@rebuy/rebuy 2.34.0 → 2.35.0

package/dist/schema/checkout-and-beyond/index.mjs

@@ -13,6 +13,7 @@ var borderWidths = ["base", "medium", "thick"];
 var BorderWidth = freezeEnum(borderWidths);
 var buttonActions = [
   "acceptOffer",
+  "addGift",
   "addToOrder",
   "declineAllOffers",
   "declineOffer",
@@ -22,6 +23,7 @@ var buttonActions = [
   "goToPrevPage",
   "goToURL",
   "removeFromOrder",
+  "removeGift",
   "selectVariant",
   "showPagination",
   "switchToSubscription",
@@ -239,6 +241,90 @@ import { z as z4 } from "zod";
 import { v7 as uuidv7 } from "uuid";
 import { z as z2 } from "zod";
 
+// src/schema/widgets/checkout-and-beyond/icons.ts
+var iconNames = [
+  "alert-circle",
+  "alert-triangle",
+  "alert-triangle-filled",
+  "arrow-down",
+  "arrow-left",
+  "arrow-right",
+  "arrow-up",
+  "arrow-up-right",
+  "bag",
+  "bullet",
+  "calendar",
+  "camera",
+  "caret-down",
+  "cart",
+  "cash-dollar",
+  "categories",
+  "check",
+  "check-circle",
+  "check-circle-filled",
+  "chevron-down",
+  "chevron-left",
+  "chevron-right",
+  "chevron-up",
+  "circle",
+  "clipboard",
+  "clock",
+  "credit-card",
+  "delete",
+  "delivered",
+  "delivery",
+  "disabled",
+  "discount",
+  "edit",
+  "email",
+  "empty",
+  "external",
+  "filter",
+  "geolocation",
+  "gift-card",
+  "globe",
+  "grid",
+  "image",
+  "info",
+  "info-filled",
+  "list-bulleted",
+  "location",
+  "lock",
+  "map",
+  "menu",
+  "menu-horizontal",
+  "menu-vertical",
+  "minus",
+  "mobile",
+  "note",
+  "order",
+  "organization",
+  "plus",
+  "profile",
+  "question-circle",
+  "question-circle-filled",
+  "reorder",
+  "reset",
+  "return",
+  "savings",
+  "search",
+  "settings",
+  "star",
+  "star-filled",
+  "star-half",
+  "store",
+  "truck",
+  "upload",
+  "x",
+  "x-circle",
+  "x-circle-filled"
+];
+var IconName = freezeEnum(iconNames);
+var iconSizes = ["base", "large", "large-100", "small", "small-100", "small-200"];
+var IconSize = freezeEnum(iconSizes);
+var iconTones = ["auto", "critical", "custom", "info", "neutral", "success", "warning"];
+var IconTone = freezeEnum(iconTones);
+
 // src/schema/widgets/checkout-and-beyond/regex.ts
 var ARRAY_INDEX_STRING = /^(0|[1-9]\d*)$/;
 var DYNAMIC_TOKEN_REGEX = /^\{\{\s*[A-Za-z]+\s*\}\}$/;
@@ -291,12 +377,39 @@ var convertNumericObjects = (input) => {
 };
 
 // src/schema/widgets/checkout-and-beyond/image.ts
-var CABImageSection = z2.object({
+var CABImageSectionFields = z2.object({
   altText: z2.string().refine(checkForHTML, NO_HTML).default(""),
-  aspectRatio: z2.literal(1).nullable().default(null),
+  /**
+   * Image width÷height (e.g. `46` for the progress-bar fill); `null` renders at natural size. Any POSITIVE
+   * ratio — never limited to 1, but never `0`/negative either: a renderer dividing by it would get `Infinity`,
+   * and CSS `aspect-ratio` drops a negative value and silently reverts to natural size.
+   */
+  aspectRatio: z2.number().positive().nullable().default(null),
   border: z2.lazy(() => CABBorder),
   buttonField: z2.enum(buttonFields).optional(),
-  category: z2.enum(["gallery", "icons", "payment-methods", "secure-checkout"]).nullable().default(null),
+  /**
+   * `icon` renders `source` as a single `s-icon` by name (the uber-image path covers icons too), reading
+   * `iconSize`/`iconTone`. The other values are a harmless informational holdover from the previous
+   * implementation — they were never significant to rendering (`icons`, plural, is NOT deprecated, just one of
+   * those inert legacy tags); `icon` is the first value that means anything.
+   *
+   * INVARIANT, encoded by the `.superRefine` below (a refined object IS a valid `z.discriminatedUnion` member
+   * in zod 4 — see `CABTextSection`): `category: 'icon'` ⇒ `source` is an icon name or `''` (icon not yet
+   * chosen); any other category ⇒ `source` is NOT a bare icon name, so it stays a URL/token/`''`.
+   *
+   * Encoded rather than left to the renderer because `source` is ONE union with no category gate, so widening
+   * it with `iconNames` also widened what a STORED payload may contain: 14 of the names are plain English
+   * words (`image`, `x`, `search`, `note`, `order`, `globe`, …), and a legacy `source: 'image'` used to fail
+   * parse — which `salvageSections` turns into a null-rendering stub PLUS a drift report. Ungated it would
+   * instead parse and reach the renderer as `<img src="image">`: a broken image, silently, where the old
+   * behavior degraded gracefully and told us about it. The client-assembled half of the invariant was never
+   * the risky half.
+   */
+  category: z2.enum(["gallery", "icon", "icons", "payment-methods", "secure-checkout"]).nullable().default(null),
+  /** `icon`-mode only: the `s-icon` `size`; `null` ⇒ the component default (`base`). Ignored by image treatments. */
+  iconSize: z2.enum(iconSizes).nullable().default(null),
+  /** `icon`-mode only: the `s-icon` `tone`; `null` ⇒ the component default (`auto`). Ignored by image treatments. */
+  iconTone: z2.enum(iconTones).nullable().default(null),
   name: z2.string().optional(),
   naturalHeight: z2.number().default(0),
   naturalWidth: z2.number().default(0),
@@ -308,9 +421,31 @@ var CABImageSection = z2.object({
   rule: CABRule.optional(),
   sectionId: z2.uuid().default(() => uuidv7()),
   sectionType: z2.literal(SectionType.image).default(SectionType.image),
-  source: z2.union([z2.url(), z2.literal(""), z2.string().regex(DYNAMIC_TOKEN_REGEX)]).default(""),
+  /**
+   * An image URL or dynamic token, an empty default, or — when `category: 'icon'` — an icon NAME. Icon mode
+   * takes a name or `''` only, NOT a token: no renderer resolves a token to an icon today, so accepting one
+   * would promise a capability that doesn't exist. Widen the refine's carve-out to `DYNAMIC_TOKEN_REGEX` when a
+   * server-chosen tier icon actually needs it.
+   */
+  source: z2.union([z2.url(), z2.literal(""), z2.string().regex(DYNAMIC_TOKEN_REGEX), z2.enum(iconNames)]).default(""),
   width: z2.number().default(100)
 });
+var iconNameSet = new Set(iconNames);
+var isIconName = (source) => iconNameSet.has(source);
+var CABImageSection = CABImageSectionFields.superRefine(({ category, source }, ctx) => {
+  if (category === "icon" && source !== "" && !isIconName(source))
+    ctx.addIssue({
+      code: "custom",
+      message: "icon-mode source must be an icon name",
+      path: ["source"]
+    });
+  if (category !== "icon" && isIconName(source))
+    ctx.addIssue({
+      code: "custom",
+      message: "source must be a URL or dynamic token unless category is `icon`",
+      path: ["source"]
+    });
+});
 
 // src/schema/widgets/checkout-and-beyond/text.ts
 import { forEach, isString as isString2 } from "es-toolkit/compat";
@@ -430,6 +565,21 @@ var CABButtonSection = z4.object({
   sectionId: z4.uuid().default(() => uuidv73()),
   sections: z4.union([z4.array(CABButtonContent), z4.strictObject({}).transform(() => [])]).default(() => []),
   sectionType: z4.literal(SectionType.button).default(SectionType.button),
+  /**
+   * The smart-cart tier this button acts on (`addGift`/`removeGift`): scopes the click to one tier's gift. The
+   * client resolves the tier's gift (productId) from the progress-bar context by this `tierId` — the button node
+   * stays data, no bespoke per-tier wiring. Absent on non-gift buttons (offer add/remove, navigation, links).
+   *
+   * Deliberately NOT `CABTextTier` (the shape `CABTextSection.tier` uses): a gift button acts on a tier the bar
+   * already resolved, so it needs the id and nothing else. Reusing the text tier would make `threshold`
+   * required, leave `tierId` optional, and DEFAULT `tierType` to `'shipping'` — a schema-supplied wrong answer
+   * on a gift button. Unknown keys are stripped, so a client spreading a whole tier in still parses.
+   *
+   * `.min(1)` because an empty id IS the silently-id-less state this shape exists to prevent: the client's
+   * lookup finds no tier and the click resolves to nothing. Safe to bound — the field is new, so there are no
+   * stored payloads to grandfather, and the producer is client code, not a merchant form.
+   */
+  tier: z4.object({ tierId: z4.string().min(1) }).optional(),
   /** Fire-and-forget pixel POSTed when the button is clicked (e.g. a Monetize decline). */
   trackingUrl: z4.string().optional()
 });
@@ -803,8 +953,12 @@ var CABProgressTier = z13.object({
   }).optional(),
   /**
    * The step-row label at this tier's slot (onsite `getTierLabel`): the merchant custom label, else the
-   * type default ('Free Shipping' / product title / '{n}% Discount'). Localized content; blank ⇒ no
-   * label under the tier's icon. Plain text — the step row is a compact icon+label, not rich copy.
+   * type default — 'Free Shipping' or '{n}% Discount'. A PRODUCT tier gets NO converter label: its name is
+   * the gift PRODUCT title, which the converter can't supply (config carries only product IDs), so the
+   * client resolves it (authoritative Shopify title, React parity) with its own localized generic fallback.
+   * Localized content; absent OR blank ⇒ no label under the tier's icon (the converter's `toTierMeta` already
+   * turns a blank label into an absent key, and a client-authored blank means the same thing — the renderer
+   * emits no caption slot rather than an empty one). Plain text — a compact icon+label.
    */
   label: z13.record(z13.string(), z13.string()).optional(),
   /**
@@ -1099,6 +1253,22 @@ var CABBannerSection = z19.lazy(
     buttonField: z19.enum(buttonFields).optional(),
     color: z19.enum(bannerColors).default("info"),
     dismissible: z19.boolean().default(true),
+    /**
+     * The `s-banner` heading — localized content (a buyer can see a merchant-composed banner). Absent OR
+     * blank ⇒ no heading; the renderer emits no heading slot for `''` rather than an empty one.
+     *
+     * Merchant-composed buyer-facing plain text, so it rejects HTML at the boundary the same way
+     * `CABImageSection.altText` and `CABTextSection.content` do (the unchecked localized records elsewhere —
+     * `progressBar`'s gift labels, `reviews`' plurals — are converter/constant-sourced, not merchant input).
+     *
+     * The refinement is a last-resort ASSERTION, not the normalization boundary: `normalizeTextContent` only
+     * rewrites `sectionType: 'text'` nodes' `content`, so nothing strips markup or canonicalizes `{token}`
+     * here. A producer must strip upstream the way `composeOffer` does for `altText`. Get it wrong and
+     * `salvageSections` stubs the whole banner (children included) with a drift report — degraded, reported,
+     * not a 500. Nothing emits `heading` yet; the first converter that maps merchant banner copy into it
+     * either strips first or teaches `normalizeTextContent` to strip this field.
+     */
+    heading: z19.record(z19.string(), z19.string().refine(checkForHTML, NO_HTML)).optional(),
     sectionType: z19.literal(SectionType.banner).default(SectionType.banner)
   })
 );
@@ -1508,6 +1678,7 @@ export {
   CABDiscountSection,
   CABExperiment,
   CABImageSection,
+  CABImageSectionFields,
   CABIntegrations,
   CABLayoutSection,
   CABMonetizeSection,
@@ -1539,6 +1710,9 @@ export {
   HEX_COLOR_REGEX,
   HTML_TAGS_REGEX,
   HorizontalAlignment,
+  IconName,
+  IconSize,
+  IconTone,
   LanguageKey,
   NO_HTML,
   OFFER_LABELS,
@@ -1586,6 +1760,9 @@ export {
   freezeEnum,
   hasHTMLInDoc,
   horizontalAlignments,
+  iconNames,
+  iconSizes,
+  iconTones,
   isBannerType,
   isButtonType,
   isCarouselType,