@finsemble/finsemble-ui 7.2.1 → 8.0.0-beta.1

package/common/redux/remoteReduxEnhancer.js

@@ -0,0 +1,202 @@
+import { LAUNCHER_SERVICE } from "../../common/constants";
+import { RouterClient } from "../../clients/routerClient";
+import { Logger } from "../../clients/logger";
+import { getModel } from "redux-loop";
+import { System } from "../system";
+/**
+ * Creates the client side of a remote redux.
+ * Exposes a store enhancer that will synchronize a copy of a slice of state.
+ * Initially used in the Interop Service and Linker UI.
+ *
+ * @param param.server fixed string "address"
+ * @param param.slice slice of state to observe and synchronize (i.e. rootState[slice])
+ */
+export const remoteReduxClientEnhancer = ({ server, slice }) => {
+    // Note: Detect disconnections from error-to-deliver messages on router; this is not 100% reliable if a window crashes or is killed by the OS
+    const remoteReduxEnhancer = (createStore) => (reducer, preloadedState) => {
+        const wrappedReducer = (state, action) => {
+            if (action.type === "@@finsemble/updateState") {
+                state = action.newState;
+            }
+            const newState = reducer(state, action);
+            return Object.assign({}, newState);
+        };
+        const store = createStore(wrappedReducer, preloadedState);
+        const enhancedStore = Object.assign(Object.assign({}, store), { dispatch: (action) => {
+                Logger.system.debug(`Interop.remote.${action.type}`, store, action);
+                if (action.type == "@@finsemble/updateState") {
+                    store.dispatch(action);
+                }
+                else if (action.type) {
+                    // Send actiom to remote store
+                    RouterClient.query(server, action);
+                    //store.dispatch(action);
+                }
+                else if (action.then) {
+                    action.then(store.dispatch);
+                }
+                return action;
+            } });
+        const routerChannel = `${Date.now()}_${Math.random()}`;
+        RouterClient.addListener(routerChannel, (error, message) => {
+            if (!error && message) {
+                const newState = message === null || message === void 0 ? void 0 : message.data;
+                const payload = { type: "@@finsemble/updateState", newState };
+                enhancedStore.dispatch(payload);
+            }
+        });
+        // Of all the ways to get windowName, this is the one that is available immediately vis a vis the preload
+        const windowName = System.Window.getCurrent().name;
+        RouterClient.query(server, {
+            "@@finsemble/action": "subscribe",
+            "@@finsemble/slice": slice,
+            "@@finsemble/routerChannel": routerChannel,
+            "@@finsemble/windowName": windowName,
+        }, () => { });
+        return enhancedStore;
+    };
+    return remoteReduxEnhancer;
+};
+/**
+ * Handles action requests from the remote client.
+ *
+ * "subscribe" - Subscribes the remote client to the requested slice. Changes to that slice are
+ * transmitted on the requested router channel, including an immediate initial broadcast of the
+ * current slice's state. The windowName is registered so that we stop transmitting after receiving
+ * a window close event for that window.
+ */
+const handleRemoteAction = ({ data, header, sliceSubscriptions, store, prevState, }) => {
+    var _a, _b;
+    const { "@@finsemble/action": action, "@@finsemble/slice": subscribeToSlice, "@@finsemble/routerChannel": routerChannel, "@@finsemble/windowName": windowName, } = data;
+    Logger.system.info(`remoteReduxServerEnhancer received ${action} for ${subscribeToSlice} from ${windowName}`);
+    if (action === "subscribe") {
+        sliceSubscriptions[subscribeToSlice] = ((_a = sliceSubscriptions[subscribeToSlice]) !== null && _a !== void 0 ? _a : []).concat({
+            windowName,
+            routerChannel,
+        });
+        const state = (_b = store.getState()) === null || _b === void 0 ? void 0 : _b[subscribeToSlice];
+        if (!prevState[subscribeToSlice])
+            prevState[subscribeToSlice] = state[subscribeToSlice];
+        RouterClient.transmit(routerChannel, state);
+    }
+    else {
+        Logger.system.warn(`remoteReduxServerEnhancer: Unexpected "@@finsemble/action"=${action} received from ${header.origin}`);
+    }
+};
+/**
+ * Handles dispatch requests from the remote client. Any valid dispatch (contains a "type" field) is
+ * accepted. All dispatches are modified to include the "@@remoteHeader" entry which can be used
+ * to debug within redux devtools.
+ */
+const handleDispatch = (data, header, dispatch) => {
+    if (!(data === null || data === void 0 ? void 0 : data.type)) {
+        Logger.system.warn(`remoteReduxServerEnhancer: Received invalid dispatch action. No "type" specified.`, data);
+        return;
+    }
+    dispatch(Object.assign(Object.assign({}, data), { "@@remoteHeader": {
+            header,
+        } }));
+};
+/**
+ * Starts the router listener and responder for a remoteReduxServerEnhancer. This code manages
+ * inbound subscriptions to store slices from clients as well as dispatches from those clients.
+ */
+const startInboundServerHandlers = ({ server, sliceSubscriptions, store, dispatch, prevState, }) => {
+    /**
+     * Listen for window closings. We'll stop transmitting store changes to closed windows.
+     */
+    RouterClient.addListener(LAUNCHER_SERVICE.WINDOW_CLOSED, (err, response) => {
+        if (err) {
+            Logger.system.error(`remoteReduxServerEnhancer: Error in listenForWindowClosings() ${err}`);
+        }
+        else {
+            const { name: windowName } = response === null || response === void 0 ? void 0 : response.data;
+            // Delete all sliceClientMap entries for the closed window
+            Object.keys(sliceSubscriptions).forEach((slice) => {
+                sliceSubscriptions[slice] = sliceSubscriptions[slice].filter((value) => value.windowName !== windowName);
+                if (!sliceSubscriptions[slice].length)
+                    delete sliceSubscriptions[slice];
+            });
+        }
+    });
+    /**
+     * Listen for incoming messages on our published `server` channel. Message types of
+     * `@@finsemble/action` will subscribe the listener to their requested slice.
+     * All other messages with a "type" will be dispatched to the local store.
+     */
+    RouterClient.addResponder(server, async (error, queryMessage) => {
+        if (error) {
+            Logger.system.error("remoteReduxServerEnhancer: Error adding responder.", error);
+            // Fatal error - the global channel is not available
+        }
+        else {
+            if (queryMessage) {
+                const { data, header } = queryMessage;
+                if (data["@@finsemble/action"])
+                    handleRemoteAction({ data, header, sliceSubscriptions, store, prevState });
+                else
+                    handleDispatch(data, header, dispatch);
+                queryMessage.sendQueryResponse(null);
+            }
+            else {
+                Logger.system.error("remoteReduxServerEnhancer: No queryMessage received from remote client");
+            }
+        }
+    });
+};
+/**
+ * Creates the server side of a remote redux. This enhancer should be added before DevTools.instrument().
+ *
+ * @param param.server string The router channel that this server should listen on
+ */
+export const remoteReduxServerEnhancer = ({ server }) => {
+    const remoteReduxEnhancer = (createStore) => (reducer) => {
+        Logger.system.info(`remoteReduxServerEnhancer: Starting on routerChannel ${server}`);
+        // These object _references_ must persist for the duration of the enhancer. handleRemoteAction
+        // maintains closure references to these object for analyzing state changes. Don't ever
+        // modify this code to replace them (NO! `sliceSubscriptions = { ...sliceSubscriptions }`)
+        let sliceSubscriptions = {};
+        let prevState = {};
+        /**
+         * The wrappedReducer injects logic to catch state changes and forward them to remote clients.
+         * For each run of the reducer, the sliceSubscriptions is iterated. Each slice is examined to
+         * determine if it has changed using deep equal. If the slice was changed, then the updated
+         * slice is transmitted to each of the subscribers.
+         */
+        const wrappedReducer = (state, action) => {
+            const newState = reducer(state, action);
+            Object.entries(sliceSubscriptions).forEach(([slice, clients]) => {
+                /**
+                 * Use reference equality to determine if the slice has changed. Actions on other slices
+                 * will not change any other slice's reference objects (due to redux's immutability) so
+                 * this code should result in transmits only when data downstream of the slice has changed.
+                 *
+                 * This is redux-loop compatible. `getModel()` will automatically convert loops into pure state
+                 * for transmission to the client.
+                 */
+                const actualState = getModel(newState);
+                if (actualState[slice] !== prevState[slice]) {
+                    prevState[slice] = actualState[slice];
+                    clients.forEach((client) => {
+                        RouterClient.transmit(client.routerChannel, actualState[slice]);
+                    });
+                }
+            });
+            return newState;
+        };
+        const store = createStore(wrappedReducer);
+        const enhancedStore = Object.assign(Object.assign({}, store), { 
+            // Pass through dispatch
+            dispatch: (action) => store.dispatch(action) });
+        startInboundServerHandlers({
+            server,
+            sliceSubscriptions,
+            store,
+            dispatch: enhancedStore.dispatch,
+            prevState,
+        });
+        return enhancedStore;
+    };
+    return remoteReduxEnhancer;
+};
+//# sourceMappingURL=remoteReduxEnhancer.js.map

