@rsdk/cli.cmd.autodoc 6.0.0-next.1 → 6.0.0-next.10

package/dist/generators/openapi-json/config.schema.d.ts

@@ -0,0 +1,55 @@
+import type { Static } from '@sinclair/typebox';
+/**
+ * Configuration schema for OpenAPI document generation.
+ * @example
+ * {
+ *   "out": "openapi.json",
+ *   "app": "./dist/app.js",
+ *   "title": "My API",
+ *   "version": "1.0.0",
+ *   "description": "API Description",
+ *   "includeZones": ["public"],
+ *   "excludeZones": ["internal"],
+ *   "security": {
+ *     "jwt": {
+ *       "type": "http",
+ *       "scheme": "bearer",
+ *       "bearerFormat": "JWT",
+ *       "name": "JWT Auth"
+ *     }
+ *   }
+ * }
+ */
+export declare const OpenApiConfigSchema: import("@sinclair/typebox").TIntersect<[import("@sinclair/typebox").TObject<{
+    title: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    version: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    includeZones: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    excludeZones: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    security: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TLiteral<"http">;
+        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        scheme: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"basic">, import("@sinclair/typebox").TLiteral<"bearer">]>;
+        bearerFormat: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>, import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TLiteral<"apiKey">;
+        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        name: import("@sinclair/typebox").TString;
+        in: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"query">, import("@sinclair/typebox").TLiteral<"header">, import("@sinclair/typebox").TLiteral<"cookie">]>;
+    }>, import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TLiteral<"oauth2">;
+        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        flows: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+            scopes: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>;
+            authorizationUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            tokenUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            refreshUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        }>>;
+    }>]>>>;
+}>, import("@sinclair/typebox").TObject<{
+    /** Output file path for the generated OpenAPI document */
+    out: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    /** Path to the application file (usually `dist/app.js`) */
+    app: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>]>;
+export type OpenApiConfigSchema = Static<typeof OpenApiConfigSchema>;

package/dist/generators/openapi-json/config.schema.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiConfigSchema = void 0;
+const http_openapi_1 = require("@rsdk/http.openapi");
+const typebox_1 = require("@sinclair/typebox");
+/**
+ * Configuration schema for OpenAPI document generation.
+ * @example
+ * {
+ *   "out": "openapi.json",
+ *   "app": "./dist/app.js",
+ *   "title": "My API",
+ *   "version": "1.0.0",
+ *   "description": "API Description",
+ *   "includeZones": ["public"],
+ *   "excludeZones": ["internal"],
+ *   "security": {
+ *     "jwt": {
+ *       "type": "http",
+ *       "scheme": "bearer",
+ *       "bearerFormat": "JWT",
+ *       "name": "JWT Auth"
+ *     }
+ *   }
+ * }
+ */
+exports.OpenApiConfigSchema = typebox_1.Type.Intersect([
+    typebox_1.Type.Partial(http_openapi_1.OpenApiOptions),
+    typebox_1.Type.Object({
+        /** Output file path for the generated OpenAPI document */
+        out: typebox_1.Type.Optional(typebox_1.Type.String()),
+        /** Path to the application file (usually `dist/app.js`) */
+        app: typebox_1.Type.Optional(typebox_1.Type.String()),
+    }),
+]);
+//# sourceMappingURL=config.schema.js.map

package/dist/generators/openapi-json/config.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.schema.js","sourceRoot":"","sources":["../../../src/generators/openapi-json/config.schema.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAEpD,+CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,mBAAmB,GAAG,cAAI,CAAC,SAAS,CAAC;IAChD,cAAI,CAAC,OAAO,CAAC,6BAAc,CAAC;IAC5B,cAAI,CAAC,MAAM,CAAC;QACV,0DAA0D;QAC1D,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,EAAE,CAAC;QAEjC,2DAA2D;QAC3D,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,EAAE,CAAC;KAClC,CAAC;CACH,CAAC,CAAC"}

package/dist/generators/openapi-json/index.d.ts

