@wix/stores 1.0.973 → 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.
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 +39 -36
  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 +37 -34
  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 +287 -287
  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 +39 -36
  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 +37 -34
  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 +287 -287
  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({
@@ -1622,8 +1622,8 @@ function zi(e2) {
1622
1622
  var Bi = (e2) => Number.parseFloat(e2?.amount);
1623
1623
  var G = (e2) => e2?.amount == null ? void 0 : Bi(e2);
1624
1624
  var Vi = [W.URL, W.DESCRIPTION, W.PLAIN_DESCRIPTION, W.MEDIA_ITEMS_INFO, W.INFO_SECTION, W.INFO_SECTION_DESCRIPTION, W.CURRENCY, W.DISCOUNT_INFO, W.SUBSCRIPTION_PRICES_INFO, W.BREADCRUMBS_INFO, W.DIRECT_CATEGORIES_INFO, W.PRODUCT_CHOICES_MEDIA_REFERENCES, W.PRODUCT_CHOICES_DISPLAY_IMAGE];
1625
- async function Hi(e2) {
1626
- return { product: Ti(await Br(e2, { fields: Vi })) };
1625
+ async function Hi(e2, t2 = Vi) {
1626
+ return { product: Ti(await Br(e2, { fields: t2 })) };
1627
1627
  }
1628
1628
  function Ui(e2) {
1629
1629
  if (e2.status === `fulfilled`) return e2.value;
@@ -3091,8 +3091,8 @@ function Kc(e2, t2, r2, i2 = false) {
3091
3091
  return t3 ? { href: t3 } : void 0;
3092
3092
  }, [e2.slug, u2]);
3093
3093
  return n(() => {
3094
- let { selectedVariant: e3, setHasAttemptedSubmit: n2, isSelectionValid: a3, selectedOptions: u3, selectedModifiers: f2, selectedSubscriptionPlanId: p2, quantity: m2, ...h2 } = t2;
3095
- return { ...o2, link: d2, ...r2, ...h2, buyerSelections: { options: Wc(u3), modifiers: Gc(f2), subscriptionPlanId: p2, quantity: m2 }, ...s2, ...c2, ...l2, isBackInStockEnabled: i2 };
3094
+ let { selectedVariant: e3, setHasAttemptedSubmit: n2, isSelectionValid: a3, selectedOptions: u3, selectedModifiers: f2, selectedSubscriptionPlanId: p2, quantity: m2, productGrouping: h2, ...g2 } = t2;
3095
+ return { ...o2, link: d2, ...r2, ...g2, buyerSelections: { options: Wc(u3), modifiers: Gc(f2), subscriptionPlanId: p2, quantity: m2 }, ...s2, ...c2, ...l2, isBackInStockEnabled: i2 };
3096
3096
  }, [o2, d2, r2, t2, s2, c2, l2, i2]);
3097
3097
  }
3098
3098
  var qc = K(`@wix/site-service-locale`);
@@ -3287,58 +3287,61 @@ function Al(e2, t2) {
3287
3287
  return { ...e2, [t2.groupingCustomizationId]: { ...n2, ...e2[t2.groupingCustomizationId] } };
3288
3288
  }
3289
3289
  function jl(e2, r2) {
3290
- let { navigateToProductPage: i2 } = Pa(), a2 = n(() => wl(e2, r2), [e2, r2]);
3291
- return { productGrouping: a2, selectGroupSiblingChoice: t((e3) => {
3292
- if (!a2) return;
3293
- let t2 = Tl(a2, e3);
3294
- t2 && i2(t2.slug);
3295
- }, [a2, i2]), productCustomizations: n(() => Dl(e2, a2), [e2, a2]), addGroupChoicesAvailability: t((e3) => Al(e3, a2), [a2]), initialSelection: n(() => {
3296
- if (!a2) return { options: {}, modifiers: {} };
3297
- let { customizationType: t2, groupingCustomizationId: n2, currentProductChoiceId: r3 } = a2;
3290
+ let i2 = n(() => wl(e2, r2?.productGroup), [e2, r2?.productGroup]);
3291
+ return { productGrouping: i2, selectGroupSiblingChoice: t((e3) => {
3292
+ if (!i2 || e3 === i2.currentProductChoiceId) return;
3293
+ let t2 = Tl(i2, e3);
3294
+ t2 && r2?.selectProductGroupMember(t2.productId);
3295
+ }, [i2, r2?.selectProductGroupMember]), productCustomizations: n(() => Dl(e2, i2), [e2, i2]), addGroupChoicesAvailability: t((e3) => Al(e3, i2), [i2]), initialSelection: n(() => {
3296
+ if (!i2) return { options: {}, modifiers: {} };
3297
+ let { customizationType: t2, groupingCustomizationId: n2, currentProductChoiceId: r3 } = i2;
3298
3298
  if (t2 === $.MODIFIER && e2.modifiers[n2].mandatory === false) return { options: {}, modifiers: {} };
3299
- let i3 = { [n2]: r3 };
3300
- return t2 === $.PRODUCT_OPTION ? { options: i3, modifiers: {} } : { options: {}, modifiers: i3 };
3301
- }, [a2, e2.modifiers]) };
3299
+ let a2 = { [n2]: r3 };
3300
+ return t2 === $.PRODUCT_OPTION ? { options: a2, modifiers: {} } : { options: {}, modifiers: a2 };
3301
+ }, [i2, e2.modifiers]) };
3302
3302
  }
3303
- function Ml(e2, i2, a2) {
3304
- let o2 = jl(e2, a2), { productGrouping: s2, selectGroupSiblingChoice: c2, addGroupChoicesAvailability: l2 } = o2, [u2, d2] = r(() => o2.initialSelection.options), [f2, p2] = r(() => o2.initialSelection.modifiers), [m2, h2] = r(void 0), [g2, _2] = r(1), [v2, y2] = r(false), b2 = n(() => sl(ul(e2.variants, i2)), [e2.variants, i2]), x2 = n(() => {
3303
+ function Ml({ product: e2, inventoryItems: i2, productGroupData: a2, hasLoadedVariants: o2 = true }) {
3304
+ let s2 = jl(e2, a2), { productGrouping: c2, selectGroupSiblingChoice: l2, addGroupChoicesAvailability: u2 } = s2, [d2, f2] = r(() => s2.initialSelection.options), [p2, m2] = r(() => s2.initialSelection.modifiers), [h2, g2] = r(void 0), [_2, v2] = r(1), [y2, b2] = r(false), x2 = n(() => sl(ul(e2.variants, i2)), [e2.variants, i2]), S2 = n(() => {
3305
3305
  let t2 = /* @__PURE__ */ new Map();
3306
3306
  return (n2) => {
3307
3307
  let r2 = ol(n2), i3 = t2.get(r2);
3308
3308
  if (i3) return i3;
3309
- let a3 = l2(cl(e2.options, b2, n2));
3309
+ let a3 = u2(cl(e2.options, x2, n2));
3310
3310
  return t2.set(r2, a3), a3;
3311
3311
  };
3312
- }, [b2, e2.options, l2]), S2 = n(() => x2(u2), [x2, u2]), C2 = n(() => Object.keys(u2).length === e2.options.length ? b2.get(ol(u2)) ?? null : null, [b2, u2, e2.options.length]), w2 = t((e3, t2) => {
3313
- if (u2[e3] !== t2) {
3314
- if (El(s2, e3, t2)) {
3315
- c2(t2);
3312
+ }, [x2, e2.options, u2])(o2 ? d2 : {}), C2 = n(() => Object.keys(d2).length === e2.options.length ? x2.get(ol(d2)) ?? null : null, [x2, d2, e2.options.length]), w2 = t((e3, t2) => {
3313
+ if (d2[e3] !== t2) {
3314
+ if (El(c2, e3, t2)) {
3315
+ l2(t2);
3316
3316
  return;
3317
3317
  }
3318
- d2((n2) => ({ ...n2, [e3]: t2 })), _2(1);
3318
+ f2((n2) => ({ ...n2, [e3]: t2 })), v2(1);
3319
3319
  }
3320
- }, [u2, s2, c2]), T2 = t((e3, t2) => {
3321
- if (El(s2, e3, t2)) {
3322
- c2(t2);
3320
+ }, [d2, c2, l2]), T2 = t((e3, t2) => {
3321
+ if (El(c2, e3, t2)) {
3322
+ l2(t2);
3323
3323
  return;
3324
3324
  }
3325
- p2((n2) => n2[e3] === t2 ? n2 : { ...n2, [e3]: t2 });
3326
- }, [s2, c2]), E2 = t((e3) => {
3327
- p2((t2) => {
3325
+ m2((n2) => n2[e3] === t2 ? n2 : { ...n2, [e3]: t2 });
3326
+ }, [c2, l2]), E2 = t((e3) => {
3327
+ m2((t2) => {
3328
3328
  if (!(e3 in t2)) return t2;
3329
3329
  let { [e3]: n2, ...r2 } = t2;
3330
3330
  return r2;
3331
3331
  });
3332
3332
  }, []), D2 = t((e3) => {
3333
- h2(e3);
3334
- }, []), O2 = n(() => Ka(C2), [C2]), k2 = n(() => qa(g2, O2), [g2, O2]), ee2 = t((e3) => {
3335
- _2(e3);
3336
- }, []), te2 = n(() => fl({ product: e2, selections: { selectedOptions: u2, selectedModifiers: f2, selectedSubscriptionPlanId: m2, quantity: k2 }, selectedVariant: C2 }), [e2, u2, f2, m2, k2, C2]), ne2 = o2.productCustomizations?.options ?? e2.options, re2 = o2.productCustomizations?.modifiers ?? e2.modifiers;
3337
- return n(() => ({ options: ne2, modifiers: re2, quantity: k2, selectedOptions: u2, selectedModifiers: f2, selectedSubscriptionPlanId: m2, selectedVariant: C2, selectedVariantId: C2?.id ?? null, selectionsAvailability: S2, maxPurchasableQuantity: O2, isSelectionValid: te2.valid, selectionValidationErrors: te2.fields, hasAttemptedSubmit: v2, setHasAttemptedSubmit: y2, selectOption: w2, selectModifier: T2, clearModifierSelection: E2, selectSubscriptionPlan: D2, selectQuantity: ee2 }), [ne2, re2, k2, u2, f2, m2, C2, S2, O2, te2, v2, w2, T2, E2, D2, ee2]);
3333
+ g2(e3);
3334
+ }, []), O2 = n(() => Ka(C2), [C2]), k2 = n(() => qa(_2, O2), [_2, O2]), ee2 = t((e3) => {
3335
+ v2(e3);
3336
+ }, []), te2 = n(() => fl({ product: e2, selections: { selectedOptions: d2, selectedModifiers: p2, selectedSubscriptionPlanId: h2, quantity: k2 }, selectedVariant: C2 }), [e2, d2, p2, h2, k2, C2]), ne2 = s2.productCustomizations?.options ?? e2.options, re2 = s2.productCustomizations?.modifiers ?? e2.modifiers;
3337
+ return n(() => ({ options: ne2, modifiers: re2, quantity: k2, selectedOptions: d2, selectedModifiers: p2, selectedSubscriptionPlanId: h2, selectedVariant: C2, selectedVariantId: C2?.id ?? null, selectionsAvailability: S2, maxPurchasableQuantity: O2, isSelectionValid: te2.valid, selectionValidationErrors: te2.fields, hasAttemptedSubmit: y2, setHasAttemptedSubmit: b2, selectOption: w2, selectModifier: T2, clearModifierSelection: E2, selectSubscriptionPlan: D2, selectQuantity: ee2, productGrouping: c2 }), [ne2, re2, k2, d2, p2, h2, C2, S2, O2, te2, y2, w2, T2, E2, D2, ee2, c2]);
3338
3338
  }
3339
3339
  function Nl({ product: e2, productGroup: t2, inventoryItems: r2, isBackInStockEnabled: i2, source: a2 }) {
3340
- let o2 = Ml(e2, r2, t2), s2 = Ga(e2, o2, Za(e2, o2.selectedVariant)), c2 = Kc(e2, o2, al({ product: e2, userInputs: o2, hasLoadedVariants: true }), i2);
3341
- return n(() => ({ ...c2, ...s2, source: a2 }), [c2, s2, a2]);
3340
+ let { navigateToProductPage: o2 } = Pa(), s2 = Ml({ product: e2, inventoryItems: r2, productGroupData: t2 && { productGroup: t2, selectProductGroupMember: (e3) => {
3341
+ let n2 = t2.members.find((t3) => t3.productId === e3);
3342
+ n2 && o2(n2.slug);
3343
+ } } }), c2 = Ga(e2, s2, Za(e2, s2.selectedVariant)), l2 = Kc(e2, s2, al({ product: e2, userInputs: s2, hasLoadedVariants: true }), i2);
3344
+ return n(() => ({ ...l2, ...c2, source: a2 }), [l2, c2, a2]);
3342
3345
  }
3343
3346
  function Pl({ productPromise: e2, source: t2, children: n2 }) {
3344
3347
  let { product: r2, productGroup: a2, inventoryItems: o2, isBackInStockEnabled: s2 } = Ui(e2), l2 = Nl({ product: r2, productGroup: a2, inventoryItems: o2, isBackInStockEnabled: s2, source: t2 });