@finsemble/finsemble-ui 10.0.0-beta.3 → 10.0.0-iocd.2

package/common/systemManagerClient.js

@@ -0,0 +1,190 @@
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+// NOTE: SystemManagerClient is currently located in common but accessible on FSBL.  We have not decided yet whether or not to expose it like the other clients.
+import { RouterClient } from "../clients/routerClient";
+import { Logger } from "../clients/logger";
+import { ALL_BOOT_STAGES } from "../platform/services/systemManager/_constants";
+import { SYSLOG_CHANNEL, STAGE_CHANNEL, SHOW_SYSLOG_CHANNEL, HIDE_SYSLOG_CHANNEL, } from "../platform/services/systemManager/_constants";
+import { statusChannel, checkpointChannel } from "../platform/services/systemManager/common";
+/**
+ * Singleton API to Finsemble System Manager
+ */
+class SystemManagerClient {
+    constructor() {
+        this.startedElements = {};
+    }
+    /**
+     * Publishes boot status for the service or component (or boot task) being started.  This method is used internally in FSBL and baseService and not directly called.
+     * @param name the name of the service or component or module
+     * @param type the type category ("services" or "components")
+     * @param state the state ("completed" or "failed")
+     *
+     * @private
+     */
+    publishBootStatus(name, type, state, error) {
+        Logger.system.debug("publishBootStatus", name, type, state);
+        RouterClient.publish(statusChannel(name), { name, type, state, error });
+    }
+    /**
+     * Waits for a specific boot stage
+     * @param stage the stage to wait for
+     * @param when wait until either "stageEntered" or "stageCompleted"
+     * @param= [callback]
+     * @returns a promise
+     *
+     * @example
+     *
+     * 	await SystemManagerClient.waitForBootStage("authentication", "stageCompleted");
+     *
+     * 	SystemManagerClient.waitForBootStage("authentication", "stageCompleted", () => {
+     *		RouterClient.publish(Constants.APPLICATION_STATE_CHANNEL, { state: "authenticated" });
+     * 	});
+     *
+     */
+    waitForBootStage(stage, when, callback = Function.prototype) {
+        const waitForBootStageCompletionPromiseResolver = (resolve, reject) => {
+            Logger.system.debug("SystemManagerClient.waitForBootStage entry", stage, when);
+            const stageIndex = ALL_BOOT_STAGES.indexOf(stage);
+            if (stage === "microkernel" && when === "stageEntered") {
+                Logger.system.error("Cannot wait on `stageEntered` for microkernel because router isn't up yet. So will instead wait for microkernel stage complete.");
+            }
+            // receives startup state from services -- see SystemManagerClient.publishBootStatus
+            const subscribeId = RouterClient.subscribe(STAGE_CHANNEL, (err, notify) => {
+                Logger.system.debug("SystemManagerClient.waitForBootStage new stage", notify.data.stage, subscribeId);
+                if (err) {
+                    Logger.system.error("SystemManagerClient.waitForBootStage subscribe error", err);
+                    callback(err);
+                    reject(err);
+                }
+                else if (stageIndex === -1) {
+                    // if illegal stage was input
+                    err = "illegal stage argument";
+                    Logger.system.debug("SystemManagerClient.waitForBootStage subscribe error", err, stage);
+                    callback(err);
+                    reject(err);
+                }
+                else {
+                    // note the following section handles cases where waitForBootStage might be invoked after the stage has been enter or passed
+                    const currentStageIndex = ALL_BOOT_STAGES.indexOf(notify.data.stage);
+                    Logger.system.debug("SystemManagerClient.waitForBootStage new stage", notify.data, subscribeId);
+                    // when the stage before completes (or anytime after) then done for "stageEntered"
+                    if (when === "stageEntered" && currentStageIndex + 1 >= stageIndex) {
+                        Logger.system.debug("SystemManagerClient.waitForBootStage stageEntered", stage, subscribeId, callback.name);
+                        callback();
+                        resolve();
+                        RouterClient.unsubscribe(subscribeId);
+                        // when current stage matches (or comes after) given stage, then done for "stageCompleted"
+                    }
+                    else if (when === "stageCompleted" && currentStageIndex >= stageIndex) {
+                        Logger.system.debug("SystemManagerClient.waitForBootStage completed", stage, subscribeId);
+                        callback();
+                        resolve();
+                        RouterClient.unsubscribe(subscribeId);
+                    }
+                    else {
+                        Logger.system.debug(`SystemManagerClient.waitForBootStage else currentStageIndex=${currentStageIndex} stageIndex=${stageIndex} `, currentStageIndex, stageIndex, stage, subscribeId);
+                    }
+                }
+            });
+        };
+        return new Promise(waitForBootStageCompletionPromiseResolver);
+    }
+    /**
+     * Waits for a specific service (or component or boot task) to be started.
+     *
+     * @param name the name of the service/boot task/component (e.g. "storageService")
+     * to wait for
+     * @param callback function to be called when the startup process has completed or error ocurred.
+     *
+     * @example
+     *
+     * 	await SystemManagerClient.waitForStartup("configService");
+     *
+     *	SystemManagerClient.waitForStartup("dataStoreService", () => {
+     *		RouterClient.publish(Constants.APPLICATION_STATE_CHANNEL, { state: "configuring" });
+     *	});
+     *
+     */
+    waitForStartup(name, callback = Function.prototype) {
+        return new Promise((resolve, reject) => {
+            if (this.startedElements[name]) {
+                resolve();
+                return;
+            }
+            Logger.system.debug(`SystemManagerClient.waitForStartup.${name}`, name);
+            // receives startup state from services -- see SystemManagerClient.publishBootStatus
+            const subscribeId = RouterClient.subscribe(statusChannel(name), (err, notify) => {
+                Logger.system.debug("SystemManagerClient.waitForStartup subscribe", name, err, notify);
+                if (err) {
+                    Logger.system.error("SystemManagerClient.waitForStartup subscribe error", err);
+                    callback(err);
+                    this.startedElements[name] = false;
+                    reject(err);
+                }
+                else if (notify.data.name === name && notify.data.state === "completed") {
+                    Logger.system.debug("SystemManagerClient.waitForStartup completed", name);
+                    this.startedElements[name] = true;
+                    callback();
+                    resolve();
+                    RouterClient.unsubscribe(subscribeId);
+                }
+            });
+        });
+    }
+    /**
+     * Publishes a checkpoints status. This must be done for any checkpoint so the SystemManager will know if the checkpoint succeeded or not
+     * @param windowName the name of the window publishing the checkpoint)
+     * @param checkpointName the name of the checkpoint (as defined in config)
+     * @param state the state for the checkpoint, either "completed" or "failed"
+     *
+     * @example
+     *
+     * 	SystemManagerClient.publishCheckpointState("workspaceService", "importedLegacyWorkspaces", "completed");
+     *
+     */
+    publishCheckpointState(windowName, checkpointName, state) {
+        //console.log("publishCheckpoint", windowName, checkpointName, state, checkpointChannel(windowName, checkpointName));
+        Logger.system.debug("publishCheckpoint", windowName, checkpointName, state, checkpointChannel(windowName, checkpointName));
+        RouterClient.publish(checkpointChannel(windowName, checkpointName), {
+            windowName,
+            checkpointName,
+            state,
+        });
+    }
+    /**
+     * Shows System Log window and bring its to front.
+     */
+    showSystemLog() {
+        Logger.system.debug("SystemManagerClient.showSystemLog");
+        RouterClient.transmit(SHOW_SYSLOG_CHANNEL, true);
+    }
+    /**
+     * Hides System Log window.
+     */
+    hideSystemLog() {
+        Logger.system.debug("SystemManagerClient.hideSystemLog");
+        RouterClient.transmit(HIDE_SYSLOG_CHANNEL, true);
+    }
+    /**
+     * Displays message on the system log
+     * @param params generally this is TBD until real system log is written
+     * @param params.error if true then the log message is an error
+     * @param params.notification if true then the log message is a notification
+     * @param message the message string to log
+     *
+     * @example
+     *
+     * 	SystemManagerClient.systemLog({ error: true}, errorMsg);
+     *  SystemManagerClient.systemLog({ notification: true }, "Notification: " + message);
+     *
+     */
+    systemLog(params, logMessage) {
+        Logger.system.debug("SystemManagerClient.systemLog", params, logMessage);
+        RouterClient.transmit(SYSLOG_CHANNEL, { params, logMessage });
+    }
+}
+const systemManagerClient = new SystemManagerClient();
+export default systemManagerClient;
+//# sourceMappingURL=systemManagerClient.js.map

