@finsemble/finsemble-ui 1.0.0-beta-1

package/react/hooks/useHotkey.js

@@ -0,0 +1,22 @@
+import { useDeepEffect } from "./useDeepEffect";
+/**
+ * This hook can be used to register a global hotkey. It makes use of Finsemble's HotkeyClient API.
+ *
+ * @param keyCombination [Array<string>] - A hotkey Combination. If null or undefined then no operation will occur.
+ * @param action Function - The function to call when the hotkey combination is pressed.
+ */
+export const useHotkey = (keyCombination, action) => {
+    // We use a deep effect comparison because we expect arrays to be passed in.
+    // React's useEffect() hook only performs shallow comparisons. We use the literal ["escape"] which would trigger an effect with every render.
+    // useDeepEffect() is a custom hook that will compare the *contents* of the arrays. This way, two literal instances will still be perceived by React as identical.
+    useDeepEffect(() => {
+        let actionIsAFunction = typeof action === "function";
+        if (!actionIsAFunction)
+            console.error("useHotkey() invalid parameters: action is not a function");
+        keyCombination && actionIsAFunction && FSBL.Clients.HotkeyClient.addGlobalHotkey(keyCombination, action);
+        return function cleanup() {
+            keyCombination && actionIsAFunction && FSBL.Clients.HotkeyClient.removeGlobalHotkey(keyCombination, action);
+        };
+    }, [keyCombination, action]);
+};
+//# sourceMappingURL=useHotkey.js.map

package/react/hooks/useHotkey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHotkey.js","sourceRoot":"","sources":["../../src/hooks/useHotkey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,cAAoD,EAAE,MAAgB,EAAE,EAAE;IACnG,4EAA4E;IAC5E,6IAA6I;IAC7I,kKAAkK;IAElK,aAAa,CAAC,GAAG,EAAE;QAClB,IAAI,iBAAiB,GAAG,OAAO,MAAM,KAAK,UAAU,CAAC;QACrD,IAAI,CAAC,iBAAiB;YAAE,OAAO,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAClG,cAAc,IAAI,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QACzG,OAAO,SAAS,OAAO;YACtB,cAAc,IAAI,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAC7G,CAAC,CAAC;IACH,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;AAC9B,CAAC,CAAC","sourcesContent":["import { useDeepEffect } from \"./useDeepEffect\";\nimport { HotkeyCombination } from \"../types/hotkeyTypes\";\n\n/**\n * This hook can be used to register a global hotkey. It makes use of Finsemble's HotkeyClient API.\n *\n * @param keyCombination [Array<string>] - A hotkey Combination. If null or undefined then no operation will occur.\n * @param action Function - The function to call when the hotkey combination is pressed.\n */\nexport const useHotkey = (keyCombination: HotkeyCombination | undefined | null, action: Function) => {\n\t// We use a deep effect comparison because we expect arrays to be passed in.\n\t// React's useEffect() hook only performs shallow comparisons. We use the literal [\"escape\"] which would trigger an effect with every render.\n\t// useDeepEffect() is a custom hook that will compare the *contents* of the arrays. This way, two literal instances will still be perceived by React as identical.\n\n\tuseDeepEffect(() => {\n\t\tlet actionIsAFunction = typeof action === \"function\";\n\t\tif (!actionIsAFunction) console.error(\"useHotkey() invalid parameters: action is not a function\");\n\t\tkeyCombination && actionIsAFunction && FSBL.Clients.HotkeyClient.addGlobalHotkey(keyCombination, action);\n\t\treturn function cleanup() {\n\t\t\tkeyCombination && actionIsAFunction && FSBL.Clients.HotkeyClient.removeGlobalHotkey(keyCombination, action);\n\t\t};\n\t}, [keyCombination, action]);\n};\n"]}

package/react/hooks/useLinker.d.ts

@@ -0,0 +1,4 @@
+export declare const useLinker: () => {
+    state: import("../reducers/linkerReducer").LinkerState;
+    toggleChannel: (channelId: number) => void;
+};

package/react/hooks/useLinker.js

