@loomcycle/client 1.97.0 → 1.99.0

package/dist/cjs/client.js

@@ -140,6 +140,10 @@ function runBody(opts) {
         body.run_timeout_seconds = opts.runTimeoutSeconds;
     if (opts.reviewTtlSeconds !== undefined)
         body.review_ttl_seconds = opts.reviewTtlSeconds;
+    if (opts.hooks !== undefined)
+        body.hooks = opts.hooks;
+    if (opts.toolHooks !== undefined)
+        body.tool_hooks = opts.toolHooks;
     if (opts.sampling !== undefined)
         body.sampling = samplingToWire(opts.sampling);
     // Same keys on the wire as in the option (mode / name / until).
@@ -281,6 +285,10 @@ class LoomcycleClient {
             body.run_timeout_seconds = opts.runTimeoutSeconds;
         if (opts.reviewTtlSeconds !== undefined)
             body.review_ttl_seconds = opts.reviewTtlSeconds;
+        if (opts.hooks !== undefined)
+            body.hooks = opts.hooks;
+        if (opts.toolHooks !== undefined)
+            body.tool_hooks = opts.toolHooks;
         if (opts.sampling !== undefined)
             body.sampling = samplingToWire(opts.sampling);
         if (opts.toolChoice !== undefined)
@@ -2042,6 +2050,8 @@ class LoomcycleClient {
             body.period = opts.period;
         if (opts.hold !== undefined)
             body.hold = opts.hold;
+        if (opts.hooks !== undefined)
+            body.hooks = opts.hooks;
         return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_channels", body, {
             signal: opts.signal,
         });
@@ -2061,6 +2071,8 @@ class LoomcycleClient {
             body.semantic = opts.semantic;
         if (opts.hold !== undefined)
             body.hold = opts.hold;
+        if (opts.hooks !== undefined)
+            body.hooks = opts.hooks;
         return (0, fetch_helpers_js_1.patchJSON)(this.ctx, `/v1/_channels/${encodeURIComponent(name)}`, body, { signal: opts.signal });
     }
     /** Delete a runtime-substrate channel + cascade its persisted

package/dist/client.js

@@ -137,6 +137,10 @@ function runBody(opts) {
         body.run_timeout_seconds = opts.runTimeoutSeconds;
     if (opts.reviewTtlSeconds !== undefined)
         body.review_ttl_seconds = opts.reviewTtlSeconds;
+    if (opts.hooks !== undefined)
+        body.hooks = opts.hooks;
+    if (opts.toolHooks !== undefined)
+        body.tool_hooks = opts.toolHooks;
     if (opts.sampling !== undefined)
         body.sampling = samplingToWire(opts.sampling);
     // Same keys on the wire as in the option (mode / name / until).
@@ -278,6 +282,10 @@ export class LoomcycleClient {
             body.run_timeout_seconds = opts.runTimeoutSeconds;
         if (opts.reviewTtlSeconds !== undefined)
             body.review_ttl_seconds = opts.reviewTtlSeconds;
+        if (opts.hooks !== undefined)
+            body.hooks = opts.hooks;
+        if (opts.toolHooks !== undefined)
+            body.tool_hooks = opts.toolHooks;
         if (opts.sampling !== undefined)
             body.sampling = samplingToWire(opts.sampling);
         if (opts.toolChoice !== undefined)
@@ -2039,6 +2047,8 @@ export class LoomcycleClient {
             body.period = opts.period;
         if (opts.hold !== undefined)
             body.hold = opts.hold;
+        if (opts.hooks !== undefined)
+            body.hooks = opts.hooks;
         return postJSON(this.ctx, "/v1/_channels", body, {
             signal: opts.signal,
         });
@@ -2058,6 +2068,8 @@ export class LoomcycleClient {
             body.semantic = opts.semantic;
         if (opts.hold !== undefined)
             body.hold = opts.hold;
+        if (opts.hooks !== undefined)
+            body.hooks = opts.hooks;
         return patchJSON(this.ctx, `/v1/_channels/${encodeURIComponent(name)}`, body, { signal: opts.signal });
     }
     /** Delete a runtime-substrate channel + cascade its persisted

package/dist/index.d.ts

@@ -128,5 +128,5 @@ export { InteractiveSession } from "./interactive.js";
 export type { InteractiveSessionOps } from "./interactive.js";
 export { ClientToolHost, clientToolsURL, CLIENT_TOOL_SUBPROTOCOL } from "./client-tools.js";
 export type { ClientToolSchema, ClientToolInvocation, ConnectClientToolsOptions, WebSocketLike, WebSocketCtor, } from "./client-tools.js";
-export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, SamplingOptions, CompactionOptions, ContextOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, RunResult, RunSpec, ConfiguredRun, ConfiguredRunPatch, ToolChoiceOptions, OutputFormatOptions, CancelAgentResult, ListAgentsResponse, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, DirectoryBudget, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, CancelTurnResult, ReviewRunResult, 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, MemoryWhen, MemoryTimeFilter, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, MemoryBackfillResponse, MemoryPurgeResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, HookFailMode, HookPhase, HookToolCall, HookToolResult, PostHookCall, PostHookResult, PreHookCall, PreHookResult, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, PromotedTeam, RetiredTeam, TeamDefDetail, TeamVerification, TeamVersion, TeamVersionList, TeamBreakpoints, TeamRunDetached, TeamRunResult, TeamRunTarget, 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, ChannelReleaseResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAwaitEntry, ChannelAwaitMode, ChannelAwaitResult, ChannelBroadcastEntry, ChannelBroadcastResult, CreateChannelOptions, ReleaseChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, EnsureMcpServerOptions, EnsureMcpServerResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, AgentDefOverlay, HookEvent, InlineWebhook, HookEntry, EventHooks, ToolEntry, EnsureCodeAgentOptions, EnsureCodeAgentResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, CapabilityInertInfo, LimitInfo, EffectiveConfigResponse, EffectiveConfigSource, EffectiveValue, RetuneRunResponse, RunConfigRecord, RunConfigResponse, RunPromptResponse, RunPromptSnapshot, PromptBlock, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, CredentialScope, CredentialMeta, CredentialListResponse, } from "./types.js";
+export type { AgentEvent, ClientOptions, ContinueOptions, EventType, HostWidening, ImageMediaType, ParentContext, PromptContent, PromptSegment, RetryInfo, RunOptions, SamplingOptions, CompactionOptions, ContextOptions, ToolUse, Usage, Agent, AgentStatus, AgentUsage, RunResult, RunSpec, ConfiguredRun, ConfiguredRunPatch, ToolChoiceOptions, OutputFormatOptions, CancelAgentResult, ListAgentsResponse, RunBatchOptions, RunBatchResult, SpawnRunResult, CompactRunResult, DirectoryBudget, DirectoryInspection, DirectoryTenant, DirectoryUser, ErasureReport, ErasureResidue, ErasureResult, ErasureTier, CancelTurnResult, ReviewRunResult, 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, MemoryWhen, MemoryTimeFilter, MemorySearchEntry, MemorySearchResponse, MemoryEmbedModelStats, MemoryEmbedStatsResponse, MemoryReembedConfigured, MemoryReembedResponse, MemoryBackfillResponse, MemoryPurgeResponse, InterruptListResponse, InterruptRow, InterruptStatus, ResolveInterruptOptions, ChannelHookCall, ChannelHookResult, HookFailMode, HookPhase, HookToolCall, HookToolResult, PostHookCall, PostHookResult, PreHookCall, PreHookResult, SubstrateToolInput, SubstrateToolResponse, TeamNameSummary, ListTeamsResponse, TeamDiagram, CreatedTeam, PromotedTeam, RetiredTeam, TeamDefDetail, TeamVerification, TeamVersion, TeamVersionList, TeamBreakpoints, TeamRunDetached, TeamRunResult, TeamRunTarget, 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, ChannelReleaseResult, ChannelScope, ChannelSubscribeResult, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, AwaitChannelsOptions, BroadcastChannelsOptions, ChannelAwaitEntry, ChannelAwaitMode, ChannelAwaitResult, ChannelBroadcastEntry, ChannelBroadcastResult, CreateChannelOptions, ReleaseChannelOptions, UpdateChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, EnsureMcpServerOptions, EnsureMcpServerResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, AgentDefOverlay, HookEvent, InlineWebhook, HookEntry, EventHooks, ToolEntry, ToolHooksByTool, EnsureCodeAgentOptions, EnsureCodeAgentResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, LLMEmbeddingItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, LLMEmbeddingsUsage, UsageDimension, UsageAggregate, UsageReportResponse, CapabilityInertInfo, LimitInfo, ErrorInfo, CallFormat, CallRef, HookDecisionInfo, EffectiveConfigResponse, EffectiveConfigSource, EffectiveValue, RetuneRunResponse, RunConfigRecord, RunConfigResponse, RunPromptResponse, RunPromptSnapshot, PromptBlock, TokenLimit, TokenLimitsResponse, ConfigResponse, ConfigProvider, ConfigModel, ConfigSearch, ConfigInstance, SetTokenLimitRequest, CredentialScope, CredentialMeta, CredentialListResponse, } from "./types.js";
 export { AgentIDInUseError, AgentNotFoundError, AlreadyPausingError, AuthError, BackpressureError, NotFoundError, InvalidArgumentError, ChannelCursorRegressionError, LoomcycleError, NotPausedError, PauseNotConfiguredError, PerUserQuotaExhaustedError, SessionBusyError, SessionNotFoundError, SnapshotNotFoundError, SnapshotTooLargeError, SnapshotVersionError, SubstrateToolRefusedError, UnavailableError, } from "./errors.js";

package/dist/types.d.ts

@@ -75,6 +75,12 @@ export interface RunConfigRecord {
     max_context_tokens?: number;
     run_timeout_seconds?: number;
     review_ttl_seconds?: number;
+    /** Hooks the run added to its agent's own: its request's, and a sub-agent's
+     *  inherited ones. */
+    hooks?: {
+        hooks?: EventHooks;
+        tool_hooks?: ToolHooksByTool;
+    };
     routing?: {
         provider?: string;
         model?: string;
@@ -233,16 +239,37 @@ export interface OverrideInfo {
      *  that moved no model is still legible. */
     fields?: string[];
 }
-/** The machine-readable half of a terminal run failure, carried on
- *  `event: error` frames.
+/** One tool call: the tool's name and its argument object. */
+export interface CallRef {
+    tool: string;
+    input: unknown;
+}
+/** What a correct call to a documented tool looks like, taken from the
+ *  operation's help article. */
+export interface CallFormat {
+    tool: string;
+    /** The operation the example is for; absent when the call named no valid
+     *  op, in which case `operations` lists the ones that exist. */
+    op?: string;
+    /** The argument object of one correct call. */
+    example?: unknown;
+    /** The tool's valid operations — only when the op was missing or unknown. */
+    operations?: string[];
+    /** The call that returns the full article. */
+    reference?: CallRef;
+}
+/** The machine-readable half of a failure. Carried on `event: error` frames (a
+ *  terminal run failure) and on a failed `event: tool_result` frame.
  *
  *  Once the SSE stream is open the HTTP status is already 200, so without this
  *  a consumer's only signal is the event type plus an English string —
  *  "retry shortly" and "your budget is exhausted" look identical and want
  *  opposite responses. */
 export interface ErrorInfo {
-    /** "transient" | "validation" | "business" | "permission". */
-    category: string;
+    /** "transient" | "validation" | "business" | "permission". Absent only on a
+     *  failed tool call not yet classified that still carries
+     *  `correct_call_format`. */
+    category?: string;
     /** Answers only "will resending this exact call fail?" — not "should I give
      *  up". A false here still leaves the alternatives in `description` open. */
     is_retryable: boolean;
@@ -252,6 +279,9 @@ export interface ErrorInfo {
      *  when there is no hint: an absent hint and a zero one are opposite
      *  instructions. */
     retry_after_ms?: number;
+    /** The correct shape of the call that failed, on a failed tool call whose
+     *  shape may be the cause. */
+    correct_call_format?: CallFormat;
 }
 /** What one hook did to one call, or to the run (the `hook_decision`
  *  payload). */
@@ -262,9 +292,13 @@ export interface HookDecisionInfo {
     /** The call a tool hook decided on; absent for agent_start / agent_stop. */
     tool_use_id?: string;
     tool_name?: string;
+    /** The message a `channel_publish` hook decided on. */
+    channel?: string;
+    message_id?: string;
     /** `block` and `hold` are agent_stop's: the model was sent back with
-     *  `reason`, or the answer is held for a verdict. */
-    decision: "deny" | "rewrite_input" | "rewrite_output" | "context" | "block" | "hold" | "unavailable";
+     *  `reason`, or the answer is held for a verdict. `release`,
+     *  `rewrite_body` and `drop` are a channel hook's (it may `hold` too). */
+    decision: "deny" | "rewrite_input" | "rewrite_output" | "context" | "block" | "hold" | "unavailable" | "release" | "rewrite_body" | "drop";
     /** For `unavailable`: `open` (the call went ahead) or `closed` (refused). */
     fail_mode?: "open" | "closed";
     /** A deny's or block's text, a hold's reason, or the error that made the
@@ -502,11 +536,12 @@ export interface AgentEvent {
     /** Set on `event: override` frames — what the operator changed, and from
      *  what to what. */
     override?: OverrideInfo;
-    /** Payload on `event: error` — the classification of a TERMINAL run failure.
-     *  Absent on every other event type, and absent for a failure the runtime
-     *  cannot categorise: there is deliberately no "unknown" category, so a
-     *  missing `error_info` means "not classified", never "classified as
-     *  nothing in particular". */
+    /** Payload on `event: error` — the classification of a TERMINAL run failure
+     *  — and on a failed `event: tool_result`: its classification and the
+     *  correct call format. Absent on every other event type, and absent for a
+     *  failure the runtime cannot categorise: there is deliberately no "unknown"
+     *  category, so a missing `error_info` means "not classified", never
+     *  "classified as nothing in particular". */
     error_info?: ErrorInfo;
     agent_id?: string;
     run_id?: string;
@@ -723,6 +758,12 @@ export interface RunOptions extends RunOverrideOptions {
      *  seconds as rejected (stop reason `review_expired`). Each hold gets the
      *  full window; omit for no deadline. Set at start only. */
     reviewTtlSeconds?: number;
+    /** Hooks this run adds to its agent's own, by event. Only ever added —
+     *  nothing here removes a hook the agent carries — and sub-agents the run
+     *  starts inherit them. They never widen hosts. Set at start only. */
+    hooks?: EventHooks;
+    /** Hooks for one of the agent's tools, by tool name. Set at start only. */
+    toolHooks?: ToolHooksByTool;
     /** Per-run LLM sampling override (v0.28.0), merged PER FIELD over the
      *  agent's own sampling (this wins; unset fields inherit). Omitted =
      *  inherit entirely. */
@@ -996,6 +1037,12 @@ export interface ContinueOptions extends RunOverrideOptions {
      *  seconds as rejected (stop reason `review_expired`). Each hold gets the
      *  full window; omit for no deadline. Set at start only. */
     reviewTtlSeconds?: number;
+    /** Hooks this run adds to its agent's own, by event. Only ever added —
+     *  nothing here removes a hook the agent carries — and sub-agents the run
+     *  starts inherit them. They never widen hosts. Set at start only. */
+    hooks?: EventHooks;
+    /** Hooks for one of the agent's tools, by tool name. Set at start only. */
+    toolHooks?: ToolHooksByTool;
     /** Per-continuation LLM sampling override — see {@link RunOptions.sampling}. */
     sampling?: SamplingOptions;
     /** Per-run tool choice (RFC DI): whether and which tool the model must
@@ -1117,6 +1164,12 @@ export interface RunSpec {
     interruption?: Record<string, unknown>;
     /** The caller's host narrowing. */
     hosts?: Record<string, unknown>;
+    /** Hooks the run added to its agent's own (its request's, and a
+     *  sub-agent's inherited ones). */
+    hooks?: {
+        hooks?: EventHooks;
+        tool_hooks?: ToolHooksByTool;
+    };
 }
 /** A finished run's answer (RFC DI). */
 export interface RunResult {
@@ -1794,7 +1847,10 @@ export interface ResolveInterruptOptions {
 }
 /** `post_failure` runs only when the tool failed, before the post chain, with
  *  the failure's classification in the payload. */
-export type HookPhase = "pre" | "post" | "post_failure" | "agent_start" | "agent_stop" | "subagent_start" | "subagent_stop" | "pre_compact" | "post_compact" | "run_end";
+export type HookPhase = "pre" | "post" | "post_failure" | "agent_start" | "agent_stop" | "subagent_start" | "subagent_stop" | "pre_compact" | "post_compact" | "run_end"
+/** A channel's event: runs on each message published to a channel that
+ *  carries hooks, before any reader sees it. */
+ | "channel_publish";
 export type HookFailMode = "open" | "closed";
 export interface HookToolCall {
     id: string;
@@ -1842,6 +1898,35 @@ export interface PostHookCall {
     tool_call: HookToolCall;
     tool_result: HookToolResult;
 }
+/** What a `channel_publish` webhook receives: one message, before any reader
+ *  of the channel sees it. */
+export interface ChannelHookCall {
+    phase: "channel_publish";
+    /** `"channel:<name>"`. */
+    owner: string;
+    hook_name: string;
+    channel: string;
+    scope: string;
+    scope_id?: string;
+    /** The same on every call for this message — a retry, or after a restart. */
+    message_id: string;
+    published_at: string;
+    published_by?: string;
+    /** `"starter_sink"` for a Starter's per-run result: a drop delivers it as
+     *  an error result rather than removing it. */
+    origin?: string;
+    /** Counts this hook's calls for this message, from 1. */
+    attempt: number;
+    /** The message as the previous hook in the chain left it. */
+    body: unknown;
+}
+/** What a `channel_publish` webhook returns. An empty body releases the
+ *  message as it is. `updated_body` goes with `release` only. */
+export interface ChannelHookResult {
+    decision?: "release" | "drop" | "hold";
+    updated_body?: unknown;
+    reason?: string;
+}
 /** Input shape for {@link LoomcycleClient.agentDef} and
  *  {@link LoomcycleClient.skillDef}. Mirrors the in-process tool
  *  input — `op` discriminates create / fork / get / list / promote
@@ -2320,7 +2405,13 @@ export interface ChannelDescriptor {
     max_messages?: number;
     /** Breakpoint: publishes are stored but never delivered until released. */
     hold?: boolean;
+    /** Hooks that decide each message before any reader sees it. */
+    hooks?: EventHooks;
     message_count: number;
+    /** Messages held for a release, and waiting for the channel's hooks —
+     *  both counted in `message_count`. */
+    held_count?: number;
+    awaiting_hooks_count?: number;
     /** RFC3339 — empty when count == 0. */
     oldest_visible_at?: string;
     newest_visible_at?: string;
@@ -2365,6 +2456,13 @@ export interface ChannelPublishResult {
     created_at: string;
     /** RFC3339Nano. Omitted when the publish was immediate. */
     visible_at?: string;
+    /** The channel holds: stored, not delivered until released. */
+    held?: boolean;
+    /** The channel carries hooks: stored, delivered only if they release it. */
+    awaiting_hooks?: boolean;
+    /** How many of the channel's oldest messages the write trimmed to stay
+     *  within max_messages. */
+    dropped_oldest?: number;
 }
 /** Options for {@link LoomcycleClient.subscribeChannel}. The call is a
  *  single-round-trip long-poll, NOT an open SSE stream — returns
@@ -2482,6 +2580,9 @@ export interface ChannelBroadcastEntry {
     created_at?: string;
     visible_at?: string;
     error?: string;
+    /** As on a single publish. */
+    held?: boolean;
+    awaiting_hooks?: boolean;
 }
 /** Response shape for {@link LoomcycleClient.broadcastChannels}.
  *  `published` + `failed` = the deduped channel count. */
@@ -2497,7 +2598,7 @@ export interface ChannelBroadcastResult {
 export interface CreateChannelOptions {
     name: string;
     description?: string;
-    /** "global" | "agent" | "user". Defaults to "global" if omitted. */
+    /** "global" | "tenant" | "agent" | "user". Defaults to "global" if omitted. */
     scope?: string;
     /** "queue" | "topic". Defaults to "queue" if omitted. */
     semantic?: string;
@@ -2512,6 +2613,11 @@ export interface CreateChannelOptions {
     /** Breakpoint: publishes are stored but never delivered until
      *  {@link LoomcycleClient.releaseChannel} hands them over. */
     hold?: boolean;
+    /** Hooks that decide each message published to the channel before any
+     *  reader sees it: `{ channel_publish: [HookDef name | inline webhook] }`.
+     *  Skipped while the server runs no channel hooks; an unknown HookDef is
+     *  refused (400 `channel_hooks_invalid`). */
+    hooks?: EventHooks;
     signal?: AbortSignal;
 }
 /** Options for {@link LoomcycleClient.updateChannel}. Nil fields
@@ -2525,6 +2631,8 @@ export interface UpdateChannelOptions {
     /** Turn the breakpoint on or off. Messages already held stay held
      *  until released — turning it off does not flush the queue. */
     hold?: boolean;
+    /** Replace the channel's hooks; `{}` removes them. */
+    hooks?: EventHooks;
     signal?: AbortSignal;
 }
 /** Options for {@link LoomcycleClient.releaseChannel}. */
@@ -2820,7 +2928,9 @@ export interface AgentInterruptionACL {
 }
 /** A hook event: a tool call's `pre` / `post` / `post_failure`, or a point in
  *  the run. */
-export type HookEvent = "pre" | "post" | "post_failure" | "agent_start" | "agent_stop" | "subagent_start" | "subagent_stop" | "pre_compact" | "post_compact" | "run_end";
+export type HookEvent = "pre" | "post" | "post_failure" | "agent_start" | "agent_stop" | "subagent_start" | "subagent_stop" | "pre_compact" | "post_compact" | "run_end"
+/** A channel's own event; an agent, a team or a run cannot attach it. */
+ | "channel_publish";
 /** A webhook written into the definition that attaches it. */
 export interface InlineWebhook {
     name: string;
@@ -2837,11 +2947,22 @@ export interface InlineWebhook {
 export type HookEntry = string | InlineWebhook;
 /** Hooks per event, in chain order. */
 export type EventHooks = Partial<Record<HookEvent, HookEntry[]>>;
+/** Each tool's own hooks, by tool name. */
+export type ToolHooksByTool = Record<string, Partial<Record<"pre" | "post" | "post_failure", HookEntry[]>>>;
 /** A `tools` entry that carries that tool's own hooks. */
 export interface ToolEntry {
     name: string;
     hooks: Partial<Record<"pre" | "post" | "post_failure", HookEntry[]>>;
 }
+/** An agent's opt-in to the listwise search rerank (`memory_rerank`). A fork
+ *  overlay merges it per field. */
+export interface MemoryRerank {
+    enabled?: boolean;
+    /** How many search candidates the model is shown (2-50). Default 20. */
+    candidates?: number;
+    /** Per-candidate character budget (200-20000). Default 1200. */
+    max_chars?: number;
+}
 export interface AgentDefOverlay {
     provider?: string;
     model?: string;
@@ -2866,7 +2987,7 @@ export interface AgentDefOverlay {
      *  takes these verbatim. */
     hooks?: EventHooks;
     /** Each tool's own hooks, by tool name. */
-    tool_hooks?: Record<string, Partial<Record<"pre" | "post" | "post_failure", HookEntry[]>>>;
+    tool_hooks?: ToolHooksByTool;
     skills?: string[];
     memory_scopes?: string[];
     /** RFC DF: recall attaches the conversation TURN each fact was distilled from,
@@ -2888,6 +3009,14 @@ export interface AgentDefOverlay {
      *  `history_scope`, and needs the trace index enabled AND backfilled — an empty
      *  index yields zero turns silently. */
     recall_attach_traces?: boolean;
+    /** Rerank this agent's document searches: `Memory op=search`, `Document
+     *  op=search`, and `recall` when it asks for documents, reorder their first
+     *  candidates with the operator's
+     *  `memory.reranker` model. Costs one model call per search (about 6,000 prompt
+     *  tokens), which is why it is set here and has NO tool parameter. The response
+     *  reports `reranked` (and `rerank_reason` when false); a failed or unavailable
+     *  rerank keeps the search's own order. */
+    memory_rerank?: MemoryRerank;
     memory_quota_bytes?: number;
     memory_backend?: string;
     retry_attempts?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loomcycle/client",
-  "version": "1.97.0",
+  "version": "1.99.0",
   "description": "TypeScript client for the loomcycle sidecar (HTTP+SSE). 71 methods covering run streaming, agent metadata, pause/resume/state, resolver re-probe (resolveProbe — issue #88 operator escape hatch), operator-token admin (operatorTokenDef — RFC L OSS multi-tenant auth) + whoami (RFC L authoritative principal, v0.17.0) + tenant-scoped listUsers / listUserAgents, dynamic MCP registration (mcpServerDef + v0.18.0 typed mcpServerDefVerify + ensureMcpServer idempotent register-if-changed), snapshot lifecycle, memory admin (incl. v0.9.0 Vector Memory embed_stats + reembed AND v0.11.5 setMemoryEntry + deleteMemoryEntry), interruption resolve, hook management, v0.8.22 substrate admin (agentDef + skillDef), v0.9.x n8n Phase 0 (listChannels + streamUserRunStates), v0.9.x Channel CRUD (publishChannel + subscribeChannel + peekChannel + ackChannel), v0.11.5 Channel admin CRUD (createChannel + updateChannel + deleteChannel — runtime substrate; yaml channels refuse mutation with HTTP 409), v0.9.x content_sha256 verify, v0.9.1 transcript first-cycle, v0.9.x dynamic MCP server registration (mcpServerDef + MCPServerDefVerifyResult), v0.10.3 Library v2 enumeration (listLibraryAgents + listLibrarySkills + listLibraryMcpServers), and v0.11.0 LLM Gateway (llmChat + llmStream — direct provider routing without agent overhead; primary target is n8n's LoomCycleChatModel AI Agent sub-node and any LangChain-compatible consumer). v0.10.1 — dual ESM + CommonJS distribution (additive — ESM consumers unchanged; CJS consumers like n8n's community-node loader now work). v0.19.0 — typed inline code-js agent ingestion (AgentDefOverlay.code_body + ensureCodeAgent — register a deterministic code agent through the substrate with no host filesystem bind; RFC J). v0.20.0 — ensureMcpServer surfaces discoveredToolCount straight from create (loomcycle now auto-discovers MCP tools at ingestion); rediscover is now an explicit force-refresh. v0.21.0 — run/continue accept optional non-secret `metadata` (repo name, review policy, …) passed to the agent, symmetric with the WebHook/Schedule trigger paths. v0.22.0 — version-aligned lockstep release; no client-surface change (RFC N tenant isolation of the agent/skill/MCP/Schedule/Webhook definition plane + real op-schemas on the builtin MCP meta-tools are both server-side). v0.23.0 — version-aligned lockstep release; no client-surface change (RFCs O/P/R MCP-server hardening + thin client and the RFC Q DeepSeek tool-content fix are all server-side / MCP-transport-side). v0.24.0 — purgeChannel clears a channel's buffered messages without deleting its definition (allowed on yaml-declared channels too, unlike deleteChannel — F20); AgentDefOverlay gains channels / evaluation_scopes / interruption so a COMPLETE interactive/multi-agent agent round-trips over the substrate (F14). (Consolidates the interim 0.24/0.25 package bumps, which were never tag-published, back into lockstep with the loomcycle v0.24.0 tag.) v0.25.0 — adds the RFC S channel fan-in/fan-out client twins: awaitChannels() (wait for any/all/at_least N messages across channels, or a timeout — non-committing) + broadcastChannels() (publish one payload to N channels in one atomic-pre-flight call), the client-facing counterparts of the in-band Channel.await / Channel.broadcast tool ops (the rest of v0.25.0 — the manual-management Web UI console + Context op=time + max_fires self-retiring schedules — is server-side / in-band, no client-surface change). v0.29.1 — Usage gains optional `max_context_tokens` (the serving model's context-window ceiling, stamped by the loop from Provider.Capabilities() on each usage event) so a consumer can render a 'context used / max' gauge without a hard-coded per-model table; additive + optional, no behavior change. (Lockstep catch-up: the field landed in loomcycle v0.29.0 but the adapter publish skipped on a version mismatch; v0.29.1 realigns the package version with the release tag so it publishes.) v0.33.0 — gRPC + TS client parity for the RFC Y external fan-out and the compaction surface: spawnRunBatch() (POST /v1/runs:batch — spawn up to 32 fresh runs concurrently in one call, combined index-aligned envelope, per-child failures in-envelope) + compactRun(runId) (POST /v1/runs/{run_id}/compact — summarize a parked run's context); plus per-run sampling + compaction overrides now accepted on runStreaming / continueSession (an explicit temperature 0 is preserved as deterministic, not dropped as falsy). (The gRPC half adds the matching SpawnRunBatch / CompactRun RPCs + the sampling/compaction fields on RunRequest/ContinueRequest — server-side.) v0.34.0 — version-aligned lockstep release; no client-surface change (context-transform plugins / RFC Z Phase 1a are server-side config; the exp7 hardening pass is server-side; the R2 cross-provider thinking-model downgrade surfaces a new `model_downgraded` SSE event the generic stream passes through unchanged). v0.35.0 — RFC AH dynamic filesystem volumes: volumeDef() (POST /v1/_volumedef — op-discriminated create/get/list/delete/purge; a Volume is flat, so delete unmaps + purge RemoveAll's, no retire/promote/fork) + listVolumes() / listEphemeralVolumes() (GET /v1/_volumes[/ephemeral] — tenant-scoped; host paths redacted for non-operator callers). Tenant-confined; the runtime derives the path inside an operator-blessed dynamic_root, so callers pass name + mode, never a host path. v1.1.1 — RFC AI interactive agentic sessions: an `interactive: true` flag on runStreaming/continueSession (a run that parks at end_turn for steering) + sendRunInput(runId, text) (POST /v1/runs/{id}/input — steer a live run) + streamRunByID(runId, {fromSeq}) (GET /v1/runs/{id}/stream — re-attach by run_id; the operator's prior turns replay as `steer` events so a cold client reconstructs the whole conversation) + a high-level InteractiveSession driver (client.interactiveSession / attachInteractiveSession — events()/send()/cancel(), the adapter port of the Web UI run terminal). The AgentEvent union gains awaiting_input/steer/context_compaction frames. Version-aligned with the loomcycle v1.1.x line so the v1.1.1 tag publishes it (also carrying the previously-unpublished v0.35.0 volume surface). v1.4.0 — RFC AL Path VFS + RFC AK Document on the wire: path(input) (POST /v1/_path — a Unix-like filesystem over Memory/Volumes/Documents; resolve/ls/stat/mkdir/mv/rm) + document(input) (POST /v1/_document — chunked-graph documents; 13 ops, needs SQL Memory on the sidecar). Scope (agent/user/tenant) + tenant are resolved server-side from the authenticated principal, never the wire; an off-run scope:'user' op keys on the principal subject so it interoperates with that user's agent runs. New PathToolInput / DocumentToolInput types; responses are op-varying (unknown — narrow as needed). v1.7.0 — RFC AT image/vision input: the PromptContent union gains an `image` variant ({ type:'image'; media_type: ImageMediaType; data: base64-no-prefix }) accepted in a user segment by runStreaming / continueSession (segments pass through unchanged — no method change). The model must be vision-capable or the run errors before the call. New ImageMediaType type (image/png|jpeg|gif|webp). v1.12.1 — Path/Document browse-by-subject + the full Document op set (RFC AS/AK): path(input, opts) / document(input, opts) accept optional scopeId / tenant browse overrides sent as ?scope_id= / ?tenant= query params (server reads them from the URL, re-checks authorization; omit both to browse your own subject — byte-identical to the pre-RFC-AS request), and DocumentToolInput.op now covers all 16 backend ops (adds set_path, export_md, import_md) with the matching include_metadata / markdown fields. Additive — existing path() / document() callers are unchanged. v1.16.0 — RFC BC client-executed tools (local tool host): connectClientTools({tools,onInvoke}) opens a persistent WebSocket to /v1/client-tools, registers tools this client runs on the user's machine (browser DOM / files / shell), and answers the invoke frames loomcycle routes when an agent of your principal calls a client:<tool> — returning your reply as an ordinary tool result. Returns a ClientToolHost driver (.close() to stop; auto-reconnect); dependency-free (global WebSocket in browsers / Node 22+, or an injected WebSocketImpl like the ws package on older Node); the bearer rides the Sec-WebSocket-Protocol subprotocol (browsers can't set an Authorization header on a WebSocket). The runtime's first WebSocket surface. v1.45.0 — RFC BL P5 subject erasure: erasureReport(subject, {tenant}) (GET /v1/_erasure — what this deployment holds about one subject, in three tiers: deletable with existing primitives, subject-keyed but not deletable, and facts ABOUT the subject in scopes they do not own) + erasureExecute(subject, {dryRun, confirm, tenant}) (POST /v1/_erasure — removes tiers 1 and 2). DEFAULTS TO A DRY RUN: dryRun defaults true and a live run also requires confirm === subject. The tier-3 residue is traceable only through the subject's chats, which a live run deletes, so a report afterwards shows rows: 0 while those facts remain — the returned object is the only durable record of what was not reached; persist it. New ErasureReport / ErasureResult / ErasureTier / ErasureResidue types. v1.47.0 — RFC BV memory-view SDK: memorySearch() (POST /v1/_memory/search — off-run unified semantic search spanning k/v entries AND document-chunk bodies in one ranked list, each hit tagged kind memory|document with chunk_id on document hits) + memoryEmbedStats(scope) + reembedMemory(scope, scopeId, {dryRun,limit}) (the Vector Memory embed-admin reads the memory-view console needs; dry_run defaults true). Fact reads (list_facts + get_chunk's entity block) ride the existing document() passthrough. Additive — existing callers unchanged. v1.61.0 — RFC CJ per-run context-window override: runStreaming / continueSession accept an optional maxContextTokens (integer tokens) that wins over the agent's own max_context_tokens; omitted inherits it (which defers to the provider/driver default). Distinct from a model's output cap; primarily for local inference (Ollama num_ctx). Serialized as the snake_case max_context_tokens field on POST /v1/runs + the continuation body; additive, existing callers unchanged. v1.72.1 — the TeamDef version lifecycle: listTeamVersions(name) (op=list — every version of one team, newest first), promoteTeam(defId) (op=promote — point the active pointer, which is what a run BY NAME executes; forkTeam defaults to promote:false, so authoring and putting in force stay two steps), retireTeam(defId, retired) (op=retire — reversible and version-scoped, unlike deleteTeam) and verifyTeam(name, contentSha256) (op=verify — the drift check for a workflow kept in source control and pushed to several deployments; an absent team answers deployed:false rather than raising). The ops existed on the substrate and over HTTP; a client that could author a team could not put one in force.",
   "license": "Apache-2.0",
   "type": "module",