@classytic/payroll 1.0.1 → 1.0.2

package/src/init.js

@@ -3,6 +3,27 @@ import logger, { setLogger } from './utils/logger.js';
 
 let initialized = false;
 
+/**
+ * Initialize HRM/Payroll framework
+ *
+ * @param {Object} options - Initialization options
+ * @param {Model} options.EmployeeModel - Employee model (required)
+ * @param {Model} options.PayrollRecordModel - Payroll record model (required)
+ * @param {Model} options.TransactionModel - Transaction model (required)
+ * @param {Model} options.AttendanceModel - Optional attendance model for integration
+ * @param {Object} options.logger - Optional custom logger
+ *
+ * @example Multi-Tenant (default)
+ * initializeHRM({
+ *   EmployeeModel,
+ *   PayrollRecordModel,
+ *   TransactionModel
+ * });
+ *
+ * @example Single-Tenant
+ * // For single-tenant apps, add organizationId with default value in your Employee schema:
+ * // organizationId: { type: ObjectId, required: true, default: () => FIXED_ORG_ID }
+ */
 export function initializeHRM({ EmployeeModel, PayrollRecordModel, TransactionModel, AttendanceModel = null, logger: customLogger }) {
   // Allow users to inject their own logger
   if (customLogger) {

package/src/plugins/employee.plugin.js

@@ -136,11 +136,18 @@ export function employeePlugin(schema, options = {}) {
     });
   };
 
-  schema.pre('save', function(next) {
+  /**
+   * Pre-save hook to automatically update salary calculations
+   * when compensation is modified.
+   *
+   * Mongoose v9 compatible - uses async function without next callback
+   * - Use throw instead of next(err) for errors
+   * - Use return instead of return next()
+   */
+  schema.pre('save', async function() {
     if (this.isModified('compensation')) {
       this.updateSalaryCalculations();
     }
-    next();
   });
 
   schema.index({ organizationId: 1, employeeId: 1 }, { unique: true });