wiil-core-js 0.0.82

package/dist/core/business-mgt/reservation-mgt/reservation-room.schema.d.ts

@@ -0,0 +1,195 @@
+import { z } from "zod";
+import { PaymentStatus, ReservationStatus } from "../../type-definitions";
+/**
+ * @fileoverview Room reservation schema definitions.
+ * @module business-mgt/reservation-mgt/room-reservation
+ */
+/**
+ * Room rate per night schema.
+ * Captures the nightly rate snapshot for a room reservation.
+ *
+ * @typedef {Object} RoomRatePerNight
+ * @property {string} date - Business-local rate date in YYYY-MM-DD format
+ * @property {number} amount - Nightly rate amount for the date
+ */
+export declare const RoomRatePerNightSchema: z.ZodObject<{
+    date: z.ZodString;
+    amount: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Room reservation schema.
+ * Represents a lodging reservation with check-in/check-out dates and nightly pricing.
+ *
+ * @typedef {Object} RoomReservation
+ * @property {string} [locationId] - Business location where the room reservation is booked
+ * @property {string} [channelId] - Channel that created or owns the booking
+ * @property {string} resourceId - Room resource or category being reserved
+ * @property {string} guestId - Guest or customer who owns the stay
+ * @property {number} personsNumber - Number of guests in the party
+ * @property {number} checkIn - Check-in timestamp
+ * @property {number} checkOut - Check-out timestamp
+ * @property {number} nights - Number of nights in the stay
+ * @property {ReservationStatus} status - Current room reservation status
+ * @property {string} [source] - Source or channel label for the reservation
+ * @property {RoomRatePerNight[]} ratePerNight - Nightly pricing breakdown
+ * @property {number} totalWithTax - Total reservation amount including tax
+ * @property {number} deposit - Deposit amount collected or required
+ * @property {PaymentStatus} [paymentStatus] - Payment status for the stay
+ * @property {string} [notes] - Internal staff notes
+ * @property {Object} [externalRef] - External platform reference
+ */
+export declare const RoomReservationSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    locationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    resourceId: z.ZodString;
+    guestId: z.ZodString;
+    personsNumber: z.ZodNumber;
+    checkIn: z.ZodNumber;
+    checkOut: z.ZodNumber;
+    nights: z.ZodNumber;
+    status: z.ZodDefault<z.ZodEnum<typeof ReservationStatus>>;
+    source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    ratePerNight: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        amount: z.ZodNumber;
+    }, z.core.$strip>>>;
+    totalWithTax: z.ZodNumber;
+    deposit: z.ZodDefault<z.ZodNumber>;
+    paymentStatus: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof PaymentStatus>>>;
+    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    externalRef: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        externalId: z.ZodString;
+        source: z.ZodString;
+        url: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
+        syncedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Schema for creating a new room reservation.
+ * Omits auto-generated fields.
+ */
+export declare const CreateRoomReservationSchema: z.ZodObject<{
+    source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    nights: z.ZodNumber;
+    status: z.ZodDefault<z.ZodEnum<typeof ReservationStatus>>;
+    locationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    channelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    paymentStatus: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof PaymentStatus>>>;
+    externalRef: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        externalId: z.ZodString;
+        source: z.ZodString;
+        url: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
+        syncedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    resourceId: z.ZodString;
+    personsNumber: z.ZodNumber;
+    guestId: z.ZodString;
+    checkIn: z.ZodNumber;
+    checkOut: z.ZodNumber;
+    ratePerNight: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        amount: z.ZodNumber;
+    }, z.core.$strip>>>;
+    totalWithTax: z.ZodNumber;
+    deposit: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Schema for updating an existing room reservation.
+ * All fields optional except id.
+ */
+export declare const UpdateRoomReservationSchema: z.ZodObject<{
+    source: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    nights: z.ZodOptional<z.ZodNumber>;
+    locationId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    channelId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    notes: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    paymentStatus: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof PaymentStatus>>>>;
+    externalRef: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        externalId: z.ZodString;
+        source: z.ZodString;
+        url: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
+        syncedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>>;
+    resourceId: z.ZodOptional<z.ZodString>;
+    personsNumber: z.ZodOptional<z.ZodNumber>;
+    guestId: z.ZodOptional<z.ZodString>;
+    checkIn: z.ZodOptional<z.ZodNumber>;
+    checkOut: z.ZodOptional<z.ZodNumber>;
+    ratePerNight: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        amount: z.ZodNumber;
+    }, z.core.$strip>>>>;
+    totalWithTax: z.ZodOptional<z.ZodNumber>;
+    deposit: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    id: z.ZodString;
+    status: z.ZodOptional<z.ZodNullable<z.ZodEnum<typeof ReservationStatus>>>;
+}, z.core.$strip>;
+/**
+ * Schema for reassigning a room reservation to a different room instance.
+ */
+export declare const RoomReAssignmentSchema: z.ZodObject<{
+    reservationId: z.ZodString;
+    fromRoomInstanceId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    toRoomInstanceId: z.ZodString;
+    reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type RoomRatePerNight = z.infer<typeof RoomRatePerNightSchema>;
+export type RoomReservation = z.infer<typeof RoomReservationSchema>;
+export type CreateRoomReservation = z.infer<typeof CreateRoomReservationSchema>;
+export type UpdateRoomReservation = z.infer<typeof UpdateRoomReservationSchema>;
+export type RoomReAssignment = z.infer<typeof RoomReAssignmentSchema>;
+/**
+ * Room reservation filter options.
+ * @interface RoomReservationFilters
+ */
+export interface RoomReservationFilters {
+    /** Text search across room reservation fields */
+    search?: string;
+    /** Filter by business location ID */
+    locationId?: string;
+    /** Filter by booking channel ID */
+    channelId?: string;
+    /** Filter by room resource ID */
+    resourceId?: string;
+    /** Filter by guest/customer ID */
+    guestId?: string;
+    /** Filter by reservation statuses */
+    status?: ReservationStatus[];
+    /** Filter by payment statuses */
+    paymentStatus?: PaymentStatus[];
+    /** Filter by check-in timestamp range */
+    dateRange?: {
+        start?: number;
+        end?: number;
+    };
+    /** Filter by external source platform */
+    externalSource?: string;
+}
+/**
+ * Room reservation sorting options.
+ * @interface RoomReservationSorting
+ */
+export interface RoomReservationSorting {
+    /** Field to sort by */
+    field: "checkIn" | "checkOut" | "createdAt";
+    /** Sort direction */
+    direction: "asc" | "desc";
+}
+/**
+ * Room reservation query options.
+ * @interface RoomReservationQueryOptions
+ */
+export interface RoomReservationQueryOptions {
+    /** Page number (1-indexed) */
+    page: number;
+    /** Items per page */
+    pageSize: number;
+    /** Optional filters */
+    filters?: RoomReservationFilters;
+    /** Optional sorting */
+    sorting?: RoomReservationSorting;
+}

package/dist/core/business-mgt/reservation-mgt/reservation-room.schema.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoomReAssignmentSchema = exports.UpdateRoomReservationSchema = exports.CreateRoomReservationSchema = exports.RoomReservationSchema = exports.RoomRatePerNightSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../../base.schema");
+const type_definitions_1 = require("../../type-definitions");
+/**
+ * @fileoverview Room reservation schema definitions.
+ * @module business-mgt/reservation-mgt/room-reservation
+ */
+// ============================================================================
+// ROOM RESERVATION SCHEMAS
+// ============================================================================
+/**
+ * Room rate per night schema.
+ * Captures the nightly rate snapshot for a room reservation.
+ *
+ * @typedef {Object} RoomRatePerNight
+ * @property {string} date - Business-local rate date in YYYY-MM-DD format
+ * @property {number} amount - Nightly rate amount for the date
+ */
+exports.RoomRatePerNightSchema = zod_1.z.object({
+    date: zod_1.z.string().describe("Business-local rate date in YYYY-MM-DD format."),
+    amount: zod_1.z.number().nonnegative().describe("Nightly room rate amount for this date before aggregation."),
+});
+/**
+ * Room reservation schema.
+ * Represents a lodging reservation with check-in/check-out dates and nightly pricing.
+ *
+ * @typedef {Object} RoomReservation
+ * @property {string} [locationId] - Business location where the room reservation is booked
+ * @property {string} [channelId] - Channel that created or owns the booking
+ * @property {string} resourceId - Room resource or category being reserved
+ * @property {string} guestId - Guest or customer who owns the stay
+ * @property {number} personsNumber - Number of guests in the party
+ * @property {number} checkIn - Check-in timestamp
+ * @property {number} checkOut - Check-out timestamp
+ * @property {number} nights - Number of nights in the stay
+ * @property {ReservationStatus} status - Current room reservation status
+ * @property {string} [source] - Source or channel label for the reservation
+ * @property {RoomRatePerNight[]} ratePerNight - Nightly pricing breakdown
+ * @property {number} totalWithTax - Total reservation amount including tax
+ * @property {number} deposit - Deposit amount collected or required
+ * @property {PaymentStatus} [paymentStatus] - Payment status for the stay
+ * @property {string} [notes] - Internal staff notes
+ * @property {Object} [externalRef] - External platform reference
+ */
+exports.RoomReservationSchema = base_schema_1.BaseModelSchema.safeExtend({
+    locationId: zod_1.z.string().nullable().optional().describe("Business location ID where the room reservation is booked. Null applies when the reservation is not location-specific."),
+    channelId: zod_1.z.string().nullable().optional().describe("Channel ID for multi-channel bookings (e.g., web, marketplace, partner)"),
+    resourceId: zod_1.z.string().describe("Room type/category ID"),
+    guestId: zod_1.z.string().describe("Guest/customer ID"),
+    personsNumber: zod_1.z.number().int().positive().describe("Party size"),
+    checkIn: zod_1.z.number().describe("Check-in timestamp"),
+    checkOut: zod_1.z.number().describe("Check-out timestamp"),
+    nights: zod_1.z.number().int().positive().describe("Number of nights"),
+    status: zod_1.z.enum(type_definitions_1.ReservationStatus).default(type_definitions_1.ReservationStatus.PENDING).describe("Room reservation lifecycle status"),
+    source: zod_1.z.string().nullable().optional().describe("Source/channel of the reservation"),
+    ratePerNight: zod_1.z.array(exports.RoomRatePerNightSchema).default([]).describe("Per-night pricing"),
+    totalWithTax: zod_1.z.number().nonnegative().describe("Total amount including tax"),
+    deposit: zod_1.z.number().nonnegative().default(0).describe("Deposit amount"),
+    paymentStatus: zod_1.z.enum(type_definitions_1.PaymentStatus).nullable().optional().describe("Payment status"),
+    notes: zod_1.z.string().nullable().optional().describe("Internal notes"),
+    externalRef: type_definitions_1.ExternalRefSchema.nullable().optional().describe("External system reference (when imported/synced)"),
+}).superRefine((data, ctx) => {
+    if (data.checkOut <= data.checkIn) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["checkOut"],
+            message: "checkOut must be greater than checkIn",
+        });
+    }
+});
+// ============================================================================
+// CREATE/UPDATE SCHEMAS
+// ============================================================================
+/**
+ * Schema for creating a new room reservation.
+ * Omits auto-generated fields.
+ */
+exports.CreateRoomReservationSchema = exports.RoomReservationSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+});
+/**
+ * Schema for updating an existing room reservation.
+ * All fields optional except id.
+ */
+exports.UpdateRoomReservationSchema = exports.CreateRoomReservationSchema.partial().extend({
+    id: zod_1.z.string().describe("Unique identifier of the room reservation to update."),
+    // Re-declared without the base `.default()` so partial updates don't inject a status the caller never set
+    status: zod_1.z.enum(type_definitions_1.ReservationStatus).nullable().optional().describe("Room reservation lifecycle status"),
+});
+// ============================================================================
+// REASSIGNMENT SCHEMA
+// ============================================================================
+/**
+ * Schema for reassigning a room reservation to a different room instance.
+ */
+exports.RoomReAssignmentSchema = zod_1.z.object({
+    reservationId: zod_1.z.string().describe("Room reservation ID being reassigned."),
+    fromRoomInstanceId: zod_1.z.string().nullable().optional().describe("Current room instance ID the reservation is being moved from."),
+    toRoomInstanceId: zod_1.z.string().describe("Target room instance ID the reservation is being moved to."),
+    reason: zod_1.z.string().nullable().optional().describe("Optional reason for the reassignment."),
+});