payservedb 5.0.1 → 5.0.3

package/src/models/penalty.js

@@ -1,77 +1,77 @@
-const mongoose = require("mongoose");
-
-const penaltySchema = new mongoose.Schema(
-  {
-    name: {
-      type: String,
-      required: true,
-    },
-    type: {
-      type: String,
-      required: true,
-      enum: ['percentage', 'fixed']
-    },
-    effectDays: {
-      type: Number,
-      required: true,
-      min: [1, "Effect days must be at least 1"]
-    },
-    percentage: {
-      type: Number,
-      required: function () {
-        return this.type === 'percentage';
-      },
-      min: [0, "Percentage must be at least 0"]
-    },
-    amount: {
-      type: Number,
-      required: function () {
-        return this.type === 'fixed';
-      },
-      min: [0, "Amount must be a positive number"]
-    },
-    module: {
-      type: String,
-      required: true,
-      enum: ['levy', 'lease', 'utility']
-    },
-    moduleId: {
-      type: mongoose.Schema.Types.ObjectId,
-      required: true,
-      refPath: 'module'
-    },
-    isActive: {
-      type: Boolean,
-      default: true,
-    },
-    facilityId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "Facility",
-      required: true,
-      index: true
-    }
-  },
-  {
-    timestamps: true,
-    indexes: [
-      { facilityId: 1, isActive: 1 },
-      { moduleId: 1, module: 1 },
-      { name: 1, facilityId: 1 }
-    ]
-  }
-);
-
-// Add any custom methods or middleware here if needed
-penaltySchema.pre('save', function (next) {
-  // Clear the irrelevant field based on penalty type
-  if (this.type === 'percentage') {
-    this.amount = null;
-  } else if (this.type === 'fixed') {
-    this.percentage = null;
-  }
-  next();
-});
-
-const Penalty = mongoose.model("Penalty", penaltySchema);
-
+const mongoose = require("mongoose");
+
+const penaltySchema = new mongoose.Schema(
+  {
+    name: {
+      type: String,
+      required: true,
+    },
+    type: {
+      type: String,
+      required: true,
+      enum: ['percentage', 'fixed']
+    },
+    effectDays: {
+      type: Number,
+      required: true,
+      min: [1, "Effect days must be at least 1"]
+    },
+    percentage: {
+      type: Number,
+      required: function () {
+        return this.type === 'percentage';
+      },
+      min: [0, "Percentage must be at least 0"]
+    },
+    amount: {
+      type: Number,
+      required: function () {
+        return this.type === 'fixed';
+      },
+      min: [0, "Amount must be a positive number"]
+    },
+    module: {
+      type: String,
+      required: true,
+      enum: ['levy', 'lease', 'utility']
+    },
+    moduleId: {
+      type: mongoose.Schema.Types.ObjectId,
+      required: true,
+      refPath: 'module'
+    },
+    isActive: {
+      type: Boolean,
+      default: true,
+    },
+    facilityId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Facility",
+      required: true,
+      index: true
+    }
+  },
+  {
+    timestamps: true,
+    indexes: [
+      { facilityId: 1, isActive: 1 },
+      { moduleId: 1, module: 1 },
+      { name: 1, facilityId: 1 }
+    ]
+  }
+);
+
+// Add any custom methods or middleware here if needed
+penaltySchema.pre('save', function (next) {
+  // Clear the irrelevant field based on penalty type
+  if (this.type === 'percentage') {
+    this.amount = null;
+  } else if (this.type === 'fixed') {
+    this.percentage = null;
+  }
+  next();
+});
+
+const Penalty = mongoose.model("Penalty", penaltySchema);
+
 module.exports = Penalty;

package/src/models/purchase_order.js

