vls-openapi-generator 1.2.2 → 1.3.0

package/dist/generate-openapi.d.ts

@@ -1,2 +1,3 @@
 #!/usr/bin/env node
 import 'module-alias/register.js';
+export declare const generateOpenAPI: () => Promise<void>;

package/dist/generate-openapi.js

@@ -1,73 +1,44 @@
 #!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const zod_openapi_1 = require("@anatine/zod-openapi");
-const child_process_1 = require("child_process");
-const fs_1 = require("fs");
-require("module-alias/register.js");
-const path = __importStar(require("path"));
-const util_1 = require("util");
-const zod_1 = require("zod");
+import { extendApi, generateSchema } from '@anatine/zod-openapi';
+import { exec } from 'child_process';
+import { promises as fs } from 'fs';
+import 'module-alias/register.js';
+import * as path from 'path';
+import { promisify } from 'util';
+import { z } from 'zod';
 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 generateTemplate = async () => {
+export const generateOpenAPI = async () => {
+    const args = process.argv;
+    const params = {};
+    for (let i = 2; i < args.length; i += 2) {
+        const key = args[i].replace('--', '');
+        params[key] = args[i + 1];
+    }
     console.info('Generating Open API documentation...');
-    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);
-    const existingOpenAPIFile = JSON.parse(await fs_1.promises.readFile(OPENAPI_FILE, 'utf-8'));
+    await promisify(exec)('rm -rf ./dist');
+    await promisify(exec)('npx tsc');
+    const handlerFiles = await fs.readdir(HANDLERS_DIR);
+    const existingOpenAPIFile = JSON.parse(await fs.readFile(OPENAPI_FILE, 'utf-8'));
     for (const handler of handlerFiles) {
         const fileName = path.parse(handler).name;
-        const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await Promise.resolve(`${path.join(SCHEMAS_DIR, fileName + '.js')}`).then(s => __importStar(require(s))).catch(() => ({})));
-        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({
+        const { bodySchema, queryParametersSchema, eventResponseParametersSchema, eventResponseModulesSchema, OPENAPI_CONFIG: openAPIConfig } = (await import(path.join(SCHEMAS_DIR, fileName + '.js')).catch(() => ({})));
+        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: zod_1.z.object({}) }),
+                : { params: z.object({}) }),
             ...(eventResponseModulesSchema
                 ? { modules: eventResponseModulesSchema }
                 : {
-                    modules: (0, zod_openapi_1.extendApi)(zod_1.z.array(zod_1.z.unknown()), {
+                    modules: extendApi(z.array(z.unknown()), {
                         example: []
                     })
                 }),
-            fallback: zod_1.z.boolean().default(false)
+            fallback: z.boolean().default(false)
         }), undefined, '3.0');
         const queryParameters = [];
         if (queryParametersSchema) {
@@ -110,11 +81,5 @@ const generateTemplate = async () => {
             }
         };
     }
-    await fs_1.promises.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
+    await fs.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
 };
-generateTemplate()
-    .then(() => console.info('Open API documentation generated successfully'))
-    .catch((error) => {
-    console.error(error);
-    process.exit(1);
-});

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './lambda-type';

package/dist/index.js

@@ -0,0 +1,22 @@
+import { generateOpenAPI } from './generate-openapi';
+import { uploadOpenAPI } from './upload-openapi';
+export * from './lambda-type';
+try {
+    await generateOpenAPI();
+    console.info('Open API documentation generated successfully');
+}
+catch (error) {
+    console.error(error);
+    process.exit(1);
+}
+if (process.argv.includes('--upload')) {
+    console.info('Uploading Open API documentation to Postman...');
+    try {
+        await uploadOpenAPI();
+        console.info('Open API documentation uploaded successfully');
+    }
+    catch (error) {
+        console.error(error);
+        process.exit(1);
+    }
+}

package/dist/lambda-type.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/dist/openapi-type.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/dist/postman-service.d.ts