@@ -1 +1,2 @@
 export * from './openapi-json.generator';
+export * from './config.schema';

package/dist/generators/openapi-json/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./openapi-json.generator"), exports);
+__exportStar(require("./config.schema"), exports);
 //# sourceMappingURL=index.js.map

package/dist/generators/openapi-json/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generators/openapi-json/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generators/openapi-json/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,kDAAgC"}

package/dist/generators/openapi-json/openapi-json.generator.d.ts

@@ -1,17 +1,15 @@
-import { PlatformApp } from '@rsdk/core';
+import type { PlatformApp } from '@rsdk/core';
 import { FileGenerator } from '../file-generator.interface';
-export type OpenApiGeneratorOptions = {
-    title: string;
-    version: string;
-    description: string;
-    includeZones?: string[];
-    excludeZones?: string[];
-};
-export declare class OpenapiGenerator extends FileGenerator {
-    private readonly app;
+import type { OpenApiConfigSchema } from './config.schema';
+/**
+ * Here we don't need `out` and `app`,
+ * but `title`, `version` and `description` are required.
+ */
+export type OpenApiGeneratorOptions = Omit<OpenApiConfigSchema, 'out' | 'app'> & Required<Pick<OpenApiConfigSchema, 'title' | 'version' | 'description'>>;
+export declare class OpenApiFileGenerator extends FileGenerator {
+    private readonly context;
     private readonly options;
     constructor(app: PlatformApp, options?: Partial<OpenApiGeneratorOptions>);
     protected getContent(): Promise<string>;
-    private clearController;
     private resolveOptions;
 }

package/dist/generators/openapi-json/openapi-json.generator.js

@@ -1,104 +1,27 @@
 "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;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenapiGenerator = void 0;
-const common_1 = require("@nestjs/common");
-const core_1 = require("@nestjs/core");
-const swagger_1 = require("@nestjs/swagger");
-const core_2 = require("@rsdk/core");
+exports.OpenApiFileGenerator = void 0;
+const http_openapi_1 = require("@rsdk/http.openapi");
 const logging_1 = require("@rsdk/logging");
-const nest_tools_1 = require("@rsdk/nest-tools");
-const zones_1 = require("@rsdk/zones");
 const file_generator_interface_1 = require("../file-generator.interface");
-class OpenapiGenerator extends file_generator_interface_1.FileGenerator {
-    app;
+class OpenApiFileGenerator extends file_generator_interface_1.FileGenerator {
+    context;
     options;
     constructor(app, options = {}) {
-        super(logging_1.LoggerFactory.create(OpenapiGenerator));
-        this.app = app;
+        super(logging_1.LoggerFactory.create(OpenApiFileGenerator));
+        this.context = app.context;
         this.options = options;
     }
     async getContent() {
-        const transports = this.app.context.options.transports;
-        if (!transports?.length) {
-            throw new Error('transports not found');
-        }
-        const httpTransport = transports?.find?.(core_2.isHttpTransport);
-        if (!httpTransport) {
-            throw new Error('http transport not found');
-        }
         this.logger.info('Generate openapi starting');
-        const root = this.app.context.getRoot();
-        const options = await this.resolveOptions(this.app, this.options);
-        const iterator = new nest_tools_1.NestDefinitionIterator(root).iterate(nest_tools_1.NestDefinitionType.Controllers);
-        const controllers = [];
-        const { includeZones, excludeZones } = options;
-        /**
-         * TODO: А может надо на основании чего-то другого, кроме тегов ещё?
-         * Просто теги могут быть с пробелами и с другими приколами... как вариант
-         * можно на основании имён контроллеров?
-         */
-        this.logger.info(`includeZones: ${includeZones}`);
-        this.logger.info(`excludeZones: ${excludeZones}`);
-        for await (const controller of iterator) {
-            const zone = zones_1.Zone.getForController(controller);
-            this.logger.info(`${controller.name} zone: ${zone || 'none'}`);
-            /**
-             * Исключаем контроллеры, c зоной из excludeZones
-             */
-            if (excludeZones && excludeZones.includes(zone)) {
-                this.logger.info(`${controller.name} excluded`);
-                continue;
-            }
-            /**
-             * Включаем только те контроллеры, которые имеют хотя бы один из тегов из includeTags
-             */
-            if (includeZones && !includeZones.includes(zone)) {
-                this.logger.info(`${controller.name} skipped`);
-                continue;
-            }
-            this.logger.info(`${controller.name} included`);
-            controllers.push(this.clearController(controller));
-        }
-        let OpenApiModule = class OpenApiModule {
-        };
-        OpenApiModule = __decorate([
-            (0, common_1.Module)({ controllers })
-        ], OpenApiModule);
-        const createOptions = await this.app.context.getNestFactoryCreateOptions();
-        const app = await core_1.NestFactory.create(OpenApiModule, ...createOptions);
-        const { title, version, description } = options;
-        const builder = new swagger_1.DocumentBuilder()
-            .setTitle(title)
-            .setVersion(version)
-            .setDescription(description);
-        const openApiConfig = builder.build();
-        const document = swagger_1.SwaggerModule.createDocument(app, openApiConfig);
+        const options = await this.resolveOptions(this.context, this.options);
+        const generator = new http_openapi_1.OpenApiGenerator(this.context, options);
+        const document = await generator.generate();
         this.logger.info('Generate openapi finished');
-        await app.close();
         return JSON.stringify(document, null, 2);
     }
-    clearController(controller) {
-        class ClearedController extends controller {
-        }
-        const keysForRedefine = ['design:paramtypes', 'self:paramtypes'];
-        for (const forRedefineMetadataKey of keysForRedefine) {
-            Reflect.defineMetadata(forRedefineMetadataKey, [], ClearedController);
-        }
-        // Влияет на `operationId` в генерации
-        Object.defineProperty(ClearedController, 'name', {
-            value: controller.name,
-            writable: false,
-        });
-        return ClearedController;
-    }
-    async resolveOptions(app, passed) {
-        const appMetadata = await app.context.getMetadata();
+    async resolveOptions(context, passed) {
+        const appMetadata = await context.getMetadata();
         const defaults = {
             title: appMetadata.name,
             version: appMetadata.version,
@@ -107,5 +30,5 @@ class OpenapiGenerator extends file_generator_interface_1.FileGenerator {
         return { ...defaults, ...passed };
     }
 }
-exports.OpenapiGenerator = OpenapiGenerator;
+exports.OpenApiFileGenerator = OpenApiFileGenerator;
 //# sourceMappingURL=openapi-json.generator.js.map

package/dist/generators/openapi-json/openapi-json.generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"openapi-json.generator.js","sourceRoot":"","sources":["../../../src/generators/openapi-json/openapi-json.generator.ts"],"names":[],"mappings":";;;;;;;;;AACA,2CAAwC;AACxC,uCAA2C;AAC3C,6CAGyB;AACzB,qCAA0D;AAC1D,2CAA8C;AAC9C,iDAA8E;AAC9E,uCAAmC;AAGnC,0EAA4D;AAU5D,MAAa,gBAAiB,SAAQ,wCAAa;IAE9B;IACA;IAFnB,YACmB,GAAgB,EAChB,UAA4C,EAAE;QAE/D,KAAK,CAAC,uBAAa,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAH7B,QAAG,GAAH,GAAG,CAAa;QAChB,YAAO,GAAP,OAAO,CAAuC;IAGjE,CAAC;IAEe,AAAN,KAAK,CAAC,UAAU;QACxB,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;QACvD,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,aAAa,GAAG,UAAU,EAAE,IAAI,EAAE,CAAC,sBAAe,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAExC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,IAAI,mCAAsB,CAAC,IAAI,CAAC,CAAC,OAAO,CACvD,+BAAkB,CAAC,WAAW,CAC/B,CAAC;QAEF,MAAM,WAAW,GAAW,EAAE,CAAC;QAC/B,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QAE/C;;;;WAIG;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,YAAY,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,YAAY,EAAE,CAAC,CAAC;QAElD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,QAAQ,EAAE,CAAC;YACxC,MAAM,IAAI,GAAW,YAAI,CAAC,gBAAgB,CAAC,UAAkB,CAAC,CAAC;YAE/D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAI,UAAkB,CAAC,IAAI,UAAU,IAAI,IAAI,MAAM,EAAE,CAAC,CAAC;YAExE;;eAEG;YACH,IAAI,YAAY,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAI,UAAkB,CAAC,IAAI,WAAW,CAAC,CAAC;gBACzD,SAAS;YACX,CAAC;YAED;;eAEG;YACH,IAAI,YAAY,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAI,UAAkB,CAAC,IAAI,UAAU,CAAC,CAAC;gBACxD,SAAS;YACX,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAI,UAAkB,CAAC,IAAI,WAAW,CAAC,CAAC;YACzD,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAAkB,CAAC,CAAC,CAAC;QAC7D,CAAC;QAGD,IAAM,aAAa,GAAnB,MAAM,aAAa;SAAG,CAAA;QAAhB,aAAa;YADlB,IAAA,eAAM,EAAC,EAAE,WAAW,EAAE,CAAC;WAClB,aAAa,CAAG;QAEtB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAE3E,MAAM,GAAG,GAAG,MAAM,kBAAW,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,aAAa,CAAC,CAAC;QAEtE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,yBAAuB,EAAE;aAC1C,QAAQ,CAAC,KAAK,CAAC;aACf,UAAU,CAAC,OAAO,CAAC;aACnB,cAAc,CAAC,WAAW,CAAC,CAAC;QAE/B,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAEtC,MAAM,QAAQ,GAAG,uBAAa,CAAC,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAElE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC9C,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QAElB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAEO,eAAe,CAAC,UAAgB;QACtC,MAAM,iBAAkB,SAAQ,UAAU;SAAG;QAE7C,MAAM,eAAe,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;QAEjE,KAAK,MAAM,sBAAsB,IAAI,eAAe,EAAE,CAAC;YACrD,OAAO,CAAC,cAAc,CAAC,sBAAsB,EAAE,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACxE,CAAC;QAED,sCAAsC;QACtC,MAAM,CAAC,cAAc,CAAC,iBAAiB,EAAE,MAAM,EAAE;YAC/C,KAAK,EAAE,UAAU,CAAC,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,GAAgB,EAChB,MAAwC;QAExC,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACpD,MAAM,QAAQ,GAA4B;YACxC,KAAK,EAAE,WAAW,CAAC,IAAI;YACvB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,WAAW,EAAE,WAAW,CAAC,WAAW;SACrC,CAAC;QAEF,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IACpC,CAAC;CACF;AAvHD,4CAuHC"}
+{"version":3,"file":"openapi-json.generator.js","sourceRoot":"","sources":["../../../src/generators/openapi-json/openapi-json.generator.ts"],"names":[],"mappings":";;;AACA,qDAAsD;AACtD,2CAA8C;AAE9C,0EAA4D;AAW5D,MAAa,oBAAqB,SAAQ,wCAAa;IACpC,OAAO,CAAkB;IACzB,OAAO,CAAmC;IAE3D,YACE,GAAgB,EAChB,UAA4C,EAAE;QAE9C,KAAK,CAAC,uBAAa,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAES,KAAK,CAAC,UAAU;QACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAE9C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtE,MAAM,SAAS,GAAG,IAAI,+BAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;QAE5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,OAAwB,EACxB,MAAwC;QAExC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,QAAQ,GAA4B;YACxC,KAAK,EAAE,WAAW,CAAC,IAAI;YACvB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,WAAW,EAAE,WAAW,CAAC,WAAW;SACrC,CAAC;QAEF,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IACpC,CAAC;CACF;AArCD,oDAqCC"}

package/dist/generators/openapi-json/schemas/config.schema.d.ts

@@ -0,0 +1,55 @@
+import type { Static } from '@sinclair/typebox';
+/**
+ * Configuration schema for OpenAPI document generation.
+ * @example
+ * {
+ *   "out": "openapi.json",
+ *   "app": "./dist/app.js",
+ *   "title": "My API",
+ *   "version": "1.0.0",
+ *   "description": "API Description",
+ *   "includeZones": ["public"],
+ *   "excludeZones": ["internal"],
+ *   "security": {
+ *     "jwt": {
+ *       "type": "http",
+ *       "scheme": "bearer",
+ *       "bearerFormat": "JWT",
+ *       "name": "JWT Auth"
+ *     }
+ *   }
+ * }
+ */
+export declare const OpenApiConfigSchema: import("@sinclair/typebox").TIntersect<[import("@sinclair/typebox").TObject<{
+    title: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    version: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    includeZones: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    excludeZones: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    security: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TLiteral<"http">;
+        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        scheme: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"basic">, import("@sinclair/typebox").TLiteral<"bearer">]>;
+        bearerFormat: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>, import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TLiteral<"apiKey">;
+        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        name: import("@sinclair/typebox").TString;
+        in: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"query">, import("@sinclair/typebox").TLiteral<"header">, import("@sinclair/typebox").TLiteral<"cookie">]>;
+    }>, import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TLiteral<"oauth2">;
+        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        flows: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+            scopes: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>;
+            authorizationUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            tokenUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            refreshUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        }>>;
+    }>]>>>;
+}>, import("@sinclair/typebox").TObject<{
+    /** Output file path for the generated OpenAPI document */
+    out: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    /** Path to the application file (usually `dist/app.js`) */
+    app: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>]>;
+export type OpenApiConfigSchema = Static<typeof OpenApiConfigSchema>;

