@finsemble/finsemble-ui 1.0.0-beta-1

package/react/components/yesNoDialog/YesNoDialog.stories.js

@@ -0,0 +1,74 @@
+import React from "react";
+import { YesNoDialog } from "./YesNoDialog";
+import { initFSBL } from "../common/helpers";
+import "../../assets/css/dialogs.css";
+export default {
+    title: "YesNoDialog/YesNoDialog",
+    component: YesNoDialog,
+};
+const Template = (args) => {
+    initFSBL(window);
+    if (args._data) {
+        FSBL.Clients.DialogManager.registerDialogCallback = async (cb) => {
+            cb === null || cb === void 0 ? void 0 : cb("", { data: args._data });
+        };
+    }
+    return React.createElement(YesNoDialog, Object.assign({}, args));
+};
+export const Empty = Template.bind({});
+export const Basic = Template.bind({});
+Basic.args = {
+    _data: {
+        title: "Example titles",
+        question: "Is this a question?",
+        showNegativeButton: false,
+        showAffirmativeButton: true,
+        showCancelButton: true,
+        showTimer: false,
+    },
+};
+export const NoText = Template.bind({});
+NoText.args = {
+    _data: {
+        showNegativeButton: false,
+        showAffirmativeButton: true,
+        showCancelButton: true,
+    },
+};
+export const WithTimer = Template.bind({});
+WithTimer.args = {
+    _data: {
+        title: "Example titles",
+        question: "Is this a question?",
+        showNegativeButton: false,
+        showAffirmativeButton: true,
+        showCancelButton: true,
+        showTimer: true,
+        timerDuration: 3000,
+    },
+};
+export const NoButtons = Template.bind({});
+NoButtons.args = {
+    _data: {
+        title: "No buttons",
+        question: "What are you going to do about it?",
+        showNegativeButton: false,
+        showAffirmativeButton: false,
+        showCancelButton: false,
+    },
+};
+export const CustomButtonLabels = Template.bind({});
+CustomButtonLabels.args = {
+    _data: {
+        title: "Example titles",
+        question: "Is this a question?",
+        showNegativeButton: true,
+        showAffirmativeButton: true,
+        showCancelButton: true,
+        affirmativeResponseLabel: "Tak",
+        negativeResponseLabel: "Nie",
+        cancelResponseLabel: "Anuluj",
+        showTimer: false,
+    },
+};
+//# sourceMappingURL=YesNoDialog.stories.js.map

package/react/components/yesNoDialog/YesNoDialog.stories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"YesNoDialog.stories.js","sourceRoot":"","sources":["../../../src/components/yesNoDialog/YesNoDialog.stories.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,8BAA8B,CAAC;AAEtC,eAAe;IACd,KAAK,EAAE,yBAAyB;IAChC,SAAS,EAAE,WAAW;CACtB,CAAC;AAEF,MAAM,QAAQ,GAAc,CAAC,IAAS,EAAE,EAAE;IACzC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEjB,IAAI,IAAI,CAAC,KAAK,EAAE;QACf,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,sBAAsB,GAAG,KAAK,EAAE,EAAO,EAAE,EAAE;YACrE,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC;KACF;IAED,OAAO,oBAAC,WAAW,oBAAK,IAAI,EAAI,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAEvC,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACvC,KAAK,CAAC,IAAI,GAAG;IACZ,KAAK,EAAE;QACN,KAAK,EAAE,gBAAgB;QACvB,QAAQ,EAAE,qBAAqB;QAC/B,kBAAkB,EAAE,KAAK;QACzB,qBAAqB,EAAE,IAAI;QAC3B,gBAAgB,EAAE,IAAI;QACtB,SAAS,EAAE,KAAK;KAChB;CACD,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxC,MAAM,CAAC,IAAI,GAAG;IACb,KAAK,EAAE;QACN,kBAAkB,EAAE,KAAK;QACzB,qBAAqB,EAAE,IAAI;QAC3B,gBAAgB,EAAE,IAAI;KACtB;CACD,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3C,SAAS,CAAC,IAAI,GAAG;IAChB,KAAK,EAAE;QACN,KAAK,EAAE,gBAAgB;QACvB,QAAQ,EAAE,qBAAqB;QAC/B,kBAAkB,EAAE,KAAK;QACzB,qBAAqB,EAAE,IAAI;QAC3B,gBAAgB,EAAE,IAAI;QACtB,SAAS,EAAE,IAAI;QACf,aAAa,EAAE,IAAI;KACnB;CACD,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3C,SAAS,CAAC,IAAI,GAAG;IAChB,KAAK,EAAE;QACN,KAAK,EAAE,YAAY;QACnB,QAAQ,EAAE,oCAAoC;QAC9C,kBAAkB,EAAE,KAAK;QACzB,qBAAqB,EAAE,KAAK;QAC5B,gBAAgB,EAAE,KAAK;KACvB;CACD,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACpD,kBAAkB,CAAC,IAAI,GAAG;IACzB,KAAK,EAAE;QACN,KAAK,EAAE,gBAAgB;QACvB,QAAQ,EAAE,qBAAqB;QAC/B,kBAAkB,EAAE,IAAI;QACxB,qBAAqB,EAAE,IAAI;QAC3B,gBAAgB,EAAE,IAAI;QACtB,wBAAwB,EAAE,KAAK;QAC/B,qBAAqB,EAAE,KAAK;QAC5B,mBAAmB,EAAE,QAAQ;QAC7B,SAAS,EAAE,KAAK;KAChB;CACD,CAAC","sourcesContent":["import React from \"react\";\nimport { YesNoDialog } from \"./YesNoDialog\";\nimport { initFSBL } from \"../common/helpers\";\nimport { Story } from \"@storybook/react/types-6-0\";\nimport \"../../assets/css/dialogs.css\";\n\nexport default {\n\ttitle: \"YesNoDialog/YesNoDialog\",\n\tcomponent: YesNoDialog,\n};\n\nconst Template: Story<{}> = (args: any) => {\n\tinitFSBL(window);\n\n\tif (args._data) {\n\t\tFSBL.Clients.DialogManager.registerDialogCallback = async (cb: any) => {\n\t\t\tcb?.(\"\", { data: args._data });\n\t\t};\n\t}\n\n\treturn <YesNoDialog {...args} />;\n};\n\nexport const Empty = Template.bind({});\n\nexport const Basic = Template.bind({});\nBasic.args = {\n\t_data: {\n\t\ttitle: \"Example titles\",\n\t\tquestion: \"Is this a question?\",\n\t\tshowNegativeButton: false,\n\t\tshowAffirmativeButton: true,\n\t\tshowCancelButton: true,\n\t\tshowTimer: false,\n\t},\n};\n\nexport const NoText = Template.bind({});\nNoText.args = {\n\t_data: {\n\t\tshowNegativeButton: false,\n\t\tshowAffirmativeButton: true,\n\t\tshowCancelButton: true,\n\t},\n};\n\nexport const WithTimer = Template.bind({});\nWithTimer.args = {\n\t_data: {\n\t\ttitle: \"Example titles\",\n\t\tquestion: \"Is this a question?\",\n\t\tshowNegativeButton: false,\n\t\tshowAffirmativeButton: true,\n\t\tshowCancelButton: true,\n\t\tshowTimer: true,\n\t\ttimerDuration: 3000,\n\t},\n};\n\nexport const NoButtons = Template.bind({});\nNoButtons.args = {\n\t_data: {\n\t\ttitle: \"No buttons\",\n\t\tquestion: \"What are you going to do about it?\",\n\t\tshowNegativeButton: false,\n\t\tshowAffirmativeButton: false,\n\t\tshowCancelButton: false,\n\t},\n};\n\nexport const CustomButtonLabels = Template.bind({});\nCustomButtonLabels.args = {\n\t_data: {\n\t\ttitle: \"Example titles\",\n\t\tquestion: \"Is this a question?\",\n\t\tshowNegativeButton: true,\n\t\tshowAffirmativeButton: true,\n\t\tshowCancelButton: true,\n\t\taffirmativeResponseLabel: \"Tak\",\n\t\tnegativeResponseLabel: \"Nie\",\n\t\tcancelResponseLabel: \"Anuluj\",\n\t\tshowTimer: false,\n\t},\n};\n"]}

