@grafana/scenes 1.30.0 → 2.0.0

package/dist/esm/variables/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sources":["../../../src/variables/types.ts"],"sourcesContent":["import { Observable } from 'rxjs';\n\nimport { BusEventWithPayload } from '@grafana/data';\nimport { VariableType, VariableHide } from '@grafana/schema';\n\nimport { SceneObject, SceneObjectState } from '../core/types';\n\nexport interface SceneVariableState extends SceneObjectState {\n  type: VariableType;\n  name: string;\n  label?: string;\n  hide?: VariableHide;\n  skipUrlSync?: boolean;\n  loading?: boolean;\n  error?: any | null;\n  description?: string | null;\n}\n\nexport interface SceneVariable<TState extends SceneVariableState = SceneVariableState> extends SceneObject<TState> {\n  /**\n   * This function is called on activation or when a dependency changes.\n   */\n  validateAndUpdate?(): Observable<ValidateAndUpdateResult>;\n\n  /**\n   * Should return the value for the given field path\n   */\n  getValue(fieldPath?: string): VariableValue | undefined | null;\n\n  /**\n   * Should return the value display text, used by the \"text\" formatter\n   * Example: ${podId:text}\n   * Useful for variables that have non user friendly values but friendly display text names.\n   */\n  getValueText?(fieldPath?: string): string;\n\n  /**\n   * A special function that locally scoped variables can implement\n   **/\n  isAncestorLoading?(): boolean;\n\n  /**\n   * Allows cancelling variable execution.\n   */\n  onCancel?(): void;\n}\n\nexport type VariableValue = VariableValueSingle | VariableValueSingle[];\n\nexport type VariableValueSingle = string | boolean | number | CustomVariableValue;\n\n/**\n * This is for edge case values like the custom \"allValue\" that should not be escaped/formatted like other values\n * The custom all value usually contain wildcards that should not be escaped.\n */\nexport interface CustomVariableValue {\n  /**\n   * The format name or function used in the expression\n   */\n  formatter(formatNameOrFn?: string | VariableCustomFormatterFn): string;\n}\n\nexport interface ValidateAndUpdateResult {}\nexport interface VariableValueOption {\n  label: string;\n  value: VariableValueSingle;\n}\n\nexport interface SceneVariableSetState extends SceneObjectState {\n  variables: SceneVariable[];\n}\n\nexport interface SceneVariables extends SceneObject<SceneVariableSetState> {\n  /**\n   * Will look for and return variable matching name\n   */\n  getByName(name: string): SceneVariable | undefined;\n  /**\n   * Will return true if the variable is loading or waiting for an update to complete.\n   */\n  isVariableLoadingOrWaitingToUpdate(variable: SceneVariable): boolean;\n}\n\nexport class SceneVariableValueChangedEvent extends BusEventWithPayload<SceneVariable> {\n  public static type = 'scene-variable-changed-value';\n}\n\nexport interface SceneVariableDependencyConfigLike {\n  /** Return all variable names this object depend on */\n  getNames(): Set<string>;\n\n  /** Used to check for dependency on a specific variable */\n  hasDependencyOn(name: string): boolean;\n\n  /**\n   * Will be called when the VariableSet have completed an update process\n   **/\n  variableUpdatesCompleted(changedVariables: Set<SceneVariable>): void;\n}\n\n/**\n * Used in CustomFormatterFn\n */\nexport interface CustomFormatterVariable {\n  name: string;\n  type: VariableType;\n  multi?: boolean;\n  includeAll?: boolean;\n}\n\nexport type VariableCustomFormatterFn = (\n  value: unknown,\n  legacyVariableModel: Partial<CustomFormatterVariable>,\n  legacyDefaultFormatter?: VariableCustomFormatterFn\n) => string;\n\nexport type InterpolationFormatParameter = string | VariableCustomFormatterFn | undefined;\n\nexport function isCustomVariableValue(value: VariableValue): value is CustomVariableValue {\n  return typeof value === 'object' && 'formatter' in value;\n}\n"],"names":[],"mappings":";;AAmFO,MAAM,uCAAuC,mBAAmC,CAAA;AAEvF,CAAA;AAFa,8BAAA,CACG,IAAO,GAAA,8BAAA,CAAA;AAkChB,SAAS,sBAAsB,KAAoD,EAAA;AACxF,EAAO,OAAA,OAAO,KAAU,KAAA,QAAA,IAAY,WAAe,IAAA,KAAA,CAAA;AACrD;;;;"}
+{"version":3,"file":"types.js","sources":["../../../src/variables/types.ts"],"sourcesContent":["import { Observable } from 'rxjs';\n\nimport { BusEventWithPayload } from '@grafana/data';\nimport { VariableType, VariableHide } from '@grafana/schema';\n\nimport { SceneObject, SceneObjectState } from '../core/types';\n\nexport interface SceneVariableState extends SceneObjectState {\n  type: VariableType;\n  name: string;\n  label?: string;\n  hide?: VariableHide;\n  skipUrlSync?: boolean;\n  loading?: boolean;\n  error?: any | null;\n  description?: string | null;\n}\n\nexport interface SceneVariable<TState extends SceneVariableState = SceneVariableState> extends SceneObject<TState> {\n  /**\n   * This function is called on activation or when a dependency changes.\n   */\n  validateAndUpdate?(): Observable<ValidateAndUpdateResult>;\n\n  /**\n   * Should return the value for the given field path\n   */\n  getValue(fieldPath?: string): VariableValue | undefined | null;\n\n  /**\n   * Should return the value display text, used by the \"text\" formatter\n   * Example: ${podId:text}\n   * Useful for variables that have non user friendly values but friendly display text names.\n   */\n  getValueText?(fieldPath?: string): string;\n\n  /**\n   * A special function that locally scoped variables can implement\n   **/\n  isAncestorLoading?(): boolean;\n\n  /**\n   * Allows cancelling variable execution.\n   */\n  onCancel?(): void;\n}\n\nexport type VariableValue = VariableValueSingle | VariableValueSingle[];\n\nexport type VariableValueSingle = string | boolean | number | CustomVariableValue;\n\n/**\n * This is for edge case values like the custom \"allValue\" that should not be escaped/formatted like other values\n * The custom all value usually contain wildcards that should not be escaped.\n */\nexport interface CustomVariableValue {\n  /**\n   * The format name or function used in the expression\n   */\n  formatter(formatNameOrFn?: string | VariableCustomFormatterFn): string;\n}\n\nexport interface ValidateAndUpdateResult {}\nexport interface VariableValueOption {\n  label: string;\n  value: VariableValueSingle;\n}\n\nexport interface SceneVariableSetState extends SceneObjectState {\n  variables: SceneVariable[];\n}\n\nexport interface SceneVariables extends SceneObject<SceneVariableSetState> {\n  /**\n   * Will look for and return variable matching name\n   */\n  getByName(name: string): SceneVariable | undefined;\n  /**\n   * Will return true if the variable is loading or waiting for an update to complete.\n   */\n  isVariableLoadingOrWaitingToUpdate(variable: SceneVariable): boolean;\n}\n\nexport class SceneVariableValueChangedEvent extends BusEventWithPayload<SceneVariable> {\n  public static type = 'scene-variable-changed-value';\n}\n\nexport interface SceneVariableDependencyConfigLike {\n  /** Return all variable names this object depend on */\n  getNames(): Set<string>;\n\n  /** Used to check for dependency on a specific variable */\n  hasDependencyOn(name: string): boolean;\n\n  /**\n   * Will be called when the VariableSet have completed an update process or when a variable has changed value.\n   **/\n  variableUpdateCompleted(variable: SceneVariable, hasChanged: boolean): void;\n}\n\n/**\n * Used in CustomFormatterFn\n */\nexport interface CustomFormatterVariable {\n  name: string;\n  type: VariableType;\n  multi?: boolean;\n  includeAll?: boolean;\n}\n\nexport type VariableCustomFormatterFn = (\n  value: unknown,\n  legacyVariableModel: Partial<CustomFormatterVariable>,\n  legacyDefaultFormatter?: VariableCustomFormatterFn\n) => string;\n\nexport type InterpolationFormatParameter = string | VariableCustomFormatterFn | undefined;\n\nexport function isCustomVariableValue(value: VariableValue): value is CustomVariableValue {\n  return typeof value === 'object' && 'formatter' in value;\n}\n"],"names":[],"mappings":";;AAmFO,MAAM,uCAAuC,mBAAmC,CAAA;AAEvF,CAAA;AAFa,8BAAA,CACG,IAAO,GAAA,8BAAA,CAAA;AAkChB,SAAS,sBAAsB,KAAoD,EAAA;AACxF,EAAO,OAAA,OAAO,KAAU,KAAA,QAAA,IAAY,WAAe,IAAA,KAAA,CAAA;AACrD;;;;"}

