@finsemble/finsemble-ui 1.0.0-beta-6 → 1.0.0-beta-9

package/react/hooks/useDeepEffect.js

@@ -0,0 +1,34 @@
+import { useEffect, useRef } from "react";
+import isEqual from "lodash/isEqual";
+function useDeepCompareMemoize(value) {
+    const ref = useRef();
+    if (!isEqual(value, ref.current)) {
+        ref.current = value;
+    }
+    return ref.current;
+}
+/**
+ * Use this just like useEffect() except that this will compare objects and arrays using lodash's isEqual() method.
+ * Always pass an array of dependencies as the second parameter!!!
+ */
+export function useDeepEffect(callback, dependencies) {
+    useEffect(callback, useDeepCompareMemoize(dependencies));
+}
+/*
+// Previous implementation that had bugs. Keep around for a bit until we shake out the new version.
+export function useDeepEffect(effectFunc : Function, deps : Array<any>) {
+    const isFirst = useRef(true);
+    const prevDeps = useRef(deps);
+
+    useEffect(() => {
+        const isSame = prevDeps.current.every((obj: any, index: any) => isEqual(obj, deps[index]));
+        if (isFirst.current || !isSame) {
+            effectFunc();
+        }
+
+        isFirst.current = false;
+        prevDeps.current = deps;
+    }, deps);
+}
+*/
+//# sourceMappingURL=useDeepEffect.js.map

package/react/hooks/useDeepEffect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDeepEffect.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useDeepEffect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC,SAAS,qBAAqB,CAAC,KAAU;IACxC,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;IAErB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE;QACjC,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;KACpB;IAED,OAAO,GAAG,CAAC,OAAO,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,QAAa,EAAE,YAAwB;IACpE,SAAS,CAAC,QAAQ,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;;;;;;EAgBE"}

package/react/hooks/useDownloadItems.d.ts

@@ -0,0 +1,24 @@
+declare type DownloadItem = {
+    id: string;
+    displayInfo: {
+        filename: string;
+        url: string;
+        state: string;
+        receivedBytes?: number;
+        totalBytes: number;
+    };
+};
+declare type DownloadState = {
+    downloadItems: DownloadItem[];
+};
+/**
+ * A hook to handle state from the download Manager UI. The state is initialized and updated
+ * based on information from fea.
+ */
+export default function useDownloadItems(): {
+    downloadItems: any;
+    removeDownloadItem: (downloadItem: DownloadItem) => void;
+    initDownloadItems: (downloadItems: DownloadState) => void;
+};
+export {};
+//# sourceMappingURL=useDownloadItems.d.ts.map

package/react/hooks/useDownloadItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDownloadItems.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useDownloadItems.ts"],"names":[],"mappings":"AAGA,aAAK,YAAY,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;KACnB,CAAC;CACF,CAAC;AAEF,aAAK,aAAa,GAAG;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;CAC9B,CAAC;AA2CF;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB;;uCAKG,YAAY;uCAMZ,aAAa;EAiBvD"}

package/react/hooks/useDownloadItems.js

