@lightspeed/ecom-headless 1.1.5-rc.0 → 1.2.0-rc.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.
Files changed (31) hide show
  1. package/CHANGELOG.md +5 -6
  2. package/README.md +8 -3
  3. package/dist/index.cjs +1 -1
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +2 -2
  6. package/dist/index.d.mts +2 -2
  7. package/dist/index.d.ts +2 -2
  8. package/dist/index.mjs +1 -1
  9. package/dist/index.mjs.map +1 -1
  10. package/dist/plugin-visualizer/bundle.html +1 -1
  11. package/dist/shared/ecom-headless.BF4ITfQc.cjs +2 -0
  12. package/dist/shared/ecom-headless.BF4ITfQc.cjs.map +1 -0
  13. package/dist/shared/{ecom-headless.C9ivNZI7.d.cts → ecom-headless.BeJeXdSY.d.mts} +99 -24
  14. package/dist/shared/{ecom-headless.DU9eDsgV.d.ts → ecom-headless.CmRks5zy.d.cts} +99 -24
  15. package/dist/shared/ecom-headless.CyyXXtdO.mjs +2 -0
  16. package/dist/shared/ecom-headless.CyyXXtdO.mjs.map +1 -0
  17. package/dist/shared/{ecom-headless.DGDJogyS.d.ts → ecom-headless.UNkw31Vf.d.cts} +311 -2
  18. package/dist/shared/{ecom-headless.DGDJogyS.d.cts → ecom-headless.UNkw31Vf.d.mts} +311 -2
  19. package/dist/shared/{ecom-headless.DGDJogyS.d.mts → ecom-headless.UNkw31Vf.d.ts} +311 -2
  20. package/dist/shared/{ecom-headless.BhIymLsJ.d.mts → ecom-headless.vv_Pbr6W.d.ts} +99 -24
  21. package/dist/storefront/index.cjs +1 -1
  22. package/dist/storefront/index.cjs.map +1 -1
  23. package/dist/storefront/index.d.cts +2 -2
  24. package/dist/storefront/index.d.mts +2 -2
  25. package/dist/storefront/index.d.ts +2 -2
  26. package/dist/storefront/index.mjs +1 -1
  27. package/dist/storefront/index.mjs.map +1 -1
  28. package/dist/types/index.d.cts +1 -1
  29. package/dist/types/index.d.mts +1 -1
  30. package/dist/types/index.d.ts +1 -1
  31. package/package.json +11 -7
@@ -475,5 +475,314 @@ interface VisitorLocation {
475
475
  source: VisitorLocationSourceType;
476
476
  }
477
477
 
