@spinajs/http-swagger 2.0.470 → 2.0.472

package/lib/cjs/cli/GenerateSwaggerCache.d.ts

@@ -0,0 +1,10 @@
+import { CliCommand } from '@spinajs/cli';
+import { Log } from '@spinajs/log-common';
+import { ClassInfo } from '@spinajs/di';
+import { BaseController } from '@spinajs/http';
+export declare class SwaggerCacheCommand extends CliCommand {
+    protected Log: Log;
+    protected Controllers: Array<ClassInfo<BaseController>>;
+    execute(): Promise<void>;
+}
+//# sourceMappingURL=GenerateSwaggerCache.d.ts.map

package/lib/cjs/cli/GenerateSwaggerCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenerateSwaggerCache.d.ts","sourceRoot":"","sources":["../../../src/cli/GenerateSwaggerCache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAW,MAAM,cAAc,CAAC;AACnD,OAAO,EAAU,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAM,MAAM,aAAa,CAAC;AAG5C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/C,qBACa,mBAAoB,SAAQ,UAAU;IAEjD,SAAS,CAAC,GAAG,EAAG,GAAG,CAAC;IAGpB,SAAS,CAAC,WAAW,EAAG,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;IAE5C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAatC"}

package/lib/cjs/cli/GenerateSwaggerCache.js

@@ -0,0 +1,43 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerCacheCommand = void 0;
+const cli_1 = require("@spinajs/cli");
+const log_common_1 = require("@spinajs/log-common");
+const di_1 = require("@spinajs/di");
+const fs_1 = require("@spinajs/fs");
+const reflection_1 = require("@spinajs/reflection");
+const swagger_cache_js_1 = require("../swagger-cache.js");
+let SwaggerCacheCommand = class SwaggerCacheCommand extends cli_1.CliCommand {
+    async execute() {
+        await di_1.DI.resolve(fs_1.fsService);
+        this.Log.info('Generating Swagger documentation cache...');
+        const cache = await di_1.DI.resolve(swagger_cache_js_1.SwaggerDocCache);
+        for (const controller of this.Controllers) {
+            this.Log.info(`Processing controller: ${controller.name}`);
+            await cache.getCache(controller);
+        }
+        this.Log.info('Swagger cache generation complete.');
+    }
+};
+exports.SwaggerCacheCommand = SwaggerCacheCommand;
+__decorate([
+    (0, log_common_1.Logger)('http-swagger'),
+    __metadata("design:type", log_common_1.Log)
+], SwaggerCacheCommand.prototype, "Log", void 0);
+__decorate([
+    (0, reflection_1.ListFromFiles)('/**/!(*.d).{ts,js}', 'system.dirs.controllers'),
+    __metadata("design:type", Array)
+], SwaggerCacheCommand.prototype, "Controllers", void 0);
+exports.SwaggerCacheCommand = SwaggerCacheCommand = __decorate([
+    (0, cli_1.Command)('http:swagger:cache', 'generate swagger documentation cache from controller JSDoc comments')
+], SwaggerCacheCommand);
+//# sourceMappingURL=GenerateSwaggerCache.js.map

package/lib/cjs/cli/GenerateSwaggerCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenerateSwaggerCache.js","sourceRoot":"","sources":["../../../src/cli/GenerateSwaggerCache.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sCAAmD;AACnD,oDAAkD;AAClD,oCAA4C;AAC5C,oCAAwC;AACxC,oDAAoD;AAEpD,0DAAsD;AAG/C,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,gBAAU;IAO1C,KAAK,CAAC,OAAO;QAClB,MAAM,OAAE,CAAC,OAAO,CAAC,cAAS,CAAC,CAAC;QAE5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,MAAM,OAAE,CAAC,OAAO,CAAC,kCAAe,CAAC,CAAC;QAEhD,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3D,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IACtD,CAAC;CACF,CAAA;AApBY,kDAAmB;AAEpB;IADT,IAAA,mBAAM,EAAC,cAAc,CAAC;8BACP,gBAAG;gDAAC;AAGV;IADT,IAAA,0BAAa,EAAC,oBAAoB,EAAE,yBAAyB,CAAC;8BACvC,KAAK;wDAA4B;8BAL9C,mBAAmB;IAD/B,IAAA,aAAO,EAAC,oBAAoB,EAAE,qEAAqE,CAAC;GACxF,mBAAmB,CAoB/B"}