@@ -1,191 +1,191 @@
-const mongoose = require('mongoose');
-
-const purchaseOrderSchema = new mongoose.Schema({
-    // Main Purchase Order Information
-    facilityId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Facility',
-        required: true,
-        index: true
-    },
-    poNumber: {
-        type: String,
-        required: true,
-        unique: true,
-        trim: true,
-        index: true
-    },
-    prNumber: {
-        type: String,
-        trim: true,
-        index: true,
-        ref: 'PurchaseRequest'
-    },
-    supplier: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Supplier',
-        required: true
-    },
-    department: {
-        type: String,
-        required: true,
-        trim: true
-    },
-    currency: {
-        type: String,
-        required: true,
-        trim: true,
-        default: 'KES'
-    },
-    date: {
-        type: Date,
-        required: true,
-        default: Date.now
-    },
-    internalNotes: {
-        type: String,
-        trim: true
-    },
-    supplierNotes: {
-        type: String,
-        trim: true
-    },
-    budget: {
-        type: String,
-        trim: true
-    },
-    status: {
-        type: String,
-        enum: ['pending approval', 'approved', 'rejected', 'sent', 'received', 'completed', 'canceled'],
-        default: 'pending approval',
-        index: true
-    },
-
-    // Items Details
-    items: [{
-        itemDescription: {
-            type: String,
-            required: true,
-            trim: true
-        },
-        quantity: {
-            type: Number,
-            required: true
-        },
-        unitOfMeasure: {
-            type: String,
-            required: true,
-            trim: true
-        },
-        unitPrice: {
-            type: Number,
-            required: true
-        },
-        taxRate: {
-            type: Number,
-            default: 0
-        },
-        totalPrice: {
-            type: Number,
-            required: true
-        }
-    }],
-
-    // Calculated Totals
-    subtotal: {
-        type: Number,
-        required: true
-    },
-    taxTotal: {
-        type: Number,
-        required: true,
-        default: 0
-    },
-    grandTotal: {
-        type: Number,
-        required: true
-    },
-
-    // Approvers Section
-    approvers: [{
-        approverId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'User',
-            required: true
-        },
-        approverName: {
-            type: String,
-            required: true
-        },
-        approverRole: {
-            type: String,
-            required: true
-        },
-        approvalStatus: {
-            type: String,
-            enum: ['pending', 'approved', 'rejected'],
-            default: 'pending'
-        },
-        approvalDate: {
-            type: Date
-        },
-        comments: {
-            type: String,
-            trim: true
-        }
-    }],
-
-    // Document attachments
-    attachments: [{
-        name: {
-            type: String,
-            required: true
-        },
-        fileType: {
-            type: String,
-            required: true
-        },
-        filePath: {
-            type: String,
-            required: true
-        },
-        uploadDate: {
-            type: Date,
-            default: Date.now
-        }
-    }]
-}, {
-    timestamps: true
-});
-
-// Virtual for tracking approval progress
-purchaseOrderSchema.virtual('approvalProgress').get(function () {
-    if (!this.approvers || this.approvers.length === 0) return 0;
-
-    const approvedCount = this.approvers.filter(
-        approver => approver.approvalStatus === 'approved'
-    ).length;
-
-    return (approvedCount / this.approvers.length) * 100;
-});
-
-// Pre-save middleware to calculate totals
-purchaseOrderSchema.pre('save', function (next) {
-    // Calculate subtotal
-    this.subtotal = this.items.reduce((sum, item) => sum + (item.unitPrice * item.quantity), 0);
-
-    // Calculate tax total
-    this.taxTotal = this.items.reduce((sum, item) => {
-        const itemTax = (item.unitPrice * item.quantity) * (item.taxRate / 100);
-        return sum + itemTax;
-    }, 0);
-
-    // Calculate grand total
-    this.grandTotal = this.subtotal + this.taxTotal;
-
-    next();
-});
-
-const PurchaseOrder = mongoose.model('PurchaseOrder', purchaseOrderSchema);
-
+const mongoose = require('mongoose');
+
+const purchaseOrderSchema = new mongoose.Schema({
+    // Main Purchase Order Information
+    facilityId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true,
+        index: true
+    },
+    poNumber: {
+        type: String,
+        required: true,
+        unique: true,
+        trim: true,
+        index: true
+    },
+    prNumber: {
+        type: String,
+        trim: true,
+        index: true,
+        ref: 'PurchaseRequest'
+    },
+    supplier: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Supplier',
+        required: true
+    },
+    department: {
+        type: String,
+        required: true,
+        trim: true
+    },
+    currency: {
+        type: String,
+        required: true,
+        trim: true,
+        default: 'KES'
+    },
+    date: {
+        type: Date,
+        required: true,
+        default: Date.now
+    },
+    internalNotes: {
+        type: String,
+        trim: true
+    },
+    supplierNotes: {
+        type: String,
+        trim: true
+    },
+    budget: {
+        type: String,
+        trim: true
+    },
+    status: {
+        type: String,
+        enum: ['pending approval', 'approved', 'rejected', 'sent', 'received', 'completed', 'canceled'],
+        default: 'pending approval',
+        index: true
+    },
+
+    // Items Details
+    items: [{
+        itemDescription: {
+            type: String,
+            required: true,
+            trim: true
+        },
+        quantity: {
+            type: Number,
+            required: true
+        },
+        unitOfMeasure: {
+            type: String,
+            required: true,
+            trim: true
+        },
+        unitPrice: {
+            type: Number,
+            required: true
+        },
+        taxRate: {
+            type: Number,
+            default: 0
+        },
+        totalPrice: {
+            type: Number,
+            required: true
+        }
+    }],
+
+    // Calculated Totals
+    subtotal: {
+        type: Number,
+        required: true
+    },
+    taxTotal: {
+        type: Number,
+        required: true,
+        default: 0
+    },
+    grandTotal: {
+        type: Number,
+        required: true
+    },
+
+    // Approvers Section
+    approvers: [{
+        approverId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User',
+            required: true
+        },
+        approverName: {
+            type: String,
+            required: true
+        },
+        approverRole: {
+            type: String,
+            required: true
+        },
+        approvalStatus: {
+            type: String,
+            enum: ['pending', 'approved', 'rejected'],
+            default: 'pending'
+        },
+        approvalDate: {
+            type: Date
+        },
+        comments: {
+            type: String,
+            trim: true
+        }
+    }],
+
+    // Document attachments
+    attachments: [{
+        name: {
+            type: String,
+            required: true
+        },
+        fileType: {
+            type: String,
+            required: true
+        },
+        filePath: {
+            type: String,
+            required: true
+        },
+        uploadDate: {
+            type: Date,
+            default: Date.now
+        }
+    }]
+}, {
+    timestamps: true
+});
+
+// Virtual for tracking approval progress
+purchaseOrderSchema.virtual('approvalProgress').get(function () {
+    if (!this.approvers || this.approvers.length === 0) return 0;
+
+    const approvedCount = this.approvers.filter(
+        approver => approver.approvalStatus === 'approved'
+    ).length;
+
+    return (approvedCount / this.approvers.length) * 100;
+});
+
+// Pre-save middleware to calculate totals
+purchaseOrderSchema.pre('save', function (next) {
+    // Calculate subtotal
+    this.subtotal = this.items.reduce((sum, item) => sum + (item.unitPrice * item.quantity), 0);
+
+    // Calculate tax total
+    this.taxTotal = this.items.reduce((sum, item) => {
+        const itemTax = (item.unitPrice * item.quantity) * (item.taxRate / 100);
+        return sum + itemTax;
+    }, 0);
+
+    // Calculate grand total
+    this.grandTotal = this.subtotal + this.taxTotal;
+
+    next();
+});
+
+const PurchaseOrder = mongoose.model('PurchaseOrder', purchaseOrderSchema);
+
 module.exports = PurchaseOrder;

