@nestjs/core 9.0.0-next.1 → 9.0.0-next.2

package/Readme.md

@@ -65,19 +65,20 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <td>
 <a href="https://nx.dev" target="_blank"><img src="https://nestjs.com/img/nx-logo.png" height="45" valign="middle" /></a></td>
     <td>
-<a href="https://valor-software.com/" target="_blank"><img src="https://docs.nestjs.com/assets/sponsors/valor-software.png" width="170" valign="middle" /></a></td>
+<a href="https://valor-software.com/" target="_blank"><img src="https://docs.nestjs.com/assets/sponsors/valor-software.png" width="170" valign="middle" /></a></td><td>
+<a href="https://amplication.com/" target="_blank"><img src="https://nestjs.com/img/amplication-logo.svg" width="190" valign="middle" /></a></td>
 </tr></table>
 
 #### Gold Sponsors
 
 <table style="text-align:center;"><tr><td>
-  <a href="https://careers.labster.com/departments/platform" target="_blank"><img src="https://nestjs.com/img/labster-logo.png" width="170" valign="middle" /></a></td><td>
 <a href="https://weld.app/" target="_blank"><img src="https://nestjs.com/img/weld-logo.svg" width="140" valign="middle" /></a></td>
 <td>
 <a href="https://intrinsic.ventures/" target="_blank"><img src="https://nestjs.com/img/intrinisic-logo.png" width="210" valign="middle" /></a></td>
  <td>
 <a href="https://jetbrains.com/" target="_blank"><img src="https://nestjs.com/img/jetbrains-logo.svg" width="110" valign="middle" /></a></td><td>
-<a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/snyk-logo-black.png" width="185" valign="middle" /></a></td></</tr></table>
+<a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/snyk-logo-black.png" width="185" valign="middle" /></a></td><td>
+<a href="https://fuseautotech.com/" target="_blank"><img src="https://nestjs.com/img/fuse-logo.svg" width="105" valign="middle" /></a></td></</tr></table>
 
 #### Silver Sponsors
 

package/adapters/http-adapter.d.ts

@@ -42,10 +42,12 @@ export declare abstract class AbstractHttpAdapter<TServer = any, TRequest = any,
     abstract getRequestUrl(request: any): any;
     abstract status(response: any, statusCode: number): any;
     abstract reply(response: any, body: any, statusCode?: number): any;
+    abstract end(response: any, message?: string): any;
     abstract render(response: any, view: string, options: any): any;
     abstract redirect(response: any, statusCode: number, url: string): any;
     abstract setErrorHandler(handler: Function, prefix?: string): any;
     abstract setNotFoundHandler(handler: Function, prefix?: string): any;
+    abstract isHeadersSent(response: any): any;
     abstract setHeader(response: any, name: string, value: string): any;
     abstract registerParserMiddleware(prefix?: string, rawBody?: boolean): any;
     abstract enableCors(options: CorsOptions | CorsOptionsDelegate<TRequest>, prefix?: string): any;

package/exceptions/base-exception-filter.js

@@ -23,7 +23,13 @@ class BaseExceptionFilter {
                 statusCode: exception.getStatus(),
                 message: res,
             };
