@simpleapps-com/augur-hooks 0.1.7 → 0.1.9

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { G as GetItemCategoryApiOptions, P as PageData, S as SearchSuggestionsResponse, a as SearchSuggestion, I as InfiniteScrollPage } from './server-CF43MUMf.js';
-export { A as AugurApiClient, b as AugurAuthContext, c as AugurCallbacks, d as AugurHooksProvider, C as CATEGORY_CACHE_OPTIONS, e as INV_MAST_CACHE_OPTIONS, f as INV_MAST_DOC_CACHE_OPTIONS, g as PRICE_CACHE_OPTIONS, h as SEARCH_SUGGESTIONS_CACHE_OPTIONS, i as getCartPricingQueryOptions, j as getCategoryItemsInfiniteKey, k as getCategoryItemsInfiniteOptions, l as getInvMastDocKey, m as getInvMastDocOptions, n as getInvMastKey, o as getInvMastOptions, p as getInvMastStockKey, q as getInvMastStockOptions, r as getItemAttributesKey, s as getItemAttributesOptions, t as getItemCategoryKey, u as getItemCategoryOptions, v as getItemDetailsKey, w as getItemDetailsOptions, x as getItemPriceKey, y as getItemPriceOptions, z as getItemSearchInfiniteKey, B as getItemSearchInfiniteOptions, D as getProductCategoryKey, E as getProductCategoryOptions, F as getProductSearchKey, H as getProductSearchOptions, J as getSearchSuggestionsKey, K as getSearchSuggestionsOptions, L as useAugurApi, M as useAugurAuth } from './server-CF43MUMf.js';
+import { G as GetItemCategoryApiOptions, P as PageData, S as SearchSuggestionsResponse, a as SearchSuggestion, I as InfiniteScrollPage, A as AugurCallbacks, b as AugurApiClient, c as AugurAuthContext } from './joomla-content-list-MMF5wDQy.js';
+export { d as AugurHooksProvider, C as CATEGORY_CACHE_OPTIONS, e as INV_MAST_CACHE_OPTIONS, f as INV_MAST_DOC_CACHE_OPTIONS, J as JOOMLA_CONTENT_CACHE_OPTIONS, g as JOOMLA_CONTENT_LIST_CACHE_OPTIONS, h as PRICE_CACHE_OPTIONS, i as SEARCH_SUGGESTIONS_CACHE_OPTIONS, j as getCartPricingQueryOptions, k as getCategoryItemsInfiniteKey, l as getCategoryItemsInfiniteOptions, m as getInvMastDocKey, n as getInvMastDocOptions, o as getInvMastKey, p as getInvMastOptions, q as getInvMastStockKey, r as getInvMastStockOptions, s as getItemAttributesKey, t as getItemAttributesOptions, u as getItemCategoryKey, v as getItemCategoryOptions, w as getItemDetailsKey, x as getItemDetailsOptions, y as getItemPriceKey, z as getItemPriceOptions, B as getItemSearchInfiniteKey, D as getItemSearchInfiniteOptions, E as getJoomlaContentKey, F as getJoomlaContentListKey, H as getJoomlaContentListOptions, K as getJoomlaContentOptions, L as getProductCategoryKey, M as getProductCategoryOptions, N as getProductSearchKey, O as getProductSearchOptions, Q as getSearchSuggestionsKey, R as getSearchSuggestionsOptions, T as useAugurApi, U as useAugurAuth } from './joomla-content-list-MMF5wDQy.js';
 import * as zustand from 'zustand';
