@simpleapps-com/augur-hooks 2.0.22 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/llms.txt CHANGED
@@ -2,18 +2,15 @@
2
2
 
3
3
  > Cross-platform React Query hooks and Zustand stores for Augur ecommerce sites
4
4
 
5
- Version: 2.0.9
5
+ Version: 2.0.21
6
6
 
7
7
  ## @simpleapps-com/augur-hooks
8
8
 
9
- - value: AugurApiClient
10
9
  - value: AugurAuthContext
11
- - value: AugurCallbacks
12
10
  - value: AugurHooksProvider
13
11
  - value: AugurSiteConfig
14
12
  - value: AugurSiteDefaults
15
13
  - value: AugurSiteFormatting
16
- - value: BatchInvMastDocParam
17
14
  - value: CacheConfig
18
15
  - value: CacheProvider
19
16
  - value: CacheTierConfig
@@ -21,9 +18,7 @@ Version: 2.0.9
21
18
  - value: DerivePriceInput
22
19
  - value: DerivedPrice
23
20
  - value: EdgeCacheValue
24
- - value: GetItemCategoryApiOptions
25
21
  - value: InfiniteScrollPage
26
- - value: PageData
27
22
  - value: PersistenceConfig
28
23
  - value: ProxyMutationOptions
29
24
  - value: ProxyQueryOptions
@@ -31,58 +26,17 @@ Version: 2.0.9
31
26
  - value: ResolvedStock
32
27
  - value: SearchSuggestion
33
28
  - value: SearchSuggestionsResponse
34
- - function: createSiteHooks - Creates a pre-configured provider component and re-exports all hooks.
35
29
  - function: executeBatchQuery
36
- - function: getBatchInvMastDocKey
37
- - value: getBatchInvMastDocOptions
38
- - value: getCartPricingQueryOptions
39
- - value: getCategoryItemsInfiniteKey
40
- - value: getCategoryItemsInfiniteOptions
41
- - value: getCustomerInvoiceDetailKey
42
- - value: getCustomerInvoicesKey
43
- - value: getCustomerOrderDetailKey
44
- - value: getCustomerOrdersKey
45
- - value: getCustomerQuoteDetailKey
46
- - value: getCustomerQuotesKey
47
- - value: getInvMastDocKey
48
- - value: getInvMastDocOptions
49
- - value: getInvMastKey
50
- - value: getInvMastOptions
51
- - function: getInvMastStockKey
52
- - value: getInvMastStockOptions
53
- - value: getItemAttributesKey
54
- - value: getItemAttributesOptions
55
- - value: getItemCategoryKey
56
- - value: getItemCategoryOptions
57
- - value: getItemDetailsKey
58
- - value: getItemDetailsOptions
59
- - value: getItemPriceKey
60
- - value: getItemPriceOptions
61
- - value: getItemSearchInfiniteKey
62
- - value: getItemSearchInfiniteOptions
63
- - value: getJoomlaContentKey
64
- - value: getJoomlaContentListKey
65
- - value: getJoomlaContentListOptions
66
- - value: getJoomlaContentOptions
67
- - value: getJoomlaMenuDocKey
68
- - value: getJoomlaMenuDocOptions
69
- - value: getJoomlaMenuKey
70
- - value: getJoomlaMenuOptions
71
- - value: getProductCategoryKey
72
- - value: getProductCategoryOptions
73
- - value: getProductSearchKey
74
- - value: getProductSearchOptions
75
- - value: getSearchSuggestionsKey
76
- - value: getSearchSuggestionsOptions
30
+ - function: getCartPricingQueryOptions
77
31
  - value: getStockKey
78
32
  - value: getStockOptions
79
- - value: useAugurApi
33
+ - function: useAugurApi
34
+ - value: useAugurApiOptional
80
35
  - value: useAugurAuth
81
36
  - value: useAugurCache
82
37
  - value: useAugurOptions
83
38
  - function: useAugurPersistence - Returns a fully configured `persistOptions` object for use with
84
39
  - value: useAugurSite
85
- - function: useBatchInvMastDoc - Fetches and caches multiple inventory master documents in a single batch.
86
40
  - function: useCartActions - Optimistic cart actions hook with automatic rollback on failure.
87
41
  - const: useCartHdrUid - Select the current cart header UID.
88
42
  - function: useCartInitialization - Initialize cart state from session (authenticated) or cookie (guest).
@@ -91,44 +45,27 @@ Version: 2.0.9
91
45
  - function: useCartPricing - Centralized hook for cart/checkout pricing.
92
46
  - const: useCartQuantityTotal - Select the total quantity summed across all cart lines.
