@classytic/payroll 1.0.0 → 2.7.5

package/dist/prorating.calculator-C7sdFiG2.d.ts

@@ -0,0 +1,135 @@
+/**
+ * @classytic/payroll - Pro-Rating Calculator
+ *
+ * Pure functions for salary pro-rating calculations.
+ * No database dependencies - can be used client-side!
+ *
+ * Handles:
+ * - Mid-period hires
+ * - Mid-period terminations
+ * - Working days (not calendar days)
+ * - Holidays exclusion
+ *
+ * @packageDocumentation
+ */
+/**
+ * Input for pro-rating calculation
+ */
+interface ProRatingInput {
+    /**
+     * Employee hire date
+     */
+    hireDate: Date;
+    /**
+     * Employee termination date (null if still employed)
+     */
+    terminationDate: Date | null;
+    /**
+     * Start of the salary period
+     */
+    periodStart: Date;
+    /**
+     * End of the salary period
+     */
+    periodEnd: Date;
+    /**
+     * Working days of the week (1=Monday, 7=Sunday)
+     * @default [1, 2, 3, 4, 5] (Monday-Friday)
+     */
+    workingDays: number[];
+    /**
+     * Public holidays to exclude from working days
+     * @default []
+     */
+    holidays?: Date[];
+}
+/**
+ * Result of pro-rating calculation
+ */
+interface ProRatingResult {
+    /**
+     * Whether the salary needs to be pro-rated
+     */
+    isProRated: boolean;
+    /**
+     * Pro-rating ratio (0-1)
+     * 1 = full salary, 0.5 = half salary, etc.
+     */
+    ratio: number;
+    /**
+     * Total working days in the period
+     */
+    periodWorkingDays: number;
+    /**
+     * Working days the employee was actually employed
+     */
+    effectiveWorkingDays: number;
+    /**
+     * Effective start date (max of hire date and period start)
+     */
+    effectiveStart: Date;
+    /**
+     * Effective end date (min of termination date and period end)
+     */
+    effectiveEnd: Date;
+}
+/**
+ * Calculate pro-rating for mid-period hires/terminations
+ *
+ * This function uses WORKING DAYS (not calendar days) for accurate pro-rating.
+ *
+ * @example
+ * ```typescript
+ * // Employee hired on March 15th, process March salary
+ * const result = calculateProRating({
+ *   hireDate: new Date('2024-03-15'),
+ *   terminationDate: null,
+ *   periodStart: new Date('2024-03-01'),
+ *   periodEnd: new Date('2024-03-31'),
+ *   workingDays: [1, 2, 3, 4, 5], // Mon-Fri
+ * });
+ *
+ * console.log(result);
+ * // {
+ * //   isProRated: true,
+ * //   ratio: 0.64,  // Worked 14 out of 22 working days
+ * //   periodWorkingDays: 22,
+ * //   effectiveWorkingDays: 14
+ * // }
+ * ```
+ *
+ * @param input - Pro-rating calculation parameters
+ * @returns Pro-rating result with ratio and working days breakdown
+ *
+ * @pure This function has no side effects and doesn't access external state
+ */
+declare function calculateProRating(input: ProRatingInput): ProRatingResult;
+/**
+ * Calculate pro-rated amount from base amount and ratio
+ *
+ * @example
+ * ```typescript
+ * const proRatedSalary = applyProRating(100000, 0.64); // 64000
+ * ```
+ *
+ * @param baseAmount - Original amount
+ * @param ratio - Pro-rating ratio (0-1)
+ * @returns Pro-rated amount (rounded)
+ *
+ * @pure No side effects
+ */
+declare function applyProRating(baseAmount: number, ratio: number): number;
+/**
+ * Check if pro-rating should be applied for a given hire/termination scenario
+ *
+ * @param hireDate - Employee hire date
+ * @param terminationDate - Employee termination date (null if active)
+ * @param periodStart - Salary period start
+ * @param periodEnd - Salary period end
+ * @returns True if pro-rating is needed
+ *
+ * @pure No side effects
+ */
+declare function shouldProRate(hireDate: Date, terminationDate: Date | null, periodStart: Date, periodEnd: Date): boolean;
+
+export { type ProRatingInput as P, applyProRating as a, type ProRatingResult as b, calculateProRating as c, shouldProRate as s };

package/dist/schemas/index.d.ts

@@ -0,0 +1,4 @@
+import 'bson';
+import 'mongoose';
+export { P as PayrollSchemaOptions, a as allowanceSchema, b as applyEmployeeIndexes, c as applyLeaveRequestIndexes, d as applyPayrollRecordIndexes, e as applyTaxWithholdingIndexes, f as bankDetailsSchema, g as compensationSchema, h as createEmployeeSchema, i as createEmploymentFields, j as createPayrollRecordFields, k as createPayrollRecordSchema, l as deductionSchema, _ as default, z as employeeIndexes, m as employmentHistorySchema, n as getLeaveRequestFields, o as getLeaveRequestModel, p as getTaxWithholdingFields, q as getTaxWithholdingModel, r as leaveBalanceFields, s as leaveBalanceSchema, t as leaveRequestIndexes, u as leaveRequestSchema, A as leaveRequestTTLIndex, B as payrollBreakdownSchema, C as payrollRecordIndexes, v as payrollStatsSchema, D as periodSchema, w as taxWithholdingIndexes, x as taxWithholdingSchema, y as workScheduleSchema } from '../index-DjB72l6e.js';
+import '../types-BVDjiVGS.js';