jszy-swagger-doc-generator 1.1.0

package/dist/cli.js

@@ -0,0 +1,154 @@
+#!/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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const fs = __importStar(require("fs"));
+const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+    .usage('Usage: $0 [options]')
+    .option('url', {
+    alias: 'u',
+    describe: 'URL to the Swagger JSON file',
+    type: 'string'
+})
+    .option('input', {
+    alias: 'i',
+    describe: 'Path to the local Swagger JSON file',
+    type: 'string'
+})
+    .option('output', {
+    alias: 'o',
+    describe: 'Output path for the generated documentation (default: ./generated/docs/api-documentation.md)',
+    type: 'string',
+    default: './generated/docs/api-documentation.md'
+})
+    .option('generate-types', {
+    describe: 'Generate TypeScript type definitions',
+    type: 'boolean',
+    default: false
+})
+    .option('generate-hooks', {
+    describe: 'Generate React hooks',
+    type: 'boolean',
+    default: false
+})
+    .option('types-output', {
+    describe: 'Output directory for TypeScript types (default: ./generated/types)',
+    type: 'string',
+    default: './generated/types'
+})
+    .option('hooks-output', {
+    describe: 'Output directory for React hooks (default: ./generated/hooks)',
+    type: 'string',
+    default: './generated/hooks'
+})
+    .check((argv) => {
+    if (!argv.url && !argv.input) {
+        throw new Error('Either --url or --input must be provided');
+    }
+    if (argv.url && argv.input) {
+        throw new Error('Only one of --url or --input can be provided');
+    }
+    return true;
+})
+    .help()
+    .parseSync();
+async function run() {
+    try {
+        // Create the generated directory if it doesn't exist
+        const generatedDir = './generated';
+        if (!fs.existsSync(generatedDir)) {
+            fs.mkdirSync(generatedDir, { recursive: true });
+            console.log(`Created directory: ${generatedDir}`);
+        }
+        const generator = new index_1.SwaggerDocGenerator();
+        let swaggerDoc;
+        if (argv.url) {
+            console.log(`Fetching Swagger JSON from: ${argv.url}`);
+            swaggerDoc = await generator.fetchSwaggerJSON(argv.url);
+        }
+        else if (argv.input) {
+            console.log(`Loading Swagger JSON from: ${argv.input}`);
+            if (!fs.existsSync(argv.input)) {
+                throw new Error(`Input file does not exist: ${argv.input}`);
+            }
+            swaggerDoc = generator.loadSwaggerFromFile(argv.input);
+        }
+        // This shouldn't happen due to the validation check, but TypeScript doesn't know that
+        if (!swaggerDoc) {
+            throw new Error('No swagger document loaded');
+        }
+        // Check if we need to generate types
+        if (argv.generateTypes) {
+            console.log('Generating TypeScript type definitions...');
+            const types = generator.generateTypeDefinitions(swaggerDoc);
+            const typesOutputPath = argv.typesOutput.endsWith('.ts') ? argv.typesOutput :
+                `${argv.typesOutput}/${swaggerDoc.info.title.replace(/\s+/g, '_')}_types.ts`;
+            generator.saveTypesToFile(types, typesOutputPath);
+            console.log(`Type definitions generated successfully at: ${typesOutputPath}`);
+        }
+        // Check if we need to generate hooks
+        if (argv.generateHooks) {
+            console.log('Generating React hooks...');
+            const hooksByTag = generator.generateReactHooks(swaggerDoc);
+            generator.saveHooksByTag(hooksByTag, argv.hooksOutput);
+            console.log(`React hooks generated successfully in: ${argv.hooksOutput}/`);
+        }
+        // Generate documentation if not generating types or hooks (for backward compatibility)
+        if (!argv.generateTypes && !argv.generateHooks) {
+            console.log('Generating documentation...');
+            const documentation = generator.generateDocumentation(swaggerDoc);
+            generator.saveDocumentationToFile(documentation, argv.output);
+            console.log(`Documentation generated successfully at: ${argv.output}`);
+        }
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            console.error('Error:', error.message);
+        }
+        else {
+            console.error('Error:', String(error));
+        }
+        process.exit(1);
+    }
+}
+// Run the CLI
+run();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,mCAA0D;AAC1D,kDAA0B;AAC1B,2CAAwC;AACxC,uCAAyB;AAEzB,MAAM,IAAI,GAAG,IAAA,eAAK,EAAC,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACtC,KAAK,CAAC,qBAAqB,CAAC;KAC5B,MAAM,CAAC,KAAK,EAAE;IACb,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,8BAA8B;IACxC,IAAI,EAAE,QAAQ;CACf,CAAC;KACD,MAAM,CAAC,OAAO,EAAE;IACf,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,qCAAqC;IAC/C,IAAI,EAAE,QAAQ;CACf,CAAC;KACD,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,8FAA8F;IACxG,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,uCAAuC;CACjD,CAAC;KACD,MAAM,CAAC,gBAAgB,EAAE;IACxB,QAAQ,EAAE,sCAAsC;IAChD,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;CACf,CAAC;KACD,MAAM,CAAC,gBAAgB,EAAE;IACxB,QAAQ,EAAE,sBAAsB;IAChC,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;CACf,CAAC;KACD,MAAM,CAAC,cAAc,EAAE;IACtB,QAAQ,EAAE,oEAAoE;IAC9E,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,mBAAmB;CAC7B,CAAC;KACD,MAAM,CAAC,cAAc,EAAE;IACtB,QAAQ,EAAE,+DAA+D;IACzE,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,mBAAmB;CAC7B,CAAC;KACD,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;IACd,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;KACD,IAAI,EAAE;KACN,SAAS,EAAE,CAAC;AAEf,KAAK,UAAU,GAAG;IAChB,IAAI,CAAC;QACH,qDAAqD;QACrD,MAAM,YAAY,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YACjC,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAChD,OAAO,CAAC,GAAG,CAAC,sBAAsB,YAAY,EAAE,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,2BAAmB,EAAE,CAAC;QAC5C,IAAI,UAAkC,CAAC;QAEvC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,+BAA+B,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YACvD,UAAU,GAAG,MAAM,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1D,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,CAAC,8BAA8B,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;YACxD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;YAC9D,CAAC;YACD,UAAU,GAAG,SAAS,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzD,CAAC;QAED,sFAAsF;QACtF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QAED,qCAAqC;QACrC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;YACzD,MAAM,KAAK,GAAG,SAAS,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;YAC5D,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACrD,GAAG,IAAI,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,WAAW,CAAC;YACrG,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,+CAA+C,eAAe,EAAE,CAAC,CAAC;QAChF,CAAC;QAED,qCAAqC;QACrC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;YACzC,MAAM,UAAU,GAAG,SAAS,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YAC5D,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACvD,OAAO,CAAC,GAAG,CAAC,0CAA0C,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;QAC7E,CAAC;QAED,uFAAuF;QACvF,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YAC/C,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;YAC3C,MAAM,aAAa,GAAG,SAAS,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;YAClE,SAAS,CAAC,uBAAuB,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAC9D,OAAO,CAAC,GAAG,CAAC,4CAA4C,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,cAAc;AACd,GAAG,EAAE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,137 @@
+export interface SwaggerDoc {
+    swagger?: string;
+    openapi?: string;
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    paths: {
+        [key: string]: {
+            [method: string]: {
+                summary?: string;
+                description?: string;
+                tags?: string[];
+                operationId?: string;
+                parameters?: Array<{
+                    name: string;
+                    in: string;
+                    description?: string;
+                    required?: boolean;
+                    schema?: {
+                        type?: string;
+                        format?: string;
+                        enum?: string[];
+                        $ref?: string;
+                        items?: any;
+                        [key: string]: any;
+                    };
+                }>;
+                requestBody?: {
+                    content: {
+                        [contentType: string]: {
+                            schema: any;
+                            example?: any;
+                        };
+                    };
+                };
+                responses: {
+                    [statusCode: string]: {
+                        description: string;
+                        content?: {
+                            [contentType: string]: {
+                                schema: any;
+                                example?: any;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components?: {
+        schemas: {
+            [key: string]: any;
+        };
+    };
+}
+export interface Parameter {
+    name: string;
+    in: string;
+    description?: string;
+    required?: boolean;
+    schema?: {
+        type?: string;
+        format?: string;
+        enum?: string[];
+        $ref?: string;
+        items?: any;
+        [key: string]: any;
+    };
+}
+export declare class SwaggerDocGenerator {
+    /**
+     * Fetches the Swagger/OpenAPI JSON from a given URL
+     */
+    fetchSwaggerJSON(url: string): Promise<SwaggerDoc>;
+    /**
+     * Loads Swagger JSON from a local file
+     */
+    loadSwaggerFromFile(filePath: string): SwaggerDoc;
+    /**
+     * Generates frontend documentation from the Swagger doc
+     */
+    generateDocumentation(swaggerDoc: SwaggerDoc): string;
+    /**
+     * Generates TypeScript type definitions from the schemas in Swagger doc
+     */
+    generateTypeDefinitions(swaggerDoc: SwaggerDoc): string;
+    /**
+     * Generates a single TypeScript type definition
+     */
+    generateSingleTypeDefinition(typeName: string, schema: any, allSchemas: {
+        [key: string]: any;
+    }): string;
+    /**
+     * Generates React hooks from the paths in Swagger doc
+     */
+    generateReactHooks(swaggerDoc: SwaggerDoc): Map<string, string>;
+    /**
+     * Generates header content for a specific tag
+     */
+    generateHeaderForTag(tag: string): string;
+    /**
+     * Generates a parameter interface for an API endpoint
+     */
+    generateParamInterface(path: string, method: string, endpointInfo: any, schemas: {
+        [key: string]: any;
+    }): string;
+    /**
+     * Generates a single React hook for an API endpoint with unique parameter interface
+     */
+    generateSingleHookWithUniqueName(path: string, method: string, endpointInfo: any, schemas: {
+        [key: string]: any;
+    }): string;
+    /**
+     * Generates a single React hook for an API endpoint
+     */
+    generateSingleHook(path: string, method: string, endpointInfo: any, schemas: {
+        [key: string]: any;
+    }): string;
+    /**
+     * Generate operation ID from path and method if not provided
+     */
+    generateOperationId(path: string, method: string): string;
+    /**
+     * Saves the generated documentation to a file
+     */
+    saveDocumentationToFile(documentation: string, outputPath: string): void;
+    /**
+     * Saves the generated TypeScript types to a file
+     */
+    saveTypesToFile(types: string, outputPath: string): void;
+    /**
+     * Saves the generated React hooks to files organized by tag
+     */
+    saveHooksByTag(hooksByTag: Map<string, string>, outputDir: string): void;
+}