@loopback/context 4.0.0-alpha.7 → 4.0.1

package/dist/interceptor.js

@@ -0,0 +1,299 @@
+"use strict";
+// Copyright IBM Corp. 2019,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.registerInterceptor = exports.invokeMethodWithInterceptors = exports.intercept = exports.INTERCEPT_CLASS_KEY = exports.mergeInterceptors = exports.INTERCEPT_METHOD_KEY = exports.globalInterceptor = exports.asGlobalInterceptor = exports.InterceptedInvocationContext = void 0;
+const tslib_1 = require("tslib");
+const metadata_1 = require("@loopback/metadata");
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const binding_decorator_1 = require("./binding-decorator");
+const binding_inspector_1 = require("./binding-inspector");
+const binding_key_1 = require("./binding-key");
+const binding_sorter_1 = require("./binding-sorter");
+const interceptor_chain_1 = require("./interceptor-chain");
+const invocation_1 = require("./invocation");
+const keys_1 = require("./keys");
+const value_promise_1 = require("./value-promise");
+const debug = (0, debug_1.default)('loopback:context:interceptor');
+/**
+ * A specialized InvocationContext for interceptors
+ */
+class InterceptedInvocationContext extends invocation_1.InvocationContext {
+    /**
+     * Discover all binding keys for global interceptors (tagged by
+     * ContextTags.GLOBAL_INTERCEPTOR)
+     */
+    getGlobalInterceptorBindingKeys() {
+        let bindings = this.findByTag(keys_1.ContextTags.GLOBAL_INTERCEPTOR);
+        bindings = bindings.filter(binding => 
+        // Only include interceptors that match the source type of the invocation
+        this.applicableTo(binding));
+        this.sortGlobalInterceptorBindings(bindings);
+        const keys = bindings.map(b => b.key);
+        debug('Global interceptor binding keys:', keys);
+        return keys;
+    }
+    /**
+     * Check if the binding for a global interceptor matches the source type
+     * of the invocation
+     * @param binding - Binding
+     */
+    applicableTo(binding) {
+        var _a;
+        const sourceType = (_a = this.source) === null || _a === void 0 ? void 0 : _a.type;
+        // Unknown source type, always apply
+        if (sourceType == null)
+            return true;
+        const allowedSource = binding.tagMap[keys_1.ContextTags.GLOBAL_INTERCEPTOR_SOURCE];
+        return (
+        // No tag, always apply
+        allowedSource == null ||
+            // source matched
+            allowedSource === sourceType ||
+            // source included in the string[]
+            (Array.isArray(allowedSource) && allowedSource.includes(sourceType)));
+    }
+    /**
+     * Sort global interceptor bindings by `globalInterceptorGroup` tags
+     * @param bindings - An array of global interceptor bindings
+     */
+    sortGlobalInterceptorBindings(bindings) {
+        var _a;
+        // Get predefined ordered groups for global interceptors
+        const orderedGroups = (_a = this.getSync(keys_1.ContextBindings.GLOBAL_INTERCEPTOR_ORDERED_GROUPS, {
+            optional: true,
+        })) !== null && _a !== void 0 ? _a : [];
+        return (0, binding_sorter_1.sortBindingsByPhase)(bindings, keys_1.ContextTags.GLOBAL_INTERCEPTOR_GROUP, orderedGroups);
+    }
+    /**
+     * Load all interceptors for the given invocation context. It adds
+     * interceptors from possibly three sources:
+     * 1. method level `@intercept`
+     * 2. class level `@intercept`
+     * 3. global interceptors discovered in the context
+     */
+    loadInterceptors() {
+        var _a, _b;
+        let interceptors = (_a = metadata_1.MetadataInspector.getMethodMetadata(exports.INTERCEPT_METHOD_KEY, this.target, this.methodName)) !== null && _a !== void 0 ? _a : [];
+        const targetClass = typeof this.target === 'function' ? this.target : this.target.constructor;
+        const classInterceptors = (_b = metadata_1.MetadataInspector.getClassMetadata(exports.INTERCEPT_CLASS_KEY, targetClass)) !== null && _b !== void 0 ? _b : [];
+        // Inserting class level interceptors before method level ones
+        interceptors = mergeInterceptors(classInterceptors, interceptors);
+        const globalInterceptors = this.getGlobalInterceptorBindingKeys();
+        // Inserting global interceptors
+        interceptors = mergeInterceptors(globalInterceptors, interceptors);
+        debug('Interceptors for %s', this.targetName, interceptors);
+        return interceptors;
+    }
+}
+exports.InterceptedInvocationContext = InterceptedInvocationContext;
+/**
+ * The `BindingTemplate` function to configure a binding as a global interceptor
+ * by tagging it with `ContextTags.INTERCEPTOR`
+ * @param group - Group for ordering the interceptor
+ */
+function asGlobalInterceptor(group) {
+    return binding => {
+        binding
+            // Tagging with `GLOBAL_INTERCEPTOR` is required.
+            .tag(keys_1.ContextTags.GLOBAL_INTERCEPTOR)
+            // `GLOBAL_INTERCEPTOR_NAMESPACE` is to make the binding key more readable.
+            .tag({ [keys_1.ContextTags.NAMESPACE]: keys_1.GLOBAL_INTERCEPTOR_NAMESPACE });
+        if (group)
+            binding.tag({ [keys_1.ContextTags.GLOBAL_INTERCEPTOR_GROUP]: group });
+    };
+}
+exports.asGlobalInterceptor = asGlobalInterceptor;
+/**
+ * `@globalInterceptor` decorator to mark the class as a global interceptor
+ * @param group - Group for ordering the interceptor
+ * @param specs - Extra binding specs
+ */
+function globalInterceptor(group, ...specs) {
+    return (0, binding_decorator_1.injectable)(asGlobalInterceptor(group), ...specs);
+}
+exports.globalInterceptor = globalInterceptor;
+/**
+ * Metadata key for method-level interceptors
+ */
+exports.INTERCEPT_METHOD_KEY = metadata_1.MetadataAccessor.create('intercept:method');
+/**
+ * Adding interceptors from the spec to the front of existing ones. Duplicate
+ * entries are eliminated from the spec side.
+ *
+ * For example:
+ *
+ * - [log] + [cache, log] => [cache, log]
+ * - [log] + [log, cache] => [log, cache]
+ * - [] + [cache, log] => [cache, log]
+ * - [cache, log] + [] => [cache, log]
+ * - [log] + [cache] => [log, cache]
+ *
+ * @param interceptorsFromSpec - Interceptors from `@intercept`
+ * @param existingInterceptors - Interceptors already applied for the method
+ */
+function mergeInterceptors(interceptorsFromSpec, existingInterceptors) {
+    const interceptorsToApply = new Set(interceptorsFromSpec);
+    const appliedInterceptors = new Set(existingInterceptors);
+    // Remove interceptors that already exist
+    for (const i of interceptorsToApply) {
+        if (appliedInterceptors.has(i)) {
+            interceptorsToApply.delete(i);
+        }
+    }
+    // Add existing interceptors after ones from the spec
+    for (const i of appliedInterceptors) {
+        interceptorsToApply.add(i);
+    }
+    return Array.from(interceptorsToApply);
+}
+exports.mergeInterceptors = mergeInterceptors;
+/**
+ * Metadata key for method-level interceptors
+ */
+exports.INTERCEPT_CLASS_KEY = metadata_1.MetadataAccessor.create('intercept:class');
+/**
+ * A factory to define `@intercept` for classes. It allows `@intercept` to be
+ * used multiple times on the same class.
+ */
+class InterceptClassDecoratorFactory extends metadata_1.ClassDecoratorFactory {
+    mergeWithOwn(ownMetadata, target) {
+        ownMetadata = ownMetadata || [];
+        return mergeInterceptors(this.spec, ownMetadata);
+    }
+}
+/**
+ * A factory to define `@intercept` for methods. It allows `@intercept` to be
+ * used multiple times on the same method.
+ */
+class InterceptMethodDecoratorFactory extends metadata_1.MethodDecoratorFactory {
+    mergeWithOwn(ownMetadata, target, methodName, methodDescriptor) {
+        ownMetadata = ownMetadata || {};
+        const interceptors = ownMetadata[methodName] || [];
+        // Adding interceptors to the list
+        ownMetadata[methodName] = mergeInterceptors(this.spec, interceptors);
+        return ownMetadata;
+    }
+}
+/**
+ * Decorator function `@intercept` for classes/methods to apply interceptors. It
+ * can be applied on a class and its public methods. Multiple occurrences of
+ * `@intercept` are allowed on the same target class or method. The decorator
+ * takes a list of `interceptor` functions or binding keys.
+ *
+ * @example
+ * ```ts
+ * @intercept(log, metrics)
+ * class MyController {
+ *   @intercept('caching-interceptor')
+ *   @intercept('name-validation-interceptor')
+ *   greet(name: string) {
+ *     return `Hello, ${name}`;
+ *   }
+ * }
+ * ```
+ *
+ * @param interceptorOrKeys - One or more interceptors or binding keys that are
+ * resolved to be interceptors
+ */
+function intercept(...interceptorOrKeys) {
+    return function interceptDecoratorForClassOrMethod(
+    // Class or a prototype
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    target, method, 
+    // Use `any` to for `TypedPropertyDescriptor`
+    // See https://github.com/loopbackio/loopback-next/pull/2704
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    methodDescriptor) {
+        if (method && methodDescriptor) {
+            // Method
+            return InterceptMethodDecoratorFactory.createDecorator(exports.INTERCEPT_METHOD_KEY, interceptorOrKeys, { decoratorName: '@intercept' })(target, method, methodDescriptor);
+        }
+        if (typeof target === 'function' && !method && !methodDescriptor) {
+            // Class
+            return InterceptClassDecoratorFactory.createDecorator(exports.INTERCEPT_CLASS_KEY, interceptorOrKeys, { decoratorName: '@intercept' })(target);
+        }
+        // Not on a class or method
+        throw new Error('@intercept cannot be used on a property: ' +
+            metadata_1.DecoratorFactory.getTargetName(target, method, methodDescriptor));
+    };
+}
+exports.intercept = intercept;
+/**
+ * Invoke a method with the given context
+ * @param context - Context object
+ * @param target - Target class (for static methods) or object (for instance methods)
+ * @param methodName - Method name
+ * @param args - An array of argument values
+ * @param options - Options for the invocation
+ */
+function invokeMethodWithInterceptors(context, target, methodName, args, options = {}) {
+    // Do not allow `skipInterceptors` as it's against the function name
+    // `invokeMethodWithInterceptors`
+    (0, assert_1.default)(!options.skipInterceptors, 'skipInterceptors is not allowed');
+    const invocationCtx = new InterceptedInvocationContext(context, target, methodName, args, options.source);
+    invocationCtx.assertMethodExists();
+    return (0, value_promise_1.tryWithFinally)(() => {
+        const interceptors = invocationCtx.loadInterceptors();
+        const targetMethodInvoker = () => invocationCtx.invokeTargetMethod(options);
+        interceptors.push(targetMethodInvoker);
+        return (0, interceptor_chain_1.invokeInterceptors)(invocationCtx, interceptors);
+    }, () => invocationCtx.close());
+}
+exports.invokeMethodWithInterceptors = invokeMethodWithInterceptors;
+/**
+ * Register an interceptor function or provider class to the given context
+ * @param ctx - Context object
+ * @param interceptor - An interceptor function or provider class
+ * @param options - Options for the interceptor binding
+ */
+function registerInterceptor(ctx, interceptor, options = {}) {
+    var _a, _b, _c;
+    let { global } = options;
+    const { group, source } = options;
+    if (group != null || source != null) {
+        // If group or source is set, assuming global
+        global = global !== false;
+    }
+    const namespace = ((_b = (_a = options.namespace) !== null && _a !== void 0 ? _a : options.defaultNamespace) !== null && _b !== void 0 ? _b : global)
+        ? keys_1.GLOBAL_INTERCEPTOR_NAMESPACE
+        : keys_1.LOCAL_INTERCEPTOR_NAMESPACE;
+    let binding;
+    if ((0, binding_inspector_1.isProviderClass)(interceptor)) {
+        binding = (0, binding_inspector_1.createBindingFromClass)(interceptor, {
+            defaultNamespace: namespace,
+            ...options,
+        });
+        if (binding.tagMap[keys_1.ContextTags.GLOBAL_INTERCEPTOR]) {
+            global = true;
+        }
+        ctx.add(binding);
+    }
+    else {
+        let key = options.key;
+        if (!key) {
+            const name = (_c = options.name) !== null && _c !== void 0 ? _c : interceptor.name;
+            if (!name) {
+                key = binding_key_1.BindingKey.generate(namespace).key;
+            }
+            else {
+                key = `${namespace}.${name}`;
+            }
+        }
+        binding = ctx
+            .bind(key)
+            .to(interceptor);
+    }
+    if (global) {
+        binding.apply(asGlobalInterceptor(group));
+        if (source) {
+            binding.tag({ [keys_1.ContextTags.GLOBAL_INTERCEPTOR_SOURCE]: source });
+        }
+    }
+    return binding;
+}
+exports.registerInterceptor = registerInterceptor;
+//# sourceMappingURL=interceptor.js.map

