@novha/anlia-core-lib 0.1.0

package/src/interfaces/domain/Menu.ts

@@ -0,0 +1,121 @@
+
+import { MenuItemStatus, MenuStatus } from "../../enums/domain/Menu";
+import { Money } from "./Money";
+
+export interface IMenuItemModifierOption {
+    id: string;
+
+    name: string;
+
+    /** Additional cost on top of the item's base price. */
+    additionalPrice?: Money;
+
+    isDefault?: boolean;
+}
+
+export interface IMenuItemModifier {
+    id: string;
+
+    /** Display name of the modifier group (e.g. "Choose a size"). */
+    name: string;
+
+    required: boolean;
+
+    /** Minimum number of selections. */
+    minSelections: number;
+
+    /** Maximum number of selections (undefined = unlimited). */
+    maxSelections?: number;
+
+    options: IMenuItemModifierOption[];
+}
+
+export interface IMenuCategory {
+    id: string;
+
+    menuId: string;
+
+    name: string;
+
+    description?: string;
+
+    /** Display order among sibling categories. */
+    sortOrder: number;
+
+    imageUrl?: string;
+
+    isActive: boolean;
+}
+
+export interface IMenuItem {
+    id: string;
+
+    restaurantId: string;
+
+    menuId: string;
+
+    categoryId: string;
+
+    name: string;
+
+    description?: string;
+
+    price: Money;
+
+    status: MenuItemStatus;
+
+    /** Estimated kitchen preparation time in minutes. */
+    preparationTimeMinutes?: number;
+
+    /** Link to the recipe or production spec. */
+    recipeId?: string;
+
+    allergens?: string[];
+
+    modifiers?: IMenuItemModifier[];
+
+    imageUrl?: string;
+
+    /** Display order within its category. */
+    sortOrder: number;
+
+    isAvailable: boolean;
+
+    /** Calorie count for nutritional display. */
+    calories?: number;
+
+    tags?: string[];
+
+    createdAt: Date;
+
+    updatedAt: Date;
+}
+
+export interface IMenu {
+    id: string;
+
+    restaurantId: string;
+
+    /** Optional location scope — null means the menu applies to all locations. */
+    locationId?: string;
+
+    name: string;
+
+    description?: string;
+
+    status: MenuStatus;
+
+    categories: IMenuCategory[];
+
+    items: IMenuItem[];
+
+    /** ISO 8601 date-time when the menu becomes effective. */
+    validFrom?: Date;
+
+    /** ISO 8601 date-time when the menu expires. */
+    validUntil?: Date;
+
+    createdAt: Date;
+
+    updatedAt: Date;
+}

package/src/interfaces/domain/Money.ts

@@ -0,0 +1,6 @@
+export type Currency = 'USD' | 'EUR' | 'GBP' | 'JPY' | 'CAD' | 'AUD' | 'CHF' | 'CNY' | 'INR' | 'BRL' | 'MXN' | 'ZAR';
+
+export interface Money {
+    amount: number;
+    currency: Currency;
+}

package/src/interfaces/domain/OpeningHours.ts

@@ -0,0 +1,11 @@
+import { DayOfWeek } from "../../enums/domain/DayOfWeek";
+
+export interface OperatingHours {
+    dayOfWeek: DayOfWeek;
+
+    openTime: string;
+
+    closeTime: string;
+
+    isClosed: boolean;
+}

package/src/interfaces/domain/Payment.ts

@@ -0,0 +1,45 @@
+import { PaymentMethod, PaymentStatus } from "../../enums/domain/Payments";
+import { Money } from "./Money";
+
+export interface IPayment {
+
+    /**
+     * Internal payment identifier.
+     */
+    id: string;
+
+    /**
+     * Vendor payment identifier.
+     */
+    externalId?: string;
+
+    /**
+     * Payment method.
+     */
+    method: PaymentMethod;
+
+    /**
+     * Payment amount.
+     */
+    amount: Money;
+
+    /**
+     * Payment status.
+     */
+    status: PaymentStatus;
+
+    /**
+     * Authorization code.
+     */
+    authorizationCode?: string;
+
+    /**
+     * Transaction reference.
+     */
+    reference?: string;
+
+    /**
+     * Paid timestamp.
+     */
+    paidAt: Date;
+}

