@zap-studio/retry 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## @zap-studio/retry@0.3.2
+
+### Tree-shakeable root re-exports
+
+The package root now re-exports the full public API, so everything can be imported from `@zap-studio/retry` directly (`BaseRetryPolicy`, `ExponentialBackoff`, `FixedDelay`, `RetryError`, `AbortError`, abort helpers, `defaultSleep`, and all public types). All exports are side-effect free and tree-shakeable; granular subpath imports keep working.
+
+- `BaseRetryPolicy` moved from the entrypoint into its own module, available as the new `./base-policy` subpath.
+- Removed the `./result-mode` and `./throw-mode` subpath exports. Both were orchestration internals (`runResultMode`, `runThrowMode`) and are no longer part of the public API.
+
+## @zap-studio/retry@0.3.1
+
+### Migrate to ultracite lint/format
+
+Internal formatting and lint cleanup only. No public API or behavior change.
+
 # @zap-studio/retry
 
 ## 0.3.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Alexandre Trotel
+Copyright (c) 2026 alexandretrotel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,14 +5,29 @@ Composable retry policy primitives for HTTP clients and async workflows.
 ## Installation
 
 ```bash
+nub add @zap-studio/retry
+# or
 npm install @zap-studio/retry
+# or
+pnpm add @zap-studio/retry
 ```
 
+## Runtime Support
+
+| Runtime            | Minimum version                         |
+| ------------------ | --------------------------------------- |
+| Node.js            | 18.0.0                                  |
+| Bun                | 1.0.0                                   |
+| Deno               | 1.42                                    |
+| Cloudflare Workers | Any current release                     |
+| Browsers           | Chrome/Edge 98, Firefox 97, Safari 15.4 |
+
+Cancellation relies on `AbortSignal.reason`, which sets the browser minimums above. Deno 1.42 is the first release that can install packages from JSR (`deno add jsr:@zap-studio/retry`).
+
 ## Usage
 
 ```ts
-import { ExponentialBackoff } from "@zap-studio/retry/exponential-backoff";
-import { FixedDelay } from "@zap-studio/retry/fixed-delay";
+import { ExponentialBackoff, FixedDelay } from "@zap-studio/retry";
 import { $fetch } from "@zap-studio/fetch";
 
 const exponential = new ExponentialBackoff({
@@ -33,11 +48,10 @@ const data = await exponential.run(async () => {
 
 `run(...)` throws when retries are exhausted.
 
-By default, policies extending `BaseRetryPolicy` throw `RetryError` on exhaustion
-and `AbortError` on cancellation.
+By default, policies extending `BaseRetryPolicy` throw `RetryError` on exhaustion and `AbortError` on cancellation.
 
 ```ts
-import { AbortError, RetryError } from "@zap-studio/retry/errors";
+import { AbortError, RetryError } from "@zap-studio/retry";
 
 try {
   const data = await exponential.run(async () => {
@@ -69,7 +83,7 @@ const result = await exponential.run(
     });
     return await response.json();
   },
-  { throwOnExhausted: false },
+  { throwOnExhausted: false }
 );
 
 if (!result.ok) {
@@ -84,7 +98,7 @@ if (!result.ok) {
 
 `BaseRetryPolicy.run` automatically applies a delay between retry attempts when no custom `sleep` function is provided in the options.
 
-That default is the `defaultSleep` helper, exported from `@zap-studio/retry/sleep`.
+That default is the `defaultSleep` helper, exported from `@zap-studio/retry`.
 
 By default, this delay mechanism relies on the native JavaScript `setTimeout`, meaning retries are scheduled using the standard event loop timing rather than any custom or blocking implementation.
 
@@ -102,7 +116,7 @@ const promise = exponential.run(
     });
     return await response.json();
   },
-  { signal: controller.signal },
+  { signal: controller.signal }
 );
 
 controller.abort(new Error("Request canceled"));
@@ -110,8 +124,7 @@ controller.abort(new Error("Request canceled"));
 await promise;
 ```
 
-In non-throw mode, abort is returned as `{ ok: false }` with `AbortError` on
-`result.error`:
+In non-throw mode, abort is returned as `{ ok: false }` with `AbortError` on `result.error`:
 
 ```ts
 const controller = new AbortController();