package/dist/generators/openapi-json/schemas/config.schema.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiConfigSchema = void 0;
+const http_openapi_1 = require("@rsdk/http.openapi");
+const typebox_1 = require("@sinclair/typebox");
+/**
+ * Configuration schema for OpenAPI document generation.
+ * @example
+ * {
+ *   "out": "openapi.json",
+ *   "app": "./dist/app.js",
+ *   "title": "My API",
+ *   "version": "1.0.0",
+ *   "description": "API Description",
+ *   "includeZones": ["public"],
+ *   "excludeZones": ["internal"],
+ *   "security": {
+ *     "jwt": {
+ *       "type": "http",
+ *       "scheme": "bearer",
+ *       "bearerFormat": "JWT",
+ *       "name": "JWT Auth"
+ *     }
+ *   }
+ * }
+ */
+exports.OpenApiConfigSchema = typebox_1.Type.Intersect([
+    typebox_1.Type.Partial(http_openapi_1.OpenApiOptions),
+    typebox_1.Type.Object({
+        /** Output file path for the generated OpenAPI document */
+        out: typebox_1.Type.Optional(typebox_1.Type.String()),
+        /** Path to the application file (usually `dist/app.js`) */
+        app: typebox_1.Type.Optional(typebox_1.Type.String()),
+    }),
+]);
+//# sourceMappingURL=config.schema.js.map

