@wix/stores 1.0.973 → 1.0.975

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/_sdk-exports/context-category-by-id/runtime.d.ts +33 -4
  2. package/_sdk-exports/context-category-by-id/runtime.js +2 -2
  3. package/_sdk-exports/context-category-by-slug/runtime.d.ts +33 -4
  4. package/_sdk-exports/context-category-by-slug/runtime.js +2 -2
  5. package/_sdk-exports/context-category-info/runtime.d.ts +6 -1
  6. package/_sdk-exports/context-category-list/runtime.d.ts +5 -1
  7. package/_sdk-exports/context-product/runtime.d.ts +13 -13
  8. package/_sdk-exports/context-product-by-id/runtime.d.ts +19 -11
  9. package/_sdk-exports/context-product-by-id/runtime.js +2 -2
  10. package/_sdk-exports/context-product-by-slug/runtime.d.ts +17 -11
  11. package/_sdk-exports/context-product-by-slug/runtime.js +2 -2
  12. package/_sdk-exports/context-product-item/runtime.d.ts +35 -2
  13. package/_sdk-exports/context-product-item/runtime.js +2 -2
  14. package/_sdk-exports/context-product-list/runtime.d.ts +29 -1
  15. package/_sdk-exports/context-promotion-item/runtime.d.ts +5 -1
  16. package/build/cjs/context-category-by-id.d.ts +33 -4
  17. package/build/cjs/context-category-by-id.js +1187 -822
  18. package/build/cjs/context-category-by-id.js.map +1 -1
  19. package/build/cjs/context-category-by-slug.d.ts +33 -4
  20. package/build/cjs/context-category-by-slug.js +1382 -1017
  21. package/build/cjs/context-category-by-slug.js.map +1 -1
  22. package/build/cjs/context-category-info.d.ts +6 -1
  23. package/build/cjs/context-category-list.d.ts +5 -1
  24. package/build/cjs/context-product-by-id.d.ts +19 -11
  25. package/build/cjs/context-product-by-id.js +438 -434
  26. package/build/cjs/context-product-by-id.js.map +1 -1
  27. package/build/cjs/context-product-by-slug.d.ts +17 -11
  28. package/build/cjs/context-product-by-slug.js +449 -445
  29. package/build/cjs/context-product-by-slug.js.map +1 -1
  30. package/build/cjs/context-product-item.d.ts +35 -2
  31. package/build/cjs/context-product-item.js +622 -621
  32. package/build/cjs/context-product-item.js.map +1 -1
  33. package/build/cjs/context-product-list.d.ts +29 -1
  34. package/build/cjs/context-product.d.ts +13 -13
  35. package/build/cjs/context-promotion-item.d.ts +5 -1
  36. package/build/es/context-category-by-id.d.mts +33 -4
  37. package/build/es/context-category-by-id.mjs +1194 -829
  38. package/build/es/context-category-by-id.mjs.map +1 -1
  39. package/build/es/context-category-by-slug.d.mts +33 -4
  40. package/build/es/context-category-by-slug.mjs +1382 -1017
  41. package/build/es/context-category-by-slug.mjs.map +1 -1
  42. package/build/es/context-category-info.d.mts +6 -1
  43. package/build/es/context-category-list.d.mts +5 -1
  44. package/build/es/context-product-by-id.d.mts +19 -11
  45. package/build/es/context-product-by-id.mjs +438 -434
  46. package/build/es/context-product-by-id.mjs.map +1 -1
  47. package/build/es/context-product-by-slug.d.mts +17 -11
  48. package/build/es/context-product-by-slug.mjs +449 -445
  49. package/build/es/context-product-by-slug.mjs.map +1 -1
  50. package/build/es/context-product-item.d.mts +35 -2
  51. package/build/es/context-product-item.mjs +622 -621
  52. package/build/es/context-product-item.mjs.map +1 -1
  53. package/build/es/context-product-list.d.mts +29 -1
  54. package/build/es/context-product.d.mts +13 -13
  55. package/build/es/context-promotion-item.d.mts +5 -1
  56. package/build/internal/cjs/context-category-by-id.d.ts +33 -4
  57. package/build/internal/cjs/context-category-by-slug.d.ts +33 -4
  58. package/build/internal/cjs/context-category-info.d.ts +6 -1
  59. package/build/internal/cjs/context-category-list.d.ts +5 -1
  60. package/build/internal/cjs/context-product-by-id.d.ts +19 -11
  61. package/build/internal/cjs/context-product-by-slug.d.ts +17 -11
  62. package/build/internal/cjs/context-product-item.d.ts +35 -2
  63. package/build/internal/cjs/context-product-list.d.ts +29 -1
  64. package/build/internal/cjs/context-product.d.ts +13 -13
  65. package/build/internal/cjs/context-promotion-item.d.ts +5 -1
  66. package/build/internal/es/context-category-by-id.d.mts +33 -4
  67. package/build/internal/es/context-category-by-slug.d.mts +33 -4
  68. package/build/internal/es/context-category-info.d.mts +6 -1
  69. package/build/internal/es/context-category-list.d.mts +5 -1
  70. package/build/internal/es/context-product-by-id.d.mts +19 -11
  71. package/build/internal/es/context-product-by-slug.d.mts +17 -11
  72. package/build/internal/es/context-product-item.d.mts +35 -2
  73. package/build/internal/es/context-product-list.d.mts +29 -1
  74. package/build/internal/es/context-product.d.mts +13 -13
  75. package/build/internal/es/context-promotion-item.d.mts +5 -1
  76. package/package.json +2 -2