package/common/systemManagerClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systemManagerClient.js","sourceRoot":"","sources":["../../../src/common/systemManagerClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,gKAAgK;AAEhK,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAChF,OAAO,EACN,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,mBAAmB,GACnB,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAG7F;;GAEG;AACH,MAAM,mBAAmB;IAAzB;QACS,oBAAe,GAAG,EAAE,CAAC;IA8L9B,CAAC;IA5LA;;;;;;;OAOG;IACI,iBAAiB,CAAC,IAAY,EAAE,IAAwB,EAAE,KAAgB,EAAE,KAAc;QAChG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5D,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,gBAAgB,CAAC,KAAgB,EAAE,IAAmB,EAAE,QAAQ,GAAG,QAAQ,CAAC,SAAS;QAC3F,MAAM,yCAAyC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/E,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAElD,IAAI,KAAK,KAAK,aAAa,IAAI,IAAI,KAAK,cAAc,EAAE;gBACvD,MAAM,CAAC,MAAM,CAAC,KAAK,CAClB,iIAAiI,CACjI,CAAC;aACF;YAED,oFAAoF;YACpF,MAAM,WAAW,GAAG,YAAY,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;gBACzE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;gBACtG,IAAI,GAAG,EAAE;oBACR,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,sDAAsD,EAAE,GAAG,CAAC,CAAC;oBACjF,QAAQ,CAAC,GAAG,CAAC,CAAC;oBACd,MAAM,CAAC,GAAG,CAAC,CAAC;iBACZ;qBAAM,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;oBAC7B,6BAA6B;oBAC7B,GAAG,GAAG,wBAAwB,CAAC;oBAC/B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,sDAAsD,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;oBACxF,QAAQ,CAAC,GAAG,CAAC,CAAC;oBACd,MAAM,CAAC,GAAG,CAAC,CAAC;iBACZ;qBAAM;oBACN,4HAA4H;oBAC5H,MAAM,iBAAiB,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACrE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;oBAEhG,kFAAkF;oBAClF,IAAI,IAAI,KAAK,cAAc,IAAI,iBAAiB,GAAG,CAAC,IAAI,UAAU,EAAE;wBACnE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mDAAmD,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;wBAC5G,QAAQ,EAAE,CAAC;wBACX,OAAO,EAAE,CAAC;wBACV,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;wBACtC,0FAA0F;qBAC1F;yBAAM,IAAI,IAAI,KAAK,gBAAgB,IAAI,iBAAiB,IAAI,UAAU,EAAE;wBACxE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,gDAAgD,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;wBAC1F,QAAQ,EAAE,CAAC;wBACX,OAAO,EAAE,CAAC;wBACV,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;qBACtC;yBAAM;wBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAClB,+DAA+D,iBAAiB,eAAe,UAAU,GAAG,EAC5G,iBAAiB,EACjB,UAAU,EACV,KAAK,EACL,WAAW,CACX,CAAC;qBACF;iBACD;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,OAAO,IAAI,OAAO,CAAC,yCAAyC,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,cAAc,CAAC,IAAY,EAAE,QAAQ,GAAG,QAAQ,CAAC,SAAS;QAChE,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC5C,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;gBAC/B,OAAO,EAAE,CAAC;gBACV,OAAO;aACP;YACD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,sCAAsC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;YACxE,oFAAoF;YACpF,MAAM,WAAW,GAAG,YAAY,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;gBAC/E,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBACvF,IAAI,GAAG,EAAE;oBACR,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oDAAoD,EAAE,GAAG,CAAC,CAAC;oBAC/E,QAAQ,CAAC,GAAG,CAAC,CAAC;oBACd,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;oBACnC,MAAM,CAAC,GAAG,CAAC,CAAC;iBACZ;qBAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,WAAW,EAAE;oBAC1E,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE,IAAI,CAAC,CAAC;oBAC1E,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;oBAClC,QAAQ,EAAE,CAAC;oBACX,OAAO,EAAE,CAAC;oBACV,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;iBACtC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,sBAAsB,CAAC,UAAkB,EAAE,cAAsB,EAAE,KAAgB;QACzF,qHAAqH;QACrH,MAAM,CAAC,MAAM,CAAC,KAAK,CAClB,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,KAAK,EACL,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,CAC7C,CAAC;QACF,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE;YACnE,UAAU;YACV,cAAc;YACd,KAAK;SACL,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,aAAa;QACnB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,YAAY,CAAC,QAAQ,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,aAAa;QACnB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,YAAY,CAAC,QAAQ,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,SAAS,CAAC,MAAM,EAAE,UAAU;QAClC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACzE,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;IAC/D,CAAC;CACD;AAED,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,EAAE,CAAC;AAEtD,eAAe,mBAAmB,CAAC"}