package/lib/cjs/config/http-swagger.d.ts

@@ -0,0 +1,42 @@
+import { ConfigVar } from '@spinajs/configuration-common';
+declare const httpSwagger: {
+    system: {
+        dirs: {
+            controllers: string[];
+            cli: string[];
+        };
+    };
+    fs: {
+        providers: {
+            service: string;
+            name: string;
+            basePath: string;
+        }[];
+    };
+    http: {
+        Static: {
+            Route: string;
+            Path: string;
+        }[];
+        swagger: {
+            enabled: boolean;
+            title: string;
+            version: string;
+            description: string;
+            basePath: string;
+            servers: {
+                url: string;
+                description?: string;
+            }[];
+            ui: {
+                cssUrl: string;
+                bundleUrl: string;
+                presetUrl: string;
+                specUrl: ConfigVar;
+                pageTitle: string;
+            };
+        };
+    };
+};
+export default httpSwagger;
+//# sourceMappingURL=http-swagger.d.ts.map

package/lib/cjs/config/http-swagger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-swagger.d.ts","sourceRoot":"","sources":["../../../src/config/http-swagger.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAiB,MAAM,+BAA+B,CAAC;AA8BzE,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;qBAsCI;gBAAE,GAAG,EAAE,MAAM,CAAC;gBAAC,WAAW,CAAC,EAAE,MAAM,CAAA;aAAE,EAAE;;;;;;;;;;CAa3D,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/lib/cjs/config/http-swagger.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const fs_1 = require("fs");
+const configuration_common_1 = require("@spinajs/configuration-common");
+const di_1 = require("@spinajs/di");
+function cwd(...paths) {
+    return (0, path_1.join)(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), ...paths);
+}
+function lib(...paths) {
+    return (0, path_1.join)(cwd(), 'node_modules', '@spinajs', 'http-swagger', 'lib', ...paths);
+}
+function swaggerUiDist() {
+    let dir = cwd();
+    // Walk up the directory tree to handle hoisted packages in monorepos
+    while (true) {
+        const candidate = (0, path_1.join)(dir, 'node_modules', 'swagger-ui-dist');
+        if ((0, fs_1.existsSync)(candidate))
+            return candidate;
+        const parent = (0, path_1.dirname)(dir);
+        if (parent === dir)
+            break;
+        dir = parent;
+    }
+    throw new Error('swagger-ui-dist package not found. Please install it as a dependency.');
+}
+function dir(path) {
+    const inCommonJs = typeof module !== 'undefined';
+    return (0, path_1.resolve)((0, path_1.normalize)((0, path_1.join)(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), 'node_modules', '@spinajs', 'http-swagger', 'lib', inCommonJs ? 'cjs' : 'mjs', path)));
+}
+const httpSwagger = {
+    system: {
+        dirs: {
+            controllers: [dir('controllers')],
+            cli: [dir('cli')]
+        },
+    },
+    fs: {
+        providers: [
+            {
+                service: 'fsNative',
+                name: '__fs_swagger_views__',
+                basePath: lib('views'),
+            },
+            {
+                service: 'fsNative',
+                name: '__fs_swagger_cache__',
+                basePath: (0, path_1.join)(process.cwd(), '__cache__', '__swagger__'),
+            },
+        ],
+    },
+    http: {
+        Static: [
+            {
+                Route: '/docs/ui',
+                Path: swaggerUiDist(),
+            },
+            {
+                Route: '/docs/static',
+                Path: lib('views'),
+            },
+        ],
+        swagger: {
+            enabled: true,
+            title: 'API Documentation',
+            version: '1.0.0',
+            description: '',
+            basePath: '',
+            servers: [],
+            ui: {
+                cssUrl: '/docs/ui/swagger-ui.css',
+                bundleUrl: '/docs/ui/swagger-ui-bundle.js',
+                presetUrl: '/docs/ui/swagger-ui-standalone-preset.js',
+                specUrl: new configuration_common_1.ConfigVar(() => {
+                    const prefix = di_1.DI.get(configuration_common_1.Configuration)?.get('http.controllers.route.prefix', '');
+                    return prefix ? `/${prefix}/docs/swagger.json` : '/docs/swagger.json';
+                }),
+                pageTitle: 'API Documentation',
+            },
+        },
+    },
+};
+exports.default = httpSwagger;
+//# sourceMappingURL=http-swagger.js.map

