@classytic/payroll 1.0.2 → 2.0.0

package/dist/types/services/compensation.service.d.ts

@@ -1,94 +0,0 @@
-export class CompensationService {
-    constructor(EmployeeModel: any);
-    EmployeeModel: any;
-    getEmployeeCompensation(employeeId: any): Promise<any>;
-    calculateBreakdown(employeeId: any): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    updateBaseAmount(employeeId: any, newAmount: any, effectiveFrom: any): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    applyIncrement(employeeId: any, { percentage, amount, effectiveFrom }: {
-        percentage: any;
-        amount: any;
-        effectiveFrom: any;
-    }): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    addAllowance(employeeId: any, allowance: any): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    removeAllowance(employeeId: any, allowanceType: any): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    addDeduction(employeeId: any, deduction: any): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    removeDeduction(employeeId: any, deductionType: any): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    setStandardCompensation(employeeId: any, baseAmount: any): Promise<{
-        baseAmount: any;
-        allowances: any;
-        deductions: any;
-        grossAmount: any;
-        netAmount: number;
-    }>;
-    compareCompensation(employeeId1: any, employeeId2: any): Promise<{
-        employee1: {
-            baseAmount: any;
-            allowances: any;
-            deductions: any;
-            grossAmount: any;
-            netAmount: number;
-        };
-        employee2: {
-            baseAmount: any;
-            allowances: any;
-            deductions: any;
-            grossAmount: any;
-            netAmount: number;
-        };
-        difference: {
-            base: number;
-            gross: number;
-            net: number;
-        };
-        ratio: {
-            base: number;
-            gross: number;
-            net: number;
-        };
-    }>;
-    getDepartmentCompensationStats(organizationId: any, department: any): Promise<any>;
-    getOrganizationCompensationStats(organizationId: any): Promise<any>;
-}
-export function createCompensationService(EmployeeModel: any): CompensationService;

package/dist/types/services/employee.service.d.ts

@@ -1,28 +0,0 @@
-export class EmployeeService {
-    constructor(EmployeeModel: any);
-    EmployeeModel: any;
-    findById(employeeId: any): Promise<any>;
-    findByUserId(userId: any, organizationId: any): Promise<any>;
-    findActive(organizationId: any, options?: {}): Promise<any>;
-    findEmployed(organizationId: any, options?: {}): Promise<any>;
-    findByDepartment(organizationId: any, department: any): Promise<any>;
-    findEligibleForPayroll(organizationId: any, month: any, year: any): Promise<any>;
-    create(data: any): Promise<any>;
-    updateStatus(employeeId: any, status: any, context?: {}): Promise<any>;
-    terminate(employeeId: any, reason: any, context?: {}): Promise<any>;
-    updateCompensation(employeeId: any, compensation: any): Promise<any>;
-    getEmployeeStats(organizationId: any): Promise<{
-        total: any;
-        active: any;
-        employed: any;
-        canReceiveSalary: any;
-        byStatus: any;
-        byDepartment: any;
-    }>;
-    groupByStatus(employees: any): any;
-    groupByDepartment(employees: any): any;
-    isActive(employee: any): boolean;
-    isEmployed(employee: any): boolean;
-    canReceiveSalary(employee: any): boolean;
-}
-export function createEmployeeService(EmployeeModel: any): EmployeeService;

package/dist/types/services/payroll.service.d.ts

@@ -1,30 +0,0 @@
-export class PayrollService {
-    constructor(PayrollModel: any, EmployeeService: any);
-    PayrollModel: any;
-    EmployeeService: any;
-    findById(payrollId: any): Promise<any>;
-    findByEmployee(employeeId: any, organizationId: any, options?: {}): Promise<any>;
-    findForPeriod(organizationId: any, month: any, year: any): Promise<any>;
-    findPending(organizationId: any, month: any, year: any): Promise<any>;
-    create(data: any): Promise<any>;
-    generateForEmployee(employeeId: any, organizationId: any, month: any, year: any): Promise<any>;
-    generateBatch(organizationId: any, month: any, year: any): Promise<{
-        success: boolean;
-        generated: number;
-        message: string;
-        payrolls?: undefined;
-    } | {
-        success: boolean;
-        generated: any;
-        payrolls: any;
-        message?: undefined;
-    }>;
-    markAsPaid(payrollId: any, paymentDetails?: {}): Promise<any>;
-    markAsProcessed(payrollId: any): Promise<any>;
-    calculatePeriodSummary(organizationId: any, month: any, year: any): Promise<any>;
-    getEmployeePayrollHistory(employeeId: any, organizationId: any, limit?: number): Promise<any>;
-    findByEmployeeAndPeriod(employeeId: any, organizationId: any, month: any, year: any): Promise<any>;
-    groupByStatus(payrolls: any): any;
-    getOverviewStats(organizationId: any): Promise<any>;
-}
-export function createPayrollService(PayrollModel: any, EmployeeService: any): PayrollService;

