@simpleapps-com/augur-hooks 0.2.0 → 0.2.2

package/dist/index.d.cts

@@ -1,10 +1,11 @@
-import { G as GetItemCategoryApiOptions, P as PageData, S as SearchSuggestionsResponse, a as SearchSuggestion, I as InfiniteScrollPage, A as AugurCallbacks, C as CacheConfig, b as AugurApiClient, c as AugurAuthContext } from './joomla-content-list-CDF5-OJ3.cjs';
-export { d as AugurHooksProvider, e as CacheProvider, f as CacheTierConfig, g as getCartPricingQueryOptions, h as getCategoryItemsInfiniteKey, i as getCategoryItemsInfiniteOptions, j as getInvMastDocKey, k as getInvMastDocOptions, l as getInvMastKey, m as getInvMastOptions, n as getInvMastStockKey, o as getInvMastStockOptions, p as getItemAttributesKey, q as getItemAttributesOptions, r as getItemCategoryKey, s as getItemCategoryOptions, t as getItemDetailsKey, u as getItemDetailsOptions, v as getItemPriceKey, w as getItemPriceOptions, x as getItemSearchInfiniteKey, y as getItemSearchInfiniteOptions, z as getJoomlaContentKey, B as getJoomlaContentListKey, D as getJoomlaContentListOptions, E as getJoomlaContentOptions, F as getProductCategoryKey, H as getProductCategoryOptions, J as getProductSearchKey, K as getProductSearchOptions, L as getSearchSuggestionsKey, M as getSearchSuggestionsOptions, N as useAugurApi, O as useAugurAuth, Q as useAugurCache } from './joomla-content-list-CDF5-OJ3.cjs';
+import { G as GetItemCategoryApiOptions, P as PageData, S as SearchSuggestionsResponse, a as SearchSuggestion, I as InfiniteScrollPage, A as AugurCallbacks, C as CacheConfig, b as AugurApiClient, c as AugurAuthContext, d as PersistenceConfig } from './joomla-content-list-DGPtwJ99.cjs';
+export { e as AugurHooksProvider, f as CacheProvider, g as CacheTierConfig, h as getCartPricingQueryOptions, i as getCategoryItemsInfiniteKey, j as getCategoryItemsInfiniteOptions, k as getInvMastDocKey, l as getInvMastDocOptions, m as getInvMastKey, n as getInvMastOptions, o as getInvMastStockKey, p as getInvMastStockOptions, q as getItemAttributesKey, r as getItemAttributesOptions, s as getItemCategoryKey, t as getItemCategoryOptions, u as getItemDetailsKey, v as getItemDetailsOptions, w as getItemPriceKey, x as getItemPriceOptions, y as getItemSearchInfiniteKey, z as getItemSearchInfiniteOptions, B as getJoomlaContentKey, D as getJoomlaContentListKey, E as getJoomlaContentListOptions, F as getJoomlaContentOptions, H as getProductCategoryKey, J as getProductCategoryOptions, K as getProductSearchKey, L as getProductSearchOptions, M as getSearchSuggestionsKey, N as getSearchSuggestionsOptions, O as useAugurApi, Q as useAugurAuth, R as useAugurCache } from './joomla-content-list-DGPtwJ99.cjs';
 import * as zustand from 'zustand';
 import { TCartLine, TItemsFilters, TPriceData, TInvMastDoc, TCategory, TItemDetails, TAttribute, TJoomlaContent, TJoomlaContentFilters } from '@simpleapps-com/augur-utils';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryKey } from '@tanstack/react-query';
 import { ReactNode, createElement } from 'react';
