formula-parser-payroll 2.1.0

package/dist/nestjs/types.d.ts

@@ -0,0 +1,117 @@
+/**
+ * NestJS Module Types for Payroll Formula Parser
+ *
+ * This module provides type definitions for database-integrated formula parsing.
+ * The types are now generic and work with any database client.
+ */
+import { FormulaContext, IDatabaseConnection, CompanyContext, EncryptionConfig } from './database-connector';
+export { FormulaContext, IDatabaseConnection, CompanyContext, EncryptionConfig };
+/**
+ * Database connection interface
+ * @deprecated Use IDatabaseConnection from database-connector instead
+ * Kept for backward compatibility
+ */
+export interface DatabaseConnection {
+    query: (sql: string, params?: any[]) => Promise<any>;
+    getRepository?: (entity: any) => any;
+}
+/**
+ * User data from authentication
+ * @deprecated Use CompanyContext from database-connector instead
+ * Kept for backward compatibility
+ */
+export interface UserData {
+    companyId: string | number;
+    companyCode?: string;
+    currentCompanyCode?: string;
+    taxCountry?: string;
+    [key: string]: any;
+}
+/**
+ * Access token configuration for encryption/decryption
+ * @deprecated Use EncryptionConfig from database-connector instead
+ * Kept for backward compatibility
+ */
+export interface AccessTokenConfig {
+    confParse: {
+        PNUMBER: string;
+        LNUMBER: string;
+        [key: string]: any;
+    };
+    [key: string]: any;
+}
+/**
+ * Authentication context interface (Legacy)
+ * @deprecated Use FormulaContext from database-connector instead
+ * Kept for backward compatibility with existing payroll-server code
+ */
+export interface AuthContext {
+    /** Main database connection (for employee/organization data) */
+    conn: DatabaseConnection | any;
+    /** Finance database connection (for payroll data) */
+    connFin: DatabaseConnection | any;
+    /** User data from authentication */
+    userData: UserData | any;
+    /** Access token with encryption config */
+    accessToken: AccessTokenConfig | any;
+    /** Allow additional properties */
+    [key: string]: any;
+}
+/**
+ * Module configuration options
+ */
+export interface PayrollFormulaModuleOptions {
+    /** Whether to enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Input for parsing formula by employee ID
+ */
+export interface ParseByEmpIdInput {
+    /** The formula to parse */
+    formula: string;
+    /** Employee ID (for single employee) */
+    empId?: string;
+    /** List of Employee IDs (for multiple employees) */
+    listEmpId?: string[];
+    /** Authentication context with database connections */
+    auth: AuthContext;
+    /** Optional: for claim-specific processing */
+    checkType?: 'claimSetting' | 'payroll';
+}
+/**
+ * Cached data for formula processing
+ */
+export interface FormulaDataCache {
+    position?: any;
+    costCenter?: any;
+    grade?: any;
+    workLocation?: any;
+    employmentStatus?: string;
+    customField?: any;
+    childDependents?: number;
+}
+/**
+ * Reserved word list result
+ */
+export interface ReservedWordResult {
+    words2: string[];
+    arrayAcr: string[];
+    claimTypes2: string[];
+    attStatuses: any[];
+    leaveTypes: any[];
+    payvarMaster: any[];
+    arrayDiscp: string[];
+    attintfWord: any[];
+}
+/**
+ * Result format compatible with payroll-server
+ * Uses 'hasil' instead of 'result' to match existing API
+ */
+export interface FormulaParseResultLegacy {
+    /** The calculated result (matches payroll-server format) */
+    hasil: number | string | boolean;
+    /** Success or error message */
+    message: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/nestjs/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/nestjs/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAG7G,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACrD,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,gEAAgE;IAChE,IAAI,EAAE,kBAAkB,GAAG,GAAG,CAAC;IAE/B,qDAAqD;IACrD,OAAO,EAAE,kBAAkB,GAAG,GAAG,CAAC;IAElC,oCAAoC;IACpC,QAAQ,EAAE,QAAQ,GAAG,GAAG,CAAC;IAEzB,0CAA0C;IAC1C,WAAW,EAAE,iBAAiB,GAAG,GAAG,CAAC;IAErC,kCAAkC;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,sCAAsC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAEhB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB,uDAAuD;IACvD,IAAI,EAAE,WAAW,CAAC;IAElB,8CAA8C;IAC9C,SAAS,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,UAAU,EAAE,GAAG,EAAE,CAAC;IAClB,YAAY,EAAE,GAAG,EAAE,CAAC;IACpB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,GAAG,EAAE,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,4DAA4D;IAC5D,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAEjC,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/nestjs/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * NestJS Module Types for Payroll Formula Parser
+ *
+ * This module provides type definitions for database-integrated formula parsing.
+ * The types are now generic and work with any database client.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/nestjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/nestjs/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/dist/types.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Payroll Formula Parser - Type Definitions
+ *
+ * This module contains all interfaces and types needed for formula parsing.
+ * Users of this package need to provide data conforming to these interfaces.
+ */
+/**
+ * Employee personal data for formula parsing
+ */
+export interface EmployeePersonalData {
+    birthdate?: Date | string | null;
+    maritalstatus?: number | string | null;
+    religionCode?: string | null;
+    gender?: number | 'MALE' | 'FEMALE';
+}
+/**
+ * Employee company data for formula parsing
+ */
+export interface EmployeeCompanyData {
+    empId: string;
+    empNo?: string;
+    startDate?: Date | string | null;
+    endDate?: Date | string | null;
+    positionId?: string | null;
+    costCode?: string | null;
+    gradeCode?: string | null;
+    workLocationCode?: string | null;
+    jobStatusCode?: string | null;
+}
+/**
+ * Employee company group data
+ */
+export interface EmployeeCompanyGroupData {
+    joinDate?: Date | string | null;
+    fulljoinDate?: Date | string | null;
+    permanentDate?: Date | string | null;
+    pensionDate?: Date | string | null;
+    terminateDate?: Date | string | null;
+}
+/**
+ * Employee job status data
+ */
+export interface EmployeeJobStatusData {
+    jobstatusnameEn?: string;
+}
+/**
+ * Combined employee data structure
+ */
+export interface EmployeeData {
+    empId: string;
+    empNo?: string;
+    startDate?: Date | string | null;
+    endDate?: Date | string | null;
+    positionId?: string | null;
+    costCode?: string | null;
+    gradeCode?: string | null;
+    workLocationCode?: string | null;
+    jobStatusCode?: string | null;
+    personal?: EmployeePersonalData;
+    companyGroup?: EmployeeCompanyGroupData;
+    jobStatus?: EmployeeJobStatusData;
+}
+/**
+ * Position data for organizational lookups
+ */
+export interface PositionData {
+    positionId?: string;
+    posNameEn?: string;
+    posCode?: string;
+    deptId?: string;
+    dept?: {
+        positionId?: string;
+        posNameEn?: string;
+        posCode?: string;
+    };
+}
+/**
+ * Cost center data
+ */
+export interface CostCenterData {
+    costcenterCode?: string;
+    costcenterNameEn?: string;
+}
+/**
+ * Grade data
+ */
+export interface GradeData {
+    gradeCode?: string;
+    gradeName?: string;
+}
+/**
+ * Work location data
+ */
+export interface WorkLocationData {
+    worklocationCode?: string;
+    worklocationName?: string;
+}
+/**
+ * Custom field data (1-10)
+ */
+export interface CustomFieldData {
+    customfield1?: string;
+    customfield2?: string;
+    customfield3?: string;
+    customfield4?: string;
+    customfield5?: string;
+    customfield6?: string;
+    customfield7?: string;
+    customfield8?: string;
+    customfield9?: string;
+    customfield10?: string;
+}
+/**
+ * Organizational data cache for formula processing
+ */
+export interface OrganizationalData {
+    position?: PositionData;
+    costCenter?: CostCenterData;
+    grade?: GradeData;
+    workLocation?: WorkLocationData;
+    customField?: CustomFieldData;
+    employmentStatus?: string;
+    childDependents?: number;
+}
+/**
+ * Component value (allowance/deduction)
+ */
+export interface ComponentValue {
+    code: string;
+    value: number | string;
+}
+/**
+ * Main input for formula parsing
+ */
+export interface FormulaParseInput {
+    /** The formula to parse and evaluate */
+    formula: string;
+    /** Employee data for personal field replacements */
+    employeeData: EmployeeData;
+    /** Organizational data for organizational field replacements */
+    organizationalData?: OrganizationalData;
+    /** Component values (allowances, deductions) as key-value pairs */
+    componentValues?: Record<string, number | string>;
+    /** List of reserved words to look for in formula (optional - uses defaults if not provided) */
+    reservedWords?: string[];
+}
+/**
+ * Result of formula parsing
+ */
+export interface FormulaParseResult {
+    /** The calculated result */
+    result: number | string | boolean;
+    /** Success or error message */
+    message: string;
+    /** Whether parsing was successful */
+    success: boolean;
+    /** The final formula after variable substitution (for debugging) */
+    processedFormula?: string;
+}
+/**
+ * Tax country codes supported
+ */
+export type TaxCountry = 'ID' | 'TH' | 'MY' | 'PH';
+/**
+ * Currency codes supported
+ */
+export type CurrencyCode = 'IDR' | 'THB' | 'MYR' | 'PHP';
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,OAAO,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAChC,YAAY,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACpC,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACrC,WAAW,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACnC,aAAa,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,OAAO,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,SAAS,CAAC,EAAE,qBAAqB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE;QACL,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAEhB,oDAAoD;IACpD,YAAY,EAAE,YAAY,CAAC;IAE3B,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,mEAAmE;IACnE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAElD,+FAA+F;IAC/F,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAElC,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAEhB,qCAAqC;IACrC,OAAO,EAAE,OAAO,CAAC;IAEjB,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC"}

package/dist/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Payroll Formula Parser - Type Definitions
+ *
+ * This module contains all interfaces and types needed for formula parsing.
+ * Users of this package need to provide data conforming to these interfaces.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "formula-parser-payroll",
+  "version": "2.1.0",
+  "description": "A lightweight, high-performance payroll formula parser for GreatDay HR. Parse and evaluate payroll formulas with employee data variables. Features parallel processing, smart caching, and works with any database client (MySQL2, Knex, TypeORM, etc.).",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "DATABASE_CONNECTOR.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "lint": "eslint src/**/*.ts"
+  },
+  "keywords": [],
+  "author": "Joel Legifani Manisali",
+  "license": "MIT",
+  "dependencies": {
+    "hot-formula-parser": "^4.0.0",
+    "moment": "^2.29.4",
+    "moment-timezone": "^0.5.43"
+  },
+  "devDependencies": {
+    "@types/node": "^18.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/greatdayhr/payroll-formula-parser.git"
+  }
+}