@freedom_sky/feige-lib 5.21.0 → 5.22.0

package/CHANGE.md

@@ -1,3 +1,5 @@
+# 5.22.0
+- add Reservation and ReservationDish interfaces for cross-repo reservation feature (ReservationDish.type uses DishType enum; Reservation.status uses ReservationStatusEnum; Reservation.addTime accepts Date | string for BSON/wire compatibility)
 # 5.21.0
 - add ReservationStatusEnum (WAITING / CANCELLED / COMPLETED) for cross-repo reservation feature
 - add UPPER_LIMIT constants: COMMON_HEADCOUNT_MAX, COMMON_CONTACT_NAME_MAX_LENGTH, COMMON_CONTACT_PHONE_MAX_LENGTH, DISH_COUNT_MAX, DISH_NOTE_MAX_LENGTH, RESERVATION_NOTE_MAX_LENGTH

package/dist/index.d.ts

@@ -37,6 +37,7 @@ export * from './interfaces/store/specification.interface';
 export * from './interfaces/store/menu-export.interface';
 export { MenuImportModeEnum } from './enum/menu-io.enum';
 export * from './interfaces/order';
+export * from './interfaces/reservation/reservation.interface';
 export { PayCompanyEnum } from './enum/pay-company.enum';
 import * as moment from 'moment';
 import Big from 'big.js';

package/dist/interfaces/reservation/reservation.interface.d.ts

@@ -0,0 +1,46 @@
+import { ReservationStatusEnum } from '../../enum/reservation.enum';
+import { DishType } from '../../enum/dish.enum';
+export interface ReservationDish {
+    readonly dishId: string;
+    readonly count: number;
+    /** Used to flag weight-priced dishes. */
+    readonly type: DishType;
+    /** For dishes priced by weight. Only meaningful when type === DishType.Weigh. */
+    readonly weight?: number;
+    readonly specifications?: Array<{
+        readonly _id: string;
+        readonly selectedItems: string[];
+    }>;
+    readonly note?: string;
+}
+export interface Reservation {
+    readonly _id: string;
+    readonly storeId: string;
+    /** ISO local string "YYYY-MM-DDTHH:mm" — no seconds, no timezone. */
+    readonly reservationTime: string;
+    readonly headcount: number;
+    readonly contactName: string;
+    readonly contactPhone?: string;
+    readonly contactEmail?: string;
+    readonly tableNum?: string;
+    readonly reservationNote?: string;
+    readonly dishes: ReservationDish[];
+    readonly status: ReservationStatusEnum;
+    /**
+     * `Date` inside the server process (mongoose returns a Date instance);
+     * ISO `string` once the document has crossed JSON.stringify (HTTP wire,
+     * app side). Same dual-shape convention as `BaseOrder.date`. Normalize
+     * with `new Date(addTime)` if you need to do math — that constructor
+     * accepts either form.
+     */
+    readonly addTime: Date | string;
+    readonly operatorId?: string;
+    /**
+     * Set when this reservation has been bound to a real order via
+     * POST /orders. Optional: a reservation can also be marked COMPLETED
+     * without a backing order (e.g. manual no-show close-out).
+     */
+    readonly boundOrderId?: string;
+    /** Mongoose default version key — present on every document. */
+    readonly __v?: number;
+}

package/dist/interfaces/reservation/reservation.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freedom_sky/feige-lib",
-  "version": "5.21.0",
+  "version": "5.22.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/src/index.ts

@@ -38,6 +38,7 @@ export * from './interfaces/store/specification.interface';
 export * from './interfaces/store/menu-export.interface';
 export { MenuImportModeEnum } from './enum/menu-io.enum';
 export * from './interfaces/order';
+export * from './interfaces/reservation/reservation.interface';
 export { PayCompanyEnum } from './enum/pay-company.enum';
 import * as moment from 'moment';
 import Big from 'big.js';

package/src/interfaces/reservation/reservation.interface.ts

@@ -0,0 +1,48 @@
+import { ReservationStatusEnum } from '../../enum/reservation.enum';
+import { DishType } from '../../enum/dish.enum';
+
+export interface ReservationDish {
+    readonly dishId: string;
+    readonly count: number;
+    /** Used to flag weight-priced dishes. */
+    readonly type: DishType;
+    /** For dishes priced by weight. Only meaningful when type === DishType.Weigh. */
+    readonly weight?: number;
+    readonly specifications?: Array<{
+        readonly _id: string;
+        readonly selectedItems: string[];
+    }>;
+    readonly note?: string;
+}
+
+export interface Reservation {
+    readonly _id: string;
+    readonly storeId: string;
+    /** ISO local string "YYYY-MM-DDTHH:mm" — no seconds, no timezone. */
+    readonly reservationTime: string;
+    readonly headcount: number;
+    readonly contactName: string;
+    readonly contactPhone?: string;
+    readonly contactEmail?: string;
+    readonly tableNum?: string;
+    readonly reservationNote?: string;
+    readonly dishes: ReservationDish[];
+    readonly status: ReservationStatusEnum;
+    /**
+     * `Date` inside the server process (mongoose returns a Date instance);
+     * ISO `string` once the document has crossed JSON.stringify (HTTP wire,
+     * app side). Same dual-shape convention as `BaseOrder.date`. Normalize
+     * with `new Date(addTime)` if you need to do math — that constructor
+     * accepts either form.
+     */
+    readonly addTime: Date | string;
+    readonly operatorId?: string;
+    /**
+     * Set when this reservation has been bound to a real order via
+     * POST /orders. Optional: a reservation can also be marked COMPLETED
+     * without a backing order (e.g. manual no-show close-out).
+     */
+    readonly boundOrderId?: string;
+    /** Mongoose default version key — present on every document. */
+    readonly __v?: number;
+}