@agent-api/sdk 1.2.1 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog — @agent-api/sdk
 
+## 1.2.2
+
+### Added
+
+- Added `RequestOptions.signal` so CLI, TUI, and desktop integrations can abort in-flight HTTP requests and response streams before a response ID is available.
+- Documented and tested response cancellation behavior alongside the existing `responses.cancel(responseID)` backend cancellation API.
+
 ## 1.2.1
 
 ### Added

package/README.md

@@ -2,7 +2,7 @@
 
 Production JavaScript/TypeScript SDK for the Managed Agent API.
 
-**Published on npm:** [`@agent-api/sdk`](https://www.npmjs.com/package/@agent-api/sdk) (v1.2.1)
+**Published on npm:** [`@agent-api/sdk`](https://www.npmjs.com/package/@agent-api/sdk) (v1.2.2)
 
 ## Install
 
@@ -257,6 +257,7 @@ const context = await createLocalContextPackage(project, {
 
 - **Retries:** automatic exponential backoff for network failures, 429, and 5xx (default 2 retries).
 - **Timeouts:** 10 minute default for requests; 1 hour for streaming agent runs (configurable via `timeout` / `streamTimeout`).
+- **Cancellation:** pass `signal` in request options to abort local HTTP waiting, and call `client.responses.cancel(responseID)` for backend best-effort cancellation after a response ID exists.
 - **Typed errors:** `AuthenticationError`, `RateLimitError`, `NotFoundError`, `BadRequestError`, etc.
 - **Pagination:** `listPage` returns a cursor page; `listIterator` auto-fetches all pages.
 
@@ -273,7 +274,7 @@ const stream = await client.responses.create({
   preset: "fast-search",
   input: "Summarize today's AI news.",
   stream: true,
-});
+}, { signal: abortController.signal });
 
 for await (const event of stream) {
   if (event.type === "response.output_text.delta") {

package/dist/internal/http.js

@@ -33,6 +33,9 @@ export class HTTPClient {
                 return await this.fetchOnce(method, path, body, options, stream, rawBody);
             }
             catch (error) {
+                if (options.signal?.aborted) {
+                    throw error;
+                }
                 if (!(error instanceof APIError) || attempt >= maxRetries) {
                     throw error;
                 }
@@ -43,14 +46,29 @@ export class HTTPClient {
                 }
                 attempt += 1;
                 const delayMs = retryDelayMs(error, attempt);
-                await sleep(delayMs);
+                await sleep(delayMs, options.signal);
             }
         }
     }
     async fetchOnce(method, path, body, options, stream, rawBody) {
         const controller = new AbortController();
         const timeout = options.timeout ?? (stream ? this.options.streamTimeout : this.options.timeout);
-        const timeoutID = setTimeout(() => controller.abort(), timeout);
+        let timedOut = false;
+        let callerAborted = options.signal?.aborted ?? false;
+        const timeoutID = setTimeout(() => {
+            timedOut = true;
+            controller.abort();
+        }, timeout);
+        const abortFromCaller = () => {
+            callerAborted = true;
+            controller.abort();
+        };
+        if (options.signal?.aborted) {
+            controller.abort();
+        }
+        else {
+            options.signal?.addEventListener("abort", abortFromCaller, { once: true });
+        }
         try {
             const headers = {
                 Accept: stream ? "text/event-stream" : "application/json",
@@ -80,12 +98,19 @@ export class HTTPClient {
                 throw error;
             }
             if (error instanceof Error && error.name === "AbortError") {
-                throw new APIConnectionError(`Request timed out after ${timeout}ms`, error);
+                if (callerAborted || options.signal?.aborted) {
+                    throw new APIConnectionError("Request aborted", error);
+                }
+                if (timedOut) {
+                    throw new APIConnectionError(`Request timed out after ${timeout}ms`, error);
+                }
+                throw new APIConnectionError("Request aborted", error);
             }
             throw new APIConnectionError("Request failed", error);
         }
         finally {
             clearTimeout(timeoutID);
+            options.signal?.removeEventListener("abort", abortFromCaller);
         }
     }
 }
@@ -99,6 +124,23 @@ function retryDelayMs(error, attempt) {
     const jitter = Math.floor(Math.random() * 100);
     return exponential + jitter;
 }
-function sleep(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
+function sleep(ms, signal) {
+    if (!signal) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+    if (signal.aborted) {
+        return Promise.reject(new APIConnectionError("Request aborted"));
+    }
+    return new Promise((resolve, reject) => {
+        const timeout = setTimeout(() => {
+            signal.removeEventListener("abort", abort);
+            resolve();
+        }, ms);
+        const abort = () => {
+            clearTimeout(timeout);
+            signal.removeEventListener("abort", abort);
+            reject(new APIConnectionError("Request aborted"));
+        };
+        signal.addEventListener("abort", abort, { once: true });
+    });
 }

package/dist/types/common.d.ts

@@ -20,6 +20,8 @@ export interface ClientOptions {
 export interface RequestOptions {
     headers?: Record<string, string>;
     timeout?: number;
+    /** Abort the underlying HTTP request or stream from caller-controlled UI/runtime state. */
+    signal?: AbortSignal;
     /** Override automatic retries for this request. */
     maxRetries?: number;
 }

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.2.1";
-export declare const USER_AGENT = "@agent-api/sdk/1.2.1";
+export declare const VERSION = "1.2.2";
+export declare const USER_AGENT = "@agent-api/sdk/1.2.2";

package/dist/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "1.2.1";
+export const VERSION = "1.2.2";
 export const USER_AGENT = `@agent-api/sdk/${VERSION}`;

package/dist-cjs/internal/http.js

@@ -36,6 +36,9 @@ class HTTPClient {
                 return await this.fetchOnce(method, path, body, options, stream, rawBody);
             }
             catch (error) {
+                if (options.signal?.aborted) {
+                    throw error;
+                }
                 if (!(error instanceof errors_js_1.APIError) || attempt >= maxRetries) {
                     throw error;
                 }
@@ -46,14 +49,29 @@ class HTTPClient {
                 }
                 attempt += 1;
                 const delayMs = retryDelayMs(error, attempt);
-                await sleep(delayMs);
+                await sleep(delayMs, options.signal);
             }
         }
     }
     async fetchOnce(method, path, body, options, stream, rawBody) {
         const controller = new AbortController();
         const timeout = options.timeout ?? (stream ? this.options.streamTimeout : this.options.timeout);
-        const timeoutID = setTimeout(() => controller.abort(), timeout);
+        let timedOut = false;
+        let callerAborted = options.signal?.aborted ?? false;
+        const timeoutID = setTimeout(() => {
+            timedOut = true;
+            controller.abort();
+        }, timeout);
+        const abortFromCaller = () => {
+            callerAborted = true;
+            controller.abort();
+        };
+        if (options.signal?.aborted) {
+            controller.abort();
+        }
+        else {
+            options.signal?.addEventListener("abort", abortFromCaller, { once: true });
+        }
         try {
             const headers = {
                 Accept: stream ? "text/event-stream" : "application/json",
@@ -83,12 +101,19 @@ class HTTPClient {
                 throw error;
             }
             if (error instanceof Error && error.name === "AbortError") {
-                throw new errors_js_1.APIConnectionError(`Request timed out after ${timeout}ms`, error);
+                if (callerAborted || options.signal?.aborted) {
+                    throw new errors_js_1.APIConnectionError("Request aborted", error);
+                }
+                if (timedOut) {
+                    throw new errors_js_1.APIConnectionError(`Request timed out after ${timeout}ms`, error);
+                }
+                throw new errors_js_1.APIConnectionError("Request aborted", error);
             }
             throw new errors_js_1.APIConnectionError("Request failed", error);
         }
         finally {
             clearTimeout(timeoutID);
+            options.signal?.removeEventListener("abort", abortFromCaller);
         }
     }
 }
@@ -103,6 +128,23 @@ function retryDelayMs(error, attempt) {
     const jitter = Math.floor(Math.random() * 100);
     return exponential + jitter;
 }
-function sleep(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
+function sleep(ms, signal) {
+    if (!signal) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+    if (signal.aborted) {
+        return Promise.reject(new errors_js_1.APIConnectionError("Request aborted"));
+    }
+    return new Promise((resolve, reject) => {
+        const timeout = setTimeout(() => {
+            signal.removeEventListener("abort", abort);
+            resolve();
+        }, ms);
+        const abort = () => {
+            clearTimeout(timeout);
+            signal.removeEventListener("abort", abort);
+            reject(new errors_js_1.APIConnectionError("Request aborted"));
+        };
+        signal.addEventListener("abort", abort, { once: true });
+    });
 }

package/dist-cjs/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.USER_AGENT = exports.VERSION = void 0;
-exports.VERSION = "1.2.1";
+exports.VERSION = "1.2.2";
 exports.USER_AGENT = `@agent-api/sdk/${exports.VERSION}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agent-api/sdk",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Production JavaScript SDK for the Managed Agent API",
   "license": "MIT",
   "repository": {