@novha/anlia-core-lib 0.1.0

package/src/events/domain/TableEvents.ts

@@ -0,0 +1,102 @@
+import { DomainEvent } from "./DomainEvent";
+import { ITable } from "../../interfaces/domain/Table";
+import { TableStatus } from "../../enums/domain/Table";
+
+// ─── Lifecycle Events ──────────────────────────────────────────────────────────
+
+export interface TableCreated extends DomainEvent {
+    eventType: "TableCreated";
+    aggregateType: "Table";
+    table: ITable;
+}
+
+export interface TableUpdated extends DomainEvent {
+    eventType: "TableUpdated";
+    aggregateType: "Table";
+    before: Partial<ITable>;
+    after: Partial<ITable>;
+}
+
+// ─── Status Events ─────────────────────────────────────────────────────────────
+
+export interface TableOpened extends DomainEvent {
+    eventType: "TableOpened";
+    aggregateType: "Table";
+    previousStatus: TableStatus;
+    openedBy?: string;
+}
+
+export interface TableOccupied extends DomainEvent {
+    eventType: "TableOccupied";
+    aggregateType: "Table";
+    partySize: number;
+    reservationId?: string;
+    seatedBy?: string;
+    occupiedAt: Date;
+}
+
+export interface TableReserved extends DomainEvent {
+    eventType: "TableReserved";
+    aggregateType: "Table";
+    reservationId: string;
+    reservedAt: Date;
+    reservedBy?: string;
+}
+
+export interface TableReleased extends DomainEvent {
+    eventType: "TableReleased";
+    aggregateType: "Table";
+    previousStatus: TableStatus;
+    releasedBy?: string;
+    releasedAt: Date;
+}
+
+// ─── Combination Events ────────────────────────────────────────────────────────
+
+export interface TableMerged extends DomainEvent {
+    eventType: "TableMerged";
+    aggregateType: "Table";
+    /** IDs of all tables joined into this combined group. */
+    mergedTableIds: string[];
+    combinedCapacity: number;
+    mergedBy?: string;
+}
+
+export interface TableSplit extends DomainEvent {
+    eventType: "TableSplit";
+    aggregateType: "Table";
+    /** IDs of tables that were part of the combined group before the split. */
+    previousTableIds: string[];
+    splitBy?: string;
+}
+
+// ─── Service Events ────────────────────────────────────────────────────────────
+
+export interface TableOutOfService extends DomainEvent {
+    eventType: "TableOutOfService";
+    aggregateType: "Table";
+    reason?: string;
+    markedBy?: string;
+    markedAt: Date;
+}
+
+export interface TableReturnedToService extends DomainEvent {
+    eventType: "TableReturnedToService";
+    aggregateType: "Table";
+    returnedBy?: string;
+    returnedAt: Date;
+}
+
+// ─── Union Type ────────────────────────────────────────────────────────────────
+
+export type TableEvent =
+    | TableCreated
+    | TableUpdated
+    | TableOpened
+    | TableOccupied
+    | TableReserved
+    | TableReleased
+    | TableMerged
+    | TableSplit
+    | TableOutOfService
+    | TableReturnedToService;

package/src/events/domain/VendorEvents.ts

@@ -0,0 +1,42 @@
+import { DomainEvent } from "./DomainEvent";
+import { IVendor } from "../../interfaces/domain/Vendor";
+import { VendorStatus } from "../../enums/domain/Vendors";
+
+
+// ─── Lifecycle Events ──────────────────────────────────────────────────────────
+
+export interface VendorCreated extends DomainEvent {
+    eventType: "VendorCreated";
+    aggregateType: "Vendor";
+    vendor: IVendor;
+}
+
+export interface VendorUpdated extends DomainEvent {
+    eventType: "VendorUpdated";
+    aggregateType: "Vendor";
+    before: Partial<IVendor>;
+    after: Partial<IVendor>;
+}
+
+export interface VendorActivated extends DomainEvent {
+    eventType: "VendorActivated";
+    aggregateType: "Vendor";
+    previousStatus: VendorStatus;
+    activatedBy?: string;
+}
+
+export interface VendorDeactivated extends DomainEvent {
+    eventType: "VendorDeactivated";
+    aggregateType: "Vendor";
+    previousStatus: VendorStatus;
+    reason?: string;
+    deactivatedBy?: string;
+}
+
+// ─── Union Type ────────────────────────────────────────────────────────────────
+
+export type VendorEvent =
+    | VendorCreated
+    | VendorUpdated
+    | VendorActivated
+    | VendorDeactivated;

package/src/events/index.ts