package/dist/types/utils/calculation.utils.d.ts

@@ -1,26 +0,0 @@
-export function sum(items: any, key: any): any;
-export function sumBy(key: any): (items: any) => any;
-export function sumAllowances(items: any): any;
-export function sumDeductions(items: any): any;
-export function calculateGross(base: any, allowances: any): any;
-export function calculateNet(gross: any, deductions: any): number;
-export function calculateTotalCompensation(base: any, allowances: any, deductions: any): {
-    gross: any;
-    net: number;
-    deductions: any;
-};
-export function applyTaxBracket(amount: any, brackets: any): number;
-export function calculateTax(amount: any, brackets: any): {
-    gross: any;
-    tax: number;
-    net: number;
-};
-export function proRateAmount(amount: any, workedDays: any, totalDays: any): number;
-export function calculatePercentage(value: any, total: any): number;
-export function applyPercentage(amount: any, percentage: any): number;
-export function composeDeductions(...deductionFns: any[]): (amount: any) => any;
-export function composeSalaryPipeline(base: any, operations: any): any;
-export function createAllowanceCalculator(allowances: any): (base: any) => any;
-export function createDeductionCalculator(deductions: any): (gross: any) => any;
-export function pipe(...fns: any[]): (value: any) => any;
-export function compose(...fns: any[]): (value: any) => any;

package/dist/types/utils/date.utils.d.ts

@@ -1,35 +0,0 @@
-export function addDays(date: any, days: any): Date;
-export function addMonths(date: any, months: any): Date;
-export function addYears(date: any, years: any): Date;
-export function startOfMonth(date: any): Date;
-export function endOfMonth(date: any): Date;
-export function startOfYear(date: any): Date;
-export function endOfYear(date: any): Date;
-export function isWeekday(date: any): boolean;
-export function isWeekend(date: any): boolean;
-export function getPayPeriod(month: any, year: any): {
-    month: any;
-    year: any;
-    startDate: Date;
-    endDate: Date;
-};
-export function getCurrentPeriod(date?: Date): {
-    year: number;
-    month: number;
-};
-export function calculateProbationEnd(hireDate: any, probationMonths: any): Date;
-export function formatDateForDB(date: any): string;
-export function parseDBDate(dateString: any): Date;
-export function diffInDays(start: any, end: any): number;
-export function diffInMonths(start: any, end: any): number;
-export function daysBetween(start: any, end: any): number;
-export function monthsBetween(start: any, end: any): number;
-export function isDateInRange(date: any, start: any, end: any): boolean;
-export function formatPeriod({ month, year }: {
-    month: any;
-    year: any;
-}): string;
-export function parsePeriod(periodString: any): {
-    month: any;
-    year: any;
-};

package/dist/types/utils/logger.d.ts

@@ -1,12 +0,0 @@
-/**
- * Set custom logger implementation
- * @param {Object} customLogger - Logger instance with info, warn, error, debug methods
- */
-export function setLogger(customLogger: any): void;
-export namespace logger {
-    function info(...args: any[]): void;
-    function warn(...args: any[]): void;
-    function error(...args: any[]): void;
-    function debug(...args: any[]): void;
-}
-export default logger;

package/dist/types/utils/query-builders.d.ts

