@spoosh/plugin-optimistic 0.6.0 → 0.7.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { FindMatchingKey, HasParams, ExtractParamNames, Simplify, ExtractData, SpooshPlugin } from '@spoosh/core';
+import { ReadPaths, FindMatchingKey, HasParams, ExtractParamNames, Simplify, ExtractData, SpooshPlugin } from '@spoosh/core';
 
 /**
  * Check if query exists in the method config.
@@ -94,22 +94,20 @@ type OptimisticBuilder<TData = unknown, TMethodConfig = unknown, TUserPath exten
      */
     ON_ERROR: IfNotUsed<"ON_ERROR", TUsed, (callback: (error: unknown) => void) => OptimisticBuilder<TData, TMethodConfig, TUserPath, TResponse, TTiming, TUsed | "ON_ERROR", TCompleted>>;
 };
-/**
- * Extract paths that have GET methods.
- */
-type ReadPaths<TSchema> = {
-    [K in keyof TSchema & string]: "GET" extends keyof TSchema[K] ? K : never;
-}[keyof TSchema & string];
 /**
  * Path methods proxy for optimistic API - only GET.
+ * Resolves literal paths (e.g., "posts/1") to schema keys (e.g., "posts/:id") using FindMatchingKey.
+ * Uses TPath for param extraction to preserve user's param names.
  */
 type OptimisticPathMethods<TSchema, TPath extends string, TResponse> = FindMatchingKey<TSchema, TPath> extends infer TKey ? TKey extends keyof TSchema ? TSchema[TKey] extends infer TRoute ? "GET" extends keyof TRoute ? TRoute["GET"] extends infer TGetConfig ? {
     GET: () => OptimisticBuilder<ExtractData<TGetConfig>, TGetConfig, TPath, TResponse, "immediate", never, false>;
 } : never : never : never : never : never;
 /**
  * Helper type for creating the optimistic API proxy.
+ * Accepts both schema-defined paths (e.g., "posts/:id") and literal paths (e.g., "posts/1").
+ * Uses union with (string & {}) to allow any string while preserving autocomplete.
  */
-type OptimisticApiHelper<TSchema, TResponse = unknown> = <TPath extends ReadPaths<TSchema>>(path: TPath) => OptimisticPathMethods<TSchema, TPath, TResponse>;
+type OptimisticApiHelper<TSchema, TResponse = unknown> = <TPath extends ReadPaths<TSchema> | (string & {})>(path: TPath) => OptimisticPathMethods<TSchema, TPath, TResponse>;
 /**
  * A generic OptimisticTarget that accepts any data/response types.
  * Used for the return type of the callback.
@@ -205,7 +203,7 @@ interface OptimisticWriteTriggerOptions<TSchema = unknown, TResponse = unknown>
     optimistic?: OptimisticCallbackFn<TSchema, TResponse>;
 }
 type OptimisticReadOptions = object;
-type OptimisticInfiniteReadOptions = object;
+type OptimisticPagesOptions = object;
 interface OptimisticReadResult {
     isOptimistic: boolean;
 }
@@ -220,9 +218,9 @@ declare function optimisticPlugin(): SpooshPlugin<{
     readOptions: OptimisticReadOptions;
     writeOptions: OptimisticWriteOptions;
     writeTriggerOptions: OptimisticWriteTriggerOptions;
-    infiniteReadOptions: OptimisticInfiniteReadOptions;
+    pagesOptions: OptimisticPagesOptions;
     readResult: OptimisticReadResult;
     writeResult: OptimisticWriteResult;
 }>;
 
-export { type AnyOptimisticTarget, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticInfiniteReadOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, type OptimisticWriteTriggerOptions, optimisticPlugin };
+export { type AnyOptimisticTarget, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticPagesOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, type OptimisticWriteTriggerOptions, optimisticPlugin };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { FindMatchingKey, HasParams, ExtractParamNames, Simplify, ExtractData, SpooshPlugin } from '@spoosh/core';
+import { ReadPaths, FindMatchingKey, HasParams, ExtractParamNames, Simplify, ExtractData, SpooshPlugin } from '@spoosh/core';
 
 /**
  * Check if query exists in the method config.
@@ -94,22 +94,20 @@ type OptimisticBuilder<TData = unknown, TMethodConfig = unknown, TUserPath exten
      */
     ON_ERROR: IfNotUsed<"ON_ERROR", TUsed, (callback: (error: unknown) => void) => OptimisticBuilder<TData, TMethodConfig, TUserPath, TResponse, TTiming, TUsed | "ON_ERROR", TCompleted>>;
 };
