@loopback/context 4.0.0-alpha.6 → 4.0.0

package/lib/binding.d.ts

@@ -1,75 +0,0 @@
-import { Context } from './context';
-import { Constructor } from './resolver';
-export declare type BoundValue = any;
-export declare class Binding {
-    private readonly _key;
-    isLocked: boolean;
-    private _tagName;
-    valueConstructor: Constructor<BoundValue>;
-    constructor(_key: string, isLocked?: boolean);
-    readonly key: string;
-    readonly tagName: string;
-    /**
-     * This is an internal function optimized for performance.
-     * Users should use `@inject(key)` or `ctx.get(key)` instead.
-     *
-     * Get the value bound to this key. Depending on `isSync`, this function returns either:
-     *  - the bound value
-     *  - a promise of the bound value
-     *
-     * Consumers wishing to consume sync values directly should use `isPromise`
-     * to check the type of the returned value to decide how to handle it.
-     *
-     * ```
-     * const result = binding.getValue(ctx);
-     * if (isPromise(result)) {
-     *   result.then(doSomething)
-     * } else {
-     *   doSomething(result);
-     * }
-     * ```
-     */
-    getValue(ctx: Context): BoundValue | Promise<BoundValue>;
-    lock(): this;
-    tag(tagName: string): this;
-    /**
-     * Bind the key to a constant value.
-     *
-     * @param value The bound value.
-     *
-     * @example
-     *
-     * ```ts
-     * ctx.bind('appName').to('CodeHub');
-     * ```
-     */
-    to(value: BoundValue): this;
-    /**
-     * Bind the key to a computed (dynamic) value.
-     *
-     * @param factoryFn The factory function creating the value.
-     *   Both sync and async functions are supported.
-     *
-     * @example
-     *
-     * ```ts
-     * // synchronous
-     * ctx.bind('now').toDynamicValue(() => Date.now());
-     *
-     * // asynchronous
-     * ctx.bind('something').toDynamicValue(
-     *  async () => Promise.delay(10).then(doSomething)
-     * );
-     * ```
-     */
-    toDynamicValue(factoryFn: () => BoundValue | Promise<BoundValue>): this;
-    /**
-     * Bind the key to an instance of the given class.
-     *
-     * @param ctor The class constructor to call. Any constructor
-     *   arguments must be annotated with `@inject` so that
-     *   we can resolve them from the context.
-     */
-    toClass<T>(ctor: Constructor<T>): this;
-    unlock(): this;
-}

package/lib/binding.js

@@ -1,102 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2013,2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-const resolver_1 = require("./resolver");
-// FIXME(bajtos) The binding class should be parameterized by the value type stored
-class Binding {
-    constructor(_key, isLocked = false) {
-        this._key = _key;
-        this.isLocked = isLocked;
-    }
-    get key() { return this._key; }
-    get tagName() { return this._tagName; }
-    /**
-     * This is an internal function optimized for performance.
-     * Users should use `@inject(key)` or `ctx.get(key)` instead.
-     *
-     * Get the value bound to this key. Depending on `isSync`, this function returns either:
-     *  - the bound value
-     *  - a promise of the bound value
-     *
-     * Consumers wishing to consume sync values directly should use `isPromise`
-     * to check the type of the returned value to decide how to handle it.
-     *
-     * ```
-     * const result = binding.getValue(ctx);
-     * if (isPromise(result)) {
-     *   result.then(doSomething)
-     * } else {
-     *   doSomething(result);
-     * }
-     * ```
-     */
-    getValue(ctx) {
-        return Promise.reject(new Error(`No value was configured for binding ${this._key}.`));
-    }
-    lock() {
-        this.isLocked = true;
-        return this;
-    }
-    tag(tagName) {
-        this._tagName = tagName;
-        return this;
-    }
-    /**
-     * Bind the key to a constant value.
-     *
-     * @param value The bound value.
-     *
-     * @example
-     *
-     * ```ts
-     * ctx.bind('appName').to('CodeHub');
-     * ```
-     */
-    to(value) {
-        this.getValue = () => value;
-        return this;
-    }
-    /**
-     * Bind the key to a computed (dynamic) value.
-     *
-     * @param factoryFn The factory function creating the value.
-     *   Both sync and async functions are supported.
-     *
-     * @example
-     *
-     * ```ts
-     * // synchronous
-     * ctx.bind('now').toDynamicValue(() => Date.now());
-     *
-     * // asynchronous
-     * ctx.bind('something').toDynamicValue(
-     *  async () => Promise.delay(10).then(doSomething)
-     * );
-     * ```
-     */
-    toDynamicValue(factoryFn) {
-        // TODO(bajtos) allow factoryFn with @inject arguments
-        this.getValue = (ctx) => factoryFn();
-        return this;
-    }
-    /**
-     * Bind the key to an instance of the given class.
-     *
-     * @param ctor The class constructor to call. Any constructor
-     *   arguments must be annotated with `@inject` so that
-     *   we can resolve them from the context.
-     */
-    toClass(ctor) {
-        this.getValue = context => resolver_1.instantiateClass(ctor, context);
-        this.valueConstructor = ctor;
-        return this;
-    }
-    unlock() {
-        this.isLocked = false;
-        return this;
-    }
-}
-exports.Binding = Binding;