-import { TCartLine, TItemsFilters, TPriceData, TInvMastDoc, TCategory, TItemDetails, TAttribute } from '@simpleapps-com/augur-utils';
+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 'react/jsx-runtime';
-import 'react';
 
 interface CartState {
     cartHdrUid: number | string | undefined;
@@ -391,6 +391,8 @@ interface UsePaginationPrefetchOptions {
     queryFn: (offset: number) => Promise<unknown>;
     /** Number of items per page */
     pageSize: number;
+    /** Custom query key builder. Receives the base key and offset, returns the full key. Default: [...queryKey, offset]. */
+    queryKeyFn?: (baseKey: QueryKey, offset: number) => QueryKey;
     /** Stale time in ms (defaults to 10 minutes) */
     staleTime?: number;
     /** GC time in ms (defaults to 30 minutes) */
@@ -401,7 +403,7 @@ interface UsePaginationPrefetchOptions {
  * Prefetch adjacent pages on hover for instant pagination.
  * Accepts a generic queryFn so it works with any paginated resource.
  */
-declare const usePaginationPrefetch: ({ queryKey, queryFn, pageSize, staleTime, gcTime, enabled, }: UsePaginationPrefetchOptions) => {
+declare const usePaginationPrefetch: ({ queryKey, queryFn, pageSize, queryKeyFn, staleTime, gcTime, enabled, }: UsePaginationPrefetchOptions) => {
     prefetchPage: (page: number) => Promise<void>;
     handlePaginationHover: (page: number) => () => void;
 };
@@ -432,4 +434,94 @@ interface UseItemSearchInfiniteOptions {
  */
 declare function useItemSearchInfinite(itemsFilters: TItemsFilters, itemCategoryUid?: number | string, options?: UseItemSearchInfiniteOptions): _tanstack_react_query.UseInfiniteQueryResult<_tanstack_react_query.InfiniteData<InfiniteScrollPage, unknown>, Error>;
 
-export { type CartActionCallbacks, type CartInitCallbacks, type CartPriceData, type CartPricingResult, type CartSessionInfo, GetItemCategoryApiOptions, InfiniteScrollPage, PageData, SearchSuggestion, SearchSuggestionsResponse, useCartActions, useCartHdrUid, useCartInitialization, useCartItemCount, useCartLines, useCartPricing, useCartStore, useCategoryItemsInfinite, useClearCart, useDebounce, useFormatPrice, useInvMast, useInvMastDoc, useInvMastStock, useItemAttributes, useItemCategory, useItemDetails, useItemFiltersStore, useItemPrice, useItemSearchInfinite, usePaginationPrefetch, useProductCategory, useProductSearch, useSearchSuggestions, useSetCartHdrUid, useSetCartLines };
+interface UseJoomlaContentOptions {
+    enabled?: boolean;
+    queryFn?: () => Promise<TJoomlaContent>;
+}
+declare function useJoomlaContent(articleId: number | string | undefined, options?: UseJoomlaContentOptions): {
+    article: TJoomlaContent | null;
+    isLoading: boolean;
+    error: Error | null;
+};
+
+interface UseJoomlaContentListOptions {
+    enabled?: boolean;
+    queryFn?: () => Promise<TJoomlaContent[]>;
+    filters?: Partial<TJoomlaContentFilters>;
+}
+declare function useJoomlaContentList(categoryId: number | string | undefined, options?: UseJoomlaContentListOptions): {
+    articles: TJoomlaContent[];
+    isLoading: boolean;
+    error: Error | null;
+};
+
+/**
+ * Factory function that creates a pre-configured provider + hook bundle,
+ * eliminating per-hook wrapper boilerplate in consumer sites.
+ *
+ * @example
+ * ```ts
+ * // lib/augur.ts
+ * import { createSiteHooks } from "@simpleapps-com/augur-hooks";
+ * import { getItemPrice, getItemCategory } from "@/lib/actions/pricing";
+ *
+ * export const augur = createSiteHooks({
+ *   callbacks: { getItemPrice, getItemCategory },
+ *   defaultCustomerId: process.env.NEXT_PUBLIC_DEFAULT_CUSTOMER_ID,
+ * });
+ *
+ * // app/layout.tsx
+ * <augur.Provider api={api} auth={{ status, customerId, userId }}>
+ *   {children}
+ * </augur.Provider>
+ *
+ * // components/price.tsx
+ * const { data } = augur.useItemPrice(itemId);
+ * ```
+ */
+
+interface CreateSiteHooksConfig {
+    /** Callback registry for routing SDK calls through server actions. */
+    callbacks?: Partial<AugurCallbacks>;
+    /** Default customer ID used when auth.customerId is not provided. */
+    defaultCustomerId?: string | number;
+}
+interface SiteHooksProviderProps {
+    /** The augur-api SDK instance. */
+    api: AugurApiClient;
+    /** Auth context (partial -- missing fields are filled from config defaults). */
+    auth?: Partial<AugurAuthContext>;
+    children: ReactNode;
+}
+interface SiteHooks {
+    Provider: (props: SiteHooksProviderProps) => ReturnType<typeof createElement>;
+    useItemPrice: typeof useItemPrice;
+    useCartPricing: typeof useCartPricing;
+    useInvMast: typeof useInvMast;
+    useInvMastDoc: typeof useInvMastDoc;
+    useInvMastStock: typeof useInvMastStock;
+    useItemCategory: typeof useItemCategory;
+    useProductCategory: typeof useProductCategory;
+    useItemDetails: typeof useItemDetails;
+    useItemAttributes: typeof useItemAttributes;
+    useProductSearch: typeof useProductSearch;
+    useSearchSuggestions: typeof useSearchSuggestions;
+    useCartActions: typeof useCartActions;
+    useCartInitialization: typeof useCartInitialization;
+    usePaginationPrefetch: typeof usePaginationPrefetch;
+    useCategoryItemsInfinite: typeof useCategoryItemsInfinite;
+    useItemSearchInfinite: typeof useItemSearchInfinite;
+    useJoomlaContent: typeof useJoomlaContent;
+    useJoomlaContentList: typeof useJoomlaContentList;
+    useDebounce: typeof useDebounce;
+    useFormatPrice: typeof useFormatPrice;
+}
+/**
+ * Creates a pre-configured provider component and re-exports all hooks.
+ *
+ * The returned `Provider` merges `config.defaultCustomerId` into the auth
+ * context; an explicit `auth.customerId` prop takes priority.
+ */
+declare function createSiteHooks(config?: CreateSiteHooksConfig): SiteHooks;
+
+export { AugurApiClient, AugurAuthContext, AugurCallbacks, 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 };

package/dist/index.js

@@ -2,6 +2,8 @@ import {
   CATEGORY_CACHE_OPTIONS,
   INV_MAST_CACHE_OPTIONS,
   INV_MAST_DOC_CACHE_OPTIONS,
+  JOOMLA_CONTENT_CACHE_OPTIONS,
+  JOOMLA_CONTENT_LIST_CACHE_OPTIONS,
   PRICE_CACHE_OPTIONS,
   SEARCH_SUGGESTIONS_CACHE_OPTIONS,
   getCartPricingQueryOptions,
@@ -23,13 +25,17 @@ import {
   getItemPriceOptions,
   getItemSearchInfiniteKey,
   getItemSearchInfiniteOptions,
+  getJoomlaContentKey,
+  getJoomlaContentListKey,
+  getJoomlaContentListOptions,
+  getJoomlaContentOptions,
   getProductCategoryKey,
   getProductCategoryOptions,
   getProductSearchKey,
   getProductSearchOptions,
   getSearchSuggestionsKey,
   getSearchSuggestionsOptions
-} from "./chunk-DS2ECDHJ.js";
+} from "./chunk-TUNAYTS6.js";
 
 // src/provider.tsx
 import { createContext, useContext } from "react";
@@ -730,6 +736,7 @@ var usePaginationPrefetch = ({
   queryKey,
   queryFn,
   pageSize,
+  queryKeyFn,
   staleTime = 10 * 60 * 1e3,
   gcTime = 30 * 60 * 1e3,
   enabled = true
@@ -741,7 +748,7 @@ var usePaginationPrefetch = ({
       const offset = (page - 1) * pageSize;
       try {
         await queryClient.prefetchQuery({
-          queryKey: [...queryKey, offset],
+          queryKey: queryKeyFn ? queryKeyFn(queryKey, offset) : [...queryKey, offset],
           queryFn: () => queryFn(offset),
           staleTime,
           gcTime
@@ -750,7 +757,7 @@ var usePaginationPrefetch = ({
         console.warn(`Error prefetching page ${page}:`, error);
       }
     },
-    [queryKey, queryFn, pageSize, staleTime, gcTime, queryClient, enabled]
+    [queryKey, queryFn, pageSize, queryKeyFn, staleTime, gcTime, queryClient, enabled]
   );
   const handlePaginationHover = useCallback2(
     (page) => {
@@ -814,13 +821,112 @@ function useItemSearchInfinite(itemsFilters, itemCategoryUid, options = {}) {
     enabled: enabled && !!itemsFilters.q
   });
 }
+
+// src/hooks/use-joomla-content.ts
+import { useQuery as useQuery12 } from "@tanstack/react-query";
+function useJoomlaContent(articleId, options = {}) {
+  const api = useAugurApi();
+  const callbacks = useAugurCallbacks();
+  const { data, isLoading, error } = useQuery12({
+    ...articleId ? getJoomlaContentOptions(api, articleId) : {
+      queryKey: getJoomlaContentKey(""),
+      /* v8 ignore next */
+      queryFn: () => Promise.reject()
+    },
+    ...options.queryFn ?? callbacks?.getJoomlaContent ? { queryFn: options.queryFn ?? (() => callbacks.getJoomlaContent(articleId)) } : {},
+    enabled: (options.enabled ?? true) && !!articleId
+  });
+  return {
+    article: data ?? null,
+    isLoading,
+    error
+  };
+}
+
+// src/hooks/use-joomla-content-list.ts
+import { useQuery as useQuery13 } from "@tanstack/react-query";
+function useJoomlaContentList(categoryId, options = {}) {
+  const api = useAugurApi();
+  const callbacks = useAugurCallbacks();
+  const { data, isLoading, error } = useQuery13({
+    ...categoryId ? getJoomlaContentListOptions(api, categoryId, options.filters) : {
+      queryKey: getJoomlaContentListKey(""),
+      /* v8 ignore next */
+      queryFn: () => Promise.reject()
+    },
+    ...options.queryFn ?? callbacks?.getJoomlaContentList ? {
+      queryFn: options.queryFn ?? (() => callbacks.getJoomlaContentList(categoryId, options.filters))
+    } : {},
+    enabled: (options.enabled ?? true) && !!categoryId
+  });
+  return {
+    articles: data ?? [],
+    isLoading,
+    error
+  };
+}
+
+// src/create-site-hooks.ts
+import { createElement } from "react";
+function createSiteHooks(config = {}) {
+  const { callbacks, defaultCustomerId } = config;
+  function Provider({ api, auth, children }) {
+    const mergedAuth = {
+      status: auth?.status ?? "unauthenticated",
+      customerId: auth?.customerId ?? defaultCustomerId,
+      userId: auth?.userId,
+      cartHdrUid: auth?.cartHdrUid
+    };
+    return createElement(AugurHooksProvider, {
+      api,
+      callbacks,
+      auth: mergedAuth,
+      children
+    });
+  }
+  Provider.displayName = "AugurSiteProvider";
+  return {
+    Provider,
+    // Hooks -- pricing
+    useItemPrice,
+    useCartPricing,
+    // Hooks -- inventory
+    useInvMast,
+    useInvMastDoc,
+    useInvMastStock,
+    // Hooks -- items & categories
+    useItemCategory,
+    useProductCategory,
+    useItemDetails,
+    useItemAttributes,
+    // Hooks -- search
+    useProductSearch,
+    useSearchSuggestions,
+    // Hooks -- cart
+    useCartActions,
+    useCartInitialization,
+    // Hooks -- pagination & infinite scroll
+    usePaginationPrefetch,
+    useCategoryItemsInfinite,
+    useItemSearchInfinite,
+    // Hooks -- Joomla
+    useJoomlaContent,
+    useJoomlaContentList,
+    // Hooks -- utilities
+    useDebounce,
+    useFormatPrice
+  };
+}
 export {
   AugurHooksProvider,
   CATEGORY_CACHE_OPTIONS,
   INV_MAST_CACHE_OPTIONS,
   INV_MAST_DOC_CACHE_OPTIONS,
+  JOOMLA_CONTENT_CACHE_OPTIONS,
+  JOOMLA_CONTENT_LIST_CACHE_OPTIONS,
   PRICE_CACHE_OPTIONS,
   SEARCH_SUGGESTIONS_CACHE_OPTIONS,
+  createSiteHooks,
   getCartPricingQueryOptions,
   getCategoryItemsInfiniteKey,
   getCategoryItemsInfiniteOptions,
@@ -840,6 +946,10 @@ export {
   getItemPriceOptions,
   getItemSearchInfiniteKey,
   getItemSearchInfiniteOptions,
+  getJoomlaContentKey,
+  getJoomlaContentListKey,
+  getJoomlaContentListOptions,
+  getJoomlaContentOptions,
   getProductCategoryKey,
   getProductCategoryOptions,
   getProductSearchKey,
@@ -868,6 +978,8 @@ export {
   useItemFiltersStore,
   useItemPrice,
   useItemSearchInfinite,
+  useJoomlaContent,
+  useJoomlaContentList,
   usePaginationPrefetch,
   useProductCategory,
   useProductSearch,