payservedb 9.6.0 → 9.6.2

package/src/models/bookingreservation.js

@@ -1,299 +1,299 @@
-const mongoose = require('mongoose');
-
-// Define the schema for Booking Reservations
-const bookingReservationSchema = new mongoose.Schema({
-    checkOutActual: {
-        type: Date
-    },
-    // When the guest was actually checked in (set by the Check In action)
-    checkedInAt: {
-        type: Date
-    },
-    // Field for checkout notes
-    checkoutNotes: {
-        type: String,
-        default: ''
-    },
-    // Field for the final amount paid (may differ from original totalAmount)
-    finalAmount: {
-        type: Number
-    },
-    // Field for additional charges at checkout
-    additionalCheckoutCharges: [{
-        description: {
-            type: String,
-            required: true
-        },
-        amount: {
-            type: Number,
-            required: true
-        },
-        reason: {
-            type: String
-        },
-        status: {
-            type: String,
-            enum: ['Unpaid', 'Partially Paid', 'Paid'],
-            default: 'Unpaid'
-        },
-        paidAmount: {
-            type: Number,
-            default: 0
-        },
-        addedAt: {
-            type: Date,
-            default: Date.now
-        }
-    }],
-    // Field to track if this reservation has been included in revenue calculations
-    revenueProcessed: {
-        type: Boolean,
-        default: false
-    },
-    // Field to store the checkout date
-    checkoutDate: {
-        type: Date
-    },
-    // Flag to indicate checkout is pending finance approval
-    checkoutPending: {
-        type: Boolean,
-        default: false
-    },
-    facilityId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Facility',
-        required: true
-    },
-    bookingPropertyId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'BookingProperty',
-        required: true
-    },
-    unitId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Unit',
-        required: true
-    },
-    bookingReservationId: {
-        type: String,
-        required: true,
-        unique: true
-    },
-    // Which staff member created this booking - always an explicit manual
-    // selection (never auto-filled from the logged-in user), so the invoice
-    // can show "You were served by <name>".
-    servedBy: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'User'
-    },
-    servedByName: {
-        type: String,
-        default: ''
-    },
-    guestInfo: {
-        name: {
-            type: String,
-            required: true
-        },
-        email: {
-            type: String,
-            required: true
-        },
-        phone: {
-            type: String,
-            required: true
-        },
-        // Not required: guests booking online (external API / widget) often
-        // don't have this to hand until check-in, and both create_reservation.js
-        // (internal) and create_booking.js (external) already treat it as
-        // optional at their own validation layer, defaulting to '' - this
-        // schema requirement was rejecting exactly those bookings.
-        idNumber: {
-            type: String,
-            default: ''
-        }
-    },
-    checkIn: {
-        type: Date,
-        required: true
-    },
-    checkOut: {
-        type: Date,
-        required: true
-    },
-    guests: {
-        adults: {
-            type: Number,
-            default: 1
-        },
-        children: {
-            type: Number,
-            default: 0
-        }
-    },
-    basePrice: {
-        type: Number,
-        required: false
-    },
-    totalAmount: {
-        type: Number,
-        required: false
-    },
-    // Running total of confirmed payments applied to this reservation's
-    // invoice - kept in sync by applyBookingInvoicePayment.js so the
-    // booking list can gate check-in eligibility (paymentTiming rules)
-    // without an extra invoice lookup per row.
-    totalPaidAmount: {
-        type: Number,
-        default: 0
-    },
-    commission: {
-        type: Number,
-        required: false
-    },
-    landlordAmount: {
-        type: Number,
-        required: false
-    },
-    currencyId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Currency',
-        required: false
-    },
-    paymentMethod: {
-        type: String,
-        enum: ['Cash', 'Card', 'Bank Transfer', 'Mobile Money', 'Other'],
-        required: false
-    },
-    paymentTiming: {
-        type: String,
-        enum: ['Before', 'After', 'Split', 'PerNight'],
-        default: 'Before'
-    },
-    // Only used when paymentTiming is 'Split' - guest must pay at least
-    // this percentage of the total before check-in is allowed.
-    splitPaymentPercentage: {
-        type: Number,
-        min: 1,
-        max: 100,
-        default: null
-    },
-    // Only used when paymentTiming is 'PerNight' - prevents sending more
-    // than one payment reminder per business day.
-    lastPerNightReminderSentAt: {
-        type: Date,
-        default: null
-    },
-    invoiceId: {
-        type: String
-    },
-    // For additional services
-    additionalServices: [{
-        serviceId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'ValueAddedService'
-        },
-        serviceName: {
-            type: String,
-            required: true
-        },
-        quantity: {
-            type: Number,
-            default: 1
-        },
-        price: {
-            type: Number,
-            required: true
-        }
-    }],
-    specialRequests: {
-        type: String
-    },
-    // This enum is a superset shared across companies on this multitenant
-    // platform (payservedb has no per-company branch) - each company's own
-    // controller code decides how 'booked'/'reserved' are actually used, so
-    // do not change the default here without checking every consumer.
-    // Swan: booked = created, zero payment. reserved = has payment (partial
-    // or full), not yet checked in. checked-in = guest on premises.
-    // checked-out = guest left but balance outstanding (e.g. damage
-    // charges). completed = balance cleared. cancelled = terminal, reachable
-    // from booked/reserved.
-    status: {
-        type: String,
-        enum: ['reserved', 'booked', 'canceled', 'cancelled', 'checked-in', 'checked-out', 'completed'],
-        default: 'reserved'
-    },
-    statusHistory: [{
-        status: {
-            type: String,
-            enum: ['reserved', 'booked', 'canceled', 'cancelled', 'checked-in', 'checked-out', 'completed'],
-            required: true
-        },
-        timestamp: {
-            type: Date,
-            default: Date.now
-        },
-        updatedBy: mongoose.Schema.Types.ObjectId
-    }],
-    // Partial payment and reservation settings
-    partialPaymentAllowed: {
-        type: Boolean,
-        default: true
-    },
-    paymentDeadline: {
-        type: Date
-    },
-    reassignmentAllowed: {
-        type: Boolean,
-        default: true
-    },
-    // Reservation policy details
-    reservationPolicy: {
-        type: String,
-        default: 'Units can be reserved with partial payment. Full payment required before check-in. Reserved units may be reassigned if payment deadline is not met.'
-    },
-    cancellationDetails: {
-        date: Date,
-        reason: String,
-        refundAmount: Number,
-        refundStatus: {
-            type: String,
-            enum: ["Pending", "Approved", "Rejected"],
-            default: "Pending"
-        },
-        refundPaymentId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: "CashPayment"
-        },
-        refundReference: String,
-        refundRequestedAt: Date,
-        refundApprovedAt: Date,
-        refundRejectedAt: Date,
-        refundRejectionReason: String,
-        // Records which named CancellationPolicy (if any) determined
-        // refundAmount, for display/audit purposes
-        appliedPolicy: {
-            policyId: {
-                type: mongoose.Schema.Types.ObjectId,
-                ref: 'CancellationPolicy'
-            },
-            policyName: String,
-            refundPercentage: Number
-        }
-    },
-    createdBy: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'User',
-    },
-    updatedBy: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'User'
-    }
-}, {
-    timestamps: true
-});
-
-// Create model from schema
-const BookingReservation = mongoose.model('BookingReservation', bookingReservationSchema);
-
+const mongoose = require('mongoose');
+
+// Define the schema for Booking Reservations
+const bookingReservationSchema = new mongoose.Schema({
+    checkOutActual: {
+        type: Date
+    },
+    // When the guest was actually checked in (set by the Check In action)
+    checkedInAt: {
+        type: Date
+    },
+    // Field for checkout notes
+    checkoutNotes: {
+        type: String,
+        default: ''
+    },
+    // Field for the final amount paid (may differ from original totalAmount)
+    finalAmount: {
+        type: Number
+    },
+    // Field for additional charges at checkout
+    additionalCheckoutCharges: [{
+        description: {
+            type: String,
+            required: true
+        },
+        amount: {
+            type: Number,
+            required: true
+        },
+        reason: {
+            type: String
+        },
+        status: {
+            type: String,
+            enum: ['Unpaid', 'Partially Paid', 'Paid'],
+            default: 'Unpaid'
+        },
+        paidAmount: {
+            type: Number,
+            default: 0
+        },
+        addedAt: {
+            type: Date,
+            default: Date.now
+        }
+    }],
+    // Field to track if this reservation has been included in revenue calculations
+    revenueProcessed: {
+        type: Boolean,
+        default: false
+    },
+    // Field to store the checkout date
+    checkoutDate: {
+        type: Date
+    },
+    // Flag to indicate checkout is pending finance approval
+    checkoutPending: {
+        type: Boolean,
+        default: false
+    },
+    facilityId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true
+    },
+    bookingPropertyId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'BookingProperty',
+        required: true
+    },
+    unitId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Unit',
+        required: true
+    },
+    bookingReservationId: {
+        type: String,
+        required: true,
+        unique: true
+    },
+    // Which staff member created this booking - always an explicit manual
+    // selection (never auto-filled from the logged-in user), so the invoice
+    // can show "You were served by <name>".
+    servedBy: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User'
+    },
+    servedByName: {
+        type: String,
+        default: ''
+    },
+    guestInfo: {
+        name: {
+            type: String,
+            required: true
+        },
+        email: {
+            type: String,
+            required: true
+        },
+        phone: {
+            type: String,
+            required: true
+        },
+        // Not required: guests booking online (external API / widget) often
+        // don't have this to hand until check-in, and both create_reservation.js
+        // (internal) and create_booking.js (external) already treat it as
+        // optional at their own validation layer, defaulting to '' - this
+        // schema requirement was rejecting exactly those bookings.
+        idNumber: {
+            type: String,
+            default: ''
+        }
+    },
+    checkIn: {
+        type: Date,
+        required: true
+    },
+    checkOut: {
+        type: Date,
+        required: true
+    },
+    guests: {
+        adults: {
+            type: Number,
+            default: 1
+        },
+        children: {
+            type: Number,
+            default: 0
+        }
+    },
+    basePrice: {
+        type: Number,
+        required: false
+    },
+    totalAmount: {
+        type: Number,
+        required: false
+    },
+    // Running total of confirmed payments applied to this reservation's
+    // invoice - kept in sync by applyBookingInvoicePayment.js so the
+    // booking list can gate check-in eligibility (paymentTiming rules)
+    // without an extra invoice lookup per row.
+    totalPaidAmount: {
+        type: Number,
+        default: 0
+    },
+    commission: {
+        type: Number,
+        required: false
+    },
+    landlordAmount: {
+        type: Number,
+        required: false
+    },
+    currencyId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Currency',
+        required: false
+    },
+    paymentMethod: {
+        type: String,
+        enum: ['Cash', 'Card', 'Bank Transfer', 'Mobile Money', 'Other'],
+        required: false
+    },
+    paymentTiming: {
+        type: String,
+        enum: ['Before', 'After', 'Split', 'PerNight'],
+        default: 'Before'
+    },
+    // Only used when paymentTiming is 'Split' - guest must pay at least
+    // this percentage of the total before check-in is allowed.
+    splitPaymentPercentage: {
+        type: Number,
+        min: 1,
+        max: 100,
+        default: null
+    },
+    // Only used when paymentTiming is 'PerNight' - prevents sending more
+    // than one payment reminder per business day.
+    lastPerNightReminderSentAt: {
+        type: Date,
+        default: null
+    },
+    invoiceId: {
+        type: String
+    },
+    // For additional services
+    additionalServices: [{
+        serviceId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'ValueAddedService'
+        },
+        serviceName: {
+            type: String,
+            required: true
+        },
+        quantity: {
+            type: Number,
+            default: 1
+        },
+        price: {
+            type: Number,
+            required: true
+        }
+    }],
+    specialRequests: {
+        type: String
+    },
+    // This enum is a superset shared across companies on this multitenant
+    // platform (payservedb has no per-company branch) - each company's own
+    // controller code decides how 'booked'/'reserved' are actually used, so
+    // do not change the default here without checking every consumer.
+    // Swan: booked = created, zero payment. reserved = has payment (partial
+    // or full), not yet checked in. checked-in = guest on premises.
+    // checked-out = guest left but balance outstanding (e.g. damage
+    // charges). completed = balance cleared. cancelled = terminal, reachable
+    // from booked/reserved.
+    status: {
+        type: String,
+        enum: ['reserved', 'booked', 'canceled', 'cancelled', 'checked-in', 'checked-out', 'completed'],
+        default: 'reserved'
+    },
+    statusHistory: [{
+        status: {
+            type: String,
+            enum: ['reserved', 'booked', 'canceled', 'cancelled', 'checked-in', 'checked-out', 'completed'],
+            required: true
+        },
+        timestamp: {
+            type: Date,
+            default: Date.now
+        },
+        updatedBy: mongoose.Schema.Types.ObjectId
+    }],
+    // Partial payment and reservation settings
+    partialPaymentAllowed: {
+        type: Boolean,
+        default: true
+    },
+    paymentDeadline: {
+        type: Date
+    },
+    reassignmentAllowed: {
+        type: Boolean,
+        default: true
+    },
+    // Reservation policy details
+    reservationPolicy: {
+        type: String,
+        default: 'Units can be reserved with partial payment. Full payment required before check-in. Reserved units may be reassigned if payment deadline is not met.'
+    },
+    cancellationDetails: {
+        date: Date,
+        reason: String,
+        refundAmount: Number,
+        refundStatus: {
+            type: String,
+            enum: ["Pending", "Approved", "Rejected"],
+            default: "Pending"
+        },
+        refundPaymentId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: "CashPayment"
+        },
+        refundReference: String,
+        refundRequestedAt: Date,
+        refundApprovedAt: Date,
+        refundRejectedAt: Date,
+        refundRejectionReason: String,
+        // Records which named CancellationPolicy (if any) determined
+        // refundAmount, for display/audit purposes
+        appliedPolicy: {
+            policyId: {
+                type: mongoose.Schema.Types.ObjectId,
+                ref: 'CancellationPolicy'
+            },
+            policyName: String,
+            refundPercentage: Number
+        }
+    },
+    createdBy: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User',
+    },
+    updatedBy: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User'
+    }
+}, {
+    timestamps: true
+});
+
+// Create model from schema
+const BookingReservation = mongoose.model('BookingReservation', bookingReservationSchema);
+
 module.exports = BookingReservation;