vls-openapi-generator 1.13.0 → 1.15.0

package/.eslintcache

@@ -0,0 +1 @@
+[{"/__w/vls-openapi-generator/vls-openapi-generator/.commitlintrc.js":"1","/__w/vls-openapi-generator/vls-openapi-generator/dist/generate-openapi.js":"2","/__w/vls-openapi-generator/vls-openapi-generator/dist/index.js":"3","/__w/vls-openapi-generator/vls-openapi-generator/dist/lambda-type.js":"4","/__w/vls-openapi-generator/vls-openapi-generator/dist/openapi-type.js":"5","/__w/vls-openapi-generator/vls-openapi-generator/dist/postman-service.js":"6","/__w/vls-openapi-generator/vls-openapi-generator/dist/upload-openapi.js":"7","/__w/vls-openapi-generator/vls-openapi-generator/eslint.config.mjs":"8","/__w/vls-openapi-generator/vls-openapi-generator/release.config.js":"9","/__w/vls-openapi-generator/vls-openapi-generator/src/generate-openapi.ts":"10","/__w/vls-openapi-generator/vls-openapi-generator/src/index.ts":"11","/__w/vls-openapi-generator/vls-openapi-generator/src/lambda-type.ts":"12","/__w/vls-openapi-generator/vls-openapi-generator/src/openapi-type.ts":"13","/__w/vls-openapi-generator/vls-openapi-generator/src/postman-service.ts":"14","/__w/vls-openapi-generator/vls-openapi-generator/src/upload-openapi.ts":"15"},{"size":103,"mtime":1764155630302,"results":"16","hashOfConfig":"17"},{"size":6644,"mtime":1764169300649,"results":"18","hashOfConfig":"17"},{"size":530,"mtime":1764169300693,"results":"19","hashOfConfig":"17"},{"size":77,"mtime":1764169300629,"results":"20","hashOfConfig":"17"},{"size":77,"mtime":1764169300637,"results":"21","hashOfConfig":"17"},{"size":3073,"mtime":1764169300665,"results":"22","hashOfConfig":"17"},{"size":5361,"mtime":1764169300693,"results":"23","hashOfConfig":"17"},{"size":1247,"mtime":1764155630302,"results":"24","hashOfConfig":"17"},{"size":401,"mtime":1764155630302,"results":"25","hashOfConfig":"17"},{"size":5552,"mtime":1764169293749,"results":"26","hashOfConfig":"27"},{"size":441,"mtime":1764155630302,"results":"28","hashOfConfig":"27"},{"size":243,"mtime":1764155630302,"results":"29","hashOfConfig":"27"},{"size":1634,"mtime":1764155630302,"results":"30","hashOfConfig":"27"},{"size":3666,"mtime":1764155630302,"results":"31","hashOfConfig":"27"},{"size":3960,"mtime":1764155630302,"results":"32","hashOfConfig":"27"},{"filePath":"33","messages":"34","suppressedMessages":"35","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"47mvrp",{"filePath":"36","messages":"37","suppressedMessages":"38","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"39","messages":"40","suppressedMessages":"41","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"42","messages":"43","suppressedMessages":"44","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"45","messages":"46","suppressedMessages":"47","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"48","messages":"49","suppressedMessages":"50","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"51","messages":"52","suppressedMessages":"53","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"54","messages":"55","suppressedMessages":"56","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"57","messages":"58","suppressedMessages":"59","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"60","messages":"61","suppressedMessages":"62","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1fhi8uz",{"filePath":"63","messages":"64","suppressedMessages":"65","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"66","messages":"67","suppressedMessages":"68","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"69","messages":"70","suppressedMessages":"71","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"72","messages":"73","suppressedMessages":"74","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"75","messages":"76","suppressedMessages":"77","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/__w/vls-openapi-generator/vls-openapi-generator/.commitlintrc.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/dist/generate-openapi.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/dist/index.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/dist/lambda-type.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/dist/openapi-type.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/dist/postman-service.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/dist/upload-openapi.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/eslint.config.mjs",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/release.config.js",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/src/generate-openapi.ts",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/src/index.ts",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/src/lambda-type.ts",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/src/openapi-type.ts",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/src/postman-service.ts",[],[],"/__w/vls-openapi-generator/vls-openapi-generator/src/upload-openapi.ts",[],[]]

package/dist/generate-openapi.js

@@ -35,51 +35,39 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateOpenAPI = void 0;
 const zod_openapi_1 = require("@anatine/zod-openapi");
-const child_process_1 = require("child_process");
-const fs_1 = require("fs");
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
 require("module-alias/register.js");
-const path = __importStar(require("path"));
-const util_1 = require("util");
+const path = __importStar(require("node:path"));
+const node_util_1 = require("node:util");
 const zod_1 = require("zod");
-const client_cloudformation_1 = require("@aws-sdk/client-cloudformation");
 const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
 const HANDLERS_DIR = path.join(process.cwd(), 'dist', 'src', 'handlers');
 const SCHEMAS_DIR = path.join(process.cwd(), 'dist', 'src', 'schemas');
 const OUTPUT_FILE = path.join(process.cwd(), 'openapi.json');
 const generateOpenAPI = async () => {
-    await (0, util_1.promisify)(child_process_1.exec)('rm -rf ./dist');
-    await (0, util_1.promisify)(child_process_1.exec)('npx tsc');
-    const handlerFiles = await fs_1.promises.readdir(HANDLERS_DIR).catch(() => []);
+    await (0, node_util_1.promisify)(node_child_process_1.exec)('rm -rf ./dist');
+    await (0, node_util_1.promisify)(node_child_process_1.exec)('npx tsc');
+    const handlerFiles = await node_fs_1.promises.readdir(HANDLERS_DIR).catch((error) => {
+        console.error(error);
+        return [];
+    });
     if (handlerFiles.length === 0) {
         console.log('No handler found in handlers folder.');
         return;
     }
     console.info('Generating Open API documentation...');
-    const args = process.argv;
-    const params = {};
-    for (let i = 2; i < args.length;) {
-        const key = args[i].replace('--', '');
-        params[key] = args[i + 1];
-        if (!params[key]) {
-            i++;
-            continue;
-        }
-        if (params[key].startsWith('--')) {
-            i++;
-            delete params[key];
-        }
-        else {
-            i += 2;
-        }
-    }
-    const existingOpenAPIFile = JSON.parse(await fs_1.promises.readFile(OPENAPI_FILE, 'utf-8'));
+    const existingOpenAPIFile = JSON.parse(await node_fs_1.promises.readFile(OPENAPI_FILE, 'utf-8'));
     existingOpenAPIFile.paths = {};
     for (const handler of handlerFiles) {
         const fileName = path.parse(handler).name;
         if (fileName.match(/^([a-z]+-)+queue-(publisher|consumer)$/)) {
             continue;
         }
-        const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
+        const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch((error) => {
+            console.error(error);
+            return {};
+        }));
         if (!openAPIConfig) {
             throw new Error(`${fileName} handler schema not found.`);
         }
@@ -94,7 +82,7 @@ const generateOpenAPI = async () => {
         if (queryParametersSchema) {
             for (const key in queryParametersComponent.properties) {
                 const properties = queryParametersComponent?.properties;
-                if (!properties || !properties[key]) {
+                if (!properties?.[key]) {
                     continue;
                 }
                 queryParameters.push({
@@ -131,65 +119,10 @@ const generateOpenAPI = async () => {
             }
         };
     }
-    const partnerName = params['partner-name'];
-    if (partnerName) {
-        const developmentURLIndex = existingOpenAPIFile.servers.findIndex((x) => x.url.includes('development'));
-        const fetchedDevelopmentURL = await getStackURL(partnerName, 'development');
-        if (fetchedDevelopmentURL) {
-            existingOpenAPIFile.servers[developmentURLIndex].url =
-                fetchedDevelopmentURL[fetchedDevelopmentURL.length - 1] === '/'
-                    ? fetchedDevelopmentURL.slice(0, -1)
-                    : fetchedDevelopmentURL;
-        }
-        else {
-            existingOpenAPIFile.servers[developmentURLIndex].url = 'development url';
-        }
-        const productionURLIndex = existingOpenAPIFile.servers.findIndex((x) => x.url.includes('production'));
-        const fetchedProductionURL = await getStackURL(partnerName, 'production');
-        if (fetchedProductionURL) {
-            existingOpenAPIFile.servers[productionURLIndex].url =
-                fetchedProductionURL[fetchedProductionURL.length - 1] === '/'
-                    ? fetchedProductionURL.slice(0, -1)
-                    : fetchedProductionURL;
-        }
-        else {
-            existingOpenAPIFile.servers[productionURLIndex].url = 'production url';
-        }
-    }
-    await fs_1.promises.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
+    await node_fs_1.promises.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
     console.info('Open API documentation generated successfully');
 };
 exports.generateOpenAPI = generateOpenAPI;
-async function getStackURL(partnerName, environment) {
-    const stackName = `${partnerName}-${environment}`;
-    const cloudFormationClient = new client_cloudformation_1.CloudFormationClient();
-    const describeStacksCommand = new client_cloudformation_1.DescribeStacksCommand({
-        StackName: stackName
-    });
-    const result = await cloudFormationClient.send(describeStacksCommand).catch((err) => {
-        if (err instanceof client_cloudformation_1.CloudFormationServiceException &&
-            err.message.includes(`Stack with id ${stackName} does not exist`)) {
-            return;
-        }
-        throw err;
-    });
-    if (!result || !result.Stacks) {
-        console.warn(`Base URL was not found with the given environment. Environment will not be updated. Given environment: ${environment}`);
-        return;
-    }
-    for (const cloudFormationStack of result.Stacks) {
-        if (!cloudFormationStack.Outputs) {
-            console.warn(`Output was not found within the given stack. Environment will not be updated. Given environment: ${environment}`);
-            return;
-        }
-        for (const output of cloudFormationStack.Outputs) {
-            if (output.OutputKey !== 'WebEndpoint' || !output.OutputValue) {
-                continue;
-            }
-            return output.OutputValue;
-        }
-    }
-}
 function generateEventResponseComponent(responseType = 'mindbehind-chat-bot-response', eventResponseParametersSchema, eventResponseModulesSchema) {
     if (responseType === 'mindbehind-chat-bot-response') {
         return (0, zod_openapi_1.generateSchema)(zod_1.z.object({

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vls-openapi-generator",
-    "version": "1.13.0",
+    "version": "1.15.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
@@ -16,7 +16,6 @@
     "description": "VLS Open API Generator",
     "dependencies": {
         "@anatine/zod-openapi": "^2.2.7",
-        "@aws-sdk/client-cloudformation": "^3.817.0",
         "axios": "^1.12.0",
         "module-alias": "^2.2.3",
         "openapi-to-postmanv2": "^4.25.0"

package/src/generate-openapi.ts

@@ -1,17 +1,12 @@
 import { extendApi, generateSchema, OpenApiZodAny } from '@anatine/zod-openapi';
-import { exec } from 'child_process';
-import { promises as fs } from 'fs';
+import { exec } from 'node:child_process';
+import { promises as fs } from 'node:fs';
 import 'module-alias/register.js';
-import * as path from 'path';
-import { promisify } from 'util';
+import * as path from 'node:path';
+import { promisify } from 'node:util';
 import { z } from 'zod';
 import { LambdaConfig, OpenAPIConfig } from './lambda-type';
 import { OpenAPI } from './openapi-type';
-import {
-    CloudFormationClient,
-    CloudFormationServiceException,
-    DescribeStacksCommand
-} from '@aws-sdk/client-cloudformation';
 
 const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
 const HANDLERS_DIR = path.join(process.cwd(), 'dist', 'src', 'handlers');
@@ -22,7 +17,11 @@ export const generateOpenAPI = async (): Promise<void> => {
     await promisify(exec)('rm -rf ./dist');
     await promisify(exec)('npx tsc');
 
-    const handlerFiles = await fs.readdir(HANDLERS_DIR).catch(() => []);
+    const handlerFiles = await fs.readdir(HANDLERS_DIR).catch((error) => {
+        console.error(error);
+
+        return [];
+    });
 
     if (handlerFiles.length === 0) {
         console.log('No handler found in handlers folder.');
@@ -32,26 +31,6 @@ export const generateOpenAPI = async (): Promise<void> => {
 
     console.info('Generating Open API documentation...');
 
-    const args = process.argv;
-    const params: Record<string, string> = {};
-
-    for (let i = 2; i < args.length; ) {
-        const key = args[i].replace('--', '');
-        params[key] = args[i + 1];
-
-        if (!params[key]) {
-            i++;
-            continue;
-        }
-
-        if (params[key].startsWith('--')) {
-            i++;
-            delete params[key];
-        } else {
-            i += 2;
-        }
-    }
-
     const existingOpenAPIFile = JSON.parse(await fs.readFile(OPENAPI_FILE, 'utf-8')) as OpenAPI;
 
     existingOpenAPIFile.paths = {};
@@ -69,7 +48,11 @@ export const generateOpenAPI = async (): Promise<void> => {
             eventResponseParametersSchema,
             eventResponseModulesSchema,
             OPENAPI_CONFIG: openAPIConfig
-        } = (await import(path.join(SCHEMAS_DIR, fileName + '.js')).catch(() => ({}))) as {
+        } = (await import(path.join(SCHEMAS_DIR, fileName + '.js')).catch((error) => {
+            console.error(error);
+
+            return {};
+        })) as {
             bodySchema?: OpenApiZodAny;
             eventResponseParametersSchema?: OpenApiZodAny;
             eventResponseModulesSchema?: OpenApiZodAny;
@@ -103,14 +86,14 @@ export const generateOpenAPI = async (): Promise<void> => {
             for (const key in queryParametersComponent.properties) {
                 const properties = queryParametersComponent?.properties;
 
-                if (!properties || !properties[key]) {
+                if (!properties?.[key]) {
                     continue;
                 }
 
                 queryParameters.push({
                     name: key,
                     in: 'query',
-                    schema: properties[key] as ReturnType<typeof generateSchema>
+                    schema: properties[key]
                 } as const);
             }
         }
@@ -143,86 +126,11 @@ export const generateOpenAPI = async (): Promise<void> => {
         };
     }
 
-    const partnerName = params['partner-name'];
-
-    if (partnerName) {
-        const developmentURLIndex = existingOpenAPIFile.servers.findIndex((x) => x.url.includes('development'));
-
-        const fetchedDevelopmentURL = await getStackURL(partnerName, 'development');
-
-        if (fetchedDevelopmentURL) {
-            existingOpenAPIFile.servers[developmentURLIndex].url =
-                fetchedDevelopmentURL[fetchedDevelopmentURL.length - 1] === '/'
-                    ? fetchedDevelopmentURL.slice(0, -1)
-                    : fetchedDevelopmentURL;
-        } else {
-            existingOpenAPIFile.servers[developmentURLIndex].url = 'development url';
-        }
-
-        const productionURLIndex = existingOpenAPIFile.servers.findIndex((x) => x.url.includes('production'));
-
-        const fetchedProductionURL = await getStackURL(partnerName, 'production');
-
-        if (fetchedProductionURL) {
-            existingOpenAPIFile.servers[productionURLIndex].url =
-                fetchedProductionURL[fetchedProductionURL.length - 1] === '/'
-                    ? fetchedProductionURL.slice(0, -1)
-                    : fetchedProductionURL;
-        } else {
-            existingOpenAPIFile.servers[productionURLIndex].url = 'production url';
-        }
-    }
-
     await fs.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
+
     console.info('Open API documentation generated successfully');
 };
 
-async function getStackURL(partnerName: string, environment: 'development' | 'production') {
-    const stackName = `${partnerName}-${environment}`;
-    const cloudFormationClient = new CloudFormationClient();
-
-    const describeStacksCommand = new DescribeStacksCommand({
-        StackName: stackName
-    });
-
-    const result = await cloudFormationClient.send(describeStacksCommand).catch((err) => {
-        if (
-            err instanceof CloudFormationServiceException &&
-            err.message.includes(`Stack with id ${stackName} does not exist`)
-        ) {
-            return;
-        }
-
-        throw err;
-    });
-
-    if (!result || !result.Stacks) {
-        console.warn(
-            `Base URL was not found with the given environment. Environment will not be updated. Given environment: ${environment}`
-        );
-
-        return;
-    }
-
-    for (const cloudFormationStack of result.Stacks) {
-        if (!cloudFormationStack.Outputs) {
-            console.warn(
-                `Output was not found within the given stack. Environment will not be updated. Given environment: ${environment}`
-            );
-
-            return;
-        }
-
-        for (const output of cloudFormationStack.Outputs) {
-            if (output.OutputKey !== 'WebEndpoint' || !output.OutputValue) {
-                continue;
-            }
-
-            return output.OutputValue;
-        }
-    }
-}
-
 function generateEventResponseComponent(
     responseType: OpenAPIConfig['responseType'] = 'mindbehind-chat-bot-response',
     eventResponseParametersSchema?: OpenApiZodAny,

package/.github/workflows/release.yaml

@@ -1,74 +0,0 @@
-name: CI/CD Pipeline
-
-on:
-    pull_request:
-        branches:
-            - main
-    push:
-        branches:
-            - main
-
-permissions:
-    contents: write
-
-jobs:
-    release:
-        if: github.event_name == 'push'
-        runs-on: [mb-runner]
-        container:
-            image: ubuntu:latest
-        steps:
-            - name: Install Git
-              run: apt-get update && apt-get -y install git
-
-            - name: Checkout code
-              uses: actions/checkout@v4
-              with:
-                  fetch-depth: 0
-
-            - name: Setup Node
-              uses: actions/setup-node@v4
-              with:
-                  node-version: 20
-                  cache: 'npm'
-
-            - name: Set ownership
-              run: chown -R $(whoami) .
-
-            - name: Install dependencies
-              run: npm install
-
-            - name: Build project
-              run: npm run build
-
-            - name: Release with Semantic
-              run: npx semantic-release
-              env:
-                  NPM_TOKEN: ${{ secrets.NPM_TOKEN_FOR_VLS }}
-
-    build:
-        if: github.event_name == 'pull_request'
-        runs-on: [mb-runner]
-        container:
-            image: ubuntu:latest
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
-
-            - name: Setup Node
-              uses: actions/setup-node@v4
-              with:
-                  node-version: 20
-                  cache: 'npm'
-
-            - name: Install dependencies
-              run: npm install
-
-            - name: Run Prettier check
-              run: npx prettier --check .
-
-            - name: Lint check
-              run: npx eslint .
-
-            - name: Build project
-              run: npm run build

package/.github/workflows/security_allinone.yml

@@ -1,23 +0,0 @@
-name: Security AllInOne
-on:
-    push:
-        branches:
-            - feature/*
-    pull_request:
-        types:
-            - opened
-            - closed
-            - ready_for_review
-jobs:
-    build:
-        runs-on:
-            group: default
-            labels: self-hosted
-        steps:
-            - name: Trigger to Insider Security
-              run: |
-                  curl -X POST -H "Content-Type: application/json" \
-                  -d '{"type": "security-allinone", "version": "v1", "repository": "${{ github.event.repository.name }}", "ref": "${{ github.head_ref || github.ref_name }}", "event_name": "${{ github.event_name }}", "event_action": "${{ github.event.action }}", "default_branch": "${{ github.event.repository.default_branch }}"}' \
-                  $INSECPROXY_HOOK
-              env:
-                  INSECPROXY_HOOK: ${{ secrets.INSECPROXY_HOOK }}