@loopback/context 4.0.0-alpha.8 → 4.1.0

package/dist/resolver.d.ts

@@ -0,0 +1,46 @@
+import { Context } from './context';
+import { ResolutionSession } from './resolution-session';
+import { BoundValue, Constructor, MapObject, ValueOrPromise } from './value-promise';
+/**
+ * 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
+ * @param session - Optional session for binding and dependency resolution
+ * @param nonInjectedArgs - Optional array of args for non-injected parameters
+ */
+export declare function instantiateClass<T>(ctor: Constructor<T>, ctx: Context, session?: ResolutionSession, nonInjectedArgs?: any[]): ValueOrPromise<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 target - The class for constructor injection or prototype for method
+ * injection
+ * @param method - The method name. If set to '', the constructor will
+ * be used.
+ * @param ctx - The context containing values for `@inject` resolution
+ * @param session - Optional session for binding and dependency resolution
+ * @param nonInjectedArgs - Optional array of args for non-injected parameters
+ */
+export declare function resolveInjectedArguments(target: object, method: string, ctx: Context, session?: ResolutionSession, nonInjectedArgs?: any[]): ValueOrPromise<BoundValue[]>;
+/**
+ * Given a class with properties decorated with `@inject`,
+ * return the map of properties resolved using the values
+ * bound in `ctx`.
+
+ * The function returns an argument array when all dependencies were
+ * resolved synchronously, or a Promise otherwise.
+ *
+ * @param constructor - The class for which properties should be resolved.
+ * @param ctx - The context containing values for `@inject` resolution
+ * @param session - Optional session for binding and dependency resolution
+ */
+export declare function resolveInjectedProperties(constructor: Function, ctx: Context, session?: ResolutionSession): ValueOrPromise<MapObject<BoundValue>>;

package/dist/resolver.js

