payservedb 3.8.9 → 3.9.1

package/index.js

@@ -108,6 +108,7 @@ const models = {
     CountryTaxRate: require('./src/models/country_tax'),
     Meter: require('./src/models/smart_water_meter'),
     DailyConsumption: require('./src/models/smart_meter_daily_consumption'),
+    WaterMeterSettings: require('./src/models/water_meter_settings'),
     AnalogMeter: require('./src/models/analog_water_meter'),
     MeterSize: require('./src/models/water_meter_size'),
     MeterProtocol: require('./src/models/water_meter_communication'),

package/package.json

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

package/src/models/handover.js

@@ -1,139 +1,245 @@
-const mongoose = require("mongoose");
+const mongoose = require('mongoose');
 
-// Schema for Handover Checklist Items
-const checklistItemSchema = new mongoose.Schema({
-  itemName: {
+const handoverItemSchema = new mongoose.Schema({
+  name: {
     type: String,
     required: true,
+    trim: true
   },
   category: {
     type: String,
     required: true,
-    enum: ["Appliances", "Furniture", "Electronics", "Utilities", "Structure", "Other"]
+    trim: true,
+    enum: ['Furniture', 'Appliance', 'Electronics', 'Fixture', 'Utility', 'Other']
   },
-  status: {
+  description: {
     type: String,
-    required: true,
-    enum: ["Working", "Not Working"]
+    trim: true
   },
-  notes: {
+  condition: {
     type: String,
-    default: ""
+    required: true,
+    enum: ['Excellent', 'Good', 'Fair', 'Poor', 'Damaged', 'Non-functional']
   },
-  photos: [{
-    url: String,
-    uploadedAt: Date
-  }]
-}, {
-  timestamps: true
-});
-
-// Main Handover Schema
-const handoverSchema = new mongoose.Schema({
-  // Basic Information
-  handoverType: {
-    type: String,
+  quantity: {
+    type: Number,
     required: true,
-    enum: ["Move-In", "Move-Out"]
+    default: 1,
+    min: [1, 'Quantity must be at least 1']
   },
-  facility: {
-    type: mongoose.Schema.Types.ObjectId,
-    ref: "Facility",
-    required: true
+  serialNumber: {
+    type: String,
+    trim: true
   },
-  unit: {
+  images: [{
+    type: String,  // URLs to stored images
+    trim: true
+  }],
+  notes: {
+    type: String,
+    trim: true
+  }
+}, { _id: true });
+
+// Define the main Handover schema
+const handoverSchema = new mongoose.Schema({
+  // References
+  facilityId: {
     type: mongoose.Schema.Types.ObjectId,
-    ref: "Unit",
+    ref: 'Facility',
     required: true
   },
-  tenant: {
+  unitId: {
     type: mongoose.Schema.Types.ObjectId,
-    ref: "Customer",
+    ref: 'Unit',
     required: true
   },
-  landlord: {
+  customerId: {
     type: mongoose.Schema.Types.ObjectId,
-    ref: "Customer",
+    ref: 'Customer',
     required: true
   },
-  lease: {
+  propertyManagerId: {
     type: mongoose.Schema.Types.ObjectId,
-    ref: "LeaseAgreement",
+    ref: 'User',  // Reference to your User model
     required: true
   },
-  propertyManager: {
-    type: mongoose.Schema.Types.ObjectId,
-    ref: "User",
-    required: true
+  
+  // Handover details
+  handoverType: {
+    type: String,
+    required: true,
+    enum: ['MoveIn', 'MoveOut'],
+    trim: true
   },
-
-  // Handover Details
-  scheduledDate: {
+  handoverDate: {
     type: Date,
-    required: true
-  },
-  actualHandoverDate: {
-    type: Date
+    required: true,
+    default: Date.now
   },
   status: {
     type: String,
     required: true,
-    enum: ["Pending", "In Progress", "Completed", "Cancelled"],
-    default: "Pending"
+    enum: ['Draft', 'Completed', 'Disputed', 'Resolved'],
+    default: 'Draft'
   },
-
-  // Checklist Items
-  checklistItems: [checklistItemSchema],
-
-  // Utility Readings
-  utilityReadings: {
+  
+  // If this is a move-out handover, reference the original move-in handover
+  relatedHandoverId: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'Handover',
+    default: null  // Only populated for move-out handovers
+  },
+  
+  // Items included in the handover
+  items: [handoverItemSchema],
+  
+  // Additional information
+  meterReadings: {
     electricity: {
-      meterNumber: String,
       reading: Number,
-      photo: String
+      imageUrl: String
     },
     water: {
-      meterNumber: String,
       reading: Number,
-      photo: String
+      imageUrl: String
     },
     gas: {
-      meterNumber: String,
       reading: Number,
-      photo: String
+      imageUrl: String
     }
   },
-
-  // Documents (Optional)
-  documents: [{
-    type: {
-      type: String,
-      enum: ["Welcome Pack", "User Manual", "Inspection Report", "Utility Transfer", "Other"]
+  
+  // Key handover confirmation
+  keysHandedOver: {
+    type: Number,
+    default: 0,
+    min: 0
+  },
+  
+  // Security deposit info (for move-out)
+  securityDeposit: {
+    amount: {
+      type: Number,
+      default: 0
     },
-    name: String,
-    url: String,
-    uploadedAt: Date
-  }],
-
-  // Feedback (for Move-Out)
-  feedback: {
-    rating: {
+    deductions: [{
+      reason: {
+        type: String,
+        trim: true
+      },
+      amount: {
+        type: Number,
+        min: 0
+      },
+      description: String
+    }],
+    refundAmount: {
       type: Number,
-      min: 1,
-      max: 5
+      default: 0
+    }
+  },
+  
+  // Signature and agreement info
+  signatures: {
+    propertyManager: {
+      signature: String,  // URL to stored signature image or digital signature data
+      date: Date
     },
-    comments: String,
-    submittedAt: Date
+    customer: {
+      signature: String,  // URL to stored signature image or digital signature data
+      date: Date,
+      agreement: {
+        type: Boolean,
+        default: false
+      }
+    }
   },
-
-  // Additional Notes
+  
+  // General notes
   notes: {
-    type: String
-  }
+    type: String,
+    trim: true
+  },
+  
+  // Any attached documents
+  attachments: [{
+    name: String,
+    fileUrl: String,
+    uploadDate: {
+      type: Date,
+      default: Date.now
+    }
+  }]
 }, {
-  timestamps: true
+  timestamps: true,
+  toJSON: { virtuals: true }, // Enable virtuals when converting to JSON
+  toObject: { virtuals: true } // Enable virtuals when converting to object
 });
 
-const Handover = mongoose.model("Handover", handoverSchema);
+// Add indexes for common queries
+handoverSchema.index({ facilityId: 1, unitId: 1, handoverType: 1 });
+handoverSchema.index({ customerId: 1, handoverType: 1 });
+handoverSchema.index({ handoverDate: -1 });
+
+// Virtual for calculating total deductions
+handoverSchema.virtual('totalDeductions').get(function() {
+  if (!this.securityDeposit.deductions || this.securityDeposit.deductions.length === 0) {
+    return 0;
+  }
+  return this.securityDeposit.deductions.reduce((total, deduction) => total + (deduction.amount || 0), 0);
+});
+
+// Add method to compare move-in and move-out states
+handoverSchema.methods.compareWithMoveIn = async function() {
+  if (this.handoverType !== 'MoveOut' || !this.relatedHandoverId) {
+    throw new Error('This method can only be called on a move-out handover with a related move-in handover');
+  }
+  
+  // Find the related move-in handover
+  const MoveInHandover = mongoose.model('Handover');
+  const moveInHandover = await MoveInHandover.findById(this.relatedHandoverId);
+  
+  if (!moveInHandover) {
+    throw new Error('Related move-in handover not found');
+  }
+  
+  // Compare items and return differences
+  const differences = {
+    missing: [],
+    damaged: [],
+    changed: []
+  };
+  
+  // Check for missing or damaged items
+  moveInHandover.items.forEach(moveInItem => {
+    const moveOutItem = this.items.find(item => 
+      item.name === moveInItem.name && 
+      item.category === moveInItem.category
+    );
+    
+    if (!moveOutItem) {
+      differences.missing.push(moveInItem);
+    } else if (moveOutItem.condition !== moveInItem.condition) {
+      if (['Poor', 'Damaged', 'Non-functional'].includes(moveOutItem.condition)) {
+        differences.damaged.push({
+          item: moveOutItem,
+          originalCondition: moveInItem.condition,
+          currentCondition: moveOutItem.condition
+        });
+      } else {
+        differences.changed.push({
+          item: moveOutItem,
+          originalCondition: moveInItem.condition,
+          currentCondition: moveOutItem.condition
+        });
+      }
+    }
+  });
+  
+  return differences;
+};
+
+const Handover = mongoose.model('Handover', handoverSchema);
 
-module.exports = Handover;
+module.exports = Handover;

package/src/models/water_meter_settings.js

@@ -0,0 +1,61 @@
+const mongoose = require('mongoose');
+
+const waterMeterSettingsSchema = new mongoose.Schema({
+  facilityId: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'Facility',
+    required: true
+  },
+  minAmount: {
+    type: Number,
+    required: true,
+    default: 1
+  },
+  maxAmount: {
+    type: Number,
+    required: true,
+    default: 10000
+  },
+  gracePeriod: {
+    type: Number,
+    required: true,
+    default: 10
+  },
+  enforcePayment: {
+    type: String,
+    enum: ['yes', 'no'],
+    required: true,
+    default: 'no'
+  },
+  minimumPaymentAmount: {
+    type: Number,
+    required: true,
+    default: 0
+  },
+  tariff: {
+    type: String,
+    enum: ['yes', 'no'],
+    required: true,
+    default: 'no'
+  },
+  tariffAmount: {
+    type: Number,
+    required: true,
+    default: 0
+  },
+  fixedTariffAmount: {
+    type: Number,
+    required: true,
+    default: 0
+  },
+  notifications: {
+    type: Boolean,
+    default: false
+  }
+}, {
+  timestamps: true
+});
+
+const WaterMeterSettings = mongoose.model('WaterMeterSettings', waterMeterSettingsSchema);
+
+module.exports = WaterMeterSettings;