@@ -0,0 +1,13 @@
+export * from "./domain/VendorEvents";
+export * from "./domain/RestaurantEvents";
+export * from "./domain/TableEvents";
+export * from "./domain/EmployeeEvents";
+export * from "./domain/CustomerEvents";
+export * from "./domain/ReservationEvents";
+export * from "./domain/OrderEvents";
+export * from "./domain/PaymentEvents";
+export * from "./domain/RecipeEvents";
+export * from "./domain/InventoryEvents";
+export * from "./domain/DeliveryEvents";
+export * from "./domain/DomainEvent";
+export * from "./domain/DomainEventType";

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from "./events";
+export * from "./enums";
+export * from "./orders";
+export * from "./interfaces";

package/src/interfaces/domain/Address.ts

@@ -0,0 +1,7 @@
+export interface IAddress {
+    street?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+}

package/src/interfaces/domain/Customer.ts

@@ -0,0 +1,33 @@
+import { IAddress } from "./Address";
+
+export interface ICustomer {
+    /**
+     * Internal customer identifier.
+     */
+    id: string;
+
+    /**
+     * Vendor customer identifier.
+     */
+    externalId?: string;
+
+    firstName?: string;
+
+    lastName?: string;
+
+    fullName?: string;
+
+    email?: string;
+
+    phoneNumber?: string;
+
+    loyaltyId?: string;
+
+    dateOfBirth?: Date;
+
+    address?: IAddress;
+
+    createdAt?: Date;
+
+    updatedAt?: Date;
+}

package/src/interfaces/domain/Delivery.ts

@@ -0,0 +1,96 @@
+import { DeliveryProvider, DeliveryStatus } from "../../enums/domain/Delivery";
+import { IAddress } from "./Address";
+import { Money } from "./Money";
+
+export interface IDeliveryDriver {
+    id?: string;
+
+    name: string;
+
+    phoneNumber?: string;
+
+    /** External driver ID from the delivery provider. */
+    externalId?: string;
+
+    /** Real-time latitude of the driver. */
+    latitude?: number;
+
+    /** Real-time longitude of the driver. */
+    longitude?: number;
+}
+
+export interface IDeliveryTracking {
+    /** Current latitude of the delivery. */
+    latitude?: number;
+
+    /** Current longitude of the delivery. */
+    longitude?: number;
+
+    /** Estimated arrival time. */
+    estimatedArrivalAt?: Date;
+
+    lastUpdatedAt: Date;
+}
+
+export interface IDeliveryProvider {
+    /** Name of the delivery provider. */
+    name: string;
+
+    code: DeliveryProvider;
+
+    /** External delivery identifier from the provider. */
+    externalId?: string;
+
+    /** Tracking URL for the delivery, if available. */
+    trackingUrl?: string;
+}
+
+export interface IDelivery {
+    id: string;
+
+    restaurantId: string;
+
+    orderId: string;
+
+    /** External delivery identifier from the provider. */
+    externalId?: string;
+
+    provider: IDeliveryProvider;
+
+    status: DeliveryStatus;
+
+    driver?: IDeliveryDriver;
+
+    /** Destination address for the delivery. */
+    deliveryAddress: IAddress;
+
+    /** Delivery fee charged to the customer. */
+    deliveryFee?: Money;
+
+    /** Tip for the driver. */
+    driverTip?: Money;
+
+    /** Estimated delivery time in minutes from order placement. */
+    estimatedDeliveryMinutes?: number;
+
+    /** Distance to the delivery address in kilometres. */
+    distanceKm?: number;
+
+    tracking?: IDeliveryTracking;
+
+    /** Free-text delivery instructions from the customer. */
+    deliveryInstructions?: string;
+
+    /** Reason for failure or cancellation, if applicable. */
+    failureReason?: string;
+
+    scheduledAt?: Date;
+
+    pickedUpAt?: Date;
+
+    deliveredAt?: Date;
+
+    createdAt: Date;
+
+    updatedAt: Date;
+}

package/src/interfaces/domain/Employee.ts

@@ -0,0 +1,29 @@
+import { EmployeeRole } from "../../enums/domain/Employee";
+
+export interface IEmployee {
+    /**
+     * Internal employee identifier.
+     */
+    id: string;
+
+    /**
+     * Vendor employee identifier.
+     */
+    externalId?: string;
+
+    firstName: string;
+
+    lastName: string;
+
+    fullName?: string;
+
+    email?: string;
+
+    phoneNumber?: string;
+
+    role: EmployeeRole;
+
+    active: boolean;
+
+    hiredAt?: Date;
+}

package/src/interfaces/domain/Ingredient.ts

