@simpleapps-com/augur-hooks 2.4.0 → 2026.11.2

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.
Files changed (103) hide show
  1. package/EXPORTS.md +25 -65
  2. package/README.md +21 -246
  3. package/dist/checkout/create-checkout-provider.d.ts +25 -0
  4. package/dist/checkout/create-checkout-provider.d.ts.map +1 -0
  5. package/dist/checkout/index.cjs +123 -106
  6. package/dist/checkout/index.cjs.map +1 -1
  7. package/dist/checkout/index.d.ts +5 -293
  8. package/dist/checkout/index.d.ts.map +1 -0
  9. package/dist/checkout/index.js +99 -82
  10. package/dist/checkout/index.js.map +1 -1
  11. package/dist/checkout/{index.d.cts → types.d.ts} +18 -40
  12. package/dist/checkout/types.d.ts.map +1 -0
  13. package/dist/chunk-6Z6JGK2C.cjs.map +1 -1
  14. package/dist/chunk-JJX23M5N.js +532 -0
  15. package/dist/chunk-JJX23M5N.js.map +1 -0
  16. package/dist/chunk-UZAFXUAO.cjs +532 -0
  17. package/dist/chunk-UZAFXUAO.cjs.map +1 -0
  18. package/dist/duration.d.ts +16 -0
  19. package/dist/duration.d.ts.map +1 -0
  20. package/dist/hooks/use-cart-actions.d.ts +68 -0
  21. package/dist/hooks/use-cart-actions.d.ts.map +1 -0
  22. package/dist/hooks/use-cart-initialization.d.ts +60 -0
  23. package/dist/hooks/use-cart-initialization.d.ts.map +1 -0
  24. package/dist/hooks/use-cart-pricing.d.ts +41 -0
  25. package/dist/hooks/use-cart-pricing.d.ts.map +1 -0
  26. package/dist/hooks/use-checkout-persistence.d.ts +41 -0
  27. package/dist/hooks/use-checkout-persistence.d.ts.map +1 -0
  28. package/dist/hooks/use-debounce.d.ts +6 -0
  29. package/dist/hooks/use-debounce.d.ts.map +1 -0
  30. package/dist/hooks/use-format-price.d.ts +29 -0
  31. package/dist/hooks/use-format-price.d.ts.map +1 -0
  32. package/dist/hooks/use-latest.d.ts +8 -0
  33. package/dist/hooks/use-latest.d.ts.map +1 -0
  34. package/dist/hooks/use-modal-lifecycle.d.ts +11 -0
  35. package/dist/hooks/use-modal-lifecycle.d.ts.map +1 -0
  36. package/dist/hooks/use-order-readiness.d.ts +47 -0
  37. package/dist/hooks/use-order-readiness.d.ts.map +1 -0
  38. package/dist/hooks/use-pagination-prefetch.d.ts +27 -0
  39. package/dist/hooks/use-pagination-prefetch.d.ts.map +1 -0
  40. package/dist/{use-order-readiness-DZTIfRzw.d.ts → hooks/use-payment-flow.d.ts} +23 -67
  41. package/dist/hooks/use-payment-flow.d.ts.map +1 -0
  42. package/dist/hooks/use-stock.d.ts +32 -0
  43. package/dist/hooks/use-stock.d.ts.map +1 -0
  44. package/dist/index.cjs +227 -184
  45. package/dist/index.cjs.map +1 -1
  46. package/dist/index.d.ts +32 -456
  47. package/dist/index.d.ts.map +1 -0
  48. package/dist/index.js +205 -162
  49. package/dist/index.js.map +1 -1
  50. package/dist/persistence/apply-limits.d.ts +8 -0
  51. package/dist/persistence/apply-limits.d.ts.map +1 -0
  52. package/dist/persistence/create-persister.d.ts +10 -0
  53. package/dist/persistence/create-persister.d.ts.map +1 -0
  54. package/dist/persistence/serializer.d.ts +11 -0
  55. package/dist/persistence/serializer.d.ts.map +1 -0
  56. package/dist/persistence/use-persistence.d.ts +59 -0
  57. package/dist/persistence/use-persistence.d.ts.map +1 -0
  58. package/dist/persistence/use-storage-monitor.d.ts +11 -0
  59. package/dist/persistence/use-storage-monitor.d.ts.map +1 -0
  60. package/dist/provider.d.ts +89 -0
  61. package/dist/provider.d.ts.map +1 -0
  62. package/dist/queries/batch-query.d.ts +23 -0
  63. package/dist/queries/batch-query.d.ts.map +1 -0
  64. package/dist/queries/index.d.ts +3 -0
  65. package/dist/queries/index.d.ts.map +1 -0
  66. package/dist/query-action-registry.d.ts +19 -0
  67. package/dist/query-action-registry.d.ts.map +1 -0
  68. package/dist/rules.d.ts +133 -0
  69. package/dist/rules.d.ts.map +1 -0
  70. package/dist/server.cjs +2 -1
  71. package/dist/server.cjs.map +1 -1
  72. package/dist/server.d.ts +10 -12
  73. package/dist/server.d.ts.map +1 -0
  74. package/dist/server.js +2 -1
  75. package/dist/server.js.map +1 -1
  76. package/dist/stores/cart-store.d.ts +51 -0
  77. package/dist/stores/cart-store.d.ts.map +1 -0
  78. package/dist/stores/items-filters-store.d.ts +30 -0
  79. package/dist/stores/items-filters-store.d.ts.map +1 -0
  80. package/dist/types.d.ts +48 -0
  81. package/dist/types.d.ts.map +1 -0
  82. package/dist/web/use-image-with-fallback.d.ts +16 -0
  83. package/dist/web/use-image-with-fallback.d.ts.map +1 -0
  84. package/dist/web/use-mobile-detection.d.ts +28 -0
  85. package/dist/web/use-mobile-detection.d.ts.map +1 -0
  86. package/dist/web/use-mobile-optimized-intersection.d.ts +17 -0
  87. package/dist/web/use-mobile-optimized-intersection.d.ts.map +1 -0
  88. package/dist/web.cjs.map +1 -1
  89. package/dist/web.d.ts +4 -60
  90. package/dist/web.d.ts.map +1 -0
  91. package/dist/web.js.map +1 -1
  92. package/llms.txt +76 -54
  93. package/package.json +26 -14
  94. package/dist/batch-query-CTlvxSmL.d.cts +0 -165
  95. package/dist/batch-query-CTlvxSmL.d.ts +0 -165
  96. package/dist/chunk-F5DUFW57.cjs +0 -383
  97. package/dist/chunk-F5DUFW57.cjs.map +0 -1
  98. package/dist/chunk-JNOHB4OP.js +0 -383
  99. package/dist/chunk-JNOHB4OP.js.map +0 -1
  100. package/dist/index.d.cts +0 -456
  101. package/dist/server.d.cts +0 -44
  102. package/dist/use-order-readiness-DZTIfRzw.d.cts +0 -137
  103. package/dist/web.d.cts +0 -60