@@ -0,0 +1,13 @@
+import { OpenAPI } from './openapi-type';
+export declare class PostmanService {
+    private client;
+    constructor(apiKey: string);
+    getCollections: () => Promise<{
+        collections: {
+            id: string;
+            name: string;
+        }[];
+    }>;
+    deleteCollection: (collectionID: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    createCollection: (payload: OpenAPI) => Promise<import("axios").AxiosResponse<any, any>>;
+}

package/dist/postman-service.js

@@ -0,0 +1,24 @@
+import axios from 'axios';
+export class PostmanService {
+    constructor(apiKey) {
+        this.getCollections = async () => {
+            return (await this.client.get('/collections')).data;
+        };
+        this.deleteCollection = async (collectionID) => {
+            return await this.client.delete(`/collections/${collectionID}`);
+        };
+        this.createCollection = async (payload) => {
+            return await this.client.post('/import/openapi', {
+                type: 'json',
+                input: payload
+            });
+        };
+        this.client = axios.create({
+            baseURL: 'https://api.getpostman.com',
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Api-Key': apiKey
+            }
+        });
+    }
+}

package/dist/upload-openapi.d.ts

@@ -0,0 +1,2 @@
+import 'module-alias/register.js';
+export declare const uploadOpenAPI: () => Promise<void>;

package/dist/upload-openapi.js

@@ -0,0 +1,28 @@
+import { promises as fs } from 'fs';
+import 'module-alias/register.js';
+import * as path from 'path';
+import { PostmanService } from './postman-service';
+const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
+export const uploadOpenAPI = async () => {
+    const args = process.argv;
+    const params = {};
+    for (let i = 2; i < args.length; i += 2) {
+        const key = args[i].replace('--', '');
+        params[key] = args[i + 1];
+    }
+    const postmanToken = params['postman-token'];
+    const stackName = params['stack-name'];
+    if (!params['postman-token']) {
+        throw new Error('Postman token is missing.');
+    }
+    if (!params['stack-name']) {
+        throw new Error('Stack name is missing.');
+    }
+    const postmanService = new PostmanService(postmanToken);
+    const stackCollection = (await postmanService.getCollections()).collections.find((x) => x.name === stackName);
+    if (stackCollection) {
+        await postmanService.deleteCollection(stackCollection.id);
+    }
+    const existingOpenAPIFile = JSON.parse(await fs.readFile(OPENAPI_FILE, 'utf-8'));
+    await postmanService.createCollection(existingOpenAPIFile);
+};

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "vls-openapi-generator",
-    "version": "1.2.2",
-    "main": "dist/generate-template.js",
-    "types": "dist/lambda-type.d.ts",
+    "version": "1.3.0",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
     "scripts": {
         "check-format": "prettier . --check",
         "fix-format": "prettier . --write",
@@ -16,6 +16,7 @@
     "description": "VLS Open API Generator",
     "dependencies": {
         "@anatine/zod-openapi": "^2.2.7",
+        "axios": "^1.7.9",
         "module-alias": "^2.2.3"
     },
     "devDependencies": {
@@ -33,6 +34,6 @@
         "typescript-eslint": "^8.9.0"
     },
     "bin": {
-        "vls-openapi-generator": "dist/generate-openapi.js"
+        "vls-openapi-generator": "dist/index.js"
     }
 }

package/src/generate-openapi.ts

