@deephaven/dashboard 0.43.0 → 0.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/dist/Dashboard.css +5 -0
  2. package/dist/Dashboard.css.map +1 -0
  3. package/dist/Dashboard.js +93 -0
  4. package/dist/Dashboard.js.map +1 -0
  5. package/dist/DashboardConstants.js +3 -0
  6. package/dist/DashboardConstants.js.map +1 -0
  7. package/dist/DashboardLayout.js +181 -0
  8. package/dist/DashboardLayout.js.map +1 -0
  9. package/dist/DashboardPanelWrapper.js +10 -0
  10. package/dist/DashboardPanelWrapper.js.map +1 -0
  11. package/dist/DashboardPlugin.js +22 -0
  12. package/dist/DashboardPlugin.js.map +1 -0
  13. package/dist/DashboardUtils.js +62 -0
  14. package/dist/DashboardUtils.js.map +1 -0
  15. package/dist/PanelErrorBoundary.css +8 -0
  16. package/dist/PanelErrorBoundary.css.map +1 -0
  17. package/dist/PanelErrorBoundary.js +55 -0
  18. package/dist/PanelErrorBoundary.js.map +1 -0
  19. package/dist/PanelEvent.js +32 -0
  20. package/dist/PanelEvent.js.map +1 -0
  21. package/dist/PanelManager.js +255 -0
  22. package/dist/PanelManager.js.map +1 -0
  23. package/dist/PanelPlaceholder.css +15 -0
  24. package/dist/PanelPlaceholder.css.map +1 -0
  25. package/dist/PanelPlaceholder.js +18 -0
  26. package/dist/PanelPlaceholder.js.map +1 -0
  27. package/dist/declaration.d.js +2 -0
  28. package/dist/declaration.d.js.map +1 -0
  29. package/dist/index.js +15 -0
  30. package/dist/index.js.map +1 -0
  31. package/dist/layout/GLPropTypes.js +37 -0
  32. package/dist/layout/GLPropTypes.js.map +1 -0
  33. package/dist/layout/GoldenLayout.css +581 -0
  34. package/dist/layout/GoldenLayout.css.map +1 -0
  35. package/dist/layout/LayoutUtils.js +690 -0
  36. package/dist/layout/LayoutUtils.js.map +1 -0
  37. package/dist/layout/hooks.js +11 -0
  38. package/dist/layout/hooks.js.map +1 -0
  39. package/dist/layout/index.js +5 -0
  40. package/dist/layout/index.js.map +1 -0
  41. package/dist/layout/usePanelRegistration.js +23 -0
  42. package/dist/layout/usePanelRegistration.js.map +1 -0
  43. package/dist/redux/actionTypes.js +3 -0
  44. package/dist/redux/actionTypes.js.map +1 -0
  45. package/dist/redux/actions.js +27 -0
  46. package/dist/redux/actions.js.map +1 -0
  47. package/dist/redux/index.js +10 -0
  48. package/dist/redux/index.js.map +1 -0
  49. package/dist/redux/reducers/dashboardData.js +7 -0
  50. package/dist/redux/reducers/dashboardData.js.map +1 -0
  51. package/dist/redux/reducers/index.js +5 -0
  52. package/dist/redux/reducers/index.js.map +1 -0
  53. package/dist/redux/selectors.js +40 -0
  54. package/dist/redux/selectors.js.map +1 -0
  55. package/package.json +10 -10
