@loomcycle/client 1.134.0 → 1.136.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.
package/README.md CHANGED
@@ -221,7 +221,8 @@ Live SSE tails of what changed in the caller's tenant's memory and documents —
221
221
  | Method | Returns | Notes |
222
222
  |---|---|---|
223
223
  | `streamMemoryChanges(opts?)` | `AsyncIterable<ChangeFeedFrame>` | `memory.set` / `memory.delete` / `memory.scope_deleted`. Mirrors `GET /v1/_memory/changes`. |
224
- | `streamDocumentChanges(opts?)` | `AsyncIterable<ChangeFeedFrame>` | `document.chunk.updated` / `document.chunk.deleted`, naming the `chunk_id`. Mirrors `GET /v1/_document/changes`. |
224
+ | `streamDocumentChanges(opts?)` | `AsyncIterable<ChangeFeedFrame>` | `document.chunk.updated` / `document.chunk.deleted` / `document.edges.changed`, naming the `chunk_id` and `document_id`. Mirrors `GET /v1/_document/changes`. |
225
+ | `documentFeed({scope, scopeId?, tenant?, signal?})` | `AsyncIterable<DocumentFeedFrame>` | RFC FV — the reader's feed, open to a tenant member: one scope (`user` / `tenant`), only documents the caller can list, `{type, chunk_id, document_id, at}` with no cursor (a reconnect is a resync). Mirrors `GET /v1/_document/feed`. |
225
226
 
226
227
  Each change is a **value-free coordinate** (`seq`, `type`, `scope`, `scope_id`, `key` or `chunk_id`, `at`): it says *what* changed, and you pull the current value through the data API. The first item is always `{ kind: "feed", payload: { enabled, since, embedder? } }`, then one `{ kind: "change", payload: MemoryChange }` per change, oldest first.
227
228
 
@@ -2761,6 +2761,25 @@ class LoomcycleClient {
2761
2761
  query: browseQuery(opts),
2762
2762
  });
2763
2763
  }
2764
+ /** Copy a set of documents into another scope (the Document tool's
2765
+ * `copy_documents`, RFC FT). The copies get new ids and carry their history,
2766
+ * tags, images and the relations between them; a relation to a document
2767
+ * outside the set stays in the source and is listed under `dangling`. A dry
2768
+ * run unless `dry_run: false` — run it first. `opts` as on
2769
+ * {@link LoomcycleClient.document}. */
2770
+ async copyDocuments(input, opts) {
2771
+ return (await this.document({ op: "copy_documents", ...input }, opts));
2772
+ }
2773
+ /** Move a set of documents into another scope, keeping every id (the
2774
+ * Document tool's `move_documents`, RFC FT). The source is removed only once
2775
+ * the target is checked; an interrupted move finishes when the same call
2776
+ * runs again. A dry run unless `dry_run: false`, which then needs
2777
+ * `expect_count` from the dry run. A relation leaving the set refuses the
2778
+ * move unless `dangling: "drop"`. `opts` as on
2779
+ * {@link LoomcycleClient.document}. */
2780
+ async moveDocuments(input, opts) {
2781
+ return (await this.document({ op: "move_documents", ...input }, opts));
2782
+ }
2764
2783
  /** Build the URL of an image chunk's asset (RFC BO) — `GET
2765
2784
  * /v1/_document/asset/{chunkId}`. Attach the bytes to a chunk with the
2766
2785
  * `set_asset` op via {@link LoomcycleClient.document}, then read them here.
@@ -3538,6 +3557,42 @@ class LoomcycleClient {
3538
3557
  async *streamDocumentChanges(opts) {
3539
3558
  yield* this.streamChangeFeed("/v1/_document/changes", opts);
3540
3559
  }
3560
+ /** Watch one scope's DOCUMENTS change, as a reader (RFC FV). Mirrors
3561
+ * `GET /v1/_document/feed?scope=user|tenant[&scope_id=…][&tenant=…]`.
3562
+ *
3563
+ * Unlike {@link LoomcycleClient.streamDocumentChanges} (the operator's
3564
+ * tenant-wide feed) this is open to a tenant MEMBER, gated like
3565
+ * {@link LoomcycleClient.document}: it names only documents the caller can
3566
+ * list, in the one scope it asked for.
3567
+ *
3568
+ * - The first item is `{ kind: "feed" }`; `payload.enabled === false` means
3569
+ * the server captures no changes — reload on a timer instead of waiting.
3570
+ * - Then one `{ kind: "change" }` per change. Changes of one type to one
3571
+ * document inside one server poll arrive as one.
3572
+ * - There is NO cursor and no resume: the stream starts now. After any
3573
+ * disconnect, reload your view and open a new stream.
3574
+ * - A `{ kind: "error" }` with code `store_unavailable` is non-fatal;
3575
+ * `access_unavailable`, `credential_revoked` and `credential_expired`
3576
+ * close the stream — reload and reconnect with a valid credential.
3577
+ * - The server re-authenticates the stream every 30 s: a revoked grant
3578
+ * stops that document's changes, and a revoked token ends the stream,
3579
+ * within that window; a token's expiry ends it on time.
3580
+ * - At most a few streams per principal (`LOOMCYCLE_DOCUMENT_FEED_MAX_STREAMS`,
3581
+ * default 4); one more is refused with a 429 — a `BackpressureError` with
3582
+ * code `too_many_streams`, not retryable until you close a stream.
3583
+ * - Iteration ends when the server closes the stream, or throws an
3584
+ * `AbortError` when `signal` aborts. */
3585
+ async *documentFeed(opts) {
3586
+ if (opts.scope !== "user" && opts.scope !== "tenant") {
3587
+ throw new Error(`loomcycle: documentFeed scope must be "user" or "tenant", got ${String(opts.scope)}`);
3588
+ }
3589
+ const q = new URLSearchParams({ scope: opts.scope, ...browseQuery(opts) });
3590
+ for await (const ev of this.streamSSEGet(`/v1/_document/feed?${q.toString()}`, opts.signal)) {
3591
+ const frame = toDocumentFeedFrame(ev);
3592
+ if (frame)
3593
+ yield frame;
3594
+ }
3595
+ }
3541
3596
  async *streamChangeFeed(path, opts) {
3542
3597
  const since = opts?.since;
3543
3598
  // The server reads an unparseable or negative `since` as 0 rather than
@@ -3873,6 +3928,26 @@ function toChangeFeedFrame(raw) {
3873
3928
  }
3874
3929
  return null;
3875
3930
  }
3931
+ /** toDocumentFeedFrame types one frame of the reader's document feed, or
3932
+ * returns null for one it does not recognise. `feed` and `error` frames are
3933
+ * read as on the operator feed; a reader `change` carries no `seq`, so it is
3934
+ * recognised by its `document_id`. */
3935
+ function toDocumentFeedFrame(raw) {
3936
+ const shared = toChangeFeedFrame(raw);
3937
+ if (shared?.kind === "feed") {
3938
+ const { since: _since, ...status } = shared.payload;
3939
+ return { kind: "feed", payload: status };
3940
+ }
3941
+ if (shared?.kind === "error")
3942
+ return shared;
3943
+ if (typeof raw.document_id === "string" &&
3944
+ typeof raw.chunk_id === "string" &&
3945
+ typeof raw.type === "string" &&
3946
+ raw.type.startsWith("document.")) {
3947
+ return { kind: "change", payload: raw };
3948
+ }
3949
+ return null;
3950
+ }
3876
3951
  // channelOpPath builds the v0.9.x Channel CRUD URL. Two families:
