@finsemble/finsemble-ui 8.3.0 → 8.4.0-beta.1

package/react/hooks/useInjectedTitleBar.js

@@ -0,0 +1,365 @@
+/**
+ * The useInjectedTitleBar hook is responsible for DOM manipulation of web content in windows where the Finsemble
+ * WindowTitleBar has been injected (as opposed to living in an encapsulating parent TitleBarWindow). This hook
+ * executes only once, to adjust any fixed content downward to make room for the title bar. It also enables a
+ * mutation observer that monitors the entire document.body for newly added nodes with "fixed" position, adjusting
+ * their vertical position accordingly when they are discovered.
+ */
+import { useEffect, useState } from "react";
+import { FEAGlobals } from "../../common/Globals";
+// Values for possible zero
+const possibleZeros = ["0", "0px", 0];
+/**
+ * Used in bumpFixedElements and bumpAbsoluteElements
+ * Calculates value to bump element by. If 'all' return top style plus the header height, if '0Positioned' return just header height
+ * @param type Whether all elements are being bumped by the header height and their top style or just header height
+ * @param topStyle Element top value
+ * @param bumpBy Value to bump element by
+ * @returns Top style for element
+ */
+const calculateBumpValue = (type, topStyle, bumpBy) => {
+    let topVal = topStyle;
+    if (type == "all") {
+        topVal = `calc(${topStyle} + ${bumpBy})`;
+    }
+    else if (type == "0Positioned" && possibleZeros.includes(topStyle)) {
+        topVal = bumpBy;
+    }
+    return topVal;
+};
+/**
+ * Used in bumpAbsoluteElements
+ *
+ * Recursively traverse through the HTML document and return an array of the top level elements
+ * and elements with static parents
+ * @param {object} element The HTML element
+ * @param {array} acc accumulator
+ * @returns {array} array top level elements and elements with static parents
+ *
+ */
+const traverseHtml = (element, acc = []) => {
+    const elements = element.children;
+    const len = elements.length;
+    if (!len) {
+        acc.push(element);
+    }
+    else {
+        for (let i = 0; i < len; i++) {
+            const style = window.getComputedStyle(elements[i], null);
+            if (style.getPropertyValue("position") == "static") {
+                acc = traverseHtml(elements[i], acc);
+            }
+            else {
+                acc.push(elements[i]);
+            }
+        }
+    }
+    return acc;
+};
+/**
+ * Called from bumpElements
+ *
+ * Bumps all elements with fixed positioning, that are not in the header, down by the configured amount.
+ * @private
+ * @param {object} params bumpElements object
+ */
+const bumpFixedElements = (params) => {
+    var _a, _b;
+    let { fixed, bumpBy } = params;
+    const getFixedElements = (selector) => {
+        const fixedElements = [];
+        const nodes = document.body.querySelectorAll(selector);
+        nodes.forEach((node) => {
+            const style = window.getComputedStyle(node, null);
+            if (style.getPropertyValue("position") == "fixed")
+                fixedElements.push(node);
+        });
+        return fixedElements;
+    };
+    const selector = "*:not(#FSBLHeader, .fsbl-header)";
+    // Get all fixed positioned elements
+    const elements = getFixedElements(selector);
+    const len = elements.length;
+    for (let i = 0; i < len; i++) {
+        const style = window.getComputedStyle(elements[i], null);
+        const topStyle = style.getPropertyValue("top");
+        if (!((_b = (_a = elements[i]) === null || _a === void 0 ? void 0 : _a.classList) === null || _b === void 0 ? void 0 : _b.contains("bumped-element"))) {
+            elements[i].style.top = calculateBumpValue(fixed, topStyle, bumpBy);
+            elements[i].classList.add("bumped-element");
+        }
+    }
+};
+/**
+ * Called from bumpElements
+ *
+ * Bumps all absolute positioned elements with static parents, that are not in the header, down by the configured amount.
+ * @private
+ * @param {object} params bumpElements object
+ */
+const bumpAbsoluteElements = (params) => {
+    var _a, _b;
+    let { absolute, bumpBy } = params;
+    const selector = "*:not(#FSBLHeader, .fsbl-header)";
+    // Get top level absolute positioned elements and elements who have static parents
+    const elements = traverseHtml({ children: document.body.querySelectorAll(`:scope > ${selector}`) });
+    const len = elements.length;
+    for (let i = 0; i < len; i++) {
+        const style = window.getComputedStyle(elements[i], null);
+        const topStyle = style.getPropertyValue("top");
+        // Target absolute positioned elements
+        if (style.getPropertyValue("position") == "absolute" && !((_b = (_a = elements[i]) === null || _a === void 0 ? void 0 : _a.classList) === null || _b === void 0 ? void 0 : _b.contains("bumped-element"))) {
+            elements[i].style.top = calculateBumpValue(absolute, topStyle, bumpBy);
+            elements[i].classList.add("bumped-element");
+        }
+    }
+};
+/**
+ * Toggle setting found in `foreign.components.["Window Manager"].FSBLHeader.bumpElements.[bumpBy|fixed|absolute]`
+ * Called from beginAdjustment()
+ *
+ * Calls bumpFixedElements and bumpAbsoluteElements to bump fixed and/or absolute elements by the value of bumpBy if configured to do so.
+ * Since absolute and fixed positioned elements are removed from the document flow their positions will not be adjusted when the titlebar
+ * is injected and they have a set top style. However, if the element is an absolute positioned element and it's
+ * parent container has a position that is not set to static, then it'll adjust relative to the parent. Fixed positioned elements, on the other hand,
+ * won't adjust unless their top styles are changed.
+ */
+const bumpElements = (config) => {
+    if (!config)
+        return;
+    if (config.bumpBy !== "0px") {
+        if (config.fixed)
+            bumpFixedElements(config);
+        if (config.absolute)
+            bumpAbsoluteElements(config);
+    }
+};
+/**
+ * This is used in adjustTopLevelHeight() and adjustContentHeight()
+ *
+ * Set the max height of each element to be the height of the parent container
+ * subtracted by the height of the previous element. This forces the element to either obey its
+ * predefined height or stay within the bounds of the max height.
+ *
+ * @param {object} elem HTML element
+ * @param {number} prevHeight height of previous sibling
+ * @param {string} maxElemHeight maximum height of the element
+ * @param {number} headerHeight the height of the header
+ */
+const adjust = (elem, prevHeight, headerHeight = 25) => {
+    var _a;
+    if (
+    // workaround to fix dnd scrim disappearing
+    !((_a = elem.classList) === null || _a === void 0 ? void 0 : _a.contains("fsbl-share-scrim"))) {
+        const clientHeight = elem.clientHeight ? elem.clientHeight : 0;
+        const offsetHeight = elem.offsetHeight ? elem.offsetHeight : 0;
+        const offset = offsetHeight - clientHeight;
+        let adjustPrev = prevHeight + offset;
+        const elemPosition = window.getComputedStyle(elem, null).getPropertyValue("position");
+        if (elemPosition == "fixed" || elemPosition == "absolute")
+            adjustPrev = headerHeight + offset;
+        elem.style.maxHeight = `calc(100% - ${adjustPrev}px)`;
+        elem.classList.add("adjusted-element");
+    }
+};
+/**
+ * Adjusts the content view height to be maximum of the parent container (passed in by adjustTopLevelHeight()) height
+ * subtracted by the total height of elements above it. The height of the previous elements are added to this calculation
+ * if they are not fixed or absolute.
+ * @param {object} parentElem parent element
+ * @param {number} headerHeight the height of the header
+ */
+const adjustContentHeight = (parentElem, headerHeight) => {
+    const { children } = parentElem;
+    const len = children.length;
+    let prevHeight = 0;
+    for (let i = 0; i < len; i++) {
+        adjust(children[i], prevHeight, headerHeight);
+        // Fixed and absolute positioned elements are ignored since they are removed from the document flow.
+        const elemPosition = window.getComputedStyle(children[i], null).getPropertyValue("position");
+        if (elemPosition !== "fixed" && elemPosition !== "absolute")
+            prevHeight = prevHeight + children[i].offsetHeight;
+    }
+};
+/**
+ * Toggle setting found in `foreign.components.["Window Manager"].FSBLHeader.adjustContentHeights`
+ * Called from beginAdjustment()
+ *
+ * Adjusts the top level content max-height to be 100% subtracted by the total height of the previous elements.
+ * The height of the previous elements are added to this calculation if they are not fixed or absolute.
+ * These top level elements will be passed into adjustContentHeight where their descendants
+ * will also have their heights adjusted.
+ *
+ * Absolute and Fixed positions elements, however, will just have their max-heights set to 100% subtracted by the header height
+ * since they are not part of the document flow.
+ * Example:
+ * In this below situation, the B element extends passed the view because the header is injected. B doesn't have a
+ * set height so it'll extend as far as it needs.
+ * --------------------
+ * |******************|
+ * |*     Titlebar   *|
+ * |******************|
+ * |******************|
+ * |*       A        *|
+ * |*                *|
+ * |******************|
+ * |******************|
+ * |*                *|
+ * |*                *|
+ * |*       B        *|
+ * |*                *|
+ * |*                *|
+ * |*                *|
+ * --------------------
+ * The chain of adjust functions will set the maxHeight of A and B to ensure they both occupy space that the above element doesn't
+ * and keep it within the bounds of the view.
+ * --------------------
+ * |******************|
+ * |*     Titlebar   *|
+ * |******************|
+ * |******************|
+ * |*       A        *|
+ * |*                *|
+ * |******************|
+ * |******************|
+ * |*                *|
+ * |*                *|
+ * |*       B        *|
+ * |*                *|
+ * |*                *|
+ * |******************|
+ * --------------------
+ * @param {number} headerHeight the height of the header
+ */
+const adjustTopLevelHeight = (headerHeight) => {
+    const elements = document.body.querySelectorAll(":scope > *:not(#FSBLHeader, .fsbl-header)");
+    let prevHeight = 0;
+    // Tags that don't accept max-heights
+    const avoidTags = ["svg", "script"];
+    elements.forEach((elem) => {
+        if (!avoidTags.includes(String(elem.tagName).toLowerCase())) {
+            adjust(elem, prevHeight, headerHeight);
+            // Heights of fixed and absolute positioned elements are not added to the total heights of previous elements
+            // since they are removed from the document flow and can be positioned anywhere in the page.
+            if (elem.style.position !== "fixed" && elem.style.position !== "absolute")
+                prevHeight = prevHeight + elem.offsetHeight;
+            adjustContentHeight(elem, headerHeight);
+        }
+    });
+};
+/**
+ * Toggle setting found in `foreign.components.["Window Manager"].FSBLHeader.bumpElements.[monitorFixedAdditions]`
+ * Called from beginAdjustment()
+ *
+ * Monitors the DOM for mutations, if the added node has a fixed position with a top style of 0px, it will be bumped by the title bar height.
+ * This ensures that if a fixed positioned element is dynamically added to the DOM, for example a pop-up modal, it'll have it's height adjusted
+ * by the header height since the initial bumping of elements can happen before this element exists.
+ *
+ * Element heights are not monitored and adjusted since this would require that all pre-existing elements have their height recalculated each time
+ * a new element is dynamically added onto the page. Absolute positioned elements, however, could be monitored and adjusted since all we would
+ * need to check for is that it's parent has a static position or not, if it does then it can be adjusted.
+ * @param headerHeight the height of the header
+ */
+const monitorFixedPositionedElements = (headerHeight) => {
+    const options = {
+        childList: true,
+        subtree: true,
+    };
+    /**
+     * MutationObserver interface provides the ability to watch for
+     * changes to the DOM tree using the observe method
+     */
+    const mutationObserver = new MutationObserver((mutations) => {
+        mutations.forEach((mutation) => {
+            mutation.addedNodes.forEach((node) => {
+                var _a;
+                if (!((_a = node === null || node === void 0 ? void 0 : node.classList) === null || _a === void 0 ? void 0 : _a.contains("bumped-element"))) {
+                    try {
+                        const nodeStyle = window.getComputedStyle(node);
+                        const topStyle = nodeStyle.top;
+                        // make sure node is fixed, has top style set to 0, and has not been bumped
+                        if (nodeStyle.position === "fixed" && possibleZeros.includes(topStyle)) {
+                            node.style.top = calculateBumpValue("0Positioned", topStyle, headerHeight);
+                            node.classList.add("bumped-element");
+                        }
+                    }
+                    catch (err) {
+                        // Expected to error if the node is not an Element e.g text is not of type Element
+                    }
+                }
+            });
+        });
+    });
+    // We observe the body and do not disconnect because there may be other elements that are dynamically loaded, such as a dialogue menu.
+    mutationObserver.observe(document.body, options);
+};
+// Hack the window's scrollbar so that it displays underneath the header. html.overflow: hidden body.overflow:auto
+// This is turned on by default. Set "Window Manager.hackScrollbar: false" to turn it off
+const hackScrollbar = () => {
+    const header = document.getElementsByClassName("fsbl-header")[0];
+    //Add a margin top to the body if there title bar is injected into the component.
+    if (header) {
+        document.body.style.margin = "0px";
+        document.body.style.marginTop = window.getComputedStyle(header, null).getPropertyValue("height");
+    }
+    const htmlElement = document.querySelector("html");
+    if (htmlElement)
+        htmlElement.style.overflowY = "hidden";
+    const bodyElement = document.querySelector("body");
+    if (bodyElement)
+        bodyElement.style.overflowY = "auto";
+};
+/**
+ * Begin adjusting the body and top level elements and their direct descendants by the header height.
+ */
+const beginAdjustment = (bumpElementConfig) => {
+    const header = document.getElementsByClassName("fsbl-header")[0];
+    if (!header) {
+        FEAGlobals.FSBL.Clients.Logger.system.error("WindowTitleBarShell.maybeAdjustWindow:could not find fsbl-header.");
+        return;
+    }
+    const bodyElement = document.querySelector("body");
+    const headerHeight = window.getComputedStyle(header, null).getPropertyValue("height");
+    if (bodyElement) {
+        bodyElement.style.height = `calc(100vh - ${headerHeight})`;
+    }
+    if (bumpElementConfig.hackScrollbar)
+        hackScrollbar();
+    if (bumpElementConfig.adjustContentHeights)
+        adjustTopLevelHeight(Number.parseInt(headerHeight, 10));
+    if (bumpElementConfig.bumpFixedElements) {
+        bumpElements(bumpElementConfig);
+        if (bumpElementConfig.monitorFixedAdditions)
+            monitorFixedPositionedElements(headerHeight);
+    }
+};
+/**
+ * Once document is ready and header is injected into DOM, begin adjusting the height of elements and bump fixed/absolute elements
+ */
+const adjustWindow = (bumpElementConfig) => {
+    // don't start pushing stuff down until page is ready. This is needed for preloaded title bars because they can happen before the page is ready.
+    if (document.readyState === "complete") {
+        beginAdjustment(bumpElementConfig);
+    }
+    else {
+        document.addEventListener("readystatechange", () => {
+            if (document.readyState === "complete")
+                beginAdjustment(bumpElementConfig);
+        });
+    }
+};
+export const useInjectedTitleBar = (bumpConfig) => {
+    const [bumped, setBumped] = useState(false);
+    // Run the hook when a BumpConfig is available (e.g. loaded from store)
+    useEffect(() => {
+        var _a;
+        // If this isn't an injected title bar window then do nothing
+        if ((_a = FEAGlobals === null || FEAGlobals === void 0 ? void 0 : FEAGlobals.fin) === null || _a === void 0 ? void 0 : _a.isTitlebarWindow())
+            return;
+        // Only run once, when the bumpConfig becomes available
+        if (bumpConfig && !bumped) {
+            adjustWindow(bumpConfig);
+            setBumped(true);
+        }
+    }, [bumpConfig]);
+};
+//# sourceMappingURL=useInjectedTitleBar.js.map

