@loopback/core 4.0.0-alpha.9 → 4.0.2

package/dist/application.js

@@ -0,0 +1,554 @@
+"use strict";
+// Copyright IBM Corp. and LoopBack contributors 2017,2020. All Rights Reserved.
+// Node module: @loopback/core
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Application = void 0;
+const tslib_1 = require("tslib");
+const context_1 = require("@loopback/context");
+const assert_1 = tslib_1.__importDefault(require("assert"));
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const events_1 = require("events");
+const component_1 = require("./component");
+const keys_1 = require("./keys");
+const lifecycle_1 = require("./lifecycle");
+const lifecycle_registry_1 = require("./lifecycle-registry");
+const service_1 = require("./service");
+const debug = (0, debug_1.default)('loopback:core:application');
+const debugShutdown = (0, debug_1.default)('loopback:core:application:shutdown');
+const debugWarning = (0, debug_1.default)('loopback:core:application:warning');
+/**
+ * A helper function to build constructor args for `Context`
+ * @param configOrParent - Application config or parent context
+ * @param parent - Parent context if the first arg is application config
+ */
+function buildConstructorArgs(configOrParent, parent) {
+    let name;
+    let parentCtx;
+    if (configOrParent instanceof context_1.Context) {
+        parentCtx = configOrParent;
+        name = undefined;
+    }
+    else {
+        parentCtx = parent;
+        name = configOrParent === null || configOrParent === void 0 ? void 0 : configOrParent.name;
+    }
+    return [parentCtx, name];
+}
+/**
+ * Application is the container for various types of artifacts, such as
+ * components, servers, controllers, repositories, datasources, connectors,
+ * and models.
+ */
+class Application extends context_1.Context {
+    constructor(configOrParent, parent) {
+        // super() has to be first statement for a constructor
+        super(...buildConstructorArgs(configOrParent, parent));
+        /**
+         * A flag to indicate that the application is being shut down
+         */
+        this._isShuttingDown = false;
+        this._initialized = false;
+        /**
+         * State of the application
+         */
+        this._state = 'created';
+        this.scope = context_1.BindingScope.APPLICATION;
+        this.options =
+            configOrParent instanceof context_1.Context ? {} : configOrParent !== null && configOrParent !== void 0 ? configOrParent : {};
+        // Configure debug
+        this._debug = debug;
+        // Bind the life cycle observer registry
+        this.bind(keys_1.CoreBindings.LIFE_CYCLE_OBSERVER_REGISTRY)
+            .toClass(lifecycle_registry_1.LifeCycleObserverRegistry)
+            .inScope(context_1.BindingScope.SINGLETON);
+        // Bind to self to allow injection of application context in other modules.
+        this.bind(keys_1.CoreBindings.APPLICATION_INSTANCE).to(this);
+        // Make options available to other modules as well.
+        this.bind(keys_1.CoreBindings.APPLICATION_CONFIG).to(this.options);
+        // Also configure the application instance to allow `@config`
+        this.configure(keys_1.CoreBindings.APPLICATION_INSTANCE).toAlias(keys_1.CoreBindings.APPLICATION_CONFIG);
+        this._shutdownOptions = { signals: ['SIGTERM'], ...this.options.shutdown };
+    }
+    /**
+     * Get the state of the application. The initial state is `created` and it can
+     * transition as follows by `start` and `stop`:
+     *
+     * 1. start
+     *   - !started -> starting -> started
+     *   - started -> started (no-op)
+     * 2. stop
+     *   - (started | initialized) -> stopping -> stopped
+     *   - ! (started || initialized) -> stopped (no-op)
+     *
+     * Two types of states are expected:
+     * - stable, such as `started` and `stopped`
+     * - in process, such as `booting` and `starting`
+     *
+     * Operations such as `start` and `stop` can only be called at a stable state.
+     * The logic should immediately set the state to a new one indicating work in
+     * process, such as `starting` and `stopping`.
+     */
+    get state() {
+        return this._state;
+    }
+    /**
+     * Register a controller class with this application.
+     *
+     * @param controllerCtor - The controller class
+     * (constructor function).
+     * @param name - Optional controller name, default to the class name
+     * @returns The newly created binding, you can use the reference to
+     * further modify the binding, e.g. lock the value to prevent further
+     * modifications.
+     *
+     * @example
+     * ```ts
+     * class MyController {
+     * }
+     * app.controller(MyController).lock();
+     * ```
+     */
+    controller(controllerCtor, nameOrOptions) {
+        this.debug('Adding controller %s', nameOrOptions !== null && nameOrOptions !== void 0 ? nameOrOptions : controllerCtor.name);
+        const binding = (0, context_1.createBindingFromClass)(controllerCtor, {
+            namespace: keys_1.CoreBindings.CONTROLLERS,
+            type: keys_1.CoreTags.CONTROLLER,
+            defaultScope: context_1.BindingScope.TRANSIENT,
+            ...toOptions(nameOrOptions),
+        });
+        this.add(binding);
+        return binding;
+    }
+    /**
+     * Bind a Server constructor to the Application's master context.
+     * Each server constructor added in this way must provide a unique prefix
+     * to prevent binding overlap.
+     *
+     * @example
+     * ```ts
+     * app.server(RestServer);
+     * // This server constructor will be bound under "servers.RestServer".
+     * app.server(RestServer, "v1API");
+     * // This server instance will be bound under "servers.v1API".
+     * ```
+     *
+     * @param server - The server constructor.
+     * @param nameOrOptions - Optional override for name or options.
+     * @returns Binding for the server class
+     *
+     */
+    server(ctor, nameOrOptions) {
+        this.debug('Adding server %s', nameOrOptions !== null && nameOrOptions !== void 0 ? nameOrOptions : ctor.name);
+        const binding = (0, context_1.createBindingFromClass)(ctor, {
+            namespace: keys_1.CoreBindings.SERVERS,
+            type: keys_1.CoreTags.SERVER,
+            defaultScope: context_1.BindingScope.SINGLETON,
+            ...toOptions(nameOrOptions),
+        }).apply(lifecycle_1.asLifeCycleObserver);
+        this.add(binding);
+        return binding;
+    }
+    /**
+     * Bind an array of Server constructors to the Application's master
+     * context.
+     * Each server added in this way will automatically be named based on the
+     * class constructor name with the "servers." prefix.
+     *
+     * @remarks
+     * If you wish to control the binding keys for particular server instances,
+     * use the app.server function instead.
+     * ```ts
+     * app.servers([
+     *  RestServer,
+     *  GRPCServer,
+     * ]);
+     * // Creates a binding for "servers.RestServer" and a binding for
+     * // "servers.GRPCServer";
+     * ```
+     *
+     * @param ctors - An array of Server constructors.
+     * @returns An array of bindings for the registered server classes
+     *
+     */
+    servers(ctors) {
+        return ctors.map(ctor => this.server(ctor));
+    }
+    /**
+     * Retrieve the singleton instance for a bound server.
+     *
+     * @typeParam T - Server type
+     * @param ctor - The constructor that was used to make the
+     * binding.
+     * @returns A Promise of server instance
+     *
+     */
+    async getServer(target) {
+        let key;
+        // instanceof check not reliable for string.
+        if (typeof target === 'string') {
+            key = `${keys_1.CoreBindings.SERVERS}.${target}`;
+        }
+        else {
+            const ctor = target;
+            key = `${keys_1.CoreBindings.SERVERS}.${ctor.name}`;
+        }
+        return this.get(key);
+    }
+    /**
+     * Assert there is no other operation is in progress, i.e., the state is not
+     * `*ing`, such as `starting` or `stopping`.
+     *
+     * @param op - The operation name, such as 'boot', 'start', or 'stop'
+     */
+    assertNotInProcess(op) {
+        (0, assert_1.default)(!this._state.endsWith('ing'), `Cannot ${op} the application as it is ${this._state}.`);
+    }
+    /**
+     * Assert current state of the application to be one of the expected values
+     * @param op - The operation name, such as 'boot', 'start', or 'stop'
+     * @param states - Valid states
+     */
+    assertInStates(op, ...states) {
+        (0, assert_1.default)(states.includes(this._state), `Cannot ${op} the application as it is ${this._state}. Valid states are ${states}.`);
+    }
+    /**
+     * Transition the application to a new state and emit an event
+     * @param state - The new state
+     */
+    setState(state) {
+        const oldState = this._state;
+        this._state = state;
+        if (oldState !== state) {
+            this.emit('stateChanged', { from: oldState, to: this._state });
+            this.emit(state);
+        }
+    }
+    async awaitState(state) {
+        await (0, events_1.once)(this, state);
+    }
+    /**
+     * Initialize the application, and all of its registered observers. The
+     * application state is checked to ensure the integrity of `initialize`.
+     *
+     * If the application is already initialized, no operation is performed.
+     *
+     * This method is automatically invoked by `start()` if the application is not
+     * initialized.
+     */
+    async init() {
+        if (this._initialized)
+            return;
+        if (this._state === 'initializing')
+            return this.awaitState('initialized');
+        this.assertNotInProcess('initialize');
+        this.setState('initializing');
+        const registry = await this.getLifeCycleObserverRegistry();
+        await registry.init();
+        this._initialized = true;
+        this.setState('initialized');
+    }
+    /**
+     * Register a function to be called when the application initializes.
+     *
+     * This is a shortcut for adding a binding for a LifeCycleObserver
+     * implementing a `init()` method.
+     *
+     * @param fn The function to invoke, it can be synchronous (returning `void`)
+     * or asynchronous (returning `Promise<void>`).
+     * @returns The LifeCycleObserver binding created.
+     */
+    onInit(fn) {
+        const key = [
+            keys_1.CoreBindings.LIFE_CYCLE_OBSERVERS,
+            fn.name || '<onInit>',
+            (0, context_1.generateUniqueId)(),
+        ].join('.');
+        return this.bind(key)
+            .to({ init: fn })
+            .apply(lifecycle_1.asLifeCycleObserver);
+    }
+    /**
+     * Start the application, and all of its registered observers. The application
+     * state is checked to ensure the integrity of `start`.
+     *
+     * If the application is not initialized, it calls first `init()` to
+     * initialize the application. This only happens if `start()` is called for
+     * the first time.
+     *
+     * If the application is already started, no operation is performed.
+     */
+    async start() {
+        if (!this._initialized)
+            await this.init();
+        if (this._state === 'starting')
+            return this.awaitState('started');
+        this.assertNotInProcess('start');
+        // No-op if it's started
+        if (this._state === 'started')
+            return;
+        this.setState('starting');
+        this.setupShutdown();
+        const registry = await this.getLifeCycleObserverRegistry();
+        await registry.start();
+        this.setState('started');
+    }
+    /**
+     * Register a function to be called when the application starts.
+     *
+     * This is a shortcut for adding a binding for a LifeCycleObserver
+     * implementing a `start()` method.
+     *
+     * @param fn The function to invoke, it can be synchronous (returning `void`)
+     * or asynchronous (returning `Promise<void>`).
+     * @returns The LifeCycleObserver binding created.
+     */
+    onStart(fn) {
+        const key = [
+            keys_1.CoreBindings.LIFE_CYCLE_OBSERVERS,
+            fn.name || '<onStart>',
+            (0, context_1.generateUniqueId)(),
+        ].join('.');
+        return this.bind(key)
+            .to({ start: fn })
+            .apply(lifecycle_1.asLifeCycleObserver);
+    }
+    /**
+     * Stop the application instance and all of its registered observers. The
+     * application state is checked to ensure the integrity of `stop`.
+     *
+     * If the application is already stopped or not started, no operation is
+     * performed.
+     */
+    async stop() {
+        if (this._state === 'stopping')
+            return this.awaitState('stopped');
+        this.assertNotInProcess('stop');
+        // No-op if it's created or stopped
+        if (this._state !== 'started' && this._state !== 'initialized')
+            return;
+        this.setState('stopping');
+        if (!this._isShuttingDown) {
+            // Explicit stop is called, let's remove signal listeners to avoid
+            // memory leak and max listener warning
+            this.removeSignalListener();
+        }
+        const registry = await this.getLifeCycleObserverRegistry();
+        await registry.stop();
+        this.setState('stopped');
+    }
+    /**
+     * Register a function to be called when the application starts.
+     *
+     * This is a shortcut for adding a binding for a LifeCycleObserver
+     * implementing a `start()` method.
+     *
+     * @param fn The function to invoke, it can be synchronous (returning `void`)
+     * or asynchronous (returning `Promise<void>`).
+     * @returns The LifeCycleObserver binding created.
+     */
+    onStop(fn) {
+        const key = [
+            keys_1.CoreBindings.LIFE_CYCLE_OBSERVERS,
+            fn.name || '<onStop>',
+            (0, context_1.generateUniqueId)(),
+        ].join('.');
+        return this.bind(key)
+            .to({ stop: fn })
+            .apply(lifecycle_1.asLifeCycleObserver);
+    }
+    async getLifeCycleObserverRegistry() {
+        return this.get(keys_1.CoreBindings.LIFE_CYCLE_OBSERVER_REGISTRY);
+    }
+    /**
+     * Add a component to this application and register extensions such as
+     * controllers, providers, and servers from the component.
+     *
+     * @param componentCtor - The component class to add.
+     * @param nameOrOptions - Optional component name or options, default to the
+     * class name
+     *
+     * @example
+     * ```ts
+     *
+     * export class ProductComponent {
+     *   controllers = [ProductController];
+     *   repositories = [ProductRepo, UserRepo];
+     *   providers = {
+     *     [AUTHENTICATION_STRATEGY]: AuthStrategy,
+     *     [AUTHORIZATION_ROLE]: Role,
+     *   };
+     * };
+     *
+     * app.component(ProductComponent);
+     * ```
+     */
+    component(componentCtor, nameOrOptions) {
+        this.debug('Adding component: %s', nameOrOptions !== null && nameOrOptions !== void 0 ? nameOrOptions : componentCtor.name);
+        const binding = (0, context_1.createBindingFromClass)(componentCtor, {
+            namespace: keys_1.CoreBindings.COMPONENTS,
+            type: keys_1.CoreTags.COMPONENT,
+            defaultScope: context_1.BindingScope.SINGLETON,
+            ...toOptions(nameOrOptions),
+        });
+        if ((0, lifecycle_1.isLifeCycleObserverClass)(componentCtor)) {
+            binding.apply(lifecycle_1.asLifeCycleObserver);
+        }
+        this.add(binding);
+        // Assuming components can be synchronously instantiated
+        const instance = this.getSync(binding.key);
+        (0, component_1.mountComponent)(this, instance);
+        return binding;
+    }
+    /**
+     * Set application metadata. `@loopback/boot` calls this method to populate
+     * the metadata from `package.json`.
+     *
+     * @param metadata - Application metadata
+     */
+    setMetadata(metadata) {
+        this.bind(keys_1.CoreBindings.APPLICATION_METADATA).to(metadata);
+    }
+    /**
+     * Register a life cycle observer class
+     * @param ctor - A class implements LifeCycleObserver
+     * @param nameOrOptions - Optional name or options for the life cycle observer
+     */
+    lifeCycleObserver(ctor, nameOrOptions) {
+        this.debug('Adding life cycle observer %s', nameOrOptions !== null && nameOrOptions !== void 0 ? nameOrOptions : ctor.name);
+        const binding = (0, context_1.createBindingFromClass)(ctor, {
+            namespace: keys_1.CoreBindings.LIFE_CYCLE_OBSERVERS,
+            type: keys_1.CoreTags.LIFE_CYCLE_OBSERVER,
+            defaultScope: context_1.BindingScope.SINGLETON,
+            ...toOptions(nameOrOptions),
+        }).apply(lifecycle_1.asLifeCycleObserver);
+        this.add(binding);
+        return binding;
+    }
+    /**
+     * Add a service to this application.
+     *
+     * @param cls - The service or provider class
+     *
+     * @example
+     *
+     * ```ts
+     * // Define a class to be bound via ctx.toClass()
+     * @injectable({scope: BindingScope.SINGLETON})
+     * export class LogService {
+     *   log(msg: string) {
+     *     console.log(msg);
+     *   }
+     * }
+     *
+     * // Define a class to be bound via ctx.toProvider()
+     * import {v4 as uuidv4} from 'uuid';
+     * export class UuidProvider implements Provider<string> {
+     *   value() {
+     *     return uuidv4();
+     *   }
+     * }
+     *
+     * // Register the local services
+     * app.service(LogService);
+     * app.service(UuidProvider, 'uuid');
+     *
+     * export class MyController {
+     *   constructor(
+     *     @inject('services.uuid') private uuid: string,
+     *     @inject('services.LogService') private log: LogService,
+     *   ) {
+     *   }
+     *
+     *   greet(name: string) {
+     *     this.log(`Greet request ${this.uuid} received: ${name}`);
+     *     return `${this.uuid}: ${name}`;
+     *   }
+     * }
+     * ```
+     */
+    service(cls, nameOrOptions) {
+        const options = toOptions(nameOrOptions);
+        const binding = (0, service_1.createServiceBinding)(cls, options);
+        this.add(binding);
+        return binding;
+    }
+    /**
+     * Register an interceptor
+     * @param interceptor - An interceptor function or provider class
+     * @param nameOrOptions - Binding name or options
+     */
+    interceptor(interceptor, nameOrOptions) {
+        const options = toOptions(nameOrOptions);
+        return (0, context_1.registerInterceptor)(this, interceptor, options);
+    }
+    /**
+     * Set up signals that are captured to shutdown the application
+     */
+    setupShutdown() {
+        if (this._signalListener != null) {
+            this.registerSignalListener();
+            return this._signalListener;
+        }
+        const gracePeriod = this._shutdownOptions.gracePeriod;
+        this._signalListener = async (signal) => {
+            const kill = () => {
+                this.removeSignalListener();
+                process.kill(process.pid, signal);
+            };
+            debugShutdown('[%s] Signal %s received for process %d', this.name, signal, process.pid);
+            if (!this._isShuttingDown) {
+                this._isShuttingDown = true;
+                let timer;
+                if (typeof gracePeriod === 'number' && !isNaN(gracePeriod)) {
+                    timer = setTimeout(kill, gracePeriod);
+                }
+                try {
+                    await this.stop();
+                }
+                finally {
+                    if (timer != null)
+                        clearTimeout(timer);
+                    kill();
+                }
+            }
+        };
+        this.registerSignalListener();
+        return this._signalListener;
+    }
+    registerSignalListener() {
+        const { signals = [] } = this._shutdownOptions;
+        debugShutdown('[%s] Registering signal listeners on the process %d', this.name, process.pid, signals);
+        signals.forEach(sig => {
+            if (process.getMaxListeners() <= process.listenerCount(sig)) {
+                if (debugWarning.enabled) {
+                    debugWarning('[%s] %d %s listeners are added to process %d', this.name, process.listenerCount(sig), sig, process.pid, new Error('MaxListenersExceededWarning'));
+                }
+            }
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            process.on(sig, this._signalListener);
+        });
+    }
+    removeSignalListener() {
+        if (this._signalListener == null)
+            return;
+        const { signals = [] } = this._shutdownOptions;
+        debugShutdown('[%s] Removing signal listeners on the process %d', this.name, process.pid, signals);
+        signals.forEach(sig => 
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        process.removeListener(sig, this._signalListener));
+    }
+}
+exports.Application = Application;
+/**
+ * Normalize name or options to `BindingFromClassOptions`
+ * @param nameOrOptions - Name or options for binding from class
+ */
+function toOptions(nameOrOptions) {
+    if (typeof nameOrOptions === 'string') {
+        return { name: nameOrOptions };
+    }
+    return nameOrOptions !== null && nameOrOptions !== void 0 ? nameOrOptions : {};
+}
+//# sourceMappingURL=application.js.map

