@simpleapps-com/augur-hooks 1.0.5 → 1.0.7

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/dist/index.d.cts CHANGED
@@ -3,7 +3,9 @@ export { d as AugurHooksProvider, e as BatchQueryConfig, f as executeBatchQuery,
3
3
  import { InfiniteScrollPage, CacheConfig, AugurAuthContext } from '@simpleapps-com/augur-core';
4
4
  export { AugurAuthContext, CacheConfig, CacheProvider, CacheTierConfig, DeepQueryOptions, EdgeCacheValue, InfiniteScrollPage, ProxyMutationOptions, ProxyQueryOptions } from '@simpleapps-com/augur-core';
5
5
  import * as zustand from 'zustand';
6
+ import * as _simpleapps_com_augur_utils from '@simpleapps-com/augur-utils';
6
7
  import { TCartLine, TItemsFilters, TPriceData, TInvMastDoc, TCategory, TItemDetails, TAttribute, TJoomlaContent, TJoomlaContentFilters, MenuItem, TMenuFilters, ImageConfig, ImageUrlOptions } from '@simpleapps-com/augur-utils';
8
+ export { DerivePriceInput, DerivedPrice } from '@simpleapps-com/augur-utils';
7
9
  import * as _tanstack_react_query from '@tanstack/react-query';
8
10
  import { QueryKey } from '@tanstack/react-query';
9
11
  import { ReactNode, createElement } from 'react';
@@ -99,7 +101,175 @@ interface UseItemPriceOptions {
99
101
  * });
