@grafana/scenes 6.12.0--canary.1121.15070832166.0 → 6.13.0--canary.1122.15158583461.0

package/dist/index.js

@@ -2965,18 +2965,34 @@ class GroupByVariableUrlSyncHandler {
     return [this.getKey()];
   }
   getUrlState() {
+    var _a;
     if (this._sceneObject.state.skipUrlSync) {
       return {};
     }
-    return { [this.getKey()]: toUrlValues(this._sceneObject.state.value, this._sceneObject.state.text) };
+    return {
+      [this.getKey()]: toUrlValues(
+        this._sceneObject.state.value,
+        this._sceneObject.state.text,
+        (_a = this._sceneObject.state.defaultValue) == null ? void 0 : _a.value
+      )
+    };
   }
   updateFromUrl(values) {
+    var _a, _b;
     let urlValue = values[this.getKey()];
     if (urlValue != null) {
       if (!this._sceneObject.isActive) {
         this._sceneObject.skipNextValidation = true;
       }
-      const { values: values2, texts } = fromUrlValues(urlValue);
+      const { values: values2, texts, defaults } = fromUrlValues(urlValue);
+      if (lodash.isEqual(values2, defaults) && this._sceneObject.state.defaultValue) {
+        this._sceneObject.changeValueTo(
+          (_a = this._sceneObject.state.defaultValue) == null ? void 0 : _a.value,
+          (_b = this._sceneObject.state.defaultValue) == null ? void 0 : _b.text,
+          false
+        );
+        return;
+      }
       this._sceneObject.changeValueTo(values2, texts);
     }
   }
@@ -2989,9 +3005,10 @@ class GroupByVariableUrlSyncHandler {
     return this._nextChangeShouldAddHistoryStep;
   }
 }
