@finsemble/finsemble-ui 7.0.0 → 7.1.0-beta.2

package/react/components/windowTitleBar/components/windowTitle.js

@@ -7,9 +7,17 @@ var _Title_instances, _Title_getWindowManagerForTab, _Title_calculateTabTitle, _
 import React, { Component } from "react";
 import { Icon } from "../../icon/Icon";
 import { Store } from "../stores/windowTitleBarStore";
+// The store name for the distributed store which tracks tab titles
 const WINDOW_TAB_TITLE_STORE = "window-tab-title";
+// The field name to watch for tab title edits
 const FIELD_NAME_PERSISTED_TITLE = "persistedTitle";
+// The windowTabNameStore reference
 let windowTabNameStore;
+/**
+ * Gets the store which tracks the tab title for a windowName. This is a distributed store shared by all components.
+ *
+ * @returns a Promise which resolves the StoreModel associated with window and tab names
+ */
 const getWindowTabNameStore = async () => {
     if (!windowTabNameStore) {
         let { data: store } = await FSBL.Clients.DistributedStoreClient.createGlobalStore({
@@ -17,23 +25,37 @@ const getWindowTabNameStore = async () => {
         });
         windowTabNameStore = store;
     }
+    // Return the store
     return windowTabNameStore;
 };
+/**
+ * The wrapper component for tab renaming
+ * @param {*} props
+ */
 function EditTab(props) {
     const [editingTitle, setEditingTitle] = React.useState(false);
     const [clickTimeout, setClickTimeout] = React.useState(undefined);
     const inputEl = React.useRef(null);
     const updateTabTitle = async (e) => {
+        // When the tab title has changed via a user edit, simply update the DistributedStore
+        // Get the title
         const title = e.target.value;
+        // Get the tab name store
         let store = await getWindowTabNameStore();
+        // If the store is unavailable, then the tab name cannot be persisted
         if (!store) {
+            // This is not critical, but tab titles may be stale
             FSBL.Clients.Logger.warn("Error persisting tab title via EditTab: the store was not found");
             return;
         }
+        // Persist the tab title
         store.setValue({ field: props.windowIdentifier.windowName, value: title });
+        // Get the window which coresponds to the tab being edited
         const { wrap: win } = await FSBL.FinsembleWindow.getInstance(props.windowIdentifier);
+        // Set the component state "persistedTitle" (which is the edited title)
         FSBL.Clients.Logger.debug(`Setting component state "${FIELD_NAME_PERSISTED_TITLE}" with value "${title}"`);
         await win.setComponentState({ field: FIELD_NAME_PERSISTED_TITLE, value: title });
+        // Stop editing in all cases
         setEditingTitle(false);
     };
     const beginEditing = async () => {
@@ -47,11 +69,13 @@ function EditTab(props) {
     const clickHandler = () => {
         const allowWindowTitleRenaming = Store.getValue("allowWindowTitleRenaming");
         if (clickTimeout) {
+            // double click
             if (allowWindowTitleRenaming) {
                 beginEditing();
             }
         }
         else if (!editingTitle) {
+            // single click
             let timeout = setTimeout(() => {
                 clearTimeout(clickTimeout);
                 setClickTimeout(undefined);
@@ -67,103 +91,207 @@ function EditTab(props) {
     const keyDownHandler = (e) => {
         e.key === "Enter" && updateTabTitle(e);
     };
-    return (React.createElement("div", { className: "fsbl-tab-editor", onClick: clickHandler }, editingTitle ? (React.createElement("div", { className: "fsbl-tab fsbl-active-tab", style: { width: props.tabWidth || "auto" } },
+    return (React.createElement("div", { className: "fsbl-tab-editor", 
+        // We can't use Click and Dblclick events together cause for one dblclick fires two click events which close title editor.
+        // Workaround with setTimeout should resolve this behavior.
+        onClick: clickHandler }, editingTitle ? (React.createElement("div", { className: "fsbl-tab fsbl-active-tab", style: { width: props.tabWidth || "auto" } },
         React.createElement("div", { draggable: true, onDragStart: (e) => {
                 e.stopPropagation();
                 e.preventDefault();
             } },
             React.createElement("input", { id: "title_editor_input", ref: inputEl, onBlur: blurHandler, onKeyDown: keyDownHandler, type: "text", className: "tab__input", maxLength: 32 })))) : (props.children)));
 }
+/*
+ * Description how stacked window tabs work.
+ *
+ * The simplest case - when you have only 2 tabs. In that case you will actually have 2 windows and 4 tabs.
+ * Lets call them as: window 1 - w1, window 2 - w2, tab 1 from window 1 - w1_t1, tab 2 from window 1 - w1_t2, for tabs from window 2 - w2_t1 and w2_t2.
+ * When you switch tabs you activate w1 or w2 with active tab w1_t1 or w2_t2 correspondingly.
+ * Tabs w1_t2 and w2_t1 are inactive. They needed only for rendering. I call them as remote tabs, cause their titles must be synchronized with active tabs titles.
+ * Thus when you rename active tab (w1_t1), the corresponding remote tab (w2_t1) should be updated automatically.
+ */
 export class Title extends Component {
     constructor(props) {
         var _a, _b, _c;
         super(props);
         _Title_instances.add(this);
+        // The listener for tab title change events via the DistributedStoreClient, kept as a reference so
+        // that the listener can be deregistered when the component is unmounted
         this.tabTitleChangedStoreListener = (err, response) => {
             if (!!err) {
+                // This is not critical; in the worst case this tab title will be stale
                 FSBL.Clients.Logger.warn(`Listener error for store "${WINDOW_TAB_TITLE_STORE}" for field "${this.props.windowIdentifier.windowName}"`, err);
                 return;
             }
+            // Log a message
             FSBL.Clients.Logger.debug(`Store "${WINDOW_TAB_TITLE_STORE}" notified of new title "${response.value}" for window "${response.field}"`);
+            // Invoke updateTitle
             if (!!this._mounted) {
                 this.updateTitle();
             }
         };
+        // Flag to determine if this instance is currently mounted; this is necessary because:
+        //  1.) Title components are mounted and unmounted as an artifact of how the tab or tab list is rendered
+        //  2.) Keeping tab titles synchronized is an asynchronous process
+        //  3.) During the asynchronous process of tab title synchronization, a call to setState is made and
+        //      that raises a React warning since the component state cannot be changed while the component
+        //      is unmounted
         this._mounted = false;
+        // Declare the initial title as a blank string
         let initialTitle = " ";
+        // If the currently rendering tab represents the current window, then use the document title (or window name)
         if (undefined !== (finsembleWindow === null || finsembleWindow === void 0 ? void 0 : finsembleWindow.thisWindowName) &&
             (finsembleWindow === null || finsembleWindow === void 0 ? void 0 : finsembleWindow.thisWindowName) === ((_a = props === null || props === void 0 ? void 0 : props.windowIdentifier) === null || _a === void 0 ? void 0 : _a.windowName)) {
             initialTitle = document.title || ((_b = props.windowIdentifier) === null || _b === void 0 ? void 0 : _b.windowName);
         }
         this.state = {
+            // Use document.title first to prevent a title flickering when dragging a tab of another window.
+            // The reason for flickering is the component re-rendering multiple times. The initial place
+            // where re-rendering start is the `disallowDragOnCenterRegion()` at the WindowTitleBarShell.
+            // At that function, we change the state of the parent component which triggers re-rendering for the children tree.
             title: initialTitle,
             icon: null,
+            // The "windowName" is the name of the window which corresponds to the this instance of the
+            // Title component, though the actual current window may belong to some other
+            // component(ie this tab represents an inactive window)
             windowName: (_c = props.windowIdentifier) === null || _c === void 0 ? void 0 : _c.windowName,
         };
+        // Bind the "updateTitle" function (in order to use React component functions)
         this.updateTitle = this.updateTitle.bind(this);
+        // Initial title set
         this.updateTitle();
     }
+    /**
+     * Updates the title for both the tab and the window.
+     *
+     * @returns a Promise which resolves nothing
+     */
     async updateTitle() {
+        // There is a subtle difference bewtween windowTitle and tabTitle. Since this code executes
+        // when *any* tab has a name change, this code can execute when the active window represents
+        // a tab other than the currently rendering tab (ie an inactive tab).
         var _a, _b, _c;
+        // The window represented by this tab title instance
         const { wrap: tabWindow } = await FSBL.FinsembleWindow.getInstance(this.props.windowIdentifier);
+        // "tabWindowOptions" refers to the options from the window which hosts the component represented by this tab
         const { data: tabWindowOptions } = await tabWindow.getOptions();
+        // Derive the title: "config title" then "document.title" then "appd title"
         let title = await __classPrivateFieldGet(this, _Title_instances, "m", _Title_calculateTabTitle).call(this);
+        // Get the titleBar icon from the WindowDescriptor for the TAB window (not the CURRENT window)
         const icon = (_c = (_b = (_a = tabWindowOptions) === null || _a === void 0 ? void 0 : _a.icons) === null || _b === void 0 ? void 0 : _b.titleBarIcon) !== null && _c !== void 0 ? _c : {
             imageType: "initials",
             name: title,
         };
+        // Log a message
         FSBL.Clients.Logger.debug(`Setting tab title ${title} for window ${this.props.windowIdentifier.windowName}`);
+        // Finally, set the state if the component is mounted
         if (!!this._mounted) {
             this.setState({
                 title,
-                icon: Object.assign(Object.assign({}, icon), { category: "Application" }),
+                icon: Object.assign(Object.assign({}, icon), { 
+                    // Application causes the background to default to a circle rather than a square
+                    category: "Application" }),
             });
         }
+        // If this tab component instance represents the window (that is, this is the active tab), then set the title
         if (finsembleWindow.thisWindowName === this.props.windowIdentifier.windowName) {
             document.title = await __classPrivateFieldGet(this, _Title_instances, "m", _Title_calculateTabTitle).call(this);
         }
     }
+    /**
+     * React component lifecycle event, triggered once the component has been added to the DOM.
+     */
     componentDidMount() {
+        // Set the mounted flag to true (this component is currently mounted)
         this._mounted = true;
+        // Add listeners
         __classPrivateFieldGet(this, _Title_instances, "m", _Title_addListeners).call(this);
     }
+    // Triggers a re-rendering of the drag handle in the title bar.
     componentDidUpdate() {
         if (typeof this.props.onUpdate === "function") {
             this.props.onUpdate();
         }
     }
+    /**
+     * React component lifecycle event, triggered before the component is removed from the DOM.
+     */
     componentWillUnmount() {
+        // Set the mounted flag to false (this component is not currently mounted)
         this._mounted = false;
+        // Remove listeners
         __classPrivateFieldGet(this, _Title_instances, "m", _Title_removeListeners).call(this);
     }
     render() {
         var _a;
         const { titleWidth } = this.props;
         const style = titleWidth ? { width: titleWidth } : {};
-        return (React.createElement(EditTab, { tabWidth: titleWidth, setActiveTab: (_a = this === null || this === void 0 ? void 0 : this.props) === null || _a === void 0 ? void 0 : _a.onClick, title: this.state.title, windowIdentifier: this.props.windowIdentifier },
+        return (React.createElement(EditTab, { tabWidth: titleWidth, setActiveTab: (_a = this === null || this === void 0 ? void 0 : this.props) === null || _a === void 0 ? void 0 : _a.onClick, title: this.state.title, 
+            // The windowIdentifier indicates which app/component this tab instance should represent
+            windowIdentifier: this.props.windowIdentifier },
             React.createElement("div", { className: "fsbl-tab-title", style: style },
                 this.state.icon && React.createElement(Icon, Object.assign({}, this.state.icon)),
                 React.createElement("div", { className: "title-text" }, this.state.title))));
     }
 }
-_Title_instances = new WeakSet(), _Title_getWindowManagerForTab = async function _Title_getWindowManagerForTab() {
+_Title_instances = new WeakSet(), _Title_getWindowManagerForTab = 
+/**
+ * Gets a reference to the "Window Manager" component for the tab which is rendering. If the this tab IS the active tab, then the WindowManager will be the same as the WindowManager
+ * attached to the WindowClient. However, all other tab components displayed in this window will need to derive the WindowManager from the config, based on the
+ * tab's windowIdentifier.
+ *
+ * This is because the tab's windowIdentifier only has the name (ex: SomeApp-37ba6708-3a75-462e-b900-1812e338cbf1). The name is derived by removing the last 5 substrings
+ * separated by "-". This will fail in the face of a UUID format change.
+ *
+ * @returns the "Window Manager" component, or "undefined" if the "Window Manager" is not found
+ */
+async function _Title_getWindowManagerForTab() {
+    // On second thought, ALL tabs will derive the WindowManager the same way; at least if it is wrong, it is wrong consistently
+    //
+    // if (finsembleWindow.thisWindowName === this.props?.windowIdentifier?.windowName) {
+    // 	return FSBL.Clients.WindowClient.options?.customData?.foreign?.components?.["Window Manager"] || FSBL.Clients.WindowClient.options?.customData?.appDConfig?.manifest?.foreign?.components?.["Window Manager"];
+    // } else {
     var _a, _b, _c, _d, _e, _f, _g, _h;
+    // Check that "windowName" exists
     if (!!((_b = (_a = this.props) === null || _a === void 0 ? void 0 : _a.windowIdentifier) === null || _b === void 0 ? void 0 : _b.windowName)) {
+        // Get the window name
         const tabsWindowName = this.props.windowIdentifier.windowName;
+        // Get the active descriptors
         const { data: activeDescriptors } = await FSBL.Clients.LauncherClient.getActiveDescriptors();
+        // Return the "Window Manager" for the window whose name matches THIS tab's name
         return (_h = (_g = (_f = (_e = (_d = (_c = activeDescriptors === null || activeDescriptors === void 0 ? void 0 : activeDescriptors[tabsWindowName]) === null || _c === void 0 ? void 0 : _c.customData) === null || _d === void 0 ? void 0 : _d.appDConfig) === null || _e === void 0 ? void 0 : _e.manifest) === null || _f === void 0 ? void 0 : _f.foreign) === null || _g === void 0 ? void 0 : _g.components) === null || _h === void 0 ? void 0 : _h["Window Manager"];
     }
     return undefined;
-}, _Title_calculateTabTitle = async function _Title_calculateTabTitle() {
+    // }
+}, _Title_calculateTabTitle = 
+/**
+ * Calculates a tab title. Uses the following algorithm until a non-null value is found.
+ * <ol>
+ *   <li>user edited tab title</li>
+ *   <li>the component config</li>
+ *   <li>document.title</li>
+ *   <li>appd config</li>
+ * </ol>
+ *
+ * @returns the calculated tab title
+ */
+async function _Title_calculateTabTitle() {
     return ((await __classPrivateFieldGet(this, _Title_instances, "m", _Title_getUserEditedTitle).call(this)) ||
         (await __classPrivateFieldGet(this, _Title_instances, "m", _Title_getConfigTitle).call(this)) ||
         (await __classPrivateFieldGet(this, _Title_instances, "m", _Title_getDocumentTitle).call(this)) ||
         __classPrivateFieldGet(this, _Title_instances, "m", _Title_getAppDTitle).call(this));
-}, _Title_getUserEditedTitle = async function _Title_getUserEditedTitle() {
+}, _Title_getUserEditedTitle = 
+/**
+ * Returns the name of the title supplied by a user; undefined if the user has not supplied a title.
+ *
+ * @returns The name of the title supplied by a user; undefined if the user has not supplied a title
+ */
+async function _Title_getUserEditedTitle() {
     const { wrap: tabWindow } = await FSBL.FinsembleWindow.getInstance(this.props.windowIdentifier);
     return new Promise((resolve) => {
         tabWindow.getComponentState({ field: FIELD_NAME_PERSISTED_TITLE }, (error, persistedTitle) => {
             if (!!error) {
+                // should always return value even if it hasn't been retrieved from the state
                 resolve(undefined);
             }
             else {
@@ -171,14 +299,28 @@ _Title_instances = new WeakSet(), _Title_getWindowManagerForTab = async function
             }
         });
     });
-}, _Title_getConfigTitle = async function _Title_getConfigTitle() {
+}, _Title_getConfigTitle = 
+/**
+ * Gets a title set in the component configuration.
+ *
+ * @returns any title set in the component configuration
+ */
+async function _Title_getConfigTitle() {
     var _a;
     const windowManager = await __classPrivateFieldGet(this, _Title_instances, "m", _Title_getWindowManagerForTab).call(this);
     return ((_a = windowManager === null || windowManager === void 0 ? void 0 : windowManager.FSBLHeader) === null || _a === void 0 ? void 0 : _a.title) || (windowManager === null || windowManager === void 0 ? void 0 : windowManager.title);
-}, _Title_getDocumentTitle = async function _Title_getDocumentTitle() {
+}, _Title_getDocumentTitle = 
+/**
+ * Returns document.title.
+ *
+ * @returns the document.title (from the "tab name" store)
+ */
+async function _Title_getDocumentTitle() {
     var _a, _b;
     const store = await getWindowTabNameStore();
+    // If the store is unavailable, then the tab name cannot be updated
     if (!store) {
+        // This is not critical, but tab titles may be stale
         FSBL.Clients.Logger.warn("Error setting the tab title: the store was not found");
         return;
     }
@@ -189,23 +331,43 @@ _Title_instances = new WeakSet(), _Title_getWindowManagerForTab = async function
     var _a, _b, _c, _d, _e, _f, _g, _h;
     return (((_e = (_d = (_c = (_b = (_a = FSBL.Clients.WindowClient.options) === null || _a === void 0 ? void 0 : _a.customData) === null || _b === void 0 ? void 0 : _b.appDConfig) === null || _c === void 0 ? void 0 : _c.manifest) === null || _d === void 0 ? void 0 : _d.component) === null || _e === void 0 ? void 0 : _e.displayName) ||
         ((_h = (_g = (_f = FSBL.Clients.WindowClient.options) === null || _f === void 0 ? void 0 : _f.customData) === null || _g === void 0 ? void 0 : _g.appDConfig) === null || _h === void 0 ? void 0 : _h.name));
-}, _Title_addListeners = async function _Title_addListeners() {
+}, _Title_addListeners = 
+/**
+ * Adds the listener(s) required to set window and tab titles.
+ */
+async function _Title_addListeners() {
+    // Subscribe to the DistributedStoreClient (these messages originate from BaseWindow, when the
+    // DistributedStore has been updated).
+    //
+    // Each window will have n listeners, where n is the number of tabs held in the window.
+    // Get the store and add a listener
     const store = await getWindowTabNameStore();
+    // If the store is unavailable, then the tab name cannot be updated
     if (!store) {
+        // This is not critical, but tab titles may be stale
         FSBL.Clients.Logger.warn("Error adding a tab title listener: the store was not found");
         return;
     }
+    // Add a listener
     store.addListener({ field: this.props.windowIdentifier.windowName }, this.tabTitleChangedStoreListener, () => {
         FSBL.Clients.Logger.debug(`Added listener to store "${WINDOW_TAB_TITLE_STORE}" for field "${this.props.windowIdentifier.windowName}"`);
     });
-}, _Title_removeListeners = async function _Title_removeListeners() {
+}, _Title_removeListeners = 
+/**
+ * Removes listener(s) required to set window and tab titles.
+ */
+async function _Title_removeListeners() {
+    // Unsubscribe from the window/tab store
     const store = await getWindowTabNameStore();
+    // If the store is unavailable, then the tab name cannot be updated
     if (!store) {
+        // This is not critical, but tab titles may be stale
         FSBL.Clients.Logger.warn("Error removing a tab title listener: the store was not found");
         return;
     }
     store.removeListener({ field: this.props.windowIdentifier.windowName }, this.tabTitleChangedStoreListener, (err, response) => {
         if (!!err) {
+            // This is not critical; the listener could not be removed from the store - this may be a memory leak
             FSBL.Clients.Logger.warn(`Could not remove listener from store "${WINDOW_TAB_TITLE_STORE}" for field "${this.props.windowIdentifier.windowName}"`, err);
             return;
         }

package/react/components/windowTitleBar/components/windowTitle.js.map

@@ -1 +1 @@
-{"version":3,"file":"windowTitle.js","sourceRoot":"","sources":["../../../../src/components/windowTitleBar/components/windowTitle.tsx"],"names":[],"mappings":";;;;;;AAGA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AAiDtD,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AAElD,MAAM,0BAA0B,GAAG,gBAAgB,CAAC;AAGpD,IAAI,kBAAuB,CAAC;AAO5B,MAAM,qBAAqB,GAAG,KAAK,IAAI,EAAE;IACxC,IAAI,CAAC,kBAAkB,EAAE;QACxB,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC;YACjF,KAAK,EAAE,sBAAsB;SAC7B,CAAC,CAAC;QACH,kBAAkB,GAAG,KAAK,CAAC;KAC3B;IAGD,OAAO,kBAAkB,CAAC;AAC3B,CAAC,CAAC;AAMF,SAAS,OAAO,CAAC,KAAmB;IACnC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAA6B,SAAS,CAAC,CAAC;IAC9F,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAmB,IAAI,CAAC,CAAC;IAErD,MAAM,cAAc,GAAG,KAAK,EAAE,CAA6E,EAAE,EAAE;QAI9G,MAAM,KAAK,GAAI,CAAC,CAAC,MAA2B,CAAC,KAAK,CAAC;QAGnD,IAAI,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,EAAE;YAEX,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;YAC5F,OAAO;SACP;QAGD,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAG3E,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAGrF,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,0BAA0B,iBAAiB,KAAK,GAAG,CAAC,CAAC;QAC3G,MAAM,GAAG,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,0BAA0B,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAGjF,eAAe,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;;QAC/B,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,0CAAE,KAAK,EAAE,CAAC;QAC1B,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE;YACrB,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG,MAAA,KAAK,CAAC,KAAK,mCAAI,EAAE,CAAC;SAC1C;IACF,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,GAAG,EAAE;QACzB,MAAM,wBAAwB,GAAG,KAAK,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAE5E,IAAI,YAAY,EAAE;YAEjB,IAAI,wBAAwB,EAAE;gBAC7B,YAAY,EAAE,CAAC;aACf;SACD;aAAM,IAAI,CAAC,YAAY,EAAE;YAEzB,IAAI,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC7B,YAAY,CAAC,YAAY,CAAC,CAAC;gBAC3B,eAAe,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC,EAAE,GAAG,CAAC,CAAC;YACR,eAAe,CAAC,OAAO,CAAC,CAAC;YACzB,IAAI,KAAK,CAAC,YAAY;gBAAE,KAAK,CAAC,YAAY,EAAE,CAAC;SAC7C;IACF,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,CAAqC,EAAE,EAAE;QAC7D,cAAc,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,CAAwC,EAAE,EAAE;QACnE,CAAC,CAAC,GAAG,KAAK,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,OAAO,CACN,6BACC,SAAS,EAAC,iBAAiB,EAG3B,OAAO,EAAE,YAAY,IAEpB,YAAY,CAAC,CAAC,CAAC,CACf,6BAAK,SAAS,EAAC,0BAA0B,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,QAAQ,IAAI,MAAM,EAAE;QAEnF,6BACC,SAAS,EAAE,IAAI,EACf,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE;gBAClB,CAAC,CAAC,eAAe,EAAE,CAAC;gBACpB,CAAC,CAAC,cAAc,EAAE,CAAC;YACpB,CAAC;YAED,+BACC,EAAE,EAAC,oBAAoB,EACvB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,WAAW,EACnB,SAAS,EAAE,cAAc,EACzB,IAAI,EAAC,MAAM,EACX,SAAS,EAAC,YAAY,EACtB,SAAS,EAAE,EAAE,GACZ,CACG,CACD,CACN,CAAC,CAAC,CAAC,CACH,KAAK,CAAC,QAAQ,CACd,CACI,CACN,CAAC;AACH,CAAC;AAYD,MAAM,OAAO,KAAM,SAAQ,SAAiC;IAgC3D,YAAY,KAAiB;;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;;QA9Bd,iCAA4B,GAAqB,CAAC,GAAkB,EAAE,QAA0C,EAAE,EAAE;YACnH,IAAI,CAAC,CAAC,GAAG,EAAE;gBAEV,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CACvB,6BAA6B,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,EAC5G,GAAG,CACH,CAAC;gBACF,OAAO;aACP;YAGD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CACxB,UAAU,sBAAsB,4BAA4B,QAAQ,CAAC,KAAK,iBAAiB,QAAQ,CAAC,KAAK,GAAG,CAC5G,CAAC;YAGF,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACpB,IAAI,CAAC,WAAW,EAAE,CAAC;aACnB;QACF,CAAC,CAAC;QAQF,aAAQ,GAAG,KAAK,CAAC;QAMhB,IAAI,YAAY,GAAG,GAAG,CAAC;QAGvB,IACC,SAAS,MAAK,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,cAAc,CAAA;YAC7C,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,cAAc,OAAK,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,gBAAgB,0CAAE,UAAU,CAAA,EACtE;YACD,YAAY,GAAG,QAAQ,CAAC,KAAK,KAAI,MAAA,KAAK,CAAC,gBAAgB,0CAAE,UAAU,CAAA,CAAC;SACpE;QAED,IAAI,CAAC,KAAK,GAAG;YAKZ,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,IAAI;YAIV,UAAU,EAAE,MAAA,KAAK,CAAC,gBAAgB,0CAAE,UAAU;SAC9C,CAAC;QAGF,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAG/C,IAAI,CAAC,WAAW,EAAE,CAAC;IACpB,CAAC;IAyHD,KAAK,CAAC,WAAW;;QAMhB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAGhG,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;QAGhE,IAAI,KAAK,GAAG,MAAM,uBAAA,IAAI,kDAAmB,MAAvB,IAAI,CAAqB,CAAC;QAG5C,MAAM,IAAI,GAAmB,MAAA,MAAA,MAAC,gBAAqC,0CAAE,KAAK,0CAAE,YAAY,mCAAI;YAC3F,SAAS,EAAE,UAAU;YACrB,IAAI,EAAE,KAAK;SACX,CAAC;QAGF,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,KAAK,eAAe,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC;QAG7G,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE;YACpB,IAAI,CAAC,QAAQ,CAAC;gBACb,KAAK;gBACL,IAAI,kCACA,IAAI,KAEP,QAAQ,EAAE,aAAa,GACvB;aACD,CAAC,CAAC;SACH;QAGD,IAAI,eAAe,CAAC,cAAc,KAAK,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE;YAC9E,QAAQ,CAAC,KAAK,GAAG,MAAM,uBAAA,IAAI,kDAAmB,MAAvB,IAAI,CAAqB,CAAC;SACjD;IACF,CAAC;IA+DD,iBAAiB;QAEhB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAGrB,uBAAA,IAAI,6CAAc,MAAlB,IAAI,CAAgB,CAAC;IACtB,CAAC;IAGD,kBAAkB;QACjB,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,UAAU,EAAE;YAC9C,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;SACtB;IACF,CAAC;IAKD,oBAAoB;QAEnB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAGtB,uBAAA,IAAI,gDAAiB,MAArB,IAAI,CAAmB,CAAC;IACzB,CAAC;IAED,MAAM;;QACL,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAClC,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO,CACN,oBAAC,OAAO,IACP,QAAQ,EAAE,UAAU,EACpB,YAAY,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,OAAO,EAClC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAEvB,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB;YAE7C,6BAAK,SAAS,EAAC,gBAAgB,EAAC,KAAK,EAAE,KAAK;gBAC1C,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,oBAAC,IAAI,oBAAK,IAAI,CAAC,KAAK,CAAC,IAAI,EAAI;gBACjD,6BAAK,SAAS,EAAC,YAAY,IAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAO,CAC/C,CACG,CACV,CAAC;IACH,CAAC;CACD;kEA/PA,KAAK;;IAQJ,IAAI,CAAC,CAAC,CAAA,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,gBAAgB,0CAAE,UAAU,CAAA,EAAE;QAE/C,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC;QAE9D,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;QAE7F,OAAO,MAAA,MAAA,MAAA,MAAA,MAAA,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,cAAc,CAAC,0CAAE,UAAU,0CAAE,UAAU,0CAAE,QAAQ,0CAAE,OAAO,0CAAE,UAAU,0CAChG,gBAAgB,CAChB,CAAC;KACF;IAED,OAAO,SAAS,CAAC;AAElB,CAAC,6BAaD,KAAK;IACJ,OAAO,CACN,CAAC,MAAM,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,CAAsB,CAAC;QAClC,CAAC,MAAM,uBAAA,IAAI,+CAAgB,MAApB,IAAI,CAAkB,CAAC;QAC9B,CAAC,MAAM,uBAAA,IAAI,iDAAkB,MAAtB,IAAI,CAAoB,CAAC;QAChC,uBAAA,IAAI,6CAAc,MAAlB,IAAI,CAAgB,CACpB,CAAC;AACH,CAAC,8BAOD,KAAK;IACJ,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAChG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC9B,SAAS,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,0BAA0B,EAAE,EAAE,CAAC,KAAU,EAAE,cAAmB,EAAE,EAAE;YACtG,IAAI,CAAC,CAAC,KAAK,EAAE;gBAEZ,OAAO,CAAC,SAAS,CAAC,CAAC;aACnB;iBAAM;gBACN,OAAO,CAAC,cAAc,CAAC,CAAC;aACxB;QACF,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,0BAOD,KAAK;;IACJ,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,uDAAwB,MAA5B,IAAI,CAA0B,CAAC;IAC3D,OAAO,CAAA,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,UAAU,0CAAE,KAAK,MAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,CAAA,CAAC;AACjE,CAAC,4BAOD,KAAK;;IACJ,MAAM,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;IAG5C,IAAI,CAAC,KAAK,EAAE;QAEX,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;QACjF,OAAO;KACP;IAED,OAAO,CAAA,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,gBAAgB,0CAAE,UAAU;QAC9C,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI;QAC3E,CAAC,CAAC,SAAS,CAAC;AACd,CAAC;;IAQA,OAAO,CACN,CAAA,MAAA,MAAA,MAAA,MAAA,MAAA,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,0CAAE,UAAU,0CAAE,UAAU,0CAAE,QAAQ,0CAAE,SAAS,0CAAE,WAAW;SAC3F,MAAA,MAAA,MAAA,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,0CAAE,UAAU,0CAAE,UAAU,0CAAE,IAAI,CAAA,CAC/D,CAAC;AACH,CAAC,wBAmDD,KAAK;IAOJ,MAAM,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;IAG5C,IAAI,CAAC,KAAK,EAAE;QAEX,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;QACvF,OAAO;KACP;IAGD,KAAK,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;QAC5G,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CACxB,4BAA4B,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,CAC3G,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC,2BAKD,KAAK;IAEJ,MAAM,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;IAE5C,IAAI,CAAC,KAAK,EAAE;QAEX,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;QACzF,OAAO;KACP;IACD,KAAK,CAAC,cAAc,CACnB,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,EACjD,IAAI,CAAC,4BAA4B,EACjC,CAAC,GAAkB,EAAE,QAA6B,EAAE,EAAE;QACrD,IAAI,CAAC,CAAC,GAAG,EAAE;YAEV,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CACvB,yCAAyC,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,EACxH,GAAG,CACH,CAAC;YACF,OAAO;SACP;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CACxB,8BAA8B,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,CAC7G,CAAC;IACH,CAAC,CACD,CAAC;AACH,CAAC","sourcesContent":["import { WindowIdentifier, WindowDescriptor, services } from \"@finsemble/finsemble-api\";\nimport { ListenerFunction } from \"@finsemble/finsemble-api/types/clients/StoreModel\";\nimport { StandardError } from \"@finsemble/finsemble-api/types/types\";\nimport React, { Component } from \"react\";\nimport { EditTabProps } from \"../../../types/windowTitleBar\";\nimport { Icon } from \"../../icon/Icon\";\nimport { Store } from \"../stores/windowTitleBarStore\";\n\ntype IconDescriptor = services.window.types.IconDescriptor;\n\n/**\n * TAB TITLES: HOW DO THEY WORK?\n *\n * Each component, when stacked, will have several tab titles. For each component, there is a window. For each window, there are 2 tab titles per component.\n *\n * Whichever component is \"active\" will render all tabs - exactly one \"active\" tab and n-1 \"inactive\" tabs (where n is the number of components in the stack). When\n * the active component is changed (via a click, for example), then the visible window becomes the window associated with the active component.\n *\n * Tab titles may change at any time, and for a number of reasons. For example, the component may execute \"document.title='...some title'\". Or perhaps the tab title has\n * been edited by the user. In order to account for all title changes, the following flow is used:\n *   *something* updates document.title\n *   The WindowClient for the component will notice the title change and send a router message (via FinsembleWindow.setTitle) with a topic representitive of the windowName\n *   BaseWindow listens to router changes on the same topic and updates a DistributedStore dedicated to tab names\n *   The tab components all subscribe to the DistributedStore dedicated to tab names and will update the title accordingly\n *\n * This is a \"one-way\" operation; that is to say that some code will ultimately alter the DistributedStore and the tab title components will read the changes. While this generally\n * happens with a write to document.title, it can also happen when a user edits the tab title manually. In this case, the component state is altered with a field \"persistedTitle\"\n * whose value is the edited title. At render time, the tab title component will use any value in \"persistedTitle\" as the title, irregardless of any other value.\n *\n * NOTE: A tab may be edited only when it is the active component; ergo the call to \"setComponentState\" is safe.\n */\n\n/**\n * WINDOW TITLES: HOW DO THEY WORK?\n *\n * Each application window has a title which is displayed in the operating system taskbar and task switcher. This title comes from the\n * value of \"document.title\" in the window title bar component. It is important to understand that when tabs are stacked, the actual window\n * which holds the window title is the title of the window of the active component. It is therefore important to keep the window title and the\n * tab titles up to date and synchronized.\n */\n\ntype TitleProps = {\n\twindowIdentifier: WindowIdentifier;\n\tonUpdate?: Function;\n\ttitleWidth?: number;\n\tonClick?: () => void;\n};\n\ntype TitleState = {\n\ttitle: string | undefined;\n\ticon: any;\n\twindowName?: string;\n};\n\n// The store name for the distributed store which tracks tab titles\nconst WINDOW_TAB_TITLE_STORE = \"window-tab-title\";\n// The field name to watch for tab title edits\nconst FIELD_NAME_PERSISTED_TITLE = \"persistedTitle\";\n\n// The windowTabNameStore reference\nlet windowTabNameStore: any;\n\n/**\n * Gets the store which tracks the tab title for a windowName. This is a distributed store shared by all components.\n *\n * @returns a Promise which resolves the StoreModel associated with window and tab names\n */\nconst getWindowTabNameStore = async () => {\n\tif (!windowTabNameStore) {\n\t\tlet { data: store } = await FSBL.Clients.DistributedStoreClient.createGlobalStore({\n\t\t\tstore: WINDOW_TAB_TITLE_STORE,\n\t\t});\n\t\twindowTabNameStore = store;\n\t}\n\n\t// Return the store\n\treturn windowTabNameStore;\n};\n\n/**\n * The wrapper component for tab renaming\n * @param {*} props\n */\nfunction EditTab(props: EditTabProps) {\n\tconst [editingTitle, setEditingTitle] = React.useState(false);\n\tconst [clickTimeout, setClickTimeout] = React.useState<NodeJS.Timeout | undefined>(undefined);\n\tconst inputEl = React.useRef<HTMLInputElement>(null);\n\n\tconst updateTabTitle = async (e: React.KeyboardEvent<HTMLInputElement> | React.FocusEvent<HTMLInputElement>) => {\n\t\t// When the tab title has changed via a user edit, simply update the DistributedStore\n\n\t\t// Get the title\n\t\tconst title = (e.target as HTMLInputElement).value;\n\n\t\t// Get the tab name store\n\t\tlet store = await getWindowTabNameStore();\n\t\t// If the store is unavailable, then the tab name cannot be persisted\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error persisting tab title via EditTab: the store was not found\");\n\t\t\treturn;\n\t\t}\n\n\t\t// Persist the tab title\n\t\tstore.setValue({ field: props.windowIdentifier.windowName, value: title });\n\n\t\t// Get the window which coresponds to the tab being edited\n\t\tconst { wrap: win } = await FSBL.FinsembleWindow.getInstance(props.windowIdentifier);\n\n\t\t// Set the component state \"persistedTitle\" (which is the edited title)\n\t\tFSBL.Clients.Logger.debug(`Setting component state \"${FIELD_NAME_PERSISTED_TITLE}\" with value \"${title}\"`);\n\t\tawait win.setComponentState({ field: FIELD_NAME_PERSISTED_TITLE, value: title });\n\n\t\t// Stop editing in all cases\n\t\tsetEditingTitle(false);\n\t};\n\n\tconst beginEditing = async () => {\n\t\tawait setEditingTitle(true);\n\t\tinputEl?.current?.focus();\n\t\tif (inputEl?.current) {\n\t\t\tinputEl.current.value = props.title ?? \"\";\n\t\t}\n\t};\n\n\tconst clickHandler = () => {\n\t\tconst allowWindowTitleRenaming = Store.getValue(\"allowWindowTitleRenaming\");\n\n\t\tif (clickTimeout) {\n\t\t\t// double click\n\t\t\tif (allowWindowTitleRenaming) {\n\t\t\t\tbeginEditing();\n\t\t\t}\n\t\t} else if (!editingTitle) {\n\t\t\t// single click\n\t\t\tlet timeout = setTimeout(() => {\n\t\t\t\tclearTimeout(clickTimeout);\n\t\t\t\tsetClickTimeout(undefined);\n\t\t\t}, 500);\n\t\t\tsetClickTimeout(timeout);\n\t\t\tif (props.setActiveTab) props.setActiveTab();\n\t\t}\n\t};\n\n\tconst blurHandler = (e: React.FocusEvent<HTMLInputElement>) => {\n\t\tupdateTabTitle(e);\n\t};\n\n\tconst keyDownHandler = (e: React.KeyboardEvent<HTMLInputElement>) => {\n\t\te.key === \"Enter\" && updateTabTitle(e);\n\t};\n\n\treturn (\n\t\t<div\n\t\t\tclassName=\"fsbl-tab-editor\"\n\t\t\t// We can't use Click and Dblclick events together cause for one dblclick fires two click events which close title editor.\n\t\t\t// Workaround with setTimeout should resolve this behavior.\n\t\t\tonClick={clickHandler}\n\t\t>\n\t\t\t{editingTitle ? (\n\t\t\t\t<div className=\"fsbl-tab fsbl-active-tab\" style={{ width: props.tabWidth || \"auto\" }}>\n\t\t\t\t\t{/* workaround to disable tab dragging in the edit mode */}\n\t\t\t\t\t<div\n\t\t\t\t\t\tdraggable={true}\n\t\t\t\t\t\tonDragStart={(e) => {\n\t\t\t\t\t\t\te.stopPropagation();\n\t\t\t\t\t\t\te.preventDefault();\n\t\t\t\t\t\t}}\n\t\t\t\t\t>\n\t\t\t\t\t\t<input\n\t\t\t\t\t\t\tid=\"title_editor_input\"\n\t\t\t\t\t\t\tref={inputEl}\n\t\t\t\t\t\t\tonBlur={blurHandler}\n\t\t\t\t\t\t\tonKeyDown={keyDownHandler}\n\t\t\t\t\t\t\ttype=\"text\"\n\t\t\t\t\t\t\tclassName=\"tab__input\"\n\t\t\t\t\t\t\tmaxLength={32}\n\t\t\t\t\t\t/>\n\t\t\t\t\t</div>\n\t\t\t\t</div>\n\t\t\t) : (\n\t\t\t\tprops.children\n\t\t\t)}\n\t\t</div>\n\t);\n}\n\n/*\n * Description how stacked window tabs work.\n *\n * The simplest case - when you have only 2 tabs. In that case you will actually have 2 windows and 4 tabs.\n * Lets call them as: window 1 - w1, window 2 - w2, tab 1 from window 1 - w1_t1, tab 2 from window 1 - w1_t2, for tabs from window 2 - w2_t1 and w2_t2.\n * When you switch tabs you activate w1 or w2 with active tab w1_t1 or w2_t2 correspondingly.\n * Tabs w1_t2 and w2_t1 are inactive. They needed only for rendering. I call them as remote tabs, cause their titles must be synchronized with active tabs titles.\n * Thus when you rename active tab (w1_t1), the corresponding remote tab (w2_t1) should be updated automatically.\n */\n\nexport class Title extends Component<TitleProps, TitleState> {\n\t// The listener for tab title change events via the DistributedStoreClient, kept as a reference so\n\t// that the listener can be deregistered when the component is unmounted\n\ttabTitleChangedStoreListener: ListenerFunction = (err: StandardError, response: { field: string; value: string }) => {\n\t\tif (!!err) {\n\t\t\t// This is not critical; in the worst case this tab title will be stale\n\t\t\tFSBL.Clients.Logger.warn(\n\t\t\t\t`Listener error for store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`,\n\t\t\t\terr\n\t\t\t);\n\t\t\treturn;\n\t\t}\n\n\t\t// Log a message\n\t\tFSBL.Clients.Logger.debug(\n\t\t\t`Store \"${WINDOW_TAB_TITLE_STORE}\" notified of new title \"${response.value}\" for window \"${response.field}\"`\n\t\t);\n\n\t\t// Invoke updateTitle\n\t\tif (!!this._mounted) {\n\t\t\tthis.updateTitle();\n\t\t}\n\t};\n\n\t// Flag to determine if this instance is currently mounted; this is necessary because:\n\t//  1.) Title components are mounted and unmounted as an artifact of how the tab or tab list is rendered\n\t//  2.) Keeping tab titles synchronized is an asynchronous process\n\t//  3.) During the asynchronous process of tab title synchronization, a call to setState is made and\n\t//      that raises a React warning since the component state cannot be changed while the component\n\t//      is unmounted\n\t_mounted = false;\n\n\tconstructor(props: TitleProps) {\n\t\tsuper(props);\n\n\t\t// Declare the initial title as a blank string\n\t\tlet initialTitle = \" \";\n\n\t\t// If the currently rendering tab represents the current window, then use the document title (or window name)\n\t\tif (\n\t\t\tundefined !== finsembleWindow?.thisWindowName &&\n\t\t\tfinsembleWindow?.thisWindowName === props?.windowIdentifier?.windowName\n\t\t) {\n\t\t\tinitialTitle = document.title || props.windowIdentifier?.windowName;\n\t\t}\n\n\t\tthis.state = {\n\t\t\t// Use document.title first to prevent a title flickering when dragging a tab of another window.\n\t\t\t// The reason for flickering is the component re-rendering multiple times. The initial place\n\t\t\t// where re-rendering start is the `disallowDragOnCenterRegion()` at the WindowTitleBarShell.\n\t\t\t// At that function, we change the state of the parent component which triggers re-rendering for the children tree.\n\t\t\ttitle: initialTitle,\n\t\t\ticon: null,\n\t\t\t// The \"windowName\" is the name of the window which corresponds to the this instance of the\n\t\t\t// Title component, though the actual current window may belong to some other\n\t\t\t// component(ie this tab represents an inactive window)\n\t\t\twindowName: props.windowIdentifier?.windowName,\n\t\t};\n\n\t\t// Bind the \"updateTitle\" function (in order to use React component functions)\n\t\tthis.updateTitle = this.updateTitle.bind(this);\n\n\t\t// Initial title set\n\t\tthis.updateTitle();\n\t}\n\n\t/**\n\t * Gets a reference to the \"Window Manager\" component for the tab which is rendering. If the this tab IS the active tab, then the WindowManager will be the same as the WindowManager\n\t * attached to the WindowClient. However, all other tab components displayed in this window will need to derive the WindowManager from the config, based on the\n\t * tab's windowIdentifier.\n\t *\n\t * This is because the tab's windowIdentifier only has the name (ex: SomeApp-37ba6708-3a75-462e-b900-1812e338cbf1). The name is derived by removing the last 5 substrings\n\t * separated by \"-\". This will fail in the face of a UUID format change.\n\t *\n\t * @returns the \"Window Manager\" component, or \"undefined\" if the \"Window Manager\" is not found\n\t */\n\tasync #getWindowManagerForTab() {\n\t\t// On second thought, ALL tabs will derive the WindowManager the same way; at least if it is wrong, it is wrong consistently\n\t\t//\n\t\t// if (finsembleWindow.thisWindowName === this.props?.windowIdentifier?.windowName) {\n\t\t// \treturn FSBL.Clients.WindowClient.options?.customData?.foreign?.components?.[\"Window Manager\"] || FSBL.Clients.WindowClient.options?.customData?.appDConfig?.manifest?.foreign?.components?.[\"Window Manager\"];\n\t\t// } else {\n\n\t\t// Check that \"windowName\" exists\n\t\tif (!!this.props?.windowIdentifier?.windowName) {\n\t\t\t// Get the window name\n\t\t\tconst tabsWindowName = this.props.windowIdentifier.windowName;\n\t\t\t// Get the active descriptors\n\t\t\tconst { data: activeDescriptors } = await FSBL.Clients.LauncherClient.getActiveDescriptors();\n\t\t\t// Return the \"Window Manager\" for the window whose name matches THIS tab's name\n\t\t\treturn activeDescriptors?.[tabsWindowName]?.customData?.appDConfig?.manifest?.foreign?.components?.[\n\t\t\t\t\"Window Manager\"\n\t\t\t];\n\t\t}\n\n\t\treturn undefined;\n\t\t// }\n\t}\n\n\t/**\n\t * Calculates a tab title. Uses the following algorithm until a non-null value is found.\n\t * <ol>\n\t *   <li>user edited tab title</li>\n\t *   <li>the component config</li>\n\t *   <li>document.title</li>\n\t *   <li>appd config</li>\n\t * </ol>\n\t *\n\t * @returns the calculated tab title\n\t */\n\tasync #calculateTabTitle() {\n\t\treturn (\n\t\t\t(await this.#getUserEditedTitle()) ||\n\t\t\t(await this.#getConfigTitle()) ||\n\t\t\t(await this.#getDocumentTitle()) ||\n\t\t\tthis.#getAppDTitle()\n\t\t);\n\t}\n\n\t/**\n\t * Returns the name of the title supplied by a user; undefined if the user has not supplied a title.\n\t *\n\t * @returns The name of the title supplied by a user; undefined if the user has not supplied a title\n\t */\n\tasync #getUserEditedTitle() {\n\t\tconst { wrap: tabWindow } = await FSBL.FinsembleWindow.getInstance(this.props.windowIdentifier);\n\t\treturn new Promise((resolve) => {\n\t\t\ttabWindow.getComponentState({ field: FIELD_NAME_PERSISTED_TITLE }, (error: any, persistedTitle: any) => {\n\t\t\t\tif (!!error) {\n\t\t\t\t\t// should always return value even if it hasn't been retrieved from the state\n\t\t\t\t\tresolve(undefined);\n\t\t\t\t} else {\n\t\t\t\t\tresolve(persistedTitle);\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\t}\n\n\t/**\n\t * Gets a title set in the component configuration.\n\t *\n\t * @returns any title set in the component configuration\n\t */\n\tasync #getConfigTitle() {\n\t\tconst windowManager = await this.#getWindowManagerForTab();\n\t\treturn windowManager?.FSBLHeader?.title || windowManager?.title;\n\t}\n\n\t/**\n\t * Returns document.title.\n\t *\n\t * @returns the document.title (from the \"tab name\" store)\n\t */\n\tasync #getDocumentTitle() {\n\t\tconst store = await getWindowTabNameStore();\n\n\t\t// If the store is unavailable, then the tab name cannot be updated\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error setting the tab title: the store was not found\");\n\t\t\treturn;\n\t\t}\n\n\t\treturn this.props?.windowIdentifier?.windowName\n\t\t\t? (await store.getGlobalValue(this.props.windowIdentifier.windowName)).data\n\t\t\t: undefined;\n\t}\n\n\t/**\n\t * Gets the AppD configuration\n\t *\n\t * @returns The AppD name\n\t */\n\t#getAppDTitle() {\n\t\treturn (\n\t\t\tFSBL.Clients.WindowClient.options?.customData?.appDConfig?.manifest?.component?.displayName ||\n\t\t\tFSBL.Clients.WindowClient.options?.customData?.appDConfig?.name\n\t\t);\n\t}\n\n\t/**\n\t * Updates the title for both the tab and the window.\n\t *\n\t * @returns a Promise which resolves nothing\n\t */\n\tasync updateTitle() {\n\t\t// There is a subtle difference bewtween windowTitle and tabTitle. Since this code executes\n\t\t// when *any* tab has a name change, this code can execute when the active window represents\n\t\t// a tab other than the currently rendering tab (ie an inactive tab).\n\n\t\t// The window represented by this tab title instance\n\t\tconst { wrap: tabWindow } = await FSBL.FinsembleWindow.getInstance(this.props.windowIdentifier);\n\n\t\t// \"tabWindowOptions\" refers to the options from the window which hosts the component represented by this tab\n\t\tconst { data: tabWindowOptions } = await tabWindow.getOptions();\n\n\t\t// Derive the title: \"config title\" then \"document.title\" then \"appd title\"\n\t\tlet title = await this.#calculateTabTitle();\n\n\t\t// Get the titleBar icon from the WindowDescriptor for the TAB window (not the CURRENT window)\n\t\tconst icon: IconDescriptor = (tabWindowOptions as WindowDescriptor)?.icons?.titleBarIcon ?? {\n\t\t\timageType: \"initials\",\n\t\t\tname: title,\n\t\t};\n\n\t\t// Log a message\n\t\tFSBL.Clients.Logger.debug(`Setting tab title ${title} for window ${this.props.windowIdentifier.windowName}`);\n\n\t\t// Finally, set the state if the component is mounted\n\t\tif (!!this._mounted) {\n\t\t\tthis.setState({\n\t\t\t\ttitle,\n\t\t\t\ticon: {\n\t\t\t\t\t...icon,\n\t\t\t\t\t// Application causes the background to default to a circle rather than a square\n\t\t\t\t\tcategory: \"Application\",\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\t// If this tab component instance represents the window (that is, this is the active tab), then set the title\n\t\tif (finsembleWindow.thisWindowName === this.props.windowIdentifier.windowName) {\n\t\t\tdocument.title = await this.#calculateTabTitle();\n\t\t}\n\t}\n\n\t/**\n\t * Adds the listener(s) required to set window and tab titles.\n\t */\n\tasync #addListeners() {\n\t\t// Subscribe to the DistributedStoreClient (these messages originate from BaseWindow, when the\n\t\t// DistributedStore has been updated).\n\t\t//\n\t\t// Each window will have n listeners, where n is the number of tabs held in the window.\n\n\t\t// Get the store and add a listener\n\t\tconst store = await getWindowTabNameStore();\n\n\t\t// If the store is unavailable, then the tab name cannot be updated\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error adding a tab title listener: the store was not found\");\n\t\t\treturn;\n\t\t}\n\n\t\t// Add a listener\n\t\tstore.addListener({ field: this.props.windowIdentifier.windowName }, this.tabTitleChangedStoreListener, () => {\n\t\t\tFSBL.Clients.Logger.debug(\n\t\t\t\t`Added listener to store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`\n\t\t\t);\n\t\t});\n\t}\n\n\t/**\n\t * Removes listener(s) required to set window and tab titles.\n\t */\n\tasync #removeListeners() {\n\t\t// Unsubscribe from the window/tab store\n\t\tconst store = await getWindowTabNameStore();\n\t\t// If the store is unavailable, then the tab name cannot be updated\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error removing a tab title listener: the store was not found\");\n\t\t\treturn;\n\t\t}\n\t\tstore.removeListener(\n\t\t\t{ field: this.props.windowIdentifier.windowName },\n\t\t\tthis.tabTitleChangedStoreListener,\n\t\t\t(err: StandardError, response: boolean | undefined) => {\n\t\t\t\tif (!!err) {\n\t\t\t\t\t// This is not critical; the listener could not be removed from the store - this may be a memory leak\n\t\t\t\t\tFSBL.Clients.Logger.warn(\n\t\t\t\t\t\t`Could not remove listener from store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`,\n\t\t\t\t\t\terr\n\t\t\t\t\t);\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tFSBL.Clients.Logger.debug(\n\t\t\t\t\t`Removed listener to store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`\n\t\t\t\t);\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * React component lifecycle event, triggered once the component has been added to the DOM.\n\t */\n\tcomponentDidMount() {\n\t\t// Set the mounted flag to true (this component is currently mounted)\n\t\tthis._mounted = true;\n\n\t\t// Add listeners\n\t\tthis.#addListeners();\n\t}\n\n\t// Triggers a re-rendering of the drag handle in the title bar.\n\tcomponentDidUpdate() {\n\t\tif (typeof this.props.onUpdate === \"function\") {\n\t\t\tthis.props.onUpdate();\n\t\t}\n\t}\n\n\t/**\n\t * React component lifecycle event, triggered before the component is removed from the DOM.\n\t */\n\tcomponentWillUnmount() {\n\t\t// Set the mounted flag to false (this component is not currently mounted)\n\t\tthis._mounted = false;\n\n\t\t// Remove listeners\n\t\tthis.#removeListeners();\n\t}\n\n\trender() {\n\t\tconst { titleWidth } = this.props;\n\t\tconst style = titleWidth ? { width: titleWidth } : {};\n\t\treturn (\n\t\t\t<EditTab\n\t\t\t\ttabWidth={titleWidth}\n\t\t\t\tsetActiveTab={this?.props?.onClick}\n\t\t\t\ttitle={this.state.title}\n\t\t\t\t// The windowIdentifier indicates which app/component this tab instance should represent\n\t\t\t\twindowIdentifier={this.props.windowIdentifier}\n\t\t\t>\n\t\t\t\t<div className=\"fsbl-tab-title\" style={style}>\n\t\t\t\t\t{this.state.icon && <Icon {...this.state.icon} />}\n\t\t\t\t\t<div className=\"title-text\">{this.state.title}</div>\n\t\t\t\t</div>\n\t\t\t</EditTab>\n\t\t);\n\t}\n}\n"]}
+{"version":3,"file":"windowTitle.js","sourceRoot":"","sources":["../../../../src/components/windowTitleBar/components/windowTitle.tsx"],"names":[],"mappings":";;;;;;AAGA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AAgDtD,mEAAmE;AACnE,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AAClD,8CAA8C;AAC9C,MAAM,0BAA0B,GAAG,gBAAgB,CAAC;AAEpD,mCAAmC;AACnC,IAAI,kBAAuB,CAAC;AAE5B;;;;GAIG;AACH,MAAM,qBAAqB,GAAG,KAAK,IAAI,EAAE;IACxC,IAAI,CAAC,kBAAkB,EAAE;QACxB,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC;YACjF,KAAK,EAAE,sBAAsB;SAC7B,CAAC,CAAC;QACH,kBAAkB,GAAG,KAAK,CAAC;KAC3B;IAED,mBAAmB;IACnB,OAAO,kBAAkB,CAAC;AAC3B,CAAC,CAAC;AAEF;;;GAGG;AACH,SAAS,OAAO,CAAC,KAAmB;IACnC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAA6B,SAAS,CAAC,CAAC;IAC9F,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAmB,IAAI,CAAC,CAAC;IAErD,MAAM,cAAc,GAAG,KAAK,EAAE,CAA6E,EAAE,EAAE;QAC9G,qFAAqF;QAErF,gBAAgB;QAChB,MAAM,KAAK,GAAI,CAAC,CAAC,MAA2B,CAAC,KAAK,CAAC;QAEnD,yBAAyB;QACzB,IAAI,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;QAC1C,qEAAqE;QACrE,IAAI,CAAC,KAAK,EAAE;YACX,oDAAoD;YACpD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;YAC5F,OAAO;SACP;QAED,wBAAwB;QACxB,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAE3E,0DAA0D;QAC1D,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAErF,uEAAuE;QACvE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,0BAA0B,iBAAiB,KAAK,GAAG,CAAC,CAAC;QAC3G,MAAM,GAAG,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,0BAA0B,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAEjF,4BAA4B;QAC5B,eAAe,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;;QAC/B,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,0CAAE,KAAK,EAAE,CAAC;QAC1B,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE;YACrB,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG,MAAA,KAAK,CAAC,KAAK,mCAAI,EAAE,CAAC;SAC1C;IACF,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,GAAG,EAAE;QACzB,MAAM,wBAAwB,GAAG,KAAK,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAE5E,IAAI,YAAY,EAAE;YACjB,eAAe;YACf,IAAI,wBAAwB,EAAE;gBAC7B,YAAY,EAAE,CAAC;aACf;SACD;aAAM,IAAI,CAAC,YAAY,EAAE;YACzB,eAAe;YACf,IAAI,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC7B,YAAY,CAAC,YAAY,CAAC,CAAC;gBAC3B,eAAe,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC,EAAE,GAAG,CAAC,CAAC;YACR,eAAe,CAAC,OAAO,CAAC,CAAC;YACzB,IAAI,KAAK,CAAC,YAAY;gBAAE,KAAK,CAAC,YAAY,EAAE,CAAC;SAC7C;IACF,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,CAAqC,EAAE,EAAE;QAC7D,cAAc,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,CAAwC,EAAE,EAAE;QACnE,CAAC,CAAC,GAAG,KAAK,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF,OAAO,CACN,6BACC,SAAS,EAAC,iBAAiB;QAC3B,0HAA0H;QAC1H,2DAA2D;QAC3D,OAAO,EAAE,YAAY,IAEpB,YAAY,CAAC,CAAC,CAAC,CACf,6BAAK,SAAS,EAAC,0BAA0B,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,QAAQ,IAAI,MAAM,EAAE;QAEnF,6BACC,SAAS,EAAE,IAAI,EACf,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE;gBAClB,CAAC,CAAC,eAAe,EAAE,CAAC;gBACpB,CAAC,CAAC,cAAc,EAAE,CAAC;YACpB,CAAC;YAED,+BACC,EAAE,EAAC,oBAAoB,EACvB,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,WAAW,EACnB,SAAS,EAAE,cAAc,EACzB,IAAI,EAAC,MAAM,EACX,SAAS,EAAC,YAAY,EACtB,SAAS,EAAE,EAAE,GACZ,CACG,CACD,CACN,CAAC,CAAC,CAAC,CACH,KAAK,CAAC,QAAQ,CACd,CACI,CACN,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AAEH,MAAM,OAAO,KAAM,SAAQ,SAAiC;IAgC3D,YAAY,KAAiB;;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;;QAhCd,kGAAkG;QAClG,wEAAwE;QACxE,iCAA4B,GAAqB,CAAC,GAAkB,EAAE,QAA0C,EAAE,EAAE;YACnH,IAAI,CAAC,CAAC,GAAG,EAAE;gBACV,uEAAuE;gBACvE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CACvB,6BAA6B,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,EAC5G,GAAG,CACH,CAAC;gBACF,OAAO;aACP;YAED,gBAAgB;YAChB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CACxB,UAAU,sBAAsB,4BAA4B,QAAQ,CAAC,KAAK,iBAAiB,QAAQ,CAAC,KAAK,GAAG,CAC5G,CAAC;YAEF,qBAAqB;YACrB,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACpB,IAAI,CAAC,WAAW,EAAE,CAAC;aACnB;QACF,CAAC,CAAC;QAEF,sFAAsF;QACtF,wGAAwG;QACxG,kEAAkE;QAClE,oGAAoG;QACpG,mGAAmG;QACnG,oBAAoB;QACpB,aAAQ,GAAG,KAAK,CAAC;QAKhB,8CAA8C;QAC9C,IAAI,YAAY,GAAG,GAAG,CAAC;QAEvB,6GAA6G;QAC7G,IACC,SAAS,MAAK,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,cAAc,CAAA;YAC7C,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,cAAc,OAAK,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,gBAAgB,0CAAE,UAAU,CAAA,EACtE;YACD,YAAY,GAAG,QAAQ,CAAC,KAAK,KAAI,MAAA,KAAK,CAAC,gBAAgB,0CAAE,UAAU,CAAA,CAAC;SACpE;QAED,IAAI,CAAC,KAAK,GAAG;YACZ,gGAAgG;YAChG,4FAA4F;YAC5F,6FAA6F;YAC7F,mHAAmH;YACnH,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,IAAI;YACV,2FAA2F;YAC3F,6EAA6E;YAC7E,uDAAuD;YACvD,UAAU,EAAE,MAAA,KAAK,CAAC,gBAAgB,0CAAE,UAAU;SAC9C,CAAC;QAEF,8EAA8E;QAC9E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE/C,oBAAoB;QACpB,IAAI,CAAC,WAAW,EAAE,CAAC;IACpB,CAAC;IAoHD;;;;OAIG;IACH,KAAK,CAAC,WAAW;QAChB,2FAA2F;QAC3F,4FAA4F;QAC5F,qEAAqE;;QAErE,oDAAoD;QACpD,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAEhG,6GAA6G;QAC7G,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;QAEhE,2EAA2E;QAC3E,IAAI,KAAK,GAAG,MAAM,uBAAA,IAAI,kDAAmB,MAAvB,IAAI,CAAqB,CAAC;QAE5C,8FAA8F;QAC9F,MAAM,IAAI,GAAmB,MAAA,MAAA,MAAC,gBAAqC,0CAAE,KAAK,0CAAE,YAAY,mCAAI;YAC3F,SAAS,EAAE,UAAU;YACrB,IAAI,EAAE,KAAK;SACX,CAAC;QAEF,gBAAgB;QAChB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,KAAK,eAAe,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC;QAE7G,qDAAqD;QACrD,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE;YACpB,IAAI,CAAC,QAAQ,CAAC;gBACb,KAAK;gBACL,IAAI,kCACA,IAAI;oBACP,gFAAgF;oBAChF,QAAQ,EAAE,aAAa,GACvB;aACD,CAAC,CAAC;SACH;QAED,6GAA6G;QAC7G,IAAI,eAAe,CAAC,cAAc,KAAK,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE;YAC9E,QAAQ,CAAC,KAAK,GAAG,MAAM,uBAAA,IAAI,kDAAmB,MAAvB,IAAI,CAAqB,CAAC;SACjD;IACF,CAAC;IA4DD;;OAEG;IACH,iBAAiB;QAChB,qEAAqE;QACrE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,gBAAgB;QAChB,uBAAA,IAAI,6CAAc,MAAlB,IAAI,CAAgB,CAAC;IACtB,CAAC;IAED,+DAA+D;IAC/D,kBAAkB;QACjB,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,UAAU,EAAE;YAC9C,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;SACtB;IACF,CAAC;IAED;;OAEG;IACH,oBAAoB;QACnB,0EAA0E;QAC1E,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAEtB,mBAAmB;QACnB,uBAAA,IAAI,gDAAiB,MAArB,IAAI,CAAmB,CAAC;IACzB,CAAC;IAED,MAAM;;QACL,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAClC,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO,CACN,oBAAC,OAAO,IACP,QAAQ,EAAE,UAAU,EACpB,YAAY,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,OAAO,EAClC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,wFAAwF;YACxF,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB;YAE7C,6BAAK,SAAS,EAAC,gBAAgB,EAAC,KAAK,EAAE,KAAK;gBAC1C,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,oBAAC,IAAI,oBAAK,IAAI,CAAC,KAAK,CAAC,IAAI,EAAI;gBACjD,6BAAK,SAAS,EAAC,YAAY,IAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAO,CAC/C,CACG,CACV,CAAC;IACH,CAAC;CACD;;AAzQA;;;;;;;;;GASG;AACH,KAAK;IACJ,4HAA4H;IAC5H,EAAE;IACF,qFAAqF;IACrF,kNAAkN;IAClN,WAAW;;IAEX,iCAAiC;IACjC,IAAI,CAAC,CAAC,CAAA,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,gBAAgB,0CAAE,UAAU,CAAA,EAAE;QAC/C,sBAAsB;QACtB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC;QAC9D,6BAA6B;QAC7B,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,oBAAoB,EAAE,CAAC;QAC7F,gFAAgF;QAChF,OAAO,MAAA,MAAA,MAAA,MAAA,MAAA,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAG,cAAc,CAAC,0CAAE,UAAU,0CAAE,UAAU,0CAAE,QAAQ,0CAAE,OAAO,0CAAE,UAAU,0CAChG,gBAAgB,CAChB,CAAC;KACF;IAED,OAAO,SAAS,CAAC;IACjB,IAAI;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK;IACJ,OAAO,CACN,CAAC,MAAM,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,CAAsB,CAAC;QAClC,CAAC,MAAM,uBAAA,IAAI,+CAAgB,MAApB,IAAI,CAAkB,CAAC;QAC9B,CAAC,MAAM,uBAAA,IAAI,iDAAkB,MAAtB,IAAI,CAAoB,CAAC;QAChC,uBAAA,IAAI,6CAAc,MAAlB,IAAI,CAAgB,CACpB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,KAAK;IACJ,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAChG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC9B,SAAS,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,0BAA0B,EAAE,EAAE,CAAC,KAAU,EAAE,cAAmB,EAAE,EAAE;YACtG,IAAI,CAAC,CAAC,KAAK,EAAE;gBACZ,6EAA6E;gBAC7E,OAAO,CAAC,SAAS,CAAC,CAAC;aACnB;iBAAM;gBACN,OAAO,CAAC,cAAc,CAAC,CAAC;aACxB;QACF,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK;;IACJ,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,uDAAwB,MAA5B,IAAI,CAA0B,CAAC;IAC3D,OAAO,CAAA,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,UAAU,0CAAE,KAAK,MAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,CAAA,CAAC;AACjE,CAAC;AAED;;;;GAIG;AACH,KAAK;;IACJ,MAAM,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;IAE5C,mEAAmE;IACnE,IAAI,CAAC,KAAK,EAAE;QACX,oDAAoD;QACpD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;QACjF,OAAO;KACP;IAED,OAAO,CAAA,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,gBAAgB,0CAAE,UAAU;QAC9C,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI;QAC3E,CAAC,CAAC,SAAS,CAAC;AACd,CAAC;;IAQA,OAAO,CACN,CAAA,MAAA,MAAA,MAAA,MAAA,MAAA,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,0CAAE,UAAU,0CAAE,UAAU,0CAAE,QAAQ,0CAAE,SAAS,0CAAE,WAAW;SAC3F,MAAA,MAAA,MAAA,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,0CAAE,UAAU,0CAAE,UAAU,0CAAE,IAAI,CAAA,CAC/D,CAAC;AACH,CAAC;AAgDD;;GAEG;AACH,KAAK;IACJ,8FAA8F;IAC9F,sCAAsC;IACtC,EAAE;IACF,uFAAuF;IAEvF,mCAAmC;IACnC,MAAM,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;IAE5C,mEAAmE;IACnE,IAAI,CAAC,KAAK,EAAE;QACX,oDAAoD;QACpD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;QACvF,OAAO;KACP;IAED,iBAAiB;IACjB,KAAK,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE;QAC5G,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CACxB,4BAA4B,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,CAC3G,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,KAAK;IACJ,wCAAwC;IACxC,MAAM,KAAK,GAAG,MAAM,qBAAqB,EAAE,CAAC;IAC5C,mEAAmE;IACnE,IAAI,CAAC,KAAK,EAAE;QACX,oDAAoD;QACpD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;QACzF,OAAO;KACP;IACD,KAAK,CAAC,cAAc,CACnB,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,EACjD,IAAI,CAAC,4BAA4B,EACjC,CAAC,GAAkB,EAAE,QAA6B,EAAE,EAAE;QACrD,IAAI,CAAC,CAAC,GAAG,EAAE;YACV,qGAAqG;YACrG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CACvB,yCAAyC,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,EACxH,GAAG,CACH,CAAC;YACF,OAAO;SACP;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CACxB,8BAA8B,sBAAsB,gBAAgB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,GAAG,CAC7G,CAAC;IACH,CAAC,CACD,CAAC;AACH,CAAC","sourcesContent":["import { WindowIdentifier, WindowDescriptor, services } from \"@finsemble/finsemble-api\";\nimport { ListenerFunction } from \"@finsemble/finsemble-api/types/clients/StoreModel\";\nimport { StandardError } from \"@finsemble/finsemble-api/types/types\";\nimport React, { Component } from \"react\";\nimport { EditTabProps } from \"../../../types/windowTitleBar\";\nimport { Icon } from \"../../icon/Icon\";\nimport { Store } from \"../stores/windowTitleBarStore\";\n\ntype IconDescriptor = services.window.types.IconDescriptor;\n\n/**\n * TAB TITLES: HOW DO THEY WORK?\n *\n * Each component, when stacked, will have several tab titles. For each component, there is a window. For each window, there are 2 tab titles per component.\n *\n * Whichever component is \"active\" will render all tabs - exactly one \"active\" tab and n-1 \"inactive\" tabs (where n is the number of components in the stack). When\n * the active component is changed (via a click, for example), then the visible window becomes the window associated with the active component.\n *\n * Tab titles may change at any time, and for a number of reasons. For example, the component may execute \"document.title='...some title'\". Or perhaps the tab title has\n * been edited by the user. In order to account for all title changes, the following flow is used:\n *   *something* updates document.title\n *   The WindowClient for the component will notice the title change and send a router message (via FinsembleWindow.setTitle) with a topic representitive of the windowName\n *   BaseWindow listens to router changes on the same topic and updates a DistributedStore dedicated to tab names\n *   The tab components all subscribe to the DistributedStore dedicated to tab names and will update the title accordingly\n *\n * This is a \"one-way\" operation; that is to say that some code will ultimately alter the DistributedStore and the tab title components will read the changes. While this generally\n * happens with a write to document.title, it can also happen when a user edits the tab title manually. In this case, the component state is altered with a field \"persistedTitle\"\n * whose value is the edited title. At render time, the tab title component will use any value in \"persistedTitle\" as the title, irregardless of any other value.\n *\n * NOTE: A tab may be edited only when it is the active component; ergo the call to \"setComponentState\" is safe.\n */\n\n/**\n * WINDOW TITLES: HOW DO THEY WORK?\n *\n * Each application window has a title which is displayed in the operating system taskbar and task switcher. This title comes from the\n * value of \"document.title\" in the window title bar component. It is important to understand that when tabs are stacked, the actual window\n * which holds the window title is the title of the window of the active component. It is therefore important to keep the window title and the\n * tab titles up to date and synchronized.\n */\n\ntype TitleProps = {\n\twindowIdentifier: WindowIdentifier;\n\tonUpdate?: Function;\n\ttitleWidth?: number;\n\tonClick?: () => void;\n};\n\ntype TitleState = {\n\ttitle: string | undefined;\n\ticon: any;\n\twindowName?: string;\n};\n\n// The store name for the distributed store which tracks tab titles\nconst WINDOW_TAB_TITLE_STORE = \"window-tab-title\";\n// The field name to watch for tab title edits\nconst FIELD_NAME_PERSISTED_TITLE = \"persistedTitle\";\n\n// The windowTabNameStore reference\nlet windowTabNameStore: any;\n\n/**\n * Gets the store which tracks the tab title for a windowName. This is a distributed store shared by all components.\n *\n * @returns a Promise which resolves the StoreModel associated with window and tab names\n */\nconst getWindowTabNameStore = async () => {\n\tif (!windowTabNameStore) {\n\t\tlet { data: store } = await FSBL.Clients.DistributedStoreClient.createGlobalStore({\n\t\t\tstore: WINDOW_TAB_TITLE_STORE,\n\t\t});\n\t\twindowTabNameStore = store;\n\t}\n\n\t// Return the store\n\treturn windowTabNameStore;\n};\n\n/**\n * The wrapper component for tab renaming\n * @param {*} props\n */\nfunction EditTab(props: EditTabProps) {\n\tconst [editingTitle, setEditingTitle] = React.useState(false);\n\tconst [clickTimeout, setClickTimeout] = React.useState<NodeJS.Timeout | undefined>(undefined);\n\tconst inputEl = React.useRef<HTMLInputElement>(null);\n\n\tconst updateTabTitle = async (e: React.KeyboardEvent<HTMLInputElement> | React.FocusEvent<HTMLInputElement>) => {\n\t\t// When the tab title has changed via a user edit, simply update the DistributedStore\n\n\t\t// Get the title\n\t\tconst title = (e.target as HTMLInputElement).value;\n\n\t\t// Get the tab name store\n\t\tlet store = await getWindowTabNameStore();\n\t\t// If the store is unavailable, then the tab name cannot be persisted\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error persisting tab title via EditTab: the store was not found\");\n\t\t\treturn;\n\t\t}\n\n\t\t// Persist the tab title\n\t\tstore.setValue({ field: props.windowIdentifier.windowName, value: title });\n\n\t\t// Get the window which coresponds to the tab being edited\n\t\tconst { wrap: win } = await FSBL.FinsembleWindow.getInstance(props.windowIdentifier);\n\n\t\t// Set the component state \"persistedTitle\" (which is the edited title)\n\t\tFSBL.Clients.Logger.debug(`Setting component state \"${FIELD_NAME_PERSISTED_TITLE}\" with value \"${title}\"`);\n\t\tawait win.setComponentState({ field: FIELD_NAME_PERSISTED_TITLE, value: title });\n\n\t\t// Stop editing in all cases\n\t\tsetEditingTitle(false);\n\t};\n\n\tconst beginEditing = async () => {\n\t\tawait setEditingTitle(true);\n\t\tinputEl?.current?.focus();\n\t\tif (inputEl?.current) {\n\t\t\tinputEl.current.value = props.title ?? \"\";\n\t\t}\n\t};\n\n\tconst clickHandler = () => {\n\t\tconst allowWindowTitleRenaming = Store.getValue(\"allowWindowTitleRenaming\");\n\n\t\tif (clickTimeout) {\n\t\t\t// double click\n\t\t\tif (allowWindowTitleRenaming) {\n\t\t\t\tbeginEditing();\n\t\t\t}\n\t\t} else if (!editingTitle) {\n\t\t\t// single click\n\t\t\tlet timeout = setTimeout(() => {\n\t\t\t\tclearTimeout(clickTimeout);\n\t\t\t\tsetClickTimeout(undefined);\n\t\t\t}, 500);\n\t\t\tsetClickTimeout(timeout);\n\t\t\tif (props.setActiveTab) props.setActiveTab();\n\t\t}\n\t};\n\n\tconst blurHandler = (e: React.FocusEvent<HTMLInputElement>) => {\n\t\tupdateTabTitle(e);\n\t};\n\n\tconst keyDownHandler = (e: React.KeyboardEvent<HTMLInputElement>) => {\n\t\te.key === \"Enter\" && updateTabTitle(e);\n\t};\n\n\treturn (\n\t\t<div\n\t\t\tclassName=\"fsbl-tab-editor\"\n\t\t\t// We can't use Click and Dblclick events together cause for one dblclick fires two click events which close title editor.\n\t\t\t// Workaround with setTimeout should resolve this behavior.\n\t\t\tonClick={clickHandler}\n\t\t>\n\t\t\t{editingTitle ? (\n\t\t\t\t<div className=\"fsbl-tab fsbl-active-tab\" style={{ width: props.tabWidth || \"auto\" }}>\n\t\t\t\t\t{/* workaround to disable tab dragging in the edit mode */}\n\t\t\t\t\t<div\n\t\t\t\t\t\tdraggable={true}\n\t\t\t\t\t\tonDragStart={(e) => {\n\t\t\t\t\t\t\te.stopPropagation();\n\t\t\t\t\t\t\te.preventDefault();\n\t\t\t\t\t\t}}\n\t\t\t\t\t>\n\t\t\t\t\t\t<input\n\t\t\t\t\t\t\tid=\"title_editor_input\"\n\t\t\t\t\t\t\tref={inputEl}\n\t\t\t\t\t\t\tonBlur={blurHandler}\n\t\t\t\t\t\t\tonKeyDown={keyDownHandler}\n\t\t\t\t\t\t\ttype=\"text\"\n\t\t\t\t\t\t\tclassName=\"tab__input\"\n\t\t\t\t\t\t\tmaxLength={32}\n\t\t\t\t\t\t/>\n\t\t\t\t\t</div>\n\t\t\t\t</div>\n\t\t\t) : (\n\t\t\t\tprops.children\n\t\t\t)}\n\t\t</div>\n\t);\n}\n\n/*\n * Description how stacked window tabs work.\n *\n * The simplest case - when you have only 2 tabs. In that case you will actually have 2 windows and 4 tabs.\n * Lets call them as: window 1 - w1, window 2 - w2, tab 1 from window 1 - w1_t1, tab 2 from window 1 - w1_t2, for tabs from window 2 - w2_t1 and w2_t2.\n * When you switch tabs you activate w1 or w2 with active tab w1_t1 or w2_t2 correspondingly.\n * Tabs w1_t2 and w2_t1 are inactive. They needed only for rendering. I call them as remote tabs, cause their titles must be synchronized with active tabs titles.\n * Thus when you rename active tab (w1_t1), the corresponding remote tab (w2_t1) should be updated automatically.\n */\n\nexport class Title extends Component<TitleProps, TitleState> {\n\t// The listener for tab title change events via the DistributedStoreClient, kept as a reference so\n\t// that the listener can be deregistered when the component is unmounted\n\ttabTitleChangedStoreListener: ListenerFunction = (err: StandardError, response: { field: string; value: string }) => {\n\t\tif (!!err) {\n\t\t\t// This is not critical; in the worst case this tab title will be stale\n\t\t\tFSBL.Clients.Logger.warn(\n\t\t\t\t`Listener error for store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`,\n\t\t\t\terr\n\t\t\t);\n\t\t\treturn;\n\t\t}\n\n\t\t// Log a message\n\t\tFSBL.Clients.Logger.debug(\n\t\t\t`Store \"${WINDOW_TAB_TITLE_STORE}\" notified of new title \"${response.value}\" for window \"${response.field}\"`\n\t\t);\n\n\t\t// Invoke updateTitle\n\t\tif (!!this._mounted) {\n\t\t\tthis.updateTitle();\n\t\t}\n\t};\n\n\t// Flag to determine if this instance is currently mounted; this is necessary because:\n\t//  1.) Title components are mounted and unmounted as an artifact of how the tab or tab list is rendered\n\t//  2.) Keeping tab titles synchronized is an asynchronous process\n\t//  3.) During the asynchronous process of tab title synchronization, a call to setState is made and\n\t//      that raises a React warning since the component state cannot be changed while the component\n\t//      is unmounted\n\t_mounted = false;\n\n\tconstructor(props: TitleProps) {\n\t\tsuper(props);\n\n\t\t// Declare the initial title as a blank string\n\t\tlet initialTitle = \" \";\n\n\t\t// If the currently rendering tab represents the current window, then use the document title (or window name)\n\t\tif (\n\t\t\tundefined !== finsembleWindow?.thisWindowName &&\n\t\t\tfinsembleWindow?.thisWindowName === props?.windowIdentifier?.windowName\n\t\t) {\n\t\t\tinitialTitle = document.title || props.windowIdentifier?.windowName;\n\t\t}\n\n\t\tthis.state = {\n\t\t\t// Use document.title first to prevent a title flickering when dragging a tab of another window.\n\t\t\t// The reason for flickering is the component re-rendering multiple times. The initial place\n\t\t\t// where re-rendering start is the `disallowDragOnCenterRegion()` at the WindowTitleBarShell.\n\t\t\t// At that function, we change the state of the parent component which triggers re-rendering for the children tree.\n\t\t\ttitle: initialTitle,\n\t\t\ticon: null,\n\t\t\t// The \"windowName\" is the name of the window which corresponds to the this instance of the\n\t\t\t// Title component, though the actual current window may belong to some other\n\t\t\t// component(ie this tab represents an inactive window)\n\t\t\twindowName: props.windowIdentifier?.windowName,\n\t\t};\n\n\t\t// Bind the \"updateTitle\" function (in order to use React component functions)\n\t\tthis.updateTitle = this.updateTitle.bind(this);\n\n\t\t// Initial title set\n\t\tthis.updateTitle();\n\t}\n\n\t/**\n\t * Gets a reference to the \"Window Manager\" component for the tab which is rendering. If the this tab IS the active tab, then the WindowManager will be the same as the WindowManager\n\t * attached to the WindowClient. However, all other tab components displayed in this window will need to derive the WindowManager from the config, based on the\n\t * tab's windowIdentifier.\n\t *\n\t * This is because the tab's windowIdentifier only has the name (ex: SomeApp-37ba6708-3a75-462e-b900-1812e338cbf1). The name is derived by removing the last 5 substrings\n\t * separated by \"-\". This will fail in the face of a UUID format change.\n\t *\n\t * @returns the \"Window Manager\" component, or \"undefined\" if the \"Window Manager\" is not found\n\t */\n\tasync #getWindowManagerForTab() {\n\t\t// On second thought, ALL tabs will derive the WindowManager the same way; at least if it is wrong, it is wrong consistently\n\t\t//\n\t\t// if (finsembleWindow.thisWindowName === this.props?.windowIdentifier?.windowName) {\n\t\t// \treturn FSBL.Clients.WindowClient.options?.customData?.foreign?.components?.[\"Window Manager\"] || FSBL.Clients.WindowClient.options?.customData?.appDConfig?.manifest?.foreign?.components?.[\"Window Manager\"];\n\t\t// } else {\n\n\t\t// Check that \"windowName\" exists\n\t\tif (!!this.props?.windowIdentifier?.windowName) {\n\t\t\t// Get the window name\n\t\t\tconst tabsWindowName = this.props.windowIdentifier.windowName;\n\t\t\t// Get the active descriptors\n\t\t\tconst { data: activeDescriptors } = await FSBL.Clients.LauncherClient.getActiveDescriptors();\n\t\t\t// Return the \"Window Manager\" for the window whose name matches THIS tab's name\n\t\t\treturn activeDescriptors?.[tabsWindowName]?.customData?.appDConfig?.manifest?.foreign?.components?.[\n\t\t\t\t\"Window Manager\"\n\t\t\t];\n\t\t}\n\n\t\treturn undefined;\n\t\t// }\n\t}\n\n\t/**\n\t * Calculates a tab title. Uses the following algorithm until a non-null value is found.\n\t * <ol>\n\t *   <li>user edited tab title</li>\n\t *   <li>the component config</li>\n\t *   <li>document.title</li>\n\t *   <li>appd config</li>\n\t * </ol>\n\t *\n\t * @returns the calculated tab title\n\t */\n\tasync #calculateTabTitle() {\n\t\treturn (\n\t\t\t(await this.#getUserEditedTitle()) ||\n\t\t\t(await this.#getConfigTitle()) ||\n\t\t\t(await this.#getDocumentTitle()) ||\n\t\t\tthis.#getAppDTitle()\n\t\t);\n\t}\n\n\t/**\n\t * Returns the name of the title supplied by a user; undefined if the user has not supplied a title.\n\t *\n\t * @returns The name of the title supplied by a user; undefined if the user has not supplied a title\n\t */\n\tasync #getUserEditedTitle() {\n\t\tconst { wrap: tabWindow } = await FSBL.FinsembleWindow.getInstance(this.props.windowIdentifier);\n\t\treturn new Promise((resolve) => {\n\t\t\ttabWindow.getComponentState({ field: FIELD_NAME_PERSISTED_TITLE }, (error: any, persistedTitle: any) => {\n\t\t\t\tif (!!error) {\n\t\t\t\t\t// should always return value even if it hasn't been retrieved from the state\n\t\t\t\t\tresolve(undefined);\n\t\t\t\t} else {\n\t\t\t\t\tresolve(persistedTitle);\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\t}\n\n\t/**\n\t * Gets a title set in the component configuration.\n\t *\n\t * @returns any title set in the component configuration\n\t */\n\tasync #getConfigTitle() {\n\t\tconst windowManager = await this.#getWindowManagerForTab();\n\t\treturn windowManager?.FSBLHeader?.title || windowManager?.title;\n\t}\n\n\t/**\n\t * Returns document.title.\n\t *\n\t * @returns the document.title (from the \"tab name\" store)\n\t */\n\tasync #getDocumentTitle() {\n\t\tconst store = await getWindowTabNameStore();\n\n\t\t// If the store is unavailable, then the tab name cannot be updated\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error setting the tab title: the store was not found\");\n\t\t\treturn;\n\t\t}\n\n\t\treturn this.props?.windowIdentifier?.windowName\n\t\t\t? (await store.getGlobalValue(this.props.windowIdentifier.windowName)).data\n\t\t\t: undefined;\n\t}\n\n\t/**\n\t * Gets the AppD configuration\n\t *\n\t * @returns The AppD name\n\t */\n\t#getAppDTitle() {\n\t\treturn (\n\t\t\tFSBL.Clients.WindowClient.options?.customData?.appDConfig?.manifest?.component?.displayName ||\n\t\t\tFSBL.Clients.WindowClient.options?.customData?.appDConfig?.name\n\t\t);\n\t}\n\n\t/**\n\t * Updates the title for both the tab and the window.\n\t *\n\t * @returns a Promise which resolves nothing\n\t */\n\tasync updateTitle() {\n\t\t// There is a subtle difference bewtween windowTitle and tabTitle. Since this code executes\n\t\t// when *any* tab has a name change, this code can execute when the active window represents\n\t\t// a tab other than the currently rendering tab (ie an inactive tab).\n\n\t\t// The window represented by this tab title instance\n\t\tconst { wrap: tabWindow } = await FSBL.FinsembleWindow.getInstance(this.props.windowIdentifier);\n\n\t\t// \"tabWindowOptions\" refers to the options from the window which hosts the component represented by this tab\n\t\tconst { data: tabWindowOptions } = await tabWindow.getOptions();\n\n\t\t// Derive the title: \"config title\" then \"document.title\" then \"appd title\"\n\t\tlet title = await this.#calculateTabTitle();\n\n\t\t// Get the titleBar icon from the WindowDescriptor for the TAB window (not the CURRENT window)\n\t\tconst icon: IconDescriptor = (tabWindowOptions as WindowDescriptor)?.icons?.titleBarIcon ?? {\n\t\t\timageType: \"initials\",\n\t\t\tname: title,\n\t\t};\n\n\t\t// Log a message\n\t\tFSBL.Clients.Logger.debug(`Setting tab title ${title} for window ${this.props.windowIdentifier.windowName}`);\n\n\t\t// Finally, set the state if the component is mounted\n\t\tif (!!this._mounted) {\n\t\t\tthis.setState({\n\t\t\t\ttitle,\n\t\t\t\ticon: {\n\t\t\t\t\t...icon,\n\t\t\t\t\t// Application causes the background to default to a circle rather than a square\n\t\t\t\t\tcategory: \"Application\",\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\t// If this tab component instance represents the window (that is, this is the active tab), then set the title\n\t\tif (finsembleWindow.thisWindowName === this.props.windowIdentifier.windowName) {\n\t\t\tdocument.title = await this.#calculateTabTitle();\n\t\t}\n\t}\n\n\t/**\n\t * Adds the listener(s) required to set window and tab titles.\n\t */\n\tasync #addListeners() {\n\t\t// Subscribe to the DistributedStoreClient (these messages originate from BaseWindow, when the\n\t\t// DistributedStore has been updated).\n\t\t//\n\t\t// Each window will have n listeners, where n is the number of tabs held in the window.\n\n\t\t// Get the store and add a listener\n\t\tconst store = await getWindowTabNameStore();\n\n\t\t// If the store is unavailable, then the tab name cannot be updated\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error adding a tab title listener: the store was not found\");\n\t\t\treturn;\n\t\t}\n\n\t\t// Add a listener\n\t\tstore.addListener({ field: this.props.windowIdentifier.windowName }, this.tabTitleChangedStoreListener, () => {\n\t\t\tFSBL.Clients.Logger.debug(\n\t\t\t\t`Added listener to store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`\n\t\t\t);\n\t\t});\n\t}\n\n\t/**\n\t * Removes listener(s) required to set window and tab titles.\n\t */\n\tasync #removeListeners() {\n\t\t// Unsubscribe from the window/tab store\n\t\tconst store = await getWindowTabNameStore();\n\t\t// If the store is unavailable, then the tab name cannot be updated\n\t\tif (!store) {\n\t\t\t// This is not critical, but tab titles may be stale\n\t\t\tFSBL.Clients.Logger.warn(\"Error removing a tab title listener: the store was not found\");\n\t\t\treturn;\n\t\t}\n\t\tstore.removeListener(\n\t\t\t{ field: this.props.windowIdentifier.windowName },\n\t\t\tthis.tabTitleChangedStoreListener,\n\t\t\t(err: StandardError, response: boolean | undefined) => {\n\t\t\t\tif (!!err) {\n\t\t\t\t\t// This is not critical; the listener could not be removed from the store - this may be a memory leak\n\t\t\t\t\tFSBL.Clients.Logger.warn(\n\t\t\t\t\t\t`Could not remove listener from store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`,\n\t\t\t\t\t\terr\n\t\t\t\t\t);\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tFSBL.Clients.Logger.debug(\n\t\t\t\t\t`Removed listener to store \"${WINDOW_TAB_TITLE_STORE}\" for field \"${this.props.windowIdentifier.windowName}\"`\n\t\t\t\t);\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * React component lifecycle event, triggered once the component has been added to the DOM.\n\t */\n\tcomponentDidMount() {\n\t\t// Set the mounted flag to true (this component is currently mounted)\n\t\tthis._mounted = true;\n\n\t\t// Add listeners\n\t\tthis.#addListeners();\n\t}\n\n\t// Triggers a re-rendering of the drag handle in the title bar.\n\tcomponentDidUpdate() {\n\t\tif (typeof this.props.onUpdate === \"function\") {\n\t\t\tthis.props.onUpdate();\n\t\t}\n\t}\n\n\t/**\n\t * React component lifecycle event, triggered before the component is removed from the DOM.\n\t */\n\tcomponentWillUnmount() {\n\t\t// Set the mounted flag to false (this component is not currently mounted)\n\t\tthis._mounted = false;\n\n\t\t// Remove listeners\n\t\tthis.#removeListeners();\n\t}\n\n\trender() {\n\t\tconst { titleWidth } = this.props;\n\t\tconst style = titleWidth ? { width: titleWidth } : {};\n\t\treturn (\n\t\t\t<EditTab\n\t\t\t\ttabWidth={titleWidth}\n\t\t\t\tsetActiveTab={this?.props?.onClick}\n\t\t\t\ttitle={this.state.title}\n\t\t\t\t// The windowIdentifier indicates which app/component this tab instance should represent\n\t\t\t\twindowIdentifier={this.props.windowIdentifier}\n\t\t\t>\n\t\t\t\t<div className=\"fsbl-tab-title\" style={style}>\n\t\t\t\t\t{this.state.icon && <Icon {...this.state.icon} />}\n\t\t\t\t\t<div className=\"title-text\">{this.state.title}</div>\n\t\t\t\t</div>\n\t\t\t</EditTab>\n\t\t);\n\t}\n}\n"]}

package/react/components/windowTitleBar/stores/windowTitleBarStore.d.ts

@@ -43,6 +43,11 @@ declare type ActionsType = {
     createParentWrapper: (params: ParentParams, cb?: Function) => void;
 };
 declare const Actions: ActionsType;
+/**
+ * Initializes the store for the windowTitleBar.
+ *
+ * @param {any} cb
+ */
 declare function initialize(cb: Function): void;
 declare let getStore: () => StoreModel;
 declare class StoreManager {