@@ -1,83 +0,0 @@
-export function toObjectId(id: any): mongoose.Types.ObjectId;
-export class QueryBuilder {
-    constructor(initialQuery?: {});
-    query: {};
-    where(field: any, value: any): this;
-    whereIn(field: any, values: any): this;
-    whereNotIn(field: any, values: any): this;
-    whereGte(field: any, value: any): this;
-    whereLte(field: any, value: any): this;
-    whereBetween(field: any, start: any, end: any): this;
-    whereExists(field: any): this;
-    whereNotExists(field: any): this;
-    build(): {};
-}
-export function createQueryBuilder(initialQuery: any): QueryBuilder;
-export class EmployeeQueryBuilder extends QueryBuilder {
-    forOrganization(organizationId: any): this;
-    forUser(userId: any): this;
-    withStatus(...statuses: any[]): this;
-    active(): this;
-    employed(): this;
-    inDepartment(department: any): this;
-    inPosition(position: any): this;
-    withEmploymentType(type: any): this;
-    hiredAfter(date: any): this;
-    hiredBefore(date: any): this;
-}
-export class PayrollQueryBuilder extends QueryBuilder {
-    forOrganization(organizationId: any): this;
-    forEmployee(employeeId: any): this;
-    forPeriod(month: any, year: any): this;
-    withStatus(...statuses: any[]): this;
-    paid(): this;
-    pending(): this;
-    inDateRange(start: any, end: any): this;
-}
-export function employee(): EmployeeQueryBuilder;
-export function payroll(): PayrollQueryBuilder;
-export function buildEmployeeQuery({ organizationId, userId, statuses }: {
-    organizationId: any;
-    userId: any;
-    statuses: any;
-}): {};
-export function buildPayrollQuery({ employeeId, period, statuses }: {
-    employeeId: any;
-    period: any;
-    statuses: any;
-}): {};
-export function buildAggregationPipeline(...stages: any[]): any[];
-export function matchStage(query: any): {
-    $match: any;
-};
-export function groupStage(groupBy: any, aggregations: any): {
-    $group: any;
-};
-export function sortStage(sortBy: any): {
-    $sort: any;
-};
-export function limitStage(limit: any): {
-    $limit: any;
-};
-export function projectStage(fields: any): {
-    $project: any;
-};
-export function lookupStage({ from, localField, foreignField, as }: {
-    from: any;
-    localField: any;
-    foreignField: any;
-    as: any;
-}): {
-    $lookup: {
-        from: any;
-        localField: any;
-        foreignField: any;
-        as: any;
-    };
-};
-export function unwindStage(path: any, options?: {}): {
-    $unwind: {
-        path: any;
-    };
-};
-import mongoose from 'mongoose';

package/dist/types/utils/validation.utils.d.ts

@@ -1,33 +0,0 @@
-export function isActive(employee: any): boolean;
-export function isOnLeave(employee: any): boolean;
-export function isSuspended(employee: any): boolean;
-export function isTerminated(employee: any): boolean;
-export function isEmployed(employee: any): boolean;
-export function canReceiveSalary(employee: any): boolean;
-export function canUpdateEmployment(employee: any): boolean;
-export function isInProbation(employee: any, now?: Date): boolean;
-export function hasCompletedProbation(employee: any, now?: Date): boolean;
-export function hasCompensation(employee: any): boolean;
-export function isEligibleForBonus(employee: any, requiredMonths?: number): boolean;
-export function isValidCompensation(compensation: any): any;
-export function isValidBankDetails(bankDetails: any): any;
-export function hasRequiredFields(obj: any, fields: any): any;
-export function createValidator(validationFns: any): (data: any) => {
-    isValid: boolean;
-    errors: {
-        field: string;
-        message: any;
-    }[];
-};
-export function required(fieldName: any): (value: any) => string | true;
-export function min(minValue: any, fieldName: any): (value: any) => string | true;
-export function max(maxValue: any, fieldName: any): (value: any) => string | true;
-export function inRange(minValue: any, maxValue: any, fieldName: any): (value: any) => string | true;
-export function oneOf(allowedValues: any, fieldName: any): (value: any) => string | true;
-export function compose(...validators: any[]): (value: any, data: any) => any;
-export function isPositive(fieldName: any): (value: any) => string | true;
-export function isValidStatus(value: any): boolean;
-export function isValidEmploymentType(value: any): boolean;
-export function minValue(minValue: any, fieldName: any): (value: any) => string | true;
-export function maxValue(maxValue: any, fieldName: any): (value: any) => string | true;
-export function isInRange(minValue: any, maxValue: any, fieldName: any): (value: any) => string | true;

package/payroll.d.ts