package/common/testPoint.d.ts

@@ -0,0 +1,57 @@
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+/**
+ * Singleton API to Finsemble System Manager
+ */
+declare class TestPoint {
+    testPointsEnabled: boolean;
+    actionMap: Record<string, Function>;
+    state: any;
+    constructor();
+    start(): Promise<void>;
+    /**
+     * Enables testpoints.  Must be invoked once from somewhere in Finsemble for testpoints to work.  Can be involved multiple times.
+     *
+     * @memberof TestPoint
+     */
+    enableTestPoints(): void;
+    /**
+     * Triggers a specific snapshot, capturing the data to be returned by waitForSnapshot for the given snapshot name
+     *
+     * @param {string} name snapshot name
+     * @param {*} snapshotData data
+     * @memberof TestPoint
+     */
+    triggerSnapshot<T = any>(name: string, snapshotData: T): void;
+    /**
+     * Waits for a specific snapshot point to be reached from somewhere in Finsemble, then returns the snapshot data.
+     *
+     * @param {*} snapshotName snapshot name to wait for
+     * @param {number} [count=1] the number of times the testpoint name must be triggered before returning
+     * @param {*} [timeout=SnapshotPointWaitTimeout] How long in milliseconds to wait before failing
+     * @returns
+     * @memberof TestPoint
+     */
+    waitForSnapshot<T = any>(snapshotName: string, count?: number, timeout?: number): Promise<T | null>;
+    /**
+     * Fires customized test action(s) corresponding to specified name -- causes the correspond onAction() to be triggered.
+     * Typically used within a Live Mocha test.
+     *
+     * @param name name of action to fire
+     * @param data data to pass to action
+     */
+    triggerAction<T = any>(name: string, data?: T): void;
+    /**
+     * Used to implement customized actions for the specificed name -- the callback is invoked when a corresponding triggerAction() is called.
+     * Typically used within unit under test to set test state or simulate user actions.
+     *
+     * @param name name of action to look for
+     * @param callback function to invoke when action fires
+     */
+    onAction<T = any>(name: string, callback: (arg0: T) => void): void;
+}
+declare const testPoint: TestPoint;
+export default testPoint;
+//# sourceMappingURL=testPoint.d.ts.map