package/lib/cjs/config/http-swagger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-swagger.js","sourceRoot":"","sources":["../../../src/config/http-swagger.ts"],"names":[],"mappings":";;AAAA,+BAAyD;AACzD,2BAAgC;AAChC,wEAAyE;AACzE,oCAAiC;AAEjC,SAAS,GAAG,CAAC,GAAG,KAAe;IAC7B,OAAO,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,GAAG,CAAC,GAAG,KAAe;IAC7B,OAAO,IAAA,WAAI,EAAC,GAAG,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC;AAClF,CAAC;AAED,SAAS,aAAa;IACpB,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;IAChB,qEAAqE;IACrE,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,SAAS,GAAG,IAAA,WAAI,EAAC,GAAG,EAAE,cAAc,EAAE,iBAAiB,CAAC,CAAC;QAC/D,IAAI,IAAA,eAAU,EAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,MAAM,GAAG,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,MAAM,KAAK,GAAG;YAAE,MAAM;QAC1B,GAAG,GAAG,MAAM,CAAC;IACf,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;AAC3F,CAAC;AAED,SAAS,GAAG,CAAC,IAAY;IACvB,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC;IACjD,OAAO,IAAA,cAAO,EAAC,IAAA,gBAAS,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACzK,CAAC;AAGD,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,WAAW,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACjC,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SAClB;KACF;IACD,EAAE,EAAE;QACF,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,UAAU;gBACnB,IAAI,EAAE,sBAAsB;gBAC5B,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC;aACvB;YACD;gBACE,OAAO,EAAE,UAAU;gBACnB,IAAI,EAAE,sBAAsB;gBAC5B,QAAQ,EAAE,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,aAAa,CAAC;aAC1D;SACF;KACF;IACD,IAAI,EAAE;QACJ,MAAM,EAAE;YACN;gBACE,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,aAAa,EAAE;aACtB;YACD;gBACE,KAAK,EAAE,cAAc;gBACrB,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC;aACnB;SACF;QACD,OAAO,EAAE;YACP,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,mBAAmB;YAC1B,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,EAAE;YACf,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,EAA6C;YACtD,EAAE,EAAE;gBACF,MAAM,EAAE,yBAAyB;gBACjC,SAAS,EAAE,+BAA+B;gBAC1C,SAAS,EAAE,0CAA0C;gBACrD,OAAO,EAAE,IAAI,gCAAS,CAAC,GAAG,EAAE;oBAC1B,MAAM,MAAM,GAAG,OAAE,CAAC,GAAG,CAAgB,oCAAa,CAAC,EAAE,GAAG,CAAS,+BAA+B,EAAE,EAAE,CAAC,CAAC;oBACtG,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACxE,CAAC,CAAC;gBACF,SAAS,EAAE,mBAAmB;aAC/B;SACF;KACF;CACF,CAAC;AAEF,kBAAe,WAAW,CAAC"}

package/lib/cjs/controllers/SwaggerController.d.ts

@@ -0,0 +1,26 @@
+import { BaseController, Json, Ok, TemplateResponse } from '@spinajs/http';
+import { SwaggerService } from '../swagger-service.js';
+import { ISwaggerUiConfig } from '../interfaces.js';
+/**
+ * Controller that serves Swagger/OpenAPI documentation.
+ * Provides the OpenAPI JSON spec and a Swagger UI interface.
+ */
+export declare class SwaggerController extends BaseController {
+    protected Swagger: SwaggerService;
+    protected UiConfig: ISwaggerUiConfig;
+    /**
+     * Returns the OpenAPI 3.0 JSON specification.
+     * @returns OpenAPI specification document
+     */
+    getSpec(): Promise<Json<{
+        error: string;
+    }> | Json<import("../interfaces.js").IOpenApiDocument>>;
+    /**
+     * Serves the Swagger UI HTML page rendered via Pug template.
+     * @returns HTML page with Swagger UI
+     */
+    getUI(): Promise<Ok<{
+        error: string;
+    }> | TemplateResponse>;
+}
+//# sourceMappingURL=SwaggerController.d.ts.map

