@loomcycle/client 0.11.5 → 0.12.8

package/dist/cjs/client.js

@@ -89,6 +89,10 @@ class LoomcycleClient {
             body.user_tier = opts.userTier;
         if (opts.userBearer !== undefined)
             body.user_bearer = opts.userBearer;
+        if (opts.userCredentials !== undefined)
+            body.user_credentials = opts.userCredentials;
+        if (opts.parentContext !== undefined)
+            body.parent_context = opts.parentContext;
         yield* this.streamSSE("/v1/runs", body, opts.signal, opts.debug);
     }
     /**
@@ -125,6 +129,10 @@ class LoomcycleClient {
             body.user_tier = opts.userTier;
         if (opts.userBearer !== undefined)
             body.user_bearer = opts.userBearer;
+        if (opts.userCredentials !== undefined)
+            body.user_credentials = opts.userCredentials;
+        if (opts.parentContext !== undefined)
+            body.parent_context = opts.parentContext;
         yield* this.streamSSE(`/v1/sessions/${encodeURIComponent(opts.sessionId)}/messages`, body, opts.signal, opts.debug);
     }
     // ---- Agent metadata ----
@@ -422,6 +430,38 @@ class LoomcycleClient {
     async mcpServerDef(input, opts) {
         return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_mcpserverdef", input, opts);
     }
+    /** Invoke the v1.x RFC E ScheduleDef substrate tool over HTTP.
+     *  Author + fork + retire scheduled-run definitions at runtime.
+     *  Mirror of {@link LoomcycleClient.agentDef} for schedules — the
+     *  primary use case is JobEmber-style "fork a yaml template
+     *  per-user with their bearer + tier cron" workflows.
+     *
+     *  Operator-admin-only: this endpoint requires the bearer token.
+     *
+     *  Op-discriminated input: `{op: "create" | "fork" | "get" |
+     *  "list" | "retire", ...}`. Note that ScheduleDef has 5 ops
+     *  (no separate `promote` — forks auto-promote by default per
+     *  RFC E's worked example; no `verify` — no content_sha256 in
+     *  v1.x).
+     *
+     *  Sharp edges (substrate refuses these):
+     *  - Name colliding with a static cfg.ScheduledRuns entry is
+     *    refused on `create` (yaml is ground truth; use `fork` to
+     *    derive a new version).
+     *  - Fork against a template with `required_credentials` must
+     *    supply all keys in `user_credentials` — loud-fail at fork
+     *    time rather than silent ingestion-time failure when the
+     *    sweeper fires.
+     *  - Cron syntax is validated server-side; invalid expressions
+     *    refuse with a parse error.
+     *
+     *  Raises {@link SubstrateToolRefusedError} on tool-level refusals
+     *  (static-name collision, missing required credential, invalid
+     *  cron, etc.); {@link InvalidArgumentError} on 400 (malformed
+     *  JSON); {@link AuthError} on 401. */
+    async scheduleDef(input, opts) {
+        return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_scheduledef", input, opts);
+    }
     // ---- v0.10.3 Library v2 enumeration (read-only, merged yaml+substrate) ----
     /** List every agent the runtime knows about — yaml-static + dynamic
      *  AgentDefs merged into one envelope per name. Each entry carries

package/dist/cjs/index.js

@@ -43,9 +43,11 @@
  *     listRunInterrupts(runId, opts?): Promise<InterruptListResponse>
  *     resolveInterrupt(runId, interruptId, opts): Promise<unknown>
  *
- *     // Substrate admin (v0.8.22)
+ *     // Substrate admin (v0.8.22; mcpServerDef v0.9.x; scheduleDef v1.x)
  *     agentDef(input): Promise<SubstrateToolResponse>
  *     skillDef(input): Promise<SubstrateToolResponse>
+ *     mcpServerDef(input): Promise<SubstrateToolResponse>
+ *     scheduleDef(input): Promise<SubstrateToolResponse>
  *
  *     // Library v2 enumeration (v0.10.3 — yaml+substrate merged)
  *     listLibraryAgents(): Promise<LibraryListResponse<LibraryAgentDefinition>>

package/dist/client.d.ts

@@ -289,6 +289,38 @@ export declare class LoomcycleClient {
     mcpServerDef(input: SubstrateToolInput, opts?: {
         signal?: AbortSignal;
     }): Promise<SubstrateToolResponse>;
+    /** Invoke the v1.x RFC E ScheduleDef substrate tool over HTTP.
+     *  Author + fork + retire scheduled-run definitions at runtime.
+     *  Mirror of {@link LoomcycleClient.agentDef} for schedules — the
+     *  primary use case is JobEmber-style "fork a yaml template
+     *  per-user with their bearer + tier cron" workflows.
+     *
+     *  Operator-admin-only: this endpoint requires the bearer token.
+     *
+     *  Op-discriminated input: `{op: "create" | "fork" | "get" |
+     *  "list" | "retire", ...}`. Note that ScheduleDef has 5 ops
+     *  (no separate `promote` — forks auto-promote by default per
+     *  RFC E's worked example; no `verify` — no content_sha256 in
+     *  v1.x).
+     *
+     *  Sharp edges (substrate refuses these):
+     *  - Name colliding with a static cfg.ScheduledRuns entry is
+     *    refused on `create` (yaml is ground truth; use `fork` to
+     *    derive a new version).
+     *  - Fork against a template with `required_credentials` must
+     *    supply all keys in `user_credentials` — loud-fail at fork
+     *    time rather than silent ingestion-time failure when the
+     *    sweeper fires.
+     *  - Cron syntax is validated server-side; invalid expressions
+     *    refuse with a parse error.
+     *
+     *  Raises {@link SubstrateToolRefusedError} on tool-level refusals
+     *  (static-name collision, missing required credential, invalid
+     *  cron, etc.); {@link InvalidArgumentError} on 400 (malformed
+     *  JSON); {@link AuthError} on 401. */
+    scheduleDef(input: SubstrateToolInput, opts?: {
+        signal?: AbortSignal;
+    }): Promise<SubstrateToolResponse>;
     /** List every agent the runtime knows about — yaml-static + dynamic
      *  AgentDefs merged into one envelope per name. Each entry carries
      *  `source: "static-only" | "dynamic-only" | "both"` so callers can

package/dist/client.js

@@ -86,6 +86,10 @@ export class LoomcycleClient {
             body.user_tier = opts.userTier;
         if (opts.userBearer !== undefined)
             body.user_bearer = opts.userBearer;
+        if (opts.userCredentials !== undefined)
+            body.user_credentials = opts.userCredentials;
+        if (opts.parentContext !== undefined)
+            body.parent_context = opts.parentContext;
         yield* this.streamSSE("/v1/runs", body, opts.signal, opts.debug);
     }
     /**
@@ -122,6 +126,10 @@ export class LoomcycleClient {
             body.user_tier = opts.userTier;
         if (opts.userBearer !== undefined)
             body.user_bearer = opts.userBearer;
+        if (opts.userCredentials !== undefined)
+            body.user_credentials = opts.userCredentials;
+        if (opts.parentContext !== undefined)
+            body.parent_context = opts.parentContext;
         yield* this.streamSSE(`/v1/sessions/${encodeURIComponent(opts.sessionId)}/messages`, body, opts.signal, opts.debug);
     }
     // ---- Agent metadata ----
@@ -419,6 +427,38 @@ export class LoomcycleClient {
     async mcpServerDef(input, opts) {
         return postJSON(this.ctx, "/v1/_mcpserverdef", input, opts);
     }
+    /** Invoke the v1.x RFC E ScheduleDef substrate tool over HTTP.
+     *  Author + fork + retire scheduled-run definitions at runtime.
+     *  Mirror of {@link LoomcycleClient.agentDef} for schedules — the
+     *  primary use case is JobEmber-style "fork a yaml template
+     *  per-user with their bearer + tier cron" workflows.
+     *
+     *  Operator-admin-only: this endpoint requires the bearer token.
+     *
+     *  Op-discriminated input: `{op: "create" | "fork" | "get" |
+     *  "list" | "retire", ...}`. Note that ScheduleDef has 5 ops
+     *  (no separate `promote` — forks auto-promote by default per
+     *  RFC E's worked example; no `verify` — no content_sha256 in
+     *  v1.x).
+     *
+     *  Sharp edges (substrate refuses these):
+     *  - Name colliding with a static cfg.ScheduledRuns entry is
+     *    refused on `create` (yaml is ground truth; use `fork` to
+     *    derive a new version).
+     *  - Fork against a template with `required_credentials` must
+     *    supply all keys in `user_credentials` — loud-fail at fork
+     *    time rather than silent ingestion-time failure when the
+     *    sweeper fires.
+     *  - Cron syntax is validated server-side; invalid expressions
+     *    refuse with a parse error.
+     *
+     *  Raises {@link SubstrateToolRefusedError} on tool-level refusals
+     *  (static-name collision, missing required credential, invalid
+     *  cron, etc.); {@link InvalidArgumentError} on 400 (malformed
+     *  JSON); {@link AuthError} on 401. */
+    async scheduleDef(input, opts) {
+        return postJSON(this.ctx, "/v1/_scheduledef", input, opts);
+    }
     // ---- v0.10.3 Library v2 enumeration (read-only, merged yaml+substrate) ----
     /** List every agent the runtime knows about — yaml-static + dynamic
      *  AgentDefs merged into one envelope per name. Each entry carries

package/dist/index.d.ts

@@ -42,9 +42,11 @@
  *     listRunInterrupts(runId, opts?): Promise<InterruptListResponse>
  *     resolveInterrupt(runId, interruptId, opts): Promise<unknown>
  *
- *     // Substrate admin (v0.8.22)
+ *     // Substrate admin (v0.8.22; mcpServerDef v0.9.x; scheduleDef v1.x)
  *     agentDef(input): Promise<SubstrateToolResponse>
  *     skillDef(input): Promise<SubstrateToolResponse>
+ *     mcpServerDef(input): Promise<SubstrateToolResponse>
+ *     scheduleDef(input): Promise<SubstrateToolResponse>
  *
  *     // Library v2 enumeration (v0.10.3 — yaml+substrate merged)
  *     listLibraryAgents(): Promise<LibraryListResponse<LibraryAgentDefinition>>
@@ -76,5 +78,5 @@
  * See `adapters/ts/README.md` for usage examples.
  */
 export { LoomcycleClient } from "./client.js";
