@nest-forge/core 0.0.1 → 0.0.2

package/dist/architecture/component.d.ts

@@ -0,0 +1,7 @@
+export declare abstract class ForgeBaseComponent {
+    protected onModuleInit(): any;
+    protected onApplicationBootstrap(): any;
+    protected onModuleDestroy(signal: string): any;
+    protected beforeApplicationShutdown(signal: string): any;
+    protected onApplicationShutdown(signal: string): any;
+}

package/dist/architecture/component.js

@@ -0,0 +1,24 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForgeBaseComponent = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const constants_1 = require("../constants");
+const core_1 = require("@nestjs/core");
+class ForgeBaseComponent {
+    /**
+     * @internal
+     */
+    [_a = constants_1.FORGE_FIELD_MODULE_REF];
+    onModuleInit() { }
+    onApplicationBootstrap() { }
+    onModuleDestroy(signal) { }
+    beforeApplicationShutdown(signal) { }
+    onApplicationShutdown(signal) { }
+}
+exports.ForgeBaseComponent = ForgeBaseComponent;
+tslib_1.__decorate([
+    (0, common_1.Inject)(core_1.ModuleRef),
+    tslib_1.__metadata("design:type", core_1.ModuleRef)
+], ForgeBaseComponent.prototype, _a, void 0);

package/dist/architecture/controller.d.ts

@@ -0,0 +1,3 @@
+import { ForgeBaseComponent } from './component';
+export declare abstract class ForgeController extends ForgeBaseComponent {
+}

package/dist/architecture/controller.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForgeController = void 0;
+const component_1 = require("./component");
+class ForgeController extends component_1.ForgeBaseComponent {
+}
+exports.ForgeController = ForgeController;

package/dist/architecture/index.d.ts

@@ -0,0 +1,4 @@
+export * from './component';
+export * from './module';
+export * from './controller';
+export * from './service';

package/dist/architecture/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./component"), exports);
+tslib_1.__exportStar(require("./module"), exports);
+tslib_1.__exportStar(require("./controller"), exports);
+tslib_1.__exportStar(require("./service"), exports);

package/dist/architecture/module.d.ts

@@ -0,0 +1,5 @@
+import { MiddlewareConsumer } from '@nestjs/common';
+import { ForgeBaseComponent } from './component';
+export declare abstract class ForgeModule extends ForgeBaseComponent {
+    configure(consumer: MiddlewareConsumer): any;
+}

package/dist/architecture/module.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForgeModule = void 0;
+const component_1 = require("./component");
+class ForgeModule extends component_1.ForgeBaseComponent {
+    configure(consumer) { }
+}
+exports.ForgeModule = ForgeModule;

package/dist/architecture/service.d.ts

@@ -0,0 +1,3 @@
+import { ForgeBaseComponent } from './component';
+export declare abstract class ForgeService extends ForgeBaseComponent {
+}

package/dist/architecture/service.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForgeService = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const component_1 = require("./component");
+let ForgeService = class ForgeService extends component_1.ForgeBaseComponent {
+};
+exports.ForgeService = ForgeService;
+exports.ForgeService = ForgeService = tslib_1.__decorate([
+    (0, common_1.Injectable)()
+], ForgeService);

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const FORGE_ROOT_MODULE: unique symbol;
+export declare const FORGE_FIELD_MODULE_REF: unique symbol;
+export declare const FORGE_TOKEN_ROOT_MODULE: unique symbol;

package/dist/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FORGE_TOKEN_ROOT_MODULE = exports.FORGE_FIELD_MODULE_REF = exports.FORGE_ROOT_MODULE = void 0;
+exports.FORGE_ROOT_MODULE = Symbol('FORGE_ROOT_MODULE');
+exports.FORGE_FIELD_MODULE_REF = Symbol('FORGE_FIELD_MODULE_REF');
+exports.FORGE_TOKEN_ROOT_MODULE = Symbol('FORGE_TOKEN_ROOT_MODULE');

package/dist/extensions/extension.d.ts

