@benup/bensdk 1.0.8 → 1.2.0

package/bin/src/cli/templates/bensdk-lib/types/grant-revoke.type.ts

@@ -1,170 +1,160 @@
 export type ActionBaseGrantRevoke = {
-    _id: string;
-    batchID?: string | undefined;
-    parentActionID?: string | undefined;
-    fingerprint?: string | undefined;
-    benefitID: string;
-    action: "GRANT" | "REVOKE";
-    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;
-        };
-        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;
+  _id: string;
+  batchID?: string | undefined;
+  parentActionID?: string | undefined;
+  fingerprint?: string | undefined;
+  benefitID: string;
+  action: 'GRANT' | 'REVOKE';
+  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;
+    };
+    employmentContract: {
+      _id: string;
+      companyID: string;
+      customerID: string;
+      accountID: 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;
+      externalCompanyID: 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;
     };
-    eligibilityOptions: {};
-    ctx?: {} | undefined;
-    log?: {} | undefined;
-    origin: string;
-    createdAt: string;
-    updatedAt?: string | undefined;
-};
+  };
+  eligibilityOptions: {};
+  ctx?: {} | undefined;
+  log?: {} | undefined;
+  origin: string;
+  createdAt: string;
+  updatedAt?: string | undefined;
+};

package/bin/src/cli/templates/bensdk-local-server/app.ts

@@ -1,48 +1,44 @@
-import { serve } from '@hono/node-server'
-import { Hono } from 'hono'
-import { WebSocketServer } from 'ws'
-import benefitsDefinition from '../../src/benefit-definition'
-import { cors } from "hono/cors";
-import pino from "pino";
-import { PassThrough } from 'stream'
-
+import { serve } from '@hono/node-server';
+import { Hono } from 'hono';
+import { cors } from 'hono/cors';
+import pino from 'pino';
+import { PassThrough } from 'stream';
+import { WebSocketServer } from 'ws';
+import benefitsDefinition from '../../src/benefit-definition';
 
 const logStream = new PassThrough();
-const logger = pino(logStream)
-const app = new Hono()
-const connections = new Set<WebSocket>()
+const logger = pino(logStream);
+const app = new Hono();
+const connections = new Set<WebSocket>();
 const onLog = (chunk: Buffer) => {
-  connections.forEach(ws => {
+  connections.forEach((ws) => {
     if (ws.readyState === WebSocket.OPEN) {
-      ws.send(chunk.toString())
+      ws.send(chunk.toString());
     }
-  })
+  });
 };
 
 logStream.on('data', onLog);
 
-
-
-app.use(
-  cors()
-);
+app.use(cors());
 
 app.get('/state-machine', async (c) => {
   const response = benefitsDefinition.stateMachine;
 
-  return c.json(response, 200)
-})
-
-
+  return c.json(response, 200);
+});
 
 app.post('/run-action', async (c) => {
-  const payload = await c.req.json()
+  const payload = await c.req.json();
   const { run, requestPayload, message, currentContext } = payload;
   const fileName = `${run.toLowerCase()}.handler.ts`;
   const fileDir = `../../src/handlers/${fileName}`;
-  const handler = await import(fileDir)
+  const handler = await import(fileDir);
 
-  const { ctxMock } = (await import('../../context.config')).createStateHandlerCtxMock(benefitsDefinition, logger)
+  const { ctxMock } = (await import('../../context.config')).createStateHandlerCtxMock(
+    benefitsDefinition,
+    logger
+  );
 
   logger.info(`Running: ${fileDir} to ${requestPayload.target.employee.name}`);
   logger.info(`Current context: ${JSON.stringify(currentContext)}`);
@@ -54,39 +50,38 @@ app.post('/run-action', async (c) => {
       ...requestPayload,
       ctx: currentContext
     },
-    ctxMock)
-  return c.json(response, 200)
-})
-
+    ctxMock
+  );
+  return c.json(response, 200);
+});
 