package/react/components/yesNoDialog/index.d.ts

@@ -0,0 +1 @@
+export { YesNoDialog } from "./YesNoDialog";

package/react/components/yesNoDialog/index.js

@@ -0,0 +1,2 @@
+export { YesNoDialog } from "./YesNoDialog";
+//# sourceMappingURL=index.js.map

package/react/components/yesNoDialog/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/yesNoDialog/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC","sourcesContent":["export { YesNoDialog } from \"./YesNoDialog\";\n"]}

package/react/components/yesNoDialog/timer.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import React from "react";
+export interface IProps {
+    timerDuration: number;
+    ontimerDurationExpiration: () => void;
+}
+interface IState {
+    timerDuration: number;
+}
+export default class Timer extends React.Component<IProps, IState> {
+    interval?: NodeJS.Timeout;
+    constructor(props: any);
+    componentDidMount(): void;
+    render(): JSX.Element;
+}
+export {};

package/react/components/yesNoDialog/timer.js

@@ -0,0 +1,32 @@
+import React from "react";
+export default class Timer extends React.Component {
+    constructor(props) {
+        super(props);
+        this.state = {
+            timerDuration: props.timerDuration,
+        };
+    }
+    //Every second, subtract a second.
+    componentDidMount() {
+        this.interval = setInterval(() => {
+            let newTime = this.state.timerDuration - 1000;
+            if (newTime <= 0) {
+                this.props.ontimerDurationExpiration();
+                if (this.interval)
+                    clearInterval(this.interval);
+            }
+            else {
+                this.setState({
+                    timerDuration: newTime,
+                });
+            }
+        }, 1000);
+    }
+    //Countdown clock.
+    render() {
+        return React.createElement("div", null,
+            "Time remaining: ",
+            this.state.timerDuration / 1000);
+    }
+}
+//# sourceMappingURL=timer.js.map

package/react/components/yesNoDialog/timer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timer.js","sourceRoot":"","sources":["../../../src/components/yesNoDialog/timer.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAU1B,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,KAAK,CAAC,SAAyB;IAGjE,YAAY,KAAU;QACrB,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,GAAG;YACZ,aAAa,EAAE,KAAK,CAAC,aAAa;SAClC,CAAC;IACH,CAAC;IAED,kCAAkC;IAClC,iBAAiB;QAChB,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YAChC,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAC9C,IAAI,OAAO,IAAI,CAAC,EAAE;gBACjB,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,QAAQ;oBAAE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAChD;iBAAM;gBACN,IAAI,CAAC,QAAQ,CAAC;oBACb,aAAa,EAAE,OAAO;iBACtB,CAAC,CAAC;aACH;QACF,CAAC,EAAE,IAAI,CAAC,CAAC;IACV,CAAC;IAED,kBAAkB;IAClB,MAAM;QACL,OAAO;;YAAsB,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAO,CAAC;IACrE,CAAC;CACD","sourcesContent":["import React from \"react\";\n\nexport interface IProps {\n\ttimerDuration: number;\n\tontimerDurationExpiration: () => void;\n}\ninterface IState {\n\ttimerDuration: number;\n}\n\nexport default class Timer extends React.Component<IProps, IState> {\n\tinterval?: NodeJS.Timeout;\n\n\tconstructor(props: any) {\n\t\tsuper(props);\n\t\tthis.state = {\n\t\t\ttimerDuration: props.timerDuration,\n\t\t};\n\t}\n\n\t//Every second, subtract a second.\n\tcomponentDidMount() {\n\t\tthis.interval = setInterval(() => {\n\t\t\tlet newTime = this.state.timerDuration - 1000;\n\t\t\tif (newTime <= 0) {\n\t\t\t\tthis.props.ontimerDurationExpiration();\n\t\t\t\tif (this.interval) clearInterval(this.interval);\n\t\t\t} else {\n\t\t\t\tthis.setState({\n\t\t\t\t\ttimerDuration: newTime,\n\t\t\t\t});\n\t\t\t}\n\t\t}, 1000);\n\t}\n\n\t//Countdown clock.\n\trender() {\n\t\treturn <div>Time remaining: {this.state.timerDuration / 1000}</div>;\n\t}\n}\n"]}