-/**
- * Extract paths that have GET methods.
- */
-type ReadPaths<TSchema> = {
-    [K in keyof TSchema & string]: "GET" extends keyof TSchema[K] ? K : never;
-}[keyof TSchema & string];
 /**
  * Path methods proxy for optimistic API - only GET.
+ * Resolves literal paths (e.g., "posts/1") to schema keys (e.g., "posts/:id") using FindMatchingKey.
+ * Uses TPath for param extraction to preserve user's param names.
  */
 type OptimisticPathMethods<TSchema, TPath extends string, TResponse> = FindMatchingKey<TSchema, TPath> extends infer TKey ? TKey extends keyof TSchema ? TSchema[TKey] extends infer TRoute ? "GET" extends keyof TRoute ? TRoute["GET"] extends infer TGetConfig ? {
     GET: () => OptimisticBuilder<ExtractData<TGetConfig>, TGetConfig, TPath, TResponse, "immediate", never, false>;
 } : never : never : never : never : never;
 /**
  * Helper type for creating the optimistic API proxy.
+ * Accepts both schema-defined paths (e.g., "posts/:id") and literal paths (e.g., "posts/1").
+ * Uses union with (string & {}) to allow any string while preserving autocomplete.
  */
-type OptimisticApiHelper<TSchema, TResponse = unknown> = <TPath extends ReadPaths<TSchema>>(path: TPath) => OptimisticPathMethods<TSchema, TPath, TResponse>;
+type OptimisticApiHelper<TSchema, TResponse = unknown> = <TPath extends ReadPaths<TSchema> | (string & {})>(path: TPath) => OptimisticPathMethods<TSchema, TPath, TResponse>;
 /**
  * A generic OptimisticTarget that accepts any data/response types.
  * Used for the return type of the callback.
@@ -205,7 +203,7 @@ interface OptimisticWriteTriggerOptions<TSchema = unknown, TResponse = unknown>
     optimistic?: OptimisticCallbackFn<TSchema, TResponse>;
 }
 type OptimisticReadOptions = object;
-type OptimisticInfiniteReadOptions = object;
+type OptimisticPagesOptions = object;
 interface OptimisticReadResult {
     isOptimistic: boolean;
 }
@@ -220,9 +218,9 @@ declare function optimisticPlugin(): SpooshPlugin<{
     readOptions: OptimisticReadOptions;
     writeOptions: OptimisticWriteOptions;
     writeTriggerOptions: OptimisticWriteTriggerOptions;
-    infiniteReadOptions: OptimisticInfiniteReadOptions;
+    pagesOptions: OptimisticPagesOptions;
     readResult: OptimisticReadResult;
     writeResult: OptimisticWriteResult;
 }>;
 
-export { type AnyOptimisticTarget, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticInfiniteReadOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, type OptimisticWriteTriggerOptions, optimisticPlugin };
+export { type AnyOptimisticTarget, type OptimisticApiHelper, type OptimisticBuilder, type OptimisticCallbackFn, type OptimisticPagesOptions, type OptimisticPluginConfig, type OptimisticReadOptions, type OptimisticReadResult, type OptimisticTarget, type OptimisticWriteOptions, type OptimisticWriteResult, type OptimisticWriteTriggerOptions, optimisticPlugin };

package/dist/index.js

@@ -25,7 +25,6 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/plugin.ts
-var import_core = require("@spoosh/core");
 var import_plugin_invalidation = require("@spoosh/plugin-invalidation");
 function createBuilder(state) {
   return {
@@ -58,12 +57,50 @@ function createOptimisticProxy() {
   });
   return ((path) => createMethodsProxy(path));
 }
-function extractTagsFromPath(path) {
-  const pathSegments = path.split("/").filter(Boolean);
-  return (0, import_core.generateTags)(pathSegments);
+function isParameterSegment(segment) {
+  return segment.startsWith(":");
 }
-function getExactMatchPath(tags) {
-  return tags.length > 0 ? tags[tags.length - 1] : void 0;
+function pathMatchesPattern(actualPath, pattern) {
+  const actualSegments = actualPath.split("/").filter(Boolean);
+  const patternSegments = pattern.split("/").filter(Boolean);
+  if (actualSegments.length !== patternSegments.length) {
+    return { matches: false, params: {}, paramMapping: {} };
+  }
+  const params = {};
+  const paramMapping = {};
+  for (let i = 0; i < patternSegments.length; i++) {
+    const patternSeg = patternSegments[i];
+    const actualSeg = actualSegments[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: {} };
+    }
+  }
+  return { matches: true, params, paramMapping };
+}
+function hasPatternParams(path) {
+  return path.split("/").some(isParameterSegment);
+}
+function extractPathFromKey(key) {
+  try {
+    const parsed = JSON.parse(key);
+    const path = parsed.path;
+    if (typeof path === "string") {
+      return path;
+    }
+    return null;
+  } catch {
+    return null;
+  }
 }
 function extractOptionsFromKey(key) {
   try {
@@ -82,6 +119,21 @@ 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] = actualParams[actualName];
+    }
+  }
+  for (const [key, value] of Object.entries(actualParams)) {
+    if (!Object.values(paramMapping).includes(key)) {
+      result[key] = value;
+    }
+  }
+  return result;
+}
 function resolveOptimisticTargets(context) {
   const pluginOptions = context.pluginOptions;
   if (!pluginOptions?.optimistic) return [];
@@ -90,27 +142,70 @@ function resolveOptimisticTargets(context) {
   const targets = Array.isArray(result) ? result : [result];
   return targets;
 }
+function getMatchingEntries(stateManager, targetPath, targetMethod) {
+  const results = [];
+  if (hasPatternParams(targetPath)) {
+    const allEntries = stateManager.getAllCacheEntries();
+    for (const { key, entry } of allEntries) {
+      if (!key.includes(`"method":"${targetMethod}"`)) 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 {
+    const allEntries = stateManager.getAllCacheEntries();
+    for (const { key, entry } of allEntries) {
+      if (!key.includes(`"method":"${targetMethod}"`)) continue;
+      const actualPath = extractPathFromKey(key);
+      if (!actualPath) continue;
+      if (actualPath === targetPath) {
+        results.push({ key, entry, extractedParams: {}, paramMapping: {} });
+      } else if (hasPatternParams(actualPath)) {
+        const { matches, params, paramMapping } = pathMatchesPattern(
+          targetPath,
+          actualPath
+        );
+        if (matches) {
+          results.push({ key, entry, extractedParams: params, paramMapping });
+        }
+      }
+    }
+  }
+  return results;
+}
 function applyOptimisticUpdate(stateManager, target, t) {
   if (!target.updater) return [];
-  const tags = extractTagsFromPath(target.path);
-  const targetSelfTag = getExactMatchPath(tags);
-  if (!targetSelfTag) return [];
   const snapshots = [];
-  const entries = stateManager.getCacheEntriesBySelfTag(targetSelfTag);
-  for (const { key, entry } of entries) {
-    if (key.includes('"type":"infinite-tracker"')) {
-      continue;
-    }
-    if (!key.includes(`"method":"${target.method}"`)) {
-      continue;
-    }
+  const matchingEntries = getMatchingEntries(
+    stateManager,
+    target.path,
+    target.method
+  );
+  for (const { key, entry, extractedParams, paramMapping } of matchingEntries) {
     if (target.where) {
-      const options = extractOptionsFromKey(key);
-      if (!options || !target.where(options)) {
+      const options = extractOptionsFromKey(key) ?? {};
+      const mappedParams = mapParamsToTargetNames(
+        options.params,
+        paramMapping
+      );
+      const mergedOptions = {
+        ...options,
+        params: {
+          ...extractedParams,
+          ...mappedParams
+        }
+      };
+      if (!target.where(mergedOptions)) {
         continue;
       }
     }
-    if (entry.state.data === void 0) {
+    if (entry?.state.data === void 0) {
       continue;
     }
     const afterData = target.updater(entry.state.data, void 0);
@@ -233,24 +328,35 @@ function optimisticPlugin() {
         const onSuccessSnapshots = [];
         for (const target of onSuccessTargets) {
           if (!target.updater) continue;
-          const tags = extractTagsFromPath(target.path);
-          const targetSelfTag = getExactMatchPath(tags);
-          if (!targetSelfTag) continue;
-          const entries = stateManager.getCacheEntriesBySelfTag(targetSelfTag);
-          for (const { key, entry } of entries) {
-            if (key.includes('"type":"infinite-tracker"')) {
-              continue;
-            }
-            if (!key.includes(`"method":"${target.method}"`)) {
-              continue;
-            }
+          const matchingEntries = getMatchingEntries(
+            stateManager,
+            target.path,
+            target.method
+          );
+          for (const {
+            key,
+            entry,
+            extractedParams,
+            paramMapping
+          } of matchingEntries) {
             if (target.where) {
-              const options = extractOptionsFromKey(key);
-              if (!options || !target.where(options)) {
+              const options = extractOptionsFromKey(key) ?? {};
+              const mappedParams = mapParamsToTargetNames(
+                options.params,
+                paramMapping
+              );
+              const mergedOptions = {
+                ...options,
+                params: {
+                  ...extractedParams,
+                  ...mappedParams
+                }
+              };
+              if (!target.where(mergedOptions)) {
                 continue;
               }
             }
-            if (entry.state.data === void 0) {
+            if (entry?.state.data === void 0) {
               continue;
             }
             const afterData = target.updater(entry.state.data, response.data);

package/dist/index.mjs

@@ -1,5 +1,4 @@
 // src/plugin.ts
-import { generateTags } from "@spoosh/core";
 import "@spoosh/plugin-invalidation";
 function createBuilder(state) {
   return {
@@ -32,12 +31,50 @@ function createOptimisticProxy() {
   });
   return ((path) => createMethodsProxy(path));
 }
-function extractTagsFromPath(path) {
-  const pathSegments = path.split("/").filter(Boolean);
-  return generateTags(pathSegments);
+function isParameterSegment(segment) {
+  return segment.startsWith(":");
 }
-function getExactMatchPath(tags) {
-  return tags.length > 0 ? tags[tags.length - 1] : void 0;
+function pathMatchesPattern(actualPath, pattern) {
+  const actualSegments = actualPath.split("/").filter(Boolean);
+  const patternSegments = pattern.split("/").filter(Boolean);
+  if (actualSegments.length !== patternSegments.length) {
+    return { matches: false, params: {}, paramMapping: {} };
+  }
+  const params = {};
+  const paramMapping = {};
+  for (let i = 0; i < patternSegments.length; i++) {
+    const patternSeg = patternSegments[i];
+    const actualSeg = actualSegments[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: {} };
+    }
+  }
+  return { matches: true, params, paramMapping };
+}
+function hasPatternParams(path) {
+  return path.split("/").some(isParameterSegment);
+}
+function extractPathFromKey(key) {
+  try {
+    const parsed = JSON.parse(key);
+    const path = parsed.path;
+    if (typeof path === "string") {
+      return path;
+    }
+    return null;
+  } catch {
+    return null;
+  }
 }
 function extractOptionsFromKey(key) {
   try {
@@ -56,6 +93,21 @@ 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] = actualParams[actualName];
+    }
+  }
+  for (const [key, value] of Object.entries(actualParams)) {
+    if (!Object.values(paramMapping).includes(key)) {
+      result[key] = value;
+    }
+  }
+  return result;
+}
 function resolveOptimisticTargets(context) {
   const pluginOptions = context.pluginOptions;
   if (!pluginOptions?.optimistic) return [];
@@ -64,27 +116,70 @@ function resolveOptimisticTargets(context) {
   const targets = Array.isArray(result) ? result : [result];
   return targets;
 }
+function getMatchingEntries(stateManager, targetPath, targetMethod) {
+  const results = [];
+  if (hasPatternParams(targetPath)) {
+    const allEntries = stateManager.getAllCacheEntries();
+    for (const { key, entry } of allEntries) {
+      if (!key.includes(`"method":"${targetMethod}"`)) 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 {
+    const allEntries = stateManager.getAllCacheEntries();
+    for (const { key, entry } of allEntries) {
+      if (!key.includes(`"method":"${targetMethod}"`)) continue;
+      const actualPath = extractPathFromKey(key);
+      if (!actualPath) continue;
+      if (actualPath === targetPath) {
+        results.push({ key, entry, extractedParams: {}, paramMapping: {} });
+      } else if (hasPatternParams(actualPath)) {
+        const { matches, params, paramMapping } = pathMatchesPattern(
+          targetPath,
+          actualPath
+        );
+        if (matches) {
+          results.push({ key, entry, extractedParams: params, paramMapping });
+        }
+      }
+    }
+  }
+  return results;
+}
 function applyOptimisticUpdate(stateManager, target, t) {
   if (!target.updater) return [];
-  const tags = extractTagsFromPath(target.path);
-  const targetSelfTag = getExactMatchPath(tags);
-  if (!targetSelfTag) return [];
   const snapshots = [];
-  const entries = stateManager.getCacheEntriesBySelfTag(targetSelfTag);
-  for (const { key, entry } of entries) {
-    if (key.includes('"type":"infinite-tracker"')) {
-      continue;
-    }
-    if (!key.includes(`"method":"${target.method}"`)) {
-      continue;
-    }
+  const matchingEntries = getMatchingEntries(
+    stateManager,
+    target.path,
+    target.method
+  );
+  for (const { key, entry, extractedParams, paramMapping } of matchingEntries) {
     if (target.where) {
-      const options = extractOptionsFromKey(key);
-      if (!options || !target.where(options)) {
+      const options = extractOptionsFromKey(key) ?? {};
+      const mappedParams = mapParamsToTargetNames(
+        options.params,
+        paramMapping
+      );
+      const mergedOptions = {
+        ...options,
+        params: {
+          ...extractedParams,
+          ...mappedParams
+        }
+      };
+      if (!target.where(mergedOptions)) {
         continue;
       }
     }
-    if (entry.state.data === void 0) {
+    if (entry?.state.data === void 0) {
       continue;
     }
     const afterData = target.updater(entry.state.data, void 0);
@@ -207,24 +302,35 @@ function optimisticPlugin() {
         const onSuccessSnapshots = [];
         for (const target of onSuccessTargets) {
           if (!target.updater) continue;
-          const tags = extractTagsFromPath(target.path);
-          const targetSelfTag = getExactMatchPath(tags);
-          if (!targetSelfTag) continue;
-          const entries = stateManager.getCacheEntriesBySelfTag(targetSelfTag);
-          for (const { key, entry } of entries) {
-            if (key.includes('"type":"infinite-tracker"')) {
-              continue;
-            }
-            if (!key.includes(`"method":"${target.method}"`)) {
-              continue;
-            }
+          const matchingEntries = getMatchingEntries(
+            stateManager,
+            target.path,
+            target.method
+          );
+          for (const {
+            key,
+            entry,
+            extractedParams,
+            paramMapping
+          } of matchingEntries) {
             if (target.where) {
-              const options = extractOptionsFromKey(key);
-              if (!options || !target.where(options)) {
+              const options = extractOptionsFromKey(key) ?? {};
+              const mappedParams = mapParamsToTargetNames(
+                options.params,
+                paramMapping
+              );
+              const mergedOptions = {
+                ...options,
+                params: {
+                  ...extractedParams,
+                  ...mappedParams
+                }
+              };
+              if (!target.where(mergedOptions)) {
                 continue;
               }
             }
-            if (entry.state.data === void 0) {
+            if (entry?.state.data === void 0) {
               continue;
             }
             const afterData = target.updater(entry.state.data, response.data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/plugin-optimistic",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Optimistic updates plugin for Spoosh - instant UI updates with automatic rollback",
   "license": "MIT",
   "repository": {
@@ -33,13 +33,13 @@
     }
   },
   "peerDependencies": {
-    "@spoosh/core": ">=0.13.1",
+    "@spoosh/core": ">=0.15.0",
     "@spoosh/plugin-invalidation": ">=0.7.0"
   },
   "devDependencies": {
-    "@spoosh/core": "0.13.1",
-    "@spoosh/plugin-invalidation": "0.7.0",
-    "@spoosh/test-utils": "0.2.0"
+    "@spoosh/core": "0.15.0",
+    "@spoosh/plugin-invalidation": "0.9.0",
+    "@spoosh/test-utils": "0.3.0"
   },
   "scripts": {
     "dev": "tsup --watch",