payservedb 5.8.6 → 5.8.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payservedb",
-  "version": "5.8.6",
+  "version": "5.8.8",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/src/models/propertyManagerContract.js

@@ -9,7 +9,7 @@ const PropertyManagerContractSchema = new Schema(
         },
         propertyManager: {
             type: mongoose.Schema.Types.ObjectId,
-            ref: 'User',
+            ref: 'User', // References global User collection
             required: [true, 'Property manager is required']
         },
         units: [{
@@ -19,7 +19,7 @@ const PropertyManagerContractSchema = new Schema(
         }],
         customerId: {
             type: mongoose.Schema.Types.ObjectId,
-            ref: 'Customer',
+            ref: 'Customer', // Can reference global or facility-specific Customer
             required: [true, 'Customer ID is required']
         },
         facilityId: {
@@ -81,7 +81,17 @@ const PropertyManagerContractSchema = new Schema(
             value: {
                 type: Number,
                 required: [true, 'Management fee value is required'],
-                min: [0, 'Management fee value cannot be negative']
+                min: [0, 'Management fee value cannot be negative'],
+                validate: {
+                    validator: function(value) {
+                        // If type is percentage, value should not exceed 100
+                        if (this.managementFee.type === 'percentage') {
+                            return value <= 100;
+                        }
+                        return true;
+                    },
+                    message: 'Management fee percentage cannot exceed 100%'
+                }
             }
         },
         // GL Account configurations
@@ -123,7 +133,7 @@ const PropertyManagerContractSchema = new Schema(
         },
         createdBy: {
             type: mongoose.Schema.Types.ObjectId,
-            ref: 'User'
+            ref: 'User' // References global User collection
         }
     },
     {
@@ -131,23 +141,72 @@ const PropertyManagerContractSchema = new Schema(
     }
 );
 
-// Basic validation
+// Enhanced pre-save validation
 PropertyManagerContractSchema.pre('save', function (next) {
+    // Validate date range
     if (this.startDate && this.endDate && this.startDate >= this.endDate) {
         next(new Error('End date must be after start date'));
-    } else if (!this.units || this.units.length === 0) {
+        return;
+    }
+    
+    // Validate units array
+    if (!this.units || this.units.length === 0) {
         next(new Error('At least one unit must be specified'));
-    } else if (this.managementFee.type === 'percentage' && this.managementFee.value > 100) {
+        return;
+    }
+    
+    // Validate management fee
+    if (!this.managementFee || !this.managementFee.type || this.managementFee.value === undefined) {
+        next(new Error('Management fee type and value are required'));
+        return;
+    }
+    
+    // Validate management fee percentage
+    if (this.managementFee.type === 'percentage' && this.managementFee.value > 100) {
         next(new Error('Management fee percentage cannot exceed 100%'));
-    } else {
-        next();
+        return;
+    }
+    
+    // Validate management fee value is non-negative
+    if (this.managementFee.value < 0) {
+        next(new Error('Management fee value cannot be negative'));
+        return;
+    }
+    
+    // Validate payment due date range
+    if (this.paymentDueDate && (this.paymentDueDate < 1 || this.paymentDueDate > 31)) {
+        next(new Error('Payment due date must be between 1 and 31'));
+        return;
     }
+    
+    // Validate required fields for Active status
+    if (this.status === 'Active') {
+        if (!this.startDate) {
+            next(new Error('Start date is required for Active contracts'));
+            return;
+        }
+        if (!this.endDate) {
+            next(new Error('End date is required for Active contracts'));
+            return;
+        }
+        if (!this.paymentDueDate) {
+            next(new Error('Payment due date is required for Active contracts'));
+            return;
+        }
+        if (!this.frequency) {
+            next(new Error('Payment frequency is required for Active contracts'));
+            return;
+        }
+    }
+    
+    next();
 });
 
-// Sync with lease data
+// Method to sync with lease data
 PropertyManagerContractSchema.methods.syncWithLeaseData = async function(leaseData) {
     if (!leaseData) return;
     
+    // Update contract fields from lease data
     this.startDate = leaseData.leaseTerms?.startDate || this.startDate;
     this.endDate = leaseData.leaseTerms?.endDate || this.endDate;
     this.paymentDueDate = leaseData.financialTerms?.paymentDueDate || this.paymentDueDate;
@@ -157,15 +216,253 @@ PropertyManagerContractSchema.methods.syncWithLeaseData = async function(leaseDa
     this.nextInvoiceDate = leaseData.billingCycle?.nextInvoiceDate || this.nextInvoiceDate;
     this.lastInvoiceDate = leaseData.billingCycle?.lastInvoiceDate || this.lastInvoiceDate;
     
+    // Automatically activate contract if all required fields are present
+    if (this.startDate && this.endDate && this.paymentDueDate && this.frequency && this.status === 'Inactive') {
+        this.status = 'Active';
+    }
+    
     return this.save();
 };
 
-// Basic indexes
+// Method to check if contract can be activated
+PropertyManagerContractSchema.methods.canBeActivated = function() {
+    return !!(this.startDate && this.endDate && this.paymentDueDate && this.frequency);
+};
+
+// Method to get missing required fields
+PropertyManagerContractSchema.methods.getMissingRequiredFields = function() {
+    const requiredFields = ['startDate', 'endDate', 'paymentDueDate', 'frequency'];
+    return requiredFields.filter(field => !this[field]);
+};
+
+// Virtual for contract completion status
+PropertyManagerContractSchema.virtual('isComplete').get(function() {
+    return this.canBeActivated();
+});
+
+// Virtual for contract duration in days
+PropertyManagerContractSchema.virtual('durationInDays').get(function() {
+    if (!this.startDate || !this.endDate) return null;
+    const diffTime = Math.abs(this.endDate - this.startDate);
+    return Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+});
+// Virtual for contract remaining days
+PropertyManagerContractSchema.virtual('remainingDays').get(function() {
+    if (!this.endDate) return null;
+    const now = new Date();
+    if (now > this.endDate) return 0;
+    const diffTime = Math.abs(this.endDate - now);
+    return Math.ceil(diffTime / (1000 * 60 * 60 * 24));
+});
+
+// Indexes for better query performance
 PropertyManagerContractSchema.index({ customerId: 1, status: 1 });
-PropertyManagerContractSchema.index({ facilityId: 1 });
-PropertyManagerContractSchema.index({ propertyManager: 1 });
+PropertyManagerContractSchema.index({ facilityId: 1, status: 1 });
+PropertyManagerContractSchema.index({ propertyManager: 1, facilityId: 1 });
+PropertyManagerContractSchema.index({ units: 1, status: 1 });
 PropertyManagerContractSchema.index({ nextInvoiceDate: 1, status: 1 });
+PropertyManagerContractSchema.index({ endDate: 1, status: 1 }); // For contract expiration queries
+PropertyManagerContractSchema.index({ 'managementFee.type': 1, 'managementFee.value': 1 }); // For fee analysis
+PropertyManagerContractSchema.index({ createdAt: -1 }); // For recent contracts
+PropertyManagerContractSchema.index({ startDate: 1, endDate: 1 }); // For date range queries
+
+// Compound indexes for common query patterns
+PropertyManagerContractSchema.index({ 
+    facilityId: 1, 
+    propertyManager: 1, 
+    status: 1 
+});
+
+PropertyManagerContractSchema.index({ 
+    facilityId: 1, 
+    customerId: 1, 
+    status: 1 
+});
+
+// Text index for searching contract names
+PropertyManagerContractSchema.index({ 
+    contractName: 'text' 
+});
+
+// Static methods for common queries
+PropertyManagerContractSchema.statics.findActiveContractsByFacility = function(facilityId) {
+    return this.find({
+        facilityId: facilityId,
+        status: 'Active'
+    }).populate('propertyManager', 'fullName email')
+      .populate('units', 'name unitType')
+      .populate('customerId', 'firstName lastName email');
+};
+
+PropertyManagerContractSchema.statics.findContractsByPropertyManager = function(propertyManagerId, facilityId) {
+    return this.find({
+        propertyManager: propertyManagerId,
+        facilityId: facilityId
+    }).populate('units', 'name unitType')
+      .populate('customerId', 'firstName lastName email')
+      .sort({ createdAt: -1 });
+};
+
+PropertyManagerContractSchema.statics.findExpiringContracts = function(facilityId, daysAhead = 30) {
+    const futureDate = new Date();
+    futureDate.setDate(futureDate.getDate() + daysAhead);
+    
+    return this.find({
+        facilityId: facilityId,
+        status: 'Active',
+        endDate: {
+            $gte: new Date(),
+            $lte: futureDate
+        }
+    }).populate('propertyManager', 'fullName email')
+      .populate('units', 'name unitType')
+      .populate('customerId', 'firstName lastName email')
+      .sort({ endDate: 1 });
+};
+
+PropertyManagerContractSchema.statics.findContractsRequiringInvoicing = function(facilityId) {
+    const today = new Date();
+    today.setHours(0, 0, 0, 0);
+    
+    return this.find({
+        facilityId: facilityId,
+        status: 'Active',
+        nextInvoiceDate: {
+            $lte: today
+        }
+    }).populate('propertyManager', 'fullName email')
+      .populate('units', 'name unitType')
+      .populate('customerId', 'firstName lastName email');
+};
+
+// Instance methods for contract management
+PropertyManagerContractSchema.methods.calculateNextInvoiceDate = function() {
+    if (!this.lastInvoiceDate && !this.startDate) return null;
+    
+    const baseDate = this.lastInvoiceDate || this.startDate;
+    const nextDate = new Date(baseDate);
+    
+    switch (this.frequency) {
+        case 'Monthly':
+            nextDate.setMonth(nextDate.getMonth() + 1);
+            break;
+        case 'Quarterly':
+            nextDate.setMonth(nextDate.getMonth() + 3);
+            break;
+        case 'Annually':
+            nextDate.setFullYear(nextDate.getFullYear() + 1);
+            break;
+        default:
+            nextDate.setMonth(nextDate.getMonth() + 1); // Default to monthly
+    }
+    
+    // Set to the payment due date of the month
+    if (this.paymentDueDate) {
+        const lastDayOfMonth = new Date(nextDate.getFullYear(), nextDate.getMonth() + 1, 0).getDate();
+        const dueDate = Math.min(this.paymentDueDate, lastDayOfMonth);
+        nextDate.setDate(dueDate);
+    }
+    
+    return nextDate;
+};
+
+PropertyManagerContractSchema.methods.updateInvoiceDates = async function(invoiceDate = new Date()) {
+    this.lastInvoiceDate = invoiceDate;
+    this.nextInvoiceDate = this.calculateNextInvoiceDate();
+    return this.save();
+};
+
+PropertyManagerContractSchema.methods.activateContract = async function() {
+    if (!this.canBeActivated()) {
+        throw new Error(`Cannot activate contract: missing required fields - ${this.getMissingRequiredFields().join(', ')}`);
+    }
+    
+    this.status = 'Active';
+    
+    // Set next invoice date if not already set
+    if (!this.nextInvoiceDate) {
+        this.nextInvoiceDate = this.calculateNextInvoiceDate();
+    }
+    
+    return this.save();
+};
+
+PropertyManagerContractSchema.methods.suspendContract = async function(reason) {
+    this.status = 'Suspended';
+    this.suspensionReason = reason;
+    return this.save();
+};
+
+PropertyManagerContractSchema.methods.terminateContract = async function(reason, terminationDate = new Date()) {
+    this.status = 'Terminated';
+    this.terminationReason = reason;
+    this.terminationDate = terminationDate;
+    return this.save();
+};
+
+PropertyManagerContractSchema.methods.completeContract = async function() {
+    this.status = 'Completed';
+    this.completionDate = new Date();
+    return this.save();
+};
+
+// Pre-findOneAndUpdate middleware to maintain data integrity
+PropertyManagerContractSchema.pre(['findOneAndUpdate', 'updateOne', 'updateMany'], function() {
+    const update = this.getUpdate();
+    
+    // If status is being changed to Active, ensure required fields are present
+    if (update.$set && update.$set.status === 'Active') {
+        const requiredFields = ['startDate', 'endDate', 'paymentDueDate', 'frequency'];
+        // Note: We can't validate here because we don't have access to the full document
+        // Validation should be done in the application logic before calling update
+    }
+    
+    // Update the updatedAt field
+    if (update.$set) {
+        update.$set.updatedAt = new Date();
+    } else {
+        this.set({ updatedAt: new Date() });
+    }
+});
+
+// Post-save middleware for logging and notifications
+PropertyManagerContractSchema.post('save', function(doc) {
+    // Log contract creation/updates
+    console.log(`Property Manager Contract ${doc.isNew ? 'created' : 'updated'}: ${doc.contractName} (${doc._id})`);
+    
+    // Here you could add webhook calls, email notifications, etc.
+    // Example: notify property manager of contract status changes
+    if (this.isModified('status')) {
+        console.log(`Contract status changed to: ${doc.status}`);
+        // Add notification logic here
+    }
+});
+
+// Error handling for validation errors
+PropertyManagerContractSchema.post('save', function(error, doc, next) {
+    if (error.name === 'ValidationError') {
+        const messages = Object.values(error.errors).map(err => err.message);
+        next(new Error(`Contract validation failed: ${messages.join(', ')}`));
+    } else {
+        next(error);
+    }
+});
+
+// JSON transformation to remove sensitive data when returning to client
+PropertyManagerContractSchema.methods.toJSON = function() {
+    const contract = this.toObject();
+    
+    // Add computed fields
+    contract.isComplete = this.isComplete;
+    contract.canBeActivated = this.canBeActivated();
+    contract.missingRequiredFields = this.getMissingRequiredFields();
+    contract.durationInDays = this.durationInDays;
+    contract.remainingDays = this.remainingDays;
+    
+    return contract;
+};
 
+// Export the schema
 module.exports = {
     schema: PropertyManagerContractSchema,
     name: 'PropertyManagerContract'

package/src/models/user.js

@@ -28,8 +28,8 @@ const userSchema = new mongoose.Schema({
         enum: ['Company', 'Project Manager', 'Universal', 'Core', 'Resident', 'Landlord', 'Supplier'],
     },
     department: {
-        type: String,
-        trim: true,
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'FacilityDepartment',
     },
     role: {
         type: String,
@@ -184,4 +184,4 @@ userSchema.index({ fullName: 'text', email: 'text' });
 
 const User = mongoose.model('User', userSchema);
 
-module.exports = User;
+module.exports = User;