package/react/enzymeSetup.d.ts

@@ -0,0 +1 @@
+export {};

package/react/enzymeSetup.js

@@ -0,0 +1,35 @@
+// This is a helper/setup script that should be `--require`d when calling mocha to run enzyme tests
+// that require more real-world browser DOM objects to be exposed, like `.document` and `.window`.
+// This is needed to use methods like `.mount()` within enzyme.
+// It uses jsdom to set up a fake web browser in JavaScript.
+//import Adapter from "enzyme-adapter-react-16";
+import Adapter from "@wojtekmaj/enzyme-adapter-react-17";
+import { configure } from "enzyme";
+import jsdom from "jsdom";
+require("@babel/register")();
+function copyProps(src, target) {
+    const props = Object.getOwnPropertyNames(src)
+        .filter((prop) => typeof target[prop] === "undefined")
+        .map((prop) => Object.getOwnPropertyDescriptor(src, prop));
+    Object.defineProperties(target, props);
+}
+function setUpDomEnvironment() {
+    const { JSDOM } = jsdom;
+    const dom = new JSDOM("<!doctype html><html><body></body></html>", { url: "http://localhost/" });
+    const { window } = dom;
+    global.window = window;
+    global.document = window.document;
+    global.navigator = {
+        userAgent: "node.js",
+    };
+    global.File = window.File;
+    global.FSBL = {
+        Clients: {
+            SearchClient: {},
+        },
+    };
+    copyProps(window, global);
+}
+setUpDomEnvironment();
+configure({ adapter: new Adapter() });
+//# sourceMappingURL=enzymeSetup.js.map

package/react/enzymeSetup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enzymeSetup.js","sourceRoot":"","sources":["../src/enzymeSetup.js"],"names":[],"mappings":"AAAA,mGAAmG;AACnG,kGAAkG;AAClG,+DAA+D;AAC/D,4DAA4D;AAE5D,gDAAgD;AAChD,OAAO,OAAO,MAAM,oCAAoC,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;AAE7B,SAAS,SAAS,CAAC,GAAG,EAAE,MAAM;IAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC;SAC3C,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC;SACrD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,wBAAwB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5D,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,mBAAmB;IAC3B,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACxB,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,2CAA2C,EAAE,EAAE,GAAG,EAAE,mBAAmB,EAAE,CAAC,CAAC;IACjG,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IAClC,MAAM,CAAC,SAAS,GAAG;QAClB,SAAS,EAAE,SAAS;KACpB,CAAC;IACF,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAC1B,MAAM,CAAC,IAAI,GAAG;QACb,OAAO,EAAE;YACR,YAAY,EAAE,EAAE;SAChB;KACD,CAAC;IACF,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED,mBAAmB,EAAE,CAAC;AAEtB,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,OAAO,EAAE,EAAE,CAAC,CAAC","sourcesContent":["// This is a helper/setup script that should be `--require`d when calling mocha to run enzyme tests\n// that require more real-world browser DOM objects to be exposed, like `.document` and `.window`.\n// This is needed to use methods like `.mount()` within enzyme.\n// It uses jsdom to set up a fake web browser in JavaScript.\n\n//import Adapter from \"enzyme-adapter-react-16\";\nimport Adapter from \"@wojtekmaj/enzyme-adapter-react-17\";\nimport { configure } from \"enzyme\";\nimport jsdom from \"jsdom\";\n\nrequire(\"@babel/register\")();\n\nfunction copyProps(src, target) {\n\tconst props = Object.getOwnPropertyNames(src)\n\t\t.filter((prop) => typeof target[prop] === \"undefined\")\n\t\t.map((prop) => Object.getOwnPropertyDescriptor(src, prop));\n\tObject.defineProperties(target, props);\n}\n\nfunction setUpDomEnvironment() {\n\tconst { JSDOM } = jsdom;\n\tconst dom = new JSDOM(\"<!doctype html><html><body></body></html>\", { url: \"http://localhost/\" });\n\tconst { window } = dom;\n\n\tglobal.window = window;\n\tglobal.document = window.document;\n\tglobal.navigator = {\n\t\tuserAgent: \"node.js\",\n\t};\n\tglobal.File = window.File;\n\tglobal.FSBL = {\n\t\tClients: {\n\t\t\tSearchClient: {},\n\t\t},\n\t};\n\tcopyProps(window, global);\n}\n\nsetUpDomEnvironment();\n\nconfigure({ adapter: new Adapter() });\n"]}

package/react/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { useAuth, useAuthSimulator } from "./useAuth";
+export { useHotkey } from "./useHotkey";

package/react/hooks/index.js

@@ -0,0 +1,3 @@
+export { useAuth, useAuthSimulator } from "./useAuth";
+export { useHotkey } from "./useHotkey";
+//# sourceMappingURL=index.js.map

package/react/hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC","sourcesContent":["export { useAuth, useAuthSimulator } from \"./useAuth\";\nexport { useHotkey } from \"./useHotkey\";\n"]}

package/react/hooks/useAuth.d.ts

@@ -0,0 +1,10 @@
+export declare const useAuth: () => {
+    publishAuthorization: (user: string, credentials?: any) => void;
+    quitApplication: () => void;
+};
+export declare const useAuthSimulator: () => {
+    sendToServer: (username: string, password: string) => Promise<{
+        result?: string;
+        error?: string;
+    }>;
+};

package/react/hooks/useAuth.js