package/common/redux/remoteReduxEnhancer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remoteReduxEnhancer.js","sourceRoot":"","sources":["../../../../src/common/redux/remoteReduxEnhancer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAkB,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAMnC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAuD,EAAE,EAAE;IACnH,6IAA6I;IAC7I,MAAM,mBAAmB,GACxB,CAAC,WAAW,EAAE,EAAE,CAChB,CAAkC,OAAsB,EAAE,cAAkC,EAAE,EAAE;QAC/F,MAAM,cAAc,GAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,MAAM,CAAC,IAAI,KAAK,yBAAyB,EAAE;gBAC9C,KAAK,GAAI,MAAc,CAAC,QAAQ,CAAC;aACjC;YACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACxC,yBACI,QAAQ,EACV;QACH,CAAC,CAAC;QAEF,MAAM,KAAK,GAAG,WAAW,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAC1D,MAAM,aAAa,mCACf,KAAK,KACR,QAAQ,EAAE,CAAC,MAAW,EAAE,EAAE;gBACzB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;gBACpE,IAAI,MAAM,CAAC,IAAI,IAAI,yBAAyB,EAAE;oBAC7C,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;iBACvB;qBAAM,IAAI,MAAM,CAAC,IAAI,EAAE;oBACvB,8BAA8B;oBAC9B,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBACnC,yBAAyB;iBACzB;qBAAM,IAAI,MAAM,CAAC,IAAI,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;iBAC5B;gBACD,OAAO,MAAM,CAAC;YACf,CAAC,GACD,CAAC;QAEF,MAAM,aAAa,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACvD,YAAY,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAC1D,IAAI,CAAC,KAAK,IAAI,OAAO,EAAE;gBACtB,MAAM,QAAQ,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;gBAC/B,MAAM,OAAO,GAAM,EAAE,IAAI,EAAE,yBAAyB,EAAE,QAAQ,EAAkB,CAAC;gBACjF,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;aAChC;QACF,CAAC,CAAC,CAAC;QAEH,yGAAyG;QACzG,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC;QAEnD,YAAY,CAAC,KAAK,CACjB,MAAM,EACN;YACC,oBAAoB,EAAE,WAAW;YACjC,mBAAmB,EAAE,KAAK;YAC1B,2BAA2B,EAAE,aAAa;YAC1C,wBAAwB,EAAE,UAAU;SACpC,EACD,GAAG,EAAE,GAAE,CAAC,CACR,CAAC;QAEF,OAAO,aAAa,CAAC;IACtB,CAAC,CAAC;IACH,OAAO,mBAAmB,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,kBAAkB,GAAG,CAAkC,EAC5D,IAAI,EACJ,MAAM,EACN,kBAAkB,EAClB,KAAK,EACL,SAAS,GAkBT,EAAE,EAAE;;IACJ,MAAM,EACL,oBAAoB,EAAE,MAAM,EAC5B,mBAAmB,EAAE,gBAAgB,EACrC,2BAA2B,EAAE,aAAa,EAC1C,wBAAwB,EAAE,UAAU,GACpC,GAAG,IAAI,CAAC;IACT,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,MAAM,QAAQ,gBAAgB,SAAS,UAAU,EAAE,CAAC,CAAC;IAC9G,IAAI,MAAM,KAAK,WAAW,EAAE;QAC3B,kBAAkB,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAA,kBAAkB,CAAC,gBAAgB,CAAC,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAC;YAC1F,UAAU;YACV,aAAa;SACb,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAA,KAAK,CAAC,QAAQ,EAAE,0CAAG,gBAAgB,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;YAAE,SAAS,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAExF,YAAY,CAAC,QAAQ,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;KAC5C;SAAM;QACN,MAAM,CAAC,MAAM,CAAC,IAAI,CACjB,8DAA8D,MAAM,kBAAkB,MAAM,CAAC,MAAM,EAAE,CACrG,CAAC;KACF;AACF,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc,GAAG,CACtB,IAAO,EACP,MAAmC,EACnC,QAA8B,EAC7B,EAAE;IACH,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,EAAE;QAChB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,mFAAmF,EAAE,IAAI,CAAC,CAAC;QAC9G,OAAO;KACP;IACD,QAAQ,iCACJ,IAAI,KACP,gBAAgB,EAAE;YACjB,MAAM;SACN,IACA,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,0BAA0B,GAAG,CAAkC,EACpE,MAAM,EACN,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,SAAS,GAaT,EAAE,EAAE;IACJ;;OAEG;IACH,YAAY,CAAC,WAAW,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;QAC1E,IAAI,GAAG,EAAE;YACR,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,iEAAiE,GAAG,EAAE,CAAC,CAAC;SAC5F;aAAM;YACN,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAC;YAC5C,0DAA0D;YAC1D,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjD,kBAAkB,CAAC,KAAK,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;gBACzG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,MAAM;oBAAE,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACzE,CAAC,CAAC,CAAC;SACH;IACF,CAAC,CAAC,CAAC;IAEH;;;;OAIG;IACH,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;QAC/D,IAAI,KAAK,EAAE;YACV,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oDAAoD,EAAE,KAAK,CAAC,CAAC;YACjF,oDAAoD;SACpD;aAAM;YACN,IAAI,YAAY,EAAE;gBACjB,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;gBACtC,IAAI,IAAI,CAAC,oBAAoB,CAAC;oBAC7B,kBAAkB,CAAO,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;;oBAC7E,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAC5C,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;aACrC;iBAAM;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,wEAAwE,CAAC,CAAC;aAC9F;SACD;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,EAAE,MAAM,EAAwC,EAAE,EAAE;IAC7F,MAAM,mBAAmB,GACxB,CAAC,WAAW,EAAE,EAAE,CAChB,CAAkC,OAAsB,EAAE,EAAE;QAC3D,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,wDAAwD,MAAM,EAAE,CAAC,CAAC;QAErF,8FAA8F;QAC9F,uFAAuF;QACvF,0FAA0F;QAC1F,IAAI,kBAAkB,GAAoE,EAAE,CAAC;QAC7F,IAAI,SAAS,GAAwB,EAAE,CAAC;QAExC;;;;;WAKG;QACH,MAAM,cAAc,GAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACvD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACxC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE;gBAC/D;;;;;;;mBAOG;gBACH,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACvC,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,KAAK,CAAC,EAAE;oBAC5C,SAAS,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;oBACtC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC1B,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;oBACjE,CAAC,CAAC,CAAC;iBACH;YACF,CAAC,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACjB,CAAC,CAAC;QAEF,MAAM,KAAK,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;QAC1C,MAAM,aAAa,mCACf,KAAK;YACR,wBAAwB;YACxB,QAAQ,EAAE,CAAC,MAAW,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GACjD,CAAC;QAEF,0BAA0B,CAAO;YAChC,MAAM;YACN,kBAAkB;YAClB,KAAK;YACL,QAAQ,EAAE,aAAa,CAAC,QAAQ;YAChC,SAAS;SACT,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACtB,CAAC,CAAC;IACH,OAAO,mBAAmB,CAAC;AAC5B,CAAC,CAAC"}

