@opra/nestjs 0.24.2 → 0.25.0

package/cjs/constants.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PARAM_ARGS_METADATA = exports.OPRA_INITIALIZER = exports.OPRA_MODULE_ID = exports.OPRA_MODULE_OPTIONS = void 0;
+exports.PARAM_ARGS_METADATA = exports.kAdapter = exports.kOptions = exports.OPRA_INITIALIZER = exports.OPRA_MODULE_ID = exports.OPRA_MODULE_OPTIONS = void 0;
 exports.OPRA_MODULE_OPTIONS = 'opra:module_options';
 exports.OPRA_MODULE_ID = 'opra:module_id';
 exports.OPRA_INITIALIZER = 'opra_initializer';
+exports.kOptions = Symbol('kOptions');
+exports.kAdapter = Symbol('kAdapter');
 exports.PARAM_ARGS_METADATA = '__routeArguments__';

package/cjs/index.js

@@ -6,3 +6,4 @@ require("./augmentation/common-decorator.augmentation.js");
 tslib_1.__exportStar(require("./opra.module.js"), exports);
 tslib_1.__exportStar(require("./decorators/context.decorator.js"), exports);
 tslib_1.__exportStar(require("./interfaces/opra-module-options.interface.js"), exports);
+tslib_1.__exportStar(require("./opra-module-ref.js"), exports);

package/cjs/opra-core.module.js

@@ -9,31 +9,40 @@ const core_1 = require("@nestjs/core");
 const metadata_scanner_1 = require("@nestjs/core/metadata-scanner");
 const constants_js_1 = require("./constants.js");
 const opra_api_factory_js_1 = require("./factories/opra-api.factory.js");
+const opra_module_ref_js_1 = require("./opra-module-ref.js");
 const nest_explorer_js_1 = require("./services/nest-explorer.js");
 const opra_api_loader_js_1 = require("./services/opra-api-loader.js");
 let OpraCoreModule = exports.OpraCoreModule = OpraCoreModule_1 = class OpraCoreModule {
-    constructor(httpAdapterHost, modulesContainer, options, opraServiceLoader) {
+    constructor(httpAdapterHost, modulesContainer, options, apiLoader) {
         this.httpAdapterHost = httpAdapterHost;
         this.modulesContainer = modulesContainer;
         this.options = options;
-        this.opraServiceLoader = opraServiceLoader;
+        this.apiLoader = apiLoader;
     }
     static forRoot(options) {
+        const providers = [
+            ...(options.providers || []),
+            {
+                provide: constants_js_1.OPRA_MODULE_OPTIONS,
+                useValue: options,
+            },
+            {
+                provide: constants_js_1.OPRA_INITIALIZER,
+                useClass: opra_api_loader_js_1.OpraApiLoader
+            },
+            {
+                provide: options.id || opra_module_ref_js_1.OpraModuleRef,
+                inject: [constants_js_1.OPRA_INITIALIZER],
+                useFactory: (apiLoader) => {
+                    return apiLoader.opraModuleRef;
+                }
+            }
+        ];
         return {
             module: OpraCoreModule_1,
             imports: [...(options.imports || [])],
-            providers: [
-                ...(options.providers || []),
-                {
-                    provide: constants_js_1.OPRA_MODULE_OPTIONS,
-                    useValue: options,
-                },
-                {
-                    provide: constants_js_1.OPRA_INITIALIZER,
-                    useClass: opra_api_loader_js_1.OpraApiLoader
-                }
-            ],
-            exports: [...(options.exports || [])]
+            exports: [...(options.exports || [])],
+            providers
         };
     }
     static forRootAsync(asyncOptions) {
@@ -50,6 +59,13 @@ let OpraCoreModule = exports.OpraCoreModule = OpraCoreModule_1 = class OpraCoreM
                     provide: constants_js_1.OPRA_INITIALIZER,
                     useClass: opra_api_loader_js_1.OpraApiLoader
                 },
+                {
+                    provide: asyncOptions.id || opra_module_ref_js_1.OpraModuleRef,
+                    inject: [constants_js_1.OPRA_INITIALIZER],
+                    useFactory: (apiLoader) => {
+                        return apiLoader.opraModuleRef;
+                    }
+                },
                 ...this.createAsyncProviders(asyncOptions)
             ]
         };
