@freedom_sky/feige-lib 5.21.0 → 5.23.0

package/src/interfaces/common/language.interface.ts

@@ -1,13 +1,13 @@
-import { DateFormat } from '../../enum/common.enum';
-export interface LanguageItem {
-    readonly name: string;
-    readonly img: string; // 语言对应图片的url
-    readonly code: string;
-    readonly speechCode: string;
-    readonly speechLang?: string;
-    readonly fontFamily?: string;
-    readonly dateFormat: DateFormat;
-    readonly defaultAreaCode: string;
-    readonly rtl?: boolean;
-    readonly codepage: string;
-}
+import { DateFormat } from '../../enum/common.enum';
+export interface LanguageItem {
+    readonly name: string;
+    readonly img: string; // 语言对应图片的url
+    readonly code: string;
+    readonly speechCode: string;
+    readonly speechLang?: string;
+    readonly fontFamily?: string;
+    readonly dateFormat: DateFormat;
+    readonly defaultAreaCode: string;
+    readonly rtl?: boolean;
+    readonly codepage: string;
+}

package/src/interfaces/member/member-transaction.interface.ts

@@ -1,32 +1,32 @@
-import { MemberTransactionTypeEnum, MemberSendTypeEnum } from '../../enum/member.enum';
-import { MemberCheckoutTypeEnum } from '../../enum/checkout.enum';
-export interface MemberTransaction {
-    _id?: string;
-    memberId: string;
-    storeId: string;
-    type: MemberTransactionTypeEnum;
-    balance: number;
-    value: number;
-    createDate: Date;
-
-    orderId: string; // 消费类型的时候记录订单id，退款的时候记录退款的订单id
-
-    note: string; //补录和扣除的备注
-    salesman: string; //补录和扣除的操作人id
-
-    canceledSavingId: string; // 取消的会员充值交易id
-
-    savingRule: {
-        // 存储类型的时候记录存储方式快照
-        savingValue: number;
-        sendValue: number;
-        sendType: MemberSendTypeEnum;
-        description: string;
-    };
-    checkout: {
-        type: MemberCheckoutTypeEnum;
-        amount: number;
-        retreated: boolean;
-        payRecordId: string;
-    };
-}
+import { MemberTransactionTypeEnum, MemberSendTypeEnum } from '../../enum/member.enum';
+import { MemberCheckoutTypeEnum } from '../../enum/checkout.enum';
+export interface MemberTransaction {
+    _id?: string;
+    memberId: string;
+    storeId: string;
+    type: MemberTransactionTypeEnum;
+    balance: number;
+    value: number;
+    createDate: Date;
+
+    orderId: string; // 消费类型的时候记录订单id，退款的时候记录退款的订单id
+
+    note: string; //补录和扣除的备注
+    salesman: string; //补录和扣除的操作人id
+
+    canceledSavingId: string; // 取消的会员充值交易id
+
+    savingRule: {
+        // 存储类型的时候记录存储方式快照
+        savingValue: number;
+        sendValue: number;
+        sendType: MemberSendTypeEnum;
+        description: string;
+    };
+    checkout: {
+        type: MemberCheckoutTypeEnum;
+        amount: number;
+        retreated: boolean;
+        payRecordId: string;
+    };
+}

package/src/interfaces/member/member.interface.ts

@@ -1,16 +1,16 @@
-import { MemberSexEnum } from '../../enum/member.enum';
-export interface Member {
-    readonly _id: string;
-    readonly storeId: string;
-    readonly mobile: string;
-    readonly name: string;
-    readonly sex: MemberSexEnum;
-    readonly countryCode: string;
-    readonly enable: boolean;
-    readonly credit: boolean;
-    readonly note: string;
-    readonly balance: number;
-    readonly salesman: string;
-    readonly birthday: Date;
-    readonly createDate: Date;
-}
+import { MemberSexEnum } from '../../enum/member.enum';
+export interface Member {
+    readonly _id: string;
+    readonly storeId: string;
+    readonly mobile: string;
+    readonly name: string;
+    readonly sex: MemberSexEnum;
+    readonly countryCode: string;
+    readonly enable: boolean;
+    readonly credit: boolean;
+    readonly note: string;
+    readonly balance: number;
+    readonly salesman: string;
+    readonly birthday: Date;
+    readonly createDate: Date;
+}

