@rebuy/rebuy 3.41.0 → 3.43.0

package/dist/transforms/postPurchase/convertProductInformation.d.ts

@@ -1,4 +1,8 @@
 import { CABOffersSection } from '../../schema/widgets/checkout-and-beyond/offers';
 import type { Reporter } from '../../server/shared';
-/** Structure only: the card provider binds the separately prepared fixed product. */
-export declare const convertProductInformation: (raw: unknown, report?: Reporter) => CABOffersSection[];
+/**
+ * Structure only: the card provider binds the separately prepared fixed product. The card is built from
+ * the section types the checkout offer card uses — price, purchase mode, variants, quantity — plus the
+ * post-purchase price breakdown and recurring summary, all driven by the saved widget settings.
+ */
+export declare const convertProductInformation: (raw: unknown, report?: Reporter, widgetSettings?: unknown) => CABOffersSection[];

package/dist/transforms/postPurchase/productCardControls.d.ts

@@ -0,0 +1,7 @@
+import { type ProductCardSettings } from '../../transforms/postPurchase/productCardSettings';
+/**
+ * The card's controls in legacy `ProductOffer` order: purchase mode, product group, variants, quantity.
+ * The purchase mode is the checkout card's `switchToSubscription` button as-is (its default labels, and
+ * `disableDowngrade` for a subscription-only widget).
+ */
+export declare const productCardControls: (settings: ProductCardSettings) => Record<string, unknown>[];

package/dist/transforms/postPurchase/productCardCosts.d.ts

@@ -0,0 +1,3 @@
+import { type ProductCardSettings } from '../../transforms/postPurchase/productCardSettings';
+/** The breakdown, then the recurring summary (legacy `ProductOffer` order). */
+export declare const productCardCosts: (settings: ProductCardSettings) => Record<string, unknown>[];

package/dist/transforms/postPurchase/productCardPricing.d.ts

@@ -0,0 +1,3 @@
+import { type ProductCardSettings } from '../../transforms/postPurchase/productCardSettings';
+/** The price line — the checkout offer card's own (`{{variantPrice}}` + struck `{{variantCompareAtPrice}}`) — then the saving. */
+export declare const productCardPricing: (settings: ProductCardSettings) => Record<string, unknown>[];

package/dist/transforms/postPurchase/productCardRows.d.ts

@@ -0,0 +1,63 @@
+type Look = {
+    color?: 'subdued' | 'success';
+    fontSize?: 'small';
+};
+/** One styled run of copy (legacy `TextBlock size="small" subdued`, `Text appearance="success"`). */
+export declare const styledCopy: (text: string, look: Look) => {
+    content: {
+        content: {
+            marks: {
+                attrs: Look;
+                type: string;
+            }[];
+            text: string;
+            type: string;
+        }[];
+        type: string;
+    }[];
+    type: string;
+};
+/** Merchant copy over its English default: blank falls back, markup is stripped (the `localizedContent` policy). */
+export declare const merchantLabel: (value: string | undefined, fallback: string) => Record<string, string>;
+export type EarnedRow = {
+    /** Copy after the value in its own cell (legacy "on every Delivery", "(included)"). */
+    after?: unknown;
+    columns: string[];
+    /** The label cell's localized content map. */
+    label: Record<string, unknown>;
+    look?: Look;
+    spacing?: 'extraTight';
+    /** The single `{{token}}` the renderer resolves to '' when there is nothing to show. */
+    token: string;
+    variable: string;
+};
+/**
+ * One label/value line that EARNS its visibility from its value: the value cell is a token-only text that
+ * hosts the `content` mutators for `variable`, and the other cells bind to the same variable, so the whole
+ * line disappears while the renderer resolves the token to '' (before calculation, a one-time choice, a
+ * zero amount). The token sits alone in its cell because a content trigger reads the cell's whole copy.
+ * The enclosing block declares `variable`.
+ */
+export declare const earnedRow: ({ after, columns, label, look, spacing, token, variable }: EarnedRow) => {
+    spacing?: "extraTight" | undefined;
+    direction: string;
+    grid: {
+        columns: string[];
+        rows: string[];
+    };
+    sections: (Record<string, unknown> | {
+        content: unknown;
+        sectionType: string;
+        visibility: {
+            variable: string;
+            visibleWhen: boolean;
+        };
+    })[];
+    sectionType: string;
+};
+/** The block-level declarations for the rows' earned variables: hidden until the value arrives. */
+export declare const earnedVariables: (names: string[]) => {
+    defaultValue: boolean;
+    name: string;
+}[];
+export {};

package/dist/transforms/postPurchase/productCardSettings.d.ts

