@classytic/payroll 1.0.2 → 2.0.0

package/dist/types/factories/payroll.factory.d.ts

@@ -1,319 +0,0 @@
-/**
- * @typedef {Object} AllowanceInput
- * @property {string} type - Type of allowance
- * @property {string} [name] - Display name for the allowance
- * @property {number} value - Allowance value (amount or percentage)
- * @property {boolean} [isPercentage=false] - Whether value is a percentage
- */
-/**
- * @typedef {Object} DeductionInput
- * @property {string} type - Type of deduction
- * @property {string} [name] - Display name for the deduction
- * @property {number} value - Deduction value (amount or percentage)
- * @property {boolean} [isPercentage=false] - Whether value is a percentage
- */
-/**
- * @typedef {Object} PeriodInput
- * @property {number} [month] - Month (1-12)
- * @property {number} [year] - Year
- */
-/**
- * @typedef {Object} PayrollMetadata
- * @property {string} [currency='BDT'] - Currency code
- * @property {string} [paymentMethod] - Payment method
- * @property {string} [notes] - Additional notes
- */
-/**
- * @typedef {Object} PayrollRecord
- * @property {string} employeeId - Employee identifier
- * @property {string} organizationId - Organization identifier
- * @property {Object} period - Pay period information
- * @property {Object} breakdown - Salary breakdown
- * @property {number} breakdown.baseAmount - Base salary amount
- * @property {Array} breakdown.allowances - Calculated allowances
- * @property {Array} breakdown.deductions - Calculated deductions
- * @property {number} breakdown.grossSalary - Gross salary
- * @property {number} breakdown.netSalary - Net salary after deductions
- * @property {string} status - Payroll status ('pending', 'processed', 'paid')
- * @property {Date|null} processedAt - When payroll was processed
- * @property {Date|null} paidAt - When payment was made
- * @property {PayrollMetadata} metadata - Additional metadata
- */
-export class PayrollFactory {
-    /**
-     * Create a new payroll record
-     *
-     * @param {Object} params - Payroll parameters
-     * @param {string} params.employeeId - Employee ID
-     * @param {string} params.organizationId - Organization ID
-     * @param {number} params.baseAmount - Base salary amount
-     * @param {AllowanceInput[]} [params.allowances=[]] - Allowances array
-     * @param {DeductionInput[]} [params.deductions=[]] - Deductions array
-     * @param {PeriodInput} [params.period={}] - Pay period
-     * @param {PayrollMetadata} [params.metadata={}] - Additional metadata
-     * @returns {PayrollRecord} Payroll record object
-     */
-    static create({ employeeId, organizationId, baseAmount, allowances, deductions, period, metadata, }: {
-        employeeId: string;
-        organizationId: string;
-        baseAmount: number;
-        allowances?: AllowanceInput[];
-        deductions?: DeductionInput[];
-        period?: PeriodInput;
-        metadata?: PayrollMetadata;
-    }): PayrollRecord;
-    /**
-     * Create a pay period object
-     *
-     * @param {PeriodInput} [params={}] - Period parameters
-     * @param {number} [params.month] - Month (defaults to current month)
-     * @param {number} [params.year] - Year (defaults to current year)
-     * @returns {Object} Pay period object with startDate, endDate, etc.
-     */
-    static createPeriod({ month, year }?: PeriodInput): any;
-    /**
-     * Calculate allowances from base amount and allowance inputs
-     *
-     * @param {number} baseAmount - Base salary amount
-     * @param {AllowanceInput[]} allowances - Array of allowances
-     * @returns {Array} Calculated allowances with amounts
-     */
-    static calculateAllowances(baseAmount: number, allowances: AllowanceInput[]): any[];
-    /**
-     * Calculate deductions from base amount and deduction inputs
-     *
-     * @param {number} baseAmount - Base salary amount
-     * @param {DeductionInput[]} deductions - Array of deductions
-     * @returns {Array} Calculated deductions with amounts
-     */
-    static calculateDeductions(baseAmount: number, deductions: DeductionInput[]): any[];
-    /**
-     * Create a bonus object
-     *
-     * @param {Object} params - Bonus parameters
-     * @param {string} params.type - Bonus type
-     * @param {number} params.amount - Bonus amount
-     * @param {string} params.reason - Reason for bonus
-     * @param {string} params.approvedBy - User who approved the bonus
-     * @returns {Object} Bonus object
-     */
-    static createBonus({ type, amount, reason, approvedBy }: {
-        type: string;
-        amount: number;
-        reason: string;
-        approvedBy: string;
-    }): any;
-    /**
-     * Create a deduction object
-     *
-     * @param {Object} params - Deduction parameters
-     * @param {string} params.type - Deduction type
-     * @param {number} params.amount - Deduction amount
-     * @param {string} params.reason - Reason for deduction
-     * @param {string} params.appliedBy - User who applied the deduction
-     * @returns {Object} Deduction object
-     */
-    static createDeduction({ type, amount, reason, appliedBy }: {
-        type: string;
-        amount: number;
-        reason: string;
-        appliedBy: string;
-    }): any;
-    /**
-     * Mark a payroll record as paid (immutable - returns new object)
-     *
-     * @param {PayrollRecord} payroll - Payroll record to mark as paid
-     * @param {Object} [params={}] - Payment details
-     * @param {Date} [params.paidAt] - Payment date (defaults to now)
-     * @param {string} [params.transactionId] - Transaction ID
-     * @param {string} [params.paymentMethod] - Payment method
-     * @returns {PayrollRecord} New payroll record marked as paid
-     */
-    static markAsPaid(payroll: PayrollRecord, { paidAt, transactionId, paymentMethod }?: {
-        paidAt?: Date;
-        transactionId?: string;
-        paymentMethod?: string;
-    }): PayrollRecord;
-    /**
-     * Mark a payroll record as processed (immutable - returns new object)
-     *
-     * @param {PayrollRecord} payroll - Payroll record to mark as processed
-     * @param {Object} [params={}] - Processing details
-     * @param {Date} [params.processedAt] - Processing date (defaults to now)
-     * @returns {PayrollRecord} New payroll record marked as processed
-     */
-    static markAsProcessed(payroll: PayrollRecord, { processedAt }?: {
-        processedAt?: Date;
-    }): PayrollRecord;
-}
-/**
- * PayrollBuilder - Fluent builder pattern for creating payroll records
- *
- * @example
- * const payroll = createPayroll()
- *   .forEmployee('emp-123')
- *   .inOrganization('org-456')
- *   .withBaseAmount(50000)
- *   .addAllowance('housing', 10000)
- *   .addDeduction('tax', 15, true)
- *   .build();
- */
-export class PayrollBuilder {
-    data: {
-        allowances: any[];
-        deductions: any[];
-        period: {};
-        metadata: {};
-    };
-    forEmployee(employeeId: any): this;
-    inOrganization(organizationId: any): this;
-    withBaseAmount(amount: any): this;
-    forPeriod(month: any, year: any): this;
-    addAllowance(type: any, value: any, isPercentage?: boolean, name?: any): this;
-    addDeduction(type: any, value: any, isPercentage?: boolean, name?: any): this;
-    addBonus(amount: any, reason: any, approvedBy: any): this;
-    withCurrency(currency: any): this;
-    withPaymentMethod(method: any): this;
-    withNotes(notes: any): this;
-    build(): PayrollRecord;
-}
-export function createPayroll(): PayrollBuilder;
-/**
- * BatchPayrollFactory - Process payroll for multiple employees at once
- *
- * @example
- * const payrolls = BatchPayrollFactory.createBatch(employees, {
- *   month: 1,
- *   year: 2025,
- *   organizationId: 'org-123'
- * });
- */
-export class BatchPayrollFactory {
-    /**
-     * Create payroll records for multiple employees
-     *
-     * @param {Array} employees - Array of employee objects
-     * @param {Object} params - Batch parameters
-     * @param {number} params.month - Month for payroll
-     * @param {number} params.year - Year for payroll
-     * @param {string} params.organizationId - Organization ID
-     * @returns {PayrollRecord[]} Array of payroll records
-     */
-    static createBatch(employees: any[], { month, year, organizationId }: {
-        month: number;
-        year: number;
-        organizationId: string;
-    }): PayrollRecord[];
-    /**
-     * Calculate total payroll amounts across multiple records
-     *
-     * @param {PayrollRecord[]} payrolls - Array of payroll records
-     * @returns {Object} Totals summary
-     * @returns {number} return.count - Total number of payrolls
-     * @returns {number} return.totalGross - Sum of gross salaries
-     * @returns {number} return.totalNet - Sum of net salaries
-     * @returns {number} return.totalAllowances - Sum of all allowances
-     * @returns {number} return.totalDeductions - Sum of all deductions
-     */
-    static calculateTotalPayroll(payrolls: PayrollRecord[]): any;
-}
-export type AllowanceInput = {
-    /**
-     * - Type of allowance
-     */
-    type: string;
-    /**
-     * - Display name for the allowance
-     */
-    name?: string;
-    /**
-     * - Allowance value (amount or percentage)
-     */
-    value: number;
-    /**
-     * - Whether value is a percentage
-     */
-    isPercentage?: boolean;
-};
-export type DeductionInput = {
-    /**
-     * - Type of deduction
-     */
-    type: string;
-    /**
-     * - Display name for the deduction
-     */
-    name?: string;
-    /**
-     * - Deduction value (amount or percentage)
-     */
-    value: number;
-    /**
-     * - Whether value is a percentage
-     */
-    isPercentage?: boolean;
-};
-export type PeriodInput = {
-    /**
-     * - Month (1-12)
-     */
-    month?: number;
-    /**
-     * - Year
-     */
-    year?: number;
-};
-export type PayrollMetadata = {
-    /**
-     * - Currency code
-     */
-    currency?: string;
-    /**
-     * - Payment method
-     */
-    paymentMethod?: string;
-    /**
-     * - Additional notes
-     */
-    notes?: string;
-};
-export type PayrollRecord = {
-    /**
-     * - Employee identifier
-     */
-    employeeId: string;
-    /**
-     * - Organization identifier
-     */
-    organizationId: string;
-    /**
-     * - Pay period information
-     */
-    period: any;
-    /**
-     * - Salary breakdown
-     */
-    breakdown: {
-        baseAmount: number;
-        allowances: any[];
-        deductions: any[];
-        grossSalary: number;
-        netSalary: number;
-    };
-    /**
-     * - Payroll status ('pending', 'processed', 'paid')
-     */
-    status: string;
-    /**
-     * - When payroll was processed
-     */
-    processedAt: Date | null;
-    /**
-     * - When payment was made
-     */
-    paidAt: Date | null;
-    /**
-     * - Additional metadata
-     */
-    metadata: PayrollMetadata;
-};

