@morojs/moro 1.0.0

package/dist/core/docs/openapi-generator.js

@@ -0,0 +1,413 @@
+"use strict";
+// OpenAPI Specification Generator for Moro Framework
+// Extracts route information from intelligent routing and generates OpenAPI 3.0 specs
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultSecuritySchemes = exports.OpenAPIGenerator = void 0;
+exports.generateOpenAPIFromRoutes = generateOpenAPIFromRoutes;
+const zod_to_openapi_1 = require("./zod-to-openapi");
+const logger_1 = require("../logger");
+const logger = (0, logger_1.createFrameworkLogger)("OpenAPIGenerator");
+// OpenAPI generator class
+class OpenAPIGenerator {
+    constructor(options) {
+        this.options = options;
+        this.routes = [];
+        this.schemas = new Map();
+        this.tags = new Set();
+        logger.debug("OpenAPI Generator initialized", "Initialization", {
+            includeExamples: options.includeExamples,
+            includeSchemas: options.includeSchemas,
+        });
+    }
+    // Add routes to the generator
+    addRoutes(routes) {
+        this.routes.push(...routes);
+        // Extract tags from routes
+        routes.forEach((route) => {
+            if (route.schema.tags) {
+                route.schema.tags.forEach((tag) => this.tags.add(tag));
+            }
+        });
+        logger.debug(`Added ${routes.length} routes to documentation`, "RouteAddition", {
+            totalRoutes: this.routes.length,
+            uniqueTags: this.tags.size,
+        });
+    }
+    // Generate complete OpenAPI specification
+    generate() {
+        logger.info("Generating OpenAPI specification", "Generation", {
+            routeCount: this.routes.length,
+            tagCount: this.tags.size,
+        });
+        const spec = {
+            openapi: "3.0.3",
+            info: this.options.info,
+            servers: this.options.servers || [
+                { url: "http://localhost:3000", description: "Development server" },
+            ],
+            paths: this.generatePaths(),
+            tags: this.generateTags(),
+        };
+        // Add components if schemas are included
+        if (this.options.includeSchemas && this.schemas.size > 0) {
+            spec.components = {
+                schemas: Object.fromEntries(this.schemas),
+                securitySchemes: this.options.securitySchemes,
+            };
+        }
+        logger.info("OpenAPI specification generated successfully", "Generation", {
+            pathCount: Object.keys(spec.paths).length,
+            schemaCount: this.schemas.size,
+            tagCount: spec.tags?.length || 0,
+        });
+        return spec;
+    }
+    // Generate paths from routes
+    generatePaths() {
+        const paths = {};
+        for (const route of this.routes) {
+            const path = this.convertPathToOpenAPI(route.schema.path);
+            const method = route.schema.method.toLowerCase();
+            if (!paths[path]) {
+                paths[path] = {};
+            }
+            paths[path][method] = this.generateOperation(route.schema);
+        }
+        return paths;
+    }
+    // Generate OpenAPI operation from route schema
+    generateOperation(route) {
+        const operation = {
+            summary: route.description || `${route.method} ${route.path}`,
+            description: route.description,
+            tags: route.tags,
+            responses: this.generateResponses(route),
+        };
+        // Add parameters (query and path)
+        const parameters = this.generateParameters(route);
+        if (parameters.length > 0) {
+            operation.parameters = parameters;
+        }
+        // Add request body (for POST, PUT, PATCH)
+        if (["POST", "PUT", "PATCH"].includes(route.method) &&
+            route.validation?.body) {
+            operation.requestBody = this.generateRequestBody(route);
+        }
+        // Add security if auth is required
+        if (route.auth) {
+            operation.security = this.generateSecurity(route);
+        }
+        return operation;
+    }
+    // Generate parameters from validation schemas
+    generateParameters(route) {
+        const parameters = [];
+        // Path parameters
+        if (route.validation?.params) {
+            const paramSchema = (0, zod_to_openapi_1.zodToOpenAPI)(route.validation.params, this.options);
+            if (paramSchema.properties) {
+                for (const [name, schema] of Object.entries(paramSchema.properties)) {
+                    parameters.push({
+                        name,
+                        in: "path",
+                        required: true,
+                        schema,
+                        description: schema.description,
+                        example: this.options.includeExamples ? schema.example : undefined,
+                    });
+                }
+            }
+        }
+        // Query parameters
+        if (route.validation?.query) {
+            const querySchema = (0, zod_to_openapi_1.zodToOpenAPI)(route.validation.query, this.options);
+            if (querySchema.properties) {
+                for (const [name, schema] of Object.entries(querySchema.properties)) {
+                    const isRequired = querySchema.required?.includes(name) || false;
+                    parameters.push({
+                        name,
+                        in: "query",
+                        required: isRequired,
+                        schema,
+                        description: schema.description,
+                        example: this.options.includeExamples ? schema.example : undefined,
+                    });
+                }
+            }
+        }
+        // Header parameters
+        if (route.validation?.headers) {
+            const headerSchema = (0, zod_to_openapi_1.zodToOpenAPI)(route.validation.headers, this.options);
+            if (headerSchema.properties) {
+                for (const [name, schema] of Object.entries(headerSchema.properties)) {
+                    const isRequired = headerSchema.required?.includes(name) || false;
+                    parameters.push({
+                        name,
+                        in: "header",
+                        required: isRequired,
+                        schema,
+                        description: schema.description,
+                        example: this.options.includeExamples ? schema.example : undefined,
+                    });
+                }
+            }
+        }
+        return parameters;
+    }
+    // Generate request body from validation schema
+    generateRequestBody(route) {
+        if (!route.validation?.body) {
+            return {
+                description: "Request body",
+                required: true,
+                content: {
+                    "application/json": {
+                        schema: { type: "object" },
+                    },
+                },
+            };
+        }
+        const bodySchema = (0, zod_to_openapi_1.zodToOpenAPI)(route.validation.body, this.options);
+        const example = this.options.includeExamples
+            ? (0, zod_to_openapi_1.generateExampleFromSchema)(route.validation.body)
+            : undefined;
+        return {
+            description: "Request body",
+            required: true,
+            content: {
+                "application/json": {
+                    schema: bodySchema,
+                    example,
+                },
+            },
+        };
+    }
+    // Generate responses
+    generateResponses(route) {
+        const responses = {};
+        // Success response
+        responses["200"] = {
+            description: "Successful response",
+            content: {
+                "application/json": {
+                    schema: {
+                        type: "object",
+                        properties: {
+                            success: { type: "boolean", example: true },
+                            data: { type: "object", description: "Response data" },
+                            message: { type: "string", example: "Operation successful" },
+                        },
+                    },
+                },
+            },
+        };
+        // Add 201 for POST requests
+        if (route.method === "POST") {
+            responses["201"] = {
+                description: "Resource created successfully",
+                content: {
+                    "application/json": {
+                        schema: {
+                            type: "object",
+                            properties: {
+                                success: { type: "boolean", example: true },
+                                data: { type: "object", description: "Created resource" },
+                                message: {
+                                    type: "string",
+                                    example: "Resource created successfully",
+                                },
+                            },
+                        },
+                    },
+                },
+            };
+        }
+        // Validation error response
+        if (route.validation) {
+            responses["400"] = {
+                description: "Validation error",
+                content: {
+                    "application/json": {
+                        schema: {
+                            type: "object",
+                            properties: {
+                                success: { type: "boolean", example: false },
+                                error: { type: "string", example: "Validation failed" },
+                                details: {
+                                    type: "array",
+                                    items: {
+                                        type: "object",
+                                        properties: {
+                                            field: { type: "string", example: "email" },
+                                            message: {
+                                                type: "string",
+                                                example: "Invalid email address",
+                                            },
+                                            code: { type: "string", example: "invalid_format" },
+                                        },
+                                    },
+                                },
+                                requestId: { type: "string", example: "req_123456" },
+                            },
+                        },
+                    },
+                },
+            };
+        }
+        // Auth error response
+        if (route.auth) {
+            responses["401"] = {
+                description: "Authentication required",
+                content: {
+                    "application/json": {
+                        schema: {
+                            type: "object",
+                            properties: {
+                                success: { type: "boolean", example: false },
+                                error: { type: "string", example: "Authentication required" },
+                                requestId: { type: "string", example: "req_123456" },
+                            },
+                        },
+                    },
+                },
+            };
+            responses["403"] = {
+                description: "Insufficient permissions",
+                content: {
+                    "application/json": {
+                        schema: {
+                            type: "object",
+                            properties: {
+                                success: { type: "boolean", example: false },
+                                error: { type: "string", example: "Insufficient permissions" },
+                                requestId: { type: "string", example: "req_123456" },
+                            },
+                        },
+                    },
+                },
+            };
+        }
+        // Rate limit error response
+        if (route.rateLimit) {
+            responses["429"] = {
+                description: "Rate limit exceeded",
+                content: {
+                    "application/json": {
+                        schema: {
+                            type: "object",
+                            properties: {
+                                success: { type: "boolean", example: false },
+                                error: { type: "string", example: "Rate limit exceeded" },
+                                retryAfter: { type: "number", example: 60 },
+                                requestId: { type: "string", example: "req_123456" },
+                            },
+                        },
+                    },
+                },
+            };
+        }
+        // Server error response
+        responses["500"] = {
+            description: "Internal server error",
+            content: {
+                "application/json": {
+                    schema: {
+                        type: "object",
+                        properties: {
+                            success: { type: "boolean", example: false },
+                            error: { type: "string", example: "Internal server error" },
+                            requestId: { type: "string", example: "req_123456" },
+                        },
+                    },
+                },
+            },
+        };
+        return responses;
+    }
+    // Generate security requirements
+    generateSecurity(route) {
+        if (!route.auth)
+            return [];
+        const security = [];
+        // Default to bearer token if no specific scheme is defined
+        security.push({
+            bearerAuth: route.auth.roles || [],
+        });
+        return security;
+    }
+    // Generate tags
+    generateTags() {
+        return Array.from(this.tags).map((tag) => ({
+            name: tag,
+            description: `Operations related to ${tag}`,
+        }));
+    }
+    // Convert Moro path format to OpenAPI path format
+    convertPathToOpenAPI(path) {
+        // Convert :param to {param} format
+        return path.replace(/:([^/]+)/g, "{$1}");
+    }
+    // Generate JSON representation
+    generateJSON() {
+        return JSON.stringify(this.generate(), null, 2);
+    }
+    // Generate YAML representation (basic implementation)
+    generateYAML() {
+        const spec = this.generate();
+        return this.objectToYAML(spec, 0);
+    }
+    // Simple YAML converter (basic implementation)
+    objectToYAML(obj, indent = 0) {
+        const spaces = "  ".repeat(indent);
+        let yaml = "";
+        for (const [key, value] of Object.entries(obj)) {
+            if (value === null || value === undefined)
+                continue;
+            yaml += `${spaces}${key}:`;
+            if (typeof value === "object" && !Array.isArray(value)) {
+                yaml += "\n" + this.objectToYAML(value, indent + 1);
+            }
+            else if (Array.isArray(value)) {
+                yaml += "\n";
+                for (const item of value) {
+                    if (typeof item === "object") {
+                        yaml += `${spaces}  -\n` + this.objectToYAML(item, indent + 2);
+                    }
+                    else {
+                        yaml += `${spaces}  - ${item}\n`;
+                    }
+                }
+            }
+            else if (typeof value === "string") {
+                yaml += ` "${value}"\n`;
+            }
+            else {
+                yaml += ` ${value}\n`;
+            }
+        }
+        return yaml;
+    }
+}
+exports.OpenAPIGenerator = OpenAPIGenerator;
+// Convenience function to generate OpenAPI from routes
+function generateOpenAPIFromRoutes(routes, options) {
+    const generator = new OpenAPIGenerator(options);
+    generator.addRoutes(routes);
+    return generator.generate();
+}
+// Default security schemes
+exports.defaultSecuritySchemes = {
+    bearerAuth: {
+        type: "http",
+        scheme: "bearer",
+        bearerFormat: "JWT",
+        description: "Bearer token authentication",
+    },
+    apiKey: {
+        type: "apiKey",
+        in: "header",
+        name: "X-API-Key",
+        description: "API key authentication",
+    },
+};
+//# sourceMappingURL=openapi-generator.js.map

