@tinycloud/sdk-services 3.1.0-beta.6 → 3.1.0-beta.7

package/dist/kv/index.d.cts

@@ -1,4 +1,4 @@
-import { B as BaseService } from '../BaseService-BhpVpA9b.cjs';
+import { B as BaseService } from '../BaseService-C8zRy0ww.cjs';
 import { R as Result, I as IService } from '../types-qwMmB7qB.cjs';
 
 /**
@@ -23,8 +23,11 @@ interface KVServiceConfig {
      */
     prefix?: string;
     /**
-     * Default timeout in milliseconds for KV operations.
-     * Overrides the context-level timeout if set.
+     * Default timeout in milliseconds for each KV request, including reading
+     * the response body. When it elapses the request is aborted and the
+     * operation returns an `ErrorCodes.TIMEOUT` error. A per-call `timeout`
+     * option overrides it. Unset (the default), `0`, or `Infinity` means no
+     * timeout.
      */
     timeout?: number;
     /** Allow additional config properties */
@@ -55,7 +58,8 @@ interface KVGetOptions {
      */
     maxResponseBytes?: number;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -85,7 +89,8 @@ interface KVPutOptions {
     /** Only write when the key does not exist. */
     ifNoneMatch?: "*";
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -123,7 +128,8 @@ interface KVBatchPutOptions {
      */
     prefix?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -182,7 +188,8 @@ interface KVListOptions {
     /** Opaque scope-bound cursor returned by a previous bounded list. */
     cursor?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -201,7 +208,8 @@ interface KVDeleteOptions {
     /** Only delete when the current object has this strong ETag. */
     ifMatch?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -218,7 +226,8 @@ interface KVHeadOptions {
      */
     prefix?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -259,7 +268,8 @@ interface KVCreateSignedReadUrlOptions {
      */
     etag?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -882,7 +892,7 @@ declare class KVService extends BaseService implements IKVService {
      * @param path - Resource path
      * @param action - KV action
      * @param body - Optional request body
-     * @param signal - Optional abort signal
+     * @param signal - Request signal from createRequestSignal()
      * @returns Fetch response
      */
     private invokeOperation;

package/dist/kv/index.d.ts

@@ -1,4 +1,4 @@
-import { B as BaseService } from '../BaseService-CuV-ZVPs.js';
+import { B as BaseService } from '../BaseService-DU-lE-Qx.js';
 import { R as Result, I as IService } from '../types-qwMmB7qB.js';
 
 /**
@@ -23,8 +23,11 @@ interface KVServiceConfig {
      */
     prefix?: string;
     /**
-     * Default timeout in milliseconds for KV operations.
-     * Overrides the context-level timeout if set.
+     * Default timeout in milliseconds for each KV request, including reading
+     * the response body. When it elapses the request is aborted and the
+     * operation returns an `ErrorCodes.TIMEOUT` error. A per-call `timeout`
+     * option overrides it. Unset (the default), `0`, or `Infinity` means no
+     * timeout.
      */
     timeout?: number;
     /** Allow additional config properties */
@@ -55,7 +58,8 @@ interface KVGetOptions {
      */
     maxResponseBytes?: number;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -85,7 +89,8 @@ interface KVPutOptions {
     /** Only write when the key does not exist. */
     ifNoneMatch?: "*";
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -123,7 +128,8 @@ interface KVBatchPutOptions {
      */
     prefix?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -182,7 +188,8 @@ interface KVListOptions {
     /** Opaque scope-bound cursor returned by a previous bounded list. */
     cursor?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -201,7 +208,8 @@ interface KVDeleteOptions {
     /** Only delete when the current object has this strong ETag. */
     ifMatch?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -218,7 +226,8 @@ interface KVHeadOptions {
      */
     prefix?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -259,7 +268,8 @@ interface KVCreateSignedReadUrlOptions {
      */
     etag?: string;
     /**
-     * Custom timeout for this operation in milliseconds.
+     * Custom timeout for this operation in milliseconds. Overrides
+     * `KVServiceConfig.timeout`; `0` disables a configured timeout.
      */
     timeout?: number;
     /**
@@ -882,7 +892,7 @@ declare class KVService extends BaseService implements IKVService {
      * @param path - Resource path
      * @param action - KV action
      * @param body - Optional request body
-     * @param signal - Optional abort signal
+     * @param signal - Request signal from createRequestSignal()
      * @returns Fetch response
      */
     private invokeOperation;

package/dist/kv/index.js

@@ -163,11 +163,31 @@ function authRequiredError(service) {
     service
   };
 }
-function timeoutError(service) {
+var RequestTimeoutError = class extends Error {
+  constructor(timeoutMs) {
+    super(`Request timed out after ${timeoutMs}ms.`);
+    this.name = "TimeoutError";
+    this.timeoutMs = timeoutMs;
+  }
+};
+function isRequestTimeoutError(error) {
+  return error instanceof RequestTimeoutError || error instanceof Error && error.name === "TimeoutError" && typeof error.timeoutMs === "number";
+}
+function timeoutError(service, timeoutMs, cause) {
+  if (timeoutMs === void 0) {
+    return {
+      code: ErrorCodes.TIMEOUT,
+      message: "Request timed out.",
+      service,
+      ...cause === void 0 ? {} : { cause }
+    };
+  }
   return {
     code: ErrorCodes.TIMEOUT,
-    message: "Request timed out.",
-    service
+    message: `Request timed out after ${timeoutMs}ms.`,
+    service,
+    ...cause === void 0 ? {} : { cause },
+    meta: { timeoutMs }
   };
 }
 function abortedError(service) {
@@ -314,6 +334,9 @@ function storageRejectionError(service, status, meta, responseText) {
 }
 function wrapError(service, error, defaultCode = ErrorCodes.NETWORK_ERROR) {
   if (error instanceof Error) {
+    if (isRequestTimeoutError(error)) {
+      return timeoutError(service, error.timeoutMs, error);
+    }
     if (error.name === "AbortError") {
       return abortedError(service);
     }
@@ -335,6 +358,7 @@ function wrapError(service, error, defaultCode = ErrorCodes.NETWORK_ERROR) {
 }
 
 // src/base/BaseService.ts
+var MAX_TIMER_DELAY_MS = 2147483647;
 var BaseService = class {
   constructor() {
     /**
@@ -515,6 +539,64 @@ var BaseService = class {
     }
     return controller.signal;
   }
+  /**
+   * Create the abort signal for one request, bounded by the request timeout.
+   *
+   * The signal aborts when the service signs out, the context aborts, the
+   * caller's `signal` aborts, or the timeout elapses, whichever comes first.
+   * A timeout aborts with a {@link RequestTimeoutError} (`TimeoutError`), which
+   * `wrapError` maps to `ErrorCodes.TIMEOUT`; the other sources keep their own
+   * reason (normally `AbortError`, mapped to `ErrorCodes.ABORTED`).
+   *
+   * The timeout is `timeoutMs` when given, otherwise `config.timeout`. Only a
+   * positive, finite value (at most 2^31-1 ms) applies; `undefined`, `0`, and
+   * `Infinity` mean no timeout, so a per-call `0` opts out of a configured one.
+   *
+   * Callers must call `dispose()` once the response body has been consumed,
+   * which clears the timer and removes the listeners this adds to the
+   * long-lived service and context signals.
+   *
+   * @param signal - The caller's abort signal for this request
+   * @param timeoutMs - Per-request timeout override in milliseconds
+   */
+  createRequestSignal(signal, timeoutMs) {
+    const controller = new AbortController();
+    const detachers = [];
+    let timer;
+    const dispose = () => {
+      if (timer !== void 0) {
+        clearTimeout(timer);
+        timer = void 0;
+      }
+      for (const detach of detachers.splice(0)) {
+        detach();
+      }
+    };
+    const abort = (reason) => {
+      dispose();
+      controller.abort(reason);
+    };
+    const requestSignal = { signal: controller.signal, dispose };
+    const parents = [
+      this.abortController.signal,
+      this.context?.abortSignal,
+      signal
+    ].filter((parent) => parent !== void 0);
+    for (const parent of parents) {
+      if (parent.aborted) {
+        abort(parent.reason);
+        return requestSignal;
+      }
+      const onAbort = () => abort(parent.reason);
+      parent.addEventListener("abort", onAbort, { once: true });
+      detachers.push(() => parent.removeEventListener("abort", onAbort));
+    }
+    const timeout = timeoutMs ?? this._config.timeout;
+    if (typeof timeout === "number" && timeout > 0 && timeout <= MAX_TIMER_DELAY_MS) {
+      timer = setTimeout(() => abort(new RequestTimeoutError(timeout)), timeout);
+    }
+    return requestSignal;
+  }
   /**
    * Wrap an operation with error handling and telemetry.
    *
@@ -775,7 +857,7 @@ var KVService = class extends BaseService {
    * @param path - Resource path
    * @param action - KV action
    * @param body - Optional request body
-   * @param signal - Optional abort signal
+   * @param signal - Request signal from createRequestSignal()
    * @returns Fetch response
    */
   async invokeOperation(path, action, body, signal, extraHeaders) {
@@ -791,7 +873,7 @@ var KVService = class extends BaseService {
       method: "POST",
       headers: requestHeaders,
       body,
-      signal: this.combineSignals(signal)
+      signal
     });
   }
   /**
@@ -968,6 +1050,7 @@ var KVService = class extends BaseService {
         "kv"
       ));
     }
+    const request = this.createRequestSignal(options?.signal, options?.timeout);
     try {
       const session = this.context.session;
       const invocationHeaders = this.context.invokeAny(
@@ -989,7 +1072,7 @@ var KVService = class extends BaseService {
       const response = await this.context.fetch(`${this.host}/invoke`, {
         method: "POST",
         headers,
-        signal: this.combineSignals(options?.signal)
+        signal: request.signal
       });
       if (!response.ok) {
         const errorText = response.status === 401 || response.status === 403 ? await this.readAuthorizationText(response) : await response.text();
@@ -1054,6 +1137,8 @@ var KVService = class extends BaseService {
       return ok({ results, count: results.length });
     } catch (error) {
       return err(wrapError("kv", error));
+    } finally {
+      request.dispose();
     }
   }
   /**
@@ -1186,12 +1271,13 @@ var KVService = class extends BaseService {
         ));
       }
       const path = this.getFullPath(key, options?.prefix);
+      const request = this.createRequestSignal(options?.signal, options?.timeout);
       try {
         const response = await this.invokeOperation(
           path,
           KVAction.GET,
           void 0,
-          options?.signal,
+          request.signal,
           options?.maxResponseBytes === void 0 ? void 0 : { "x-tinycloud-max-response-bytes": String(options.maxResponseBytes) }
         );
         if (!response.ok) {
@@ -1248,6 +1334,8 @@ var KVService = class extends BaseService {
         });
       } catch (error) {
         return err(wrapError("kv", error));
+      } finally {
+        request.dispose();
       }
     });
   }
@@ -1275,12 +1363,13 @@ var KVService = class extends BaseService {
       }
       const path = this.getFullPath(key, options?.prefix);
       const body = this.serializePutValue(value, options?.contentType);
+      const request = this.createRequestSignal(options?.signal, options?.timeout);
       try {
         const response = await this.invokeOperation(
           path,
           KVAction.PUT,
           body,
-          options?.signal,
+          request.signal,
           {
             ...options?.ifMatch === void 0 ? {} : { "if-match": options.ifMatch },
             ...options?.ifNoneMatch === void 0 ? {} : { "if-none-match": options.ifNoneMatch }
@@ -1336,6 +1425,8 @@ var KVService = class extends BaseService {
         });
       } catch (error) {
         return err(wrapError("kv", error));
+      } finally {
+        request.dispose();
       }
     });
   }
@@ -1375,6 +1466,7 @@ var KVService = class extends BaseService {
         seen.add(path);
       }
       let requestMayHaveDispatched = false;
+      const request = this.createRequestSignal(options?.signal, options?.timeout);
       try {
         const body = new FormData();
         for (let index = 0; index < items.length; index++) {
@@ -1397,7 +1489,7 @@ var KVService = class extends BaseService {
           method: "POST",
           headers,
           body,
-          signal: this.combineSignals(options?.signal)
+          signal: request.signal
         };
         const fetchFn = this.context.fetch;
         requestMayHaveDispatched = true;
@@ -1448,14 +1540,16 @@ var KVService = class extends BaseService {
           rawBody = await response.json();
         } catch (jsonError) {
           const cause = jsonError instanceof Error ? jsonError : new Error(String(jsonError));
+          const timedOut = isRequestTimeoutError(cause);
           return err(
             serviceError(
-              ErrorCodes.NETWORK_ERROR,
-              `KV batchPut response was not valid JSON: ${cause.message}`,
+              timedOut ? ErrorCodes.TIMEOUT : ErrorCodes.NETWORK_ERROR,
+              timedOut ? `KV batchPut response body did not arrive in time: ${cause.message}` : `KV batchPut response was not valid JSON: ${cause.message}`,
               "kv",
               {
                 cause,
                 meta: {
+                  ...timedOut ? { timeoutMs: cause.timeoutMs } : {},
                   requestMayHaveDispatched: true,
                   responseReceived: true,
                   status: response.status,
@@ -1510,6 +1604,8 @@ var KVService = class extends BaseService {
           ...wrapped,
           meta: { ...wrapped.meta, requestMayHaveDispatched }
         });
+      } finally {
+        request.dispose();
       }
     });
   }
@@ -1532,12 +1628,13 @@ var KVService = class extends BaseService {
       if (options?.path) {
         listPath = listPath ? `${listPath}/${options.path}` : options.path;
       }
+      const request = this.createRequestSignal(options?.signal, options?.timeout);
       try {
         const response = await this.invokeOperation(
           listPath,
           KVAction.LIST,
           void 0,
-          options?.signal,
+          request.signal,
           options?.limit === void 0 && options?.cursor === void 0 ? void 0 : {
             ...options?.limit === void 0 ? {} : { "x-tinycloud-limit": String(options.limit) },
             ...options?.cursor === void 0 ? {} : { "x-tinycloud-cursor": options.cursor }
@@ -1578,6 +1675,8 @@ var KVService = class extends BaseService {
         });
       } catch (error) {
         return err(wrapError("kv", error));
+      } finally {
+        request.dispose();
       }
     });
   }
@@ -1590,12 +1689,13 @@ var KVService = class extends BaseService {
         return err(authRequiredError("kv"));
       }
       const path = this.getFullPath(key, options?.prefix);
+      const request = this.createRequestSignal(options?.signal, options?.timeout);
       try {
         const response = await this.invokeOperation(
           path,
           KVAction.DELETE,
           void 0,
-          options?.signal,
+          request.signal,
           options?.ifMatch === void 0 ? void 0 : { "if-match": options.ifMatch }
         );
         if (!response.ok) {
@@ -1643,6 +1743,8 @@ var KVService = class extends BaseService {
         });
       } catch (error) {
         return err(wrapError("kv", error));
+      } finally {
+        request.dispose();
       }
     });
   }
@@ -1655,12 +1757,13 @@ var KVService = class extends BaseService {
         return err(authRequiredError("kv"));
       }
       const path = this.getFullPath(key, options?.prefix);
+      const request = this.createRequestSignal(options?.signal, options?.timeout);
       try {
         const response = await this.invokeOperation(
           path,
           KVAction.HEAD,
           void 0,
-          options?.signal
+          request.signal
         );
         if (!response.ok) {
           if (response.status === 401 || response.status === 403) {
@@ -1691,6 +1794,8 @@ var KVService = class extends BaseService {
         });
       } catch (error) {
         return err(wrapError("kv", error));
+      } finally {
+        request.dispose();
       }
     });
   }
@@ -1728,12 +1833,13 @@ var KVService = class extends BaseService {
       if (options?.etag !== void 0) {
         body.etag = options.etag;
       }
+      const request = this.createRequestSignal(options?.signal, options?.timeout);
       try {
         const response = await this.context.fetch(`${this.host}/signed/kv`, {
           method: "POST",
           headers: this.withJsonContentType(headers),
           body: JSON.stringify(body),
-          signal: this.combineSignals(options?.signal)
+          signal: request.signal
         });
         if (!response.ok) {
           return this.createSignedReadUrlError(response, key, path);
@@ -1753,6 +1859,8 @@ var KVService = class extends BaseService {
         return ok(signedUrl);
       } catch (error) {
         return err(wrapError("kv", error));
+      } finally {
+        request.dispose();
       }
     });
   }