@perses-dev/dashboards 0.39.0 → 0.40.1

package/dist/cjs/components/SaveDashboardButton/SaveDashboardButton.js

@@ -16,20 +16,22 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "SaveDashboardButton", {
     enumerable: true,
-    get: ()=>SaveDashboardButton
+    get: function() {
+        return SaveDashboardButton;
+    }
 });
-const _jsxRuntime = require("react/jsx-runtime");
+const _jsxruntime = require("react/jsx-runtime");
 const _react = require("react");
 const _material = require("@mui/material");
 const _core = require("@perses-dev/core");
-const _pluginSystem = require("@perses-dev/plugin-system");
+const _pluginsystem = require("@perses-dev/plugin-system");
 const _context = require("../../context");
 const SaveDashboardButton = ({ onSave , isDisabled , variant ='contained'  })=>{
     const [isSavingDashboard, setSavingDashboard] = (0, _react.useState)(false);
     const { dashboard , setDashboard  } = (0, _context.useDashboard)();
     const { getSavedVariablesStatus , setVariableDefaultValues  } = (0, _context.useTemplateVariableActions)();
     const { isSavedVariableModified  } = getSavedVariablesStatus();
-    const { timeRange  } = (0, _pluginSystem.useTimeRange)();
+    const { timeRange  } = (0, _pluginsystem.useTimeRange)();
     const { setEditMode  } = (0, _context.useEditMode)();
     const { openSaveChangesConfirmationDialog , closeSaveChangesConfirmationDialog  } = (0, _context.useSaveChangesConfirmationDialog)();
     const onSaveButtonClick = ()=>{
@@ -70,15 +72,13 @@ const SaveDashboardButton = ({ onSave , isDisabled , variant ='contained'  })=>{
             } catch (error) {
                 throw new Error(`An error occurred while saving the dashboard. ${error}`);
             } finally{
-                if (isSavingDashboard) {
-                    setSavingDashboard(false);
-                }
+                setSavingDashboard(false);
             }
         } else {
             setEditMode(false);
         }
     };
-    return /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Button, {
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.Button, {
         variant: variant,
         onClick: onSaveButtonClick,
         disabled: isDisabled || isSavingDashboard,

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

@@ -14,15 +14,17 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_exportStar(require("./SaveDashboardButton"), exports);
-function _exportStar(from, to) {
+_export_star(require("./SaveDashboardButton"), exports);
+function _export_star(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];
-            }
-        });
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
     });
     return from;
 }

package/dist/cjs/components/TimeRangeControls/TimeRangeControls.js

@@ -21,20 +21,28 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    DEFAULT_TIME_RANGE_OPTIONS: ()=>DEFAULT_TIME_RANGE_OPTIONS,
-    DEFAULT_REFRESH_INTERVAL_OPTIONS: ()=>DEFAULT_REFRESH_INTERVAL_OPTIONS,
-    TimeRangeControls: ()=>TimeRangeControls
+    DEFAULT_TIME_RANGE_OPTIONS: function() {
+        return DEFAULT_TIME_RANGE_OPTIONS;
+    },
+    DEFAULT_REFRESH_INTERVAL_OPTIONS: function() {
+        return DEFAULT_REFRESH_INTERVAL_OPTIONS;
+    },
+    TimeRangeControls: function() {
+        return TimeRangeControls;
+    }
 });
-const _jsxRuntime = require("react/jsx-runtime");
-const _refresh = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/Refresh"));
+const _jsxruntime = require("react/jsx-runtime");
+const _Refresh = /*#__PURE__*/ _interop_require_default(require("mdi-material-ui/Refresh"));
 const _material = require("@mui/material");
 const _components = require("@perses-dev/components");
-const _pluginSystem = require("@perses-dev/plugin-system");
+const _pluginsystem = require("@perses-dev/plugin-system");
 const _core = require("@perses-dev/core");
+const _react = require("react");
 const _constants = require("../../constants");
 const _context = require("../../context");