@@ -0,0 +1,5 @@
1
+ .dashboard-container {
2
+ position: relative;
3
+ }
4
+
5
+ /*# sourceMappingURL=Dashboard.css.map */
@@ -0,0 +1 @@
1
+ {"version":3,"sourceRoot":"","sources":["../src/Dashboard.scss"],"names":[],"mappings":"AAAA;EACE","file":"Dashboard.css","sourcesContent":[".dashboard-container {\n position: relative;\n}\n"]}
@@ -0,0 +1,93 @@
1
+ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
2
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
3
+ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
4
+ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
5
+ function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
6
+ import React, { useEffect, useMemo, useRef, useState } from 'react';
7
+ import throttle from 'lodash.throttle';
8
+ import GoldenLayout from '@deephaven/golden-layout';
9
+ import "./layout/GoldenLayout.css";
10
+ import LayoutUtils from "./layout/LayoutUtils.js";
11
+ import PanelPlaceholder from "./PanelPlaceholder.js";
12
+ import DashboardLayout from "./DashboardLayout.js";
13
+ import "./Dashboard.css";
14
+ var RESIZE_THROTTLE = 100;
15
+ var DEFAULT_CALLBACK = () => undefined;
16
+ var EMPTY_OBJECT = Object.freeze({});
17
+ export function Dashboard(_ref) {
18
+ var {
19
+ id = 'default',
20
+ children,
21
+ emptyDashboard,
22
+ layoutConfig,
23
+ layoutSettings = EMPTY_OBJECT,
24
+ onLayoutConfigChange = DEFAULT_CALLBACK,
25
+ onGoldenLayoutChange = DEFAULT_CALLBACK,
26
+ onLayoutInitialized = DEFAULT_CALLBACK,
27
+ fallbackComponent = PanelPlaceholder,
28
+ hydrate,
29
+ dehydrate,
30
+ panelWrapper
31
+ } = _ref;
32
+ var layoutElement = useRef(null);
33
+ var [isInitialized, setIsInitialized] = useState(false);
34
+ var [layout, setLayout] = useState();
35
+ useEffect(function initDashboard() {
36
+ if (!layoutElement.current) {
37
+ setLayout(undefined);
38
+ return;
39
+ }
40
+ var config = _objectSpread({}, LayoutUtils.makeDefaultLayout());
41
+ if (config.settings === undefined) {
42
+ config.settings = {};
43
+ }
44
+ Object.assign(config.settings, layoutSettings);
45
+
46
+ // Load our content later after plugins have registered
47
+ config.content = [];
48
+ var newLayout = new GoldenLayout(config, layoutElement.current);
49
+ var onInit = () => {
50
+ newLayout.off('initialised', onInit);
51
+ setIsInitialized(true);
52
+ };
53
+ newLayout.on('initialised', onInit);
54
+ if (fallbackComponent != null) {
55
+ newLayout.setFallbackComponent(fallbackComponent);
56
+ }
57
+ newLayout.init();
58
+ setLayout(newLayout);
59
+ onGoldenLayoutChange(newLayout);
60
+ return () => {
61
+ newLayout.destroy();
62
+ };
63
+ }, [layoutSettings, fallbackComponent, onGoldenLayoutChange, setIsInitialized, setLayout]);
64
+ var handleResize = useMemo(() => throttle(() => {
65
+ if (layout != null && layout.isInitialised) {
66
+ layout === null || layout === void 0 ? void 0 : layout.updateSize();
67
+ }
68
+ }, RESIZE_THROTTLE), [layout]);
69
+ useEffect(function initResizeEventListner() {
70
+ window.addEventListener('resize', handleResize);
71
+ return () => {
72
+ window.removeEventListener('resize', handleResize);
73
+ };
74
+ }, [handleResize]);
75
+ return /*#__PURE__*/React.createElement("div", {
76
+ className: "dashboard-container w-100 h-100"
77
+ }, /*#__PURE__*/React.createElement("div", {
78
+ className: "w-100 h-100",
79
+ ref: layoutElement
80
+ }), isInitialized && layout && /*#__PURE__*/React.createElement(DashboardLayout, {
81
+ emptyDashboard: emptyDashboard,
82
+ id: id,
83
+ layout: layout,
84
+ layoutConfig: layoutConfig,
85
+ onLayoutChange: onLayoutConfigChange,
86
+ onLayoutInitialized: onLayoutInitialized,
87
+ hydrate: hydrate,
88
+ dehydrate: dehydrate,
89
+ panelWrapper: panelWrapper
90
+ }, children));
91
+ }
92
+ export default Dashboard;
93
+ //# sourceMappingURL=Dashboard.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Dashboard.js","names":["React","useEffect","useMemo","useRef","useState","throttle","GoldenLayout","LayoutUtils","PanelPlaceholder","DashboardLayout","RESIZE_THROTTLE","DEFAULT_CALLBACK","undefined","EMPTY_OBJECT","Object","freeze","Dashboard","id","children","emptyDashboard","layoutConfig","layoutSettings","onLayoutConfigChange","onGoldenLayoutChange","onLayoutInitialized","fallbackComponent","hydrate","dehydrate","panelWrapper","layoutElement","isInitialized","setIsInitialized","layout","setLayout","initDashboard","current","config","makeDefaultLayout","settings","assign","content","newLayout","onInit","off","on","setFallbackComponent","init","destroy","handleResize","isInitialised","updateSize","initResizeEventListner","window","addEventListener","removeEventListener"],"sources":["../src/Dashboard.tsx"],"sourcesContent":["import React, {\n ComponentType,\n ForwardRefExoticComponent,\n RefAttributes,\n useEffect,\n useMemo,\n useRef,\n useState,\n} from 'react';\nimport throttle from 'lodash.throttle';\nimport GoldenLayout from '@deephaven/golden-layout';\nimport type { ItemConfigType } from '@deephaven/golden-layout';\nimport './layout/GoldenLayout.scss';\nimport LayoutUtils from './layout/LayoutUtils';\nimport PanelPlaceholder from './PanelPlaceholder';\nimport DashboardLayout from './DashboardLayout';\nimport {\n PanelDehydrateFunction,\n PanelHydrateFunction,\n PanelProps,\n} from './DashboardPlugin';\nimport './Dashboard.scss';\n\nconst RESIZE_THROTTLE = 100;\n\nconst DEFAULT_CALLBACK = () => undefined;\n\nconst EMPTY_OBJECT = Object.freeze({});\n\nexport type DashboardProps = {\n id?: string;\n children?: React.ReactNode | React.ReactNode[];\n emptyDashboard?: React.ReactNode;\n layoutConfig?: ItemConfigType[];\n layoutSettings?: Record<string, unknown>;\n onLayoutConfigChange?: () => void;\n onGoldenLayoutChange?: (goldenLayout: GoldenLayout) => void;\n onLayoutInitialized?: () => void;\n fallbackComponent?: ForwardRefExoticComponent<\n PanelProps & RefAttributes<HTMLDivElement>\n >;\n hydrate?: PanelHydrateFunction;\n dehydrate?: PanelDehydrateFunction;\n\n /** Component to wrap each panel with */\n panelWrapper?: ComponentType;\n};\n\nexport function Dashboard({\n id = 'default',\n children,\n emptyDashboard,\n layoutConfig,\n layoutSettings = EMPTY_OBJECT,\n onLayoutConfigChange = DEFAULT_CALLBACK,\n onGoldenLayoutChange = DEFAULT_CALLBACK,\n onLayoutInitialized = DEFAULT_CALLBACK,\n fallbackComponent = PanelPlaceholder,\n hydrate,\n dehydrate,\n panelWrapper,\n}: DashboardProps): JSX.Element {\n const layoutElement = useRef<HTMLDivElement>(null);\n const [isInitialized, setIsInitialized] = useState(false);\n const [layout, setLayout] = useState<GoldenLayout>();\n\n useEffect(\n function initDashboard() {\n if (!layoutElement.current) {\n setLayout(undefined);\n return;\n }\n const config = {\n ...LayoutUtils.makeDefaultLayout(),\n };\n if (config.settings === undefined) {\n config.settings = {};\n }\n Object.assign(config.settings, layoutSettings);\n\n // Load our content later after plugins have registered\n config.content = [];\n\n const newLayout = new GoldenLayout(config, layoutElement.current);\n\n const onInit = () => {\n newLayout.off('initialised', onInit);\n setIsInitialized(true);\n };\n newLayout.on('initialised', onInit);\n\n if (fallbackComponent != null) {\n newLayout.setFallbackComponent(fallbackComponent);\n }\n\n newLayout.init();\n\n setLayout(newLayout);\n\n onGoldenLayoutChange(newLayout);\n\n return () => {\n newLayout.destroy();\n };\n },\n [\n layoutSettings,\n fallbackComponent,\n onGoldenLayoutChange,\n setIsInitialized,\n setLayout,\n ]\n );\n\n const handleResize = useMemo(\n () =>\n throttle(() => {\n if (layout != null && layout.isInitialised) {\n layout?.updateSize();\n }\n }, RESIZE_THROTTLE),\n [layout]\n );\n\n useEffect(\n function initResizeEventListner() {\n window.addEventListener('resize', handleResize);\n return () => {\n window.removeEventListener('resize', handleResize);\n };\n },\n [handleResize]\n );\n\n return (\n <div className=\"dashboard-container w-100 h-100\">\n <div className=\"w-100 h-100\" ref={layoutElement} />\n {isInitialized && layout && (\n <DashboardLayout\n emptyDashboard={emptyDashboard}\n id={id}\n layout={layout}\n layoutConfig={layoutConfig}\n onLayoutChange={onLayoutConfigChange}\n onLayoutInitialized={onLayoutInitialized}\n hydrate={hydrate}\n dehydrate={dehydrate}\n panelWrapper={panelWrapper}\n >\n {children}\n </DashboardLayout>\n )}\n </div>\n );\n}\n\nexport default Dashboard;\n"],"mappings":";;;;;AAAA,OAAOA,KAAK,IAIVC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QACH,OAAO;AACd,OAAOC,QAAQ,MAAM,iBAAiB;AACtC,OAAOC,YAAY,MAAM,0BAA0B;AAAC;AAAA,OAG7CC,WAAW;AAAA,OACXC,gBAAgB;AAAA,OAChBC,eAAe;AAAA;AAQtB,IAAMC,eAAe,GAAG,GAAG;AAE3B,IAAMC,gBAAgB,GAAG,MAAMC,SAAS;AAExC,IAAMC,YAAY,GAAGC,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,CAAC;AAqBtC,OAAO,SAASC,SAAS,OAaO;EAAA,IAbN;IACxBC,EAAE,GAAG,SAAS;IACdC,QAAQ;IACRC,cAAc;IACdC,YAAY;IACZC,cAAc,GAAGR,YAAY;IAC7BS,oBAAoB,GAAGX,gBAAgB;IACvCY,oBAAoB,GAAGZ,gBAAgB;IACvCa,mBAAmB,GAAGb,gBAAgB;IACtCc,iBAAiB,GAAGjB,gBAAgB;IACpCkB,OAAO;IACPC,SAAS;IACTC;EACc,CAAC;EACf,IAAMC,aAAa,GAAG1B,MAAM,CAAiB,IAAI,CAAC;EAClD,IAAM,CAAC2B,aAAa,EAAEC,gBAAgB,CAAC,GAAG3B,QAAQ,CAAC,KAAK,CAAC;EACzD,IAAM,CAAC4B,MAAM,EAAEC,SAAS,CAAC,GAAG7B,QAAQ,EAAgB;EAEpDH,SAAS,CACP,SAASiC,aAAa,GAAG;IACvB,IAAI,CAACL,aAAa,CAACM,OAAO,EAAE;MAC1BF,SAAS,CAACrB,SAAS,CAAC;MACpB;IACF;IACA,IAAMwB,MAAM,qBACP7B,WAAW,CAAC8B,iBAAiB,EAAE,CACnC;IACD,IAAID,MAAM,CAACE,QAAQ,KAAK1B,SAAS,EAAE;MACjCwB,MAAM,CAACE,QAAQ,GAAG,CAAC,CAAC;IACtB;IACAxB,MAAM,CAACyB,MAAM,CAACH,MAAM,CAACE,QAAQ,EAAEjB,cAAc,CAAC;;IAE9C;IACAe,MAAM,CAACI,OAAO,GAAG,EAAE;IAEnB,IAAMC,SAAS,GAAG,IAAInC,YAAY,CAAC8B,MAAM,EAAEP,aAAa,CAACM,OAAO,CAAC;IAEjE,IAAMO,MAAM,GAAG,MAAM;MACnBD,SAAS,CAACE,GAAG,CAAC,aAAa,EAAED,MAAM,CAAC;MACpCX,gBAAgB,CAAC,IAAI,CAAC;IACxB,CAAC;IACDU,SAAS,CAACG,EAAE,CAAC,aAAa,EAAEF,MAAM,CAAC;IAEnC,IAAIjB,iBAAiB,IAAI,IAAI,EAAE;MAC7BgB,SAAS,CAACI,oBAAoB,CAACpB,iBAAiB,CAAC;IACnD;IAEAgB,SAAS,CAACK,IAAI,EAAE;IAEhBb,SAAS,CAACQ,SAAS,CAAC;IAEpBlB,oBAAoB,CAACkB,SAAS,CAAC;IAE/B,OAAO,MAAM;MACXA,SAAS,CAACM,OAAO,EAAE;IACrB,CAAC;EACH,CAAC,EACD,CACE1B,cAAc,EACdI,iBAAiB,EACjBF,oBAAoB,EACpBQ,gBAAgB,EAChBE,SAAS,CACV,CACF;EAED,IAAMe,YAAY,GAAG9C,OAAO,CAC1B,MACEG,QAAQ,CAAC,MAAM;IACb,IAAI2B,MAAM,IAAI,IAAI,IAAIA,MAAM,CAACiB,aAAa,EAAE;MAC1CjB,MAAM,aAANA,MAAM,uBAANA,MAAM,CAAEkB,UAAU,EAAE;IACtB;EACF,CAAC,EAAExC,eAAe,CAAC,EACrB,CAACsB,MAAM,CAAC,CACT;EAED/B,SAAS,CACP,SAASkD,sBAAsB,GAAG;IAChCC,MAAM,CAACC,gBAAgB,CAAC,QAAQ,EAAEL,YAAY,CAAC;IAC/C,OAAO,MAAM;MACXI,MAAM,CAACE,mBAAmB,CAAC,QAAQ,EAAEN,YAAY,CAAC;IACpD,CAAC;EACH,CAAC,EACD,CAACA,YAAY,CAAC,CACf;EAED,oBACE;IAAK,SAAS,EAAC;EAAiC,gBAC9C;IAAK,SAAS,EAAC,aAAa;IAAC,GAAG,EAAEnB;EAAc,EAAG,EAClDC,aAAa,IAAIE,MAAM,iBACtB,oBAAC,eAAe;IACd,cAAc,EAAEb,cAAe;IAC/B,EAAE,EAAEF,EAAG;IACP,MAAM,EAAEe,MAAO;IACf,YAAY,EAAEZ,YAAa;IAC3B,cAAc,EAAEE,oBAAqB;IACrC,mBAAmB,EAAEE,mBAAoB;IACzC,OAAO,EAAEE,OAAQ;IACjB,SAAS,EAAEC,SAAU;IACrB,YAAY,EAAEC;EAAa,GAE1BV,QAAQ,CAEZ,CACG;AAEV;AAEA,eAAeF,SAAS"}
@@ -0,0 +1,3 @@
1
+ // eslint-disable-next-line import/prefer-default-export
2
+ export var DEFAULT_DASHBOARD_ID = 'default';
3
+ //# sourceMappingURL=DashboardConstants.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DashboardConstants.js","names":["DEFAULT_DASHBOARD_ID"],"sources":["../src/DashboardConstants.ts"],"sourcesContent":["// eslint-disable-next-line import/prefer-default-export\nexport const DEFAULT_DASHBOARD_ID = 'default';\n"],"mappings":"AAAA;AACA,OAAO,IAAMA,oBAAoB,GAAG,SAAS"}
@@ -0,0 +1,181 @@
1
+ function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
2
+ import React, { useCallback, useEffect, useMemo, useState } from 'react';
3
+ import PropTypes from 'prop-types';
4
+ import Log from '@deephaven/log';
5
+ import { usePrevious } from '@deephaven/react-hooks';
6
+ import { useDispatch, useSelector } from 'react-redux';
7
+ import PanelManager from "./PanelManager.js";
8
+ import PanelErrorBoundary from "./PanelErrorBoundary.js";
9
+ import LayoutUtils from "./layout/LayoutUtils.js";
10
+ import { dehydrate as dehydrateDefault, hydrate as hydrateDefault } from "./DashboardUtils.js";
11
+ import PanelEvent from "./PanelEvent.js";
12
+ import { GLPropTypes, useListener } from "./layout/index.js";
13
+ import { getDashboardData, updateDashboardData } from "./redux/index.js";
14
+ import DashboardPanelWrapper from "./DashboardPanelWrapper.js";
15
+ var log = Log.module('DashboardLayout');
16
+ var EMPTY_OBJECT = Object.freeze({});
17
+ var DEFAULT_LAYOUT_CONFIG = [];
18
+ var DEFAULT_CALLBACK = () => undefined;
19
+
20
+ // If a component isn't registered, just pass through the props so they are saved if a plugin is loaded later
21
+ var FALLBACK_CALLBACK = props => props;
22
+ /**
23
+ * DashboardLayout component. Handles hydrating, dehydrating components, listening for dragging panels.
24
+ */
25
+ export function DashboardLayout(_ref) {
26
+ var _useSelector, _closed;
27
+ var {
28
+ id,
29
+ children,
30
+ emptyDashboard = /*#__PURE__*/React.createElement("div", null, "Dashboard is empty."),
31
+ layout,
32
+ layoutConfig = DEFAULT_LAYOUT_CONFIG,
33
+ onLayoutChange = DEFAULT_CALLBACK,
34
+ onLayoutInitialized = DEFAULT_CALLBACK,
35
+ hydrate = hydrateDefault,
36
+ dehydrate = dehydrateDefault,
37
+ panelWrapper = DashboardPanelWrapper
38
+ } = _ref;
39
+ var dispatch = useDispatch();
40
+ var data = (_useSelector = useSelector(state => getDashboardData(state, id))) !== null && _useSelector !== void 0 ? _useSelector : EMPTY_OBJECT;
41
+ var [isDashboardEmpty, setIsDashboardEmpty] = useState(false);
42
+ var [isItemDragging, setIsItemDragging] = useState(false);
43
+ var [lastConfig, setLastConfig] = useState();
44
+ var [initialClosedPanels] = useState((_closed = data === null || data === void 0 ? void 0 : data.closed) !== null && _closed !== void 0 ? _closed : []);
45
+ var [isDashboardInitialized, setIsDashboardInitialized] = useState(false);
46
+ var [layoutChildren, setLayoutChildren] = useState(layout.getReactChildren());
47
+ var hydrateMap = useMemo(() => new Map(), []);
48
+ var dehydrateMap = useMemo(() => new Map(), []);
49
+ var registerComponent = useCallback(function (name, componentType) {
50
+ var componentHydrate = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : hydrate;
51
+ var componentDehydrate = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : dehydrate;
52
+ log.debug2('registerComponent', name, componentType, componentHydrate, componentDehydrate);
53
+ function renderComponent(props, ref) {
54
+ // Cast it to an `any` type so we can pass the ref in correctly.
55
+ // ComponentType doesn't seem to work right, ReactNode is also incorrect
56
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
57
+ var CType = componentType;
58
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
59
+ var PanelWrapperType = panelWrapper;
60
+
61
+ // Props supplied by GoldenLayout
62
+ // eslint-disable-next-line react/prop-types
63
+ var {
64
+ glContainer,
65
+ glEventHub
66
+ } = props;
67
+ return /*#__PURE__*/React.createElement(PanelErrorBoundary, {
68
+ glContainer: glContainer,
69
+ glEventHub: glEventHub
70
+ }, /*#__PURE__*/React.createElement(PanelWrapperType, props, /*#__PURE__*/React.createElement(CType, _extends({}, props, {
71
+ ref: ref
72
+ }))));
73
+ }
74
+ var wrappedComponent = /*#__PURE__*/React.forwardRef(renderComponent);
75
+ var cleanup = layout.registerComponent(name, wrappedComponent);
76
+ hydrateMap.set(name, componentHydrate);
77
+ dehydrateMap.set(name, componentDehydrate);
78
+ return cleanup;
79
+ }, [hydrate, dehydrate, hydrateMap, dehydrateMap, layout, panelWrapper]);
80
+ var hydrateComponent = useCallback((name, props) => {
81
+ var _hydrateMap$get;
82
+ return ((_hydrateMap$get = hydrateMap.get(name)) !== null && _hydrateMap$get !== void 0 ? _hydrateMap$get : FALLBACK_CALLBACK)(props, id);
83
+ }, [hydrateMap, id]);
84
+ var dehydrateComponent = useCallback((name, config) => {
85
+ var _dehydrateMap$get;
86
+ return ((_dehydrateMap$get = dehydrateMap.get(name)) !== null && _dehydrateMap$get !== void 0 ? _dehydrateMap$get : FALLBACK_CALLBACK)(config, id);
87
+ }, [dehydrateMap, id]);
88
+ var panelManager = useMemo(() => new PanelManager(layout, hydrateComponent, dehydrateComponent, new Map(), initialClosedPanels, _ref2 => {
89
+ var {
90
+ closed,
91
+ openedMap
92
+ } = _ref2;
93
+ dispatch(updateDashboardData(id, {
94
+ closed,
95
+ openedMap
96
+ }));
97
+ }), [dehydrateComponent, dispatch, hydrateComponent, id, initialClosedPanels, layout]);
98
+ var handleLayoutStateChanged = useCallback(() => {
99
+ // we don't want to emit stateChanges that happen during item drags or else
100
+ // we risk the last saved state being one without that panel in the layout entirely
101
+ if (isItemDragging) return;
102
+ if (!isDashboardInitialized) {
103
+ onLayoutInitialized();
104
+ setIsDashboardInitialized(true);
105
+ }
106
+ var glConfig = layout.toConfig();
107
+ var contentConfig = glConfig.content;
108
+ var dehydratedLayoutConfig = LayoutUtils.dehydrateLayoutConfig(contentConfig, dehydrateComponent);
109
+ var hasChanged = lastConfig == null || !LayoutUtils.isEqual(lastConfig, dehydratedLayoutConfig);
110
+ log.debug('handleLayoutStateChanged', hasChanged, contentConfig, dehydratedLayoutConfig);
111
+ if (hasChanged) {
112
+ setIsDashboardEmpty(layout.root.contentItems.length === 0);
113
+ setLastConfig(dehydratedLayoutConfig);
114
+ onLayoutChange(dehydratedLayoutConfig);
115
+ setLayoutChildren(layout.getReactChildren());
116
+ }
117
+ }, [dehydrateComponent, isDashboardInitialized, isItemDragging, lastConfig, layout, onLayoutChange, onLayoutInitialized]);
118
+ var handleLayoutItemPickedUp = useCallback(component => {
119
+ var componentId = LayoutUtils.getIdFromContainer(component);
120
+ layout.eventHub.emit(PanelEvent.DRAGGING, componentId);
121
+ setIsItemDragging(true);
122
+ }, [layout.eventHub]);
123
+ var handleLayoutItemDropped = useCallback(component => {
124
+ var componentId = LayoutUtils.getIdFromContainer(component);
125
+ layout.eventHub.emit(PanelEvent.DROPPED, componentId);
126
+ setIsItemDragging(false);
127
+ }, [layout.eventHub]);
128
+ var handleComponentCreated = useCallback(item => {
129
+ log.debug2('handleComponentCreated', item);
130
+ if (item == null || item.config == null || item.config.component == null || item.element == null) {
131
+ return;
132
+ }
133
+ var cssComponent = item.config.component.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
134
+ var cssClass = "".concat(cssComponent, "-component");
135
+ item.element.addClass(cssClass);
136
+ }, []);
137
+ var handleReactChildrenChange = useCallback(() => {
138
+ setLayoutChildren(layout.getReactChildren());
139
+ }, [layout]);
140
+ useListener(layout, 'stateChanged', handleLayoutStateChanged);
141
+ useListener(layout, 'itemPickedUp', handleLayoutItemPickedUp);
142
+ useListener(layout, 'itemDropped', handleLayoutItemDropped);
143
+ useListener(layout, 'componentCreated', handleComponentCreated);
144
+ useListener(layout.eventHub, PanelEvent.TITLE_CHANGED, handleLayoutStateChanged);
145
+ useListener(layout, 'reactChildrenChanged', handleReactChildrenChange);
146
+ var previousLayoutConfig = usePrevious(layoutConfig);
147
+ useEffect(function loadNewConfig() {
148
+ if (previousLayoutConfig !== layoutConfig && layoutConfig !== lastConfig) {
149
+ log.debug('Setting new layout content...');
150
+ var content = LayoutUtils.hydrateLayoutConfig(layoutConfig, hydrateComponent);
151
+ // Remove the old layout before add the new one
152
+ while (layout.root.contentItems.length > 0) {
153
+ layout.root.contentItems[0].remove();
154
+ }
155
+
156
+ // Add the new content. It is usally just one item from the root
157
+ for (var i = 0; i < content.length; i += 1) {
158
+ layout.root.addChild(content[i]);
159
+ }
160
+ setIsDashboardEmpty(layout.root.contentItems.length === 0);
161
+ }
162
+ }, [hydrateComponent, layout, layoutConfig, lastConfig, panelManager, previousLayoutConfig]);
163
+ return /*#__PURE__*/React.createElement(React.Fragment, null, isDashboardEmpty && emptyDashboard, layoutChildren, React.Children.map(children, child => child != null ? /*#__PURE__*/React.cloneElement(child, {
164
+ id,
165
+ layout,
166
+ panelManager,
167
+ registerComponent
168
+ }) : null));
169
+ }
170
+ DashboardLayout.propTypes = {
171
+ id: PropTypes.string.isRequired,
172
+ children: PropTypes.node,
173
+ data: PropTypes.shape({}),
174
+ emptyDashboard: PropTypes.node,
175
+ layout: GLPropTypes.Layout.isRequired,
176
+ layoutConfig: PropTypes.arrayOf(PropTypes.shape({})),
177
+ onLayoutChange: PropTypes.func,
178
+ onLayoutInitialized: PropTypes.func
179
+ };
180
+ export default DashboardLayout;
181
+ //# sourceMappingURL=DashboardLayout.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DashboardLayout.js","names":["React","useCallback","useEffect","useMemo","useState","PropTypes","Log","usePrevious","useDispatch","useSelector","PanelManager","PanelErrorBoundary","LayoutUtils","dehydrate","dehydrateDefault","hydrate","hydrateDefault","PanelEvent","GLPropTypes","useListener","getDashboardData","updateDashboardData","DashboardPanelWrapper","log","module","EMPTY_OBJECT","Object","freeze","DEFAULT_LAYOUT_CONFIG","DEFAULT_CALLBACK","undefined","FALLBACK_CALLBACK","props","DashboardLayout","id","children","emptyDashboard","layout","layoutConfig","onLayoutChange","onLayoutInitialized","panelWrapper","dispatch","data","state","isDashboardEmpty","setIsDashboardEmpty","isItemDragging","setIsItemDragging","lastConfig","setLastConfig","initialClosedPanels","closed","isDashboardInitialized","setIsDashboardInitialized","layoutChildren","setLayoutChildren","getReactChildren","hydrateMap","Map","dehydrateMap","registerComponent","name","componentType","componentHydrate","componentDehydrate","debug2","renderComponent","ref","CType","PanelWrapperType","glContainer","glEventHub","wrappedComponent","forwardRef","cleanup","set","hydrateComponent","get","dehydrateComponent","config","panelManager","openedMap","handleLayoutStateChanged","glConfig","toConfig","contentConfig","content","dehydratedLayoutConfig","dehydrateLayoutConfig","hasChanged","isEqual","debug","root","contentItems","length","handleLayoutItemPickedUp","component","componentId","getIdFromContainer","eventHub","emit","DRAGGING","handleLayoutItemDropped","DROPPED","handleComponentCreated","item","element","cssComponent","replace","toLowerCase","cssClass","addClass","handleReactChildrenChange","TITLE_CHANGED","previousLayoutConfig","loadNewConfig","hydrateLayoutConfig","remove","i","addChild","Children","map","child","cloneElement","propTypes","string","isRequired","node","shape","Layout","arrayOf","func"],"sources":["../src/DashboardLayout.tsx"],"sourcesContent":["import React, {\n ComponentType,\n ReactElement,\n useCallback,\n useEffect,\n useMemo,\n useState,\n} from 'react';\nimport PropTypes from 'prop-types';\nimport GoldenLayout from '@deephaven/golden-layout';\nimport type {\n Container,\n ItemConfigType,\n ReactComponentConfig,\n} from '@deephaven/golden-layout';\nimport Log from '@deephaven/log';\nimport { usePrevious } from '@deephaven/react-hooks';\nimport { RootState } from '@deephaven/redux';\nimport { useDispatch, useSelector } from 'react-redux';\nimport PanelManager, { ClosedPanels } from './PanelManager';\nimport PanelErrorBoundary from './PanelErrorBoundary';\nimport LayoutUtils from './layout/LayoutUtils';\nimport {\n dehydrate as dehydrateDefault,\n hydrate as hydrateDefault,\n} from './DashboardUtils';\nimport PanelEvent from './PanelEvent';\nimport { GLPropTypes, useListener } from './layout';\nimport { getDashboardData, updateDashboardData } from './redux';\nimport {\n PanelComponentType,\n PanelDehydrateFunction,\n PanelHydrateFunction,\n PanelProps,\n} from './DashboardPlugin';\nimport DashboardPanelWrapper from './DashboardPanelWrapper';\n\nexport type DashboardLayoutConfig = ItemConfigType[];\n\nconst log = Log.module('DashboardLayout');\n\nconst EMPTY_OBJECT = Object.freeze({});\n\nconst DEFAULT_LAYOUT_CONFIG: DashboardLayoutConfig = [];\n\nconst DEFAULT_CALLBACK = () => undefined;\n\n// If a component isn't registered, just pass through the props so they are saved if a plugin is loaded later\nconst FALLBACK_CALLBACK = (props: unknown) => props;\n\ntype DashboardData = {\n closed?: ClosedPanels;\n};\n\ninterface DashboardLayoutProps {\n id: string;\n\n // Default hydrate/dehydration functions\n hydrate?: PanelHydrateFunction;\n dehydrate?: PanelDehydrateFunction;\n layout: GoldenLayout;\n layoutConfig?: DashboardLayoutConfig;\n onLayoutChange?: (dehydratedLayout: DashboardLayoutConfig) => void;\n onLayoutInitialized?: () => void;\n data?: DashboardData;\n children?: React.ReactNode | React.ReactNode[];\n emptyDashboard?: React.ReactNode;\n\n /** Component to wrap each panel with */\n panelWrapper?: ComponentType;\n}\n\n/**\n * DashboardLayout component. Handles hydrating, dehydrating components, listening for dragging panels.\n */\nexport function DashboardLayout({\n id,\n children,\n emptyDashboard = <div>Dashboard is empty.</div>,\n layout,\n layoutConfig = DEFAULT_LAYOUT_CONFIG,\n onLayoutChange = DEFAULT_CALLBACK,\n onLayoutInitialized = DEFAULT_CALLBACK,\n hydrate = hydrateDefault,\n dehydrate = dehydrateDefault,\n panelWrapper = DashboardPanelWrapper,\n}: DashboardLayoutProps): JSX.Element {\n const dispatch = useDispatch();\n const data =\n useSelector<RootState>(state => getDashboardData(state, id)) ??\n EMPTY_OBJECT;\n\n const [isDashboardEmpty, setIsDashboardEmpty] = useState(false);\n const [isItemDragging, setIsItemDragging] = useState(false);\n const [lastConfig, setLastConfig] = useState<DashboardLayoutConfig>();\n const [initialClosedPanels] = useState<ReactComponentConfig[] | undefined>(\n (data as DashboardData)?.closed ?? []\n );\n const [isDashboardInitialized, setIsDashboardInitialized] = useState(false);\n const [layoutChildren, setLayoutChildren] = useState(\n layout.getReactChildren()\n );\n\n const hydrateMap = useMemo(() => new Map(), []);\n const dehydrateMap = useMemo(() => new Map(), []);\n const registerComponent = useCallback(\n (\n name: string,\n componentType: PanelComponentType,\n componentHydrate = hydrate,\n componentDehydrate = dehydrate\n ) => {\n log.debug2(\n 'registerComponent',\n name,\n componentType,\n componentHydrate,\n componentDehydrate\n );\n\n function renderComponent(props: PanelProps, ref: unknown) {\n // Cast it to an `any` type so we can pass the ref in correctly.\n // ComponentType doesn't seem to work right, ReactNode is also incorrect\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const CType = componentType as any;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const PanelWrapperType = panelWrapper as any;\n\n // Props supplied by GoldenLayout\n // eslint-disable-next-line react/prop-types\n const { glContainer, glEventHub } = props;\n return (\n <PanelErrorBoundary glContainer={glContainer} glEventHub={glEventHub}>\n {/* eslint-disable-next-line react/jsx-props-no-spreading */}\n <PanelWrapperType {...props}>\n {/* eslint-disable-next-line react/jsx-props-no-spreading */}\n <CType {...props} ref={ref} />\n </PanelWrapperType>\n </PanelErrorBoundary>\n );\n }\n\n const wrappedComponent = React.forwardRef(renderComponent);\n const cleanup = layout.registerComponent(name, wrappedComponent);\n hydrateMap.set(name, componentHydrate);\n dehydrateMap.set(name, componentDehydrate);\n return cleanup;\n },\n [hydrate, dehydrate, hydrateMap, dehydrateMap, layout, panelWrapper]\n );\n const hydrateComponent = useCallback(\n (name, props) => (hydrateMap.get(name) ?? FALLBACK_CALLBACK)(props, id),\n [hydrateMap, id]\n );\n const dehydrateComponent = useCallback(\n (name, config) => (dehydrateMap.get(name) ?? FALLBACK_CALLBACK)(config, id),\n [dehydrateMap, id]\n );\n const panelManager = useMemo(\n () =>\n new PanelManager(\n layout,\n hydrateComponent,\n dehydrateComponent,\n new Map(),\n initialClosedPanels,\n ({ closed, openedMap }) => {\n dispatch(updateDashboardData(id, { closed, openedMap }));\n }\n ),\n [\n dehydrateComponent,\n dispatch,\n hydrateComponent,\n id,\n initialClosedPanels,\n layout,\n ]\n );\n\n const handleLayoutStateChanged = useCallback(() => {\n // we don't want to emit stateChanges that happen during item drags or else\n // we risk the last saved state being one without that panel in the layout entirely\n if (isItemDragging) return;\n\n if (!isDashboardInitialized) {\n onLayoutInitialized();\n setIsDashboardInitialized(true);\n }\n\n const glConfig = layout.toConfig();\n const contentConfig = glConfig.content;\n const dehydratedLayoutConfig = LayoutUtils.dehydrateLayoutConfig(\n contentConfig,\n dehydrateComponent\n );\n const hasChanged =\n lastConfig == null ||\n !LayoutUtils.isEqual(lastConfig, dehydratedLayoutConfig);\n\n log.debug(\n 'handleLayoutStateChanged',\n hasChanged,\n contentConfig,\n dehydratedLayoutConfig\n );\n\n if (hasChanged) {\n setIsDashboardEmpty(layout.root.contentItems.length === 0);\n\n setLastConfig(dehydratedLayoutConfig);\n\n onLayoutChange(dehydratedLayoutConfig);\n\n setLayoutChildren(layout.getReactChildren());\n }\n }, [\n dehydrateComponent,\n isDashboardInitialized,\n isItemDragging,\n lastConfig,\n layout,\n onLayoutChange,\n onLayoutInitialized,\n ]);\n\n const handleLayoutItemPickedUp = useCallback(\n (component: Container) => {\n const componentId = LayoutUtils.getIdFromContainer(component);\n layout.eventHub.emit(PanelEvent.DRAGGING, componentId);\n setIsItemDragging(true);\n },\n [layout.eventHub]\n );\n\n const handleLayoutItemDropped = useCallback(\n (component: Container) => {\n const componentId = LayoutUtils.getIdFromContainer(component);\n layout.eventHub.emit(PanelEvent.DROPPED, componentId);\n setIsItemDragging(false);\n },\n [layout.eventHub]\n );\n\n const handleComponentCreated = useCallback(item => {\n log.debug2('handleComponentCreated', item);\n\n if (\n item == null ||\n item.config == null ||\n item.config.component == null ||\n item.element == null\n ) {\n return;\n }\n\n const cssComponent = item.config.component\n .replace(/([a-z])([A-Z])/g, '$1-$2')\n .toLowerCase();\n const cssClass = `${cssComponent}-component`;\n item.element.addClass(cssClass);\n }, []);\n\n const handleReactChildrenChange = useCallback(() => {\n setLayoutChildren(layout.getReactChildren());\n }, [layout]);\n\n useListener(layout, 'stateChanged', handleLayoutStateChanged);\n useListener(layout, 'itemPickedUp', handleLayoutItemPickedUp);\n useListener(layout, 'itemDropped', handleLayoutItemDropped);\n useListener(layout, 'componentCreated', handleComponentCreated);\n useListener(\n layout.eventHub,\n PanelEvent.TITLE_CHANGED,\n handleLayoutStateChanged\n );\n useListener(layout, 'reactChildrenChanged', handleReactChildrenChange);\n\n const previousLayoutConfig = usePrevious(layoutConfig);\n useEffect(\n function loadNewConfig() {\n if (\n previousLayoutConfig !== layoutConfig &&\n layoutConfig !== lastConfig\n ) {\n log.debug('Setting new layout content...');\n const content = LayoutUtils.hydrateLayoutConfig(\n layoutConfig,\n hydrateComponent\n );\n // Remove the old layout before add the new one\n while (layout.root.contentItems.length > 0) {\n layout.root.contentItems[0].remove();\n }\n\n // Add the new content. It is usally just one item from the root\n for (let i = 0; i < content.length; i += 1) {\n layout.root.addChild(content[i]);\n }\n\n setIsDashboardEmpty(layout.root.contentItems.length === 0);\n }\n },\n [\n hydrateComponent,\n layout,\n layoutConfig,\n lastConfig,\n panelManager,\n previousLayoutConfig,\n ]\n );\n\n return (\n <>\n {isDashboardEmpty && emptyDashboard}\n {layoutChildren}\n {React.Children.map(children, child =>\n child != null\n ? React.cloneElement(child as ReactElement, {\n id,\n layout,\n panelManager,\n registerComponent,\n })\n : null\n )}\n </>\n );\n}\n\nDashboardLayout.propTypes = {\n id: PropTypes.string.isRequired,\n children: PropTypes.node,\n data: PropTypes.shape({}),\n emptyDashboard: PropTypes.node,\n layout: GLPropTypes.Layout.isRequired,\n layoutConfig: PropTypes.arrayOf(PropTypes.shape({})),\n onLayoutChange: PropTypes.func,\n onLayoutInitialized: PropTypes.func,\n};\n\nexport default DashboardLayout;\n"],"mappings":";AAAA,OAAOA,KAAK,IAGVC,WAAW,EACXC,SAAS,EACTC,OAAO,EACPC,QAAQ,QACH,OAAO;AACd,OAAOC,SAAS,MAAM,YAAY;AAOlC,OAAOC,GAAG,MAAM,gBAAgB;AAChC,SAASC,WAAW,QAAQ,wBAAwB;AAEpD,SAASC,WAAW,EAAEC,WAAW,QAAQ,aAAa;AAAC,OAChDC,YAAY;AAAA,OACZC,kBAAkB;AAAA,OAClBC,WAAW;AAAA,SAEhBC,SAAS,IAAIC,gBAAgB,EAC7BC,OAAO,IAAIC,cAAc;AAAA,OAEpBC,UAAU;AAAA,SACRC,WAAW,EAAEC,WAAW;AAAA,SACxBC,gBAAgB,EAAEC,mBAAmB;AAAA,OAOvCC,qBAAqB;AAI5B,IAAMC,GAAG,GAAGjB,GAAG,CAACkB,MAAM,CAAC,iBAAiB,CAAC;AAEzC,IAAMC,YAAY,GAAGC,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEtC,IAAMC,qBAA4C,GAAG,EAAE;AAEvD,IAAMC,gBAAgB,GAAG,MAAMC,SAAS;;AAExC;AACA,IAAMC,iBAAiB,GAAIC,KAAc,IAAKA,KAAK;AAwBnD;AACA;AACA;AACA,OAAO,SAASC,eAAe,OAWO;EAAA;EAAA,IAXN;IAC9BC,EAAE;IACFC,QAAQ;IACRC,cAAc,gBAAG,iCAAK,qBAAmB,CAAM;IAC/CC,MAAM;IACNC,YAAY,GAAGV,qBAAqB;IACpCW,cAAc,GAAGV,gBAAgB;IACjCW,mBAAmB,GAAGX,gBAAgB;IACtCd,OAAO,GAAGC,cAAc;IACxBH,SAAS,GAAGC,gBAAgB;IAC5B2B,YAAY,GAAGnB;EACK,CAAC;EACrB,IAAMoB,QAAQ,GAAGlC,WAAW,EAAE;EAC9B,IAAMmC,IAAI,mBACRlC,WAAW,CAAYmC,KAAK,IAAIxB,gBAAgB,CAACwB,KAAK,EAAEV,EAAE,CAAC,CAAC,uDAC5DT,YAAY;EAEd,IAAM,CAACoB,gBAAgB,EAAEC,mBAAmB,CAAC,GAAG1C,QAAQ,CAAC,KAAK,CAAC;EAC/D,IAAM,CAAC2C,cAAc,EAAEC,iBAAiB,CAAC,GAAG5C,QAAQ,CAAC,KAAK,CAAC;EAC3D,IAAM,CAAC6C,UAAU,EAAEC,aAAa,CAAC,GAAG9C,QAAQ,EAAyB;EACrE,IAAM,CAAC+C,mBAAmB,CAAC,GAAG/C,QAAQ,YACnCuC,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAoBS,MAAM,6CAAI,EAAE,CACtC;EACD,IAAM,CAACC,sBAAsB,EAAEC,yBAAyB,CAAC,GAAGlD,QAAQ,CAAC,KAAK,CAAC;EAC3E,IAAM,CAACmD,cAAc,EAAEC,iBAAiB,CAAC,GAAGpD,QAAQ,CAClDiC,MAAM,CAACoB,gBAAgB,EAAE,CAC1B;EAED,IAAMC,UAAU,GAAGvD,OAAO,CAAC,MAAM,IAAIwD,GAAG,EAAE,EAAE,EAAE,CAAC;EAC/C,IAAMC,YAAY,GAAGzD,OAAO,CAAC,MAAM,IAAIwD,GAAG,EAAE,EAAE,EAAE,CAAC;EACjD,IAAME,iBAAiB,GAAG5D,WAAW,CACnC,UACE6D,IAAY,EACZC,aAAiC,EAG9B;IAAA,IAFHC,gBAAgB,uEAAGjD,OAAO;IAAA,IAC1BkD,kBAAkB,uEAAGpD,SAAS;IAE9BU,GAAG,CAAC2C,MAAM,CACR,mBAAmB,EACnBJ,IAAI,EACJC,aAAa,EACbC,gBAAgB,EAChBC,kBAAkB,CACnB;IAED,SAASE,eAAe,CAACnC,KAAiB,EAAEoC,GAAY,EAAE;MACxD;MACA;MACA;MACA,IAAMC,KAAK,GAAGN,aAAoB;MAClC;MACA,IAAMO,gBAAgB,GAAG7B,YAAmB;;MAE5C;MACA;MACA,IAAM;QAAE8B,WAAW;QAAEC;MAAW,CAAC,GAAGxC,KAAK;MACzC,oBACE,oBAAC,kBAAkB;QAAC,WAAW,EAAEuC,WAAY;QAAC,UAAU,EAAEC;MAAW,gBAEnE,oBAAC,gBAAgB,EAAKxC,KAAK,eAEzB,oBAAC,KAAK,eAAKA,KAAK;QAAE,GAAG,EAAEoC;MAAI,GAAG,CACb,CACA;IAEzB;IAEA,IAAMK,gBAAgB,gBAAGzE,KAAK,CAAC0E,UAAU,CAACP,eAAe,CAAC;IAC1D,IAAMQ,OAAO,GAAGtC,MAAM,CAACwB,iBAAiB,CAACC,IAAI,EAAEW,gBAAgB,CAAC;IAChEf,UAAU,CAACkB,GAAG,CAACd,IAAI,EAAEE,gBAAgB,CAAC;IACtCJ,YAAY,CAACgB,GAAG,CAACd,IAAI,EAAEG,kBAAkB,CAAC;IAC1C,OAAOU,OAAO;EAChB,CAAC,EACD,CAAC5D,OAAO,EAAEF,SAAS,EAAE6C,UAAU,EAAEE,YAAY,EAAEvB,MAAM,EAAEI,YAAY,CAAC,CACrE;EACD,IAAMoC,gBAAgB,GAAG5E,WAAW,CAClC,CAAC6D,IAAI,EAAE9B,KAAK;IAAA;IAAA,OAAK,oBAAC0B,UAAU,CAACoB,GAAG,CAAChB,IAAI,CAAC,6DAAI/B,iBAAiB,EAAEC,KAAK,EAAEE,EAAE,CAAC;EAAA,GACvE,CAACwB,UAAU,EAAExB,EAAE,CAAC,CACjB;EACD,IAAM6C,kBAAkB,GAAG9E,WAAW,CACpC,CAAC6D,IAAI,EAAEkB,MAAM;IAAA;IAAA,OAAK,sBAACpB,YAAY,CAACkB,GAAG,CAAChB,IAAI,CAAC,iEAAI/B,iBAAiB,EAAEiD,MAAM,EAAE9C,EAAE,CAAC;EAAA,GAC3E,CAAC0B,YAAY,EAAE1B,EAAE,CAAC,CACnB;EACD,IAAM+C,YAAY,GAAG9E,OAAO,CAC1B,MACE,IAAIO,YAAY,CACd2B,MAAM,EACNwC,gBAAgB,EAChBE,kBAAkB,EAClB,IAAIpB,GAAG,EAAE,EACTR,mBAAmB,EACnB,SAA2B;IAAA,IAA1B;MAAEC,MAAM;MAAE8B;IAAU,CAAC;IACpBxC,QAAQ,CAACrB,mBAAmB,CAACa,EAAE,EAAE;MAAEkB,MAAM;MAAE8B;IAAU,CAAC,CAAC,CAAC;EAC1D,CAAC,CACF,EACH,CACEH,kBAAkB,EAClBrC,QAAQ,EACRmC,gBAAgB,EAChB3C,EAAE,EACFiB,mBAAmB,EACnBd,MAAM,CACP,CACF;EAED,IAAM8C,wBAAwB,GAAGlF,WAAW,CAAC,MAAM;IACjD;IACA;IACA,IAAI8C,cAAc,EAAE;IAEpB,IAAI,CAACM,sBAAsB,EAAE;MAC3Bb,mBAAmB,EAAE;MACrBc,yBAAyB,CAAC,IAAI,CAAC;IACjC;IAEA,IAAM8B,QAAQ,GAAG/C,MAAM,CAACgD,QAAQ,EAAE;IAClC,IAAMC,aAAa,GAAGF,QAAQ,CAACG,OAAO;IACtC,IAAMC,sBAAsB,GAAG5E,WAAW,CAAC6E,qBAAqB,CAC9DH,aAAa,EACbP,kBAAkB,CACnB;IACD,IAAMW,UAAU,GACdzC,UAAU,IAAI,IAAI,IAClB,CAACrC,WAAW,CAAC+E,OAAO,CAAC1C,UAAU,EAAEuC,sBAAsB,CAAC;IAE1DjE,GAAG,CAACqE,KAAK,CACP,0BAA0B,EAC1BF,UAAU,EACVJ,aAAa,EACbE,sBAAsB,CACvB;IAED,IAAIE,UAAU,EAAE;MACd5C,mBAAmB,CAACT,MAAM,CAACwD,IAAI,CAACC,YAAY,CAACC,MAAM,KAAK,CAAC,CAAC;MAE1D7C,aAAa,CAACsC,sBAAsB,CAAC;MAErCjD,cAAc,CAACiD,sBAAsB,CAAC;MAEtChC,iBAAiB,CAACnB,MAAM,CAACoB,gBAAgB,EAAE,CAAC;IAC9C;EACF,CAAC,EAAE,CACDsB,kBAAkB,EAClB1B,sBAAsB,EACtBN,cAAc,EACdE,UAAU,EACVZ,MAAM,EACNE,cAAc,EACdC,mBAAmB,CACpB,CAAC;EAEF,IAAMwD,wBAAwB,GAAG/F,WAAW,CACzCgG,SAAoB,IAAK;IACxB,IAAMC,WAAW,GAAGtF,WAAW,CAACuF,kBAAkB,CAACF,SAAS,CAAC;IAC7D5D,MAAM,CAAC+D,QAAQ,CAACC,IAAI,CAACpF,UAAU,CAACqF,QAAQ,EAAEJ,WAAW,CAAC;IACtDlD,iBAAiB,CAAC,IAAI,CAAC;EACzB,CAAC,EACD,CAACX,MAAM,CAAC+D,QAAQ,CAAC,CAClB;EAED,IAAMG,uBAAuB,GAAGtG,WAAW,CACxCgG,SAAoB,IAAK;IACxB,IAAMC,WAAW,GAAGtF,WAAW,CAACuF,kBAAkB,CAACF,SAAS,CAAC;IAC7D5D,MAAM,CAAC+D,QAAQ,CAACC,IAAI,CAACpF,UAAU,CAACuF,OAAO,EAAEN,WAAW,CAAC;IACrDlD,iBAAiB,CAAC,KAAK,CAAC;EAC1B,CAAC,EACD,CAACX,MAAM,CAAC+D,QAAQ,CAAC,CAClB;EAED,IAAMK,sBAAsB,GAAGxG,WAAW,CAACyG,IAAI,IAAI;IACjDnF,GAAG,CAAC2C,MAAM,CAAC,wBAAwB,EAAEwC,IAAI,CAAC;IAE1C,IACEA,IAAI,IAAI,IAAI,IACZA,IAAI,CAAC1B,MAAM,IAAI,IAAI,IACnB0B,IAAI,CAAC1B,MAAM,CAACiB,SAAS,IAAI,IAAI,IAC7BS,IAAI,CAACC,OAAO,IAAI,IAAI,EACpB;MACA;IACF;IAEA,IAAMC,YAAY,GAAGF,IAAI,CAAC1B,MAAM,CAACiB,SAAS,CACvCY,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CACnCC,WAAW,EAAE;IAChB,IAAMC,QAAQ,aAAMH,YAAY,eAAY;IAC5CF,IAAI,CAACC,OAAO,CAACK,QAAQ,CAACD,QAAQ,CAAC;EACjC,CAAC,EAAE,EAAE,CAAC;EAEN,IAAME,yBAAyB,GAAGhH,WAAW,CAAC,MAAM;IAClDuD,iBAAiB,CAACnB,MAAM,CAACoB,gBAAgB,EAAE,CAAC;EAC9C,CAAC,EAAE,CAACpB,MAAM,CAAC,CAAC;EAEZlB,WAAW,CAACkB,MAAM,EAAE,cAAc,EAAE8C,wBAAwB,CAAC;EAC7DhE,WAAW,CAACkB,MAAM,EAAE,cAAc,EAAE2D,wBAAwB,CAAC;EAC7D7E,WAAW,CAACkB,MAAM,EAAE,aAAa,EAAEkE,uBAAuB,CAAC;EAC3DpF,WAAW,CAACkB,MAAM,EAAE,kBAAkB,EAAEoE,sBAAsB,CAAC;EAC/DtF,WAAW,CACTkB,MAAM,CAAC+D,QAAQ,EACfnF,UAAU,CAACiG,aAAa,EACxB/B,wBAAwB,CACzB;EACDhE,WAAW,CAACkB,MAAM,EAAE,sBAAsB,EAAE4E,yBAAyB,CAAC;EAEtE,IAAME,oBAAoB,GAAG5G,WAAW,CAAC+B,YAAY,CAAC;EACtDpC,SAAS,CACP,SAASkH,aAAa,GAAG;IACvB,IACED,oBAAoB,KAAK7E,YAAY,IACrCA,YAAY,KAAKW,UAAU,EAC3B;MACA1B,GAAG,CAACqE,KAAK,CAAC,+BAA+B,CAAC;MAC1C,IAAML,OAAO,GAAG3E,WAAW,CAACyG,mBAAmB,CAC7C/E,YAAY,EACZuC,gBAAgB,CACjB;MACD;MACA,OAAOxC,MAAM,CAACwD,IAAI,CAACC,YAAY,CAACC,MAAM,GAAG,CAAC,EAAE;QAC1C1D,MAAM,CAACwD,IAAI,CAACC,YAAY,CAAC,CAAC,CAAC,CAACwB,MAAM,EAAE;MACtC;;MAEA;MACA,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGhC,OAAO,CAACQ,MAAM,EAAEwB,CAAC,IAAI,CAAC,EAAE;QAC1ClF,MAAM,CAACwD,IAAI,CAAC2B,QAAQ,CAACjC,OAAO,CAACgC,CAAC,CAAC,CAAC;MAClC;MAEAzE,mBAAmB,CAACT,MAAM,CAACwD,IAAI,CAACC,YAAY,CAACC,MAAM,KAAK,CAAC,CAAC;IAC5D;EACF,CAAC,EACD,CACElB,gBAAgB,EAChBxC,MAAM,EACNC,YAAY,EACZW,UAAU,EACVgC,YAAY,EACZkC,oBAAoB,CACrB,CACF;EAED,oBACE,0CACGtE,gBAAgB,IAAIT,cAAc,EAClCmB,cAAc,EACdvD,KAAK,CAACyH,QAAQ,CAACC,GAAG,CAACvF,QAAQ,EAAEwF,KAAK,IACjCA,KAAK,IAAI,IAAI,gBACT3H,KAAK,CAAC4H,YAAY,CAACD,KAAK,EAAkB;IACxCzF,EAAE;IACFG,MAAM;IACN4C,YAAY;IACZpB;EACF,CAAC,CAAC,GACF,IAAI,CACT,CACA;AAEP;AAEA5B,eAAe,CAAC4F,SAAS,GAAG;EAC1B3F,EAAE,EAAE7B,SAAS,CAACyH,MAAM,CAACC,UAAU;EAC/B5F,QAAQ,EAAE9B,SAAS,CAAC2H,IAAI;EACxBrF,IAAI,EAAEtC,SAAS,CAAC4H,KAAK,CAAC,CAAC,CAAC,CAAC;EACzB7F,cAAc,EAAE/B,SAAS,CAAC2H,IAAI;EAC9B3F,MAAM,EAAEnB,WAAW,CAACgH,MAAM,CAACH,UAAU;EACrCzF,YAAY,EAAEjC,SAAS,CAAC8H,OAAO,CAAC9H,SAAS,CAAC4H,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;EACpD1F,cAAc,EAAElC,SAAS,CAAC+H,IAAI;EAC9B5F,mBAAmB,EAAEnC,SAAS,CAAC+H;AACjC,CAAC;AAED,eAAenG,eAAe"}
@@ -0,0 +1,10 @@
1
+ import React from 'react';
2
+ export function DashboardPanelWrapper(_ref) {
3
+ var {
4
+ children
5
+ } = _ref;
6
+ // eslint-disable-next-line react/jsx-no-useless-fragment
7
+ return /*#__PURE__*/React.createElement(React.Fragment, null, children);
8
+ }
9
+ export default DashboardPanelWrapper;
10
+ //# sourceMappingURL=DashboardPanelWrapper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DashboardPanelWrapper.js","names":["React","DashboardPanelWrapper","children"],"sources":["../src/DashboardPanelWrapper.tsx"],"sourcesContent":["import React, { PropsWithChildren } from 'react';\n\nexport function DashboardPanelWrapper({ children }: PropsWithChildren<object>) {\n // eslint-disable-next-line react/jsx-no-useless-fragment\n return <>{children}</>;\n}\n\nexport default DashboardPanelWrapper;\n"],"mappings":"AAAA,OAAOA,KAAK,MAA6B,OAAO;AAEhD,OAAO,SAASC,qBAAqB,OAA0C;EAAA,IAAzC;IAAEC;EAAoC,CAAC;EAC3E;EACA,oBAAO,0CAAGA,QAAQ,CAAI;AACxB;AAEA,eAAeD,qBAAqB"}
@@ -0,0 +1,22 @@
1
+ import GoldenLayout from '@deephaven/golden-layout';
2
+ import PanelManager from "./PanelManager.js";
3
+ /**
4
+ * Alias for the return type of React.forwardRef()
5
+ */
6
+ export function isWrappedComponent(type) {
7
+ return (type === null || type === void 0 ? void 0 : type.WrappedComponent) !== undefined;
8
+ }
9
+ /**
10
+ * Takes a partial DashboardPluginComponentProps and verifies all the dashboard component fields are filled in.
11
+ * @param props The props to check
12
+ * @returns True if the props are valid DashboardPluginComponentProps, false otherwise
13
+ */
14
+ export function isDashboardPluginProps(props) {
15
+ return typeof props.id === 'string' && props.layout instanceof GoldenLayout && props.panelManager instanceof PanelManager && typeof props.registerComponent === 'function';
16
+ }
17
+ export function assertIsDashboardPluginProps(props) {
18
+ if (!isDashboardPluginProps(props)) {
19
+ throw new Error("Expected dashboard plugin props, but instead received ".concat(props));
20
+ }
21
+ }
22
+ //# sourceMappingURL=DashboardPlugin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DashboardPlugin.js","names":["GoldenLayout","PanelManager","isWrappedComponent","type","WrappedComponent","undefined","isDashboardPluginProps","props","id","layout","panelManager","registerComponent","assertIsDashboardPluginProps","Error"],"sources":["../src/DashboardPlugin.ts"],"sourcesContent":["import type {\n Component,\n ComponentType,\n ForwardRefExoticComponent,\n PropsWithoutRef,\n RefAttributes,\n} from 'react';\nimport { ConnectedComponent } from 'react-redux';\nimport GoldenLayout from '@deephaven/golden-layout';\nimport type {\n ReactComponentConfig,\n EventEmitter,\n Container,\n} from '@deephaven/golden-layout';\nimport PanelManager from './PanelManager';\n\n/**\n * Alias for the return type of React.forwardRef()\n */\nexport type ForwardRefComponentType<P, R> = ForwardRefExoticComponent<\n PropsWithoutRef<P> & RefAttributes<R>\n>;\n\n/**\n * Panel components can provide static props that provide meta data about the\n * panel.\n */\nexport interface PanelStaticMetaData {\n /**\n * Should be set to the same name as the component type.\n * @deprecated Use `displayName` instead.\n */\n COMPONENT?: string;\n\n /** Title of the panel. */\n TITLE?: string;\n}\n\n/**\n * Panels defined as functional components have to use React.forwardRef.\n */\nexport type PanelFunctionComponentType<P, R> = ForwardRefComponentType<P, R> &\n PanelStaticMetaData;\n\nexport type WrappedComponentType<\n P extends PanelProps,\n C extends ComponentType<P>\n> = ConnectedComponent<C, P>;\n\nexport type PanelComponentType<\n P extends PanelProps = PanelProps,\n C extends ComponentType<P> = ComponentType<P>\n> = (\n | ComponentType<P>\n | WrappedComponentType<P, C>\n | PanelFunctionComponentType<P, unknown>\n) &\n PanelStaticMetaData;\n\nexport function isWrappedComponent<\n P extends PanelProps,\n C extends ComponentType<P>\n>(type: PanelComponentType<P, C>): type is WrappedComponentType<P, C> {\n return (type as WrappedComponentType<P, C>)?.WrappedComponent !== undefined;\n}\n\nexport type PanelProps = {\n glContainer: Container;\n glEventHub: EventEmitter;\n};\n\nexport type PanelComponent<T extends PanelProps = PanelProps> = Component<T>;\n\nexport type PanelConfig = ReactComponentConfig & {\n componentState?: Record<string, unknown> | null;\n};\n\nexport type DashboardConfig = {\n id: string;\n layout: GoldenLayout;\n panelManager: PanelManager;\n};\n\nexport interface DashboardPanelDefinition {\n name: string;\n definition: ComponentType;\n}\n\nexport type DeregisterComponentFunction = () => void;\n\nexport type PanelHydrateFunction<T = PanelProps> = (\n props: T,\n dashboardId: string\n) => PanelProps;\n\nexport type PanelDehydrateFunction = (\n config: PanelConfig,\n dashboardId: string\n) => PanelConfig | null;\n\nexport type DashboardPluginComponentProps = {\n id: string;\n layout: GoldenLayout;\n panelManager: PanelManager;\n registerComponent: <P extends PanelProps, C extends ComponentType<P>>(\n name: string,\n ComponentType: PanelComponentType<P, C>,\n hydrate?: PanelHydrateFunction<P>,\n dehydrate?: PanelDehydrateFunction\n ) => DeregisterComponentFunction;\n};\n\nexport interface DashboardPlugin {\n panels?: DashboardPanelDefinition[];\n\n /** Hydrate the provided panel and props. Return the same object if no changes made. */\n hydrateComponent?: (name: string, props: PanelProps) => PanelProps;\n\n /** Dehydrate a component. Return the same object if no changes made, or `null` if the component should not be saved */\n dehydrateComponent?: (\n name: string,\n config: PanelConfig\n ) => PanelConfig | null;\n\n /** Called when the dashboard is initialized and layout is ready. */\n initialize?: (config: DashboardConfig) => void;\n\n /** Called when the dashboard is unintialized and layout is about to be destroyed */\n deinitialize?: (config: DashboardConfig) => void;\n}\n\n/**\n * Takes a partial DashboardPluginComponentProps and verifies all the dashboard component fields are filled in.\n * @param props The props to check\n * @returns True if the props are valid DashboardPluginComponentProps, false otherwise\n */\nexport function isDashboardPluginProps(\n props: Partial<DashboardPluginComponentProps>\n): props is DashboardPluginComponentProps {\n return (\n typeof props.id === 'string' &&\n props.layout instanceof GoldenLayout &&\n props.panelManager instanceof PanelManager &&\n typeof props.registerComponent === 'function'\n );\n}\n\nexport function assertIsDashboardPluginProps(\n props: Partial<DashboardPluginComponentProps>\n): asserts props is DashboardPluginComponentProps {\n if (!isDashboardPluginProps(props)) {\n throw new Error(\n `Expected dashboard plugin props, but instead received ${props}`\n );\n }\n}\n"],"mappings":"AAQA,OAAOA,YAAY,MAAM,0BAA0B;AAAC,OAM7CC,YAAY;AAEnB;AACA;AACA;AAyCA,OAAO,SAASC,kBAAkB,CAGhCC,IAA8B,EAAsC;EACpE,OAAO,CAACA,IAAI,aAAJA,IAAI,uBAAJA,IAAI,CAAiCC,gBAAgB,MAAKC,SAAS;AAC7E;AAmEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,sBAAsB,CACpCC,KAA6C,EACL;EACxC,OACE,OAAOA,KAAK,CAACC,EAAE,KAAK,QAAQ,IAC5BD,KAAK,CAACE,MAAM,YAAYT,YAAY,IACpCO,KAAK,CAACG,YAAY,YAAYT,YAAY,IAC1C,OAAOM,KAAK,CAACI,iBAAiB,KAAK,UAAU;AAEjD;AAEA,OAAO,SAASC,4BAA4B,CAC1CL,KAA6C,EACG;EAChD,IAAI,CAACD,sBAAsB,CAACC,KAAK,CAAC,EAAE;IAClC,MAAM,IAAIM,KAAK,iEAC4CN,KAAK,EAC/D;EACH;AACF"}
@@ -0,0 +1,62 @@
1
+ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
2
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
3
+ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
4
+ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
5
+ function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
6
+ /**
7
+ * Dehydrate an existing panel to allow it to be serialized/saved.
8
+ * Just takes what's in the panels `metadata` in the props and `panelState` in
9
+ * the component state, assumes it's serializable, and saves it.
10
+ * @param config The panel config to dehydrate
11
+ * @returns The dehydrated PanelConfig
12
+ */
13
+ export function dehydrate(config) {
14
+ var {
15
+ props,
16
+ componentState
17
+ } = config;
18
+ var {
19
+ metadata
20
+ } = props;
21
+ var {
22
+ panelState = null
23
+ } = props;
24
+ if (componentState) {
25
+ ({
26
+ panelState
27
+ } = componentState);
28
+ }
29
+ var newProps = {};
30
+ if (metadata != null) {
31
+ newProps.metadata = metadata;
32
+ }
33
+ if (panelState != null) {
34
+ newProps.panelState = panelState;
35
+ }
36
+ return _objectSpread(_objectSpread({}, config), {}, {
37
+ componentState: null,
38
+ props: newProps,
39
+ type: 'react-component'
40
+ });
41
+ }
42
+
43
+ /**
44
+ * Default hydration function. Just applies the dashboard ID. When used with dehydrate above,
45
+ * the panels state will be stored in `panelState` prop.
46
+ * @param props Panel props to hydrate
47
+ * @param localDashboardId The local dashboard ID to hydrate the panel with
48
+ * @returns The hydrated panel props
49
+ */
50
+ export function hydrate(props) {
51
+ var localDashboardId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
52
+ return _objectSpread(_objectSpread({
53
+ metadata: {}
54
+ }, props), {}, {
55
+ localDashboardId
56
+ });
57
+ }
58
+ export default {
59
+ dehydrate,
60
+ hydrate
61
+ };
62
+ //# sourceMappingURL=DashboardUtils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DashboardUtils.js","names":["dehydrate","config","props","componentState","metadata","panelState","newProps","type","hydrate","localDashboardId"],"sources":["../src/DashboardUtils.ts"],"sourcesContent":["import { PanelConfig, PanelProps } from './DashboardPlugin';\n\nexport type DashboardPanelProps = PanelProps & {\n localDashboardId: string;\n metadata?: Record<string, unknown>;\n};\n\n/**\n * Dehydrate an existing panel to allow it to be serialized/saved.\n * Just takes what's in the panels `metadata` in the props and `panelState` in\n * the component state, assumes it's serializable, and saves it.\n * @param config The panel config to dehydrate\n * @returns The dehydrated PanelConfig\n */\nexport function dehydrate(config: PanelConfig): PanelConfig | null {\n const { props, componentState } = config;\n const { metadata } = props;\n let { panelState = null } = props;\n if (componentState) {\n ({ panelState } = componentState);\n }\n const newProps: Record<string, unknown> = {};\n if (metadata != null) {\n newProps.metadata = metadata;\n }\n if (panelState != null) {\n newProps.panelState = panelState;\n }\n\n return {\n ...config,\n componentState: null,\n props: newProps,\n type: 'react-component',\n };\n}\n\n/**\n * Default hydration function. Just applies the dashboard ID. When used with dehydrate above,\n * the panels state will be stored in `panelState` prop.\n * @param props Panel props to hydrate\n * @param localDashboardId The local dashboard ID to hydrate the panel with\n * @returns The hydrated panel props\n */\nexport function hydrate(\n props: PanelProps & Record<string, unknown>,\n localDashboardId = ''\n): DashboardPanelProps {\n return {\n metadata: {},\n ...props,\n localDashboardId,\n };\n}\n\nexport default {\n dehydrate,\n hydrate,\n};\n"],"mappings":";;;;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,SAAS,CAACC,MAAmB,EAAsB;EACjE,IAAM;IAAEC,KAAK;IAAEC;EAAe,CAAC,GAAGF,MAAM;EACxC,IAAM;IAAEG;EAAS,CAAC,GAAGF,KAAK;EAC1B,IAAI;IAAEG,UAAU,GAAG;EAAK,CAAC,GAAGH,KAAK;EACjC,IAAIC,cAAc,EAAE;IAClB,CAAC;MAAEE;IAAW,CAAC,GAAGF,cAAc;EAClC;EACA,IAAMG,QAAiC,GAAG,CAAC,CAAC;EAC5C,IAAIF,QAAQ,IAAI,IAAI,EAAE;IACpBE,QAAQ,CAACF,QAAQ,GAAGA,QAAQ;EAC9B;EACA,IAAIC,UAAU,IAAI,IAAI,EAAE;IACtBC,QAAQ,CAACD,UAAU,GAAGA,UAAU;EAClC;EAEA,uCACKJ,MAAM;IACTE,cAAc,EAAE,IAAI;IACpBD,KAAK,EAAEI,QAAQ;IACfC,IAAI,EAAE;EAAiB;AAE3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,OAAO,CACrBN,KAA2C,EAEtB;EAAA,IADrBO,gBAAgB,uEAAG,EAAE;EAErB;IACEL,QAAQ,EAAE,CAAC;EAAC,GACTF,KAAK;IACRO;EAAgB;AAEpB;AAEA,eAAe;EACbT,SAAS;EACTQ;AACF,CAAC"}
@@ -0,0 +1,8 @@
1
+ /* stylelint-disable scss/at-import-no-partial-leading-underscore */
2
+ .panel-error-boundary {
3
+ height: 100%;
4
+ width: 100%;
5
+ position: relative;
6
+ }
7
+
8
+ /*# sourceMappingURL=PanelErrorBoundary.css.map */
@@ -0,0 +1 @@
1
+ {"version":3,"sourceRoot":"","sources":["../../../node_modules/@deephaven/components/scss/custom.scss","../src/PanelErrorBoundary.scss"],"names":[],"mappings":"AAAA;ACEA;EACE;EACA;EACA","file":"PanelErrorBoundary.css","sourcesContent":["/* stylelint-disable scss/at-import-no-partial-leading-underscore */\n// Consumers should be able to resolve bootstrap/ to node_modules/bootstrap\n\n//Make bootstrap functions available for use in overrides\n@import 'bootstrap/scss/_functions.scss';\n@import './bootstrap_overrides.scss';\n\n//_variable imports come after bootstrap default overrides,\n// makes all other variables and mixins from bootstrap available\n/// with just importing customer.scss\n@import 'bootstrap/scss/_variables.scss';\n@import 'bootstrap/scss/_mixins.scss';\n\n//New variables come after imports\n@import './new_variables.scss';\n","@import '@deephaven/components/scss/custom.scss';\n\n.panel-error-boundary {\n height: 100%;\n width: 100%;\n position: relative;\n}\n"]}
@@ -0,0 +1,55 @@
1
+ import React, { Component } from 'react';
2
+ import { LoadingOverlay } from '@deephaven/components';
3
+ import Log from '@deephaven/log';
4
+ import PanelEvent from "./PanelEvent.js";
5
+ import LayoutUtils from "./layout/LayoutUtils.js";
6
+ import "./PanelErrorBoundary.css";
7
+ var log = Log.module('PanelErrorBoundary');
8
+ /**
9
+ * Panel wrapper implementing Error Boundary and emitting Closed event.
10
+ * Closed event has to be emitted from the wrapper instead of the panel itself
11
+ * because the panel can get unmounted on errors
12
+ * and we want to differentiate between unmount on error vs panel being intentionally closed.
13
+ */
14
+ class PanelErrorBoundary extends Component {
15
+ constructor(props) {
16
+ super(props);
17
+ this.state = {
18
+ error: null
19
+ };
20
+ }
21
+ componentDidCatch(error) {
22
+ this.setState({
23
+ error
24
+ });
25
+ }
26
+ componentWillUnmount() {
27
+ var {
28
+ glContainer,
29
+ glEventHub
30
+ } = this.props;
31
+ var panelId = LayoutUtils.getIdFromContainer(glContainer);
32
+ log.debug('componentWillUnmount', panelId);
33
+ glEventHub.emit(PanelEvent.CLOSED, panelId, glContainer);
34
+ }
35
+ render() {
36
+ var {
37
+ children
38
+ } = this.props;
39
+ var {
40
+ error
41
+ } = this.state;
42
+ if (error != null) {
43
+ return /*#__PURE__*/React.createElement("div", {
44
+ className: "panel-error-boundary"
45
+ }, /*#__PURE__*/React.createElement(LoadingOverlay, {
46
+ errorMessage: "".concat(error),
47
+ isLoading: false,
48
+ isLoaded: false
49
+ }));
50
+ }
51
+ return children;
52
+ }
53
+ }
54
+ export default PanelErrorBoundary;
55
+ //# sourceMappingURL=PanelErrorBoundary.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PanelErrorBoundary.js","names":["React","Component","LoadingOverlay","Log","PanelEvent","LayoutUtils","log","module","PanelErrorBoundary","constructor","props","state","error","componentDidCatch","setState","componentWillUnmount","glContainer","glEventHub","panelId","getIdFromContainer","debug","emit","CLOSED","render","children"],"sources":["../src/PanelErrorBoundary.tsx"],"sourcesContent":["import React, { Component, ReactNode } from 'react';\nimport { LoadingOverlay } from '@deephaven/components';\nimport type { Container, EventEmitter } from '@deephaven/golden-layout';\nimport Log from '@deephaven/log';\nimport PanelEvent from './PanelEvent';\nimport LayoutUtils from './layout/LayoutUtils';\nimport './PanelErrorBoundary.scss';\n\nconst log = Log.module('PanelErrorBoundary');\n\ninterface PanelErrorBoundaryProps {\n children: ReactNode;\n glContainer: Container;\n glEventHub: EventEmitter;\n}\n\ninterface PanelErrorBoundaryState {\n error: Error | null;\n}\n/**\n * Panel wrapper implementing Error Boundary and emitting Closed event.\n * Closed event has to be emitted from the wrapper instead of the panel itself\n * because the panel can get unmounted on errors\n * and we want to differentiate between unmount on error vs panel being intentionally closed.\n */\nclass PanelErrorBoundary extends Component<\n PanelErrorBoundaryProps,\n PanelErrorBoundaryState\n> {\n constructor(props: PanelErrorBoundaryProps) {\n super(props);\n this.state = { error: null };\n }\n\n componentDidCatch(error: Error): void {\n this.setState({ error });\n }\n\n componentWillUnmount(): void {\n const { glContainer, glEventHub } = this.props;\n const panelId = LayoutUtils.getIdFromContainer(glContainer);\n log.debug('componentWillUnmount', panelId);\n glEventHub.emit(PanelEvent.CLOSED, panelId, glContainer);\n }\n\n render(): ReactNode {\n const { children } = this.props;\n const { error } = this.state;\n if (error != null) {\n return (\n <div className=\"panel-error-boundary\">\n <LoadingOverlay\n errorMessage={`${error}`}\n isLoading={false}\n isLoaded={false}\n />\n </div>\n );\n }\n return children;\n }\n}\n\nexport default PanelErrorBoundary;\n"],"mappings":"AAAA,OAAOA,KAAK,IAAIC,SAAS,QAAmB,OAAO;AACnD,SAASC,cAAc,QAAQ,uBAAuB;AAEtD,OAAOC,GAAG,MAAM,gBAAgB;AAAC,OAC1BC,UAAU;AAAA,OACVC,WAAW;AAAA;AAGlB,IAAMC,GAAG,GAAGH,GAAG,CAACI,MAAM,CAAC,oBAAoB,CAAC;AAW5C;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,kBAAkB,SAASP,SAAS,CAGxC;EACAQ,WAAW,CAACC,KAA8B,EAAE;IAC1C,KAAK,CAACA,KAAK,CAAC;IACZ,IAAI,CAACC,KAAK,GAAG;MAAEC,KAAK,EAAE;IAAK,CAAC;EAC9B;EAEAC,iBAAiB,CAACD,KAAY,EAAQ;IACpC,IAAI,CAACE,QAAQ,CAAC;MAAEF;IAAM,CAAC,CAAC;EAC1B;EAEAG,oBAAoB,GAAS;IAC3B,IAAM;MAAEC,WAAW;MAAEC;IAAW,CAAC,GAAG,IAAI,CAACP,KAAK;IAC9C,IAAMQ,OAAO,GAAGb,WAAW,CAACc,kBAAkB,CAACH,WAAW,CAAC;IAC3DV,GAAG,CAACc,KAAK,CAAC,sBAAsB,EAAEF,OAAO,CAAC;IAC1CD,UAAU,CAACI,IAAI,CAACjB,UAAU,CAACkB,MAAM,EAAEJ,OAAO,EAAEF,WAAW,CAAC;EAC1D;EAEAO,MAAM,GAAc;IAClB,IAAM;MAAEC;IAAS,CAAC,GAAG,IAAI,CAACd,KAAK;IAC/B,IAAM;MAAEE;IAAM,CAAC,GAAG,IAAI,CAACD,KAAK;IAC5B,IAAIC,KAAK,IAAI,IAAI,EAAE;MACjB,oBACE;QAAK,SAAS,EAAC;MAAsB,gBACnC,oBAAC,cAAc;QACb,YAAY,YAAKA,KAAK,CAAG;QACzB,SAAS,EAAE,KAAM;QACjB,QAAQ,EAAE;MAAM,EAChB,CACE;IAEV;IACA,OAAOY,QAAQ;EACjB;AACF;AAEA,eAAehB,kBAAkB"}
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Events emitted by panels and to control panels
3
+ */
4
+ export default Object.freeze({
5
+ // Panel has received focus
6
+ FOCUS: 'PanelEvent.FOCUS',
7
+ // Panel has been mounted
8
+ MOUNT: 'PanelEvent.MOUNT',
9
+ // Panel has been unmounted
10
+ UNMOUNT: 'PanelEvent.UNMOUNT',
11
+ // The title of the panel has changed
12
+ TITLE_CHANGED: 'PanelEvent.TITLE_CHANGED',
13
+ // Panel was re-opened from a dehydrated state
14
+ REOPEN: 'PanelEvent.REOPEN',
15
+ // Panel was deleted
16
+ DELETE: 'PanelEvent.DELETE',
17
+ // Panel was cloned/copied
18
+ CLONED: 'PanelEvent.CLONED',
19
+ // Panel was closed
20
+ CLOSED: 'PanelEvent.CLOSED',
21
+ // Event to open a new panel
22
+ // Plugins will need to register to open based on this event.
23
+ // Multiple plugins could open panels for the same event if desired.
24
+ OPEN: 'PanelEvent.OPEN',
25
+ // Event to close a panel that's currently open
26
+ CLOSE: 'PanelEvent.CLOSE',
27
+ // Panel is being dragged
28
+ DRAGGING: 'PanelEvent.DRAGGING',
29
+ // Panel is dropped
30
+ DROPPED: 'PanelEvent.DROPPED'
31
+ });
32
+ //# sourceMappingURL=PanelEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PanelEvent.js","names":["Object","freeze","FOCUS","MOUNT","UNMOUNT","TITLE_CHANGED","REOPEN","DELETE","CLONED","CLOSED","OPEN","CLOSE","DRAGGING","DROPPED"],"sources":["../src/PanelEvent.ts"],"sourcesContent":["/**\n * Events emitted by panels and to control panels\n */\nexport default Object.freeze({\n // Panel has received focus\n FOCUS: 'PanelEvent.FOCUS',\n\n // Panel has been mounted\n MOUNT: 'PanelEvent.MOUNT',\n\n // Panel has been unmounted\n UNMOUNT: 'PanelEvent.UNMOUNT',\n\n // The title of the panel has changed\n TITLE_CHANGED: 'PanelEvent.TITLE_CHANGED',\n\n // Panel was re-opened from a dehydrated state\n REOPEN: 'PanelEvent.REOPEN',\n\n // Panel was deleted\n DELETE: 'PanelEvent.DELETE',\n\n // Panel was cloned/copied\n CLONED: 'PanelEvent.CLONED',\n\n // Panel was closed\n CLOSED: 'PanelEvent.CLOSED',\n\n // Event to open a new panel\n // Plugins will need to register to open based on this event.\n // Multiple plugins could open panels for the same event if desired.\n OPEN: 'PanelEvent.OPEN',\n\n // Event to close a panel that's currently open\n CLOSE: 'PanelEvent.CLOSE',\n\n // Panel is being dragged\n DRAGGING: 'PanelEvent.DRAGGING',\n\n // Panel is dropped\n DROPPED: 'PanelEvent.DROPPED',\n});\n"],"mappings":"AAAA;AACA;AACA;AACA,eAAeA,MAAM,CAACC,MAAM,CAAC;EAC3B;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,OAAO,EAAE,oBAAoB;EAE7B;EACAC,aAAa,EAAE,0BAA0B;EAEzC;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACAC,MAAM,EAAE,mBAAmB;EAE3B;EACA;EACA;EACAC,IAAI,EAAE,iBAAiB;EAEvB;EACAC,KAAK,EAAE,kBAAkB;EAEzB;EACAC,QAAQ,EAAE,qBAAqB;EAE/B;EACAC,OAAO,EAAE;AACX,CAAC,CAAC"}