@loopback/context 4.0.0-alpha.6 → 4.0.0

package/dist/inject.js

@@ -0,0 +1,535 @@
+"use strict";
+// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Node module: @loopback/context
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasInjections = exports.inspectInjections = exports.describeInjectedProperties = exports.inspectTargetType = exports.describeInjectedArguments = exports.assertTargetType = exports.Getter = exports.inject = void 0;
+const metadata_1 = require("@loopback/metadata");
+const binding_1 = require("./binding");
+const binding_filter_1 = require("./binding-filter");
+const context_view_1 = require("./context-view");
+const resolution_session_1 = require("./resolution-session");
+const INJECT_PARAMETERS_KEY = metadata_1.MetadataAccessor.create('inject:parameters');
+const INJECT_PROPERTIES_KEY = metadata_1.MetadataAccessor.create('inject:properties');
+// A key to cache described argument injections
+const INJECT_METHODS_KEY = metadata_1.MetadataAccessor.create('inject:methods');
+/**
+ * A decorator to annotate method arguments for automatic injection
+ * by LoopBack IoC container.
+ *
+ * @example
+ * Usage - Typescript:
+ *
+ * ```ts
+ * class InfoController {
+ *   @inject('authentication.user') public userName: string;
+ *
+ *   constructor(@inject('application.name') public appName: string) {
+ *   }
+ *   // ...
+ * }
+ * ```
+ *
+ * Usage - JavaScript:
+ *
+ *  - TODO(bajtos)
+ *
+ * @param bindingSelector - What binding to use in order to resolve the value of the
+ * decorated constructor parameter or property.
+ * @param metadata - Optional metadata to help the injection
+ * @param resolve - Optional function to resolve the injection
+ *
+ */
+function inject(bindingSelector, metadata, resolve) {
+    if (typeof bindingSelector === 'function' && !resolve) {
+        resolve = resolveValuesByFilter;
+    }
+    const injectionMetadata = Object.assign({ decorator: '@inject' }, metadata);
+    if (injectionMetadata.bindingComparator && !resolve) {
+        throw new Error('Binding comparator is only allowed with a binding filter');
+    }
+    if (!bindingSelector && typeof resolve !== 'function') {
+        throw new Error('A non-empty binding selector or resolve function is required for @inject');
+    }
+    return function markParameterOrPropertyAsInjected(target, member, methodDescriptorOrParameterIndex) {
+        if (typeof methodDescriptorOrParameterIndex === 'number') {
+            // The decorator is applied to a method parameter
+            // Please note propertyKey is `undefined` for constructor
+            const paramDecorator = metadata_1.ParameterDecoratorFactory.createDecorator(INJECT_PARAMETERS_KEY, {
+                target,
+                member,
+                methodDescriptorOrParameterIndex,
+                bindingSelector,
+                metadata: injectionMetadata,
+                resolve,
+            }, 
+            // Do not deep clone the spec as only metadata is mutable and it's
+            // shallowly cloned
+            { cloneInputSpec: false, decoratorName: injectionMetadata.decorator });
+            paramDecorator(target, member, methodDescriptorOrParameterIndex);
+        }
+        else if (member) {
+            // Property or method
+            if (target instanceof Function) {
+                throw new Error('@inject is not supported for a static property: ' +
+                    metadata_1.DecoratorFactory.getTargetName(target, member));
+            }
+            if (methodDescriptorOrParameterIndex) {
+                // Method
+                throw new Error('@inject cannot be used on a method: ' +
+                    metadata_1.DecoratorFactory.getTargetName(target, member, methodDescriptorOrParameterIndex));
+            }
+            const propDecorator = metadata_1.PropertyDecoratorFactory.createDecorator(INJECT_PROPERTIES_KEY, {
+                target,
+                member,
+                methodDescriptorOrParameterIndex,
+                bindingSelector,
+                metadata: injectionMetadata,
+                resolve,
+            }, 
+            // Do not deep clone the spec as only metadata is mutable and it's
+            // shallowly cloned
+            { cloneInputSpec: false, decoratorName: injectionMetadata.decorator });
+            propDecorator(target, member);
+        }
+        else {
+            // It won't happen here as `@inject` is not compatible with ClassDecorator
+            /* istanbul ignore next */
+            throw new Error('@inject can only be used on a property or a method parameter');
+        }
+    };
+}
+exports.inject = inject;
+var Getter;
+(function (Getter) {
+    /**
+     * Convert a value into a Getter returning that value.
+     * @param value
+     */
+    function fromValue(value) {
+        return () => Promise.resolve(value);
+    }
+    Getter.fromValue = fromValue;
+})(Getter = exports.Getter || (exports.Getter = {}));
+(function (inject) {
+    /**
+     * Inject a function for getting the actual bound value.
+     *
+     * This is useful when implementing Actions, where
+     * the action is instantiated for Sequence constructor, but some
+     * of action's dependencies become bound only after other actions
+     * have been executed by the sequence.
+     *
+     * See also `Getter<T>`.
+     *
+     * @param bindingSelector - The binding key or filter we want to eventually get
+     * value(s) from.
+     * @param metadata - Optional metadata to help the injection
+     */
+    inject.getter = function injectGetter(bindingSelector, metadata) {
+        metadata = Object.assign({ decorator: '@inject.getter' }, metadata);
+        return inject(bindingSelector, metadata, (0, binding_filter_1.isBindingAddress)(bindingSelector)
+            ? resolveAsGetter
+            : resolveAsGetterByFilter);
+    };
+    /**
+     * Inject a function for setting (binding) the given key to a given
+     * value. (Only static/constant values are supported, it's not possible
+     * to bind a key to a class or a provider.)
+     *
+     * This is useful e.g. when implementing Actions that are contributing
+     * new Elements.
+     *
+     * See also `Setter<T>`.
+     *
+     * @param bindingKey - The key of the value we want to set.
+     * @param metadata - Optional metadata to help the injection
+     */
+    inject.setter = function injectSetter(bindingKey, metadata) {
+        metadata = Object.assign({ decorator: '@inject.setter' }, metadata);
+        return inject(bindingKey, metadata, resolveAsSetter);
+    };
+    /**
+     * Inject the binding object for the given key. This is useful if a binding
+     * needs to be set up beyond just a constant value allowed by
+     * `@inject.setter`. The injected binding is found or created based on the
+     * `metadata.bindingCreation` option. See `BindingCreationPolicy` for more
+     * details.
+     *
+     * @example
+     *
+     * ```ts
+     * class MyAuthAction {
+     *   @inject.binding('current-user', {
+     *     bindingCreation: BindingCreationPolicy.ALWAYS_CREATE,
+     *   })
+     *   private userBinding: Binding<UserProfile>;
+     *
+     *   async authenticate() {
+     *     this.userBinding.toDynamicValue(() => {...});
+     *   }
+     * }
+     * ```
+     *
+     * @param bindingKey - Binding key
+     * @param metadata - Metadata for the injection
+     */
+    inject.binding = function injectBinding(bindingKey, metadata) {
+        metadata = Object.assign({ decorator: '@inject.binding' }, metadata);
+        return inject(bindingKey !== null && bindingKey !== void 0 ? bindingKey : '', metadata, resolveAsBinding);
+    };
+    /**
+     * Inject an array of values by a tag pattern string or regexp
+     *
+     * @example
+     * ```ts
+     * class AuthenticationManager {
+     *   constructor(
+     *     @inject.tag('authentication.strategy') public strategies: Strategy[],
+     *   ) {}
+     * }
+     * ```
+     * @param bindingTag - Tag name, regex or object
+     * @param metadata - Optional metadata to help the injection
+     */
+    inject.tag = function injectByTag(bindingTag, metadata) {
+        metadata = Object.assign({ decorator: '@inject.tag', tag: bindingTag }, metadata);
+        return inject((0, binding_filter_1.filterByTag)(bindingTag), metadata);
+    };
+    /**
+     * Inject matching bound values by the filter function
+     *
+     * @example
+     * ```ts
+     * class MyControllerWithView {
+     *   @inject.view(filterByTag('foo'))
+     *   view: ContextView<string[]>;
+     * }
+     * ```
+     * @param bindingFilter - A binding filter function
+     * @param metadata
+     */
+    inject.view = function injectContextView(bindingFilter, metadata) {
+        metadata = Object.assign({ decorator: '@inject.view' }, metadata);
+        return inject(bindingFilter, metadata, resolveAsContextView);
+    };
+    /**
+     * Inject the context object.
+     *
+     * @example
+     * ```ts
+     * class MyProvider {
+     *  constructor(@inject.context() private ctx: Context) {}
+     * }
+     * ```
+     */
+    inject.context = function injectContext() {
+        return inject('', { decorator: '@inject.context' }, (ctx) => ctx);
+    };
+})(inject = exports.inject || (exports.inject = {}));
+/**
+ * Assert the target type inspected from TypeScript for injection to be the
+ * expected type. If the types don't match, an error is thrown.
+ * @param injection - Injection information
+ * @param expectedType - Expected type
+ * @param expectedTypeName - Name of the expected type to be used in the error
+ * @returns The name of the target
+ */
+function assertTargetType(injection, expectedType, expectedTypeName) {
+    const targetName = resolution_session_1.ResolutionSession.describeInjection(injection).targetName;
+    const targetType = inspectTargetType(injection);
+    if (targetType && targetType !== expectedType) {
+        expectedTypeName = expectedTypeName !== null && expectedTypeName !== void 0 ? expectedTypeName : expectedType.name;
+        throw new Error(`The type of ${targetName} (${targetType.name}) is not ${expectedTypeName}`);
+    }
+    return targetName;
+}
+exports.assertTargetType = assertTargetType;
+/**
+ * Resolver for `@inject.getter`
+ * @param ctx
+ * @param injection
+ * @param session
+ */
+function resolveAsGetter(ctx, injection, session) {
+    assertTargetType(injection, Function, 'Getter function');
+    const bindingSelector = injection.bindingSelector;
+    // We need to clone the session for the getter as it will be resolved later
+    const forkedSession = resolution_session_1.ResolutionSession.fork(session);
+    const options = {
+        session: forkedSession,
+        ...injection.metadata,
+    };
+    return function getter() {
+        return ctx.get(bindingSelector, options);
+    };
+}
+/**
+ * Resolver for `@inject.setter`
+ * @param ctx
+ * @param injection
+ */
+function resolveAsSetter(ctx, injection) {
+    const targetName = assertTargetType(injection, Function, 'Setter function');
+    const bindingSelector = injection.bindingSelector;
+    if (!(0, binding_filter_1.isBindingAddress)(bindingSelector)) {
+        throw new Error(`@inject.setter (${targetName}) does not allow BindingFilter.`);
+    }
+    if (bindingSelector === '') {
+        throw new Error('Binding key is not set for @inject.setter');
+    }
+    // No resolution session should be propagated into the setter
+    return function setter(value) {
+        const binding = findOrCreateBindingForInjection(ctx, injection);
+        binding.to(value);
+    };
+}
+function resolveAsBinding(ctx, injection, session) {
+    const targetName = assertTargetType(injection, binding_1.Binding);
+    const bindingSelector = injection.bindingSelector;
+    if (!(0, binding_filter_1.isBindingAddress)(bindingSelector)) {
+        throw new Error(`@inject.binding (${targetName}) does not allow BindingFilter.`);
+    }
+    return findOrCreateBindingForInjection(ctx, injection, session);
+}
+function findOrCreateBindingForInjection(ctx, injection, session) {
+    if (injection.bindingSelector === '')
+        return session === null || session === void 0 ? void 0 : session.currentBinding;
+    const bindingCreation = injection.metadata &&
+        injection.metadata.bindingCreation;
+    const binding = ctx.findOrCreateBinding(injection.bindingSelector, bindingCreation);
+    return binding;
+}
+/**
+ * Check if constructor injection should be applied to the base class
+ * of the given target class
+ *
+ * @param targetClass - Target class
+ */
+function shouldSkipBaseConstructorInjection(targetClass) {
+    // FXIME(rfeng): We use the class definition to check certain patterns
+    const classDef = targetClass.toString();
+    return (
+    /*
+     * See https://github.com/loopbackio/loopback-next/issues/2946
+     * A class decorator can return a new constructor that mixes in
+     * additional properties/methods.
+     *
+     * @example
+     * ```ts
+     * class extends baseConstructor {
+     *   // The constructor calls `super(...arguments)`
+     *   constructor() {
+     *     super(...arguments);
+     *   }
+     *   classProperty = 'a classProperty';
+     *   classFunction() {
+     *     return 'a classFunction';
+     *   }
+     * };
+     * ```
+     *
+     * We check the following pattern:
+     * ```ts
+     * constructor() {
+     *   super(...arguments);
+     * }
+     * ```
+     */
+    !classDef.match(/\s+constructor\s*\(\s*\)\s*\{\s*super\(\.\.\.arguments\)/) &&
+        /*
+         * See https://github.com/loopbackio/loopback-next/issues/1565
+         *
+         * @example
+         * ```ts
+         * class BaseClass {
+         *   constructor(@inject('foo') protected foo: string) {}
+         *   // ...
+         * }
+         *
+         * class SubClass extends BaseClass {
+         *   // No explicit constructor is present
+         *
+         *   @inject('bar')
+         *   private bar: number;
+         *   // ...
+         * };
+         *
+         */
+        classDef.match(/\s+constructor\s*\([^\)]*\)\s+\{/m));
+}
+/**
+ * Return an array of injection objects for parameters
+ * @param target - The target class for constructor or static methods,
+ * or the prototype for instance methods
+ * @param method - Method name, undefined for constructor
+ */
+function describeInjectedArguments(target, method) {
+    var _a, _b;
+    method = method !== null && method !== void 0 ? method : '';
+    // Try to read from cache
+    const cache = (_a = metadata_1.MetadataInspector.getAllMethodMetadata(INJECT_METHODS_KEY, target, {
+        ownMetadataOnly: true,
+    })) !== null && _a !== void 0 ? _a : {};
+    let meta = cache[method];
+    if (meta)
+        return meta;
+    // Build the description
+    const options = {};
+    if (method === '') {
+        if (shouldSkipBaseConstructorInjection(target)) {
+            options.ownMetadataOnly = true;
+        }
+    }
+    else if (Object.prototype.hasOwnProperty.call(target, method)) {
+        // The method exists in the target, no injections on the super method
+        // should be honored
+        options.ownMetadataOnly = true;
+    }
+    meta =
+        (_b = metadata_1.MetadataInspector.getAllParameterMetadata(INJECT_PARAMETERS_KEY, target, method, options)) !== null && _b !== void 0 ? _b : [];
+    // Cache the result
+    cache[method] = meta;
+    metadata_1.MetadataInspector.defineMetadata(INJECT_METHODS_KEY, cache, target);
+    return meta;
+}
+exports.describeInjectedArguments = describeInjectedArguments;
+/**
+ * Inspect the target type for the injection to find out the corresponding
+ * JavaScript type
+ * @param injection - Injection information
+ */
+function inspectTargetType(injection) {
+    var _a;
+    if (typeof injection.methodDescriptorOrParameterIndex === 'number') {
+        const designType = metadata_1.MetadataInspector.getDesignTypeForMethod(injection.target, injection.member);
+        return (_a = designType === null || designType === void 0 ? void 0 : designType.parameterTypes) === null || _a === void 0 ? void 0 : _a[injection.methodDescriptorOrParameterIndex];
+    }
+    return metadata_1.MetadataInspector.getDesignTypeForProperty(injection.target, injection.member);
+}
+exports.inspectTargetType = inspectTargetType;
+/**
+ * Resolve an array of bound values matching the filter function for `@inject`.
+ * @param ctx - Context object
+ * @param injection - Injection information
+ * @param session - Resolution session
+ */
+function resolveValuesByFilter(ctx, injection, session) {
+    assertTargetType(injection, Array);
+    const bindingFilter = injection.bindingSelector;
+    const view = new context_view_1.ContextView(ctx, bindingFilter, injection.metadata.bindingComparator);
+    return view.resolve(session);
+}
+/**
+ * Resolve to a getter function that returns an array of bound values matching
+ * the filter function for `@inject.getter`.
+ *
+ * @param ctx - Context object
+ * @param injection - Injection information
+ * @param session - Resolution session
+ */
+function resolveAsGetterByFilter(ctx, injection, session) {
+    assertTargetType(injection, Function, 'Getter function');
+    const bindingFilter = injection.bindingSelector;
+    return (0, context_view_1.createViewGetter)(ctx, bindingFilter, injection.metadata.bindingComparator, session);
+}
+/**
+ * Resolve to an instance of `ContextView` by the binding filter function
+ * for `@inject.view`
+ * @param ctx - Context object
+ * @param injection - Injection information
+ */
+function resolveAsContextView(ctx, injection) {
+    assertTargetType(injection, context_view_1.ContextView);
+    const bindingFilter = injection.bindingSelector;
+    const view = new context_view_1.ContextView(ctx, bindingFilter, injection.metadata.bindingComparator);
+    view.open();
+    return view;
+}
+/**
+ * Return a map of injection objects for properties
+ * @param target - The target class for static properties or
+ * prototype for instance properties.
+ */
+function describeInjectedProperties(target) {
+    var _a;
+    const metadata = (_a = metadata_1.MetadataInspector.getAllPropertyMetadata(INJECT_PROPERTIES_KEY, target)) !== null && _a !== void 0 ? _a : {};
+    return metadata;
+}
+exports.describeInjectedProperties = describeInjectedProperties;
+/**
+ * Inspect injections for a binding created with `toClass` or `toProvider`
+ * @param binding - Binding object
+ */
+function inspectInjections(binding) {
+    var _a;
+    const json = {};
+    const ctor = (_a = binding.valueConstructor) !== null && _a !== void 0 ? _a : binding.providerConstructor;
+    if (ctor == null)
+        return json;
+    const constructorInjections = describeInjectedArguments(ctor, '').map(inspectInjection);
+    if (constructorInjections.length) {
+        json.constructorArguments = constructorInjections;
+    }
+    const propertyInjections = describeInjectedProperties(ctor.prototype);
+    const properties = {};
+    for (const p in propertyInjections) {
+        properties[p] = inspectInjection(propertyInjections[p]);
+    }
+    if (Object.keys(properties).length) {
+        json.properties = properties;
+    }
+    return json;
+}
+exports.inspectInjections = inspectInjections;
+/**
+ * Inspect an injection
+ * @param injection - Injection information
+ */
+function inspectInjection(injection) {
+    var _a, _b;
+    const injectionInfo = resolution_session_1.ResolutionSession.describeInjection(injection);
+    const descriptor = {};
+    if (injectionInfo.targetName) {
+        descriptor.targetName = injectionInfo.targetName;
+    }
+    if ((0, binding_filter_1.isBindingAddress)(injectionInfo.bindingSelector)) {
+        // Binding key
+        descriptor.bindingKey = injectionInfo.bindingSelector.toString();
+    }
+    else if ((0, binding_filter_1.isBindingTagFilter)(injectionInfo.bindingSelector)) {
+        // Binding tag filter
+        descriptor.bindingTagPattern = JSON.parse(JSON.stringify(injectionInfo.bindingSelector.bindingTagPattern));
+    }
+    else {
+        // Binding filter function
+        descriptor.bindingFilter =
+            (_b = (_a = injectionInfo.bindingSelector) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : '<function>';
+    }
+    // Inspect metadata
+    if (injectionInfo.metadata) {
+        if (injectionInfo.metadata.decorator &&
+            injectionInfo.metadata.decorator !== '@inject') {
+            descriptor.decorator = injectionInfo.metadata.decorator;
+        }
+        if (injectionInfo.metadata.optional) {
+            descriptor.optional = injectionInfo.metadata.optional;
+        }
+    }
+    return descriptor;
+}
+/**
+ * Check if the given class has `@inject` or other decorations that map to
+ * `@inject`.
+ *
+ * @param cls - Class with possible `@inject` decorations
+ */
+function hasInjections(cls) {
+    return (metadata_1.MetadataInspector.getClassMetadata(INJECT_PARAMETERS_KEY, cls) != null ||
+        metadata_1.Reflector.getMetadata(INJECT_PARAMETERS_KEY.toString(), cls.prototype) !=
+            null ||
+        metadata_1.MetadataInspector.getAllPropertyMetadata(INJECT_PROPERTIES_KEY, cls.prototype) != null);
+}
+exports.hasInjections = hasInjections;
+//# sourceMappingURL=inject.js.map

package/dist/inject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inject.js","sourceRoot":"","sources":["../src/inject.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,iDAS4B;AAC5B,uCAA8C;AAC9C,qDAM0B;AAI1B,iDAA6D;AAE7D,6DAA0E;AAG1E,MAAM,qBAAqB,GAAG,2BAAgB,CAAC,MAAM,CAGnD,mBAAmB,CAAC,CAAC;AAEvB,MAAM,qBAAqB,GAAG,2BAAgB,CAAC,MAAM,CAGnD,mBAAmB,CAAC,CAAC;AAEvB,+CAA+C;AAC/C,MAAM,kBAAkB,GAAG,2BAAgB,CAAC,MAAM,CAChD,gBAAgB,CACjB,CAAC;AAwDF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,MAAM,CACpB,eAAgC,EAChC,QAA4B,EAC5B,OAA0B;IAE1B,IAAI,OAAO,eAAe,KAAK,UAAU,IAAI,CAAC,OAAO,EAAE;QACrD,OAAO,GAAG,qBAAqB,CAAC;KACjC;IACD,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,SAAS,EAAE,SAAS,EAAC,EAAE,QAAQ,CAAC,CAAC;IAC1E,IAAI,iBAAiB,CAAC,iBAAiB,IAAI,CAAC,OAAO,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC7E;IACD,IAAI,CAAC,eAAe,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;QACrD,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;KACH;IACD,OAAO,SAAS,iCAAiC,CAC/C,MAAc,EACd,MAA0B,EAC1B,gCAEU;QAEV,IAAI,OAAO,gCAAgC,KAAK,QAAQ,EAAE;YACxD,iDAAiD;YACjD,yDAAyD;YACzD,MAAM,cAAc,GAClB,oCAAyB,CAAC,eAAe,CACvC,qBAAqB,EACrB;gBACE,MAAM;gBACN,MAAM;gBACN,gCAAgC;gBAChC,eAAe;gBACf,QAAQ,EAAE,iBAAiB;gBAC3B,OAAO;aACR;YACD,kEAAkE;YAClE,mBAAmB;YACnB,EAAC,cAAc,EAAE,KAAK,EAAE,aAAa,EAAE,iBAAiB,CAAC,SAAS,EAAC,CACpE,CAAC;YACJ,cAAc,CAAC,MAAM,EAAE,MAAO,EAAE,gCAAgC,CAAC,CAAC;SACnE;aAAM,IAAI,MAAM,EAAE;YACjB,qBAAqB;YACrB,IAAI,MAAM,YAAY,QAAQ,EAAE;gBAC9B,MAAM,IAAI,KAAK,CACb,kDAAkD;oBAChD,2BAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CACjD,CAAC;aACH;YACD,IAAI,gCAAgC,EAAE;gBACpC,SAAS;gBACT,MAAM,IAAI,KAAK,CACb,sCAAsC;oBACpC,2BAAgB,CAAC,aAAa,CAC5B,MAAM,EACN,MAAM,EACN,gCAAgC,CACjC,CACJ,CAAC;aACH;YACD,MAAM,aAAa,GACjB,mCAAwB,CAAC,eAAe,CACtC,qBAAqB,EACrB;gBACE,MAAM;gBACN,MAAM;gBACN,gCAAgC;gBAChC,eAAe;gBACf,QAAQ,EAAE,iBAAiB;gBAC3B,OAAO;aACR;YACD,kEAAkE;YAClE,mBAAmB;YACnB,EAAC,cAAc,EAAE,KAAK,EAAE,aAAa,EAAE,iBAAiB,CAAC,SAAS,EAAC,CACpE,CAAC;YACJ,aAAa,CAAC,MAAM,EAAE,MAAO,CAAC,CAAC;SAChC;aAAM;YACL,0EAA0E;YAC1E,0BAA0B;YAC1B,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;IACH,CAAC,CAAC;AACJ,CAAC;AAtFD,wBAsFC;AASD,IAAiB,MAAM,CAQtB;AARD,WAAiB,MAAM;IACrB;;;OAGG;IACH,SAAgB,SAAS,CAAI,KAAQ;QACnC,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAFe,gBAAS,YAExB,CAAA;AACH,CAAC,EARgB,MAAM,GAAN,cAAM,KAAN,cAAM,QAQtB;AAyBD,WAAiB,MAAM;IACrB;;;;;;;;;;;;;OAaG;IACU,aAAM,GAAG,SAAS,YAAY,CACzC,eAAyC,EACzC,QAA4B;QAE5B,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,SAAS,EAAE,gBAAgB,EAAC,EAAE,QAAQ,CAAC,CAAC;QAClE,OAAO,MAAM,CACX,eAAe,EACf,QAAQ,EACR,IAAA,iCAAgB,EAAC,eAAe,CAAC;YAC/B,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,uBAAuB,CAC5B,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;;;;;;;OAYG;IACU,aAAM,GAAG,SAAS,YAAY,CACzC,UAA0B,EAC1B,QAAgC;QAEhC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,SAAS,EAAE,gBAAgB,EAAC,EAAE,QAAQ,CAAC,CAAC;QAClE,OAAO,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;IACvD,CAAC,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,cAAO,GAAG,SAAS,aAAa,CAC3C,UAAyC,EACzC,QAAgC;QAEhC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,SAAS,EAAE,iBAAiB,EAAC,EAAE,QAAQ,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC;IAC9D,CAAC,CAAC;IAEF;;;;;;;;;;;;;OAaG;IACU,UAAG,GAAG,SAAS,WAAW,CACrC,UAA+B,EAC/B,QAA4B;QAE5B,QAAQ,GAAG,MAAM,CAAC,MAAM,CACtB,EAAC,SAAS,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU,EAAC,EAC3C,QAAQ,CACT,CAAC;QACF,OAAO,MAAM,CAAC,IAAA,4BAAW,EAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC,CAAC;IAEF;;;;;;;;;;;;OAYG;IACU,WAAI,GAAG,SAAS,iBAAiB,CAC5C,aAA4B,EAC5B,QAA4B;QAE5B,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,SAAS,EAAE,cAAc,EAAC,EAAE,QAAQ,CAAC,CAAC;QAChE,OAAO,MAAM,CAAC,aAAa,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IAC/D,CAAC,CAAC;IAEF;;;;;;;;;OASG;IACU,cAAO,GAAG,SAAS,aAAa;QAC3C,OAAO,MAAM,CAAC,EAAE,EAAE,EAAC,SAAS,EAAE,iBAAiB,EAAC,EAAE,CAAC,GAAY,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC,EA9IgB,MAAM,GAAN,cAAM,KAAN,cAAM,QA8ItB;AAED;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAC9B,SAA8B,EAC9B,YAAsB,EACtB,gBAAyB;IAEzB,MAAM,UAAU,GAAG,sCAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC;IAC7E,MAAM,UAAU,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAChD,IAAI,UAAU,IAAI,UAAU,KAAK,YAAY,EAAE;QAC7C,gBAAgB,GAAG,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,YAAY,CAAC,IAAI,CAAC;QACzD,MAAM,IAAI,KAAK,CACb,eAAe,UAAU,KAAK,UAAU,CAAC,IAAI,YAAY,gBAAgB,EAAE,CAC5E,CAAC;KACH;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAdD,4CAcC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CACtB,GAAY,EACZ,SAA8B,EAC9B,OAA0B;IAE1B,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,SAAS,CAAC,eAAiC,CAAC;IACpE,2EAA2E;IAC3E,MAAM,aAAa,GAAG,sCAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,OAAO,GAAsB;QACjC,OAAO,EAAE,aAAa;QACtB,GAAG,SAAS,CAAC,QAAQ;KACtB,CAAC;IACF,OAAO,SAAS,MAAM;QACpB,OAAO,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,GAAY,EAAE,SAAoB;IACzD,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAC5E,MAAM,eAAe,GAAG,SAAS,CAAC,eAAe,CAAC;IAClD,IAAI,CAAC,IAAA,iCAAgB,EAAC,eAAe,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CACb,mBAAmB,UAAU,iCAAiC,CAC/D,CAAC;KACH;IACD,IAAI,eAAe,KAAK,EAAE,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;KAC9D;IACD,6DAA6D;IAC7D,OAAO,SAAS,MAAM,CAAC,KAAc;QACnC,MAAM,OAAO,GAAG,+BAA+B,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAChE,OAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,GAAY,EACZ,SAAoB,EACpB,OAA0B;IAE1B,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,EAAE,iBAAO,CAAC,CAAC;IACxD,MAAM,eAAe,GAAG,SAAS,CAAC,eAAe,CAAC;IAClD,IAAI,CAAC,IAAA,iCAAgB,EAAC,eAAe,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CACb,oBAAoB,UAAU,iCAAiC,CAChE,CAAC;KACH;IACD,OAAO,+BAA+B,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,+BAA+B,CACtC,GAAY,EACZ,SAA6B,EAC7B,OAA2B;IAE3B,IAAI,SAAS,CAAC,eAAe,KAAK,EAAE;QAAE,OAAO,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC;IACrE,MAAM,eAAe,GACnB,SAAS,CAAC,QAAQ;QACjB,SAAS,CAAC,QAAkC,CAAC,eAAe,CAAC;IAChE,MAAM,OAAO,GAAqB,GAAG,CAAC,mBAAmB,CACvD,SAAS,CAAC,eAAiC,EAC3C,eAAe,CAChB,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,SAAS,kCAAkC,CAAC,WAAmB;IAC7D,sEAAsE;IACtE,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;IACxC,OAAO;IACL;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,CAAC,QAAQ,CAAC,KAAK,CACb,0DAA0D,CAC3D;QACD;;;;;;;;;;;;;;;;;;WAkBG;QACH,QAAQ,CAAC,KAAK,CAAC,mCAAmC,CAAC,CACpD,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CACvC,MAAc,EACd,MAAe;;IAEf,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;IAEtB,yBAAyB;IACzB,MAAM,KAAK,GACT,MAAA,4BAAiB,CAAC,oBAAoB,CACpC,kBAAkB,EAClB,MAAM,EACN;QACE,eAAe,EAAE,IAAI;KACtB,CACF,mCAAI,EAAE,CAAC;IACV,IAAI,IAAI,GAA0B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChD,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAEtB,wBAAwB;IACxB,MAAM,OAAO,GAAsB,EAAE,CAAC;IACtC,IAAI,MAAM,KAAK,EAAE,EAAE;QACjB,IAAI,kCAAkC,CAAC,MAAM,CAAC,EAAE;YAC9C,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;SAChC;KACF;SAAM,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;QAC/D,qEAAqE;QACrE,oBAAoB;QACpB,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;KAChC;IACD,IAAI;QACF,MAAA,4BAAiB,CAAC,uBAAuB,CACvC,qBAAqB,EACrB,MAAM,EACN,MAAM,EACN,OAAO,CACR,mCAAI,EAAE,CAAC;IAEV,mBAAmB;IACnB,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IACrB,4BAAiB,CAAC,cAAc,CAC9B,kBAAkB,EAClB,KAAK,EACL,MAAM,CACP,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AA7CD,8DA6CC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,SAA8B;;IAC9D,IAAI,OAAO,SAAS,CAAC,gCAAgC,KAAK,QAAQ,EAAE;QAClE,MAAM,UAAU,GAAG,4BAAiB,CAAC,sBAAsB,CACzD,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,MAAO,CAClB,CAAC;QACF,OAAO,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,cAAc,0CAC/B,SAAS,CAAC,gCAA0C,CACrD,CAAC;KACH;IACD,OAAO,4BAAiB,CAAC,wBAAwB,CAC/C,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,MAAO,CAClB,CAAC;AACJ,CAAC;AAdD,8CAcC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAC5B,GAAY,EACZ,SAA8B,EAC9B,OAA0B;IAE1B,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACnC,MAAM,aAAa,GAAG,SAAS,CAAC,eAAgC,CAAC;IACjE,MAAM,IAAI,GAAG,IAAI,0BAAW,CAC1B,GAAG,EACH,aAAa,EACb,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CACrC,CAAC;IACF,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAC9B,GAAY,EACZ,SAA8B,EAC9B,OAA0B;IAE1B,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACzD,MAAM,aAAa,GAAG,SAAS,CAAC,eAAgC,CAAC;IACjE,OAAO,IAAA,+BAAgB,EACrB,GAAG,EACH,aAAa,EACb,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EACpC,OAAO,CACR,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,GAAY,EAAE,SAA8B;IACxE,gBAAgB,CAAC,SAAS,EAAE,0BAAW,CAAC,CAAC;IAEzC,MAAM,aAAa,GAAG,SAAS,CAAC,eAAgC,CAAC;IACjE,MAAM,IAAI,GAAG,IAAI,0BAAW,CAC1B,GAAG,EACH,aAAa,EACb,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CACrC,CAAC;IACF,IAAI,CAAC,IAAI,EAAE,CAAC;IACZ,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,MAAc;;IAEd,MAAM,QAAQ,GACZ,MAAA,4BAAiB,CAAC,sBAAsB,CACtC,qBAAqB,EACrB,MAAM,CACP,mCAAI,EAAE,CAAC;IACV,OAAO,QAAQ,CAAC;AAClB,CAAC;AATD,gEASC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,OAAmC;;IACnE,MAAM,IAAI,GAAe,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,gBAAgB,mCAAI,OAAO,CAAC,mBAAmB,CAAC;IACrE,IAAI,IAAI,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAC9B,MAAM,qBAAqB,GAAG,yBAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,CACnE,gBAAgB,CACjB,CAAC;IACF,IAAI,qBAAqB,CAAC,MAAM,EAAE;QAChC,IAAI,CAAC,oBAAoB,GAAG,qBAAqB,CAAC;KACnD;IACD,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACtE,MAAM,UAAU,GAAe,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,IAAI,kBAAkB,EAAE;QAClC,UAAU,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;KACzD;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE;QAClC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;KAC9B;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAnBD,8CAmBC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,SAAuC;;IAC/D,MAAM,aAAa,GAAG,sCAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACrE,MAAM,UAAU,GAAe,EAAE,CAAC;IAClC,IAAI,aAAa,CAAC,UAAU,EAAE;QAC5B,UAAU,CAAC,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC;KAClD;IACD,IAAI,IAAA,iCAAgB,EAAC,aAAa,CAAC,eAAe,CAAC,EAAE;QACnD,cAAc;QACd,UAAU,CAAC,UAAU,GAAG,aAAa,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;KAClE;SAAM,IAAI,IAAA,mCAAkB,EAAC,aAAa,CAAC,eAAe,CAAC,EAAE;QAC5D,qBAAqB;QACrB,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,KAAK,CACvC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAChE,CAAC;KACH;SAAM;QACL,0BAA0B;QAC1B,UAAU,CAAC,aAAa;YACtB,MAAA,MAAA,aAAa,CAAC,eAAe,0CAAE,IAAI,mCAAI,YAAY,CAAC;KACvD;IACD,mBAAmB;IACnB,IAAI,aAAa,CAAC,QAAQ,EAAE;QAC1B,IACE,aAAa,CAAC,QAAQ,CAAC,SAAS;YAChC,aAAa,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS,EAC9C;YACA,UAAU,CAAC,SAAS,GAAG,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC;SACzD;QACD,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACnC,UAAU,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC;SACvD;KACF;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,GAAyB;IACrD,OAAO,CACL,4BAAiB,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,GAAG,CAAC,IAAI,IAAI;QACtE,oBAAS,CAAC,WAAW,CAAC,qBAAqB,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC;YACpE,IAAI;QACN,4BAAiB,CAAC,sBAAsB,CACtC,qBAAqB,EACrB,GAAG,CAAC,SAAS,CACd,IAAI,IAAI,CACV,CAAC;AACJ,CAAC;AAVD,sCAUC"}

package/dist/interception-proxy.d.ts

@@ -0,0 +1,76 @@
+import { Context } from './context';
+import { InvocationArgs, InvocationSource } from './invocation';
+import { ResolutionSession } from './resolution-session';
+import { ValueOrPromise } from './value-promise';
+/**
+ * Create the Promise type for `T`. If `T` extends `Promise`, the type is `T`,
+ * otherwise the type is `ValueOrPromise<T>`.
+ */
+export declare type AsValueOrPromise<T> = T extends Promise<unknown> ? T : ValueOrPromise<T>;
+/**
+ * The intercepted variant of a function to return `ValueOrPromise<T>`.
+ * If `T` is not a function, the type is `T`.
+ */
+export declare type AsInterceptedFunction<T> = T extends (...args: InvocationArgs) => infer R ? (...args: Parameters<T>) => AsValueOrPromise<R> : T;
+/**
+ * The proxy type for `T`. The return type for any method of `T` with original
+ * return type `R` becomes `ValueOrPromise<R>` if `R` does not extend `Promise`.
+ * Property types stay untouched.
+ *
+ * @example
+ * ```ts
+ * class MyController {
+ *   name: string;
+ *
+ *   greet(name: string): string {
+ *     return `Hello, ${name}`;
+ *   }
+ *
+ *   async hello(name: string) {
+ *     return `Hello, ${name}`;
+ *   }
+ * }
+ * ```
+ *
+ * `AsyncProxy<MyController>` will be:
+ * ```ts
+ * {
+ *   name: string; // the same as MyController
+ *   greet(name: string): ValueOrPromise<string>; // the return type becomes `ValueOrPromise<string>`
+ *   hello(name: string): Promise<string>; // the same as MyController
+ * }
+ * ```
+ */
+export declare type AsyncProxy<T> = {
+    [P in keyof T]: AsInterceptedFunction<T[P]>;
+};
+/**
+ * Invocation source for injected proxies. It wraps a snapshot of the
+ * `ResolutionSession` that tracks the binding/injection stack.
+ */
+export declare class ProxySource implements InvocationSource<ResolutionSession> {
+    readonly value: ResolutionSession;
+    type: string;
+    constructor(value: ResolutionSession);
+    toString(): string;
+}
+/**
+ * A proxy handler that applies interceptors
+ *
+ * See https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Proxy
+ */
+export declare class InterceptionHandler<T extends object> implements ProxyHandler<T> {
+    private context;
+    private session?;
+    private source?;
+    constructor(context?: Context, session?: ResolutionSession | undefined, source?: InvocationSource<unknown> | undefined);
+    get(target: T, propertyName: PropertyKey, receiver: unknown): any;
+}
+/**
+ * Create a proxy that applies interceptors for method invocations
+ * @param target - Target class or object
+ * @param context - Context object
+ * @param session - Resolution session
+ * @param source - Invocation source
+ */
+export declare function createProxyWithInterceptors<T extends object>(target: T, context?: Context, session?: ResolutionSession, source?: InvocationSource): AsyncProxy<T>;