@finsemble/finsemble-ui 7.3.9 → 7.3.10

package/deprecated/baseClient.js

@@ -0,0 +1,124 @@
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+import { RouterClient } from "../clients/routerClient";
+import { Logger } from "../clients/logger";
+import { System } from "../common/system";
+import { FSBLDependencyManagerSingleton as FSBLDependencyManager } from "../common/dependencyManager";
+/**
+ * <h2>Base Client</h2>
+ * The Base Client is inherited by every client to provide common functionality to the clients. Once all dependencies are met, either client or service, the client's `onReady` method is fired.
+ *
+ * We're currently halfway through migrating our clients from extending a normal function prototype to an ES6 class.
+ * "_BaseClient" represents the new class, while "BaseClient" is the original function. When the migration is complete,
+ * we will remove the old function and rename "_BaseClient" to "BaseClient".
+
+ * @param {Object} params
+ * @param {Function} params.onReady - A function to be called after the client has initialized.
+ * @param {String} params.name - The name of the client
+    @example
+    import { _BaseClient as BaseClient } from "./baseClient";
+    var NewClient = function (params) {
+        BaseClient.call(this, params);
+        var self = this;
+
+        return this;
+    };
+
+    var clientInstance = new NewClient({
+        onReady: function (cb) {
+            Logger.system.log("NewClient Online");
+            cb();
+        },
+        name:"NewClient"
+    });
+    clientInstance.initialize();
+    module.exports = clientInstance;
+    @private
+ */
+export class _BaseClient {
+    constructor(params) {
+        /** The callback called when this service is ready. */
+        this.onReadyCallback = (cb) => {
+            cb();
+        };
+        // Flag is reset when the client is ready.
+        this.isReady = false;
+        this.startupDependencies = {
+            services: [],
+            clients: [],
+        };
+        /** Queue of functions registered via calls to `onReady()`, invoked once the client goes online. */
+        this.clientReadyQueue = [];
+        /** Gets the current window name. */
+        this.windowName = "";
+        /**
+         * @private
+         */
+        this.processClientReadyQueue = () => {
+            for (const cb of this.clientReadyQueue) {
+                cb();
+            }
+            this.clientReadyQueue = [];
+        };
+        /**
+         * @private
+         */
+        this.onReady = (cb) => {
+            if (this.isReady)
+                cb();
+            else
+                this.clientReadyQueue.push(cb);
+        };
+        /** Check to see if the client can come online. We check this against the required services and clients */
+        /**
+         * @private
+         *
+         */
+        this.setClientOnline = () => {
+            var _a;
+            this.isReady = true;
+            const onReadyMessage = `STARTUP:CLIENT:ONLINE:${(_a = this.finWindow) === null || _a === void 0 ? void 0 : _a.name}:${this.name}`;
+            this.logger.system.log(onReadyMessage);
+            const readyCB = () => {
+                this.logger.system.debug(onReadyMessage);
+                FSBLDependencyManager.setClientOnline(this.name);
+                this.processClientReadyQueue();
+            };
+            this.onReadyCallback(readyCB);
+        };
+        /**
+         * @private
+         */
+        this.initialize = (cb) => {
+            var _a;
+            this.logger.system.log("baseClient initialize", this.name);
+            this.finWindow = System.Window.getCurrent();
+            this.windowName = (_a = this.finWindow) === null || _a === void 0 ? void 0 : _a.name;
+            this.logger.system.debug("baseClient Init Router Ready", this.name, "DEPENDENCIES", this.startupDependencies);
+            FSBLDependencyManager.startup.waitFor(this.startupDependencies, () => {
+                this.logger.system.log("baseClient initialize waitfor done", this.name);
+                cb === null || cb === void 0 ? void 0 : cb();
+                this.setClientOnline();
+            }, `${this.windowName}(${this.name})`);
+        };
+        Logger.system.deprecated("BaseClient has been deprecated. There is no longer a need to create dependencies on Finsemble's built-in clients.");
+        this.name = params.name;
+        if (params.onReady)
+            this.onReadyCallback = params.onReady;
+        this.startupDependencies = params.startupDependencies || {
+            services: [],
+            clients: [],
+        };
+        this.logger = Logger;
+        this.routerClient = RouterClient;
+    }
+    /**
+     * @private
+     */
+    onClose(cb) {
+        cb === null || cb === void 0 ? void 0 : cb();
+    }
+}
+//# sourceMappingURL=baseClient.js.map