-const _toolbarIconButton = require("../ToolbarIconButton");
-function _interopRequireDefault(obj) {
+const _ToolbarIconButton = require("../ToolbarIconButton");
+const _useDashboard = require("../../context/useDashboard");
+function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
@@ -135,9 +143,10 @@ const DEFAULT_REFRESH_INTERVAL_OPTIONS = [
 ];
 const DEFAULT_HEIGHT = '34px';
 function TimeRangeControls({ heightPx , showTimeRangeSelector =true , showRefreshButton =true , showRefreshInterval =true , timePresets =DEFAULT_TIME_RANGE_OPTIONS  }) {
-    const { timeRange , setTimeRange , refresh , refreshInterval , setRefreshInterval  } = (0, _pluginSystem.useTimeRange)();
+    const { timeRange , setTimeRange , refresh , refreshInterval , setRefreshInterval  } = (0, _pluginsystem.useTimeRange)();
     // TODO: Remove this since it couples to the dashboard context
     const dashboardDuration = (0, _context.useDashboardDuration)();
+    const { dashboard , setDashboard  } = (0, _useDashboard.useDashboard)();
     // Convert height to a string, then use the string for styling
     const height = heightPx === undefined ? DEFAULT_HEIGHT : `${heightPx}px`;
     // add time shortcut if one does not match duration from dashboard JSON
@@ -151,31 +160,46 @@ function TimeRangeControls({ heightPx , showTimeRangeSelector =true , showRefres
             });
         }
     }
-    return /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Stack, {
+    // set the new refresh interval both in the dashboard context & as query param
+    const handleRefreshIntervalChange = (0, _react.useCallback)((duration)=>{
+        setDashboard({
+            ...dashboard,
+            spec: {
+                ...dashboard.spec,
+                refreshInterval: duration
+            }
+        });
+        setRefreshInterval(duration);
+    }, [
+        dashboard,
+        setDashboard,
+        setRefreshInterval
+    ]);
+    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_material.Stack, {
         direction: "row",
         spacing: 1,
         children: [
-            showTimeRangeSelector && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.DateTimeRangePicker, {
+            showTimeRangeSelector && /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.DateTimeRangePicker, {
                 timeOptions: timePresets,
                 value: timeRange,
                 onChange: setTimeRange,
                 height: height
             }),
-            showRefreshButton && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.InfoTooltip, {
+            showRefreshButton && /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.InfoTooltip, {
                 description: _constants.TOOLTIP_TEXT.refreshDashboard,
-                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_toolbarIconButton.ToolbarIconButton, {
+                children: /*#__PURE__*/ (0, _jsxruntime.jsx)(_ToolbarIconButton.ToolbarIconButton, {
                     "aria-label": _constants.TOOLTIP_TEXT.refreshDashboard,
                     onClick: refresh,
                     sx: {
                         height
                     },
-                    children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_refresh.default, {})
+                    children: /*#__PURE__*/ (0, _jsxruntime.jsx)(_Refresh.default, {})
                 })
             }),
-            showRefreshInterval && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.RefreshIntervalPicker, {
+            showRefreshInterval && /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.RefreshIntervalPicker, {
                 timeOptions: DEFAULT_REFRESH_INTERVAL_OPTIONS,
                 value: refreshInterval,
-                onChange: setRefreshInterval,
+                onChange: handleRefreshIntervalChange,
                 height: height
             })
         ]

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

@@ -14,15 +14,17 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_exportStar(require("./TimeRangeControls"), exports);
-function _exportStar(from, to) {
+_export_star(require("./TimeRangeControls"), exports);
+function _export_star(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];
-            }
-        });
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
     });
     return from;
 }

package/dist/cjs/components/ToolbarIconButton/ToolbarIconButton.js

@@ -16,13 +16,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "ToolbarIconButton", {
     enumerable: true,
-    get: ()=>ToolbarIconButton
+    get: function() {
+        return ToolbarIconButton;
+    }
 });
-const _jsxRuntime = require("react/jsx-runtime");
+const _jsxruntime = require("react/jsx-runtime");
 const _react = require("react");
 const _material = require("@mui/material");
 function IconButton(props, ref) {
-    return /*#__PURE__*/ (0, _jsxRuntime.jsx)(StyledIconButton, {
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(StyledIconButton, {
         ref: ref,
         variant: "outlined",
         color: "secondary",

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

@@ -14,15 +14,17 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_exportStar(require("./ToolbarIconButton"), exports);
-function _exportStar(from, to) {
+_export_star(require("./ToolbarIconButton"), exports);
+function _export_star(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];
-            }
-        });
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
     });
     return from;
 }