package/src/interfaces/domain/Recipe.ts

@@ -0,0 +1,91 @@
+import { InventoryUnit } from "../../enums/domain/Inventory";
+import { AllergenType, DietaryFlag } from "../../enums/domain/Ingredient";
+import { INutritionalInfo } from "./Ingredient";
+import { RecipeStatus, RecipeYieldUnit } from "../../enums/domain/Recipe";
+
+export interface IRecipeIngredient {
+    ingredientId: string;
+
+    /** Display name snapshot (denormalised for readability). */
+    name: string;
+
+    quantity: number;
+
+    unit: InventoryUnit;
+
+    /** If true this ingredient can be omitted without breaking the recipe. */
+    optional: boolean;
+
+    notes?: string;
+}
+
+export interface IRecipeStep {
+    /** 1-based step number. */
+    stepNumber: number;
+
+    instruction: string;
+
+    /** Estimated time to complete this step in minutes. */
+    durationMinutes?: number;
+
+    /** Equipment required for this step (e.g. "Stand mixer", "Salamander"). */
+    equipment?: string[];
+
+    imageUrl?: string;
+}
+
+export interface IRecipe {
+    id: string;
+
+    restaurantId: string;
+
+    /** Display name of the recipe. */
+    name: string;
+
+    description?: string;
+
+    status: RecipeStatus;
+
+    /** ID of the menu item this recipe produces, if applicable. */
+    menuItemId?: string;
+
+    ingredients: IRecipeIngredient[];
+
+    steps: IRecipeStep[];
+
+    /** Number of portions (or other yield units) this recipe produces. */
+    yieldQuantity: number;
+
+    yieldUnit: RecipeYieldUnit;
+
+    /** Total preparation time in minutes (before cooking). */
+    prepTimeMinutes?: number;
+
+    /** Total cooking/baking time in minutes. */
+    cookTimeMinutes?: number;
+
+    allergens?: AllergenType[];
+
+    dietaryFlags?: DietaryFlag[];
+
+    /** Aggregated nutritional info for one yield unit of this recipe. */
+    nutritionalInfo?: INutritionalInfo;
+
+    /** Internal cost to produce one yield unit, calculated from ingredients. */
+    costPerYield?: number;
+
+    /** URL to a reference photo or instructional video. */
+    imageUrl?: string;
+
+    /** Free-form chef notes or plating instructions. */
+    notes?: string;
+
+    /** Version counter — increment when the recipe changes. */
+    version: number;
+
+    createdBy?: string;
+
+    createdAt: Date;
+
+    updatedAt: Date;
+}

package/src/interfaces/domain/Reservation.ts

@@ -0,0 +1,45 @@
+import { ReservationSource, ReservationStatus } from "../../enums/domain/Reservation";
+
+export interface IReservation {
+    id: string;
+
+    restaurantId: string;
+
+    customerId: string;
+
+    // Booking information
+    reservationDate: Date;
+    startTime: string;
+    endTime: string;
+
+    partySize: number;
+
+    // Status tracking
+    status: ReservationStatus;
+
+    // Table assignment
+    tableIds: string[];
+
+    // Customer requests
+    specialRequests?: string;
+
+    // Contact snapshot
+    customerName: string;
+    customerPhone?: string;
+    customerEmail?: string;
+
+    // Source of booking
+    source: ReservationSource;
+
+    // Lifecycle timestamps
+    createdAt: Date;
+    updatedAt: Date;
+    cancelledAt?: Date;
+    confirmedAt?: Date;
+    checkedInAt?: Date;
+    completedAt?: Date;
+
+    // Staff handling
+    createdBy?: string;
+    assignedEmployeeId?: string;
+}

package/src/interfaces/domain/Restaurant.ts