478
- export { LegalPageTypeValues as L, CustomerCookieConsentValues as s, JsApiPageValues as x, VisitorLocationSourceValues as y };
479
- export type { AddProductData as A, BaseJsApiPage as B, CartAddProductCallback as C, EcwidApiPromise as E, JsApiFilterParams as J, Order as O, RecurringChargeSettings as R, ShippingAddress as S, TrackingConsent as T, VisitorLocation as V, AddProductParameter as a, AddProductRecurringChargeSettings as b, BillingPerson as c, CartApi as d, CartCalculateTotalCallback as e, CartClearCallback as f, CartData as g, CartDominatingColor as h, CartGetCallback as i, CartGoToCheckoutCallback as j, CartImageBorderInfo as k, CartItem as l, CartMediaItem as m, CartProduct as n, CartRemoveProductCallback as o, CartRemoveProductsCallback as p, CartVideoInfo as q, CustomerApi as r, CustomerData as t, CustomerGetCallback as u, CustomerSignOutCallback as v, JsApiPage as w, CustomerCookieConsentType as z };
478
+ declare const StorefrontRuntimeBridgeVersion: 1;
479
+ declare const StorefrontRuntimeCapabilityValues: {
480
+ readonly CATALOG_PAGE: "CATALOG_PAGE";
481
+ readonly CATALOG_FILTERS: "CATALOG_FILTERS";
482
+ readonly CATEGORY_MENU: "CATEGORY_MENU";
483
+ readonly CATALOG_SUBSCRIPTION: "CATALOG_SUBSCRIPTION";
484
+ readonly PRODUCT: "PRODUCT";
485
+ readonly PRODUCT_CONFIGURATION: "PRODUCT_CONFIGURATION";
486
+ readonly RELATED_PRODUCTS: "RELATED_PRODUCTS";
487
+ readonly PRODUCTS_SUBSCRIPTION: "PRODUCTS_SUBSCRIPTION";
488
+ readonly FAVORITES_STATE: "FAVORITES_STATE";
489
+ readonly FAVORITES_MUTATION: "FAVORITES_MUTATION";
490
+ readonly FAVORITES_SUBSCRIPTION: "FAVORITES_SUBSCRIPTION";
491
+ };
492
+ type StorefrontRuntimeCapability = typeof StorefrontRuntimeCapabilityValues[keyof typeof StorefrontRuntimeCapabilityValues];
493
+ type StorefrontCatalogProductSortOrder = 'DEFINED_BY_STORE_OWNER' | 'ADDED_TIME_DESC' | 'PRICE_ASC' | 'PRICE_DESC' | 'NAME_ASC' | 'NAME_DESC' | 'IN_STORE_RECEIVED_DATE_DESC';
494
+ interface StorefrontProductFilters {
495
+ readonly categories?: readonly number[];
496
+ readonly keyword?: string;
497
+ readonly priceFrom?: number;
498
+ readonly priceTo?: number;
499
+ readonly inventory?: 'instock' | 'outofstock';
500
+ readonly uncategorized?: boolean;
501
+ readonly onSale?: 'onsale' | 'notonsale';
502
+ readonly attributes?: Readonly<Record<string, readonly string[]>>;
503
+ readonly options?: Readonly<Record<string, readonly string[]>>;
504
+ readonly sku?: string;
505
+ readonly swatch?: Readonly<Record<string, readonly string[]>>;
506
+ readonly locations?: readonly string[];
507
+ }
508
+ interface StorefrontPagination {
509
+ readonly offset: number;
510
+ readonly limit: number;
511
+ }
512
+ interface StorefrontListingRequest {
513
+ readonly filters: StorefrontProductFilters;
514
+ readonly sortBy: StorefrontCatalogProductSortOrder;
515
+ readonly pagination: StorefrontPagination;
516
+ }
517
+ interface StorefrontCatalogPageRequest {
518
+ readonly categoryId?: number;
519
+ readonly isArtificialCategory?: boolean;
520
+ readonly listing: StorefrontListingRequest;
521
+ }
522
+ interface StorefrontCatalogFiltersRequest {
523
+ readonly categoryId?: number;
524
+ readonly isArtificialCategory?: boolean;
525
+ readonly filters: StorefrontProductFilters;
526
+ }
527
+ interface StorefrontCategoryMenuRequest {
528
+ readonly categoryId?: number;
529
+ readonly isArtificialCategory?: boolean;
530
+ readonly pagination: StorefrontPagination;
531
+ }
532
+ interface StorefrontProductRequest {
533
+ readonly productId: number;
534
+ readonly variationId?: number;
535
+ readonly selectedOptionIndexes?: readonly number[];
536
+ }
537
+ type StorefrontSelectedOptions = Readonly<Record<string, string | readonly string[]>>;
538
+ interface StorefrontProductConfigurationRequest {
539
+ readonly productId: number;
540
+ readonly selectedOptions: StorefrontSelectedOptions;
541
+ readonly customPrice?: number;
542
+ }
543
+ interface StorefrontRelatedProductsRequest {
544
+ readonly productId: number;
545
+ }
546
+ interface StorefrontPicture {
547
+ readonly alt?: string;
548
+ readonly width: number;
549
+ readonly height: number;
550
+ readonly image160pxUrl?: string;
551
+ readonly image400pxUrl?: string;
552
+ readonly image800pxUrl?: string;
553
+ readonly image1500pxUrl?: string;
554
+ readonly imageOriginalUrl?: string;
555
+ }
556
+ interface StorefrontProductMedia extends StorefrontPicture {
557
+ readonly id: string;
558
+ readonly type: 'PICTURE' | 'VIDEO';
559
+ readonly isMain: boolean;
560
+ readonly video?: {
561
+ readonly embedHtml: string;
562
+ readonly url: string;
563
+ readonly width?: number;
564
+ readonly height?: number;
565
+ };
566
+ }
567
+ interface StorefrontCategorySummary {
568
+ readonly id: number;
569
+ readonly name: string;
570
+ readonly media?: StorefrontPicture;
571
+ readonly slugs: {
572
+ readonly forRouteWithId: string;
573
+ readonly forRouteWithoutId?: string;
574
+ };
575
+ }
576
+ interface StorefrontCategoryDetails extends StorefrontCategorySummary {
577
+ readonly description: string;
578
+ readonly categoryPath: readonly StorefrontCategorySummary[];
579
+ readonly seo: {
580
+ readonly title?: string;
581
+ readonly description?: string;
582
+ readonly canonicalUrl?: string;
583
+ };
584
+ }
585
+ interface StorefrontProductAttribute {
586
+ readonly id: number;
587
+ readonly name: string;
588
+ readonly type: string;
589
+ readonly value: string;
590
+ readonly separator: string;
591
+ readonly isNameAndValueSwapped: boolean;
592
+ }
593
+ interface StorefrontOptionChoice {
594
+ readonly choiceId: string;
595
+ readonly choiceName: string;
596
+ readonly modifierFormatted: string;
597
+ readonly visibility?: string;
598
+ readonly hexCodes?: readonly string[];
599
+ }
600
+ interface StorefrontProductOption {
601
+ readonly type: string;
602
+ readonly optionId: string;
603
+ readonly optionText: string;
604
+ readonly required: boolean;
605
+ readonly placeholder?: string;
606
+ readonly maxLength?: number;
607
+ readonly useImageAsSwatchSelector?: boolean;
608
+ readonly selected?: string | readonly string[];
609
+ readonly choices: readonly StorefrontOptionChoice[];
610
+ }
611
+ interface StorefrontAppliedTax {
612
+ readonly name: string;
613
+ readonly percent: number;
614
+ readonly price: number;
615
+ }
616
+ interface StorefrontWholesalePrice {
617
+ readonly quantity: number;
618
+ readonly price: number;
619
+ readonly priceFormatted: string;
620
+ readonly discountPercent: number;
621
+ }
622
+ interface StorefrontPriceRange {
623
+ readonly minPrice: number;
624
+ readonly maxPrice: number;
625
+ readonly minPriceFormatted: string;
626
+ readonly maxPriceFormatted: string;
627
+ readonly minCompareToPrice: number;
628
+ readonly maxCompareToPrice: number;
629
+ }
630
+ interface StorefrontProductPrice {
631
+ readonly price: number;
632
+ readonly priceFormatted: string;
633
+ readonly compareToPrice?: number;
634
+ readonly compareToPriceFormatted?: string;
635
+ readonly range?: StorefrontPriceRange;
636
+ readonly lowestPrice?: {
637
+ readonly labelForProductList: string;
638
+ readonly labelForProductDetails: string;
639
+ };
640
+ readonly appliedTaxes: readonly StorefrontAppliedTax[];
641
+ readonly wholesalePrices: readonly StorefrontWholesalePrice[];
642
+ }
643
+ interface StorefrontProductInventory {
644
+ readonly isSoldOut: boolean;
645
+ readonly isPreorderAllowed: boolean;
646
+ readonly isShippingRequired: boolean;
647
+ readonly quantity?: number;
648
+ readonly warningLimit?: number;
649
+ readonly minPurchaseQuantity?: number;
650
+ readonly maxPurchaseQuantity?: number;
651
+ readonly weight?: {
652
+ readonly value: number;
653
+ readonly formattedValue: string;
654
+ };
655
+ readonly dimensions?: {
656
+ readonly length: number;
657
+ readonly width: number;
658
+ readonly height: number;
659
+ };
660
+ }
661
+ type StorefrontPurchaseKind = 'NORMAL' | 'CUSTOM_PRICE' | 'SUBSCRIPTION' | 'UNSUPPORTED';
662
+ interface StorefrontProductConfiguration {
663
+ readonly variationId?: number;
664
+ readonly sku?: string;
665
+ readonly selectedOptions: StorefrontSelectedOptions;
666
+ readonly options: readonly StorefrontProductOption[];
667
+ readonly media: readonly StorefrontProductMedia[];
668
+ readonly price: StorefrontProductPrice;
669
+ readonly inventory: StorefrontProductInventory;
670
+ readonly attributes: readonly StorefrontProductAttribute[];
671
+ readonly purchaseKind: StorefrontPurchaseKind;
672
+ readonly isSelectionComplete: boolean;
673
+ readonly isPurchasable: boolean;
674
+ }
675
+ interface StorefrontProduct {
676
+ readonly id: number;
677
+ readonly variationId?: number;
678
+ readonly name: string;
679
+ readonly subtitle: string;
680
+ readonly description: string;
681
+ readonly sku?: string;
682
+ readonly urls: {
683
+ readonly directPageUrl: string;
684
+ readonly proxyLinkUrl: string;
685
+ };
686
+ readonly categoryPaths: readonly {
687
+ readonly isDefault: boolean;
688
+ readonly items: readonly StorefrontCategorySummary[];
689
+ }[];
690
+ readonly attributes: readonly StorefrontProductAttribute[];
691
+ readonly options: readonly StorefrontProductOption[];
692
+ readonly media: readonly StorefrontProductMedia[];
693
+ readonly gridMedia: readonly StorefrontProductMedia[];
694
+ readonly price: StorefrontProductPrice;
695
+ readonly inventory: StorefrontProductInventory;
696
+ readonly rating: number;
697
+ readonly reviewsPublishedCount: number;
698
+ readonly ribbon?: {
699
+ readonly text: string;
700
+ readonly color: string;
701
+ };
702
+ readonly flags: {
703
+ readonly canAddToBagSilently: boolean;
704
+ readonly hasRelatedProducts: boolean;
705
+ readonly hasSizeChart: boolean;
706
+ readonly isGiftCard: boolean;
707
+ };
708
+ readonly defaultConfiguration: StorefrontProductConfiguration;
709
+ }
710
+ interface StorefrontExpandedCategory {
711
+ readonly category: StorefrontCategoryDetails;
712
+ readonly subcategories: readonly StorefrontCategorySummary[];
713
+ readonly products: readonly StorefrontProduct[];
714
+ readonly totalProductsCount: number;
715
+ readonly hasMoreProducts: boolean;
716
+ }
717
+ interface StorefrontCatalogPage {
718
+ readonly expandedCategories: readonly StorefrontExpandedCategory[];
719
+ readonly collapsedCategories: readonly StorefrontCategorySummary[];
720
+ }
721
+ interface StorefrontFilterValue {
722
+ readonly filterId: string | number;
723
+ readonly filterName?: string;
724
+ readonly productCount: number;
725
+ }
726
+ interface StorefrontCatalogValuesFilter {
727
+ readonly type: 'INVENTORY' | 'ON_SALE' | 'CATEGORIES' | 'LOCATIONS';
728
+ readonly values: readonly StorefrontFilterValue[];
729
+ readonly totalCount?: number;
730
+ }
731
+ interface StorefrontCatalogPriceFilter {
732
+ readonly type: 'PRICE';
733
+ readonly values?: {
734
+ readonly min: number;
735
+ readonly max: number;
736
+ };
737
+ }
738
+ interface StorefrontCatalogOptionFilter {
739
+ readonly type: 'OPTION' | 'SWATCH';
740
+ readonly optionId: string;
741
+ readonly optionName: string;
742
+ readonly displayComponent?: string;
743
+ readonly values: readonly (StorefrontFilterValue & {
744
+ readonly hexCodes?: readonly string[];
745
+ })[];
746
+ }
747
+ interface StorefrontCatalogAttributeFilter {
748
+ readonly type: 'ATTRIBUTE';
749
+ readonly attributeId: string;
750
+ readonly attributeName: string;
751
+ readonly values: readonly StorefrontFilterValue[];
752
+ }
753
+ interface StorefrontCatalogMarkerFilter {
754
+ readonly type: 'SEARCH' | 'SKU';
755
+ }
756
+ type StorefrontCatalogFilter = StorefrontCatalogValuesFilter | StorefrontCatalogPriceFilter | StorefrontCatalogOptionFilter | StorefrontCatalogAttributeFilter | StorefrontCatalogMarkerFilter;
757
+ interface StorefrontCatalogFilters {
758
+ readonly filters: readonly StorefrontCatalogFilter[];
759
+ readonly productCount?: number;
760
+ }
761
+ interface StorefrontCategoryMenuItem {
762
+ readonly id: number;
763
+ readonly name: string;
764
+ readonly slugs?: {
765
+ readonly forRouteWithId: string;
766
+ readonly forRouteWithoutId?: string;
767
+ };
768
+ readonly productCount?: number;
769
+ readonly hasChildren?: boolean;
770
+ readonly uncategorized?: boolean;
771
+ }
772
+ interface StorefrontCategoryMenu {
773
+ readonly currentPath: readonly StorefrontCategoryMenuItem[];
774
+ readonly totalCount: number;
775
+ readonly limit: number;
776
+ readonly offset: number;
777
+ readonly page: number;
778
+ readonly categories: readonly StorefrontCategoryMenuItem[];
779
+ readonly productCount: number;
780
+ }
781
+ interface StorefrontFavoritesState {
782
+ readonly productIds: readonly number[];
783
+ readonly count: number;
784
+ readonly customerState: 'GUEST' | 'AUTHENTICATED';
785
+ }
786
+
787
+ export { LegalPageTypeValues as L, StorefrontRuntimeBridgeVersion as ag, StorefrontRuntimeCapabilityValues as ai, VisitorLocationSourceValues as an, CustomerCookieConsentValues as s, JsApiPageValues as x };
788
+ export type { StorefrontListingRequest as $, AddProductData as A, BaseJsApiPage as B, CartAddProductCallback as C, StorefrontCatalogFilter as D, EcwidApiPromise as E, StorefrontCatalogFilters as F, StorefrontCatalogFiltersRequest as G, StorefrontCatalogMarkerFilter as H, StorefrontCatalogOptionFilter as I, JsApiFilterParams as J, StorefrontCatalogPage as K, StorefrontCatalogPageRequest as M, StorefrontCatalogPriceFilter as N, Order as O, StorefrontCatalogProductSortOrder as P, StorefrontCatalogValuesFilter as Q, RecurringChargeSettings as R, ShippingAddress as S, StorefrontCategoryDetails as T, StorefrontCategoryMenu as U, StorefrontCategoryMenuItem as V, StorefrontCategoryMenuRequest as W, StorefrontCategorySummary as X, StorefrontExpandedCategory as Y, StorefrontFavoritesState as Z, StorefrontFilterValue as _, AddProductParameter as a, StorefrontOptionChoice as a0, StorefrontPagination as a1, StorefrontPicture as a2, StorefrontPriceRange as a3, StorefrontProduct as a4, StorefrontProductAttribute as a5, StorefrontProductConfiguration as a6, StorefrontProductConfigurationRequest as a7, StorefrontProductFilters as a8, StorefrontProductInventory as a9, StorefrontProductMedia as aa, StorefrontProductOption as ab, StorefrontProductPrice as ac, StorefrontProductRequest as ad, StorefrontPurchaseKind as ae, StorefrontRelatedProductsRequest as af, StorefrontRuntimeCapability as ah, StorefrontSelectedOptions as aj, StorefrontWholesalePrice as ak, TrackingConsent as al, VisitorLocation as am, CustomerCookieConsentType as ao, AddProductRecurringChargeSettings as b, BillingPerson as c, CartApi as d, CartCalculateTotalCallback as e, CartClearCallback as f, CartData as g, CartDominatingColor as h, CartGetCallback as i, CartGoToCheckoutCallback as j, CartImageBorderInfo as k, CartItem as l, CartMediaItem as m, CartProduct as n, CartRemoveProductCallback as o, CartRemoveProductsCallback as p, CartVideoInfo as q, CustomerApi as r, CustomerData as t, CustomerGetCallback as u, CustomerSignOutCallback as v, JsApiPage as w, StorefrontAppliedTax as y, StorefrontCatalogAttributeFilter as z };
@@ -475,5 +475,314 @@ interface VisitorLocation {
475
475
  source: VisitorLocationSourceType;
476
476
  }
