@perses-dev/dashboards 0.8.1 → 0.9.0

package/dist/cjs/components/Panel/Panel.js

@@ -1,10 +1,3 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Panel = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
 // Copyright 2022 The Perses Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,73 +10,170 @@ const jsx_runtime_1 = require("react/jsx-runtime");
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-const react_1 = require("react");
-const use_resize_observer_1 = __importDefault(require("use-resize-observer"));
-const react_intersection_observer_1 = require("react-intersection-observer");
-const plugin_system_1 = require("@perses-dev/plugin-system");
-const components_1 = require("@perses-dev/components");
-const material_1 = require("@mui/material");
-const InformationOutline_1 = __importDefault(require("mdi-material-ui/InformationOutline"));
-const Pencil_1 = __importDefault(require("mdi-material-ui/Pencil"));
-const DragVertical_1 = __importDefault(require("mdi-material-ui/DragVertical"));
-const context_1 = require("../../context");
-const PanelContent_1 = require("./PanelContent");
-/**
- * Renders a PanelDefinition's content inside of a Card.
- */
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "Panel", {
+    enumerable: true,
+    get: ()=>Panel
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const _react = require("react");
+const _useResizeObserver = /*#__PURE__*/ _interopRequireDefault(require("use-resize-observer"));
+const _reactIntersectionObserver = require("react-intersection-observer");
+const _components = require("@perses-dev/components");
+const _material = require("@mui/material");
+const _informationOutline = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/InformationOutline"));
+const _pencil = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/Pencil"));
+const _dragVertical = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/DragVertical"));
+const _context = require("../../context");
+const _panelContent = require("./PanelContent");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
 function Panel(props) {
-    const { definition, groupIndex, panelKey, ...others } = props;
-    const [contentElement, setContentElement] = (0, react_1.useState)(null);
-    const [isHovered, setIsHovered] = (0, react_1.useState)(false);
-    const { width, height } = (0, use_resize_observer_1.default)({ ref: contentElement });
-    const contentDimensions = (0, react_1.useMemo)(() => {
-        if (width === undefined || height === undefined)
-            return undefined;
-        return { width, height };
-    }, [width, height]);
-    const { ref, inView } = (0, react_intersection_observer_1.useInView)({
+    const { definition , groupIndex , panelKey , ...others } = props;
+    const [contentElement, setContentElement] = (0, _react.useState)(null);
+    const [isHovered, setIsHovered] = (0, _react.useState)(false);
+    const { width , height  } = (0, _useResizeObserver.default)({
+        ref: contentElement
+    });
+    const contentDimensions = (0, _react.useMemo)(()=>{
+        if (width === undefined || height === undefined) return undefined;
+        return {
+            width,
+            height
+        };
+    }, [
+        width,
+        height
+    ]);
+    const { ref , inView  } = (0, _reactIntersectionObserver.useInView)({
         threshold: 0.3,
         initialInView: false,
-        triggerOnce: true,
+        triggerOnce: true
     });
     // TODO: adjust padding for small panels, consistent way to determine isLargePanel here and in StatChart
     const panelPadding = 1.5;
-    const { isEditMode } = (0, context_1.useEditMode)();
-    const { openPanelDrawer } = (0, context_1.useDashboardApp)();
-    const handleEditButtonClick = () => {
-        openPanelDrawer({ groupIndex, panelKey });
+    const { isEditMode  } = (0, _context.useEditMode)();
+    const { openPanelDrawer  } = (0, _context.useDashboardApp)();
+    const handleEditButtonClick = ()=>{
+        openPanelDrawer({
+            groupIndex,
+            panelKey
+        });
     };
-    return ((0, jsx_runtime_1.jsxs)(material_1.Card, { ref: ref, sx: {
+    return /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Card, {
+        ref: ref,
+        sx: {
             ...others.sx,
             width: '100%',
             height: '100%',
             display: 'flex',
-            flexFlow: 'column nowrap',
-        }, variant: "outlined", ...others, onMouseEnter: () => setIsHovered(true), onMouseLeave: () => setIsHovered(false), children: [(0, jsx_runtime_1.jsx)(material_1.CardHeader, { title: (0, jsx_runtime_1.jsxs)(material_1.Box, { sx: {
+            flexFlow: 'column nowrap'
+        },
+        variant: "outlined",
+        ...others,
+        onMouseEnter: ()=>setIsHovered(true),
+        onMouseLeave: ()=>setIsHovered(false),
+        children: [
+            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.CardHeader, {
+                title: /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+                    sx: {
                         display: 'flex',
                         alignItems: 'center',
-                        minHeight: '24px',
-                    }, children: [(0, jsx_runtime_1.jsx)(material_1.Typography, { component: "h2", variant: "body2", fontWeight: (theme) => theme.typography.fontWeightMedium, whiteSpace: "nowrap", overflow: "hidden", textOverflow: "ellipsis", children: definition.display.name }), (0, jsx_runtime_1.jsxs)(material_1.Box, { sx: {
+                        minHeight: '24px'
+                    },
+                    children: [
+                        /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Typography, {
+                            component: "h2",
+                            variant: "body2",
+                            fontWeight: (theme)=>theme.typography.fontWeightMedium,
+                            whiteSpace: "nowrap",
+                            overflow: "hidden",
+                            textOverflow: "ellipsis",
+                            children: definition.spec.display.name
+                        }),
+                        /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+                            sx: {
                                 display: 'flex',
                                 alignItems: 'center',
-                                marginLeft: 'auto',
-                            }, children: [!isEditMode && isHovered && definition.display.description && ((0, jsx_runtime_1.jsx)(components_1.InfoTooltip, { id: "info-tooltip", description: definition.display.description, placement: components_1.TooltipPlacement.Bottom, children: (0, jsx_runtime_1.jsx)(InformationOutline_1.default, { "aria-describedby": "info-tooltip", "aria-hidden": false, fontSize: "small", sx: { cursor: 'pointer' } }) })), isEditMode && isHovered && ((0, jsx_runtime_1.jsxs)(material_1.Stack, { direction: "row", alignItems: "center", spacing: 0.5, children: [(0, jsx_runtime_1.jsx)(IconButton, { "aria-label": "edit panel", size: "small", onClick: handleEditButtonClick, children: (0, jsx_runtime_1.jsx)(Pencil_1.default, {}) }), (0, jsx_runtime_1.jsx)(IconButton, { "aria-label": "drag handle", size: "small", children: (0, jsx_runtime_1.jsx)(DragVertical_1.default, { className: "drag-handle", sx: { cursor: 'grab' } }) })] }))] })] }), sx: {
+                                marginLeft: 'auto'
+                            },
+                            children: [
+                                !isEditMode && isHovered && definition.spec.display.description && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.InfoTooltip, {
+                                    id: "info-tooltip",
+                                    description: definition.spec.display.description,
+                                    placement: _components.TooltipPlacement.Bottom,
+                                    children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_informationOutline.default, {
+                                        "aria-describedby": "info-tooltip",
+                                        "aria-hidden": false,
+                                        fontSize: "small",
+                                        sx: {
+                                            cursor: 'pointer'
+                                        }
+                                    })
+                                }),
+                                isEditMode && isHovered && /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Stack, {
+                                    direction: "row",
+                                    alignItems: "center",
+                                    spacing: 0.5,
+                                    children: [
+                                        /*#__PURE__*/ (0, _jsxRuntime.jsx)(IconButton, {
+                                            "aria-label": "edit panel",
+                                            size: "small",
+                                            onClick: handleEditButtonClick,
+                                            children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_pencil.default, {})
+                                        }),
+                                        /*#__PURE__*/ (0, _jsxRuntime.jsx)(IconButton, {
+                                            "aria-label": "drag handle",
+                                            size: "small",
+                                            children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_dragVertical.default, {
+                                                className: "drag-handle",
+                                                sx: {
+                                                    cursor: 'grab'
+                                                }
+                                            })
+                                        })
+                                    ]
+                                })
+                            ]
+                        })
+                    ]
+                }),
+                sx: {
                     display: 'block',
-                    padding: (theme) => theme.spacing(1, panelPadding),
-                    borderBottom: (theme) => `solid 1px ${theme.palette.divider}`,
-                } }), (0, jsx_runtime_1.jsx)(material_1.CardContent, { sx: {
+                    padding: (theme)=>theme.spacing(1, panelPadding),
+                    borderBottom: (theme)=>`solid 1px ${theme.palette.divider}`
+                }
+            }),
+            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.CardContent, {
+                sx: {
                     position: 'relative',
                     overflow: 'hidden',
                     flexGrow: 1,
-                    padding: (theme) => theme.spacing(panelPadding),
+                    padding: (theme)=>theme.spacing(panelPadding),
                     // Override MUI default style for last-child
                     ':last-child': {
-                        padding: (theme) => theme.spacing(panelPadding),
-                    },
-                }, ref: setContentElement, children: (0, jsx_runtime_1.jsx)(plugin_system_1.PluginBoundary, { loadingFallback: "Loading...", ErrorFallbackComponent: components_1.ErrorAlert, children: inView === true && (0, jsx_runtime_1.jsx)(PanelContent_1.PanelContent, { definition: definition, contentDimensions: contentDimensions }) }) })] }));
+                        padding: (theme)=>theme.spacing(panelPadding)
+                    }
+                },
+                ref: setContentElement,
+                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.ErrorBoundary, {
+                    FallbackComponent: _components.ErrorAlert,
+                    children: inView === true && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_panelContent.PanelContent, {
+                        definition: definition,
+                        contentDimensions: contentDimensions
+                    })
+                })
+            })
+        ]
+    });
 }
