@loomcycle/client 0.11.3 → 0.11.5

package/README.md

@@ -6,7 +6,7 @@ TypeScript client for the [loomcycle](https://github.com/denn-gubsky/loomcycle)
 
 ## Status
 
-**v0.11.3** — 41 methods covering run streaming, agent metadata, transcript, pause/resume/state, snapshot lifecycle, memory admin, interruption resolve, hook registration, **v0.8.22 substrate admin (agentDef + skillDef)**, **v0.9.x n8n Phase 0 (listChannels + streamUserRunStates)**, **v0.9.x content_sha256**, **v0.9.x dynamic MCP server registration (mcpServerDef)**, **v0.10.3 Library v2 enumeration (listLibraryAgents/Skills/McpServers)**, **v0.11.0 LLM Gateway (llmChat + llmStream)**, and health.
+**v0.11.4** — 42 methods covering run streaming, agent metadata, transcript, pause/resume/state, snapshot lifecycle, memory admin, interruption resolve, hook registration, **v0.8.22 substrate admin (agentDef + skillDef)**, **v0.9.x n8n Phase 0 (listChannels + streamUserRunStates)**, **v0.9.x content_sha256**, **v0.9.x dynamic MCP server registration (mcpServerDef)**, **v0.10.3 Library v2 enumeration (listLibraryAgents/Skills/McpServers)**, **v0.11.0 LLM Gateway (llmChat + llmStream)**, **v0.11.4 OpenAI Embeddings (embeddings)**, and health.
 
 > Migrating from raw `fetch` against `/v1/*`? See **[docs/MIGRATING-FROM-HTTP.md](./docs/MIGRATING-FROM-HTTP.md)** for a side-by-side walkthrough.
 
@@ -25,6 +25,7 @@ TypeScript client for the [loomcycle](https://github.com/denn-gubsky/loomcycle)
 - **First-run UX on the binary** (v0.11.1) — paired CLI commands `loomcycle init` (bootstrap config) + `loomcycle doctor` (health check) + auto-discovery of `~/.config/loomcycle/loomcycle.yaml`. No adapter changes; lockstep version bump only.
 - **Docker image + brew formula polish** (v0.11.2) — multi-arch image at `docker.io/denngubsky/loomcycle`; brew formula caveats refreshed to reference `loomcycle init` / `loomcycle doctor`; new `installation` Context.help topic. No adapter changes; lockstep version bump only.
 - **OpenAI Chat Completions compatibility shim** (v0.11.3) — new `POST /v1/chat/completions` endpoint serves OpenAI's exact wire shape; consumers using the OpenAI SDK can point at loomcycle by changing only base URL + auth token. `@loomcycle/client` consumers should still prefer `llmChat()` / `llmStream()` over the shim for richer typing (per-frame discriminated unions vs OpenAI's flat chunks). No adapter changes; lockstep version bump only.
+- **OpenAI Embeddings compatibility shim** (v0.11.4) — new `POST /v1/embeddings` endpoint serves OpenAI's Embeddings API shape. New `embeddings()` adapter method + four typed exports (`LLMEmbeddingsOptions`, `LLMEmbeddingsResponse`, `LLMEmbeddingItem`, `LLMEmbeddingsUsage`). Dispatches to the single configured `providers.Embedder` (the same instance Memory tool uses); RAG tools / vector DBs / LangChain `OpenAIEmbeddings` consumers point at loomcycle by changing only the base URL.
 
 ## Install
 

package/dist/cjs/client.js

@@ -521,6 +521,29 @@ class LoomcycleClient {
         const reader = resp.body.getReader();
         yield* parseLLMStreamFrames(reader);
     }
+    // ---- v0.11.4 OpenAI Embeddings compatibility shim ----
+    /** Compute embedding vectors via the OpenAI-compatible
+     *  `/v1/embeddings` endpoint. Dispatches to the single configured
+     *  `providers.Embedder` (the same instance Memory tool uses for
+     *  `embed:true` internally). No resolver path, no tier overlay,
+     *  no streaming — embeddings are synchronous.
+     *
+     *  Accepts `input` as a string OR string array. Tokenized inputs
+     *  (number arrays) are refused at the server boundary — send text.
+     *  `encoding_format: "base64"` packs each float32 little-endian
+     *  then base64-encodes (saves ~25% wire bytes on 1536-dim
+     *  vectors); "float" (default) emits each vector as a JSON array.
+     *
+     *  Raises {@link AuthError} on 401; {@link UnavailableError} on
+     *  503 (no embedder configured — set memory.embedder.* in
+     *  loomcycle.yaml); {@link InvalidArgumentError} on 400 (bad
+     *  request shape). */
+    async embeddings(opts) {
+        const { signal: _signal, ...body } = opts;
+        return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/embeddings", body, {
+            signal: opts.signal,
+        });
+    }
     // ---- Internal helpers ----
     /** Shared SSE POST → stream-of-AgentEvent path. Used by
      *  runStreaming + continueSession.
@@ -684,6 +707,78 @@ class LoomcycleClient {
         const path = channelOpPath(channel, opts.scope, opts.userId, "ack");
         return (0, fetch_helpers_js_1.postJSON)(this.ctx, path, { cursor: opts.cursor }, { signal: opts.signal });
     }
+    // ---- v0.11.5 Channel admin CRUD ----
+    //
+    // Three bearer-authed ops that mutate the runtime-substrate
+    // channel registry. yaml-declared channels are immutable from
+    // this surface — the server refuses with HTTP 409 + wire `code`
+    // `channel_yaml_immutable`. The TS adapter surfaces that as a
+    // {@link LoomcycleError} with status 409.
+    /** Create a new runtime-substrate channel. Refuses with HTTP 409
+     *  when the name matches a yaml-declared channel (code
+     *  `channel_yaml_immutable`) or an existing runtime channel
+     *  (code `channel_name_in_use`). */
+    async createChannel(opts) {
+        const body = { name: opts.name };
+        if (opts.description !== undefined)
+            body.description = opts.description;
+        if (opts.scope !== undefined)
+            body.scope = opts.scope;
+        if (opts.semantic !== undefined)
+            body.semantic = opts.semantic;
+        if (opts.default_ttl !== undefined)
+            body.default_ttl = opts.default_ttl;
+        if (opts.max_messages !== undefined)
+            body.max_messages = opts.max_messages;
+        if (opts.publisher !== undefined)
+            body.publisher = opts.publisher;
+        if (opts.period !== undefined)
+            body.period = opts.period;
+        return (0, fetch_helpers_js_1.postJSON)(this.ctx, "/v1/_channels", body, {
+            signal: opts.signal,
+        });
+    }
+    /** Partially update a runtime-substrate channel. Nil-valued fields
+     *  in `opts` leave the corresponding attribute unchanged. Refuses
+     *  yaml-declared channels with HTTP 409. */
+    async updateChannel(name, opts) {
+        const body = {};
+        if (opts.description !== undefined)
+            body.description = opts.description;
+        if (opts.default_ttl !== undefined)
+            body.default_ttl = opts.default_ttl;
+        if (opts.max_messages !== undefined)
+            body.max_messages = opts.max_messages;
+        if (opts.semantic !== undefined)
+            body.semantic = opts.semantic;
+        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
+     *  messages + cursors. yaml-declared channels refuse with HTTP 409.
+     *  Idempotent: deleting a non-existent runtime channel returns a
+     *  {@link NotFoundError} so the caller can distinguish that case. */
+    async deleteChannel(name, opts) {
+        return (0, fetch_helpers_js_1.deleteRequest)(this.ctx, `/v1/_channels/${encodeURIComponent(name)}`, opts);
+    }
+    // ---- v0.11.5 Memory entry admin CRUD ----
+    /** Idempotently upsert one memory entry by full (scope, scope_id,
+     *  key) identifier. PUT semantics — re-writes overwrite the value.
+     *  Optional embed flag triggers a synchronous embed via the
+     *  operator-configured embedder. */
+    async setMemoryEntry(scope, scopeID, key, opts) {
+        const body = { value: opts.value };
+        if (opts.embed !== undefined)
+            body.embed = opts.embed;
+        if (opts.ttl_seconds !== undefined)
+            body.ttl_seconds = opts.ttl_seconds;
+        return (0, fetch_helpers_js_1.putJSON)(this.ctx, `/v1/_memory/scopes/${encodeURIComponent(scope)}/${encodeURIComponent(scopeID)}/keys/${encodeURIComponent(key)}`, body, { signal: opts.signal });
+    }
+    /** Delete one memory entry by (scope, scope_id, key). Idempotent:
+     *  deleting a missing row is a non-error per the in-band Memory
+     *  tool's semantics — both surfaces return 204. */
+    async deleteMemoryEntry(scope, scopeID, key, opts) {
+        return (0, fetch_helpers_js_1.deleteRequest)(this.ctx, `/v1/_memory/scopes/${encodeURIComponent(scope)}/${encodeURIComponent(scopeID)}/keys/${encodeURIComponent(key)}`, opts);
+    }
     /** Subscribe to run state transitions for one user_id via SSE.
      *  Yields one `{ kind: "open", ... }` item first (confirms the
      *  connection is live), then one `{ kind: "event", ... }` per

package/dist/cjs/fetch-helpers.js

@@ -14,6 +14,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.authHeaders = authHeaders;
 exports.jsonFetch = jsonFetch;
 exports.postJSON = postJSON;
+exports.putJSON = putJSON;
+exports.patchJSON = patchJSON;
 exports.deleteRequest = deleteRequest;
 exports.raiseFromResponse = raiseFromResponse;
 const errors_js_1 = require("./errors.js");
@@ -65,6 +67,51 @@ async function postJSON(ctx, path, body, opts) {
         return null;
     return (await resp.json());
 }
+/** putJSON sends a JSON-encoded body via PUT and unwraps the
+ *  response. Idempotent — REST-canonical verb for "create or
+ *  overwrite by full identifier." */
+async function putJSON(ctx, path, body, opts) {
+    const headers = authHeaders(ctx);
+    let bodyStr;
+    if (body !== undefined) {
+        headers["Content-Type"] = "application/json";
+        bodyStr = JSON.stringify(body);
+    }
+    const resp = await ctx.fetchImpl(ctx.baseUrl + path, {
+        method: "PUT",
+        headers,
+        body: bodyStr,
+        signal: opts?.signal,
+    });
+    if (!resp.ok) {
+        await raiseFromResponse(resp);
+    }
+    if (resp.status === 204)
+        return null;
+    return (await resp.json());
+}
+/** patchJSON sends a JSON-encoded body via PATCH and unwraps the
+ *  response. For partial-update endpoints. */
+async function patchJSON(ctx, path, body, opts) {
+    const headers = authHeaders(ctx);
+    let bodyStr;
+    if (body !== undefined) {
+        headers["Content-Type"] = "application/json";
+        bodyStr = JSON.stringify(body);
+    }
+    const resp = await ctx.fetchImpl(ctx.baseUrl + path, {
+        method: "PATCH",
+        headers,
+        body: bodyStr,
+        signal: opts?.signal,
+    });
+    if (!resp.ok) {
+        await raiseFromResponse(resp);
+    }
+    if (resp.status === 204)
+        return null;
+    return (await resp.json());
+}
 /** deleteRequest sends a DELETE and tolerates 204/200/404-with-
  *  idempotent-semantics per the loomcycle wire contract. */
 async function deleteRequest(ctx, path, opts) {

package/dist/cjs/index.js

@@ -56,6 +56,9 @@
  *     llmChat(opts: LLMChatOptions): Promise<LLMChatResponse>
  *     llmStream(opts: LLMChatOptions): AsyncIterable<LLMChatStreamItem>
  *
+ *     // OpenAI Embeddings compatibility shim (v0.11.4)
+ *     embeddings(opts: LLMEmbeddingsOptions): Promise<LLMEmbeddingsResponse>
+ *
  *   Errors (typed subclasses of LoomcycleError; see README for the
  *   full HTTP-status → typed-error mapping table):
  *     LoomcycleError, AgentNotFoundError, SessionNotFoundError,

package/dist/client.d.ts

@@ -23,7 +23,7 @@
  * via fetch-helpers.ts:raiseFromResponse — see README.md for the
  * full mapping table.
  */
-import type { Agent, AgentEvent, AgentStatus, CancelAgentResult, ClientOptions, ContinueOptions, CreateSnapshotOptions, HealthResponse, Hook, InterruptListResponse, InterruptStatus, AckChannelOptions, ChannelAckResult, ChannelPeekResult, ChannelPublishResult, ChannelSubscribeResult, ListChannelsResponse, PeekChannelOptions, PublishChannelOptions, SubscribeChannelOptions, LibraryAgentDefinition, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, ListUsersResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, MemoryEntriesResponse, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopesResponse, PauseResult, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, RunOptions, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, TranscriptResponse } from "./types.js";
+import type { Agent, AgentEvent, AgentStatus, CancelAgentResult, ClientOptions, ContinueOptions, CreateSnapshotOptions, HealthResponse, Hook, InterruptListResponse, InterruptStatus, AckChannelOptions, ChannelAckResult, ChannelDescriptor, ChannelPeekResult, ChannelPublishResult, ChannelSubscribeResult, CreateChannelOptions, ListChannelsResponse, PeekChannelOptions, PublishChannelOptions, SetMemoryEntryOptions, SetMemoryEntryResponse, SubscribeChannelOptions, UpdateChannelOptions, LibraryAgentDefinition, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, ListUsersResponse, LLMChatOptions, LLMChatResponse, LLMChatStreamItem, LLMEmbeddingsOptions, LLMEmbeddingsResponse, MemoryEntriesResponse, MemoryEntryResponse, MemoryScopeIDsResponse, MemoryScopesResponse, PauseResult, RegisterHookOptions, RegisterHookResponse, ResolveInterruptOptions, ResumeResult, RunOptions, RunStateStreamItem, RuntimeStateResponse, SnapshotCreateResponse, SnapshotDescriptor, SnapshotEnvelope, SnapshotRestoreResponse, StreamUserRunStatesOptions, SubstrateToolInput, SubstrateToolResponse, TranscriptResponse } from "./types.js";
 export declare class LoomcycleClient {
     private ctx;
     constructor(opts?: ClientOptions);
@@ -361,6 +361,23 @@ export declare class LoomcycleClient {
      *  Use this for live token streaming into LangChain BaseChatModel
      *  `_stream` callbacks. */
     llmStream(opts: LLMChatOptions): AsyncIterable<LLMChatStreamItem>;
+    /** Compute embedding vectors via the OpenAI-compatible
+     *  `/v1/embeddings` endpoint. Dispatches to the single configured
+     *  `providers.Embedder` (the same instance Memory tool uses for
+     *  `embed:true` internally). No resolver path, no tier overlay,
+     *  no streaming — embeddings are synchronous.
+     *
+     *  Accepts `input` as a string OR string array. Tokenized inputs
+     *  (number arrays) are refused at the server boundary — send text.
+     *  `encoding_format: "base64"` packs each float32 little-endian
+     *  then base64-encodes (saves ~25% wire bytes on 1536-dim
+     *  vectors); "float" (default) emits each vector as a JSON array.
+     *
+     *  Raises {@link AuthError} on 401; {@link UnavailableError} on
+     *  503 (no embedder configured — set memory.embedder.* in
+     *  loomcycle.yaml); {@link InvalidArgumentError} on 400 (bad
+     *  request shape). */
+    embeddings(opts: LLMEmbeddingsOptions): Promise<LLMEmbeddingsResponse>;
     /** Shared SSE POST → stream-of-AgentEvent path. Used by
      *  runStreaming + continueSession.
      *
@@ -408,6 +425,33 @@ export declare class LoomcycleClient {
      *  raise a {@link ConflictError} (HTTP 409, code
      *  `channel_cursor_regression`). */
     ackChannel(channel: string, opts: AckChannelOptions): Promise<ChannelAckResult>;
+    /** Create a new runtime-substrate channel. Refuses with HTTP 409
+     *  when the name matches a yaml-declared channel (code
+     *  `channel_yaml_immutable`) or an existing runtime channel
+     *  (code `channel_name_in_use`). */
+    createChannel(opts: CreateChannelOptions): Promise<ChannelDescriptor>;
+    /** Partially update a runtime-substrate channel. Nil-valued fields
+     *  in `opts` leave the corresponding attribute unchanged. Refuses
+     *  yaml-declared channels with HTTP 409. */
+    updateChannel(name: string, opts: UpdateChannelOptions): Promise<ChannelDescriptor>;
+    /** Delete a runtime-substrate channel + cascade its persisted
+     *  messages + cursors. yaml-declared channels refuse with HTTP 409.
+     *  Idempotent: deleting a non-existent runtime channel returns a
+     *  {@link NotFoundError} so the caller can distinguish that case. */
+    deleteChannel(name: string, opts?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    /** Idempotently upsert one memory entry by full (scope, scope_id,
+     *  key) identifier. PUT semantics — re-writes overwrite the value.
+     *  Optional embed flag triggers a synchronous embed via the
+     *  operator-configured embedder. */
+    setMemoryEntry(scope: string, scopeID: string, key: string, opts: SetMemoryEntryOptions): Promise<SetMemoryEntryResponse>;
+    /** Delete one memory entry by (scope, scope_id, key). Idempotent:
+     *  deleting a missing row is a non-error per the in-band Memory
+     *  tool's semantics — both surfaces return 204. */
+    deleteMemoryEntry(scope: string, scopeID: string, key: string, opts?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
     /** Subscribe to run state transitions for one user_id via SSE.
      *  Yields one `{ kind: "open", ... }` item first (confirms the
      *  connection is live), then one `{ kind: "event", ... }` per

package/dist/client.js

@@ -23,7 +23,7 @@
  * via fetch-helpers.ts:raiseFromResponse — see README.md for the
  * full mapping table.
  */
-import { authHeaders, deleteRequest, jsonFetch, postJSON, raiseFromResponse, } from "./fetch-helpers.js";
+import { authHeaders, deleteRequest, jsonFetch, patchJSON, postJSON, putJSON, raiseFromResponse, } from "./fetch-helpers.js";
 import { parseSSE } from "./stream.js";
 export class LoomcycleClient {
     ctx;
@@ -518,6 +518,29 @@ export class LoomcycleClient {
         const reader = resp.body.getReader();
         yield* parseLLMStreamFrames(reader);
     }
+    // ---- v0.11.4 OpenAI Embeddings compatibility shim ----
+    /** Compute embedding vectors via the OpenAI-compatible
+     *  `/v1/embeddings` endpoint. Dispatches to the single configured
+     *  `providers.Embedder` (the same instance Memory tool uses for
+     *  `embed:true` internally). No resolver path, no tier overlay,
+     *  no streaming — embeddings are synchronous.
+     *
+     *  Accepts `input` as a string OR string array. Tokenized inputs
+     *  (number arrays) are refused at the server boundary — send text.
+     *  `encoding_format: "base64"` packs each float32 little-endian
+     *  then base64-encodes (saves ~25% wire bytes on 1536-dim
+     *  vectors); "float" (default) emits each vector as a JSON array.
+     *
+     *  Raises {@link AuthError} on 401; {@link UnavailableError} on
+     *  503 (no embedder configured — set memory.embedder.* in
+     *  loomcycle.yaml); {@link InvalidArgumentError} on 400 (bad
+     *  request shape). */
+    async embeddings(opts) {
+        const { signal: _signal, ...body } = opts;
+        return postJSON(this.ctx, "/v1/embeddings", body, {
+            signal: opts.signal,
+        });
+    }
     // ---- Internal helpers ----
     /** Shared SSE POST → stream-of-AgentEvent path. Used by
      *  runStreaming + continueSession.
@@ -681,6 +704,78 @@ export class LoomcycleClient {
         const path = channelOpPath(channel, opts.scope, opts.userId, "ack");
         return postJSON(this.ctx, path, { cursor: opts.cursor }, { signal: opts.signal });
     }
+    // ---- v0.11.5 Channel admin CRUD ----
+    //
+    // Three bearer-authed ops that mutate the runtime-substrate
+    // channel registry. yaml-declared channels are immutable from
+    // this surface — the server refuses with HTTP 409 + wire `code`
+    // `channel_yaml_immutable`. The TS adapter surfaces that as a
+    // {@link LoomcycleError} with status 409.
+    /** Create a new runtime-substrate channel. Refuses with HTTP 409
+     *  when the name matches a yaml-declared channel (code
+     *  `channel_yaml_immutable`) or an existing runtime channel
+     *  (code `channel_name_in_use`). */
+    async createChannel(opts) {
+        const body = { name: opts.name };
+        if (opts.description !== undefined)
+            body.description = opts.description;
+        if (opts.scope !== undefined)
+            body.scope = opts.scope;
+        if (opts.semantic !== undefined)
+            body.semantic = opts.semantic;
+        if (opts.default_ttl !== undefined)
+            body.default_ttl = opts.default_ttl;
+        if (opts.max_messages !== undefined)
+            body.max_messages = opts.max_messages;
+        if (opts.publisher !== undefined)
+            body.publisher = opts.publisher;
+        if (opts.period !== undefined)
+            body.period = opts.period;
+        return postJSON(this.ctx, "/v1/_channels", body, {
+            signal: opts.signal,
+        });
+    }
+    /** Partially update a runtime-substrate channel. Nil-valued fields
+     *  in `opts` leave the corresponding attribute unchanged. Refuses
+     *  yaml-declared channels with HTTP 409. */
+    async updateChannel(name, opts) {
+        const body = {};
+        if (opts.description !== undefined)
+            body.description = opts.description;
+        if (opts.default_ttl !== undefined)
+            body.default_ttl = opts.default_ttl;
+        if (opts.max_messages !== undefined)
+            body.max_messages = opts.max_messages;
+        if (opts.semantic !== undefined)
+            body.semantic = opts.semantic;
+        return patchJSON(this.ctx, `/v1/_channels/${encodeURIComponent(name)}`, body, { signal: opts.signal });
+    }
+    /** Delete a runtime-substrate channel + cascade its persisted
+     *  messages + cursors. yaml-declared channels refuse with HTTP 409.
+     *  Idempotent: deleting a non-existent runtime channel returns a
+     *  {@link NotFoundError} so the caller can distinguish that case. */
+    async deleteChannel(name, opts) {
+        return deleteRequest(this.ctx, `/v1/_channels/${encodeURIComponent(name)}`, opts);
+    }
+    // ---- v0.11.5 Memory entry admin CRUD ----
+    /** Idempotently upsert one memory entry by full (scope, scope_id,
+     *  key) identifier. PUT semantics — re-writes overwrite the value.
+     *  Optional embed flag triggers a synchronous embed via the
+     *  operator-configured embedder. */
+    async setMemoryEntry(scope, scopeID, key, opts) {
+        const body = { value: opts.value };
+        if (opts.embed !== undefined)
+            body.embed = opts.embed;
+        if (opts.ttl_seconds !== undefined)
+            body.ttl_seconds = opts.ttl_seconds;
+        return putJSON(this.ctx, `/v1/_memory/scopes/${encodeURIComponent(scope)}/${encodeURIComponent(scopeID)}/keys/${encodeURIComponent(key)}`, body, { signal: opts.signal });
+    }
+    /** Delete one memory entry by (scope, scope_id, key). Idempotent:
+     *  deleting a missing row is a non-error per the in-band Memory
+     *  tool's semantics — both surfaces return 204. */
+    async deleteMemoryEntry(scope, scopeID, key, opts) {
+        return deleteRequest(this.ctx, `/v1/_memory/scopes/${encodeURIComponent(scope)}/${encodeURIComponent(scopeID)}/keys/${encodeURIComponent(key)}`, opts);
+    }
     /** Subscribe to run state transitions for one user_id via SSE.
      *  Yields one `{ kind: "open", ... }` item first (confirms the
      *  connection is live), then one `{ kind: "event", ... }` per

package/dist/fetch-helpers.d.ts

@@ -43,6 +43,17 @@ export declare function jsonFetch<T>(ctx: _FetchContext, path: string, opts?: {
 export declare function postJSON<T>(ctx: _FetchContext, path: string, body?: unknown, opts?: {
     signal?: AbortSignal;
 }): Promise<T>;
+/** putJSON sends a JSON-encoded body via PUT and unwraps the
+ *  response. Idempotent — REST-canonical verb for "create or
+ *  overwrite by full identifier." */
+export declare function putJSON<T>(ctx: _FetchContext, path: string, body?: unknown, opts?: {
+    signal?: AbortSignal;
+}): Promise<T>;
+/** patchJSON sends a JSON-encoded body via PATCH and unwraps the
+ *  response. For partial-update endpoints. */
+export declare function patchJSON<T>(ctx: _FetchContext, path: string, body?: unknown, opts?: {
+    signal?: AbortSignal;
+}): Promise<T>;
 /** deleteRequest sends a DELETE and tolerates 204/200/404-with-
  *  idempotent-semantics per the loomcycle wire contract. */
 export declare function deleteRequest(ctx: _FetchContext, path: string, opts?: {

package/dist/fetch-helpers.js

@@ -58,6 +58,51 @@ export async function postJSON(ctx, path, body, opts) {
         return null;
     return (await resp.json());
 }
+/** putJSON sends a JSON-encoded body via PUT and unwraps the
+ *  response. Idempotent — REST-canonical verb for "create or
+ *  overwrite by full identifier." */
+export async function putJSON(ctx, path, body, opts) {
+    const headers = authHeaders(ctx);
+    let bodyStr;
+    if (body !== undefined) {
+        headers["Content-Type"] = "application/json";
+        bodyStr = JSON.stringify(body);
+    }
+    const resp = await ctx.fetchImpl(ctx.baseUrl + path, {
+        method: "PUT",
+        headers,
+        body: bodyStr,
+        signal: opts?.signal,
+    });
+    if (!resp.ok) {
+        await raiseFromResponse(resp);
+    }
+    if (resp.status === 204)
+        return null;
+    return (await resp.json());
+}
+/** patchJSON sends a JSON-encoded body via PATCH and unwraps the
+ *  response. For partial-update endpoints. */
+export async function patchJSON(ctx, path, body, opts) {
+    const headers = authHeaders(ctx);
+    let bodyStr;
+    if (body !== undefined) {
+        headers["Content-Type"] = "application/json";
+        bodyStr = JSON.stringify(body);
+    }
+    const resp = await ctx.fetchImpl(ctx.baseUrl + path, {
+        method: "PATCH",
+        headers,
+        body: bodyStr,
+        signal: opts?.signal,
+    });
+    if (!resp.ok) {
+        await raiseFromResponse(resp);
+    }
+    if (resp.status === 204)
+        return null;
+    return (await resp.json());
+}
 /** deleteRequest sends a DELETE and tolerates 204/200/404-with-
  *  idempotent-semantics per the loomcycle wire contract. */
 export async function deleteRequest(ctx, path, opts) {

package/dist/index.d.ts

@@ -55,6 +55,9 @@
  *     llmChat(opts: LLMChatOptions): Promise<LLMChatResponse>
  *     llmStream(opts: LLMChatOptions): AsyncIterable<LLMChatStreamItem>
  *
+ *     // OpenAI Embeddings compatibility shim (v0.11.4)
+ *     embeddings(opts: LLMEmbeddingsOptions): Promise<LLMEmbeddingsResponse>
+ *
  *   Errors (typed subclasses of LoomcycleError; see README for the
  *   full HTTP-status → typed-error mapping table):
  *     LoomcycleError, AgentNotFoundError, SessionNotFoundError,
@@ -73,5 +76,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, AgentDefRowResponse, AgentDefVerifyResult, SkillDefVerifyResult, MCPServerDefRowResponse, MCPServerDefVerifyResult, LibraryAgentDefinition, LibraryEntry, LibraryListResponse, LibraryMcpServerDefinition, LibrarySkillDefinition, LLMChatContent, LLMChatMessage, LLMChatOptions, LLMChatResponse, LLMChatStreamDelta, LLMChatStreamItem, LLMChatToolCall, LLMChatUsage, LLMTool, } from "./types.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 { 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

@@ -55,6 +55,9 @@
  *     llmChat(opts: LLMChatOptions): Promise<LLMChatResponse>
  *     llmStream(opts: LLMChatOptions): AsyncIterable<LLMChatStreamItem>
  *
+ *     // OpenAI Embeddings compatibility shim (v0.11.4)
+ *     embeddings(opts: LLMEmbeddingsOptions): Promise<LLMEmbeddingsResponse>
+ *
  *   Errors (typed subclasses of LoomcycleError; see README for the
  *   full HTTP-status → typed-error mapping table):
  *     LoomcycleError, AgentNotFoundError, SessionNotFoundError,

package/dist/types.d.ts

@@ -555,6 +555,7 @@ export interface PostHookResult {
  *  {@link LoomcycleClient.listChannels}. */
 export interface ChannelDescriptor {
     name: string;
+    description?: string;
     scope?: string;
     semantic?: string;
     publisher?: string;
@@ -565,6 +566,10 @@ export interface ChannelDescriptor {
     /** RFC3339 — empty when count == 0. */
     oldest_visible_at?: string;
     newest_visible_at?: string;
+    /** v0.11.5: "yaml" (operator yaml — immutable from this surface),
+     *  "runtime" (substrate — CRUD-mutable), "orphan" (no declaration,
+     *  only orphan messages). */
+    source?: "yaml" | "runtime" | "orphan" | string;
 }
 /** Response shape for {@link LoomcycleClient.listChannels}. */
 export interface ListChannelsResponse {
@@ -656,6 +661,63 @@ export interface AckChannelOptions {
 export interface ChannelAckResult {
     ok: boolean;
 }
+/** Options for {@link LoomcycleClient.createChannel}. Operator-yaml
+ *  channels are immutable from this surface; the server returns
+ *  HTTP 409 `channel_yaml_immutable` when `name` matches a yaml-
+ *  declared channel. */
+export interface CreateChannelOptions {
+    name: string;
+    description?: string;
+    /** "global" | "agent" | "user". Defaults to "global" if omitted. */
+    scope?: string;
+    /** "queue" | "topic". Defaults to "queue" if omitted. */
+    semantic?: string;
+    /** Seconds; 0 = no TTL. */
+    default_ttl?: number;
+    /** 0 = unbounded. */
+    max_messages?: number;
+    /** Free-form attribution; not enforced by the substrate. */
+    publisher?: string;
+    /** Free-form retention hint; not enforced by the substrate. */
+    period?: string;
+    signal?: AbortSignal;
+}
+/** Options for {@link LoomcycleClient.updateChannel}. Nil fields
+ *  leave the corresponding channel attribute unchanged. */
+export interface UpdateChannelOptions {
+    description?: string;
+    default_ttl?: number;
+    max_messages?: number;
+    /** "queue" | "topic" */
+    semantic?: string;
+    signal?: AbortSignal;
+}
+/** Options for {@link LoomcycleClient.setMemoryEntry}. `value` is
+ *  opaque JSON. Setting `embed: true` triggers a synchronous embed
+ *  via the operator-configured embedder; the returned `embedded`
+ *  flag + optional `embed_warning` report whether the embedding
+ *  landed. */
+export interface SetMemoryEntryOptions {
+    value: unknown;
+    /** When true, also compute + store the embedding (requires
+     *  memory.embedder yaml + a vector-capable store backend). */
+    embed?: boolean;
+    /** Optional TTL in seconds; <= 0 means "no expiry". */
+    ttl_seconds?: number;
+    signal?: AbortSignal;
+}
+/** Response shape for {@link LoomcycleClient.setMemoryEntry}. */
+export interface SetMemoryEntryResponse {
+    scope: string;
+    scope_id: string;
+    key: string;
+    /** true when the embedding was computed AND stored. */
+    embedded: boolean;
+    /** Non-empty when embed was requested but failed (transient
+     *  error, embedder unconfigured, vector backend not available).
+     *  The k/v row still landed. */
+    embed_warning?: string;
+}
 /** One run state transition emitted by
  *  {@link LoomcycleClient.streamUserRunStates}. The TS field is RFC3339. */
 export interface RunStateEvent {
@@ -1027,3 +1089,49 @@ export interface LLMChatStreamDelta {
     text?: string;
     partial_json?: string;
 }
+/** Request body for `embeddings()`. */
+export interface LLMEmbeddingsOptions {
+    /** Consumer's requested model id (echoed in the response).
+     *  Loomcycle uses the single configured embedder regardless;
+     *  the field is informational for drop-in compatibility. */
+    model: string;
+    /** Text(s) to embed. v1 accepts string or string[]; tokenized
+     *  inputs (number arrays) are refused — send text. */
+    input: string | string[];
+    /** "float" (default) emits each vector as a JSON array of
+     *  numbers; "base64" packs each float32 little-endian then
+     *  base64-encodes (saves ~25% wire bytes on 1536-dim vectors). */
+    encoding_format?: "float" | "base64";
+    /** OpenAI's post-hoc dimension reduction parameter. Accepted-
+     *  but-ignored in v0.11.4 (the providers.Embedder interface
+     *  doesn't take a dimension parameter today). */
+    dimensions?: number;
+    /** OpenAI-standard opaque end-user identifier. Maps to
+     *  loomcycle's per-user quota tracking + audit log. */
+    user?: string;
+    /** Optional AbortSignal for caller-driven cancellation. */
+    signal?: AbortSignal;
+}
+/** Per-embedding entry in the response data array. */
+export interface LLMEmbeddingItem {
+    object: "embedding";
+    /** float[] when the request used encoding_format:"float"
+     *  (default); base64 string when encoding_format:"base64". */
+    embedding: number[] | string;
+    index: number;
+}
+/** Token-accounting payload. v0.11.4 leaves both fields at 0 — the
+ *  substrate's Embedder interface doesn't return per-call token
+ *  counts today. When that lands, the shim's translator populates
+ *  these automatically. */
+export interface LLMEmbeddingsUsage {
+    prompt_tokens: number;
+    total_tokens: number;
+}
+/** Response shape mirrors OpenAI's /v1/embeddings exactly. */
+export interface LLMEmbeddingsResponse {
+    object: "list";
+    data: LLMEmbeddingItem[];
+    model: string;
+    usage: LLMEmbeddingsUsage;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loomcycle/client",
-  "version": "0.11.3",
-  "description": "TypeScript client for the loomcycle sidecar (HTTP+SSE). 41 methods covering run streaming, agent metadata, pause/resume/state, snapshot lifecycle, memory admin (incl. v0.9.0 Vector Memory embed_stats + reembed), 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.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).",
+  "version": "0.11.5",
+  "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",
   "repository": {