@loomcycle/client 1.91.0 → 1.93.0

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.
@@ -138,8 +138,15 @@ function runBody(opts) {
138
138
  body.metadata = opts.metadata;
139
139
  if (opts.runTimeoutSeconds !== undefined)
140
140
  body.run_timeout_seconds = opts.runTimeoutSeconds;
141
+ if (opts.reviewTtlSeconds !== undefined)
142
+ body.review_ttl_seconds = opts.reviewTtlSeconds;
141
143
  if (opts.sampling !== undefined)
142
144
  body.sampling = samplingToWire(opts.sampling);
145
+ // Same keys on the wire as in the option (mode / name / until).
146
+ if (opts.toolChoice !== undefined)
147
+ body.tool_choice = opts.toolChoice;
148
+ if (opts.outputFormat !== undefined)
149
+ body.output_format = opts.outputFormat;
143
150
  if (opts.compaction !== undefined)
144
151
  body.compaction = compactionToWire(opts.compaction);
145
152
  if (opts.context !== undefined)
@@ -193,6 +200,8 @@ function applyOverridesToWire(body, opts) {
193
200
  body.interactive = opts.interactive;
194
201
  if (opts.interruption !== undefined)
195
202
  body.interruption = opts.interruption;
203
+ if (opts.review !== undefined)
204
+ body.review = opts.review;
196
205
  }
197
206
  class LoomcycleClient {
198
207
  ctx;
@@ -270,8 +279,14 @@ class LoomcycleClient {
270
279
  body.metadata = opts.metadata;
271
280
  if (opts.runTimeoutSeconds !== undefined)
272
281
  body.run_timeout_seconds = opts.runTimeoutSeconds;
282
+ if (opts.reviewTtlSeconds !== undefined)
283
+ body.review_ttl_seconds = opts.reviewTtlSeconds;
273
284
  if (opts.sampling !== undefined)
274
285
  body.sampling = samplingToWire(opts.sampling);
286
+ if (opts.toolChoice !== undefined)
287
+ body.tool_choice = opts.toolChoice;
288
+ if (opts.outputFormat !== undefined)
289
+ body.output_format = opts.outputFormat;
275
290
  if (opts.compaction !== undefined)
276
291
  body.compaction = compactionToWire(opts.compaction);
277
292
  if (opts.context !== undefined)
@@ -342,6 +357,58 @@ class LoomcycleClient {
342
357
  async getRunConfig(runId, opts) {
343
358
  return (0, fetch_helpers_js_1.jsonFetch)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/config`, opts);
344
359
  }
360
+ /** Read the prompt a run's first model call received (RFC DI). Mirrors
361
+ * `GET /v1/runs/{run_id}/prompt`. Recorded when the model was called, not
362
+ * re-derived now, so it is what the model saw even if a document or memory
363
+ * it quoted has changed since.
364
+ *
365
+ * Raises {@link NotFoundError} (404) for an unknown run and for another
366
+ * tenant's run alike, and also — with code `no_prompt_snapshot` — for a run
367
+ * that never reached a model call or predates prompt snapshots. */
368
+ /** Create a run WITHOUT starting it (RFC DI): a configured run holds its
369
+ * request, runs nothing and takes no slot until
370
+ * {@link LoomcycleClient.startConfiguredRun}. It is validated now exactly as
371
+ * a run would be; admission and the budget check happen at start. It never
372
+ * stores a secret — pass `userBearer` / `userCredentials` to the start. */
373
+ async createConfiguredRun(opts) {
374
+ const body = runBody(opts);
375
+ body.start = false;
376
+ return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/runs", body, { signal: opts.signal });
377
+ }
378
+ /** Replace fields of a configured run's request. Set fields replace the
379
+ * draft's; `remove` names wire fields (snake_case, e.g. `"sampling"`) to
380
+ * drop. The agent, the identity and secrets cannot be changed. Refused
381
+ * (409) once the run has started. */
382
+ async updateConfiguredRun(runId, patch, opts) {
383
+ // runBody serializes only the fields that are set, so a partial patch
384
+ // stays partial on the wire.
385
+ const body = runBody(patch);
386
+ delete body.agent;
387
+ for (const k of opts?.remove ?? [])
388
+ body[k] = null;
389
+ return (0, fetch_helpers_js_1.patchJSON)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}`, body, { signal: opts?.signal });
390
+ }
391
+ /** Start a configured run and stream it, exactly as
392
+ * {@link LoomcycleClient.runStreaming} streams a new one. Admission happens
393
+ * here: a refusal (429 / 503) throws before any event and leaves the run
394
+ * configured, to be started again later. Secrets the draft never stored
395
+ * are passed here. */
396
+ async *startConfiguredRun(runId, opts) {
397
+ const body = {};
398
+ if (opts?.userBearer !== undefined)
399
+ body.user_bearer = opts.userBearer;
400
+ if (opts?.userCredentials !== undefined)
401
+ body.user_credentials = opts.userCredentials;
402
+ yield* this.streamSSE(`/v1/runs/${encodeURIComponent(runId)}/start`, body, opts?.signal, opts?.debug);
403
+ }
404
+ /** Discard a configured run and its session. A live run is not discarded —
405
+ * cancel it instead. */
406
+ async deleteConfiguredRun(runId, opts) {
407
+ await (0, fetch_helpers_js_1.deleteRequest)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}`, opts);
408
+ }
409
+ async getRunPrompt(runId, opts) {
410
+ return (0, fetch_helpers_js_1.jsonFetch)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/prompt`, opts);
411
+ }
345
412
  /** Read what a run will ACTUALLY use, field by field, with the layer that
346
413
  * decided each. Mirrors `GET /v1/runs/{run_id}/effective-config`.
347
414
  *
@@ -539,6 +606,11 @@ class LoomcycleClient {
539
606
  * NOT whole-run cancel ({@link LoomcycleClient.cancelAgent}), which terminates
540
607
  * the run. Returns `{ run_id, stopped, parked }`.
541
608
  *
609
+ * A team walk's run (the `run_id` a detached `runTeam` returns) has no turns,
610
+ * so this ENDS the walk and the runs it spawned: `{ stopped: true, parked:
611
+ * false }`, recorded as cancelled. Walks are reachable on the replica running
612
+ * them only.
613
+ *
542
614
  * Rejects with RunBusyError (409) when the run isn't mid-turn or isn't
543
615
  * interactive, and AgentNotFoundError (404) for an unknown / cross-tenant run.
544
616
  * Mirrors POST /v1/runs/{run_id}/cancel. (RFC BH)
@@ -549,6 +621,26 @@ class LoomcycleClient {
549
621
  body.reason = opts.reason;
550
622
  return (0, fetch_helpers_js_1.postJSON)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/cancel`, body, opts);
551
623
  }
624
+ /**
625
+ * Deliver a verdict on a run held for review (one started or retuned with
626
+ * `review: true`, whose stream has emitted `awaiting_review`).
627
+ *
628
+ * - `approve` — the run completes on the answer it was held on.
629
+ * - `reject` with `feedback` — the feedback becomes the run's next user turn;
630
+ * it revises and is held again.
631
+ * - `reject` without feedback — the run ends with status `rejected`.
632
+ *
633
+ * Rejects with a LoomcycleError of status 409 (body code `not_held`) when
634
+ * the run is live but not held, NotFoundError (404) for an unknown, finished
635
+ * or cross-tenant run, and InvalidArgumentError (400) for feedback on an
636
+ * approval. Mirrors POST /v1/runs/{run_id}/review.
637
+ */
638
+ async reviewRun(runId, decision, opts) {
639
+ const body = { decision };
640
+ if (opts?.feedback !== undefined)
641
+ body.feedback = opts.feedback;
642
+ return (0, fetch_helpers_js_1.postJSON)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/review`, body, opts);
643
+ }
552
644
  // ---- Agent metadata ----
553
645
  /** Read one agent's status + usage stats. Raises AgentNotFoundError
554
646
  * when the agent_id is unknown. */
package/dist/client.d.ts CHANGED
@@ -25,7 +25,7 @@
25
25
  */
26
26
  import { InteractiveSession } from "./interactive.js";
27
27
  import { ClientToolHost, type ConnectClientToolsOptions } from "./client-tools.js";
28
- import type { CredentialListResponse, CredentialMeta, CredentialScope, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResult, Agent, AgentEvent, AgentStatus, CancelAgentResult, ClientOptions, ContinueOptions, RunOverrideOptions, EffectiveConfigResponse, RetuneRunResponse, RunConfigResponse, CreateSnapshotOptions, EnsureCodeAgentOptions, EnsureCodeAgentResult, EnsureMcpServerOptions, EnsureMcpServerResult, HealthResponse, Hook, InterruptListResponse, InterruptStatus, AckChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAckResult, ChannelAwaitResult, ChannelBroadcastResult, ChannelDescriptor, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelReleaseResult, ChannelSubscribeResult, CreateChannelOptions, ListChannelsResponse, PeekChannelOptions, PublishChannelOptions, ReleaseChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, SubscribeChannelOptions, UpdateChannelOptions, LibraryAgentDefinition, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, ListUsersResponse, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, ListUserTokensResponse, RunnableAgentsResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, MCPServerDefVerifyResult, MemoryEmbedStatsResponse, MemoryEntriesResponse, MemoryEntryResponse, MemoryBackfillResponse, MemoryPurgeResponse, MemoryReembedResponse, MemoryScopeIDsResponse, MemoryScopesResponse, MemorySearchInput, MemorySearchResponse, PauseResult, PersistentVolumesResponse, EphemeralVolumesResponse, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, ReplaySessionResult, CancelTurnResult, RunBatchOptions, RunBatchResult, RunOptions, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, ListTeamsResponse, PromotedTeam, RetiredTeam, TeamBreakpoints, TeamDefDetail, TeamRunDetached, TeamRunTarget, TeamVerification, TeamVersionList, TeamDiagram, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, TranscriptResponse, WhoamiResponse, UsageDimension, UsageReportResponse, TokenLimit, TokenLimitsResponse, ConfigResponse, SetTokenLimitRequest } from "./types.js";
28
+ import type { CredentialListResponse, CredentialMeta, CredentialScope, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResult, Agent, AgentEvent, AgentStatus, CancelAgentResult, ClientOptions, ContinueOptions, RunOverrideOptions, EffectiveConfigResponse, RetuneRunResponse, RunConfigResponse, RunPromptResponse, CreateSnapshotOptions, EnsureCodeAgentOptions, EnsureCodeAgentResult, EnsureMcpServerOptions, EnsureMcpServerResult, HealthResponse, Hook, InterruptListResponse, InterruptStatus, AckChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAckResult, ChannelAwaitResult, ChannelBroadcastResult, ChannelDescriptor, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelReleaseResult, ChannelSubscribeResult, CreateChannelOptions, ListChannelsResponse, PeekChannelOptions, PublishChannelOptions, ReleaseChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, SubscribeChannelOptions, UpdateChannelOptions, LibraryAgentDefinition, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, ListUsersResponse, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, ListUserTokensResponse, RunnableAgentsResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, MCPServerDefVerifyResult, MemoryEmbedStatsResponse, MemoryEntriesResponse, MemoryEntryResponse, MemoryBackfillResponse, MemoryPurgeResponse, MemoryReembedResponse, MemoryScopeIDsResponse, MemoryScopesResponse, MemorySearchInput, MemorySearchResponse, PauseResult, PersistentVolumesResponse, EphemeralVolumesResponse, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, ReplaySessionResult, CancelTurnResult, ReviewRunResult, RunBatchOptions, RunBatchResult, RunOptions, ConfiguredRun, ConfiguredRunPatch, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, ListTeamsResponse, PromotedTeam, RetiredTeam, TeamBreakpoints, TeamDefDetail, TeamRunDetached, TeamRunTarget, TeamVerification, TeamVersionList, TeamDiagram, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, TranscriptResponse, WhoamiResponse, UsageDimension, UsageReportResponse, TokenLimit, TokenLimitsResponse, ConfigResponse, SetTokenLimitRequest } from "./types.js";
29
29
  export declare class LoomcycleClient {
30
30
  private ctx;
31
31
  constructor(opts?: ClientOptions);
@@ -120,6 +120,47 @@ export declare class LoomcycleClient {
120
120
  getRunConfig(runId: string, opts?: {
121
121
  signal?: AbortSignal;
122
122
  }): Promise<RunConfigResponse>;
123
+ /** Read the prompt a run's first model call received (RFC DI). Mirrors
124
+ * `GET /v1/runs/{run_id}/prompt`. Recorded when the model was called, not
125
+ * re-derived now, so it is what the model saw even if a document or memory
126
+ * it quoted has changed since.
127
+ *
128
+ * Raises {@link NotFoundError} (404) for an unknown run and for another
129
+ * tenant's run alike, and also — with code `no_prompt_snapshot` — for a run
130
+ * that never reached a model call or predates prompt snapshots. */
131
+ /** Create a run WITHOUT starting it (RFC DI): a configured run holds its
132
+ * request, runs nothing and takes no slot until
133
+ * {@link LoomcycleClient.startConfiguredRun}. It is validated now exactly as
134
+ * a run would be; admission and the budget check happen at start. It never
135
+ * stores a secret — pass `userBearer` / `userCredentials` to the start. */
136
+ createConfiguredRun(opts: Omit<RunOptions, "userBearer" | "userCredentials" | "sessionId" | "debug">): Promise<ConfiguredRun>;
137
+ /** Replace fields of a configured run's request. Set fields replace the
138
+ * draft's; `remove` names wire fields (snake_case, e.g. `"sampling"`) to
139
+ * drop. The agent, the identity and secrets cannot be changed. Refused
140
+ * (409) once the run has started. */
141
+ updateConfiguredRun(runId: string, patch: ConfiguredRunPatch, opts?: {
142
+ remove?: string[];
143
+ signal?: AbortSignal;
144
+ }): Promise<ConfiguredRun>;
145
+ /** Start a configured run and stream it, exactly as
146
+ * {@link LoomcycleClient.runStreaming} streams a new one. Admission happens
147
+ * here: a refusal (429 / 503) throws before any event and leaves the run
148
+ * configured, to be started again later. Secrets the draft never stored
149
+ * are passed here. */
150
+ startConfiguredRun(runId: string, opts?: {
151
+ userBearer?: string;
152
+ userCredentials?: Record<string, string>;
153
+ signal?: AbortSignal;
154
+ debug?: boolean;
155
+ }): AsyncIterable<AgentEvent>;
156
+ /** Discard a configured run and its session. A live run is not discarded —
157
+ * cancel it instead. */
158
+ deleteConfiguredRun(runId: string, opts?: {
159
+ signal?: AbortSignal;
160
+ }): Promise<void>;
161
+ getRunPrompt(runId: string, opts?: {
162
+ signal?: AbortSignal;
163
+ }): Promise<RunPromptResponse>;
123
164
  /** Read what a run will ACTUALLY use, field by field, with the layer that
124
165
  * decided each. Mirrors `GET /v1/runs/{run_id}/effective-config`.
125
166
  *
@@ -283,6 +324,11 @@ export declare class LoomcycleClient {
283
324
  * NOT whole-run cancel ({@link LoomcycleClient.cancelAgent}), which terminates
284
325
  * the run. Returns `{ run_id, stopped, parked }`.
285
326
  *
327
+ * A team walk's run (the `run_id` a detached `runTeam` returns) has no turns,
328
+ * so this ENDS the walk and the runs it spawned: `{ stopped: true, parked:
329
+ * false }`, recorded as cancelled. Walks are reachable on the replica running
330
+ * them only.
331
+ *
286
332
  * Rejects with RunBusyError (409) when the run isn't mid-turn or isn't
287
333
  * interactive, and AgentNotFoundError (404) for an unknown / cross-tenant run.
288
334
  * Mirrors POST /v1/runs/{run_id}/cancel. (RFC BH)
@@ -291,6 +337,24 @@ export declare class LoomcycleClient {
291
337
  reason?: string;
292
338
  signal?: AbortSignal;
293
339
  }): Promise<CancelTurnResult>;
340
+ /**
341
+ * Deliver a verdict on a run held for review (one started or retuned with
342
+ * `review: true`, whose stream has emitted `awaiting_review`).
343
+ *
344
+ * - `approve` — the run completes on the answer it was held on.
345
+ * - `reject` with `feedback` — the feedback becomes the run's next user turn;
346
+ * it revises and is held again.
347
+ * - `reject` without feedback — the run ends with status `rejected`.
348
+ *
349
+ * Rejects with a LoomcycleError of status 409 (body code `not_held`) when
350
+ * the run is live but not held, NotFoundError (404) for an unknown, finished
351
+ * or cross-tenant run, and InvalidArgumentError (400) for feedback on an
352
+ * approval. Mirrors POST /v1/runs/{run_id}/review.
353
+ */
354
+ reviewRun(runId: string, decision: "approve" | "reject", opts?: {
355
+ feedback?: string;
356
+ signal?: AbortSignal;
357
+ }): Promise<ReviewRunResult>;
294
358
  /** Read one agent's status + usage stats. Raises AgentNotFoundError
295
359
  * when the agent_id is unknown. */
296
360
  getAgent(agentId: string, opts?: {
package/dist/client.js CHANGED
@@ -135,8 +135,15 @@ function runBody(opts) {
135
135
  body.metadata = opts.metadata;
136
136
  if (opts.runTimeoutSeconds !== undefined)
137
137
  body.run_timeout_seconds = opts.runTimeoutSeconds;
138
+ if (opts.reviewTtlSeconds !== undefined)
139
+ body.review_ttl_seconds = opts.reviewTtlSeconds;
138
140
  if (opts.sampling !== undefined)
139
141
  body.sampling = samplingToWire(opts.sampling);
142
+ // Same keys on the wire as in the option (mode / name / until).
143
+ if (opts.toolChoice !== undefined)
144
+ body.tool_choice = opts.toolChoice;
145
+ if (opts.outputFormat !== undefined)
146
+ body.output_format = opts.outputFormat;
140
147
  if (opts.compaction !== undefined)
141
148
  body.compaction = compactionToWire(opts.compaction);
142
149
  if (opts.context !== undefined)
@@ -190,6 +197,8 @@ function applyOverridesToWire(body, opts) {
190
197
  body.interactive = opts.interactive;
191
198
  if (opts.interruption !== undefined)
192
199
  body.interruption = opts.interruption;
200
+ if (opts.review !== undefined)
201
+ body.review = opts.review;
193
202
  }
194
203
  export class LoomcycleClient {
195
204
  ctx;
@@ -267,8 +276,14 @@ export class LoomcycleClient {
267
276
  body.metadata = opts.metadata;
268
277
  if (opts.runTimeoutSeconds !== undefined)
269
278
  body.run_timeout_seconds = opts.runTimeoutSeconds;
279
+ if (opts.reviewTtlSeconds !== undefined)
280
+ body.review_ttl_seconds = opts.reviewTtlSeconds;
270
281
  if (opts.sampling !== undefined)
271
282
  body.sampling = samplingToWire(opts.sampling);
283
+ if (opts.toolChoice !== undefined)
284
+ body.tool_choice = opts.toolChoice;
285
+ if (opts.outputFormat !== undefined)
286
+ body.output_format = opts.outputFormat;
272
287
  if (opts.compaction !== undefined)
273
288
  body.compaction = compactionToWire(opts.compaction);
274
289
  if (opts.context !== undefined)
@@ -339,6 +354,58 @@ export class LoomcycleClient {
339
354
  async getRunConfig(runId, opts) {
340
355
  return jsonFetch(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/config`, opts);
341
356
  }
