@loomcycle/client 1.45.0 → 1.46.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.
@@ -286,6 +286,44 @@ class LoomcycleClient {
286
286
  * `applied` is "live", "marker", or "noop". Mirrors
287
287
  * POST /v1/runs/{run_id}/compact.
288
288
  */
289
+ /**
290
+ * List the subjects with activity in a tenant (loomcycle v1.46.0+).
291
+ *
292
+ * A "user" here is DERIVED from run activity, not a stored record — there is no
293
+ * create or update, and removing a subject's footprint is
294
+ * {@link erasureExecute}.
295
+ */
296
+ async directoryUsers(opts) {
297
+ const q = opts?.tenant !== undefined
298
+ ? `?tenant=${encodeURIComponent(opts.tenant)}`
299
+ : "";
300
+ return (0, fetch_helpers_js_1.jsonFetch)(this.ctx, `/v1/_users${q}`, opts);
301
+ }
302
+ /**
303
+ * Aggregate one subject's activity, chats, memory, documents, budget and usage
304
+ * in a single call (loomcycle v1.46.0+).
305
+ *
306
+ * An admin token MUST pass `tenant` — a subject id is only unique within one, so
307
+ * the server refuses rather than guessing (`""` selects the default tenant on a
308
+ * single-tenant install). A tenant-scoped principal is confined regardless.
309
+ */
310
+ async directoryInspect(subject, opts) {
311
+ const q = opts?.tenant !== undefined
312
+ ? `?tenant=${encodeURIComponent(opts.tenant)}`
313
+ : "";
314
+ return (0, fetch_helpers_js_1.jsonFetch)(this.ctx, `/v1/_users/${encodeURIComponent(subject)}${q}`, opts);
315
+ }
316
+ /**
317
+ * Enumerate tenants with derived counts (loomcycle v1.46.0+). **Requires an
318
+ * operator-admin token** — the list of tenants is itself cross-tenant
319
+ * information, so a scoped token is refused rather than given a filtered list.
320
+ *
321
+ * Derived from runs: a tenant that has never started a run does not appear, so
322
+ * an empty list means no ACTIVITY, not no tenants.
323
+ */
324
+ async directoryTenants(opts) {
325
+ return (0, fetch_helpers_js_1.jsonFetch)(this.ctx, "/v1/_tenants", opts);
326
+ }
289
327
  /**
290
328
  * Report what this deployment holds about one SUBJECT, in three tiers
291
329
  * separated by what they guarantee (RFC BL P5). Read-only.
package/dist/client.d.ts CHANGED
@@ -25,7 +25,7 @@
25
25
  */
26
26
  import { InteractiveSession } from "./interactive.js";
27
27
  import { ClientToolHost, type ConnectClientToolsOptions } from "./client-tools.js";
28
- import type { ErasureReport, ErasureResult, Agent, AgentEvent, AgentStatus, CancelAgentResult, ClientOptions, ContinueOptions, CreateSnapshotOptions, EnsureCodeAgentOptions, EnsureCodeAgentResult, EnsureMcpServerOptions, EnsureMcpServerResult, HealthResponse, Hook, InterruptListResponse, InterruptStatus, AckChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAckResult, ChannelAwaitResult, ChannelBroadcastResult, ChannelDescriptor, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelSubscribeResult, CreateChannelOptions, ListChannelsResponse, PeekChannelOptions, PublishChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, SubscribeChannelOptions, UpdateChannelOptions, LibraryAgentDefinition, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, ListUsersResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, MCPServerDefVerifyResult, MemoryEntriesResponse, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopesResponse, PauseResult, PersistentVolumesResponse, EphemeralVolumesResponse, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, ReplaySessionResult, CancelTurnResult, RunBatchOptions, RunBatchResult, RunOptions, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, ListTeamsResponse, TeamDefDetail, TeamDiagram, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, TranscriptResponse, WhoamiResponse, UsageDimension, UsageReportResponse, TokenLimit, TokenLimitsResponse, ConfigResponse, SetTokenLimitRequest } from "./types.js";
28
+ import type { DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResult, Agent, AgentEvent, AgentStatus, CancelAgentResult, ClientOptions, ContinueOptions, CreateSnapshotOptions, EnsureCodeAgentOptions, EnsureCodeAgentResult, EnsureMcpServerOptions, EnsureMcpServerResult, HealthResponse, Hook, InterruptListResponse, InterruptStatus, AckChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAckResult, ChannelAwaitResult, ChannelBroadcastResult, ChannelDescriptor, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelSubscribeResult, CreateChannelOptions, ListChannelsResponse, PeekChannelOptions, PublishChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, SubscribeChannelOptions, UpdateChannelOptions, LibraryAgentDefinition, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, ListUsersResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, MCPServerDefVerifyResult, MemoryEntriesResponse, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopesResponse, PauseResult, PersistentVolumesResponse, EphemeralVolumesResponse, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, ReplaySessionResult, CancelTurnResult, RunBatchOptions, RunBatchResult, RunOptions, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, ListTeamsResponse, TeamDefDetail, TeamDiagram, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, TranscriptResponse, WhoamiResponse, UsageDimension, UsageReportResponse, TokenLimit, TokenLimitsResponse, ConfigResponse, SetTokenLimitRequest } from "./types.js";
29
29
  export declare class LoomcycleClient {
30
30
  private ctx;
31
31
  constructor(opts?: ClientOptions);
@@ -139,6 +139,45 @@ export declare class LoomcycleClient {
139
139
  * `applied` is "live", "marker", or "noop". Mirrors
140
140
  * POST /v1/runs/{run_id}/compact.
141
141
  */
142
+ /**
143
+ * List the subjects with activity in a tenant (loomcycle v1.46.0+).
144
+ *
145
+ * A "user" here is DERIVED from run activity, not a stored record — there is no
146
+ * create or update, and removing a subject's footprint is
147
+ * {@link erasureExecute}.
148
+ */
149
+ directoryUsers(opts?: {
150
+ tenant?: string;
151
+ signal?: AbortSignal;
152
+ }): Promise<{
153
+ users: DirectoryUser[];
154
+ }>;
155
+ /**
156
+ * Aggregate one subject's activity, chats, memory, documents, budget and usage
157
+ * in a single call (loomcycle v1.46.0+).
158
+ *
159
+ * An admin token MUST pass `tenant` — a subject id is only unique within one, so
160
+ * the server refuses rather than guessing (`""` selects the default tenant on a
161
+ * single-tenant install). A tenant-scoped principal is confined regardless.
162
+ */
163
+ directoryInspect(subject: string, opts?: {
164
+ tenant?: string;
165
+ signal?: AbortSignal;
166
+ }): Promise<DirectoryInspection>;
167
+ /**
168
+ * Enumerate tenants with derived counts (loomcycle v1.46.0+). **Requires an
169
+ * operator-admin token** — the list of tenants is itself cross-tenant
170
+ * information, so a scoped token is refused rather than given a filtered list.
171
+ *
172
+ * Derived from runs: a tenant that has never started a run does not appear, so
173
+ * an empty list means no ACTIVITY, not no tenants.
174
+ */
175
+ directoryTenants(opts?: {
176
+ signal?: AbortSignal;
177
+ }): Promise<{
178
+ tenants: DirectoryTenant[];
179
+ notes?: string[];
180
+ }>;
142
181
  /**
143
182
  * Report what this deployment holds about one SUBJECT, in three tiers
144
183
  * separated by what they guarantee (RFC BL P5). Read-only.
package/dist/client.js CHANGED
@@ -283,6 +283,44 @@ export class LoomcycleClient {
283
283
  * `applied` is "live", "marker", or "noop". Mirrors
284
284
  * POST /v1/runs/{run_id}/compact.
285
285
  */
286
+ /**
287
+ * List the subjects with activity in a tenant (loomcycle v1.46.0+).
288
+ *
289
+ * A "user" here is DERIVED from run activity, not a stored record — there is no
290
+ * create or update, and removing a subject's footprint is
291
+ * {@link erasureExecute}.
292
+ */
293
+ async directoryUsers(opts) {
294
+ const q = opts?.tenant !== undefined
295
+ ? `?tenant=${encodeURIComponent(opts.tenant)}`
296
+ : "";
297
+ return jsonFetch(this.ctx, `/v1/_users${q}`, opts);
298
+ }
299
+ /**
300
+ * Aggregate one subject's activity, chats, memory, documents, budget and usage
301
+ * in a single call (loomcycle v1.46.0+).
302
+ *
303
+ * An admin token MUST pass `tenant` — a subject id is only unique within one, so
304
+ * the server refuses rather than guessing (`""` selects the default tenant on a
305
+ * single-tenant install). A tenant-scoped principal is confined regardless.
306
+ */
307
+ async directoryInspect(subject, opts) {
308
+ const q = opts?.tenant !== undefined
309
+ ? `?tenant=${encodeURIComponent(opts.tenant)}`
310
+ : "";
311
+ return jsonFetch(this.ctx, `/v1/_users/${encodeURIComponent(subject)}${q}`, opts);
312
+ }
313
+ /**
314
+ * Enumerate tenants with derived counts (loomcycle v1.46.0+). **Requires an
315
+ * operator-admin token** — the list of tenants is itself cross-tenant
316
+ * information, so a scoped token is refused rather than given a filtered list.
317
+ *
318
+ * Derived from runs: a tenant that has never started a run does not appear, so
319
+ * an empty list means no ACTIVITY, not no tenants.
320
+ */
321
+ async directoryTenants(opts) {
322
+ return jsonFetch(this.ctx, "/v1/_tenants", opts);
323
+ }
286
324
  /**
287
325
  * Report what this deployment holds about one SUBJECT, in three tiers
288
326
  * separated by what they guarantee (RFC BL P5). Read-only.
package/dist/index.d.ts CHANGED
@@ -111,5 +111,5 @@ export { InteractiveSession } from "./interactive.js";
111
111
  export type { InteractiveSessionOps } from "./interactive.js";
112
112
  export { ClientToolHost, clientToolsURL, CLIENT_TOOL_SUBPROTOCOL } from "./client-tools.js";
113
113
  export type { ClientToolSchema, ClientToolInvocation, ConnectClientToolsOptions, WebSocketLike, WebSocketCtor, } from "./client-tools.js";
114
- export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, SamplingOptions, CompactionOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, CancelAgentResult, ListAgentsResponse, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, CancelTurnResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, WhoamiResponse, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, Hook, HookFailMode, HookPhase, HookToolCall, HookToolResult, ListHooksResponse, PostHookCall, PostHookResult, PreHookCall, PreHookResult, RegisterHookOptions, RegisterHookResponse, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, TeamDefDetail, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, VolumeMode, PersistentVolumeEntry, PersistentVolumesResponse, EphemeralVolumeEntry, EphemeralVolumesResponse, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAwaitEntry, ChannelAwaitMode, ChannelAwaitResult, ChannelBroadcastEntry, ChannelBroadcastResult, CreateChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, EnsureMcpServerOptions, EnsureMcpServerResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, AgentDefOverlay, EnsureCodeAgentOptions, EnsureCodeAgentResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, LimitInfo, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, } from "./types.js";
114
+ export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, SamplingOptions, CompactionOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, CancelAgentResult, ListAgentsResponse, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, DirectoryBudget, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, CancelTurnResult, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, WhoamiResponse, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, Hook, HookFailMode, HookPhase, HookToolCall, HookToolResult, ListHooksResponse, PostHookCall, PostHookResult, PreHookCall, PreHookResult, RegisterHookOptions, RegisterHookResponse, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, TeamDefDetail, TeamRunResult, PathToolInput, PathToolResponse, DocumentToolInput, DocumentToolResponse, HistoryToolInput, HistoryToolResponse, VolumeMode, PersistentVolumeEntry, PersistentVolumesResponse, EphemeralVolumeEntry, EphemeralVolumesResponse, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ChannelPublishResult, ChannelPurgeResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAwaitEntry, ChannelAwaitMode, ChannelAwaitResult, ChannelBroadcastEntry, ChannelBroadcastResult, CreateChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, EnsureMcpServerOptions, EnsureMcpServerResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, AgentDefOverlay, EnsureCodeAgentOptions, EnsureCodeAgentResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, LimitInfo, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, } from "./types.js";
115
115
  export { AgentIDInUseError, AgentNotFoundError, AlreadyPausingError, AuthError, BackpressureError, HookNotFoundError, NotFoundError, InvalidArgumentError, ChannelCursorRegressionError, LoomcycleError, NotPausedError, PauseNotConfiguredError, PerUserQuotaExhaustedError, SessionBusyError, SessionNotFoundError, SnapshotNotFoundError, SnapshotTooLargeError, SnapshotVersionError, SubstrateToolRefusedError, UnavailableError, } from "./errors.js";
package/dist/types.d.ts CHANGED
@@ -429,6 +429,57 @@ export interface RunBatchResult {
429
429
  /** Result of {@link LoomcycleClient.compactRun}. `applied` is "live" (pushed to
430
430
  * the running loop), "marker" (persisted for a terminal run's next
431
431
  * continuation), or "noop" (too short to compact). */
432
+ /**
433
+ * One DERIVED user (RFC-free: a user is a GROUP BY over run activity, not a
434
+ * stored record — so there is no profile here and no way to create one).
435
+ */
436
+ export interface DirectoryUser {
437
+ subject: string;
438
+ running_count: number;
439
+ total_count: number;
440
+ /** RFC3339 UTC; absent when the subject has never started a run. */
441
+ last_started_at?: string;
442
+ }
443
+ /**
444
+ * Token budget for a subject. Both bounds are OPTIONAL because absent and zero
445
+ * differ: absent is "no ceiling at this tier", zero would refuse every run.
446
+ */
447
+ export interface DirectoryBudget {
448
+ soft_limit?: number;
449
+ hard_limit?: number;
450
+ }
451
+ /**
452
+ * One subject's aggregate view (loomcycle v1.46.0+) — the five surfaces an
453
+ * operator otherwise visits separately.
454
+ *
455
+ * `documents` is absent rather than 0 when SQL Memory is not configured: the
456
+ * plane was NOT examined, which is a different statement from empty. Likewise a
457
+ * non-empty `errors` means a plane could not be read, so every count is a LOWER
458
+ * BOUND — do not present the numbers as complete.
459
+ */
460
+ export interface DirectoryInspection {
461
+ tenant: string;
462
+ subject: string;
463
+ activity: DirectoryUser;
464
+ chats: number;
465
+ /** Per scope, not one number: the subject's own rows and what a shared agent
466
+ * holds ABOUT them are different things. */
467
+ memory: Record<string, number>;
468
+ documents?: number;
469
+ budget?: DirectoryBudget;
470
+ usage: {
471
+ calls: number;
472
+ cost: number;
473
+ };
474
+ errors?: string[];
475
+ notes?: string[];
476
+ }
477
+ /** One tenant with derived counts. */
478
+ export interface DirectoryTenant {
479
+ tenant: string;
480
+ users: number;
481
+ runs: number;
482
+ }
432
483
  /**
433
484
  * One tier's per-plane counts in an erasure report.
434
485
  *
@@ -959,7 +1010,7 @@ export type PathToolInput = {
959
1010
  * requires the operator to grant BOTH `memory_scopes` and `sql_scopes` with
960
1011
  * `tenant`, since a document spans both planes. */
961
1012
  export type DocumentToolInput = {
962
- op: "create_document" | "get_document" | "delete_document" | "set_path" | "create_chunk" | "get_chunk" | "update_chunk" | "delete_chunk" | "move_chunk" | "link_chunks" | "unlink_chunks" | "query_chunks" | "define_type" | "list_types" | "export_md" | "import_md";
1013
+ 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" | "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";
963
1014
  scope?: "agent" | "user" | "tenant";
964
1015
  /** Document id (get/delete_document) or chunk id (get/update/delete/move_chunk). */
965
1016
  id?: string;
@@ -973,9 +1024,25 @@ export type DocumentToolInput = {
973
1024
  body?: string;
974
1025
  fields?: Record<string, unknown>;
975
1026
  status?: string;
1027
+ /** The chunk's or document's tags (RFC BS). create/update/upsert_chunk +
1028
+ * create_document replace-set the whole set (omit = unchanged, [] = clear);
1029
+ * add_tags/remove_tags take the tags to change. Nested tags use a slash. */
1030
+ tags?: string[];
1031
+ /** query_chunks / query_documents: return only items carrying exactly this tag. */
1032
+ tag?: string;
1033
+ /** query_chunks: match this tag OR anything nested under it (prefix + '/'). */
1034
+ tag_prefix?: string;
976
1035
  position?: number;
977
- /** update_chunk: the chunk's current revision (optimistic concurrency). */
1036
+ /** update_chunk: the chunk's current revision (optimistic concurrency).
1037
+ * get_version: the historical revision to fetch. */
978
1038
  revision?: number;
1039
+ /** diff (RFC BS): the two chunk revisions to compare (from_revision →
1040
+ * to_revision), producing a unified-diff text. */
1041
+ from_revision?: number;
1042
+ to_revision?: number;
1043
+ /** import_canvas (RFC BS): a node/edge canvas graph to build a document from
1044
+ * (the shape export_canvas emits). Opaque here; the backend owns the schema. */
1045
+ canvas?: unknown;
979
1046
  from_id?: string;
980
1047
  to_id?: string;
981
1048
  kind?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@loomcycle/client",
3
- "version": "1.45.0",
3
+ "version": "1.46.0",
4
4
  "description": "TypeScript client for the loomcycle sidecar (HTTP+SSE). 64 methods covering run streaming, agent metadata, pause/resume/state, resolver re-probe (resolveProbe \u2014 issue #88 operator escape hatch), operator-token admin (operatorTokenDef \u2014 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 \u2014 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 \u2014 direct provider routing without agent overhead; primary target is n8n's LoomCycleChatModel AI Agent sub-node and any LangChain-compatible consumer). v0.10.1 \u2014 dual ESM + CommonJS distribution (additive \u2014 ESM consumers unchanged; CJS consumers like n8n's community-node loader now work). v0.19.0 \u2014 typed inline code-js agent ingestion (AgentDefOverlay.code_body + ensureCodeAgent \u2014 register a deterministic code agent through the substrate with no host filesystem bind; RFC J). v0.20.0 \u2014 ensureMcpServer surfaces discoveredToolCount straight from create (loomcycle now auto-discovers MCP tools at ingestion); rediscover is now an explicit force-refresh. v0.21.0 \u2014 run/continue accept optional non-secret `metadata` (repo name, review policy, \u2026) passed to the agent, symmetric with the WebHook/Schedule trigger paths. v0.22.0 \u2014 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 \u2014 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 \u2014 purgeChannel clears a channel's buffered messages without deleting its definition (allowed on yaml-declared channels too, unlike deleteChannel \u2014 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 \u2014 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 \u2014 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 \u2014 the manual-management Web UI console + Context op=time + max_fires self-retiring schedules \u2014 is server-side / in-band, no client-surface change). v0.29.1 \u2014 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 \u2014 gRPC + TS client parity for the RFC Y external fan-out and the compaction surface: spawnRunBatch() (POST /v1/runs:batch \u2014 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 \u2014 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 \u2014 server-side.) v0.34.0 \u2014 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 \u2014 RFC AH dynamic filesystem volumes: volumeDef() (POST /v1/_volumedef \u2014 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] \u2014 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 \u2014 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 \u2014 steer a live run) + streamRunByID(runId, {fromSeq}) (GET /v1/runs/{id}/stream \u2014 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 \u2014 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 \u2014 RFC AL Path VFS + RFC AK Document on the wire: path(input) (POST /v1/_path \u2014 a Unix-like filesystem over Memory/Volumes/Documents; resolve/ls/stat/mkdir/mv/rm) + document(input) (POST /v1/_document \u2014 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 \u2014 narrow as needed). v1.7.0 \u2014 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 \u2014 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 \u2014 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 \u2014 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 \u2014 existing path() / document() callers are unchanged. v1.16.0 \u2014 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> \u2014 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 \u2014 RFC BL P5 subject erasure: erasureReport(subject, {tenant}) (GET /v1/_erasure \u2014 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 \u2014 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 \u2014 the returned object is the only durable record of what was not reached; persist it. New ErasureReport / ErasureResult / ErasureTier / ErasureResidue types.",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",