package/dist/index.d.ts

@@ -102,9 +102,9 @@ interface SceneVariableDependencyConfigLike {
     /** Used to check for dependency on a specific variable */
     hasDependencyOn(name: string): boolean;
     /**
-     * Will be called when the VariableSet have completed an update process
+     * Will be called when the VariableSet have completed an update process or when a variable has changed value.
      **/
-    variableUpdatesCompleted(changedVariables: Set<SceneVariable>): void;
+    variableUpdateCompleted(variable: SceneVariable, hasChanged: boolean): void;
 }
 /**
  * Used in CustomFormatterFn
@@ -279,7 +279,6 @@ interface SceneDataLayerProviderState extends SceneObjectState {
     data?: PanelData;
     isEnabled?: boolean;
     isHidden?: boolean;
-    _isWaitingForVariables?: boolean;
 }
 interface SceneDataLayerProvider extends SceneObject<SceneDataLayerProviderState> {
     topic: DataTopic;
@@ -412,6 +411,17 @@ interface RuntimeDataSourceOptions {
  */
 declare function registerRuntimeDataSource({ dataSource }: RuntimeDataSourceOptions): void;
 
+/**
+ * @param root
+ * @returns the full scene url state as a object with keys and values
+ */
+declare function getUrlState(root: SceneObject): SceneObjectUrlValues;
+/**
+ * Exported util function to sync state from an initial url state.
+ * Useful for initializing an embedded scenes with a url state string.
+ */
+declare function syncStateFromSearchParams(root: SceneObject, urlParams: URLSearchParams): void;
+
 interface FormatRegistryItem extends RegistryItem {
     formatter(value: VariableValue, args: string[], variable: FormatVariable): string;
 }