@@ -0,0 +1,110 @@
+import { useDispatch, useSelector } from "../store";
+import { useEffect } from "react";
+import { LinkerActions } from "../actions/linkerActions";
+import { MAXIMUM_ALLOWED_ACTIVE_CHANNELS } from "../types/linkerTypes";
+// Encapsulate the linker initialization and Redux dispatch functions inside the hook
+export const useLinker = () => {
+    const dispatch = useDispatch();
+    const linkerState = useSelector((state) => state.linker);
+    const hideWindow = () => {
+        // Must blur or you end up having to click twice to show the window.
+        // If you just hide, the first time the user clicks
+        // on the linker button, the blur will trigger, which will hide the window.
+        finsembleWindow.blur();
+        finsembleWindow.hide();
+    };
+    useEffect(() => {
+        const setInitialChannels = () => {
+            const channels = FSBL.Clients.LinkerClient.getAllChannels();
+            dispatch(LinkerActions.SET_CHANNELS({ channels }));
+        };
+        const focusWindow = () => {
+            finsembleWindow.focus();
+        };
+        const initAccessibleLinkerMode = () => {
+            const accessibilityCallback = (err, value) => {
+                if (err) {
+                    FSBL.Clients.Logger.system.error(`Failed to get accessibleLinker value: ${err}`);
+                    return;
+                }
+                dispatch(LinkerActions.SET_ACCESSIBILITY({
+                    isAccessibleLinker: Boolean(value),
+                }));
+            };
+            FSBL.Clients.ConfigClient.getValue("finsemble.accessibleLinker", accessibilityCallback);
+        };
+        /** If user switches the linker channel for different components, this function would be invoked. It will dispatch another
+         *  action to update the linker's state according to the linker setup on the switched component.
+         *
+         * @param err  error from FSBL
+         * @param msg  msg from FSBL
+         */
+        const onActiveChannelsChanged = (err, msg) => {
+            const componentLinkerState = FSBL.Clients.LinkerClient.getState(msg.data.windowIdentifier);
+            if (err) {
+                FSBL.Clients.Logger.system.error("Failed to update the linker state.");
+                return;
+            }
+            dispatch(LinkerActions.UPDATE_ACTIVE_CHANNELS({
+                channelNames: componentLinkerState.channels,
+                windowIdentifier: msg.data.windowIdentifier,
+            }));
+            msg.sendQueryResponse(null, null);
+        };
+        FSBL.Clients.Logger.system.log("Linker component is mounted. Initializing.");
+        finsembleWindow.addEventListener("blurred", hideWindow);
+        finsembleWindow.addEventListener("shown", focusWindow);
+        setInitialChannels();
+        initAccessibleLinkerMode();
+        FSBL.Clients.RouterClient.addResponder("Finsemble.LinkerWindow.SetActiveChannels", onActiveChannelsChanged);
+        return () => {
+            FSBL.Clients.Logger.system.log("Linker component is unmounted. Cleaning up the event listeners.");
+            finsembleWindow.removeEventListener("blurred", hideWindow);
+            finsembleWindow.removeEventListener("shown", focusWindow);
+            FSBL.Clients.RouterClient.removeResponder("Finsemble.LinkerWindow.SetActiveChannels");
+        };
+    }, []);
+    useEffect(() => {
+        FSBL.Clients.WindowClient.fitToDOM();
+    }, [linkerState]);
+    const toggleChannel = (channelId) => {
+        const channel = linkerState.channels[channelId];
+        if (!channel) {
+            FSBL.Clients.Logger.system.error("Targeted channel to toggle is not found.");
+            return;
+        }
+        const channelName = channel.name;
+        const channelActive = channel.active;
+        const { windowIdentifier } = linkerState;
+        const updateActivationTo = (isActive) => (err) => {
+            if (err) {
+                FSBL.Clients.Logger.system.error("Error in linkerHook, linkCallback", err);
+                return;
+            }
+            dispatch(LinkerActions.UPDATE_CHANNEL_STATUS({
+                channelId,
+                active: isActive,
+            }));
+        };
+        const numberOfActiveChannels = Object.values(linkerState.channels).filter((c) => c === null || c === void 0 ? void 0 : c.active).length;
+        // We're activating if the channel is currently inactive
+        const activating = !channelActive;
+        const deactivating = channelActive;
+        const allowedToActivateAnotherChannel = numberOfActiveChannels < MAXIMUM_ALLOWED_ACTIVE_CHANNELS;
+        // if we're toggling a channel to be inactive OR
+        // we're trying to toggle one to be active AND we have not hit our maximum,
+        // let the call go through. Otherwise log an error.
+        if (deactivating) {
+            FSBL.Clients.LinkerClient.unlinkFromChannel(channelName, windowIdentifier, updateActivationTo(false));
+        }
+        else if (activating && allowedToActivateAnotherChannel) {
+            FSBL.Clients.LinkerClient.linkToChannel(channelName, windowIdentifier, updateActivationTo(true));
+        }
+        else {
+            FSBL.Clients.Logger.system.error(`Attempted to toggle more than ${MAXIMUM_ALLOWED_ACTIVE_CHANNELS} channels. This could result in an unacceptable UX. Please contact finsemble support if you would like to render more than ${MAXIMUM_ALLOWED_ACTIVE_CHANNELS} linker channels in the window title bar.`);
+        }
+        hideWindow();
+    };
+    return { state: linkerState, toggleChannel };
+};
+//# sourceMappingURL=useLinker.js.map