@@ -0,0 +1,68 @@
+import { useEffect, useReducer } from "react";
+import { FEAGlobals } from "../../common/Globals";
+const initialState = { downloadItems: [] };
+/*
+Action Types
+*/
+const UPDATE = "UPDATE";
+const REMOVED = "REMOVED";
+const INIT = "INIT";
+function reducer(state, action) {
+    var _a;
+    switch (action.type) {
+        case INIT:
+            // Initialize the state with the downloadItems saved in FEA. Values are only expected when the UI is reopened.
+            return {
+                downloadItems: [...state.downloadItems, ...(_a = action.payload) === null || _a === void 0 ? void 0 : _a.reverse()],
+            };
+        case UPDATE: {
+            // Adds or updates the downloadItem if it already exists
+            const downloadItemExistsInArray = state.downloadItems.find((downloadItem) => downloadItem.id === action.payload.id);
+            const downloadItems = downloadItemExistsInArray
+                ? state.downloadItems.map((downloadItem) => downloadItem.id === action.payload.id ? action.payload : downloadItem)
+                : [action.payload, ...state.downloadItems];
+            return { downloadItems };
+        }
+        case REMOVED: {
+            // Removes the downloadItem from the list of downloads
+            const downloadItems = state.downloadItems.filter((downloadItem) => downloadItem.id !== action.payload.id);
+            return {
+                downloadItems,
+            };
+        }
+        default:
+            throw new Error();
+    }
+}
+/**
+ * A hook to handle state from the download Manager UI. The state is initialized and updated
+ * based on information from fea.
+ */
+export default function useDownloadItems() {
+    const [state, dispatch] = useReducer(reducer, initialState);
+    /*
+        Action Creators
+    */
+    const removeDownloadItem = (downloadItem) => {
+        dispatch({ type: REMOVED, payload: downloadItem });
+    };
+    const updateDownloadItem = (downloadItem) => {
+        dispatch({ type: UPDATE, payload: downloadItem });
+    };
+    const initDownloadItems = (downloadItems) => {
+        dispatch({ type: INIT, payload: downloadItems });
+    };
+    // Listens for message from fea that a download was initiated/updated
+    useEffect(() => {
+        FEAGlobals.fin.desktop.System.addEventListener("download-update", updateDownloadItem);
+        return () => {
+            FEAGlobals.fin.desktop.System.removeEventListener("download-update", updateDownloadItem);
+        };
+    }, []);
+    return {
+        downloadItems: state.downloadItems,
+        removeDownloadItem,
+        initDownloadItems,
+    };
+}
+//# sourceMappingURL=useDownloadItems.js.map

package/react/hooks/useDownloadItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDownloadItems.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useDownloadItems.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAiBlD,MAAM,YAAY,GAAkB,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;AAE1D;;EAEE;AACF,MAAM,MAAM,GAAG,QAAQ,CAAC;AACxB,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,IAAI,GAAG,MAAM,CAAC;AAEpB,SAAS,OAAO,CAAC,KAAkC,EAAE,MAAsC;;IAC1F,QAAQ,MAAM,CAAC,IAAI,EAAE;QACpB,KAAK,IAAI;YACR,8GAA8G;YAC9G,OAAO;gBACN,aAAa,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,EAAE,GAAG,MAAA,MAAM,CAAC,OAAO,0CAAE,OAAO,EAAE,CAAC;aACrE,CAAC;QACH,KAAK,MAAM,CAAC,CAAC;YACZ,wDAAwD;YACxD,MAAM,yBAAyB,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CACzD,CAAC,YAAiB,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,EAAE,CAC5D,CAAC;YACF,MAAM,aAAa,GAAG,yBAAyB;gBAC9C,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAiB,EAAE,EAAE,CAC9C,YAAY,CAAC,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CACpE;gBACH,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;YAE5C,OAAO,EAAE,aAAa,EAAE,CAAC;SACzB;QACD,KAAK,OAAO,CAAC,CAAC;YACb,sDAAsD;YACtD,MAAM,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC1G,OAAO;gBACN,aAAa;aACb,CAAC;SACF;QACD;YACC,MAAM,IAAI,KAAK,EAAE,CAAC;KACnB;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB;IACvC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC5D;;MAEE;IACF,MAAM,kBAAkB,GAAG,CAAC,YAA0B,EAAE,EAAE;QACzD,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC;IACF,MAAM,kBAAkB,GAAG,CAAC,YAAY,EAAE,EAAE;QAC3C,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IACnD,CAAC,CAAC;IACF,MAAM,iBAAiB,GAAG,CAAC,aAA4B,EAAE,EAAE;QAC1D,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;IAClD,CAAC,CAAC;IAEF,qEAAqE;IACrE,SAAS,CAAC,GAAG,EAAE;QACd,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC;QACtF,OAAO,GAAG,EAAE;YACX,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC;QAC1F,CAAC,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACN,aAAa,EAAE,KAAK,CAAC,aAAa;QAClC,kBAAkB;QAClB,iBAAiB;KACjB,CAAC;AACH,CAAC"}

package/react/hooks/useFavorites.d.ts