package/dist/generators/openapi-json/schemas/config.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.schema.js","sourceRoot":"","sources":["../../../../src/generators/openapi-json/schemas/config.schema.ts"],"names":[],"mappings":";;;AAAA,qDAAoD;AAEpD,+CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,mBAAmB,GAAG,cAAI,CAAC,SAAS,CAAC;IAChD,cAAI,CAAC,OAAO,CAAC,6BAAc,CAAC;IAC5B,cAAI,CAAC,MAAM,CAAC;QACV,0DAA0D;QAC1D,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,EAAE,CAAC;QAEjC,2DAA2D;QAC3D,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,EAAE,CAAC;KAClC,CAAC;CACH,CAAC,CAAC"}

package/dist/generators/openapi-json/schemas/index.d.ts

@@ -0,0 +1 @@
+export * from './config.schema';

package/dist/generators/openapi-json/schemas/index.js

@@ -0,0 +1,18 @@
+"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("./config.schema"), exports);
+//# sourceMappingURL=index.js.map

package/dist/generators/openapi-json/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generators/openapi-json/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC"}

package/jest.config.e2e.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.e2e');

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config');

package/jest.config.unit.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.unit');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/cli.cmd.autodoc",
-  "version": "6.0.0-next.1",
+  "version": "6.0.0-next.10",
   "description": "autodoc your app!",
   "homepage": "https://github.com/R-Vision/rsdk",
   "license": "Apache License 2.0",
