@nemesis-oss/ollama-sdk 1.20.1 → 1.21.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [1.21.0] — `systemOne` takes a cancellation signal; the failover layer stops dropping caller signals (ADR 0037)
+
+The Decision Plane in nexum could not bound a System One call: its `AbortSignal` never reached the wire. Tracing that found a defect in the SDK, not in nexum. `FailoverHttpClient.request` replaced the caller's signal with the failover layer's own in every attempt, so a signal passed to any runtime operation that accepts one was silently ignored. [ADR 0037](./docs/adr/0037-systemone-signal-failover-cancellation.md) records the root cause and the declined alternatives.
+
+### Fixed — per-call signals are honoured
+
+- **`native.tags`, `native.ps`, `native.version`, `native.blobs`, and `runtime.invoke({ signal })`** now cancel in flight. They accepted the option and ignored it before this release. A caller that relied on the signal being ignored will now see an abort, and a caller that passes an already-aborted signal fails immediately without sending the request.
+
+### Added
+
+- **`client.systemOne(request, { signal })`.** The signal covers the whole call: the cloud-model version probe that runs first (ADR 0036), and the request on the wire. An abort rejects with `OllamaAbortError`. The probe is raced against the signal rather than cancelled, so one impatient caller cannot poison the cached probe for later calls.
+
+### Changed
+
+- `systemOne` calls `runtime.invoke` with the same operation and body that `NativeApi.systemOne` uses. Calls that pass no signal send the same request as before.
+
+### Docs
+
+- `docs-site/api/client.md` and `docs-site/guide/system-one.md` document the signal. ADR 0037 is added to both ADR indexes.
+
+### Notes — CHANGELOG tidy
+
+- Two `[Unreleased]` headings held entries that had already shipped. The 1.9.0-era entries (the IPv6 loopback fix, host normalization, and the digest work) now sit under 1.9.0, since their commits are in the `v1.9.0` tag. The MCP bridge and stdio entries now sit under "Releases 1.5.0 to 1.8.0", since their first commits are between `v1.5.0` and `v1.8.0`. There are still no release sections for 1.5.0, 1.5.1, or 1.6.0 in this file.
+
 ## [1.20.1] — Self-hosted servers are no longer refused as Ollama Cloud
 
 Structured output (`format`) was refused pre-flight for every base URL outside `localhost`, `*.local`, `192.168.*` and `10.*`. The classifier treated any other host as cloud, so a self-hosted server reached by a Docker or Kubernetes service name (`http://ollama:11434`), a `172.16/12` address, or a public domain of its own threw `OllamaUnsupportedCapabilityError` on every `format` request. There was no opt-out. Caught while wiring `@nemesis-oss/ollama-sdk` into agentic-tui, whose docker-compose stack points the supervisor at `http://ollama:11434`.