@@ -3513,7 +3513,12 @@ declare function useCategoryInfo(category: Category): {
3513
3513
  //#endregion
3514
3514
  //#region src/extensions/gallery/providers/category-info-context/category-info-context-provider.d.ts
3515
3515
  type CategoryInfoContextImplementation = ReturnType<typeof useCategoryInfo>;
3516
- /** Reads the category details supplied by a surrounding category info provider. */
3516
+ /**
3517
+ * The `useCategoryInfoContext()` hook provides access to a store category's name, descriptions,
3518
+ * image, page link, and the categories it's nested under. Use it to show a category's details, for
3519
+ * example in the header of a category page, and to link to the category and to the categories it's
3520
+ * nested under.
3521
+ */
3517
3522
  declare function useCategoryInfoContext(): CategoryInfoContextValue;
3518
3523
  /** Props accepted by {@link CategoryInfoContextProvider}. */
3519
3524
  interface CategoryInfoContextProviderProps extends React.PropsWithChildren {
@@ -86,7 +86,11 @@ interface CategoryListContextValue {
86
86
  }
87
87
  //#endregion
88
88
  //#region src/extensions/gallery/providers/category-list-context/category-list-context-provider.d.ts
89
- /** Reads the visible store categories and the current category. */
89
+ /**
90
+ * The `useCategoryListContext()` hook provides access to the store's visible categories and to the
91
+ * ID of the category whose page the component is on. Use it to build category navigation, such as
92
+ * links to the current category's child categories or to its parent category.
93
+ */
90
94
  declare function useCategoryListContext(): CategoryListContextValue;
91
95
  /** Props accepted by {@link CategoryListContextProvider}. */
92
96
  interface CategoryListContextProviderProps extends React.PropsWithChildren {
@@ -4010,16 +4010,7 @@ interface Price {
4010
4010
  formattedAmount: string;
4011
4011
  }
4012
4012
  //#endregion
4013
- //#region src/domain/inventory/inventory.d.ts
4014
- interface InventoryItem {
4015
- variantId: string;
4016
- availabilityStatus?: AvailabilityStatusWithLiterals;
4017
- quantity?: number;
4018
- trackQuantity: boolean;
4019
- preorderInfo?: PreorderInfo;
4020
- }
4021
- //#endregion
4022
- //#region src/extensions/product/providers/api/product-groups/product-groups.d.ts
4013
+ //#region src/api/product-groups/product-groups.d.ts
4023
4014
  declare enum ProductGroupCustomizationType {
4024
4015
  PRODUCT_OPTION = "PRODUCT_OPTION",
4025
4016
  MODIFIER = "MODIFIER"
@@ -4036,6 +4027,15 @@ interface ProductGroupMember {
4036
4027
  inventoryAvailabilityStatus?: AvailabilityStatus;
4037
4028
  }
4038
4029
  //#endregion
4030
+ //#region src/domain/inventory/inventory.d.ts
4031
+ interface InventoryItem {
4032
+ variantId: string;
4033
+ availabilityStatus?: AvailabilityStatusWithLiterals;
4034
+ quantity?: number;
4035
+ trackQuantity: boolean;
4036
+ preorderInfo?: PreorderInfo;
4037
+ }
4038
+ //#endregion
4039
4039
  //#region src/extensions/product/providers/hooks/use-price/use-price.d.ts
4040
4040
  /** Way to buy a subscription product, either one of its subscription plans or a one-time purchase. */
4041
4041
  interface SubscriptionPlan {
@@ -4213,7 +4213,15 @@ interface ProductByIdContextProviderProps extends React.PropsWithChildren {
4213
4213
  productId?: string;
4214
4214
  }
4215
4215
  type ProductByIdContextImplementation = ReturnType<typeof useStandaloneProductContextValue>;
4216
- /** Reads the product context for the configured product. */
4216
+ /**
4217
+ * The `useProductByIdContext()` hook provides access to the store product chosen in the settings of
4218
+ * a **Product**
4219
+ * [Data Source](https://dev.wix.com/docs/studio-two/code-your-site/code-model/data-sources/about-data-sources):
4220
+ * its details, prices, media, and stock, and the visitor's selection of options, modifiers,
4221
+ * subscription plan, and quantity. Use it to feature a product anywhere on a site, let visitors
4222
+ * choose what to buy, and let them add their selection to the cart, start a checkout, or sign up
4223
+ * for a back-in-stock email.
4224
+ */
4217
4225
  declare function useProductByIdContext(): ProductContextValue;
4218
4226
  /** Loads a product by ID and supplies its details and purchase actions to descendants. */
4219
4227
  declare function ProductByIdContextProvider({