package/common/redux/types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Union of known server addresses for remote redux.
+ */
+export declare type RemoteReduxServerAddress = "@@finsemble/remoteRedux/InteropStore";
+export declare type ActionId = {
+    actionUniqueID: string;
+    type: string;
+};
+export declare type ActionResult = {
+    type: string;
+    result?: any;
+    error?: any;
+};
+//# sourceMappingURL=types.d.ts.map

package/common/redux/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/common/redux/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,wBAAwB,GAAG,sCAAsC,CAAC;AAE9E,oBAAY,QAAQ,GAAG;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,oBAAY,YAAY,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;CACZ,CAAC"}

package/common/redux/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/common/redux/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/common/redux/types.ts"],"names":[],"mappings":""}

package/common/system.d.ts

@@ -0,0 +1,309 @@
+/**
+ * Important note: These classes make use of "getters". Don't confuse these with function calls.
+ */
+import { SDServerInfo, MonitorInfo, VirtualScreenCoordinates } from "../FEA";
+import { StandardErrorCallback, Manifest, StandardPromise } from "../types";
+import { FEAWindow, NotificationOptions, FEAInfo } from "../FEA";
+declare class SystemWindow {
+    static createNew(params: any, cb: StandardErrorCallback<FEAWindow>): void;
+    static getCurrent(): FEAWindow;
+    static wrap(windowName: string): FEAWindow;
+}
+/**
+ * <h2>Clipboard</h2>
+ * @param {object} params
+ */
+declare class Clipboard {
+    constructor();
+    /**
+     * Write Text to Clipboard
+     */
+    static writeText(data: any, type: any, callback: any, errorCallback: any): void;
+    static writeHTML(data: any, type: any, callback: any, errorCallback: any): void;
+    static writeRTF(data: any, type: any, callback: any, errorCallback: any): void;
+    static readText(type: any, callback: any, errorCallback: any): void;
+    static readHTML(type: any, callback: any, errorCallback: any): void;
+    static readRTF(type: any, callback: any, errorCallback: any): void;
+}
+/**
+ * <h2>The Finsemble System API </h2>
+ * ----------
+ * The Finsemble System API is a set private and experimental of APIs for exposing operating system and electron-based functionality, including the clipboard, mouse position, monitor info, and others.
+ * @private
+ */
+export declare class System {
+    /**
+     * Application is deprecated. getCurrent().restart() continues to be used by LTS seed so this must
+     * stay until we can remove SDD permanently from seed.
+     *
+     * The other functions can be removed once clients are confirmed not to be using them.
+     */
+    static get Application(): {
+        getCurrent: () => {
+            restart: () => void;
+            getWindow: () => FEAWindow;
+            addEventListener: (type: any, listener: (event: any) => void, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            close: (force?: boolean, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getChildWindows: (callback?: ((children: FEAWindow[]) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getGroups: (callback?: ((groups: FEAWindow[][]) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getManifest: (callback?: ((manifest: Manifest) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getParentUuid: (callback?: ((uuid: string) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getInfo: (callback?: ((info: any) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            getTrayIconInfo: (callback?: ((trayInfo: any) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            isRunning: (callback?: ((running: boolean) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+            registerUser: (userName: string, appName: string, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            removeEventListener: (type: any, previouslyRegisteredListener: (event: any) => any, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            removeTrayIcon: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            run: (callback?: ((successObj: any) => void) | undefined, errorCallback?: ((reason: string, errorObj: any) => void) | undefined) => void;
+            scheduleRestart: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            setTrayIcon: (iconUrl: string, listener: {
+                [key: string]: Function;
+            }, callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            terminate: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            wait: (callback?: () => void, errorCallback?: ((reason: string) => void) | undefined) => void;
+            window: {
+                name: string;
+            };
+            uuid: string;
+        };
+    };
+    /**
+     * Determines if the current window was launched through finsemble, or is external or freestanding
+     * @private
+     * @returns boolean True if freestanding
+     */
+    static isFreestanding(): boolean;
+    /**
+     * Window
+     * @private
+     * @returns Window
+     */
+    static get Window(): typeof SystemWindow;
+    /**
+     * Notification
+     * @private
+     * @returns Notification
+     */
+    static get Notification(): {
+        send: (params: NotificationOptions) => void;
+    };
+    /**
+     * Clipboard
+     * @private
+     * @returns Clipboard
+     */
+    static get Clipboard(): typeof Clipboard;
+    static getManifest(cb?: (manifest: Manifest) => void): Promise<Manifest>;
+    /**
+     * (experimental) Gets current mouse position
+     * @experimental
+     * @param cb
+     */
+    static getMousePosition(cb?: StandardErrorCallback<VirtualScreenCoordinates>): Promise<VirtualScreenCoordinates>;
+    /**
+     * Deletes assets downloaded via the manifest's `appAssets` config
+     * @param alias - If set then delete that specific asset, otherwise delete them all
+     * @returns A golang style promise that resolves after the delete is complete
+     */
+    static deleteAssets(alias?: string | null): StandardPromise<void>;
+    /**
+     * Asynchronous method that passes the SmartDesktopDesigner's Server Information to the provided callback
+     * @private
+     * @returns Clipboard
+     */
+    static getSDServerInfo(cb?: Function): Promise<SDServerInfo>;
+    /**
+     * Get all monitors
+     * @private
+     * @param cb Callback with monitorInfo type
+     */
+    static getMonitorInfo(cb?: (monitorInfo: MonitorInfo) => void): Promise<MonitorInfo>;
+    /**
+     * Returns a boolean that is true when the webcontents are running within an electron browserView
+     * @private
+     * @returns boolean
+     */
+    static isBrowserView(): boolean;
+    /**
+     * Returns the BrowserViewId.  See  isBrowserView method.
+     * @private
+     * @returns number The browserViewId
+     * @deprecated use getWebContentsId
+     */
+    static getViewId(): number | null;
+    /**
+     * Returns the Electron WebContents ID for the current WebContents (view or window)
+     * @private
+     * @returns number The WebContents ID
+     */
+    static getWebContentsId(): number | null;
+    /**
+     * Does the current webcontents contain browserviews
+     * @deprecated - use isTitlebarWindow() instead
+     * @private
+     * @returns boolean True when the current webcontents are a browserwindow that contains associated browserviews
+     */
+    static hasBrowserView(): boolean;
+    /**
+     * Is the current webcontents a title bar shell
+     * @private
+     * @returns boolean True when the current webcontents is a title bar shell
+     */
+    static isTitlebarWindow(): boolean;
+    /**
+     * Returns the fin object
+     * @private
+     * @returns fin
+     */
+    static get fin(): import("../FEA").FEA;
+    /**
+     * Invokes optional callback and resolves promise when FEA is ready.
+     *
+     * @param {Function} [cb] Optional callback for system ready
+     * @private
+     * @returns Promise<void>
+     * @deprecated It is no longer necessary to wait on ready
+     */
+    static ready(cb?: () => void): Promise<void>;
+    /**
+     * Sets the icon for the system tray
+     * @param url The url of the icon to use in the system tray
+     */
+    static setTrayIcon(url: string, cb?: () => void): void;
+    /**
+     * Asynchronous method that passes the host specs of the system to the provided callback
+     * @private
+     * @param cb callback
+     */
+    static getHostSpecs(cb?: Function): Promise<any>;
+    /**
+     * Returns the InterApplicationBus
+     * @private
+     * @returns IAB
+     */
+    static get InterApplicationBus(): import("../FEA").FEAInterApplicationBus;
+    /**
+     * Launches an external application
+     * @private
+     */
+    static get launchExternalProcess(): (options: import("../FEA").ExternalProcessLaunchInfo, callback?: ((payload: {
+        uuid: string;
+    }) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Terminates an external application
+     * @private
+     */
+    static get terminateExternalProcess(): (processUuid: string, timeout: number, callback?: ((info: {
+        result: "failed" | "clean" | "terminated";
+    }) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Hard terminates Finsemble.
+     *
+     * (deprecated) Use `FSBL.shutdownApplication()`
+     * @private
+     */
+    static get exit(): (callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Clears finsemble cache
+     * @private
+     */
+    static get clearCache(): (options: import("../FEA").CacheOptions, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Shows the chromium developer tools for the current window
+     * @private
+     * @returns IAB
+     */
+    static get showDeveloperTools(): (name: string, isView?: number | boolean | null | undefined, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * Returns runtime information
+     * @private
+     * @returns RunTimeInfo
+     */
+    /**
+     * Adds an event listener
+     * @private
+     * @returns RunTimeInfo
+     */
+    static get addEventListener(): ({
+        <K extends keyof WindowEventMap>(type: K, listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions | undefined): void;
+        (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions | undefined): void;
+    } & typeof addEventListener) | ((type: "application-closed" | "application-crashed" | "application-created" | "application-started" | "apply-update-requested" | "desktop-icon-clicked" | "idle-state-changed" | "monitor-info-changed" | "new-window-created" | "session-changed" | "system-tray-click" | "system-tray-right-click" | "system-tray-mouse-enter" | "protocol-handler-triggered" | "log-fea", listener: (event: import("../FEA").SystemBaseEvent | import("../FEA").DesktopIconClickedEvent | import("../FEA").IdleStateChangedEvent | import("../FEA").MonitorInfoChangedEvent | import("../FEA").SessionChangedEvent | import("../FEA").ProtocolHandlerEvent) => void, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void);
+    static get addSelectClientCertificateListener(): () => any;
+    static get addCertificateErrorListener(): () => any;
+    static getFEAInfo(cb?: (info: FEAInfo) => void): Promise<FEAInfo>;
+    /**
+     * getVersion
+     * @private
+     * @deprecated Use getFEAInfo instead.
+     * @returns getVersion function
+     */
+    static get getVersion(): (callback?: ((version: string) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * getUpdateAvailable
+     * @private
+     * @returns getUpdateAvailable function
+     */
+    static get getUpdateAvailable(): (cb: (isUpdateAvailable: boolean) => void) => void;
+    /**
+     * (deprecated) Opens website with external browser
+     * @returns openUrlWithBrowser function
+     */
+    static get openUrlWithBrowser(): (url: string, callback?: (() => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * getProcessList
+     * @private
+     * @returns getProcessList function
+     */
+    static get getProcessList(): (callback?: ((processInfoList: import("../FEA").Metric[]) => void) | undefined, errorCallback?: ((reason: string) => void) | undefined) => void;
+    /**
+     * getProtocolString
+     * @private
+     * @returns getProtocolString function
+     */
+    static get getProtocolString(): (cb?: ((data: string) => void) | undefined) => Promise<string>;
+    /**
+     * hideSplashScreen
+     * @private
+     * @returns hideSplashScreen function
+     */
+    static get hideSplashScreen(): () => void;
+    /**
+     * notifyLoggerReady
+     * @private
+     */
+    static notifyLoggerReady(): void;
+    /**
+     * updateCentralLoggerState
+     * @private
+     */
+    static updateCentralLoggerState(loggerState: any): void;
+    /**
+     * Performs handshake with FEA to indicate the primary application started successfully
+     * @private
+     */
+    static startupApplicationHandshake(): void;
+    /**
+     * Hard terminates the application.
+     * This is called only by Finsemble's ShutdownManager to stop the entire application
+     * after it has gracefully closed services. Do not call this directly. Use `FSBL.shutdownApplication()`.
+     * @private
+     */
+    static terminate(): void;
+    /**
+     * Hard resets the application.
+     * This is called only by Finsemble's ShutdownManager to restart the entire application
+     * after it has gracefully closed services. Do not call this directly. Use `FSBL.restartApplication()`.
+     * @private
+     */
+    static restart(): void;
+    /**
+     * Gets an environment variable by name
+     * @param envVar The name of the environment variable to fetch
+     * @param cb the optional callback
+     * @returns a Promise that resolves to the environment variable value
+     * @private
+     */
+    static getEnvironmentVariable(envVar: string, cb?: (variable: string) => void): Promise<string>;
+}
+export {};
+//# sourceMappingURL=system.d.ts.map

package/common/system.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../../src/common/system.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAG7E,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAiB,mBAAmB,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAIhF,cAAM,YAAY;IACjB,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,qBAAqB,CAAC,SAAS,CAAC;IAIlE,MAAM,CAAC,UAAU;IAIjB,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS;CAG1C;AA8CD;;;GAGG;AACH,cAAM,SAAS;;IAKd;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAKpD,MAAM,CAAC,SAAS,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAKpD,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAKnD,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAK7C,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;IAK7C,MAAM,CAAC,OAAO,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,EAAE,aAAa,KAAA;CAI5C;AAED;;;;;GAKG;AACH,qBAAa,MAAM;IAClB;;;;;OAKG;IACH,MAAM,KAAK,WAAW;;;;qCAUX,GAAG,oBACS,GAAG,KAAK,IAAI,aACnB,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;4BAIzB,OAAO,aAAa,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;qDAGhD,SAAS,EAAE,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;6CAGtE,SAAS,EAAE,EAAE,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;iDAG5D,QAAQ,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;+CAG7D,MAAM,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;yCAG/D,GAAG,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;qDAG1C,GAAG,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;8CAG7D,OAAO,KAAK,IAAI,yCAA2B,MAAM,KAAK,IAAI;qCAIhF,MAAM,WACP,MAAM,aACJ,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;wCAKlC,GAAG,wCAC6B,GAAG,KAAK,GAAG,aACtC,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;wCAIb,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;2CAGlD,GAAG,KAAK,IAAI,yCAA2B,MAAM,YAAY,GAAG,KAAK,IAAI;yCACtE,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;mCAIvE,MAAM;;0BAEJ,MAAM,IAAI,4BACI,MAAM,KAAK,IAAI;mCAIlB,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;8BAGzD,MAAM,IAAI,4BAA2B,MAAM,KAAK,IAAI;;;;;;MAUzE;IAED;;;;OAIG;IACH,MAAM,CAAC,cAAc;IAIrB;;;;OAIG;IACH,MAAM,KAAK,MAAM,wBAEhB;IAED;;;;OAIG;IACH,MAAM,KAAK,YAAY;uBAEN,mBAAmB;MAInC;IAED;;;;OAIG;IACH,MAAM,KAAK,SAAS,qBAEnB;IAED,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;IASxE;;;;OAIG;WACU,gBAAgB,CAC5B,EAAE,CAAC,EAAE,qBAAqB,CAAC,wBAAwB,CAAC,GAClD,OAAO,CAAC,wBAAwB,CAAC;IAiBpC;;;;OAIG;WACU,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;IAIvE;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,EAAE,WAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IAStE;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IASpF;;;;OAIG;IACH,MAAM,CAAC,aAAa;IAIpB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,IAAI,MAAM,GAAG,IAAI;IAKjC;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,IAAI,MAAM,GAAG,IAAI;IAIxC;;;;;OAKG;IACH,MAAM,CAAC,cAAc;IAKrB;;;;OAIG;IACH,MAAM,CAAC,gBAAgB;IAIvB;;;;OAIG;IACH,MAAM,KAAK,GAAG,yBAEb;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI;IAS5B;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IAItD;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,EAAE,WAAqB;IAS3C;;;;OAIG;IACH,MAAM,KAAK,mBAAmB,4CAE7B;IAED;;;OAGG;IACH,MAAM,KAAK,qBAAqB;;6FAE/B;IAED;;;OAGG;IACH,MAAM,KAAK,wBAAwB;;6FAElC;IAED;;;;;OAKG;IACH,MAAM,KAAK,IAAI,0GAEd;IAED;;;OAGG;IACH,MAAM,KAAK,UAAU,kJAEpB;IAED;;;;OAIG;IACH,MAAM,KAAK,kBAAkB,sKAE5B;IAED;;;;OAIG;IACH;;;;OAIG;IACH,MAAM,KAAK,gBAAgB;;;kwBAO1B;IAED,MAAM,KAAK,kCAAkC,cAE5C;IAED,MAAM,KAAK,2BAA2B,cAErC;IAED,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IASjE;;;;;OAKG;IACH,MAAM,KAAK,UAAU,yHAEpB;IAED;;;;OAIG;IACH,MAAM,KAAK,kBAAkB,uDAE5B;IAED;;;OAGG;IACH,MAAM,KAAK,kBAAkB,uHAE5B;IAED;;;;OAIG;IACH,MAAM,KAAK,cAAc,oJAExB;IAED;;;;OAIG;IACH,MAAM,KAAK,iBAAiB,mEAE3B;IAED;;;;OAIG;IACH,MAAM,KAAK,gBAAgB,eAE1B;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB;IAIxB;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,WAAW,EAAE,GAAG;IAIhD;;;OAGG;IACH,MAAM,CAAC,2BAA2B;IAMlC;;;;;OAKG;IACH,MAAM,CAAC,SAAS;IAIhB;;;;;OAKG;IACH,MAAM,CAAC,OAAO;IAId;;;;;;OAMG;IACH,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;CAQ/F"}