package/src/interfaces/order/baseOrder.interface.ts

@@ -1,89 +1,89 @@
-import { DishSnapshot } from '../store/dishSnapshot.interface';
-import { PrintStatusEnum } from '../../enum/printer.enum';
-import { OrderTypeEnum } from '../../enum/order.enum';
-import { TaxTypeEnum } from '../../enum/tax.enum';
-
-export interface BaseOrder {
-    readonly _id: string;
-    readonly serialOrderId: string;
-    readonly type: OrderTypeEnum;
-    readonly note?: string;
-    readonly merchantNote?: string;
-    readonly printerPrinted: string[];
-    readonly kdsPrinted: string[];
-    readonly printStatus: PrintStatusEnum;
-    readonly content: Content[];
-    readonly storeId: string;
-    readonly clientId: string;
-    readonly date: Date | string;
-    readonly autoCleanTime?: Date | string;
-    readonly status: string;
-    readonly checkoutFirst: boolean;
-    readonly salesmanId: string;
-    readonly __v: number;
-    readonly process?: Process[];
-    readonly checkout?: Checkout[];
-    readonly payed: boolean;
-    readonly retreated?: boolean;
-    readonly noTax?: boolean;
-    readonly taxType?: TaxTypeEnum;
-    readonly priceHaveTaxBindOrderTaxes?: {
-        name: string;
-        rate: number;
-    }[];
-    readonly taxes?: {
-        name: string;
-        volume: number;
-    }[];
-}
-
-export interface Content {
-    _id?: string;
-    dishSnapshot: DishSnapshot;
-    count: number;
-    weight?: number;
-    note?: string;
-    delivering?: number;
-    finished?: number;
-    retreated?: number;
-    retreatReason?: string;
-    date?: Date | string;
-}
-
-export interface Task {
-    _id: string;
-    type: string;
-    date: Date | string;
-    dishGroupId?: string;
-    status: string;
-    operatorId?: string;
-    outletNum?: number;
-    count?: number;
-    callReason?: string;
-    content?: Content[];
-    valet?: boolean;
-    printerPrinted: string[];
-    kdsPrinted: string[];
-    printStatus: PrintStatusEnum;
-    clientId: string;
-}
-
-export interface Process {
-    readonly _id?: string;
-    readonly type: string;
-    readonly value: number;
-    readonly volume?: number;
-}
-
-export interface Checkout {
-    readonly _id?: string;
-    readonly type: string;
-    readonly customType?: string;
-    readonly amount: number;
-    readonly realCash?: number;
-    readonly retreated?: boolean;
-    readonly date?: Date | string;
-    readonly payRecordId?: string;
-    readonly memberTransactionId?: string;
-    readonly operatorId?: string;
-}
+import { DishSnapshot } from '../store/dishSnapshot.interface';
+import { PrintStatusEnum } from '../../enum/printer.enum';
+import { OrderTypeEnum } from '../../enum/order.enum';
+import { TaxTypeEnum } from '../../enum/tax.enum';
+
+export interface BaseOrder {
+    readonly _id: string;
+    readonly serialOrderId: string;
+    readonly type: OrderTypeEnum;
+    readonly note?: string;
+    readonly merchantNote?: string;
+    readonly printerPrinted: string[];
+    readonly kdsPrinted: string[];
+    readonly printStatus: PrintStatusEnum;
+    readonly content: Content[];
+    readonly storeId: string;
+    readonly clientId: string;
+    readonly date: Date | string;
+    readonly autoCleanTime?: Date | string;
+    readonly status: string;
+    readonly checkoutFirst: boolean;
+    readonly salesmanId: string;
+    readonly __v: number;
+    readonly process?: Process[];
+    readonly checkout?: Checkout[];
+    readonly payed: boolean;
+    readonly retreated?: boolean;
+    readonly noTax?: boolean;
+    readonly taxType?: TaxTypeEnum;
+    readonly priceHaveTaxBindOrderTaxes?: {
+        name: string;
+        rate: number;
+    }[];
+    readonly taxes?: {
+        name: string;
+        volume: number;
+    }[];
+}
+
+export interface Content {
+    _id?: string;
+    dishSnapshot: DishSnapshot;
+    count: number;
+    weight?: number;
+    note?: string;
+    delivering?: number;
+    finished?: number;
+    retreated?: number;
+    retreatReason?: string;
+    date?: Date | string;
+}
+
+export interface Task {
+    _id: string;
+    type: string;
+    date: Date | string;
+    dishGroupId?: string;
+    status: string;
+    operatorId?: string;
+    outletNum?: number;
+    count?: number;
+    callReason?: string;
+    content?: Content[];
+    valet?: boolean;
+    printerPrinted: string[];
+    kdsPrinted: string[];
+    printStatus: PrintStatusEnum;
+    clientId: string;
+}
+
+export interface Process {
+    readonly _id?: string;
+    readonly type: string;
+    readonly value: number;
+    readonly volume?: number;
+}
+
+export interface Checkout {
+    readonly _id?: string;
+    readonly type: string;
+    readonly customType?: string;
+    readonly amount: number;
+    readonly realCash?: number;
+    readonly retreated?: boolean;
+    readonly date?: Date | string;
+    readonly payRecordId?: string;
+    readonly memberTransactionId?: string;
+    readonly operatorId?: string;
+}

