payservedb 5.7.9 → 5.8.0

package/src/models/water_invoice.js

@@ -1,193 +1,193 @@
-const mongoose = require('mongoose');
-
-const waterInvoiceSchema = new mongoose.Schema(
-  {
-    // Basic identifiers
-    invoiceNumber: {
-      type: String,
-      required: true,
-      unique: true
-    },
-    accountNumber: {
-      type: String,
-      required: true
-    },
-    unitName: {
-      type: String,
-      required: true,
-    },
-    yearMonth: {
-      type: String,
-      required: true,
-    },
-    facilityId: {
-      type: mongoose.Schema.Types.ObjectId,
-      required: true
-    },
-    customerId: {
-      type: mongoose.Schema.Types.ObjectId,
-      required: true
-    },
-    billingType: {
-      type: String,
-      enum: ['postpaid'],
-    },
-    balanceBroughtForward: {
-      type: Number,
-      default: 0
-    },
-    // Dates
-    dateIssued: {
-      type: Date,
-      default: Date.now
-    },
-    dueDate: {
-      type: Date,
-      required: true
-    },
-
-    // Meter & Consumption Details
-    meterNumber: {
-      type: String,
-      required: true
-    },
-    meterReadings: {
-      previousReading: {
-        type: Number,
-        required: true
-      },
-      currentReading: {
-        type: Number,
-        required: true
-      },
-      usage: {
-        type: Number,
-        required: true,
-      }
-    },
-    consumptionPeriod: {
-      startDate: {
-        type: Date,
-        required: true
-      },
-      endDate: {
-        type: Date,
-        required: true
-      }
-    },
-
-    // Charges
-    charges: {
-      waterCharge: {
-        type: Number,
-        required: true
-      },
-      sewerCharge: {
-        type: Number,
-        default: 0
-      },
-      tax: {
-        type: Number,
-        default: 0
-      },
-      fixedCharge: {
-        type: Number,
-        default: 0
-      },
-      totalMonthlyBill: {
-        type: Number,
-        required: true
-      }
-    },
-    amountPaid: {
-      type: Number,
-      default: 0
-    },
-    imageUrl: { type: String, trim: true },
-
-    // Invoice Note & Status
-    invoiceNote: {
-      type: String,
-      default: 'Payment is due within 10 days'
-    },
-    status: {
-      type: String,
-      required: true,
-      enum: ['Pending', 'Paid', 'Partially Paid', 'Cancelled', 'Overdue', 'Unpaid'],
-      default: 'Pending'
-    },
-
-    // Currency Info
-    currency: {
-      id: {
-        type: mongoose.Schema.Types.ObjectId
-      },
-      name: {
-        type: String,
-        default: 'Kenyan Shilling'
-      },
-      code: {
-        type: String,
-        default: 'KES'
-      },
-      symbol: {
-        type: String,
-        default: 'KSh'
-      }
-    },
-
-    // Payment & Reconciliation
-    reconciliationHistory: [
-      {
-        date: {
-          type: Date,
-          default: Date.now
-        },
-        amount: {
-          type: Number,
-          required: true
-        },
-        type: {
-          type: String,
-          default: 'Manual'
-        },
-        paymentReference: {
-          type: String
-        },
-        paymentCompletion: {
-          type: String,
-          default: 'Completed'
-        },
-        sourceInvoice: {
-          type: String
-        },
-        destinationInvoice: {
-          type: String
-        },
-        notes: {
-          type: String
-        },
-        remainingBalance: {
-          type: Number
-        }
-      }
-    ],
-  },
-  {
-    timestamps: true
-  }
-);
-
-waterInvoiceSchema.pre('save', function (next) {
-  if (this.isModified('dueDate') || this.isNew) {
-    const today = new Date();
-    if (this.dueDate < today && this.status === 'Pending') {
-      this.status = 'Overdue';
-    }
-  }
-  next();
-});
-
-const WaterInvoice = mongoose.model('WaterInvoice', waterInvoiceSchema);
-
-module.exports = WaterInvoice;
+const mongoose = require('mongoose');
+
+const waterInvoiceSchema = new mongoose.Schema(
+  {
+    // Basic identifiers
+    invoiceNumber: {
+      type: String,
+      required: true,
+      unique: true
+    },
+    accountNumber: {
+      type: String,
+      required: true
+    },
+    unitName: {
+      type: String,
+      required: true,
+    },
+    yearMonth: {
+      type: String,
+      required: true,
+    },
+    facilityId: {
+      type: mongoose.Schema.Types.ObjectId,
+      required: true
+    },
+    customerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      required: true
+    },
+    billingType: {
+      type: String,
+      enum: ['postpaid'],
+    },
+    balanceBroughtForward: {
+      type: Number,
+      default: 0
+    },
+    // Dates
+    dateIssued: {
+      type: Date,
+      default: Date.now
+    },
+    dueDate: {
+      type: Date,
+      required: true
+    },
+
+    // Meter & Consumption Details
+    meterNumber: {
+      type: String,
+      required: true
+    },
+    meterReadings: {
+      previousReading: {
+        type: Number,
+        required: true
+      },
+      currentReading: {
+        type: Number,
+        required: true
+      },
+      usage: {
+        type: Number,
+        required: true,
+      }
+    },
+    consumptionPeriod: {
+      startDate: {
+        type: Date,
+        required: true
+      },
+      endDate: {
+        type: Date,
+        required: true
+      }
+    },
+
+    // Charges
+    charges: {
+      waterCharge: {
+        type: Number,
+        required: true
+      },
+      sewerCharge: {
+        type: Number,
+        default: 0
+      },
+      tax: {
+        type: Number,
+        default: 0
+      },
+      fixedCharge: {
+        type: Number,
+        default: 0
+      },
+      totalMonthlyBill: {
+        type: Number,
+        required: true
+      }
+    },
+    amountPaid: {
+      type: Number,
+      default: 0
+    },
+    imageUrl: { type: String, trim: true },
+
+    // Invoice Note & Status
+    invoiceNote: {
+      type: String,
+      default: 'Payment is due within 10 days'
+    },
+    status: {
+      type: String,
+      required: true,
+      enum: ['Pending', 'Paid', 'Partially Paid', 'Cancelled', 'Overdue', 'Unpaid'],
+      default: 'Pending'
+    },
+
+    // Currency Info
+    currency: {
+      id: {
+        type: mongoose.Schema.Types.ObjectId
+      },
+      name: {
+        type: String,
+        default: 'Kenyan Shilling'
+      },
+      code: {
+        type: String,
+        default: 'KES'
+      },
+      symbol: {
+        type: String,
+        default: 'KSh'
+      }
+    },
+
+    // Payment & Reconciliation
+    reconciliationHistory: [
+      {
+        date: {
+          type: Date,
+          default: Date.now
+        },
+        amount: {
+          type: Number,
+          required: true
+        },
+        type: {
+          type: String,
+          default: 'Manual'
+        },
+        paymentReference: {
+          type: String
+        },
+        paymentCompletion: {
+          type: String,
+          default: 'Completed'
+        },
+        sourceInvoice: {
+          type: String
+        },
+        destinationInvoice: {
+          type: String
+        },
+        notes: {
+          type: String
+        },
+        remainingBalance: {
+          type: Number
+        }
+      }
+    ],
+  },
+  {
+    timestamps: true
+  }
+);
+
+waterInvoiceSchema.pre('save', function (next) {
+  if (this.isModified('dueDate') || this.isNew) {
+    const today = new Date();
+    if (this.dueDate < today && this.status === 'Pending') {
+      this.status = 'Overdue';
+    }
+  }
+  next();
+});
+
+const WaterInvoice = mongoose.model('WaterInvoice', waterInvoiceSchema);
+
+module.exports = WaterInvoice;