@@ -8,35 +8,23 @@
     "access": "public"
   },
   "main": "dist/index.js",
-  "files": [
-    "dist"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/R-Vision/rsdk"
-  },
+  "types": "dist/index.d.ts",
   "dependencies": {
-    "commander": "^12.1.0",
-    "lodash": "^4.17.21",
-    "log-update": "4.0.0",
-    "markdown-table": "2.0.0",
-    "pino-pretty": "^10.3.1"
-  },
-  "peerDependencies": {
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/swagger": "^7.0.0 || ^8.0.0",
-    "@opentelemetry/api": "1.9.0",
-    "@rsdk/autodoc.protocol": "*",
-    "@rsdk/cli.common": "*",
-    "@rsdk/common": "*",
-    "@rsdk/common.node": "*",
-    "@rsdk/core": "*",
-    "@rsdk/logging": "*",
-    "@rsdk/metadata": "*",
-    "@rsdk/nest-tools": "*",
-    "@rsdk/zones": "*",
-    "reflect-metadata": "^0.1.12 || ^0.2.0"
+    "@rsdk/cli.common": "6.0.0-next.10",
+    "@rsdk/cli.core": "6.0.0-next.10",
+    "@rsdk/common": "6.0.0-next.10",
+    "@rsdk/common.node": "6.0.0-next.10",
+    "@rsdk/core": "6.0.0-next.10",
+    "@rsdk/http.openapi": "6.0.0-next.10",
+    "@rsdk/logging": "6.0.0-next.10",
+    "@rsdk/nest-tools": "6.0.0-next.10",
+    "@rsdk/zones": "6.0.0-next.10",
+    "@sinclair/typebox": "^0.34.9",
+    "lodash": "^4.17.21",
+    "yaml": "^2.6.1"
   },
