@simpleapps-com/augur-hooks 0.1.3 → 0.1.5

package/dist/server-ZsiDw2HO.d.ts

@@ -0,0 +1,275 @@
+import * as _simpleapps_com_augur_utils from '@simpleapps-com/augur-utils';
+import { TPriceData, TInvMastDoc, TCategory, TItemDetails, TProductCategory, TProductItem, TItemsFilters } from '@simpleapps-com/augur-utils';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+/**
+ * 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;
+}
+
+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>;
+};
+
+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>;
+};
+
+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>;
+};
+
+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 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>;
+};
+
+type ProductCategoryResponse = {
+    itemCategoryDesc: string;
+    childrenTotal: number;
+    children: TProductCategory[];
+    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;
+    queryKey: readonly ["productCategory", string | number | null];
+    queryFn: () => Promise<ProductCategoryResponse>;
+};
+
+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 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>;
+};
+
+type ProductSearchResponse = {
+    items: TProductItem[];
+    totalResults: number;
+};
+/**
+ * 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>;
+};
+
+declare const SEARCH_SUGGESTIONS_CACHE_OPTIONS: {
+    readonly staleTime: number;
+    readonly gcTime: number;
+};
+/**
+ * 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>;
+};
+
+/**
+ * Get cart pricing query options for prefetching or parent components.
+ */
+declare function getCartPricingQueryOptions(api: AugurApiClient, 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>;
+}[];
+
+declare const getCategoryItemsInfiniteKey: (itemCategoryUid: number, itemsFilters: TItemsFilters) => readonly ["categoryItemsInfinite", number, string];
+
+declare const getItemSearchInfiniteKey: (itemsFilters: TItemsFilters, itemCategoryUid?: number | string) => readonly ["itemSearchInfinite", string, string | number | undefined];
+
+export { type AugurApiClient as A, getSearchSuggestionsKey as B, CATEGORY_CACHE_OPTIONS as C, getSearchSuggestionsOptions as D, useAugurApi as E, type GetItemCategoryApiOptions as G, INV_MAST_CACHE_OPTIONS as I, type PageData as P, type SearchSuggestionsResponse as S, type SearchSuggestion as a, AugurHooksProvider as b, INV_MAST_DOC_CACHE_OPTIONS as c, PRICE_CACHE_OPTIONS as d, SEARCH_SUGGESTIONS_CACHE_OPTIONS as e, getCategoryItemsInfiniteKey as f, getCartPricingQueryOptions as g, getInvMastDocKey as h, getInvMastDocOptions as i, getInvMastKey as j, getInvMastOptions as k, getInvMastStockKey as l, getInvMastStockOptions as m, getItemAttributesKey as n, getItemAttributesOptions as o, getItemCategoryKey as p, getItemCategoryOptions as q, getItemDetailsKey as r, getItemDetailsOptions as s, getItemPriceKey as t, getItemPriceOptions as u, getItemSearchInfiniteKey as v, getProductCategoryKey as w, getProductCategoryOptions as x, getProductSearchKey as y, getProductSearchOptions as z };

package/dist/server.cjs