@@ -0,0 +1,47 @@
1
+ /** Parameters for order readiness validation. */
2
+ export interface OrderReadinessParams {
3
+ cartHdrUid: string | number | undefined;
4
+ shippingAddress: unknown;
5
+ billingAddress: unknown;
6
+ shippingMethodSaved: boolean;
7
+ showBillingInfoSummary: boolean;
8
+ processingOrder: boolean;
9
+ paymentMethod: string;
10
+ unifiedPaymentAccountId: string | undefined;
11
+ unifiedBilling: boolean;
12
+ isFreeShipping: boolean;
13
+ carrierId: string;
14
+ shippingFee: number | undefined;
15
+ isEditShippingInfo: boolean;
16
+ isEditShippingMethods: boolean;
17
+ isEditBillingInfo: boolean;
18
+ editCc: boolean;
19
+ /**
20
+ * Site-provided function to check if the order is ready.
21
+ *
22
+ * Return `true` or `false` to override the default gates. Return
23
+ * `undefined` to defer to the default logic (useful when the override
24
+ * only applies to specific order flows — e.g. sample-only or pickup).
25
+ */
26
+ customReadinessCheck?: (params: OrderReadinessParams) => boolean | undefined;
27
+ }
28
+ /**
29
+ * Pure function that determines if an order is ready to submit.
30
+ *
31
+ * Checks all gates: cart exists, addresses present, shipping method saved,
32
+ * billing shown, payment complete (for credit card), shipping fee present
33
+ * (for non-free, non-pickup orders), and no sections being edited.
34
+ */
35
+ export declare function determineOrderReadiness(params: OrderReadinessParams): boolean;
36
+ /**
37
+ * Debounced order readiness hook.
38
+ *
39
+ * Recomputes readiness 300ms after any dependency changes to avoid
40
+ * excessive re-renders during rapid state transitions (e.g., typing
41
+ * in address fields).
42
+ */
43
+ export declare function useOrderReadiness(params: OrderReadinessParams): {
44
+ enableProcessOrderBtn: boolean;
45
+ processingValidation: boolean;
46
+ };
47
+ //# sourceMappingURL=use-order-readiness.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-order-readiness.d.ts","sourceRoot":"","sources":["../../src/hooks/use-order-readiness.ts"],"names":[],"mappings":"AAMA,iDAAiD;AACjD,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACxC,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;IACxB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,sBAAsB,EAAE,OAAO,CAAC;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,GAAG,SAAS,CAAC;CAC9E;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAE7E;AAuBD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,oBAAoB;;;EAuC7D"}
@@ -0,0 +1,27 @@
1
+ import type { QueryKey } from "@tanstack/react-query";
2
+ import type { Millis } from "../duration";
3
+ interface UsePaginationPrefetchOptions {
4
+ /** Query key for the paginated data */
5
+ queryKey: QueryKey;
6
+ /** Function to fetch a page of data */
7
+ queryFn: (offset: number) => Promise<unknown>;
8
+ /** Number of items per page */
9
+ pageSize: number;
10
+ /** Custom query key builder. Receives the base key and offset, returns the full key. Default: [...queryKey, offset]. */
11
+ queryKeyFn?: (baseKey: QueryKey, offset: number) => QueryKey;
12
+ /** Stale time (defaults to 10 minutes) */
13
+ staleTime?: Millis;
14
+ /** GC time (defaults to 30 minutes) */
15
+ gcTime?: Millis;
16
+ enabled?: boolean;
17
+ }
18
+ /**
19
+ * Prefetch adjacent pages on hover for instant pagination.
20
+ * Accepts a generic queryFn so it works with any paginated resource.
21
+ */
22
+ export declare const usePaginationPrefetch: ({ queryKey, queryFn, pageSize, queryKeyFn, staleTime, gcTime, enabled, }: UsePaginationPrefetchOptions) => {
23
+ prefetchPage: (page: number) => Promise<void>;
24
+ handlePaginationHover: (page: number) => () => void;
25
+ };
26
+ export {};
27
+ //# sourceMappingURL=use-pagination-prefetch.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-pagination-prefetch.d.ts","sourceRoot":"","sources":["../../src/hooks/use-pagination-prefetch.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,UAAU,4BAA4B;IACpC,uCAAuC;IACvC,QAAQ,EAAE,QAAQ,CAAC;IACnB,uCAAuC;IACvC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,wHAAwH;IACxH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,KAAK,QAAQ,CAAC;IAC7D,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAAI,0EAQnC,4BAA4B;yBAId,MAAM;kCAkBZ,MAAM;CAWhB,CAAC"}
@@ -1,8 +1,7 @@
1
- import * as react from 'react';
2
- import { TTransactionSetup, TCardInfo, TPaymentValidation, TAccountQuery, TBillingUpdate } from '@simpleapps-com/augur-utils';
3
-
1
+ import type { Dispatch, SetStateAction } from "react";
2
+ import type { TTransactionSetup, TCardInfo, TPaymentValidation, TAccountQuery, TBillingUpdate } from "@simpleapps-com/augur-utils";
4
3
  /** Site-specific payment action callbacks injected into usePaymentFlow. */