-  "gitHead": "3114a76df17cf98d6f3cbb8a931599a883af6783"
+  "gitHead": "26c1a04480e6209098be6636afbde7fd357da61a"
 }

package/src/base/app.loader.ts

@@ -0,0 +1,39 @@
+import { Assert } from '@rsdk/common';
+import { Path } from '@rsdk/common.node';
+import { PlatformApp } from '@rsdk/core';
+import type { ILogger } from '@rsdk/logging';
+
+export class AppLoader {
+  constructor(private readonly logger: ILogger) {}
+
+  async loadApp(
+    fullpath: string,
+    required: boolean,
+  ): Promise<PlatformApp | undefined> {
+    let app: PlatformApp | undefined;
+
+    try {
+      const [absolute] = Path.absolutize(fullpath);
+      const loaded = await import(absolute);
+
+      app = loaded.app as PlatformApp;
+    } catch (error) {
+      Assert.isError(error);
+      this.logger.warn(`module by path ${fullpath} not found`);
+
+      if (!required) {
+        this.logger.info(`found --if-present, finished with exit code 0`);
+        return undefined;
+      }
+
+      this.logger.error(`Error on import ${fullpath}`, error);
+      throw error;
+    }
+
+    if (app instanceof PlatformApp) {
+      return app;
+    }
+
+    throw new Error('app is not instance of PlatformApp');
+  }
+}

package/src/base/document.file.ts