package/react/hooks/useLinker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLinker.js","sourceRoot":"","sources":["../../src/hooks/useLinker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAW,+BAA+B,EAAE,MAAM,sBAAsB,CAAC;AAIhF,qFAAqF;AACrF,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,EAAE;IAC7B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzD,MAAM,UAAU,GAAG,GAAG,EAAE;QACvB,oEAAoE;QACpE,mDAAmD;QACnD,2EAA2E;QAC3E,eAAe,CAAC,IAAI,EAAE,CAAC;QACvB,eAAe,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACd,MAAM,kBAAkB,GAAG,GAAG,EAAE;YAC/B,MAAM,QAAQ,GAAc,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;YACvE,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC;QAEF,MAAM,WAAW,GAAG,GAAG,EAAE;YACxB,eAAe,CAAC,KAAK,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF,MAAM,wBAAwB,GAAG,GAAG,EAAE;YACrC,MAAM,qBAAqB,GAAG,CAAC,GAAQ,EAAE,KAAU,EAAE,EAAE;gBACtD,IAAI,GAAG,EAAE;oBACR,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAyC,GAAG,EAAE,CAAC,CAAC;oBACjF,OAAO;iBACP;gBAED,QAAQ,CACP,aAAa,CAAC,iBAAiB,CAAC;oBAC/B,kBAAkB,EAAE,OAAO,CAAC,KAAK,CAAC;iBAClC,CAAC,CACF,CAAC;YACH,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,4BAA4B,EAAE,qBAAqB,CAAC,CAAC;QACzF,CAAC,CAAC;QAEF;;;;;WAKG;QACH,MAAM,uBAAuB,GAAG,CAAC,GAAQ,EAAE,GAAQ,EAAE,EAAE;YACtD,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAE3F,IAAI,GAAG,EAAE;gBACR,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBACvE,OAAO;aACP;YAED,QAAQ,CACP,aAAa,CAAC,sBAAsB,CAAC;gBACpC,YAAY,EAAE,oBAAoB,CAAC,QAAQ;gBAC3C,gBAAgB,EAAE,GAAG,CAAC,IAAI,CAAC,gBAAgB;aAC3C,CAAC,CACF,CAAC;YAEF,GAAG,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;QAC7E,eAAe,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACxD,eAAe,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACvD,kBAAkB,EAAE,CAAC;QACrB,wBAAwB,EAAE,CAAC;QAC3B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,0CAA0C,EAAE,uBAAuB,CAAC,CAAC;QAE5G,OAAO,GAAG,EAAE;YACX,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,iEAAiE,CAAC,CAAC;YAClG,eAAe,CAAC,mBAAmB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC3D,eAAe,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC1D,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,0CAA0C,CAAC,CAAC;QACvF,CAAC,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IACtC,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,EAAE;QAC3C,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,EAAE;YACb,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAC7E,OAAO;SACP;QACD,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;QACjC,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;QACrC,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC;QAEzC,MAAM,kBAAkB,GAAG,CAAC,QAAiB,EAAE,EAAE,CAAC,CAAC,GAAQ,EAAE,EAAE;YAC9D,IAAI,GAAG,EAAE;gBACR,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;gBAC3E,OAAO;aACP;YAED,QAAQ,CACP,aAAa,CAAC,qBAAqB,CAAC;gBACnC,SAAS;gBACT,MAAM,EAAE,QAAQ;aAChB,CAAC,CACF,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM,CAAC,CAAC,MAAM,CAAC;QAEnG,wDAAwD;QACxD,MAAM,UAAU,GAAG,CAAC,aAAa,CAAC;QAClC,MAAM,YAAY,GAAG,aAAa,CAAC;QACnC,MAAM,+BAA+B,GAAG,sBAAsB,GAAG,+BAA+B,CAAC;QACjG,gDAAgD;QAChD,2EAA2E;QAC3E,mDAAmD;QACnD,IAAI,YAAY,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;SACtG;aAAM,IAAI,UAAU,IAAI,+BAA+B,EAAE;YACzD,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,WAAW,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;SACjG;aAAM;YACN,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAC/B,iCAAiC,+BAA+B,8HAA8H,+BAA+B,2CAA2C,CACxQ,CAAC;SACF;QACD,UAAU,EAAE,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;AAC9C,CAAC,CAAC","sourcesContent":["import { useDispatch, useSelector } from \"../store\";\nimport { useEffect } from \"react\";\nimport { LinkerActions } from \"../actions/linkerActions\";\nimport { Channel, MAXIMUM_ALLOWED_ACTIVE_CHANNELS } from \"../types/linkerTypes\";\n\ndeclare const finsembleWindow: any;\n\n// Encapsulate the linker initialization and Redux dispatch functions inside the hook\nexport const useLinker = () => {\n\tconst dispatch = useDispatch();\n\tconst linkerState = useSelector((state) => state.linker);\n\n\tconst hideWindow = () => {\n\t\t// Must blur or you end up having to click twice to show the window.\n\t\t// If you just hide, the first time the user clicks\n\t\t// on the linker button, the blur will trigger, which will hide the window.\n\t\tfinsembleWindow.blur();\n\t\tfinsembleWindow.hide();\n\t};\n\n\tuseEffect(() => {\n\t\tconst setInitialChannels = () => {\n\t\t\tconst channels: Channel[] = FSBL.Clients.LinkerClient.getAllChannels();\n\t\t\tdispatch(LinkerActions.SET_CHANNELS({ channels }));\n\t\t};\n\n\t\tconst focusWindow = () => {\n\t\t\tfinsembleWindow.focus();\n\t\t};\n\n\t\tconst initAccessibleLinkerMode = () => {\n\t\t\tconst accessibilityCallback = (err: any, value: any) => {\n\t\t\t\tif (err) {\n\t\t\t\t\tFSBL.Clients.Logger.system.error(`Failed to get accessibleLinker value: ${err}`);\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tdispatch(\n\t\t\t\t\tLinkerActions.SET_ACCESSIBILITY({\n\t\t\t\t\t\tisAccessibleLinker: Boolean(value),\n\t\t\t\t\t})\n\t\t\t\t);\n\t\t\t};\n\t\t\tFSBL.Clients.ConfigClient.getValue(\"finsemble.accessibleLinker\", accessibilityCallback);\n\t\t};\n\n\t\t/** If user switches the linker channel for different components, this function would be invoked. It will dispatch another\n\t\t *  action to update the linker's state according to the linker setup on the switched component.\n\t\t *\n\t\t * @param err  error from FSBL\n\t\t * @param msg  msg from FSBL\n\t\t */\n\t\tconst onActiveChannelsChanged = (err: any, msg: any) => {\n\t\t\tconst componentLinkerState = FSBL.Clients.LinkerClient.getState(msg.data.windowIdentifier);\n\n\t\t\tif (err) {\n\t\t\t\tFSBL.Clients.Logger.system.error(\"Failed to update the linker state.\");\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tdispatch(\n\t\t\t\tLinkerActions.UPDATE_ACTIVE_CHANNELS({\n\t\t\t\t\tchannelNames: componentLinkerState.channels,\n\t\t\t\t\twindowIdentifier: msg.data.windowIdentifier,\n\t\t\t\t})\n\t\t\t);\n\n\t\t\tmsg.sendQueryResponse(null, null);\n\t\t};\n\n\t\tFSBL.Clients.Logger.system.log(\"Linker component is mounted. Initializing.\");\n\t\tfinsembleWindow.addEventListener(\"blurred\", hideWindow);\n\t\tfinsembleWindow.addEventListener(\"shown\", focusWindow);\n\t\tsetInitialChannels();\n\t\tinitAccessibleLinkerMode();\n\t\tFSBL.Clients.RouterClient.addResponder(\"Finsemble.LinkerWindow.SetActiveChannels\", onActiveChannelsChanged);\n\n\t\treturn () => {\n\t\t\tFSBL.Clients.Logger.system.log(\"Linker component is unmounted. Cleaning up the event listeners.\");\n\t\t\tfinsembleWindow.removeEventListener(\"blurred\", hideWindow);\n\t\t\tfinsembleWindow.removeEventListener(\"shown\", focusWindow);\n\t\t\tFSBL.Clients.RouterClient.removeResponder(\"Finsemble.LinkerWindow.SetActiveChannels\");\n\t\t};\n\t}, []);\n\n\tuseEffect(() => {\n\t\tFSBL.Clients.WindowClient.fitToDOM();\n\t}, [linkerState]);\n\n\tconst toggleChannel = (channelId: number) => {\n\t\tconst channel = linkerState.channels[channelId];\n\t\tif (!channel) {\n\t\t\tFSBL.Clients.Logger.system.error(\"Targeted channel to toggle is not found.\");\n\t\t\treturn;\n\t\t}\n\t\tconst channelName = channel.name;\n\t\tconst channelActive = channel.active;\n\t\tconst { windowIdentifier } = linkerState;\n\n\t\tconst updateActivationTo = (isActive: boolean) => (err: any) => {\n\t\t\tif (err) {\n\t\t\t\tFSBL.Clients.Logger.system.error(\"Error in linkerHook, linkCallback\", err);\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tdispatch(\n\t\t\t\tLinkerActions.UPDATE_CHANNEL_STATUS({\n\t\t\t\t\tchannelId,\n\t\t\t\t\tactive: isActive,\n\t\t\t\t})\n\t\t\t);\n\t\t};\n\n\t\tconst numberOfActiveChannels = Object.values(linkerState.channels).filter((c) => c?.active).length;\n\n\t\t// We're activating if the channel is currently inactive\n\t\tconst activating = !channelActive;\n\t\tconst deactivating = channelActive;\n\t\tconst allowedToActivateAnotherChannel = numberOfActiveChannels < MAXIMUM_ALLOWED_ACTIVE_CHANNELS;\n\t\t// if we're toggling a channel to be inactive OR\n\t\t// we're trying to toggle one to be active AND we have not hit our maximum,\n\t\t// let the call go through. Otherwise log an error.\n\t\tif (deactivating) {\n\t\t\tFSBL.Clients.LinkerClient.unlinkFromChannel(channelName, windowIdentifier, updateActivationTo(false));\n\t\t} else if (activating && allowedToActivateAnotherChannel) {\n\t\t\tFSBL.Clients.LinkerClient.linkToChannel(channelName, windowIdentifier, updateActivationTo(true));\n\t\t} else {\n\t\t\tFSBL.Clients.Logger.system.error(\n\t\t\t\t`Attempted to toggle more than ${MAXIMUM_ALLOWED_ACTIVE_CHANNELS} channels. This could result in an unacceptable UX. Please contact finsemble support if you would like to render more than ${MAXIMUM_ALLOWED_ACTIVE_CHANNELS} linker channels in the window title bar.`\n\t\t\t);\n\t\t}\n\t\thideWindow();\n\t};\n\n\treturn { state: linkerState, toggleChannel };\n};\n"]}