package/lib/context.d.ts

@@ -1,14 +0,0 @@
-import { Binding, BoundValue } from './binding';
-export declare class Context {
-    private _parent;
-    private registry;
-    constructor(_parent?: Context);
-    bind(key: string): Binding;
-    contains(key: string): boolean;
-    find(pattern?: string): Binding[];
-    findByTag(pattern: string): Binding[];
-    protected _mergeWithParent(childList: Binding[], parentList?: Binding[]): Binding[];
-    get(key: string): Promise<BoundValue>;
-    getSync(key: string): BoundValue;
-    getBinding(key: string): Binding;
-}

package/lib/context.js

@@ -1,96 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2013,2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-const binding_1 = require("./binding");
-const isPromise_1 = require("./isPromise");
-class Context {
-    constructor(_parent) {
-        this._parent = _parent;
-        this.registry = new Map();
-    }
-    bind(key) {
-        const keyExists = this.registry.has(key);
-        if (keyExists) {
-            const existingBinding = this.registry.get(key);
-            const bindingIsLocked = existingBinding && existingBinding.isLocked;
-            if (bindingIsLocked)
-                throw new Error(`Cannot rebind key "${key}", associated binding is locked`);
-        }
-        const binding = new binding_1.Binding(key);
-        this.registry.set(key, binding);
-        return binding;
-    }
-    contains(key) {
-        return this.registry.has(key);
-    }
-    find(pattern) {
-        let bindings = [];
-        if (pattern) {
-            // TODO(@superkhau): swap with production grade glob to regex lib
-            const glob = new RegExp('^' + pattern.split('*').join('.*') + '$');
-            this.registry.forEach(binding => {
-                const isMatch = glob.test(binding.key);
-                if (isMatch)
-                    bindings.push(binding);
-            });
-        }
-        else {
-            bindings = Array.from(this.registry.values());
-        }
-        const parentBindings = this._parent && this._parent.find(pattern);
-        return this._mergeWithParent(bindings, parentBindings);
-    }
-    findByTag(pattern) {
-        const bindings = [];
-        // TODO(@superkhau): swap with production grade glob to regex lib
-        const glob = new RegExp('^' + pattern.split('*').join('.*') + '$');
-        this.registry.forEach(binding => {
-            const isMatch = glob.test(binding.tagName);
-            if (isMatch)
-                bindings.push(binding);
-        });
-        const parentBindings = this._parent && this._parent.findByTag(pattern);
-        return this._mergeWithParent(bindings, parentBindings);
-    }
-    _mergeWithParent(childList, parentList) {
-        if (!parentList)
-            return childList;
-        const additions = parentList.filter(parentBinding => {
-            // children bindings take precedence
-            return !childList.some(childBinding => childBinding.key === parentBinding.key);
-        });
-        return childList.concat(additions);
-    }
-    get(key) {
-        try {
-            const binding = this.getBinding(key);
-            return Promise.resolve(binding.getValue(this));
-        }
-        catch (err) {
-            return Promise.reject(err);
-        }
-    }
-    getSync(key) {
-        const binding = this.getBinding(key);
-        const valueOrPromise = binding.getValue(this);
-        if (isPromise_1.isPromise(valueOrPromise)) {
-            throw new Error(`Cannot get ${key} synchronously: ` +
-                `the value requires async computation`);
-        }
-        return valueOrPromise;
-    }
-    getBinding(key) {
-        const binding = this.registry.get(key);
-        if (binding) {
-            return binding;
-        }
-        if (this._parent) {
-            return this._parent.getBinding(key);
-        }
-        throw new Error(`The key ${key} was not bound to any value.`);
-    }
-}
-exports.Context = Context;