package/dist/interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interceptor.js","sourceRoot":"","sources":["../src/interceptor.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,iDAO4B;AAC5B,iEAA4B;AAC5B,+DAAiC;AAEjC,2DAA+C;AAC/C,2DAK6B;AAC7B,+CAAyD;AACzD,qDAAqD;AAErD,2DAI6B;AAC7B,6CAKsB;AACtB,iCAKgB;AAEhB,mDAA4E;AAC5E,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,8BAA8B,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAa,4BAA6B,SAAQ,8BAAiB;IACjE;;;OAGG;IACH,+BAA+B;QAC7B,IAAI,QAAQ,GAAqC,IAAI,CAAC,SAAS,CAC7D,kBAAW,CAAC,kBAAkB,CAC/B,CAAC;QACF,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;QACnC,yEAAyE;QACzE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAC3B,CAAC;QAEF,IAAI,CAAC,6BAA6B,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACtC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACK,YAAY,CAAC,OAAmC;;QACtD,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC;QACrC,oCAAoC;QACpC,IAAI,UAAU,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QACpC,MAAM,aAAa,GACjB,OAAO,CAAC,MAAM,CAAC,kBAAW,CAAC,yBAAyB,CAAC,CAAC;QACxD,OAAO;QACL,uBAAuB;QACvB,aAAa,IAAI,IAAI;YACrB,iBAAiB;YACjB,aAAa,KAAK,UAAU;YAC5B,kCAAkC;YAClC,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,6BAA6B,CACnC,QAA0C;;QAE1C,wDAAwD;QACxD,MAAM,aAAa,GACjB,MAAA,IAAI,CAAC,OAAO,CAAC,sBAAe,CAAC,iCAAiC,EAAE;YAC9D,QAAQ,EAAE,IAAI;SACf,CAAC,mCAAI,EAAE,CAAC;QACX,OAAO,IAAA,oCAAmB,EACxB,QAAQ,EACR,kBAAW,CAAC,wBAAwB,EACpC,aAAa,CACd,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB;;QACd,IAAI,YAAY,GACd,MAAA,4BAAiB,CAAC,iBAAiB,CACjC,4BAAoB,EACpB,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,UAAU,CAChB,mCAAI,EAAE,CAAC;QACV,MAAM,WAAW,GACf,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QAC5E,MAAM,iBAAiB,GACrB,MAAA,4BAAiB,CAAC,gBAAgB,CAAC,2BAAmB,EAAE,WAAW,CAAC,mCACpE,EAAE,CAAC;QACL,8DAA8D;QAC9D,YAAY,GAAG,iBAAiB,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAClE,MAAM,kBAAkB,GAAG,IAAI,CAAC,+BAA+B,EAAE,CAAC;QAClE,gCAAgC;QAChC,YAAY,GAAG,iBAAiB,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;QACnE,KAAK,CAAC,qBAAqB,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAC5D,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAvFD,oEAuFC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,KAAc;IAChD,OAAO,OAAO,CAAC,EAAE;QACf,OAAO;YACL,iDAAiD;aAChD,GAAG,CAAC,kBAAW,CAAC,kBAAkB,CAAC;YACpC,2EAA2E;aAC1E,GAAG,CAAC,EAAC,CAAC,kBAAW,CAAC,SAAS,CAAC,EAAE,mCAA4B,EAAC,CAAC,CAAC;QAChE,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,EAAC,CAAC,kBAAW,CAAC,wBAAwB,CAAC,EAAE,KAAK,EAAC,CAAC,CAAC;IAC1E,CAAC,CAAC;AACJ,CAAC;AATD,kDASC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,KAAc,EAAE,GAAG,KAAoB;IACvE,OAAO,IAAA,8BAAU,EAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;AAC1D,CAAC;AAFD,8CAEC;AAaD;;GAEG;AACU,QAAA,oBAAoB,GAAG,2BAAgB,CAAC,MAAM,CAGzD,kBAAkB,CAAC,CAAC;AAEtB;;;;;;;;;;;;;;GAcG;AACH,SAAgB,iBAAiB,CAC/B,oBAAwC,EACxC,oBAAwC;IAExC,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAC1D,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAC1D,yCAAyC;IACzC,KAAK,MAAM,CAAC,IAAI,mBAAmB,EAAE;QACnC,IAAI,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YAC9B,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC/B;KACF;IACD,qDAAqD;IACrD,KAAK,MAAM,CAAC,IAAI,mBAAmB,EAAE;QACnC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAC5B;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AACzC,CAAC;AAjBD,8CAiBC;AAED;;GAEG;AACU,QAAA,mBAAmB,GAAG,2BAAgB,CAAC,MAAM,CAGxD,iBAAiB,CAAC,CAAC;AAErB;;;GAGG;AACH,MAAM,8BAA+B,SAAQ,gCAE5C;IACW,YAAY,CAAC,WAA+B,EAAE,MAAc;QACpE,WAAW,GAAG,WAAW,IAAI,EAAE,CAAC;QAChC,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACnD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,+BAAgC,SAAQ,iCAE7C;IACW,YAAY,CACpB,WAA4C,EAC5C,MAAc,EACd,UAAkB,EAClB,gBAAkD;QAElD,WAAW,GAAG,WAAW,IAAI,EAAE,CAAC;QAChC,MAAM,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAEnD,kCAAkC;QAClC,WAAW,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAErE,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,SAAS,CAAC,GAAG,iBAAqC;IAChE,OAAO,SAAS,kCAAkC;IAChD,uBAAuB;IACvB,8DAA8D;IAC9D,MAAW,EACX,MAAe;IACf,6CAA6C;IAC7C,4DAA4D;IAC5D,8DAA8D;IAC9D,gBAA+C;QAE/C,IAAI,MAAM,IAAI,gBAAgB,EAAE;YAC9B,SAAS;YACT,OAAO,+BAA+B,CAAC,eAAe,CACpD,4BAAoB,EACpB,iBAAiB,EACjB,EAAC,aAAa,EAAE,YAAY,EAAC,CAC9B,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAiB,CAAC,CAAC;SACtC;QACD,IAAI,OAAO,MAAM,KAAK,UAAU,IAAI,CAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE;YAChE,QAAQ;YACR,OAAO,8BAA8B,CAAC,eAAe,CACnD,2BAAmB,EACnB,iBAAiB,EACjB,EAAC,aAAa,EAAE,YAAY,EAAC,CAC9B,CAAC,MAAM,CAAC,CAAC;SACX;QACD,2BAA2B;QAC3B,MAAM,IAAI,KAAK,CACb,2CAA2C;YACzC,2BAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,CAAC,CACnE,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAjCD,8BAiCC;AAED;;;;;;;GAOG;AACH,SAAgB,4BAA4B,CAC1C,OAAgB,EAChB,MAAc,EACd,UAAkB,EAClB,IAAoB,EACpB,UAA6B,EAAE;IAE/B,oEAAoE;IACpE,iCAAiC;IACjC,IAAA,gBAAM,EAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,iCAAiC,CAAC,CAAC;IACrE,MAAM,aAAa,GAAG,IAAI,4BAA4B,CACpD,OAAO,EACP,MAAM,EACN,UAAU,EACV,IAAI,EACJ,OAAO,CAAC,MAAM,CACf,CAAC;IAEF,aAAa,CAAC,kBAAkB,EAAE,CAAC;IACnC,OAAO,IAAA,8BAAc,EACnB,GAAG,EAAE;QACH,MAAM,YAAY,GAAG,aAAa,CAAC,gBAAgB,EAAE,CAAC;QACtD,MAAM,mBAAmB,GAAG,GAAG,EAAE,CAC/B,aAAa,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC5C,YAAY,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACvC,OAAO,IAAA,sCAAkB,EAAC,aAAa,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC,EACD,GAAG,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,CAC5B,CAAC;AACJ,CAAC;AA7BD,oEA6BC;AAoBD;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,GAAY,EACZ,WAA6D,EAC7D,UAAqC,EAAE;;IAEvC,IAAI,EAAC,MAAM,EAAC,GAAG,OAAO,CAAC;IACvB,MAAM,EAAC,KAAK,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IAChC,IAAI,KAAK,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,EAAE;QACnC,6CAA6C;QAC7C,MAAM,GAAG,MAAM,KAAK,KAAK,CAAC;KAC3B;IAED,MAAM,SAAS,GACb,CAAA,MAAA,MAAA,OAAO,CAAC,SAAS,mCAAI,OAAO,CAAC,gBAAgB,mCAAI,MAAM;QACrD,CAAC,CAAC,mCAA4B;QAC9B,CAAC,CAAC,kCAA2B,CAAC;IAElC,IAAI,OAA6B,CAAC;IAClC,IAAI,IAAA,mCAAe,EAAC,WAAW,CAAC,EAAE;QAChC,OAAO,GAAG,IAAA,0CAAsB,EAAC,WAAW,EAAE;YAC5C,gBAAgB,EAAE,SAAS;YAC3B,GAAG,OAAO;SACX,CAAC,CAAC;QACH,IAAI,OAAO,CAAC,MAAM,CAAC,kBAAW,CAAC,kBAAkB,CAAC,EAAE;YAClD,MAAM,GAAG,IAAI,CAAC;SACf;QACD,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KAClB;SAAM;QACL,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,WAAW,CAAC,IAAI,CAAC;YAC9C,IAAI,CAAC,IAAI,EAAE;gBACT,GAAG,GAAG,wBAAU,CAAC,QAAQ,CAAc,SAAS,CAAC,CAAC,GAAG,CAAC;aACvD;iBAAM;gBACL,GAAG,GAAG,GAAG,SAAS,IAAI,IAAI,EAAE,CAAC;aAC9B;SACF;QACD,OAAO,GAAG,GAAG;aACV,IAAI,CAAC,GAAkC,CAAC;aACxC,EAAE,CAAC,WAA0B,CAAC,CAAC;KACnC;IACD,IAAI,MAAM,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,IAAI,MAAM,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,EAAC,CAAC,kBAAW,CAAC,yBAAyB,CAAC,EAAE,MAAM,EAAC,CAAC,CAAC;SAChE;KACF;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAjDD,kDAiDC"}