357
+ /** Read the prompt a run's first model call received (RFC DI). Mirrors
358
+ * `GET /v1/runs/{run_id}/prompt`. Recorded when the model was called, not
359
+ * re-derived now, so it is what the model saw even if a document or memory
360
+ * it quoted has changed since.
361
+ *
362
+ * Raises {@link NotFoundError} (404) for an unknown run and for another
363
+ * tenant's run alike, and also — with code `no_prompt_snapshot` — for a run
364
+ * that never reached a model call or predates prompt snapshots. */
365
+ /** Create a run WITHOUT starting it (RFC DI): a configured run holds its
366
+ * request, runs nothing and takes no slot until
367
+ * {@link LoomcycleClient.startConfiguredRun}. It is validated now exactly as
368
+ * a run would be; admission and the budget check happen at start. It never
369
+ * stores a secret — pass `userBearer` / `userCredentials` to the start. */
370
+ async createConfiguredRun(opts) {
371
+ const body = runBody(opts);
372
+ body.start = false;
373
+ return postJSON(this.ctx, "/v1/runs", body, { signal: opts.signal });
374
+ }
375
+ /** Replace fields of a configured run's request. Set fields replace the
376
+ * draft's; `remove` names wire fields (snake_case, e.g. `"sampling"`) to
377
+ * drop. The agent, the identity and secrets cannot be changed. Refused
378
+ * (409) once the run has started. */
379
+ async updateConfiguredRun(runId, patch, opts) {
380
+ // runBody serializes only the fields that are set, so a partial patch
381
+ // stays partial on the wire.
382
+ const body = runBody(patch);
383
+ delete body.agent;
384
+ for (const k of opts?.remove ?? [])
385
+ body[k] = null;
386
+ return patchJSON(this.ctx, `/v1/runs/${encodeURIComponent(runId)}`, body, { signal: opts?.signal });
387
+ }
388
+ /** Start a configured run and stream it, exactly as
389
+ * {@link LoomcycleClient.runStreaming} streams a new one. Admission happens
390
+ * here: a refusal (429 / 503) throws before any event and leaves the run
391
+ * configured, to be started again later. Secrets the draft never stored
392
+ * are passed here. */
393
+ async *startConfiguredRun(runId, opts) {
394
+ const body = {};
395
+ if (opts?.userBearer !== undefined)
396
+ body.user_bearer = opts.userBearer;
397
+ if (opts?.userCredentials !== undefined)
398
+ body.user_credentials = opts.userCredentials;
399
+ yield* this.streamSSE(`/v1/runs/${encodeURIComponent(runId)}/start`, body, opts?.signal, opts?.debug);
400
+ }
401
+ /** Discard a configured run and its session. A live run is not discarded —
402
+ * cancel it instead. */
403
+ async deleteConfiguredRun(runId, opts) {
404
+ await deleteRequest(this.ctx, `/v1/runs/${encodeURIComponent(runId)}`, opts);
405
+ }
406
+ async getRunPrompt(runId, opts) {
407
+ return jsonFetch(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/prompt`, opts);
408
+ }
342
409
  /** Read what a run will ACTUALLY use, field by field, with the layer that
343
410
  * decided each. Mirrors `GET /v1/runs/{run_id}/effective-config`.
344
411
  *
@@ -536,6 +603,11 @@ export class LoomcycleClient {
536
603
  * NOT whole-run cancel ({@link LoomcycleClient.cancelAgent}), which terminates
537
604
  * the run. Returns `{ run_id, stopped, parked }`.
538
605
  *
606
+ * A team walk's run (the `run_id` a detached `runTeam` returns) has no turns,
607
+ * so this ENDS the walk and the runs it spawned: `{ stopped: true, parked:
608
+ * false }`, recorded as cancelled. Walks are reachable on the replica running
609
+ * them only.
610
+ *
539
611
  * Rejects with RunBusyError (409) when the run isn't mid-turn or isn't
540
612
  * interactive, and AgentNotFoundError (404) for an unknown / cross-tenant run.
541
613
  * Mirrors POST /v1/runs/{run_id}/cancel. (RFC BH)
@@ -546,6 +618,26 @@ export class LoomcycleClient {
546
618
  body.reason = opts.reason;
547
619
  return postJSON(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/cancel`, body, opts);
548
620
  }