package/lib/index.d.ts

@@ -1,5 +0,0 @@
-export { Binding, BoundValue } from './binding';
-export { Context } from './context';
-export { Constructor } from './resolver';
-export { inject } from './inject';
-export declare const isPromise: any;

package/lib/index.js

@@ -1,13 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-var binding_1 = require("./binding");
-exports.Binding = binding_1.Binding;
-var context_1 = require("./context");
-exports.Context = context_1.Context;
-var inject_1 = require("./inject");
-exports.inject = inject_1.inject;
-exports.isPromise = require('is-promise');

package/lib/inject.d.ts

@@ -1,24 +0,0 @@
-import 'reflect-metadata';
-/**
- * A decorator to annotate method arguments for automatic injection
- * by LoopBack IoC container.
- *
- * Usage - Typescript:
- *
- * ```ts
- * class InfoController {
- *   constructor(@inject('application.name') public appName: string) {
- *   }
- *   // ...
- * }
- * ```
- *
- * Usage - JavaScript:
- *
- *  - TODO(bajtos)
- *
- * @param bindingKey What binding to use in order to resolve the value
- * of the annotated argument.
- */
-export declare function inject(bindingKey: string): (target: Object, propertyKey: string | symbol, parameterIndex: number) => void;
-export declare function describeInjectedArguments(target: Function): string[];

package/lib/inject.js

@@ -1,43 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2013,2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-const assert = require("assert");
-require("reflect-metadata");
-const REFLECTION_KEY = 'loopback.inject';
-/**
- * A decorator to annotate method arguments for automatic injection
- * by LoopBack IoC container.
- *
- * Usage - Typescript:
- *
- * ```ts
- * class InfoController {
- *   constructor(@inject('application.name') public appName: string) {
- *   }
- *   // ...
- * }
- * ```
- *
- * Usage - JavaScript:
- *
- *  - TODO(bajtos)
- *
- * @param bindingKey What binding to use in order to resolve the value
- * of the annotated argument.
- */
-function inject(bindingKey) {
-    return function markArgumentAsInjected(target, propertyKey, parameterIndex) {
-        assert(parameterIndex != undefined, '@inject decorator can be used on function arguments only!');
-        const injectedArgs = Reflect.getOwnMetadata(REFLECTION_KEY, target, propertyKey) || [];
-        injectedArgs[parameterIndex] = bindingKey;
-        Reflect.defineMetadata(REFLECTION_KEY, injectedArgs, target, propertyKey);
-    };
-}
-exports.inject = inject;
-function describeInjectedArguments(target) {
-    return Reflect.getOwnMetadata(REFLECTION_KEY, target) || [];
-}
-exports.describeInjectedArguments = describeInjectedArguments;

package/lib/isPromise.d.ts

@@ -1 +0,0 @@
-export declare function isPromise<T>(value: T | Promise<T>): value is Promise<T>;

package/lib/isPromise.js

@@ -1,14 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2013,2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-function isPromise(value) {
-    if (!value)
-        return false;
-    if (typeof value !== 'object' && typeof value !== 'function')
-        return false;
-    return typeof value.then === 'function';
-}
-exports.isPromise = isPromise;

package/lib/resolver.d.ts

@@ -1,26 +0,0 @@
-import { Context } from './context';
-import { BoundValue } from './binding';
-export declare type Constructor<T> = new (...args: any[]) => T;
-/**
- * Create an instance of a class which constructor has arguments
- * decorated with `@inject`.
- *
- * The function returns a class when all dependencies were
- * resolved synchronously, or a Promise otherwise.
- *
- * @param ctor The class constructor to call.
- * @param ctx The context containing values for `@inject` resolution
- */
-export declare function instantiateClass<T>(ctor: Constructor<T>, ctx: Context): T | Promise<T>;
-/**
- * Given a function with arguments decorated with `@inject`,
- * return the list of arguments resolved using the values
- * bound in `ctx`.
-
- * The function returns an argument array when all dependencies were
- * resolved synchronously, or a Promise otherwise.
- *
- * @param fn The function for which the arguments should be resolved.
- * @param ctx The context containing values for `@inject` resolution
- */
-export declare function resolveInjectedArguments(fn: Function, ctx: Context): BoundValue[] | Promise<BoundValue[]>;