package/dist/invocation.d.ts

@@ -0,0 +1,101 @@
+import { Context } from './context';
+import { ResolutionSession } from './resolution-session';
+import { ValueOrPromise } from './value-promise';
+/**
+ * Return value for a method invocation
+ */
+export declare type InvocationResult = any;
+/**
+ * Array of arguments for a method invocation
+ */
+export declare type InvocationArgs = any[];
+/**
+ * An interface to represent the caller of the invocation
+ */
+export interface InvocationSource<T = unknown> {
+    /**
+     * Type of the invoker, such as `proxy` and `route`
+     */
+    readonly type: string;
+    /**
+     * Metadata for the source, such as `ResolutionSession`
+     */
+    readonly value: T;
+}
+/**
+ * InvocationContext represents the context to invoke interceptors for a method.
+ * The context can be used to access metadata about the invocation as well as
+ * other dependencies.
+ */
+export declare class InvocationContext extends Context {
+    readonly target: object;
+    readonly methodName: string;
+    readonly args: InvocationArgs;
+    readonly source?: InvocationSource<unknown> | undefined;
+    /**
+     * Construct a new instance of `InvocationContext`
+     * @param parent - Parent context, such as the RequestContext
+     * @param target - Target class (for static methods) or prototype/object
+     * (for instance methods)
+     * @param methodName - Method name
+     * @param args - An array of arguments
+     */
+    constructor(parent: Context, target: object, methodName: string, args: InvocationArgs, source?: InvocationSource<unknown> | undefined);
+    /**
+     * The target class, such as `OrderController`
+     */
+    get targetClass(): Function;
+    /**
+     * The target name, such as `OrderController.prototype.cancelOrder`
+     */
+    get targetName(): string;
+    /**
+     * Description of the invocation
+     */
+    get description(): string;
+    toString(): string;
+    /**
+     * Assert the method exists on the target. An error will be thrown if otherwise.
+     * @param context - Invocation context
+     */
+    assertMethodExists(): Record<string, Function>;
+    /**
+     * Invoke the target method with the given context
+     * @param context - Invocation context
+     * @param options - Options for the invocation
+     */
+    invokeTargetMethod(options?: InvocationOptions): any;
+}
+/**
+ * Options to control invocations
+ */
+export declare type InvocationOptions = {
+    /**
+     * Skip dependency injection on method parameters
+     */
+    skipParameterInjection?: boolean;
+    /**
+     * Skip invocation of interceptors
+     */
+    skipInterceptors?: boolean;
+    /**
+     * Information about the source object that makes the invocation. For REST,
+     * it's a `Route`. For injected proxies, it's a `Binding`.
+     */
+    source?: InvocationSource;
+    /**
+     * Resolution session
+     */
+    session?: ResolutionSession;
+};
+/**
+ * Invoke a method using dependency injection. Interceptors are invoked as part
+ * of the invocation.
+ * @param target - Target of the method, it will be the class for a static
+ * method, and instance or class prototype for a prototype method
+ * @param method - Name of the method
+ * @param ctx - Context object
+ * @param nonInjectedArgs - Optional array of args for non-injected parameters
+ * @param options - Options for the invocation
+ */
+export declare function invokeMethod(target: object, method: string, ctx: Context, nonInjectedArgs?: InvocationArgs, options?: InvocationOptions): ValueOrPromise<InvocationResult>;