@@ -126,7 +139,7 @@ const result = await exponential.run(
   {
     signal: controller.signal,
     throwOnExhausted: false,
-  },
+  }
 );
 
 if (!result.ok) {
@@ -159,18 +172,16 @@ const predictableIntervalPolicy = new FixedDelay({
 
 Extend `BaseRetryPolicy` when the built-in policies do not match your retry rules.
 
-You implement `next(...)` only; the base class supplies `onExhausted` with a default
-`RetryError` and keeps the shared `run(...)` orchestration (override `onExhausted` when
-you need a different terminal error).
+You implement `next(...)` only; the base class supplies `onExhausted` with a default `RetryError` and keeps the shared `run(...)` orchestration (override `onExhausted` when you need a different terminal error).
 
 ```ts
 import { BaseRetryPolicy } from "@zap-studio/retry";
-import type { RetryDecision, RetryDecisionInput } from "@zap-studio/retry/types";
+import type { RetryDecision, RetryDecisionInput } from "@zap-studio/retry";
 
 class LinearBackoff extends BaseRetryPolicy {
   constructor(
     private readonly maxAttempts: number,
-    private readonly stepMs: number,
+    private readonly stepMs: number
   ) {
     super();
   }
@@ -201,7 +212,7 @@ const value = await policy.run(doWork);
 Use `RetryError` when an orchestrator exhausts retries and needs to surface final context.
 
 ```ts
-import { RetryError } from "@zap-studio/retry/errors";
+import { RetryError } from "@zap-studio/retry";
 
 throw new RetryError("Retry policy exhausted all attempts.", {
   attempts: attempt,

package/dist/abort.d.ts

@@ -0,0 +1,29 @@
+import { t as AbortError } from "./errors-BVZjP1Q5.js";
+//#region src/abort.d.ts
+/**
+ * Throws when the provided abort signal is already aborted.
+ *
+ * @param signal - Optional abort signal to inspect.
+ * @throws {AbortError} When the signal is aborted.
+ */
+declare const toAbortError: (reason: unknown) => AbortError;
+/**
+ * Throws when the provided abort signal is already aborted.
+ *
+ * @param signal - Optional abort signal to inspect.
+ * @throws {AbortError} When the signal is aborted.
+ */
+declare const throwIfAborted: (signal?: AbortSignal) => void;
+/**
+ * Waits for delay sleep while observing cancellation through an abort signal.
+ *
+ * @param sleep - Sleep function used to await `delayMs`.
+ * @param delayMs - Delay duration in milliseconds.
+ * @param signal - Abort signal to observe while waiting.
+ * @returns Promise that resolves when delay finishes.
+ * @throws {AbortError} When the signal aborts before or during wait.
+ */
+declare const sleepWithAbortSignal: (sleep: (delayMs: number) => Promise<void>, delayMs: number, signal: AbortSignal) => Promise<void>;
+//#endregion
+export { sleepWithAbortSignal, throwIfAborted, toAbortError };
+//# sourceMappingURL=abort.d.ts.map

package/dist/abort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort.d.ts","names":[],"sources":["../src/abort.ts"],"mappings":";;;;;;;;cAca,eAAgB,oBAAkB;;;;;;;cA8BlC,iBAAkB,SAAS;;;;;;;;;;cAiB3B,uBACX,QAAQ,oBAAoB,eAC5B,iBACA,QAAQ,gBACP"}

package/dist/{abort.mjs → abort.js}

@@ -1,4 +1,4 @@
-import { AbortError } from "./errors.mjs";
+import { AbortError } from "./errors.js";
 //#region src/abort.ts
 /**
 * Abort-signal helpers for retry orchestration internals.
@@ -11,17 +11,7 @@ import { AbortError } from "./errors.mjs";
 * @param signal - Optional abort signal to inspect.
 * @throws {AbortError} When the signal is aborted.
 */
-function throwIfAborted(signal) {
-	if (!signal?.aborted) return;
-	throw toAbortError(signal.reason);
-}
-/**
-* Converts an abort reason into a normalized `AbortError`.
-*
-* @param reason - Arbitrary abort reason value.
-* @returns Normalized abort error instance.
-*/
-function toAbortError(reason) {
+const toAbortError = (reason) => {
 	if (reason instanceof AbortError) return reason;
 	if (reason instanceof Error) return new AbortError(reason.message, { cause: reason });
 	if (typeof reason === "string" && reason.length > 0) return new AbortError(reason);
@@ -31,7 +21,17 @@ function toAbortError(reason) {
 	} catch {
 		return new AbortError("Retry aborted.");
 	}
-}
+};
+/**
+* Throws when the provided abort signal is already aborted.
+*
+* @param signal - Optional abort signal to inspect.
+* @throws {AbortError} When the signal is aborted.
+*/
+const throwIfAborted = (signal) => {
+	if (signal?.aborted !== true) return;
+	throw toAbortError(signal.reason);
+};
 /**
 * Waits for delay sleep while observing cancellation through an abort signal.
 *
@@ -41,11 +41,11 @@ function toAbortError(reason) {
 * @returns Promise that resolves when delay finishes.
 * @throws {AbortError} When the signal aborts before or during wait.
 */
-async function sleepWithAbortSignal(sleep, delayMs, signal) {
+const sleepWithAbortSignal = async (sleep, delayMs, signal) => {
 	if (signal.aborted) throw toAbortError(signal.reason);
 	let onAbort;
 	try {
-		await Promise.race([sleep(delayMs), new Promise((_, reject) => {
+		await Promise.race([sleep(delayMs), new Promise((_resolve, reject) => {
 			onAbort = () => {
 				reject(toAbortError(signal.reason));
 			};
@@ -54,8 +54,8 @@ async function sleepWithAbortSignal(sleep, delayMs, signal) {
 	} finally {
 		if (onAbort) signal.removeEventListener("abort", onAbort);
 	}
-}
+};
 //#endregion
 export { sleepWithAbortSignal, throwIfAborted, toAbortError };
 
-//# sourceMappingURL=abort.mjs.map
+//# sourceMappingURL=abort.js.map

package/dist/abort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort.js","names":[],"sources":["../src/abort.ts"],"sourcesContent":["/**\n * Abort-signal helpers for retry orchestration internals.\n *\n * @module @zap-studio/retry/abort\n */\n\nimport { AbortError } from \"./errors.js\";\n\n/**\n * Throws when the provided abort signal is already aborted.\n *\n * @param signal - Optional abort signal to inspect.\n * @throws {AbortError} When the signal is aborted.\n */\nexport const toAbortError = (reason: unknown): AbortError => {\n  if (reason instanceof AbortError) {\n    return reason;\n  }\n\n  if (reason instanceof Error) {\n    return new AbortError(reason.message, { cause: reason });\n  }\n\n  if (typeof reason === \"string\" && reason.length > 0) {\n    return new AbortError(reason);\n  }\n\n  if (reason === undefined) {\n    return new AbortError(\"Retry aborted.\");\n  }\n\n  try {\n    return new AbortError(`Retry aborted: ${JSON.stringify(reason)}`);\n  } catch {\n    return new AbortError(\"Retry aborted.\");\n  }\n};\n\n/**\n * Throws when the provided abort signal is already aborted.\n *\n * @param signal - Optional abort signal to inspect.\n * @throws {AbortError} When the signal is aborted.\n */\nexport const throwIfAborted = (signal?: AbortSignal): void => {\n  if (signal?.aborted !== true) {\n    return;\n  }\n\n  throw toAbortError(signal.reason);\n};\n\n/**\n * Waits for delay sleep while observing cancellation through an abort signal.\n *\n * @param sleep - Sleep function used to await `delayMs`.\n * @param delayMs - Delay duration in milliseconds.\n * @param signal - Abort signal to observe while waiting.\n * @returns Promise that resolves when delay finishes.\n * @throws {AbortError} When the signal aborts before or during wait.\n */\nexport const sleepWithAbortSignal = async (\n  sleep: (delayMs: number) => Promise<void>,\n  delayMs: number,\n  signal: AbortSignal\n): Promise<void> => {\n  if (signal.aborted) {\n    throw toAbortError(signal.reason);\n  }\n\n  let onAbort: (() => void) | undefined;\n\n  try {\n    await Promise.race([\n      sleep(delayMs),\n      // oxlint-disable-next-line promise/avoid-new -- AbortSignal callback is adapted into the race promise.\n      new Promise<never>((_resolve, reject) => {\n        onAbort = (): void => {\n          reject(toAbortError(signal.reason));\n        };\n\n        signal.addEventListener(\"abort\", onAbort, { once: true });\n      }),\n    ]);\n  } finally {\n    if (onAbort) {\n      signal.removeEventListener(\"abort\", onAbort);\n    }\n  }\n};\n"],"mappings":";;;;;;;;;;;;;AAcA,MAAa,gBAAgB,WAAgC;CAC3D,IAAI,kBAAkB,YACpB,OAAO;CAGT,IAAI,kBAAkB,OACpB,OAAO,IAAI,WAAW,OAAO,SAAS,EAAE,OAAO,OAAO,CAAC;CAGzD,IAAI,OAAO,WAAW,YAAY,OAAO,SAAS,GAChD,OAAO,IAAI,WAAW,MAAM;CAG9B,IAAI,WAAW,KAAA,GACb,OAAO,IAAI,WAAW,gBAAgB;CAGxC,IAAI;EACF,OAAO,IAAI,WAAW,kBAAkB,KAAK,UAAU,MAAM,GAAG;CAClE,QAAQ;EACN,OAAO,IAAI,WAAW,gBAAgB;CACxC;AACF;;;;;;;AAQA,MAAa,kBAAkB,WAA+B;CAC5D,IAAI,QAAQ,YAAY,MACtB;CAGF,MAAM,aAAa,OAAO,MAAM;AAClC;;;;;;;;;;AAWA,MAAa,uBAAuB,OAClC,OACA,SACA,WACkB;CAClB,IAAI,OAAO,SACT,MAAM,aAAa,OAAO,MAAM;CAGlC,IAAI;CAEJ,IAAI;EACF,MAAM,QAAQ,KAAK,CACjB,MAAM,OAAO,GAEb,IAAI,SAAgB,UAAU,WAAW;GACvC,gBAAsB;IACpB,OAAO,aAAa,OAAO,MAAM,CAAC;GACpC;GAEA,OAAO,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;EAC1D,CAAC,CACH,CAAC;CACH,UAAU;EACR,IAAI,SACF,OAAO,oBAAoB,SAAS,OAAO;CAE/C;AACF"}

package/dist/base-policy-Dn3TOJd3.js

@@ -0,0 +1,248 @@
+import { RetryError } from "./errors.js";
+import { sleepWithAbortSignal, throwIfAborted, toAbortError } from "./abort.js";
+import { defaultSleep } from "./sleep.js";
+//#region src/_result-mode.ts
+/**
+* Result-mode execution path for `BaseRetryPolicy.run` when
+* `throwOnExhausted: false` is set.
+*
+* @module @zap-studio/retry/_result-mode (private)
+*/
+/**
+* When `signal` is already aborted, builds the terminal `{ ok: false }` object
+* with a normalized `AbortError` on `error`.
+*
+* @param signal - Optional abort signal; only acts when `aborted` is set.
+* @param attempts - Number of finished attempts to report in the result.
+* @returns Failure result or `undefined` if not aborted.
+*/
+const buildAbortResult = (signal, attempts) => {
+	if (signal?.aborted !== true) return;
+	return {
+		attempts,
+		error: toAbortError(signal.reason),
+		ok: false
+	};
+};
+/**
+* Runs one `execute(attempt)` call and returns either a success value or a
+* captured error without rethrowing.
+*
+* @param execute - User work callback.
+* @param attempt - One-based attempt number passed to `execute`.
+* @returns A tagged success with `value` or a tagged failure with `error`.
+*/
+const runAttempt = async (execute, attempt) => {
+	try {
+		return {
+			ok: true,
+			value: await execute(attempt)
+		};
+	} catch (error) {
+		return {
+			error,
+			ok: false
+		};
+	}
+};
+/**
+* Awaits inter-attempt delay in result mode, mapping an abort during wait to
+* a terminal result instead of throwing when `throwOnExhausted` is false.
+*
+* @param sleep - Custom or default sleep implementation.
+* @param delayMs - Milliseconds to wait.
+* @param signal - If set, `sleep` is raced with the abort signal.
+* @param attempts - Attempt count to attach if the wait ends in abort.
+* @returns A terminal result when canceled during the wait, otherwise
+*   `undefined`.
+* @throws {Error} The underlying `sleep` rejection when it is not an abort.
+*/
+const waitForDelay = async (sleep, delayMs, signal, attempts) => {
+	if (signal === void 0) {
+		await sleep(delayMs);
+		return;
+	}
+	try {
+		await sleepWithAbortSignal(sleep, delayMs, signal);
+		return;
+	} catch (error) {
+		const aborted = buildAbortResult(signal, attempts);
+		if (aborted !== void 0) return aborted;
+		throw error;
+	}
+};
+/**
+* After a failed attempt, applies abort rules, `next`, optional delay, and
+* either returns a terminal `RetryRunResult` or `undefined` to continue.
+*
+* @param policy - Retry policy hooks (`next`, `onExhausted`) matching
+*   `BaseRetryPolicy`.
+* @param params - Failure context for the current attempt.
+* @param params.attempt - Current attempt number.
+* @param params.error - Error thrown by the attempt.
+* @param params.sleep - Delay function between retries.
+* @param params.signal - Optional abort signal.
+* @returns Terminal non-throw result if the loop should stop, otherwise
+*   `undefined` to schedule another attempt.
+* @throws {Error} Any error thrown by `next`, `onExhausted`, or a custom `sleep` when
+*   the error is not an abort.
+*/
+const handleFailure = async (policy, params) => {
+	const { attempt, error, sleep, signal } = params;
+	const abortResult = buildAbortResult(signal, attempt);
+	if (abortResult !== void 0) return abortResult;
+	const decision = policy.next({
+		attempt,
+		error
+	});
+	if (!decision.shouldRetry) return {
+		attempts: attempt,
+		error: policy.onExhausted({
+			attempts: attempt,
+			error
+		}),
+		ok: false
+	};
+	if (decision.delayMs > 0) {
+		const delayAbortResult = await waitForDelay(sleep, decision.delayMs, signal, attempt);
+		if (delayAbortResult !== void 0) return delayAbortResult;
+	}
+};
+/**
+* Runs the non-throw retry loop, returning
+* `RetryRunResult`.
+*
+* @param policy - Object providing `next` and `onExhausted` (same contract as
+*   `BaseRetryPolicy`).
+* @param execute - Async work callback per attempt.
+* @param sleep - Delay function between retries.
+* @param signal - Optional cancel signal.
+* @returns Terminal success or failure object.
+* @throws {Error} Any error thrown by `next`, `onExhausted`, or a non-abort `sleep`
+*   failure.
+*/
+const runResultMode = async (policy, execute, sleep, signal) => {
+	let attempt = 1;
+	while (true) {
+		const abortResult = buildAbortResult(signal, Math.max(0, attempt - 1));
+		if (abortResult !== void 0) return abortResult;
+		const execution = await runAttempt(execute, attempt);
+		if (execution.ok) return {
+			ok: true,
+			value: execution.value
+		};
+		const failure = await handleFailure(policy, {
+			attempt,
+			error: execution.error,
+			signal,
+			sleep
+		});
+		if (failure !== void 0) return failure;
+		attempt += 1;
+	}
+};
+//#endregion
+//#region src/_throw-mode.ts
+/**
+* Throw-mode execution path for `BaseRetryPolicy.run` (default when
+* `throwOnExhausted` is not `false`).
+*
+* @module @zap-studio/retry/_throw-mode (private)
+*/
+/**
+* Runs the throw-mode retry loop: throws `RetryError` on exhaustion and
+* `AbortError` when `signal` aborts.
+*
+* @param policy - Object providing `next` and `onExhausted` (same contract as
+*   `BaseRetryPolicy`).
+* @param execute - Async work callback per attempt.
+* @param sleep - Delay function between retries.
+* @param signal - Optional cancel signal.
+* @returns Resolves to the first successful return value.
+* @throws {RetryError} When retries are exhausted and `onExhausted` returns
+*   the terminal error.
+* @throws {AbortError} When `signal` is already aborted or aborts while waiting.
+* @throws {Error} Any error thrown by `next`, `onExhausted`, or `sleep`.
+*/
+const runThrowMode = async (policy, execute, sleep, signal) => {
+	let attempt = 1;
+	while (true) {
+		throwIfAborted(signal);
+		try {
+			return await execute(attempt);
+		} catch (error) {
+			throwIfAborted(signal);
+			const typedError = error;
+			const decision = policy.next({
+				attempt,
+				error: typedError
+			});
+			if (!decision.shouldRetry) throw policy.onExhausted({
+				attempts: attempt,
+				error: typedError
+			});
+			if (decision.delayMs > 0) await (signal === void 0 ? sleep(decision.delayMs) : sleepWithAbortSignal(sleep, decision.delayMs, signal));
+			attempt += 1;
+		}
+	}
+};
+//#endregion
+//#region src/base-policy.ts
+/**
+* Retry runner base class and shared orchestration implementation.
+*
+* @module @zap-studio/retry/base-policy
+*/
+/**
+* Base class for implementing retry policies and running retry orchestration.
+*
+* Extend this class and implement {@link BaseRetryPolicy.next} to define retry
+* behavior, then call {@link BaseRetryPolicy.run} to execute operations with that
+* policy.
+*/
+var BaseRetryPolicy = class {
+	/**
+	* Builds the terminal error thrown or returned when retries are exhausted.
+	*
+	* Override this when you need custom terminal error types.
+	*
+	* @param input - Exhaustion context.
+	* @returns `RetryError` by default.
+	* @throws {Error} Any error thrown by an overriding policy implementation.
+	*/
+	onExhausted(input) {
+		return new RetryError("Retry policy exhausted all attempts.", {
+			attempts: input.attempts,
+			lastData: input.data,
+			lastError: input.error
+		});
+	}
+	/**
+	* Runs retry orchestration in non-throw mode.
+	*
+	* When `throwOnExhausted` is `false`, returns a discriminated result union.
+	*
+	* @param execute - Async function to execute per attempt.
+	* @param options - Runner settings.
+	* @returns Success value or terminal result object based on option mode.
+	* @throws {Error} Any error thrown by `next`, by `onExhausted`, or by a custom `sleep`
+	*   function. When `throwOnExhausted` is `false`, exhaustion itself is returned
+	*   as `{ ok: false }` instead of thrown.
+	*   Cancellation is returned as `{ ok: false, error: AbortError }` in non-throw
+	*   mode.
+	*
+	* @example
+	* const result = await policy.run(doWork, { throwOnExhausted: false });
+	* if (!result.ok) console.error(result.error);
+	*/
+	async run(execute, options = {}) {
+		const sleep = options.sleep ?? defaultSleep;
+		const { signal } = options;
+		if (options.throwOnExhausted === false) return await runResultMode(this, execute, sleep, signal);
+		return await runThrowMode(this, execute, sleep, signal);
+	}
+};
+//#endregion
+export { BaseRetryPolicy as t };
+
+//# sourceMappingURL=base-policy-Dn3TOJd3.js.map

package/dist/base-policy-Dn3TOJd3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-policy-Dn3TOJd3.js","names":[],"sources":["../src/_result-mode.ts","../src/_throw-mode.ts","../src/base-policy.ts"],"sourcesContent":["/**\n * Result-mode execution path for `BaseRetryPolicy.run` when\n * `throwOnExhausted: false` is set.\n *\n * @module @zap-studio/retry/_result-mode (private)\n */\n\nimport { sleepWithAbortSignal, toAbortError } from \"./abort.js\";\nimport type { RetryPolicy, RetryRunResult } from \"./types.js\";\n\n/**\n * When `signal` is already aborted, builds the terminal `{ ok: false }` object\n * with a normalized `AbortError` on `error`.\n *\n * @param signal - Optional abort signal; only acts when `aborted` is set.\n * @param attempts - Number of finished attempts to report in the result.\n * @returns Failure result or `undefined` if not aborted.\n */\nconst buildAbortResult = (\n  signal: AbortSignal | undefined,\n  attempts: number\n): RetryRunResult<never> | undefined => {\n  if (signal?.aborted !== true) {\n    return undefined;\n  }\n\n  return {\n    attempts,\n    error: toAbortError(signal.reason),\n    ok: false,\n  };\n};\n\n/**\n * Runs one `execute(attempt)` call and returns either a success value or a\n * captured error without rethrowing.\n *\n * @param execute - User work callback.\n * @param attempt - One-based attempt number passed to `execute`.\n * @returns A tagged success with `value` or a tagged failure with `error`.\n */\nconst runAttempt = async <T>(\n  execute: (attempt: number) => Promise<T>,\n  attempt: number\n): Promise<{ ok: true; value: T } | { ok: false; error: unknown }> => {\n  try {\n    return {\n      ok: true,\n      value: await execute(attempt),\n    };\n  } catch (error) {\n    return {\n      error,\n      ok: false,\n    };\n  }\n};\n\n/**\n * Awaits inter-attempt delay in result mode, mapping an abort during wait to\n * a terminal result instead of throwing when `throwOnExhausted` is false.\n *\n * @param sleep - Custom or default sleep implementation.\n * @param delayMs - Milliseconds to wait.\n * @param signal - If set, `sleep` is raced with the abort signal.\n * @param attempts - Attempt count to attach if the wait ends in abort.\n * @returns A terminal result when canceled during the wait, otherwise\n *   `undefined`.\n * @throws {Error} The underlying `sleep` rejection when it is not an abort.\n */\nconst waitForDelay = async (\n  sleep: (delayMs: number) => Promise<void>,\n  delayMs: number,\n  signal: AbortSignal | undefined,\n  attempts: number\n): Promise<RetryRunResult<never> | undefined> => {\n  if (signal === undefined) {\n    await sleep(delayMs);\n    return undefined;\n  }\n\n  try {\n    await sleepWithAbortSignal(sleep, delayMs, signal);\n    return undefined;\n  } catch (error) {\n    const aborted = buildAbortResult(signal, attempts);\n    if (aborted !== undefined) {\n      return aborted;\n    }\n    throw error;\n  }\n};\n\n/**\n * After a failed attempt, applies abort rules, `next`, optional delay, and\n * either returns a terminal `RetryRunResult` or `undefined` to continue.\n *\n * @param policy - Retry policy hooks (`next`, `onExhausted`) matching\n *   `BaseRetryPolicy`.\n * @param params - Failure context for the current attempt.\n * @param params.attempt - Current attempt number.\n * @param params.error - Error thrown by the attempt.\n * @param params.sleep - Delay function between retries.\n * @param params.signal - Optional abort signal.\n * @returns Terminal non-throw result if the loop should stop, otherwise\n *   `undefined` to schedule another attempt.\n * @throws {Error} Any error thrown by `next`, `onExhausted`, or a custom `sleep` when\n *   the error is not an abort.\n */\nconst handleFailure = async <TError, TData>(\n  policy: RetryPolicy<TError, TData>,\n  params: {\n    attempt: number;\n    error: TError;\n    sleep: (delayMs: number) => Promise<void>;\n    signal: AbortSignal | undefined;\n  }\n): Promise<RetryRunResult<never> | undefined> => {\n  const { attempt, error, sleep, signal } = params;\n  const abortResult = buildAbortResult(signal, attempt);\n  if (abortResult !== undefined) {\n    return abortResult;\n  }\n\n  const decision = policy.next({\n    attempt,\n    error,\n  });\n\n  if (!decision.shouldRetry) {\n    const terminalError = policy.onExhausted({\n      attempts: attempt,\n      error,\n    });\n\n    return {\n      attempts: attempt,\n      error: terminalError,\n      ok: false,\n    };\n  }\n\n  if (decision.delayMs > 0) {\n    const delayAbortResult = await waitForDelay(\n      sleep,\n      decision.delayMs,\n      signal,\n      attempt\n    );\n    if (delayAbortResult !== undefined) {\n      return delayAbortResult;\n    }\n  }\n\n  return undefined;\n};\n\n/**\n * Runs the non-throw retry loop, returning\n * `RetryRunResult`.\n *\n * @param policy - Object providing `next` and `onExhausted` (same contract as\n *   `BaseRetryPolicy`).\n * @param execute - Async work callback per attempt.\n * @param sleep - Delay function between retries.\n * @param signal - Optional cancel signal.\n * @returns Terminal success or failure object.\n * @throws {Error} Any error thrown by `next`, `onExhausted`, or a non-abort `sleep`\n *   failure.\n */\nexport const runResultMode = async <T, TError, TData>(\n  policy: RetryPolicy<TError, TData>,\n  execute: (attempt: number) => Promise<T>,\n  sleep: (delayMs: number) => Promise<void>,\n  signal?: AbortSignal\n): Promise<RetryRunResult<T>> => {\n  let attempt = 1;\n\n  while (true) {\n    const abortResult = buildAbortResult(signal, Math.max(0, attempt - 1));\n    if (abortResult !== undefined) {\n      return abortResult;\n    }\n\n    // oxlint-disable-next-line no-await-in-loop -- Retry attempts must run sequentially.\n    const execution = await runAttempt(execute, attempt);\n    if (execution.ok) {\n      return { ok: true, value: execution.value };\n    }\n\n    // oxlint-disable-next-line no-await-in-loop -- Failure handling belongs to the current sequential attempt.\n    const failure = await handleFailure(policy, {\n      attempt,\n      // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- Policy error generic represents the caller's thrown error domain.\n      error: execution.error as TError,\n      signal,\n      sleep,\n    });\n    if (failure !== undefined) {\n      return failure;\n    }\n\n    attempt += 1;\n  }\n};\n","/**\n * Throw-mode execution path for `BaseRetryPolicy.run` (default when\n * `throwOnExhausted` is not `false`).\n *\n * @module @zap-studio/retry/_throw-mode (private)\n */\n\nimport { sleepWithAbortSignal, throwIfAborted } from \"./abort.js\";\nimport type { RetryPolicy } from \"./types.js\";\n\n/**\n * Runs the throw-mode retry loop: throws `RetryError` on exhaustion and\n * `AbortError` when `signal` aborts.\n *\n * @param policy - Object providing `next` and `onExhausted` (same contract as\n *   `BaseRetryPolicy`).\n * @param execute - Async work callback per attempt.\n * @param sleep - Delay function between retries.\n * @param signal - Optional cancel signal.\n * @returns Resolves to the first successful return value.\n * @throws {RetryError} When retries are exhausted and `onExhausted` returns\n *   the terminal error.\n * @throws {AbortError} When `signal` is already aborted or aborts while waiting.\n * @throws {Error} Any error thrown by `next`, `onExhausted`, or `sleep`.\n */\nexport const runThrowMode = async <T, TError, TData>(\n  policy: RetryPolicy<TError, TData>,\n  execute: (attempt: number) => Promise<T>,\n  sleep: (delayMs: number) => Promise<void>,\n  signal?: AbortSignal\n): Promise<T> => {\n  let attempt = 1;\n\n  while (true) {\n    throwIfAborted(signal);\n\n    try {\n      // oxlint-disable-next-line no-await-in-loop -- Retry attempts must run sequentially.\n      return await execute(attempt);\n    } catch (error) {\n      throwIfAborted(signal);\n\n      // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- Policy error generic represents the caller's thrown error domain.\n      const typedError = error as TError;\n      const decision = policy.next({\n        attempt,\n        error: typedError,\n      });\n\n      if (!decision.shouldRetry) {\n        throw policy.onExhausted({\n          attempts: attempt,\n          error: typedError,\n        });\n      }\n\n      if (decision.delayMs > 0) {\n        // oxlint-disable-next-line no-await-in-loop -- Delay belongs between sequential retry attempts.\n        await (signal === undefined\n          ? sleep(decision.delayMs)\n          : sleepWithAbortSignal(sleep, decision.delayMs, signal));\n      }\n\n      attempt += 1;\n    }\n  }\n};\n","/**\n * Retry runner base class and shared orchestration implementation.\n *\n * @module @zap-studio/retry/base-policy\n */\n\nimport { runResultMode } from \"./_result-mode.js\";\nimport { runThrowMode } from \"./_throw-mode.js\";\nimport { RetryError } from \"./errors.js\";\nimport { defaultSleep } from \"./sleep.js\";\nimport type {\n  RetryDecision,\n  RetryDecisionInput,\n  RetryExhaustedInput,\n  RetryPolicy,\n  RetryRunOptions,\n  RetryRunResult,\n} from \"./types.js\";\n\n/**\n * Base class for implementing retry policies and running retry orchestration.\n *\n * Extend this class and implement {@link BaseRetryPolicy.next} to define retry\n * behavior, then call {@link BaseRetryPolicy.run} to execute operations with that\n * policy.\n */\nexport abstract class BaseRetryPolicy<\n  TError = unknown,\n  TData = unknown,\n> implements RetryPolicy<TError, TData> {\n  /**\n   * Returns the retry decision for a failed attempt.\n   *\n   * @param input - Attempt context used to compute retry behavior.\n   * @throws {Error} Any error thrown by a concrete retry policy implementation.\n   */\n  public abstract next(input: RetryDecisionInput<TError, TData>): RetryDecision;\n\n  /**\n   * Builds the terminal error thrown or returned when retries are exhausted.\n   *\n   * Override this when you need custom terminal error types.\n   *\n   * @param input - Exhaustion context.\n   * @returns `RetryError` by default.\n   * @throws {Error} Any error thrown by an overriding policy implementation.\n   */\n  // oxlint-disable-next-line class-methods-use-this -- RetryPolicy requires an instance hook that subclasses may override.\n  public onExhausted(input: RetryExhaustedInput<TError, TData>): RetryError {\n    return new RetryError(\"Retry policy exhausted all attempts.\", {\n      attempts: input.attempts,\n      lastData: input.data,\n      lastError: input.error,\n    });\n  }\n\n  /**\n   * Runs retry orchestration in non-throw mode.\n   *\n   * @param execute - Async function to execute per attempt.\n   * @param options - Runner settings with `throwOnExhausted: false`.\n   * @returns A discriminated result union containing success value or terminal error.\n   * @throws {Error} Any error thrown by `next`, `onExhausted`, or a custom `sleep`.\n   */\n  public async run<T>(\n    execute: (attempt: number) => Promise<T>,\n    options: RetryRunOptions & { throwOnExhausted: false }\n  ): Promise<RetryRunResult<T>>;\n\n  /**\n   * Runs retry orchestration and throws terminal error on exhaustion.\n   *\n   * @param execute - Async function to execute per attempt.\n   * @param options - Optional runner settings.\n   * @returns The successful execution value.\n   * @throws {RetryError} When retries are exhausted and `onExhausted` returns the\n   *   terminal retry error. The default implementation returns `RetryError` with the last\n   *   execution failure available on `RetryError.lastError`.\n   * @throws {AbortError} When `options.signal` is already aborted or aborts while retrying.\n   * @throws {Error} Any error thrown by `next`, by `onExhausted`, or by a custom `sleep`\n   *   function.\n   */\n  public async run<T>(\n    execute: (attempt: number) => Promise<T>,\n    options?: RetryRunOptions & { throwOnExhausted?: true }\n  ): Promise<T>;\n\n  /**\n   * Runs retry orchestration in non-throw mode.\n   *\n   * When `throwOnExhausted` is `false`, returns a discriminated result union.\n   *\n   * @param execute - Async function to execute per attempt.\n   * @param options - Runner settings.\n   * @returns Success value or terminal result object based on option mode.\n   * @throws {Error} Any error thrown by `next`, by `onExhausted`, or by a custom `sleep`\n   *   function. When `throwOnExhausted` is `false`, exhaustion itself is returned\n   *   as `{ ok: false }` instead of thrown.\n   *   Cancellation is returned as `{ ok: false, error: AbortError }` in non-throw\n   *   mode.\n   *\n   * @example\n   * const result = await policy.run(doWork, { throwOnExhausted: false });\n   * if (!result.ok) console.error(result.error);\n   */\n  public async run<T>(\n    execute: (attempt: number) => Promise<T>,\n    options: RetryRunOptions = {}\n  ): Promise<T | RetryRunResult<T>> {\n    const sleep = options.sleep ?? defaultSleep;\n    const { signal } = options;\n    if (options.throwOnExhausted === false) {\n      return await runResultMode(this, execute, sleep, signal);\n    }\n\n    return await runThrowMode(this, execute, sleep, signal);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAM,oBACJ,QACA,aACsC;CACtC,IAAI,QAAQ,YAAY,MACtB;CAGF,OAAO;EACL;EACA,OAAO,aAAa,OAAO,MAAM;EACjC,IAAI;CACN;AACF;;;;;;;;;AAUA,MAAM,aAAa,OACjB,SACA,YACoE;CACpE,IAAI;EACF,OAAO;GACL,IAAI;GACJ,OAAO,MAAM,QAAQ,OAAO;EAC9B;CACF,SAAS,OAAO;EACd,OAAO;GACL;GACA,IAAI;EACN;CACF;AACF;;;;;;;;;;;;;AAcA,MAAM,eAAe,OACnB,OACA,SACA,QACA,aAC+C;CAC/C,IAAI,WAAW,KAAA,GAAW;EACxB,MAAM,MAAM,OAAO;EACnB;CACF;CAEA,IAAI;EACF,MAAM,qBAAqB,OAAO,SAAS,MAAM;EACjD;CACF,SAAS,OAAO;EACd,MAAM,UAAU,iBAAiB,QAAQ,QAAQ;EACjD,IAAI,YAAY,KAAA,GACd,OAAO;EAET,MAAM;CACR;AACF;;;;;;;;;;;;;;;;;AAkBA,MAAM,gBAAgB,OACpB,QACA,WAM+C;CAC/C,MAAM,EAAE,SAAS,OAAO,OAAO,WAAW;CAC1C,MAAM,cAAc,iBAAiB,QAAQ,OAAO;CACpD,IAAI,gBAAgB,KAAA,GAClB,OAAO;CAGT,MAAM,WAAW,OAAO,KAAK;EAC3B;EACA;CACF,CAAC;CAED,IAAI,CAAC,SAAS,aAMZ,OAAO;EACL,UAAU;EACV,OAPoB,OAAO,YAAY;GACvC,UAAU;GACV;EACF,CAIqB;EACnB,IAAI;CACN;CAGF,IAAI,SAAS,UAAU,GAAG;EACxB,MAAM,mBAAmB,MAAM,aAC7B,OACA,SAAS,SACT,QACA,OACF;EACA,IAAI,qBAAqB,KAAA,GACvB,OAAO;CAEX;AAGF;;;;;;;;;;;;;;AAeA,MAAa,gBAAgB,OAC3B,QACA,SACA,OACA,WAC+B;CAC/B,IAAI,UAAU;CAEd,OAAO,MAAM;EACX,MAAM,cAAc,iBAAiB,QAAQ,KAAK,IAAI,GAAG,UAAU,CAAC,CAAC;EACrE,IAAI,gBAAgB,KAAA,GAClB,OAAO;EAIT,MAAM,YAAY,MAAM,WAAW,SAAS,OAAO;EACnD,IAAI,UAAU,IACZ,OAAO;GAAE,IAAI;GAAM,OAAO,UAAU;EAAM;EAI5C,MAAM,UAAU,MAAM,cAAc,QAAQ;GAC1C;GAEA,OAAO,UAAU;GACjB;GACA;EACF,CAAC;EACD,IAAI,YAAY,KAAA,GACd,OAAO;EAGT,WAAW;CACb;AACF;;;;;;;;;;;;;;;;;;;;;;;;ACnLA,MAAa,eAAe,OAC1B,QACA,SACA,OACA,WACe;CACf,IAAI,UAAU;CAEd,OAAO,MAAM;EACX,eAAe,MAAM;EAErB,IAAI;GAEF,OAAO,MAAM,QAAQ,OAAO;EAC9B,SAAS,OAAO;GACd,eAAe,MAAM;GAGrB,MAAM,aAAa;GACnB,MAAM,WAAW,OAAO,KAAK;IAC3B;IACA,OAAO;GACT,CAAC;GAED,IAAI,CAAC,SAAS,aACZ,MAAM,OAAO,YAAY;IACvB,UAAU;IACV,OAAO;GACT,CAAC;GAGH,IAAI,SAAS,UAAU,GAErB,OAAO,WAAW,KAAA,IACd,MAAM,SAAS,OAAO,IACtB,qBAAqB,OAAO,SAAS,SAAS,MAAM;GAG1D,WAAW;EACb;CACF;AACF;;;;;;;;;;;;;;;ACxCA,IAAsB,kBAAtB,MAGwC;;;;;;;;;;CAmBtC,YAAmB,OAAuD;EACxE,OAAO,IAAI,WAAW,wCAAwC;GAC5D,UAAU,MAAM;GAChB,UAAU,MAAM;GAChB,WAAW,MAAM;EACnB,CAAC;CACH;;;;;;;;;;;;;;;;;;;CAmDA,MAAa,IACX,SACA,UAA2B,CAAC,GACI;EAChC,MAAM,QAAQ,QAAQ,SAAS;EAC/B,MAAM,EAAE,WAAW;EACnB,IAAI,QAAQ,qBAAqB,OAC/B,OAAO,MAAM,cAAc,MAAM,SAAS,OAAO,MAAM;EAGzD,OAAO,MAAM,aAAa,MAAM,SAAS,OAAO,MAAM;CACxD;AACF"}

package/dist/base-policy.d.ts

@@ -0,0 +1,59 @@
+import { r as RetryError } from "./errors-BVZjP1Q5.js";
+import { RetryDecision, RetryDecisionInput, RetryExhaustedInput, RetryPolicy, RetryRunOptions, RetryRunResult } from "./types.js";
+//#region src/base-policy.d.ts
+/**
+ * Base class for implementing retry policies and running retry orchestration.
+ *
+ * Extend this class and implement {@link BaseRetryPolicy.next} to define retry
+ * behavior, then call {@link BaseRetryPolicy.run} to execute operations with that
+ * policy.
+ */
+declare abstract class BaseRetryPolicy<TError = unknown, TData = unknown> implements RetryPolicy<TError, TData> {
+  /**
+   * Returns the retry decision for a failed attempt.
+   *
+   * @param input - Attempt context used to compute retry behavior.
+   * @throws {Error} Any error thrown by a concrete retry policy implementation.
+   */
+  abstract next(input: RetryDecisionInput<TError, TData>): RetryDecision;
+  /**
+   * Builds the terminal error thrown or returned when retries are exhausted.
+   *
+   * Override this when you need custom terminal error types.
+   *
+   * @param input - Exhaustion context.
+   * @returns `RetryError` by default.
+   * @throws {Error} Any error thrown by an overriding policy implementation.
+   */
+  onExhausted(input: RetryExhaustedInput<TError, TData>): RetryError;
+  /**
+   * Runs retry orchestration in non-throw mode.
+   *
+   * @param execute - Async function to execute per attempt.
+   * @param options - Runner settings with `throwOnExhausted: false`.
+   * @returns A discriminated result union containing success value or terminal error.
+   * @throws {Error} Any error thrown by `next`, `onExhausted`, or a custom `sleep`.
+   */
+  run<T>(execute: (attempt: number) => Promise<T>, options: RetryRunOptions & {
+    throwOnExhausted: false;
+  }): Promise<RetryRunResult<T>>;
+  /**
+   * Runs retry orchestration and throws terminal error on exhaustion.
+   *
+   * @param execute - Async function to execute per attempt.
+   * @param options - Optional runner settings.
+   * @returns The successful execution value.
+   * @throws {RetryError} When retries are exhausted and `onExhausted` returns the
+   *   terminal retry error. The default implementation returns `RetryError` with the last
+   *   execution failure available on `RetryError.lastError`.
+   * @throws {AbortError} When `options.signal` is already aborted or aborts while retrying.
+   * @throws {Error} Any error thrown by `next`, by `onExhausted`, or by a custom `sleep`
+   *   function.
+   */
+  run<T>(execute: (attempt: number) => Promise<T>, options?: RetryRunOptions & {
+    throwOnExhausted?: true;
+  }): Promise<T>;
+}
+//#endregion
+export { BaseRetryPolicy };
+//# sourceMappingURL=base-policy.d.ts.map

package/dist/base-policy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-policy.d.ts","names":[],"sources":["../src/base-policy.ts"],"mappings":";;;;;;;;;;uBA0BsB,gBACpB,kBACA,4BACW,YAAY,QAAQ;;;;;;;WAOf,KAAK,OAAO,mBAAmB,QAAQ,SAAS;;;;;;;;;;EAYhE,YAAmB,OAAO,oBAAoB,QAAQ,SAAS;;;;;;;;;EAgB/D,IAAiB,GACf,UAAU,oBAAoB,QAAQ,IACtC,SAAS;IAAoB;MAC5B,QAAQ,eAAe;;;;;;;;;;;;;;EAe1B,IAAiB,GACf,UAAU,oBAAoB,QAAQ,IACtC,UAAU;IAAoB;MAC7B,QAAQ"}

package/dist/base-policy.js

@@ -0,0 +1,2 @@
+import { t as BaseRetryPolicy } from "./base-policy-Dn3TOJd3.js";
+export { BaseRetryPolicy };