norns-sdk 0.1.0 → 0.3.0

package/dist/index.d.cts

@@ -264,6 +264,12 @@ declare class NornsClient {
         delete: (agent: AgentRef, key: string) => Promise<void>;
     };
 }
+/**
+ * A key issued by `POST /api/v1/api_keys` with a worker scope (`nrnw_...`).
+ * It opens the worker socket and nothing else, so a worker holding one must
+ * not try the REST API.
+ */
+declare function isScopedKey(apiKey: string): boolean;
 
 /**
  * Where the SDK writes what it is doing. Anything with these four methods
@@ -301,7 +307,11 @@ interface NornsWorkerOptions {
     agents: AgentDefinition | AgentDefinition[];
     /** The Norns base URL. Defaults to `NORNS_URL`. */
     url?: string;
-    /** The tenant's bearer token. Defaults to `NORNS_API_KEY`. */
+    /**
+     * The bearer token. Defaults to `NORNS_API_KEY`. A scoped worker key
+     * (`nrnw_...`) joins without registering the agents, since it cannot reach
+     * the REST API; register the definitions with a tenant key.
+     */
     apiKey?: string;
     /**
      * How a model name on an LLM task becomes a model to call: a function, a
@@ -582,6 +592,10 @@ declare class JoinError extends NornsError {
 declare class GardDestroyedError extends NornsError {
     constructor(gard: string | number | undefined);
 }
+/** The scoped key this worker joined on was revoked while it was connected. */
+declare class KeyRevokedError extends NornsError {
+    constructor();
+}
 /** A stream's socket closed before the run reached a terminal event. */
 declare class StreamClosedError extends NornsError {
     readonly reason: unknown;
@@ -626,6 +640,12 @@ interface LlmTask {
     summary?: string | null;
     date?: string | null;
     messages?: NeutralMessage[];
+    /** In place of `messages` once this worker holds the run's history (see HistoryCache). */
+    messages_delta?: {
+        base_count: number;
+        drop: number;
+        append: NeutralMessage[];
+    };
     tools?: NeutralTool[];
     context_policy?: unknown;
     max_tokens?: number | null;
@@ -669,5 +689,5 @@ type ToolResult = {
     error: string;
 };
 
-export { DEFAULT_MODEL, GardDestroyedError, JoinError, NornsApiError, NornsClient, NornsError, NornsTimeoutError, NornsWorker, NotFoundError, StreamClosedError, consoleLogger, defineAgent, inferProvider, silentLogger, tool };
+export { DEFAULT_MODEL, GardDestroyedError, JoinError, KeyRevokedError, NornsApiError, NornsClient, NornsError, NornsTimeoutError, NornsWorker, NotFoundError, StreamClosedError, consoleLogger, defineAgent, inferProvider, isScopedKey, silentLogger, tool };
 export type { AgentDefinition, AgentInfo, AgentMode, AgentOptions, AgentRef, Capability, CheckpointPolicy, ContextPolicy, ContextStrategy, Conversation, InferToolInput, ListRunsOptions, LlmResult, LlmTask, Logger, MessageResult, ModelResolver, ModelSource, ModelsOption, NeutralMessage, NeutralToolCall, NornsClientOptions, NornsWorkerOptions, OnFailure, RegisterPortOptions, RegisteredPort, Run, RunEvent, RunStatus, SendMessageOptions, StreamEvent, StreamOptions, SubagentConversation, SubagentPolicy, ToolContext, ToolDefinition, ToolInputSchema, ToolOptions, ToolResult, ToolTask, WaitingFor, WebSocketConstructor };

package/dist/index.d.ts

@@ -264,6 +264,12 @@ declare class NornsClient {
         delete: (agent: AgentRef, key: string) => Promise<void>;
     };
 }
+/**
+ * A key issued by `POST /api/v1/api_keys` with a worker scope (`nrnw_...`).
+ * It opens the worker socket and nothing else, so a worker holding one must
+ * not try the REST API.
+ */
+declare function isScopedKey(apiKey: string): boolean;
 
 /**
  * Where the SDK writes what it is doing. Anything with these four methods
@@ -301,7 +307,11 @@ interface NornsWorkerOptions {
     agents: AgentDefinition | AgentDefinition[];
     /** The Norns base URL. Defaults to `NORNS_URL`. */
     url?: string;
-    /** The tenant's bearer token. Defaults to `NORNS_API_KEY`. */
+    /**
+     * The bearer token. Defaults to `NORNS_API_KEY`. A scoped worker key
+     * (`nrnw_...`) joins without registering the agents, since it cannot reach
+     * the REST API; register the definitions with a tenant key.
+     */
     apiKey?: string;
     /**
      * How a model name on an LLM task becomes a model to call: a function, a
@@ -582,6 +592,10 @@ declare class JoinError extends NornsError {
 declare class GardDestroyedError extends NornsError {
     constructor(gard: string | number | undefined);
 }
+/** The scoped key this worker joined on was revoked while it was connected. */
+declare class KeyRevokedError extends NornsError {
+    constructor();
+}
 /** A stream's socket closed before the run reached a terminal event. */
 declare class StreamClosedError extends NornsError {
     readonly reason: unknown;
@@ -626,6 +640,12 @@ interface LlmTask {
     summary?: string | null;
     date?: string | null;
     messages?: NeutralMessage[];
+    /** In place of `messages` once this worker holds the run's history (see HistoryCache). */
+    messages_delta?: {
+        base_count: number;
+        drop: number;
+        append: NeutralMessage[];
+    };
     tools?: NeutralTool[];
     context_policy?: unknown;
     max_tokens?: number | null;
@@ -669,5 +689,5 @@ type ToolResult = {
     error: string;
 };
 
-export { DEFAULT_MODEL, GardDestroyedError, JoinError, NornsApiError, NornsClient, NornsError, NornsTimeoutError, NornsWorker, NotFoundError, StreamClosedError, consoleLogger, defineAgent, inferProvider, silentLogger, tool };
+export { DEFAULT_MODEL, GardDestroyedError, JoinError, KeyRevokedError, NornsApiError, NornsClient, NornsError, NornsTimeoutError, NornsWorker, NotFoundError, StreamClosedError, consoleLogger, defineAgent, inferProvider, isScopedKey, silentLogger, tool };
 export type { AgentDefinition, AgentInfo, AgentMode, AgentOptions, AgentRef, Capability, CheckpointPolicy, ContextPolicy, ContextStrategy, Conversation, InferToolInput, ListRunsOptions, LlmResult, LlmTask, Logger, MessageResult, ModelResolver, ModelSource, ModelsOption, NeutralMessage, NeutralToolCall, NornsClientOptions, NornsWorkerOptions, OnFailure, RegisterPortOptions, RegisteredPort, Run, RunEvent, RunStatus, SendMessageOptions, StreamEvent, StreamOptions, SubagentConversation, SubagentPolicy, ToolContext, ToolDefinition, ToolInputSchema, ToolOptions, ToolResult, ToolTask, WaitingFor, WebSocketConstructor };

package/dist/index.js

@@ -206,6 +206,12 @@ var GardDestroyedError = class extends NornsError {
     this.name = "GardDestroyedError";
   }
 };
+var KeyRevokedError = class extends NornsError {
+  constructor() {
+    super("the worker's scoped key was revoked");
+    this.name = "KeyRevokedError";
+  }
+};
 var StreamClosedError = class extends NornsError {
   reason;
   constructor(reason) {
@@ -534,6 +540,9 @@ function resolveApiKey(apiKey) {
   if (!value) throw new NornsError("Norns API key missing: pass `apiKey` or set NORNS_API_KEY");
   return value;
 }
+function isScopedKey(apiKey) {
+  return apiKey.startsWith("nrnw_");
+}
 function wsBase(url) {
   return url.replace(/^http:\/\//, "ws://").replace(/^https:\/\//, "wss://");
 }
@@ -1113,6 +1122,51 @@ function neutralUsage(usage) {
   return out;
 }
 
+// src/history-cache.ts
+var HistoryCache = class {
+  #runs = /* @__PURE__ */ new Map();
+  #maxRuns;
+  constructor(maxRuns = 256) {
+    this.#maxRuns = maxRuns;
+  }
+  /** The task with `messages` filled in, or `undefined` on a miss. */
+  resolve(task) {
+    if (task.purpose === "compact") return task;
+    const runId = task.run_id;
+    const delta = task.messages_delta;
+    if (delta === void 0) {
+      if (runId !== void 0 && Array.isArray(task.messages)) this.#remember(runId, task.messages);
+      return task;
+    }
+    const previous = runId === void 0 ? void 0 : this.#runs.get(runId);
+    if (runId === void 0 || previous === void 0 || previous.length !== delta.base_count) {
+      return void 0;
+    }
+    const messages = [...previous.slice(delta.drop), ...delta.append];
+    this.#remember(runId, messages);
+    const resolved = { ...task, messages };
+    delete resolved.messages_delta;
+    return resolved;
+  }
+  /** Forget everything: a new connection gets the full history anyway. */
+  clear() {
+    this.#runs.clear();
+  }
+  /** How many runs are held; for tests. */
+  get size() {
+    return this.#runs.size;
+  }
+  #remember(runId, messages) {
+    this.#runs.delete(runId);
+    this.#runs.set(runId, messages);
+    while (this.#runs.size > this.#maxRuns) {
+      const oldest = this.#runs.keys().next().value;
+      if (oldest === void 0) break;
+      this.#runs.delete(oldest);
+    }
+  }
+};
+
 // src/worker.ts
 var TOPIC = "worker:lobby";
 var NornsWorker = class {
@@ -1133,6 +1187,7 @@ var NornsWorker = class {
   #client;
   #resolveModel;
   #inFlight = /* @__PURE__ */ new Set();
+  #history = new HistoryCache();
   #state = "idle";
   #socket;
   #channel;
@@ -1201,9 +1256,15 @@ var NornsWorker = class {
     return this.#starting;
   }
   async #start() {
-    for (const agent of this.#agents) {
-      const info = await this.#client.agents.ensure(agent);
-      this.#logger.info(`Registered agent '${agent.name}' (id=${info.id})`);
+    if (isScopedKey(this.#apiKey)) {
+      this.#logger.info(
+        "Worker key is scoped (nrnw_): skipping agent registration. Register the agent definitions with a tenant key."
+      );
+    } else {
+      for (const agent of this.#agents) {
+        const info = await this.#client.agents.ensure(agent);
+        this.#logger.info(`Registered agent '${agent.name}' (id=${info.id})`);
+      }
     }
     if (this.#capabilities.includes("llm")) {
       for (const model of new Set(this.#agents.map((a) => a.model))) {
@@ -1225,7 +1286,10 @@ var NornsWorker = class {
       ...this.#socketOptions
     });
     this.#socket = socket;
-    socket.onOpen(() => this.#logger.info(`Connected to ${this.url}`));
+    socket.onOpen(() => {
+      this.#logger.info(`Connected to ${this.url}`);
+      this.#history.clear();
+    });
     socket.onError((err) => {
       if (this.#state === "starting" || this.#state === "running") {
         this.#logger.warn(`Connection error (${errorMessage(err)}); retrying`);
@@ -1251,6 +1315,10 @@ var NornsWorker = class {
       this.#logger.error("This worker's gard was destroyed; shutting down");
       this.#fail(new GardDestroyedError(this.gard));
     });
+    channel.on("key_revoked", () => {
+      this.#logger.error("This worker's key was revoked; shutting down");
+      this.#fail(new KeyRevokedError());
+    });
     channel.onError((reason) => {
       if (this.#state === "running")
         this.#logger.warn(`Channel error (${errorMessage(reason)}); rejoining`);
@@ -1284,7 +1352,10 @@ var NornsWorker = class {
     const params = {
       worker_id: this.workerId,
       tools: [...this.#tools.values()].map(toolRegistration),
-      capabilities: this.#capabilities
+      capabilities: this.#capabilities,
+      // This worker keeps the history it was last sent per run, so Norns may
+      // send later steps as the change only (HistoryCache).
+      features: ["message_cache"]
     };
     if (this.gard !== void 0) {
       params.gard = this.gard;
@@ -1413,7 +1484,14 @@ var NornsWorker = class {
       (resp) => this.#logger.warn(`Server rejected result for ${taskId}: ${errorMessage(resp)}`)
     );
   }
-  async #runLlm(task, signal) {
+  async #runLlm(received, signal) {
+    const task = this.#history.resolve(received);
+    if (task === void 0) {
+      this.#logger.info(
+        "LLM task arrived as a delta on an unknown base; asking for the full history"
+      );
+      return { status: "error", error: "message_cache_miss" };
+    }
     const model = task.model ?? "?";
     const tools = task.tools ?? [];
     this.#logger.info(
@@ -1553,6 +1631,7 @@ export {
   DEFAULT_MODEL,
   GardDestroyedError,
   JoinError,
+  KeyRevokedError,
   NornsApiError,
   NornsClient,
   NornsError,
@@ -1563,6 +1642,7 @@ export {
   consoleLogger,
   defineAgent,
   inferProvider,
+  isScopedKey,
   jsonSchema3 as jsonSchema,
   silentLogger,
   tool