@loopback/metadata 4.0.0-alpha.8 → 4.1.0

package/dist/inspector.d.ts

@@ -0,0 +1,120 @@
+import { NamespacedReflect } from './reflect';
+import { DecoratorType, DesignTimeMethodMetadata, MetadataKey, MetadataMap } from './types';
+/**
+ * Options for inspection
+ */
+export interface InspectionOptions {
+    /**
+     * Only inspect own metadata of a given target. The prototype chain will not
+     * be checked. The implementation uses `Reflect.getOwnMetadata()` if the flag
+     * is set to `true`. Otherwise, it uses `Reflect.getMetadata()`.
+     *
+     * The flag is `false` by default for `MetadataInspector`.
+     */
+    ownMetadataOnly?: boolean;
+}
+/**
+ * Inspector for metadata applied by decorators
+ */
+export declare class MetadataInspector {
+    /**
+     * Expose Reflector, which is a wrapper of `Reflect` and it uses `loopback`
+     * as the namespace prefix for all metadata keys
+     */
+    static readonly Reflector: NamespacedReflect;
+    /**
+     * Expose the reflector for TypeScript design-time metadata
+     */
+    static readonly DesignTimeReflector: NamespacedReflect;
+    /**
+     * Get the metadata associated with the given key for a given class
+     * @param key - Metadata key
+     * @param target - Class that contains the metadata
+     * @param options - Options for inspection
+     */
+    static getClassMetadata<T>(key: MetadataKey<T, ClassDecorator>, target: Function, options?: InspectionOptions): T | undefined;
+    /**
+     * Define metadata for the given target
+     * @param key - Metadata key
+     * @param value - Metadata value
+     * @param target - Target for the metadata
+     * @param member - Optional property or method name
+     */
+    static defineMetadata<T>(key: MetadataKey<T, DecoratorType>, value: T, target: Object, member?: string): void;
+    /**
+     * Get the metadata associated with the given key for all methods of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param options - Options for inspection
+     */
+    static getAllMethodMetadata<T>(key: MetadataKey<T, MethodDecorator>, target: Object, options?: InspectionOptions): MetadataMap<T> | undefined;
+    /**
+     * Get the metadata associated with the given key for a given method of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param methodName - Method name. If not present, default to '' to use
+     * the constructor
+     * @param options - Options for inspection
+     */
+    static getMethodMetadata<T>(key: MetadataKey<T, MethodDecorator>, target: Object, methodName?: string, options?: InspectionOptions): T | undefined;
+    /**
+     * Get the metadata associated with the given key for all properties of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param options - Options for inspection
+     */
+    static getAllPropertyMetadata<T>(key: MetadataKey<T, PropertyDecorator>, target: Object, options?: InspectionOptions): MetadataMap<T> | undefined;
+    /**
+     * Get the metadata associated with the given key for a given property of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static properties or prototype for instance
+     * properties
+     * @param propertyName - Property name
+     * @param options - Options for inspection
+     */
+    static getPropertyMetadata<T>(key: MetadataKey<T, PropertyDecorator>, target: Object, propertyName: string, options?: InspectionOptions): T | undefined;
+    /**
+     * Get the metadata associated with the given key for all parameters of a
+     * given method
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param methodName - Method name. If not present, default to '' to use
+     * the constructor
+     * @param options - Options for inspection
+     */
+    static getAllParameterMetadata<T>(key: MetadataKey<T, ParameterDecorator>, target: Object, methodName?: string, options?: InspectionOptions): T[] | undefined;
+    /**
+     * Get the metadata associated with the given key for a parameter of a given
+     * method by index
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param methodName - Method name. If not present, default to '' to use
+     * the constructor
+     * @param index - Index of the parameter, starting with 0
+     * @param options - Options for inspection
+     */
+    static getParameterMetadata<T>(key: MetadataKey<T, ParameterDecorator>, target: Object, methodName: string, index: number, options?: InspectionOptions): T | undefined;
+    /**
+     * Get TypeScript design time type for a property
+     * @param target - Class or prototype
+     * @param propertyName - Property name
+     * @returns Design time metadata. The return value is `undefined` when:
+     * - The property has type `undefined`, `null`
+     * - The TypeScript project has not enabled the compiler option `emitDecoratorMetadata`.
+     * - The code is written in vanilla JavaScript.
+     */
+    static getDesignTypeForProperty(target: Object, propertyName: string): Function | undefined;
+    /**
+     * Get TypeScript design time type for a method.
+     * @param target - Class or prototype
+     * @param methodName - Method name
+     * @returns Design time metadata. The return value is `undefined`
+     * in projects that do not enable `emitDecoratorMetadata`
+     * in TypeScript compiler options or are written in vanilla JavaScript.
+     */
+    static getDesignTypeForMethod(target: Object, methodName: string): DesignTimeMethodMetadata | undefined;
+}

