@cimplify/sdk 0.22.0 → 0.22.1
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/react.d.mts +31 -90
- package/dist/react.d.ts +31 -90
- package/dist/react.js +687 -2296
- package/dist/react.mjs +688 -2297
- package/package.json +1 -1
package/dist/react.d.mts
CHANGED
|
@@ -132,7 +132,12 @@ declare function useCimplify(): CimplifyContextValue;
|
|
|
132
132
|
declare function useOptionalCimplify(): CimplifyContextValue | null;
|
|
133
133
|
declare function useCimplifyClient(): CimplifyClientContextValue;
|
|
134
134
|
|
|
135
|
-
interface
|
|
135
|
+
interface CachedQueryBaseOptions {
|
|
136
|
+
enabled?: boolean;
|
|
137
|
+
client?: CimplifyClient;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
interface UseProductsOptions extends CachedQueryBaseOptions {
|
|
136
141
|
category?: string;
|
|
137
142
|
taxonomy?: string;
|
|
138
143
|
search?: string;
|
|
@@ -146,8 +151,6 @@ interface UseProductsOptions {
|
|
|
146
151
|
max_price?: number;
|
|
147
152
|
page?: number;
|
|
148
153
|
properties?: Record<string, string>;
|
|
149
|
-
enabled?: boolean;
|
|
150
|
-
client?: CimplifyClient;
|
|
151
154
|
}
|
|
152
155
|
interface UseProductsResult {
|
|
153
156
|
products: Product[];
|
|
@@ -160,9 +163,7 @@ interface UseProductsResult {
|
|
|
160
163
|
}
|
|
161
164
|
declare function useProducts(options?: UseProductsOptions): UseProductsResult;
|
|
162
165
|
|
|
163
|
-
interface UseProductOptions {
|
|
164
|
-
enabled?: boolean;
|
|
165
|
-
client?: CimplifyClient;
|
|
166
|
+
interface UseProductOptions extends CachedQueryBaseOptions {
|
|
166
167
|
}
|
|
167
168
|
interface UseProductResult {
|
|
168
169
|
product: ProductWithDetails | null;
|
|
@@ -172,9 +173,7 @@ interface UseProductResult {
|
|
|
172
173
|
}
|
|
173
174
|
declare function useProduct(slugOrId: string | null | undefined, options?: UseProductOptions): UseProductResult;
|
|
174
175
|
|
|
175
|
-
interface UseCategoriesOptions {
|
|
176
|
-
enabled?: boolean;
|
|
177
|
-
client?: CimplifyClient;
|
|
176
|
+
interface UseCategoriesOptions extends CachedQueryBaseOptions {
|
|
178
177
|
}
|
|
179
178
|
interface UseCategoriesResult {
|
|
180
179
|
categories: Category[];
|
|
@@ -283,9 +282,7 @@ interface UseLocationsResult {
|
|
|
283
282
|
}
|
|
284
283
|
declare function useLocations(options?: UseLocationsOptions): UseLocationsResult;
|
|
285
284
|
|
|
286
|
-
interface UseCollectionsOptions {
|
|
287
|
-
client?: CimplifyClient;
|
|
288
|
-
enabled?: boolean;
|
|
285
|
+
interface UseCollectionsOptions extends CachedQueryBaseOptions {
|
|
289
286
|
}
|
|
290
287
|
interface UseCollectionsResult {
|
|
291
288
|
collections: Collection[];
|
|
@@ -295,9 +292,7 @@ interface UseCollectionsResult {
|
|
|
295
292
|
}
|
|
296
293
|
declare function useCollections(options?: UseCollectionsOptions): UseCollectionsResult;
|
|
297
294
|
|
|
298
|
-
interface UseCollectionOptions {
|
|
299
|
-
client?: CimplifyClient;
|
|
300
|
-
enabled?: boolean;
|
|
295
|
+
interface UseCollectionOptions extends CachedQueryBaseOptions {
|
|
301
296
|
}
|
|
302
297
|
interface UseCollectionResult {
|
|
303
298
|
collection: Collection | null;
|
|
@@ -358,10 +353,8 @@ interface UseQuoteResult {
|
|
|
358
353
|
}
|
|
359
354
|
declare function useQuote(input: UseQuoteInput | null | undefined, options?: UseQuoteOptions): UseQuoteResult;
|
|
360
355
|
|
|
361
|
-
interface UseTaxonomiesOptions {
|
|
356
|
+
interface UseTaxonomiesOptions extends CachedQueryBaseOptions {
|
|
362
357
|
parentId?: string;
|
|
363
|
-
enabled?: boolean;
|
|
364
|
-
client?: CimplifyClient;
|
|
365
358
|
}
|
|
366
359
|
interface UseTaxonomiesResult {
|
|
367
360
|
taxonomies: ProductTaxonomy[];
|
|
@@ -371,9 +364,7 @@ interface UseTaxonomiesResult {
|
|
|
371
364
|
}
|
|
372
365
|
declare function useTaxonomies(options?: UseTaxonomiesOptions): UseTaxonomiesResult;
|
|
373
366
|
|
|
374
|
-
interface UseTaxonomyOptions {
|
|
375
|
-
enabled?: boolean;
|
|
376
|
-
client?: CimplifyClient;
|
|
367
|
+
interface UseTaxonomyOptions extends CachedQueryBaseOptions {
|
|
377
368
|
}
|
|
378
369
|
interface UseTaxonomyResult {
|
|
379
370
|
taxonomy: TaxonomyWithChildren | null;
|
|
@@ -383,9 +374,7 @@ interface UseTaxonomyResult {
|
|
|
383
374
|
}
|
|
384
375
|
declare function useTaxonomy(id: string, options?: UseTaxonomyOptions): UseTaxonomyResult;
|
|
385
376
|
|
|
386
|
-
interface UseTaxonomyPathOptions {
|
|
387
|
-
enabled?: boolean;
|
|
388
|
-
client?: CimplifyClient;
|
|
377
|
+
interface UseTaxonomyPathOptions extends CachedQueryBaseOptions {
|
|
389
378
|
}
|
|
390
379
|
interface UseTaxonomyPathResult {
|
|
391
380
|
path: ProductTaxonomy[];
|
|
@@ -395,9 +384,7 @@ interface UseTaxonomyPathResult {
|
|
|
395
384
|
}
|
|
396
385
|
declare function useTaxonomyPath(id: string, options?: UseTaxonomyPathOptions): UseTaxonomyPathResult;
|
|
397
386
|
|
|
398
|
-
interface UseProductSchedulesOptions {
|
|
399
|
-
enabled?: boolean;
|
|
400
|
-
client?: CimplifyClient;
|
|
387
|
+
interface UseProductSchedulesOptions extends CachedQueryBaseOptions {
|
|
401
388
|
}
|
|
402
389
|
interface UseProductSchedulesResult {
|
|
403
390
|
schedules: ProductTimeProfile[];
|
|
@@ -407,10 +394,8 @@ interface UseProductSchedulesResult {
|
|
|
407
394
|
}
|
|
408
395
|
declare function useProductSchedules(productId: string, options?: UseProductSchedulesOptions): UseProductSchedulesResult;
|
|
409
396
|
|
|
410
|
-
interface UseProductAvailabilityOptions {
|
|
397
|
+
interface UseProductAvailabilityOptions extends CachedQueryBaseOptions {
|
|
411
398
|
locationId?: string;
|
|
412
|
-
enabled?: boolean;
|
|
413
|
-
client?: CimplifyClient;
|
|
414
399
|
}
|
|
415
400
|
interface UseProductAvailabilityResult {
|
|
416
401
|
isAvailable: boolean | null;
|
|
@@ -421,10 +406,8 @@ interface UseProductAvailabilityResult {
|
|
|
421
406
|
}
|
|
422
407
|
declare function useProductAvailability(productId: string, options?: UseProductAvailabilityOptions): UseProductAvailabilityResult;
|
|
423
408
|
|
|
424
|
-
interface UseDealsOptions {
|
|
409
|
+
interface UseDealsOptions extends CachedQueryBaseOptions {
|
|
425
410
|
locationId?: string;
|
|
426
|
-
enabled?: boolean;
|
|
427
|
-
client?: CimplifyClient;
|
|
428
411
|
}
|
|
429
412
|
interface UseDealsResult {
|
|
430
413
|
deals: Deal[];
|
|
@@ -434,9 +417,7 @@ interface UseDealsResult {
|
|
|
434
417
|
}
|
|
435
418
|
declare function useDeals(options?: UseDealsOptions): UseDealsResult;
|
|
436
419
|
|
|
437
|
-
interface UseProductsOnSaleOptions {
|
|
438
|
-
enabled?: boolean;
|
|
439
|
-
client?: CimplifyClient;
|
|
420
|
+
interface UseProductsOnSaleOptions extends CachedQueryBaseOptions {
|
|
440
421
|
}
|
|
441
422
|
interface UseProductsOnSaleResult {
|
|
442
423
|
products: ProductDealInfo[];
|
|
@@ -446,9 +427,7 @@ interface UseProductsOnSaleResult {
|
|
|
446
427
|
}
|
|
447
428
|
declare function useProductsOnSale(options?: UseProductsOnSaleOptions): UseProductsOnSaleResult;
|
|
448
429
|
|
|
449
|
-
interface UseProductDealsOptions {
|
|
450
|
-
enabled?: boolean;
|
|
451
|
-
client?: CimplifyClient;
|
|
430
|
+
interface UseProductDealsOptions extends CachedQueryBaseOptions {
|
|
452
431
|
}
|
|
453
432
|
interface UseProductDealsResult {
|
|
454
433
|
deals: Deal[];
|
|
@@ -468,9 +447,7 @@ interface UseValidateDiscountResult {
|
|
|
468
447
|
}
|
|
469
448
|
declare function useValidateDiscount(options?: UseValidateDiscountOptions): UseValidateDiscountResult;
|
|
470
449
|
|
|
471
|
-
interface UseBundlesOptions {
|
|
472
|
-
enabled?: boolean;
|
|
473
|
-
client?: CimplifyClient;
|
|
450
|
+
interface UseBundlesOptions extends CachedQueryBaseOptions {
|
|
474
451
|
}
|
|
475
452
|
interface UseBundlesResult {
|
|
476
453
|
bundles: BundleSummary[];
|
|
@@ -499,11 +476,9 @@ interface UseProductPriceResult {
|
|
|
499
476
|
}
|
|
500
477
|
declare function useProductPrice(input: UseProductPriceInput): UseProductPriceResult;
|
|
501
478
|
|
|
502
|
-
interface UseOrdersOptions {
|
|
479
|
+
interface UseOrdersOptions extends CachedQueryBaseOptions {
|
|
503
480
|
status?: OrderStatus;
|
|
504
481
|
limit?: number;
|
|
505
|
-
enabled?: boolean;
|
|
506
|
-
client?: CimplifyClient;
|
|
507
482
|
}
|
|
508
483
|
interface UseOrdersResult {
|
|
509
484
|
orders: Order[];
|
|
@@ -513,9 +488,7 @@ interface UseOrdersResult {
|
|
|
513
488
|
}
|
|
514
489
|
declare function useOrders(options?: UseOrdersOptions): UseOrdersResult;
|
|
515
490
|
|
|
516
|
-
interface UseServicesOptions {
|
|
517
|
-
enabled?: boolean;
|
|
518
|
-
client?: CimplifyClient;
|
|
491
|
+
interface UseServicesOptions extends CachedQueryBaseOptions {
|
|
519
492
|
}
|
|
520
493
|
interface UseServicesResult {
|
|
521
494
|
services: Service[];
|
|
@@ -525,10 +498,8 @@ interface UseServicesResult {
|
|
|
525
498
|
}
|
|
526
499
|
declare function useServices(options?: UseServicesOptions): UseServicesResult;
|
|
527
500
|
|
|
528
|
-
interface UseAvailableSlotsOptions {
|
|
501
|
+
interface UseAvailableSlotsOptions extends CachedQueryBaseOptions {
|
|
529
502
|
participantCount?: number;
|
|
530
|
-
enabled?: boolean;
|
|
531
|
-
client?: CimplifyClient;
|
|
532
503
|
}
|
|
533
504
|
interface UseAvailableSlotsResult {
|
|
534
505
|
slots: AvailableSlot[];
|
|
@@ -538,11 +509,9 @@ interface UseAvailableSlotsResult {
|
|
|
538
509
|
}
|
|
539
510
|
declare function useAvailableSlots(serviceId: string | null, date: string | null, options?: UseAvailableSlotsOptions): UseAvailableSlotsResult;
|
|
540
511
|
|
|
541
|
-
interface UseServiceAvailabilityOptions {
|
|
512
|
+
interface UseServiceAvailabilityOptions extends CachedQueryBaseOptions {
|
|
542
513
|
participantCount?: number;
|
|
543
514
|
locationId?: string;
|
|
544
|
-
enabled?: boolean;
|
|
545
|
-
client?: CimplifyClient;
|
|
546
515
|
}
|
|
547
516
|
interface UseServiceAvailabilityResult {
|
|
548
517
|
days: DayAvailability[];
|
|
@@ -552,10 +521,8 @@ interface UseServiceAvailabilityResult {
|
|
|
552
521
|
}
|
|
553
522
|
declare function useServiceAvailability(serviceId: string | null, startDate: string | null, endDate: string | null, options?: UseServiceAvailabilityOptions): UseServiceAvailabilityResult;
|
|
554
523
|
|
|
555
|
-
interface UseBookingsOptions {
|
|
524
|
+
interface UseBookingsOptions extends CachedQueryBaseOptions {
|
|
556
525
|
filter?: "all" | "upcoming" | "past";
|
|
557
|
-
enabled?: boolean;
|
|
558
|
-
client?: CimplifyClient;
|
|
559
526
|
}
|
|
560
527
|
interface UseBookingsResult {
|
|
561
528
|
bookings: CustomerBooking[];
|
|
@@ -566,10 +533,8 @@ interface UseBookingsResult {
|
|
|
566
533
|
}
|
|
567
534
|
declare function useBookings(options?: UseBookingsOptions): UseBookingsResult;
|
|
568
535
|
|
|
569
|
-
interface UseAttributeDefinitionsOptions {
|
|
570
|
-
enabled?: boolean;
|
|
536
|
+
interface UseAttributeDefinitionsOptions extends CachedQueryBaseOptions {
|
|
571
537
|
namespace?: string;
|
|
572
|
-
client?: CimplifyClient;
|
|
573
538
|
}
|
|
574
539
|
interface UseAttributeDefinitionsResult {
|
|
575
540
|
definitions: CustomAttributeDefinition[];
|
|
@@ -579,9 +544,7 @@ interface UseAttributeDefinitionsResult {
|
|
|
579
544
|
}
|
|
580
545
|
declare function useAttributeDefinitions(options?: UseAttributeDefinitionsOptions): UseAttributeDefinitionsResult;
|
|
581
546
|
|
|
582
|
-
interface UsePropertyFacetsOptions {
|
|
583
|
-
enabled?: boolean;
|
|
584
|
-
client?: CimplifyClient;
|
|
547
|
+
interface UsePropertyFacetsOptions extends CachedQueryBaseOptions {
|
|
585
548
|
category_id?: string;
|
|
586
549
|
product_type?: string;
|
|
587
550
|
}
|
|
@@ -648,9 +611,7 @@ interface UseVariantSelectorResult {
|
|
|
648
611
|
*/
|
|
649
612
|
declare function useVariantSelector(options: UseVariantSelectorOptions): UseVariantSelectorResult;
|
|
650
613
|
|
|
651
|
-
interface UseActivityStateOptions {
|
|
652
|
-
enabled?: boolean;
|
|
653
|
-
client?: CimplifyClient;
|
|
614
|
+
interface UseActivityStateOptions extends CachedQueryBaseOptions {
|
|
654
615
|
}
|
|
655
616
|
interface UseActivityStateResult {
|
|
656
617
|
state: ActivityStateResponse | null;
|
|
@@ -661,19 +622,11 @@ interface UseActivityStateResult {
|
|
|
661
622
|
refetch: () => Promise<void>;
|
|
662
623
|
dismissMessage: (code: string) => Promise<void>;
|
|
663
624
|
}
|
|
664
|
-
/**
|
|
665
|
-
* useActivityState — fetches the current session activity state including messages and intent.
|
|
666
|
-
*
|
|
667
|
-
* Wraps `client.activity.getState()` with global caching and in-flight dedup.
|
|
668
|
-
* Provides a `dismissMessage` action to dismiss individual messages and refetch.
|
|
669
|
-
*/
|
|
670
625
|
declare function useActivityState(options?: UseActivityStateOptions): UseActivityStateResult;
|
|
671
626
|
|
|
672
|
-
interface UseRecommendationsOptions {
|
|
627
|
+
interface UseRecommendationsOptions extends CachedQueryBaseOptions {
|
|
673
628
|
locationId?: string;
|
|
674
629
|
limit?: number;
|
|
675
|
-
enabled?: boolean;
|
|
676
|
-
client?: CimplifyClient;
|
|
677
630
|
}
|
|
678
631
|
interface UseRecommendationsResult {
|
|
679
632
|
recommendations: ActivityRecommendation[];
|
|
@@ -682,20 +635,12 @@ interface UseRecommendationsResult {
|
|
|
682
635
|
error: CimplifyError | null;
|
|
683
636
|
refetch: () => Promise<void>;
|
|
684
637
|
}
|
|
685
|
-
/**
|
|
686
|
-
* useRecommendations — fetches personalized product recommendations based on session activity.
|
|
687
|
-
*
|
|
688
|
-
* Wraps `client.activity.getRecommendations()` with global caching and in-flight dedup.
|
|
689
|
-
* Cache key includes locationId and limit.
|
|
690
|
-
*/
|
|
691
638
|
declare function useRecommendations(options?: UseRecommendationsOptions): UseRecommendationsResult;
|
|
692
639
|
|
|
693
|
-
interface UseDeliveryFeeOptions {
|
|
640
|
+
interface UseDeliveryFeeOptions extends CachedQueryBaseOptions {
|
|
694
641
|
latitude: number;
|
|
695
642
|
longitude: number;
|
|
696
643
|
country?: string;
|
|
697
|
-
enabled?: boolean;
|
|
698
|
-
client?: CimplifyClient;
|
|
699
644
|
}
|
|
700
645
|
interface UseDeliveryFeeResult {
|
|
701
646
|
fee: DeliveryFeeResponse | null;
|
|
@@ -705,11 +650,9 @@ interface UseDeliveryFeeResult {
|
|
|
705
650
|
}
|
|
706
651
|
declare function useDeliveryFee(options: UseDeliveryFeeOptions): UseDeliveryFeeResult;
|
|
707
652
|
|
|
708
|
-
interface UseFxRateOptions {
|
|
653
|
+
interface UseFxRateOptions extends CachedQueryBaseOptions {
|
|
709
654
|
from: CurrencyCode;
|
|
710
655
|
to: CurrencyCode;
|
|
711
|
-
enabled?: boolean;
|
|
712
|
-
client?: CimplifyClient;
|
|
713
656
|
}
|
|
714
657
|
interface UseFxRateResult {
|
|
715
658
|
rate: FxRateResponse | null;
|
|
@@ -719,9 +662,7 @@ interface UseFxRateResult {
|
|
|
719
662
|
}
|
|
720
663
|
declare function useFxRate(options: UseFxRateOptions): UseFxRateResult;
|
|
721
664
|
|
|
722
|
-
interface UseBootstrapOptions {
|
|
723
|
-
enabled?: boolean;
|
|
724
|
-
client?: CimplifyClient;
|
|
665
|
+
interface UseBootstrapOptions extends CachedQueryBaseOptions {
|
|
725
666
|
}
|
|
726
667
|
interface UseBootstrapResult {
|
|
727
668
|
bootstrap: StorefrontBootstrap | null;
|
package/dist/react.d.ts
CHANGED
|
@@ -132,7 +132,12 @@ declare function useCimplify(): CimplifyContextValue;
|
|
|
132
132
|
declare function useOptionalCimplify(): CimplifyContextValue | null;
|
|
133
133
|
declare function useCimplifyClient(): CimplifyClientContextValue;
|
|
134
134
|
|
|
135
|
-
interface
|
|
135
|
+
interface CachedQueryBaseOptions {
|
|
136
|
+
enabled?: boolean;
|
|
137
|
+
client?: CimplifyClient;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
interface UseProductsOptions extends CachedQueryBaseOptions {
|
|
136
141
|
category?: string;
|
|
137
142
|
taxonomy?: string;
|
|
138
143
|
search?: string;
|
|
@@ -146,8 +151,6 @@ interface UseProductsOptions {
|
|
|
146
151
|
max_price?: number;
|
|
147
152
|
page?: number;
|
|
148
153
|
properties?: Record<string, string>;
|
|
149
|
-
enabled?: boolean;
|
|
150
|
-
client?: CimplifyClient;
|
|
151
154
|
}
|
|
152
155
|
interface UseProductsResult {
|
|
153
156
|
products: Product[];
|
|
@@ -160,9 +163,7 @@ interface UseProductsResult {
|
|
|
160
163
|
}
|
|
161
164
|
declare function useProducts(options?: UseProductsOptions): UseProductsResult;
|
|
162
165
|
|
|
163
|
-
interface UseProductOptions {
|
|
164
|
-
enabled?: boolean;
|
|
165
|
-
client?: CimplifyClient;
|
|
166
|
+
interface UseProductOptions extends CachedQueryBaseOptions {
|
|
166
167
|
}
|
|
167
168
|
interface UseProductResult {
|
|
168
169
|
product: ProductWithDetails | null;
|
|
@@ -172,9 +173,7 @@ interface UseProductResult {
|
|
|
172
173
|
}
|
|
173
174
|
declare function useProduct(slugOrId: string | null | undefined, options?: UseProductOptions): UseProductResult;
|
|
174
175
|
|
|
175
|
-
interface UseCategoriesOptions {
|
|
176
|
-
enabled?: boolean;
|
|
177
|
-
client?: CimplifyClient;
|
|
176
|
+
interface UseCategoriesOptions extends CachedQueryBaseOptions {
|
|
178
177
|
}
|
|
179
178
|
interface UseCategoriesResult {
|
|
180
179
|
categories: Category[];
|
|
@@ -283,9 +282,7 @@ interface UseLocationsResult {
|
|
|
283
282
|
}
|
|
284
283
|
declare function useLocations(options?: UseLocationsOptions): UseLocationsResult;
|
|
285
284
|
|
|
286
|
-
interface UseCollectionsOptions {
|
|
287
|
-
client?: CimplifyClient;
|
|
288
|
-
enabled?: boolean;
|
|
285
|
+
interface UseCollectionsOptions extends CachedQueryBaseOptions {
|
|
289
286
|
}
|
|
290
287
|
interface UseCollectionsResult {
|
|
291
288
|
collections: Collection[];
|
|
@@ -295,9 +292,7 @@ interface UseCollectionsResult {
|
|
|
295
292
|
}
|
|
296
293
|
declare function useCollections(options?: UseCollectionsOptions): UseCollectionsResult;
|
|
297
294
|
|
|
298
|
-
interface UseCollectionOptions {
|
|
299
|
-
client?: CimplifyClient;
|
|
300
|
-
enabled?: boolean;
|
|
295
|
+
interface UseCollectionOptions extends CachedQueryBaseOptions {
|
|
301
296
|
}
|
|
302
297
|
interface UseCollectionResult {
|
|
303
298
|
collection: Collection | null;
|
|
@@ -358,10 +353,8 @@ interface UseQuoteResult {
|
|
|
358
353
|
}
|
|
359
354
|
declare function useQuote(input: UseQuoteInput | null | undefined, options?: UseQuoteOptions): UseQuoteResult;
|
|
360
355
|
|
|
361
|
-
interface UseTaxonomiesOptions {
|
|
356
|
+
interface UseTaxonomiesOptions extends CachedQueryBaseOptions {
|
|
362
357
|
parentId?: string;
|
|
363
|
-
enabled?: boolean;
|
|
364
|
-
client?: CimplifyClient;
|
|
365
358
|
}
|
|
366
359
|
interface UseTaxonomiesResult {
|
|
367
360
|
taxonomies: ProductTaxonomy[];
|
|
@@ -371,9 +364,7 @@ interface UseTaxonomiesResult {
|
|
|
371
364
|
}
|
|
372
365
|
declare function useTaxonomies(options?: UseTaxonomiesOptions): UseTaxonomiesResult;
|
|
373
366
|
|
|
374
|
-
interface UseTaxonomyOptions {
|
|
375
|
-
enabled?: boolean;
|
|
376
|
-
client?: CimplifyClient;
|
|
367
|
+
interface UseTaxonomyOptions extends CachedQueryBaseOptions {
|
|
377
368
|
}
|
|
378
369
|
interface UseTaxonomyResult {
|
|
379
370
|
taxonomy: TaxonomyWithChildren | null;
|
|
@@ -383,9 +374,7 @@ interface UseTaxonomyResult {
|
|
|
383
374
|
}
|
|
384
375
|
declare function useTaxonomy(id: string, options?: UseTaxonomyOptions): UseTaxonomyResult;
|
|
385
376
|
|
|
386
|
-
interface UseTaxonomyPathOptions {
|
|
387
|
-
enabled?: boolean;
|
|
388
|
-
client?: CimplifyClient;
|
|
377
|
+
interface UseTaxonomyPathOptions extends CachedQueryBaseOptions {
|
|
389
378
|
}
|
|
390
379
|
interface UseTaxonomyPathResult {
|
|
391
380
|
path: ProductTaxonomy[];
|
|
@@ -395,9 +384,7 @@ interface UseTaxonomyPathResult {
|
|
|
395
384
|
}
|
|
396
385
|
declare function useTaxonomyPath(id: string, options?: UseTaxonomyPathOptions): UseTaxonomyPathResult;
|
|
397
386
|
|
|
398
|
-
interface UseProductSchedulesOptions {
|
|
399
|
-
enabled?: boolean;
|
|
400
|
-
client?: CimplifyClient;
|
|
387
|
+
interface UseProductSchedulesOptions extends CachedQueryBaseOptions {
|
|
401
388
|
}
|
|
402
389
|
interface UseProductSchedulesResult {
|
|
403
390
|
schedules: ProductTimeProfile[];
|
|
@@ -407,10 +394,8 @@ interface UseProductSchedulesResult {
|
|
|
407
394
|
}
|
|
408
395
|
declare function useProductSchedules(productId: string, options?: UseProductSchedulesOptions): UseProductSchedulesResult;
|
|
409
396
|
|
|
410
|
-
interface UseProductAvailabilityOptions {
|
|
397
|
+
interface UseProductAvailabilityOptions extends CachedQueryBaseOptions {
|
|
411
398
|
locationId?: string;
|
|
412
|
-
enabled?: boolean;
|
|
413
|
-
client?: CimplifyClient;
|
|
414
399
|
}
|
|
415
400
|
interface UseProductAvailabilityResult {
|
|
416
401
|
isAvailable: boolean | null;
|
|
@@ -421,10 +406,8 @@ interface UseProductAvailabilityResult {
|
|
|
421
406
|
}
|
|
422
407
|
declare function useProductAvailability(productId: string, options?: UseProductAvailabilityOptions): UseProductAvailabilityResult;
|
|
423
408
|
|
|
424
|
-
interface UseDealsOptions {
|
|
409
|
+
interface UseDealsOptions extends CachedQueryBaseOptions {
|
|
425
410
|
locationId?: string;
|
|
426
|
-
enabled?: boolean;
|
|
427
|
-
client?: CimplifyClient;
|
|
428
411
|
}
|
|
429
412
|
interface UseDealsResult {
|
|
430
413
|
deals: Deal[];
|
|
@@ -434,9 +417,7 @@ interface UseDealsResult {
|
|
|
434
417
|
}
|
|
435
418
|
declare function useDeals(options?: UseDealsOptions): UseDealsResult;
|
|
436
419
|
|
|
437
|
-
interface UseProductsOnSaleOptions {
|
|
438
|
-
enabled?: boolean;
|
|
439
|
-
client?: CimplifyClient;
|
|
420
|
+
interface UseProductsOnSaleOptions extends CachedQueryBaseOptions {
|
|
440
421
|
}
|
|
441
422
|
interface UseProductsOnSaleResult {
|
|
442
423
|
products: ProductDealInfo[];
|
|
@@ -446,9 +427,7 @@ interface UseProductsOnSaleResult {
|
|
|
446
427
|
}
|
|
447
428
|
declare function useProductsOnSale(options?: UseProductsOnSaleOptions): UseProductsOnSaleResult;
|
|
448
429
|
|
|
449
|
-
interface UseProductDealsOptions {
|
|
450
|
-
enabled?: boolean;
|
|
451
|
-
client?: CimplifyClient;
|
|
430
|
+
interface UseProductDealsOptions extends CachedQueryBaseOptions {
|
|
452
431
|
}
|
|
453
432
|
interface UseProductDealsResult {
|
|
454
433
|
deals: Deal[];
|
|
@@ -468,9 +447,7 @@ interface UseValidateDiscountResult {
|
|
|
468
447
|
}
|
|
469
448
|
declare function useValidateDiscount(options?: UseValidateDiscountOptions): UseValidateDiscountResult;
|
|
470
449
|
|
|
471
|
-
interface UseBundlesOptions {
|
|
472
|
-
enabled?: boolean;
|
|
473
|
-
client?: CimplifyClient;
|
|
450
|
+
interface UseBundlesOptions extends CachedQueryBaseOptions {
|
|
474
451
|
}
|
|
475
452
|
interface UseBundlesResult {
|
|
476
453
|
bundles: BundleSummary[];
|
|
@@ -499,11 +476,9 @@ interface UseProductPriceResult {
|
|
|
499
476
|
}
|
|
500
477
|
declare function useProductPrice(input: UseProductPriceInput): UseProductPriceResult;
|
|
501
478
|
|
|
502
|
-
interface UseOrdersOptions {
|
|
479
|
+
interface UseOrdersOptions extends CachedQueryBaseOptions {
|
|
503
480
|
status?: OrderStatus;
|
|
504
481
|
limit?: number;
|
|
505
|
-
enabled?: boolean;
|
|
506
|
-
client?: CimplifyClient;
|
|
507
482
|
}
|
|
508
483
|
interface UseOrdersResult {
|
|
509
484
|
orders: Order[];
|
|
@@ -513,9 +488,7 @@ interface UseOrdersResult {
|
|
|
513
488
|
}
|
|
514
489
|
declare function useOrders(options?: UseOrdersOptions): UseOrdersResult;
|
|
515
490
|
|
|
516
|
-
interface UseServicesOptions {
|
|
517
|
-
enabled?: boolean;
|
|
518
|
-
client?: CimplifyClient;
|
|
491
|
+
interface UseServicesOptions extends CachedQueryBaseOptions {
|
|
519
492
|
}
|
|
520
493
|
interface UseServicesResult {
|
|
521
494
|
services: Service[];
|
|
@@ -525,10 +498,8 @@ interface UseServicesResult {
|
|
|
525
498
|
}
|
|
526
499
|
declare function useServices(options?: UseServicesOptions): UseServicesResult;
|
|
527
500
|
|
|
528
|
-
interface UseAvailableSlotsOptions {
|
|
501
|
+
interface UseAvailableSlotsOptions extends CachedQueryBaseOptions {
|
|
529
502
|
participantCount?: number;
|
|
530
|
-
enabled?: boolean;
|
|
531
|
-
client?: CimplifyClient;
|
|
532
503
|
}
|
|
533
504
|
interface UseAvailableSlotsResult {
|
|
534
505
|
slots: AvailableSlot[];
|
|
@@ -538,11 +509,9 @@ interface UseAvailableSlotsResult {
|
|
|
538
509
|
}
|
|
539
510
|
declare function useAvailableSlots(serviceId: string | null, date: string | null, options?: UseAvailableSlotsOptions): UseAvailableSlotsResult;
|
|
540
511
|
|
|
541
|
-
interface UseServiceAvailabilityOptions {
|
|
512
|
+
interface UseServiceAvailabilityOptions extends CachedQueryBaseOptions {
|
|
542
513
|
participantCount?: number;
|
|
543
514
|
locationId?: string;
|
|
544
|
-
enabled?: boolean;
|
|
545
|
-
client?: CimplifyClient;
|
|
546
515
|
}
|
|
547
516
|
interface UseServiceAvailabilityResult {
|
|
548
517
|
days: DayAvailability[];
|
|
@@ -552,10 +521,8 @@ interface UseServiceAvailabilityResult {
|
|
|
552
521
|
}
|
|
553
522
|
declare function useServiceAvailability(serviceId: string | null, startDate: string | null, endDate: string | null, options?: UseServiceAvailabilityOptions): UseServiceAvailabilityResult;
|
|
554
523
|
|
|
555
|
-
interface UseBookingsOptions {
|
|
524
|
+
interface UseBookingsOptions extends CachedQueryBaseOptions {
|
|
556
525
|
filter?: "all" | "upcoming" | "past";
|
|
557
|
-
enabled?: boolean;
|
|
558
|
-
client?: CimplifyClient;
|
|
559
526
|
}
|
|
560
527
|
interface UseBookingsResult {
|
|
561
528
|
bookings: CustomerBooking[];
|
|
@@ -566,10 +533,8 @@ interface UseBookingsResult {
|
|
|
566
533
|
}
|
|
567
534
|
declare function useBookings(options?: UseBookingsOptions): UseBookingsResult;
|
|
568
535
|
|
|
569
|
-
interface UseAttributeDefinitionsOptions {
|
|
570
|
-
enabled?: boolean;
|
|
536
|
+
interface UseAttributeDefinitionsOptions extends CachedQueryBaseOptions {
|
|
571
537
|
namespace?: string;
|
|
572
|
-
client?: CimplifyClient;
|
|
573
538
|
}
|
|
574
539
|
interface UseAttributeDefinitionsResult {
|
|
575
540
|
definitions: CustomAttributeDefinition[];
|
|
@@ -579,9 +544,7 @@ interface UseAttributeDefinitionsResult {
|
|
|
579
544
|
}
|
|
580
545
|
declare function useAttributeDefinitions(options?: UseAttributeDefinitionsOptions): UseAttributeDefinitionsResult;
|
|
581
546
|
|
|
582
|
-
interface UsePropertyFacetsOptions {
|
|
583
|
-
enabled?: boolean;
|
|
584
|
-
client?: CimplifyClient;
|
|
547
|
+
interface UsePropertyFacetsOptions extends CachedQueryBaseOptions {
|
|
585
548
|
category_id?: string;
|
|
586
549
|
product_type?: string;
|
|
587
550
|
}
|
|
@@ -648,9 +611,7 @@ interface UseVariantSelectorResult {
|
|
|
648
611
|
*/
|
|
649
612
|
declare function useVariantSelector(options: UseVariantSelectorOptions): UseVariantSelectorResult;
|
|
650
613
|
|
|
651
|
-
interface UseActivityStateOptions {
|
|
652
|
-
enabled?: boolean;
|
|
653
|
-
client?: CimplifyClient;
|
|
614
|
+
interface UseActivityStateOptions extends CachedQueryBaseOptions {
|
|
654
615
|
}
|
|
655
616
|
interface UseActivityStateResult {
|
|
656
617
|
state: ActivityStateResponse | null;
|
|
@@ -661,19 +622,11 @@ interface UseActivityStateResult {
|
|
|
661
622
|
refetch: () => Promise<void>;
|
|
662
623
|
dismissMessage: (code: string) => Promise<void>;
|
|
663
624
|
}
|
|
664
|
-
/**
|
|
665
|
-
* useActivityState — fetches the current session activity state including messages and intent.
|
|
666
|
-
*
|
|
667
|
-
* Wraps `client.activity.getState()` with global caching and in-flight dedup.
|
|
668
|
-
* Provides a `dismissMessage` action to dismiss individual messages and refetch.
|
|
669
|
-
*/
|
|
670
625
|
declare function useActivityState(options?: UseActivityStateOptions): UseActivityStateResult;
|
|
671
626
|
|
|
672
|
-
interface UseRecommendationsOptions {
|
|
627
|
+
interface UseRecommendationsOptions extends CachedQueryBaseOptions {
|
|
673
628
|
locationId?: string;
|
|
674
629
|
limit?: number;
|
|
675
|
-
enabled?: boolean;
|
|
676
|
-
client?: CimplifyClient;
|
|
677
630
|
}
|
|
678
631
|
interface UseRecommendationsResult {
|
|
679
632
|
recommendations: ActivityRecommendation[];
|
|
@@ -682,20 +635,12 @@ interface UseRecommendationsResult {
|
|
|
682
635
|
error: CimplifyError | null;
|
|
683
636
|
refetch: () => Promise<void>;
|
|
684
637
|
}
|
|
685
|
-
/**
|
|
686
|
-
* useRecommendations — fetches personalized product recommendations based on session activity.
|
|
687
|
-
*
|
|
688
|
-
* Wraps `client.activity.getRecommendations()` with global caching and in-flight dedup.
|
|
689
|
-
* Cache key includes locationId and limit.
|
|
690
|
-
*/
|
|
691
638
|
declare function useRecommendations(options?: UseRecommendationsOptions): UseRecommendationsResult;
|
|
692
639
|
|
|
693
|
-
interface UseDeliveryFeeOptions {
|
|
640
|
+
interface UseDeliveryFeeOptions extends CachedQueryBaseOptions {
|
|
694
641
|
latitude: number;
|
|
695
642
|
longitude: number;
|
|
696
643
|
country?: string;
|
|
697
|
-
enabled?: boolean;
|
|
698
|
-
client?: CimplifyClient;
|
|
699
644
|
}
|
|
700
645
|
interface UseDeliveryFeeResult {
|
|
701
646
|
fee: DeliveryFeeResponse | null;
|
|
@@ -705,11 +650,9 @@ interface UseDeliveryFeeResult {
|
|
|
705
650
|
}
|
|
706
651
|
declare function useDeliveryFee(options: UseDeliveryFeeOptions): UseDeliveryFeeResult;
|
|
707
652
|
|
|
708
|
-
interface UseFxRateOptions {
|
|
653
|
+
interface UseFxRateOptions extends CachedQueryBaseOptions {
|
|
709
654
|
from: CurrencyCode;
|
|
710
655
|
to: CurrencyCode;
|
|
711
|
-
enabled?: boolean;
|
|
712
|
-
client?: CimplifyClient;
|
|
713
656
|
}
|
|
714
657
|
interface UseFxRateResult {
|
|
715
658
|
rate: FxRateResponse | null;
|
|
@@ -719,9 +662,7 @@ interface UseFxRateResult {
|
|
|
719
662
|
}
|
|
720
663
|
declare function useFxRate(options: UseFxRateOptions): UseFxRateResult;
|
|
721
664
|
|
|
722
|
-
interface UseBootstrapOptions {
|
|
723
|
-
enabled?: boolean;
|
|
724
|
-
client?: CimplifyClient;
|
|
665
|
+
interface UseBootstrapOptions extends CachedQueryBaseOptions {
|
|
725
666
|
}
|
|
726
667
|
interface UseBootstrapResult {
|
|
727
668
|
bootstrap: StorefrontBootstrap | null;
|