@loomcycle/client 1.50.0 → 1.54.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/dist/cjs/client.js +21 -0
- package/dist/cjs/index.js +1 -0
- package/dist/client.d.ts +26 -1
- package/dist/client.js +21 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.js +1 -0
- package/dist/types.d.ts +47 -1
- package/package.json +1 -1
package/dist/cjs/client.js
CHANGED
|
@@ -555,6 +555,15 @@ class LoomcycleClient {
|
|
|
555
555
|
async revokeUserToken(subject, defId, opts) {
|
|
556
556
|
return (0, fetch_helpers_js_1.deleteJSON)(this.ctx, `/v1/_users/${encodeURIComponent(subject)}/tokens/${encodeURIComponent(defId)}`, opts);
|
|
557
557
|
}
|
|
558
|
+
/** List the agents the caller may run (RFC BY, v1.51.0+), tiered by access
|
|
559
|
+
* mode: bundled/system always, the tenant's shared agents for a non-isolated
|
|
560
|
+
* caller, own reserved. Member-read (runs:read), so a delegated user token
|
|
561
|
+
* reaches it — the tiering is decided server-side from the caller's access
|
|
562
|
+
* mode. Lean entries (name + source); operator metadata stays in the
|
|
563
|
+
* Library. */
|
|
564
|
+
async runnableAgents(opts) {
|
|
565
|
+
return (0, fetch_helpers_js_1.jsonFetch)(this.ctx, "/v1/_runnable-agents", opts);
|
|
566
|
+
}
|
|
558
567
|
/** Whoami — the authenticated principal (RFC L v0.17.0). Any
|
|
559
568
|
* authenticated bearer; returns its authoritative tenant / subject /
|
|
560
569
|
* scopes + `is_admin`. `open_mode: true` when the server runs without
|
|
@@ -1095,6 +1104,14 @@ class LoomcycleClient {
|
|
|
1095
1104
|
async memoryBackendDef(input, opts) {
|
|
1096
1105
|
return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_memorybackenddef", input, opts);
|
|
1097
1106
|
}
|
|
1107
|
+
/** DocumentSourceDef substrate ops (create/fork/get/list/retire) — RFC CE
|
|
1108
|
+
* remote-document-source registration. Operator-admin only. Authors + forks
|
|
1109
|
+
* named peer document sources the Document tool's set_remote/sync consume.
|
|
1110
|
+
* Static document_sources.<name>: yaml stays immutable ground truth; this
|
|
1111
|
+
* produces the derived layer. Mirrors POST /v1/_documentsourcedef. */
|
|
1112
|
+
async documentSourceDef(input, opts) {
|
|
1113
|
+
return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_documentsourcedef", input, opts);
|
|
1114
|
+
}
|
|
1098
1115
|
/** OperatorTokenDef substrate ops (create/rotate/retire/get/list) —
|
|
1099
1116
|
* RFC L OSS multi-tenant authorization. Operator-admin only. The
|
|
1100
1117
|
* token plaintext is returned ONCE in the create/rotate response.
|
|
@@ -1182,6 +1199,10 @@ class LoomcycleClient {
|
|
|
1182
1199
|
body.def_id = target.defId;
|
|
1183
1200
|
if (target.input !== undefined)
|
|
1184
1201
|
body.input = target.input;
|
|
1202
|
+
if (target.boardChunkId !== undefined)
|
|
1203
|
+
body.board_chunk_id = target.boardChunkId;
|
|
1204
|
+
if (target.boardScope !== undefined)
|
|
1205
|
+
body.board_scope = target.boardScope;
|
|
1185
1206
|
return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_teamdef", body, opts);
|
|
1186
1207
|
}
|
|
1187
1208
|
/** Invoke the RFC AL Path VFS tool over HTTP (`POST /v1/_path`). A
|
package/dist/cjs/index.js
CHANGED
|
@@ -24,6 +24,7 @@
|
|
|
24
24
|
* mintUserToken(subject, opts?): Promise<MintedUserToken> // delegated token
|
|
25
25
|
* listUserTokens(subject, opts?): Promise<ListUserTokensResponse>
|
|
26
26
|
* revokeUserToken(subject, defId, opts?): Promise<{def_id, retired_at}>
|
|
27
|
+
* runnableAgents(opts?): Promise<RunnableAgentsResponse> // RFC BY (v1.51.0) — agents I can run
|
|
27
28
|
* whoami(): Promise<WhoamiResponse> // RFC L principal (v0.17.0)
|
|
28
29
|
*
|
|
29
30
|
* // Pause / Resume / State (v0.8.17/8.18)
|
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 { 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, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, ListUserTokensResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, MCPServerDefVerifyResult, MemoryEmbedStatsResponse, MemoryEntriesResponse, MemoryEntryResponse, MemoryReembedResponse, MemoryScopeIDsResponse, MemoryScopesResponse, MemorySearchInput, MemorySearchResponse, PauseResult, PersistentVolumesResponse, EphemeralVolumesResponse, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, ReplaySessionResult, CancelTurnResult, RunBatchOptions, RunBatchResult, RunOptions, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, ListTeamsResponse, 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, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, ListUserTokensResponse, RunnableAgentsResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, MCPServerDefVerifyResult, MemoryEmbedStatsResponse, MemoryEntriesResponse, MemoryEntryResponse, MemoryReembedResponse, MemoryScopeIDsResponse, MemoryScopesResponse, MemorySearchInput, MemorySearchResponse, PauseResult, PersistentVolumesResponse, EphemeralVolumesResponse, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, ResolverMatrix, CompactRunResult, ReplaySessionResult, CancelTurnResult, RunBatchOptions, RunBatchResult, RunOptions, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, CreatedTeam, ListTeamsResponse, 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);
|
|
@@ -382,6 +382,15 @@ export declare class LoomcycleClient {
|
|
|
382
382
|
def_id: string;
|
|
383
383
|
retired_at: string;
|
|
384
384
|
}>;
|
|
385
|
+
/** List the agents the caller may run (RFC BY, v1.51.0+), tiered by access
|
|
386
|
+
* mode: bundled/system always, the tenant's shared agents for a non-isolated
|
|
387
|
+
* caller, own reserved. Member-read (runs:read), so a delegated user token
|
|
388
|
+
* reaches it — the tiering is decided server-side from the caller's access
|
|
389
|
+
* mode. Lean entries (name + source); operator metadata stays in the
|
|
390
|
+
* Library. */
|
|
391
|
+
runnableAgents(opts?: {
|
|
392
|
+
signal?: AbortSignal;
|
|
393
|
+
}): Promise<RunnableAgentsResponse>;
|
|
385
394
|
/** Whoami — the authenticated principal (RFC L v0.17.0). Any
|
|
386
395
|
* authenticated bearer; returns its authoritative tenant / subject /
|
|
387
396
|
* scopes + `is_admin`. `open_mode: true` when the server runs without
|
|
@@ -770,6 +779,14 @@ export declare class LoomcycleClient {
|
|
|
770
779
|
memoryBackendDef(input: SubstrateToolInput, opts?: {
|
|
771
780
|
signal?: AbortSignal;
|
|
772
781
|
}): Promise<SubstrateToolResponse>;
|
|
782
|
+
/** DocumentSourceDef substrate ops (create/fork/get/list/retire) — RFC CE
|
|
783
|
+
* remote-document-source registration. Operator-admin only. Authors + forks
|
|
784
|
+
* named peer document sources the Document tool's set_remote/sync consume.
|
|
785
|
+
* Static document_sources.<name>: yaml stays immutable ground truth; this
|
|
786
|
+
* produces the derived layer. Mirrors POST /v1/_documentsourcedef. */
|
|
787
|
+
documentSourceDef(input: SubstrateToolInput, opts?: {
|
|
788
|
+
signal?: AbortSignal;
|
|
789
|
+
}): Promise<SubstrateToolResponse>;
|
|
773
790
|
/** OperatorTokenDef substrate ops (create/rotate/retire/get/list) —
|
|
774
791
|
* RFC L OSS multi-tenant authorization. Operator-admin only. The
|
|
775
792
|
* token plaintext is returned ONCE in the create/rotate response.
|
|
@@ -846,6 +863,14 @@ export declare class LoomcycleClient {
|
|
|
846
863
|
name?: string;
|
|
847
864
|
defId?: string;
|
|
848
865
|
input?: string;
|
|
866
|
+
/** Bind the walk to a Document chunk task board (RFC BT P4): each state
|
|
867
|
+
* transition persists `chunk.status` = the current team state, and every
|
|
868
|
+
* handler run this walk spawns carries the task key on its
|
|
869
|
+
* `parent_context` (so a board client can pin the live agent to the
|
|
870
|
+
* card). Omit for an ephemeral run. */
|
|
871
|
+
boardChunkId?: string;
|
|
872
|
+
/** The Document scope of `boardChunkId` (agent | user, default user). */
|
|
873
|
+
boardScope?: "agent" | "user";
|
|
849
874
|
}, opts?: {
|
|
850
875
|
signal?: AbortSignal;
|
|
851
876
|
}): Promise<TeamRunResult>;
|
package/dist/client.js
CHANGED
|
@@ -552,6 +552,15 @@ export class LoomcycleClient {
|
|
|
552
552
|
async revokeUserToken(subject, defId, opts) {
|
|
553
553
|
return deleteJSON(this.ctx, `/v1/_users/${encodeURIComponent(subject)}/tokens/${encodeURIComponent(defId)}`, opts);
|
|
554
554
|
}
|
|
555
|
+
/** List the agents the caller may run (RFC BY, v1.51.0+), tiered by access
|
|
556
|
+
* mode: bundled/system always, the tenant's shared agents for a non-isolated
|
|
557
|
+
* caller, own reserved. Member-read (runs:read), so a delegated user token
|
|
558
|
+
* reaches it — the tiering is decided server-side from the caller's access
|
|
559
|
+
* mode. Lean entries (name + source); operator metadata stays in the
|
|
560
|
+
* Library. */
|
|
561
|
+
async runnableAgents(opts) {
|
|
562
|
+
return jsonFetch(this.ctx, "/v1/_runnable-agents", opts);
|
|
563
|
+
}
|
|
555
564
|
/** Whoami — the authenticated principal (RFC L v0.17.0). Any
|
|
556
565
|
* authenticated bearer; returns its authoritative tenant / subject /
|
|
557
566
|
* scopes + `is_admin`. `open_mode: true` when the server runs without
|
|
@@ -1092,6 +1101,14 @@ export class LoomcycleClient {
|
|
|
1092
1101
|
async memoryBackendDef(input, opts) {
|
|
1093
1102
|
return postJSON(this.ctx, "/v1/_memorybackenddef", input, opts);
|
|
1094
1103
|
}
|
|
1104
|
+
/** DocumentSourceDef substrate ops (create/fork/get/list/retire) — RFC CE
|
|
1105
|
+
* remote-document-source registration. Operator-admin only. Authors + forks
|
|
1106
|
+
* named peer document sources the Document tool's set_remote/sync consume.
|
|
1107
|
+
* Static document_sources.<name>: yaml stays immutable ground truth; this
|
|
1108
|
+
* produces the derived layer. Mirrors POST /v1/_documentsourcedef. */
|
|
1109
|
+
async documentSourceDef(input, opts) {
|
|
1110
|
+
return postJSON(this.ctx, "/v1/_documentsourcedef", input, opts);
|
|
1111
|
+
}
|
|
1095
1112
|
/** OperatorTokenDef substrate ops (create/rotate/retire/get/list) —
|
|
1096
1113
|
* RFC L OSS multi-tenant authorization. Operator-admin only. The
|
|
1097
1114
|
* token plaintext is returned ONCE in the create/rotate response.
|
|
@@ -1179,6 +1196,10 @@ export class LoomcycleClient {
|
|
|
1179
1196
|
body.def_id = target.defId;
|
|
1180
1197
|
if (target.input !== undefined)
|
|
1181
1198
|
body.input = target.input;
|
|
1199
|
+
if (target.boardChunkId !== undefined)
|
|
1200
|
+
body.board_chunk_id = target.boardChunkId;
|
|
1201
|
+
if (target.boardScope !== undefined)
|
|
1202
|
+
body.board_scope = target.boardScope;
|
|
1182
1203
|
return postJSON(this.ctx, "/v1/_teamdef", body, opts);
|
|
1183
1204
|
}
|
|
1184
1205
|
/** Invoke the RFC AL Path VFS tool over HTTP (`POST /v1/_path`). A
|
package/dist/index.d.ts
CHANGED
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
* mintUserToken(subject, opts?): Promise<MintedUserToken> // delegated token
|
|
24
24
|
* listUserTokens(subject, opts?): Promise<ListUserTokensResponse>
|
|
25
25
|
* revokeUserToken(subject, defId, opts?): Promise<{def_id, retired_at}>
|
|
26
|
+
* runnableAgents(opts?): Promise<RunnableAgentsResponse> // RFC BY (v1.51.0) — agents I can run
|
|
26
27
|
* whoami(): Promise<WhoamiResponse> // RFC L principal (v0.17.0)
|
|
27
28
|
*
|
|
28
29
|
* // Pause / Resume / State (v0.8.17/8.18)
|
|
@@ -122,5 +123,5 @@ export { InteractiveSession } from "./interactive.js";
|
|
|
122
123
|
export type { InteractiveSessionOps } from "./interactive.js";
|
|
123
124
|
export { ClientToolHost, clientToolsURL, CLIENT_TOOL_SUBPROTOCOL } from "./client-tools.js";
|
|
124
125
|
export type { ClientToolSchema, ClientToolInvocation, ConnectClientToolsOptions, WebSocketLike, WebSocketCtor, } from "./client-tools.js";
|
|
125
|
-
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, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, UserTokenMeta, ListUserTokensResponse, WhoamiResponse, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, MemorySearchInput, MemorySource, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, 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";
|
|
126
|
+
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, UserRecord, CreateUserBody, UpdateUserBody, MintedUserToken, UserTokenMeta, ListUserTokensResponse, RunnableAgent, RunnableAgentsResponse, WhoamiResponse, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, ResolverMatrix, ResolverModelStatus, ResolverProviderAvailability, CreateSnapshotOptions, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotListResponse, SnapshotRestoreResponse, MemoryEntriesResponse, MemoryEntry, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopeIDSummary, MemoryScopeKind, MemoryScopesResponse, MemorySearchInput, MemorySource, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, 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";
|
|
126
127
|
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/index.js
CHANGED
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
* mintUserToken(subject, opts?): Promise<MintedUserToken> // delegated token
|
|
24
24
|
* listUserTokens(subject, opts?): Promise<ListUserTokensResponse>
|
|
25
25
|
* revokeUserToken(subject, defId, opts?): Promise<{def_id, retired_at}>
|
|
26
|
+
* runnableAgents(opts?): Promise<RunnableAgentsResponse> // RFC BY (v1.51.0) — agents I can run
|
|
26
27
|
* whoami(): Promise<WhoamiResponse> // RFC L principal (v0.17.0)
|
|
27
28
|
*
|
|
28
29
|
* // Pause / Resume / State (v0.8.17/8.18)
|
package/dist/types.d.ts
CHANGED
|
@@ -283,6 +283,13 @@ export interface ParentContext {
|
|
|
283
283
|
/** The consumer's tier marker captured at root-run time (distinct from
|
|
284
284
|
* `userTier`, which is loomcycle's resolver policy). */
|
|
285
285
|
tier_at_run?: string;
|
|
286
|
+
/** Workflow-board correlation (loomboard, RFC BT P4). A board-bound
|
|
287
|
+
* `TeamDef op=run` stamps these onto each handler run it spawns, so a client
|
|
288
|
+
* folding the run-state stream (RunStateEvent.parent_context) can pin the
|
|
289
|
+
* live agent to its kanban card. Absent for non-board runs. */
|
|
290
|
+
board_scope?: string;
|
|
291
|
+
board_chunk_id?: string;
|
|
292
|
+
board_document_id?: string;
|
|
286
293
|
}
|
|
287
294
|
export interface ContinueOptions {
|
|
288
295
|
/** Required — the session to continue. */
|
|
@@ -681,6 +688,15 @@ export interface ListUserTokensResponse {
|
|
|
681
688
|
subject: string;
|
|
682
689
|
tokens: UserTokenMeta[];
|
|
683
690
|
}
|
|
691
|
+
/** One entry in the runnable-agent catalog — the name to run + its tier.
|
|
692
|
+
* Intentionally lean: no operator metadata (versions, retired, hashes). */
|
|
693
|
+
export interface RunnableAgent {
|
|
694
|
+
name: string;
|
|
695
|
+
source: string;
|
|
696
|
+
}
|
|
697
|
+
export interface RunnableAgentsResponse {
|
|
698
|
+
agents: RunnableAgent[];
|
|
699
|
+
}
|
|
684
700
|
/** GET /v1/_me — the authenticated principal resolved from the bearer.
|
|
685
701
|
* `open_mode` is true when the server runs without the OperatorTokenDef
|
|
686
702
|
* substrate (single shared LOOMCYCLE_AUTH_TOKEN); `legacy` is true for a
|
|
@@ -1170,7 +1186,7 @@ export type PathToolInput = {
|
|
|
1170
1186
|
* requires the operator to grant BOTH `memory_scopes` and `sql_scopes` with
|
|
1171
1187
|
* `tenant`, since a document spans both planes. */
|
|
1172
1188
|
export type DocumentToolInput = {
|
|
1173
|
-
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";
|
|
1189
|
+
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" | "list_facts" | "judge_fact" | "verbatim_answer" | "verification_stats" | "propose_entity" | "search" | "set_remote" | "sync" | "diff_remote";
|
|
1174
1190
|
scope?: "agent" | "user" | "tenant";
|
|
1175
1191
|
/** Document id (get/delete_document) or chunk id (get/update/delete/move_chunk). */
|
|
1176
1192
|
id?: string;
|
|
@@ -1216,6 +1232,36 @@ export type DocumentToolInput = {
|
|
|
1216
1232
|
/** export_md: embed round-trippable chunk metadata + edges as HTML comments
|
|
1217
1233
|
* (default true server-side). false = clean human-facing Markdown. */
|
|
1218
1234
|
include_metadata?: boolean;
|
|
1235
|
+
/** search / graph_recall: free text. search matches it semantically against
|
|
1236
|
+
* chunk BODIES; graph_recall uses it to find starting chunks by title.
|
|
1237
|
+
* verbatim_answer: the lookup question to answer. */
|
|
1238
|
+
query?: string;
|
|
1239
|
+
/** upsert_chunk: the stable identity of this fact — upserting twice with the
|
|
1240
|
+
* same key updates ONE chunk. judge_fact: name the fact by key instead of id. */
|
|
1241
|
+
natural_key?: string;
|
|
1242
|
+
/** The entity this fact is about, paired with `type` (RFC CC). Documents
|
|
1243
|
+
* carry neither, which is what lets the ontology gate tell them apart. */
|
|
1244
|
+
subject?: string;
|
|
1245
|
+
/** upsert_chunk: the span of source text this fact was drawn from — the
|
|
1246
|
+
* evidence a judge checks the claim against. */
|
|
1247
|
+
source_quote?: string;
|
|
1248
|
+
/** judge_fact: whether the fact's recorded span supports it. The confidence
|
|
1249
|
+
* each maps to is set by the SERVER, so a caller cannot invent a scale.
|
|
1250
|
+
* `mistyped` = the span does support the claim, but it is filed as the wrong
|
|
1251
|
+
* kind of thing; the fix is a retype, so it stays visible. */
|
|
1252
|
+
verdict?: "supported" | "unclear" | "unsupported" | "mistyped";
|
|
1253
|
+
/** judge_fact: why. Required — a withheld fact whose ground is not stated is
|
|
1254
|
+
* indistinguishable from a bug. */
|
|
1255
|
+
reason?: string;
|
|
1256
|
+
/** list_facts / graph_recall: also return facts a judge marked unsupported.
|
|
1257
|
+
* They are withheld by default and never deleted, so this is how to read what
|
|
1258
|
+
* was refused, and why. */
|
|
1259
|
+
include_refuted?: boolean;
|
|
1260
|
+
/** verbatim_answer: how close a match must be before it can be quoted as an
|
|
1261
|
+
* answer (default 0.6 server-side). Cosine scale is a property of the
|
|
1262
|
+
* EMBEDDING MODEL, so tune this against your own — the response reports the
|
|
1263
|
+
* actual score even when it declines to answer. */
|
|
1264
|
+
min_score?: number;
|
|
1219
1265
|
/** import_md: an export_md-shaped Markdown document (headings = hierarchy;
|
|
1220
1266
|
* `<!-- loom: ... -->` metadata; `<!-- loom-edges: ... -->` trailer). Omit
|
|
1221
1267
|
* document_id to create a new document; pass it (+ optional parent_id) to
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@loomcycle/client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.54.0",
|
|
4
4
|
"description": "TypeScript client for the loomcycle sidecar (HTTP+SSE). 67 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. 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.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|