@loopback/context 3.5.1 → 3.8.1

package/src/interceptor.ts

@@ -15,7 +15,13 @@ import assert from 'assert';
 import debugFactory from 'debug';
 import {Binding, BindingTemplate} from './binding';
 import {bind} from './binding-decorator';
-import {BindingSpec} from './binding-inspector';
+import {
+  BindingFromClassOptions,
+  BindingSpec,
+  createBindingFromClass,
+  isProviderClass,
+} from './binding-inspector';
+import {BindingAddress, BindingKey} from './binding-key';
 import {sortBindingsByPhase} from './binding-sorter';
 import {Context} from './context';
 import {
@@ -33,8 +39,10 @@ import {
   ContextBindings,
   ContextTags,
   GLOBAL_INTERCEPTOR_NAMESPACE,
+  LOCAL_INTERCEPTOR_NAMESPACE,
 } from './keys';
-import {tryWithFinally, ValueOrPromise} from './value-promise';
+import {Provider} from './provider';
+import {Constructor, tryWithFinally, ValueOrPromise} from './value-promise';
 const debug = debugFactory('loopback:context:interceptor');
 
 /**
@@ -345,3 +353,78 @@ export function invokeMethodWithInterceptors(
     () => invocationCtx.close(),
   );
 }
+
+/**
+ * Options for an interceptor binding
+ */
+export interface InterceptorBindingOptions extends BindingFromClassOptions {
+  /**
+   * Global or local interceptor
+   */
+  global?: boolean;
+  /**
+   * Group name for a global interceptor
+   */
+  group?: string;
+  /**
+   * Source filter for a global interceptor
+   */
+  source?: string | string[];
+}
+
+/**
+ * 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
+ */
+export function registerInterceptor(
+  ctx: Context,
+  interceptor: Interceptor | Constructor<Provider<Interceptor>>,
+  options: InterceptorBindingOptions = {},
+) {
+  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 =
+    options.namespace ?? options.defaultNamespace ?? global
+      ? GLOBAL_INTERCEPTOR_NAMESPACE
+      : LOCAL_INTERCEPTOR_NAMESPACE;
+
+  let binding: Binding<Interceptor>;
+  if (isProviderClass(interceptor)) {
+    binding = createBindingFromClass(interceptor, {
+      defaultNamespace: namespace,
+      ...options,
+    });
+    if (binding.tagMap[ContextTags.GLOBAL_INTERCEPTOR]) {
+      global = true;
+    }
+    ctx.add(binding);
+  } else {
+    let key = options.key;
+    if (!key) {
+      const name = options.name ?? interceptor.name;
+      if (!name) {
+        key = BindingKey.generate<Interceptor>(namespace).key;
+      } else {
+        key = `${namespace}.${name}`;
+      }
+    }
+    binding = ctx
+      .bind(key as BindingAddress<Interceptor>)
+      .to(interceptor as Interceptor);
+  }
+  if (global) {
+    binding.apply(asGlobalInterceptor(group));
+    if (source) {
+      binding.tag({[ContextTags.GLOBAL_INTERCEPTOR_SOURCE]: source});
+    }
+  }
+
+  return binding;
+}

package/src/keys.ts

@@ -12,6 +12,7 @@ import {BindingKey} from './binding-key';
 export namespace ContextTags {
   export const CLASS = 'class';
   export const PROVIDER = 'provider';
+  export const DYNAMIC_VALUE_PROVIDER = 'dynamicValueProvider';
 
   /**
    * Type of the artifact
@@ -58,6 +59,11 @@ export namespace ContextTags {
  */
 export const GLOBAL_INTERCEPTOR_NAMESPACE = 'globalInterceptors';
 
+/**
+ * Default namespace for local interceptors
+ */
+export const LOCAL_INTERCEPTOR_NAMESPACE = 'interceptors';
+
 /**
  * Namespace for context bindings
  */

package/src/resolution-session.ts

@@ -6,7 +6,9 @@
 import {DecoratorFactory} from '@loopback/metadata';
 import debugModule from 'debug';
 import {Binding} from './binding';
-import {Injection} from './inject';
+import {BindingSelector} from './binding-filter';
+import {Context} from './context';
+import {Injection, InjectionMetadata} from './inject';
 import {BoundValue, tryWithFinally, ValueOrPromise} from './value-promise';
 
 const debugSession = debugModule('loopback:context:resolver:session');
@@ -35,6 +37,12 @@ export interface InjectionElement {
   value: Readonly<Injection>;
 }
 
+export interface InjectionDescriptor {
+  targetName: string;
+  bindingSelector: BindingSelector;
+  metadata: InjectionMetadata;
+}
+
 /**
  * Binding or injection elements tracked by resolution sessions
  */
@@ -155,7 +163,9 @@ export class ResolutionSession {
    * Describe the injection for debugging purpose
    * @param injection - Injection object
    */
-  static describeInjection(injection: Readonly<Injection>) {
+  static describeInjection(
+    injection: Readonly<Injection>,
+  ): InjectionDescriptor {
     const name = getTargetName(
       injection.target,
       injection.member,
@@ -366,3 +376,21 @@ export function asResolutionOptions(
   }
   return optionsOrSession ?? {};
 }
+
+/**
+ * Contextual metadata for resolution
+ */
+export interface ResolutionContext<T = unknown> {
+  /**
+   * The context for resolution
+   */
+  readonly context: Context;
+  /**
+   * The binding to be resolved
+   */
+  readonly binding: Readonly<Binding<T>>;
+  /**
+   * The options used for resolution
+   */
+  readonly options: ResolutionOptions;
+}

package/src/value-promise.ts

@@ -8,6 +8,7 @@
  * utility methods to handle values and/or promises.
  */
 
+import {v4 as uuidv4} from 'uuid';
 /**
  * A class constructor accepting arbitrary arguments.
  */
@@ -270,3 +271,15 @@ export function transformValueOrPromise<T, V>(
     return transformer(valueOrPromise);
   }
 }
+
+/**
+ * A utility to generate uuid v4
+ */
+export function uuid() {
+  return uuidv4();
+}
+
+/**
+ * A regular expression for testing uuid v4 PATTERN
+ */
+export const UUID_PATTERN = /[0-9A-F]{8}-[0-9A-F]{4}-[4][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}/i;

package/index.d.ts

@@ -1,6 +0,0 @@
-// 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
-
-export * from './dist';

package/index.js

@@ -1,6 +0,0 @@
-// 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
-
-module.exports = require('./dist');