@opra/nestjs 1.0.0-alpha.7 → 1.0.0-alpha.9

package/cjs/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IS_PUBLIC_KEY = void 0;
+exports.IS_PUBLIC_KEY = 'isPublic';

package/cjs/decorators/public.decorator.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Public = void 0;
+const common_1 = require("@nestjs/common");
+const constants_js_1 = require("../constants.js");
+const Public = () => (0, common_1.SetMetadata)(constants_js_1.IS_PUBLIC_KEY, true);
+exports.Public = Public;

package/cjs/index.js

@@ -3,5 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 require("reflect-metadata");
 require("./augmentation/nestjs.augmentation.js");
+tslib_1.__exportStar(require("./constants.js"), exports);
+tslib_1.__exportStar(require("./decorators/public.decorator.js"), exports);
 tslib_1.__exportStar(require("./opra-http.module.js"), exports);
 tslib_1.__exportStar(require("./opra-nestjs-adapter.js"), exports);

package/cjs/opra-http-core.module.js

@@ -3,9 +3,9 @@ var OpraHttpCoreModule_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpraHttpCoreModule = void 0;
 const tslib_1 = require("tslib");
-const ts_gems_1 = require("ts-gems");
 const common_1 = require("@nestjs/common");
 const common_2 = require("@opra/common");
+const ts_gems_1 = require("ts-gems");
 const opra_nestjs_adapter_js_1 = require("./opra-nestjs-adapter.js");
 const opra_middleware_js_1 = require("./services/opra-middleware.js");
 let OpraHttpCoreModule = OpraHttpCoreModule_1 = class OpraHttpCoreModule {
@@ -18,32 +18,33 @@ let OpraHttpCoreModule = OpraHttpCoreModule_1 = class OpraHttpCoreModule {
             method: common_1.RequestMethod.ALL,
         });
     }