@@ -420,18 +444,18 @@ A second full audit against the current official Ollama docs (`docs/openapi.yaml
 - Five runnable examples: `examples/vision-inputs.ts`, `examples/responses-bridge.ts`, `examples/conversation-session.ts`, `examples/context-safety.ts`, `examples/blob-publishing.ts` (`npm run example <file>`) — plus `examples/usage-balance.ts` from the docs-recheck pass.
 - 50 new unit tests (mocked fetch — CI-safe, no daemon): `test/vision-resolver.test.ts`, `test/responses-bridge.test.ts`, `test/conversation-session.test.ts`, `test/context-safety.test.ts`, `test/blob-helpers.test.ts` — plus 10 more in `test/usage-balance.test.ts`.
 
-## [Unreleased]
+### Also shipped in 1.9.0 (filed under Unreleased)
 
-### Fix: IPv6 loopback was classified as Ollama Cloud
+#### Fix: IPv6 loopback was classified as Ollama Cloud
 
 - `inferRuntimeMode()` compared `URL.hostname` to `'::1'`, but WHATWG URL reports an IPv6 literal with its brackets (`'[::1]'`), so `http://[::1]:11434` was classified as `cloud`. Structured-output (`format`) requests to a local Ollama on IPv6 loopback were therefore refused pre-flight with `OllamaUnsupportedCapabilityError`, and `localMode` was off for capability detection. The brackets are now stripped before comparing. Public IPv6 addresses are still `cloud`.
 
-### Host normalization and scoped `OLLAMA_API_KEY`
+#### Host normalization and scoped `OLLAMA_API_KEY`
 
 - **Base URL normalization.** `baseUrl`, `OLLAMA_HOST`, per-credential `baseUrl` and `endpoints[].baseUrl` now accept the bare forms the Ollama CLI accepts: `127.0.0.1:11434`, `0.0.0.0`, `:11434`, `myhost`. A missing scheme defaults to `http://`, a missing port on a scheme-less host defaults to `11434`, scheme-less port `443` selects `https://`, and `:port` means `127.0.0.1`. Full URLs and reverse-proxy path prefixes are unchanged. Previously a scheme-less value produced an invalid request URL.
 - **Behavior change: `OLLAMA_API_KEY` is no longer forwarded to arbitrary hosts.** The env-sourced key is applied to the default endpoint only when its host is Ollama Cloud (`ollama.com`, `*.ollama.com`) or loopback. An explicit `apiKey` is always sent, to any host. If you relied on `OLLAMA_API_KEY` for a LAN or proxied server, pass `apiKey` explicitly. Web search/fetch (always `https://ollama.com`) still use the env key.
 
-### Production-readiness audit — tool-call accumulator, mock server
+#### Production-readiness audit — tool-call accumulator, mock server
 
 - **Offline wire-format conformance tests** (`test/conformance/native-api-offline.test.ts`). The sibling `native-api.test.ts` hits a REAL Ollama server and skips when none is available. The new offline tests use `OllamaMockServer` to emit contract-shaped NDJSON frames without any model inference, so they run in every CI environment — including those without an Ollama daemon. They validate ONLY the wire format (schema conformance, error-class mapping, optional-field handling), NOT model behavior. The split exists because wire-format drift is a contract concern (catchable offline), while model-behavior drift is a server/model concern (only catchable against a live server). 22 new tests covering:
   - `GET /api/version`, `/api/tags`, `/api/ps`, `POST /api/show` schema conformance
@@ -443,7 +467,7 @@ A second full audit against the current official Ollama docs (`docs/openapi.yaml
   - `OllamaClient` vs `NativeApi` shape parity (mirrors the live parity test)
 - Updated `test/conformance/harness.ts` docstring to document the live-vs-offline split.
 
-### Production-readiness audit — tool-call accumulator, mock server
+#### Production-readiness audit — tool-call accumulator, mock server
 
 - **Defensive tool-call streaming accumulator (`src/tools/tool-call-accumulator.ts`).** The original `aggregateChat` in `src/streaming/normalize.ts` blindly appended every chunk's `tool_calls` array, which would produce duplicate entries if Ollama ever started streaming them incrementally. The new `ToolCallAccumulator` matches entries by `id` (the SDK-synthesized stable identifier) or by array position, and merges them with spread-semantics on `function.arguments`. For the documented native Ollama behavior (tool_calls arrive complete in one chunk), the accumulator is a no-op — one chunk carries the full array, the next chunk has nothing, and the accumulator appends exactly once. The accumulator is also exported for callers who want the same merge logic on raw NDJSON chunks.
   - New exports: `ToolCallAccumulator` class, `mergeToolCallArrays()` stateless helper, `mergeToolCall()` / `mergeToolCallArgumentsString()` / `isSameToolCall()` standalone helpers.
@@ -460,7 +484,7 @@ A second full audit against the current official Ollama docs (`docs/openapi.yaml
   - Idempotent `stop()` — safe to call from `afterEach` hooks without tracking whether `start()` ran.
   - Ephemeral port support (`port: 0`) for parallel test runs.
 
-### Second digest — mid-stream errors, 502/503 specialization, pull-progress ergonomics
+#### Second digest — mid-stream errors, 502/503 specialization, pull-progress ergonomics
 
 - **In-band stream-error trapping (NDJSON).** Ollama's streaming endpoints start with HTTP 200 OK and chunked transfer encoding; if generation fails mid-flight (GPU OOM, driver crash, context window overflow, model unload race), the server emits a final `{"error": "..."}` JSON frame and closes the stream. The HTTP status code never changes from 200, so HTTP-status-based error detection misses these errors entirely — they would silently bleed into the assistant's content stream as garbage tokens or undefined-field accesses.
   - `parseNdjsonStream` now detects bare `{"error": "..."}` frames and throws `OllamaStreamError` immediately, with the error message preserved.
@@ -496,7 +520,7 @@ A second full audit against the current official Ollama docs (`docs/openapi.yaml
   - Otherwise → `'unknown'` (caller should treat as "ask the model and see what it does").
   - The family is extracted from `/api/show`'s `model_info.*.architecture` (with fallbacks to `details.family` then `details.families[0]`).
 
-### First digest — VRAM lifecycle, fetchWithBackoff, System One image caps, done_reason decoder
+#### First digest — VRAM lifecycle, fetchWithBackoff, System One image caps, done_reason decoder
 
 - **VRAM lifecycle primitives.** Added ergonomic helpers for explicit GPU memory management, addressing the upstream `keep_alive` semantics documented in the Ollama FAQ:
   - `KeepAlive` type union (`string | number | 'unload' | 'indefinite'`) and `normalizeKeepAlive()` helper map the SDK-level sugar literals `'unload'` and `'indefinite'` to the wire-level `0` and `-1` sentinels.
@@ -554,7 +578,7 @@ A second full audit against the current official Ollama docs (`docs/openapi.yaml
 
 - MCP tool arguments are now validated against advertised JSON Schema constraints before dispatch, while `resultMode: 'structured'` preserves raw MCP `CallToolResult` objects for programmatic consumers.
 
-## [Unreleased]
+## Releases 1.5.0 to 1.8.0 (filed under Unreleased)
 
 - **MCP bridge hardening.** MCP tool discovery now supports bounded pagination, repeated-cursor protection, request cancellation, richer MCP metadata types, and structured/non-text result preservation.
 - **Optional Node MCP stdio adapter.** `@nemesis-oss/ollama-sdk/mcp/stdio` connects to local MCP servers using the official `@modelcontextprotocol/client` v2 transport without importing Node-only code into the root package.

package/dist/index.cjs

@@ -2626,6 +2626,24 @@ function createTimeoutSignal(timeoutMs, userSignal) {
   };
   return { signal: controller.signal, cancel };
 }
+function untilAborted(promise, signal, message) {
+  if (signal === void 0) return promise;
+  return new Promise((resolve, reject) => {
+    const onAbort = () => reject(new OllamaAbortError(message));
+    promise.then(
+      (value) => {
+        signal.removeEventListener("abort", onAbort);
+        resolve(value);
+      },
+      (error) => {
+        signal.removeEventListener("abort", onAbort);
+        reject(error);
+      }
+    );
+    if (signal.aborted) onAbort();
+    else signal.addEventListener("abort", onAbort, { once: true });
+  });
+}
 
 // src/keep-alive.ts
 var KEEP_ALIVE_UNLOAD = 0;
@@ -5653,15 +5671,13 @@ var FailoverHttpClient = class {
   async request(options) {
     const { model, ...httpOptions } = options;
     return this.client.executeWithFailover(
-      async (http, signal) => {
-        const mergedOptions = {
-          ...httpOptions,
-          ...httpOptions.signal !== void 0 ? { signal } : { signal }
-        };
-        return http.request(mergedOptions);
-      },
+      // The signal handed to the operation already combines the caller's signal
+      // (passed below) with the failover scope and timeout. Using it, rather than
+      // the caller's, keeps the request cancellable by `destroy()` as well.
+      async (http, signal) => http.request({ ...httpOptions, signal }),
       {
         singleEndpoint: false,
+        ...httpOptions.signal !== void 0 ? { signal: httpOptions.signal } : {},
         ...model !== void 0 ? { model } : {}
       }
     );
@@ -6501,12 +6517,18 @@ var OllamaClient = class _OllamaClient {
    *
    * For the low-level generated API (without the generic wrapper), use
    * `client.native.systemOne(request)` directly.
+   *
+   * @param options.signal Cancels the whole call, including the cloud-model
+   *   version probe that runs first, so the gate never extends a caller's
+   *   deadline. An abort rejects with an {@link OllamaAbortError}.
    */
-  async systemOne(request) {
-    await this.assertCloudModelSupported(request.model);
-    return this.native.systemOne(
-      request
-    );
+  async systemOne(request, options = {}) {
+    await this.assertCloudModelSupported(request.model, options.signal);
+    return this.runtime.invoke({
+      operation: systemOneOp,
+      body: request,
+      ...options.signal !== void 0 ? { signal: options.signal } : {}
+    });
   }
   /**
    * Cloud-model version gate for {@link systemOne} — throws
@@ -6518,19 +6540,25 @@ var OllamaClient = class _OllamaClient {
    * so a later gated call retries), so at most one extra round-trip happens
    * across all gated calls.
    */
-  async assertCloudModelSupported(model) {
+  async assertCloudModelSupported(model, signal) {
     if (!isCloudModel(model)) return;
     const candidates = this.registry.candidates();
     const baseUrl = candidates[0]?.baseUrl ?? DEFAULT_BASE_URL;
     if (inferRuntimeMode(baseUrl) !== "local") return;
+    if (this.serverVersionCache === void 0) {
+      this.serverVersionCache = this.native.version().then((v) => v.version);
+    }
+    const probe = this.serverVersionCache;
     let version;
     try {
-      if (this.serverVersionCache === void 0) {
-        this.serverVersionCache = this.native.version().then((v) => v.version);
-      }
-      version = await this.serverVersionCache;
-    } catch {
-      this.serverVersionCache = void 0;
+      version = await untilAborted(
+        probe,
+        signal,
+        "System One call aborted while probing the Ollama server version"
+      );
+    } catch (error) {
+      if (signal?.aborted) throw error;
+      if (this.serverVersionCache === probe) this.serverVersionCache = void 0;
       return;
     }
     if (version && compareOllamaVersions(version, CLOUD_MODEL_MIN_OLLAMA_VERSION) < 0) {