package/dist/cjs/components/Variables/BuiltinVariableAccordions.js

@@ -0,0 +1,140 @@
+// Copyright 2023 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
+});
+Object.defineProperty(exports, "BuiltinVariableAccordions", {
+    enumerable: true,
+    get: function() {
+        return BuiltinVariableAccordions;
+    }
+});
+const _jsxruntime = require("react/jsx-runtime");
+const _material = require("@mui/material");
+const _ChevronUp = /*#__PURE__*/ _interop_require_default(require("mdi-material-ui/ChevronUp"));
+const _components = require("@perses-dev/components");
+const _react = require("react");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function BuiltinVariableAccordions({ builtinVariableDefinitions  }) {
+    const builtinVariablesBySource = (0, _react.useMemo)(()=>{
+        const result = {};
+        for (const definition of builtinVariableDefinitions){
+            const value = result[definition.spec.source];
+            if (value) {
+                value.push(definition);
+                continue;
+            }
+            result[definition.spec.source] = [
+                definition
+            ];
+        }
+        return result;
+    }, [
+        builtinVariableDefinitions
+    ]);
+    const sources = (0, _react.useMemo)(()=>{
+        const result = [];
+        for(const source in builtinVariablesBySource){
+            if (!result.includes(source)) {
+                result.push(source);
+            }
+        }
+        return result;
+    }, [
+        builtinVariablesBySource
+    ]);
+    var _builtinVariablesBySource_source, _v_spec_display_description;
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_jsxruntime.Fragment, {
+        children: sources.map((source)=>{
+            /*#__PURE__*/ return (0, _jsxruntime.jsxs)(_material.Accordion, {
+                sx: (theme)=>({
+                        '.MuiAccordionSummary-root': {
+                            backgroundColor: theme.palette.background.lighter
+                        },
+                        '.MuiAccordionDetails-root': {
+                            backgroundColor: theme.palette.background.lighter
+                        }
+                    }),
+                children: [
+                    /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.AccordionSummary, {
+                        expandIcon: /*#__PURE__*/ (0, _jsxruntime.jsx)(_ChevronUp.default, {}),
+                        "aria-controls": "builtin",
+                        id: "builtin",
+                        children: /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.Typography, {
+                            variant: "h2",
+                            children: /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.InfoTooltip, {
+                                title: `${source} Builtin Variables`,
+                                description: "Variables computed during dashboard rendering.",
+                                children: /*#__PURE__*/ (0, _jsxruntime.jsxs)("span", {
+                                    children: [
+                                        source,
+                                        " Builtin Variables"
+                                    ]
+                                })
+                            })
+                        })
+                    }),
+                    /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.AccordionDetails, {
+                        children: /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TableContainer, {
+                            children: /*#__PURE__*/ (0, _jsxruntime.jsxs)(_material.Table, {
+                                sx: {
+                                    minWidth: 650
+                                },
+                                "aria-label": "table of external variables",
+                                children: [
+                                    /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TableHead, {
+                                        children: /*#__PURE__*/ (0, _jsxruntime.jsxs)(_material.TableRow, {
+                                            children: [
+                                                /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TableCell, {
+                                                    children: "Name"
+                                                }),
+                                                /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TableCell, {
+                                                    children: "Description"
+                                                })
+                                            ]
+                                        })
+                                    }),
+                                    /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TableBody, {
+                                        children: ((_builtinVariablesBySource_source = builtinVariablesBySource[source]) !== null && _builtinVariablesBySource_source !== void 0 ? _builtinVariablesBySource_source : []).map((v)=>{
+                                            var _v_spec_display;
+                                            /*#__PURE__*/ return (0, _jsxruntime.jsxs)(_material.TableRow, {
+                                                children: [
+                                                    /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TableCell, {
+                                                        component: "th",
+                                                        scope: "row",
+                                                        sx: {
+                                                            fontWeight: 'bold'
+                                                        },
+                                                        children: v.spec.name
+                                                    }),
+                                                    /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.TableCell, {
+                                                        children: (_v_spec_display_description = (_v_spec_display = v.spec.display) === null || _v_spec_display === void 0 ? void 0 : _v_spec_display.description) !== null && _v_spec_display_description !== void 0 ? _v_spec_display_description : ''
+                                                    })
+                                                ]
+                                            }, source + '-' + v.spec.name);
+                                        })
+                                    })
+                                ]
+                            })
+                        })
+                    })
+                ]
+            }, source);
+        })
+    });
+}