+import * as _tanstack_react_query_persist_client from '@tanstack/react-query-persist-client';
 import 'react/jsx-runtime';
 
 interface CartState {
@@ -526,4 +527,55 @@ interface SiteHooks {
  */
 declare function createSiteHooks(config?: CreateSiteHooksConfig): SiteHooks;
 
-export { AugurApiClient, AugurAuthContext, AugurCallbacks, CacheConfig, type CartActionCallbacks, type CartInitCallbacks, type CartPriceData, type CartPricingResult, type CartSessionInfo, type CreateSiteHooksConfig, GetItemCategoryApiOptions, InfiniteScrollPage, PageData, SearchSuggestion, SearchSuggestionsResponse, createSiteHooks, useCartActions, useCartHdrUid, useCartInitialization, useCartItemCount, useCartLines, useCartPricing, useCartStore, useCategoryItemsInfinite, useClearCart, useDebounce, useFormatPrice, useInvMast, useInvMastDoc, useInvMastStock, useItemAttributes, useItemCategory, useItemDetails, useItemFiltersStore, useItemPrice, useItemSearchInfinite, useJoomlaContent, useJoomlaContentList, usePaginationPrefetch, useProductCategory, useProductSearch, useSearchSuggestions, useSetCartHdrUid, useSetCartLines };
+/**
+ * Returns a fully configured `persistOptions` object for use with
+ * `PersistQueryClientProvider` from `@tanstack/react-query-persist-client`.
+ *
+ * Handles:
+ * - SSR-safe persister creation (no-op on server)
+ * - Map → Record serialization for localStorage compatibility
+ * - Selective persistence (only successful queries matching persistableKeys)
+ * - Per-key-prefix LRU eviction (via `limits`)
+ * - Throttled writes to localStorage
+ * - Hydration safety (maxAge: 0 until client mount)
+ * - Storage monitoring with automatic eviction when over threshold
+ * - Dev mode auto-buster (invalidates cache on each restart)
+ *
+ * @example
+ * ```tsx
+ * import { useAugurPersistence } from "@simpleapps-com/augur-hooks";
+ *
+ * function Providers({ children }) {
+ *   const [queryClient] = useState(() => new QueryClient({ ... }));
+ *   const persistOptions = useAugurPersistence({
+ *     key: "my-site-cache",
+ *     buster: "1.0.0",
+ *     persistableKeys: ["price", "categories", "invMast"],
+ *     limits: { invMast: 100 },
+ *   });
+ *
+ *   return (
+ *     <PersistQueryClientProvider client={queryClient} persistOptions={persistOptions}>
+ *       <augur.Provider api={api} auth={auth}>
+ *         {children}
+ *       </augur.Provider>
+ *     </PersistQueryClientProvider>
+ *   );
+ * }
+ * ```
+ */
+declare function useAugurPersistence(config: PersistenceConfig): {
+    persister: _tanstack_react_query_persist_client.Persister;
+    maxAge: number;
+    buster: string;
+    dehydrateOptions: {
+        shouldDehydrateQuery: (query: {
+            queryKey: readonly unknown[];
+            state: {
+                status: string;
+            };
+        }) => boolean;
+    };
+};
+
+export { AugurApiClient, AugurAuthContext, AugurCallbacks, CacheConfig, type CartActionCallbacks, type CartInitCallbacks, type CartPriceData, type CartPricingResult, type CartSessionInfo, type CreateSiteHooksConfig, GetItemCategoryApiOptions, InfiniteScrollPage, PageData, PersistenceConfig, SearchSuggestion, SearchSuggestionsResponse, createSiteHooks, useAugurPersistence, useCartActions, useCartHdrUid, useCartInitialization, useCartItemCount, useCartLines, useCartPricing, useCartStore, useCategoryItemsInfinite, useClearCart, useDebounce, useFormatPrice, useInvMast, useInvMastDoc, useInvMastStock, useItemAttributes, useItemCategory, useItemDetails, useItemFiltersStore, useItemPrice, useItemSearchInfinite, useJoomlaContent, useJoomlaContentList, usePaginationPrefetch, useProductCategory, useProductSearch, useSearchSuggestions, useSetCartHdrUid, useSetCartLines };

package/dist/index.d.ts

@@ -1,10 +1,11 @@
-import { G as GetItemCategoryApiOptions, P as PageData, S as SearchSuggestionsResponse, a as SearchSuggestion, I as InfiniteScrollPage, A as AugurCallbacks, C as CacheConfig, b as AugurApiClient, c as AugurAuthContext } from './joomla-content-list-CDF5-OJ3.js';
-export { d as AugurHooksProvider, e as CacheProvider, f as CacheTierConfig, g as getCartPricingQueryOptions, h as getCategoryItemsInfiniteKey, i as getCategoryItemsInfiniteOptions, j as getInvMastDocKey, k as getInvMastDocOptions, l as getInvMastKey, m as getInvMastOptions, n as getInvMastStockKey, o as getInvMastStockOptions, p as getItemAttributesKey, q as getItemAttributesOptions, r as getItemCategoryKey, s as getItemCategoryOptions, t as getItemDetailsKey, u as getItemDetailsOptions, v as getItemPriceKey, w as getItemPriceOptions, x as getItemSearchInfiniteKey, y as getItemSearchInfiniteOptions, z as getJoomlaContentKey, B as getJoomlaContentListKey, D as getJoomlaContentListOptions, E as getJoomlaContentOptions, F as getProductCategoryKey, H as getProductCategoryOptions, J as getProductSearchKey, K as getProductSearchOptions, L as getSearchSuggestionsKey, M as getSearchSuggestionsOptions, N as useAugurApi, O as useAugurAuth, Q as useAugurCache } from './joomla-content-list-CDF5-OJ3.js';
+import { G as GetItemCategoryApiOptions, P as PageData, S as SearchSuggestionsResponse, a as SearchSuggestion, I as InfiniteScrollPage, A as AugurCallbacks, C as CacheConfig, b as AugurApiClient, c as AugurAuthContext, d as PersistenceConfig } from './joomla-content-list-DGPtwJ99.js';
+export { e as AugurHooksProvider, f as CacheProvider, g as CacheTierConfig, h as getCartPricingQueryOptions, i as getCategoryItemsInfiniteKey, j as getCategoryItemsInfiniteOptions, k as getInvMastDocKey, l as getInvMastDocOptions, m as getInvMastKey, n as getInvMastOptions, o as getInvMastStockKey, p as getInvMastStockOptions, q as getItemAttributesKey, r as getItemAttributesOptions, s as getItemCategoryKey, t as getItemCategoryOptions, u as getItemDetailsKey, v as getItemDetailsOptions, w as getItemPriceKey, x as getItemPriceOptions, y as getItemSearchInfiniteKey, z as getItemSearchInfiniteOptions, B as getJoomlaContentKey, D as getJoomlaContentListKey, E as getJoomlaContentListOptions, F as getJoomlaContentOptions, H as getProductCategoryKey, J as getProductCategoryOptions, K as getProductSearchKey, L as getProductSearchOptions, M as getSearchSuggestionsKey, N as getSearchSuggestionsOptions, O as useAugurApi, Q as useAugurAuth, R as useAugurCache } from './joomla-content-list-DGPtwJ99.js';
 import * as zustand from 'zustand';
 import { TCartLine, TItemsFilters, TPriceData, TInvMastDoc, TCategory, TItemDetails, TAttribute, TJoomlaContent, TJoomlaContentFilters } from '@simpleapps-com/augur-utils';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryKey } from '@tanstack/react-query';
 import { ReactNode, createElement } from 'react';
+import * as _tanstack_react_query_persist_client from '@tanstack/react-query-persist-client';
 import 'react/jsx-runtime';
 
 interface CartState {
@@ -526,4 +527,55 @@ interface SiteHooks {
  */
 declare function createSiteHooks(config?: CreateSiteHooksConfig): SiteHooks;
 
-export { AugurApiClient, AugurAuthContext, AugurCallbacks, CacheConfig, type CartActionCallbacks, type CartInitCallbacks, type CartPriceData, type CartPricingResult, type CartSessionInfo, type CreateSiteHooksConfig, GetItemCategoryApiOptions, InfiniteScrollPage, PageData, SearchSuggestion, SearchSuggestionsResponse, createSiteHooks, useCartActions, useCartHdrUid, useCartInitialization, useCartItemCount, useCartLines, useCartPricing, useCartStore, useCategoryItemsInfinite, useClearCart, useDebounce, useFormatPrice, useInvMast, useInvMastDoc, useInvMastStock, useItemAttributes, useItemCategory, useItemDetails, useItemFiltersStore, useItemPrice, useItemSearchInfinite, useJoomlaContent, useJoomlaContentList, usePaginationPrefetch, useProductCategory, useProductSearch, useSearchSuggestions, useSetCartHdrUid, useSetCartLines };
+/**
+ * Returns a fully configured `persistOptions` object for use with
+ * `PersistQueryClientProvider` from `@tanstack/react-query-persist-client`.
+ *
+ * Handles:
+ * - SSR-safe persister creation (no-op on server)
+ * - Map → Record serialization for localStorage compatibility
+ * - Selective persistence (only successful queries matching persistableKeys)
+ * - Per-key-prefix LRU eviction (via `limits`)
+ * - Throttled writes to localStorage
+ * - Hydration safety (maxAge: 0 until client mount)
+ * - Storage monitoring with automatic eviction when over threshold
+ * - Dev mode auto-buster (invalidates cache on each restart)
+ *
+ * @example
+ * ```tsx
+ * import { useAugurPersistence } from "@simpleapps-com/augur-hooks";
+ *
+ * function Providers({ children }) {
+ *   const [queryClient] = useState(() => new QueryClient({ ... }));
+ *   const persistOptions = useAugurPersistence({
+ *     key: "my-site-cache",
+ *     buster: "1.0.0",
+ *     persistableKeys: ["price", "categories", "invMast"],
+ *     limits: { invMast: 100 },
+ *   });
+ *
+ *   return (
+ *     <PersistQueryClientProvider client={queryClient} persistOptions={persistOptions}>
+ *       <augur.Provider api={api} auth={auth}>
+ *         {children}
+ *       </augur.Provider>
+ *     </PersistQueryClientProvider>
+ *   );
+ * }
+ * ```
+ */
+declare function useAugurPersistence(config: PersistenceConfig): {
+    persister: _tanstack_react_query_persist_client.Persister;
+    maxAge: number;
+    buster: string;
+    dehydrateOptions: {
+        shouldDehydrateQuery: (query: {
+            queryKey: readonly unknown[];
+            state: {
+                status: string;
+            };
+        }) => boolean;
+    };
+};
+
+export { AugurApiClient, AugurAuthContext, AugurCallbacks, CacheConfig, type CartActionCallbacks, type CartInitCallbacks, type CartPriceData, type CartPricingResult, type CartSessionInfo, type CreateSiteHooksConfig, GetItemCategoryApiOptions, InfiniteScrollPage, PageData, PersistenceConfig, SearchSuggestion, SearchSuggestionsResponse, createSiteHooks, useAugurPersistence, useCartActions, useCartHdrUid, useCartInitialization, useCartItemCount, useCartLines, useCartPricing, useCartStore, useCategoryItemsInfinite, useClearCart, useDebounce, useFormatPrice, useInvMast, useInvMastDoc, useInvMastStock, useItemAttributes, useItemCategory, useItemDetails, useItemFiltersStore, useItemPrice, useItemSearchInfinite, useJoomlaContent, useJoomlaContentList, usePaginationPrefetch, useProductCategory, useProductSearch, useSearchSuggestions, useSetCartHdrUid, useSetCartLines };

package/dist/index.js

@@ -935,6 +935,168 @@ function createSiteHooks(config = {}) {
     useFormatPrice
   };
 }
+
+// src/persistence/use-persistence.ts
+import { useState as useState2, useEffect as useEffect4, useMemo as useMemo3 } from "react";
+
+// src/persistence/serializer.ts
+function serialize(data) {
+  return JSON.stringify(data, (_key, value) => {
+    if (value instanceof Map) return Object.fromEntries(value);
+    return value;
+  });
+}
+function deserialize(data) {
+  return JSON.parse(data);
+}
+
+// src/persistence/apply-limits.ts
+function applyLimits(data, limits) {
+  const queries = data.clientState?.queries;
+  if (!queries || Object.keys(limits).length === 0) return data;
+  const entries = queries;
+  const unlimited = [];
+  const groups = /* @__PURE__ */ new Map();
+  for (const q of entries) {
+    const prefix = Array.isArray(q.queryKey) ? q.queryKey[0] : void 0;
+    if (typeof prefix === "string" && prefix in limits) {
+      const group = groups.get(prefix) ?? [];
+      group.push(q);
+      groups.set(prefix, group);
+    } else {
+      unlimited.push(q);
+    }
+  }
+  const kept = [];
+  for (const [prefix, group] of groups) {
+    const limit = limits[prefix];
+    const sorted = [...group].sort(
+      (a, b) => (b.state.dataUpdatedAt ?? 0) - (a.state.dataUpdatedAt ?? 0)
+    );
+    kept.push(...sorted.slice(0, limit));
+  }
+  return {
+    ...data,
+    clientState: {
+      ...data.clientState,
+      queries: [...unlimited, ...kept]
+    }
+  };
+}
+
+// src/persistence/create-persister.ts
+var noopPersister = {
+  persistClient: async () => {
+  },
+  restoreClient: async () => void 0,
+  removeClient: async () => {
+  }
+};
+function createPersister(config) {
+  if (typeof window === "undefined") return noopPersister;
+  const throttleMs = config.throttleMs ?? 1e3;
+  const limits = config.limits ?? {};
+  let timer;
+  let pending;
+  function flush() {
+    if (!pending) return;
+    try {
+      const limited = applyLimits(pending, limits);
+      window.localStorage.setItem(config.key, serialize(limited));
+    } catch {
+    }
+    pending = void 0;
+  }
+  return {
+    persistClient(client) {
+      pending = client;
+      if (!timer) {
+        timer = setTimeout(() => {
+          timer = void 0;
+          flush();
+        }, throttleMs);
+      }
+    },
+    restoreClient() {
+      try {
+        const raw = window.localStorage.getItem(config.key);
+        if (!raw) return void 0;
+        return deserialize(raw);
+      } catch {
+        return void 0;
+      }
+    },
+    removeClient() {
+      window.localStorage.removeItem(config.key);
+    }
+  };
+}
+
+// src/persistence/use-storage-monitor.ts
+import { useEffect as useEffect3 } from "react";
+var CHECK_INTERVAL_MS = 5 * 60 * 1e3;
+function useStorageMonitor(config) {
+  const { key, limits = {}, maxStorageMB = 3 } = config;
+  const limitKeys = Object.keys(limits);
+  useEffect3(() => {
+    if (typeof window === "undefined" || limitKeys.length === 0) return;
+    function evict() {
+      const storage = window.localStorage;
+      let totalSize = 0;
+      for (const k of Object.keys(storage)) {
+        const v = storage.getItem(k);
+        if (v) totalSize += k.length + v.length;
+      }
+      const usedMB = totalSize * 2 / 1024 / 1024;
+      if (usedMB <= maxStorageMB) return;
+      try {
+        const raw = storage.getItem(key);
+        if (!raw) return;
+        const parsed = JSON.parse(raw);
+        if (!parsed.clientState?.queries) return;
+        parsed.clientState.queries = parsed.clientState.queries.filter(
+          (q) => {
+            if (!Array.isArray(q.queryKey)) return true;
+            const prefix = q.queryKey[0];
+            return typeof prefix !== "string" || !limitKeys.includes(prefix);
+          }
+        );
+        storage.setItem(key, JSON.stringify(parsed));
+      } catch {
+        storage.removeItem(key);
+      }
+    }
+    evict();
+    const id = setInterval(evict, CHECK_INTERVAL_MS);
+    return () => clearInterval(id);
+  }, [key, maxStorageMB, limitKeys.length]);
+}
+
+// src/persistence/use-persistence.ts
+function useAugurPersistence(config) {
+  const [persister] = useState2(() => createPersister(config));
+  const [isMounted, setIsMounted] = useState2(false);
+  useEffect4(() => {
+    setIsMounted(true);
+  }, []);
+  useStorageMonitor(config);
+  const isDev = typeof process !== "undefined" && process.env?.NODE_ENV === "development";
+  const { persistableKeys } = config;
+  const dehydrateOptions = useMemo3(() => ({
+    shouldDehydrateQuery: (query) => {
+      const key = query.queryKey;
+      if (!Array.isArray(key) || key.length === 0) return false;
+      if (query.state.status !== "success") return false;
+      return persistableKeys.includes(key[0]);
+    }
+  }), [persistableKeys]);
+  return {
+    persister,
+    maxAge: isMounted ? config.maxAge ?? 24 * 60 * 60 * 1e3 : 0,
+    buster: isDev ? String(Date.now()) : config.buster ?? "",
+    dehydrateOptions
+  };
+}
 export {
   AugurHooksProvider,
   createSiteHooks,
@@ -970,6 +1132,7 @@ export {
   useAugurApi,
   useAugurAuth,
   useAugurCache,
+  useAugurPersistence,
   useCartActions,
   useCartHdrUid,
   useCartInitialization,