@hazeljs/swagger 0.3.1 → 0.4.0

package/dist/index.d.ts

@@ -5,4 +5,5 @@ export { SwaggerModule } from './swagger.module';
 export { SwaggerService, type SwaggerSpec } from './swagger.service';
 export { Swagger, ApiOperation, getSwaggerMetadata, getOperationMetadata, } from './swagger.decorator';
 export type { SwaggerOptions, SwaggerOperation, SwaggerSchema } from './swagger.types';
+export type { AutoSwaggerOptions } from './swagger.service';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EACL,OAAO,EACP,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EACL,OAAO,EACP,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGvF,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/swagger.service.d.ts

@@ -1,5 +1,11 @@
 import { SwaggerOperation, SwaggerSchema } from './swagger.types';
 import { Type } from '@hazeljs/core';
+export interface AutoSwaggerOptions {
+    title?: string;
+    description?: string;
+    version?: string;
+    autoGenerateOperations?: boolean;
+}
 export interface SwaggerSpec {
     openapi: string;
     info: {
@@ -18,6 +24,12 @@ export interface SwaggerSpec {
 }
 export declare class SwaggerService {
     private spec;
+    generateAutoSpec(moduleType: Type<unknown>, options?: AutoSwaggerOptions): SwaggerSpec;
+    private processControllerAuto;
+    private processRouteAuto;
+    private generateAutoOperation;
+    private extractPathParameters;
+    private addDefaultSchemas;
     generateSpec(controllers: Type<unknown>[]): SwaggerSpec;
     private normalizePath;
 }

package/dist/swagger.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swagger.service.d.ts","sourceRoot":"","sources":["../src/swagger.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGlE,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAErC,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACxD,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;KACxC,CAAC;IACF,IAAI,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrD;AAQD,qBACa,cAAc;IACzB,OAAO,CAAC,IAAI,CAOV;IAEF,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,WAAW;IAsGvD,OAAO,CAAC,aAAa;CAStB"}
+{"version":3,"file":"swagger.service.d.ts","sourceRoot":"","sources":["../src/swagger.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGlE,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAGrC,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACxD,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;KACxC,CAAC;IACF,IAAI,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrD;AAQD,qBACa,cAAc;IACzB,OAAO,CAAC,IAAI,CAOV;IAGF,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,WAAW;IAqCtF,OAAO,CAAC,qBAAqB;IA8B7B,OAAO,CAAC,gBAAgB;IA8BxB,OAAO,CAAC,qBAAqB;IAkG7B,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,iBAAiB;IAyCzB,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,WAAW;IAsGvD,OAAO,CAAC,aAAa;CAStB"}

package/dist/swagger.service.js

@@ -13,6 +13,7 @@ exports.SwaggerService = void 0;
 const core_1 = require("@hazeljs/core");
 const swagger_decorator_1 = require("./swagger.decorator");
 const core_2 = __importDefault(require("@hazeljs/core"));
+const core_3 = require("@hazeljs/core");
 let SwaggerService = class SwaggerService {
     constructor() {
         this.spec = {
@@ -24,6 +25,220 @@ let SwaggerService = class SwaggerService {
             },
         };
     }
+    // Auto-generate spec from module without explicit Swagger decorators
+    generateAutoSpec(moduleType, options) {
+        try {
+            core_2.default.debug('Auto-generating Swagger spec from module:', moduleType.name);
+            // Reset spec
+            this.spec = {
+                openapi: '3.0.0',
+                info: {
+                    title: options?.title || 'HazelJS API',
+                    description: options?.description || 'Auto-generated API documentation',
+                    version: options?.version || '1.0.0',
+                },
+                paths: {},
+                components: {
+                    schemas: {},
+                },
+                tags: [],
+            };
+            const controllers = (0, core_3.collectControllersFromModule)(moduleType);
+            // Process each controller
+            controllers.forEach((controller) => {
+                this.processControllerAuto(controller, options?.autoGenerateOperations !== false);
+            });
+            // Add default error schemas
+            this.addDefaultSchemas();
+            core_2.default.debug('Auto-generated Swagger specification completed');
+            return this.spec;
+        }
+        catch (error) {
+            core_2.default.error('Failed to auto-generate Swagger specification:', error);
+            throw error;
+        }
+    }
+    processControllerAuto(controller, autoGenerateOps) {
+        if (!controller)
+            return;
+        // Get controller path from metadata
+        const controllerMetadata = Reflect.getMetadata('hazel:controller', controller) || {};
+        const basePath = controllerMetadata.path || '';
+        // Get API tags from metadata
+        const apiTags = Reflect.getMetadata('hazel:api:tags', controller) || [];
+        // Add controller as a tag if not already present
+        if (!this.spec.tags)
+            this.spec.tags = [];
+        const controllerTag = {
+            name: apiTags.length > 0 ? apiTags[0] : controller.name,
+            description: `${controller.name} endpoints`,
+        };
+        if (!this.spec.tags.find((tag) => tag.name === controllerTag.name)) {
+            this.spec.tags.push(controllerTag);
+        }
+        // Get route metadata
+        const routes = Reflect.getMetadata('hazel:routes', controller) || [];
+        // Process each route
+        routes.forEach((route) => {
+            this.processRouteAuto(controller, route, basePath, controllerTag.name, autoGenerateOps);
+        });
+    }
+    processRouteAuto(controller, route, basePath, tag, autoGenerateOps) {
+        const { path, method, propertyKey } = route;
+        const fullPath = this.normalizePath(`${basePath}${path}`);
+        // Check for existing operation metadata
+        let operation = (0, swagger_decorator_1.getOperationMetadata)(controller.prototype, propertyKey);
+        // Auto-generate operation if not found and auto-generation is enabled
+        if (!operation && autoGenerateOps) {
+            operation = this.generateAutoOperation(method, propertyKey, tag, route);
+        }
+        if (!operation)
+            return;
+        // Add operation to paths
+        const pathItem = this.spec.paths[fullPath] || {};
+        pathItem[method.toLowerCase()] = {
+            ...operation,
+            tags: operation.tags || [tag],
+        };
+        this.spec.paths[fullPath] = pathItem;
+    }
+    generateAutoOperation(method, propertyKey, tag, route) {
+        const methodName = String(propertyKey);
+        const isGetMethod = method.toLowerCase() === 'get';
+        const isPostMethod = method.toLowerCase() === 'post';
+        const isPutMethod = method.toLowerCase() === 'put';
+        const isDeleteMethod = method.toLowerCase() === 'delete';
+        // Generate summary based on method name
+        let summary = '';
+        if (methodName.includes('create') || isPostMethod) {
+            summary = `Create new resource`;
+        }
+        else if (methodName.includes('update') || isPutMethod) {
+            summary = `Update resource`;
+        }
+        else if (methodName.includes('delete') || isDeleteMethod) {
+            summary = `Delete resource`;
+        }
+        else if (methodName.includes('find') || isGetMethod) {
+            summary = `Get resource(s)`;
+        }
+        else {
+            summary = `${method.toUpperCase()} ${methodName}`;
+        }
+        const operation = {
+            summary,
+            description: `Auto-generated ${method.toUpperCase()} operation`,
+            tags: [tag],
+            responses: {
+                '200': {
+                    description: 'Successful response',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'object',
+                                properties: {
+                                    data: {
+                                        type: 'object',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        };
+        // Add parameters for path variables - need to extract from the route path
+        const pathParams = this.extractPathParameters(route.path);
+        if (pathParams.length > 0) {
+            operation.parameters = pathParams.map((param) => ({
+                name: param,
+                in: 'path',
+                required: true,
+                schema: { type: 'string' },
+            }));
+        }
+        // Add request body for POST/PUT/PATCH
+        if (isPostMethod || isPutMethod) {
+            operation.requestBody = {
+                required: true,
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                        },
+                    },
+                },
+            };
+        }
+        // Add common error responses
+        if (operation.responses) {
+            operation.responses['400'] = {
+                description: 'Bad request',
+                content: {
+                    'application/json': {
+                        schema: { type: 'object' },
+                    },
+                },
+            };
+            operation.responses['500'] = {
+                description: 'Internal server error',
+                content: {
+                    'application/json': {
+                        schema: { type: 'object' },
+                    },
+                },
+            };
+        }
+        return operation;
+    }
+    extractPathParameters(path) {
+        const params = [];
+        const paramRegex = /:([^/]+)/g;
+        let match;
+        while ((match = paramRegex.exec(path)) !== null) {
+            params.push(match[1]);
+        }
+        return params;
+    }
+    addDefaultSchemas() {
+        // Add common error schemas
+        this.spec.components.schemas.Error = {
+            type: 'object',
+            properties: {
+                error: {
+                    type: 'object',
+                    properties: {
+                        message: { type: 'string' },
+                        statusCode: { type: 'number' },
+                        timestamp: { type: 'string', format: 'date-time' },
+                    },
+                },
+            },
+        };
+        this.spec.components.schemas.ValidationError = {
+            type: 'object',
+            properties: {
+                error: {
+                    type: 'object',
+                    properties: {
+                        message: { type: 'string' },
+                        statusCode: { type: 'number' },
+                        timestamp: { type: 'string', format: 'date-time' },
+                        errors: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    field: { type: 'string' },
+                                    message: { type: 'string' },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        };
+    }
     generateSpec(controllers) {
         try {
             if (!Array.isArray(controllers)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hazeljs/swagger",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Swagger/OpenAPI documentation module for HazelJS framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -51,5 +51,5 @@
   "peerDependencies": {
     "@hazeljs/core": ">=0.2.0-beta.0"
   },
-  "gitHead": "db6df492988e5d7b03253a98977c71c7a4540e1c"
+  "gitHead": "3cde5425a60eed497a777795724c93a926c69155"
 }