payservedb 8.3.9 → 8.4.1

package/src/models/water_meter_settings.js

@@ -1,284 +1,288 @@
-const mongoose = require('mongoose');
-
-const waterMeterSettingsSchema = new mongoose.Schema({
-  facilityId: {
-    type: mongoose.Schema.Types.ObjectId,
-    ref: 'Facility',
-    required: true,
-    unique: true
-  },
-  minAmount: {
-    type: Number,
-    required: true,
-    default: 1
-  },
-  maxAmount: {
-    type: Number,
-    required: true,
-    default: 10000
-  },
-  lowThreshold: {
-    type: Number,
-    default: 0
-  },
-  highThreshold: {
-    type: Number,
-    default: 0
-  },
-  gracePeriod: {
-    type: Number,
-    required: true,
-    default: 10
-  },
-  invoiceDay: {
-    type: Number,
-    required: true,
-    min: 0,
-    max: 30,
-    default: 3
-  },
-  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
-  },
-  tariffAmountSmart: {
-    type: Number,
-    default: 0
-  },
-  fixedTariffAmount: {
-    type: Number,
-    required: true,
-    default: 0
-  },
-  meterLoan: {
-    type: Number,
-    required: true,
-    default: 0
-  },
-
-  // Updated notification structure - separated concerns
-  notifications: {
-    // Usage and billing notifications
-    usageAlerts: {
-      enabled: {
-        type: Boolean,
-        default: false
-      },
-      daily: {
-        type: Boolean,
-        default: false
-      },
-      weekly: {
-        type: Boolean,
-        default: false
-      },
-      monthly: {
-        type: Boolean,
-        default: false
-      }
-    },
-    statements: {
-      enabled: {
-        type: Boolean,
-        default: false
-      }
-    },
-    // Payment reminder notifications 
-    paymentReminders: {
-      enabled: {
-        type: Boolean,
-        default: false
-      },
-      daysBeforeDue: {
-        type: Number,
-        default: 3,
-        min: 1,
-        max: 30
-      },
-      frequency: {
-        type: String,
-        enum: ['daily', 'weekly', 'once'],
-        default: 'once'
-      }
-    }
-  },
-
-  // Other charges section
-  otherCharges: {
-    type: String,
-    enum: ['yes', 'no'],
-    default: 'no'
-  },
-  sewerageCharge: {
-    type: Number,
-    default: 0
-  },
-  fixedCharge: {
-    type: Number,
-    default: 0
-  },
-  vatPercentage: {
-    type: Number,
-    min: 0,
-    max: 100,
-    default: 0
-  },
-
-  // Payment methods
-  paymentMethods: {
-    mobilePayment: {
-      status: {
-        type: Boolean,
-        default: false
-      },
-      paymentId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'FacilityPaymentDetails'
-      }
-    },
-    bankPayment: {
-      status: {
-        type: Boolean,
-        default: false
-      },
-      paymentId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'BankDetails'
-      }
-    }
-  },
-
-  // Discounts
-  discounts: [{
-    name: {
-      type: String,
-      required: true,
-      trim: true
-    },
-    type: {
-      type: String,
-      enum: ['percentage', 'fixed_amount'],
-      required: true
-    },
-    value: {
-      type: Number,
-      required: true,
-      min: 0
-    },
-    yearMonth: {
-      type: String,
-      required: true
-    }
-  }],
-
-  // Biller address for invoices
-  billerAddress: {
-    name: {
-      type: String,
-      trim: true,
-    },
-    email: {
-      type: String,
-      trim: true,
-      lowercase: true,
-      validate: {
-        validator: function (v) {
-          if (!v) return true; // allow empty
-          return /^\w+([\.-]?\w+)@\w+([\.-]?\w+)(\.\w{2,3})+$/.test(v);
-        },
-        message: "Please enter a valid email address"
-      }
-    },
-    phone: {
-      type: String,
-      trim: true,
-    },
-    address: {
-      type: String,
-      trim: true,
-    },
-    city: {
-      type: String,
-      trim: true,
-    },
-    country: {
-      type: String,
-      trim: true,
-      default: "Kenya"
-    },
-    logo: {
-      type: String,
-      required: false,
-    },
-    digitalSignature: {
-      type: String,
-      required: false,
-    }
-  },
-  // GL accounts for accounting entries
-  glAccounts: {
-    invoice: {
-      debit: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "GLAccount",
-        required: false,
-      },
-      credit: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "GLAccount",
-        required: false,
-      }
-    },
-    payment: {
-      debit: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "GLAccount",
-        required: false,
-      },
-      credit: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "GLAccount",
-        required: false,
-      }
-    }
-  },
-
-  //GL ACCOUNT DOUBLE ENTRIES
-
-  invocieCreationDe: {
-    type: mongoose.Schema.Types.ObjectId,
-    ref: 'GLAccountDoubleEntries',
-    unique: true
-  },
-
-  invoicePaymentDe: {
-    type: mongoose.Schema.Types.ObjectId,
-    ref: 'GLAccountDoubleEntries',
-    unique: true
-  },
-
-}, {
-  timestamps: true
-});
-
-const WaterMeterSettings = mongoose.model('WaterMeterSettings', waterMeterSettingsSchema);
-
+const mongoose = require('mongoose');
+
+const waterMeterSettingsSchema = new mongoose.Schema({
+  facilityId: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'Facility',
+    required: true,
+    unique: true
+  },
+  minAmount: {
+    type: Number,
+    required: true,
+    default: 1
+  },
+  maxAmount: {
+    type: Number,
+    required: true,
+    default: 10000
+  },
+  lowThreshold: {
+    type: Number,
+    default: 0
+  },
+  highThreshold: {
+    type: Number,
+    default: 0
+  },
+  freeWaterAllowance: {
+    type: Number,
+    required: true,
+    default: 0,
+    min: 0,
+    description: "Free water allowance in cubic meters (m³) - users won't be billed for consumption up to this amount"
+  },
+  gracePeriod: {
+    type: Number,
+    required: true,
+    default: 10
+  },
+  invoiceDay: {
+    type: Number,
+    required: true,
+    min: 0,
+    max: 30,
+    default: 3
+  },
+  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
+  },
+  tariffAmountSmart: {
+    type: Number,
+    default: 0
+  },
+  fixedTariffAmount: {
+    type: Number,
+    required: true,
+    default: 0
+  },
+  meterLoan: {
+    type: Number,
+    required: true,
+    default: 0
+  },
+
+  // Updated notification structure - separated concerns
+  notifications: {
+    // Usage and billing notifications
+    usageAlerts: {
+      enabled: {
+        type: Boolean,
+        default: false
+      },
+      daily: {
+        type: Boolean,
+        default: false
+      },
+      weekly: {
+        type: Boolean,
+        default: false
+      },
+      monthly: {
+        type: Boolean,
+        default: false
+      }
+    },
+    statements: {
+      enabled: {
+        type: Boolean,
+        default: false
+      }
+    },
+    // Payment reminder notifications 
+    paymentReminders: {
+      enabled: {
+        type: Boolean,
+        default: false
+      },
+      daysBeforeDue: {
+        type: Number,
+        default: 3,
+        min: 1,
+        max: 30
+      },
+      frequency: {
+        type: String,
+        enum: ['daily', 'weekly', 'once'],
+        default: 'once'
+      }
+    }
+  },
+
+  // Other charges section
+  otherCharges: {
+    type: String,
+    enum: ['yes', 'no'],
+    default: 'no'
+  },
+  sewerageCharge: {
+    type: Number,
+    default: 0
+  },
+  fixedCharge: {
+    type: Number,
+    default: 0
+  },
+  vatPercentage: {
+    type: Number,
+    min: 0,
+    max: 100,
+    default: 0
+  },
+
+  // Payment methods
+  paymentMethods: {
+    mobilePayment: {
+      status: {
+        type: Boolean,
+        default: false
+      },
+      paymentId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'FacilityPaymentDetails'
+      }
+    },
+    bankPayment: {
+      status: {
+        type: Boolean,
+        default: false
+      },
+      paymentId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'BankDetails'
+      }
+    }
+  },
+
+  // Discounts
+  discounts: [{
+    name: {
+      type: String,
+      required: true,
+      trim: true
+    },
+    type: {
+      type: String,
+      enum: ['percentage', 'fixed_amount'],
+      required: true
+    },
+    value: {
+      type: Number,
+      required: true,
+      min: 0
+    },
+    yearMonth: {
+      type: String,
+      required: true
+    }
+  }],
+
+  // Biller address for invoices
+  billerAddress: {
+    name: {
+      type: String,
+      trim: true,
+    },
+    email: {
+      type: String,
+      trim: true,
+      lowercase: true,
+      validate: {
+        validator: function (v) {
+          if (!v) return true; // allow empty
+          return /^\w+([\.-]?\w+)@\w+([\.-]?\w+)(\.\w{2,3})+$/.test(v);
+        },
+        message: "Please enter a valid email address"
+      }
+    },
+    phone: {
+      type: String,
+      trim: true,
+    },
+    address: {
+      type: String,
+      trim: true,
+    },
+    city: {
+      type: String,
+      trim: true,
+    },
+    country: {
+      type: String,
+      trim: true,
+      default: "Kenya"
+    },
+    logo: {
+      type: String,
+      required: false,
+    },
+    digitalSignature: {
+      type: String,
+      required: false,
+    }
+  },
+  // GL accounts for accounting entries
+  glAccounts: {
+    invoice: {
+      debit: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "GLAccount",
+        required: false,
+      },
+      credit: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "GLAccount",
+        required: false,
+      }
+    },
+    payment: {
+      debit: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "GLAccount",
+        required: false,
+      },
+      credit: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "GLAccount",
+        required: false,
+      }
+    }
+  },
+
+  //GL ACCOUNT DOUBLE ENTRIES
+  invocieCreationDe: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'GLAccountDoubleEntries',
+    unique: true
+  },
+  invoicePaymentDe: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'GLAccountDoubleEntries',
+    unique: true
+  },
+}, {
+  timestamps: true
+});
+
+const WaterMeterSettings = mongoose.model('WaterMeterSettings', waterMeterSettingsSchema);
+
 module.exports = WaterMeterSettings;