@@ -100,11 +116,11 @@ let OpraCoreModule = exports.OpraCoreModule = OpraCoreModule_1 = class OpraCoreM
             }
         })();
         if (opraModule) {
-            await this.opraServiceLoader.initialize(opraModule);
+            await this.apiLoader.initialize(opraModule);
         }
     }
     async onModuleDestroy() {
-        await this.opraServiceLoader.stop();
+        await this.apiLoader.stop();
     }
 };
 exports.OpraCoreModule = OpraCoreModule = OpraCoreModule_1 = tslib_1.__decorate([
@@ -115,6 +131,7 @@ exports.OpraCoreModule = OpraCoreModule = OpraCoreModule_1 = tslib_1.__decorate(
             nest_explorer_js_1.NestExplorer
         ]
     }),
+    (0, common_1.Global)(),
     tslib_1.__param(2, (0, common_1.Inject)(constants_js_1.OPRA_MODULE_OPTIONS)),
     tslib_1.__param(3, (0, common_1.Inject)(constants_js_1.OPRA_INITIALIZER)),
     tslib_1.__metadata("design:paramtypes", [core_1.HttpAdapterHost,

package/cjs/opra-module-ref.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpraModuleRef = void 0;
+const constants_js_1 = require("./constants.js");
+class OpraModuleRef {
+    get adapter() {
+        return this[constants_js_1.kAdapter];
+    }
+    get api() {
+        return this[constants_js_1.kAdapter].api;
+    }
+    get options() {
+        return this[constants_js_1.kOptions];
+    }
+}
+exports.OpraModuleRef = OpraModuleRef;

package/cjs/services/opra-api-loader.js

@@ -8,15 +8,18 @@ const common_2 = require("@opra/common");
 const core_2 = require("@opra/core");
 const constants_js_1 = require("../constants.js");
 const opra_api_factory_js_1 = require("../factories/opra-api.factory.js");
+const opra_module_ref_js_1 = require("../opra-module-ref.js");
 class OpraApiLoader {
     constructor() {
         this.logger = new common_1.Logger(OpraApiLoader.name, { timestamp: true });
+        this.opraModuleRef = new opra_module_ref_js_1.OpraModuleRef();
     }
     async initialize(rootModule) {
         const httpAdapter = this.httpAdapterHost?.httpAdapter;
         const globalPrefix = this.applicationConfig.getGlobalPrefix();
         const platformName = httpAdapter.getType();
-        const moduleOptions = this.opraModuleOptions;
+        const moduleOptions = this.options;
+        this.opraModuleRef[constants_js_1.kOptions] = this.options;
         let prefixPath = new common_2.OpraURLPath((moduleOptions.useGlobalPrefix !== false ? globalPrefix : ''));
         if (moduleOptions.basePath)
             prefixPath = prefixPath.join(moduleOptions.basePath);
@@ -26,13 +29,13 @@ class OpraApiLoader {
             basePath: prefixPath.toString()
         };
         try {
-            const serviceHost = await this.opraFactory.generateService(rootModule, options, 'http');
-            if (!serviceHost.resources.size) {
+            const apiDocument = await this.opraFactory.generateService(rootModule, options, 'http');
+            if (!apiDocument.resources.size) {
                 this.logger.warn(`No Sources found (${name})`);
                 return;
             }
             if (platformName === 'express') {
-                this.adapter = await this.registerExpress(serviceHost, options);
+                this.opraModuleRef[constants_js_1.kAdapter] = await this.registerExpress(apiDocument, options);
                 // else if (platformName === 'fastify')
                 // await this.registerFastify();
             }
@@ -49,13 +52,14 @@ class OpraApiLoader {
     async stop() {
         //
     }
-    async registerExpress(service, moduleOptions) {
+    async registerExpress(apiDocument, moduleOptions) {
         const httpAdapter = this.httpAdapterHost.httpAdapter;
+        /* istanbul ignore next */
         if (!httpAdapter)
-            return;
+            throw new Error('HttpAdapterHost is not initialized');
         const app = httpAdapter.getInstance();
-        const logger = moduleOptions.logger || new common_1.Logger(service.info.title);
-        return await core_2.ExpressAdapter.create(app, service, {
+        const logger = moduleOptions.logger || new common_1.Logger(apiDocument.info.title);
+        return await core_2.ExpressAdapter.create(app, apiDocument, {
             ...moduleOptions,
             logger,
         });
@@ -77,4 +81,4 @@ tslib_1.__decorate([
 tslib_1.__decorate([
     (0, common_1.Inject)(constants_js_1.OPRA_MODULE_OPTIONS),
     tslib_1.__metadata("design:type", Object)
-], OpraApiLoader.prototype, "opraModuleOptions", void 0);
+], OpraApiLoader.prototype, "options", void 0);

package/esm/constants.js

@@ -1,4 +1,6 @@
 export const OPRA_MODULE_OPTIONS = 'opra:module_options';
 export const OPRA_MODULE_ID = 'opra:module_id';
 export const OPRA_INITIALIZER = 'opra_initializer';
+export const kOptions = Symbol('kOptions');
+export const kAdapter = Symbol('kAdapter');
 export const PARAM_ARGS_METADATA = '__routeArguments__';

package/esm/index.js

@@ -3,3 +3,4 @@ import './augmentation/common-decorator.augmentation.js';
 export * from './opra.module.js';
 export * from './decorators/context.decorator.js';
 export * from './interfaces/opra-module-options.interface.js';
+export * from './opra-module-ref.js';

package/esm/opra-core.module.js

@@ -1,36 +1,45 @@
 var OpraCoreModule_1;
 import { __decorate, __metadata, __param } from "tslib";
 import * as crypto from 'crypto';
-import { Inject, Module } from '@nestjs/common';
+import { Global, Inject, Module } from '@nestjs/common';
 import { HttpAdapterHost, ModulesContainer } from '@nestjs/core';
 import { MetadataScanner } from '@nestjs/core/metadata-scanner';
 import { OPRA_INITIALIZER, OPRA_MODULE_ID, OPRA_MODULE_OPTIONS } from './constants.js';
 import { OpraApiFactory } from './factories/opra-api.factory.js';
+import { OpraModuleRef } from './opra-module-ref.js';
 import { NestExplorer } from './services/nest-explorer.js';
 import { OpraApiLoader } from './services/opra-api-loader.js';
 export let OpraCoreModule = OpraCoreModule_1 = class OpraCoreModule {
-    constructor(httpAdapterHost, modulesContainer, options, opraServiceLoader) {
+    constructor(httpAdapterHost, modulesContainer, options, apiLoader) {
         this.httpAdapterHost = httpAdapterHost;
         this.modulesContainer = modulesContainer;
         this.options = options;
-        this.opraServiceLoader = opraServiceLoader;
+        this.apiLoader = apiLoader;
     }
     static forRoot(options) {
+        const providers = [
+            ...(options.providers || []),
+            {
+                provide: OPRA_MODULE_OPTIONS,
+                useValue: options,
+            },
+            {
+                provide: OPRA_INITIALIZER,
+                useClass: OpraApiLoader
+            },
+            {
+                provide: options.id || OpraModuleRef,
+                inject: [OPRA_INITIALIZER],
+                useFactory: (apiLoader) => {
+                    return apiLoader.opraModuleRef;
+                }
+            }
+        ];
         return {
             module: OpraCoreModule_1,
             imports: [...(options.imports || [])],
-            providers: [
-                ...(options.providers || []),
-                {
-                    provide: OPRA_MODULE_OPTIONS,
-                    useValue: options,
-                },
-                {
-                    provide: OPRA_INITIALIZER,
-                    useClass: OpraApiLoader
-                }
-            ],
-            exports: [...(options.exports || [])]
+            exports: [...(options.exports || [])],
+            providers
         };
     }
     static forRootAsync(asyncOptions) {
@@ -47,6 +56,13 @@ export let OpraCoreModule = OpraCoreModule_1 = class OpraCoreModule {
                     provide: OPRA_INITIALIZER,
                     useClass: OpraApiLoader
                 },
+                {
+                    provide: asyncOptions.id || OpraModuleRef,
+                    inject: [OPRA_INITIALIZER],
+                    useFactory: (apiLoader) => {
+                        return apiLoader.opraModuleRef;
+                    }
+                },
                 ...this.createAsyncProviders(asyncOptions)
             ]
         };
@@ -97,11 +113,11 @@ export let OpraCoreModule = OpraCoreModule_1 = class OpraCoreModule {
             }
         })();
         if (opraModule) {
-            await this.opraServiceLoader.initialize(opraModule);
+            await this.apiLoader.initialize(opraModule);
         }
     }
     async onModuleDestroy() {
-        await this.opraServiceLoader.stop();
+        await this.apiLoader.stop();
     }
 };
 OpraCoreModule = OpraCoreModule_1 = __decorate([
@@ -112,6 +128,7 @@ OpraCoreModule = OpraCoreModule_1 = __decorate([
             NestExplorer
         ]
     }),
+    Global(),
     __param(2, Inject(OPRA_MODULE_OPTIONS)),
     __param(3, Inject(OPRA_INITIALIZER)),
     __metadata("design:paramtypes", [HttpAdapterHost,

package/esm/opra-module-ref.js

@@ -0,0 +1,12 @@
+import { kAdapter, kOptions } from './constants.js';
+export class OpraModuleRef {
+    get adapter() {
+        return this[kAdapter];
+    }
+    get api() {
+        return this[kAdapter].api;
+    }
+    get options() {
+        return this[kOptions];
+    }
+}

package/esm/services/opra-api-loader.js

@@ -3,17 +3,20 @@ import { Inject, Logger } from '@nestjs/common';
 import { ApplicationConfig, HttpAdapterHost } from '@nestjs/core';
 import { OpraURLPath } from '@opra/common';
 import { ExpressAdapter } from '@opra/core';
-import { OPRA_MODULE_OPTIONS } from '../constants.js';
+import { kAdapter, kOptions, OPRA_MODULE_OPTIONS } from '../constants.js';
 import { OpraApiFactory } from '../factories/opra-api.factory.js';
+import { OpraModuleRef } from '../opra-module-ref.js';
 export class OpraApiLoader {
     constructor() {
         this.logger = new Logger(OpraApiLoader.name, { timestamp: true });
+        this.opraModuleRef = new OpraModuleRef();
     }
     async initialize(rootModule) {
         const httpAdapter = this.httpAdapterHost?.httpAdapter;
         const globalPrefix = this.applicationConfig.getGlobalPrefix();
         const platformName = httpAdapter.getType();
-        const moduleOptions = this.opraModuleOptions;
+        const moduleOptions = this.options;
+        this.opraModuleRef[kOptions] = this.options;
         let prefixPath = new OpraURLPath((moduleOptions.useGlobalPrefix !== false ? globalPrefix : ''));
         if (moduleOptions.basePath)
             prefixPath = prefixPath.join(moduleOptions.basePath);
@@ -23,13 +26,13 @@ export class OpraApiLoader {
             basePath: prefixPath.toString()
         };
         try {
-            const serviceHost = await this.opraFactory.generateService(rootModule, options, 'http');
-            if (!serviceHost.resources.size) {
+            const apiDocument = await this.opraFactory.generateService(rootModule, options, 'http');
+            if (!apiDocument.resources.size) {
                 this.logger.warn(`No Sources found (${name})`);
                 return;
             }
             if (platformName === 'express') {
-                this.adapter = await this.registerExpress(serviceHost, options);
+                this.opraModuleRef[kAdapter] = await this.registerExpress(apiDocument, options);
                 // else if (platformName === 'fastify')
                 // await this.registerFastify();
             }
@@ -46,13 +49,14 @@ export class OpraApiLoader {
     async stop() {
         //
     }
-    async registerExpress(service, moduleOptions) {
+    async registerExpress(apiDocument, moduleOptions) {
         const httpAdapter = this.httpAdapterHost.httpAdapter;
+        /* istanbul ignore next */
         if (!httpAdapter)
-            return;
+            throw new Error('HttpAdapterHost is not initialized');
         const app = httpAdapter.getInstance();
-        const logger = moduleOptions.logger || new Logger(service.info.title);
-        return await ExpressAdapter.create(app, service, {
+        const logger = moduleOptions.logger || new Logger(apiDocument.info.title);
+        return await ExpressAdapter.create(app, apiDocument, {
             ...moduleOptions,
             logger,
         });
@@ -73,4 +77,4 @@ __decorate([
 __decorate([
     Inject(OPRA_MODULE_OPTIONS),
     __metadata("design:type", Object)
-], OpraApiLoader.prototype, "opraModuleOptions", void 0);
+], OpraApiLoader.prototype, "options", void 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/nestjs",
-  "version": "0.24.2",
+  "version": "0.25.0",
   "description": "Opra NestJS module",
   "author": "Panates",
   "license": "MIT",
@@ -25,8 +25,8 @@
     "clean:cover": "rimraf ../../coverage/nestjs"
   },
   "dependencies": {
-    "@opra/common": "^0.24.2",
-    "@opra/core": "^0.24.2",
+    "@opra/common": "^0.25.0",
+    "@opra/core": "^0.25.0",
     "fast-tokenizer": "^1.2.2",
     "lodash.head": "^4.0.1",
     "lodash.identity": "^3.0.0",
@@ -43,15 +43,9 @@
     "ts-gems": "^2.4.1"
   },
   "type": "module",
-  "types": "types/index.d.ts",
-  "exports": {
-    ".": {
-      "require": "./cjs/index.js",
-      "default": "./esm/index.js"
-    },
-    "./cjs": "./cjs/index.js",
-    "./esm": "./esm/index.js"
-  },
+  "module": "./esm/index.js",
+  "main": "./cjs/index.js",
+  "types": "./types/index.d.ts",
   "engines": {
     "node": ">=16.0",
     "npm": ">=7.0.0"

package/types/constants.d.ts

@@ -1,4 +1,6 @@
 export declare const OPRA_MODULE_OPTIONS = "opra:module_options";
 export declare const OPRA_MODULE_ID = "opra:module_id";
 export declare const OPRA_INITIALIZER = "opra_initializer";
+export declare const kOptions: unique symbol;
+export declare const kAdapter: unique symbol;
 export declare const PARAM_ARGS_METADATA = "__routeArguments__";

package/types/index.d.ts

@@ -3,3 +3,4 @@ import './augmentation/common-decorator.augmentation.js';
 export * from './opra.module.js';
 export * from './decorators/context.decorator.js';
 export * from './interfaces/opra-module-options.interface.js';
+export * from './opra-module-ref.js';

package/types/interfaces/opra-module-options.interface.d.ts

@@ -2,18 +2,22 @@ import { ModuleMetadata, Type } from '@nestjs/common';
 import { OpraSchema } from '@opra/common';
 import { HttpAdapter } from '@opra/core';
 export type OpraModuleOptions = HttpAdapter.Options & {
+    id?: any;
     info?: OpraSchema.DocumentInfo;
     /**
      * @default true
      */
     useGlobalPrefix?: boolean;
 };
+type OpraModuleOptionsWithoutId = Omit<OpraModuleOptions, 'id'>;
 export interface OpraModuleOptionsFactory {
-    createOptions(): Promise<OpraModuleOptions> | OpraModuleOptions;
+    createOptions(): Promise<OpraModuleOptionsWithoutId> | OpraModuleOptionsWithoutId;
 }
 export interface OpraModuleAsyncOptions extends Pick<ModuleMetadata, 'imports' | 'providers'> {
+    id?: any;
     useExisting?: Type<OpraModuleOptionsFactory>;
     useClass?: Type<OpraModuleOptionsFactory>;
-    useFactory?: (...args: any[]) => Promise<OpraModuleOptions> | OpraModuleOptions;
+    useFactory?: (...args: any[]) => Promise<OpraModuleOptionsWithoutId> | OpraModuleOptionsWithoutId;
     inject?: any[];
 }
+export {};

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

@@ -6,8 +6,8 @@ export declare class OpraCoreModule implements OnModuleInit, OnModuleDestroy {
     private readonly httpAdapterHost;
     protected readonly modulesContainer: ModulesContainer;
     private readonly options;
-    private readonly opraServiceLoader;
-    constructor(httpAdapterHost: HttpAdapterHost, modulesContainer: ModulesContainer, options: OpraModuleOptions, opraServiceLoader: OpraApiLoader);
+    private readonly apiLoader;
+    constructor(httpAdapterHost: HttpAdapterHost, modulesContainer: ModulesContainer, options: OpraModuleOptions, apiLoader: OpraApiLoader);
     static forRoot(options: OpraModuleOptions & Pick<DynamicModule, 'imports' | 'providers' | 'exports'>): DynamicModule;
     static forRootAsync(asyncOptions: OpraModuleAsyncOptions): DynamicModule;
     private static createAsyncProviders;

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

@@ -0,0 +1,11 @@
+import { ApiDocument } from '@opra/common';
+import { PlatformAdapter } from '@opra/core';
+import { kAdapter, kOptions } from './constants.js';
+import { OpraModuleOptions } from './interfaces/opra-module-options.interface.js';
+export declare class OpraModuleRef {
+    protected [kOptions]: OpraModuleOptions;
+    protected [kAdapter]: PlatformAdapter;
+    get adapter(): PlatformAdapter;
+    get api(): ApiDocument;
+    get options(): OpraModuleOptions;
+}

package/types/services/opra-api-loader.d.ts

@@ -2,17 +2,18 @@ import { Logger } from '@nestjs/common';
 import { ApplicationConfig, HttpAdapterHost } from '@nestjs/core';
 import { Module } from '@nestjs/core/injector/module.js';
 import { ApiDocument } from '@opra/common';
-import { ExpressAdapter, PlatformAdapter } from '@opra/core';
+import { ExpressAdapter } from '@opra/core';
 import { OpraApiFactory } from '../factories/opra-api.factory.js';
 import { OpraModuleOptions } from '../interfaces/opra-module-options.interface.js';
+import { OpraModuleRef } from '../opra-module-ref.js';
 export declare class OpraApiLoader {
     protected readonly logger: Logger;
-    protected adapter: PlatformAdapter | undefined;
+    readonly opraModuleRef: OpraModuleRef;
     protected readonly httpAdapterHost: HttpAdapterHost;
     protected readonly applicationConfig: ApplicationConfig;
     protected readonly opraFactory: OpraApiFactory;
-    protected readonly opraModuleOptions: OpraModuleOptions;
+    protected readonly options: OpraModuleOptions;
     initialize(rootModule: Module): Promise<void>;
     stop(): Promise<void>;
-    protected registerExpress(service: ApiDocument, moduleOptions: OpraModuleOptions): Promise<ExpressAdapter | undefined>;
+    protected registerExpress(apiDocument: ApiDocument, moduleOptions: OpraModuleOptions): Promise<ExpressAdapter>;
 }