3877
3952
  // - scope === "global" → /v1/_channels/{channel}/{op}
3878
3953
  // - scope === "user" → /v1/users/{userId}/channels/{channel}/{op}
@@ -70,9 +70,11 @@ const TRANSIENT_CODES = new Set([
70
70
  /** 429 codes that do NOT clear by waiting: the caller has to act first, so
71
71
  * a retry loop on them never ends. `configured_run_cap`: the user already
72
72
  * holds as many configured (not yet started) runs as the operator allows,
73
- * and only starting or discarding one makes room. (A hard token budget,
74
- * `token_limit_exceeded`, has a class of its own outside BackpressureError.) */
75
- const CALLER_ACTION_429_CODES = new Set(["configured_run_cap"]);
73
+ * and only starting or discarding one makes room. `too_many_streams`: the
74
+ * principal already holds as many document feed streams as allowed, and only
75
+ * closing one makes room. (A hard token budget, `token_limit_exceeded`, has a
76
+ * class of its own outside BackpressureError.) */
77
+ const CALLER_ACTION_429_CODES = new Set(["configured_run_cap", "too_many_streams"]);
76
78
  /** Base class for every HTTP 404 the client surfaces. Lets callers
77
79
  * catch any not-found case with a single `instanceof NotFoundError`
78
80
  * check, regardless of which specific resource was missing
package/dist/cjs/index.js CHANGED
@@ -78,6 +78,7 @@
78
78
  * // Memory / document change feeds (RFC CD Part C; SSE; substrate:tenant)
79
79
  * streamMemoryChanges(opts?): AsyncIterable<ChangeFeedFrame> // feed | change | error (non-fatal); resume with opts.since = last seq
80
80
  * streamDocumentChanges(opts?): AsyncIterable<ChangeFeedFrame>
81
+ * documentFeed(opts): AsyncIterable<DocumentFeedFrame> // RFC FV: member-safe, one scope, no cursor (reconnect = resync)
81
82
  *
82
83
  * // Interruption (v0.8.16; decline RFC BH)
83
84
  * listUserInterrupts(userId, opts?): Promise<InterruptListResponse>
@@ -158,6 +159,7 @@
158
159
  * // Path VFS + chunked-graph Documents on the wire (v1.4.0 — RFC AL / RFC AK)
159
160
  * path(input): Promise<PathToolResponse> // resolve/ls/stat/mkdir/mv/rm
160
161
  * document(input): Promise<DocumentToolResponse> // 13 ops; needs SQL Memory
162
+ * copyDocuments(input) / moveDocuments(input): Promise<DocumentTransferResult> // RFC FT, dry run by default
161
163
  *
162
164
  * // History — browse/search/annotate past chats (RFC BE; tenant-confined)
163
165
  * history(input): Promise<HistoryToolResponse> // list/get/search/rename/annotate/pin/archive/recap/resume
package/dist/client.d.ts CHANGED
@@ -26,7 +26,7 @@
26
26
  import { InteractiveSession } from "./interactive.js";
27
27
  import { LoomcycleOAuth } from "./oauth.js";
28
28
  import { ClientToolHost, type ConnectClientToolsOptions } from "./client-tools.js";
29
- import type { ChangeFeedFrame, StreamChangesOptions, CredentialListResponse, CredentialMeta, CryptoKeyEncoding, CryptoKeyExport, CryptoKeyExternal, CryptoKeyType, CryptoRequest, CryptoResultByOp, DecideRequest, DecideResponse, DecisionModelsResponse, CredentialScope, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResult, MergeSubjectsResult, ReviewQueueFilter, ReviewQueueResult, RuleStatementsResult, RevertRulingResult, ListRulingsResult, ApplyReviewPolicyResult, BindSubjectPrincipalResult, 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, UserIdentitiesResponse, AuthGateListResponse, CreateInviteBody, CreatedInvite, AuthInviteListResponse, CreatedPasswordReset, GateIdentitiesResponse, GateTenantStatus, 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, UsageBucket, 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, AppClientConfig, AppClientEntry, ClientDefInput, ClientDefListResponse, ClientDefNamesResponse, ClientDefRecord, ClientDefRetireResult, ClientDefVerifyResult, DeviceLoginOptions, DeviceLoginResult } from "./types.js";
29
+ import type { ChangeFeedFrame, StreamChangesOptions, DocumentFeedFrame, DocumentFeedOptions, CredentialListResponse, CredentialMeta, CryptoKeyEncoding, CryptoKeyExport, CryptoKeyExternal, CryptoKeyType, CryptoRequest, CryptoResultByOp, DecideRequest, DecideResponse, DecisionModelsResponse, CredentialScope, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResult, MergeSubjectsResult, ReviewQueueFilter, ReviewQueueResult, RuleStatementsResult, RevertRulingResult, ListRulingsResult, ApplyReviewPolicyResult, BindSubjectPrincipalResult, 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, UserIdentitiesResponse, AuthGateListResponse, CreateInviteBody, CreatedInvite, AuthInviteListResponse, CreatedPasswordReset, GateIdentitiesResponse, GateTenantStatus, 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, DocumentCopyInput, DocumentMoveInput, DocumentTransferResult, HistoryToolInput, HistoryToolResponse, EvaluationSubmitInput, EvaluationGetInput, EvaluationListForRunInput, EvaluationListForDefInput, EvaluationAggregateInput, EvaluationInput, EvaluationSubmitResult, EvaluationRecord, EvaluationListForRunResult, EvaluationListForDefResult, EvaluationAggregate, TranscriptResponse, WhoamiResponse, UsageDimension, UsageBucket, 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, AppClientConfig, AppClientEntry, ClientDefInput, ClientDefListResponse, ClientDefNamesResponse, ClientDefRecord, ClientDefRetireResult, ClientDefVerifyResult, DeviceLoginOptions, DeviceLoginResult } from "./types.js";
30
30
  export declare class LoomcycleClient {
31
31
  private ctx;
32
32
  private readonly tokenProvider?;
@@ -2074,6 +2074,29 @@ export declare class LoomcycleClient {
2074
2074
  scopeId?: string;
2075
2075
  tenant?: string;
2076
2076
  }): Promise<DocumentToolResponse>;
2077
+ /** Copy a set of documents into another scope (the Document tool's
2078
+ * `copy_documents`, RFC FT). The copies get new ids and carry their history,
2079
+ * tags, images and the relations between them; a relation to a document
2080
+ * outside the set stays in the source and is listed under `dangling`. A dry
2081
+ * run unless `dry_run: false` — run it first. `opts` as on
2082
+ * {@link LoomcycleClient.document}. */
2083
+ copyDocuments(input: DocumentCopyInput, opts?: {
2084
+ signal?: AbortSignal;
2085
+ scopeId?: string;
2086
+ tenant?: string;
2087
+ }): Promise<DocumentTransferResult>;
2088
+ /** Move a set of documents into another scope, keeping every id (the
2089
+ * Document tool's `move_documents`, RFC FT). The source is removed only once
2090
+ * the target is checked; an interrupted move finishes when the same call
2091
+ * runs again. A dry run unless `dry_run: false`, which then needs
2092
+ * `expect_count` from the dry run. A relation leaving the set refuses the
2093
+ * move unless `dangling: "drop"`. `opts` as on
2094
+ * {@link LoomcycleClient.document}. */
2095
+ moveDocuments(input: DocumentMoveInput, opts?: {
2096
+ signal?: AbortSignal;
2097
+ scopeId?: string;
2098
+ tenant?: string;
2099
+ }): Promise<DocumentTransferResult>;
2077
2100
  /** Build the URL of an image chunk's asset (RFC BO) — `GET
2078
2101
  * /v1/_document/asset/{chunkId}`. Attach the bytes to a chunk with the
2079
2102
  * `set_asset` op via {@link LoomcycleClient.document}, then read them here.
@@ -2494,6 +2517,32 @@ export declare class LoomcycleClient {
2494
2517
  * {@link LoomcycleClient.streamMemoryChanges}; a reader wanting both
2495
2518
  * families opens both. */
2496
2519
  streamDocumentChanges(opts?: StreamChangesOptions): AsyncIterable<ChangeFeedFrame>;
2520
+ /** Watch one scope's DOCUMENTS change, as a reader (RFC FV). Mirrors
2521
+ * `GET /v1/_document/feed?scope=user|tenant[&scope_id=…][&tenant=…]`.
2522
+ *
2523
+ * Unlike {@link LoomcycleClient.streamDocumentChanges} (the operator's
2524
+ * tenant-wide feed) this is open to a tenant MEMBER, gated like
2525
+ * {@link LoomcycleClient.document}: it names only documents the caller can
2526
+ * list, in the one scope it asked for.
2527
+ *
2528
+ * - The first item is `{ kind: "feed" }`; `payload.enabled === false` means
2529
+ * the server captures no changes — reload on a timer instead of waiting.
2530
+ * - Then one `{ kind: "change" }` per change. Changes of one type to one
2531
+ * document inside one server poll arrive as one.
2532
+ * - There is NO cursor and no resume: the stream starts now. After any
2533
+ * disconnect, reload your view and open a new stream.
2534
+ * - A `{ kind: "error" }` with code `store_unavailable` is non-fatal;
2535
+ * `access_unavailable`, `credential_revoked` and `credential_expired`
2536
+ * close the stream — reload and reconnect with a valid credential.
2537
+ * - The server re-authenticates the stream every 30 s: a revoked grant
2538
+ * stops that document's changes, and a revoked token ends the stream,
2539
+ * within that window; a token's expiry ends it on time.
2540
+ * - At most a few streams per principal (`LOOMCYCLE_DOCUMENT_FEED_MAX_STREAMS`,
2541
+ * default 4); one more is refused with a 429 — a `BackpressureError` with
2542
+ * code `too_many_streams`, not retryable until you close a stream.
2543
+ * - Iteration ends when the server closes the stream, or throws an
2544
+ * `AbortError` when `signal` aborts. */
2545
+ documentFeed(opts: DocumentFeedOptions): AsyncIterable<DocumentFeedFrame>;
2497
2546
  private streamChangeFeed;
2498
2547
  /** List credential METADATA for a scope (RFC AR) — never a secret value.
2499
2548
  * `user` = your own subject's tokens (per-user, e.g. a personal Telegram bot
package/dist/client.js CHANGED
@@ -2758,6 +2758,25 @@ export class LoomcycleClient {
2758
2758
  query: browseQuery(opts),
2759
2759
  });
2760
2760
  }
2761
+ /** Copy a set of documents into another scope (the Document tool's
2762
+ * `copy_documents`, RFC FT). The copies get new ids and carry their history,
2763
+ * tags, images and the relations between them; a relation to a document
2764
+ * outside the set stays in the source and is listed under `dangling`. A dry
2765
+ * run unless `dry_run: false` — run it first. `opts` as on
2766
+ * {@link LoomcycleClient.document}. */
2767
+ async copyDocuments(input, opts) {
2768
+ return (await this.document({ op: "copy_documents", ...input }, opts));
2769
+ }
2770
+ /** Move a set of documents into another scope, keeping every id (the
2771
+ * Document tool's `move_documents`, RFC FT). The source is removed only once
2772
+ * the target is checked; an interrupted move finishes when the same call
2773
+ * runs again. A dry run unless `dry_run: false`, which then needs
2774
+ * `expect_count` from the dry run. A relation leaving the set refuses the
2775
+ * move unless `dangling: "drop"`. `opts` as on
2776
+ * {@link LoomcycleClient.document}. */
2777
+ async moveDocuments(input, opts) {
2778
+ return (await this.document({ op: "move_documents", ...input }, opts));
2779
+ }
2761
2780
  /** Build the URL of an image chunk's asset (RFC BO) — `GET
2762
2781
  * /v1/_document/asset/{chunkId}`. Attach the bytes to a chunk with the
2763
2782
  * `set_asset` op via {@link LoomcycleClient.document}, then read them here.
@@ -3535,6 +3554,42 @@ export class LoomcycleClient {
3535
3554
  async *streamDocumentChanges(opts) {
3536
3555
  yield* this.streamChangeFeed("/v1/_document/changes", opts);
3537
3556
  }
3557
+ /** Watch one scope's DOCUMENTS change, as a reader (RFC FV). Mirrors
3558
+ * `GET /v1/_document/feed?scope=user|tenant[&scope_id=…][&tenant=…]`.
3559
+ *
3560
+ * Unlike {@link LoomcycleClient.streamDocumentChanges} (the operator's
3561
+ * tenant-wide feed) this is open to a tenant MEMBER, gated like
3562
+ * {@link LoomcycleClient.document}: it names only documents the caller can
3563
+ * list, in the one scope it asked for.
3564
+ *
3565
+ * - The first item is `{ kind: "feed" }`; `payload.enabled === false` means
3566
+ * the server captures no changes — reload on a timer instead of waiting.
3567
+ * - Then one `{ kind: "change" }` per change. Changes of one type to one
3568
+ * document inside one server poll arrive as one.
3569
+ * - There is NO cursor and no resume: the stream starts now. After any
3570
+ * disconnect, reload your view and open a new stream.
3571
+ * - A `{ kind: "error" }` with code `store_unavailable` is non-fatal;
3572
+ * `access_unavailable`, `credential_revoked` and `credential_expired`
3573
+ * close the stream — reload and reconnect with a valid credential.
3574
+ * - The server re-authenticates the stream every 30 s: a revoked grant
3575
+ * stops that document's changes, and a revoked token ends the stream,
3576
+ * within that window; a token's expiry ends it on time.
3577
+ * - At most a few streams per principal (`LOOMCYCLE_DOCUMENT_FEED_MAX_STREAMS`,
3578
+ * default 4); one more is refused with a 429 — a `BackpressureError` with
3579
+ * code `too_many_streams`, not retryable until you close a stream.
3580
+ * - Iteration ends when the server closes the stream, or throws an
3581
+ * `AbortError` when `signal` aborts. */
3582
+ async *documentFeed(opts) {
3583
+ if (opts.scope !== "user" && opts.scope !== "tenant") {
3584
+ throw new Error(`loomcycle: documentFeed scope must be "user" or "tenant", got ${String(opts.scope)}`);
3585
+ }
3586
+ const q = new URLSearchParams({ scope: opts.scope, ...browseQuery(opts) });
3587
+ for await (const ev of this.streamSSEGet(`/v1/_document/feed?${q.toString()}`, opts.signal)) {
3588
+ const frame = toDocumentFeedFrame(ev);
3589
+ if (frame)
3590
+ yield frame;
3591
+ }
3592
+ }
3538
3593
  async *streamChangeFeed(path, opts) {
3539
3594
  const since = opts?.since;
3540
3595
  // The server reads an unparseable or negative `since` as 0 rather than
@@ -3869,6 +3924,26 @@ function toChangeFeedFrame(raw) {
3869
3924
  }
3870
3925
  return null;
3871
3926
  }
3927
+ /** toDocumentFeedFrame types one frame of the reader's document feed, or
3928
+ * returns null for one it does not recognise. `feed` and `error` frames are
3929
+ * read as on the operator feed; a reader `change` carries no `seq`, so it is
3930
+ * recognised by its `document_id`. */
3931
+ function toDocumentFeedFrame(raw) {
3932
+ const shared = toChangeFeedFrame(raw);
3933
+ if (shared?.kind === "feed") {
3934
+ const { since: _since, ...status } = shared.payload;
3935
+ return { kind: "feed", payload: status };
3936
+ }
3937
+ if (shared?.kind === "error")
3938
+ return shared;
3939
+ if (typeof raw.document_id === "string" &&
3940
+ typeof raw.chunk_id === "string" &&
3941
+ typeof raw.type === "string" &&
3942
+ raw.type.startsWith("document.")) {
3943
+ return { kind: "change", payload: raw };
3944
+ }
3945
+ return null;
3946
+ }
3872
3947
  // channelOpPath builds the v0.9.x Channel CRUD URL. Two families:
3873
3948
  // - scope === "global" → /v1/_channels/{channel}/{op}
3874
3949
  // - scope === "user" → /v1/users/{userId}/channels/{channel}/{op}
package/dist/errors.js CHANGED
@@ -66,9 +66,11 @@ const TRANSIENT_CODES = new Set([
66
66
  /** 429 codes that do NOT clear by waiting: the caller has to act first, so
67
67
  * a retry loop on them never ends. `configured_run_cap`: the user already
68
68
  * holds as many configured (not yet started) runs as the operator allows,
69
- * and only starting or discarding one makes room. (A hard token budget,
70
- * `token_limit_exceeded`, has a class of its own outside BackpressureError.) */
71
- const CALLER_ACTION_429_CODES = new Set(["configured_run_cap"]);
69
+ * and only starting or discarding one makes room. `too_many_streams`: the
70
+ * principal already holds as many document feed streams as allowed, and only
71
+ * closing one makes room. (A hard token budget, `token_limit_exceeded`, has a
72
+ * class of its own outside BackpressureError.) */
73
+ const CALLER_ACTION_429_CODES = new Set(["configured_run_cap", "too_many_streams"]);
72
74
  /** Base class for every HTTP 404 the client surfaces. Lets callers
73
75
  * catch any not-found case with a single `instanceof NotFoundError`
74
76
  * check, regardless of which specific resource was missing
package/dist/index.d.ts CHANGED
@@ -77,6 +77,7 @@
77
77
  * // Memory / document change feeds (RFC CD Part C; SSE; substrate:tenant)
78
78
  * streamMemoryChanges(opts?): AsyncIterable<ChangeFeedFrame> // feed | change | error (non-fatal); resume with opts.since = last seq
79
79
  * streamDocumentChanges(opts?): AsyncIterable<ChangeFeedFrame>
80
+ * documentFeed(opts): AsyncIterable<DocumentFeedFrame> // RFC FV: member-safe, one scope, no cursor (reconnect = resync)
80
81
  *
81
82
  * // Interruption (v0.8.16; decline RFC BH)
82
83
  * listUserInterrupts(userId, opts?): Promise<InterruptListResponse>
@@ -157,6 +158,7 @@
157
158
  * // Path VFS + chunked-graph Documents on the wire (v1.4.0 — RFC AL / RFC AK)
158
159
  * path(input): Promise<PathToolResponse> // resolve/ls/stat/mkdir/mv/rm
159
160
  * document(input): Promise<DocumentToolResponse> // 13 ops; needs SQL Memory
161
+ * copyDocuments(input) / moveDocuments(input): Promise<DocumentTransferResult> // RFC FT, dry run by default
160
162
  *
161
163
  * // History — browse/search/annotate past chats (RFC BE; tenant-confined)
162
164
  * history(input): Promise<HistoryToolResponse> // list/get/search/rename/annotate/pin/archive/recap/resume
@@ -216,5 +218,5 @@ export { ClientToolHost, clientToolsURL, CLIENT_TOOL_SUBPROTOCOL } from "./clien
216
218
  export type { ClientToolSchema, ClientToolInvocation, ConnectClientToolsOptions, WebSocketLike, WebSocketCtor, } from "./client-tools.js";
217
219
  export { LoomcycleOAuth, OAuthTokenProvider, parseAuthorizeResponse, pkceChallenge } from "./oauth.js";
218
220
  export type { LoomcycleOAuthOptions, OAuthTokenProviderOptions } from "./oauth.js";
219
- 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, MergeSubjectsResult, SubjectRef, BindSubjectPrincipalResult, ReviewQueueFilter, ReviewQueueGroup, ReviewQueueResult, RuleStatementsResult, RevertRulingResult, RulingBreakdown, RulingItem, RulingSelector, RulingRecord, ListRulingsResult, PolicyRuleCount, ApplyReviewPolicyResult, ErasureBoundSubject, ErasureTokenRef, CancelTurnResult, ReviewRunResult, ReplaySessionResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, UserStatus, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, TokenRestrictions, UserTokenMeta, ListUserTokensResponse, UserIdentity, UserIdentitiesResponse, AuthGateKind, AuthGate, AuthGateKey, AuthGateRemoval, AuthGateProbe, AuthGateListResponse, CreateInviteBody, CreatedInvite, AuthInviteState, AuthInvite, AuthInviteListResponse, CreatedPasswordReset, GateIdentity, GateIdentitiesResponse, GateTenantStatus, 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, DocumentEdgeEvidence, 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, AgentSpeech, 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, UsageBucket, 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, RunFileImportSource, RunFileImportHeading, 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, OAuthServerMetadata, OAuthTokenResponse, OAuthTokenSet, BeginAuthorizeOptions, AuthorizeRequest, AuthorizeResponseParams, CompleteAuthorizeOptions, RefreshTokenOptions, RevokeTokenOptions, TokenProvider, AppClientRefresh, AppClientConfig, ClientDefInput, ClientDefRecord, ConfigAppClient, AppClientEntry, ClientDefListResponse, ClientDefVerifyResult, ClientDefRetireResult, ClientDefNameSummary, ClientDefNamesResponse, DeviceLoginPrompt, DeviceLoginOptions, DeviceLoginResult, } from "./types.js";
221
+ 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, MergeSubjectsResult, SubjectRef, BindSubjectPrincipalResult, ReviewQueueFilter, ReviewQueueGroup, ReviewQueueResult, RuleStatementsResult, RevertRulingResult, RulingBreakdown, RulingItem, RulingSelector, RulingRecord, ListRulingsResult, PolicyRuleCount, ApplyReviewPolicyResult, ErasureBoundSubject, ErasureTokenRef, CancelTurnResult, ReviewRunResult, ReplaySessionResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, UserStatus, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, TokenRestrictions, UserTokenMeta, ListUserTokensResponse, UserIdentity, UserIdentitiesResponse, AuthGateKind, AuthGate, AuthGateKey, AuthGateRemoval, AuthGateProbe, AuthGateListResponse, CreateInviteBody, CreatedInvite, AuthInviteState, AuthInvite, AuthInviteListResponse, CreatedPasswordReset, GateIdentity, GateIdentitiesResponse, GateTenantStatus, 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, DocumentEdgeEvidence, DocumentToolResponse, DocumentCopyInput, DocumentMoveInput, DocumentTransferEntry, DocumentTransferResult, DocumentSearchFilter, DocumentSearchHit, DocumentSearchResult, DocumentRelatedResult, GraphSnapshot, 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, DocumentFeedChange, DocumentFeedChangeType, DocumentFeedFrame, DocumentFeedOptions, DocumentFeedStatus, 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, AgentSpeech, 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, UsageBucket, 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, RunFileImportSource, RunFileImportHeading, 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, OAuthServerMetadata, OAuthTokenResponse, OAuthTokenSet, BeginAuthorizeOptions, AuthorizeRequest, AuthorizeResponseParams, CompleteAuthorizeOptions, RefreshTokenOptions, RevokeTokenOptions, TokenProvider, AppClientRefresh, AppClientConfig, ClientDefInput, ClientDefRecord, ConfigAppClient, AppClientEntry, ClientDefListResponse, ClientDefVerifyResult, ClientDefRetireResult, ClientDefNameSummary, ClientDefNamesResponse, DeviceLoginPrompt, DeviceLoginOptions, DeviceLoginResult, } from "./types.js";
220
222
  export { AclDeniedError, AgentIDInUseError, AgentNotFoundError, AlreadyPausingError, AuthError, BackpressureError, DeviceLoginError, NotFoundError, InsufficientScopeError, InvalidArgumentError, ChannelCursorRegressionError, LoomcycleError, NotPausedError, OAuthError, PauseNotConfiguredError, PerUserQuotaExhaustedError, PromptTooLargeError, RateLimitedError, RequestTooLargeError, SessionBusyError, SessionNotFoundError, SnapshotNotFoundError, SnapshotTooLargeError, SnapshotVersionError, SubstrateToolRefusedError, TokenLimitExceededError, UnavailableError, } from "./errors.js";
package/dist/index.js CHANGED
@@ -77,6 +77,7 @@
77
77
  * // Memory / document change feeds (RFC CD Part C; SSE; substrate:tenant)
78
78
  * streamMemoryChanges(opts?): AsyncIterable<ChangeFeedFrame> // feed | change | error (non-fatal); resume with opts.since = last seq
79
79
  * streamDocumentChanges(opts?): AsyncIterable<ChangeFeedFrame>
80
+ * documentFeed(opts): AsyncIterable<DocumentFeedFrame> // RFC FV: member-safe, one scope, no cursor (reconnect = resync)
80
81
  *
81
82
  * // Interruption (v0.8.16; decline RFC BH)
82
83
  * listUserInterrupts(userId, opts?): Promise<InterruptListResponse>
@@ -157,6 +158,7 @@
157
158
  * // Path VFS + chunked-graph Documents on the wire (v1.4.0 — RFC AL / RFC AK)
158
159
  * path(input): Promise<PathToolResponse> // resolve/ls/stat/mkdir/mv/rm
159
160
  * document(input): Promise<DocumentToolResponse> // 13 ops; needs SQL Memory
161
+ * copyDocuments(input) / moveDocuments(input): Promise<DocumentTransferResult> // RFC FT, dry run by default
160
162
  *
161
163
  * // History — browse/search/annotate past chats (RFC BE; tenant-confined)
162
164
  * history(input): Promise<HistoryToolResponse> // list/get/search/rename/annotate/pin/archive/recap/resume
package/dist/types.d.ts CHANGED
@@ -3767,7 +3767,7 @@ export type DocumentEdgeEvidence = {
3767
3767
  char_end?: number;
3768
3768
  };
3769
3769
  export type DocumentToolInput = {
3770
- op: "create_document" | "get_document" | "documents_summary" | "query_documents" | "delete_document" | "set_path" | "create_chunk" | "upsert_chunk" | "get_chunk" | "update_chunk" | "delete_chunk" | "supersede_chunk" | "graph_recall" | "move_chunk" | "reorder_chunk" | "link_chunks" | "unlink_chunks" | "get_edges" | "get_edge" | "propose_statement" | "accept_statement" | "reject_statement" | "list_statements" | "judge_statements" | "maintain_statement" | "resolve_anchor" | "lease" | "release" | "describe_ontology" | "extract_citations" | "classify" | "accept_classification" | "query_chunks" | "add_tags" | "remove_tags" | "list_tags" | "define_type" | "list_types" | "set_asset" | "get_asset" | "export_md" | "import_md" | "backlinks" | "related" | "unlinked_mentions" | "history" | "get_version" | "diff" | "export_canvas" | "import_canvas" | "list_facts" | "judge_fact" | "verbatim_answer" | "verification_stats" | "remember" | "propose_entity" | "propose_subject" | "search" | "set_remote" | "sync" | "diff_remote";
3770
+ op: "create_document" | "get_document" | "documents_summary" | "query_documents" | "graph_snapshot" | "delete_document" | "set_path" | "copy_documents" | "move_documents" | "create_chunk" | "upsert_chunk" | "get_chunk" | "update_chunk" | "delete_chunk" | "supersede_chunk" | "graph_recall" | "move_chunk" | "reorder_chunk" | "link_chunks" | "unlink_chunks" | "get_edges" | "get_edge" | "propose_statement" | "accept_statement" | "reject_statement" | "list_statements" | "judge_statements" | "maintain_statement" | "resolve_anchor" | "lease" | "release" | "describe_ontology" | "extract_citations" | "classify" | "accept_classification" | "query_chunks" | "add_tags" | "remove_tags" | "list_tags" | "define_type" | "list_types" | "set_asset" | "get_asset" | "export_md" | "import_md" | "backlinks" | "related" | "unlinked_mentions" | "history" | "get_version" | "diff" | "export_canvas" | "import_canvas" | "list_facts" | "judge_fact" | "verbatim_answer" | "verification_stats" | "remember" | "propose_entity" | "propose_subject" | "search" | "set_remote" | "sync" | "diff_remote";
3771
3771
  scope?: "agent" | "user" | "tenant";
3772
3772
  /** Document id (get/delete_document) or chunk id (get/update/delete/move_chunk). */
3773
3773
  id?: string;
@@ -3835,8 +3835,9 @@ export type DocumentToolInput = {
3835
3835
  * names ONE source (chunk_id; session_id + event_seq; or scope + natural_key)
3836
3836
  * and the verbatim quote, which the server checks against that source. */
3837
3837
  evidence?: DocumentEdgeEvidence[];
3838
- /** get_edges (default true) / backlinks (default false): include relations
3839
- * proposed for review. graph_recall (default false): also follow them. */
3838
+ /** get_edges (default true) / backlinks (default false) / graph_snapshot
3839
+ * (default false): include relations proposed for review. graph_recall
3840
+ * (default false): also follow them. */
3840
3841
  include_proposed?: boolean;
3841
3842
  /** get_edges / backlinks / graph_recall / list_facts: also return what has been
3842
3843
  * retired (superseded relations and facts). list_statements: also list
@@ -3848,8 +3849,9 @@ export type DocumentToolInput = {
3848
3849
  /** get_edges: out | in | both (default both). reorder_chunk: up | down. sync /
3849
3850
  * diff_remote: pull (default) | push. */
3850
3851
  direction?: "out" | "in" | "both" | "up" | "down" | "pull" | "push";
3851
- /** get_edges / backlinks / list_statements: the next_cursor of the previous page
3852
- * (list_statements: with the same `order`). */
3852
+ /** get_edges / backlinks / list_statements / graph_snapshot: the next_cursor
3853
+ * of the previous page (list_statements: with the same `order`;
3854
+ * graph_snapshot: `page.next_cursor`). */
3853
3855
  after?: string;
3854
3856
  /** list_statements: only relations with an evidence row quoting a chunk of
3855
3857
  * this document. (`document_id` keeps relations with either end in it.) */
@@ -3873,6 +3875,9 @@ export type DocumentToolInput = {
3873
3875
  hops?: 1;
3874
3876
  budget_chars?: number;
3875
3877
  };
3878
+ /** search: also return `query_xyz`, the query placed on the scope's 3D map
3879
+ * (the axes of graph_snapshot's `projection` block). Absent without a map. */
3880
+ with_projection?: boolean;
3876
3881
  /** related: a chunk whose neighbours BY RELATION to return as `linked`. */
3877
3882
  related_to?: string;
3878
3883
  /** import_md: the markdown is a new edition of document_id / work_key. */
@@ -3911,11 +3916,41 @@ export type DocumentToolInput = {
3911
3916
  /** search / related: never chunks of documents named at or under these paths. */
3912
3917
  exclude_under_paths?: string[];
3913
3918
  /** documents_summary: the documents to summarize. search / related: return
3914
- * only chunks of these documents. */
3919
+ * only chunks of these documents. copy_documents / move_documents: the
3920
+ * documents to copy or move. */
3915
3921
  document_ids?: string[];
3922
+ /** copy_documents / move_documents: the scope the documents go to (`scope`
3923
+ * is where they are). */
3924
+ to_scope?: "agent" | "user" | "tenant";
3925
+ /** copy_documents / move_documents: Path prefixes to rewrite, from → to;
3926
+ * the longest wins. */
3927
+ path_map?: Record<string, string>;
3928
+ /** copy_documents / move_documents: true (the default) reports without
3929
+ * writing. */
3930
+ dry_run?: boolean;
3931
+ /** move_documents: relations leaving the set refuse the move (`refuse`, the
3932
+ * default) or are deleted with the source (`drop`). */
3933
+ dangling?: "refuse" | "drop";
3934
+ /** move_documents: required with `dry_run: false` — the dry run's
3935
+ * `counts.documents`. */
3936
+ expect_count?: number;
3916
3937
  /** search / related: never chunks of these documents (e.g. the document under
3917
3938
  * review, so its own text is not found as evidence for itself). */
3918
3939
  exclude_document_ids?: string[];
3940
+ /** graph_snapshot: only the documents holding these chunks (with
3941
+ * `document_ids`, the union). A chunk of a document the caller may not read
3942
+ * selects nothing, as a missing id does. */
3943
+ chunk_ids?: string[];
3944
+ /** graph_snapshot: the sections to return (default all but `projection`).
3945
+ * `chunks` needs `documents`; `edges`, `facts` and `projection` need
3946
+ * `chunks`. */
3947
+ include?: Array<"documents" | "chunks" | "edges" | "dirents" | "facts" | "projection">;
3948
+ /** graph_snapshot: documents per page (default 200, at most 1000 — a larger
3949
+ * value is lowered, never refused). A page always holds whole documents. */
3950
+ page_documents?: number;
3951
+ /** graph_snapshot: the most relations one page returns (default 50000, at
3952
+ * most 200000); `edges.truncated` says it was reached. */
3953
+ edge_budget?: number;
3919
3954
  /** search / related: chunk types, each including its ontology subtypes (with
3920
3955
  * `type`, the union of both). */
3921
3956
  types?: string[];
@@ -4030,6 +4065,96 @@ export type DocumentToolInput = {
4030
4065
  * `create_document` returns `{document_id, root_chunk_id, ...}`). */
4031
4066
  export type PathToolResponse = unknown;
4032
4067
  export type DocumentToolResponse = unknown;
4068
+ /** The set and target of {@link LoomcycleClient.copyDocuments} and
4069
+ * {@link LoomcycleClient.moveDocuments} — the Document tool's copy_documents
4070
+ * and move_documents, in their wire shape. `document_ids`, `under_path` and
4071
+ * `under_paths` combine (at most 500 documents). `dry_run` defaults to true:
4072
+ * the call reports and writes nothing. */
4073
+ export interface DocumentCopyInput {
4074
+ /** Where the documents are (default `user`). */
4075
+ scope?: "agent" | "user" | "tenant";
4076
+ /** Where they go. A copy into `scope` itself needs `path_map`. */
4077
+ to_scope: "agent" | "user" | "tenant";
4078
+ document_ids?: string[];
4079
+ under_path?: string;
4080
+ under_paths?: string[];
4081
+ /** Path prefixes to rewrite, from → to; the longest matching prefix wins. */
4082
+ path_map?: Record<string, string>;
4083
+ dry_run?: boolean;
4084
+ }
4085
+ /** {@link DocumentCopyInput} plus what a move adds. A move keeps every id and
4086
+ * removes the documents from `scope`; `to_scope` must differ from it. */
4087
+ export interface DocumentMoveInput extends DocumentCopyInput {
4088
+ /** Relations between a moved document and one outside the set: `refuse`
4089
+ * (default) refuses the move, `drop` deletes them with the source. */
4090
+ dangling?: "refuse" | "drop";
4091
+ /** Required with `dry_run: false`: the dry run's `counts.documents`. The
4092
+ * move is refused, and nothing moves, when the set changed since. */
4093
+ expect_count?: number;
4094
+ }
4095
+ /** A document of the set, as the answer reports it. */
4096
+ export interface DocumentTransferEntry {
4097
+ id: string;
4098
+ /** A real copy's new id. A move keeps `id`. */
4099
+ new_id?: string;
4100
+ /** The names it has (or would have) in `to_scope`. */
4101
+ paths: string[];
4102
+ /** A move's target an earlier, interrupted call of the same move wrote. */
4103
+ resumed?: boolean;
4104
+ }
4105
+ /** What copyDocuments / moveDocuments answer, dry run or real. Fields a call
4106
+ * did not produce are absent. */
4107
+ export interface DocumentTransferResult {
4108
+ scope: string;
4109
+ to_scope: string;
4110
+ dry_run: boolean;
4111
+ documents: DocumentTransferEntry[];
4112
+ /** documents, chunks, statements, revisions, assets; units after a real call. */
4113
+ counts: Record<string, number>;
4114
+ /** Documents left out, by code: not_found, is_ontology, is_subject,
4115
+ * holds_facts, forbidden, path_collision, key_collision, write_failed, and
4116
+ * for a move id_collision. Capped at 200; `refused_count` is exact. */
4117
+ refused: {
4118
+ document_id: string;
4119
+ code: string;
4120
+ detail?: string;
4121
+ }[];
4122
+ refused_count?: number;
4123
+ /** Relations with an end (or evidence) outside the set. Capped at 200;
4124
+ * `dangling_count` is exact. */
4125
+ dangling: {
4126
+ statement_id: string;
4127
+ kind: string;
4128
+ from: string;
4129
+ to: string;
4130
+ outside: string;
4131
+ }[];
4132
+ dangling_count: number;
4133
+ /** Move, dry run: `dangling_relations` when the real move would be refused. */
4134
+ blocked_by?: string;
4135
+ /** Move with `dangling: "drop"`: the relations deleted. */
4136
+ dropped?: number;
4137
+ /** Move, dry run: documents an interrupted move took out of `scope`, which
4138
+ * the real call names in `to_scope`. */
4139
+ to_finish?: string[];
4140
+ /** Move, real: the ids now in `to_scope`. */
4141
+ moved?: string[];
4142
+ /** Move, real: written to `to_scope` but not moved; the source is kept. Run
4143
+ * the same call again. */
4144
+ unfinished?: {
4145
+ document_id: string;
4146
+ code: string;
4147
+ detail?: string;
4148
+ }[];
4149
+ name_failures?: {
4150
+ document_id: string;
4151
+ path: string;
4152
+ error: string;
4153
+ }[];
4154
+ body_failures?: number;
4155
+ statements_failed?: number;
4156
+ statement_error?: string;
4157
+ }
4033
4158
  /** What a filtered `document({op:"search"|"related", …})` call resolved its
4034
4159
  * structural filter to — present on the response ONLY when a filter argument
4035
4160
  * was passed (a filter-free response has no `filter` key). */
@@ -4088,6 +4213,9 @@ export type DocumentSearchResult = {
4088
4213
  filter?: DocumentSearchFilter;
4089
4214
  reranked?: boolean;
4090
4215
  rerank_reason?: string;
4216
+ /** With `with_projection` and a map for the scope: the query's place on it
4217
+ * (4 decimals). */
4218
+ query_xyz?: [number, number, number];
4091
4219
  };
4092
4220
  /** Response of `document({op:"related"})` — narrow a {@link DocumentToolResponse}
4093
4221
  * to it. */
@@ -4103,6 +4231,108 @@ export type DocumentRelatedResult = {
4103
4231
  }>;
4104
4232
  filter?: DocumentSearchFilter;
4105
4233
  };
4234
+ /** Response of `document({op:"graph_snapshot"})` — narrow a
4235
+ * {@link DocumentToolResponse} to it. Columnar: every array of a section is
4236
+ * parallel (position `i` of each describes one item). An `*_idx` column is a
4237
+ * position in another section of the same response; a `*_code` column is a
4238
+ * position in the matching `codes` list, `-1` = none. Timestamps are unix
4239
+ * nanoseconds. Documents the caller may not read are absent, with their
4240
+ * chunks, the relations into them and their Path names. */
4241
+ export type GraphSnapshot = {
4242
+ page: {
4243
+ /** Documents on this page — always whole documents, in id order. */
4244
+ documents: number;
4245
+ /** Pass as `after` for the next page; absent on the last one. */
4246
+ next_cursor?: string;
4247
+ /** Present when the SQL Memory row cap fitted fewer documents than asked. */
4248
+ clamped_to?: number;
4249
+ };
4250
+ codes: {
4251
+ types: string[];
4252
+ statuses: string[];
4253
+ kinds: string[];
4254
+ fact_classes: string[];
4255
+ methods: string[];
4256
+ };
4257
+ documents?: {
4258
+ ids: string[];
4259
+ titles: string[];
4260
+ root_chunk_ids: string[];
4261
+ type_code: number[];
4262
+ status_code: number[];
4263
+ created_at: number[];
4264
+ updated_at: number[];
4265
+ color_enabled: boolean[];
4266
+ color_scheme: Array<Record<string, unknown> | null>;
4267
+ /** Every Path name of each document, shortest first. */
4268
+ paths: string[][];
4269
+ };
4270
+ chunks?: {
4271
+ ids: string[];
4272
+ document_idx: number[];
4273
+ /** -1 = a root. Always an earlier position: parents come first. */
4274
+ parent_idx: number[];
4275
+ position: number[];
4276
+ type_code: number[];
4277
+ status_code: number[];
4278
+ titles: string[];
4279
+ valid_at: Array<number | null>;
4280
+ invalid_at: Array<number | null>;
4281
+ updated_at: number[];
4282
+ /** Only with `include` naming `facts`. */
4283
+ is_fact?: boolean[];
4284
+ fact_class_code?: number[];
4285
+ fact_confidence?: Array<number | null>;
4286
+ fact_retired?: boolean[];
4287
+ };
4288
+ edges?: {
4289
+ ids: string[];
4290
+ /** A chunk position, or a negative `external[].idx`. */
4291
+ from_idx: number[];
4292
+ to_idx: number[];
4293
+ kind_code: number[];
4294
+ auto: boolean[];
4295
+ created_at: number[];
4296
+ status_code: number[];
4297
+ method_code: number[];
4298
+ confidence: Array<number | null>;
4299
+ valid_at: Array<number | null>;
4300
+ invalid_at: Array<number | null>;
4301
+ /** Ends on another page (or outside the selection). */
4302
+ external: Array<{
4303
+ idx: number;
4304
+ id: string;
4305
+ document_id: string;
4306
+ }>;
4307
+ /** True when `edge_budget` stopped the list. */
4308
+ truncated: boolean;
4309
+ };
4310
+ /** First page only. */
4311
+ dirents?: {
4312
+ paths: string[];
4313
+ kinds: Array<"directory" | "document">;
4314
+ /** A position in `documents` when the document is on this page, else -1. */
4315
+ document_idx: number[];
4316
+ /** The document a name points at ("" for a directory), whatever its page. */
4317
+ document_ids: string[];
4318
+ };
4319
+ /** Only with `include` naming `projection`: each chunk's place on the
4320
+ * scope's 3D map by meaning. `method` says how the map was fitted: `pca`
4321
+ * (the embedding on the scope's three principal axes) or `umap` (a layout
4322
+ * that keeps each chunk's nearest neighbours near it, so a document's
4323
+ * chunks stay together); absent while the projection is off. `model` is
4324
+ * the embedder ("<provider>/<model>"); `basis_version` 0 means no map yet,
4325
+ * with `xyz` empty and every chunk missing. Otherwise `xyz` is one x, y, z
4326
+ * triple per chunk in `chunks.ids` order (4 decimals), and a chunk with no
4327
+ * place on the current map is 0, 0, 0 with its position in `missing`. */
4328
+ projection?: {
4329
+ model: string;
4330
+ basis_version: number;
4331
+ method?: "pca" | "umap";
4332
+ xyz: number[];
4333
+ missing: number[];
4334
+ };
4335
+ };
4106
4336
  /** Input for {@link LoomcycleClient.history} — the RFC BE History tool
4107
4337
  * (POST /v1/_history). Browse/search/annotate PAST CHATS (a chat = a session).
4108
4338
  * Op-discriminated; the owner is resolved server-side from the authenticated
@@ -7084,7 +7314,10 @@ export interface ForkTeamOptions extends CreateTeamOptions {
7084
7314
  * {@link LoomcycleClient.streamMemoryChanges}, `document.chunk.*` on
7085
7315
  * {@link LoomcycleClient.streamDocumentChanges}. Mirrors the runtime's
7086
7316
  * `store.MemoryChangeType`. */
7087
- export type MemoryChangeType = "memory.set" | "memory.delete" | "memory.scope_deleted" | "document.chunk.updated" | "document.chunk.deleted";
7317
+ export type MemoryChangeType = "memory.set" | "memory.delete" | "memory.scope_deleted" | "document.chunk.updated" | "document.chunk.deleted"
7318
+ /** A statement (a link between chunks) was written, ruled on or removed —
7319
+ * one per endpoint document (RFC FV). */
7320
+ | "document.edges.changed";
7088
7321
  /** The memory scope a change landed in. `global` is listed because the
7089
7322
  * runtime's scope enum has it and the feed passes the written scope through
7090
7323
  * unchanged, not because Memory writes it today. */
@@ -7108,6 +7341,10 @@ export interface MemoryChange {
7108
7341
  scope_id: string;
7109
7342
  key?: string;
7110
7343
  chunk_id?: string;
7344
+ /** The document a `document.*` change belongs to, recorded when the write
7345
+ * happened (RFC FV). Absent on a row whose writer did not say, and on rows
7346
+ * from a runtime older than the field. */
7347
+ document_id?: string;
7111
7348
  /** RFC3339 time of the write. */
7112
7349
  at: string;
7113
7350
  }
@@ -7187,6 +7424,60 @@ export interface StreamChangesOptions {
7187
7424
  /** Abort to close the stream; the iterator then throws an `AbortError`. */
7188
7425
  signal?: AbortSignal;
7189
7426
  }
7427
+ /** The change types {@link LoomcycleClient.documentFeed} carries. */
7428
+ export type DocumentFeedChangeType = "document.chunk.updated" | "document.chunk.deleted" | "document.edges.changed";
7429
+ /** One reader-feed change: a document the caller can list changed. NO cursor
7430
+ * — the reader feed never sends a seq, and a reconnect is a resync. Several
7431
+ * changes of one type to one document inside one server poll arrive as one,
7432
+ * naming the latest chunk. Value-free: refetch the document (e.g. through
7433
+ * `document({op:"graph_snapshot", document_ids:[…]})`). */
7434
+ export interface DocumentFeedChange {
7435
+ type: DocumentFeedChangeType;
7436
+ /** The chunk changed; for `document.edges.changed`, the statement's endpoint
7437
+ * in this document. */
7438
+ chunk_id: string;
7439
+ document_id: string;
7440
+ /** RFC3339 time of the write. */
7441
+ at: string;
7442
+ }
7443
+ /** The reader feed's opening frame (`event: feed`). Only `enabled`: no
7444
+ * cursor, and no embedder health (that is the operator feed's). */
7445
+ export interface DocumentFeedStatus {
7446
+ /** `false` when the server does not capture changes
7447
+ * (`LOOMCYCLE_MEMORY_CHANGES_ENABLED` unset): the stream stays open and NO
7448
+ * change will arrive — fall back to reloading on a timer. */
7449
+ enabled: boolean;
7450
+ }
7451
+ /** Yielded by {@link LoomcycleClient.documentFeed}: `{ kind: "feed" }` first,
7452
+ * then one `{ kind: "change" }` per change. An `error` item with code
7453
+ * `store_unavailable` is non-fatal (the server retries). These end the
7454
+ * stream: `access_unavailable` (the caller's access could not be re-checked),
7455
+ * `credential_revoked` (the credential no longer authenticates or is no longer
7456
+ * admitted) and `credential_expired` (the token's lifetime ended) — reload,
7457
+ * and reconnect with a valid credential. */
7458
+ export type DocumentFeedFrame = {
7459
+ kind: "feed";
7460
+ payload: DocumentFeedStatus;
7461
+ } | {
7462
+ kind: "change";
7463
+ payload: DocumentFeedChange;
7464
+ } | {
7465
+ kind: "error";
7466
+ payload: ChangeFeedError;
7467
+ };
7468
+ /** Options for {@link LoomcycleClient.documentFeed}. */
7469
+ export interface DocumentFeedOptions {
7470
+ /** The scope to watch. `agent` is not served: agent scopes are private to
7471
+ * their runs. */
7472
+ scope: "user" | "tenant";
7473
+ /** RFC AS browse override: watch another subject's user scope you may see
7474
+ * (sent as `?scope_id=`). */
7475
+ scopeId?: string;
7476
+ /** An admin's tenant focus (sent as `?tenant=`); ignored for anyone else. */
7477
+ tenant?: string;
7478
+ /** Abort to close the stream; the iterator then throws an `AbortError`. */
7479
+ signal?: AbortSignal;
7480
+ }
7190
7481
  /** The access-control rollout mode a deployment runs in. */
7191
7482
  export type AclMode = "compat" | "shadow" | "enforce";
7192
7483
  /** Marks an entry the config declares rather than the store holds. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@loomcycle/client",
3
- "version": "1.134.0",
3
+ "version": "1.136.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",