477
477
 
478
- export { LegalPageTypeValues as L, CustomerCookieConsentValues as s, JsApiPageValues as x, VisitorLocationSourceValues as y };
479
- export type { AddProductData as A, BaseJsApiPage as B, CartAddProductCallback as C, EcwidApiPromise as E, JsApiFilterParams as J, Order as O, RecurringChargeSettings as R, ShippingAddress as S, TrackingConsent as T, VisitorLocation as V, AddProductParameter as a, AddProductRecurringChargeSettings as b, BillingPerson as c, CartApi as d, CartCalculateTotalCallback as e, CartClearCallback as f, CartData as g, CartDominatingColor as h, CartGetCallback as i, CartGoToCheckoutCallback as j, CartImageBorderInfo as k, CartItem as l, CartMediaItem as m, CartProduct as n, CartRemoveProductCallback as o, CartRemoveProductsCallback as p, CartVideoInfo as q, CustomerApi as r, CustomerData as t, CustomerGetCallback as u, CustomerSignOutCallback as v, JsApiPage as w, CustomerCookieConsentType as z };
478
+ declare const StorefrontRuntimeBridgeVersion: 1;
479
+ declare const StorefrontRuntimeCapabilityValues: {
480
+ readonly CATALOG_PAGE: "CATALOG_PAGE";
481
+ readonly CATALOG_FILTERS: "CATALOG_FILTERS";
482
+ readonly CATEGORY_MENU: "CATEGORY_MENU";
483
+ readonly CATALOG_SUBSCRIPTION: "CATALOG_SUBSCRIPTION";
484
+ readonly PRODUCT: "PRODUCT";
485
+ readonly PRODUCT_CONFIGURATION: "PRODUCT_CONFIGURATION";
486
+ readonly RELATED_PRODUCTS: "RELATED_PRODUCTS";
487
+ readonly PRODUCTS_SUBSCRIPTION: "PRODUCTS_SUBSCRIPTION";
488
+ readonly FAVORITES_STATE: "FAVORITES_STATE";
489
+ readonly FAVORITES_MUTATION: "FAVORITES_MUTATION";
490
+ readonly FAVORITES_SUBSCRIPTION: "FAVORITES_SUBSCRIPTION";
491
+ };
492
+ type StorefrontRuntimeCapability = typeof StorefrontRuntimeCapabilityValues[keyof typeof StorefrontRuntimeCapabilityValues];
493
+ type StorefrontCatalogProductSortOrder = 'DEFINED_BY_STORE_OWNER' | 'ADDED_TIME_DESC' | 'PRICE_ASC' | 'PRICE_DESC' | 'NAME_ASC' | 'NAME_DESC' | 'IN_STORE_RECEIVED_DATE_DESC';
494
+ interface StorefrontProductFilters {
495
+ readonly categories?: readonly number[];
496
+ readonly keyword?: string;
497
+ readonly priceFrom?: number;
498
+ readonly priceTo?: number;
499
+ readonly inventory?: 'instock' | 'outofstock';
500
+ readonly uncategorized?: boolean;
501
+ readonly onSale?: 'onsale' | 'notonsale';
502
+ readonly attributes?: Readonly<Record<string, readonly string[]>>;
503
+ readonly options?: Readonly<Record<string, readonly string[]>>;
504
+ readonly sku?: string;
505
+ readonly swatch?: Readonly<Record<string, readonly string[]>>;
506
+ readonly locations?: readonly string[];
507
+ }
508
+ interface StorefrontPagination {
509
+ readonly offset: number;
510
+ readonly limit: number;
511
+ }
512
+ interface StorefrontListingRequest {
513
+ readonly filters: StorefrontProductFilters;
514
+ readonly sortBy: StorefrontCatalogProductSortOrder;
515
+ readonly pagination: StorefrontPagination;
516
+ }
517
+ interface StorefrontCatalogPageRequest {
518
+ readonly categoryId?: number;
519
+ readonly isArtificialCategory?: boolean;
520
+ readonly listing: StorefrontListingRequest;
521
+ }
522
+ interface StorefrontCatalogFiltersRequest {
523
+ readonly categoryId?: number;
524
+ readonly isArtificialCategory?: boolean;
525
+ readonly filters: StorefrontProductFilters;
526
+ }
527
+ interface StorefrontCategoryMenuRequest {
528
+ readonly categoryId?: number;
529
+ readonly isArtificialCategory?: boolean;
530
+ readonly pagination: StorefrontPagination;
531
+ }
532
+ interface StorefrontProductRequest {
533
+ readonly productId: number;
534
+ readonly variationId?: number;
535
+ readonly selectedOptionIndexes?: readonly number[];
536
+ }
537
+ type StorefrontSelectedOptions = Readonly<Record<string, string | readonly string[]>>;
538
+ interface StorefrontProductConfigurationRequest {
539
+ readonly productId: number;
540
+ readonly selectedOptions: StorefrontSelectedOptions;
541
+ readonly customPrice?: number;
542
+ }
543
+ interface StorefrontRelatedProductsRequest {
544
+ readonly productId: number;
545
+ }
546
+ interface StorefrontPicture {
547
+ readonly alt?: string;
548
+ readonly width: number;
549
+ readonly height: number;
550
+ readonly image160pxUrl?: string;
551
+ readonly image400pxUrl?: string;
552
+ readonly image800pxUrl?: string;
553
+ readonly image1500pxUrl?: string;
554
+ readonly imageOriginalUrl?: string;
555
+ }
556
+ interface StorefrontProductMedia extends StorefrontPicture {
557
+ readonly id: string;
558
+ readonly type: 'PICTURE' | 'VIDEO';
559
+ readonly isMain: boolean;
560
+ readonly video?: {
561
+ readonly embedHtml: string;
562
+ readonly url: string;
563
+ readonly width?: number;
564
+ readonly height?: number;
565
+ };
566
+ }
567
+ interface StorefrontCategorySummary {
568
+ readonly id: number;
569
+ readonly name: string;
570
+ readonly media?: StorefrontPicture;
571
+ readonly slugs: {
572
+ readonly forRouteWithId: string;
573
+ readonly forRouteWithoutId?: string;
574
+ };
575
+ }
576
+ interface StorefrontCategoryDetails extends StorefrontCategorySummary {
577
+ readonly description: string;
578
+ readonly categoryPath: readonly StorefrontCategorySummary[];
579
+ readonly seo: {
580
+ readonly title?: string;
581
+ readonly description?: string;
582
+ readonly canonicalUrl?: string;
583
+ };
584
+ }
585
+ interface StorefrontProductAttribute {
586
+ readonly id: number;
587
+ readonly name: string;
588
+ readonly type: string;
589
+ readonly value: string;
590
+ readonly separator: string;
591
+ readonly isNameAndValueSwapped: boolean;
592
+ }
593
+ interface StorefrontOptionChoice {
594
+ readonly choiceId: string;
595
+ readonly choiceName: string;
596
+ readonly modifierFormatted: string;
597
+ readonly visibility?: string;
598
+ readonly hexCodes?: readonly string[];
599
+ }
600
+ interface StorefrontProductOption {
601
+ readonly type: string;
602
+ readonly optionId: string;
603
+ readonly optionText: string;
604
+ readonly required: boolean;
605
+ readonly placeholder?: string;
606
+ readonly maxLength?: number;
607
+ readonly useImageAsSwatchSelector?: boolean;
608
+ readonly selected?: string | readonly string[];
609
+ readonly choices: readonly StorefrontOptionChoice[];
610
+ }
611
+ interface StorefrontAppliedTax {
612
+ readonly name: string;
613
+ readonly percent: number;
614
+ readonly price: number;
615
+ }
616
+ interface StorefrontWholesalePrice {
617
+ readonly quantity: number;
618
+ readonly price: number;
619
+ readonly priceFormatted: string;
620
+ readonly discountPercent: number;
621
+ }
622
+ interface StorefrontPriceRange {
623
+ readonly minPrice: number;
624
+ readonly maxPrice: number;
625
+ readonly minPriceFormatted: string;
626
+ readonly maxPriceFormatted: string;
627
+ readonly minCompareToPrice: number;
628
+ readonly maxCompareToPrice: number;
629
+ }
630
+ interface StorefrontProductPrice {
631
+ readonly price: number;
632
+ readonly priceFormatted: string;
633
+ readonly compareToPrice?: number;
634
+ readonly compareToPriceFormatted?: string;
635
+ readonly range?: StorefrontPriceRange;
636
+ readonly lowestPrice?: {
637
+ readonly labelForProductList: string;
638
+ readonly labelForProductDetails: string;
639
+ };
640
+ readonly appliedTaxes: readonly StorefrontAppliedTax[];
641
+ readonly wholesalePrices: readonly StorefrontWholesalePrice[];
642
+ }
643
+ interface StorefrontProductInventory {
644
+ readonly isSoldOut: boolean;
645
+ readonly isPreorderAllowed: boolean;
646
+ readonly isShippingRequired: boolean;
647
+ readonly quantity?: number;
648
+ readonly warningLimit?: number;
649
+ readonly minPurchaseQuantity?: number;
650
+ readonly maxPurchaseQuantity?: number;
651
+ readonly weight?: {
652
+ readonly value: number;
653
+ readonly formattedValue: string;
654
+ };
655
+ readonly dimensions?: {
656
+ readonly length: number;
657
+ readonly width: number;
658
+ readonly height: number;
659
+ };
660
+ }
661
+ type StorefrontPurchaseKind = 'NORMAL' | 'CUSTOM_PRICE' | 'SUBSCRIPTION' | 'UNSUPPORTED';
662
+ interface StorefrontProductConfiguration {
663
+ readonly variationId?: number;
664
+ readonly sku?: string;
665
+ readonly selectedOptions: StorefrontSelectedOptions;
666
+ readonly options: readonly StorefrontProductOption[];
667
+ readonly media: readonly StorefrontProductMedia[];
668
+ readonly price: StorefrontProductPrice;
669
+ readonly inventory: StorefrontProductInventory;
670
+ readonly attributes: readonly StorefrontProductAttribute[];
671
+ readonly purchaseKind: StorefrontPurchaseKind;
672
+ readonly isSelectionComplete: boolean;
673
+ readonly isPurchasable: boolean;
674
+ }
675
+ interface StorefrontProduct {
676
+ readonly id: number;
677
+ readonly variationId?: number;
678
+ readonly name: string;
679
+ readonly subtitle: string;
680
+ readonly description: string;
681
+ readonly sku?: string;
682
+ readonly urls: {
683
+ readonly directPageUrl: string;
684
+ readonly proxyLinkUrl: string;
685
+ };
686
+ readonly categoryPaths: readonly {
687
+ readonly isDefault: boolean;
688
+ readonly items: readonly StorefrontCategorySummary[];
689
+ }[];
690
+ readonly attributes: readonly StorefrontProductAttribute[];
691
+ readonly options: readonly StorefrontProductOption[];
692
+ readonly media: readonly StorefrontProductMedia[];
693
+ readonly gridMedia: readonly StorefrontProductMedia[];
694
+ readonly price: StorefrontProductPrice;
695
+ readonly inventory: StorefrontProductInventory;
696
+ readonly rating: number;
697
+ readonly reviewsPublishedCount: number;
698
+ readonly ribbon?: {
699
+ readonly text: string;
700
+ readonly color: string;
701
+ };
702
+ readonly flags: {
703
+ readonly canAddToBagSilently: boolean;
704
+ readonly hasRelatedProducts: boolean;
705
+ readonly hasSizeChart: boolean;
706
+ readonly isGiftCard: boolean;
707
+ };
708
+ readonly defaultConfiguration: StorefrontProductConfiguration;
709
+ }
710
+ interface StorefrontExpandedCategory {
711
+ readonly category: StorefrontCategoryDetails;
712
+ readonly subcategories: readonly StorefrontCategorySummary[];
713
+ readonly products: readonly StorefrontProduct[];
714
+ readonly totalProductsCount: number;
715
+ readonly hasMoreProducts: boolean;
716
+ }
717
+ interface StorefrontCatalogPage {
718
+ readonly expandedCategories: readonly StorefrontExpandedCategory[];
719
+ readonly collapsedCategories: readonly StorefrontCategorySummary[];
720
+ }
721
+ interface StorefrontFilterValue {
722
+ readonly filterId: string | number;
723
+ readonly filterName?: string;
724
+ readonly productCount: number;
725
+ }
726
+ interface StorefrontCatalogValuesFilter {
727
+ readonly type: 'INVENTORY' | 'ON_SALE' | 'CATEGORIES' | 'LOCATIONS';
728
+ readonly values: readonly StorefrontFilterValue[];
729
+ readonly totalCount?: number;
730
+ }
731
+ interface StorefrontCatalogPriceFilter {
732
+ readonly type: 'PRICE';
733
+ readonly values?: {
734
+ readonly min: number;
735
+ readonly max: number;
736
+ };
737
+ }
738
+ interface StorefrontCatalogOptionFilter {
739
+ readonly type: 'OPTION' | 'SWATCH';
740
+ readonly optionId: string;
741
+ readonly optionName: string;
742
+ readonly displayComponent?: string;
743
+ readonly values: readonly (StorefrontFilterValue & {
744
+ readonly hexCodes?: readonly string[];
745
+ })[];
746
+ }
747
+ interface StorefrontCatalogAttributeFilter {
748
+ readonly type: 'ATTRIBUTE';
749
+ readonly attributeId: string;
750
+ readonly attributeName: string;
751
+ readonly values: readonly StorefrontFilterValue[];
752
+ }
753
+ interface StorefrontCatalogMarkerFilter {
754
+ readonly type: 'SEARCH' | 'SKU';
755
+ }
756
+ type StorefrontCatalogFilter = StorefrontCatalogValuesFilter | StorefrontCatalogPriceFilter | StorefrontCatalogOptionFilter | StorefrontCatalogAttributeFilter | StorefrontCatalogMarkerFilter;
757
+ interface StorefrontCatalogFilters {
758
+ readonly filters: readonly StorefrontCatalogFilter[];
759
+ readonly productCount?: number;
760
+ }
761
+ interface StorefrontCategoryMenuItem {
762
+ readonly id: number;
763
+ readonly name: string;
764
+ readonly slugs?: {
765
+ readonly forRouteWithId: string;
766
+ readonly forRouteWithoutId?: string;
767
+ };
768
+ readonly productCount?: number;
769
+ readonly hasChildren?: boolean;
770
+ readonly uncategorized?: boolean;
771
+ }
772
+ interface StorefrontCategoryMenu {
773
+ readonly currentPath: readonly StorefrontCategoryMenuItem[];
774
+ readonly totalCount: number;
775
+ readonly limit: number;
776
+ readonly offset: number;
777
+ readonly page: number;
778
+ readonly categories: readonly StorefrontCategoryMenuItem[];
779
+ readonly productCount: number;
780
+ }
781
+ interface StorefrontFavoritesState {
782
+ readonly productIds: readonly number[];
783
+ readonly count: number;
784
+ readonly customerState: 'GUEST' | 'AUTHENTICATED';
785
+ }
786
+
787
+ export { LegalPageTypeValues as L, StorefrontRuntimeBridgeVersion as ag, StorefrontRuntimeCapabilityValues as ai, VisitorLocationSourceValues as an, CustomerCookieConsentValues as s, JsApiPageValues as x };
788
+ export type { StorefrontListingRequest as $, AddProductData as A, BaseJsApiPage as B, CartAddProductCallback as C, StorefrontCatalogFilter as D, EcwidApiPromise as E, StorefrontCatalogFilters as F, StorefrontCatalogFiltersRequest as G, StorefrontCatalogMarkerFilter as H, StorefrontCatalogOptionFilter as I, JsApiFilterParams as J, StorefrontCatalogPage as K, StorefrontCatalogPageRequest as M, StorefrontCatalogPriceFilter as N, Order as O, StorefrontCatalogProductSortOrder as P, StorefrontCatalogValuesFilter as Q, RecurringChargeSettings as R, ShippingAddress as S, StorefrontCategoryDetails as T, StorefrontCategoryMenu as U, StorefrontCategoryMenuItem as V, StorefrontCategoryMenuRequest as W, StorefrontCategorySummary as X, StorefrontExpandedCategory as Y, StorefrontFavoritesState as Z, StorefrontFilterValue as _, AddProductParameter as a, StorefrontOptionChoice as a0, StorefrontPagination as a1, StorefrontPicture as a2, StorefrontPriceRange as a3, StorefrontProduct as a4, StorefrontProductAttribute as a5, StorefrontProductConfiguration as a6, StorefrontProductConfigurationRequest as a7, StorefrontProductFilters as a8, StorefrontProductInventory as a9, StorefrontProductMedia as aa, StorefrontProductOption as ab, StorefrontProductPrice as ac, StorefrontProductRequest as ad, StorefrontPurchaseKind as ae, StorefrontRelatedProductsRequest as af, StorefrontRuntimeCapability as ah, StorefrontSelectedOptions as aj, StorefrontWholesalePrice as ak, TrackingConsent as al, VisitorLocation as am, CustomerCookieConsentType as ao, AddProductRecurringChargeSettings as b, BillingPerson as c, CartApi as d, CartCalculateTotalCallback as e, CartClearCallback as f, CartData as g, CartDominatingColor as h, CartGetCallback as i, CartGoToCheckoutCallback as j, CartImageBorderInfo as k, CartItem as l, CartMediaItem as m, CartProduct as n, CartRemoveProductCallback as o, CartRemoveProductsCallback as p, CartVideoInfo as q, CustomerApi as r, CustomerData as t, CustomerGetCallback as u, CustomerSignOutCallback as v, JsApiPage as w, StorefrontAppliedTax as y, StorefrontCatalogAttributeFilter as z };