@spoosh/plugin-optimistic 0.4.1 → 0.4.3

package/README.md

@@ -2,7 +2,7 @@
 
 Optimistic updates plugin for Spoosh - instant UI updates with automatic rollback on error.
 
-**[Documentation](https://spoosh.dev/docs/plugins/optimistic)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`, `@spoosh/plugin-invalidation`
+**[Documentation](https://spoosh.dev/docs/react/plugins/optimistic)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`, `@spoosh/plugin-invalidation`
 
 ## Installation
 

package/dist/index.d.mts

@@ -215,7 +215,6 @@ declare module "@spoosh/core" {
     }
 }
 
-declare const OPTIMISTIC_SNAPSHOTS_KEY = "optimistic:snapshots";
 /**
  * Enables optimistic updates for mutations.
  *
@@ -226,7 +225,7 @@ declare const OPTIMISTIC_SNAPSHOTS_KEY = "optimistic:snapshots";
  * unnecessary refetches that would override the optimistic data. You can override
  * this by explicitly setting the `invalidate` option with a mode string or array.
  *
- * @see {@link https://spoosh.dev/docs/plugins/optimistic | Optimistic Plugin Documentation}
+ * @see {@link https://spoosh.dev/docs/react/plugins/optimistic | Optimistic Plugin Documentation}
  *
  * @returns Optimistic plugin instance
  *
@@ -279,4 +278,4 @@ declare function optimisticPlugin(): SpooshPlugin<{
     writeResult: OptimisticWriteResult;
 }>;
 
-export { type AnyOptimisticTarget, OPTIMISTIC_SNAPSHOTS_KEY, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticInfiniteReadOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, optimisticPlugin };
+export { type AnyOptimisticTarget, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticInfiniteReadOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, optimisticPlugin };

package/dist/index.d.ts

@@ -215,7 +215,6 @@ declare module "@spoosh/core" {
     }
 }
 
-declare const OPTIMISTIC_SNAPSHOTS_KEY = "optimistic:snapshots";
 /**
  * Enables optimistic updates for mutations.
  *
@@ -226,7 +225,7 @@ declare const OPTIMISTIC_SNAPSHOTS_KEY = "optimistic:snapshots";
  * unnecessary refetches that would override the optimistic data. You can override
  * this by explicitly setting the `invalidate` option with a mode string or array.
  *
- * @see {@link https://spoosh.dev/docs/plugins/optimistic | Optimistic Plugin Documentation}
+ * @see {@link https://spoosh.dev/docs/react/plugins/optimistic | Optimistic Plugin Documentation}
  *
  * @returns Optimistic plugin instance
  *
@@ -279,4 +278,4 @@ declare function optimisticPlugin(): SpooshPlugin<{
     writeResult: OptimisticWriteResult;
 }>;
 
-export { type AnyOptimisticTarget, OPTIMISTIC_SNAPSHOTS_KEY, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticInfiniteReadOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, optimisticPlugin };
+export { type AnyOptimisticTarget, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticInfiniteReadOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, optimisticPlugin };

package/dist/index.js

@@ -20,7 +20,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  OPTIMISTIC_SNAPSHOTS_KEY: () => OPTIMISTIC_SNAPSHOTS_KEY,
   optimisticPlugin: () => optimisticPlugin
 });
 module.exports = __toCommonJS(src_exports);
@@ -28,7 +27,6 @@ module.exports = __toCommonJS(src_exports);
 // src/plugin.ts
 var import_core = require("@spoosh/core");
 var import_plugin_invalidation = require("@spoosh/plugin-invalidation");
-var OPTIMISTIC_SNAPSHOTS_KEY = "optimistic:snapshots";
 function createBuilder(state) {
   return {
     ...state,
@@ -167,22 +165,16 @@ function optimisticPlugin() {
       const immediateTargets = targets.filter((t) => t.timing !== "onSuccess");
       const allSnapshots = [];
       for (const target of immediateTargets) {
-        const snapshots2 = applyOptimisticUpdate(stateManager, target);
-        allSnapshots.push(...snapshots2);
-      }
-      if (allSnapshots.length > 0) {
-        context.metadata.set(OPTIMISTIC_SNAPSHOTS_KEY, allSnapshots);
+        const snapshots = applyOptimisticUpdate(stateManager, target);
+        allSnapshots.push(...snapshots);
       }
       const response = await next();
-      const snapshots = context.metadata.get(
-        OPTIMISTIC_SNAPSHOTS_KEY
-      ) ?? [];
       if (response.error) {
         const shouldRollback = targets.some(
           (t) => t.rollbackOnError && t.timing !== "onSuccess"
         );
-        if (shouldRollback && snapshots.length > 0) {
-          rollbackOptimistic(stateManager, snapshots);
+        if (shouldRollback && allSnapshots.length > 0) {
+          rollbackOptimistic(stateManager, allSnapshots);
         }
         for (const target of targets) {
           if (target.onError) {
@@ -190,8 +182,8 @@ function optimisticPlugin() {
           }
         }
       } else {
-        if (snapshots.length > 0) {
-          confirmOptimistic(stateManager, snapshots);
+        if (allSnapshots.length > 0) {
+          confirmOptimistic(stateManager, allSnapshots);
         }
         const onSuccessTargets = targets.filter(
           (t) => t.timing === "onSuccess"

package/dist/index.mjs

@@ -1,7 +1,6 @@
 // src/plugin.ts
 import { generateTags } from "@spoosh/core";
 import "@spoosh/plugin-invalidation";
-var OPTIMISTIC_SNAPSHOTS_KEY = "optimistic:snapshots";
 function createBuilder(state) {
   return {
     ...state,
@@ -140,22 +139,16 @@ function optimisticPlugin() {
       const immediateTargets = targets.filter((t) => t.timing !== "onSuccess");
       const allSnapshots = [];
       for (const target of immediateTargets) {
-        const snapshots2 = applyOptimisticUpdate(stateManager, target);
-        allSnapshots.push(...snapshots2);
-      }
-      if (allSnapshots.length > 0) {
-        context.metadata.set(OPTIMISTIC_SNAPSHOTS_KEY, allSnapshots);
+        const snapshots = applyOptimisticUpdate(stateManager, target);
+        allSnapshots.push(...snapshots);
       }
       const response = await next();
-      const snapshots = context.metadata.get(
-        OPTIMISTIC_SNAPSHOTS_KEY
-      ) ?? [];
       if (response.error) {
         const shouldRollback = targets.some(
           (t) => t.rollbackOnError && t.timing !== "onSuccess"
         );
-        if (shouldRollback && snapshots.length > 0) {
-          rollbackOptimistic(stateManager, snapshots);
+        if (shouldRollback && allSnapshots.length > 0) {
+          rollbackOptimistic(stateManager, allSnapshots);
         }
         for (const target of targets) {
           if (target.onError) {
@@ -163,8 +156,8 @@ function optimisticPlugin() {
           }
         }
       } else {
-        if (snapshots.length > 0) {
-          confirmOptimistic(stateManager, snapshots);
+        if (allSnapshots.length > 0) {
+          confirmOptimistic(stateManager, allSnapshots);
         }
         const onSuccessTargets = targets.filter(
           (t) => t.timing === "onSuccess"
@@ -205,6 +198,5 @@ function optimisticPlugin() {
   };
 }
 export {
-  OPTIMISTIC_SNAPSHOTS_KEY,
   optimisticPlugin
 };

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@spoosh/plugin-optimistic",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Optimistic updates plugin for Spoosh - instant UI updates with automatic rollback",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nxnom/spoosh.git",
+    "url": "git+https://github.com/spooshdev/spoosh.git",
     "directory": "packages/plugin-optimistic"
   },
   "bugs": {
-    "url": "https://github.com/nxnom/spoosh/issues"
+    "url": "https://github.com/spooshdev/spoosh/issues"
   },
-  "homepage": "https://spoosh.dev/react/docs/plugins/optimistic",
+  "homepage": "https://spoosh.dev/docs/react/plugins/optimistic",
   "publishConfig": {
     "access": "public"
   },
@@ -33,13 +33,13 @@
     }
   },
   "peerDependencies": {
-    "@spoosh/core": ">=0.9.0",
+    "@spoosh/core": ">=0.11.1",
     "@spoosh/plugin-invalidation": ">=0.4.0"
   },
   "devDependencies": {
-    "@spoosh/core": "0.9.0",
-    "@spoosh/test-utils": "0.1.5",
-    "@spoosh/plugin-invalidation": "0.5.0"
+    "@spoosh/core": "0.11.1",
+    "@spoosh/test-utils": "0.1.6",
+    "@spoosh/plugin-invalidation": "0.5.6"
   },
   "scripts": {
     "dev": "tsup --watch",