@@ -0,0 +1,25 @@
+import { Favorite } from "../types/favoriteTypes";
+declare type FavoritesHook = {
+    /**
+     * The current favorites list from the store.
+     */
+    favorites: Favorite[];
+    /**
+     * Adds a favorite to the favorites store.
+     */
+    addFavorite: (favorite: Favorite) => void;
+    /**
+     * Removes the favorite for the given id from the favorites store.
+     */
+    removeFavorite: (id: Favorite["id"]) => void;
+    /**
+     * Returns true if the current id has been favorited.
+     */
+    isFavorited: (id: Favorite["id"]) => boolean;
+};
+/**
+ * The useFavorites() hook is used by FavoriteMaker to interact with the redux store.
+ */
+export declare const useFavorites: () => FavoritesHook;
+export {};
+//# sourceMappingURL=useFavorites.d.ts.map

package/react/hooks/useFavorites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFavorites.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useFavorites.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGlD,aAAK,aAAa,GAAG;IACpB;;OAEG;IACH,SAAS,EAAE,QAAQ,EAAE,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAE1C;;OAEG;IACH,cAAc,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;IAE7C;;OAEG;IACH,WAAW,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,QAAO,aAqB/B,CAAC"}

package/react/hooks/useFavorites.js

@@ -0,0 +1,24 @@
+import { useDispatch, useSelector } from "../store";
+import { FavoriteActions } from "../actions/favoriteActions";
+/**
+ * The useFavorites() hook is used by FavoriteMaker to interact with the redux store.
+ */
+export const useFavorites = () => {
+    const dispatch = useDispatch();
+    const { favorites } = useSelector((state) => state.favorite);
+    const favoritesIds = favorites.map((fav) => fav.id);
+    const addFavorite = (favorite) => {
+        dispatch(FavoriteActions.ADD_FAVORITE(favorite));
+    };
+    const removeFavorite = (id) => {
+        dispatch(FavoriteActions.REMOVE_FAVORITE(id));
+    };
+    const isFavorited = (id) => favoritesIds.includes(id);
+    return {
+        favorites,
+        addFavorite,
+        removeFavorite,
+        isFavorited,
+    };
+};
+//# sourceMappingURL=useFavorites.js.map

package/react/hooks/useFavorites.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFavorites.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useFavorites.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAwB7D;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAkB,EAAE;IAC/C,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAEpD,MAAM,WAAW,GAAG,CAAC,QAAkB,EAAE,EAAE;QAC1C,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,EAAkB,EAAE,EAAE;QAC7C,QAAQ,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,EAAkB,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEtE,OAAO;QACN,SAAS;QACT,WAAW;QACX,cAAc;QACd,WAAW;KACX,CAAC;AACH,CAAC,CAAC"}

package/react/hooks/useFavoritesShell.d.ts

@@ -0,0 +1,15 @@
+import { Favorite } from "../types/favoriteTypes";
+/**
+ * The useFavoritesShell() hook is used by FavoritesShell to interact with the redux store
+ * and storage.
+ */
+export declare const useFavoritesShell: () => {
+    favorites: Favorite[];
+    removeFavorite: (id: string) => void;
+    triggerFavorite: (id: Favorite["id"], category: Favorite["category"]) => Promise<void>;
+    setFavoritesOrder: ({ oldIndex, newIndex }: {
+        oldIndex: number;
+        newIndex: number;
+    }) => void;
+};
+//# sourceMappingURL=useFavoritesShell.d.ts.map

package/react/hooks/useFavoritesShell.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFavoritesShell.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useFavoritesShell.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AASlD;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;0BAWM,QAAQ,CAAC,IAAI,CAAC,YAAY,QAAQ,CAAC,UAAU,CAAC;;kBA0BlB,MAAM;kBAAY,MAAM;;CAsCvF,CAAC"}

package/react/hooks/useFavoritesShell.js