@@ -0,0 +1,61 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+var _chunkMRQREI4Lcjs = require('./chunk-MRQREI4L.cjs');
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+exports.CATEGORY_CACHE_OPTIONS = _chunkMRQREI4Lcjs.CATEGORY_CACHE_OPTIONS; exports.INV_MAST_CACHE_OPTIONS = _chunkMRQREI4Lcjs.INV_MAST_CACHE_OPTIONS; exports.INV_MAST_DOC_CACHE_OPTIONS = _chunkMRQREI4Lcjs.INV_MAST_DOC_CACHE_OPTIONS; exports.PRICE_CACHE_OPTIONS = _chunkMRQREI4Lcjs.PRICE_CACHE_OPTIONS; exports.SEARCH_SUGGESTIONS_CACHE_OPTIONS = _chunkMRQREI4Lcjs.SEARCH_SUGGESTIONS_CACHE_OPTIONS; exports.getCartPricingQueryOptions = _chunkMRQREI4Lcjs.getCartPricingQueryOptions; exports.getCategoryItemsInfiniteKey = _chunkMRQREI4Lcjs.getCategoryItemsInfiniteKey; exports.getInvMastDocKey = _chunkMRQREI4Lcjs.getInvMastDocKey; exports.getInvMastDocOptions = _chunkMRQREI4Lcjs.getInvMastDocOptions; exports.getInvMastKey = _chunkMRQREI4Lcjs.getInvMastKey; exports.getInvMastOptions = _chunkMRQREI4Lcjs.getInvMastOptions; exports.getInvMastStockKey = _chunkMRQREI4Lcjs.getInvMastStockKey; exports.getInvMastStockOptions = _chunkMRQREI4Lcjs.getInvMastStockOptions; exports.getItemAttributesKey = _chunkMRQREI4Lcjs.getItemAttributesKey; exports.getItemAttributesOptions = _chunkMRQREI4Lcjs.getItemAttributesOptions; exports.getItemCategoryKey = _chunkMRQREI4Lcjs.getItemCategoryKey; exports.getItemCategoryOptions = _chunkMRQREI4Lcjs.getItemCategoryOptions; exports.getItemDetailsKey = _chunkMRQREI4Lcjs.getItemDetailsKey; exports.getItemDetailsOptions = _chunkMRQREI4Lcjs.getItemDetailsOptions; exports.getItemPriceKey = _chunkMRQREI4Lcjs.getItemPriceKey; exports.getItemPriceOptions = _chunkMRQREI4Lcjs.getItemPriceOptions; exports.getItemSearchInfiniteKey = _chunkMRQREI4Lcjs.getItemSearchInfiniteKey; exports.getProductCategoryKey = _chunkMRQREI4Lcjs.getProductCategoryKey; exports.getProductCategoryOptions = _chunkMRQREI4Lcjs.getProductCategoryOptions; exports.getProductSearchKey = _chunkMRQREI4Lcjs.getProductSearchKey; exports.getProductSearchOptions = _chunkMRQREI4Lcjs.getProductSearchOptions; exports.getSearchSuggestionsKey = _chunkMRQREI4Lcjs.getSearchSuggestionsKey; exports.getSearchSuggestionsOptions = _chunkMRQREI4Lcjs.getSearchSuggestionsOptions;
+//# sourceMappingURL=server.cjs.map

package/dist/server.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/augur-packages/augur-packages/packages/augur-hooks/dist/server.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,+gEAAC","file":"/home/runner/work/augur-packages/augur-packages/packages/augur-hooks/dist/server.cjs"}

package/dist/server.d.cts

@@ -0,0 +1,4 @@
+export { A as AugurApiClient, C as CATEGORY_CACHE_OPTIONS, I as INV_MAST_CACHE_OPTIONS, c as INV_MAST_DOC_CACHE_OPTIONS, d as PRICE_CACHE_OPTIONS, P as PageData, e as SEARCH_SUGGESTIONS_CACHE_OPTIONS, g as getCartPricingQueryOptions, f as getCategoryItemsInfiniteKey, h as getInvMastDocKey, i as getInvMastDocOptions, j as getInvMastKey, k as getInvMastOptions, l as getInvMastStockKey, m as getInvMastStockOptions, n as getItemAttributesKey, o as getItemAttributesOptions, p as getItemCategoryKey, q as getItemCategoryOptions, r as getItemDetailsKey, s as getItemDetailsOptions, t as getItemPriceKey, u as getItemPriceOptions, v as getItemSearchInfiniteKey, w as getProductCategoryKey, x as getProductCategoryOptions, y as getProductSearchKey, z as getProductSearchOptions, B as getSearchSuggestionsKey, D as getSearchSuggestionsOptions } from './server-ZsiDw2HO.cjs';
+import '@simpleapps-com/augur-utils';
+import 'react/jsx-runtime';
+import 'react';

package/dist/server.d.ts

