@ikas/bp-storefront 0.16.0 → 0.17.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.
@@ -11,7 +11,7 @@ import { CustomerReviewForm, IkasBundleProduct, IkasDisplayedProductGroup, IkasD
11
11
  * @example
12
12
  * ```typescript
13
13
  * import { initProductOnBrowser } from "@ikas/bp-storefront";
14
- * import { IkasProduct } from "@ikas/bp-storefront-models";
14
+ * import { IkasProduct } from "@ikas/bp-storefront";
15
15
  *
16
16
  * function initProduct(product: IkasProduct) {
17
17
  * initProductOnBrowser(product);
@@ -33,7 +33,7 @@ export declare function initProductOnBrowser(product: IkasProduct): void;
33
33
  * @example
34
34
  * ```typescript
35
35
  * import { hasProductVariant } from "@ikas/bp-storefront";
36
- * import { IkasProduct } from "@ikas/bp-storefront-models";
36
+ * import { IkasProduct } from "@ikas/bp-storefront";
37
37
  *
38
38
  * function ProductCard({ product }: { product: IkasProduct }) {
39
39
  * const hasVariants = hasProductVariant(product);
@@ -59,7 +59,7 @@ export declare function hasProductVariant(product: IkasProduct, showVariantsInGr
59
59
  * @example
60
60
  * ```typescript
61
61
  * import { hasProductStock } from "@ikas/bp-storefront";
62
- * import { IkasProduct } from "@ikas/bp-storefront-models";
62
+ * import { IkasProduct } from "@ikas/bp-storefront";
63
63
  *
64
64
  * function ProductCard({ product }: { product: IkasProduct }) {
65
65
  * const inStock = hasProductStock(product);
@@ -86,7 +86,7 @@ export declare function hasProductStock(product: IkasProduct): boolean;
86
86
  * @example
87
87
  * ```typescript
88
88
  * import { hasProductValidOptionValues, addItemToCart, getSelectedProductVariant } from "@ikas/bp-storefront";
89
- * import { IkasProduct } from "@ikas/bp-storefront-models";
89
+ * import { IkasProduct } from "@ikas/bp-storefront";
90
90
  *
91
91
  * async function handleAddToCart(product: IkasProduct) {
92
92
  * if (!hasProductValidOptionValues(product)) {
@@ -117,7 +117,7 @@ export declare function hasProductValidOptionValues(product: IkasProduct): boole
117
117
  * hasProductVariantStock,
118
118
  * getProductVariantFormattedFinalPrice
119
119
  * } from "@ikas/bp-storefront";
120
- * import { IkasProduct } from "@ikas/bp-storefront-models";
120
+ * import { IkasProduct } from "@ikas/bp-storefront";
121
121
  *
122
122
  * function ProductDetail({ product }: { product: IkasProduct }) {
123
123
  * const selectedVariant = getSelectedProductVariant(product);
@@ -145,7 +145,7 @@ export declare function getSelectedProductVariant(product: IkasProduct): IkasPro
145
145
  * @example
146
146
  * ```typescript
147
147
  * import { getMainProductVariantValue } from "@ikas/bp-storefront";
148
- * import { IkasProduct } from "@ikas/bp-storefront-models";
148
+ * import { IkasProduct } from "@ikas/bp-storefront";
149
149
  *
150
150
  * function ProductCard({ product }: { product: IkasProduct }) {
151
151
  * const mainValue = getMainProductVariantValue(product);
@@ -167,7 +167,7 @@ export declare function getMainProductVariantValue(product: IkasProduct): IkasVa
167
167
  * @example
168
168
  * ```typescript
169
169
  * import { getMainProductVariantType } from "@ikas/bp-storefront";
170
- * import { IkasProduct } from "@ikas/bp-storefront-models";
170
+ * import { IkasProduct } from "@ikas/bp-storefront";
171
171
  *
172
172
  * function ProductCard({ product }: { product: IkasProduct }) {
173
173
  * const mainType = getMainProductVariantType(product);
@@ -192,7 +192,7 @@ export declare function getMainProductVariantType(product: IkasProduct): import(
192
192
  * @example
193
193
  * ```typescript
194
194
  * import { getSelectedProductVariantHref } from "@ikas/bp-storefront";
195
- * import { IkasProduct } from "@ikas/bp-storefront-models";
195
+ * import { IkasProduct } from "@ikas/bp-storefront";
196
196
  *
197
197
  * function ProductLink({ product }: { product: IkasProduct }) {
198
198
  * const href = getSelectedProductVariantHref(product);
@@ -213,7 +213,7 @@ export declare function getSelectedProductVariantHref(product: IkasProduct): str
213
213
  * @example
214
214
  * ```typescript
215
215
  * import { getProductHref } from "@ikas/bp-storefront";
216
- * import { IkasProduct } from "@ikas/bp-storefront-models";
216
+ * import { IkasProduct } from "@ikas/bp-storefront";
217
217
  *
218
218
  * function ProductCard({ product }: { product: IkasProduct }) {
219
219
  * return (
@@ -239,7 +239,7 @@ export declare function getProductHref(product: IkasProduct): string;
239
239
  * @example
240
240
  * ```typescript
241
241
  * import { getDisplayedProductVariantTypes, selectVariantValue } from "@ikas/bp-storefront";
242
- * import { IkasProduct } from "@ikas/bp-storefront-models";
242
+ * import { IkasProduct } from "@ikas/bp-storefront";
243
243
  *
244
244
  * function VariantSelector({ product }: { product: IkasProduct }) {
245
245
  * const variantTypes = getDisplayedProductVariantTypes(product);
@@ -283,7 +283,7 @@ export declare function getDisplayedProductVariantTypes(product: IkasProduct): I
283
283
  * @example
284
284
  * ```typescript
285
285
  * import { isAddToCartEnabled } from "@ikas/bp-storefront";
286
- * import { IkasProduct } from "@ikas/bp-storefront-models";
286
+ * import { IkasProduct } from "@ikas/bp-storefront";
287
287
  *
288
288
  * function AddToCartButton({ product }: { product: IkasProduct }) {
289
289
  * const enabled = isAddToCartEnabled(product);
@@ -308,7 +308,7 @@ export declare function isAddToCartEnabled(product: IkasProduct): boolean;
308
308
  * @example
309
309
  * ```typescript
310
310
  * import { isCustomerReviewEnabled } from "@ikas/bp-storefront";
311
- * import { IkasProduct } from "@ikas/bp-storefront-models";
311
+ * import { IkasProduct } from "@ikas/bp-storefront";
312
312
  *
313
313
  * function ProductReviews({ product }: { product: IkasProduct }) {
314
314
  * if (!isCustomerReviewEnabled(product)) return null;
@@ -329,7 +329,7 @@ export declare function isCustomerReviewEnabled(product: IkasProduct): boolean;
329
329
  * @example
330
330
  * ```typescript
331
331
  * import { isCustomerReviewLoginRequired, isCustomerReviewEnabled, customerStore } from "@ikas/bp-storefront";
332
- * import { IkasProduct } from "@ikas/bp-storefront-models";
332
+ * import { IkasProduct } from "@ikas/bp-storefront";
333
333
  *
334
334
  * function ReviewForm({ product }: { product: IkasProduct }) {
335
335
  * if (!isCustomerReviewEnabled(product)) return null;
@@ -354,7 +354,7 @@ export declare function isCustomerReviewLoginRequired(product: IkasProduct): boo
354
354
  * @example
355
355
  * ```typescript
356
356
  * import { getGroupedAttributeValues } from "@ikas/bp-storefront";
357
- * import { IkasProduct } from "@ikas/bp-storefront-models";
357
+ * import { IkasProduct } from "@ikas/bp-storefront";
358
358
  *
359
359
  * function ProductAttributes({ product }: { product: IkasProduct }) {
360
360
  * const attributes = getGroupedAttributeValues(product);
@@ -384,7 +384,7 @@ export declare function getGroupedAttributeValues(product: IkasProduct): IkasPro
384
384
  * @example
385
385
  * ```typescript
386
386
  * import { getDisplayedProductGroups } from "@ikas/bp-storefront";
387
- * import { IkasProduct } from "@ikas/bp-storefront-models";
387
+ * import { IkasProduct } from "@ikas/bp-storefront";
388
388
  *
389
389
  * function ProductGroupSelector({ product }: { product: IkasProduct }) {
390
390
  * const groups = getDisplayedProductGroups(product);
@@ -424,7 +424,7 @@ export declare function getDisplayedProductGroups(product: IkasProduct): IkasDis
424
424
  * @example
425
425
  * ```typescript
426
426
  * import { selectVariantValue, getDisplayedProductVariantTypes } from "@ikas/bp-storefront";
427
- * import { IkasProduct, IkasVariantValue } from "@ikas/bp-storefront-models";
427
+ * import { IkasProduct, IkasVariantValue } from "@ikas/bp-storefront";
428
428
  *
429
429
  * function SizeSelector({ product }: { product: IkasProduct }) {
430
430
  * const variantTypes = getDisplayedProductVariantTypes(product);
@@ -464,7 +464,7 @@ export declare function selectVariantValue(product: IkasProduct, variantValue: I
464
464
  * @example
465
465
  * ```typescript
466
466
  * import { getProductCampaigns } from "@ikas/bp-storefront";
467
- * import { IkasProduct } from "@ikas/bp-storefront-models";
467
+ * import { IkasProduct } from "@ikas/bp-storefront";
468
468
  *
469
469
  * async function loadCampaigns(product: IkasProduct) {
470
470
  * const campaigns = await getProductCampaigns(product);
@@ -488,7 +488,7 @@ export declare function getProductCampaigns(product: IkasProduct): Promise<impor
488
488
  * @example
489
489
  * ```typescript
490
490
  * import { getProductAvailableStockLocations } from "@ikas/bp-storefront";
491
- * import { IkasProduct } from "@ikas/bp-storefront-models";
491
+ * import { IkasProduct } from "@ikas/bp-storefront";
492
492
  *
493
493
  * async function showPickupLocations(product: IkasProduct) {
494
494
  * const locations = await getProductAvailableStockLocations(product);
@@ -512,7 +512,7 @@ export declare function getProductAvailableStockLocations(product: IkasProduct):
512
512
  * @example
513
513
  * ```typescript
514
514
  * import { getProductOptionSet } from "@ikas/bp-storefront";
515
- * import { IkasProduct } from "@ikas/bp-storefront-models";
515
+ * import { IkasProduct } from "@ikas/bp-storefront";
516
516
  *
517
517
  * async function loadProductOptions(product: IkasProduct) {
518
518
  * const hasOptions = await getProductOptionSet(product);
@@ -536,7 +536,7 @@ export declare function getProductOptionSet(product: IkasProduct): Promise<boole
536
536
  * @example
537
537
  * ```typescript
538
538
  * import { initBundleProducts } from "@ikas/bp-storefront";
539
- * import { IkasProduct } from "@ikas/bp-storefront-models";
539
+ * import { IkasProduct } from "@ikas/bp-storefront";
540
540
  *
541
541
  * async function loadProduct(product: IkasProduct) {
542
542
  * await initBundleProducts(product);
@@ -558,7 +558,7 @@ export declare function initBundleProducts(product: IkasProduct): Promise<void>;
558
558
  * @example
559
559
  * ```typescript
560
560
  * import { getBundleProductsOfVariant, getSelectedProductVariant } from "@ikas/bp-storefront";
561
- * import { IkasProduct } from "@ikas/bp-storefront-models";
561
+ * import { IkasProduct } from "@ikas/bp-storefront";
562
562
  *
563
563
  * async function refreshBundleProducts(product: IkasProduct) {
564
564
  * const variant = getSelectedProductVariant(product);
@@ -580,7 +580,7 @@ export declare function getBundleProductsOfVariant(product: IkasProduct, variant
580
580
  * @example
581
581
  * ```typescript
582
582
  * import { isBundleProductQuantityEditable, setBundleProductQuantity } from "@ikas/bp-storefront";
583
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
583
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
584
584
  *
585
585
  * function BundleItem({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
586
586
  * const editable = isBundleProductQuantityEditable(bundleProduct);
@@ -610,7 +610,7 @@ export declare function isBundleProductQuantityEditable(bundleProduct: IkasBundl
610
610
  * @example
611
611
  * ```typescript
612
612
  * import { shouldDisplayBundleProductPrice, getBundleProductFormattedFinalPrice } from "@ikas/bp-storefront";
613
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
613
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
614
614
  *
615
615
  * function BundleItem({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
616
616
  * return (
@@ -638,7 +638,7 @@ export declare function shouldDisplayBundleProductPrice(bundleProduct: IkasBundl
638
638
  * @example
639
639
  * ```typescript
640
640
  * import { getBundleProductFinalPrice } from "@ikas/bp-storefront";
641
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
641
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
642
642
  *
643
643
  * function BundlePrice({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
644
644
  * const price = getBundleProductFinalPrice(bundleProduct);
@@ -659,7 +659,7 @@ export declare function getBundleProductFinalPrice(bundleProduct: IkasBundleProd
659
659
  * @example
660
660
  * ```typescript
661
661
  * import { getBundleProductFormattedFinalPrice, shouldDisplayBundleProductPrice } from "@ikas/bp-storefront";
662
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
662
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
663
663
  *
664
664
  * function BundleItemPrice({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
665
665
  * if (!shouldDisplayBundleProductPrice(bundleProduct)) return null;
@@ -680,7 +680,7 @@ export declare function getBundleProductFormattedFinalPrice(bundleProduct: IkasB
680
680
  * @example
681
681
  * ```typescript
682
682
  * import { getBundleProductFinalPriceWithQuantity } from "@ikas/bp-storefront";
683
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
683
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
684
684
  *
685
685
  * function BundleTotal({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
686
686
  * const total = getBundleProductFinalPriceWithQuantity(bundleProduct);
@@ -701,7 +701,7 @@ export declare function getBundleProductFinalPriceWithQuantity(bundleProduct: Ik
701
701
  * @example
702
702
  * ```typescript
703
703
  * import { getBundleProductFormattedFinalPriceWithQuantity } from "@ikas/bp-storefront";
704
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
704
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
705
705
  *
706
706
  * function BundleItemTotal({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
707
707
  * return <span>{getBundleProductFormattedFinalPriceWithQuantity(bundleProduct)}</span>;
@@ -721,7 +721,7 @@ export declare function getBundleProductFormattedFinalPriceWithQuantity(bundlePr
721
721
  * @example
722
722
  * ```typescript
723
723
  * import { getBundleProductSellPrice, getBundleProductFinalPrice } from "@ikas/bp-storefront";
724
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
724
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
725
725
  *
726
726
  * function BundleDiscount({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
727
727
  * const sell = getBundleProductSellPrice(bundleProduct);
@@ -744,7 +744,7 @@ export declare function getBundleProductSellPrice(bundleProduct: IkasBundleProdu
744
744
  * @example
745
745
  * ```typescript
746
746
  * import { getBundleProductFormattedSellPrice } from "@ikas/bp-storefront";
747
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
747
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
748
748
  *
749
749
  * function BundleOriginalPrice({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
750
750
  * return <span className="original-price">{getBundleProductFormattedSellPrice(bundleProduct)}</span>;
@@ -764,7 +764,7 @@ export declare function getBundleProductFormattedSellPrice(bundleProduct: IkasBu
764
764
  * @example
765
765
  * ```typescript
766
766
  * import { getBundleProductSellPriceWithQuantity } from "@ikas/bp-storefront";
767
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
767
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
768
768
  *
769
769
  * function BundleOriginalTotal({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
770
770
  * const total = getBundleProductSellPriceWithQuantity(bundleProduct);
@@ -785,7 +785,7 @@ export declare function getBundleProductSellPriceWithQuantity(bundleProduct: Ika
785
785
  * @example
786
786
  * ```typescript
787
787
  * import { getBundleProductFormattedSellPriceWithQuantity } from "@ikas/bp-storefront";
788
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
788
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
789
789
  *
790
790
  * function BundleOriginalTotal({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
791
791
  * return (
@@ -810,7 +810,7 @@ export declare function getBundleProductFormattedSellPriceWithQuantity(bundlePro
810
810
  * @example
811
811
  * ```typescript
812
812
  * import { setProductOfBundleProduct } from "@ikas/bp-storefront";
813
- * import { IkasBundleProduct, IkasProduct } from "@ikas/bp-storefront-models";
813
+ * import { IkasBundleProduct, IkasProduct } from "@ikas/bp-storefront";
814
814
  *
815
815
  * function attachProduct(bundleProduct: IkasBundleProduct, product: IkasProduct) {
816
816
  * setProductOfBundleProduct(bundleProduct, product);
@@ -832,7 +832,7 @@ export declare function setProductOfBundleProduct(bundleProduct: IkasBundleProdu
832
832
  * @example
833
833
  * ```typescript
834
834
  * import { setBundleProductQuantity, isBundleProductQuantityEditable } from "@ikas/bp-storefront";
835
- * import { IkasBundleProduct } from "@ikas/bp-storefront-models";
835
+ * import { IkasBundleProduct } from "@ikas/bp-storefront";
836
836
  *
837
837
  * function QuantityControl({ bundleProduct }: { bundleProduct: IkasBundleProduct }) {
838
838
  * if (!isBundleProductQuantityEditable(bundleProduct)) return null;
@@ -860,7 +860,7 @@ export declare function setBundleProductQuantity(bundleProduct: IkasBundleProduc
860
860
  * @example
861
861
  * ```typescript
862
862
  * import { setOptionRealPrices } from "@ikas/bp-storefront";
863
- * import { IkasProduct } from "@ikas/bp-storefront-models";
863
+ * import { IkasProduct } from "@ikas/bp-storefront";
864
864
  *
865
865
  * function recalculateOptions(product: IkasProduct) {
866
866
  * setOptionRealPrices(product);
@@ -882,7 +882,7 @@ export declare function setOptionRealPrices(product: IkasProduct): void;
882
882
  * @example
883
883
  * ```typescript
884
884
  * import { getProductCategoryPath } from "@ikas/bp-storefront";
885
- * import { IkasProduct } from "@ikas/bp-storefront-models";
885
+ * import { IkasProduct } from "@ikas/bp-storefront";
886
886
  *
887
887
  * function Breadcrumb({ product }: { product: IkasProduct }) {
888
888
  * const path = getProductCategoryPath(product);
@@ -913,7 +913,7 @@ export declare function getProductCategoryPath(product: IkasProduct): import("..
913
913
  * @example
914
914
  * ```typescript
915
915
  * import { getProductFirstCategory } from "@ikas/bp-storefront";
916
- * import { IkasProduct } from "@ikas/bp-storefront-models";
916
+ * import { IkasProduct } from "@ikas/bp-storefront";
917
917
  *
918
918
  * function ProductCategory({ product }: { product: IkasProduct }) {
919
919
  * const category = getProductFirstCategory(product);
@@ -935,7 +935,7 @@ export declare function getProductFirstCategory(product: IkasProduct): import(".
935
935
  * @example
936
936
  * ```typescript
937
937
  * import { getIkasProductCustomerReviewForm, isCustomerReviewEnabled } from "@ikas/bp-storefront";
938
- * import { IkasProduct } from "@ikas/bp-storefront-models";
938
+ * import { IkasProduct } from "@ikas/bp-storefront";
939
939
  *
940
940
  * function ReviewForm({ product }: { product: IkasProduct }) {
941
941
  * if (!isCustomerReviewEnabled(product)) return null;
@@ -961,7 +961,7 @@ export declare function getIkasProductCustomerReviewForm(product: IkasProduct):
961
961
  * @example
962
962
  * ```typescript
963
963
  * import { clearIkasProductCustomerReviewForm } from "@ikas/bp-storefront";
964
- * import { IkasProduct } from "@ikas/bp-storefront-models";
964
+ * import { IkasProduct } from "@ikas/bp-storefront";
965
965
  *
966
966
  * function handleReviewSubmitted(product: IkasProduct) {
967
967
  * clearIkasProductCustomerReviewForm(product);
@@ -982,7 +982,7 @@ export declare function clearIkasProductCustomerReviewForm(product: IkasProduct)
982
982
  * @example
983
983
  * ```typescript
984
984
  * import { isFavoriteIkasProduct, addIkasProductToFavorites, removeIkasProductFromFavorites } from "@ikas/bp-storefront";
985
- * import { IkasProduct } from "@ikas/bp-storefront-models";
985
+ * import { IkasProduct } from "@ikas/bp-storefront";
986
986
  *
987
987
  * function FavoriteButton({ product }: { product: IkasProduct }) {
988
988
  * const isFavorite = isFavoriteIkasProduct(product);
@@ -1017,7 +1017,7 @@ export declare function isFavoriteIkasProduct(product: IkasProduct): boolean;
1017
1017
  * @example
1018
1018
  * ```typescript
1019
1019
  * import { addIkasProductToFavorites, customerStore } from "@ikas/bp-storefront";
1020
- * import { IkasProduct } from "@ikas/bp-storefront-models";
1020
+ * import { IkasProduct } from "@ikas/bp-storefront";
1021
1021
  *
1022
1022
  * async function handleAddToFavorites(product: IkasProduct) {
1023
1023
  * if (!customerStore.customer) {
@@ -1044,7 +1044,7 @@ export declare function addIkasProductToFavorites(product: IkasProduct): Promise
1044
1044
  * @example
1045
1045
  * ```typescript
1046
1046
  * import { removeIkasProductFromFavorites } from "@ikas/bp-storefront";
1047
- * import { IkasProduct } from "@ikas/bp-storefront-models";
1047
+ * import { IkasProduct } from "@ikas/bp-storefront";
1048
1048
  *
1049
1049
  * async function handleRemoveFromFavorites(product: IkasProduct) {
1050
1050
  * await removeIkasProductFromFavorites(product);
@@ -11,7 +11,7 @@ import { BackInStockNotificationForm, IkasAppliedCampaignAmount, IkasProductAttr
11
11
  * @example
12
12
  * ```typescript
13
13
  * import { getProductVariantMainImage, getSelectedProductVariant } from "@ikas/bp-storefront";
14
- * import { IkasProduct } from "@ikas/bp-storefront-models";
14
+ * import { IkasProduct } from "@ikas/bp-storefront";
15
15
  *
16
16
  * function ProductImage({ product }: { product: IkasProduct }) {
17
17
  * const variant = getSelectedProductVariant(product);
@@ -38,7 +38,7 @@ export declare function getProductVariantMainImage(variant: IkasProductVariant):
38
38
  * @example
39
39
  * ```typescript
40
40
  * import { hasProductVariantStock, getSelectedProductVariant } from "@ikas/bp-storefront";
41
- * import { IkasProduct } from "@ikas/bp-storefront-models";
41
+ * import { IkasProduct } from "@ikas/bp-storefront";
42
42
  *
43
43
  * function AddToCartButton({ product }: { product: IkasProduct }) {
44
44
  * const variant = getSelectedProductVariant(product);
@@ -65,7 +65,7 @@ export declare function hasProductVariantStock(variant: IkasProductVariant): boo
65
65
  * @example
66
66
  * ```typescript
67
67
  * import { getGroupedAttributeValuesForVariant, getSelectedProductVariant } from "@ikas/bp-storefront";
68
- * import { IkasProduct } from "@ikas/bp-storefront-models";
68
+ * import { IkasProduct } from "@ikas/bp-storefront";
69
69
  *
70
70
  * function VariantAttributes({ product }: { product: IkasProduct }) {
71
71
  * const variant = getSelectedProductVariant(product);
@@ -94,7 +94,7 @@ export declare function getGroupedAttributeValuesForVariant(variant: IkasProduct
94
94
  * @example
95
95
  * ```typescript
96
96
  * import { getProductVariantB2bPriceRule, getSelectedProductVariant } from "@ikas/bp-storefront";
97
- * import { IkasProduct } from "@ikas/bp-storefront-models";
97
+ * import { IkasProduct } from "@ikas/bp-storefront";
98
98
  *
99
99
  * function B2BPriceInfo({ product }: { product: IkasProduct }) {
100
100
  * const variant = getSelectedProductVariant(product);
@@ -120,7 +120,7 @@ export declare function getProductVariantB2bPriceRule(variant: IkasProductVarian
120
120
  * @example
121
121
  * ```typescript
122
122
  * import { getProductVariantPrice, getSelectedProductVariant } from "@ikas/bp-storefront";
123
- * import { IkasProduct } from "@ikas/bp-storefront-models";
123
+ * import { IkasProduct } from "@ikas/bp-storefront";
124
124
  *
125
125
  * function PriceCurrency({ product }: { product: IkasProduct }) {
126
126
  * const variant = getSelectedProductVariant(product);
@@ -143,7 +143,7 @@ export declare function getProductVariantPrice(variant: IkasProductVariant): Ika
143
143
  * @example
144
144
  * ```typescript
145
145
  * import { hasBundleSettings, getSelectedProductVariant } from "@ikas/bp-storefront";
146
- * import { IkasProduct } from "@ikas/bp-storefront-models";
146
+ * import { IkasProduct } from "@ikas/bp-storefront";
147
147
  *
148
148
  * function BundleIndicator({ product }: { product: IkasProduct }) {
149
149
  * const variant = getSelectedProductVariant(product);
@@ -168,7 +168,7 @@ export declare function hasBundleSettings(variant: IkasProductVariant): boolean;
168
168
  * @example
169
169
  * ```typescript
170
170
  * import { getProductVariantBundlePrice, hasBundleSettings, getSelectedProductVariant } from "@ikas/bp-storefront";
171
- * import { IkasProduct } from "@ikas/bp-storefront-models";
171
+ * import { IkasProduct } from "@ikas/bp-storefront";
172
172
  *
173
173
  * function BundlePrice({ product }: { product: IkasProduct }) {
174
174
  * const variant = getSelectedProductVariant(product);
@@ -195,7 +195,7 @@ export declare function getProductVariantBundlePrice(variant: IkasProductVariant
195
195
  * @example
196
196
  * ```typescript
197
197
  * import { getProductVariantFinalPrice, getSelectedProductVariant } from "@ikas/bp-storefront";
198
- * import { IkasProduct } from "@ikas/bp-storefront-models";
198
+ * import { IkasProduct } from "@ikas/bp-storefront";
199
199
  *
200
200
  * function calculateTotal(product: IkasProduct, quantity: number) {
201
201
  * const variant = getSelectedProductVariant(product);
@@ -218,7 +218,7 @@ export declare function getProductVariantFinalPrice(variant: IkasProductVariant)
218
218
  * @example
219
219
  * ```typescript
220
220
  * import { getProductVariantFormattedFinalPrice, getSelectedProductVariant } from "@ikas/bp-storefront";
221
- * import { IkasProduct } from "@ikas/bp-storefront-models";
221
+ * import { IkasProduct } from "@ikas/bp-storefront";
222
222
  *
223
223
  * function PriceDisplay({ product }: { product: IkasProduct }) {
224
224
  * const variant = getSelectedProductVariant(product);
@@ -279,7 +279,7 @@ export declare function getProductVariantSellPrice(variant: IkasProductVariant):
279
279
  * hasProductVariantDiscount,
280
280
  * getSelectedProductVariant
281
281
  * } from "@ikas/bp-storefront";
282
- * import { IkasProduct } from "@ikas/bp-storefront-models";
282
+ * import { IkasProduct } from "@ikas/bp-storefront";
283
283
  *
284
284
  * function PriceDisplay({ product }: { product: IkasProduct }) {
285
285
  * const variant = getSelectedProductVariant(product);
@@ -313,7 +313,7 @@ export declare function getProductVariantFormattedSellPrice(variant: IkasProduct
313
313
  * @example
314
314
  * ```typescript
315
315
  * import { getProductVariantFormattedBuyPrice, getSelectedProductVariant } from "@ikas/bp-storefront";
316
- * import { IkasProduct } from "@ikas/bp-storefront-models";
316
+ * import { IkasProduct } from "@ikas/bp-storefront";
317
317
  *
318
318
  * function BuyPriceDisplay({ product }: { product: IkasProduct }) {
319
319
  * const variant = getSelectedProductVariant(product);
@@ -336,7 +336,7 @@ export declare function getProductVariantFormattedBuyPrice(variant: IkasProductV
336
336
  * @example
337
337
  * ```typescript
338
338
  * import { getProductVariantAppliedCampaignAmount, getSelectedProductVariant } from "@ikas/bp-storefront";
339
- * import { IkasProduct } from "@ikas/bp-storefront-models";
339
+ * import { IkasProduct } from "@ikas/bp-storefront";
340
340
  *
341
341
  * function CampaignInfo({ product }: { product: IkasProduct }) {
342
342
  * const variant = getSelectedProductVariant(product);
@@ -367,7 +367,7 @@ export declare function getProductVariantAppliedCampaignAmount(variant: IkasProd
367
367
  * @example
368
368
  * ```typescript
369
369
  * import { getProductVariantCampaignPrice, getSelectedProductVariant } from "@ikas/bp-storefront";
370
- * import { IkasProduct } from "@ikas/bp-storefront-models";
370
+ * import { IkasProduct } from "@ikas/bp-storefront";
371
371
  *
372
372
  * function CampaignPriceCheck({ product }: { product: IkasProduct }) {
373
373
  * const variant = getSelectedProductVariant(product);
@@ -393,7 +393,7 @@ export declare function getProductVariantCampaignPrice(variant: IkasProductVaria
393
393
  * @example
394
394
  * ```typescript
395
395
  * import { getProductVariantFormattedCampaignPrice, getProductVariantCampaignPrice, getSelectedProductVariant } from "@ikas/bp-storefront";
396
- * import { IkasProduct } from "@ikas/bp-storefront-models";
396
+ * import { IkasProduct } from "@ikas/bp-storefront";
397
397
  *
398
398
  * function CampaignPriceDisplay({ product }: { product: IkasProduct }) {
399
399
  * const variant = getSelectedProductVariant(product);
@@ -419,7 +419,7 @@ export declare function getProductVariantFormattedCampaignPrice(variant: IkasPro
419
419
  * @example
420
420
  * ```typescript
421
421
  * import { getProductVariantDiscountPrice, getSelectedProductVariant } from "@ikas/bp-storefront";
422
- * import { IkasProduct } from "@ikas/bp-storefront-models";
422
+ * import { IkasProduct } from "@ikas/bp-storefront";
423
423
  *
424
424
  * function DiscountPriceDisplay({ product }: { product: IkasProduct }) {
425
425
  * const variant = getSelectedProductVariant(product);
@@ -445,7 +445,7 @@ export declare function getProductVariantDiscountPrice(variant: IkasProductVaria
445
445
  * @example
446
446
  * ```typescript
447
447
  * import { getProductVariantFormattedDiscountPrice, hasProductVariantDiscount, getSelectedProductVariant } from "@ikas/bp-storefront";
448
- * import { IkasProduct } from "@ikas/bp-storefront-models";
448
+ * import { IkasProduct } from "@ikas/bp-storefront";
449
449
  *
450
450
  * function FormattedDiscountPrice({ product }: { product: IkasProduct }) {
451
451
  * const variant = getSelectedProductVariant(product);
@@ -471,7 +471,7 @@ export declare function getProductVariantFormattedDiscountPrice(variant: IkasPro
471
471
  * @example
472
472
  * ```typescript
473
473
  * import { hasProductVariantDiscount, getProductVariantDiscountPercentage, getSelectedProductVariant } from "@ikas/bp-storefront";
474
- * import { IkasProduct } from "@ikas/bp-storefront-models";
474
+ * import { IkasProduct } from "@ikas/bp-storefront";
475
475
  *
476
476
  * function SaleBadge({ product }: { product: IkasProduct }) {
477
477
  * const variant = getSelectedProductVariant(product);
@@ -498,7 +498,7 @@ export declare function hasProductVariantDiscount(variant: IkasProductVariant):
498
498
  * @example
499
499
  * ```typescript
500
500
  * import { getProductVariantFormattedDiscountAmount, hasProductVariantDiscount, getSelectedProductVariant } from "@ikas/bp-storefront";
501
- * import { IkasProduct } from "@ikas/bp-storefront-models";
501
+ * import { IkasProduct } from "@ikas/bp-storefront";
502
502
  *
503
503
  * function SavingsDisplay({ product }: { product: IkasProduct }) {
504
504
  * const variant = getSelectedProductVariant(product);
@@ -523,7 +523,7 @@ export declare function getProductVariantFormattedDiscountAmount(variant: IkasPr
523
523
  * @example
524
524
  * ```typescript
525
525
  * import { getProductVariantDiscountAmount, getSelectedProductVariant } from "@ikas/bp-storefront";
526
- * import { IkasProduct } from "@ikas/bp-storefront-models";
526
+ * import { IkasProduct } from "@ikas/bp-storefront";
527
527
  *
528
528
  * function SavingsDisplay({ product }: { product: IkasProduct }) {
529
529
  * const variant = getSelectedProductVariant(product);
@@ -550,7 +550,7 @@ export declare function getProductVariantDiscountAmount(variant: IkasProductVari
550
550
  * @example
551
551
  * ```typescript
552
552
  * import { getProductVariantDiscountPercentage, hasProductVariantDiscount, getSelectedProductVariant } from "@ikas/bp-storefront";
553
- * import { IkasProduct } from "@ikas/bp-storefront-models";
553
+ * import { IkasProduct } from "@ikas/bp-storefront";
554
554
  *
555
555
  * function DiscountBadge({ product }: { product: IkasProduct }) {
556
556
  * const variant = getSelectedProductVariant(product);
@@ -580,7 +580,7 @@ export declare function getProductVariantDiscountPercentage(variant: IkasProduct
580
580
  * @example
581
581
  * ```typescript
582
582
  * import { getProductVariantFinalPriceWithCampaignOffers, getSelectedProductVariant } from "@ikas/bp-storefront";
583
- * import { IkasProduct } from "@ikas/bp-storefront-models";
583
+ * import { IkasProduct } from "@ikas/bp-storefront";
584
584
  *
585
585
  * function TotalWithOffers({ product }: { product: IkasProduct }) {
586
586
  * const variant = getSelectedProductVariant(product);
@@ -603,7 +603,7 @@ export declare function getProductVariantFinalPriceWithCampaignOffers(variant: I
603
603
  * @example
604
604
  * ```typescript
605
605
  * import { getProductVariantFormattedFinalPriceWithCampaignOffers, getSelectedProductVariant } from "@ikas/bp-storefront";
606
- * import { IkasProduct } from "@ikas/bp-storefront-models";
606
+ * import { IkasProduct } from "@ikas/bp-storefront";
607
607
  *
608
608
  * function FormattedTotalWithOffers({ product }: { product: IkasProduct }) {
609
609
  * const variant = getSelectedProductVariant(product);
@@ -629,7 +629,7 @@ export declare function getProductVariantFormattedFinalPriceWithCampaignOffers(v
629
629
  * @example
630
630
  * ```typescript
631
631
  * import { getProductVariantSellPriceWithCampaignOffers, getSelectedProductVariant } from "@ikas/bp-storefront";
632
- * import { IkasProduct } from "@ikas/bp-storefront-models";
632
+ * import { IkasProduct } from "@ikas/bp-storefront";
633
633
  *
634
634
  * function OriginalTotalWithOffers({ product }: { product: IkasProduct }) {
635
635
  * const variant = getSelectedProductVariant(product);
@@ -656,7 +656,7 @@ export declare function getProductVariantSellPriceWithCampaignOffers(variant: Ik
656
656
  * getProductVariantFormattedFinalPriceWithCampaignOffers,
657
657
  * getSelectedProductVariant
658
658
  * } from "@ikas/bp-storefront";
659
- * import { IkasProduct } from "@ikas/bp-storefront-models";
659
+ * import { IkasProduct } from "@ikas/bp-storefront";
660
660
  *
661
661
  * function PriceWithOffers({ product }: { product: IkasProduct }) {
662
662
  * const variant = getSelectedProductVariant(product);
@@ -685,7 +685,7 @@ export declare function getProductVariantFormattedSellPriceWithCampaignOffers(va
685
685
  * @example
686
686
  * ```typescript
687
687
  * import { getProductVariantCampaignOffersDiscountPercentage, getSelectedProductVariant } from "@ikas/bp-storefront";
688
- * import { IkasProduct } from "@ikas/bp-storefront-models";
688
+ * import { IkasProduct } from "@ikas/bp-storefront";
689
689
  *
690
690
  * function CampaignOffersDiscount({ product }: { product: IkasProduct }) {
691
691
  * const variant = getSelectedProductVariant(product);
@@ -711,7 +711,7 @@ export declare function getProductVariantCampaignOffersDiscountPercentage(varian
711
711
  * @example
712
712
  * ```typescript
713
713
  * import { getProductVariantIsBackInStockEnabled, hasProductVariantStock, getSelectedProductVariant } from "@ikas/bp-storefront";
714
- * import { IkasProduct } from "@ikas/bp-storefront-models";
714
+ * import { IkasProduct } from "@ikas/bp-storefront";
715
715
  *
716
716
  * function BackInStockSection({ product }: { product: IkasProduct }) {
717
717
  * const variant = getSelectedProductVariant(product);
@@ -740,7 +740,7 @@ export declare function getProductVariantIsBackInStockEnabled(variant: IkasProdu
740
740
  * getProductVariantIsBackInStockEnabled,
741
741
  * getSelectedProductVariant
742
742
  * } from "@ikas/bp-storefront";
743
- * import { IkasProduct } from "@ikas/bp-storefront-models";
743
+ * import { IkasProduct } from "@ikas/bp-storefront";
744
744
  *
745
745
  * function BackInStockForm({ product }: { product: IkasProduct }) {
746
746
  * const variant = getSelectedProductVariant(product);
@@ -768,7 +768,7 @@ export declare function getProductVariantIsBackInStockCustomerLoginRequired(vari
768
768
  * @example
769
769
  * ```typescript
770
770
  * import { saveProductVariantBackInStockReminder, getSelectedProductVariant } from "@ikas/bp-storefront";
771
- * import { IkasProduct } from "@ikas/bp-storefront-models";
771
+ * import { IkasProduct } from "@ikas/bp-storefront";
772
772
  *
773
773
  * async function handleBackInStockSubmit(product: IkasProduct, email: string) {
774
774
  * const variant = getSelectedProductVariant(product);
@@ -795,7 +795,7 @@ export declare function saveProductVariantBackInStockReminder(variant: IkasProdu
795
795
  * @example
796
796
  * ```typescript
797
797
  * import { getProductVariantUnitPriceText, getSelectedProductVariant } from "@ikas/bp-storefront";
798
- * import { IkasProduct } from "@ikas/bp-storefront-models";
798
+ * import { IkasProduct } from "@ikas/bp-storefront";
799
799
  *
800
800
  * function UnitPriceDisplay({ product }: { product: IkasProduct }) {
801
801
  * const variant = getSelectedProductVariant(product);
@@ -821,7 +821,7 @@ export declare function getProductVariantUnitPriceText(variant: IkasProductVaria
821
821
  * @example
822
822
  * ```typescript
823
823
  * import { getProductVariantBackInStockForm, getSelectedProductVariant } from "@ikas/bp-storefront";
824
- * import { IkasProduct } from "@ikas/bp-storefront-models";
824
+ * import { IkasProduct } from "@ikas/bp-storefront";
825
825
  *
826
826
  * function BackInStockFormComponent({ product }: { product: IkasProduct }) {
827
827
  * const variant = getSelectedProductVariant(product);
@@ -853,7 +853,7 @@ export declare function getProductVariantBackInStockForm(variant: IkasProductVar
853
853
  * @example
854
854
  * ```typescript
855
855
  * import { clearProductVariantBackInStockForm, saveProductVariantBackInStockReminder, getSelectedProductVariant } from "@ikas/bp-storefront";
856
- * import { IkasProduct } from "@ikas/bp-storefront-models";
856
+ * import { IkasProduct } from "@ikas/bp-storefront";
857
857
  *
858
858
  * async function handleSubmitAndReset(product: IkasProduct, email: string) {
859
859
  * const variant = getSelectedProductVariant(product);
@@ -10,7 +10,7 @@ import { IkasThemePageType } from "../../../storefront-models/src";
10
10
  * @example
11
11
  * ```typescript
12
12
  * import { initBaseStore } from "@ikas/bp-storefront";
13
- * import { IkasThemePageType } from "@ikas/bp-storefront-models";
13
+ * import { IkasThemePageType } from "@ikas/bp-storefront";
14
14
  *
15
15
  * initBaseStore(IkasThemePageType.PRODUCT_DETAIL);
16
16
  * ```
@@ -38,7 +38,7 @@ export declare function getCheckoutUrlFromCartStore(cartStore: IkasCartStore): s
38
38
  * @example
39
39
  * ```typescript
40
40
  * import { addItemToCart, getSelectedProductVariant } from "@ikas/bp-storefront";
41
- * import { IkasProduct } from "@ikas/bp-storefront-models";
41
+ * import { IkasProduct } from "@ikas/bp-storefront";
42
42
  *
43
43
  * async function handleAddToCart(product: IkasProduct) {
44
44
  * const variant = getSelectedProductVariant(product);
@@ -69,7 +69,7 @@ export declare function addItemToCart(variant: IkasProductVariant, product: Ikas
69
69
  * @example
70
70
  * ```typescript
71
71
  * import { addSelectedtedVariantToCart } from "@ikas/bp-storefront";
72
- * import { IkasProduct } from "@ikas/bp-storefront-models";
72
+ * import { IkasProduct } from "@ikas/bp-storefront";
73
73
  *
74
74
  * // Quick add button in product list
75
75
  * async function handleQuickAdd(product: IkasProduct) {
@@ -260,7 +260,7 @@ export declare function waitForCartStoreInit(cartStore: IkasCartStore): Promise<
260
260
  * @example
261
261
  * ```typescript
262
262
  * import { cartStore, findExistingCartItem, getSelectedProductVariant } from "@ikas/bp-storefront";
263
- * import { IkasProduct } from "@ikas/bp-storefront-models";
263
+ * import { IkasProduct } from "@ikas/bp-storefront";
264
264
  *
265
265
  * function getCartItemForProduct(product: IkasProduct) {
266
266
  * if (!cartStore.cart) return null;
@@ -293,7 +293,7 @@ export declare function findExistingCartItem(cart: IkasCart, variant: IkasProduc
293
293
  * @example
294
294
  * ```typescript
295
295
  * import { cartStore, findExistingCartItemWithProduct } from "@ikas/bp-storefront";
296
- * import { IkasProduct } from "@ikas/bp-storefront-models";
296
+ * import { IkasProduct } from "@ikas/bp-storefront";
297
297
  *
298
298
  * function isProductInCart(product: IkasProduct): boolean {
299
299
  * if (!cartStore.cart) return false;
@@ -387,7 +387,7 @@ export declare function getCart(): Promise<void>;
387
387
  * @example
388
388
  * ```typescript
389
389
  * import { getAcceptedOffers } from "@ikas/bp-storefront";
390
- * import { IkasProduct } from "@ikas/bp-storefront-models";
390
+ * import { IkasProduct } from "@ikas/bp-storefront";
391
391
  *
392
392
  * function getPendingOffers(product: IkasProduct) {
393
393
  * const pending = getAcceptedOffers(product.offers);
@@ -418,7 +418,7 @@ export declare function getAcceptedOffers(offers: IkasProductOffer[]): {
418
418
  * @example
419
419
  * ```typescript
420
420
  * import { cartStore, createPayWithIkasSession } from "@ikas/bp-storefront";
421
- * import { IkasProduct } from "@ikas/bp-storefront-models";
421
+ * import { IkasProduct } from "@ikas/bp-storefront";
422
422
  *
423
423
  * async function handleBuyNow(product: IkasProduct) {
424
424
  * const result = await createPayWithIkasSession(cartStore, product, 1);
@@ -454,7 +454,7 @@ export declare function createPayWithIkasSession(cartStore: IkasCartStore, produ
454
454
  * @example
455
455
  * ```typescript
456
456
  * import { setCart } from "@ikas/bp-storefront";
457
- * import { IkasCart } from "@ikas/bp-storefront-models";
457
+ * import { IkasCart } from "@ikas/bp-storefront";
458
458
  *
459
459
  * async function handleCartResponse(cart: IkasCart) {
460
460
  * await setCart(cart);
@@ -169,7 +169,7 @@ export declare function socialLoginToken(customerStore: IkasCustomerStore, token
169
169
  * @example
170
170
  * ```typescript
171
171
  * import { customerStore, deleteCustomerAddress } from "@ikas/bp-storefront";
172
- * import { IkasCustomerAddress } from "@ikas/bp-storefront-models";
172
+ * import { IkasCustomerAddress } from "@ikas/bp-storefront";
173
173
  *
174
174
  * async function handleDeleteAddress(address: IkasCustomerAddress) {
175
175
  * const success = await deleteCustomerAddress(customerStore, address);
@@ -769,7 +769,7 @@ export declare function getFavoriteProducts(customerStore: IkasCustomerStore): P
769
769
  * @example
770
770
  * ```typescript
771
771
  * import { customerStore, addProductToFavorites } from "@ikas/bp-storefront";
772
- * import { IkasProduct } from "@ikas/bp-storefront-models";
772
+ * import { IkasProduct } from "@ikas/bp-storefront";
773
773
  *
774
774
  * async function handleAddToWishlist(product: IkasProduct) {
775
775
  * if (!customerStore.customer) {
@@ -1082,7 +1082,7 @@ export declare function getOrderProductFiles(customerStore: IkasCustomerStore, f
1082
1082
  * @example
1083
1083
  * ```typescript
1084
1084
  * import { customerStore, getDigitalProductFileDownloadUrl } from "@ikas/bp-storefront";
1085
- * import { IkasOrder, IkasProductFile } from "@ikas/bp-storefront-models";
1085
+ * import { IkasOrder, IkasProductFile } from "@ikas/bp-storefront";
1086
1086
  *
1087
1087
  * async function handleDownload(order: IkasOrder, file: IkasProductFile) {
1088
1088
  * await getDigitalProductFileDownloadUrl(customerStore, order, file);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ikas/bp-storefront",
3
- "version": "0.16.0",
3
+ "version": "0.17.0",
4
4
  "description": "A framework for the ikas blueprint storefronts.",
5
5
  "author": "ikas",
6
6
  "license": "ISC",