-        applicationRef.reply(host.getArgByIndex(1), message, exception.getStatus());
+        const response = host.getArgByIndex(1);
+        if (!applicationRef.isHeadersSent(response)) {
+            applicationRef.reply(response, message, exception.getStatus());
+        }
+        else {
+            applicationRef.end(response);
+        }
     }
     handleUnknownError(exception, host, applicationRef) {
         const body = this.isHttpError(exception)
@@ -35,7 +41,13 @@ class BaseExceptionFilter {
                 statusCode: common_1.HttpStatus.INTERNAL_SERVER_ERROR,
                 message: constants_1.MESSAGES.UNKNOWN_EXCEPTION_MESSAGE,
             };
-        applicationRef.reply(host.getArgByIndex(1), body, body.statusCode);
+        const response = host.getArgByIndex(1);
+        if (!applicationRef.isHeadersSent(response)) {
+            applicationRef.reply(response, body, body.statusCode);
+        }
+        else {
+            applicationRef.end(response);
+        }
         if (this.isExceptionObject(exception)) {
             return BaseExceptionFilter.logger.error(exception.message, exception.stack);
         }

package/helpers/context-id-factory.d.ts

@@ -1,4 +1,4 @@
-import { ChildContextIdInfo, ContextId } from '../injector/instance-wrapper';
+import { ContextId, HostComponentInfo } from '../injector/instance-wrapper';
 export declare function createContextId(): ContextId;
 export interface ContextIdStrategy<T = any> {
     /**
@@ -6,8 +6,9 @@ export interface ContextIdStrategy<T = any> {
      * This lets you construct durable DI sub-trees that can be shared between contexts.
      * @param contextId auto-generated child context id
      * @param request request object
+     * @returns a context id resolver function
      */
-    attach(contextId: ContextId, request: T): ((info: ChildContextIdInfo) => ContextId) | undefined;
+    attach(contextId: ContextId, request: T): ((info: HostComponentInfo) => ContextId) | undefined;
 }
 export declare class ContextIdFactory {
     private static strategy?;

package/index.d.ts

@@ -11,5 +11,6 @@ export * from './middleware';
 export * from './nest-application';
 export * from './nest-application-context';
 export { NestFactory } from './nest-factory';
+export * from './repl';
 export * from './router';
 export * from './services';

package/index.js

@@ -26,5 +26,6 @@ tslib_1.__exportStar(require("./nest-application"), exports);
 tslib_1.__exportStar(require("./nest-application-context"), exports);
 var nest_factory_1 = require("./nest-factory");
 Object.defineProperty(exports, "NestFactory", { enumerable: true, get: function () { return nest_factory_1.NestFactory; } });
+tslib_1.__exportStar(require("./repl"), exports);
 tslib_1.__exportStar(require("./router"), exports);
 tslib_1.__exportStar(require("./services"), exports);

package/injector/index.d.ts

@@ -1,6 +1,6 @@
 export * from './container';
 export * from './inquirer';
-export { ChildContextIdInfo, ContextId } from './instance-wrapper';
+export { ContextId, HostComponentInfo } from './instance-wrapper';
 export * from './lazy-module-loader';
 export * from './module-ref';
 export * from './modules-container';

package/injector/injector.d.ts

@@ -48,7 +48,7 @@ export declare class Injector {
     loadController(wrapper: InstanceWrapper<Controller>, moduleRef: Module, contextId?: ContextId): Promise<void>;
     loadInjectable<T = any>(wrapper: InstanceWrapper<T>, moduleRef: Module, contextId?: ContextId, inquirer?: InstanceWrapper): Promise<void>;
     loadProvider(wrapper: InstanceWrapper<Injectable>, moduleRef: Module, contextId?: ContextId, inquirer?: InstanceWrapper): Promise<void>;
-    applyDoneHook<T>(wrapper: InstancePerContext<T>): () => void;
+    applyDoneHook<T>(wrapper: InstancePerContext<T>): (err?: unknown) => void;
     resolveConstructorParams<T>(wrapper: InstanceWrapper<T>, moduleRef: Module, inject: InjectorDependency[], callback: (args: unknown[]) => void | Promise<void>, contextId?: ContextId, inquirer?: InstanceWrapper, parentInquirer?: InstanceWrapper): Promise<void>;
     getClassDependencies<T>(wrapper: InstanceWrapper<T>): [InjectorDependency[], number[]];
     getFactoryProviderDependencies<T>(wrapper: InstanceWrapper<T>): [InjectorDependency[], number[]];

package/injector/injector.js

@@ -31,7 +31,11 @@ class Injector {
         const inquirerId = this.getInquirerId(inquirer);
         const instanceHost = wrapper.getInstanceByContextId(this.getContextId(contextId, wrapper), inquirerId);
         if (instanceHost.isPending) {
-            return instanceHost.donePromise;
+            return instanceHost.donePromise.then((err) => {
+                if (err) {
+                    throw err;
+                }
+            });
         }
         const done = this.applyDoneHook(instanceHost);
         const token = wrapper.token || wrapper.name;
@@ -43,13 +47,19 @@ class Injector {
         if (instanceHost.isResolved) {
             return done();
         }
-        const callback = async (instances) => {
-            const properties = await this.resolveProperties(wrapper, moduleRef, inject, contextId, wrapper, inquirer);
-            const instance = await this.instantiateClass(instances, wrapper, targetWrapper, contextId, inquirer);
-            this.applyProperties(instance, properties);
-            done();
-        };
-        await this.resolveConstructorParams(wrapper, moduleRef, inject, callback, contextId, wrapper, inquirer);
+        try {
+            const callback = async (instances) => {
+                const properties = await this.resolveProperties(wrapper, moduleRef, inject, contextId, wrapper, inquirer);
+                const instance = await this.instantiateClass(instances, wrapper, targetWrapper, contextId, inquirer);
+                this.applyProperties(instance, properties);
+                done();
+            };
+            await this.resolveConstructorParams(wrapper, moduleRef, inject, callback, contextId, wrapper, inquirer);
+        }
+        catch (err) {
+            done(err);
+            throw err;
+        }
     }
     async loadMiddleware(wrapper, collection, moduleRef, contextId = constants_2.STATIC_CONTEXT, inquirer) {
         const { metatype, token } = wrapper;

package/injector/instance-wrapper.d.ts

@@ -3,7 +3,7 @@ import { FactoryProvider } from '@nestjs/common/interfaces';
 import { InstanceToken, Module } from './module';
 export declare const INSTANCE_METADATA_SYMBOL: unique symbol;
 export declare const INSTANCE_ID_SYMBOL: unique symbol;
-export interface ChildContextIdInfo {
+export interface HostComponentInfo {
     /**
      * Injection token (or class reference)
      */
@@ -15,13 +15,13 @@ export interface ChildContextIdInfo {
 }
 export interface ContextId {
     readonly id: number;
-    getParent?(info: ChildContextIdInfo): ContextId;
+    getParent?(info: HostComponentInfo): ContextId;
 }
 export interface InstancePerContext<T> {
     instance: T;
     isResolved?: boolean;
     isPending?: boolean;
-    donePromise?: Promise<void>;
+    donePromise?: Promise<unknown>;
 }
 export interface PropertyMetadata {
     key: symbol | string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/core",
-  "version": "9.0.0-next.1",
+  "version": "9.0.0-next.2",
   "description": "Nest - modern, fast, powerful node.js web framework (@core)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -36,7 +36,7 @@
     "uuid": "8.3.2"
   },
   "devDependencies": {
-    "@nestjs/common": "^9.0.0-next.1"
+    "@nestjs/common": "^9.0.0-next.2"
   },
   "peerDependencies": {
     "@nestjs/common": "^8.0.0",

package/repl/assign-to-object.util.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Similar to `Object.assign` but copying properties descriptors from `source`
+ * as well.
+ */
+export declare function assignToObject<T, U>(target: T, source: U): T & U;

package/repl/assign-to-object.util.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assignToObject = void 0;
+/**
+ * Similar to `Object.assign` but copying properties descriptors from `source`
+ * as well.
+ */
+function assignToObject(target, source) {
+    Object.defineProperties(target, Object.keys(source).reduce((descriptors, key) => {
+        descriptors[key] = Object.getOwnPropertyDescriptor(source, key);
+        return descriptors;
+    }, Object.create(null)));
+    return target;
+}
+exports.assignToObject = assignToObject;

package/repl/constants.d.ts

@@ -0,0 +1 @@
+export declare const REPL_INITIALIZED_MESSAGE = "REPL initialized";

package/repl/constants.js

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

package/repl/index.d.ts

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

package/repl/index.js

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

package/repl/native-functions/debug-repl-fn.d.ts

@@ -0,0 +1,9 @@
+import type { Type } from '@nestjs/common';
+import { ReplFunction } from '../repl-function';
+import type { ReplFnDefinition } from '../repl.interfaces';
+export declare class DebugReplFn extends ReplFunction {
+    fnDefinition: ReplFnDefinition;
+    action(moduleCls?: Type<unknown> | string): void;
+    private printCtrlsAndProviders;
+    private printCollection;
+}

package/repl/native-functions/debug-repl-fn.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebugReplFn = void 0;
+const cli_colors_util_1 = require("@nestjs/common/utils/cli-colors.util");
+const repl_function_1 = require("../repl-function");
+class DebugReplFn extends repl_function_1.ReplFunction {
+    constructor() {
+        super(...arguments);
+        this.fnDefinition = {
+            name: 'debug',
+            description: 'Print all registered modules as a list together with their controllers and providers. If the argument is passed in, for example, "debug(MyModule)" then it will only print components of this specific module.',
+            signature: '(moduleCls?: ClassRef | string) => void',
+        };
+    }
+    action(moduleCls) {
+        this.ctx.writeToStdout('\n');
+        if (moduleCls) {
+            const token = typeof moduleCls === 'function' ? moduleCls.name : moduleCls;
+            const moduleEntry = this.ctx.debugRegistry[token];
+            if (!moduleEntry) {
+                return this.logger.error(`"${token}" has not been found in the modules registry`);
+            }
+            this.printCtrlsAndProviders(token, moduleEntry);
+        }
+        else {
+            Object.keys(this.ctx.debugRegistry).forEach(moduleKey => {
+                this.printCtrlsAndProviders(moduleKey, this.ctx.debugRegistry[moduleKey]);
+            });
+        }
+        this.ctx.writeToStdout('\n');
+    }
+    printCtrlsAndProviders(moduleName, moduleDebugEntry) {
+        this.ctx.writeToStdout(`${cli_colors_util_1.clc.green(moduleName)}:\n`);
+        this.printCollection('controllers', moduleDebugEntry['controllers']);
+        this.printCollection('providers', moduleDebugEntry['providers']);
+    }
+    printCollection(title, collectionValue) {
+        const collectionEntries = Object.keys(collectionValue);
+        if (collectionEntries.length <= 0) {
+            return;
+        }
+        this.ctx.writeToStdout(` ${cli_colors_util_1.clc.yellow(`- ${title}`)}:\n`);
+        collectionEntries.forEach(provider => this.ctx.writeToStdout(`  ${cli_colors_util_1.clc.green('◻')} ${provider}\n`));
+    }
+}
+exports.DebugReplFn = DebugReplFn;

package/repl/native-functions/get-relp-fn.d.ts

@@ -0,0 +1,7 @@
+import type { Type } from '@nestjs/common';
+import { ReplFunction } from '../repl-function';
+import type { ReplFnDefinition } from '../repl.interfaces';
+export declare class GetReplFn extends ReplFunction {
+    fnDefinition: ReplFnDefinition;
+    action(token: string | symbol | Function | Type<any>): any;
+}

package/repl/native-functions/get-relp-fn.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetReplFn = void 0;
+const repl_function_1 = require("../repl-function");
+class GetReplFn extends repl_function_1.ReplFunction {
+    constructor() {
+        super(...arguments);
+        this.fnDefinition = {
+            name: 'get',
+            signature: '(token: InjectionToken) => any',
+            description: 'Retrieves an instance of either injectable or controller, otherwise, throws exception.',
+            aliases: ['$'],
+        };
+    }
+    action(token) {
+        return this.ctx.app.get(token);
+    }
+}
+exports.GetReplFn = GetReplFn;

package/repl/native-functions/help-repl-fn.d.ts

@@ -0,0 +1,7 @@
+import { ReplFunction } from '../repl-function';
+import type { ReplFnDefinition } from '../repl.interfaces';
+export declare class HelpReplFn extends ReplFunction {
+    fnDefinition: ReplFnDefinition;
+    static buildHelpMessage: ({ name, description }: ReplFnDefinition) => string;
+    action(): void;
+}

package/repl/native-functions/help-repl-fn.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HelpReplFn = void 0;
+const iterare_1 = require("iterare");
+const cli_colors_util_1 = require("@nestjs/common/utils/cli-colors.util");
+const repl_function_1 = require("../repl-function");
+class HelpReplFn extends repl_function_1.ReplFunction {
+    constructor() {
+        super(...arguments);
+        this.fnDefinition = {
+            name: 'help',
+            signature: '() => void',
+            description: 'Display all available REPL native functions.',
+        };
+    }
+    action() {
+        const sortedNativeFunctions = (0, iterare_1.iterate)(this.ctx.nativeFunctions)
+            .map(([, nativeFunction]) => nativeFunction.fnDefinition)
+            .toArray()
+            .sort((a, b) => (a.name < b.name ? -1 : 1));
+        this.ctx.writeToStdout(`You can call ${cli_colors_util_1.clc.bold('.help')} on any function listed below (e.g.: ${cli_colors_util_1.clc.bold('help.help')}):\n\n` +
+            sortedNativeFunctions.map(HelpReplFn.buildHelpMessage).join('\n') +
+            // Without the following LF the last item won't be displayed
+            '\n');
+    }
+}
+exports.HelpReplFn = HelpReplFn;
+HelpReplFn.buildHelpMessage = ({ name, description }) => cli_colors_util_1.clc.cyanBright(name) +
+    (description ? ` ${cli_colors_util_1.clc.bold('-')} ${description}` : '');

package/repl/native-functions/index.d.ts

@@ -0,0 +1,6 @@
+export * from './help-repl-fn';
+export * from './get-relp-fn';
+export * from './resolve-repl-fn';
+export * from './select-relp-fn';
+export * from './debug-repl-fn';
+export * from './methods-repl-fn';

package/repl/native-functions/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./help-repl-fn"), exports);
+tslib_1.__exportStar(require("./get-relp-fn"), exports);
+tslib_1.__exportStar(require("./resolve-repl-fn"), exports);
+tslib_1.__exportStar(require("./select-relp-fn"), exports);
+tslib_1.__exportStar(require("./debug-repl-fn"), exports);
+tslib_1.__exportStar(require("./methods-repl-fn"), exports);

package/repl/native-functions/methods-repl-fn.d.ts

@@ -0,0 +1,8 @@
+import type { Type } from '@nestjs/common';
+import { ReplFunction } from '../repl-function';
+import type { ReplFnDefinition } from '../repl.interfaces';
+export declare class MethodsReplFn extends ReplFunction {
+    fnDefinition: ReplFnDefinition;
+    private readonly metadataScanner;
+    action(token: Type<unknown> | string): void;
+}

package/repl/native-functions/methods-repl-fn.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodsReplFn = void 0;
+const cli_colors_util_1 = require("@nestjs/common/utils/cli-colors.util");
+const metadata_scanner_1 = require("../../metadata-scanner");
+const repl_function_1 = require("../repl-function");
+class MethodsReplFn extends repl_function_1.ReplFunction {
+    constructor() {
+        super(...arguments);
+        this.fnDefinition = {
+            name: 'methods',
+            description: 'Display all public methods available on a given provider or controller.',
+            signature: '(token: ClassRef | string) => void',
+        };
+        this.metadataScanner = new metadata_scanner_1.MetadataScanner();
+    }
+    action(token) {
+        const proto = typeof token !== 'function'
+            ? Object.getPrototypeOf(this.ctx.app.get(token))
+            : token === null || token === void 0 ? void 0 : token.prototype;
+        const methods = new Set(this.metadataScanner.getAllFilteredMethodNames(proto));
+        this.ctx.writeToStdout('\n');
+        this.ctx.writeToStdout(`${cli_colors_util_1.clc.green('Methods')}:\n`);
+        methods.forEach(methodName => this.ctx.writeToStdout(` ${cli_colors_util_1.clc.yellow('◻')} ${methodName}\n`));
+        this.ctx.writeToStdout('\n');
+    }
+}
+exports.MethodsReplFn = MethodsReplFn;

package/repl/native-functions/resolve-repl-fn.d.ts

@@ -0,0 +1,7 @@
+import type { Type } from '@nestjs/common';
+import { ReplFunction } from '../repl-function';
+import type { ReplFnDefinition } from '../repl.interfaces';
+export declare class ResolveReplFn extends ReplFunction {
+    fnDefinition: ReplFnDefinition;
+    action(token: string | symbol | Function | Type<any>, contextId: any): Promise<any>;
+}

package/repl/native-functions/resolve-repl-fn.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolveReplFn = void 0;
+const repl_function_1 = require("../repl-function");
+class ResolveReplFn extends repl_function_1.ReplFunction {
+    constructor() {
+        super(...arguments);
+        this.fnDefinition = {
+            name: 'resolve',
+            description: 'Resolves transient or request-scoped instance of either injectable or controller, otherwise, throws exception.',
+            signature: '(token: InjectionToken, contextId: any) => Promise<any>',
+        };
+    }
+    action(token, contextId) {
+        return this.ctx.app.resolve(token, contextId);
+    }
+}
+exports.ResolveReplFn = ResolveReplFn;

package/repl/native-functions/select-relp-fn.d.ts

@@ -0,0 +1,7 @@
+import type { DynamicModule, INestApplicationContext, Type } from '@nestjs/common';
+import { ReplFunction } from '../repl-function';
+import type { ReplFnDefinition } from '../repl.interfaces';
+export declare class SelectReplFn extends ReplFunction {
+    fnDefinition: ReplFnDefinition;
+    action(token: DynamicModule | Type<unknown>): INestApplicationContext;
+}

package/repl/native-functions/select-relp-fn.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectReplFn = void 0;
+const repl_function_1 = require("../repl-function");
+class SelectReplFn extends repl_function_1.ReplFunction {
+    constructor() {
+        super(...arguments);
+        this.fnDefinition = {
+            name: 'select',
+            description: 'Allows navigating through the modules tree, for example, to pull out a specific instance from the selected module.',
+            signature: '(token: DynamicModule | ClassRef) => INestApplicationContext',
+        };
+    }
+    action(token) {
+        return this.ctx.app.select(token);
+    }
+}
+exports.SelectReplFn = SelectReplFn;

package/repl/repl-context.d.ts

@@ -0,0 +1,26 @@
+import { INestApplication, InjectionToken, Logger } from '@nestjs/common';
+import { ReplFunction } from './repl-function';
+import type { ReplFunctionClass } from './repl.interfaces';
+declare type ModuleKey = string;
+export declare type ModuleDebugEntry = {
+    controllers: Record<string, InjectionToken>;
+    providers: Record<string, InjectionToken>;
+};
+declare type ReplScope = Record<string, any>;
+export declare class ReplContext {
+    readonly app: INestApplication;
+    readonly logger: Logger;
+    debugRegistry: Record<ModuleKey, ModuleDebugEntry>;
+    readonly globalScope: ReplScope;
+    readonly nativeFunctions: Map<string, ReplFunction<unknown[], any>>;
+    private readonly container;
+    constructor(app: INestApplication, nativeFunctionsClassRefs?: ReplFunctionClass[]);
+    writeToStdout(text: string): void;
+    private initializeContext;
+    private introspectCollection;
+    private stringifyToken;
+    private addNativeFunction;
+    private registerFunctionIntoGlobalScope;
+    private initializeNativeFunctions;
+}
+export {};

package/repl/repl-context.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplContext = void 0;
+const common_1 = require("@nestjs/common");
+const application_config_1 = require("../application-config");
+const injector_1 = require("../injector");
+const internal_core_module_1 = require("../injector/internal-core-module");
+const native_functions_1 = require("./native-functions");
+class ReplContext {
+    constructor(app, nativeFunctionsClassRefs) {
+        this.app = app;
+        this.logger = new common_1.Logger(ReplContext.name);
+        this.debugRegistry = {};
+        this.globalScope = Object.create(null);
+        this.nativeFunctions = new Map();
+        this.container = app.container; // Using `any` because `app.container` is not public.
+        this.initializeContext();
+        this.initializeNativeFunctions(nativeFunctionsClassRefs || []);
+    }
+    writeToStdout(text) {
+        process.stdout.write(text);
+    }
+    initializeContext() {
+        const modules = this.container.getModules();
+        modules.forEach(moduleRef => {
+            let moduleName = moduleRef.metatype.name;
+            if (moduleName === internal_core_module_1.InternalCoreModule.name) {
+                return;
+            }
+            if (this.globalScope[moduleName]) {
+                moduleName += ` (${moduleRef.token})`;
+            }
+            this.introspectCollection(moduleRef, moduleName, 'providers');
+            this.introspectCollection(moduleRef, moduleName, 'controllers');
+            // For in REPL auto-complete functionality
+            Object.defineProperty(this.globalScope, moduleName, {
+                value: moduleRef.metatype,
+                configurable: false,
+                enumerable: true,
+            });
+        });
+    }
+    introspectCollection(moduleRef, moduleKey, collection) {
+        var _a;
+        const moduleDebugEntry = {};
+        moduleRef[collection].forEach(({ token }) => {
+            const stringifiedToken = this.stringifyToken(token);
+            if (stringifiedToken === application_config_1.ApplicationConfig.name ||
+                stringifiedToken === moduleRef.metatype.name ||
+                this.globalScope[stringifiedToken]) {
+                return;
+            }
+            // For in REPL auto-complete functionality
+            Object.defineProperty(this.globalScope, stringifiedToken, {
+                value: token,
+                configurable: false,
+                enumerable: true,
+            });
+            if (stringifiedToken === injector_1.ModuleRef.name) {
+                return;
+            }
+            moduleDebugEntry[stringifiedToken] = token;
+        });
+        this.debugRegistry[moduleKey] = Object.assign(Object.assign({}, (_a = this.debugRegistry) === null || _a === void 0 ? void 0 : _a[moduleKey]), { [collection]: moduleDebugEntry });
+    }
+    stringifyToken(token) {
+        return typeof token !== 'string'
+            ? typeof token === 'function'
+                ? token.name
+                : token === null || token === void 0 ? void 0 : token.toString()
+            : token;
+    }
+    addNativeFunction(NativeFunctionRef) {
+        var _a;
+        const nativeFunction = new NativeFunctionRef(this);
+        const nativeFunctions = [nativeFunction];
+        this.nativeFunctions.set(nativeFunction.fnDefinition.name, nativeFunction);
+        (_a = nativeFunction.fnDefinition.aliases) === null || _a === void 0 ? void 0 : _a.forEach(aliaseName => {
+            const aliasNativeFunction = Object.create(nativeFunction);
+            aliasNativeFunction.fnDefinition = {
+                name: aliaseName,
+                description: aliasNativeFunction.fnDefinition.description,
+                signature: aliasNativeFunction.fnDefinition.signature,
+            };
+            this.nativeFunctions.set(aliaseName, aliasNativeFunction);
+            nativeFunctions.push(aliasNativeFunction);
+        });
+        return nativeFunctions;
+    }
+    registerFunctionIntoGlobalScope(nativeFunction) {
+        // Bind the method to REPL's context:
+        this.globalScope[nativeFunction.fnDefinition.name] =
+            nativeFunction.action.bind(nativeFunction);
+        // Load the help trigger as a `help` getter on each native function:
+        const functionBoundRef = this.globalScope[nativeFunction.fnDefinition.name];
+        Object.defineProperty(functionBoundRef, 'help', {
+            enumerable: false,
+            configurable: false,
+            get: () => 
+            // Dynamically builds the help message as will unlikely to be called
+            // several times.
+            this.writeToStdout(nativeFunction.makeHelpMessage()),
+        });
+    }
+    initializeNativeFunctions(nativeFunctionsClassRefs) {
+        const builtInFunctionsClassRefs = [
+            native_functions_1.HelpReplFn,
+            native_functions_1.GetReplFn,
+            native_functions_1.ResolveReplFn,
+            native_functions_1.SelectReplFn,
+            native_functions_1.DebugReplFn,
+            native_functions_1.MethodsReplFn,
+        ];
+        builtInFunctionsClassRefs
+            .concat(nativeFunctionsClassRefs)
+            .forEach(NativeFunction => {
+            const nativeFunctions = this.addNativeFunction(NativeFunction);
+            nativeFunctions.forEach(nativeFunction => {
+                this.registerFunctionIntoGlobalScope(nativeFunction);
+            });
+        });
+    }
+}
+exports.ReplContext = ReplContext;

package/repl/repl-function.d.ts

@@ -0,0 +1,18 @@
+import { Logger } from '@nestjs/common';
+import { ReplContext } from './repl-context';
+import type { ReplFnDefinition } from './repl.interfaces';
+export declare abstract class ReplFunction<ActionParams extends Array<unknown> = Array<unknown>, ActionReturn = any> {
+    protected readonly ctx: ReplContext;
+    /** Metadata that describes the built-in function itself. */
+    abstract fnDefinition: ReplFnDefinition;
+    protected readonly logger: Logger;
+    constructor(ctx: ReplContext);
+    /**
+     * Method called when the function is invoked from the REPL by the user.
+     */
+    abstract action(...args: ActionParams): ActionReturn;
+    /**
+     * @returns A message displayed by calling `<fnName>.help`
+     */
+    makeHelpMessage(): string;
+}

package/repl/repl-function.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplFunction = void 0;
+const cli_colors_util_1 = require("@nestjs/common/utils/cli-colors.util");
+class ReplFunction {
+    constructor(ctx) {
+        this.ctx = ctx;
+        this.logger = ctx.logger;
+    }
+    /**
+     * @returns A message displayed by calling `<fnName>.help`
+     */
+    makeHelpMessage() {
+        const { description, name, signature } = this.fnDefinition;
+        const fnSignatureWithName = `${name}${signature}`;
+        return `${cli_colors_util_1.clc.yellow(description)}\n${cli_colors_util_1.clc.magentaBright('Interface:')} ${cli_colors_util_1.clc.bold(fnSignatureWithName)}\n`;
+    }
+}
+exports.ReplFunction = ReplFunction;

package/repl/repl-logger.d.ts

@@ -0,0 +1,5 @@
+import { ConsoleLogger } from '@nestjs/common';
+export declare class ReplLogger extends ConsoleLogger {
+    private static readonly ignoredContexts;
+    log(_message: any, context?: string): void;
+}

package/repl/repl-logger.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplLogger = void 0;
+const common_1 = require("@nestjs/common");
+const nest_application_1 = require("../nest-application");
+const router_explorer_1 = require("../router/router-explorer");
+const routes_resolver_1 = require("../router/routes-resolver");
+class ReplLogger extends common_1.ConsoleLogger {
+    log(_message, context) {
+        if (ReplLogger.ignoredContexts.includes(context)) {
+            return;
+        }
+        // eslint-disable-next-line
+        return super.log.apply(this, Array.from(arguments));
+    }
+}
+exports.ReplLogger = ReplLogger;
+ReplLogger.ignoredContexts = [
+    routes_resolver_1.RoutesResolver.name,
+    router_explorer_1.RouterExplorer.name,
+    nest_application_1.NestApplication.name,
+];

package/repl/repl.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { Type } from '@nestjs/common';
+import * as _repl from 'repl';
+export declare function repl(module: Type): Promise<_repl.REPLServer>;

package/repl/repl.interfaces.d.ts

@@ -0,0 +1,16 @@
+import type { ReplContext } from './repl-context';
+import type { ReplFunction } from './repl-function';
+export declare type ReplFnDefinition = {
+    /** Function's name. Note that this should be a valid JavaScript function name. */
+    name: string;
+    /** Alternative names to the function. */
+    aliases?: ReplFnDefinition['name'][];
+    /** Function's description to display when `<function>.help` is entered. */
+    description: string;
+    /**
+     * Function's signature following TypeScript _function type expression_ syntax.
+     * @example '(token: InjectionToken) => any'
+     */
+    signature: string;
+};
+export declare type ReplFunctionClass = new (replContext: ReplContext) => ReplFunction;

package/repl/repl.interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/repl/repl.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.repl = void 0;
+const common_1 = require("@nestjs/common");
+const _repl = require("repl");
+const cli_colors_util_1 = require("@nestjs/common/utils/cli-colors.util");
+const nest_factory_1 = require("../nest-factory");
+const constants_1 = require("./constants");
+const repl_context_1 = require("./repl-context");
+const repl_logger_1 = require("./repl-logger");
+const assign_to_object_util_1 = require("./assign-to-object.util");
+async function repl(module) {
+    const app = await nest_factory_1.NestFactory.create(module, {
+        abortOnError: false,
+        logger: new repl_logger_1.ReplLogger(),
+    });
+    await app.init();
+    const replContext = new repl_context_1.ReplContext(app);
+    common_1.Logger.log(constants_1.REPL_INITIALIZED_MESSAGE);
+    const replServer = _repl.start({
+        prompt: cli_colors_util_1.clc.green('> '),
+        ignoreUndefined: true,
+    });
+    (0, assign_to_object_util_1.assignToObject)(replServer.context, replContext.globalScope);
+    return replServer;
+}
+exports.repl = repl;