-function toUrlValues(values, texts) {
+function toUrlValues(values, texts, defaultValues) {
   values = Array.isArray(values) ? values : [values];
   texts = Array.isArray(texts) ? texts : [texts];
+  const defaults = defaultValues ? Array.isArray(defaultValues) ? defaultValues : [defaultValues] : [];
   return values.map((value, idx) => {
     if (value === void 0 || value === null) {
       return "";
@@ -2999,21 +3016,27 @@ function toUrlValues(values, texts) {
     value = String(value);
     let text = texts[idx];
     text = text === void 0 || text === null ? value : String(text);
-    return toUrlCommaDelimitedString(value, text);
+    return toUrlCommaDelimitedString(value, text) + (defaults.includes(value) ? escapeUrlPipeDelimiters("|default") : "");
   });
 }
 function fromUrlValues(urlValues) {
   urlValues = Array.isArray(urlValues) ? urlValues : [urlValues];
   return urlValues.reduce(
     (acc, urlValue) => {
-      const [value, label] = (urlValue != null ? urlValue : "").split(",");
+      const pipeEscapedVal = /__gfp__/g[Symbol.replace](urlValue, "|");
+      const [commaValues, isDefault] = (pipeEscapedVal != null ? pipeEscapedVal : "").split("|");
+      const [value, label] = (commaValues != null ? commaValues : "").split(",");
       acc.values.push(unescapeUrlDelimiters(value));
       acc.texts.push(unescapeUrlDelimiters(label != null ? label : value));
+      if (isDefault) {
+        acc.defaults.push(value);
+      }
       return acc;
     },
     {
       values: [],
-      texts: []
+      texts: [],
+      defaults: []
     }
   );
 }
@@ -3077,6 +3100,101 @@ function wrapInSafeSerializableSceneObject(sceneObject) {
   return { value: sceneObject, text: "__sceneObject" };
 }
 
+function DefaultGroupByCustomIndicatorContainer(props) {
+  const { model } = props;
+  const theme = ui.useTheme2();
+  const styles = getStyles$h(theme);
+  const inputStyles = ui.getInputStyles({ theme, invalid: false });
+  const value = React.useMemo(
+    () => lodash.isArray(model.state.value) ? model.state.value : model.state.value ? [model.state.value] : [],
+    [model.state.value]
+  );
+  const isRestorable = React.useMemo(() => {
+    return model.checkIfRestorable(value);
+  }, [value, model]);
+  let buttons = [];
+  if (value && value.length) {
+    buttons.push(
+      /* @__PURE__ */ React__default.default.createElement(
+        ui.IconButton,
+        {
+          "aria-label": "clear",
+          key: "clear",
+          name: "times",
+          size: "md",
+          className: styles.clearIcon,
+          onClick: (e) => {
+            model.changeValueTo([], void 0, true);
+          }
+        }
+      )
+    );
+  }
+  if (isRestorable) {
+    buttons.push(
+      /* @__PURE__ */ React__default.default.createElement(
+        ui.IconButton,
+        {
+          onClick: (e) => {
+            props.model.restoreDefaultValues();
+          },
+          onKeyDownCapture: (e) => {
+            if (e.key === "Enter") {
+              props.model.restoreDefaultValues();
+            }
+          },
+          key: "restore",
+          name: "history",
+          size: "md",
+          className: styles.clearIcon,
+          tooltip: "Restore groupby set by this dashboard."
+        }
+      )
+    );
+  }
+  if (!isRestorable) {
+    buttons.push(
+      /* @__PURE__ */ React__default.default.createElement(
+        ui.Tooltip,
+        {
+          key: "tooltip",
+          content: "Applied by default in this dashboard. If edited, it carries over to other dashboards.",
+          placement: "bottom"
+        },
+        /* @__PURE__ */ React__default.default.createElement(ui.Icon, { name: "info-circle", size: "md" })
+      )
+    );
+  }
+  return /* @__PURE__ */ React__default.default.createElement(
+    "div",
+    {
+      onMouseDown: (e) => {
+        e.preventDefault();
+        e.stopPropagation();
+      },
+      className: css.cx(
+        inputStyles.suffix,
+        css.css({
+          position: "relative"
+        })
+      )
+    },
+    buttons
+  );
+}
+const getStyles$h = (theme) => ({
+  clearIcon: css.css({
+    color: theme.colors.action.disabledText,
+    cursor: "pointer",
+    "&:hover:before": {
+      backgroundColor: "transparent"
+    },
+    "&:hover": {
+      color: theme.colors.text.primary
+    }
+  })
+});
+
 class GroupByVariable extends MultiValueVariable {
   constructor(initialState) {
     super({
@@ -3095,6 +3213,14 @@ class GroupByVariable extends MultiValueVariable {
     });
     this.isLazy = true;
     this._urlSync = new GroupByVariableUrlSyncHandler(this);
+    this._activationHandler = () => {
+      if (this.state.defaultValue && (lodash.isArray(this.state.value) && !this.state.value.length || !this.state.value)) {
+        this.setState({
+          value: this.state.defaultValue.value,
+          text: this.state.defaultValue.text
+        });
+      }
+    };
     /**
      * Get possible keys given current filters. Do not call from plugins directly
      */
@@ -3139,6 +3265,7 @@ class GroupByVariable extends MultiValueVariable {
         return () => allActiveGroupByVariables.delete(this);
       });
     }
+    this.addActivationHandler(this._activationHandler);
   }
   validateAndUpdate() {
     return this.getValueOptions({}).pipe(
@@ -3197,6 +3324,24 @@ class GroupByVariable extends MultiValueVariable {
       })
     );
   }
+  // This method is related to the defaultValue property. We check if the current value
+  // is different from the default value. If it is, the groupBy will show a button
+  // allowing the user to restore the default values.
+  checkIfRestorable(values) {
+    var _a, _b, _c, _d;
+    const originalValues = lodash.isArray((_a = this.state.defaultValue) == null ? void 0 : _a.value) ? (_b = this.state.defaultValue) == null ? void 0 : _b.value : ((_c = this.state.defaultValue) == null ? void 0 : _c.value) ? [(_d = this.state.defaultValue) == null ? void 0 : _d.value] : [];
+    const vals = lodash.isArray(values) ? values : [values];
+    if (vals.length !== originalValues.length) {
+      return true;
+    }
+    return !lodash.isEqual(vals, originalValues);
+  }
+  restoreDefaultValues() {
+    if (!this.state.defaultValue) {
+      return;
+    }
+    this.changeValueTo(this.state.defaultValue.value, this.state.defaultValue.text, true);
+  }
   /**
    * Allows clearing the value of the variable to an empty value. Overrides default behavior of a MultiValueVariable
    */
@@ -3215,7 +3360,8 @@ function GroupByVariableRenderer({ model }) {
     noValueOnClear,
     options,
     includeAll,
-    allowCustomValue = true
+    allowCustomValue = true,
+    defaultValue
   } = model.useState();
   const values = React.useMemo(() => {
     const arrayValue = lodash.isArray(value) ? value : [value];
@@ -3233,6 +3379,7 @@ function GroupByVariableRenderer({ model }) {
   const [inputValue, setInputValue] = React.useState("");
   const [uncommittedValue, setUncommittedValue] = React.useState(values);
   const optionSearcher = React.useMemo(() => getOptionSearcher(options, includeAll), [options, includeAll]);
+  const hasDefaultValue = defaultValue !== void 0;
   React.useEffect(() => {
     setUncommittedValue(values);
   }, [values]);
@@ -3260,7 +3407,7 @@ function GroupByVariableRenderer({ model }) {
       "aria-label": "Group by selector",
       "data-testid": `GroupBySelect-${key}`,
       id: key,
-      placeholder: "Select value",
+      placeholder: "Group by label",
       width: "auto",
       allowCustomValue,
       inputValue,
@@ -3276,7 +3423,12 @@ function GroupByVariableRenderer({ model }) {
       isClearable: true,
       hideSelectedOptions: false,
       isLoading: isFetchingOptions,
-      components: { Option: OptionWithCheckbox },
+      components: {
+        Option: OptionWithCheckbox,
+        ...hasDefaultValue ? {
+          IndicatorsContainer: () => /* @__PURE__ */ React__default.default.createElement(DefaultGroupByCustomIndicatorContainer, { model })
+        } : {}
+      },
       onInputChange,
       onBlur: () => {
         model.changeValueTo(
@@ -3307,7 +3459,7 @@ function GroupByVariableRenderer({ model }) {
       "aria-label": "Group by selector",
       "data-testid": `GroupBySelect-${key}`,
       id: key,
-      placeholder: "Select value",
+      placeholder: "Group by label",
       width: "auto",
       inputValue,
       value: uncommittedValue && uncommittedValue.length > 0 ? uncommittedValue : null,