@@ -0,0 +1,103 @@
+import { z } from 'zod';
+/**
+ * The saved widget settings the product card's sections read. Each piece falls back to its schema
+ * defaults on its own, so one malformed setting degrades that piece and never drops the card (the preview
+ * converter's report-and-continue policy). The admin editor always writes all of them.
+ */
+export declare const ProductCardSettings: z.ZodCatch<z.ZodObject<{
+    discount: z.ZodCatch<z.ZodObject<{
+        amount: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>, z.ZodPipe<z.ZodUnknown, z.ZodTransform<number, unknown>>]>>;
+        shouldShowSavingText: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        type: z.ZodDefault<z.ZodEnum<{
+            none: "none";
+            fixed_amount: "fixed_amount";
+            percentage: "percentage";
+        }>>;
+    }, z.core.$strip>>;
+    language: z.ZodCatch<z.ZodObject<{
+        global: z.ZodCatch<z.ZodObject<{
+            payNow: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            subscriptionOption: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            shipping: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            quantity: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            declineAll: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            declineThisOffer: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            free: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            notAvailable: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            payNowUpgradeToSubscription: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            recurringShipping: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            recurringSubtotal: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            reviewsPlural: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            reviewsSingular: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            save: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            subtotal: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            taxes: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+            total: z.ZodCatch<z.ZodDefault<z.ZodString>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>> | z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodUnknown, z.ZodTransform<string, unknown>>]>>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    productOptions: z.ZodCatch<z.ZodObject<{
+        hideOutOfStockVariants: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        matchVariant: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        showDeclineAll: z.ZodOptional<z.ZodEnum<{
+            none: "none";
+            both: "both";
+            above: "above";
+            below: "below";
+        }>>;
+        showShipping: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        showSubtotal: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        showTaxes: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        showTotal: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        showVariantSelectors: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        variantSelectorDisplayMode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            single: "single";
+            separate: "separate";
+        }>>>;
+    }, z.core.$strip>>;
+    productType: z.ZodCatch<z.ZodDefault<z.ZodUnion<readonly [z.ZodEnum<{
+        "one-time": "one-time";
+        subscription: "subscription";
+        both: "both";
+    }>, z.ZodPipe<z.ZodLiteral<"">, z.ZodTransform<string, "">>]>>>;
+    quantityInputs: z.ZodCatch<z.ZodObject<{
+        defaultQuantity: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodNull, z.ZodTransform<number, null>>]>>;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        maxValue: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodNull, z.ZodTransform<number, null>>]>>;
+        minValue: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodUnknown, z.ZodTransform<number, unknown>>]>>;
+    }, z.core.$strip>>;
+    subImages: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>>;
+    subscription: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        discount: z.ZodObject<{
+            amount: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>, z.ZodPipe<z.ZodUnknown, z.ZodTransform<number, unknown>>]>>;
+            shouldShowSavingText: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            type: z.ZodDefault<z.ZodEnum<{
+                none: "none";
+                fixed_amount: "fixed_amount";
+                percentage: "percentage";
+            }>>;
+        }, z.core.$strip>;
+        shipping: z.ZodObject<{
+            amount: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>, z.ZodPipe<z.ZodUnknown, z.ZodTransform<number, unknown>>]>>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            recurringAmount: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>, z.ZodPipe<z.ZodUnknown, z.ZodTransform<number, unknown>>]>>;
+            shippingTitle: z.ZodDefault<z.ZodString>;
+            type: z.ZodDefault<z.ZodEnum<{
+                fixed_amount: "fixed_amount";
+                free: "free";
+            }>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>>>;
+    upgradeToSubscription: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        acceptButtonText: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        allow: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        emailRefundNotice: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        errorBannerText: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>>>;
+}, z.core.$strip>>;
+export type ProductCardSettings = z.infer<typeof ProductCardSettings>;
+/**
+ * Whether the widget can sell a subscription (`both`/`subscription`, or an upgrade-to-subscription
+ * widget). Only then do the subscription settings reach the card — `subscription` is always present with
+ * its defaults, so reading it on a one-time widget would act on settings the editor never showed.
+ */
+export declare const sellsSubscription: ({ productType, upgradeToSubscription }: ProductCardSettings) => boolean;

package/dist/transforms/postPurchase/types.d.ts

@@ -3,8 +3,8 @@ import { WidgetType } from '../../schema/widgets/checkout-and-beyond/constants';
  * A saved post-purchase widget as `/cab/sections` sees it: `type` plus its ordered `blocks`, no `version`
  * discriminator. This is the shape of EVERY `PostPurchaseSettings` (its `blocks` even default to three
  * blocks), so the guard below claims every saved post-purchase widget by design — the section tree is the