100
102
  * ```
101
103
  */
102
- declare function useItemPrice(itemId: string | undefined, customerId: string | number | undefined, quantity?: number, options?: UseItemPriceOptions): _tanstack_react_query.UseQueryResult<TPriceData, Error>;
104
+ declare function useItemPrice(itemId: string | undefined, customerId: string | number | undefined, quantity?: number, options?: UseItemPriceOptions): {
105
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
106
+ data: TPriceData;
107
+ error: Error;
108
+ isError: true;
109
+ isPending: false;
110
+ isLoading: false;
111
+ isLoadingError: false;
112
+ isRefetchError: true;
113
+ isSuccess: false;
114
+ isPlaceholderData: false;
115
+ status: "error";
116
+ dataUpdatedAt: number;
117
+ errorUpdatedAt: number;
118
+ failureCount: number;
119
+ failureReason: Error | null;
120
+ errorUpdateCount: number;
121
+ isFetched: boolean;
122
+ isFetchedAfterMount: boolean;
123
+ isFetching: boolean;
124
+ isInitialLoading: boolean;
125
+ isPaused: boolean;
126
+ isRefetching: boolean;
127
+ isStale: boolean;
128
+ isEnabled: boolean;
129
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
130
+ fetchStatus: _tanstack_react_query.FetchStatus;
131
+ promise: Promise<TPriceData>;
132
+ } | {
133
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
134
+ data: TPriceData;
135
+ error: null;
136
+ isError: false;
137
+ isPending: false;
138
+ isLoading: false;
139
+ isLoadingError: false;
140
+ isRefetchError: false;
141
+ isSuccess: true;
142
+ isPlaceholderData: false;
143
+ status: "success";
144
+ dataUpdatedAt: number;
145
+ errorUpdatedAt: number;
146
+ failureCount: number;
147
+ failureReason: Error | null;
148
+ errorUpdateCount: number;
149
+ isFetched: boolean;
150
+ isFetchedAfterMount: boolean;
151
+ isFetching: boolean;
152
+ isInitialLoading: boolean;
153
+ isPaused: boolean;
154
+ isRefetching: boolean;
155
+ isStale: boolean;
156
+ isEnabled: boolean;
157
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
158
+ fetchStatus: _tanstack_react_query.FetchStatus;
159
+ promise: Promise<TPriceData>;
160
+ } | {
161
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
162
+ data: undefined;
163
+ error: Error;
164
+ isError: true;
165
+ isPending: false;
166
+ isLoading: false;
167
+ isLoadingError: true;
168
+ isRefetchError: false;
169
+ isSuccess: false;
170
+ isPlaceholderData: false;
171
+ status: "error";
172
+ dataUpdatedAt: number;
173
+ errorUpdatedAt: number;
174
+ failureCount: number;
175
+ failureReason: Error | null;
176
+ errorUpdateCount: number;
177
+ isFetched: boolean;
178
+ isFetchedAfterMount: boolean;
179
+ isFetching: boolean;
180
+ isInitialLoading: boolean;
181
+ isPaused: boolean;
182
+ isRefetching: boolean;
183
+ isStale: boolean;
184
+ isEnabled: boolean;
185
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
186
+ fetchStatus: _tanstack_react_query.FetchStatus;
187
+ promise: Promise<TPriceData>;
188
+ } | {
189
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
190
+ data: undefined;
191
+ error: null;
192
+ isError: false;
193
+ isPending: true;
194
+ isLoading: true;
195
+ isLoadingError: false;
196
+ isRefetchError: false;
197
+ isSuccess: false;
198
+ isPlaceholderData: false;
199
+ status: "pending";
200
+ dataUpdatedAt: number;
201
+ errorUpdatedAt: number;
202
+ failureCount: number;
203
+ failureReason: Error | null;
204
+ errorUpdateCount: number;
205
+ isFetched: boolean;
206
+ isFetchedAfterMount: boolean;
207
+ isFetching: boolean;
208
+ isInitialLoading: boolean;
209
+ isPaused: boolean;
210
+ isRefetching: boolean;
211
+ isStale: boolean;
212
+ isEnabled: boolean;
213
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
214
+ fetchStatus: _tanstack_react_query.FetchStatus;
215
+ promise: Promise<TPriceData>;
216
+ } | {
217
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
218
+ data: undefined;
219
+ error: null;
220
+ isError: false;
221
+ isPending: true;
222
+ isLoadingError: false;
223
+ isRefetchError: false;
224
+ isSuccess: false;
225
+ isPlaceholderData: false;
226
+ status: "pending";
227
+ dataUpdatedAt: number;
228
+ errorUpdatedAt: number;
229
+ failureCount: number;
230
+ failureReason: Error | null;
231
+ errorUpdateCount: number;
232
+ isFetched: boolean;
233
+ isFetchedAfterMount: boolean;
234
+ isFetching: boolean;
235
+ isLoading: boolean;
236
+ isInitialLoading: boolean;
237
+ isPaused: boolean;
238
+ isRefetching: boolean;
239
+ isStale: boolean;
240
+ isEnabled: boolean;
241
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
242
+ fetchStatus: _tanstack_react_query.FetchStatus;
243
+ promise: Promise<TPriceData>;
244
+ } | {
245
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
246
+ data: TPriceData;
247
+ isError: false;
248
+ error: null;
249
+ isPending: false;
250
+ isLoading: false;
251
+ isLoadingError: false;
252
+ isRefetchError: false;
253
+ isSuccess: true;
254
+ isPlaceholderData: true;
255
+ status: "success";
256
+ dataUpdatedAt: number;
257
+ errorUpdatedAt: number;
258
+ failureCount: number;
259
+ failureReason: Error | null;
260
+ errorUpdateCount: number;
261
+ isFetched: boolean;
262
+ isFetchedAfterMount: boolean;
263
+ isFetching: boolean;
264
+ isInitialLoading: boolean;
265
+ isPaused: boolean;
266
+ isRefetching: boolean;
267
+ isStale: boolean;
268
+ isEnabled: boolean;
269
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
270
+ fetchStatus: _tanstack_react_query.FetchStatus;
271
+ promise: Promise<TPriceData>;
272
+ };
103
273
 
104
274
  interface UseInvMastDocOptions {
105
275
  enabled?: boolean;
package/dist/index.d.ts CHANGED
@@ -3,7 +3,9 @@ export { d as AugurHooksProvider, e as BatchQueryConfig, f as executeBatchQuery,
3
3
  import { InfiniteScrollPage, CacheConfig, AugurAuthContext } from '@simpleapps-com/augur-core';
4
4
  export { AugurAuthContext, CacheConfig, CacheProvider, CacheTierConfig, DeepQueryOptions, EdgeCacheValue, InfiniteScrollPage, ProxyMutationOptions, ProxyQueryOptions } from '@simpleapps-com/augur-core';
5
5
  import * as zustand from 'zustand';
6
+ import * as _simpleapps_com_augur_utils from '@simpleapps-com/augur-utils';
6
7
  import { TCartLine, TItemsFilters, TPriceData, TInvMastDoc, TCategory, TItemDetails, TAttribute, TJoomlaContent, TJoomlaContentFilters, MenuItem, TMenuFilters, ImageConfig, ImageUrlOptions } from '@simpleapps-com/augur-utils';
8
+ export { DerivePriceInput, DerivedPrice } from '@simpleapps-com/augur-utils';
7
9
  import * as _tanstack_react_query from '@tanstack/react-query';
8
10
  import { QueryKey } from '@tanstack/react-query';
9
11
  import { ReactNode, createElement } from 'react';
@@ -99,7 +101,175 @@ interface UseItemPriceOptions {
99
101
  * });
100
102
  * ```
