@feedmepos/mf-order-setting 0.0.91 → 0.0.92

package/dist/package/entity/reservation/reservation-pos.do.d.ts

@@ -0,0 +1,222 @@
+import { z } from 'zod';
+/**
+ * pos-v8's local mirror of one backend reservation, stored in the restaurant
+ * CouchDB as `reservation_<reservation._id>`. reservation-backend stays the
+ * source of truth; Main POS is the only writer of these documents (poll + Ably
+ * upsert, purge outside the list window), so a Sub POS can read them later.
+ */
+export declare const FdoPosReservation: z.ZodObject<{
+    /** Couch document id, `reservation_<reservation._id>` */
+    _id: z.ZodString;
+    reservation: z.ZodObject<{
+        _id: z.ZodEffects<z.ZodString, string, string>;
+        status: z.ZodEnum<["DRAFT", "CONFIRMED", "CANCELLED", "SEATED", "NO_SHOW"]>;
+        restaurant: z.ZodEffects<z.ZodString, string, string>;
+        capacityTierId: z.ZodString;
+        rangeId: z.ZodString;
+        startDate: z.ZodEffects<z.ZodString, string, string>;
+        endDate: z.ZodEffects<z.ZodString, string, string>;
+        pax: z.ZodNumber;
+        userName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        userPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        userEmail: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        userId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        slotNumber: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        slotLockedAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+        customerRemarks: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        guestPreferences: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            value: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            value: string[];
+        }, {
+            name: string;
+            value: string[];
+        }>, "many">>>;
+        reservedUntil: z.ZodEffects<z.ZodString, string, string>;
+        orderId: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+        staffRemarks: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            text: z.ZodString;
+            authorName: z.ZodString;
+            createdAt: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            text: string;
+            createdAt: string;
+            authorName: string;
+        }, {
+            text: string;
+            createdAt: string;
+            authorName: string;
+        }>, "many">>>;
+        createdAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+        createdBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        confirmedAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+        confirmedBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        seatedAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+        seatedBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        cancelledAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+        cancelledBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        noShowAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+        noShowBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        orderId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        createdBy?: string | null | undefined;
+        userId?: string | null | undefined;
+        userName?: string | null | undefined;
+        guestPreferences?: {
+            name: string;
+            value: string[];
+        }[] | null | undefined;
+        userPhone?: string | null | undefined;
+        userEmail?: string | null | undefined;
+        slotNumber?: string | null | undefined;
+        slotLockedAt?: string | null | undefined;
+        customerRemarks?: string | null | undefined;
+        staffRemarks?: {
+            text: string;
+            createdAt: string;
+            authorName: string;
+        }[] | null | undefined;
+        confirmedAt?: string | null | undefined;
+        confirmedBy?: string | null | undefined;
+        seatedAt?: string | null | undefined;
+        seatedBy?: string | null | undefined;
+        cancelledAt?: string | null | undefined;
+        cancelledBy?: string | null | undefined;
+        noShowAt?: string | null | undefined;
+        noShowBy?: string | null | undefined;
+        status: "CANCELLED" | "DRAFT" | "CONFIRMED" | "SEATED" | "NO_SHOW";
+        restaurant: string;
+        _id: string;
+        pax: number;
+        startDate: string;
+        endDate: string;
+        reservedUntil: string;
+        capacityTierId: string;
+        rangeId: string;
+    }, {
+        orderId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        createdBy?: string | null | undefined;
+        userId?: string | null | undefined;
+        userName?: string | null | undefined;
+        guestPreferences?: {
+            name: string;
+            value: string[];
+        }[] | null | undefined;
+        userPhone?: string | null | undefined;
+        userEmail?: string | null | undefined;
+        slotNumber?: string | null | undefined;
+        slotLockedAt?: string | null | undefined;
+        customerRemarks?: string | null | undefined;
+        staffRemarks?: {
+            text: string;
+            createdAt: string;
+            authorName: string;
+        }[] | null | undefined;
+        confirmedAt?: string | null | undefined;
+        confirmedBy?: string | null | undefined;
+        seatedAt?: string | null | undefined;
+        seatedBy?: string | null | undefined;
+        cancelledAt?: string | null | undefined;
+        cancelledBy?: string | null | undefined;
+        noShowAt?: string | null | undefined;
+        noShowBy?: string | null | undefined;
+        status: "CANCELLED" | "DRAFT" | "CONFIRMED" | "SEATED" | "NO_SHOW";
+        restaurant: string;
+        _id: string;
+        pax: number;
+        startDate: string;
+        endDate: string;
+        reservedUntil: string;
+        capacityTierId: string;
+        rangeId: string;
+    }>;
+    /** When Main POS last wrote this mirror from the backend */
+    syncedAt: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    reservation: {
+        orderId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        createdBy?: string | null | undefined;
+        userId?: string | null | undefined;
+        userName?: string | null | undefined;
+        guestPreferences?: {
+            name: string;
+            value: string[];
+        }[] | null | undefined;
+        userPhone?: string | null | undefined;
+        userEmail?: string | null | undefined;
+        slotNumber?: string | null | undefined;
+        slotLockedAt?: string | null | undefined;
+        customerRemarks?: string | null | undefined;
+        staffRemarks?: {
+            text: string;
+            createdAt: string;
+            authorName: string;
+        }[] | null | undefined;
+        confirmedAt?: string | null | undefined;
+        confirmedBy?: string | null | undefined;
+        seatedAt?: string | null | undefined;
+        seatedBy?: string | null | undefined;
+        cancelledAt?: string | null | undefined;
+        cancelledBy?: string | null | undefined;
+        noShowAt?: string | null | undefined;
+        noShowBy?: string | null | undefined;
+        status: "CANCELLED" | "DRAFT" | "CONFIRMED" | "SEATED" | "NO_SHOW";
+        restaurant: string;
+        _id: string;
+        pax: number;
+        startDate: string;
+        endDate: string;
+        reservedUntil: string;
+        capacityTierId: string;
+        rangeId: string;
+    };
+    syncedAt: string;
+}, {
+    _id: string;
+    reservation: {
+        orderId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        createdBy?: string | null | undefined;
+        userId?: string | null | undefined;
+        userName?: string | null | undefined;
+        guestPreferences?: {
+            name: string;
+            value: string[];
+        }[] | null | undefined;
+        userPhone?: string | null | undefined;
+        userEmail?: string | null | undefined;
+        slotNumber?: string | null | undefined;
+        slotLockedAt?: string | null | undefined;
+        customerRemarks?: string | null | undefined;
+        staffRemarks?: {
+            text: string;
+            createdAt: string;
+            authorName: string;
+        }[] | null | undefined;
+        confirmedAt?: string | null | undefined;
+        confirmedBy?: string | null | undefined;
+        seatedAt?: string | null | undefined;
+        seatedBy?: string | null | undefined;
+        cancelledAt?: string | null | undefined;
+        cancelledBy?: string | null | undefined;
+        noShowAt?: string | null | undefined;
+        noShowBy?: string | null | undefined;
+        status: "CANCELLED" | "DRAFT" | "CONFIRMED" | "SEATED" | "NO_SHOW";
+        restaurant: string;
+        _id: string;
+        pax: number;
+        startDate: string;
+        endDate: string;
+        reservedUntil: string;
+        capacityTierId: string;
+        rangeId: string;
+    };
+    syncedAt: string;
+}>;
+export type FdoPosReservation = z.infer<typeof FdoPosReservation>;