package/common/testPoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testPoint.d.ts","sourceRoot":"","sources":["../../../src/common/testPoint.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH;;GAEG;AACH,cAAM,SAAS;IACd,iBAAiB,EAAE,OAAO,CAAS;IAEnC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAM;IAGzC,KAAK,EAAE,GAAG,CAAM;;IAMV,KAAK;IAgBX;;;;OAIG;IACH,gBAAgB;IAIhB;;;;;;OAMG;IACH,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;IAOtD;;;;;;;;OAQG;IACH,eAAe,CAAC,CAAC,GAAG,GAAG,EACtB,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,MAAU,EACjB,OAAO,GAAE,MAAiC,GACxC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAqBpB;;;;;;OAMG;IACH,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;IAK7C;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI;CAI3D;AAED,QAAA,MAAM,SAAS,WAAkB,CAAC;AAElC,eAAe,SAAS,CAAC"}

package/common/testPoint.js

@@ -0,0 +1,106 @@
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+// TestPoint is currently located in common but accessible on FSBL for Live-Mocha testing.
+import { RouterClient } from "../clients/routerClient";
+import { Logger } from "../clients/logger";
+const TestPointChannel = "Finsemble.testPointsEnabled";
+const TestPointActionChannel = "Finsemble.testPointActions";
+const SnapshotPointWaitTimeout = 60 * 1000;
+/**
+ * Singleton API to Finsemble System Manager
+ */
+class TestPoint {
+    constructor() {
+        this.testPointsEnabled = false;
+        this.actionMap = {};
+        // State made accessable for TestPoint clients to directly access and store data within.
+        this.state = {};
+        this.start();
+    }
+    async start() {
+        RouterClient.addListener(TestPointChannel, () => {
+            Logger.system.debug(`TestPoint Module Enable`);
+            this.testPointsEnabled = true;
+        });
+        RouterClient.addListener(TestPointActionChannel, (err, response) => {
+            let { name, data } = response.data;
+            if (this.testPointsEnabled && typeof this.actionMap[name] === "function") {
+                Logger.system.debug(`TestPoint: firing ${name} action`, data);
+                this.actionMap[name](data);
+            }
+        });
+    }
+    /**
+     * Enables testpoints.  Must be invoked once from somewhere in Finsemble for testpoints to work.  Can be involved multiple times.
+     *
+     * @memberof TestPoint
+     */
+    enableTestPoints() {
+        RouterClient.transmit(TestPointChannel, true);
+    }
+    /**
+     * Triggers a specific snapshot, capturing the data to be returned by waitForSnapshot for the given snapshot name
+     *
+     * @param {string} name snapshot name
+     * @param {*} snapshotData data
+     * @memberof TestPoint
+     */
+    triggerSnapshot(name, snapshotData) {
+        if (this.testPointsEnabled) {
+            RouterClient.transmit("Finsemble.testPoint", { name, snapshotData });
+            Logger.system.debug("forceObjectsToLogger", `TestPoint: generating snapshot ${name}`, snapshotData);
+        }
+    }
+    /**
+     * Waits for a specific snapshot point to be reached from somewhere in Finsemble, then returns the snapshot data.
+     *
+     * @param {*} snapshotName snapshot name to wait for
+     * @param {number} [count=1] the number of times the testpoint name must be triggered before returning
+     * @param {*} [timeout=SnapshotPointWaitTimeout] How long in milliseconds to wait before failing
+     * @returns
+     * @memberof TestPoint
+     */
+    waitForSnapshot(snapshotName, count = 1, timeout = SnapshotPointWaitTimeout) {
+        let counter = 0;
+        return new Promise((resolve) => {
+            let timeoutId = setTimeout(() => {
+                Logger.system.error(`waitForSnapshot timed out on ${snapshotName}`);
+                resolve(null);
+            }, timeout);
+            RouterClient.addListener("Finsemble.testPoint", (err, response) => {
+                if (response.data.name === snapshotName && ++counter === count) {
+                    clearTimeout(timeoutId);
+                    Logger.system.debug("forceObjectsToLogger", `TestPoint: waitForSnapshot ${snapshotName} resolving`, response.data.snapshotData);
+                    resolve(response.data.snapshotData);
+                }
+            });
+        });
+    }
+    /**
+     * Fires customized test action(s) corresponding to specified name -- causes the correspond onAction() to be triggered.
+     * Typically used within a Live Mocha test.
+     *
+     * @param name name of action to fire
+     * @param data data to pass to action
+     */
+    triggerAction(name, data) {
+        RouterClient.transmit(TestPointActionChannel, { name, data });
+        Logger.system.debug("forceObjectsToLogger", `TestPoint: triggerAction ${name}`, data);
+    }
+    /**
+     * Used to implement customized actions for the specificed name -- the callback is invoked when a corresponding triggerAction() is called.
+     * Typically used within unit under test to set test state or simulate user actions.
+     *
+     * @param name name of action to look for
+     * @param callback function to invoke when action fires
+     */
+    onAction(name, callback) {
+        Logger.system.debug("forceObjectsToLogger", `TestPoint: onAction defined ${name}`);
+        this.actionMap[name] = callback;
+    }
+}
+const testPoint = new TestPoint();
+export default testPoint;
+//# sourceMappingURL=testPoint.js.map