-    static forRoot(options) {
-        const opraAdapter = new opra_nestjs_adapter_js_1.OpraNestAdapter(options);
-        const token = options?.id || opra_nestjs_adapter_js_1.OpraNestAdapter;
+    static forRoot(init, options) {
+        const opraAdapter = new opra_nestjs_adapter_js_1.OpraNestAdapter(init, options);
+        const token = init?.id || opra_nestjs_adapter_js_1.OpraNestAdapter;
         const providers = [
-            ...(options?.providers || []),
+            ...(init?.providers || []),
             {
                 provide: opra_nestjs_adapter_js_1.OpraNestAdapter,
                 useFactory: async () => {
                     (0, ts_gems_1.asMutable)(opraAdapter).document = await common_2.ApiDocumentFactory.createDocument({
-                        ...options,
-                        api: { protocol: 'http', name: options.name, controllers: opraAdapter.controllers },
+                        ...init,
+                        api: { protocol: 'http', name: init.name, controllers: init.controllers },
                     });
                     return opraAdapter;
                 },
             },
         ];
-        if (token !== opra_nestjs_adapter_js_1.OpraNestAdapter)
+        if (token !== opra_nestjs_adapter_js_1.OpraNestAdapter) {
             providers.push({
                 provide: token,
                 useValue: opraAdapter,
             });
+        }
         return {
             module: OpraHttpCoreModule_1,
-            controllers: opraAdapter.controllers,
-            imports: [...(options?.imports || [])],
-            exports: [...(options?.exports || []), token],
+            controllers: opraAdapter.nestControllers,
+            imports: [...(init?.imports || [])],
+            exports: [...(init?.exports || []), token],
             providers,
         };
     }

package/cjs/opra-http.module.js

@@ -8,12 +8,13 @@ const opra_http_core_module_js_1 = require("./opra-http-core.module.js");
 let OpraHttpModule = OpraHttpModule_1 = class OpraHttpModule {
     /**
      *
+     * @param init
      * @param options
      */
-    static forRoot(options) {
+    static forRoot(init, options) {
         return {
             module: OpraHttpModule_1,
-            imports: [opra_http_core_module_js_1.OpraHttpCoreModule.forRoot(options)],
+            imports: [opra_http_core_module_js_1.OpraHttpCoreModule.forRoot(init, options)],
         };
     }
 };

package/cjs/opra-nestjs-adapter.js

@@ -2,56 +2,84 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpraNestAdapter = exports.kHandler = void 0;
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const ts_gems_1 = require("ts-gems");
 const common_1 = require("@nestjs/common");
 const common_2 = require("@opra/common");
 const core_1 = require("@opra/core");
+const path_1 = tslib_1.__importDefault(require("path"));
+const ts_gems_1 = require("ts-gems");
+const public_decorator_1 = require("./decorators/public.decorator");
 const opra_exception_filter_js_1 = require("./services/opra-exception-filter.js");
 exports.kHandler = Symbol.for('kHandler');
 class OpraNestAdapter extends core_1.HttpAdapter {
-    constructor(options) {
+    constructor(init, options) {
         super((function () {
             const document = new common_2.ApiDocument();
             document.api = new common_2.HttpApi(document);
             return document;
         })(), options);
-        this.controllers = [];
-        let basePath = options.basePath || '/';
+        this.nestControllers = [];
+        this.options = options;
+        let basePath = options?.basePath || '/';
         if (!basePath.startsWith('/'))
             basePath = '/' + basePath;
-        if (options.controllers)
-            options.controllers.forEach(c => this._createNestControllers(c, basePath));
+        this._addRootController(basePath);
+        if (init.controllers)
+            init.controllers.forEach(c => this._addToNestControllers(c, basePath));
     }
     async close() {
         //
     }
-    _createNestControllers(source, currentPath) {
-        const metadata = Reflect.getMetadata(common_2.HTTP_CONTROLLER_METADATA, source);
+    _addRootController(basePath) {
+        const _this = this;
+        let RootController = class RootController {
+            schema(_req, next) {
+                _this[exports.kHandler].sendDocumentSchema(_req.opraContext).catch(next);
+            }
+        };
+        tslib_1.__decorate([
+            (0, common_1.Get)('/\\$schema'),
+            tslib_1.__param(0, (0, common_1.Req)()),
+            tslib_1.__param(1, (0, common_1.Next)()),
+            tslib_1.__metadata("design:type", Function),
+            tslib_1.__metadata("design:paramtypes", [Object, Function]),
+            tslib_1.__metadata("design:returntype", void 0)
+        ], RootController.prototype, "schema", null);
+        RootController = tslib_1.__decorate([
+            (0, common_1.Controller)({
+                path: basePath,
+            })
+        ], RootController);
+        if (this.options?.schemaRouteIsPublic) {
+            (0, public_decorator_1.Public)()(RootController.prototype, 'schema', Object.getOwnPropertyDescriptor(RootController.prototype, 'schema'));
+        }
+        this.nestControllers.push(RootController);
+    }
+    _addToNestControllers(sourceClass, currentPath) {
+        const metadata = Reflect.getMetadata(common_2.HTTP_CONTROLLER_METADATA, sourceClass);
         if (!metadata)
             return;
         const newClass = {
-            [source.name]: class extends source {
+            [sourceClass.name]: class extends sourceClass {
             },
-        }[source.name];
+        }[sourceClass.name];
         const newPath = metadata.path ? path_1.default.join(currentPath, metadata.path) : currentPath;
         const adapter = this;
         /** Inject exception filter */
         (0, common_1.UseFilters)(new opra_exception_filter_js_1.OpraExceptionFilter(adapter))(newClass);
         (0, common_1.Controller)()(newClass);
-        this.controllers.push(newClass);
+        this.nestControllers.push(newClass);
         if (metadata.operations) {
             for (const [k, v] of Object.entries(metadata.operations)) {
-                const operationHandler = source.prototype[k];
+                const operationHandler = sourceClass.prototype[k];
                 Object.defineProperty(newClass.prototype, k, {
                     writable: true,
                     /** NestJS handler method */
                     async value(_req) {
                         const api = adapter.document.api;
-                        const controller = api.findController(newClass);
+                        const controller = api.findController(sourceClass);
                         const operation = controller?.operations.get(k);
                         const context = (0, ts_gems_1.asMutable)(_req.opraContext);
-                        if (!(context && operation && typeof operationHandler === 'function'))
+                        if (!(context && operation && typeof operationHandler === 'function')) {
                             throw new common_2.NotFoundError({
                                 message: `No endpoint found for [${_req.method}]${_req.baseUrl}`,
                                 details: {
@@ -59,6 +87,7 @@ class OpraNestAdapter extends core_1.HttpAdapter {
                                     method: _req.method,
                                 },
                             });
+                        }
                         /** Configure the HttpContext */
                         context.adapter = adapter;
                         context.document = adapter.document;
@@ -114,6 +143,8 @@ class OpraNestAdapter extends core_1.HttpAdapter {
                         /** Call @Search decorator over new property */
                         (0, common_1.Search)(operationPath)(newClass.prototype, k, descriptor);
                         break;
+                    default:
+                        break;
                 }
             }
         }
@@ -121,7 +152,7 @@ class OpraNestAdapter extends core_1.HttpAdapter {
             for (const child of metadata.controllers) {
                 if (!(0, common_2.isConstructor)(child))
                     throw new TypeError('Controllers should be injectable a class');
-                this._createNestControllers(child, newPath);
+                this._addToNestControllers(child, newPath);
             }
         }
     }

package/esm/constants.js

@@ -0,0 +1 @@
+export const IS_PUBLIC_KEY = 'isPublic';

package/esm/decorators/public.decorator.js

@@ -0,0 +1,3 @@
+import { SetMetadata } from '@nestjs/common';
+import { IS_PUBLIC_KEY } from '../constants.js';
+export const Public = () => SetMetadata(IS_PUBLIC_KEY, true);

package/esm/index.js

@@ -1,4 +1,6 @@
 import 'reflect-metadata';
 import './augmentation/nestjs.augmentation.js';
+export * from './constants.js';
+export * from './decorators/public.decorator.js';
 export * from './opra-http.module.js';
 export * from './opra-nestjs-adapter.js';

package/esm/opra-http-core.module.js

@@ -1,8 +1,8 @@
 var OpraHttpCoreModule_1;
 import { __decorate, __metadata } from "tslib";
-import { asMutable } from 'ts-gems';
 import { Global, Module, RequestMethod, } from '@nestjs/common';
 import { ApiDocumentFactory } from '@opra/common';
+import { asMutable } from 'ts-gems';
 import { OpraNestAdapter } from './opra-nestjs-adapter.js';
 import { OpraMiddleware } from './services/opra-middleware.js';
 let OpraHttpCoreModule = OpraHttpCoreModule_1 = class OpraHttpCoreModule {
@@ -15,32 +15,33 @@ let OpraHttpCoreModule = OpraHttpCoreModule_1 = class OpraHttpCoreModule {
             method: RequestMethod.ALL,
         });
     }
-    static forRoot(options) {
-        const opraAdapter = new OpraNestAdapter(options);
-        const token = options?.id || OpraNestAdapter;
+    static forRoot(init, options) {
+        const opraAdapter = new OpraNestAdapter(init, options);
+        const token = init?.id || OpraNestAdapter;
         const providers = [
-            ...(options?.providers || []),
+            ...(init?.providers || []),
             {
                 provide: OpraNestAdapter,
                 useFactory: async () => {
                     asMutable(opraAdapter).document = await ApiDocumentFactory.createDocument({
-                        ...options,
-                        api: { protocol: 'http', name: options.name, controllers: opraAdapter.controllers },
+                        ...init,
+                        api: { protocol: 'http', name: init.name, controllers: init.controllers },
                     });
                     return opraAdapter;
                 },
             },
         ];
-        if (token !== OpraNestAdapter)
+        if (token !== OpraNestAdapter) {
             providers.push({
                 provide: token,
                 useValue: opraAdapter,
             });
+        }
         return {
             module: OpraHttpCoreModule_1,
-            controllers: opraAdapter.controllers,
-            imports: [...(options?.imports || [])],
-            exports: [...(options?.exports || []), token],
+            controllers: opraAdapter.nestControllers,
+            imports: [...(init?.imports || [])],
+            exports: [...(init?.exports || []), token],
             providers,
         };
     }

package/esm/opra-http.module.js

@@ -5,12 +5,13 @@ import { OpraHttpCoreModule } from './opra-http-core.module.js';
 let OpraHttpModule = OpraHttpModule_1 = class OpraHttpModule {
     /**
      *
+     * @param init
      * @param options
      */
-    static forRoot(options) {
+    static forRoot(init, options) {
         return {
             module: OpraHttpModule_1,
-            imports: [OpraHttpCoreModule.forRoot(options)],
+            imports: [OpraHttpCoreModule.forRoot(init, options)],
         };
     }
 };

package/esm/opra-nestjs-adapter.js

@@ -1,53 +1,82 @@
-import nodePath from 'path';
-import { asMutable } from 'ts-gems';
-import { Controller, Delete, Get, Head, Options, Patch, Post, Put, Req, Res, Search, UseFilters, } from '@nestjs/common';
+import { __decorate, __metadata, __param } from "tslib";
+import { Controller, Delete, Get, Head, Next, Options, Patch, Post, Put, Req, Res, Search, UseFilters, } from '@nestjs/common';
 import { ApiDocument, HTTP_CONTROLLER_METADATA, HttpApi, isConstructor, NotFoundError, } from '@opra/common';
 import { HttpAdapter } from '@opra/core';
+import nodePath from 'path';
+import { asMutable } from 'ts-gems';
+import { Public } from './decorators/public.decorator';
 import { OpraExceptionFilter } from './services/opra-exception-filter.js';
 export const kHandler = Symbol.for('kHandler');
 export class OpraNestAdapter extends HttpAdapter {
-    constructor(options) {
+    constructor(init, options) {
         super((function () {
             const document = new ApiDocument();
             document.api = new HttpApi(document);
             return document;
         })(), options);
-        this.controllers = [];
-        let basePath = options.basePath || '/';
+        this.nestControllers = [];
+        this.options = options;
+        let basePath = options?.basePath || '/';
         if (!basePath.startsWith('/'))
             basePath = '/' + basePath;
-        if (options.controllers)
-            options.controllers.forEach(c => this._createNestControllers(c, basePath));
+        this._addRootController(basePath);
+        if (init.controllers)
+            init.controllers.forEach(c => this._addToNestControllers(c, basePath));
     }
     async close() {
         //
     }
-    _createNestControllers(source, currentPath) {
-        const metadata = Reflect.getMetadata(HTTP_CONTROLLER_METADATA, source);
+    _addRootController(basePath) {
+        const _this = this;
+        let RootController = class RootController {
+            schema(_req, next) {
+                _this[kHandler].sendDocumentSchema(_req.opraContext).catch(next);
+            }
+        };
+        __decorate([
+            Get('/\\$schema'),
+            __param(0, Req()),
+            __param(1, Next()),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object, Function]),
+            __metadata("design:returntype", void 0)
+        ], RootController.prototype, "schema", null);
+        RootController = __decorate([
+            Controller({
+                path: basePath,
+            })
+        ], RootController);
+        if (this.options?.schemaRouteIsPublic) {
+            Public()(RootController.prototype, 'schema', Object.getOwnPropertyDescriptor(RootController.prototype, 'schema'));
+        }
+        this.nestControllers.push(RootController);
+    }
+    _addToNestControllers(sourceClass, currentPath) {
+        const metadata = Reflect.getMetadata(HTTP_CONTROLLER_METADATA, sourceClass);
         if (!metadata)
             return;
         const newClass = {
-            [source.name]: class extends source {
+            [sourceClass.name]: class extends sourceClass {
             },
-        }[source.name];
+        }[sourceClass.name];
         const newPath = metadata.path ? nodePath.join(currentPath, metadata.path) : currentPath;
         const adapter = this;
         /** Inject exception filter */
         UseFilters(new OpraExceptionFilter(adapter))(newClass);
         Controller()(newClass);
-        this.controllers.push(newClass);
+        this.nestControllers.push(newClass);
         if (metadata.operations) {
             for (const [k, v] of Object.entries(metadata.operations)) {
-                const operationHandler = source.prototype[k];
+                const operationHandler = sourceClass.prototype[k];
                 Object.defineProperty(newClass.prototype, k, {
                     writable: true,
                     /** NestJS handler method */
                     async value(_req) {
                         const api = adapter.document.api;
-                        const controller = api.findController(newClass);
+                        const controller = api.findController(sourceClass);
                         const operation = controller?.operations.get(k);
                         const context = asMutable(_req.opraContext);
-                        if (!(context && operation && typeof operationHandler === 'function'))
+                        if (!(context && operation && typeof operationHandler === 'function')) {
                             throw new NotFoundError({
                                 message: `No endpoint found for [${_req.method}]${_req.baseUrl}`,
                                 details: {
@@ -55,6 +84,7 @@ export class OpraNestAdapter extends HttpAdapter {
                                     method: _req.method,
                                 },
                             });
+                        }
                         /** Configure the HttpContext */
                         context.adapter = adapter;
                         context.document = adapter.document;
@@ -110,6 +140,8 @@ export class OpraNestAdapter extends HttpAdapter {
                         /** Call @Search decorator over new property */
                         Search(operationPath)(newClass.prototype, k, descriptor);
                         break;
+                    default:
+                        break;
                 }
             }
         }
@@ -117,7 +149,7 @@ export class OpraNestAdapter extends HttpAdapter {
             for (const child of metadata.controllers) {
                 if (!isConstructor(child))
                     throw new TypeError('Controllers should be injectable a class');
-                this._createNestControllers(child, newPath);
+                this._addToNestControllers(child, newPath);
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/nestjs",
-  "version": "1.0.0-alpha.7",
+  "version": "1.0.0-alpha.9",
   "description": "Opra NestJS module",
   "author": "Panates",
   "license": "MIT",
@@ -27,21 +27,23 @@
     "clean:cover": "rimraf ../../coverage/client"
   },
   "dependencies": {
-    "@opra/common": "^1.0.0-alpha.7",
-    "@opra/core": "^1.0.0-alpha.7",
+    "@opra/common": "^1.0.0-alpha.9",
+    "@opra/core": "^1.0.0-alpha.9",
     "fast-tokenizer": "^1.3.0",
     "lodash.head": "^4.0.1",
     "reflect-metadata": "^0.2.2"
   },
   "peerDependencies": {
-    "@nestjs/common": "^10.3.9",
-    "@nestjs/core": "^10.3.9"
+    "@nestjs/common": "^10.3.10",
+    "@nestjs/core": "^10.3.10"
   },
   "devDependencies": {
-    "@nestjs/platform-express": "^10.3.9",
-    "@nestjs/testing": "^10.3.9",
+    "@nestjs/platform-express": "^10.3.10",
+    "@nestjs/testing": "^10.3.10",
     "@types/lodash.head": "^4.0.9",
     "filedirname": "^3.4.0",
+    "rxjs": "^7.8.1",
+    "supertest": "^7.0.0",
     "ts-gems": "^3.4.0"
   },
   "type": "module",

package/types/constants.d.ts

@@ -0,0 +1 @@
+export declare const IS_PUBLIC_KEY = "isPublic";

package/types/decorators/public.decorator.d.ts

@@ -0,0 +1 @@
+export declare const Public: () => import("@nestjs/common").CustomDecorator<string>;

package/types/index.d.ts

@@ -1,4 +1,6 @@
 import 'reflect-metadata';
 import './augmentation/nestjs.augmentation.js';
+export * from './constants.js';
+export * from './decorators/public.decorator.js';
 export * from './opra-http.module.js';
 export * from './opra-nestjs-adapter.js';

package/types/opra-http-core.module.d.ts

@@ -5,6 +5,6 @@ export declare class OpraHttpCoreModule implements OnModuleDestroy, NestModule {
     protected opraAdapter: OpraNestAdapter;
     constructor(opraAdapter: OpraNestAdapter);
     configure(consumer: MiddlewareConsumer): void;
-    static forRoot(options: OpraHttpModule.Options): DynamicModule;
+    static forRoot(init: OpraHttpModule.Initiator, options?: OpraHttpModule.Options): DynamicModule;
     onModuleDestroy(): Promise<void>;
 }

package/types/opra-http.module.d.ts

@@ -1,16 +1,20 @@
 import { DynamicModule } from '@nestjs/common';
 import { ApiDocumentFactory } from '@opra/common';
 export declare namespace OpraHttpModule {
-    interface Options extends Pick<DynamicModule, 'imports' | 'providers' | 'exports' | 'controllers'>, Pick<ApiDocumentFactory.InitArguments, 'types' | 'references' | 'info'> {
+    interface Initiator extends Pick<DynamicModule, 'imports' | 'providers' | 'exports' | 'controllers'>, Pick<ApiDocumentFactory.InitArguments, 'types' | 'references' | 'info'> {
         id?: any;
         name: string;
+    }
+    interface Options {
         basePath?: string;
+        schemaRouteIsPublic?: boolean;
     }
 }
 export declare class OpraHttpModule {
     /**
      *
+     * @param init
      * @param options
      */
-    static forRoot(options: OpraHttpModule.Options): DynamicModule;
+    static forRoot(init: OpraHttpModule.Initiator, options?: OpraHttpModule.Options): DynamicModule;
 }

package/types/opra-nestjs-adapter.d.ts

@@ -3,8 +3,10 @@ import { HttpAdapter } from '@opra/core';
 import type { OpraHttpModule } from './opra-http.module';
 export declare const kHandler: unique symbol;
 export declare class OpraNestAdapter extends HttpAdapter {
-    readonly controllers: Type[];
-    constructor(options: OpraHttpModule.Options);
+    readonly nestControllers: Type[];
+    readonly options?: OpraHttpModule.Options;
+    constructor(init: OpraHttpModule.Initiator, options?: OpraHttpModule.Options);
     close(): Promise<void>;
-    protected _createNestControllers(source: Type, currentPath: string): void;
+    protected _addRootController(basePath: string): void;
+    protected _addToNestControllers(sourceClass: Type, currentPath: string): void;
 }

package/types/services/opra-middleware.d.ts

@@ -1,5 +1,5 @@
-import type { NextFunction, Request, Response } from 'express';
 import { NestMiddleware } from '@nestjs/common';
+import type { NextFunction, Request, Response } from 'express';
 export declare class OpraMiddleware implements NestMiddleware {
     use(req: Request, res: Response, next: NextFunction): void;
 }