@spoosh/plugin-optimistic 0.8.0 → 0.8.2

package/dist/index.js

@@ -32,54 +32,28 @@ var import_plugin_invalidation = require("@spoosh/plugin-invalidation");
 function isParameterSegment(segment) {
   return segment.startsWith(":");
 }
-function hasPatternParams(path) {
-  return path.split("/").some(isParameterSegment);
-}
-function pathMatchesPattern(actualPath, pattern) {
-  const actualSegments = actualPath.split("/").filter(Boolean);
+function pathMatchesPattern(resolvedPath, pattern) {
+  const resolvedSegments = resolvedPath.split("/").filter(Boolean);
   const patternSegments = pattern.split("/").filter(Boolean);
-  if (actualSegments.length !== patternSegments.length) {
-    return { matches: false, params: {}, paramMapping: {} };
+  if (resolvedSegments.length !== patternSegments.length) {
+    return { matches: false, params: {} };
   }
   const params = {};
-  const paramMapping = {};
   for (let i = 0; i < patternSegments.length; i++) {
     const patternSeg = patternSegments[i];
-    const actualSeg = actualSegments[i];
+    const resolvedSeg = resolvedSegments[i];
     if (isParameterSegment(patternSeg)) {
-      const targetParamName = patternSeg.slice(1);
-      if (isParameterSegment(actualSeg)) {
-        const actualParamName = actualSeg.slice(1);
-        paramMapping[targetParamName] = actualParamName;
-        continue;
-      }
-      params[targetParamName] = actualSeg;
-    } else if (isParameterSegment(actualSeg)) {
-      continue;
-    } else if (patternSeg !== actualSeg) {
-      return { matches: false, params: {}, paramMapping: {} };
+      const paramName = patternSeg.slice(1);
+      params[paramName] = resolvedSeg;
+    } else if (patternSeg !== resolvedSeg) {
+      return { matches: false, params: {} };
     }
   }
-  return { matches: true, params, paramMapping };
+  return { matches: true, params };
 }
 
 // src/utils/cache-key.ts
 var import_core = require("@spoosh/core");
-function extractPathFromKey(key) {
-  try {
-    const parsed = JSON.parse(key);
-    const path = parsed.path;
-    if (typeof path === "string") {
-      return path;
-    }
-    if (Array.isArray(path)) {
-      return path.join("/");
-    }
-    return null;
-  } catch {
-    return null;
-  }
-}
 function formatCacheKeyForTrace(key) {
   const resolvedPath = (0, import_core.generateSelfTagFromKey)(key);
   if (!resolvedPath) return "unknown";
@@ -122,26 +96,16 @@ function extractOptionsFromKey(key) {
     return null;
   }
 }
-function mapParamsToTargetNames(actualParams, paramMapping) {
-  if (!actualParams) return {};
-  const result = {};
-  for (const [targetName, actualName] of Object.entries(paramMapping)) {
-    if (actualName in actualParams) {
-      result[targetName] = String(actualParams[actualName]);
-    }
-  }
-  for (const [key, value] of Object.entries(actualParams)) {
-    if (!Object.values(paramMapping).includes(key)) {
-      result[key] = String(value);
-    }
-  }
-  return result;
-}
+
+// src/plugin.ts
+var import_core3 = require("@spoosh/core");
 
 // src/builder/index.ts
 function createBuilder(state, isConfirmed = false) {
   return {
     ...state,
+    // Expose the internal state so the plugin can access predicates
+    __state: state,
     filter(predicate) {
       return createBuilder({ ...state, filter: predicate }, isConfirmed);
     },
@@ -193,27 +157,13 @@ function resolveOptimisticTargets(context) {
 function getMatchingEntries(stateManager, targetPath) {
   const results = [];
   const allEntries = stateManager.getAllCacheEntries();
-  if (hasPatternParams(targetPath)) {
-    for (const { key, entry } of allEntries) {
-      if (!key.includes(`"method":"GET"`)) continue;
-      const actualPath = extractPathFromKey(key);
-      if (!actualPath) continue;
-      const { matches, params, paramMapping } = pathMatchesPattern(
-        actualPath,
-        targetPath
-      );
-      if (matches) {
-        results.push({ key, entry, extractedParams: params, paramMapping });
-      }
-    }
-  } else {
-    for (const { key, entry } of allEntries) {
-      if (!key.includes(`"method":"GET"`)) continue;
-      const actualPath = extractPathFromKey(key);
-      if (!actualPath) continue;
-      if (actualPath === targetPath) {
-        results.push({ key, entry, extractedParams: {}, paramMapping: {} });
-      }
+  for (const { key, entry } of allEntries) {
+    if (!key.includes(`"method":"GET"`)) continue;
+    const resolvedPath = (0, import_core3.generateSelfTagFromKey)(key);
+    if (!resolvedPath) continue;
+    const { matches, params } = pathMatchesPattern(resolvedPath, targetPath);
+    if (matches) {
+      results.push({ key, entry, extractedParams: params });
     }
   }
   return results;
@@ -222,28 +172,22 @@ function applyUpdate(stateManager, target, updater, response, t) {
   const snapshots = [];
   const matchingEntries = getMatchingEntries(stateManager, target.path);
   if (matchingEntries.length === 0) {
-    t?.skip(`Skipped ${target.path} (no cache entry)`);
     return [];
   }
-  for (const { key, entry, extractedParams, paramMapping } of matchingEntries) {
-    if (target.filter) {
+  for (const { key, entry, extractedParams } of matchingEntries) {
+    const targetWithState = target;
+    const filterPredicate = targetWithState.__state ? targetWithState.__state.filter : target.filter;
+    if (filterPredicate) {
       const options = extractOptionsFromKey(key) ?? {};
-      const mappedParams = mapParamsToTargetNames(
-        options.params,
-        paramMapping
-      );
       const mergedOptions = {
         ...options,
         params: {
-          ...extractedParams,
-          ...mappedParams
+          ...options.params,
+          ...extractedParams
         }
       };
       try {
-        if (!target.filter(mergedOptions)) {
-          t?.skip(
-            `Skipped ${formatCacheKeyForTrace(key)} (filter not matched)`
-          );
+        if (!filterPredicate(mergedOptions)) {
           continue;
         }
       } catch {
@@ -252,7 +196,6 @@ function applyUpdate(stateManager, target, updater, response, t) {
       }
     }
     if (entry?.state.data === void 0) {
-      t?.skip(`Skipped ${formatCacheKeyForTrace(key)} (no cached data)`);
       continue;
     }
     const afterData = updater(entry.state.data, response);
@@ -315,11 +258,13 @@ function optimisticPlugin() {
       context.plugins.get("spoosh:invalidation")?.setDefaultMode("none");
       const allImmediateSnapshots = [];
       for (const target of targets) {
-        if (!target.immediateUpdater) continue;
+        const targetWithState = target;
+        const immediateUpdater = targetWithState.__state ? targetWithState.__state.immediateUpdater : target.immediateUpdater;
+        if (!immediateUpdater) continue;
         const snapshots = applyUpdate(
           stateManager,
           target,
-          target.immediateUpdater,
+          immediateUpdater,
           void 0,
           t
         );
@@ -333,9 +278,12 @@ function optimisticPlugin() {
       }
       const response = await next();
       if (response.error) {
-        const shouldRollback = targets.some(
-          (target) => target.rollbackOnError && target.immediateUpdater
-        );
+        const shouldRollback = targets.some((target) => {
+          const targetWithState = target;
+          const rollbackOnError = targetWithState.__state ? targetWithState.__state.rollbackOnError : target.rollbackOnError;
+          const immediateUpdater = targetWithState.__state ? targetWithState.__state.immediateUpdater : target.immediateUpdater;
+          return rollbackOnError && immediateUpdater;
+        });
         if (shouldRollback && allImmediateSnapshots.length > 0) {
           rollbackOptimistic(stateManager, allImmediateSnapshots);
           for (const snapshot of allImmediateSnapshots) {
@@ -346,8 +294,10 @@ function optimisticPlugin() {
           }
         }
         for (const target of targets) {
-          if (target.onError) {
-            target.onError(response.error);
+          const targetWithState = target;
+          const onError = targetWithState.__state ? targetWithState.__state.onError : target.onError;
+          if (onError) {
+            onError(response.error);
           }
         }
       } else {
@@ -355,11 +305,13 @@ function optimisticPlugin() {
           confirmOptimistic(stateManager, allImmediateSnapshots);
         }
         for (const target of targets) {
-          if (!target.confirmedUpdater) continue;
+          const targetWithState = target;
+          const confirmedUpdater = targetWithState.__state ? targetWithState.__state.confirmedUpdater : target.confirmedUpdater;
+          if (!confirmedUpdater) continue;
           const snapshots = applyUpdate(
             stateManager,
             target,
-            target.confirmedUpdater,
+            confirmedUpdater,
             response.data,
             t
           );

package/dist/index.mjs

@@ -8,54 +8,28 @@ import "@spoosh/plugin-invalidation";
 function isParameterSegment(segment) {
   return segment.startsWith(":");
 }
-function hasPatternParams(path) {
-  return path.split("/").some(isParameterSegment);
-}
-function pathMatchesPattern(actualPath, pattern) {
-  const actualSegments = actualPath.split("/").filter(Boolean);
+function pathMatchesPattern(resolvedPath, pattern) {
+  const resolvedSegments = resolvedPath.split("/").filter(Boolean);
   const patternSegments = pattern.split("/").filter(Boolean);
-  if (actualSegments.length !== patternSegments.length) {
-    return { matches: false, params: {}, paramMapping: {} };
+  if (resolvedSegments.length !== patternSegments.length) {
+    return { matches: false, params: {} };
   }
   const params = {};
-  const paramMapping = {};
   for (let i = 0; i < patternSegments.length; i++) {
     const patternSeg = patternSegments[i];
-    const actualSeg = actualSegments[i];
+    const resolvedSeg = resolvedSegments[i];
     if (isParameterSegment(patternSeg)) {
-      const targetParamName = patternSeg.slice(1);
-      if (isParameterSegment(actualSeg)) {
-        const actualParamName = actualSeg.slice(1);
-        paramMapping[targetParamName] = actualParamName;
-        continue;
-      }
-      params[targetParamName] = actualSeg;
-    } else if (isParameterSegment(actualSeg)) {
-      continue;
-    } else if (patternSeg !== actualSeg) {
-      return { matches: false, params: {}, paramMapping: {} };
+      const paramName = patternSeg.slice(1);
+      params[paramName] = resolvedSeg;
+    } else if (patternSeg !== resolvedSeg) {
+      return { matches: false, params: {} };
     }
   }
-  return { matches: true, params, paramMapping };
+  return { matches: true, params };
 }
 
 // src/utils/cache-key.ts
 import { generateSelfTagFromKey } from "@spoosh/core";
-function extractPathFromKey(key) {
-  try {
-    const parsed = JSON.parse(key);
-    const path = parsed.path;
-    if (typeof path === "string") {
-      return path;
-    }
-    if (Array.isArray(path)) {
-      return path.join("/");
-    }
-    return null;
-  } catch {
-    return null;
-  }
-}
 function formatCacheKeyForTrace(key) {
   const resolvedPath = generateSelfTagFromKey(key);
   if (!resolvedPath) return "unknown";
@@ -98,26 +72,16 @@ function extractOptionsFromKey(key) {
     return null;
   }
 }
-function mapParamsToTargetNames(actualParams, paramMapping) {
-  if (!actualParams) return {};
-  const result = {};
-  for (const [targetName, actualName] of Object.entries(paramMapping)) {
-    if (actualName in actualParams) {
-      result[targetName] = String(actualParams[actualName]);
-    }
-  }
-  for (const [key, value] of Object.entries(actualParams)) {
-    if (!Object.values(paramMapping).includes(key)) {
-      result[key] = String(value);
-    }
-  }
-  return result;
-}
+
+// src/plugin.ts
+import { generateSelfTagFromKey as generateSelfTagFromKey2 } from "@spoosh/core";
 
 // src/builder/index.ts
 function createBuilder(state, isConfirmed = false) {
   return {
     ...state,
+    // Expose the internal state so the plugin can access predicates
+    __state: state,
     filter(predicate) {
       return createBuilder({ ...state, filter: predicate }, isConfirmed);
     },
@@ -169,27 +133,13 @@ function resolveOptimisticTargets(context) {
 function getMatchingEntries(stateManager, targetPath) {
   const results = [];
   const allEntries = stateManager.getAllCacheEntries();
-  if (hasPatternParams(targetPath)) {
-    for (const { key, entry } of allEntries) {
-      if (!key.includes(`"method":"GET"`)) continue;
-      const actualPath = extractPathFromKey(key);
-      if (!actualPath) continue;
-      const { matches, params, paramMapping } = pathMatchesPattern(
-        actualPath,
-        targetPath
-      );
-      if (matches) {
-        results.push({ key, entry, extractedParams: params, paramMapping });
-      }
-    }
-  } else {
-    for (const { key, entry } of allEntries) {
-      if (!key.includes(`"method":"GET"`)) continue;
-      const actualPath = extractPathFromKey(key);
-      if (!actualPath) continue;
-      if (actualPath === targetPath) {
-        results.push({ key, entry, extractedParams: {}, paramMapping: {} });
-      }
+  for (const { key, entry } of allEntries) {
+    if (!key.includes(`"method":"GET"`)) continue;
+    const resolvedPath = generateSelfTagFromKey2(key);
+    if (!resolvedPath) continue;
+    const { matches, params } = pathMatchesPattern(resolvedPath, targetPath);
+    if (matches) {
+      results.push({ key, entry, extractedParams: params });
     }
   }
   return results;
@@ -198,28 +148,22 @@ function applyUpdate(stateManager, target, updater, response, t) {
   const snapshots = [];
   const matchingEntries = getMatchingEntries(stateManager, target.path);
   if (matchingEntries.length === 0) {
-    t?.skip(`Skipped ${target.path} (no cache entry)`);
     return [];
   }
-  for (const { key, entry, extractedParams, paramMapping } of matchingEntries) {
-    if (target.filter) {
+  for (const { key, entry, extractedParams } of matchingEntries) {
+    const targetWithState = target;
+    const filterPredicate = targetWithState.__state ? targetWithState.__state.filter : target.filter;
+    if (filterPredicate) {
       const options = extractOptionsFromKey(key) ?? {};
-      const mappedParams = mapParamsToTargetNames(
-        options.params,
-        paramMapping
-      );
       const mergedOptions = {
         ...options,
         params: {
-          ...extractedParams,
-          ...mappedParams
+          ...options.params,
+          ...extractedParams
         }
       };
       try {
-        if (!target.filter(mergedOptions)) {
-          t?.skip(
-            `Skipped ${formatCacheKeyForTrace(key)} (filter not matched)`
-          );
+        if (!filterPredicate(mergedOptions)) {
           continue;
         }
       } catch {
@@ -228,7 +172,6 @@ function applyUpdate(stateManager, target, updater, response, t) {
       }
     }
     if (entry?.state.data === void 0) {
-      t?.skip(`Skipped ${formatCacheKeyForTrace(key)} (no cached data)`);
       continue;
     }
     const afterData = updater(entry.state.data, response);
@@ -291,11 +234,13 @@ function optimisticPlugin() {
       context.plugins.get("spoosh:invalidation")?.setDefaultMode("none");
       const allImmediateSnapshots = [];
       for (const target of targets) {
-        if (!target.immediateUpdater) continue;
+        const targetWithState = target;
+        const immediateUpdater = targetWithState.__state ? targetWithState.__state.immediateUpdater : target.immediateUpdater;
+        if (!immediateUpdater) continue;
         const snapshots = applyUpdate(
           stateManager,
           target,
-          target.immediateUpdater,
+          immediateUpdater,
           void 0,
           t
         );
@@ -309,9 +254,12 @@ function optimisticPlugin() {
       }
       const response = await next();
       if (response.error) {
-        const shouldRollback = targets.some(
-          (target) => target.rollbackOnError && target.immediateUpdater
-        );
+        const shouldRollback = targets.some((target) => {
+          const targetWithState = target;
+          const rollbackOnError = targetWithState.__state ? targetWithState.__state.rollbackOnError : target.rollbackOnError;
+          const immediateUpdater = targetWithState.__state ? targetWithState.__state.immediateUpdater : target.immediateUpdater;
+          return rollbackOnError && immediateUpdater;
+        });
         if (shouldRollback && allImmediateSnapshots.length > 0) {
           rollbackOptimistic(stateManager, allImmediateSnapshots);
           for (const snapshot of allImmediateSnapshots) {
@@ -322,8 +270,10 @@ function optimisticPlugin() {
           }
         }
         for (const target of targets) {
-          if (target.onError) {
-            target.onError(response.error);
+          const targetWithState = target;
+          const onError = targetWithState.__state ? targetWithState.__state.onError : target.onError;
+          if (onError) {
+            onError(response.error);
           }
         }
       } else {
@@ -331,11 +281,13 @@ function optimisticPlugin() {
           confirmOptimistic(stateManager, allImmediateSnapshots);
         }
         for (const target of targets) {
-          if (!target.confirmedUpdater) continue;
+          const targetWithState = target;
+          const confirmedUpdater = targetWithState.__state ? targetWithState.__state.confirmedUpdater : target.confirmedUpdater;
+          if (!confirmedUpdater) continue;
           const snapshots = applyUpdate(
             stateManager,
             target,
-            target.confirmedUpdater,
+            confirmedUpdater,
             response.data,
             t
           );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/plugin-optimistic",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Optimistic updates plugin for Spoosh - instant UI updates with automatic rollback",
   "license": "MIT",
   "repository": {
@@ -37,9 +37,9 @@
     "@spoosh/plugin-invalidation": ">=0.7.0"
   },
   "devDependencies": {
-    "@spoosh/core": "0.17.0",
-    "@spoosh/plugin-invalidation": "0.10.0",
-    "@spoosh/test-utils": "0.3.0"
+    "@spoosh/core": "0.17.1",
+    "@spoosh/test-utils": "0.3.0",
+    "@spoosh/plugin-invalidation": "0.10.0"
   },
   "scripts": {
     "dev": "tsup --watch",