@@ -0,0 +1,79 @@
+import { useDispatch } from "../store";
+import { FavoriteActions } from "../actions/favoriteActions";
+import { useFavorites } from "./useFavorites";
+import { useEffect } from "react";
+import { FEAGlobals } from "../../common/Globals";
+let storageIsInitialized = false;
+/**
+ * The useFavoritesShell() hook is used by FavoritesShell to interact with the redux store
+ * and storage.
+ */
+export const useFavoritesShell = () => {
+    const dispatch = useDispatch();
+    const { favorites, removeFavorite } = useFavorites();
+    // Ideally in the future the following function will be decoupled from implementation, allowing Favorites to generically dispatch actions.
+    /**
+     * Given a favorite item, trigger the associated action on that item.
+     * I.e. If it's a finsemble component, a new window of that component is launched. If it's a workspace, the workspace would be switched to.
+     * @param id The favorite item's id
+     * @param category The to be triggered favorite item's category
+     */
+    const triggerFavorite = async (id, category) => {
+        if (category === "Application") {
+            FEAGlobals.FSBL.Clients.LauncherClient.spawn(id, {
+                addToWorkspace: true,
+                monitor: "mine",
+            });
+        }
+        else if (category === "Workspace") {
+            FEAGlobals.FSBL.Clients.DistributedStoreClient.getStore({ store: "Finsemble-WorkspaceMenu-Global-Store", global: true }, (err, store) => {
+                store.Dispatcher.dispatch({
+                    actionType: "switchToWorkspace",
+                    data: {
+                        name: id,
+                    },
+                });
+            });
+        }
+    };
+    /**
+     * We need to persist the right order in whent he user reorders favorites in the toolbar. This ensures
+     * that favorites will appear in the right order on future Toolbar launches.
+     * @param favElements The ordered collection of favorite elements
+     */
+    const setFavoritesOrder = ({ oldIndex, newIndex }) => {
+        dispatch(FavoriteActions.REORDER_FAVORITES({ oldIndex, newIndex }));
+    };
+    /**
+     * This effect initializes the favorites redux store. The store must only be initialized once, even though useFavorites may be
+     * referenced by many different React components. We use the module level variable `storageIsInitialized` as a simple flag to
+     * prevent initialization from occuring more than once.
+     */
+    useEffect(() => {
+        if (storageIsInitialized)
+            return;
+        storageIsInitialized = true;
+        // Copy the persisted favorites from Storage to the redux store
+        FEAGlobals.FSBL.Clients.StorageClient.get({ topic: "favorites", key: "allCurrentFavorites" }, (err, data) => {
+            if (err) {
+                return FEAGlobals.FSBL.Clients.Logger.system.error(`Favorite Hook -> Failed to retrieve favorites from StorageClient: ${err}`);
+            }
+            dispatch(FavoriteActions.INITIALIZE_FAVORITES(data));
+        });
+    }, [dispatch]);
+    // When the list of favorite items change, we want to persist that data to the store.
+    useEffect(() => {
+        FEAGlobals.FSBL.Clients.StorageClient.save({
+            topic: "favorites",
+            key: "allCurrentFavorites",
+            value: favorites,
+        });
+    }, [favorites]);
+    return {
+        favorites,
+        removeFavorite,
+        triggerFavorite,
+        setFavoritesOrder,
+    };
+};
+//# sourceMappingURL=useFavoritesShell.js.map