package/dist/types/hrm.orchestrator.d.ts

@@ -1,47 +0,0 @@
-export const hrmOrchestrator: HRMOrchestrator;
-export const hrm: HRMOrchestrator;
-export default hrm;
-declare class HRMOrchestrator {
-    _models: {
-        EmployeeModel: any;
-        PayrollRecordModel: any;
-        TransactionModel: any;
-        AttendanceModel: any;
-    };
-    _initialized: boolean;
-    configure({ EmployeeModel, PayrollRecordModel, TransactionModel, AttendanceModel }: {
-        EmployeeModel: any;
-        PayrollRecordModel: any;
-        TransactionModel: any;
-        AttendanceModel?: any;
-    }): void;
-    _ensureInitialized(): void;
-    isInitialized(): boolean;
-    hire(params: any): Promise<any>;
-    updateEmployment(params: any): Promise<any>;
-    terminate(params: any): Promise<any>;
-    reHire(params: any): Promise<any>;
-    listEmployees(params: any): Promise<any>;
-    getEmployee(params: any): Promise<any>;
-    updateSalary(params: any): Promise<any>;
-    addAllowance(params: any): Promise<any>;
-    removeAllowance(params: any): Promise<any>;
-    addDeduction(params: any): Promise<any>;
-    removeDeduction(params: any): Promise<any>;
-    updateBankDetails(params: any): Promise<any>;
-    processSalary(params: any): Promise<{
-        payrollRecord: any;
-        transaction: any;
-        employee: any;
-    }>;
-    processBulkPayroll(params: any): Promise<{
-        successful: any[];
-        failed: any[];
-        total: any;
-    }>;
-    payrollHistory(params: any): Promise<any>;
-    payrollSummary(params: any): Promise<any>;
-    exportPayroll(params: any): Promise<any>;
-    getEmployeeModel(): any;
-    getPayrollRecordModel(): any;
-}