package/react/hooks/useInjectedTitleBar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInjectedTitleBar.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useInjectedTitleBar.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,2BAA2B;AAC3B,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;AAEtC;;;;;;;GAOG;AACH,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAE,MAAc,EAAE,EAAE;IAC7E,IAAI,MAAM,GAAG,QAAQ,CAAC;IACtB,IAAI,IAAI,IAAI,KAAK,EAAE;QAClB,MAAM,GAAG,QAAQ,QAAQ,MAAM,MAAM,GAAG,CAAC;KACzC;SAAM,IAAI,IAAI,IAAI,aAAa,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACrE,MAAM,GAAG,MAAM,CAAC;KAChB;IACD,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,YAAY,GAAG,CAAC,OAAY,EAAE,MAAa,EAAE,EAAE,EAAE;IACtD,MAAM,QAAQ,GAAQ,OAAO,CAAC,QAAQ,CAAC;IACvC,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC5B,IAAI,CAAC,GAAG,EAAE;QACT,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KAClB;SAAM;QACN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;YAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACzD,IAAI,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,QAAQ,EAAE;gBACnD,GAAG,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;aACrC;iBAAM;gBACN,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;aACtB;SACD;KACD;IACD,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,MAAW,EAAE,EAAE;;IACzC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAE/B,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,EAAE;QAC7C,MAAM,aAAa,GAAU,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;YAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAClD,IAAI,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,OAAO;gBAAE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;IACtB,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,kCAAkC,CAAC;IACpD,oCAAoC;IACpC,MAAM,QAAQ,GAAQ,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACjD,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAEzD,MAAM,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,CAAA,MAAA,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,SAAS,0CAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAA,EAAE;YACxD,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YACpE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;SAC5C;KACD;AACF,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,CAAC,MAAW,EAAE,EAAE;;IAC5C,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAElC,MAAM,QAAQ,GAAG,kCAAkC,CAAC;IACpD,kFAAkF;IAClF,MAAM,QAAQ,GAAQ,YAAY,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;IACzG,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAEzD,MAAM,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE/C,sCAAsC;QACtC,IAAI,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,UAAU,IAAI,CAAC,CAAA,MAAA,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,SAAS,0CAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAA,EAAE;YAC5G,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YACvE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;SAC5C;KACD;AACF,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,YAAY,GAAG,CAAC,MAAmB,EAAE,EAAE;IAC5C,IAAI,CAAC,MAAM;QAAE,OAAO;IACpB,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,EAAE;QAC5B,IAAI,MAAM,CAAC,KAAK;YAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,MAAM,CAAC,QAAQ;YAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;KAClD;AACF,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,GAAG,CAAC,IAAiB,EAAE,UAAkB,EAAE,eAAuB,EAAE,EAAE,EAAE;;IACnF;IACC,2CAA2C;IAC3C,CAAC,CAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAA,EAC5C;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,YAAY,GAAG,YAAY,CAAC;QAC3C,IAAI,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;QAErC,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACtF,IAAI,YAAY,IAAI,OAAO,IAAI,YAAY,IAAI,UAAU;YAAE,UAAU,GAAG,YAAY,GAAG,MAAM,CAAC;QAC9F,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,eAAe,UAAU,KAAK,CAAC;QACtD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;KACvC;AACF,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,mBAAmB,GAAG,CAAC,UAAuB,EAAE,YAAoB,EAAE,EAAE;IAC7E,MAAM,EAAE,QAAQ,EAAE,GAAQ,UAAU,CAAC;IACrC,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC5B,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;QAC7B,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QAC9C,oGAAoG;QACpG,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAC7F,IAAI,YAAY,KAAK,OAAO,IAAI,YAAY,KAAK,UAAU;YAAE,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;KAChH;AACF,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,oBAAoB,GAAG,CAAC,YAAoB,EAAE,EAAE;IACrD,MAAM,QAAQ,GAA4B,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,2CAA2C,CAAC,CAAC;IACtH,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,qCAAqC;IACrC,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAEpC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;QACtC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE;YAC5D,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;YACvC,4GAA4G;YAC5G,4FAA4F;YAC5F,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,UAAU;gBACxE,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC;YAE7C,mBAAmB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SACxC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,8BAA8B,GAAG,CAAC,YAAoB,EAAE,EAAE;IAC/D,MAAM,OAAO,GAAG;QACf,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI;KACb,CAAC;IAEF;;;OAGG;IACH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,CAAC,SAAS,EAAE,EAAE;QAC3D,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC9B,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;;gBACzC,IAAI,CAAC,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,0CAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAA,EAAE;oBACjD,IAAI;wBACH,MAAM,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;wBAChD,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC;wBAE/B,2EAA2E;wBAC3E,IAAI,SAAS,CAAC,QAAQ,KAAK,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;4BACvE,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;4BAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;yBACrC;qBACD;oBAAC,OAAO,GAAG,EAAE;wBACb,kFAAkF;qBAClF;iBACD;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,sIAAsI;IACtI,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,kHAAkH;AAClH,yFAAyF;AACzF,MAAM,aAAa,GAAG,GAAG,EAAE;IAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjE,iFAAiF;IACjF,IAAI,MAAM,EAAE;QACX,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;QACnC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;KACjG;IAED,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACnD,IAAI,WAAW;QAAE,WAAW,CAAC,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC;IACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACnD,IAAI,WAAW;QAAE,WAAW,CAAC,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC;AACvD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,iBAA6B,EAAE,EAAE;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IACjE,IAAI,CAAC,MAAM,EAAE;QACZ,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACjH,OAAO;KACP;IACD,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAEtF,IAAI,WAAW,EAAE;QAChB,WAAW,CAAC,KAAK,CAAC,MAAM,GAAG,gBAAgB,YAAY,GAAG,CAAC;KAC3D;IAED,IAAI,iBAAiB,CAAC,aAAa;QAAE,aAAa,EAAE,CAAC;IAErD,IAAI,iBAAiB,CAAC,oBAAoB;QAAE,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;IAEpG,IAAI,iBAAiB,CAAC,iBAAiB,EAAE;QACxC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAChC,IAAI,iBAAiB,CAAC,qBAAqB;YAAE,8BAA8B,CAAC,YAAY,CAAC,CAAC;KAC1F;AACF,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,YAAY,GAAG,CAAC,iBAA6B,EAAE,EAAE;IACtD,gJAAgJ;IAChJ,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE;QACvC,eAAe,CAAC,iBAAiB,CAAC,CAAC;KACnC;SAAM;QACN,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAClD,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU;gBAAE,eAAe,CAAC,iBAAiB,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;KACH;AACF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,UAA6B,EAAE,EAAE;IACpE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAU,KAAK,CAAC,CAAC;IACrD,uEAAuE;IACvE,SAAS,CAAC,GAAG,EAAE;;QACd,6DAA6D;QAC7D,IAAI,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,0CAAE,gBAAgB,EAAE;YAAE,OAAO;QAChD,uDAAuD;QACvD,IAAI,UAAU,IAAI,CAAC,MAAM,EAAE;YAC1B,YAAY,CAAC,UAAU,CAAC,CAAC;YACzB,SAAS,CAAC,IAAI,CAAC,CAAC;SAChB;IACF,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC"}

