@simpleapps-com/augur-hooks 0.1.4 → 0.1.6

package/dist/index.d.ts

@@ -1,93 +1,11 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode } from 'react';
+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 * as zustand from 'zustand';
-import * as _simpleapps_com_augur_utils from '@simpleapps-com/augur-utils';
-import { TCartLine, TItemsFilters, TPriceData, TInvMastDoc, TCategory, TItemDetails, TProductCategory, TAttribute, TProductItem } from '@simpleapps-com/augur-utils';
+import { TCartLine, TItemsFilters, TPriceData, TInvMastDoc, TCategory, TItemDetails, TAttribute } from '@simpleapps-com/augur-utils';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryKey } from '@tanstack/react-query';
-
-/**
- * Minimal type for the augur-api SDK instance.
- * Consumers provide their concrete AugurAPI instance; we keep the type
- * loose so augur-hooks doesn't need to depend directly on the SDK package.
- */
-type AugurApiClient = any;
-interface AugurHooksProviderProps {
-    api: AugurApiClient;
-    children: ReactNode;
-}
-/**
- * Provides the augur-api SDK instance to all hooks in the tree.
- *
- * ```tsx
- * import { AugurAPI } from "@simpleapps-com/augur-api";
- * const api = new AugurAPI({ baseUrl: "...", token: "..." });
- *
- * <AugurHooksProvider api={api}>
- *   <App />
- * </AugurHooksProvider>
- * ```
- */
-declare function AugurHooksProvider({ api, children }: AugurHooksProviderProps): react_jsx_runtime.JSX.Element;
-/**
- * Returns the augur-api SDK instance from context.
- * Throws if called outside of `<AugurHooksProvider>`.
- */
-declare function useAugurApi(): AugurApiClient;
-
-/**
- * Hook-specific types that don't belong in augur-utils.
- * These describe hook parameters and API response shapes.
- */
-/** Parameters for product search queries. */
-type PageData = {
-    categoryIdList?: string;
-    filters?: [string, string][];
-    limit: number;
-    page: number;
-    offset: number;
-    q: string;
-    sortBy: string;
-    tagslist?: string;
-    itemCategoryUid?: number;
-};
-/** A single search suggestion from OpenSearch. */
-type SearchSuggestion = {
-    suggestionsUid: number;
-    queryStringUid: number;
-    suggestionsString: string;
-    suggestionsMetaphone: string | null;
-    avgTotalResults: number;
-    dateCreated: string;
-    dateLastModified: string;
-    updateCd: number;
-    statusCd: number;
-    processCd: number;
-    score: number;
-};
-/** Response shape from the search suggestions endpoint. */
-type SearchSuggestionsResponse = {
-    count: number;
-    data: SearchSuggestion[];
-    message: string;
-    options: unknown[];
-    params: unknown[];
-    status: number;
-    total: number;
-    totalResults: number;
-};
-/** API options for item category queries. */
-interface GetItemCategoryApiOptions {
-    childrenFilter?: string;
-    childrenLimit?: number;
-    childrenOffset?: number;
-    classId5List?: string;
-    filters?: Record<string, string>;
-    orderBy?: string;
-    path?: string;
-    productCollection?: string;
-    rootItemCategoryId?: string;
-}
+import 'react/jsx-runtime';
+import 'react';
 
 interface CartState {
     cartHdrUid: number | string | undefined;
@@ -163,35 +81,6 @@ interface UseItemPriceOptions {
     /** Override the default queryFn (e.g. with a cached server action). */
     queryFn?: () => Promise<TPriceData>;
 }
-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.
- */
-declare const getItemPriceKey: (itemId: string | undefined, customerId: string | number | undefined, quantity?: number) => readonly ["price", string, string | number | undefined, number];
-/**
- * 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;
-    queryKey: readonly ["price", string, string | number | undefined, number];
-    queryFn: () => Promise<TPriceData>;
-};
 /**
  * Fetches and caches item pricing via the augur-api SDK.
  *
@@ -212,25 +101,6 @@ interface UseInvMastDocOptions {
     /** Override the default queryFn (e.g. with a cached server action). */
     queryFn?: () => Promise<TInvMastDoc>;
 }
-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.
- */
-declare const getInvMastDocKey: (invMastUid: number, itemId: string, includePricing: "Y" | "N") => readonly ["invMastDoc", number, string, "Y" | "N"];
-/**
- * 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;
-    queryKey: readonly ["invMastDoc", number, string, "Y" | "N"];
-    queryFn: () => Promise<TInvMastDoc>;
-};
 /**
  * Fetches and caches an inventory master document via the augur-api SDK.
  */
