@nestjs/core 10.1.3 → 10.2.0

package/Readme.md

@@ -23,7 +23,7 @@
 
 ## Description
 
-Nest is a framework for building efficient, scalable <a href="https://nodejs.org" target="_blank">Node.js</a> server-side applications. It uses modern JavaScript, is built with  <a href="https://www.typescriptlang.org" target="_blank">TypeScript</a> (preserves compatibility with pure JavaScript) and combines elements of OOP (Object Oriented Programming), FP (Functional Programming), and FRP (Functional Reactive Programming).
+Nest is a framework for building efficient, scalable <a href="https://nodejs.org" target="_blank">Node.js</a> server-side applications. It uses modern JavaScript, is built with <a href="https://www.typescriptlang.org" target="_blank">TypeScript</a> (preserves compatibility with pure JavaScript) and combines elements of OOP (Object Oriented Programming), FP (Functional Programming), and FRP (Functional Reactive Programming).
 
 <p>Under the hood, Nest makes use of <a href="https://expressjs.com/" target="_blank">Express</a>, but also, provides compatibility with a wide range of other libraries, like e.g. <a href="https://github.com/fastify/fastify" target="_blank">Fastify</a>, allowing for easy use of the myriad third-party plugins which are available.</p>
 
@@ -34,10 +34,10 @@ Nest is a framework for building efficient, scalable <a href="https://nodejs.org
 
 ## Getting started
 