5
- interface PaymentFlowCallbacks {
4
+ export interface PaymentFlowCallbacks {
6
5
  /** Initialize a payment session. Returns transaction setup or undefined on failure. */
7
6
  transactionSetup: (params: {
8
7
  customerId: string;
@@ -36,7 +35,7 @@ interface PaymentFlowCallbacks {
36
35
  };
37
36
  }
38
37
  /** Billing address shape accepted by the payment flow. */
39
- interface PaymentBillingAddress {
38
+ export interface PaymentBillingAddress {
40
39
  address1: string;
41
40
  address2?: string;
42
41
  city: string;
@@ -52,6 +51,22 @@ interface UsePaymentFlowParams {
52
51
  /** Persist payment tokens to sessionStorage for cross-navigation recovery. */
53
52
  persistPayment?: boolean;
54
53
  }
54
+ /** sessionStorage key for persisted payment tokens. */
55
+ export declare const PAYMENT_STORAGE_KEY = "checkout:payment";
56
+ /** State and setters returned by usePaymentFlow. */
57
+ interface PaymentFlow {
58
+ isOpen: boolean;
59
+ setIsOpen: Dispatch<SetStateAction<boolean>>;
60
+ editCc: boolean;
61
+ setEditCc: Dispatch<SetStateAction<boolean>>;
62
+ unified: TTransactionSetup | null;
63
+ unifiedCc: TCardInfo | null;
64
+ unifiedResponse: boolean;
65
+ unifiedBilling: boolean;
66
+ unifiedPayment: TAccountQuery | null;
67
+ capturedBin: string | null;
68
+ handleBinCapture: (bin: string) => void;
69
+ }
55
70
  /**
56
71
  * Manages the full Element/Unified payment lifecycle:
57
72
  * transactionSetup -> cardInfo -> validatePayment -> accountQuery -> billingUpdate
@@ -73,65 +88,6 @@ interface UsePaymentFlowParams {
73
88
  * });
74
89
  * ```
75
90
  */
76
- declare function usePaymentFlow({ callbacks, customerId, billingAddress, paymentMethod, shippingAccepted, persistPayment, }: UsePaymentFlowParams): {
77
- isOpen: boolean;
78
- setIsOpen: react.Dispatch<react.SetStateAction<boolean>>;
79
- editCc: boolean;
80
- setEditCc: react.Dispatch<react.SetStateAction<boolean>>;
81
- unified: TTransactionSetup | null;
82
- unifiedCc: TCardInfo | null;
83
- unifiedResponse: boolean;
84
- unifiedBilling: boolean;
85
- unifiedPayment: TAccountQuery | null;
86
- capturedBin: string | null;
87
- handleBinCapture: (bin: string) => void;
88
- };
89
-
90
- /** Parameters for order readiness validation. */
91
- interface OrderReadinessParams {
92
- cartHdrUid: string | number | undefined;
93
- shippingAddress: unknown;
94
- billingAddress: unknown;
95
- shippingMethodSaved: boolean;
96
- showBillingInfoSummary: boolean;
97
- processingOrder: boolean;
98
- paymentMethod: string;
99
- unifiedPaymentAccountId: string | undefined;
100
- unifiedBilling: boolean;
101
- isFreeShipping: boolean;
102
- carrierId: string;
103
- shippingFee: number | undefined;
104
- isEditShippingInfo: boolean;
105
- isEditShippingMethods: boolean;
106
- isEditBillingInfo: boolean;
107
- editCc: boolean;
108
- /**
109
- * Site-provided function to check if the order is ready.
110
- *
111
- * Return `true` or `false` to override the default gates. Return
112
- * `undefined` to defer to the default logic (useful when the override
113
- * only applies to specific order flows — e.g. sample-only or pickup).
114
- */
115
- customReadinessCheck?: (params: OrderReadinessParams) => boolean | undefined;
116
- }
117
- /**
118
- * Pure function that determines if an order is ready to submit.
119
- *
120
- * Checks all gates: cart exists, addresses present, shipping method saved,
121
- * billing shown, payment complete (for credit card), shipping fee present
122
- * (for non-free, non-pickup orders), and no sections being edited.
123
- */
124
- declare function determineOrderReadiness(params: OrderReadinessParams): boolean;
125
- /**
126
- * Debounced order readiness hook.
127
- *
128
- * Recomputes readiness 300ms after any dependency changes to avoid
129
- * excessive re-renders during rapid state transitions (e.g., typing
130
- * in address fields).
131
- */
132
- declare function useOrderReadiness(params: OrderReadinessParams): {
133
- enableProcessOrderBtn: boolean;
134
- processingValidation: boolean;
135
- };
136
-
137
- export { type OrderReadinessParams as O, type PaymentBillingAddress as P, type PaymentFlowCallbacks as a, usePaymentFlow as b, determineOrderReadiness as d, useOrderReadiness as u };
91
+ export declare function usePaymentFlow({ callbacks, customerId, billingAddress, paymentMethod, shippingAccepted, persistPayment, }: UsePaymentFlowParams): PaymentFlow;
92
+ export {};
93
+ //# sourceMappingURL=use-payment-flow.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-payment-flow.d.ts","sourceRoot":"","sources":["../../src/hooks/use-payment-flow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,KAAK,EACV,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,aAAa,EACb,cAAc,EACf,MAAM,6BAA6B,CAAC;AAGrC,2EAA2E;AAC3E,MAAM,WAAW,oBAAoB;IACnC,uFAAuF;IACvF,gBAAgB,EAAE,CAAC,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAC7F,gDAAgD;IAChD,QAAQ,EAAE,CAAC,MAAM,EAAE;QAAE,kBAAkB,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IACrF,4BAA4B;IAC5B,eAAe,EAAE,CAAC,MAAM,EAAE;QACxB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;IAC9C,8BAA8B;IAC9B,YAAY,EAAE,CAAC,MAAM,EAAE;QACrB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IACzC,iDAAiD;IACjD,aAAa,EAAE,CAAC,MAAM,EAAE;QACtB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,KAAK,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IAC1C,4CAA4C;IAC5C,KAAK,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;KACnC,CAAC;CACH;AAED,0DAA0D;AAC1D,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,oBAAoB;IAC5B,SAAS,EAAE,oBAAoB,CAAC;IAChC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACxC,cAAc,EAAE,qBAAqB,GAAG,SAAS,CAAC;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,8EAA8E;IAC9E,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,uDAAuD;AACvD,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAStD,oDAAoD;AACpD,UAAU,WAAW;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7C,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7C,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAClC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,aAAa,GAAG,IAAI,CAAC;IACrC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC;AA+BD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,cAAc,CAAC,EAC7B,SAAS,EACT,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,EAAE,oBAAoB,GAAG,WAAW,CAkQpC"}
@@ -0,0 +1,32 @@
1
+ import type { ResolvedStock, TStock } from "@simpleapps-com/augur-utils";
2
+ export interface UseStockOptions {
3
+ enabled?: boolean;
4
+ /** Override the default queryFn (e.g. with a custom server action). */
5
+ queryFn?: () => Promise<TStock>;
6
+ /** Company key to extract stock for a specific company. */
7
+ companyKey?: string;
8
+ /** Whether to round the quantity. */
9
+ round?: boolean;
10
+ /** Threshold below which stock is considered "low". */
11
+ lowStockThreshold?: number;
12
+ /** Whether to include the quantity in the resolved output. */
13
+ showQuantity?: boolean;
14
+ }
15
+ /** Raw stock, its resolved form, and query state returned by useStock. */
16
+ interface StockResult {
17
+ stock: TStock | null;
18
+ resolved: ResolvedStock | null;
19
+ loading: boolean;
20
+ error: Error | null;
21
+ }
22
+ /**
23
+ * Fetches full TStock data and resolves it into a normalized stock object.
24
+ *
25
+ * Uses the proxy from AugurHooksProvider context. Works with:
26
+ * - Direct SDK (api prop on provider)
27
+ * - Server actions (auto-detected via queryAction registration)
28
+ * - Custom queryFn override
29
+ */
30
+ export declare function useStock(invMastUid: number | string, options?: UseStockOptions): StockResult;
31
+ export {};
32
+ //# sourceMappingURL=use-stock.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-stock.d.ts","sourceRoot":"","sources":["../../src/hooks/use-stock.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAKzE,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,uDAAuD;IACvD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,8DAA8D;IAC9D,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,0EAA0E;AAC1E,UAAU,WAAW;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,WAAW,CAqChG"}