package/deprecated/baseClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseClient.js","sourceRoot":"","sources":["../../../src/deprecated/baseClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAkB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,8BAA8B,IAAI,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAYtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,OAAO,WAAW;IA8BvB,YAAY,MAAwB;QA7BpC,sDAAsD;QAC9C,oBAAe,GAA6B,CAAC,EAAc,EAAE,EAAE;YACtE,EAAE,EAAE,CAAC;QACN,CAAC,CAAC;QAEF,0CAA0C;QAClC,YAAO,GAAY,KAAK,CAAC;QAEzB,wBAAmB,GAAgD;YAC1E,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,EAAE;SACX,CAAC;QAEF,mGAAmG;QAC3F,qBAAgB,GAAmB,EAAE,CAAC;QAO9C,oCAAoC;QACpC,eAAU,GAAW,EAAE,CAAC;QAqBxB;;WAEG;QACH,4BAAuB,GAAG,GAAG,EAAE;YAC9B,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACvC,EAAE,EAAE,CAAC;aACL;YACD,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC5B,CAAC,CAAC;QAEF;;WAEG;QACH,YAAO,GAAG,CAAC,EAAc,EAAE,EAAE;YAC5B,IAAI,IAAI,CAAC,OAAO;gBAAE,EAAE,EAAE,CAAC;;gBAClB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrC,CAAC,CAAC;QAEF,0GAA0G;QAC1G;;;WAGG;QACH,oBAAe,GAAG,GAAG,EAAE;;YACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,MAAM,cAAc,GAAG,yBAAyB,MAAA,IAAI,CAAC,SAAS,0CAAE,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACpF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YACvC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACpB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;gBACzC,qBAAqB,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjD,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAChC,CAAC,CAAC;YACF,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF;;WAEG;QACH,eAAU,GAAG,CAAC,EAAe,EAAE,EAAE;;YAChC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAE3D,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC5C,IAAI,CAAC,UAAU,GAAG,MAAA,IAAI,CAAC,SAAS,0CAAE,IAAI,CAAC;YACvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;YAC9G,qBAAqB,CAAC,OAAO,CAAC,OAAO,CACpC,IAAI,CAAC,mBAAmB,EACxB,GAAG,EAAE;gBACJ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBACxE,EAAE,aAAF,EAAE,uBAAF,EAAE,EAAI,CAAC;gBACP,IAAI,CAAC,eAAe,EAAE,CAAC;YACxB,CAAC,EACD,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,GAAG,CAClC,CAAC;QACH,CAAC,CAAC;QAlED,MAAM,CAAC,MAAM,CAAC,UAAU,CACvB,mHAAmH,CACnH,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,MAAM,CAAC,OAAO;YAAE,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC;QAC1D,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,IAAI;YACxD,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,EAAE;SACX,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IAClC,CAAC;IAyDD;;OAEG;IACH,OAAO,CAAC,EAAe;QACtB,EAAE,aAAF,EAAE,uBAAF,EAAE,EAAI,CAAC;IACR,CAAC;CACD"}

package/deprecated/deprecatedFunctions.d.ts