@@ -0,0 +1,68 @@
+import { InventoryUnit } from "../../enums/domain/Inventory";
+import { Money } from "./Money";
+import { IngredientStatus, AllergenType, DietaryFlag } from "../../enums/domain/Ingredient";
+
+export interface INutritionalInfo {
+    /** Per 100 g or 100 ml of the ingredient. */
+    per100g: boolean;
+
+    calories?: number;
+
+    protein?: number;
+
+    carbohydrates?: number;
+
+    sugar?: number;
+
+    fat?: number;
+
+    saturatedFat?: number;
+
+    fiber?: number;
+
+    sodium?: number;
+}
+
+export interface IIngredient {
+    id: string;
+
+    restaurantId: string;
+
+    /** Human-readable name (e.g. "Whole Wheat Flour"). */
+    name: string;
+
+    /** Optional short code used in recipes and purchase orders. */
+    sku?: string;
+
+    description?: string;
+
+    status: IngredientStatus;
+
+    /** Unit used when measuring this ingredient in recipes. */
+    unit: InventoryUnit;
+
+    /** Standard purchase cost per unit. */
+    unitCost?: Money;
+
+    /** Link to the corresponding inventory item. */
+    inventoryItemId?: string;
+
+    allergens?: AllergenType[];
+
+    dietaryFlags?: DietaryFlag[];
+
+    nutritionalInfo?: INutritionalInfo;
+
+    /** Storage location or section (e.g. "Walk-in Cooler", "Dry Storage"). */
+    storageLocation?: string;
+
+    /** Minimum shelf life in days after opening. */
+    shelfLifeDays?: number;
+
+    /** Supplier or vendor reference. */
+    supplierId?: string;
+
+    createdAt: Date;
+
+    updatedAt: Date;
+}

package/src/interfaces/domain/Inventory.ts

@@ -0,0 +1,52 @@
+import { InventoryCategory, InventoryStatus, InventoryUnit } from "../../enums/domain/Inventory";
+
+export interface IInventoryItem {
+    id: string;
+
+    restaurantId: string;
+
+    // Basic information
+    name: string;
+    sku: string;
+    category: InventoryCategory;
+
+    // Measurement
+    unit: InventoryUnit;
+
+    // Stock levels
+    quantityOnHand: number;
+    minimumStockLevel: number;
+    maximumStockLevel?: number;
+
+    // Cost
+    unitCost: number;
+
+    // Supplier
+    vendorId?: string;
+
+    // Storage
+    location?: string;
+
+    // Expiration
+    expiryDate?: Date;
+
+    status: InventoryStatus;
+
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+export interface IInventory {
+
+    id: string;
+
+    restaurantId: string;
+
+
+    items: IInventoryItem[];
+
+
+    createdAt: Date;
+
+    updatedAt: Date;
+}

package/src/interfaces/domain/Kitchen.ts

@@ -0,0 +1,128 @@
+import {
+    KitchenItemStatus,
+    KitchenPriority,
+    KitchenStationStatus,
+    KitchenStationType,
+    KitchenStatus,
+    KitchenTicketStatus
+} from "../../enums/domain/Kitchen";
+
+export interface KitchenStation {
+    id: string;
+
+    kitchenId: string;
+
+    name: string;
+
+    type: KitchenStationType;
+
+    status: KitchenStationStatus;
+
+    createdAt: Date;
+}
+
+export interface Kitchen {
+    id: string;
+
+    restaurantId: string;
+
+    name: string;
+
+    status: KitchenStatus;
+
+    stations: KitchenStation[];
+
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+export interface KitchenTicket {
+
+    id: string;
+
+    restaurantId: string;
+
+    orderId: string;
+
+    stationId?: string;
+
+
+    items: KitchenTicketItem[];
+
+
+    status: KitchenTicketStatus;
+
+
+    priority: KitchenPriority;
+
+
+    createdAt: Date;
+
+    startedAt?: Date;
+
+    completedAt?: Date;
+}
+
+export interface KitchenTicketItem {
+
+    id: string;
+
+    /**
+     * Parent kitchen ticket
+     */
+    kitchenTicketId: string;
+
+
+    /**
+     * Original order item reference
+     */
+    orderItemId: string;
+
+
+    /**
+     * Menu item being prepared
+     */
+    menuItemId: string;
+
+
+    /**
+     * Snapshot of item name at preparation time
+     * (important if menu changes later)
+     */
+    menuItemName: string;
+
+
+    /**
+     * Number of items to prepare
+     */
+    quantity: number;
+
+
+    /**
+     * Kitchen preparation status
+     */
+    status: KitchenItemStatus;
+
+
+    /**
+     * Preparation instructions
+     */
+    notes?: string;
+
+
+    /**
+     * Which kitchen station handles it
+     */
+    stationId?: string;
+
+
+    /**
+     * Timing information
+     */
+    startedAt?: Date;
+
+    completedAt?: Date;
+
+
+    createdAt: Date;
+}

package/src/interfaces/domain/Location.ts

@@ -0,0 +1,20 @@
+export interface ILocation {
+    id?: string;
+
+    name?: string;
+
+    addressLine1: string;
+    addressLine2?: string;
+
+    city: string;
+    stateOrProvince: string;
+    postalCode: string;
+    country: string;
+
+    latitude?: number;
+    longitude?: number;
+
+    timezone?: string;
+
+    instructions?: string;
+}