@@ -0,0 +1,45 @@
+import { CuisineType, RestaurantStatus, RestaurantType } from "../../enums/domain/Restaurant";
+import { IAddress } from "./Address";
+import { OperatingHours } from "./OpeningHours";
+
+export interface IRestaurant {
+    id: string;
+
+    // Basic Information
+    name: string;
+    legalName?: string;
+    description?: string;
+
+    // Contact Information
+    email?: string;
+    phone?: string;
+    website?: string;
+
+    // Address
+    address: IAddress;
+
+    // Business Information
+    businessType: RestaurantType;
+    cuisineTypes: CuisineType[];
+
+    // Operating Hours
+    operatingHours: OperatingHours[];
+
+    // Time & Currency
+    timezone: string;
+    currency: string;
+    locale: string;
+
+    // Capacity
+    seatingCapacity?: number;
+
+    // Status
+    status: RestaurantStatus;
+
+    // Branding
+    logoUrl?: string;
+
+    // Audit
+    createdAt: Date;
+    updatedAt: Date;
+}

package/src/interfaces/domain/Table.ts

@@ -0,0 +1,69 @@
+import type { TableArea, TableShape, TableStatus } from "../../enums/domain/Table";
+
+export interface ITablePosition {
+    x: number;
+    y: number;
+
+    rotation?: number;
+}
+
+export interface ITable {
+    id: string;
+
+    restaurantId: string;
+    locationId?: string;
+
+    /**
+     * Human-readable table number or identifier.
+     * Examples: "1", "12", "A5", "Patio-3"
+     */
+    number: string;
+
+    /**
+     * Optional display name.
+     */
+    name?: string;
+
+    /**
+     * Number of guests this table can comfortably seat.
+     */
+    capacity: number;
+
+    /**
+     * Physical area of the restaurant.
+     */
+    area?: TableArea;
+
+    /**
+     * Shape of the table.
+     */
+    shape?: TableShape;
+
+    /**
+     * Current operational status.
+     */
+    status: TableStatus;
+
+    /**
+     * Can this table be combined with others?
+     */
+    combinable: boolean;
+
+    /**
+     * IDs of tables that may be combined with this one.
+     */
+    combinableTableIds?: string[];
+
+    /**
+     * Optional floor plan coordinates.
+     */
+    position?: ITablePosition;
+
+    /**
+     * Notes visible to staff.
+     */
+    notes?: string;
+
+    createdAt: Date;
+    updatedAt: Date;
+}

package/src/interfaces/domain/Vendor.ts

@@ -0,0 +1,35 @@
+import { Vendor, VendorStatus, VendorType } from "../../enums/domain/Vendors";
+import { IAddress } from "./Address";
+
+
+export interface IVendor {
+    id: string;
+
+    restaurantId: string;
+
+    name: string;
+
+    vendorCode: Vendor;
+
+    type: VendorType;
+
+    status: VendorStatus;
+
+    contactName?: string;
+
+    email?: string;
+
+    phoneNumber?: string;
+
+    address?: IAddress;
+
+    taxId?: string;
+
+    website?: string;
+
+    notes?: string;
+
+    createdAt: Date;
+
+    updatedAt: Date;
+}

package/src/interfaces/index.ts

@@ -0,0 +1,17 @@
+export * from "./domain/Address";
+export * from "./domain/Employee";
+export * from "./domain/Inventory";
+export * from "./domain/Kitchen";
+export * from "./domain/Menu";
+export * from "./domain/Payment";
+export * from "./domain/Recipe";
+export * from "./domain/Restaurant";
+export * from "./domain/Table";
+export * from "./domain/Vendor";
+export * from "./domain/Delivery";
+export * from "./domain/Ingredient";
+export * from "./domain/Customer";
+export * from "./domain/Money";
+export * from "./domain/Location";
+export * from "./domain/Reservation";
+export * from "./domain/OpeningHours";

package/src/orders/OrderModule.ts

@@ -0,0 +1,17 @@
+import { Module } from "@nestjs/common";
+import { EventBridgeModule } from "../eventBridge/EventBridgeModule";
+import { SquareOrderServiceImpl } from "./services/square/SquareOrderServiceImpl";
+import { OrderSymbols } from "./ioc";
+
+@Module({
+    imports: [EventBridgeModule],
+    providers: [
+        {
+            provide:  OrderSymbols.SquareOrderService,
+            useClass: SquareOrderServiceImpl,
+        },
+    ],
+    exports: [OrderSymbols.SquareOrderService],
+})
+
+export class OrderModule {}

package/src/orders/domain/Enums.ts