@@ -0,0 +1,26 @@
+export const useAuth = () => {
+    const publishAuthorization = (user, credentials) => {
+        FSBL.System.Window.getCurrent().hide();
+        FSBL.Clients.AuthenticationClient.publishAuthorization(user, credentials);
+    };
+    const quitApplication = () => {
+        FSBL.System.exit();
+    };
+    return {
+        publishAuthorization,
+        quitApplication,
+    };
+};
+export const useAuthSimulator = () => {
+    const sendToServer = async (username, password) => {
+        if (!username || !username.length)
+            return await Promise.resolve({ error: "Missing or empty username" });
+        if (!password || !password.length)
+            return await Promise.resolve({ error: "Missing or empty password" });
+        return await Promise.resolve({ result: "ok" });
+    };
+    return {
+        sendToServer,
+    };
+};
+//# sourceMappingURL=useAuth.js.map

package/react/hooks/useAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAuth.js","sourceRoot":"","sources":["../../src/hooks/useAuth.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,EAAE;IAC3B,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,WAAiB,EAAE,EAAE;QAChE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC3E,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,GAAG,EAAE;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC,CAAC;IAEF,OAAO;QACN,oBAAoB;QACpB,eAAe;KACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACpC,MAAM,YAAY,GAAG,KAAK,EAAE,QAAgB,EAAE,QAAgB,EAAgD,EAAE;QAC/G,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,2BAA2B,EAAE,CAAC,CAAC;QACxG,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,2BAA2B,EAAE,CAAC,CAAC;QACxG,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC;IAEF,OAAO;QACN,YAAY;KACZ,CAAC;AACH,CAAC,CAAC","sourcesContent":["export const useAuth = () => {\n\tconst publishAuthorization = (user: string, credentials?: any) => {\n\t\tFSBL.System.Window.getCurrent().hide();\n\t\tFSBL.Clients.AuthenticationClient.publishAuthorization(user, credentials);\n\t};\n\n\tconst quitApplication = () => {\n\t\tFSBL.System.exit();\n\t};\n\n\treturn {\n\t\tpublishAuthorization,\n\t\tquitApplication,\n\t};\n};\n\nexport const useAuthSimulator = () => {\n\tconst sendToServer = async (username: string, password: string): Promise<{ result?: string; error?: string }> => {\n\t\tif (!username || !username.length) return await Promise.resolve({ error: \"Missing or empty username\" });\n\t\tif (!password || !password.length) return await Promise.resolve({ error: \"Missing or empty password\" });\n\t\treturn await Promise.resolve({ result: \"ok\" });\n\t};\n\n\treturn {\n\t\tsendToServer,\n\t};\n};\n"]}

package/react/hooks/useDashbar.d.ts

@@ -0,0 +1,8 @@
+import { DashbarItem } from "../types/dashbarTypes";
+export declare const useDashbar: () => {
+    dashbarItems: DashbarItem[];
+    reorderDashbarItems: ({ oldIndex, newIndex }: {
+        oldIndex: number;
+        newIndex: number;
+    }) => void;
+};

package/react/hooks/useDashbar.js

@@ -0,0 +1,114 @@
+import { useDeepEffect } from "./useDeepEffect";
+import { useSelector } from "../store";
+import { ToolbarActions } from "../actions/toolbarActions";
+import { useDispatch } from "react-redux";
+let storageIsInitialized = false;
+let DashbarStore;
+const setDashbarItem = (itemName, availableDashbarItems, newDashbarItems) => {
+    if (availableDashbarItems.hasOwnProperty(itemName)) {
+        const newItem = availableDashbarItems[itemName];
+        newItem.id = itemName;
+        newDashbarItems.push(newItem);
+    }
+};
+const initializeDistributedStore = async () => {
+    const storeParams = {
+        store: "Finsemble-Dashbar-Store",
+        global: true,
+        persist: true,
+    };
+    const { err, data: store } = await FSBL.Clients.DistributedStoreClient.createStore(storeParams);
+    if (err || !store) {
+        const error = `Error initializing dashbar: unable to retrieve stored items, falling back to config: ${err}`;
+        FSBL.Clients.Logger.system.error(error);
+        return;
+    }
+    DashbarStore = store;
+};
+/**
+ * Fetches an initial list of dashbar items from the persistent distributed store,
+ * and if that doesn't exist, from spawnData
+ */
+const initializeDashbarItems = async () => {
+    var _a;
+    let dashbarItemList;
+    if (DashbarStore && Object.keys(DashbarStore.values).length > 0) {
+        dashbarItemList = DashbarStore.values.dashbaritems;
+    }
+    if (!dashbarItemList) {
+        const spawnData = FSBL.Clients.WindowClient.getSpawnData();
+        if (Array.isArray((_a = spawnData === null || spawnData === void 0 ? void 0 : spawnData.dashbar) === null || _a === void 0 ? void 0 : _a.items)) {
+            dashbarItemList = spawnData.dashbar.items;
+        }
+    }
+    if (!dashbarItemList)
+        dashbarItemList = [];
+    const newDashbarItems = [];
+    if (dashbarItemList.length > 0) {
+        const { data: availableDashbarItems } = await FSBL.Clients.ConfigClient.getValue({
+            field: "finsemble.availableDashbarItems",
+        });
+        dashbarItemList.forEach((itemName) => setDashbarItem(itemName, availableDashbarItems, newDashbarItems));
+    }
+    if (!DashbarStore.values.dashbaritems) {
+        DashbarStore.setValue({
+            field: "dashbaritems",
+            value: dashbarItemList,
+        });
+        return null;
+    }
+    else {
+        return newDashbarItems;
+    }
+};
+export const useDashbar = () => {
+    const dispatch = useDispatch();
+    const setDashbarItems = async (err, data) => {
+        if (!err && data) {
+            const { data: availableDashbarItems } = await FSBL.Clients.ConfigClient.getValue({
+                field: "finsemble.availableDashbarItems",
+            });
+            const newDashbarItems = [];
+            // Add the widget name as an id to help identify
+            // keys -> widgets when reordering items
+            data.value.forEach((item) => setDashbarItem(item, availableDashbarItems, newDashbarItems));
+            dispatch(ToolbarActions.SET_DASHBAR_ITEMS(newDashbarItems));
+        }
+    };
+    /**
+     * This effect initializes the dashbar items in the redux store. The store must only be initialized once. We use the module level variable
+     * `storageIsInitialized` as a simple flag to prevent initialization from occuring more than once.
+     */
+    useDeepEffect(async () => {
+        if (!storageIsInitialized) {
+            storageIsInitialized = true;
+            await initializeDistributedStore();
+            const newDashbarItems = await initializeDashbarItems();
+            if (newDashbarItems)
+                dispatch(ToolbarActions.SET_DASHBAR_ITEMS(newDashbarItems));
+            DashbarStore.addListener({ field: "dashbaritems" }, setDashbarItems);
+        }
+        return function cleanup() {
+            DashbarStore.removeListener({ field: "dashbaritems" }, setDashbarItems);
+        };
+    }, [dispatch]);
+    const { dashbarItems } = useSelector((state) => state.toolbar);
+    const reorderDashbarItems = ({ oldIndex, newIndex }) => {
+        const dashbarItemsNewOrder = [...dashbarItems];
+        const dashbarItemToMove = dashbarItemsNewOrder[oldIndex];
+        dashbarItemsNewOrder.splice(oldIndex, 1);
+        dashbarItemsNewOrder.splice(newIndex, 0, dashbarItemToMove);
+        const newOrderList = dashbarItemsNewOrder.map((dashbarItem) => dashbarItem.id);
+        DashbarStore.setValue({
+            field: "dashbaritems",
+            value: newOrderList,
+        }, () => {
+            dispatch(ToolbarActions.REORDER_DASHBAR_ITEMS({ oldIndex, newIndex }));
+        });
+    };
+    return {
+        dashbarItems,
+        reorderDashbarItems,
+    };
+};
+//# sourceMappingURL=useDashbar.js.map

package/react/hooks/useDashbar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDashbar.js","sourceRoot":"","sources":["../../src/hooks/useDashbar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAO1C,IAAI,oBAAoB,GAAY,KAAK,CAAC;AAM1C,IAAI,YAAwB,CAAC;AAE7B,MAAM,cAAc,GAAG,CACtB,QAAgB,EAChB,qBAAkD,EAClD,eAA8B,EAC7B,EAAE;IACH,IAAI,qBAAqB,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACnD,MAAM,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAChD,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC;QACtB,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KAC9B;AACF,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,KAAK,IAAmB,EAAE;IAC5D,MAAM,WAAW,GAAG;QACnB,KAAK,EAAE,yBAAyB;QAChC,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE,IAAI;KACb,CAAC;IACF,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAChG,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE;QAClB,MAAM,KAAK,GAAG,wFAAwF,GAAG,EAAE,CAAC;QAC5G,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxC,OAAO;KACP;IAED,YAAY,GAAG,KAAK,CAAC;AACtB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,sBAAsB,GAAG,KAAK,IAAmC,EAAE;;IACxE,IAAI,eAAe,CAAC;IACpB,IAAI,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;QAChE,eAAe,GAAI,YAAY,CAAC,MAAgC,CAAC,YAAY,CAAC;KAC9E;IAED,IAAI,CAAC,eAAe,EAAE;QACrB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;QAC3D,IAAI,KAAK,CAAC,OAAO,CAAC,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,0CAAE,KAAK,CAAC,EAAE;YAC7C,eAAe,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC;SAC1C;KACD;IAED,IAAI,CAAC,eAAe;QAAE,eAAe,GAAG,EAAE,CAAC;IAE3C,MAAM,eAAe,GAAkB,EAAE,CAAC;IAC1C,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/B,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC;YAChF,KAAK,EAAE,iCAAiC;SACxC,CAAC,CAAC;QAEH,eAAe,CAAC,OAAO,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,qBAAqB,EAAE,eAAe,CAAC,CAAC,CAAC;KAChH;IAED,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,EAAE;QACtC,YAAY,CAAC,QAAQ,CAAC;YACrB,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,eAAe;SACtB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;KACZ;SAAM;QACN,OAAO,eAAe,CAAC;KACvB;AACF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE;IAC9B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAE/B,MAAM,eAAe,GAAG,KAAK,EAAE,GAAkB,EAAE,IAAS,EAAE,EAAE;QAC/D,IAAI,CAAC,GAAG,IAAI,IAAI,EAAE;YACjB,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC;gBAChF,KAAK,EAAE,iCAAiC;aACxC,CAAC,CAAC;YACH,MAAM,eAAe,GAAkB,EAAE,CAAC;YAC1C,gDAAgD;YAChD,wCAAwC;YACxC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,EAAE,eAAe,CAAC,CAAC,CAAC;YAEnG,QAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC;SAC5D;IACF,CAAC,CAAC;IAEF;;;OAGG;IACH,aAAa,CAAC,KAAK,IAAI,EAAE;QACxB,IAAI,CAAC,oBAAoB,EAAE;YAC1B,oBAAoB,GAAG,IAAI,CAAC;YAC5B,MAAM,0BAA0B,EAAE,CAAC;YACnC,MAAM,eAAe,GAAG,MAAM,sBAAsB,EAAE,CAAC;YACvD,IAAI,eAAe;gBAAE,QAAQ,CAAC,cAAc,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC;YACjF,YAAY,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,eAAe,CAAC,CAAC;SACrE;QACD,OAAO,SAAS,OAAO;YACtB,YAAY,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,eAAe,CAAC,CAAC;QACzE,CAAC,CAAC;IACH,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,MAAM,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE/D,MAAM,mBAAmB,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAA0C,EAAE,EAAE;QAC9F,MAAM,oBAAoB,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC;QAC/C,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACzD,oBAAoB,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACzC,oBAAoB,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAE5D,MAAM,YAAY,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAE/E,YAAY,CAAC,QAAQ,CACpB;YACC,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,YAAY;SACnB,EACD,GAAG,EAAE;YACJ,QAAQ,CAAC,cAAc,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACxE,CAAC,CACD,CAAC;IACH,CAAC,CAAC;IAEF,OAAO;QACN,YAAY;QACZ,mBAAmB;KACnB,CAAC;AACH,CAAC,CAAC","sourcesContent":["import { useDeepEffect } from \"./useDeepEffect\";\nimport { useSelector } from \"../store\";\nimport { ToolbarActions } from \"../actions/toolbarActions\";\nimport { useDispatch } from \"react-redux\";\nimport { DashbarItem } from \"../types/dashbarTypes\";\nimport { types } from \"@finsemble/finsemble-api\";\n\ntype StoreModel = types.StoreModel;\ntype StandardError = types.StandardError;\n\nlet storageIsInitialized: boolean = false;\n\ntype DashbarStoreValueType = {\n\tdashbaritems: DashbarItem[];\n};\n\nlet DashbarStore: StoreModel;\n\nconst setDashbarItem = (\n\titemName: string,\n\tavailableDashbarItems: Record<string, DashbarItem>,\n\tnewDashbarItems: DashbarItem[]\n) => {\n\tif (availableDashbarItems.hasOwnProperty(itemName)) {\n\t\tconst newItem = availableDashbarItems[itemName];\n\t\tnewItem.id = itemName;\n\t\tnewDashbarItems.push(newItem);\n\t}\n};\n\nconst initializeDistributedStore = async (): Promise<void> => {\n\tconst storeParams = {\n\t\tstore: \"Finsemble-Dashbar-Store\",\n\t\tglobal: true,\n\t\tpersist: true,\n\t};\n\tconst { err, data: store } = await FSBL.Clients.DistributedStoreClient.createStore(storeParams);\n\tif (err || !store) {\n\t\tconst error = `Error initializing dashbar: unable to retrieve stored items, falling back to config: ${err}`;\n\t\tFSBL.Clients.Logger.system.error(error);\n\t\treturn;\n\t}\n\n\tDashbarStore = store;\n};\n\n/**\n * Fetches an initial list of dashbar items from the persistent distributed store,\n * and if that doesn't exist, from spawnData\n */\nconst initializeDashbarItems = async (): Promise<DashbarItem[] | null> => {\n\tlet dashbarItemList;\n\tif (DashbarStore && Object.keys(DashbarStore.values).length > 0) {\n\t\tdashbarItemList = (DashbarStore.values as DashbarStoreValueType).dashbaritems;\n\t}\n\n\tif (!dashbarItemList) {\n\t\tconst spawnData = FSBL.Clients.WindowClient.getSpawnData();\n\t\tif (Array.isArray(spawnData?.dashbar?.items)) {\n\t\t\tdashbarItemList = spawnData.dashbar.items;\n\t\t}\n\t}\n\n\tif (!dashbarItemList) dashbarItemList = [];\n\n\tconst newDashbarItems: DashbarItem[] = [];\n\tif (dashbarItemList.length > 0) {\n\t\tconst { data: availableDashbarItems } = await FSBL.Clients.ConfigClient.getValue({\n\t\t\tfield: \"finsemble.availableDashbarItems\",\n\t\t});\n\n\t\tdashbarItemList.forEach((itemName: string) => setDashbarItem(itemName, availableDashbarItems, newDashbarItems));\n\t}\n\n\tif (!DashbarStore.values.dashbaritems) {\n\t\tDashbarStore.setValue({\n\t\t\tfield: \"dashbaritems\",\n\t\t\tvalue: dashbarItemList,\n\t\t});\n\t\treturn null;\n\t} else {\n\t\treturn newDashbarItems;\n\t}\n};\n\nexport const useDashbar = () => {\n\tconst dispatch = useDispatch();\n\n\tconst setDashbarItems = async (err: StandardError, data: any) => {\n\t\tif (!err && data) {\n\t\t\tconst { data: availableDashbarItems } = await FSBL.Clients.ConfigClient.getValue({\n\t\t\t\tfield: \"finsemble.availableDashbarItems\",\n\t\t\t});\n\t\t\tconst newDashbarItems: DashbarItem[] = [];\n\t\t\t// Add the widget name as an id to help identify\n\t\t\t// keys -> widgets when reordering items\n\t\t\tdata.value.forEach((item: string) => setDashbarItem(item, availableDashbarItems, newDashbarItems));\n\n\t\t\tdispatch(ToolbarActions.SET_DASHBAR_ITEMS(newDashbarItems));\n\t\t}\n\t};\n\n\t/**\n\t * This effect initializes the dashbar items in the redux store. The store must only be initialized once. We use the module level variable\n\t * `storageIsInitialized` as a simple flag to prevent initialization from occuring more than once.\n\t */\n\tuseDeepEffect(async () => {\n\t\tif (!storageIsInitialized) {\n\t\t\tstorageIsInitialized = true;\n\t\t\tawait initializeDistributedStore();\n\t\t\tconst newDashbarItems = await initializeDashbarItems();\n\t\t\tif (newDashbarItems) dispatch(ToolbarActions.SET_DASHBAR_ITEMS(newDashbarItems));\n\t\t\tDashbarStore.addListener({ field: \"dashbaritems\" }, setDashbarItems);\n\t\t}\n\t\treturn function cleanup() {\n\t\t\tDashbarStore.removeListener({ field: \"dashbaritems\" }, setDashbarItems);\n\t\t};\n\t}, [dispatch]);\n\n\tconst { dashbarItems } = useSelector((state) => state.toolbar);\n\n\tconst reorderDashbarItems = ({ oldIndex, newIndex }: { oldIndex: number; newIndex: number }) => {\n\t\tconst dashbarItemsNewOrder = [...dashbarItems];\n\t\tconst dashbarItemToMove = dashbarItemsNewOrder[oldIndex];\n\t\tdashbarItemsNewOrder.splice(oldIndex, 1);\n\t\tdashbarItemsNewOrder.splice(newIndex, 0, dashbarItemToMove);\n\n\t\tconst newOrderList = dashbarItemsNewOrder.map((dashbarItem) => dashbarItem.id);\n\n\t\tDashbarStore.setValue(\n\t\t\t{\n\t\t\t\tfield: \"dashbaritems\",\n\t\t\t\tvalue: newOrderList,\n\t\t\t},\n\t\t\t() => {\n\t\t\t\tdispatch(ToolbarActions.REORDER_DASHBAR_ITEMS({ oldIndex, newIndex }));\n\t\t\t}\n\t\t);\n\t};\n\n\treturn {\n\t\tdashbarItems,\n\t\treorderDashbarItems,\n\t};\n};\n"]}

