@zorgo/next 1.1.6 → 1.3.0

package/dist/components.d.ts

@@ -1,35 +1,24 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { z } from 'zod';
+import { ReactNode } from 'react';
 
 declare function CookieConsent(): react_jsx_runtime.JSX.Element | null;
 
-interface BreadcrumbItem {
-    label: string;
-    /** Omit (or leave undefined) to render the crumb as plain, non-clickable text. */
-    href?: string;
-}
-/** Per-slot Tailwind classes for the breadcrumb trail. */
-type BreadcrumbsItemClasses = Partial<{
-    baseContainer: string;
-    crumbLink: string;
-    crumbText: string;
-    separator: string;
-}>;
-/**
- * Structural / theme defaults. Merged with `itemClasses` via
- * {@link mergeBreadcrumbsItemClasses}.
- */
-declare const BREADCRUMBS_DEFAULT_ITEM_CLASSES: Required<BreadcrumbsItemClasses>;
-declare function mergeBreadcrumbsItemClasses(overrides?: BreadcrumbsItemClasses): {
-    baseContainer: string;
-    crumbLink: string;
-    crumbText: string;
-    separator: string;
-};
-/** Minimal, presentational breadcrumb trail (e.g. Menu -> Category -> Item). */
-declare function Breadcrumbs({ items, itemClasses, }: {
-    items: BreadcrumbItem[];
-    itemClasses?: BreadcrumbsItemClasses;
-}): react_jsx_runtime.JSX.Element;
+/** A row of `portion_schemes` — a franchise-owned, franchise-named menu entity. */
+declare const PortionSchemeSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    franchise_id: z.ZodNumber;
+    geometry: z.ZodEnum<{
+        radial: "radial";
+        grid: "grid";
+        linear: "linear";
+        count: "count";
+    }>;
+    name: z.ZodString;
+    min_divisions: z.ZodDefault<z.ZodNumber>;
+    max_divisions: z.ZodNumber;
+}, z.core.$strip>;
+type PortionScheme = z.infer<typeof PortionSchemeSchema>;
 
 type LocationStatus = "active" | "permanently_closed";
 interface Location {
@@ -72,16 +61,27 @@ interface ItemVariant {
     components?: Component[];
     base_item_id?: number;
     rules?: Rule[];
+    portion_scheme_id?: number | null;
+    portion_scheme?: PortionScheme | null;
     display_price?: number;
     active_promo_id?: number;
 }
+interface BaseItemImage {
+    image_id: number;
+    base_item_id: number;
+    alias: string;
+    raw_path?: string | null;
+    processed_path?: string | null;
+    sort_index?: number;
+    local_key?: string | null;
+}
 interface MenuItem {
     base_item_id: number;
     category_id: number;
     franchise_id: number;
     name: string;
     per_person?: boolean | null;
-    image_path?: string | null;
+    images?: BaseItemImage[];
     variants: ItemVariant[];
     rules: Rule[];
     description?: string | null;
@@ -119,6 +119,7 @@ interface Rule {
     min_selection: number;
     max_selection?: number;
     included_quantity: number;
+    is_portionable?: boolean;
     items?: RuleItem[];
     components?: RuleComponent[];
 }
@@ -139,6 +140,36 @@ interface RuleComponent {
     behavior?: ScalingBehavior;
     serving_weight?: number;
 }
+interface CustomizationOption {
+    key: string;
+    id: number;
+    type: "item" | "component";
+    name: string;
+    description?: string | null;
+    upcharge: number;
+    selected: boolean;
+    disabled: boolean;
+    toggle: () => void;
+    /** Section this option currently targets; null when editing the whole item. */
+    portion?: string | null;
+    /** Section indices this option already covers, for shading the picker. */
+    coveredSections?: number[];
+    /** Already applied to the whole item, so individual sections are moot. */
+    coveredWhole?: boolean;
+}
+interface CustomizationRule extends Rule {
+    rule_id: number;
+    max: number;
+    /** Weighted, not a row count: two halves of one topping count as 1. */
+    selectedCount: number;
+    satisfied: boolean;
+    /** "Choose 1. Select up to 5. 1 included" — the rule's limits in words. */
+    subtext: string;
+    message: () => string | null;
+    options: CustomizationOption[];
+    /** This rule can be applied per-section under the item's scheme. */
+    portionable?: boolean;
+}
 interface OrderItem {
     item_id: number;
     base_item_id: number;
@@ -155,6 +186,7 @@ interface OrderItem {
     components?: OrderComponent[];
     selections?: RuleSelection[];
     comments?: string;
+    portion_scheme?: PortionScheme | null;
     status?: "removed" | "modified";
     applied_promo_id?: number;
     discount_amount?: number;
@@ -163,6 +195,7 @@ interface OrderComponent extends Component {
     quantity_servings: number;
     upcharge?: number;
     rule_id?: number;
+    portion?: string | null;
 }
 interface RuleSelection {
     rule_id: number;
@@ -177,6 +210,7 @@ interface Selection {
     serving_price?: number;
     name: string;
     status?: "removed" | "modified" | "added";
+    portion?: string | null;
     component_type_id?: number;
     serving_weight?: number;
     measurement_type?: "weight" | "count";
@@ -261,8 +295,9 @@ declare function AccordionMenu({ items, categories, itemClasses, }: {
     itemClasses?: AccordionMenuItemClasses;
 }): react_jsx_runtime.JSX.Element;
 
+declare function money(cents: number): string;
 /** Per-slot Tailwind classes for the item customization form. */
-type ItemCustomizationFormItemClasses = Partial<{
+type ClientItemFormItemClasses = Partial<{
     baseContainer: string;
     title: string;
     description: string;
@@ -280,6 +315,7 @@ type ItemCustomizationFormItemClasses = Partial<{
     incrementButton: string;
     servingsValue: string;
     ruleError: string;
+    portionHint: string;
     commentsTextarea: string;
     quantityRow: string;
     submitButton: string;
@@ -287,10 +323,10 @@ type ItemCustomizationFormItemClasses = Partial<{
 }>;
 /**
  * Structural / theme defaults. Merged with `itemClasses` via
- * {@link mergeItemCustomizationFormItemClasses}.
+ * {@link mergeClientItemFormItemClasses}.
  */
-declare const ITEM_CUSTOMIZATION_FORM_DEFAULT_ITEM_CLASSES: Required<ItemCustomizationFormItemClasses>;
-declare function mergeItemCustomizationFormItemClasses(overrides?: ItemCustomizationFormItemClasses): {
+declare const CLIENT_ITEM_FORM_DEFAULT_ITEM_CLASSES: Required<ClientItemFormItemClasses>;
+declare function mergeClientItemFormItemClasses(overrides?: ClientItemFormItemClasses): {
     baseContainer: string;
     title: string;
     description: string;
@@ -308,19 +344,174 @@ declare function mergeItemCustomizationFormItemClasses(overrides?: ItemCustomiza
     incrementButton: string;
     servingsValue: string;
     ruleError: string;
+    portionHint: string;
     commentsTextarea: string;
     quantityRow: string;
     submitButton: string;
     notFound: string;
 };
-declare function ItemCustomizationForm({ baseItemId, seed, editIndex, itemClasses, onSubmitSuccess, }: {
+/**
+ * Fully-resolved classes. Every section takes this (not the partial overrides)
+ * so a subcomponent used on its own and one composed into ClientItemForm merge
+ * the defaults exactly once.
+ */
+type ClientItemFormSlots = ReturnType<typeof mergeClientItemFormItemClasses>;
+declare const CLIENT_ITEM_FORM_SLOTS: ClientItemFormSlots;
+
+/**
+ * The stock item form. Every section here is exported on its own — a site that
+ * wants its own layout composes these instead of forking the file.
+ */
+declare function ClientItemForm({ baseItemId, seed, editIndex, itemClasses, onSubmitSuccess, }: {
     baseItemId: number;
     seed?: OrderItem;
     editIndex?: number;
-    itemClasses?: ItemCustomizationFormItemClasses;
+    itemClasses?: ClientItemFormItemClasses;
+    /** Defaults to navigating back to /menu. */
     onSubmitSuccess?: () => void;
 }): react_jsx_runtime.JSX.Element;
 
+declare function OptionButton({ label, subtext, selected, onClick, slots, }: {
+    label: string;
+    subtext?: string;
+    selected: boolean;
+    onClick: () => void;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Size / variant picker. Renders nothing when there is only one variant. */
+declare function VariantSection({ variants, variant, setVariant, title, slots, }: {
+    variants: ItemVariant[];
+    variant: ItemVariant;
+    setVariant: (variant: ItemVariant) => void;
+    title?: string;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * What the variant already includes, each togglable on or off — for the whole
+ * item, or for whichever section is being edited ("no cheese on the left").
+ */
+declare function ComponentsSection({ variant, draft, setComponentServings, activeSection, divisions, scheme, title, slots, }: {
+    variant: ItemVariant;
+    draft?: OrderItem | null;
+    setComponentServings: (componentId: number, servings: number, portion?: string | null) => void;
+    /** Section being edited; null = the whole item. */
+    activeSection?: number | null;
+    divisions?: number;
+    /** Names the section a removal applies to. */
+    scheme?: PortionScheme | null;
+    title?: string;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element | null;
+
+/** The item's cut selector, wrapped in a titled form section. */
+declare function PortionSection({ scheme, divisions, activeSection, setActiveSection, setDivisions, slots, }: {
+    scheme: PortionScheme;
+    divisions: number;
+    activeSection: number | null;
+    setActiveSection: (section: number | null) => void;
+    setDivisions: (divisions: number) => void;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** One rule group (toppings, sides, …) and its unmet-requirement message. */
+declare function RuleSection({ rule, activeSection, divisions, scheme, placeOption, slots, }: {
+    rule: CustomizationRule;
+    /** Section currently being edited, so a whole-item-only rule can say so. */
+    activeSection?: number | null;
+    /** How the item is currently cut, for the portion this section writes. */
+    divisions?: number;
+    /** Names the section an option sits on; omit when the item can't be cut. */
+    scheme?: PortionScheme | null;
+    /** Defaults to the option's own whole-item toggle. */
+    placeOption?: (ruleId: number, baseKey: string, portion: string | null, max?: number) => void;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Free-text special instructions. */
+declare function CommentsSection({ comments, setComments, title, placeholder, rows, slots, }: {
+    comments: string;
+    setComments: (comments: string) => void;
+    title?: string;
+    placeholder?: string;
+    rows?: number;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Line quantity stepper. The hook already floors quantity at 1. */
+declare function QuantitySection({ quantity, setQuantity, title, slots, }: {
+    quantity: number;
+    setQuantity: (next: number | ((current: number) => number)) => void;
+    title?: string;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Add-to-cart button: names the first unmet rule, otherwise the price. */
+declare function SubmitButton({ canSubmit, unmetRule, price, salePrice, isEditMode, onSubmit, slots, }: {
+    canSubmit: boolean;
+    unmetRule?: CustomizationRule | null;
+    price: number;
+    salePrice?: number | null;
+    isEditMode?: boolean;
+    onSubmit: () => void;
+    slots?: ClientItemFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+interface BreadcrumbItem {
+    label: string;
+    /** Omit (or leave undefined) to render the crumb as plain, non-clickable text. */
+    href?: string;
+}
+/** Per-slot Tailwind classes for the breadcrumb trail. */
+type BreadcrumbsItemClasses = Partial<{
+    baseContainer: string;
+    crumbLink: string;
+    crumbText: string;
+    separator: string;
+}>;
+/**
+ * Structural / theme defaults. Merged with `itemClasses` via
+ * {@link mergeBreadcrumbsItemClasses}.
+ */
+declare const BREADCRUMBS_DEFAULT_ITEM_CLASSES: Required<BreadcrumbsItemClasses>;
+declare function mergeBreadcrumbsItemClasses(overrides?: BreadcrumbsItemClasses): {
+    baseContainer: string;
+    crumbLink: string;
+    crumbText: string;
+    separator: string;
+};
+/** Minimal, presentational breadcrumb trail (e.g. Menu -> Category -> Item). */
+declare function Breadcrumbs({ items, itemClasses, }: {
+    items: BreadcrumbItem[];
+    itemClasses?: BreadcrumbsItemClasses;
+}): react_jsx_runtime.JSX.Element;
+
+/**
+ * Section pickers. One per geometry, all with the same props and all dumb: they
+ * draw `divisions` sections, highlight `active`, shade `covered`, and call
+ * `onSelect`. Every indexing rule lives in the scheme and in portionUtils —
+ * a renderer never decides what section 2 means. See docs/portions.md §4.
+ */
+interface PortionShapeProps {
+    divisions: number;
+    active: number | null;
+    /** Sections already carrying the selection being edited, shaded not selected. */
+    covered?: number[];
+    onSelect: (index: number | null) => void;
+}
+interface PortionPickerProps extends PortionShapeProps {
+    scheme: PortionScheme;
+    onDivisionsChange: (divisions: number) => void;
+    className?: string;
+}
+/**
+ * The one portion control: a cut selector plus the geometry's shape. Adding a
+ * geometry means adding a `portion_geometry` enum value and a case here, in the
+ * same change — which is exactly why geometry is a closed enum.
+ */
+declare function PortionPicker({ scheme, divisions, active, covered, onSelect, onDivisionsChange, className, }: PortionPickerProps): react_jsx_runtime.JSX.Element;
+
 /** Per-slot Tailwind classes for the find-location layout. */
 type FindLocationItemClasses = Partial<{
     baseContainer: string;
@@ -423,58 +614,20 @@ type CheckoutFormItemClasses = Partial<{
  * {@link mergeCheckoutFormItemClasses}.
  */
 declare const CHECKOUT_FORM_DEFAULT_ITEM_CLASSES: Required<CheckoutFormItemClasses>;
-declare function mergeCheckoutFormItemClasses(overrides?: CheckoutFormItemClasses): {
-    shell: string;
-    shellInner: string;
-    pageTitle: string;
-    primaryButton: string;
-    secondaryButton: string;
-    incrementButton: string;
-    surface: string;
-    fieldInput: string;
-    fieldContainer: string;
-    fieldLabel: string;
-    fieldError: string;
-    statusPanel: string;
-    statusTitle: string;
-    statusMessage: string;
-    statusMessageError: string;
-    statusActions: string;
-    stepSection: string;
-    sectionTitle: string;
-    cartList: string;
-    totals: string;
-    totalsRow: string;
-    totalsDivider: string;
-    totalsTotalRow: string;
-    form: string;
-    formActions: string;
-    submitError: string;
-    paymentSurface: string;
-    steps: string;
-    stepBadge: string;
-    stepBadgeActive: string;
-    stepBadgeInactive: string;
-    stepLabel: string;
-    stepLabelActive: string;
-    stepLabelInactive: string;
-    stepDivider: string;
-    stepDividerActive: string;
-    stepDividerInactive: string;
-    cartLine: string;
-    cartLineName: string;
-    cartLineSelection: string;
-    cartLinePrice: string;
-    cartLineControls: string;
-    cartLineQuantity: string;
-    promoApplied: string;
-    promoAppliedLabel: string;
-    promoRow: string;
-    promoInput: string;
-    promoError: string;
-};
+declare function mergeCheckoutFormItemClasses(overrides?: CheckoutFormItemClasses): Required<CheckoutFormItemClasses>;
+/**
+ * Fully-resolved classes. Every subcomponent takes this (not the partial
+ * overrides) so a piece used on its own and one composed into CheckoutForm
+ * merge the defaults exactly once.
+ */
+type CheckoutFormSlots = Required<CheckoutFormItemClasses>;
+declare const CHECKOUT_FORM_SLOTS: CheckoutFormSlots;
+
 /**
- * Full checkout flow: cart + customer details, then Stripe payment.
+ * The stock checkout flow: cart + customer details, then Stripe payment.
+ * Every piece here is exported on its own — a site that wants its own layout
+ * composes these instead of forking the file.
+ *
  * The order + payment intent are created on details submit (not on mount),
  * so the collected customer and any applied promo are baked into the charge.
  */
@@ -485,4 +638,79 @@ declare function CheckoutForm({ itemClasses, homeHref, menuHref, checkoutHref, }
     checkoutHref?: string;
 }): react_jsx_runtime.JSX.Element;
 
-export { ACCORDION_MENU_DEFAULT_ITEM_CLASSES, AccordionMenu, type AccordionMenuItemClasses, BREADCRUMBS_DEFAULT_ITEM_CLASSES, type BreadcrumbItem, Breadcrumbs, type BreadcrumbsItemClasses, CHECKOUT_FORM_DEFAULT_ITEM_CLASSES, CheckoutForm, type CheckoutFormItemClasses, CookieConsent, FIND_LOCATION_DEFAULT_ITEM_CLASSES, FindLocation, type FindLocationItemClasses, GRID_MENU_DEFAULT_ITEM_CLASSES, GridMenu, type GridMenuItemClasses, ITEM_CUSTOMIZATION_FORM_DEFAULT_ITEM_CLASSES, ItemCustomizationForm, type ItemCustomizationFormItemClasses, mergeAccordionMenuItemClasses, mergeBreadcrumbsItemClasses, mergeCheckoutFormItemClasses, mergeFindLocationItemClasses, mergeGridMenuItemClasses, mergeItemCustomizationFormItemClasses };
+/** Page wrapper + title every checkout state renders inside. */
+declare function CheckoutShell({ children, title, slots, }: {
+    children: ReactNode;
+    title?: ReactNode;
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Numbered progress header shown above each step. */
+declare function CheckoutSteps({ current, labels, slots, }: {
+    current: number;
+    labels?: string[];
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Terminal states: empty cart, payment result, errors, location prompt. */
+declare function StatusPanel({ title, message, action, tone, slots, }: {
+    title: string;
+    message?: string;
+    action: ReactNode;
+    tone?: "default" | "error";
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** One cart line: selections, price, edit + quantity controls. */
+declare function OrderLine({ item, index, onRemove, slots, }: {
+    item: OrderItem;
+    index: number;
+    onRemove: () => void;
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+/** Every line in the cart. */
+declare function OrderLines({ slots, }: {
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Subtotal, discount, tax, service fee, total. */
+declare function OrderTotals({ slots, }: {
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Promo code entry; swaps to the applied-promo row once one sticks. */
+declare function PromoCode({ placeholder, slots, }: {
+    placeholder?: string;
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/**
+ * Name / phone / email inputs, seeded from the stored customer. Must be
+ * rendered inside a `DynamicFormShell`.
+ */
+declare function ContactFields({ slots, }: {
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/**
+ * Terms + marketing checkboxes. Must be rendered inside a `DynamicFormShell`;
+ * the submit handler reads `termsAccepted` / `marketingConsent`.
+ */
+declare function ConsentFields({ termsLabel, marketingLabel, slots, }: {
+    termsLabel?: React.ReactNode;
+    marketingLabel?: React.ReactNode;
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Step 1: review the cart, apply a promo, hand over contact details. */
+declare function DetailsStep({ slots, }: {
+    slots?: CheckoutFormSlots;
+}): react_jsx_runtime.JSX.Element;
+
+/** Step 2: the Stripe payment element. Must be rendered inside `<Elements>`. */
+declare function PaymentStep({ slots, checkoutHref, }: {
+    slots?: CheckoutFormSlots;
+    checkoutHref?: string;
+}): react_jsx_runtime.JSX.Element;
+
+export { ACCORDION_MENU_DEFAULT_ITEM_CLASSES, AccordionMenu, type AccordionMenuItemClasses, BREADCRUMBS_DEFAULT_ITEM_CLASSES, type BreadcrumbItem, Breadcrumbs, type BreadcrumbsItemClasses, CHECKOUT_FORM_DEFAULT_ITEM_CLASSES, CHECKOUT_FORM_SLOTS, CLIENT_ITEM_FORM_DEFAULT_ITEM_CLASSES, CLIENT_ITEM_FORM_SLOTS, CheckoutForm, type CheckoutFormItemClasses, type CheckoutFormSlots, CheckoutShell, CheckoutSteps, ClientItemForm, type ClientItemFormItemClasses, type ClientItemFormSlots, CommentsSection, ComponentsSection, ConsentFields, ContactFields, CookieConsent, DetailsStep, FIND_LOCATION_DEFAULT_ITEM_CLASSES, FindLocation, type FindLocationItemClasses, GRID_MENU_DEFAULT_ITEM_CLASSES, GridMenu, type GridMenuItemClasses, CLIENT_ITEM_FORM_DEFAULT_ITEM_CLASSES as ITEM_CUSTOMIZATION_FORM_DEFAULT_ITEM_CLASSES, ClientItemForm as ItemCustomizationClient, ClientItemForm as ItemCustomizationForm, type ClientItemFormItemClasses as ItemCustomizationFormItemClasses, OptionButton, OrderLine, OrderLines, OrderTotals, PaymentStep, PortionPicker, type PortionPickerProps, PortionSection, type PortionShapeProps, PromoCode, QuantitySection, RuleSection, StatusPanel, SubmitButton, VariantSection, mergeAccordionMenuItemClasses, mergeBreadcrumbsItemClasses, mergeCheckoutFormItemClasses, mergeClientItemFormItemClasses, mergeFindLocationItemClasses, mergeGridMenuItemClasses, mergeClientItemFormItemClasses as mergeItemCustomizationFormItemClasses, money };