-
-const wss = new WebSocketServer({ noServer: true })
+const wss = new WebSocketServer({ noServer: true });
 wss.on('connection', (ws) => {
-  connections.add(ws)
+  connections.add(ws);
 
   ws.on('message', (message) => {
-    console.log('Message received:', message.toString())
-  })
+    console.log('Message received:', message.toString());
+  });
 
   ws.on('close', () => {
-    console.log('Close connection')
-    connections.delete(ws)
-  })
-})
+    console.log('Close connection');
+    connections.delete(ws);
+  });
+});
 
 export async function startServer() {
   return new Promise((res: any, rej: any) => {
-    const server = serve({ fetch: app.fetch, port: 3000 })
+    const server = serve({ fetch: app.fetch, port: 3000 });
     server.on('upgrade', (request, socket, head) => {
-      const { url } = request
+      const { url } = request;
       if (url === '/ws') {
         wss.handleUpgrade(request, socket, head, (ws) => {
-          wss.emit('connection', ws, request)
-        })
+          wss.emit('connection', ws, request);
+        });
       } else {
-        socket.destroy()
+        socket.destroy();
       }
-    })
-    res()
-  })
-};
+    });
+    res();
+  });
+}

package/bin/src/cli/templates/bensdk-viewer/.svelte-kit/tsconfig.json

@@ -1,49 +1,38 @@
 {
-	"compilerOptions": {
-		"paths": {
-			"$lib": [
-				"../src/lib"
-			],
-			"$lib/*": [
-				"../src/lib/*"
-			]
-		},
-		"rootDirs": [
-			"..",
-			"./types"
-		],
-		"verbatimModuleSyntax": true,
-		"isolatedModules": true,
-		"lib": [
-			"esnext",
-			"DOM",
-			"DOM.Iterable"
-		],
-		"moduleResolution": "bundler",
-		"module": "esnext",
-		"noEmit": true,
-		"target": "esnext"
-	},
-	"include": [
-		"ambient.d.ts",
-		"non-ambient.d.ts",
-		"./types/**/$types.d.ts",
-		"../vite.config.js",
-		"../vite.config.ts",
-		"../src/**/*.js",
-		"../src/**/*.ts",
-		"../src/**/*.svelte",
-		"../tests/**/*.js",
-		"../tests/**/*.ts",
-		"../tests/**/*.svelte"
-	],
-	"exclude": [
-		"../node_modules/**",
-		"../src/service-worker.js",
-		"../src/service-worker/**/*.js",
-		"../src/service-worker.ts",
-		"../src/service-worker/**/*.ts",
-		"../src/service-worker.d.ts",
-		"../src/service-worker/**/*.d.ts"
-	]
-}
+  "compilerOptions": {
+    "paths": {
+      "$lib": ["../src/lib"],
+      "$lib/*": ["../src/lib/*"]
+    },
+    "rootDirs": ["..", "./types"],
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "lib": ["esnext", "DOM", "DOM.Iterable"],
+    "moduleResolution": "bundler",
+    "module": "esnext",
+    "noEmit": true,
+    "target": "esnext"
+  },
+  "include": [
+    "ambient.d.ts",
+    "non-ambient.d.ts",
+    "./types/**/$types.d.ts",
+    "../vite.config.js",
+    "../vite.config.ts",
+    "../src/**/*.js",
+    "../src/**/*.ts",
+    "../src/**/*.svelte",
+    "../tests/**/*.js",
+    "../tests/**/*.ts",
+    "../tests/**/*.svelte"
+  ],
+  "exclude": [
+    "../node_modules/**",
+    "../src/service-worker.js",
+    "../src/service-worker/**/*.js",
+    "../src/service-worker.ts",
+    "../src/service-worker/**/*.ts",
+    "../src/service-worker.d.ts",
+    "../src/service-worker/**/*.d.ts"
+  ]
+}

package/bin/src/cli/templates/bensdk-viewer/src/app.d.ts

@@ -1,13 +1,13 @@
 // See https://svelte.dev/docs/kit/types#app.d.ts
 // for information about these interfaces
 declare global {
-	namespace App {
-		// interface Error {}
-		// interface Locals {}
-		// interface PageData {}
-		// interface PageState {}
-		// interface Platform {}
-	}
+  namespace App {
+    // interface Error {}
+    // interface Locals {}
+    // interface PageData {}
+    // interface PageState {}
+    // interface Platform {}
+  }
 }
 
 export {};

