@classytic/payroll 2.0.0 → 2.3.0

package/dist/schemas/index.js

@@ -39,6 +39,16 @@ var PAYMENT_FREQUENCY = {
   DAILY: "daily"
 };
 var PAYMENT_FREQUENCY_VALUES = Object.values(PAYMENT_FREQUENCY);
+var PAYMENT_METHOD = {
+  BANK: "bank",
+  CASH: "cash",
+  MOBILE: "mobile",
+  BKASH: "bkash",
+  NAGAD: "nagad",
+  ROCKET: "rocket",
+  CHECK: "check"
+};
+var PAYMENT_METHOD_VALUES = Object.values(PAYMENT_METHOD);
 var ALLOWANCE_TYPE = {
   HOUSING: "housing",
   TRANSPORT: "transport",
@@ -77,6 +87,40 @@ var TERMINATION_REASON = {
   OTHER: "other"
 };
 var TERMINATION_REASON_VALUES = Object.values(TERMINATION_REASON);
+var LEAVE_TYPE = {
+  ANNUAL: "annual",
+  SICK: "sick",
+  UNPAID: "unpaid",
+  MATERNITY: "maternity",
+  PATERNITY: "paternity",
+  BEREAVEMENT: "bereavement",
+  COMPENSATORY: "compensatory",
+  OTHER: "other"
+};
+var LEAVE_TYPE_VALUES = Object.values(LEAVE_TYPE);
+var LEAVE_REQUEST_STATUS = {
+  PENDING: "pending",
+  APPROVED: "approved",
+  REJECTED: "rejected",
+  CANCELLED: "cancelled"
+};
+var LEAVE_REQUEST_STATUS_VALUES = Object.values(LEAVE_REQUEST_STATUS);
+var TAX_TYPE = {
+  INCOME_TAX: "income_tax",
+  SOCIAL_SECURITY: "social_security",
+  HEALTH_INSURANCE: "health_insurance",
+  PENSION: "pension",
+  EMPLOYMENT_INSURANCE: "employment_insurance",
+  LOCAL_TAX: "local_tax",
+  OTHER: "other"
+};
+var TAX_TYPE_VALUES = Object.values(TAX_TYPE);
+var TAX_STATUS = {
+  PENDING: "pending",
+  SUBMITTED: "submitted",
+  PAID: "paid"
+};
+var TAX_STATUS_VALUES = Object.values(TAX_STATUS);
 
 // src/config.ts
 var HRM_CONFIG = {
@@ -115,6 +159,267 @@ var ORG_ROLES = {
   }
 };
 Object.values(ORG_ROLES).map((role) => role.key);
+var periodSchema = new Schema(
+  {
+    month: { type: Number, required: true, min: 1, max: 12 },
+    year: { type: Number, required: true, min: 2020 },
+    startDate: { type: Date, required: true },
+    endDate: { type: Date, required: true },
+    payDate: { type: Date, required: true }
+  },
+  { _id: false }
+);
+var leaveBalanceSchema = new Schema(
+  {
+    type: {
+      type: String,
+      enum: LEAVE_TYPE_VALUES,
+      required: true
+    },
+    allocated: { type: Number, default: 0, min: 0 },
+    used: { type: Number, default: 0, min: 0 },
+    pending: { type: Number, default: 0, min: 0 },
+    carriedOver: { type: Number, default: 0, min: 0 },
+    expiresAt: { type: Date },
+    year: { type: Number, required: true }
+  },
+  { _id: false }
+);
+var leaveBalanceFields = {
+  leaveBalances: [leaveBalanceSchema]
+};
+var leaveRequestFields = {
+  organizationId: {
+    type: Schema.Types.ObjectId,
+    ref: "Organization",
+    required: false
+    // Optional for single-tenant mode
+  },
+  employeeId: {
+    type: Schema.Types.ObjectId,
+    required: true
+  },
+  userId: {
+    type: Schema.Types.ObjectId,
+    ref: "User",
+    required: true
+  },
+  type: {
+    type: String,
+    enum: LEAVE_TYPE_VALUES,
+    required: true
+  },
+  startDate: { type: Date, required: true },
+  endDate: { type: Date, required: true },
+  days: { type: Number, required: true, min: 0.5 },
+  halfDay: { type: Boolean, default: false },
+  reason: { type: String },
+  status: {
+    type: String,
+    enum: LEAVE_REQUEST_STATUS_VALUES,
+    default: "pending"
+  },
+  reviewedBy: { type: Schema.Types.ObjectId, ref: "User" },
+  reviewedAt: { type: Date },
+  reviewNotes: { type: String },
+  attachments: [{ type: String }],
+  metadata: { type: Schema.Types.Mixed, default: {} }
+};
+var leaveRequestIndexes = [
+  { fields: { organizationId: 1, employeeId: 1, startDate: -1 } },
+  { fields: { organizationId: 1, status: 1, createdAt: -1 } },
+  { fields: { employeeId: 1, status: 1 } },
+  // Most relevant for single-tenant
+  { fields: { organizationId: 1, type: 1, status: 1 } }
+];
+var leaveRequestTTLIndex = {
+  fields: { createdAt: 1 },
+  options: {
+    expireAfterSeconds: 63072e3,
+    // 2 years default
+    partialFilterExpression: {
+      status: { $in: ["approved", "rejected", "cancelled"] }
+    }
+  }
+};
+function applyLeaveRequestIndexes(schema, options = {}) {
+  if (!options.createIndexes) return;
+  for (const { fields } of leaveRequestIndexes) {
+    schema.index(fields);
+  }
+  if (options.enableTTL) {
+    schema.index(leaveRequestTTLIndex.fields, {
+      ...leaveRequestTTLIndex.options,
+      expireAfterSeconds: options.ttlSeconds ?? leaveRequestTTLIndex.options.expireAfterSeconds
+    });
+  }
+}
+function createLeaveRequestSchema(additionalFields = {}, options = {}) {
+  const fields = { ...leaveRequestFields };
+  if (options.requireOrganizationId) {
+    fields.organizationId = {
+      ...fields.organizationId,
+      required: true
+    };
+  }
+  const schema = new Schema(
+    {
+      ...fields,
+      ...additionalFields
+    },
+    { timestamps: true }
+  );
+  applyLeaveRequestIndexes(schema, options);
+  schema.virtual("isPending").get(function() {
+    return this.status === "pending";
+  });
+  schema.virtual("isApproved").get(function() {
+    return this.status === "approved";
+  });
+  schema.virtual("isRejected").get(function() {
+    return this.status === "rejected";
+  });
+  schema.virtual("isCancelled").get(function() {
+    return this.status === "cancelled";
+  });
+  schema.virtual("durationInDays").get(function() {
+    return this.days;
+  });
+  return schema;
+}
+var taxWithholdingFields = {
+  organizationId: {
+    type: Schema.Types.ObjectId,
+    required: true,
+    ref: "Organization",
+    index: true
+  },
+  employeeId: {
+    type: Schema.Types.ObjectId,
+    required: true,
+    ref: "Employee",
+    index: true
+  },
+  userId: {
+    type: Schema.Types.ObjectId,
+    required: false,
+    ref: "User"
+  },
+  payrollRecordId: {
+    type: Schema.Types.ObjectId,
+    required: true,
+    ref: "PayrollRecord",
+    index: true
+  },
+  transactionId: {
+    type: Schema.Types.ObjectId,
+    required: true,
+    ref: "Transaction",
+    index: true
+  },
+  period: {
+    type: periodSchema,
+    required: true
+  },
+  amount: {
+    type: Number,
+    required: true,
+    min: 0
+  },
+  currency: {
+    type: String,
+    default: "BDT"
+  },
+  taxType: {
+    type: String,
+    enum: TAX_TYPE_VALUES,
+    required: true
+  },
+  taxRate: {
+    type: Number,
+    required: true,
+    min: 0,
+    max: 1
+  },
+  taxableAmount: {
+    type: Number,
+    required: true,
+    min: 0
+  },
+  status: {
+    type: String,
+    enum: TAX_STATUS_VALUES,
+    default: "pending"
+  },
+  submittedAt: Date,
+  paidAt: Date,
+  governmentTransactionId: {
+    type: Schema.Types.ObjectId,
+    ref: "Transaction"
+  },
+  referenceNumber: String,
+  notes: String,
+  metadata: {
+    type: Schema.Types.Mixed,
+    default: {}
+  }
+};
+var taxWithholdingIndexes = [
+  {
+    fields: { organizationId: 1, status: 1, "period.year": 1, "period.month": 1 }
+  },
+  {
+    fields: { employeeId: 1, "period.year": -1, "period.month": -1 }
+  },
+  {
+    fields: { payrollRecordId: 1 }
+  },
+  {
+    fields: { transactionId: 1 }
+  },
+  {
+    fields: { organizationId: 1, taxType: 1, status: 1 }
+  },
+  {
+    fields: { governmentTransactionId: 1 },
+    options: { sparse: true }
+  }
+];
+function applyTaxWithholdingIndexes(schema) {
+  for (const { fields, options } of taxWithholdingIndexes) {
+    schema.index(fields, options);
+  }
+}
+function createTaxWithholdingSchema(additionalFields = {}) {
+  const schema = new Schema(
+    {
+      ...taxWithholdingFields,
+      ...additionalFields
+    },
+    { timestamps: true }
+  );
+  applyTaxWithholdingIndexes(schema);
+  schema.virtual("isPending").get(function() {
+    return this.status === "pending";
+  });
+  schema.virtual("isPaid").get(function() {
+    return this.status === "paid";
+  });
+  schema.virtual("isSubmitted").get(function() {
+    return this.status === "submitted";
+  });
+  schema.methods.markAsSubmitted = function(submittedAt = /* @__PURE__ */ new Date()) {
+    this.status = "submitted";
+    this.submittedAt = submittedAt;
+  };
+  schema.methods.markAsPaid = function(transactionId, referenceNumber, paidAt = /* @__PURE__ */ new Date()) {
+    this.status = "paid";
+    this.governmentTransactionId = transactionId;
+    this.referenceNumber = referenceNumber;
+    this.paidAt = paidAt;
+  };
+  return schema;
+}
 
 // src/schemas/index.ts
 var allowanceSchema = new Schema(
@@ -219,7 +524,15 @@ var employmentFields = {
   userId: {
     type: Schema.Types.ObjectId,
     ref: "User",
-    required: true
+    required: false
+    // Allow guest employees (no user account)
+  },
+  email: {
+    type: String,
+    trim: true,
+    lowercase: true,
+    required: false
+    // For guest employees without user account
   },
   organizationId: {
     type: Schema.Types.ObjectId,
@@ -253,20 +566,22 @@ var payrollBreakdownSchema = new Schema(
     baseAmount: { type: Number, required: true, min: 0 },
     allowances: [
       {
-        type: { type: String },
-        amount: { type: Number, min: 0 },
+        type: { type: String, required: true },
+        amount: { type: Number, required: true, min: 0 },
         taxable: { type: Boolean, default: true }
       }
     ],
     deductions: [
       {
-        type: { type: String },
-        amount: { type: Number, min: 0 },
+        type: { type: String, required: true },
+        amount: { type: Number, required: true, min: 0 },
         description: { type: String }
       }
     ],
     grossSalary: { type: Number, required: true, min: 0 },
     netSalary: { type: Number, required: true, min: 0 },
+    taxableAmount: { type: Number, default: 0, min: 0 },
+    taxAmount: { type: Number, default: 0, min: 0 },
     workingDays: { type: Number, min: 0 },
     actualDays: { type: Number, min: 0 },
     proRatedAmount: { type: Number, default: 0, min: 0 },
@@ -276,32 +591,21 @@ var payrollBreakdownSchema = new Schema(
   },
   { _id: false }
 );
-var periodSchema = new Schema(
-  {
-    month: { type: Number, required: true, min: 1, max: 12 },
-    year: { type: Number, required: true, min: 2020 },
-    startDate: { type: Date, required: true },
-    endDate: { type: Date, required: true },
-    payDate: { type: Date, required: true }
-  },
-  { _id: false }
-);
 var payrollRecordFields = {
   organizationId: {
     type: Schema.Types.ObjectId,
     ref: "Organization",
-    required: true,
-    index: true
+    required: true
   },
   employeeId: {
     type: Schema.Types.ObjectId,
-    required: true,
-    index: true
+    required: true
   },
   userId: {
     type: Schema.Types.ObjectId,
     ref: "User",
-    index: true
+    required: false
+    // Optional for guest employees
   },
   period: { type: periodSchema, required: true },
   breakdown: { type: payrollBreakdownSchema, required: true },
@@ -309,20 +613,56 @@ var payrollRecordFields = {
   status: {
     type: String,
     enum: PAYROLL_STATUS_VALUES,
-    default: "pending",
-    index: true
+    default: "pending"
   },
+  processedAt: { type: Date },
   paidAt: { type: Date },
-  paymentMethod: { type: String },
+  paymentMethod: {
+    type: String,
+    enum: PAYMENT_METHOD_VALUES
+  },
   processedBy: { type: Schema.Types.ObjectId, ref: "User" },
   notes: { type: String },
   payslipUrl: { type: String },
+  metadata: {
+    type: Schema.Types.Mixed,
+    default: {}
+  },
   exported: { type: Boolean, default: false },
-  exportedAt: { type: Date }
+  exportedAt: { type: Date },
+  corrections: [
+    {
+      previousAmount: Number,
+      newAmount: Number,
+      reason: String,
+      correctedBy: { type: Schema.Types.ObjectId, ref: "User" },
+      correctedAt: { type: Date, default: Date.now }
+    }
+  ]
 };
 var employeeIndexes = [
   { fields: { organizationId: 1, employeeId: 1 }, options: { unique: true } },
-  { fields: { userId: 1, organizationId: 1 }, options: { unique: true } },
+  // Partial unique index: Only includes docs with userId field (excludes guest employees)
+  // Uses partialFilterExpression instead of sparse for compound indexes
+  {
+    fields: { userId: 1, organizationId: 1 },
+    options: {
+      unique: true,
+      partialFilterExpression: { userId: { $exists: true } }
+    }
+  },
+  // Partial unique index: Only includes non-terminated docs with email
+  // This allows email reuse when employees are terminated and rehired
+  {
+    fields: { email: 1, organizationId: 1 },
+    options: {
+      unique: true,
+      partialFilterExpression: {
+        email: { $exists: true },
+        status: { $in: ["active", "on_leave", "suspended"] }
+      }
+    }
+  },
   { fields: { organizationId: 1, status: 1 } },
   { fields: { organizationId: 1, department: 1 } },
   { fields: { organizationId: 1, "compensation.netSalary": -1 } }
@@ -339,8 +679,8 @@ var payrollRecordIndexes = [
   {
     fields: { createdAt: 1 },
     options: {
-      expireAfterSeconds: HRM_CONFIG.dataRetention.payrollRecordsTTL,
-      partialFilterExpression: { exported: true }
+      expireAfterSeconds: HRM_CONFIG.dataRetention.payrollRecordsTTL
+      // TTL applies to ALL records (user handles backups/exports at app level)
     }
   }
 ];
@@ -435,6 +775,6 @@ var schemas_default = {
   createPayrollRecordSchema
 };
 
-export { allowanceSchema, applyEmployeeIndexes, applyPayrollRecordIndexes, bankDetailsSchema, compensationSchema, createEmployeeSchema, createPayrollRecordSchema, deductionSchema, schemas_default as default, employeeIndexes, employmentFields, employmentHistorySchema, payrollBreakdownSchema, payrollRecordFields, payrollRecordIndexes, payrollStatsSchema, periodSchema, workScheduleSchema };
+export { allowanceSchema, applyEmployeeIndexes, applyLeaveRequestIndexes, applyPayrollRecordIndexes, applyTaxWithholdingIndexes, bankDetailsSchema, compensationSchema, createEmployeeSchema, createLeaveRequestSchema, createPayrollRecordSchema, createTaxWithholdingSchema, deductionSchema, schemas_default as default, employeeIndexes, employmentFields, employmentHistorySchema, leaveBalanceFields, leaveBalanceSchema, leaveRequestFields, leaveRequestIndexes, leaveRequestTTLIndex, payrollBreakdownSchema, payrollRecordFields, payrollRecordIndexes, payrollStatsSchema, periodSchema, taxWithholdingFields, taxWithholdingIndexes, workScheduleSchema };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map