surshar / claude-code

Claude Code is an agentic coding tool that lives in your terminal, understands your codebase, and helps you code faster by executing routine tasks, explaining complex code, and handling git workflows - all through natural language commands.

Built by Anthropic · github.com/anthropics

claude-code / mods / types / claude-code.d.ts

Alice T'Poteattelemetry: rows carry the engine's version, base version and build time from $.session.version() (#96487) cbab6f4 · 28 days ago History

13,044 lines · 489.6 KBRaw

1	// Written by Claude Code 2.1.277.
2	// Claude Code function hooks: the plugin API's TypeScript declarations.
3	//
4	// EARLY ACCESS: this surface may change between releases without notice.
5	// Written by `/plugin-types`; regenerate with that command after an update
6	// rather than editing. The first line names the Claude Code version that
7	// wrote it. TypeScript 5.4 or newer reads it. `claude plugin validate <dir>`
8	// is the other half: it reads a plugin's manifest and its hooks module's
9	// source the way the engine will and reports what the module hooks and
10	// calls and everything the engine would refuse, before any session loads it.
11	//
12	// What is here: the module a hooks module may import types from,
13	// import type { Register, On, EngineInterface } from 'claude-code'
14	// (at run time the import is empty), and the globals a hooks module has:
15	// `h` and `Fragment` (what JSX compiles against), the JSX namespace, and
16	// the environment's web APIs (URL, TextEncoder, AbortController,
17	// crypto.subtle, ...). A hooks module runs in an environment of its own:
18	// no DOM, no Node. The module, and every file it imports from the plugin,
19	// is named .ts, .tsx, .jsx, .js, .mjs, .cjs, .mts or .cts (a file named
20	// otherwise is not loaded) and is an ES module whatever its suffix: there
21	// is no `require`. The elements a render hook draws with (`Box`, `Text`,
22	// `Button`, ...) are not globals: they come from the surface's table,
23	// const { Box, Text } = $.ui.resolve(e)
24	//
25	// Also here: 'claude-code/testing', the kit a plugin's *.test.ts and
26	// *.test.tsx files import under `claude plugin test <dir>`, which runs each
27	// in an environment like the one a plugin's hooks run in (no fs, network or
28	// process), the plugin loaded from the folder by the engine's own host:
29	// `test(name, async ($, on) => { ... })`, where `$` is the engine's own
30	// and the hooks `on` registers sit beneath every plugin; with describe,
31	// expect, tier, and `mock`, whose clock, store and env answer those nouns
32	// beneath the plugins from memory. `$.ui.mount` draws a component through
33	// the plugin on the surface the test names (terminal, desktop, vscode or
34	// mobile: never assumed) and hands back the drawing to read and act on by
35	// key: find an element, press a Button, type into an Input, drive a
36	// `Client`'s module (keys, pointer, posts, its frame clock), each act typed
37	// by that surface's element table, so one test body run over several
38	// surfaces covers the mod's hooks and description on each. It exercises
39	// the mod (its hooks, the tree they return under each surface's rules, its
40	// `Client` modules), never a surface's paint (Ink's, the desktop page's):
41	//
42	// test('notes add up on every surface that takes input', async $ => {
43	// for (const surface of ['terminal', 'desktop'] as const) {
44	// const ui = await $.ui.mount({ plugin: 'notes', surface, ...BAND })
45	// await ui.input({ key: 'new', text: 'milk' })
46	// expect((await ui.find({ key: 'count' }))?.text).toBe('1 note')
47	// await ui.key({ key: 'down', in: 'list' })
48	// await ui.unmount()
49	// }
50	// for (const surface of ['terminal', 'desktop', 'vscode', 'mobile'] as const) {
51	// const ui = await $.ui.mount({ plugin: 'notes', surface, ...HINT })
52	// expect(await ui.find({ type: 'Text', text: /notes/ })).toBeDefined()
53	// await ui.press({ key: 'dismiss' })
54	// }
55	// })
56	//
57	// Typing a plugin against it:
58	// export const register: Register = (on, options) => { ... }
59	// or, in a .js module,
60	// /** @type {import('claude-code').Register} */
61	// export const register = (on, options) => { ... }
62	//
63	// A tsconfig.json (or jsconfig.json) that fits a hooks module:
64	// {
65	// "compilerOptions": {
66	// "target": "es2023", "lib": ["es2023"], "types": [],
67	// "module": "esnext", "moduleResolution": "bundler",
68	// "strict": true, "noUncheckedIndexedAccess": true,
69	// "noEmit": true, "skipLibCheck": true,
70	// "jsx": "react", "jsxFactory": "h", "jsxFragmentFactory": "Fragment"
71	// },
72	// "include": [".claude/types", "hooks", "tests"]
73	// }
74	// ".claude/types" is where /plugin-types writes this file and, beside it,
75	// claude-code-mcp.d.ts and claude-code-plugins.d.ts, the index of the
76	// enabled plugins' type contracts, each copied to claude-code-plugins/
77	// <plugin>.d.ts: what a plugin adds to `$` in engine.create, so a plugin
78	// you depend on is typed with nothing copied (the include above takes the
79	// whole folder). "hooks" is the plugin's hooks/ folder and "tests" its test
80	// files. `lib` names no DOM: the environment has none, and its `Text`
81	// would shadow the element.
82	//
83	// A plugin that adds a noun to `$` ships its own contract: a .d.ts its
84	// plugin.json names as "types", exporting the noun's types at its top level
85	// and declaring the noun on the engine's interface,
86	// export type Topo = { ... }
87	// declare module 'claude-code' {
88	// interface EngineInterface { topo: Topo }
89	// }
90	// with no import or reference, its exported names led by the noun's
91	// PascalCase name; the plugin's own hooks module imports them from it.
92
93	declare module 'claude-code' {
94	/**
95	* What an Agent call a plugin raised (`$.tool.call({ tool: "Agent", ... })`)
96	* answers as `result` once the agent settles; `text` is its final answer.
97	*
98	* A plugin's spawn always runs in the background, so the call resolves with
99	* this record and not the Agent tool's own (BuiltinToolResults), which is
100	* what a model's Agent call carries at `tool.call`.
101	*/
102	export type AgentCallRecord = {
103	/**
104	* The spawned agent's id, as `$.agent.list()` names it.
105	*/
106	agentId: string;
107	/**
108	* The model the agent resolved to, when one is known.
109	*/
110	resolvedModel?: string;
111	};
112
113	/**
114	* One agent loop of this session as `$.agent.list()` returns it: a subagent
115	* or an in-process teammate.
116	*/
117	export type AgentInfo = {
118	/**
119	* The agent's id: the same string its loop's `tool.call` events carry as
120	* `agentId`, and a spawn inside it as `parentAgentId`.
121	*/
122	id: string;
123	/**
124	* Its row's label.
125	*/
126	description: string;
127	/**
128	* The agent definition it runs as (`general-purpose`, `Explore`, ...), or
129	* `teammate` for an in-process teammate.
130	*/
131	type: string;
132	/**
133	* `running`, `completed`, `failed`, `killed`, or another of the engine's task
134	* statuses.
135	*/
136	status: string;
137	/**
138	* The id of the subagent whose loop spawned it; absent when the main loop
139	* did.
140	*/
141	parentId?: string;
142	/**
143	* The plugin whose `$.agent.spawn` (or Agent `$.tool.call`) started it;
144	* absent when the model or the person did.
145	*
146	* The origin axis: which plugin caused it, whichever loop that hook ran in.
147	*/
148	spawnedBy?: string;
149	/**
150	* What SendMessage addresses it by (`Agent({ name })`, or the engine's own
151	* for a background agent), when it has one; not `description` or `type`.
152	*/
153	name?: string;
154	};
155
156	/**
157	* Which model loop an event happened in: the loop's agent id inside a
158	* subagent's or a teammate's loop, absent on the main loop.
159	*
160	* The agent axis, not the origin axis: `next.origin` names the plugin whose
161	* hook frame caused the dispatch (the recursion skip), whichever loop it ran
162	* in; `agentId` names the loop, whoever caused the call.
163	*/
164	export type AgentLoop = {
165	/**
166	* The id of the loop this call runs in: for a subagent or a teammate, the
167	* `id` `$.agent.list()` gives it; absent on the main loop.
168	*
169	* A workflow's agents and the engine's own forks (compaction, memory) carry
170	* ids no list names. Pinned: a different value is refused, one left out is
171	* kept. Which loop, not which plugin caused it (that is `next.origin`).
172	*/
173	agentId?: string;
174	};
175
176	/**
177	* The input of `agent.offer`: one agent type, at the moment the engine
178	* offers it to the model.
179	*
180	* Listed for the model (the agent listing) or named by it at dispatch
181	* (`subagent_type`): the same event at each. Model-facing only: a plugin's
182	* own `$.agent.spawn` of a type is no offer, and `agent.spawn` governs it.
183	*/
184	export type AgentOfferInput = {
185	/**
186	* Which type (`Explore`, `Plan`, a plugin's agent); the key a matcher
187	* narrows on.
188	*/
189	agent: string;
190	/**
191	* Its listing line's text as the definition states it (`whenToUse`).
192	*/
193	description: string;
194	/**
195	* Where the definition came from (`built-in`, `plugin`, a settings
196	* source), so a matcher tells a built-in from a user's agent of its name.
197	*/
198	source: string;
199	/**
200	* Who provides this agent: the plugin and its tier; `{ plugin: "engine",
201	* tier: "core" }` for a built-in. Pinned: a rewrite is refused.
202	*/
203	provider: Origin;
204	};
205
206	/**
207	* What an `agent.offer` hook returns: whether the model is offered the agent
208	* type, in its listing and at dispatch.
209	*/
210	export type AgentOfferResult = {
211	isOffered: boolean;
212	};
213
214	/**
215	* `agent.spawn`'s input as the call takes it: what the Agent tool's caller
216	* says; the engine fills the rest.
217	*
218	* A call's spawn runs in the background: it resolves once the subagent
219	* started, and nothing holds it in the foreground.
220	*/
221	export type AgentSpawnArgs = Pick<AgentSpawnInput, 'prompt'> & Partial<Pick<AgentSpawnInput, 'description' \| 'subagentType' \| 'model' \| 'name' \| 'cwd'>>;
222
223	/**
224	* The input of `agent.spawn`: what the Agent tool decided about the
225	* subagent it is about to start, before its model is resolved.
226	*
227	* A hook rewrites content (prompt, description, subagentType, model,
228	* background, cwd), read back as the tool's parameters; tool_use_id, name,
229	* fork, parentModel, permissionMode, parentAgentId and provider are pinned.
230	*/
231	export type AgentSpawnInput = {
232	/**
233	* The Agent tool call this spawn belongs to (for `$.ui.notice`). Pinned:
234	* the spawn's identity.
235	*/
236	tool_use_id: string;
237	/**
238	* The task the subagent is given: the Agent tool's `prompt` parameter. A
239	* rewrite is the prompt the subagent runs with.
240	*/
241	prompt: string;
242	/**
243	* The Agent tool's short `description` of the task (a few words). A rewrite
244	* is what the task shows as.
245	*/
246	description: string;
247	/**
248	* The resolved agent type (`general-purpose`, `Explore`, a plugin's agent,
249	* `fork`). A rewrite names another agent this call can dispatch, exactly.
250	*
251	* That definition is the one spawned; a name matching none refuses the
252	* spawn, and a fork dispatches no other.
253	*/
254	subagentType: string;
255	/**
256	* Who provides this agent: the plugin and its tier; `{ plugin: "engine",
257	* tier: "core" }` for a built-in. Pinned with the spawn's identity.
258	*/
259	provider: Origin;
260	/**
261	* The Agent tool's `model` parameter as given, an alias (`haiku`) or a
262	* full id; undefined lets the agent's own model, then the parent's, decide.
263	*
264	* Ignored for forks, which always inherit. A hook sets this to pick the
265	* subagent's model.
266	*/
267	model?: string;
268	/**
269	* The parent's effective model, what `inherit` resolves to. Pinned: a fact
270	* of the parent (set `model` to change what the subagent runs on).
271	*/
272	parentModel: string;
273	/**
274	* The id of the loop the spawn happens in (its `tool.call` `agentId`; for a
275	* subagent or teammate its `$.agent.list()` id); absent from main.
276	*
277	* Pinned: a different value is refused, one left out is kept. The agent
278	* axis, not the origin: `next.origin` names the plugin whose hook frame
279	* caused the spawn, this names the model loop it happened in.
280	*/
281	parentAgentId?: string;
282	/**
283	* The parent's permission mode (`default`, `acceptEdits`, `plan`, ...), which
284	* the subagent inherits. Pinned: a fact of the parent.
285	*/
286	permissionMode?: string;
287	/**
288	* True when the subagent will run in the background (or remotely). A
289	* rewrite is read back as the call's `run_in_background`.
290	*
291	* The agent's own definition and remote isolation can still force it on,
292	* and disabled background tasks force it off.
293	*/
294	background: boolean;
295	/**
296	* True for a fork of the parent: it inherits the parent's context and model,
297	* and `model` is ignored. Pinned: the spawn's identity.
298	*/
299	fork: boolean;
300	/**
301	* Given by the call (`Agent({ name })`, addressable by SendMessage);
302	* undefined when unnamed. Pinned: the address the parent routes by.
303	*/
304	name?: string;
305	/**
306	* The directory the subagent runs in when the call set one (`cwd`); undefined
307	* means the parent's. A rewrite is where the subagent runs.
308	*/
309	cwd?: string;
310	};
311
312	/**
313	* What an `agent.spawn` hook returns and what `next(e)` resolves to: the
314	* started subagent's `{ model, agentId }`, or `{ deny: reason }`, refusing it.
315	*
316	* It and `$.agent.spawn(input)` resolve once the subagent started; its answer
317	* is its own `turn.complete`, carrying this `agentId`. Keep the id and set
318	* `got[agentId]` to what waits; a `turn.complete` hook resolves it:
319	*
320	* @example
321	* on("turn.complete", ($, e, next) => (got[e.agentId]?.(e.answer), next(e)))
322	*/
323	export type AgentSpawnResult = {
324	/**
325	* What the subagent runs on: from core the resolved id; from a hook an
326	* alias (`haiku`) or an id.
327	*/
328	model: string;
329	/**
330	* The started subagent's id: the same string its loop's `tool.call`
331	* events carry as `agentId` and `$.agent.list()` lists it by.
332	*
333	* Set by core; a hook that answers without `next` started none.
334	*/
335	agentId?: string;
336	deny?: undefined;
337	} \| {
338	/**
339	* Refuses the spawn, so nothing starts; the model sees the text as the
340	* Agent tool's error.
341	*/
342	deny: string;
343	model?: undefined;
344	agentId?: undefined;
345	};
346
347	/**
348	* What `$.agent.register` takes: an agent type this plugin defines, spelled
349	* as an agent definition in settings JSON is, plus its `name`.
350	*
351	* Every field an agent file or `--agents` entry may carry is here and takes
352	* effect as it does there; the engine validates it with the same schema.
353	*/
354	type AgentSpec = {
355	/**
356	* The type's short name (letters, digits, `_`, `-`; up to 64); the type is
357	* `<plugin>:<name>`, as a plugin's agent file `agents/<name>.md` names one.
358	*/
359	name: string;
360	/**
361	* When to delegate to this agent: the line the model reads in its listing
362	* of agent types, and `agent.offer`'s `description`.
363	*/
364	description: string;
365	/**
366	* The agent's system prompt, whole: it replaces the session's.
367	*/
368	prompt: string;
369	/**
370	* What the agent may call, by tool name (`Read`, `Bash`, `mcp__x__y`); a
371	* call to any other is refused. Left out: every tool the parent has.
372	*/
373	tools?: readonly string[];
374	/**
375	* Tools withheld from the agent, by name, out of whatever `tools` allows.
376	*/
377	disallowedTools?: readonly string[];
378	/**
379	* The agent's model: an alias (`haiku`, `sonnet`, `opus`), a full id, or
380	* `inherit` for the parent's. Left out: the session's subagent default.
381	*/
382	model?: string;
383	/**
384	* The agent's effort: a level (`low`, `medium`, `high`, `xhigh`, `max`)
385	* or an integer budget.
386	*/
387	effort?: string \| number;
388	/**
389	* How the agent's permission asks are decided, a mode: `default`,
390	* `acceptEdits`, `plan`, `auto`, `dontAsk` or `bypassPermissions`.
391	*
392	* Left out: the parent's.
393	*/
394	permissionMode?: string;
395	/**
396	* Servers connected over MCP for the agent's run: a configured server's
397	* name, or `{ "<name>": { command, args } }`, one server's config inline.
398	*/
399	mcpServers?: readonly (string \| Record<string, unknown>)[];
400	/**
401	* Settings hooks in force while the agent runs, in settings.json's `hooks`
402	* shape (`{ PreToolUse: [{ matcher, hooks: [...] }] }`).
403	*/
404	hooks?: Record<string, unknown>;
405	/**
406	* The most turns the agent takes before it stops.
407	*/
408	maxTurns?: number;
409	/**
410	* Preloaded into the agent's context before its first turn: skill names.
411	*/
412	skills?: readonly string[];
413	/**
414	* The agent's first user turn; `{{intent}}` in it takes the spawn's prompt.
415	* Left out: the spawn's prompt is the first turn.
416	*/
417	initialPrompt?: string;
418	/**
419	* A persistent memory the agent keeps between runs, and where: `user`,
420	* `project` or `local`.
421	*/
422	memory?: 'user' \| 'project' \| 'local';
423	/**
424	* Set so that every spawn of the agent runs in the background.
425	*/
426	background?: true;
427	/**
428	* Set so that the agent's context carries no CLAUDE.md block (the person's,
429	* the project's, the rules): it takes what it needs from its prompt.
430	*/
431	omitClaudeMd?: true;
432	/**
433	* Where the agent runs apart from the session: `worktree`, a git worktree
434	* of its own; `remote`, a cloud session where the build allows one.
435	*/
436	isolation?: 'worktree' \| 'remote';
437	};
438
439	/**
440	* The hook `on("*", hook)` takes: it runs on every event, plugin nouns no
441	* declaration names included, so `e` is `unknown` and `next` is StarNext.
442	*
443	* Until `next.is(pattern, e)` narrows `e`, all a hook can do with it is pass
444	* it on, time it, log it, or fail it; once narrowed it is an ordinary hook on
445	* those events.
446	*
447	* @param $ the engine interface; at `engine.create` the empty table, so a hook
448	* that reads `$` tests `next.is("engine.create", e)` first
449	*/
450	export type AnyEventHook = ($: EngineInterface, e: unknown, next: StarNext) => unknown;
451
452	/**
453	* Every key of every variant, index signatures included.
454	*/
455	type AnyKeyOf<I> = I extends unknown ? keyof I : never;
456
457	/**
458	* The argument of event `N`: `e` in its hooks, and what its call takes. For a
459	* union of names, the union of their arguments.
460	*/
461	export type Args<N extends EventName = EventName> = EventOf[N];
462
463	/**
464	* Options of `$.ui.ask`.
465	*/
466	export type AskOptions = {
467	/**
468	* 2-4 option labels; fewer than two are padded with Yes/No; free text is the
469	* dialog's Other.
470	*/
471	options?: readonly string[];
472	/**
473	* A short chip beside the question (`Approach`, 12 characters at most).
474	*/
475	header?: string;
476	/**
477	* Allow several options; the answer comes back comma-joined.
478	*/
479	multiSelect?: true;
480	};
481
482	/**
483	* The input of `attribution.text`: one text the engine asks the model to
484	* write into a commit or a pull request, at the moment it is composed.
485	*
486	* Composed for the Bash description, the commit skills, a PR's body, the
487	* pre-ship mandate and the commit gate's deny: the same event at each.
488	*/
489	export type AttributionTextInput = {
490	/**
491	* Which text (`commit`, `pr`, `exemption`, `remedy`); the key a matcher
492	* narrows on.
493	*/
494	kind: AttributionTextKind;
495	/**
496	* As the engine composed it, the settings applied.
497	*/
498	text: string;
499	};
500
501	/**
502	* Which git text `attribution.text` carries: the commit trailer, the PR
503	* footer, the mandate's or the commit gate's sentence naming the exemption.
504	*/
505	export type AttributionTextKind = 'commit' \| 'pr' \| 'exemption' \| 'remedy';
506
507	/**
508	* What an `attribution.text` hook returns: the text the model reads in
509	* that place.
510	*/
511	export type AttributionTextResult = {
512	text: string;
513	};
514
515	/**
516	* What `$.audio.play` plays: a URL the engine fetches, or the bytes.
517	*/
518	export type AudioClip = {
519	/**
520	* A file of the calling plugin's own, relative to the plugin's
521	* directory (`fx/open.wav`); no `.`, no leading slash.
522	*
523	* The engine resolves it and loads the file from disk.
524	*/
525	asset: string;
526	url?: undefined;
527	base64?: undefined;
528	mime?: undefined;
529	} \| {
530	/**
531	* The clip's URL; the engine fetches it (never the plugin).
532	*/
533	url: string;
534	asset?: undefined;
535	base64?: undefined;
536	mime?: undefined;
537	} \| {
538	/**
539	* The clip's bytes, base64.
540	*/
541	base64: string;
542	/**
543	* What the bytes are (`audio/mpeg`, `audio/wav`).
544	*/
545	mime: string;
546	asset?: undefined;
547	url?: undefined;
548	};
549
550	type BackgroundTaskSummary = {
551	id: string;
552	/**
553	* Friendly task-type label (e.g. 'shell', 'subagent', 'monitor', 'workflow'). Falls back to the raw discriminant for unknown types.
554	*/
555	type: string;
556	status: string;
557	/**
558	* Free-text description. Capped at 1000 chars; clipped values append an in-string "... [+N chars]" marker.
559	*/
560	description: string;
561	/**
562	* Shell command line. Only present for 'shell' tasks. Capped at 1000 chars with the same "... [+N chars]" marker.
563	*/
564	command?: string;
565	/**
566	* Subagent type name. Only present for 'subagent' tasks.
567	*/
568	agent_type?: string;
569	/**
570	* MCP server name. Only present for 'monitor' / 'MCP task' tasks.
571	*/
572	server?: string;
573	/**
574	* MCP tool name. Only present for 'monitor' / 'MCP task' tasks.
575	*/
576	tool?: string;
577	/**
578	* Workflow name. Only present for 'workflow' tasks.
579	*/
580	name?: string;
581	};
582
583	type BaseHookInput = {
584	session_id: string;
585	transcript_path: string;
586	cwd: string;
587	/**
588	* UUID correlating a user prompt with all subsequent events until the next prompt. Same value emitted on OpenTelemetry events as the `prompt.id` attribute, so hook output can be joined to OTel events at prompt grain. Absent until the first user input of the process lifetime.
589	*/
590	prompt_id?: string;
591	permission_mode?: string;
592	/**
593	* Subagent identifier. Present only when the hook fires from within a subagent (e.g., a tool called by an AgentTool worker). Absent for the main thread, even in --agent sessions. Use this field (not agent_type) to distinguish subagent calls from main-thread calls.
594	*/
595	agent_id?: string;
596	/**
597	* Agent type name (e.g., "general-purpose", "code-reviewer"). Present when the hook fires from within a subagent (alongside agent_id), or on the main thread of a session started with --agent (without agent_id).
598	*/
599	agent_type?: string;
600	/**
601	* Reasoning effort applied to the current turn. Same shape as StatusLineCommandInput.effort. Present for hooks that fire within a tool-use context (PreToolUse, PostToolUse, Stop, SubagentStop, etc.) on a model that supports the effort parameter; absent for session-lifecycle hooks and models without effort support.
602	*/
603	effort?: {
604	/**
605	* Active effort level for the current turn (e.g., "low", "medium", "high", "xhigh", "max"), after any silent downgrade for the selected model. Also exposed to hook commands and Bash as the CLAUDE_EFFORT env var.
606	*/
607	level: string;
608	};
609	};
610
611	/**
612	* The `Box` props a `hover` may override, none of which moves the Box's
613	* siblings, and `scope`, which names the hover group the Box joins.
614	*
615	* `display` is `"flex"` alone, on a Box drawn `display: "none"`: with a
616	* `scope`, every member of the lit group is revealed, in whichever site it
617	* sits, so a pointer on a glyph in the transcript can swap an entry into a
618	* fixed row of the band, or reveal an absolutely positioned card.
619	* `borderStyle` only restyles a border the Box has; the offsets move a Box
620	* drawn `position: "absolute"`, none in the flow. The surface applies a
621	* hover as the pointer moves, so a reveal that moves what the pointer rests
622	* on is drawn once, not in a loop.
623	*/
624	export type BoxHoverProps = {
625	/**
626	* Names a hover group of this plugin's: every element it draws with the
627	* same `scope`, in any site, lights while any is hovered, reveals included.
628	*
629	* A Pane row and a mark on a transcript message can share one. Another
630	* plugin's elements under the same string are a different group. One to
631	* 64 characters, no control characters; no keyed Box needed; no hook runs.
632	*/
633	scope?: string;
634	borderStyle?: string;
635	borderColor?: string;
636	borderDimColor?: boolean;
637	backgroundColor?: string;
638	display?: 'flex';
639	top?: number;
640	left?: number;
641	right?: number;
642	bottom?: number;
643	};
644
645	/**
646	* The props of `Box`: the layout, position, margin, padding and border props
647	* of Ink's Box a tree may set, and the two of hover.
648	*/
649	export type BoxProps = {
650	/**
651	* Makes the Box a hover scope: while the pointer is anywhere over it, its
652	* own `hover` and that of every element beneath it apply.
653	*
654	* A nested Box with a `key` of its own scopes what is beneath it, a placed
655	* card outside its rows included. A key a sibling Box already took, or one
656	* that is no plain string, names no scope: hovers beneath it stay inert.
657	*/
658	key?: string;
659	/**
660	* Style overrides applied by the surface while the pointer is over the
661	* nearest keyed `Box`, this one included, or, given a `scope`, its group.
662	*
663	* No hook runs and nothing crosses to the plugin. To reveal on hover, draw
664	* the Box `display: "none"` with `hover: { display: "flex" }` in a visible
665	* keyed Box or under a `scope`; on a `position: "absolute"` Box, no reflow.
666	*/
667	hover?: BoxHoverProps;
668	/**
669	* `"absolute"` leaves the flow, as in CSS: placed against its parent by
670	* the offsets, no room among its siblings, painted over those before it.
671	*
672	* So showing or moving it (a hover may) moves nothing; the pointer on it is
673	* on its parent. Clipped, pointer and paint, by the region its site is in
674	* (viewport, pane, band), by the site itself on the main screen or export.
675	*
676	* @example <Box key="k"><Text>glyph</Text><Box position="absolute" top={-2}
677	* left={2} display="none" hover={{ display: 'flex' }}>the card</Box></Box>
678	*/
679	position?: 'relative' \| 'absolute';
680	/**
681	* Rows from the parent's top edge, in character cells: an integer,
682	* negative above the edge.
683	*
684	* With `bottom` and no `height` the Box spans the two.
685	*/
686	top?: number;
687	/**
688	* Columns from the parent's left edge, in character cells: an integer,
689	* negative left of the edge.
690	*
691	* With `right` and no `width` the Box spans the two.
692	*/
693	left?: number;
694	/**
695	* Columns from the parent's right edge, in character cells: an integer,
696	* negative right of the edge.
697	*/
698	right?: number;
699	/**
700	* Rows from the parent's bottom edge, in character cells: an integer,
701	* negative below the edge.
702	*/
703	bottom?: number;
704	flexDirection?: 'row' \| 'column' \| 'row-reverse' \| 'column-reverse';
705	flexGrow?: number;
706	flexShrink?: number;
707	flexWrap?: 'nowrap' \| 'wrap' \| 'wrap-reverse';
708	alignItems?: 'flex-start' \| 'center' \| 'flex-end' \| 'stretch';
709	alignSelf?: 'flex-start' \| 'center' \| 'flex-end' \| 'auto';
710	justifyContent?: 'flex-start' \| 'center' \| 'flex-end' \| 'space-between' \| 'space-around' \| 'space-evenly';
711	gap?: number;
712	columnGap?: number;
713	rowGap?: number;
714	width?: number \| string;
715	height?: number \| string;
716	minWidth?: number \| string;
717	minHeight?: number \| string;
718	margin?: number;
719	marginX?: number;
720	marginY?: number;
721	marginTop?: number;
722	marginBottom?: number;
723	marginLeft?: number;
724	marginRight?: number;
725	padding?: number;
726	paddingX?: number;
727	paddingY?: number;
728	paddingTop?: number;
729	paddingBottom?: number;
730	paddingLeft?: number;
731	paddingRight?: number;
732	borderStyle?: string;
733	borderColor?: string;
734	borderDimColor?: boolean;
735	backgroundColor?: string;
736	overflow?: 'visible' \| 'hidden';
737	display?: 'flex' \| 'none';
738	};
739
740	/**
741	* One variant per built-in tool; with none in the table (a plugin author's
742	* project before `/plugin-types` ran), one loose variant over every name.
743	*/
744	export type BuiltinToolCallInput = [BuiltinToolName] extends [never] ? BuiltinToolCallInputFallback : {
745	[N in BuiltinToolName]: ToolInputOf<N, BuiltinToolInputs[N]>;
746	}[BuiltinToolName];
747
748	/**
749	* The built-in branch's answer when no built-in tool is declared: every
750	* name, its args unconstrained.
751	*/
752	type BuiltinToolCallInputFallback = {
753	/**
754	* The name of the tool being called (`Bash`); comparing it narrows `e` once
755	* the table has entries. Reserved: a rewrite of it is ignored by core.
756	*/
757	tool: string;
758	/**
759	* The tool_use block's id: the same at every event of the call and in
760	* `$.ui.notice`. Reserved: a rewrite of it is ignored by core.
761	*/
762	tool_use_id: string;
763	[argument: string]: unknown;
764	};
765
766	/**
767	* The arguments of each built-in tool by name, for declaration merging;
768	* empty until a declaration file adds entries, then `e.tool === "Bash"`
769	* narrows `e` to Bash's arguments.
770	*
771	* `/plugin-types` writes this build's set beneath the engine's declarations
772	* (claude-code.d.ts), from each tool's input schema.
773	*
774	* @example
775	* interface BuiltinToolInputs { Bash: { command: string; timeout?: number } }
776	*/
777	export interface BuiltinToolInputs {
778	}
779
780	/**
781	* The names of the built-in tools.
782	*/
783	export type BuiltinToolName = keyof BuiltinToolInputs & string;
784
785	/**
786	* The structured result of each built-in tool by name, for declaration
787	* merging; empty until a declaration file adds entries, then after
788	* `e.tool === "Bash"` the `result` of `next(e)` is Bash's record.
789	*
790	* `/plugin-types` writes this build's set beneath the engine's declarations
791	* (claude-code.d.ts), from each tool's output schema; a tool without one is
792	* `unknown`.
793	*
794	* @example
795	* interface BuiltinToolResults { Bash: { stdout: string; stderr: string } }
796	*/
797	export interface BuiltinToolResults {
798	}
799
800	/**
801	* The props of `Button`, every surface's pressable leaf: an address, a
802	* label, the closure a press runs, and the label styles a hover overrides.
803	*
804	* The terminal draws `[ label ]` (when `plain`, `1: label` or the label
805	* alone), a desktop a native button; a click, a `hotkey`, the chord for its
806	* `action`, or Enter under the focus raises `ui.press`, its bottom `onPress`.
807	*/
808	export type ButtonProps = {
809	/**
810	* The element's address: `e.element` at `ui.press`, what a matcher names.
811	* Defaults to the label.
812	*/
813	key?: string;
814	/**
815	* The text drawn on the button; or the one string child.
816	*/
817	label?: string;
818	/**
819	* One digit (`"1"`) or one lowercase letter (`"w"`) that presses it while
820	* the plugin's site holds the focus; anything else is refused.
821	*
822	* The band after ctrl+x tab or a click, a focused `Pane`; never from the
823	* composer, save a bare digit in an empty one pressing a band Button, as a
824	* survey is answered. Shift+w matches `"w"`; two on one key, the later wins.
825	*/
826	hotkey?: string;
827	/**
828	* An engine keybinding action (`"app:cycleDiffBase"`) whose chord, as the
829	* person bound it, presses this from the prompt; unknown names refused.
830	*
831	* Chords, or a modified key Global or an active context binds, on the
832	* terminal while mounted, no dialog up and no engine handler of the action
833	* mounted; a pane's over the band's over another's, then the last drawn.
834	*/
835	action?: string;
836	/**
837	* Drawn without chrome: the hotkey in the accent color, a colon, the
838	* label (`1: Yes`), as a survey's row reads; no `hotkey`, the label alone.
839	*
840	* A one-glyph label (`'\u{1F50A}'`, a speaker) is then a control by
841	* itself: the focus and the pointer still invert it, `dimColor` and `hover`
842	* still apply. A desktop draws its native button either way.
843	*/
844	plain?: true;
845	/**
846	* The label drawn dim at rest, as `Text`'s `dimColor`, and at full strength
847	* under the pointer or the focus: a secondary control, a path in a list.
848	*/
849	dimColor?: boolean;
850	/**
851	* The site's focus ring starts here when the site takes the keyboard,
852	* instead of on nothing, as the DOM's `autofocus`: Enter acts on it at once.
853	*
854	* A pane opened with `focus`, or the person's focus chord or click, is the
855	* take. Of several in one site the first drawn wins; it raises `ui.focus`,
856	* origin this plugin. A ring the person has moved stays where it was put.
857	*/
858	autoFocus?: true;
859	/**
860	* Label style overrides (the `Text` set) applied by the surface while the
861	* nearest enclosing keyed `Box`, or given a `scope` its group, is hovered.
862	*
863	* No hook runs and nothing crosses to the plugin; under the pointer itself
864	* the button inverts as it always has. Refused outside a keyed Box unless
865	* it names a `scope`.
866	*/
867	hover?: TextHoverProps;
868	/**
869	* What the press runs, in the plugin's own environment: the bottom of the
870	* `ui.press` chain. The host holds only a handle, for the drawing's life.
871	*/
872	onPress: () => void;
873	};
874
875	/**
876	* The handler `on(...).catch(handler)` takes for a hook of type `F`: the
877	* hook's `($, e, next)`, run afresh when it throws, misreturns or overruns.
878	*
879	* `next` carries `error` and `called` (Caught) and is replay-safe; a return
880	* within the grace is the hook's result, `undefined` the hook absent. On a
881	* streaming event the handler is a generator too, continuing the stream.
882	*/
883	export type CatchHandler<F> = F extends ($: infer D, e: infer E, next: infer N) => infer R ? [R] extends [AsyncGenerator<unknown, unknown, unknown>] ? ($: D, e: E, next: N & Caught) => R : ($: D, e: E, next: N & Caught) => R \| undefined \| Promise<Awaited<R> \| undefined> : never;
884
885	/**
886	* What `next` carries into a `.catch` handler and nowhere else: why the
887	* hook failed, and whether it had called `next` before it did.
888	*
889	* There `next` is replay-safe: when `called`, `next(e)` resolves to what the
890	* hook's last call settled to, nothing beneath running again, the argument
891	* unread; when not, it runs the hooks beneath once and a later call replays.
892	*/
893	export type Caught = {
894	/**
895	* Why the hook failed (HookFailure); undefined on an ordinary hook's
896	* `next`, so its presence says a handler is running.
897	*/
898	readonly error: HookFailure;
899	/**
900	* True when the failed hook had called `next()` or `next.to()` at least
901	* once, settled or in flight; the handler runs once that call settled.
902	*/
903	readonly called: boolean;
904	};
905
906	/**
907	* What a hook on streaming event `N` yields, and what its `next(e)` yields
908	* to it (ChunkOf by name).
909	*/
910	export type Chunk<N extends StreamingEventName = StreamingEventName> = ChunkOf[N];
911
912	/**
913	* The chunk type of each streaming event, by name: what its stream yields.
914	*/
915	export type ChunkOf = {
916	/**
917	* One piece of the model's response (TurnStepChunk).
918	*/
919	'turn.step': TurnStepChunk;
920	};
921
922	/**
923	* What every `turn.step` chunk may carry: the engine's handle on the item
924	* of its own stream the chunk was read off, absent on a chunk a hook made.
925	*
926	* A hook that passes a chunk on, or rewrites it by spreading it, keeps the
927	* handle, and whatever it left unchanged reaches the engine as the engine
928	* streamed it; a chunk built afresh has none and is taken at its word.
929	*/
930	type ChunkRef = {
931	/**
932	* The engine's handle on its own streamed item; opaque, this step's only.
933	*/
934	ref?: number;
935	};
936
937	/**
938	* The name of a classic hook event as a function-hooks event: the settings
939	* hook's own name under `classic` (`classic.Stop`, `classic.PreToolUse`).
940	*/
941	export type ClassicEventName = `classic.${ClassicHookEvent}`;
942
943	/**
944	* The classic (settings) hook events, one per classic event name: `e` is
945	* what the classic hook receives on stdin for that event.
946	*
947	* The chain is [managed settings hooks, ...hooks modules, the other settings
948	* hooks as core], so a managed block ends it above every module. In shape
949	* `classic.PreToolUse` alone differs: its `e` is ToolCallEnvelope, no more.
950	*/
951	export type ClassicEventOf = {
952	[E in ClassicHookEvent as `classic.${E}`]: E extends 'PreToolUse' ? ToolCallEnvelope : ClassicHookInputs[E];
953	};
954
955	/**
956	* The name of a classic hook event: `PreToolUse`, `Stop`, and the rest.
957	*/
958	export type ClassicHookEvent = HookInput['hook_event_name'];
959
960	/**
961	* What a classic hook receives on stdin for each event, by event name: the
962	* Agent SDK's `<Event>HookInput`.
963	*/
964	export type ClassicHookInputs = {
965	[I in HookInput as I['hook_event_name']]: I;
966	};
967
968	/**
969	* Everything a classic hook event's answer can carry, named as the classic
970	* hook's JSON output names it; each event reads its subset (ClassicResultOf).
971	*
972	* The settings hooks below fold into one of these (last write wins, contexts
973	* concatenate); a hooks module returns `next(e)`, a copy with fields changed,
974	* or its own. A field of the wrong shape fails the hook, which is skipped.
975	*/
976	export type ClassicResult = {
977	/**
978	* `decision: "block"` with this text as `reason` (a command hook's exit
979	* code 2): the event's block, veto or re-prompt.
980	*/
981	block?: string;
982	/**
983	* `continue: false`: the session stops after this event.
984	*/
985	preventContinuation?: true;
986	/**
987	* Shown when `preventContinuation` stops the session (`stopReason`).
988	*/
989	stopReason?: string;
990	/**
991	* `hookSpecificOutput.additionalContext`, one entry per hook: text handed
992	* to the model with the event.
993	*/
994	additionalContext?: string[];
995	/**
996	* `hookSpecificOutput.sessionTitle` (UserPromptSubmit, SessionStart).
997	*/
998	sessionTitle?: string;
999	/**
1000	* `hookSpecificOutput.suppressOriginalPrompt` (UserPromptSubmit,
1001	* UserPromptExpansion).
1002	*/
1003	suppressOriginalPrompt?: true;
1004	/**
1005	* `hookSpecificOutput.initialUserMessage` (SessionStart).
1006	*/
1007	initialUserMessage?: string;
1008	/**
1009	* `hookSpecificOutput.watchPaths` (SessionStart).
1010	*/
1011	watchPaths?: string[];
1012	/**
1013	* `hookSpecificOutput.reloadSkills` (SessionStart).
1014	*/
1015	reloadSkills?: true;
1016	/**
1017	* `hookSpecificOutput.permissionDecision` (PreModelSwitch).
1018	*/
1019	permissionDecision?: 'allow' \| 'deny' \| 'ask';
1020	/**
1021	* `hookSpecificOutput.permissionDecisionReason` (PreModelSwitch).
1022	*/
1023	permissionDecisionReason?: string;
1024	/**
1025	* `hookSpecificOutput.decision` (PermissionRequest).
1026	*/
1027	decision?: PermissionRequestDecision;
1028	/**
1029	* `hookSpecificOutput.updatedToolOutput` (PostToolUse): replaces what the
1030	* model sees of the tool's result.
1031	*/
1032	updatedToolOutput?: unknown;
1033	/**
1034	* `hookSpecificOutput.updatedMCPToolOutput` (PostToolUse, MCP tools only).
1035	*/
1036	updatedMCPToolOutput?: unknown;
1037	/**
1038	* `hookSpecificOutput.retry` (PermissionDenied).
1039	*/
1040	retry?: true;
1041	/**
1042	* `hookSpecificOutput.displayContent` (MessageDisplay).
1043	*/
1044	displayContent?: string;
1045	/**
1046	* `hookSpecificOutput.worktreePath` (WorktreeCreate; a command hook prints
1047	* it): the worktree the hook created, absolute or relative to its cwd.
1048	*
1049	* Left unset, the session creates its git worktree as it would unhooked.
1050	*/
1051	worktreePath?: string;
1052	};
1053
1054	/**
1055	* The event-specific fields of ClassicResult each classic event reads (its
1056	* `hookSpecificOutput`), by event; an event absent here reads none of them.
1057	*
1058	* `block`, `preventContinuation` and `stopReason` are every event's.
1059	*/
1060	export type ClassicResultFields = {
1061	UserPromptSubmit: 'additionalContext' \| 'sessionTitle' \| 'suppressOriginalPrompt';
1062	UserPromptExpansion: 'additionalContext' \| 'suppressOriginalPrompt';
1063	SessionStart: 'additionalContext' \| 'initialUserMessage' \| 'sessionTitle' \| 'watchPaths' \| 'reloadSkills';
1064	Setup: 'additionalContext';
1065	PreModelSwitch: 'permissionDecision' \| 'permissionDecisionReason';
1066	PostModelSwitch: 'additionalContext';
1067	SubagentStart: 'additionalContext';
1068	PostToolUse: 'additionalContext' \| 'updatedToolOutput' \| 'updatedMCPToolOutput';
1069	PostToolUseFailure: 'additionalContext';
1070	PostToolBatch: 'additionalContext';
1071	Stop: 'additionalContext';
1072	SubagentStop: 'additionalContext';
1073	PermissionDenied: 'retry';
1074	PermissionRequest: 'decision';
1075	MessageDisplay: 'displayContent';
1076	WorktreeCreate: 'worktreePath';
1077	};
1078
1079	/**
1080	* What each classic hook event's hook returns and its `next(e)` resolves to:
1081	* the event's own subset of ClassicResult.
1082	*
1083	* `classic.PreToolUse` keeps its `allow` / `ask` / `deny` result
1084	* (PreToolUseResult).
1085	*/
1086	export type ClassicResultOf = {
1087	[E in ClassicHookEvent as `classic.${E}`]: E extends 'PreToolUse' ? PreToolUseResult : Pick<ClassicResult, 'block' \| 'preventContinuation' \| 'stopReason' \| (E extends keyof ClassicResultFields ? ClassicResultFields[E] : never)>;
1088	};
1089
1090	/**
1091	* Options of `$.model.classify`.
1092	*/
1093	export type ClassifyOptions = {
1094	/**
1095	* An alias (`haiku`) or a full model id; default the engine's small fast
1096	* model.
1097	*/
1098	model?: string;
1099	};
1100
1101	/**
1102	* The element table a surface module draws with, `surface.elements`: the
1103	* terminal's (Elements) less `Client` (none nests), `Raster` and `Image`.
1104	*
1105	* What `$.ui.resolve(e)` is to a hooks module; a Button, Input or Select
1106	* keeps its handler here. A tree of them keeps every tree's bounds (20,000
1107	* nodes, 32 deep, 100,000 characters serialized) or the instance unmounts.
1108	*/
1109	export type ClientElements = Omit<Elements['terminal'], 'Client' \| 'Raster' \| 'Image'>;
1110
1111	/**
1112	* One key the person pressed while a `Client` had the focus, as
1113	* `surface.onKey` hands it. Escape never arrives: it returns the focus.
1114	*/
1115	export type ClientKeyEvent = {
1116	/**
1117	* A special key's name (`up`, `down`, `left`, `right`, `return`, `tab`,
1118	* `backspace`, `delete`, `pageup`, `home`, ...) or the character typed.
1119	*/
1120	key: string;
1121	/**
1122	* Modifier keys held with it, each present only when true.
1123	*/
1124	ctrl?: true;
1125	shift?: true;
1126	meta?: true;
1127	};
1128
1129	/**
1130	* The component a surface module exports (default, or its one PascalCase
1131	* export): from props and surface to the tree drawn (no nested `Client`).
1132	*
1133	* Runs on the drawing thread, a second per call at most; `h` and `Fragment`
1134	* are the environment's, so nothing of the module's takes those names. A
1135	* throw, an overrun or a tree past the bounds (ClientElements) unmounts it.
1136	*
1137	* @example
1138	* const Tag: ClientModule<string> = (t, s) => s.elements.Text({ children: t })
1139	*/
1140	export type ClientModule<P extends JsonValue = JsonValue, S = unknown> = (props: P, surface: ClientSurface<S>) => RenderElement;
1141
1142	/**
1143	* One pointer event over a `Client`'s region, as `surface.onPointer` hands
1144	* it: region-relative cells, and the sub-cell position where known.
1145	*
1146	* After a `down` in the region the instance holds the pointer until the
1147	* `up`: every `move` reaches it, past the edges too (negative, or beyond
1148	* `columns`/`rows`), and the transcript neither selects nor scrolls.
1149	*/
1150	export type ClientPointerEvent = {
1151	type: ClientPointerType;
1152	/**
1153	* The column under the pointer, 0 at the region's left edge; on `enter`
1154	* and `leave`, the last column a move reported.
1155	*/
1156	x: number;
1157	/**
1158	* The row under the pointer, 0 at the region's top edge.
1159	*/
1160	y: number;
1161	/**
1162	* The same position with the fraction of a cell kept (`x: 12`, `fine.x:
1163	* 12.375`), where the surface knows it: a terminal that reports pixels.
1164	*
1165	* kitty, Ghostty, iTerm2, WezTerm and foot do; tmux passes none through.
1166	* Absent elsewhere and on `enter`/`leave`; present, a `move` comes within
1167	* a cell too. What a module showing another program's pixels forwards.
1168	*
1169	* @example
1170	* surface.onPointer(e => click((e.fine?.x ?? e.x + 0.5) * pixelsPerCell))
1171	*/
1172	fine?: {
1173	x: number;
1174	y: number;
1175	};
1176	/**
1177	* Which button is down (`down`, `move` while held) or came up (`up`);
1178	* absent on a hover `move`, `enter` and `leave`.
1179	*/
1180	button?: 'left' \| 'middle' \| 'right';
1181	/**
1182	* Modifier keys the terminal reported held, each present only when true.
1183	*/
1184	shift?: true;
1185	alt?: true;
1186	ctrl?: true;
1187	};
1188
1189	/**
1190	* What the pointer did over a `Client`'s region: a button went down, the
1191	* pointer moved, the button came up, or the pointer crossed the region's edge.
1192	*/
1193	export type ClientPointerType = 'down' \| 'move' \| 'up' \| 'enter' \| 'leave';
1194
1195	/**
1196	* The props of `Client`: which of the plugin's surface modules draws here,
1197	* under what key, with what data, in how much room.
1198	*/
1199	export type ClientProps = {
1200	/**
1201	* The instance's address within the drawing: two `Client`s of one plugin in
1202	* one tree take two keys. What `e.element` carries at `ui.message`.
1203	*
1204	* The engine keeps the instance (its local state, its timers) across the
1205	* plugin's redraws while a `Client` under this key stays in the tree.
1206	*/
1207	key: string;
1208	/**
1209	* The surface module's path, a string literal relative to this file:
1210	* `module: "./<name>.tsx"` (or `.jsx`, `.ts`, `.js`, `.mjs`).
1211	*
1212	* Read off the source: a variable there is refused at load, as is a path
1213	* outside the plugin or naming no file. Its default export draws, else
1214	* its one PascalCase export; loaded, the tree carries the plugin's path.
1215	*/
1216	module: string;
1217	/**
1218	* Plain data (JsonValue) handed to the module function; a new value on a
1219	* redraw reaches the running instance, its state kept.
1220	*
1221	* Bounded as a tree's text is; not a channel for closures.
1222	* Typed `unknown` so a matcher over a tree stays shallow.
1223	*/
1224	props?: unknown;
1225	/**
1226	* Columns the instance's region takes: a count, or a percentage of the
1227	* parent. Absent, the region is as wide as what the module draws.
1228	*/
1229	width?: number \| string;
1230	/**
1231	* Rows the instance's region takes: a count, or a percentage of the parent.
1232	* Absent, the region is as tall as what the module draws.
1233	*/
1234	height?: number \| string;
1235	/**
1236	* How the region grows into free room along the parent's direction, as a
1237	* Box's `flexGrow`.
1238	*/
1239	flexGrow?: number;
1240	};
1241
1242	/**
1243	* What a surface module's function receives as its second argument: its
1244	* elements, the instance's local state, its region, input, clock and port.
1245	*
1246	* Called again (same `surface`, same `state`) on new props, after
1247	* `setState`, and on a resize; what it returns is drawn in the region. No
1248	* `$` here: the hooks module has it, and `post` is the way to reach it.
1249	*/
1250	export type ClientSurface<S = unknown> = {
1251	/**
1252	* The surface's element table (ClientElements), the tags the module draws
1253	* with: `const { Box, Text } = surface.elements`. No `Client` in it.
1254	*/
1255	readonly elements: ClientElements;
1256	/**
1257	* The instance's local state: `undefined` until the first `setState`.
1258	* Kept across the plugin's redraws; dropped with the instance.
1259	*/
1260	readonly state: S \| undefined;
1261	/**
1262	* Replaces the local state and schedules one more call of the function on
1263	* the next frame; several calls before it coalesce into one redraw.
1264	*
1265	* A `setState` on each of three renders in a row with no key, pointer,
1266	* tick, press or props between is a render loop: the instance unmounts.
1267	*/
1268	setState: (next: S) => void;
1269	/**
1270	* The region's width in cells, as last laid out (0 before the first
1271	* layout).
1272	*/
1273	readonly columns: number;
1274	/**
1275	* The region's height in cells, as last laid out (0 before the first
1276	* layout).
1277	*/
1278	readonly rows: number;
1279	/**
1280	* Calls `fn` every `ms` milliseconds on the surface's frame clock until
1281	* the returned function is called or the instance unmounts.
1282	*
1283	* Start it once (while `state` is still undefined), not on every call.
1284	*/
1285	every: (ms: number, fn: () => void) => () => void;
1286	/**
1287	* Sets the instance's pointer listener (one; a later call replaces it)
1288	* and returns what clears it. See ClientPointerEvent for capture.
1289	*/
1290	onPointer: (fn: (event: ClientPointerEvent) => void) => () => void;
1291	/**
1292	* Sets the instance's key listener (one; a later call replaces it),
1293	* reached while a click has given it the focus; Escape returns that.
1294	*/
1295	onKey: (fn: (event: ClientKeyEvent) => void) => () => void;
1296	/**
1297	* Sends plain data to the plugin's hooks module: `e.data` of a
1298	* `ui.message` only that plugin's hooks see, one per frame at most.
1299	*
1300	* A later post in the same frame replaces an undelivered one; a hook
1301	* answering `{ props }` hands this instance its next props. At most
1302	* 20,000 values, 32 deep, 100,000 characters, or the post is not sent.
1303	*/
1304	post: (data: JsonValue) => void;
1305	};
1306
1307	/**
1308	* The argument of the `$.clock` waits (`sleep`, `after`, `every`): how long,
1309	* in milliseconds, before the dispatch resolves.
1310	*/
1311	type ClockWait = {
1312	/**
1313	* The wait, a non-negative number of milliseconds.
1314	*/
1315	ms: number;
1316	};
1317
1318	/**
1319	* The props of `Code`, source text every surface draws with the engine's own
1320	* highlighter: coloured tokens, a line gutter on request, or a unified diff.
1321	*
1322	* A leaf: no children. `source` is the element's data as a string is a
1323	* Text's, bounded and free of control characters the same way; the colour
1324	* on screen is the engine's, never the plugin's.
1325	*/
1326	export type CodeProps = {
1327	/**
1328	* The text drawn: source code, or under `format: 'diff'` one or more
1329	* unified-diff hunks.
1330	*
1331	* At most 10000 characters; tab and newline are the only control
1332	* characters it may hold.
1333	*/
1334	source: string;
1335	/**
1336	* A highlighter language id or alias (`typescript`, `ts`, `py`), a
1337	* plugin-contributed grammar's included.
1338	*
1339	* Absent, the language is inferred from `path`; when neither resolves,
1340	* the text is drawn plain.
1341	*/
1342	language?: string;
1343	/**
1344	* A file path the language is inferred from when `language` is absent:
1345	* its extension or name, else a shebang on the first line.
1346	*
1347	* Drawn nowhere and never read: nothing touches the disk.
1348	*/
1349	path?: string;
1350	/**
1351	* The 1-based number of the first line of `source`: present, a dim
1352	* right-aligned gutter numbers the lines from it; absent, no gutter.
1353	*
1354	* Ignored under `format: 'diff'`, whose hunks carry their own numbers.
1355	*/
1356	startLine?: number;
1357	/**
1358	* `'source'` (the default) draws `source` as code; `'diff'` reads it as
1359	* unified-diff hunks and draws gutters, markers, add and remove colouring.
1360	*
1361	* A hunk is `@@ -a,b +c,d @@` then lines starting ` `, `+` or `-`; a
1362	* leading `---`/`+++` pair and `\ No newline at end of file` are read
1363	* past. A source that does not parse as hunks is refused.
1364	*/
1365	format?: 'source' \| 'diff';
1366	/**
1367	* What a line wider than the room does, in Text's `wrap` vocabulary:
1368	* `'wrap'` (the default) continues it on rows under the gutter.
1369	*
1370	* `'truncate-end'` cuts it at the edge with an ellipsis; Text's other
1371	* spellings are refused, since a gutter leaves them no sense here.
1372	*/
1373	wrap?: 'wrap' \| 'truncate-end';
1374	};
1375
1376	/**
1377	* The input of `command.describe`: how one slash command presents in the
1378	* typeahead and `/help`, at the moment the engine lists it.
1379	*/
1380	export type CommandDescribeInput = {
1381	/**
1382	* Names the command without its slash; the key a matcher narrows on. A
1383	* rewrite is refused.
1384	*/
1385	command: string;
1386	/**
1387	* The one-line description the menu shows, as the command declares it.
1388	*/
1389	description: string;
1390	/**
1391	* The hint drawn dim after the name (`[name]`), when the command has one.
1392	*/
1393	argumentHint?: string;
1394	/**
1395	* Whether the typeahead and `/help` leave the command out; a hidden
1396	* command still runs when typed in full.
1397	*/
1398	isHidden: boolean;
1399	/**
1400	* Whether the command declares it runs at once when typed mid-turn,
1401	* instead of waiting for the turn to end.
1402	*
1403	* One that decides per invocation reads false. Read only: not part of
1404	* what a hook answers, and a rewrite is refused.
1405	*/
1406	immediate: boolean;
1407	/**
1408	* Who provides this command: the plugin and its tier; `{ plugin: "engine",
1409	* tier: "core" }` for a built-in. Pinned: a rewrite is refused.
1410	*/
1411	provider: Origin;
1412	};
1413
1414	/**
1415	* What a `command.describe` hook returns: the description, hint and hidden
1416	* flag the menu uses; the name, `immediate` and `provider` stay as they were.
1417	*/
1418	export type CommandDescribeResult = Omit<CommandDescribeInput, 'command' \| 'immediate' \| 'provider'>;
1419
1420	/**
1421	* One slash command as `$.command.list()` returns it.
1422	*/
1423	export type CommandInfo = {
1424	/**
1425	* What the person runs it by, without the slash.
1426	*/
1427	name: string;
1428	/**
1429	* The one line the typeahead shows for it.
1430	*/
1431	description: string;
1432	/**
1433	* Where it comes from (CommandSource).
1434	*/
1435	source: CommandSource;
1436	/**
1437	* Which plugin added it, when `source` is `plugin` and the engine knows:
1438	* the one that registered it, or whose manifest carries it.
1439	*/
1440	plugin?: string;
1441	};
1442
1443	/**
1444	* Where a command's answer will show: which of the terminal's two layouts
1445	* the surface renders, and how wide it is when the command runs.
1446	*
1447	* A fact the engine stamps on `command.run`, so a command that draws (opens
1448	* a pane, prints a wide table) can suit the room it has: the fullscreen
1449	* layout docks a pane beside the transcript from 110 columns, the main
1450	* screen places it inline above the prompt at any width.
1451	*/
1452	export type CommandPresentation = {
1453	/**
1454	* True under the fullscreen (alternate-screen) layout; false on the main
1455	* screen (`CLAUDE_CODE_NO_FLICKER=0`, tmux by default) and headless.
1456	*
1457	* The fact `RenderViewport`'s `isFullscreen` carries on every terminal
1458	* drawing, from the same source: the two agree.
1459	*/
1460	isFullscreen: boolean;
1461	/**
1462	* The terminal's width in cells as the command runs; 80 where no terminal
1463	* has measured (headless with no tty).
1464	*/
1465	columns: number;
1466	};
1467
1468	/**
1469	* `command.run`'s input as a plugin's `$.command.run` takes it: `args` may
1470	* be left out (`/command`, bare); `origin` and `presentation` the engine sets.
1471	*/
1472	export type CommandRunArgs = Omit<CommandRunInput, 'origin' \| 'args' \| 'presentation'> & {
1473	/**
1474	* Everything after the name, as the person would type it; left out, `""`.
1475	*/
1476	args?: string;
1477	};
1478
1479	/**
1480	* The input of `command.run`: one slash command about to run, the way the
1481	* person typed it (`/name args`), and where the run came from.
1482	*/
1483	export type CommandRunInput = {
1484	/**
1485	* Names the command without its slash (`compact`, `hello`), aliases and
1486	* folds resolved; the key a matcher narrows on. A rewrite is refused.
1487	*/
1488	command: string;
1489	/**
1490	* Everything after the name, as typed (`""` when nothing was); a hook
1491	* rewrites it with `next({ ...e, args })`.
1492	*/
1493	args: string;
1494	/**
1495	* Where the run came from, in `prompt.submit`'s words (PromptOrigin):
1496	* the person's Enter (`composer`), the bridge, the SDK, or a plugin.
1497	*
1498	* A plugin's `$.command.run` reads `{ kind: 'plugin', name }`. `next(e)`
1499	* passes it on as received.
1500	*/
1501	origin: PromptOrigin;
1502	/**
1503	* Where the command's answer will show (CommandPresentation): the
1504	* fullscreen layout or the main screen, and the terminal's width.
1505	*
1506	* Pinned: the engine stamps it, `next(e)` passes it on, a rewrite that
1507	* leaves it out keeps it and one that changes it is refused.
1508	*/
1509	presentation: CommandPresentation;
1510	};
1511
1512	/**
1513	* What a `command.run` hook returns and what `next(e)` and `$.command.run`
1514	* resolve to: the command's output text and the notes it leaves the model.
1515	*
1516	* From core, `text` is what the command printed (a `local` command's
1517	* returned text; a panel command may print nothing), `context` what it
1518	* recorded for the model beside that, and `ref` names the run.
1519	*
1520	* A hook's own answer without `next` runs no command: its `text` is shown
1521	* as the command's output, under the names of the plugins hooking the
1522	* command unless each is bundled with Claude Code, whose answer reads as
1523	* the built-in command's own, and its `context` is recorded after it.
1524	*
1525	* Both are the plugin's to size, as a core command's output is; what bounds
1526	* them is what bounds any transcript row where a surface draws it.
1527	*/
1528	export type CommandRunResult = {
1529	/**
1530	* The command's output as a transcript line, or undefined when the
1531	* command showed nothing as text (a panel, a prompt for the model).
1532	*/
1533	text?: string;
1534	/**
1535	* What the model reads after the command's output and the person never
1536	* sees, each entry one hidden user message recorded after the output row.
1537	*
1538	* From core, the notes the command left the model, absent when none. Kept
1539	* whole from `next`: left out after `next`, the last answer's notes ride
1540	* along; written, it keeps every entry that answer had (none empty).
1541	*/
1542	context?: readonly string[];
1543	/**
1544	* Set by core on what `next(e)` resolves to: names the engine's run of
1545	* the command (its result stays on the host side).
1546	*
1547	* A hook that returns the object it got makes the engine use that run
1548	* verbatim. Absent on a hook's own `{ text }` and on `$.command.run`'s.
1549	*/
1550	ref?: number;
1551	};
1552
1553	/**
1554	* Where a slash command comes from, as `$.command.list()` tells them apart.
1555	*
1556	* `builtin` ships with Claude Code; `plugin` is a plugin's markdown command,
1557	* skill or `$.command.register`; `user` is the user's or project's own
1558	* file; `mcp` an MCP server's prompt.
1559	*/
1560	export type CommandSource = 'builtin' \| 'plugin' \| 'user' \| 'mcp';
1561
1562	/**
1563	* What `$.command.register` takes: the slash command this plugin serves.
1564	*/
1565	export type CommandSpec = {
1566	/**
1567	* The command's name without the slash (letters, digits, `_`, `-`; up to
1568	* 64); the person runs it as `/<name>`.
1569	*/
1570	name: string;
1571	/**
1572	* The one line the typeahead and `/help` show for it.
1573	*/
1574	description: string;
1575	/**
1576	* The hint drawn dim after the name (`[name]`), when it takes arguments.
1577	*/
1578	argumentHint?: string;
1579	/**
1580	* Set so that `/<name>` typed while a turn is in flight runs at once
1581	* instead of waiting for the turn to end, as it does when left out.
1582	*
1583	* Its `command.run` hook then runs while a turn may still be streaming and
1584	* must not assume the turn's state (what the transcript holds, whether a
1585	* tool is mid-call); its `{ text }` prints as an idle run's does.
1586	*/
1587	immediate?: true;
1588	};
1589
1590	type ConfigChangeHookInput = BaseHookInput & {
1591	hook_event_name: 'ConfigChange';
1592	source: 'user_settings' \| 'project_settings' \| 'local_settings' \| 'policy_settings' \| 'skills';
1593	file_path?: string;
1594	};
1595
1596	/**
1597	* The input of `config.describe`: how one `/config` row presents, at the
1598	* moment the menu lists it (and for `$.config.list`).
1599	*/
1600	export type ConfigDescribeInput = {
1601	/**
1602	* Names the row, as `config.set`'s `key` does; the key a matcher narrows
1603	* on. Pinned: a rewrite is refused.
1604	*/
1605	key: string;
1606	/**
1607	* What the menu draws for the row, before its value.
1608	*/
1609	label: string;
1610	/**
1611	* The help text beneath the label, when the row has one (a plugin
1612	* field's `description`); absent for the panel's own rows.
1613	*/
1614	description?: string;
1615	/**
1616	* Whether the menu leaves the row out; a hidden row still answers
1617	* `$.config.set` and `/config key=value`.
1618	*/
1619	isHidden: boolean;
1620	/**
1621	* Who owns the row, as `config.set`'s `provider`. Pinned.
1622	*/
1623	provider: Origin;
1624	};
1625
1626	/**
1627	* What a `config.describe` hook returns: the label, help text and hidden
1628	* flag the menu uses; the key and provider stay as they were.
1629	*/
1630	export type ConfigDescribeResult = Omit<ConfigDescribeInput, 'key' \| 'provider'>;
1631
1632	/**
1633	* How a `/config` row takes its value: `boolean` toggles, `choice` picks one
1634	* of its `options`, `text` takes a string, `number` a number.
1635	*/
1636	export type ConfigKind = 'boolean' \| 'choice' \| 'text' \| 'number';
1637
1638	/**
1639	* Where a `config.set` came from, in `prompt.submit`'s words: the person
1640	* in the `/config` menu (`composer`), the bridge, or a plugin, named.
1641	*
1642	* Set by the engine; `next(e)` passes it on as received and none sets it.
1643	*/
1644	export type ConfigOrigin = {
1645	/**
1646	* The person's own change in the `/config` menu (a toggle, a pick, a
1647	* typed value), or their `/config key=value`.
1648	*/
1649	kind: 'composer';
1650	} \| {
1651	/**
1652	* A `/config key=value` that arrived over the Remote Control bridge (a
1653	* phone or web client, or a relay): not attestably the owner's hand.
1654	*/
1655	kind: 'bridge';
1656	} \| {
1657	/**
1658	* A plugin's `$.config.set`; that plugin's own hooks do not see it.
1659	*/
1660	kind: 'plugin';
1661	/**
1662	* The calling plugin's name.
1663	*/
1664	name: string;
1665	};
1666
1667	/**
1668	* One `/config` row as `$.config.list()` returns it: what the menu would
1669	* draw now, after every `config.describe` hook, a hidden row left out.
1670	*/
1671	export type ConfigRow = {
1672	/**
1673	* Names the row: the panel's id for a built-in, `<plugin>.<field>` for a
1674	* plugin's `userConfig` field; what `$.config.set` takes.
1675	*/
1676	key: string;
1677	/**
1678	* What the menu draws for the row, before its value.
1679	*/
1680	label: string;
1681	/**
1682	* The help text under the label, when the row has one.
1683	*/
1684	description?: string;
1685	/**
1686	* How the row takes its value (ConfigKind).
1687	*/
1688	kind: ConfigKind;
1689	/**
1690	* What the row holds now.
1691	*/
1692	value: ConfigValue;
1693	/**
1694	* The values a `choice` row takes, in order (a plugin string field's
1695	* declared `options` for its row); absent otherwise.
1696	*/
1697	options?: readonly string[];
1698	/**
1699	* Who owns the row: the engine for the panel's own, else the plugin.
1700	*/
1701	provider: Origin;
1702	/**
1703	* Whether a trusted source (managed settings, the organization's policy)
1704	* owns the value, so the menu shows it and refuses a change.
1705	*/
1706	isLocked: boolean;
1707	};
1708
1709	/**
1710	* `config.set`'s input as a plugin's `$.config.set(args)` takes it: the
1711	* row's key and the value; the engine fills the rest.
1712	*/
1713	export type ConfigSetArgs = Pick<ConfigSetInput, 'key' \| 'value'>;
1714
1715	/**
1716	* The input of `config.set`: one `/config` row about to change, from the
1717	* menu or a plugin's `$.config.set`, with what it holds now and who owns it.
1718	*/
1719	export type ConfigSetInput = {
1720	/**
1721	* Names the row: the panel's own id for a built-in (`theme`, `verbose`,
1722	* `autoCompact`), `<plugin>.<field>` for a plugin's `userConfig` field.
1723	*
1724	* The key a matcher narrows on; pinned: a rewrite is refused.
1725	*/
1726	key: string;
1727	/**
1728	* What the row is being set to; `next({ ...e, value })` clamps or
1729	* replaces it, held to the row's kind (a toggle takes a boolean).
1730	*/
1731	value: ConfigValue;
1732	/**
1733	* What the row holds before the change, as the menu shows it. Pinned.
1734	*/
1735	previous: ConfigValue;
1736	/**
1737	* Who owns the row: `{ plugin: "engine", tier: "core" }` for the panel's
1738	* own, the plugin and its tier for a `userConfig` field. Pinned.
1739	*/
1740	provider: Origin;
1741	/**
1742	* Where the change came from (ConfigOrigin): the person in the menu
1743	* (`composer`) or a plugin's `$.config.set`. Pinned.
1744	*/
1745	origin: ConfigOrigin;
1746	};
1747
1748	/**
1749	* What a `config.set` hook returns and what `next(e)` resolves to:
1750	* `{ value }` once written, or `{ deny: reason }`, the row left as it was.
1751	*
1752	* The menu shows a deny's reason beside the row; a plugin's `$.config.set`
1753	* resolves with it.
1754	*/
1755	export type ConfigSetResult = {
1756	value: ConfigValue;
1757	deny?: undefined;
1758	} \| {
1759	deny: string;
1760	value?: undefined;
1761	};
1762
1763	/**
1764	* A `/config` row's value as a hook and `$.config` see it: a toggle's
1765	* boolean, a choice's or a text's string, a number, or a list of strings.
1766	*/
1767	export type ConfigValue = boolean \| string \| number \| readonly string[];
1768
1769	/**
1770	* One custom agent whose description the Agent tool's prompt carries;
1771	* built-in agents are left out.
1772	*/
1773	export type ContextAgent = {
1774	/**
1775	* The agent's type, as the Agent tool names it.
1776	*/
1777	agentType: string;
1778	/**
1779	* Where it was defined, by the engine's word (`projectSettings`,
1780	* `userSettings`, `plugin`); the display label is the renderer's.
1781	*/
1782	source: string;
1783	/**
1784	* The description's estimated tokens.
1785	*/
1786	tokens: number;
1787	};
1788
1789	/**
1790	* The token counts the last API response of the live window reported, as
1791	* the API spells them; the breakdown's `Messages` row is reconciled to it.
1792	*/
1793	export type ContextApiUsage = {
1794	/**
1795	* Uncached input tokens the response was answered over.
1796	*/
1797	input_tokens: number;
1798	/**
1799	* Tokens the response generated.
1800	*/
1801	output_tokens: number;
1802	/**
1803	* Input tokens written to the prompt cache by the request.
1804	*/
1805	cache_creation_input_tokens: number;
1806	/**
1807	* Input tokens read from the prompt cache by the request.
1808	*/
1809	cache_read_input_tokens: number;
1810	};
1811
1812	/**
1813	* How a context breakdown is counted: `full` with the token-count API per
1814	* category, `summary` from the last response's usage and local estimates.
1815	*
1816	* The SDK's `get_context_usage` takes the same two words as its `detail`.
1817	*/
1818	export type ContextBreakdownDetail = 'summary' \| 'full';
1819
1820	/**
1821	* One row of the breakdown, as /context lists it beside the grid (`System
1822	* prompt`, `Messages`, `Free space`, `Autocompact buffer`).
1823	*/
1824	export type ContextCategory = {
1825	/**
1826	* The row's label as /context prints it.
1827	*/
1828	name: string;
1829	/**
1830	* The row's estimated tokens; a `deferred` row's do not count toward the
1831	* total.
1832	*/
1833	tokens: number;
1834	/**
1835	* The theme colour /context draws the row and its squares in, by its key
1836	* in the theme (`promptBorder`, `inactive`, `permission`).
1837	*/
1838	color: string;
1839	/**
1840	* Whether the row is tool schemas loaded on demand, which the grid leaves
1841	* out; the same fact as `kind` `deferred`.
1842	*/
1843	isDeferred: boolean;
1844	/**
1845	* What the row is (ContextCategoryKind), stamped by the engine.
1846	*/
1847	kind: ContextCategoryKind;
1848	};
1849
1850	/**
1851	* What a breakdown row is; branch on this, never on the row's `name`.
1852	*
1853	* `used` content occupies the window, `free` is the window left, `buffer`
1854	* the compaction reserve, `deferred` tool schemas loaded on demand and
1855	* outside the window.
1856	*/
1857	export type ContextCategoryKind = 'used' \| 'free' \| 'buffer' \| 'deferred';
1858
1859	/**
1860	* One square of the grid /context draws: which row it belongs to and how
1861	* full it is.
1862	*/
1863	export type ContextGridSquare = {
1864	/**
1865	* The theme colour of the square's row, by its key in the theme.
1866	*/
1867	color: string;
1868	/**
1869	* Whether the square holds any of its row's tokens.
1870	*/
1871	isFilled: boolean;
1872	/**
1873	* The `name` of the row the square belongs to (`Free space` for the
1874	* window left).
1875	*/
1876	categoryName: string;
1877	/**
1878	* The row's tokens, repeated on each of its squares.
1879	*/
1880	tokens: number;
1881	/**
1882	* The row's share of the window as a whole percentage, repeated likewise.
1883	*/
1884	percentage: number;
1885	/**
1886	* How full this one square is, 0 to 1: a row's last square is the partial
1887	* one (/context draws it hollow under 0.7).
1888	*/
1889	squareFullness: number;
1890	};
1891
1892	/**
1893	* One MCP tool's schema as the context carries it.
1894	*/
1895	export type ContextMcpTool = {
1896	/**
1897	* The tool's wire name (`mcp__linear__create_issue`).
1898	*/
1899	name: string;
1900	/**
1901	* The server it belongs to, as /mcp lists it.
1902	*/
1903	serverName: string;
1904	/**
1905	* The schema's estimated tokens.
1906	*/
1907	tokens: number;
1908	/**
1909	* Whether the schema is inside the window now: always, unless tool
1910	* schemas load on demand and this one has not been searched for yet.
1911	*/
1912	isLoaded: boolean;
1913	};
1914
1915	/**
1916	* One memory file the context carries (a CLAUDE.md, a rules file, an
1917	* auto-memory entry).
1918	*/
1919	export type ContextMemoryFile = {
1920	/**
1921	* The file's path, absolute.
1922	*/
1923	path: string;
1924	/**
1925	* The display label of where it was loaded from (`Project`, `User`,
1926	* `Local`, `Managed`, `AutoMem`).
1927	*/
1928	type: string;
1929	/**
1930	* The file's estimated tokens.
1931	*/
1932	tokens: number;
1933	};
1934
1935	/**
1936	* One skill whose listing the context carries.
1937	*/
1938	export type ContextSkill = {
1939	/**
1940	* The skill's name as `/skills` lists it.
1941	*/
1942	name: string;
1943	/**
1944	* Where it came from, by the engine's word (`userSettings`, `plugin`,
1945	* `built-in`, `mcp`, `syncedSkills`); the display label is the renderer's.
1946	*/
1947	source: string;
1948	/**
1949	* The providing plugin's name, when the skill comes from one.
1950	*/
1951	pluginName?: string;
1952	/**
1953	* The listing's estimated tokens.
1954	*/
1955	tokens: number;
1956	};
1957
1958	/**
1959	* The skills the context lists for the model: how many there are, how many
1960	* fit the listing's budget, and each one's share.
1961	*/
1962	export type ContextSkills = {
1963	/**
1964	* How many skills the session has.
1965	*/
1966	totalSkills: number;
1967	/**
1968	* How many the listing included within its token budget.
1969	*/
1970	includedSkills: number;
1971	/**
1972	* The listing's tokens in all.
1973	*/
1974	tokens: number;
1975	/**
1976	* One entry per listed skill.
1977	*/
1978	skillFrontmatter: ContextSkill[];
1979	};
1980
1981	/**
1982	* The slash commands the Skill tool's prompt lists, counted.
1983	*/
1984	export type ContextSlashCommands = {
1985	/**
1986	* How many commands the session has.
1987	*/
1988	totalCommands: number;
1989	/**
1990	* How many the listing included.
1991	*/
1992	includedCommands: number;
1993	/**
1994	* The listing's tokens in all.
1995	*/
1996	tokens: number;
1997	};
1998
1999	/**
2000	* How the window the breakdown measures against was settled; /context
2001	* prints its `Auto-compact window` line off this.
2002	*
2003	* `auto` is the model's own limit; the rest name a compaction window by who
2004	* set it: the `CLAUDE_CODE_AUTO_COMPACT_WINDOW` variable, the settings, the
2005	* account, an experiment, the model's default, or an unrecognised model's.
2006	*/
2007	export type ContextWindowSource = 'env' \| 'settings' \| 'clientdata' \| 'experiment' \| 'model-default' \| 'unknown-model' \| 'auto';
2008
2009	/**
2010	* The plugin's identity (`plugin`) and the nouns core contributes to `$` as
2011	* the innermost step of the `engine.create` fold.
2012	*
2013	* A plugin's finished `$` (EngineInterface) has every core noun an outer
2014	* step did not withhold, and every noun the plugins' steps added.
2015	*/
2016	export interface CoreEngineInterface {
2017	/**
2018	* This plugin, as loaded: its manifest name and its directory.
2019	*/
2020	plugin: {
2021	/**
2022	* From plugin.json; debug-log and `$.ui.log` lines carry it.
2023	*/
2024	name: string;
2025	/**
2026	* The plugin's directory (the one holding plugin.json), absolute.
2027	*/
2028	root: string;
2029	};
2030	/**
2031	* Display: a line under an open dialog, a redraw or a repaint, a
2032	* transcript or debug line, panes the surface places, a window or ring.
2033	*/
2034	ui: {
2035	/**
2036	* Shows `text` as one line under the dialog open for `tool_use_id`, or
2037	* removes the line when `text` is undefined.
2038	*
2039	* Core removes the line when the call resolves. A call that is not open
2040	* is refused, as is another plugin's `$.tool.call` run.
2041	*
2042	* @param tool_use_id the call whose open dialog gets the line
2043	* @param text the line to show; undefined removes it
2044	* @example
2045	* $.ui.notice(e.tool_use_id, "checked by my-plugin"); return next(e)
2046	*/
2047	notice: (tool_use_id: string, text: string \| undefined) => void;
2048	/**
2049	* Re-runs an event whose results the engine caches: `ui.render` draws the
2050	* instances this plugin may draw again; the others drop the cached answers.
2051	*
2052	* A render hook whose state changed (a countdown) calls it for a redraw, at
2053	* most ten a second, thirty for the shown pane and the band (calls sooner
2054	* fold); a prompt section, context or attachment hook: dropped next turn.
2055	*
2056	* @param event `ui.render`, or a cached-answer event: `prompt.section`,
2057	* `prompt.context`, `prompt.attachment`, `tool/command/config.describe`
2058	*/
2059	invalidate: (event: InvalidatableEventName) => void;
2060	/**
2061	* Repaints a mounted `Raster` this plugin's own render hook drew with new
2062	* cells, or swaps a keyed `Image` it drew to a new source; no redraw.
2063	*
2064	* The surface paints the cells or source at its next frame, so blits
2065	* between frames fold into one: up to 120 a second taken, some sixty
2066	* shown. An Image swap sends one small command; a resize is a redraw.
2067	*
2068	* @param args `requestId` (the site), `key`, and `cells` (RasterProps) or
2069	* `source` (ImageSource); `columns`, `rows` (the mounted size)
2070	* @returns `{}` once the cells or source are its next frame, or `{ deny }`
2071	* (not mounted, not this plugin's, another size, cells that do
2072	* not decode, a bad source, or an Image drawing its alt there:
2073	* no placeholder images, or a file this terminal cannot read)
2074	* @example
2075	* $.clock.every(33, () => $.ui.blit({ requestId, key, cells: frame() }))
2076	* @example
2077	* await $.ui.blit({ requestId: 'browser', key: 'view',
2078	* source: { shm: name, format: 'rgb', width, height } })
2079	*/
2080	blit: (args: UiBlitArgs) => Promise<UiBlitResult>;
2081	/**
2082	* The elements of the surface `e` is drawn on (Elements[e.surface]): a
2083	* frozen table of constructors, the JSX tags a render hook draws with.
2084	*
2085	* A read, not a dispatch: the engine ran `ui.resolve` (the other hooks,
2086	* then core) at load, per surface and component. Narrowed `e.surface`:
2087	* that table exactly; unnarrowed: the union, so shared names type-check.
2088	*
2089	* @param e this hook's own `ui.render` argument (its surface and
2090	* component pick the table)
2091	* @returns the surface's frozen element table (`Elements[e.surface]`)
2092	* @example
2093	* const { Box, Text } = $.ui.resolve(e)
2094	* return <Box>{await next(e)}<Text dimColor>done</Text></Box>
2095	*/
2096	resolve: <E extends ResolveInput>(e: E) => Elements[E['surface']];
2097	/**
2098	* Appends one line to the transcript, drawn like a system notice (dim;
2099	* not sent to the model), or with `{ to: "debug" }` to the debug log alone.
2100	*
2101	* A row of its own at the next frame, in logging order; a `-p` or SDK
2102	* host receives it as `ui_log`; the debug log has every line under this
2103	* plugin's name. Raised as `ui.log`: a hook above may rewrite `e.to`.
2104	*
2105	* @param text the line's text
2106	* @param options `to`: `transcript` (the default) or `debug`
2107	* @example
2108	* $.ui.log(`prompt from ${e.origin.kind}: ${e.text.length} chars`)
2109	* @example
2110	* $.ui.log(`cache miss for ${e.tool_use_id}`, { to: "debug" })
2111	*/
2112	log: (text: string, options?: UiLogOptions) => void;
2113	/**
2114	* Asks the user `question` in the engine's own AskUserQuestion dialog and
2115	* resolves to the label they chose, or the text typed under "Other".
2116	*
2117	* A `tool.call` of `AskUserQuestion` through every hook but the calling
2118	* one, drawn by `ui.render` on `AskUserQuestion`; a multi-select answer is
2119	* comma-joined. Rejects when dismissed, and in a `-p` run (no one to ask).
2120	*
2121	* @param question the question, ending in a question mark
2122	* @param options 2-4 option labels, or `{ options, header, multiSelect }`
2123	* @returns the label chosen, the chosen labels comma-joined, or free text
2124	* typed under "Other" (so compare it with the labels exactly)
2125	* @example
2126	* const mood = await $.ui.ask("How careful?", ["Bold", "Careful"])
2127	*/
2128	ask: (question: string, options?: readonly string[] \| AskOptions) => Promise<string>;
2129	/**
2130	* Shows `text` on the notification bar under the prompt for a few
2131	* seconds, the way the engine's own "context left" notice appears.
2132	*
2133	* It leaves the transcript and the model untouched.
2134	*
2135	* @param text the line to show; an unpaired surrogate half in it is drawn
2136	* as U+FFFD
2137	* @param options `timeoutMs`: how long it stays (default 4000)
2138	* @example
2139	* $.ui.toast(`turn took ${Math.round(e.durationMs / 1000)} s`)
2140	*/
2141	toast: (text: string, options?: ToastOptions) => void;
2142	/**
2143	* Pins `text` as this plugin's status line under the prompt, beside the
2144	* engine's own pinned notices, until the next call replaces it.
2145	*
2146	* One per plugin; `undefined` removes it.
2147	*
2148	* @param text the line to keep on screen (an unpaired surrogate half is
2149	* drawn as U+FFFD); undefined clears it
2150	* @example
2151	* $.ui.status("thinking..."); return next(e)
2152	*/
2153	status: (text: string \| undefined) => void;
2154	/**
2155	* Opens a pane: a framed region the surface places, whose body this
2156	* plugin draws by hooking `ui.render` for `{ component: "Pane" }`.
2157	*
2158	* One instance per id (`requestId`): opening an open id retitles it; a hook
2159	* on `ui.open` may refuse it. The keyboard is the person's; unasked, it
2160	* waits undrawn below 144 columns (110 once asked), judged at each open.
2161	*
2162	* @param pane `id` (1-64 of letters, digits, `_`, `-`), `title`, `focus`,
2163	* `closeOnEscape` and `holdToasts` (a dialog), `rows` / `columns` wanted
2164	* @returns settles once the pane is open (or retitled)
2165	* @example
2166	* await $.ui.open({ id: "clock", title: "Clock" })
2167	* @example
2168	* await $.ui.open({ id: "ask", focus: true, closeOnEscape: true, rows: 9 })
2169	*/
2170	open: (pane: PaneOpenArgs) => Promise<void>;
2171	/**
2172	* Closes one of the open panes; an id that is not open is left alone.
2173	*
2174	* Every close raises `ui.close`, `e.origin` naming whose it is: this call
2175	* (`plugin`), the person's mark or key (`person`), an unload (`unload`).
2176	* A hook answering without `next` keeps the pane open, save on an unload.
2177	*
2178	* @param pane `id`: the id the pane was opened under
2179	* @returns settles once the pane is gone or a hook answered for it;
2180	* rejects on a hook's `{ deny }`
2181	* @example
2182	* onPress: () => $.ui.close({ id: "clock" })
2183	*/
2184	close: (pane: PaneCloseArgs) => Promise<void>;
2185	/**
2186	* Lists this plugin's own open panes (UiPane): each one's id and title,
2187	* and whether it is shown, holds the keyboard, and is placed.
2188	*
2189	* The engine's record, not the module's: a module reloaded while its
2190	* pane stayed up finds it here. Another plugin's panes are not listed.
2191	*
2192	* @returns the panes in open order, placed ones first; empty with none
2193	* @example
2194	* const isUp = (await $.ui.panes()).some(pane => pane.id === "clock")
2195	* if (!isUp) await $.ui.open({ id: "clock", title: "Clock" })
2196	*/
2197	panes: () => Promise<readonly UiPane[]>;
2198	/**
2199	* Scrolls something into view as the DOM's `scrollIntoView` would: a
2200	* render instance by `requestId`, an element by `key`, a site's edge.
2201	*
2202	* A site of this plugin's (its pane, the band it draws into) moves under
2203	* the event `ui.scroll`, origin `plugin`. A transcript row moves only
2204	* while this call answers the person's own input, where one scrolls.
2205	*
2206	* @param args `to` (what), `in` (which site, required for `start` and
2207	* `end`), `block` (where it lands; `nearest` by default)
2208	* @returns `{}` once it moved, or `{ deny }` saying why not
2209	* @example
2210	* onPress: () => $.ui.scroll({ in: "log", to: "end" })
2211	*/
2212	scroll: (args: UiScrollArgs) => Promise<UiScrollResult>;
2213	/**
2214	* Moves the focus ring of one of this plugin's sites onto an element it
2215	* drew there, as the DOM's `element.focus()`, while it holds the keys.
2216	*
2217	* Raised as the event `ui.focus`, origin `plugin`; the engine's inverse
2218	* marks the element. The keyboard is the person's to give: a site not
2219	* holding it, or holding it on another plugin's element, is `{ deny }`.
2220	*
2221	* @param args `requestId` (which site: a pane's id, the band's) and `key`
2222	* (the element's, as drawn)
2223	* @returns `{}` once it moved, or `{ deny }` saying why not
2224	* @example
2225	* onPress: () => $.ui.focus({ requestId: "files", key: "row:0" })
2226	*/
2227	focus: (args: UiFocusArgs) => Promise<UiFocusResult>;
2228	};
2229	/**
2230	* Completions through the session's own client and credentials.
2231	*/
2232	model: {
2233	/**
2234	* Runs one text completion through the session's own API client and
2235	* resolves to the reply's text.
2236	*
2237	* No tools, no history, no system prompt beyond the CLI's identity block
2238	* and `request.system`.
2239	*
2240	* @param request the model (an alias such as `haiku`, or a full id,
2241	* resolved like a `--model` value), the prompt, and a token cap
2242	* @returns the reply's text
2243	* @example
2244	* const reply = await $.model.complete({ model: "haiku", prompt: "Hi." })
2245	*/
2246	complete: (request: ModelCompleteRequest) => Promise<string>;
2247	/**
2248	* Runs one tool-less completion over the session's OWN transcript, sharing
2249	* the main thread's prompt cache; the reply's text and the fork's usage.
2250	*
2251	* Not `complete`: sharing the cache prefix means the model and system
2252	* prompt are the session's, read from its last turn's cache-safe snapshot,
2253	* and tools are denied. Null on a cold snapshot or an API error.
2254	*
2255	* @param request the one user message the fork answers
2256	* @returns the reply's text with the fork's usage, or null on a cold
2257	* snapshot or an API error
2258	* @example
2259	* const reply = await $.model.fork({ prompt: "One line to learn?" })
2260	* if (reply !== null) $.ui.log(`${reply.usage.output_tokens} tokens`)
2261	*/
2262	fork: (request: ModelForkRequest) => Promise<ModelForkResult \| null>;
2263	/**
2264	* Picks one of `labels` for `text` with one completion over
2265	* `$.model.complete` and a fixed classifier prompt.
2266	*
2267	* `text` is data; the model answers with a label alone. It resolves
2268	* `undefined` when the answer named none of `labels`. A failed request,
2269	* an abort or a reply with no text rejects, naming the cause.
2270	*
2271	* @param text what to classify
2272	* @param labels the labels to choose from (2 or more)
2273	* @param options `model`: an alias or id; default the engine's small
2274	* fast model
2275	* @returns the label the model named, or undefined when it named none;
2276	* rejects when the request fails or the reply has no text
2277	* @example
2278	* const kind = await $.model.classify(e.text, ["bug", "feature"])
2279	* if (kind === undefined) return next(e)
2280	*/
2281	classify: (text: string, labels: readonly string[], options?: ClassifyOptions) => Promise<string \| undefined>;
2282	};
2283	/**
2284	* Sound: clip playback and platform speech.
2285	*/
2286	audio: {
2287	/**
2288	* Plays one audio clip, starting now; clips are not queued, so two calls
2289	* play together (a bed under speech).
2290	*
2291	* `{ asset }` is the plugin's own file, loaded by the engine and played
2292	* through the platform's player (`afplay` on macOS). Resolves when
2293	* playback ends; rejects, naming the cause, when the clip cannot play.
2294	*
2295	* @param clip the plugin's own file (`{ asset }`), a URL the engine
2296	* fetches, or the bytes as base64 with their MIME type
2297	* @param options `shouldLoop`, `gain`, and an AbortSignal that stops the
2298	* clip
2299	*/
2300	play: (clip: AudioClip, options?: PlayOptions) => Promise<void>;
2301	/**
2302	* Speaks `text` with the platform's own synthesizer (`say` on macOS).
2303	* Plain text.
2304	*
2305	* Utterances are queued among themselves; clips are not. Resolves when
2306	* the utterance has ended; rejects, naming the cause, when there is no
2307	* synthesizer, the voice is not installed, or the utterance failed.
2308	*
2309	* @param text what to say, as plain text
2310	* @param options `voice`: the system voice's exact name (`Samantha`);
2311	* absent, the synthesizer's default
2312	* @returns which synthesizer spoke, once the utterance has ended
2313	*/
2314	speak: (text: string, options?: SpeakOptions) => Promise<SpeakResult>;
2315	};
2316	/**
2317	* The engine's connected MCP servers.
2318	*/
2319	mcp: {
2320	/**
2321	* Calls `tool` on one of the engine's connected MCP servers with the
2322	* engine's own connection and credentials.
2323	*
2324	* A `cached` server is dialed on first use. No permission prompt: the
2325	* plugin's call, seen by the hooks above it, is the grant. Positional, not
2326	* the `{ tool: "mcp__server__tool", ... }` shape a `tool.call` hook sees.
2327	*
2328	* @param server the server's name as /mcp lists it (`claude.ai Gmail`;
2329	* the tool-name spelling `claude_ai_Gmail` is accepted too)
2330	* @param tool the tool's name on that server (`create_draft`)
2331	* @param args the tool's arguments; none when absent
2332	* @returns the tool's result as MCP returns it: `content` blocks and
2333	* `isError`
2334	* @example
2335	* const { content } = await $.mcp.call("claude.ai Gmail", "create_draft", {
2336	* to: "team@example.com",
2337	* subject: "Release notes",
2338	* })
2339	*/
2340	call: (server: string, tool: string, args?: Record<string, unknown>) => Promise<McpToolResult>;
2341	};
2342	/**
2343	* The running session, read as plain data, and compacting it.
2344	*/
2345	session: {
2346	/**
2347	* Returns the transcript so far, one entry per user or assistant
2348	* message; progress rows, `$.ui.log` lines and notices are not messages.
2349	*
2350	* Each entry is a SessionMessage, `{ role, text, toolUses }` (a user
2351	* message may add `toolResults`; a `toolUses` entry adds its `result` and
2352	* `text` once answered). A long transcript answers its newest 4096.
2353	*
2354	* @example
2355	* const last = (await $.session.messages()).at(-1)
2356	*/
2357	messages: () => Promise<SessionMessage[]>;
2358	/**
2359	* Returns the directory the session runs in, absolute.
2360	*/
2361	cwd: () => Promise<string>;
2362	/**
2363	* Returns the session's project root, absolute: where it started, or
2364	* where `/cd`, a host's directory change or a worktree move took it.
2365	*
2366	* A shell `cd` during the session does not move it; nested instruction
2367	* files are read only beneath it.
2368	*/
2369	root: () => Promise<string>;
2370	/**
2371	* Returns the main loop's model, as `/model` shows it.
2372	*/
2373	model: () => Promise<string>;
2374	/**
2375	* Returns how many prompts the user has sent this session (user turns in
2376	* the transcript).
2377	*/
2378	turns: () => Promise<number>;
2379	/**
2380	* Returns the session's id (the transcript file's name).
2381	*/
2382	id: () => Promise<string>;
2383	/**
2384	* Returns the git repository the session runs in, read from the working
2385	* copy on each call; null when the directory is not inside one.
2386	*
2387	* @example
2388	* const repo = await $.session.repo(); const publicRepo = !repo?.internal
2389	*/
2390	repo: () => Promise<SessionRepo \| null>;
2391	/**
2392	* Returns every surface the session draws on, each once: `terminal` under
2393	* the REPL first, then the remote ones in the order they attached.
2394	*
2395	* A session may draw on several at once (a terminal and two phones):
2396	* clients attach (`session.attach`) and detach, and a render hook still
2397	* reads `e.surface` per ask. Empty in a plain -p run; never rejects.
2398	*
2399	* @example
2400	* const inApp = (await $.session.surfaces()).some(s => s !== "terminal")
2401	*/
2402	surfaces: () => Promise<readonly RenderSurface[]>;
2403	/**
2404	* Returns the first of `$.session.surfaces()`, or null where nothing
2405	* draws.
2406	*
2407	* @deprecated use `surfaces()`; a session may draw on several surfaces at
2408	* once
2409	*/
2410	surface: () => Promise<RenderSurface \| null>;
2411	/**
2412	* Returns the context window's fill, the rate-limit windows and the
2413	* cost, as the status line has them; with `breakdown`, by category too.
2414	*
2415	* The plain call costs nothing; `"full"` counts each category with the
2416	* token-count API as /context does, `"summary"` estimates locally, and
2417	* `context.breakdown` comes back in the SDK's `get_context_usage` shape.
2418	*
2419	* @param args `{ breakdown, columns }`: how the breakdown is counted and
2420	* the width its grid is drawn in; nothing for the status line's figures
2421	* @returns `{ context, rateLimits, cost }` as the status line has them
2422	* @example
2423	* const { context } = await $.session.usage()
2424	* if ((context.percent ?? 0) >= 85) await $.session.compact()
2425	* @example
2426	* const usage = await $.session.usage({ breakdown: "full", columns })
2427	* for (const row of usage.context.breakdown?.gridRows ?? []) draw(row)
2428	*/
2429	usage: (args?: SessionUsageArgs) => Promise<SessionUsage>;
2430	/**
2431	* Returns the version of the engine the session runs on, the release it
2432	* is built from, and when it was built.
2433	*
2434	* The same three values the engine's own analytics rows carry, answered
2435	* in every mode and build; `base` is absent when the version is not
2436	* spelled as a release, `builtAt` in a run from source that stamps none.
2437	*
2438	* @returns `{ version, base, builtAt }`: the full version, its release
2439	* (`2.1.280`, or `2.1.280-dev` for a development build) and an
2440	* ISO 8601 build time
2441	* @example
2442	* const { version, base, builtAt } = await $.session.version()
2443	* row.env = { version, version_base: base, build_time: builtAt }
2444	* @example
2445	* const isDevelopmentBuild = (await $.session.version()).base?.endsWith("-dev")
2446	*/
2447	version: () => Promise<SessionVersion>;
2448	/**
2449	* Compacts the conversation: the event `session.compact` with `trigger`
2450	* `plugin`, the same call `/compact` makes, between turns.
2451	*
2452	* It runs through every hook but the calling one, then core: a summary
2453	* and the kept messages in the transcript's place. Resolves `{ skip }`
2454	* when a hook vetoed it; rejects while a turn runs.
2455	*
2456	* @example
2457	* const { skip } = await $.session.compact({ instructions: "the plan" })
2458	*/
2459	compact: EventCalls['session']['compact'];
2460	/**
2461	* Holds the session's Anthropic credential on the host and answers an
2462	* opaque handle and its kind; the secret never reaches the plugin.
2463	*
2464	* The handle is spent through `$.http.fetch(url, { auth: handle })`,
2465	* which sets the credential header, only for a first-party host. Null
2466	* where the build or the provider has no first-party credential to hold.
2467	*
2468	* @example
2469	* await $.http.fetch(url, { auth: (await $.session.authorize())?.handle })
2470	*/
2471	authorize: () => Promise<SessionAuthorization>;
2472	};
2473	/**
2474	* The running model turn: ending it.
2475	*/
2476	turn: {
2477	/**
2478	* Cancels the running model turn: the one whose id `turn.start` handed
2479	* this plugin, its running tools stopped, no interruption marker.
2480	*
2481	* The event `turn.abort`, seen by the hooks above; the prompt this
2482	* plugin submits next is the context. Rejects, naming both ids, when
2483	* `turnId` is not the running turn's; a hook may end its own turn.
2484	*
2485	* @param input `turnId`: the id `turn.start` carried
2486	* @example
2487	* on("turn.start", ($, e, next) => { held = e.turnId; return next(e) })
2488	*/
2489	abort: (input: OpEventOf['turn.abort']) => Promise<void>;
2490	};
2491	/**
2492	* Submitting a prompt the model reads as a user turn, and the person's
2493	* prompt box: read as it stands, written, or proposed into.
2494	*/
2495	prompt: {
2496	/**
2497	* Submits a prompt: the event `prompt.submit`, the same call the engine
2498	* makes for a typed prompt; `input.text` runs when the session is idle.
2499	*
2500	* It goes through every hook but the calling one (the plugin's others
2501	* see it) with `e.origin` `{ kind: 'plugin', name }`, the name the
2502	* model reads it under unless a hook leaves it out of its answer.
2503	*
2504	* @example
2505	* void $.prompt.submit({ text: "List the TODOs you just mentioned." })
2506	*/
2507	submit: EventCalls['prompt']['submit'];
2508	/**
2509	* Returns the prompt box as it stands, the draft typed so far and the
2510	* cursor's offset into it, so a `fill` can keep what the person typed.
2511	*
2512	* Never rejects: `{ text: '', cursor: 0 }` where the session draws no box
2513	* (a -p run, an SDK host) or none is mounted yet.
2514	*
2515	* @example
2516	* const { text, cursor } = await $.prompt.read()
2517	*/
2518	read: () => Promise<PromptBox>;
2519	/**
2520	* Puts `input.text` in the prompt box as the draft, by `mode`: `replace`
2521	* (the default) over it, `append` after it, `insert` at the cursor.
2522	*
2523	* The event `prompt.fill` through the other plugins' hooks; `isFilled:
2524	* false` under a dialog or headless. To hand the model text WITH the next
2525	* prompt instead, a `prompt.submit` hook adds `context` (second example).
2526	*
2527	* @example
2528	* await $.prompt.fill({ text: `> ${quote}\n`, mode: "insert" })
2529	* @example
2530	* ($, e, next) => next({ ...e, context: [...(e.context ?? []), hunk] })
2531	*/
2532	fill: (input: PromptFillArgs) => Promise<PromptFilled>;
2533	/**
2534	* Proposes `input.text` as the prompt box's dim suggestion, Tab to take:
2535	* the event `prompt.suggest`, as the engine's own guess after a turn.
2536	*
2537	* It goes through every other plugin's hook with `e.origin` `{ kind:
2538	* 'plugin', name }`, the engine's own suggestions on or off; `{ isShown:
2539	* false }` while the box holds text, a turn runs, or headless (no box).
2540	*
2541	* @example
2542	* void $.prompt.suggest({ text: "run the tests you just wrote" })
2543	*/
2544	suggest: EventCalls['prompt']['suggest'];
2545	};
2546	/**
2547	* The tools the model has in this session, and running one.
2548	*/
2549	tool: {
2550	/**
2551	* Returns the tools the model can call now, built-in and MCP alike, in
2552	* the order the model sees them.
2553	*
2554	* @example
2555	* const names = (await $.tool.list()).map(t => t.name)
2556	*/
2557	list: () => Promise<ToolInfo[]>;
2558	/**
2559	* Calls a tool: the event `tool.call`, the same call the engine makes for
2560	* the model's tool calls, under a `tool_use_id` of its own.
2561	*
2562	* It runs through every hook but the calling one (the plugin's others
2563	* see it), the permission check and its dialog, then the tool. Rejects
2564	* when no tool has that name or the call is aborted.
2565	*
2566	* @example
2567	* const { text } = await $.tool.call({ tool: "Read", file_path: "a.md" })
2568	*/
2569	call: EventCalls['tool']['call'];
2570	/**
2571	* Asks the engine's permission decision for a tool call now: the event
2572	* `tool.check`, resolved to `{ decision, reason?, rule? }`.
2573	*
2574	* The hooks run (the calling hook's own frame skipped, `next.origin` this
2575	* plugin, no `tool_use_id`); nothing runs, no dialog opens, no PreToolUse
2576	* hook or classifier is asked.
2577	*
2578	* @example
2579	* const { decision } = await $.tool.check({ tool: "Read", input })
2580	*/
2581	check: EventCalls['tool']['check'];
2582	/**
2583	* Declares a tool the model can call from the next prompt on: the name,
2584	* description and input schema of `mcp__<plugin>__<name>`.
2585	*
2586	* Serve it with a `tool.call` hook on `{ tool: "mcp__<plugin>__<name>" }`
2587	* that returns the result (a call no hook answers fails); a name registered
2588	* again is replaced. Rejects until the session binds, at `session.start`.
2589	*
2590	* @param tool `name`, `description` (what the model reads), `inputSchema`
2591	* (a JSON schema object; default `{ type: "object" }`)
2592	* @returns `{ tool }`, the registered tool's full name
2593	* `mcp__<plugin>__<name>`
2594	* @example
2595	* await $.tool.register({ name: "weather", description: "Weather." })
2596	*/
2597	register: (tool: ToolSpec) => Promise<OpValueOf['tool.register']>;
2598	};
2599	/**
2600	* The slash commands the person can run in this session, and running one.
2601	*/
2602	command: {
2603	/**
2604	* Returns the slash commands the person can run now, built-in, plugin
2605	* and MCP alike, in the order the typeahead lists them.
2606	*
2607	* @example
2608	* const names = (await $.command.list()).map(c => c.name)
2609	*/
2610	list: () => Promise<CommandInfo[]>;
2611	/**
2612	* Runs a slash command as if the person typed `/command args`: the
2613	* event `command.run`, queued and run once the session is idle.
2614	*
2615	* It runs through every hook but the calling one with `e.origin`
2616	* `{ kind: 'plugin', name }`, its lines in the transcript. Rejects an
2617	* unknown name, and inside a hook the turn is waiting on.
2618	*
2619	* @example
2620	* const { text } = await $.command.run({ command: "status" })
2621	*/
2622	run: EventCalls['command']['run'];
2623	/**
2624	* Declares the slash command `/<name>` for this session, listed in the
2625	* typeahead from the next keystroke on.
2626	*
2627	* Serve it with a `command.run` hook on `{ command: "<name>" }` that
2628	* returns `{ text }`; a run no hook answers says so as its output.
2629	* Registering a name again replaces it; a built-in's name is refused.
2630	*
2631	* @param command `name`, `description` (what the menu shows),
2632	* `argumentHint` (dim after the name), `immediate` (runs mid-turn)
2633	* @returns `{ command }`, the registered name
2634	* @example
2635	* await $.command.register({ name: "hello", description: "Says hi." })
2636	*/
2637	register: (command: CommandSpec) => Promise<OpValueOf['command.register']>;
2638	};
2639	/**
2640	* Every row of the settings menu (`/config`), the panel's own and each
2641	* enabled plugin's `userConfig` fields alike: listing and changing them.
2642	*/
2643	config: {
2644	/**
2645	* Returns the rows the `/config` menu would draw now, in its order,
2646	* each with its current value, its kind, its owner and its lock.
2647	*
2648	* After every `config.describe` hook: a hidden row is left out, a
2649	* relabelled one carries the new label.
2650	*
2651	* @example
2652	* const theme = (await $.config.list()).find(row => row.key === "theme")
2653	*/
2654	list: () => Promise<ConfigRow[]>;
2655	/**
2656	* Changes one row as if the person did in the menu: the event
2657	* `config.set` with `origin` `{ kind: 'plugin', name }`, then the writer.
2658	*
2659	* Through the other plugins' hooks, this plugin's own skipped; `{ deny }`
2660	* when a hook refused, the value does not fit, a trusted source owns the
2661	* row or only its dialog changes it. Rejects a key no row has.
2662	*
2663	* @param args `key` (as `list` names it) and `value` (the row's kind)
2664	* @returns `{ value }` once written, or `{ deny }`
2665	* @example
2666	* const { deny } = await $.config.set({ key: "verbose", value: true })
2667	*/
2668	set: EventCalls['config']['set'];
2669	};
2670	/**
2671	* Subagents.
2672	*/
2673	agent: {
2674	/**
2675	* Spawns a subagent: the event `agent.spawn`, the same call the engine
2676	* makes when the Agent tool starts one; the engine fills the rest.
2677	*
2678	* It runs every hook but the calling one, then the Agent tool in the
2679	* background under this call's origin: `{ model, agentId }` once the
2680	* subagent started (its answer is its `turn.complete`), or `{ deny }`.
2681	*
2682	* @example
2683	* const { agentId } = await $.agent.spawn({ prompt: "Read README.md." })
2684	*/
2685	spawn: EventCalls['agent']['spawn'];
2686	/**
2687	* Returns the session's subagents so far, the ones the model spawned and
2688	* the ones plugins did alike.
2689	*/
2690	list: () => Promise<AgentInfo[]>;
2691	/**
2692	* Defines an agent type the Agent tool dispatches from the next turn on,
2693	* named `<plugin>:<name>`: the event `agent.register`.
2694	*
2695	* Every field takes effect as in an agent file; re-registered, a name is
2696	* replaced; unloaded, a plugin's types go. `agent.offer` hides it from
2697	* the model alone; any plugin's `$.agent.spawn` answers to `agent.spawn`.
2698	*
2699	* @param spec `name`, `description` (when to delegate), `prompt` (its
2700	* system prompt), and any other field of an agent definition
2701	* @returns `{ agent }`, the full name; rejects until the session binds,
2702	* on a spec the schema refuses (its reason), on a hook's deny
2703	* @example
2704	* await $.agent.register({ name: "runner", description: "Runs a spec",
2705	* prompt: RUNNER_PROMPT, tools: ["Read", "Bash"], omitClaudeMd: true })
2706	* @example
2707	* // runner-only: hidden from the model, spawned by this plugin's tool,
2708	* // answered by the subagent's turn.complete (matched by agentId)
2709	* on("agent.offer", { agent: "lab:runner" }, () => ({ isOffered: false }))
2710	* on("tool.call", { tool: "mcp__lab__run" }, async ($, e) => {
2711	* const { agentId, deny } = await $.agent.spawn({
2712	* subagentType: "lab:runner", prompt: e.spec, description: "run" })
2713	* return { result: deny ?? (await answerOf(agentId)) }
2714	* })
2715	*/
2716	register: (spec: AgentSpec) => Promise<OpValueOf['agent.register']>;
2717	};
2718	/**
2719	* The file system as the engine's own process reaches it; a relative path
2720	* is under the session's working directory, and text is UTF-8.
2721	*
2722	* An absolute path is used as given; where one may go is an `fs.*` hook's
2723	* to say. A read or write over 4 MiB rejects, a foreign network location
2724	* as spelled rejects untouched, and an OS refusal rejects with its errno.
2725	*/
2726	fs: {
2727	/**
2728	* Reads a file and returns its text, or with `{ as: "bytes" }` its bytes
2729	* as `{ base64 }`.
2730	*
2731	* Rejects when missing, or over 4 MiB, which bounds what one read copies
2732	* into the plugin's environment. A file the plugin ships is under
2733	* `$.plugin.root`.
2734	*
2735	* @param path relative to the working directory, or absolute
2736	* @param options `as`: `"text"` (the default) or `"bytes"`
2737	* @returns the file's text, or `{ base64 }`
2738	* @example
2739	* const readme = await $.fs.read("README.md")
2740	* @example
2741	* const { base64 } = await $.fs.read(
2742	* `${$.plugin.root}/hooks/weights.bin`, { as: "bytes" })
2743	* const weights = Uint8Array.fromBase64(base64)
2744	*/
2745	read: FsReadCall;
2746	/**
2747	* Writes `text` to a file, creating it and its directories as needed.
2748	*
2749	* @param path relative to the working directory, or absolute
2750	* @param text the whole new content
2751	*/
2752	write: (path: string, text: string) => Promise<void>;
2753	/**
2754	* Lists a directory: `{ name, kind, size, isLink }` per entry, by name,
2755	* each entry as it stands (a symbolic link is `other` with `isLink`).
2756	*
2757	* @param path the directory's path; absent, the working directory
2758	* @returns the entries, `{ name, kind, size, isLink }` each
2759	*/
2760	list: (path?: string) => Promise<FsEntry[]>;
2761	/**
2762	* Returns whether the path exists; rejects only a network location as
2763	* spelled, which no `fs` call reaches.
2764	*/
2765	exists: (path: string) => Promise<boolean>;
2766	/**
2767	* Returns `{ kind, size, mtimeMs, isLink }` of the path: what it leads to,
2768	* and whether it is itself a symbolic link. Rejects when missing.
2769	*
2770	* With `{ resolve: true }` also `realPath`, where the path lands, absent
2771	* when it leads nowhere; a guard matches it and denies without it, since a
2772	* spelling it cannot resolve (`~`, a file not there yet) the tool may open.
2773	*
2774	* @param path relative to the working directory, or absolute
2775	* @param options `resolve`: also answer `realPath` (one more file system
2776	* call)
2777	* @returns the stat, `realPath` with it when asked and resolvable; rejects
2778	* `ENOENT` for a missing path
2779	* @example
2780	* // ROOT was resolved the same way and SEP is its separator; an
2781	* // allow-list under it is the robust guard, a deny-list on spellings
2782	* // only best effort (a hard link or a case alias keeps its own)
2783	* on("tool.call", { tool: "Read" }, async ($, e, next) => {
2784	* const stat = await $.fs.stat(e.file_path, { resolve: true })
2785	* .catch(() => undefined)
2786	* const real = stat?.realPath
2787	* const isInside = real !== undefined && real.startsWith(ROOT + SEP)
2788	* return isInside ? next(e) : { deny: "outside the project" }
2789	* })
2790	* @example
2791	* // a Write may name a file not there yet: `placed` answers where the
2792	* // path lands or undefined, and the guard denies on undefined or
2793	* // outside ROOT. Unplaceable by spelling first, with no file system
2794	* // call (drive-relative `D:x`, a `\\` or `//` network or device path,
2795	* // a name that is empty, ".", ".." or itself `C:...`); then the file
2796	* // if it stats; else its folder, cut after the last separator and
2797	* // keeping it so a drive or share root stays that root, plus the name
2798	* const placed = async (path) => {
2799	* const cut = Math.max(path.lastIndexOf("/"), path.lastIndexOf("\\"))
2800	* const name = path.slice(cut + 1)
2801	* const isPlaceable = !/^[A-Za-z]:(?![\\/])/.test(path) &&
2802	* !/^[\\/][\\/]/.test(path) && !/^[A-Za-z]:/.test(name) &&
2803	* name !== "" && name !== "." && name !== ".."
2804	* if (!isPlaceable) return undefined
2805	* const own = await $.fs.stat(path, { resolve: true })
2806	* .catch(() => undefined)
2807	* if (own) return own.realPath
2808	* const folder = cut < 0 ? "." : path.slice(0, cut + 1)
2809	* const dir = await $.fs.stat(folder, { resolve: true })
2810	* .catch(() => undefined)
2811	* return dir?.realPath === undefined ? undefined
2812	* : `${dir.realPath.replace(/[\\/]$/, "")}${SEP}${name}`
2813	* }
2814	* const real = await placed(e.file_path)
2815	* const isInside = real !== undefined && real.startsWith(ROOT + SEP)
2816	* return isInside ? next(e) : { deny: "cannot place it, or outside" }
2817	*/
2818	stat: (path: string, options?: FsStatOptions) => Promise<FsStat>;
2819	/**
2820	* Reads the named instruction files in every directory above the
2821	* session's original working directory, the way the engine reads CLAUDE.md.
2822	*
2823	* Root first, each `{ dir, name, content }` that exists, the content
2824	* with its `@include`s after it; `of` and `below` together are the
2825	* engine's own walk for a nested CLAUDE.md between root and read file.
2826	*
2827	* @param request `names`, relative `.md` file names (no `..`); `of`, the
2828	* file walked down to; `below`, the directory the walk stays inside
2829	* @returns the files found, root first
2830	* @example
2831	* const found = await $.fs.ancestors({ names: ["AGENTS.md"] })
2832	* const stack = await $.fs.ancestors({ names: ["AGENTS.md"], of: path })
2833	* const nested = await $.fs.ancestors({
2834	* names: ["AGENTS.md"],
2835	* of: e.file_path,
2836	* below: await $.session.root(),
2837	* })
2838	*/
2839	ancestors: (request: FsAncestorsRequest) => Promise<readonly FsAncestor[]>;
2840	};
2841	/**
2842	* This plugin's own key-value store, kept between sessions and hot
2843	* reloads; values are JSON data.
2844	*
2845	* A JSON file of the plugin's own under the user's Claude Code
2846	* configuration directory.
2847	*/
2848	store: {
2849	/**
2850	* Returns the value under `key`, or `undefined` when unset.
2851	*
2852	* @example
2853	* const count = Number((await $.store.get("count")) ?? 0) + 1
2854	*/
2855	get: (key: string) => Promise<unknown>;
2856	/**
2857	* Sets `key` to `value`, which must be JSON data.
2858	*
2859	* `get` reads back `JSON.parse(JSON.stringify(value))`: a Date is its ISO
2860	* string, an `undefined` field is dropped, a Map or Set is `{}`. Rejects
2861	* a function, a cycle, or a store over 4 MiB of JSON text in all.
2862	*/
2863	set: (key: string, value: unknown) => Promise<void>;
2864	/**
2865	* Removes `key` from the store.
2866	*/
2867	delete: (key: string) => Promise<void>;
2868	/**
2869	* Returns every key set, in insertion order.
2870	*/
2871	keys: () => Promise<string[]>;
2872	};
2873	/**
2874	* The time and timers, each an event through the host: `clock.now` reads
2875	* the time; `clock.sleep`, `after` and `every` wait until it has passed.
2876	*
2877	* A timer's callback is the plugin's own function, kept in its environment
2878	* and run there when the wait resolves; a hot reload of the plugin cancels
2879	* its pending waits with the old environment.
2880	*/
2881	clock: {
2882	/**
2883	* Resolves milliseconds since the epoch, now.
2884	*
2885	* @example
2886	* const startedAt = await $.clock.now()
2887	*/
2888	now: () => Promise<number>;
2889	/**
2890	* Resolves after `ms` milliseconds; rejects at once when `signal` aborts.
2891	*
2892	* @param ms how long, in milliseconds
2893	* @param options `signal`: ends the wait early with a rejection (pass
2894	* `next.signal` so a hook's wait ends with its dispatch)
2895	* @example
2896	* await $.clock.sleep(500, { signal: next.signal })
2897	*/
2898	sleep: (ms: number, options?: SleepOptions) => Promise<void>;
2899	/**
2900	* Calls `fn` once after `ms` milliseconds; `cancel()` before then stops it.
2901	*
2902	* One `clock.after` dispatch: `fn` runs when it resolves, and never when
2903	* a hook refuses it.
2904	*/
2905	after: TimerCall;
2906	/**
2907	* Calls `fn` every `ms` milliseconds (at least 1) until `cancel()`.
2908	*
2909	* One `clock.every` dispatch per period: `fn` runs when it resolves and
2910	* the next period is asked; a refused period ends the interval.
2911	*
2912	* @example
2913	* const tick = $.clock.every(1000, () => $.ui.status("polling"))
2914	*/
2915	every: TimerCall;
2916	};
2917	/**
2918	* The network, through the host.
2919	*/
2920	http: {
2921	/**
2922	* Fetches `url` through the host (never the plugin's own network) and
2923	* resolves `{ status, ok, headers, text }` once the body is read.
2924	*
2925	* http or https, to whatever the host process can reach, unless the
2926	* administrator's policy switches refuse it; an `auth` handle from
2927	* `$.session.authorize()` rides https only, to a first-party host.
2928	*
2929	* @param url the URL (http or https)
2930	* @param init `{ method, headers, body, auth, socketPath }` (body a
2931	* string; socketPath a Unix socket to go over instead of TCP)
2932	* @returns `{ status, ok, headers, text }` once the body is read
2933	* @example
2934	* const { ok, text } = await $.http.fetch("https://example.com/status")
2935	* @example
2936	* await $.http.fetch("http://bridge/reload", {
2937	* method: "POST",
2938	* socketPath: `${runDirectory}/bridge.sock`,
2939	* })
2940	*/
2941	fetch: (url: string, init?: HttpInit) => Promise<HttpResponse>;
2942	};
2943	/**
2944	* Commands on the host, run as the user the session runs as. CLI only.
2945	*
2946	* Local execution, not a network path: what a command of its own reaches
2947	* is its own, as for the Bash tool and a settings `command` hook.
2948	*/
2949	process: {
2950	/**
2951	* Runs a command on the host by its argument vector (no shell) and
2952	* resolves `{ exitCode, stdout, stderr }` once it exits, any exit code.
2953	*
2954	* One shot: the whole output is read, so a background process left
2955	* writing holds the call until the timeout. Rejects when the command
2956	* cannot start or is still running then. Git runs with repo hooks off.
2957	*
2958	* @param argv the command and its arguments, `argv[0]` the executable
2959	* @param init `{ cwd, env, stdin, timeoutMs }` (cwd the session's by
2960	* default; timeout 30 s by default, ten minutes at most)
2961	* @returns `{ exitCode, stdout, stderr }` once the child exits
2962	* @example
2963	* const { exitCode, stdout } = await $.process.run(["git", "status"])
2964	*/
2965	run: (argv: readonly string[], init?: ProcessRunInit) => Promise<ProcessRunResult>;
2966	};
2967	/**
2968	* What the settings files, `--settings` and managed policy hold, as the
2969	* engine runs under it; read only.
2970	*
2971	* Every key crosses as the source holds it, `env` and the helper commands
2972	* included: nothing is filtered. The OAuth session and the global config
2973	* (~/.claude.json) are not settings and are never read.
2974	*/
2975	settings: {
2976	/**
2977	* Resolves with the settings merged over every source, as the engine
2978	* reads them, or with one source's settings as loaded (`{ source }`).
2979	*
2980	* A snapshot in plain data each call; a source with no file answers
2981	* `{}`. The sources (SettingsSource) rise in precedence from `user` to
2982	* `policy`: the merge takes a key from the last source that has it.
2983	*
2984	* @param args `{ source }` to read one source; nothing for the merge
2985	* @returns the settings object, keyed as a settings.json is
2986	* @example
2987	* const { permissions } = await $.settings.read()
2988	* const policy = await $.settings.read({ source: "policy" })
2989	*/
2990	read: (args?: SettingsReadArgs) => Promise<Settings>;
2991	};
2992	/**
2993	* The environment of this process, the one every Bash child, MCP server
2994	* and `$.process.run` command started after inherits.
2995	*
2996	* `get` and `set` take the variable's name as a string literal, so what a
2997	* module reads and writes is read off its source: `claude plugin validate`
2998	* lists the names, and a name the module does not spell is refused.
2999	*/
3000	env: {
3001	/**
3002	* Resolves with the variable's value, or `undefined` when it is unset.
3003	*
3004	* `name` must be a string literal; `claude plugin validate` lists the
3005	* names your module reads and writes.
3006	*
3007	* @example
3008	* const home = await $.env.get("HOME")
3009	*/
3010	get: (name: string) => Promise<string \| undefined>;
3011	/**
3012	* Sets the variable for this process and everything it starts after, or
3013	* unsets it when `value` is `undefined`.
3014	*
3015	* `name` must be a string literal; `claude plugin validate` lists the
3016	* names your module reads and writes.
3017	*
3018	* @example
3019	* await $.env.set("GIT_PAGER", "cat")
3020	*/
3021	set: (name: string, value: string \| undefined) => Promise<void>;
3022	};
3023	}
3024
3025	/**
3026	* The name of an event the engine defines itself (a key of CoreEventOf);
3027	* EventName adds the declared plugin nouns' events.
3028	*/
3029	type CoreEventName = keyof CoreEventOf;
3030
3031	/**
3032	* The argument of each event the engine defines itself: its call sites'
3033	* (EngineEventOf), the classic hooks' (ClassicEventOf), the calls on `$`.
3034	*/
3035	type CoreEventOf = EngineEventOf & ClassicEventOf & OpEventOf;
3036
3037	type CwdChangedHookInput = BaseHookInput & {
3038	hook_event_name: 'CwdChanged';
3039	old_cwd: string;
3040	new_cwd: string;
3041	};
3042
3043	type DirectoryAddedHookInput = BaseHookInput & {
3044	hook_event_name: 'DirectoryAdded';
3045	/**
3046	* Absolute path of the directory that was added.
3047	*/
3048	directory: string;
3049	/**
3050	* How the directory was added: "slash_command" for /add-dir, "register_repo_root" for the SDK control_request.
3051	*/
3052	source: 'slash_command' \| 'register_repo_root';
3053	};
3054
3055	/**
3056	* The `children` field every element constructor's props carry, appended
3057	* beside its own props type: one child, or a list that may nest.
3058	*
3059	* JSX types a lone child as the child itself (`<Text dimColor>done</Text>`
3060	* passes the string, `<Text>{count}</Text>` the number), and a mapped list
3061	* beside a sibling as a nested list (`<Box>{rows.map(row)}<Text>ok</Text>`).
3062	*/
3063	export type ElementChildren = {
3064	children?: RenderChildren;
3065	};
3066
3067	/**
3068	* An element as `$.ui.resolve(e)` hands it out: a constructor from props to
3069	* the frozen plain-data element, `children` among the props as JSX passes.
3070	*
3071	* `const { Box } = $.ui.resolve(e)` then `<Box gap={1}>...</Box>` compiles to
3072	* `h(Box, { gap: 1 }, ...children)`, and `h` calls a function tag with its
3073	* props, so the table's constructors are the JSX tags.
3074	*/
3075	export type ElementConstructor<P> = (props: P & ElementChildren) => RenderElement;
3076
3077	/**
3078	* Every element name of every surface: what a table handed out is completed to
3079	* (an omitted one draws a fragment; see `ui.resolve`).
3080	*/
3081	export type ElementName = {
3082	[P in RenderSurface]: keyof Elements[P];
3083	}[RenderSurface];
3084
3085	/**
3086	* The element constructors each surface draws, by `e.surface`: what
3087	* `$.ui.resolve(e)` returns and a `ui.resolve` hook passes on; no globals.
3088	*
3089	* All carry `Box`, `Text`, `Button`, `Link`, `Code`, `Markdown`; every remote
3090	* surface `Svg`; all but mobile `Input` and `Select`; terminal and desktop
3091	* `Client`; terminal `Raster` and `Image`. Narrowed on `e.surface`, that table.
3092	*/
3093	export type Elements = {
3094	terminal: {
3095	Box: ElementConstructor<BoxProps>;
3096	Text: ElementConstructor<TextProps>;
3097	Button: ElementConstructor<ButtonProps>;
3098	Input: ElementConstructor<InputProps>;
3099	Select: ElementConstructor<SelectProps>;
3100	Link: ElementConstructor<LinkProps>;
3101	Code: ElementConstructor<CodeProps>;
3102	Markdown: ElementConstructor<MarkdownProps>;
3103	/**
3104	* A region one of the plugin's surface modules draws (ClientModule), named
3105	* by `module`: a string literal, the module's path relative to this file.
3106	*
3107	* The engine reads the surface module off the hooks module's source
3108	* before anything runs, so a variable, a template with a substitution or
3109	* a computed path as `module` is refused at load, naming the line.
3110	*/
3111	Client: ElementConstructor<ClientProps>;
3112	Raster: ElementConstructor<RasterProps>;
3113	Image: ElementConstructor<ImageProps>;
3114	};
3115	desktop: {
3116	Box: ElementConstructor<BoxProps>;
3117	Text: ElementConstructor<TextProps>;
3118	Button: ElementConstructor<ButtonProps>;
3119	Input: ElementConstructor<InputProps>;
3120	Select: ElementConstructor<SelectProps>;
3121	Svg: ElementConstructor<SvgProps>;
3122	Link: ElementConstructor<LinkProps>;
3123	Code: ElementConstructor<CodeProps>;
3124	Markdown: ElementConstructor<MarkdownProps>;
3125	Client: ElementConstructor<ClientProps>;
3126	};
3127	/**
3128	* No `Input` or `Select`: the control protocol carries presses (ui_press)
3129	* but no ui_input or ui_select yet; not a limit of the device.
3130	*
3131	* The table grows when those messages exist.
3132	*/
3133	mobile: {
3134	Box: ElementConstructor<BoxProps>;
3135	Text: ElementConstructor<TextProps>;
3136	Button: ElementConstructor<ButtonProps>;
3137	Svg: ElementConstructor<SvgProps>;
3138	Link: ElementConstructor<LinkProps>;
3139	Code: ElementConstructor<CodeProps>;
3140	Markdown: ElementConstructor<MarkdownProps>;
3141	};
3142	/**
3143	* The desktop's table without `Client`: a remote `Client`'s module, presses
3144	* and posts (ui_client_module, ui_client_press, ui_message) name no surface.
3145	*
3146	* They are the desktop's alone today, not a limit of the editor's webview:
3147	* the table gains `Client` when those asks name a surface.
3148	*/
3149	vscode: {
3150	Box: ElementConstructor<BoxProps>;
3151	Text: ElementConstructor<TextProps>;
3152	Button: ElementConstructor<ButtonProps>;
3153	Input: ElementConstructor<InputProps>;
3154	Select: ElementConstructor<SelectProps>;
3155	Svg: ElementConstructor<SvgProps>;
3156	Link: ElementConstructor<LinkProps>;
3157	Code: ElementConstructor<CodeProps>;
3158	Markdown: ElementConstructor<MarkdownProps>;
3159	};
3160	};
3161
3162	/**
3163	* The table `ui.resolve` answers for an argument of surface `P`.
3164	*/
3165	export type ElementTable<P extends RenderSurface = RenderSurface> = Elements[P];
3166
3167	/**
3168	* Hook input for the Elicitation event. Fired when an MCP server requests user input. Hooks can auto-respond (accept/decline) instead of showing the dialog.
3169	*/
3170	type ElicitationHookInput = BaseHookInput & {
3171	hook_event_name: 'Elicitation';
3172	mcp_server_name: string;
3173	message: string;
3174	mode?: 'form' \| 'url';
3175	url?: string;
3176	elicitation_id?: string;
3177	requested_schema?: Record<string, unknown>;
3178	};
3179
3180	/**
3181	* Hook input for the ElicitationResult event. Fired after the user responds to an MCP elicitation. Hooks can observe or override the response before it is sent to the server.
3182	*/
3183	type ElicitationResultHookInput = BaseHookInput & {
3184	hook_event_name: 'ElicitationResult';
3185	mcp_server_name: string;
3186	elicitation_id?: string;
3187	mode?: 'form' \| 'url';
3188	action: 'accept' \| 'decline' \| 'cancel';
3189	content?: Record<string, unknown>;
3190	};
3191
3192	/**
3193	* The input of `engine.create`: the fold that builds `$`, once per load,
3194	* core innermost.
3195	*
3196	* A hook is written in post-order: `const built = await next(e)` is `$` as
3197	* built so far; `return { ...built, voice: { say } }` adds this plugin's noun.
3198	* See EngineEventOf's `engine.create` for what a step may and may not do.
3199	*/
3200	export type EngineCreateInput = {
3201	/**
3202	* The modules this fold builds, in list order, first outermost (managed
3203	* plugins first, so an org plugin's withholding wins).
3204	*
3205	* The whole set at a load, this plugin alone at its reload, the ones added
3206	* or changed at a refresh that keeps the rest: a module added later that
3207	* does not hook this event is built against the table as it stands.
3208	*/
3209	plugins: readonly string[];
3210	};
3211
3212	/**
3213	* What an `engine.create` hook returns: `$` as built so far with this
3214	* plugin's nouns added, less any it withheld.
3215	*
3216	* Every declared noun is optional here. Between hooks it crosses the chain
3217	* as interface descriptors; a hook sees objects (EngineInterfaceBuilt).
3218	*/
3219	export type EngineCreateResult = Partial<EngineInterface> & {
3220	readonly [noun: string]: unknown;
3221	};
3222
3223	/**
3224	* The events the engine raises at its call sites, and `engine.create`; the
3225	* classic settings hooks' events are ClassicEventOf.
3226	*
3227	* At every one, a hook that fails (throws, overruns its budget: HookBudget,
3228	* answers a wrong shape) is skipped: the hooks beneath and core run in its
3229	* place, or its last `next` result stands; the failure is reported by name.
3230	*/
3231	export type EngineEventOf = {
3232	/**
3233	* Fires when the engine is about to run a tool. `next(e)` runs the hooks
3234	* beneath, then core (the permission prompt, the tool itself).
3235	*
3236	* Return `{ deny: reason }` to refuse or `{ result }` to answer yourself; a
3237	* hook that returns while its `next` is pending aborts what runs beneath.
3238	* The managed-settings hooks run first: their deny is the call's result.
3239	*/
3240	'tool.call': ToolCallInput;
3241	/**
3242	* Fires when the engine decides whether a tool call may run, after the
3243	* `tool.call` and PreToolUse hooks and before the mode settles an ask.
3244	*
3245	* `next(e)` resolves to the engine's verdict (rules, mode, the tool's own
3246	* check, PreToolUse's decision); return any `{ decision }`. `$.tool.check`
3247	* runs the same chain and executes nothing.
3248	*
3249	* @example
3250	* on("tool.check", { tool: "Read" }, () => ({ decision: "allow" }))
3251	*/
3252	'tool.check': ToolCheckInput;
3253	/**
3254	* Fires when the engine is about to draw a component: once per input value
3255	* (props, viewport width), plugin load or `$.ui.invalidate("ui.render")`.
3256	*
3257	* A repaint reuses the answer; a clock invalidates. `next(e)` resolves to the
3258	* drawing: return it, wrap it, draw your own, or rewrite `props`. A tree that
3259	* does not validate draws the engine's own; `--plugin-dir` is told why.
3260	*/
3261	'ui.render': RenderInput;
3262	/**
3263	* Fires when the plugins load (not per draw), once per surface, component
3264	* and plugin: `e` names the surface and component, never the props.
3265	*
3266	* `next(e)` resolves to the surface's table, which `$.ui.resolve(e)` then
3267	* reads. Return it, one with an element restyled for every other plugin,
3268	* or one with a key left out (a fragment there); own table: hook skipped.
3269	*/
3270	'ui.resolve': ResolveInput;
3271	/**
3272	* Fires when a `Button` a render hook drew is pressed on a surface; `e` is
3273	* `{ plugin, element, component, surface }`, `element` the button's `key`.
3274	*
3275	* `next(e)` runs the hooks beneath, then core: the element's own `onPress`
3276	* closure, in its plugin's environment, resolving to `{ element }`. Return
3277	* `next(e)` to let the press through, or `{ element }` to take it.
3278	*/
3279	'ui.press': UiPressArgument;
3280	/**
3281	* Fires when an `Input` a render hook drew changes or is submitted; `e` is
3282	* `{ plugin, element, component, surface, kind, value }`.
3283	*
3284	* `next(e)` runs the hooks beneath, then the element's own `onInput` or
3285	* `onSubmit` with `e.value` as the chain left it, resolving to `{ element,
3286	* value }`; `next({ ...e, value })` rewrites the typing, an answer takes it.
3287	*/
3288	'ui.input': UiInputArgument;
3289	/**
3290	* Fires when a `Select` a render hook drew is picked from; `e` is
3291	* `{ plugin, element, component, surface, value }`.
3292	*
3293	* `next(e)` runs the hooks beneath, then the element's own `onSelect` with
3294	* `e.value` as the chain left it, resolving to `{ element, value }`;
3295	* `next({ ...e, value })` rewrites the pick, an answer takes it.
3296	*/
3297	'ui.select': UiSelectArgument;
3298	/**
3299	* Fires when a `Client` THIS plugin drew posts from its surface module
3300	* (`surface.post(data)`); only this plugin's hooks see it.
3301	*
3302	* `next.origin` names `client`: `data` came from code. Core answers `{}`;
3303	* `next({ ...e, data })` rewrites the data; `{ props }` hands the posting
3304	* instance its next props without a redraw. One per instance per frame.
3305	*/
3306	'ui.message': UiMessageArgument;
3307	/**
3308	* Fires before a site's window moves: the person's wheel or scroll keys on
3309	* a `Pane` body or the `AbovePrompt` band, at its edges too; `$.ui.scroll`.
3310	*
3311	* `next(e)` moves it to `e.offset` and draws: `{}`; `next({ ...e, offset
3312	* })` elsewhere; no `next` (`{}` or `{ deny }`) leaves it undrawn, so a hook
3313	* drawing its own rows under a header moves them by `e.by` and invalidates.
3314	*
3315	* @example
3316	* on("ui.scroll", { requestId: "log" }, ($, e) => (scrollOwnRows(e.by), {}))
3317	*/
3318	'ui.scroll': UiScrollInput;
3319	/**
3320	* Fires before a site's focus ring moves: the person's Tab, arrows or click
3321	* in a `Pane` or the band; an `autoFocus` element taking it; `$.ui.focus`.
3322	*
3323	* `next(e)` lands it on `e.element` (absent: one of the engine's stops) and
3324	* draws: `{}`; `next({ ...e, element })` on another of `e.plugin`'s; no
3325	* `next` (`{}` or `{ deny }`) keeps it where it was, drawn as it was.
3326	*
3327	* @example
3328	* on("ui.focus", { requestId: "list" }, ($, e, next) => (mark(e), next(e)))
3329	*/
3330	'ui.focus': UiFocusInput;
3331	/**
3332	* Fires when the engine offers an agent type to the model, in the agent
3333	* listing and again at dispatch; `next(e)` resolves to `{ isOffered: true }`.
3334	*
3335	* Return `{ isOffered: false }` to keep the type out of the listing and
3336	* refuse its dispatch. A hook that fails passes it through.
3337	*
3338	* @example
3339	* on("agent.offer", { agent: "Plan" }, () => ({ isOffered: false }))
3340	*/
3341	'agent.offer': AgentOfferInput;
3342	/**
3343	* Fires when the Agent tool is about to start a subagent, everything
3344	* decided and its model not yet resolved.
3345	*
3346	* `next(e)` resolves to `{ model }`. Return it, `next({ ...e, model })`,
3347	* `{ model }` of your own (an alias resolves like the tool's parameter), or
3348	* `{ deny: reason }`.
3349	*/
3350	'agent.spawn': AgentSpawnInput;
3351	/**
3352	* Fires when a prompt is submitted, before the turn starts. `next(e)` runs
3353	* the hooks beneath and the UserPromptSubmit settings hooks.
3354	*
3355	* Rewrite with `next({ ...e, text })` (the user message on screen follows)
3356	* or stop it with `{ drop: reason }`; a broken plugin never blocks a prompt.
3357	* A prompt typed while a turn ran fires at Enter, with that turn's id.
3358	*/
3359	'prompt.submit': PromptSubmitInput;
3360	/**
3361	* Fires when a text is about to be put in the prompt box as the person's
3362	* draft (a plugin's `$.prompt.fill`); `next(e)` writes it by `e.mode`.
3363	*
3364	* `replace` over the draft, `append` after it, `insert` at the cursor;
3365	* rewrite `text` or `mode` going down, or answer `{ isFilled: false }`
3366	* without `next` to keep it out, as core does under a dialog or headless.
3367	*
3368	* @example
3369	* on("prompt.fill", ($, e, next) => next({ ...e, text: e.text.trim() }))
3370	*/
3371	'prompt.fill': PromptFillInput;
3372	/**
3373	* Fires when a text is proposed as the prompt box's dim suggestion, Tab to
3374	* take: the engine's guess after a turn, or a plugin's `$.prompt.suggest`.
3375	*
3376	* `next(e)` shows it: `{ isShown }`. Rewrite with `next({ ...e, text })`,
3377	* or answer `{ isShown: false }` without `next` to drop it; core answers
3378	* that too while the box holds text or a turn runs.
3379	*
3380	* @example
3381	* on("prompt.suggest", { origin: { kind: "suggestion" } }, hide)
3382	*/
3383	'prompt.suggest': PromptSuggestInput;
3384	/**
3385	* Fires when the person edits the main prompt box: a key the editor took as
3386	* an edit, or a paste; `next(e)` resolves the box the editor shows.
3387	*
3388	* `e` is the draft before and the splice (`start`, `end`, `inputText`); a
3389	* burst of keys is one edit. Rewrite `inputText` going down or the box
3390	* coming up; `{ text: e.text, cursor: e.cursor }` without `next` consumes.
3391	*
3392	* @example
3393	* on("prompt.edit", ($, e, next) => next({ ...e, inputText: up(e) }))
3394	*/
3395	'prompt.edit': PromptEditInput;
3396	/**
3397	* Fires once per named section of the system prompt, when the engine
3398	* assembles it; `next(e)` resolves to `{ text }` as core computed it.
3399	*
3400	* Sections are cached by name for the session until
3401	* `$.ui.invalidate("prompt.section")`: an unstable answer spends the
3402	* model's prompt cache on every call. A hook that fails passes it through.
3403	*
3404	* @example
3405	* on("prompt.section", { name: "memory" }, () => ({ text: null }))
3406	*/
3407	'prompt.section': PromptSectionInput;
3408	/**
3409	* Fires once per conversation, when the engine computes the context blocks
3410	* its first user message carries; `next(e)` resolves to `{ blocks }`.
3411	*
3412	* Append, drop, reorder or rewrite with `next({ ...e, blocks })`; the
3413	* engine renders what comes back, in order, until
3414	* `$.ui.invalidate("prompt.context")` or a re-read (compaction, `/clear`).
3415	*
3416	* @example
3417	* on("prompt.context", () => ({ blocks: [] }))
3418	*/
3419	'prompt.context': PromptContextInput;
3420	/**
3421	* Fires once per message the engine injects for the model on its own (a
3422	* reminder, a mode transition, a mentioned file), as a request carries it.
3423	*
3424	* `next(e)` resolves to `{ text }`; `{ text: null }` leaves it out. The
3425	* answer holds per attachment for the process (asked again on resume or
3426	* `$.ui.invalidate`); the transcript keeps the engine's record.
3427	*
3428	* @example
3429	* on("prompt.attachment", { type: "todo_reminder" }, () => ({ text: null }))
3430	*/
3431	'prompt.attachment': PromptAttachmentInput;
3432	/**
3433	* Fires once per tool, when the engine first renders the tool's schema in
3434	* a session; `next(e)` resolves to `{ description, isDeferred? }`.
3435	*
3436	* Cached for the session until `$.ui.invalidate("tool.describe")`: an
3437	* unstable answer spends the model's prompt cache. An explicit `isDeferred`
3438	* moves the tool behind ToolSearch (true) or into the prompt's list (false).
3439	*
3440	* @example
3441	* on("tool.describe", { tool: "Bash" }, ($, e) => ({ ...e, description }))
3442	* @example
3443	* on("tool.describe", { tool: "Monitor" }, pin) // {...e, isDeferred: false}
3444	*/
3445	'tool.describe': ToolDescribeInput;
3446	/**
3447	* Fires when a slash command is about to run (`/name args` typed, or a
3448	* plugin's `$.command.run`); `next(e)` resolves to `{ text }`, its output.
3449	*
3450	* Core is the engine's command (a registered one has none). Rewrite `args`
3451	* with `next`, or return `{ text }` without it to answer in its place; one
3452	* after `next` replaces a printed output, not a panel or prompt it opened.
3453	*
3454	* @example
3455	* on("command.run", { command: "hello" }, () => ({ text: "hello" }))
3456	*/
3457	'command.run': CommandRunInput;
3458	/**
3459	* Fires once per command, when the engine lists it for the typeahead and
3460	* `/help`; `next(e)` resolves to `{ description, argumentHint, isHidden }`.
3461	*
3462	* Listed answers are cached for the session until
3463	* `$.ui.invalidate("command.describe")`. A hook that fails passes it
3464	* through.
3465	*
3466	* @example
3467	* on("command.describe", ($, e, next) => next({ ...e, isHidden: true }))
3468	*/
3469	'command.describe': CommandDescribeInput;
3470	/**
3471	* Fires when a `/config` row is about to change, from the menu or a
3472	* plugin's `$.config.set`; `next(e)` resolves to `{ value }` once written.
3473	*
3474	* Return `{ deny: reason }` to leave the row as it is (the menu says why),
3475	* or `next({ ...e, value })` to clamp it; a value of the wrong kind for
3476	* the row is refused. A row a trusted source owns is core's to refuse.
3477	*
3478	* @example
3479	* on("config.set", { key: "theme" }, () => ({ deny: "the theme stays" }))
3480	*/
3481	'config.set': ConfigSetInput;
3482	/**
3483	* Fires once per `/config` row, when the menu lists it and for
3484	* `$.config.list`; `next(e)` resolves to `{ label, description, isHidden }`.
3485	*
3486	* Relabel, re-describe or hide with `next({ ...e, isHidden: true })`; the
3487	* answers are cached until `$.ui.invalidate("config.describe")` or the
3488	* loaded plugins change. A hook that fails passes the row through.
3489	*
3490	* @example
3491	* on("config.describe", { key: "tips" }, hide) // answers isHidden: true
3492	*/
3493	'config.describe': ConfigDescribeInput;
3494	/**
3495	* Fires when the engine expands a skill's prompt for the model (`/name`,
3496	* the Skill tool, a preload); `next(e)` resolves to `{ text }` as computed.
3497	*
3498	* Return `{ text }` with the text the model reads instead. A hook that
3499	* fails passes it through.
3500	*
3501	* @example
3502	* on("skill.prompt", { skill: "commit" }, () => ({ text: "A haiku." }))
3503	*/
3504	'skill.prompt': SkillPromptInput;
3505	/**
3506	* Fires when the engine composes a git text the model is to write (`kind`:
3507	* `commit`, `pr`, `exemption`, `remedy`); `next(e)` resolves to `{ text }`.
3508	*
3509	* Return `{ text }` with the text the model reads instead. A hook that
3510	* fails passes it through.
3511	*
3512	* @example
3513	* on("attribution.text", { kind: "commit" }, () => ({ text: "" }))
3514	*/
3515	'attribution.text': AttributionTextInput;
3516	/**
3517	* Fires once per process for each loaded plugin, before the first prompt,
3518	* then once per fresh load of one (never `/clear`); `next(e)` is `{ cwd }`.
3519	*
3520	* Observe. The first is awaited: a `$.tool.register` is listed by turn one.
3521	* A later one runs its hooks alone: an enable, a worker respawn, or a reload
3522	* (changed modules only; all if one hooks `engine.create`/`plugin.register`).
3523	*
3524	* @example
3525	* on("session.start", ($, e, next) => $.tool.register(t).then(() => next(e)))
3526	*/
3527	'session.start': SessionStartInput;
3528	/**
3529	* Fires when a delivery reaches the session (a relay's event, a peer's
3530	* message, a Remote Control prompt), before it is queued; `{ text }`.
3531	*
3532	* Rewrite with `next({ ...e, text })`, or return `{ consumed: reason }` to
3533	* take it: nothing is queued, shown or read by the model. `origin` and
3534	* `event` pass on as received; `session.send`, its dual, is reserved.
3535	*
3536	* @example
3537	* on("session.receive", { origin: "peer" }, () => ({ consumed: "muted" }))
3538	*/
3539	'session.receive': SessionReceiveInput;
3540	/**
3541	* Fires when the conversation is about to be compacted (`/compact`, the
3542	* threshold, a plugin, or ahead of time); `next(e)` resolves `{ messages }`.
3543	*
3544	* Rewrite `instructions` or `messages` on the way down, the messages on
3545	* the way up, or answer `{ messages }` of your own; `{ skip: reason }`
3546	* leaves the conversation as it is. `trigger` passes on as received.
3547	*
3548	* @example
3549	* on("session.compact", { trigger: "precompute" }, () => ({ skip: "off" }))
3550	*/
3551	'session.compact': SessionCompactInput;
3552	/**
3553	* Fires when a remote client joins the session's roster of attached
3554	* surfaces: it said so (ui_attach), or it first asked to draw.
3555	*
3556	* Observe (a phone joined: draw the lobby); `next(e)` resolves to
3557	* `{ clientId }`, a different return changes nothing. `$.session.surfaces()`
3558	* reads the roster; a render hook still reads `e.surface` per ask.
3559	*
3560	* @example
3561	* on("session.attach", { surface: "mobile" }, ($, e, next) => next(e))
3562	*/
3563	'session.attach': SessionAttachInput;
3564	/**
3565	* Fires when a client leaves the roster: it detached, or the session ended
3566	* with it attached (`e.reason`). Observe; `next(e)` echoes `{ clientId }`.
3567	*/
3568	'session.detach': SessionDetachInput;
3569	/**
3570	* Fires when the engine measures the session and a unit moved: after each
3571	* main-thread turn, and when a rate-limit window moves a whole point.
3572	*
3573	* Observe; `next(e)` echoes `{ changed }`. `$.session.usage()`'s figures,
3574	* pushed, not polled: compare them with your own threshold here, call the
3575	* op for the breakdown. One at a time, a burst folding into one more.
3576	*
3577	* @example
3578	* on("session.measure", ($, e, next) => (toastPast90(e.rateLimits), next(e)))
3579	*/
3580	'session.measure': SessionMeasureInput;
3581	/**
3582	* Fires once when the session ends (exit, /clear, resume, logout, signal, a
3583	* `-p` run done), after its SessionEnd settings hooks; `e.reason` says which.
3584	*
3585	* `e.resume.id` is `--resume`'s id; `next(e)` runs the engine's end step for
3586	* the plugins (at an exit the attached clients leave): `{ sessionId }`. The
3587	* SessionEnd bound afresh, 1.5 s by default; a `kill -9` raises nothing.
3588	*
3589	* @example
3590	* on("session.end", async ($, e, next) => (await keep(e.resume), next(e)))
3591	*/
3592	'session.end': SessionEndInput;
3593	/**
3594	* Fires once per hooks module about to join the chain, at load (the set
3595	* folded and built, nothing swapped in) and at reload; core allows.
3596	*
3597	* Return `{ refuse: reason }` and it never joins: no hook, no noun, no tool
3598	* of it; the transcript names who refused. Its judges, `$` whole, are the
3599	* plugins admitted before it and the binary's; judge by `tier` and `uses`.
3600	*
3601	* @example
3602	* on("plugin.register", { tier: "user" }, () => ({ refuse: "managed only" }))
3603	*/
3604	'plugin.register': PluginRegisterInput;
3605	/**
3606	* Fires when a model turn begins, before its first model call; `next(e)`
3607	* resolves to `{ turnId }`. Observe: a different return changes nothing.
3608	*/
3609	'turn.start': TurnStartInput;
3610	/**
3611	* Fires when the engine is about to send a model request of a turn, main's
3612	* or a subagent's (`e.agentId`); `next(e)` resolves to the whole response.
3613	*
3614	* `next({ ...e, model })` or `effort` sends another; the turn, the index and
3615	* the message count are pinned. An answer without `next` sends no request.
3616	* It streams (StreamNext): the hook's budget counts its own code alone.
3617	*/
3618	'turn.step': TurnStepInput;
3619	/**
3620	* Fires when a model turn has ended, at the point its duration is reported;
3621	* `next(e)` resolves to `{ text }`, the answer. `e.reason` says why.
3622	*
3623	* Return `{ text }` with a different text to show it beneath the answer (a
3624	* synopsis, a TL;DR line); the transcript's record is never rewritten. A
3625	* hook that fails leaves the answer as it was.
3626	*/
3627	'turn.complete': TurnCompleteInput;
3628	/**
3629	* Runs while `$` is being built, once per load or reload of this plugin
3630	* and before any other hook of it; `next(e)` resolves to `$` built so far.
3631	*
3632	* A step may ADD nouns and WITHHOLD nouns (leave one out, or return without
3633	* `next`); it may NOT REPLACE one another step added: the step fails, named
3634	* with both plugins. A step that fails unloads its plugin; `$` is rebuilt.
3635	*/
3636	'engine.create': EngineCreateInput;
3637	};
3638
3639	/**
3640	* `$`, the first parameter of every hook. Frozen; core's interface plus
3641	* every noun the plugins' `engine.create` steps added.
3642	*
3643	* Flat, `<noun>.<event>`; it does not carry `on`, since registration happens
3644	* before `$` exists. An interface so a plugin types the noun it provides by
3645	* declaration merging, the way a jQuery plugin types `$.fn`.
3646	*
3647	* @example
3648	* declare module "claude-code" { interface EngineInterface { voice: Voice } }
3649	*/
3650	export interface EngineInterface extends CoreEngineInterface {
3651	}
3652
3653	/**
3654	* What `next(e)` resolves to at `engine.create`: `$` as the steps beneath
3655	* built it, typed as `$` is, open to nouns no declaration names yet.
3656	*
3657	* A withheld noun is on it as a stub (a step inside withheld it, or the
3658	* last fold did and this is a reload), and the host refuses an op on one a
3659	* step outside withholds later; a typed module bootstraps at load on it.
3660	*/
3661	export type EngineInterfaceBuilt = EngineInterface & {
3662	readonly [noun: string]: unknown;
3663	};
3664
3665	/**
3666	* The engine's events' results.
3667	*/
3668	export type EngineResultOf = {
3669	/**
3670	* `{ result, context? }`, `{ deny }`, or core's `{ ref, result }`.
3671	*/
3672	'tool.call': ToolCallResult;
3673	/**
3674	* `{ decision, reason?, rule? }`.
3675	*/
3676	'tool.check': ToolCheckResult;
3677	/**
3678	* The tree to draw; `{ type: "engine", ref }` is core's own drawing.
3679	*/
3680	'ui.render': RenderElement;
3681	/**
3682	* The surface's element table (Elements[e.surface]): constructors from props
3683	* to a RenderElement.
3684	*/
3685	'ui.resolve': ElementTable;
3686	/**
3687	* `{ element }`: the element whose handler the press reached.
3688	*/
3689	'ui.press': UiPressResult;
3690	/**
3691	* `{ element, value }`: the field whose handler the input reached, and
3692	* the text it received.
3693	*/
3694	'ui.input': UiInputResult;
3695	/**
3696	* `{ element, value }`: the picker whose handler the pick reached, and
3697	* the value it received.
3698	*/
3699	'ui.select': UiSelectResult;
3700	/**
3701	* `{ props? }`: the posting instance's next props, when a hook hands some.
3702	*/
3703	'ui.message': UiMessageResult;
3704	/**
3705	* `{}` once the window moved, or `{ deny }`.
3706	*/
3707	'ui.scroll': UiScrollResult;
3708	/**
3709	* `{}` once the ring moved, or `{ deny }`.
3710	*/
3711	'ui.focus': UiFocusResult;
3712	/**
3713	* `{ isOffered }`.
3714	*/
3715	'agent.offer': AgentOfferResult;
3716	/**
3717	* `{ model }` or `{ deny }`.
3718	*/
3719	'agent.spawn': AgentSpawnResult;
3720	/**
3721	* `{ text, context? }` or `{ drop }`.
3722	*/
3723	'prompt.submit': PromptSubmitResult;
3724	/**
3725	* `{ isFilled }`.
3726	*/
3727	'prompt.fill': PromptFillResult;
3728	/**
3729	* `{ isShown }`.
3730	*/
3731	'prompt.suggest': PromptSuggestResult;
3732	/**
3733	* `{ text, cursor }`, the box the editor shows next.
3734	*/
3735	'prompt.edit': PromptEditResult;
3736	/**
3737	* `{ text }` (null leaves the section out).
3738	*/
3739	'prompt.section': PromptSectionResult;
3740	/**
3741	* `{ blocks }` (a block left out is not sent).
3742	*/
3743	'prompt.context': PromptContextResult;
3744	/**
3745	* `{ text }` (null leaves the attachment out).
3746	*/
3747	'prompt.attachment': PromptAttachmentResult;
3748	/**
3749	* `{ description, isDeferred? }`.
3750	*/
3751	'tool.describe': ToolDescribeResult;
3752	/**
3753	* `{ text }` (the command's output, when it printed one).
3754	*/
3755	'command.run': CommandRunResult;
3756	/**
3757	* `{ description, argumentHint, isHidden }`.
3758	*/
3759	'command.describe': CommandDescribeResult;
3760	/**
3761	* `{ value }` once written, or `{ deny }`.
3762	*/
3763	'config.set': ConfigSetResult;
3764	/**
3765	* `{ label, description, isHidden }`.
3766	*/
3767	'config.describe': ConfigDescribeResult;
3768	/**
3769	* `{ text }`.
3770	*/
3771	'skill.prompt': SkillPromptResult;
3772	/**
3773	* `{ text }`.
3774	*/
3775	'attribution.text': AttributionTextResult;
3776	/**
3777	* `{ cwd }`.
3778	*/
3779	'session.start': SessionStartResult;
3780	/**
3781	* `{ text }`, or `{ consumed }`.
3782	*/
3783	'session.receive': SessionReceiveResult;
3784	/**
3785	* `{ messages, tokensBefore?, tokensAfter? }`, or `{ skip }`.
3786	*/
3787	'session.compact': SessionCompactResult;
3788	/**
3789	* `{ clientId }`.
3790	*/
3791	'session.attach': SessionAttachResult;
3792	/**
3793	* `{ clientId }`.
3794	*/
3795	'session.detach': SessionDetachResult;
3796	/**
3797	* `{ changed }`.
3798	*/
3799	'session.measure': SessionMeasureResult;
3800	/**
3801	* `{ sessionId }`.
3802	*/
3803	'session.end': SessionEndResult;
3804	/**
3805	* `{ allow: true }`, or `{ refuse }`.
3806	*/
3807	'plugin.register': PluginRegisterResult;
3808	/**
3809	* `{ turnId }`.
3810	*/
3811	'turn.start': TurnStartResult;
3812	/**
3813	* The response: `{ turnId, index, answer, toolUses, stopReason, usage }`.
3814	*/
3815	'turn.step': TurnStepResult;
3816	/**
3817	* `{ text }`.
3818	*/
3819	'turn.complete': TurnCompleteResult;
3820	/**
3821	* `$` as built so far, with this plugin's interface added and any it
3822	* withheld left out; `next(e)` resolves to EngineInterfaceBuilt.
3823	*/
3824	'engine.create': EngineCreateResult;
3825	};
3826
3827	/**
3828	* The engine's own events as calls on `$`, one signature each:
3829	* `$.<noun>.<event>(input)` resolves to its result, or to its stream.
3830	*
3831	* The engine raises its events through these same calls; a plugin's call
3832	* runs the same chain with the calling hook alone skipped. `input` may leave
3833	* out what the engine fills (`tool_use_id`, the parent agent).
3834	*/
3835	export type EventCalls = {
3836	tool: {
3837	call: ToolCallOverloads;
3838	check: (input: ToolCheckArgs) => Promise<ToolCheckResult>;
3839	describe: (input: ToolDescribeInput) => Promise<ToolDescribeResult>;
3840	};
3841	command: {
3842	run: (input: CommandRunArgs) => Promise<CommandRunResult>;
3843	describe: (input: CommandDescribeInput) => Promise<CommandDescribeResult>;
3844	};
3845	config: {
3846	set: (input: ConfigSetArgs) => Promise<ConfigSetResult>;
3847	describe: (input: ConfigDescribeInput) => Promise<ConfigDescribeResult>;
3848	};
3849	prompt: {
3850	submit: (input: PromptSubmitArgs) => Promise<PromptSubmitResult>;
3851	fill: (input: PromptFillArgs) => Promise<PromptFillResult>;
3852	suggest: (input: PromptSuggestArgs) => Promise<PromptSuggestResult>;
3853	section: (input: PromptSectionInput) => Promise<PromptSectionResult>;
3854	context: (input: PromptContextInput) => Promise<PromptContextResult>;
3855	attachment: (input: PromptAttachmentInput) => Promise<PromptAttachmentResult>;
3856	};
3857	skill: {
3858	prompt: (input: SkillPromptInput) => Promise<SkillPromptResult>;
3859	};
3860	attribution: {
3861	text: (input: AttributionTextInput) => Promise<AttributionTextResult>;
3862	};
3863	agent: {
3864	offer: (input: AgentOfferInput) => Promise<AgentOfferResult>;
3865	spawn: (input: AgentSpawnArgs) => Promise<AgentSpawnResult>;
3866	};
3867	session: {
3868	start: (input: SessionStartInput) => Promise<SessionStartResult>;
3869	receive: (input: SessionReceiveInput) => Promise<SessionReceiveResult>;
3870	compact: (input?: SessionCompactArgs) => Promise<SessionCompactResult>;
3871	attach: (input: SessionAttachInput) => Promise<SessionAttachResult>;
3872	detach: (input: SessionDetachInput) => Promise<SessionDetachResult>;
3873	measure: (input: SessionMeasureInput) => Promise<SessionMeasureResult>;
3874	end: (input: SessionEndInput) => Promise<SessionEndResult>;
3875	};
3876	turn: {
3877	start: (input: TurnStartInput) => Promise<TurnStartResult>;
3878	step: (input: TurnStepInput) => HookStream<TurnStepChunk, TurnStepResult>;
3879	complete: (input: TurnCompleteInput) => Promise<TurnCompleteResult>;
3880	};
3881	ui: {
3882	render: <C extends RenderComponent>(input: RenderInput<C>) => Promise<RenderElement>;
3883	resolve: <E extends ResolveInput>(e: E) => Elements[E['surface']];
3884	scroll: (input: UiScrollArgs) => Promise<UiScrollResult>;
3885	focus: (input: UiFocusArgs) => Promise<UiFocusResult>;
3886	};
3887	};
3888
3889	/**
3890	* The name of an event: a key of EventOf, the engine's own (CoreEventName)
3891	* and the declared plugin nouns' (NounEventName).
3892	*/
3893	export type EventName = keyof EventOf;
3894
3895	/**
3896	* The argument of each event, by event name: what a hook receives as `e`
3897	* and what the call on `$` takes. Plain data, frozen to every depth.
3898	*
3899	* The engine's own events (CoreEventOf: a plugin's `$.fs.write(...)` is
3900	* a dispatch the hooks above it see) and the methods of the plugin nouns
3901	* declared on EngineInterface (NounEventOf).
3902	*/
3903	export type EventOf = CoreEventOf & NounEventOf;
3904
3905	/**
3906	* The result of event `N`: what its hooks return and what their `next(e)`
3907	* resolves to.
3908	*/
3909	export type EventResult<N extends EventName = EventName> = ResultOf[N];
3910
3911	/**
3912	* The hook signature of each event, `($, e, next)`, as one mapped type over
3913	* EventOf; a streaming event's is the generator form (StreamHook).
3914	*
3915	* With one handler type per event, `Events[E]` for a generic E would be a
3916	* union; as one mapped type it stays a single function type the engine
3917	* calls without a cast (TS 4.6 correlated unions).
3918	*
3919	* @param $ the engine interface, frozen, the same object at every invocation;
3920	* at `engine.create` the empty table, since `$` exists after the fold
3921	* @param e the event's argument, frozen to every depth (`e.command = "ls"`
3922	* is a type error and throws); a rewrite is a copy passed to `next`
3923	* @param next the rest of the chain; a chain a hook raises through `$` skips
3924	* this hook and runs every other, its plugin's others too
3925	*/
3926	export type Events = {
3927	[E in keyof EventOf]: E extends StreamingEventName ? StreamHook<E> : ($: E extends 'engine.create' ? NoEngineInterface : EngineInterface, e: Frozen<Args<E>>, next: Next<E>) => EventResult<E> \| Promise<EventResult<E>>;
3928	};
3929
3930	type ExitReason = 'clear' \| 'resume' \| 'logout' \| 'prompt_input_exit' \| 'other';
3931
3932	type FileChangedHookInput = BaseHookInput & {
3933	hook_event_name: 'FileChanged';
3934	file_path: string;
3935	event: 'change' \| 'add' \| 'unlink';
3936	};
3937
3938	/**
3939	* `T` with every property read-only to every depth, arrays and tuples kept
3940	* as declared: how a hook's `e` is typed.
3941	*
3942	* `e.command = 'x'` is a type error; `next({ ...e, command: 'x' })` compiles.
3943	*/
3944	export type Frozen<T> = T extends (...args: never[]) => unknown ? T : T extends readonly unknown[] ? {
3945	[K in keyof T]: Frozen<T[K]>;
3946	} : T extends object ? {
3947	readonly [K in keyof T]: Frozen<T[K]>;
3948	} : T;
3949
3950	/**
3951	* One file `$.fs.ancestors` found: the directory it stands in, the name it
3952	* was asked for by, and its text as the engine's memory loader reads it.
3953	*/
3954	export type FsAncestor = {
3955	/**
3956	* The directory the file stands in, absolute.
3957	*/
3958	dir: string;
3959	/**
3960	* The spelling the caller asked for it by.
3961	*/
3962	name: string;
3963	/**
3964	* The file's text, with what its `@include`s bring after it.
3965	*/
3966	content: string;
3967	/**
3968	* The file and then each file its `@` imports brought, in load order,
3969	* path and text apiece; `content` is these texts joined.
3970	*/
3971	parts: readonly FsAncestorPart[];
3972	};
3973
3974	/**
3975	* One file of an ancestor entry: the file itself or one it imported.
3976	*/
3977	export type FsAncestorPart = {
3978	/**
3979	* The file's path, absolute.
3980	*/
3981	path: string;
3982	/**
3983	* Its text as the engine's memory loader reads it.
3984	*/
3985	content: string;
3986	};
3987
3988	/**
3989	* The argument of `$.fs.ancestors`: the file names to look for in each
3990	* directory, the file to walk down to, and the directory to walk beneath.
3991	*/
3992	export type FsAncestorsRequest = {
3993	/**
3994	* Relative `.md` file names, each looked for in every directory.
3995	*/
3996	names: readonly string[];
3997	/**
3998	* The file the walk goes on down to the directory of, relative to the
3999	* working directory or absolute; absent, it ends at the working directory.
4000	*/
4001	of?: string;
4002	/**
4003	* The directory the walk starts beneath, relative to the working directory
4004	* or absolute; absent, the walk starts at the filesystem root.
4005	*
4006	* Only directories strictly inside it are read, so with `of` a file under
4007	* the project root the walk reads the directories between the two, as the
4008	* engine reads a nested CLAUDE.md; a file not inside it finds nothing.
4009	*/
4010	below?: string;
4011	};
4012
4013	/**
4014	* What `$.fs.read(path, { as: "bytes" })` resolves with: the file's bytes,
4015	* base64, since only plain data crosses into a plugin's environment.
4016	*/
4017	export type FsBytes = {
4018	/**
4019	* The file's content, standard padded base64;
4020	* `Uint8Array.fromBase64(base64)` gives the bytes back.
4021	*/
4022	base64: string;
4023	};
4024
4025	/**
4026	* One entry of `$.fs.list`: the entry itself, a link not followed.
4027	*/
4028	export type FsEntry = {
4029	/**
4030	* The entry's name (no directory part).
4031	*/
4032	name: string;
4033	/**
4034	* `file`, `dir`, or `other`, of the entry itself: a symbolic link is
4035	* `other` (`$.fs.stat` says what it leads to, and with `resolve` where).
4036	*/
4037	kind: 'file' \| 'dir' \| 'other';
4038	/**
4039	* Bytes, for a file.
4040	*/
4041	size: number;
4042	/**
4043	* True when the entry is a symbolic link.
4044	*/
4045	isLink: boolean;
4046	};
4047
4048	/**
4049	* How `$.fs.read` answers: `text` (UTF-8, the default) or `bytes` (base64).
4050	*/
4051	export type FsReadAs = 'text' \| 'bytes';
4052
4053	/**
4054	* The options of `$.fs.read` that ask for the bytes: the call answers
4055	* `{ base64 }`.
4056	*/
4057	export type FsReadBytesOptions = {
4058	/**
4059	* `bytes`.
4060	*/
4061	as: 'bytes';
4062	};
4063
4064	/**
4065	* `$.fs.read`: the file's text, or with `{ as: "bytes" }` its bytes as
4066	* `{ base64 }`.
4067	*/
4068	export type FsReadCall = {
4069	(path: string): Promise<string>;
4070	(path: string, options: FsReadBytesOptions): Promise<FsBytes>;
4071	(path: string, options: FsReadOptions): Promise<string \| FsBytes>;
4072	};
4073
4074	/**
4075	* The options of `$.fs.read`.
4076	*/
4077	export type FsReadOptions = {
4078	/**
4079	* `bytes` answers `{ base64 }` for a binary file; `text` (the default) the
4080	* file's text.
4081	*/
4082	as: FsReadAs;
4083	};
4084
4085	/**
4086	* What `$.fs.stat` resolves with: what the path leads to, whether the path
4087	* itself is a symbolic link, and where it lands when asked.
4088	*/
4089	export type FsStat = {
4090	/**
4091	* `file`, `dir`, or `other`, of what the path leads to: a link is
4092	* followed, and one that leads nowhere is `other`.
4093	*/
4094	kind: 'file' \| 'dir' \| 'other';
4095	/**
4096	* Bytes, for a file.
4097	*/
4098	size: number;
4099	/**
4100	* Last modification, milliseconds since the epoch.
4101	*/
4102	mtimeMs: number;
4103	/**
4104	* True when the path itself is a symbolic link; `kind`, `size` and
4105	* `mtimeMs` then describe what it points at, or the link when that is gone.
4106	*/
4107	isLink: boolean;
4108	/**
4109	* Where the path landed when asked with `{ resolve: true }`: absolute,
4110	* every symbolic link followed, `.` and `..` folded; else absent.
4111	*
4112	* Absent too when the path leads nowhere or a hook above withheld it, so
4113	* a guard denies without it; and a hard link, a volume or file-id spelling
4114	* (macOS `/.vol/`) or a case alias keeps its own spelling, `isLink` false.
4115	*
4116	* @remarks a deny-list on spellings is thus best effort; an allow-list on
4117	* `realPath` under a root resolved the same way is the robust guard.
4118	*/
4119	realPath?: string;
4120	};
4121
4122	/**
4123	* The options of `$.fs.stat`.
4124	*/
4125	export type FsStatOptions = {
4126	/**
4127	* True to resolve where the path lands as well.
4128	*
4129	* The answer then carries `realPath` when the path leads somewhere, at
4130	* the cost of one more file system call: where it landed then, not a hold
4131	* on what a tool opens afterwards.
4132	*/
4133	resolve: boolean;
4134	};
4135
4136	/**
4137	* Every event (``), or every event under a namespace (`classic.`: each
4138	* one whose name starts with `classic.`).
4139	*/
4140	export type Glob = '' \| `${Namespace}.`;
4141
4142	/**
4143	* The hook `on(pattern, hook)` takes for a glob or a negation: one function
4144	* placed on every selected event, `e` and the result typed as their union.
4145	*
4146	* `next.event` says which event a run is; `next.is(pattern, e)` narrows `e`
4147	* to one of them. At `engine.create` (a negation may select it) `$` is the
4148	* empty table and the hook observes the fold, as a `*` hook does.
4149	*/
4150	export type GlobHook<P extends Pattern, N extends EventName = Selected<P>> = ($: EngineInterface, e: Frozen<Args<N>>, next: GlobNext<P>) => EventResult<N> \| Promise<EventResult<N>>;
4151
4152	/**
4153	* `next` in a hook on a glob or a negation: an overload per selected event,
4154	* then one over their union for an `e` not yet narrowed.
4155	*
4156	* `is` narrows `e` to the selected events its pattern names; `event` is one
4157	* of the selected names.
4158	*/
4159	export type GlobNext<P extends Pattern, N extends EventName = Selected<P>> = OrderedOverloads<N> & {
4160	(e: Args<N>): Promise<GlobNextResult<N>>;
4161	/**
4162	* Continues this dispatch at a tier, as Next's `to` (a managed hook's),
4163	* over the selected events' union for an `e` not yet narrowed.
4164	*/
4165	readonly to: (e: Args<N>, tier: TargetTier) => Promise<GlobNextResult<N>>;
4166	readonly signal: AbortSignal;
4167	readonly is: <M extends PatternOver<N>>(pattern: M, e: unknown) => e is Frozen<Args<Extract<N, Selected<M>>>>;
4168	readonly event: N;
4169	readonly origin: Origin;
4170	readonly trace: readonly TraceEntry<N, Args<N>, GlobNextResult<N>>[];
4171	readonly budget: NextBudget;
4172	};
4173
4174	/**
4175	* What `next(e)` resolves to in a glob hook before `e` is narrowed: the
4176	* NextResult of each selected event, as a union.
4177	*/
4178	type GlobNextResult<N extends EventName> = {
4179	[K in N]: NextResult<K>;
4180	}[N];
4181
4182	/**
4183	* One hook, `($, e, next)`, on event `E`.
4184	*/
4185	export type Hook<E extends EventName = EventName> = Events[E];
4186
4187	/**
4188	* The time bounds every hook runs under, in milliseconds: the engine's own
4189	* constants are typed by these members, and `next.budget` reads the live one.
4190	*
4191	* Each bounds the hook's OWN time: the clock stops while a `next(e)` call or
4192	* any `$` call of the hook's is in flight (a `$.clock` wait excepted), so a
4193	* slow chain beneath or a minute-long `$.model.complete` costs it nothing.
4194	*
4195	* @example
4196	* await $.model.complete(ask) // a minute; next.budget.remainingMs unmoved
4197	*/
4198	export type HookBudget = {
4199	/**
4200	* A hook's budget per dispatch, from its call to its return; past it the
4201	* hook is absent (its `.catch` asked, else `next(e)` run on its behalf).
4202	*
4203	* A streaming hook's (`turn.step`, an async generator) spans its whole
4204	* run and counts only while its own code runs: never at a `yield`, never
4205	* while it reads the stream beneath. Not per chunk: the sum of its work.
4206	*/
4207	readonly ms: 10_000;
4208	/**
4209	* A `.catch` handler's grace: a fresh budget from the moment it is called,
4210	* on the same clock (its `next` replay and its `$` calls are free).
4211	*
4212	* Past it the hook is absent as if it had no handler; `next.error.budget`
4213	* and `next.budget.ms` both read it there. `engine.create` has no budget.
4214	*/
4215	readonly catchMs: 1_000;
4216	/**
4217	* How long a hook may keep running after `next.signal` aborted (the person
4218	* interrupted, a hook above settled first, its own budget ran out).
4219	*
4220	* Past it the hook is reported as lingering; the dispatch had already gone
4221	* on without it when the signal aborted.
4222	*/
4223	readonly lingerMs: 5_000;
4224	};
4225
4226	/**
4227	* Why a hook failed, as its `.catch` handler reads it on `next.error`: plain
4228	* frozen data.
4229	*
4230	* `throw`: the hook threw, or returned what the site refuses, `message`
4231	* saying what; `timeout`: it outran its budget, `message` then what its last
4232	* `next()` rejected with, if it did. `budget` is the handler's own grace.
4233	*/
4234	export type HookFailure = {
4235	readonly kind: 'throw' \| 'timeout';
4236	/**
4237	* The thrown error's message, or for a timeout what the hook's last
4238	* `next()` rejected with; absent for a timeout with nothing rejected.
4239	*/
4240	readonly message?: string;
4241	/**
4242	* The grace the handler runs under, in milliseconds; past it, the hook is
4243	* absent as if it had no handler.
4244	*/
4245	readonly budget: number;
4246	};
4247
4248	/**
4249	* The hook type per pattern: an event's own (Events), `*`'s (AnyEventHook),
4250	* or a glob's over the events it selects (GlobHook), as one conditional type.
4251	*
4252	* One type, so the two-argument `on` stays ONE generic signature: as an
4253	* overload set the language service offers no tool-name completions inside
4254	* `e.tool === "`; as an index into a table TS intersects every argument.
4255	*/
4256	export type HookFor<P extends Pattern> = P extends '*' ? AnyEventHook : P extends EventName ? Events[P] : GlobHook<P>;
4257
4258	type HookInput = PreToolUseHookInput \| PostToolUseHookInput \| PostToolUseFailureHookInput \| PostToolBatchHookInput \| PermissionDeniedHookInput \| NotificationHookInput \| UserPromptSubmitHookInput \| UserPromptExpansionHookInput \| SessionStartHookInput \| SessionEndHookInput \| StopHookInput \| StopFailureHookInput \| SubagentStartHookInput \| SubagentStopHookInput \| PreCompactHookInput \| PostCompactHookInput \| PreModelSwitchHookInput \| PostModelSwitchHookInput \| PermissionRequestHookInput \| SetupHookInput \| TeammateIdleHookInput \| TaskCreatedHookInput \| TaskCompletedHookInput \| ElicitationHookInput \| ElicitationResultHookInput \| ConfigChangeHookInput \| InstructionsLoadedHookInput \| WorktreeCreateHookInput \| WorktreeRemoveHookInput \| CwdChangedHookInput \| FileChangedHookInput \| DirectoryAddedHookInput \| MessageDisplayHookInput;
4259
4260	/**
4261	* The hook event `E` takes: an async generator over its chunks for a
4262	* streaming event (`turn.step`), `($, e, next) => result` for every other.
4263	*/
4264	export type HookOf<E extends EventName> = Events[E];
4265
4266	/**
4267	* What a hooks module exports: `register`, and nothing the loader reads
4268	* besides.
4269	*/
4270	export type HooksModule = {
4271	register: Register;
4272	};
4273
4274	/**
4275	* What `next(e)` returns on a streaming event: the stream of everything
4276	* beneath, chunk by chunk, whose return value is the result from beneath.
4277	*
4278	* `yield* next(e)` forwards the chunks and evaluates to that result; a
4279	* transforming hook reads `for await (const chunk of stream)` and then
4280	* `await stream.result`. Each call runs what is beneath afresh.
4281	*/
4282	export type HookStream<C, R> = AsyncGenerator<C, R> & {
4283	/**
4284	* Settles with what beneath returned once the stream has been read to
4285	* its end; rejects if the stream is closed before that.
4286	*/
4287	readonly result: Promise<R>;
4288	};
4289
4290	/**
4291	* Options of `$.http.fetch`.
4292	*/
4293	export type HttpInit = {
4294	/**
4295	* `GET` (default), `POST`, ...
4296	*/
4297	method?: string;
4298	/**
4299	* Request headers.
4300	*/
4301	headers?: Record<string, string>;
4302	/**
4303	* The request body, as text.
4304	*/
4305	body?: string;
4306	/**
4307	* The handle `$.session.authorize()` answered: the engine sets the
4308	* session's credential header itself, only for a first-party host.
4309	*/
4310	auth?: string;
4311	/**
4312	* The absolute path of a Unix domain socket the request goes over instead
4313	* of TCP (near 100 B at most): one per session, in a private directory.
4314	*
4315	* The URL still gives path, query and Host; redirects stay on it; no proxy;
4316	* `https:` is TLS verified against the URL's host (always, once `auth`
4317	* rides), so a credential reaches only its host. No relative path, no NUL.
4318	*
4319	* @example
4320	* await $.http.fetch(url, { socketPath: `${runDirectory}/bridge.sock` })
4321	*/
4322	socketPath?: string;
4323	};
4324
4325	/**
4326	* What `$.http.fetch` resolves with.
4327	*/
4328	export type HttpResponse = {
4329	/**
4330	* The HTTP status code.
4331	*/
4332	status: number;
4333	/**
4334	* True for a 2xx status.
4335	*/
4336	ok: boolean;
4337	/**
4338	* Response headers, lower-cased names.
4339	*/
4340	headers: Record<string, string>;
4341	/**
4342	* The body, as text.
4343	*/
4344	text: string;
4345	};
4346
4347	/**
4348	* A `$.ui.blit` argument swapping one of the caller's mounted keyed Images
4349	* to its next picture; every call sends it, so a stream needs no generation.
4350	*
4351	* The surface writes them with its frames, some sixty a second: byte and
4352	* `file` sources fold to the last per frame; every `shm` source reaches the
4353	* terminal (it unlinks each), and is denied while frames are not written.
4354	*
4355	* @example await $.ui.blit({ requestId: 'browser', key: 'view',
4356	* source: { shm: '/tb-4', format: 'rgb', width: 1280, height: 720 } })
4357	*/
4358	export type ImageBlitArgs = {
4359	/**
4360	* The site the Image is drawn in, by the `requestId` this plugin draws it
4361	* under.
4362	*/
4363	requestId: string;
4364	/**
4365	* The Image's `key` in that drawing.
4366	*/
4367	key: string;
4368	/**
4369	* The next picture (ImageSource): bytes, or a name the terminal reads.
4370	*/
4371	source: ImageSource;
4372	/**
4373	* Refused unless it is the mounted Image's width in cells. Absent, that.
4374	*/
4375	columns?: number;
4376	/**
4377	* Refused unless it is the mounted Image's height in cells. Absent, that.
4378	*/
4379	rows?: number;
4380	};
4381
4382	/**
4383	* The props of `Image`, the terminal surface's picture leaf: pixels over a
4384	* box of cells where the terminal can (kitty, Ghostty), the `alt` elsewhere.
4385	*
4386	* A leaf: no children, `hover` or `onPress`; the cells are text, so the
4387	* picture scrolls and clips as a word does. Drawn again with another `source`
4388	* it is replaced in place; keyed, `$.ui.blit` swaps it at the frame rate.
4389	*
4390	* @example const { bytes } = await $.fs.read('chart.png', { as: 'bytes' })
4391	* <Image source={{ png: bytes.toBase64() }} columns={40} rows={12} alt="p95" />
4392	* @example <Image key="view" source={{ shm: '/tb-7', format: 'rgb', width: 960,
4393	* height: 600 }} columns={80} rows={25} alt="the page" />
4394	*/
4395	export type ImageProps = {
4396	/**
4397	* The element's address within the drawing: what `$.ui.blit` names to swap.
4398	*
4399	* Unique among the Images of one tree; absent, only a redraw changes it.
4400	*/
4401	key?: string;
4402	/**
4403	* The picture (ImageSource): `{ png }` or `{ rgba, width, height }` bytes,
4404	* or `{ file, format }` / `{ shm, format, width, height }` read here.
4405	*/
4406	source: ImageSource;
4407	/** How many terminal columns wide, 1 to 255; the picture is scaled to fill
4408	* the box and the site clips what its body cannot show. */
4409	columns: number;
4410	/**
4411	* How many terminal rows tall, 1 to 255.
4412	*/
4413	rows: number;
4414	/**
4415	* What the picture says, drawn dim in its place where the picture cannot
4416	* be (and read by a screen reader); required, may be a single space.
4417	*/
4418	alt: string;
4419	};
4420
4421	/**
4422	* The picture an `Image` shows: base64 bytes the plugin holds (at most 2 MiB
4423	* decoded), or the name of a file or POSIX shared-memory object it does not.
4424	*
4425	* A name is one another process on this machine wrote; the terminal, running
4426	* as the person, opens, reads and decodes it itself, so no pixel crosses `$`
4427	* and the engine never touches it. One it will not read (not a regular file,
4428	* under `/proc`, `/sys` or `/dev`, gone, across ssh) draws a blank box, its
4429	* words in the debug log; it unlinks a shared-memory object once read, so
4430	* each frame is a fresh one. A source equal to the last drawn sends nothing;
4431	* `generation` makes new content under an unchanged name a new source.
4432	*
4433	* @example { rgba: pixels.toBase64(), width: 64, height: 32 }
4434	* @example { file: '/dev/shm/frame-3.rgba', format: 'rgba', width: 640,
4435	* height: 400 }
4436	* @example { shm: '/tb-view-2', format: 'rgb', width: 1280, height: 720 }
4437	*/
4438	export type ImageSource = {
4439	/**
4440	* A whole PNG file, base64.
4441	*/
4442	png: string;
4443	} \| {
4444	/**
4445	* `width * height` RGBA pixels, 4 bytes each, base64.
4446	*/
4447	rgba: string;
4448	/**
4449	* Pixels per row, 1 to 2048.
4450	*/
4451	width: number;
4452	/**
4453	* Rows of pixels, 1 to 2048.
4454	*/
4455	height: number;
4456	} \| {
4457	/**
4458	* The absolute path of a regular file holding a whole PNG, at most
4459	* 3072 bytes of path; read by the terminal, left in place.
4460	*/
4461	file: string;
4462	/**
4463	* The file is a whole PNG; the terminal decodes it and sizes it itself.
4464	*/
4465	format: 'png';
4466	/**
4467	* A whole number that changes when the file's content does under the
4468	* same path, so a redraw reads it again; absent, the path alone tells.
4469	*/
4470	generation?: number;
4471	} \| {
4472	/**
4473	* The absolute path of a regular file of `width * height` raw pixels, at
4474	* most 3072 bytes of path; read by the terminal, left in place.
4475	*
4476	* On Linux a file under `/dev/shm` is memory.
4477	*/
4478	file: string;
4479	/**
4480	* `rgba`, 4 bytes a pixel, or `rgb`, 3.
4481	*/
4482	format: 'rgba' \| 'rgb';
4483	/**
4484	* Pixels per row, 1 to 4096.
4485	*/
4486	width: number;
4487	/**
4488	* Rows of pixels, 1 to 4096.
4489	*/
4490	height: number;
4491	/**
4492	* A whole number that changes when the file's content does under the
4493	* same path, so a redraw reads it again; absent, the path alone tells.
4494	*/
4495	generation?: number;
4496	} \| {
4497	/**
4498	* The name of a POSIX shared-memory object of `width * height` raw
4499	* pixels: `/` then up to 254 of `A-Z a-z 0-9 . _ -` (macOS takes 30).
4500	*
4501	* The terminal unlinks it after reading, so a name feeds one Image
4502	* drawn once and is never sent again on a redraw; POSIX terminals only.
4503	*/
4504	shm: string;
4505	/**
4506	* `rgba`, 4 bytes a pixel, or `rgb`, 3.
4507	*/
4508	format: 'rgba' \| 'rgb';
4509	/**
4510	* Pixels per row, 1 to 4096.
4511	*/
4512	width: number;
4513	/**
4514	* Rows of pixels, 1 to 4096.
4515	*/
4516	height: number;
4517	/**
4518	* A whole number that changes when a fresh object reuses a name, so a
4519	* redraw reads it again; absent, the name alone tells.
4520	*/
4521	generation?: number;
4522	};
4523
4524	/**
4525	* The keys of object pattern `P` that object member `E` cannot satisfy, `D`
4526	* levels down; `never` when there is none, which is what keeps the member.
4527	*
4528	* A key `E` does not have (an open record has every string key), or one
4529	* whose value `P` narrows to nothing.
4530	*/
4531	type ImpossibleKeys<E, P, D extends readonly unknown[]> = {
4532	[K in keyof P]-?: K extends keyof E ? [NarrowedValue<Exclude<E[K], undefined>, P[K], D>] extends [never] ? K : never : K;
4533	}[keyof P];
4534
4535	/**
4536	* The props of `Input`, every surface's one-line text field: an address,
4537	* optional texts, and the closures a change and a submit run. A leaf.
4538	*
4539	* Focused through the same ring as `Button` (`abovePrompt:focus`); while it
4540	* has focus every printable key reaches it alone and Esc returns them; a
4541	* change and Enter raise `ui.input`, whose bottom is `onInput` / `onSubmit`.
4542	*/
4543	export type InputProps = {
4544	/**
4545	* The element's address: `e.element` at `ui.input`, what a matcher names.
4546	*/
4547	key: string;
4548	/**
4549	* Text drawn before the field.
4550	*/
4551	label?: string;
4552	/**
4553	* Text drawn dim in an empty field.
4554	*/
4555	placeholder?: string;
4556	/**
4557	* The text the field holds when drawn; the person's typing replaces it
4558	* until the hook draws another.
4559	*/
4560	value?: string;
4561	/**
4562	* What Enter does, in a word or two, drawn beside the field while it has
4563	* focus (`send`). Defaults to `submit`.
4564	*/
4565	submitLabel?: string;
4566	/**
4567	* The site's focus ring starts here when the site takes the keyboard,
4568	* instead of on nothing, as the DOM's `autofocus`: Enter acts on it at once.
4569	*
4570	* A pane opened with `focus`, or the person's focus chord or click, is the
4571	* take. Of several in one site the first drawn wins; it raises `ui.focus`,
4572	* origin this plugin. A ring the person has moved stays where it was put.
4573	*/
4574	autoFocus?: true;
4575	/**
4576	* Runs on every change of the text, in the plugin's own environment: the
4577	* bottom of a `ui.input` chain of kind `change`.
4578	*/
4579	onInput?: (value: string, e: UiInputArgument) => void;
4580	/**
4581	* Runs on Enter with the text, in the plugin's own environment: the bottom
4582	* of a `ui.input` chain of kind `submit`. No model turn unless it asks one.
4583	*/
4584	onSubmit: (value: string, e: UiInputArgument) => void;
4585	};
4586
4587	/**
4588	* Every tier an instruction file can belong to, for checking a hook's
4589	* answer; the kind type is derived from this list.
4590	*/
4591	const INSTRUCTION_FILE_KINDS: readonly ["managed", "user", "project", "local", "memory"];
4592
4593	/**
4594	* One instruction file behind the `claudeMd` block: where it was read, its
4595	* tier, its text as loaded, and the file that `@`-imported it if one did.
4596	*/
4597	export type InstructionFile = {
4598	/**
4599	* The file's path, absolute.
4600	*/
4601	path: string;
4602	/**
4603	* Its tier.
4604	*/
4605	kind: InstructionFileKind;
4606	/**
4607	* The text as loaded (comments and frontmatter already stripped).
4608	*/
4609	content: string;
4610	/**
4611	* The path of the file whose `@` import brought this one, when one did.
4612	*/
4613	parent?: string;
4614	};
4615
4616	/**
4617	* What tier an instruction file belongs to: the organization's managed
4618	* policy, the person's own, the project's checked-in or private ones, memory.
4619	*/
4620	export type InstructionFileKind = (typeof INSTRUCTION_FILE_KINDS)[number];
4621
4622	type InstructionsLoadedHookInput = BaseHookInput & {
4623	hook_event_name: 'InstructionsLoaded';
4624	file_path: string;
4625	memory_type: 'User' \| 'Project' \| 'Local' \| 'Managed';
4626	load_reason: 'session_start' \| 'nested_traversal' \| 'path_glob_match' \| 'include' \| 'compact';
4627	globs?: string[];
4628	trigger_file_path?: string;
4629	parent_file_path?: string;
4630	};
4631
4632	/**
4633	* What `$.ui.invalidate` takes: a render event, or one of the six events
4634	* whose answers the engine caches for the session.
4635	*/
4636	export type InvalidatableEventName = RenderEventName \| 'prompt.section' \| 'prompt.context' \| 'prompt.attachment' \| 'tool.describe' \| 'command.describe' \| 'config.describe';
4637
4638	/**
4639	* Whether tag key `K` selects members of `I`: it does when each member gives
4640	* it ONE literal (`component: "ToolUse"` on the ToolUse variant).
4641	*
4642	* A key that is the same union on every member is a filter at runtime; it
4643	* is left out of the selection so that it cannot defeat the narrowing the
4644	* other keys give.
4645	*/
4646	type IsDiscriminant<I, K> = I extends unknown ? K extends KnownKeys<I> ? IsSingleLiteral<I[K]> : true : never;
4647
4648	/**
4649	* Whether `V` is made of literals only: `"a" \| "b"` is, `string` is not.
4650	*/
4651	type IsLiteralValued<V> = string extends V ? false : number extends V ? false : boolean extends V ? false : [V] extends [string \| number \| boolean] ? true : false;
4652
4653	/**
4654	* Whether `V` is exactly one string, number or boolean literal.
4655	*/
4656	type IsSingleLiteral<V> = [V] extends [string \| number \| boolean] ? IsUnion<V> extends true ? false : true : false;
4657
4658	/**
4659	* Whether `T` is a union of two or more members.
4660	*/
4661	type IsUnion<T, U = T> = T extends unknown ? [U] extends [T] ? false : true : never;
4662
4663	/**
4664	* Plain data: what JSON holds, and what crosses between a plugin's hooks
4665	* module and its surface module whole (a `Client`'s props, a post's data).
4666	*
4667	* A function, a class instance, `undefined` or a cycle is not plain data;
4668	* the engine refuses one where it checks, and drops it where it clones.
4669	*/
4670	export type JsonValue = string \| number \| boolean \| null \| readonly JsonValue[] \| {
4671	readonly [key: string]: JsonValue;
4672	};
4673
4674	/**
4675	* What `next` takes in a matched hook: the variants of `e` the matcher can
4676	* match (KeptMembers), as declared, so a rewrite of a pinned field passes.
4677	*/
4678	type KeptEvent<P extends Pattern, M> = MatchedNames<P, M> extends infer N extends EventName ? N extends unknown ? KeptMembers<Args<N>, M> : never : never;
4679
4680	/**
4681	* The members of the argument union `E` matcher `P` can match, as declared;
4682	* what `next` takes, so a rewrite may change a field the matcher pinned.
4683	*
4684	* A member is dropped when `P` names a key it lacks, or gives a key, at any
4685	* depth, a value none of that key's values can equal (ImpossibleKeys).
4686	*/
4687	type KeptMembers<E, P> = E extends unknown ? [ImpossibleKeys<E, P, []>] extends [never] ? E : never : never;
4688
4689	/**
4690	* The declared keys of `T`, the string and number index signatures left out.
4691	*/
4692	type KnownKeys<T> = keyof {
4693	[K in keyof T as string extends K ? never : number extends K ? never : K]: 0;
4694	};
4695
4696	/**
4697	* The events whose overload must come after the rest, lest it shadow them.
4698	*
4699	* `classic.PreToolUse` shares `tool.call`'s envelope, `turn.abort` every
4700	* turn event's `turnId`, and an object of any shape is assignable to NoArgs.
4701	*/
4702	type LateOverload = 'classic.PreToolUse' \| 'turn.abort' \| NoArgsEvent;
4703
4704	/**
4705	* The props of `Link`, a hyperlink every surface draws: an OSC 8 span on the
4706	* terminal (else its text then the URL in dim), an anchor on desktop.
4707	*
4708	* An inline element: its children are the text, strings and inline
4709	* elements; absent children the `label`, absent both the URL. The engine
4710	* bounds `href` before the tree crosses.
4711	*/
4712	export type LinkProps = {
4713	/**
4714	* Where the link goes: an `https:` URL (or `http://localhost`), at most
4715	* 2048 characters of printable ASCII, spelled as `new URL(href).href`.
4716	*
4717	* No `user@host` part, no raw `@`, space or non-ASCII letter (encode them);
4718	* anything else refuses the tree the Link is in.
4719	*/
4720	href: string;
4721	/**
4722	* The text drawn when the element has no children; absent both, the URL
4723	* itself is the text.
4724	*/
4725	label?: string;
4726	};
4727
4728	/**
4729	* What a matcher value selects by: itself, or `unknown` for a RegExp, which
4730	* selects nothing.
4731	*/
4732	type Literal<X> = X extends RegExp ? unknown : X;
4733
4734	/**
4735	* What a `Markdown` carries across the boundary: its address, text, dimness
4736	* and which links it answers; `onLinkPress` stays behind, a `press` instead.
4737	*/
4738	export type MarkdownLeafProps = {
4739	/**
4740	* The element's address: what `e.element` carries and what a matcher
4741	* names; present whenever the element carries a `press`.
4742	*/
4743	key?: string;
4744	/**
4745	* The markdown drawn, bounded as a Text's string is.
4746	*/
4747	text: string;
4748	/**
4749	* The whole block dim, as `Text`'s `dimColor`; absent draws as false.
4750	*/
4751	dimColor?: boolean;
4752	/**
4753	* Which links a press belongs to, by `href` as written; absent, with a
4754	* `press`, every link drawn. Compared with the pressed target only.
4755	*/
4756	pressableLinks?: readonly string[];
4757	};
4758
4759	/**
4760	* The props of `Markdown`, a block of markdown every surface draws as it
4761	* draws an assistant reply's text: its own renderer, links, tables, fences.
4762	*
4763	* A leaf: no children. `text` is the element's data as a `Text`'s string is,
4764	* bounded the same way. With `onLinkPress` the links it draws are the
4765	* plugin's to answer: a press on one raises `ui.press` addressed to `key`.
4766	*/
4767	export type MarkdownProps = {
4768	/**
4769	* The element's address: `e.element` at `ui.press`, what a matcher names.
4770	* Required with `onLinkPress`, since a press needs one; else optional.
4771	*/
4772	key?: string;
4773	/**
4774	* The markdown drawn, as an assistant reply would write it.
4775	*
4776	* At most 10000 characters, tab and newline its only control characters;
4777	* a link whose scheme is not `https:`, `http:` or `file:` draws as text,
4778	* never clickable. Not drawn around the approval dialog.
4779	*/
4780	text: string;
4781	/**
4782	* The whole block dim, as `Text`'s `dimColor`: a thought, an aside.
4783	*/
4784	dimColor?: boolean;
4785	/**
4786	* What a press on a link in `text` runs, in the plugin's own environment:
4787	* the bottom of a `ui.press` chain whose `e.link` names the link.
4788	*
4789	* A press is a plain single click where the surface reports clicks (the
4790	* fullscreen terminal): it opens nothing and lands once no double-click
4791	* followed; a ctrl, alt or terminal-kept cmd click opens it as before.
4792	*/
4793	onLinkPress?: (link: PressedLink, e: UiPressArgument) => void;
4794	/**
4795	* Which links in `text` a press belongs to, by `href` as the markdown
4796	* writes it; absent, every link drawn. Only with `onLinkPress`.
4797	*
4798	* A link left out keeps the surface's own behaviour. At most 256 entries
4799	* of at most 2048 characters; compared with the pressed link's target,
4800	* never opened.
4801	*/
4802	pressableLinks?: readonly string[];
4803	};
4804
4805	/**
4806	* The argument a matched hook receives: `e` narrowed by `M` (Narrowed), per
4807	* event the registration covers.
4808	*/
4809	export type MatchedEvent<P extends Pattern, M> = MatchedNames<P, M> extends infer N extends EventName ? N extends unknown ? Narrowed<Args<N>, M> : never : never;
4810
4811	/**
4812	* The hook `on(pattern, matcher, hook)` takes: `($, e, next)` with `e`
4813	* narrowed by the matcher (MatchedEvent), and a tagged result the same way.
4814	*
4815	* On a streaming event it is the generator form (MatchedStreamHook). `next`
4816	* takes the variants the matcher keeps, as declared (KeptEvent); `next.is`
4817	* names the events the registration covers and narrows as the matcher does.
4818	*/
4819	export type MatchedHook<P extends Pattern, M> = P extends StreamingEventName ? MatchedStreamHook<P, M> : ($: EngineInterface, e: Frozen<MatchedEvent<P, M>>, next: Next<MatchedNames<P, M>, KeptEvent<P, M>, MatchedResult<P, M>, {
4820	[K in MatchedNames<P, M>]: Narrowed<Args<K>, M>;
4821	}>) => MatchedResult<P, M> \| Promise<MatchedResult<P, M>>;
4822
4823	/**
4824	* The events a matched registration on `P` covers: the event named, or for a
4825	* glob every selected event whose input has each key the matcher names.
4826	*/
4827	type MatchedNames<P, M = never> = P extends EventName ? P : {
4828	[N in Selected<P & string>]: [M] extends [never] ? N : keyof M extends AnyKeyOf<Args<N>> ? N : never;
4829	}[Selected<P & string>];
4830
4831	/**
4832	* What a matched hook returns: the event's result, narrowed by `M` where the
4833	* result is a union tagged by the matcher's tag keys.
4834	*/
4835	export type MatchedResult<P extends Pattern, M> = MatchedNames<P, M> extends infer N extends EventName ? N extends unknown ? Select<EventResult<N>, Selection<Args<N>, M>> : never : never;
4836
4837	/**
4838	* The hook `on(event, matcher, hook)` takes on a streaming event: the
4839	* generator form, `e` narrowed by the matcher, `next(e)` the stream beneath.
4840	*/
4841	export type MatchedStreamHook<P extends StreamingEventName, M> = ($: EngineInterface, e: Frozen<MatchedEvent<P, M>>, next: MatchedStreamNext<P, M>) => StreamHookBody<Chunk<P>, MatchedResult<P, M>>;
4842
4843	/**
4844	* What a matched streaming hook's `next.is(pattern, e)` narrows `e` to:
4845	* the streaming event's argument narrowed by the matcher.
4846	*/
4847	type MatchedStreamNarrowings<P extends StreamingEventName, M> = {
4848	[K in P]: Narrowed<Args<K>, M>;
4849	};
4850
4851	/**
4852	* A matched streaming hook's `next`: the variants the matcher keeps, the
4853	* result tagged the same way, `next.is` narrowing as the matcher does.
4854	*/
4855	type MatchedStreamNext<P extends StreamingEventName, M> = StreamNext<P, KeptEvent<P, M>, MatchedResult<P, M>, MatchedStreamNarrowings<P, M>>;
4856
4857	/**
4858	* What `on(event, matcher, hook)` takes for an argument of type `I`: the
4859	* shape of the `e` the hook wants, a partial of it at any depth.
4860	*
4861	* A leaf is `===` or a RegExp (`{ command: /^p4 / }`); an array is any-of;
4862	* an object is a partial of an OBJECT, so `{ command: { startsWith } }` is
4863	* a type error where `e` is typed and free where it is `unknown`.
4864	*/
4865	export type Matcher<I, All = I> = I extends unknown ? {
4866	readonly [K in KnownKeys<I>]?: MatcherValue<I[K], MatcherValueOf<All, K>>;
4867	} & (string extends keyof I ? OpenMatcher<I, All> : unknown) : never;
4868
4869	/**
4870	* Any matcher at all, for a field typed `unknown` (a tool's input, a
4871	* result's output): the kinds the engine accepts, unchecked there.
4872	*
4873	* The four kinds: a scalar is `===`; a RegExp tests the value as a string
4874	* (`{ command: /^p4 / }`); an array matches if any element does; an object
4875	* is a partial of an object. `{ startsWith: 'p4' }` never matches a string.
4876	*/
4877	type MatcherData = string \| number \| boolean \| null \| RegExp \| readonly MatcherData[] \| {
4878	readonly [key: string]: MatcherData;
4879	};
4880
4881	/**
4882	* The declared keys of every variant of `I` (index signatures aside).
4883	*/
4884	type MatcherKeys<I> = I extends unknown ? KnownKeys<I> : never;
4885
4886	/**
4887	* What matches one value of type `V`, by the runtime's kinds:
4888	* a scalar leaf takes the value or a RegExp; an object, a partial of it.
4889	*
4890	* For an array, what matches one ELEMENT of it, since a pattern against an
4891	* array value holds when some element matches; for `unknown`, any matcher.
4892	* A scalar matches by `===`, a RegExp tests the value as a string.
4893	*/
4894	type MatcherOne<V> = unknown extends V ? MatcherData : V extends readonly (infer Item)[] ? MatcherOne<Item> : V extends string \| number \| boolean \| null ? V \| RegExp : V extends object ? Matcher<V> : V extends undefined ? never : unknown;
4895
4896	/**
4897	* What a matcher gives a key whose value is `V` on this variant and `Across`
4898	* over every variant: one MatcherOne, or an array of them matched as one-of.
4899	*
4900	* The one-of is typed over every variant, so `{ tool: ['Bash', 'Read'] }`
4901	* types on the Bash variant; with a nested pattern beside it, the pattern is
4902	* checked against a variant the one-of names, not against each of them.
4903	*/
4904	type MatcherValue<V, Across = V> = MatcherOne<V> \| readonly MatcherOne<Across>[];
4905
4906	/**
4907	* The type of key `K` across the variants of `I` that declare it.
4908	*/
4909	type MatcherValueOf<I, K> = I extends unknown ? K extends KnownKeys<I> ? I[K] : never : never;
4910
4911	/**
4912	* One block of an MCP result: `type` and the fields that kind of block carries.
4913	*/
4914	export type McpContentBlock = {
4915	/**
4916	* The block's kind: `text`, `image`, `audio`, `resource`, `resource_link`.
4917	*/
4918	type: string;
4919	/**
4920	* Set on a `text` block.
4921	*/
4922	text?: string;
4923	/**
4924	* Set on a `resource_link` (or embedded `resource`) block.
4925	*/
4926	uri?: string;
4927	/**
4928	* Declared by an image, audio or resource block.
4929	*/
4930	mimeType?: string;
4931	[field: string]: unknown;
4932	};
4933
4934	/**
4935	* The MCP server serving this tool, for `mcp__*` tools: `name` is the server's config key (for `source: "sdk"`, exactly the name the SDK host registered in `sdkMcpServers` / `mcp_set_servers`; for any other source, the key as authored in that configuration - untrusted text, the same value `mcp_status` and system/init report, to be escaped before display), `source` is where its definition came from - `sdk` (an in-process server the SDK host runs; only the host can register one, so a configured server of the same name never reads `sdk`), `plugin` (a server a plugin ships or registers at runtime), or a config scope (`user`, `project`, `local`, `dynamic` for --mcp-config / `mcp_set_servers` process servers, `managed`, `enterprise`, `claudeai`, `agent`). Key trust on `source`, not on the name or the tool-name prefix. Absent for non-MCP tools.
4936	*/
4937	type McpServerProvenance = {
4938	name: string;
4939	/**
4940	* sdk \| plugin \| user \| project \| local \| dynamic \| managed \| enterprise \| claudeai \| agent - an open set; treat unknown values as an unrecognized configured source, never as sdk.
4941	*/
4942	source: string;
4943	};
4944
4945	/**
4946	* The MCP branch of a `tool.call` hook's `e` (and of `$.tool.call`'s input):
4947	* one variant per declared tool, else the loose McpToolCallInputFallback.
4948	*
4949	* `$.mcp.call(server, tool, args)` takes none of these: its parameters are
4950	* positional, the server and tool by name, then the arguments object.
4951	*/
4952	export type McpToolCallInput = [keyof McpToolInputs] extends [never] ? McpToolCallInputFallback : {
4953	[N in keyof McpToolInputs & string]: ToolInputOf<N, McpToolInputs[N] & Record<string, unknown>>;
4954	}[keyof McpToolInputs & string];
4955
4956	/**
4957	* The `e` a `tool.call` (or `classic.PreToolUse`) hook receives for an MCP
4958	* tool while no MCP tool is declared: every `mcp__*` name, loose arguments.
4959	*
4960	* McpToolInputs has no entries until `/plugin-types` writes the connected
4961	* tools' declarations; also the `input` of `$.tool.call({ tool:
4962	* "mcp__<server>__<tool>", ... })`. Not `$.mcp.call`'s, which is positional:
4963	*
4964	* @example
4965	* on("tool.call", { tool: "mcp__gh__issue" }, ($, e, next) => audit(e.title))
4966	*/
4967	type McpToolCallInputFallback = {
4968	/**
4969	* The name of the tool being called (`mcp__<server>__<tool>`); comparing
4970	* it narrows `e`. Reserved: a rewrite of it is ignored by core.
4971	*/
4972	tool: McpToolName;
4973	/**
4974	* The tool_use block's id: the same at every event of the call and in
4975	* `$.ui.notice`. Reserved: a rewrite of it is ignored by core.
4976	*/
4977	tool_use_id: string;
4978	[argument: string]: unknown;
4979	};
4980
4981	/**
4982	* The inputs of the MCP tools this project knows, keyed by full tool name,
4983	* for declaration merging; empty by default, then every MCP tool is loose.
4984	*
4985	* A `.d.ts` in the plugin author's project (written by `/plugin-types <dir>`
4986	* from the connected servers' JSON Schemas, or by hand) adds entries under
4987	* `declare module "claude-code"`; `e.tool === <name>` then narrows to them.
4988	*
4989	* @example
4990	* interface McpToolInputs { "mcp__my_server__send": { to: string } }
4991	*/
4992	export interface McpToolInputs {
4993	}
4994
4995	/**
4996	* The name of an MCP tool as the engine spells it: `mcp__<server>__<tool>`.
4997	*/
4998	export type McpToolName = `mcp__${string}__${string}`;
4999
5000	/**
5001	* An MCP tools/call result as the SDK returns it, plain data.
5002	*/
5003	export type McpToolResult = {
5004	/**
5005	* The result's content blocks, in order (text, image, resource,
5006	* resource_link, ...).
5007	*/
5008	content: McpContentBlock[];
5009	/**
5010	* True when the server reported the call as failed; the blocks then describe
5011	* the error.
5012	*/
5013	isError: boolean;
5014	/**
5015	* The server's structured result, when its tool declares an output schema.
5016	*/
5017	structuredContent?: unknown;
5018	};
5019
5020	/**
5021	* Hook input for the MessageDisplay event. Fired with each batch of newly completed lines while an assistant message streams. Display-only: the stored message and what the model sees are untouched.
5022	*/
5023	type MessageDisplayHookInput = BaseHookInput & {
5024	hook_event_name: 'MessageDisplay';
5025	/**
5026	* UUID of the current turn.
5027	*/
5028	turn_id: string;
5029	/**
5030	* UUID of the assistant message being displayed. Stable across every flush of the same message. Not the API msg_... id.
5031	*/
5032	message_id: string;
5033	/**
5034	* Zero-based index of this delta within the message. Increments by one per flush.
5035	*/
5036	index: number;
5037	/**
5038	* True on the message's last flush. Exactly one flush per message has it.
5039	*/
5040	final: boolean;
5041	/**
5042	* The newly completed lines since the prior flush. Always whole lines, except on the final flush which may end mid-line. The delta of the final flush is empty when the message ends on a newline; treat final as the end-of-message signal regardless.
5043	*/
5044	delta: string;
5045	};
5046
5047	/**
5048	* What `$.model.complete` takes.
5049	*/
5050	export type ModelCompleteRequest = {
5051	/**
5052	* An alias (`haiku`) or a full model id; resolved and allowlist-checked like
5053	* a `--model` value.
5054	*/
5055	model: string;
5056	/**
5057	* The one user message; the reply's text comes back.
5058	*/
5059	prompt: string;
5060	/**
5061	* Precedes the completion as its system prompt, after the CLI's identity
5062	* block. Default none.
5063	*/
5064	system?: string;
5065	/**
5066	* The reply's token cap: any positive integer up to what one reply can
5067	* hold, the model's own output limit or 64000, whichever is lower.
5068	*
5069	* Default 1024. The reply comes back whole, not streamed, and a provider
5070	* ends such a request at ten minutes, hence the 64000. One past the limit
5071	* is refused, naming it.
5072	*/
5073	maxTokens?: number;
5074	};
5075
5076	/**
5077	* What `$.model.fork` takes.
5078	*/
5079	export type ModelForkRequest = {
5080	/**
5081	* The one user message, appended to the session's own transcript.
5082	*
5083	* The reply's text and usage come back, or null on an API error or a cold
5084	* transcript.
5085	*/
5086	prompt: string;
5087	};
5088
5089	/**
5090	* What `$.model.fork` resolves to when the fork answered: the reply's text
5091	* and what the fork cost.
5092	*/
5093	export type ModelForkResult = {
5094	/**
5095	* The non-error replies' text, joined by newlines.
5096	*/
5097	text: string;
5098	/**
5099	* The fork's token counts, so a plugin can account for what it spent.
5100	*/
5101	usage: ModelForkUsage;
5102	};
5103
5104	/**
5105	* What one fork cost, as the API counted it: the four token counts of the
5106	* fork's completions summed.
5107	*/
5108	export type ModelForkUsage = {
5109	input_tokens: number;
5110	output_tokens: number;
5111	cache_read_input_tokens: number;
5112	cache_creation_input_tokens: number;
5113	};
5114
5115	/**
5116	* The prefixes a glob may name: one or more whole leading segments of an
5117	* event name (`tool` of `tool.call`), derived, plugin nouns included.
5118	*/
5119	export type Namespace<N extends string = EventName> = N extends `${infer Head}.${infer Rest}` ? Head \| `${Head}.${Namespace<Rest>}` : never;
5120
5121	/**
5122	* How many object or array levels a matcher narrows `e` through, counted as
5123	* a tuple's length: the runtime's own limit, which refuses a deeper matcher.
5124	*
5125	* Past it a field keeps its declared type; nothing becomes `any`.
5126	*/
5127	type NarrowDepth = 8;
5128
5129	/**
5130	* `e` in a matched hook: the members of the argument union `E` matcher `P`
5131	* can match, each with the keys `P` names narrowed to what a match implies.
5132	*
5133	* A scalar narrows to the literal, a one-of to what its alternatives give,
5134	* an object key recursively, an array some element of which must match to
5135	* a non-empty tuple; other keys, `unknown` and RegExp-matched fields keep.
5136	*/
5137	export type Narrowed<E, P> = E extends unknown ? NarrowedMember<E, P, []> : never;
5138
5139	/**
5140	* A value of declared type `V` under a one-of, folded over the tuple into
5141	* `Found`: the union of what each alternative narrows `V` to (NarrowedByOne).
5142	*
5143	* An alternative that cannot match adds nothing, so a one-of none of whose
5144	* alternatives can is `never`; a one-of typed as a plain array rather than
5145	* a tuple narrows by the union of its elements at once.
5146	*/
5147	type NarrowedByAny<V, Alternatives extends readonly unknown[], D extends readonly unknown[], Found = never> = Alternatives extends readonly [infer First, ...infer Rest] ? NarrowedByAny<V, Rest, D, Found \| NarrowedByOne<V, First, D>> : Alternatives extends readonly [] ? Found : Found \| NarrowedByOne<V, Alternatives[number], D>;
5148
5149	/**
5150	* A value of declared type `V` under one matcher node `Q` that is not a
5151	* one-of, member of `V` by member; a member that cannot match is `never`.
5152	*
5153	* An array some element of which must match becomes NonEmpty; a RegExp
5154	* keeps the member; an object pattern recurses into an object member, one
5155	* level down; a scalar keeps a member as narrow, and replaces a wider one.
5156	*/
5157	type NarrowedByOne<V, Q, D extends readonly unknown[]> = V extends readonly (infer Item)[] ? [NarrowedValue<Item, Q, [...D, unknown]>] extends [never] ? never : NonEmpty<V, Item> : Q extends RegExp ? V : Q extends object ? V extends object ? NarrowedMember<V, Q, [...D, unknown]> : never : V extends Q ? V : Q extends V ? Q : never;
5158
5159	/**
5160	* One object member `E` under object pattern `P`, `D` levels down: `never`
5161	* when a key of `P` is impossible on it (ImpossibleKeys), else `E` narrowed.
5162	*
5163	* Each key `P` names is narrowed (NarrowedValue); every other key, and each
5164	* key's optionality, stays as declared.
5165	*/
5166	type NarrowedMember<E, P, D extends readonly unknown[]> = [
5167	ImpossibleKeys<E, P, D>
5168	] extends [never] ? {
5169	[K in keyof E]: K extends keyof P ? NarrowedValue<E[K], P[K], D> : E[K];
5170	} : never;
5171
5172	/**
5173	* A value of declared type `V` where the matcher gives `Q`, `D` levels
5174	* down: NarrowedByAny under a one-of (an array), NarrowedByOne otherwise.
5175	*
5176	* As declared once `D` reaches NarrowDepth, or for a field typed `unknown`
5177	* (a tool's input), which no pattern narrows.
5178	*/
5179	type NarrowedValue<V, Q, D extends readonly unknown[]> = D['length'] extends NarrowDepth ? V : unknown extends V ? V : Q extends readonly unknown[] ? NarrowedByAny<V, Q, D> : NarrowedByOne<V, Q, D>;
5180
5181	/**
5182	* `!` before a name or a glob: every event except the ones it selects. `!*`
5183	* would select none, so it is no pattern.
5184	*/
5185	type Negation = `!${Exclude<EventName \| Glob, '*'>}`;
5186
5187	/**
5188	* The rest of the chain, as one hook receives it: made once per dispatch per
5189	* hook, frozen; `next(e)` resolves to the downstream result.
5190	*
5191	* Each call runs the hooks below again; core is the last, and below it `next`
5192	* rejects. Called with no argument it rejects, naming the hook. A hook that
5193	* returns without calling it ends the chain; returning nothing is a failure.
5194	*
5195	* @template S what `next.is(pattern, e)` narrows `e` to, per event: the event's
5196	* argument, or, under a matcher, that argument narrowed by it (MatchedHook)
5197	* @template T the tool `e` names, when it names one: on `tool.call` it types
5198	* the result (NextResultFor); an `e` without `tool` takes the line beneath
5199	*/
5200	export type Next<N extends EventName = EventName, E = Args<N>, O = NextResult<N>, S extends {
5201	[K in N]?: unknown;
5202	} = {
5203	[K in N]: Args<K>;
5204	}> = {
5205	<T extends string>(e: E & ToolNamed<T>): Promise<NextResultFor<N, O, T>>;
5206	(e: E): Promise<O>;
5207	/**
5208	* Continues this dispatch at a tier: `next(e)` with every link between
5209	* this hook's own tier and that one skipped, by tier and narrowing only.
5210	*
5211	* A managed hook's: prepend may name append, builtin or core, append core;
5212	* it never skips a tier with more authority, so no user hook skips the
5213	* org's. A literal on the hook's own `next`; skipped links are traced.
5214	*/
5215	readonly to: {
5216	<T extends string>(e: E & ToolNamed<T>, tier: TargetTier): Promise<NextResultFor<N, O, T>>;
5217	(e: E, tier: TargetTier): Promise<O>;
5218	};
5219	/**
5220	* Aborts when the call this dispatch belongs to is abandoned: the user
5221	* interrupted, a hook above settled first, or this hook ran out of budget.
5222	*
5223	* Anything the hook started (timers, requests) should stop on it. It is an
5224	* AbortSignal of the plugin's own environment, driven by the chain's.
5225	*/
5226	readonly signal: AbortSignal;
5227	/**
5228	* Whether this dispatch's event is selected by `pattern` (a name, a glob,
5229	* a negation), as a type predicate on `e`: `next.is("tool.call", e)`.
5230	*
5231	* Under a matcher the narrowing includes it. `pattern` names events this
5232	* hook covers (PatternOver); a name outside them is a compile error.
5233	*/
5234	readonly is: <M extends PatternOver<N>>(pattern: M, e: unknown) => e is Frozen<S[Extract<N, Selected<M>>]>;
5235	/**
5236	* The name of this dispatch's event, as a value, for a glob hook to log or
5237	* switch on.
5238	*/
5239	readonly event: N;
5240	/**
5241	* Who raised this dispatch: the calling plugin's name and the tier it sits
5242	* in (Origin); the engine reads `{ plugin: "engine", tier: "core" }`.
5243	*
5244	* Set by the host alone, from the environment the call came from (its own
5245	* MessagePort) and that plugin's seat; nothing a plugin writes reaches it.
5246	* Every hook of one dispatch sees the same origin, and `next.to` keeps it.
5247	*
5248	* @example
5249	* return next.origin.tier === "prepend" ? next.to(e, "append") : next(e)
5250	*/
5251	readonly origin: Origin;
5252	/**
5253	* What settled beneath this hook on its latest `next()` call, the one
5254	* started last: an entry per link beneath, nearest first, the engine's last.
5255	*
5256	* Empty before `next` is called; filled even when `next` rejected; a link
5257	* still running joins in place later, nothing listed leaves; it ends short
5258	* of the engine at a link that answered its last call itself. Data, frozen.
5259	*/
5260	readonly trace: readonly TraceEntry<N, E, O>[];
5261	/**
5262	* How much time this hook runs under and how much is left (NextBudget),
5263	* read fresh on each access; HookBudget says what the clock counts.
5264	*
5265	* It stands still while a `next` or `$` call of the hook's is in flight;
5266	* in a `.catch` handler it is the grace, `ms` being `next.error.budget`.
5267	*
5268	* @example
5269	* if (next.budget.remainingMs < 2_000) return next(e) // skip the polish
5270	*/
5271	readonly budget: NextBudget;
5272	};
5273
5274	/**
5275	* The budget the code reading `next.budget` runs under: the whole allowance
5276	* and what is left of it now, plain data read fresh on each access.
5277	*
5278	* In a hook `ms` is HookBudget's `ms`; in a `.catch` handler its `catchMs`
5279	* (equal to `next.error.budget`); on a `next` nothing meters (the engine's
5280	* own, a test's root one) `ms` is 0 and `remainingMs` Infinity.
5281	*
5282	* @example
5283	* if (next.budget.remainingMs < 2_000) return next(e) // skip the slow path
5284	*/
5285	export type NextBudget = {
5286	/**
5287	* The whole budget in milliseconds; 0 where nothing meters this `next`.
5288	*/
5289	readonly ms: number;
5290	/**
5291	* What is left of it now, in milliseconds, never below 0; Infinity where
5292	* nothing meters. It stands still while a `next` or `$` call is in flight.
5293	*/
5294	readonly remainingMs: number;
5295	};
5296
5297	/**
5298	* What `next(e)` resolves to for event `N`: the event's result, except at
5299	* `engine.create`, where the steps beneath return `$` as built so far.
5300	*
5301	* A withheld noun is on that `$` as a stub, so the built table is typed
5302	* whole where what a hook returns (EngineCreateResult) is partial.
5303	*/
5304	export type NextResult<N extends EventName> = N extends 'engine.create' ? EngineInterfaceBuilt : EventResult<N>;
5305
5306	/**
5307	* What `next(e)` resolves to once `e.tool` is the literal `T`: on `tool.call`
5308	* the result typed for that tool; on every other event, `O` as declared.
5309	*
5310	* `result` is Bash's record after `e.tool === "Bash"`; an un-narrowed `e`
5311	* names every tool, and `result` stays `unknown`.
5312	*/
5313	export type NextResultFor<N extends EventName, O, T extends string> = [
5314	N
5315	] extends ['tool.call'] ? ToolCallResult<T> : O;
5316
5317	/**
5318	* The argument of a call on `$` that takes nothing (`$.session.cwd()`): an
5319	* object with no keys.
5320	*/
5321	type NoArgs = Record<never, never>;
5322
5323	/**
5324	* The events whose argument is exactly NoArgs (`session.cwd`, a declared
5325	* plugin noun's `() => ...`); their overloads come last (LateOverload).
5326	*/
5327	type NoArgsEvent = {
5328	[N in EventName]: Args<N> extends NoArgs ? NoArgs extends Args<N> ? N : never : never;
5329	}[EventName];
5330
5331	/**
5332	* What an `engine.create` hook receives as `$`: nothing. Every property
5333	* reads as `never`, so `$.model` inside the hook is a compile error.
5334	*/
5335	export type NoEngineInterface = {
5336	readonly [noun: string]: never;
5337	};
5338
5339	/**
5340	* Array type `V`, of element `Item`, once some element of it is known to
5341	* match: a tuple of at least one `Item`, readonly when `V` is.
5342	*
5343	* So `e` still passes wherever the declared array is taken; a `V` that is
5344	* already a non-empty tuple is kept as it is.
5345	*/
5346	type NonEmpty<V, Item> = V extends readonly [unknown, ...unknown[]] ? V : V extends Item[] ? [Item, ...Item[]] : readonly [Item, ...Item[]];
5347
5348	type NotificationHookInput = BaseHookInput & {
5349	hook_event_name: 'Notification';
5350	message: string;
5351	title?: string;
5352	notification_type: string;
5353	};
5354
5355	/**
5356	* The declared plugin nouns' methods as event rows (NounEventRow), one per
5357	* `<noun>.<method>` that is a function; a member that is not is no event.
5358	*/
5359	type NounEvent = {
5360	[K in PluginNoun]: {
5361	[M in keyof EngineInterface[K] & string]: EngineInterface[K][M] extends (...args: infer Parameters) => infer Result ? NounEventRow<`${K}.${M}`, Parameters extends readonly [] ? NoArgs : Parameters[0], Awaited<Result>> : never;
5362	}[keyof EngineInterface[K] & string];
5363	}[PluginNoun];
5364
5365	/**
5366	* The name of a declared plugin noun's event (`voice.speak`).
5367	*/
5368	type NounEventName = keyof NounEventOf & string;
5369
5370	/**
5371	* The events of the plugin nouns declared on EngineInterface, by name: the
5372	* argument of each `<noun>.<method>`. Empty until a plugin declares a noun.
5373	*
5374	* @example
5375	* declare module "claude-code" { interface EngineInterface { voice: Voice } }
5376	*/
5377	export type NounEventOf = {
5378	[E in NounEvent as E['name']]: E['args'];
5379	};
5380
5381	/**
5382	* The result of a declared plugin noun's event as its hooks see it:
5383	* `{ value }` (the method's answer) or `{ deny }`.
5384	*/
5385	type NounEventResult<N extends NounEventName> = ValueOrDeny<NounValueOf[N]>;
5386
5387	/**
5388	* One method of a declared plugin noun as an event row: its event's name,
5389	* argument (the method's first parameter) and value (its awaited result).
5390	*/
5391	type NounEventRow<Name extends string, Args, Value> = {
5392	name: Name;
5393	args: Args;
5394	value: Value;
5395	};
5396
5397	/**
5398	* What each declared plugin noun's method answers (the `value` of its
5399	* event's result), by event name.
5400	*/
5401	type NounValueOf = {
5402	[E in NounEvent as E['name']]: E['value'];
5403	};
5404
5405	/**
5406	* Registers `hook` on the events `pattern` selects: one by name, every one
5407	* under a namespace (`classic.`), all (``), or all but some (`!tool.*`).
5408	*
5409	* One function stands on every selected event (`next.event` says which),
5410	* under a matcher for the inputs it matches; a plugin's registrations nest
5411	* in order, first outermost; a repeat throws. Returns the Registration.
5412	*
5413	* @see HookBudget the time each hook has per dispatch (its own time: waits
5414	* on `next` and `$` are free), read live from `next.budget`
5415	*/
5416	export type On = {
5417	<P extends Pattern>(pattern: P, hook: NoInfer<HookFor<P>>): Registration<HookFor<P>>;
5418	<P extends Pattern, const M extends Matcher<Args<MatchedNames<P>>>>(pattern: P, matcher: M, hook: NoInfer<MatchedHook<P, M>>): Registration<MatchedHook<P, M>>;
5419	};
5420
5421	/**
5422	* The part of a transcript message the surface that drew it has on screen:
5423	* units `first` to `last` of the message's `of`, counted from its start.
5424	*
5425	* The terminal counts the rows the site laid out, from its first (the blank
5426	* row the engine draws above a message is its row 0; a hook's tree starts at
5427	* its own); other surfaces count in their unit, so compare `first / of` there.
5428	*
5429	* @remarks While `null` the terminal holds the site at the rows it last laid
5430	* out (a scroller's geometry needs real rows); on screen, draw anything.
5431	* @example if (e.props.onScreen) shown.set(e.requestId, e.props.onScreen)
5432	* else shown.delete(e.requestId) // the band's legend lists `shown`
5433	*/
5434	type OnScreen = {
5435	/**
5436	* The unit inside the viewport, from 0: on the terminal, `7` when the
5437	* message's top seven rows are scrolled away.
5438	*/
5439	first: number;
5440	/**
5441	* The unit inside the viewport, inclusive; at least `first`.
5442	*/
5443	last: number;
5444	/**
5445	* The message's whole extent in the same unit, as laid out (a hook's tree
5446	* taller than the engine's counts its own rows); more than `last`.
5447	*
5448	* One surface's numbers say nothing of another's: what the phone shows the
5449	* terminal may not, and each `ui.render` carries its own surface's.
5450	*/
5451	of: number;
5452	};
5453
5454	/**
5455	* The keys a variant with a string index signature (an MCP tool's input)
5456	* takes beyond its own: another variant's key as typed there; others free.
5457	*
5458	* So a misspelt value for a key some variant declares (`command: 5`) is
5459	* refused on every variant, not admitted by the open one.
5460	*/
5461	type OpenMatcher<I, All> = {
5462	readonly [K in Exclude<MatcherKeys<All>, KnownKeys<I>>]?: MatcherValue<MatcherValueOf<All, K>>;
5463	} & Readonly<Record<string, unknown>>;
5464
5465	/**
5466	* The name of a call on `$` the host serves, as an event.
5467	*/
5468	export type OpEventName = keyof OpEventOf;
5469
5470	/**
5471	* The calls on `$` the host serves, as events: `e` is the call's argument as
5472	* it crosses to the host, and every one is hookable by name and by `on("*")`.
5473	*
5474	* A hook above the caller passes it on, rewrites it, refuses it with
5475	* `{ deny }` or answers with `{ value }`; core is the host's implementation.
5476	* The calling hook alone is skipped, and `next.origin` names the caller.
5477	*/
5478	export type OpEventOf = {
5479	/**
5480	* The argument of `$.model.complete(request)`.
5481	*/
5482	'model.complete': ModelCompleteRequest;
5483	/**
5484	* The argument of `$.model.classify(text, labels, options)`.
5485	*/
5486	'model.classify': {
5487	text: string;
5488	labels: readonly string[];
5489	options?: ClassifyOptions;
5490	};
5491	/**
5492	* The argument of `$.model.fork(request)`.
5493	*/
5494	'model.fork': ModelForkRequest;
5495	/**
5496	* The clip and how to play it (`shouldLoop`, `gain`); the signal does not
5497	* cross.
5498	*/
5499	'audio.play': {
5500	clip: AudioClip;
5501	shouldLoop: boolean;
5502	gain?: number;
5503	};
5504	/**
5505	* The argument of `$.audio.speak(text, { voice })`.
5506	*/
5507	'audio.speak': SpeakRequest;
5508	/**
5509	* The argument of `$.mcp.call(server, tool, args)`.
5510	*/
5511	'mcp.call': {
5512	server: string;
5513	tool: string;
5514	args: Record<string, unknown>;
5515	};
5516	/**
5517	* The argument of `$.session.cwd()`.
5518	*/
5519	'session.cwd': NoArgs;
5520	/**
5521	* The argument of `$.session.root()`.
5522	*/
5523	'session.root': NoArgs;
5524	/**
5525	* The argument of `$.session.model()`.
5526	*/
5527	'session.model': NoArgs;
5528	/**
5529	* The argument of `$.session.turns()`.
5530	*/
5531	'session.turns': NoArgs;
5532	/**
5533	* The argument of `$.session.id()`.
5534	*/
5535	'session.id': NoArgs;
5536	/**
5537	* The argument of `$.session.messages()`.
5538	*/
5539	'session.messages': NoArgs;
5540	/**
5541	* The argument of `$.session.repo()`.
5542	*/
5543	'session.repo': NoArgs;
5544	/**
5545	* The argument of `$.session.surface()`.
5546	*
5547	* @deprecated with `$.session.surface()`; hook `session.surfaces`
5548	*/
5549	'session.surface': NoArgs;
5550	/**
5551	* The argument of `$.session.surfaces()`.
5552	*/
5553	'session.surfaces': NoArgs;
5554	/**
5555	* The argument of `$.session.authorize()`.
5556	*/
5557	'session.authorize': NoArgs;
5558	/**
5559	* The argument of `$.session.usage({ breakdown, columns })`.
5560	*/
5561	'session.usage': SessionUsageArgs;
5562	/**
5563	* The argument of `$.session.version()`.
5564	*/
5565	'session.version': NoArgs;
5566	/**
5567	* The argument of `$.turn.abort({ turnId })`.
5568	*/
5569	'turn.abort': {
5570	turnId: string;
5571	};
5572	/**
5573	* The argument of `$.prompt.read()`.
5574	*/
5575	'prompt.read': NoArgs;
5576	/**
5577	* The argument of `$.tool.list()`.
5578	*/
5579	'tool.list': NoArgs;
5580	/**
5581	* The argument of `$.tool.register(spec)`.
5582	*/
5583	'tool.register': Required<ToolSpec>;
5584	/**
5585	* The argument of `$.command.list()`.
5586	*/
5587	'command.list': NoArgs;
5588	/**
5589	* The argument of `$.command.register(spec)`.
5590	*/
5591	'command.register': CommandSpec;
5592	/**
5593	* The argument of `$.config.list()`.
5594	*/
5595	'config.list': NoArgs;
5596	/**
5597	* The argument of `$.agent.list()`.
5598	*/
5599	'agent.list': NoArgs;
5600	/**
5601	* The argument of `$.agent.register(spec)`: the agent type as the plugin
5602	* defined it. A hook above rewrites any of it; the type stays the caller's.
5603	*/
5604	'agent.register': AgentSpec;
5605	/**
5606	* The argument of `$.ui.toast(text, { timeoutMs })`.
5607	*/
5608	'ui.toast': {
5609	text: string;
5610	timeoutMs?: number;
5611	};
5612	/**
5613	* The argument of `$.ui.status(text)`; `text` undefined clears the line.
5614	*/
5615	'ui.status': {
5616	text: string \| undefined;
5617	};
5618	/**
5619	* The argument of `$.ui.log(text, { to })`; `to` is always present
5620	* (UiLogSink), and `next({ ...e, to: "debug" })` keeps a line off screen.
5621	*/
5622	'ui.log': {
5623	text: string;
5624	to: UiLogSink;
5625	};
5626	/**
5627	* The argument of `$.ui.notice(tool_use_id, text)`.
5628	*/
5629	'ui.notice': {
5630	tool_use_id: string;
5631	text: string \| undefined;
5632	};
5633	/**
5634	* The argument of `$.ui.invalidate(event)`.
5635	*/
5636	'ui.invalidate': {
5637	event: InvalidatableEventName;
5638	};
5639	/**
5640	* The argument of `$.ui.open({ id, title, focus })`; a hook above the
5641	* opener may retitle it or refuse it with `{ deny }`, never rename it.
5642	*/
5643	'ui.open': PaneOpenArgs;
5644	/**
5645	* The argument of `$.ui.close({ id })` with `origin` `plugin`; the engine
5646	* raises it too, for the person (`person`) and an unload (`unload`).
5647	*/
5648	'ui.close': PaneCloseInput;
5649	/**
5650	* The argument of `$.ui.panes()`.
5651	*/
5652	'ui.panes': NoArgs;
5653	/**
5654	* The argument of `$.ui.blit(...)`: a Raster's `cells` or a keyed Image's
5655	* `source`; a hook above may rewrite either with `next`, or `{ deny }`.
5656	*/
5657	'ui.blit': UiBlitArgs;
5658	/**
5659	* The argument of `$.fs.read(path, { as })`: `as` is `text` unless the
5660	* caller asked for `bytes`.
5661	*/
5662	'fs.read': {
5663	path: string;
5664	as: FsReadAs;
5665	};
5666	/**
5667	* The argument of `$.fs.write(path, text)`.
5668	*/
5669	'fs.write': {
5670	path: string;
5671	text: string;
5672	};
5673	/**
5674	* The argument of `$.fs.list(path)`.
5675	*/
5676	'fs.list': {
5677	path: string;
5678	};
5679	/**
5680	* The argument of `$.fs.exists(path)`.
5681	*/
5682	'fs.exists': {
5683	path: string;
5684	};
5685	/**
5686	* The argument of `$.fs.stat(path, { resolve })`: `resolve` is false
5687	* unless the caller asked where the path lands.
5688	*/
5689	'fs.stat': {
5690	path: string;
5691	resolve: boolean;
5692	};
5693	/**
5694	* The argument of `$.fs.ancestors({ names, of, below })`.
5695	*/
5696	'fs.ancestors': FsAncestorsRequest;
5697	/**
5698	* The argument of `$.store.get(key)`.
5699	*/
5700	'store.get': {
5701	key: string;
5702	};
5703	/**
5704	* The argument of `$.store.set(key, value)`.
5705	*/
5706	'store.set': {
5707	key: string;
5708	value: unknown;
5709	};
5710	/**
5711	* The argument of `$.store.delete(key)`.
5712	*/
5713	'store.delete': {
5714	key: string;
5715	};
5716	/**
5717	* The argument of `$.store.keys()`.
5718	*/
5719	'store.keys': NoArgs;
5720	/**
5721	* The argument of `$.clock.now()`.
5722	*/
5723	'clock.now': NoArgs;
5724	/**
5725	* The argument of `$.clock.sleep(ms, { signal })`; the signal does not
5726	* cross, it aborts the dispatch.
5727	*/
5728	'clock.sleep': ClockWait;
5729	/**
5730	* The argument of `$.clock.after(ms, fn)`: the wait before `fn`, which
5731	* stays in the plugin's environment and runs once the dispatch resolves.
5732	*/
5733	'clock.after': ClockWait;
5734	/**
5735	* The argument of `$.clock.every(ms, fn)`, dispatched once per period:
5736	* `fn` runs each time a dispatch resolves, and the next period is asked.
5737	*/
5738	'clock.every': ClockWait;
5739	/**
5740	* The argument of `$.http.fetch(url, init)`.
5741	*/
5742	'http.fetch': {
5743	url: string;
5744	init?: HttpInit;
5745	};
5746	/**
5747	* The argument of `$.process.run(argv, init)`.
5748	*/
5749	'process.run': {
5750	argv: readonly string[];
5751	init?: ProcessRunInit;
5752	};
5753	/**
5754	* The argument of `$.settings.read({ source })`.
5755	*/
5756	'settings.read': SettingsReadArgs;
5757	/**
5758	* The argument of `$.env.get(name)`; `name` is identity, pinned.
5759	*/
5760	'env.get': {
5761	name: string;
5762	};
5763	/**
5764	* The argument of `$.env.set(name, value)`; `name` is identity, pinned,
5765	* and no `value` unsets.
5766	*/
5767	'env.set': {
5768	name: string;
5769	value?: string;
5770	};
5771	};
5772
5773	/**
5774	* The result of a call on `$` as its event's hooks see it: `{ value }` (the
5775	* call's answer) or `{ deny }`.
5776	*/
5777	export type OpEventResult<N extends OpEventName = OpEventName> = ValueOrDeny<OpValueOf[N]>;
5778
5779	/**
5780	* What each call on `$` answers (the `value` of its event's result), by event
5781	* name.
5782	*/
5783	export type OpValueOf = {
5784	'model.complete': string;
5785	'model.classify': string \| undefined;
5786	'model.fork': ModelForkResult \| null;
5787	'audio.play': void;
5788	'audio.speak': SpeakResult;
5789	'mcp.call': McpToolResult;
5790	'session.cwd': string;
5791	'session.root': string;
5792	'session.model': string;
5793	'session.turns': number;
5794	'session.id': string;
5795	'session.messages': SessionMessage[];
5796	'session.repo': SessionRepo \| null;
5797	'session.surface': RenderSurface \| null;
5798	'session.surfaces': readonly RenderSurface[];
5799	/**
5800	* The credential handle, or null where the build or the provider has no
5801	* first-party credential to hold.
5802	*/
5803	'session.authorize': SessionAuthorization;
5804	'session.usage': SessionUsage;
5805	/**
5806	* The engine's version, its release, and its build time when stamped.
5807	*/
5808	'session.version': SessionVersion;
5809	'turn.abort': void;
5810	/**
5811	* The box as it stands; the empty box where the session draws none.
5812	*/
5813	'prompt.read': PromptBox;
5814	'tool.list': ToolInfo[];
5815	'tool.register': {
5816	tool: string;
5817	};
5818	'command.list': CommandInfo[];
5819	'command.register': {
5820	command: string;
5821	};
5822	'config.list': ConfigRow[];
5823	'agent.list': AgentInfo[];
5824	'agent.register': {
5825	agent: string;
5826	};
5827	'ui.toast': void;
5828	'ui.status': void;
5829	'ui.log': void;
5830	'ui.notice': void;
5831	'ui.invalidate': void;
5832	'ui.open': void;
5833	'ui.close': void;
5834	/**
5835	* The calling plugin's open panes, placed then unplaced, in open order.
5836	*/
5837	'ui.panes': readonly UiPane[];
5838	'ui.blit': UiBlitResult;
5839	/**
5840	* The text; `{ base64 }` when asked for bytes.
5841	*/
5842	'fs.read': string \| FsBytes;
5843	'fs.write': void;
5844	'fs.list': FsEntry[];
5845	'fs.exists': boolean;
5846	'fs.stat': FsStat;
5847	'fs.ancestors': readonly FsAncestor[];
5848	'store.get': unknown;
5849	'store.set': void;
5850	'store.delete': void;
5851	'store.keys': string[];
5852	/**
5853	* Milliseconds since the epoch.
5854	*/
5855	'clock.now': number;
5856	'clock.sleep': void;
5857	'clock.after': void;
5858	'clock.every': void;
5859	'http.fetch': HttpResponse;
5860	'process.run': ProcessRunResult;
5861	'settings.read': Settings;
5862	'env.get': string \| undefined;
5863	'env.set': void;
5864	};
5865
5866	/**
5867	* One call signature per event in `Names`, intersected, the ambiguous ones
5868	* (LateOverload) after the rest: `next` for a hook covering several events.
5869	*
5870	* An empty group contributes nothing (Overloads<never> is unknown).
5871	*/
5872	type OrderedOverloads<Names extends EventName> = Overloads<Exclude<Names, LateOverload>> & Overloads<Extract<Names, 'classic.PreToolUse'>> & Overloads<Extract<Names, 'turn.abort'>> & Overloads<Extract<Names, NoArgsEvent>>;
5873
5874	/**
5875	* Who raised a dispatch, as `next.origin` holds it: the calling plugin's
5876	* name and the tier it sits in; the engine reads `engine` in `core`.
5877	*
5878	* The same pair a `next.trace` entry names its link by, and an event's
5879	* `provider` its subject's definer by. Set by the host from where the call
5880	* came from and where that plugin was seated; nothing a plugin writes.
5881	*/
5882	export type Origin = {
5883	/**
5884	* Whose hook made the `$` call, by name; `"engine"` for a call site,
5885	* `"client"` for a `Client` surface module's `ui.message` post.
5886	*/
5887	readonly plugin: string;
5888	/**
5889	* Where that plugin sits among the chain's tiers (Tier); `"core"` for the
5890	* engine, the owning plugin's for a `client` post.
5891	*/
5892	readonly tier: Tier;
5893	};
5894
5895	/**
5896	* One call signature per event in `Names`, intersected into an overload set.
5897	*/
5898	type Overloads<Names extends EventName> = UnionToIntersection<{
5899	[N in Names]: (e: Args<N>) => Promise<NextResult<N>>;
5900	}[Names]>;
5901
5902	/**
5903	* The argument of `$.ui.close`: the pane to close (`{ id }`). `origin` is
5904	* the engine's to set: a plugin's call reads `plugin` at the hooks.
5905	*/
5906	export type PaneCloseArgs = Omit<PaneCloseInput, 'origin'>;
5907
5908	/**
5909	* The input of `ui.close`: the pane closing and why (PaneCloseOrigin).
5910	* Closing an id that is not open does nothing.
5911	*/
5912	export type PaneCloseInput = {
5913	/**
5914	* What `$.ui.open` named the pane; pinned: `next(e)` passes it on.
5915	*/
5916	id: string;
5917	/**
5918	* Who closes it, set by the engine: a hook that answers without `next`
5919	* keeps the pane open on `plugin` and `person`, never on `unload`.
5920	*/
5921	origin: PaneCloseOrigin;
5922	};
5923
5924	/**
5925	* Why a pane closes, as the engine stamped it at `ui.close`.
5926	*
5927	* `unload` drops a pane nothing draws any more (its plugin unloaded, or its
5928	* drawing threw): it is gone before the hooks hear of it, and its opener's
5929	* hooks do not run. `next(e)` passes the origin on as received; none sets it.
5930	*/
5931	export type PaneCloseOrigin = {
5932	/**
5933	* `plugin`, a plugin's `$.ui.close`; `person`, the person's close mark or
5934	* close key; `unload`, the engine's own.
5935	*/
5936	kind: 'plugin' \| 'person' \| 'unload';
5937	};
5938
5939	/**
5940	* The argument of `$.ui.open`: which pane, its title, whether it asks the
5941	* person's keyboard, its dialog manners, its size: rows inline, columns docked.
5942	*
5943	* An open answering the person's input (a command or prompt they entered, a
5944	* press) is placed at any width; one the plugin makes on its own waits
5945	* undrawn below 144 terminal columns, 110 once they asked for that id.
5946	*/
5947	export type PaneOpenArgs = {
5948	/**
5949	* Names the pane: 1-64 of letters, digits, `_` and `-`. One pane per id:
5950	* opening an open id delivers the new title, never a second instance.
5951	*
5952	* Pinned at the hooks: `next(e)` passes it on; the title and focus rewrite.
5953	*/
5954	id: string;
5955	/**
5956	* The pane's tab while more than one pane is open (with one, no title is
5957	* drawn), and the `title` its hook sees; the id when omitted.
5958	*
5959	* An unpaired surrogate half (a `.slice()` through an emoji) is drawn as
5960	* U+FFFD; a control character is refused.
5961	*/
5962	title?: string;
5963	/**
5964	* A request, not a grant: the surface focuses (and raises) the pane only
5965	* while the prompt has the keys over an empty composer.
5966	*
5967	* An element of the band or a pane the person holds, text in the
5968	* composer, a dialog or a survey each refuse it: the pane opens without
5969	* the keyboard.
5970	*/
5971	focus?: true;
5972	/**
5973	* While the pane holds the keyboard, the key that hands it back (Escape)
5974	* also closes it as the person's close does: `ui.close`, origin `person`.
5975	*
5976	* So does Escape at an idle, empty prompt once the prompt has the keys
5977	* again (the person typed, or `focus` was refused); over text, a running
5978	* turn, a dialog, a footer selection, a viewed agent's transcript or a
5979	* prompt mode of its own the key stays theirs.
5980	*
5981	* A hook may refuse that close and keep it open. Left out, Escape returns
5982	* the keys to the prompt and the pane stays. Each open sets it anew, as it
5983	* sets the title.
5984	*/
5985	closeOnEscape?: true;
5986	/**
5987	* While the pane is on screen the surface holds its transient toasts (the
5988	* notification line under the prompt) and shows them once it closes.
5989	*
5990	* As it does behind the engine's own side panel; pinned warnings still
5991	* show. Left out, toasts show as they come. Each open sets it anew.
5992	*/
5993	holdToasts?: true;
5994	/**
5995	* The body rows the pane's content wants while seated inline above the
5996	* prompt: it opens that tall, up to what the layout spares, not a third.
5997	*
5998	* A request, not a grant: a size the person dragged or keyed the block
5999	* to wins, this session's or a kept one, and the dock ignores it. A
6000	* positive whole number; left out, a third. Each open sets it anew.
6001	*/
6002	rows?: number;
6003	/**
6004	* The body columns the pane's content wants while docked beside a
6005	* fullscreen transcript: the dock opens that wide, floor to ceiling.
6006	*
6007	* A request, not a grant: a width the person dragged or keyed the dock
6008	* to wins, this session's or a kept one, and the inline block ignores
6009	* it. A positive whole number; left out, the share. Each open sets it anew.
6010	*
6011	* @example
6012	* await $.ui.open({ id: "browser", focus: true, rows: 24, columns: 100 })
6013	*/
6014	columns?: number;
6015	};
6016
6017	/**
6018	* What `on(pattern, hook)` and `next.is(pattern, e)` take: an event's name,
6019	* a glob (``, `classic.`), or a negation of either (`!tool.describe`).
6020	*/
6021	export type Pattern = EventName \| Glob \| Negation;
6022
6023	/**
6024	* The patterns `next.is` takes in a hook covering the events `N`: their
6025	* names, `*`, a glob over one of their namespaces, or a negation.
6026	*
6027	* A name none of them has is a compile error, as is a glob over a namespace
6028	* none is under; a negation that selects none of them narrows `e` to never.
6029	*/
6030	type PatternOver<N extends EventName> = N \| '' \| `${Namespace<N>}.` \| Negation;
6031
6032	type PermissionBehavior = 'allow' \| 'deny' \| 'ask';
6033
6034	type PermissionDeniedHookInput = BaseHookInput & {
6035	hook_event_name: 'PermissionDenied';
6036	tool_name: string;
6037	tool_input: unknown;
6038	tool_use_id: string;
6039	reason: string;
6040	mcp_server?: McpServerProvenance;
6041	};
6042
6043	/**
6044	* Permission mode for controlling how tool executions are handled. 'default' - Standard behavior, prompts for dangerous operations. 'acceptEdits' - Auto-accept file edit operations. 'bypassPermissions' - Bypass all permission checks (requires allowDangerouslySkipPermissions). 'plan' - Planning mode, no actual tool execution. 'dontAsk' - Don't prompt for permissions, deny if not pre-approved. 'auto' - Use a model classifier to approve/deny permission prompts.
6045	*/
6046	type PermissionMode = 'default' \| 'acceptEdits' \| 'bypassPermissions' \| 'plan' \| 'dontAsk' \| 'auto';
6047
6048	/**
6049	* A `classic.PermissionRequest` answer's `decision`, as the classic hook's
6050	* `hookSpecificOutput.decision`: allow (with a rewrite or rules) or deny.
6051	*/
6052	export type PermissionRequestDecision = {
6053	behavior: 'allow';
6054	updatedInput?: Record<string, unknown>;
6055	updatedPermissions?: PermissionUpdates;
6056	} \| {
6057	behavior: 'deny';
6058	message?: string;
6059	interrupt?: true;
6060	};
6061
6062	type PermissionRequestHookInput = BaseHookInput & {
6063	hook_event_name: 'PermissionRequest';
6064	tool_name: string;
6065	tool_input: unknown;
6066	permission_suggestions?: PermissionUpdate[];
6067	mcp_server?: McpServerProvenance;
6068	};
6069
6070	type PermissionRuleValue = {
6071	toolName: string;
6072	ruleContent?: string;
6073	};
6074
6075	type PermissionUpdate = {
6076	type: 'addRules';
6077	rules: PermissionRuleValue[];
6078	behavior: PermissionBehavior;
6079	destination: PermissionUpdateDestination;
6080	} \| {
6081	type: 'replaceRules';
6082	rules: PermissionRuleValue[];
6083	behavior: PermissionBehavior;
6084	destination: PermissionUpdateDestination;
6085	} \| {
6086	type: 'removeRules';
6087	rules: PermissionRuleValue[];
6088	behavior: PermissionBehavior;
6089	destination: PermissionUpdateDestination;
6090	} \| {
6091	type: 'setMode';
6092	mode: PermissionMode;
6093	destination: PermissionUpdateDestination;
6094	} \| {
6095	type: 'addDirectories';
6096	directories: string[];
6097	destination: PermissionUpdateDestination;
6098	} \| {
6099	type: 'removeDirectories';
6100	directories: string[];
6101	destination: PermissionUpdateDestination;
6102	};
6103
6104	type PermissionUpdateDestination = 'userSettings' \| 'projectSettings' \| 'localSettings' \| 'session' \| 'cliArg';
6105
6106	/**
6107	* The permission rules a PermissionRequest allow may add: the shape of the
6108	* request's own `permission_suggestions` (the SDK's PermissionUpdate list).
6109	*/
6110	type PermissionUpdates = NonNullable<ClassicHookInputs['PermissionRequest']['permission_suggestions']>;
6111
6112	/**
6113	* How `$.audio.play` plays a clip: looped until `signal` aborts, or once.
6114	*
6115	* A loop needs the signal that ends it; a single play takes one as an option.
6116	*/
6117	export type PlayOptions = {
6118	/**
6119	* Repeat the clip until `signal` aborts (the promise then resolves).
6120	*/
6121	shouldLoop: true;
6122	/**
6123	* Linear gain, from 0 to 4; default 1.
6124	*/
6125	gain?: number;
6126	/**
6127	* Stops the clip: playback ends at once and the promise resolves.
6128	*/
6129	signal: AbortSignal;
6130	} \| {
6131	/**
6132	* Play once.
6133	*/
6134	shouldLoop?: false;
6135	/**
6136	* Linear gain, from 0 to 4; default 1.
6137	*/
6138	gain?: number;
6139	/**
6140	* Stops the clip early, as above.
6141	*/
6142	signal?: AbortSignal;
6143	};
6144
6145	/**
6146	* The nouns a plugin declared on `$` by merging into EngineInterface; never
6147	* one the engine's own events are under (`tool`, `session`, `ui`).
6148	*/
6149	type PluginNoun = Exclude<keyof EngineInterface & string, keyof CoreEngineInterface \| Namespace<CoreEventName>>;
6150
6151	/**
6152	* A plugin's options as `register(on, options)` receives them: the values of
6153	* the fields its manifest's `userConfig` declares, defaults filled in.
6154	*
6155	* Stored in settings.json `pluginConfigs[<plugin>].options` (sensitive ones
6156	* in secure storage), validated against the declared `type` before the module
6157	* loads; a required field with no value fails the load, naming the field. A
6158	* string field that declares `options` holds one of them: `/config` draws it
6159	* as a picker over them, and a stored value outside them counts as unset, so
6160	* its default applies. A `--plugin-dir` plugin's key is its plugin.json
6161	* `<name>` (or `<name>@inline`).
6162	*/
6163	export type PluginOptions = Readonly<Record<string, string \| number \| boolean \| readonly string[]>>;
6164
6165	/**
6166	* The input of `plugin.register`: one hooks module the engine is about to
6167	* load, read off its manifest and its scanned source. Every field is pinned.
6168	*
6169	* `tier` and `uses` are the host's reading of the module, what a gate holds
6170	* it to; `name`, `root`, `version` and `provenance` are its own word (its
6171	* manifest, its place), so a rule keyed on them is one a rename walks past.
6172	*/
6173	export type PluginRegisterInput = {
6174	/**
6175	* The plugin's name, as its own plugin.json declares it.
6176	*/
6177	name: string;
6178	/**
6179	* Where its hooks would stand among the chain's tiers (Tier); never
6180	* `core`, the engine's own.
6181	*/
6182	tier: Exclude<Tier, 'core'>;
6183	/**
6184	* The plugin's directory (the one holding plugin.json), absolute.
6185	*/
6186	root: string;
6187	/**
6188	* Its manifest's `version`, when it states one.
6189	*/
6190	version?: string;
6191	/**
6192	* Where the plugin came from, as the loader keys it: `<name>@<marketplace>`
6193	* installed, `<name>@inline` by `--plugin-dir`, `<name>@builtin` bundled.
6194	*/
6195	provenance: string;
6196	/**
6197	* What the module hooks and calls, as scanned (PluginRegisterUses).
6198	*/
6199	uses: PluginRegisterUses;
6200	};
6201
6202	/**
6203	* What a `plugin.register` hook returns and what `next(e)` resolves to:
6204	* `{ allow: true }` from core, or `{ refuse: reason }`.
6205	*/
6206	export type PluginRegisterResult = {
6207	/**
6208	* The module loads: its `engine.create` step runs and its hooks join.
6209	*/
6210	allow: true;
6211	refuse?: undefined;
6212	} \| {
6213	/**
6214	* The module does not load: no step, no hooks, no tools or commands;
6215	* the transcript names the plugin that refused and this reason.
6216	*/
6217	refuse: string;
6218	allow?: undefined;
6219	};
6220
6221	/**
6222	* What a hooks module uses, as the host scanned its source before loading it:
6223	* the same lists `claude plugin validate` prints and the host's rule reads.
6224	*
6225	* Exact, since a module that spells `on`, `$` or `$.env` other than literally
6226	* does not load.
6227	*/
6228	export type PluginRegisterUses = {
6229	/**
6230	* The patterns its `on(...)` registrations name, as written (`tool.call`,
6231	* ``, `classic.`, `!tool.describe`), in registration order, each once.
6232	*/
6233	events: readonly string[];
6234	/**
6235	* What it calls on `$`, spelled `noun.method` (`fs.write`, `http.fetch`),
6236	* sorted, each once.
6237	*/
6238	calls: readonly string[];
6239	/**
6240	* The environment variables its `$.env.get` and `$.env.set` calls name;
6241	* absent when it calls neither.
6242	*/
6243	env?: {
6244	/**
6245	* The names its `$.env.get` calls spell, sorted, each once.
6246	*/
6247	reads: readonly string[];
6248	/**
6249	* The names its `$.env.set` calls spell, sorted, each once.
6250	*/
6251	writes: readonly string[];
6252	};
6253	};
6254
6255	/**
6256	* Whose element: the plugin whose hook drew it, stamped by the runtime as the
6257	* tree leaves it; a Box's or Text's `group`, a Client's or Raster's own.
6258	*
6259	* A Button's `press` names its plugin the same way, beside its handle. Two
6260	* plugins under one `hover.scope` string never share a group.
6261	*/
6262	type PluginStamp = {
6263	plugin: string;
6264	};
6265
6266	type PostCompactHookInput = BaseHookInput & {
6267	hook_event_name: 'PostCompact';
6268	trigger: 'manual' \| 'auto';
6269	/**
6270	* The conversation summary produced by compaction
6271	*/
6272	compact_summary: string;
6273	};
6274
6275	type PostModelSwitchHookInput = (BaseHookInput & {
6276	hook_event_name: 'PostModelSwitch';
6277	}) & {
6278	/**
6279	* Resolved model id the session was running before the switch
6280	*/
6281	from_model: string;
6282	/**
6283	* Resolved model id the session runs after the switch
6284	*/
6285	to_model: string;
6286	/**
6287	* What was asked for (alias such as "opus", a full id, or null for "default")
6288	*/
6289	requested_model: string \| null;
6290	/**
6291	* command: /model <name>, the /config Model row, or enabling fast mode when that promotes the model; picker: an interactive model picker; sdk: headless set_model (SDK, Remote Control, IDE); auto: automatic fallback or other programmatic change; resume: model restored while resuming a session
6292	*/
6293	source: 'command' \| 'picker' \| 'sdk' \| 'auto' \| 'resume';
6294	/**
6295	* Prompt tokens the next request re-sends: the last main-thread response's input + cache_read + cache_creation + output tokens (0 before the first response; for a server-side tool loop, its last iteration's window, not the summed totals)
6296	*/
6297	context_tokens: number;
6298	/**
6299	* Whether the current model's prompt cache is likely still warm (a switch then forfeits it)
6300	*/
6301	prompt_cache_warm: boolean;
6302	cache_ttl: '5m' \| '1h';
6303	/**
6304	* Estimated cost of re-caching context_tokens on to_model at its cache-write rate - the managed modelPricing when set, otherwise list price; excludes the response
6305	*/
6306	estimated_cache_write_usd: number;
6307	/**
6308	* configured: priced at the managed modelPricing setting; catalog: list price; default: to_model unknown, the default tier was assumed
6309	*/
6310	pricing: 'configured' \| 'catalog' \| 'default';
6311	};
6312
6313	/**
6314	* Hook input for the PostToolBatch event. Fired once after every tool call in a batch has resolved, before the next model request. PostToolUse fires per-tool and may run concurrently for parallel tool calls; PostToolBatch fires exactly once with the full batch.
6315	*/
6316	type PostToolBatchHookInput = BaseHookInput & {
6317	hook_event_name: 'PostToolBatch';
6318	tool_calls: PostToolBatchToolCall[];
6319	};
6320
6321	type PostToolBatchToolCall = {
6322	tool_name: string;
6323	tool_input: unknown;
6324	tool_use_id: string;
6325	tool_response?: unknown;
6326	};
6327
6328	type PostToolUseFailureHookInput = BaseHookInput & {
6329	hook_event_name: 'PostToolUseFailure';
6330	tool_name: string;
6331	tool_input: unknown;
6332	tool_use_id: string;
6333	error: string;
6334	is_interrupt?: boolean;
6335	/**
6336	* Tool execution time in milliseconds. Excludes permission-prompt and hook time.
6337	*/
6338	duration_ms?: number;
6339	mcp_server?: McpServerProvenance;
6340	};
6341
6342	type PostToolUseHookInput = BaseHookInput & {
6343	hook_event_name: 'PostToolUse';
6344	tool_name: string;
6345	tool_input: unknown;
6346	tool_response: unknown;
6347	tool_use_id: string;
6348	/**
6349	* Tool execution time in milliseconds. Excludes permission-prompt and hook time.
6350	*/
6351	duration_ms?: number;
6352	mcp_server?: McpServerProvenance;
6353	};
6354
6355	type PreCompactHookInput = BaseHookInput & {
6356	hook_event_name: 'PreCompact';
6357	trigger: 'manual' \| 'auto';
6358	custom_instructions: string \| null;
6359	};
6360
6361	type PreModelSwitchHookInput = (BaseHookInput & {
6362	hook_event_name: 'PreModelSwitch';
6363	}) & {
6364	/**
6365	* Resolved model id the session was running before the switch
6366	*/
6367	from_model: string;
6368	/**
6369	* Resolved model id the session runs after the switch
6370	*/
6371	to_model: string;
6372	/**
6373	* What was asked for (alias such as "opus", a full id, or null for "default")
6374	*/
6375	requested_model: string \| null;
6376	/**
6377	* command: /model <name>, the /config Model row, or enabling fast mode when that promotes the model; picker: an interactive model picker; sdk: headless set_model (SDK, Remote Control, IDE)
6378	*/
6379	source: 'command' \| 'picker' \| 'sdk';
6380	/**
6381	* Prompt tokens the next request re-sends: the last main-thread response's input + cache_read + cache_creation + output tokens (0 before the first response; for a server-side tool loop, its last iteration's window, not the summed totals)
6382	*/
6383	context_tokens: number;
6384	/**
6385	* Whether the current model's prompt cache is likely still warm (a switch then forfeits it)
6386	*/
6387	prompt_cache_warm: boolean;
6388	cache_ttl: '5m' \| '1h';
6389	/**
6390	* Estimated cost of re-caching context_tokens on to_model at its cache-write rate - the managed modelPricing when set, otherwise list price; excludes the response
6391	*/
6392	estimated_cache_write_usd: number;
6393	/**
6394	* configured: priced at the managed modelPricing setting; catalog: list price; default: to_model unknown, the default tier was assumed
6395	*/
6396	pricing: 'configured' \| 'catalog' \| 'default';
6397	};
6398
6399	/**
6400	* The link a press landed on: one a `Markdown` drew, pressed where the
6401	* surface reports presses (a plain click in the fullscreen terminal).
6402	*
6403	* What the surface knows of the cell pressed, not which occurrence: two
6404	* links written with one target read the same here.
6405	*/
6406	export type PressedLink = {
6407	/**
6408	* The link's target as the surface drew it: for an `https:` link, the
6409	* href as the markdown wrote it.
6410	*/
6411	href: string;
6412	};
6413
6414	/**
6415	* The decision of a `classic.PreToolUse` result: `allow`, `ask`, `deny`, or
6416	* none.
6417	*/
6418	export type PreToolUseDecision = {
6419	/**
6420	* Lets the call run without a permission prompt (the managed-settings
6421	* hooks ran first; a deny from them ended the chain above).
6422	*/
6423	allow: true;
6424	ask?: undefined;
6425	deny?: undefined;
6426	} \| {
6427	/**
6428	* Asks the user before the call runs; the text is shown as the reason.
6429	*/
6430	ask: string;
6431	allow?: undefined;
6432	deny?: undefined;
6433	} \| {
6434	/**
6435	* Refuses the call; the model receives the text as the reason.
6436	*/
6437	deny: string;
6438	allow?: undefined;
6439	ask?: undefined;
6440	} \| {
6441	allow?: undefined;
6442	ask?: undefined;
6443	deny?: undefined;
6444	};
6445
6446	type PreToolUseHookInput = BaseHookInput & {
6447	hook_event_name: 'PreToolUse';
6448	tool_name: string;
6449	tool_input: unknown;
6450	tool_use_id: string;
6451	mcp_server?: McpServerProvenance;
6452	};
6453
6454	/**
6455	* What a `classic.PreToolUse` hook returns: one of `allow`, `ask`, `deny`,
6456	* or none of them, which passes the call on to the normal permission flow.
6457	*/
6458	export type PreToolUseResult = PreToolUseDecision & {
6459	/**
6460	* Replaces the tool's arguments; validated against the tool's schema before
6461	* the tool runs.
6462	*/
6463	updatedInput?: Record<string, unknown>;
6464	/**
6465	* Extra context handed to the model with the call, one entry per note.
6466	*/
6467	additionalContext?: string[];
6468	};
6469
6470	/**
6471	* Options of `$.process.run`.
6472	*/
6473	export type ProcessRunInit = {
6474	/**
6475	* The child's working directory, relative to the session's or absolute;
6476	* absent, the session's working directory.
6477	*/
6478	cwd?: string;
6479	/**
6480	* Variables set over the host process's own environment.
6481	*/
6482	env?: Record<string, string>;
6483	/**
6484	* Text written to the child's standard input, then closed.
6485	*/
6486	stdin?: string;
6487	/**
6488	* How long the child may run before it is killed and the call rejects,
6489	* in milliseconds; 30 seconds when absent, ten minutes at most.
6490	*/
6491	timeoutMs?: number;
6492	};
6493
6494	/**
6495	* What `$.process.run` resolves with once the child has exited.
6496	*/
6497	export type ProcessRunResult = {
6498	/**
6499	* The child's exit status; a child ended by a signal reads as 1.
6500	*/
6501	exitCode: number;
6502	/**
6503	* What the child wrote to standard output, as text, cut at the output
6504	* limit.
6505	*/
6506	stdout: string;
6507	/**
6508	* What the child wrote to standard error, as text, cut at the output
6509	* limit.
6510	*/
6511	stderr: string;
6512	};
6513
6514	/**
6515	* The input of `prompt.attachment`: one message the engine injects into the
6516	* conversation for the model on its own, as a request is about to carry it.
6517	*
6518	* A reminder, a mode transition, a listing, a mentioned file, a hook's
6519	* context: the person never typed it and mostly never sees it. Only an
6520	* attachment that carries text for the model is raised.
6521	*/
6522	export type PromptAttachmentInput = {
6523	/**
6524	* As the engine names the attachment's kind; the key a matcher narrows on.
6525	* Pinned. Builds add and retire kinds: match by name.
6526	*
6527	* Among them `todo_reminder`, `plan_mode`, `plan_mode_exit`, `auto_mode`,
6528	* `auto_mode_exit`, `instructions`, `nested_memory`, `skill_listing`,
6529	* `deferred_tools_delta`, `edited_text_file`, `file`, `queued_command`.
6530	*/
6531	type: string;
6532	/**
6533	* What the model reads for this attachment, inside the engine's framing;
6534	* rewritable with `next({ ...e, text })`.
6535	*
6536	* The `<system-reminder>` wrapper (or the system channel that replaces it)
6537	* goes around what the chain answers, never inside it. An attachment
6538	* rendered as several text blocks hands them joined by newlines.
6539	*/
6540	text: string;
6541	/**
6542	* Who authored the text (PromptAttachmentOrigin): the engine, a settings
6543	* hook, or a plugin's chain context.
6544	*
6545	* Pinned: a different value is refused, one left out is kept.
6546	*/
6547	origin: PromptAttachmentOrigin;
6548	/**
6549	* The loop whose request carries the attachment: a subagent's id, the `id`
6550	* `$.agent.list()` gives it and its `tool.call`s carry; absent on main.
6551	*
6552	* Pinned: a different value is refused, one left out is kept. A subagent
6553	* a hook spawned through `$.agent.spawn` is resolved past that hook.
6554	*/
6555	agentId?: string;
6556	};
6557
6558	/**
6559	* Who authored the text an injected attachment carries, as the engine knows
6560	* it from the attachment itself; a closed set, pinned on the event.
6561	*
6562	* A hooks module reads `e.origin.kind` to tell the engine's own prose from a
6563	* settings hook's output or another plugin's context. `next(e)` passes it on
6564	* as received; one left out is put back; no hook sets one.
6565	*/
6566	export type PromptAttachmentOrigin = {
6567	/**
6568	* The engine's own prose or framing: a reminder, a mode transition, a
6569	* listing, a notice, an announced context block.
6570	*
6571	* A file the person mentioned, as the engine presents it, and a prompt
6572	* or notification delivered into a running turn are the engine's too.
6573	*/
6574	kind: 'engine';
6575	} \| {
6576	/**
6577	* A settings hook's output the engine injects for the model: its
6578	* additional context, a blocking error's note, a stopped continuation.
6579	*/
6580	kind: 'hook';
6581	/**
6582	* The settings hook event that produced it (`SessionStart`,
6583	* `UserPromptSubmit`, `PostToolUse`, ...).
6584	*/
6585	event: string;
6586	} \| {
6587	/**
6588	* Text a plugin's hook attached through a chain's `context`
6589	* (`prompt.submit`, `tool.call`), as the model reads it.
6590	*/
6591	kind: 'plugin';
6592	/**
6593	* The chain's event that attached it.
6594	*/
6595	event: string;
6596	};
6597
6598	/**
6599	* What a `prompt.attachment` hook returns: the text the model reads for that
6600	* attachment, or null to leave the attachment out of the request.
6601	*/
6602	export type PromptAttachmentResult = {
6603	text: string \| null;
6604	};
6605
6606	/**
6607	* The person's prompt box as it stands: the draft and where the cursor is in
6608	* it; what `$.prompt.read()` resolves and `$.prompt.fill` hands back.
6609	*
6610	* No selection: the terminal's box has none of its own, and a surface that
6611	* binds one adds it here.
6612	*/
6613	export type PromptBox = {
6614	/**
6615	* The draft as typed so far; `''` where the session draws no box.
6616	*/
6617	text: string;
6618	/**
6619	* Where the next typed character lands: an offset into `text` in UTF-16
6620	* code units, 0 at the start, `text.length` at the end.
6621	*/
6622	cursor: number;
6623	};
6624
6625	/**
6626	* One block of the context the first user message carries: a name the
6627	* engine keys it by and the text under it.
6628	*/
6629	export type PromptContextBlock = {
6630	/**
6631	* The key the block renders under (`# name`): `claudeMd`, `userEmail`,
6632	* `attachedProject`, `currentDate`, or a plugin's own.
6633	*
6634	* The field a matcher narrows on; unique among one context's blocks.
6635	*/
6636	name: string;
6637	/**
6638	* The block's text; `claudeMd`'s is the instruction files framed as the
6639	* engine frames them, empty when it announces none.
6640	*/
6641	text: string;
6642	};
6643
6644	/**
6645	* The context blocks of a conversation's first user message, in the order
6646	* the engine renders them: what `prompt.context` takes and answers alike.
6647	*/
6648	export type PromptContextBlocks = {
6649	/**
6650	* From core: `claudeMd` (when instruction files are loaded), `userEmail`,
6651	* `attachedProject`, `currentDate`, each only when present.
6652	*/
6653	blocks: readonly PromptContextBlock[];
6654	};
6655
6656	/**
6657	* The input of `prompt.context`: the context blocks the engine prepends to a
6658	* conversation's first user message, and the files behind `claudeMd`.
6659	*/
6660	export type PromptContextInput = {
6661	/**
6662	* From core: `claudeMd` (when instruction files are loaded), `userEmail`,
6663	* `attachedProject`, `currentDate`, each only when present.
6664	*/
6665	blocks: readonly PromptContextBlock[];
6666	/**
6667	* The files behind `claudeMd`, in the order it renders them, `@` imports
6668	* included; empty when it renders none.
6669	*
6670	* Undefined when a hook above rewrote the `claudeMd` text: the files
6671	* behind that text are then unknown, and a hook adds none of its own.
6672	*/
6673	instructionFiles?: readonly InstructionFile[];
6674	};
6675
6676	/**
6677	* What a `prompt.context` hook returns: the blocks the conversation
6678	* carries, in order; one left out is not sent.
6679	*/
6680	export type PromptContextResult = {
6681	/**
6682	* What the conversation carries, in order.
6683	*/
6684	blocks: readonly PromptContextBlock[];
6685	/**
6686	* The files now behind `claudeMd`; left out, the ones from below stand.
6687	*
6688	* Kept in step with the `claudeMd` text at every link: a changed list
6689	* renders the text the next reader gets, a rewritten text makes the files
6690	* unknown from there on. Every kind is the hook's to add, drop or rewrite.
6691	*/
6692	instructionFiles?: readonly InstructionFile[];
6693	};
6694
6695	/**
6696	* The input of `prompt.edit` (prompt-edit/): one edit the person makes in the
6697	* prompt box, as the draft before it and the splice the editor made of it.
6698	*/
6699	export type PromptEditInput = {
6700	/**
6701	* Who edits (PromptEditOrigin): the person at the composer. Pinned:
6702	* `next(e)` passes it on as received.
6703	*/
6704	origin: PromptEditOrigin;
6705	/**
6706	* The one key that made the edit, in `Client` `onKey`'s shape, when one
6707	* did; absent for a paste and for a burst of keys folded into one edit.
6708	*
6709	* Pinned: which key the person pressed is a fact, not the hook's to change.
6710	*/
6711	key?: ClientKeyEvent;
6712	/**
6713	* The draft before the edit. `next({ ...e, text })` applies the edit to
6714	* another draft instead.
6715	*/
6716	text: string;
6717	/**
6718	* Where the person's caret stood in `text` before the edit, 0 to
6719	* `text.length`.
6720	*/
6721	cursor: number;
6722	/**
6723	* Where in `text` the edit begins: the start of the span it replaces, or
6724	* where what was typed goes in; a bare cursor move begins where it lands.
6725	*/
6726	start: number;
6727	/**
6728	* Where the replaced span of `text` ends: `start` for an insertion or a
6729	* move, past it for a deletion (Backspace, a kill).
6730	*/
6731	end: number;
6732	/**
6733	* What goes in between `start` and `end`: the typed or pasted text, `''` for
6734	* a deletion or a move.
6735	*
6736	* `next({ ...e, inputText })` puts in another; the cursor lands after it.
6737	*/
6738	inputText: string;
6739	};
6740
6741	/**
6742	* Who edits the prompt box at `prompt.edit`, as the engine stamps it where
6743	* the edit starts; a closed set a matcher narrows on.
6744	*
6745	* `next(e)` passes it on as received; no hook sets one.
6746	*/
6747	export type PromptEditOrigin = {
6748	/**
6749	* The person, typing or pasting into the main prompt box.
6750	*/
6751	kind: 'composer';
6752	};
6753
6754	/**
6755	* What a `prompt.edit` hook returns and what `next(e)` resolves to: the box
6756	* after the edit (PromptBox), which the editor then shows.
6757	*
6758	* From core, `e.text` with the splice applied and the cursor after what went
6759	* in. Rewrite it (`{ ...r, text, cursor }`) to change what lands; answer
6760	* `{ text: e.text, cursor: e.cursor }` without `next` to consume the key.
6761	*/
6762	export type PromptEditResult = PromptBox;
6763
6764	/**
6765	* `prompt.fill`'s input as a plugin's `$.prompt.fill(args)` takes it: no
6766	* `origin` (the engine sets the calling plugin's), `mode` optional.
6767	*/
6768	export type PromptFillArgs = {
6769	/**
6770	* What the box is to take (PromptFillInput `text`).
6771	*/
6772	text: string;
6773	/**
6774	* Where it goes (PromptFillMode); `replace` when left out.
6775	*/
6776	mode?: PromptFillMode;
6777	};
6778
6779	/**
6780	* What `$.prompt.fill` resolves to: whether the box took the text, and the
6781	* box afterwards (PromptBox) as the caller's own `$.prompt.read()` reads it.
6782	*
6783	* The box goes to a plugin whose module calls `$.prompt.read`, through the
6784	* hooks on it; one that never does, or is refused there, gets the empty box.
6785	*/
6786	export type PromptFilled = {
6787	/**
6788	* True once the box holds the text; false where no box could take it or a
6789	* hook kept it out (PromptFillResult).
6790	*/
6791	isFilled: boolean;
6792	/**
6793	* The draft after the fill; unchanged when `isFilled` is false; `''` where
6794	* no box is drawn or the caller may not read it (see above).
6795	*/
6796	text: string;
6797	/**
6798	* Where the person types next: an offset into `text`, past the fill's text
6799	* for `insert`, at the end for `replace` and `append`.
6800	*/
6801	cursor: number;
6802	};
6803
6804	/**
6805	* The input of `prompt.fill` (prompt-fill/): a text about to be put in the
6806	* prompt box as the person's draft, over it, after it, or at the cursor.
6807	*/
6808	export type PromptFillInput = {
6809	/**
6810	* What the box takes; the person edits it or presses Enter.
6811	* `next({ ...e, text })` writes another.
6812	*/
6813	text: string;
6814	/**
6815	* Where the text goes (PromptFillMode): over the draft, after it, or in at
6816	* the cursor. `next({ ...e, mode })` moves it; left out of a rewrite, kept.
6817	*/
6818	mode: PromptFillMode;
6819	/**
6820	* Who writes (PromptFillOrigin), set by the engine where the write
6821	* starts. Pinned: `next(e)` passes it on as received.
6822	*/
6823	origin: PromptFillOrigin;
6824	};
6825
6826	/**
6827	* Where a `prompt.fill` puts its text: over the whole draft, after it, or
6828	* into it at the cursor.
6829	*
6830	* `replace` empties the box first and leaves the cursor at the text's end;
6831	* `append` keeps the draft and adds the text after it, cursor at the end;
6832	* `insert` splices the text in at the cursor and moves the cursor past it,
6833	* so what the person had typed stays on either side.
6834	*/
6835	export type PromptFillMode = 'replace' \| 'append' \| 'insert';
6836
6837	/**
6838	* Who writes the prompt box at `prompt.fill`, as the engine stamps it where
6839	* the write starts; a closed set a matcher narrows on.
6840	*
6841	* `next(e)` passes it on as received; no hook sets one.
6842	*/
6843	export type PromptFillOrigin = {
6844	/**
6845	* The engine writing the box on its own account; reserved for its own
6846	* sites, none of which raises `prompt.fill` as shipped.
6847	*/
6848	kind: 'engine';
6849	} \| {
6850	/**
6851	* A plugin's `$.prompt.fill`.
6852	*/
6853	kind: 'plugin';
6854	/**
6855	* The filling plugin's name.
6856	*/
6857	name: string;
6858	};
6859
6860	/**
6861	* What a `prompt.fill` hook returns and what `next(e)` resolves to: whether
6862	* the text went into the prompt box.
6863	*/
6864	export type PromptFillResult = {
6865	/**
6866	* True once the box holds the text; false where no box can take it (a
6867	* dialog holds the keys, a headless session has none).
6868	*
6869	* A hook answering `{ isFilled: false }` without `next` keeps the text
6870	* out.
6871	*/
6872	isFilled: boolean;
6873	};
6874
6875	/**
6876	* Where a `prompt.submit` submission came from, as the engine knows it at
6877	* the site it was queued from; a closed set, never a text prefix.
6878	*
6879	* A hooks module reads `e.origin.kind` to tell the user's own Enter from a
6880	* notification, a peer session, a schedule or another plugin. `next(e)`
6881	* passes it on as received; an answer may leave it out; no hook sets one.
6882	*/
6883	export type PromptOrigin = {
6884	/**
6885	* The user's own gesture at the terminal, as the engine stamped it
6886	* (never presumed from an unstamped command).
6887	*
6888	* Enter at the prompt, typed or queued, or a click on a transcript
6889	* link; a channel the engine cannot attest (a same-user socket) is
6890	* never stamped, and arrives as `unclassified`.
6891	*/
6892	kind: 'composer';
6893	} \| {
6894	/**
6895	* The user's message through the Remote Control bridge (a phone or
6896	* web client).
6897	*/
6898	kind: 'bridge';
6899	} \| {
6900	/**
6901	* The SDK host's own turn (`claude -p`, the Agent SDK), not typed at
6902	* a terminal.
6903	*/
6904	kind: 'sdk';
6905	} \| {
6906	/**
6907	* A background task's notification, dequeued when the session went
6908	* idle or delivered into a running turn (`turnId` set).
6909	*/
6910	kind: 'task-notification';
6911	} \| {
6912	/**
6913	* A scheduled task, routine or /loop firing its stored prompt.
6914	*/
6915	kind: 'scheduled-trigger';
6916	} \| {
6917	/**
6918	* Another Claude session's message ("Another Claude session sent a
6919	* message"), as a turn of its own or delivered into a running one.
6920	*/
6921	kind: 'peer';
6922	} \| {
6923	/**
6924	* Another session's SendMessage delivery, model-authored and framed
6925	* as a notification.
6926	*/
6927	kind: 'peer-send-message';
6928	} \| {
6929	/**
6930	* A delivery a coordinating session composed for one of its threads.
6931	*/
6932	kind: 'projects-relay';
6933	} \| {
6934	/**
6935	* A message from a channel an MCP server relays (Slack, Telegram).
6936	*/
6937	kind: 'channel';
6938	/**
6939	* The channel server's name.
6940	*/
6941	server: string;
6942	} \| {
6943	/**
6944	* A coordinating session's hand-off to a worker session.
6945	*/
6946	kind: 'coordinator';
6947	} \| {
6948	/**
6949	* A background observer agent's report to the agent it observes.
6950	*/
6951	kind: 'observer';
6952	} \| {
6953	/**
6954	* An activity digest delivered to an observer agent.
6955	*/
6956	kind: 'observer-activity';
6957	} \| {
6958	/**
6959	* A programmatic follow-up to a user's UI action, user-initiated but
6960	* not typed this turn.
6961	*/
6962	kind: 'auto-continuation';
6963	} \| {
6964	/**
6965	* A turn with no provenance the engine can name: one the ingress
6966	* could not classify, or a command queued with no stamp at all.
6967	*
6968	* An idle notice or a delivery receipt the engine queued isMeta with
6969	* no stamp is one too; the engine frames that shape as a non-user
6970	* source.
6971	*/
6972	kind: 'unclassified';
6973	} \| {
6974	/**
6975	* The session's owner pinging it from Slack.
6976	*/
6977	kind: 'slack-ping';
6978	} \| {
6979	/**
6980	* A plugin's `$.prompt.submit`; the model reads the prompt under the
6981	* plugin's name unless a hook leaves the origin out of its answer.
6982	*/
6983	kind: 'plugin';
6984	/**
6985	* The submitting plugin's name.
6986	*/
6987	name: string;
6988	};
6989
6990	/**
6991	* The input of `prompt.section`: one named section of the system prompt, at
6992	* the moment the engine assembles it.
6993	*/
6994	export type PromptSectionInput = {
6995	/**
6996	* As the engine names the section (`env_info_simple`, `memory`, ...); the
6997	* key a matcher narrows on.
6998	*/
6999	name: string;
7000	/**
7001	* The section's text as core computed it, or null when core omits it.
7002	*/
7003	text: string \| null;
7004	};
7005
7006	/**
7007	* What a `prompt.section` hook returns: the text the prompt carries for that
7008	* section, or null to leave it out.
7009	*/
7010	export type PromptSectionResult = {
7011	text: string \| null;
7012	};
7013
7014	/**
7015	* `prompt.submit`'s input as a plugin's call takes it: `origin`, `turnId`
7016	* and `wait` are the engine's to set, `context` the hooks' to attach.
7017	*
7018	* `origin` is the calling plugin's name; `turnId` is the turn a prompt typed
7019	* mid-turn ran over; `wait` is false, as a plugin's prompt runs once idle.
7020	*/
7021	export type PromptSubmitArgs = Omit<PromptSubmitInput, 'origin' \| 'turnId' \| 'wait' \| 'context'>;
7022
7023	/**
7024	* A pasted or attached non-text item of a submitted prompt; its kind, never
7025	* its bytes.
7026	*/
7027	export type PromptSubmitAttachment = {
7028	/**
7029	* The item's kind.
7030	*/
7031	type: 'image' \| 'audio' \| 'document';
7032	/**
7033	* The item's MIME type (`image/png`), when known.
7034	*/
7035	mediaType?: string;
7036	/**
7037	* The pasted file's name, when it had one.
7038	*/
7039	filename?: string;
7040	};
7041
7042	/**
7043	* The input of `prompt.submit`: the prompt as typed, after the input became
7044	* a user message and before it enters the session.
7045	*/
7046	export type PromptSubmitInput = {
7047	/**
7048	* The prompt's text as it will reach the model (pastes already expanded).
7049	*/
7050	text: string;
7051	/**
7052	* Present only when the submission carried images or other non-text items.
7053	*/
7054	attachments?: readonly PromptSubmitAttachment[];
7055	/**
7056	* What the model reads beside the prompt and the user never sees, each
7057	* entry one block after the prompt as typed; absent as the engine raises it.
7058	*
7059	* A hook attaches on the way down: `next({ ...e, context: [...(e.context
7060	* ?? []), mine] })`, keeping which it likes; none empty, any length: past
7061	* 100,000 characters (200,000 together) the model reads a head and path.
7062	*/
7063	context?: readonly string[];
7064	/**
7065	* The id of the model turn that was running when the prompt was submitted
7066	* (`turn.start`'s `turnId`): typed over that turn, or delivered into it.
7067	*
7068	* A queued delivery (a peer session's message) reaches the model inside a
7069	* running turn. Absent for a prompt submitted while the session was idle,
7070	* and for a plugin's own (`$.prompt.submit`), which runs once it is idle.
7071	*/
7072	turnId?: string;
7073	/**
7074	* Whether the user asked the prompt to wait its turn (`chat:queueSubmit`,
7075	* `ctrl+x enter` by default): true for that submission, false otherwise.
7076	*
7077	* The engine queues every prompt typed mid-turn either way; the flag is
7078	* for hooks, so one that cancels the running turn on a plain Enter can
7079	* leave a waiting prompt alone. False for a prompt a plugin submitted.
7080	*/
7081	wait: boolean;
7082	/**
7083	* Where the submission came from (PromptOrigin), set by the engine where
7084	* it was queued: the user's Enter, a notification, a peer, a plugin.
7085	*
7086	* `next(e)` passes it on as received; no hook may set one.
7087	*/
7088	origin: PromptOrigin;
7089	};
7090
7091	/**
7092	* What a `prompt.submit` hook returns and what `next(e)` resolves to: the
7093	* prompt that entered, `{ text, context?, origin? }`, or `{ drop: reason }`.
7094	*
7095	* `next(e)` resolves once the prompt entered the session and its turn
7096	* started, or it was queued behind the running one; not when the turn ends,
7097	* which is `turn.complete`. A hook answering without `next` enters nothing.
7098	*/
7099	export type PromptSubmitResult = {
7100	/**
7101	* The prompt that entered; from core, the text that arrived at the
7102	* bottom. A rewrite passes it down, `next({ ...e, text })`.
7103	*/
7104	text: string;
7105	/**
7106	* What entered beside the prompt for the model, never shown the user:
7107	* from core, the context that arrived (`e.context`).
7108	*
7109	* Each entry is one block after the prompt as typed. A hook attaches
7110	* context on the way down; one put here after `next` resolved is not
7111	* attached (the prompt had entered), and is logged.
7112	*/
7113	context?: readonly string[];
7114	/**
7115	* Where the prompt entered from: from core, `e.origin` as received;
7116	* absent, the prompt is the user's own.
7117	*
7118	* A hook may put back the origin it received; it may not set another.
7119	*/
7120	origin?: PromptOrigin;
7121	drop?: undefined;
7122	} \| {
7123	/**
7124	* The prompt did not enter: a hook's refusal, answered without `next`,
7125	* or a settings hook's block beneath.
7126	*
7127	* The text is shown to the user as the reason.
7128	*/
7129	drop: string;
7130	text?: undefined;
7131	context?: undefined;
7132	origin?: undefined;
7133	};
7134
7135	/**
7136	* `prompt.suggest`'s input as a plugin's `$.prompt.suggest(args)` takes it:
7137	* `origin` is the engine's to set (the calling plugin's name).
7138	*/
7139	export type PromptSuggestArgs = Omit<PromptSuggestInput, 'origin'>;
7140
7141	/**
7142	* The input of `prompt.suggest` (prompt-suggest/): a text about to be shown
7143	* dim in the empty prompt box, for Tab (or the right arrow) to take.
7144	*/
7145	export type PromptSuggestInput = {
7146	/**
7147	* The proposed prompt: shown, not written; taking it puts it in the box
7148	* for editing. `next({ ...e, text })` proposes another.
7149	*/
7150	text: string;
7151	/**
7152	* Who proposes (PromptSuggestOrigin), set by the engine where the
7153	* proposal starts. Pinned: `next(e)` passes it on as received.
7154	*/
7155	origin: PromptSuggestOrigin;
7156	};
7157
7158	/**
7159	* Who proposes the text at `prompt.suggest`, as the engine stamps it where
7160	* the proposal starts; a closed set a matcher narrows on.
7161	*
7162	* `next(e)` passes it on as received; no hook sets one.
7163	*/
7164	export type PromptSuggestOrigin = {
7165	/**
7166	* The engine's own guess at the person's next prompt, generated after
7167	* a turn (the prompt-suggestion service).
7168	*/
7169	kind: 'suggestion';
7170	} \| {
7171	/**
7172	* A plugin's `$.prompt.suggest`.
7173	*/
7174	kind: 'plugin';
7175	/**
7176	* The proposing plugin's name.
7177	*/
7178	name: string;
7179	};
7180
7181	/**
7182	* What a `prompt.suggest` hook returns and what `next(e)` resolves to:
7183	* whether the text is now the box's dim suggestion.
7184	*/
7185	export type PromptSuggestResult = {
7186	/**
7187	* True once the box has the suggestion to show, at once or as soon as a
7188	* dialog gives the box back; false where it cannot show.
7189	*
7190	* It cannot while the box holds text, a turn runs, the text is blank, or
7191	* the session is headless. A hook answering `{ isShown: false }` without
7192	* `next` keeps it from showing.
7193	*/
7194	isShown: boolean;
7195	};
7196
7197	/**
7198	* A `$.ui.blit` argument repainting one of the caller's mounted Rasters.
7199	*
7200	* `columns` and `rows`, when given, must be the mounted size (a resize is a
7201	* redraw, `$.ui.invalidate("ui.render")`, not a blit).
7202	*/
7203	export type RasterBlitArgs = {
7204	/**
7205	* The site the Raster is drawn in, by the `requestId` this plugin draws
7206	* it under: one of its panes' ids, a tool row's `tool_use_id`, the band's.
7207	*/
7208	requestId: string;
7209	/**
7210	* The Raster's `key` in that drawing.
7211	*/
7212	key: string;
7213	/**
7214	* The new cells, encoded as the element's `cells` are (RasterProps), for
7215	* the mounted `columns * rows`.
7216	*/
7217	cells: string;
7218	/**
7219	* The width the cells are laid out for; refused unless it is the mounted
7220	* Raster's. Absent, the mounted width.
7221	*/
7222	columns?: number;
7223	/**
7224	* The height the cells are laid out for; refused unless it is the mounted
7225	* Raster's. Absent, the mounted height.
7226	*/
7227	rows?: number;
7228	};
7229
7230	/**
7231	* The props of `Raster`, the terminal surface's cell-grid leaf: a fixed box
7232	* of cells, each a glyph, a foreground and a background, packed in `cells`.
7233	*
7234	* A leaf: no children, `hover` or `onPress` yet; repainted in place by
7235	* `$.ui.blit`. Terminal only for now (elsewhere a fragment); its palette
7236	* paints 1024 distinct color pairs at once and the rest as their nearest.
7237	*/
7238	export type RasterProps = {
7239	/**
7240	* The element's address within the drawing: what `$.ui.blit` names to
7241	* repaint it, unique among the Rasters of one tree.
7242	*/
7243	key: string;
7244	/**
7245	* How many terminal columns wide, 1 to 512; the site clips what its body
7246	* cannot show.
7247	*/
7248	columns: number;
7249	/**
7250	* How many terminal rows tall, 1 to 256.
7251	*/
7252	rows: number;
7253	/**
7254	* Every cell, row-major: standard padded base64 of `columns * rows`
7255	* little-endian u32 triplets `[codePoint, foreground, background]`.
7256	*
7257	* A code point is one printable width-1 BMP character (blocks, box drawing,
7258	* braille too), or the tree is refused naming the cell's index; a color is
7259	* `0x00RRGGBB`, or `0x01000000` (bit 24 alone) for the terminal's default.
7260	*
7261	* @example const words = Uint32Array.of(0x2588, 0xff8800, 0x01000000)
7262	* const cells = new Uint8Array(words.buffer).toBase64() // one orange cell
7263	*/
7264	cells: string;
7265	};
7266
7267	/**
7268	* The hooks module's entry: `export function register(on, options)`. `on`
7269	* registers hooks; `options` is the plugin's configuration (PluginOptions).
7270	*
7271	* The options are fixed for this activation: a change to them reloads the
7272	* plugin and `register` runs again with the new object. Hooks close over it.
7273	* Its return is dropped, a promise awaited: `on => on(...)` is a module.
7274	*
7275	* @example
7276	* on("tool.call", ($, e, next) => e.tool === "Bash" ? { deny: "no" } : next(e))
7277	*/
7278	export type Register = (on: On, options: PluginOptions) => unknown;
7279
7280	/**
7281	* What `on(...)` returns for a hook of type `F`: the registration, which
7282	* takes one `.catch` (CatchHandler); without it a failed hook is absent.
7283	*
7284	* A second `.catch` on one registration throws, as does one after
7285	* register() returned and one on `engine.create`, whose hook has no budget
7286	* and whose failure is the load's.
7287	*/
7288	export type Registration<F> = {
7289	/**
7290	* Sets the handler run when the hook throws or overruns its budget; its
7291	* answer within the grace stands as the hook's result for the dispatch.
7292	*
7293	* The budget is HookBudget's `ms` and the grace its `catchMs`, both on
7294	* the clock that stops while the code waits on `next` or `$`.
7295	*/
7296	readonly catch: (handler: CatchHandler<F>) => void;
7297	};
7298
7299	/**
7300	* What an element takes as `children`, as JSX passes them: a node, a number
7301	* (drawn as its string), a value the factory drops, or a list that may nest.
7302	*
7303	* `false`, `null` and `undefined` are dropped, so `{ok && <Text>hi</Text>}`
7304	* and `{n > 0 ? <Text>{n}</Text> : null}` type; a mapped list beside a
7305	* sibling nests. The element holds the flat, normalized list of RenderNode.
7306	*/
7307	export type RenderChildren = RenderNode \| number \| boolean \| null \| undefined \| readonly RenderChildren[];
7308
7309	/**
7310	* Everything `ui.render` can draw: one name per component that has a render
7311	* site; a matcher narrows on it.
7312	*
7313	* The permission dialog is drawn by the engine alone, since its answer
7314	* authorises an action; a plugin adds context with `$.ui.notice`. `Pane` is
7315	* the one component whose instances a plugin opens (`$.ui.open`).
7316	*/
7317	export type RenderComponent = 'AskUserQuestion' \| 'UserMessage' \| 'AssistantMessage' \| 'ToolUse' \| 'ToolResult' \| 'ToolGroup' \| 'ToolProgress' \| 'CommandOutput' \| 'Spinner' \| 'TurnDuration' \| 'InfoNotice' \| 'SessionMode' \| 'PromptHint' \| 'AbovePrompt' \| 'Pane';
7318
7319	/**
7320	* What a render hook returns, and what `next(e)` resolves to: a plain-data
7321	* tree of elements (a Box or Text is a StyledElement), strings as children.
7322	*
7323	* Props are an allowlisted subset of Ink's Box/Text props (the ones
7324	* ElementProps declares); a tree with any other prop fails validation as a
7325	* whole and the engine's own component is drawn with the original props.
7326	*/
7327	export type RenderElement = StyledElement<'Box', BoxHoverProps> \| StyledElement<'Text', TextHoverProps> \| {
7328	/**
7329	* A button, on every surface: `[ label ]` on the terminal, a native
7330	* button on a desktop; a press raises `ui.press` (`e.element` the key).
7331	*
7332	* Built by `<Button>` or the table's `t.Button`. The `onPress` closure
7333	* stays in the plugin's own environment under `press.handle`; the host
7334	* holds the handle for the lifetime of the drawing. A leaf: no children.
7335	*/
7336	type: 'Button';
7337	props: {
7338	/**
7339	* The element's address: what `e.element` carries and what a matcher
7340	* names (`{ element: "explain" }`).
7341	*/
7342	key: string;
7343	/**
7344	* The text drawn on the button.
7345	*/
7346	label: string;
7347	/**
7348	* One digit (`"1"`) or one lowercase letter (`"w"`) that presses it
7349	* while the plugin's site holds the focus; anything else is refused.
7350	*
7351	* The band after ctrl+x tab or a click, a focused `Pane`: on keydown,
7352	* lowercased; never from the composer, save a bare digit in an empty
7353	* one pressing a band Button. Two on one hotkey: the later wins.
7354	*/
7355	hotkey?: string;
7356	/**
7357	* An engine keybinding action (`"app:cycleDiffBase"`) whose chord
7358	* presses the Button from the prompt; an unknown name is refused.
7359	*
7360	* Chords, or a modified key Global or an active context binds, on
7361	* the terminal while mounted, no dialog up, no engine handler of it
7362	* mounted; a pane's over the band's over another's, the last drawn.
7363	*/
7364	action?: string;
7365	/**
7366	* Drawn without chrome: the hotkey in the accent color, a colon,
7367	* then the label (`1: Yes`); without a `hotkey`, the label alone.
7368	*
7369	* The focus still inverts it. In JSX the label may be the one string
7370	* child (`<Button hotkey="1" plain onPress={...}>Yes</Button>`); the
7371	* key defaults to the label.
7372	*/
7373	plain?: true;
7374	/**
7375	* The label dim at rest, as `Text`'s `dimColor`, and at full strength
7376	* under the pointer or the focus; absent draws as false.
7377	*/
7378	dimColor?: TextProps['dimColor'];
7379	/**
7380	* The site's ring starts on this element when the site takes the
7381	* keyboard; the first drawn of several. Absent draws as before.
7382	*/
7383	autoFocus?: true;
7384	};
7385	/**
7386	* Where the handler lives: the plugin whose hook drew the element, and
7387	* the handle its environment keeps the `onPress` closure under.
7388	*
7389	* The runtime stamps the plugin as the tree leaves that hook.
7390	*/
7391	press: {
7392	plugin: string;
7393	handle: number;
7394	};
7395	/**
7396	* Label style overrides (the Text set) the surface applies while the
7397	* nearest keyed Box, or the group `scope` names, is hovered; plain data.
7398	*/
7399	hover?: TextHoverProps;
7400	} \| {
7401	/**
7402	* A one-line text field on every surface; a change and Enter raise
7403	* `ui.input` (`e.element` the key, `e.kind` which, `e.value` the text).
7404	*
7405	* Built by `<Input>` or the table's `t.Input`. The `onInput` and
7406	* `onSubmit` closures stay in the plugin's own environment under
7407	* `press.handle`, held as a Button's is. A leaf: no children.
7408	*/
7409	type: 'Input';
7410	props: {
7411	/**
7412	* The element's address: what `e.element` carries and what a matcher
7413	* names (`{ element: "reply" }`).
7414	*/
7415	key: string;
7416	/**
7417	* Text drawn before the field.
7418	*/
7419	label?: string;
7420	/**
7421	* Text drawn dim in an empty field.
7422	*/
7423	placeholder?: string;
7424	/**
7425	* The text the field holds when drawn.
7426	*/
7427	value?: string;
7428	/**
7429	* What Enter does, drawn beside the field while it has focus.
7430	*/
7431	submitLabel?: string;
7432	/**
7433	* The site's ring starts on this element when the site takes the
7434	* keyboard; the first drawn of several. Absent draws as before.
7435	*/
7436	autoFocus?: true;
7437	};
7438	/**
7439	* Where the handlers live: the plugin whose hook drew the element, and
7440	* the handle its environment keeps the closures under.
7441	*
7442	* The runtime stamps the plugin as the tree leaves that hook.
7443	*/
7444	press: {
7445	plugin: string;
7446	handle: number;
7447	};
7448	children?: undefined;
7449	} \| {
7450	/**
7451	* A one-of-several picker on every surface; a pick raises `ui.select`
7452	* (`e.element` the key, `e.value` the option's value).
7453	*
7454	* Built by `<Select>` or the table's `t.Select`. The `onSelect` closure
7455	* stays in the plugin's own environment under `press.handle`, held as
7456	* a Button's is. A leaf: no children.
7457	*/
7458	type: 'Select';
7459	props: {
7460	/**
7461	* The element's address: what `e.element` carries and what a matcher
7462	* names (`{ element: "peer" }`).
7463	*/
7464	key: string;
7465	/**
7466	* Text drawn before the current value.
7467	*/
7468	label?: string;
7469	/**
7470	* What can be picked, in the order drawn: each a value and the text
7471	* drawn for it.
7472	*/
7473	options: readonly SelectOption[];
7474	/**
7475	* Which option is selected when drawn.
7476	*/
7477	value?: string;
7478	/**
7479	* The site's ring starts on this element when the site takes the
7480	* keyboard; the first drawn of several. Absent draws as before.
7481	*/
7482	autoFocus?: true;
7483	};
7484	/**
7485	* Where the handler lives: the plugin whose hook drew the element, and
7486	* the handle its environment keeps the closure under.
7487	*
7488	* The runtime stamps the plugin as the tree leaves that hook.
7489	*/
7490	press: {
7491	plugin: string;
7492	handle: number;
7493	};
7494	children?: undefined;
7495	} \| {
7496	/**
7497	* A hyperlink every surface draws: an OSC 8 span on the terminal (its
7498	* text then the URL in dim where unsupported), an anchor on desktop.
7499	*
7500	* Inline: its children are the text, strings and inline elements;
7501	* absent children the label, absent both the URL. `href` is `https:`
7502	* (or `http://localhost`) and bounded, or the tree is refused.
7503	*/
7504	type: 'Link';
7505	props: LinkProps;
7506	children?: RenderNode[];
7507	} \| {
7508	/**
7509	* Source code every surface draws with the engine's highlighter, tokens
7510	* coloured by language; under `format: 'diff'`, unified-diff hunks.
7511	*
7512	* A leaf: a dim gutter numbers the lines from `startLine`; a diff has
7513	* both gutters, markers, add and remove backgrounds. `source` is
7514	* bounded as a Text's string is, or the tree is refused.
7515	*/
7516	type: 'Code';
7517	props: CodeProps;
7518	children?: undefined;
7519	} \| {
7520	/**
7521	* A block of markdown every surface draws as it draws an assistant
7522	* reply's text: its own renderer, theme, hyperlinks and highlighting.
7523	*
7524	* Built by `<Markdown>` or the table's `t.Markdown`. A leaf: `text` is
7525	* bounded as a Text's string is, or the tree is refused. Without a
7526	* `press` its links are the surface's own, opened as it opens links.
7527	*/
7528	type: 'Markdown';
7529	props: MarkdownLeafProps;
7530	children?: undefined;
7531	} \| {
7532	/**
7533	* A `Markdown` whose plugin answers the links it drew (`onLinkPress`):
7534	* a press on one raises `ui.press` with `e.link`, the surface opens none.
7535	*/
7536	type: 'Markdown';
7537	props: MarkdownLeafProps;
7538	/**
7539	* Where the `onLinkPress` handler lives: the plugin whose hook drew
7540	* the element, and the handle its environment keeps the closure under.
7541	*
7542	* The runtime stamps the plugin as the tree leaves that hook.
7543	*/
7544	press: {
7545	plugin: string;
7546	handle: number;
7547	};
7548	children?: undefined;
7549	} \| {
7550	/**
7551	* A region one of the plugin's SURFACE MODULES, named by path, draws and
7552	* handles input for on the drawing thread, without `$` (ClientModule).
7553	*
7554	* `Client` from the table. One instance per plugin, drawing and `key`
7555	* lives while the node stays in the tree, and talks to the plugin's
7556	* hooks through `ui.message`. The desktop carries it as data.
7557	*/
7558	type: 'Client';
7559	props: ClientProps;
7560	/**
7561	* Whose surface module `props.module` names: the plugin whose hook
7562	* drew the element, stamped by the runtime as the tree leaves it.
7563	*/
7564	client: {
7565	plugin: string;
7566	};
7567	children?: undefined;
7568	} \| {
7569	/**
7570	* A vector drawing, the remote surfaces' alone: the SVG markup is the
7571	* element's data, drawn in an isolated box, off the page.
7572	*
7573	* A leaf: hooks above wrap or replace it whole, nothing reaches inside;
7574	* a press other plugins should see goes on an enclosing Button. On a
7575	* surface whose table lacks it the tree is refused.
7576	*/
7577	type: 'Svg';
7578	props: SvgProps;
7579	children?: undefined;
7580	} \| {
7581	/**
7582	* A grid of terminal cells, the terminal surface's alone: each cell a
7583	* glyph, a foreground and a background, packed in `props.cells`.
7584	*
7585	* A leaf, one node however many cells; hooks above wrap or replace it
7586	* whole. A mounted one is repainted in place by its plugin's
7587	* `$.ui.blit`. On a surface whose table lacks it the tree is refused.
7588	*/
7589	type: 'Raster';
7590	props: RasterProps;
7591	/**
7592	* Whose Raster: the plugin whose hook drew the element, stamped by the
7593	* runtime as the tree leaves it; the one plugin whose blit reaches it.
7594	*/
7595	raster: {
7596	plugin: string;
7597	};
7598	children?: undefined;
7599	} \| {
7600	/**
7601	* A picture, the terminal surface's alone: `props.source` drawn over a
7602	* box of cells where the terminal can, `props.alt` where it cannot.
7603	*
7604	* A leaf: hooks above wrap or replace it whole; a press other plugins
7605	* should see goes on an enclosing Button; keyed, its plugin's
7606	* `$.ui.blit` swaps it. On a surface without it the tree is refused.
7607	*/
7608	type: 'Image';
7609	props: ImageProps;
7610	/**
7611	* Whose Image: the plugin whose hook drew the element, stamped by the
7612	* runtime as the tree leaves it; the one plugin whose blit reaches it.
7613	*/
7614	image: {
7615	plugin: string;
7616	};
7617	children?: undefined;
7618	} \| {
7619	/**
7620	* The component core draws itself, with the props held under `ref`.
7621	*/
7622	type: 'engine';
7623	/**
7624	* Which drawing: the number core answered from `next(e)`, under which
7625	* it holds the props it received; 0 draws the original props.
7626	*/
7627	ref: number;
7628	};
7629
7630	/**
7631	* The render event: `ui.render`, one event for every component that has a
7632	* render site.
7633	*/
7634	export type RenderEventName = 'ui.render';
7635
7636	/**
7637	* The input of `ui.render`: a union discriminated by `component`, one member
7638	* per RenderComponent and per RenderSurface.
7639	*/
7640	export type RenderInput<C extends RenderComponent = RenderComponent, P extends RenderSurface = RenderSurface> = C extends RenderComponent ? P extends RenderSurface ? RenderInputOf<C, P> : never : never;
7641
7642	/**
7643	* One `ui.render` input, for a component narrowed to one surface.
7644	*/
7645	export type RenderInputOf<C extends RenderComponent, P extends RenderSurface> = {
7646	/**
7647	* Where the tree will be drawn; one literal per member, so
7648	* `if (e.surface === "terminal")` narrows `e` and `$.ui.resolve(e)`.
7649	*
7650	* Over the wire it is what the client declared, a rendering fact and not a
7651	* trust signal: do not key policy on it.
7652	*/
7653	surface: P;
7654	/**
7655	* Which component this instance is; the key a matcher narrows on.
7656	*/
7657	component: C;
7658	/**
7659	* The instance: the tool_use_id for a dialog or tool row, the message id
7660	* for a message, the agent id for a spinner.
7661	*
7662	* Two drawings of one component are two instances.
7663	*/
7664	requestId: string;
7665	/**
7666	* The size of what the surface draws into, in character cells, and whether
7667	* its layout docks a pane; absent where no surface has measured.
7668	*
7669	* Part of the envelope: a rewrite keeps it. On the terminal, the interactive
7670	* screen's, where a change of width re-draws every hooked site once the
7671	* resize settles; on a remote surface, what it reported.
7672	*/
7673	viewport?: RenderViewport;
7674	/**
7675	* The component's plain-data props.
7676	*/
7677	props: RenderPropsOf[C];
7678	};
7679
7680	/**
7681	* A node of a render tree: an element, or a string (text).
7682	*/
7683	export type RenderNode = RenderElement \| string;
7684
7685	/**
7686	* The plain-data props of each renderable component, as `ui.render` sees
7687	* them under `e.props`; a hook rewrites them with `next({ ...e, props })`.
7688	*
7689	* A rewrite is validated by the component and an invalid one draws the
7690	* original. This table is the plugin-facing render contract; the author's
7691	* file notes which surfaces raise each member (RENDER_SURFACES_OF).
7692	*/
7693	export type RenderPropsOf = {
7694	/**
7695	* The dialog the AskUserQuestion tool opens.
7696	*
7697	* Raised on every surface.
7698	*/
7699	AskUserQuestion: {
7700	/**
7701	* The name of the tool whose call opened the dialog (`AskUserQuestion`).
7702	*/
7703	tool: string;
7704	/**
7705	* The tool's `questions` input, as the dialog will draw them; a rewrite
7706	* must still fit the tool's schema or the original is drawn.
7707	*/
7708	questions: unknown[];
7709	/**
7710	* The call's `metadata.source` (who asked) when the model gave one.
7711	* Analytics only; never drawn.
7712	*/
7713	metadataSource?: string;
7714	};
7715	/**
7716	* A user-role transcript row: the person's prompt (`> ...`), a background
7717	* task's notification, or a message another agent, teammate or session sent.
7718	*
7719	* `origin`, `task` and `from` tell them apart and are read-only; a rewrite
7720	* of `text` draws in the row alone: the stored message, and the model's
7721	* framing of another party's words as that party's, stay as they were.
7722	*
7723	* Raised on every surface.
7724	*/
7725	UserMessage: {
7726	/**
7727	* What the row shows: the prompt as typed, a notification's summary, or
7728	* a message's body less the engine's framing (summary line included).
7729	*
7730	* A rewrite is printable, bounded text and draws where the engine draws
7731	* the body; a teammate block of several frames or with a summary line
7732	* keeps the engine's drawing, one string not being those parts.
7733	*/
7734	text: string;
7735	/**
7736	* Where the stored message came from, as `prompt.submit` named it: the
7737	* composer's, a task notification's, a peer's, a channel's, a plugin's.
7738	*
7739	* `unclassified` for a teammate's (its drain stamps none) and for a
7740	* message stored before stamps. Read-only.
7741	*/
7742	origin: PromptOrigin;
7743	/**
7744	* Whether the view draws the row in full: the ctrl+o transcript,
7745	* `--verbose`, a surface with no ctrl+o (an export). Read-only.
7746	*
7747	* False, a message row is one dim line naming its sender; a hook that
7748	* draws a compact row of its own passes when true, so ctrl+o shows all.
7749	*/
7750	isExpanded: boolean;
7751	/**
7752	* What a notification row (`origin.kind` `task-notification`) reports
7753	* on: its background task; absent on every other row. Read-only.
7754	*/
7755	task?: UserMessageTask;
7756	/**
7757	* Who sent the message the row carries: another agent of this session, a
7758	* teammate, another session, a channel; absent otherwise. Read-only.
7759	*/
7760	from?: UserMessageFrom;
7761	/**
7762	* Which of its rows the transcript's viewport shows now: `null` while
7763	* drawn outside it, absent where the surface does not say. Read-only.
7764	*
7765	* Reported once drawn and again when it changes: on a scroll, for the
7766	* messages at the viewport's edges only. A rewrite carries it on as
7767	* received; one that changes or drops it is refused.
7768	*/
7769	onScreen?: OnScreen \| null;
7770	};
7771	/**
7772	* One text block of an assistant reply in the transcript; a rewrite
7773	* changes the drawing and leaves the stored message alone (ctrl+o).
7774	*
7775	* Raised on every surface.
7776	*/
7777	AssistantMessage: {
7778	/**
7779	* The block's text, markdown, as the transcript will draw it.
7780	*/
7781	text: string;
7782	/**
7783	* True on the block that draws the bullet opening a reply.
7784	*/
7785	isFirstOfReply: boolean;
7786	/**
7787	* Which of its rows the transcript's viewport shows now: `null` while
7788	* drawn outside it, absent where the surface does not say. Read-only.
7789	*
7790	* Reported once drawn and again when it changes: on a scroll, for the
7791	* messages at the viewport's edges only. A rewrite carries it on as
7792	* received; one that changes or drops it is refused.
7793	*/
7794	onScreen?: OnScreen \| null;
7795	};
7796	/**
7797	* A tool call's row in the transcript (`Bash(ls -la)` and its result); the
7798	* call was decided by `tool.call`, so a rewrite here changes the row alone.
7799	*
7800	* Raised on every surface.
7801	*/
7802	ToolUse: {
7803	/**
7804	* The id `tool.call` carried for this call (`e.tool_use_id` there); the
7805	* same value as the row's `requestId`, where it is looked for. Read-only.
7806	*/
7807	tool_use_id: string;
7808	/**
7809	* Which one the row draws (`Bash`, `Read`, a plugin's tool), as
7810	* `tool.call` named it.
7811	*/
7812	tool: string;
7813	/**
7814	* The call's input, as the model sent it.
7815	*/
7816	input: unknown;
7817	/**
7818	* True while the call is still running.
7819	*/
7820	isRunning: boolean;
7821	/**
7822	* True when the call ended in an error (a refusal at the dialog is one).
7823	*/
7824	isErrored: boolean;
7825	/**
7826	* True when an abort ended the call: the user's Esc or a plugin's
7827	* `$.turn.abort` cut it while it ran, or dropped it before it ran.
7828	*
7829	* The row draws `Interrupted` for it, as the transcript marker does.
7830	*/
7831	isInterrupted: boolean;
7832	/**
7833	* The stored result once the call has resolved (`{ stdout, stderr, ... }`
7834	* for Bash: `BuiltinToolResults[tool]`); undefined while it runs.
7835	*
7836	* For a call that errored, was refused or an abort cut, it is the text
7837	* the model read (an `isInterrupted` call: the abort's own). An expanded
7838	* group's rows draw it inline; a standalone row's is its own `ToolResult`.
7839	*/
7840	output?: unknown;
7841	/**
7842	* Which of its rows the transcript's viewport shows now: `null` while
7843	* drawn outside it, absent where the surface does not say. Read-only.
7844	*
7845	* Reported once drawn and again when it changes: on a scroll, for the
7846	* messages at the viewport's edges only. A rewrite carries it on as
7847	* received; one that changes or drops it is refused.
7848	*/
7849	onScreen?: OnScreen \| null;
7850	};
7851	/**
7852	* The result block drawn under a standalone tool row in the transcript,
7853	* which the tool's own result renderer draws from `output`.
7854	*
7855	* A rewrite of `output` is checked against the tool's output schema (one
7856	* that does not fit draws nothing; one the renderer cannot read hits the
7857	* row's error boundary). The stored result is untouched.
7858	*
7859	* Raised on every surface.
7860	*/
7861	ToolResult: {
7862	/**
7863	* The id `tool.call` carried for the call this result belongs to
7864	* (`e.tool_use_id` there); the same value as `requestId`. Read-only.
7865	*/
7866	tool_use_id: string;
7867	/**
7868	* Which one the result belongs to (`Bash`, `Read`, a plugin's tool).
7869	* Read-only.
7870	*/
7871	tool: string;
7872	/**
7873	* The tool's own result object (`{ stdout, stderr, interrupted, ... }` for
7874	* Bash), the same one `ToolUse.output` carries; a rewrite is drawn.
7875	*
7876	* A built-in tool's is `BuiltinToolResults[tool]`, the record
7877	* `tool.call` resolved as `result`.
7878	*/
7879	output: unknown;
7880	/**
7881	* True when the call ended in an error, which draws the error text and not
7882	* `output`. Read-only.
7883	*/
7884	isErrored: boolean;
7885	/**
7886	* Which of its rows the transcript's viewport shows now: `null` while
7887	* drawn outside it, absent where the surface does not say. Read-only.
7888	*
7889	* Reported once drawn and again when it changes: on a scroll, for the
7890	* messages at the viewport's edges only. A rewrite carries it on as
7891	* received; one that changes or drops it is refused.
7892	*/
7893	onScreen?: OnScreen \| null;
7894	};
7895	/**
7896	* A run of tool calls the transcript folds into one count line (`Read 3
7897	* files, ran 2 shell commands`): reads, searches, listings.
7898	*
7899	* A hook that sets `isExpanded` unfolds the group where it is, and each row
7900	* it unfolds into is a `ToolUse` drawing a `ToolUse` hook then sees.
7901	*
7902	* Raised on every surface.
7903	*/
7904	ToolGroup: {
7905	/**
7906	* In the order the model made them.
7907	*/
7908	calls: ReadonlyArray<ToolGroupCall>;
7909	/**
7910	* True while the group is the live one: a call in it may still be
7911	* running and the model's next call may join it.
7912	*/
7913	isActive: boolean;
7914	/**
7915	* Whether each call draws as its own `ToolUse` row (true under
7916	* `--verbose` and in the ctrl+o transcript) or the group draws one line.
7917	*
7918	* The one prop of the three a rewrite changes on the screen.
7919	*/
7920	isExpanded: boolean;
7921	/**
7922	* Which of its rows the transcript's viewport shows now: `null` while
7923	* drawn outside it, absent where the surface does not say. Read-only.
7924	*
7925	* Reported once drawn and again when it changes: on a scroll, for the
7926	* messages at the viewport's edges only. A rewrite carries it on as
7927	* received; one that changes or drops it is refused.
7928	*/
7929	onScreen?: OnScreen \| null;
7930	};
7931	/**
7932	* The output row a slash command printed in the transcript, under its echo
7933	* (`/cost`'s lines, the `text` a `command.run` hook answered).
7934	*
7935	* What the run resolved as text, a `local` command's or a plugin's alike. A
7936	* rewrite of `text` draws there and the stored row keeps what the model
7937	* reads; a hook's own tree draws in the row's place, the transcript's width.
7938	*
7939	* Raised on every surface.
7940	*/
7941	CommandOutput: {
7942	/**
7943	* Which one printed the row, as `command.run` named it (no slash); a
7944	* hook on its own command matches by it.
7945	*
7946	* Read-only: a rewrite carries it on as received; one that changes or
7947	* drops it is refused and the engine draws its own row.
7948	*/
7949	command: string;
7950	/**
7951	* The arguments the run had, as the echo above the row shows them
7952	* (`***` for a command that marks its arguments sensitive). Read-only.
7953	*/
7954	args: string;
7955	/**
7956	* The row's text: what the command printed, or the `text` a hook
7957	* answered under its plugin's name; markdown, as the row draws it.
7958	*/
7959	text: string;
7960	/**
7961	* True when the row is the run's error line (a command that threw),
7962	* which draws in the error colour and not dim. Read-only.
7963	*/
7964	isErrored: boolean;
7965	/**
7966	* Which of its rows the transcript's viewport shows now: `null` while
7967	* drawn outside it, absent where the surface does not say. Read-only.
7968	*
7969	* Reported once drawn and again when it changes: on a scroll, for the
7970	* messages at the viewport's edges only. A rewrite carries it on as
7971	* received; one that changes or drops it is refused.
7972	*/
7973	onScreen?: OnScreen \| null;
7974	};
7975	/**
7976	* One row of the live tool-progress region under a running tool call; today
7977	* the run-in-background pill. One instance per row.
7978	*
7979	* A union on `kind`: other progress kinds join as their props become plain
7980	* data, each with its own fields, so a hook matches `{ props: { kind:
7981	* "background_hint" } }` or branches on `e.props.kind` and stays right.
7982	*
7983	* Raised on the terminal surface only.
7984	*/
7985	ToolProgress: {
7986	/**
7987	* The tool call the row belongs to, as `tool.call` and the `ToolUse` row
7988	* carry it. Read-only: a rewrite carries it on as received.
7989	*
7990	* While several foreground calls share one pill, the first of them.
7991	*/
7992	tool_use_id: string;
7993	/**
7994	* Which progress row: the run-in-background pill. Read-only.
7995	*/
7996	kind: 'background_hint';
7997	/**
7998	* The pill's text as the engine draws it, dim, under the tool call:
7999	* `(ctrl+b to run in background)`, or with the person's own binding.
8000	*
8001	* A rewrite is drawn in its place, dim; `""` draws nothing. A hook that
8002	* returns a tree draws that instead.
8003	*/
8004	hint: string;
8005	};
8006	/**
8007	* The line that animates while a turn runs (`Sauteing... (12s, 300
8008	* tokens)`); a remote surface draws its own.
8009	*
8010	* The row reads `word` (or `message` while one overrides it), then
8011	* `suffix`, then the dim parenthetical the engine keeps (elapsed time,
8012	* tokens, effort); a hook rewrites the first three or draws its own tree.
8013	*
8014	* Raised on the terminal surface only.
8015	*/
8016	Spinner: {
8017	/**
8018	* Animated by the line (`Sauteing`), as sampled for this turn.
8019	*/
8020	word: string;
8021	/**
8022	* The text drawn instead of the word while a state overrides it, else null.
8023	*/
8024	message: string \| null;
8025	/**
8026	* What the engine draws right after the word or message to say the turn is
8027	* still going: one ellipsis character.
8028	*
8029	* Left off a text that already ends in an ellipsis, so a rewritten
8030	* `message` ending in one shows one. A rewrite is drawn as given (`""`
8031	* draws the text bare, `" ~"` draws `Sauteing ~`); left out, the engine's.
8032	*/
8033	suffix: string;
8034	/**
8035	* What the turn is doing.
8036	*/
8037	mode: 'requesting' \| 'responding' \| 'thinking' \| 'tool-input' \| 'tool-use';
8038	};
8039	/**
8040	* The line that closes a turn in the transcript (`Baked for 3s`); a
8041	* remote surface draws its own footer.
8042	*
8043	* Raised on the terminal surface only.
8044	*/
8045	TurnDuration: {
8046	/**
8047	* The past-tense word the line drew (`Baked`), as sampled for this line.
8048	*/
8049	word: string;
8050	/**
8051	* The turn's duration in milliseconds, as the line formats it (`3s`,
8052	* `1m 4s`).
8053	*/
8054	durationMs: number;
8055	/**
8056	* Which of its rows the transcript's viewport shows now: `null` while
8057	* drawn outside it, absent where the surface does not say. Read-only.
8058	*
8059	* Reported once drawn and again when it changes: on a scroll, for the
8060	* messages at the viewport's edges only. A rewrite carries it on as
8061	* received; one that changes or drops it is refused.
8062	*/
8063	onScreen?: OnScreen \| null;
8064	};
8065	/**
8066	* One dim status line under the logo (the model source, an experiment
8067	* enrollment, a settings hint), with a trailing `/command`.
8068	*
8069	* Raised on the terminal surface only.
8070	*/
8071	InfoNotice: {
8072	/**
8073	* The notice's text, flattened to one string.
8074	*/
8075	text: string;
8076	/**
8077	* The slash command appended after the text, or null when the notice has
8078	* none.
8079	*/
8080	command: string \| null;
8081	/**
8082	* Which of its rows the transcript's viewport shows now: `null` while
8083	* drawn outside it, absent where the surface does not say. Read-only.
8084	*
8085	* Reported once drawn and again when it changes: on a scroll, for the
8086	* messages at the viewport's edges only. A rewrite carries it on as
8087	* received; one that changes or drops it is refused.
8088	*/
8089	onScreen?: OnScreen \| null;
8090	};
8091	/**
8092	* The dim mode labels at the right of the prompt footer (`focus`, `memory
8093	* paused`), joined by ` & `. One instance.
8094	*
8095	* A hook adds a mode by rewriting `modes`, removes one by filtering, or
8096	* draws its own tree.
8097	*
8098	* Raised on the terminal and desktop surfaces only.
8099	*/
8100	SessionMode: {
8101	/**
8102	* The labels the footer shows, in order; empty when there are none.
8103	*/
8104	modes: readonly string[];
8105	};
8106	/**
8107	* The dim hint line under the prompt (`? for shortcuts`, `esc to
8108	* interrupt`, the pills beside them). One instance.
8109	*
8110	* A hook rewrites `hint` and the rewrite is drawn in the line's place, or
8111	* draws its own tree; `isDraft` and `isWorking` say what the line is for.
8112	*
8113	* Raised on the terminal surface only.
8114	*/
8115	PromptHint: {
8116	/**
8117	* True while the prompt holds typed text. Read-only.
8118	*/
8119	isDraft: boolean;
8120	/**
8121	* True while a model turn is running. Read-only.
8122	*/
8123	isWorking: boolean;
8124	/**
8125	* The line's text as the engine draws it; one string, so a rewrite
8126	* replaces the line.
8127	*
8128	* Read from the drawn line the way the screen reader reads it, one space
8129	* between parts.
8130	*/
8131	hint: string;
8132	};
8133	/**
8134	* The band directly above the prompt input, where the surveys draw; the
8135	* engine draws nothing of its own here.
8136	*
8137	* A hook draws a tree, or passes; one instance. The person collapses it
8138	* (ctrl+x ctrl+a, `[-]`) or focuses it (a click, ctrl+x tab): an Input
8139	* types, a Button arms the hotkeys, a tree taller than it scrolls.
8140	*
8141	* Raised on the terminal surface only.
8142	*/
8143	AbovePrompt: {
8144	/**
8145	* True while a survey holds the band; a hook yields to it. Read-only.
8146	*/
8147	hasSurvey: boolean;
8148	/**
8149	* True while a model turn is running. Read-only.
8150	*/
8151	isWorking: boolean;
8152	/**
8153	* Rows the band may take: in fullscreen, what the bottom slot has left
8154	* above the prompt; otherwise the terminal's height. Read-only.
8155	*
8156	* That slot is capped at half the terminal's rows, the prompt's included.
8157	* A tree of at most `maxRows` rows shows whole; a taller one scrolls in a
8158	* window of `scroll.bodyRows`, and a bare digit arms no Button's hotkey.
8159	*/
8160	maxRows: number;
8161	/**
8162	* Cells across the band: the terminal's width, or the transcript
8163	* column's while a `Pane` is docked beside it. Read-only.
8164	*
8165	* A tree wider than this wraps or truncates as its Text props say; size
8166	* a table or a rule to it rather than to `viewport.columns`.
8167	*/
8168	bodyColumns: number;
8169	/**
8170	* The band's window over a tree taller than `maxRows`: engine-owned,
8171	* moved by the wheel, and by the person's keys while the band is focused.
8172	*
8173	* `bodyRows` is `maxRows` less the `n more` row. Read-only.
8174	*/
8175	scroll: SiteScroll;
8176	/**
8177	* Which transcript is on screen above the band: the main conversation's
8178	* (no `agentId`) or one agent's, opened from the tasks list.
8179	*
8180	* The same band under either; a switch re-runs the hook with the new
8181	* view. Read-only: a rewrite carries it on as received; one that changes
8182	* or drops it is refused, the hook that passed it failing.
8183	*/
8184	view: SiteView;
8185	};
8186	/**
8187	* The framed region a plugin opened with `$.ui.open({ id })`: one instance
8188	* per id (`requestId`), its body the hook's tree, one shown, the rest tabs.
8189	*
8190	* Placed by the surface (docked in fullscreen, else above the prompt) and
8191	* keyed by the person (ctrl+x tab, Esc), who closes it from the engine's mark
8192	* or ctrl+x x: `ui.close` with origin `person`, which a hook may refuse.
8193	*
8194	* Raised on every surface.
8195	*/
8196	Pane: {
8197	/**
8198	* Its tab's label while more than one pane is open (with one, the engine
8199	* draws no title): the `title` it was opened with, or its id.
8200	*
8201	* A click on a tab, or Tab onto it and Enter, shows that pane. Read-only
8202	* here; another `$.ui.open` (or a hook on `ui.open`) retitles.
8203	*/
8204	title: string;
8205	/**
8206	* True while the person has given the pane the keyboard: Tab walks its
8207	* elements, a Button's `hotkey` presses it, the arrows scroll. Read-only.
8208	*/
8209	isFocused: boolean;
8210	/**
8211	* Cells across the body, inside the frame. Read-only.
8212	*/
8213	bodyColumns: number;
8214	/**
8215	* Where the surface seated the pane: `dock` beside the transcript (the
8216	* terminal in fullscreen from 110 columns), or `inline` above the prompt.
8217	*
8218	* Read-only: a rewrite carries it on as received; one that changes or
8219	* drops it is refused, the hook that passed it failing.
8220	*/
8221	placement: 'dock' \| 'inline';
8222	/**
8223	* The body's window over the tree: engine-owned, moved by the person's
8224	* keys while the pane is focused. Read-only.
8225	*/
8226	scroll: SiteScroll;
8227	/**
8228	* Which transcript is on screen beside the pane: the main conversation's
8229	* (no `agentId`) or one agent's, opened from the tasks list.
8230	*
8231	* The pane stays open across a switch, one instance re-rendered for the
8232	* view, so a hook draws for the agent in view. Read-only: a rewrite carries
8233	* it on as received; one that changes or drops it is refused.
8234	*/
8235	view: SiteView;
8236	};
8237	};
8238
8239	/**
8240	* What a `ui.render` hook returns and what `next(e)` resolves to: a
8241	* RenderElement tree, the same for every component.
8242	*/
8243	export type RenderResultOf = {
8244	[C in RenderComponent]: RenderElement;
8245	};
8246
8247	/**
8248	* Where a render event's component is drawn: `terminal` is Ink, which draws
8249	* the hook's whole tree; the rest are remote surfaces drawing it themselves.
8250	*
8251	* `desktop` is Claude Code Desktop, `mobile` the Claude mobile app, `vscode`
8252	* Claude Code for VS Code. A remote surface asks over the wire (ui_render),
8253	* draws with the props the hook handed core, and draws the tree where it has
8254	* a slot for it.
8255	*
8256	* Each surface's ask is its own evaluation, since a tree may hold an element
8257	* only some surfaces draw (Svg, Client).
8258	*/
8259	export type RenderSurface = 'terminal' \| 'desktop' \| 'mobile' \| 'vscode';
8260
8261	/**
8262	* The size of what a surface draws into, in character cells of the
8263	* surface's monospace metric, and whether its layout docks a pane.
8264	*
8265	* On the terminal, the conversation's columns and screen rows; on a remote
8266	* surface, the pane's width and height over the advance and line height of
8267	* its code font. Cell-based until the first element lays out in pixels.
8268	*/
8269	export type RenderViewport = {
8270	/**
8271	* Cells across. A tree wider than this wraps or truncates, as its Text
8272	* props say.
8273	*/
8274	columns: number;
8275	/**
8276	* Cells down the whole surface, not the room left for this component.
8277	*
8278	* Informational: a change of height alone re-draws nothing and keys no
8279	* new evaluation, so a hook reads it as of the last width or props change.
8280	*/
8281	rows: number;
8282	/**
8283	* Whether this surface docks a pane beside the transcript, so a pane a
8284	* plugin opens unasked is a sidebar, not a takeover; absent is unknown.
8285	*
8286	* What `command.run`'s `presentation.isFullscreen` says. The terminal always
8287	* says: `true` fullscreen, `false` on the main screen, fixed per session; a
8288	* remote surface once its client reports it with the size, absent before.
8289	*
8290	* @remarks The desktop and VS Code report it once they place panes; the
8291	* mobile app, which has no dock, `false`. A change re-draws the sites.
8292	* @example if (e.viewport?.isFullscreen === true) void $.ui.open({ id })
8293	*/
8294	isFullscreen?: boolean;
8295	};
8296
8297	/**
8298	* The input of `ui.resolve`: which surface's elements, for which component;
8299	* a union with one member per surface (ResolveInputOf).
8300	*
8301	* Resolved when the plugins load, ahead of any drawing, so it names the
8302	* surface and the component and not the props; a `ui.render` argument is
8303	* one (it carries both), which is what `$.ui.resolve(e)` takes.
8304	*/
8305	export type ResolveInput<C extends RenderComponent = RenderComponent, P extends RenderSurface = RenderSurface> = P extends RenderSurface ? ResolveInputOf<C, P> : never;
8306
8307	/**
8308	* One `ui.resolve` input, for a component on one surface.
8309	*/
8310	export type ResolveInputOf<C extends RenderComponent, P extends RenderSurface> = {
8311	/**
8312	* Where the table draws; one literal per member, so a hook that narrows
8313	* it narrows the table `next(e)` resolves to.
8314	*/
8315	surface: P;
8316	/**
8317	* Which drawing the table is resolved for; the key a matcher narrows on.
8318	*/
8319	component: C;
8320	};
8321
8322	/**
8323	* What each event's hook returns, and what its `next(e)` resolves to, by event
8324	* name.
8325	*/
8326	export type ResultOf = EngineResultOf & ClassicResultOf & {
8327	[N in OpEventName]: OpEventResult<N>;
8328	} & {
8329	[N in NounEventName]: NounEventResult<N>;
8330	};
8331
8332	type SDKAssistantMessageError = 'authentication_failed' \| 'oauth_org_not_allowed' \| 'account_on_hold' \| 'verification_required' \| 'billing_error' \| 'rate_limit' \| 'overloaded' \| 'invalid_request' \| 'model_not_found' \| 'server_error' \| 'unknown' \| 'max_output_tokens' \| 'cloud_credential_error';
8333
8334	/**
8335	* The members of `T` assignable to `S`; all of `T` when none is.
8336	*/
8337	type Select<T, S> = [Extract<T, S>] extends [never] ? T : Extract<T, S>;
8338
8339	/**
8340	* The events a pattern selects, as a union of names: the one named, every
8341	* one under a glob's namespace, or every one a negation does not exclude.
8342	*/
8343	export type Selected<P extends string> = P extends '' ? EventName : P extends `!${infer Negated}` ? Exclude<EventName, Selected<Negated>> : P extends `${infer Prefix}.` ? Extract<EventName, `${Prefix}.${string}`> : Extract<EventName, P>;
8344
8345	/**
8346	* The literal each tag key of `I` is held to by matcher `M`: one-of arrays
8347	* flattened, RegExps widened to `unknown`.
8348	*/
8349	type Selection<I, M> = {
8350	[K in keyof M & TagKeys<I>]: Literal<M[K] extends readonly (infer One)[] ? One : M[K]>;
8351	};
8352
8353	/**
8354	* One option of a `Select`: the value `onSelect` and `ui.select` carry, and
8355	* the text drawn for it (the value when absent).
8356	*/
8357	export type SelectOption = {
8358	value: string;
8359	label?: string;
8360	};
8361
8362	/**
8363	* The props of `Select`, every surface's one-of-several picker: an address,
8364	* a label, the options, the one selected, the closure a pick runs. A leaf.
8365	*
8366	* Focused through the same ring as `Button` (`abovePrompt:focus`); keys reach
8367	* it only while it has focus (arrows move, Enter picks) and Esc always
8368	* returns to the prompt; a pick raises `ui.select`, its bottom `onSelect`.
8369	*/
8370	export type SelectProps = {
8371	/**
8372	* The element's address: `e.element` at `ui.select`, what a matcher names.
8373	*/
8374	key: string;
8375	/**
8376	* Text drawn before the current value.
8377	*/
8378	label?: string;
8379	/**
8380	* What can be picked, in the order drawn; at least one, values unique.
8381	*/
8382	options: readonly SelectOption[];
8383	/**
8384	* Which option is selected when drawn; the person's pick replaces it
8385	* until the hook draws another.
8386	*/
8387	value?: string;
8388	/**
8389	* The site's focus ring starts here when the site takes the keyboard,
8390	* instead of on nothing, as the DOM's `autofocus`: Enter acts on it at once.
8391	*
8392	* A pane opened with `focus`, or the person's focus chord or click, is the
8393	* take. Of several in one site the first drawn wins; it raises `ui.focus`,
8394	* origin this plugin. A ring the person has moved stays where it was put.
8395	*/
8396	autoFocus?: true;
8397	/**
8398	* Runs on a pick with the option's value, in the plugin's own environment:
8399	* the bottom of a `ui.select` chain. No model turn unless it asks one.
8400	*/
8401	onSelect: (value: string, e: UiSelectArgument) => void;
8402	};
8403
8404	/**
8405	* The input of `session.attach`: a surface joined the session's roster of
8406	* attached clients (a phone opened the session; the desktop app connected).
8407	*
8408	* A remote client attaches by saying so (ui_attach) or by its first ask to
8409	* draw; the terminal's attachment is the REPL's binding and raises nothing.
8410	* Every field is the engine's: a hook observes, `next(e)` passes them on.
8411	*/
8412	export type SessionAttachInput = {
8413	/**
8414	* Where the client draws: what it declared, a rendering fact.
8415	*/
8416	surface: RenderSurface;
8417	/**
8418	* The client's own id, unique in the roster; two phones are two clients on
8419	* one surface. A client that never named itself is `<surface>:default`.
8420	*/
8421	clientId: string;
8422	/**
8423	* The size the client draws into, in character cells, and whether its
8424	* layout docks a pane, when it said.
8425	*/
8426	viewport?: RenderViewport;
8427	};
8428
8429	/**
8430	* What a `session.attach` hook returns and what `next(e)` resolves to:
8431	* `{ clientId }`, echoed by core; a hook's own value changes nothing.
8432	*/
8433	export type SessionAttachResult = {
8434	clientId: string;
8435	};
8436
8437	/**
8438	* What `$.session.authorize()` answers: an opaque handle for the session's
8439	* Anthropic credential and its kind, or null when there is none to hold.
8440	*
8441	* The secret itself stays with the engine; the handle is its plugin-side
8442	* face, spent through `$.http.fetch(url, { auth: handle })`.
8443	*/
8444	export type SessionAuthorization = {
8445	handle: string;
8446	kind: 'bearer' \| 'api-key';
8447	} \| null;
8448
8449	/**
8450	* `session.compact`'s input as a plugin's `$.session.compact(args)` takes
8451	* it: `trigger` (`plugin`), `messages` and `agentId` are the engine's.
8452	*/
8453	export type SessionCompactArgs = {
8454	/**
8455	* What the summary should keep or stress, as typed after `/compact`;
8456	* absent, the engine's own compaction prompt alone.
8457	*/
8458	instructions?: string;
8459	};
8460
8461	/**
8462	* A compaction that stands: the conversation as it reads afterwards, and
8463	* the token counts the engine recorded when it was the one compacting.
8464	*/
8465	export type SessionCompacted = {
8466	/**
8467	* The conversation after the compaction, oldest first: from core, its
8468	* summary and the messages it kept; from a hook, whatever it hands up.
8469	*
8470	* What the transcript becomes (kept, on `precompute`, for the compaction
8471	* that comes). A message with the engine's `handle` stands as the engine
8472	* has it; one without is built from its `role`, `text` and tool blocks.
8473	*/
8474	messages: readonly SessionMessage[];
8475	/**
8476	* The conversation's size before, in tokens; absent when core did not
8477	* record it.
8478	*/
8479	tokensBefore?: number;
8480	/**
8481	* Its size afterwards, in tokens; absent on `precompute` and when core
8482	* did not record it.
8483	*/
8484	tokensAfter?: number;
8485	skip?: undefined;
8486	};
8487
8488	/**
8489	* The input of `session.compact`: one compaction of the conversation, about
8490	* to run; `messages` is the transcript it runs over.
8491	*/
8492	export type SessionCompactInput = {
8493	/**
8494	* What is compacting (SessionCompactTrigger); the key a matcher narrows
8495	* on. Pinned: `next(e)` passes it on as received.
8496	*/
8497	trigger: SessionCompactTrigger;
8498	/**
8499	* The id of the loop compacting, for a subagent's or a fork's own
8500	* transcript; absent for the main conversation (tool.call's `agentId`).
8501	*
8502	* Pinned: left out of a rewrite it is put back, changed it fails the hook.
8503	* `$.session.messages()` is the main conversation whatever this names.
8504	*/
8505	agentId?: string;
8506	/**
8507	* What the summary should keep or stress: the text after `/compact`, a
8508	* plugin's, or absent.
8509	*
8510	* `next({ ...e, instructions })` changes what the summarizer is told.
8511	*/
8512	instructions?: string;
8513	/**
8514	* The transcript being compacted, in `$.session.messages()`'s shape, each
8515	* message carrying the engine's `handle`; a subagent's own under `agentId`.
8516	*
8517	* `next({ ...e, messages })` changes what is summarized: a message kept
8518	* with its handle is the engine's own, whole; one without is read as built.
8519	*/
8520	messages: readonly SessionMessage[];
8521	};
8522
8523	/**
8524	* What a `session.compact` hook returns and what `next(e)` resolves to: the
8525	* compaction (`{ messages, tokensBefore?, tokensAfter? }`) or `{ skip }`.
8526	*
8527	* There is no summary string: the summary is a message.
8528	*/
8529	export type SessionCompactResult = SessionCompacted \| SessionCompactSkipped;
8530
8531	/**
8532	* A compaction vetoed: on `precompute` nothing is computed or kept; on any
8533	* other trigger the conversation stays as it is and one line says why.
8534	*
8535	* Core answers it too, when a classic PreCompact hook blocks.
8536	*/
8537	export type SessionCompactSkipped = {
8538	/**
8539	* Why, as the notice reads.
8540	*/
8541	skip: string;
8542	messages?: undefined;
8543	};
8544
8545	/**
8546	* Who compacts: the person's `/compact` (`manual`), the engine at its
8547	* threshold or on a prompt too long (`auto`), a plugin, or a `precompute`.
8548	*
8549	* `precompute` is the one dispatch that installs nothing: its result is kept
8550	* for the compaction that comes, if the conversation it ran over still leads.
8551	*/
8552	export type SessionCompactTrigger = 'manual' \| 'auto' \| 'plugin' \| 'precompute';
8553
8554	/**
8555	* The context window broken down as /context breaks it down: the rows, the
8556	* grid and the lists beneath it, in the SDK's `get_context_usage` shape.
8557	*
8558	* Less that reply's internal-build sections. Token counts are the engine's
8559	* estimates as numbers, never formatted: a `full` breakdown counts with the
8560	* token-count API where it can, a `summary` one estimates throughout.
8561	*/
8562	export type SessionContextBreakdown = {
8563	/**
8564	* One row per category, the free space and the compaction buffer among
8565	* them; `kind` says which is which.
8566	*/
8567	categories: ContextCategory[];
8568	/**
8569	* Tokens in use, unclamped: past `rawMaxTokens` when over the window.
8570	*/
8571	totalTokens: number;
8572	/**
8573	* The window measured against, the same figure as `rawMaxTokens`.
8574	*/
8575	maxTokens: number;
8576	/**
8577	* The window measured against, in tokens: the model's limit, or a smaller
8578	* compaction window (`autocompactSource` says which).
8579	*/
8580	rawMaxTokens: number;
8581	/**
8582	* How that window was settled (ContextWindowSource); the SDK's reply
8583	* carries it under this name too, outside its typed schema.
8584	*/
8585	autocompactSource: ContextWindowSource;
8586	/**
8587	* `totalTokens` over `rawMaxTokens` as a whole percentage, 0 to 100 and
8588	* past it when over.
8589	*/
8590	percentage: number;
8591	/**
8592	* The grid, row by row: 10 by 10, 20 by 10 for a window of a million or
8593	* more, 5 wide when asked for under 80 `columns`.
8594	*/
8595	gridRows: ContextGridSquare[][];
8596	/**
8597	* Which model the breakdown was computed for, as `/model` shows it.
8598	*/
8599	model: string;
8600	/**
8601	* Each memory file in the context, with its path and tokens.
8602	*/
8603	memoryFiles: ContextMemoryFile[];
8604	/**
8605	* Each MCP tool's schema, with its server and tokens.
8606	*/
8607	mcpTools: ContextMcpTool[];
8608	/**
8609	* The custom agents the Agent tool describes, each with its tokens.
8610	*/
8611	agents: ContextAgent[];
8612	/**
8613	* The slash-command listing, counted; absent when the session lists none.
8614	*/
8615	slashCommands?: ContextSlashCommands;
8616	/**
8617	* The skill listing, counted, with one entry per skill; absent when the
8618	* session lists none.
8619	*/
8620	skills?: ContextSkills;
8621	/**
8622	* The token count at which auto-compaction runs; absent when it is off.
8623	*/
8624	autoCompactThreshold?: number;
8625	/**
8626	* Whether auto-compaction is on for the session.
8627	*/
8628	isAutoCompactEnabled: boolean;
8629	/**
8630	* The last response's own token counts, or null before one came back.
8631	*/
8632	apiUsage: ContextApiUsage \| null;
8633	};
8634
8635	/**
8636	* The live context window as the status line reads it, and by category as
8637	* /context breaks it down when the call asked (`{ breakdown }`).
8638	*
8639	* `tokens` and `percent` are the last API response's input side against the
8640	* model's window, absent until the first response of the live window: a
8641	* fresh session, or one just compacted, until its next response.
8642	*/
8643	export type SessionContextUsage = {
8644	/**
8645	* Input tokens the last response was answered over: uncached, cache-written
8646	* and cache-read together (the status line's `total_input_tokens`).
8647	*/
8648	tokens?: number;
8649	/**
8650	* The context window of the session's model, in tokens (the status line's
8651	* `context_window_size`).
8652	*/
8653	window: number;
8654	/**
8655	* `tokens` over `window` as a whole percentage, 0 to 100 (the status
8656	* line's `used_percentage`).
8657	*/
8658	percent?: number;
8659	/**
8660	* The window by category, as /context breaks it down: present only when
8661	* the call passed `breakdown`, and only with a session bound.
8662	*
8663	* It measures against the compaction window (`rawMaxTokens`), which may be
8664	* smaller than `window`, and estimates every category, so its
8665	* `totalTokens` need not equal `tokens`.
8666	*/
8667	breakdown?: SessionContextBreakdown;
8668	};
8669
8670	/**
8671	* What the session has cost, as `/cost` and the status line total it.
8672	*/
8673	export type SessionCost = {
8674	/**
8675	* US dollars, summed over every priced API response this session.
8676	*/
8677	usd: number;
8678	};
8679
8680	type SessionCronSummary = {
8681	id: string;
8682	/**
8683	* Cron expression, e.g. "0 9 * * 1-5".
8684	*/
8685	schedule: string;
8686	/**
8687	* False for one-shot wakeups whose cron field encodes a single fire time; true for tasks that re-fire on every match.
8688	*/
8689	recurring: boolean;
8690	/**
8691	* Prompt text submitted when the cron fires. Capped at 1000 chars; clipped values append an in-string "... [+N chars]" marker.
8692	*/
8693	prompt: string;
8694	};
8695
8696	/**
8697	* The input of `session.detach`: a client left the session's roster. Every
8698	* field is the engine's: a hook observes, and `next(e)` passes them on.
8699	*/
8700	export type SessionDetachInput = {
8701	/**
8702	* Where the client drew.
8703	*/
8704	surface: RenderSurface;
8705	/**
8706	* The id it attached under.
8707	*/
8708	clientId: string;
8709	/**
8710	* Why it left: it detached, or the session ended under it.
8711	*/
8712	reason: SessionDetachReason;
8713	};
8714
8715	/**
8716	* Why a client left the roster: `detach`, it said so (ui_detach); `end`, the
8717	* session ended with it still attached.
8718	*/
8719	export type SessionDetachReason = 'detach' \| 'end';
8720
8721	/**
8722	* What a `session.detach` hook returns and what `next(e)` resolves to:
8723	* `{ clientId }`, echoed by core; a hook's own value changes nothing.
8724	*/
8725	export type SessionDetachResult = {
8726	clientId: string;
8727	};
8728
8729	type SessionEndHookInput = BaseHookInput & {
8730	hook_event_name: 'SessionEnd';
8731	reason: ExitReason;
8732	};
8733
8734	/**
8735	* The input of `session.end`: the session is ending, why, and how to come back
8736	* to it.
8737	*
8738	* Every field is the engine's: a hook observes, and `next(e)` passes them on.
8739	*/
8740	export type SessionEndInput = {
8741	/**
8742	* Why it ends (SessionEndReason), the word the classic SessionEnd hook
8743	* receives as its `reason`.
8744	*/
8745	reason: SessionEndReason;
8746	/**
8747	* The ending session's id (`$.session.id()` until now); after a `/clear`
8748	* or a resume the process goes on under another.
8749	*/
8750	sessionId: string;
8751	/**
8752	* What `claude --resume` takes to return to it.
8753	*/
8754	resume: SessionResume;
8755	};
8756
8757	/**
8758	* Why the session ended: the classic SessionEnd hook's own `reason`, word for
8759	* word.
8760	*
8761	* `prompt_input_exit`, the person left (/exit, ctrl+c, ctrl+d); `clear`, a
8762	* /clear started a fresh one; `resume`, another took its place; `logout`;
8763	* `other`, a `-p` run finished or the process got SIGINT, SIGTERM or SIGHUP.
8764	*/
8765	export type SessionEndReason = ClassicHookInputs['SessionEnd']['reason'];
8766
8767	/**
8768	* What a `session.end` hook returns and what `next(e)` resolves to:
8769	* `{ sessionId }`, echoed by core; a hook's own value changes nothing.
8770	*/
8771	export type SessionEndResult = {
8772	sessionId: string;
8773	};
8774
8775	/**
8776	* The input of `session.measure`: what `$.session.usage()` answers at this
8777	* moment, and which of its units moved since the last measurement a hook saw.
8778	*
8779	* The same figures the op reads, without `context.breakdown`: call
8780	* `$.session.usage({ breakdown })` from the hook when the categories matter.
8781	* Every field is the engine's: a hook observes, and `next(e)` passes them on.
8782	*/
8783	export type SessionMeasureInput = {
8784	/**
8785	* The live context window (`$.session.usage()`'s `context`): the window,
8786	* and its fill once a response of the live window reported one.
8787	*
8788	* Never carries `breakdown` here.
8789	*/
8790	context: SessionContextUsage;
8791	/**
8792	* The rate-limit windows the last response reported, each with its
8793	* `percentUsed`; empty off a subscription or before the first reading.
8794	*/
8795	rateLimits: SessionRateLimit[];
8796	/**
8797	* What the session has cost so far; absent where the host keeps no ledger.
8798	*/
8799	cost?: SessionCost;
8800	/**
8801	* Which units differ from the last measurement raised (UsageUnit), never
8802	* empty; the first measurement names every unit it has a figure for.
8803	*
8804	* `context`: the fill moved; `rateLimits`: a window moved a whole point,
8805	* appeared or left, or the account's limit status changed; `cost`: the
8806	* total grew.
8807	*/
8808	changed: UsageUnit[];
8809	};
8810
8811	/**
8812	* What a `session.measure` hook returns and what `next(e)` resolves to:
8813	* `{ changed }`, echoed by core; a hook's own value changes nothing.
8814	*/
8815	export type SessionMeasureResult = {
8816	changed: UsageUnit[];
8817	};
8818
8819	/**
8820	* One message of the transcript as `$.session.messages()` returns it.
8821	*/
8822	export type SessionMessage = {
8823	/**
8824	* Who wrote it.
8825	*/
8826	role: 'user' \| 'assistant';
8827	/**
8828	* Its text blocks joined; '' when it has none.
8829	*/
8830	text: string;
8831	/**
8832	* The tool_use blocks of an assistant message, each with its outcome
8833	* (`result`, `text`, `isError`) once the transcript holds it.
8834	*/
8835	toolUses: ToolUseSummary[];
8836	/**
8837	* The tool_result blocks of a user message: `{ tool_use_id, text, isError,
8838	* result }`.
8839	*/
8840	toolResults?: ToolResultSummary[];
8841	/**
8842	* An opaque token the engine stamps on a message it hands a
8843	* `session.compact` hook, so a list handed back maps to its own messages.
8844	*
8845	* Absent on `$.session.messages()` and on a message a hook built.
8846	*/
8847	handle?: string;
8848	};
8849
8850	/**
8851	* One rate-limit window as the rate-limit notices read it.
8852	*/
8853	export type SessionRateLimit = {
8854	/**
8855	* Which window: `five_hour`, `seven_day`, or a Claude gateway's
8856	* `spend_limit`.
8857	*/
8858	kind: string;
8859	/**
8860	* How much of the window is used, 0 to 100 with at most one decimal:
8861	* 23.5, or 7, never 7.000000000000001; past 100 on an exceeded spend limit.
8862	*/
8863	percentUsed: number;
8864	/**
8865	* When the window resets, as an ISO 8601 timestamp.
8866	*/
8867	resetsAt?: string;
8868	};
8869
8870	/**
8871	* An external-event wake the delivery's text parsed as (a GitHub relay
8872	* event, a signal's notice): the envelope's attributes and its JSON body.
8873	*/
8874	export type SessionReceiveEvent = {
8875	/**
8876	* The producing service (`github`).
8877	*/
8878	source: string;
8879	/**
8880	* The event's discriminator (`pull_request.closed`, `check_suite`).
8881	*/
8882	kind: string;
8883	/**
8884	* The envelope's JSON body (`{ pr: "acme/app#12", outcome: "merged" }`).
8885	*/
8886	data: Record<string, unknown>;
8887	/**
8888	* The `data` keys whose values are free text a third party wrote (a
8889	* commenter's `author` and `comment`), as the producer marked them.
8890	*
8891	* Empty when none; the server asserts every other key's value, not these.
8892	*/
8893	untrustedKeys: readonly string[];
8894	};
8895
8896	/**
8897	* The input of `session.receive`: one inbound delivery (a relay's event, a
8898	* peer's message, a Remote Control prompt), sanitized, before it is queued.
8899	*/
8900	export type SessionReceiveInput = {
8901	/**
8902	* Where the delivery came from, as the bridge classified it; the key a
8903	* matcher narrows on. `next(e)` passes it on as received.
8904	*/
8905	origin: SessionReceiveOrigin;
8906	/**
8907	* The delivery's body as the model would read it (a content-block
8908	* delivery's text blocks, joined).
8909	*/
8910	text: string;
8911	/**
8912	* The external-event wake the text parsed as (`source` `github` for a
8913	* subscribed pull request's event); passed on as received.
8914	*
8915	* Present only for a delivery the server itself rendered as a wake (a
8916	* webhook relay, the session inbox), by its asserted origin; anyone else's
8917	* wake-shaped text stays `text`. Its `untrustedKeys` name third-party text.
8918	*/
8919	event?: SessionReceiveEvent;
8920	};
8921
8922	/**
8923	* Where an inbound delivery came from, as the bridge classified it from the
8924	* server's stamps: `prompt.submit`'s `e.origin`, less what never arrives.
8925	*/
8926	export type SessionReceiveOrigin = {
8927	/**
8928	* `bridge` the user's own from a Remote Control client; `peer` another
8929	* session; `unclassified` one the bridge could not place.
8930	*
8931	* `task-notification` a relay's event (a GitHub webhook) or a trigger;
8932	* `scheduled-trigger` a routine; `peer-send-message` another session's
8933	* SendMessage; `projects-relay` and `slack-ping` as at `prompt.submit`.
8934	*/
8935	kind: 'bridge' \| 'task-notification' \| 'scheduled-trigger' \| 'peer' \| 'peer-send-message' \| 'projects-relay' \| 'slack-ping' \| 'unclassified';
8936	};
8937
8938	/**
8939	* What a `session.receive` hook returns and what `next(e)` resolves to: the
8940	* delivery that was queued, `{ text }`, or `{ consumed: reason }`.
8941	*
8942	* `next(e)` resolves once the delivery is queued; a hook answering without
8943	* `next` queues nothing.
8944	*/
8945	export type SessionReceiveResult = {
8946	/**
8947	* The body the delivery was queued with; from core, `e.text` as it
8948	* arrived at the bottom.
8949	*
8950	* A rewrite passes it down, `next({ ...e, text })`.
8951	*/
8952	text: string;
8953	consumed?: undefined;
8954	} \| {
8955	/**
8956	* Takes the delivery, answered without `next`: it is not queued, not
8957	* written to the transcript and never reaches the model.
8958	*
8959	* The reason is logged, the plugin named.
8960	*/
8961	consumed: string;
8962	text?: undefined;
8963	};
8964
8965	/**
8966	* What `$.session.repo()` answers: the repository's root and its origin remote,
8967	* when the session is in one.
8968	*/
8969	export type SessionRepo = {
8970	/**
8971	* The repository's root, absolute: the main working tree's for a worktree.
8972	*/
8973	root: string;
8974	/**
8975	* The `origin` remote's URL as git has it (push URL preferred), or null when
8976	* the repository has none.
8977	*/
8978	remote: string \| null;
8979	/**
8980	* Whether the remote is one of the repositories this build treats as its
8981	* own; false in a build that has none or when the remote is unrecognized.
8982	*
8983	* The engine matches the build's own list of repositories with its
8984	* hardened remote parser. A plugin reads this to behave differently in a
8985	* public repository; which repositories are the build's is its to say.
8986	*/
8987	internal: boolean;
8988	/**
8989	* The repository the allowlist matched, as `owner/name`; null when
8990	* `internal` is false.
8991	*
8992	* A working copy without a remote that the engine still recognises is
8993	* named by its own checkout configuration; a remote's name is its path.
8994	*/
8995	name: string \| null;
8996	};
8997
8998	/**
8999	* How to come back to the session that ended: what `claude --resume` takes.
9000	*/
9001	export type SessionResume = {
9002	/**
9003	* What `claude --resume <id>` takes, the ending session's own.
9004	*
9005	* It resumes a session that wrote a transcript: one that never ran a
9006	* prompt, or ran with persistence off, left nothing under this id.
9007	*/
9008	id: string;
9009	};
9010
9011	type SessionStartHookInput = BaseHookInput & {
9012	hook_event_name: 'SessionStart';
9013	source: 'startup' \| 'resume' \| 'clear' \| 'compact' \| 'fork';
9014	agent_type?: string;
9015	model?: string;
9016	session_title?: string;
9017	/**
9018	* resume/fork: seconds since the resumed transcript's last assistant response
9019	*/
9020	seconds_since_last_response?: number;
9021	/**
9022	* resume/fork: the resumed transcript's last response input + cache_read + cache_creation + output tokens (for a server-side tool loop, its last iteration's window, not the summed totals)
9023	*/
9024	context_tokens?: number;
9025	/**
9026	* resume/fork: seconds_since_last_response exceeds the prompt-cache TTL, so the first request re-caches context_tokens
9027	*/
9028	prompt_cache_likely_expired?: boolean;
9029	/**
9030	* resume/fork: estimated cost of re-caching context_tokens on the session model - the managed modelPricing when set, otherwise list price; excludes the response
9031	*/
9032	estimated_cache_write_usd?: number;
9033	};
9034
9035	/**
9036	* The input of `session.start`: the session the process starts with, read the
9037	* way `$.session` reads it at that moment.
9038	*/
9039	export type SessionStartInput = {
9040	/**
9041	* The directory the session runs in, absolute (`$.session.cwd()`).
9042	*/
9043	cwd: string;
9044	/**
9045	* Where the session draws at start (`$.session.surfaces()[0]`): `terminal`
9046	* under the REPL; null for a `-p` run or the SDK, which draw nowhere yet.
9047	*/
9048	surface: RenderSurface \| null;
9049	/**
9050	* Whether a person is at the prompt: true under the REPL, false for a `-p`
9051	* run or the SDK.
9052	*/
9053	isInteractive: boolean;
9054	};
9055
9056	/**
9057	* What a `session.start` hook returns and what `next(e)` resolves to:
9058	* `{ cwd }`, echoed by core; a hook's own value does not change the session.
9059	*/
9060	export type SessionStartResult = {
9061	cwd: string;
9062	};
9063
9064	/**
9065	* What `$.session.usage()` answers: the context window's fill, the account's
9066	* rate-limit windows and the session's cost, as the status line has them.
9067	*
9068	* A figure the engine does not have is left out, never zeroed: `rateLimits`
9069	* is empty off a subscription, `cost` absent where the host keeps no ledger.
9070	*/
9071	export type SessionUsage = {
9072	/**
9073	* The live context window: the status line's `context_window` figures.
9074	*/
9075	context: SessionContextUsage;
9076	/**
9077	* The rate-limit windows the last API response reported (`five_hour`,
9078	* `seven_day`, a gateway's `spend_limit`); empty when none has a reading.
9079	*/
9080	rateLimits: SessionRateLimit[];
9081	/**
9082	* What the session has cost so far, as /cost totals it; absent only where
9083	* the host keeps no cost ledger (the CLI always has one).
9084	*/
9085	cost?: SessionCost;
9086	};
9087
9088	/**
9089	* What `$.session.usage(args)` takes: nothing for the status line's figures
9090	* alone; `breakdown` to have the window broken down as /context breaks it.
9091	*/
9092	export type SessionUsageArgs = {
9093	/**
9094	* Asks for `context.breakdown` and says how it is counted
9095	* (ContextBreakdownDetail); absent, none is computed and the call is free.
9096	*
9097	* `full` sends one token-count request per tool and memory file, as
9098	* /context does; `summary` estimates locally and sends none.
9099	*/
9100	breakdown?: ContextBreakdownDetail;
9101	/**
9102	* The width the breakdown's grid will be drawn in, in terminal columns;
9103	* absent, the full-width grid. Read only with `breakdown`.
9104	*
9105	* Under 80 the grid is the narrow one /context draws there, 5 wide. A thin
9106	* client's breakdown is the remote workspace's, whose grid ignores this.
9107	*/
9108	columns?: number;
9109	};
9110
9111	/**
9112	* What `$.session.version()` answers: the version of the engine the session
9113	* runs on, the release that version is built from, and when it was built.
9114	*
9115	* The three are what the engine's own analytics rows carry as `version`,
9116	* `version_base` and `build_time`, so a row a plugin sends and a row the
9117	* engine sends from the same binary agree.
9118	*/
9119	export type SessionVersion = {
9120	/**
9121	* The engine's full version, as `claude --version` prints it: a release's
9122	* (`2.1.280`) or a development build's, which adds the build's date, time
9123	* and commit (`2.1.280-dev.20260920.t101500.sha1a2b3c4`).
9124	*/
9125	version: string;
9126	/**
9127	* The release the version is built from, its semantic core and channel:
9128	* `2.1.280` for that release, `2.1.280-dev` for a development build of it.
9129	* Absent when the version is not spelled as a release.
9130	*/
9131	base?: string;
9132	/**
9133	* When the binary was built, an ISO 8601 timestamp
9134	* (`2026-09-20T10:15:00Z`). Absent in a run from source that stamps none.
9135	*/
9136	builtAt?: string;
9137	};
9138
9139	/**
9140	* What `$.settings.read` answers: an object keyed as a settings.json is
9141	* (`permissions`, `env`, `hooks`, `model`, `enabledPlugins`, ...).
9142	*
9143	* Each key is as https://code.claude.com/docs/en/settings documents it and
9144	* https://json.schemastore.org/claude-code-settings.json types it. A
9145	* snapshot in plain data: a write to it changes nothing the engine reads.
9146	*/
9147	export type Settings = Readonly<Record<string, unknown>>;
9148
9149	/**
9150	* What `$.settings.read(args)` takes.
9151	*/
9152	export type SettingsReadArgs = {
9153	/**
9154	* The one source read, as loaded; absent, the settings merged over every
9155	* source, as the engine runs under them.
9156	*/
9157	source?: SettingsSource;
9158	};
9159
9160	/**
9161	* One source of settings by the name a plugin gives it, lowest precedence
9162	* first; the engine's own name is the same word with `Settings` appended.
9163	*
9164	* `user` is ~/.claude/settings.json, `project` .claude/settings.json,
9165	* `local` .claude/settings.local.json, `flag` what `--settings` and the
9166	* SDK's inline settings carry, and `policy` the managed settings, every
9167	* managed tier merged.
9168	*/
9169	export type SettingsSource = 'user' \| 'project' \| 'local' \| 'flag' \| 'policy';
9170
9171	type SetupHookInput = BaseHookInput & {
9172	hook_event_name: 'Setup';
9173	trigger: 'init' \| 'maintenance';
9174	};
9175
9176	/**
9177	* Where a site's window sits over the tree a hook drew in it (a pane's body,
9178	* the band): the engine's to move (the person scrolls), the plugin's to read.
9179	*/
9180	export type SiteScroll = {
9181	/**
9182	* The first row of the tree the window shows; 0 at the top. Read-only.
9183	*/
9184	offset: number;
9185	/**
9186	* How many rows of the tree the window shows at once: the rows the
9187	* surface gave the body. Read-only.
9188	*/
9189	bodyRows: number;
9190	};
9191
9192	/**
9193	* Which transcript the person has on screen where a site draws: the main
9194	* conversation's, or one agent's, opened from the tasks list.
9195	*
9196	* The person's to switch, the plugin's to read: a switch re-runs the site's
9197	* hooks with the new view, the site itself staying where it is.
9198	*/
9199	export type SiteView = {
9200	/**
9201	* The agent whose transcript is in view: the `id` `$.agent.list()` gives
9202	* it, the `agentId` its `turn.step` and `tool.call` events carry.
9203	*
9204	* Absent while the main conversation is in view. Read-only.
9205	*/
9206	agentId?: string;
9207	};
9208
9209	/**
9210	* The input of `skill.prompt`: one skill's prompt, at the moment the engine
9211	* expanded it for the model.
9212	*
9213	* Typed as `/name`, called through the Skill tool, or preloaded into a
9214	* subagent: the same event at each.
9215	*/
9216	export type SkillPromptInput = {
9217	/**
9218	* Which skill (`commit`); the key a matcher narrows on.
9219	*/
9220	skill: string;
9221	/**
9222	* The prompt's text as the skill computed it (its text blocks, joined).
9223	*/
9224	text: string;
9225	};
9226
9227	/**
9228	* What a `skill.prompt` hook returns: the text the model reads for that
9229	* skill.
9230	*/
9231	export type SkillPromptResult = {
9232	text: string;
9233	};
9234
9235	/**
9236	* Options of `$.clock.sleep`.
9237	*/
9238	export type SleepOptions = {
9239	/**
9240	* Aborting it rejects the sleep at once.
9241	*/
9242	signal?: AbortSignal;
9243	};
9244
9245	/**
9246	* Options of `$.audio.speak`.
9247	*/
9248	export type SpeakOptions = {
9249	/**
9250	* The system voice's exact name as the platform lists it (`Samantha`, or the
9251	* name of a voice you installed). Absent: the synthesizer's default voice.
9252	*/
9253	voice?: string;
9254	};
9255
9256	/**
9257	* The argument of `$.audio.speak(text, options)` as the event carries it.
9258	*/
9259	type SpeakRequest = SpeakOptions & {
9260	/**
9261	* What to say, as plain text, of at most 4096 characters.
9262	*/
9263	text: string;
9264	};
9265
9266	/**
9267	* What `$.audio.speak` resolves with once the utterance has ended.
9268	*/
9269	export type SpeakResult = {
9270	/**
9271	* Which synthesizer spoke: `system`, the platform's own (`say` on macOS).
9272	*/
9273	via: 'system';
9274	};
9275
9276	/**
9277	* `next` in a `*` hook: the set of events is open at runtime, so `e` is
9278	* `unknown` until `next.is(pattern, e)` narrows it to events it knows.
9279	*
9280	* The callable is an overload per known event (OrderedOverloads), then
9281	* `(e: unknown) => Promise<unknown>` last: `next(e)` with `e` still unknown
9282	* resolves to `unknown`.
9283	*/
9284	export type StarNext = OrderedOverloads<EventName> & {
9285	(e: unknown): Promise<unknown>;
9286	/**
9287	* Continues this dispatch at a tier, as Next's `to` (a managed hook's):
9288	* `e` still unknown resolves to `unknown`.
9289	*/
9290	readonly to: (e: unknown, tier: TargetTier) => Promise<unknown>;
9291	readonly signal: AbortSignal;
9292	readonly is: <M extends Pattern>(pattern: M, e: unknown) => e is Frozen<Args<Selected<M>>>;
9293	readonly event: EventName;
9294	readonly origin: Origin;
9295	readonly trace: readonly TraceEntry<EventName, unknown, unknown>[];
9296	readonly budget: NextBudget;
9297	};
9298
9299	type StopFailureHookInput = BaseHookInput & {
9300	hook_event_name: 'StopFailure';
9301	error: SDKAssistantMessageError;
9302	error_details?: string;
9303	last_assistant_message?: string;
9304	};
9305
9306	type StopHookInput = BaseHookInput & {
9307	hook_event_name: 'Stop';
9308	stop_hook_active: boolean;
9309	/**
9310	* Text content of the last assistant message before stopping. Avoids the need to read and parse the transcript file.
9311	*/
9312	last_assistant_message?: string;
9313	/**
9314	* In-flight background work (running/pending + backgrounded) registered in this session. Lets hooks distinguish "session is done" from "session is paused waiting for background work to wake it". Empty array when nothing is in flight.
9315	*/
9316	background_tasks?: BackgroundTaskSummary[];
9317	/**
9318	* Session-scoped cron tasks (CronCreate, ScheduleWakeup, /loop) that will wake this session later. Empty array when none are scheduled.
9319	*/
9320	session_crons?: SessionCronSummary[];
9321	};
9322
9323	/**
9324	* The hook a streaming event takes: `async function* ($, e, next) {}`,
9325	* yielding the event's chunks and returning its result.
9326	*
9327	* `return yield* next(e)` passes; `for await (const c of next(e)) yield
9328	* f(c)` transforms; yielding without `next` answers alone. A chunk yielded
9329	* stays: a hook that fails mid-stream is left, the rest from beneath it.
9330	*
9331	* @example on('turn.step', async function* ($, e, next) {
9332	* const r = yield* next(e); return { ...r } })
9333	*/
9334	export type StreamHook<N extends StreamingEventName> = ($: EngineInterface, e: Frozen<Args<N>>, next: StreamNext<N>) => StreamHookBody<Chunk<N>, EventResult<N>>;
9335
9336	/**
9337	* What a hook on a streaming event evaluates to: the async generator an
9338	* `async function*` makes, yielding `C` and returning `R` or nothing.
9339	*
9340	* Returning nothing lets its last `next(e)`'s result stand. A plain
9341	* function is a type error here even when it returns `next(e)`: the hook
9342	* is the generator, not a function that hands one back.
9343	*/
9344	export type StreamHookBody<C, R> = AsyncGenerator<C, R \| void> & {
9345	/**
9346	* Absent on a generator; present on `next(e)`, which is not a hook body.
9347	*/
9348	readonly result?: never;
9349	};
9350
9351	/**
9352	* The events that stream: their hooks are async generators, `next(e)` is
9353	* the stream of everything beneath, and the result is what it returns.
9354	*
9355	* `turn.step` alone: the model's response arrives in pieces, and a hook
9356	* that saw it whole could not change what had already been shown.
9357	*/
9358	export type StreamingEventName = 'turn.step';
9359
9360	/**
9361	* The rest of the chain as a hook on a streaming event receives it: Next,
9362	* except that `next(e)` is the stream beneath (HookStream), not a promise.
9363	*
9364	* Each call opens a fresh stream; for `turn.step` each is a model request,
9365	* so a hook that calls it twice makes two. Not calling it yields the hook's
9366	* own chunks and returns its own result, and nothing beneath runs.
9367	*
9368	* @template S what `next.is(pattern, e)` narrows `e` to, as Next's
9369	* @see HookBudget `ms`: the hook's budget counts its own code, never a wait
9370	* at a `yield` or on this stream, however long the response beneath takes
9371	*/
9372	export type StreamNext<N extends StreamingEventName = StreamingEventName, E = Args<N>, O = NextResult<N>, S extends {
9373	[K in N]?: unknown;
9374	} = {
9375	[K in N]: Args<K>;
9376	}> = Pick<Next<N, E, O, S>, 'signal' \| 'is' \| 'event' \| 'origin' \| 'budget'> & {
9377	(e: E): HookStream<Chunk<N>, O>;
9378	/**
9379	* Continues this dispatch at a tier, as Next's `to`: the stream beneath
9380	* with the links between this hook's tier and that one skipped.
9381	*/
9382	readonly to: (e: E, tier: TargetTier) => HookStream<Chunk<N>, O>;
9383	/**
9384	* What settled beneath on the latest `next()` stream, as Next's; a
9385	* streaming link's entry counts the chunks it yielded up (`chunks`).
9386	*/
9387	readonly trace: readonly TraceEntry<N, E, O>[];
9388	};
9389
9390	/**
9391	* The shape a `Box` and a `Text` share in a render tree: allowlisted props,
9392	* an optional `hover`, the group stamp a `hover.scope` earns, and children.
9393	*
9394	* `Tag` is which of the two; `Hover` is that element's hover props. Every
9395	* surface draws both: Ink's Box and Text on the terminal, a flex div and a
9396	* styled span on the desktop.
9397	*/
9398	type StyledElement<Tag extends 'Box' \| 'Text', Hover> = {
9399	type: Tag;
9400	/**
9401	* A Box's layout, position, spacing and border props and the `key` that
9402	* makes it a hover scope; a Text's colors and styles. Others are refused.
9403	*/
9404	props?: Record<string, string \| number \| boolean>;
9405	/**
9406	* Style overrides the surface applies while the pointer is over the
9407	* nearest keyed Box, or over any member of the group `scope` names.
9408	*
9409	* Plain data, no hook. Nothing that moves a sibling: `borderStyle`
9410	* restyles a border the Box has, `display` only reveals a Box drawn
9411	* `"none"` (under a keyed Box or in a scope), an offset moves a placed Box.
9412	*/
9413	hover?: Hover;
9414	/**
9415	* Whose group `hover.scope` names; absent without a `scope`.
9416	*/
9417	group?: PluginStamp;
9418	/**
9419	* In order: a Box holds elements and strings (core wraps each string in
9420	* a Text); a Text holds strings and inline elements, never an engine node.
9421	*/
9422	children?: RenderNode[];
9423	};
9424
9425	type SubagentStartHookInput = BaseHookInput & {
9426	hook_event_name: 'SubagentStart';
9427	agent_id: string;
9428	agent_type: string;
9429	};
9430
9431	type SubagentStopHookInput = BaseHookInput & {
9432	hook_event_name: 'SubagentStop';
9433	stop_hook_active: boolean;
9434	agent_id: string;
9435	agent_transcript_path: string;
9436	agent_type: string;
9437	/**
9438	* Text content of the last assistant message before stopping. Avoids the need to read and parse the transcript file.
9439	*/
9440	last_assistant_message?: string;
9441	/**
9442	* In-flight background work (running/pending + backgrounded) registered in this session. Lets hooks distinguish "session is done" from "session is paused waiting for background work to wake it". Empty array when nothing is in flight.
9443	*/
9444	background_tasks?: BackgroundTaskSummary[];
9445	/**
9446	* Session-scoped cron tasks (CronCreate, ScheduleWakeup, /loop) that will wake this session later. Empty array when none are scheduled.
9447	*/
9448	session_crons?: SessionCronSummary[];
9449	};
9450
9451	/**
9452	* The props of `Svg`, the remote surfaces' vector leaf: the markup is the
9453	* element's data, as a string is a Text's, drawn isolated.
9454	*
9455	* A leaf: no children. The surface never lets the markup reach the page
9456	* (the engine bounds it; the desktop and the editor draw it as an image, or
9457	* in a sandboxed frame when `isInteractive`; the mobile app in a web view).
9458	*/
9459	export type SvgProps = {
9460	/**
9461	* The SVG document, `<svg ...>...</svg>`, at most 131072 characters.
9462	*/
9463	source: string;
9464	/**
9465	* What the drawing says, for a reader that cannot see it; required, since
9466	* a surface without the element draws nothing else of it.
9467	*/
9468	alt: string;
9469	/**
9470	* CSS pixels; absent, the box takes the markup's own width up to the slot.
9471	*/
9472	width?: number;
9473	/**
9474	* CSS pixels; absent, the markup's own height at the drawn width.
9475	*/
9476	height?: number;
9477	/**
9478	* `true` draws the SVG in a script-less sandboxed frame so hover, CSS
9479	* `:hover`, SMIL animation and `<title>` tooltips work; absent, an image.
9480	*
9481	* It never enables script or event-handler attributes (the frame has no
9482	* allow-scripts and the scrub strips them); presses that other plugins
9483	* should observe go on an enclosing element.
9484	*/
9485	isInteractive?: boolean;
9486	};
9487
9488	/**
9489	* The keys of `I` a matcher may select variants by: literal-valued in every
9490	* variant, and one literal per variant (IsDiscriminant).
9491	*/
9492	type TagKeys<I> = {
9493	[K in MatcherKeys<I>]: IsLiteralValued<MatcherValueOf<I, K>> extends true ? IsDiscriminant<I, K> extends true ? K : never : never;
9494	}[MatcherKeys<I>];
9495
9496	/**
9497	* A tier `next.to(e, tier)` may name: one a floor can reach past a tier of
9498	* less authority to, so never `prepend` or `user`, which nothing skips to.
9499	*/
9500	export type TargetTier = Exclude<Tier, 'prepend' \| 'user'>;
9501
9502	type TaskCompletedHookInput = BaseHookInput & {
9503	hook_event_name: 'TaskCompleted';
9504	task_id: string;
9505	task_subject: string;
9506	task_description?: string;
9507	teammate_name?: string;
9508	/**
9509	* @deprecated Sessions have a single implicit team; this carries the session-derived team name and will be removed in a future release.
9510	*/
9511	team_name?: string;
9512	};
9513
9514	type TaskCreatedHookInput = BaseHookInput & {
9515	hook_event_name: 'TaskCreated';
9516	task_id: string;
9517	task_subject: string;
9518	task_description?: string;
9519	teammate_name?: string;
9520	/**
9521	* @deprecated Sessions have a single implicit team; this carries the session-derived team name and will be removed in a future release.
9522	*/
9523	team_name?: string;
9524	};
9525
9526	type TeammateIdleHookInput = BaseHookInput & {
9527	hook_event_name: 'TeammateIdle';
9528	teammate_name: string;
9529	/**
9530	* @deprecated Sessions have a single implicit team; this carries the session-derived team name and will be removed in a future release.
9531	*/
9532	team_name: string;
9533	};
9534
9535	/**
9536	* The `Text` props a `hover` may override (its colors and styles, not its
9537	* wrapping) and `scope`, the hover group it joins; a `Button`'s label too.
9538	*/
9539	export type TextHoverProps = {
9540	/**
9541	* Names a hover group of this plugin's: every element it draws with the
9542	* same `scope`, in any site on the surface, lights while any is hovered.
9543	*
9544	* Another plugin's elements under the same string are a different group.
9545	* One to 64 characters, no control characters; no keyed Box needed. On the
9546	* terminal a Text nested in a Text follows its group but cannot heat it.
9547	*/
9548	scope?: string;
9549	color?: string;
9550	backgroundColor?: string;
9551	dimColor?: boolean;
9552	bold?: boolean;
9553	italic?: boolean;
9554	underline?: boolean;
9555	strikethrough?: boolean;
9556	inverse?: boolean;
9557	};
9558
9559	/**
9560	* The props of `Text`: the color and style props of Ink's Text a tree may
9561	* set. Colors are a theme key or a raw color.
9562	*/
9563	export type TextProps = {
9564	/**
9565	* Style overrides applied by the surface while the pointer is over the
9566	* nearest enclosing keyed `Box`, or, given a `scope`, over its group.
9567	*
9568	* No hook runs and nothing crosses to the plugin. Refused outside a keyed
9569	* Box unless it names a `scope`.
9570	*/
9571	hover?: TextHoverProps;
9572	color?: string;
9573	backgroundColor?: string;
9574	dimColor?: boolean;
9575	bold?: boolean;
9576	italic?: boolean;
9577	underline?: boolean;
9578	strikethrough?: boolean;
9579	inverse?: boolean;
9580	wrap?: 'wrap' \| 'end' \| 'middle' \| 'truncate' \| 'truncate-start' \| 'truncate-middle' \| 'truncate-end';
9581	};
9582
9583	/**
9584	* One of the chain's five tiers (TIERS), outermost first; on every
9585	* `next.trace` entry, and what `next.to(e, tier)` names.
9586	*
9587	* `prepend` and `append` are the managed plugins an administrator lists,
9588	* `user` everything a person installs, `builtin` the plugins bundled in the
9589	* binary, `core` the engine's innermost link.
9590	*/
9591	export type Tier = (typeof TIERS)[number];
9592
9593	/**
9594	* The chain's five tiers, outermost first: earlier is outer is more
9595	* authority, and same-event hooks nest in this order and no other way.
9596	*
9597	* The managed plugins an administrator prepends, everything a person
9598	* installs, the managed plugins appended, the plugins bundled in the binary,
9599	* the engine's innermost link; a built-in's `$` calls still raise everywhere.
9600	*/
9601	const TIERS: readonly ["prepend", "user", "append", "builtin", "core"];
9602
9603	/**
9604	* A pending timer from `$.clock.after` / `$.clock.every`.
9605	*/
9606	export type Timer = {
9607	/**
9608	* Stops it; a stopped timer never fires again.
9609	*/
9610	cancel: () => void;
9611	};
9612
9613	/**
9614	* A timer on `$.clock` (`after`, `every`): `fn` runs after `ms` milliseconds,
9615	* once or until `cancel()`.
9616	*/
9617	export type TimerCall = (ms: number, fn: () => void) => Timer;
9618
9619	/**
9620	* Options of `$.ui.toast`.
9621	*/
9622	export type ToastOptions = {
9623	/**
9624	* How long the line stays, in milliseconds; default 4000.
9625	*/
9626	timeoutMs?: number;
9627	};
9628
9629	/**
9630	* `tool.call`'s input as the call takes it: `tool_use_id` and `agentId` may
9631	* ride along (a hook passing its event's input on) and are dropped.
9632	*
9633	* The run gets its own id and runs in the session's loop.
9634	*/
9635	export type ToolCallArgs = ToolCallEnvelope extends infer I ? I extends ToolCallEnvelope ? Omit<I, 'tool_use_id'> & ToolCallReserved<I['tool']> : never : never;
9636
9637	/**
9638	* The envelope the two tool events share: the tool, the id of this call, and
9639	* the tool's arguments spread beside them (`e.command` for Bash).
9640	*
9641	* A union discriminated by `tool`: after `if (e.tool === "Bash")`, `e.command`
9642	* is a string and a rewrite is checked against Bash's schema. The `e` of
9643	* `classic.PreToolUse` exactly; `tool.call`'s adds the loop (ToolCallInput).
9644	*/
9645	export type ToolCallEnvelope = BuiltinToolCallInput \| McpToolCallInput;
9646
9647	/**
9648	* The input of `tool.call`: the tool, the id of this call, the tool's
9649	* arguments beside them (`e.command` for Bash), and `agentId` in a subagent.
9650	*
9651	* A union discriminated by `tool`: after `if (e.tool === "Bash")`, `e.command`
9652	* is a string and a rewrite is checked against Bash's schema. `tool`,
9653	* `tool_use_id` and `agentId` are reserved: a rewrite of any is refused.
9654	*/
9655	export type ToolCallInput = ToolCallEnvelope & AgentLoop;
9656
9657	/**
9658	* `$.tool.call(input)`: resolves with `result` typed for the tool `input`
9659	* names (ToolCallResult), or loosely for an input that names none literally.
9660	*/
9661	type ToolCallOverloads = {
9662	<T extends string>(input: ToolCallArgs & ToolNamed<T>): Promise<ToolCallResult<T>>;
9663	(input: ToolCallArgs): Promise<ToolCallResult>;
9664	};
9665
9666	/**
9667	* The keys `tool.call`'s input carries beside the tool's own arguments, none
9668	* of which the tool sees (the engine strips them before the tool runs).
9669	*
9670	* `consent` is the person's own words for the press that raised the call
9671	* (`The user pressed "1: Yes" on ...`): the run's context carries it as a human
9672	* turn, which the permission path reads as the user's request.
9673	*/
9674	export type ToolCallReserved<T> = {
9675	tool: T;
9676	tool_use_id?: string;
9677	consent?: string;
9678	};
9679
9680	/**
9681	* What a `tool.call` hook returns and what `next(e)` and `$.tool.call(input)`
9682	* resolve to: the tool's result (`{ result, context? }`) or `{ deny }`.
9683	*
9684	* From core the result is `{ ref, result, text }` or, when the tool reported
9685	* an error, `{ ref, result, text, isError }`; `ref` names core's messages.
9686	*
9687	* @template Name the tool the call went to, typing `result` per built-in
9688	* tool (BuiltinToolResults) once `e.tool` is narrowed; else `unknown`
9689	*/
9690	export type ToolCallResult<Name extends string = string> = {
9691	/**
9692	* Refuses the call: the model receives the text as an error result.
9693	* Absent when the call was answered.
9694	*/
9695	deny: string;
9696	result?: undefined;
9697	context?: undefined;
9698	ref?: undefined;
9699	text?: undefined;
9700	isError?: undefined;
9701	} \| {
9702	/**
9703	* The tool's output: from core the tool's record, typed per built-in
9704	* tool once `e.tool` and `isError` are narrowed; from a hook, its own.
9705	*
9706	* Core validates a hook's answer against the tool's output schema when
9707	* it has one, maps it for the model with the tool's own mapper, and
9708	* records it in the transcript as the tool's result. Absent on a deny.
9709	*/
9710	result: ToolResultOf<Name>;
9711	/**
9712	* What the model reads after the tool's result and the user never
9713	* sees. From core, none.
9714	*
9715	* One reminder, as a PostToolUse hook's is, after the managed tier's
9716	* review; none on a plugin's own `$.tool.call`. Kept whole from `next`,
9717	* none empty, any length: past 100,000 (200,000 together) head + path.
9718	*/
9719	context?: readonly string[];
9720	/**
9721	* Set by core on what `next(e)` resolves to: names the messages core
9722	* produced for the call (they stay on the host side).
9723	*
9724	* A hook that returns the object it got makes core use them verbatim.
9725	* Absent on a hook's own `{ result }` and on a deny.
9726	*/
9727	ref?: number;
9728	/**
9729	* Set by core: the result as the model reads it (text blocks joined),
9730	* present whatever the tool, where `result`'s shape varies per tool.
9731	*
9732	* Absent on a hook's own `{ result }`.
9733	*/
9734	text?: string;
9735	isError?: undefined;
9736	deny?: undefined;
9737	} \| {
9738	/**
9739	* Set by core, present only when the tool reported an error (it threw,
9740	* was interrupted, or answered an error): `text` is what the model read.
9741	*/
9742	isError: true;
9743	/**
9744	* What the transcript stored for the errored call: the error text, or
9745	* undefined when nothing was stored; never the tool's typed record.
9746	*/
9747	result: unknown;
9748	/**
9749	* The error as the model reads it.
9750	*/
9751	text?: string;
9752	/**
9753	* As on an answered result: names the messages core produced.
9754	*/
9755	ref?: number;
9756	/**
9757	* As on an answered result.
9758	*/
9759	context?: readonly string[];
9760	deny?: undefined;
9761	};
9762
9763	/**
9764	* `tool.check`'s input as `$.tool.check` takes it: the tool and its
9765	* arguments; `tool_use_id` is the engine's to set, never a query's.
9766	*/
9767	type ToolCheckArgs = Pick<ToolCheckInput, 'tool' \| 'input'>;
9768
9769	/**
9770	* The verdict of `tool.check`: run the tool, put it to the mode's decider
9771	* (the dialog, the auto-mode classifier, a headless host), or refuse it.
9772	*/
9773	type ToolCheckDecision = 'allow' \| 'ask' \| 'deny';
9774
9775	/**
9776	* The input of `tool.check`: the tool, its arguments, and the call's id when
9777	* the engine is deciding a real call.
9778	*
9779	* All three are the question's identity and are pinned: a hook decides
9780	* about this call, it does not change it (`tool.call` rewrites a call).
9781	*/
9782	type ToolCheckInput = {
9783	/**
9784	* As the model names it (`Bash`, `mcp__server__tool`); the key a matcher
9785	* narrows on.
9786	*/
9787	tool: string;
9788	/**
9789	* The tool's arguments as the permission decision reads them
9790	* (`{ command }` for Bash, `{ file_path, ... }` for the file tools).
9791	*/
9792	input: unknown;
9793	/**
9794	* The call being decided, on a real call only; absent on a query.
9795	*
9796	* `next.origin` names who raised it: `{ plugin: 'engine', tier: 'core' }`
9797	* for the model's own call, the plugin for its `$.tool.call` or its query.
9798	*/
9799	tool_use_id?: string;
9800	};
9801
9802	/**
9803	* What a `tool.check` hook returns and what `next(e)` resolves to: the
9804	* verdict, why, and the settings rule behind it when one decided.
9805	*
9806	* From core, the engine's declarative decision for the session's mode and
9807	* rules. A hook may answer any verdict in either direction; the last word up
9808	* the chain is the decision.
9809	*/
9810	type ToolCheckResult = {
9811	/**
9812	* `allow` runs the tool; `ask` puts it to the mode's decider; `deny`
9813	* refuses it, the reason the model's error.
9814	*/
9815	decision: ToolCheckDecision;
9816	/**
9817	* Why, in a sentence: from core the rule or check that decided; from a
9818	* hook, what the model reads on a deny and the dialog shows on an ask.
9819	*/
9820	reason?: string;
9821	/**
9822	* The settings rule that decided, as written (`Bash(git push:*)`).
9823	*
9824	* Absent for a mode or a tool's own check.
9825	*/
9826	rule?: string;
9827	};
9828
9829	/**
9830	* Where a `tool.describe` answer places the tool: `true` behind ToolSearch
9831	* (its schema loads when the model asks for it), `false` in the prompt's list.
9832	*
9833	* Left out of an answer, the placement beneath stands.
9834	*/
9835	export type ToolDeferral = boolean;
9836
9837	/**
9838	* The input of `tool.describe`: one tool's description, at the moment the
9839	* engine first renders the tool's schema for the model.
9840	*/
9841	export type ToolDescribeInput = {
9842	/**
9843	* As the model sees the name (`Bash`, `mcp__server__tool`); the key a
9844	* matcher narrows on.
9845	*/
9846	tool: string;
9847	/**
9848	* The tool's description as it computed it.
9849	*/
9850	description: string;
9851	/**
9852	* Present, and true, when the engine lists the tool behind ToolSearch (its
9853	* schema loads when the model asks for it by name); absent for one listed.
9854	*
9855	* By the engine's rule an MCP server's tool, or one that asks to be,
9856	* unless a rule keeps it in front.
9857	*/
9858	isDeferred?: true;
9859	/**
9860	* Who provides this tool: the plugin and its tier; `{ plugin: "engine",
9861	* tier: "core" }` for a built-in. Pinned: a rewrite is refused.
9862	*
9863	* A configured MCP server's tool is `mcp:<server>`, in `prepend` when the
9864	* policy settings source configures the server, else `user`.
9865	*/
9866	provider: Origin;
9867	};
9868
9869	/**
9870	* What a `tool.describe` hook returns: the description the model sees for that
9871	* tool and, when the hook moves it, where the tool waits (ToolDeferral).
9872	*
9873	* `{ description }` alone, or `{ ...(await next(e)), description }`, changes
9874	* the text and keeps the engine's placement; `isDeferred: true` puts the tool
9875	* behind ToolSearch, `isDeferred: false` puts its schema in the prompt's list.
9876	*/
9877	export type ToolDescribeResult = {
9878	description: string;
9879	isDeferred?: ToolDeferral;
9880	};
9881
9882	/**
9883	* `{ tool, tool_use_id, ...args }` as one flat object type, generic over
9884	* the tool name and its parsed arguments.
9885	*/
9886	type ToolEnvelope<Name, Arguments> = {
9887	/**
9888	* The name of the tool being called (`Bash`, `mcp__<server>__<tool>`);
9889	* comparing it narrows `e`. Reserved: a rewrite of it is ignored by core.
9890	*/
9891	tool: Name;
9892	/**
9893	* The tool_use block's id: the same at every event of the call and in
9894	* `$.ui.notice`. Reserved: a rewrite of it is ignored by core.
9895	*/
9896	tool_use_id: string;
9897	} & Arguments;
9898
9899	/**
9900	* One tool call of a ToolGroup, as `ui.render` sees it under `calls`.
9901	*/
9902	export type ToolGroupCall = {
9903	/**
9904	* The id `tool.call` carried for this call (`e.tool_use_id` there), so a
9905	* hook that saw the call finds its row in the group. Read-only.
9906	*
9907	* Absent on a desktop host that predates it.
9908	*/
9909	tool_use_id?: string;
9910	/**
9911	* Which one the call ran (`Bash`, `Read`, `Grep`, ...).
9912	*/
9913	tool: string;
9914	/**
9915	* The call's input, as the model sent it.
9916	*/
9917	input: unknown;
9918	/**
9919	* True while the call is still running.
9920	*/
9921	isRunning: boolean;
9922	/**
9923	* True when the call ended in an error.
9924	*/
9925	isErrored: boolean;
9926	/**
9927	* True when an abort ended the call, as on `ToolUse`.
9928	*/
9929	isInterrupted: boolean;
9930	/**
9931	* As on `ToolUse`; undefined while the call runs.
9932	*/
9933	output?: unknown;
9934	};
9935
9936	/**
9937	* One tool as `$.tool.list()` returns it.
9938	*/
9939	export type ToolInfo = {
9940	/**
9941	* What the model calls it by.
9942	*/
9943	name: string;
9944	/**
9945	* What it does, in the tool's own words (its description; a first sentence at
9946	* most for MCP tools without one).
9947	*/
9948	description: string;
9949	/**
9950	* True for an MCP server's tool.
9951	*/
9952	mcp: boolean;
9953	};
9954
9955	/**
9956	* `{ tool, tool_use_id, ...args }` as one flat object type.
9957	*
9958	* The docs of `tool` and `tool_use_id` live on the `keyof` operand: a mapped
9959	* type takes its properties' docs from there.
9960	*/
9961	export type ToolInputOf<Name extends string, Arguments> = {
9962	[K in keyof ToolEnvelope<Name, Arguments>]: ToolEnvelope<Name, Arguments>[K];
9963	};
9964
9965	/**
9966	* An input that names its tool as the literal `T`: what `next` and
9967	* `$.tool.call` read to type the call's result per tool (NextResultFor).
9968	*/
9969	type ToolNamed<T extends string> = {
9970	/**
9971	* The name of the tool being called (`Bash`).
9972	*/
9973	readonly tool: T;
9974	};
9975
9976	/**
9977	* The structured result of the tool named `Name`: its BuiltinToolResults
9978	* entry for a built-in tool, else `unknown`.
9979	*
9980	* Agent's is its entry or an AgentCallRecord (what a plugin-raised call
9981	* answers). `unknown` covers an MCP tool, a name the results table lacks
9982	* (one merged into the inputs table alone too), and `Name` left at `string`.
9983	*/
9984	export type ToolResultOf<Name extends string> = string extends Name ? unknown : Name extends keyof BuiltinToolResults & string ? BuiltinToolResults[Name] \| (Name extends 'Agent' ? AgentCallRecord : never) : unknown;
9985
9986	/**
9987	* One tool_result block of a user message.
9988	*/
9989	export type ToolResultSummary = {
9990	/**
9991	* The id of the call this result answers (`tool.call`'s `e.tool_use_id`).
9992	*/
9993	tool_use_id: string;
9994	/**
9995	* The result as the model read it (text blocks joined).
9996	*/
9997	text: string;
9998	/**
9999	* True when the tool reported an error.
10000	*/
10001	isError: boolean;
10002	/**
10003	* What the transcript stored for the call: the tool's record on an answered
10004	* one (`tool.call`'s `result`), the error text when `isError`.
10005	*
10006	* Absent when nothing was stored. Headless (`-p`), a tool may store the
10007	* record less its bulk (Bash blanks `stdout`); `text` is what the model
10008	* read either way.
10009	*/
10010	result?: unknown;
10011	};
10012
10013	/**
10014	* What `$.tool.register` takes.
10015	*/
10016	export type ToolSpec = {
10017	/**
10018	* The tool's short name (letters, digits, `_`, `-`; up to 64); the model
10019	* calls it as `mcp__<plugin>__<name>`.
10020	*/
10021	name: string;
10022	/**
10023	* What the tool does, for the model (and the person where tools are
10024	* listed); an unpaired surrogate half in it is drawn as U+FFFD.
10025	*/
10026	description: string;
10027	/**
10028	* A JSON schema object for the input (`{ type: "object", properties,
10029	* required }`); default `{ type: "object" }`.
10030	*/
10031	inputSchema?: Record<string, unknown>;
10032	};
10033
10034	/**
10035	* One tool_use block of an assistant message, with its outcome once the
10036	* transcript holds the call's tool_result (paired by `tool_use_id`).
10037	*/
10038	export type ToolUseSummary = {
10039	/**
10040	* The call's id, as `tool.call` carried it (`e.tool_use_id` there).
10041	*/
10042	tool_use_id: string;
10043	/**
10044	* Which one was called (`Read`, `Bash`, `mcp__server__tool`), as
10045	* `tool.call` named it (`e.tool` there).
10046	*/
10047	tool: string;
10048	/**
10049	* The arguments the model gave it.
10050	*/
10051	input: Record<string, unknown>;
10052	/**
10053	* What the transcript stored for the call: the tool's record on an answered
10054	* one (`tool.call`'s `result`), the error text on a refused or errored one.
10055	*
10056	* Absent while the call is in flight or when nothing was stored. Headless
10057	* (`-p`), a tool may store the record less its bulk (Bash blanks `stdout`);
10058	* `text` holds either way.
10059	*/
10060	result?: unknown;
10061	/**
10062	* The result as the model read it; absent while the call is in flight.
10063	*/
10064	text?: string;
10065	/**
10066	* Present only when the tool reported an error, as on `tool.call`'s result.
10067	*/
10068	isError?: true;
10069	};
10070
10071	/**
10072	* One settled run of a link beneath the caller, as `next.trace` lists it:
10073	* data, not a handle.
10074	*
10075	* `received` and `returned` are the live references where the hook runs
10076	* beside the chain; in a hooks module its own copies, as `e` is.
10077	*/
10078	export type TraceEntry<N extends EventName = EventName, E = Args<N>, O = NextResult<N>> = {
10079	/**
10080	* The link's place in the chain, 0 the outermost.
10081	*/
10082	readonly index: number;
10083	/**
10084	* The hook's plugin; `"engine"` for the engine's own core or bottom.
10085	*/
10086	readonly plugin: string;
10087	/**
10088	* The link's tier (Tier); `"core"` for the engine's own core or bottom.
10089	*/
10090	readonly tier: Tier;
10091	readonly event: N;
10092	readonly outcome: TraceOutcome;
10093	/**
10094	* Why the link was skipped without running, when it was: `bypassed by
10095	* <plugin>`, whose `next.to` went beneath this tier. Absent when it ran.
10096	*/
10097	readonly reason?: string;
10098	/**
10099	* Its own wall time, its `next()` calls' time in flight taken out.
10100	*
10101	* The engine entry's is everything beneath the last hook: in a hooks
10102	* module, the host round trip.
10103	*/
10104	readonly ms: number;
10105	/**
10106	* How many chunks the link yielded up, on a streaming event; absent on
10107	* every other. A link left mid-stream counts what it yielded before.
10108	*/
10109	readonly chunks?: number;
10110	readonly received: E;
10111	/**
10112	* What the link settled on; undefined when it was skipped or rejected.
10113	*/
10114	readonly returned: O \| undefined;
10115	};
10116
10117	/**
10118	* What the chain decided for one link, as `next.trace` names it.
10119	*
10120	* `returned`: its result stood; `passed`: it returned, by reference, what its
10121	* last `next()` resolved to (a hooks module's hook answers with a copy of its
10122	* own, so it reads `returned`); `skipped`: it failed before `next`, or a
10123	* `next.to` above continued beneath its tier (`reason` says which), and
10124	* beneath ran in its place; `kept`: it failed after `next`, and that run's
10125	* result stands; `expired`: its budget ran out (what stands follows
10126	* skipped/kept); `caught`: it threw or its budget ran out, and its `.catch`
10127	* handler's result stands; `rejected`: the link rejected; the deepest such
10128	* entry is where the rejection came from, and the ones above it let it pass.
10129	*/
10130	export type TraceOutcome = 'caught' \| 'expired' \| 'kept' \| 'passed' \| 'rejected' \| 'returned' \| 'skipped';
10131
10132	/**
10133	* What every `turn.complete` carries whatever its reason: the answer, the
10134	* duration, the interrupt flag, the turn's id, its loop and what it cost.
10135	*/
10136	type TurnCompleteFields = {
10137	/**
10138	* The assistant's final visible text this turn ("" if none, e.g.
10139	* thinking-only).
10140	*/
10141	answer: string;
10142	/**
10143	* Wall-clock length of the turn in milliseconds.
10144	*/
10145	durationMs: number;
10146	/**
10147	* True when the turn ended by interruption (`reason === 'aborted'`).
10148	*/
10149	isAborted: boolean;
10150	/**
10151	* The turn's id, the same one its `turn.start` and every `turn.step`
10152	* carried; a subagent's run raises no `turn.start`, its steps carry it.
10153	*/
10154	turnId: string;
10155	/**
10156	* The loop the turn ran in: a subagent's id, as `$.agent.spawn` resolves
10157	* it, each run of its loop one turn; absent on the main loop.
10158	*
10159	* Pinned: a different value is refused, one left out is kept. Every hook
10160	* sees a subagent's turn, so a hook that spawns sees its children's turns
10161	* too and bounds itself.
10162	*/
10163	agentId?: string;
10164	/**
10165	* What the turn cost: its responses' token counts summed and the model of
10166	* the last, read off the API responses the engine already holds.
10167	*
10168	* Absent when the turn got no response (interrupted before one, an API
10169	* error).
10170	*/
10171	usage?: TurnUsage;
10172	};
10173
10174	/**
10175	* The input of `turn.complete`: the assistant's final message of a turn, at
10176	* the moment the turn ends (where the turn's duration is reported).
10177	*
10178	* `reason` says why it ended; `refusal` exists on a refusal alone.
10179	*/
10180	export type TurnCompleteInput = TurnCompleteFields & (TurnCompleteRefused \| TurnCompleteUnrefused);
10181
10182	/**
10183	* Why a turn ended: the model answered, the user interrupted it, the model
10184	* refused with no fallback model to retry on, or an API error ended it.
10185	*/
10186	export type TurnCompleteReason = 'answer' \| 'aborted' \| 'refusal' \| 'error';
10187
10188	/**
10189	* The end of a turn the model refused with no fallback model to retry on:
10190	* what the API said of the refusal rides along.
10191	*/
10192	type TurnCompleteRefused = {
10193	reason: 'refusal';
10194	refusal: TurnRefusal;
10195	};
10196
10197	/**
10198	* What a `turn.complete` hook returns and what `next(e)` resolves to:
10199	* `{ text }`; a text other than a main-loop answer's is shown beneath it.
10200	*
10201	* Core fills `usage` from `e.usage` when the turn had one; a hook above reads
10202	* it, and one that answers its own may leave it out.
10203	*/
10204	export type TurnCompleteResult = {
10205	text: string;
10206	usage?: TurnUsage;
10207	};
10208
10209	/**
10210	* The end of a turn that was not a refusal: answered, interrupted, or dead
10211	* on an API error (retries exhausted, the context limit), nothing more.
10212	*/
10213	type TurnCompleteUnrefused = {
10214	reason: Exclude<TurnCompleteReason, 'refusal'>;
10215	};
10216
10217	/**
10218	* What the API said about a refusal that ended a turn: the classifier's
10219	* category and its explanation, each null when the API sent none.
10220	*/
10221	export type TurnRefusal = {
10222	category: string \| null;
10223	explanation: string \| null;
10224	};
10225
10226	/**
10227	* The input of `turn.start`: the prompt a model turn begins with, after
10228	* `prompt.submit` settled the text and the UserPromptSubmit settings hooks ran.
10229	*/
10230	export type TurnStartInput = {
10231	/**
10232	* The user's text as the turn proceeds with it ("" for a turn started without
10233	* a typed prompt, e.g. a continuation).
10234	*/
10235	text: string;
10236	/**
10237	* The turn's id, minted here; the same one every `turn.step` and the
10238	* `turn.complete` of this turn carry.
10239	*/
10240	turnId: string;
10241	};
10242
10243	/**
10244	* What a `turn.start` hook returns and what `next(e)` resolves to:
10245	* `{ turnId }`, echoed by core; a hook's own value does not change the turn.
10246	*/
10247	export type TurnStartResult = {
10248	turnId: string;
10249	};
10250
10251	/**
10252	* One piece of a `turn.step` response as it streams through the chain:
10253	* what a hook's `next(e)` yields and what the hook yields up in turn.
10254	*
10255	* Text, thinking, a tool call's start and arguments, and the stop are
10256	* plain data a hook reads and rewrites; `engine` is the rest, passed on
10257	* unread. What leaves the outermost hook is what is shown and recorded.
10258	*/
10259	export type TurnStepChunk = TurnStepTextChunk \| TurnStepThinkingChunk \| TurnStepToolChunk \| TurnStepInputChunk \| TurnStepStopChunk \| TurnStepEngineChunk;
10260
10261	/**
10262	* An item of the engine's stream the other chunk kinds do not model (the
10263	* envelope, a block's start and end, a retry marker), opaque by `ref`.
10264	*
10265	* Pass it on where it came. A hook that yields its own response has none
10266	* to yield, and the engine supplies what the response needs around the
10267	* chunks it does yield.
10268	*/
10269	export type TurnStepEngineChunk = {
10270	kind: 'engine';
10271	/**
10272	* The engine's handle on the item; opaque, this step's only.
10273	*/
10274	ref: number;
10275	};
10276
10277	/**
10278	* The input of `turn.step`: one model request inside a turn, at the moment
10279	* the engine is about to send it; the bottom of the chain sends it.
10280	*
10281	* The transcript is not on it: `messageCount` says how many messages the
10282	* request carries, and `$.session.messages()` reads them. A hook rewrites
10283	* `model` or `effort` going down; the rest is pinned.
10284	*/
10285	export type TurnStepInput = {
10286	/**
10287	* The turn this step belongs to (`turn.start`'s id; inside a subagent's
10288	* loop, the id the run's `turn.complete` will carry). Pinned.
10289	*/
10290	turnId: string;
10291	/**
10292	* The step's position in the turn, from 0. Pinned.
10293	*/
10294	index: number;
10295	/**
10296	* Which model the request names, as the engine resolved it for this step
10297	* (the session's, a fallback's). `next({ ...e, model })` names another.
10298	*/
10299	model: string;
10300	/**
10301	* How hard the request asks the model to think: the session's setting or
10302	* the model's default, absent for a model without effort; rewritable.
10303	*/
10304	effort?: 'low' \| 'medium' \| 'high' \| 'xhigh' \| 'max' \| number;
10305	/**
10306	* How many messages the request carries (the conversation so far, the
10307	* turn's tool results included). Pinned: the messages are the engine's.
10308	*/
10309	messageCount: number;
10310	/**
10311	* The loop the request is made in: a subagent's id, the `id`
10312	* `$.agent.list()` gives it and its `tool.call`s carry; absent on main.
10313	*
10314	* Pinned: a different value is refused, one left out is kept. A subagent
10315	* a hook spawned through `$.agent.spawn` steps past that hook, as its tool
10316	* calls do; every other hook sees its steps.
10317	*/
10318	agentId?: string;
10319	};
10320
10321	/**
10322	* A piece of a tool call's arguments as they arrive: JSON text, partial,
10323	* for the `tool` chunk of the same `index`.
10324	*
10325	* The arguments the tool runs with are the pieces concatenated and parsed
10326	* once the block ends; pieces that do not parse leave the call without
10327	* arguments it can run on, as a model that wrote broken JSON would.
10328	*/
10329	export type TurnStepInputChunk = ChunkRef & {
10330	kind: 'input';
10331	index: number;
10332	/**
10333	* The next piece of the arguments' JSON text.
10334	*/
10335	json: string;
10336	};
10337
10338	/**
10339	* What a `turn.step` hook returns and what `next(e)` resolves to: the
10340	* model's response to the step's request, once its blocks are all in.
10341	*
10342	* From the bottom, the response the engine streamed; a hook's own value
10343	* changes what the hooks above it read, never what the engine streamed.
10344	*/
10345	export type TurnStepResult = {
10346	/**
10347	* The turn this step belongs to, as received.
10348	*/
10349	turnId: string;
10350	/**
10351	* The step's position in the turn, as received.
10352	*/
10353	index: number;
10354	/**
10355	* The visible text of the response ("" when it only called tools, only
10356	* thought, or no request was made).
10357	*/
10358	answer: string;
10359	/**
10360	* The tool calls the response made, in order; empty for a text-only step.
10361	*/
10362	toolUses: readonly TurnStepToolUse[];
10363	/**
10364	* Why the model stopped; null when no response arrived (the request
10365	* failed or was interrupted before a message, or no request was made).
10366	*/
10367	stopReason: TurnStopReason;
10368	/**
10369	* What the request cost as the API reported it, and the model that
10370	* answered; null when no response arrived or it carried no usage.
10371	*/
10372	usage: TurnUsage \| null;
10373	};
10374
10375	/**
10376	* The response is whole: why the model stopped and what the request cost,
10377	* as the step's result will carry them. The last chunk of one response.
10378	*/
10379	export type TurnStepStopChunk = ChunkRef & {
10380	kind: 'stop';
10381	stopReason: TurnStopReason;
10382	usage: TurnUsage \| null;
10383	};
10384
10385	/**
10386	* A piece of the response's visible text as it arrives, in block `index`.
10387	*
10388	* The text the person watches stream and the text the transcript records
10389	* are both the concatenation of these, in order, per block: a hook that
10390	* rewrites them rewrites both, one that drops them all drops the block.
10391	*/
10392	export type TurnStepTextChunk = ChunkRef & {
10393	kind: 'text';
10394	/**
10395	* The content block the piece belongs to, from 0 within one response.
10396	*/
10397	index: number;
10398	text: string;
10399	};
10400
10401	/**
10402	* A piece of the model's thinking as it arrives, in block `index`: what
10403	* the person sees of it live.
10404	*
10405	* The thinking block the transcript keeps is the one the model signed, as
10406	* the engine received it; thinking a hook streams without the engine's
10407	* block behind it is shown and not recorded.
10408	*/
10409	export type TurnStepThinkingChunk = ChunkRef & {
10410	kind: 'thinking';
10411	index: number;
10412	text: string;
10413	};
10414
10415	/**
10416	* The model begins a tool call in block `index`: the tool's name and the
10417	* call's id; its arguments follow as `input` chunks of the same index.
10418	*
10419	* A block whose `tool` chunk never comes out of the chain is no tool call:
10420	* the engine records none and runs none.
10421	*/
10422	export type TurnStepToolChunk = ChunkRef & {
10423	kind: 'tool';
10424	index: number;
10425	/**
10426	* The call's `tool_use_id`.
10427	*/
10428	id: string;
10429	/**
10430	* The tool's name (`Read`, `Bash`, `mcp__server__tool`).
10431	*/
10432	name: string;
10433	};
10434
10435	/**
10436	* One tool call the model asked for in a step: the tool's name and its
10437	* arguments.
10438	*/
10439	export type TurnStepToolUse = {
10440	/**
10441	* The tool's name (`Read`, `Bash`, `mcp__server__tool`).
10442	*/
10443	name: string;
10444	/**
10445	* The arguments the model gave it, as the tool schema shapes them.
10446	*/
10447	input: unknown;
10448	};
10449
10450	/**
10451	* Why the model stopped, as a `turn.step` result and its stop chunk carry
10452	* it: one of the API's stop reasons, or null when no response arrived.
10453	*/
10454	type TurnStopReason = 'end_turn' \| 'max_tokens' \| 'stop_sequence' \| 'tool_use' \| 'pause_turn' \| 'compaction' \| 'refusal' \| 'model_context_window_exceeded' \| null;
10455
10456	/**
10457	* What a model turn, or one response inside it, cost as the API reported it:
10458	* the four token counts (`$.model.fork`'s usage shape) and the model's id.
10459	*
10460	* A turn's counts are its responses' summed; its model is the last response's.
10461	*/
10462	export type TurnUsage = ModelForkUsage & {
10463	/**
10464	* Which model answered, by the id the API reports.
10465	*/
10466	model: string;
10467	};
10468
10469	/**
10470	* What a plugin's `$.ui.blit(args)` takes: a Raster's next `cells`
10471	* (RasterBlitArgs) or a keyed Image's next `source` (ImageBlitArgs).
10472	*
10473	* Either names an element this plugin's own `ui.render` hook drew, still
10474	* mounted; a hook above may rewrite the cells or the source, never the
10475	* address or which kind it is.
10476	*/
10477	export type UiBlitArgs = RasterBlitArgs \| ImageBlitArgs;
10478
10479	/**
10480	* What `$.ui.blit` resolves to and what a `ui.blit` hook's `{ value }`
10481	* holds: `{}` once the cells or source are the next frame's, or why not.
10482	*/
10483	export type UiBlitResult = {
10484	/**
10485	* Absent when the cells or source were taken; else why not.
10486	*
10487	* Nothing of this plugin's is mounted there (another plugin's reads so),
10488	* the size is not the mounted one, the cells or source are bad, or the
10489	* Image draws its `alt` there, the reason spelled out for a fallback.
10490	*/
10491	deny?: string;
10492	};
10493
10494	/**
10495	* What a plugin's `$.ui.focus(args)` takes: one of its own elements, by the
10496	* `key` it drew it under, in one of its sites that holds the keyboard now.
10497	*
10498	* The engine resolves it to that site's ring and raises `ui.focus` under
10499	* the plugin's origin; the keyboard is the person's to give, so a site that
10500	* does not hold it, or holds it on another plugin's element, is `{ deny }`.
10501	*/
10502	export type UiFocusArgs = {
10503	/**
10504	* The site, by the `requestId` this plugin draws it under: one of its
10505	* panes' ids, or the band's.
10506	*/
10507	requestId: string;
10508	/**
10509	* The element's `key`: a `Button`, `Input` or `Select` this plugin drew in
10510	* that site; of several under one key, the first in document order.
10511	*/
10512	key: string;
10513	};
10514
10515	/**
10516	* The render components whose site keeps a focus ring: a pane's body and
10517	* the band above the prompt, each a ring over the elements hooks drew there.
10518	*/
10519	export type UiFocusComponent = 'Pane' \| 'AbovePrompt';
10520
10521	/**
10522	* The input of `ui.focus`: a site's focus ring about to move onto one of the
10523	* elements a hook drew in it (a `Button`, `Input` or `Select`), or off them.
10524	*
10525	* Every key but `element` is the engine's word, pinned: `next(e)` passes
10526	* them on, a rewrite that leaves one out keeps it, one that changes it fails
10527	* the hook. `element` is the hook's to rewrite; the ring has not moved yet.
10528	*/
10529	export type UiFocusInput = {
10530	/**
10531	* Which site: a `Pane` body or the `AbovePrompt` band.
10532	*/
10533	component: UiFocusComponent;
10534	/**
10535	* The instance the `ui.render` hook drawing the site sees: the pane's id,
10536	* or the band's one id.
10537	*/
10538	requestId: string;
10539	/**
10540	* Whose `ui.render` hook drew the element taking the ring; absent with
10541	* `element`. Read-only.
10542	*/
10543	plugin?: string;
10544	/**
10545	* The `key` of the element taking the ring, as `ui.press` names it; absent
10546	* for one of the engine's own stops (a pane's close mark or another's tab).
10547	*
10548	* `next({ ...e, element })` lands it on another element `plugin` drew in
10549	* the site instead; one not drawn there is core's `{ deny }`.
10550	*/
10551	element?: string;
10552	/**
10553	* Who moves it (UiFocusOrigin), set by the engine where the move starts.
10554	*/
10555	origin: UiFocusOrigin;
10556	};
10557
10558	/**
10559	* Who moves the ring at `ui.focus`, as the engine stamps it where the move
10560	* starts; a closed set a matcher narrows on.
10561	*
10562	* `next(e)` passes it on as received; no hook sets one.
10563	*/
10564	export type UiFocusOrigin = {
10565	/**
10566	* The person, by Tab, the arrows or a click while the site holds the
10567	* keyboard.
10568	*/
10569	kind: 'person';
10570	} \| {
10571	/**
10572	* A plugin's `$.ui.focus`, or its `autoFocus` element taking the ring
10573	* as the site takes the keyboard.
10574	*/
10575	kind: 'plugin';
10576	/**
10577	* The focusing plugin's name.
10578	*/
10579	name: string;
10580	};
10581
10582	/**
10583	* What a `ui.focus` hook returns, what `next(e)` resolves to, and what
10584	* `$.ui.focus` hands back: `{}` once the ring moved, or why it did not.
10585	*
10586	* As `ui.scroll` spells it.
10587	*/
10588	export type UiFocusResult = {
10589	/**
10590	* Absent when the ring is where the chain left it; else why nothing
10591	* moved.
10592	*
10593	* A hook kept the ring (no `next`); the site is not this plugin's, does
10594	* not hold the keyboard, or another plugin's element holds it; no element
10595	* of `plugin` is drawn under `element`; another move landed first.
10596	*/
10597	deny?: string;
10598	};
10599
10600	/**
10601	* The argument of `ui.input`: a change of, or a submit from, an `Input` a
10602	* render hook drew. Flat and frozen like every event's.
10603	*
10604	* Another plugin addresses one field by matcher:
10605	* `on("ui.input", { plugin: "roster", element: "reply" }, ...)`.
10606	*/
10607	export type UiInputArgument = {
10608	/**
10609	* Whose `ui.render` hook drew the element.
10610	*/
10611	plugin: string;
10612	/**
10613	* The `key` the hook gave its `Input`: its address, what a matcher names.
10614	*/
10615	element: string;
10616	/**
10617	* The render component the element was drawn in (`AbovePrompt`,
10618	* `ToolUse`, ...).
10619	*/
10620	component: RenderComponent;
10621	/**
10622	* The instance the element was drawn in: the `requestId` the `ui.render`
10623	* hook that drew it saw (a tool row's tool_use_id, a pane's id).
10624	*/
10625	requestId: string;
10626	/**
10627	* Where the typing came from, one literal per member, so
10628	* `if (e.surface === "terminal")` narrows `e`.
10629	*/
10630	surface: RenderSurface;
10631	/**
10632	* `change` after every edit of the text; `submit` on Enter.
10633	*/
10634	kind: 'change' \| 'submit';
10635	/**
10636	* The field's whole text at that moment; a hook above may rewrite it for
10637	* the plugins beneath and the element's own handler.
10638	*/
10639	value: string;
10640	};
10641
10642	/**
10643	* What a `ui.input` hook returns and what `next(e)` resolves to.
10644	*
10645	* Beneath every hook, core runs the element's `onInput` (kind `change`) or
10646	* `onSubmit` (kind `submit`) closure in its plugin's environment with the
10647	* value as the chain left it, and answers `{ element, value }`.
10648	*/
10649	export type UiInputResult = {
10650	/**
10651	* Which handler the input reached, by its Input's `key`.
10652	*/
10653	element: string;
10654	/**
10655	* The text the handler received.
10656	*/
10657	value: string;
10658	};
10659
10660	/**
10661	* Options of `$.ui.log`.
10662	*/
10663	export type UiLogOptions = {
10664	/**
10665	* Where the line goes (UiLogSink); `transcript` when left out. A hook on
10666	* `ui.log` reads it as `e.to` and may send the line elsewhere.
10667	*/
10668	to?: UiLogSink;
10669	};
10670
10671	/**
10672	* Where a `$.ui.log` line goes: `transcript`, a dim row of its own (and the
10673	* debug log, as every line); `debug`, the debug log alone, nothing on screen.
10674	*
10675	* The debug log is `claude --debug` or the `--debug-file`; either way the
10676	* line is led by the plugin's name.
10677	*/
10678	export type UiLogSink = 'transcript' \| 'debug';
10679
10680	/**
10681	* The argument of `ui.message`: what a `Client` instance's surface module
10682	* posted (`surface.post(data)`), addressed by where the instance is drawn.
10683	*
10684	* The origin is `client`: code sent it, on nobody's behalf, so `data` is
10685	* input to validate, not a fact. Everything but `data` is the engine's word
10686	* and a hook may not rewrite it.
10687	*/
10688	export type UiMessageArgument = {
10689	/**
10690	* Where the instance is drawn: `terminal`, or `desktop` once it has them.
10691	*/
10692	surface: RenderSurface;
10693	/**
10694	* The render component the `Client` was drawn in (`AbovePrompt`, `Pane`,
10695	* ...).
10696	*/
10697	component: RenderComponent;
10698	/**
10699	* The engine's id for the drawing the `Client` sits in: the `requestId` the
10700	* `ui.render` hook that drew it saw.
10701	*/
10702	requestId: string;
10703	/**
10704	* The `Client`'s `key`: which instance posted.
10705	*/
10706	element: string;
10707	/**
10708	* The `Client`'s `module`: which surface module runs there, as its path
10709	* under the plugin's folder.
10710	*/
10711	module: string;
10712	/**
10713	* What the instance posted: plain data (JsonValue), bounded as a tree's
10714	* text is; typed `unknown` since it came from code. Rewritable.
10715	*/
10716	data: unknown;
10717	};
10718
10719	/**
10720	* What a `ui.message` hook returns and what `next(e)` resolves to.
10721	*
10722	* Core answers `{}`: the message was heard and nothing changes. A hook that
10723	* answers `{ props }` hands the posting instance its next props directly, its
10724	* local state kept, with no `ui.render` run; the plugin's next redraw hands
10725	* props again as usual.
10726	*/
10727	export type UiMessageResult = {
10728	/**
10729	* The instance's next props, plain data (JsonValue) bounded as a `Client`'s
10730	* props are; absent leaves the instance's props as they were.
10731	*/
10732	props?: unknown;
10733	};
10734
10735	/**
10736	* One of this plugin's open panes as `$.ui.panes()` lists it: the pane's
10737	* id and title, and where it stands with the person right now.
10738	*
10739	* Where a surface seated it (`dock` or `inline`) is that surface's to say, on
10740	* the `Pane` render props (`placement`); a session may draw on several.
10741	*/
10742	export type UiPane = {
10743	/**
10744	* What `$.ui.open({ id })` named it, which `$.ui.close` and its
10745	* `ui.render` `requestId` name too.
10746	*/
10747	id: string;
10748	/**
10749	* Its tab's label: the `title` of its latest open, or the id.
10750	*/
10751	title: string;
10752	/**
10753	* True for the one pane the surface shows; the rest are tabs behind it.
10754	*/
10755	isShown: boolean;
10756	/**
10757	* True while the person has given it the keyboard.
10758	*/
10759	isFocused: boolean;
10760	/**
10761	* False while it waits undrawn: opened unasked on a terminal too narrow
10762	* for an unrequested pane, until an open the width or the person admits.
10763	*/
10764	isPlaced: boolean;
10765	};
10766
10767	/**
10768	* The argument of `ui.press`: a press on a `Button` a render hook drew, or
10769	* on an answered `Markdown` link. Flat and frozen like every event's.
10770	*
10771	* Another plugin addresses one button by matcher:
10772	* `on("ui.press", { plugin: "explainer", element: "explain" }, ...)`.
10773	*/
10774	export type UiPressArgument = {
10775	/**
10776	* Whose `ui.render` hook drew the element.
10777	*/
10778	plugin: string;
10779	/**
10780	* The `key` the hook gave its `Button` or `Markdown`: its address, what a
10781	* matcher names.
10782	*/
10783	element: string;
10784	/**
10785	* The render component the element was drawn in (`ToolUse`,
10786	* `AssistantMessage`, ...).
10787	*/
10788	component: RenderComponent;
10789	/**
10790	* The instance the element was drawn in: the `requestId` the `ui.render`
10791	* hook that drew it saw (a tool row's tool_use_id, a pane's id).
10792	*/
10793	requestId: string;
10794	/**
10795	* Where the press came from, one literal per member, so
10796	* `if (e.surface === "terminal")` narrows `e`.
10797	*/
10798	surface: RenderSurface;
10799	/**
10800	* Where the press landed, when the element is a `Markdown` whose links
10801	* its plugin answers (`onLinkPress`); absent for a `Button`.
10802	*
10803	* A hook may rewrite its `href` for the hooks and the closure beneath; one
10804	* that adds or drops it fails, and the press goes on beneath it.
10805	*/
10806	link?: PressedLink;
10807	};
10808
10809	/**
10810	* What a `ui.press` hook returns and what `next(e)` resolves to.
10811	*
10812	* Beneath every hook, core runs the element's `onPress` closure in its
10813	* plugin's environment with `e` as the chain left it, and answers
10814	* `{ element }`.
10815	*/
10816	export type UiPressResult = {
10817	/**
10818	* Which handler the press reached, by its Button's `key`.
10819	*/
10820	element: string;
10821	};
10822
10823	/**
10824	* What a plugin's `$.ui.scroll(args)` takes: what to bring into view, in
10825	* which of its sites, and where in the window it lands.
10826	*
10827	* The engine resolves it to a window and an offset and raises `ui.scroll`
10828	* under the plugin's origin; a transcript row is the person's to move, so
10829	* it is revealed only while the plugin answers the person's own input.
10830	*/
10831	export type UiScrollArgs = {
10832	/**
10833	* What to reveal (UiScrollTarget): a render instance by `requestId`, one
10834	* of this plugin's elements by `key`, or the `start` or `end` of `in`.
10835	*/
10836	to: UiScrollTarget;
10837	/**
10838	* The site to scroll, by the `requestId` this plugin draws it under: one
10839	* of its panes' ids, or the band's.
10840	*
10841	* Required with `start` and `end`; with `{ key }` it picks the site when
10842	* the key is drawn in several.
10843	*/
10844	in?: string;
10845	/**
10846	* Where the target lands in the window (UiScrollBlock); `nearest` when
10847	* left out, so a row already showing does not move.
10848	*/
10849	block?: UiScrollBlock;
10850	};
10851
10852	/**
10853	* Where in its scrollable a revealed row lands, as the DOM's
10854	* `scrollIntoView({ block })` names it.
10855	*
10856	* `nearest` moves the least that shows the row whole, and not at all when
10857	* it already shows; `start`, `center` and `end` put its top, middle or
10858	* bottom at that edge of the window. A row taller than the window shows
10859	* its top.
10860	*/
10861	export type UiScrollBlock = 'start' \| 'center' \| 'end' \| 'nearest';
10862
10863	/**
10864	* The render components whose site the engine scrolls: a pane's body and
10865	* the band above the prompt, each a window over the tree a hook drew there.
10866	*/
10867	export type UiScrollComponent = 'Pane' \| 'AbovePrompt';
10868
10869	/**
10870	* The input of `ui.scroll`: a site's window asked to move over the tree a
10871	* hook drew in it (a pane's body, the band above the prompt).
10872	*
10873	* Every key but `offset` is the engine's word, pinned: `next(e)` passes
10874	* them on, a rewrite that leaves one out keeps it, one that changes or adds
10875	* one fails the hook. `offset` is the hook's to rewrite; nothing moved yet.
10876	*/
10877	export type UiScrollInput = {
10878	/**
10879	* Which site: a `Pane` body or the `AbovePrompt` band.
10880	*/
10881	component: UiScrollComponent;
10882	/**
10883	* The instance the `ui.render` hook drawing the site sees: the pane's id,
10884	* or the band's one id.
10885	*/
10886	requestId: string;
10887	/**
10888	* The first row the window is to show, 0 at the top: the row it shows
10889	* now plus `by`, clamped to the tree, or where `$.ui.scroll` resolved.
10890	*
10891	* `next({ ...e, offset })` moves it elsewhere (a clamp); one past the
10892	* tree's end lands at the end. Nothing has moved when a hook reads it.
10893	*/
10894	offset: number;
10895	/**
10896	* The rows the move asks for, signed, negative toward the top; what the
10897	* DOM's `scrollBy` takes. Read-only.
10898	*
10899	* The person's: a wheel tick `-1` or `1` at rest, more as ticks crowd or
10900	* summed in flight; an arrow a row while the engine has rows to scroll, a
10901	* page key `bodyRows`, Home and End `contentRows`. A plugin's: its distance.
10902	*/
10903	by: number;
10904	/**
10905	* How many rows of the tree the window shows at once, as drawn now.
10906	* Read-only.
10907	*/
10908	bodyRows: number;
10909	/**
10910	* How many rows the tree has, as drawn now: the window's last offset is
10911	* `contentRows - bodyRows`, none when the tree fits. Read-only.
10912	*/
10913	contentRows: number;
10914	/**
10915	* Who moves it (UiScrollOrigin), set by the engine where the move starts.
10916	*/
10917	origin: UiScrollOrigin;
10918	/**
10919	* The body cell the person's wheel or trackpad was over (UiScrollPointer);
10920	* absent for the scroll keys and for `$.ui.scroll`. Read-only.
10921	*
10922	* Moves summed while a dispatch was in flight carry the latest one's. A
10923	* hook pinning a list over rows it scrolls itself tells a tick over the
10924	* list (`row` among its list's rows) from one over the body.
10925	*/
10926	pointer?: UiScrollPointer;
10927	};
10928
10929	/**
10930	* Who moves the window at `ui.scroll`, as the engine stamps it where the
10931	* move starts; a closed set a matcher narrows on.
10932	*
10933	* `next(e)` passes it on as received; no hook sets one.
10934	*/
10935	export type UiScrollOrigin = {
10936	/**
10937	* The person, by the wheel over the site or its scroll keys while
10938	* they hold it.
10939	*/
10940	kind: 'person';
10941	} \| {
10942	/**
10943	* A plugin's `$.ui.scroll`.
10944	*/
10945	kind: 'plugin';
10946	/**
10947	* The scrolling plugin's name.
10948	*/
10949	name: string;
10950	};
10951
10952	/**
10953	* The cell the pointer was over when the person's wheel raised `ui.scroll`,
10954	* in the site's body: the box its `ui.render` hook draws into, as painted.
10955	*
10956	* The DOM's `clientY - body.top` in cells, the window's offset not added: a
10957	* hook drawing its own window reads `row` as its tree's row, one the engine
10958	* scrolls adds the `scroll.offset` it drew with. The frame lies outside.
10959	*/
10960	export type UiScrollPointer = {
10961	/**
10962	* 0 at the body's left edge, as `bodyColumns` counts them; negative, or
10963	* `bodyColumns` and past, over an inline pane's side borders.
10964	*/
10965	column: number;
10966	/**
10967	* 0 at the body's first showing row, as `bodyRows` counts them.
10968	*
10969	* The tree's row is `scroll.offset + row` under the engine's window, and
10970	* `row` itself under a hook's own (offset 0); negative over a pane's top
10971	* border or tab row, `bodyRows` or more over its bottom border.
10972	*/
10973	row: number;
10974	};
10975
10976	/**
10977	* What a `ui.scroll` hook returns, what `next(e)` resolves to, and what
10978	* `$.ui.scroll` hands back: `{}` once the window moved, or why it did not.
10979	*/
10980	export type UiScrollResult = {
10981	/**
10982	* Absent when the window is where the chain left it; else why nothing
10983	* moved, as `tool.call` and `config.set` spell a refusal.
10984	*
10985	* A hook kept the window (no `next`); the target is not this plugin's;
10986	* another move landed first (`the window moved meanwhile`); a transcript
10987	* row is not the person's ask (`not person-initiated`) or none scrolls.
10988	*/
10989	deny?: string;
10990	};
10991
10992	/**
10993	* What `$.ui.scroll` brings into view: never a row number, always a thing
10994	* drawn somewhere.
10995	*
10996	* `{ requestId }` names a render instance by the id its `ui.render` hook
10997	* saw (a transcript message's, a tool row's tool_use_id), scrolled into view
10998	* inside whatever scrolls it. `{ key }` names an element this plugin drew
10999	* with that `key`, inside the site it drew it in. `start` and `end` are the
11000	* top and bottom of the site `in` names; `end` keeps up with a tree that
11001	* grows (rows the plugin just added count) until anything next moves it.
11002	*/
11003	export type UiScrollTarget = {
11004	requestId: string;
11005	} \| {
11006	key: string;
11007	} \| 'start' \| 'end';
11008
11009	/**
11010	* The argument of `ui.select`: a pick from a `Select` a render hook drew.
11011	* Flat and frozen like every event's.
11012	*
11013	* Another plugin addresses one picker by matcher:
11014	* `on("ui.select", { plugin: "roster", element: "peer" }, ...)`.
11015	*/
11016	export type UiSelectArgument = {
11017	/**
11018	* Whose `ui.render` hook drew the element.
11019	*/
11020	plugin: string;
11021	/**
11022	* The `key` the hook gave its `Select`: its address, what a matcher names.
11023	*/
11024	element: string;
11025	/**
11026	* The render component the element was drawn in (`AbovePrompt`,
11027	* `ToolUse`, ...).
11028	*/
11029	component: RenderComponent;
11030	/**
11031	* The instance the element was drawn in: the `requestId` the `ui.render`
11032	* hook that drew it saw (a tool row's tool_use_id, a pane's id).
11033	*/
11034	requestId: string;
11035	/**
11036	* Where the pick came from, one literal per member, so
11037	* `if (e.surface === "terminal")` narrows `e`.
11038	*/
11039	surface: RenderSurface;
11040	/**
11041	* The picked option's value; a hook above may rewrite it for the plugins
11042	* beneath and the element's own handler.
11043	*/
11044	value: string;
11045	};
11046
11047	/**
11048	* What a `ui.select` hook returns and what `next(e)` resolves to.
11049	*
11050	* Beneath every hook, core runs the element's `onSelect` closure in its
11051	* plugin's environment with the value as the chain left it, and answers
11052	* `{ element, value }`.
11053	*/
11054	export type UiSelectResult = {
11055	/**
11056	* Which handler the pick reached, by its Select's `key`.
11057	*/
11058	element: string;
11059	/**
11060	* What the handler received: the option's value as the chain left it.
11061	*/
11062	value: string;
11063	};
11064
11065	/**
11066	* The intersection of a union's members (`A \| B` to `A & B`), by inferring
11067	* one parameter type from the contravariant positions.
11068	*/
11069	type UnionToIntersection<U> = (U extends unknown ? (member: U) => void : never) extends (member: infer I) => void ? I : never;
11070
11071	/**
11072	* One unit of what `$.session.usage()` answers, by its key there: the
11073	* context window's fill, the rate-limit windows, the session's cost.
11074	*/
11075	export type UsageUnit = 'context' \| 'rateLimits' \| 'cost';
11076
11077	/**
11078	* Who sent the message a `UserMessage` row carries, when someone other than
11079	* the person did: another agent, a teammate, another session, a channel.
11080	*
11081	* Read-only. The sender's words are not the person's: the model reads them
11082	* framed as that sender's whatever a hook draws for the row.
11083	*/
11084	type UserMessageFrom = {
11085	/**
11086	* The sender's name as the row shows it: a subagent's name, else its type;
11087	* a teammate's; another session's title; a channel's sender, else server.
11088	*
11089	* One printable line: control and format characters stripped, whitespace
11090	* collapsed, length bounded. Absent (no `from`) for a teammate block whose
11091	* frames name different senders or none.
11092	*/
11093	name: string;
11094	};
11095
11096	/**
11097	* The background task a `UserMessage` notification row reports on: a
11098	* subagent, a background shell, a workflow, a remote agent, a monitor.
11099	*
11100	* Every field is the notification's own, so the row names the same task on
11101	* every draw, a resumed session's included; the session's record of it
11102	* (name, type, description) is `$.agent.list()`'s, by `id`. Each string is
11103	* one printable line, bounded (a forged envelope's bytes capped). Read-only.
11104	*/
11105	type UserMessageTask = {
11106	/**
11107	* The task's id as the notification names it; for a subagent, the
11108	* `agentId` its `turn.complete` carried and `$.agent.list()` keys.
11109	*/
11110	id?: string;
11111	/**
11112	* How the task ended: `completed`, `failed` or `killed` (stopped, by the
11113	* person or by Claude), or another word its producer wrote.
11114	*/
11115	status?: string;
11116	/**
11117	* What kind of task, when the notification says (`remote_agent`, an
11118	* artifact watch's kind); a subagent's and a shell's leave it out.
11119	*/
11120	type?: string;
11121	/**
11122	* Which call started the task: its `tool_use_id`, when the notification
11123	* carries it.
11124	*/
11125	toolUseId?: string;
11126	/**
11127	* How long the task ran, in milliseconds, when the notification says; the
11128	* row draws it after the summary (`2m 2s`).
11129	*/
11130	durationMs?: number;
11131	};
11132
11133	type UserPromptExpansionHookInput = BaseHookInput & {
11134	hook_event_name: 'UserPromptExpansion';
11135	expansion_type: 'slash_command' \| 'mcp_prompt';
11136	command_name: string;
11137	command_args: string;
11138	command_source?: string;
11139	prompt: string;
11140	};
11141
11142	type UserPromptSubmitHookInput = BaseHookInput & {
11143	hook_event_name: 'UserPromptSubmit';
11144	prompt: string;
11145	/**
11146	* Who authored/injected the prompt: `user` = submitted from the interactive composer, `sdk` = non-interactive entrypoint (`-p` / Agent SDK), `loop_wakeup` = dynamic /loop wakeup, `schedule_wakeup` = scheduled-task fire (CronCreate/routine), `system` = other machine-injected turns (peer/channel messages, task notifications, auto-continuation), `poll_event` = the poll-event channel enqueue-time pass (the hook fires when the host submits an event, before its delivery ack exists - a blocking verdict rejects the event). Payloads may omit it while the field rolls out.
11147	*/
11148	source?: 'user' \| 'sdk' \| 'system' \| 'loop_wakeup' \| 'schedule_wakeup' \| 'poll_event';
11149	session_title?: string;
11150	};
11151
11152	/**
11153	* The result of a call on `$` as the hooks on its event see it: `{ value }`,
11154	* the call's answer, or `{ deny }`, the reason the caller's promise rejects.
11155	*/
11156	type ValueOrDeny<Value> = {
11157	value: Value;
11158	deny?: undefined;
11159	} \| {
11160	deny: string;
11161	value?: undefined;
11162	};
11163
11164	type WorktreeCreateHookInput = BaseHookInput & {
11165	hook_event_name: 'WorktreeCreate';
11166	name: string;
11167	};
11168
11169	type WorktreeRemoveHookInput = BaseHookInput & {
11170	hook_event_name: 'WorktreeRemove';
11171	worktree_path: string;
11172	};
11173
11174	/**
11175	* The globals of a hooks module's environment: these and no others (no DOM,
11176	* no Node). No code generation either: `eval` and `new Function` over a
11177	* string throw, and there is no `WebAssembly` (deliberately; a module that
11178	* needs compiled code runs it in a process of its own through `$.process.run`).
11179	* A surface module's environment (Client) has the same globals and a
11180	* `console`; neither has timers (a hooks module waits on `$.clock`, a
11181	* surface module on `surface.every`).
11182	*/
11183	global {
11184	/**
11185	* The JSX factory (classic runtime, `@jsx h`; the engine prepends the
11186	* pragma): a plain-data element from a string tag or a component.
11187	*
11188	* JSX compiles to bare `h(...)` calls resolved by name, so a module (hooks or
11189	* surface) never declares, imports or takes as a parameter anything named
11190	* `h` or `Fragment` where it writes JSX, and carries no `@jsx` pragma of its
11191	* own: either silently points its JSX away from this factory, and a
11192	* `<Client>` tag written under another factory is not found when the
11193	* module's surface modules are read off its source.
11194	*/
11195	const h: (
11196	tag: string \| ((props: never) => RenderNode \| null \| undefined),
11197	props: Record<string, unknown> \| null \| undefined,
11198	...children: unknown[]
11199	) => RenderNode \| null \| undefined
11200
11201	/**
11202	* `<>...</>`: a column Box around the children.
11203	*/
11204	const Fragment: (props: { children?: RenderNode[] }) => RenderElement
11205
11206	/**
11207	* JSX over the element table: every tag is a constructor from
11208	* `$.ui.resolve(e)` (`const { Box, Text } = $.ui.resolve(e)`), typed by
11209	* its props; there are no intrinsic (string) tags.
11210	*/
11211	namespace JSX {
11212	type Element = RenderElement
11213	type Children = RenderChildren
11214	type ElementType = (props: never) => RenderNode \| null \| undefined
11215	interface IntrinsicElements {}
11216	interface ElementChildrenAttribute {
11217	children: unknown
11218	}
11219	interface IntrinsicAttributes {
11220	key?: string
11221	}
11222	}
11223
11224	interface AbortSignal {
11225	readonly aborted: boolean
11226	readonly reason: unknown
11227	throwIfAborted(): void
11228	addEventListener(
11229	type: 'abort',
11230	listener: () => void,
11231	options?: { once?: boolean },
11232	): void
11233	removeEventListener(type: 'abort', listener: () => void): void
11234	}
11235	var AbortSignal: {
11236	prototype: AbortSignal
11237	abort(reason?: unknown): AbortSignal
11238	timeout(milliseconds: number): AbortSignal
11239	any(signals: AbortSignal[]): AbortSignal
11240	}
11241	interface AbortController {
11242	readonly signal: AbortSignal
11243	abort(reason?: unknown): void
11244	}
11245	var AbortController: {
11246	prototype: AbortController
11247	new (): AbortController
11248	}
11249	interface TextEncoder {
11250	readonly encoding: string
11251	encode(input?: string): Uint8Array
11252	}
11253	var TextEncoder: { prototype: TextEncoder; new (): TextEncoder }
11254	interface TextDecoder {
11255	readonly encoding: string
11256	decode(input?: ArrayBufferView \| ArrayBuffer): string
11257	}
11258	var TextDecoder: { prototype: TextDecoder; new (label?: string): TextDecoder }
11259	interface URLSearchParams {
11260	append(name: string, value: string): void
11261	delete(name: string): void
11262	get(name: string): string \| null
11263	getAll(name: string): string[]
11264	has(name: string): boolean
11265	set(name: string, value: string): void
11266	toString(): string
11267	forEach(callback: (value: string, key: string) => void): void
11268	}
11269	var URLSearchParams: {
11270	prototype: URLSearchParams
11271	new (init?: string \| Record<string, string> \| string[][]): URLSearchParams
11272	}
11273	interface URL {
11274	hash: string
11275	host: string
11276	hostname: string
11277	href: string
11278	readonly origin: string
11279	password: string
11280	pathname: string
11281	port: string
11282	protocol: string
11283	search: string
11284	readonly searchParams: URLSearchParams
11285	username: string
11286	toString(): string
11287	toJSON(): string
11288	}
11289	var URL: {
11290	prototype: URL
11291	new (url: string, base?: string \| URL): URL
11292	canParse(url: string, base?: string): boolean
11293	}
11294	function atob(data: string): string
11295	function btoa(data: string): string
11296	function structuredClone<T>(value: T): T
11297	var crypto: {
11298	readonly subtle: {
11299	digest(
11300	algorithm: string \| { name: string },
11301	data: ArrayBufferView \| ArrayBuffer,
11302	): Promise<ArrayBuffer>
11303	}
11304	randomUUID(): string
11305	getRandomValues<T extends ArrayBufferView>(array: T): T
11306	}
11307	var performance: { now(): number }
11308	}
11309	}
11310
11311	declare module 'claude-code/testing' {
11312	import type { Args } from 'claude-code';
11313	import type { Chunk } from 'claude-code';
11314	import type { ClientKeyEvent } from 'claude-code';
11315	import type { ClientPointerEvent } from 'claude-code';
11316	import type { Elements } from 'claude-code';
11317	import type { EventCalls } from 'claude-code';
11318	import type { EventName } from 'claude-code';
11319	import type { HookStream } from 'claude-code';
11320	import type { JsonValue } from 'claude-code';
11321	import type { On } from 'claude-code';
11322	import type { PressedLink } from 'claude-code';
11323	import type { Register } from 'claude-code';
11324	import type { RenderComponent } from 'claude-code';
11325	import type { RenderElement } from 'claude-code';
11326	import type { RenderPropsOf } from 'claude-code';
11327	import type { RenderSurface } from 'claude-code';
11328	import type { RenderViewport } from 'claude-code';
11329	import type { ResultOf } from 'claude-code';
11330	import type { StreamingEventName } from 'claude-code';
11331	import type { Tier } from 'claude-code';
11332	import type { UiInputArgument } from 'claude-code';
11333	import type { UiInputResult } from 'claude-code';
11334	import type { UiPressResult } from 'claude-code';
11335	import type { UiSelectResult } from 'claude-code';
11336
11337	/**
11338	* A value that matches by a rule inside `toEqual` and its kin
11339	* (`expect.any`, `expect.objectContaining`), known by its text in a failure.
11340	*/
11341	export type AsymmetricMatcher = {
11342	readonly text: string;
11343	};
11344
11345	/**
11346	* The same checks on what a promise received settles with, each resolving
11347	* once the promise has settled and the check passed.
11348	*/
11349	export type AsyncMatchers = {
11350	[K in keyof Matchers]: (...args: Parameters<Matchers[K]>) => Promise<void>;
11351	};
11352
11353	/**
11354	* Which `Client` of a mounted drawing an act or a read means, by the `key`
11355	* its element carries; optional while the drawing holds exactly one.
11356	*/
11357	export type ClientScope = {
11358	in?: string;
11359	};
11360
11361	/**
11362	* A class, as `toThrow`, `toBeInstanceOf` and `expect.any` take it.
11363	*/
11364	export type Constructor = abstract new (...args: never[]) => unknown;
11365
11366	/**
11367	* A group of tests: its name leads the title of each test declared inside,
11368	* and its body runs at once, while the file loads.
11369	*
11370	* @param name the group's name
11371	* @param body declares the group's tests
11372	*/
11373	export const describe: (name: string, body: () => void) => void;
11374
11375	/**
11376	* The element each surface-dependent act of a mounted drawing reaches: a
11377	* handle carries the act only where the surface's table has the element.
11378	*
11379	* `input` needs `Input` and `select` needs `Select` (every surface but
11380	* mobile today); `key`, `pointer`, `post`, `advance` and `resize` reach a
11381	* `Client` (terminal and desktop today). The rest need nothing but a tree.
11382	*/
11383	export type ElementOfAct = {
11384	input: 'Input';
11385	select: 'Select';
11386	key: 'Client';
11387	pointer: 'Client';
11388	post: 'Client';
11389	advance: 'Client';
11390	resize: 'Client';
11391	};
11392
11393	/**
11394	* What a mounted drawing's `find` and `findAll` match an element on, every
11395	* field given at once: its tag, its `key`, and the text it shows.
11396	*
11397	* `text` matches the element's whole shown text (string children, a Button
11398	* or Link's label, a Markdown's text, a Code's source, an Input's value):
11399	* a string by inclusion, a RegExp by test.
11400	*
11401	* @example
11402	* await ui.findAll({ type: 'Text', text: /overdue/, in: 'board' })
11403	*/
11404	export type ElementQuery = {
11405	type?: string;
11406	key?: string;
11407	text?: string \| RegExp;
11408	/**
11409	* Searches what this `Client`'s surface module drew (by the `Client`'s
11410	* key) instead of the plugin's own tree.
11411	*/
11412	in?: string;
11413	};
11414
11415	/**
11416	* What a test holds as `$`, the engine's own: every call on it is made as
11417	* the REPL, the query loop and the render sites make theirs, over every plugin.
11418	*
11419	* `next.origin` is the engine, and the whole chain runs over the plugins
11420	* loaded. A tool call's `tool_use_id` is minted when left out; `$.ui.mount`
11421	* is a surface the test names drawing an instance, `$.ui.press` a press on it.
11422	*/
11423	export type Engine = {
11424	[N in keyof EventCalls]: N extends 'ui' ? EngineNoun<N> & EnginePress & EngineMount : EngineNoun<N>;
11425	};
11426
11427	/**
11428	* One call on the engine's `$`: the event's input whole, as an engine call
11429	* site passes it, to its result, or for a streaming event to its stream.
11430	*/
11431	export type EngineCall<E extends EventName> = E extends StreamingEventName ? (e: Args<E>) => HookStream<Chunk<E>, ResultOf[E]> : (e: Args<E>) => Promise<ResultOf[E]>;
11432
11433	/**
11434	* A surface drawing a component instance through the plugins, then driven
11435	* by key through a handle typed by that surface (Mounted).
11436	*
11437	* `ui.render` raised there for those props, the tree validated by that
11438	* table, its `Client`s running; the reads and `press` on every surface,
11439	* `input` where the table has `Input`, the `Client` acts where `Client`.
11440	*
11441	* @example
11442	* for (const surface of SURFACES) run(await $.ui.mount({ ...HINT, surface }))
11443	*/
11444	export type EngineMount = {
11445	/**
11446	* Raises the plugins' drawing of the component on the surface and holds
11447	* it, as that surface showing the instance does.
11448	*
11449	* Resolves once the tree validated and every `Client` in it drew once.
11450	*
11451	* @param target whose elements, the surface, the component, its props,
11452	* the instance's requestId, and what the surface measured
11453	* @returns the mounted drawing; rejects when no `surface` (or an unknown
11454	* one) is named, when the surface cannot draw the tree the chain
11455	* returned (with the reason: an element its table lacks, a prop not
11456	* allowed), or when a `Client`'s module failed or drew nothing
11457	*/
11458	mount: <P extends RenderSurface, C extends RenderComponent>(target: MountTarget<P, C>) => Promise<Mounted<P, C>>;
11459	};
11460
11461	/**
11462	* One noun of the engine's `$`: each of its events as the engine calls it,
11463	* `tool.call` and `ui.render` typed per tool and component, `ui.resolve` out.
11464	*/
11465	export type EngineNoun<N extends keyof EventCalls> = {
11466	[V in EngineNounEvent<N>]: `${N}.${V}` extends 'tool.call' \| 'ui.render' ? EventCalls[N][V] : EngineCall<`${N}.${V}` & EventName>;
11467	};
11468
11469	/**
11470	* The events of one noun a test's `$` carries: every one but `ui.resolve`,
11471	* which a render hook calls on its own `$` and the engine never raises.
11472	*/
11473	export type EngineNounEvent<N extends keyof EventCalls> = Exclude<keyof EventCalls[N] & string, `${N}.resolve` extends 'ui.resolve' ? 'resolve' : never>;
11474
11475	/**
11476	* A surface pressing a Button a test rendered, or a Markdown's link: the
11477	* `ui.press` chain over every plugin hooked on it, its own closure last.
11478	*/
11479	export type EnginePress = {
11480	/**
11481	* Presses the Button, as a click or its hotkey does; with `link`, the
11482	* Markdown's link, as a click on it does.
11483	*
11484	* `e.surface` is the surface of the drawing that holds it.
11485	*
11486	* @param target whose element, its key, the instance and surface when
11487	* several hold it, and for a Markdown the link
11488	* @returns what the chain settled on; rejects when no such element is
11489	* drawn, or several are and neither instance nor surface tells them apart
11490	*/
11491	press: (target: PressTarget) => Promise<UiPressResult \| undefined>;
11492	};
11493
11494	/**
11495	* The checks on a value (`expect(received)`), and with them the matchers
11496	* that stand inside an expected value (`expect.any(Number)`).
11497	*/
11498	export type Expect = Expecting & Matching;
11499
11500	/**
11501	* Checks a value: `expect(received).toEqual(expected)` throws an
11502	* AssertionError naming both sides when it fails, a message given leading.
11503	*
11504	* `.not` negates; `.resolves` and `.rejects` check what a promise settles
11505	* with; `expect.any(Number)` and its kin stand inside an expected value.
11506	*/
11507	export const expect: Expect;
11508
11509	/**
11510	* What `expect(received)` answers: the checks, their negation, and the
11511	* checks on what a promise received resolves or rejects with.
11512	*/
11513	export type Expectation = Negatable<Matchers> & {
11514	/**
11515	* The checks on what the promise received resolves with; a rejection
11516	* fails them.
11517	*/
11518	resolves: Negatable<AsyncMatchers>;
11519	/**
11520	* The checks on what the promise received rejects with; a resolution
11521	* fails them.
11522	*/
11523	rejects: Negatable<AsyncMatchers>;
11524	};
11525
11526	/**
11527	* `expect(received, message?)`: the checks on a value, a message of the
11528	* test's own leading a failure's.
11529	*/
11530	export type Expecting = (received: unknown, message?: string) => Expectation;
11531
11532	/**
11533	* One element of a mounted drawing as `find` returns it: the description
11534	* the plugin's hook (or a `Client`'s module) built, read as plain data.
11535	*
11536	* What every surface is handed to draw, not what any surface painted: the
11537	* same on the terminal, the desktop, VS Code and mobile.
11538	*/
11539	export type FoundElement = {
11540	/**
11541	* The element's tag: `Box`, `Text`, `Button`, `Input`, `Client`, ...
11542	*/
11543	type: string;
11544	/**
11545	* What its props carry as `key`, when they do.
11546	*/
11547	key: string \| undefined;
11548	/**
11549	* Its props, plain data: a Button's `label`, a Text's `color`, ...;
11550	* handlers never cross (a Button's `onPress` is not here).
11551	*/
11552	props: Record<string, unknown>;
11553	/**
11554	* What it shows: its string children in document order and, for the
11555	* leaves that draw a prop as text, that prop (ElementQuery `text`).
11556	*/
11557	text: string;
11558	/**
11559	* Its children as drawn: strings and element descriptions.
11560	*/
11561	children: unknown[];
11562	};
11563
11564	/**
11565	* The checks `expect(received)` offers; each throws an AssertionError when
11566	* it fails, naming what was expected and what was received.
11567	*/
11568	export type Matchers = {
11569	/**
11570	* Passes when received is the value, by `Object.is`.
11571	*
11572	* @param expected the value
11573	*/
11574	toBe: (expected: unknown) => void;
11575	/**
11576	* Passes when received equals the value in structure, properties holding
11577	* undefined ignored; `expect.any` and its kin match inside it.
11578	*
11579	* @param expected the value
11580	*/
11581	toEqual: (expected: unknown) => void;
11582	/**
11583	* As `toEqual`, but undefined properties and prototypes count.
11584	*
11585	* @param expected the value
11586	*/
11587	toStrictEqual: (expected: unknown) => void;
11588	/**
11589	* Passes when received holds at least the object's properties, equal.
11590	*
11591	* @param expected the object
11592	*/
11593	toMatchObject: (expected: object) => void;
11594	/**
11595	* Passes when a string received includes the item, or an iterable
11596	* received has an element that is it.
11597	*
11598	* @param item the substring or element
11599	*/
11600	toContain: (item: unknown) => void;
11601	/**
11602	* Passes when an iterable received has an element equal to the item.
11603	*
11604	* @param item the element
11605	*/
11606	toContainEqual: (item: unknown) => void;
11607	/**
11608	* Passes when received's `length` is the number.
11609	*
11610	* @param length the number
11611	*/
11612	toHaveLength: (length: number) => void;
11613	/**
11614	* Passes when received holds a property at the path (`a.b`, or the keys
11615	* in order), equal to the value when one is given.
11616	*
11617	* @param path the property's path
11618	* @param value what it must equal, when given
11619	*/
11620	toHaveProperty: (path: string \| readonly string[], value?: unknown) => void;
11621	/**
11622	* Passes when received is undefined.
11623	*/
11624	toBeUndefined: () => void;
11625	/**
11626	* Passes when received is anything but undefined.
11627	*/
11628	toBeDefined: () => void;
11629	/**
11630	* Passes when received is null.
11631	*/
11632	toBeNull: () => void;
11633	/**
11634	* Passes when received is truthy.
11635	*/
11636	toBeTruthy: () => void;
11637	/**
11638	* Passes when received is falsy.
11639	*/
11640	toBeFalsy: () => void;
11641	/**
11642	* Passes when received is NaN.
11643	*/
11644	toBeNaN: () => void;
11645	/**
11646	* Passes when received is greater than the bound.
11647	*
11648	* @param bound the bound
11649	*/
11650	toBeGreaterThan: (bound: number \| bigint) => void;
11651	/**
11652	* Passes when received is the bound or greater.
11653	*
11654	* @param bound the bound
11655	*/
11656	toBeGreaterThanOrEqual: (bound: number \| bigint) => void;
11657	/**
11658	* Passes when received is less than the bound.
11659	*
11660	* @param bound the bound
11661	*/
11662	toBeLessThan: (bound: number \| bigint) => void;
11663	/**
11664	* Passes when received is the bound or less.
11665	*
11666	* @param bound the bound
11667	*/
11668	toBeLessThanOrEqual: (bound: number \| bigint) => void;
11669	/**
11670	* Passes when a string received includes the text, or the pattern matches
11671	* it.
11672	*
11673	* @param pattern the text or pattern
11674	*/
11675	toMatch: (pattern: string \| RegExp) => void;
11676	/**
11677	* Passes when a string received starts with the prefix.
11678	*
11679	* @param prefix the prefix
11680	*/
11681	toStartWith: (prefix: string) => void;
11682	/**
11683	* Passes when a string received ends with the suffix.
11684	*
11685	* @param suffix the suffix
11686	*/
11687	toEndWith: (suffix: string) => void;
11688	/**
11689	* Passes when received is an instance of the class.
11690	*
11691	* @param expected the class
11692	*/
11693	toBeInstanceOf: (expected: Constructor) => void;
11694	/**
11695	* Passes when calling received throws (or, under `rejects`, the rejection
11696	* is) an error as described: by substring, pattern, class or message.
11697	*
11698	* @param expected the description; any throw passes without one
11699	*/
11700	toThrow: (expected?: ThrowExpectation) => void;
11701	};
11702
11703	/**
11704	* The matchers that stand inside an expected value, each matching received
11705	* there by a rule instead of by equality.
11706	*/
11707	export type Matching = {
11708	/**
11709	* Matches any instance of the class, a primitive by its wrapper
11710	* (`expect.any(Number)`).
11711	*
11712	* @param expected the class
11713	* @returns the matcher
11714	*/
11715	any: (expected: Constructor) => AsymmetricMatcher;
11716	/**
11717	* Matches anything but null and undefined.
11718	*
11719	* @returns the matcher
11720	*/
11721	anything: () => AsymmetricMatcher;
11722	/**
11723	* Matches a string that includes the text.
11724	*
11725	* @param text the substring
11726	* @returns the matcher
11727	*/
11728	stringContaining: (text: string) => AsymmetricMatcher;
11729	/**
11730	* Matches a string the pattern matches.
11731	*
11732	* @param pattern the pattern, or the source of one
11733	* @returns the matcher
11734	*/
11735	stringMatching: (pattern: string \| RegExp) => AsymmetricMatcher;
11736	/**
11737	* Matches an object holding at least the shape's properties, equal.
11738	*
11739	* @param shape the properties
11740	* @returns the matcher
11741	*/
11742	objectContaining: (shape: object) => AsymmetricMatcher;
11743	/**
11744	* Matches an array holding an element equal to each of the items.
11745	*
11746	* @param items the elements
11747	* @returns the matcher
11748	*/
11749	arrayContaining: (items: readonly unknown[]) => AsymmetricMatcher;
11750	};
11751
11752	/**
11753	* The world beneath the plugins, mocked noun by noun: each member registers
11754	* hooks of the test's on `on`, visible where the test calls it.
11755	*/
11756	export type Mock = {
11757	/**
11758	* Answers `$.clock` from a clock in memory that moves only when the test
11759	* moves it: `clock.now` reads it, and each wait is held.
11760	*
11761	* A held wait resolves when an advance crosses the time it is due, and is
11762	* dropped when its dispatch aborts; one held past a hook's budget (ten
11763	* seconds of real time) is let go, as a hook that overran.
11764	*
11765	* @param on the test's `on`
11766	* @param options where the clock starts (`now`, 0 when not given)
11767	* @returns the clock: its time, and the calls that move it
11768	*/
11769	clock: (on: On, options?: MockClockOptions) => MockClock;
11770	/**
11771	* Answers `$.store` from a store in memory: `get`, `set`, `delete` and
11772	* `keys` over it, as the engine keeps a plugin's own.
11773	*
11774	* @param on the test's `on`
11775	* @param entries what the store holds at the start (nothing when not given)
11776	*/
11777	store: (on: On, entries?: Readonly<Record<string, unknown>>) => void;
11778	/**
11779	* Answers `$.env.get` from a set of variables; one not listed is unset.
11780	*
11781	* @param on the test's `on`
11782	* @param variables the environment the plugins read
11783	*/
11784	env: (on: On, variables: Readonly<Record<string, string>>) => void;
11785	};
11786
11787	/**
11788	* The world beneath the plugins, mocked noun by noun: `mock.clock`,
11789	* `mock.store` and `mock.env`.
11790	*
11791	* Each registers hooks of the test's on the `on` it is handed, visible where
11792	* the test calls it, and answers its noun from memory.
11793	*/
11794	export const mock: Mock;
11795
11796	/**
11797	* The clock `mock.clock` hands back: the time its hooks answer, and the only
11798	* ways it moves.
11799	*/
11800	export type MockClock = {
11801	/**
11802	* The time now, in milliseconds: what `$.clock.now()` resolves beneath the
11803	* plugins.
11804	*
11805	* @returns the time
11806	*/
11807	now: () => number;
11808	/**
11809	* Moves the clock on, resolving each wait due on the way (`$.clock.sleep`,
11810	* `after`, `every`, this clock's `sleep`) in the order it comes due.
11811	*
11812	* The clock reads each wait's time as it resolves, and what one started
11813	* runs before the next resolves.
11814	*
11815	* @param ms how far to move, in milliseconds
11816	* @returns resolves once the clock is there and the event loop settled
11817	*/
11818	advance: (ms: number) => Promise<void>;
11819	/**
11820	* Moves the clock to a time at or past now, as `advance` would.
11821	*
11822	* @param ms the time, in milliseconds
11823	* @returns resolves once the clock is there and the event loop settled
11824	*/
11825	set: (ms: number) => Promise<void>;
11826	/**
11827	* Lets what is already under way run as far as it can without the clock
11828	* moving: every wait due now resolves and the event loop settles.
11829	*
11830	* The same as `advance(0)`; the name for the step between starting a
11831	* dispatch unawaited and looking at what it did.
11832	*
11833	* @returns resolves once the event loop settled, the time where it was
11834	*/
11835	settle: () => Promise<void>;
11836	/**
11837	* Resolves once the clock has moved this far past now: how a hook of the
11838	* test's answers late.
11839	*
11840	* @param ms how far, in milliseconds
11841	* @returns resolves when an advance crosses that time
11842	*/
11843	sleep: (ms: number) => Promise<void>;
11844	};
11845
11846	/**
11847	* Where a mocked clock starts: `now`, in milliseconds (0 when not given).
11848	*/
11849	export type MockClockOptions = {
11850	now?: number;
11851	};
11852
11853	/**
11854	* A drawing of component `C` the test mounted on surface `P`: reads over its
11855	* description, acts on its elements by key, `Client` acts where `P` has one.
11856	*
11857	* Narrowed by the `surface` the test passed, as `e.surface` narrows
11858	* `$.ui.resolve(e)`: no `input` on `mobile`, no `key` on `vscode`, whose
11859	* tables (Elements) lack `Input` and `Client`; over a union, their meet.
11860	*/
11861	export type Mounted<P extends RenderSurface = RenderSurface, C extends RenderComponent = RenderComponent> = {
11862	[K in keyof MountedMembers<P, C> as K extends keyof ElementOfAct ? ElementOfAct[K] extends keyof Elements[P] ? K : never : K]: MountedMembers<P, C>[K];
11863	};
11864
11865	/**
11866	* Every member a mounted drawing of component `C` can have; `Mounted<P, C>`
11867	* keeps the ones surface `P` has the element for (ElementOfAct).
11868	*
11869	* Each act resolves once the loop settled and what a plugin invalidated
11870	* was drawn again. The kit exercises the mod (its hooks, its description
11871	* under the surface's rules, its `Client` modules), never a surface's paint.
11872	*/
11873	export type MountedMembers<P extends RenderSurface, C extends RenderComponent = RenderComponent> = {
11874	/**
11875	* Where this drawing is, as the test named it.
11876	*/
11877	readonly surface: P;
11878	/**
11879	* The tree as last drawn: what the plugins' `ui.render` chain returned
11880	* for this instance, validated by the surface's table, as plain data.
11881	*
11882	* With `in`, what that `Client`'s surface module last drew instead.
11883	*
11884	* @param scope `{ in }`: a `Client`'s key, to read its module's tree
11885	* @returns the tree; rejects with the refusal when the surface could not
11886	* draw what the chain returned, or with a `Client`'s fault line
11887	* @example
11888	* expect(await ui.drawn()).toMatchObject({ type: 'Box' })
11889	*/
11890	drawn: (scope?: ClientScope) => Promise<RenderElement>;
11891	/**
11892	* The first element matching the query, outermost first in document
11893	* order, or undefined.
11894	*
11895	* @param query tag, key and shown text to match; `in` to search a Client
11896	* @returns the element's description, or undefined when none matches
11897	* @example
11898	* expect((await ui.find({ key: 'count' }))?.text).toBe('3 notes')
11899	*/
11900	find: (query: ElementQuery) => Promise<FoundElement \| undefined>;
11901	/**
11902	* Every element matching the query, in document order.
11903	*
11904	* @param query tag, key and shown text to match; `in` to search a Client
11905	* @returns the matching elements' descriptions
11906	* @example
11907	* expect(await ui.findAll({ type: 'Button' })).toHaveLength(2)
11908	*/
11909	findAll: (query: ElementQuery) => Promise<FoundElement[]>;
11910	/**
11911	* Presses the Button keyed `key`, as the person activating it on this
11912	* surface does: the `ui.press` chain, the Button's own `onPress` last.
11913	*
11914	* `e.surface` is this drawing's. With `link`, presses that link of the
11915	* Markdown keyed `key` instead. A Button a `Client`'s module drew is
11916	* pressed the same way, by its key.
11917	*
11918	* @param target the key; another plugin's name to press its Button; a link
11919	* @returns what the chain settled on
11920	* @example
11921	* await ui.press({ key: 'save' })
11922	*/
11923	press: (target: MountPressTarget) => Promise<UiPressResult \| undefined>;
11924	/**
11925	* Types into the Input keyed `key`: the `ui.input` chain with the text as
11926	* `e.value`, the Input's own handler last.
11927	*
11928	* `kind` `submit` (the default) is Enter with that text, `change` an edit
11929	* that leaves it in the field.
11930	*
11931	* @param target the key and the text; `kind`; another plugin's name
11932	* @returns what the chain settled on
11933	* @example
11934	* await ui.input({ key: 'title', text: 'groceries' })
11935	*/
11936	input: (target: MountInputTarget) => Promise<UiInputResult \| undefined>;
11937	/**
11938	* Picks `value` in the Select keyed `key`: the `ui.select` chain, the
11939	* Select's own `onSelect` last.
11940	*
11941	* @param target the key and the option's value; another plugin's name
11942	* @returns what the chain settled on
11943	* @example
11944	* await ui.select({ key: 'sort', value: 'date' })
11945	*/
11946	select: (target: MountSelectTarget) => Promise<UiSelectResult \| undefined>;
11947	/**
11948	* Hands a `Client`'s `onKey` listener one key, as a key pressed while
11949	* its region has the focus does.
11950	*
11951	* `in` names the `Client` by key; optional when the drawing holds one.
11952	*
11953	* @param event the key (`{ key: 'right' }`, `{ key: 'a', ctrl: true }`)
11954	* @example
11955	* await ui.key({ key: 'return', in: 'board' })
11956	*/
11957	key: (event: MountKeyEvent) => Promise<void>;
11958	/**
11959	* Hands a `Client`'s `onPointer` listener one event, in the cells of its
11960	* region as every surface that draws a `Client` reports them.
11961	*
11962	* @param event the event (`{ type: 'down', x: 3, y: 0, button: 'left' }`)
11963	* @example
11964	* await ui.pointer({ type: 'down', x: 2, y: 0, button: 'left' })
11965	*/
11966	pointer: (event: MountPointerEvent) => Promise<void>;
11967	/**
11968	* Posts as a `Client`'s own `surface.post(data)` does: the plugin's
11969	* `ui.message` hooks run with `e.data`, `e.surface` this drawing's.
11970	*
11971	* A `{ props }` they answer reaches the instance, which redraws with
11972	* its state kept.
11973	*
11974	* @param data plain data (JsonValue)
11975	* @param scope `{ in }`: which `Client`, when the drawing holds several
11976	* @example
11977	* await ui.post({ pick: 2 })
11978	*/
11979	post: (data: JsonValue, scope?: ClientScope) => Promise<void>;
11980	/**
11981	* Moves the drawing's frame clock on: each `surface.every(ms, fn)` timer
11982	* of its `Client`s fires at every interval of its own the move crosses.
11983	*
11984	* @param ms how far, in milliseconds
11985	* @example
11986	* await ui.advance(250)
11987	*/
11988	advance: (ms: number) => Promise<void>;
11989	/**
11990	* Lays a `Client`'s region out at a size, as the surface measuring it
11991	* does: what its module reads as `surface.columns` and `surface.rows`.
11992	*
11993	* @param size cells across and down; `in`: which `Client`
11994	* @example
11995	* await ui.resize({ columns: 40, rows: 3 })
11996	*/
11997	resize: (size: MountResizeTarget) => Promise<void>;
11998	/**
11999	* Draws the instance again, as the engine does when its props change (a
12000	* tool row's output arrived): the `ui.render` chain with the next props.
12001	*
12002	* A plugin's own `$.ui.invalidate` needs no call: the drawing follows it
12003	* before the next read.
12004	*
12005	* @param props the component's next props; the current ones when absent
12006	* @example
12007	* await ui.redraw({ ...TOOL_ROW, isRunning: false, output: 'done' })
12008	*/
12009	redraw: (props?: RenderPropsOf[C]) => Promise<void>;
12010	/**
12011	* Lets the drawing go, as the surface dropping the instance does: its
12012	* `Client`s and their timers end. Later acts on the handle reject.
12013	*
12014	* @example
12015	* await ui.unmount()
12016	*/
12017	unmount: () => Promise<void>;
12018	};
12019
12020	/**
12021	* What a mounted drawing's `input` takes: the Input's key, the text, which
12022	* of the two inputs it is (`submit` when unsaid), another plugin's name.
12023	*/
12024	export type MountInputTarget = {
12025	key: string;
12026	text: string;
12027	kind?: UiInputArgument['kind'];
12028	plugin?: string;
12029	};
12030
12031	/**
12032	* What a mounted drawing's `key` takes: the key as a `Client`'s `onKey`
12033	* listener receives it (ClientKeyEvent), and which `Client` when several.
12034	*/
12035	export type MountKeyEvent = ClientKeyEvent & ClientScope;
12036
12037	/**
12038	* What a mounted drawing's `pointer` takes: the event as a `Client`'s
12039	* `onPointer` listener receives it, in its region's cells, and which one.
12040	*/
12041	export type MountPointerEvent = ClientPointerEvent & ClientScope;
12042
12043	/**
12044	* What a mounted drawing's `press` takes: the Button's key, another
12045	* plugin's name when the Button is not the mounted plugin's, a link.
12046	*/
12047	export type MountPressTarget = {
12048	key: string;
12049	plugin?: string;
12050	/**
12051	* Presses this link of the Markdown keyed `key` instead of a Button.
12052	*/
12053	link?: PressedLink;
12054	};
12055
12056	/**
12057	* What a mounted drawing's `resize` takes: a `Client` region's size in
12058	* cells, as the surface measuring it hands it, and which `Client`.
12059	*/
12060	export type MountResizeTarget = {
12061	columns: number;
12062	rows: number;
12063	in?: string;
12064	};
12065
12066	/**
12067	* What a mounted drawing's `select` takes: the Select's key, the picked
12068	* option's value, another plugin's name when the Select is not its own.
12069	*/
12070	export type MountSelectTarget = {
12071	key: string;
12072	value: string;
12073	plugin?: string;
12074	};
12075
12076	/**
12077	* What `$.ui.mount` takes: whose elements the test will act on, the surface
12078	* that draws, and the component instance the engine asks the plugins for.
12079	*
12080	* The envelope a `ui.render` hook sees as `e` (`surface`, `component`,
12081	* `requestId`, `viewport`, `props`) plus `plugin`. `surface` is never
12082	* defaulted: one body run over several surfaces is what shows independence.
12083	*
12084	* @example
12085	* $.ui.mount({ plugin: 'notes', surface, component: 'Pane', props: PANE })
12086	*/
12087	export type MountTarget<P extends RenderSurface = RenderSurface, C extends RenderComponent = RenderComponent> = {
12088	/**
12089	* Whose elements the handle's acts address by bare `key`: the plugin
12090	* under test, usually. An act names another plugin to reach its element.
12091	*/
12092	plugin: string;
12093	/**
12094	* What draws: its element table validates every tree the plugins
12095	* return, and every dispatch the handle raises carries it as `e.surface`.
12096	*
12097	* One of `terminal`, `desktop`, `vscode`, `mobile`.
12098	*/
12099	surface: P;
12100	/**
12101	* Which component the engine asks the plugins to draw (`Pane`,
12102	* `AbovePrompt`, `ToolUse`, ...): what a `ui.render` matcher narrows on.
12103	*/
12104	component: C;
12105	/**
12106	* The component's props, what the hook reads as `e.props`.
12107	*/
12108	props: RenderPropsOf[C];
12109	/**
12110	* The instance drawn (a pane's id, a tool row's tool_use_id); one is
12111	* minted when absent. Two mounts of one component are two instances.
12112	*/
12113	requestId?: string;
12114	/**
12115	* What the surface measured, as the hook reads it under `e.viewport`;
12116	* absent when the surface has not measured, as on `e`.
12117	*
12118	* Cells across and down in the surface's monospace metric and whether it
12119	* docks a pane. A `Client` in the drawing starts laid out at this size
12120	* (0 by 0 when absent) until the handle's `resize` lays its region out.
12121	*/
12122	viewport?: RenderViewport;
12123	};
12124
12125	/**
12126	* A set of checks and, under `not`, the same set passing where they fail.
12127	*/
12128	export type Negatable<M> = M & {
12129	/**
12130	* The checks negated.
12131	*/
12132	not: M;
12133	};
12134
12135	/**
12136	* Written inline in a test and loaded as a plugin folder is: its name, the
12137	* tier it loads in (`user` when not given), and its hooks module's `register`.
12138	*
12139	* `register` is written `register(on) { ... }` and is self-contained, as a
12140	* module's is: it closes over nothing of the test file.
12141	*/
12142	export type Plugin = {
12143	name: string;
12144	tier?: PluginTier;
12145	register: Register;
12146	};
12147
12148	/**
12149	* A tier a plugin loads in: every tier but the engine's own.
12150	*/
12151	export type PluginTier = Exclude<Tier, 'core'>;
12152
12153	/**
12154	* What `$.ui.press` takes: the plugin whose `ui.render` hook drew the element,
12155	* the `key` it gave it, the instance and surface when several, a `link`.
12156	*/
12157	export type PressTarget = {
12158	plugin: string;
12159	key: string;
12160	/**
12161	* Which instance holds it, when the plugin drew the key in several.
12162	*/
12163	requestId?: string;
12164	/**
12165	* Which surface's drawing, when the key is drawn on more than one; the
12166	* press carries the surface of the drawing it lands in either way.
12167	*/
12168	surface?: RenderSurface;
12169	/**
12170	* For a Markdown answering its links: which of them the press lands on.
12171	*/
12172	link?: PressedLink;
12173	};
12174
12175	/**
12176	* One test: it passes when its body returns or resolves, and fails when it
12177	* throws, rejects or outlasts its time (5000 ms, or `timeoutMs`).
12178	*
12179	* The body gets the engine's `$` and an `on` whose hooks sit beneath every
12180	* plugin; `plugins` load inline plugins beside the one under test. A failure
12181	* carries what the engine reported meanwhile: each hook it skipped, and why.
12182	*
12183	* @param name the test's name, led in its title by the describes around it
12184	* @param rest the body, `($, on) => ...`, or the options then the body
12185	*/
12186	export const test: (name: string, ...rest: TestRest) => void;
12187
12188	/**
12189	* A test: the engine's `$`, and `on`, a plugin's registrar, whose hooks sit
12190	* beneath every plugin; beneath them the bottom hook throws, naming its event.
12191	*
12192	* The plugins load at the test's first call on `$`, so a test registers its
12193	* hooks before it, as a module registers its own in `register()`.
12194	*/
12195	export type TestBody = ($: Engine, on: On) => unknown;
12196
12197	/**
12198	* What `test` takes beside its name: the inline plugins it loads beside the
12199	* one under test, and how long it may run (5000 ms when not given).
12200	*/
12201	export type TestOptions = {
12202	plugins?: readonly Plugin[];
12203	timeoutMs?: number;
12204	};
12205
12206	/**
12207	* What follows a test's name: its body, or its options then its body.
12208	*/
12209	export type TestRest = readonly [body: TestBody] \| readonly [options: TestOptions, body: TestBody];
12210
12211	/**
12212	* What `toThrow` compares the thrown error with: a substring or pattern of
12213	* its message, its class, a value carrying the whole message, or nothing.
12214	*/
12215	export type ThrowExpectation = string \| RegExp \| Constructor \| WithMessage;
12216
12217	/**
12218	* Says which tier the plugin under test loads in, once, at the top of the
12219	* file: `prepend`, `user` (when unsaid), `append` or `builtin`.
12220	*
12221	* @param tier the tier
12222	*/
12223	export const tier: (tier: PluginTier) => void;
12224
12225	/**
12226	* An error-like value `toThrow` compares by its whole message.
12227	*/
12228	export type WithMessage = {
12229	message: string;
12230	};
12231	}
12232
12233	// The inputs of the built-in tools this build has, from each tool's
12234	// input schema. Merges into ToolCallInput (BuiltinToolInputs) so
12235	// `e.tool === "Bash"` narrows to the tool's arguments.
12236	declare module 'claude-code' {
12237	interface BuiltinToolInputs {
12238	Agent: {
12239	/** A short (3-5 word) description of the task */
12240	description: string
12241	/** The task for the agent to perform */
12242	prompt: string
12243	/** The type of specialized agent to use for this task */
12244	subagent_type?: string
12245	/** Optional model override for this agent. Takes precedence over the agent definition's model frontmatter and the configured default subagent model. If omitted, uses the agent definition's model, else the default (inherits from the parent unless a default subagent model is configured). Ignored for subagent_type: "fork" — forks always inherit the parent model. */
12246	model?: "sonnet" \| "opus" \| "haiku" \| "fable"
12247	/** Agents run in the background by default; you will be notified when one completes. Set to false only when your very next action depends on this agent's result and nothing else could usefully happen while it runs — otherwise leave it in the background so the user can hand you other work. */
12248	run_in_background?: boolean
12249	/** Name for the spawned agent. Makes it addressable via SendMessage({to: name}) while running. */
12250	name?: string
12251	/** Deprecated; ignored. The session has a single implicit team. */
12252	team_name?: string
12253	/** Deprecated; ignored. Subagents inherit the parent session's permission mode; agent-definition frontmatter may override it. */
12254	mode?: "acceptEdits" \| "auto" \| "bypassPermissions" \| "default" \| "dontAsk" \| "plan"
12255	/** Isolation mode. "worktree" creates a temporary git worktree so the agent works on an isolated copy of the repo. "remote" launches the agent in a remote cloud environment (always runs in background; availability is gated). */
12256	isolation?: "worktree" \| "remote"
12257	}
12258	Bash: {
12259	/** The command to execute */
12260	command: string
12261	/** Optional timeout in milliseconds (max 600000) */
12262	timeout?: number
12263	/** Clear, concise description of what this command does in active voice. Never use words like "complex" or "risk" in the description - just describe what it does. Say what the command does in plain words: do not echo the command's text, its flags, or file paths - the user reads this description, often without seeing the command. For simple commands (git, npm, standard CLI tools), keep it brief (5-10 words): - ls → "List files in current directory" - git status → "Show working tree status" - npm install → "Install package dependencies" For commands that are harder to parse at a glance (piped commands, obscure flags, etc.), add enough context to clarify what it does: - find . -name ".tmp" -exec rm {} \; → "Find and delete all .tmp files recursively" - git reset --hard origin/main → "Discard all local changes and match remote main" - curl -s url \| jq '.data[]' → "Fetch JSON from URL and extract data array elements" /
12264	description?: string
12265	/** Set to true to run this command in the background. */
12266	run_in_background?: boolean
12267	/** Set this to true to dangerously override sandbox mode and run commands without sandboxing. */
12268	dangerouslyDisableSandbox?: boolean
12269	}
12270	CronCreate: {
12271	/** Standard 5-field cron expression in local time: "M H DoM Mon DoW" (e.g. "* /5 * * * " = every 5 minutes, "30 14 28 2 " = Feb 28 at 2:30pm local once). */
12272	cron: string
12273	/** The prompt to enqueue at each fire time. */
12274	prompt: string
12275	/** true (default) = fire on every cron match until deleted or auto-expired after 7 days. false = fire once at the next match, then auto-delete. Use false for "remind me at X" one-shot requests with pinned minute/hour/dom/month. */
12276	recurring?: boolean
12277	/** true = persist to .claude/scheduled_tasks.json and survive restarts. false (default) = in-memory only, dies when this Claude session ends. Use true only when the user asks the task to survive across sessions. */
12278	durable?: boolean
12279	}
12280	CronDelete: {
12281	/** Job ID returned by CronCreate. */
12282	id: string
12283	}
12284	CronList: {}
12285	Edit: {
12286	/** The absolute path to the file to modify */
12287	file_path: string
12288	/** The text to replace */
12289	old_string: string
12290	/** The text to replace it with (must be different from old_string) */
12291	new_string: string
12292	/** Replace all occurrences of old_string (default false) */
12293	replace_all?: boolean
12294	}
12295	EnterWorktree: {
12296	/** Optional name for a new worktree. Each "/"-separated segment may contain only letters, digits, dots, underscores, and dashes; max 64 chars total. A random name is generated if not provided. Mutually exclusive with `path`. */
12297	name?: string
12298	/** Path to an existing worktree to switch into instead of creating a new one. Must appear in `git worktree list` for the current repo — or, on first entry from the launch directory, for a repo nested inside it (multi-repo workspace). Mutually exclusive with `name`. */
12299	path?: string
12300	}
12301	ExitWorktree: {
12302	/** "keep" leaves the worktree and branch on disk; "remove" deletes both. */
12303	action: "keep" \| "remove"
12304	/** Required true when action is "remove" and the worktree has uncommitted files or unmerged commits. The tool will refuse and list them otherwise. */
12305	discard_changes?: boolean
12306	}
12307	ListAgents: {
12308	/** Not available in this build; leave unset. */
12309	channel?: string
12310	/** Not available in this build; leave unset. */
12311	q?: string
12312	}
12313	NotebookEdit: {
12314	/** The absolute path to the Jupyter notebook file to edit (must be absolute, not relative) */
12315	notebook_path: string
12316	/** The ID of the cell to edit. When inserting a new cell, the new cell will be inserted after the cell with this ID, or at the beginning if not specified. */
12317	cell_id?: string
12318	/** The new source for the cell */
12319	new_source: string
12320	/** The type of the cell (code or markdown). If not specified, it defaults to the current cell type. If using edit_mode=insert, this is required. */
12321	cell_type?: "code" \| "markdown"
12322	/** The type of edit to make (replace, insert, delete). Defaults to replace. */
12323	edit_mode?: "replace" \| "insert" \| "delete"
12324	}
12325	PowerShell: {
12326	/** The PowerShell command to execute */
12327	command: string
12328	/** Optional timeout in milliseconds (max 600000) */
12329	timeout?: number
12330	/** Clear, concise description of what this command does in active voice. */
12331	description?: string
12332	/** Set to true to run this command in the background. */
12333	run_in_background?: boolean
12334	/** Set this to true to dangerously override sandbox mode and run commands without sandboxing. */
12335	dangerouslyDisableSandbox?: boolean
12336	}
12337	Read: {
12338	/** The absolute path to the file to read */
12339	file_path: string
12340	/** The line number to start reading from. Only provide if the file is too large to read at once */
12341	offset?: number
12342	/** The number of lines to read. Only provide if the file is too large to read at once. */
12343	limit?: number
12344	/** Page range for PDF files (e.g., "1-5", "3", "10-20"). Only applicable to PDF files. Maximum 20 pages per request. */
12345	pages?: string
12346	}
12347	ReportFindings: {
12348	/** Effort level the review ran at */
12349	level?: "low" \| "medium" \| "high" \| "xhigh" \| "max"
12350	/** Verified findings, most-severe first; empty if none survived */
12351	findings: Array<{
12352	/** Repo-relative path of the file the finding is in */
12353	file: string
12354	/** 1-indexed line the finding anchors to */
12355	line?: number
12356	/** One-sentence statement of the defect */
12357	summary: string
12358	/** Compressed label for compact UI (≤60 chars): the claim alone, no rationale or consequence clause */
12359	short_summary?: string
12360	/** Concrete inputs/state → wrong output/crash */
12361	failure_scenario: string
12362	/** Short kebab-case slug of the finding type, e.g. "correctness", "simplification", "efficiency", "test-coverage" */
12363	category?: string
12364	/** Set when a verify pass ran; absent on inline-only reviews */
12365	verdict?: "CONFIRMED" \| "PLAUSIBLE"
12366	/** Set ONLY when re-reporting after applying fixes: what happened to this finding */
12367	outcome?: "fixed" \| "skipped" \| "no_change_needed"
12368	}>
12369	}
12370	ScheduleWakeup: {
12371	/** Seconds from now to wake up. Clamped to [60, 3600] by the runtime. Required unless `stop` is true. */
12372	delaySeconds?: number
12373	/** One short sentence explaining the chosen delay. Goes to telemetry and is shown to the user. Be specific. Required unless `stop` is true. */
12374	reason?: string
12375	/** The /loop input to fire on wake-up. Pass the same /loop input verbatim each turn so the next firing re-enters the skill and continues the loop. For autonomous /loop (no user prompt), pass the literal sentinel `<<autonomous-loop-dynamic>>` instead (the dynamic-pacing variant, not the CronCreate-mode `<<autonomous-loop>>`). Required unless `stop` is true. */
12376	prompt?: string
12377	/** Set to true to end the dynamic loop immediately instead of scheduling another wakeup. When true, all other fields are ignored and no further wakeups fire. */
12378	stop?: boolean
12379	/** true = nothing changed (you checked and there is nothing to report). false = something happened worth keeping (edited a file, posted a message, advanced state, surfaced a finding). Consecutive noop:true ticks are collapsed in the user's terminal view and tracked as a streak. Required unless `stop` is true. */
12380	noop?: boolean
12381	}
12382	SendMessage: {
12383	/** Recipient: a name from ListAgents (append its " [ref]" only when a listing or an error shows one), a teammate name, "main", or a background agent's agentId */
12384	to: unknown & unknown
12385	/** A 5-10 word label for your own transcript row (not transmitted — the recipient previews the first line of `message`). Truncated to 200 characters rather than rejected. */
12386	summary?: string
12387	/** Plain text message content. The recipient's human sees only the FIRST LINE as a one-line preview until they expand it, so make the first line a clear, self-contained sentence saying what this is about — not a greeting, preamble, or bare @-mention. */
12388	message: string
12389	/** Ask a session ON THIS MACHINE to send you ONE notice when it next goes idle (finishes its turn with nothing queued) or exits — opt-in, one-shot, no polling. With a message: deliver it now AND subscribe. Without a message (omit it): a pure subscription that costs the other session nothing. */
12390	notify_when_idle?: boolean
12391	}
12392	Skill: {
12393	/** The name of a skill from the available-skills list. Do not guess names. */
12394	skill: string
12395	/** Optional arguments for the skill */
12396	args?: string
12397	}
12398	TaskOutput: {
12399	/** The task ID to get output from */
12400	task_id: string
12401	/** Whether to wait for completion */
12402	block: boolean
12403	/** Max wait time in ms */
12404	timeout: number
12405	}
12406	TaskStop: {
12407	/** The ID of the background task to stop. Agent-team teammates and named background agents are also accepted by agent ID or name. */
12408	task_id?: string
12409	/** Deprecated: use task_id instead */
12410	shell_id?: string
12411	}
12412	ToolSearch: {
12413	/** Query to find deferred tools. Use "select:<tool_name>" for direct selection, or keywords to search. */
12414	query: string
12415	/** Maximum number of results to return (default: 5) */
12416	max_results: number
12417	}
12418	WebFetch: {
12419	/** The URL to fetch content from */
12420	url: string
12421	/** The prompt to run on the fetched content */
12422	prompt: string
12423	}
12424	WebSearch: {
12425	/** The search query to use */
12426	query: string
12427	/** Only include search results from these domains */
12428	allowed_domains?: string[]
12429	/** Never include search results from these domains */
12430	blocked_domains?: string[]
12431	}
12432	Workflow: {
12433	/** Self-contained workflow script. Must begin with `export const meta = { name, description, phases }` (pure literal, no computed values) followed by the script body using agent()/parallel()/pipeline()/phase(). */
12434	script?: string
12435	/** Name of a predefined workflow (built-in or from .claude/workflows/). Resolves to a self-contained script. */
12436	name?: string
12437	/** Ignored — set the workflow description in the script's `meta` block. */
12438	description?: string
12439	/** Ignored — set the workflow title in the script's `meta` block. */
12440	title?: string
12441	/** Optional input value exposed to the script as the global `args`, verbatim. Pass arrays/objects as actual JSON values, NOT as a JSON-encoded string — a stringified list breaks `args.filter`/`args.map` in the script. Use for parameterized named workflows (e.g. a research question). */
12442	args?: unknown
12443	/** Path to a workflow script file on disk. Every Workflow invocation persists its script under the session directory and returns the path in the tool result. To iterate, edit that file with Write/Edit and re-invoke Workflow with the same `scriptPath` instead of re-sending the full script. Takes precedence over `script` and `name`. */
12444	scriptPath?: string
12445	/** Run ID of a prior Workflow invocation to resume from. Completed agent() calls with unchanged (prompt, opts) return their cached results instantly; only edited or new calls re-run. Same-session only. Stop the prior run first (TaskStop) before resuming. */
12446	resumeFromRunId?: string
12447	}
12448	Write: {
12449	/** The absolute path to the file to write (must be absolute, not relative) */
12450	file_path: string
12451	/** The content to write to the file */
12452	content: string
12453	}
12454	}
12455	}
12456
12457	// The structured results of the same tools, from each tool's output
12458	// schema. Merges into ToolCallResult (BuiltinToolResults) so after
12459	// `e.tool === "Bash"` the `result` of `next(e)` is the tool's record.
12460	declare module 'claude-code' {
12461	interface BuiltinToolResults {
12462	Agent: {
12463	agentId: string
12464	/** @internal Count of leading harness-authored content blocks (hand-back provenance bookkeeping; not a stable consumer field) */
12465	harnessNoteCount?: number
12466	/** @internal Count of trailing harness-authored content blocks (hand-back provenance bookkeeping; not a stable consumer field) */
12467	harnessTailCount?: number
12468	/** @internal Fingerprint binding the harness section counts to the exact content they were computed against; a hook rewrite invalidates the counts rather than misplacing rewritten bytes */
12469	harnessSectionHash?: string
12470	agentType?: string
12471	/** @internal How the report reached this result under the subagent hand-back contract: 'send' = the child's classified SubagentHandback delivery, 'flagged' = that delivery under a SECURITY WARNING, 'withheld' = nothing was delivered (not a stable consumer field) */
12472	handback?: "send" \| "flagged" \| "withheld"
12473	content: Array<{
12474	type: "text"
12475	text: string
12476	citations?: unknown[] \| null
12477	}>
12478	resolvedModel?: string
12479	modelsUsed?: string[]
12480	totalToolUseCount: number
12481	totalDurationMs: number
12482	totalTokens: number
12483	usage: {
12484	input_tokens: number
12485	output_tokens: number
12486	cache_creation_input_tokens: number \| null
12487	cache_read_input_tokens: number \| null
12488	server_tool_use: {
12489	web_search_requests: number
12490	web_fetch_requests: number
12491	} \| null
12492	service_tier: string \| null
12493	cache_creation: {
12494	ephemeral_1h_input_tokens: number
12495	ephemeral_5m_input_tokens: number
12496	} \| null
12497	inference_geo?: string \| null
12498	speed?: string \| null
12499	iterations?: unknown
12500	output_tokens_details?: {
12501	thinking_tokens?: number \| null
12502	} \| null
12503	}
12504	toolStats?: {
12505	readCount: number
12506	searchCount: number
12507	bashCount: number
12508	editFileCount: number
12509	linesAdded: number
12510	linesRemoved: number
12511	otherToolCount: number
12512	frameCount?: number
12513	}
12514	status: "completed"
12515	prompt: string
12516	worktreePath?: string
12517	worktreeBranch?: string
12518	} \| {
12519	status: "async_launched"
12520	isAsync?: true
12521	/** The ID of the async agent */
12522	agentId: string
12523	/** The description of the task */
12524	description: string
12525	/** Model in use at the backgrounding transition (a pre-background swap is reflected here) */
12526	resolvedModel?: string
12527	/** Ordered distinct models used before backgrounding (length > 1 means a mid-run swap) */
12528	modelsUsed?: string[]
12529	/** The prompt for the agent */
12530	prompt: string
12531	/** Path to the output file for checking agent progress */
12532	outputFile: string
12533	/** Whether the calling agent has Read/Bash tools to check progress */
12534	canReadOutputFile?: boolean
12535	} \| {
12536	status: "remote_launched"
12537	/** The ID of the remote agent task */
12538	taskId: string
12539	/** The URL of the cloud session */
12540	sessionUrl: string
12541	/** The description of the task */
12542	description: string
12543	/** The prompt for the agent */
12544	prompt: string
12545	/** Path to the output file for checking agent progress */
12546	outputFile: string
12547	}
12548	Bash: {
12549	/** The standard output of the command */
12550	stdout: string
12551	/** The standard error output of the command */
12552	stderr: string
12553	/** Path to raw output file for large MCP tool outputs */
12554	rawOutputPath?: string
12555	/** Whether the command was interrupted */
12556	interrupted: boolean
12557	/** Flag to indicate if stdout contains image data */
12558	isImage?: boolean
12559	/** ID of the background task if command is running in background */
12560	backgroundTaskId?: string
12561	/** True if the user manually backgrounded the command with Ctrl+B */
12562	backgroundedByUser?: boolean
12563	/** @internal True if a plugin's turn abort moved the running command to the background */
12564	backgroundedByTurnAbort?: boolean
12565	/** @internal True if the command was moved to the background so a message queued for the model could reach it */
12566	backgroundedToDeliverMessage?: boolean
12567	/** Set when the command hit its timeout and was auto-backgrounded; the timeout value in ms */
12568	timedOutAfterMs?: number
12569	/** Model-facing note that the session cwd was not changed by a backgrounded command containing a directory-change builtin (cd/pushd/popd/chdir) */
12570	backgroundCwdHint?: string
12571	/** True when this backgrounded command is owned by a synchronous subagent and is therefore terminated when that agent gives its final response; absent when the command survives (main loop, async subagents) */
12572	backgroundEndsWithFinalResponse?: true
12573	/** Flag to indicate if sandbox mode was overridden */
12574	dangerouslyDisableSandbox?: boolean
12575	/** Semantic interpretation for non-error exit codes with special meaning */
12576	returnCodeInterpretation?: string
12577	/** Whether the command is expected to produce no output on success */
12578	noOutputExpected?: boolean
12579	/** Structured content blocks */
12580	structuredContent?: unknown[]
12581	/** Path to the persisted full output in tool-results dir (set when output is too large for inline) */
12582	persistedOutputPath?: string
12583	/** Total size of the output in bytes (set when output is too large for inline) */
12584	persistedOutputSize?: number
12585	/** Model-facing note listing readFileState entries whose mtime bumped during this command (set when WRITE_COMMAND_MARKERS matches) */
12586	staleReadFileStateHint?: string
12587	/** Model-facing system-reminder appended when a gh command reports a GitHub API rate-limit error */
12588	ghRateLimitHint?: string
12589	/** Structured classification of git/gh operations detected in this command (commit/push/merge/rebase/PR). Client-facing — lets clients render git activity without re-parsing stdout; not surfaced to the model. */
12590	gitOperation?: {
12591	commit?: {
12592	sha: string
12593	kind: "committed" \| "amended" \| "cherry-picked"
12594	branch?: string
12595	}
12596	push?: {
12597	branch: string
12598	}
12599	branch?: {
12600	ref: string
12601	action: "merged" \| "rebased"
12602	}
12603	pr?: {
12604	number: number
12605	url?: string
12606	action: "created" \| "edited" \| "merged" \| "commented" \| "closed" \| "reopened" \| "ready" \| "draft" \| "auto-merge-enabled" \| "auto-merge-disabled"
12607	}
12608	}
12609	/** @internal Per-file diff of the working-tree changes this command made, for rendering and for PostToolUse Bash hooks (changedFiles: absolute paths of every changed file known, shown or not, at most 200; cut when shorter than files.length + moreFiles); not surfaced to the model. */
12610	bashEditDiff?: {
12611	files: {
12612	filePath: string
12613	hunks: {
12614	oldStart: number
12615	oldLines: number
12616	newStart: number
12617	newLines: number
12618	lines: string[]
12619	}[]
12620	created?: true
12621	deleted?: true
12622	}[]
12623	moreFiles: number
12624	changedFiles?: string[]
12625	unavailable?: true
12626	skipped?: true
12627	shared?: true
12628	}
12629	}
12630	CronCreate: {
12631	id: string
12632	humanSchedule: string
12633	recurring: boolean
12634	durable?: boolean
12635	}
12636	CronDelete: {
12637	id: string
12638	}
12639	CronList: {
12640	jobs: {
12641	id: string
12642	cron: string
12643	humanSchedule: string
12644	prompt: string
12645	recurring?: boolean
12646	durable?: boolean
12647	}[]
12648	}
12649	Edit: {
12650	/** The file path that was edited */
12651	filePath: string
12652	/** The original string that was replaced */
12653	oldString: string
12654	/** The new string that replaced it */
12655	newString: string
12656	/** The original file contents before editing */
12657	originalFile: string \| null
12658	/** Diff patch showing the changes */
12659	structuredPatch: {
12660	oldStart: number
12661	oldLines: number
12662	newStart: number
12663	newLines: number
12664	lines: string[]
12665	}[]
12666	/** Whether the user modified the proposed changes */
12667	userModified: boolean
12668	/** Whether all occurrences were replaced */
12669	replaceAll: boolean
12670	gitDiff?: {
12671	filename: string
12672	status: "modified" \| "added"
12673	additions: number
12674	deletions: number
12675	changes: number
12676	patch: string
12677	/** GitHub owner/repo when available */
12678	repository?: string \| null
12679	}
12680	/** True when the edit was held for the machine owner to review instead of written; the file is unchanged */
12681	staged?: boolean
12682	}
12683	EnterWorktree: {
12684	worktreePath: string
12685	worktreeBranch?: string
12686	message: string
12687	}
12688	ExitWorktree: {
12689	action: "keep" \| "remove"
12690	originalCwd: string
12691	worktreePath: string
12692	worktreeBranch?: string
12693	tmuxSessionName?: string
12694	discardedFiles?: number
12695	discardedCommits?: number
12696	message: string
12697	}
12698	ListAgents: {
12699	/** Formatted list of reachable agents */
12700	listing: string
12701	}
12702	NotebookEdit: {
12703	/** The new source code that was written to the cell */
12704	new_source: string
12705	/** The previous cell source (replace/delete only). Enables cell-relative diff rendering without re-reading the notebook. */
12706	old_source?: string
12707	/** The ID of the cell that was edited */
12708	cell_id?: string
12709	/** The type of the cell */
12710	cell_type: "code" \| "markdown"
12711	/** The programming language of the notebook */
12712	language: string
12713	/** The edit mode that was used */
12714	edit_mode: string
12715	/** Error message if the operation failed */
12716	error?: string
12717	/** The path to the notebook file */
12718	notebook_path: string
12719	/** The original notebook content before modification */
12720	original_file: string
12721	/** The updated notebook content after modification */
12722	updated_file: string
12723	}
12724	PowerShell: {
12725	/** The standard output of the command */
12726	stdout: string
12727	/** The standard error output of the command */
12728	stderr: string
12729	/** Whether the command was interrupted */
12730	interrupted: boolean
12731	/** Semantic interpretation for non-error exit codes with special meaning */
12732	returnCodeInterpretation?: string
12733	/** Flag to indicate if stdout contains image data */
12734	isImage?: boolean
12735	/** Path to persisted full output when too large for inline */
12736	persistedOutputPath?: string
12737	/** Total output size in bytes when persisted */
12738	persistedOutputSize?: number
12739	/** ID of the background task if command is running in background */
12740	backgroundTaskId?: string
12741	/** True if the user manually backgrounded the command with Ctrl+B */
12742	backgroundedByUser?: boolean
12743	/** @internal True if a plugin's turn abort moved the running command to the background */
12744	backgroundedByTurnAbort?: boolean
12745	/** @internal True if the command was moved to the background so a message queued for the model could reach it */
12746	backgroundedToDeliverMessage?: boolean
12747	/** Set when the command hit its timeout and was auto-backgrounded; the timeout value in ms */
12748	timedOutAfterMs?: number
12749	/** True when this backgrounded command is owned by a synchronous subagent and is therefore terminated when that agent gives its final response; absent when the command survives (main loop, async subagents) */
12750	backgroundEndsWithFinalResponse?: true
12751	/** Structured classification of git/gh operations detected in this command (commit/push/merge/rebase/PR). Client-facing — lets clients render git activity without re-parsing stdout; not surfaced to the model. */
12752	gitOperation?: {
12753	commit?: {
12754	sha: string
12755	kind: "committed" \| "amended" \| "cherry-picked"
12756	branch?: string
12757	}
12758	push?: {
12759	branch: string
12760	}
12761	branch?: {
12762	ref: string
12763	action: "merged" \| "rebased"
12764	}
12765	pr?: {
12766	number: number
12767	url?: string
12768	action: "created" \| "edited" \| "merged" \| "commented" \| "closed" \| "reopened" \| "ready" \| "draft" \| "auto-merge-enabled" \| "auto-merge-disabled"
12769	}
12770	}
12771	}
12772	Read: {
12773	type: "text"
12774	file: {
12775	/** The path to the file that was read */
12776	filePath: string
12777	/** The content of the file */
12778	content: string
12779	/** Number of lines in the returned content */
12780	numLines: number
12781	/** The starting line number */
12782	startLine: number
12783	/** Total number of lines in the file */
12784	totalLines: number
12785	/** True when a whole-file read was auto-paginated because it exceeded the token cap (the content is a partial first page). A programmatic signal for internal consumers; survives output reconstruction (unlike the render-time banner). */
12786	truncatedByTokenCap?: boolean
12787	}
12788	/** Set when this Read completed a saved Artifact source file: the Artifact and the version of it that now counts as viewed. */
12789	artifactRead?: {
12790	slug: string
12791	ver: string
12792	}
12793	} \| {
12794	type: "image"
12795	file: {
12796	/** Base64-encoded image data */
12797	base64: string
12798	/** The MIME type of the image */
12799	type: "image/jpeg" \| "image/png" \| "image/gif" \| "image/webp"
12800	/** Original file size in bytes */
12801	originalSize: number
12802	/** Image dimension info for coordinate mapping */
12803	dimensions?: {
12804	/** Original image width in pixels */
12805	originalWidth?: number
12806	/** Original image height in pixels */
12807	originalHeight?: number
12808	/** Displayed image width in pixels (after resizing) */
12809	displayWidth?: number
12810	/** Displayed image height in pixels (after resizing) */
12811	displayHeight?: number
12812	}
12813	}
12814	} \| {
12815	type: "notebook"
12816	file: {
12817	/** The path to the notebook file */
12818	filePath: string
12819	/** Array of notebook cells */
12820	cells: unknown[]
12821	}
12822	} \| {
12823	type: "pdf"
12824	file: {
12825	/** The path to the PDF file */
12826	filePath: string
12827	/** Base64-encoded PDF data */
12828	base64: string
12829	/** Original file size in bytes */
12830	originalSize: number
12831	}
12832	} \| {
12833	type: "parts"
12834	file: {
12835	/** The path to the PDF file */
12836	filePath: string
12837	/** Original file size in bytes */
12838	originalSize: number
12839	/** Number of pages extracted */
12840	count: number
12841	/** Directory containing extracted page images */
12842	outputDir: string
12843	}
12844	/** Document page number of the first extracted page (1 when no range was requested); labels the page images in the model-facing tool_result */
12845	firstPage?: number
12846	/** Extracted page images, in page order. Present only transiently in-process: the page image bytes are delivered solely as image blocks in the model-facing tool_result content and are not retained on the tool_use_result, so this key is absent on the emitted/persisted result */
12847	pages?: Array<{
12848	/** Base64-encoded page image; empty when the page could not be processed */
12849	base64: string
12850	/** The MIME type of the image */
12851	mediaType: "image/jpeg" \| "image/png" \| "image/gif" \| "image/webp"
12852	/** Why the page could not be processed as an image; set only when base64 is empty */
12853	error?: string
12854	}>
12855	} \| {
12856	type: "file_unchanged"
12857	file: {
12858	/** The path to the file */
12859	filePath: string
12860	}
12861	/** Set when the dedup matched a startup-seeded entry (CLAUDE.md / nested memory) rather than a prior Read tool_result */
12862	source?: "seeded"
12863	}
12864	ReportFindings: {
12865	/** Number of findings reported */
12866	count: number
12867	/** Effort level the review ran at */
12868	level?: "low" \| "medium" \| "high" \| "xhigh" \| "max"
12869	/** Echoed for the result body */
12870	findings: Array<{
12871	/** Repo-relative path of the file the finding is in */
12872	file: string
12873	/** 1-indexed line the finding anchors to */
12874	line?: number
12875	/** One-sentence statement of the defect */
12876	summary: string
12877	/** Compressed label for compact UI (≤60 chars): the claim alone, no rationale or consequence clause */
12878	short_summary?: string
12879	/** Concrete inputs/state → wrong output/crash */
12880	failure_scenario: string
12881	/** Short kebab-case slug of the finding type, e.g. "correctness", "simplification", "efficiency", "test-coverage" */
12882	category?: string
12883	/** Set when a verify pass ran; absent on inline-only reviews */
12884	verdict?: "CONFIRMED" \| "PLAUSIBLE"
12885	/** Set ONLY when re-reporting after applying fixes: what happened to this finding */
12886	outcome?: "fixed" \| "skipped" \| "no_change_needed"
12887	}>
12888	}
12889	ScheduleWakeup: {
12890	/** Epoch ms timestamp when the next wakeup will fire */
12891	scheduledFor: number
12892	/** Actual delay used after clamping to runtime bounds */
12893	clampedDelaySeconds: number
12894	/** True if the requested delaySeconds was outside [60, 3600] */
12895	wasClamped: boolean
12896	/** True when the model ended the loop via `stop: true` */
12897	stopped?: boolean
12898	/** How many pending dynamic-loop wakeups stop:true cancelled. 0 means nothing was pending — a recurring /loop cron is not cancelled by stop:true. */
12899	cancelledWakeups?: number
12900	}
12901	SendMessage: unknown
12902	Skill: {
12903	/** Whether the skill is valid */
12904	success: boolean
12905	/** The name of the skill */
12906	commandName: string
12907	/** Tools allowed by this skill */
12908	allowedTools?: string[]
12909	/** Resolved model the skill turn runs on when a frontmatter model override took effect; omitted otherwise */
12910	model?: string
12911	/** Execution status */
12912	status?: "inline"
12913	/** True when the skill instructions were loaded read-only (nothing was executed) */
12914	readOnly?: boolean
12915	} \| {
12916	/** Whether the skill completed successfully */
12917	success: boolean
12918	/** The name of the skill */
12919	commandName: string
12920	/** Execution status */
12921	status: "forked"
12922	/** The ID of the sub-agent that executed the skill */
12923	agentId: string
12924	/** The result from the forked skill execution */
12925	result: string
12926	/** True when the sub-agent was launched in the background: `result` describes the launch, and the skill outcome arrives later as a task notification. */
12927	background?: boolean
12928	}
12929	TaskOutput: unknown
12930	TaskStop: {
12931	/** Status message about the operation */
12932	message: string
12933	/** The ID of the task that was stopped */
12934	task_id: string
12935	/** The type of the task that was stopped */
12936	task_type: string
12937	/** The command or description of the stopped task */
12938	command?: string
12939	}
12940	ToolSearch: {
12941	matches: string[]
12942	query: string
12943	total_deferred_tools: number
12944	pending_mcp_servers?: string[]
12945	failed_mcp_servers?: {
12946	name: string
12947	errorCode?: string
12948	error?: string
12949	}[]
12950	}
12951	WebFetch: {
12952	/** Size of the fetched content in bytes */
12953	bytes: number
12954	/** HTTP response code */
12955	code: number
12956	/** HTTP response code text */
12957	codeText: string
12958	/** Processed result from applying the prompt to the content */
12959	result: string
12960	/** Time taken to fetch and process the content */
12961	durationMs: number
12962	/** The URL that was fetched */
12963	url: string
12964	artifactRead?: {
12965	slug: string
12966	ver?: string
12967	seeded?: false
12968	}
12969	}
12970	WebSearch: {
12971	/** The search query that was executed */
12972	query: string
12973	/** Search results and/or text commentary from the model */
12974	results: Array<{
12975	/** ID of the tool use */
12976	tool_use_id: string
12977	/** Array of search hits */
12978	content: Array<{
12979	/** The title of the search result */
12980	title: string
12981	/** The URL of the search result */
12982	url: string
12983	}>
12984	} \| string>
12985	/** Time taken to complete the search operation */
12986	durationSeconds: number
12987	/** Number of web searches performed */
12988	searchCount?: number
12989	}
12990	Workflow: {
12991	status: "async_launched" \| "remote_launched"
12992	taskId: string
12993	/** TaskType of the registered background task — 'local_workflow' for in-process runs, 'remote_agent' when remote:true dispatches to CCR. Set on all new writes; absent only on transcripts written before this field existed. */
12994	taskType?: "local_workflow" \| "remote_agent"
12995	/** meta.name from the workflow script — same value as task_started.workflow_name. Set on all new writes; absent only on transcripts written before this field existed. */
12996	workflowName?: string
12997	/** Local workflow run identifier for resumeFromRunId. Absent for remote_launched (the CCR session URL is the resume handle there) and on transcripts written before this field existed. */
12998	runId?: string
12999	summary?: string
13000	/** Directory where subagent transcripts are written during execution */
13001	transcriptDir?: string
13002	/** Path to the persisted workflow script for this invocation. Editable via Write/Edit; pass back as `scriptPath` to re-run without resending the script. */
13003	scriptPath?: string
13004	/** CCR session URL when status is remote_launched */
13005	sessionUrl?: string
13006	/** Non-blocking heads-up (e.g. local git state diverges from the pushed branch the cloud session will clone) */
13007	warning?: string
13008	/** Set if syntax check failed */
13009	error?: string
13010	}
13011	Write: {
13012	/** Whether a new file was created or an existing file was updated */
13013	type: "create" \| "update"
13014	/** The path to the file that was written */
13015	filePath: string
13016	/** The content that was written to the file */
13017	content: string
13018	/** Diff patch showing the changes (empty when nothing changed, the diff timed out, or — with originalFile null on an update — the previous content was too large to diff) */
13019	structuredPatch: {
13020	oldStart: number
13021	oldLines: number
13022	newStart: number
13023	newLines: number
13024	lines: string[]
13025	}[]
13026	/** The original file content before the write (null for new files, or when the previous content was too large to include) */
13027	originalFile: string \| null
13028	gitDiff?: {
13029	filename: string
13030	status: "modified" \| "added"
13031	additions: number
13032	deletions: number
13033	changes: number
13034	patch: string
13035	/** GitHub owner/repo when available */
13036	repository?: string \| null
13037	}
13038	/** True when the user edited the proposed content in the permission dialog before accepting */
13039	userModified?: boolean
13040	/** True when the write was held for the machine owner to review instead of written; the file is unchanged */
13041	staged?: boolean
13042	}
13043	}
13044	}