@wix/stores 1.0.972 → 1.0.974
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/_sdk-exports/context-category-by-id/runtime.d.ts +33 -4
- package/_sdk-exports/context-category-by-id/runtime.js +2 -2
- package/_sdk-exports/context-category-by-slug/runtime.d.ts +33 -4
- package/_sdk-exports/context-category-by-slug/runtime.js +2 -2
- package/_sdk-exports/context-category-info/runtime.d.ts +6 -1
- package/_sdk-exports/context-category-list/runtime.d.ts +5 -1
- package/_sdk-exports/context-product/runtime.d.ts +13 -13
- package/_sdk-exports/context-product-by-id/runtime.d.ts +19 -11
- package/_sdk-exports/context-product-by-id/runtime.js +2 -2
- package/_sdk-exports/context-product-by-slug/runtime.d.ts +17 -11
- package/_sdk-exports/context-product-by-slug/runtime.js +2 -2
- package/_sdk-exports/context-product-item/runtime.d.ts +35 -2
- package/_sdk-exports/context-product-item/runtime.js +2 -2
- package/_sdk-exports/context-product-list/runtime.d.ts +29 -1
- package/_sdk-exports/context-promotion-item/runtime.d.ts +5 -1
- package/build/cjs/context-category-by-id.d.ts +33 -4
- package/build/cjs/context-category-by-id.js +1187 -822
- package/build/cjs/context-category-by-id.js.map +1 -1
- package/build/cjs/context-category-by-slug.d.ts +33 -4
- package/build/cjs/context-category-by-slug.js +1382 -1017
- package/build/cjs/context-category-by-slug.js.map +1 -1
- package/build/cjs/context-category-info.d.ts +6 -1
- package/build/cjs/context-category-list.d.ts +5 -1
- package/build/cjs/context-product-by-id.d.ts +19 -11
- package/build/cjs/context-product-by-id.js +39 -36
- package/build/cjs/context-product-by-id.js.map +1 -1
- package/build/cjs/context-product-by-slug.d.ts +17 -11
- package/build/cjs/context-product-by-slug.js +37 -34
- package/build/cjs/context-product-by-slug.js.map +1 -1
- package/build/cjs/context-product-item.d.ts +35 -2
- package/build/cjs/context-product-item.js +287 -287
- package/build/cjs/context-product-item.js.map +1 -1
- package/build/cjs/context-product-list.d.ts +29 -1
- package/build/cjs/context-product.d.ts +13 -13
- package/build/cjs/context-promotion-item.d.ts +5 -1
- package/build/es/context-category-by-id.d.mts +33 -4
- package/build/es/context-category-by-id.mjs +1194 -829
- package/build/es/context-category-by-id.mjs.map +1 -1
- package/build/es/context-category-by-slug.d.mts +33 -4
- package/build/es/context-category-by-slug.mjs +1382 -1017
- package/build/es/context-category-by-slug.mjs.map +1 -1
- package/build/es/context-category-info.d.mts +6 -1
- package/build/es/context-category-list.d.mts +5 -1
- package/build/es/context-product-by-id.d.mts +19 -11
- package/build/es/context-product-by-id.mjs +39 -36
- package/build/es/context-product-by-id.mjs.map +1 -1
- package/build/es/context-product-by-slug.d.mts +17 -11
- package/build/es/context-product-by-slug.mjs +37 -34
- package/build/es/context-product-by-slug.mjs.map +1 -1
- package/build/es/context-product-item.d.mts +35 -2
- package/build/es/context-product-item.mjs +287 -287
- package/build/es/context-product-item.mjs.map +1 -1
- package/build/es/context-product-list.d.mts +29 -1
- package/build/es/context-product.d.mts +13 -13
- package/build/es/context-promotion-item.d.mts +5 -1
- package/build/internal/cjs/context-category-by-id.d.ts +33 -4
- package/build/internal/cjs/context-category-by-slug.d.ts +33 -4
- package/build/internal/cjs/context-category-info.d.ts +6 -1
- package/build/internal/cjs/context-category-list.d.ts +5 -1
- package/build/internal/cjs/context-product-by-id.d.ts +19 -11
- package/build/internal/cjs/context-product-by-slug.d.ts +17 -11
- package/build/internal/cjs/context-product-item.d.ts +35 -2
- package/build/internal/cjs/context-product-list.d.ts +29 -1
- package/build/internal/cjs/context-product.d.ts +13 -13
- package/build/internal/cjs/context-promotion-item.d.ts +5 -1
- package/build/internal/es/context-category-by-id.d.mts +33 -4
- package/build/internal/es/context-category-by-slug.d.mts +33 -4
- package/build/internal/es/context-category-info.d.mts +6 -1
- package/build/internal/es/context-category-list.d.mts +5 -1
- package/build/internal/es/context-product-by-id.d.mts +19 -11
- package/build/internal/es/context-product-by-slug.d.mts +17 -11
- package/build/internal/es/context-product-item.d.mts +35 -2
- package/build/internal/es/context-product-list.d.mts +29 -1
- package/build/internal/es/context-product.d.mts +13 -13
- package/build/internal/es/context-promotion-item.d.mts +5 -1
- package/package.json +3 -3
|
@@ -3779,12 +3779,35 @@ interface Product {
|
|
|
3779
3779
|
productGroupId?: string;
|
|
3780
3780
|
}
|
|
3781
3781
|
//#endregion
|
|
3782
|
+
//#region src/api/product-groups/product-groups.d.ts
|
|
3783
|
+
declare enum ProductGroupCustomizationType {
|
|
3784
|
+
PRODUCT_OPTION = "PRODUCT_OPTION",
|
|
3785
|
+
MODIFIER = "MODIFIER"
|
|
3786
|
+
}
|
|
3787
|
+
interface ProductGroup {
|
|
3788
|
+
groupingCustomizationId: string;
|
|
3789
|
+
customizationType: ProductGroupCustomizationType;
|
|
3790
|
+
members: ProductGroupMember[];
|
|
3791
|
+
}
|
|
3792
|
+
interface ProductGroupMember {
|
|
3793
|
+
productId: string;
|
|
3794
|
+
choice: ProductChoice;
|
|
3795
|
+
slug: string;
|
|
3796
|
+
inventoryAvailabilityStatus?: AvailabilityStatus;
|
|
3797
|
+
}
|
|
3798
|
+
interface ProductGroupData {
|
|
3799
|
+
productGroup: ProductGroup;
|
|
3800
|
+
selectProductGroupMember: (productId: string) => void;
|
|
3801
|
+
}
|
|
3802
|
+
//#endregion
|
|
3782
3803
|
//#region src/extensions/product/providers/product-item-context/product-item-context-provider.d.ts
|
|
3783
3804
|
interface ProductItem {
|
|
3784
3805
|
/** The current entry of the `productItems` array. */
|
|
3785
3806
|
product: Product;
|
|
3786
3807
|
/** The default location ID for the product. */
|
|
3787
3808
|
defaultLocationId: string | undefined;
|
|
3809
|
+
/** Group data + sibling-swap handler for this product; absent when the product is not grouped. */
|
|
3810
|
+
productGroupData?: ProductGroupData;
|
|
3788
3811
|
}
|
|
3789
3812
|
//#endregion
|
|
3790
3813
|
//#region src/extensions/gallery/providers/api/promotions/promotions.d.ts
|
|
@@ -3955,7 +3978,12 @@ interface ProductListContextValue {
|
|
|
3955
3978
|
}
|
|
3956
3979
|
//#endregion
|
|
3957
3980
|
//#region src/extensions/gallery/providers/product-list-context/product-list-context-provider.d.ts
|
|
3958
|
-
/**
|
|
3981
|
+
/**
|
|
3982
|
+
* The `useProductListContext()` hook provides access to a store category's products, the filters
|
|
3983
|
+
* and sort options for them, and the visitor's filter and sort selection. Use it to show how many
|
|
3984
|
+
* products match the visitor's filters, let visitors filter and sort the list, and load more
|
|
3985
|
+
* products.
|
|
3986
|
+
*/
|
|
3959
3987
|
declare function useProductListContext(): ProductListContextValue;
|
|
3960
3988
|
/** Props accepted by {@link ProductListContextProvider}. */
|
|
3961
3989
|
interface ProductListContextProviderProps extends React.PropsWithChildren {
|
|
@@ -4081,7 +4081,7 @@ interface ProductContextValue {
|
|
|
4081
4081
|
* @param choiceId - ID of the choice to select, from the option's `choices`.
|
|
4082
4082
|
* @example Show each option's choices as buttons
|
|
4083
4083
|
* ```tsx
|
|
4084
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4084
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4085
4085
|
*
|
|
4086
4086
|
* function OptionButtons() {
|
|
4087
4087
|
* const { options, buyerSelections, selectionsAvailability, selectOption } = useProductContext();
|
|
@@ -4121,7 +4121,7 @@ interface ProductContextValue {
|
|
|
4121
4121
|
* choice to select, from the modifier's `choices`.
|
|
4122
4122
|
* @example Show each choice modifier as a dropdown
|
|
4123
4123
|
* ```tsx
|
|
4124
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4124
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4125
4125
|
*
|
|
4126
4126
|
* function ModifierDropdowns() {
|
|
4127
4127
|
* const { modifiers, buyerSelections, selectModifier } = useProductContext();
|
|
@@ -4158,7 +4158,7 @@ interface ProductContextValue {
|
|
|
4158
4158
|
* @param modifierId - ID of the modifier whose value to clear.
|
|
4159
4159
|
* @example Clear a free-text modifier when the visitor empties its field
|
|
4160
4160
|
* ```tsx
|
|
4161
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4161
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4162
4162
|
*
|
|
4163
4163
|
* function TextModifierFields() {
|
|
4164
4164
|
* const { modifiers, buyerSelections, selectModifier, clearModifierSelection } = useProductContext();
|
|
@@ -4198,7 +4198,7 @@ interface ProductContextValue {
|
|
|
4198
4198
|
* `selectionValidationErrors.subscriptionPlanId`.
|
|
4199
4199
|
* @example Let the visitor choose a subscription plan
|
|
4200
4200
|
* ```tsx
|
|
4201
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4201
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4202
4202
|
*
|
|
4203
4203
|
* function SubscriptionPlanPicker() {
|
|
4204
4204
|
* const { subscriptionPlans, buyerSelections, selectSubscriptionPlan } = useProductContext();
|
|
@@ -4231,7 +4231,7 @@ interface ProductContextValue {
|
|
|
4231
4231
|
* quantity below 1 is kept, and shows as `'below-min'` in `selectionValidationErrors.quantity`.
|
|
4232
4232
|
* @example Change the quantity with plus and minus buttons
|
|
4233
4233
|
* ```tsx
|
|
4234
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4234
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4235
4235
|
*
|
|
4236
4236
|
* function QuantityStepper() {
|
|
4237
4237
|
* const { buyerSelections, maxPurchasableQuantity, selectQuantity } = useProductContext();
|
|
@@ -4274,7 +4274,7 @@ interface ProductContextValue {
|
|
|
4274
4274
|
* Must be the index of an item in `media`.
|
|
4275
4275
|
* @example Switch the gallery item from a row of buttons
|
|
4276
4276
|
* ```tsx
|
|
4277
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4277
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4278
4278
|
*
|
|
4279
4279
|
* function MediaThumbnailNav() {
|
|
4280
4280
|
* const { media, selectedMediaIndex, selectMedia } = useProductContext();
|
|
@@ -4318,7 +4318,7 @@ interface ProductContextValue {
|
|
|
4318
4318
|
* @example Add the selection to the cart on a product page
|
|
4319
4319
|
* ```tsx
|
|
4320
4320
|
* import { useState } from 'react';
|
|
4321
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4321
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4322
4322
|
*
|
|
4323
4323
|
* function AddToCartButton() {
|
|
4324
4324
|
* const { isInStock, isPreOrderState, addToCartState, handleAddToCart } = useProductContext();
|
|
@@ -4358,7 +4358,7 @@ interface ProductContextValue {
|
|
|
4358
4358
|
* @example Start a checkout for the selection on a product page
|
|
4359
4359
|
* ```tsx
|
|
4360
4360
|
* import { useState } from 'react';
|
|
4361
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4361
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4362
4362
|
*
|
|
4363
4363
|
* function BuyNowButton() {
|
|
4364
4364
|
* const { isInStock, isPreOrderState, buyNowState, handleBuyNow } = useProductContext();
|
|
@@ -4403,7 +4403,7 @@ interface ProductContextValue {
|
|
|
4403
4403
|
* @example Offer a back-in-stock email for an out-of-stock selection
|
|
4404
4404
|
* ```tsx
|
|
4405
4405
|
* import { useState, type FormEvent } from 'react';
|
|
4406
|
-
* import { useProductContext } from '@wix/stores/product
|
|
4406
|
+
* import { useProductContext } from '@wix/stores/context/product';
|
|
4407
4407
|
*
|
|
4408
4408
|
* function NotifyMeForm() {
|
|
4409
4409
|
* const { isInStock, isPreOrderState, isBackInStockEnabled, selectedVariantId, handleNotifyMe } = useProductContext();
|
|
@@ -4436,10 +4436,10 @@ interface ProductContextValue {
|
|
|
4436
4436
|
//#endregion
|
|
4437
4437
|
//#region src/extensions/product/providers/product-context/product-context-provider.d.ts
|
|
4438
4438
|
/**
|
|
4439
|
-
* The
|
|
4440
|
-
* the visitor's selection of options, modifiers, subscription plan, and quantity. Use
|
|
4441
|
-
* product, let visitors choose what to buy, and let them add their selection to the
|
|
4442
|
-
* checkout, or sign up for a back-in-stock email.
|
|
4439
|
+
* The `useProductContext()` hook provides access to a store product's details, prices, media, and
|
|
4440
|
+
* stock, and to the visitor's selection of options, modifiers, subscription plan, and quantity. Use
|
|
4441
|
+
* it to show a product, let visitors choose what to buy, and let them add their selection to the
|
|
4442
|
+
* cart, start a checkout, or sign up for a back-in-stock email.
|
|
4443
4443
|
*/
|
|
4444
4444
|
declare function useProductContext(): ProductContextValue;
|
|
4445
4445
|
/** Props accepted by {@link ProductContextProvider}. */
|
|
@@ -66,7 +66,11 @@ interface PromotionItem {
|
|
|
66
66
|
/** The current entry of the `promotionItems` array. */
|
|
67
67
|
promotion: PromotionItemContextValue;
|
|
68
68
|
}
|
|
69
|
-
/**
|
|
69
|
+
/**
|
|
70
|
+
* The `usePromotionItemContext()` hook provides access to a promotion shown among the products in a
|
|
71
|
+
* **Product List**, including its image, alt text, link, and position. Use it to build a promotion
|
|
72
|
+
* card, such as a banner that links to a sale. It returns `null` outside a **Promotion Item**.
|
|
73
|
+
*/
|
|
70
74
|
declare function usePromotionItemContext(): PromotionItemContextValue | null;
|
|
71
75
|
declare function usePromotionItemContextValue({
|
|
72
76
|
promotion
|
|
@@ -3913,9 +3913,31 @@ interface GetProductsListResponse {
|
|
|
3913
3913
|
hasNext: boolean;
|
|
3914
3914
|
}
|
|
3915
3915
|
//#endregion
|
|
3916
|
+
//#region src/api/product-groups/product-groups.d.ts
|
|
3917
|
+
declare enum ProductGroupCustomizationType {
|
|
3918
|
+
PRODUCT_OPTION = "PRODUCT_OPTION",
|
|
3919
|
+
MODIFIER = "MODIFIER"
|
|
3920
|
+
}
|
|
3921
|
+
interface ProductGroup {
|
|
3922
|
+
groupingCustomizationId: string;
|
|
3923
|
+
customizationType: ProductGroupCustomizationType;
|
|
3924
|
+
members: ProductGroupMember[];
|
|
3925
|
+
}
|
|
3926
|
+
interface ProductGroupMember {
|
|
3927
|
+
productId: string;
|
|
3928
|
+
choice: ProductChoice;
|
|
3929
|
+
slug: string;
|
|
3930
|
+
inventoryAvailabilityStatus?: AvailabilityStatus;
|
|
3931
|
+
}
|
|
3932
|
+
interface ProductGroupData {
|
|
3933
|
+
productGroup: ProductGroup;
|
|
3934
|
+
selectProductGroupMember: (productId: string) => void;
|
|
3935
|
+
}
|
|
3936
|
+
//#endregion
|
|
3916
3937
|
//#region src/extensions/gallery/providers/hooks/use-product-list-context-value/use-product-list/use-product-list.d.ts
|
|
3917
3938
|
interface InitialProductList {
|
|
3918
3939
|
page: GetProductsListResponse;
|
|
3940
|
+
productGroupByGroupId: Record<string, ProductGroup>;
|
|
3919
3941
|
filterSelectionKey: string;
|
|
3920
3942
|
sortType: SortTypes;
|
|
3921
3943
|
productsPerPage: number;
|
|
@@ -3969,6 +3991,16 @@ declare function useCategoryContextValue(data: CategoryPageData): {
|
|
|
3969
3991
|
breadcrumbs: CategoryBreadcrumb[];
|
|
3970
3992
|
};
|
|
3971
3993
|
//#endregion
|
|
3994
|
+
//#region src/extensions/product/providers/product-item-context/product-item-context-provider.d.ts
|
|
3995
|
+
interface ProductItem {
|
|
3996
|
+
/** The current entry of the `productItems` array. */
|
|
3997
|
+
product: Product;
|
|
3998
|
+
/** The default location ID for the product. */
|
|
3999
|
+
defaultLocationId: string | undefined;
|
|
4000
|
+
/** Group data + sibling-swap handler for this product; absent when the product is not grouped. */
|
|
4001
|
+
productGroupData?: ProductGroupData;
|
|
4002
|
+
}
|
|
4003
|
+
//#endregion
|
|
3972
4004
|
//#region src/extensions/gallery/providers/hooks/use-product-list-context-value/use-product-list-context-value.d.ts
|
|
3973
4005
|
declare function useProductListContextValue(data: CategoryPageData, productsPerPage: number): {
|
|
3974
4006
|
productCount: number;
|
|
@@ -3987,10 +4019,7 @@ declare function useProductListContextValue(data: CategoryPageData, productsPerP
|
|
|
3987
4019
|
clearAllFilters: () => void;
|
|
3988
4020
|
filters: Filter[];
|
|
3989
4021
|
currency: string | undefined;
|
|
3990
|
-
productItems:
|
|
3991
|
-
product: Product;
|
|
3992
|
-
defaultLocationId: string | undefined;
|
|
3993
|
-
}[];
|
|
4022
|
+
productItems: ProductItem[];
|
|
3994
4023
|
promotionItems: {
|
|
3995
4024
|
promotion: PromotionItemContextValue;
|
|
3996
4025
|
}[];
|