wiil-core-js 0.0.82

package/dist/core/business-mgt/menu.order.schema.js

@@ -0,0 +1,149 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateMenuOrderStatusSchema = exports.UpdateMenuOrderSchema = exports.CreateMenuOrderSchema = exports.MenuOrderSchema = exports.MenuOrderItemSchema = exports.MenuOrderItemBaseSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_schema_1 = require("../base.schema");
+const order_schema_1 = require("./order.schema");
+const type_definitions_1 = require("../type-definitions");
+/**
+ * @fileoverview Menu order schema definitions for restaurant/food service.
+ * @module business-mgt/menu-order
+ */
+/**
+ * Base menu order item schema (without IDs for creation).
+ *
+ * @typedef {Object} MenuOrderItemBase
+ * @property {string} menuItemId - Menu item ID being ordered
+ * @property {string} itemName - Name of the menu item
+ * @property {number} quantity - Quantity ordered
+ * @property {number} unitPrice - Price per unit
+ * @property {number} totalPrice - Total price for this item
+ * @property {string} [specialInstructions] - Special preparation instructions
+ * @property {Array} [customizations] - Item customizations with additional costs
+ * @property {string} status - Item status
+ * @property {number} [preparationTime] - Estimated prep time in minutes
+ * @property {string} [notes] - Additional notes
+ */
+exports.MenuOrderItemBaseSchema = zod_1.default.object({
+    menuItemId: zod_1.default.string().describe("References MenuItem from menu-config.schema that is being ordered. Links order item to catalog for pricing, availability, and preparation details."),
+    itemName: zod_1.default.string().describe("Display name of the menu item captured at order time. Preserved even if catalog item is later renamed, ensuring historical order accuracy."),
+    quantity: zod_1.default.number().int().positive().describe("Number of units ordered for this menu item. Used for pricing calculations and kitchen preparation quantities."),
+    unitPrice: zod_1.default.number().nonnegative().describe("Price per unit at the time of order. Captures pricing snapshot for order integrity even if catalog prices change later."),
+    totalPrice: zod_1.default.number().nonnegative().describe("Total price for this line item: unitPrice × quantity + customization costs. Used in order subtotal calculations."),
+    // Restaurant-specific
+    specialInstructions: zod_1.default.string().nullable().default(null).describe("Customer's special preparation requests (e.g., 'no onions', 'extra sauce', 'well done'). Communicated to kitchen staff for customized preparation."),
+    customizations: zod_1.default.array(zod_1.default.object({
+        name: zod_1.default.string().describe("Customization option name (e.g., 'Extra Cheese', 'Gluten-Free Bread', 'Add Bacon')."),
+        value: zod_1.default.string().describe("Selected customization value or specification (e.g., 'Yes', 'Large', 'On the side')."),
+        additionalCost: zod_1.default.number().nonnegative().default(0).describe("Extra charge for this customization. Defaults to 0 for no-cost modifications.")
+    })).nullable().default(null).describe("Item customizations with pricing. Enables upselling and personalization in AI-powered Menu Order conversations."),
+    status: zod_1.default.enum(type_definitions_1.OrderStatus).default(type_definitions_1.OrderStatus.PENDING).describe("Current preparation status of this individual item. Enables per-item tracking in kitchen workflow. Defaults to PENDING."),
+    preparationTime: zod_1.default.number().int().positive().nullable().default(null).describe("Estimated preparation time in minutes for this specific item. Used for kitchen scheduling and customer ready-time estimates."),
+    notes: zod_1.default.string().nullable().default(null).describe("Internal notes about this item for kitchen or service staff. Not visible to customers.")
+});
+/**
+ * Menu order item schema with IDs (for existing items).
+ */
+exports.MenuOrderItemSchema = exports.MenuOrderItemBaseSchema.safeExtend({
+    id: zod_1.default.string().describe("Unique identifier for this menu order item instance."),
+    menuOrderId: zod_1.default.string().describe("References parent MenuOrder this item belongs to. Maintains order-item relationship for order management and fulfillment tracking."),
+});
+/**
+ * Menu order schema - for restaurants/food service.
+ *
+ * @typedef {Object} MenuOrder
+ * @property {string} [orderNumber] - Human-readable order number
+ * @property {string} type - Order type (dine-in, takeout, delivery)
+ * @property {string} status - Current order status
+ * @property {Array} items - Items in the order
+ * @property {string} customerId - ID of the customer placing the order
+ * @property {Object} [customer] - Customer information
+ * @property {Object} pricing - Pricing details
+ * @property {string} paymentStatus - Payment status
+ * @property {string} [paymentMethod] - Payment method used
+ * @property {string} [paymentReference] - Payment reference number
+ * @property {number} orderDate - Order date as Unix timestamp
+ * @property {number} [requestedTime] - Requested pickup/delivery time
+ * @property {number} [estimatedReadyTime] - Estimated ready time
+ * @property {number} [actualReadyTime] - Actual ready time
+ * @property {string} [specialInstructions] - Special instructions
+ * @property {string[]} [allergies] - Customer allergies
+ * @property {string} [tableNumber] - Table number for dine-in
+ * @property {string} [externalOrderId] - External order ID for integrations
+ * @property {string} source - Order source
+ * @property {string} [cancelReason] - Reason for cancellation
+ * @property {string} [notes] - Additional notes
+ * @property {string} [serviceConversationConfigId] - Service conversation config ID
+ * @property {Object} [deliveryAddress] - Delivery address if applicable
+ * @property {number} [tip] - Tip amount for the order
+ */
+exports.MenuOrderSchema = base_schema_1.BaseModelSchema.safeExtend({
+    orderNumber: zod_1.default.string().nullable().default(null).describe("Human-readable order number displayed to customers and staff (e.g., '#1234', 'A-42'). Generated by Menu Management for easy reference and communication."),
+    type: zod_1.default.enum(type_definitions_1.MenuOrderType).describe("Order fulfillment type: DINE_IN (eat at restaurant), TAKEOUT (customer pickup), or DELIVERY (courier delivery). Determines workflow and address requirements."),
+    status: zod_1.default.enum(type_definitions_1.OrderStatus).default(type_definitions_1.OrderStatus.PENDING).describe("Current order status tracking progression from placement to fulfillment. Used by kitchen display systems and customer notifications. Defaults to PENDING."),
+    items: zod_1.default.array(exports.MenuOrderItemSchema).min(1, "Order must have at least one item").describe("Menu items in this order with quantities, pricing, and customizations. Minimum one item required for valid order."),
+    customerId: zod_1.default.string().describe("References Customer who placed this order. Links to customer profile for order history, preferences, and communication."),
+    customer: order_schema_1.OrderCustomerSchema.nullable().default(null).describe("Populated customer information for convenient access. Includes name, contact details, and delivery address from order.schema.ts."),
+    pricing: order_schema_1.OrderPricingSchema.describe("Complete pricing breakdown including subtotal, tax, tip, delivery fees, and discounts. From order.schema.ts for consistent pricing across order types."),
+    // Payment
+    paymentStatus: zod_1.default.enum(type_definitions_1.PaymentStatus).default(type_definitions_1.PaymentStatus.PENDING).describe("Payment processing status. Tracks whether order is paid, pending, failed, or refunded. Defaults to PENDING."),
+    paymentMethod: zod_1.default.string().nullable().default(null).describe("Payment method used (e.g., 'credit_card', 'cash', 'digital_wallet'). Captured for accounting and reconciliation."),
+    paymentReference: zod_1.default.string().nullable().default(null).describe("External payment system reference or transaction ID. Used for payment verification and dispute resolution."),
+    // Restaurant-specific timing
+    orderDate: zod_1.default.number().describe("Unix timestamp when order was placed. Used for order history, analytics, and time-based reporting."),
+    requestedTime: zod_1.default.number().nullable().default(null).describe("Unix timestamp for customer's requested pickup or delivery time. Used for scheduling kitchen preparation and delivery coordination."),
+    estimatedReadyTime: zod_1.default.number().nullable().default(null).describe("Unix timestamp when kitchen estimates order will be ready. Communicated to customers via AI Powered Services and used for pickup/delivery scheduling."),
+    actualReadyTime: zod_1.default.number().nullable().default(null).describe("Unix timestamp when order was actually completed and ready. Used for performance tracking and customer communication accuracy."),
+    // Restaurant-specific requests
+    specialInstructions: zod_1.default.string().nullable().default(null).describe("Order-level special instructions from customer (e.g., 'ring doorbell', 'leave at door', 'call upon arrival'). Applies to entire order vs item-specific instructions."),
+    allergies: zod_1.default.array(zod_1.default.string()).nullable().default(null).describe("Customer's allergy information for this order (e.g., ['peanuts', 'shellfish']). Critical for kitchen safety protocols and cross-contamination prevention."),
+    tableNumber: zod_1.default.string().nullable().default(null).describe("Table number for DINE_IN orders. Links order to physical location for server delivery and bill management."),
+    // Integration
+    externalOrderId: zod_1.default.string().nullable().default(null).describe("Order ID from external system (third-party delivery platform, POS system). Enables order synchronization and cross-platform tracking."),
+    source: zod_1.default.string().default('direct').describe("Order source channel (e.g., 'direct', 'web', 'phone', 'third_party_platform'). Used for attribution tracking and channel analytics. Defaults to 'direct'."),
+    cancelReason: zod_1.default.string().nullable().default(null).describe("Reason provided when order is cancelled. Used for analytics, process improvement, and customer service follow-up."),
+    notes: zod_1.default.string().nullable().default(null).describe("Internal operational notes about this order. Not visible to customers; used by staff for coordination and special handling."),
+    serviceConversationConfigId: zod_1.default.string().nullable().default(null).describe("References the AI Powered Services conversation configuration that powered this order. Links order to deployment channel and conversation history."),
+    deliveryAddress: zod_1.default.object({
+        street: zod_1.default.string().describe("Delivery street address for DELIVERY type orders. Primary location for courier navigation."),
+        city: zod_1.default.string().nullable().default(null).describe("Delivery city for regional routing and delivery fee calculation."),
+        postalCode: zod_1.default.string().nullable().default(null).describe("Delivery postal code for address validation and delivery zone determination."),
+    }).nullable().default(null).describe("Delivery address for DELIVERY type orders. Required when type is DELIVERY; unused for DINE_IN or TAKEOUT."),
+    tip: zod_1.default.number().nonnegative().nullable().default(null).describe("Tip amount for the order."),
+});
+/**
+ * Schema for creating a new menu order.
+ * Omits auto-generated fields and uses base items without IDs.
+ */
+exports.CreateMenuOrderSchema = exports.MenuOrderSchema.omit({
+    id: true,
+    orderNumber: true,
+    createdAt: true,
+    updatedAt: true,
+    actualReadyTime: true,
+    items: true,
+    cancelReason: true,
+    serviceConversationConfigId: true,
+}).safeExtend({
+    items: zod_1.default.array(exports.MenuOrderItemBaseSchema).min(1, "Order must have at least one item"),
+    cancelReason: zod_1.default.string().nullable().default(null),
+});
+/**
+ * Schema for updating an existing menu order.
+ * All fields are optional except id.
+ */
+exports.UpdateMenuOrderSchema = exports.CreateMenuOrderSchema.partial().safeExtend({
+    id: zod_1.default.string(),
+});
+/**
+ * Quick status update schema for menu orders.
+ */
+exports.UpdateMenuOrderStatusSchema = zod_1.default.object({
+    id: zod_1.default.string().describe("Unique identifier of the MenuOrder to update status for."),
+    status: zod_1.default.enum(type_definitions_1.OrderStatus).describe("New order status to transition to (e.g., from PENDING to PREPARING to READY). Validates against OrderStatus enum for workflow consistency."),
+    estimatedReadyTime: zod_1.default.number().nullable().default(null).describe("Updated Unix timestamp for estimated completion. Used when kitchen adjusts timing based on current workload or delays."),
+    actualReadyTime: zod_1.default.number().nullable().default(null).describe("Unix timestamp when order was actually completed. Set when status transitions to READY or COMPLETED for performance tracking."),
+});