package/react/hooks/useFavoritesShell.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFavoritesShell.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useFavoritesShell.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,IAAI,oBAAoB,GAAY,KAAK,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACrC,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,GAAG,YAAY,EAAE,CAAC;IAErD,0IAA0I;IAC1I;;;;;OAKG;IACH,MAAM,eAAe,GAAG,KAAK,EAAE,EAAkB,EAAE,QAA8B,EAAE,EAAE;QACpF,IAAI,QAAQ,KAAK,aAAa,EAAE;YAC/B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE;gBAChD,cAAc,EAAE,IAAI;gBACpB,OAAO,EAAE,MAAM;aACf,CAAC,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,WAAW,EAAE;YACpC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CACtD,EAAE,KAAK,EAAE,sCAAsC,EAAE,MAAM,EAAE,IAAI,EAAE,EAC/D,CAAC,GAAkB,EAAE,KAAW,EAAE,EAAE;gBACnC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC;oBACzB,UAAU,EAAE,mBAAmB;oBAC/B,IAAI,EAAE;wBACL,IAAI,EAAE,EAAE;qBACR;iBACD,CAAC,CAAC;YACJ,CAAC,CACD,CAAC;SACF;IACF,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,iBAAiB,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAA0C,EAAE,EAAE;QAC5F,QAAQ,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC;IAEF;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,oBAAoB;YAAE,OAAO;QACjC,oBAAoB,GAAG,IAAI,CAAC;QAC5B,+DAA+D;QAC/D,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,qBAAqB,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC3G,IAAI,GAAG,EAAE;gBACR,OAAO,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CACjD,qEAAqE,GAAG,EAAE,CAC1E,CAAC;aACF;YACD,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,qFAAqF;IACrF,SAAS,CAAC,GAAG,EAAE;QACd,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC;YAC1C,KAAK,EAAE,WAAW;YAClB,GAAG,EAAE,qBAAqB;YAC1B,KAAK,EAAE,SAAS;SAChB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO;QACN,SAAS;QACT,cAAc;QACd,eAAe;QACf,iBAAiB;KACjB,CAAC;AACH,CAAC,CAAC"}

package/react/hooks/useFloatingFocus.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Adds a floating focus indicator to the page. This improves accessibility by providing
+ * a visual indicator when using keyboard navigation. The indicator will briefly flash a
+ * contrasting gray on the page field that has focus. This indicator will only display during
+ * keyboard navigation, not mouse navigation.
+ *
+ * floatingFocus.lazy.css can be used to modify the appearance of the indicator.
+ *
+ * We must be careful not to inject styles until the DOM exists because this hook could be
+ * called in a preload (such as an injected windowTitlebar). For the same reason, we compile
+ * the styles using style-loader's lazy option and dynamically inject them rather than allowing
+ * them to be injected as import side effects. This use case relies on floating-focus-a11y's unstyled
+ * build: https://github.com/Q42/floating-focus-a11y#separate-stylesheet
+ */
+export declare const useFloatingFocus: () => void;
+//# sourceMappingURL=useFloatingFocus.d.ts.map

package/react/hooks/useFloatingFocus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFloatingFocus.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useFloatingFocus.ts"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,YAU5B,CAAC"}

package/react/hooks/useFloatingFocus.js

@@ -0,0 +1,36 @@
+import FocusA11Y from "@q42/floating-focus-a11y/dist/unstyled";
+import { useEffect } from "react";
+import floatingFocusCSS from "../assets/css/floatingFocus.lazy.css";
+const addFloatingFocus = () => {
+    // Load the styles into the document's <head>
+    floatingFocusCSS.use();
+    // Create the accessibility helper
+    new FocusA11Y();
+};
+/**
+ * Adds a floating focus indicator to the page. This improves accessibility by providing
+ * a visual indicator when using keyboard navigation. The indicator will briefly flash a
+ * contrasting gray on the page field that has focus. This indicator will only display during
+ * keyboard navigation, not mouse navigation.
+ *
+ * floatingFocus.lazy.css can be used to modify the appearance of the indicator.
+ *
+ * We must be careful not to inject styles until the DOM exists because this hook could be
+ * called in a preload (such as an injected windowTitlebar). For the same reason, we compile
+ * the styles using style-loader's lazy option and dynamically inject them rather than allowing
+ * them to be injected as import side effects. This use case relies on floating-focus-a11y's unstyled
+ * build: https://github.com/Q42/floating-focus-a11y#separate-stylesheet
+ */
+export const useFloatingFocus = () => {
+    useEffect(() => {
+        if (document.readyState === "loading") {
+            window.addEventListener("DOMContentLoaded", () => {
+                addFloatingFocus();
+            });
+        }
+        else {
+            addFloatingFocus();
+        }
+    }, []);
+};
+//# sourceMappingURL=useFloatingFocus.js.map