93
47
  - const: useCartStore - Zustand store for cart state. Prefer the individual selector hooks below for optimal re-renders.
94
- - function: useCategoryItemsInfinite - Infinite scroll for category product listings.
95
48
  - const: useClearCart - Get the `clearCart` action (stable reference).
96
- - function: useCustomerInvoices
97
- - function: useCustomerOrders
98
- - function: useCustomerQuotes
99
49
  - function: useDebounce - Debounces a rapidly-changing value.
100
50
  - function: useFormatPrice - Hook that returns a price formatter.
101
- - function: useInvMast
102
- - function: useInvMastDoc - Fetches and caches an inventory master document via the augur-api SDK.
103
- - function: useInvMastStock
104
- - function: useInvoiceDetail
105
- - function: useItemAttributes
106
- - function: useItemCategory - Fetches and caches item category data via the augur-api SDK.
107
- - function: useItemDetails
108
51
  - const: useItemFiltersStore - Zustand store for item list filters, sorting, and pagination state.
109
- - function: useItemPrice - Fetches and caches item pricing via the augur-api SDK.
110
- - function: useItemSearchInfinite - Infinite scroll for search results.
111
- - function: useJoomlaContent
112
- - function: useJoomlaContentList
113
- - function: useJoomlaMenu
114
- - function: useJoomlaMenuDoc
115
- - function: useOrderDetail
116
52
  - const: usePaginationPrefetch - Prefetch adjacent pages on hover for instant pagination.
117
- - function: useProductCategory
118
- - function: useProductSearch - Searches products via the augur-api OpenSearch endpoint.
119
- - function: useQuoteDetail
120
- - function: useSearchSuggestions - Fetches search suggestions via the augur-api OpenSearch endpoint.
53
+ - function: usePaymentFlow - Manages the full Element/Unified payment lifecycle:
121
54
  - const: useSetCartHdrUid - Get the `setCartHdrUid` action (stable reference).
122
55
  - const: useSetCartLines - Get the `setCartLines` action (stable reference). Also recomputes totals.
123
56
  - function: useStock - Fetches full TStock data and resolves it into a normalized stock object.
57
+ - type: AugurApiClient
124
58
  - type: BatchQueryConfig
125
59
  - type: CartActionCallbacks
126
60
  - type: CartInitCallbacks
127
61
  - type: CartPriceData
128
62
  - type: CartPricingResult
129
63
  - type: CartSessionInfo
130
- - type: CreateSiteHooksConfig
131
64
  - type: FormatPriceCallOptions
65
+ - type: GetItemCategoryApiOptions
66
+ - type: PageData
67
+ - type: PaymentBillingAddress
68
+ - type: PaymentFlowCallbacks
132
69
  - type: UseFormatPriceOptions
133
70
  - type: UseStockOptions
134
71
 
@@ -139,61 +76,19 @@ Version: 2.0.9
139
76
  - value: InfiniteScrollPage
140
77
  - function: createAugurOptions - Creates server-side query options proxy for prefetching.
141
78
  - function: executeBatchQuery
142
- - function: getBatchInvMastDocKey
143
- - value: getBatchInvMastDocOptions
144
- - value: getCartPricingQueryOptions
145
- - value: getCategoryItemsInfiniteKey
146
- - value: getCategoryItemsInfiniteOptions
147
- - value: getCustomerInvoiceDetailKey
148
- - value: getCustomerInvoicesKey
149
- - value: getCustomerOrderDetailKey
150
- - value: getCustomerOrdersKey
151
- - value: getCustomerQuoteDetailKey
152
- - value: getCustomerQuotesKey
153
- - value: getInvMastDocKey
154
- - value: getInvMastDocOptions
155
- - value: getInvMastKey
156
- - value: getInvMastOptions
157
- - function: getInvMastStockKey
158
- - value: getInvMastStockOptions
159
- - value: getItemAttributesKey
160
- - value: getItemAttributesOptions
161
- - value: getItemCategoryKey
162
- - value: getItemCategoryOptions
163
- - value: getItemDetailsKey
164
- - value: getItemDetailsOptions
165
- - value: getItemPriceKey
166
- - value: getItemPriceOptions
167
- - value: getItemSearchInfiniteKey
168
- - value: getItemSearchInfiniteOptions
169
- - value: getJoomlaContentKey
170
- - value: getJoomlaContentListKey
171
- - value: getJoomlaContentListOptions
172
- - value: getJoomlaContentOptions
173
- - value: getJoomlaMenuDocKey
174
- - value: getJoomlaMenuDocOptions
175
- - value: getJoomlaMenuKey
176
- - value: getJoomlaMenuOptions
177
- - value: getProductCategoryKey
178
- - value: getProductCategoryOptions
179
- - value: getProductSearchKey
180
- - value: getProductSearchOptions
79
+ - function: getCartPricingQueryOptions
181
80
  - const: getQueryClient - Returns a per-request singleton QueryClient for React Server Components.