package/src/interfaces/order/buffetOrder.interface.ts

@@ -1,14 +1,14 @@
-import { TableOrder } from './tableOrder.interface';
-import { BuffetCombosItems } from '../store/store.interface';
-
-export interface BuffetOrder extends TableOrder {
-    readonly buffet: {
-        snapshot: BuffetCombosItems;
-        taxes: {
-            name: string;
-            rate: number;
-        }[];
-    };
-    readonly adultNum: number;
-    readonly childNum: number;
-}
+import { TableOrder } from './tableOrder.interface';
+import { BuffetCombosItems } from '../store/store.interface';
+
+export interface BuffetOrder extends TableOrder {
+    readonly buffet: {
+        snapshot: BuffetCombosItems;
+        taxes: {
+            name: string;
+            rate: number;
+        }[];
+    };
+    readonly adultNum: number;
+    readonly childNum: number;
+}

package/src/interfaces/order/deliveryOrder.interface.ts

@@ -1,10 +1,10 @@
-import { BaseOrder } from './baseOrder.interface';
-
-export interface DeliveryOrder extends BaseOrder {
-    readonly selfPickUp: false;
-    readonly phoneNum: string;
-    readonly deliveryFee: number;
-    readonly address: string;
-    readonly nickName: string;
-    readonly reserveTime?: Date;
-}
+import { BaseOrder } from './baseOrder.interface';
+
+export interface DeliveryOrder extends BaseOrder {
+    readonly selfPickUp: false;
+    readonly phoneNum: string;
+    readonly deliveryFee: number;
+    readonly address: string;
+    readonly nickName: string;
+    readonly reserveTime?: Date;
+}

package/src/interfaces/order/index.ts

@@ -1,7 +1,7 @@
-export * from './deliveryOrder.interface';
-export * from './pickupOrder.interface';
-export * from './order.interface';
-export * from './buffetOrder.interface';
-export * from './tableOrder.interface';
-export * from './serialOrder.interface';
-export * from './baseOrder.interface';
+export * from './deliveryOrder.interface';
+export * from './pickupOrder.interface';
+export * from './order.interface';
+export * from './buffetOrder.interface';
+export * from './tableOrder.interface';
+export * from './serialOrder.interface';
+export * from './baseOrder.interface';

package/src/interfaces/order/order.interface.ts

