vls-openapi-generator 1.9.0 → 1.10.1

package/.github/workflows/release.yaml

@@ -8,19 +8,32 @@ on:
         branches:
             - main
 
+permissions:
+    contents: write
+
 jobs:
     release:
         if: github.event_name == 'push'
-        runs-on: ubuntu-latest
+        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@v3
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
 
-            - name: Set up Node.js
-              uses: actions/setup-node@v3
+            - name: Setup Node
+              uses: actions/setup-node@v4
               with:
-                  node-version: '20'
-                  registry-url: 'https://registry.npmjs.org/'
+                  node-version: 20
+                  cache: 'npm'
+
+            - name: Set ownership
+              run: chown -R $(whoami) .
 
             - name: Install dependencies
               run: npm install
@@ -31,19 +44,22 @@ jobs:
             - name: Release with Semantic
               run: npx semantic-release
               env:
-                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_FOR_VLS }}
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN_FOR_VLS }}
 
     build:
         if: github.event_name == 'pull_request'
-        runs-on: ubuntu-latest
+        runs-on: [mb-runner]
+        container:
+            image: ubuntu:latest
         steps:
             - name: Checkout code
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
 
-            - name: Set up Node.js
-              uses: actions/setup-node@v3
+            - name: Setup Node
+              uses: actions/setup-node@v4
               with:
-                  node-version: '20'
+                  node-version: 20
+                  cache: 'npm'
 
             - name: Install dependencies
               run: npm install

package/dist/generate-openapi.js

@@ -76,25 +76,13 @@ 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(() => ({})));
-        const { LAMBDA_CONFIG } = (await Promise.resolve(`${path.join(HANDLERS_DIR, `${fileName}.js`)}`).then(s => __importStar(require(s))));
-        if (openAPIConfig.isDocumentationNeeded !== undefined && !openAPIConfig.isDocumentationNeeded) {
+        if (openAPIConfig.isDocumentationNeeded === false) {
             continue;
         }
+        const { LAMBDA_CONFIG } = (await Promise.resolve(`${path.join(HANDLERS_DIR, `${fileName}.js`)}`).then(s => __importStar(require(s))));
         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({
-            ...(eventResponseParametersSchema
-                ? { params: eventResponseParametersSchema }
-                : { params: zod_1.z.object({}) }),
-            ...(eventResponseModulesSchema
-                ? { modules: eventResponseModulesSchema }
-                : {
-                    modules: (0, zod_openapi_1.extendApi)(zod_1.z.array(zod_1.z.unknown()), {
-                        example: []
-                    })
-                }),
-            fallback: zod_1.z.boolean().default(false)
-        }), undefined, '3.0');
+        const eventResponseComponent = generateEventResponseComponent(openAPIConfig.responseType, eventResponseParametersSchema, eventResponseModulesSchema);
         const queryParameters = [];
         if (queryParametersSchema) {
             for (const key in queryParametersComponent.properties) {
@@ -195,3 +183,21 @@ async function getStackURL(partnerName, environment) {
         }
     }
 }
+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({
+            ...(eventResponseParametersSchema
+                ? { params: eventResponseParametersSchema }
+                : { params: zod_1.z.object({}) }),
+            ...(eventResponseModulesSchema
+                ? { modules: eventResponseModulesSchema }
+                : {
+                    modules: (0, zod_openapi_1.extendApi)(zod_1.z.array(zod_1.z.unknown()), {
+                        example: []
+                    })
+                }),
+            fallback: zod_1.z.boolean().default(false)
+        }), undefined, '3.0');
+    }
+    return (0, zod_openapi_1.generateSchema)(eventResponseParametersSchema ?? zod_1.z.object({}), undefined, '3.0');
+}

package/dist/lambda-type.d.ts

@@ -1,6 +1,7 @@
 export type OpenAPIConfig = {
     tags: string[];
     isDocumentationNeeded?: boolean;
+    responseType?: 'mindbehind-chat-bot-response' | 'api-response';
 };
 export type LambdaConfig = {
     api?: {

package/package.json

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

package/src/generate-openapi.ts

@@ -70,32 +70,20 @@ export const generateOpenAPI = async (): Promise<void> => {
             OPENAPI_CONFIG: OpenAPIConfig;
         };
 
+        if (openAPIConfig.isDocumentationNeeded === false) {
+            continue;
+        }
+
         const { LAMBDA_CONFIG } = (await import(path.join(HANDLERS_DIR, `${fileName}.js`))) as {
             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(
-            z.object({
-                ...(eventResponseParametersSchema
-                    ? { params: eventResponseParametersSchema }
-                    : { params: z.object({}) }),
-                ...(eventResponseModulesSchema
-                    ? { modules: eventResponseModulesSchema }
-                    : {
-                          modules: extendApi(z.array(z.unknown()), {
-                              example: []
-                          })
-                      }),
-                fallback: z.boolean().default(false)
-            }),
-            undefined,
-            '3.0'
+        const eventResponseComponent = generateEventResponseComponent(
+            openAPIConfig.responseType,
+            eventResponseParametersSchema,
+            eventResponseModulesSchema
         );
 
         const queryParameters = [];
@@ -223,3 +211,31 @@ async function getStackURL(partnerName: string, environment: 'development' | 'pr
         }
     }
 }
+
+function generateEventResponseComponent(
+    responseType: OpenAPIConfig['responseType'] = 'mindbehind-chat-bot-response',
+    eventResponseParametersSchema?: OpenApiZodAny,
+    eventResponseModulesSchema?: OpenApiZodAny
+) {
+    if (responseType === 'mindbehind-chat-bot-response') {
+        return generateSchema(
+            z.object({
+                ...(eventResponseParametersSchema
+                    ? { params: eventResponseParametersSchema }
+                    : { params: z.object({}) }),
+                ...(eventResponseModulesSchema
+                    ? { modules: eventResponseModulesSchema }
+                    : {
+                          modules: extendApi(z.array(z.unknown()), {
+                              example: []
+                          })
+                      }),
+                fallback: z.boolean().default(false)
+            }),
+            undefined,
+            '3.0'
+        );
+    }
+
+    return generateSchema(eventResponseParametersSchema ?? z.object({}), undefined, '3.0');
+}

package/src/lambda-type.ts

@@ -1,6 +1,7 @@
 export type OpenAPIConfig = {
     tags: string[];
     isDocumentationNeeded?: boolean;
+    responseType?: 'mindbehind-chat-bot-response' | 'api-response';
 };
 
 export type LambdaConfig = {