package/common/testPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testPoint.js","sourceRoot":"","sources":["../../../src/common/testPoint.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,0FAA0F;AAE1F,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,MAAM,gBAAgB,GAAG,6BAA6B,CAAC;AACvD,MAAM,sBAAsB,GAAG,4BAA4B,CAAC;AAC5D,MAAM,wBAAwB,GAAG,EAAE,GAAG,IAAI,CAAC;AAE3C;;GAEG;AACH,MAAM,SAAS;IAQd;QAPA,sBAAiB,GAAY,KAAK,CAAC;QAEnC,cAAS,GAA6B,EAAE,CAAC;QAEzC,wFAAwF;QACxF,UAAK,GAAQ,EAAE,CAAC;QAGf,IAAI,CAAC,KAAK,EAAE,CAAC;IACd,CAAC;IAED,KAAK,CAAC,KAAK;QACV,YAAY,CAAC,WAAW,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC/C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC/C,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,WAAW,CAAC,sBAAsB,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;YAClE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC;YAEnC,IAAI,IAAI,CAAC,iBAAiB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,UAAU,EAAE;gBACzE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,IAAI,SAAS,EAAE,IAAI,CAAC,CAAC;gBAC9D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;aAC3B;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACf,YAAY,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAU,IAAY,EAAE,YAAe;QACrD,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC3B,YAAY,CAAC,QAAQ,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;YACrE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,kCAAkC,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC;SACpG;IACF,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CACd,YAAoB,EACpB,QAAgB,CAAC,EACjB,UAAkB,wBAAwB;QAE1C,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC9B,IAAI,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC/B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,YAAY,EAAE,CAAC,CAAC;gBACpE,OAAO,CAAC,IAAI,CAAC,CAAC;YACf,CAAC,EAAE,OAAO,CAAC,CAAC;YACZ,YAAY,CAAC,WAAW,CAAC,qBAAqB,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;gBACjE,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,EAAE,OAAO,KAAK,KAAK,EAAE;oBAC/D,YAAY,CAAC,SAAS,CAAC,CAAC;oBACxB,MAAM,CAAC,MAAM,CAAC,KAAK,CAClB,sBAAsB,EACtB,8BAA8B,YAAY,YAAY,EACtD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAC1B,CAAC;oBACF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBACpC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAU,IAAY,EAAE,IAAQ;QAC5C,YAAY,CAAC,QAAQ,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,4BAA4B,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAU,IAAY,EAAE,QAA2B;QAC1D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,+BAA+B,IAAI,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;IACjC,CAAC;CACD;AAED,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;AAElC,eAAe,SAAS,CAAC"}

package/common/toast.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+export declare type ToastFrequency = "ALWAYS" | "ONCE-SINCE-STARTUP" | "MAX-COUNT";
+export declare type ToastOptions = {
+    maxCount?: number;
+    duration?: number;
+};
+/**
+ * Conditionally alerts the end user using a desktop notification (toast).
+ *
+ * In addition to the params specified here, params may also include any valid parameter for electron.Notification.
+ *
+ * Set topic = "devModeOnly" so that UserNotifications only are displayed when running from the seed or with SDD.
+ *
+ * @param topic Specifies a category for the notification. This parameter is reserved for future use; it is designed to filter notifications (e.g., applying regEx's defined in config to determine which notifications are displayed). Any topic string can be specified; however "system" is the recommended topic for system notifications applicable both to end uses and to developers. "dev" is the recommended topic for notifications applicable only during development (e.g., a notification that <i>config.json</i> has an illegal value).
+ * @param frequency Either "ALWAYS", "ONCE-SINCE-STARTUP", or "MAX-COUNT" to determine if alert should be displayed. Note, the frequencies are based on the number of notifications emitted from a window (as opposed to system wide).
+ * @param identifier Uniquely identifies this specific notification message. Used when "frequency" is set to "ONCE-SINCE-STARTUP" or "MAX-COUNT".
+ * @param message Message to display in the notification. Typically a string. Finsemble's built in templating accepts and object. See <i>../src/components/notification/notification.html<i>.
+ * @param params
+ * @param params.maxCount Specifies the max number of notifications to display for specified identifier when frequency="MAX-COUNT" (default is 1).
+ * @param params.duration Time in milliseconds before auto-dismissing the notification (defaults to 24 hours).
+ *
+ * @example
+ * FSBL.UserNotification.alert("system", "ONCE-SINCE-STARTUP", "MANIFEST-Error", message);
+ * FSBL.UserNotification.alert("dev", "ALWAYS", "Config-Error", message, { duration: 1000 * 5 });
+ * FSBL.UserNotification.alert("dev", "MAX-COUNT", "Transport-Failure", message, { maxCount: 2 });
+ */
+export declare const toast: (topic: string, frequency: ToastFrequency, identifier: string, message: any, params?: ToastOptions) => void;
+declare const _default: {
+    toast: (topic: string, frequency: ToastFrequency, identifier: string, message: any, params?: ToastOptions | undefined) => void;
+    alert: (topic: string, frequency: ToastFrequency, identifier: string, message: any, params?: ToastOptions | undefined) => void;
+};
+export default _default;
+//# sourceMappingURL=toast.d.ts.map