package/dist/cjs/components/Variables/EditVariablesButton.js

@@ -16,17 +16,20 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "EditVariablesButton", {
     enumerable: true,
-    get: ()=>EditVariablesButton
+    get: function() {
+        return EditVariablesButton;
+    }
 });
-const _jsxRuntime = require("react/jsx-runtime");
+const _jsxruntime = require("react/jsx-runtime");
 const _react = require("react");
 const _material = require("@mui/material");
-const _pencilOutline = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/PencilOutline"));
+const _PencilOutline = /*#__PURE__*/ _interop_require_default(require("mdi-material-ui/PencilOutline"));
 const _components = require("@perses-dev/components");
+const _pluginsystem = require("@perses-dev/plugin-system");
 const _constants = require("../../constants");
 const _context = require("../../context");
-const _variableEditor = require("./VariableEditor");
-function _interopRequireDefault(obj) {
+const _VariableEditor = require("./VariableEditor");
+function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
@@ -35,6 +38,7 @@ function EditVariablesButton({ variant ='text' , label ='Variables' , color ='pr
     const [isVariableEditorOpen, setIsVariableEditorOpen] = (0, _react.useState)(false);
     const variableDefinitions = (0, _context.useTemplateVariableDefinitions)();
     const externalVariableDefinitions = (0, _context.useTemplateExternalVariableDefinitions)();
+    const builtinVariableDefinitions = (0, _pluginsystem.useBuiltinVariableDefinitions)();
     const { setVariableDefinitions  } = (0, _context.useTemplateVariableActions)();
     const openVariableEditor = ()=>{
         setIsVariableEditorOpen(true);
@@ -42,12 +46,12 @@ function EditVariablesButton({ variant ='text' , label ='Variables' , color ='pr
     const closeVariableEditor = ()=>{
         setIsVariableEditorOpen(false);
     };
-    return /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_jsxruntime.Fragment, {
         children: [
-            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.InfoTooltip, {
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.InfoTooltip, {
                 description: _constants.TOOLTIP_TEXT.editVariables,
-                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Button, {
-                    startIcon: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_pencilOutline.default, {}),
+                children: /*#__PURE__*/ (0, _jsxruntime.jsx)(_material.Button, {
+                    startIcon: /*#__PURE__*/ (0, _jsxruntime.jsx)(_PencilOutline.default, {}),
                     onClick: openVariableEditor,
                     "aria-label": _constants.TOOLTIP_TEXT.editVariables,
                     variant: variant,
@@ -60,7 +64,7 @@ function EditVariablesButton({ variant ='text' , label ='Variables' , color ='pr
                     children: label
                 })
             }),
-            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.Drawer, {
+            /*#__PURE__*/ (0, _jsxruntime.jsx)(_components.Drawer, {
                 isOpen: isVariableEditorOpen,
                 onClose: closeVariableEditor,
                 PaperProps: {
@@ -69,9 +73,10 @@ function EditVariablesButton({ variant ='text' , label ='Variables' , color ='pr
                     }
                 },
                 "data-testid": "variable-editor",
-                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_variableEditor.VariableEditor, {
+                children: /*#__PURE__*/ (0, _jsxruntime.jsx)(_VariableEditor.VariableEditor, {
                     variableDefinitions: variableDefinitions,
                     externalVariableDefinitions: externalVariableDefinitions,
+                    builtinVariableDefinitions: builtinVariableDefinitions,
                     onCancel: closeVariableEditor,
                     onChange: (variables)=>{
                         setVariableDefinitions(variables);