@wix/himalaya-cli 0.1096.0 → 0.1098.0

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/stores-v1/src/display.d.ts

@@ -66,6 +66,17 @@ export interface StoreProduct {
             currency?: string;
         };
     };
+    /** Option groups, both spellings: V1 `productOptions`, V3 `options`. Declared
+     *  because the wire carries them on BOTH catalogs and this type denying them is
+     *  what let every template product screen drop the colour/size picker. Shapes
+     *  differ per catalog, so read them with `productOptions()` from ./options. */
+    productOptions?: unknown[];
+    options?: unknown[];
+    /** V3 purchasable variants. The cart addresses a V3 option choice by `variantId`,
+     *  which `cartOptionsPayload()` resolves out of this. */
+    variantsInfo?: {
+        variants?: unknown[];
+    };
 }
 export interface StoreProductsResponse {
     products?: StoreProduct[];

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/stores-v1/src/extensions.d.ts

@@ -43,6 +43,7 @@ export declare function queryInventory(productId: string): Promise<WixQueryInven
  *  Only the supplied fields change (e.g. trackQuantity + a variant's quantity). */
 export declare function updateInventory(inventoryItemId: string, inventoryItem: WixInventoryItemWrite): Promise<WixUpdateInventoryResponse>;
 export * from "./display.js";
+export * from "./options.js";
 /** Forget the resolved Stores catalog version, in this worker and app-wide.
  *  Call this when the app points itself at a DIFFERENT Wix site. */
 export declare function forgetCatalogVersion(): void;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/stores-v1/src/options.d.ts

@@ -0,0 +1,74 @@
+import type { StoreProduct } from "./display.js";
+import { type WixImageSize } from "@wix/himalaya/wix-media";
+/** One selectable choice inside an option group. */
+export interface StoreOptionChoice {
+    /** Stable id within the group. V3: the `choiceId`. V1: the choice's own label,
+     *  which is what V1 has and what its cart payload carries. */
+    id: string;
+    /** What the shopper reads on the chip — "BEIGE", "M". */
+    label: string;
+    /** Is at least one variant carrying this choice in stock? */
+    inStock: boolean;
+    /** HEX swatch the site configured for this choice ("#e1bfc5"), or "" — a colour
+     *  group carries one, a size group does not. */
+    colorCode: string;
+    /** Choice-linked image, sized, or "" when the choice has none. */
+    image: string;
+}
+/** One option group, e.g. `COLOR` with `BEIGE` / `PINK`. */
+export interface StoreOption {
+    /** V3: the option id, used to resolve the variant. V1: the option name. */
+    id: string;
+    name: string;
+    /** `color` groups are the ones worth rendering as swatches — the choices carry
+     *  a `colorCode`. Everything else is a list of words. */
+    kind: "color" | "list";
+    choices: StoreOptionChoice[];
+}
+/** The shopper's pick: option id → choice id. A group the shopper has not chosen
+ *  yet is absent (or maps to ""). */
+export type StoreOptionSelection = Record<string, string>;
+/**
+ * Every offerable option group on a product, in site order, from either catalog.
+ *
+ * `[]` for a product with no options — the common case, so a caller must render
+ * nothing rather than an empty picker.
+ *
+ * `size` sizes the per-choice swatch image, like `productImage`; pass `null` for
+ * the stored original.
+ */
+export declare function productOptions(product: StoreProduct | undefined, size?: WixImageSize | null): StoreOption[];
+/** The choice to preselect for a group: the only one when there is exactly one,
+ *  otherwise "" so the shopper picks deliberately. */
+export declare function defaultChoice(option: StoreOption): string;
+/** A selection with every single-choice group pre-filled — what a product screen
+ *  starts from. */
+export declare function defaultSelection(options: StoreOption[]): StoreOptionSelection;
+/** Has the shopper chosen in EVERY group? Add to cart stays disabled until this
+ *  is true — a half-chosen product is the unfulfillable order. */
+export declare function isSelectionComplete(options: StoreOption[], selection: StoreOptionSelection): boolean;
+/** Human summary of the current selection, e.g. "BEIGE · M" ("" when nothing is
+ *  chosen). Labels, not ids — this is shopper-facing text. */
+export declare function selectionSummary(options: StoreOption[], selection: StoreOptionSelection): string;
+/**
+ * The V3 variant matching the shopper's choices, or "" when none does.
+ *
+ * Set equality on `{optionId, choiceId}` pairs, not order — V3 does not promise
+ * the variant's `choices` array is in the product's option order, and a positional
+ * compare passes on a two-option product until the day the site reorders it.
+ */
+export declare function resolveVariantId(product: StoreProduct | undefined, selection: StoreOptionSelection): string;
+/**
+ * The `catalogReference.options` value for `addToCurrentCart`, built for whichever
+ * catalog this product came from — V3 `{ variantId }`, V1 `{ options: {…} }`.
+ *
+ * `undefined` for a product with no options at all, which is what the cart wants
+ * (the line needs no `options` object).
+ *
+ * THROWS on V3 when the selection matches no variant, rather than returning a
+ * payload that adds an un-fulfillable line. The two ways to get here are a
+ * selection that is still incomplete (guard with `isSelectionComplete`) and a read
+ * whose `variantsInfo` did not come back — both are the caller's to fix, and both
+ * are invisible if this returns a plausible-looking payload instead.
+ */
+export declare function cartOptionsPayload(product: StoreProduct | undefined, options: StoreOption[], selection: StoreOptionSelection): Record<string, unknown> | undefined;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-stores.mjs

@@ -577,6 +577,131 @@ function plainText(value) {
   return (value || "").replace(/<[^>]+>/g, "").replace(/\s+/g, " ").trim();
 }
 
+// ../../stdlib/wix-sdk/stores-v1/src/options.ts
+function str(v) {
+  return typeof v === "string" ? v.trim() : "";
+}
+function choiceImage(raw, size) {
+  const m = raw;
+  const slot = m?.mainMedia ?? m?.items?.[0] ?? raw;
+  return slot ? mediaSlotUrl(slot, size) : "";
+}
+function hex(raw) {
+  const v = str(raw);
+  return /^#[0-9a-fA-F]{3}([0-9a-fA-F]{3})?$/.test(v) ? v.toLowerCase() : "";
+}
+function v1Choices(raw, size) {
+  const out = [];
+  for (const c of Array.isArray(raw) ? raw : []) {
+    const o = c;
+    if (o.visible === false) continue;
+    const label = str(o.description) || str(o.value);
+    if (!label || out.some((x) => x.id === label)) continue;
+    out.push({
+      id: label,
+      label,
+      inStock: o.inStock !== false,
+      colorCode: hex(o.value),
+      image: choiceImage(o.media, size)
+    });
+  }
+  return out;
+}
+function v3Choices(raw, size) {
+  const settings = raw;
+  const out = [];
+  for (const c of Array.isArray(settings?.choices) ? settings.choices : []) {
+    const o = c;
+    if (o.visible === false) continue;
+    const label = str(o.name) || str(o.key);
+    const id = str(o.choiceId);
+    if (!id || !label || out.some((x) => x.id === id)) continue;
+    const linked = Array.isArray(o.linkedMedia) ? o.linkedMedia[0] : void 0;
+    out.push({
+      id,
+      label,
+      inStock: o.inStock !== false,
+      colorCode: hex(o.colorCode) || hex(o.value?.colorCode),
+      image: choiceImage(o.displayImage ?? linked, size)
+    });
+  }
+  return out;
+}
+function kindOf(raw) {
+  const v = str(raw).toUpperCase();
+  return v.includes("COLOR") || v.includes("COLOUR") || v === "SWATCH_CHOICES" ? "color" : "list";
+}
+function productOptions(product, size = WIX_LIST_IMAGE) {
+  const p = product;
+  const out = [];
+  for (const raw of Array.isArray(p?.productOptions) ? p.productOptions : []) {
+    const o = raw;
+    const name = str(o.name);
+    const choices = v1Choices(o.choices, size);
+    if (name) out.push({ id: name, name, kind: kindOf(o.optionType), choices });
+  }
+  if (out.length) return out;
+  for (const raw of Array.isArray(p?.options) ? p.options : []) {
+    const o = raw;
+    const name = str(o.name);
+    const id = str(o.id) || name;
+    const choices = v3Choices(o.choicesSettings, size);
+    if (name) out.push({ id, name, kind: kindOf(o.optionRenderType), choices });
+  }
+  return out;
+}
+function defaultChoice(option) {
+  return option.choices.length === 1 ? option.choices[0].id : "";
+}
+function defaultSelection(options) {
+  const out = {};
+  for (const o of options) {
+    const choice = defaultChoice(o);
+    if (choice) out[o.id] = choice;
+  }
+  return out;
+}
+function isSelectionComplete(options, selection) {
+  return options.every((o) => !!selection[o.id]);
+}
+function selectionSummary(options, selection) {
+  return options.map((o) => o.choices.find((c) => c.id === selection[o.id])?.label ?? "").filter(Boolean).join(" \xB7 ");
+}
+function isV3(p) {
+  return Array.isArray(p.options) || !!p.variantsInfo;
+}
+function resolveVariantId(product, selection) {
+  const p = product;
+  const variants = p?.variantsInfo?.variants ?? [];
+  const want = Object.entries(selection).filter(([, choice]) => !!choice);
+  for (const v of variants) {
+    if (v.visible === false) continue;
+    const pairs = (v.choices ?? []).map((c) => [str(c.optionChoiceIds?.optionId), str(c.optionChoiceIds?.choiceId)]);
+    if (pairs.length !== want.length) continue;
+    if (want.every(([optionId, choiceId]) => pairs.some(([o, c]) => o === optionId && c === choiceId))) {
+      return str(v.id);
+    }
+  }
+  return "";
+}
+function cartOptionsPayload(product, options, selection) {
+  const p = product ?? {};
+  if (isV3(p)) {
+    const variantId = resolveVariantId(product, selection);
+    if (variantId) return { variantId };
+    if (options.length === 0) return void 0;
+    throw new Error(
+      "cartOptionsPayload: no Catalog V3 variant matches the chosen options \u2014 check every option group has a choice (isSelectionComplete) and that the product was read with its variantsInfo."
+    );
+  }
+  const picked = {};
+  for (const o of options) {
+    const choice = selection[o.id];
+    if (choice) picked[o.name] = choice;
+  }
+  return Object.keys(picked).length ? { options: picked } : void 0;
+}
+
 // ../../stdlib/wix-sdk/stores-v1/src/extensions.ts
 function queryProducts(req = {}) {
   return readWithCatalogFallback(async (v) => {
@@ -685,21 +810,28 @@ export {
   WIX_DETAIL_IMAGE,
   WIX_LIST_IMAGE,
   addProductMedia,
+  cartOptionsPayload,
   createProduct,
+  defaultChoice,
+  defaultSelection,
   deleteProduct,
   forgetCatalogVersion2 as forgetCatalogVersion,
   getProduct,
   getStoreProduct,
+  isSelectionComplete,
   isUnsizedWixMedia,
   mediaSlotUrl,
   plainText,
   productGallery,
   productImage,
+  productOptions,
   productPrice,
   queryInventory,
   queryProducts,
   queryStoreProducts,
+  resolveVariantId,
   searchStoreProducts,
+  selectionSummary,
   updateInventory,
   updateProduct,
   wixCall,