@@ -1,241 +0,0 @@
-/**
- * Type declarations for @classytic/payroll
- * This provides IntelliSense support for the HRM library
- */
-
-declare module '@classytic/payroll' {
-    import { Model, Document } from 'mongoose';
-  
-    // Initialization
-    export function initializeHRM(config: {
-      EmployeeModel: Model<any>;
-      PayrollRecordModel: Model<any>;
-      TransactionModel: Model<any>;
-      AttendanceModel?: Model<any> | null;
-      logger?: any;
-    }): void;
-  
-    export function isInitialized(): boolean;
-    export function setLogger(logger: any): void;
-  
-    // Models
-    export const PayrollRecord: Model<any>;
-  
-    // Orchestrator
-    export const hrm: any;
-    export const hrmOrchestrator: any;
-  
-    // Enums
-    export const EMPLOYMENT_TYPE: Record<string, string>;
-    export const EMPLOYMENT_TYPE_VALUES: string[];
-    export const EMPLOYEE_STATUS: Record<string, string>;
-    export const EMPLOYEE_STATUS_VALUES: string[];
-    export const DEPARTMENT: Record<string, string>;
-    export const DEPARTMENT_VALUES: string[];
-    export const PAYMENT_FREQUENCY: Record<string, string>;
-    export const PAYMENT_FREQUENCY_VALUES: string[];
-    export const PAYMENT_METHOD: Record<string, string>;
-    export const PAYMENT_METHOD_VALUES: string[];
-    export const ALLOWANCE_TYPE: Record<string, string>;
-    export const ALLOWANCE_TYPE_VALUES: string[];
-    export const DEDUCTION_TYPE: Record<string, string>;
-    export const DEDUCTION_TYPE_VALUES: string[];
-    export const PAYROLL_STATUS: Record<string, string>;
-    export const PAYROLL_STATUS_VALUES: string[];
-    export const TERMINATION_REASON: Record<string, string>;
-    export const TERMINATION_REASON_VALUES: string[];
-    export const HRM_TRANSACTION_CATEGORIES: Record<string, string>;
-    export const HRM_CATEGORY_VALUES: string[];
-    export function isHRMManagedCategory(category: string): boolean;
-  
-    // Config
-    export const HRM_CONFIG: any;
-    export const SALARY_BANDS: any;
-    export const TAX_BRACKETS: any;
-    export const ORG_ROLES: Record<string, string>;
-    export const ORG_ROLE_KEYS: string[];
-    export const ROLE_MAPPING: Record<string, any>;
-    export function calculateTax(income: number): number;
-    export function getSalaryBand(salary: number): any;
-    export function determineOrgRole(role: string): string;
-  
-    // Schemas
-    export const employmentFields: Record<string, any>;
-    export const allowanceSchema: any;
-    export const deductionSchema: any;
-    export const compensationSchema: any;
-    export const workScheduleSchema: any;
-    export const bankDetailsSchema: any;
-    export const employmentHistorySchema: any;
-    export const payrollStatsSchema: any;
-  
-    // Plugins
-    export function employeePlugin(schema: any, options?: any): void;
-  
-    // Utilities
-    export function addDays(date: Date, days: number): Date;
-    export function addMonths(date: Date, months: number): Date;
-    export function diffInDays(date1: Date, date2: Date): number;
-    export function diffInMonths(date1: Date, date2: Date): number;
-    export function startOfMonth(date: Date): Date;
-    export function endOfMonth(date: Date): Date;
-    export function startOfYear(date: Date): Date;
-    export function endOfYear(date: Date): Date;
-    export function isWeekday(date: Date): boolean;
-    export function isWeekend(date: Date): boolean;
-    export function getPayPeriod(date: Date, frequency: string): any;
-    export function getCurrentPeriod(frequency: string): any;
-    export function calculateProbationEnd(startDate: Date, months: number): Date;
-    export function formatDateForDB(date: Date): string;
-    export function parseDBDate(dateString: string): Date;
-  
-    // Calculation utilities
-    export function sum(...numbers: number[]): number;
-    export function sumBy<T>(array: T[], iteratee: (item: T) => number): number;
-    export function sumAllowances(allowances: any[]): number;
-    export function sumDeductions(deductions: any[]): number;
-    export function calculateGross(baseSalary: number, allowances: any[]): number;
-    export function calculateNet(gross: number, deductions: any[]): number;
-    export function applyPercentage(amount: number, percentage: number): number;
-    export function calculatePercentage(part: number, total: number): number;
-    export function createAllowanceCalculator(config: any): (salary: number) => number;
-    export function createDeductionCalculator(config: any): (salary: number) => number;
-    export function calculateTotalCompensation(compensation: any): number;
-    export function pipe(...fns: Function[]): Function;
-    export function compose(...fns: Function[]): Function;
-  
-    // Validation utilities
-    export function isActive(employee: any): boolean;
-    export function isOnLeave(employee: any): boolean;
-    export function isSuspended(employee: any): boolean;
-    export function isTerminated(employee: any): boolean;
-    export function isEmployed(employee: any): boolean;
-    export function canReceiveSalary(employee: any): boolean;
-    export function hasCompensation(employee: any): boolean;
-    export function required(value: any): boolean;
-    export function minValue(min: number): (value: number) => boolean;
-    export function maxValue(max: number): (value: number) => boolean;
-    export function isInRange(min: number, max: number): (value: number) => boolean;
-    export function isPositive(value: number): boolean;
-    export function isValidStatus(status: string): boolean;
-    export function isValidEmploymentType(type: string): boolean;
-    export function composeValidators(...validators: Function[]): Function;
-  
-    // Query Builders
-    export class QueryBuilder {
-      where(conditions: any): this;
-      select(fields: string | string[]): this;
-      populate(paths: string | any[]): this;
-      sort(sort: any): this;
-      limit(limit: number): this;
-      skip(skip: number): this;
-      lean(lean?: boolean): this;
-      exec(): Promise<any>;
-    }
-  
-    export class EmployeeQueryBuilder extends QueryBuilder {
-      byOrganization(organizationId: string): this;
-      byStatus(status: string): this;
-      byDepartment(department: string): this;
-      active(): this;
-      terminated(): this;
-    }
-  
-    export class PayrollQueryBuilder extends QueryBuilder {
-      byEmployee(employeeId: string): this;
-      byPeriod(year: number, month: number): this;
-      byStatus(status: string): this;
-      pending(): this;
-      processed(): this;
-    }
-  
-    export function employee(model: Model<any>): EmployeeQueryBuilder;
-    export function payroll(model: Model<any>): PayrollQueryBuilder;
-    export function toObjectId(id: string): any;
-  
-    // Factories
-    export class EmployeeFactory {
-      static create(data: any): any;
-    }
-  
-    export class EmployeeBuilder {
-      setBasicInfo(info: any): this;
-      setEmployment(employment: any): this;
-      setCompensation(compensation: any): this;
-      build(): any;
-    }
-  
-    export function createEmployee(data: any): any;
-  
-    export class PayrollFactory {
-      static create(data: any): any;
-    }
-  
-    export class PayrollBuilder {
-      setEmployee(employeeId: string): this;
-      setPeriod(year: number, month: number): this;
-      setEarnings(earnings: any): this;
-      setDeductions(deductions: any): this;
-      build(): any;
-    }
-  
-    export class BatchPayrollFactory {
-      static createBatch(employees: any[], period: any): any[];
-    }
-  
-    export function createPayroll(data: any): any;
-  
-    export class CompensationFactory {
-      static create(data: any): any;
-    }
-  
-    export class CompensationBuilder {
-      setBaseSalary(amount: number): this;
-      addAllowance(allowance: any): this;
-      addDeduction(deduction: any): this;
-      build(): any;
-    }
-  
-    export const CompensationPresets: {
-      junior: (baseSalary: number) => any;
-      mid: (baseSalary: number) => any;
-      senior: (baseSalary: number) => any;
-      manager: (baseSalary: number) => any;
-    };
-  
-    export function createCompensation(data: any): any;
-  
-    // Services
-    export class EmployeeService {
-      constructor(model: Model<any>);
-      findById(id: string): Promise<any>;
-      findByOrganization(organizationId: string): Promise<any[]>;
-      create(data: any): Promise<any>;
-      update(id: string, data: any): Promise<any>;
-      delete(id: string): Promise<void>;
-    }
-  
-    export function createEmployeeService(model: Model<any>): EmployeeService;
-  
-    export class PayrollService {
-      constructor(payrollModel: Model<any>, employeeModel: Model<any>);
-      processPayroll(employeeId: string, period: any): Promise<any>;
-      findByPeriod(organizationId: string, year: number, month: number): Promise<any[]>;
-    }
-  
-    export function createPayrollService(
-      payrollModel: Model<any>,
-      employeeModel: Model<any>
-    ): PayrollService;
-  
-    export class CompensationService {
-      constructor(employeeModel: Model<any>);
-      updateCompensation(employeeId: string, compensation: any): Promise<any>;
-      getCompensationHistory(employeeId: string): Promise<any[]>;
-    }
-  
-    export function createCompensationService(model: Model<any>): CompensationService;
-  
-    export default hrm;
-  }
-