182
- - value: getSearchSuggestionsKey
183
- - value: getSearchSuggestionsOptions
184
81
  - value: getStockKey
185
82
  - value: getStockOptions
186
83
  - value: stableStringify
187
84
  - type: AugurApiClient
188
- - type: AugurCallbacks
189
- - type: BatchInvMastDocParam
190
85
  - type: BatchQueryConfig
191
86
  - type: PageData
192
87
 
193
88
  ## @simpleapps-com/augur-hooks/web
194
89
 
195
90
  - function: MobileProvider - Optional provider that tracks hydration state.
196
- - function: useImageWithFallback
91
+ - function: useImageWithFallback - Preloads an agr.media image and shows a fallback while loading.
197
92
  - function: useIsHydrated - Returns true only after the client has hydrated.
198
93
  - function: useIsMobile - Returns whether the screen is mobile-sized.
199
94
  - const: useMobileOptimizedIntersection - IntersectionObserver hook with mobile-optimized root margins.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@simpleapps-com/augur-hooks",
3
- "version": "2.0.22",
3
+ "version": "2.1.0",
4
4
  "description": "Cross-platform React Query hooks and Zustand stores for Augur ecommerce sites",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -33,8 +33,8 @@
33
33
  "llms.txt"
34
34
  ],
35
35
  "dependencies": {
36
- "@simpleapps-com/augur-core": "2.0.22",
37
- "@simpleapps-com/augur-utils": "2.0.22"
36
+ "@simpleapps-com/augur-core": "2.1.0",
37
+ "@simpleapps-com/augur-utils": "2.1.0"
38
38
  },
