@grafana/scenes 2.2.1 → 2.2.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v2.2.2 (Wed Jan 31 2024)
+
+#### 🐛 Bug Fix
+
+- AdHocFiltersVariable: The `create()` factory supports `applyMode` as parameter [#553](https://github.com/grafana/scenes/pull/553) ([@ivanortegaalba](https://github.com/ivanortegaalba))
+
+#### Authors: 1
+
+- Ivan Ortega Alba ([@ivanortegaalba](https://github.com/ivanortegaalba))
+
+---
+
 # v2.2.1 (Tue Jan 30 2024)
 
 #### 🐛 Bug Fix

package/dist/esm/variables/adhoc/AdHocFiltersVariable.js

@@ -31,9 +31,9 @@ const _AdHocFiltersVariable = class extends SceneObjectBase {
       type: "adhoc",
       hide: VariableHide.hideLabel,
       name: (_a = state.name) != null ? _a : "Filters",
-      set: new AdHocFilterSet(__spreadProps(__spreadValues({}, state), {
+      set: new AdHocFilterSet(__spreadValues({
         applyMode: "manual"
-      }))
+      }, state))
     });
   }
   constructor(state) {

package/dist/esm/variables/adhoc/AdHocFiltersVariable.js.map

@@ -1 +1 @@
-{"version":3,"file":"AdHocFiltersVariable.js","sources":["../../../../src/variables/adhoc/AdHocFiltersVariable.tsx"],"sourcesContent":["import React from 'react';\nimport { AdHocVariableFilter } from '@grafana/data';\nimport { SceneObjectBase } from '../../core/SceneObjectBase';\nimport { SceneVariable, SceneVariableState, SceneVariableValueChangedEvent, VariableValue } from '../types';\nimport { AdHocFilterSet, AdHocFilterSetState } from './AdHocFiltersSet';\nimport { SceneComponentProps } from '../../core/types';\nimport { VariableHide } from '@grafana/schema';\nimport { renderPrometheusLabelFilters } from '../utils';\n\nexport interface AdHocFiltersVariableState extends SceneVariableState {\n  /**\n   * Important that you set applyFiltersTo: 'manual' when you create the set.\n   */\n  set: AdHocFilterSet;\n  /**\n   * This is the expression that the filters resulted in. Defaults to\n   * Prometheus / Loki compatible label fitler expression\n   */\n  filterExpression?: string;\n}\n\nexport type AdHocFiltersVariableCreateHelperArgs = Pick<\n  AdHocFilterSetState,\n  | 'name'\n  | 'filters'\n  | 'baseFilters'\n  | 'datasource'\n  | 'tagKeyRegexFilter'\n  | 'getTagKeysProvider'\n  | 'getTagValuesProvider'\n  | 'name'\n  | 'layout'\n>;\n\nexport class AdHocFiltersVariable\n  extends SceneObjectBase<AdHocFiltersVariableState>\n  implements SceneVariable<AdHocFiltersVariableState>\n{\n  /** Helper factory function that makes sure AdHocFilterSet is created correctly  */\n  public static create(state: AdHocFiltersVariableCreateHelperArgs): AdHocFiltersVariable {\n    return new AdHocFiltersVariable({\n      type: 'adhoc',\n      hide: VariableHide.hideLabel,\n      name: state.name ?? 'Filters',\n      set: new AdHocFilterSet({\n        ...state,\n        // Main reason for this helper factory functyion\n        applyMode: 'manual',\n      }),\n    });\n  }\n\n  public constructor(state: AdHocFiltersVariableState) {\n    super({\n      ...state,\n      filterExpression: state.filterExpression ?? renderPrometheusLabelFilters(state.set.state.filters),\n    });\n\n    // Subscribe to filter changes and up the variable value (filterExpression)\n    this.addActivationHandler(() => {\n      this._subs.add(\n        this.state.set.subscribeToState((newState, prevState) => {\n          if (newState.filters !== prevState.filters) {\n            this._updateFilterExpression(newState.filters, true);\n          }\n        })\n      );\n\n      this._updateFilterExpression(this.state.set.state.filters, false);\n    });\n  }\n\n  public getValue(): VariableValue | undefined {\n    return this.state.filterExpression;\n  }\n\n  private _updateFilterExpression(filters: AdHocVariableFilter[], publishEvent: boolean) {\n    let expr = renderPrometheusLabelFilters(filters);\n\n    if (expr === this.state.filterExpression) {\n      return;\n    }\n\n    this.setState({ filterExpression: expr });\n\n    if (publishEvent) {\n      this.publishEvent(new SceneVariableValueChangedEvent(this), true);\n    }\n  }\n\n  // Same UI as the standalone AdHocFilterSet\n  public static Component = ({ model }: SceneComponentProps<AdHocFiltersVariable>) => {\n    return <model.state.set.Component model={model.state.set} />;\n  };\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAkCO,MAAM,qBAAA,GAAN,cACG,eAEV,CAAA;AAAA,EAEE,OAAc,OAAO,KAAmE,EAAA;AAvC1F,IAAA,IAAA,EAAA,CAAA;AAwCI,IAAA,OAAO,IAAI,qBAAqB,CAAA;AAAA,MAC9B,IAAM,EAAA,OAAA;AAAA,MACN,MAAM,YAAa,CAAA,SAAA;AAAA,MACnB,IAAA,EAAA,CAAM,EAAM,GAAA,KAAA,CAAA,IAAA,KAAN,IAAc,GAAA,EAAA,GAAA,SAAA;AAAA,MACpB,GAAK,EAAA,IAAI,cAAe,CAAA,aAAA,CAAA,cAAA,CAAA,EAAA,EACnB,KADmB,CAAA,EAAA;AAAA,QAGtB,SAAW,EAAA,QAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AAAA,EAEO,YAAY,KAAkC,EAAA;AApDvD,IAAA,IAAA,EAAA,CAAA;AAqDI,IAAA,KAAA,CAAM,iCACD,KADC,CAAA,EAAA;AAAA,MAEJ,gBAAA,EAAA,CAAkB,WAAM,gBAAN,KAAA,IAAA,GAAA,EAAA,GAA0B,6BAA6B,KAAM,CAAA,GAAA,CAAI,MAAM,OAAO,CAAA;AAAA,KACjG,CAAA,CAAA,CAAA;AAGD,IAAA,IAAA,CAAK,qBAAqB,MAAM;AAC9B,MAAA,IAAA,CAAK,KAAM,CAAA,GAAA;AAAA,QACT,KAAK,KAAM,CAAA,GAAA,CAAI,gBAAiB,CAAA,CAAC,UAAU,SAAc,KAAA;AACvD,UAAI,IAAA,QAAA,CAAS,OAAY,KAAA,SAAA,CAAU,OAAS,EAAA;AAC1C,YAAK,IAAA,CAAA,uBAAA,CAAwB,QAAS,CAAA,OAAA,EAAS,IAAI,CAAA,CAAA;AAAA,WACrD;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AAEA,MAAA,IAAA,CAAK,wBAAwB,IAAK,CAAA,KAAA,CAAM,GAAI,CAAA,KAAA,CAAM,SAAS,KAAK,CAAA,CAAA;AAAA,KACjE,CAAA,CAAA;AAAA,GACH;AAAA,EAEO,QAAsC,GAAA;AAC3C,IAAA,OAAO,KAAK,KAAM,CAAA,gBAAA,CAAA;AAAA,GACpB;AAAA,EAEQ,uBAAA,CAAwB,SAAgC,YAAuB,EAAA;AACrF,IAAI,IAAA,IAAA,GAAO,6BAA6B,OAAO,CAAA,CAAA;AAE/C,IAAI,IAAA,IAAA,KAAS,IAAK,CAAA,KAAA,CAAM,gBAAkB,EAAA;AACxC,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,QAAS,CAAA,EAAE,gBAAkB,EAAA,IAAA,EAAM,CAAA,CAAA;AAExC,IAAA,IAAI,YAAc,EAAA;AAChB,MAAA,IAAA,CAAK,YAAa,CAAA,IAAI,8BAA+B,CAAA,IAAI,GAAG,IAAI,CAAA,CAAA;AAAA,KAClE;AAAA,GACF;AAMF,CAAA,CAAA;AA5DO,IAAM,oBAAN,GAAA,sBAAA;AAAM,oBAAA,CAyDG,SAAY,GAAA,CAAC,EAAE,KAAA,EAAuD,KAAA;AAClF,EAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,KAAA,CAAM,KAAM,CAAA,GAAA,CAAI,SAAhB,EAAA;AAAA,IAA0B,KAAA,EAAO,MAAM,KAAM,CAAA,GAAA;AAAA,GAAK,CAAA,CAAA;AAC5D,CAAA;;;;"}
+{"version":3,"file":"AdHocFiltersVariable.js","sources":["../../../../src/variables/adhoc/AdHocFiltersVariable.tsx"],"sourcesContent":["import React from 'react';\nimport { AdHocVariableFilter } from '@grafana/data';\nimport { SceneObjectBase } from '../../core/SceneObjectBase';\nimport { SceneVariable, SceneVariableState, SceneVariableValueChangedEvent, VariableValue } from '../types';\nimport { AdHocFilterSet, AdHocFilterSetState } from './AdHocFiltersSet';\nimport { SceneComponentProps } from '../../core/types';\nimport { VariableHide } from '@grafana/schema';\nimport { renderPrometheusLabelFilters } from '../utils';\n\nexport interface AdHocFiltersVariableState extends SceneVariableState {\n  /**\n   * Important that you set applyFiltersTo: 'manual' when you create the set.\n   */\n  set: AdHocFilterSet;\n  /**\n   * This is the expression that the filters resulted in. Defaults to\n   * Prometheus / Loki compatible label fitler expression\n   */\n  filterExpression?: string;\n}\n\nexport type AdHocFiltersVariableCreateHelperArgs = Pick<\n  AdHocFilterSetState,\n  | 'name'\n  | 'filters'\n  | 'baseFilters'\n  | 'datasource'\n  | 'tagKeyRegexFilter'\n  | 'getTagKeysProvider'\n  | 'getTagValuesProvider'\n  | 'name'\n  | 'layout'\n  | 'applyMode'\n>;\n\nexport class AdHocFiltersVariable\n  extends SceneObjectBase<AdHocFiltersVariableState>\n  implements SceneVariable<AdHocFiltersVariableState>\n{\n  /** Helper factory function that makes sure AdHocFilterSet is created correctly  */\n  public static create(state: AdHocFiltersVariableCreateHelperArgs): AdHocFiltersVariable {\n    return new AdHocFiltersVariable({\n      type: 'adhoc',\n      hide: VariableHide.hideLabel,\n      name: state.name ?? 'Filters',\n      set: new AdHocFilterSet({\n        // The applyMode defaults to 'manual' when used through the variable as it is the most frecuent use case\n        applyMode: 'manual',\n        ...state,\n      }),\n    });\n  }\n\n  public constructor(state: AdHocFiltersVariableState) {\n    super({\n      ...state,\n      filterExpression: state.filterExpression ?? renderPrometheusLabelFilters(state.set.state.filters),\n    });\n\n    // Subscribe to filter changes and up the variable value (filterExpression)\n    this.addActivationHandler(() => {\n      this._subs.add(\n        this.state.set.subscribeToState((newState, prevState) => {\n          if (newState.filters !== prevState.filters) {\n            this._updateFilterExpression(newState.filters, true);\n          }\n        })\n      );\n\n      this._updateFilterExpression(this.state.set.state.filters, false);\n    });\n  }\n\n  public getValue(): VariableValue | undefined {\n    return this.state.filterExpression;\n  }\n\n  private _updateFilterExpression(filters: AdHocVariableFilter[], publishEvent: boolean) {\n    let expr = renderPrometheusLabelFilters(filters);\n\n    if (expr === this.state.filterExpression) {\n      return;\n    }\n\n    this.setState({ filterExpression: expr });\n\n    if (publishEvent) {\n      this.publishEvent(new SceneVariableValueChangedEvent(this), true);\n    }\n  }\n\n  // Same UI as the standalone AdHocFilterSet\n  public static Component = ({ model }: SceneComponentProps<AdHocFiltersVariable>) => {\n    return <model.state.set.Component model={model.state.set} />;\n  };\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAmCO,MAAM,qBAAA,GAAN,cACG,eAEV,CAAA;AAAA,EAEE,OAAc,OAAO,KAAmE,EAAA;AAxC1F,IAAA,IAAA,EAAA,CAAA;AAyCI,IAAA,OAAO,IAAI,qBAAqB,CAAA;AAAA,MAC9B,IAAM,EAAA,OAAA;AAAA,MACN,MAAM,YAAa,CAAA,SAAA;AAAA,MACnB,IAAA,EAAA,CAAM,EAAM,GAAA,KAAA,CAAA,IAAA,KAAN,IAAc,GAAA,EAAA,GAAA,SAAA;AAAA,MACpB,GAAA,EAAK,IAAI,cAAe,CAAA,cAAA,CAAA;AAAA,QAEtB,SAAW,EAAA,QAAA;AAAA,OAAA,EACR,KACJ,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AAAA,EAEO,YAAY,KAAkC,EAAA;AArDvD,IAAA,IAAA,EAAA,CAAA;AAsDI,IAAA,KAAA,CAAM,iCACD,KADC,CAAA,EAAA;AAAA,MAEJ,gBAAA,EAAA,CAAkB,WAAM,gBAAN,KAAA,IAAA,GAAA,EAAA,GAA0B,6BAA6B,KAAM,CAAA,GAAA,CAAI,MAAM,OAAO,CAAA;AAAA,KACjG,CAAA,CAAA,CAAA;AAGD,IAAA,IAAA,CAAK,qBAAqB,MAAM;AAC9B,MAAA,IAAA,CAAK,KAAM,CAAA,GAAA;AAAA,QACT,KAAK,KAAM,CAAA,GAAA,CAAI,gBAAiB,CAAA,CAAC,UAAU,SAAc,KAAA;AACvD,UAAI,IAAA,QAAA,CAAS,OAAY,KAAA,SAAA,CAAU,OAAS,EAAA;AAC1C,YAAK,IAAA,CAAA,uBAAA,CAAwB,QAAS,CAAA,OAAA,EAAS,IAAI,CAAA,CAAA;AAAA,WACrD;AAAA,SACD,CAAA;AAAA,OACH,CAAA;AAEA,MAAA,IAAA,CAAK,wBAAwB,IAAK,CAAA,KAAA,CAAM,GAAI,CAAA,KAAA,CAAM,SAAS,KAAK,CAAA,CAAA;AAAA,KACjE,CAAA,CAAA;AAAA,GACH;AAAA,EAEO,QAAsC,GAAA;AAC3C,IAAA,OAAO,KAAK,KAAM,CAAA,gBAAA,CAAA;AAAA,GACpB;AAAA,EAEQ,uBAAA,CAAwB,SAAgC,YAAuB,EAAA;AACrF,IAAI,IAAA,IAAA,GAAO,6BAA6B,OAAO,CAAA,CAAA;AAE/C,IAAI,IAAA,IAAA,KAAS,IAAK,CAAA,KAAA,CAAM,gBAAkB,EAAA;AACxC,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,QAAS,CAAA,EAAE,gBAAkB,EAAA,IAAA,EAAM,CAAA,CAAA;AAExC,IAAA,IAAI,YAAc,EAAA;AAChB,MAAA,IAAA,CAAK,YAAa,CAAA,IAAI,8BAA+B,CAAA,IAAI,GAAG,IAAI,CAAA,CAAA;AAAA,KAClE;AAAA,GACF;AAMF,CAAA,CAAA;AA5DO,IAAM,oBAAN,GAAA,sBAAA;AAAM,oBAAA,CAyDG,SAAY,GAAA,CAAC,EAAE,KAAA,EAAuD,KAAA;AAClF,EAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,KAAA,CAAM,KAAM,CAAA,GAAA,CAAI,SAAhB,EAAA;AAAA,IAA0B,KAAA,EAAO,MAAM,KAAM,CAAA,GAAA;AAAA,GAAK,CAAA,CAAA;AAC5D,CAAA;;;;"}

package/dist/index.d.ts

@@ -542,7 +542,7 @@ interface AdHocFiltersVariableState extends SceneVariableState {
      */
     filterExpression?: string;
 }
-type AdHocFiltersVariableCreateHelperArgs = Pick<AdHocFilterSetState, 'name' | 'filters' | 'baseFilters' | 'datasource' | 'tagKeyRegexFilter' | 'getTagKeysProvider' | 'getTagValuesProvider' | 'name' | 'layout'>;
+type AdHocFiltersVariableCreateHelperArgs = Pick<AdHocFilterSetState, 'name' | 'filters' | 'baseFilters' | 'datasource' | 'tagKeyRegexFilter' | 'getTagKeysProvider' | 'getTagValuesProvider' | 'name' | 'layout' | 'applyMode'>;
 declare class AdHocFiltersVariable extends SceneObjectBase<AdHocFiltersVariableState> implements SceneVariable<AdHocFiltersVariableState> {
     /** Helper factory function that makes sure AdHocFilterSet is created correctly  */
     static create(state: AdHocFiltersVariableCreateHelperArgs): AdHocFiltersVariable;

package/dist/index.js

@@ -5980,9 +5980,9 @@ const _AdHocFiltersVariable = class extends SceneObjectBase {
       type: "adhoc",
       hide: schema.VariableHide.hideLabel,
       name: (_a = state.name) != null ? _a : "Filters",
-      set: new AdHocFilterSet(__spreadProps$9(__spreadValues$d({}, state), {
+      set: new AdHocFilterSet(__spreadValues$d({
         applyMode: "manual"
-      }))
+      }, state))
     });
   }
   constructor(state) {