@@ -0,0 +1,45 @@
+/**
+ * This file serves as a temporary holding area for deprecated functions.
+ * Once a deprecated function is removed from the public API then it can
+ * be either deleted from this file or moved to a permanent location.
+ */
+import { IRouterClient } from "../clients/routerClient";
+import { FinsembleWindow } from "../common/FinsembleWindow";
+/**
+ * Gets all active or pending window names. Active windows have completed spawning.  Pending windows have been spawned but haven't yet completed.
+ *
+ * @param {StandardCallback} cb Callback returns an array of window names (as does the resolved Promise).
+ * @private
+ */
+export declare const deprecatedGetActiveAndPendingWindowNames: (routerClient: IRouterClient, cb?: Function) => Promise<{
+    err: any;
+    data: any;
+}>;
+/**
+ * Highlights the window as active by creating a border around the window.
+ *
+ * @param {boolean} active  Set to false to turn off activity
+ * @private
+ */
+export declare const deprecatedSetActive: (active: boolean) => void;
+/**
+ * Gets the window name of current window or the parent, if tabbed. The code that manages window movement will not see a child window if it's part of a stacked window. This function will return the window name that the Window Service cares about for window movement.
+ */
+export declare const deprecatedGetWindowNameForDocking: (finsembleWindow: FinsembleWindow) => string;
+/** Daniel H. 1/14/2019
+ * This method is only used in the DragAndDrop client, and it introduces a sneaky circular dependency between
+ * this module and the launcherClient. It should be refactored out of this module. This can't be done until v4.0.0, as
+ * it would be a breaking change to our API.
+ */
+/**
+ * This will either open a component with the shared data or publish the shared data using the linker client if the window is linked.
+ *
+ * @param {object} params
+ * @param {object} [params.data]
+ * @param {boolean} [params.publishOnly] if the component is linked, this will only publish the data, not force open a window if it does not exist. If the component is not linked, this is ignored.
+ * @param {function} [params.multipleOpenerHandler] Optional. This function is called with on object that contains a map of componentTypes to the data types they can open. It must return a list of components to be opened. If no handler is provided, the first found component will be chosen. It is possible that the component opened may not handle all the data provided.
+ * @param {function} cb callback invoked with action taken.
+ *
+ */
+export declare function openSharedData(params: any, cb: any): void;
+//# sourceMappingURL=deprecatedFunctions.d.ts.map

package/deprecated/deprecatedFunctions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecatedFunctions.d.ts","sourceRoot":"","sources":["../../../src/deprecated/deprecatedFunctions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAI5D;;;;;GAKG;AACH,eAAO,MAAM,wCAAwC,iBACtC,aAAa,OACvB,QAAQ,KACV,QAAQ;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAWjC,CAAC;AA8CF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,WAAY,OAAO,SAMlD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,oBAAqB,eAAe,WAEjF,CAAC;AAEF;;;;GAIG;AACH;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,KAAA,EAAE,EAAE,KAAA,QA4FxC"}

package/deprecated/deprecatedFunctions.js