- * widget's presentation, and the non-block settings (`discount`, `products`, `integrations`, …) are read by
- * the post-purchase session/Decision contracts, not converted into sections.
+ * widget's presentation. The product card also reads the display settings outside `blocks` (REB-24817); the
+ * purchase terms (`discount` amounts, `products`, `integrations`, …) are read by the session/Decision contracts.
  */
 export type V1PostPurchaseSettings = {
     blocks: unknown[];

package/dist/transforms/productCard/earnedText.d.ts

@@ -0,0 +1,25 @@
+type ContentOperator = 'is_empty' | 'is_not_empty';
+/**
+ * The two `content` mutators that let a section EARN a boolean from its own interpolated copy: empty →
+ * false, non-empty → true. Both legs are emitted so a re-interpolation corrects the flag either way.
+ */
+export declare const earnedFrom: (variable: string) => {
+    effect: "set_false" | "set_true";
+    variable: string;
+    when: {
+        operator: ContentOperator;
+        type: string;
+    };
+}[];
+/** A visibility binding that shows the section while `variable` holds. */
+export declare const shownWhile: (variable: string) => {
+    variable: string;
+    visibleWhen: boolean;
+};
+/**
+ * A `text` section that hosts the mutators for `variable` and is itself bound to it, so it renders only
+ * when its interpolated copy is non-empty — a token the renderer resolves to '' hides the line and every
+ * sibling bound to the same variable (the offer card's variant title, the post-purchase cost rows).
+ */
+export declare const earnedText: (variable: string, content: unknown) => Record<string, unknown>;
+export {};

package/dist/transforms/productCard/priceText.d.ts

@@ -0,0 +1,2 @@
+/** The price line (variant price + on-sale compare-at strikethrough) as a `text` section. */
+export declare const priceText: () => Record<string, unknown>;

package/dist/transforms/productCard/quantitySection.d.ts

@@ -0,0 +1,28 @@
+export type QuantityBounds = {
+    errorMessages?: {
+        en: Record<string, string>;
+    };
+    inputType?: 'number' | 'select';
+    maxValue?: number | null;
+    minValue?: number | null;
+    /** The control's a11y label; omitted ⇒ the schema default. */
+    name?: string;
+};
+/**
+ * A `quantity` stepper from legacy bounds. Legacy quantity had no upper bound (checkout's
+ * `DefaultQuantityRule.MAX = null`) and allowed 0; the CAB schema pins `max` to [1, 100] and `min` to
+ * >= 1. Clamp instead of passing through so a legacy `maxValue: 250` (or a 0) degrades to a valid widget
+ * rather than throwing at parse. `min` is also capped at `max` — the schema has no cross-field refine, so a
+ * legacy `min > max` (e.g. {maxValue: 5, minValue: 8}) would parse but render a degenerate stepper (REB #766).
+ * Shared by the checkout offer card and the post-purchase product card.
+ */
+export declare const quantitySection: ({ errorMessages, inputType, maxValue, minValue, name }: QuantityBounds) => {
+    sectionType: string;
+    name?: string | undefined;
+    max: number;
+    min: number;
+    inputType?: "number" | "select" | undefined;
+    errorMessages?: {
+        en: Record<string, string>;
+    } | undefined;
+};

package/dist/transforms/productCard/subscriptionToggle.d.ts

@@ -0,0 +1,18 @@
+export type SubscriptionToggleLabels = {
+    /** The switch-to-one-time label override. */
+    oneTime?: string;
+    /** The ONE upsell label legacy had; it fills both upsell slots. */
+    upgrade?: string;
+};
+/**
+ * The in-card subscribe / one-time toggle: a `switchToSubscription` button with its four label slots
+ * (the same `SWITCH_LABELS` slot set as the line-item editor, including the `subscriptionOption`
+ * frequency template, so the frequency select localizes). Emitted when the merchant offers
+ * subscriptions (`productType` both/subscription); the renderer shows it per product by selling-plan
+ * availability. Legacy checkout-offers had ONE upsell label — `upgradeToSubscription`, used whatever
+ * the plan's discount (`useSellingPlanData.handleCheckboxLabel`) — so it fills BOTH upsell slots; the
+ * renderer's discount>0 slot pick then can't change which merchant text shows. Anything blank/absent
+ * falls back to the shared localized defaults. Shared by the checkout offer card and the post-purchase
+ * product card.
+ */
+export declare const subscriptionToggle: (productType: string | undefined, labels?: SubscriptionToggleLabels) => Record<string, unknown>[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rebuy/rebuy",
-    "version": "3.41.0",
+    "version": "3.43.0",
     "description": "Shared zod schemas, legacy-to-CAB widget transforms, and server orchestrators for Rebuy's Shopify consumers (rebuy-api, admin-nextjs, rebuy-shopify-extensions)",
     "license": "MIT",
     "author": "Rebuy, Inc.",