@buildanagent/sdk 0.1.0-alpha.5 → 0.1.0-alpha.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +78 -5
- package/dist/budget.d.ts +33 -0
- package/dist/budget.js +55 -0
- package/dist/budget.js.map +1 -0
- package/dist/errors.d.ts +5 -2
- package/dist/errors.js +4 -1
- package/dist/errors.js.map +1 -1
- package/dist/events.d.ts +10 -1
- package/dist/events.js +1 -0
- package/dist/events.js.map +1 -1
- package/dist/index.d.ts +9 -4
- package/dist/index.js +8 -3
- package/dist/index.js.map +1 -1
- package/dist/loop.d.ts +11 -0
- package/dist/loop.js +100 -13
- package/dist/loop.js.map +1 -1
- package/dist/progress.d.ts +34 -0
- package/dist/progress.js +139 -0
- package/dist/progress.js.map +1 -0
- package/dist/result.d.ts +20 -3
- package/dist/result.js.map +1 -1
- package/dist/run.d.ts +53 -1
- package/dist/run.js +51 -1
- package/dist/run.js.map +1 -1
- package/dist/steering.d.ts +52 -0
- package/dist/steering.js +104 -0
- package/dist/steering.js.map +1 -0
- package/dist/tools/define.d.ts +3 -3
- package/dist/tools/define.js +6 -3
- package/dist/tools/define.js.map +1 -1
- package/dist/tools/types.d.ts +8 -0
- package/dist/tools/types.js.map +1 -1
- package/dist/vendor/agent-safety/hash.d.ts +16 -0
- package/dist/vendor/agent-safety/hash.js +109 -0
- package/dist/vendor/agent-safety/hash.js.map +1 -0
- package/package.json +2 -2
package/dist/result.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * What a run returns: a union discriminated by `stopReason`, in which only the `done` variant carries `output`, so\n * code that reads the output without checking the stop reason fails to compile (D10). Every variant carries the\n * usage, the cost and a context the run can continue from.\n */\nimport type { AssistantMessage, Cost, Message, Usage } from \"@buildanagent/gateway\";\n\n/**\n * A run's conversation as plain JSON: the system prompt and every message so far. Store it anywhere and pass it to\n * `continueRun()` to go on from where the run stopped.\n */\nexport interface Context {\n readonly system: string;\n readonly messages: readonly Message[];\n}\n\n/** Why a model call failed, copied from the failed message's `error`. */\nexport interface RunError {\n /**\n * `overflow`: the request was larger than the model's context window. `quota`: the account is out of quota or\n * credit. `retryable`: a temporary failure that outlasted the model's retries. `fatal`: any other failure, such as a\n * rejected request. `hook`: an interceptor threw while the run fails closed, and `message` says which one.\n */\n readonly kind: NonNullable<AssistantMessage[\"error\"]>[\"kind\"] | \"hook\";\n readonly message: string;\n /** The provider's HTTP status, when the failure came with one. */\n readonly status?: number;\n}\n\n/** The fields every run result carries. */\nexport interface ResultBase {\n /** The messages this run added: the input, if any, then every response and tool result, in order. */\n readonly messages: readonly Message[];\n /** The whole conversation, earlier history included, ready for `continueRun()`. */\n readonly context: Context;\n /** The tokens of every model call, summed. */\n readonly usage: Usage;\n /**\n * The cost of every model call, summed. It is unknown if any call's cost is. A run that made no call costs an exact\n * 0 with basis `provider`, so adding it to another cost keeps that cost's basis.\n */\n readonly cost: Cost;\n /** How many model calls the run made. */\n readonly steps: number;\n}\n\n/**\n * A run that finished: the model answered without calling a tool, or an output tool accepted its answer. `output` is\n * the accepted answer, and `undefined` when the run has no output tool, the model answered in text, or another tool\n * ended the run with `terminate: true`. A text\n * answer cut off at the output limit also ends `done`; its message's `stopReason` is then `\"length\"`.\n */\nexport interface DoneResult<S> extends ResultBase {\n readonly stopReason: \"done\";\n readonly output: S | undefined;\n}\n\n/**\n * A run that ended before it finished. `max_steps`: it made `maxSteps` model calls and the model still wanted to\n * continue. `aborted`: it was aborted.\n */\nexport interface EndedResult extends ResultBase {\n readonly stopReason: \"max_steps\" | \"aborted\";\n}\n\n
|
|
1
|
+
{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * What a run returns: a union discriminated by `stopReason`, in which only the `done` variant carries `output`, so\n * code that reads the output without checking the stop reason fails to compile (D10). Every variant carries the\n * usage, the cost and a context the run can continue from.\n */\nimport type { AssistantMessage, Cost, Message, Usage } from \"@buildanagent/gateway\";\n\n/**\n * A run's conversation as plain JSON: the system prompt and every message so far. Store it anywhere and pass it to\n * `continueRun()` to go on from where the run stopped.\n */\nexport interface Context {\n readonly system: string;\n readonly messages: readonly Message[];\n}\n\n/** Why a model call failed, copied from the failed message's `error`. */\nexport interface RunError {\n /**\n * `overflow`: the request was larger than the model's context window. `quota`: the account is out of quota or\n * credit. `retryable`: a temporary failure that outlasted the model's retries. `fatal`: any other failure, such as a\n * rejected request. `hook`: an interceptor threw while the run fails closed, and `message` says which one.\n * `unknown_price`: the run has a `budgetUsd`, but a price it needs is unknown, so it can't check the spend.\n */\n readonly kind: NonNullable<AssistantMessage[\"error\"]>[\"kind\"] | \"hook\" | \"unknown_price\";\n readonly message: string;\n /** The provider's HTTP status, when the failure came with one. */\n readonly status?: number;\n}\n\n/** The fields every run result carries. */\nexport interface ResultBase {\n /** The messages this run added: the input, if any, then every response and tool result, in order. */\n readonly messages: readonly Message[];\n /** The whole conversation, earlier history included, ready for `continueRun()`. */\n readonly context: Context;\n /** The tokens of every model call, summed. */\n readonly usage: Usage;\n /**\n * The cost of every model call, summed. It is unknown if any call's cost is. A run that made no call costs an exact\n * 0 with basis `provider`, so adding it to another cost keeps that cost's basis.\n */\n readonly cost: Cost;\n /** How many model calls the run made. */\n readonly steps: number;\n}\n\n/**\n * A run that finished: the model answered without calling a tool, or an output tool accepted its answer. `output` is\n * the accepted answer, and `undefined` when the run has no output tool, the model answered in text, or another tool\n * ended the run with `terminate: true`. A text\n * answer cut off at the output limit also ends `done`; its message's `stopReason` is then `\"length\"`.\n */\nexport interface DoneResult<S> extends ResultBase {\n readonly stopReason: \"done\";\n readonly output: S | undefined;\n}\n\n/**\n * A run that ended before it finished. `max_steps`: it made `maxSteps` model calls and the model still wanted to\n * continue. `aborted`: it was aborted.\n */\nexport interface EndedResult extends ResultBase {\n readonly stopReason: \"max_steps\" | \"aborted\";\n}\n\n/**\n * A run that stopped making progress. The default progress policy ends a run this way after 3 identical failing tool\n * calls in a row, or after 5 failing calls to a tool with one `progressKey`; pass `progress` to `run()` to change the\n * thresholds, or `progress: false` to turn the policy off. A `shouldStop` hook that returns `{ stop: \"no_progress\" }`\n * ends a run this way too. `reason` says which rule or hook fired.\n */\nexport interface NoProgressResult extends ResultBase {\n readonly stopReason: \"no_progress\";\n readonly reason: string;\n}\n\n/**\n * A run that ended before a model call because that call could have taken the spend past `budgetUsd`. `spentUsd` is\n * what the run's earlier calls cost, and `projectedUsd` the most the refused call could have cost.\n */\nexport interface BudgetResult extends ResultBase {\n readonly stopReason: \"budget\";\n readonly reason: string;\n readonly budgetUsd: number;\n readonly spentUsd: number;\n readonly projectedUsd: number;\n}\n\n/** A run that ended because a model call failed, or because an interceptor failed while the run fails closed. */\nexport interface ErrorResult extends ResultBase {\n readonly stopReason: \"error\";\n readonly error: RunError;\n}\n\n/**\n * A run that stopped before it finished, for a reason `stoppedBy` names. `clarification`: a tool from\n * `clarificationTool()` asked the user a question. Any other value is the `reason` a `shouldStop` hook gave, or\n * `\"hook\"` when it returned `true`. To go on, add the answer to `context` as a user message and pass the\n * context to `continueRun()`.\n */\nexport interface StoppedResult extends ResultBase {\n readonly stopReason: \"stopped\";\n readonly stoppedBy: string;\n}\n\n/** What a run returns. Check `stopReason` before you read the fields of one variant. */\nexport type RunResult<S = unknown> =\n | DoneResult<S>\n | BudgetResult\n | EndedResult\n | ErrorResult\n | NoProgressResult\n | StoppedResult;\n\n/** Every run result except `done`, which `runOrThrow()` turns into a `RunStoppedError`. */\nexport type UnfinishedResult = Exclude<RunResult, DoneResult<unknown>>;\n"]}
|
package/dist/run.d.ts
CHANGED
|
@@ -6,9 +6,11 @@
|
|
|
6
6
|
import type { ContentBlock, Message, Model } from "@buildanagent/gateway";
|
|
7
7
|
import type { AgentEvent } from "./events.js";
|
|
8
8
|
import type { CallOptions, Interceptors, Observer } from "./hooks.js";
|
|
9
|
+
import { type ProgressPolicy } from "./progress.js";
|
|
9
10
|
import type { Context, DoneResult, RunResult } from "./result.js";
|
|
11
|
+
import { type DeliveryReceipt } from "./steering.js";
|
|
10
12
|
import type { Clock } from "./testing/determinism.js";
|
|
11
|
-
import type { ToolDefinition } from "./tools/types.js";
|
|
13
|
+
import type { ToolContext, ToolDefinition } from "./tools/types.js";
|
|
12
14
|
/** The options `run()` and `continueRun()` share. */
|
|
13
15
|
export interface RunOptions<S = unknown> {
|
|
14
16
|
/** The model, from `createModel()`. */
|
|
@@ -28,6 +30,30 @@ export interface RunOptions<S = unknown> {
|
|
|
28
30
|
* ends with `stopReason: "max_steps"` and emits a `warning` event with `code: "max_steps"`.
|
|
29
31
|
*/
|
|
30
32
|
readonly maxSteps?: number;
|
|
33
|
+
/**
|
|
34
|
+
* The most the run's model calls may cost, in USD. Before each call the run projects its cost with
|
|
35
|
+
* `projectCallCost()` and, if the spend so far plus that projection would pass the cap, ends with
|
|
36
|
+
* `stopReason: "budget"` without making the call. The cap counts the calls this run makes, not the cost of the
|
|
37
|
+
* history a `continueRun()` starts from. A budgeted run on a model whose price is unknown ends `error` with
|
|
38
|
+
* `error.kind: "unknown_price"` before its first call, because it could not tell what it spent. Without it, a run
|
|
39
|
+
* has no cap.
|
|
40
|
+
*/
|
|
41
|
+
readonly budgetUsd?: number;
|
|
42
|
+
/**
|
|
43
|
+
* The default progress policy: the run ends `no_progress` after 3 identical failing tool calls in a row, or after 5
|
|
44
|
+
* calls to a tool with one `progressKey` and no success between them. It runs after your own `shouldStop`, whose
|
|
45
|
+
* `{ continue }` can't keep a stuck run going. Pass numbers to change either threshold, or `false` to turn the
|
|
46
|
+
* policy off.
|
|
47
|
+
*/
|
|
48
|
+
readonly progress?: ProgressPolicy | false;
|
|
49
|
+
/**
|
|
50
|
+
* How deeply this run is nested inside other agents' tool calls. Default 0. A tool that starts a run of its own
|
|
51
|
+
* passes `depth: ctx.depth + 1` and `maxDepth: ctx.maxDepth`; `run()` throws an `SdkError` with code
|
|
52
|
+
* `max_depth_exceeded` when `depth` is above `maxDepth`, which the tool's caller reads as an error result.
|
|
53
|
+
*/
|
|
54
|
+
readonly depth?: number;
|
|
55
|
+
/** The deepest nesting allowed, which tools read as `ctx.maxDepth`. Default 2. */
|
|
56
|
+
readonly maxDepth?: number;
|
|
31
57
|
/** Aborts the run, like `run.abort()`. */
|
|
32
58
|
readonly signal?: AbortSignal;
|
|
33
59
|
/** Options for every model call, such as `maxOutputTokens`. The run passes its own abort signal. */
|
|
@@ -87,7 +113,33 @@ export interface Run<S = unknown> extends AsyncIterable<AgentEvent> {
|
|
|
87
113
|
* in the `observers` option.
|
|
88
114
|
*/
|
|
89
115
|
on(observer: Observer): () => void;
|
|
116
|
+
/**
|
|
117
|
+
* Queues a user message that redirects the run. The run applies it at the next step boundary: after the model call
|
|
118
|
+
* or tool batch in flight, never inside it, and before the next model call. The promise resolves with a
|
|
119
|
+
* `DeliveryReceipt` once the message is in the transcript, and the run emits a `steer_applied` event for it. It
|
|
120
|
+
* rejects with an `SdkError` whose code is `undelivered_message` when the run ends first, and with
|
|
121
|
+
* `invalid_run_options` for a blank message or a block that isn't text or an image. Steers are applied in the
|
|
122
|
+
* order they were sent.
|
|
123
|
+
*/
|
|
124
|
+
steer(message: string | readonly ContentBlock[]): Promise<DeliveryReceipt>;
|
|
125
|
+
/**
|
|
126
|
+
* Queues a user message that waits until the run would otherwise end. When the model has answered and no tool call
|
|
127
|
+
* is left, the run applies every waiting follow-up as user messages and makes one more model call, so a follow-up
|
|
128
|
+
* sent before the run ends extends it by one step. A steer that is waiting goes first. The run still ends, and the
|
|
129
|
+
* follow-up rejects with `undelivered_message`, when another stop reason ends it: a `shouldStop` hook or progress
|
|
130
|
+
* policy that stops it, its output tool, an abort or `maxSteps`. The receipt works as for `steer()`.
|
|
131
|
+
*/
|
|
132
|
+
followUp(message: string | readonly ContentBlock[]): Promise<DeliveryReceipt>;
|
|
90
133
|
}
|
|
134
|
+
/**
|
|
135
|
+
* The `depth` and `maxDepth` options for a run that a tool starts: one level deeper than the tool's own run, under
|
|
136
|
+
* the same cap. Spread it into the nested `run()`; the nested run throws `max_depth_exceeded` when the tool was
|
|
137
|
+
* already at `maxDepth`.
|
|
138
|
+
*/
|
|
139
|
+
export declare function nestedRunDepth(ctx: Pick<ToolContext, "depth" | "maxDepth">): {
|
|
140
|
+
depth: number;
|
|
141
|
+
maxDepth: number;
|
|
142
|
+
};
|
|
91
143
|
/**
|
|
92
144
|
* Starts a run: the model answers `input`, runs the tools it asks for, and goes on until it answers without a tool
|
|
93
145
|
* call, an output tool accepts its answer, or a stop reason ends the run early. Throws an `SdkError` at once for an
|
package/dist/run.js
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
|
+
import { checkBudgetOption } from "./budget.js";
|
|
1
2
|
import { RunStoppedError, SdkError } from "./errors.js";
|
|
2
3
|
import { runLoop } from "./loop.js";
|
|
3
4
|
import { ObserverBus } from "./observers.js";
|
|
5
|
+
import { progressCheck, resolveProgress } from "./progress.js";
|
|
6
|
+
import { SteeringQueue } from "./steering.js";
|
|
4
7
|
import { preparedSchemaOf } from "./tools/define.js";
|
|
5
8
|
import { SDK_VERSION } from "./version.js";
|
|
6
9
|
/** The step cap's default, counted in model calls. */
|
|
7
10
|
const DEFAULT_MAX_STEPS = 20;
|
|
11
|
+
/** The depth cap's default (D11): a top-level run, its subagents and their subagents may run, and no deeper. */
|
|
12
|
+
const DEFAULT_MAX_DEPTH = 2;
|
|
8
13
|
/** How long the run waits, by default, for an observer to catch up before it drops it. */
|
|
9
14
|
const DEFAULT_OBSERVER_TIMEOUT_MS = 10_000;
|
|
10
15
|
/** The longest delay `setTimeout` accepts; a larger one fires at once on Node and workerd alike. */
|
|
@@ -62,11 +67,13 @@ class RunHandle {
|
|
|
62
67
|
#settled = false;
|
|
63
68
|
/** Set by `run_end`: nothing may follow it, so a late observer report is dropped. */
|
|
64
69
|
#closed = false;
|
|
70
|
+
#steering;
|
|
65
71
|
#failure;
|
|
66
72
|
#stepIndex = 0;
|
|
67
73
|
constructor(setup, signal, watch) {
|
|
68
74
|
this.id = setup.runId;
|
|
69
75
|
this.#clock = setup.clock;
|
|
76
|
+
this.#steering = new SteeringQueue(setup.runId);
|
|
70
77
|
this.#bus = new ObserverBus((hook, error) => {
|
|
71
78
|
if (!this.#closed)
|
|
72
79
|
this.#push({ type: "hook_error", hook, error: messageOf(error) }, this.#stepIndex);
|
|
@@ -91,7 +98,7 @@ class RunHandle {
|
|
|
91
98
|
this.#settled = true;
|
|
92
99
|
return this.#bus.flush();
|
|
93
100
|
};
|
|
94
|
-
const loop = Promise.resolve().then(() => runLoop({ ...setup, signal: this.#controller.signal }, emit, drain));
|
|
101
|
+
const loop = Promise.resolve().then(() => runLoop({ ...setup, signal: this.#controller.signal, steering: this.#steering }, emit, drain));
|
|
95
102
|
// The loop's result type is `RunResult<unknown>`; only the output tool, whose type is `S`, fills `output`.
|
|
96
103
|
this.result = loop;
|
|
97
104
|
// Handling the rejection here also keeps a caller who only iterates from an unhandled rejection: iteration
|
|
@@ -108,6 +115,12 @@ class RunHandle {
|
|
|
108
115
|
checkObserver(observer);
|
|
109
116
|
return this.#bus.add(observer);
|
|
110
117
|
}
|
|
118
|
+
steer(message) {
|
|
119
|
+
return this.#steering.add("steer", message);
|
|
120
|
+
}
|
|
121
|
+
followUp(message) {
|
|
122
|
+
return this.#steering.add("follow_up", message);
|
|
123
|
+
}
|
|
111
124
|
[Symbol.asyncIterator]() {
|
|
112
125
|
let cursor = 0;
|
|
113
126
|
return {
|
|
@@ -173,6 +186,36 @@ function toolsOf(options) {
|
|
|
173
186
|
}
|
|
174
187
|
return tools;
|
|
175
188
|
}
|
|
189
|
+
function isCount(value) {
|
|
190
|
+
return typeof value === "number" && Number.isInteger(value) && value >= 0;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* The `depth` and `maxDepth` options for a run that a tool starts: one level deeper than the tool's own run, under
|
|
194
|
+
* the same cap. Spread it into the nested `run()`; the nested run throws `max_depth_exceeded` when the tool was
|
|
195
|
+
* already at `maxDepth`.
|
|
196
|
+
*/
|
|
197
|
+
export function nestedRunDepth(ctx) {
|
|
198
|
+
return { depth: ctx.depth + 1, maxDepth: ctx.maxDepth };
|
|
199
|
+
}
|
|
200
|
+
/** Checks `depth` and `maxDepth`, and refuses a run nested deeper than the cap allows (D11). */
|
|
201
|
+
function depthsOf(options) {
|
|
202
|
+
const { depth = 0, maxDepth = DEFAULT_MAX_DEPTH } = options;
|
|
203
|
+
if (!isCount(depth) || !isCount(maxDepth)) {
|
|
204
|
+
throw new SdkError("invalid_run_options", `depth and maxDepth must be whole numbers, 0 or more, got ${String(depth)} and ${String(maxDepth)}`);
|
|
205
|
+
}
|
|
206
|
+
if (depth > maxDepth) {
|
|
207
|
+
throw new SdkError("max_depth_exceeded", `a run at depth ${depth} is deeper than maxDepth ${maxDepth} allows`);
|
|
208
|
+
}
|
|
209
|
+
return { depth, maxDepth };
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* The default progress policy for this run, or `undefined` when `progress: false` turns it off. `skip` is the number
|
|
213
|
+
* of messages before the run's own.
|
|
214
|
+
*/
|
|
215
|
+
function progressOf(options, tools, skip) {
|
|
216
|
+
const policy = resolveProgress(options.progress);
|
|
217
|
+
return policy === undefined ? undefined : progressCheck(tools, policy, skip);
|
|
218
|
+
}
|
|
176
219
|
function setupOf(options, context, input) {
|
|
177
220
|
if (!isModel(options.model)) {
|
|
178
221
|
throw new SdkError("invalid_run_options", "the model must come from createModel(), such as createModel({ adapter, id })");
|
|
@@ -181,7 +224,10 @@ function setupOf(options, context, input) {
|
|
|
181
224
|
if (!Number.isInteger(maxSteps) || maxSteps < 1) {
|
|
182
225
|
throw new SdkError("invalid_run_options", `maxSteps must be a positive integer, got ${maxSteps}`);
|
|
183
226
|
}
|
|
227
|
+
const budgetUsd = checkBudgetOption(options.budgetUsd);
|
|
184
228
|
const tools = toolsOf(options);
|
|
229
|
+
const { depth, maxDepth } = depthsOf(options);
|
|
230
|
+
const progress = progressOf(options, tools, context.messages.length + input.length);
|
|
185
231
|
if (options.output !== undefined && (options.output.exposure ?? "direct") !== "direct") {
|
|
186
232
|
throw new SdkError("invalid_run_options", `the output tool "${options.output.name}" must be sent to the model, so its exposure must be "direct"`);
|
|
187
233
|
}
|
|
@@ -194,8 +240,12 @@ function setupOf(options, context, input) {
|
|
|
194
240
|
tools,
|
|
195
241
|
output: options.output,
|
|
196
242
|
maxSteps,
|
|
243
|
+
...(budgetUsd === undefined ? {} : { budgetUsd }),
|
|
244
|
+
depth,
|
|
245
|
+
maxDepth,
|
|
197
246
|
modelOptions: options.modelOptions ?? {},
|
|
198
247
|
interceptors: checkInterceptors(options.interceptors ?? {}),
|
|
248
|
+
...(progress === undefined ? {} : { progress }),
|
|
199
249
|
clock: options.clock ?? systemClock,
|
|
200
250
|
};
|
|
201
251
|
}
|
package/dist/run.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGxD,OAAO,EAAkB,OAAO,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,sDAAsD;AACtD,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAE7B,0FAA0F;AAC1F,MAAM,2BAA2B,GAAG,MAAM,CAAC;AAC3C,oGAAoG;AACpG,MAAM,YAAY,GAAG,aAAa,CAAC;AAEnC,MAAM,WAAW,GAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;AACnE,MAAM,SAAS,GAAG,GAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;AAoF/D,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,aAAa,CAAC,QAAiB;IACtC,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,uCAAuC,OAAO,QAAQ,EAAE,CAAC,CAAC;IACtG,CAAC;AACH,CAAC;AAED,MAAM,UAAU,GAAG;IACjB,kBAAkB;IAClB,iBAAiB;IACjB,gBAAgB;IAChB,gBAAgB;IAChB,eAAe;IACf,YAAY;CACJ,CAAC;AAEX,4GAA4G;AAC5G,SAAS,iBAAiB,CAAC,YAA0B;IACnD,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC9D,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,yCAAyC,CAAC,CAAC;IACvF,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAY,YAAY,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;YACrD,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,gBAAgB,IAAI,4BAA4B,OAAO,IAAI,EAAE,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC;IACnC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,aAAa,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;QACvF,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,4DAA4D,CAAC,CAAC;IAC1G,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,QAAQ,CAAC,MAAe;IAC/B,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC;IAC9C,OAAO,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9D,CAAC;AAED,MAAM,SAAS;IACJ,EAAE,CAAS;IACX,MAAM,CAAwB;IAC9B,OAAO,GAAiB,EAAE,CAAC;IAC3B,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;IACpC,MAAM,CAAQ;IACd,IAAI,CAAc;IAC3B,QAAQ,GAAmB,EAAE,CAAC;IAC9B,MAAM,GAAG,KAAK,CAAC;IACf,yGAAyG;IACzG,QAAQ,GAAG,KAAK,CAAC;IACjB,qFAAqF;IACrF,OAAO,GAAG,KAAK,CAAC;IAChB,QAAQ,CAA0C;IAClD,UAAU,GAAG,CAAC,CAAC;IAEf,YAAY,KAAgC,EAAE,MAA+B,EAAE,KAAoB;QACjG,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1C,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QACpB,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;QAC5B,KAAK,MAAM,QAAQ,IAAI,SAAS;YAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG,CAAC,IAAoB,EAAE,SAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtF,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;QACxB,MAAM,QAAQ,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,IAAa,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAC7G,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9D,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,YAAY,EAAE,CAAC;;YAC/B,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,gHAAgH;QAChH,sGAAsG;QACtG,+GAA+G;QAC/G,oGAAoG;QACpG,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/G,2GAA2G;QAC3G,IAAI,CAAC,MAAM,GAAG,IAA6B,CAAC;QAC5C,2GAA2G;QAC3G,yBAAyB;QACzB,IAAI,CAAC,IAAI,CACP,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,CAAC,EAChD,CAAC,KAAc,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,CAC/D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAe;QACnB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAC5E,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAClG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,EAAE,CAAC,QAAkB;QACnB,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,OAAO;YACL,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,OAAO,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACrD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpE,CAAC;gBACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,IAAI,CAAC,CAAC;oBACZ,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;gBACvC,CAAC;gBACD,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;oBAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC3D,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC1C,CAAC;SACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAoB,EAAE,SAAiB;QAC3C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACjD,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC;QACnG,MAAM,KAAK,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,EAAgB,CAAC;QACjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,IAAI,CAAC,MAA+B,EAAE,YAAwB,EAAE,OAAgD;QAC9G,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,OAAO;YAAE,IAAI,EAAE,CAAC;IACrC,CAAC;CACF;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,MAAM,SAAS,GAAG,KAA8B,CAAC;IACjD,OAAO,CACL,OAAO,SAAS,KAAK,QAAQ;QAC7B,SAAS,KAAK,IAAI;QAClB,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU;QACtC,OAAO,SAAS,CAAC,KAAK,KAAK,UAAU;QACrC,OAAO,SAAS,CAAC,GAAG,KAAK,QAAQ,CAClC,CAAC;AACJ,CAAC;AAED,kHAAkH;AAClH,SAAS,OAAO,CAAC,OAA4B;IAC3C,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAc,CAAC;IACtD,MAAM,MAAM,GAAG,OAAO,CAAC,MAA6B,CAAC;IACrD,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,QAAQ,CAAC,yBAAyB,EAAE,wBAAwB,IAAI,CAAC,IAAI,8BAA8B,CAAC,CAAC;QACjH,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,OAAO,CAAC,OAA4B,EAAE,OAAgB,EAAE,KAAyB;IACxF,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,8EAA8E,CAC/E,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,iBAAiB,CAAC;IACvD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,4CAA4C,QAAQ,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvF,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,oBAAoB,OAAO,CAAC,MAAM,CAAC,IAAI,+DAA+D,CACvG,CAAC;IACJ,CAAC;IACD,OAAO;QACL,KAAK,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,SAAS,CAAC,EAAE;QAC3C,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,KAAK;QACL,KAAK;QACL,MAAM,EAAE,OAAO,CAAC,MAA6B;QAC7C,QAAQ;QACR,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE;QACxC,YAAY,EAAE,iBAAiB,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;QAC3D,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,WAAW;KACpC,CAAC;AACJ,CAAC;AAQD,SAAS,WAAW,CAAC,OAA4B;IAC/C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;IAC1C,KAAK,MAAM,QAAQ,IAAI,SAAS;QAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,iBAAiB,IAAI,2BAA2B,CAAC;IAC3E,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC,IAAI,SAAS,GAAG,YAAY,EAAE,CAAC;QAC/G,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,gDAAgD,YAAY,SAAS,SAAS,EAAE,CACjF,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAc,OAAiC;IAChE,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACrH,MAAM,KAAK,GAAY,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;IAC/D,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACrG,OAAO,IAAI,SAAS,CAAI,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAc,OAAgB,EAAE,OAAsB;IAC/E,OAAO,IAAI,SAAS,CAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/F,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAI,OAAe;IACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;IACpC,IAAI,MAAM,CAAC,UAAU,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IAChD,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC","sourcesContent":["/**\n * `run()`, `continueRun()` and `runOrThrow()`, and the `Run` object they share (SDK plan §3.3; D10). A run streams\n * its events to anyone who iterates it and settles `result` with the same run's outcome, so the streaming and the\n * non-streaming caller drive one loop.\n */\nimport type { ContentBlock, Message, Model } from \"@buildanagent/gateway\";\nimport { RunStoppedError, SdkError } from \"./errors.js\";\nimport type { AgentEvent, AgentEventBody } from \"./events.js\";\nimport type { CallOptions, Interceptors, Observer } from \"./hooks.js\";\nimport { type LoopSetup, runLoop } from \"./loop.js\";\nimport { ObserverBus } from \"./observers.js\";\nimport type { Context, DoneResult, RunResult } from \"./result.js\";\nimport type { Clock } from \"./testing/determinism.js\";\nimport { preparedSchemaOf } from \"./tools/define.js\";\nimport type { AnyTool } from \"./tools/pipeline.js\";\nimport type { ToolDefinition } from \"./tools/types.js\";\nimport { SDK_VERSION } from \"./version.js\";\n\n/** The step cap's default, counted in model calls. */\nconst DEFAULT_MAX_STEPS = 20;\n\n/** How long the run waits, by default, for an observer to catch up before it drops it. */\nconst DEFAULT_OBSERVER_TIMEOUT_MS = 10_000;\n/** The longest delay `setTimeout` accepts; a larger one fires at once on Node and workerd alike. */\nconst MAX_TIMER_MS = 2_147_483_647;\n\nconst systemClock: Clock = { now: () => new Date().toISOString() };\nconst randomIds = (): string => globalThis.crypto.randomUUID();\n\n/** The options `run()` and `continueRun()` share. */\nexport interface RunOptions<S = unknown> {\n /** The model, from `createModel()`. */\n readonly model: Model;\n /**\n * The tools the model may call. Tools whose `exposure` is `deferred` or `hidden` are not sent unless a\n * `beforeModelCall` interceptor names them in `activeTools`.\n */\n readonly tools?: readonly ToolDefinition<unknown, unknown>[];\n /**\n * A tool from `outputTool()` whose input is the final answer. It is sent with the other tools; once the model calls\n * it with input that passes its schema, the run ends `done`, and `result.output` holds the validated answer.\n */\n readonly output?: ToolDefinition<S, S>;\n /**\n * The most model calls the run may make. Default 20. A run that reaches it while the model still wants to go on\n * ends with `stopReason: \"max_steps\"` and emits a `warning` event with `code: \"max_steps\"`.\n */\n readonly maxSteps?: number;\n /** Aborts the run, like `run.abort()`. */\n readonly signal?: AbortSignal;\n /** Options for every model call, such as `maxOutputTokens`. The run passes its own abort signal. */\n readonly modelOptions?: CallOptions;\n /**\n * The interceptors: hooks that can change the run at six moments. A run takes one object; join several with\n * `composeInterceptors()`. See `Interceptors` for the order and for what a failing hook does.\n */\n readonly interceptors?: Interceptors;\n /**\n * Observers, which receive every event from `run_start` on and can't change the run. Each observer sees the events in\n * order and waits for its own promises, but observers don't wait for each other. An observer that throws becomes a\n * `hook_error` event. The run waits for every observer to handle the last event before it settles, for at most\n * `observerTimeoutMs` each time it waits; an observer that hasn't caught up by then is removed and reported as a\n * `hook_error`.\n */\n readonly observers?: readonly Observer[];\n /**\n * The longest the run waits for its observers each time it waits for them: before `agent_settled`, before\n * `run_end` and before it settles. A number from 1 to 2147483647; the default is 10000. It bounds an observer whose promise never settles.\n */\n readonly observerTimeoutMs?: number;\n /** Stamps each event's `timestamp`, and is passed to tools. Defaults to the system clock. */\n readonly clock?: Clock;\n /** Makes the run's id. Defaults to `crypto.randomUUID()`. */\n readonly idGenerator?: () => string;\n}\n\n/** What `run()` takes besides the shared options. */\nexport interface RunInput {\n /** The system prompt. */\n readonly system: string;\n /** The user's message that starts the run. */\n readonly input: string | readonly ContentBlock[];\n /** Earlier messages to send before `input`, such as a previous conversation. */\n readonly history?: readonly Message[];\n}\n\n/**\n * A run in progress. Iterate it to stream its events: each iteration starts from the run's first event, so you can\n * start iterating at any time. Await `result` for the outcome; it rejects only for a programmer error, such as a\n * tool that returns a malformed result, and iteration then throws the same error after the last event.\n */\nexport interface Run<S = unknown> extends AsyncIterable<AgentEvent> {\n /** The run's id, which every event carries. */\n readonly id: string;\n /** The outcome, once the run has stopped. */\n readonly result: Promise<RunResult<S>>;\n /**\n * Stops the run. A model call in flight ends, a running tool sees its `signal` fire, and calls that haven't started\n * get an error result instead. The run then ends with `stopReason: \"aborted\"`. Does nothing once the run has its\n * outcome and is ending, which is before `agent_settled`.\n */\n abort(reason?: string): void;\n /**\n * Adds an observer that receives the events from now on, in order, and returns the function that removes it. An\n * event that was queued for it but not yet handled is dropped when you remove it. Add it right after `run()` to\n * see every event but `run_start`, which `run()` emits before it returns; to see that one too, pass the observer\n * in the `observers` option.\n */\n on(observer: Observer): () => void;\n}\n\nfunction messageOf(error: unknown): string {\n return error instanceof Error ? error.message : String(error);\n}\n\nfunction checkObserver(observer: unknown): void {\n if (typeof observer !== \"function\") {\n throw new SdkError(\"invalid_run_options\", `an observer must be a function, got ${typeof observer}`);\n }\n}\n\nconst HOOK_NAMES = [\n \"transformContext\",\n \"beforeModelCall\",\n \"afterModelCall\",\n \"beforeToolCall\",\n \"afterToolCall\",\n \"shouldStop\",\n] as const;\n\n/** Checks the interceptors option once, so a misspelt or mistyped hook fails at `run()` and not mid-run. */\nfunction checkInterceptors(interceptors: Interceptors): Interceptors {\n if (typeof interceptors !== \"object\" || interceptors === null) {\n throw new SdkError(\"invalid_run_options\", \"interceptors must be an object of hooks\");\n }\n for (const name of HOOK_NAMES) {\n const hook: unknown = interceptors[name];\n if (hook !== undefined && typeof hook !== \"function\") {\n throw new SdkError(\"invalid_run_options\", `interceptors.${name} must be a function, got ${typeof hook}`);\n }\n }\n const { onFailure } = interceptors;\n if (onFailure !== undefined && onFailure !== \"fail_closed\" && onFailure !== \"continue\") {\n throw new SdkError(\"invalid_run_options\", `interceptors.onFailure must be \"fail_closed\" or \"continue\"`);\n }\n return interceptors;\n}\n\nfunction reasonOf(reason: unknown): string | undefined {\n if (typeof reason === \"string\") return reason;\n return reason instanceof Error ? reason.message : undefined;\n}\n\nclass RunHandle<S> implements Run<S> {\n readonly id: string;\n readonly result: Promise<RunResult<S>>;\n readonly #events: AgentEvent[] = [];\n readonly #controller = new AbortController();\n readonly #clock: Clock;\n readonly #bus: ObserverBus;\n #waiters: (() => void)[] = [];\n #ended = false;\n /** Set once the loop has its outcome and starts to end the run, so `abort()` no longer does anything. */\n #settled = false;\n /** Set by `run_end`: nothing may follow it, so a late observer report is dropped. */\n #closed = false;\n #failure: { readonly error: unknown } | undefined;\n #stepIndex = 0;\n\n constructor(setup: Omit<LoopSetup, \"signal\">, signal: AbortSignal | undefined, watch: ObserverSetup) {\n this.id = setup.runId;\n this.#clock = setup.clock;\n this.#bus = new ObserverBus((hook, error) => {\n if (!this.#closed) this.#push({ type: \"hook_error\", hook, error: messageOf(error) }, this.#stepIndex);\n }, watch.timeoutMs);\n const { observers } = watch;\n for (const observer of observers) this.#bus.add(observer);\n const emit = (body: AgentEventBody, stepIndex: number) => this.#push(body, stepIndex);\n const { model } = setup;\n const versions = { sdkVersion: SDK_VERSION, specVersion: \"v1\" as const, defaultsHash: \"\", capabilities: [] };\n emit({ type: \"run_start\", ...versions, model: model.ref }, 0);\n const forwardAbort = () => this.abort(reasonOf(signal?.reason));\n if (signal?.aborted) forwardAbort();\n else signal?.addEventListener(\"abort\", forwardAbort, { once: true });\n // The loop starts after this turn, so an observer added with `run.on()` straight after `run()` sees every event\n // after `run_start`, and a `run.abort()` straight after it stops the run before its first model call.\n // The loop drains the observers only once it has its outcome (`finish()`), so the first drain is also where an\n // abort stops mattering: it could no longer change the outcome, only add an `abort` event after it.\n const drain = () => {\n this.#settled = true;\n return this.#bus.flush();\n };\n const loop = Promise.resolve().then(() => runLoop({ ...setup, signal: this.#controller.signal }, emit, drain));\n // The loop's result type is `RunResult<unknown>`; only the output tool, whose type is `S`, fills `output`.\n this.result = loop as Promise<RunResult<S>>;\n // Handling the rejection here also keeps a caller who only iterates from an unhandled rejection: iteration\n // throws the same error.\n loop.then(\n () => this.#end(signal, forwardAbort, undefined),\n (error: unknown) => this.#end(signal, forwardAbort, { error }),\n );\n }\n\n abort(reason?: string): void {\n if (this.#settled || this.#ended || this.#controller.signal.aborted) return;\n this.#push(reason === undefined ? { type: \"abort\" } : { type: \"abort\", reason }, this.#stepIndex);\n this.#controller.abort(reason);\n }\n\n on(observer: Observer): () => void {\n checkObserver(observer);\n return this.#bus.add(observer);\n }\n\n [Symbol.asyncIterator](): AsyncIterator<AgentEvent> {\n let cursor = 0;\n return {\n next: async () => {\n while (cursor >= this.#events.length && !this.#ended) {\n await new Promise<void>((resolve) => this.#waiters.push(resolve));\n }\n const event = this.#events[cursor];\n if (event !== undefined) {\n cursor += 1;\n return { value: event, done: false };\n }\n if (this.#failure !== undefined) throw this.#failure.error;\n return { value: undefined, done: true };\n },\n };\n }\n\n #push(body: AgentEventBody, stepIndex: number): void {\n this.#stepIndex = stepIndex;\n if (body.type === \"run_end\") this.#closed = true;\n const base = { runId: this.id, seq: this.#events.length, stepIndex, timestamp: this.#clock.now() };\n const event = { ...base, ...body } as AgentEvent;\n this.#events.push(event);\n this.#bus.deliver(event);\n this.#wake();\n }\n\n #end(signal: AbortSignal | undefined, forwardAbort: () => void, failure: { readonly error: unknown } | undefined) {\n signal?.removeEventListener(\"abort\", forwardAbort);\n this.#failure = failure;\n this.#ended = true;\n this.#wake();\n }\n\n #wake(): void {\n const waiters = this.#waiters;\n this.#waiters = [];\n for (const wake of waiters) wake();\n }\n}\n\nfunction isModel(model: unknown): model is Model {\n const candidate = model as Partial<Model> | null;\n return (\n typeof candidate === \"object\" &&\n candidate !== null &&\n typeof candidate.stream === \"function\" &&\n typeof candidate.price === \"function\" &&\n typeof candidate.ref === \"object\"\n );\n}\n\n/** Every tool the run may send, the output tool last unless `tools` already holds it, after checking each one. */\nfunction toolsOf(options: RunOptions<unknown>): AnyTool[] {\n const tools = [...(options.tools ?? [])] as AnyTool[];\n const output = options.output as AnyTool | undefined;\n if (output !== undefined && !tools.includes(output)) tools.push(output);\n const names = new Set<string>();\n for (const tool of tools) {\n preparedSchemaOf(tool);\n if (names.has(tool.name)) {\n throw new SdkError(\"invalid_tool_definition\", `two tools are named \"${tool.name}\"; tool names must be unique`);\n }\n names.add(tool.name);\n }\n return tools;\n}\n\nfunction setupOf(options: RunOptions<unknown>, context: Context, input: readonly Message[]): Omit<LoopSetup, \"signal\"> {\n if (!isModel(options.model)) {\n throw new SdkError(\n \"invalid_run_options\",\n \"the model must come from createModel(), such as createModel({ adapter, id })\",\n );\n }\n const maxSteps = options.maxSteps ?? DEFAULT_MAX_STEPS;\n if (!Number.isInteger(maxSteps) || maxSteps < 1) {\n throw new SdkError(\"invalid_run_options\", `maxSteps must be a positive integer, got ${maxSteps}`);\n }\n const tools = toolsOf(options);\n if (options.output !== undefined && (options.output.exposure ?? \"direct\") !== \"direct\") {\n throw new SdkError(\n \"invalid_run_options\",\n `the output tool \"${options.output.name}\" must be sent to the model, so its exposure must be \"direct\"`,\n );\n }\n return {\n runId: (options.idGenerator ?? randomIds)(),\n model: options.model,\n system: context.system,\n history: context.messages,\n input,\n tools,\n output: options.output as AnyTool | undefined,\n maxSteps,\n modelOptions: options.modelOptions ?? {},\n interceptors: checkInterceptors(options.interceptors ?? {}),\n clock: options.clock ?? systemClock,\n };\n}\n\n/** The observers a run starts with, and how long it waits for them. */\ninterface ObserverSetup {\n readonly observers: readonly Observer[];\n readonly timeoutMs: number;\n}\n\nfunction observersOf(options: RunOptions<unknown>): ObserverSetup {\n const observers = options.observers ?? [];\n for (const observer of observers) checkObserver(observer);\n const timeoutMs = options.observerTimeoutMs ?? DEFAULT_OBSERVER_TIMEOUT_MS;\n if (typeof timeoutMs !== \"number\" || !Number.isFinite(timeoutMs) || timeoutMs <= 0 || timeoutMs > MAX_TIMER_MS) {\n throw new SdkError(\n \"invalid_run_options\",\n `observerTimeoutMs must be a number from 1 to ${MAX_TIMER_MS}, got ${timeoutMs}`,\n );\n }\n return { observers, timeoutMs };\n}\n\n/**\n * Starts a run: the model answers `input`, runs the tools it asks for, and goes on until it answers without a tool\n * call, an output tool accepts its answer, or a stop reason ends the run early. Throws an `SdkError` at once for an\n * unusable option: a model that isn't from `createModel()`, a `maxSteps` that isn't a positive integer, an output tool\n * that isn't sent to the model, or two tools with one name.\n */\nexport function run<S = unknown>(options: RunOptions<S> & RunInput): Run<S> {\n const content = typeof options.input === \"string\" ? [{ type: \"text\" as const, text: options.input }] : options.input;\n const input: Message = { role: \"user\", content: [...content] };\n const setup = setupOf(options, { system: options.system, messages: options.history ?? [] }, [input]);\n return new RunHandle<S>(setup, options.signal, observersOf(options));\n}\n\n/**\n * Goes on with a conversation from a result's `context`, or one you rebuilt from your own store. It runs like\n * `run()`, from the last message in the context, and `result.messages` holds only the messages it adds. The context\n * is sent as it stands, so add a user message to one that ends with the model's answer, such as a `done` result's.\n */\nexport function continueRun<S = unknown>(context: Context, options: RunOptions<S>): Run<S> {\n return new RunHandle<S>(setupOf(options, context, []), options.signal, observersOf(options));\n}\n\n/**\n * Awaits a run and returns its result if it ended `done`. Any other stop reason throws a `RunStoppedError` that\n * carries the result and the context to continue from.\n */\nexport async function runOrThrow<S>(started: Run<S>): Promise<DoneResult<S>> {\n const result = await started.result;\n if (result.stopReason === \"done\") return result;\n throw new RunStoppedError(result);\n}\n"]}
|
|
1
|
+
{"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGxD,OAAO,EAAkB,OAAO,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAA2C,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAExG,OAAO,EAAwB,aAAa,EAAE,MAAM,eAAe,CAAC;AAEpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,sDAAsD;AACtD,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAE7B,gHAAgH;AAChH,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAE5B,0FAA0F;AAC1F,MAAM,2BAA2B,GAAG,MAAM,CAAC;AAC3C,oGAAoG;AACpG,MAAM,YAAY,GAAG,aAAa,CAAC;AAEnC,MAAM,WAAW,GAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;AACnE,MAAM,SAAS,GAAG,GAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;AA6H/D,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,aAAa,CAAC,QAAiB;IACtC,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,uCAAuC,OAAO,QAAQ,EAAE,CAAC,CAAC;IACtG,CAAC;AACH,CAAC;AAED,MAAM,UAAU,GAAG;IACjB,kBAAkB;IAClB,iBAAiB;IACjB,gBAAgB;IAChB,gBAAgB;IAChB,eAAe;IACf,YAAY;CACJ,CAAC;AAEX,4GAA4G;AAC5G,SAAS,iBAAiB,CAAC,YAA0B;IACnD,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC9D,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,yCAAyC,CAAC,CAAC;IACvF,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAY,YAAY,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;YACrD,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,gBAAgB,IAAI,4BAA4B,OAAO,IAAI,EAAE,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC;IACnC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,aAAa,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;QACvF,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,4DAA4D,CAAC,CAAC;IAC1G,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,QAAQ,CAAC,MAAe;IAC/B,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC;IAC9C,OAAO,MAAM,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9D,CAAC;AAED,MAAM,SAAS;IACJ,EAAE,CAAS;IACX,MAAM,CAAwB;IAC9B,OAAO,GAAiB,EAAE,CAAC;IAC3B,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;IACpC,MAAM,CAAQ;IACd,IAAI,CAAc;IAC3B,QAAQ,GAAmB,EAAE,CAAC;IAC9B,MAAM,GAAG,KAAK,CAAC;IACf,yGAAyG;IACzG,QAAQ,GAAG,KAAK,CAAC;IACjB,qFAAqF;IACrF,OAAO,GAAG,KAAK,CAAC;IACP,SAAS,CAAgB;IAClC,QAAQ,CAA0C;IAClD,UAAU,GAAG,CAAC,CAAC;IAEf,YAAY,KAA6C,EAAE,MAA+B,EAAE,KAAoB;QAC9G,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1C,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QACpB,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;QAC5B,KAAK,MAAM,QAAQ,IAAI,SAAS;YAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG,CAAC,IAAoB,EAAE,SAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtF,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;QACxB,MAAM,QAAQ,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,IAAa,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAC7G,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9D,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,YAAY,EAAE,CAAC;;YAC/B,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,gHAAgH;QAChH,sGAAsG;QACtG,+GAA+G;QAC/G,oGAAoG;QACpG,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CACvC,OAAO,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,CAC9F,CAAC;QACF,2GAA2G;QAC3G,IAAI,CAAC,MAAM,GAAG,IAA6B,CAAC;QAC5C,2GAA2G;QAC3G,yBAAyB;QACzB,IAAI,CAAC,IAAI,CACP,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,CAAC,EAChD,CAAC,KAAc,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,CAC/D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAe;QACnB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAC5E,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAClG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,EAAE,CAAC,QAAkB;QACnB,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,OAAyC;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,QAAQ,CAAC,OAAyC;QAChD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,OAAO;YACL,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,OAAO,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACrD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpE,CAAC;gBACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,IAAI,CAAC,CAAC;oBACZ,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;gBACvC,CAAC;gBACD,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;oBAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC3D,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC1C,CAAC;SACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAoB,EAAE,SAAiB;QAC3C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACjD,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC;QACnG,MAAM,KAAK,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,EAAgB,CAAC;QACjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,IAAI,CAAC,MAA+B,EAAE,YAAwB,EAAE,OAAgD;QAC9G,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,OAAO;YAAE,IAAI,EAAE,CAAC;IACrC,CAAC;CACF;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,MAAM,SAAS,GAAG,KAA8B,CAAC;IACjD,OAAO,CACL,OAAO,SAAS,KAAK,QAAQ;QAC7B,SAAS,KAAK,IAAI;QAClB,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU;QACtC,OAAO,SAAS,CAAC,KAAK,KAAK,UAAU;QACrC,OAAO,SAAS,CAAC,GAAG,KAAK,QAAQ,CAClC,CAAC;AACJ,CAAC;AAED,kHAAkH;AAClH,SAAS,OAAO,CAAC,OAA4B;IAC3C,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAc,CAAC;IACtD,MAAM,MAAM,GAAG,OAAO,CAAC,MAA6B,CAAC;IACrD,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,QAAQ,CAAC,yBAAyB,EAAE,wBAAwB,IAAI,CAAC,IAAI,8BAA8B,CAAC,CAAC;QACjH,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAC5E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,GAA4C;IACzE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;AAC1D,CAAC;AAED,gGAAgG;AAChG,SAAS,QAAQ,CAAC,OAA4B;IAC5C,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,QAAQ,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC;IAC5D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,4DAA4D,MAAM,CAAC,KAAK,CAAC,QAAQ,MAAM,CAAC,QAAQ,CAAC,EAAE,CACpG,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;QACrB,MAAM,IAAI,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,KAAK,4BAA4B,QAAQ,SAAS,CAAC,CAAC;IACjH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,OAA4B,EAAE,KAAyB,EAAE,IAAY;IACvF,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjD,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,OAAO,CACd,OAA4B,EAC5B,OAAgB,EAChB,KAAyB;IAEzB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,8EAA8E,CAC/E,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,iBAAiB,CAAC;IACvD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,4CAA4C,QAAQ,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IACpF,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvF,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,oBAAoB,OAAO,CAAC,MAAM,CAAC,IAAI,+DAA+D,CACvG,CAAC;IACJ,CAAC;IACD,OAAO;QACL,KAAK,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,SAAS,CAAC,EAAE;QAC3C,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,KAAK;QACL,KAAK;QACL,MAAM,EAAE,OAAO,CAAC,MAA6B;QAC7C,QAAQ;QACR,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;QACjD,KAAK;QACL,QAAQ;QACR,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,EAAE;QACxC,YAAY,EAAE,iBAAiB,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;QAC3D,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC/C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,WAAW;KACpC,CAAC;AACJ,CAAC;AAQD,SAAS,WAAW,CAAC,OAA4B;IAC/C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;IAC1C,KAAK,MAAM,QAAQ,IAAI,SAAS;QAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,iBAAiB,IAAI,2BAA2B,CAAC;IAC3E,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC,IAAI,SAAS,GAAG,YAAY,EAAE,CAAC;QAC/G,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,gDAAgD,YAAY,SAAS,SAAS,EAAE,CACjF,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAc,OAAiC;IAChE,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACrH,MAAM,KAAK,GAAY,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC;IAC/D,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACrG,OAAO,IAAI,SAAS,CAAI,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAc,OAAgB,EAAE,OAAsB;IAC/E,OAAO,IAAI,SAAS,CAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/F,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAI,OAAe;IACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC;IACpC,IAAI,MAAM,CAAC,UAAU,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IAChD,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC","sourcesContent":["/**\n * `run()`, `continueRun()` and `runOrThrow()`, and the `Run` object they share (SDK plan §3.3; D10). A run streams\n * its events to anyone who iterates it and settles `result` with the same run's outcome, so the streaming and the\n * non-streaming caller drive one loop.\n */\nimport type { ContentBlock, Message, Model } from \"@buildanagent/gateway\";\nimport { checkBudgetOption } from \"./budget.js\";\nimport { RunStoppedError, SdkError } from \"./errors.js\";\nimport type { AgentEvent, AgentEventBody } from \"./events.js\";\nimport type { CallOptions, Interceptors, Observer } from \"./hooks.js\";\nimport { type LoopSetup, runLoop } from \"./loop.js\";\nimport { ObserverBus } from \"./observers.js\";\nimport { type ProgressCheck, type ProgressPolicy, progressCheck, resolveProgress } from \"./progress.js\";\nimport type { Context, DoneResult, RunResult } from \"./result.js\";\nimport { type DeliveryReceipt, SteeringQueue } from \"./steering.js\";\nimport type { Clock } from \"./testing/determinism.js\";\nimport { preparedSchemaOf } from \"./tools/define.js\";\nimport type { AnyTool } from \"./tools/pipeline.js\";\nimport type { ToolContext, ToolDefinition } from \"./tools/types.js\";\nimport { SDK_VERSION } from \"./version.js\";\n\n/** The step cap's default, counted in model calls. */\nconst DEFAULT_MAX_STEPS = 20;\n\n/** The depth cap's default (D11): a top-level run, its subagents and their subagents may run, and no deeper. */\nconst DEFAULT_MAX_DEPTH = 2;\n\n/** How long the run waits, by default, for an observer to catch up before it drops it. */\nconst DEFAULT_OBSERVER_TIMEOUT_MS = 10_000;\n/** The longest delay `setTimeout` accepts; a larger one fires at once on Node and workerd alike. */\nconst MAX_TIMER_MS = 2_147_483_647;\n\nconst systemClock: Clock = { now: () => new Date().toISOString() };\nconst randomIds = (): string => globalThis.crypto.randomUUID();\n\n/** The options `run()` and `continueRun()` share. */\nexport interface RunOptions<S = unknown> {\n /** The model, from `createModel()`. */\n readonly model: Model;\n /**\n * The tools the model may call. Tools whose `exposure` is `deferred` or `hidden` are not sent unless a\n * `beforeModelCall` interceptor names them in `activeTools`.\n */\n readonly tools?: readonly ToolDefinition<unknown, unknown>[];\n /**\n * A tool from `outputTool()` whose input is the final answer. It is sent with the other tools; once the model calls\n * it with input that passes its schema, the run ends `done`, and `result.output` holds the validated answer.\n */\n readonly output?: ToolDefinition<S, S>;\n /**\n * The most model calls the run may make. Default 20. A run that reaches it while the model still wants to go on\n * ends with `stopReason: \"max_steps\"` and emits a `warning` event with `code: \"max_steps\"`.\n */\n readonly maxSteps?: number;\n /**\n * The most the run's model calls may cost, in USD. Before each call the run projects its cost with\n * `projectCallCost()` and, if the spend so far plus that projection would pass the cap, ends with\n * `stopReason: \"budget\"` without making the call. The cap counts the calls this run makes, not the cost of the\n * history a `continueRun()` starts from. A budgeted run on a model whose price is unknown ends `error` with\n * `error.kind: \"unknown_price\"` before its first call, because it could not tell what it spent. Without it, a run\n * has no cap.\n */\n readonly budgetUsd?: number;\n /**\n * The default progress policy: the run ends `no_progress` after 3 identical failing tool calls in a row, or after 5\n * calls to a tool with one `progressKey` and no success between them. It runs after your own `shouldStop`, whose\n * `{ continue }` can't keep a stuck run going. Pass numbers to change either threshold, or `false` to turn the\n * policy off.\n */\n readonly progress?: ProgressPolicy | false;\n /**\n * How deeply this run is nested inside other agents' tool calls. Default 0. A tool that starts a run of its own\n * passes `depth: ctx.depth + 1` and `maxDepth: ctx.maxDepth`; `run()` throws an `SdkError` with code\n * `max_depth_exceeded` when `depth` is above `maxDepth`, which the tool's caller reads as an error result.\n */\n readonly depth?: number;\n /** The deepest nesting allowed, which tools read as `ctx.maxDepth`. Default 2. */\n readonly maxDepth?: number;\n /** Aborts the run, like `run.abort()`. */\n readonly signal?: AbortSignal;\n /** Options for every model call, such as `maxOutputTokens`. The run passes its own abort signal. */\n readonly modelOptions?: CallOptions;\n /**\n * The interceptors: hooks that can change the run at six moments. A run takes one object; join several with\n * `composeInterceptors()`. See `Interceptors` for the order and for what a failing hook does.\n */\n readonly interceptors?: Interceptors;\n /**\n * Observers, which receive every event from `run_start` on and can't change the run. Each observer sees the events in\n * order and waits for its own promises, but observers don't wait for each other. An observer that throws becomes a\n * `hook_error` event. The run waits for every observer to handle the last event before it settles, for at most\n * `observerTimeoutMs` each time it waits; an observer that hasn't caught up by then is removed and reported as a\n * `hook_error`.\n */\n readonly observers?: readonly Observer[];\n /**\n * The longest the run waits for its observers each time it waits for them: before `agent_settled`, before\n * `run_end` and before it settles. A number from 1 to 2147483647; the default is 10000. It bounds an observer whose promise never settles.\n */\n readonly observerTimeoutMs?: number;\n /** Stamps each event's `timestamp`, and is passed to tools. Defaults to the system clock. */\n readonly clock?: Clock;\n /** Makes the run's id. Defaults to `crypto.randomUUID()`. */\n readonly idGenerator?: () => string;\n}\n\n/** What `run()` takes besides the shared options. */\nexport interface RunInput {\n /** The system prompt. */\n readonly system: string;\n /** The user's message that starts the run. */\n readonly input: string | readonly ContentBlock[];\n /** Earlier messages to send before `input`, such as a previous conversation. */\n readonly history?: readonly Message[];\n}\n\n/**\n * A run in progress. Iterate it to stream its events: each iteration starts from the run's first event, so you can\n * start iterating at any time. Await `result` for the outcome; it rejects only for a programmer error, such as a\n * tool that returns a malformed result, and iteration then throws the same error after the last event.\n */\nexport interface Run<S = unknown> extends AsyncIterable<AgentEvent> {\n /** The run's id, which every event carries. */\n readonly id: string;\n /** The outcome, once the run has stopped. */\n readonly result: Promise<RunResult<S>>;\n /**\n * Stops the run. A model call in flight ends, a running tool sees its `signal` fire, and calls that haven't started\n * get an error result instead. The run then ends with `stopReason: \"aborted\"`. Does nothing once the run has its\n * outcome and is ending, which is before `agent_settled`.\n */\n abort(reason?: string): void;\n /**\n * Adds an observer that receives the events from now on, in order, and returns the function that removes it. An\n * event that was queued for it but not yet handled is dropped when you remove it. Add it right after `run()` to\n * see every event but `run_start`, which `run()` emits before it returns; to see that one too, pass the observer\n * in the `observers` option.\n */\n on(observer: Observer): () => void;\n /**\n * Queues a user message that redirects the run. The run applies it at the next step boundary: after the model call\n * or tool batch in flight, never inside it, and before the next model call. The promise resolves with a\n * `DeliveryReceipt` once the message is in the transcript, and the run emits a `steer_applied` event for it. It\n * rejects with an `SdkError` whose code is `undelivered_message` when the run ends first, and with\n * `invalid_run_options` for a blank message or a block that isn't text or an image. Steers are applied in the\n * order they were sent.\n */\n steer(message: string | readonly ContentBlock[]): Promise<DeliveryReceipt>;\n /**\n * Queues a user message that waits until the run would otherwise end. When the model has answered and no tool call\n * is left, the run applies every waiting follow-up as user messages and makes one more model call, so a follow-up\n * sent before the run ends extends it by one step. A steer that is waiting goes first. The run still ends, and the\n * follow-up rejects with `undelivered_message`, when another stop reason ends it: a `shouldStop` hook or progress\n * policy that stops it, its output tool, an abort or `maxSteps`. The receipt works as for `steer()`.\n */\n followUp(message: string | readonly ContentBlock[]): Promise<DeliveryReceipt>;\n}\n\nfunction messageOf(error: unknown): string {\n return error instanceof Error ? error.message : String(error);\n}\n\nfunction checkObserver(observer: unknown): void {\n if (typeof observer !== \"function\") {\n throw new SdkError(\"invalid_run_options\", `an observer must be a function, got ${typeof observer}`);\n }\n}\n\nconst HOOK_NAMES = [\n \"transformContext\",\n \"beforeModelCall\",\n \"afterModelCall\",\n \"beforeToolCall\",\n \"afterToolCall\",\n \"shouldStop\",\n] as const;\n\n/** Checks the interceptors option once, so a misspelt or mistyped hook fails at `run()` and not mid-run. */\nfunction checkInterceptors(interceptors: Interceptors): Interceptors {\n if (typeof interceptors !== \"object\" || interceptors === null) {\n throw new SdkError(\"invalid_run_options\", \"interceptors must be an object of hooks\");\n }\n for (const name of HOOK_NAMES) {\n const hook: unknown = interceptors[name];\n if (hook !== undefined && typeof hook !== \"function\") {\n throw new SdkError(\"invalid_run_options\", `interceptors.${name} must be a function, got ${typeof hook}`);\n }\n }\n const { onFailure } = interceptors;\n if (onFailure !== undefined && onFailure !== \"fail_closed\" && onFailure !== \"continue\") {\n throw new SdkError(\"invalid_run_options\", `interceptors.onFailure must be \"fail_closed\" or \"continue\"`);\n }\n return interceptors;\n}\n\nfunction reasonOf(reason: unknown): string | undefined {\n if (typeof reason === \"string\") return reason;\n return reason instanceof Error ? reason.message : undefined;\n}\n\nclass RunHandle<S> implements Run<S> {\n readonly id: string;\n readonly result: Promise<RunResult<S>>;\n readonly #events: AgentEvent[] = [];\n readonly #controller = new AbortController();\n readonly #clock: Clock;\n readonly #bus: ObserverBus;\n #waiters: (() => void)[] = [];\n #ended = false;\n /** Set once the loop has its outcome and starts to end the run, so `abort()` no longer does anything. */\n #settled = false;\n /** Set by `run_end`: nothing may follow it, so a late observer report is dropped. */\n #closed = false;\n readonly #steering: SteeringQueue;\n #failure: { readonly error: unknown } | undefined;\n #stepIndex = 0;\n\n constructor(setup: Omit<LoopSetup, \"signal\" | \"steering\">, signal: AbortSignal | undefined, watch: ObserverSetup) {\n this.id = setup.runId;\n this.#clock = setup.clock;\n this.#steering = new SteeringQueue(setup.runId);\n this.#bus = new ObserverBus((hook, error) => {\n if (!this.#closed) this.#push({ type: \"hook_error\", hook, error: messageOf(error) }, this.#stepIndex);\n }, watch.timeoutMs);\n const { observers } = watch;\n for (const observer of observers) this.#bus.add(observer);\n const emit = (body: AgentEventBody, stepIndex: number) => this.#push(body, stepIndex);\n const { model } = setup;\n const versions = { sdkVersion: SDK_VERSION, specVersion: \"v1\" as const, defaultsHash: \"\", capabilities: [] };\n emit({ type: \"run_start\", ...versions, model: model.ref }, 0);\n const forwardAbort = () => this.abort(reasonOf(signal?.reason));\n if (signal?.aborted) forwardAbort();\n else signal?.addEventListener(\"abort\", forwardAbort, { once: true });\n // The loop starts after this turn, so an observer added with `run.on()` straight after `run()` sees every event\n // after `run_start`, and a `run.abort()` straight after it stops the run before its first model call.\n // The loop drains the observers only once it has its outcome (`finish()`), so the first drain is also where an\n // abort stops mattering: it could no longer change the outcome, only add an `abort` event after it.\n const drain = () => {\n this.#settled = true;\n return this.#bus.flush();\n };\n const loop = Promise.resolve().then(() =>\n runLoop({ ...setup, signal: this.#controller.signal, steering: this.#steering }, emit, drain),\n );\n // The loop's result type is `RunResult<unknown>`; only the output tool, whose type is `S`, fills `output`.\n this.result = loop as Promise<RunResult<S>>;\n // Handling the rejection here also keeps a caller who only iterates from an unhandled rejection: iteration\n // throws the same error.\n loop.then(\n () => this.#end(signal, forwardAbort, undefined),\n (error: unknown) => this.#end(signal, forwardAbort, { error }),\n );\n }\n\n abort(reason?: string): void {\n if (this.#settled || this.#ended || this.#controller.signal.aborted) return;\n this.#push(reason === undefined ? { type: \"abort\" } : { type: \"abort\", reason }, this.#stepIndex);\n this.#controller.abort(reason);\n }\n\n on(observer: Observer): () => void {\n checkObserver(observer);\n return this.#bus.add(observer);\n }\n\n steer(message: string | readonly ContentBlock[]): Promise<DeliveryReceipt> {\n return this.#steering.add(\"steer\", message);\n }\n\n followUp(message: string | readonly ContentBlock[]): Promise<DeliveryReceipt> {\n return this.#steering.add(\"follow_up\", message);\n }\n\n [Symbol.asyncIterator](): AsyncIterator<AgentEvent> {\n let cursor = 0;\n return {\n next: async () => {\n while (cursor >= this.#events.length && !this.#ended) {\n await new Promise<void>((resolve) => this.#waiters.push(resolve));\n }\n const event = this.#events[cursor];\n if (event !== undefined) {\n cursor += 1;\n return { value: event, done: false };\n }\n if (this.#failure !== undefined) throw this.#failure.error;\n return { value: undefined, done: true };\n },\n };\n }\n\n #push(body: AgentEventBody, stepIndex: number): void {\n this.#stepIndex = stepIndex;\n if (body.type === \"run_end\") this.#closed = true;\n const base = { runId: this.id, seq: this.#events.length, stepIndex, timestamp: this.#clock.now() };\n const event = { ...base, ...body } as AgentEvent;\n this.#events.push(event);\n this.#bus.deliver(event);\n this.#wake();\n }\n\n #end(signal: AbortSignal | undefined, forwardAbort: () => void, failure: { readonly error: unknown } | undefined) {\n signal?.removeEventListener(\"abort\", forwardAbort);\n this.#failure = failure;\n this.#ended = true;\n this.#wake();\n }\n\n #wake(): void {\n const waiters = this.#waiters;\n this.#waiters = [];\n for (const wake of waiters) wake();\n }\n}\n\nfunction isModel(model: unknown): model is Model {\n const candidate = model as Partial<Model> | null;\n return (\n typeof candidate === \"object\" &&\n candidate !== null &&\n typeof candidate.stream === \"function\" &&\n typeof candidate.price === \"function\" &&\n typeof candidate.ref === \"object\"\n );\n}\n\n/** Every tool the run may send, the output tool last unless `tools` already holds it, after checking each one. */\nfunction toolsOf(options: RunOptions<unknown>): AnyTool[] {\n const tools = [...(options.tools ?? [])] as AnyTool[];\n const output = options.output as AnyTool | undefined;\n if (output !== undefined && !tools.includes(output)) tools.push(output);\n const names = new Set<string>();\n for (const tool of tools) {\n preparedSchemaOf(tool);\n if (names.has(tool.name)) {\n throw new SdkError(\"invalid_tool_definition\", `two tools are named \"${tool.name}\"; tool names must be unique`);\n }\n names.add(tool.name);\n }\n return tools;\n}\n\nfunction isCount(value: unknown): value is number {\n return typeof value === \"number\" && Number.isInteger(value) && value >= 0;\n}\n\n/**\n * The `depth` and `maxDepth` options for a run that a tool starts: one level deeper than the tool's own run, under\n * the same cap. Spread it into the nested `run()`; the nested run throws `max_depth_exceeded` when the tool was\n * already at `maxDepth`.\n */\nexport function nestedRunDepth(ctx: Pick<ToolContext, \"depth\" | \"maxDepth\">): { depth: number; maxDepth: number } {\n return { depth: ctx.depth + 1, maxDepth: ctx.maxDepth };\n}\n\n/** Checks `depth` and `maxDepth`, and refuses a run nested deeper than the cap allows (D11). */\nfunction depthsOf(options: RunOptions<unknown>): { depth: number; maxDepth: number } {\n const { depth = 0, maxDepth = DEFAULT_MAX_DEPTH } = options;\n if (!isCount(depth) || !isCount(maxDepth)) {\n throw new SdkError(\n \"invalid_run_options\",\n `depth and maxDepth must be whole numbers, 0 or more, got ${String(depth)} and ${String(maxDepth)}`,\n );\n }\n if (depth > maxDepth) {\n throw new SdkError(\"max_depth_exceeded\", `a run at depth ${depth} is deeper than maxDepth ${maxDepth} allows`);\n }\n return { depth, maxDepth };\n}\n\n/**\n * The default progress policy for this run, or `undefined` when `progress: false` turns it off. `skip` is the number\n * of messages before the run's own.\n */\nfunction progressOf(options: RunOptions<unknown>, tools: readonly AnyTool[], skip: number): ProgressCheck | undefined {\n const policy = resolveProgress(options.progress);\n return policy === undefined ? undefined : progressCheck(tools, policy, skip);\n}\n\nfunction setupOf(\n options: RunOptions<unknown>,\n context: Context,\n input: readonly Message[],\n): Omit<LoopSetup, \"signal\" | \"steering\"> {\n if (!isModel(options.model)) {\n throw new SdkError(\n \"invalid_run_options\",\n \"the model must come from createModel(), such as createModel({ adapter, id })\",\n );\n }\n const maxSteps = options.maxSteps ?? DEFAULT_MAX_STEPS;\n if (!Number.isInteger(maxSteps) || maxSteps < 1) {\n throw new SdkError(\"invalid_run_options\", `maxSteps must be a positive integer, got ${maxSteps}`);\n }\n const budgetUsd = checkBudgetOption(options.budgetUsd);\n const tools = toolsOf(options);\n const { depth, maxDepth } = depthsOf(options);\n const progress = progressOf(options, tools, context.messages.length + input.length);\n if (options.output !== undefined && (options.output.exposure ?? \"direct\") !== \"direct\") {\n throw new SdkError(\n \"invalid_run_options\",\n `the output tool \"${options.output.name}\" must be sent to the model, so its exposure must be \"direct\"`,\n );\n }\n return {\n runId: (options.idGenerator ?? randomIds)(),\n model: options.model,\n system: context.system,\n history: context.messages,\n input,\n tools,\n output: options.output as AnyTool | undefined,\n maxSteps,\n ...(budgetUsd === undefined ? {} : { budgetUsd }),\n depth,\n maxDepth,\n modelOptions: options.modelOptions ?? {},\n interceptors: checkInterceptors(options.interceptors ?? {}),\n ...(progress === undefined ? {} : { progress }),\n clock: options.clock ?? systemClock,\n };\n}\n\n/** The observers a run starts with, and how long it waits for them. */\ninterface ObserverSetup {\n readonly observers: readonly Observer[];\n readonly timeoutMs: number;\n}\n\nfunction observersOf(options: RunOptions<unknown>): ObserverSetup {\n const observers = options.observers ?? [];\n for (const observer of observers) checkObserver(observer);\n const timeoutMs = options.observerTimeoutMs ?? DEFAULT_OBSERVER_TIMEOUT_MS;\n if (typeof timeoutMs !== \"number\" || !Number.isFinite(timeoutMs) || timeoutMs <= 0 || timeoutMs > MAX_TIMER_MS) {\n throw new SdkError(\n \"invalid_run_options\",\n `observerTimeoutMs must be a number from 1 to ${MAX_TIMER_MS}, got ${timeoutMs}`,\n );\n }\n return { observers, timeoutMs };\n}\n\n/**\n * Starts a run: the model answers `input`, runs the tools it asks for, and goes on until it answers without a tool\n * call, an output tool accepts its answer, or a stop reason ends the run early. Throws an `SdkError` at once for an\n * unusable option: a model that isn't from `createModel()`, a `maxSteps` that isn't a positive integer, an output tool\n * that isn't sent to the model, or two tools with one name.\n */\nexport function run<S = unknown>(options: RunOptions<S> & RunInput): Run<S> {\n const content = typeof options.input === \"string\" ? [{ type: \"text\" as const, text: options.input }] : options.input;\n const input: Message = { role: \"user\", content: [...content] };\n const setup = setupOf(options, { system: options.system, messages: options.history ?? [] }, [input]);\n return new RunHandle<S>(setup, options.signal, observersOf(options));\n}\n\n/**\n * Goes on with a conversation from a result's `context`, or one you rebuilt from your own store. It runs like\n * `run()`, from the last message in the context, and `result.messages` holds only the messages it adds. The context\n * is sent as it stands, so add a user message to one that ends with the model's answer, such as a `done` result's.\n */\nexport function continueRun<S = unknown>(context: Context, options: RunOptions<S>): Run<S> {\n return new RunHandle<S>(setupOf(options, context, []), options.signal, observersOf(options));\n}\n\n/**\n * Awaits a run and returns its result if it ended `done`. Any other stop reason throws a `RunStoppedError` that\n * carries the result and the context to continue from.\n */\nexport async function runOrThrow<S>(started: Run<S>): Promise<DoneResult<S>> {\n const result = await started.result;\n if (result.stopReason === \"done\") return result;\n throw new RunStoppedError(result);\n}\n"]}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Steering and follow-up (SDK plan §3.3). A caller queues a user message while a run goes on; the loop applies it
|
|
3
|
+
* only at a step boundary, so a running model call or tool batch is never cut. A steer is applied before the run's
|
|
4
|
+
* next model call. A follow-up waits until the run would otherwise end. Each queued message returns a receipt once
|
|
5
|
+
* it has entered the transcript.
|
|
6
|
+
*/
|
|
7
|
+
import type { ContentBlock } from "@buildanagent/gateway";
|
|
8
|
+
/** Whether a message steers the run now or follows up once it would otherwise end. */
|
|
9
|
+
export type DeliveryKind = "steer" | "follow_up";
|
|
10
|
+
/**
|
|
11
|
+
* Proof that a queued message entered the transcript. `id` is unique within the run, `message` is the content the
|
|
12
|
+
* run added as a user message, and `stepIndex` is the step at whose start the run added it. That step's model call is
|
|
13
|
+
* the first to see the message, unless the run ends before the call, which a budget stop or a failed hook can cause.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeliveryReceipt {
|
|
16
|
+
readonly id: string;
|
|
17
|
+
readonly kind: DeliveryKind;
|
|
18
|
+
readonly message: readonly ContentBlock[];
|
|
19
|
+
readonly stepIndex: number;
|
|
20
|
+
}
|
|
21
|
+
/** A message the loop took from the queue, with the function that settles its receipt. */
|
|
22
|
+
export interface Delivery {
|
|
23
|
+
readonly kind: DeliveryKind;
|
|
24
|
+
readonly message: readonly ContentBlock[];
|
|
25
|
+
/** Settles the receipt once the message is in the transcript. */
|
|
26
|
+
readonly deliver: (stepIndex: number) => DeliveryReceipt;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* The queue between a caller and the loop. The caller adds with `steer()` and `followUp()`; the loop takes with
|
|
30
|
+
* `take()` at a step boundary, and closes the queue when the run has its outcome.
|
|
31
|
+
*/
|
|
32
|
+
export declare class SteeringQueue {
|
|
33
|
+
#private;
|
|
34
|
+
constructor(runId: string);
|
|
35
|
+
/**
|
|
36
|
+
* Queues a message. The promise rejects, never throws, for an unusable message or a run that has ended. A caller who
|
|
37
|
+
* ignores the promise must not crash the process when the run ends first, so a rejection is always marked handled;
|
|
38
|
+
* a caller who awaits it still sees it.
|
|
39
|
+
*/
|
|
40
|
+
add(kind: DeliveryKind, message: string | readonly ContentBlock[]): Promise<DeliveryReceipt>;
|
|
41
|
+
/** True while a steer is waiting. */
|
|
42
|
+
hasSteers(): boolean;
|
|
43
|
+
/** True while any message is waiting. */
|
|
44
|
+
hasPending(): boolean;
|
|
45
|
+
/**
|
|
46
|
+
* Removes and returns the waiting steers, and the waiting follow-ups too when `withFollowUps` is set, all in the
|
|
47
|
+
* order they were sent.
|
|
48
|
+
*/
|
|
49
|
+
take(withFollowUps: boolean): Delivery[];
|
|
50
|
+
/** Ends the queue: every message still waiting is rejected, and later calls are too. */
|
|
51
|
+
close(): void;
|
|
52
|
+
}
|
package/dist/steering.js
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { SdkError } from "./errors.js";
|
|
2
|
+
/** A copy of one block of a steering message that holds only the block's own fields. */
|
|
3
|
+
function checkBlock(block) {
|
|
4
|
+
const candidate = block;
|
|
5
|
+
if (candidate?.type === "text" && typeof candidate.text === "string") {
|
|
6
|
+
// Providers refuse an empty text block, so it is refused here rather than failing the next model call.
|
|
7
|
+
if (candidate.text.trim().length === 0) {
|
|
8
|
+
throw new SdkError("invalid_run_options", "a steering message's text block must not be empty");
|
|
9
|
+
}
|
|
10
|
+
return { type: "text", text: candidate.text };
|
|
11
|
+
}
|
|
12
|
+
if (candidate?.type === "image" && typeof candidate.mediaType === "string" && typeof candidate.data === "string") {
|
|
13
|
+
return { type: "image", mediaType: candidate.mediaType, data: candidate.data };
|
|
14
|
+
}
|
|
15
|
+
throw new SdkError("invalid_run_options", "a steering message holds only text and image blocks");
|
|
16
|
+
}
|
|
17
|
+
/** The content of a steering message: a string that isn't blank, or a non-empty list of text and image blocks. */
|
|
18
|
+
function contentOf(message) {
|
|
19
|
+
if (typeof message === "string") {
|
|
20
|
+
if (message.trim().length === 0)
|
|
21
|
+
throw new SdkError("invalid_run_options", "a steering message must not be empty");
|
|
22
|
+
return [{ type: "text", text: message }];
|
|
23
|
+
}
|
|
24
|
+
if (!Array.isArray(message) || message.length === 0) {
|
|
25
|
+
throw new SdkError("invalid_run_options", "a steering message must be a string or a non-empty list of blocks");
|
|
26
|
+
}
|
|
27
|
+
return message.map(checkBlock);
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* The queue between a caller and the loop. The caller adds with `steer()` and `followUp()`; the loop takes with
|
|
31
|
+
* `take()` at a step boundary, and closes the queue when the run has its outcome.
|
|
32
|
+
*/
|
|
33
|
+
export class SteeringQueue {
|
|
34
|
+
#runId;
|
|
35
|
+
#queue = [];
|
|
36
|
+
#count = 0;
|
|
37
|
+
#closed = false;
|
|
38
|
+
constructor(runId) {
|
|
39
|
+
this.#runId = runId;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Queues a message. The promise rejects, never throws, for an unusable message or a run that has ended. A caller who
|
|
43
|
+
* ignores the promise must not crash the process when the run ends first, so a rejection is always marked handled;
|
|
44
|
+
* a caller who awaits it still sees it.
|
|
45
|
+
*/
|
|
46
|
+
add(kind, message) {
|
|
47
|
+
const receipt = this.#enqueue(kind, message);
|
|
48
|
+
receipt.catch(() => undefined);
|
|
49
|
+
return receipt;
|
|
50
|
+
}
|
|
51
|
+
#enqueue(kind, message) {
|
|
52
|
+
let content;
|
|
53
|
+
try {
|
|
54
|
+
content = contentOf(message);
|
|
55
|
+
}
|
|
56
|
+
catch (error) {
|
|
57
|
+
return Promise.reject(error);
|
|
58
|
+
}
|
|
59
|
+
if (this.#closed)
|
|
60
|
+
return Promise.reject(undelivered(kind));
|
|
61
|
+
this.#count += 1;
|
|
62
|
+
const id = `${this.#runId}:message-${this.#count}`;
|
|
63
|
+
return new Promise((resolve, reject) => {
|
|
64
|
+
this.#queue.push({ id, kind, message: content, resolve, reject });
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
/** True while a steer is waiting. */
|
|
68
|
+
hasSteers() {
|
|
69
|
+
return this.#queue.some((entry) => entry.kind === "steer");
|
|
70
|
+
}
|
|
71
|
+
/** True while any message is waiting. */
|
|
72
|
+
hasPending() {
|
|
73
|
+
return this.#queue.length > 0;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Removes and returns the waiting steers, and the waiting follow-ups too when `withFollowUps` is set, all in the
|
|
77
|
+
* order they were sent.
|
|
78
|
+
*/
|
|
79
|
+
take(withFollowUps) {
|
|
80
|
+
const taken = this.#queue.filter((entry) => withFollowUps || entry.kind === "steer");
|
|
81
|
+
this.#queue = this.#queue.filter((entry) => !taken.includes(entry));
|
|
82
|
+
return taken.map((entry) => ({
|
|
83
|
+
kind: entry.kind,
|
|
84
|
+
message: entry.message,
|
|
85
|
+
deliver: (stepIndex) => {
|
|
86
|
+
const receipt = { id: entry.id, kind: entry.kind, message: entry.message, stepIndex };
|
|
87
|
+
entry.resolve(receipt);
|
|
88
|
+
return receipt;
|
|
89
|
+
},
|
|
90
|
+
}));
|
|
91
|
+
}
|
|
92
|
+
/** Ends the queue: every message still waiting is rejected, and later calls are too. */
|
|
93
|
+
close() {
|
|
94
|
+
this.#closed = true;
|
|
95
|
+
const waiting = this.#queue;
|
|
96
|
+
this.#queue = [];
|
|
97
|
+
for (const entry of waiting)
|
|
98
|
+
entry.reject(undelivered(entry.kind));
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
function undelivered(kind) {
|
|
102
|
+
return new SdkError("undelivered_message", `the ${kind === "steer" ? "steer" : "follow-up"} was not applied: the run ended before its next step boundary`);
|
|
103
|
+
}
|
|
104
|
+
//# sourceMappingURL=steering.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"steering.js","sourceRoot":"","sources":["../src/steering.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAiCvC,wFAAwF;AACxF,SAAS,UAAU,CAAC,KAAc;IAChC,MAAM,SAAS,GAAG,KAAuF,CAAC;IAC1G,IAAI,SAAS,EAAE,IAAI,KAAK,MAAM,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrE,uGAAuG;QACvG,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,mDAAmD,CAAC,CAAC;QACjG,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC;IAChD,CAAC;IACD,IAAI,SAAS,EAAE,IAAI,KAAK,OAAO,IAAI,OAAO,SAAS,CAAC,SAAS,KAAK,QAAQ,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACjH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC;IACjF,CAAC;IACD,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,qDAAqD,CAAC,CAAC;AACnG,CAAC;AAED,kHAAkH;AAClH,SAAS,SAAS,CAAC,OAAgB;IACjC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,sCAAsC,CAAC,CAAC;QACnH,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,QAAQ,CAAC,qBAAqB,EAAE,mEAAmE,CAAC,CAAC;IACjH,CAAC;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,aAAa;IACf,MAAM,CAAS;IACxB,MAAM,GAAa,EAAE,CAAC;IACtB,MAAM,GAAG,CAAC,CAAC;IACX,OAAO,GAAG,KAAK,CAAC;IAEhB,YAAY,KAAa;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAkB,EAAE,OAAyC;QAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,QAAQ,CAAC,IAAkB,EAAE,OAAyC;QACpE,IAAI,OAAuB,CAAC;QAC5B,IAAI,CAAC;YACH,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QACjB,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,YAAY,IAAI,CAAC,MAAM,EAAE,CAAC;QACnD,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC;IACrC,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,yCAAyC;IACzC,UAAU;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,aAAsB;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QACrF,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC3B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,CAAC,SAAS,EAAE,EAAE;gBACrB,MAAM,OAAO,GAAoB,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC;gBACvG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACvB,OAAO,OAAO,CAAC;YACjB,CAAC;SACF,CAAC,CAAC,CAAC;IACN,CAAC;IAED,wFAAwF;IACxF,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,KAAK,MAAM,KAAK,IAAI,OAAO;YAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;CACF;AAED,SAAS,WAAW,CAAC,IAAkB;IACrC,OAAO,IAAI,QAAQ,CACjB,qBAAqB,EACrB,OAAO,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,+DAA+D,CAC/G,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Steering and follow-up (SDK plan §3.3). A caller queues a user message while a run goes on; the loop applies it\n * only at a step boundary, so a running model call or tool batch is never cut. A steer is applied before the run's\n * next model call. A follow-up waits until the run would otherwise end. Each queued message returns a receipt once\n * it has entered the transcript.\n */\nimport type { ContentBlock } from \"@buildanagent/gateway\";\nimport { SdkError } from \"./errors.js\";\n\n/** Whether a message steers the run now or follows up once it would otherwise end. */\nexport type DeliveryKind = \"steer\" | \"follow_up\";\n\n/**\n * Proof that a queued message entered the transcript. `id` is unique within the run, `message` is the content the\n * run added as a user message, and `stepIndex` is the step at whose start the run added it. That step's model call is\n * the first to see the message, unless the run ends before the call, which a budget stop or a failed hook can cause.\n */\nexport interface DeliveryReceipt {\n readonly id: string;\n readonly kind: DeliveryKind;\n readonly message: readonly ContentBlock[];\n readonly stepIndex: number;\n}\n\ninterface Queued {\n readonly id: string;\n readonly kind: DeliveryKind;\n readonly message: readonly ContentBlock[];\n readonly resolve: (receipt: DeliveryReceipt) => void;\n readonly reject: (error: unknown) => void;\n}\n\n/** A message the loop took from the queue, with the function that settles its receipt. */\nexport interface Delivery {\n readonly kind: DeliveryKind;\n readonly message: readonly ContentBlock[];\n /** Settles the receipt once the message is in the transcript. */\n readonly deliver: (stepIndex: number) => DeliveryReceipt;\n}\n\n/** A copy of one block of a steering message that holds only the block's own fields. */\nfunction checkBlock(block: unknown): ContentBlock {\n const candidate = block as { type?: unknown; text?: unknown; mediaType?: unknown; data?: unknown } | null;\n if (candidate?.type === \"text\" && typeof candidate.text === \"string\") {\n // Providers refuse an empty text block, so it is refused here rather than failing the next model call.\n if (candidate.text.trim().length === 0) {\n throw new SdkError(\"invalid_run_options\", \"a steering message's text block must not be empty\");\n }\n return { type: \"text\", text: candidate.text };\n }\n if (candidate?.type === \"image\" && typeof candidate.mediaType === \"string\" && typeof candidate.data === \"string\") {\n return { type: \"image\", mediaType: candidate.mediaType, data: candidate.data };\n }\n throw new SdkError(\"invalid_run_options\", \"a steering message holds only text and image blocks\");\n}\n\n/** The content of a steering message: a string that isn't blank, or a non-empty list of text and image blocks. */\nfunction contentOf(message: unknown): ContentBlock[] {\n if (typeof message === \"string\") {\n if (message.trim().length === 0) throw new SdkError(\"invalid_run_options\", \"a steering message must not be empty\");\n return [{ type: \"text\", text: message }];\n }\n if (!Array.isArray(message) || message.length === 0) {\n throw new SdkError(\"invalid_run_options\", \"a steering message must be a string or a non-empty list of blocks\");\n }\n return message.map(checkBlock);\n}\n\n/**\n * The queue between a caller and the loop. The caller adds with `steer()` and `followUp()`; the loop takes with\n * `take()` at a step boundary, and closes the queue when the run has its outcome.\n */\nexport class SteeringQueue {\n readonly #runId: string;\n #queue: Queued[] = [];\n #count = 0;\n #closed = false;\n\n constructor(runId: string) {\n this.#runId = runId;\n }\n\n /**\n * Queues a message. The promise rejects, never throws, for an unusable message or a run that has ended. A caller who\n * ignores the promise must not crash the process when the run ends first, so a rejection is always marked handled;\n * a caller who awaits it still sees it.\n */\n add(kind: DeliveryKind, message: string | readonly ContentBlock[]): Promise<DeliveryReceipt> {\n const receipt = this.#enqueue(kind, message);\n receipt.catch(() => undefined);\n return receipt;\n }\n\n #enqueue(kind: DeliveryKind, message: string | readonly ContentBlock[]): Promise<DeliveryReceipt> {\n let content: ContentBlock[];\n try {\n content = contentOf(message);\n } catch (error) {\n return Promise.reject(error);\n }\n if (this.#closed) return Promise.reject(undelivered(kind));\n this.#count += 1;\n const id = `${this.#runId}:message-${this.#count}`;\n return new Promise<DeliveryReceipt>((resolve, reject) => {\n this.#queue.push({ id, kind, message: content, resolve, reject });\n });\n }\n\n /** True while a steer is waiting. */\n hasSteers(): boolean {\n return this.#queue.some((entry) => entry.kind === \"steer\");\n }\n\n /** True while any message is waiting. */\n hasPending(): boolean {\n return this.#queue.length > 0;\n }\n\n /**\n * Removes and returns the waiting steers, and the waiting follow-ups too when `withFollowUps` is set, all in the\n * order they were sent.\n */\n take(withFollowUps: boolean): Delivery[] {\n const taken = this.#queue.filter((entry) => withFollowUps || entry.kind === \"steer\");\n this.#queue = this.#queue.filter((entry) => !taken.includes(entry));\n return taken.map((entry) => ({\n kind: entry.kind,\n message: entry.message,\n deliver: (stepIndex) => {\n const receipt: DeliveryReceipt = { id: entry.id, kind: entry.kind, message: entry.message, stepIndex };\n entry.resolve(receipt);\n return receipt;\n },\n }));\n }\n\n /** Ends the queue: every message still waiting is rejected, and later calls are too. */\n close(): void {\n this.#closed = true;\n const waiting = this.#queue;\n this.#queue = [];\n for (const entry of waiting) entry.reject(undelivered(entry.kind));\n }\n}\n\nfunction undelivered(kind: DeliveryKind): SdkError {\n return new SdkError(\n \"undelivered_message\",\n `the ${kind === \"steer\" ? \"steer\" : \"follow-up\"} was not applied: the run ended before its next step boundary`,\n );\n}\n"]}
|
package/dist/tools/define.d.ts
CHANGED
|
@@ -17,9 +17,9 @@ export declare function preparedSchemaOf(tool: ToolDefinition<unknown, unknown>)
|
|
|
17
17
|
*
|
|
18
18
|
* Throws an `SdkError`, code `invalid_tool_definition`, when the name breaks the tool-name rule (1 to 64 characters
|
|
19
19
|
* from `A-Z`, `a-z`, `0-9`, `_` and `-`), the description or `execute` is missing, `exposure` is not one of its three
|
|
20
|
-
* values, `executionMode` is neither `parallel` nor `sequential`, `resourceKey` is not a function,
|
|
21
|
-
* does not compile or names a draft other than 2020-12 or 7, or a Standard Schema cannot describe
|
|
22
|
-
* Schema.
|
|
20
|
+
* values, `executionMode` is neither `parallel` nor `sequential`, `resourceKey` or `progressKey` is not a function,
|
|
21
|
+
* a raw JSON Schema does not compile or names a draft other than 2020-12 or 7, or a Standard Schema cannot describe
|
|
22
|
+
* itself as JSON Schema.
|
|
23
23
|
*/
|
|
24
24
|
export declare function defineTool<I, S = unknown>(definition: ToolDefinition<I, S>): ToolDefinition<I, S>;
|
|
25
25
|
/** The options of `outputTool()`. */
|
package/dist/tools/define.js
CHANGED
|
@@ -46,6 +46,9 @@ export function preparedSchemaOf(tool) {
|
|
|
46
46
|
if (tool.resourceKey !== undefined && typeof tool.resourceKey !== "function") {
|
|
47
47
|
throw invalid(`tool "${name}": resourceKey must be a function`);
|
|
48
48
|
}
|
|
49
|
+
if (tool.progressKey !== undefined && typeof tool.progressKey !== "function") {
|
|
50
|
+
throw invalid(`tool "${name}": progressKey must be a function`);
|
|
51
|
+
}
|
|
49
52
|
const schema = prepareSchema(name, tool.inputSchema);
|
|
50
53
|
prepared.set(tool, schema);
|
|
51
54
|
return schema;
|
|
@@ -55,9 +58,9 @@ export function preparedSchemaOf(tool) {
|
|
|
55
58
|
*
|
|
56
59
|
* Throws an `SdkError`, code `invalid_tool_definition`, when the name breaks the tool-name rule (1 to 64 characters
|
|
57
60
|
* from `A-Z`, `a-z`, `0-9`, `_` and `-`), the description or `execute` is missing, `exposure` is not one of its three
|
|
58
|
-
* values, `executionMode` is neither `parallel` nor `sequential`, `resourceKey` is not a function,
|
|
59
|
-
* does not compile or names a draft other than 2020-12 or 7, or a Standard Schema cannot describe
|
|
60
|
-
* Schema.
|
|
61
|
+
* values, `executionMode` is neither `parallel` nor `sequential`, `resourceKey` or `progressKey` is not a function,
|
|
62
|
+
* a raw JSON Schema does not compile or names a draft other than 2020-12 or 7, or a Standard Schema cannot describe
|
|
63
|
+
* itself as JSON Schema.
|
|
61
64
|
*/
|
|
62
65
|
export function defineTool(definition) {
|
|
63
66
|
const tool = Object.freeze({ ...definition });
|