package/common/toast.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toast.d.ts","sourceRoot":"","sources":["../../../src/common/toast.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,oBAAY,cAAc,GAAG,QAAQ,GAAG,oBAAoB,GAAG,WAAW,CAAC;AAE3E,oBAAY,YAAY,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,eAAO,MAAM,KAAK,UACV,MAAM,aACF,cAAc,cACb,MAAM,WACT,GAAG,WACH,YAAY,SAoDrB,CAAC;;;;;AAEF,wBAGE"}

package/common/toast.js

@@ -0,0 +1,88 @@
+/*!
+ * Copyright 2017 - 2020 by ChartIQ, Inc.
+ * All rights reserved.
+ */
+import { Logger } from "../clients/logger";
+import { System } from "./system";
+import SystemManagerClient from "./systemManagerClient";
+import { singleton } from "./Singleton";
+/**
+ * The controller keeps track of the number of times that particular
+ * notifications have been sent
+ */
+class ToastController {
+    constructor() {
+        this.alertOnceSinceStartUp = {};
+        this.alertCurrentCount = {};
+    }
+}
+/**
+ * Conditionally alerts the end user using a desktop notification (toast).
+ *
+ * In addition to the params specified here, params may also include any valid parameter for electron.Notification.
+ *
+ * Set topic = "devModeOnly" so that UserNotifications only are displayed when running from the seed or with SDD.
+ *
+ * @param topic Specifies a category for the notification. This parameter is reserved for future use; it is designed to filter notifications (e.g., applying regEx's defined in config to determine which notifications are displayed). Any topic string can be specified; however "system" is the recommended topic for system notifications applicable both to end uses and to developers. "dev" is the recommended topic for notifications applicable only during development (e.g., a notification that <i>config.json</i> has an illegal value).
+ * @param frequency Either "ALWAYS", "ONCE-SINCE-STARTUP", or "MAX-COUNT" to determine if alert should be displayed. Note, the frequencies are based on the number of notifications emitted from a window (as opposed to system wide).
+ * @param identifier Uniquely identifies this specific notification message. Used when "frequency" is set to "ONCE-SINCE-STARTUP" or "MAX-COUNT".
+ * @param message Message to display in the notification. Typically a string. Finsemble's built in templating accepts and object. See <i>../src/components/notification/notification.html<i>.
+ * @param params
+ * @param params.maxCount Specifies the max number of notifications to display for specified identifier when frequency="MAX-COUNT" (default is 1).
+ * @param params.duration Time in milliseconds before auto-dismissing the notification (defaults to 24 hours).
+ *
+ * @example
+ * FSBL.UserNotification.alert("system", "ONCE-SINCE-STARTUP", "MANIFEST-Error", message);
+ * FSBL.UserNotification.alert("dev", "ALWAYS", "Config-Error", message, { duration: 1000 * 5 });
+ * FSBL.UserNotification.alert("dev", "MAX-COUNT", "Transport-Failure", message, { maxCount: 2 });
+ */
+export const toast = (topic, frequency, identifier, message, params) => {
+    const controller = singleton("Toast", ToastController);
+    params = params || {};
+    let alertUser = false;
+    const key = `toast.${identifier}`;
+    const duration = params.duration || 1000 * 60 * 60 * 24;
+    switch (frequency) {
+        case "ONCE-SINCE-STARTUP": {
+            if (key in controller.alertOnceSinceStartUp) {
+                alertUser = false;
+            }
+            else {
+                // if no key then must be first time
+                alertUser = true;
+                controller.alertOnceSinceStartUp[key] = true;
+            }
+            break;
+        }
+        case "MAX-COUNT": {
+            let currentCount = 0;
+            const maxCount = params.maxCount || 1;
+            if (key in controller.alertCurrentCount) {
+                currentCount = controller.alertCurrentCount[key];
+            }
+            controller.alertCurrentCount[key] = ++currentCount; // increment and store
+            if (currentCount <= maxCount) {
+                alertUser = true;
+            }
+            break;
+        }
+        default: {
+            // default to "ALWAYS"
+            alertUser = true;
+        }
+    }
+    Logger.log("toast", topic, alertUser, frequency, identifier, message, params);
+    if (alertUser) {
+        const notifyObject = Object.assign(Object.assign({ message, timeout: duration }, params), { devModeOnly: topic === "devModeOnly" });
+        if (!notifyObject.title && topic === "devModeOnly") {
+            notifyObject.title = "Finsemble Developer Notification";
+        }
+        SystemManagerClient.systemLog({ notification: true }, `Notification: ${message}`);
+        System.Notification.send(notifyObject);
+    }
+};
+export default {
+    toast,
+    alert: toast,
+};
+//# sourceMappingURL=toast.js.map