@@ -246,30 +116,6 @@ interface UseItemCategoryOptions {
     /** Override the default queryFn (e.g. with a cached server action). */
     queryFn?: () => Promise<TCategory>;
 }
-declare const CATEGORY_CACHE_OPTIONS: {
-    readonly staleTime: number;
-    readonly gcTime: number;
-};
-type ItemCategoryQueryKey = readonly [
-    "itemCategory",
-    number,
-    GetItemCategoryApiOptions | undefined
-];
-/**
- * Generates a consistent query key for item category queries.
- * Usable in both client hooks and server-side prefetch.
- */
-declare const getItemCategoryKey: (itemCategoryUid: number, apiOptions?: GetItemCategoryApiOptions) => ItemCategoryQueryKey;
-/**
- * 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;
-    queryKey: ItemCategoryQueryKey;
-    queryFn: () => Promise<TCategory>;
-};
 /**
  * Fetches and caches item category data via the augur-api SDK.
  */
@@ -283,17 +129,6 @@ interface UseInvMastOptions {
     enabled?: boolean;
     queryFn?: () => Promise<TItemDetails>;
 }
-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;
-    queryKey: readonly ["invMast", number, string];
-    queryFn: () => Promise<TItemDetails>;
-};
 declare function useInvMast(invMastUid: number, itemId: string, options?: UseInvMastOptions): {
     item: TItemDetails | undefined;
     isLoading: boolean;
@@ -304,13 +139,6 @@ interface UseInvMastStockOptions {
     enabled?: boolean;
     queryFn?: () => Promise<number>;
 }
-declare const getInvMastStockKey: (invMastUid: number | string) => readonly ["invMastStock", string | number];
-declare const getInvMastStockOptions: (api: AugurApiClient, invMastUid: number | string) => {
-    staleTime: number;
-    gcTime: number;
-    queryKey: readonly ["invMastStock", string | number];
-    queryFn: () => Promise<number>;
-};
 declare function useInvMastStock(invMastUid: number | string, options?: UseInvMastStockOptions): {
     qtyOnHand: number | null;
     loading: boolean;
@@ -320,40 +148,26 @@ declare function useInvMastStock(invMastUid: number | string, options?: UseInvMa
 type ProductCategoryResponse = {
     itemCategoryDesc: string;
     childrenTotal: number;
-    children: TProductCategory[];
+    children: unknown[];
     categoryImage: string | null;
 };
 interface UseProductCategoryOptions {
     enabled?: boolean;
     queryFn?: () => Promise<ProductCategoryResponse>;
 }
-declare const getProductCategoryKey: (itemCategoryUid: number | string | null) => readonly ["productCategory", string | number | null];
-declare const getProductCategoryOptions: (api: AugurApiClient, itemCategoryUid: number | string) => {
-    staleTime: number;
-    gcTime: number;
-    queryKey: readonly ["productCategory", string | number | null];
-    queryFn: () => Promise<ProductCategoryResponse>;
-};
 declare function useProductCategory(itemCategoryUid: number | string | null, options?: UseProductCategoryOptions): {
+    loading: boolean;
+    error: Error | null;
     childrenTotal: number;
     itemCategoryDesc: string;
-    productCategories: TProductCategory[] | null;
+    productCategories: unknown[] | null;
     productCategoryImage: string | null;
-    loading: boolean;
-    error: Error | null;
 };
 
 interface UseItemDetailsOptions {
     enabled?: boolean;
     queryFn?: () => Promise<TItemDetails>;
 }
-declare const getItemDetailsKey: (itemId: number | string) => readonly ["itemDetails", string | number];
-declare const getItemDetailsOptions: (api: AugurApiClient, itemId: number | string) => {
-    staleTime: number;
-    gcTime: number;
-    queryKey: readonly ["itemDetails", string | number];
-    queryFn: () => Promise<TItemDetails>;
-};
 declare function useItemDetails(itemId: number | string | undefined, options?: UseItemDetailsOptions): {
     itemCategoryUid: number | null | undefined;
     itemDetails: TItemDetails | null;
@@ -367,13 +181,6 @@ interface UseItemAttributesOptions {
         attributes: TAttribute[];
     }>;
 }
-declare const getItemAttributesKey: (itemCategoryUid: number | string | null) => readonly ["itemAttributes", string | number | null];
-declare const getItemAttributesOptions: (api: AugurApiClient, itemCategoryUid: number | string) => {
-    staleTime: number;
-    gcTime: number;
-    queryKey: readonly ["itemAttributes", string | number | null];
-    queryFn: () => Promise<any>;
-};
 declare function useItemAttributes(itemCategoryUid: number | string | null, options?: UseItemAttributesOptions): {
     attributes: any;
     loading: boolean;
@@ -381,33 +188,19 @@ declare function useItemAttributes(itemCategoryUid: number | string | null, opti
 };
 
 type ProductSearchResponse = {
-    items: TProductItem[];
+    items: unknown[];
     totalResults: number;
 };
 interface UseProductSearchOptions {
     /** Override the default queryFn (e.g. with a cached server action). */
     queryFn?: () => Promise<ProductSearchResponse>;
 }
-/**
- * Generates a consistent query key for product search queries.
- */
-declare const getProductSearchKey: (pageData: PageData) => readonly ["productSearch", string, number, number, string, number | undefined];
-/**
- * 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;
-    queryKey: readonly ["productSearch", string, number, number, string, number | undefined];
-    queryFn: () => Promise<ProductSearchResponse>;
-};
 /**
  * Searches products via the augur-api OpenSearch endpoint.
  * Replaces the ampro-online pattern of fetching from a Next.js API route.
  */
 declare function useProductSearch(pageData: PageData, options?: UseProductSearchOptions): {
-    productItems: TProductItem[] | null;
+    productItems: unknown[] | null;
     total: number;
     loading: boolean;
     error: Error | null;
@@ -420,20 +213,6 @@ interface UseSearchSuggestionsOptions {
     /** Override the default queryFn (e.g. with a cached server action). */
     queryFn?: () => Promise<SearchSuggestionsResponse>;
 }
-/**
- * Generates a consistent query key for search suggestion queries.
- */
-declare const getSearchSuggestionsKey: (query: string, limit: number, offset: number) => readonly ["searchSuggestions", string, number, number];
-/**
- * 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;
-    queryKey: readonly ["searchSuggestions", string, number, number];
-    queryFn: () => Promise<SearchSuggestionsResponse>;
-};
 /**
  * Fetches search suggestions via the augur-api OpenSearch endpoint.
  * Replaces the ampro-online pattern of fetching from a Next.js API route.
@@ -450,17 +229,17 @@ type CartLineInput = Pick<TCartLine, "invMastUid" | "quantity" | "unitOfMeasure"
 };
 /** Site-specific callbacks injected into useCartActions. */
 interface CartActionCallbacks {
-    /** Add items to cart via API. Returns true on success. */
+    /** Add items to cart via API. Truthy = success, falsy = failure. */
     addToCart: (cartHdrUid: number, items: Array<{
         cartHdrUid: number;
         invMastUid: number;
         quantity: number;
         unitOfMeasure: string;
-    }>) => Promise<boolean>;
-    /** Update cart lines via API. Returns true on success. */
-    updateCartLines: (cartHdrUid: number, lines: TCartLine[]) => Promise<boolean>;
-    /** Delete all items from cart via API. Returns true on success. */
-    deleteItemsFromCart: (cartHdrUid: number) => Promise<boolean>;
+    }>) => Promise<boolean | undefined | void>;
+    /** Update cart lines via API. Truthy = success, falsy = failure. */
+    updateCartLines: (cartHdrUid: number, lines: TCartLine[]) => Promise<boolean | undefined | void>;
+    /** Delete all items from cart via API. Truthy = success, falsy = failure. */
+    deleteItemsFromCart: (cartHdrUid: number) => Promise<boolean | undefined | void>;
     /** Optional toast notification callback. */
     toast?: {
         info?: (message: string) => void;
@@ -513,17 +292,17 @@ interface CartSessionInfo {
     /** User's ID (e.g., Joomla user ID). Undefined if not authenticated. */
     userId?: string | number;
     /** Cart header UID from the auth session, if available. */
-    cartHdrUid?: number;
+    cartHdrUid?: number | string;
 }
 /** Site-specific callbacks injected into useCartInitialization. */
 interface CartInitCallbacks {
     /** Look up or create a cart header. Returns { cartHdrUid, cartToken? }. */
     cartHdrLookup: (userId: string | number, cartToken: string) => Promise<{
         cartHdrUid: number;
-        cartToken?: string;
-    } | null>;
+        cartToken?: string | null;
+    } | null | undefined>;
     /** Fetch cart line items for a given cart header UID. */
-    getCartLines: (cartHdrUid: number) => Promise<TCartLine[]>;
+    getCartLines: (cartHdrUid: number) => Promise<TCartLine[] | undefined>;
     /** Get the current cart token from cookies. */
     getCartToken: () => string | null;
     /** Save cart token to cookies. */
@@ -593,6 +372,8 @@ interface CartPricingResult {
 }
 interface UseCartPricingOptions {
     customerId?: string | number;
+    /** Override per-item price fetching (e.g. with a server action). */
+    queryFn?: (itemId: string, customerId: string | number, quantity: number) => Promise<TPriceData>;
 }
 /**
  * Centralized hook for cart/checkout pricing.
@@ -602,24 +383,6 @@ interface UseCartPricingOptions {
  * identical calls across components.
  */
 declare function useCartPricing(options?: UseCartPricingOptions): CartPricingResult;
-/**
- * Get cart pricing query options for prefetching or parent components.
- */
-declare function getCartPricingQueryOptions(api: ReturnType<typeof useAugurApi>, cartLines: Array<{
-    itemId: string;
-    quantity: number;
-}>, customerId: string | number | undefined): {
-    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>;
-}[];
 
 interface UsePaginationPrefetchOptions {
     /** Query key for the paginated data */
@@ -643,34 +406,30 @@ declare const usePaginationPrefetch: ({ queryKey, queryFn, pageSize, staleTime,
     handlePaginationHover: (page: number) => () => void;
 };
 
-interface CategoryItemsInfiniteResponse {
-    data: TProductItem[];
-    total: number;
-    nextCursor?: number;
-}
 interface UseCategoryItemsInfiniteOptions {
     enabled?: boolean;
+    /** Override the default queryFn (e.g. with a server action). */
+    queryFn?: (context: {
+        pageParam: unknown;
+    }) => Promise<InfiniteScrollPage>;
 }
-declare const getCategoryItemsInfiniteKey: (itemCategoryUid: number, itemsFilters: TItemsFilters) => readonly ["categoryItemsInfinite", number, string];
 /**
  * Infinite scroll for category product listings.
  * Fetches pages of products via the augur-api SDK.
  */
-declare function useCategoryItemsInfinite(itemCategoryUid: number, itemsFilters: TItemsFilters, options?: UseCategoryItemsInfiniteOptions): _tanstack_react_query.UseInfiniteQueryResult<_tanstack_react_query.InfiniteData<CategoryItemsInfiniteResponse, unknown>, Error>;
+declare function useCategoryItemsInfinite(itemCategoryUid: number, itemsFilters: TItemsFilters, options?: UseCategoryItemsInfiniteOptions): _tanstack_react_query.UseInfiniteQueryResult<_tanstack_react_query.InfiniteData<InfiniteScrollPage, unknown>, Error>;
 
-interface ItemSearchInfiniteResponse {
-    data: TProductItem[];
-    total: number;
-    nextCursor?: number;
-}
 interface UseItemSearchInfiniteOptions {
     enabled?: boolean;
+    /** Override the default queryFn (e.g. with a server action). */
+    queryFn?: (context: {
+        pageParam: unknown;
+    }) => Promise<InfiniteScrollPage>;
 }
-declare const getItemSearchInfiniteKey: (itemsFilters: TItemsFilters, itemCategoryUid?: number | string) => readonly ["itemSearchInfinite", string, string | number | undefined];
 /**
  * Infinite scroll for search results.
  * Fetches pages of products via the augur-api SDK OpenSearch endpoint.
  */
-declare function useItemSearchInfinite(itemsFilters: TItemsFilters, itemCategoryUid?: number | string, options?: UseItemSearchInfiniteOptions): _tanstack_react_query.UseInfiniteQueryResult<_tanstack_react_query.InfiniteData<ItemSearchInfiniteResponse, unknown>, Error>;
+declare function useItemSearchInfinite(itemsFilters: TItemsFilters, itemCategoryUid?: number | string, options?: UseItemSearchInfiniteOptions): _tanstack_react_query.UseInfiniteQueryResult<_tanstack_react_query.InfiniteData<InfiniteScrollPage, unknown>, Error>;
 
-export { type AugurApiClient, AugurHooksProvider, CATEGORY_CACHE_OPTIONS, type CartActionCallbacks, type CartInitCallbacks, type CartPriceData, type CartPricingResult, type CartSessionInfo, type GetItemCategoryApiOptions, INV_MAST_CACHE_OPTIONS, INV_MAST_DOC_CACHE_OPTIONS, PRICE_CACHE_OPTIONS, type PageData, type SearchSuggestion, type SearchSuggestionsResponse, getCartPricingQueryOptions, getCategoryItemsInfiniteKey, getInvMastDocKey, getInvMastDocOptions, getInvMastKey, getInvMastOptions, getInvMastStockKey, getInvMastStockOptions, getItemAttributesKey, getItemAttributesOptions, getItemCategoryKey, getItemCategoryOptions, getItemDetailsKey, getItemDetailsOptions, getItemPriceKey, getItemPriceOptions, getItemSearchInfiniteKey, getProductCategoryKey, getProductCategoryOptions, getProductSearchKey, getProductSearchOptions, getSearchSuggestionsKey, getSearchSuggestionsOptions, useAugurApi, 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 };
+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 };