@grafana/scenes 6.10.4 → 6.11.0--canary.1121.15019988505.0

package/dist/index.d.ts

@@ -1,13 +1,13 @@
 import * as _grafana_data from '@grafana/data';
-import { BusEventWithPayload, EventBus, BusEvent, BusEventType, BusEventHandler, PanelMenuItem, FieldConfigSource, PanelPlugin, AbsoluteTimeRange, PanelData, InterpolateFunction, PanelModel, TimeRange, DataTransformContext, DataFrame, DataQueryRequest, DataSourceGetTagKeysOptions, DataSourceGetTagValuesOptions, Scope, IconName, PageLayoutType, UrlQueryMap, DataQuery as DataQuery$1, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, GetTagResponse, MetricFindValue, SelectableValue, VariableRefresh as VariableRefresh$1, VariableSort, EventFilterOptions, AnnotationEvent, AnnotationQuery, DataTransformerConfig, TimeOption, FieldConfig, FieldType, FieldValueMatcherConfig, ScopedVar, RawTimeRange } from '@grafana/data';
+import { BusEventWithPayload, EventBus, BusEvent, BusEventType, BusEventHandler, PanelMenuItem, FieldConfigSource, PanelPlugin, AbsoluteTimeRange, PanelData, InterpolateFunction, PanelModel, TimeRange, DataTransformContext, DataFrame, DataQueryRequest, DataSourceGetTagKeysOptions, DataSourceGetTagValuesOptions, IconName, PageLayoutType, UrlQueryMap, DataQuery as DataQuery$1, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, GetTagResponse, MetricFindValue, SelectableValue, VariableRefresh as VariableRefresh$1, VariableSort, Scope, EventFilterOptions, AnnotationEvent, AnnotationQuery, DataTransformerConfig, TimeOption, FieldConfig, FieldType, FieldValueMatcherConfig, ScopedVar, RawTimeRange } from '@grafana/data';
 import * as React$1 from 'react';
-import React__default, { ComponentType, CSSProperties, PointerEvent, ForwardRefExoticComponent } from 'react';
+import React__default, { ComponentType, ReactNode, CSSProperties, PointerEvent, ForwardRefExoticComponent } from 'react';
 import * as rxjs from 'rxjs';
 import { Observable, Subscription, Unsubscribable, MonoTypeOperatorFunction, ReplaySubject } from 'rxjs';
 import * as _grafana_schema from '@grafana/schema';
 import { VariableType, VariableHide, TimeZone, DataQuery, DataTopic, DataSourceRef, VariableRefresh, LoadingState, DashboardCursorSync, MatcherConfig, TableFieldOptions } from '@grafana/schema';
 import { PanelContext, WeekStart, IconName as IconName$1 } from '@grafana/ui';
-import { ScopesContextValue, LocationService, VariableInterpolation } from '@grafana/runtime';
+import { LocationService, VariableInterpolation, ScopesContextValue } from '@grafana/runtime';
 import { Location } from 'history';
 import ReactGridLayout from 'react-grid-layout';
 import { Options, FieldConfig as FieldConfig$1 } from '@grafana/schema/dist/esm/raw/composable/barchart/panelcfg/x/BarChartPanelCfg_types.gen';
@@ -63,6 +63,10 @@ interface SceneVariable<TState extends SceneVariableState = SceneVariableState>
      * Allows cancelling variable execution.
      */
     onCancel?(): void;
+    /**
+     * Edge case for variables that is hidden but wants to be render to access react contexts (ScopesVariable)
+     */
+    hiddenRender?(): React.ReactNode;
     /**
      * @experimental
      * Indicates that a variable loads values lazily when user interacts with the variable dropdown.
@@ -275,6 +279,10 @@ interface VariableDependencyConfigOptions<TState extends SceneObjectState> {
      * Handle time macros.
      */
     handleTimeMacros?: boolean;
