@spoosh/plugin-deduplication 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,48 @@
+# @spoosh/plugin-deduplication
+
+Request deduplication plugin for Spoosh - prevents duplicate in-flight requests.
+
+**[Documentation](https://spoosh.dev/docs/plugins/deduplication)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-deduplication
+```
+
+## Usage
+
+```typescript
+import { deduplicationPlugin } from "@spoosh/plugin-deduplication";
+
+// Default: dedupe reads, not writes
+const plugins = [deduplicationPlugin()];
+
+// Enable deduplication for writes too
+// Extreme caution: may cause unintended side effects
+// **Avoid using it unless you fully understand the implications**
+const plugins = [deduplicationPlugin({ write: "in-flight" })];
+
+// Per-request override
+useRead((api) => api.posts.$get(), { dedupe: false });
+```
+
+## Options
+
+### Plugin Config
+
+| Option  | Type                   | Default       | Description                   |
+| ------- | ---------------------- | ------------- | ----------------------------- |
+| `read`  | `"in-flight" \| false` | `"in-flight"` | Deduplication mode for reads  |
+| `write` | `"in-flight" \| false` | `false`       | Deduplication mode for writes |
+
+### Per-Request Options
+
+| Option   | Type                   | Description                             |
+| -------- | ---------------------- | --------------------------------------- |
+| `dedupe` | `"in-flight" \| false` | Override deduplication for this request |
+
+### Modes
+
+- `"in-flight"` - Reuse existing in-flight request promise if one exists
+- `false` - Always make a new request

package/dist/index.d.mts

@@ -0,0 +1,63 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+type DedupeMode = "in-flight" | false;
+type DeduplicationConfig = {
+    /** Deduplication mode for read operations. @default "in-flight" */
+    read?: DedupeMode;
+    /** Deduplication mode for write operations. @default false */
+    write?: DedupeMode;
+};
+type DeduplicationReadOptions = {
+    /** Override deduplication for this request. */
+    dedupe?: DedupeMode;
+};
+type DeduplicationWriteOptions = {
+    /** Override deduplication for this request. */
+    dedupe?: DedupeMode;
+};
+type DeduplicationInfiniteReadOptions = {
+    /** Override deduplication for this request. */
+    dedupe?: DedupeMode;
+};
+type DeduplicationReadResult = object;
+type DeduplicationWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginExportsRegistry {
+        "spoosh:deduplication": {
+            getConfig: () => {
+                read: DedupeMode;
+                write: DedupeMode;
+            };
+        };
+    }
+}
+
+/**
+ * Prevents duplicate in-flight requests for the same query.
+ *
+ * When multiple components request the same data simultaneously,
+ * only one network request is made and all callers share the result.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/deduplication | Deduplication Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [deduplicationPlugin({ read: "in-flight" })];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   dedupe: false, // Disable deduplication for this query
+ * });
+ * ```
+ */
+declare function deduplicationPlugin(config?: DeduplicationConfig): SpooshPlugin<{
+    readOptions: DeduplicationReadOptions;
+    writeOptions: DeduplicationWriteOptions;
+    infiniteReadOptions: DeduplicationInfiniteReadOptions;
+    readResult: DeduplicationReadResult;
+    writeResult: DeduplicationWriteResult;
+}>;
+
+export { type DedupeMode, type DeduplicationConfig, type DeduplicationInfiniteReadOptions, type DeduplicationReadOptions, type DeduplicationReadResult, type DeduplicationWriteOptions, type DeduplicationWriteResult, deduplicationPlugin };

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+type DedupeMode = "in-flight" | false;
+type DeduplicationConfig = {
+    /** Deduplication mode for read operations. @default "in-flight" */
+    read?: DedupeMode;
+    /** Deduplication mode for write operations. @default false */
+    write?: DedupeMode;
+};
+type DeduplicationReadOptions = {
+    /** Override deduplication for this request. */
+    dedupe?: DedupeMode;
+};
+type DeduplicationWriteOptions = {
+    /** Override deduplication for this request. */
+    dedupe?: DedupeMode;
+};
+type DeduplicationInfiniteReadOptions = {
+    /** Override deduplication for this request. */
+    dedupe?: DedupeMode;
+};
+type DeduplicationReadResult = object;
+type DeduplicationWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginExportsRegistry {
+        "spoosh:deduplication": {
+            getConfig: () => {
+                read: DedupeMode;
+                write: DedupeMode;
+            };
+        };
+    }
+}
+
+/**
+ * Prevents duplicate in-flight requests for the same query.
+ *
+ * When multiple components request the same data simultaneously,
+ * only one network request is made and all callers share the result.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/deduplication | Deduplication Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [deduplicationPlugin({ read: "in-flight" })];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   dedupe: false, // Disable deduplication for this query
+ * });
+ * ```
+ */
+declare function deduplicationPlugin(config?: DeduplicationConfig): SpooshPlugin<{
+    readOptions: DeduplicationReadOptions;
+    writeOptions: DeduplicationWriteOptions;
+    infiniteReadOptions: DeduplicationInfiniteReadOptions;
+    readResult: DeduplicationReadResult;
+    writeResult: DeduplicationWriteResult;
+}>;
+
+export { type DedupeMode, type DeduplicationConfig, type DeduplicationInfiniteReadOptions, type DeduplicationReadOptions, type DeduplicationReadResult, type DeduplicationWriteOptions, type DeduplicationWriteResult, deduplicationPlugin };

package/dist/index.js

@@ -0,0 +1,54 @@
+"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, {
+  deduplicationPlugin: () => deduplicationPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function deduplicationPlugin(config) {
+  const resolvedConfig = {
+    read: config?.read ?? "in-flight",
+    write: config?.write ?? false
+  };
+  return {
+    name: "spoosh:deduplication",
+    operations: ["read", "infiniteRead", "write"],
+    middleware: async (context, next) => {
+      const defaultMode = context.operationType === "write" ? resolvedConfig.write : resolvedConfig.read;
+      const requestOverride = context.pluginOptions?.dedupe;
+      const dedupeMode = requestOverride ?? defaultMode;
+      if (dedupeMode === "in-flight") {
+        const existingPromise = context.stateManager.getPendingPromise(
+          context.queryKey
+        );
+        if (existingPromise) {
+          return existingPromise;
+        }
+      }
+      return next();
+    },
+    exports: () => ({
+      getConfig: () => resolvedConfig
+    })
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,31 @@
+// src/plugin.ts
+function deduplicationPlugin(config) {
+  const resolvedConfig = {
+    read: config?.read ?? "in-flight",
+    write: config?.write ?? false
+  };
+  return {
+    name: "spoosh:deduplication",
+    operations: ["read", "infiniteRead", "write"],
+    middleware: async (context, next) => {
+      const defaultMode = context.operationType === "write" ? resolvedConfig.write : resolvedConfig.read;
+      const requestOverride = context.pluginOptions?.dedupe;
+      const dedupeMode = requestOverride ?? defaultMode;
+      if (dedupeMode === "in-flight") {
+        const existingPromise = context.stateManager.getPendingPromise(
+          context.queryKey
+        );
+        if (existingPromise) {
+          return existingPromise;
+        }
+      }
+      return next();
+    },
+    exports: () => ({
+      getConfig: () => resolvedConfig
+    })
+  };
+}
+export {
+  deduplicationPlugin
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@spoosh/plugin-deduplication",
+  "version": "0.1.0-beta.0",
+  "description": "Request deduplication plugin for Spoosh - prevents duplicate in-flight requests",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-deduplication"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/deduplication",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "deduplication",
+    "api-client",
+    "dedupe"
+  ],
+  "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'"
+  }
+}