vls-openapi-generator 1.8.2 → 1.9.0

package/dist/generate-openapi.js

@@ -77,6 +77,9 @@ const generateOpenAPI = async () => {
         }
         const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
         const { LAMBDA_CONFIG } = (await Promise.resolve(`${path.join(HANDLERS_DIR, `${fileName}.js`)}`).then(s => __importStar(require(s))));
+        if (openAPIConfig.isDocumentationNeeded !== undefined && !openAPIConfig.isDocumentationNeeded) {
+            continue;
+        }
         const bodyComponent = (0, zod_openapi_1.generateSchema)(bodySchema ?? zod_1.z.never(), undefined, '3.0');
         const queryParametersComponent = (0, zod_openapi_1.generateSchema)(queryParametersSchema ?? zod_1.z.never(), undefined, '3.0');
         const eventResponseComponent = (0, zod_openapi_1.generateSchema)(zod_1.z.object({
@@ -143,6 +146,9 @@ const generateOpenAPI = async () => {
                     ? 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) {
@@ -151,18 +157,28 @@ const generateOpenAPI = async () => {
                     ? fetchedProductionURL.slice(0, -1)
                     : fetchedProductionURL;
         }
+        else {
+            existingOpenAPIFile.servers[productionURLIndex].url = 'production url';
+        }
     }
     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 stackName = `${partnerName}-${environment}`;
     const cloudFormationClient = new client_cloudformation_1.CloudFormationClient();
     const describeStacksCommand = new client_cloudformation_1.DescribeStacksCommand({
-        StackName: `${partnerName}-${environment}`
+        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;
     });
-    const result = await cloudFormationClient.send(describeStacksCommand);
-    if (!result.Stacks) {
+    if (!result || !result.Stacks) {
         console.warn(`Base URL was not found with the given environment. Environment will not be updated. Given environment: ${environment}`);
         return;
     }

package/dist/lambda-type.d.ts

@@ -1,5 +1,6 @@
 export type OpenAPIConfig = {
     tags: string[];
+    isDocumentationNeeded?: boolean;
 };
 export type LambdaConfig = {
     api?: {

package/package.json

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

package/src/generate-openapi.ts

@@ -7,7 +7,11 @@ 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';
+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');
@@ -70,6 +74,10 @@ export const generateOpenAPI = async (): Promise<void> => {
             LAMBDA_CONFIG?: LambdaConfig;
         };
 
+        if (openAPIConfig.isDocumentationNeeded !== undefined && !openAPIConfig.isDocumentationNeeded) {
+            continue;
+        }
+
         const bodyComponent = generateSchema(bodySchema ?? z.never(), undefined, '3.0');
         const queryParametersComponent = generateSchema(queryParametersSchema ?? z.never(), undefined, '3.0');
         const eventResponseComponent = generateSchema(
@@ -148,6 +156,8 @@ export const generateOpenAPI = async (): Promise<void> => {
                 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'));
@@ -159,6 +169,8 @@ export const generateOpenAPI = async (): Promise<void> => {
                 fetchedProductionURL[fetchedProductionURL.length - 1] === '/'
                     ? fetchedProductionURL.slice(0, -1)
                     : fetchedProductionURL;
+        } else {
+            existingOpenAPIFile.servers[productionURLIndex].url = 'production url';
         }
     }
 
@@ -167,15 +179,25 @@ export const generateOpenAPI = async (): Promise<void> => {
 };
 
 async function getStackURL(partnerName: string, environment: 'development' | 'production') {
+    const stackName = `${partnerName}-${environment}`;
     const cloudFormationClient = new CloudFormationClient();
 
     const describeStacksCommand = new DescribeStacksCommand({
-        StackName: `${partnerName}-${environment}`
+        StackName: stackName
     });
 
-    const result = await cloudFormationClient.send(describeStacksCommand);
+    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.Stacks) {
+    if (!result || !result.Stacks) {
         console.warn(
             `Base URL was not found with the given environment. Environment will not be updated. Given environment: ${environment}`
         );

package/src/lambda-type.ts

@@ -1,5 +1,6 @@
 export type OpenAPIConfig = {
     tags: string[];
+    isDocumentationNeeded?: boolean;
 };
 
 export type LambdaConfig = {