+    /**
+     * Depends on scopes
+     */
+    dependsOnScopes?: boolean;
 }
 declare class VariableDependencyConfig<TState extends SceneObjectState> implements SceneVariableDependencyConfigLike {
     private _sceneObject;
@@ -650,36 +658,6 @@ declare class EmbeddedScene extends SceneObjectBase<EmbeddedSceneState> {
 }
 declare function EmbeddedSceneRenderer({ model }: SceneComponentProps<EmbeddedScene>): React__default.JSX.Element;
 
-declare class SceneScopesBridge extends SceneObjectBase {
-    static Component: typeof SceneScopesBridgeRenderer;
-    protected _renderBeforeActivation: boolean;
-    private _contextSubject;
-    getValue(): Scope[];
-    /**
-     * Emits values of the selected scopes array. It emits the current value and the previous value if there is a change.
-     * @param cb
-     */
-    subscribeToValue(cb: (newScopes: Scope[], prevScopes: Scope[]) => void): Unsubscribable;
-    isLoading(): boolean;
-    subscribeToLoading(cb: (loading: boolean) => void): Unsubscribable;
-    setEnabled(enabled: boolean): void;
-    setReadOnly(readOnly: boolean): void;
-    /**
-     * This method is used to keep the context up to date with the scopes context received from React
-     *
-     * Its rationale is:
-     *   - When a new context is available, check if we have pending scopes passed from the URL
-     *      - If we have pending scopes, ask the new context to load them
-     *      - The loading should happen in a setTimeout to allow the existing context to pass its values to the URL sync handler
-     *   - If a new context is received, propagate it as a new value in the behavior subject
-     *   - If a new value is received, force a re-render to trigger the URL sync handler
-     */
-    updateContext(newContext: ScopesContextValue | undefined): void;
-    private get context();
-    private get contextObservable();
-}
-declare function SceneScopesBridgeRenderer({ model }: SceneComponentProps<SceneScopesBridge>): null;
-
 interface SceneRouteMatch<Params extends {
     [K in keyof Params]?: string;
 } = {}> {
@@ -692,7 +670,6 @@ interface SceneAppState extends SceneObjectState {
     pages: SceneAppPageLike[];
     name?: string;
     urlSyncOptions?: SceneUrlSyncOptions;
-    scopesBridge?: SceneScopesBridge;
 }
 interface SceneAppRoute {
     path: string;
@@ -737,7 +714,6 @@ interface SceneAppPageState extends SceneObjectState {
      */
     getFallbackPage?: () => SceneAppPageLike;
     layout?: PageLayoutType;
-    useScopes?: boolean;
 }
 interface SceneAppPageLike extends SceneObject<SceneAppPageState>, DataRequestEnricher {
     initializeScene(scene: SceneObject): void;
@@ -965,8 +941,9 @@ declare class AdHocFiltersVariable extends SceneObjectBase<AdHocFiltersVariableS
     static Component: typeof AdHocFiltersVariableRenderer;
     private _scopedVars;
     private _dataSourceSrv;
-    private _scopesBridge;
     private _originalValues;
+    /** Needed for scopes dependency */
+    protected _variableDependency: VariableDependencyConfig<AdHocFiltersVariableState>;
     protected _urlSync: AdHocFiltersVariableUrlSyncHandler;
     constructor(state: Partial<AdHocFiltersVariableState>);
     private _activationHandler;
@@ -1219,7 +1196,6 @@ declare class GroupByVariable extends MultiValueVariable<GroupByVariableState> {
     static Component: typeof GroupByVariableRenderer;
     isLazy: boolean;
     protected _urlSync: SceneObjectUrlSyncHandler;
-    private _scopesBridge;
     validateAndUpdate(): Observable<ValidateAndUpdateResult>;
     private _updateValueGivenNewOptions;
     getValueOptions(args: VariableGetOptionsArgs): Observable<VariableValueOption[]>;
@@ -1416,9 +1392,9 @@ declare function getAncestor<ParentType>(sceneObject: SceneObject, ancestorType:
  */
 declare function findDescendents<T extends SceneObject>(scene: SceneObject, descendentType: SceneType<T>): T[];
 /**
- * Will walk up the scene object graph to the closest $scopesBridge scene object
+ * Will return the scopes from the scopes variable if available.
  */
-declare function getScopesBridge(sceneObject: SceneObject): SceneScopesBridge | undefined;
+declare function getScopes(sceneObject: SceneObject): Scope[] | undefined;
 
 declare const sceneGraph: {
     getVariables: typeof getVariables;
@@ -1436,7 +1412,7 @@ declare const sceneGraph: {
     getAncestor: typeof getAncestor;
     getQueryController: typeof getQueryController;
     findDescendents: typeof findDescendents;
-    getScopesBridge: typeof getScopesBridge;
+    getScopes: typeof getScopes;
 };
 
 interface ActWhenVariableChangedState extends SceneObjectState {
@@ -1703,8 +1679,6 @@ declare class SceneQueryRunner extends SceneObjectBase<QueryRunnerState> impleme
     private _dataLayersMerger;
     private _timeSub?;
     private _timeSubRange?;
-    private _scopesSub?;
-    private _scopesSubBridge?;
     private _containerWidth?;
     private _variableValueRecorder;
     private _results;
@@ -1743,12 +1717,11 @@ declare class SceneQueryRunner extends SceneObjectBase<QueryRunnerState> impleme
     private _onDeactivate;
     setContainerWidth(width: number): void;
     isDataReadyToDisplay(): boolean;
-    private subscribeToScopesChanges;
     private subscribeToTimeRangeChanges;
     runQueries(): void;
     private getMaxDataPoints;
     cancelQuery(): void;
-    private runWithTimeRangeAndScopes;
+    private runWithTimeRange;
     clone(withState?: Partial<QueryRunnerState>): this;
     private prepareRequests;
     private onDataReceived;
@@ -1883,7 +1856,7 @@ interface VariableSelectProps {
     /** To provide an option to hide the label in the variable value selector */
     hideLabel?: boolean;
 }
-declare function VariableValueSelectWrapper({ variable, layout, showAlways, hideLabel }: VariableSelectProps): React__default.JSX.Element | null;
+declare function VariableValueSelectWrapper({ variable, layout, showAlways, hideLabel }: VariableSelectProps): string | number | boolean | React__default.JSX.Element | Iterable<React__default.ReactNode> | null | undefined;
 
 interface VariableValueControlState extends SceneObjectState {
     layout?: ControlsLayout;
@@ -1898,8 +1871,6 @@ declare class VariableValueControl extends SceneObjectBase<VariableValueControlS
 declare function VariableValueControlRenderer({ model }: SceneComponentProps<VariableValueControl>): React__default.JSX.Element | null;
 
 declare class SceneVariableSet extends SceneObjectBase<SceneVariableSetState> implements SceneVariables {
-    /** Variables that have changed in since the activation or since the first manual value change */
-    private _variablesThatHaveChanged;
     /** Variables that are scheduled to be validated and updated */
     private _variablesToUpdate;
     /** Variables currently updating  */
@@ -2002,6 +1973,41 @@ declare class TestVariable extends MultiValueVariable<TestVariableState> {
     static Component: ({ model }: SceneComponentProps<MultiValueVariable>) => React__default.JSX.Element;
 }
 
+interface ScopesVariableState extends SceneVariableState {
+    /**
+     * Last captured state from ScopesContext
+     */
+    scopes: Scope[];
+    /**
+     * Set to true if you want to the variable to enable / disable scopes when activated / deactivated
+     */
+    enable?: boolean;
+}
+declare class ScopesVariable extends SceneObjectBase<ScopesVariableState> implements SceneVariable<ScopesVariableState> {
+    protected _renderBeforeActivation: boolean;
+    protected _context: ScopesContextValue | undefined;
+    constructor(state: Partial<ScopesVariableState>);
+    /**
+     * Temporary simple implementation to stringify the scopes.
+     */
+    getValue(fieldPath: string): VariableValue;
+    getScopes(): Scope[] | undefined;
+    /**
+     * This method is used to keep the context up to date with the scopes context received from React
+     * 1) Subscribes to ScopesContext state changes and synchronizes it with the variable state
+     * 2) Handles enable / disabling of scopes based on variable enable option.
+     */
+    setContext(context: ScopesContextValue | undefined): (() => void) | undefined;
+    updateStateFromContext(state: {
+        loading: boolean;
+        value: Scope[];
+    }): void;
+    /**
+     * Special function that enables variables to be hidden but still render to access react contexts
+     */
+    hiddenRender(): ReactNode;
+}
+
 interface LocalValueVariableState extends SceneVariableState {
     value: VariableValue;
     text: VariableValue;
@@ -2106,6 +2112,7 @@ interface SceneTimePickerState extends SceneObjectState {
     hidePicker?: boolean;
     isOnCanvas?: boolean;
     quickRanges?: TimeOption[];
+    defaultQuickRanges?: TimeOption[];
 }
 declare class SceneTimePicker extends SceneObjectBase<SceneTimePickerState> {
     static Component: typeof SceneTimePickerRenderer;
@@ -2490,9 +2497,6 @@ declare class SceneAppPage extends SceneObjectBase<SceneAppPageState> implements
     static Component: typeof SceneAppPageRenderer;
     private _sceneCache;
     private _drilldownCache;
-    private _scopesBridge;
-    constructor(state: SceneAppPageState);
-    private _activationHandler;
     initializeScene(scene: EmbeddedScene): void;
     getScene(routeMatch: SceneRouteMatch): EmbeddedScene;
     getDrilldownPage(drilldown: SceneAppDrilldownView, routeMatch: SceneRouteMatch<{}>): SceneAppPageLike;
@@ -3027,5 +3031,5 @@ declare const sceneUtils: {
     isGroupByVariable: typeof isGroupByVariable;
 };
 
-export { AdHocFiltersVariable, ConstantVariable, ControlsLabel, CustomVariable, DataProviderProxy, DataSourceVariable, EmbeddedScene, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, GroupByVariable, IntervalVariable, LazyLoader, LocalValueVariable, MultiOrSingleValueSelect, MultiValueVariable, NestedScene, NewSceneObjectAddedEvent, PanelBuilders, PanelOptionsBuilders, QueryVariable, RuntimeDataSource, SafeSerializableSceneObject, SceneApp, SceneAppPage, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerSet, SceneDataLayerSetBase, SceneDataNode, SceneDataTransformer, SceneDebugger, SceneFlexItem, SceneFlexLayout, SceneGridItem, SceneGridLayout, SceneGridLayoutDragStartEvent, SceneGridRow, SceneObjectBase, SceneObjectRef, SceneObjectStateChangedEvent, SceneObjectUrlSyncConfig, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneScopesBridge, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariableSet, SceneVariableValueChangedEvent, SplitLayout, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UserActionEvent, VariableDependencyConfig, VariableValueControl, VariableValueSelectWrapper, VariableValueSelectors, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelExploreButton, VizPanelMenu, index$1 as behaviors, index as dataLayers, formatRegistry, getExploreURL, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync };
+export { AdHocFiltersVariable, ConstantVariable, ControlsLabel, CustomVariable, DataProviderProxy, DataSourceVariable, EmbeddedScene, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, GroupByVariable, IntervalVariable, LazyLoader, LocalValueVariable, MultiOrSingleValueSelect, MultiValueVariable, NestedScene, NewSceneObjectAddedEvent, PanelBuilders, PanelOptionsBuilders, QueryVariable, RuntimeDataSource, SafeSerializableSceneObject, SceneApp, SceneAppPage, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerSet, SceneDataLayerSetBase, SceneDataNode, SceneDataTransformer, SceneDebugger, SceneFlexItem, SceneFlexLayout, SceneGridItem, SceneGridLayout, SceneGridLayoutDragStartEvent, SceneGridRow, SceneObjectBase, SceneObjectRef, SceneObjectStateChangedEvent, SceneObjectUrlSyncConfig, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariableSet, SceneVariableValueChangedEvent, ScopesVariable, SplitLayout, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UserActionEvent, VariableDependencyConfig, VariableValueControl, VariableValueSelectWrapper, VariableValueSelectors, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelExploreButton, VizPanelMenu, index$1 as behaviors, index as dataLayers, formatRegistry, getExploreURL, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync };
 export type { AdHocFilterWithLabels, CancelActivationHandler, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariableValue, DataLayerFilter, DataRequestEnricher, DeepPartial, EmbeddedSceneState, ExtraQueryDataProcessor, ExtraQueryDescriptor, ExtraQueryProvider, FiltersRequestEnricher, FormatVariable, InterpolationFormatParameter, MacroVariableConstructor, MultiValueVariableState, QueryRunnerState, SceneActivationHandler, SceneAppDrilldownView, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneComponent, SceneComponentProps, SceneDataLayerProvider, SceneDataLayerProviderState, SceneDataProvider, SceneDataProviderResult, SceneDataQuery, SceneDataState, SceneDataTransformerState, SceneDeactivationHandler, SceneFlexItemLike, SceneFlexItemState, SceneGridItemLike, SceneGridItemStateLike, SceneInteractionProfileEvent, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectState, SceneObjectStateChangedPayload, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryControllerEntry, SceneQueryControllerEntryType, SceneQueryControllerLike, SceneRefreshPickerState, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimeRangeLike, SceneTimeRangeState, SceneUrlSyncOptions, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSetState, SceneVariableState, SceneVariables, UrlSyncManagerLike, UseStateHookOptions, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableGetOptionsArgs, VariableValue, VariableValueOption, VariableValueSingle, VizConfig, VizPanelState };