@benup/bensdk 1.0.7 → 1.1.0

package/bin/src/cli/templates/bensdk-cli/templates/state.handler.template.ts

@@ -1,14 +1,14 @@
 /* eslint-disable jsdoc/require-jsdoc */
+// import benefitDefinition from '../benefit-definition';
 // import {Action} from "../benefit-definition.types.js";
-import benefitDefinition from '../benefit-definition';
 import { StateHandler } from '../lib/types/state.handler.type';
-import { getLogsFromResponse } from "../lib/utils/logs";
+import { getLogsFromResponse } from '../lib/utils/logs';
 
 export interface BenefitResponse {
   values: string[];
 }
 
-// StateMachine, 
+// StateMachine,
 
 export const options = {
   maxRetries: 10
@@ -33,15 +33,14 @@ const handler: StateHandler<
      */
     return {
       handlerResponse: {
-        response: "UNACK"
-      },
+        response: 'UNACK'
+      }
     };
   }
 
-
   return {
     handlerResponse: {
-      response: "ACK"
+      response: 'ACK'
     },
     action: {
       state: stateMachine.next,

package/bin/src/cli/templates/bensdk-cli/validate.ts

@@ -1,19 +1,18 @@
 /// <reference types="node" />
-import { BenefitDefinitionSchema } from "./lib/benefit-definition.schema";
-import fs from "fs";
-import validateStateMachine, {
-  finalStates,
-  initialStates,
-} from "./lib/state-machine";
+import { BenefitDefinitionSchema } from './lib/benefit-definition.schema';
+import validateStateMachine, { finalStates, initialStates } from './lib/state-machine';
 
 function validateStateMachineStatesInLogs(benefitDefinition: any) {
   // Get all states from each action type's state machine
   const statesByAction = Object.entries(benefitDefinition.stateMachine)
     .filter(([action]) => benefitDefinition.availableActions.includes(action))
-    .reduce((acc, [action, states]) => {
-      acc[action] = Object.keys(states as object);
-      return acc;
-    }, {} as Record<string, string[]>);
+    .reduce(
+      (acc, [action, states]) => {
+        acc[action] = Object.keys(states as object);
+        return acc;
+      },
+      {} as Record<string, string[]>
+    );
 
   // Check if each state has a corresponding log schema
   Object.entries(statesByAction).forEach(([action, states]) => {
@@ -30,11 +29,7 @@ function validateStateMachineStatesInLogs(benefitDefinition: any) {
     );
 
     if (missingStates.length > 0) {
-      throw new Error(
-        `Missing log schemas for states in ${action}: ${missingStates.join(
-          ", "
-        )}`
-      );
+      throw new Error(`Missing log schemas for states in ${action}: ${missingStates.join(', ')}`);
     }
   });
 }
@@ -46,22 +41,29 @@ export async function validateBenefitDefinition(benefitDefinition: any) {
     validateStateMachine(benefitDefinition.stateMachine.GRANT);
     validateStateMachine(benefitDefinition.stateMachine.REVOKE);
 
-    if (benefitDefinition.availableActions.includes("RECHARGE")) {
+    if (benefitDefinition.availableActions.includes('RECHARGE')) {
       validateStateMachine(benefitDefinition.stateMachine.RECHARGE);
     }
 
+    if (benefitDefinition.availableActions.includes('GRANT_DEPENDENT')) {
+      validateStateMachine(benefitDefinition.stateMachine.GRANT_DEPENDENT);
+    }
+
+    if (benefitDefinition.availableActions.includes('REVOKE_DEPENDENT')) {
+      validateStateMachine(benefitDefinition.stateMachine.REVOKE_DEPENDENT);
+    }
+
     validateStateMachineStatesInLogs(benefitDefinition);
 
-    console.log("Benefit definition is valid");
+    console.log('Benefit definition is valid');
   } catch (error) {
-    console.error("Failed to validate benefit definition:", error);
+    console.error('Failed to validate benefit definition:', error);
     process.exit(1);
   }
 }
 
 async function main() {
-  const benefitDefinition = (await import(`${process.cwd()}/src/benefit-definition.ts` ))
-  .default;
+  const benefitDefinition = (await import(`${process.cwd()}/src/benefit-definition.ts`)).default;
 
   await validateBenefitDefinition(benefitDefinition);
 }

package/bin/src/cli/templates/bensdk-lib/types/action-base.type.ts

@@ -1,177 +1,214 @@
 export type ActionBase = {
-    _id: string;
-    batchID?: string | undefined;
-    parentActionID?: string | undefined;
-    fingerprint?: string | undefined;
-    benefitID: string;
-    action: "GRANT" | "REVOKE" | "DEDUCTION" | "RECHARGE";
-    state: string;
-    target: {
-        employee: {
-            _id: string;
-            name: string;
-            /** CPF in format 000.000.000-00 */
-            cpf: string;
-            birthdate: string;
-            address: {
-                street: string;
-                number: string;
-                complement?: string | undefined;
-                neighborhood: string;
-                city: string;
-                state: string;
-                zipCode: string;
-                country: string;
-            };
-            email?: string | undefined;
-            createdAt: string;
-            updatedAt?: string | undefined;
+  _id: string;
+  batchID?: string | undefined;
+  parentActionID?: string | undefined;
+  fingerprint?: string | undefined;
+  benefitID: string;
+  action: 'GRANT' | 'REVOKE' | 'DEDUCTION' | 'RECHARGE' | 'GRANT_DEPENDENT' | 'REVOKE_DEPENDENT';
+  state: string;
+  target: {
+    dependent: {
+      externalDependentID: string;
+      externalDependentCode: string;
+      name: string;
+      /** CPF in format 000.000.000-00 */
+      cpf: string;
+      birthDate: string;
+      sex: 'M' | 'F';
+      relationshipType: string;
+      maritalStatus: string;
+      benefits: {
+        [x: string]: {
+          value: boolean;
+          options?: {} | undefined;
         };
-        employmentContract: {
-            _id: string;
-            companyID: string;
-            customerID: string;
-            accountID: string;
-            establishmentID: string;
-            admissionDate: string;
-            externalEmploymentContractID: string;
-            position: {
-                code: number;
-                description: string;
-            };
-            establishment: {
-                code: number;
-                description: string;
-            };
-            startDateOfCurrentSituation: string;
-            situation: {
-                code: number;
-                description: string;
-            };
-            benefits: {
-                [x: string]: {
-                    value: boolean;
-                    options?: {} | undefined;
-                };
-            };
-            status: "ADMITTED" | "DISMISSED" | "SUSPENDED" | "IGNORED";
-            fingerprint: string;
-            createdAt: string;
-            isDeleted?: boolean;
-        };
-        company: {
-            _id: string;
-            accountID: string;
-            cnpj: string;
-            /** razao social */
-            businessName: string;
-            /** nome fantasia */
-            tradeName: string;
-            address?: {
-                street: string;
-                number: string;
-                complement?: string | undefined;
-                neighborhood: string;
-                city: string;
-                state: string;
-                zipCode: string;
-                country: string;
-            } | undefined;
-            createdAt: string;
-            updatedAt?: string | undefined;
-        };
-        payrollConfiguration: {
-            _id: string;
-            accountID: string;
-            companyID: string;
-            payrollSystem: "LG_ONPREMISE_VLI" | "LG_CLOUD" | "LG_ONPREMISE_AMBEV";
-            eligibilitySource: "BENEFIT_MODULE" | "ADDITIONAL_ATTRIBUTE";
-            productToggle?: {
-                isOcherstratorActive?: boolean;
-                isIntegratorActive?: boolean;
-            };
-            cutoffDay: number;
-            modifiedContractsWindowInDays: number;
-            dataMapping: {
-                eligibility?: {
-                    benefitID: string;
-                    eligibilityType: "BENEFIT" | "ATTRIBUTE" | "ELIGIBLE_TO_ALL";
-                    eligibilityCode?: (number | string) | undefined;
-                    eligibilityMap?: {
-                        eligibilityValue: (boolean | number) | string;
-                        isEligible: boolean;
-                        options: {};
-                    }[] | undefined;
-                }[] | undefined;
-                deduction?: {
-                    benefitID: string;
-                    deduction: {
-                        externalPayrollID: number;
-                        externalPayrollEventID: number;
-                    };
-                    refund?: {
-                        externalPayrollID: number;
-                        externalPayrollEventID: number;
-                    } | undefined;
-                    meta?: {} | undefined;
-                }[] | undefined;
-                recharge?: {
-                    cronID: string;
-                    label?: string | undefined;
-                    eventID: number;
-                    sheetID: number;
-                    benefitID: string;
-                    productID?: string | undefined;
-                    executionCron: string;
-                    rechargeDate?: number | undefined;
-                }[] | undefined;
-                situation?: {
-                    code: number;
-                    value: "ADMITTED" | "DISMISSED" | "SUSPENDED" | "IGNORED";
-                }[] | undefined;
-            };
-            version: 2;
-            isDeleted?: boolean;
-            createdAt: string;
-            updatedAt?: string | undefined;
-            deletedAt?: string | undefined;
-        };
-        establishment: {
-            _id: string;
-            accountID: string;
-            companyID: string;
-            cnpj: string;
-            /** razao social */
-            businessName: string;
-            /** nome fantasia */
-            tradeName: string;
-            /** código da empresa no sistema de folha */
-            externalEstablishmentID: string;
-            address?: {
-                street: string;
-                number: string;
-                complement?: string | undefined;
-                neighborhood: string;
-                city: string;
-                state: string;
-                zipCode: string;
-                country: string;
-            } | undefined;
-            createdAt: string;
-            updatedAt?: string | undefined;
+      };
+      status: 'LINKED' | 'UNLINKED';
+    };
+    employee: {
+      _id: string;
+      name: string;
+      /** CPF in format 000.000.000-00 */
+      cpf: string;
+      birthdate: string;
+      address: {
+        street: string;
+        number: string;
+        complement?: string | undefined;
+        neighborhood: string;
+        city: string;
+        state: string;
+        zipCode: string;
+        country: string;
+      };
+      email?: string | undefined;
+      createdAt: string;
+      updatedAt?: string | undefined;
+    };
+    employmentContract: {
+      _id: string;
+      companyID: string;
+      customerID: string;
+      accountID: string;
+      establishmentID: string;
+      admissionDate: string;
+      externalEmploymentContractID: string;
+      position: {
+        code: number;
+        description: string;
+      };
+      establishment: {
+        code: number;
+        description: string;
+      };
+      startDateOfCurrentSituation: string;
+      situation: {
+        code: number;
+        description: string;
+      };
+      benefits: {
+        [x: string]: {
+          value: boolean;
+          options?: {} | undefined;
         };
+      };
+      status: 'ADMITTED' | 'DISMISSED' | 'SUSPENDED' | 'IGNORED';
+      fingerprint: string;
+      createdAt: string;
+      isDeleted?: boolean;
+    };
+    company: {
+      _id: string;
+      accountID: string;
+      cnpj: string;
+      /** razao social */
+      businessName: string;
+      /** nome fantasia */
+      tradeName: string;
+      address?:
+        | {
+            street: string;
+            number: string;
+            complement?: string | undefined;
+            neighborhood: string;
+            city: string;
+            state: string;
+            zipCode: string;
+            country: string;
+          }
+        | undefined;
+      createdAt: string;
+      updatedAt?: string | undefined;
+    };
+    payrollConfiguration: {
+      _id: string;
+      accountID: string;
+      companyID: string;
+      payrollSystem: 'LG_ONPREMISE_VLI' | 'LG_CLOUD' | 'LG_ONPREMISE_AMBEV';
+      eligibilitySource: 'BENEFIT_MODULE' | 'ADDITIONAL_ATTRIBUTE';
+      productToggle?: {
+        isOcherstratorActive?: boolean;
+        isIntegratorActive?: boolean;
+      };
+      cutoffDay: number;
+      modifiedContractsWindowInDays: number;
+      dataMapping: {
+        eligibility?:
+          | {
+              benefitID: string;
+              eligibilityType: 'BENEFIT' | 'ATTRIBUTE' | 'ELIGIBLE_TO_ALL';
+              eligibilityCode?: (number | string) | undefined;
+              eligibilityMap?:
+                | {
+                    eligibilityValue: (boolean | number) | string;
+                    isEligible: boolean;
+                    options: {};
+                  }[]
+                | undefined;
+            }[]
+          | undefined;
+        deduction?:
+          | {
+              benefitID: string;
+              deduction: {
+                externalPayrollID: number;
+                externalPayrollEventID: number;
+              };
+              refund?:
+                | {
+                    externalPayrollID: number;
+                    externalPayrollEventID: number;
+                  }
+                | undefined;
+              meta?: {} | undefined;
+            }[]
+          | undefined;
+        recharge?:
+          | {
+              rechargeID: string;
+              label?: string | undefined;
+              eventID: number;
+              sheetID: number;
+              benefitID: string;
+              productID?: string | undefined;
+              executionCron: string;
+              rechargeDate?: number | undefined;
+            }[]
+          | undefined;
+        situation?:
+          | {
+              code: number;
+              value: 'ADMITTED' | 'DISMISSED' | 'SUSPENDED' | 'IGNORED';
+            }[]
+          | undefined;
+      };
+      version: 2;
+      isDeleted?: boolean;
+      createdAt: string;
+      updatedAt?: string | undefined;
+      deletedAt?: string | undefined;
+    };
+    establishment: {
+      _id: string;
+      accountID: string;
+      companyID: string;
+      cnpj: string;
+      /** razao social */
+      businessName: string;
+      /** nome fantasia */
+      tradeName: string;
+      /** código da empresa no sistema de folha */
+      externalEstablishmentID: string;
+      address?:
+        | {
+            street: string;
+            number: string;
+            complement?: string | undefined;
+            neighborhood: string;
+            city: string;
+            state: string;
+            zipCode: string;
+            country: string;
+          }
+        | undefined;
+      createdAt: string;
+      updatedAt?: string | undefined;
     };
-    eligibilityOptions: {};
-    ctx?: {} | undefined;
-    log?: {} | undefined;
-    origin: string;
-    rechargeInput?: {
+  };
+  eligibilityOptions: {};
+  ctx?: {} | undefined;
+  log?: {} | undefined;
+  origin: string;
+  rechargeInput?:
+    | {
         externalSheetID: string;
         externalEventID: string;
         date: string;
         value: number;
-    } | undefined;
-    deductionInput?: {
+      }
+    | undefined;
+  deductionInput?:
+    | {
         payrollSystem: string;
         externalSheetID: string;
         externalEventID: string;
@@ -179,7 +216,8 @@ export type ActionBase = {
         isAccumulative: boolean;
         date: string;
         value: number;
-    } | undefined;
-    createdAt: string;
-    updatedAt?: string | undefined;
-};
+      }
+    | undefined;
+  createdAt: string;
+  updatedAt?: string | undefined;
+};

package/bin/src/cli/templates/bensdk-lib/types/action.types.ts

@@ -1,11 +1,13 @@
-import { ActionBase } from "./action-base.type"
-import { ActionBaseDeduction } from "./base-deduction.type"
-import { ActionBaseRecharge } from "./base-recharge.type"
-import { ActionBaseGrantRevoke } from "./grant-revoke.type"
+import { ActionBase } from './action-base.type';
+import { ActionBaseDeduction } from './base-deduction.type';
+import { ActionBaseDependent } from './base-dependent.type';
+import { ActionBaseRecharge } from './base-recharge.type';
+import { ActionBaseGrantRevoke } from './grant-revoke.type';
 
 export {
-    ActionBase,
-    ActionBaseDeduction,
-    ActionBaseRecharge,
-    ActionBaseGrantRevoke
-}
+  ActionBase,
+  ActionBaseDeduction,
+  ActionBaseDependent,
+  ActionBaseGrantRevoke,
+  ActionBaseRecharge
+};