@@ -559,11 +569,14 @@ interface VariableDependencyConfigOptions<TState extends SceneObjectState> {
      * Optional way to customize how to handle when a dependent variable changes
      * If not specified the default behavior is to trigger a re-render
      */
-    onReferencedVariableValueChanged?: () => void;
+    onReferencedVariableValueChanged?: (variable: SceneVariable) => void;
     /**
-     * Optional way to customize how to handle when the variable system has completed an update
+     * Two scenarios trigger this callback to be called.
+     * 1. When any direct dependency changed value
+     * 2. In case hasDependencyInLoadingState was called and returned true we really care about any variable update. So in this scenario this callback is called
+     *    after any variable update completes. This is to cover scenarios where an object is waiting for indirect dependencies to complete.
      */
-    onVariableUpdatesCompleted?: (changedVariables: Set<SceneVariable>, dependencyChanged: boolean) => void;
+    onVariableUpdateCompleted?: () => void;
 }
 declare class VariableDependencyConfig<TState extends SceneObjectState> implements SceneVariableDependencyConfigLike {
     private _sceneObject;
@@ -571,6 +584,7 @@ declare class VariableDependencyConfig<TState extends SceneObjectState> implemen
     private _state;
     private _dependencies;
     private _statePaths?;
+    private _isWaitingForVariables;
     scanCount: number;
     constructor(_sceneObject: SceneObject<TState>, _options: VariableDependencyConfigOptions<TState>);
     /**
@@ -580,11 +594,8 @@ declare class VariableDependencyConfig<TState extends SceneObjectState> implemen
     /**
      * This is called whenever any set of variables have new values. It up to this implementation to check if it's relevant given the current dependencies.
      */
-    variableUpdatesCompleted(changedVariables: Set<SceneVariable>): void;
-    /**
-     * Only way to force a re-render is to update state right now
-     */
-    private defaultHandlerReferencedVariableValueChanged;
+    variableUpdateCompleted(variable: SceneVariable, hasChanged: boolean): void;
+    hasDependencyInLoadingState(): boolean;
     getNames(): Set<string>;
     setPaths(paths: Array<keyof TState>): void;
     private scanStateForDependencies;
@@ -723,7 +734,6 @@ interface QueryRunnerState extends SceneObjectState {
     liveStreaming?: boolean;
     maxDataPointsFromWidth?: boolean;
     dataLayerFilter?: DataLayerFilter;
-    _isWaitingForVariables?: boolean;
     _hasFetchedData?: boolean;
 }
 interface DataQueryExtended extends DataQuery$1 {
@@ -747,8 +757,17 @@ declare class SceneQueryRunner extends SceneObjectBase<QueryRunnerState> impleme
     private _handleDataLayers;
     private _onLayersReceived;
     /**
-     * Handles some tricky cases where we need to run queries even when they have not changed in case
-     * the query execution on activate was stopped due to VariableSet still not having processed all variables.
+     * This tries to start a new query whenever a variable completes or is changed.
+     *
+     * We care about variable update completions even when the variable has not changed and even when it is not a direct dependency.
+     * Example: Variables A and B (B depends on A). A update depends on time range. So when time change query runner will
+     * find that variable A is loading which is a dependency on of variable B so will set _isWaitingForVariables to true and
+     * not issue any query.
+     *
+     * When A completes it's loading (with no value change, so B never updates) it will cause a call of this function letting
+     * the query runner know that A has completed, and in case _isWaitingForVariables we try to run the query. The query will
+     * only run if all variables are in a non loading state so in other scenarios where a query depends on many variables this will
+     * be called many times until all dependencies are in a non loading state.   *
      */
     private onVariableUpdatesCompleted;
     private shouldRunQueriesOnActivate;
@@ -976,7 +995,7 @@ declare abstract class SceneDataLayerBase<T extends SceneDataLayerProviderState>
     constructor(initialState: T, variableDependencyStatePaths?: Array<keyof T>);
     protected onActivate(): CancelActivationHandler;
     protected onDeactivate(): void;
-    protected onVariableUpdatesCompleted(variables: Set<SceneVariable>, dependencyChanged: boolean): void;
+    protected onVariableUpdateCompleted(): void;
     cancelQuery(): void;
     protected publishResults(data: PanelData, topic: DataTopic): void;
     getResultsStream(): ReplaySubject<SceneDataLayerProviderResult>;
@@ -1223,11 +1242,11 @@ declare class SceneVariableSet extends SceneObjectBase<SceneVariableSetState> im
 }
 declare class SceneVariableSetVariableDependencyHandler implements SceneVariableDependencyConfigLike {
     private _variableUpdatesCompleted;
-    constructor(_variableUpdatesCompleted: (changedVariables: Set<SceneVariable>) => void);
+    constructor(_variableUpdatesCompleted: (variable: SceneVariable, hasChanged: boolean) => void);
     private _emptySet;
     getNames(): Set<string>;
     hasDependencyOn(name: string): boolean;
-    variableUpdatesCompleted(changedVariables: Set<SceneVariable>): void;
+    variableUpdateCompleted(variable: SceneVariable, hasChanged: boolean): void;
 }
 
 interface TestVariableState extends MultiValueVariableState {
@@ -1280,6 +1299,22 @@ interface UrlSyncManagerLike {
     cleanUp(root: SceneObject): void;
     getUrlState(root: SceneObject): SceneObjectUrlValues;
 }
+declare class UrlSyncManager implements UrlSyncManagerLike {
+    private _urlKeyMapper;
+    private _sceneRoot;
+    private _stateSub;
+    private _locationSub?;
+    private _lastPath?;
+    /**
+     * Updates the current scene state to match URL state.
+     */
+    initSync(root: SceneObject): void;
+    cleanUp(root: SceneObject): void;
+    syncFrom(sceneObj: SceneObject): void;
+    private _onLocationUpdate;
+    private _onStateChanged;
+    getUrlState(root: SceneObject): SceneObjectUrlValues;
+}
 declare function getUrlSyncManager(): UrlSyncManagerLike;
 
 interface EmbeddedSceneState extends SceneObjectState {
@@ -2192,6 +2227,8 @@ declare const sceneUtils: {
     registerRuntimeDataSource: typeof registerRuntimeDataSource;
     registerVariableMacro: typeof registerVariableMacro;
     cloneSceneObjectState: typeof cloneSceneObjectState;
+    syncStateFromSearchParams: typeof syncStateFromSearchParams;
+    getUrlState: typeof getUrlState;
     renderPrometheusLabelFilters: typeof renderPrometheusLabelFilters;
     isAdHocVariable: typeof isAdHocVariable;
     isConstantVariable: typeof isConstantVariable;
@@ -2202,4 +2239,4 @@ declare const sceneUtils: {
     isTextBoxVariable: typeof isTextBoxVariable;
 };
 
-export { AdHocFilterSet, AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomVariable, CustomVariableValue, DataLayerFilter, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, FieldConfigBuilders, FormatVariable, InterpolationFormatParameter, IntervalVariable, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, NestedScene, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderResult, SceneDataLayerProviderState, SceneDataLayers, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataProviderResultLike, SceneDataState, SceneDataTransformer, SceneDeactivationHandler, SceneDebugger, SceneFlexItem, SceneFlexItemLike, SceneFlexItemState, SceneFlexLayout, SceneGridItem, SceneGridItemLike, SceneGridItemStateLike, SceneGridLayout, SceneGridRow, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncManagerLike as UrlSyncManager, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableValue, VariableValueOption, VariableValueSelectors, VariableValueSingle, VizPanel, VizPanelBuilder, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getUrlSyncManager, isCustomVariableValue, isDataRequestEnricher, isSceneObject, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp };
+export { AdHocFilterSet, AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomVariable, CustomVariableValue, DataLayerFilter, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, FieldConfigBuilders, FormatVariable, InterpolationFormatParameter, IntervalVariable, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, NestedScene, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderResult, SceneDataLayerProviderState, SceneDataLayers, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataProviderResultLike, SceneDataState, SceneDataTransformer, SceneDeactivationHandler, SceneDebugger, SceneFlexItem, SceneFlexItemLike, SceneFlexItemState, SceneFlexLayout, SceneGridItem, SceneGridItemLike, SceneGridItemStateLike, SceneGridLayout, SceneGridRow, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncManager, UrlSyncManagerLike, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableValue, VariableValueOption, VariableValueSelectors, VariableValueSingle, VizPanel, VizPanelBuilder, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getUrlSyncManager, isCustomVariableValue, isDataRequestEnricher, isSceneObject, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp };