@perses-dev/dashboards 0.0.0-snapshot-time-range-height-80d08fc

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

@@ -0,0 +1,459 @@
+// 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
+});
+Object.defineProperty(exports, "VariableEditForm", {
+    enumerable: true,
+    get: ()=>VariableEditForm
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const _react = /*#__PURE__*/ _interopRequireWildcard(require("react"));
+const _material = require("@mui/material");
+const _useImmer = require("use-immer");
+const _pluginSystem = require("@perses-dev/plugin-system");
+const _components = require("@perses-dev/components");
+const _refresh = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/Refresh"));
+const _clipboardOutline = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/ClipboardOutline"));
+const _variableModel = require("../variable-model");
+const _variableEditorFormModel = require("./variable-editor-form-model");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const DEFAULT_MAX_PREVIEW_VALUES = 50;
+// TODO: Replace with proper validation library
+function getValidation(state) {
+    /** Name validation */ let name = null;
+    if (!state.name) {
+        name = 'Name is required';
+    }
+    // name can only contain alphanumeric characters and underscores and no spaces
+    if (state.name && !/^[a-zA-Z0-9_-]+$/.test(state.name)) {
+        name = 'Name can only contain alphanumeric characters, underscores, and dashes';
+    }
+    return {
+        name,
+        isValid: !name
+    };
+}
+const SectionHeader = ({ children  })=>/*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Typography, {
+        pb: 2,
+        variant: "subtitle1",
+        children: children
+    });
+function VariableListPreview({ definition , onRefresh  }) {
+    const { data , isFetching , error  } = (0, _variableModel.useListVariablePluginValues)(definition);
+    const [maxValues, setMaxValues] = (0, _react.useState)(DEFAULT_MAX_PREVIEW_VALUES);
+    const showAll = ()=>{
+        setMaxValues(undefined);
+    };
+    let notShown = 0;
+    if (data && (data === null || data === void 0 ? void 0 : data.length) > 0 && maxValues) {
+        notShown = data.length - maxValues;
+    }
+    const errorMessage = error === null || error === void 0 ? void 0 : error.message;
+    return /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+        children: [
+            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Stack, {
+                direction: 'row',
+                spacing: 1,
+                alignItems: "center",
+                children: [
+                    /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Typography, {
+                        variant: "caption",
+                        children: "Preview Values"
+                    }),
+                    /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Tooltip, {
+                        title: "Refresh Values",
+                        placement: "right",
+                        children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.IconButton, {
+                            onClick: onRefresh,
+                            size: "small",
+                            children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_refresh.default, {})
+                        })
+                    }),
+                    /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Tooltip, {
+                        title: "Copy Values to Clipboard",
+                        placement: "right",
+                        children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.IconButton, {
+                            onClick: async ()=>{
+                                if (data === null || data === void 0 ? void 0 : data.length) {
+                                    await navigator.clipboard.writeText(data.map((d)=>d.label).join(','));
+                                    alert('Copied to clipboard!');
+                                }
+                            },
+                            size: "small",
+                            children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_clipboardOutline.default, {})
+                        })
+                    })
+                ]
+            }),
+            errorMessage && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Alert, {
+                severity: "error",
+                children: errorMessage
+            }),
+            isFetching && 'Loading...',
+            (data === null || data === void 0 ? void 0 : data.length) === 0 && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Alert, {
+                severity: "info",
+                children: "No results"
+            }),
+            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+                children: [
+                    data === null || data === void 0 ? void 0 : data.slice(0, maxValues).map((val)=>/*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Chip, {
+                            sx: {
+                                mr: 1,
+                                mb: 1
+                            },
+                            size: "small",
+                            label: val.label
+                        }, val.value)),
+                    notShown > 0 && /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Chip, {
+                        onClick: showAll,
+                        variant: "outlined",
+                        sx: {
+                            mr: 1,
+                            mb: 1
+                        },
+                        size: "small",
+                        label: `+${notShown} more`
+                    })
+                ]
+            })
+        ]
+    });
+}
+function VariableEditForm({ initialVariableDefinition , onChange , onCancel  }) {
+    const [state, setState] = (0, _useImmer.useImmer)((0, _variableEditorFormModel.getInitialState)(initialVariableDefinition));
+    const validation = (0, _react.useMemo)(()=>getValidation(state), [
+        state
+    ]);
+    const [previewKey, setPreviewKey] = _react.default.useState(0);
+    const refreshPreview = ()=>{
+        setPreviewKey((prev)=>prev + 1);
+    };
+    /** We use the `previewKey` that we increment to know when to explicity update the
+   * spec that will be used for preview. The reason why we do this is to avoid
+   * having to re-fetch the values when the user is still editing the spec.
+   */ const previewSpec = (0, _react.useMemo)(()=>{
+        return (0, _variableEditorFormModel.getVariableDefinitionFromState)(state);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [
+        previewKey
+    ]);
+    return /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+        children: [
+            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+                sx: {
+                    display: 'flex',
+                    alignItems: 'center',
+                    padding: (theme)=>theme.spacing(1, 2),
+                    borderBottom: (theme)=>`1px solid ${theme.palette.divider}`
+                },
+                children: [
+                    /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Typography, {
+                        variant: "h2",
+                        children: "Edit Variable"
+                    }),
+                    /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Stack, {
+                        direction: "row",
+                        spacing: 1,
+                        sx: {
+                            marginLeft: 'auto'
+                        },
+                        children: [
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Button, {
+                                disabled: !validation.isValid,
+                                variant: "contained",
+                                onClick: ()=>{
+                                    onChange((0, _variableEditorFormModel.getVariableDefinitionFromState)(state));
+                                },
+                                children: "Update"
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Button, {
+                                color: "secondary",
+                                variant: "outlined",
+                                onClick: ()=>{
+                                    onCancel();
+                                },
+                                children: "Cancel"
+                            })
+                        ]
+                    })
+                ]
+            }),
+            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+                padding: 2,
+                sx: {
+                    overflowY: 'scroll'
+                },
+                children: [
+                    /*#__PURE__*/ (0, _jsxRuntime.jsx)(SectionHeader, {
+                        children: "General"
+                    }),
+                    /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Grid, {
+                        container: true,
+                        spacing: 2,
+                        mb: 2,
+                        children: [
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Grid, {
+                                item: true,
+                                xs: 6,
+                                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.TextField, {
+                                    required: true,
+                                    error: !!validation.name,
+                                    fullWidth: true,
+                                    label: "Name",
+                                    value: state.name,
+                                    helperText: validation.name,
+                                    onChange: (v)=>{
+                                        setState((draft)=>{
+                                            draft.name = v.target.value;
+                                        });
+                                    }
+                                })
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Grid, {
+                                item: true,
+                                xs: 6,
+                                children: /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.FormControl, {
+                                    fullWidth: true,
+                                    children: [
+                                        /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.InputLabel, {
+                                            id: "variable-type-select-label",
+                                            children: "Type"
+                                        }),
+                                        /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Select, {
+                                            labelId: "variable-type-select-label",
+                                            id: "variable-type-select",
+                                            label: "Type",
+                                            value: state.kind,
+                                            onChange: (v)=>{
+                                                setState((draft)=>{
+                                                    draft.kind = v.target.value;
+                                                });
+                                            },
+                                            children: _variableModel.VARIABLE_TYPES.map((v)=>/*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.MenuItem, {
+                                                    value: v.kind,
+                                                    children: v.label
+                                                }, v.kind))
+                                        })
+                                    ]
+                                })
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Grid, {
+                                item: true,
+                                xs: 6,
+                                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.TextField, {
+                                    fullWidth: true,
+                                    label: "Display Label",
+                                    value: state.title,
+                                    onChange: (v)=>{
+                                        setState((draft)=>{
+                                            draft.title = v.target.value;
+                                        });
+                                    }
+                                })
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Grid, {
+                                item: true,
+                                xs: 12,
+                                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.TextField, {
+                                    fullWidth: true,
+                                    label: "Description",
+                                    value: state.description,
+                                    onChange: (v)=>{
+                                        setState((draft)=>{
+                                            draft.description = v.target.value;
+                                        });
+                                    }
+                                })
+                            })
+                        ]
+                    }),
+                    state.kind === 'TextVariable' && /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+                        children: [
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(SectionHeader, {
+                                children: "Text Options"
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Grid, {
+                                container: true,
+                                spacing: 2,
+                                mb: 2,
+                                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Grid, {
+                                    item: true,
+                                    xs: 12,
+                                    children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.TextField, {
+                                        label: "Value",
+                                        value: state.textVariableFields.value,
+                                        onChange: (v)=>{
+                                            setState((draft)=>{
+                                                draft.textVariableFields.value = v.target.value;
+                                            });
+                                        }
+                                    })
+                                })
+                            })
+                        ]
+                    }),
+                    state.kind === 'ListVariable' && /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+                        children: [
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(SectionHeader, {
+                                children: "List Options"
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Grid, {
+                                container: true,
+                                spacing: 2,
+                                mb: 2,
+                                children: [
+                                    /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Grid, {
+                                        item: true,
+                                        xs: 6,
+                                        children: [
+                                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.ClickAwayListener, {
+                                                onClickAway: ()=>refreshPreview(),
+                                                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Box, {})
+                                            }),
+                                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_pluginSystem.PluginEditor, {
+                                                width: 500,
+                                                pluginType: "Variable",
+                                                pluginKindLabel: "Source",
+                                                value: state.listVariableFields.plugin,
+                                                onChange: (val)=>{
+                                                    setState((draft)=>{
+                                                        draft.listVariableFields.plugin = val;
+                                                    });
+                                                }
+                                            })
+                                        ]
+                                    }),
+                                    state.listVariableFields.plugin.kind && /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Grid, {
+                                        item: true,
+                                        xs: 12,
+                                        children: [
+                                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.TextField, {
+                                                sx: {
+                                                    mb: 1
+                                                },
+                                                label: "Capturing Regexp Filter",
+                                                value: state.listVariableFields.capturing_regexp,
+                                                onChange: (e)=>{
+                                                    setState((draft)=>{
+                                                        draft.listVariableFields.capturing_regexp = e.target.value;
+                                                    });
+                                                }
+                                            }),
+                                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_components.ErrorBoundary, {
+                                                FallbackComponent: ()=>/*#__PURE__*/ (0, _jsxRuntime.jsx)("div", {
+                                                        children: "Error previewing values"
+                                                    }),
+                                                resetKeys: [
+                                                    previewSpec
+                                                ],
+                                                children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(VariableListPreview, {
+                                                    onRefresh: refreshPreview,
+                                                    definition: previewSpec
+                                                })
+                                            })
+                                        ]
+                                    })
+                                ]
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(SectionHeader, {
+                                children: "Dropdown Options"
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Grid, {
+                                container: true,
+                                spacing: 1,
+                                mb: 1,
+                                children: [
+                                    /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Grid, {
+                                        item: true,
+                                        xs: 12,
+                                        children: [
+                                            "Allow Multiple",
+                                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Switch, {
+                                                checked: state.listVariableFields.allowMultiple,
+                                                onChange: (e)=>{
+                                                    setState((draft)=>{
+                                                        draft.listVariableFields.allowMultiple = e.target.checked;
+                                                    });
+                                                }
+                                            })
+                                        ]
+                                    }),
+                                    /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Grid, {
+                                        item: true,
+                                        xs: 12,
+                                        children: [
+                                            "Allow All",
+                                            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Switch, {
+                                                checked: state.listVariableFields.allowAll,
+                                                onChange: (e)=>{
+                                                    setState((draft)=>{
+                                                        draft.listVariableFields.allowAll = e.target.checked;
+                                                    });
+                                                }
+                                            })
+                                        ]
+                                    })
+                                ]
+                            })
+                        ]
+                    })
+                ]
+            })
+        ]
+    });
+}

package/dist/cjs/components/Variables/VariableEditorForm/index.js

@@ -0,0 +1,28 @@
+// 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
+});
+_exportStar(require("./VariableEditorForm"), 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;
+}

package/dist/cjs/components/Variables/VariableEditorForm/variable-editor-form-model.js

@@ -0,0 +1,89 @@
+// 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
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    getInitialState: ()=>getInitialState,
+    getVariableDefinitionFromState: ()=>getVariableDefinitionFromState
+});
+function getInitialState(initialVariableDefinition) {
+    var ref;
+    var _value;
+    const textVariableFields = {
+        value: (_value = initialVariableDefinition.spec.value) !== null && _value !== void 0 ? _value : ''
+    };
+    const listVariableFields = {
+        allowMultiple: false,
+        allowAll: false,
+        capturing_regexp: undefined,
+        plugin: {
+            kind: '',
+            spec: {}
+        }
+    };
+    if (initialVariableDefinition.kind === 'ListVariable') {
+        var _allow_all_value;
+        listVariableFields.allowMultiple = (_allow_all_value = initialVariableDefinition.spec.allow_all_value) !== null && _allow_all_value !== void 0 ? _allow_all_value : false;
+        var _allow_all_value1;
+        listVariableFields.allowAll = (_allow_all_value1 = initialVariableDefinition.spec.allow_all_value) !== null && _allow_all_value1 !== void 0 ? _allow_all_value1 : false;
+        listVariableFields.capturing_regexp = initialVariableDefinition.spec.capturing_regexp;
+        listVariableFields.plugin = initialVariableDefinition.spec.plugin;
+    }
+    return {
+        name: initialVariableDefinition.spec.name,
+        title: (ref = initialVariableDefinition.spec.display) === null || ref === void 0 ? void 0 : ref.name,
+        kind: initialVariableDefinition.kind,
+        description: '',
+        listVariableFields,
+        textVariableFields
+    };
+}
+function getVariableDefinitionFromState(state) {
+    const { name , title , kind  } = state;
+    const commonSpec = {
+        name,
+        display: {
+            name: title
+        }
+    };
+    if (kind === 'TextVariable') {
+        return {
+            kind,
+            spec: {
+                ...commonSpec,
+                ...state.textVariableFields
+            }
+        };
+    }
+    if (kind === 'ListVariable') {
+        return {
+            kind,
+            spec: {
+                ...commonSpec,
+                allow_multiple: state.listVariableFields.allowMultiple,
+                allow_all_value: state.listVariableFields.allowAll,
+                capturing_regexp: state.listVariableFields.capturing_regexp,
+                plugin: state.listVariableFields.plugin
+            }
+        };
+    }
+    throw new Error(`Unknown variable kind: ${kind}`);
+}