package/react/hooks/useDeepEffect.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Use this just like useEffect() except that this will compare objects and arrays using lodash's isEqual() method.
+ * Always pass an array of dependencies as the second parameter!!!
+ */
+export declare function useDeepEffect(callback: any, dependencies: Array<any>): void;

package/react/hooks/useDeepEffect.js

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

package/react/hooks/useDeepEffect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDeepEffect.js","sourceRoot":"","sources":["../../src/hooks/useDeepEffect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC,SAAS,qBAAqB,CAAC,KAAU;IACxC,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;IAErB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE;QACjC,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;KACpB;IAED,OAAO,GAAG,CAAC,OAAO,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,QAAa,EAAE,YAAwB;IACpE,SAAS,CAAC,QAAQ,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;;;;;;EAgBE","sourcesContent":["import { useEffect, useRef } from \"react\";\nimport isEqual from \"lodash/isEqual\";\n\nfunction useDeepCompareMemoize(value: any) {\n\tconst ref = useRef();\n\n\tif (!isEqual(value, ref.current)) {\n\t\tref.current = value;\n\t}\n\n\treturn ref.current;\n}\n\n/**\n * Use this just like useEffect() except that this will compare objects and arrays using lodash's isEqual() method.\n * Always pass an array of dependencies as the second parameter!!!\n */\nexport function useDeepEffect(callback: any, dependencies: Array<any>) {\n\tuseEffect(callback, useDeepCompareMemoize(dependencies));\n}\n\n/*\n// Previous implementation that had bugs. Keep around for a bit until we shake out the new version.\nexport function useDeepEffect(effectFunc : Function, deps : Array<any>) {\n\tconst isFirst = useRef(true);\n\tconst prevDeps = useRef(deps);\n\n\tuseEffect(() => {\n\t\tconst isSame = prevDeps.current.every((obj: any, index: any) => isEqual(obj, deps[index]));\n\t\tif (isFirst.current || !isSame) {\n\t\t\teffectFunc();\n\t\t}\n\n\t\tisFirst.current = false;\n\t\tprevDeps.current = deps;\n\t}, deps);\n}\n*/\n"]}

