payservedb 9.1.5 → 9.1.7

package/src/models/movein_deal.js

@@ -1,79 +1,79 @@
-const mongoose = require('mongoose');
-const ObjectId = mongoose.Schema.Types.ObjectId;
-
-const moveInDealSchema = new mongoose.Schema(
-    {
-        unitId:        { type: ObjectId, required: true, index: true },
-        unitName:      { type: String, default: null },
-        source: {
-            type: String,
-            enum: ['standalone', 'payserve'],
-            default: 'standalone',
-            index: true,
-        },
-        sourceFacilityId: { type: ObjectId, ref: 'Facility', default: null, index: true },
-        sourceUnitId:     { type: ObjectId, default: null, index: true },
-        landlordId:       { type: ObjectId, default: null, index: true },
-        tenantId:         { type: ObjectId, ref: 'MoveInUser', default: null, index: true },
-        tenantName:       { type: String, default: null },
-        tenantEmail:      { type: String, default: null, index: true },
-        tenantPhone:      { type: String, default: null },
-        isGuest:          { type: Boolean, default: false, index: true },
-        applicationId:    { type: ObjectId, ref: 'MoveInApplication', default: null, index: true },
-        reservationId:    { type: ObjectId, ref: 'MoveInReservation', default: null, index: true },
-        bookingId:        { type: ObjectId, ref: 'MoveInBooking', default: null, index: true },
-        desiredMoveInDate:{ type: Date, default: null },
-        agreedMoveInDate: { type: Date, default: null },
-        agreedRentAmount: { type: Number, default: null },
-        currency:         { type: String, default: 'KES' },
-        status: {
-            type: String,
-            enum: [
-                'lead',
-                'viewing_requested',
-                'viewing_confirmed',
-                'applied',
-                'application_approved',
-                'reserved',
-                'offer_sent',
-                'tenant_confirmed',
-                'payment_pending',
-                'rented',
-                'cancelled',
-                'expired',
-                'lost',
-            ],
-            default: 'lead',
-            index: true,
-        },
-        commissionStatus: {
-            type: String,
-            enum: ['not_due', 'due', 'invoiced', 'paid', 'waived', 'refunded', 'disputed'],
-            default: 'not_due',
-            index: true,
-        },
-        lastEvent:       { type: String, default: null },
-        cancelledReason: { type: String, default: null },
-        notes:           { type: String, default: null },
-        payserveSync: {
-            status: {
-                type: String,
-                enum: ['not_applicable', 'pending', 'synced', 'failed'],
-                default: 'not_applicable',
-            },
-            residentId: { type: ObjectId, default: null },
-            leaseId:    { type: ObjectId, default: null },
-            invoiceId:  { type: ObjectId, default: null },
-            lastError:  { type: String, default: null },
-            syncedAt:   { type: Date, default: null },
-        },
-    },
-    { timestamps: true }
-);
-
-moveInDealSchema.index({ unitId: 1, status: 1 });
-moveInDealSchema.index({ tenantId: 1, unitId: 1 });
-moveInDealSchema.index({ tenantEmail: 1, unitId: 1 });
-
-const MoveInDeal = mongoose.model('MoveInDeal', moveInDealSchema);
-module.exports = MoveInDeal;
+const mongoose = require('mongoose');
+const ObjectId = mongoose.Schema.Types.ObjectId;
+
+const moveInDealSchema = new mongoose.Schema(
+    {
+        unitId:        { type: ObjectId, required: true, index: true },
+        unitName:      { type: String, default: null },
+        source: {
+            type: String,
+            enum: ['standalone', 'payserve'],
+            default: 'standalone',
+            index: true,
+        },
+        sourceFacilityId: { type: ObjectId, ref: 'Facility', default: null, index: true },
+        sourceUnitId:     { type: ObjectId, default: null, index: true },
+        landlordId:       { type: ObjectId, default: null, index: true },
+        tenantId:         { type: ObjectId, ref: 'MoveInUser', default: null, index: true },
+        tenantName:       { type: String, default: null },
+        tenantEmail:      { type: String, default: null, index: true },
+        tenantPhone:      { type: String, default: null },
+        isGuest:          { type: Boolean, default: false, index: true },
+        applicationId:    { type: ObjectId, ref: 'MoveInApplication', default: null, index: true },
+        reservationId:    { type: ObjectId, ref: 'MoveInReservation', default: null, index: true },
+        bookingId:        { type: ObjectId, ref: 'MoveInBooking', default: null, index: true },
+        desiredMoveInDate:{ type: Date, default: null },
+        agreedMoveInDate: { type: Date, default: null },
+        agreedRentAmount: { type: Number, default: null },
+        currency:         { type: String, default: 'KES' },
+        status: {
+            type: String,
+            enum: [
+                'lead',
+                'viewing_requested',
+                'viewing_confirmed',
+                'applied',
+                'application_approved',
+                'reserved',
+                'offer_sent',
+                'tenant_confirmed',
+                'payment_pending',
+                'rented',
+                'cancelled',
+                'expired',
+                'lost',
+            ],
+            default: 'lead',
+            index: true,
+        },
+        commissionStatus: {
+            type: String,
+            enum: ['not_due', 'due', 'invoiced', 'paid', 'waived', 'refunded', 'disputed'],
+            default: 'not_due',
+            index: true,
+        },
+        lastEvent:       { type: String, default: null },
+        cancelledReason: { type: String, default: null },
+        notes:           { type: String, default: null },
+        payserveSync: {
+            status: {
+                type: String,
+                enum: ['not_applicable', 'pending', 'synced', 'failed'],
+                default: 'not_applicable',
+            },
+            residentId: { type: ObjectId, default: null },
+            leaseId:    { type: ObjectId, default: null },
+            invoiceId:  { type: ObjectId, default: null },
+            lastError:  { type: String, default: null },
+            syncedAt:   { type: Date, default: null },
+        },
+    },
+    { timestamps: true }
+);
+
+moveInDealSchema.index({ unitId: 1, status: 1 });
+moveInDealSchema.index({ tenantId: 1, unitId: 1 });
+moveInDealSchema.index({ tenantEmail: 1, unitId: 1 });
+
+const MoveInDeal = mongoose.model('MoveInDeal', moveInDealSchema);
+module.exports = MoveInDeal;

