@classytic/payroll 1.0.0 → 1.0.2

package/dist/types/config.d.ts

@@ -0,0 +1,162 @@
+export function calculateTax(annualIncome: any, currency?: string): number;
+export function getSalaryBand(amount: any): string;
+/**
+ * Determines the appropriate organization role for an employee
+ * Based on department, employment type, and position
+ * @param {Object} employmentData - Employee's employment data
+ * @param {string} employmentData.department - Employee's department
+ * @param {string} employmentData.type - Employment type (full_time, intern, etc.)
+ * @param {string} employmentData.position - Job position/title
+ * @returns {string} Organization role key
+ */
+export function determineOrgRole(employmentData?: {
+    department: string;
+    type: string;
+    position: string;
+}): string;
+export namespace HRM_CONFIG {
+    namespace dataRetention {
+        let payrollRecordsTTL: number;
+        let exportWarningDays: number;
+    }
+    namespace payroll {
+        let defaultCurrency: string;
+        let allowProRating: boolean;
+        let attendanceIntegration: boolean;
+        let autoDeductions: boolean;
+        let overtimeEnabled: boolean;
+    }
+    namespace salary {
+        let minimumWage: number;
+        let maximumAllowances: number;
+        let maximumDeductions: number;
+        let defaultFrequency: string;
+    }
+    namespace employment {
+        let defaultProbationMonths: number;
+        let maxProbationMonths: number;
+        let allowReHiring: boolean;
+        let trackEmploymentHistory: boolean;
+    }
+    namespace validation {
+        let requireBankDetails: boolean;
+        let requireEmployeeId: boolean;
+        let uniqueEmployeeIdPerOrg: boolean;
+        let allowMultiTenantEmployees: boolean;
+    }
+}
+export namespace ORG_ROLES {
+    namespace OWNER {
+        let key: string;
+        let label: string;
+        let description: string;
+    }
+    namespace MANAGER {
+        let key_1: string;
+        export { key_1 as key };
+        let label_1: string;
+        export { label_1 as label };
+        let description_1: string;
+        export { description_1 as description };
+    }
+    namespace TRAINER {
+        let key_2: string;
+        export { key_2 as key };
+        let label_2: string;
+        export { label_2 as label };
+        let description_2: string;
+        export { description_2 as description };
+    }
+    namespace STAFF {
+        let key_3: string;
+        export { key_3 as key };
+        let label_3: string;
+        export { label_3 as label };
+        let description_3: string;
+        export { description_3 as description };
+    }
+    namespace INTERN {
+        let key_4: string;
+        export { key_4 as key };
+        let label_4: string;
+        export { label_4 as label };
+        let description_4: string;
+        export { description_4 as description };
+    }
+    namespace CONSULTANT {
+        let key_5: string;
+        export { key_5 as key };
+        let label_5: string;
+        export { label_5 as label };
+        let description_5: string;
+        export { description_5 as description };
+    }
+}
+export const ORG_ROLE_KEYS: string[];
+export namespace ROLE_MAPPING {
+    export namespace byDepartment {
+        let management: string;
+        let training: string;
+        let sales: string;
+        let operations: string;
+        let finance: string;
+        let hr: string;
+        let marketing: string;
+        let it: string;
+        let support: string;
+    }
+    export namespace byEmploymentType {
+        let full_time: string;
+        let part_time: string;
+        let contract: string;
+        let intern: string;
+        let consultant: string;
+    }
+    let _default: string;
+    export { _default as default };
+}
+export namespace SALARY_BANDS {
+    export namespace intern_1 {
+        let min: number;
+        let max: number;
+    }
+    export { intern_1 as intern };
+    export namespace junior {
+        let min_1: number;
+        export { min_1 as min };
+        let max_1: number;
+        export { max_1 as max };
+    }
+    export namespace mid {
+        let min_2: number;
+        export { min_2 as min };
+        let max_2: number;
+        export { max_2 as max };
+    }
+    export namespace senior {
+        let min_3: number;
+        export { min_3 as min };
+        let max_3: number;
+        export { max_3 as max };
+    }
+    export namespace lead {
+        let min_4: number;
+        export { min_4 as min };
+        let max_4: number;
+        export { max_4 as max };
+    }
+    export namespace executive {
+        let min_5: number;
+        export { min_5 as min };
+        let max_5: number;
+        export { max_5 as max };
+    }
+}
+export namespace TAX_BRACKETS {
+    let BDT: {
+        min: number;
+        max: number;
+        rate: number;
+    }[];
+}
+export default HRM_CONFIG;