package/lib/resolver.js

@@ -1,72 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2013,2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-const isPromise_1 = require("./isPromise");
-const inject_1 = require("./inject");
-/**
- * Create an instance of a class which constructor has arguments
- * decorated with `@inject`.
- *
- * The function returns a class when all dependencies were
- * resolved synchronously, or a Promise otherwise.
- *
- * @param ctor The class constructor to call.
- * @param ctx The context containing values for `@inject` resolution
- */
-function instantiateClass(ctor, ctx) {
-    const argsOrPromise = resolveInjectedArguments(ctor, ctx);
-    if (isPromise_1.isPromise(argsOrPromise)) {
-        return argsOrPromise.then(args => new ctor(...args));
-    }
-    else {
-        return new ctor(...argsOrPromise);
-    }
-}
-exports.instantiateClass = instantiateClass;
-/**
- * Given a function with arguments decorated with `@inject`,
- * return the list of arguments resolved using the values
- * bound in `ctx`.
-
- * The function returns an argument array when all dependencies were
- * resolved synchronously, or a Promise otherwise.
- *
- * @param fn The function for which the arguments should be resolved.
- * @param ctx The context containing values for `@inject` resolution
- */
-function resolveInjectedArguments(fn, ctx) {
-    // NOTE: the array may be sparse, i.e.
-    //   Object.keys(injectedArgs).length !== injectedArgs.length
-    // Example value:
-    //   [ , 'key1', , 'key2']
-    const injectedArgs = inject_1.describeInjectedArguments(fn);
-    const args = new Array(fn.length);
-    let asyncResolvers = undefined;
-    for (let ix = 0; ix < fn.length; ix++) {
-        const bindingKey = injectedArgs[ix];
-        if (!bindingKey) {
-            throw new Error(`Cannot resolve injected arguments for function ${fn.name}: ` +
-                `The argument ${ix + 1} was not decorated for dependency injection.`);
-        }
-        const binding = ctx.getBinding(bindingKey);
-        const valueOrPromise = binding.getValue(ctx);
-        if (isPromise_1.isPromise(valueOrPromise)) {
-            if (!asyncResolvers)
-                asyncResolvers = [];
-            asyncResolvers.push(valueOrPromise.then((v) => args[ix] = v));
-        }
-        else {
-            args[ix] = valueOrPromise;
-        }
-    }
-    if (asyncResolvers) {
-        return Promise.all(asyncResolvers).then(() => args);
-    }
-    else {
-        return args;
-    }
-}
-exports.resolveInjectedArguments = resolveInjectedArguments;

package/lib6/binding.d.ts

@@ -1,75 +0,0 @@
-import { Context } from './context';
-import { Constructor } from './resolver';
-export declare type BoundValue = any;
-export declare class Binding {
-    private readonly _key;
-    isLocked: boolean;
-    private _tagName;
-    valueConstructor: Constructor<BoundValue>;
-    constructor(_key: string, isLocked?: boolean);
-    readonly key: string;
-    readonly tagName: string;
-    /**
-     * This is an internal function optimized for performance.
-     * Users should use `@inject(key)` or `ctx.get(key)` instead.
-     *
-     * Get the value bound to this key. Depending on `isSync`, this function returns either:
-     *  - the bound value
-     *  - a promise of the bound value
-     *
-     * Consumers wishing to consume sync values directly should use `isPromise`
-     * to check the type of the returned value to decide how to handle it.
-     *
-     * ```
-     * const result = binding.getValue(ctx);
-     * if (isPromise(result)) {
-     *   result.then(doSomething)
-     * } else {
-     *   doSomething(result);
-     * }
-     * ```
-     */
-    getValue(ctx: Context): BoundValue | Promise<BoundValue>;
-    lock(): this;
-    tag(tagName: string): this;
-    /**
-     * Bind the key to a constant value.
-     *
-     * @param value The bound value.
-     *
-     * @example
-     *
-     * ```ts
-     * ctx.bind('appName').to('CodeHub');
-     * ```
-     */
-    to(value: BoundValue): this;
-    /**
-     * Bind the key to a computed (dynamic) value.
-     *
-     * @param factoryFn The factory function creating the value.
-     *   Both sync and async functions are supported.
-     *
-     * @example
-     *
-     * ```ts
-     * // synchronous
-     * ctx.bind('now').toDynamicValue(() => Date.now());
-     *
-     * // asynchronous
-     * ctx.bind('something').toDynamicValue(
-     *  async () => Promise.delay(10).then(doSomething)
-     * );
-     * ```
-     */
-    toDynamicValue(factoryFn: () => BoundValue | Promise<BoundValue>): this;
-    /**
-     * Bind the key to an instance of the given class.
-     *
-     * @param ctor The class constructor to call. Any constructor
-     *   arguments must be annotated with `@inject` so that
-     *   we can resolve them from the context.
-     */
-    toClass<T>(ctor: Constructor<T>): this;
-    unlock(): this;
-}