package/dist/inspector.js

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataInspector = void 0;
+const tslib_1 = require("tslib");
+// Copyright IBM Corp. 2017,2019. All Rights Reserved.
+// Node module: @loopback/metadata
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const decorator_factory_1 = require("./decorator-factory");
+const reflect_1 = require("./reflect");
+const debug = (0, debug_1.default)('loopback:metadata:inspector');
+/**
+ * TypeScript reflector without a namespace. The TypeScript compiler can be
+ * configured to add design time metadata.
+ *
+ * See https://www.typescriptlang.org/docs/handbook/decorators.html
+ */
+const TSReflector = new reflect_1.NamespacedReflect();
+/**
+ * Inspector for metadata applied by decorators
+ */
+class MetadataInspector {
+    /**
+     * Get the metadata associated with the given key for a given class
+     * @param key - Metadata key
+     * @param target - Class that contains the metadata
+     * @param options - Options for inspection
+     */
+    static getClassMetadata(key, target, options) {
+        return (options === null || options === void 0 ? void 0 : options.ownMetadataOnly)
+            ? reflect_1.Reflector.getOwnMetadata(key.toString(), target)
+            : reflect_1.Reflector.getMetadata(key.toString(), target);
+    }
+    /**
+     * Define metadata for the given target
+     * @param key - Metadata key
+     * @param value - Metadata value
+     * @param target - Target for the metadata
+     * @param member - Optional property or method name
+     */
+    static defineMetadata(key, value, target, member) {
+        reflect_1.Reflector.defineMetadata(key.toString(), value, target, member);
+    }
+    /**
+     * Get the metadata associated with the given key for all methods of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param options - Options for inspection
+     */
+    static getAllMethodMetadata(key, target, options) {
+        return (options === null || options === void 0 ? void 0 : options.ownMetadataOnly)
+            ? reflect_1.Reflector.getOwnMetadata(key.toString(), target)
+            : reflect_1.Reflector.getMetadata(key.toString(), target);
+    }
+    /**
+     * Get the metadata associated with the given key for a given method of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param methodName - Method name. If not present, default to '' to use
+     * the constructor
+     * @param options - Options for inspection
+     */
+    static getMethodMetadata(key, target, methodName, options) {
+        methodName = methodName !== null && methodName !== void 0 ? methodName : '';
+        const meta = (options === null || options === void 0 ? void 0 : options.ownMetadataOnly)
+            ? reflect_1.Reflector.getOwnMetadata(key.toString(), target)
+            : reflect_1.Reflector.getMetadata(key.toString(), target);
+        return meta === null || meta === void 0 ? void 0 : meta[methodName];
+    }
+    /**
+     * Get the metadata associated with the given key for all properties of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param options - Options for inspection
+     */
+    static getAllPropertyMetadata(key, target, options) {
+        return (options === null || options === void 0 ? void 0 : options.ownMetadataOnly)
+            ? reflect_1.Reflector.getOwnMetadata(key.toString(), target)
+            : reflect_1.Reflector.getMetadata(key.toString(), target);
+    }
+    /**
+     * Get the metadata associated with the given key for a given property of the
+     * target class or prototype
+     * @param key - Metadata key
+     * @param target - Class for static properties or prototype for instance
+     * properties
+     * @param propertyName - Property name
+     * @param options - Options for inspection
+     */
+    static getPropertyMetadata(key, target, propertyName, options) {
+        const meta = (options === null || options === void 0 ? void 0 : options.ownMetadataOnly)
+            ? reflect_1.Reflector.getOwnMetadata(key.toString(), target)
+            : reflect_1.Reflector.getMetadata(key.toString(), target);
+        return meta === null || meta === void 0 ? void 0 : meta[propertyName];
+    }
+    /**
+     * Get the metadata associated with the given key for all parameters of a
+     * given method
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param methodName - Method name. If not present, default to '' to use
+     * the constructor
+     * @param options - Options for inspection
+     */
+    static getAllParameterMetadata(key, target, methodName, options) {
+        methodName = methodName !== null && methodName !== void 0 ? methodName : '';
+        const meta = (options === null || options === void 0 ? void 0 : options.ownMetadataOnly)
+            ? reflect_1.Reflector.getOwnMetadata(key.toString(), target)
+            : reflect_1.Reflector.getMetadata(key.toString(), target);
+        return meta === null || meta === void 0 ? void 0 : meta[methodName];
+    }
+    /**
+     * Get the metadata associated with the given key for a parameter of a given
+     * method by index
+     * @param key - Metadata key
+     * @param target - Class for static methods or prototype for instance methods
+     * @param methodName - Method name. If not present, default to '' to use
+     * the constructor
+     * @param index - Index of the parameter, starting with 0
+     * @param options - Options for inspection
+     */
+    static getParameterMetadata(key, target, methodName, index, options) {
+        methodName = methodName || '';
+        const meta = (options === null || options === void 0 ? void 0 : options.ownMetadataOnly)
+            ? reflect_1.Reflector.getOwnMetadata(key.toString(), target)
+            : reflect_1.Reflector.getMetadata(key.toString(), target);
+        const params = meta === null || meta === void 0 ? void 0 : meta[methodName];
+        return params === null || params === void 0 ? void 0 : params[index];
+    }
+    /**
+     * Get TypeScript design time type for a property
+     * @param target - Class or prototype
+     * @param propertyName - Property name
+     * @returns Design time metadata. The return value is `undefined` when:
+     * - The property has type `undefined`, `null`
+     * - The TypeScript project has not enabled the compiler option `emitDecoratorMetadata`.
+     * - The code is written in vanilla JavaScript.
+     */
+    static getDesignTypeForProperty(target, propertyName) {
+        return TSReflector.getMetadata('design:type', target, propertyName);
+    }
+    /**
+     * Get TypeScript design time type for a method.
+     * @param target - Class or prototype
+     * @param methodName - Method name
+     * @returns Design time metadata. The return value is `undefined`
+     * in projects that do not enable `emitDecoratorMetadata`
+     * in TypeScript compiler options or are written in vanilla JavaScript.
+     */
+    static getDesignTypeForMethod(target, methodName) {
+        const type = TSReflector.getMetadata('design:type', target, methodName);
+        const parameterTypes = TSReflector.getMetadata('design:paramtypes', target, methodName);
+        const returnType = TSReflector.getMetadata('design:returntype', target, methodName);
+        if (type === undefined &&
+            parameterTypes === undefined &&
+            returnType === undefined) {
+            /* istanbul ignore next */
+            if (debug.enabled) {
+                const targetName = decorator_factory_1.DecoratorFactory.getTargetName(target, methodName);
+                debug('No design-time type metadata found while inspecting %s. ' +
+                    'Did you forget to enable TypeScript compiler option `emitDecoratorMetadata`?', targetName);
+            }
+            return undefined;
+        }
+        return {
+            type,
+            parameterTypes,
+            returnType,
+        };
+    }
+}
+exports.MetadataInspector = MetadataInspector;
+/**
+ * Expose Reflector, which is a wrapper of `Reflect` and it uses `loopback`
+ * as the namespace prefix for all metadata keys
+ */
+MetadataInspector.Reflector = reflect_1.Reflector;
+/**
+ * Expose the reflector for TypeScript design-time metadata
+ */
+MetadataInspector.DesignTimeReflector = TSReflector;
+//# sourceMappingURL=inspector.js.map

