+ lHj> Rt^RIHt^RIHt^RIHtHtHt^RI H t H t H t H t HtHtHt^RIHtHt^RIHt!RR]4t!R R ]4t!R R ]4t]!R ]RR7]!R]RR7!RR]4t!RR]4t!RR]4t]!R]RR7]!R]RR7]!R]RR7!RR]4t]!R ]R!R7!R"R#]4t]!R$]R%R7!R&R']4t]!R(]R)R7!R*R+]4t!R,R-]4t ]!R.] R/R7]!R0]R1R7]!R2]R3R7]!R4]R5R7!R6R7]4t!]!R8]!R9R7!R:R;]4t"!R<R=]4t#!R>R?]4t$!R@RA]4t%!RBRC]4t&!RDRE]4t'!RFRG]4t(!RHRI]4t)]!RJ])RKR7!RLRM]4t*]!RN]*ROR7!RPRQ]4t+]!RR]+RSR7!RTRU]4t,]!RV],RWR7!RXRY]4t-]!RZ]-R[R7!R\R]]4t.]!R^].R_R7!R`Ra]4t/]!Rb]/RcR7!RdRe]4t0]!Rf]0RgR7!RhRi]4t1]!Rj]1RkR7!RlRm]4t2]!Rn]2RoR7!RpRq]4t3]!Rr]3RsR7!RtRu]4t4]!Rv]4RwR7!RxRy]4t5]!Rz]5R{R7!R|R}]4t6!R~R]4t7]!R]6RR7]!R]7RR7!RR]4t8]!R]8RR7]!R] RR7!RR]4t9!RR]4t:]!R]:RR7!RR]4t;]!R];RR7!RR]4t<]!R]]!R]>RR7!RR]4t?]!R]?RR7]!R]?RR7]!R]?RR7!RR]4t@]!R]@RR7!RR]4tA!RR]4tBERFwtCtD]!]C]B]DR7K !RR]4tE!RR]4tF!RR]4tG!RR]4tH]!R]ERR7]!R]FRR7]!R]GRR7]!R]HRR7!RR]4tI!RR]4tJ]!R]IRR7]!R]JRR7!RR]4tK]!R]KRR7!RR]4tL]!R]LRR7!RR]4tM!RR]4tN]!R]MRR7]!R]NRR7!RR]4tO]!R]ORR7!RR]4tP!RR]4tQ]!R]PRR7]!R]QRR7]!RRRR7!RR]4tR!RR]4tS!RR]4tT!RR]4tU]!R]RRR7]!R]SRR7]!R]TRR7]!R]URR7!RR]4tV!RR]4tW!RR]4tX]!R]VRR7]!R]WERR7]!ER]XERR7!ERER]4tY]!ER]YERR7]!ER]YERR7]!ER ]YER R7]!ER ]YER R7]!ER ]YERR7]!ER]YERR7]!ER]YERR7.RENRNRNRNRNERNRNRCNERNR NRINR7NERNRNRNRNRNRNR#NRNR}NRNRNRNRNRNRNRNRNRYNRNR]NERNRNRNRNRUNRQNRNRNR NRMNR+NRNRNRNRNRNRyNRiNRmNERNERNRqNRuNReNR;NRNRNRNRNtZR#(uNotification payloads: every ``event`` frame the gateway emits (``params.payload``). One ``Payload`` model per event name, registered with ``event(...)``; ``request.cancel`` lives in ``server_requests.py`` next to the requests it withdraws. Each model's docstring names the Python emitter it was typed from — that emitter is the source of truth, the hand-written TS in ``apps/shared/src/gateway-events.ts`` was only the map. Fields the emitter always sets are required; anything conditional is ``X | None = None``. A handful of payloads stay ``extra="allow"`` on purpose: their closed shape is owned by another module (the skin engine, the pet store, the goal/loop/heartbeat state files, the free-tier bootstrap record) or they are watcher signals whose payload is ``{}`` today and may grow. Everything else is closed, so a drifted emitter fails the suite (``registry.check_payload`` raises under ``HERMES_TEST_ISOLATION``). ) annotations)Field) JsonValuePayloadWireEnum)MessageReaction PlanGaugeSessionLiveInfoSubagentStatus ToolLabel ToolLabelKindUsage)FreeTierChallengePayloadSessionControlSnapshot)eventcD]tRt^tRt]P RR/,tRtR#) OpenPayloadzMA payload whose known keys are typed but whose closed set is owned elsewhere.extraallowN)__name__ __module__ __qualname____firstlineno____doc__r model_config__static_attributes__rA/home/ubuntu/.hermes/hermes-agent/tui_gateway/contracts/events.pyrrsW''7G*<L.>"'"=K=$T:Hn:KKKKrr cV]tRt^3t$RtR]R&R]R&R]R&RtR ]R &RtR ]R &R tR#) GatewayReadyPayloadzQ``tui_gateway/entry.py`` (stdio) / ``tui_gateway/ws.py`` (WebSocket) first frame.r skinbool change_eventsr" replay_epochN bool | None heartbeatsession_authorityr) rrrrrr/r8r9rrrrr2r23s.[ !I{!&*{)rr2z gateway.readyzaFirst frame of a connection: the resolved skin, the change-event capability and the replay epoch.)docz skin.changedzSThe active skin moved (name switch or live colour edit); repaint from this palette.c]tRt^Et$RtR]R&R]R&R]R&R]R&R]R&R]R &R tR]R &R tR ]R&R tR]R&R t R]R&R]R&Rt R #)SetupReadyPayloadz>``hermes_cli/free_tier_bootstrap.py::SetupRecord.as_payload``.r4provider_configuredr"inference_providerfree_tier_accountfree_tier_route has_identityother_providersr!errorN str | None error_coder7 retryable int | None retry_afterfloat finished_atr) rrrrrr/rCrErFrHrrrrr<r<EsVHE3O!J !!I{!"K"rr<c&]tRt^VtRtRtRtRtRtR#)OnboardingOutcomedoneskippedreplaceddeletedrN) rrrrrMrNrOrPrrrrrLrLVs DGHGrrLc:]tRt^]t$RtR]R&R]R&R]R&RtR#) OnboardingEndedPayloada$``agent/onboarding_record.py::_transition``: the run ``run_id`` stopped being in progress. ``stored_session_id`` is its chat at the compression tip. ``done``: the first-task card was answered; ``skipped``: Skip setup; ``replaced``: a rerun opened a new run; ``deleted``: its chat was deleted.r"run_idstored_session_idrLoutcomerNrrrrrr/rrrrrRrR]sk K rrRzonboarding.endedzAA first-run onboarding run ended; sent to every connected window.z setup.readyzXThe free-tier bootstrap finished (broadcast); the desktop's setup gate reads the record.zfree_tier.challengezThe account service wants a browser challenge cleared before the free-tier token exchange (broadcast); the desktop loads ``url`` in a hidden window.c&]tRt^rt$RtR]R&RtR#) ErrorPayloadu<Every ``_emit("error", …)`` site sets exactly ``message``.r"messagerNrVrrrrXrXrs F LrrXrCzWA session-level failure outside a turn (agent init, model switch, compression, resume).c&]tRt^{t$RtR]R&RtR#) NoticePayloadz:``tui_gateway/model_switch.py`` capability-refresh notice.r"rYrNrVrrrr[r[{s D Lrr[noticezAInformational one-liner for the session (capabilities refreshed).cT]tRt^t$RtRtR]R&RtR]R&RtR]R&Rt R]R&Rt R#) MessageStartPayloadah``message.start``. Empty from the TUI gateway's emitters and for an ordinary admission; ``gateway/session_authority._stamp_claim`` adds an automation admission's async-result card (``session_automation.admission_display``: a background-process completion) and its model text, so a viewer that did not submit the turn paints the same header the submitter would.NrD display_kind display_textnotification_categorytextr) rrrrrr_r/r`rarbrrrrr^r^s3b $L*##L*#(,:,D*rr^z message.startzIA turn began streaming; an automation turn carries its async-result card.cB]tRt^t$RtR]R&RtR]R&RtR]R&R tR#) StreamDeltaPayloada ``prompt_turn._invoke_agent._stream`` (message.delta: ``text`` + optional ``rendered``), ``agent_callbacks._agent_cbs`` (reasoning.delta / thinking.delta), ``tool_progress._progress_reasoning`` (reasoning.available). ``verbose`` rides only when the session's verbose reasoning mode is on.r"rbNrDrenderedr7verboser) rrrrrr/rerfrrrrrdrds#f IHjG[rrdc&]tRt^t$RtR]R&RtR#)MessageDeltaPayloada``message.delta``. A session-authority local-viewer turn also publishes ``text: null``: the reply segment boundary (the agent's ``stream_delta_callback(None)``, before tool lines) that closes the classic CLI's reply box. Every other viewer ignores an empty chunk.rDrbrNrVrrrrhrhsV rrhz message.deltazHOne streamed chunk of the assistant reply (null text: segment boundary).zreasoning.deltaz,One streamed chunk of the model's reasoning.zreasoning.availablez6A completed reasoning block (non-streaming providers).zthinking.deltaz/Legacy thinking-text chunk (thinking_callback).c0]tRt^t$RtR]R&R]R&RtR#)MessageInterimPayloadzW``prompt_turn._interim_assistant_cb`` / ``agent_callbacks`` interim_assistant_callback.r"rbr4already_streamedrNrVrrrrjrjsa Irrjzmessage.interimzPInterim assistant commentary (text beside tool calls) sealed as its own segment.c&]tRt^tRtRtRtRtRtR#) TurnStatusz``prompt_turn._result_status``.completerC interruptedrN) rrrrrrnrCrorrrrrmrms)H EKrrmcH]tRt^t$RtR]R&R]R&R]R&RtR]R&RtR #) UsageLimitSuggestionub``agent/plan_limits.py::ModelSuggestion`` — a recommended model that still works past the limit.r"modellabelnotenousproviderrN)rrrrrr/rvrrrrrqrqsl J J IHcrrqc&]tRt^t$RtR]R&RtR#)UsageLimitCreditsu``agent/plan_limits.py::CreditsOption`` — ``use_credits`` (turn on Keep going), ``add_credits``, or ``add_credits_and_keep_going`` (both: Keep going is off and there is no balance).r"actionrNrVrrrrxrxsY Krrxc]tRt^t$RtR]R&R]R&R]R&RtR]R&R]R &]!]R 7t R ]R &Rt R ]R&Rt R]R&Rt R#) UsageLimitu``agent/plan_limits.py::LimitHit`` — a usage-window plan's limit: what ran out, when it resets, and the one-click ways on (switch to a recommended model, use / add credits).r"gauge_idscope limit_nameNrG resets_at_msrYr%zlist[UsageLimitSuggestion] suggestionszUsageLimitCredits | Nonecreditsr! current_modelr) rrrrrr/rrlistrrrrrrrr{r{sMQM JO#L*# L.3D.IK+I(,G %,M3rr{c]tRt^t$RtR]R&R]R&R]R&RtR]R &RtR]R &RtR ]R &Rt R ]R&] PRR/,t Rt R#) ErrorSurfaceu``agent/error_surface.py::_surface`` — advisory {layer, code, retryable} (+ identity, + auth hint, + ``resets_at`` epoch seconds when the provider named when its limit lifts, + ``usage_limit`` on a usage-window plan's limit).r"layercoder4rFNrDrvrr float | None resets_atzUsageLimit | None usage_limitrrr) rrrrrr/rvrrrrrrrrrrrrsV# J IOHjE:"I|"%)K")''7G*<``session_lifecycle._announce_session_reclaimed`` (broadcast).r"rrTreasonrNrVrrrr r sHO Krr zsession.reclaimedz@The backend reclaimed a live session out from under its clients.cN]tRtRt$RtR]R&R]R&R]R&R]R&R ]R &R tR #) ApprovalCancelledPayloadi"u``session_lifecycle._announce_cancelled_gateway_approvals`` (broadcast). One frame for every pending approval dropped by an interrupt / reap / teardown (#106678) — the deny-resolve is silent without it, so a reconnecting client's prompt looks lost rather than cancelled. ``cancelled_count`` is the number of dropped entries; ``request_ids`` omits empty/missing ids, so the two can disagree when an entry has no request_id. r"rrTr rcancelled_countr request_idsrNrVrrrr r "s%O Krr zapproval.cancelledzrPending gateway approvals were dropped by interrupt/reap/teardown; the wait resolved as deny (not a user refusal).c"]tRtRt$R]R&RtR#)SessionControlUpdatePayloadi6rcontrolrNrrrrrr6s ##rrzsession.control.updatez0Persisted goal / loop / heartbeat state changed.c0]tRtRt$RtR]R&R]R&RtR#) BillingStepUpVerificationPayloadi=z4``methods_session`` billing.step_up on_verification.r"verification_url user_coderNrVrrrrr=s>Nrrzbilling.step_up.verificationzSDevice-flow URL + code for the billing scope step-up; the client opens the browser.c>]tRtRt$RtR]R&R]R&RtR]R&R tR#) SideAgentCompletePayloadiKzZ``methods_prompt._spawn_side_agent``: ``{task_id, **extra, text}``; btw adds ``question``.r"task_idrbNrDquestionr)rrrrrr/rrrrrrrKsd L IHjrrzbackground.completez"A /background side agent finished.z btw.completez"A /btw side question was answered.zpreview.restart.completez*The hidden preview-restart agent finished.c>]tRtRt$RtR]R&R]R&RtR]R&R tR#) PreviewRestartProgressPayloadiXzQ``methods_prompt`` restart body + ``agent_callbacks._preview_restart_callbacks``.r"rrbNrDrr)rrrrrr/rrrrrrrXs[ L IE:rrzpreview.restart.progressz-Progress line from the preview-restart agent.c:]tRtRt$RtR]R&R]R&R]R&RtR #) SubagentOutputTailEntryifz=``tools/delegate_tool_results.py::_extract_output_tail`` row.r"toolrr4is_errorrNrVrrrrrfsG I LNrrc`]tRtRt$RtR]R&R]R&R]R&RtR ]R &RtR ]R &RtR ]R &Rt R ]R &Rt R]R&Rt R ]R&Rt R]R&Rt R]R&RtR]R&RtR]R&RtR]R&RtR]R&RtR]R&RtR]R&RtR]R&RtR ]R&RtR ]R&RtR]R&RtR ]R &RtR!]R"&RtR ]R#&R$tR#)%SubagentEventPayloadinu``tool_progress._progress_subagent`` — every ``subagent.*`` frame; identity fields are optional because older emitters omit them and the TUI spawn tree falls back to flat rendering.r"goalr task_count task_indexNrD subagent_id parent_idchild_session_id delegation_idrGdepthrr tool_countzlist[str] | Nonetoolsetsrrrr files_read files_writtenz$list[SubagentOutputTailEntry] | None output_tail tool_namerbzSubagentStatus | Nonerrrduration_seconds tool_previewr)rrrrrr/r%r&r'r(r)rrr*r+rrrrr,r-r.r/rbrrr0r1rrrrr!r!ns] IOO"K" Iz #'j' $M:$E:E:!J !!%H%#L*# $M:$#'j' Iz #'J '&*M#*8]tRtRt$RtR]R&RtR]R&R]R &R tR#) WakeDetectedPayloadi/z/``methods_voice`` wake detector ``_on_detect``.r"phraseNrDprofiler4start_new_sessionr)rrrrrr/rkrrrrriri/s9 KGZrriz voice.statuszVoice recorder state changed.z voice.partialz6Live STT text so far while the user is still speaking.zvoice.transcriptzAA voice capture produced text (or a stop phrase / silence limit).z wake.detectedzA wake phrase fired.c^]tRtRt$RtR]R&RtR]R&RtR]R&RtR ]R &Rt R]R &R t R#) PetChangedPayloadi@ud``change_watcher._pet_changed_payload`` — ``pet.info.meta``-shaped; ``{enabled: false}`` when off.r4enabledNrDslug displayNamerscalespritesheetRevisionr) rrrrrr/rprqrrrsrrrrrnrn@s3n MD*"K"E<&**rrncL]tRtRt$RtR]R&R]R&RtR]R &RtR ]R &R tR#) PetGenerateProgressPayloadiJzL``methods_session`` pet.generate: token-only init frame, then one per draft.r"tokenrr5NrGr4rDdataUrir) rrrrrr/r4rwrrrrruruJs#V J JE:GZrruc^]tRtRt$RtR]R&RtR]R&RtR]R&RtR]R &Rt R]R &R t R#) PetHatchProgressPayloadiSz[``methods_session`` pet.hatch ``_on_progress``: ``{event, detail}`` or the parsed row form.r"rNrDrr`rMrr) rrrrrr/rr`rMrrrrrryrySs2e JFJE:D*E:rryz pet.changedz3The active pet / its spritesheet changed (watcher).zpet.generate.progressz#Pet base-draft generation progress.zpet.hatch.progressz!Pet hatch (row drawing) progress.c]tRtRtRtRtR#)ChangeSignalPayloadieu\``change_watcher._CHANGE_WATCHES`` payload fn — ``{}`` for every watch except pet.changed.rN)rrrrrrrrrr{r{esfrr{z cron.changedz,cron/jobs.json moved; refetch the cron list.zsessions.changedz)state.db moved; refetch the session list.zplatforms.changedz2gateway_state.json moved; refetch platform status.zprojects.changedz3projects.db moved; refetch the project list + tree.zpairing.changedz%Pairing state moved; refetch pairing.zskills.changedz\A skill root moved (installed/removed elsewhere); refetch commands.catalog from the gateway.zbot_relay.outbox.pendingz0A bot-relay outbox envelope is queued; drain it.rrrr r ))zsubagent.spawn_requestedz>delegate_task accepted a child goal (before the child starts).)zsubagent.startz"A delegated child started running.)zsubagent.progressz(Batched tool-name progress from a child.)zsubagent.thinkingzA child's reasoning chunk.)z subagent.toolzA child called a tool.)zsubagent.completez1A child finished (status + observability rollup).)[r __future__rpydanticrbaserrrcommonrrr r r r r config_free_tier_controlrrregistryrrr r2r<rLrRrXr[r^rdrhrjrmrqrxr{rrrrrrrrrrrrrrrrrrrrrr r rrrrrr!_name_docr3r7r;r?rArDrFrIrNrRrTrVr]r_rbrdrirnruryr{__all__rrrrs2  #..pppV='= +  *' *o* monk _a "W0 MOm& df5 GH 7 g|!z{G h #fg ' o* UW  ,o*0z{+1_`/5mn*0abG. \^  7   =7 = #7 #%G%$0W0006fg'o*1TU!('!(Ho*0~'o*0vwg j/'ij7 ,2`am&,kl *w *l$*VW *' * o*0~G .4deG/6AB ' o*0tun(.YZ g  w 28z{4:^_Wj.&^_no su 7!=Chig28z{ w  4 ~@$'$ ;Astw$&F _a w 5;_`n.4XY ":@lmG "?Etu g$7$<KE4 %%40'G "g"o*0ST.4QRn(.YZk?(_` ' n(.^_o*0TU  m&,RSW06fgG74:pq,2]^W06fg $g$$W$"$CJCD!#AGop 4%jk ' (W('n(.MNo*0hi06yzo*0FG + +km&,ab9?de39\] g+gn)/]^-3^_.4hi-3hi,2YZ+ hj "5;mn  6 8X % '? AV Xf  / 1F   6  8I  Kc  e|      ,   .C   ET      !:    @U Wl  4 6C EZ  1 3L Nd  . 0D F[  ) +: ! "# "4# r