package/src/models/water_meter_single_day_history.js

@@ -1,35 +1,35 @@
-const mongoose = require('mongoose');
-
-const singleDayWaterMeterHistorySchema = new mongoose.Schema({
-    meterId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'WaterMeter',
-        required: true,
-        index: true
-    },
-    date: {
-        type: String,
-        required: true
-    },
-    reading: {
-        type: Number,
-        required: true,
-        min: 0
-    },
-    status: {
-        type: String,
-        enum: ['opened', 'closed', 'maintenance', 'faulty'],
-        default: 'opened',
-    },
-    time: {
-        type: String,
-        required: true
-    }
-}, {
-    timestamps: true
-});
-
-singleDayWaterMeterHistorySchema.index({ meterId: 1, date: 1 });
-const SingleDayWaterMeterHistory = mongoose.model('SingleDayWaterMeterHistory', singleDayWaterMeterHistorySchema);
-
+const mongoose = require('mongoose');
+
+const singleDayWaterMeterHistorySchema = new mongoose.Schema({
+    meterId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'WaterMeter',
+        required: true,
+        index: true
+    },
+    date: {
+        type: String,
+        required: true
+    },
+    reading: {
+        type: Number,
+        required: true,
+        min: 0
+    },
+    status: {
+        type: String,
+        enum: ['opened', 'closed', 'maintenance', 'faulty'],
+        default: 'opened',
+    },
+    time: {
+        type: String,
+        required: true
+    }
+}, {
+    timestamps: true
+});
+
+singleDayWaterMeterHistorySchema.index({ meterId: 1, date: 1 });
+const SingleDayWaterMeterHistory = mongoose.model('SingleDayWaterMeterHistory', singleDayWaterMeterHistorySchema);
+
 module.exports = SingleDayWaterMeterHistory;

package/src/models/water_meter_size.js

@@ -1,16 +1,16 @@
-const mongoose = require('mongoose');
-
-const meterSizeSchema = new mongoose.Schema({
-    code: {
-        type: String,
-        required: true,
-        unique: true,
-        trim: true, // Example: DN-15, DN-20, etc.
-    }
-}, {
-    timestamps: true
-});
-
-const MeterSize = mongoose.model('MeterSize', meterSizeSchema);
-
+const mongoose = require('mongoose');
+
+const meterSizeSchema = new mongoose.Schema({
+    code: {
+        type: String,
+        required: true,
+        unique: true,
+        trim: true, // Example: DN-15, DN-20, etc.
+    }
+}, {
+    timestamps: true
+});
+
+const MeterSize = mongoose.model('MeterSize', meterSizeSchema);
+
 module.exports = MeterSize;