package/dist/invocation.js

@@ -0,0 +1,163 @@
+"use strict";
+// Copyright IBM Corp. 2019,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.invokeMethod = exports.InvocationContext = void 0;
+const tslib_1 = require("tslib");
+const metadata_1 = require("@loopback/metadata");
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const context_1 = require("./context");
+const interceptor_1 = require("./interceptor");
+const resolver_1 = require("./resolver");
+const value_promise_1 = require("./value-promise");
+const debug = (0, debug_1.default)('loopback:context:invocation');
+const getTargetName = metadata_1.DecoratorFactory.getTargetName;
+/**
+ * InvocationContext represents the context to invoke interceptors for a method.
+ * The context can be used to access metadata about the invocation as well as
+ * other dependencies.
+ */
+class InvocationContext extends context_1.Context {
+    /**
+     * Construct a new instance of `InvocationContext`
+     * @param parent - Parent context, such as the RequestContext
+     * @param target - Target class (for static methods) or prototype/object
+     * (for instance methods)
+     * @param methodName - Method name
+     * @param args - An array of arguments
+     */
+    constructor(parent, target, methodName, args, source) {
+        super(parent);
+        this.target = target;
+        this.methodName = methodName;
+        this.args = args;
+        this.source = source;
+    }
+    /**
+     * The target class, such as `OrderController`
+     */
+    get targetClass() {
+        return typeof this.target === 'function'
+            ? this.target
+            : this.target.constructor;
+    }
+    /**
+     * The target name, such as `OrderController.prototype.cancelOrder`
+     */
+    get targetName() {
+        return getTargetName(this.target, this.methodName);
+    }
+    /**
+     * Description of the invocation
+     */
+    get description() {
+        const source = this.source == null ? '' : `${this.source} => `;
+        return `InvocationContext(${this.name}): ${source}${this.targetName}`;
+    }
+    toString() {
+        return this.description;
+    }
+    /**
+     * Assert the method exists on the target. An error will be thrown if otherwise.
+     * @param context - Invocation context
+     */
+    assertMethodExists() {
+        const targetWithMethods = this.target;
+        if (typeof targetWithMethods[this.methodName] !== 'function') {
+            const targetName = getTargetName(this.target, this.methodName);
+            (0, assert_1.default)(false, `Method ${targetName} not found`);
+        }
+        return targetWithMethods;
+    }
+    /**
+     * Invoke the target method with the given context
+     * @param context - Invocation context
+     * @param options - Options for the invocation
+     */
+    invokeTargetMethod(options = { skipParameterInjection: true }) {
+        const targetWithMethods = this.assertMethodExists();
+        if (!options.skipParameterInjection) {
+            return invokeTargetMethodWithInjection(this, targetWithMethods, this.methodName, this.args, options.session);
+        }
+        return invokeTargetMethod(this, targetWithMethods, this.methodName, this.args);
+    }
+}
+exports.InvocationContext = InvocationContext;
+/**
+ * Invoke a method using dependency injection. Interceptors are invoked as part
+ * of the invocation.
+ * @param target - Target of the method, it will be the class for a static
+ * method, and instance or class prototype for a prototype method
+ * @param method - Name of the method
+ * @param ctx - Context object
+ * @param nonInjectedArgs - Optional array of args for non-injected parameters
+ * @param options - Options for the invocation
+ */
+function invokeMethod(target, method, ctx, nonInjectedArgs = [], options = {}) {
+    if (options.skipInterceptors) {
+        if (options.skipParameterInjection) {
+            // Invoke the target method directly without injection or interception
+            return invokeTargetMethod(ctx, target, method, nonInjectedArgs);
+        }
+        else {
+            return invokeTargetMethodWithInjection(ctx, target, method, nonInjectedArgs, options.session);
+        }
+    }
+    // Invoke the target method with interception but no injection
+    return (0, interceptor_1.invokeMethodWithInterceptors)(ctx, target, method, nonInjectedArgs, options);
+}
+exports.invokeMethod = invokeMethod;
+/**
+ * Invoke a method. Method parameter dependency injection is honored.
+ * @param target - Target of the method, it will be the class for a static
+ * method, and instance or class prototype for a prototype method
+ * @param method - Name of the method
+ * @param ctx - Context
+ * @param nonInjectedArgs - Optional array of args for non-injected parameters
+ */
+function invokeTargetMethodWithInjection(ctx, target, method, nonInjectedArgs, session) {
+    const methodName = getTargetName(target, method);
+    /* istanbul ignore if */
+    if (debug.enabled) {
+        debug('Invoking method %s', methodName);
+        if (nonInjectedArgs === null || nonInjectedArgs === void 0 ? void 0 : nonInjectedArgs.length) {
+            debug('Non-injected arguments:', nonInjectedArgs);
+        }
+    }
+    const argsOrPromise = (0, resolver_1.resolveInjectedArguments)(target, method, ctx, session, nonInjectedArgs);
+    const targetWithMethods = target;
+    (0, assert_1.default)(typeof targetWithMethods[method] === 'function', `Method ${method} not found`);
+    return (0, value_promise_1.transformValueOrPromise)(argsOrPromise, args => {
+        /* istanbul ignore if */
+        if (debug.enabled) {
+            debug('Injected arguments for %s:', methodName, args);
+        }
+        return invokeTargetMethod(ctx, targetWithMethods, method, args);
+    });
+}
+/**
+ * Invoke the target method
+ * @param ctx - Context object
+ * @param target - Target class or object
+ * @param methodName - Target method name
+ * @param args - Arguments
+ */
+function invokeTargetMethod(ctx, // Not used
+target, methodName, args) {
+    const targetWithMethods = target;
+    /* istanbul ignore if */
+    if (debug.enabled) {
+        debug('Invoking method %s', getTargetName(target, methodName), args);
+    }
+    // Invoke the target method
+    const result = targetWithMethods[methodName](...args);
+    /* istanbul ignore if */
+    if (debug.enabled) {
+        debug('Method invoked: %s', getTargetName(target, methodName), result);
+    }
+    return result;
+}
+//# sourceMappingURL=invocation.js.map

