@ikas/bp-storefront 0.15.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.
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/addToCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/completeRegistration.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/contactForm.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/helpers.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/pageView.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/productView.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/removeFromCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/viewBrand.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/viewCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/viewCategory.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/viewListing.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/viewSearchResults.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/analytics-functions/viewStorefrontPopup.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/facebook/addToCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/facebook/productView.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/facebook/purchase.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/facebook/viewCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/google-analytics/addToCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/google-analytics/productView.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/google-analytics/removeFromCart.d.ts +1 -1
- package/dist/analytics/google-analytics/viewCart.d.ts +2 -0
- package/dist/{storefront/src/analytics → analytics}/google-tag-manager/addToCart.d.ts +2 -2
- package/dist/{storefront/src/analytics → analytics}/google-tag-manager/completeRegistration.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/google-tag-manager/productView.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/google-tag-manager/removeFromCart.d.ts +2 -2
- package/dist/{storefront/src/analytics → analytics}/google-tag-manager/viewCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/google-tag-manager/viewCategory.d.ts +3 -3
- package/dist/{storefront/src/analytics → analytics}/ikas/analytics.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/tiktok/addToCart.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/tiktok/productView.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/tiktok/viewCategory.d.ts +1 -1
- package/dist/{storefront/src/analytics → analytics}/utils.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/api/blog/index.d.ts +5 -5
- package/dist/{storefront/src/functions → functions}/api/brand/index.d.ts +3 -3
- package/dist/{storefront/src/functions → functions}/api/cart/index.d.ts +9 -9
- package/dist/{storefront/src/functions → functions}/api/category/index.d.ts +3 -3
- package/dist/functions/api/checkout/index.d.ts +32 -0
- package/dist/functions/api/customer/index.d.ts +204 -0
- package/dist/{storefront/src/functions → functions}/api/file/index.d.ts +3 -3
- package/dist/functions/api/html-meta-data/index.d.ts +4 -0
- package/dist/{storefront/src/functions → functions}/api/location/index.d.ts +7 -7
- package/dist/{storefront/src/functions → functions}/api/loyalty/index.d.ts +7 -7
- package/dist/functions/api/masterpass/index.d.ts +2 -0
- package/dist/functions/api/merchant/index.d.ts +4 -0
- package/dist/functions/api/popup/index.d.ts +4 -0
- package/dist/{storefront/src/functions → functions}/api/product/index.d.ts +21 -21
- package/dist/{storefront/src/functions → functions}/api/raffle/index.d.ts +5 -5
- package/dist/functions/api/storefront/index.d.ts +3 -0
- package/dist/{storefront/src/functions → functions}/models/attribute-detail/index.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/models/attribute-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/base/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog/category/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog/category/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog-category-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog-category-list/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/blog-list/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/brand/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/brand/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/brand-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/brand-list/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/campaign-offer/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/category/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/category/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/category/path-item/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/category/path-item/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/category-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/category-list/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/checkout/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/country/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer/address/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer/attribute/index.d.ts +3 -3
- package/dist/{storefront/src/functions → functions}/models/customer/attribute/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer/index.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/models/customer/review/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer/review/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer-review-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer-review-list/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer-review-summary-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/customer-review-summary-list/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/filter-category/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/html-meta-data/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/ikas-theme/date-picker.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/image/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/merchant-settings/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/address/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/adjustment/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/gift-package/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/index.d.ts +7 -7
- package/dist/{storefront/src/functions → functions}/models/order/line-item/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/line-item/option/value/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/line-item/variant/bundle-product/bundle-variant/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/line-item/variant/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/line-item/variant/value/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/order/package/index.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/models/order/transaction/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/payment-gateway/index.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/models/payment-gateway/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/attribute/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/attribute-value/index.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/models/product/attribute-value/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/campaign-offer/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/campaign-offer/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/campaign-offer/product/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/filter/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/filter/settings/init.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/models/product/group/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/image/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/index.d.ts +47 -47
- package/dist/{storefront/src/functions → functions}/models/product/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/option-set/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/option-set/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/option-set/option/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/option-set/option/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/stock-location/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/variant/index.d.ts +34 -34
- package/dist/{storefront/src/functions → functions}/models/product/variant/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/variant/price/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product/variant-type/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/product-list/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/raffle/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/raffle/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/state/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/account-info/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/address/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/back-in-stock-notification/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/contact-form/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/coupon-code-form/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/customer-review/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/forgot-password/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/login/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/newsletter-subscription/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/order-tracking/index.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/models/validator/recover-password/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/register/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/sms-login/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/validator/verify-phone-number/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/variant-type/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/variant-type/init.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/models/variant-type/variant-value/index.d.ts +1 -1
- package/dist/{storefront/src/functions → functions}/stores/base/index.d.ts +2 -2
- package/dist/{storefront/src/functions → functions}/stores/cart/index.d.ts +9 -9
- package/dist/{storefront/src/functions → functions}/stores/customer/index.d.ts +9 -9
- package/dist/{storefront/src/index.d.ts → index.d.ts} +4 -4
- package/dist/{storefront/src/router → router}/index.d.ts +1 -1
- package/dist/{storefront/src/stores → stores}/base/index.d.ts +1 -1
- package/dist/{storefront/src/stores → stores}/cart/index.d.ts +1 -1
- package/dist/{storefront/src/stores → stores}/customer/index.d.ts +3 -3
- package/dist/{storefront/src/theme → theme}/styles/index.d.ts +1 -1
- package/package.json +2 -2
- package/dist/storefront/src/analytics/google-analytics/viewCart.d.ts +0 -2
- package/dist/storefront/src/functions/api/checkout/index.d.ts +0 -32
- package/dist/storefront/src/functions/api/customer/index.d.ts +0 -204
- package/dist/storefront/src/functions/api/html-meta-data/index.d.ts +0 -4
- package/dist/storefront/src/functions/api/masterpass/index.d.ts +0 -2
- package/dist/storefront/src/functions/api/merchant/index.d.ts +0 -4
- package/dist/storefront/src/functions/api/popup/index.d.ts +0 -4
- package/dist/storefront/src/functions/api/storefront/index.d.ts +0 -3
- /package/dist/{storefront/src/analytics → analytics}/analytics-functions/addToWishlist.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/analytics-functions/createEmailSubscription.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/analytics-functions/customerLogin.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/analytics-functions/customerLogout.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/analytics-functions/customerVisit.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/analytics-functions/index.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/analytics-functions/search.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/analytics.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/events.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/facebook/addToWishlist.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/facebook/completeRegistration.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/facebook/contactForm.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/facebook/pageView.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/facebook/search.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/facebook/utils.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/facebook/viewCategory.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-analytics/search.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-analytics/utils.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-tag-manager/customerLogin.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-tag-manager/customerLogout.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-tag-manager/customerVisit.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-tag-manager/disableHTML.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-tag-manager/pageView.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-tag-manager/search.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/google-tag-manager/utils.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/tiktok/addToWishlist.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/tiktok/completeRegistration.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/tiktok/contactForm.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/tiktok/identify.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/tiktok/pageView.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/tiktok/search.d.ts +0 -0
- /package/dist/{storefront/src/analytics → analytics}/tiktok/utils.d.ts +0 -0
- /package/dist/{storefront/src/externals → externals}/index.d.ts +0 -0
- /package/dist/{storefront/src/functions → functions}/models/index.d.ts +0 -0
- /package/dist/{storefront/src/functions → functions}/models/validator/index.d.ts +0 -0
- /package/dist/{storefront/src/functions → functions}/others/index.d.ts +0 -0
- /package/dist/{storefront/src/functions → functions}/stores/index.d.ts +0 -0
- /package/dist/{storefront/src/i18n → i18n}/index.d.ts +0 -0
- /package/dist/{storefront/src/theme → theme}/infinite-scroller/index.d.ts +0 -0
- /package/dist/{storefront/src/theme → theme}/overlay/index.d.ts +0 -0
- /package/dist/{storefront/src/theme → theme}/slider/index.d.ts +0 -0
- /package/dist/{storefront/src/utils → utils}/blueprint.d.ts +0 -0
- /package/dist/{storefront/src/utils → utils}/currency.d.ts +0 -0
- /package/dist/{storefront/src/utils → utils}/fetch.d.ts +0 -0
- /package/dist/{storefront/src/utils → utils}/helper.d.ts +0 -0
- /package/dist/{storefront/src/utils → utils}/object-wrapper.d.ts +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { BackInStockNotificationForm, IkasAppliedCampaignAmount, IkasProductAttributeMap, IkasProductPrice, IkasProductVariant } from "
|
|
1
|
+
import { BackInStockNotificationForm, IkasAppliedCampaignAmount, IkasProductAttributeMap, IkasProductPrice, IkasProductVariant } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Get the main/primary image for a product variant.
|
|
4
4
|
*
|
|
@@ -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
|
|
14
|
+
* import { IkasProduct } from "@ikas/bp-storefront";
|
|
15
15
|
*
|
|
16
16
|
* function ProductImage({ product }: { product: IkasProduct }) {
|
|
17
17
|
* const variant = getSelectedProductVariant(product);
|
|
@@ -25,7 +25,7 @@ import { BackInStockNotificationForm, IkasAppliedCampaignAmount, IkasProductAttr
|
|
|
25
25
|
* }
|
|
26
26
|
* ```
|
|
27
27
|
*/
|
|
28
|
-
export declare function getProductVariantMainImage(variant: IkasProductVariant): import("
|
|
28
|
+
export declare function getProductVariantMainImage(variant: IkasProductVariant): import("../../../../storefront-models/src").IkasProductImage | undefined;
|
|
29
29
|
/**
|
|
30
30
|
* Check if a specific product variant has stock available.
|
|
31
31
|
*
|
|
@@ -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
|
|
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
|
|
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
|
|
97
|
+
* import { IkasProduct } from "@ikas/bp-storefront";
|
|
98
98
|
*
|
|
99
99
|
* function B2BPriceInfo({ product }: { product: IkasProduct }) {
|
|
100
100
|
* const variant = getSelectedProductVariant(product);
|
|
@@ -107,7 +107,7 @@ export declare function getGroupedAttributeValuesForVariant(variant: IkasProduct
|
|
|
107
107
|
* }
|
|
108
108
|
* ```
|
|
109
109
|
*/
|
|
110
|
-
export declare function getProductVariantB2bPriceRule(variant: IkasProductVariant): import("
|
|
110
|
+
export declare function getProductVariantB2bPriceRule(variant: IkasProductVariant): import("../../../../storefront-models/src").IkasCustomerPriceListRule | null;
|
|
111
111
|
/**
|
|
112
112
|
* Get the applicable price object for a product variant based on the storefront or B2B customer price list.
|
|
113
113
|
*
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
856
|
+
* import { IkasProduct } from "@ikas/bp-storefront";
|
|
857
857
|
*
|
|
858
858
|
* async function handleSubmitAndReset(product: IkasProduct, email: string) {
|
|
859
859
|
* const variant = getSelectedProductVariant(product);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IkasProductVariant } from "
|
|
1
|
+
import { IkasProductVariant } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes a product variant by initializing its images, sorting them by order, and initializing its attribute values.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IkasProductPrice } from "
|
|
1
|
+
import { IkasProductPrice } from "../../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Returns the final effective price for a product, using the discount price if available or falling back to the sell price.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IkasProductVariantType } from "
|
|
1
|
+
import { IkasProductVariantType } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes a product variant type by reordering its variant values to match the specified variant value IDs order, then delegating to the variant type initializer for locale translations.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IkasApplicableProductFilterValue, IkasFilterCategory, IkasProductFilter, IkasProductFilterNumberRangeListOption, IkasProductList, IkasProductListSortType, IkasSearchSuggestion } from "
|
|
1
|
+
import { IkasApplicableProductFilterValue, IkasFilterCategory, IkasProductFilter, IkasProductFilterNumberRangeListOption, IkasProductList, IkasProductListSortType, IkasSearchSuggestion } from "../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes a new product list with default values merged with the provided partial data.
|
|
4
4
|
*
|
package/dist/{storefront/src/functions → functions}/models/validator/account-info/index.d.ts
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AccountInfoForm } from "
|
|
1
|
+
import { AccountInfoForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the account info form by loading the current customer's first name, last name, and phone from the store and setting default field states.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AddressForm, IkasCustomerAddress } from "
|
|
1
|
+
import { AddressForm, IkasCustomerAddress } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes an address form with default or existing address values, loads location data, and configures field settings.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { BackInStockNotificationForm, IkasProductVariant } from "
|
|
1
|
+
import { BackInStockNotificationForm, IkasProductVariant } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the back-in-stock notification form by associating it with a product variant and setting up the email field with localized label and placeholder.
|
|
4
4
|
*
|
package/dist/{storefront/src/functions → functions}/models/validator/contact-form/index.d.ts
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ContactForm } from "
|
|
1
|
+
import { ContactForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the contact form with default field states for first name, last name, email, phone, and message, including localized labels and placeholders.
|
|
4
4
|
*
|
package/dist/{storefront/src/functions → functions}/models/validator/customer-review/index.d.ts
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CustomerReviewForm } from "
|
|
1
|
+
import { CustomerReviewForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the customer review form with default field values, labels, and placeholders for title, comment, and star rating.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { NewsletterSubscriptionForm } from "
|
|
1
|
+
import { NewsletterSubscriptionForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the newsletter subscription form with default field values and resets submission state.
|
|
4
4
|
*
|
package/dist/{storefront/src/functions → functions}/models/validator/order-tracking/index.d.ts
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { OrderTrackingForm } from "
|
|
1
|
+
import { OrderTrackingForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the order tracking form with default field values for email and order number, and resets submission state.
|
|
4
4
|
*
|
|
@@ -67,4 +67,4 @@ export declare function setOrderTrackingFormOrderNumber(orderTrackingForm: Order
|
|
|
67
67
|
* }
|
|
68
68
|
* ```
|
|
69
69
|
*/
|
|
70
|
-
export declare function submitOrderTrackingForm(orderTrackingForm: OrderTrackingForm): Promise<import("
|
|
70
|
+
export declare function submitOrderTrackingForm(orderTrackingForm: OrderTrackingForm): Promise<import("../../../../storefront-models/src").IkasOrder | null>;
|
package/dist/{storefront/src/functions → functions}/models/validator/recover-password/index.d.ts
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RecoverPasswordForm } from "
|
|
1
|
+
import { RecoverPasswordForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the recover password form with default field values for password and password confirmation, and resets submission state.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IkasFormAttributeItem, RegisterForm } from "
|
|
1
|
+
import { IkasFormAttributeItem, RegisterForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the registration form with default field values, labels, placeholders, and customer attributes.
|
|
4
4
|
*
|
package/dist/{storefront/src/functions → functions}/models/validator/verify-phone-number/index.d.ts
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { VerifyPhoneNumberForm } from "
|
|
1
|
+
import { VerifyPhoneNumberForm } from "../../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the phone number verification form with default field values and sets the step to "Enter Phone Number".
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IkasVariantType } from "
|
|
1
|
+
import { IkasVariantType } from "../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes a variant type by linking each variant value back to its parent variant type and applying locale-specific translations.
|
|
4
4
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IkasThemePageType } from "
|
|
1
|
+
import { IkasThemePageType } from "../../../storefront-models/src";
|
|
2
2
|
/**
|
|
3
3
|
* Initializes the base store by setting the current page type.
|
|
4
4
|
*
|
|
@@ -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
|
|
13
|
+
* import { IkasThemePageType } from "@ikas/bp-storefront";
|
|
14
14
|
*
|
|
15
15
|
* initBaseStore(IkasThemePageType.PRODUCT_DETAIL);
|
|
16
16
|
* ```
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { APIResponse } from "
|
|
2
|
-
import { IkasCart, IkasOrderLineItem, IkasProduct, IkasProductOffer, IkasProductVariant } from "
|
|
1
|
+
import { APIResponse } from "../../../storefront-api-client/src";
|
|
2
|
+
import { IkasCart, IkasOrderLineItem, IkasProduct, IkasProductOffer, IkasProductVariant } from "../../../storefront-models/src";
|
|
3
3
|
import { IkasCartStore } from "../../../stores/cart";
|
|
4
4
|
/**
|
|
5
5
|
* Get the checkout URL for the current cart.
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
457
|
+
* import { IkasCart } from "@ikas/bp-storefront";
|
|
458
458
|
*
|
|
459
459
|
* async function handleCartResponse(cart: IkasCart) {
|
|
460
460
|
* await setCart(cart);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { SaveCustomerFormDataInput } from "
|
|
2
|
-
import { APIResponse } from "
|
|
3
|
-
import { AccountInfoForm, AddressForm, ContactForm, CouponCodeForm, ForgotPasswordForm, IkasContactForm, IkasCustomer, IkasCustomerAddress, IkasCustomerAttributeValue, IkasCustomerReviewForm, IkasFavoriteProduct, IkasOrder, IkasOrderTransaction, IkasProduct, IkasProductFile, LoginForm, NewsletterSubscriptionForm, OrderTrackingForm, RecoverPasswordForm, RegisterForm, SmsLoginForm, VerifyPhoneNumberForm } from "
|
|
1
|
+
import type { SaveCustomerFormDataInput } from "../../../storefront-api/src";
|
|
2
|
+
import { APIResponse } from "../../../storefront-api-client/src";
|
|
3
|
+
import { AccountInfoForm, AddressForm, ContactForm, CouponCodeForm, ForgotPasswordForm, IkasContactForm, IkasCustomer, IkasCustomerAddress, IkasCustomerAttributeValue, IkasCustomerReviewForm, IkasFavoriteProduct, IkasOrder, IkasOrderTransaction, IkasProduct, IkasProductFile, LoginForm, NewsletterSubscriptionForm, OrderTrackingForm, RecoverPasswordForm, RegisterForm, SmsLoginForm, VerifyPhoneNumberForm } from "../../../storefront-models/src";
|
|
4
4
|
import { IkasCustomerStore } from "../../../stores/customer";
|
|
5
5
|
import { IkasLoginError, IkasRegisterError } from "../../api/customer";
|
|
6
6
|
export type SocialLoginProvider = "facebook" | "google" | "twitch";
|
|
@@ -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
|
|
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
|
|
772
|
+
* import { IkasProduct } from "@ikas/bp-storefront";
|
|
773
773
|
*
|
|
774
774
|
* async function handleAddToWishlist(product: IkasProduct) {
|
|
775
775
|
* if (!customerStore.customer) {
|
|
@@ -903,7 +903,7 @@ export declare function saveCustomerFormData(customerStore: IkasCustomerStore, i
|
|
|
903
903
|
* }
|
|
904
904
|
* ```
|
|
905
905
|
*/
|
|
906
|
-
export declare function sendReview(customerStore: IkasCustomerStore, input: IkasCustomerReviewForm): Promise<import("
|
|
906
|
+
export declare function sendReview(customerStore: IkasCustomerStore, input: IkasCustomerReviewForm): Promise<import("../../../storefront-models/src").IkasCustomerReview | undefined>;
|
|
907
907
|
/**
|
|
908
908
|
* Deactivate (delete) the current customer's account after password verification.
|
|
909
909
|
*
|
|
@@ -1045,7 +1045,7 @@ export declare function waitForCaptchaTokenInit(customerStore: IkasCustomerStore
|
|
|
1045
1045
|
* }
|
|
1046
1046
|
* ```
|
|
1047
1047
|
*/
|
|
1048
|
-
export declare function getCustomerAttributes(customerStore: IkasCustomerStore): Promise<import("
|
|
1048
|
+
export declare function getCustomerAttributes(customerStore: IkasCustomerStore): Promise<import("../../../storefront-models/src").IkasCustomerAttribute[]>;
|
|
1049
1049
|
/**
|
|
1050
1050
|
* Get digital product files associated with an order by their file IDs.
|
|
1051
1051
|
*
|
|
@@ -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
|
|
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);
|
|
@@ -1172,7 +1172,7 @@ export declare function setSavedLastViewedProductsResponse(customerStore: IkasCu
|
|
|
1172
1172
|
* }
|
|
1173
1173
|
* ```
|
|
1174
1174
|
*/
|
|
1175
|
-
export declare function getLastViewedProducts(customerStore: IkasCustomerStore): Promise<import("
|
|
1175
|
+
export declare function getLastViewedProducts(customerStore: IkasCustomerStore): Promise<import("../../../storefront-models/src").IkasLastViewedProduct[]>;
|
|
1176
1176
|
/**
|
|
1177
1177
|
* Record a product view event, saving it to the API for logged-in users or local storage for guests.
|
|
1178
1178
|
*
|