package/src/models/water_meter_account.js

@@ -1,78 +1,78 @@
-const mongoose = require('mongoose');
-
-const waterMeterAccountSchema = new mongoose.Schema({
-    facilityId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Facility',
-        required: true,
-    },
-    account_no: {
-        type: String,
-        required: true,
-        trim: true
-    },
-    customerId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Customer',
-    },
-    customerName: {
-        type: String,
-        required: true,
-        trim: true
-    },
-    phoneNumber: {
-        type: String,
-        required: true,
-        trim: true
-    },
-    email: {
-        type: String,
-        required: true,
-        trim: true
-    },
-    meterNumber: {
-        type: String,
-        required: true,
-        unique: true,
-        trim: true
-    },
-    unitId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Unit',
-    },
-    payment_type: {
-        type: String,
-        required: true,
-        enum: ['Postpaid', 'Prepaid']
-    },
-    previousReading: {
-        type: Number,
-        required: true,
-        default: 0
-    },
-    currentReading: {
-        type: Number,
-        required: true
-    },
-    status: {
-        type: String,
-        required: true,
-        enum: ['Active', 'Inactive'],
-        default: 'Active'
-    },
-    created_on: {
-        type: Date,
-        required: true,
-        default: Date.now
-    },
-    meter_id: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'WaterMeter',
-    }
-}, {
-    timestamps: true
-});
-
-const WaterMeterAccount = mongoose.model('WaterMeterAccount', waterMeterAccountSchema);
-
-module.exports = WaterMeterAccount;
+const mongoose = require('mongoose');
+
+const waterMeterAccountSchema = new mongoose.Schema({
+    facilityId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true,
+    },
+    account_no: {
+        type: String,
+        required: true,
+        trim: true
+    },
+    customerId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Customer',
+    },
+    customerName: {
+        type: String,
+        required: true,
+        trim: true
+    },
+    phoneNumber: {
+        type: String,
+        required: true,
+        trim: true
+    },
+    email: {
+        type: String,
+        required: true,
+        trim: true
+    },
+    meterNumber: {
+        type: String,
+        required: true,
+        unique: true,
+        trim: true
+    },
+    unitId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Unit',
+    },
+    payment_type: {
+        type: String,
+        required: true,
+        enum: ['Postpaid', 'Prepaid']
+    },
+    previousReading: {
+        type: Number,
+        required: true,
+        default: 0
+    },
+    currentReading: {
+        type: Number,
+        required: true
+    },
+    status: {
+        type: String,
+        required: true,
+        enum: ['Active', 'Inactive'],
+        default: 'Active'
+    },
+    created_on: {
+        type: Date,
+        required: true,
+        default: Date.now
+    },
+    meter_id: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'WaterMeter',
+    }
+}, {
+    timestamps: true
+});
+
+const WaterMeterAccount = mongoose.model('WaterMeterAccount', waterMeterAccountSchema);
+
+module.exports = WaterMeterAccount;