package/react/hooks/useMenu.d.ts

@@ -0,0 +1,39 @@
+declare type MenuHook = {
+    /**
+     * The Id of the menu that is currently open
+     *
+     * @type {string | null}
+     */
+    openMenuId: string | null;
+    /**
+     * Dispatches a TOGGLE_MENU action, which should cause the menu to close if it is open, or to open if it is closed.
+     */
+    toggleMenu: () => void;
+    /**
+     * Dispatches a CLOSE_MENU action, which should cause the menu to close if it is open.
+     */
+    closeMenu: () => void;
+    /**
+     * Dispatches a CLOSE_MENU action after a timeout (DURATION in ms). See description in useMenu comments.
+     */
+    blurMenu: () => void;
+    /**
+     * Dispatches a OPEN_MENU action, which should cause the menu to open if it is closed.
+     */
+    openMenu: () => void;
+    /**
+     * Returns true if the id of the menu matches the currently active menu
+     * @return boolean - Returns true if the menu is active
+     */
+    isMenuActive: () => boolean;
+};
+/**
+ * A hook for working with menus. It gets its implicit menu "id" from React context.
+ * It dispatches actions to the reducer to modify menu state across MenuShell instances.
+ *
+ * See menuReducer.ts for "toggle/blur" race condition algorithm
+ *
+ * Setting window.FSBL.debug=true will override menu close on blur, to make it easier to debug windows
+ */
+export declare const useMenu: () => MenuHook;
+export {};