621
+ /**
622
+ * Deliver a verdict on a run held for review (one started or retuned with
623
+ * `review: true`, whose stream has emitted `awaiting_review`).
624
+ *
625
+ * - `approve` — the run completes on the answer it was held on.
626
+ * - `reject` with `feedback` — the feedback becomes the run's next user turn;
627
+ * it revises and is held again.
628
+ * - `reject` without feedback — the run ends with status `rejected`.
629
+ *
630
+ * Rejects with a LoomcycleError of status 409 (body code `not_held`) when
631
+ * the run is live but not held, NotFoundError (404) for an unknown, finished
632
+ * or cross-tenant run, and InvalidArgumentError (400) for feedback on an
633
+ * approval. Mirrors POST /v1/runs/{run_id}/review.
634
+ */
635
+ async reviewRun(runId, decision, opts) {
636
+ const body = { decision };
637
+ if (opts?.feedback !== undefined)
638
+ body.feedback = opts.feedback;
639
+ return postJSON(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/review`, body, opts);
640
+ }
549
641
  // ---- Agent metadata ----
550
642
  /** Read one agent's status + usage stats. Raises AgentNotFoundError
551
643
  * when the agent_id is unknown. */
package/dist/index.d.ts CHANGED
@@ -128,5 +128,5 @@ export { InteractiveSession } from "./interactive.js";
128
128
  export type { InteractiveSessionOps } from "./interactive.js";
129
129
  export { ClientToolHost, clientToolsURL, CLIENT_TOOL_SUBPROTOCOL } from "./client-tools.js";
130
130
  export type { ClientToolSchema, ClientToolInvocation, ConnectClientToolsOptions, WebSocketLike, WebSocketCtor, } from "./client-tools.js";
131
- export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, SamplingOptions, CompactionOptions, ContextOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, CancelAgentResult, ListAgentsResponse, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, DirectoryBudget, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, CancelTurnResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, UserTokenMeta, ListUserTokensResponse, RunnableAgent, RunnableAgentsResponse, WhoamiResponse, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, MemorySearchInput, MemorySource, MemoryWhen, MemoryTimeFilter, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, MemoryBackfillResponse, MemoryPurgeResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, Hook, HookFailMode, HookPhase, HookToolCall, HookToolResult, ListHooksResponse, PostHookCall, PostHookResult, PreHookCall, PreHookResult, RegisterHookOptions, RegisterHookResponse, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, PromotedTeam, RetiredTeam, TeamDefDetail, TeamVerification, TeamVersion, TeamVersionList, TeamBreakpoints, TeamRunDetached, TeamRunResult, TeamRunTarget, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, VolumeMode, PersistentVolumeEntry, PersistentVolumesResponse, EphemeralVolumeEntry, EphemeralVolumesResponse, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelReleaseResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAwaitEntry, ChannelAwaitMode, ChannelAwaitResult, ChannelBroadcastEntry, ChannelBroadcastResult, CreateChannelOptions, ReleaseChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, EnsureMcpServerOptions, EnsureMcpServerResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, AgentDefOverlay, EnsureCodeAgentOptions, EnsureCodeAgentResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, CapabilityInertInfo, LimitInfo, EffectiveConfigResponse, EffectiveConfigSource, EffectiveValue, RetuneRunResponse, RunConfigRecord, RunConfigResponse, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, CredentialScope, CredentialMeta, CredentialListResponse, } from "./types.js";
131
+ export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, SamplingOptions, CompactionOptions, ContextOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, RunResult, RunSpec, ConfiguredRun, ConfiguredRunPatch, ToolChoiceOptions, OutputFormatOptions, CancelAgentResult, ListAgentsResponse, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, DirectoryBudget, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, CancelTurnResult, ReviewRunResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, UserTokenMeta, ListUserTokensResponse, RunnableAgent, RunnableAgentsResponse, WhoamiResponse, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, MemorySearchInput, MemorySource, MemoryWhen, MemoryTimeFilter, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, MemoryBackfillResponse, MemoryPurgeResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, Hook, HookFailMode, HookPhase, HookToolCall, HookToolResult, ListHooksResponse, PostHookCall, PostHookResult, PreHookCall, PreHookResult, RegisterHookOptions, RegisterHookResponse, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, PromotedTeam, RetiredTeam, TeamDefDetail, TeamVerification, TeamVersion, TeamVersionList, TeamBreakpoints, TeamRunDetached, TeamRunResult, TeamRunTarget, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, VolumeMode, PersistentVolumeEntry, PersistentVolumesResponse, EphemeralVolumeEntry, EphemeralVolumesResponse, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelReleaseResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAwaitEntry, ChannelAwaitMode, ChannelAwaitResult, ChannelBroadcastEntry, ChannelBroadcastResult, CreateChannelOptions, ReleaseChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, EnsureMcpServerOptions, EnsureMcpServerResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, AgentDefOverlay, EnsureCodeAgentOptions, EnsureCodeAgentResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, CapabilityInertInfo, LimitInfo, EffectiveConfigResponse, EffectiveConfigSource, EffectiveValue, RetuneRunResponse, RunConfigRecord, RunConfigResponse, RunPromptResponse, RunPromptSnapshot, PromptBlock, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, CredentialScope, CredentialMeta, CredentialListResponse, } from "./types.js";
132
132
  export { AgentIDInUseError, AgentNotFoundError, AlreadyPausingError, AuthError, BackpressureError, HookNotFoundError, NotFoundError, InvalidArgumentError, ChannelCursorRegressionError, LoomcycleError, NotPausedError, PauseNotConfiguredError, PerUserQuotaExhaustedError, SessionBusyError, SessionNotFoundError, SnapshotNotFoundError, SnapshotTooLargeError, SnapshotVersionError, SubstrateToolRefusedError, UnavailableError, } from "./errors.js";
package/dist/types.d.ts CHANGED
@@ -7,7 +7,7 @@
7
7
  * `client.ts` for the input shapes (RunOptions, CreateSnapshotOptions,
8
8
  * etc.) — those are translated to snake_case in the request body.
9
9
  */
10
- export type EventType = "started" | "text" | "tool_call" | "tool_result" | "usage" | "done" | "error" | "retry" | "host_widened" | "session" | "agent" | "awaiting_input" | "steer" | "context_compaction" | "capability_inert" | "limit" | "override" | "context_recap" | "context_state" | "context_distill_declined" | "context_exhausted" | "thinking" | "turn_cancelled" | "provider_fallback" | "fallback_suppressed" | "model_downgraded" | "cache_invalidated" | "reasoning_invalidated" | "channel_publish" | "channel_delivery" | "interruption_pending" | "spawn_child_started" | "spawn_child_result" | "_meta";
10
+ export type EventType = "started" | "text" | "tool_call" | "tool_result" | "usage" | "done" | "error" | "retry" | "host_widened" | "session" | "agent" | "awaiting_input" | "awaiting_review" | "steer" | "context_compaction" | "capability_inert" | "limit" | "override" | "context_recap" | "context_state" | "context_distill_declined" | "context_exhausted" | "thinking" | "turn_cancelled" | "provider_fallback" | "fallback_suppressed" | "model_downgraded" | "cache_invalidated" | "reasoning_invalidated" | "channel_publish" | "channel_delivery" | "interruption_pending" | "spawn_child_started" | "spawn_child_result" | "prompt_snapshot" | "_meta";
11
11
  export interface ToolUse {
12
12
  id: string;
13
13
  name: string;
@@ -74,6 +74,7 @@ export interface RunConfigRecord {
74
74
  context?: Record<string, unknown>;
75
75
  max_context_tokens?: number;
76
76
  run_timeout_seconds?: number;
77
+ review_ttl_seconds?: number;
77
78
  routing?: {
78
79
  provider?: string;
79
80
  model?: string;
@@ -93,6 +94,7 @@ export interface RunConfigRecord {
93
94
  inject_tool_guide?: boolean;
94
95
  };
95
96
  interactive?: boolean;
97
+ review?: boolean;
96
98
  interruption?: {
97
99
  enabled?: boolean;
98
100
  kinds?: string[];
@@ -129,6 +131,28 @@ export interface RunConfigResponse {
129
131
  model: string;
130
132
  config: RunConfigRecord;
131
133
  }
134
+ /** Payload on a `prompt_snapshot` transcript event (RFC DI): the system blocks
135
+ * and the run's input its first model call received. */
136
+ export interface RunPromptSnapshot {
137
+ system: PromptBlock[];
138
+ input: PromptBlock[];
139
+ }
140
+ /** One block of a {@link RunPromptResponse}. `text` blocks carry the prompt
141
+ * text; an `image` block keeps its `media_type` but not its bytes. */
142
+ export interface PromptBlock {
143
+ type: string;
144
+ text?: string;
145
+ media_type?: string;
146
+ }
147
+ /** The reply from `GET /v1/runs/{run_id}/prompt` (RFC DI) — what the run's first
148
+ * model call was sent, as assembled: skills, memory injection, `{{...}}`
149
+ * expansion and metadata already applied. `input` is this run's own input
150
+ * (for a continuation, the new message rather than the whole history). */
151
+ export interface RunPromptResponse {
152
+ run_id: string;
153
+ system: PromptBlock[];
154
+ input: PromptBlock[];
155
+ }
132
156
  /** The reply from `GET /v1/runs/{run_id}/effective-config` — for every
133
157
  * overridable field, the value this run will actually use and which layer
134
158
  * decided it.
@@ -427,6 +451,13 @@ export interface AgentEvent {
427
451
  awaiting_input?: {
428
452
  since_turn?: number;
429
453
  };
454
+ /** Payload on `event: awaiting_review` — the run is held for a verdict.
455
+ * `round` is 1 on the first answer and counts up with each revision. */
456
+ awaiting_review?: {
457
+ since_turn?: number;
458
+ round?: number;
459
+ expires_at?: string;
460
+ };
430
461
  /** Payload on `event: steer` (RFC AI) — the operator's drained turn. On a
431
462
  * re-attach replay, `source` is `"replay"`. Nil on all other event types. */
432
463
  user_input?: {
@@ -476,6 +507,8 @@ export interface AgentEvent {
476
507
  turn_cancelled?: TurnCancelledInfo;
477
508
  /** Payload on `spawn_child_started` / `spawn_child_result`. */
478
509
  spawn_child?: SpawnChildInfo;
510
+ /** Payload on `prompt_snapshot` (transcript only). */
511
+ prompt_snapshot?: RunPromptSnapshot;
479
512
  /** The assistant turn's accumulated reasoning trace, on `done`. Empty for
480
513
  * non-thinking models. */
481
514
  reasoning?: string;
@@ -562,6 +595,12 @@ export interface RunOverrideOptions {
562
595
  * `false` releases a run that was started interactive. Omit to keep whatever
563
596
  * the run has; a retune of anything else must not disturb this. */
564
597
  interactive?: boolean;
598
+ /** Hold the run for an operator's verdict each time its model finishes,
599
+ * instead of completing: {@link LoomcycleClient.reviewRun} approves it, or
600
+ * rejects it with feedback it revises from (and is held again), or rejects
601
+ * it outright (status `rejected`). Settable while the run is going; `false`
602
+ * on a run that is held releases it as approved. */
603
+ review?: boolean;
565
604
  /** Let this run's agent ASK a human a question, overriding what its
566
605
  * definition allows.
567
606
  *
@@ -651,10 +690,21 @@ export interface RunOptions extends RunOverrideOptions {
651
690
  * its budget spans that wait, so the CPU-oriented default is often too low.
652
691
  * Ignored by LLM agents. 0 / omitted = inherit. */
653
692
  runTimeoutSeconds?: number;
693
+ /** With `review`: end a held answer that gets no verdict within this many
694
+ * seconds as rejected (stop reason `review_expired`). Each hold gets the
695
+ * full window; omit for no deadline. Set at start only. */
696
+ reviewTtlSeconds?: number;
654
697
  /** Per-run LLM sampling override (v0.28.0), merged PER FIELD over the
655
698
  * agent's own sampling (this wins; unset fields inherit). Omitted =
656
699
  * inherit entirely. */
657
700
  sampling?: SamplingOptions;
701
+ /** Per-run tool choice (RFC DI): whether and which tool the model must
702
+ * call, and for how many calls. REPLACES the agent's own whole. */
703
+ toolChoice?: ToolChoiceOptions;
704
+ /** Per-run answer schema (RFC DI): the final answer is held to it where
705
+ * the model supports it, and returned parsed as `result.structured`.
706
+ * REPLACES the agent's own whole. */
707
+ outputFormat?: OutputFormatOptions;
658
708
  /** Per-run context-compaction override (v0.32.0), merged PER FIELD over
659
709
  * the agent's own compaction block (this wins; unset fields inherit).
660
710
  * Omitted = inherit entirely. Trigger compaction mid-run with
@@ -690,6 +740,34 @@ export interface RunOptions extends RunOverrideOptions {
690
740
  debug?: boolean;
691
741
  signal?: AbortSignal;
692
742
  }
743
+ /** The JSON schema a run's final answer must follow (RFC DI) — structured
744
+ * output. Same shape per-agent (AgentDef `output_format`) and per-run; a
745
+ * per-run value REPLACES the agent's whole. The parsed answer is
746
+ * `result.structured`. A model that cannot enforce it runs anyway, with a
747
+ * `capability_inert` event naming what was not enforced. */
748
+ export interface OutputFormatOptions {
749
+ /** The only kind, and the default when omitted. */
750
+ type?: "json_schema";
751
+ /** Label where a provider needs one (OpenAI does). Default "output". */
752
+ name?: string;
753
+ /** A JSON Schema whose root is `type: "object"`. */
754
+ schema: Record<string, unknown>;
755
+ }
756
+ /** Whether and which tool the model must call, and for how many calls
757
+ * (RFC DI). Same shape per-agent (AgentDef `tool_choice`) and per-run; a
758
+ * per-run value REPLACES the agent's whole. A model that cannot enforce it
759
+ * runs anyway, with a `capability_inert` event naming what was not enforced. */
760
+ export interface ToolChoiceOptions {
761
+ /** `auto` (provider default), `none` (no tool calls), `required` (some
762
+ * tool), `tool` (the tool named in `name`). */
763
+ mode: "auto" | "none" | "required" | "tool";
764
+ /** The tool to call — required with mode `tool`, refused otherwise. */
765
+ name?: string;
766
+ /** How long it applies: `first_call` (default), `until_called` (until the
767
+ * model makes a call that satisfies it), `always` (refused for `required`
768
+ * and `tool`, which could then never finish). */
769
+ until?: "first_call" | "until_called" | "always";
770
+ }
693
771
  /** Per-run LLM sampling override (v0.28.0). Mirrors config.Sampling — every
694
772
  * field optional; an unset field inherits the agent's value. An explicit
695
773
  * `temperature: 0` is deterministic, NOT "unset". Each provider maps what it
@@ -885,8 +963,19 @@ export interface ContinueOptions extends RunOverrideOptions {
885
963
  /** Optional ad-hoc per-run code-js wall-clock budget (seconds) for the
886
964
  * continuation's new run — see {@link RunOptions.runTimeoutSeconds}. */
887
965
  runTimeoutSeconds?: number;
966
+ /** With `review`: end a held answer that gets no verdict within this many
967
+ * seconds as rejected (stop reason `review_expired`). Each hold gets the
968
+ * full window; omit for no deadline. Set at start only. */
969
+ reviewTtlSeconds?: number;
888
970
  /** Per-continuation LLM sampling override — see {@link RunOptions.sampling}. */
889
971
  sampling?: SamplingOptions;
972
+ /** Per-run tool choice (RFC DI): whether and which tool the model must
973
+ * call, and for how many calls. REPLACES the agent's own whole. */
974
+ toolChoice?: ToolChoiceOptions;
975
+ /** Per-run answer schema (RFC DI): the final answer is held to it where
976
+ * the model supports it, and returned parsed as `result.structured`.
977
+ * REPLACES the agent's own whole. */
978
+ outputFormat?: OutputFormatOptions;
890
979
  /** Per-continuation context-compaction override — see {@link RunOptions.compaction}. */
891
980
  compaction?: CompactionOptions;
892
981
  /** Per-continuation context-distillation override — see
@@ -917,7 +1006,9 @@ export interface ClientOptions {
917
1006
  * own fetch (e.g. node-fetch on older Node). */
918
1007
  fetch?: typeof fetch;
919
1008
  }
920
- export type AgentStatus = "running" | "completed" | "failed" | "cancelled";
1009
+ /** `configured` is a run created but not yet started (RFC DI). */
1010
+ /** `rejected` is a run a reviewer turned down without feedback (RFC DJ). */
1011
+ export type AgentStatus = "configured" | "running" | "completed" | "failed" | "cancelled" | "rejected";
921
1012
  export interface AgentUsage {
922
1013
  input_tokens?: number;
923
1014
  output_tokens?: number;
@@ -946,6 +1037,67 @@ export interface Agent {
946
1037
  * can attribute a child sub-agent's cost to the user-initiated request
947
1038
  * in a single fetch. Omitted when the run carried no context. */
948
1039
  parent_context?: ParentContext;
1040
+ /** The run's answer (RFC DI) — what the row had no field for; `stop_reason`,
1041
+ * `error` and `usage` are above. Present on {@link LoomcycleClient.getAgent}
1042
+ * only (listings omit it), and only once the run has finished with
1043
+ * something to report. */
1044
+ result?: RunResult;
1045
+ /** The run's own configuration (RFC DI): the overrides it ran with, merged
1046
+ * over its definition. {@link LoomcycleClient.getAgent} only, like
1047
+ * `result`; absent when the run overrode nothing. */
1048
+ spec?: RunSpec;
1049
+ /** A CONFIGURED run's request as it will start (RFC DI) — what
1050
+ * {@link LoomcycleClient.updateConfiguredRun} edits. Snake_case wire keys;
1051
+ * present only while the run is configured, and never holds a secret. */
1052
+ draft?: Record<string, unknown>;
1053
+ }
1054
+ /** A run created without being started (RFC DI). */
1055
+ export interface ConfiguredRun {
1056
+ run_id: string;
1057
+ agent_id?: string;
1058
+ session_id?: string;
1059
+ status: "configured";
1060
+ /** The stored request, snake_case wire keys. */
1061
+ draft: Record<string, unknown>;
1062
+ }
1063
+ /** The fields {@link LoomcycleClient.updateConfiguredRun} may replace: a run's
1064
+ * options minus its agent, identity, secrets and transport knobs. */
1065
+ export type ConfiguredRunPatch = Partial<Omit<RunOptions, "agent" | "sessionId" | "tenantId" | "userId" | "agentId" | "userBearer" | "userCredentials" | "signal" | "debug">>;
1066
+ /** A run's own configuration record (RFC DI), as persisted — the values it
1067
+ * ran with after its per-run overrides were merged over its definition.
1068
+ * Keys and nested values are the server's snake_case wire names (not the
1069
+ * camelCase request options), so nested blocks are left untyped. */
1070
+ export interface RunSpec {
1071
+ sampling?: Record<string, unknown>;
1072
+ tool_choice?: ToolChoiceOptions;
1073
+ output_format?: OutputFormatOptions;
1074
+ compaction?: Record<string, unknown>;
1075
+ context?: Record<string, unknown>;
1076
+ max_context_tokens?: number;
1077
+ run_timeout_seconds?: number;
1078
+ review_ttl_seconds?: number;
1079
+ /** Which model serves the run: model / provider / tier / effort. */
1080
+ routing?: Record<string, unknown>;
1081
+ /** The run's budget: max_tokens / max_iterations / … */
1082
+ resources?: Record<string, unknown>;
1083
+ tuning?: Record<string, unknown>;
1084
+ /** Whether the run parks at its turn boundaries (current, after any retune). */
1085
+ interactive?: boolean;
1086
+ /** Whether the run is held for review when it finishes (current, after any retune). */
1087
+ review?: boolean;
1088
+ interruption?: Record<string, unknown>;
1089
+ /** The caller's host narrowing. */
1090
+ hosts?: Record<string, unknown>;
1091
+ }
1092
+ /** A finished run's answer (RFC DI). */
1093
+ export interface RunResult {
1094
+ /** The text of the run's last assistant turn. */
1095
+ final_text?: string;
1096
+ /** The final structured state of a stateful run. */
1097
+ state?: Record<string, unknown>;
1098
+ /** The final answer parsed against the run's `outputFormat`; absent when
1099
+ * the run had none or the answer was not a JSON object. */
1100
+ structured?: Record<string, unknown>;
949
1101
  }
950
1102
  export interface ListAgentsResponse {
951
1103
  agents: Agent[];
@@ -1113,7 +1265,14 @@ export interface ReplaySessionResult {
1113
1265
  /** Result of {@link LoomcycleClient.cancelTurn} (RFC BH) — the current turn was
1114
1266
  * stopped and the interactive run parked at awaiting_input (session +
1115
1267
  * transcript intact). This is NOT whole-run cancel ({@link
1116
- * LoomcycleClient.cancelAgent}). */
1268
+ * LoomcycleClient.cancelAgent}). For a team walk `parked` is false: the walk
1269
+ * was ended, not parked. */
1270
+ /** Result of {@link LoomcycleClient.reviewRun}. */
1271
+ export interface ReviewRunResult {
1272
+ run_id: string;
1273
+ decision: "approve" | "reject";
1274
+ delivered: boolean;
1275
+ }
1117
1276
  export interface CancelTurnResult {
1118
1277
  run_id: string;
1119
1278
  stopped: boolean;
@@ -2672,6 +2831,10 @@ export interface AgentDefOverlay {
2672
2831
  code_body?: string;
2673
2832
  tier?: string;
2674
2833
  effort?: string;
2834
+ /** Whether and which tool the model must call (RFC DI). */
2835
+ tool_choice?: ToolChoiceOptions;
2836
+ /** The JSON schema the answer must follow (RFC DI). */
2837
+ output_format?: OutputFormatOptions;
2675
2838
  max_tokens?: number;
2676
2839
  max_iterations?: number;
2677
2840
  max_concurrent_children?: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@loomcycle/client",
3
- "version": "1.91.0",
3
+ "version": "1.93.0",
4
4
  "description": "TypeScript client for the loomcycle sidecar (HTTP+SSE). 71 methods covering run streaming, agent metadata, pause/resume/state, resolver re-probe (resolveProbe — issue #88 operator escape hatch), operator-token admin (operatorTokenDef — RFC L OSS multi-tenant auth) + whoami (RFC L authoritative principal, v0.17.0) + tenant-scoped listUsers / listUserAgents, dynamic MCP registration (mcpServerDef + v0.18.0 typed mcpServerDefVerify + ensureMcpServer idempotent register-if-changed), snapshot lifecycle, memory admin (incl. v0.9.0 Vector Memory embed_stats + reembed AND v0.11.5 setMemoryEntry + deleteMemoryEntry), interruption resolve, hook management, v0.8.22 substrate admin (agentDef + skillDef), v0.9.x n8n Phase 0 (listChannels + streamUserRunStates), v0.9.x Channel CRUD (publishChannel + subscribeChannel + peekChannel + ackChannel), v0.11.5 Channel admin CRUD (createChannel + updateChannel + deleteChannel — runtime substrate; yaml channels refuse mutation with HTTP 409), v0.9.x content_sha256 verify, v0.9.1 transcript first-cycle, v0.9.x dynamic MCP server registration (mcpServerDef + MCPServerDefVerifyResult), v0.10.3 Library v2 enumeration (listLibraryAgents + listLibrarySkills + listLibraryMcpServers), and v0.11.0 LLM Gateway (llmChat + llmStream — direct provider routing without agent overhead; primary target is n8n's LoomCycleChatModel AI Agent sub-node and any LangChain-compatible consumer). v0.10.1 — dual ESM + CommonJS distribution (additive — ESM consumers unchanged; CJS consumers like n8n's community-node loader now work). v0.19.0 — typed inline code-js agent ingestion (AgentDefOverlay.code_body + ensureCodeAgent — register a deterministic code agent through the substrate with no host filesystem bind; RFC J). v0.20.0 — ensureMcpServer surfaces discoveredToolCount straight from create (loomcycle now auto-discovers MCP tools at ingestion); rediscover is now an explicit force-refresh. v0.21.0 — run/continue accept optional non-secret `metadata` (repo name, review policy, …) passed to the agent, symmetric with the WebHook/Schedule trigger paths. v0.22.0 — version-aligned lockstep release; no client-surface change (RFC N tenant isolation of the agent/skill/MCP/Schedule/Webhook definition plane + real op-schemas on the builtin MCP meta-tools are both server-side). v0.23.0 — version-aligned lockstep release; no client-surface change (RFCs O/P/R MCP-server hardening + thin client and the RFC Q DeepSeek tool-content fix are all server-side / MCP-transport-side). v0.24.0 — purgeChannel clears a channel's buffered messages without deleting its definition (allowed on yaml-declared channels too, unlike deleteChannel — F20); AgentDefOverlay gains channels / evaluation_scopes / interruption so a COMPLETE interactive/multi-agent agent round-trips over the substrate (F14). (Consolidates the interim 0.24/0.25 package bumps, which were never tag-published, back into lockstep with the loomcycle v0.24.0 tag.) v0.25.0 — adds the RFC S channel fan-in/fan-out client twins: awaitChannels() (wait for any/all/at_least N messages across channels, or a timeout — non-committing) + broadcastChannels() (publish one payload to N channels in one atomic-pre-flight call), the client-facing counterparts of the in-band Channel.await / Channel.broadcast tool ops (the rest of v0.25.0 — the manual-management Web UI console + Context op=time + max_fires self-retiring schedules — is server-side / in-band, no client-surface change). v0.29.1 — Usage gains optional `max_context_tokens` (the serving model's context-window ceiling, stamped by the loop from Provider.Capabilities() on each usage event) so a consumer can render a 'context used / max' gauge without a hard-coded per-model table; additive + optional, no behavior change. (Lockstep catch-up: the field landed in loomcycle v0.29.0 but the adapter publish skipped on a version mismatch; v0.29.1 realigns the package version with the release tag so it publishes.) v0.33.0 — gRPC + TS client parity for the RFC Y external fan-out and the compaction surface: spawnRunBatch() (POST /v1/runs:batch — spawn up to 32 fresh runs concurrently in one call, combined index-aligned envelope, per-child failures in-envelope) + compactRun(runId) (POST /v1/runs/{run_id}/compact — summarize a parked run's context); plus per-run sampling + compaction overrides now accepted on runStreaming / continueSession (an explicit temperature 0 is preserved as deterministic, not dropped as falsy). (The gRPC half adds the matching SpawnRunBatch / CompactRun RPCs + the sampling/compaction fields on RunRequest/ContinueRequest — server-side.) v0.34.0 — version-aligned lockstep release; no client-surface change (context-transform plugins / RFC Z Phase 1a are server-side config; the exp7 hardening pass is server-side; the R2 cross-provider thinking-model downgrade surfaces a new `model_downgraded` SSE event the generic stream passes through unchanged). v0.35.0 — RFC AH dynamic filesystem volumes: volumeDef() (POST /v1/_volumedef — op-discriminated create/get/list/delete/purge; a Volume is flat, so delete unmaps + purge RemoveAll's, no retire/promote/fork) + listVolumes() / listEphemeralVolumes() (GET /v1/_volumes[/ephemeral] — tenant-scoped; host paths redacted for non-operator callers). Tenant-confined; the runtime derives the path inside an operator-blessed dynamic_root, so callers pass name + mode, never a host path. v1.1.1 — RFC AI interactive agentic sessions: an `interactive: true` flag on runStreaming/continueSession (a run that parks at end_turn for steering) + sendRunInput(runId, text) (POST /v1/runs/{id}/input — steer a live run) + streamRunByID(runId, {fromSeq}) (GET /v1/runs/{id}/stream — re-attach by run_id; the operator's prior turns replay as `steer` events so a cold client reconstructs the whole conversation) + a high-level InteractiveSession driver (client.interactiveSession / attachInteractiveSession — events()/send()/cancel(), the adapter port of the Web UI run terminal). The AgentEvent union gains awaiting_input/steer/context_compaction frames. Version-aligned with the loomcycle v1.1.x line so the v1.1.1 tag publishes it (also carrying the previously-unpublished v0.35.0 volume surface). v1.4.0 — RFC AL Path VFS + RFC AK Document on the wire: path(input) (POST /v1/_path — a Unix-like filesystem over Memory/Volumes/Documents; resolve/ls/stat/mkdir/mv/rm) + document(input) (POST /v1/_document — chunked-graph documents; 13 ops, needs SQL Memory on the sidecar). Scope (agent/user/tenant) + tenant are resolved server-side from the authenticated principal, never the wire; an off-run scope:'user' op keys on the principal subject so it interoperates with that user's agent runs. New PathToolInput / DocumentToolInput types; responses are op-varying (unknown — narrow as needed). v1.7.0 — RFC AT image/vision input: the PromptContent union gains an `image` variant ({ type:'image'; media_type: ImageMediaType; data: base64-no-prefix }) accepted in a user segment by runStreaming / continueSession (segments pass through unchanged — no method change). The model must be vision-capable or the run errors before the call. New ImageMediaType type (image/png|jpeg|gif|webp). v1.12.1 — Path/Document browse-by-subject + the full Document op set (RFC AS/AK): path(input, opts) / document(input, opts) accept optional scopeId / tenant browse overrides sent as ?scope_id= / ?tenant= query params (server reads them from the URL, re-checks authorization; omit both to browse your own subject — byte-identical to the pre-RFC-AS request), and DocumentToolInput.op now covers all 16 backend ops (adds set_path, export_md, import_md) with the matching include_metadata / markdown fields. Additive — existing path() / document() callers are unchanged. v1.16.0 — RFC BC client-executed tools (local tool host): connectClientTools({tools,onInvoke}) opens a persistent WebSocket to /v1/client-tools, registers tools this client runs on the user's machine (browser DOM / files / shell), and answers the invoke frames loomcycle routes when an agent of your principal calls a client:<tool> — returning your reply as an ordinary tool result. Returns a ClientToolHost driver (.close() to stop; auto-reconnect); dependency-free (global WebSocket in browsers / Node 22+, or an injected WebSocketImpl like the ws package on older Node); the bearer rides the Sec-WebSocket-Protocol subprotocol (browsers can't set an Authorization header on a WebSocket). The runtime's first WebSocket surface. v1.45.0 — RFC BL P5 subject erasure: erasureReport(subject, {tenant}) (GET /v1/_erasure — what this deployment holds about one subject, in three tiers: deletable with existing primitives, subject-keyed but not deletable, and facts ABOUT the subject in scopes they do not own) + erasureExecute(subject, {dryRun, confirm, tenant}) (POST /v1/_erasure — removes tiers 1 and 2). DEFAULTS TO A DRY RUN: dryRun defaults true and a live run also requires confirm === subject. The tier-3 residue is traceable only through the subject's chats, which a live run deletes, so a report afterwards shows rows: 0 while those facts remain — the returned object is the only durable record of what was not reached; persist it. New ErasureReport / ErasureResult / ErasureTier / ErasureResidue types. v1.47.0 — RFC BV memory-view SDK: memorySearch() (POST /v1/_memory/search — off-run unified semantic search spanning k/v entries AND document-chunk bodies in one ranked list, each hit tagged kind memory|document with chunk_id on document hits) + memoryEmbedStats(scope) + reembedMemory(scope, scopeId, {dryRun,limit}) (the Vector Memory embed-admin reads the memory-view console needs; dry_run defaults true). Fact reads (list_facts + get_chunk's entity block) ride the existing document() passthrough. Additive — existing callers unchanged. v1.61.0 — RFC CJ per-run context-window override: runStreaming / continueSession accept an optional maxContextTokens (integer tokens) that wins over the agent's own max_context_tokens; omitted inherits it (which defers to the provider/driver default). Distinct from a model's output cap; primarily for local inference (Ollama num_ctx). Serialized as the snake_case max_context_tokens field on POST /v1/runs + the continuation body; additive, existing callers unchanged. v1.72.1 — the TeamDef version lifecycle: listTeamVersions(name) (op=list — every version of one team, newest first), promoteTeam(defId) (op=promote — point the active pointer, which is what a run BY NAME executes; forkTeam defaults to promote:false, so authoring and putting in force stay two steps), retireTeam(defId, retired) (op=retire — reversible and version-scoped, unlike deleteTeam) and verifyTeam(name, contentSha256) (op=verify — the drift check for a workflow kept in source control and pushed to several deployments; an absent team answers deployed:false rather than raising). The ops existed on the substrate and over HTTP; a client that could author a team could not put one in force.",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",