@@ -0,0 +1,200 @@
+/**
+ * This file serves as a temporary holding area for deprecated functions.
+ * Once a deprecated function is removed from the public API then it can
+ * be either deleted from this file or moved to a permanent location.
+ */
+import { Logger } from "../clients/logger";
+import LinkerClient from "./linkerClient";
+import { AppsClient } from "../clients";
+/**
+ * Gets all active or pending window names. Active windows have completed spawning.  Pending windows have been spawned but haven't yet completed.
+ *
+ * @param {StandardCallback} cb Callback returns an array of window names (as does the resolved Promise).
+ * @private
+ */
+export const deprecatedGetActiveAndPendingWindowNames = (routerClient, cb = Function.prototype) => {
+    const promiseResolver = (resolve) => {
+        routerClient.query("Launcher.getActiveAndPendingWindowNames", {}, (err, response) => {
+            if (err) {
+                Logger.system.error(err);
+            }
+            cb(err, response.data);
+            resolve({ err, data: response.data });
+        });
+    };
+    return new Promise(promiseResolver);
+};
+/**
+ *
+ * Helper to see if element has a class.
+ * @param {HTMLElement} el
+ * @param {String} className
+ * @private
+ * @return {HTMLElement}
+ */
+function hasClass(el, className) {
+    if (el.classList) {
+        return el.classList.contains(className);
+    }
+    return !!el.className.match(new RegExp(`(\\s|^)${className}(\\s|$)`));
+}
+/**
+ * Adds a class to an HTML element
+ * @param {HTMLElement} el
+ * @param {String} className
+ * @private
+ */
+function addClass(el, className) {
+    if (el.classList) {
+        el.classList.add(className);
+    }
+    else if (!hasClass(el, className)) {
+        el.className = `${el.className} ${className}`;
+    }
+}
+/**
+ *
+ * Removes class from HTML element
+ * @param {HTMLElement} el
+ * @param {String} className
+ * @private
+ */
+function removeClass(el, className) {
+    if (el.classList) {
+        el.classList.remove(className);
+    }
+    else if (hasClass(el, className)) {
+        const reg = new RegExp(`(\\s|^)${className}(\\s|$)`);
+        el.className = el.className.replace(reg, " ");
+    }
+}
+/**
+ * Highlights the window as active by creating a border around the window.
+ *
+ * @param {boolean} active  Set to false to turn off activity
+ * @private
+ */
+export const deprecatedSetActive = (active) => {
+    if (active) {
+        addClass(document.documentElement, "desktop-active");
+    }
+    else {
+        removeClass(document.documentElement, "desktop-active");
+    }
+};
+/**
+ * Gets the window name of current window or the parent, if tabbed. The code that manages window movement will not see a child window if it's part of a stacked window. This function will return the window name that the Window Service cares about for window movement.
+ */
+export const deprecatedGetWindowNameForDocking = (finsembleWindow) => {
+    return finsembleWindow.name;
+};
+/** Daniel H. 1/14/2019
+ * This method is only used in the DragAndDrop client, and it introduces a sneaky circular dependency between
+ * this module and the launcherClient. It should be refactored out of this module. This can't be done until v4.0.0, as
+ * it would be a breaking change to our API.
+ */
+/**
+ * This will either open a component with the shared data or publish the shared data using the linker client if the window is linked.
+ *
+ * @param {object} params
+ * @param {object} [params.data]
+ * @param {boolean} [params.publishOnly] if the component is linked, this will only publish the data, not force open a window if it does not exist. If the component is not linked, this is ignored.
+ * @param {function} [params.multipleOpenerHandler] Optional. This function is called with on object that contains a map of componentTypes to the data types they can open. It must return a list of components to be opened. If no handler is provided, the first found component will be chosen. It is possible that the component opened may not handle all the data provided.
+ * @param {function} cb callback invoked with action taken.
+ *
+ */
+export function openSharedData(params, cb) {
+    const launcherClient = AppsClient;
+    const linkerClient = LinkerClient;
+    // If no handler is specified to deal with multiple components, use the first found
+    if (!params.multipleOpenerHandler) {
+        params.multipleOpenerHandler = function (componentsMappedToData) {
+            // find the component that can open the most amount of data
+            let maxDataTypesOpened = 0;
+            let componentToOpen;
+            for (const componentType of Object.keys(componentsMappedToData)) {
+                if (componentsMappedToData[componentType].length > maxDataTypesOpened) {
+                    componentToOpen = componentType;
+                    maxDataTypesOpened = componentsMappedToData[componentType].length;
+                }
+            }
+            return [componentToOpen];
+        };
+    }
+    const errors = [];
+    const componentsMappedToData = {};
+    // Loop through the data
+    launcherClient.getComponentsThatCanReceiveDataTypes({ dataTypes: Object.keys(params.data) }, (err, dataTypeComponentMap) => {
+        for (const dataType of Object.keys(dataTypeComponentMap)) {
+            if (!dataTypeComponentMap[dataType].componentTypes.length) {
+                const error = `No Components Available to Handle the type: ${dataType}`;
+                errors.push(error);
+                Logger.system.error(error);
+            }
+            else {
+                for (const component of dataTypeComponentMap[dataType].componentTypes) {
+                    if (!componentsMappedToData[component]) {
+                        componentsMappedToData[component] = [dataType];
+                    }
+                    else
+                        componentsMappedToData[component].push(dataType);
+                }
+            }
+        }
+        // What if multiple components need to be opened?
+        let componentsToOpen = Object.keys(componentsMappedToData);
+        if (componentsToOpen.length) {
+            if (componentsToOpen.length > 1) {
+                componentsToOpen = params.multipleOpenerHandler(componentsMappedToData);
+            }
+            const linkerChannels = Object.keys(linkerClient.channels);
+            if (linkerChannels.length) {
+                // if linked
+                const linkedWindows = linkerClient.getLinkedComponents({
+                    componentTypes: componentsToOpen,
+                    windowIdentifier: linkerClient.windowIdentifier(),
+                });
+                if (linkedWindows.length || params.publishOnly) {
+                    // If publishOnly is true then just publish, not spawn
+                    linkerClient.publish({
+                        dataType: "Finsemble.DragAndDropClient",
+                        data: params.data,
+                    }, () => { });
+                    if (cb)
+                        cb(errors.length ? errors : null, "Data published");
+                }
+                else {
+                    // spawn
+                    for (const component of componentsToOpen) {
+                        launcherClient.spawn(component, {
+                            data: {
+                                sharedData: params.data,
+                                linker: {
+                                    channels: linkerChannels,
+                                },
+                            },
+                            addToWorkspace: true,
+                        });
+                    }
+                    if (cb)
+                        cb(errors.length ? errors : null, "Linked Window(s) spawned with data");
+                }
+            }
+            else if (!params.publishOnly) {
+                for (const component of componentsToOpen) {
+                    launcherClient.spawn(component, {
+                        data: {
+                            sharedData: params.data,
+                        },
+                        addToWorkspace: true,
+                    });
+                }
+                if (cb)
+                    cb(errors.length ? errors : null, "New Window(s) spawned with data");
+            }
+        }
+        else if (cb)
+            cb(errors.length ? errors : null, null);
+    });
+}
+//# sourceMappingURL=deprecatedFunctions.js.map