package/src/models/water_meter_billing.js

@@ -1,58 +1,58 @@
-const mongoose = require('mongoose');
-
-const analogBillingSchema = new mongoose.Schema({
-    facilityId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Facility',
-        required: true,
-    },
-    meterNumber: {
-        type: String,
-        required: true,
-    },
-    accountNumber: {
-        type: String,
-        required: true,
-    },
-    currentReading: {
-        type: Number,
-        required: true,
-    },
-    previousReading: {
-        type: Number,
-        required: true,
-    },
-    yearMonth: {
-        type: String, // Expected format: 'YYYY-MM'
-        required: true,
-    },
-    totalUsage: {
-        type: Number,
-        required: true,
-    },
-    unitName: {
-        type: String,
-        required: true,
-    },
-    customerId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Customer',
-    },
-    billingType: {
-        type: String,
-        enum: ['postpaid'],
-    },
-    status: {
-        type: String,
-        enum: ['pending', 'reviewed', 'billed'],
-        default: 'pending',
-    },
-}, {
-    timestamps: true,
-});
-
-analogBillingSchema.index({ meterNumber: 1, yearMonth: 1 }, { unique: true });
-
-const AnalogBilling = mongoose.model('AnalogBilling', analogBillingSchema);
-
-module.exports = AnalogBilling;
+const mongoose = require('mongoose');
+
+const analogBillingSchema = new mongoose.Schema({
+    facilityId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true,
+    },
+    meterNumber: {
+        type: String,
+        required: true,
+    },
+    accountNumber: {
+        type: String,
+        required: true,
+    },
+    currentReading: {
+        type: Number,
+        required: true,
+    },
+    previousReading: {
+        type: Number,
+        required: true,
+    },
+    yearMonth: {
+        type: String, // Expected format: 'YYYY-MM'
+        required: true,
+    },
+    totalUsage: {
+        type: Number,
+        required: true,
+    },
+    unitName: {
+        type: String,
+        required: true,
+    },
+    customerId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Customer',
+    },
+    billingType: {
+        type: String,
+        enum: ['postpaid'],
+    },
+    status: {
+        type: String,
+        enum: ['pending', 'reviewed', 'billed'],
+        default: 'pending',
+    },
+}, {
+    timestamps: true,
+});
+
+analogBillingSchema.index({ meterNumber: 1, yearMonth: 1 }, { unique: true });
+
+const AnalogBilling = mongoose.model('AnalogBilling', analogBillingSchema);
+
+module.exports = AnalogBilling;

package/src/models/water_meter_communication.js

@@ -1,18 +1,18 @@
-const mongoose = require('mongoose');
-
-const protocolSchema = new mongoose.Schema({
-    name: {
-        type: String,
-        required: true,
-        unique: true,
-        trim: true,
-        uppercase: true,
-        // Example: TCP, GPRS, API, etc.
-    }
-}, {
-    timestamps: true
-});
-
-const MeterProtocol = mongoose.model('MeterProtocol', protocolSchema);
-
+const mongoose = require('mongoose');
+
+const protocolSchema = new mongoose.Schema({
+    name: {
+        type: String,
+        required: true,
+        unique: true,
+        trim: true,
+        uppercase: true,
+        // Example: TCP, GPRS, API, etc.
+    }
+}, {
+    timestamps: true
+});
+
+const MeterProtocol = mongoose.model('MeterProtocol', protocolSchema);
+
 module.exports = MeterProtocol;