package/react/hooks/useNotifications.d.ts

@@ -10,7 +10,7 @@ declare type NotificationUIStatePublish = (state: NotificationServiceState) => v
 export declare const useNotificationUI: () => [state: NotificationServiceState, setState: NotificationUIStatePublish];
 export declare const getToolbarMonitor: () => Promise<MonitorInfoDetail | undefined>;
 export declare const moveToToolbarMonitor: () => Promise<void>;
-export declare const getOS: () => "Mac" | "Windows" | "Linux" | undefined;
+export declare const getOS: () => "Windows" | "Linux" | "Mac" | undefined;
 /**
  * Example for setting up button clicks
  *

package/react/hooks/useToolbar.d.ts

@@ -6,6 +6,7 @@ export declare const useToolbar: () => {
     toggleAutoArrange: () => Promise<void>;
     showToolbar: () => void;
     hideToolbar: () => void;
+    dockToolbar: () => void;
     launchPreferences: (tabName: string) => void;
 };
 //# sourceMappingURL=useToolbar.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useToolbar.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useToolbar.ts"],"names":[],"mappings":"AA0JA,eAAO,MAAM,UAAU;;;;;;;;iCAlDa,MAAM;CAsEzC,CAAC"}
+{"version":3,"file":"useToolbar.d.ts","sourceRoot":"","sources":["../../../../src/ui/hooks/useToolbar.ts"],"names":[],"mappings":"AAoKA,eAAO,MAAM,UAAU;;;;;;;;;iCAlDa,MAAM;CAuEzC,CAAC"}

package/react/hooks/useToolbar.js

@@ -33,7 +33,16 @@ const showToolbar = () => {
     bringToolbarToFront({ focus: true });
 };
 /**
- * Mimimizes all windows.
+ * Docks the toolbar to the primary monitor
+ */
+const dockToolbar = () => {
+    FEAGlobals.FSBL.Clients.RouterClient.transmit("DockingService.dockWindow", {
+        windowName: FEAGlobals.finsembleWindow.name,
+        uuid: FEAGlobals.finsembleWindow.uuid,
+    });
+};
+/**
+ * Minimizes all windows.
  */
 const minimizeAllWindows = () => {
     FEAGlobals.FSBL.Clients.WorkspaceClient.minimizeAll();
@@ -49,8 +58,8 @@ const revealAllWindows = () => {
  */
 const toggleAutoArrange = async () => {
     /**
-     * Bring windows to front before auto arranging them to ensure maximised windows are included in the action
-     * This is relies on bringWindowsToFront() restoring maximised and minimised windows
+     * Bring windows to front before auto arranging them to ensure maximized windows are included in the action
+     * This is relies on bringWindowsToFront() restoring maximized and minimized windows
      */
     await FEAGlobals.FSBL.Clients.WorkspaceClient.bringWindowsToFront();
     FEAGlobals.FSBL.Clients.WorkspaceClient.autoArrange({}, () => {
@@ -146,6 +155,7 @@ export const useToolbar = () => {
         toggleAutoArrange,
         showToolbar,
         hideToolbar,
+        dockToolbar,
         launchPreferences,
     };
 };

package/react/hooks/useToolbar.js.map

@@ -1 +1 @@
-{"version":3,"file":"useToolbar.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useToolbar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;;GAGG;AACH,MAAM,mBAAmB,GAAG,CAAC,EAAE,KAAK,EAAsB,EAAE,EAAE;IAC7D,UAAU,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,GAAQ,EAAE,EAAE;QAC1D,IAAI,GAAG,EAAE;YACR,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;SACvF;QAED,IAAI,KAAK,EAAE;YACV,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;SACnC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;IAClC,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,oCAAoC,EAAE;QACnF,UAAU,EAAE,UAAU,CAAC,eAAe,CAAC,IAAI;QAC3C,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,IAAI;KACrC,CAAC,CAAC;IACH,mBAAmB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,kBAAkB,GAAG,GAAG,EAAE;IAC/B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC;AACvD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,GAAG,EAAE;IAC7B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;AAC/D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;IACpC;;;OAGG;IACH,MAAM,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;IACpE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,EAAE;QAC5D,mEAAmE;QACnE,oEAAoE;QACpE,mBAAmB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,eAAe,GAAG,GAAG,EAAE;IAC5B,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE;QAC7D,UAAU,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,uBAAuB,GAAG,GAAG,EAAE;IACpC,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;AAClG,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,GAAG,EAAE;IAClC,0BAA0B,EAAE,CAAC;IAC7B,gHAAgH;IAChH,qBAAqB;IACrB,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,GAAG,EAAE;IACxC,IAAI,MAAM,CAAC,cAAc,KAAK,qBAAqB,EAAE;QACpD,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;KAC7B;AACF,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAE,EAAE;IAC7C,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,iCAAiC,EAAE;QAChF,cAAc,EAAE,OAAO;KACvB,CAAC,CAAC;IACH,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAChD;QACC,aAAa,EAAE,iBAAiB;KAChC,EACD;QACC,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,QAAQ;KACb,CACD,CAAC;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,kBAAkB,GAAG,GAAG,EAAE;IAC/B,gEAAgE;IAChE,IAAI,MAAM,CAAC,cAAc,KAAK,qBAAqB;QAAE,OAAO;IAE5D,+HAA+H;IAC/H,IAAI,MAAM,CAAC,cAAc,EAAE;QAC1B,OAAO,CAAC,KAAK,CACZ,0aAA0a,CAC1a,CAAC;QACF,OAAO;KACP;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,GAAG,qBAAqB,CAAC;IAE9C,wFAAwF;IACxF,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC7E,2BAA2B,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC5E,2BAA2B,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE;IAC9B,SAAS,CAAC,GAAG,EAAE;QACd,eAAe,EAAE,CAAC;QAClB,uBAAuB,EAAE,CAAC;QAE1B,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;YACnC,kBAAkB,EAAE,CAAC;SACrB;IACF,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACN,2BAA2B;QAC3B,kBAAkB;QAClB,kBAAkB;QAClB,gBAAgB;QAChB,iBAAiB;QACjB,WAAW;QACX,WAAW;QACX,iBAAiB;KACjB,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"useToolbar.js","sourceRoot":"","sources":["../../../../src/ui/hooks/useToolbar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;;GAGG;AACH,MAAM,mBAAmB,GAAG,CAAC,EAAE,KAAK,EAAsB,EAAE,EAAE;IAC7D,UAAU,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,GAAQ,EAAE,EAAE;QAC1D,IAAI,GAAG,EAAE;YACR,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;SACvF;QAED,IAAI,KAAK,EAAE;YACV,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;SACnC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;IAClC,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,oCAAoC,EAAE;QACnF,UAAU,EAAE,UAAU,CAAC,eAAe,CAAC,IAAI;QAC3C,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,IAAI;KACrC,CAAC,CAAC;IACH,mBAAmB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,2BAA2B,EAAE;QAC1E,UAAU,EAAE,UAAU,CAAC,eAAe,CAAC,IAAI;QAC3C,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,IAAI;KACrC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,kBAAkB,GAAG,GAAG,EAAE;IAC/B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC;AACvD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,GAAG,EAAE;IAC7B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;AAC/D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;IACpC;;;OAGG;IACH,MAAM,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;IACpE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,EAAE;QAC5D,mEAAmE;QACnE,oEAAoE;QACpE,mBAAmB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,eAAe,GAAG,GAAG,EAAE;IAC5B,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE;QAC7D,UAAU,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,uBAAuB,GAAG,GAAG,EAAE;IACpC,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;AAClG,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,GAAG,EAAE;IAClC,0BAA0B,EAAE,CAAC;IAC7B,gHAAgH;IAChH,qBAAqB;IACrB,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,GAAG,EAAE;IACxC,IAAI,MAAM,CAAC,cAAc,KAAK,qBAAqB,EAAE;QACpD,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;KAC7B;AACF,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAE,EAAE;IAC7C,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,iCAAiC,EAAE;QAChF,cAAc,EAAE,OAAO;KACvB,CAAC,CAAC;IACH,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAChD;QACC,aAAa,EAAE,iBAAiB;KAChC,EACD;QACC,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,QAAQ;KACb,CACD,CAAC;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,kBAAkB,GAAG,GAAG,EAAE;IAC/B,gEAAgE;IAChE,IAAI,MAAM,CAAC,cAAc,KAAK,qBAAqB;QAAE,OAAO;IAE5D,+HAA+H;IAC/H,IAAI,MAAM,CAAC,cAAc,EAAE;QAC1B,OAAO,CAAC,KAAK,CACZ,0aAA0a,CAC1a,CAAC;QACF,OAAO;KACP;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,GAAG,qBAAqB,CAAC;IAE9C,wFAAwF;IACxF,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC7E,2BAA2B,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC5E,2BAA2B,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE;IAC9B,SAAS,CAAC,GAAG,EAAE;QACd,eAAe,EAAE,CAAC;QAClB,uBAAuB,EAAE,CAAC;QAE1B,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;YACnC,kBAAkB,EAAE,CAAC;SACrB;IACF,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACN,2BAA2B;QAC3B,kBAAkB;QAClB,kBAAkB;QAClB,gBAAgB;QAChB,iBAAiB;QACjB,WAAW;QACX,WAAW;QACX,WAAW;QACX,iBAAiB;KACjB,CAAC;AACH,CAAC,CAAC"}

package/typedoc-types.d.ts

@@ -0,0 +1,9 @@
+export declare type StandardError = Error | string | null | undefined;
+export declare type StandardErrorCallback<R = any> = (err: StandardError, response?: R) => void;
+export declare type StandardPromise<R = any> = Promise<{
+    err?: StandardError;
+    data?: R;
+}>;
+export declare type StandardCallback<E = StandardError, R = any> = (err: E, response?: R) => void;
+export declare type Manifest = Record<string, any>;
+//# sourceMappingURL=typedoc-types.d.ts.map

package/typedoc-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedoc-types.d.ts","sourceRoot":"","sources":["../../src/typedoc-types.ts"],"names":[],"mappings":"AAOA,oBAAY,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAG9D,oBAAY,qBAAqB,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAGxF,oBAAY,eAAe,CAAC,CAAC,GAAG,GAAG,IAAI,OAAO,CAAC;IAC9C,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,CAAC,CAAC;CACT,CAAC,CAAC;AAGH,oBAAY,gBAAgB,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAG1F,oBAAY,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC"}

package/typedoc-types.js

@@ -0,0 +1,6 @@
+// This page lists common types that are used repeatedly by the clients. These types have been isolated
+// into a single entrypoint for TypeDocs to pull into the API docs.
+// These used to live in main.ts or types.ts, but using either of those as entry points pulled a large
+// amount of irrelevant type info into the docs. These have been isolated to keep things clean.
+export {};
+//# sourceMappingURL=typedoc-types.js.map

package/typedoc-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedoc-types.js","sourceRoot":"","sources":["../../src/typedoc-types.ts"],"names":[],"mappings":"AAAA,uGAAuG;AACvG,mEAAmE;AACnE,sGAAsG;AACtG,+FAA+F"}

package/types.d.ts

@@ -1,23 +1,17 @@
+import { StandardError } from "./typedoc-types";
 export { StoreModel } from "./clients/StoreModel";
 export { FDC3 } from "./typedefs";
 export declare type CallbackError = {
     message: string;
     code: string;
 };
-export declare type StandardError = Error | string | null | undefined;
-export declare type StandardErrorCallback<R = any> = (err: StandardError, response?: R) => void;
-export declare type StandardPromise<R = any> = Promise<{
-    err?: StandardError;
-    data?: R;
-}>;
+export { AppDefinition, SelectConnectAppList } from "./platform/services/Interop/types";
+export declare type FinsembleConfig = Record<string, any>;
+export declare type AppConfig = Record<string, any>;
 export declare type StandardResponse<R = any> = {
     err?: StandardError;
     data?: R;
 };
-export declare type StandardCallback<E = StandardError, R = any> = (err: E, response?: R) => void;
-export declare type Manifest = Record<string, any>;
-export declare type FinsembleConfig = Record<string, any>;
-export declare type AppConfig = Record<string, any>;
-export { AppDefinition, SelectConnectAppList } from "./platform/services/Interop/types";
+export * from "./typedoc-types";
 export * from "./platform/services/config/types";
 //# sourceMappingURL=types.d.ts.map

package/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGlC,oBAAY,aAAa,GAAG;IAE3B,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,oBAAY,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAG9D,oBAAY,qBAAqB,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAGxF,oBAAY,eAAe,CAAC,CAAC,GAAG,GAAG,IAAI,OAAO,CAAC;IAC9C,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,CAAC,CAAC;CACT,CAAC,CAAC;AAEH,oBAAY,gBAAgB,CAAC,CAAC,GAAG,GAAG,IAAI;IACvC,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,CAAC,CAAC;CACT,CAAC;AAGF,oBAAY,gBAAgB,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAG1F,oBAAY,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE3C,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAElD,oBAAY,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAExF,cAAc,kCAAkC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGlC,oBAAY,aAAa,GAAG;IAE3B,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAExF,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAElD,oBAAY,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5C,oBAAY,gBAAgB,CAAC,CAAC,GAAG,GAAG,IAAI;IACvC,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,cAAc,iBAAiB,CAAC;AAChC,cAAc,kCAAkC,CAAC"}

package/types.js

@@ -1,6 +1,8 @@
+// This should be converted to an interface so that StoreModel and it's dependencies aren't exported
 export { StoreModel } from "./clients/StoreModel";
 // This is for backward compatibility only, forcing typedefs to be compiled and packaged.
 // Use @finos/fdc3 instead of typedefs
 export { FDC3 } from "./typedefs";
+export * from "./typedoc-types";
 export * from "./platform/services/config/types";
 //# sourceMappingURL=types.js.map

package/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,yFAAyF;AACzF,sCAAsC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAsClC,cAAc,kCAAkC,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAEA,oGAAoG;AACpG,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,yFAAyF;AACzF,sCAAsC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAqBlC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kCAAkC,CAAC"}

package/common/events/PrivateEventManager.d.ts

@@ -1,95 +0,0 @@
-import { RouterListenerUnsubscribe } from "../../clients/routerClient";
-import PublicEventManager, { Unsubscriber } from "./PublicEventManager";
-declare type EventOptions = {
-    initialQueryTimeout: Number;
-    timeout: Number;
-};
-/**
- * This private Event Manager distributes events to remove event handlers (using the router).
- * It is used within the windowService and workspaceService. Clients use the PublicEventManager
- * in order to register and unregister handlers.
- *
- * The primary use is for FinsembleWindow events. FinsembleWindow is derived from PublicEventManager.
- *
- * The windowService will create multiple PrivateEventManagers, generally one per live window. Each
- * PrivateEventManager maintains its own private store of remote event handlers. Note that event handlers
- * may exist across multiple windows. For instance, a window called "Bobby" may want to know when another
- * window called "Gary" closes. When Bobby registers an event handler ("tell me when Gary closes") then
- * Gary's PrivateEventManager will gain a handler, which is associated with Bobby.
- *
- * In the above scenario, if Bobby (client) closes then Gary's PrivateEventManager will remove all references
- * to remote event handlers. But, if Gary closes then Bobby's references will become orphans - never triggered,
- * which is probably fine for most application logic.
- *
- * For more information on the distrubted event architecture - see https://miro.com/app/board/o9J_kwhN9zo=/
- *
- * Note, this class can also be used as a *local* event manager with the functions.
- */
-declare class EventManager extends PublicEventManager {
-    #private;
-    eventList: string[];
-    eventInternalHandlerMap: Record<string, string[]>;
-    remoteListenerEventMap: Record<string, string[]>;
-    windowToGuidsMap: Record<string, string[]>;
-    waitList: Record<string, Function>;
-    unsubscribes: RouterListenerUnsubscribe[];
-    /**
-     *Creates an instance of EventManager.
-     * @param {*} params
-     * @memberof EventManager
-     */
-    constructor(params: {
-        name: string;
-        sourceType?: string;
-    });
-    /**
-     * Removes all listeners associated with a window [that has closed]
-     */
-    private removeWindow;
-    /**
-     * Removes all listeners for a specific remote guid
-     */
-    private removeGuid;
-    /**
-     * Adds an individual remote listener (listenerGuid+event) to this event manager
-     */
-    registerRemoteEventHandler(event: string, listenerGuid: string, listenerWindow: string): void;
-    /**
-     * Removes an individual remote listener (listenerGuid+event) from this event manager
-     */
-    unregisterRemoteEventHandler(event: string, listenerGuid: string, listenerWindow: string): void;
-    /**
-     * We must wait for a remote transit if delayed
-     *
-     * @memberof EventManager
-     */
-    awaitRemoteDelayer(eventGuid: string, listenerGuid: string): Promise<Function>;
-    /**
-     * Sends a message to a remote listener (PublicEventManager) which will then emit a local Finsemble event.
-     *
-     * Called by this.trigger().
-     */
-    private queryRemoteListener;
-    /**
-     * Forwards an event to all remote listeners and then waits for them to respond.
-     * They may optionally interrupt the event by sending a "cancel" which results in FinsembleEvent throwing
-     * an exception. Any individual exception will cause this function to also throw an exception, thus
-     * interrupting the event (which occurs upstream, e.g. preventing a window from closing).
-     */
-    trigger(event: string, data?: any, options?: EventOptions): Promise<any[] | void>;
-    /**
-     * Adds a *local* event listener.
-     */
-    addEventListener(event: string, handler: Function): Unsubscriber;
-    /**
-     * Removes a *local* event listener.
-     */
-    removeEventListener(event: string, handler: Function): void;
-    /**
-     * Removes all router listeners and subscriptions. This is called when the windowService terminates this
-     * PrivateEventManager (e.g. because the window has closed).
-     */
-    cleanup(): void;
-}
-export default EventManager;
-//# sourceMappingURL=PrivateEventManager.d.ts.map

package/common/events/PrivateEventManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PrivateEventManager.d.ts","sourceRoot":"","sources":["../../../../src/common/events/PrivateEventManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAErF,OAAO,kBAAkB,EAAE,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAKxE,aAAK,YAAY,GAAG;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,cAAM,YAAa,SAAQ,kBAAkB;;IAM5C,SAAS,EAAE,MAAM,EAAE,CAAM;IAEzB,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAM;IAEvD,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAM;IAEtD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAM;IAEhD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAM;IAExC,YAAY,EAAE,yBAAyB,EAAE,CAAM;IAE/C;;;;OAIG;gBACS,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;IA8BzD;;OAEG;IACH,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,UAAU;IASlB;;OAEG;IACH,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI;IAM7F;;OAEG;IACH,4BAA4B,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI;IAkB/F;;;;OAIG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgB9E;;;;OAIG;YACW,mBAAmB;IAqEjC;;;;;OAKG;IACG,OAAO,CACZ,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,GAAU,EAChB,OAAO,GAAE,YAA4D,GACnE,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IAsCxB;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,YAAY;IAgBhE;;OAEG;IACH,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAc3D;;;OAGG;IACH,OAAO;CASP;AAED,eAAe,YAAY,CAAC"}