-exports.Panel = Panel;
-const IconButton = (0, material_1.styled)(material_1.IconButton)(({ theme }) => ({
-    borderRadius: theme.shape.borderRadius,
-    padding: '4px',
-}));
+const IconButton = (0, _material.styled)(_material.IconButton)(({ theme  })=>({
+        borderRadius: theme.shape.borderRadius,
+        padding: '4px'
+    }));

package/dist/cjs/components/Panel/Panel.test.js

@@ -1,9 +1,3 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const jsx_runtime_1 = require("react/jsx-runtime");
 // Copyright 2022 The Perses Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,49 +10,64 @@ const jsx_runtime_1 = require("react/jsx-runtime");
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-const plugin_system_1 = require("@perses-dev/plugin-system");
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const _pluginSystem = require("@perses-dev/plugin-system");
 require("intersection-observer");
-const react_1 = require("@testing-library/react");
-const test_1 = require("../../test");
-const testDashboard_1 = __importDefault(require("../../test/testDashboard"));
-const Panel_1 = require("./Panel");
-describe('Panel', () => {
-    let props;
-    let initialState;
-    beforeEach(() => {
-        props = {
+const _react = require("@testing-library/react");
+const _test = require("../../test");
+const _context = require("../../context");
+const _panel = require("./Panel");
+describe('Panel', ()=>{
+    // Helper to create panel props for rendering tests
+    const createPanelProps = ()=>{
+        return {
             definition: {
-                display: {
-                    name: 'Fake Panel',
-                    description: 'This is a fake panel',
-                },
-                kind: 'FakePanel',
-                options: {},
+                kind: 'Panel',
+                spec: {
+                    display: {
+                        name: 'Fake Panel',
+                        description: 'This is a fake panel'
+                    },
+                    plugin: {
+                        kind: 'FakePanel',
+                        spec: {}
+                    }
+                }
             },
             groupIndex: 0,
-            panelKey: 'panelRef',
+            panelKey: 'panelRef'
         };
-        initialState = {
-            isEditMode: false,
-            dashboardSpec: testDashboard_1.default.spec,
-        };
-    });
+    };
     // Helper to render the panel with some context set
-    const renderPanel = (initialState) => {
-        const { addMockPlugin, pluginRegistryProps } = (0, test_1.mockPluginRegistryProps)();
-        addMockPlugin('Panel', 'FakePanel', test_1.FAKE_PANEL_PLUGIN);
-        (0, test_1.renderWithContext)((0, jsx_runtime_1.jsx)(plugin_system_1.PluginRegistry, { ...pluginRegistryProps, children: (0, jsx_runtime_1.jsx)(Panel_1.Panel, { ...props }) }), initialState);
+    const renderPanel = (isEditMode = false)=>{
+        const { addMockPlugin , pluginRegistryProps  } = (0, _test.mockPluginRegistryProps)();
+        addMockPlugin('Panel', 'FakePanel', _test.FAKE_PANEL_PLUGIN);
+        (0, _test.renderWithContext)(/*#__PURE__*/ (0, _jsxRuntime.jsx)(_pluginSystem.PluginRegistry, {
+            ...pluginRegistryProps,
+            children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_context.DashboardProvider, {
+                initialState: {
+                    dashboardSpec: (0, _test.getTestDashboard)().spec,
+                    isEditMode
+                },
+                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_panel.Panel, {
+                    ...createPanelProps()
+                })
+            })
+        }));
     };
-    it('should render name and info icon', async () => {
+    it('should render name and info icon', async ()=>{
         renderPanel();
-        await react_1.screen.findByText('Fake Panel');
-        react_1.screen.queryByLabelText('info-tooltip');
+        await _react.screen.findByText('Fake Panel');
+        _react.screen.queryByLabelText('info-tooltip');
     });
-    it('should render edit icons when in edit mode', async () => {
-        initialState.isEditMode = true;
-        renderPanel(initialState);
-        await react_1.screen.queryByLabelText('drag handle');
-        react_1.screen.queryByLabelText('edit panel');
-        react_1.screen.queryByLabelText('more');
+    it('should render edit icons when in edit mode', ()=>{
+        renderPanel(true);
+        _react.screen.queryByLabelText('drag handle');
+        _react.screen.queryByLabelText('edit panel');
+        _react.screen.queryByLabelText('more');
     });
 });

package/dist/cjs/components/Panel/PanelContent.js

@@ -1,15 +1,43 @@
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PanelContent = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
-const plugin_system_1 = require("@perses-dev/plugin-system");
-/**
- * A small wrapper component that renders the appropriate PanelComponent from a Panel plugin based on the panel
- * definition's kind. Used so that a PluginLoadingBoundary can be wrapped around this for fallback UI while
- * the plugin is loading.
- */
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "PanelContent", {
+    enumerable: true,
+    get: ()=>PanelContent
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const _pluginSystem = require("@perses-dev/plugin-system");
+const _material = require("@mui/material");
 function PanelContent(props) {
-    const { PanelComponent } = (0, plugin_system_1.usePanelPlugin)(props.definition.kind);
-    return (0, jsx_runtime_1.jsx)(PanelComponent, { ...props });
+    const { definition: { spec: { plugin: { kind: panelPluginKind  } ,  } ,  } , contentDimensions ,  } = props;
+    const { data: plugin , isLoading  } = (0, _pluginSystem.usePlugin)('Panel', panelPluginKind, {
+        useErrorBoundary: true
+    });
+    const PanelComponent = plugin === null || plugin === void 0 ? void 0 : plugin.PanelComponent;
+    if (isLoading) {
+        return /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Skeleton, {
+            variant: "rectangular",
+            width: contentDimensions === null || contentDimensions === void 0 ? void 0 : contentDimensions.width,
+            height: contentDimensions === null || contentDimensions === void 0 ? void 0 : contentDimensions.height
+        });
+    }
+    if (PanelComponent === undefined) {
+        throw new Error(`Missing PanelComponent from panel plugin for kind '${panelPluginKind}'`);
+    }
+    return /*#__PURE__*/ (0, _jsxRuntime.jsx)(PanelComponent, {
+        ...props
+    });
 }
-exports.PanelContent = PanelContent;

package/dist/cjs/components/Panel/index.js

@@ -1,4 +1,3 @@
-"use strict";
 // Copyright 2022 The Perses Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,19 +10,19 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Panel"), exports);
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_exportStar(require("./Panel"), exports);
+function _exportStar(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) Object.defineProperty(to, k, {
+            enumerable: true,
+            get: function() {
+                return from[k];
+            }
+        });
+    });
+    return from;
+}