vls-openapi-generator 1.12.0 → 1.14.0

package/dist/generate-openapi.js

@@ -35,44 +35,26 @@ 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(() => []);
     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;
@@ -80,6 +62,9 @@ const generateOpenAPI = async () => {
             continue;
         }
         const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
+        if (!openAPIConfig) {
+            throw new Error(`${fileName} handler schema not found.`);
+        }
         if (openAPIConfig.isDocumentationNeeded === false) {
             continue;
         }
@@ -91,7 +76,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({
@@ -128,65 +113,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.12.0",
+    "version": "1.14.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');
@@ -32,26 +27,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 = {};
@@ -77,6 +52,10 @@ export const generateOpenAPI = async (): Promise<void> => {
             OPENAPI_CONFIG: OpenAPIConfig;
         };
 
+        if (!openAPIConfig) {
+            throw new Error(`${fileName} handler schema not found.`);
+        }
+
         if (openAPIConfig.isDocumentationNeeded === false) {
             continue;
         }
@@ -99,14 +78,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);
             }
         }
@@ -139,86 +118,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,