@zorgo/next 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,305 @@
+export * from '@zorgo/universal/hooks/hooks';
+export * from '@zorgo/universal/components/Form';
+
+type LocationStatus = "active" | "permanently_closed";
+interface Location {
+    location_id: number;
+    franchise_id: number;
+    name: string;
+    address?: string;
+    force_close?: boolean;
+    status?: LocationStatus | null;
+    stripe_account_id?: string;
+    stripe_location_id?: string;
+    monday_open?: string;
+    monday_close?: string;
+    tuesday_open?: string;
+    tuesday_close?: string;
+    wednesday_open?: string;
+    wednesday_close?: string;
+    thursday_open?: string;
+    thursday_close?: string;
+    friday_open?: string;
+    friday_close?: string;
+    saturday_open?: string;
+    saturday_close?: string;
+    sunday_open?: string;
+    sunday_close?: string;
+}
+/** Single source for ordering channels (website, kiosk, POS). Values match DB strings. */
+declare enum Platforms {
+    Website = "website",
+    Kiosk = "kiosk",
+    Pos = "pos",
+    KitchenDisplay = "kitchen_display"
+}
+interface Category {
+    category_id: number;
+    name: string;
+    is_catering?: boolean;
+    rules: Rule[];
+    active_promo_id?: number;
+}
+interface ItemVariant {
+    item_id: number;
+    name: string;
+    price: number;
+    components?: Component[];
+    base_item_id?: number;
+    rules?: Rule[];
+    display_price?: number;
+    active_promo_id?: number;
+}
+interface MenuItem {
+    base_item_id: number;
+    category_id: number;
+    franchise_id: number;
+    name: string;
+    per_person?: boolean | null;
+    image_path?: string | null;
+    variants: ItemVariant[];
+    rules: Rule[];
+    description?: string | null;
+    active_promo_id?: number;
+    is_catering?: boolean;
+}
+interface ScalingBehavior {
+    headcount_threshold: number;
+    starting_amount: number;
+    step_interval: number;
+    step_size: number;
+    maximum: number | null;
+}
+interface Component {
+    id: number;
+    servings_per_item?: number;
+    is_base?: boolean;
+    price_per_serving?: number;
+    franchise_id?: number;
+    component_type_id: number;
+    serving_weight?: number;
+    name: string;
+    item_id?: number;
+    prep_ahead?: boolean;
+    measurement_type?: "weight" | "count";
+    display_unit?: string;
+    behavior?: ScalingBehavior;
+}
+interface Rule {
+    rule_id?: number;
+    item_id?: number;
+    base_item_id?: number;
+    category_id?: number;
+    group_name: string;
+    min_selection: number;
+    max_selection?: number;
+    included_quantity: number;
+    items?: RuleItem[];
+    components?: RuleComponent[];
+}
+interface RuleItem {
+    item_id: number;
+    name: string;
+    quantity: number;
+    upcharge_price: number;
+    description?: string | null;
+    behavior?: ScalingBehavior;
+}
+interface RuleComponent {
+    component_id: number;
+    name: string;
+    quantity: number;
+    upcharge_price: number;
+    description?: string | null;
+    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;
+}
+interface CustomizationRule extends Rule {
+    rule_id: number;
+    max: number;
+    selectedCount: number;
+    satisfied: boolean;
+    message: () => string | null;
+    options: CustomizationOption[];
+}
+interface OrderItem {
+    item_id: number;
+    base_item_id: number;
+    name: string;
+    quantity: number;
+    price: number;
+    display_price?: number;
+    order_item_id?: number;
+    category_id: number;
+    category_name?: string;
+    is_catering?: boolean;
+    /** When true, each unit counts toward catering headcount minimums (menu `per_person`). */
+    per_person?: boolean | null;
+    components?: OrderComponent[];
+    selections?: RuleSelection[];
+    comments?: string;
+    status?: "removed" | "modified";
+    applied_promo_id?: number;
+    discount_amount?: number;
+}
+interface OrderComponent extends Component {
+    quantity_servings: number;
+    upcharge?: number;
+    rule_id?: number;
+}
+interface RuleSelection {
+    rule_id: number;
+    group_name?: string;
+    selections: Selection[];
+}
+interface Selection {
+    type: "item" | "component";
+    id: number;
+    quantity: number;
+    upcharge: number;
+    serving_price?: number;
+    name: string;
+    status?: "removed" | "modified" | "added";
+    component_type_id?: number;
+    serving_weight?: number;
+    measurement_type?: "weight" | "count";
+    display_unit?: string;
+}
+interface Customer {
+    customer_id?: number;
+    first_name: string;
+    last_name?: string;
+    phone: string;
+    email?: string;
+    allow_marketing?: boolean;
+}
+interface OrderMeta {
+    ready_at?: Date | string | null;
+    requested_minutes?: number | null;
+    is_scheduled?: boolean;
+    is_catering?: boolean;
+    is_third_party?: boolean;
+    source?: string;
+    tags?: string[];
+    name_override?: string;
+}
+interface Order {
+    order_id: number;
+    order_code?: string;
+    customer: Customer;
+    location_id: number;
+    location_name?: string;
+    franchise_id?: number;
+    method_id: number;
+    type_id: number;
+    time_placed: Date;
+    time_requested?: string;
+    items: OrderItem[];
+    order_status: number;
+    is_catering?: boolean;
+    promo_code?: string;
+    charges: Charge[];
+    subtotal?: number;
+    total?: number;
+    tax?: number;
+    service_fee?: number;
+    discount?: number;
+    tip?: number;
+    meta?: OrderMeta;
+    /** Single-line mailing-style address when order is delivery (e.g. "123 Main St, City, MI 48103"). */
+    delivery_address?: string;
+    revision?: number;
+    updated_at?: Date | string;
+    table_number?: number;
+}
+interface Charge {
+    id?: number;
+    order_id?: number;
+    total: number;
+    subtotal: number;
+    tax: number;
+    tip?: number;
+    discount?: number;
+    service_fee?: number;
+    charge_id?: string;
+    charge_status?: number;
+    created_at?: Date;
+    payment_method?: string;
+    refund_amount?: number;
+    refunded_at?: Date | string;
+    refund_id?: string;
+    drawer_session_id?: number;
+    setup_intent_id?: string;
+    stripe_payment_method_id?: string;
+    stripe_customer_id?: string;
+}
+interface Promotion {
+    id?: number;
+    created_at?: string;
+    /** Platforms where this promotion applies; omit, null, [], or all enum values => all platforms. Persist [] for “all”. */
+    platforms?: Platforms[] | null;
+    name: string;
+    description?: string;
+    discount_value: number;
+    promotion_type_id: number;
+    franchise_id?: number;
+    location_id: number | null;
+    customer_group_id?: number;
+    is_automatic: boolean;
+    promo_code: string | null;
+    start_date: Date | null;
+    end_date: Date | null;
+    schedule_details_json: PromotionScheduleDetails;
+    min_purchase_amount?: number | null;
+    min_purchase_quantity?: number | null;
+    discount_target_type: "category" | "item" | "item_variant" | null;
+    discount_target_ids?: number[];
+    is_active: boolean;
+    /** When true, only applies to catering orders. Uses sigmoid bulk discount when min_purchase_quantity is set. */
+    is_catering_only?: boolean | null;
+}
+interface PromotionScheduleDetails {
+    days?: number[];
+    interval: "weekly" | "monthly" | "daily";
+    start_time?: string;
+    end_time?: string;
+}
+type RecommendationStrategy = "top_items" | "discover";
+interface RecommendationRequest {
+    userKey: string;
+    locationId: number;
+    topK?: number;
+    strategy?: RecommendationStrategy;
+    sampleSize?: number;
+    seed?: number;
+}
+interface RecommendationResult {
+    item: OrderItem;
+    base_item_id: number;
+    description?: string | null;
+    final_score?: number;
+    score?: number;
+    probability?: number;
+    ingredient_score?: number;
+    molecular_score?: number;
+}
+
+interface Menu {
+    items: MenuItem[];
+    categories: Category[];
+    components: Component[];
+    rules: Rule[];
+}
+
+export type { Category, Customer, CustomizationOption, CustomizationRule, ItemVariant, Location, Menu, MenuItem, Order, OrderComponent, OrderItem, Promotion, RecommendationRequest, RecommendationResult, RecommendationStrategy, Rule, RuleComponent, RuleItem, RuleSelection, Selection };