package/dist/types/core/compensation.manager.d.ts

@@ -0,0 +1,54 @@
+export function updateSalary({ EmployeeModel, employeeId, compensation, effectiveFrom, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    compensation?: {};
+    effectiveFrom?: Date;
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function addAllowance({ EmployeeModel, employeeId, type, amount, taxable, recurring, effectiveFrom, effectiveTo, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    type: any;
+    amount: any;
+    taxable?: boolean;
+    recurring?: boolean;
+    effectiveFrom?: Date;
+    effectiveTo?: any;
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function removeAllowance({ EmployeeModel, employeeId, type, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    type: any;
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function addDeduction({ EmployeeModel, employeeId, type, amount, auto, recurring, description, effectiveFrom, effectiveTo, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    type: any;
+    amount: any;
+    auto?: boolean;
+    recurring?: boolean;
+    description?: string;
+    effectiveFrom?: Date;
+    effectiveTo?: any;
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function removeDeduction({ EmployeeModel, employeeId, type, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    type: any;
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function updateBankDetails({ EmployeeModel, employeeId, bankDetails, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    bankDetails?: {};
+    context?: {};
+    session?: any;
+}): Promise<any>;

package/dist/types/core/employment.manager.d.ts

@@ -0,0 +1,49 @@
+export function hireEmployee({ EmployeeModel, organizationId, userId, employment, compensation, bankDetails, context, session }: {
+    EmployeeModel: any;
+    organizationId: any;
+    userId: any;
+    employment?: {};
+    compensation?: {};
+    bankDetails?: {};
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function updateEmployment({ EmployeeModel, employeeId, updates, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    updates?: {};
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function terminateEmployee({ EmployeeModel, employeeId, terminationDate, reason, notes, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    terminationDate?: Date;
+    reason?: string;
+    notes?: string;
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function reHireEmployee({ EmployeeModel, employeeId, hireDate, position, department, compensation, context, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    hireDate?: Date;
+    position?: any;
+    department?: any;
+    compensation?: any;
+    context?: {};
+    session?: any;
+}): Promise<any>;
+export function getEmployeeList({ EmployeeModel, organizationId, filters, pagination, session }: {
+    EmployeeModel: any;
+    organizationId: any;
+    filters?: {};
+    pagination?: {};
+    session?: any;
+}): Promise<any>;
+export function getEmployeeById({ EmployeeModel, employeeId, populateUser, session }: {
+    EmployeeModel: any;
+    employeeId: any;
+    populateUser?: boolean;
+    session?: any;
+}): Promise<any>;

package/dist/types/core/payroll.manager.d.ts

@@ -0,0 +1,60 @@
+export function processSalary({ EmployeeModel, PayrollRecordModel, TransactionModel, AttendanceModel, employeeId, month, year, paymentDate, paymentMethod, context, session }: {
+    EmployeeModel: any;
+    PayrollRecordModel: any;
+    TransactionModel: any;
+    AttendanceModel?: any;
+    employeeId: any;
+    month: any;
+    year: any;
+    paymentDate?: Date;
+    paymentMethod?: string;
+    context?: {};
+    session?: any;
+}): Promise<{
+    payrollRecord: any;
+    transaction: any;
+    employee: any;
+}>;
+export function processBulkPayroll({ EmployeeModel, PayrollRecordModel, TransactionModel, AttendanceModel, organizationId, month, year, employeeIds, paymentDate, paymentMethod, context, session: providedSession }: {
+    EmployeeModel: any;
+    PayrollRecordModel: any;
+    TransactionModel: any;
+    AttendanceModel?: any;
+    organizationId: any;
+    month: any;
+    year: any;
+    employeeIds?: any[];
+    paymentDate?: Date;
+    paymentMethod?: string;
+    context?: {};
+    session?: any;
+}): Promise<{
+    successful: any[];
+    failed: any[];
+    total: any;
+}>;
+export function getPayrollHistory({ PayrollRecordModel, employeeId, organizationId, month, year, status, pagination, session }: {
+    PayrollRecordModel: any;
+    employeeId?: any;
+    organizationId?: any;
+    month?: any;
+    year?: any;
+    status?: any;
+    pagination?: {};
+    session?: any;
+}): Promise<any>;
+export function getPayrollSummary({ PayrollRecordModel, organizationId, month, year, session }: {
+    PayrollRecordModel: any;
+    organizationId: any;
+    month?: any;
+    year?: any;
+    session?: any;
+}): Promise<any>;
+export function exportPayrollData({ PayrollRecordModel, organizationId, startDate, endDate, format, session }: {
+    PayrollRecordModel: any;
+    organizationId: any;
+    startDate: any;
+    endDate: any;
+    format?: string;
+    session?: any;
+}): Promise<any>;

package/dist/types/enums.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Check if category is HRM-managed (created by HRM workflows only)
+ */
+export function isHRMManagedCategory(category: any): boolean;
+export namespace EMPLOYMENT_TYPE {
+    let FULL_TIME: string;
+    let PART_TIME: string;
+    let CONTRACT: string;
+    let INTERN: string;
+    let CONSULTANT: string;
+}
+export const EMPLOYMENT_TYPE_VALUES: string[];
+export namespace EMPLOYEE_STATUS {
+    let ACTIVE: string;
+    let ON_LEAVE: string;
+    let SUSPENDED: string;
+    let TERMINATED: string;
+}
+export const EMPLOYEE_STATUS_VALUES: string[];
+export namespace DEPARTMENT {
+    let MANAGEMENT: string;
+    let TRAINING: string;
+    let SALES: string;
+    let OPERATIONS: string;
+    let SUPPORT: string;
+    let HR: string;
+    let MAINTENANCE: string;
+    let MARKETING: string;
+}
+export const DEPARTMENT_VALUES: string[];
+export namespace PAYMENT_FREQUENCY {
+    let MONTHLY: string;
+    let BI_WEEKLY: string;
+    let WEEKLY: string;
+    let HOURLY: string;
+    let DAILY: string;
+}
+export const PAYMENT_FREQUENCY_VALUES: string[];
+export namespace ALLOWANCE_TYPE {
+    let HOUSING: string;
+    let TRANSPORT: string;
+    let MEAL: string;
+    let MOBILE: string;
+    let MEDICAL: string;
+    let EDUCATION: string;
+    let OTHER: string;
+}
+export const ALLOWANCE_TYPE_VALUES: string[];
+export namespace DEDUCTION_TYPE {
+    export let TAX: string;
+    export let LOAN: string;
+    export let ADVANCE: string;
+    export let PROVIDENT_FUND: string;
+    export let INSURANCE: string;
+    export let ABSENCE: string;
+    let OTHER_1: string;
+    export { OTHER_1 as OTHER };
+}
+export const DEDUCTION_TYPE_VALUES: string[];
+export namespace PAYROLL_STATUS {
+    let PENDING: string;
+    let PROCESSING: string;
+    let PAID: string;
+    let FAILED: string;
+    let CANCELLED: string;
+}
+export const PAYROLL_STATUS_VALUES: string[];
+export namespace TERMINATION_REASON {
+    export let RESIGNATION: string;
+    export let RETIREMENT: string;
+    export let TERMINATION: string;
+    export let CONTRACT_END: string;
+    export let MUTUAL_AGREEMENT: string;
+    let OTHER_2: string;
+    export { OTHER_2 as OTHER };
+}
+export const TERMINATION_REASON_VALUES: string[];
+export namespace PAYMENT_METHOD {
+    let BANK: string;
+    let CASH: string;
+    let BKASH: string;
+    let NAGAD: string;
+    let ROCKET: string;
+}
+export const PAYMENT_METHOD_VALUES: string[];
+export namespace HRM_TRANSACTION_CATEGORIES {
+    let SALARY: string;
+    let BONUS: string;
+    let COMMISSION: string;
+    let OVERTIME: string;
+    let SEVERANCE: string;
+}
+export const HRM_CATEGORY_VALUES: string[];
+declare namespace _default {
+    export { EMPLOYMENT_TYPE };
+    export { EMPLOYMENT_TYPE_VALUES };
+    export { EMPLOYEE_STATUS };
+    export { EMPLOYEE_STATUS_VALUES };
+    export { DEPARTMENT };
+    export { DEPARTMENT_VALUES };
+    export { PAYMENT_FREQUENCY };
+    export { PAYMENT_FREQUENCY_VALUES };
+    export { PAYMENT_METHOD };
+    export { PAYMENT_METHOD_VALUES };
+    export { ALLOWANCE_TYPE };
+    export { ALLOWANCE_TYPE_VALUES };
+    export { DEDUCTION_TYPE };
+    export { DEDUCTION_TYPE_VALUES };
+    export { PAYROLL_STATUS };
+    export { PAYROLL_STATUS_VALUES };
+    export { TERMINATION_REASON };
+    export { TERMINATION_REASON_VALUES };
+    export { HRM_TRANSACTION_CATEGORIES };
+    export { HRM_CATEGORY_VALUES };
+    export { isHRMManagedCategory };
+}
+export default _default;

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

@@ -0,0 +1,196 @@
+export class CompensationFactory {
+    static create({ baseAmount, frequency, currency, allowances, deductions, effectiveFrom, }: {
+        baseAmount: any;
+        frequency?: string;
+        currency?: string;
+        allowances?: any[];
+        deductions?: any[];
+        effectiveFrom?: Date;
+    }): {
+        baseAmount: any;
+        frequency: string;
+        currency: string;
+        allowances: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        deductions: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        effectiveFrom: Date;
+        lastUpdated: Date;
+    };
+    static createAllowance({ type, name, value, isPercentage }: {
+        type: any;
+        name: any;
+        value: any;
+        isPercentage?: boolean;
+    }): {
+        type: any;
+        name: any;
+        value: any;
+        isPercentage: boolean;
+    };
+    static createDeduction({ type, name, value, isPercentage }: {
+        type: any;
+        name: any;
+        value: any;
+        isPercentage?: boolean;
+    }): {
+        type: any;
+        name: any;
+        value: any;
+        isPercentage: boolean;
+    };
+    static updateBaseAmount(compensation: any, newAmount: any, effectiveFrom?: Date): any;
+    static addAllowance(compensation: any, allowance: any): any;
+    static removeAllowance(compensation: any, allowanceType: any): any;
+    static addDeduction(compensation: any, deduction: any): any;
+    static removeDeduction(compensation: any, deductionType: any): any;
+    static calculateBreakdown(compensation: any): {
+        baseAmount: any;
+        allowances: any;
+        deductions: any;
+        grossAmount: any;
+        netAmount: number;
+    };
+    static applyIncrement(compensation: any, { percentage, amount, effectiveFrom }: {
+        percentage: any;
+        amount: any;
+        effectiveFrom?: Date;
+    }): any;
+}
+export class CompensationBuilder {
+    data: {
+        allowances: any[];
+        deductions: any[];
+        frequency: string;
+        currency: string;
+    };
+    withBase(amount: any, frequency?: string, currency?: string): this;
+    addAllowance(type: any, value: any, isPercentage?: boolean, name?: any): this;
+    addDeduction(type: any, value: any, isPercentage?: boolean, name?: any): this;
+    effectiveFrom(date: any): this;
+    build(): {
+        baseAmount: any;
+        frequency: string;
+        currency: string;
+        allowances: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        deductions: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        effectiveFrom: Date;
+        lastUpdated: Date;
+    };
+}
+export function createCompensation(): CompensationBuilder;
+export namespace CompensationPresets {
+    function basic(baseAmount: any): {
+        baseAmount: any;
+        frequency: string;
+        currency: string;
+        allowances: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        deductions: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        effectiveFrom: Date;
+        lastUpdated: Date;
+    };
+    function withHouseRent(baseAmount: any, rentPercentage?: number): {
+        baseAmount: any;
+        frequency: string;
+        currency: string;
+        allowances: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        deductions: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        effectiveFrom: Date;
+        lastUpdated: Date;
+    };
+    function withMedical(baseAmount: any, medicalPercentage?: number): {
+        baseAmount: any;
+        frequency: string;
+        currency: string;
+        allowances: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        deductions: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        effectiveFrom: Date;
+        lastUpdated: Date;
+    };
+    function standard(baseAmount: any): {
+        baseAmount: any;
+        frequency: string;
+        currency: string;
+        allowances: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        deductions: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        effectiveFrom: Date;
+        lastUpdated: Date;
+    };
+    function withProvidentFund(baseAmount: any, pfPercentage?: number): {
+        baseAmount: any;
+        frequency: string;
+        currency: string;
+        allowances: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        deductions: {
+            type: any;
+            name: any;
+            value: any;
+            isPercentage: boolean;
+        }[];
+        effectiveFrom: Date;
+        lastUpdated: Date;
+    };
+}