package/dist/core/business-mgt/order.schema.d.ts

@@ -0,0 +1,222 @@
+import z from "zod";
+import { DiscountScope, DiscountType, PricingRuleAdjustmentType, PricingRuleApplyLevel, TaxRateType, TaxScope } from "../type-definitions";
+/**
+ * @fileoverview Shared order schema definitions used across menu and product orders.
+ * @module business-mgt/order
+ */
+/**
+ * Order address schema.
+ * Extends base address with delivery-specific instructions.
+ *
+ * @typedef {Object} OrderAddress
+ * @property {string} [deliveryInstructions] - Special delivery instructions for couriers
+ */
+export declare const OrderAddress: z.ZodOptional<z.ZodObject<{
+    street: z.ZodString;
+    street2: z.ZodOptional<z.ZodString>;
+    city: z.ZodString;
+    state: z.ZodString;
+    postalCode: z.ZodString;
+    country: z.ZodString;
+    deliveryInstructions: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>;
+/**
+ * Order customer schema.
+ * Captures customer information for order identification and communication.
+ *
+ * @typedef {Object} OrderCustomer
+ * @property {string} [customerId] - Customer ID if registered
+ * @property {string} name - Customer's full name
+ * @property {string} [phone] - Customer's phone number
+ * @property {string} [email] - Customer's email address
+ * @property {Object} [address] - Customer address for delivery/billing
+ */
+export declare const OrderCustomerSchema: z.ZodObject<{
+    customerId: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    phone: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodEmail>;
+    address: z.ZodOptional<z.ZodObject<{
+        street: z.ZodString;
+        street2: z.ZodOptional<z.ZodString>;
+        city: z.ZodString;
+        state: z.ZodString;
+        postalCode: z.ZodString;
+        country: z.ZodString;
+        deliveryInstructions: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Applied discount schema.
+ * Captures a discount applied to an order with calculated amounts.
+ *
+ * @typedef {Object} AppliedDiscount
+ * @property {string} [discountRuleId] - Internal discount rule ID
+ * @property {string} [externalDiscountId] - External system discount ID
+ * @property {string} name - Discount display name
+ * @property {string} [code] - Discount code if applicable
+ * @property {DiscountScope} scope - Discount scope (order, item, category)
+ * @property {DiscountType} type - Discount type (percentage, fixed)
+ * @property {number} value - Discount value
+ * @property {number} discountableAmount - Amount eligible for discount
+ * @property {number} discountAmount - Calculated discount amount
+ * @property {boolean} isStacked - Whether this discount was stacked
+ */
+export declare const AppliedDiscountSchema: z.ZodObject<{
+    discountRuleId: z.ZodOptional<z.ZodString>;
+    externalDiscountId: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    code: z.ZodOptional<z.ZodString>;
+    scope: z.ZodDefault<z.ZodEnum<typeof DiscountScope>>;
+    type: z.ZodEnum<typeof DiscountType>;
+    value: z.ZodNumber;
+    discountableAmount: z.ZodNumber;
+    discountAmount: z.ZodNumber;
+    isStacked: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type AppliedDiscount = z.infer<typeof AppliedDiscountSchema>;
+/**
+ * Applied pricing rule schema.
+ * Captures a pricing rule applied to an order with calculated adjustments.
+ *
+ * @typedef {Object} AppliedPricingRule
+ * @property {string} [pricingRuleId] - Internal pricing rule ID
+ * @property {string} [externalPricingRuleId] - External system pricing rule ID
+ * @property {string} name - Pricing rule display name
+ * @property {PricingRuleApplyLevel} applyLevel - Level at which rule was applied
+ * @property {PricingRuleAdjustmentType} adjustmentType - Type of price adjustment
+ * @property {number} adjustmentValue - Adjustment value
+ * @property {number} baseAmount - Original amount before adjustment
+ * @property {number} adjustedAmount - Amount after adjustment
+ * @property {number} deltaAmount - Difference (can be negative)
+ * @property {number} [appliedAt] - Timestamp when rule was applied
+ */
+export declare const AppliedPricingRuleSchema: z.ZodObject<{
+    pricingRuleId: z.ZodOptional<z.ZodString>;
+    externalPricingRuleId: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    applyLevel: z.ZodDefault<z.ZodEnum<typeof PricingRuleApplyLevel>>;
+    adjustmentType: z.ZodEnum<typeof PricingRuleAdjustmentType>;
+    adjustmentValue: z.ZodNumber;
+    baseAmount: z.ZodNumber;
+    adjustedAmount: z.ZodNumber;
+    deltaAmount: z.ZodNumber;
+    appliedAt: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type AppliedPricingRule = z.infer<typeof AppliedPricingRuleSchema>;
+/**
+ * Applied tax schema.
+ * Captures a tax applied to an order with calculated amounts.
+ *
+ * @typedef {Object} AppliedTax
+ * @property {string} [taxRuleId] - Internal tax rule ID
+ * @property {string} [externalTaxId] - External system tax ID
+ * @property {string} name - Tax display name
+ * @property {TaxScope} scope - Tax scope (order, item, category)
+ * @property {TaxRateType} rateType - Tax rate type (percentage, fixed)
+ * @property {number} rateValue - Tax rate value
+ * @property {number} taxableAmount - Amount subject to tax
+ * @property {number} taxAmount - Calculated tax amount
+ * @property {boolean} isInclusive - Whether tax is included in prices
+ */
+export declare const AppliedTaxSchema: z.ZodObject<{
+    taxRuleId: z.ZodOptional<z.ZodString>;
+    externalTaxId: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    scope: z.ZodDefault<z.ZodEnum<typeof TaxScope>>;
+    rateType: z.ZodEnum<typeof TaxRateType>;
+    rateValue: z.ZodNumber;
+    taxableAmount: z.ZodNumber;
+    taxAmount: z.ZodNumber;
+    isInclusive: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export type AppliedTax = z.infer<typeof AppliedTaxSchema>;
+/**
+ * Order pricing schema.
+ * Comprehensive pricing breakdown including subtotals, discounts, taxes, and fees.
+ *
+ * @typedef {Object} OrderPricing
+ * @property {number} subtotal - Subtotal before tax and fees
+ * @property {number} tax - Tax amount
+ * @property {number} tip - Tip/gratuity amount
+ * @property {number} shippingAmount - Shipping amount if applicable
+ * @property {number} discount - Discount amount applied
+ * @property {number} total - Final total amount
+ * @property {string} currency - Currency code (ISO 4217 format)
+ */
+export declare const OrderPricingSchema: z.ZodObject<{
+    subtotalBeforeTax: z.ZodOptional<z.ZodNumber>;
+    subtotal: z.ZodNumber;
+    appliedPricingRules: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        pricingRuleId: z.ZodOptional<z.ZodString>;
+        externalPricingRuleId: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        applyLevel: z.ZodDefault<z.ZodEnum<typeof PricingRuleApplyLevel>>;
+        adjustmentType: z.ZodEnum<typeof PricingRuleAdjustmentType>;
+        adjustmentValue: z.ZodNumber;
+        baseAmount: z.ZodNumber;
+        adjustedAmount: z.ZodNumber;
+        deltaAmount: z.ZodNumber;
+        appliedAt: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    totalPricingAdjustmentAmount: z.ZodDefault<z.ZodNumber>;
+    subtotalAfterPricingRules: z.ZodOptional<z.ZodNumber>;
+    appliedDiscounts: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        discountRuleId: z.ZodOptional<z.ZodString>;
+        externalDiscountId: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        code: z.ZodOptional<z.ZodString>;
+        scope: z.ZodDefault<z.ZodEnum<typeof DiscountScope>>;
+        type: z.ZodEnum<typeof DiscountType>;
+        value: z.ZodNumber;
+        discountableAmount: z.ZodNumber;
+        discountAmount: z.ZodNumber;
+        isStacked: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    totalDiscountAmount: z.ZodDefault<z.ZodNumber>;
+    subtotalAfterDiscount: z.ZodOptional<z.ZodNumber>;
+    appliedTaxes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        taxRuleId: z.ZodOptional<z.ZodString>;
+        externalTaxId: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        scope: z.ZodDefault<z.ZodEnum<typeof TaxScope>>;
+        rateType: z.ZodEnum<typeof TaxRateType>;
+        rateValue: z.ZodNumber;
+        taxableAmount: z.ZodNumber;
+        taxAmount: z.ZodNumber;
+        isInclusive: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    totalTaxAmount: z.ZodDefault<z.ZodNumber>;
+    tax: z.ZodDefault<z.ZodNumber>;
+    tip: z.ZodDefault<z.ZodNumber>;
+    shippingAmount: z.ZodDefault<z.ZodNumber>;
+    discount: z.ZodDefault<z.ZodNumber>;
+    subtotalAfterTax: z.ZodOptional<z.ZodNumber>;
+    total: z.ZodNumber;
+    currency: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+export type OrderCustomer = z.infer<typeof OrderCustomerSchema>;
+export type OrderPricing = z.infer<typeof OrderPricingSchema>;
+export type OrderAddress = z.infer<typeof OrderAddress>;
+/**
+ * Menu item daypart schema.
+ * Defines time-based availability windows for menu items.
+ *
+ * @typedef {Object} MenuItemDaypart
+ * @property {string} name - Daypart name (e.g., Breakfast, Lunch)
+ * @property {string} startTime - Daypart start time in HH:MM format
+ * @property {string} endTime - Daypart end time in HH:MM format
+ * @property {string[]} [daysOfWeek] - Optional active days (0-6, Sunday=0)
+ */
+export declare const MenuItemDaypartSchema: z.ZodObject<{
+    name: z.ZodString;
+    startTime: z.ZodString;
+    endTime: z.ZodString;
+    daysOfWeek: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Default menu item dayparts.
+ * Standard time windows for meal periods.
+ */
+export declare const DEFAULT_MENU_ITEM_DAYPARTS: z.infer<typeof MenuItemDaypartSchema>[];
+export type MenuItemDaypart = z.infer<typeof MenuItemDaypartSchema>;

package/dist/core/business-mgt/order.schema.js

@@ -0,0 +1,205 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_MENU_ITEM_DAYPARTS = exports.MenuItemDaypartSchema = exports.OrderPricingSchema = exports.AppliedTaxSchema = exports.AppliedPricingRuleSchema = exports.AppliedDiscountSchema = exports.OrderCustomerSchema = exports.OrderAddress = void 0;
+const zod_1 = __importDefault(require("zod"));
+const base_schema_1 = require("../base.schema");
+const type_definitions_1 = require("../type-definitions");
+/**
+ * @fileoverview Shared order schema definitions used across menu and product orders.
+ * @module business-mgt/order
+ */
+// ============================================================================
+// ADDRESS SCHEMA
+// ============================================================================
+/**
+ * Order address schema.
+ * Extends base address with delivery-specific instructions.
+ *
+ * @typedef {Object} OrderAddress
+ * @property {string} [deliveryInstructions] - Special delivery instructions for couriers
+ */
+exports.OrderAddress = base_schema_1.AddressSchema.safeExtend({
+    deliveryInstructions: zod_1.default.string().optional().describe("Special delivery instructions (gate code, building entrance, drop-off location) for couriers and delivery personnel.")
+}).optional();
+// ============================================================================
+// ORDER CUSTOMER SCHEMA
+// ============================================================================
+/**
+ * Order customer schema.
+ * Captures customer information for order identification and communication.
+ *
+ * @typedef {Object} OrderCustomer
+ * @property {string} [customerId] - Customer ID if registered
+ * @property {string} name - Customer's full name
+ * @property {string} [phone] - Customer's phone number
+ * @property {string} [email] - Customer's email address
+ * @property {Object} [address] - Customer address for delivery/billing
+ */
+exports.OrderCustomerSchema = zod_1.default.object({
+    customerId: zod_1.default.string().optional().describe("References Customer ID if customer is registered in the system. Used to link order history, preferences, and loyalty data."),
+    name: zod_1.default.string().min(1, "Customer name is required").describe("Customer's full name for order identification, receipts, and communication. Required for all orders."),
+    phone: zod_1.default.string().optional().describe("Customer's contact phone for order updates, delivery coordination, and support. Used by AI Powered Services for SMS notifications."),
+    email: zod_1.default.email().optional().describe("Customer's email for digital receipts, order confirmations, and AI-generated order summaries."),
+    address: exports.OrderAddress.describe("Customer address for delivery (menu/product orders) or billing purposes. Extended with delivery-specific instructions.")
+});
+// ============================================================================
+// APPLIED DISCOUNT SCHEMA
+// ============================================================================
+/**
+ * Applied discount schema.
+ * Captures a discount applied to an order with calculated amounts.
+ *
+ * @typedef {Object} AppliedDiscount
+ * @property {string} [discountRuleId] - Internal discount rule ID
+ * @property {string} [externalDiscountId] - External system discount ID
+ * @property {string} name - Discount display name
+ * @property {string} [code] - Discount code if applicable
+ * @property {DiscountScope} scope - Discount scope (order, item, category)
+ * @property {DiscountType} type - Discount type (percentage, fixed)
+ * @property {number} value - Discount value
+ * @property {number} discountableAmount - Amount eligible for discount
+ * @property {number} discountAmount - Calculated discount amount
+ * @property {boolean} isStacked - Whether this discount was stacked
+ */
+exports.AppliedDiscountSchema = zod_1.default.object({
+    discountRuleId: zod_1.default.string().optional(),
+    externalDiscountId: zod_1.default.string().optional(),
+    name: zod_1.default.string().min(1),
+    code: zod_1.default.string().optional(),
+    scope: zod_1.default.enum(type_definitions_1.DiscountScope).default(type_definitions_1.DiscountScope.ORDER),
+    type: zod_1.default.enum(type_definitions_1.DiscountType),
+    value: zod_1.default.number().nonnegative(),
+    discountableAmount: zod_1.default.number().nonnegative(),
+    discountAmount: zod_1.default.number().nonnegative(),
+    isStacked: zod_1.default.boolean().default(false),
+});
+// ============================================================================
+// APPLIED PRICING RULE SCHEMA
+// ============================================================================
+/**
+ * Applied pricing rule schema.
+ * Captures a pricing rule applied to an order with calculated adjustments.
+ *
+ * @typedef {Object} AppliedPricingRule
+ * @property {string} [pricingRuleId] - Internal pricing rule ID
+ * @property {string} [externalPricingRuleId] - External system pricing rule ID
+ * @property {string} name - Pricing rule display name
+ * @property {PricingRuleApplyLevel} applyLevel - Level at which rule was applied
+ * @property {PricingRuleAdjustmentType} adjustmentType - Type of price adjustment
+ * @property {number} adjustmentValue - Adjustment value
+ * @property {number} baseAmount - Original amount before adjustment
+ * @property {number} adjustedAmount - Amount after adjustment
+ * @property {number} deltaAmount - Difference (can be negative)
+ * @property {number} [appliedAt] - Timestamp when rule was applied
+ */
+exports.AppliedPricingRuleSchema = zod_1.default.object({
+    pricingRuleId: zod_1.default.string().optional(),
+    externalPricingRuleId: zod_1.default.string().optional(),
+    name: zod_1.default.string().min(1),
+    applyLevel: zod_1.default.enum(type_definitions_1.PricingRuleApplyLevel).default(type_definitions_1.PricingRuleApplyLevel.ORDER),
+    adjustmentType: zod_1.default.enum(type_definitions_1.PricingRuleAdjustmentType),
+    adjustmentValue: zod_1.default.number().nonnegative(),
+    baseAmount: zod_1.default.number().nonnegative(),
+    adjustedAmount: zod_1.default.number().nonnegative(),
+    deltaAmount: zod_1.default.number(),
+    appliedAt: zod_1.default.number().int().nonnegative().optional(),
+});
+// ============================================================================
+// APPLIED TAX SCHEMA
+// ============================================================================
+/**
+ * Applied tax schema.
+ * Captures a tax applied to an order with calculated amounts.
+ *
+ * @typedef {Object} AppliedTax
+ * @property {string} [taxRuleId] - Internal tax rule ID
+ * @property {string} [externalTaxId] - External system tax ID
+ * @property {string} name - Tax display name
+ * @property {TaxScope} scope - Tax scope (order, item, category)
+ * @property {TaxRateType} rateType - Tax rate type (percentage, fixed)
+ * @property {number} rateValue - Tax rate value
+ * @property {number} taxableAmount - Amount subject to tax
+ * @property {number} taxAmount - Calculated tax amount
+ * @property {boolean} isInclusive - Whether tax is included in prices
+ */
+exports.AppliedTaxSchema = zod_1.default.object({
+    taxRuleId: zod_1.default.string().optional(),
+    externalTaxId: zod_1.default.string().optional(),
+    name: zod_1.default.string().min(1),
+    scope: zod_1.default.enum(type_definitions_1.TaxScope).default(type_definitions_1.TaxScope.ORDER),
+    rateType: zod_1.default.enum(type_definitions_1.TaxRateType),
+    rateValue: zod_1.default.number().nonnegative(),
+    taxableAmount: zod_1.default.number().nonnegative(),
+    taxAmount: zod_1.default.number().nonnegative(),
+    isInclusive: zod_1.default.boolean().default(false),
+});
+// ============================================================================
+// ORDER PRICING SCHEMA
+// ============================================================================
+/**
+ * Order pricing schema.
+ * Comprehensive pricing breakdown including subtotals, discounts, taxes, and fees.
+ *
+ * @typedef {Object} OrderPricing
+ * @property {number} subtotal - Subtotal before tax and fees
+ * @property {number} tax - Tax amount
+ * @property {number} tip - Tip/gratuity amount
+ * @property {number} shippingAmount - Shipping amount if applicable
+ * @property {number} discount - Discount amount applied
+ * @property {number} total - Final total amount
+ * @property {string} currency - Currency code (ISO 4217 format)
+ */
+exports.OrderPricingSchema = zod_1.default.object({
+    subtotalBeforeTax: zod_1.default.number().nonnegative().optional().describe("Subtotal before tax"),
+    subtotal: zod_1.default.number().nonnegative().describe("Subtotal before tax and fees"),
+    appliedPricingRules: zod_1.default.array(exports.AppliedPricingRuleSchema).default([]).describe("Detailed applied pricing rule breakdown"),
+    totalPricingAdjustmentAmount: zod_1.default.number().default(0).describe("Net adjustment amount from appliedPricingRules"),
+    subtotalAfterPricingRules: zod_1.default.number().nonnegative().optional().describe("Subtotal after pricing rules and before discounts"),
+    appliedDiscounts: zod_1.default.array(exports.AppliedDiscountSchema).default([]).describe("Detailed applied discount breakdown"),
+    totalDiscountAmount: zod_1.default.number().nonnegative().default(0).describe("Total discount amount from appliedDiscounts"),
+    subtotalAfterDiscount: zod_1.default.number().nonnegative().optional().describe("Subtotal after discounts and before tax"),
+    appliedTaxes: zod_1.default.array(exports.AppliedTaxSchema).default([]).describe("Detailed applied tax breakdown"),
+    totalTaxAmount: zod_1.default.number().nonnegative().default(0).describe("Total tax amount from appliedTaxes"),
+    tax: zod_1.default.number().nonnegative().default(0).describe("Tax amount"),
+    tip: zod_1.default.number().nonnegative().default(0).describe("Tip/gratuity amount"),
+    shippingAmount: zod_1.default.number().nonnegative().default(0).describe("Shipping amount if applicable"),
+    discount: zod_1.default.number().nonnegative().default(0).describe("Discount amount applied"),
+    subtotalAfterTax: zod_1.default.number().nonnegative().optional().describe("Subtotal after tax and before tips/shipping"),
+    total: zod_1.default.number().nonnegative().describe("Final total amount"),
+    currency: zod_1.default.string().length(3).default("USD").describe("Currency code (ISO 4217 format)")
+});
+// ============================================================================
+// MENU ITEM DAYPART SCHEMA
+// ============================================================================
+/**
+ * Menu item daypart schema.
+ * Defines time-based availability windows for menu items.
+ *
+ * @typedef {Object} MenuItemDaypart
+ * @property {string} name - Daypart name (e.g., Breakfast, Lunch)
+ * @property {string} startTime - Daypart start time in HH:MM format
+ * @property {string} endTime - Daypart end time in HH:MM format
+ * @property {string[]} [daysOfWeek] - Optional active days (0-6, Sunday=0)
+ */
+exports.MenuItemDaypartSchema = zod_1.default.object({
+    name: zod_1.default.string().min(1).describe("Daypart name (e.g., Breakfast, Lunch)"),
+    startTime: zod_1.default.string().regex(/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/, "Invalid time format (HH:MM)").describe("Daypart start time in HH:MM format"),
+    endTime: zod_1.default.string().regex(/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/, "Invalid time format (HH:MM)").describe("Daypart end time in HH:MM format"),
+    daysOfWeek: zod_1.default.array(zod_1.default.string().regex(/^[0-6]$/, "Day must be 0-6")).optional().describe("Optional active days where 0 = Sunday and 6 = Saturday"),
+});
+// ============================================================================
+// DEFAULT DAYPARTS
+// ============================================================================
+/**
+ * Default menu item dayparts.
+ * Standard time windows for meal periods.
+ */
+exports.DEFAULT_MENU_ITEM_DAYPARTS = [
+    { name: "Breakfast", startTime: "06:00", endTime: "11:00" },
+    { name: "Lunch", startTime: "11:00", endTime: "16:00" },
+    { name: "Dinner", startTime: "16:00", endTime: "22:00" },
+    { name: "Happy hour", startTime: "15:00", endTime: "18:00" },
+];

package/dist/core/business-mgt/pricing-rule.shared.schema.d.ts

@@ -0,0 +1,56 @@
+import { z } from "zod";
+import { PricingChannel, PricingRuleAdjustmentType, PricingRuleApplyLevel } from "../type-definitions";
+/**
+ * @fileoverview Shared pricing rule schema definitions used across menu and product pricing.
+ * @module business-mgt/pricing-rule-shared
+ */
+export { PricingChannel, PricingRuleAdjustmentType, PricingRuleApplyLevel };
+/**
+ * Pricing rule channel mapping schema.
+ * Maps pricing rules to external platform pricing rule IDs.
+ *
+ * @typedef {Object} PricingRuleChannelMapping
+ * @property {string} channelId - Channel identifier
+ * @property {string} externalPricingRuleId - External pricing rule ID
+ */
+export declare const PricingRuleChannelMappingSchema: z.ZodObject<{
+    channelId: z.ZodString;
+    externalPricingRuleId: z.ZodString;
+}, z.core.$strip>;
+export type PricingRuleChannelMapping = z.infer<typeof PricingRuleChannelMappingSchema>;
+/**
+ * Pricing rule common condition schema.
+ * Defines when a pricing rule should be applied based on time, day, customer, and channel.
+ *
+ * @typedef {Object} PricingRuleCommonCondition
+ * @property {number[]} daysOfWeek - Days of week (0-6, Sunday=0)
+ * @property {number} [startMinute] - Start minute of day (0-1439)
+ * @property {number} [endMinute] - End minute of day (0-1439)
+ * @property {string[]} [customerSegmentIds] - Target customer segment IDs
+ * @property {PricingChannel} channel - Channel scope for the rule
+ */
+export declare const PricingRuleCommonConditionSchema: z.ZodObject<{
+    daysOfWeek: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+    startMinute: z.ZodOptional<z.ZodNumber>;
+    endMinute: z.ZodOptional<z.ZodNumber>;
+    customerSegmentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    channel: z.ZodDefault<z.ZodEnum<typeof PricingChannel>>;
+}, z.core.$strip>;
+/**
+ * Pricing rule action schema.
+ * Defines the price adjustment to apply when rule conditions are met.
+ *
+ * @typedef {Object} PricingRuleAction
+ * @property {PricingRuleAdjustmentType} adjustmentType - Type of price adjustment
+ * @property {number} adjustmentValue - Adjustment value (percentage or fixed amount)
+ * @property {string} currency - Currency code for fixed adjustments
+ * @property {number} [maxAdjustmentAmount] - Maximum adjustment cap
+ */
+export declare const PricingRuleActionSchema: z.ZodObject<{
+    adjustmentType: z.ZodEnum<typeof PricingRuleAdjustmentType>;
+    adjustmentValue: z.ZodNumber;
+    currency: z.ZodDefault<z.ZodString>;
+    maxAdjustmentAmount: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PricingRuleCommonCondition = z.infer<typeof PricingRuleCommonConditionSchema>;
+export type PricingRuleAction = z.infer<typeof PricingRuleActionSchema>;