package/lib/cjs/controllers/SwaggerController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwaggerController.d.ts","sourceRoot":"","sources":["../../../src/controllers/SwaggerController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAiB,IAAI,EAAE,EAAE,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC1F,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;GAGG;AACH,qBACa,iBAAkB,SAAQ,cAAc;IAEnD,SAAS,CAAC,OAAO,EAAG,cAAc,CAAC;IAGnC,SAAS,CAAC,QAAQ,EAAG,gBAAgB,CAAC;IAEtC;;;OAGG;IAEU,OAAO;;;IAQpB;;;OAGG;IAEU,KAAK;;;CAkBnB"}

package/lib/cjs/controllers/SwaggerController.js

@@ -0,0 +1,74 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerController = void 0;
+const di_1 = require("@spinajs/di");
+const configuration_1 = require("@spinajs/configuration");
+const http_1 = require("@spinajs/http");
+const swagger_service_js_1 = require("../swagger-service.js");
+/**
+ * Controller that serves Swagger/OpenAPI documentation.
+ * Provides the OpenAPI JSON spec and a Swagger UI interface.
+ */
+let SwaggerController = class SwaggerController extends http_1.BaseController {
+    /**
+     * Returns the OpenAPI 3.0 JSON specification.
+     * @returns OpenAPI specification document
+     */
+    async getSpec() {
+        if (!this.Swagger.IsEnabled) {
+            return new http_1.Json({ error: 'Swagger documentation is disabled' });
+        }
+        return new http_1.Json(await this.Swagger.getSpec());
+    }
+    /**
+     * Serves the Swagger UI HTML page rendered via Pug template.
+     * @returns HTML page with Swagger UI
+     */
+    async getUI() {
+        if (!this.Swagger.IsEnabled) {
+            return new http_1.Ok({ error: 'Swagger documentation is disabled' });
+        }
+        const cfg = this.UiConfig || {};
+        return new http_1.TemplateResponse({ template: 'swagger.pug', provider: '__fs_swagger_views__' }, {
+            title: cfg.pageTitle || (await this.Swagger.getSpec())?.info?.title || 'API Documentation',
+            cssUrl: cfg.cssUrl || 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css',
+            bundleUrl: cfg.bundleUrl || 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js',
+            presetUrl: cfg.presetUrl || 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-standalone-preset.js',
+            specUrl: cfg.specUrl || '/docs/swagger.json',
+        });
+    }
+};
+exports.SwaggerController = SwaggerController;
+__decorate([
+    (0, di_1.Autoinject)(),
+    __metadata("design:type", swagger_service_js_1.SwaggerService)
+], SwaggerController.prototype, "Swagger", void 0);
+__decorate([
+    (0, configuration_1.Config)('http.swagger.ui'),
+    __metadata("design:type", Object)
+], SwaggerController.prototype, "UiConfig", void 0);
+__decorate([
+    (0, http_1.Get)('swagger.json'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], SwaggerController.prototype, "getSpec", null);
+__decorate([
+    (0, http_1.Get)('/'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], SwaggerController.prototype, "getUI", null);
+exports.SwaggerController = SwaggerController = __decorate([
+    (0, http_1.BasePath)('docs')
+], SwaggerController);
+//# sourceMappingURL=SwaggerController.js.map

package/lib/cjs/controllers/SwaggerController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwaggerController.js","sourceRoot":"","sources":["../../../src/controllers/SwaggerController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAyC;AACzC,0DAAgD;AAChD,wCAA0F;AAC1F,8DAAuD;AAGvD;;;GAGG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAkB,SAAQ,qBAAc;IAOnD;;;OAGG;IAEU,AAAN,KAAK,CAAC,OAAO;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAI,WAAI,CAAC,EAAE,KAAK,EAAE,mCAAmC,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,IAAI,WAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IAEU,AAAN,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC5B,OAAO,IAAI,SAAE,CAAC,EAAE,KAAK,EAAE,mCAAmC,EAAE,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,GAAG,GAA8B,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;QAE3D,OAAO,IAAI,uBAAgB,CACzB,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,sBAAsB,EAAE,EAC7D;YACE,KAAK,EAAE,GAAG,CAAC,SAAS,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,IAAI,mBAAmB;YAC1F,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,+DAA+D;YACrF,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,qEAAqE;YACjG,SAAS,EAAE,GAAG,CAAC,SAAS,IAAI,gFAAgF;YAC5G,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,oBAAoB;SAC7C,CACF,CAAC;IACJ,CAAC;CACF,CAAA;AA3CY,8CAAiB;AAElB;IADT,IAAA,eAAU,GAAE;8BACO,mCAAc;kDAAC;AAGzB;IADT,IAAA,sBAAM,EAAC,iBAAiB,CAAC;;mDACY;AAOzB;IADZ,IAAA,UAAG,EAAC,cAAc,CAAC;;;;gDAOnB;AAOY;IADZ,IAAA,UAAG,EAAC,GAAG,CAAC;;;;8CAkBR;4BA1CU,iBAAiB;IAD7B,IAAA,eAAQ,EAAC,MAAM,CAAC;GACJ,iBAAiB,CA2C7B"}

package/lib/cjs/index.d.ts

@@ -0,0 +1,7 @@
+export * from './interfaces.js';
+export * from './swagger-cache.js';
+export * from './swagger-service.js';
+export * from './controllers/SwaggerController.js';
+export * from './openapi-builder.js';
+export * from './cli/GenerateSwaggerCache.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oCAAoC,CAAC;AACnD,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,23 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interfaces.js"), exports);
+__exportStar(require("./swagger-cache.js"), exports);
+__exportStar(require("./swagger-service.js"), exports);
+__exportStar(require("./controllers/SwaggerController.js"), exports);
+__exportStar(require("./openapi-builder.js"), exports);
+__exportStar(require("./cli/GenerateSwaggerCache.js"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,qDAAmC;AACnC,uDAAqC;AACrC,qEAAmD;AACnD,uDAAqC;AACrC,gEAA8C"}

package/lib/cjs/interfaces.d.ts

@@ -0,0 +1,211 @@
+/**
+ * Configuration for Swagger/OpenAPI documentation generation.
+ * Read from application configuration at path `http.swagger`
+ */
+export interface ISwaggerConfig {
+    enabled: boolean;
+    title: string;
+    version: string;
+    description?: string;
+    basePath?: string;
+    servers?: ISwaggerServer[];
+    securitySchemes?: Record<string, ISecurityScheme>;
+    security?: Record<string, string[]>[];
+    ui?: ISwaggerUiConfig;
+}
+/**
+ * Configuration for Swagger UI rendering
+ */
+export interface ISwaggerUiConfig {
+    /**
+     * URL to swagger-ui CSS file
+     */
+    cssUrl: string;
+    /**
+     * URL to swagger-ui-bundle.js
+     */
+    bundleUrl: string;
+    /**
+     * URL to swagger-ui-standalone-preset.js
+     */
+    presetUrl: string;
+    /**
+     * URL to the OpenAPI JSON spec endpoint (used by Swagger UI to load the spec)
+     */
+    specUrl: string;
+    /**
+     * Custom page title for the Swagger UI page
+     */
+    pageTitle?: string;
+}
+export interface ISwaggerServer {
+    url: string;
+    description?: string;
+}
+export interface ISecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    scheme?: string;
+    bearerFormat?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    description?: string;
+}
+/**
+ * JSDoc documentation extracted from a controller method
+ */
+export interface IMethodDocumentation {
+    summary?: string;
+    description?: string;
+    params: Record<string, IParamDocumentation>;
+    returns?: IReturnDocumentation;
+    responses?: Record<string, IResponseDocumentation>;
+    examples?: IExampleDocumentation[];
+    tags?: string[];
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+}
+export interface IParamDocumentation {
+    name: string;
+    description?: string;
+    type?: string;
+    required?: boolean;
+}
+export interface IReturnDocumentation {
+    description?: string;
+    type?: string;
+    schema?: IOpenApiSchema;
+}
+export interface IResponseDocumentation {
+    description: string;
+    type?: string;
+}
+export interface IExampleDocumentation {
+    name?: string;
+    description?: string;
+    value?: string;
+}
+/** JSDoc-extracted documentation for a policy class */
+export interface IPolicyDocumentation {
+    /** File where the policy is defined (for traceability) */
+    file?: string;
+    /** Class-level JSDoc description, if present */
+    description?: string;
+}
+/**
+ * Cache entry for a single controller's JSDoc documentation
+ */
+export interface ISwaggerCacheEntry {
+    className: string;
+    classDescription?: string;
+    classTags?: string[];
+    methods: Record<string, IMethodDocumentation>;
+    /** Controller-level policies (applied to every route on the controller) */
+    controllerPolicies?: string[];
+    /** Per-route policy class names */
+    routePolicies?: Record<string, string[]>;
+    /** Docs for each referenced policy class, keyed by class name */
+    policies?: Record<string, IPolicyDocumentation>;
+}
+/**
+ * OpenAPI 3.0 document structure
+ */
+export interface IOpenApiDocument {
+    openapi: string;
+    info: IOpenApiInfo;
+    servers?: IOpenApiServer[];
+    paths: Record<string, IOpenApiPathItem>;
+    components?: IOpenApiComponents;
+    security?: Record<string, string[]>[];
+    tags?: IOpenApiTag[];
+}
+export interface IOpenApiInfo {
+    title: string;
+    version: string;
+    description?: string;
+}
+export interface IOpenApiServer {
+    url: string;
+    description?: string;
+}
+export interface IOpenApiTag {
+    name: string;
+    description?: string;
+}
+export interface IOpenApiPathItem {
+    [method: string]: IOpenApiOperation;
+}
+export interface IOpenApiOperation {
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    deprecated?: boolean;
+    parameters?: IOpenApiParameter[];
+    requestBody?: IOpenApiRequestBody;
+    responses: Record<string, IOpenApiResponse>;
+    security?: Record<string, string[]>[];
+    /** RBAC resource name (from rbac-http @Resource) */
+    'x-rbac-resource'?: string;
+    /**
+     * Permissions accepted for this route (accesscontrol actions:
+     * readAny|readOwn|updateAny|updateOwn|createAny|createOwn|deleteAny|deleteOwn).
+     * Access is granted if the caller's role(s) have at least one.
+     */
+    'x-rbac-permissions'?: string[];
+    /** Policy class names applied to this route (controller-level + route-level, in execution order) */
+    'x-policies'?: string[];
+}
+export interface IOpenApiParameter {
+    name: string;
+    in: 'query' | 'path' | 'header' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema?: IOpenApiSchema;
+    style?: string;
+    explode?: boolean;
+}
+export interface IOpenApiRequestBody {
+    description?: string;
+    required?: boolean;
+    content: Record<string, IOpenApiMediaType>;
+}
+export interface IOpenApiMediaType {
+    schema?: IOpenApiSchema;
+    examples?: Record<string, IOpenApiExample>;
+}
+export interface IOpenApiExample {
+    summary?: string;
+    description?: string;
+    value?: any;
+}
+export interface IOpenApiResponse {
+    description?: string;
+    content?: Record<string, IOpenApiMediaType>;
+    $ref?: string;
+}
+export interface IOpenApiSchema {
+    type?: string;
+    format?: string;
+    items?: IOpenApiSchema;
+    properties?: Record<string, IOpenApiSchema>;
+    required?: string[];
+    $ref?: string;
+    description?: string;
+    enum?: any[];
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    nullable?: boolean;
+    oneOf?: IOpenApiSchema[];
+    anyOf?: IOpenApiSchema[];
+    allOf?: IOpenApiSchema[];
+    example?: unknown;
+}
+export interface IOpenApiComponents {
+    schemas?: Record<string, IOpenApiSchema>;
+    securitySchemes?: Record<string, ISecurityScheme>;
+    responses?: Record<string, IOpenApiResponse>;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/lib/cjs/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACtC,EAAE,CAAC,EAAE,gBAAgB,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAC;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IACnD,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACnC,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC9C,2EAA2E;IAC3E,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACzC,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACtC,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACjC,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACtC,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,oGAAoG;IACpG,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC9C"}

package/lib/cjs/interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.js.map

package/lib/cjs/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":""}