@@ -0,0 +1,4 @@
+export { A as AugurApiClient, C as CATEGORY_CACHE_OPTIONS, I as INV_MAST_CACHE_OPTIONS, c as INV_MAST_DOC_CACHE_OPTIONS, d as PRICE_CACHE_OPTIONS, P as PageData, e as SEARCH_SUGGESTIONS_CACHE_OPTIONS, g as getCartPricingQueryOptions, f as getCategoryItemsInfiniteKey, h as getInvMastDocKey, i as getInvMastDocOptions, j as getInvMastKey, k as getInvMastOptions, l as getInvMastStockKey, m as getInvMastStockOptions, n as getItemAttributesKey, o as getItemAttributesOptions, p as getItemCategoryKey, q as getItemCategoryOptions, r as getItemDetailsKey, s as getItemDetailsOptions, t as getItemPriceKey, u as getItemPriceOptions, v as getItemSearchInfiniteKey, w as getProductCategoryKey, x as getProductCategoryOptions, y as getProductSearchKey, z as getProductSearchOptions, B as getSearchSuggestionsKey, D as getSearchSuggestionsOptions } from './server-ZsiDw2HO.js';
+import '@simpleapps-com/augur-utils';
+import 'react/jsx-runtime';
+import 'react';

package/dist/server.js

@@ -0,0 +1,61 @@
+import {
+  CATEGORY_CACHE_OPTIONS,
+  INV_MAST_CACHE_OPTIONS,
+  INV_MAST_DOC_CACHE_OPTIONS,
+  PRICE_CACHE_OPTIONS,
+  SEARCH_SUGGESTIONS_CACHE_OPTIONS,
+  getCartPricingQueryOptions,
+  getCategoryItemsInfiniteKey,
+  getInvMastDocKey,
+  getInvMastDocOptions,
+  getInvMastKey,
+  getInvMastOptions,
+  getInvMastStockKey,
+  getInvMastStockOptions,
+  getItemAttributesKey,
+  getItemAttributesOptions,
+  getItemCategoryKey,
+  getItemCategoryOptions,
+  getItemDetailsKey,
+  getItemDetailsOptions,
+  getItemPriceKey,
+  getItemPriceOptions,
+  getItemSearchInfiniteKey,
+  getProductCategoryKey,
+  getProductCategoryOptions,
+  getProductSearchKey,
+  getProductSearchOptions,
+  getSearchSuggestionsKey,
+  getSearchSuggestionsOptions
+} from "./chunk-V3RMLU3V.js";
+export {
+  CATEGORY_CACHE_OPTIONS,
+  INV_MAST_CACHE_OPTIONS,
+  INV_MAST_DOC_CACHE_OPTIONS,
+  PRICE_CACHE_OPTIONS,
+  SEARCH_SUGGESTIONS_CACHE_OPTIONS,
+  getCartPricingQueryOptions,
+  getCategoryItemsInfiniteKey,
+  getInvMastDocKey,
+  getInvMastDocOptions,
+  getInvMastKey,
+  getInvMastOptions,
+  getInvMastStockKey,
+  getInvMastStockOptions,
+  getItemAttributesKey,
+  getItemAttributesOptions,
+  getItemCategoryKey,
+  getItemCategoryOptions,
+  getItemDetailsKey,
+  getItemDetailsOptions,
+  getItemPriceKey,
+  getItemPriceOptions,
+  getItemSearchInfiniteKey,
+  getProductCategoryKey,
+  getProductCategoryOptions,
+  getProductSearchKey,
+  getProductSearchOptions,
+  getSearchSuggestionsKey,
+  getSearchSuggestionsOptions
+};
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simpleapps-com/augur-hooks",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Cross-platform React Query hooks and Zustand stores for Augur ecommerce sites",
   "license": "MIT",
   "repository": {
@@ -15,6 +15,11 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.js",
+      "require": "./dist/server.cjs"
+    },
     "./web": {
       "types": "./dist/web.d.ts",
       "import": "./dist/web.js",
@@ -26,10 +31,10 @@
     "dist"
   ],
   "dependencies": {
-    "@simpleapps-com/augur-utils": "0.1.3"
+    "@simpleapps-com/augur-utils": "0.1.5"
   },
   "peerDependencies": {
-    "@simpleapps-com/augur-api": "^0.9.0",
+    "@simpleapps-com/augur-api": "^0.9.6",
     "@tanstack/react-query": "^5.80.0",
     "@tanstack/react-query-persist-client": "^5.80.0",
     "react": "^19.0.0",
@@ -38,7 +43,6 @@
   "devDependencies": {
     "@tanstack/react-query": "^5.80.0",
     "@testing-library/react": "^16.3.2",
-    "@testing-library/react-hooks": "^8.0.1",
     "@types/node": "^22.0.0",
     "@types/react": "^19.0.0",
     "@types/react-dom": "^19.0.0",