101
103
  */
102
- declare function useItemPrice(itemId: string | undefined, customerId: string | number | undefined, quantity?: number, options?: UseItemPriceOptions): _tanstack_react_query.UseQueryResult<TPriceData, Error>;
104
+ declare function useItemPrice(itemId: string | undefined, customerId: string | number | undefined, quantity?: number, options?: UseItemPriceOptions): {
105
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
106
+ data: TPriceData;
107
+ error: Error;
108
+ isError: true;
109
+ isPending: false;
110
+ isLoading: false;
111
+ isLoadingError: false;
112
+ isRefetchError: true;
113
+ isSuccess: false;
114
+ isPlaceholderData: false;
115
+ status: "error";
116
+ dataUpdatedAt: number;
117
+ errorUpdatedAt: number;
118
+ failureCount: number;
119
+ failureReason: Error | null;
120
+ errorUpdateCount: number;
121
+ isFetched: boolean;
122
+ isFetchedAfterMount: boolean;
123
+ isFetching: boolean;
124
+ isInitialLoading: boolean;
125
+ isPaused: boolean;
126
+ isRefetching: boolean;
127
+ isStale: boolean;
128
+ isEnabled: boolean;
129
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
130
+ fetchStatus: _tanstack_react_query.FetchStatus;
131
+ promise: Promise<TPriceData>;
132
+ } | {
133
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
134
+ data: TPriceData;
135
+ error: null;
136
+ isError: false;
137
+ isPending: false;
138
+ isLoading: false;
139
+ isLoadingError: false;
140
+ isRefetchError: false;
141
+ isSuccess: true;
142
+ isPlaceholderData: false;
143
+ status: "success";
144
+ dataUpdatedAt: number;
145
+ errorUpdatedAt: number;
146
+ failureCount: number;
147
+ failureReason: Error | null;
148
+ errorUpdateCount: number;
149
+ isFetched: boolean;
150
+ isFetchedAfterMount: boolean;
151
+ isFetching: boolean;
152
+ isInitialLoading: boolean;
153
+ isPaused: boolean;
154
+ isRefetching: boolean;
155
+ isStale: boolean;
156
+ isEnabled: boolean;
157
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
158
+ fetchStatus: _tanstack_react_query.FetchStatus;
159
+ promise: Promise<TPriceData>;
160
+ } | {
161
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
162
+ data: undefined;
163
+ error: Error;
164
+ isError: true;
165
+ isPending: false;
166
+ isLoading: false;
167
+ isLoadingError: true;
168
+ isRefetchError: false;
169
+ isSuccess: false;
170
+ isPlaceholderData: false;
171
+ status: "error";
172
+ dataUpdatedAt: number;
173
+ errorUpdatedAt: number;
174
+ failureCount: number;
175
+ failureReason: Error | null;
176
+ errorUpdateCount: number;
177
+ isFetched: boolean;
178
+ isFetchedAfterMount: boolean;
179
+ isFetching: boolean;
180
+ isInitialLoading: boolean;
181
+ isPaused: boolean;
182
+ isRefetching: boolean;
183
+ isStale: boolean;
184
+ isEnabled: boolean;
185
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
186
+ fetchStatus: _tanstack_react_query.FetchStatus;
187
+ promise: Promise<TPriceData>;
188
+ } | {
189
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
190
+ data: undefined;
191
+ error: null;
192
+ isError: false;
193
+ isPending: true;
194
+ isLoading: true;
195
+ isLoadingError: false;
196
+ isRefetchError: false;
197
+ isSuccess: false;
198
+ isPlaceholderData: false;
199
+ status: "pending";
200
+ dataUpdatedAt: number;
201
+ errorUpdatedAt: number;
202
+ failureCount: number;
203
+ failureReason: Error | null;
204
+ errorUpdateCount: number;
205
+ isFetched: boolean;
206
+ isFetchedAfterMount: boolean;
207
+ isFetching: boolean;
208
+ isInitialLoading: boolean;
209
+ isPaused: boolean;
210
+ isRefetching: boolean;
211
+ isStale: boolean;
212
+ isEnabled: boolean;
213
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
214
+ fetchStatus: _tanstack_react_query.FetchStatus;
215
+ promise: Promise<TPriceData>;
216
+ } | {
217
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
218
+ data: undefined;
219
+ error: null;
220
+ isError: false;
221
+ isPending: true;
222
+ isLoadingError: false;
223
+ isRefetchError: false;
224
+ isSuccess: false;
225
+ isPlaceholderData: false;
226
+ status: "pending";
227
+ dataUpdatedAt: number;
228
+ errorUpdatedAt: number;
229
+ failureCount: number;
230
+ failureReason: Error | null;
231
+ errorUpdateCount: number;
232
+ isFetched: boolean;
233
+ isFetchedAfterMount: boolean;
234
+ isFetching: boolean;
235
+ isLoading: boolean;
236
+ isInitialLoading: boolean;
237
+ isPaused: boolean;
238
+ isRefetching: boolean;
239
+ isStale: boolean;
240
+ isEnabled: boolean;
241
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
242
+ fetchStatus: _tanstack_react_query.FetchStatus;
243
+ promise: Promise<TPriceData>;
244
+ } | {
245
+ derived: _simpleapps_com_augur_utils.DerivedPrice | null;
246
+ data: TPriceData;
247
+ isError: false;
248
+ error: null;
249
+ isPending: false;
250
+ isLoading: false;
251
+ isLoadingError: false;
252
+ isRefetchError: false;
253
+ isSuccess: true;
254
+ isPlaceholderData: true;
255
+ status: "success";
256
+ dataUpdatedAt: number;
257
+ errorUpdatedAt: number;
258
+ failureCount: number;
259
+ failureReason: Error | null;
260
+ errorUpdateCount: number;
261
+ isFetched: boolean;
262
+ isFetchedAfterMount: boolean;
263
+ isFetching: boolean;
264
+ isInitialLoading: boolean;
265
+ isPaused: boolean;
266
+ isRefetching: boolean;
267
+ isStale: boolean;
268
+ isEnabled: boolean;
269
+ refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<TPriceData, Error>>;
270
+ fetchStatus: _tanstack_react_query.FetchStatus;
271
+ promise: Promise<TPriceData>;
272
+ };
103
273
 