package/common/toast.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toast.js","sourceRoot":"","sources":["../../../src/common/toast.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,MAAM,eAAe;IAArB;QACC,0BAAqB,GAAG,EAAE,CAAC;QAE3B,sBAAiB,GAAG,EAAE,CAAC;IACxB,CAAC;CAAA;AASD;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,MAAM,CAAC,MAAM,KAAK,GAAG,CACpB,KAAa,EACb,SAAyB,EACzB,UAAkB,EAClB,OAAY,EACZ,MAAqB,EACpB,EAAE;IACH,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACvD,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;IACtB,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,GAAG,GAAG,SAAS,UAAU,EAAE,CAAC;IAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IAExD,QAAQ,SAAS,EAAE;QAClB,KAAK,oBAAoB,CAAC,CAAC;YAC1B,IAAI,GAAG,IAAI,UAAU,CAAC,qBAAqB,EAAE;gBAC5C,SAAS,GAAG,KAAK,CAAC;aAClB;iBAAM;gBACN,oCAAoC;gBACpC,SAAS,GAAG,IAAI,CAAC;gBACjB,UAAU,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;aAC7C;YACD,MAAM;SACN;QACD,KAAK,WAAW,CAAC,CAAC;YACjB,IAAI,YAAY,GAAG,CAAC,CAAC;YACrB,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;YACtC,IAAI,GAAG,IAAI,UAAU,CAAC,iBAAiB,EAAE;gBACxC,YAAY,GAAG,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;aACjD;YACD,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,sBAAsB;YAC1E,IAAI,YAAY,IAAI,QAAQ,EAAE;gBAC7B,SAAS,GAAG,IAAI,CAAC;aACjB;YACD,MAAM;SACN;QACD,OAAO,CAAC,CAAC;YACR,sBAAsB;YACtB,SAAS,GAAG,IAAI,CAAC;SACjB;KACD;IAED,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9E,IAAI,SAAS,EAAE;QACd,MAAM,YAAY,iCACjB,OAAO,EACP,OAAO,EAAE,QAAQ,IAEd,MAAM,KACT,WAAW,EAAE,KAAK,KAAK,aAAa,GACpC,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,KAAK,KAAK,aAAa,EAAE;YACnD,YAAY,CAAC,KAAK,GAAG,kCAAkC,CAAC;SACxD;QACD,mBAAmB,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,iBAAiB,OAAO,EAAE,CAAC,CAAC;QAClF,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KACvC;AACF,CAAC,CAAC;AAEF,eAAe;IACd,KAAK;IACL,KAAK,EAAE,KAAK;CACZ,CAAC"}

package/common/util.d.ts