package/deprecated/deprecatedFunctions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecatedFunctions.js","sourceRoot":"","sources":["../../../src/deprecated/deprecatedFunctions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACvD,YAA2B,EAC3B,KAAe,QAAQ,CAAC,SAAS,EACE,EAAE;IACrC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,EAAE;QACnC,YAAY,CAAC,KAAK,CAAC,yCAAyC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;YACnF,IAAI,GAAG,EAAE;gBACR,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvB,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;IACF,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,SAAS,QAAQ,CAAC,EAAE,EAAE,SAAS;IAC9B,IAAI,EAAE,CAAC,SAAS,EAAE;QACjB,OAAO,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;KACxC;IACD,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,UAAU,SAAS,SAAS,CAAC,CAAC,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,EAAE,EAAE,SAAS;IAC9B,IAAI,EAAE,CAAC,SAAS,EAAE;QACjB,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;KAC5B;SAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE;QACpC,EAAE,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC,SAAS,IAAI,SAAS,EAAE,CAAC;KAC9C;AACF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,EAAE,EAAE,SAAS;IACjC,IAAI,EAAE,CAAC,SAAS,EAAE;QACjB,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;KAC/B;SAAM,IAAI,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE;QACnC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,SAAS,SAAS,CAAC,CAAC;QACrD,EAAE,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;KAC9C;AACF,CAAC;AACD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAe,EAAE,EAAE;IACtD,IAAI,MAAM,EAAE;QACX,QAAQ,CAAC,QAAQ,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;KACrD;SAAM;QACN,WAAW,CAAC,QAAQ,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;KACxD;AACF,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,eAAgC,EAAE,EAAE;IACrF,OAAO,eAAe,CAAC,IAAI,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;GAIG;AACH;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,MAAM,EAAE,EAAE;IACxC,MAAM,cAAc,GAAG,UAAU,CAAC;IAClC,MAAM,YAAY,GAAG,YAAY,CAAC;IAClC,mFAAmF;IACnF,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE;QAClC,MAAM,CAAC,qBAAqB,GAAG,UAAU,sBAAsB;YAC9D,2DAA2D;YAC3D,IAAI,kBAAkB,GAAG,CAAC,CAAC;YAC3B,IAAI,eAAe,CAAC;YACpB,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE;gBAChE,IAAI,sBAAsB,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,kBAAkB,EAAE;oBACtE,eAAe,GAAG,aAAa,CAAC;oBAChC,kBAAkB,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC;iBAClE;aACD;YACD,OAAO,CAAC,eAAe,CAAC,CAAC;QAC1B,CAAC,CAAC;KACF;IAED,MAAM,MAAM,GAAU,EAAE,CAAC;IACzB,MAAM,sBAAsB,GAAG,EAAE,CAAC;IAElC,wBAAwB;IACxB,cAAc,CAAC,oCAAoC,CAClD,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EACvC,CAAC,GAAG,EAAE,oBAAoB,EAAE,EAAE;QAC7B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE;YACzD,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE;gBAC1D,MAAM,KAAK,GAAG,+CAA+C,QAAQ,EAAE,CAAC;gBACxE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aAC3B;iBAAM;gBACN,KAAK,MAAM,SAAS,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAC,cAAc,EAAE;oBACtE,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,EAAE;wBACvC,sBAAsB,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;qBAC/C;;wBAAM,sBAAsB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iBACxD;aACD;SACD;QAED,iDAAiD;QACjD,IAAI,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QAC3D,IAAI,gBAAgB,CAAC,MAAM,EAAE;YAC5B,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;gBAChC,gBAAgB,GAAG,MAAM,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;aACxE;YACD,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC1D,IAAI,cAAc,CAAC,MAAM,EAAE;gBAC1B,YAAY;gBACZ,MAAM,aAAa,GAAG,YAAY,CAAC,mBAAmB,CAAC;oBACtD,cAAc,EAAE,gBAAgB;oBAChC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB,EAAE;iBACjD,CAAC,CAAC;gBACH,IAAI,aAAa,CAAC,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE;oBAC/C,sDAAsD;oBACtD,YAAY,CAAC,OAAO,CACnB;wBACC,QAAQ,EAAE,6BAA6B;wBACvC,IAAI,EAAE,MAAM,CAAC,IAAI;qBACjB,EACD,GAAG,EAAE,GAAE,CAAC,CACR,CAAC;oBACF,IAAI,EAAE;wBAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;iBAC5D;qBAAM;oBACN,QAAQ;oBACR,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE;wBACzC,cAAc,CAAC,KAAK,CAAC,SAAS,EAAE;4BAC/B,IAAI,EAAE;gCACL,UAAU,EAAE,MAAM,CAAC,IAAI;gCACvB,MAAM,EAAE;oCACP,QAAQ,EAAE,cAAc;iCACxB;6BACD;4BACD,cAAc,EAAE,IAAI;yBACpB,CAAC,CAAC;qBACH;oBACD,IAAI,EAAE;wBAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,oCAAoC,CAAC,CAAC;iBAChF;aACD;iBAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;gBAC/B,KAAK,MAAM,SAAS,IAAI,gBAAgB,EAAE;oBACzC,cAAc,CAAC,KAAK,CAAC,SAAS,EAAE;wBAC/B,IAAI,EAAE;4BACL,UAAU,EAAE,MAAM,CAAC,IAAI;yBACvB;wBACD,cAAc,EAAE,IAAI;qBACpB,CAAC,CAAC;iBACH;gBACD,IAAI,EAAE;oBAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;aAC7E;SACD;aAAM,IAAI,EAAE;YAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC,CACD,CAAC;AACH,CAAC"}

