@benup/bensdk 1.13.4 → 1.13.9-0

package/bin/lib/types/benefit-definition.types.d.ts

@@ -1,15 +1,20 @@
 import z from 'zod';
-import { EmploymentContracts } from '@benup-dev/benup-api';
+import { PayrollConfiguration } from '@benup-dev/benup-api';
 import { AxiosInstance } from 'axios';
+import pino from 'pino';
+import { EmploymentContractSchema } from '../schemas/action.schema';
 import { BenefitDefinitionSchema } from '../schemas/benefit-definition.schema';
 import { LockHelper } from './lib/lock-helper.lib.type';
 import { TokenHelper } from './lib/token-helper.lib.type';
 import { StateHandlerCtx, WebhookRequest, WebhookResponse } from './state-handler.types';
 type Base = z.infer<typeof BenefitDefinitionSchema>;
+type PayrollConfigurationType = z.infer<typeof PayrollConfiguration.default.collection.v3.PayrollConfigurationSchema>;
+type BenefitGeneralOptions = NonNullable<NonNullable<PayrollConfigurationType['dataMapping']['eligibility']>[number]['options']>;
 export type AuthHandlerCtx = {
     tokenHelper: TokenHelper;
     lockHelper: LockHelper;
-    employmentContract: z.infer<typeof EmploymentContracts.default.collection.default>;
+    employmentContract: z.infer<typeof EmploymentContractSchema>;
+    benefitGeneralOptions?: BenefitGeneralOptions;
 };
 export type AuthHandlerResult = {
     outcome: 'FAILED';
@@ -35,6 +40,46 @@ export type RateLimitConfig = {
     maxExecutionsPerWindow: number;
     windowSeconds: number;
 };
+export type DeductionSftpHandlerInput = {
+    deductionID: string;
+    payrollConfigurationID: string;
+    accountID: string;
+    companyID: string;
+    rawLineNumber: number;
+    rawLine: string;
+};
+export type DeductionSftpHandlerCtx = {
+    logger: pino.Logger;
+    benupAPI: AxiosInstance;
+};
+export type DeductionEmploymentContractHandlerInput = {
+    deductionID: string;
+    payrollConfigurationID: string;
+    accountID: string;
+    companyID: string;
+    employmentContractID: string;
+};
+export type DeductionEmploymentContractHandlerCtx = {
+    logger: pino.Logger;
+    benupAPI: AxiosInstance;
+    benefitPartnerAPI?: AxiosInstance;
+};
+export type DeductionPlanResult = {
+    planResult: 'FAILED';
+    reason: string;
+} | {
+    planResult: 'SUCCEEDED';
+    plannedPayrollDeduction: {
+        employmentContractID: string;
+        customerID: string;
+        externalEmploymentContractID: string;
+        value: number;
+        date: string;
+        isAccumulative: boolean;
+        externalPayrollID: string;
+        externalEventID: string;
+    };
+};
 export type BenefitDefinition = Omit<Base, 'stateMachine'> & {
     rateLimit?: RateLimitConfig;
     /**
@@ -57,7 +102,7 @@ export type BenefitDefinition = Omit<Base, 'stateMachine'> & {
         } & any;
         DEDUCTION?: {
             REQUESTED_DEDUCTION: {
-                next: 'REQUESTED_PAYROLL_DEDUCTION' | string;
+                next: 'DEDUCTION_REQUESTED' | string;
             };
         } & any;
     };
@@ -65,8 +110,16 @@ export type BenefitDefinition = Omit<Base, 'stateMachine'> & {
         handler: (request: WebhookRequest<any>, ctx: StateHandlerCtx) => Promise<WebhookResponse>;
     };
     auth?: {
-        handler: (credentials: any, ctx: any) => Promise<AuthHandlerResult>;
+        handler: (credentials: any[], ctx: any) => Promise<AuthHandlerResult>;
         credentialsHealthCheckHandler?: (credentials: any) => Promise<CredentialsHealthCheckResult>;
     };
+    deduction?: {
+        sftp?: {
+            rawLineHandler: (input: DeductionSftpHandlerInput, ctx: DeductionSftpHandlerCtx) => Promise<DeductionPlanResult>;
+        };
+        employmentContract?: {
+            handler: (input: DeductionEmploymentContractHandlerInput, ctx: DeductionEmploymentContractHandlerCtx) => Promise<DeductionPlanResult>;
+        };
+    };
 };
 export {};

package/bin/lib/types/lib/action-helper.lib.type.d.ts

@@ -1,4 +1,6 @@
+import { ActionAfterBeforeRecharge } from '../action.types';
 export interface ActionHelper {
+    findHooksByBatchID: (batchID: string) => Promise<ActionAfterBeforeRecharge[]>;
     findByContext: (ctx: any) => Promise<any[]>;
     findByExecutionID: (executionID: string) => Promise<any[]>;
     updateOne: (state: string, logs: any, body: any, action: any) => Promise<void>;

package/bin/lib/types/lib/token-helper.lib.type.d.ts

@@ -1,11 +1,13 @@
 type GetTokenParameters = {
     accountID: string;
     companyID: string;
+    cnpj?: string;
     benefitID: string;
 };
 type SetTokenParameters = {
     accountID: string;
     companyID: string;
+    cnpj?: string;
     benefitID: string;
     valueToBeStored: string;
     storeForSeconds: number;

package/bin/lib/types/state-handler.types.d.ts

@@ -78,6 +78,12 @@ export interface StateHandlerCtx {
      * Used to notify pc-recharge-api when a RECHARGE action reaches a terminal state.
      */
     pcRechargeAPI?: AxiosInstance;
+    /**
+     * pcDeductionAPI Axios instance
+     * Present only when PC_DEDUCTION_API_URL is configured.
+     * Used to notify pc-deduction-api when a DEDUCTION action reaches a terminal state.
+     */
+    pcDeductionAPI?: AxiosInstance;
     /**
      * deductionFileIngestionHelper
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@benup/bensdk",
-  "version": "1.13.4",
+  "version": "1.13.9-0",
   "main": "index.js",
   "type": "module",
   "scripts": {