vls-openapi-generator 1.7.0 → 1.8.0

package/dist/generate-openapi.js

@@ -41,6 +41,7 @@ require("module-alias/register.js");
 const path = __importStar(require("path"));
 const util_1 = require("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');
@@ -49,9 +50,20 @@ const generateOpenAPI = async () => {
     console.info('Generating Open API documentation...');
     const args = process.argv;
     const params = {};
-    for (let i = 2; i < args.length; i += 2) {
+    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;
+        }
     }
     await (0, util_1.promisify)(child_process_1.exec)('rm -rf ./dist');
     await (0, util_1.promisify)(child_process_1.exec)('npx tsc');
@@ -121,7 +133,43 @@ 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;
+        }
+        const productionURLIndex = existingOpenAPIFile.servers.findIndex((x) => x.url.includes('production'));
+        const fetchedProductionURL = await getStackURL(partnerName, 'production');
+        if (fetchedProductionURL) {
+            existingOpenAPIFile.servers[productionURLIndex].url = fetchedProductionURL;
+        }
+    }
     await 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 cloudFormationClient = new client_cloudformation_1.CloudFormationClient();
+    const describeStacksCommand = new client_cloudformation_1.DescribeStacksCommand({
+        StackName: `${partnerName}-development`
+    });
+    const result = await cloudFormationClient.send(describeStacksCommand);
+    if (!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;
+        }
+    }
+}

package/dist/upload-openapi.js

@@ -40,7 +40,6 @@ const openapi_to_postmanv2_1 = require("openapi-to-postmanv2");
 const path = __importStar(require("path"));
 const util_1 = require("util");
 const postman_service_1 = require("./postman-service");
-const client_cloudformation_1 = require("@aws-sdk/client-cloudformation");
 const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
 const uploadOpenAPI = async () => {
     console.info('Uploading Open API documentation to Postman...');
@@ -111,36 +110,20 @@ const uploadOpenAPI = async () => {
         }
     }
     await postmanService.updateCollection(collectionID, collection);
-    const environments = (await postmanService.getAllEnvironments()).environments;
-    const stackEnvironment = environments.find((x) => x.name === stackName);
-    const cloudFormationClient = new client_cloudformation_1.CloudFormationClient();
-    const describeStacksCommand = new client_cloudformation_1.DescribeStacksCommand({
-        StackName: stackName
-    });
-    const result = await cloudFormationClient.send(describeStacksCommand);
-    if (!result.Stacks) {
+    const baseUrl = existingOpenAPIFile.servers.find((x) => x.url.includes(environment))?.url;
+    if (!baseUrl) {
         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;
-            }
-            if (!stackEnvironment) {
-                await postmanService.createEnvironment(stackName, [{ key: 'baseUrl', value: output.OutputValue }]);
-            }
-            else {
-                await postmanService.updateEnvironment(stackEnvironment.id, stackEnvironment.name, [
-                    { key: 'baseUrl', value: output.OutputValue }
-                ]);
-            }
-            break;
-        }
+    const environments = (await postmanService.getAllEnvironments()).environments;
+    const stackEnvironment = environments.find((x) => x.name === stackName);
+    if (!stackEnvironment) {
+        await postmanService.createEnvironment(stackName, [{ key: 'baseUrl', value: baseUrl }]);
+    }
+    else {
+        await postmanService.updateEnvironment(stackEnvironment.id, stackEnvironment.name, [
+            { key: 'baseUrl', value: baseUrl }
+        ]);
     }
     console.info('Open API documentation uploaded successfully');
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vls-openapi-generator",
-    "version": "1.7.0",
+    "version": "1.8.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {

package/src/generate-openapi.ts

@@ -7,6 +7,7 @@ import { promisify } from 'util';
 import { z } from 'zod';
 import { LambdaConfig, OpenAPIConfig } from './lambda-type';
 import { OpenAPI } from './openapi-type';
+import { CloudFormationClient, 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');
@@ -19,9 +20,21 @@ export const generateOpenAPI = async (): Promise<void> => {
     const args = process.argv;
     const params: Record<string, string> = {};
 
-    for (let i = 2; i < args.length; i += 2) {
+    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;
+        }
     }
 
     await promisify(exec)('rm -rf ./dist');
@@ -123,6 +136,62 @@ 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;
+        }
+
+        const productionURLIndex = existingOpenAPIFile.servers.findIndex((x) => x.url.includes('production'));
+
+        const fetchedProductionURL = await getStackURL(partnerName, 'production');
+
+        if (fetchedProductionURL) {
+            existingOpenAPIFile.servers[productionURLIndex].url = fetchedProductionURL;
+        }
+    }
+
     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 cloudFormationClient = new CloudFormationClient();
+
+    const describeStacksCommand = new DescribeStacksCommand({
+        StackName: `${partnerName}-development`
+    });
+
+    const result = await cloudFormationClient.send(describeStacksCommand);
+
+    if (!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;
+        }
+    }
+}

package/src/upload-openapi.ts

@@ -5,7 +5,6 @@ import * as path from 'path';
 import { promisify } from 'util';
 import { OpenAPI } from './openapi-type';
 import { PostmanService } from './postman-service';
-import { CloudFormationClient, DescribeStacksCommand } from '@aws-sdk/client-cloudformation';
 
 const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
 
@@ -108,19 +107,9 @@ export const uploadOpenAPI = async (): Promise<void> => {
 
     await postmanService.updateCollection(collectionID, collection);
 
-    const environments = (await postmanService.getAllEnvironments()).environments;
-
-    const stackEnvironment = environments.find((x) => x.name === stackName);
-
-    const cloudFormationClient = new CloudFormationClient();
+    const baseUrl = existingOpenAPIFile.servers.find((x) => x.url.includes(environment))?.url;
 
-    const describeStacksCommand = new DescribeStacksCommand({
-        StackName: stackName
-    });
-
-    const result = await cloudFormationClient.send(describeStacksCommand);
-
-    if (!result.Stacks) {
+    if (!baseUrl) {
         console.warn(
             `Base URL was not found with the given environment. Environment will not be updated. Given environment: ${environment}`
         );
@@ -128,30 +117,16 @@ export const uploadOpenAPI = async (): Promise<void> => {
         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;
-            }
+    const environments = (await postmanService.getAllEnvironments()).environments;
 
-            if (!stackEnvironment) {
-                await postmanService.createEnvironment(stackName, [{ key: 'baseUrl', value: output.OutputValue }]);
-            } else {
-                await postmanService.updateEnvironment(stackEnvironment.id, stackEnvironment.name, [
-                    { key: 'baseUrl', value: output.OutputValue }
-                ]);
-            }
+    const stackEnvironment = environments.find((x) => x.name === stackName);
 
-            break;
-        }
+    if (!stackEnvironment) {
+        await postmanService.createEnvironment(stackName, [{ key: 'baseUrl', value: baseUrl }]);
+    } else {
+        await postmanService.updateEnvironment(stackEnvironment.id, stackEnvironment.name, [
+            { key: 'baseUrl', value: baseUrl }
+        ]);
     }
 
     console.info('Open API documentation uploaded successfully');