package/deprecated/deprecatedlauncherClient.d.ts

@@ -0,0 +1,163 @@
+import { StandardError, StandardErrorCallback, StandardPromise } from "../types";
+import { WindowIdentifier } from "../platform/services/window/types";
+import { ComponentDescriptor, MonitorInfo } from "../clients/appsClient";
+/**
+ * Dynamically registers a component with the Launcher Service for the current Finsemble session. This method registers a given component in a component manifest, making it available to an app launcher component. Note: Components registered in this way are removed at the end of Finsemble's current session.
+ *
+ * @param params.componentType The key of the component in the component's config.
+ * @param params.manifest This should be a component manifest, i.e., a component configuration file like <i>components.json</i>.
+ * @param cb The callback to be invoked after the method completes successfully.
+ * @deprecated
+ */
+export declare const registerComponent: (params: {
+    componentType: string;
+    manifest: ComponentDescriptor;
+}, cb: StandardErrorCallback<string>) => StandardPromise<string>;
+/**
+ * Unregisters a component with the Launcher Service.
+ *
+ * @param params.componentType The key of the component in the component's config.
+ * @param cb
+ * @deprecated
+ */
+export declare const unRegisterComponent: (params: {
+    componentType: string;
+}, cb?: StandardErrorCallback<string>) => StandardPromise<string>;
+/**
+ * @deprecated as of 5.2.0, will be removed in a future release.
+ *
+ * Convenience function to get a monitor descriptor for a given windowIdentifier, or for the
+ * current window.
+ *
+ * @param windowIdentifier The window to find the monitor for. Current window if undefined.
+ * @param cb Returns a monitor descriptor (optional or use returned Promise)
+ * @returns A promise that resolves to a monitorInfo
+ * @ignore
+ */
+export declare const getMonitor: (windowIdentifier: WindowIdentifier, cb?: StandardErrorCallback<MonitorInfo>) => StandardPromise<MonitorInfo>;
+/**
+ * Gets all active or pending window names. Active windows have completed spawning.  Pending windows have been spawned but haven't yet completed.
+ *
+ * @param cb Callback returns an array of window names (as does the resolved Promise).
+ * @ignore
+ * @deprecated Move to workspaceService where this code is actually used
+ */
+export declare const getActiveAndPendingWindowNames: (cb?: Function) => Promise<{
+    err: any;
+    data: any;
+}>;
+/**
+ * Get list of windows objects that haven't finished spawning
+ * Individual window objects are not full windows,
+ * they contain the window name and a few other attributes
+ *
+ * @returns Object
+ * @ignore
+ * @deprecated Move to workspaceService where this code is actually used
+ */
+export declare const getPendingWindows: () => StandardPromise<string[]>;
+/**
+ * Gets components that can receive specific data types. Returns an object containing componentTypes mapped to a list of dataTypes they can receive. This is based on the "advertiseReceivers" property in a component's config.
+ *
+ * ```javascript
+ * FSBL.Client.LauncherClient.getComponentsThatCanReceiveDataTypes({ dataTypes: ['chartiq.chart', 'salesforce.contact']}, function(err, response) {
+ * 	//Response contains: {'chartiq.chart': ['Advanced Chart'], 'salesforce.contact': ['Salesforce Contact']}
+ * })
+ * ```
+ * @param params.dataTypes An array of data types. Looks for components that can receive those data types.
+ * @param cb The callback to be invoked after the method completes successfully.
+ * @deprecated
+ * @ignore
+ */
+export declare const getComponentsThatCanReceiveDataTypes: (params: {
+    dataTypes: string[];
+}, cb?: Function) => Promise<unknown>;
+/**
+ * Minimizes all but a specific list or group of windows. Either groupName or windowList must be specified.
+ *
+ * ```javascript
+ * LauncherClient.hyperFocus({ windowList: ['AdvancedChart-123-123', 'Symphony-Chat-234-234']}, function(err, response) {
+ *
+ * })
+ * ```
+ * @param params
+ * @param params.windowList Optional. An array of window names or window identifiers. Not to be used with componentType.
+ * @param params.groupName Optional. The name of a window group to hyperFocus.
+ * @param params.componentType Optional. The Component Type to hyperFocus. Not to be used with windowList.
+ * @deprecated as of 4.0.0, may be removed in the future
+ * @ignore
+ */
+export declare const hyperFocus: (params: {
+    windowList?: string[] | WindowIdentifier[];
+    groupName?: string;
+    componentType?: string;
+}, cb?: () => void) => Promise<void>;
+/**
+ * Create Window group
+ * @param params
+ * @param params.groupName The name of the window group to create
+ * @param params.windowList An array of window names or window identifiers to add to the group. Optional.
+ * @param cb callback to be called upon group creation
+ *
+ * @ignore
+ * @deprecated
+ */
+export declare const createWindowGroup: (params: {
+    windowList?: string[] | WindowIdentifier[];
+    groupName?: string;
+}, cb?: Function) => Promise<unknown>;
+/**
+ * Add Windows to group
+ * @param params
+ * @param params.groupName The name of the window group
+ * @param params.windowList An array of window names or window identifiers to add to the group.
+ * @param cb callback to be called upon group creation
+ *
+ * @ignore
+ * @deprecated
+ */
+export declare const addWindowsToGroup: (params: {
+    windowList?: string[] | WindowIdentifier[];
+    groupName?: string;
+}, cb?: Function) => Promise<unknown>;
+/**
+ * Remove Windows from group
+ * @param params
+ * @param params.groupName The name of the window group
+ * @param params.windowList An array of window names or window identifiers to remove from the group.
+ * @param cb callback to be called upon group creation
+ *
+ * @ignore
+ * @deprecated
+ */
+export declare const removeWindowsFromGroup: (params: {
+    windowList?: string[] | WindowIdentifier[];
+    groupName?: string;
+}, cb?: Function) => Promise<unknown>;
+/**
+ * Get Window Groups that a window belongs to. If no windowIdentifier is specified, gets  the groups of the current window.
+ * @param params
+ * @param params.windowIdentifier Optional. If not specified uses current window
+ * @param cb callback with a list of groups
+ *
+ * @ignore
+ * @deprecated
+ */
+export declare const getGroupsForWindow: (params: {
+    windowIdentifier: WindowIdentifier;
+} | null, cb?: Function) => Promise<unknown>;
+/**
+ * @param params
+ * @param params.windowIdentifier Optional. Current window is assumed if not specified.
+ * @param params.groupNames List of group names to add window to. Groups will be created if they do not exist.
+ * @param cb
+ * @ignore
+ * @deprecated
+ */
+export declare const addToGroups: (params: {
+    windowIdentifier?: WindowIdentifier;
+    groupNames?: string[];
+}, cb: (err?: StandardError) => void) => Promise<{
+    err: StandardError;
+}>;
+//# sourceMappingURL=deprecatedlauncherClient.d.ts.map