-export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, PromptContent, PromptSegment, RetryInfo, RunOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, CancelAgentResult, ListAgentsResponse, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, 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, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ChannelPublishResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, CreateChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, } from "./types.js";
+export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, CancelAgentResult, ListAgentsResponse, TranscriptEvent, TranscriptResponse, HealthResponse, ListUsersResponse, UserSummary, PauseResult, ResumeResult, RuntimeStateResponse, RuntimeStateStatus, 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, SystemPromptPayload, UserInputPayload, ChannelDescriptor, ListChannelsResponse, RunStateEvent, RunStateStreamClose, RunStateStreamItem, RunStateStreamOpen, StreamUserRunStatesOptions, AckChannelOptions, ChannelAckResult, ChannelMessageItem, ChannelPeekResult, ChannelPublishResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, CreateChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, } from "./types.js";
 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

@@ -42,9 +42,11 @@
  *     listRunInterrupts(runId, opts?): Promise<InterruptListResponse>
  *     resolveInterrupt(runId, interruptId, opts): Promise<unknown>
  *
- *     // Substrate admin (v0.8.22)
+ *     // Substrate admin (v0.8.22; mcpServerDef v0.9.x; scheduleDef v1.x)
  *     agentDef(input): Promise<SubstrateToolResponse>
  *     skillDef(input): Promise<SubstrateToolResponse>