package/lib6/binding.js

@@ -1,102 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2013,2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-const resolver_1 = require("./resolver");
-// FIXME(bajtos) The binding class should be parameterized by the value type stored
-class Binding {
-    constructor(_key, isLocked = false) {
-        this._key = _key;
-        this.isLocked = isLocked;
-    }
-    get key() { return this._key; }
-    get tagName() { return this._tagName; }
-    /**
-     * This is an internal function optimized for performance.
-     * Users should use `@inject(key)` or `ctx.get(key)` instead.
-     *
-     * Get the value bound to this key. Depending on `isSync`, this function returns either:
-     *  - the bound value
-     *  - a promise of the bound value
-     *
-     * Consumers wishing to consume sync values directly should use `isPromise`
-     * to check the type of the returned value to decide how to handle it.
-     *
-     * ```
-     * const result = binding.getValue(ctx);
-     * if (isPromise(result)) {
-     *   result.then(doSomething)
-     * } else {
-     *   doSomething(result);
-     * }
-     * ```
-     */
-    getValue(ctx) {
-        return Promise.reject(new Error(`No value was configured for binding ${this._key}.`));
-    }
-    lock() {
-        this.isLocked = true;
-        return this;
-    }
-    tag(tagName) {
-        this._tagName = tagName;
-        return this;
-    }
-    /**
-     * Bind the key to a constant value.
-     *
-     * @param value The bound value.
-     *
-     * @example
-     *
-     * ```ts
-     * ctx.bind('appName').to('CodeHub');
-     * ```
-     */
-    to(value) {
-        this.getValue = () => value;
-        return this;
-    }
-    /**
-     * Bind the key to a computed (dynamic) value.
-     *
-     * @param factoryFn The factory function creating the value.
-     *   Both sync and async functions are supported.
-     *
-     * @example
-     *
-     * ```ts
-     * // synchronous
-     * ctx.bind('now').toDynamicValue(() => Date.now());
-     *
-     * // asynchronous
-     * ctx.bind('something').toDynamicValue(
-     *  async () => Promise.delay(10).then(doSomething)
-     * );
-     * ```
-     */
-    toDynamicValue(factoryFn) {
-        // TODO(bajtos) allow factoryFn with @inject arguments
-        this.getValue = (ctx) => factoryFn();
-        return this;
-    }
-    /**
-     * Bind the key to an instance of the given class.
-     *
-     * @param ctor The class constructor to call. Any constructor
-     *   arguments must be annotated with `@inject` so that
-     *   we can resolve them from the context.
-     */
-    toClass(ctor) {
-        this.getValue = context => resolver_1.instantiateClass(ctor, context);
-        this.valueConstructor = ctor;
-        return this;
-    }
-    unlock() {
-        this.isLocked = false;
-        return this;
-    }
-}
-exports.Binding = Binding;

package/lib6/context.d.ts

@@ -1,14 +0,0 @@
-import { Binding, BoundValue } from './binding';
-export declare class Context {
-    private _parent;
-    private registry;
-    constructor(_parent?: Context);
-    bind(key: string): Binding;
-    contains(key: string): boolean;
-    find(pattern?: string): Binding[];
-    findByTag(pattern: string): Binding[];
-    protected _mergeWithParent(childList: Binding[], parentList?: Binding[]): Binding[];
-    get(key: string): Promise<BoundValue>;
-    getSync(key: string): BoundValue;
-    getBinding(key: string): Binding;
-}