package/dist/application.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../src/application.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAe2B;AAC3B,4DAA4B;AAC5B,0DAAiC;AACjC,mCAA4B;AAC5B,2CAAsD;AACtD,iCAA8C;AAC9C,2CAIqB;AACrB,6DAA+D;AAE/D,uCAA+D;AAC/D,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,2BAA2B,CAAC,CAAC;AACxD,MAAM,aAAa,GAAG,IAAA,eAAY,EAAC,oCAAoC,CAAC,CAAC;AACzE,MAAM,YAAY,GAAG,IAAA,eAAY,EAAC,mCAAmC,CAAC,CAAC;AAEvE;;;;GAIG;AACH,SAAS,oBAAoB,CAC3B,cAA4C,EAC5C,MAAgB;IAEhB,IAAI,IAAwB,CAAC;IAC7B,IAAI,SAA8B,CAAC;IAEnC,IAAI,cAAc,YAAY,iBAAO,EAAE;QACrC,SAAS,GAAG,cAAc,CAAC;QAC3B,IAAI,GAAG,SAAS,CAAC;KAClB;SAAM;QACL,SAAS,GAAG,MAAM,CAAC;QACnB,IAAI,GAAG,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,IAAI,CAAC;KAC7B;IACD,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAa,WAAY,SAAQ,iBAAO;IAoDtC,YAAY,cAA4C,EAAE,MAAgB;QACxE,sDAAsD;QACtD,KAAK,CAAC,GAAG,oBAAoB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;QAnDzD;;WAEG;QACK,oBAAe,GAAG,KAAK,CAAC;QAIxB,iBAAY,GAAG,KAAK,CAAC;QAE7B;;WAEG;QACK,WAAM,GAAG,SAAS,CAAC;QAwCzB,IAAI,CAAC,KAAK,GAAG,sBAAY,CAAC,WAAW,CAAC;QAEtC,IAAI,CAAC,OAAO;YACV,cAAc,YAAY,iBAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,CAAC;QAEhE,kBAAkB;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEpB,wCAAwC;QACxC,IAAI,CAAC,IAAI,CAAC,mBAAY,CAAC,4BAA4B,CAAC;aACjD,OAAO,CAAC,8CAAyB,CAAC;aAClC,OAAO,CAAC,sBAAY,CAAC,SAAS,CAAC,CAAC;QACnC,2EAA2E;QAC3E,IAAI,CAAC,IAAI,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACtD,mDAAmD;QACnD,IAAI,CAAC,IAAI,CAAC,mBAAY,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5D,6DAA6D;QAC7D,IAAI,CAAC,SAAS,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAC,OAAO,CACvD,mBAAY,CAAC,kBAAkB,CAChC,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,EAAC,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAC,CAAC;IAC3E,CAAC;IA7DD;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IA0CD;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,cAAkC,EAClC,aAAgD;QAEhD,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,IAAA,gCAAsB,EAAC,cAAc,EAAE;YACrD,SAAS,EAAE,mBAAY,CAAC,WAAW;YACnC,IAAI,EAAE,eAAQ,CAAC,UAAU;YACzB,YAAY,EAAE,sBAAY,CAAC,SAAS;YACpC,GAAG,SAAS,CAAC,aAAa,CAAC;SAC5B,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,MAAM,CACX,IAAoB,EACpB,aAAgD;QAEhD,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAG,IAAA,gCAAsB,EAAC,IAAI,EAAE;YAC3C,SAAS,EAAE,mBAAY,CAAC,OAAO;YAC/B,IAAI,EAAE,eAAQ,CAAC,MAAM;YACrB,YAAY,EAAE,sBAAY,CAAC,SAAS;YACpC,GAAG,SAAS,CAAC,aAAa,CAAC;SAC5B,CAAC,CAAC,KAAK,CAAC,+BAAmB,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,OAAO,CAAmB,KAAuB;QACtD,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,SAAS,CACpB,MAA+B;QAE/B,IAAI,GAAW,CAAC;QAChB,4CAA4C;QAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,GAAG,GAAG,GAAG,mBAAY,CAAC,OAAO,IAAI,MAAM,EAAE,CAAC;SAC3C;aAAM;YACL,MAAM,IAAI,GAAG,MAAwB,CAAC;YACtC,GAAG,GAAG,GAAG,mBAAY,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,GAAG,CAAI,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACO,kBAAkB,CAAC,EAAU;QACrC,IAAA,gBAAM,EACJ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC5B,UAAU,EAAE,6BAA6B,IAAI,CAAC,MAAM,GAAG,CACxD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,cAAc,CAAC,EAAU,EAAE,GAAG,MAAgB;QACtD,IAAA,gBAAM,EACJ,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAC5B,UAAU,EAAE,6BAA6B,IAAI,CAAC,MAAM,sBAAsB,MAAM,GAAG,CACpF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,QAAQ,CAAC,KAAa;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,QAAQ,KAAK,KAAK,EAAE;YACtB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,EAAC,CAAC,CAAC;YAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAClB;IACH,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,KAAa;QACtC,MAAM,IAAA,aAAI,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,YAAY;YAAE,OAAO;QAC9B,IAAI,IAAI,CAAC,MAAM,KAAK,cAAc;YAAE,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC1E,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;QAC3D,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,EAA8B;QAC1C,MAAM,GAAG,GAAG;YACV,mBAAY,CAAC,oBAAoB;YACjC,EAAE,CAAC,IAAI,IAAI,UAAU;YACrB,IAAA,0BAAgB,GAAE;SACnB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEZ,OAAO,IAAI,CAAC,IAAI,CAAoB,GAAG,CAAC;aACrC,EAAE,CAAC,EAAC,IAAI,EAAE,EAAE,EAAC,CAAC;aACd,KAAK,CAAC,+BAAmB,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU;YAAE,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACjC,wBAAwB;QACxB,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAAE,OAAO;QACtC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1B,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;QAC3D,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACI,OAAO,CAAC,EAA8B;QAC3C,MAAM,GAAG,GAAG;YACV,mBAAY,CAAC,oBAAoB;YACjC,EAAE,CAAC,IAAI,IAAI,WAAW;YACtB,IAAA,0BAAgB,GAAE;SACnB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEZ,OAAO,IAAI,CAAC,IAAI,CAAoB,GAAG,CAAC;aACrC,EAAE,CAAC,EAAC,KAAK,EAAE,EAAE,EAAC,CAAC;aACf,KAAK,CAAC,+BAAmB,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU;YAAE,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAChC,mCAAmC;QACnC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,aAAa;YAAE,OAAO;QACvE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,kEAAkE;YAClE,uCAAuC;YACvC,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAC7B;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,4BAA4B,EAAE,CAAC;QAC3D,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,EAA8B;QAC1C,MAAM,GAAG,GAAG;YACV,mBAAY,CAAC,oBAAoB;YACjC,EAAE,CAAC,IAAI,IAAI,UAAU;YACrB,IAAA,0BAAgB,GAAE;SACnB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACZ,OAAO,IAAI,CAAC,IAAI,CAAoB,GAAG,CAAC;aACrC,EAAE,CAAC,EAAC,IAAI,EAAE,EAAE,EAAC,CAAC;aACd,KAAK,CAAC,+BAAmB,CAAC,CAAC;IAChC,CAAC;IAEO,KAAK,CAAC,4BAA4B;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAY,CAAC,4BAA4B,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,SAAS,CACd,aAA6B,EAC7B,aAAgD;QAEhD,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,OAAO,GAAG,IAAA,gCAAsB,EAAC,aAAa,EAAE;YACpD,SAAS,EAAE,mBAAY,CAAC,UAAU;YAClC,IAAI,EAAE,eAAQ,CAAC,SAAS;YACxB,YAAY,EAAE,sBAAY,CAAC,SAAS;YACpC,GAAG,SAAS,CAAC,aAAa,CAAC;SAC5B,CAAC,CAAC;QACH,IAAI,IAAA,oCAAwB,EAAC,aAAa,CAAC,EAAE;YAC3C,OAAO,CAAC,KAAK,CAAC,+BAAmB,CAAC,CAAC;SACpC;QACD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,wDAAwD;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAY,OAAO,CAAC,GAAG,CAAC,CAAC;QACtD,IAAA,0BAAc,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,QAA6B;QAC9C,IAAI,CAAC,IAAI,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CACtB,IAAoB,EACpB,aAAgD;QAEhD,IAAI,CAAC,KAAK,CAAC,+BAA+B,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,OAAO,GAAG,IAAA,gCAAsB,EAAC,IAAI,EAAE;YAC3C,SAAS,EAAE,mBAAY,CAAC,oBAAoB;YAC5C,IAAI,EAAE,eAAQ,CAAC,mBAAmB;YAClC,YAAY,EAAE,sBAAY,CAAC,SAAS;YACpC,GAAG,SAAS,CAAC,aAAa,CAAC;SAC5B,CAAC,CAAC,KAAK,CAAC,+BAAmB,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACI,OAAO,CACZ,GAA8B,EAC9B,aAAuC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,IAAA,8BAAoB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,WAAW,CAChB,WAA6D,EAC7D,aAAkD;QAElD,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QACzC,OAAO,IAAA,6BAAmB,EAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACO,aAAa;QACrB,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,EAAE;YAChC,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,eAAe,CAAC;SAC7B;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC;QACtD,IAAI,CAAC,eAAe,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,GAAG,EAAE;gBAChB,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACpC,CAAC,CAAC;YACF,aAAa,CACX,wCAAwC,EACxC,IAAI,CAAC,IAAI,EACT,MAAM,EACN,OAAO,CAAC,GAAG,CACZ,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACzB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;gBAC5B,IAAI,KAAK,CAAC;gBACV,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;oBAC1D,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;iBACvC;gBACD,IAAI;oBACF,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;iBACnB;wBAAS;oBACR,IAAI,KAAK,IAAI,IAAI;wBAAE,YAAY,CAAC,KAAK,CAAC,CAAC;oBACvC,IAAI,EAAE,CAAC;iBACR;aACF;QACH,CAAC,CAAC;QACF,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAEO,sBAAsB;QAC5B,MAAM,EAAC,OAAO,GAAG,EAAE,EAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC7C,aAAa,CACX,qDAAqD,EACrD,IAAI,CAAC,IAAI,EACT,OAAO,CAAC,GAAG,EACX,OAAO,CACR,CAAC;QACF,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACpB,IAAI,OAAO,CAAC,eAAe,EAAE,IAAI,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;gBAC3D,IAAI,YAAY,CAAC,OAAO,EAAE;oBACxB,YAAY,CACV,8CAA8C,EAC9C,IAAI,CAAC,IAAI,EACT,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,EAC1B,GAAG,EACH,OAAO,CAAC,GAAG,EACX,IAAI,KAAK,CAAC,6BAA6B,CAAC,CACzC,CAAC;iBACH;aACF;YACD,kEAAkE;YAClE,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,OAAO;QACzC,MAAM,EAAC,OAAO,GAAG,EAAE,EAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC7C,aAAa,CACX,kDAAkD,EAClD,IAAI,CAAC,IAAI,EACT,OAAO,CAAC,GAAG,EACX,OAAO,CACR,CAAC;QACF,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACpB,kEAAkE;QAClE,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAClD,CAAC;IACJ,CAAC;CACF;AA9kBD,kCA8kBC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,aAAgD;IACjE,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;QACrC,OAAO,EAAC,IAAI,EAAE,aAAa,EAAC,CAAC;KAC9B;IACD,OAAO,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAC;AAC7B,CAAC"}