package/react/hooks/useMenu.js

@@ -0,0 +1,50 @@
+import { useDispatch, useSelector } from "../store";
+import { MenuActions } from "../actions/menuActions";
+import { useCallback, useContext } from "react";
+import { MenuContext } from "../components/menu/menuContext";
+/**
+ * A hook for working with menus. It gets its implicit menu "id" from React context.
+ * It dispatches actions to the reducer to modify menu state across MenuShell instances.
+ *
+ * See menuReducer.ts for "toggle/blur" race condition algorithm
+ *
+ * Setting window.FSBL.debug=true will override menu close on blur, to make it easier to debug windows
+ */
+export const useMenu = () => {
+    const DURATION = 120;
+    const dispatch = useDispatch();
+    const { openMenuId } = useSelector((state) => state.menu);
+    const { thisMenuId } = useContext(MenuContext);
+    const toggleMenu = useCallback(() => {
+        dispatch(MenuActions.TOGGLE_MENU(thisMenuId));
+    }, [dispatch, thisMenuId]);
+    const openMenu = useCallback(() => {
+        // without this call, the toolbar will stay hidden behind other content, and the menus will not be visible
+        FSBL.Clients.WindowClient.bringToFront();
+        dispatch(MenuActions.OPEN_MENU(thisMenuId));
+    }, [dispatch, thisMenuId]);
+    const closeMenu = useCallback(() => {
+        dispatch(MenuActions.CLOSE_MENU(thisMenuId));
+    }, [dispatch, thisMenuId]);
+    const blurMenu = useCallback(() => {
+        if (FSBL === null || FSBL === void 0 ? void 0 : FSBL.debug)
+            return; // If we're debugging then don't blur menus
+        // This is a purposeful closure. There is no need to update it with new state.
+        const closeIfPending = () => {
+            dispatch(MenuActions.CLOSE_MENU_IF_PENDING(thisMenuId));
+        };
+        dispatch(MenuActions.BLUR_MENU(thisMenuId));
+        // See menuReducer.ts for how this timeout is used. Removing the timeout will cause a race condition.
+        setTimeout(closeIfPending, DURATION);
+    }, [dispatch, thisMenuId]);
+    const isMenuActive = () => openMenuId === thisMenuId;
+    return {
+        openMenuId,
+        toggleMenu,
+        closeMenu,
+        openMenu,
+        blurMenu,
+        isMenuActive,
+    };
+};
+//# sourceMappingURL=useMenu.js.map