package/dist/invocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invocation.js","sourceRoot":"","sources":["../src/invocation.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,iDAAoD;AACpD,iEAA4B;AAC5B,+DAAiC;AACjC,uCAAkC;AAClC,+CAA2D;AAE3D,yCAAoD;AACpD,mDAAwE;AAExE,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,6BAA6B,CAAC,CAAC;AAC1D,MAAM,aAAa,GAAG,2BAAgB,CAAC,aAAa,CAAC;AA4BrD;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,iBAAO;IAC5C;;;;;;;OAOG;IACH,YACE,MAAe,EACC,MAAc,EACd,UAAkB,EAClB,IAAoB,EACpB,MAAyB;QAEzC,KAAK,CAAC,MAAM,CAAC,CAAC;QALE,WAAM,GAAN,MAAM,CAAQ;QACd,eAAU,GAAV,UAAU,CAAQ;QAClB,SAAI,GAAJ,IAAI,CAAgB;QACpB,WAAM,GAAN,MAAM,CAAmB;IAG3C,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU;YACtC,CAAC,CAAC,IAAI,CAAC,MAAM;YACb,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,MAAM,CAAC;QAC/D,OAAO,qBAAqB,IAAI,CAAC,IAAI,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IACxE,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAkC,CAAC;QAClE,IAAI,OAAO,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,UAAU,EAAE;YAC5D,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/D,IAAA,gBAAM,EAAC,KAAK,EAAE,UAAU,UAAU,YAAY,CAAC,CAAC;SACjD;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAChB,UAA6B,EAAC,sBAAsB,EAAE,IAAI,EAAC;QAE3D,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACpD,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE;YACnC,OAAO,+BAA+B,CACpC,IAAI,EACJ,iBAAiB,EACjB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,IAAI,EACT,OAAO,CAAC,OAAO,CAChB,CAAC;SACH;QACD,OAAO,kBAAkB,CACvB,IAAI,EACJ,iBAAiB,EACjB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,IAAI,CACV,CAAC;IACJ,CAAC;CACF;AArFD,8CAqFC;AAyBD;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,MAAc,EACd,MAAc,EACd,GAAY,EACZ,kBAAkC,EAAE,EACpC,UAA6B,EAAE;IAE/B,IAAI,OAAO,CAAC,gBAAgB,EAAE;QAC5B,IAAI,OAAO,CAAC,sBAAsB,EAAE;YAClC,sEAAsE;YACtE,OAAO,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;SACjE;aAAM;YACL,OAAO,+BAA+B,CACpC,GAAG,EACH,MAAM,EACN,MAAM,EACN,eAAe,EACf,OAAO,CAAC,OAAO,CAChB,CAAC;SACH;KACF;IACD,8DAA8D;IAC9D,OAAO,IAAA,0CAA4B,EACjC,GAAG,EACH,MAAM,EACN,MAAM,EACN,eAAe,EACf,OAAO,CACR,CAAC;AACJ,CAAC;AA7BD,oCA6BC;AAED;;;;;;;GAOG;AACH,SAAS,+BAA+B,CACtC,GAAY,EACZ,MAAc,EACd,MAAc,EACd,eAAgC,EAChC,OAA2B;IAE3B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjD,wBAAwB;IACxB,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;QACxC,IAAI,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM,EAAE;YAC3B,KAAK,CAAC,yBAAyB,EAAE,eAAe,CAAC,CAAC;SACnD;KACF;IACD,MAAM,aAAa,GAAG,IAAA,mCAAwB,EAC5C,MAAM,EACN,MAAM,EACN,GAAG,EACH,OAAO,EACP,eAAe,CAChB,CAAC;IACF,MAAM,iBAAiB,GAAG,MAAkC,CAAC;IAC7D,IAAA,gBAAM,EACJ,OAAO,iBAAiB,CAAC,MAAM,CAAC,KAAK,UAAU,EAC/C,UAAU,MAAM,YAAY,CAC7B,CAAC;IACF,OAAO,IAAA,uCAAuB,EAAC,aAAa,EAAE,IAAI,CAAC,EAAE;QACnD,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;SACvD;QACD,OAAO,kBAAkB,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACzB,GAAY,EAAE,WAAW;AACzB,MAAc,EACd,UAAkB,EAClB,IAAoB;IAEpB,MAAM,iBAAiB,GAAG,MAAkC,CAAC;IAC7D,wBAAwB;IACxB,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CAAC,oBAAoB,EAAE,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;KACtE;IACD,2BAA2B;IAC3B,MAAM,MAAM,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACtD,wBAAwB;IACxB,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CAAC,oBAAoB,EAAE,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;KACxE;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/json-types.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Type definition for JSON types
+ */
+/**
+ * JSON primitive types:
+ * - string
+ * - number
+ * - boolean
+ * - null
+ */
+export declare type JSONPrimitive = string | number | boolean | null;
+/**
+ * JSON values
+ * - primitive
+ * - object
+ * - array
+ */
+export declare type JSONValue = JSONPrimitive | JSONObject | JSONArray;
+/**
+ * JSON object
+ */
+export interface JSONObject extends Record<string, JSONValue> {
+}
+/**
+ * JSON array
+ */
+export interface JSONArray extends Array<JSONValue> {
+}

package/dist/json-types.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright IBM Corp. 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 });
+//# sourceMappingURL=json-types.js.map

package/dist/json-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-types.js","sourceRoot":"","sources":["../src/json-types.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE"}