package/dist/component.d.ts

@@ -0,0 +1,80 @@
+import { Binding, BoundValue, Constructor, Provider } from '@loopback/context';
+import { Application, ControllerClass, ServiceOrProviderClass } from './application';
+import { LifeCycleObserver } from './lifecycle';
+import { Server } from './server';
+/**
+ * A map of provider classes to be bound to a context
+ */
+export interface ProviderMap {
+    [key: string]: Constructor<Provider<BoundValue>>;
+}
+/**
+ * A map of classes to be bound to a context
+ */
+export interface ClassMap {
+    [key: string]: Constructor<BoundValue>;
+}
+/**
+ * A component declares a set of artifacts so that they can be contributed to
+ * an application as a group
+ */
+export interface Component {
+    /**
+     * An array of controller classes
+     */
+    controllers?: ControllerClass[];
+    /**
+     * A map of providers to be bound to the application context
+     *
+     * @example
+     * ```ts
+     * {
+     *   'authentication.strategies.ldap': LdapStrategyProvider
+     * }
+     * ```
+     */
+    providers?: ProviderMap;
+    /**
+     * A map of classes to be bound to the application context.
+     *
+     * @example
+     * ```ts
+     * {
+     *   'rest.body-parsers.xml': XmlBodyParser
+     * }
+     * ```
+     */
+    classes?: ClassMap;
+    /**
+     * A map of name/class pairs for servers
+     */
+    servers?: {
+        [name: string]: Constructor<Server>;
+    };
+    lifeCycleObservers?: Constructor<LifeCycleObserver>[];
+    /**
+     * An array of service or provider classes
+     */
+    services?: ServiceOrProviderClass[];
+    /**
+     * An array of bindings to be aded to the application context.
+     *
+     * @example
+     * ```ts
+     * const bindingX = Binding.bind('x').to('Value X');
+     * this.bindings = [bindingX]
+     * ```
+     */
+    bindings?: Binding[];
+    /**
+     * Other properties
+     */
+    [prop: string]: any;
+}
+/**
+ * Mount a component to an Application.
+ *
+ * @param app - Application
+ * @param component - Component instance
+ */
+export declare function mountComponent(app: Application, component: Component): void;