package/bin/src/cli/templates/bensdk-viewer/src/app.html

@@ -1,12 +1,12 @@
 <!doctype html>
 <html lang="en">
-	<head>
-		<meta charset="utf-8" />
-		<link rel="icon" href="%sveltekit.assets%/favicon.png" />
-		<meta name="viewport" content="width=device-width, initial-scale=1" />
-		%sveltekit.head%
-	</head>
-	<body data-sveltekit-preload-data="hover">
-		<div style="display: contents">%sveltekit.body%</div>
-	</body>
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%sveltekit.assets%/favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    %sveltekit.head%
+  </head>
+  <body data-sveltekit-preload-data="hover">
+    <div style="display: contents">%sveltekit.body%</div>
+  </body>
 </html>

package/bin/src/cli/templates/bensdk-viewer/src/routes/+page.svelte

@@ -34,7 +34,6 @@
       "companyID": "67d08762f7c7deeba70df761",
       "customerID": "67d08705f0de4e3d6816878c",
       "accountID": "67d0877a8e6afb996881e224",
-      "establishmentID": "67d087914daaf3ecdd941676",
       "admissionDate": "2024-01-01",
       "externalEmploymentContractID": "123",
       "position": {
@@ -61,19 +60,10 @@
       "createdAt": "2025-03-11T19:01:15.490Z",
       "isDeleted": false
     },
-    "establishment": {
-      "_id": "67d087914daaf3ecdd941676",
-      "externalEstablishmentID": "123",
-      "companyID": "67d08762f7c7deeba70df761",
-      "accountID": "67d0877a8e6afb996881e224",
-      "cnpj": "34.714.870/0000-63",
-      "businessName": "businessName",
-      "tradeName": "tradeName",
-      "createdAt": "2025-03-11T19:01:15.490Z"
-    },
     "company": {
       "_id": "67d08762f7c7deeba70df761",
       "accountID": "67d0877a8e6afb996881e224",
+      "externalCompanyID": "123",
       "cnpj": "34.714.870/0000-63",
       "businessName": "businessName",
       "tradeName": "tradeName",
@@ -412,7 +402,6 @@
       'target.employmentContract.companyID': 'Company identifier',
       'target.employmentContract.customerID': 'Customer identifier',
       'target.employmentContract.accountID': 'Account identifier',
-      'target.employmentContract.establishmentID': 'Establishment identifier',
       'target.employmentContract.admissionDate': 'Admission date',
       'target.employmentContract.externalEmploymentContractID': 'External contract identifier',
       'target.employmentContract.position': 'Position information',
@@ -424,16 +413,9 @@
       'target.employmentContract.fingerprint': 'Contract fingerprint',
       'target.employmentContract.createdAt': 'Creation timestamp',
       'target.employmentContract.isDeleted': 'Deletion status',
-      'target.establishment._id': 'Establishment unique identifier',
-      'target.establishment.externalEstablishmentID': 'External establishment identifier',
-      'target.establishment.companyID': 'Company identifier',
-      'target.establishment.accountID': 'Account identifier',
-      'target.establishment.cnpj': 'Establishment CNPJ',
-      'target.establishment.businessName': 'Business name',
-      'target.establishment.tradeName': 'Trade name',
-      'target.establishment.createdAt': 'Creation timestamp',
       'target.company._id': 'Company unique identifier',
       'target.company.accountID': 'Account identifier',
+      'target.company.externalCompanyID': 'External company identifier',
       'target.company.cnpj': 'Company CNPJ',
       'target.company.businessName': 'Business name',
       'target.company.tradeName': 'Trade name',

package/bin/src/cli/templates/bensdk-viewer/startup.ts

@@ -1,7 +1,7 @@
 //@ts-nocheck
+import open from 'open';
 import { preview } from 'vite';
-import open from 'open'
-import {startServer} from '../server/app';
+import { startServer } from '../server/app';
 
 (async () => {
   await startServer();
@@ -9,6 +9,5 @@ import {startServer} from '../server/app';
   const view = await preview();
   const url = view.resolvedUrls!.local[0];
   console.log('\x1b[1m%s\x1b[0m %s', 'benSDK developer tools:', url);
-  await open(url); 
-
-})();
+  await open(url);
+})();