@@ -1,84 +1,84 @@
-import { DishSnapshot } from '../store/dishSnapshot.interface';
-import { PrintStatusEnum } from '../../enum/printer.enum';
-import { DeliveryOrder } from './deliveryOrder.interface';
-import { PickUpOrder } from './pickupOrder.interface';
-import { TableOrder } from './tableOrder.interface';
-import { BuffetOrder } from './buffetOrder.interface';
-import { SerialOrder } from './serialOrder.interface';
-import { OrderTypeEnum, TaxTypeEnum } from '../../index';
-import { Content } from './baseOrder.interface';
-import { Task } from './baseOrder.interface';
-import { Process } from './baseOrder.interface';
-import { Checkout } from './baseOrder.interface';
-import { BuffetCombosItems } from '../store/store.interface';
-
-export interface Order {
-    readonly _id: string;
-    readonly serialOrderId: string;
-    readonly type: OrderTypeEnum;
-    readonly tableNum?: string;
-    readonly serialNum?: string;
-    readonly phoneNum?: string;
-    readonly deliveryFee?: number;
-    readonly address?: string;
-    readonly nickName?: string;
-    readonly note?: string;
-    readonly merchantNote?: string;
-    readonly printerPrinted: string[];
-    readonly kdsPrinted: string[];
-    readonly printStatus: PrintStatusEnum;
-    readonly content: Content[];
-    readonly tasks: Task[];
-    readonly storeId: string;
-    readonly clientId: string;
-    readonly date: Date | string;
-    readonly autoCleanTime?: Date | string;
-    readonly status: string;
-    readonly checkoutFirst: boolean;
-    readonly operatorId: string;
-    readonly salesmanId: string;
-    readonly __v: number;
-    readonly process?: Process[];
-    readonly checkout?: Checkout[];
-    readonly payed: boolean;
-    readonly retreated?: boolean;
-    readonly noTax?: boolean;
-    readonly taxType?: TaxTypeEnum;
-    readonly reserveTime?: Date;
-    readonly selfPickUp?: boolean;
-    readonly selfPickUpUseDeliveryMenu?: boolean; //自取使用外卖价格, false表示使用堂食价格
-    readonly pack?: boolean;
-    readonly priceHaveTaxBindOrderTaxes?: {
-        name: string;
-        rate: number;
-    }[];
-    readonly taxes?: {
-        name: string;
-        volume: number;
-    }[];
-    readonly buffet?: {
-        snapshot: BuffetCombosItems;
-        taxes: {
-            name: string;
-            rate: number;
-        }[];
-    };
-    readonly adultNum?: number;
-    readonly childNum?: number;
-}
-
-export type AnyOrder = TableOrder | BuffetOrder | SerialOrder | DeliveryOrder | PickUpOrder;
-
-/**
- * @param order
- */
-export function isTableOrder(order: Order): order is TableOrder {
-    return order.type === OrderTypeEnum.Table;
-}
-
-/**
- * @param order
- */
-export function isBuffetOrder(order: Order): order is TableOrder {
-    return order.type === OrderTypeEnum.Buffet;
-}
+import { DishSnapshot } from '../store/dishSnapshot.interface';
+import { PrintStatusEnum } from '../../enum/printer.enum';
+import { DeliveryOrder } from './deliveryOrder.interface';
+import { PickUpOrder } from './pickupOrder.interface';
+import { TableOrder } from './tableOrder.interface';
+import { BuffetOrder } from './buffetOrder.interface';
+import { SerialOrder } from './serialOrder.interface';
+import { OrderTypeEnum, TaxTypeEnum } from '../../index';
+import { Content } from './baseOrder.interface';
+import { Task } from './baseOrder.interface';
+import { Process } from './baseOrder.interface';
+import { Checkout } from './baseOrder.interface';
+import { BuffetCombosItems } from '../store/store.interface';
+
+export interface Order {
+    readonly _id: string;
+    readonly serialOrderId: string;
+    readonly type: OrderTypeEnum;
+    readonly tableNum?: string;
+    readonly serialNum?: string;
+    readonly phoneNum?: string;
+    readonly deliveryFee?: number;
+    readonly address?: string;
+    readonly nickName?: string;
+    readonly note?: string;
+    readonly merchantNote?: string;
+    readonly printerPrinted: string[];
+    readonly kdsPrinted: string[];
+    readonly printStatus: PrintStatusEnum;
+    readonly content: Content[];
+    readonly tasks: Task[];
+    readonly storeId: string;
+    readonly clientId: string;
+    readonly date: Date | string;
+    readonly autoCleanTime?: Date | string;
+    readonly status: string;
+    readonly checkoutFirst: boolean;
+    readonly operatorId: string;
+    readonly salesmanId: string;
+    readonly __v: number;
+    readonly process?: Process[];
+    readonly checkout?: Checkout[];
+    readonly payed: boolean;
+    readonly retreated?: boolean;
+    readonly noTax?: boolean;
+    readonly taxType?: TaxTypeEnum;
+    readonly reserveTime?: Date;
+    readonly selfPickUp?: boolean;
+    readonly selfPickUpUseDeliveryMenu?: boolean; //自取使用外卖价格, false表示使用堂食价格
+    readonly pack?: boolean;
+    readonly priceHaveTaxBindOrderTaxes?: {
+        name: string;
+        rate: number;
+    }[];
+    readonly taxes?: {
+        name: string;
+        volume: number;
+    }[];
+    readonly buffet?: {
+        snapshot: BuffetCombosItems;
+        taxes: {
+            name: string;
+            rate: number;
+        }[];
+    };
+    readonly adultNum?: number;
+    readonly childNum?: number;
+}
+
+export type AnyOrder = TableOrder | BuffetOrder | SerialOrder | DeliveryOrder | PickUpOrder;
+
+/**
+ * @param order
+ */
+export function isTableOrder(order: Order): order is TableOrder {
+    return order.type === OrderTypeEnum.Table;
+}
+
+/**
+ * @param order
+ */
+export function isBuffetOrder(order: Order): order is TableOrder {
+    return order.type === OrderTypeEnum.Buffet;
+}