@@ -0,0 +1,203 @@
+"use strict";
+// Copyright IBM Corp. 2017,2019. 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.resolveInjectedProperties = exports.resolveInjectedArguments = exports.instantiateClass = 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_filter_1 = require("./binding-filter");
+const inject_1 = require("./inject");
+const resolution_session_1 = require("./resolution-session");
+const value_promise_1 = require("./value-promise");
+const debug = (0, debug_1.default)('loopback:context:resolver');
+const getTargetName = metadata_1.DecoratorFactory.getTargetName;
+/**
+ * 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
+ * @param session - Optional session for binding and dependency resolution
+ * @param nonInjectedArgs - Optional array of args for non-injected parameters
+ */
+function instantiateClass(ctor, ctx, session, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+nonInjectedArgs) {
+    /* istanbul ignore if */
+    if (debug.enabled) {
+        debug('Instantiating %s', getTargetName(ctor));
+        if (nonInjectedArgs === null || nonInjectedArgs === void 0 ? void 0 : nonInjectedArgs.length) {
+            debug('Non-injected arguments:', nonInjectedArgs);
+        }
+    }
+    const argsOrPromise = resolveInjectedArguments(ctor, '', ctx, session, nonInjectedArgs);
+    const propertiesOrPromise = resolveInjectedProperties(ctor, ctx, session);
+    const inst = (0, value_promise_1.transformValueOrPromise)(argsOrPromise, args => {
+        /* istanbul ignore if */
+        if (debug.enabled) {
+            debug('Injected arguments for %s():', ctor.name, args);
+        }
+        return new ctor(...args);
+    });
+    return (0, value_promise_1.transformValueOrPromise)(propertiesOrPromise, props => {
+        /* istanbul ignore if */
+        if (debug.enabled) {
+            debug('Injected properties for %s:', ctor.name, props);
+        }
+        return (0, value_promise_1.transformValueOrPromise)(inst, obj => Object.assign(obj, props));
+    });
+}
+exports.instantiateClass = instantiateClass;
+/**
+ * If the scope of current binding is `SINGLETON`, reset the context
+ * to be the one that owns the current binding to make sure a singleton
+ * does not have dependencies injected from child contexts unless the
+ * injection is for method (excluding constructor) parameters.
+ */
+function resolveContext(ctx, injection, session) {
+    const currentBinding = session === null || session === void 0 ? void 0 : session.currentBinding;
+    if (currentBinding == null) {
+        // No current binding
+        return ctx;
+    }
+    const isConstructorOrPropertyInjection = 
+    // constructor injection
+    !injection.member ||
+        // property injection
+        typeof injection.methodDescriptorOrParameterIndex !== 'number';
+    if (isConstructorOrPropertyInjection) {
+        // Set context to the resolution context of the current binding for
+        // constructor or property injections against a singleton
+        ctx = ctx.getResolutionContext(currentBinding);
+    }
+    return ctx;
+}
+/**
+ * Resolve the value or promise for a given injection
+ * @param ctx - Context
+ * @param injection - Descriptor of the injection
+ * @param session - Optional session for binding and dependency resolution
+ */
+function resolve(ctx, injection, session) {
+    /* istanbul ignore if */
+    if (debug.enabled) {
+        debug('Resolving an injection:', resolution_session_1.ResolutionSession.describeInjection(injection));
+    }
+    ctx = resolveContext(ctx, injection, session);
+    const resolved = resolution_session_1.ResolutionSession.runWithInjection(s => {
+        if (injection.resolve) {
+            // A custom resolve function is provided
+            return injection.resolve(ctx, injection, s);
+        }
+        else {
+            // Default to resolve the value from the context by binding key
+            (0, assert_1.default)((0, binding_filter_1.isBindingAddress)(injection.bindingSelector), 'The binding selector must be an address (string or BindingKey)');
+            const key = injection.bindingSelector;
+            const options = {
+                session: s,
+                ...injection.metadata,
+            };
+            return ctx.getValueOrPromise(key, options);
+        }
+    }, injection, session);
+    return resolved;
+}
+/**
+ * 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 target - The class for constructor injection or prototype for method
+ * injection
+ * @param method - The method name. If set to '', the constructor will
+ * be used.
+ * @param ctx - The context containing values for `@inject` resolution
+ * @param session - Optional session for binding and dependency resolution
+ * @param nonInjectedArgs - Optional array of args for non-injected parameters
+ */
+function resolveInjectedArguments(target, method, ctx, session, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+nonInjectedArgs) {
+    /* istanbul ignore if */
+    if (debug.enabled) {
+        debug('Resolving injected arguments for %s', getTargetName(target, method));
+    }
+    const targetWithMethods = target;
+    if (method) {
+        (0, assert_1.default)(typeof targetWithMethods[method] === 'function', `Method ${method} not found`);
+    }
+    // NOTE: the array may be sparse, i.e.
+    //   Object.keys(injectedArgs).length !== injectedArgs.length
+    // Example value:
+    //   [ , 'key1', , 'key2']
+    const injectedArgs = (0, inject_1.describeInjectedArguments)(target, method);
+    const extraArgs = nonInjectedArgs !== null && nonInjectedArgs !== void 0 ? nonInjectedArgs : [];
+    let argLength = metadata_1.DecoratorFactory.getNumberOfParameters(target, method);
+    // Please note `injectedArgs` contains `undefined` for non-injected args
+    const numberOfInjected = injectedArgs.filter(i => i != null).length;
+    if (argLength < numberOfInjected + extraArgs.length) {
+        /**
+         * `Function.prototype.length` excludes the rest parameter and only includes
+         * parameters before the first one with a default value. For example,
+         * `hello(@inject('name') name: string = 'John')` gives 0 for argLength
+         */
+        argLength = numberOfInjected + extraArgs.length;
+    }
+    let nonInjectedIndex = 0;
+    return (0, value_promise_1.resolveList)(new Array(argLength), (val, ix) => {
+        // The `val` argument is not used as the resolver only uses `injectedArgs`
+        // and `extraArgs` to return the new value
+        const injection = ix < injectedArgs.length ? injectedArgs[ix] : undefined;
+        if (injection == null ||
+            (!injection.bindingSelector && !injection.resolve)) {
+            if (nonInjectedIndex < extraArgs.length) {
+                // Set the argument from the non-injected list
+                return extraArgs[nonInjectedIndex++];
+            }
+            else {
+                const name = getTargetName(target, method, ix);
+                throw new resolution_session_1.ResolutionError(`The argument '${name}' is not decorated for dependency injection ` +
+                    'but no value was supplied by the caller. Did you forget to apply ' +
+                    '@inject() to the argument?', { context: ctx, options: { session } });
+            }
+        }
+        return resolve(ctx, injection, 
+        // Clone the session so that multiple arguments can be resolved in parallel
+        resolution_session_1.ResolutionSession.fork(session));
+    });
+}
+exports.resolveInjectedArguments = resolveInjectedArguments;
+/**
+ * Given a class with properties decorated with `@inject`,
+ * return the map of properties resolved using the values
+ * bound in `ctx`.
+
+ * The function returns an argument array when all dependencies were
+ * resolved synchronously, or a Promise otherwise.
+ *
+ * @param constructor - The class for which properties should be resolved.
+ * @param ctx - The context containing values for `@inject` resolution
+ * @param session - Optional session for binding and dependency resolution
+ */
+function resolveInjectedProperties(constructor, ctx, session) {
+    /* istanbul ignore if */
+    if (debug.enabled) {
+        debug('Resolving injected properties for %s', getTargetName(constructor));
+    }
+    const injectedProperties = (0, inject_1.describeInjectedProperties)(constructor.prototype);
+    return (0, value_promise_1.resolveMap)(injectedProperties, injection => resolve(ctx, injection, 
+    // Clone the session so that multiple properties can be resolved in parallel
+    resolution_session_1.ResolutionSession.fork(session)));
+}
+exports.resolveInjectedProperties = resolveInjectedProperties;
+//# sourceMappingURL=resolver.js.map

