@rsdk/cli.cmd.autodoc 6.0.0-next.8 → 6.0.0-next.9

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/cli.cmd.autodoc",
-  "version": "6.0.0-next.8",
+  "version": "6.0.0-next.9",
   "description": "autodoc your app!",
   "homepage": "https://github.com/R-Vision/rsdk",
   "license": "Apache License 2.0",
@@ -13,18 +13,18 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/swagger": "^7.0.0 || ^8.0.0",
-    "@rsdk/cli.common": "6.0.0-next.8",
-    "@rsdk/cli.core": "6.0.0-next.8",
-    "@rsdk/common": "6.0.0-next.8",
-    "@rsdk/common.node": "6.0.0-next.8",
-    "@rsdk/core": "6.0.0-next.8",
-    "@rsdk/http.openapi": "6.0.0-next.8",
-    "@rsdk/logging": "6.0.0-next.8",
-    "@rsdk/nest-tools": "6.0.0-next.8",
-    "@rsdk/zones": "6.0.0-next.8",
+    "@rsdk/cli.common": "6.0.0-next.9",
+    "@rsdk/cli.core": "6.0.0-next.9",
+    "@rsdk/common": "6.0.0-next.9",
+    "@rsdk/common.node": "6.0.0-next.9",
+    "@rsdk/core": "6.0.0-next.9",
+    "@rsdk/http.openapi": "6.0.0-next.9",
+    "@rsdk/logging": "6.0.0-next.9",
+    "@rsdk/nest-tools": "6.0.0-next.9",
+    "@rsdk/zones": "6.0.0-next.9",
     "@sinclair/typebox": "^0.34.9",
     "lodash": "^4.17.21",
     "yaml": "^2.6.1"
   },
-  "gitHead": "3d0d13e78842a0d57124a5246d00c77718be0045"
+  "gitHead": "1489dda3b612de37a2b927e8c74058a910a4ddc9"
 }

package/src/generators/openapi-json/schemas/config.schema.spec.ts