package/react/hooks/useMenu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMenu.js","sourceRoot":"","sources":["../../src/hooks/useMenu.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAgC7D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,GAAa,EAAE;IACrC,MAAM,QAAQ,GAAW,GAAG,CAAC;IAC7B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1D,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IAE/C,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE;QACnC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;IAC/C,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IAE3B,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;QACjC,0GAA0G;QAC1G,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;QACzC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7C,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IAE3B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE;QAClC,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9C,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IAE3B,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;QACjC,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK;YAAE,OAAO,CAAC,2CAA2C;QAEpE,8EAA8E;QAC9E,MAAM,cAAc,GAAG,GAAG,EAAE;YAC3B,QAAQ,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC;QAEF,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QAE5C,qGAAqG;QACrG,UAAU,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IAE3B,MAAM,YAAY,GAAG,GAAY,EAAE,CAAC,UAAU,KAAK,UAAU,CAAC;IAE9D,OAAO;QACN,UAAU;QACV,UAAU;QACV,SAAS;QACT,QAAQ;QACR,QAAQ;QACR,YAAY;KACZ,CAAC;AACH,CAAC,CAAC","sourcesContent":["import { useDispatch, useSelector } from \"../store\";\nimport { MenuActions } from \"../actions/menuActions\";\nimport { useCallback, useContext } from \"react\";\nimport { MenuContext } from \"../components/menu/menuContext\";\n\ntype MenuHook = {\n\t/**\n\t * The Id of the menu that is currently open\n\t *\n\t * @type {string | null}\n\t */\n\topenMenuId: string | null;\n\t/**\n\t * Dispatches a TOGGLE_MENU action, which should cause the menu to close if it is open, or to open if it is closed.\n\t */\n\ttoggleMenu: () => void;\n\t/**\n\t * Dispatches a CLOSE_MENU action, which should cause the menu to close if it is open.\n\t */\n\tcloseMenu: () => void;\n\t/**\n\t * Dispatches a CLOSE_MENU action after a timeout (DURATION in ms). See description in useMenu comments.\n\t */\n\tblurMenu: () => void;\n\t/**\n\t * Dispatches a OPEN_MENU action, which should cause the menu to open if it is closed.\n\t */\n\topenMenu: () => void;\n\t/**\n\t * Returns true if the id of the menu matches the currently active menu\n\t * @return boolean - Returns true if the menu is active\n\t */\n\tisMenuActive: () => boolean;\n};\n\n/**\n * A hook for working with menus. It gets its implicit menu \"id\" from React context.\n * It dispatches actions to the reducer to modify menu state across MenuShell instances.\n *\n * See menuReducer.ts for \"toggle/blur\" race condition algorithm\n *\n * Setting window.FSBL.debug=true will override menu close on blur, to make it easier to debug windows\n */\nexport const useMenu = (): MenuHook => {\n\tconst DURATION: number = 120;\n\tconst dispatch = useDispatch();\n\tconst { openMenuId } = useSelector((state) => state.menu);\n\tconst { thisMenuId } = useContext(MenuContext);\n\n\tconst toggleMenu = useCallback(() => {\n\t\tdispatch(MenuActions.TOGGLE_MENU(thisMenuId));\n\t}, [dispatch, thisMenuId]);\n\n\tconst openMenu = useCallback(() => {\n\t\t// without this call, the toolbar will stay hidden behind other content, and the menus will not be visible\n\t\tFSBL.Clients.WindowClient.bringToFront();\n\t\tdispatch(MenuActions.OPEN_MENU(thisMenuId));\n\t}, [dispatch, thisMenuId]);\n\n\tconst closeMenu = useCallback(() => {\n\t\tdispatch(MenuActions.CLOSE_MENU(thisMenuId));\n\t}, [dispatch, thisMenuId]);\n\n\tconst blurMenu = useCallback(() => {\n\t\tif (FSBL?.debug) return; // If we're debugging then don't blur menus\n\n\t\t// This is a purposeful closure. There is no need to update it with new state.\n\t\tconst closeIfPending = () => {\n\t\t\tdispatch(MenuActions.CLOSE_MENU_IF_PENDING(thisMenuId));\n\t\t};\n\n\t\tdispatch(MenuActions.BLUR_MENU(thisMenuId));\n\n\t\t// See menuReducer.ts for how this timeout is used. Removing the timeout will cause a race condition.\n\t\tsetTimeout(closeIfPending, DURATION);\n\t}, [dispatch, thisMenuId]);\n\n\tconst isMenuActive = (): boolean => openMenuId === thisMenuId;\n\n\treturn {\n\t\topenMenuId,\n\t\ttoggleMenu,\n\t\tcloseMenu,\n\t\topenMenu,\n\t\tblurMenu,\n\t\tisMenuActive,\n\t};\n};\n"]}