39
39
  "peerDependencies": {
40
40
  "@simpleapps-com/augur-api": "^2026.3.3",
@@ -1,44 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/web/use-image-with-fallback.ts
2
- var _react = require('react');
3
- var _augurutils = require('@simpleapps-com/augur-utils');
4
- function useImageWithFallback(config, imagePath, options) {
5
- const defaultSrc = _augurutils.getDefaultImageUrl.call(void 0, config, options);
6
- const realSrc = imagePath ? _augurutils.getImageUrl.call(void 0, config, imagePath) : "";
7
- const [src, setSrc] = _react.useState.call(void 0, defaultSrc);
8
- const [isLoading, setIsLoading] = _react.useState.call(void 0, !!realSrc);
9
- const [hasError, setHasError] = _react.useState.call(void 0, false);
10
- const imageRef = _react.useRef.call(void 0, null);
11
- _react.useEffect.call(void 0, () => {
12
- if (!realSrc) {
13
- setSrc(defaultSrc);
14
- setIsLoading(false);
15
- setHasError(false);
16
- return;
17
- }
18
- setSrc(defaultSrc);
19
- setIsLoading(true);
20
- setHasError(false);
21
- const img = new Image();
22
- imageRef.current = img;
23
- img.onload = () => {
24
- setSrc(realSrc);
25
- setIsLoading(false);
26
- };
27
- img.onerror = () => {
28
- setIsLoading(false);
29
- setHasError(true);
30
- };
31
- img.src = realSrc;
32
- return () => {
33
- img.onload = null;
34
- img.onerror = null;
35
- imageRef.current = null;
36
- };
37
- }, [realSrc, defaultSrc]);
38
- return { src, isLoading, hasError };
39
- }
40
-
41
-
42
-
43
- exports.useImageWithFallback = useImageWithFallback;
44
- //# sourceMappingURL=chunk-AXCNTEAB.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["/home/runner/work/augur-packages/augur-packages/packages/augur-hooks/dist/chunk-AXCNTEAB.cjs","../src/web/use-image-with-fallback.ts"],"names":[],"mappings":"AAAA;ACEA,8BAA4C;AAE5C,yDAAgD;AAezC,SAAS,oBAAA,CACd,MAAA,EACA,SAAA,EACA,OAAA,EAC4B;AAC5B,EAAA,MAAM,WAAA,EAAa,4CAAA,MAAmB,EAAQ,OAAO,CAAA;AACrD,EAAA,MAAM,QAAA,EAAU,UAAA,EAAY,qCAAA,MAAY,EAAQ,SAAS,EAAA,EAAI,EAAA;AAE7D,EAAA,MAAM,CAAC,GAAA,EAAK,MAAM,EAAA,EAAI,6BAAA,UAAmB,CAAA;AACzC,EAAA,MAAM,CAAC,SAAA,EAAW,YAAY,EAAA,EAAI,6BAAA,CAAU,CAAC,OAAO,CAAA;AACpD,EAAA,MAAM,CAAC,QAAA,EAAU,WAAW,EAAA,EAAI,6BAAA,KAAc,CAAA;AAC9C,EAAA,MAAM,SAAA,EAAW,2BAAA,IAAoC,CAAA;AAErD,EAAA,8BAAA,CAAU,EAAA,GAAM;AACd,IAAA,GAAA,CAAI,CAAC,OAAA,EAAS;AACZ,MAAA,MAAA,CAAO,UAAU,CAAA;AACjB,MAAA,YAAA,CAAa,KAAK,CAAA;AAClB,MAAA,WAAA,CAAY,KAAK,CAAA;AACjB,MAAA,MAAA;AAAA,IACF;AAEA,IAAA,MAAA,CAAO,UAAU,CAAA;AACjB,IAAA,YAAA,CAAa,IAAI,CAAA;AACjB,IAAA,WAAA,CAAY,KAAK,CAAA;AAEjB,IAAA,MAAM,IAAA,EAAM,IAAI,KAAA,CAAM,CAAA;AACtB,IAAA,QAAA,CAAS,QAAA,EAAU,GAAA;AAEnB,IAAA,GAAA,CAAI,OAAA,EAAS,CAAA,EAAA,GAAM;AACjB,MAAA,MAAA,CAAO,OAAO,CAAA;AACd,MAAA,YAAA,CAAa,KAAK,CAAA;AAAA,IACpB,CAAA;AAEA,IAAA,GAAA,CAAI,QAAA,EAAU,CAAA,EAAA,GAAM;AAClB,MAAA,YAAA,CAAa,KAAK,CAAA;AAClB,MAAA,WAAA,CAAY,IAAI,CAAA;AAAA,IAClB,CAAA;AAEA,IAAA,GAAA,CAAI,IAAA,EAAM,OAAA;AAEV,IAAA,OAAO,CAAA,EAAA,GAAM;AACX,MAAA,GAAA,CAAI,OAAA,EAAS,IAAA;AACb,MAAA,GAAA,CAAI,QAAA,EAAU,IAAA;AACd,MAAA,QAAA,CAAS,QAAA,EAAU,IAAA;AAAA,IACrB,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,OAAA,EAAS,UAAU,CAAC,CAAA;AAExB,EAAA,OAAO,EAAE,GAAA,EAAK,SAAA,EAAW,SAAS,CAAA;AACpC;AD5BA;AACA;AACE;AACF,oDAAC","file":"/home/runner/work/augur-packages/augur-packages/packages/augur-hooks/dist/chunk-AXCNTEAB.cjs","sourcesContent":[null,"\"use client\";\n\nimport { useEffect, useState, useRef } from \"react\";\nimport type { ImageConfig, ImageUrlOptions } from \"@simpleapps-com/augur-utils\";\nimport { getImageUrl, getDefaultImageUrl } from \"@simpleapps-com/augur-utils\";\n\ninterface UseImageWithFallbackResult {\n src: string;\n isLoading: boolean;\n hasError: boolean;\n}\n\n/**\n * Preloads an agr.media image and shows a fallback while loading.\n *\n * 1. Returns the default image immediately.\n * 2. Preloads the real image via `new Image()`.\n * 3. Swaps to the real URL on success; keeps the fallback on error.\n */\nexport function useImageWithFallback(\n config: ImageConfig,\n imagePath: string | undefined,\n options?: ImageUrlOptions,\n): UseImageWithFallbackResult {\n const defaultSrc = getDefaultImageUrl(config, options);\n const realSrc = imagePath ? getImageUrl(config, imagePath) : \"\";\n\n const [src, setSrc] = useState(defaultSrc);\n const [isLoading, setIsLoading] = useState(!!realSrc);\n const [hasError, setHasError] = useState(false);\n const imageRef = useRef<HTMLImageElement | null>(null);\n\n useEffect(() => {\n if (!realSrc) {\n setSrc(defaultSrc);\n setIsLoading(false);\n setHasError(false);\n return;\n }\n\n setSrc(defaultSrc);\n setIsLoading(true);\n setHasError(false);\n\n const img = new Image();\n imageRef.current = img;\n\n img.onload = () => {\n setSrc(realSrc);\n setIsLoading(false);\n };\n\n img.onerror = () => {\n setIsLoading(false);\n setHasError(true);\n };\n\n img.src = realSrc;\n\n return () => {\n img.onload = null;\n img.onerror = null;\n imageRef.current = null;\n };\n }, [realSrc, defaultSrc]);\n\n return { src, isLoading, hasError };\n}\n"]}