package/src/models/movein_disbursement.js

@@ -0,0 +1,37 @@
+const mongoose = require('mongoose');
+
+const moveInDisbursementSchema = new mongoose.Schema(
+    {
+        tenancyId:       { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
+        unitId:          { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
+        landlordId:      { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
+        tenantId:        { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
+
+        // Amounts
+        totalCollected:  { type: Number, required: true },
+        commissionAmount:{ type: Number, required: true },
+        netAmount:       { type: Number, required: true },  // totalCollected - commissionAmount
+        currency:        { type: String, default: 'KES' },
+
+        // Disbursement details
+        status:          { type: String, enum: ['pending', 'processing', 'settled', 'failed'], default: 'pending', index: true },
+        method:          { type: String, enum: ['mpesa', 'bank', null], default: null },
+        reference:       { type: String, default: null },  // M-Pesa code or bank ref
+        disbursedAt:     { type: Date, default: null },
+        disbursedBy:     { type: mongoose.Schema.Types.ObjectId, default: null },
+        note:            { type: String, default: null },
+
+        // Bank details snapshot at time of disbursement
+        bankName:        { type: String, default: null },
+        bankAccount:     { type: String, default: null },
+        bankBranch:      { type: String, default: null },
+
+        // Invoice references
+        landlordInvoiceId: { type: mongoose.Schema.Types.ObjectId, default: null },
+        landlordReceiptId: { type: mongoose.Schema.Types.ObjectId, default: null },
+    },
+    { timestamps: true }
+);
+
+const MoveInDisbursement = mongoose.model('MoveInDisbursement', moveInDisbursementSchema);
+module.exports = MoveInDisbursement;

package/src/models/movein_email_thread.js

@@ -0,0 +1,20 @@
+const mongoose = require('mongoose');
+
+const moveInEmailThreadSchema = new mongoose.Schema(
+    {
+        messageId: { type: String, required: true, unique: true, index: true },
+        from:      { type: String, default: '' },
+        fromName:  { type: String, default: '' },
+        subject:   { type: String, default: '(no subject)' },
+        bodyText:  { type: String, default: '' },
+        bodyHtml:  { type: String, default: '' },
+        date:      { type: Date, default: Date.now },
+        uid:       { type: Number, default: null },
+        isRead:    { type: Boolean, default: false },
+        isReplied: { type: Boolean, default: false },
+    },
+    { timestamps: true }
+);
+
+const MoveInEmailThread = mongoose.model('MoveInEmailThread', moveInEmailThreadSchema);
+module.exports = MoveInEmailThread;

package/src/models/movein_enquiry.js

@@ -0,0 +1,17 @@
+const mongoose = require('mongoose');
+
+const moveInEnquirySchema = new mongoose.Schema(
+    {
+        unitId:     { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
+        landlordId: { type: mongoose.Schema.Types.ObjectId, default: null, index: true },
+        fullName:   { type: String, required: true, trim: true },
+        phone:      { type: String, default: null },
+        email:      { type: String, required: true, trim: true, lowercase: true },
+        message:    { type: String, default: null },
+        isRead:     { type: Boolean, default: false },
+    },
+    { timestamps: true }
+);
+
+const MoveInEnquiry = mongoose.model('MoveInEnquiry', moveInEnquirySchema);
+module.exports = MoveInEnquiry;

package/src/models/movein_featured_package.js

@@ -0,0 +1,17 @@
+const mongoose = require('mongoose');
+
+const moveInFeaturedPackageSchema = new mongoose.Schema(
+    {
+        name:         { type: String, required: true, trim: true, maxlength: 80 },
+        description:  { type: String, default: '', maxlength: 500 },
+        durationDays: { type: Number, required: true, min: 1, max: 365 },
+        price:        { type: Number, required: true, min: 0 },
+        sortOrder:    { type: Number, default: 0 },
+        isActive:     { type: Boolean, default: true },
+        createdBy:    { type: mongoose.Schema.Types.ObjectId, default: null },
+    },
+    { timestamps: true }
+);
+
+const MoveInFeaturedPackage = mongoose.model('MoveInFeaturedPackage', moveInFeaturedPackageSchema);
+module.exports = MoveInFeaturedPackage;

package/src/models/movein_handoff_token.js

@@ -1,16 +1,16 @@
-const mongoose = require('mongoose');
-
-// Short-lived, single-use token that lets a landlord_main session
-// bootstrap a Move-In session without re-logging in.
-const moveInHandoffTokenSchema = new mongoose.Schema(
-    {
-        token:      { type: String, required: true, unique: true, index: true },
-        landlordId: { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
-        used:       { type: Boolean, default: false },
-        expiresAt:  { type: Date, required: true },
-    },
-    { timestamps: true }
-);
-
-const MoveInHandoffToken = mongoose.model('MoveInHandoffToken', moveInHandoffTokenSchema);
-module.exports = MoveInHandoffToken;
+const mongoose = require('mongoose');
+
+// Short-lived, single-use token that lets a landlord_main session
+// bootstrap a Move-In session without re-logging in.
+const moveInHandoffTokenSchema = new mongoose.Schema(
+    {
+        token:      { type: String, required: true, unique: true, index: true },
+        landlordId: { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
+        used:       { type: Boolean, default: false },
+        expiresAt:  { type: Date, required: true },
+    },
+    { timestamps: true }
+);
+
+const MoveInHandoffToken = mongoose.model('MoveInHandoffToken', moveInHandoffTokenSchema);
+module.exports = MoveInHandoffToken;

package/src/models/movein_invoice.js

@@ -0,0 +1,25 @@
+const mongoose = require('mongoose');
+
+const moveInInvoiceSchema = new mongoose.Schema(
+    {
+        invoiceNumber:          { type: String, required: true, unique: true, index: true },
+        tenantName:             { type: String, required: true, trim: true },
+        tenantEmail:            { type: String, required: true, trim: true, lowercase: true },
+        tenantPhone:            { type: String, default: null },
+        unitId:                 { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
+        landlordId:             { type: mongoose.Schema.Types.ObjectId, default: null, index: true },
+        wantUnitApplicationId:  { type: mongoose.Schema.Types.ObjectId, default: null },
+        type:                   { type: String, default: 'deposit' },
+        amount:                 { type: Number, required: true },
+        currency:               { type: String, default: 'KES' },
+        status:                 { type: String, enum: ['pending', 'paid', 'cancelled', 'expired'], default: 'pending', index: true },
+        deadlineAt:             { type: Date, default: null },
+        paidAt:                 { type: Date, default: null },
+        mpesaTransactionId:     { type: String, default: null },
+        notes:                  { type: String, default: null },
+    },
+    { timestamps: true }
+);
+
+const MoveInInvoice = mongoose.model('MoveInInvoice', moveInInvoiceSchema);
+module.exports = MoveInInvoice;

package/src/models/movein_landlord.js

@@ -1,18 +1,18 @@
-const mongoose = require('mongoose');
-const ObjectId = mongoose.Schema.Types.ObjectId;
-
-// Created in payserve_movein DB when admin assigns the Move-In module to a landlord.
-// landlordId references the payserve_property User — no cross-DB constraint enforced by Mongoose.
-const moveInLandlordSchema = new mongoose.Schema(
-    {
-        landlordId: { type: ObjectId, required: true, unique: true, index: true },
-        isEnabled:  { type: Boolean, default: true, index: true },
-        assignedBy: { type: ObjectId, default: null }, // core user who assigned
-        assignedAt: { type: Date, default: Date.now },
-        revokedAt:  { type: Date, default: null },
-    },
-    { timestamps: true }
-);
-
-const MoveInLandlord = mongoose.model('MoveInLandlord', moveInLandlordSchema);
-module.exports = MoveInLandlord;
+const mongoose = require('mongoose');
+const ObjectId = mongoose.Schema.Types.ObjectId;
+
+// Created in payserve_movein DB when admin assigns the Move-In module to a landlord.
+// landlordId references the payserve_property User — no cross-DB constraint enforced by Mongoose.
+const moveInLandlordSchema = new mongoose.Schema(
+    {
+        landlordId: { type: ObjectId, required: true, unique: true, index: true },
+        isEnabled:  { type: Boolean, default: true, index: true },
+        assignedBy: { type: ObjectId, default: null }, // core user who assigned
+        assignedAt: { type: Date, default: Date.now },
+        revokedAt:  { type: Date, default: null },
+    },
+    { timestamps: true }
+);
+
+const MoveInLandlord = mongoose.model('MoveInLandlord', moveInLandlordSchema);
+module.exports = MoveInLandlord;

package/src/models/movein_landlord_user.js

@@ -1,20 +1,20 @@
-const mongoose = require('mongoose');
-
-const moveInLandlordUserSchema = new mongoose.Schema(
-    {
-        fullName:       { type: String, required: true, trim: true },
-        email:          { type: String, required: true, unique: true, lowercase: true, trim: true },
-        phoneNumber:    { type: String, required: true, unique: true },
-        // Standalone landlords have a bcrypt password.
-        // PayServe-linked landlords have MANAGED_BY_PAYSERVE — auth defers to payserve_property.
-        password:       { type: String, default: 'MANAGED_BY_PAYSERVE' },
-        companyName:    { type: String, trim: true, default: null },
-        isEnabled:      { type: Boolean, default: true },
-        // Set when provisioned from an existing PayServe landlord account.
-        payserveUserId: { type: mongoose.Schema.Types.ObjectId, default: null, index: true },
-    },
-    { timestamps: true }
-);
-
-const MoveInLandlordUser = mongoose.model('MoveInLandlordUser', moveInLandlordUserSchema);
-module.exports = MoveInLandlordUser;
+const mongoose = require('mongoose');
+
+const moveInLandlordUserSchema = new mongoose.Schema(
+    {
+        fullName:       { type: String, required: true, trim: true },
+        email:          { type: String, required: true, unique: true, lowercase: true, trim: true },
+        phoneNumber:    { type: String, required: true, unique: true },
+        // Standalone landlords have a bcrypt password.
+        // PayServe-linked landlords have MANAGED_BY_PAYSERVE — auth defers to payserve_property.
+        password:       { type: String, default: 'MANAGED_BY_PAYSERVE' },
+        companyName:    { type: String, trim: true, default: null },
+        isEnabled:      { type: Boolean, default: true },
+        // Set when provisioned from an existing PayServe landlord account.
+        payserveUserId: { type: mongoose.Schema.Types.ObjectId, default: null, index: true },
+    },
+    { timestamps: true }
+);
+
+const MoveInLandlordUser = mongoose.model('MoveInLandlordUser', moveInLandlordUserSchema);
+module.exports = MoveInLandlordUser;

package/src/models/movein_lease.js

@@ -0,0 +1,38 @@
+const mongoose = require('mongoose');
+
+const moveInLeaseSchema = new mongoose.Schema(
+    {
+        // 'default' = platform-wide template; 'unit' = unit-specific override
+        type:            { type: String, enum: ['default', 'unit'], required: true, index: true },
+        unitId:          { type: mongoose.Schema.Types.ObjectId, default: null, index: true },
+        uploadedBy:      { type: mongoose.Schema.Types.ObjectId, required: true },
+
+        // File storage
+        originalName:    { type: String, required: true },
+        filePath:        { type: String, required: true },
+        mimeType:        { type: String, default: 'application/pdf' },
+        fileSizeBytes:   { type: Number, default: null },
+
+        status:          { type: String, enum: ['active', 'superseded'], default: 'active', index: true },
+        supersededAt:    { type: Date, default: null },
+
+        // Signed copy (per tenancy — embedded subdoc array)
+        signedCopies: [
+            {
+                tenancyId:     { type: mongoose.Schema.Types.ObjectId, required: true },
+                tenantId:      { type: mongoose.Schema.Types.ObjectId, required: true },
+                filePath:      { type: String, required: true },
+                originalName:  { type: String, default: null },
+                uploadedAt:    { type: Date, default: Date.now },
+                status:        { type: String, enum: ['pending_review', 'approved', 'rejected'], default: 'pending_review' },
+                reviewedAt:    { type: Date, default: null },
+                reviewedBy:    { type: mongoose.Schema.Types.ObjectId, default: null },
+                rejectionNote: { type: String, default: null },
+            }
+        ],
+    },
+    { timestamps: true }
+);
+
+const MoveInLease = mongoose.model('MoveInLease', moveInLeaseSchema);
+module.exports = MoveInLease;

package/src/models/movein_message.js

@@ -1,27 +1,27 @@
-const mongoose = require('mongoose');
-const ObjectId = mongoose.Schema.Types.ObjectId;
-
-const moveInMessageSchema = new mongoose.Schema(
-    {
-        conversationId: { type: ObjectId, ref: 'MoveInConversation', required: true, index: true },
-        senderId:       { type: ObjectId, required: true, index: true },
-        senderType: {
-            type: String,
-            enum: ['tenant', 'landlord'],
-            required: true,
-        },
-        body:          { type: String, required: true },
-        type: {
-            type: String,
-            enum: ['text', 'image'],
-            default: 'text',
-        },
-        attachmentUrl: { type: String, default: null },
-        isRead:        { type: Boolean, default: false, index: true },
-        readAt:        { type: Date, default: null },
-    },
-    { timestamps: true }
-);
-
-const MoveInMessage = mongoose.model('MoveInMessage', moveInMessageSchema);
-module.exports = MoveInMessage;
+const mongoose = require('mongoose');
+const ObjectId = mongoose.Schema.Types.ObjectId;
+
+const moveInMessageSchema = new mongoose.Schema(
+    {
+        conversationId: { type: ObjectId, ref: 'MoveInConversation', required: true, index: true },
+        senderId:       { type: ObjectId, required: true, index: true },
+        senderType: {
+            type: String,
+            enum: ['tenant', 'landlord'],
+            required: true,
+        },
+        body:          { type: String, required: true },
+        type: {
+            type: String,
+            enum: ['text', 'image'],
+            default: 'text',
+        },
+        attachmentUrl: { type: String, default: null },
+        isRead:        { type: Boolean, default: false, index: true },
+        readAt:        { type: Date, default: null },
+    },
+    { timestamps: true }
+);
+
+const MoveInMessage = mongoose.model('MoveInMessage', moveInMessageSchema);
+module.exports = MoveInMessage;

package/src/models/movein_notification.js

@@ -1,27 +1,27 @@
-const mongoose = require('mongoose');
-const ObjectId = mongoose.Schema.Types.ObjectId;
-
-const moveInNotificationSchema = new mongoose.Schema(
-    {
-        recipientId: { type: ObjectId, required: true, index: true },
-        recipientType: {
-            type: String,
-            enum: ['tenant', 'landlord'],
-            required: true,
-        },
-        title:   { type: String, required: true },
-        body:    { type: String, required: true },
-        type: {
-            type: String,
-            enum: ['application', 'viewing', 'reservation', 'payment', 'message', 'general'],
-            default: 'general',
-        },
-        relatedId:   { type: ObjectId, default: null },
-        isRead:      { type: Boolean, default: false, index: true },
-        readAt:      { type: Date, default: null },
-    },
-    { timestamps: true }
-);
-
-const MoveInNotification = mongoose.model('MoveInNotification', moveInNotificationSchema);
-module.exports = MoveInNotification;
+const mongoose = require('mongoose');
+const ObjectId = mongoose.Schema.Types.ObjectId;
+
+const moveInNotificationSchema = new mongoose.Schema(
+    {
+        recipientId: { type: ObjectId, required: true, index: true },
+        recipientType: {
+            type: String,
+            enum: ['tenant', 'landlord'],
+            required: true,
+        },
+        title:   { type: String, required: true },
+        body:    { type: String, required: true },
+        type: {
+            type: String,
+            enum: ['application', 'viewing', 'reservation', 'payment', 'message', 'general'],
+            default: 'general',
+        },
+        relatedId:   { type: ObjectId, default: null },
+        isRead:      { type: Boolean, default: false, index: true },
+        readAt:      { type: Date, default: null },
+    },
+    { timestamps: true }
+);
+
+const MoveInNotification = mongoose.model('MoveInNotification', moveInNotificationSchema);
+module.exports = MoveInNotification;

package/src/models/movein_otp.js

@@ -1,14 +1,14 @@
-const mongoose = require('mongoose');
-
-const moveInOtpSchema = new mongoose.Schema(
-    {
-        email:     { type: String, required: true, lowercase: true, trim: true, index: true },
-        otp:       { type: String, required: true },
-        expiresAt: { type: Date, required: true },
-        used:      { type: Boolean, default: false },
-    },
-    { timestamps: true }
-);
-
-const MoveInOtp = mongoose.model('MoveInOtp', moveInOtpSchema);
-module.exports = MoveInOtp;
+const mongoose = require('mongoose');
+
+const moveInOtpSchema = new mongoose.Schema(
+    {
+        email:     { type: String, required: true, lowercase: true, trim: true, index: true },
+        otp:       { type: String, required: true },
+        expiresAt: { type: Date, required: true },
+        used:      { type: Boolean, default: false },
+    },
+    { timestamps: true }
+);
+
+const MoveInOtp = mongoose.model('MoveInOtp', moveInOtpSchema);
+module.exports = MoveInOtp;