package/react/hooks/useNotifications.d.ts

@@ -0,0 +1,80 @@
+import { NotificationsConfig } from "../components/notifications/types";
+import { services } from "@finsemble/finsemble-api";
+declare type NotificationServiceState = services.notification.types.NotificationServiceState;
+declare type IFilter = services.notification.types.IFilter;
+declare type IMuteFilter = services.notification.types.IMuteFilter;
+declare type INotification = services.notification.types.INotification;
+declare type INotificationHistoryOptions = services.notification.types.INotificationHistoryOptions;
+declare type NotificationUIStatePublish = (state: NotificationServiceState) => void;
+/**
+ * Thin wrapper around usePubSub to give us typesafety for the notification service's UI state.
+ * Automatically appends this client's windowName which is used by the notification service to
+ * display the notification center on an appropriate monitor.
+ */
+export declare const useNotificationUI: () => [state: services.notification.types.NotificationServiceState, setState: NotificationUIStatePublish];
+export declare const moveToToolbarMonitor: () => Promise<void>;
+export declare const getOS: () => "Windows" | "Linux" | "Mac" | undefined;
+/**
+ * Example for setting up button clicks
+ *
+ * @param notification
+ * @param action
+ */
+export declare const doAction: (notification: INotification, action: any) => void;
+/**
+ * Example for setting up button clicks
+ *
+ * @param filter
+ */
+export declare const mute: (filter: IMuteFilter) => Promise<void>;
+/**
+ * Example for setting up button clicks
+ *
+ * @param filter
+ */
+export declare const unmute: (filter: IMuteFilter) => Promise<void>;
+/**
+ * Snooze a notification
+ *
+ * @param {INotification[]} notifications
+ */
+export declare const snoozeNotifications: (notifications: INotification[]) => Promise<void>;
+/**
+ * Marks a notification as read
+ *
+ * @param {INotification[]} notifications
+ */
+export declare const markNotificationsUnread: (notifications: INotification[]) => void;
+/**
+ * Marks a notification as read
+ *
+ * @param {INotification[]} notifications
+ */
+export declare const markNotificationsRead: (notifications: INotification[]) => void;
+/**
+ * Dismisses a notification
+ *
+ * @param {INotification[]} notifications
+ */
+export declare const dismissNotification: (notifications: INotification[]) => void;
+export declare const initializeCenterToggle: () => {
+    toggleCenter: () => void;
+};
+/**
+ * Get Notification's config from
+ */
+export declare const getNotificationConfig: () => NotificationsConfig;
+export declare const getFetchHistoryParams: (config: any, params: any) => any[];
+export default function useNotifications(params?: any): {
+    activeNotifications: (notifications: INotification[], applyMuteFilterOverride?: boolean | undefined) => services.notification.types.INotification[];
+    addNotification: (notification: INotification) => void;
+    notificationIsActive: (notification: INotification, applyMuteFilterOverride?: boolean | undefined) => boolean;
+    getNotificationHistory: (since?: INotificationHistoryOptions, filter?: null | IFilter) => Promise<INotification[]>;
+    groupNotificationsByType: (notifications: INotification[]) => {
+        [x: string]: any;
+    };
+    notifications: any[];
+    removeNotification: (notification: INotification) => void;
+    setOpaqueClassName: (isOpaque: boolean) => void;
+};
+export {};