104
274
  interface UseInvMastDocOptions {
105
275
  enabled?: boolean;
package/dist/index.js CHANGED
@@ -199,7 +199,9 @@ function useFormatPrice(locale = "en-US", currency = "USD") {
199
199
  }
200
200
 
201
201
  // src/hooks/use-item-price.ts
202
+ import { useMemo as useMemo2 } from "react";
202
203
  import { useQuery } from "@tanstack/react-query";
204
+ import { derivePrice } from "@simpleapps-com/augur-utils";
203
205
  function useItemPrice(itemId, customerId, quantity = 1, options = {}) {
204
206
  const api = useAugurApiOptional();
205
207
  const callbacks = useAugurCallbacks();
@@ -208,12 +210,17 @@ function useItemPrice(itemId, customerId, quantity = 1, options = {}) {
208
210
  const effectiveCustomerId = customerId ?? auth?.customerId;
209
211
  const defaultOptions = getItemPriceOptions(api, itemId, effectiveCustomerId, quantity, cache);
210
212
  const resolvedQueryFn = options.queryFn ?? (callbacks?.getItemPrice ? () => callbacks.getItemPrice(itemId, effectiveCustomerId, quantity) : void 0);
211
- return useQuery({
213
+ const query = useQuery({
212
214
  ...defaultOptions,
213
215
  ...resolvedQueryFn ? { queryFn: resolvedQueryFn } : {},
214
216
  enabled: options.enabled ?? (Boolean(itemId) && Boolean(effectiveCustomerId)),
215
217
  retry: 3
216
218
  });
219
+ const derived = useMemo2(
220
+ () => derivePrice({ priceData: query.data, quantity }),
221
+ [query.data, quantity]
222
+ );
223
+ return { ...query, derived };
217
224
  }
218
225
 
219
226
  // src/hooks/use-inv-mast-doc.ts
@@ -652,7 +659,7 @@ function useCartActions(callbacks) {
652
659
  }
653
660
 
654
661
  // src/hooks/use-cart-initialization.ts
655
- import { useEffect as useEffect2, useMemo as useMemo2, useRef } from "react";
662
+ import { useEffect as useEffect2, useMemo as useMemo3, useRef } from "react";
656
663
  import { useQuery as useQuery12, useQueryClient as useQueryClient3 } from "@tanstack/react-query";
657
664
  var MAX_RETRY_ATTEMPTS = 7;
658
665
  var RETRY_DELAY_MS = 1e3;
@@ -666,7 +673,7 @@ function useCartInitialization(session, callbacks) {
666
673
  const effectiveStatus = session.status;
667
674
  const effectiveUserId = session.userId ?? auth?.userId;
668
675
  const effectiveCartHdrUid = session.cartHdrUid ?? auth?.cartHdrUid;
669
- const effectiveSession = useMemo2(
676
+ const effectiveSession = useMemo3(
670
677
  () => ({ status: effectiveStatus, userId: effectiveUserId, cartHdrUid: effectiveCartHdrUid }),
671
678
  [effectiveStatus, effectiveUserId, effectiveCartHdrUid]
672
679
  );
@@ -752,8 +759,9 @@ function useCartInitialization(session, callbacks) {
752
759
  }
753
760
 
754
761
  // src/hooks/use-cart-pricing.ts
755
- import { useMemo as useMemo3 } from "react";
762
+ import { useMemo as useMemo4 } from "react";
756
763
  import { useQueries } from "@tanstack/react-query";
764
+ import { derivePrice as derivePrice2 } from "@simpleapps-com/augur-utils";
757
765
  function useCartPricing(options = {}) {
758
766
  const api = useAugurApiOptional();
759
767
  const callbacks = useAugurCallbacks();
@@ -777,30 +785,31 @@ function useCartPricing(options = {}) {
777
785
  };
778
786
  })
779
787
  });
780
- const prices = useMemo3(() => {
788
+ const prices = useMemo4(() => {
781
789
  const map = {};
782
790
  cartLines.forEach((line, index) => {
783
791
  const queryResult = priceQueries[index];
784
792
  if (queryResult?.data) {
793
+ const derived = derivePrice2({ priceData: queryResult.data, quantity: line.quantity });
785
794
  map[line.itemId.toUpperCase()] = {
786
- unitPrice: queryResult.data.unitPrice ?? 0,
795
+ unitPrice: derived.unitPrice,
787
796
  priceData: queryResult.data
788
797
  };
789
798
  }
790
799
  });
791
800
  return map;
792
801
  }, [cartLines, priceQueries]);
793
- const getUnitPrice = useMemo3(() => {
802
+ const getUnitPrice = useMemo4(() => {
794
803
  return (itemId) => {
795
804
  return prices[itemId?.toUpperCase()]?.unitPrice ?? 0;
796
805
  };
797
806
  }, [prices]);
798
- const getItemTotal = useMemo3(() => {
807
+ const getItemTotal = useMemo4(() => {
799
808
  return (itemId, quantity) => {
800
809
  return getUnitPrice(itemId) * quantity;
801
810
  };
802
811
  }, [getUnitPrice]);
803
- const subtotal = useMemo3(() => {
812
+ const subtotal = useMemo4(() => {
804
813
  return cartLines.reduce((sum, line) => {
805
814
  const unitPrice = prices[line.itemId.toUpperCase()]?.unitPrice ?? 0;
806
815
  return sum + unitPrice * line.quantity;
@@ -1183,7 +1192,7 @@ function createSiteHooks(config = {}) {
1183
1192
  }
1184
1193
 
1185
1194
  // src/persistence/use-persistence.ts
1186
- import { useState as useState2, useEffect as useEffect4, useMemo as useMemo4 } from "react";
1195
+ import { useState as useState2, useEffect as useEffect4, useMemo as useMemo5 } from "react";
1187
1196
 
1188
1197
  // src/persistence/serializer.ts
1189
1198
  function serialize(data) {
@@ -1328,7 +1337,7 @@ function useAugurPersistence(config) {
1328
1337
  useStorageMonitor(config);
1329
1338
  const isDev = typeof process !== "undefined" && process.env?.NODE_ENV === "development";
1330
1339
  const { persistableKeys } = config;
1331
- const dehydrateOptions = useMemo4(() => ({
1340
+ const dehydrateOptions = useMemo5(() => ({
1332
1341
  shouldDehydrateQuery: (query) => {
1333
1342
  const key = query.queryKey;
1334
1343
  if (!Array.isArray(key) || key.length === 0) return false;