@loomcycle/client 1.124.0 → 1.125.0

package/dist/cjs/client.js

@@ -446,6 +446,51 @@ class LoomcycleClient {
     async getEffectiveConfig(runId, opts) {
         return (0, fetch_helpers_js_1.jsonFetch)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/effective-config`, opts);
     }
+    /** Run one File-tool op on a run's inbox from outside the run — the files the
+     *  run's tools returned. Mirrors `POST /v1/runs/{run_id}/file`, the HTTP twin
+     *  of the MCP `file` tool. Ops: stat, ls, extract, import, keep, rm, clear.
+     *  The response is the op's own JSON (narrow as needed).
+     *
+     *  Needs `runs:read`, and works on any run you can read; another tenant's run
+     *  is an opaque {@link NotFoundError}. extract, keep, rm and clear write, so
+     *  they need the run's owner or an admin — a tenant operator counts as one
+     *  for its own tenant's runs; anyone else gets a
+     *  {@link SubstrateToolRefusedError}, as does a refused op. */
+    async runFile(runId, input, opts) {
+        return (0, fetch_helpers_js_1.postJSON)(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/file`, input, opts);
+    }
+    /** Download one file of a run's inbox. Mirrors
+     *  `GET /v1/runs/{run_id}/inbox/{path}` (HEAD with `head: true`). `path` is
+     *  relative to the inbox root (`documents/a.pdf`) or a reference
+     *  (`volume:inbox:documents/a.pdf`).
+     *
+     *  Any reader of the run may download (`runs:read`). `range` is sent as the
+     *  Range header (`bytes=0-1023`). The inbox is deleted when its run ends, so
+     *  a finished run's file — like a missing file, run, or another tenant's run —
+     *  is a {@link NotFoundError}. */
+    async downloadRunInboxFile(runId, path, opts) {
+        const rel = path.replace(/^volume:inbox:/, "");
+        const encoded = rel.split("/").map(encodeURIComponent).join("/");
+        const headers = {};
+        if (this.ctx.authToken)
+            headers.Authorization = `Bearer ${this.ctx.authToken}`;
+        if (opts?.range)
+            headers.Range = opts.range;
+        const resp = await this.ctx.fetchImpl(`${this.ctx.baseUrl}/v1/runs/${encodeURIComponent(runId)}/inbox/${encoded}`, { method: opts?.head ? "HEAD" : "GET", headers, signal: opts?.signal });
+        if (!resp.ok) {
+            await (0, fetch_helpers_js_1.raiseFromResponse)(resp);
+        }
+        const bytes = opts?.head ? new Uint8Array() : new Uint8Array(await resp.arrayBuffer());
+        return {
+            bytes,
+            status: resp.status,
+            contentType: resp.headers.get("Content-Type") ?? "",
+            filename: dispositionFilename(resp.headers.get("Content-Disposition")) ?? rel.split("/").pop() ?? "",
+            sha256: resp.headers.get("X-Loomcycle-SHA256") ?? "",
+            origin: resp.headers.get("X-Loomcycle-Origin") ?? "",
+            headers: resp.headers,
+        };
+    }
     /** Which per-run overrides a run of `name` may set, for this caller — what a
      *  run form needs before it sends anything. Mirrors
      *  `GET /v1/_agentdef/{name}/overridable`.
@@ -799,8 +844,10 @@ class LoomcycleClient {
         return { agents: resp.agents ?? [], next_cursor: resp.next_cursor ?? "" };
     }
     /** Aggregated token-usage + cost report (RFC AV). Group by any of
-     *  tenant/user/provider/model/source over an optional time window; group by
-     *  `source` for the operator-vs-tenant split. Tenant-scoped server-side: a
+     *  tenant/user/provider/model/source/purpose over an optional time window;
+     *  group by `source` for the operator-vs-tenant split, by `purpose` to see
+     *  what OCR and speech-to-text cost (a row's `audio_seconds` is the audio its
+     *  speech-to-text calls transcribed). Tenant-scoped server-side: a
      *  tenant principal sees only its own tenant (the `tenant` focus is
      *  admin-only). Mirrors `GET /v1/_usage`. */
     async usageReport(opts) {
@@ -1275,6 +1322,12 @@ class LoomcycleClient {
             body.document_ids = input.documentIds;
         if (input.excludeDocumentIds !== undefined)
             body.exclude_document_ids = input.excludeDocumentIds;
+        // The second scope's documents: sent only when set, so a one-scope search's
+        // response stays byte-identical (no per-entry `scope`).
+        if (input.documentsScope !== undefined)
+            body.documents_scope = input.documentsScope;
+        if (input.documentsScopeId !== undefined)
+            body.documents_scope_id = input.documentsScopeId;
         return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_memory/search", body, {
             signal: opts?.signal,
         });
@@ -3219,6 +3272,23 @@ class LoomcycleClient {
     }
 }
 exports.LoomcycleClient = LoomcycleClient;
+/** The file name of an RFC 8187 `filename*=UTF-8''…` Content-Disposition, or
+ *  a plain quoted `filename="…"`; undefined when there is neither. */
+function dispositionFilename(header) {
+    if (!header)
+        return undefined;
+    const star = /filename\*=UTF-8''([^;]+)/i.exec(header);
+    if (star) {
+        try {
+            return decodeURIComponent(star[1].trim());
+        }
+        catch {
+            return undefined;
+        }
+    }
+    const plain = /filename="([^"]*)"/i.exec(header);
+    return plain ? plain[1] : undefined;
+}
 /** Lightweight SSE parser tailored to the run-state stream. Each
  *  frame's event name distinguishes the two kinds; data is JSON.
  *  Comment lines (": keepalive") are ignored. */

package/dist/client.d.ts