+ *     mcpServerDef(input): Promise<SubstrateToolResponse>
+ *     scheduleDef(input): Promise<SubstrateToolResponse>
  *
  *     // Library v2 enumeration (v0.10.3 — yaml+substrate merged)
  *     listLibraryAgents(): Promise<LibraryListResponse<LibraryAgentDefinition>>

package/dist/types.d.ts

@@ -69,6 +69,7 @@ export interface AgentEvent {
     run_id?: string;
     session_id?: string;
     parent_agent_id?: string | null;
+    parent_context?: ParentContext;
     meta_subtype?: "stream_open" | "stream_close";
     meta_reason?: string;
 }
@@ -130,6 +131,23 @@ export interface RunOptions {
      *  (static-bearer setups unaffected). Sub-agents inherit identically.
      *  Never persisted; never logged in full. */
     userBearer?: string;
+    /** Per-tool named credentials map (v1.x RFC F). Per-MCP-server bearers
+     *  keyed by operator-chosen name (convention: the `mcp_servers.<name>`
+     *  yaml key). Substituted into MCP HTTP header values containing
+     *  `${run.credentials.<name>}` at outbound request-build time. Keys
+     *  match `[a-zA-Z0-9_-]{1,64}`; values arbitrary strings. Sub-agents
+     *  inherit the whole map. Coexists with `userBearer` — the legacy
+     *  field auto-promotes to `userCredentials.default` for back-compat
+     *  with v0.8.x flows. Never persisted; never logged. */
+    userCredentials?: Record<string, string>;
+    /** Opaque caller-tracking lineage (v0.12.x). Carried verbatim by the
+     *  runtime, inherited UNCHANGED by every sub-agent the Agent tool
+     *  spawns, persisted on each run row, and echoed back on the per-agent
+     *  report surfaces (agent status, run-state stream, the `event: agent`
+     *  frame) — so you can attribute a child sub-agent's usage to the
+     *  user-initiated request that spawned the whole tree. Not a secret.
+     *  Omitted = no tracking context. */
+    parentContext?: ParentContext;
     /** Opt-in observability: when true, the iterator emits client-
      *  synthesized `{ type: "_meta", meta_subtype: "stream_open" | "stream_close" }`
      *  events around the real event stream. `meta_reason` carries the
@@ -140,6 +158,20 @@ export interface RunOptions {
     debug?: boolean;
     signal?: AbortSignal;
 }
+/** Opaque caller-tracking lineage (v0.12.x) attached to a run and
+ *  propagated to all its sub-agents. The runtime stores and echoes
+ *  these fields verbatim and never interprets them. All fields
+ *  optional; an all-empty object is treated as absent. */
+export interface ParentContext {
+    /** The consumer's identifier for the user-initiated run at the root of
+     *  the spawn tree — echoed on every descendant. */
+    root_agent_run_id?: string;
+    /** The consumer's logical-operation key for the root request. */
+    function_key?: string;
+    /** The consumer's tier marker captured at root-run time (distinct from
+     *  `userTier`, which is loomcycle's resolver policy). */
+    tier_at_run?: string;
+}
 export interface ContinueOptions {
     /** Required — the session to continue. */
     sessionId: string;
@@ -166,6 +198,14 @@ export interface ContinueOptions {
      *  so different continuations in the same session may carry
      *  different end-user tokens. */
     userBearer?: string;
+    /** Per-tool named credentials map (v1.x RFC F). See
+     *  {@link RunOptions.userCredentials} for the full shape — same
+     *  semantics, supplied per-continuation rather than per-fresh-run. */
+    userCredentials?: Record<string, string>;
+    /** Opaque caller-tracking lineage (v0.12.x). See
+     *  {@link RunOptions.parentContext} — same shape; a continuation may
+     *  (re)set the lineage for the new run it creates. */
+    parentContext?: ParentContext;
     /** Opt-in observability: see {@link RunOptions.debug}. Same shape. */
     debug?: boolean;
     signal?: AbortSignal;
@@ -192,6 +232,7 @@ export interface AgentUsage {
     cache_creation_tokens?: number;
     cache_read_tokens?: number;
     model?: string;
+    provider?: string;
 }
 export interface Agent {
     agent_id: string;
@@ -208,6 +249,11 @@ export interface Agent {
     usage: AgentUsage;
     last_heartbeat_at: string | null;
     live: boolean;
+    /** Opaque caller-tracking lineage this run carries (inherited from its
+     *  root for sub-agents), v0.12.x. Echoed here alongside `usage` so you
+     *  can attribute a child sub-agent's cost to the user-initiated request
+     *  in a single fetch. Omitted when the run carried no context. */
+    parent_context?: ParentContext;
 }
 export interface ListAgentsResponse {
     agents: Agent[];
@@ -730,6 +776,10 @@ export interface RunStateEvent {
     stop_reason?: string;
     error?: string;
     ts: string;
+    /** Opaque caller-tracking lineage echoed on the transition (v0.12.x),
+     *  so a subscriber learns which root request a finishing sub-agent
+     *  belongs to. Omitted when the run carried no context. */
+    parent_context?: ParentContext;
 }
 /** Initial stream_open frame emitted before the first run_state. */
 export interface RunStateStreamOpen {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loomcycle/client",
-  "version": "0.11.5",
+  "version": "0.12.8",
   "description": "TypeScript client for the loomcycle sidecar (HTTP+SSE). 46 methods covering run streaming, agent metadata, pause/resume/state, 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).",
   "license": "Apache-2.0",
   "type": "module",