package/src/models/purchase_request.js

@@ -1,66 +1,66 @@
-const mongoose = require('mongoose');
-
-const purchaseRequestSchema = new mongoose.Schema({
-    facilityId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Facility',
-        required: true,
-        index: true
-    },
-    items: [{
-        itemDescription: {
-            type: String,
-            required: true,
-            trim: true
-        },
-        quantity: {
-            type: Number,
-            required: true
-        },
-        unitOfMeasure: {
-            type: String,
-            required: true,
-            trim: true
-        },
-        remarksSpecification: {
-            type: String,
-            trim: true
-        }
-    }],
-    from: {
-        type: String,
-        trim: true
-    },
-    date: {
-        type: Date,
-        required: true,
-        default: Date.now
-    },
-    irfNumber: {
-        type: String,
-        required: true,
-        trim: true,
-        index: true
-    },
-    department: {
-        type: String,
-        trim: true
-    },
-    status: {
-        type: String,
-        default: 'pending',
-        index: true
-    },
-    poStatus: {
-        type: String,
-        enum: ['PO Raised', 'pending'],
-        default: 'pending',
-        index: true
-    }
-}, {
-    timestamps: true
-});
-
-const PurchaseRequest = mongoose.model('PurchaseRequest', purchaseRequestSchema);
-
+const mongoose = require('mongoose');
+
+const purchaseRequestSchema = new mongoose.Schema({
+    facilityId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true,
+        index: true
+    },
+    items: [{
+        itemDescription: {
+            type: String,
+            required: true,
+            trim: true
+        },
+        quantity: {
+            type: Number,
+            required: true
+        },
+        unitOfMeasure: {
+            type: String,
+            required: true,
+            trim: true
+        },
+        remarksSpecification: {
+            type: String,
+            trim: true
+        }
+    }],
+    from: {
+        type: String,
+        trim: true
+    },
+    date: {
+        type: Date,
+        required: true,
+        default: Date.now
+    },
+    irfNumber: {
+        type: String,
+        required: true,
+        trim: true,
+        index: true
+    },
+    department: {
+        type: String,
+        trim: true
+    },
+    status: {
+        type: String,
+        default: 'pending',
+        index: true
+    },
+    poStatus: {
+        type: String,
+        enum: ['PO Raised', 'pending'],
+        default: 'pending',
+        index: true
+    }
+}, {
+    timestamps: true
+});
+
+const PurchaseRequest = mongoose.model('PurchaseRequest', purchaseRequestSchema);
+
 module.exports = PurchaseRequest;