@@ -25,7 +25,7 @@
  */
 import { InteractiveSession } from "./interactive.js";
 import { ClientToolHost, type ConnectClientToolsOptions } from "./client-tools.js";
-import type { ChangeFeedFrame, StreamChangesOptions, CredentialListResponse, CredentialMeta, CryptoKeyEncoding, CryptoKeyExport, CryptoKeyExternal, CryptoKeyType, CryptoRequest, CryptoResultByOp, DecideRequest, DecideResponse, DecisionModelsResponse, CredentialScope, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResult, Agent, AgentEvent, AgentList, CancelAgentResult, ClientOptions, ContinueOptions, RunOverrideOptions, EffectiveConfigResponse, AgentOverridableResponse, RetuneRunResponse, RunConfigResponse, RunPromptResponse, CreateSnapshotOptions, EnsureCodeAgentOptions, EnsureCodeAgentResult, EnsureHookDefOptions, EnsureHookDefResult, HookDefInput, HookDefOverlay, HookDefRowResponse, CreateDefOptions, ForkDefOptions, HookDefForkOverlay, ScheduleDefInput, ScheduleDefOverlay, ScheduleDefRowResponse, WebhookDefInput, WebhookDefOverlay, WebhookDefRowResponse, EnsureMcpServerOptions, EnsureMcpServerResult, HealthResponse, InterruptListResponse, InterruptStatus, ListUserAgentsOptions, WalkRunsPage, AckChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAckResult, ChannelAwaitResult, ChannelBroadcastResult, ChannelDescriptor, ChannelPeekResult, ListTeamChannelsOptions, PeekTeamChannelOptions, ReleaseTeamChannelOptions, TeamChannelPeekResult, TeamChannelReleaseResult, TeamChannelsResult, 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, RetentionOverride, PersistentVolumesResponse, EphemeralVolumesResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, RunTreeDeletion, ReplaySessionResult, CancelTurnResult, ReviewRunResult, RunBatchOptions, RunBatchResult, RunOptions, ConfiguredRun, ConfiguredRunPatch, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, CreateTeamOptions, DefNamesResponse, ForkTeamOptions, ModelAliasesResponse, OperatorTokenDefNamesResponse, ProviderModelsResponse, RoutingResponse, ScheduleListResponse, SchedulePauseResult, ScheduleRunNowResult, ScheduleStateView, ListTeamsResponse, PromotedTeam, RetiredTeam, TeamBreakpoints, TeamDefDetail, TeamRunDetached, TeamRunTarget, TeamVerification, TeamDraft, TeamDraftVerification, TeamVersionList, TeamDiagram, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, EvaluationSubmitInput, EvaluationGetInput, EvaluationListForRunInput, EvaluationListForDefInput, EvaluationAggregateInput, EvaluationInput, EvaluationSubmitResult, EvaluationRecord, EvaluationListForRunResult, EvaluationListForDefResult, EvaluationAggregate, TranscriptResponse, WhoamiResponse, UsageDimension, UsageReportResponse, TokenLimit, TokenLimitsResponse, ConfigResponse, SetTokenLimitRequest, AclBinding, AclBindingListResponse, AclCatalog, AclDefInput, AclDefListResponse, AclDefNamesResponse, AclDefRow, AclRule, AclValidateResult, AuthzDecision, AuthzEvaluationRequest, AuthzEvaluationsRequest, AuthzEvaluationsResponse, AuthzExplainResponse, AuthzSimulateRequest, AuthzSimulateResponse, CreateAclBindingBody, CreateGroupBody, GroupDetail, GroupEffective, GroupListResponse, GroupMemberChange, GroupMemberKind, GroupRow } from "./types.js";
+import type { ChangeFeedFrame, StreamChangesOptions, CredentialListResponse, CredentialMeta, CryptoKeyEncoding, CryptoKeyExport, CryptoKeyExternal, CryptoKeyType, CryptoRequest, CryptoResultByOp, DecideRequest, DecideResponse, DecisionModelsResponse, CredentialScope, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResult, Agent, AgentEvent, AgentList, CancelAgentResult, ClientOptions, ContinueOptions, RunOverrideOptions, EffectiveConfigResponse, RunFileInput, RunInboxDownload, AgentOverridableResponse, RetuneRunResponse, RunConfigResponse, RunPromptResponse, CreateSnapshotOptions, EnsureCodeAgentOptions, EnsureCodeAgentResult, EnsureHookDefOptions, EnsureHookDefResult, HookDefInput, HookDefOverlay, HookDefRowResponse, CreateDefOptions, ForkDefOptions, HookDefForkOverlay, ScheduleDefInput, ScheduleDefOverlay, ScheduleDefRowResponse, WebhookDefInput, WebhookDefOverlay, WebhookDefRowResponse, EnsureMcpServerOptions, EnsureMcpServerResult, HealthResponse, InterruptListResponse, InterruptStatus, ListUserAgentsOptions, WalkRunsPage, AckChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAckResult, ChannelAwaitResult, ChannelBroadcastResult, ChannelDescriptor, ChannelPeekResult, ListTeamChannelsOptions, PeekTeamChannelOptions, ReleaseTeamChannelOptions, TeamChannelPeekResult, TeamChannelReleaseResult, TeamChannelsResult, 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, RetentionOverride, PersistentVolumesResponse, EphemeralVolumesResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, RunTreeDeletion, ReplaySessionResult, CancelTurnResult, ReviewRunResult, RunBatchOptions, RunBatchResult, RunOptions, ConfiguredRun, ConfiguredRunPatch, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, CreateTeamOptions, DefNamesResponse, ForkTeamOptions, ModelAliasesResponse, OperatorTokenDefNamesResponse, ProviderModelsResponse, RoutingResponse, ScheduleListResponse, SchedulePauseResult, ScheduleRunNowResult, ScheduleStateView, ListTeamsResponse, PromotedTeam, RetiredTeam, TeamBreakpoints, TeamDefDetail, TeamRunDetached, TeamRunTarget, TeamVerification, TeamDraft, TeamDraftVerification, TeamVersionList, TeamDiagram, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, EvaluationSubmitInput, EvaluationGetInput, EvaluationListForRunInput, EvaluationListForDefInput, EvaluationAggregateInput, EvaluationInput, EvaluationSubmitResult, EvaluationRecord, EvaluationListForRunResult, EvaluationListForDefResult, EvaluationAggregate, TranscriptResponse, WhoamiResponse, UsageDimension, UsageReportResponse, TokenLimit, TokenLimitsResponse, ConfigResponse, SetTokenLimitRequest, AclBinding, AclBindingListResponse, AclCatalog, AclDefInput, AclDefListResponse, AclDefNamesResponse, AclDefRow, AclRule, AclValidateResult, AuthzDecision, AuthzEvaluationRequest, AuthzEvaluationsRequest, AuthzEvaluationsResponse, AuthzExplainResponse, AuthzSimulateRequest, AuthzSimulateResponse, CreateAclBindingBody, CreateGroupBody, GroupDetail, GroupEffective, GroupListResponse, GroupMemberChange, GroupMemberKind, GroupRow } from "./types.js";
 export declare class LoomcycleClient {
     private ctx;
     constructor(opts?: ClientOptions);
@@ -183,6 +183,33 @@ export declare class LoomcycleClient {
     getEffectiveConfig(runId: string, opts?: {
         signal?: AbortSignal;
     }): Promise<EffectiveConfigResponse>;
+    /** Run one File-tool op on a run's inbox from outside the run — the files the
+     *  run's tools returned. Mirrors `POST /v1/runs/{run_id}/file`, the HTTP twin
+     *  of the MCP `file` tool. Ops: stat, ls, extract, import, keep, rm, clear.
+     *  The response is the op's own JSON (narrow as needed).
+     *
+     *  Needs `runs:read`, and works on any run you can read; another tenant's run
+     *  is an opaque {@link NotFoundError}. extract, keep, rm and clear write, so
+     *  they need the run's owner or an admin — a tenant operator counts as one
+     *  for its own tenant's runs; anyone else gets a
+     *  {@link SubstrateToolRefusedError}, as does a refused op. */
+    runFile<T = unknown>(runId: string, input: RunFileInput, opts?: {
+        signal?: AbortSignal;
+    }): Promise<T>;
+    /** Download one file of a run's inbox. Mirrors
+     *  `GET /v1/runs/{run_id}/inbox/{path}` (HEAD with `head: true`). `path` is
+     *  relative to the inbox root (`documents/a.pdf`) or a reference
+     *  (`volume:inbox:documents/a.pdf`).
+     *
+     *  Any reader of the run may download (`runs:read`). `range` is sent as the
+     *  Range header (`bytes=0-1023`). The inbox is deleted when its run ends, so
+     *  a finished run's file — like a missing file, run, or another tenant's run —
+     *  is a {@link NotFoundError}. */
+    downloadRunInboxFile(runId: string, path: string, opts?: {
+        range?: string;
+        head?: boolean;
+        signal?: AbortSignal;
+    }): Promise<RunInboxDownload>;
     /** Which per-run overrides a run of `name` may set, for this caller — what a
      *  run form needs before it sends anything. Mirrors
      *  `GET /v1/_agentdef/{name}/overridable`.
@@ -474,8 +501,10 @@ export declare class LoomcycleClient {
         signal?: AbortSignal;
     }): Promise<WalkRunsPage>;
     /** Aggregated token-usage + cost report (RFC AV). Group by any of
-     *  tenant/user/provider/model/source over an optional time window; group by
-     *  `source` for the operator-vs-tenant split. Tenant-scoped server-side: a
+     *  tenant/user/provider/model/source/purpose over an optional time window;
+     *  group by `source` for the operator-vs-tenant split, by `purpose` to see
+     *  what OCR and speech-to-text cost (a row's `audio_seconds` is the audio its
+     *  speech-to-text calls transcribed). Tenant-scoped server-side: a
      *  tenant principal sees only its own tenant (the `tenant` focus is
      *  admin-only). Mirrors `GET /v1/_usage`. */
     usageReport(opts?: {

package/dist/client.js

@@ -443,6 +443,51 @@ export class LoomcycleClient {
     async getEffectiveConfig(runId, opts) {
         return jsonFetch(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/effective-config`, opts);
     }
+    /** Run one File-tool op on a run's inbox from outside the run — the files the
+     *  run's tools returned. Mirrors `POST /v1/runs/{run_id}/file`, the HTTP twin
+     *  of the MCP `file` tool. Ops: stat, ls, extract, import, keep, rm, clear.
+     *  The response is the op's own JSON (narrow as needed).
+     *
+     *  Needs `runs:read`, and works on any run you can read; another tenant's run
+     *  is an opaque {@link NotFoundError}. extract, keep, rm and clear write, so
+     *  they need the run's owner or an admin — a tenant operator counts as one
+     *  for its own tenant's runs; anyone else gets a
+     *  {@link SubstrateToolRefusedError}, as does a refused op. */
+    async runFile(runId, input, opts) {
+        return postJSON(this.ctx, `/v1/runs/${encodeURIComponent(runId)}/file`, input, opts);
+    }
+    /** Download one file of a run's inbox. Mirrors
+     *  `GET /v1/runs/{run_id}/inbox/{path}` (HEAD with `head: true`). `path` is
+     *  relative to the inbox root (`documents/a.pdf`) or a reference
+     *  (`volume:inbox:documents/a.pdf`).
+     *
+     *  Any reader of the run may download (`runs:read`). `range` is sent as the
+     *  Range header (`bytes=0-1023`). The inbox is deleted when its run ends, so
+     *  a finished run's file — like a missing file, run, or another tenant's run —
+     *  is a {@link NotFoundError}. */
+    async downloadRunInboxFile(runId, path, opts) {
+        const rel = path.replace(/^volume:inbox:/, "");
+        const encoded = rel.split("/").map(encodeURIComponent).join("/");
+        const headers = {};
+        if (this.ctx.authToken)
+            headers.Authorization = `Bearer ${this.ctx.authToken}`;
+        if (opts?.range)
+            headers.Range = opts.range;
+        const resp = await this.ctx.fetchImpl(`${this.ctx.baseUrl}/v1/runs/${encodeURIComponent(runId)}/inbox/${encoded}`, { method: opts?.head ? "HEAD" : "GET", headers, signal: opts?.signal });
+        if (!resp.ok) {
+            await raiseFromResponse(resp);
+        }
+        const bytes = opts?.head ? new Uint8Array() : new Uint8Array(await resp.arrayBuffer());
+        return {
+            bytes,
+            status: resp.status,
+            contentType: resp.headers.get("Content-Type") ?? "",
+            filename: dispositionFilename(resp.headers.get("Content-Disposition")) ?? rel.split("/").pop() ?? "",
+            sha256: resp.headers.get("X-Loomcycle-SHA256") ?? "",
+            origin: resp.headers.get("X-Loomcycle-Origin") ?? "",
+            headers: resp.headers,
+        };
+    }
     /** Which per-run overrides a run of `name` may set, for this caller — what a
      *  run form needs before it sends anything. Mirrors
      *  `GET /v1/_agentdef/{name}/overridable`.
@@ -796,8 +841,10 @@ export class LoomcycleClient {
         return { agents: resp.agents ?? [], next_cursor: resp.next_cursor ?? "" };
     }
     /** Aggregated token-usage + cost report (RFC AV). Group by any of
-     *  tenant/user/provider/model/source over an optional time window; group by
-     *  `source` for the operator-vs-tenant split. Tenant-scoped server-side: a
+     *  tenant/user/provider/model/source/purpose over an optional time window;
+     *  group by `source` for the operator-vs-tenant split, by `purpose` to see
+     *  what OCR and speech-to-text cost (a row's `audio_seconds` is the audio its
+     *  speech-to-text calls transcribed). Tenant-scoped server-side: a
      *  tenant principal sees only its own tenant (the `tenant` focus is
      *  admin-only). Mirrors `GET /v1/_usage`. */
     async usageReport(opts) {
@@ -1272,6 +1319,12 @@ export class LoomcycleClient {
             body.document_ids = input.documentIds;
         if (input.excludeDocumentIds !== undefined)
             body.exclude_document_ids = input.excludeDocumentIds;
+        // The second scope's documents: sent only when set, so a one-scope search's
+        // response stays byte-identical (no per-entry `scope`).
+        if (input.documentsScope !== undefined)
+            body.documents_scope = input.documentsScope;
+        if (input.documentsScopeId !== undefined)
+            body.documents_scope_id = input.documentsScopeId;
         return postJSON(this.ctx, "/v1/_memory/search", body, {
             signal: opts?.signal,
         });
@@ -3215,6 +3268,23 @@ export class LoomcycleClient {
         return postJSON(this.ctx, "/v1/_crypto", input, opts);
     }
 }
+/** The file name of an RFC 8187 `filename*=UTF-8''…` Content-Disposition, or
+ *  a plain quoted `filename="…"`; undefined when there is neither. */
+function dispositionFilename(header) {
+    if (!header)
+        return undefined;
+    const star = /filename\*=UTF-8''([^;]+)/i.exec(header);
+    if (star) {
+        try {
+            return decodeURIComponent(star[1].trim());
+        }
+        catch {
+            return undefined;
+        }
+    }
+    const plain = /filename="([^"]*)"/i.exec(header);
+    return plain ? plain[1] : undefined;
+}
 /** Lightweight SSE parser tailored to the run-state stream. Each
  *  frame's event name distinguishes the two kinds; data is JSON.
  *  Comment lines (": keepalive") are ignored. */

package/dist/index.d.ts

@@ -187,5 +187,5 @@ export { verifyLoomcycleSignature, verifyLoomcycleDelivery } from "./signature.j
 export type { VerifySignatureOptions, VerifiedDelivery } from "./signature.js";
 export { ClientToolHost, clientToolsURL, CLIENT_TOOL_SUBPROTOCOL } from "./client-tools.js";
 export type { ClientToolSchema, ClientToolInvocation, ConnectClientToolsOptions, WebSocketLike, WebSocketCtor, } from "./client-tools.js";
-export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, RunOverrideOptions, SamplingOptions, CompactionOptions, ContextOptions, ToolUse, Usage, CallTiming, Agent, AgentStatus, AwaitedState, AgentUsage, RunResult, RunSpec, RunSpecTeam, ConfiguredRun, ConfiguredRunPatch, ToolChoiceOptions, OutputFormatOptions, CancelAgentResult, ListAgentsResponse, ListUserAgentsOptions, AgentList, WalkRunsPage, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, RunTreeDeletion, RunTreeNotReached, DirectoryBudget, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureAccess, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, ErasureTokenRef, CancelTurnResult, ReviewRunResult, ReplaySessionResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, TokenRestrictions, UserTokenMeta, ListUserTokensResponse, RunnableAgent, RunnableAgentsResponse, WhoamiResponse, WhoamiEffective, WhoamiAuth, PauseResult, RetentionOverride, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, MemorySearchDocumentFilter, MemorySearchInput, MemorySource, MemoryWhen, MemoryTimeFilter, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, MemoryBackfillResponse, MemoryPurgeResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, ChannelHookCall, ChannelHookResult, HookFailMode, HookPhase, HookToolCall, HookToolResult, PostHookCall, PostHookResult, PreHookCall, PreHookResult, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, PromotedTeam, RetiredTeam, TeamDefDetail, TeamVerification, TeamDraft, TeamDraftVerification, TeamIssue, TeamIssueKind, TeamVersion, TeamVersionList, TeamBreakpoints, TeamRunDetached, TeamRunResult, TeamRunTarget, CreateTeamOptions, ForkTeamOptions, DefNameSummary, DefNamesResponse, OperatorTokenDefNameSummary, OperatorTokenDefNamesResponse, ScheduleListEntry, ScheduleListResponse, ScheduleActiveRun, ScheduleStateView, ScheduleRunNowResult, SchedulePauseResult, ModelAlias, ModelAliasesResponse, RoutingResponse, RoutingUserTier, RoutingTier, RoutingCandidate, RoutingThroughput, RoutingProvider, SearchRoutingProvider, RoutingEmbedder, RoutingDecision, RoutingDecisionModel, ProviderModelsResponse, TeamRunStep, TeamDecisionHandler, TeamDecisionQuestion, TeamDecisionAnswer, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, DocumentSearchFilter, DocumentSearchHit, DocumentSearchResult, DocumentRelatedResult, HistoryToolInput, HistoryToolResponse, EvaluationEmitterRole, EvaluationSubmitInput, EvaluationGetInput, EvaluationListForRunInput, EvaluationListForDefInput, EvaluationAggregateInput, EvaluationInput, EvaluationSubmitResult, EvaluationRecord, EvaluationListForRunResult, EvaluationListForDefResult, EvaluationScoreStats, EvaluationAggregate, VolumeMode, PersistentVolumeEntry, PersistentVolumesResponse, EphemeralVolumeEntry, EphemeralVolumesResponse, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, ChangeFeedError, ChangeFeedFrame, ChangeFeedStatus, EmbedderHealth, MemoryChange, MemoryChangeScope, MemoryChangeType, StreamChangesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ListTeamChannelsOptions, PeekTeamChannelOptions, ReleaseTeamChannelOptions, TeamChannelReleaseResult, TeamChannelDeclaredIn, TeamChannelDescriptor, TeamChannelPeekResult, TeamChannelsResult, 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, AgentRouting, AgentChannelACL, AgentInterruptionACL, AgentDecision, MemoryRerank, AgentSampling, AgentCompaction, AgentTranscription, AgentContext, TierCandidate, CoreBlock, HookEvent, InlineWebhook, HookEntry, EventHooks, ToolEntry, ToolHooksByTool, EnsureCodeAgentOptions, EnsureCodeAgentResult, CreateDefOptions, ForkDefOptions, EnsureHookDefOptions, EnsureHookDefResult, HookDefBody, HookDefForkOverlay, HookDefInput, HookDefMatch, HookDefOverlay, HookDefRowResponse, HookDefVerifyResult, ScheduleDefInput, ScheduleDefOverlay, ScheduleDefRowResponse, ScheduledRunHook, ScheduledRunPromptContent, ScheduledRunPromptSegment, WebhookDefAuth, WebhookDefFilter, WebhookDefInput, WebhookDefOverlay, WebhookDefRateLimit, WebhookDefRowResponse, WebhookDefDeliveries, WebhookDefSyncResponse, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, CapabilityInertInfo, LimitInfo, FileCapturedInfo, TranscriptionInfo, AdmissionInfo, ErrorInfo, CallFormat, CallRef, HookDecisionInfo, TeamDecisionInfo, OverrideInfo, FallbackInfo, InterruptionEventInfo, SpawnChildInfo, TurnCancelledInfo, ChannelEventInfo, ContextCompactionInfo, ContextRecapInfo, ContextStateInfo, ContextExhaustedInfo, ContextTierVerdict, ContextDistillDeclinedInfo, EffectiveConfigResponse, EffectiveConfigSource, EffectiveValue, InertContextSetting, AgentOverridableResponse, OverridableField, OverrideLockReason, RetuneRunResponse, RunConfigRecord, SubagentHoldInfo, RunConfigResponse, RunPromptResponse, RunPromptSnapshot, PromptBlock, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, CredentialScope, CredentialMeta, CredentialListResponse, CryptoKeyVersion, CryptoKeyExport, CryptoKeyType, CryptoKeyEncoding, CryptoKeyBackend, CryptoKeyExternal, CryptoOp, CryptoRequestBase, CryptoKeyRef, CryptoEncryptRequest, CryptoDecryptRequest, CryptoRewrapRequest, CryptoMacRequest, CryptoVerifyMacRequest, CryptoSignRequest, CryptoVerifyRequest, CryptoPublicKeyRequest, CryptoTotpRequest, CryptoHashRequest, CryptoRandomRequest, CryptoHashPasswordRequest, CryptoVerifyPasswordRequest, CryptoRequest, CryptoEncryptResult, CryptoDecryptResult, CryptoRewrapResult, CryptoMacResult, CryptoVerifyResult, CryptoSignResult, CryptoPublicJWK, CryptoPublicKeyResult, CryptoTotpResult, CryptoHashResult, CryptoRandomResult, CryptoHashPasswordResult, CryptoVerifyPasswordResult, CryptoResultByOp, CryptoResult, DecideRequest, DecideResponse, DecisionQuestion, DecisionChoiceQuestion, DecisionNoulQuestion, DecisionScoreQuestion, DecisionAnswer, DecisionChoiceAnswer, DecisionNoulAnswer, DecisionScoreAnswer, DecisionModel, DecisionModelsResponse, AclMode, AclSource, AclEffect, AclSubjectKind, AclCondition, AclRule, AclList, AclDefRow, AclDefListResponse, AclDefNamesResponse, AclValidateResult, AclCatalogType, AclCatalog, AclDefOp, AclDefInput, GroupRow, GroupMemberKind, GroupMember, GroupListResponse, GroupDetail, GroupEffective, CreateGroupBody, GroupMemberChange, AclBinding, AclBindingListResponse, CreateAclBindingBody, AuthzReason, AuthzDecision, AuthzRequestContext, AuthzEvaluationRequest, AuthzEvaluationsSemantic, AuthzEvaluationsRequest, AuthzEvaluationsResponse, AuthzTrace, AuthzAppliedBinding, AuthzExplainResponse, AuthzDraftBinding, AuthzSimulateRequest, AuthzSimulateResult, AuthzSimulateResponse, } from "./types.js";
+export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, RunOverrideOptions, SamplingOptions, CompactionOptions, ContextOptions, ToolUse, Usage, CallTiming, Agent, AgentStatus, AwaitedState, AgentUsage, RunResult, RunSpec, RunSpecTeam, ConfiguredRun, ConfiguredRunPatch, ToolChoiceOptions, OutputFormatOptions, CancelAgentResult, ListAgentsResponse, ListUserAgentsOptions, AgentList, WalkRunsPage, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, RunTreeDeletion, RunTreeNotReached, DirectoryBudget, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureAccess, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, ErasureTokenRef, CancelTurnResult, ReviewRunResult, ReplaySessionResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, TokenRestrictions, UserTokenMeta, ListUserTokensResponse, RunnableAgent, RunnableAgentsResponse, WhoamiResponse, WhoamiEffective, WhoamiAuth, PauseResult, RetentionOverride, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, MemorySearchDocumentFilter, MemorySearchInput, MemorySource, MemoryWhen, MemoryTimeFilter, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, MemoryBackfillResponse, MemoryPurgeResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, ChannelHookCall, ChannelHookResult, HookFailMode, HookPhase, HookToolCall, HookToolResult, PostHookCall, PostHookResult, PreHookCall, PreHookResult, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, PromotedTeam, RetiredTeam, TeamDefDetail, TeamVerification, TeamDraft, TeamDraftVerification, TeamIssue, TeamIssueKind, TeamVersion, TeamVersionList, TeamBreakpoints, TeamRunDetached, TeamRunResult, TeamRunTarget, CreateTeamOptions, ForkTeamOptions, DefNameSummary, DefNamesResponse, OperatorTokenDefNameSummary, OperatorTokenDefNamesResponse, ScheduleListEntry, ScheduleListResponse, ScheduleActiveRun, ScheduleStateView, ScheduleRunNowResult, SchedulePauseResult, ModelAlias, ModelAliasesResponse, RoutingResponse, RoutingUserTier, RoutingTier, RoutingCandidate, RoutingThroughput, RoutingProvider, SearchRoutingProvider, RoutingEmbedder, RoutingDecision, RoutingDecisionModel, ProviderModelsResponse, TeamRunStep, TeamDecisionHandler, TeamDecisionQuestion, TeamDecisionAnswer, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, DocumentSearchFilter, DocumentSearchHit, DocumentSearchResult, DocumentRelatedResult, HistoryToolInput, HistoryToolResponse, EvaluationEmitterRole, EvaluationSubmitInput, EvaluationGetInput, EvaluationListForRunInput, EvaluationListForDefInput, EvaluationAggregateInput, EvaluationInput, EvaluationSubmitResult, EvaluationRecord, EvaluationListForRunResult, EvaluationListForDefResult, EvaluationScoreStats, EvaluationAggregate, VolumeMode, PersistentVolumeEntry, PersistentVolumesResponse, EphemeralVolumeEntry, EphemeralVolumesResponse, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, ChangeFeedError, ChangeFeedFrame, ChangeFeedStatus, EmbedderHealth, MemoryChange, MemoryChangeScope, MemoryChangeType, StreamChangesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ListTeamChannelsOptions, PeekTeamChannelOptions, ReleaseTeamChannelOptions, TeamChannelReleaseResult, TeamChannelDeclaredIn, TeamChannelDescriptor, TeamChannelPeekResult, TeamChannelsResult, 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, AgentRouting, AgentChannelACL, AgentInterruptionACL, AgentDecision, MemoryRerank, AgentSampling, AgentCompaction, AgentTranscription, AgentContext, TierCandidate, CoreBlock, HookEvent, InlineWebhook, HookEntry, EventHooks, ToolEntry, ToolHooksByTool, EnsureCodeAgentOptions, EnsureCodeAgentResult, CreateDefOptions, ForkDefOptions, EnsureHookDefOptions, EnsureHookDefResult, HookDefBody, HookDefForkOverlay, HookDefInput, HookDefMatch, HookDefOverlay, HookDefRowResponse, HookDefVerifyResult, ScheduleDefInput, ScheduleDefOverlay, ScheduleDefRowResponse, ScheduledRunHook, ScheduledRunPromptContent, ScheduledRunPromptSegment, WebhookDefAuth, WebhookDefFilter, WebhookDefInput, WebhookDefOverlay, WebhookDefRateLimit, WebhookDefRowResponse, WebhookDefDeliveries, WebhookDefSyncResponse, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, CapabilityInertInfo, LimitInfo, FileCapturedInfo, TranscriptionInfo, AdmissionInfo, ErrorInfo, CallFormat, CallRef, HookDecisionInfo, TeamDecisionInfo, OverrideInfo, FallbackInfo, InterruptionEventInfo, SpawnChildInfo, TurnCancelledInfo, ChannelEventInfo, ContextCompactionInfo, ContextRecapInfo, ContextStateInfo, ContextExhaustedInfo, ContextTierVerdict, ContextDistillDeclinedInfo, EffectiveConfigResponse, RunFileInput, RunInboxDownload, EffectiveConfigSource, EffectiveValue, InertContextSetting, AgentOverridableResponse, OverridableField, OverrideLockReason, RetuneRunResponse, RunConfigRecord, SubagentHoldInfo, RunConfigResponse, RunPromptResponse, RunPromptSnapshot, PromptBlock, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, CredentialScope, CredentialMeta, CredentialListResponse, CryptoKeyVersion, CryptoKeyExport, CryptoKeyType, CryptoKeyEncoding, CryptoKeyBackend, CryptoKeyExternal, CryptoOp, CryptoRequestBase, CryptoKeyRef, CryptoEncryptRequest, CryptoDecryptRequest, CryptoRewrapRequest, CryptoMacRequest, CryptoVerifyMacRequest, CryptoSignRequest, CryptoVerifyRequest, CryptoPublicKeyRequest, CryptoTotpRequest, CryptoHashRequest, CryptoRandomRequest, CryptoHashPasswordRequest, CryptoVerifyPasswordRequest, CryptoRequest, CryptoEncryptResult, CryptoDecryptResult, CryptoRewrapResult, CryptoMacResult, CryptoVerifyResult, CryptoSignResult, CryptoPublicJWK, CryptoPublicKeyResult, CryptoTotpResult, CryptoHashResult, CryptoRandomResult, CryptoHashPasswordResult, CryptoVerifyPasswordResult, CryptoResultByOp, CryptoResult, DecideRequest, DecideResponse, DecisionQuestion, DecisionChoiceQuestion, DecisionNoulQuestion, DecisionScoreQuestion, DecisionAnswer, DecisionChoiceAnswer, DecisionNoulAnswer, DecisionScoreAnswer, DecisionModel, DecisionModelsResponse, AclMode, AclSource, AclEffect, AclSubjectKind, AclCondition, AclRule, AclList, AclDefRow, AclDefListResponse, AclDefNamesResponse, AclValidateResult, AclCatalogType, AclCatalog, AclDefOp, AclDefInput, GroupRow, GroupMemberKind, GroupMember, GroupListResponse, GroupDetail, GroupEffective, CreateGroupBody, GroupMemberChange, AclBinding, AclBindingListResponse, CreateAclBindingBody, AuthzReason, AuthzDecision, AuthzRequestContext, AuthzEvaluationRequest, AuthzEvaluationsSemantic, AuthzEvaluationsRequest, AuthzEvaluationsResponse, AuthzTrace, AuthzAppliedBinding, AuthzExplainResponse, AuthzDraftBinding, AuthzSimulateRequest, AuthzSimulateResult, AuthzSimulateResponse, } from "./types.js";
 export { AclDeniedError, AgentIDInUseError, AgentNotFoundError, AlreadyPausingError, AuthError, BackpressureError, NotFoundError, InsufficientScopeError, InvalidArgumentError, ChannelCursorRegressionError, LoomcycleError, NotPausedError, PauseNotConfiguredError, PerUserQuotaExhaustedError, PromptTooLargeError, RateLimitedError, RequestTooLargeError, SessionBusyError, SessionNotFoundError, SnapshotNotFoundError, SnapshotTooLargeError, SnapshotVersionError, SubstrateToolRefusedError, TokenLimitExceededError, UnavailableError, } from "./errors.js";

package/dist/types.d.ts

@@ -187,6 +187,49 @@ export interface RunPromptResponse {
     system: PromptBlock[];
     input: PromptBlock[];
 }
+/** Input for {@link LoomcycleClient.runFile} — one File-tool op on the inbox of
+ *  a run, from outside the run (`POST /v1/runs/{run_id}/file`). The run is the
+ *  path's; the fields are the tool's own, snake_case as on the wire. download
+ *  and upload are not offered here: they need a run's HTTP allowlist. */
+export type RunFileInput = {
+    op: "stat" | "ls" | "extract" | "import" | "keep" | "rm" | "clear";
+    /** stat / ls / rm / extract / import: `volume:inbox:<path>`, or a bare path in the inbox. */
+    path?: string;
+    /** keep: the inbox file to copy. */
+    from?: string;
+    /** keep: `volume:<name>:<path>` in a read-write dynamic volume of your tenant. */
+    to?: string;
+    overwrite?: boolean;
+    recursive?: boolean;
+    /** clear: one folder of the inbox to empty instead of all of it. */
+    prefix?: string;
+    images?: boolean;
+    max_rows?: number;
+    excerpt_chars?: number;
+    title?: string;
+    doc_path?: string;
+    scope?: string;
+    tags?: string[];
+};
+/** What {@link LoomcycleClient.downloadRunInboxFile} returns: one inbox file's
+ *  bytes and what the server says about them. */
+export interface RunInboxDownload {
+    /** The bytes (empty for a HEAD request). */
+    bytes: Uint8Array;
+    /** 200, or 206 for a range. */
+    status: number;
+    /** The type the server served: the recorded type when it is one a browser
+     *  cannot run, else `application/octet-stream`. */
+    contentType: string;
+    /** The file's name, from Content-Disposition. */
+    filename: string;
+    /** SHA-256 (hex) of the file's bytes as served — the whole file, also for a range. */
+    sha256: string;
+    /** The producer the runtime recorded (`mcp:<server>/<tool>`, `http`, …), or
+     *  `unknown` when the file changed since it was kept. */
+    origin: string;
+    headers: Headers;
+}
 /** The reply from `GET /v1/runs/{run_id}/effective-config` — for every
  *  overridable field, the value this run will actually use and which layer
  *  decided it.
@@ -2391,11 +2434,12 @@ export interface MemorySearchInput {
      *
      *  The four document filters need a search that can return documents (no
      *  `sources`, or `sources` including `"documents"`; otherwise 400
-     *  `invalid_filter`), are refused on `scope: "tenant"` (400 `invalid_filter`),
-     *  and need SQL Memory on the server (400 `filter_unavailable`). They resolve in
-     *  the caller's own tenant. The response then carries {@link
-     *  MemorySearchResponse.filter}. For chunk-level filters (type, status, tags, a
-     *  validity instant) use `document({ op: "search" })`. */
+     *  `invalid_filter`) and SQL Memory on the server (400 `filter_unavailable`).
+     *  They resolve in the caller's own tenant. With a {@link documentsScope}
+     *  different from `scope` they aim at that scope's documents instead. The
+     *  response then carries {@link MemorySearchResponse.filter}. For chunk-level
+     *  filters (type, status, tags, a validity instant) use
+     *  `document({ op: "search" })`. */
     underPaths?: string[];
     /** Never return the chunks of documents named at or under these paths (sent as
      *  `exclude_under_paths`). Documents only, as {@link underPaths}. */
@@ -2406,6 +2450,23 @@ export interface MemorySearchInput {
     /** Never return the chunks of these documents (sent as
      *  `exclude_document_ids`). Documents only, as {@link underPaths}. */
     excludeDocumentIds?: string[];
+    /** Also search the DOCUMENTS of this scope in the same call (sent as
+     *  `documents_scope`): for example a user's own notes together with the
+     *  tenant's reference documents. Both are ranked into one list under one
+     *  `topK`, and each entry then carries {@link MemorySearchEntry.scope}. Only
+     *  documents come from this scope; facts and notes still come from `scope`.
+     *  The four document filters aim at this scope's documents.
+     *
+     *  Equal to `scope` (and {@link documentsScopeId} omitted or equal to
+     *  `scopeId`), it is the same as adding `"documents"` to `sources`. It cannot
+     *  be combined with `sources: ["traces"]` (400 `invalid_documents_scope`). A
+     *  caller whose access does not reach that scope's documents gets 403. */
+    documentsScope?: "agent" | "user" | "tenant";
+    /** The subject of {@link documentsScope} (sent as `documents_scope_id`): the
+     *  agent name or user id. Required when `documentsScope` is `"agent"` or
+     *  `"user"` and differs from `scope`; ignored for `"tenant"`. The tenant is
+     *  always the caller's own. */
+    documentsScopeId?: string;
 }
 /** What a document filter on {@link LoomcycleClient.memorySearch} resolved to —
  *  present on the response ONLY when a filter was sent. */
@@ -2427,6 +2488,9 @@ export interface MemorySearchDocumentFilter {
      *  false while access-control rules can deny the caller reading part of the
      *  scope — the counts then cover only documents it may read. */
     inverted: boolean;
+    /** The scope the filter resolved in — present when it aimed at a
+     *  {@link MemorySearchInput.documentsScope} different from `scope`. */
+    scope?: "agent" | "user" | "tenant";
 }
 /** The observed-time predicate on {@link MemorySearchInput}. Timestamps are
  *  RFC3339 instants — resolve phrases like "the first weekend of October"
@@ -2501,6 +2565,10 @@ export interface MemorySearchEntry {
         kind: "description" | "claim" | "question";
         text: string;
     };
+    /** The scope this hit came from — present on every entry when the request
+     *  set a {@link MemorySearchInput.documentsScope} different from `scope`, so
+     *  the caller's own memory can be told from the other scope's documents. */
+    scope?: "agent" | "user" | "tenant";
 }
 export interface MemorySearchResponse {
     scope: string;
@@ -2518,6 +2586,11 @@ export interface MemorySearchResponse {
     /** What the document filter resolved to — present only when one was sent
      *  ({@link MemorySearchInput.underPaths} and its siblings). */
     filter?: MemorySearchDocumentFilter;
+    /** The second scope searched for documents and its store scope id ("" for
+     *  tenant) — present only when the request set a
+     *  {@link MemorySearchInput.documentsScope} different from `scope`. */
+    documents_scope?: "agent" | "user" | "tenant";
+    documents_scope_id?: string;
 }
 export interface MemoryTimeFilter {
     mode: "prefer" | "require";
@@ -5409,7 +5482,9 @@ export interface LLMEmbeddingsResponse {
     usage: LLMEmbeddingsUsage;
 }
 /** A whitelisted grouping dimension for the usage report. */
-export type UsageDimension = "tenant" | "user" | "provider" | "model" | "source";
+export type UsageDimension = "tenant" | "user" | "provider" | "model" | "source"
+/** What the calls were for: chat | ocr | stt. */
+ | "purpose";
 /** One grouped row of a usage report; only the grouped dimensions are set. */
 export interface UsageAggregate {
     tenant_id?: string;
@@ -5418,6 +5493,8 @@ export interface UsageAggregate {
     model?: string;
     /** operator | tenant | user */
     credential_source?: string;
+    /** chat | ocr | stt — set when grouped by `purpose`. */
+    purpose?: string;
     input_tokens: number;
     output_tokens: number;
     cache_creation_tokens: number;
@@ -5426,6 +5503,9 @@ export interface UsageAggregate {
     currency?: string;
     call_count: number;
     unpriced_calls: number;
+    /** Seconds of audio the group's speech-to-text calls transcribed (the unit
+     *  their per-minute price is computed from); absent when it has none. */
+    audio_seconds?: number;
 }
 export interface UsageReportResponse {
     group_by: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loomcycle/client",
-  "version": "1.124.0",
+  "version": "1.125.0",
   "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.",
   "license": "Apache-2.0",
   "type": "module",