@@ -0,0 +1,265 @@
+import { TypeBoxValidator } from '@rsdk/common';
+import { parse } from 'yaml';
+
+import { OpenApiConfigSchema } from './config.schema';
+
+describe('OpenAPI Config Schema', () => {
+  const validator = new TypeBoxValidator(OpenApiConfigSchema);
+
+  it('should validate minimal config', () => {
+    const config = parse(`
+      out: openapi.json
+      title: Test API
+      version: 1.0.0
+      description: Test API Description
+    `);
+
+    const { isValid, errors } = validator.check(config);
+
+    expect(isValid).toBe(true);
+    expect(errors).toHaveLength(0);
+  });
+
+  it('should validate minimal config', () => {
+    const config = parse(`
+      out: openapi.json
+      title: Test API
+      version: '1.0.0'
+      description: Test API Description
+    `);
+
+    const { isValid, errors } = validator.check(config);
+
+    expect(isValid).toBe(true);
+    expect(errors).toHaveLength(0);
+  });
+
+  it('should validate config with zones', () => {
+    const config = parse(`
+      out: openapi.json
+      title: Test API
+      version: '1.0.0'
+      description: Test API Description
+      includeZones:
+        - public
+        - api:web
+      excludeZones:
+        - __internal
+    `);
+
+    const { isValid, errors } = validator.check(config);
+
+    expect(isValid).toBe(true);
+    expect(errors).toHaveLength(0);
+  });
+
+  it('should validate config without optional fields', () => {
+    const config = parse(`
+      out: openapi.json
+      version: '1.0.0'
+    `);
+
+    const { isValid, errors } = validator.check(config);
+
+    expect(isValid).toBe(true);
+    expect(errors).toHaveLength(0);
+  });
+
+  describe('Security Schemes', () => {
+    it('should validate API Key auth', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        version: '1.0.0'
+        description: Test API Description
+        security:
+          ApiKeyAuth:
+            type: apiKey
+            in: header
+            name: x-api-key
+            description: API Key Authentication
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(true);
+      expect(errors).toHaveLength(0);
+    });
+
+    it('should validate Bearer auth', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        version: '1.0.0'
+        description: Test API Description
+        security:
+          BearerAuth:
+            type: http
+            scheme: bearer
+            bearerFormat: JWT
+            description: JWT Bearer Authentication
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(true);
+      expect(errors).toHaveLength(0);
+    });
+
+    it('should validate Basic auth', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        version: '1.0.0'
+        description: Test API Description
+        security:
+          BasicAuth:
+            type: http
+            scheme: basic
+            description: Basic Authentication
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(true);
+      expect(errors).toHaveLength(0);
+    });
+
+    it('should validate OAuth2 auth', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        version: '1.0.0'
+        description: Test API Description
+        security:
+          OAuth2Auth:
+            type: oauth2
+            flows:
+              implicit:
+                authorizationUrl: https://auth.example.com/oauth/authorize
+                scopes:
+                  read: Read access
+                  write: Write access
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      for (const error of errors) {
+        console.log(error);
+      }
+
+      expect(isValid).toBe(true);
+      expect(errors).toHaveLength(0);
+    });
+
+    it('should validate multiple security schemes', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        version: '1.0.0'
+        description: Test API Description
+        security:
+          BearerAuth:
+            type: http
+            scheme: bearer
+            bearerFormat: JWT
+            description: JWT Bearer Authentication
+          
+          ApiKeyAuth:
+            type: apiKey
+            in: header
+            name: x-api-key
+            description: API Key Authentication
+          
+          OAuth2Auth:
+            type: oauth2
+            description: OAuth2 Authentication
+            flows:
+              implicit:
+                authorizationUrl: https://auth.example.com/oauth/authorize
+                scopes:
+                  read: Read access
+                  write: Write access
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(true);
+      expect(errors).toHaveLength(0);
+    });
+
+    it('should validate cookie-based auth', () => {
+      const config = parse(`
+        out: openapi/openapi.web.json
+        includeZones:
+          - api:web
+        title: Web API
+        version: '1.3'
+        description: Web API methods
+        security:
+          SessionCookie:
+            type: apiKey
+            in: cookie
+            name: sessionId
+            description: Cookie-based authentication
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(true);
+      expect(errors).toHaveLength(0);
+    });
+  });
+
+  describe('Validation Errors', () => {
+    it('should fail on invalid security type', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        version: 1.0.0
+        description: Test API Description
+        security:
+          InvalidAuth:
+            type: invalid
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(false);
+      expect(errors).toHaveLength(2);
+    });
+
+    it('should fail on missing required fields', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        description: Test API Description
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(true);
+      expect(errors).toHaveLength(0);
+    });
+
+    it('should fail on invalid OAuth2 flow configuration', () => {
+      const config = parse(`
+        out: openapi.json
+        title: Test API
+        version: 1.0.0
+        description: Test API Description
+        security:
+          - type: oauth2
+            schemaName: OAuth2Auth
+            flows:
+              implicit:
+                scopes: invalid
+      `);
+
+      const { isValid, errors } = validator.check(config);
+
+      expect(isValid).toBe(false);
+      expect(errors.length).toBeGreaterThan(0);
+    });
+  });
+});

package/src/generators/openapi-json/schemas/config.schema.ts

@@ -0,0 +1,37 @@
+import { OpenApiOptions } from '@rsdk/http.openapi';
+import type { Static } from '@sinclair/typebox';
+import { Type } 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 const OpenApiConfigSchema = Type.Intersect([
+  Type.Partial(OpenApiOptions),
+  Type.Object({
+    /** Output file path for the generated OpenAPI document */
+    out: Type.Optional(Type.String()),
+
+    /** Path to the application file (usually `dist/app.js`) */
+    app: Type.Optional(Type.String()),
+  }),
+]);
+
+export type OpenApiConfigSchema = Static<typeof OpenApiConfigSchema>;

package/src/generators/openapi-json/schemas/index.ts

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