package/react/hooks/useFloatingFocus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFloatingFocus.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useFloatingFocus.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,wCAAwC,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,gBAAgB,MAAM,sCAAsC,CAAC;AAEpE,MAAM,gBAAgB,GAAG,GAAG,EAAE;IAC7B,6CAA6C;IAC7C,gBAAgB,CAAC,GAAG,EAAE,CAAC;IACvB,kCAAkC;IAClC,IAAI,SAAS,EAAE,CAAC;AACjB,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACpC,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,GAAG,EAAE;gBAChD,gBAAgB,EAAE,CAAC;YACpB,CAAC,CAAC,CAAC;SACH;aAAM;YACN,gBAAgB,EAAE,CAAC;SACnB;IACF,CAAC,EAAE,EAAE,CAAC,CAAC;AACR,CAAC,CAAC"}

package/react/hooks/useHotkey.d.ts

@@ -0,0 +1,9 @@
+import { HotkeyCombination } from "../types/hotkeyTypes";
+/**
+ * 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 declare const useHotkey: (keyCombination: HotkeyCombination | undefined | null, action: Function) => void;
+//# sourceMappingURL=useHotkey.d.ts.map

package/react/hooks/useHotkey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useHotkey.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useHotkey.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAGzD;;;;;GAKG;AACH,eAAO,MAAM,SAAS,mBAAoB,iBAAiB,GAAG,SAAS,GAAG,IAAI,UAAU,QAAQ,SAe/F,CAAC"}

package/react/hooks/useHotkey.js

@@ -0,0 +1,25 @@
+import { useDeepEffect } from "./useDeepEffect";
+import { FEAGlobals } from "../../common/Globals";
+/**
+ * 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 && FEAGlobals.FSBL.Clients.HotkeyClient.addGlobalHotkey(keyCombination, action);
+        return function cleanup() {
+            keyCombination &&
+                actionIsAFunction &&
+                FEAGlobals.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/ui/hooks/useHotkey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;;;;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,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QACpH,OAAO,SAAS,OAAO;YACtB,cAAc;gBACb,iBAAiB;gBACjB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAClF,CAAC,CAAC;IACH,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;AAC9B,CAAC,CAAC"}

package/react/hooks/useLinker.d.ts

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

package/react/hooks/useLinker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLinker.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useLinker.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,SAAS;;+BAoFa,MAAM;CA8CxC,CAAC"}

package/react/hooks/useLinker.js

@@ -0,0 +1,111 @@
+import { useDispatch, useSelector } from "../store";
+import { useEffect } from "react";
+import { LinkerActions } from "../actions/linkerActions";
+import { MAXIMUM_ALLOWED_ACTIVE_CHANNELS } from "../types/linkerTypes";
+import { FEAGlobals } from "../../common/Globals";
+// 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.
+        FEAGlobals.finsembleWindow.blur();
+        FEAGlobals.finsembleWindow.hide();
+    };
+    useEffect(() => {
+        const setInitialChannels = () => {
+            const channels = FEAGlobals.FSBL.Clients.LinkerClient.getAllChannels();
+            dispatch(LinkerActions.SET_CHANNELS({ channels }));
+        };
+        const focusWindow = () => {
+            FEAGlobals.finsembleWindow.focus();
+        };
+        const initAccessibleLinkerMode = () => {
+            const accessibilityCallback = (err, value) => {
+                if (err) {
+                    FEAGlobals.FSBL.Clients.Logger.system.error(`Failed to get accessibleLinker value: ${err}`);
+                    return;
+                }
+                dispatch(LinkerActions.SET_ACCESSIBILITY({
+                    isAccessibleLinker: Boolean(value),
+                }));
+            };
+            FEAGlobals.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 FEAGlobals.FSBL
+         * @param msg  msg from FEAGlobals.FSBL
+         */
+        const onActiveChannelsChanged = (err, msg) => {
+            const componentLinkerState = FEAGlobals.FSBL.Clients.LinkerClient.getState(msg.data.windowIdentifier);
+            if (err) {
+                FEAGlobals.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);
+        };
+        FEAGlobals.FSBL.Clients.Logger.system.log("Linker component is mounted. Initializing.");
+        FEAGlobals.finsembleWindow.addEventListener("blurred", hideWindow);
+        FEAGlobals.finsembleWindow.addEventListener("shown", focusWindow);
+        setInitialChannels();
+        initAccessibleLinkerMode();
+        FEAGlobals.FSBL.Clients.RouterClient.addResponder("Finsemble.LinkerWindow.SetActiveChannels", onActiveChannelsChanged);
+        return () => {
+            FEAGlobals.FSBL.Clients.Logger.system.log("Linker component is unmounted. Cleaning up the event listeners.");
+            FEAGlobals.finsembleWindow.removeEventListener("blurred", hideWindow);
+            FEAGlobals.finsembleWindow.removeEventListener("shown", focusWindow);
+            FEAGlobals.FSBL.Clients.RouterClient.removeResponder("Finsemble.LinkerWindow.SetActiveChannels");
+        };
+    }, []);
+    useEffect(() => {
+        FEAGlobals.FSBL.Clients.WindowClient.fitToDOM();
+    }, [linkerState]);
+    const toggleChannel = (channelId) => {
+        const channel = linkerState.channels[channelId];
+        if (!channel) {
+            FEAGlobals.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) {
+                FEAGlobals.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) {
+            FEAGlobals.FSBL.Clients.LinkerClient.unlinkFromChannel(channelName, windowIdentifier, updateActivationTo(false));
+        }
+        else if (activating && allowedToActivateAnotherChannel) {
+            FEAGlobals.FSBL.Clients.LinkerClient.linkToChannel(channelName, windowIdentifier, updateActivationTo(true));
+        }
+        else {
+            FEAGlobals.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/ui/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;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,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,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;QAClC,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACd,MAAM,kBAAkB,GAAG,GAAG,EAAE;YAC/B,MAAM,QAAQ,GAAc,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;YAClF,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC,CAAC;QAEF,MAAM,WAAW,GAAG,GAAG,EAAE;YACxB,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QACpC,CAAC,CAAC;QAEF,MAAM,wBAAwB,GAAG,GAAG,EAAE;YACrC,MAAM,qBAAqB,GAAG,CAAC,GAAQ,EAAE,KAAU,EAAE,EAAE;gBACtD,IAAI,GAAG,EAAE;oBACR,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAyC,GAAG,EAAE,CAAC,CAAC;oBAC5F,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,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,4BAA4B,EAAE,qBAAqB,CAAC,CAAC;QACpG,CAAC,CAAC;QAEF;;;;;WAKG;QACH,MAAM,uBAAuB,GAAG,CAAC,GAAQ,EAAE,GAAQ,EAAE,EAAE;YACtD,MAAM,oBAAoB,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAEtG,IAAI,GAAG,EAAE;gBACR,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBAClF,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,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;QACxF,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACnE,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAClE,kBAAkB,EAAE,CAAC;QACrB,wBAAwB,EAAE,CAAC;QAC3B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAChD,0CAA0C,EAC1C,uBAAuB,CACvB,CAAC;QAEF,OAAO,GAAG,EAAE;YACX,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,iEAAiE,CAAC,CAAC;YAC7G,UAAU,CAAC,eAAe,CAAC,mBAAmB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YACtE,UAAU,CAAC,eAAe,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YACrE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,0CAA0C,CAAC,CAAC;QAClG,CAAC,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACd,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IACjD,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,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;YACxF,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,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;gBACtF,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,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;SACjH;aAAM,IAAI,UAAU,IAAI,+BAA+B,EAAE;YACzD,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,WAAW,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;SAC5G;aAAM;YACN,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAC1C,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"}

package/react/hooks/useMenu.d.ts

@@ -0,0 +1,40 @@
+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.FEAGlobals.FSBL.debug=true will override menu close on blur, to make it easier to debug windows
+ */
+export declare const useMenu: () => MenuHook;
+export {};
+//# sourceMappingURL=useMenu.d.ts.map

package/react/hooks/useMenu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMenu.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useMenu.ts"],"names":[],"mappings":"AAMA,aAAK,QAAQ,GAAG;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC;CAC5B,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,QAAO,QA4C1B,CAAC"}