@qiaopeng/tanstack-query-plus 0.2.15 → 0.3.1

package/README.md

@@ -1088,6 +1088,7 @@ function useUpdateProduct({ page, pageSize }) {
 
 适用操作与行为说明：
 - 编辑/删除：在 `sync+invalidate` 模式下，会对已缓存的家族变体按 `id` 合并或移除；随后统一失效，最终以服务端为准
+- **自动竞态保护**：当检测到 `consistency` 模式开启时，会自动取消该列表家族下所有正在进行的旧请求，防止旧数据覆盖新缓存
 - 新增/状态变更：默认不做跨页注入，仅当前页处理并家族失效；需要跨页放置时请在服务端裁决归属
 
 现在你已经掌握了数据变更和乐观更新。接下来，让我们学习如何处理无限滚动和分页场景。

package/dist/utils/index.d.ts

@@ -1,7 +1,7 @@
 export { createFieldEnricher, createOptimisticBase, createTempId, type FieldMappingConfig } from "./fieldMapper.js";
 export { getNetworkInfo, getNetworkSpeed, isFastNetwork, isSlowNetwork, type NavigatorWithConnection } from "./network.js";
 export { batchRemoveItems, batchUpdateItems, conditionalUpdateItems, createAddItemConfig, createListOperationConfig, createRemoveItemConfig, createUpdateItemConfig, type ListOperationVariables, listUpdater, reorderItems } from "./optimisticUtils.js";
-export { keepPreviousData } from "./placeholderData.js";
+export { keepPreviousData, stableListPlaceholder } from "./placeholderData.js";
 export { getPrefetchManager, type InteractionRecord, type NetworkSpeed, type PredictionResult, type PrefetchConfig, type PrefetchStats, type PrefetchTask, resetPrefetchManager, SmartPrefetchManager } from "./prefetchManager.js";
 export { createQueryKeyFactory, createSimpleQueryKeyFactory, extractParamsFromKey, isQueryKeyEqual, type NormalizeConfig, normalizeQueryParams, type QueryKeyFactory, type QueryKeyFactoryConfig } from "./queryKey.js";
 export { compose, selectById, selectByIds, selectCount, selectField, selectFields, selectFirst, selectItems, selectLast, selectMap, selectors, selectTotal, selectWhere } from "./selectors.js";

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACpH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,KAAK,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAC3H,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1P,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,KAAK,YAAY,EAAE,KAAK,gBAAgB,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACpO,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,oBAAoB,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACxN,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAChM,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC3F,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACpH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,KAAK,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAC3H,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC1P,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,KAAK,YAAY,EAAE,KAAK,gBAAgB,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACpO,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,oBAAoB,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACxN,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAChM,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC3F,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/utils/index.js

@@ -1,7 +1,7 @@
 export { createFieldEnricher, createOptimisticBase, createTempId } from "./fieldMapper.js";
 export { getNetworkInfo, getNetworkSpeed, isFastNetwork, isSlowNetwork } from "./network.js";
 export { batchRemoveItems, batchUpdateItems, conditionalUpdateItems, createAddItemConfig, createListOperationConfig, createRemoveItemConfig, createUpdateItemConfig, listUpdater, reorderItems } from "./optimisticUtils.js";
-export { keepPreviousData } from "./placeholderData.js";
+export { keepPreviousData, stableListPlaceholder } from "./placeholderData.js";
 export { getPrefetchManager, resetPrefetchManager, SmartPrefetchManager } from "./prefetchManager.js";
 export { createQueryKeyFactory, createSimpleQueryKeyFactory, extractParamsFromKey, isQueryKeyEqual, normalizeQueryParams } from "./queryKey.js";
 export { compose, selectById, selectByIds, selectCount, selectField, selectFields, selectFirst, selectItems, selectLast, selectMap, selectors, selectTotal, selectWhere } from "./selectors.js";

package/dist/utils/placeholderData.d.ts

@@ -1,2 +1,3 @@
 export { keepPreviousData } from "@tanstack/react-query";
+export declare function stableListPlaceholder<T = any>(previousData: T | undefined): T | undefined;
 //# sourceMappingURL=placeholderData.d.ts.map

package/dist/utils/placeholderData.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"placeholderData.d.ts","sourceRoot":"","sources":["../../src/utils/placeholderData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"placeholderData.d.ts","sourceRoot":"","sources":["../../src/utils/placeholderData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,wBAAgB,qBAAqB,CAAC,CAAC,GAAG,GAAG,EAAE,YAAY,EAAE,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,CAuBzF"}

package/dist/utils/placeholderData.js

@@ -1 +1,28 @@
 export { keepPreviousData } from "@tanstack/react-query";
+export function stableListPlaceholder(previousData) {
+    if (previousData === undefined || previousData === null)
+        return previousData;
+    if (Array.isArray(previousData)) {
+        return [];
+    }
+    if (typeof previousData === "object") {
+        const obj = { ...previousData };
+        if (Array.isArray(obj.Rows)) {
+            obj.Rows = [];
+            if (typeof obj.Total === "number")
+                obj.Total = obj.Total;
+            return obj;
+        }
+        if (Array.isArray(obj.items)) {
+            obj.items = [];
+            if (typeof obj.total === "number")
+                obj.total = obj.total;
+            return obj;
+        }
+        if (Array.isArray(obj.data)) {
+            obj.data = [];
+            return obj;
+        }
+    }
+    return previousData;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qiaopeng/tanstack-query-plus",
-  "version": "0.2.15",
+  "version": "0.3.1",
   "description": "Enhanced TanStack Query toolkit: defaults, hooks, persistence, offline, utils",
   "author": "qiaopeng",
   "license": "MIT",
@@ -95,10 +95,14 @@
     }
   },
   "devDependencies": {
+    "@tanstack/react-query": "^5",
+    "@tanstack/react-query-persist-client": "^5",
     "@tanstack/react-query-devtools": "^5",
     "@types/node": "^20.12.7",
     "@types/react": "^18.3.2",
     "@types/react-dom": "^18.3.0",
+    "react": ">=18",
+    "react-dom": ">=18",
     "react-intersection-observer": "^9",
     "tsup": "^8.0.0",
     "typescript": "^5.4.0"

package/dist/types/consistency.d.ts

@@ -1,13 +0,0 @@
-import type { QueryKey } from "@tanstack/react-query";
-export type ConsistencyMode = "invalidate" | "sync+invalidate";
-export interface FamilyConsistencyOptions {
-    baseKey: QueryKey;
-    mode?: ConsistencyMode;
-    idField?: string;
-    listSelector?: (data: unknown) => unknown[] | {
-        items: unknown[];
-        total?: number;
-    } | null;
-    maxKeys?: number;
-}
-//# sourceMappingURL=consistency.d.ts.map

package/dist/types/consistency.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"consistency.d.ts","sourceRoot":"","sources":["../../src/types/consistency.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,iBAAiB,CAAC;AAC/D,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,QAAQ,CAAC;IAClB,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,EAAE,GAAG;QAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC1F,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/consistency.js

@@ -1 +0,0 @@
-export {};

package/dist/utils/invalidationManager.d.ts

@@ -1,4 +0,0 @@
-import { QueryClient } from "@tanstack/react-query";
-export declare function scheduleInvalidations(queryClient: QueryClient, tasks: any[], delay: number): void;
-export declare function cancelScheduledInvalidations(tasks: any[]): void;
-//# sourceMappingURL=invalidationManager.d.ts.map

package/dist/utils/invalidationManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"invalidationManager.d.ts","sourceRoot":"","sources":["../../src/utils/invalidationManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAUpD,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,QAe1F;AAED,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,GAAG,EAAE,QAQxD"}

package/dist/utils/invalidationManager.js

@@ -1,28 +0,0 @@
-const timers = new Map();
-function getTaskKey(task) {
-    // Serialize the task to identify duplicates.
-    // We mainly care about queryKey and exact/refetchType properties.
-    return JSON.stringify(task);
-}
-export function scheduleInvalidations(queryClient, tasks, delay) {
-    tasks.forEach(task => {
-        const key = getTaskKey(task);
-        if (timers.has(key)) {
-            clearTimeout(timers.get(key));
-        }
-        const timer = setTimeout(() => {
-            queryClient.invalidateQueries(task);
-            timers.delete(key);
-        }, delay);
-        timers.set(key, timer);
-    });
-}
-export function cancelScheduledInvalidations(tasks) {
-    tasks.forEach(task => {
-        const key = getTaskKey(task);
-        if (timers.has(key)) {
-            clearTimeout(timers.get(key));
-            timers.delete(key);
-        }
-    });
-}