@@ -0,0 +1,17 @@
+export enum OrderType {
+    DINE_IN = "DINE_IN",
+    TAKEAWAY = "TAKEAWAY",
+    DELIVERY = "DELIVERY",
+    CURBSIDE = "CURBSIDE",
+    DRIVE_THROUGH = "DRIVE_THROUGH"
+}
+
+export enum OrderStatus {
+  PENDING = "PENDING",
+  ACCEPTED = "ACCEPTED",
+  IN_PROGRESS = "IN_PROGRESS",
+  READY = "READY",
+  COMPLETED = "COMPLETED",
+  CANCELLED = "CANCELLED",
+  REFUNDED = "REFUNDED"
+}

package/src/orders/domain/Order.ts

@@ -0,0 +1,109 @@
+import { ICustomer } from "../../interfaces/domain/Customer";
+import { IEmployee } from "../../interfaces/domain/Employee";
+import { Money } from "../../interfaces/domain/Money";
+import { IOrderItem } from "./OrderItem";
+import { OrderStatus, OrderType } from "./Enums";
+import { IPayment } from "../../interfaces/domain/Payment";
+import { IVendor } from "../../interfaces/domain/Vendor";
+
+export interface IOrder {
+    /**
+     * Unique order identifier in your platform.
+     */
+    id: string;
+
+    /**
+     * Original vendor order identifier.
+     */
+    externalId: string;
+
+    /**
+     * Restaurant that owns the order.
+     */
+    restaurantId: string;
+
+    /**
+     * POS vendor.
+     */
+    vendor: IVendor;
+
+    /**
+     * Location/branch.
+     */
+    locationId: string;
+
+    /**
+     * Customer (optional).
+     */
+    customer?: ICustomer;
+
+    /**
+     * Employee who created the order.
+     */
+    employee?: IEmployee;
+
+    /**
+     * Ordered items.
+     */
+    items: IOrderItem[];
+
+    /**
+     * Current order status.
+     */
+    status: OrderStatus;
+
+    /**
+     * Order type.
+     */
+    type: OrderType;
+
+    /**
+     * Subtotal before discounts and taxes.
+     */
+    subtotal: Money;
+
+    /**
+     * Total discount.
+     */
+    discount: Money;
+
+    /**
+     * Total tax.
+     */
+    tax: Money;
+
+    /**
+     * Tip amount.
+     */
+    tip: Money;
+
+    /**
+     * Final amount paid.
+     */
+    total: Money;
+
+    /**
+     * Payment information.
+     */
+    payments: IPayment[];
+
+    /**
+     * Optional notes.
+     */
+    notes?: string;
+
+    /**
+     * Date/time the order was created.
+     */
+    createdAt: Date;
+
+    /**
+     * Date/time last updated.
+     */
+    updatedAt: Date;
+
+    /**
+     * Date/time completed.
+     */
+    completedAt?: Date;
+}

package/src/orders/domain/OrderItem.ts

@@ -0,0 +1,68 @@
+import { Money } from "../../interfaces/domain/Money";
+
+export interface IOrderItemModifier {
+    id: string;
+
+    name: string;
+
+    quantity?: number;
+
+    price?: Money;
+}
+
+export interface IOrderItem {
+    /**
+     * Unique identifier of the line item.
+     */
+    id: string;
+
+    /**
+     * Product/Menu item identifier.
+     */
+    productId: string;
+
+    /**
+     * Display name.
+     */
+    name: string;
+
+    /**
+     * Category (Burger, Drinks, Dessert, etc.)
+     */
+    category?: string;
+
+    /**
+     * Quantity ordered.
+     */
+    quantity: number;
+
+    /**
+     * Unit selling price.
+     */
+    unitPrice: Money;
+
+    /**
+     * Total discount applied to this item.
+     */
+    discount?: Money;
+
+    /**
+     * Tax applied to this item.
+     */
+    tax?: Money;
+
+    /**
+     * Final total for this line.
+     */
+    total: Money;
+
+    /**
+     * Optional modifiers.
+     */
+    modifiers?: IOrderItemModifier[];
+
+    /**
+     * Free-text note from customer.
+     */
+    notes?: string;
+}