package/src/interfaces/order/pickupOrder.interface.ts

@@ -1,9 +1,9 @@
-import { BaseOrder } from './baseOrder.interface';
-
-export interface PickUpOrder extends BaseOrder {
-    readonly selfPickUp: true;
-    readonly phoneNum: string;
-    readonly nickName: string;
-    readonly reserveTime?: Date;
-    readonly selfPickUpUseDeliveryMenu: boolean;
-}
+import { BaseOrder } from './baseOrder.interface';
+
+export interface PickUpOrder extends BaseOrder {
+    readonly selfPickUp: true;
+    readonly phoneNum: string;
+    readonly nickName: string;
+    readonly reserveTime?: Date;
+    readonly selfPickUpUseDeliveryMenu: boolean;
+}

package/src/interfaces/order/serialOrder.interface.ts

@@ -1,5 +1,5 @@
-import { BaseOrder } from './baseOrder.interface';
-
-export interface SerialOrder extends BaseOrder {
-    readonly serialNum: string;
-}
+import { BaseOrder } from './baseOrder.interface';
+
+export interface SerialOrder extends BaseOrder {
+    readonly serialNum: string;
+}

package/src/interfaces/order/tableOrder.interface.ts

@@ -1,8 +1,8 @@
-import { BaseOrder } from './baseOrder.interface';
-import { Task } from './baseOrder.interface';
-
-export interface TableOrder extends BaseOrder {
-    readonly tableNum: string;
-    readonly tasks: Task[];
-    readonly operatorId: string;
-}
+import { BaseOrder } from './baseOrder.interface';
+import { Task } from './baseOrder.interface';
+
+export interface TableOrder extends BaseOrder {
+    readonly tableNum: string;
+    readonly tasks: Task[];
+    readonly operatorId: string;
+}

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;
+}

package/src/interfaces/store/classification.interface.ts

@@ -1,7 +1,7 @@
-export interface Classification {
-    name: string;
-    readonly names?: object;
-    readonly content: Array<string>;
-    readonly noFullOrderDiscount: boolean;
-    readonly date: string | Date;
-}
+export interface Classification {
+    name: string;
+    readonly names?: object;
+    readonly content: Array<string>;
+    readonly noFullOrderDiscount: boolean;
+    readonly date: string | Date;
+}