@@ -0,0 +1,137 @@
+import { WindowIdentifier, WindowDescriptor } from "../platform/services/window/types";
+import { FEAWindow } from "../FEA";
+/**
+ * Compresses or expands an object in the same manner as Array.flatMap();
+ *
+ * Requires a Record<string,any>. Do not pass empty or primitive objects.
+ *
+ * Usage:
+ * objectFlatMap(object, (key, value) => {
+        // Remove key/value pair
+        if(key === "goodbye") return [];
+        // Add key/value pair
+        if(key === "add") return [[key,value],[key2,value2]]
+        // Retain/replace key/value pair
+        return [[key,value]];
+    });
+ */
+export declare const objectFlatMap: (obj: Record<string, any>, func: (key: string, value: any) => [key: string, value: any][]) => {
+    [k: string]: any;
+};
+export declare function clone(from: any, to?: any): any;
+/**
+ * <h2>Finsemble Utility Functions</h2>
+ */
+export declare function isPercentage(val: any): boolean;
+/**
+ * Rounds number to n decimal places
+ */
+export declare const roundToDecimal: (num: number, decimal: number) => number;
+export declare function crossDomain(url: string): boolean;
+/**
+ * Returns a finWindow or null if not found
+ * @param  windowIdentifier A window identifier
+ * @param  cb Optional callback containing finWindow or null if not found (or use Promise)
+ * @return Promise that resolves to a finWindow or rejects if not found
+ */
+export declare function getFinWindow(windowIdentifier?: WindowIdentifier, cb?: (remoteWindow: FEAWindow | null) => void): Promise<FEAWindow>;
+/**
+ * Retrieves a windowDescriptor given a windowIdentifier
+ * @param windowIdentifier The window to locate. If empty then the current window is returned.
+ * @param cb Function to retrieve result (optional or use Promise)
+ * @return A promise that resolves to a WindowDescriptor
+ */
+export declare function getWindowDescriptor(windowIdentifier?: WindowIdentifier, cb?: (windowDescriptor: WindowDescriptor | null) => void): Promise<WindowDescriptor>;
+/**
+ * Returns a windowIdentifier for the current window
+ * @param cb Callback function returns windowIdentifier for this window (optional or use Promise)
+ * @returns A promise that resolves to a windowIdentifier
+ */
+export declare const getMyWindowIdentifier: (cb?: ((windowIdentifier: WindowIdentifier) => void) | undefined) => Promise<WindowIdentifier>;
+/**
+ * @returns Transforms an array of strings into a camel cased string.
+ * @memberof Utils
+ */
+export declare function camelCase(...args: string[]): string;
+export declare function isWindows(cb?: (osIsWindows: boolean) => void): Promise<boolean>;
+/**
+ * Calculates windowType for a newly spawned window
+ * windowType can be set or overwritten in many ways. The intention here is to end up with a limited set of
+ * final windowTypes
+ * @export
+ * @param config Object containing all possible values used to set windowTypes, some of these values may be unset depending on the execution path
+ */
+export declare function getWindowType(config: any): string;
+/**
+ * For the DOM element that has been passed in, this function returns a bounding box that is relative
+ * to the virtual monitor space. That is, it returns the position of the DOM element on the desktop.
+ * @param {HTMLElement|string} element A selector or HTMLElement
+ */
+export declare const getDesktopBoundingBox: (element: string | Element) => Promise<{
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+    right: number;
+    bottom: number;
+}>;
+export declare const isPointInBox: (point: {
+    x: number;
+    y: number;
+}, box: {
+    top: number;
+    left: number;
+    bottom?: number;
+    right?: number;
+    width: number;
+    height: number;
+}) => boolean;
+/**
+ * Returns (via callback) true if the mouse is currently located (hovering) over the requested element.
+ * @param element The element, or a selector, to check
+ * @param cb A function that returns a boolean
+ */
+export declare const isMouseOverDOMElement: (element: Element, cb?: Function) => Promise<boolean>;
+export declare const fastClone: (obj: any) => any;
+/** Returns exactly what's passed to it. Useful for higher-order functions. */
+export declare function identity<T>(arg: T): T;
+/**
+ * Wraps a callback accepting function in a promise. The callback must have the type
+ * specified in StandardCallback, and the wrapped function *MUST* call the callback
+ * on all possible code paths.
+ */
+export declare function promisify<T = any>(f: any, thisContext?: any): (...args: any[]) => Promise<T>;
+/**
+ * Creates a promise that rejects after the specified time with
+ * the given message.
+ */
+export declare function timeoutPromise(ms: any, message: string): Promise<unknown>;
+/**
+ * Wraps a promise in another promise that either rejects after the specified number of milliseconds
+ * or resolves with the result of the promise.
+ */
+export declare function wrapWithTimeout<T>(promise: Promise<T>, ms: number, message: string): Promise<T>;
+/**
+ * Deep equal doesn't work properly if the objects aren't exactly equal
+ * We have several places in the code that attach extra parameters to bounds objects
+ * This function will test equality on bounds for the only left, right, top, bottom, width and height
+ * @param {} bounds1
+ * @param {*} bounds2
+ */
+export declare function checkIfBoundsAreEqual(bounds1: any, bounds2: any): boolean;
+/**
+ * Uses set timeout to provide a mechanism like sleep. e.g. await sleep(1000). Can be used in conjunction with Promise.race to implement timeouts.
+ *
+ * @export
+ * @param {Number} ms number of milliseconds to wait for
+ * @param {Boolean} rejectPromise if true, will reject instead of resolving the promise
+ * @returns
+ */
+export declare function sleep(ms: any, rejectPromise?: boolean): Promise<unknown>;
+/**
+ * Like isEqual but Array order is ignored
+ * @param value1
+ * @param value2
+ */
+export declare const isEqualIgnoringArrayOrder: (value1: any, value2: any) => boolean;
+//# sourceMappingURL=util.d.ts.map

package/common/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/common/util.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAOnC;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,QACpB,OAAO,MAAM,EAAE,GAAG,CAAC,cACZ,MAAM,SAAS,GAAG;;CAC6C,CAAC;AAQ7E,wBAAgB,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,GAAE,GAAQ,GAAG,GAAG,CAsBlD;AAED;;GAEG;AAEH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAK9C;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,QAAS,MAAM,WAAW,MAAM,WAG1D,CAAC;AAEF,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAehD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC3B,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,EAAE,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,GAAG,IAAI,KAAK,IAAI,GAC3C,OAAO,CAAC,SAAS,CAAC,CA2CpB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAClC,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,EAAE,CAAC,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,KAAK,IAAI,GACtD,OAAO,CAAC,gBAAgB,CAAC,CAe3B;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,4BAA4B,gBAAgB,KAAK,IAAI,kBAAG,QAAQ,gBAAgB,CAqBjH,CAAC;AACF;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,UAS1C;AAED,wBAAsB,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAKrF;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,CAgDjD;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,YAAmB,MAAM,GAAG,OAAO;;;;;;;EA6BpE,CAAC;AAEF,eAAO,MAAM,YAAY,UACjB;IACN,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACV,OACI;IACJ,KAAK,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CACf,KACC,OAIF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,YAAmB,OAAO,OAAM,QAAQ,KAAwB,QAAQ,OAAO,CAMhH,CAAC;AAEF,eAAO,MAAM,SAAS,QAAS,GAAG,QAoBjC,CAAC;AAEF,8EAA8E;AAC9E,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAErC;AA8BD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,IAAI,OAAA,KAAK,OAAO,CAAC,CAAC,CAAC,CAQrF;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,EAAE,KAAA,EAAE,OAAO,EAAE,MAAM,oBAOjD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAE/F;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,KAAA,EAAE,OAAO,KAAA,WAMrD;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,EAAE,KAAA,EAAE,aAAa,UAAQ,oBAW9C;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,WAAY,GAAG,UAAU,GAAG,KAAG,OAQpE,CAAC"}