package/dist/resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,iDAAoD;AACpD,iEAA4B;AAC5B,+DAAgC;AAChC,qDAAkD;AAGlD,qCAIkB;AAClB,6DAI8B;AAC9B,mDAQyB;AAEzB,MAAM,KAAK,GAAG,IAAA,eAAW,EAAC,2BAA2B,CAAC,CAAC;AACvD,MAAM,aAAa,GAAG,2BAAgB,CAAC,aAAa,CAAC;AAErD;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAC9B,IAAoB,EACpB,GAAY,EACZ,OAA2B;AAC3B,8DAA8D;AAC9D,eAAuB;IAEvB,wBAAwB;IACxB,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CAAC,kBAAkB,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,IAAI,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM,EAAE;YAC3B,KAAK,CAAC,yBAAyB,EAAE,eAAe,CAAC,CAAC;SACnD;KACF;IACD,MAAM,aAAa,GAAG,wBAAwB,CAC5C,IAAI,EACJ,EAAE,EACF,GAAG,EACH,OAAO,EACP,eAAe,CAChB,CAAC;IACF,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAsB,IAAA,uCAAuB,EACrD,aAAa,EACb,IAAI,CAAC,EAAE;QACL,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,KAAK,CAAC,8BAA8B,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3B,CAAC,CACF,CAAC;IACF,OAAO,IAAA,uCAAuB,EAAC,mBAAmB,EAAE,KAAK,CAAC,EAAE;QAC1D,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,KAAK,CAAC,6BAA6B,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;SACxD;QACD,OAAO,IAAA,uCAAuB,EAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC;AAvCD,4CAuCC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CACrB,GAAY,EACZ,SAA8B,EAC9B,OAA2B;IAE3B,MAAM,cAAc,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC;IAC/C,IAAI,cAAc,IAAI,IAAI,EAAE;QAC1B,qBAAqB;QACrB,OAAO,GAAG,CAAC;KACZ;IAED,MAAM,gCAAgC;IACpC,wBAAwB;IACxB,CAAC,SAAS,CAAC,MAAM;QACjB,qBAAqB;QACrB,OAAO,SAAS,CAAC,gCAAgC,KAAK,QAAQ,CAAC;IAEjE,IAAI,gCAAgC,EAAE;QACpC,mEAAmE;QACnE,yDAAyD;QACzD,GAAG,GAAG,GAAG,CAAC,oBAAoB,CAAC,cAAc,CAAE,CAAC;KACjD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,SAAS,OAAO,CACd,GAAY,EACZ,SAA8B,EAC9B,OAA2B;IAE3B,wBAAwB;IACxB,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CACH,yBAAyB,EACzB,sCAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAC/C,CAAC;KACH;IAED,GAAG,GAAG,cAAc,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,sCAAiB,CAAC,gBAAgB,CACjD,CAAC,CAAC,EAAE;QACF,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,wCAAwC;YACxC,OAAO,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;SAC7C;aAAM;YACL,+DAA+D;YAC/D,IAAA,gBAAM,EACJ,IAAA,iCAAgB,EAAC,SAAS,CAAC,eAAe,CAAC,EAC3C,gEAAgE,CACjE,CAAC;YACF,MAAM,GAAG,GAAG,SAAS,CAAC,eAAiC,CAAC;YACxD,MAAM,OAAO,GAAsB;gBACjC,OAAO,EAAE,CAAC;gBACV,GAAG,SAAS,CAAC,QAAQ;aACtB,CAAC;YACF,OAAO,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SAC5C;IACH,CAAC,EACD,SAAS,EACT,OAAO,CACR,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,wBAAwB,CACtC,MAAc,EACd,MAAc,EACd,GAAY,EACZ,OAA2B;AAC3B,8DAA8D;AAC9D,eAAuB;IAEvB,wBAAwB;IACxB,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CAAC,qCAAqC,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;KAC7E;IACD,MAAM,iBAAiB,GAAiC,MAAM,CAAC;IAC/D,IAAI,MAAM,EAAE;QACV,IAAA,gBAAM,EACJ,OAAO,iBAAiB,CAAC,MAAM,CAAC,KAAK,UAAU,EAC/C,UAAU,MAAM,YAAY,CAC7B,CAAC;KACH;IACD,sCAAsC;IACtC,6DAA6D;IAC7D,iBAAiB;IACjB,0BAA0B;IAC1B,MAAM,YAAY,GAAG,IAAA,kCAAyB,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAE,CAAC;IAExC,IAAI,SAAS,GAAG,2BAAgB,CAAC,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvE,wEAAwE;IACxE,MAAM,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC;IACpE,IAAI,SAAS,GAAG,gBAAgB,GAAG,SAAS,CAAC,MAAM,EAAE;QACnD;;;;WAIG;QACH,SAAS,GAAG,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC;KACjD;IAED,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,OAAO,IAAA,2BAAW,EAAC,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;QACnD,0EAA0E;QAC1E,0CAA0C;QAC1C,MAAM,SAAS,GAAG,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,IACE,SAAS,IAAI,IAAI;YACjB,CAAC,CAAC,SAAS,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAClD;YACA,IAAI,gBAAgB,GAAG,SAAS,CAAC,MAAM,EAAE;gBACvC,8CAA8C;gBAC9C,OAAO,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC;aACtC;iBAAM;gBACL,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC/C,MAAM,IAAI,oCAAe,CACvB,iBAAiB,IAAI,8CAA8C;oBACjE,mEAAmE;oBACnE,4BAA4B,EAC9B,EAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,EAAC,OAAO,EAAC,EAAC,CACnC,CAAC;aACH;SACF;QAED,OAAO,OAAO,CACZ,GAAG,EACH,SAAS;QACT,2EAA2E;QAC3E,sCAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAChC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AArED,4DAqEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,yBAAyB,CACvC,WAAqB,EACrB,GAAY,EACZ,OAA2B;IAE3B,wBAAwB;IACxB,IAAI,KAAK,CAAC,OAAO,EAAE;QACjB,KAAK,CAAC,sCAAsC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;KAC3E;IACD,MAAM,kBAAkB,GAAG,IAAA,mCAA0B,EAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAE7E,OAAO,IAAA,0BAAU,EAAC,kBAAkB,EAAE,SAAS,CAAC,EAAE,CAChD,OAAO,CACL,GAAG,EACH,SAAS;IACT,4EAA4E;IAC5E,sCAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAChC,CACF,CAAC;AACJ,CAAC;AAnBD,8DAmBC"}

package/dist/unique-id.d.ts

@@ -0,0 +1,14 @@
+import hyperid from 'hyperid';
+/**
+ * Generate a (globally) unique identifier in a very fast way.
+ * Please note the ids ARE NOT formatted as UUID and have variable length.
+ * The format of generated values may change in the future.
+ *
+ * @internal
+ */
+export declare const generateUniqueId: hyperid.Instance;
+/**
+ * A regular expression for testing values generated by generateUniqueId.
+ * @internal
+ */
+export declare const UNIQUE_ID_PATTERN: RegExp;

package/dist/unique-id.js

@@ -0,0 +1,26 @@
+"use strict";
+// Copyright IBM Corp. 2018,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.UNIQUE_ID_PATTERN = exports.generateUniqueId = void 0;
+const tslib_1 = require("tslib");
+const hyperid_1 = (0, tslib_1.__importDefault)(require("hyperid"));
+/**
+ * Generate a (globally) unique identifier in a very fast way.
+ * Please note the ids ARE NOT formatted as UUID and have variable length.
+ * The format of generated values may change in the future.
+ *
+ * @internal
+ */
+exports.generateUniqueId = (0, hyperid_1.default)({
+    fixedLength: false,
+    urlSafe: true,
+});
+/**
+ * A regular expression for testing values generated by generateUniqueId.
+ * @internal
+ */
+exports.UNIQUE_ID_PATTERN = /[A-Za-z0-9-_]+-\d+/;
+//# sourceMappingURL=unique-id.js.map

package/dist/unique-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unique-id.js","sourceRoot":"","sources":["../src/unique-id.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,mEAA8B;AAE9B;;;;;;GAMG;AACU,QAAA,gBAAgB,GAAG,IAAA,iBAAO,EAAC;IACtC,WAAW,EAAE,KAAK;IAClB,OAAO,EAAE,IAAI;CACd,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,iBAAiB,GAAG,oBAAoB,CAAC"}

package/dist/value-promise.d.ts

@@ -0,0 +1,134 @@
+/**
+ * A class constructor accepting arbitrary arguments.
+ */
+export declare type Constructor<T> = new (...args: any[]) => T;
+export declare type BoundValue = any;
+/**
+ * Representing a value or promise. This type is used to represent results of
+ * synchronous/asynchronous resolution of values.
+ *
+ * Note that we are using PromiseLike instead of native Promise to describe
+ * the asynchronous variant. This allows producers of async values to use
+ * any Promise implementation (e.g. Bluebird) instead of native Promises
+ * provided by JavaScript runtime.
+ */
+export declare type ValueOrPromise<T> = T | PromiseLike<T>;
+export declare type MapObject<T> = Record<string, T>;
+/**
+ * Check whether a value is a Promise-like instance.
+ * Recognizes both native promises and third-party promise libraries.
+ *
+ * @param value - The value to check.
+ */
+export declare function isPromiseLike<T>(value: T | PromiseLike<T> | undefined): value is PromiseLike<T>;
+/**
+ * Get nested properties of an object by path
+ * @param value - Value of the source object
+ * @param path - Path to the property
+ */
+export declare function getDeepProperty<OUT = BoundValue, IN = BoundValue>(value: IN, path: string): OUT | undefined;
+/**
+ * Resolve entries of an object into a new object with the same keys. If one or
+ * more entries of the source object are resolved to a promise by the `resolver`
+ * function, this method returns a promise which will be resolved to the new
+ * object with fully resolved entries.
+ *
+ * @example
+ *
+ * - Example 1: resolve all entries synchronously
+ * ```ts
+ * const result = resolveMap({a: 'x', b: 'y'}, v => v.toUpperCase());
+ * ```
+ * The `result` will be `{a: 'X', b: 'Y'}`.
+ *
+ * - Example 2: resolve one or more entries asynchronously
+ * ```ts
+ * const result = resolveMap({a: 'x', b: 'y'}, v =>
+ *   Promise.resolve(v.toUpperCase()),
+ * );
+ * ```
+ * The `result` will be a promise of `{a: 'X', b: 'Y'}`.
+ *
+ * @param map - The original object containing the source entries
+ * @param resolver - A function resolves an entry to a value or promise. It will
+ * be invoked with the property value, the property name, and the source object.
+ */
+export declare function resolveMap<T, V>(map: MapObject<T>, resolver: (val: T, key: string, values: MapObject<T>) => ValueOrPromise<V>): ValueOrPromise<MapObject<V>>;
+/**
+ * Resolve entries of an array into a new array with the same indexes. If one or
+ * more entries of the source array are resolved to a promise by the `resolver`
+ * function, this method returns a promise which will be resolved to the new
+ * array with fully resolved entries.
+ *
+ * @example
+ *
+ * - Example 1: resolve all entries synchronously
+ * ```ts
+ * const result = resolveList(['a', 'b'], v => v.toUpperCase());
+ * ```
+ * The `result` will be `['A', 'B']`.
+ *
+ * - Example 2: resolve one or more entries asynchronously
+ * ```ts
+ * const result = resolveList(['a', 'b'], v =>
+ *   Promise.resolve(v.toUpperCase()),
+ * );
+ * ```
+ * The `result` will be a promise of `['A', 'B']`.
+ *
+ * @param list - The original array containing the source entries
+ * @param resolver - A function resolves an entry to a value or promise. It will
+ * be invoked with the property value, the property index, and the source array.
+ */
+export declare function resolveList<T, V>(list: T[], resolver: (val: T, index: number, values: T[]) => ValueOrPromise<V>): ValueOrPromise<V[]>;
+/**
+ * Try to run an action that returns a promise or a value
+ * @param action - A function that returns a promise or a value
+ * @param finalAction - A function to be called once the action
+ * is fulfilled or rejected (synchronously or asynchronously)
+ *
+ *  @typeParam T - Type for the return value
+ */
+export declare function tryWithFinally<T>(action: () => ValueOrPromise<T>, finalAction: () => void): ValueOrPromise<T>;
+/**
+ * Try to run an action that returns a promise or a value with error and final
+ * actions to mimic `try {} catch(err) {} finally {}` for a value or promise.
+ *
+ * @param action - A function that returns a promise or a value
+ * @param errorAction - A function to be called once the action
+ * is rejected (synchronously or asynchronously). It must either return a new
+ * value or throw an error.
+ * @param finalAction - A function to be called once the action
+ * is fulfilled or rejected (synchronously or asynchronously)
+ *
+ * @typeParam T - Type for the return value
+ */
+export declare function tryCatchFinally<T>(action: () => ValueOrPromise<T>, errorAction?: (err: unknown) => T | never, finalAction?: () => void): ValueOrPromise<T>;
+/**
+ * Resolve an iterator of source values into a result until the evaluator
+ * returns `true`
+ * @param source - The iterator of source values
+ * @param resolver - The resolve function that maps the source value to a result
+ * @param evaluator - The evaluate function that decides when to stop
+ */
+export declare function resolveUntil<T, V>(source: Iterator<T>, resolver: (sourceVal: T) => ValueOrPromise<V | undefined>, evaluator: (sourceVal: T, targetVal: V | undefined) => boolean): ValueOrPromise<V | undefined>;
+/**
+ * Transform a value or promise with a function that produces a new value or
+ * promise
+ * @param valueOrPromise - The value or promise
+ * @param transformer - A function that maps the source value to a value or promise
+ */
+export declare function transformValueOrPromise<T, V>(valueOrPromise: ValueOrPromise<T>, transformer: (val: T) => ValueOrPromise<V>): ValueOrPromise<V>;
+/**
+ * A utility to generate uuid v4
+ *
+ * @deprecated Use `generateUniqueId`, [uuid](https://www.npmjs.com/package/uuid)
+ * or [hyperid](https://www.npmjs.com/package/hyperid) instead.
+ */
+export declare function uuid(): string;
+/**
+ * A regular expression for testing uuid v4 PATTERN
+ * @deprecated This pattern is an internal helper used by unit-tests, we are no
+ * longer using it.
+ */
+export declare const UUID_PATTERN: RegExp;