package/dist/package/entity/reservation/reservation.do.d.ts

@@ -0,0 +1,205 @@
+import { z } from 'zod';
+/** Guest preference value - supports text, single select (radio), and multi select (checkbox) */
+export declare const FdoGuestPreferenceValue: z.ZodObject<{
+    /** The preference name (matches FdoReservationPreference.name) */
+    name: z.ZodString;
+    /** The customer's selection - string for text/radio, array for checkbox */
+    value: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    value: string | string[];
+}, {
+    name: string;
+    value: string | string[];
+}>;
+export type FdoGuestPreferenceValue = z.infer<typeof FdoGuestPreferenceValue>;
+/** Maximum number of staff remarks kept on one reservation. */
+export declare const RESERVATION_STAFF_REMARK_LIMIT = 30;
+/** Maximum length of one staff remark. */
+export declare const RESERVATION_STAFF_REMARK_MAX_LENGTH = 300;
+/** Actor recorded on `…By` fields for status changes made by the backend cron. */
+export declare const RESERVATION_ACTOR_SYSTEM = "system";
+/** Actor recorded on `…By` fields for status changes made by the customer. */
+export declare const RESERVATION_ACTOR_CUSTOMER = "customer";
+/**
+ * One entry of the staff remarks thread shown in the POS reservation detail.
+ * Append-only; the customer's own booking note stays in `customerRemarks`.
+ */
+export declare const FdoReservationStaffRemark: z.ZodObject<{
+    text: z.ZodString;
+    /** Name of the POS employee who wrote it, as asserted by the POS */
+    authorName: z.ZodString;
+    createdAt: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+    createdAt: string;
+    authorName: string;
+}, {
+    text: string;
+    createdAt: string;
+    authorName: string;
+}>;
+export type FdoReservationStaffRemark = z.infer<typeof FdoReservationStaffRemark>;
+export declare const FdoRestaurantReservation: z.ZodObject<{
+    _id: z.ZodEffects<z.ZodString, string, string>;
+    status: z.ZodEnum<["DRAFT", "CONFIRMED", "CANCELLED", "SEATED", "NO_SHOW"]>;
+    /** * The timestamp until which this slot is held/blocked for the user.
+     * If the current time > reservedUntil and status is DRAFT,
+     * the inventory is released back to the public.
+     */
+    reservedUntil: z.ZodEffects<z.ZodString, string, string>;
+    /** Restaurant _id */
+    restaurant: z.ZodEffects<z.ZodString, string, string>;
+    /** The capacity tier ID - the actual inventory unit being booked */
+    capacityTierId: z.ZodString;
+    /** The range ID - the zone/area this reservation belongs to */
+    rangeId: z.ZodString;
+    orderId: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    /** Pax */
+    pax: z.ZodNumber;
+    startDate: z.ZodEffects<z.ZodString, string, string>;
+    endDate: z.ZodEffects<z.ZodString, string, string>;
+    userName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /** User phone and email can be null if created by POS */
+    userPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    userEmail: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /** User _id that created the reservation, can be null if created by POS */
+    userId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /** POS assigned slot number */
+    slotNumber: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /** POS table lock timestamp. Null means unlocked. */
+    slotLockedAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    /** Customer remarks, can be preset/custom */
+    customerRemarks: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /** Guest preferences - customer's selections from range preferences */
+    guestPreferences: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        /** The preference name (matches FdoReservationPreference.name) */
+        name: z.ZodString;
+        /** The customer's selection - string for text/radio, array for checkbox */
+        value: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        value: string | string[];
+    }, {
+        name: string;
+        value: string | string[];
+    }>, "many">>>;
+    /**
+     * Staff remarks thread (POS). Bounded to RESERVATION_STAFF_REMARK_LIMIT
+     * entries; only written through `POST /pos/reservation/:id/remarks`.
+     */
+    staffRemarks: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        text: z.ZodString;
+        /** Name of the POS employee who wrote it, as asserted by the POS */
+        authorName: z.ZodString;
+        createdAt: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        text: string;
+        createdAt: string;
+        authorName: string;
+    }, {
+        text: string;
+        createdAt: string;
+        authorName: string;
+    }>, "many">>>;
+    /** When the reservation document was created. Absent on documents created before 2026-10. */
+    createdAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    /** Who created it: the POS employee name, or "customer" for an online booking. */
+    createdBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /**
+     * Status timestamps and actors, used by the POS Activity tab. Each is set
+     * by the backend at the transition. `…By` is the POS employee name,
+     * RESERVATION_ACTOR_CUSTOMER or RESERVATION_ACTOR_SYSTEM.
+     */
+    confirmedAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    confirmedBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    seatedAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    seatedBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    cancelledAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    cancelledBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    noShowAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+    noShowBy: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    /**
+     * Seat lock: set while a Start Ordering request is creating the order, so
+     * a second terminal's concurrent request is rejected. Cleared on success
+     * or failure; a stale lock older than the seat-lock TTL is ignored.
+     */
+    seatingAt: z.ZodNullable<z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>>;
+}, "strip", z.ZodTypeAny, {
+    orderId?: string | null | undefined;
+    createdAt?: string | null | undefined;
+    createdBy?: string | null | undefined;
+    userId?: string | null | undefined;
+    userName?: string | null | undefined;
+    guestPreferences?: {
+        name: string;
+        value: string | string[];
+    }[] | null | undefined;
+    userPhone?: string | null | undefined;
+    userEmail?: string | null | undefined;
+    slotNumber?: string | null | undefined;
+    slotLockedAt?: string | null | undefined;
+    customerRemarks?: string | null | undefined;
+    staffRemarks?: {
+        text: string;
+        createdAt: string;
+        authorName: string;
+    }[] | null | undefined;
+    confirmedAt?: string | null | undefined;
+    confirmedBy?: string | null | undefined;
+    seatedAt?: string | null | undefined;
+    seatedBy?: string | null | undefined;
+    cancelledAt?: string | null | undefined;
+    cancelledBy?: string | null | undefined;
+    noShowAt?: string | null | undefined;
+    noShowBy?: string | null | undefined;
+    seatingAt?: string | null | undefined;
+    status: "CANCELLED" | "DRAFT" | "CONFIRMED" | "SEATED" | "NO_SHOW";
+    restaurant: string;
+    _id: string;
+    pax: number;
+    startDate: string;
+    endDate: string;
+    reservedUntil: string;
+    capacityTierId: string;
+    rangeId: string;
+}, {
+    orderId?: string | null | undefined;
+    createdAt?: string | null | undefined;
+    createdBy?: string | null | undefined;
+    userId?: string | null | undefined;
+    userName?: string | null | undefined;
+    guestPreferences?: {
+        name: string;
+        value: string | string[];
+    }[] | null | undefined;
+    userPhone?: string | null | undefined;
+    userEmail?: string | null | undefined;
+    slotNumber?: string | null | undefined;
+    slotLockedAt?: string | null | undefined;
+    customerRemarks?: string | null | undefined;
+    staffRemarks?: {
+        text: string;
+        createdAt: string;
+        authorName: string;
+    }[] | null | undefined;
+    confirmedAt?: string | null | undefined;
+    confirmedBy?: string | null | undefined;
+    seatedAt?: string | null | undefined;
+    seatedBy?: string | null | undefined;
+    cancelledAt?: string | null | undefined;
+    cancelledBy?: string | null | undefined;
+    noShowAt?: string | null | undefined;
+    noShowBy?: string | null | undefined;
+    seatingAt?: string | null | undefined;
+    status: "CANCELLED" | "DRAFT" | "CONFIRMED" | "SEATED" | "NO_SHOW";
+    restaurant: string;
+    _id: string;
+    pax: number;
+    startDate: string;
+    endDate: string;
+    reservedUntil: string;
+    capacityTierId: string;
+    rangeId: string;
+}>;
+export type FdoRestaurantReservation = z.infer<typeof FdoRestaurantReservation>;