@@ -15,7 +15,15 @@ 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 generateTemplate = async (): Promise<void> => {
+export const generateOpenAPI = async (): Promise<void> => {
+    const args = process.argv;
+    const params: Record<string, string> = {};
+
+    for (let i = 2; i < args.length; i += 2) {
+        const key = args[i].replace('--', '');
+        params[key] = args[i + 1];
+    }
+
     console.info('Generating Open API documentation...');
 
     await promisify(exec)('rm -rf ./dist');
@@ -109,11 +117,3 @@ const generateTemplate = async (): Promise<void> => {
 
     await fs.writeFile(OUTPUT_FILE, JSON.stringify(existingOpenAPIFile, undefined, 4));
 };
-
-generateTemplate()
-    .then(() => console.info('Open API documentation generated successfully'))
-    .catch((error) => {
-        console.error(error);
-
-        process.exit(1);
-    });

package/src/index.ts

@@ -0,0 +1,28 @@
+import { generateOpenAPI } from './generate-openapi';
+import { uploadOpenAPI } from './upload-openapi';
+
+export * from './lambda-type';
+
+try {
+    await generateOpenAPI();
+
+    console.info('Open API documentation generated successfully');
+} catch (error) {
+    console.error(error);
+
+    process.exit(1);
+}
+
+if (process.argv.includes('--upload')) {
+    console.info('Uploading Open API documentation to Postman...');
+
+    try {
+        await uploadOpenAPI();
+
+        console.info('Open API documentation uploaded successfully');
+    } catch (error) {
+        console.error(error);
+
+        process.exit(1);
+    }
+}

package/src/postman-service.ts

@@ -0,0 +1,38 @@
+import axios, { Axios } from 'axios';
+import { OpenAPI } from './openapi-type';
+
+export class PostmanService {
+    private client: Axios;
+
+    constructor(apiKey: string) {
+        this.client = axios.create({
+            baseURL: 'https://api.getpostman.com',
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Api-Key': apiKey
+            }
+        });
+    }
+
+    public getCollections = async () => {
+        return (
+            await this.client.get<{
+                collections: {
+                    id: string;
+                    name: string;
+                }[];
+            }>('/collections')
+        ).data;
+    };
+
+    public deleteCollection = async (collectionID: string) => {
+        return await this.client.delete(`/collections/${collectionID}`);
+    };
+
+    public createCollection = async (payload: OpenAPI) => {
+        return await this.client.post('/import/openapi', {
+            type: 'json',
+            input: payload
+        });
+    };
+}

package/src/upload-openapi.ts

@@ -0,0 +1,40 @@
+import { promises as fs } from 'fs';
+import 'module-alias/register.js';
+import * as path from 'path';
+import { OpenAPI } from './openapi-type';
+import { PostmanService } from './postman-service';
+
+const OPENAPI_FILE = path.join(process.cwd(), 'openapi.json');
+
+export const uploadOpenAPI = async (): Promise<void> => {
+    const args = process.argv;
+    const params: Record<string, string> = {};
+
+    for (let i = 2; i < args.length; i += 2) {
+        const key = args[i].replace('--', '');
+        params[key] = args[i + 1];
+    }
+
+    const postmanToken = params['postman-token'];
+    const stackName = params['stack-name'];
+
+    if (!params['postman-token']) {
+        throw new Error('Postman token is missing.');
+    }
+
+    if (!params['stack-name']) {
+        throw new Error('Stack name is missing.');
+    }
+
+    const postmanService = new PostmanService(postmanToken);
+
+    const stackCollection = (await postmanService.getCollections()).collections.find((x) => x.name === stackName);
+
+    if (stackCollection) {
+        await postmanService.deleteCollection(stackCollection.id);
+    }
+
+    const existingOpenAPIFile = JSON.parse(await fs.readFile(OPENAPI_FILE, 'utf-8')) as OpenAPI;
+
+    await postmanService.createCollection(existingOpenAPIFile);
+};

package/tsconfig.json

@@ -25,9 +25,9 @@
         // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
         /* Modules */
-        "module": "commonjs" /* Specify what module code is generated. */,
+        "module": "ES2022" /* Specify what module code is generated. */,
         "rootDir": "src" /* Specify the root folder within your source files. */,
-        // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+        "moduleResolution": "node10" /* Specify how TypeScript looks up a file from a given module specifier. */,
         // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
         // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
         // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */