@microsoft/fast-element 2.0.0-beta.2 → 2.0.0-beta.20

package/dist/esm/di/di.js

@@ -0,0 +1,1430 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Big thanks to https://github.com/fkleuver and the https://github.com/aurelia/aurelia project
+ * for the bulk of this code and many of the associated tests.
+ */
+import { Context } from "../context.js";
+import "../interfaces.js";
+import { Metadata } from "../metadata.js";
+import { emptyArray, FAST } from "../platform.js";
+/**
+ * A utility class used that constructs and registers resolvers for a dependency
+ * injection container. Supports a standard set of object lifetimes.
+ * @public
+ */
+export class ResolverBuilder {
+    /**
+     *
+     * @param container - The container to create resolvers for.
+     * @param key - The key to register resolvers under.
+     */
+    constructor(container, key) {
+        this.container = container;
+        this.key = key;
+    }
+    /**
+     * Creates a resolver for an existing object instance.
+     * @param value - The instance to resolve.
+     * @returns The resolver.
+     */
+    instance(value) {
+        return this.registerResolver(0 /* ResolverStrategy.instance */, value);
+    }
+    /**
+     * Creates a resolver that enforces a singleton lifetime.
+     * @param value - The type to create and cache the singleton for.
+     * @returns The resolver.
+     */
+    singleton(value) {
+        return this.registerResolver(1 /* ResolverStrategy.singleton */, value);
+    }
+    /**
+     * Creates a resolver that creates a new instance for every dependency request.
+     * @param value - The type to create instances of.
+     * @returns - The resolver.
+     */
+    transient(value) {
+        return this.registerResolver(2 /* ResolverStrategy.transient */, value);
+    }
+    /**
+     * Creates a resolver that invokes a callback function for every dependency resolution
+     * request, allowing custom logic to return the dependency.
+     * @param value - The callback to call during resolution.
+     * @returns The resolver.
+     */
+    callback(value) {
+        return this.registerResolver(3 /* ResolverStrategy.callback */, value);
+    }
+    /**
+     * Creates a resolver that invokes a callback function the first time that a dependency
+     * resolution is requested. The returned value is then cached and provided for all
+     * subsequent requests.
+     * @param value - The callback to call during the first resolution.
+     * @returns The resolver.
+     */
+    cachedCallback(value) {
+        return this.registerResolver(3 /* ResolverStrategy.callback */, cacheCallbackResult(value));
+    }
+    /**
+     * Aliases the current key to a different key.
+     * @param destinationKey - The key to point the alias to.
+     * @returns The resolver.
+     */
+    aliasTo(destinationKey) {
+        return this.registerResolver(5 /* ResolverStrategy.alias */, destinationKey);
+    }
+    registerResolver(strategy, state) {
+        const { container, key } = this;
+        /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+        this.container = this.key = (void 0);
+        return container.registerResolver(key, new ResolverImpl(key, strategy, state));
+    }
+}
+function cloneArrayWithPossibleProps(source) {
+    const clone = source.slice();
+    const keys = Object.keys(source);
+    const len = keys.length;
+    let key;
+    for (let i = 0; i < len; ++i) {
+        key = keys[i];
+        if (!isArrayIndex(key)) {
+            clone[key] = source[key];
+        }
+    }
+    return clone;
+}
+/**
+ * A set of default resolvers useful in configuring a container.
+ * @public
+ */
+export const DefaultResolver = Object.freeze({
+    /**
+     * Disables auto-registration and throws for all un-registered dependencies.
+     * @param key - The key to create the resolver for.
+     */
+    none(key) {
+        throw FAST.error(1512 /* Message.noDefaultResolver */, { key });
+    },
+    /**
+     * Provides default singleton resolution behavior during auto-registration.
+     * @param key - The key to create the resolver for.
+     * @returns The resolver.
+     */
+    singleton(key) {
+        return new ResolverImpl(key, 1 /* ResolverStrategy.singleton */, key);
+    },
+    /**
+     * Provides default transient resolution behavior during auto-registration.
+     * @param key - The key to create the resolver for.
+     * @returns The resolver.
+     */
+    transient(key) {
+        return new ResolverImpl(key, 2 /* ResolverStrategy.transient */, key);
+    },
+});
+/**
+ * Configuration for a dependency injection container.
+ * @public
+ */
+export const ContainerConfiguration = Object.freeze({
+    /**
+     * The default configuration used when creating a DOM-disconnected container.
+     * @remarks
+     * The default creates a root container, with no parent container. It does not handle
+     * owner requests and it uses singleton resolution behavior for auto-registration.
+     */
+    default: Object.freeze({
+        parentLocator: () => null,
+        asyncRegistrationLocator: () => __awaiter(void 0, void 0, void 0, function* () { return null; }),
+        responsibleForOwnerRequests: false,
+        defaultResolver: DefaultResolver.singleton,
+    }),
+});
+function createContext(nameConfigOrCallback, configuror) {
+    const configure = typeof nameConfigOrCallback === "function" ? nameConfigOrCallback : configuror;
+    const friendlyName = typeof nameConfigOrCallback === "string"
+        ? nameConfigOrCallback
+        : nameConfigOrCallback && "friendlyName" in nameConfigOrCallback
+            ? nameConfigOrCallback.friendlyName || defaultFriendlyName
+            : defaultFriendlyName;
+    const respectConnection = typeof nameConfigOrCallback === "string"
+        ? false
+        : nameConfigOrCallback && "respectConnection" in nameConfigOrCallback
+            ? nameConfigOrCallback.respectConnection || false
+            : false;
+    const Interface = function (target, property, index) {
+        if (target == null || new.target !== undefined) {
+            throw FAST.error(1501 /* Message.noRegistrationForContext */, { name: Interface.name });
+        }
+        if (property) {
+            DI.defineProperty(target, property, Interface, respectConnection);
+        }
+        else {
+            const annotationParamtypes = Metadata.getOrCreateAnnotationParamTypes(target);
+            annotationParamtypes[index] = Interface;
+        }
+    };
+    Interface.$isInterface = true;
+    Reflect.defineProperty(Interface, "name", {
+        value: friendlyName !== null && friendlyName !== void 0 ? friendlyName : defaultFriendlyName,
+    });
+    if (configure != null) {
+        Interface.register = function (container, key) {
+            return configure(new ResolverBuilder(container, key !== null && key !== void 0 ? key : Interface));
+        };
+    }
+    Interface.toString = function toString() {
+        return `DIContext<${Interface.name}>`;
+    };
+    return Interface;
+}
+const dependencyLookup = new Map();
+let rootDOMContainer = null;
+let nonRootDOMContainerCount = 0;
+/**
+ * The gateway to dependency injection APIs.
+ * @public
+ */
+export const DI = Object.freeze({
+    /**
+     * Installs dependency injection as the default strategy for handling
+     * all calls to Context.request.
+     * @param fallback - Creates a container if one cannot be found.
+     */
+    installAsContextRequestStrategy(fallback) {
+        Context.setDefaultRequestStrategy((target, context, callback) => {
+            const container = DI.findResponsibleContainer(target, fallback);
+            callback(container.get(context));
+        });
+    },
+    /**
+     * Creates a new dependency injection container.
+     * @param config - The configuration for the container.
+     * @returns A newly created dependency injection container.
+     */
+    createContainer(config) {
+        return new ContainerImpl(null, Object.assign({}, ContainerConfiguration.default, config));
+    },
+    /**
+     * Finds the dependency injection container responsible for providing dependencies
+     * to the specified node.
+     * @param target - The node to find the responsible container for.
+     * @param fallback - Creates a container if one cannot be found.
+     * @returns The container responsible for providing dependencies to the node.
+     * @remarks
+     * This will be the same as the parent container if the specified node
+     * does not itself host a container configured with responsibleForOwnerRequests.
+     */
+    findResponsibleContainer(target, fallback) {
+        const owned = target.$$container$$;
+        if (owned && owned.responsibleForOwnerRequests) {
+            return owned;
+        }
+        return DI.findParentContainer(target, fallback);
+    },
+    /**
+     * Find the dependency injection container up the DOM tree from this node.
+     * @param target - The node to find the parent container for.
+     * @param fallback - Creates a container if one cannot be found.
+     * @returns The parent container of this node.
+     * @remarks
+     * This will be the same as the responsible container if the specified node
+     * does not itself host a container configured with responsibleForOwnerRequests.
+     */
+    findParentContainer(target, fallback) {
+        // NOTE: If there are no node-specific containers in existence other
+        // than the root, then we can bypass raising events and instead just grab
+        // the reference to the root container because we know it's the parent
+        // for this node.
+        if (nonRootDOMContainerCount < 1) {
+            return fallback ? fallback() : DI.getOrCreateDOMContainer();
+        }
+        // NOTE: If even one node-specific container has been created then we can
+        // no longer assume that the parent container for the target is the root
+        // and we must dispatch a context event in order to find the parent
+        // container in the DOM.
+        let container;
+        Context.dispatch(target, DOMContainer, value => (container = value));
+        // NOTE: If there are node-specific containers but there doesn't happen to
+        // be one that is a parent to the target node, then we still need to fall
+        // back to the root container.
+        return container !== null && container !== void 0 ? container : (fallback ? fallback() : DI.getOrCreateDOMContainer());
+    },
+    /**
+     * Returns a dependency injection container if one is explicitly owned by the specified
+     * node. If one is not owned, then a new container is created and assigned to the node.
+     * @param target - The node to find or create the container for.
+     * @param config - The configuration for the container if one needs to be created.
+     * @returns The located or created container.
+     * @remarks
+     * This API does not search for a responsible or parent container. It looks only for a container
+     * directly defined on the specified node and creates one at that location if one does not
+     * already exist.
+     */
+    getOrCreateDOMContainer(target, config) {
+        if (!target) {
+            return (rootDOMContainer ||
+                (rootDOMContainer = new ContainerImpl(typeof window !== "undefined" ? window : null, Object.assign({}, ContainerConfiguration.default, config, {
+                    parentLocator: () => null,
+                }))));
+        }
+        let container = target.$$container$$;
+        if (container === void 0) {
+            // NOTE: Creating a node-specific container de-optimizes container resolution.
+            nonRootDOMContainerCount++;
+            container = new ContainerImpl(target, Object.assign({}, ContainerConfiguration.default, config, {
+                parentLocator: DI.findParentContainer,
+            }));
+        }
+        return container;
+    },
+    /**
+     * Gets the dependency keys representing what is needed to instantiate the specified type.
+     * @param Type - The type to get the dependencies for.
+     * @returns An array of dependency keys.
+     */
+    getDependencies(Type) {
+        // Note: Every detail of this getDependencies method is pretty deliberate at the moment, and probably not yet 100% tested from every possible angle,
+        // so be careful with making changes here as it can have a huge impact on complex end user apps.
+        // Preferably, only make changes to the dependency resolution process via a RFC.
+        let dependencies = dependencyLookup.get(Type);
+        if (dependencies === void 0) {
+            // Type.length is the number of constructor parameters. If this is 0, it could mean the class has an empty constructor
+            // but it could also mean the class has no constructor at all (in which case it inherits the constructor from the prototype).
+            // Non-zero constructor length + no paramtypes means emitDecoratorMetadata is off, or the class has no decorator.
+            // We're not doing anything with the above right now, but it's good to keep in mind for any future issues.
+            const inject = Type.inject;
+            if (inject === void 0) {
+                // design:paramtypes is set by tsc when emitDecoratorMetadata is enabled.
+                const designParamtypes = Metadata.getDesignParamTypes(Type);
+                // di:paramtypes is set by the parameter decorator from DI.createInterface or by @inject
+                const annotationParamtypes = Metadata.getAnnotationParamTypes(Type);
+                if (designParamtypes === emptyArray) {
+                    if (annotationParamtypes === emptyArray) {
+                        // Only go up the prototype if neither static inject nor any of the paramtypes is defined, as
+                        // there is no sound way to merge a type's deps with its prototype's deps
+                        const Proto = Object.getPrototypeOf(Type);
+                        if (typeof Proto === "function" && Proto !== Function.prototype) {
+                            dependencies = cloneArrayWithPossibleProps(DI.getDependencies(Proto));
+                        }
+                        else {
+                            dependencies = [];
+                        }
+                    }
+                    else {
+                        // No design:paramtypes so just use the di:paramtypes
+                        dependencies = cloneArrayWithPossibleProps(annotationParamtypes);
+                    }
+                }
+                else if (annotationParamtypes === emptyArray) {
+                    // No di:paramtypes so just use the design:paramtypes
+                    dependencies = cloneArrayWithPossibleProps(designParamtypes);
+                }
+                else {
+                    // We've got both, so merge them (in case of conflict on same index, di:paramtypes take precedence)
+                    dependencies = cloneArrayWithPossibleProps(designParamtypes);
+                    let len = annotationParamtypes.length;
+                    let auAnnotationParamtype;
+                    for (let i = 0; i < len; ++i) {
+                        auAnnotationParamtype = annotationParamtypes[i];
+                        if (auAnnotationParamtype !== void 0) {
+                            dependencies[i] = auAnnotationParamtype;
+                        }
+                    }
+                    const keys = Object.keys(annotationParamtypes);
+                    len = keys.length;
+                    let key;
+                    for (let i = 0; i < len; ++i) {
+                        key = keys[i];
+                        if (!isArrayIndex(key)) {
+                            dependencies[key] = annotationParamtypes[key];
+                        }
+                    }
+                }
+            }
+            else {
+                // Ignore paramtypes if we have static inject
+                dependencies = cloneArrayWithPossibleProps(inject);
+            }
+            dependencyLookup.set(Type, dependencies);
+        }
+        return dependencies;
+    },
+    /**
+     * Defines a property on a web component class. The value of this property will
+     * be resolved from the dependency injection container responsible for the element
+     * instance, based on where it is connected in the DOM.
+     * @param target - The target to define the property on.
+     * @param propertyName - The name of the property to define.
+     * @param key - The dependency injection key.
+     * @param respectConnection - Indicates whether or not to update the property value if the
+     * hosting component is disconnected and then re-connected at a different location in the DOM.
+     * @remarks
+     * The respectConnection option is only applicable to elements that descend from FASTElement.
+     */
+    defineProperty(target, propertyName, key, respectConnection = false) {
+        const diPropertyKey = `$di_${propertyName}`;
+        Reflect.defineProperty(target, propertyName, {
+            get: function () {
+                let value = this[diPropertyKey];
+                if (value === void 0) {
+                    const container = this instanceof Node
+                        ? DI.findResponsibleContainer(this)
+                        : DI.getOrCreateDOMContainer();
+                    value = container.get(key);
+                    this[diPropertyKey] = value;
+                    if (respectConnection) {
+                        const notifier = this.$fastController;
+                        if (!notifier) {
+                            throw FAST.error(1514 /* Message.connectUpdateRequiresController */);
+                        }
+                        const handleChange = () => {
+                            const newContainer = DI.findResponsibleContainer(this);
+                            const newValue = newContainer.get(key);
+                            const oldValue = this[diPropertyKey];
+                            if (newValue !== oldValue) {
+                                this[diPropertyKey] = value;
+                                notifier.notify(propertyName);
+                            }
+                        };
+                        notifier.subscribe({ handleChange }, "isConnected");
+                    }
+                }
+                return value;
+            },
+        });
+    },
+    /**
+     * Creates a dependency injection key.
+     * @param nameConfigOrCallback - A friendly name for the key or a lambda that configures a
+     * default resolution for the dependency.
+     * @param configuror - If a friendly name was provided for the first parameter, then an optional
+     * lambda that configures a default resolution for the dependency can be provided second.
+     * @returns The created key.
+     * @remarks
+     * The created key can be used as a property decorator or constructor parameter decorator,
+     * in addition to its standard use in an inject array or through direct container APIs.
+     */
+    createContext,
+    /**
+     * A decorator that specifies what to inject into its target.
+     * @param dependencies - The dependencies to inject.
+     * @returns The decorator to be applied to the target class.
+     * @remarks
+     * The decorator can be used to decorate a class, listing all of the classes dependencies.
+     * Or it can be used to decorate a constructor parameter, indicating what to inject for that
+     * parameter.
+     * Or it can be used for a web component property, indicating what that property should resolve to.
+     */
+    inject(...dependencies) {
+        return function (target, key, descriptor) {
+            if (typeof descriptor === "number") {
+                // It's a parameter decorator.
+                const annotationParamtypes = Metadata.getOrCreateAnnotationParamTypes(target);
+                const dep = dependencies[0];
+                if (dep !== void 0) {
+                    annotationParamtypes[descriptor] = dep;
+                }
+            }
+            else if (key) {
+                DI.defineProperty(target, key, dependencies[0]);
+            }
+            else {
+                const annotationParamtypes = descriptor
+                    ? Metadata.getOrCreateAnnotationParamTypes(descriptor.value)
+                    : Metadata.getOrCreateAnnotationParamTypes(target);
+                let dep;
+                for (let i = 0; i < dependencies.length; ++i) {
+                    dep = dependencies[i];
+                    if (dep !== void 0) {
+                        annotationParamtypes[i] = dep;
+                    }
+                }
+            }
+        };
+    },
+    /**
+     * Registers the `target` class as a transient dependency; each time the dependency is resolved
+     * a new instance will be created.
+     *
+     * @param target - The class / constructor function to register as transient.
+     * @returns The same class, with a static `register` method that takes a container and returns the appropriate resolver.
+     *
+     * @example
+     * On an existing class
+     * ```ts
+     * class Foo { }
+     * DI.transient(Foo);
+     * ```
+     *
+     * @example
+     * Inline declaration
+     *
+     * ```ts
+     * const Foo = DI.transient(class { });
+     * // Foo is now strongly typed with register
+     * Foo.register(container);
+     * ```
+     *
+     * @public
+     */
+    transient(target) {
+        target.register = function register(container) {
+            const registration = Registration.transient(target, target);
+            return registration.register(container);
+        };
+        target.registerInRequestor = false;
+        return target;
+    },
+    /**
+     * Registers the `target` class as a singleton dependency; the class will only be created once. Each
+     * consecutive time the dependency is resolved, the same instance will be returned.
+     *
+     * @param target - The class / constructor function to register as a singleton.
+     * @returns The same class, with a static `register` method that takes a container and returns the appropriate resolver.
+     * @example
+     * On an existing class
+     * ```ts
+     * class Foo { }
+     * DI.singleton(Foo);
+     * ```
+     *
+     * @example
+     * Inline declaration
+     * ```ts
+     * const Foo = DI.singleton(class { });
+     * // Foo is now strongly typed with register
+     * Foo.register(container);
+     * ```
+     *
+     * @public
+     */
+    singleton(target, options = defaultSingletonOptions) {
+        target.register = function register(container) {
+            const registration = Registration.singleton(target, target);
+            return registration.register(container);
+        };
+        target.registerInRequestor = options.scoped;
+        return target;
+    },
+});
+/**
+ * The key that resolves the dependency injection Container itself.
+ * @public
+ */
+export const Container = DI.createContext("Container");
+/**
+ * The key that resolves a DOMContainer itself.
+ * @public
+ */
+export const DOMContainer = Container;
+/**
+ * The key that resolves the ServiceLocator itself.
+ * @public
+ */
+export const ServiceLocator = Container;
+function createResolver(getter) {
+    return function (key) {
+        const resolver = function (target, property, descriptor) {
+            DI.inject(resolver)(target, property, descriptor);
+        };
+        resolver.$isResolver = true;
+        resolver.resolve = function (handler, requestor) {
+            return getter(key, handler, requestor);
+        };
+        return resolver;
+    };
+}
+/**
+ * A decorator that specifies what to inject into its target.
+ * @param dependencies - The dependencies to inject.
+ * @returns The decorator to be applied to the target class.
+ * @remarks
+ * The decorator can be used to decorate a class, listing all of the classes dependencies.
+ * Or it can be used to decorate a constructor paramter, indicating what to inject for that
+ * parameter.
+ * Or it can be used for a web component property, indicating what that property should resolve to.
+ *
+ * @public
+ */
+export const inject = DI.inject;
+function transientDecorator(target) {
+    return DI.transient(target);
+}
+export function transient(target) {
+    return target == null ? transientDecorator : transientDecorator(target);
+}
+const defaultSingletonOptions = { scoped: false };
+function singletonDecorator(target) {
+    return DI.singleton(target);
+}
+/**
+ * @public
+ */
+export function singleton(targetOrOptions) {
+    if (typeof targetOrOptions === "function") {
+        return DI.singleton(targetOrOptions);
+    }
+    return function ($target) {
+        return DI.singleton($target, targetOrOptions);
+    };
+}
+function createAllResolver(getter) {
+    return function (key, searchAncestors) {
+        searchAncestors = !!searchAncestors;
+        const resolver = function (target, property, descriptor) {
+            DI.inject(resolver)(target, property, descriptor);
+        };
+        resolver.$isResolver = true;
+        resolver.resolve = function (handler, requestor) {
+            /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+            return getter(key, handler, requestor, searchAncestors);
+        };
+        return resolver;
+    };
+}
+/**
+ * A decorator and DI resolver that will resolve an array of all dependencies
+ * registered with the specified key.
+ * @param key - The key to resolve all dependencies for.
+ * @param searchAncestors - [optional] Indicates whether to search ancestor containers.
+ * @public
+ */
+export const all = createAllResolver((key, handler, requestor, searchAncestors) => requestor.getAll(key, searchAncestors));
+/**
+ * A decorator that lazily injects a dependency depending on whether the `Key` is present at the time of function call.
+ *
+ * @example
+ * You need to make your argument a function that returns the type, for example
+ * ```ts
+ * class Foo {
+ *   constructor( @lazy('random') public random: () => number )
+ * }
+ * const foo = container.get(Foo); // instanceof Foo
+ * foo.random(); // throws
+ * ```
+ * would throw an exception because you haven't registered `'random'` before calling the method.
+ * @example
+ * This, would give you a new 'Math.random()' number each time.
+ * ```ts
+ * class Foo {
+ *   constructor( @lazy('random') public random: () => random )
+ * }
+ * container.register(Registration.callback('random', Math.random ));
+ * container.get(Foo).random(); // some random number
+ * container.get(Foo).random(); // another random number
+ * ```
+ *
+ * `@lazy` does not manage the lifecycle of the underlying key. If you want a singleton, you have to register as a
+ * `singleton`, `transient` would also behave as you would expect, providing you a new instance each time.
+ *
+ * @param key - The key to lazily resolve.
+ * see {@link DI.createContext} on interactions with interfaces
+ *
+ * @public
+ */
+export const lazy = createResolver((key, handler, requestor) => {
+    return () => requestor.get(key);
+});
+/**
+ * A decorator that allows you to optionally inject a dependency depending on whether the [[`Key`]] is present, for example:
+ * @example
+ * ```ts
+ * class Foo {
+ *   constructor( @inject('mystring') public str: string = 'somestring' )
+ * }
+ * container.get(Foo); // throws
+ * ```
+ * would fail
+ *
+ * @example
+ * ```ts
+ * class Foo {
+ *   constructor( @optional('mystring') public str: string = 'somestring' )
+ * }
+ * container.get(Foo).str // somestring
+ * ```
+ * if you use it without a default it will inject `undefined`, so remember to mark your input type as
+ * possibly `undefined`!
+ *
+ * @param key - The key to optionally resolve.
+ * see {@link DI.createContext} on interactions with interfaces
+ *
+ * @public
+ */
+export const optional = createResolver((key, handler, requestor) => {
+    if (requestor.has(key, true)) {
+        return requestor.get(key);
+    }
+    else {
+        return undefined;
+    }
+});
+/**
+ * A decorator that tells the container not to try to inject a dependency.
+ *
+ * @public
+ */
+export function ignore(target, property, descriptor) {
+    DI.inject(ignore)(target, property, descriptor);
+}
+// Hack: casting below used to prevent TS from generate a namespace which can't be commented
+// and results in documentation validation errors.
+ignore.$isResolver = true;
+ignore.resolve = () => undefined;
+/**
+ * A decorator that indicates that a new instance should be injected scoped to the
+ * container that requested the instance.
+ * @param key - The dependency key for the new instance.
+ * @remarks
+ * This creates a resolver with an instance strategy pointing to the new instance, effectively
+ * making this a singleton, scoped to the container or DOM's subtree.
+ *
+ * @public
+ */
+export const newInstanceForScope = createResolver((key, handler, requestor) => {
+    const instance = createNewInstance(key, handler);
+    const resolver = new ResolverImpl(key, 0 /* ResolverStrategy.instance */, instance);
+    requestor.registerResolver(key, resolver);
+    return instance;
+});
+/**
+ * A decorator that indicates that a new instance should be injected.
+ * @param key - The dependency key for the new instance.
+ * @remarks
+ * The instance is not internally cached with a resolver as newInstanceForScope does.
+ *
+ * @public
+ */
+export const newInstanceOf = createResolver((key, handler, _requestor) => createNewInstance(key, handler));
+function createNewInstance(key, handler) {
+    /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+    return handler.getFactory(key).construct(handler);
+}
+/** @internal */
+export class ResolverImpl {
+    constructor(key, strategy, state) {
+        this.key = key;
+        this.strategy = strategy;
+        this.state = state;
+        this.resolving = false;
+    }
+    get $isResolver() {
+        return true;
+    }
+    register(container) {
+        return container.registerResolver(this.key, this);
+    }
+    resolveAsync(handler, requestor) {
+        switch (this.strategy) {
+            case 1 /* ResolverStrategy.singleton */: {
+                if (this.resolving) {
+                    throw FAST.error(1513 /* Message.cyclicDependency */, { name: this.state.name });
+                }
+                this.resolving = true;
+                return handler
+                    .getFactory(this.state)
+                    .constructAsync(requestor)
+                    .then(instance => {
+                    this.state = instance;
+                    this.strategy = 0 /* ResolverStrategy.instance */;
+                    this.resolving = false;
+                    return instance;
+                });
+            }
+            case 2 /* ResolverStrategy.transient */: {
+                // Always create transients from the requesting container
+                const factory = handler.getFactory(this.state);
+                if (factory === null) {
+                    throw FAST.error(1502 /* Message.noFactoryForResolver */, { key: this.key });
+                }
+                return factory.constructAsync(requestor);
+            }
+            default:
+                return Promise.resolve(this.resolve(handler, requestor));
+        }
+    }
+    resolve(handler, requestor) {
+        switch (this.strategy) {
+            case 0 /* ResolverStrategy.instance */:
+                return this.state;
+            case 1 /* ResolverStrategy.singleton */: {
+                if (this.resolving) {
+                    throw FAST.error(1513 /* Message.cyclicDependency */, { name: this.state.name });
+                }
+                this.resolving = true;
+                this.state = handler
+                    .getFactory(this.state)
+                    .construct(requestor);
+                this.strategy = 0 /* ResolverStrategy.instance */;
+                this.resolving = false;
+                return this.state;
+            }
+            case 2 /* ResolverStrategy.transient */: {
+                // Always create transients from the requesting container
+                const factory = handler.getFactory(this.state);
+                if (factory === null) {
+                    throw FAST.error(1502 /* Message.noFactoryForResolver */, { key: this.key });
+                }
+                return factory.construct(requestor);
+            }
+            case 3 /* ResolverStrategy.callback */:
+                return this.state(handler, requestor, this);
+            case 4 /* ResolverStrategy.array */:
+                return this.state[0].resolve(handler, requestor);
+            case 5 /* ResolverStrategy.alias */:
+                return requestor.get(this.state);
+            default:
+                throw FAST.error(1503 /* Message.invalidResolverStrategy */, {
+                    strategy: this.strategy,
+                });
+        }
+    }
+    getFactory(container) {
+        var _a, _b, _c;
+        switch (this.strategy) {
+            case 1 /* ResolverStrategy.singleton */:
+            case 2 /* ResolverStrategy.transient */:
+                return container.getFactory(this.state);
+            case 5 /* ResolverStrategy.alias */:
+                return (_c = (_b = (_a = container.getResolver(this.state)) === null || _a === void 0 ? void 0 : _a.getFactory) === null || _b === void 0 ? void 0 : _b.call(_a, container)) !== null && _c !== void 0 ? _c : null;
+            default:
+                return null;
+        }
+    }
+}
+function containerGetKey(d) {
+    return this.get(d);
+}
+function transformInstance(inst, transform) {
+    return transform(inst);
+}
+/** @internal */
+export class FactoryImpl {
+    constructor(Type, dependencies) {
+        this.Type = Type;
+        this.dependencies = dependencies;
+        this.transformers = null;
+    }
+    constructAsync(container, dynamicDependencies) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resolved = yield Promise.all(this.dependencies.map(x => container.getAsync(x)));
+            return this.constructCore(resolved, dynamicDependencies);
+        });
+    }
+    construct(container, dynamicDependencies) {
+        const resolved = this.dependencies.map(containerGetKey, container);
+        return this.constructCore(resolved, dynamicDependencies);
+    }
+    constructCore(resolved, dynamicDependencies) {
+        let instance;
+        if (dynamicDependencies === void 0) {
+            instance = new this.Type(...resolved);
+        }
+        else {
+            instance = new this.Type(...resolved, ...dynamicDependencies);
+        }
+        if (this.transformers === null) {
+            return instance;
+        }
+        return this.transformers.reduce(transformInstance, instance);
+    }
+    registerTransformer(transformer) {
+        (this.transformers || (this.transformers = [])).push(transformer);
+    }
+}
+const containerResolver = {
+    $isResolver: true,
+    resolve(handler, requestor) {
+        return requestor;
+    },
+    resolveAsync: function (handler, requestor) {
+        return Promise.resolve(requestor);
+    },
+};
+function isRegistry(obj) {
+    return typeof obj.register === "function";
+}
+function isSelfRegistry(obj) {
+    return isRegistry(obj) && typeof obj.registerInRequestor === "boolean";
+}
+function isRegisterInRequester(obj) {
+    return isSelfRegistry(obj) && obj.registerInRequestor;
+}
+function isClass(obj) {
+    return obj.prototype !== void 0;
+}
+const InstrinsicTypeNames = new Set([
+    "Array",
+    "ArrayBuffer",
+    "Boolean",
+    "DataView",
+    "Date",
+    "Error",
+    "EvalError",
+    "Float32Array",
+    "Float64Array",
+    "Function",
+    "Int8Array",
+    "Int16Array",
+    "Int32Array",
+    "Map",
+    "Number",
+    "Object",
+    "Promise",
+    "RangeError",
+    "ReferenceError",
+    "RegExp",
+    "Set",
+    "SharedArrayBuffer",
+    "String",
+    "SyntaxError",
+    "TypeError",
+    "Uint8Array",
+    "Uint8ClampedArray",
+    "Uint16Array",
+    "Uint32Array",
+    "URIError",
+    "WeakMap",
+    "WeakSet",
+]);
+const factories = new Map();
+/**
+ * @internal
+ */
+export class ContainerImpl {
+    constructor(owner, config) {
+        this.owner = owner;
+        this.config = config;
+        this._parent = void 0;
+        this.registerDepth = 0;
+        this.isHandlingContextRequests = false;
+        this.resolvers = new Map();
+        this.resolvers.set(Container, containerResolver);
+        if (owner) {
+            owner.$$container$$ = this;
+            if ("addEventListener" in owner) {
+                Context.handle(owner, (e) => {
+                    if (this.isHandlingContextRequests) {
+                        try {
+                            const value = this.get(e.context);
+                            e.stopImmediatePropagation();
+                            e.callback(value);
+                        }
+                        catch (_a) {
+                            // Container failed to find the context, so we need to
+                            // let the event propagate.
+                            // TODO: Introduce a tryGet API to Container. Issue #4582
+                        }
+                    }
+                    else if (e.context === Container &&
+                        e.composedPath()[0] !== this.owner) {
+                        e.stopImmediatePropagation();
+                        e.callback(this);
+                    }
+                });
+            }
+        }
+    }
+    get parent() {
+        if (this._parent === void 0) {
+            this._parent = this.config.parentLocator(this.owner);
+        }
+        return this._parent;
+    }
+    get depth() {
+        return this.parent === null ? 0 : this.parent.depth + 1;
+    }
+    get responsibleForOwnerRequests() {
+        return this.config.responsibleForOwnerRequests;
+    }
+    handleContextRequests(enable) {
+        this.isHandlingContextRequests = enable;
+    }
+    register(...params) {
+        if (++this.registerDepth === 100) {
+            // Most likely cause is trying to register a plain object that does not have a
+            // register method and is not a class constructor
+            throw FAST.error(1504 /* Message.cannotAutoregisterDependency */);
+        }
+        let current;
+        let keys;
+        let value;
+        let j;
+        let jj;
+        for (let i = 0, ii = params.length; i < ii; ++i) {
+            current = params[i];
+            if (!isObject(current)) {
+                continue;
+            }
+            if (isRegistry(current)) {
+                current.register(this);
+            }
+            else if (isClass(current)) {
+                Registration.singleton(current, current).register(this);
+            }
+            else {
+                keys = Object.keys(current);
+                j = 0;
+                jj = keys.length;
+                for (; j < jj; ++j) {
+                    value = current[keys[j]];
+                    if (!isObject(value)) {
+                        continue;
+                    }
+                    // note: we could remove this if-branch and call this.register directly
+                    // - the extra check is just a perf tweak to create fewer unnecessary arrays by the spread operator
+                    if (isRegistry(value)) {
+                        value.register(this);
+                    }
+                    else {
+                        this.register(value);
+                    }
+                }
+            }
+        }
+        --this.registerDepth;
+        return this;
+    }
+    registerResolver(key, resolver) {
+        validateKey(key);
+        const resolvers = this.resolvers;
+        const result = resolvers.get(key);
+        if (result == null) {
+            resolvers.set(key, resolver);
+        }
+        else if (result instanceof ResolverImpl &&
+            result.strategy === 4 /* ResolverStrategy.array */) {
+            result.state.push(resolver);
+        }
+        else {
+            resolvers.set(key, new ResolverImpl(key, 4 /* ResolverStrategy.array */, [result, resolver]));
+        }
+        return resolver;
+    }
+    registerTransformer(key, transformer) {
+        const resolver = this.getResolver(key);
+        if (resolver == null) {
+            return false;
+        }
+        if (resolver.getFactory) {
+            const factory = resolver.getFactory(this);
+            if (factory == null) {
+                return false;
+            }
+            // This type cast is a bit of a hacky one, necessary due to the duplicity of IResolverLike.
+            // Problem is that that interface's type arg can be of type Key, but the getFactory method only works on
+            // type Constructable. So the return type of that optional method has this additional constraint, which
+            // seems to confuse the type checker.
+            factory.registerTransformer(transformer);
+            return true;
+        }
+        return false;
+    }
+    getResolver(key, autoRegister = true) {
+        validateKey(key);
+        if (key.resolve !== void 0) {
+            return key;
+        }
+        /* eslint-disable-next-line @typescript-eslint/no-this-alias */
+        let current = this;
+        let resolver;
+        while (current != null) {
+            resolver = current.resolvers.get(key);
+            if (resolver == null) {
+                if (current.parent == null) {
+                    const handler = isRegisterInRequester(key)
+                        ? this
+                        : current;
+                    return autoRegister ? this.jitRegister(key, handler) : null;
+                }
+                current = current.parent;
+            }
+            else {
+                return resolver;
+            }
+        }
+        return null;
+    }
+    has(key, searchAncestors = false) {
+        return this.resolvers.has(key)
+            ? true
+            : searchAncestors && this.parent != null
+                ? this.parent.has(key, true)
+                : false;
+    }
+    getAsync(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            validateKey(key);
+            if (key.$isResolver) {
+                return key.resolveAsync(this, this);
+            }
+            /* eslint-disable-next-line @typescript-eslint/no-this-alias */
+            let current = this;
+            let resolver;
+            while (current != null) {
+                resolver = current.resolvers.get(key);
+                if (resolver == null) {
+                    if (current.parent == null) {
+                        const registration = yield this.config.asyncRegistrationLocator(key);
+                        if (!registration) {
+                            throw FAST.error(1505 /* Message.cannotResolveKey */, { key });
+                        }
+                        const handler = isRegisterInRequester(key)
+                            ? this
+                            : current;
+                        resolver = registration.register(handler);
+                        return resolver.resolveAsync(current, this);
+                    }
+                    current = current.parent;
+                }
+                else {
+                    return resolver.resolveAsync(current, this);
+                }
+            }
+            throw FAST.error(1505 /* Message.cannotResolveKey */, { key });
+        });
+    }
+    get(key) {
+        validateKey(key);
+        if (key.$isResolver) {
+            return key.resolve(this, this);
+        }
+        /* eslint-disable-next-line @typescript-eslint/no-this-alias */
+        let current = this;
+        let resolver;
+        while (current != null) {
+            resolver = current.resolvers.get(key);
+            if (resolver == null) {
+                if (current.parent == null) {
+                    const handler = isRegisterInRequester(key)
+                        ? this
+                        : current;
+                    resolver = this.jitRegister(key, handler);
+                    return resolver.resolve(current, this);
+                }
+                current = current.parent;
+            }
+            else {
+                return resolver.resolve(current, this);
+            }
+        }
+        throw FAST.error(1505 /* Message.cannotResolveKey */, { key });
+    }
+    getAll(key, searchAncestors = false) {
+        validateKey(key);
+        /* eslint-disable-next-line @typescript-eslint/no-this-alias */
+        const requestor = this;
+        let current = requestor;
+        let resolver;
+        if (searchAncestors) {
+            let resolutions = emptyArray;
+            while (current != null) {
+                resolver = current.resolvers.get(key);
+                if (resolver != null) {
+                    resolutions = resolutions.concat(
+                    /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion */
+                    buildAllResponse(resolver, current, requestor));
+                }
+                current = current.parent;
+            }
+            return resolutions;
+        }
+        else {
+            while (current != null) {
+                resolver = current.resolvers.get(key);
+                if (resolver == null) {
+                    current = current.parent;
+                    if (current == null) {
+                        return emptyArray;
+                    }
+                }
+                else {
+                    return buildAllResponse(resolver, current, requestor);
+                }
+            }
+        }
+        return emptyArray;
+    }
+    getFactory(Type) {
+        let factory = factories.get(Type);
+        if (factory === void 0) {
+            if (isNativeFunction(Type)) {
+                throw FAST.error(1506 /* Message.cannotConstructNativeFunction */, {
+                    name: Type.name,
+                });
+            }
+            factories.set(Type, (factory = new FactoryImpl(Type, DI.getDependencies(Type))));
+        }
+        return factory;
+    }
+    registerFactory(key, factory) {
+        factories.set(key, factory);
+    }
+    createChild(config) {
+        return new ContainerImpl(null, Object.assign({}, this.config, config, { parentLocator: () => this }));
+    }
+    jitRegister(keyAsValue, handler) {
+        if (typeof keyAsValue !== "function") {
+            throw FAST.error(1507 /* Message.cannotJITRegisterNonConstructor */, {
+                value: keyAsValue,
+            });
+        }
+        if (InstrinsicTypeNames.has(keyAsValue.name)) {
+            throw FAST.error(1508 /* Message.cannotJITRegisterIntrinsic */, {
+                value: keyAsValue.name,
+            });
+        }
+        if (isRegistry(keyAsValue)) {
+            const registrationResolver = keyAsValue.register(handler);
+            if (!(registrationResolver instanceof Object) ||
+                registrationResolver.resolve == null) {
+                const newResolver = handler.resolvers.get(keyAsValue);
+                if (newResolver != void 0) {
+                    return newResolver;
+                }
+                throw FAST.error(1510 /* Message.invalidResolver */);
+            }
+            return registrationResolver;
+        }
+        else if (keyAsValue.$isInterface) {
+            throw FAST.error(1509 /* Message.cannotJITRegisterInterface */, {
+                value: keyAsValue.name,
+            });
+        }
+        else {
+            const resolver = this.config.defaultResolver(keyAsValue, handler);
+            handler.resolvers.set(keyAsValue, resolver);
+            return resolver;
+        }
+    }
+}
+const cache = new WeakMap();
+function cacheCallbackResult(fun) {
+    return function (handler, requestor, resolver) {
+        if (cache.has(resolver)) {
+            return cache.get(resolver);
+        }
+        const t = fun(handler, requestor, resolver);
+        cache.set(resolver, t);
+        return t;
+    };
+}
+/**
+ * You can use the resulting Registration of any of the factory methods
+ * to register with the container.
+ *
+ * @example
+ * ```
+ * class Foo {}
+ * const container = DI.createContainer();
+ * container.register(Registration.instance(Foo, new Foo()));
+ * container.get(Foo);
+ * ```
+ *
+ * @public
+ */
+export const Registration = Object.freeze({
+    /**
+     * Allows you to pass an instance.
+     * Every time you request this {@link Key} you will get this instance back.
+     *
+     * @example
+     * ```
+     * Registration.instance(Foo, new Foo()));
+     * ```
+     *
+     * @param key - The key to register the instance under.
+     * @param value - The instance to return when the key is requested.
+     */
+    instance(key, value) {
+        return new ResolverImpl(key, 0 /* ResolverStrategy.instance */, value);
+    },
+    /**
+     * Creates an instance from the class.
+     * Every time you request this {@link Key} you will get the same one back.
+     *
+     * @example
+     * ```
+     * Registration.singleton(Foo, Foo);
+     * ```
+     *
+     * @param key - The key to register the singleton under.
+     * @param value - The class to instantiate as a singleton when first requested.
+     */
+    singleton(key, value) {
+        return new ResolverImpl(key, 1 /* ResolverStrategy.singleton */, value);
+    },
+    /**
+     * Creates an instance from a class.
+     * Every time you request this {@link Key} you will get a new instance.
+     *
+     * @example
+     * ```
+     * Registration.instance(Foo, Foo);
+     * ```
+     *
+     * @param key - The key to register the instance type under.
+     * @param value - The class to instantiate each time the key is requested.
+     */
+    transient(key, value) {
+        return new ResolverImpl(key, 2 /* ResolverStrategy.transient */, value);
+    },
+    /**
+     * Delegates to a callback function to provide the dependency.
+     * Every time you request this {@link Key} the callback will be invoked to provide
+     * the dependency.
+     *
+     * @example
+     * ```
+     * Registration.callback(Foo, () => new Foo());
+     * Registration.callback(Bar, (c: Container) => new Bar(c.get(Foo)));
+     * ```
+     *
+     * @param key - The key to register the callback for.
+     * @param callback - The function that is expected to return the dependency.
+     */
+    callback(key, callback) {
+        return new ResolverImpl(key, 3 /* ResolverStrategy.callback */, callback);
+    },
+    /**
+     * Delegates to a callback function to provide the dependency and then caches the
+     * dependency for future requests.
+     *
+     * @example
+     * ```
+     * Registration.cachedCallback(Foo, () => new Foo());
+     * Registration.cachedCallback(Bar, (c: Container) => new Bar(c.get(Foo)));
+     * ```
+     *
+     * @param key - The key to register the callback for.
+     * @param callback - The function that is expected to return the dependency.
+     * @remarks
+     * If you pass the same Registration to another container, the same cached value will be used.
+     * Should all references to the resolver returned be removed, the cache will expire.
+     */
+    cachedCallback(key, callback) {
+        return new ResolverImpl(key, 3 /* ResolverStrategy.callback */, cacheCallbackResult(callback));
+    },
+    /**
+     * Creates an alternate {@link Key} to retrieve an instance by.
+     *
+     * @example
+     * ```
+     * Register.singleton(Foo, Foo)
+     * Register.aliasTo(Foo, MyFoos);
+     *
+     * container.getAll(MyFoos) // contains an instance of Foo
+     * ```
+     *
+     * @param originalKey - The original key that has been registered.
+     * @param aliasKey - The alias to the original key.
+     */
+    aliasTo(originalKey, aliasKey) {
+        return new ResolverImpl(aliasKey, 5 /* ResolverStrategy.alias */, originalKey);
+    },
+});
+/** @internal */
+export function validateKey(key) {
+    if (key === null || key === void 0) {
+        throw FAST.error(1511 /* Message.invalidKey */);
+    }
+}
+function buildAllResponse(resolver, handler, requestor) {
+    if (resolver instanceof ResolverImpl &&
+        resolver.strategy === 4 /* ResolverStrategy.array */) {
+        const state = resolver.state;
+        let i = state.length;
+        const results = new Array(i);
+        while (i--) {
+            results[i] = state[i].resolve(handler, requestor);
+        }
+        return results;
+    }
+    return [resolver.resolve(handler, requestor)];
+}
+const defaultFriendlyName = "(anonymous)";
+function isObject(value) {
+    return (typeof value === "object" && value !== null) || typeof value === "function";
+}
+/**
+ * Determine whether the value is a native function.
+ *
+ * @param fn - The function to check.
+ * @returns `true` is the function is a native function, otherwise `false`
+ */
+const isNativeFunction = (function () {
+    const lookup = new WeakMap();
+    let isNative = false;
+    let sourceText = "";
+    let i = 0;
+    return function (fn) {
+        isNative = lookup.get(fn);
+        if (isNative === void 0) {
+            sourceText = fn.toString();
+            i = sourceText.length;
+            // http://www.ecma-international.org/ecma-262/#prod-NativeFunction
+            isNative =
+                // 29 is the length of 'function () { [native code] }' which is the smallest length of a native function string
+                i >= 29 &&
+                    // 100 seems to be a safe upper bound of the max length of a native function. In Chrome and FF it's 56, in Edge it's 61.
+                    i <= 100 &&
+                    // This whole heuristic *could* be tricked by a comment. Do we need to care about that?
+                    sourceText.charCodeAt(i - 1) === 0x7d && // }
+                    // TODO: the spec is a little vague about the precise constraints, so we do need to test this across various browsers to make sure just one whitespace is a safe assumption.
+                    sourceText.charCodeAt(i - 2) <= 0x20 && // whitespace
+                    sourceText.charCodeAt(i - 3) === 0x5d && // ]
+                    sourceText.charCodeAt(i - 4) === 0x65 && // e
+                    sourceText.charCodeAt(i - 5) === 0x64 && // d
+                    sourceText.charCodeAt(i - 6) === 0x6f && // o
+                    sourceText.charCodeAt(i - 7) === 0x63 && // c
+                    sourceText.charCodeAt(i - 8) === 0x20 && //
+                    sourceText.charCodeAt(i - 9) === 0x65 && // e
+                    sourceText.charCodeAt(i - 10) === 0x76 && // v
+                    sourceText.charCodeAt(i - 11) === 0x69 && // i
+                    sourceText.charCodeAt(i - 12) === 0x74 && // t
+                    sourceText.charCodeAt(i - 13) === 0x61 && // a
+                    sourceText.charCodeAt(i - 14) === 0x6e && // n
+                    sourceText.charCodeAt(i - 15) === 0x58; // [
+            lookup.set(fn, isNative);
+        }
+        return isNative;
+    };
+})();
+const isNumericLookup = {};
+function isArrayIndex(value) {
+    switch (typeof value) {
+        case "number":
+            return value >= 0 && (value | 0) === value;
+        case "string": {
+            const result = isNumericLookup[value];
+            if (result !== void 0) {
+                return result;
+            }
+            const length = value.length;
+            if (length === 0) {
+                return (isNumericLookup[value] = false);
+            }
+            let ch = 0;
+            for (let i = 0; i < length; ++i) {
+                ch = value.charCodeAt(i);
+                if ((i === 0 && ch === 0x30 && length > 1) /* must not start with 0 */ ||
+                    ch < 0x30 /* 0 */ ||
+                    ch > 0x39 /* 9 */) {
+                    return (isNumericLookup[value] = false);
+                }
+            }
+            return (isNumericLookup[value] = true);
+        }
+        default:
+            return false;
+    }
+}