package/dist/inspector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspector.js","sourceRoot":"","sources":["../src/inspector.ts"],"names":[],"mappings":";;;;AAAA,sDAAsD;AACtD,kCAAkC;AAClC,+CAA+C;AAC/C,gEAAgE;AAChE,+DAAgC;AAChC,2DAAqD;AACrD,uCAAuD;AAQvD,MAAM,KAAK,GAAG,IAAA,eAAW,EAAC,6BAA6B,CAAC,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,GAAG,IAAI,2BAAiB,EAAE,CAAC;AAgB5C;;GAEG;AACH,MAAa,iBAAiB;IAW5B;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CACrB,GAAmC,EACnC,MAAgB,EAChB,OAA2B;QAE3B,OAAO,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;YAC7B,CAAC,CAAC,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;YAClD,CAAC,CAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CACnB,GAAkC,EAClC,KAAQ,EACR,MAAc,EACd,MAAe;QAEf,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,oBAAoB,CACzB,GAAoC,EACpC,MAAc,EACd,OAA2B;QAE3B,OAAO,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;YAC7B,CAAC,CAAC,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;YAClD,CAAC,CAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,iBAAiB,CACtB,GAAoC,EACpC,MAAc,EACd,UAAmB,EACnB,OAA2B;QAE3B,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAmB,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;YACnD,CAAC,CAAC,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;YAClD,CAAC,CAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,UAAU,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,sBAAsB,CAC3B,GAAsC,EACtC,MAAc,EACd,OAA2B;QAE3B,OAAO,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;YAC7B,CAAC,CAAC,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;YAClD,CAAC,CAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,mBAAmB,CACxB,GAAsC,EACtC,MAAc,EACd,YAAoB,EACpB,OAA2B;QAE3B,MAAM,IAAI,GAAmB,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;YACnD,CAAC,CAAC,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;YAClD,CAAC,CAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,YAAY,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,uBAAuB,CAC5B,GAAuC,EACvC,MAAc,EACd,UAAmB,EACnB,OAA2B;QAE3B,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAqB,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;YACrD,CAAC,CAAC,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;YAClD,CAAC,CAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,UAAU,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,CACzB,GAAuC,EACvC,MAAc,EACd,UAAkB,EAClB,KAAa,EACb,OAA2B;QAE3B,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAqB,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;YACrD,CAAC,CAAC,mBAAS,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC;YAClD,CAAC,CAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,UAAU,CAAC,CAAC;QAClC,OAAO,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAG,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,wBAAwB,CAC7B,MAAc,EACd,YAAoB;QAEpB,OAAO,WAAW,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,sBAAsB,CAC3B,MAAc,EACd,UAAkB;QAElB,MAAM,IAAI,GAAG,WAAW,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACxE,MAAM,cAAc,GAAG,WAAW,CAAC,WAAW,CAC5C,mBAAmB,EACnB,MAAM,EACN,UAAU,CACX,CAAC;QACF,MAAM,UAAU,GAAG,WAAW,CAAC,WAAW,CACxC,mBAAmB,EACnB,MAAM,EACN,UAAU,CACX,CAAC;QAEF,IACE,IAAI,KAAK,SAAS;YAClB,cAAc,KAAK,SAAS;YAC5B,UAAU,KAAK,SAAS,EACxB;YACA,0BAA0B;YAC1B,IAAI,KAAK,CAAC,OAAO,EAAE;gBACjB,MAAM,UAAU,GAAG,oCAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;gBACtE,KAAK,CACH,0DAA0D;oBACxD,8EAA8E,EAChF,UAAU,CACX,CAAC;aACH;YAED,OAAO,SAAS,CAAC;SAClB;QAED,OAAO;YACL,IAAI;YACJ,cAAc;YACd,UAAU;SACX,CAAC;IACJ,CAAC;;AAtOH,8CAuOC;AAtOC;;;GAGG;AACa,2BAAS,GAAG,mBAAS,CAAC;AACtC;;GAEG;AACa,qCAAmB,GAAG,WAAW,CAAC"}

