@rebuy/rebuy 3.35.0 → 3.37.0

package/dist/server/preparePostPurchaseCollectionView.d.ts

@@ -0,0 +1,452 @@
+import type { z } from 'zod';
+import { PostPurchaseExcludedProductIds } from '../schema/postPurchaseProductCollectionView';
+import type { PostPurchaseVariantDefaultContext } from '../schema/postPurchaseVariantDefaultContext';
+import type { Reporter } from '../server/shared';
+/** The collection binds no exact variant, so a `variantId` it would silently drop is refused instead. */
+declare const CollectionChoice: z.ZodObject<{
+    productId: z.ZodNumber;
+    choice: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"one-time">;
+    }, z.core.$strict>, z.ZodObject<{
+        mode: z.ZodLiteral<"subscription">;
+        sellingPlanId: z.ZodNumber;
+    }, z.core.$strict>], "mode">>;
+}, z.core.$strict>;
+/**
+ * The opt-in collection owns cardinality; the existing member projector owns all purchase rules. It resolves
+ * no variant: a multi-variant plain member stays `unsupported` here, and `prepareMember` (the member and
+ * quantity views) is the path that takes an exact `variantId` or resolves defaults for it.
+ */
+export declare const preparePostPurchaseCollectionView: (widgetId: number, settings: unknown, response: unknown, report?: Reporter, requested?: z.input<typeof CollectionChoice>, excludedProductIds?: PostPurchaseExcludedProductIds, defaults?: PostPurchaseVariantDefaultContext) => {
+    members: {
+        reportingProduct?: {
+            id: number;
+            title: string;
+        } | undefined;
+        productId: number;
+        productIndex: number;
+        view: {
+            preparation: {
+                labels: {
+                    declineAll: string;
+                    free: string;
+                    payNow: string;
+                    quantity: string;
+                    recurringShipping: string;
+                    recurringSubtotal: string;
+                    save: string;
+                    shipping: string;
+                    subtotal: string;
+                    taxes: string;
+                    total: string;
+                };
+                product: {
+                    title: string;
+                    id: number;
+                    variant: {
+                        title: string;
+                        compareAtPrice: string | null;
+                        id: number;
+                        price: string;
+                    };
+                    image?: {
+                        src: string;
+                    } | null | undefined;
+                    description?: string | null | undefined;
+                };
+                selection: {
+                    productId: number;
+                    quantity: number;
+                    variantId: number;
+                    sellingPlanId?: number | undefined;
+                };
+                status: "prepared";
+                terms: {
+                    discount: {
+                        amount: number;
+                        title: string;
+                        type: "none" | "fixed_amount" | "percentage";
+                    };
+                    shipping: {
+                        amount: number;
+                        title: string;
+                        type: "fixed_amount" | "free";
+                    };
+                    subscription?: {
+                        initialShippingPrice: number;
+                        intervalLabel: string;
+                        name: string;
+                        recurringShippingPrice: number;
+                        shippingOption: {
+                            presentmentTitle: string;
+                            title: string;
+                        };
+                        adjustment?: {
+                            amount: number;
+                            type: "price" | "fixed_amount" | "percentage";
+                        } | undefined;
+                    } | undefined;
+                };
+                display: {
+                    discountedFrom: "price" | "compare_at_price";
+                    language: {
+                        description: string;
+                        descriptionEnabled: boolean;
+                    };
+                    primaryImage: {
+                        description: string;
+                        source: string;
+                    };
+                    productOptions: {
+                        showShipping: boolean;
+                        showSubtotal: boolean;
+                        showTaxes: boolean;
+                        showTotal: boolean;
+                        showVariantSelectors: boolean;
+                        showDeclineAll?: "none" | "both" | "above" | "below" | undefined;
+                    };
+                    responseDescription: string;
+                    reviews: {
+                        color: string;
+                        rating: number;
+                        reviewCount: number;
+                        reviewsPlural: string;
+                        reviewsSingular: string;
+                        size: "small" | "large" | "medium";
+                        strokeColor: string;
+                        strokeWidth: number;
+                    } | null;
+                    shouldShowSavingText: boolean;
+                    description: string | null;
+                    descriptionDocument?: {
+                        attrs: {
+                            blockSpacing?: "none" | "base" | "extraTight" | "tight" | "loose" | "extraLoose" | undefined;
+                        };
+                        content: never[] | {
+                            attrs: {
+                                textAlign?: "start" | "center" | "end" | undefined;
+                            };
+                            content: never[] | {
+                                text: string;
+                                type: "text";
+                                marks?: never[] | ({
+                                    type: "bold";
+                                } | {
+                                    type: "italic";
+                                } | {
+                                    attrs: {
+                                        class: string | null;
+                                        href: string;
+                                        rel: string;
+                                        target: string;
+                                    };
+                                    type: "link";
+                                } | {
+                                    type: "strike";
+                                } | {
+                                    attrs: {
+                                        color: "success" | "warning" | "critical" | "base" | "decorative" | "subdued" | "accent";
+                                        fontSize: "small" | "base" | "large" | "medium" | "extraSmall" | "extraLarge" | "heading";
+                                    };
+                                    type: "textStyle";
+                                })[] | undefined;
+                            }[];
+                            type: "paragraph";
+                        }[];
+                        type: "doc";
+                    } | undefined;
+                    gallery?: {
+                        images: {
+                            description: string;
+                            id: number;
+                            source: string;
+                            thumbnail: string;
+                        }[];
+                        selectedImageId?: number | undefined;
+                    } | undefined;
+                };
+            };
+            sections: {
+                alignment: {
+                    horizontal: "start" | "center" | "end";
+                    vertical: "top" | "middle" | "bottom";
+                };
+                border: {
+                    radius: "small" | "none" | "base" | "large" | "fullyRounded";
+                    style: "none" | "base" | "dotted" | "dashed";
+                    width: "base" | "medium" | "thick";
+                };
+                direction: "columns" | "rows" | "grid";
+                padding: "none" | "base" | "extraTight" | "tight" | "loose" | "extraLoose";
+                sectionId: string;
+                sections: never[] | import("..").CABSection[];
+                sectionType: "layout";
+                spacing: "none" | "base" | "extraTight" | "tight" | "loose" | "extraLoose";
+                width: number;
+                editorMode: "checkoutExtension" | "postPurchaseOffer" | "thankYouPage" | "orderStatusPage" | "ordersIndexPage" | "customerProfilePage";
+                previewMode: boolean;
+                storeId: number | null;
+                targetArea: {
+                    icon: string;
+                    label: string;
+                    width: string;
+                    fill?: boolean | undefined;
+                    flip?: "vertical" | "horizontal" | "both" | undefined;
+                } | null;
+                tracking: {
+                    enableAttribution: boolean;
+                    enableSource: boolean;
+                    enableWidget: boolean;
+                };
+                type: "product" | "bundle_builder" | "cart" | "cart_subscription" | "dynamic_bundle" | "gift_with_purchase" | "placeholder" | "pre_purchase" | "product_addon" | "product_upsell" | "recharge_checkout" | "recharge_customer_portal" | "recharge_post_purchase" | "shopify_checkout" | "shopify_checkout_extension" | "shopify_post_purchase" | "shopify_post_purchase_extension" | "switch_to_subscription" | "ui_extension_ad" | "ui_extension_button" | "ui_extension_content_block" | "ui_extension_line_item_editor" | "ui_extension_progress_bar";
+                uiLabels: {
+                    currentPage: Record<string, string>;
+                    guest: Record<string, string>;
+                    loadingOptions: Record<string, string>;
+                    nextPage: Record<string, string>;
+                    offerCarousel: Record<string, string>;
+                    offerDialog: Record<string, string>;
+                    page: Record<string, string>;
+                    previousPage: Record<string, string>;
+                    selected: Record<string, string>;
+                    subscriptionOptions: Record<string, string>;
+                    updating: Record<string, string>;
+                };
+                version: 2;
+                widgetId: number | null;
+                buttonField?: "declineAllOffers" | "declineOffer" | "removeFromOrder" | "undoAddToOrder" | "activePage" | "addedToCart" | "addingToCart" | "addToCart" | "buttonLabel" | "destinationUrl" | "inactivePage" | "overlayContent" | "payNow" | "progressReached" | "progressRemaining" | "redirectToCheckout" | "showVariant" | "showVariants" | "soldOut" | "subscriptionOption" | "switchToOneTimePurchase" | "switchToSubscriptionNoDiscount" | "switchToSubscriptionWithDiscount" | undefined;
+                frame?: "callout" | "offer-content" | undefined;
+                grid?: {
+                    columns: (string | number)[];
+                    rows: (string | number)[];
+                } | undefined;
+                name?: string | undefined;
+                viewUrl?: string | undefined;
+                wrapping?: {
+                    breakAt: number;
+                    maxPerLine: number;
+                } | undefined;
+                mutators?: {
+                    effect: "set_false" | "set_true" | "toggle";
+                    variable: string;
+                    when: {
+                        operator: "is_empty" | "is_not_empty";
+                        type: "content";
+                    } | {
+                        operator: "equals" | "greater_than" | "less_than";
+                        type: "result_count";
+                        value: number;
+                    } | {
+                        operator: "contains" | "does_not_contain";
+                        type: "result_tag";
+                        value: string;
+                    } | {
+                        event: "item_added" | "quantity_changed" | "variant_selected";
+                        type: "event";
+                    };
+                }[] | undefined;
+                variables?: ({
+                    defaultValue: string;
+                    name: string;
+                    type: "text";
+                    seed?: undefined;
+                } | {
+                    defaultValue: number;
+                    name: string;
+                    type: "number";
+                    seed?: undefined;
+                } | {
+                    defaultValue: boolean;
+                    name: string;
+                    type: "boolean";
+                    seed?: {
+                        dataSourceId: number | null;
+                        ruleset: {
+                            exitIfMatched: boolean;
+                            logic: {
+                                rules: {
+                                    operator: "equals" | "greater_than" | "less_than" | "contains" | "does_not_contain" | "after" | "anything" | "before" | "contains_any" | "does_not_contain_any" | "does_not_equal";
+                                    products: never[] | unknown[];
+                                    type: "product" | "date" | "cart" | "cart_count" | "cart_item_count" | "cart_line_count" | "cart_subtotal" | "collection" | "customer" | "customer_order_count" | "customer_tag" | "customer_total_spent" | "product_tag" | "product_title" | "product_type" | "product_vendor";
+                                    value: string;
+                                }[];
+                            }[];
+                            output: {
+                                key: string;
+                                type: "data_json";
+                                value: string;
+                            }[];
+                        }[];
+                    } | undefined;
+                })[] | undefined;
+                visibility?: {
+                    variable: string;
+                    visibleWhen: boolean;
+                } | undefined;
+                experiment?: {
+                    elementId: number;
+                    experimentId: number;
+                    experimentType: string;
+                    selectedId: number;
+                } | undefined;
+            };
+            groupCatalog?: {
+                memberProductId: number;
+                options: {
+                    productId: number;
+                    title: string;
+                    variantCatalog: {
+                        displayMode: "single" | "separate";
+                        options: {
+                            name: string;
+                            values: string[];
+                            id: number;
+                            position: number;
+                        }[];
+                        productId: number;
+                        showSelectors: boolean;
+                        variants: {
+                            available: boolean;
+                            id: number;
+                            title: string;
+                            option1?: string | undefined;
+                            option2?: string | null | undefined;
+                            option3?: string | null | undefined;
+                            imageId?: number | null | undefined;
+                        }[];
+                    };
+                }[];
+            } | undefined;
+            initialVariant?: {
+                variantId: number;
+            } | undefined;
+            planCatalog?: {
+                plans: {
+                    id: number;
+                    intervalLabel: string;
+                    name: string;
+                    adjustment?: {
+                        amount: number;
+                        type: "price" | "fixed_amount" | "percentage";
+                    } | undefined;
+                    intervalFrequency?: string | undefined;
+                }[];
+                productId: number;
+                requiresSellingPlan: boolean;
+                variantId: number;
+            } | null | undefined;
+            purchaseOptions?: {
+                defaultChoice: {
+                    mode: "one-time";
+                } | {
+                    mode: "subscription";
+                    sellingPlanId: number;
+                };
+                modes: ("one-time" | "subscription")[];
+                selector: "radio" | "dropdown";
+            } | undefined;
+            variantCatalog?: {
+                displayMode: "single" | "separate";
+                options: {
+                    name: string;
+                    values: string[];
+                    id: number;
+                    position: number;
+                }[];
+                productId: number;
+                showSelectors: boolean;
+                variants: {
+                    available: boolean;
+                    id: number;
+                    title: string;
+                    option1?: string | undefined;
+                    option2?: string | null | undefined;
+                    option3?: string | null | undefined;
+                    imageId?: number | null | undefined;
+                }[];
+            } | undefined;
+        } | {
+            preparation: {
+                reason: string;
+                status: "unsupported";
+            };
+            sections: null;
+            groupCatalog?: {
+                memberProductId: number;
+                options: {
+                    productId: number;
+                    title: string;
+                    variantCatalog: {
+                        displayMode: "single" | "separate";
+                        options: {
+                            name: string;
+                            values: string[];
+                            id: number;
+                            position: number;
+                        }[];
+                        productId: number;
+                        showSelectors: boolean;
+                        variants: {
+                            available: boolean;
+                            id: number;
+                            title: string;
+                            option1?: string | undefined;
+                            option2?: string | null | undefined;
+                            option3?: string | null | undefined;
+                            imageId?: number | null | undefined;
+                        }[];
+                    };
+                }[];
+            } | undefined;
+            initialVariant?: {
+                variantId: number;
+            } | undefined;
+            planCatalog?: {
+                plans: {
+                    id: number;
+                    intervalLabel: string;
+                    name: string;
+                    adjustment?: {
+                        amount: number;
+                        type: "price" | "fixed_amount" | "percentage";
+                    } | undefined;
+                    intervalFrequency?: string | undefined;
+                }[];
+                productId: number;
+                requiresSellingPlan: boolean;
+                variantId: number;
+            } | null | undefined;
+            purchaseOptions?: {
+                defaultChoice: {
+                    mode: "one-time";
+                } | {
+                    mode: "subscription";
+                    sellingPlanId: number;
+                };
+                modes: ("one-time" | "subscription")[];
+                selector: "radio" | "dropdown";
+            } | undefined;
+            variantCatalog?: {
+                displayMode: "single" | "separate";
+                options: {
+                    name: string;
+                    values: string[];
+                    id: number;
+                    position: number;
+                }[];
+                productId: number;
+                showSelectors: boolean;
+                variants: {
+                    available: boolean;
+                    id: number;
+                    title: string;
+                    option1?: string | undefined;
+                    option2?: string | null | undefined;
+                    option3?: string | null | undefined;
+                    imageId?: number | null | undefined;
+                }[];
+            } | undefined;
+        };
+    }[];
+};
+export {};