package/react/hooks/useFavorites.d.ts

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

package/react/hooks/useFavorites.js

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

package/react/hooks/useFavorites.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFavorites.js","sourceRoot":"","sources":["../../src/hooks/useFavorites.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAwB7D;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAkB,EAAE;IAC/C,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAEpD,MAAM,WAAW,GAAG,CAAC,QAAkB,EAAE,EAAE;QAC1C,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CAAC,EAAkB,EAAE,EAAE;QAC7C,QAAQ,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,EAAkB,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEtE,OAAO;QACN,SAAS;QACT,WAAW;QACX,cAAc;QACd,WAAW;KACX,CAAC;AACH,CAAC,CAAC","sourcesContent":["import { useDispatch, useSelector } from \"../store\";\nimport { Favorite } from \"../types/favoriteTypes\";\nimport { FavoriteActions } from \"../actions/favoriteActions\";\n\ntype FavoritesHook = {\n\t/**\n\t * The current favorites list from the store.\n\t */\n\tfavorites: Favorite[];\n\n\t/**\n\t * Adds a favorite to the favorites store.\n\t */\n\taddFavorite: (favorite: Favorite) => void;\n\n\t/**\n\t * Removes the favorite for the given id from the favorites store.\n\t */\n\tremoveFavorite: (id: Favorite[\"id\"]) => void;\n\n\t/**\n\t * Returns true if the current id has been favorited.\n\t */\n\tisFavorited: (id: Favorite[\"id\"]) => boolean;\n};\n\n/**\n * The useFavorites() hook is used by FavoriteMaker to interact with the redux store.\n */\nexport const useFavorites = (): FavoritesHook => {\n\tconst dispatch = useDispatch();\n\tconst { favorites } = useSelector((state) => state.favorite);\n\tconst favoritesIds = favorites.map((fav) => fav.id);\n\n\tconst addFavorite = (favorite: Favorite) => {\n\t\tdispatch(FavoriteActions.ADD_FAVORITE(favorite));\n\t};\n\n\tconst removeFavorite = (id: Favorite[\"id\"]) => {\n\t\tdispatch(FavoriteActions.REMOVE_FAVORITE(id));\n\t};\n\n\tconst isFavorited = (id: Favorite[\"id\"]) => favoritesIds.includes(id);\n\n\treturn {\n\t\tfavorites,\n\t\taddFavorite,\n\t\tremoveFavorite,\n\t\tisFavorited,\n\t};\n};\n"]}