-* To check out the [guide](https://docs.nestjs.com), visit [docs.nestjs.com](https://docs.nestjs.com). :books:
-* 要查看中文 [指南](readme_zh.md), 请访问 [docs.nestjs.cn](https://docs.nestjs.cn). :books:
-* [가이드](readme_kr.md) 문서는 [docs.nestjs.com](https://docs.nestjs.com)에서 확인하실 수 있습니다. :books:
-* [ガイド](readme_jp.md)は [docs.nestjs.com](https://docs.nestjs.com)でご確認ください。 :books:
+- To check out the [guide](https://docs.nestjs.com), visit [docs.nestjs.com](https://docs.nestjs.com). :books:
+- 要查看中文 [指南](readme_zh.md), 请访问 [docs.nestjs.cn](https://docs.nestjs.cn). :books:
+- [가이드](readme_kr.md) 문서는 [docs.nestjs.com](https://docs.nestjs.com)에서 확인하실 수 있습니다. :books:
+- [ガイド](readme_jp.md)は [docs.nestjs.com](https://docs.nestjs.com)でご確認ください。 :books:
 
 ## Questions
 
@@ -56,10 +56,13 @@ With official support, you can get expert help straight from Nest core team. We
 Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support from the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
 
 #### Principal Sponsors
+
 <table style="text-align:center;"><tr>
   <td><a href="https://trilon.io" target="_blank"><img src="https://nestjs.com/img/trilon.svg" width="200" 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>
+<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
@@ -69,8 +72,7 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <td>
 <a href="https://github.com/Sanofi-IADC" target="_blank"><img src="https://docs.nestjs.com/assets/sponsors/sanofi.png" width="180" valign="middle" /></a></td>
 <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://amplication.com/" target="_blank"><img src="https://nestjs.com/img/amplication-logo.svg" width="190" valign="middle" /></a></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://weld.app/" target="_blank"><img src="https://nestjs.com/img/weld-logo.svg" width="140" valign="middle" /></a></td>
 <td>
@@ -86,7 +88,8 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 #### Silver Sponsors
 
 <table style="text-align:center;"><tr>
-<td><a href="https://n.inc" target="_blank"><img src="https://nestjs.com/img/n-inc-logo.svg" width="120" valign="middle" /></td></tr>
+<td><a href="https://n.inc" target="_blank"><img src="https://nestjs.com/img/n-inc-logo.svg" width="120" valign="middle" /></td>
+<td><a href="https://twistag.com/" target="_blank"><img src="https://nestjs.com/img/twistag-logo.png" width="120" valign="middle" /></td></tr>
 </table>
 
 #### Sponsors
@@ -121,9 +124,9 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 
 ## Stay in touch
 
-* Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-* Website - [https://nestjs.com](https://nestjs.com/)
-* Twitter - [@nestframework](https://twitter.com/nestframework)
+- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
 
 ## License
 

package/discovery/discoverable-meta-host-collection.d.ts

@@ -0,0 +1,46 @@
+import { Type } from '@nestjs/common';
+import { InstanceWrapper } from '../injector/instance-wrapper';
+import { ModulesContainer } from '../injector/modules-container';
+export declare class DiscoverableMetaHostCollection {
+    /**
+     * A map of class references to metadata keys.
+     */
+    static readonly metaHostLinks: Map<Function | Type<any>, string>;
+    /**
+     * A map of metadata keys to instance wrappers (providers) with the corresponding metadata key.
+     * The map is weakly referenced by the modules container (unique per application).
+     */
+    private static readonly providersByMetaKey;
+    /**
+     * A map of metadata keys to instance wrappers (controllers) with the corresponding metadata key.
+     * The map is weakly referenced by the modules container (unique per application).
+     */
+    private static readonly controllersByMetaKey;
+    /**
+     * Adds a link between a class reference and a metadata key.
+     * @param target The class reference.
+     * @param metadataKey The metadata key.
+     */
+    static addClassMetaHostLink(target: Type | Function, metadataKey: string): void;
+    /**
+     * Inspects a provider instance wrapper and adds it to the collection of providers
+     * if it has a metadata key.
+     * @param hostContainerRef A reference to the modules container.
+     * @param instanceWrapper A provider instance wrapper.
+     * @returns void
+     */
+    static inspectProvider(hostContainerRef: ModulesContainer, instanceWrapper: InstanceWrapper): void;
+    /**
+     * Inspects a controller instance wrapper and adds it to the collection of controllers
+     * if it has a metadata key.
+     * @param hostContainerRef A reference to the modules container.
+     * @param instanceWrapper A controller's instance wrapper.
+     * @returns void
+     */
+    static inspectController(hostContainerRef: ModulesContainer, instanceWrapper: InstanceWrapper): void;
+    static insertByMetaKey(metaKey: string, instanceWrapper: InstanceWrapper, collection: Map<string, Set<InstanceWrapper>>): void;
+    static getProvidersByMetaKey(hostContainerRef: ModulesContainer, metaKey: string): Set<InstanceWrapper>;
+    static getControllersByMetaKey(hostContainerRef: ModulesContainer, metaKey: string): Set<InstanceWrapper>;
+    private static inspectInstanceWrapper;
+    private static getMetaKeyByInstanceWrapper;
+}

package/discovery/discoverable-meta-host-collection.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiscoverableMetaHostCollection = void 0;
+class DiscoverableMetaHostCollection {
+    /**
+     * Adds a link between a class reference and a metadata key.
+     * @param target The class reference.
+     * @param metadataKey The metadata key.
+     */
+    static addClassMetaHostLink(target, metadataKey) {
+        this.metaHostLinks.set(target, metadataKey);
+    }
+    /**
+     * Inspects a provider instance wrapper and adds it to the collection of providers
+     * if it has a metadata key.
+     * @param hostContainerRef A reference to the modules container.
+     * @param instanceWrapper A provider instance wrapper.
+     * @returns void
+     */
+    static inspectProvider(hostContainerRef, instanceWrapper) {
+        return this.inspectInstanceWrapper(hostContainerRef, instanceWrapper, this.providersByMetaKey);
+    }
+    /**
+     * Inspects a controller instance wrapper and adds it to the collection of controllers
+     * if it has a metadata key.
+     * @param hostContainerRef A reference to the modules container.
+     * @param instanceWrapper A controller's instance wrapper.
+     * @returns void
+     */
+    static inspectController(hostContainerRef, instanceWrapper) {
+        return this.inspectInstanceWrapper(hostContainerRef, instanceWrapper, this.controllersByMetaKey);
+    }
+    static insertByMetaKey(metaKey, instanceWrapper, collection) {
+        if (collection.has(metaKey)) {
+            const wrappers = collection.get(metaKey);
+            wrappers.add(instanceWrapper);
+        }
+        else {
+            const wrappers = new Set();
+            wrappers.add(instanceWrapper);
+            collection.set(metaKey, wrappers);
+        }
+    }
+    static getProvidersByMetaKey(hostContainerRef, metaKey) {
+        const wrappersByMetaKey = this.providersByMetaKey.get(hostContainerRef);
+        return wrappersByMetaKey.get(metaKey);
+    }
+    static getControllersByMetaKey(hostContainerRef, metaKey) {
+        const wrappersByMetaKey = this.controllersByMetaKey.get(hostContainerRef);
+        return wrappersByMetaKey.get(metaKey);
+    }
+    static inspectInstanceWrapper(hostContainerRef, instanceWrapper, wrapperByMetaKeyMap) {
+        const metaKey = DiscoverableMetaHostCollection.getMetaKeyByInstanceWrapper(instanceWrapper);
+        if (!metaKey) {
+            return;
+        }
+        let collection;
+        if (wrapperByMetaKeyMap.has(hostContainerRef)) {
+            collection = wrapperByMetaKeyMap.get(hostContainerRef);
+        }
+        else {
+            collection = new Map();
+            wrapperByMetaKeyMap.set(hostContainerRef, collection);
+        }
+        this.insertByMetaKey(metaKey, instanceWrapper, collection);
+    }
+    static getMetaKeyByInstanceWrapper(instanceWrapper) {
+        return this.metaHostLinks.get(
+        // NOTE: Regarding the ternary statement below,
+        // - The condition `!wrapper.metatype` is needed because when we use `useValue`
+        // the value of `wrapper.metatype` will be `null`.
+        // - The condition `wrapper.inject` is needed here because when we use
+        // `useFactory`, the value of `wrapper.metatype` will be the supplied
+        // factory function.
+        // For both cases, we should use `wrapper.instance.constructor` instead
+        // of `wrapper.metatype` to resolve processor's class properly.
+        // But since calling `wrapper.instance` could degrade overall performance
+        // we must defer it as much we can.
+        instanceWrapper.metatype || instanceWrapper.inject
+            ? instanceWrapper.instance?.constructor ?? instanceWrapper.metatype
+            : instanceWrapper.metatype);
+    }
+}
+exports.DiscoverableMetaHostCollection = DiscoverableMetaHostCollection;
+/**
+ * A map of class references to metadata keys.
+ */
+DiscoverableMetaHostCollection.metaHostLinks = new Map();
+/**
+ * A map of metadata keys to instance wrappers (providers) with the corresponding metadata key.
+ * The map is weakly referenced by the modules container (unique per application).
+ */
+DiscoverableMetaHostCollection.providersByMetaKey = new WeakMap();
+/**
+ * A map of metadata keys to instance wrappers (controllers) with the corresponding metadata key.
+ * The map is weakly referenced by the modules container (unique per application).
+ */
+DiscoverableMetaHostCollection.controllersByMetaKey = new WeakMap();

package/discovery/discovery-service.d.ts

@@ -1,20 +1,76 @@
+import { CustomDecorator } from '@nestjs/common';
 import { InstanceWrapper } from '../injector/instance-wrapper';
 import { Module } from '../injector/module';
 import { ModulesContainer } from '../injector/modules-container';
 /**
  * @publicApi
  */
-export interface DiscoveryOptions {
+export interface FilterByInclude {
+    /**
+     * List of modules to include (whitelist) into the discovery process.
+     */
     include?: Function[];
 }
+/**
+ * @publicApi
+ */
+export interface FilterByMetadataKey {
+    /**
+     * A key to filter controllers and providers by.
+     * Only instance wrappers with the specified metadata key will be returned.
+     */
+    metadataKey?: string;
+}
+/**
+ * @publicApi
+ */
+export type DiscoveryOptions = FilterByInclude | FilterByMetadataKey;
+/**
+ * @publicApi
+ */
+export type DiscoverableDecorator<T> = ((opts?: T) => CustomDecorator) & {
+    KEY: string;
+};
 /**
  * @publicApi
  */
 export declare class DiscoveryService {
     private readonly modulesContainer;
     constructor(modulesContainer: ModulesContainer);
+    /**
+     * Creates a decorator that can be used to decorate classes and methods with metadata.
+     * The decorator will also add the class to the collection of discoverable classes (by metadata key).
+     * Decorated classes can be discovered using the `getProviders` and `getControllers` methods.
+     * @returns A decorator function.
+     */
+    static createDecorator<T>(): DiscoverableDecorator<T>;
+    /**
+     * Returns an array of instance wrappers (providers).
+     * Depending on the options, the array will contain either all providers or only providers with the specified metadata key.
+     * @param options Discovery options.
+     * @param modules A list of modules to filter by.
+     * @returns An array of instance wrappers (providers).
+     */
     getProviders(options?: DiscoveryOptions, modules?: Module[]): InstanceWrapper[];
+    /**
+     * Returns an array of instance wrappers (controllers).
+     * Depending on the options, the array will contain either all controllers or only controllers with the specified metadata key.
+     * @param options Discovery options.
+     * @param modules A list of modules to filter by.
+     * @returns An array of instance wrappers (controllers).
+     */
     getControllers(options?: DiscoveryOptions, modules?: Module[]): InstanceWrapper[];
+    /**
+     * Retrieves metadata from the specified instance wrapper.
+     * @param decorator The decorator to retrieve metadata of.
+     * @param instanceWrapper Reference to the instance wrapper.
+     * @param methodKey An optional method key to retrieve metadata from.
+     * @returns Discovered metadata.
+     */
+    getMetadataByDecorator<T extends DiscoverableDecorator<any>>(decorator: T, instanceWrapper: InstanceWrapper, methodKey?: string): T extends DiscoverableDecorator<infer R> ? R | undefined : T | undefined;
+    /**
+     * Returns a list of modules to be used for discovery.
+     */
     protected getModules(options?: DiscoveryOptions): Module[];
     private includeWhitelisted;
 }

package/discovery/discovery-service.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DiscoveryService = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@nestjs/common");
+const uid_1 = require("uid");
 const modules_container_1 = require("../injector/modules-container");
+const discoverable_meta_host_collection_1 = require("./discoverable-meta-host-collection");
 /**
  * @publicApi
  */
@@ -11,16 +13,73 @@ let DiscoveryService = exports.DiscoveryService = class DiscoveryService {
     constructor(modulesContainer) {
         this.modulesContainer = modulesContainer;
     }
+    /**
+     * Creates a decorator that can be used to decorate classes and methods with metadata.
+     * The decorator will also add the class to the collection of discoverable classes (by metadata key).
+     * Decorated classes can be discovered using the `getProviders` and `getControllers` methods.
+     * @returns A decorator function.
+     */
+    static createDecorator() {
+        const metadataKey = (0, uid_1.uid)(21);
+        const decoratorFn = (opts) => (target, key, descriptor) => {
+            if (!descriptor) {
+                discoverable_meta_host_collection_1.DiscoverableMetaHostCollection.addClassMetaHostLink(target, metadataKey);
+            }
+            (0, common_1.SetMetadata)(metadataKey, opts ?? {})(target, key, descriptor);
+        };
+        decoratorFn.KEY = metadataKey;
+        return decoratorFn;
+    }
+    /**
+     * Returns an array of instance wrappers (providers).
+     * Depending on the options, the array will contain either all providers or only providers with the specified metadata key.
+     * @param options Discovery options.
+     * @param modules A list of modules to filter by.
+     * @returns An array of instance wrappers (providers).
+     */
     getProviders(options = {}, modules = this.getModules(options)) {
+        if ('metadataKey' in options) {
+            const providers = discoverable_meta_host_collection_1.DiscoverableMetaHostCollection.getProvidersByMetaKey(this.modulesContainer, options.metadataKey);
+            return Array.from(providers);
+        }
         const providers = modules.map(item => [...item.providers.values()]);
         return (0, common_1.flatten)(providers);
     }
+    /**
+     * Returns an array of instance wrappers (controllers).
+     * Depending on the options, the array will contain either all controllers or only controllers with the specified metadata key.
+     * @param options Discovery options.
+     * @param modules A list of modules to filter by.
+     * @returns An array of instance wrappers (controllers).
+     */
     getControllers(options = {}, modules = this.getModules(options)) {
+        if ('metadataKey' in options) {
+            const controllers = discoverable_meta_host_collection_1.DiscoverableMetaHostCollection.getControllersByMetaKey(this.modulesContainer, options.metadataKey);
+            return Array.from(controllers);
+        }
         const controllers = modules.map(item => [...item.controllers.values()]);
         return (0, common_1.flatten)(controllers);
     }
+    /**
+     * Retrieves metadata from the specified instance wrapper.
+     * @param decorator The decorator to retrieve metadata of.
+     * @param instanceWrapper Reference to the instance wrapper.
+     * @param methodKey An optional method key to retrieve metadata from.
+     * @returns Discovered metadata.
+     */
+    getMetadataByDecorator(decorator, instanceWrapper, methodKey) {
+        if (methodKey) {
+            return Reflect.getMetadata(decorator.KEY, instanceWrapper.instance[methodKey]);
+        }
+        const clsRef = instanceWrapper.instance?.constructor ?? instanceWrapper.metatype;
+        return Reflect.getMetadata(decorator.KEY, clsRef);
+    }
+    /**
+     * Returns a list of modules to be used for discovery.
+     */
     getModules(options = {}) {
-        if (!options.include) {
+        const includeInOpts = 'include' in options;
+        if (!includeInOpts) {
             const moduleRefs = [...this.modulesContainer.values()];
             return moduleRefs;
         }

package/injector/container.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NestContainer = void 0;
 const constants_1 = require("@nestjs/common/constants");
+const discoverable_meta_host_collection_1 = require("../discovery/discoverable-meta-host-collection");
 const exceptions_1 = require("../errors/exceptions");
 const initialize_on_preview_allowlist_1 = require("../inspector/initialize-on-preview.allowlist");
 const serialized_graph_1 = require("../inspector/serialized-graph");
@@ -137,7 +138,7 @@ class NestContainer {
         const moduleRef = this.modules.get(token);
         const { token: relatedModuleToken } = await this.moduleCompiler.compile(relatedModule);
         const related = this.modules.get(relatedModuleToken);
-        moduleRef.addRelatedModule(related);
+        moduleRef.addImport(related);
     }
     addProvider(provider, token, enhancerSubtype) {
         const moduleRef = this.modules.get(token);
@@ -147,7 +148,10 @@ class NestContainer {
         if (!moduleRef) {
             throw new exceptions_1.UnknownModuleException();
         }
-        return moduleRef.addProvider(provider, enhancerSubtype);
+        const providerKey = moduleRef.addProvider(provider, enhancerSubtype);
+        const providerRef = moduleRef.getProviderByKey(providerKey);
+        discoverable_meta_host_collection_1.DiscoverableMetaHostCollection.inspectProvider(this.modules, providerRef);
+        return providerKey;
     }
     addInjectable(injectable, token, enhancerSubtype, host) {
         if (!this.modules.has(token)) {
@@ -169,6 +173,8 @@ class NestContainer {
         }
         const moduleRef = this.modules.get(token);
         moduleRef.addController(controller);
+        const controllerRef = moduleRef.controllers.get(controller);
+        discoverable_meta_host_collection_1.DiscoverableMetaHostCollection.inspectController(this.modules, controllerRef);
     }
     clear() {
         this.modules.clear();
@@ -186,7 +192,7 @@ class NestContainer {
         if (target === globalModule || target === this.internalCoreModule) {
             return;
         }
-        target.addRelatedModule(globalModule);
+        target.addImport(globalModule);
     }
     getDynamicMetadataByToken(token, metadataKey) {
         const metadata = this.dynamicModulesMetadata.get(token);

package/injector/helpers/silent-logger.d.ts

@@ -5,5 +5,6 @@ export declare class SilentLogger extends Logger {
     warn: () => void;
     debug: () => void;
     verbose: () => void;
+    fatal: () => void;
     setLogLevels: () => void;
 }

package/injector/helpers/silent-logger.js

@@ -12,6 +12,7 @@ class SilentLogger extends common_1.Logger {
         this.warn = noop;
         this.debug = noop;
         this.verbose = noop;
+        this.fatal = noop;
         this.setLogLevels = noop;
     }
 }

package/injector/module.d.ts

@@ -43,8 +43,8 @@ export declare class Module {
     addModuleAsProvider(): void;
     addApplicationConfig(): void;
     addInjectable<T extends Injectable>(injectable: Provider, enhancerSubtype: EnhancerSubtype, host?: Type<T>): string | symbol | Function | InstanceWrapper<unknown>;
-    addProvider(provider: Provider): Provider | InjectionToken;
-    addProvider(provider: Provider, enhancerSubtype: EnhancerSubtype): Provider | InjectionToken;
+    addProvider(provider: Provider): InjectionToken;
+    addProvider(provider: Provider, enhancerSubtype: EnhancerSubtype): InjectionToken;
     isCustomProvider(provider: Provider): provider is ClassProvider | FactoryProvider | ValueProvider | ExistingProvider;
     addCustomProvider(provider: ClassProvider | FactoryProvider | ValueProvider | ExistingProvider, collection: Map<Function | string | symbol, any>, enhancerSubtype?: EnhancerSubtype): InjectionToken;
     isCustomClass(provider: any): provider is ClassProvider;
@@ -61,6 +61,10 @@ export declare class Module {
     validateExportedProvider(token: InjectionToken): InjectionToken;
     addController(controller: Type<Controller>): void;
     assignControllerUniqueId(controller: Type<Controller>): void;
+    addImport(moduleRef: Module): void;
+    /**
+     * @deprecated
+     */
     addRelatedModule(module: Module): void;
     replace(toReplace: InjectionToken, options: any): void;
     hasProvider(token: InjectionToken): boolean;

package/injector/module.js

@@ -330,6 +330,12 @@ class Module {
             value: (0, random_string_generator_util_1.randomStringGenerator)(),
         });
     }
+    addImport(moduleRef) {
+        this._imports.add(moduleRef);
+    }
+    /**
+     * @deprecated
+     */
     addRelatedModule(module) {
         this._imports.add(module);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/core",
-  "version": "10.1.3",
+  "version": "10.2.0",
   "description": "Nest - modern, fast, powerful node.js web framework (@core)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -36,7 +36,7 @@
     "uid": "2.0.2"
   },
   "devDependencies": {
-    "@nestjs/common": "10.1.3"
+    "@nestjs/common": "10.2.0"
   },
   "peerDependencies": {
     "@nestjs/common": "^10.0.0",

package/router/router-explorer.d.ts

@@ -43,4 +43,5 @@ export declare class RouterExplorer {
     private createCallbackProxy;
     createRequestScopedHandler(instanceWrapper: InstanceWrapper, requestMethod: RequestMethod, moduleRef: Module, moduleKey: string, methodName: string): <TRequest extends Record<any, any>, TResponse>(req: TRequest, res: TResponse, next: () => void) => Promise<void>;
     private getContextId;
+    private copyMetadataToCallback;
 }

package/router/router-explorer.js

@@ -101,6 +101,7 @@ class RouterExplorer {
                         controllerVersion: routePathMetadata.controllerVersion,
                     },
                 };
+                this.copyMetadataToCallback(targetCallback, routeHandler);
                 routerMethodRef(path, routeHandler);
                 this.graphInspector.insertEntrypointDefinition(entrypointDefinition, instanceWrapper.id);
             });
@@ -200,5 +201,10 @@ class RouterExplorer {
         }
         return contextId;
     }
+    copyMetadataToCallback(originalCallback, targetCallback) {
+        for (const key of Reflect.getMetadataKeys(originalCallback)) {
+            Reflect.defineMetadata(key, Reflect.getMetadata(key, originalCallback), targetCallback);
+        }
+    }
 }
 exports.RouterExplorer = RouterExplorer;

package/services/reflector.service.d.ts

@@ -1,4 +1,25 @@
-import { Type } from '@nestjs/common';
+import { CustomDecorator, Type } from '@nestjs/common';
+/**
+ * @publicApi
+ */
+export interface CreateDecoratorOptions<T = any> {
+    /**
+     * The key for the metadata.
+     * @default uid(21)
+     */
+    key?: string;
+    /**
+     * The transform function to apply to the metadata value.
+     * @default value => value
+     */
+    transform?: (value: T) => T;
+}
+/**
+ * @publicApi
+ */
+export type ReflectableDecorator<T> = ((opts?: T) => CustomDecorator) & {
+    KEY: string;
+};
 /**
  * Helper class providing Nest reflection capabilities.
  *
@@ -7,6 +28,24 @@ import { Type } from '@nestjs/common';
  * @publicApi
  */
 export declare class Reflector {
+    /**
+     * Creates a decorator that can be used to decorate classes and methods with metadata.
+     * Can be used as a strongly-typed alternative to `@SetMetadata`.
+     * @param options Decorator options.
+     * @returns A decorator function.
+     */
+    static createDecorator<T>(options?: CreateDecoratorOptions): ReflectableDecorator<T>;
+    /**
+     * Retrieve metadata for a reflectable decorator for a specified target.
+     *
+     * @example
+     * `const roles = this.reflector.get(Roles, context.getHandler());`
+     *
+     * @param decorator reflectable decorator created through `Reflector.createDecorator`
+     * @param target context (decorated object) to retrieve metadata from
+     *
+     */
+    get<T extends ReflectableDecorator<any>>(decorator: T, target: Type<any> | Function): T extends ReflectableDecorator<infer R> ? R : unknown;
     /**
      * Retrieve metadata for a specified key for a specified target.
      *
@@ -18,6 +57,14 @@ export declare class Reflector {
      *
      */
     get<TResult = any, TKey = any>(metadataKey: TKey, target: Type<any> | Function): TResult;
+    /**
+     * Retrieve metadata for a specified decorator for a specified set of targets.
+     *
+     * @param decorator lookup decorator for metadata to retrieve
+     * @param targets context (decorated objects) to retrieve metadata from
+     *
+     */
+    getAll<T extends ReflectableDecorator<any>>(decorator: T, targets: (Type<any> | Function)[]): T extends ReflectableDecorator<infer R> ? R extends Array<any> ? R[] : R : unknown;
     /**
      * Retrieve metadata for a specified key for a specified set of targets.
      *
@@ -26,6 +73,14 @@ export declare class Reflector {
      *
      */
     getAll<TResult extends any[] = any[], TKey = any>(metadataKey: TKey, targets: (Type<any> | Function)[]): TResult;
+    /**
+     * Retrieve metadata for a specified decorator for a specified set of targets and merge results.
+     *
+     * @param decorator lookup decorator for metadata to retrieve
+     * @param targets context (decorated objects) to retrieve metadata from
+     *
+     */
+    getAllAndMerge<T extends ReflectableDecorator<any>>(decorator: T, targets: (Type<any> | Function)[]): T extends ReflectableDecorator<infer R> ? R : unknown;
     /**
      * Retrieve metadata for a specified key for a specified set of targets and merge results.
      *
@@ -33,7 +88,15 @@ export declare class Reflector {
      * @param targets context (decorated objects) to retrieve metadata from
      *
      */
-    getAllAndMerge<TResult extends any[] = any[], TKey = any>(metadataKey: TKey, targets: (Type<any> | Function)[]): TResult;
+    getAllAndMerge<TResult extends any[] | object = any[], TKey = any>(metadataKey: TKey, targets: (Type<any> | Function)[]): TResult;
+    /**
+     * Retrieve metadata for a specified decorator for a specified set of targets and return a first not undefined value.
+     *
+     * @param decorator lookup decorator for metadata to retrieve
+     * @param targets context (decorated objects) to retrieve metadata from
+     *
+     */
+    getAllAndOverride<T extends ReflectableDecorator<any>>(decorator: T, targets: (Type<any> | Function)[]): T extends ReflectableDecorator<infer R> ? R : unknown;
     /**
      * Retrieve metadata for a specified key for a specified set of targets and return a first not undefined value.
      *

package/services/reflector.service.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Reflector = void 0;
+const common_1 = require("@nestjs/common");
 const shared_utils_1 = require("@nestjs/common/utils/shared.utils");
+const uid_1 = require("uid");
 /**
  * Helper class providing Nest reflection capabilities.
  *
@@ -11,37 +13,56 @@ const shared_utils_1 = require("@nestjs/common/utils/shared.utils");
  */
 class Reflector {
     /**
-     * Retrieve metadata for a specified key for a specified target.
+     * Creates a decorator that can be used to decorate classes and methods with metadata.
+     * Can be used as a strongly-typed alternative to `@SetMetadata`.
+     * @param options Decorator options.
+     * @returns A decorator function.
+     */
+    static createDecorator(options = {}) {
+        const metadataKey = options.key ?? (0, uid_1.uid)(21);
+        const decoratorFn = (metadataValue) => (target, key, descriptor) => {
+            const value = options.transform
+                ? options.transform(metadataValue)
+                : metadataValue;
+            (0, common_1.SetMetadata)(metadataKey, value ?? {})(target, key, descriptor);
+        };
+        decoratorFn.KEY = metadataKey;
+        return decoratorFn;
+    }
+    /**
+     * Retrieve metadata for a specified key or decorator for a specified target.
      *
      * @example
      * `const roles = this.reflector.get<string[]>('roles', context.getHandler());`
      *
-     * @param metadataKey lookup key for metadata to retrieve
+     * @param metadataKey lookup key or decorator for metadata to retrieve
      * @param target context (decorated object) to retrieve metadata from
      *
      */
-    get(metadataKey, target) {
+    get(metadataKeyOrDecorator, target) {
+        const metadataKey = metadataKeyOrDecorator.KEY ??
+            metadataKeyOrDecorator;
         return Reflect.getMetadata(metadataKey, target);
     }
     /**
-     * Retrieve metadata for a specified key for a specified set of targets.
+     * Retrieve metadata for a specified key or decorator for a specified set of targets.
      *
-     * @param metadataKey lookup key for metadata to retrieve
+     * @param metadataKeyOrDecorator lookup key or decorator for metadata to retrieve
      * @param targets context (decorated objects) to retrieve metadata from
      *
      */
-    getAll(metadataKey, targets) {
-        return (targets || []).map(target => this.get(metadataKey, target));
+    getAll(metadataKeyOrDecorator, targets) {
+        return (targets || []).map(target => this.get(metadataKeyOrDecorator, target));
     }
     /**
-     * Retrieve metadata for a specified key for a specified set of targets and merge results.
+     * Retrieve metadata for a specified key or decorator for a specified set of targets and merge results.
      *
-     * @param metadataKey lookup key for metadata to retrieve
+     * @param metadataKeyOrDecorator lookup key for metadata to retrieve
      * @param targets context (decorated objects) to retrieve metadata from
      *
      */
-    getAllAndMerge(metadataKey, targets) {
-        const metadataCollection = this.getAll(metadataKey, targets).filter(item => item !== undefined);
+    getAllAndMerge(metadataKeyOrDecorator, targets) {
+        const metadataCollection = this.getAll(metadataKeyOrDecorator, targets).filter(item => item !== undefined);
         if ((0, shared_utils_1.isEmpty)(metadataCollection)) {
             return metadataCollection;
         }
@@ -59,15 +80,15 @@ class Reflector {
         });
     }
     /**
-     * Retrieve metadata for a specified key for a specified set of targets and return a first not undefined value.
+     * Retrieve metadata for a specified key or decorator for a specified set of targets and return a first not undefined value.
      *
-     * @param metadataKey lookup key for metadata to retrieve
+     * @param metadataKeyOrDecorator lookup key or metadata for metadata to retrieve
      * @param targets context (decorated objects) to retrieve metadata from
      *
      */
-    getAllAndOverride(metadataKey, targets) {
+    getAllAndOverride(metadataKeyOrDecorator, targets) {
         for (const target of targets) {
-            const result = this.get(metadataKey, target);
+            const result = this.get(metadataKeyOrDecorator, target);
             if (result !== undefined) {
                 return result;
             }