@@ -0,0 +1,33 @@
+import type { ILogger } from '@rsdk/logging';
+import { existsSync } from 'node:fs';
+import { mkdir, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+
+/**
+ * TODO: Может быть удобная абстракция для работы с файлами.
+ * Ещё в старых загашниках надо NetworkFile поискать
+ */
+export type DocumentFile = {
+  name: string;
+  content: string;
+};
+
+export class DocumentWriter {
+  constructor(
+    private readonly logger: ILogger,
+    private readonly basepath: string,
+  ) {}
+
+  async write(file: DocumentFile): Promise<string> {
+    const exists = existsSync(this.basepath);
+    if (!exists) {
+      await mkdir(this.basepath, { recursive: true });
+    }
+    const fullpath = path.join(this.basepath, file.name);
+
+    this.logger.info(`writing file ${file.name}...`);
+    await writeFile(fullpath, file.content);
+    this.logger.info(`file ${file.name} created!`);
+    return fullpath;
+  }
+}

package/src/base/index.ts

@@ -0,0 +1,2 @@
+export * from './app.loader';
+export * from './document.file';

package/src/commands/autodoc.cmd.ts

@@ -0,0 +1,93 @@
+import { Command, IRunnable, Option, ValueOption } from '@rsdk/cli.common';
+import { FsPathParser, Path } from '@rsdk/common.node';
+import { ILogger, LoggerFactory } from '@rsdk/logging';
+import { API_ZONE_INTERNAL } from '@rsdk/zones';
+
+import { type DocumentFile, DocumentWriter } from '../base';
+import { AppLoader } from '../base';
+import {
+  MarkdownDocsGenerator,
+  OpenApiFileGenerator,
+  RsdkFileGenerator,
+} from '../generators';
+
+import { OpenApiCommand } from './openapi.variation';
+
+@Command('autodoc', {
+  description: 'autodoc your app',
+  variations: [OpenApiCommand],
+})
+export class AutodocCommand implements IRunnable {
+  private readonly logger: ILogger;
+  private readonly loader: AppLoader;
+
+  constructor() {
+    this.logger = LoggerFactory.create(AutodocCommand);
+    this.loader = new AppLoader(this.logger);
+  }
+
+  async run(
+    @Option('verbose', { description: 'Verbose output' })
+    verbose: boolean,
+
+    @Option('if-present', { description: 'Not fail if not provided app file' })
+    ifPresent: boolean,
+
+    @Option('open-api', {
+      description: 'generate open api (internal routes are excluded)',
+    })
+    openApi: boolean,
+
+    @ValueOption('out', new FsPathParser('dir', { check: 'dirname' }), {
+      description: 'output directory',
+      defaultValue: 'autodoc',
+      alias: 'o',
+    })
+    outPath: string,
+
+    @ValueOption('app', new FsPathParser('file'), {
+      description: 'path to app.js file',
+      defaultValue: './dist/app.js',
+      alias: 'a',
+    })
+    appPath: string,
+  ): Promise<void> {
+    if (verbose) {
+      this.logger.info(`app path: ${appPath}`);
+      this.logger.info(`output directory path: ${outPath}`);
+      this.logger.info(`--if-present: ${ifPresent}`);
+    }
+
+    const app = await this.loader.loadApp(appPath, !ifPresent);
+    if (!app) {
+      return;
+    }
+
+    const documents: DocumentFile[] = [
+      await new RsdkFileGenerator(app).createFile('rsdk.json'),
+      await new MarkdownDocsGenerator(app).createFile('autodoc.md'),
+    ];
+
+    if (openApi) {
+      const generator = new OpenApiFileGenerator(app, {
+        excludeZones: [API_ZONE_INTERNAL],
+      });
+
+      const openApiDocument = await generator.createFile('openapi.json');
+
+      if (openApiDocument) {
+        documents.push(openApiDocument);
+      }
+    }
+
+    const [absolutePath] = Path.absolutize(outPath);
+
+    const writer = new DocumentWriter(this.logger, absolutePath);
+
+    await Promise.all(
+      documents.map(async (doc) => {
+        await writer.write(doc);
+      }),
+    );
+  }
+}