package/dist/{src/reflect.d.ts → reflect.d.ts}

@@ -1,35 +1,36 @@
 import 'reflect-metadata';
 export declare class NamespacedReflect {
-    private namespace;
+    private namespace?;
     /**
-     * @param namespace : namespace to bind this reflect context
+     * @param namespace - Namespace to bind this reflect context
      */
     constructor(namespace?: string | undefined);
-    private getMetadataKey(metadataKey);
+    private getMetadataKey;
     /**
      * define metadata for a target class or it's property/method
      */
-    defineMetadata(metadataKey: string, metadataValue: any, target: Object, propertyKey?: string | symbol): void;
+    defineMetadata(metadataKey: string, metadataValue: any, target: Object, propertyKey?: string): void;
     /**
      * lookup metadata from a target object and its prototype chain
      */
-    getMetadata(metadataKey: string, target: Object, propertyKey?: string | symbol): any;
+    getMetadata(metadataKey: string, target: Object, propertyKey?: string): any;
     /**
      * get own metadata for a target object or it's property/method
      */
-    getOwnMetadata(metadataKey: string, target: Object, propertyKey?: string | symbol): any;
+    getOwnMetadata(metadataKey: string, target: Object, propertyKey?: string): any;
     /**
      * Check if the target has corresponding metadata
-     * @param metadataKey Key
-     * @param target Target
-     * @param propertyKey Optional property key
+     * @param metadataKey - Key
+     * @param target - Target
+     * @param propertyKey - Optional property key
      */
-    hasMetadata(metadataKey: string, target: Object, propertyKey?: string | symbol): boolean;
-    hasOwnMetadata(metadataKey: string, target: Object, propertyKey?: string | symbol): boolean;
-    deleteMetadata(metadataKey: string, target: Object, propertyKey?: string | symbol): boolean;
-    getMetadataKeys(target: Object, propertyKey?: string | symbol): string[];
-    getOwnMetadataKeys(target: Object, propertyKey?: string | symbol): string[];
-    decorate(decorators: (PropertyDecorator | MethodDecorator)[] | ClassDecorator[], target: Object, targetKey?: string | symbol, descriptor?: PropertyDescriptor): PropertyDescriptor | Function;
+    hasMetadata(metadataKey: string, target: Object, propertyKey?: string): boolean;
+    hasOwnMetadata(metadataKey: string, target: Object, propertyKey?: string): boolean;
+    deleteMetadata(metadataKey: string, target: Object, propertyKey?: string): boolean;
+    getMetadataKeys(target: Object, propertyKey?: string): string[];
+    getOwnMetadataKeys(target: Object, propertyKey?: string): string[];
+    decorate(decorators: (PropertyDecorator | MethodDecorator)[], target: Object, targetKey?: string | symbol, descriptor?: PropertyDescriptor): PropertyDescriptor | Function;
+    decorate(decorators: ClassDecorator[], target: Object): PropertyDescriptor | Function;
     metadata(metadataKey: string, metadataValue: any): {
         (target: Function): void;
         (target: Object, targetKey: string | symbol): void;

package/dist/{src/reflect.js → reflect.js}

@@ -1,17 +1,18 @@
 "use strict";
-// Copyright IBM Corp. 2017. All Rights Reserved.
+// Copyright IBM Corp. 2017,2019. All Rights Reserved.
 // Node module: @loopback/metadata
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reflector = exports.NamespacedReflect = void 0;
 require("reflect-metadata");
-/* tslint:disable:no-any */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /*
  * namespaced wrapper to handle reflect api
  */
 class NamespacedReflect {
     /**
-     * @param namespace : namespace to bind this reflect context
+     * @param namespace - Namespace to bind this reflect context
      */
     constructor(namespace) {
         this.namespace = namespace;
@@ -54,9 +55,9 @@ class NamespacedReflect {
     }
     /**
      * Check if the target has corresponding metadata
-     * @param metadataKey Key
-     * @param target Target
-     * @param propertyKey Optional property key
+     * @param metadataKey - Key
+     * @param target - Target
+     * @param propertyKey - Optional property key
      */
     hasMetadata(metadataKey, target, propertyKey) {
         metadataKey = this.getMetadataKey(metadataKey);
@@ -131,13 +132,11 @@ class NamespacedReflect {
             return Reflect.decorate(decorators, target);
         }
     }
-    /* tslint:disable-next-line:no-any */
     metadata(metadataKey, metadataValue) {
         metadataKey = this.getMetadataKey(metadataKey);
         return Reflect.metadata(metadataKey, metadataValue);
     }
 }
 exports.NamespacedReflect = NamespacedReflect;
-/* tslint:disable-next-line:variable-name */
 exports.Reflector = new NamespacedReflect('loopback');
 //# sourceMappingURL=reflect.js.map

package/dist/reflect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reflect.js","sourceRoot":"","sources":["../src/reflect.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,kCAAkC;AAClC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,4BAA0B;AAE1B,uDAAuD;AAEvD;;GAEG;AACH,MAAa,iBAAiB;IAC5B;;OAEG;IACH,YAAoB,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;IAAG,CAAC;IAElC,cAAc,CAAC,WAAmB;QACxC,qDAAqD;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,WAAmB,EACnB,aAAkB,EAClB,MAAc,EACd,WAAoB;QAEpB,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,WAAW,EAAE;YACf,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;SACzE;aAAM;YACL,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;SAC5D;IACH,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,WAAmB,EAAE,MAAc,EAAE,WAAoB;QACnE,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,WAAW,EAAE;YACf,OAAO,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;SAC9D;QACD,OAAO,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,WAAmB,EACnB,MAAc,EACd,WAAoB;QAEpB,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,WAAW,EAAE;YACf,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;SACjE;QACD,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,WAAW,CACT,WAAmB,EACnB,MAAc,EACd,WAAoB;QAEpB,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,WAAW,EAAE;YACf,OAAO,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;SAC9D;QACD,OAAO,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,cAAc,CACZ,WAAmB,EACnB,MAAc,EACd,WAAoB;QAEpB,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,WAAW,EAAE;YACf,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;SACjE;QACD,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,cAAc,CACZ,WAAmB,EACnB,MAAc,EACd,WAAoB;QAEpB,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,WAAW,EAAE;YACf,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;SACjE;QACD,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,eAAe,CAAC,MAAc,EAAE,WAAoB;QAClD,IAAI,IAAc,CAAC;QACnB,IAAI,WAAW,EAAE;YACf,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;SACrD;aAAM;YACL,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;SACxC;QACD,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,SAAS;gBAAE,OAAO,IAAI,CAAC,CAAC,6BAA6B;YAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;YACpC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;oBAC7B,0CAA0C;oBAC1C,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;iBAC1C;aACF;SACF;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,MAAc,EAAE,WAAoB;QACrD,IAAI,IAAc,CAAC;QACnB,IAAI,WAAW,EAAE;YACf,IAAI,GAAG,OAAO,CAAC,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;SACxD;aAAM;YACL,IAAI,GAAG,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;SAC3C;QACD,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,CAAC,SAAS;gBAAE,OAAO,IAAI,CAAC,CAAC,6BAA6B;YAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;YACpC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;oBAC7B,0CAA0C;oBAC1C,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;iBAC1C;aACF;SACF;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAcD,QAAQ,CACN,UAAsE,EACtE,MAAc,EACd,SAA2B,EAC3B,UAA+B;QAE/B,IAAI,SAAS,EAAE;YACb,OAAO,OAAO,CAAC,QAAQ,CACoB,UAAU,EACnD,MAAM,EACN,SAAS,EACT,UAAU,CACX,CAAC;SACH;aAAM;YACL,OAAO,OAAO,CAAC,QAAQ,CAAmB,UAAU,EAAY,MAAM,CAAC,CAAC;SACzE;IACH,CAAC;IAED,QAAQ,CACN,WAAmB,EACnB,aAAkB;QAKlB,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IACtD,CAAC;CACF;AAlLD,8CAkLC;AAEY,QAAA,SAAS,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Decorator function types
+ */
+export declare type DecoratorType = ClassDecorator | PropertyDecorator | MethodDecorator | ParameterDecorator;
+/**
+ * A strongly-typed metadata accessor via reflection
+ * @typeParam T - Type of the metadata value
+ * @typeParam D - Type of the decorator
+ */
+export declare class MetadataAccessor<T, D extends DecoratorType = DecoratorType> {
+    readonly key: string;
+    private constructor();
+    toString(): string;
+    /**
+     * Create a strongly-typed metadata accessor
+     * @param key - The metadata key
+     * @typeParam V - Type of the metadata value
+     * @typeParam DT - Type of the decorator
+     */
+    static create<V, DT extends DecoratorType>(key: string): MetadataAccessor<V, DT>;
+}
+/**
+ * Key for metadata access via reflection
+ * @typeParam T - Type of the metadata value
+ * @typeParam D - Type of the decorator
+ */
+export declare type MetadataKey<T, D extends DecoratorType> = MetadataAccessor<T, D> | string;
+/**
+ * An object mapping keys to corresponding metadata
+ */
+export interface MetadataMap<T> {
+    [propertyOrMethodName: string]: T;
+}
+/**
+ * Design time metadata for a method.
+ *
+ * @example
+ * ```ts
+ * class MyController
+ * {
+ *   myMethod(x: string, y: number, z: MyClass): boolean {
+ *     // ...
+ *     return true;
+ *   }
+ * }
+ * ```
+ *
+ * The `myMethod` above has design-time metadata as follows:
+ * ```ts
+ * {
+ *   type: Function,
+ *   parameterTypes: [String, Number, MyClass],
+ *   returnType: Boolean
+ * }
+ * ```
+ */
+export interface DesignTimeMethodMetadata {
+    /**
+     * Type of the method itself. It is `Function` for methods, `undefined` for the constructor.
+     */
+    type: Function | undefined;
+    /**
+     * An array of parameter types.
+     */
+    parameterTypes: Function[];
+    /**
+     * Return type, may be `undefined` (e.g. for constructors).
+     */
+    returnType: Function | undefined;
+}

package/dist/types.js

@@ -0,0 +1,32 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Node module: @loopback/metadata
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataAccessor = void 0;
+/**
+ * A strongly-typed metadata accessor via reflection
+ * @typeParam T - Type of the metadata value
+ * @typeParam D - Type of the decorator
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+class MetadataAccessor {
+    constructor(key) {
+        this.key = key;
+    }
+    toString() {
+        return this.key;
+    }
+    /**
+     * Create a strongly-typed metadata accessor
+     * @param key - The metadata key
+     * @typeParam V - Type of the metadata value
+     * @typeParam DT - Type of the decorator
+     */
+    static create(key) {
+        return new MetadataAccessor(key);
+    }
+}
+exports.MetadataAccessor = MetadataAccessor;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,kCAAkC;AAClC,+CAA+C;AAC/C,gEAAgE;;;AAWhE;;;;GAIG;AACH,6DAA6D;AAC7D,MAAa,gBAAgB;IAC3B,YAAoC,GAAW;QAAX,QAAG,GAAH,GAAG,CAAQ;IAAG,CAAC;IAEnD,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAA8B,GAAW;QACpD,OAAO,IAAI,gBAAgB,CAAQ,GAAG,CAAC,CAAC;IAC1C,CAAC;CACF;AAhBD,4CAgBC"}

package/package.json

@@ -1,57 +1,56 @@
 {
   "name": "@loopback/metadata",
-  "version": "4.0.0-alpha.8",
-  "description": "LoopBack's metadata utilities for reflection and decoration",
+  "description": "Utilities to help developers implement TypeScript decorators, define/merge metadata, and inspect metadata",
+  "version": "4.1.0",
+  "keywords": [
+    "LoopBack",
+    "Decorators",
+    "Reflect"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "packages/metadata"
+  },
   "engines": {
-    "node": ">=6"
+    "node": "12 || 14 || 16 || 17"
   },
   "scripts": {
-    "acceptance": "lb-mocha \"DIST/test/acceptance/**/*.js\"",
-    "build": "npm run build:dist && npm run build:dist6",
-    "build:current": "lb-tsc",
-    "build:dist": "lb-tsc es2017",
-    "build:dist6": "lb-tsc es2015",
-    "build:apidocs": "lb-apidocs",
-    "clean": "lb-clean loopback-metadata*.tgz dist dist6 package api-docs",
-    "prepublishOnly": "npm run build && npm run build:apidocs",
-    "pretest": "npm run build:current",
-    "test": "lb-mocha \"DIST/test/unit/**/*.js\" \"DIST/test/acceptance/**/*.js\"",
-    "unit": "lb-mocha \"DIST/test/unit/**/*.js\"",
+    "acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-metadata*.tgz dist *.tsbuildinfo package",
+    "pretest": "npm run build",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\"",
+    "unit": "lb-mocha \"dist/__tests__/unit/**/*.js\"",
     "verify": "npm pack && tar xf loopback-metadata*.tgz && tree package && npm run clean"
   },
-  "author": "IBM",
-  "copyright.owner": "IBM Corp.",
-  "license": "MIT",
-  "dependencies": {
-    "debug": "^3.1.0",
-    "lodash": "^4.17.4",
-    "reflect-metadata": "^0.1.10"
-  },
-  "devDependencies": {
-    "@loopback/build": "^4.0.0-alpha.12",
-    "@loopback/testlab": "^4.0.0-alpha.22",
-    "@types/debug": "^0.0.30",
-    "@types/lodash": "^4.14.96"
+  "publishConfig": {
+    "access": "public"
   },
-  "keywords": [
-    "LoopBack",
-    "Decorators",
-    "Reflect"
-  ],
   "files": [
     "README.md",
-    "index.js",
-    "index.d.ts",
-    "dist/src",
-    "dist6/src",
-    "api-docs",
-    "src"
+    "dist",
+    "src",
+    "!*/__tests__"
   ],
-  "publishConfig": {
-    "access": "public"
+  "dependencies": {
+    "debug": "^4.3.3",
+    "lodash": "^4.17.21",
+    "reflect-metadata": "^0.1.13",
+    "tslib": "^2.3.1"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/strongloop/loopback-next.git"
-  }
+  "devDependencies": {
+    "@loopback/build": "^8.1.0",
+    "@loopback/eslint-config": "^12.0.2",
+    "@loopback/testlab": "^4.1.0",
+    "@types/debug": "^4.1.7",
+    "@types/lodash": "^4.14.178",
+    "@types/node": "^12.20.43"
+  },
+  "gitHead": "e16818ccb01edc0269ef6c45b022c5f1b67f852c"
 }