package/deprecated/deprecatedlauncherClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecatedlauncherClient.d.ts","sourceRoot":"","sources":["../../../src/deprecated/deprecatedlauncherClient.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAOrE,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,WACrB;IACP,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,mBAAmB,CAAC;CAC9B,MACG,sBAAsB,MAAM,CAAC,KAC/B,gBAAgB,MAAM,CAKxB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,WACvB;IACP,aAAa,EAAE,MAAM,CAAC;CACtB,OACI,sBAAsB,MAAM,CAAC,KAChC,gBAAgB,MAAM,CAWxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,qBACJ,gBAAgB,OAC7B,sBAAsB,WAAW,CAAC,KACrC,gBAAgB,WAAW,CAM7B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,QAAQ,QAAQ,KAAwB,QAAQ;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAIjH,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,QAAa,gBAAgB,MAAM,EAAE,CAMlE,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,oCAAoC,WACxC;IACP,SAAS,EAAE,MAAM,EAAE,CAAC;CACpB,OACG,QAAQ,qBAmBZ,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,WACd;IACP,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB,OACI,MAAM,IAAI,KACb,QAAQ,IAAI,CAiBd,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,WACrB;IACP,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,OACG,QAAQ,qBAsBZ,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,WACrB;IACP,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,oCAsBD,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB,WAC1B;IACP,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,EAAE,CAAC;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,OACG,QAAQ,qBAoBZ,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,WACtB;IACP,gBAAgB,EAAE,gBAAgB,CAAC;CACnC,GAAG,IAAI,OACJ,QAAQ,qBAyBZ,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,WACf;IACP,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,aACU,aAAa,KAAK,IAAI;SAChB,aAAa;EAS9B,CAAC"}