package/react/hooks/useFavoritesShell.d.ts

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

package/react/hooks/useFavoritesShell.js

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

package/react/hooks/useFavoritesShell.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFavoritesShell.js","sourceRoot":"","sources":["../../src/hooks/useFavoritesShell.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKlC,IAAI,oBAAoB,GAAY,KAAK,CAAC;AAE1C;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACrC,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,GAAG,YAAY,EAAE,CAAC;IAErD,0IAA0I;IAC1I;;;;;OAKG;IACH,MAAM,eAAe,GAAG,KAAK,EAAE,EAAkB,EAAE,QAA8B,EAAE,EAAE;QACpF,IAAI,QAAQ,KAAK,aAAa,EAAE;YAC/B,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE;gBACrC,cAAc,EAAE,IAAI;gBACpB,OAAO,EAAE,MAAM;aACf,CAAC,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,WAAW,EAAE;YACpC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,QAAQ,CAC3C,EAAE,KAAK,EAAE,sCAAsC,EAAE,MAAM,EAAE,IAAI,EAAE,EAC/D,CAAC,GAAkB,EAAE,KAAW,EAAE,EAAE;gBACnC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC;oBACzB,UAAU,EAAE,mBAAmB;oBAC/B,IAAI,EAAE;wBACL,IAAI,EAAE,EAAE;qBACR;iBACD,CAAC,CAAC;YACJ,CAAC,CACD,CAAC;SACF;IACF,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,iBAAiB,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAA0C,EAAE,EAAE;QAC5F,QAAQ,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC;IAEF;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,oBAAoB;YAAE,OAAO;QACjC,oBAAoB,GAAG,IAAI,CAAC;QAC5B,+DAA+D;QAC/D,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,qBAAqB,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAChG,IAAI,GAAG,EAAE;gBACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CACtC,qEAAqE,GAAG,EAAE,CAC1E,CAAC;aACF;YACD,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,qFAAqF;IACrF,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC;YAC/B,KAAK,EAAE,WAAW;YAClB,GAAG,EAAE,qBAAqB;YAC1B,KAAK,EAAE,SAAS;SAChB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO;QACN,SAAS;QACT,cAAc;QACd,eAAe;QACf,iBAAiB;KACjB,CAAC;AACH,CAAC,CAAC","sourcesContent":["import { useDispatch } from \"../store\";\nimport { Favorite } from \"../types/favoriteTypes\";\nimport { FavoriteActions } from \"../actions/favoriteActions\";\nimport { useFavorites } from \"./useFavorites\";\nimport { useEffect } from \"react\";\nimport { types } from \"@finsemble/finsemble-api\";\n\ntype StandardError = types.StandardError;\n\nlet storageIsInitialized: boolean = false;\n\n/**\n * The useFavoritesShell() hook is used by FavoritesShell to interact with the redux store\n * and storage.\n */\nexport const useFavoritesShell = () => {\n\tconst dispatch = useDispatch();\n\tconst { favorites, removeFavorite } = useFavorites();\n\n\t// Ideally in the future the following function will be decoupled from implementation, allowing Favorites to generically dispatch actions.\n\t/**\n\t * Given a favorite item, trigger the associated action on that item.\n\t * I.e. If it's a finsemble component, a new window of that component is launched. If it's a workspace, the workspace would be switched to.\n\t * @param id The favorite item's id\n\t * @param category The to be triggered favorite item's category\n\t */\n\tconst triggerFavorite = async (id: Favorite[\"id\"], category: Favorite[\"category\"]) => {\n\t\tif (category === \"Application\") {\n\t\t\tFSBL.Clients.LauncherClient.spawn(id, {\n\t\t\t\taddToWorkspace: true,\n\t\t\t\tmonitor: \"mine\",\n\t\t\t});\n\t\t} else if (category === \"Workspace\") {\n\t\t\tFSBL.Clients.DistributedStoreClient.getStore(\n\t\t\t\t{ store: \"Finsemble-WorkspaceMenu-Global-Store\", global: true },\n\t\t\t\t(err: StandardError, store?: any) => {\n\t\t\t\t\tstore.Dispatcher.dispatch({\n\t\t\t\t\t\tactionType: \"switchToWorkspace\",\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\tname: id,\n\t\t\t\t\t\t},\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t);\n\t\t}\n\t};\n\n\t/**\n\t * We need to persist the right order in whent he user reorders favorites in the toolbar. This ensures\n\t * that favorites will appear in the right order on future Toolbar launches.\n\t * @param favElements The ordered collection of favorite elements\n\t */\n\tconst setFavoritesOrder = ({ oldIndex, newIndex }: { oldIndex: number; newIndex: number }) => {\n\t\tdispatch(FavoriteActions.REORDER_FAVORITES({ oldIndex, newIndex }));\n\t};\n\n\t/**\n\t * This effect initializes the favorites redux store. The store must only be initialized once, even though useFavorites may be\n\t * referenced by many different React components. We use the module level variable `storageIsInitialized` as a simple flag to\n\t * prevent initialization from occuring more than once.\n\t */\n\tuseEffect(() => {\n\t\tif (storageIsInitialized) return;\n\t\tstorageIsInitialized = true;\n\t\t// Copy the persisted favorites from Storage to the redux store\n\t\tFSBL.Clients.StorageClient.get({ topic: \"favorites\", key: \"allCurrentFavorites\" }, (err, data) => {\n\t\t\tif (err) {\n\t\t\t\treturn FSBL.Clients.Logger.system.error(\n\t\t\t\t\t`Favorite Hook -> Failed to retrieve favorites from StorageClient: ${err}`\n\t\t\t\t);\n\t\t\t}\n\t\t\tdispatch(FavoriteActions.INITIALIZE_FAVORITES(data));\n\t\t});\n\t}, [dispatch]);\n\n\t// When the list of favorite items change, we want to persist that data to the store.\n\tuseEffect(() => {\n\t\tFSBL.Clients.StorageClient.save({\n\t\t\ttopic: \"favorites\",\n\t\t\tkey: \"allCurrentFavorites\",\n\t\t\tvalue: favorites,\n\t\t});\n\t}, [favorites]);\n\n\treturn {\n\t\tfavorites,\n\t\tremoveFavorite,\n\t\ttriggerFavorite,\n\t\tsetFavoritesOrder,\n\t};\n};\n"]}

package/react/hooks/useHotkey.d.ts

@@ -0,0 +1,8 @@
+import { HotkeyCombination } from "../types/hotkeyTypes";
+/**
+ * This hook can be used to register a global hotkey. It makes use of Finsemble's HotkeyClient API.
+ *
+ * @param keyCombination [Array<string>] - A hotkey Combination. If null or undefined then no operation will occur.
+ * @param action Function - The function to call when the hotkey combination is pressed.
+ */
+export declare const useHotkey: (keyCombination: HotkeyCombination | undefined | null, action: Function) => void;