@benup/bensdk 1.6.2 → 1.8.0

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

@@ -1,6 +1,8 @@
 import fs from 'fs';
+import { promises as fsPromises } from 'fs';
 import { initialStates } from './lib/state-machine';
 import { validateBenefitDefinition } from './validate';
+import inquirer from 'inquirer';
 
 async function main() {
   const benefitDefinition = (await import(`${process.cwd()}/src/benefit-definition.ts`)).default;
@@ -24,32 +26,31 @@ async function main() {
       {} as Record<string, string[]>
     );
 
-  Object.keys(stateMachines).forEach((action) => {
+  for (const action of Object.keys(stateMachines)) {
     const states = stateMachines[action];
 
-    states.forEach((state) => {
+    for (const state of states) {
       if (initialStates.includes(state)) {
-        return;
+        continue;
       }
 
       const fileName = `${state.toLocaleLowerCase()}.handler.ts`;
       let stateHandler = stateHandlerTemplate;
-      const actionSize = action
-      .split('_')
+      const actionSize = action.split('_');
       let actionInCamelCase = '';
-      if(actionSize.length === 1){
-        actionInCamelCase = action.split('')
-        .map((word, index) => index === 0 ? word.toUpperCase() : word.toLowerCase())
-        .join('');
+      if (actionSize.length === 1) {
+        actionInCamelCase = action
+          .split('')
+          .map((word, index) => (index === 0 ? word.toUpperCase() : word.toLowerCase()))
+          .join('');
       } else {
         actionInCamelCase = action
-        .split('_')[1]
-        .split('')
-        .map((word, index) => index === 0 ? word.toUpperCase() : word.toLowerCase())
-        .join('');
+          .split('_')[1]
+          .split('')
+          .map((word, index) => (index === 0 ? word.toUpperCase() : word.toLowerCase()))
+          .join('');
       }
 
-
       stateHandler = stateHandler.replace(
         '// StateMachine,',
         `const stateMachine = benefitDefinition.stateMachine.${action}.${state};  `
@@ -60,13 +61,13 @@ async function main() {
         `import benefitDefinition from '../benefit-definition';`
       );
 
-      if(action === 'GRANT' || action === 'REVOKE'){
+      if (action === 'GRANT' || action === 'REVOKE') {
         stateHandler = stateHandler.replace(
           '// import {Action}',
           `import { ActionBaseGrantRevoke as Action} from '@benup/bensdk/bin/lib/types/action.types'`
         );
       } else {
-      stateHandler = stateHandler.replace(
+        stateHandler = stateHandler.replace(
           '// import {Action}',
           `import { ActionBase${actionInCamelCase} as Action} from '@benup/bensdk/bin/lib/types/action.types'`
         );
@@ -86,9 +87,81 @@ async function main() {
       if (!fs.existsSync(handlersDir)) {
         fs.mkdirSync(handlersDir, { recursive: true });
       }
-      fs.writeFileSync(`${handlersDir}/${fileName}`, stateHandler, 'utf-8');
-    });
-  });
+
+      if (!fs.existsSync(`${handlersDir}/${fileName}`)) {
+        await fsPromises.writeFile(`${handlersDir}/${fileName}`, stateHandler, 'utf-8');
+      } else {
+        const answer = await inquirer.prompt({
+          type: 'list',
+          name: 'overwrite',
+          message: `The file ${fileName} already exists. Do you want to overwrite it?`,
+          choices: ['overwrite', 'skip']
+        });
+
+        if (answer.overwrite === 'overwrite') {
+          await fsPromises.writeFile(`${handlersDir}/${fileName}`, stateHandler, 'utf-8');
+        }
+      }
+    }
+
+    const testsDir = `${process.cwd()}/__tests__`;
+
+    if (!fs.existsSync(testsDir)) {
+      fs.mkdirSync(testsDir, { recursive: true });
+    }
+
+    // Read the action test template
+    let actionTestTemplate = await fsPromises.readFile(
+      process.cwd() + '/bin/cli/templates/action.test.template.ts',
+      'utf-8'
+    );
+
+    // Replaces the action placeholder with the current action name
+    actionTestTemplate = actionTestTemplate.replaceAll('CHANGE_ACTION_NAME_PLACEHOLDER', action);
+
+    const testFileName = `${action.toLowerCase()}.test.ts`;
+    if (!fs.existsSync(`${testsDir}/${testFileName}`)) {
+      await fsPromises.writeFile(`${testsDir}/${testFileName}`, actionTestTemplate, 'utf-8');
+    } else {
+      const answer = await inquirer.prompt({
+        type: 'list',
+        name: 'overwrite',
+        message: `The test file ${testFileName} already exists. Do you want to overwrite it?`,
+        choices: ['overwrite', 'skip']
+      });
+
+      if (answer.overwrite === 'overwrite') {
+        await fsPromises.writeFile(`${testsDir}/${testFileName}`, actionTestTemplate, 'utf-8');
+      }
+    }
+
+    /**
+     * Creates the utils.ts for the tests if it doesn't exists
+     */
+    if (!fs.existsSync(`${testsDir}/utils.ts`)) {
+      const utilsTestTemplate = await fsPromises.readFile(
+        process.cwd() + '/bin/cli/templates/utils.template.ts',
+        'utf-8'
+      );
+
+      await fsPromises.writeFile(`${testsDir}/utils.ts`, utilsTestTemplate, 'utf-8');
+    } else {
+      const answer = await inquirer.prompt({
+        type: 'list',
+        name: 'overwrite',
+        message: `The utils.ts file already exists. Do you want to overwrite it?`,
+        choices: ['overwrite', 'skip']
+      });
+
+      if (answer.overwrite === 'overwrite') {
+        const utilsTestTemplate = await fsPromises.readFile(
+          process.cwd() + '/bin/cli/templates/utils.template.ts',
+          'utf-8'
+        );
+        await fsPromises.writeFile(`${testsDir}/utils.ts`, utilsTestTemplate, 'utf-8');
+      }
+    }
+  }
 }
 
 main();

package/bin/src/cli/templates/bensdk-cli/templates/action.test.template.ts

@@ -0,0 +1,34 @@
+import { describe, expect, it } from 'vitest';
+import { app } from '../bin/server/app';
+import { getUrl } from './utils';
+
+/**
+ * Write your state-machine actions tests here!
+ * How to do that? This is the test-suite for CHANGE_ACTION_NAME_PLACEHOLDER, We recommend that
+ * for each state from the action you write the possible scenarios
+ */
+describe('SM Tests for CHANGE_ACTION_NAME_PLACEHOLDER', () => {
+  const action = 'CHANGE_ACTION_NAME_PLACEHOLDER';
+
+  it('[REQUEST_CHANGE_ACTION_NAME_PLACEHOLDER] should fail and return 500 for invalid payload', async () => {
+    const res = await app.request(`${getUrl()}`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+
+      /**
+       * We recommend you to create an utils or some method that create this payload
+       */
+      body: JSON.stringify({
+        message: {},
+        requestPayload: {
+          action: 'CHANGE_ACTION_NAME_PLACEHOLDER'
+        },
+        currentContext: {}
+      })
+    });
+
+    const data = await res.text();
+
+    expect(res.status).toBe(500);
+  });
+});

package/bin/src/cli/templates/bensdk-cli/templates/utils.template.ts

@@ -0,0 +1 @@
+export const getUrl = () => 'http://localhost:3000/run-action';

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

@@ -69,7 +69,7 @@ wss.on('connection', (ws) => {
   });
 });
 
-export async function startServer() {
+async function startServer() {
   return new Promise((res: any, rej: any) => {
     const server = serve({ fetch: app.fetch, port: 3000 });
     server.on('upgrade', (request, socket, head) => {
@@ -85,3 +85,5 @@ export async function startServer() {
     res();
   });
 }
+
+export { app, startServer };

package/bin/src/cli/templates/package.template.json

@@ -4,7 +4,7 @@
   "main": "index.js",
   "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "vitest --run",
     "format": "npx prettier --write .",
     "lint": "npx tsc --noemit && npx prettier --check . && npx eslint .",
     "start": "cd bin/viewer && tsx startup.ts",
@@ -34,7 +34,7 @@
     "pino": "^9.6.0",
     "hono": "^4.7.7",
     "@hono/node-server": "^1.14.1",
-    "vitest": "^3.1.2",
+    "vitest": "^3.2.4",
     "@sveltejs/adapter-auto": "^4.0.0",
     "@sveltejs/kit": "^2.16.0",
     "@sveltejs/vite-plugin-svelte": "^5.0.0",

package/package.json

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