package/dist/core/docs/openapi-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-generator.js","sourceRoot":"","sources":["../../../src/core/docs/openapi-generator.ts"],"names":[],"mappings":";AAAA,qDAAqD;AACrD,sFAAsF;;;AAmjBtF,8DAOC;AAvjBD,qDAI0B;AAC1B,sCAAkD;AAElD,MAAM,MAAM,GAAG,IAAA,8BAAqB,EAAC,kBAAkB,CAAC,CAAC;AAwHzD,0BAA0B;AAC1B,MAAa,gBAAgB;IAK3B,YAAoB,OAA0B;QAA1B,YAAO,GAAP,OAAO,CAAmB;QAJtC,WAAM,GAAoB,EAAE,CAAC;QAC7B,YAAO,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC3C,SAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAG/B,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,gBAAgB,EAAE;YAC9D,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAC;IACL,CAAC;IAED,8BAA8B;IAC9B,SAAS,CAAC,MAAuB;QAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAE5B,2BAA2B;QAC3B,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACvB,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACtB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CACV,SAAS,MAAM,CAAC,MAAM,0BAA0B,EAChD,eAAe,EACf;YACE,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC/B,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;SAC3B,CACF,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,QAAQ;QACN,MAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE,YAAY,EAAE;YAC5D,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC9B,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;SACzB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAgB;YACxB,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI;gBAC/B,EAAE,GAAG,EAAE,uBAAuB,EAAE,WAAW,EAAE,oBAAoB,EAAE;aACpE;YACD,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE;YAC3B,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE;SAC1B,CAAC;QAEF,yCAAyC;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,UAAU,GAAG;gBAChB,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;gBACzC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;aAC9C,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,8CAA8C,EAAE,YAAY,EAAE;YACxE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM;YACzC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YAC9B,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC;SACjC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6BAA6B;IACrB,aAAa;QACnB,MAAM,KAAK,GAAgC,EAAE,CAAC;QAE9C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAEjD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACnB,CAAC;YAED,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+CAA+C;IACvC,iBAAiB,CAAC,KAAkB;QAC1C,MAAM,SAAS,GAAqB;YAClC,OAAO,EAAE,KAAK,CAAC,WAAW,IAAI,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,EAAE;YAC7D,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;SACzC,CAAC;QAEF,kCAAkC;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,SAAS,CAAC,UAAU,GAAG,UAAU,CAAC;QACpC,CAAC;QAED,0CAA0C;QAC1C,IACE,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YAC/C,KAAK,CAAC,UAAU,EAAE,IAAI,EACtB,CAAC;YACD,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAC1D,CAAC;QAED,mCAAmC;QACnC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,8CAA8C;IACtC,kBAAkB,CAAC,KAAkB;QAC3C,MAAM,UAAU,GAAuB,EAAE,CAAC;QAE1C,kBAAkB;QAClB,IAAI,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAC7B,MAAM,WAAW,GAAG,IAAA,6BAAY,EAAC,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACxE,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;gBAC3B,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;oBACpE,UAAU,CAAC,IAAI,CAAC;wBACd,IAAI;wBACJ,EAAE,EAAE,MAAM;wBACV,QAAQ,EAAE,IAAI;wBACd,MAAM;wBACN,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;qBACnE,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,mBAAmB;QACnB,IAAI,KAAK,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC;YAC5B,MAAM,WAAW,GAAG,IAAA,6BAAY,EAAC,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACvE,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;gBAC3B,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;oBACpE,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;oBACjE,UAAU,CAAC,IAAI,CAAC;wBACd,IAAI;wBACJ,EAAE,EAAE,OAAO;wBACX,QAAQ,EAAE,UAAU;wBACpB,MAAM;wBACN,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;qBACnE,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,oBAAoB;QACpB,IAAI,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAG,IAAA,6BAAY,EAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1E,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;gBAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;oBACrE,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;oBAClE,UAAU,CAAC,IAAI,CAAC;wBACd,IAAI;wBACJ,EAAE,EAAE,QAAQ;wBACZ,QAAQ,EAAE,UAAU;wBACpB,MAAM;wBACN,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;qBACnE,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,+CAA+C;IACvC,mBAAmB,CAAC,KAAkB;QAC5C,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;YAC5B,OAAO;gBACL,WAAW,EAAE,cAAc;gBAC3B,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC3B;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,6BAAY,EAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe;YAC1C,CAAC,CAAC,IAAA,0CAAyB,EAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;YAClD,CAAC,CAAC,SAAS,CAAC;QAEd,OAAO;YACL,WAAW,EAAE,cAAc;YAC3B,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE,UAAU;oBAClB,OAAO;iBACR;aACF;SACF,CAAC;IACJ,CAAC;IAED,qBAAqB;IACb,iBAAiB,CACvB,KAAkB;QAElB,MAAM,SAAS,GAAoC,EAAE,CAAC;QAEtD,mBAAmB;QACnB,SAAS,CAAC,KAAK,CAAC,GAAG;YACjB,WAAW,EAAE,qBAAqB;YAClC,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;4BAC3C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,EAAE;4BACtD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,sBAAsB,EAAE;yBAC7D;qBACF;iBACF;aACF;SACF,CAAC;QAEF,4BAA4B;QAC5B,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC5B,SAAS,CAAC,KAAK,CAAC,GAAG;gBACjB,WAAW,EAAE,+BAA+B;gBAC5C,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;gCAC3C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,kBAAkB,EAAE;gCACzD,OAAO,EAAE;oCACP,IAAI,EAAE,QAAQ;oCACd,OAAO,EAAE,+BAA+B;iCACzC;6BACF;yBACF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,4BAA4B;QAC5B,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrB,SAAS,CAAC,KAAK,CAAC,GAAG;gBACjB,WAAW,EAAE,kBAAkB;gBAC/B,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gCAC5C,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,EAAE;gCACvD,OAAO,EAAE;oCACP,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE;4CAC3C,OAAO,EAAE;gDACP,IAAI,EAAE,QAAQ;gDACd,OAAO,EAAE,uBAAuB;6CACjC;4CACD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE;yCACpD;qCACF;iCACF;gCACD,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE;6BACrD;yBACF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,sBAAsB;QACtB,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,SAAS,CAAC,KAAK,CAAC,GAAG;gBACjB,WAAW,EAAE,yBAAyB;gBACtC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gCAC5C,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,yBAAyB,EAAE;gCAC7D,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE;6BACrD;yBACF;qBACF;iBACF;aACF,CAAC;YAEF,SAAS,CAAC,KAAK,CAAC,GAAG;gBACjB,WAAW,EAAE,0BAA0B;gBACvC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gCAC5C,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,0BAA0B,EAAE;gCAC9D,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE;6BACrD;yBACF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,4BAA4B;QAC5B,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,SAAS,CAAC,KAAK,CAAC,GAAG;gBACjB,WAAW,EAAE,qBAAqB;gBAClC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gCAC5C,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,qBAAqB,EAAE;gCACzD,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;gCAC3C,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE;6BACrD;yBACF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,wBAAwB;QACxB,SAAS,CAAC,KAAK,CAAC,GAAG;YACjB,WAAW,EAAE,uBAAuB;YACpC,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;4BAC5C,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAuB,EAAE;4BAC3D,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE;yBACrD;qBACF;iBACF;aACF;SACF,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,iCAAiC;IACzB,gBAAgB,CAAC,KAAkB;QACzC,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC;QAE3B,MAAM,QAAQ,GAAiC,EAAE,CAAC;QAElD,2DAA2D;QAC3D,QAAQ,CAAC,IAAI,CAAC;YACZ,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;SACnC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB;IACR,YAAY;QAClB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACzC,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,yBAAyB,GAAG,EAAE;SAC5C,CAAC,CAAC,CAAC;IACN,CAAC;IAED,kDAAkD;IAC1C,oBAAoB,CAAC,IAAY;QACvC,mCAAmC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,+BAA+B;IAC/B,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,sDAAsD;IACtD,YAAY;QACV,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,+CAA+C;IACvC,YAAY,CAAC,GAAQ,EAAE,SAAiB,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,IAAI,GAAG,EAAE,CAAC;QAEd,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;gBAAE,SAAS;YAEpD,IAAI,IAAI,GAAG,MAAM,GAAG,GAAG,GAAG,CAAC;YAE3B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvD,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;YACtD,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,IAAI,IAAI,IAAI,CAAC;gBACb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC7B,IAAI,IAAI,GAAG,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;oBACjE,CAAC;yBAAM,CAAC;wBACN,IAAI,IAAI,GAAG,MAAM,OAAO,IAAI,IAAI,CAAC;oBACnC,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACrC,IAAI,IAAI,KAAK,KAAK,KAAK,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC;YACxB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7aD,4CA6aC;AAED,uDAAuD;AACvD,SAAgB,yBAAyB,CACvC,MAAuB,EACvB,OAA0B;IAE1B,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChD,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC5B,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED,2BAA2B;AACd,QAAA,sBAAsB,GAA0C;IAC3E,UAAU,EAAE;QACV,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,QAAQ;QAChB,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,6BAA6B;KAC3C;IACD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,QAAQ;QACZ,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,wBAAwB;KACtC;CACF,CAAC"}

package/dist/core/docs/simple-docs.d.ts

@@ -0,0 +1,21 @@
+import { CompiledRoute } from "../routing";
+export interface SimpleDocsOptions {
+    title?: string;
+    description?: string;
+    basePath?: string;
+}
+export declare class SimpleDocsGenerator {
+    private options;
+    private routes;
+    constructor(options?: SimpleDocsOptions);
+    addRoutes(routes: CompiledRoute[]): void;
+    generateHTML(): string;
+    private groupRoutesByTag;
+    private generateRouteDocumentation;
+    private generateRouteSection;
+    private generateValidationInfo;
+    private generateAuthInfo;
+    private generateRateLimitInfo;
+    private generateExamples;
+}
+export declare function createSimpleDocsMiddleware(routes: CompiledRoute[], options?: SimpleDocsOptions): (req: any, res: any, next: () => void) => void;