@zap-studio/retry 0.2.0 → 0.3.0

package/dist/types.d.mts

@@ -1,4 +1,4 @@
-import { t as RetryError } from "./error-CVW4I654.mjs";
+import { r as RetryError, t as AbortError } from "./errors-fWo_KyVO.mjs";
 
 //#region src/types.d.ts
 /**
@@ -28,25 +28,59 @@ interface RetryPolicy<TError = unknown, TData = unknown> {
 * Decision returned by a retry policy for a specific attempt.
 */
 interface RetryDecision {
+  /**
+  * When `true`, the runner may schedule another attempt (subject to
+  * `delayMs` and the runner's abort rules).
+  */
   readonly shouldRetry: boolean;
+  /**
+  * Milliseconds to wait before the next attempt when `shouldRetry` is `true`.
+  */
   readonly delayMs: number;
+  /**
+  * Optional machine-readable reason for the decision.
+  */
   readonly reason?: "retry" | "max-attempts-reached" | "policy-declined";
 }
 /**
 * Input passed to `RetryPolicy.next(...)` for each failed attempt.
 */
 interface RetryDecisionInput<TError = unknown, TData = unknown> {
+  /**
+  * One-based attempt number for the current failure.
+  */
   readonly attempt: number;
+  /**
+  * Optional policy-level maximum attempts, when a policy wants to pass it
+  * through to `next`.
+  */
   readonly maxAttempts?: number;
+  /**
+  * Error raised by the most recent `execute(attempt)` call, when a failure
+  * occurred.
+  */
   readonly error?: TError;
+  /**
+  * Optional data captured alongside the failure, when a policy populates
+  * it.
+  */
   readonly data?: TData;
 }
 /**
 * Input passed to `RetryPolicy.onExhausted(...)` when retries stop.
 */
 interface RetryExhaustedInput<TError = unknown, TData = unknown> {
+  /**
+  * Count of completed attempts that led to stopping retries.
+  */
   readonly attempts: number;
+  /**
+  * Last execution error, when available.
+  */
   readonly error?: TError;
+  /**
+  * Last captured data, when a policy or runner supplies it.
+  */
   readonly data?: TData;
 }
 /**
@@ -70,19 +104,40 @@ interface RetryRunOptions {
   *
   * When `false`, the runner returns a `RetryRunResult` discriminated union.
   *
-  * @default false
+  * @default true
   */
   readonly throwOnExhausted?: boolean;
 }
 /**
 * Result union returned by non-throw runner mode.
+*
+* - Success: `ok: true` with the resolved `value`.
+* - Failure: `ok: false` with terminal `error` and completed `attempts` count
+*   (exhaustion or abort).
 */
 type RetryRunResult<T> = {
+  /**
+  * Discriminator for a successful run.
+  */
   ok: true;
+  /**
+  * Successful return value from the final attempt.
+  */
   value: T;
 } | {
+  /**
+  * Discriminator for a failed or aborted run.
+  */
   ok: false;
-  error: RetryError;
+  /**
+  * Terminal error: `RetryError` when retries are exhausted, or
+  * `AbortError` when the run is canceled (non-throw path uses the same
+  * instances as throw mode, not wrapped).
+  */
+  error: RetryError | AbortError;
+  /**
+  * Number of attempts that completed before the terminal outcome.
+  */
   attempts: number;
 };
 //#endregion

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;;;;;;;;UAiBiB,WAAA;;;;;;EAMf,IAAA,CAAK,KAAA,EAAO,kBAAA,CAAmB,MAAA,EAAQ,KAAA,IAAS,aAAA;;;;;;EAMhD,WAAA,CAAY,KAAA,EAAO,mBAAA,CAAoB,MAAA,EAAQ,KAAA,IAAS,UAAA;AAAA;AAM1D;;;AAAA,UAAiB,aAAA;EAAA,SACN,WAAA;EAAA,SACA,OAAA;EAAA,SACA,MAAA;AAAA;;AAMX;;UAAiB,kBAAA;EAAA,SACN,OAAA;EAAA,SACA,WAAA;EAAA,SACA,KAAA,GAAQ,MAAA;EAAA,SACR,IAAA,GAAO,KAAA;AAAA;;;;UAMD,mBAAA;EAAA,SACN,QAAA;EAAA,SACA,KAAA,GAAQ,MAAA;EAAA,SACR,IAAA,GAAO,KAAA;AAAA;;;;UAMD,eAAA;EANC;AAMlB;;;;EANkB,SAYP,KAAA,IAAS,OAAA,aAAoB,OAAA;;;;;;WAM7B,MAAA,GAAS,WAAA;EAQT;AAMX;;;;;;EANW,SAAA,gBAAA;AAAA;;;;KAMC,cAAA;EAEN,EAAA;EACA,KAAA,EAAO,CAAA;AAAA;EAGP,EAAA;EACA,KAAA,EAAO,UAAA;EACP,QAAA;AAAA"}
+{"version":3,"file":"types.d.mts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;;;;;;;;UAiBiB,WAAA;;;;;;EAMf,IAAA,CAAK,KAAA,EAAO,kBAAA,CAAmB,MAAA,EAAQ,KAAA,IAAS,aAAA;;;;;;EAMhD,WAAA,CAAY,KAAA,EAAO,mBAAA,CAAoB,MAAA,EAAQ,KAAA,IAAS,UAAA;AAAA;AAM1D;;;AAAA,UAAiB,aAAA;;;;;WAKN,WAAA;EAcX;;;EAAA,SAVW,OAAA;;;;WAIA,MAAA;AAAA;;;;UAMM,kBAAA;;;;WAIN,OAAA;;;;;WAKA,WAAA;;;AAkCX;;WA7BW,KAAA,GAAQ,MAAA;EAyCC;;;;EAAA,SApCT,IAAA,GAAO,KAAA;AAAA;;;;UAMD,mBAAA;;;;WAIN,QAAA;;;;WAIA,KAAA,GAAQ,MAAA;;;;WAIR,IAAA,GAAO,KAAA;AAAA;;;;UAMD,eAAA;;;;;;WAMN,KAAA,IAAS,OAAA,aAAoB,OAAA;;;;;;WAM7B,MAAA,GAAS,WAAA;;;;;;;;WAQT,gBAAA;AAAA;;;;;;;;KAUC,cAAA;;;;EAKN,EAAA;;;;EAIA,KAAA,EAAO,CAAA;AAAA;;;;EAMP,EAAA;;;;;;EAMA,KAAA,EAAO,UAAA,GAAa,UAAA;;;;EAIpB,QAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zap-studio/retry",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "private": false,
   "description": "Composable retry policies for resilient async operations.",
   "keywords": [
@@ -30,9 +30,13 @@
   "types": "./dist/index.d.mts",
   "exports": {
     ".": "./dist/index.mjs",
-    "./error": "./dist/error.mjs",
+    "./abort": "./dist/abort.mjs",
+    "./errors": "./dist/errors.mjs",
     "./exponential-backoff": "./dist/exponential-backoff.mjs",
     "./fixed-delay": "./dist/fixed-delay.mjs",
+    "./result-mode": "./dist/result-mode.mjs",
+    "./sleep": "./dist/sleep.mjs",
+    "./throw-mode": "./dist/throw-mode.mjs",
     "./types": "./dist/types.mjs",
     "./package.json": "./package.json"
   },

package/dist/error-CVW4I654.d.mts

@@ -1,44 +0,0 @@
-//#region src/error.d.ts
-/**
-* Terminal error types used by retry policies and runners.
-*
-* @module @zap-studio/retry/error
-*/
-/**
-* Context payload attached to `RetryError`.
-*/
-interface RetryErrorContext {
-  readonly attempts: number;
-  readonly lastError?: unknown;
-  readonly lastData?: unknown;
-}
-/**
-* Error thrown when retries are exhausted.
-*
-* @example
-* throw new RetryError("Retry exhausted", {
-*   attempts: 3,
-*   lastError: new Error("network"),
-* });
-*/
-declare class RetryError extends Error {
-  /**
-  * Total attempts performed before exhaustion.
-  */
-  readonly attempts: number;
-  /**
-  * Last captured error from execution.
-  */
-  readonly lastError?: unknown;
-  /**
-  * Last captured data value, when available.
-  */
-  readonly lastData?: unknown;
-  /**
-  * Creates a RetryError with structured terminal context.
-  */
-  constructor(message: string, context: RetryErrorContext);
-}
-//#endregion
-export { RetryErrorContext as n, RetryError as t };
-//# sourceMappingURL=error-CVW4I654.d.mts.map

package/dist/error-CVW4I654.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-CVW4I654.d.mts","names":[],"sources":["../src/error.ts"],"mappings":";;AASA;;;;;;;UAAiB,iBAAA;EAAA,SACN,QAAA;EAAA,SACA,SAAA;EAAA,SACA,QAAA;AAAA;;;;;;;;;;cAYE,UAAA,SAAmB,KAAA;EAiBQ;;;EAAA,SAbtB,QAAA;;;;WAIA,SAAA;;;;WAIA,QAAA;;;;EAKhB,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,iBAAA;AAAA"}

package/dist/error.d.mts

@@ -1,2 +0,0 @@
-import { n as RetryErrorContext, t as RetryError } from "./error-CVW4I654.mjs";
-export { RetryError, RetryErrorContext };

package/dist/error.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"error.mjs","names":[],"sources":["../src/error.ts"],"sourcesContent":["/**\n * Terminal error types used by retry policies and runners.\n *\n * @module @zap-studio/retry/error\n */\n\n/**\n * Context payload attached to `RetryError`.\n */\nexport interface RetryErrorContext {\n  readonly attempts: number;\n  readonly lastError?: unknown;\n  readonly lastData?: unknown;\n}\n\n/**\n * Error thrown when retries are exhausted.\n *\n * @example\n * throw new RetryError(\"Retry exhausted\", {\n *   attempts: 3,\n *   lastError: new Error(\"network\"),\n * });\n */\nexport class RetryError extends Error {\n  /**\n   * Total attempts performed before exhaustion.\n   */\n  public readonly attempts: number;\n  /**\n   * Last captured error from execution.\n   */\n  public readonly lastError?: unknown;\n  /**\n   * Last captured data value, when available.\n   */\n  public readonly lastData?: unknown;\n\n  /**\n   * Creates a RetryError with structured terminal context.\n   */\n  constructor(message: string, context: RetryErrorContext) {\n    super(message);\n    this.name = \"RetryError\";\n    this.attempts = context.attempts;\n    this.lastError = context.lastError;\n    this.lastData = context.lastData;\n  }\n}\n"],"mappings":";;;;;;;;;;AAwBA,IAAa,aAAb,cAAgC,MAAM;;;;CAIpC;;;;CAIA;;;;CAIA;;;;CAKA,YAAY,SAAiB,SAA4B;AACvD,QAAM,QAAQ;AACd,OAAK,OAAO;AACZ,OAAK,WAAW,QAAQ;AACxB,OAAK,YAAY,QAAQ;AACzB,OAAK,WAAW,QAAQ"}