@spoosh/plugin-retry 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Spoosh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# @spoosh/plugin-retry
+
+Automatic retry plugin for Spoosh with configurable attempts and delay.
+
+**[Documentation](https://spoosh.dev/docs/plugins/retry)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-retry
+```
+
+## Usage
+
+```typescript
+import { retryPlugin } from "@spoosh/plugin-retry";
+
+const plugins = [
+  retryPlugin({ retries: 3, retryDelay: 1000 }), // 3 retries with 1 second delay
+];
+
+// Per-query override
+useRead((api) => api.posts.$get(), { retries: 5, retryDelay: 2000 });
+
+// Disable retries for a specific request
+useRead((api) => api.posts.$get(), { retries: false });
+```
+
+## Options
+
+### Plugin Config
+
+| Option       | Type              | Default | Description                                                  |
+| ------------ | ----------------- | ------- | ------------------------------------------------------------ |
+| `retries`    | `number \| false` | `3`     | Number of retry attempts. Set to `false` to disable retries. |
+| `retryDelay` | `number`          | `1000`  | Delay between retries in milliseconds                        |
+
+### Per-Request Options
+
+| Option       | Type              | Description                              |
+| ------------ | ----------------- | ---------------------------------------- |
+| `retries`    | `number \| false` | Override retry attempts for this request |
+| `retryDelay` | `number`          | Override retry delay for this request    |

package/dist/index.d.mts

@@ -0,0 +1,53 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface RetryPluginConfig {
+    /** Number of retry attempts. Set to `false` to disable retries. Defaults to 3. */
+    retries?: number | false;
+    /** Delay between retries in milliseconds. Defaults to 1000. */
+    retryDelay?: number;
+}
+interface RetryReadOptions {
+    /** Number of retry attempts. Set to `false` to disable retries. Overrides plugin default. */
+    retries?: number | false;
+    /** Delay between retries in milliseconds. Overrides plugin default. */
+    retryDelay?: number;
+}
+interface RetryWriteOptions {
+    /** Number of retry attempts. Set to `false` to disable retries. Overrides plugin default. */
+    retries?: number | false;
+    /** Delay between retries in milliseconds. Overrides plugin default. */
+    retryDelay?: number;
+}
+type RetryInfiniteReadOptions = RetryReadOptions;
+type RetryReadResult = object;
+type RetryWriteResult = object;
+
+/**
+ * Enables automatic retry for failed requests.
+ *
+ * Retries failed requests with configurable attempt count and delay.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/retry | Retry Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [retryPlugin({ retries: 3, retryDelay: 1000 })];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   retries: 5,
+ *   retryDelay: 2000,
+ * });
+ * ```
+ */
+declare function retryPlugin(config?: RetryPluginConfig): SpooshPlugin<{
+    readOptions: RetryReadOptions;
+    writeOptions: RetryWriteOptions;
+    infiniteReadOptions: RetryInfiniteReadOptions;
+    readResult: RetryReadResult;
+    writeResult: RetryWriteResult;
+}>;
+
+export { type RetryInfiniteReadOptions, type RetryPluginConfig, type RetryReadOptions, type RetryReadResult, type RetryWriteOptions, type RetryWriteResult, retryPlugin };

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface RetryPluginConfig {
+    /** Number of retry attempts. Set to `false` to disable retries. Defaults to 3. */
+    retries?: number | false;
+    /** Delay between retries in milliseconds. Defaults to 1000. */
+    retryDelay?: number;
+}
+interface RetryReadOptions {
+    /** Number of retry attempts. Set to `false` to disable retries. Overrides plugin default. */
+    retries?: number | false;
+    /** Delay between retries in milliseconds. Overrides plugin default. */
+    retryDelay?: number;
+}
+interface RetryWriteOptions {
+    /** Number of retry attempts. Set to `false` to disable retries. Overrides plugin default. */
+    retries?: number | false;
+    /** Delay between retries in milliseconds. Overrides plugin default. */
+    retryDelay?: number;
+}
+type RetryInfiniteReadOptions = RetryReadOptions;
+type RetryReadResult = object;
+type RetryWriteResult = object;
+
+/**
+ * Enables automatic retry for failed requests.
+ *
+ * Retries failed requests with configurable attempt count and delay.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/retry | Retry Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [retryPlugin({ retries: 3, retryDelay: 1000 })];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   retries: 5,
+ *   retryDelay: 2000,
+ * });
+ * ```
+ */
+declare function retryPlugin(config?: RetryPluginConfig): SpooshPlugin<{
+    readOptions: RetryReadOptions;
+    writeOptions: RetryWriteOptions;
+    infiniteReadOptions: RetryInfiniteReadOptions;
+    readResult: RetryReadResult;
+    writeResult: RetryWriteResult;
+}>;
+
+export { type RetryInfiniteReadOptions, type RetryPluginConfig, type RetryReadOptions, type RetryReadResult, type RetryWriteOptions, type RetryWriteResult, retryPlugin };

package/dist/index.js

@@ -0,0 +1,45 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  retryPlugin: () => retryPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function retryPlugin(config = {}) {
+  const { retries: defaultRetries = 3, retryDelay: defaultRetryDelay = 1e3 } = config;
+  return {
+    name: "spoosh:retry",
+    operations: ["read", "write", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      const retries = pluginOptions?.retries ?? defaultRetries;
+      const retryDelay = pluginOptions?.retryDelay ?? defaultRetryDelay;
+      context.requestOptions = {
+        ...context.requestOptions,
+        retries,
+        retryDelay
+      };
+      return next();
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,22 @@
+// src/plugin.ts
+function retryPlugin(config = {}) {
+  const { retries: defaultRetries = 3, retryDelay: defaultRetryDelay = 1e3 } = config;
+  return {
+    name: "spoosh:retry",
+    operations: ["read", "write", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      const retries = pluginOptions?.retries ?? defaultRetries;
+      const retryDelay = pluginOptions?.retryDelay ?? defaultRetryDelay;
+      context.requestOptions = {
+        ...context.requestOptions,
+        retries,
+        retryDelay
+      };
+      return next();
+    }
+  };
+}
+export {
+  retryPlugin
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@spoosh/plugin-retry",
+  "version": "0.1.0-beta.0",
+  "description": "Automatic retry plugin for Spoosh with configurable attempts and delay",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-retry"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/retry",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "retry",
+    "resilience",
+    "api-client"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@spoosh/core": ">=0.1.0"
+  },
+  "devDependencies": {
+    "@spoosh/core": "0.1.0-beta.0",
+    "@spoosh/test-utils": "0.1.0-beta.0"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --max-warnings 0",
+    "format": "prettier --write 'src/**/*.ts'"
+  }
+}