package/dist/types/index.d.ts

@@ -1,20 +0,0 @@
-export { setLogger } from "./utils/logger.js";
-export { employeePlugin } from "./plugins/employee.plugin.js";
-export { default as PayrollRecord } from "./models/payroll-record.model.js";
-export default hrmDefault;
-import { hrm as hrmDefault } from './hrm.orchestrator.js';
-export { initializeHRM, isInitialized } from "./init.js";
-export { EMPLOYMENT_TYPE, EMPLOYMENT_TYPE_VALUES, EMPLOYEE_STATUS, EMPLOYEE_STATUS_VALUES, DEPARTMENT, DEPARTMENT_VALUES, PAYMENT_FREQUENCY, PAYMENT_FREQUENCY_VALUES, PAYMENT_METHOD, PAYMENT_METHOD_VALUES, ALLOWANCE_TYPE, ALLOWANCE_TYPE_VALUES, DEDUCTION_TYPE, DEDUCTION_TYPE_VALUES, PAYROLL_STATUS, PAYROLL_STATUS_VALUES, TERMINATION_REASON, TERMINATION_REASON_VALUES, HRM_TRANSACTION_CATEGORIES, HRM_CATEGORY_VALUES, isHRMManagedCategory } from "./enums.js";
-export { HRM_CONFIG, SALARY_BANDS, TAX_BRACKETS, ORG_ROLES, ORG_ROLE_KEYS, ROLE_MAPPING, calculateTax, getSalaryBand, determineOrgRole } from "./config.js";
-export { employmentFields, allowanceSchema, deductionSchema, compensationSchema, workScheduleSchema, bankDetailsSchema, employmentHistorySchema, payrollStatsSchema } from "./schemas/employment.schema.js";
-export { hrm, hrmOrchestrator } from "./hrm.orchestrator.js";
-export { addDays, addMonths, diffInDays, diffInMonths, startOfMonth, endOfMonth, startOfYear, endOfYear, isWeekday, isWeekend, getPayPeriod, getCurrentPeriod, calculateProbationEnd, formatDateForDB, parseDBDate } from "./utils/date.utils.js";
-export { sum, sumBy, sumAllowances, sumDeductions, calculateGross, calculateNet, applyPercentage, calculatePercentage, createAllowanceCalculator, createDeductionCalculator, calculateTotalCompensation, pipe, compose } from "./utils/calculation.utils.js";
-export { isActive, isOnLeave, isSuspended, isTerminated, isEmployed, canReceiveSalary, hasCompensation, required, minValue, maxValue, isInRange, isPositive, isValidStatus, isValidEmploymentType, compose as composeValidators } from "./utils/validation.utils.js";
-export { QueryBuilder, EmployeeQueryBuilder, PayrollQueryBuilder, employee, payroll, toObjectId } from "./utils/query-builders.js";
-export { EmployeeFactory, EmployeeBuilder, createEmployee } from "./factories/employee.factory.js";
-export { PayrollFactory, PayrollBuilder, BatchPayrollFactory, createPayroll } from "./factories/payroll.factory.js";
-export { CompensationFactory, CompensationBuilder, CompensationPresets, createCompensation } from "./factories/compensation.factory.js";
-export { EmployeeService, createEmployeeService } from "./services/employee.service.js";
-export { PayrollService, createPayrollService } from "./services/payroll.service.js";
-export { CompensationService, createCompensationService } from "./services/compensation.service.js";

package/dist/types/init.d.ts

@@ -1,30 +0,0 @@
-/**
- * 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, logger: customLogger }: {
-    EmployeeModel: Model;
-    PayrollRecordModel: Model;
-    TransactionModel: Model;
-    AttendanceModel: Model;
-    logger: any;
-}): void;
-export function isInitialized(): boolean;
-export default initializeHRM;

package/dist/types/models/payroll-record.model.d.ts

@@ -1,3 +0,0 @@
-export default PayrollRecord;
-declare const PayrollRecord: mongoose.Model<any, {}, {}, {}, any, any, any>;
-import mongoose from 'mongoose';

package/dist/types/plugins/employee.plugin.d.ts

@@ -1,2 +0,0 @@
-export function employeePlugin(schema: any, options?: {}): void;
-export default employeePlugin;