@finsemble/finsemble-ui 6.6.3 → 7.0.0-beta-X

package/react/hooks/usePubSub.js

@@ -1,11 +1,29 @@
 import * as React from "react";
 const { useState, useEffect } = React;
+/**
+ * A generic effect for getting and setting state dynamically from a Router pubsub channel.
+ *
+ * @param {string} topic The pubsub topic (i.e. channel) to subscribe
+ * @param {object} initialMessage The initial state (defaults to empty object)
+ * @returns [object, function] The current state of the pubsub channel (or initialMessage if no state exists).
+ * The second returned array parameter is a publish function which can be used to update state.
+ *
+ * @example
+ * // Inside a React functional component
+ * const [currentState, publish] = usePubSub("topic", {});
+ * console.log(currentState);
+ *
+ * onClick = () => {
+ *    publish(someNewState);
+ * }
+ */
 function usePubSub(topic, initialMessage = {}) {
     const [message, setMessage] = useState(initialMessage);
     const pub = (value) => FSBL.Clients.RouterClient.publish(topic, value);
     useEffect(() => {
         const subscribeId = FSBL.Clients.RouterClient.subscribe(topic, (err, res) => {
             if (err) {
+                // Use Finsemble Logger?
                 console.error(err);
             }
             setMessage(res.data);

package/react/hooks/usePubSub.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePubSub.js","sourceRoot":"","sources":["../../src/hooks/usePubSub.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;AAmBtC,SAAS,SAAS,CAAC,KAAa,EAAE,iBAAyB,EAAE;IAC5D,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;IAEvD,MAAM,GAAG,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAE5E,SAAS,CAAC,GAAG,EAAE;QACd,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC3E,IAAI,GAAG,EAAE;gBAER,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;YACD,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,EAAE;YACX,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACvB,CAAC;AAED,OAAO,EAAE,SAAS,EAAE,CAAC","sourcesContent":["import * as React from \"react\";\n\nconst { useState, useEffect } = React;\n\n/**\n * A generic effect for getting and setting state dynamically from a Router pubsub channel.\n *\n * @param {string} topic The pubsub topic (i.e. channel) to subscribe\n * @param {object} initialMessage The initial state (defaults to empty object)\n * @returns [object, function] The current state of the pubsub channel (or initialMessage if no state exists).\n * The second returned array parameter is a publish function which can be used to update state.\n *\n * @example\n * // Inside a React functional component\n * const [currentState, publish] = usePubSub(\"topic\", {});\n * console.log(currentState);\n *\n * onClick = () => {\n *    publish(someNewState);\n * }\n */\nfunction usePubSub(topic: string, initialMessage: object = {}): [{ [key: string]: any }, Function] {\n\tconst [message, setMessage] = useState(initialMessage);\n\n\tconst pub = (value: any) => FSBL.Clients.RouterClient.publish(topic, value);\n\n\tuseEffect(() => {\n\t\tconst subscribeId = FSBL.Clients.RouterClient.subscribe(topic, (err, res) => {\n\t\t\tif (err) {\n\t\t\t\t// Use Finsemble Logger?\n\t\t\t\tconsole.error(err);\n\t\t\t}\n\t\t\tsetMessage(res.data);\n\t\t});\n\t\treturn () => {\n\t\t\tFSBL.Clients.RouterClient.unsubscribe(subscribeId);\n\t\t};\n\t}, []);\n\n\treturn [message, pub];\n}\n\nexport { usePubSub };\n"]}
+{"version":3,"file":"usePubSub.js","sourceRoot":"","sources":["../../src/hooks/usePubSub.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;AAEtC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,SAAS,CAAC,KAAa,EAAE,iBAAyB,EAAE;IAC5D,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;IAEvD,MAAM,GAAG,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAE5E,SAAS,CAAC,GAAG,EAAE;QACd,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC3E,IAAI,GAAG,EAAE;gBACR,wBAAwB;gBACxB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;YACD,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,EAAE;YACX,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACvB,CAAC;AAED,OAAO,EAAE,SAAS,EAAE,CAAC","sourcesContent":["import * as React from \"react\";\n\nconst { useState, useEffect } = React;\n\n/**\n * A generic effect for getting and setting state dynamically from a Router pubsub channel.\n *\n * @param {string} topic The pubsub topic (i.e. channel) to subscribe\n * @param {object} initialMessage The initial state (defaults to empty object)\n * @returns [object, function] The current state of the pubsub channel (or initialMessage if no state exists).\n * The second returned array parameter is a publish function which can be used to update state.\n *\n * @example\n * // Inside a React functional component\n * const [currentState, publish] = usePubSub(\"topic\", {});\n * console.log(currentState);\n *\n * onClick = () => {\n *    publish(someNewState);\n * }\n */\nfunction usePubSub(topic: string, initialMessage: object = {}): [{ [key: string]: any }, Function] {\n\tconst [message, setMessage] = useState(initialMessage);\n\n\tconst pub = (value: any) => FSBL.Clients.RouterClient.publish(topic, value);\n\n\tuseEffect(() => {\n\t\tconst subscribeId = FSBL.Clients.RouterClient.subscribe(topic, (err, res) => {\n\t\t\tif (err) {\n\t\t\t\t// Use Finsemble Logger?\n\t\t\t\tconsole.error(err);\n\t\t\t}\n\t\t\tsetMessage(res.data);\n\t\t});\n\t\treturn () => {\n\t\t\tFSBL.Clients.RouterClient.unsubscribe(subscribeId);\n\t\t};\n\t}, []);\n\n\treturn [message, pub];\n}\n\nexport { usePubSub };\n"]}

package/react/hooks/useSearch.d.ts

@@ -6,5 +6,10 @@ declare type SearchHook = {
     updateQuery: (query: string) => void;
     resetSearch: () => void;
 };
+/**
+ * A hook for working with search. Search results stream back, and this hook will relay those through
+ * a reducer. Note that the reducer implementation is a singleton (if you have multiple search) inputs
+ * across a component then they will all be synchronized to query and results.
+ */
 declare const useSearch: () => SearchHook;
 export { useSearch };

package/react/hooks/useSearch.js

@@ -3,6 +3,11 @@ import { useDispatch, useSelector } from "../store";
 import { SearchActions } from "../actions/searchActions";
 import { debounce } from "lodash";
 const { SearchClient } = FSBL.Clients;
+/**
+ * A hook for working with search. Search results stream back, and this hook will relay those through
+ * a reducer. Note that the reducer implementation is a singleton (if you have multiple search) inputs
+ * across a component then they will all be synchronized to query and results.
+ */
 const useSearch = () => {
     const dispatch = useDispatch();
     const { searchQuery, searchResults } = useSelector((state) => state.search);
@@ -11,8 +16,14 @@ const useSearch = () => {
         dispatch(SearchActions.UPDATE_RESULTS(results));
     }, [dispatch]);
     const onSearchClientResponse = (searchError, responses, query) => {
+        // If we get a response back from an older query then drop the results
         if (query !== currentQuery.current)
             return;
+        /**
+         * The callback from `SearchClient.search` can return *multiple times*, and it uses a single global array
+         * that it is constantly mutating. React isn't doing a deep comparison, so it never updates the results, we
+         * therefore force an update by cloning the array into a new reference.
+         */
         const clonedProviderResponses = JSON.parse(JSON.stringify(responses));
         if (!clonedProviderResponses)
             return updateResults([]);
@@ -21,10 +32,29 @@ const useSearch = () => {
             providersWithData = [];
         updateResults(providersWithData);
     };
+    /**
+     * The seach client callback procedure is a little strange. In order to prevent a hangup for slow search
+     * providers, your callback to searchClient.search is invoked multiple times -- one time per search provider.
+     *
+     * Your search goes out for "De", you get a response from the WindowService saying "No components match".
+     * Then you get a response from the WorkspaceService saying "Hey DefaultWorkspace matches!". Your callback
+     * has been hit twice. On the 2nd time, you get all of the data you would've gotten the first time.
+     *
+     * Without debouncing the search client response, we end up setting intermediary state, which forces the DOM to
+     * render, which forces the window size to change to fit the DOM. Imagine the situation above.
+     *
+     * We send out a search for "DE", and the WindowService comes back at us first saying 'no components'. There's no data,
+     * so there's no results. So there's no DOM spit out for the search results. This causes the window to size down
+     * to its minimum. Miliseconds later, the workspace service comes at us saying "Hey I have workspaces!", which
+     * causes the search menu to expand to fit the results in the DOM. By setting the intermediary
+     * state, we cause unnecessary renders and we end up resizing resizing the window in a very jarring manner.
+     * By waiting until they've had a chance to come at us in a burst, we make the menu resizing smoother and less prone to jitter.
+     */
     const debouncedSearchResponse = debounce(onSearchClientResponse, 100);
     const updateQuery = useCallback((query) => {
         dispatch(SearchActions.UPDATE_QUERY(query));
         currentQuery.current = query;
+        // Run the search() effect. One day, move this to effects middleware.
         SearchClient.search({ text: query }, (e, responses) => {
             debouncedSearchResponse(e, responses, query);
         });

package/react/hooks/useSearch.js.map

@@ -1 +1 @@
-{"version":3,"file":"useSearch.js","sourceRoot":"","sources":["../../src/hooks/useSearch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAKlC,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;AActC,MAAM,SAAS,GAAG,GAAe,EAAE;IAClC,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5E,MAAM,YAAY,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IAEhC,MAAM,aAAa,GAAG,WAAW,CAChC,CAAC,OAAmB,EAAE,EAAE;QACvB,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IACF,MAAM,sBAAsB,GAAG,CAAC,WAAgB,EAAE,SAAmC,EAAE,KAAa,EAAE,EAAE;QAEvG,IAAI,KAAK,KAAK,YAAY,CAAC,OAAO;YAAE,OAAO;QAM3C,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,uBAAuB;YAAE,OAAO,aAAa,CAAC,EAAE,CAAC,CAAC;QAEvD,IAAI,iBAAiB,GAAG,uBAAuB,CAAC,MAAM,CACrD,CAAC,QAAgC,EAAE,EAAE,WAAC,OAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,MAAM,CAAA,EAAA,CAC5D,CAAC;QACF,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;YAAE,iBAAiB,GAAG,EAAE,CAAC;QAE3D,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAClC,CAAC,CAAC;IAoBF,MAAM,uBAAuB,GAAG,QAAQ,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;IAEtE,MAAM,WAAW,GAAG,WAAW,CAC9B,CAAC,KAAa,EAAE,EAAE;QACjB,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,YAAY,CAAC,OAAO,GAAG,KAAK,CAAC;QAE7B,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAM,EAAE,SAAmC,EAAE,EAAE;YACpF,uBAAuB,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACJ,CAAC,EACD,CAAC,QAAQ,EAAE,aAAa,CAAC,CACzB,CAAC;IAEF,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACpC,QAAQ,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IACxC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,OAAO;QACN,aAAa;QACb,WAAW;QACX,WAAW;QACX,WAAW;KACX,CAAC;AACH,CAAC,CAAC;AACF,OAAO,EAAE,SAAS,EAAE,CAAC","sourcesContent":["import { useRef, useCallback } from \"react\";\nimport { useDispatch, useSelector } from \"../store\";\nimport { SearchActions } from \"../actions/searchActions\";\nimport { debounce } from \"lodash\";\nimport { services } from \"@finsemble/finsemble-api\";\n\ntype SearchProviderResponse = services.search.types.SearchProviderResponse;\n\nconst { SearchClient } = FSBL.Clients;\n\ntype SearchHook = {\n\tsearchResults: Array<SearchProviderResponse>;\n\tsearchQuery: string;\n\tupdateQuery: (query: string) => void;\n\tresetSearch: () => void;\n};\n\n/**\n * A hook for working with search. Search results stream back, and this hook will relay those through\n * a reducer. Note that the reducer implementation is a singleton (if you have multiple search) inputs\n * across a component then they will all be synchronized to query and results.\n */\nconst useSearch = (): SearchHook => {\n\tconst dispatch = useDispatch();\n\tconst { searchQuery, searchResults } = useSelector((state) => state.search);\n\tconst currentQuery = useRef({});\n\n\tconst updateResults = useCallback(\n\t\t(results: Array<any>) => {\n\t\t\tdispatch(SearchActions.UPDATE_RESULTS(results));\n\t\t},\n\t\t[dispatch]\n\t);\n\tconst onSearchClientResponse = (searchError: any, responses: SearchProviderResponse[], query: string) => {\n\t\t// If we get a response back from an older query then drop the results\n\t\tif (query !== currentQuery.current) return;\n\t\t/**\n\t\t * The callback from `SearchClient.search` can return *multiple times*, and it uses a single global array\n\t\t * that it is constantly mutating. React isn't doing a deep comparison, so it never updates the results, we\n\t\t * therefore force an update by cloning the array into a new reference.\n\t\t */\n\t\tconst clonedProviderResponses = JSON.parse(JSON.stringify(responses));\n\n\t\tif (!clonedProviderResponses) return updateResults([]);\n\n\t\tlet providersWithData = clonedProviderResponses.filter(\n\t\t\t(provider: SearchProviderResponse) => provider?.data?.length\n\t\t);\n\t\tif (providersWithData.length === 0) providersWithData = [];\n\n\t\tupdateResults(providersWithData);\n\t};\n\n\t/**\n\t * The seach client callback procedure is a little strange. In order to prevent a hangup for slow search\n\t * providers, your callback to searchClient.search is invoked multiple times -- one time per search provider.\n\t *\n\t * Your search goes out for \"De\", you get a response from the WindowService saying \"No components match\".\n\t * Then you get a response from the WorkspaceService saying \"Hey DefaultWorkspace matches!\". Your callback\n\t * has been hit twice. On the 2nd time, you get all of the data you would've gotten the first time.\n\t *\n\t * Without debouncing the search client response, we end up setting intermediary state, which forces the DOM to\n\t * render, which forces the window size to change to fit the DOM. Imagine the situation above.\n\t *\n\t * We send out a search for \"DE\", and the WindowService comes back at us first saying 'no components'. There's no data,\n\t * so there's no results. So there's no DOM spit out for the search results. This causes the window to size down\n\t * to its minimum. Miliseconds later, the workspace service comes at us saying \"Hey I have workspaces!\", which\n\t * causes the search menu to expand to fit the results in the DOM. By setting the intermediary\n\t * state, we cause unnecessary renders and we end up resizing resizing the window in a very jarring manner.\n\t * By waiting until they've had a chance to come at us in a burst, we make the menu resizing smoother and less prone to jitter.\n\t */\n\tconst debouncedSearchResponse = debounce(onSearchClientResponse, 100);\n\n\tconst updateQuery = useCallback(\n\t\t(query: string) => {\n\t\t\tdispatch(SearchActions.UPDATE_QUERY(query));\n\t\t\tcurrentQuery.current = query;\n\t\t\t// Run the search() effect. One day, move this to effects middleware.\n\t\t\tSearchClient.search({ text: query }, (e: any, responses: SearchProviderResponse[]) => {\n\t\t\t\tdebouncedSearchResponse(e, responses, query);\n\t\t\t});\n\t\t},\n\t\t[dispatch, updateResults]\n\t);\n\n\tconst resetSearch = useCallback(() => {\n\t\tdispatch(SearchActions.RESET_SEARCH());\n\t}, [dispatch]);\n\n\treturn {\n\t\tsearchResults,\n\t\tupdateQuery,\n\t\tsearchQuery,\n\t\tresetSearch,\n\t};\n};\nexport { useSearch };\n"]}
+{"version":3,"file":"useSearch.js","sourceRoot":"","sources":["../../src/hooks/useSearch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAKlC,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;AAStC;;;;GAIG;AACH,MAAM,SAAS,GAAG,GAAe,EAAE;IAClC,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5E,MAAM,YAAY,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IAEhC,MAAM,aAAa,GAAG,WAAW,CAChC,CAAC,OAAmB,EAAE,EAAE;QACvB,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,CAAC,EACD,CAAC,QAAQ,CAAC,CACV,CAAC;IACF,MAAM,sBAAsB,GAAG,CAAC,WAAgB,EAAE,SAAmC,EAAE,KAAa,EAAE,EAAE;QACvG,sEAAsE;QACtE,IAAI,KAAK,KAAK,YAAY,CAAC,OAAO;YAAE,OAAO;QAC3C;;;;WAIG;QACH,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,uBAAuB;YAAE,OAAO,aAAa,CAAC,EAAE,CAAC,CAAC;QAEvD,IAAI,iBAAiB,GAAG,uBAAuB,CAAC,MAAM,CACrD,CAAC,QAAgC,EAAE,EAAE,WAAC,OAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,MAAM,CAAA,EAAA,CAC5D,CAAC;QACF,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;YAAE,iBAAiB,GAAG,EAAE,CAAC;QAE3D,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,uBAAuB,GAAG,QAAQ,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;IAEtE,MAAM,WAAW,GAAG,WAAW,CAC9B,CAAC,KAAa,EAAE,EAAE;QACjB,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,YAAY,CAAC,OAAO,GAAG,KAAK,CAAC;QAC7B,qEAAqE;QACrE,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAM,EAAE,SAAmC,EAAE,EAAE;YACpF,uBAAuB,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACJ,CAAC,EACD,CAAC,QAAQ,EAAE,aAAa,CAAC,CACzB,CAAC;IAEF,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACpC,QAAQ,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IACxC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,OAAO;QACN,aAAa;QACb,WAAW;QACX,WAAW;QACX,WAAW;KACX,CAAC;AACH,CAAC,CAAC;AACF,OAAO,EAAE,SAAS,EAAE,CAAC","sourcesContent":["import { useRef, useCallback } from \"react\";\nimport { useDispatch, useSelector } from \"../store\";\nimport { SearchActions } from \"../actions/searchActions\";\nimport { debounce } from \"lodash\";\nimport { services } from \"@finsemble/finsemble-api\";\n\ntype SearchProviderResponse = services.search.types.SearchProviderResponse;\n\nconst { SearchClient } = FSBL.Clients;\n\ntype SearchHook = {\n\tsearchResults: Array<SearchProviderResponse>;\n\tsearchQuery: string;\n\tupdateQuery: (query: string) => void;\n\tresetSearch: () => void;\n};\n\n/**\n * A hook for working with search. Search results stream back, and this hook will relay those through\n * a reducer. Note that the reducer implementation is a singleton (if you have multiple search) inputs\n * across a component then they will all be synchronized to query and results.\n */\nconst useSearch = (): SearchHook => {\n\tconst dispatch = useDispatch();\n\tconst { searchQuery, searchResults } = useSelector((state) => state.search);\n\tconst currentQuery = useRef({});\n\n\tconst updateResults = useCallback(\n\t\t(results: Array<any>) => {\n\t\t\tdispatch(SearchActions.UPDATE_RESULTS(results));\n\t\t},\n\t\t[dispatch]\n\t);\n\tconst onSearchClientResponse = (searchError: any, responses: SearchProviderResponse[], query: string) => {\n\t\t// If we get a response back from an older query then drop the results\n\t\tif (query !== currentQuery.current) return;\n\t\t/**\n\t\t * The callback from `SearchClient.search` can return *multiple times*, and it uses a single global array\n\t\t * that it is constantly mutating. React isn't doing a deep comparison, so it never updates the results, we\n\t\t * therefore force an update by cloning the array into a new reference.\n\t\t */\n\t\tconst clonedProviderResponses = JSON.parse(JSON.stringify(responses));\n\n\t\tif (!clonedProviderResponses) return updateResults([]);\n\n\t\tlet providersWithData = clonedProviderResponses.filter(\n\t\t\t(provider: SearchProviderResponse) => provider?.data?.length\n\t\t);\n\t\tif (providersWithData.length === 0) providersWithData = [];\n\n\t\tupdateResults(providersWithData);\n\t};\n\n\t/**\n\t * The seach client callback procedure is a little strange. In order to prevent a hangup for slow search\n\t * providers, your callback to searchClient.search is invoked multiple times -- one time per search provider.\n\t *\n\t * Your search goes out for \"De\", you get a response from the WindowService saying \"No components match\".\n\t * Then you get a response from the WorkspaceService saying \"Hey DefaultWorkspace matches!\". Your callback\n\t * has been hit twice. On the 2nd time, you get all of the data you would've gotten the first time.\n\t *\n\t * Without debouncing the search client response, we end up setting intermediary state, which forces the DOM to\n\t * render, which forces the window size to change to fit the DOM. Imagine the situation above.\n\t *\n\t * We send out a search for \"DE\", and the WindowService comes back at us first saying 'no components'. There's no data,\n\t * so there's no results. So there's no DOM spit out for the search results. This causes the window to size down\n\t * to its minimum. Miliseconds later, the workspace service comes at us saying \"Hey I have workspaces!\", which\n\t * causes the search menu to expand to fit the results in the DOM. By setting the intermediary\n\t * state, we cause unnecessary renders and we end up resizing resizing the window in a very jarring manner.\n\t * By waiting until they've had a chance to come at us in a burst, we make the menu resizing smoother and less prone to jitter.\n\t */\n\tconst debouncedSearchResponse = debounce(onSearchClientResponse, 100);\n\n\tconst updateQuery = useCallback(\n\t\t(query: string) => {\n\t\t\tdispatch(SearchActions.UPDATE_QUERY(query));\n\t\t\tcurrentQuery.current = query;\n\t\t\t// Run the search() effect. One day, move this to effects middleware.\n\t\t\tSearchClient.search({ text: query }, (e: any, responses: SearchProviderResponse[]) => {\n\t\t\t\tdebouncedSearchResponse(e, responses, query);\n\t\t\t});\n\t\t},\n\t\t[dispatch, updateResults]\n\t);\n\n\tconst resetSearch = useCallback(() => {\n\t\tdispatch(SearchActions.RESET_SEARCH());\n\t}, [dispatch]);\n\n\treturn {\n\t\tsearchResults,\n\t\tupdateQuery,\n\t\tsearchQuery,\n\t\tresetSearch,\n\t};\n};\nexport { useSearch };\n"]}

package/react/hooks/useToolbar.d.ts

@@ -3,7 +3,7 @@ export declare const useToolbar: () => {
     preventSystemClose: () => void;
     minimizeAllWindows: () => void;
     revealAllWindows: () => void;
-    toggleAutoArrange: () => void;
+    toggleAutoArrange: () => Promise<void>;
     showToolbar: () => void;
     hideToolbar: () => void;
     launchPreferences: (tabName: string) => void;

package/react/hooks/useToolbar.js

@@ -1,5 +1,9 @@
 import { useEffect } from "react";
 import { openQuitConfirmationDialog } from "../components/shared/openQuitConfirmationDialog";
+/**
+ * Function to bring toolbar to front (since dockable toolbar can be hidden)
+ * @param {boolean} focus If true, will also focus the toolbar
+ */
 const bringToolbarToFront = ({ focus }) => {
     finsembleWindow.bringToFront(null, (err) => {
         if (err) {
@@ -10,10 +14,16 @@ const bringToolbarToFront = ({ focus }) => {
         }
     });
 };
+/**
+ * Hides the toolbar
+ */
 const hideToolbar = () => {
     finsembleWindow.blur();
     finsembleWindow.hide();
 };
+/**
+ * Shows the toolbar left-aligned to the user's mouse.
+ */
 const showToolbar = () => {
     FSBL.Clients.RouterClient.transmit("DockingService.showAtMousePosition", {
         windowName: finsembleWindow.name,
@@ -21,28 +31,57 @@ const showToolbar = () => {
     });
     bringToolbarToFront({ focus: true });
 };
+/**
+ * Mimimizes all windows.
+ */
 const minimizeAllWindows = () => {
     FSBL.Clients.WorkspaceClient.minimizeAll();
 };
+/**
+ * Brings all windows to front.
+ */
 const revealAllWindows = () => {
     FSBL.Clients.WorkspaceClient.bringWindowsToFront();
 };
-const toggleAutoArrange = () => {
+/**
+ * Toggles Auto Arrange for all windows on the same monitor as the toolbar
+ */
+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
+     */
+    await FSBL.Clients.WorkspaceClient.bringWindowsToFront();
     FSBL.Clients.WorkspaceClient.autoArrange({}, () => {
+        // This is legacy and we're not sure if it's still required or not.
+        // We can try eliminating this once core auto arrange is refactored.
         bringToolbarToFront({ focus: false });
-        revealAllWindows();
     });
 };
+/**
+ * It's a requirement that the toolbar not be minimized.
+ * the minimizable option does not work.
+ * Instead, we just listen for this event and restore the window.
+ */
 const preventMinimize = () => {
     finsembleWindow.addEventListener("minimized", () => {
         finsembleWindow.restore();
     });
 };
+/**
+ * Required to let the system know that the toolbar is up and ready.
+ * Other pieces of the UI key off of this.
+ */
 const publishSystemCheckpoint = () => {
     FSBL.SystemManagerClient.publishCheckpointState("Toolbar", "initialize", "completed");
 };
+/**
+ * Prevents closing of the window.
+ */
 const onBeforeToolbarUnload = () => {
     openQuitConfirmationDialog();
+    // Return of a non-void value (in this `onbeforeunload` handler) is what tells Electron not to close the window.
+    // Don't delete this!
     return false;
 };
 const removeSystemClosePrevention = () => {
@@ -62,14 +101,27 @@ const launchPreferences = (tabName) => {
         top: "center",
     });
 };
+/**
+ * Prevents the window from going down on alt+f4 or closing from taskbar.
+ * Pops up a dialog asking if the user meant to shut down the system.
+ */
 const preventSystemClose = () => {
+    // This function was already called, so no need to run it again.
     if (window.onbeforeunload === onBeforeToolbarUnload)
         return;
+    // Bypass system close prevention if for some reason the toolbar has been customized with an alternative onbeforeunload handler
     if (window.onbeforeunload) {
         console.error(`Finsemble toolbar was configured to prevent system closes, however, there is already a function assigned to window.onbeforeunload. In order to prevent the OS from closing your window, we need to overwrite this handler. Users will be able to close your toolbar from the windows taskbar. Please remove your onbeforeunload handler or set the toolbar property 'allowSystemToCloseWindow' to true to get rid of this error message.`);
         return;
     }
+    /**
+     * From the electron docs:
+     * Note: There is a subtle difference between the behaviors of window.onbeforeunload = handler and window.addEventListener('beforeunload', handler). It is recommended to always set the event.returnValue explicitly, instead of only returning a value, as the former works more consistently within Electron.
+     *
+     * Tried addEventListener, and it wouldn't work.
+     */
     window.onbeforeunload = onBeforeToolbarUnload;
+    // Detect when the system is being shutdown or restarted to remove the close prevention.
     FSBL.Clients.RouterClient.addListener("Application.shutdown", () => {
         removeSystemClosePrevention();
     });

package/react/hooks/useToolbar.js.map

@@ -1 +1 @@
-{"version":3,"file":"useToolbar.js","sourceRoot":"","sources":["../../src/hooks/useToolbar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAC;AAM7F,MAAM,mBAAmB,GAAG,CAAC,EAAE,KAAK,EAAsB,EAAE,EAAE;IAC7D,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,GAAQ,EAAE,EAAE;QAC/C,IAAI,GAAG,EAAE;YACR,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;SAC5E;QAED,IAAI,KAAK,EAAE;YACV,eAAe,CAAC,KAAK,EAAE,CAAC;SACxB;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAKF,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,eAAe,CAAC,IAAI,EAAE,CAAC;IACvB,eAAe,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC,CAAC;AAKF,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,oCAAoC,EAAE;QACxE,UAAU,EAAE,eAAe,CAAC,IAAI;QAChC,IAAI,EAAE,eAAe,CAAC,IAAI;KAC1B,CAAC,CAAC;IACH,mBAAmB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACtC,CAAC,CAAC;AAKF,MAAM,kBAAkB,GAAG,GAAG,EAAE;IAC/B,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC;AAC5C,CAAC,CAAC;AAKF,MAAM,gBAAgB,GAAG,GAAG,EAAE;IAC7B,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;AACpD,CAAC,CAAC;AAKF,MAAM,iBAAiB,GAAG,GAAG,EAAE;IAC9B,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,EAAE;QAGjD,mBAAmB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACtC,gBAAgB,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAOF,MAAM,eAAe,GAAG,GAAG,EAAE;IAC5B,eAAe,CAAC,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE;QAClD,eAAe,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAMF,MAAM,uBAAuB,GAAG,GAAG,EAAE;IACpC,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;AACvF,CAAC,CAAC;AAKF,MAAM,qBAAqB,GAAG,GAAG,EAAE;IAClC,0BAA0B,EAAE,CAAC;IAG7B,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,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,iCAAiC,EAAE;QACrE,cAAc,EAAE,OAAO;KACvB,CAAC,CAAC;IACH,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CACrC;QACC,aAAa,EAAE,iBAAiB;KAChC,EACD;QACC,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,QAAQ;KACb,CACD,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,kBAAkB,GAAG,GAAG,EAAE;IAE/B,IAAI,MAAM,CAAC,cAAc,KAAK,qBAAqB;QAAE,OAAO;IAG5D,IAAI,MAAM,CAAC,cAAc,EAAE;QAC1B,OAAO,CAAC,KAAK,CACZ,0aAA0a,CAC1a,CAAC;QACF,OAAO;KACP;IAQD,MAAM,CAAC,cAAc,GAAG,qBAAqB,CAAC;IAG9C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAClE,2BAA2B,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACjE,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,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;YACxB,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","sourcesContent":["import { useEffect } from \"react\";\nimport { openQuitConfirmationDialog } from \"../components/shared/openQuitConfirmationDialog\";\n\n/**\n * Function to bring toolbar to front (since dockable toolbar can be hidden)\n * @param {boolean} focus If true, will also focus the toolbar\n */\nconst bringToolbarToFront = ({ focus }: { focus: boolean }) => {\n\tfinsembleWindow.bringToFront(null, (err: any) => {\n\t\tif (err) {\n\t\t\tFSBL.Clients.Logger.system.error(\"bringToolbarToFront failed, error:\", err);\n\t\t}\n\n\t\tif (focus) {\n\t\t\tfinsembleWindow.focus();\n\t\t}\n\t});\n};\n\n/**\n * Hides the toolbar\n */\nconst hideToolbar = () => {\n\tfinsembleWindow.blur();\n\tfinsembleWindow.hide();\n};\n\n/**\n * Shows the toolbar left-aligned to the user's mouse.\n */\nconst showToolbar = () => {\n\tFSBL.Clients.RouterClient.transmit(\"DockingService.showAtMousePosition\", {\n\t\twindowName: finsembleWindow.name,\n\t\tuuid: finsembleWindow.uuid,\n\t});\n\tbringToolbarToFront({ focus: true });\n};\n\n/**\n * Mimimizes all windows.\n */\nconst minimizeAllWindows = () => {\n\tFSBL.Clients.WorkspaceClient.minimizeAll();\n};\n\n/**\n * Brings all windows to front.\n */\nconst revealAllWindows = () => {\n\tFSBL.Clients.WorkspaceClient.bringWindowsToFront();\n};\n\n/**\n * Toggles Auto Arrange for all windows on the same monitor as the toolbar\n */\nconst toggleAutoArrange = () => {\n\tFSBL.Clients.WorkspaceClient.autoArrange({}, () => {\n\t\t// This is legacy and we're not sure if it's still required or not.\n\t\t// We can try eliminating this once core auto arrange is refactored.\n\t\tbringToolbarToFront({ focus: false });\n\t\trevealAllWindows();\n\t});\n};\n\n/**\n * It's a requirement that the toolbar not be minimized.\n * the minimizable option does not work.\n * Instead, we just listen for this event and restore the window.\n */\nconst preventMinimize = () => {\n\tfinsembleWindow.addEventListener(\"minimized\", () => {\n\t\tfinsembleWindow.restore();\n\t});\n};\n\n/**\n * Required to let the system know that the toolbar is up and ready.\n * Other pieces of the UI key off of this.\n */\nconst publishSystemCheckpoint = () => {\n\tFSBL.SystemManagerClient.publishCheckpointState(\"Toolbar\", \"initialize\", \"completed\");\n};\n\n/**\n * Prevents closing of the window.\n */\nconst onBeforeToolbarUnload = () => {\n\topenQuitConfirmationDialog();\n\t// Return of a non-void value (in this `onbeforeunload` handler) is what tells Electron not to close the window.\n\t// Don't delete this!\n\treturn false;\n};\n\nconst removeSystemClosePrevention = () => {\n\tif (window.onbeforeunload === onBeforeToolbarUnload) {\n\t\twindow.onbeforeunload = null;\n\t}\n};\n\nconst launchPreferences = (tabName: string) => {\n\tFSBL.Clients.RouterClient.transmit(\"FinsembleUserPreferencesChannel\", {\n\t\tpreferencesTab: tabName,\n\t});\n\tFSBL.Clients.LauncherClient.showWindow(\n\t\t{\n\t\t\tcomponentType: \"UserPreferences\",\n\t\t},\n\t\t{\n\t\t\tmonitor: \"mine\",\n\t\t\tleft: \"center\",\n\t\t\ttop: \"center\",\n\t\t}\n\t);\n};\n\n/**\n * Prevents the window from going down on alt+f4 or closing from taskbar.\n * Pops up a dialog asking if the user meant to shut down the system.\n */\nconst preventSystemClose = () => {\n\t// This function was already called, so no need to run it again.\n\tif (window.onbeforeunload === onBeforeToolbarUnload) return;\n\n\t// Bypass system close prevention if for some reason the toolbar has been customized with an alternative onbeforeunload handler\n\tif (window.onbeforeunload) {\n\t\tconsole.error(\n\t\t\t`Finsemble toolbar was configured to prevent system closes, however, there is already a function assigned to window.onbeforeunload. In order to prevent the OS from closing your window, we need to overwrite this handler. Users will be able to close your toolbar from the windows taskbar. Please remove your onbeforeunload handler or set the toolbar property 'allowSystemToCloseWindow' to true to get rid of this error message.`\n\t\t);\n\t\treturn;\n\t}\n\n\t/**\n\t * From the electron docs:\n\t * Note: There is a subtle difference between the behaviors of window.onbeforeunload = handler and window.addEventListener('beforeunload', handler). It is recommended to always set the event.returnValue explicitly, instead of only returning a value, as the former works more consistently within Electron.\n\t *\n\t * Tried addEventListener, and it wouldn't work.\n\t */\n\twindow.onbeforeunload = onBeforeToolbarUnload;\n\n\t// Detect when the system is being shutdown or restarted to remove the close prevention.\n\tFSBL.Clients.RouterClient.addListener(\"Application.shutdown\", () => {\n\t\tremoveSystemClosePrevention();\n\t});\n\n\tFSBL.Clients.RouterClient.addListener(\"Application.restart\", () => {\n\t\tremoveSystemClosePrevention();\n\t});\n};\n\nexport const useToolbar = () => {\n\tuseEffect(() => {\n\t\tpreventMinimize();\n\t\tpublishSystemCheckpoint();\n\n\t\tif (FSBL.debug !== true) {\n\t\t\tpreventSystemClose();\n\t\t}\n\t}, []);\n\n\treturn {\n\t\tremoveSystemClosePrevention,\n\t\tpreventSystemClose,\n\t\tminimizeAllWindows,\n\t\trevealAllWindows,\n\t\ttoggleAutoArrange,\n\t\tshowToolbar,\n\t\thideToolbar,\n\t\tlaunchPreferences,\n\t};\n};\n"]}
+{"version":3,"file":"useToolbar.js","sourceRoot":"","sources":["../../src/hooks/useToolbar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAC;AAE7F;;;GAGG;AACH,MAAM,mBAAmB,GAAG,CAAC,EAAE,KAAK,EAAsB,EAAE,EAAE;IAC7D,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,GAAQ,EAAE,EAAE;QAC/C,IAAI,GAAG,EAAE;YACR,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;SAC5E;QAED,IAAI,KAAK,EAAE;YACV,eAAe,CAAC,KAAK,EAAE,CAAC;SACxB;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,eAAe,CAAC,IAAI,EAAE,CAAC;IACvB,eAAe,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAG,GAAG,EAAE;IACxB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,oCAAoC,EAAE;QACxE,UAAU,EAAE,eAAe,CAAC,IAAI;QAChC,IAAI,EAAE,eAAe,CAAC,IAAI;KAC1B,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,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC;AAC5C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,gBAAgB,GAAG,GAAG,EAAE;IAC7B,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;AACpD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE;IACpC;;;OAGG;IACH,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;IACzD,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,EAAE;QACjD,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,eAAe,CAAC,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE;QAClD,eAAe,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,uBAAuB,GAAG,GAAG,EAAE;IACpC,IAAI,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;AACvF,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,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,iCAAiC,EAAE;QACrE,cAAc,EAAE,OAAO;KACvB,CAAC,CAAC;IACH,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CACrC;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,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAClE,2BAA2B,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACjE,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,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;YACxB,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","sourcesContent":["import { useEffect } from \"react\";\nimport { openQuitConfirmationDialog } from \"../components/shared/openQuitConfirmationDialog\";\n\n/**\n * Function to bring toolbar to front (since dockable toolbar can be hidden)\n * @param {boolean} focus If true, will also focus the toolbar\n */\nconst bringToolbarToFront = ({ focus }: { focus: boolean }) => {\n\tfinsembleWindow.bringToFront(null, (err: any) => {\n\t\tif (err) {\n\t\t\tFSBL.Clients.Logger.system.error(\"bringToolbarToFront failed, error:\", err);\n\t\t}\n\n\t\tif (focus) {\n\t\t\tfinsembleWindow.focus();\n\t\t}\n\t});\n};\n\n/**\n * Hides the toolbar\n */\nconst hideToolbar = () => {\n\tfinsembleWindow.blur();\n\tfinsembleWindow.hide();\n};\n\n/**\n * Shows the toolbar left-aligned to the user's mouse.\n */\nconst showToolbar = () => {\n\tFSBL.Clients.RouterClient.transmit(\"DockingService.showAtMousePosition\", {\n\t\twindowName: finsembleWindow.name,\n\t\tuuid: finsembleWindow.uuid,\n\t});\n\tbringToolbarToFront({ focus: true });\n};\n\n/**\n * Mimimizes all windows.\n */\nconst minimizeAllWindows = () => {\n\tFSBL.Clients.WorkspaceClient.minimizeAll();\n};\n\n/**\n * Brings all windows to front.\n */\nconst revealAllWindows = () => {\n\tFSBL.Clients.WorkspaceClient.bringWindowsToFront();\n};\n\n/**\n * Toggles Auto Arrange for all windows on the same monitor as the toolbar\n */\nconst toggleAutoArrange = async () => {\n\t/**\n\t * Bring windows to front before auto arranging them to ensure maximised windows are included in the action\n\t * This is relies on bringWindowsToFront() restoring maximised and minimised windows\n\t */\n\tawait FSBL.Clients.WorkspaceClient.bringWindowsToFront();\n\tFSBL.Clients.WorkspaceClient.autoArrange({}, () => {\n\t\t// This is legacy and we're not sure if it's still required or not.\n\t\t// We can try eliminating this once core auto arrange is refactored.\n\t\tbringToolbarToFront({ focus: false });\n\t});\n};\n\n/**\n * It's a requirement that the toolbar not be minimized.\n * the minimizable option does not work.\n * Instead, we just listen for this event and restore the window.\n */\nconst preventMinimize = () => {\n\tfinsembleWindow.addEventListener(\"minimized\", () => {\n\t\tfinsembleWindow.restore();\n\t});\n};\n\n/**\n * Required to let the system know that the toolbar is up and ready.\n * Other pieces of the UI key off of this.\n */\nconst publishSystemCheckpoint = () => {\n\tFSBL.SystemManagerClient.publishCheckpointState(\"Toolbar\", \"initialize\", \"completed\");\n};\n\n/**\n * Prevents closing of the window.\n */\nconst onBeforeToolbarUnload = () => {\n\topenQuitConfirmationDialog();\n\t// Return of a non-void value (in this `onbeforeunload` handler) is what tells Electron not to close the window.\n\t// Don't delete this!\n\treturn false;\n};\n\nconst removeSystemClosePrevention = () => {\n\tif (window.onbeforeunload === onBeforeToolbarUnload) {\n\t\twindow.onbeforeunload = null;\n\t}\n};\n\nconst launchPreferences = (tabName: string) => {\n\tFSBL.Clients.RouterClient.transmit(\"FinsembleUserPreferencesChannel\", {\n\t\tpreferencesTab: tabName,\n\t});\n\tFSBL.Clients.LauncherClient.showWindow(\n\t\t{\n\t\t\tcomponentType: \"UserPreferences\",\n\t\t},\n\t\t{\n\t\t\tmonitor: \"mine\",\n\t\t\tleft: \"center\",\n\t\t\ttop: \"center\",\n\t\t}\n\t);\n};\n\n/**\n * Prevents the window from going down on alt+f4 or closing from taskbar.\n * Pops up a dialog asking if the user meant to shut down the system.\n */\nconst preventSystemClose = () => {\n\t// This function was already called, so no need to run it again.\n\tif (window.onbeforeunload === onBeforeToolbarUnload) return;\n\n\t// Bypass system close prevention if for some reason the toolbar has been customized with an alternative onbeforeunload handler\n\tif (window.onbeforeunload) {\n\t\tconsole.error(\n\t\t\t`Finsemble toolbar was configured to prevent system closes, however, there is already a function assigned to window.onbeforeunload. In order to prevent the OS from closing your window, we need to overwrite this handler. Users will be able to close your toolbar from the windows taskbar. Please remove your onbeforeunload handler or set the toolbar property 'allowSystemToCloseWindow' to true to get rid of this error message.`\n\t\t);\n\t\treturn;\n\t}\n\n\t/**\n\t * From the electron docs:\n\t * Note: There is a subtle difference between the behaviors of window.onbeforeunload = handler and window.addEventListener('beforeunload', handler). It is recommended to always set the event.returnValue explicitly, instead of only returning a value, as the former works more consistently within Electron.\n\t *\n\t * Tried addEventListener, and it wouldn't work.\n\t */\n\twindow.onbeforeunload = onBeforeToolbarUnload;\n\n\t// Detect when the system is being shutdown or restarted to remove the close prevention.\n\tFSBL.Clients.RouterClient.addListener(\"Application.shutdown\", () => {\n\t\tremoveSystemClosePrevention();\n\t});\n\n\tFSBL.Clients.RouterClient.addListener(\"Application.restart\", () => {\n\t\tremoveSystemClosePrevention();\n\t});\n};\n\nexport const useToolbar = () => {\n\tuseEffect(() => {\n\t\tpreventMinimize();\n\t\tpublishSystemCheckpoint();\n\n\t\tif (FSBL.debug !== true) {\n\t\t\tpreventSystemClose();\n\t\t}\n\t}, []);\n\n\treturn {\n\t\tremoveSystemClosePrevention,\n\t\tpreventSystemClose,\n\t\tminimizeAllWindows,\n\t\trevealAllWindows,\n\t\ttoggleAutoArrange,\n\t\tshowToolbar,\n\t\thideToolbar,\n\t\tlaunchPreferences,\n\t};\n};\n"]}

package/react/reducers/favoriteReducer.d.ts

@@ -1,6 +1,9 @@
 import { FavoriteActionTypes } from "../actions/favoriteActions";
 import { Favorite } from "../types/favoriteTypes";
 import { Reducer } from "react";
+/**
+ * Favorite state definition.
+ */
 export declare type FavoriteState = {
     favorites: Favorite[];
 };

package/react/reducers/linkerReducer.d.ts

@@ -1,6 +1,9 @@
 import { Channel, WindowIdentifier } from "../types/linkerTypes";
 import { LinkerActionTypes } from "../actions/linkerActions";
 import { Reducer } from "react";
+/**
+ * Linker component type definition
+ */
 export declare type LinkerState = {
     channels: Record<number, Channel | undefined>;
     isAccessibleLinker: boolean;

package/react/reducers/linkerReducer.js

@@ -1,9 +1,13 @@
 import produce from "immer";
 import { LinkerActions } from "../actions/linkerActions";
+// The linker state before we initialize the linker. The initialize linker function will
+// make calls to the LinkerClient and
+// fill in the state with the relevant linker information.
 export const initialState = {
     channels: {},
     isAccessibleLinker: true,
 };
+// The linker's reducer
 export const linkerReducer = produce((state, action) => {
     LinkerActions.match(action, {
         UPDATE_CHANNEL_STATUS: ({ channelId, active }) => {

package/react/reducers/linkerReducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"linkerReducer.js","sourceRoot":"","sources":["../../src/reducers/linkerReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAE5B,OAAO,EAAqB,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAkB5E,MAAM,CAAC,MAAM,YAAY,GAAgB;IACxC,QAAQ,EAAE,EAAE;IACZ,kBAAkB,EAAE,IAAI;CACxB,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAA4C,OAAO,CAC5E,CAAC,KAAkB,EAAE,MAAyB,EAAE,EAAE;IACjD,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE;QAC3B,qBAAqB,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE;YAChD,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAChD,IAAI,aAAa;gBAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;QAClD,CAAC;QACD,YAAY,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC9B,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAgB,EAAE,KAAa,EAAE,EAAE;gBACjE,OAAO;oBACN,EAAE,EAAE,KAAK;oBACT,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,MAAM,EAAE,KAAK;iBACb,CAAC;YACH,CAAC,CAAC,CAAC;QACJ,CAAC;QACD,sBAAsB,EAAE,CAAC,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,EAAE;YAC9D,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC5E,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;YAC1C,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;gBACpD,IAAI,OAAO,EAAE;oBACZ,OAAO,CAAC,MAAM,GAAG,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBACzD;aACD;QACF,CAAC;QACD,iBAAiB,EAAE,CAAC,EAAE,kBAAkB,EAAE,EAAE,EAAE;YAC7C,KAAK,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EACD,YAAY,CACZ,CAAC","sourcesContent":["import produce from \"immer\";\nimport { Channel, WindowIdentifier } from \"../types/linkerTypes\";\nimport { LinkerActionTypes, LinkerActions } from \"../actions/linkerActions\";\nimport { Reducer } from \"react\";\n\n/**\n * Linker component type definition\n */\nexport type LinkerState = {\n\t/* The linker channels */\n\tchannels: Record<number, Channel | undefined>;\n\t/* Default to true. If the linker is an accessible linker, its channel labels will be shown along with the color indicators */\n\tisAccessibleLinker: boolean;\n\t/* The window identifier for the window that the linker component is on. They have one to one matching relationship */\n\twindowIdentifier?: WindowIdentifier;\n};\n\n// The linker state before we initialize the linker. The initialize linker function will\n// make calls to the LinkerClient and\n// fill in the state with the relevant linker information.\nexport const initialState: LinkerState = {\n\tchannels: {},\n\tisAccessibleLinker: true,\n};\n// The linker's reducer\nexport const linkerReducer: Reducer<LinkerState, LinkerActionTypes> = produce(\n\t(state: LinkerState, action: LinkerActionTypes) => {\n\t\tLinkerActions.match(action, {\n\t\t\tUPDATE_CHANNEL_STATUS: ({ channelId, active }) => {\n\t\t\t\tconst targetChannel = state.channels[channelId];\n\t\t\t\tif (targetChannel) targetChannel.active = active;\n\t\t\t},\n\t\t\tSET_CHANNELS: ({ channels }) => {\n\t\t\t\tstate.channels = channels.map((channel: Channel, index: number) => {\n\t\t\t\t\treturn {\n\t\t\t\t\t\tid: index,\n\t\t\t\t\t\tname: channel.name,\n\t\t\t\t\t\tcolor: channel.color,\n\t\t\t\t\t\tborder: channel.border,\n\t\t\t\t\t\tactive: false,\n\t\t\t\t\t};\n\t\t\t\t});\n\t\t\t},\n\t\t\tUPDATE_ACTIVE_CHANNELS: ({ channelNames, windowIdentifier }) => {\n\t\t\t\tconst channelNameArray = Object.values(channelNames).map((obj) => obj.name);\n\t\t\t\tstate.windowIdentifier = windowIdentifier;\n\t\t\t\tfor (const channel of Object.values(state.channels)) {\n\t\t\t\t\tif (channel) {\n\t\t\t\t\t\tchannel.active = channelNameArray.includes(channel.name);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\tSET_ACCESSIBILITY: ({ isAccessibleLinker }) => {\n\t\t\t\tstate.isAccessibleLinker = isAccessibleLinker;\n\t\t\t},\n\t\t\tdefault: () => state,\n\t\t});\n\t},\n\tinitialState\n);\n"]}
+{"version":3,"file":"linkerReducer.js","sourceRoot":"","sources":["../../src/reducers/linkerReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAE5B,OAAO,EAAqB,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAe5E,wFAAwF;AACxF,qCAAqC;AACrC,0DAA0D;AAC1D,MAAM,CAAC,MAAM,YAAY,GAAgB;IACxC,QAAQ,EAAE,EAAE;IACZ,kBAAkB,EAAE,IAAI;CACxB,CAAC;AACF,uBAAuB;AACvB,MAAM,CAAC,MAAM,aAAa,GAA4C,OAAO,CAC5E,CAAC,KAAkB,EAAE,MAAyB,EAAE,EAAE;IACjD,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE;QAC3B,qBAAqB,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE;YAChD,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAChD,IAAI,aAAa;gBAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;QAClD,CAAC;QACD,YAAY,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC9B,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAgB,EAAE,KAAa,EAAE,EAAE;gBACjE,OAAO;oBACN,EAAE,EAAE,KAAK;oBACT,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,MAAM,EAAE,KAAK;iBACb,CAAC;YACH,CAAC,CAAC,CAAC;QACJ,CAAC;QACD,sBAAsB,EAAE,CAAC,EAAE,YAAY,EAAE,gBAAgB,EAAE,EAAE,EAAE;YAC9D,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC5E,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;YAC1C,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;gBACpD,IAAI,OAAO,EAAE;oBACZ,OAAO,CAAC,MAAM,GAAG,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBACzD;aACD;QACF,CAAC;QACD,iBAAiB,EAAE,CAAC,EAAE,kBAAkB,EAAE,EAAE,EAAE;YAC7C,KAAK,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EACD,YAAY,CACZ,CAAC","sourcesContent":["import produce from \"immer\";\nimport { Channel, WindowIdentifier } from \"../types/linkerTypes\";\nimport { LinkerActionTypes, LinkerActions } from \"../actions/linkerActions\";\nimport { Reducer } from \"react\";\n\n/**\n * Linker component type definition\n */\nexport type LinkerState = {\n\t/* The linker channels */\n\tchannels: Record<number, Channel | undefined>;\n\t/* Default to true. If the linker is an accessible linker, its channel labels will be shown along with the color indicators */\n\tisAccessibleLinker: boolean;\n\t/* The window identifier for the window that the linker component is on. They have one to one matching relationship */\n\twindowIdentifier?: WindowIdentifier;\n};\n\n// The linker state before we initialize the linker. The initialize linker function will\n// make calls to the LinkerClient and\n// fill in the state with the relevant linker information.\nexport const initialState: LinkerState = {\n\tchannels: {},\n\tisAccessibleLinker: true,\n};\n// The linker's reducer\nexport const linkerReducer: Reducer<LinkerState, LinkerActionTypes> = produce(\n\t(state: LinkerState, action: LinkerActionTypes) => {\n\t\tLinkerActions.match(action, {\n\t\t\tUPDATE_CHANNEL_STATUS: ({ channelId, active }) => {\n\t\t\t\tconst targetChannel = state.channels[channelId];\n\t\t\t\tif (targetChannel) targetChannel.active = active;\n\t\t\t},\n\t\t\tSET_CHANNELS: ({ channels }) => {\n\t\t\t\tstate.channels = channels.map((channel: Channel, index: number) => {\n\t\t\t\t\treturn {\n\t\t\t\t\t\tid: index,\n\t\t\t\t\t\tname: channel.name,\n\t\t\t\t\t\tcolor: channel.color,\n\t\t\t\t\t\tborder: channel.border,\n\t\t\t\t\t\tactive: false,\n\t\t\t\t\t};\n\t\t\t\t});\n\t\t\t},\n\t\t\tUPDATE_ACTIVE_CHANNELS: ({ channelNames, windowIdentifier }) => {\n\t\t\t\tconst channelNameArray = Object.values(channelNames).map((obj) => obj.name);\n\t\t\t\tstate.windowIdentifier = windowIdentifier;\n\t\t\t\tfor (const channel of Object.values(state.channels)) {\n\t\t\t\t\tif (channel) {\n\t\t\t\t\t\tchannel.active = channelNameArray.includes(channel.name);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\tSET_ACCESSIBILITY: ({ isAccessibleLinker }) => {\n\t\t\t\tstate.isAccessibleLinker = isAccessibleLinker;\n\t\t\t},\n\t\t\tdefault: () => state,\n\t\t});\n\t},\n\tinitialState\n);\n"]}

package/react/reducers/menuReducer.d.ts

@@ -1,8 +1,36 @@
 import { MenuActionTypes } from "../actions/menuActions";
 import { Reducer } from "react";
+/**
+ * Menu state definition.
+ */
 export declare type MenuState = {
+    /**
+     * Contains the id of the currently open menu
+     */
     openMenuId: string | null;
+    /**
+     * Contains the id of a menu that has been blurred but not yet closed. See menuReducer for algorithm.
+     */
     pendingBlurId: string | null;
 };
 export declare const initialState: MenuState;
+/**
+ * Algorithm for managing "toggle/blur" race condition
+ *
+ * When a user clicks the  for an open window it triggers two events which end up in a race.
+ * A blur event will close the menu. A toggle event will also close the menu.
+ * However, if the blur event arrives *before* the toggle event then the menu would (1) close, (2) toggle back open
+ *
+ * The algorithm to address this race condition is to instead use three events. These are the two races
+ * (1) BLUR_MENU - sets pendingBlurId to the id of the menu
+ * (2) TOGGLE_MENU - closes the menu if it is open (true), and clears pendingBlurId
+ * (3) CLOSE_IF_PENDING - closes the menu only if pendingBlurId is still set, and clears pendingBlurId
+ *
+ * (1) TOGGLE_MENU - closes the menu if it is open (pendingBlurId will not be set)
+ * (2) BLUR_MENU - sets pendingBlurId to the id of the menu
+ * (3) CLOSE_IF_PENDING - menu is already closed. clears pendingBlurId.
+ *
+ * menuHook() is responsible for triggering each of these events.
+ * This algorithm depends on the time delay between BLUR_MENU and CLOSE_IF_PENDING to be long enough that TOGGLE_MENU is assured to trigger.
+ */
 export declare const menuReducer: Reducer<MenuState, MenuActionTypes>;

package/react/reducers/menuReducer.js

@@ -4,23 +4,57 @@ export const initialState = {
     openMenuId: null,
     pendingBlurId: null,
 };
+/**
+ * Algorithm for managing "toggle/blur" race condition
+ *
+ * When a user clicks the  for an open window it triggers two events which end up in a race.
+ * A blur event will close the menu. A toggle event will also close the menu.
+ * However, if the blur event arrives *before* the toggle event then the menu would (1) close, (2) toggle back open
+ *
+ * The algorithm to address this race condition is to instead use three events. These are the two races
+ * (1) BLUR_MENU - sets pendingBlurId to the id of the menu
+ * (2) TOGGLE_MENU - closes the menu if it is open (true), and clears pendingBlurId
+ * (3) CLOSE_IF_PENDING - closes the menu only if pendingBlurId is still set, and clears pendingBlurId
+ *
+ * (1) TOGGLE_MENU - closes the menu if it is open (pendingBlurId will not be set)
+ * (2) BLUR_MENU - sets pendingBlurId to the id of the menu
+ * (3) CLOSE_IF_PENDING - menu is already closed. clears pendingBlurId.
+ *
+ * menuHook() is responsible for triggering each of these events.
+ * This algorithm depends on the time delay between BLUR_MENU and CLOSE_IF_PENDING to be long enough that TOGGLE_MENU is assured to trigger.
+ */
 export const menuReducer = produce((state, action) => {
     MenuActions.match(action, {
+        /**
+         * If the menu is open then close it. If it's closed then open it.
+         */
         TOGGLE_MENU: (id) => {
             state.pendingBlurId = null;
             state.openMenuId = state.openMenuId === id ? null : id;
         },
+        /**
+         * Opens the menu. If it is already open then state won't actually change.
+         */
         OPEN_MENU: (id) => {
             state.pendingBlurId = null;
             state.openMenuId = id;
         },
+        /**
+         * Closes the menu iff it is open
+         */
         CLOSE_MENU: (id) => {
             state.pendingBlurId = null;
             state.openMenuId = state.openMenuId === id ? null : state.openMenuId;
         },
+        /**
+         * Sets the menu to be pending close
+         */
         BLUR_MENU: (id) => {
             state.pendingBlurId = id;
         },
+        /**
+         * Closes the menu iff it is open and pending close
+         */
         CLOSE_MENU_IF_PENDING: (id) => {
             if (state.pendingBlurId === id && state.openMenuId === id)
                 state.openMenuId = null;

package/react/reducers/menuReducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"menuReducer.js","sourceRoot":"","sources":["../../src/reducers/menuReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAmB,MAAM,wBAAwB,CAAC;AAiBtE,MAAM,CAAC,MAAM,YAAY,GAAc;IACtC,UAAU,EAAE,IAAI;IAChB,aAAa,EAAE,IAAI;CACnB,CAAC;AAqBF,MAAM,CAAC,MAAM,WAAW,GAAwC,OAAO,CAAC,CAAC,KAAgB,EAAE,MAAuB,EAAE,EAAE;IACrH,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE;QAIzB,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE;YACnB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAC3B,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,CAAC;QAID,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE;YACjB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAC3B,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACvB,CAAC;QAID,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE;YAClB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAC3B,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QACtE,CAAC;QAID,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE;YACjB,KAAK,CAAC,aAAa,GAAG,EAAE,CAAC;QAC1B,CAAC;QAID,qBAAqB,EAAE,CAAC,EAAE,EAAE,EAAE;YAC7B,IAAI,KAAK,CAAC,aAAa,KAAK,EAAE,IAAI,KAAK,CAAC,UAAU,KAAK,EAAE;gBAAE,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;YACnF,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EAAE,YAAY,CAAC,CAAC","sourcesContent":["import produce from \"immer\";\nimport { MenuActions, MenuActionTypes } from \"../actions/menuActions\";\nimport { Reducer } from \"react\";\n\n/**\n * Menu state definition.\n */\nexport type MenuState = {\n\t/**\n\t * Contains the id of the currently open menu\n\t */\n\topenMenuId: string | null;\n\t/**\n\t * Contains the id of a menu that has been blurred but not yet closed. See menuReducer for algorithm.\n\t */\n\tpendingBlurId: string | null;\n};\n\nexport const initialState: MenuState = {\n\topenMenuId: null,\n\tpendingBlurId: null,\n};\n\n/**\n * Algorithm for managing \"toggle/blur\" race condition\n *\n * When a user clicks the  for an open window it triggers two events which end up in a race.\n * A blur event will close the menu. A toggle event will also close the menu.\n * However, if the blur event arrives *before* the toggle event then the menu would (1) close, (2) toggle back open\n *\n * The algorithm to address this race condition is to instead use three events. These are the two races\n * (1) BLUR_MENU - sets pendingBlurId to the id of the menu\n * (2) TOGGLE_MENU - closes the menu if it is open (true), and clears pendingBlurId\n * (3) CLOSE_IF_PENDING - closes the menu only if pendingBlurId is still set, and clears pendingBlurId\n *\n * (1) TOGGLE_MENU - closes the menu if it is open (pendingBlurId will not be set)\n * (2) BLUR_MENU - sets pendingBlurId to the id of the menu\n * (3) CLOSE_IF_PENDING - menu is already closed. clears pendingBlurId.\n *\n * menuHook() is responsible for triggering each of these events.\n * This algorithm depends on the time delay between BLUR_MENU and CLOSE_IF_PENDING to be long enough that TOGGLE_MENU is assured to trigger.\n */\nexport const menuReducer: Reducer<MenuState, MenuActionTypes> = produce((state: MenuState, action: MenuActionTypes) => {\n\tMenuActions.match(action, {\n\t\t/**\n\t\t * If the menu is open then close it. If it's closed then open it.\n\t\t */\n\t\tTOGGLE_MENU: (id) => {\n\t\t\tstate.pendingBlurId = null;\n\t\t\tstate.openMenuId = state.openMenuId === id ? null : id;\n\t\t},\n\t\t/**\n\t\t * Opens the menu. If it is already open then state won't actually change.\n\t\t */\n\t\tOPEN_MENU: (id) => {\n\t\t\tstate.pendingBlurId = null;\n\t\t\tstate.openMenuId = id;\n\t\t},\n\t\t/**\n\t\t * Closes the menu iff it is open\n\t\t */\n\t\tCLOSE_MENU: (id) => {\n\t\t\tstate.pendingBlurId = null;\n\t\t\tstate.openMenuId = state.openMenuId === id ? null : state.openMenuId;\n\t\t},\n\t\t/**\n\t\t * Sets the menu to be pending close\n\t\t */\n\t\tBLUR_MENU: (id) => {\n\t\t\tstate.pendingBlurId = id;\n\t\t},\n\t\t/**\n\t\t * Closes the menu iff it is open and pending close\n\t\t */\n\t\tCLOSE_MENU_IF_PENDING: (id) => {\n\t\t\tif (state.pendingBlurId === id && state.openMenuId === id) state.openMenuId = null;\n\t\t\tstate.pendingBlurId = null;\n\t\t},\n\t\tdefault: () => state,\n\t});\n}, initialState);\n"]}
+{"version":3,"file":"menuReducer.js","sourceRoot":"","sources":["../../src/reducers/menuReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAmB,MAAM,wBAAwB,CAAC;AAiBtE,MAAM,CAAC,MAAM,YAAY,GAAc;IACtC,UAAU,EAAE,IAAI;IAChB,aAAa,EAAE,IAAI;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAwC,OAAO,CAAC,CAAC,KAAgB,EAAE,MAAuB,EAAE,EAAE;IACrH,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE;QACzB;;WAEG;QACH,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE;YACnB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAC3B,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,CAAC;QACD;;WAEG;QACH,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE;YACjB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAC3B,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACvB,CAAC;QACD;;WAEG;QACH,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE;YAClB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAC3B,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QACtE,CAAC;QACD;;WAEG;QACH,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE;YACjB,KAAK,CAAC,aAAa,GAAG,EAAE,CAAC;QAC1B,CAAC;QACD;;WAEG;QACH,qBAAqB,EAAE,CAAC,EAAE,EAAE,EAAE;YAC7B,IAAI,KAAK,CAAC,aAAa,KAAK,EAAE,IAAI,KAAK,CAAC,UAAU,KAAK,EAAE;gBAAE,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;YACnF,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EAAE,YAAY,CAAC,CAAC","sourcesContent":["import produce from \"immer\";\nimport { MenuActions, MenuActionTypes } from \"../actions/menuActions\";\nimport { Reducer } from \"react\";\n\n/**\n * Menu state definition.\n */\nexport type MenuState = {\n\t/**\n\t * Contains the id of the currently open menu\n\t */\n\topenMenuId: string | null;\n\t/**\n\t * Contains the id of a menu that has been blurred but not yet closed. See menuReducer for algorithm.\n\t */\n\tpendingBlurId: string | null;\n};\n\nexport const initialState: MenuState = {\n\topenMenuId: null,\n\tpendingBlurId: null,\n};\n\n/**\n * Algorithm for managing \"toggle/blur\" race condition\n *\n * When a user clicks the  for an open window it triggers two events which end up in a race.\n * A blur event will close the menu. A toggle event will also close the menu.\n * However, if the blur event arrives *before* the toggle event then the menu would (1) close, (2) toggle back open\n *\n * The algorithm to address this race condition is to instead use three events. These are the two races\n * (1) BLUR_MENU - sets pendingBlurId to the id of the menu\n * (2) TOGGLE_MENU - closes the menu if it is open (true), and clears pendingBlurId\n * (3) CLOSE_IF_PENDING - closes the menu only if pendingBlurId is still set, and clears pendingBlurId\n *\n * (1) TOGGLE_MENU - closes the menu if it is open (pendingBlurId will not be set)\n * (2) BLUR_MENU - sets pendingBlurId to the id of the menu\n * (3) CLOSE_IF_PENDING - menu is already closed. clears pendingBlurId.\n *\n * menuHook() is responsible for triggering each of these events.\n * This algorithm depends on the time delay between BLUR_MENU and CLOSE_IF_PENDING to be long enough that TOGGLE_MENU is assured to trigger.\n */\nexport const menuReducer: Reducer<MenuState, MenuActionTypes> = produce((state: MenuState, action: MenuActionTypes) => {\n\tMenuActions.match(action, {\n\t\t/**\n\t\t * If the menu is open then close it. If it's closed then open it.\n\t\t */\n\t\tTOGGLE_MENU: (id) => {\n\t\t\tstate.pendingBlurId = null;\n\t\t\tstate.openMenuId = state.openMenuId === id ? null : id;\n\t\t},\n\t\t/**\n\t\t * Opens the menu. If it is already open then state won't actually change.\n\t\t */\n\t\tOPEN_MENU: (id) => {\n\t\t\tstate.pendingBlurId = null;\n\t\t\tstate.openMenuId = id;\n\t\t},\n\t\t/**\n\t\t * Closes the menu iff it is open\n\t\t */\n\t\tCLOSE_MENU: (id) => {\n\t\t\tstate.pendingBlurId = null;\n\t\t\tstate.openMenuId = state.openMenuId === id ? null : state.openMenuId;\n\t\t},\n\t\t/**\n\t\t * Sets the menu to be pending close\n\t\t */\n\t\tBLUR_MENU: (id) => {\n\t\t\tstate.pendingBlurId = id;\n\t\t},\n\t\t/**\n\t\t * Closes the menu iff it is open and pending close\n\t\t */\n\t\tCLOSE_MENU_IF_PENDING: (id) => {\n\t\t\tif (state.pendingBlurId === id && state.openMenuId === id) state.openMenuId = null;\n\t\t\tstate.pendingBlurId = null;\n\t\t},\n\t\tdefault: () => state,\n\t});\n}, initialState);\n"]}

package/react/reducers/rootReducer.d.ts

@@ -147,7 +147,7 @@ export declare const rootReducer: import("redux").Reducer<import("redux").Combin
 }) | ({
     type: "update_apps";
 } & {
-    payload: import("@finsemble/finsemble-api/types/services/Interop/types").AppDefinition[];
+    payload: import("@finsemble/finsemble-api").AppDefinition[];
 }) | ({
     type: "new_app";
 } & {
@@ -159,7 +159,7 @@ export declare const rootReducer: import("redux").Reducer<import("redux").Combin
 }) | ({
     type: "update_app";
 } & {
-    payload: import("@finsemble/finsemble-api/types/services/Interop/types").AppDefinition;
+    payload: import("@finsemble/finsemble-api").AppDefinition;
 }) | ({
     type: "delete_app";
 } & {

package/react/reducers/rootReducer.js

@@ -14,5 +14,8 @@ export const rootReducer = combineReducers({
     menu: menuReducer,
     search: searchReducer,
     smartDesktopDesigner: smartDesktopDesignerReducer,
+    // Before adding your reducer, be sure to add the correct action
+    // types to ../actions/rootActions.ts. Otherwise you will get a deeply
+    // nested type error like "YOUR_ACTION_TYPE is not assignable to OTHER_ACTION_TYPE".
 });
 //# sourceMappingURL=rootReducer.js.map

package/react/reducers/rootReducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"rootReducer.js","sourceRoot":"","sources":["../../src/reducers/rootReducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAe,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAkB,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,eAAe,EAAiB,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,WAAW,EAAa,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,aAAa,EAAe,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAe5E,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC;IAC1C,OAAO,EAAE,cAAc;IACvB,MAAM,EAAE,aAAa;IACrB,SAAS,EAAE,gBAAgB;IAC3B,QAAQ,EAAE,eAAe;IACzB,IAAI,EAAE,WAAW;IACjB,MAAM,EAAE,aAAa;IACrB,oBAAoB,EAAE,2BAA2B;CAIjD,CAAC,CAAC","sourcesContent":["import { ToolbarState, toolbarReducer } from \"./toolbarReducer\";\nimport { LinkerState, linkerReducer } from \"./linkerReducer\";\nimport { combineReducers } from \"redux\";\nimport { workspaceReducer, WorkspaceState } from \"./workspaceReducer\";\nimport { favoriteReducer, FavoriteState } from \"./favoriteReducer\";\nimport { menuReducer, MenuState } from \"./menuReducer\";\nimport { searchReducer, SearchState } from \"./searchReducer\";\nimport { smartDesktopDesignerReducer } from \"./smartDesktopDesignerReducer\";\nimport { SmartDesktopDesignerState } from \"../types/smartDesktopDesignerTypes\";\n\n// DH 2/11/2019 - This should be auto-inferred from `typeof rootReducer`, but\n// I can't get it working, so we'll write it manually.\nexport type RootState = {\n\ttoolbar: ToolbarState;\n\tlinker: LinkerState;\n\tworkspace: WorkspaceState;\n\tmenu: MenuState;\n\tfavorite: FavoriteState;\n\tsearch: SearchState;\n\tsmartDesktopDesigner: SmartDesktopDesignerState;\n};\n\nexport const rootReducer = combineReducers({\n\ttoolbar: toolbarReducer,\n\tlinker: linkerReducer,\n\tworkspace: workspaceReducer,\n\tfavorite: favoriteReducer,\n\tmenu: menuReducer,\n\tsearch: searchReducer,\n\tsmartDesktopDesigner: smartDesktopDesignerReducer,\n\t// Before adding your reducer, be sure to add the correct action\n\t// types to ../actions/rootActions.ts. Otherwise you will get a deeply\n\t// nested type error like \"YOUR_ACTION_TYPE is not assignable to OTHER_ACTION_TYPE\".\n});\n"]}
+{"version":3,"file":"rootReducer.js","sourceRoot":"","sources":["../../src/reducers/rootReducer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAe,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAkB,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,eAAe,EAAiB,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,WAAW,EAAa,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,aAAa,EAAe,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAe5E,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC;IAC1C,OAAO,EAAE,cAAc;IACvB,MAAM,EAAE,aAAa;IACrB,SAAS,EAAE,gBAAgB;IAC3B,QAAQ,EAAE,eAAe;IACzB,IAAI,EAAE,WAAW;IACjB,MAAM,EAAE,aAAa;IACrB,oBAAoB,EAAE,2BAA2B;IACjD,gEAAgE;IAChE,sEAAsE;IACtE,oFAAoF;CACpF,CAAC,CAAC","sourcesContent":["import { ToolbarState, toolbarReducer } from \"./toolbarReducer\";\nimport { LinkerState, linkerReducer } from \"./linkerReducer\";\nimport { combineReducers } from \"redux\";\nimport { workspaceReducer, WorkspaceState } from \"./workspaceReducer\";\nimport { favoriteReducer, FavoriteState } from \"./favoriteReducer\";\nimport { menuReducer, MenuState } from \"./menuReducer\";\nimport { searchReducer, SearchState } from \"./searchReducer\";\nimport { smartDesktopDesignerReducer } from \"./smartDesktopDesignerReducer\";\nimport { SmartDesktopDesignerState } from \"../types/smartDesktopDesignerTypes\";\n\n// DH 2/11/2019 - This should be auto-inferred from `typeof rootReducer`, but\n// I can't get it working, so we'll write it manually.\nexport type RootState = {\n\ttoolbar: ToolbarState;\n\tlinker: LinkerState;\n\tworkspace: WorkspaceState;\n\tmenu: MenuState;\n\tfavorite: FavoriteState;\n\tsearch: SearchState;\n\tsmartDesktopDesigner: SmartDesktopDesignerState;\n};\n\nexport const rootReducer = combineReducers({\n\ttoolbar: toolbarReducer,\n\tlinker: linkerReducer,\n\tworkspace: workspaceReducer,\n\tfavorite: favoriteReducer,\n\tmenu: menuReducer,\n\tsearch: searchReducer,\n\tsmartDesktopDesigner: smartDesktopDesignerReducer,\n\t// Before adding your reducer, be sure to add the correct action\n\t// types to ../actions/rootActions.ts. Otherwise you will get a deeply\n\t// nested type error like \"YOUR_ACTION_TYPE is not assignable to OTHER_ACTION_TYPE\".\n});\n"]}

package/react/reducers/searchReducer.d.ts

@@ -1,7 +1,14 @@
 import { SearchActionTypes } from "../actions/searchActions";
 import { Reducer } from "react";
+/**
+ * Search state definition.
+ */
 export declare type SearchState = {
+    /**
+     */
     searchQuery: string;
+    /**
+     */
     searchResults: Array<any>;
 };
 export declare const initialState: SearchState;

package/react/reducers/searchReducer.js

@@ -6,12 +6,18 @@ export const initialState = {
 };
 export const searchReducer = produce((state, action) => {
     SearchActions.match(action, {
+        /**
+         */
         UPDATE_QUERY: (query) => {
             state.searchQuery = query;
         },
+        /**
+         */
         UPDATE_RESULTS: (results) => {
             state.searchResults = results;
         },
+        /**
+         */
         RESET_SEARCH: () => {
             state.searchResults = [];
             state.searchQuery = "";

package/react/reducers/searchReducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"searchReducer.js","sourceRoot":"","sources":["../../src/reducers/searchReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAqB,MAAM,0BAA0B,CAAC;AAe5E,MAAM,CAAC,MAAM,YAAY,GAAgB;IACxC,WAAW,EAAE,EAAE;IACf,aAAa,EAAE,EAAE;CACjB,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAA4C,OAAO,CAC5E,CAAC,KAAkB,EAAE,MAAyB,EAAE,EAAE;IACjD,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE;QAG3B,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YACvB,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC;QAC3B,CAAC;QAGD,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;YAC3B,KAAK,CAAC,aAAa,GAAG,OAAO,CAAC;QAC/B,CAAC;QAGD,YAAY,EAAE,GAAG,EAAE;YAClB,KAAK,CAAC,aAAa,GAAG,EAAE,CAAC;YACzB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;QACxB,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EACD,YAAY,CACZ,CAAC","sourcesContent":["import produce from \"immer\";\nimport { SearchActions, SearchActionTypes } from \"../actions/searchActions\";\nimport { Reducer } from \"react\";\n\n/**\n * Search state definition.\n */\nexport type SearchState = {\n\t/**\n\t */\n\tsearchQuery: string;\n\t/**\n\t */\n\tsearchResults: Array<any>;\n};\n\nexport const initialState: SearchState = {\n\tsearchQuery: \"\",\n\tsearchResults: [],\n};\n\nexport const searchReducer: Reducer<SearchState, SearchActionTypes> = produce(\n\t(state: SearchState, action: SearchActionTypes) => {\n\t\tSearchActions.match(action, {\n\t\t\t/**\n\t\t\t */\n\t\t\tUPDATE_QUERY: (query) => {\n\t\t\t\tstate.searchQuery = query;\n\t\t\t},\n\t\t\t/**\n\t\t\t */\n\t\t\tUPDATE_RESULTS: (results) => {\n\t\t\t\tstate.searchResults = results;\n\t\t\t},\n\t\t\t/**\n\t\t\t */\n\t\t\tRESET_SEARCH: () => {\n\t\t\t\tstate.searchResults = [];\n\t\t\t\tstate.searchQuery = \"\";\n\t\t\t},\n\t\t\tdefault: () => state,\n\t\t});\n\t},\n\tinitialState\n);\n"]}
+{"version":3,"file":"searchReducer.js","sourceRoot":"","sources":["../../src/reducers/searchReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAqB,MAAM,0BAA0B,CAAC;AAe5E,MAAM,CAAC,MAAM,YAAY,GAAgB;IACxC,WAAW,EAAE,EAAE;IACf,aAAa,EAAE,EAAE;CACjB,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAA4C,OAAO,CAC5E,CAAC,KAAkB,EAAE,MAAyB,EAAE,EAAE;IACjD,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE;QAC3B;WACG;QACH,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;YACvB,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC;QAC3B,CAAC;QACD;WACG;QACH,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;YAC3B,KAAK,CAAC,aAAa,GAAG,OAAO,CAAC;QAC/B,CAAC;QACD;WACG;QACH,YAAY,EAAE,GAAG,EAAE;YAClB,KAAK,CAAC,aAAa,GAAG,EAAE,CAAC;YACzB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;QACxB,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EACD,YAAY,CACZ,CAAC","sourcesContent":["import produce from \"immer\";\nimport { SearchActions, SearchActionTypes } from \"../actions/searchActions\";\nimport { Reducer } from \"react\";\n\n/**\n * Search state definition.\n */\nexport type SearchState = {\n\t/**\n\t */\n\tsearchQuery: string;\n\t/**\n\t */\n\tsearchResults: Array<any>;\n};\n\nexport const initialState: SearchState = {\n\tsearchQuery: \"\",\n\tsearchResults: [],\n};\n\nexport const searchReducer: Reducer<SearchState, SearchActionTypes> = produce(\n\t(state: SearchState, action: SearchActionTypes) => {\n\t\tSearchActions.match(action, {\n\t\t\t/**\n\t\t\t */\n\t\t\tUPDATE_QUERY: (query) => {\n\t\t\t\tstate.searchQuery = query;\n\t\t\t},\n\t\t\t/**\n\t\t\t */\n\t\t\tUPDATE_RESULTS: (results) => {\n\t\t\t\tstate.searchResults = results;\n\t\t\t},\n\t\t\t/**\n\t\t\t */\n\t\t\tRESET_SEARCH: () => {\n\t\t\t\tstate.searchResults = [];\n\t\t\t\tstate.searchQuery = \"\";\n\t\t\t},\n\t\t\tdefault: () => state,\n\t\t});\n\t},\n\tinitialState\n);\n"]}

package/react/reducers/workspaceReducer.js

@@ -12,6 +12,7 @@ export const workspaceReducer = produce((state, action) => {
         UPDATE_ALL_WORKSPACES: ({ activeWorkspace, workspaces }) => {
             state.activeWorkspace = activeWorkspace;
             if (workspaces) {
+                // We only care about the name returned by the workspaceService updates
                 state.workspaces = workspaces.map(({ name }) => {
                     return { name };
                 });

package/react/reducers/workspaceReducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"workspaceReducer.js","sourceRoot":"","sources":["../../src/reducers/workspaceReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAwB,MAAM,6BAA6B,CAAC;AAUrF,MAAM,CAAC,MAAM,YAAY,GAAmB;IAC3C,eAAe,EAAE;QAChB,IAAI,EAAE,EAAE;KACR;IACD,UAAU,EAAE,EAAE;IACd,YAAY,EAAE,KAAK;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAkD,OAAO,CACrF,CAAC,KAAqB,EAAE,MAA4B,EAAE,EAAE;IACvD,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE;QAC9B,qBAAqB,EAAE,CAAC,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,EAAE;YAC1D,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;YAExC,IAAI,UAAU,EAAE;gBAEf,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;oBAC9C,OAAO,EAAE,IAAI,EAAE,CAAC;gBACjB,CAAC,CAAC,CAAC;aACH;QACF,CAAC;QACD,0CAA0C,EAAE,CAAC,YAAY,EAAE,EAAE;YAC5D,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EACD,YAAY,CACZ,CAAC","sourcesContent":["import produce from \"immer\";\nimport { WorkspaceActions, WorkspaceActionTypes } from \"../actions/workspaceActions\";\nimport { Workspace } from \"../types/workspaceTypes\";\nimport { Reducer } from \"react\";\n\nexport type WorkspaceState = {\n\tactiveWorkspace: Workspace;\n\tworkspaces: Workspace[];\n\tpromptOnSave: boolean;\n};\n\nexport const initialState: WorkspaceState = {\n\tactiveWorkspace: {\n\t\tname: \"\",\n\t},\n\tworkspaces: [],\n\tpromptOnSave: false,\n};\n\nexport const workspaceReducer: Reducer<WorkspaceState, WorkspaceActionTypes> = produce(\n\t(state: WorkspaceState, action: WorkspaceActionTypes) => {\n\t\tWorkspaceActions.match(action, {\n\t\t\tUPDATE_ALL_WORKSPACES: ({ activeWorkspace, workspaces }) => {\n\t\t\t\tstate.activeWorkspace = activeWorkspace;\n\n\t\t\t\tif (workspaces) {\n\t\t\t\t\t// We only care about the name returned by the workspaceService updates\n\t\t\t\t\tstate.workspaces = workspaces.map(({ name }) => {\n\t\t\t\t\t\treturn { name };\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t},\n\t\t\tUPDATE_PROMPT_ON_SAVE_WORKSPACE_PREFERENCE: (promptOnSave) => {\n\t\t\t\tstate.promptOnSave = promptOnSave;\n\t\t\t},\n\t\t\tdefault: () => state,\n\t\t});\n\t},\n\tinitialState\n);\n"]}
+{"version":3,"file":"workspaceReducer.js","sourceRoot":"","sources":["../../src/reducers/workspaceReducer.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAwB,MAAM,6BAA6B,CAAC;AAUrF,MAAM,CAAC,MAAM,YAAY,GAAmB;IAC3C,eAAe,EAAE;QAChB,IAAI,EAAE,EAAE;KACR;IACD,UAAU,EAAE,EAAE;IACd,YAAY,EAAE,KAAK;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAkD,OAAO,CACrF,CAAC,KAAqB,EAAE,MAA4B,EAAE,EAAE;IACvD,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE;QAC9B,qBAAqB,EAAE,CAAC,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,EAAE;YAC1D,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;YAExC,IAAI,UAAU,EAAE;gBACf,uEAAuE;gBACvE,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;oBAC9C,OAAO,EAAE,IAAI,EAAE,CAAC;gBACjB,CAAC,CAAC,CAAC;aACH;QACF,CAAC;QACD,0CAA0C,EAAE,CAAC,YAAY,EAAE,EAAE;YAC5D,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;KACpB,CAAC,CAAC;AACJ,CAAC,EACD,YAAY,CACZ,CAAC","sourcesContent":["import produce from \"immer\";\nimport { WorkspaceActions, WorkspaceActionTypes } from \"../actions/workspaceActions\";\nimport { Workspace } from \"../types/workspaceTypes\";\nimport { Reducer } from \"react\";\n\nexport type WorkspaceState = {\n\tactiveWorkspace: Workspace;\n\tworkspaces: Workspace[];\n\tpromptOnSave: boolean;\n};\n\nexport const initialState: WorkspaceState = {\n\tactiveWorkspace: {\n\t\tname: \"\",\n\t},\n\tworkspaces: [],\n\tpromptOnSave: false,\n};\n\nexport const workspaceReducer: Reducer<WorkspaceState, WorkspaceActionTypes> = produce(\n\t(state: WorkspaceState, action: WorkspaceActionTypes) => {\n\t\tWorkspaceActions.match(action, {\n\t\t\tUPDATE_ALL_WORKSPACES: ({ activeWorkspace, workspaces }) => {\n\t\t\t\tstate.activeWorkspace = activeWorkspace;\n\n\t\t\t\tif (workspaces) {\n\t\t\t\t\t// We only care about the name returned by the workspaceService updates\n\t\t\t\t\tstate.workspaces = workspaces.map(({ name }) => {\n\t\t\t\t\t\treturn { name };\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t},\n\t\t\tUPDATE_PROMPT_ON_SAVE_WORKSPACE_PREFERENCE: (promptOnSave) => {\n\t\t\t\tstate.promptOnSave = promptOnSave;\n\t\t\t},\n\t\t\tdefault: () => state,\n\t\t});\n\t},\n\tinitialState\n);\n"]}