@@ -1,4 +1,5 @@
-import { INestApplication, INestApplicationContext, MiddlewareConsumer, ModuleMetadata } from '@nestjs/common';
+import { INestApplication, INestApplicationContext, INestMicroservice, MiddlewareConsumer, ModuleMetadata } from '@nestjs/common';
+import { ForgeController, ForgeModule, ForgeService } from '../architecture';
 export declare abstract class ForgeExtension {
     /**
      * The metdata for this extension.
@@ -13,9 +14,13 @@ export declare abstract class ForgeExtension {
      */
     configureHttpApplication(application: INestApplication): any;
     /**
-     * Configures a Nest application context. This is
+     * Configures a Nest application context. This is for a standalone application that has no web server.
      */
     configureStandaloneApplication(context: INestApplicationContext): any;
+    /**
+     * Configures a Nest microservice context.
+     */
+    configureMicroserviceApplication(context: INestMicroservice): any;
     /**
      * Configures the root module of the application.
      */
@@ -25,6 +30,18 @@ export declare abstract class ForgeExtension {
      * queried.
      */
     instrument(instance: unknown): any;
+    /**
+     * Augments a `ForgeModule` instance.
+     */
+    augmentModule(instance: ForgeModule, moduleRef: any): any;
+    /**
+     * Augments a `ForgeController` instance.
+     */
+    augmentController(instance: ForgeController, moduleRef: any): any;
+    /**
+     * Augments a `ForgeService` instance.
+     */
+    augmentService(instance: ForgeService, moduleRef: any): any;
     /**
      * Returns the metadata for this extension.
      */

package/dist/extensions/extension.js

@@ -17,9 +17,13 @@ class ForgeExtension {
      */
     configureHttpApplication(application) { }
     /**
-     * Configures a Nest application context. This is
+     * Configures a Nest application context. This is for a standalone application that has no web server.
      */
     configureStandaloneApplication(context) { }
+    /**
+     * Configures a Nest microservice context.
+     */
+    configureMicroserviceApplication(context) { }
     /**
      * Configures the root module of the application.
      */
@@ -29,6 +33,18 @@ class ForgeExtension {
      * queried.
      */
     instrument(instance) { }
+    /**
+     * Augments a `ForgeModule` instance.
+     */
+    augmentModule(instance, moduleRef) { }
+    /**
+     * Augments a `ForgeController` instance.
+     */
+    augmentController(instance, moduleRef) { }
+    /**
+     * Augments a `ForgeService` instance.
+     */
+    augmentService(instance, moduleRef) { }
     /**
      * Returns the metadata for this extension.
      */

package/dist/forge-options.interface.d.ts

@@ -1,9 +1,13 @@
 import { NestApplicationOptions } from '@nestjs/common';
 import { ForgeExtensionResolvable } from './extensions';
 import { NestApplicationContextOptions } from '@nestjs/common/interfaces/nest-application-context-options.interface';
+import { NestMicroserviceOptions } from '@nestjs/common/interfaces/microservices/nest-microservice-options.interface';
 export interface ForgeApplicationOptions extends NestApplicationOptions {
     extensions?: ForgeExtensionResolvable | ForgeExtensionResolvable[];
 }
 export interface ForgeApplicationContextOptions extends NestApplicationContextOptions {
     extensions?: ForgeExtensionResolvable | ForgeExtensionResolvable[];
 }
+export interface ForgeMicroserviceOptions extends NestMicroserviceOptions {
+    extensions?: ForgeExtensionResolvable | ForgeExtensionResolvable[];
+}

package/dist/forge.factory.d.ts

@@ -1,21 +1,37 @@
 import { DynamicModule, ForwardReference, MiddlewareConsumer, Type } from '@nestjs/common';
-import { ForgeApplicationContextOptions, ForgeApplicationOptions } from './forge-options.interface';
+import { ForgeApplicationContextOptions, ForgeApplicationOptions, ForgeMicroserviceOptions } from './forge-options.interface';
 import { ForgeExtension, ForgeExtensionResolvable } from './extensions';
+import { ModuleRef } from '@nestjs/core';
+import { FORGE_ROOT_MODULE } from './constants';
+import { ForgeBaseComponent, ForgeController, ForgeModule, ForgeService } from './architecture';
 declare class Forge {
+    private _augmented;
     create(appModule: IEntryNestModule, options?: ForgeApplicationOptions): Promise<import("@nestjs/common").INestApplication<any>>;
     createApplicationContext(appModule: IEntryNestModule, options: ForgeApplicationContextOptions): Promise<import("@nestjs/common").INestApplicationContext>;
+    createMicroservice<T extends object>(appModule: IEntryNestModule, options: ForgeMicroserviceOptions & T): Promise<import("@nestjs/common").INestMicroservice>;
     protected discoverExtensions(resolvables: ForgeExtensionResolvable | ForgeExtensionResolvable[]): ForgeExtension[];
     protected resolveExtension(resolvable: ForgeExtensionResolvable): ForgeExtension;
     protected createRootModule(appModule: IEntryNestModule, extensions: ForgeExtension[]): {
-        new (): {
+        new (moduleRef: ModuleRef): {
+            readonly moduleRef: ModuleRef;
             configure(consumer: MiddlewareConsumer): void;
+            readonly [FORGE_ROOT_MODULE]: true;
         };
     };
-    protected createInstrument(extensions: ForgeExtension[], originalInstrument?: Instrument): Instrument;
+    protected createInstrument(extensions: ForgeExtension[], originalInstrument?: Instrument): InstrumentResponse;
+    protected augmentComponents(instances: ForgeBaseComponent[], extensions: ForgeExtension[]): void;
+    protected augmentModule(instance: ForgeModule, extensions: ForgeExtension[]): void;
+    protected augmentController(instance: ForgeController, extensions: ForgeExtension[]): void;
+    protected augmentService(instance: ForgeService, extensions: ForgeExtension[]): void;
+    protected _isRootModule(instance: unknown): instance is IForgeRootModule;
 }
 type IEntryNestModule = Type<any> | DynamicModule | ForwardReference | Promise<IEntryNestModule>;
 type Instrument = {
     instanceDecorator: (instance: unknown) => unknown;
 };
+interface InstrumentResponse {
+    instances: ForgeBaseComponent[];
+    instanceDecorator: (instance: unknown) => any;
+}
 declare const forge: Forge;
 export { forge as Forge };

package/dist/forge.factory.js

@@ -4,14 +4,21 @@ exports.Forge = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@nestjs/common");
 const core_1 = require("@nestjs/core");
+const constants_1 = require("./constants");
+const architecture_1 = require("./architecture");
 class Forge {
+    _augmented = new Set();
     async create(appModule, options) {
         const extensions = this.discoverExtensions(options?.extensions ?? []);
         const root = this.createRootModule(appModule, extensions);
+        const instrument = this.createInstrument(extensions, options.instrument);
         const app = await core_1.NestFactory.create(root, {
             ...options,
-            instrument: this.createInstrument(extensions, options.instrument),
+            instrument: {
+                instanceDecorator: instrument.instanceDecorator,
+            },
         });
+        this.augmentComponents(instrument.instances, extensions);
         for (const extension of extensions) {
             extension.configureHttpApplication(app);
         }
@@ -20,15 +27,35 @@ class Forge {
     async createApplicationContext(appModule, options) {
         const extensions = this.discoverExtensions(options?.extensions ?? []);
         const root = this.createRootModule(appModule, extensions);
+        const instrument = this.createInstrument(extensions, options.instrument);
         const app = await core_1.NestFactory.createApplicationContext(root, {
             ...options,
-            instrument: this.createInstrument(extensions, options.instrument),
+            instrument: {
+                instanceDecorator: instrument.instanceDecorator,
+            },
         });
+        this.augmentComponents(instrument.instances, extensions);
         for (const extension of extensions) {
             extension.configureStandaloneApplication(app);
         }
         return app;
     }
+    async createMicroservice(appModule, options) {
+        const extensions = this.discoverExtensions(options?.extensions ?? []);
+        const root = this.createRootModule(appModule, extensions);
+        const instrument = this.createInstrument(extensions, options.instrument);
+        const app = await core_1.NestFactory.createMicroservice(root, {
+            ...options,
+            instrument: {
+                instanceDecorator: instrument.instanceDecorator,
+            },
+        });
+        this.augmentComponents(instrument.instances, extensions);
+        for (const extension of extensions) {
+            extension.configureMicroserviceApplication(app);
+        }
+        return app;
+    }
     discoverExtensions(resolvables) {
         const extensions = new Map();
         if (!Array.isArray(resolvables)) {
@@ -62,7 +89,7 @@ class Forge {
     }
     createRootModule(appModule, extensions) {
         const meta = {
-            imports: [appModule],
+            imports: [],
             controllers: [],
             providers: [],
             exports: [],
@@ -74,7 +101,13 @@ class Forge {
             meta.providers.push(...(extensionMeta.providers ?? []));
             meta.exports.push(...(extensionMeta.exports ?? []));
         }
+        meta.imports.push(appModule);
         let ForgeRootModule = class ForgeRootModule {
+            moduleRef;
+            [constants_1.FORGE_ROOT_MODULE] = true;
+            constructor(moduleRef) {
+                this.moduleRef = moduleRef;
+            }
             configure(consumer) {
                 for (const extension of extensions) {
                     extension.configureRootModule(consumer);
@@ -82,14 +115,39 @@ class Forge {
             }
         };
         ForgeRootModule = tslib_1.__decorate([
-            (0, common_1.Module)(meta)
+            (0, common_1.Module)(meta),
+            (0, common_1.Global)(),
+            tslib_1.__metadata("design:paramtypes", [core_1.ModuleRef])
         ], ForgeRootModule);
+        let ForgeRootProviderModule = class ForgeRootProviderModule {
+        };
+        ForgeRootProviderModule = tslib_1.__decorate([
+            (0, common_1.Global)(),
+            (0, common_1.Module)({
+                providers: [
+                    {
+                        provide: constants_1.FORGE_TOKEN_ROOT_MODULE,
+                        useClass: ForgeRootModule,
+                    },
+                ],
+                exports: [constants_1.FORGE_TOKEN_ROOT_MODULE],
+            })
+        ], ForgeRootProviderModule);
+        meta.imports.unshift(ForgeRootProviderModule);
         return ForgeRootModule;
     }
     createInstrument(extensions, originalInstrument) {
         const hasOriginalInstrument = originalInstrument && originalInstrument.instanceDecorator;
+        const instances = new Array();
         return {
-            instanceDecorator(instance) {
+            instances,
+            instanceDecorator: (instance) => {
+                if (this._isRootModule(instance)) {
+                    // TODO
+                }
+                if (instance instanceof architecture_1.ForgeBaseComponent) {
+                    instances.push(instance);
+                }
                 for (const extension of extensions) {
                     const response = extension.instrument(instance);
                     if (response !== undefined) {
@@ -103,6 +161,40 @@ class Forge {
             },
         };
     }
+    augmentComponents(instances, extensions) {
+        for (const instance of instances) {
+            if (!this._augmented.has(instance)) {
+                if (instance instanceof architecture_1.ForgeModule) {
+                    this.augmentModule(instance, extensions);
+                }
+                else if (instance instanceof architecture_1.ForgeController) {
+                    this.augmentController(instance, extensions);
+                }
+                else if (instance instanceof architecture_1.ForgeService) {
+                    this.augmentService(instance, extensions);
+                }
+                this._augmented.add(instance);
+            }
+        }
+    }
+    augmentModule(instance, extensions) {
+        for (const extension of extensions) {
+            extension.augmentModule(instance, instance[constants_1.FORGE_FIELD_MODULE_REF]);
+        }
+    }
+    augmentController(instance, extensions) {
+        for (const extension of extensions) {
+            extension.augmentController(instance, instance[constants_1.FORGE_FIELD_MODULE_REF]);
+        }
+    }
+    augmentService(instance, extensions) {
+        for (const extension of extensions) {
+            extension.augmentService(instance, instance[constants_1.FORGE_FIELD_MODULE_REF]);
+        }
+    }
+    _isRootModule(instance) {
+        return typeof instance === 'object' && instance !== null && instance[constants_1.FORGE_ROOT_MODULE] === true;
+    }
 }
 const forge = new Forge();
 exports.Forge = forge;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './forge.factory';
 export * from './forge-options.interface';
 export * from './extensions';
+export * from './architecture';

package/dist/index.js

@@ -4,3 +4,4 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./forge.factory"), exports);
 tslib_1.__exportStar(require("./forge-options.interface"), exports);
 tslib_1.__exportStar(require("./extensions"), exports);
+tslib_1.__exportStar(require("./architecture"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@nest-forge/core",
 	"description": "",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"scripts": {
 		"build": "rimraf dist && tsc -p tsconfig.json",
 		"watch": "rimraf dist && tsc -w -p tsconfig.json",

package/tsconfig.json

@@ -15,7 +15,6 @@
 		"sourceMap": false,
 		"allowJs": false,
 		"outDir": "./dist",
-		"baseUrl": ".",
 		"forceConsistentCasingInFileNames": true,
 		"strictPropertyInitialization": false,
 		"stripInternal": true