@simpleapps-com/augur-hooks 0.1.9 → 0.2.0

package/dist/{joomla-content-list-MMF5wDQy.d.ts → joomla-content-list-CDF5-OJ3.d.cts}

@@ -44,6 +44,32 @@ type SearchSuggestionsResponse = {
     total: number;
     totalResults: number;
 };
+/** Cache provider for Redis-compatible storage. */
+interface CacheProvider {
+    prefix: string;
+    get: (key: string) => Promise<string | null>;
+    set: (key: string, value: string, ttlSeconds: number) => Promise<void>;
+}
+/** Cache settings for a single tier. */
+interface CacheTierConfig {
+    /** CDN edge cache. Passed directly to SDK as edgeCache. Valid values: 1–8 (hours) or '30s', '1m', '5m'. */
+    edgeCache?: number | string;
+    /** Redis cache TTL in seconds. Requires provider. */
+    redis?: number;
+    /** React Query staleTime in ms. Overrides the built-in default. */
+    staleTime?: number;
+    /** React Query gcTime (garbage collection) in ms. Overrides the built-in default. */
+    gcTime?: number;
+}
+/** Cache configuration. All fields optional, all off by default. */
+interface CacheConfig {
+    /** Redis-compatible cache. Required for redis caching. */
+    provider?: CacheProvider;
+    /** TTLs for long-lived data (categories, item details, docs). */
+    static?: CacheTierConfig;
+    /** TTLs for frequently-changing data (prices, stock, search). */
+    semiStatic?: CacheTierConfig;
+}
 /** API options for item category queries. */
 interface GetItemCategoryApiOptions {
     childrenFilter?: string;
@@ -178,6 +204,8 @@ interface AugurHooksProviderProps {
     callbacks?: AugurCallbacks;
     /** Optional auth context — hooks fall back to these values when not passed directly. */
     auth?: AugurAuthContext;
+    /** Optional cache configuration — controls edge and Redis caching per tier. */
+    cache?: CacheConfig;
     children: ReactNode;
 }
 /**
@@ -203,7 +231,7 @@ interface AugurHooksProviderProps {
  * </AugurHooksProvider>
  * ```
  */
-declare function AugurHooksProvider({ api, callbacks, auth, children, }: AugurHooksProviderProps): react_jsx_runtime.JSX.Element;
+declare function AugurHooksProvider({ api, callbacks, auth, cache, children, }: AugurHooksProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * Returns the augur-api SDK instance from context.
  * Throws if called outside of `<AugurHooksProvider>`.
@@ -215,16 +243,12 @@ declare function useAugurApi(): AugurApiClient;
  * auth fields are not passed directly as hook parameters.
  */
 declare function useAugurAuth(): AugurAuthContext | undefined;
+/**
+ * Returns the provider-level cache configuration, if any.
+ * Used internally by hooks to enable edge/Redis caching.
+ */
+declare function useAugurCache(): CacheConfig | undefined;
 
-declare const PRICE_CACHE_OPTIONS: {
-    readonly refetchOnReconnect: true;
-    readonly refetchOnWindowFocus: false;
-    readonly meta: {
-        readonly persist: true;
-    };
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
 /**
  * Generates a consistent query key for item price queries.
  * Usable in both client hooks and server-side prefetch.
@@ -234,22 +258,18 @@ declare const getItemPriceKey: (itemId: string | undefined, customerId: string |
  * Query options for item price. Accepts the SDK instance so it works
  * in both client (via provider) and server (via direct construction).
  */
-declare const getItemPriceOptions: (api: AugurApiClient, itemId: string | undefined, customerId: string | number | undefined, quantity?: number) => {
-    refetchOnReconnect: true;
-    refetchOnWindowFocus: false;
-    meta: {
-        readonly persist: true;
-    };
-    staleTime: number;
-    gcTime: number;
+declare const getItemPriceOptions: (api: AugurApiClient, itemId: string | undefined, customerId: string | number | undefined, quantity?: number, cache?: CacheConfig) => {
     queryKey: readonly ["price", string, string | number | undefined, number];
     queryFn: () => Promise<TPriceData>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
+    refetchOnReconnect: boolean;
+    refetchOnWindowFocus: boolean;
+    meta: {
+        persist: boolean;
+    };
 };
 
-declare const INV_MAST_DOC_CACHE_OPTIONS: {
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
 /**
  * Generates a consistent query key for inv mast doc queries.
  * Usable in both client hooks and server-side prefetch.
@@ -259,17 +279,13 @@ declare const getInvMastDocKey: (invMastUid: number, itemId: string, includePric
  * Query options for inv mast doc. Accepts the SDK instance so it works
  * in both client (via provider) and server (via direct construction).
  */
-declare const getInvMastDocOptions: (api: AugurApiClient, invMastUid: number, itemId: string, includePricing: "Y" | "N") => {
-    staleTime: number;
-    gcTime: number;
+declare const getInvMastDocOptions: (api: AugurApiClient, invMastUid: number, itemId: string, includePricing: "Y" | "N", cache?: CacheConfig) => {
     queryKey: readonly ["invMastDoc", number, string, "Y" | "N"];
     queryFn: () => Promise<TInvMastDoc>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
-declare const CATEGORY_CACHE_OPTIONS: {
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
 type ItemCategoryQueryKey = readonly [
     "itemCategory",
     number,
@@ -284,31 +300,27 @@ declare const getItemCategoryKey: (itemCategoryUid: number, apiOptions?: GetItem
  * Query options for item category. Accepts the SDK instance so it works
  * in both client (via provider) and server (via direct construction).
  */
-declare const getItemCategoryOptions: (api: AugurApiClient, itemCategoryUid: number, apiOptions?: GetItemCategoryApiOptions) => {
-    staleTime: number;
-    gcTime: number;
+declare const getItemCategoryOptions: (api: AugurApiClient, itemCategoryUid: number, apiOptions?: GetItemCategoryApiOptions, cache?: CacheConfig) => {
     queryKey: ItemCategoryQueryKey;
     queryFn: () => Promise<TCategory>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
-declare const INV_MAST_CACHE_OPTIONS: {
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
 declare const getInvMastKey: (invMastUid: number, itemId: string) => readonly ["invMast", number, string];
-declare const getInvMastOptions: (api: AugurApiClient, invMastUid: number, itemId: string) => {
-    staleTime: number;
-    gcTime: number;
+declare const getInvMastOptions: (api: AugurApiClient, invMastUid: number, itemId: string, cache?: CacheConfig) => {
     queryKey: readonly ["invMast", number, string];
     queryFn: () => Promise<TItemDetails>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
 declare const getInvMastStockKey: (invMastUid: number | string) => readonly ["invMastStock", string | number];
-declare const getInvMastStockOptions: (api: AugurApiClient, invMastUid: number | string) => {
-    staleTime: number;
-    gcTime: number;
+declare const getInvMastStockOptions: (api: AugurApiClient, invMastUid: number | string, cache?: CacheConfig) => {
     queryKey: readonly ["invMastStock", string | number];
     queryFn: () => Promise<number>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
 type ProductCategoryResponse = {
@@ -318,27 +330,27 @@ type ProductCategoryResponse = {
     categoryImage: string | null;
 };
 declare const getProductCategoryKey: (itemCategoryUid: number | string | null) => readonly ["productCategory", string | number | null];
-declare const getProductCategoryOptions: (api: AugurApiClient, itemCategoryUid: number | string) => {
-    staleTime: number;
-    gcTime: number;
+declare const getProductCategoryOptions: (api: AugurApiClient, itemCategoryUid: number | string, cache?: CacheConfig) => {
     queryKey: readonly ["productCategory", string | number | null];
     queryFn: () => Promise<ProductCategoryResponse>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
 declare const getItemDetailsKey: (itemId: number | string) => readonly ["itemDetails", string | number];
-declare const getItemDetailsOptions: (api: AugurApiClient, itemId: number | string) => {
-    staleTime: number;
-    gcTime: number;
+declare const getItemDetailsOptions: (api: AugurApiClient, itemId: number | string, cache?: CacheConfig) => {
     queryKey: readonly ["itemDetails", string | number];
     queryFn: () => Promise<TItemDetails>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
 declare const getItemAttributesKey: (itemCategoryUid: number | string | null) => readonly ["itemAttributes", string | number | null];
-declare const getItemAttributesOptions: (api: AugurApiClient, itemCategoryUid: number | string) => {
-    staleTime: number;
-    gcTime: number;
+declare const getItemAttributesOptions: (api: AugurApiClient, itemCategoryUid: number | string, cache?: CacheConfig) => {
     queryKey: readonly ["itemAttributes", string | number | null];
     queryFn: () => Promise<any>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
 type ProductSearchResponse = {
@@ -353,17 +365,13 @@ declare const getProductSearchKey: (pageData: PageData) => readonly ["productSea
  * Query options for product search. Accepts the SDK instance so it works
  * in both client (via provider) and server (via direct construction).
  */
-declare const getProductSearchOptions: (api: AugurApiClient, pageData: PageData) => {
-    staleTime: number;
-    gcTime: number;
+declare const getProductSearchOptions: (api: AugurApiClient, pageData: PageData, cache?: CacheConfig) => {
     queryKey: readonly ["productSearch", string, number, number, string, number | undefined];
     queryFn: () => Promise<ProductSearchResponse>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
-declare const SEARCH_SUGGESTIONS_CACHE_OPTIONS: {
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
 /**
  * Generates a consistent query key for search suggestion queries.
  */
@@ -372,11 +380,11 @@ declare const getSearchSuggestionsKey: (query: string, limit: number, offset: nu
  * Query options for search suggestions. Accepts the SDK instance so it works
  * in both client (via provider) and server (via direct construction).
  */
-declare const getSearchSuggestionsOptions: (api: AugurApiClient, query: string, limit?: number, offset?: number) => {
-    staleTime: number;
-    gcTime: number;
+declare const getSearchSuggestionsOptions: (api: AugurApiClient, query: string, limit?: number, offset?: number, cache?: CacheConfig) => {
     queryKey: readonly ["searchSuggestions", string, number, number];
     queryFn: () => Promise<SearchSuggestionsResponse>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
 /**
@@ -385,17 +393,17 @@ declare const getSearchSuggestionsOptions: (api: AugurApiClient, query: string,
 declare function getCartPricingQueryOptions(api: AugurApiClient, cartLines: Array<{
     itemId: string;
     quantity: number;
-}>, customerId: string | number | undefined): {
+}>, customerId: string | number | undefined, cache?: CacheConfig): {
     enabled: boolean;
-    refetchOnReconnect: true;
-    refetchOnWindowFocus: false;
-    meta: {
-        readonly persist: true;
-    };
-    staleTime: number;
-    gcTime: number;
     queryKey: readonly ["price", string, string | number | undefined, number];
     queryFn: () => Promise<_simpleapps_com_augur_utils.TPriceData>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
+    refetchOnReconnect: boolean;
+    refetchOnWindowFocus: boolean;
+    meta: {
+        persist: boolean;
+    };
 }[];
 
 declare const getCategoryItemsInfiniteKey: (itemCategoryUid: number, itemsFilters: TItemsFilters) => readonly ["categoryItemsInfinite", number, string];
@@ -403,15 +411,15 @@ declare const getCategoryItemsInfiniteKey: (itemCategoryUid: number, itemsFilter
  * Full infinite query options for category items.
  * Usable for server-side prefetch with `queryClient.prefetchInfiniteQuery()`.
  */
-declare const getCategoryItemsInfiniteOptions: (api: AugurApiClient, itemCategoryUid: number, itemsFilters: TItemsFilters) => {
-    staleTime: number;
-    gcTime: number;
+declare const getCategoryItemsInfiniteOptions: (api: AugurApiClient, itemCategoryUid: number, itemsFilters: TItemsFilters, cache?: CacheConfig) => {
     queryKey: readonly ["categoryItemsInfinite", number, string];
     queryFn: ({ pageParam, }: {
         pageParam?: unknown;
     }) => Promise<InfiniteScrollPage>;
     initialPageParam: number;
     getNextPageParam: (lastPage: InfiniteScrollPage) => number | undefined;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
 declare const getItemSearchInfiniteKey: (itemsFilters: TItemsFilters, itemCategoryUid?: number | string) => readonly ["itemSearchInfinite", string, string | number | undefined];
@@ -419,42 +427,34 @@ declare const getItemSearchInfiniteKey: (itemsFilters: TItemsFilters, itemCatego
  * Full infinite query options for item search.
  * Usable for server-side prefetch with `queryClient.prefetchInfiniteQuery()`.
  */
-declare const getItemSearchInfiniteOptions: (api: AugurApiClient, itemsFilters: TItemsFilters, itemCategoryUid?: number | string) => {
-    meta: {
-        persist: boolean;
-    };
-    staleTime: number;
-    gcTime: number;
+declare const getItemSearchInfiniteOptions: (api: AugurApiClient, itemsFilters: TItemsFilters, itemCategoryUid?: number | string, cache?: CacheConfig) => {
     queryKey: readonly ["itemSearchInfinite", string, string | number | undefined];
     queryFn: ({ pageParam, }: {
         pageParam?: unknown;
     }) => Promise<InfiniteScrollPage>;
     initialPageParam: number;
     getNextPageParam: (lastPage: InfiniteScrollPage) => number | undefined;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
+    meta: {
+        persist: boolean;
+    };
 };
 
-declare const JOOMLA_CONTENT_CACHE_OPTIONS: {
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
 declare const getJoomlaContentKey: (articleId: number | string) => readonly ["joomlaContent", string | number];
-declare const getJoomlaContentOptions: (api: AugurApiClient, articleId: number | string) => {
-    staleTime: number;
-    gcTime: number;
+declare const getJoomlaContentOptions: (api: AugurApiClient, articleId: number | string, cache?: CacheConfig) => {
     queryKey: readonly ["joomlaContent", string | number];
     queryFn: () => Promise<TJoomlaContent>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
-declare const JOOMLA_CONTENT_LIST_CACHE_OPTIONS: {
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
 declare const getJoomlaContentListKey: (categoryId: number | string, filters?: Partial<TJoomlaContentFilters>) => readonly ["joomlaContentList", string | number, Partial<TJoomlaContentFilters> | undefined];
-declare const getJoomlaContentListOptions: (api: AugurApiClient, categoryId: number | string, filters?: Partial<TJoomlaContentFilters>) => {
-    staleTime: number;
-    gcTime: number;
+declare const getJoomlaContentListOptions: (api: AugurApiClient, categoryId: number | string, filters?: Partial<TJoomlaContentFilters>, cache?: CacheConfig) => {
     queryKey: readonly ["joomlaContentList", string | number, Partial<TJoomlaContentFilters> | undefined];
     queryFn: () => Promise<TJoomlaContent[]>;
+    staleTime: number | undefined;
+    gcTime: number | undefined;
 };
 
-export { type AugurCallbacks as A, getItemSearchInfiniteKey as B, CATEGORY_CACHE_OPTIONS as C, getItemSearchInfiniteOptions as D, getJoomlaContentKey as E, getJoomlaContentListKey as F, type GetItemCategoryApiOptions as G, getJoomlaContentListOptions as H, type InfiniteScrollPage as I, JOOMLA_CONTENT_CACHE_OPTIONS as J, getJoomlaContentOptions as K, getProductCategoryKey as L, getProductCategoryOptions as M, getProductSearchKey as N, getProductSearchOptions as O, type PageData as P, getSearchSuggestionsKey as Q, getSearchSuggestionsOptions as R, type SearchSuggestionsResponse as S, useAugurApi as T, useAugurAuth as U, type SearchSuggestion as a, type AugurApiClient as b, type AugurAuthContext as c, AugurHooksProvider as d, INV_MAST_CACHE_OPTIONS as e, INV_MAST_DOC_CACHE_OPTIONS as f, JOOMLA_CONTENT_LIST_CACHE_OPTIONS as g, PRICE_CACHE_OPTIONS as h, SEARCH_SUGGESTIONS_CACHE_OPTIONS as i, getCartPricingQueryOptions as j, getCategoryItemsInfiniteKey as k, getCategoryItemsInfiniteOptions as l, getInvMastDocKey as m, getInvMastDocOptions as n, getInvMastKey as o, getInvMastOptions as p, getInvMastStockKey as q, getInvMastStockOptions as r, getItemAttributesKey as s, getItemAttributesOptions as t, getItemCategoryKey as u, getItemCategoryOptions as v, getItemDetailsKey as w, getItemDetailsOptions as x, getItemPriceKey as y, getItemPriceOptions as z };
+export { type AugurCallbacks as A, getJoomlaContentListKey as B, type CacheConfig as C, getJoomlaContentListOptions as D, getJoomlaContentOptions as E, getProductCategoryKey as F, type GetItemCategoryApiOptions as G, getProductCategoryOptions as H, type InfiniteScrollPage as I, getProductSearchKey as J, getProductSearchOptions as K, getSearchSuggestionsKey as L, getSearchSuggestionsOptions as M, useAugurApi as N, useAugurAuth as O, type PageData as P, useAugurCache as Q, type SearchSuggestionsResponse as S, type SearchSuggestion as a, type AugurApiClient as b, type AugurAuthContext as c, AugurHooksProvider as d, type CacheProvider as e, type CacheTierConfig as f, getCartPricingQueryOptions as g, getCategoryItemsInfiniteKey as h, getCategoryItemsInfiniteOptions as i, getInvMastDocKey as j, getInvMastDocOptions as k, getInvMastKey as l, getInvMastOptions as m, getInvMastStockKey as n, getInvMastStockOptions as o, getItemAttributesKey as p, getItemAttributesOptions as q, getItemCategoryKey as r, getItemCategoryOptions as s, getItemDetailsKey as t, getItemDetailsOptions as u, getItemPriceKey as v, getItemPriceOptions as w, getItemSearchInfiniteKey as x, getItemSearchInfiniteOptions as y, getJoomlaContentKey as z };