@stll/fetch 0.1.0 → 0.1.1

package/README.md

@@ -22,10 +22,11 @@ const stream = await fetchWithTimeout(url, {
 
 The timeout is required by the type. `headers` bounds the wait for the
 response; `idle` also restarts on every body chunk and errors the body stream
-when it stalls. A timeout rejects (or errors the body) with a `TimeoutError`
-`DOMException`, and the caller's `signal` and a `Request`'s own signal still
-abort the request. `timeoutMs: number` is a total deadline over the request
-and its body.
+when it stalls; `total` bounds the request and its body consumption through
+the transport's own signal and returns the transport's response unchanged. A
+timeout rejects (or errors the body) with a `TimeoutError` `DOMException`, and
+the caller's `signal` and a `Request`'s own signal still abort the request.
+`timeoutMs: number` remains the legacy numeric form of the total policy.
 
 `createFetchWithTimeout(fetcher)` returns the same function over another
 `fetch` implementation (a proxy-aware client, or a fake in tests).

package/dist/{index-DNw-Gzhr.d.ts → index-nwAjbSQV.d.ts}

@@ -3,6 +3,9 @@ declare const isConnectionFailure: (cause: unknown) => boolean;
 //#endregion
 //#region src/index.d.ts
 type FetchTimeout = {
+  type: "total";
+  ms: number;
+} | {
   type: "headers";
   ms: number;
 } | {
@@ -18,9 +21,9 @@ type FetchWithTimeoutInit = Omit<RequestInit, "signal"> & {
   signal?: AbortSignal | undefined;
 } & ({
   timeout: FetchTimeout;
-  timeoutMs?: never;
+  timeoutMs?: number;
 } | {
-  /** Choose a headers or idle timeout for new callers. */
+  /** Use an explicit timeout policy for new callers. */
   timeoutMs: number;
   timeout?: never;
 });

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-import { a as createFetchWithTimeout, i as TransportRequestInit, n as FetchWithTimeoutInit, o as fetchWithTimeout, r as Fetcher, s as isConnectionFailure, t as FetchTimeout } from "./index-DNw-Gzhr.js";
+import { a as createFetchWithTimeout, i as TransportRequestInit, n as FetchWithTimeoutInit, o as fetchWithTimeout, r as Fetcher, s as isConnectionFailure, t as FetchTimeout } from "./index-nwAjbSQV.js";
 export { FetchTimeout, FetchWithTimeoutInit, Fetcher, TransportRequestInit, createFetchWithTimeout, fetchWithTimeout, isConnectionFailure };

package/dist/index.js

@@ -53,14 +53,15 @@ const isConnectionFailure = (cause) => {
 const executeFetchWithTimeout = async (fetcher, input, { timeout, timeoutMs, signal, ...init }) => {
 	const callerSignals = [signal, input instanceof Request ? input.signal : void 0].filter((candidate) => candidate !== void 0);
 	const activeFetcher = fetcher ?? globalThis.fetch;
-	if (timeout === void 0) {
-		const total = AbortSignal.timeout(timeoutMs);
-		return await activeFetcher(input, {
-			...init,
-			signal: AbortSignal.any([...callerSignals, total])
-		});
-	}
-	if (!Number.isFinite(timeout.ms) || timeout.ms < 0 || timeout.ms > 2147483647) throw new DOMException("Invalid fetch timeout duration", "NotSupportedError");
+	const duration = timeout?.ms ?? timeoutMs;
+	if (typeof duration !== "number" || !Number.isFinite(duration) || duration < 0 || duration > 2147483647) throw new DOMException("Invalid fetch timeout duration", "NotSupportedError");
+	if (timeout === void 0 || timeout.type === "total") return await activeFetcher(input, {
+		...init,
+		signal: AbortSignal.any([...callerSignals, AbortSignal.timeout(duration)]),
+		...timeout === void 0 ? {} : { timeout },
+		timeoutMs: duration
+	});
+	const policy = timeout;
 	const controller = new AbortController();
 	const combined = AbortSignal.any([...callerSignals, controller.signal]);
 	const expire = () => controller.abort(new DOMException("Fetch timed out", "TimeoutError"));
@@ -71,18 +72,20 @@ const executeFetchWithTimeout = async (fetcher, input, { timeout, timeoutMs, sig
 	};
 	const reset = () => {
 		clear();
-		timer = setTimeout(expire, timeout.ms);
+		timer = setTimeout(expire, duration);
 	};
 	reset();
 	const response = await Promise.resolve().then(async () => await activeFetcher(input, {
 		...init,
-		signal: combined
+		signal: combined,
+		timeout: policy,
+		timeoutMs: duration
 	})).finally(clear);
 	if (combined.aborted) {
 		await Promise.allSettled([response.body?.cancel(combined.reason)]);
 		throw combined.reason;
 	}
-	if (timeout.type === "headers" || response.body === null) return response;
+	if (policy.type === "headers" || response.body === null) return response;
 	const reader = response.body.getReader();
 	let stopped = false;
 	let cancellation;

package/dist/publisher.d.ts

@@ -1,5 +1,5 @@
-import { i as TransportRequestInit } from "./index-DNw-Gzhr.js";
 import { Result } from "better-result";
+import { i as TransportRequestInit } from "./index-nwAjbSQV.js";
 //#region src/publisher.d.ts
 export type PublisherPolicy = {
   type: "obey";
@@ -121,4 +121,5 @@ type ReadBoundedBodyOptions = {
 };
 export declare const readBoundedBody: (response: Response, { maxBytes, signal }: ReadBoundedBodyOptions) => Promise<Result<Uint8Array, PublisherBodyLimitError>>;
 export declare const createPolitePublisherFetch: <Target extends PublisherTarget>({ validateTarget, fetcher, clock, robotsTtlMs, robotsRetryMs, robotsLoadTimeoutMs, defaultMinimumIntervalMs, onTelemetry }: PublisherFetcherOptions<Target>) => (input: string | URL, options?: PublisherFetchOptions) => Promise<Result<PublisherFetchResult, PublisherPolicyError>>;
-//#endregion
+//#endregion
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stll/fetch",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Fetch with a mandatory timeout (headers or idle body window), connection-failure classification, and a robots-aware polite publisher fetch",
   "keywords": [
     "abort",
@@ -57,7 +57,7 @@
     "@stll/typescript-config": "0.0.0",
     "bun-types": "1.4.4",
     "fast-check": "^4.10.2",
-    "tsdown": "0.23.0"
+    "tsdown": "0.23.1"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts"