@grafana/scenes 6.2.1--canary.990.13570008543.0 → 6.2.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _grafana_data from '@grafana/data';
-import { BusEventWithPayload, EventBus, BusEvent, BusEventType, BusEventHandler, PanelMenuItem, FieldConfigSource, PanelModel, PanelPlugin, AbsoluteTimeRange, PanelData, InterpolateFunction, TimeRange, DataQueryRequest, DataSourceGetTagKeysOptions, DataSourceGetTagValuesOptions, DataTransformContext, DataFrame, Scope, IconName, PageLayoutType, UrlQueryMap, DataQuery as DataQuery$1, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, SelectableValue, MetricFindValue, GetTagResponse, 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, PanelModel, PanelPlugin, AbsoluteTimeRange, PanelData, InterpolateFunction, TimeRange, DataQueryRequest, DataSourceGetTagKeysOptions, DataSourceGetTagValuesOptions, DataTransformContext, DataFrame, IconName, PageLayoutType, UrlQueryMap, DataQuery as DataQuery$1, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, SelectableValue, MetricFindValue, GetTagResponse, VariableRefresh as VariableRefresh$1, VariableSort, 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 * as rxjs from 'rxjs';
@@ -7,7 +7,7 @@ import { Observable, Subscription, Unsubscribable, MonoTypeOperatorFunction, Rep
 import * as _grafana_schema from '@grafana/schema';
 import { VariableType, VariableHide, TimeZone, DataTopic, DataQuery, 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 } 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';
@@ -222,6 +222,11 @@ declare abstract class SceneObjectBase<TState extends SceneObjectState = SceneOb
     forEachChild(callback: (child: SceneObjectBase) => void): void;
     /** Returns a SceneObjectRef that will resolve to this object */
     getRef(): SceneObjectRef<this>;
+    toJSON(): {
+        type: any;
+        isActive: boolean;
+        state: TState;
+    };
 }
 /**
  * This hook is always returning model.state instead of a useState that remembers the last state emitted on the subject
@@ -645,51 +650,6 @@ declare class EmbeddedScene extends SceneObjectBase<EmbeddedSceneState> {
 }
 declare function EmbeddedSceneRenderer({ model }: SceneComponentProps<EmbeddedScene>): React__default.JSX.Element;
 
-interface SceneObjectUrlSyncConfigOptions {
-    keys: string[] | (() => string[]);
-}
-declare class SceneObjectUrlSyncConfig implements SceneObjectUrlSyncHandler {
-    private _sceneObject;
-    private _keys;
-    private _nextChangeShouldAddHistoryStep;
-    constructor(_sceneObject: SceneObjectWithUrlSync, _options: SceneObjectUrlSyncConfigOptions);
-    getKeys(): string[];
-    getUrlState(): SceneObjectUrlValues;
-    updateFromUrl(values: SceneObjectUrlValues): void;
-    shouldCreateHistoryStep(values: SceneObjectUrlValues): boolean;
-    performBrowserHistoryAction(callback: () => void): void;
-}
-
-declare class SceneScopesBridge extends SceneObjectBase implements SceneObjectWithUrlSync {
-    static Component: typeof SceneScopesBridgeRenderer;
-    protected _urlSync: SceneObjectUrlSyncConfig;
-    protected _renderBeforeActivation: boolean;
-    private _contextSubject;
-    private _pendingScopes;
-    getUrlState(): SceneObjectUrlValues;
-    updateFromUrl(values: SceneObjectUrlValues): void;
-    getValue(): Scope[];
-    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;
 } = {}> {
@@ -702,7 +662,6 @@ interface SceneAppState extends SceneObjectState {
     pages: SceneAppPageLike[];
     name?: string;
     urlSyncOptions?: SceneUrlSyncOptions;
-    scopesBridge?: SceneScopesBridge;
 }
 interface SceneAppRoute {
     path: string;
@@ -747,7 +706,6 @@ interface SceneAppPageState extends SceneObjectState {
      */
     getFallbackPage?: () => SceneAppPageLike;
     layout?: PageLayoutType;
-    useScopes?: boolean;
 }
 interface SceneAppPageLike extends SceneObject<SceneAppPageState>, DataRequestEnricher {
     initializeScene(scene: SceneObject): void;
@@ -975,10 +933,8 @@ declare class AdHocFiltersVariable extends SceneObjectBase<AdHocFiltersVariableS
     static Component: typeof AdHocFiltersVariableRenderer;
     private _scopedVars;
     private _dataSourceSrv;
-    private _scopesBridge;
     protected _urlSync: AdHocFiltersVariableUrlSyncHandler;
     constructor(state: Partial<AdHocFiltersVariableState>);
-    private _activationHandler;
     setState(update: Partial<AdHocFiltersVariableState>): void;
     /**
      * Updates the variable's `filters` and `filterExpression` state.
@@ -1219,7 +1175,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[]>;
@@ -1236,7 +1191,7 @@ declare class GroupByVariable extends MultiValueVariable<GroupByVariableState> {
         text: string[];
     };
 }
-declare function GroupByVariableRenderer({ model }: SceneComponentProps<GroupByVariable>): React__default.JSX.Element;
+declare function GroupByVariableRenderer({ model }: SceneComponentProps<MultiValueVariable>): React__default.JSX.Element;
 
 declare function isAdHocVariable(variable: SceneVariable): variable is AdHocFiltersVariable;
 declare function isConstantVariable(variable: SceneVariable): variable is ConstantVariable;
@@ -1415,10 +1370,6 @@ declare function getAncestor<ParentType>(sceneObject: SceneObject, ancestorType:
  * This will search down the full scene graph, looking for objects that match the provided descendentType type.
  */
 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
- */
-declare function getScopesBridge(sceneObject: SceneObject): SceneScopesBridge | undefined;
 
 declare const sceneGraph: {
     getVariables: typeof getVariables;
@@ -1436,7 +1387,6 @@ declare const sceneGraph: {
     getAncestor: typeof getAncestor;
     getQueryController: typeof getQueryController;
     findDescendents: typeof findDescendents;
-    getScopesBridge: typeof getScopesBridge;
 };
 
 interface ActWhenVariableChangedState extends SceneObjectState {
@@ -1614,6 +1564,21 @@ declare class SceneDataNode extends SceneObjectBase<SceneDataNodeState> implemen
     getResultsStream(): rxjs.Observable<SceneDataProviderResult>;
 }
 
+interface SceneObjectUrlSyncConfigOptions {
+    keys: string[] | (() => string[]);
+}
+declare class SceneObjectUrlSyncConfig implements SceneObjectUrlSyncHandler {
+    private _sceneObject;
+    private _keys;
+    private _nextChangeShouldAddHistoryStep;
+    constructor(_sceneObject: SceneObjectWithUrlSync, _options: SceneObjectUrlSyncConfigOptions);
+    getKeys(): string[];
+    getUrlState(): SceneObjectUrlValues;
+    updateFromUrl(values: SceneObjectUrlValues): void;
+    shouldCreateHistoryStep(values: SceneObjectUrlValues): boolean;
+    performBrowserHistoryAction(callback: () => void): void;
+}
+
 declare class SceneTimeRange extends SceneObjectBase<SceneTimeRangeState> implements SceneTimeRangeLike {
     protected _urlSync: SceneObjectUrlSyncConfig;
     constructor(state?: Partial<SceneTimeRangeState>);
@@ -1688,8 +1653,6 @@ declare class SceneQueryRunner extends SceneObjectBase<QueryRunnerState> impleme
     private _dataLayersMerger;
     private _timeSub?;
     private _timeSubRange?;
-    private _scopesSub?;
-    private _scopesSubBridge?;
     private _containerWidth?;
     private _variableValueRecorder;
     private _results;
@@ -1728,12 +1691,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;
@@ -2457,7 +2419,6 @@ declare const LazyLoader: LazyLoaderType;
  * Responsible for top level pages routing
  */
 declare class SceneApp extends SceneObjectBase<SceneAppState> implements DataRequestEnricher {
-    protected _renderBeforeActivation: boolean;
     enrichDataRequest(): {
         app: string;
     };
@@ -2475,9 +2436,7 @@ 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;
@@ -2978,4 +2937,4 @@ declare const sceneUtils: {
     isGroupByVariable: typeof isGroupByVariable;
 };
 
-export { AdHocFilterWithLabels, AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLabel, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataProviderProxy, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, ExtraQueryDataProcessor, ExtraQueryDescriptor, ExtraQueryProvider, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, FilterOrigin, FiltersRequestEnricher, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, LazyLoader, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, MultiValueVariableState, NestedScene, NewSceneObjectAddedEvent, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SafeSerializableSceneObject, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderState, SceneDataLayerSet, SceneDataLayerSetBase, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataQuery, SceneDataState, SceneDataTransformer, SceneDataTransformerState, SceneDeactivationHandler, SceneDebugger, SceneFlexItem, SceneFlexItemLike, SceneFlexItemState, SceneFlexLayout, SceneGridItem, SceneGridItemLike, SceneGridItemStateLike, SceneGridLayout, SceneGridLayoutDragStartEvent, SceneGridRow, SceneInteractionProfileEvent, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryControllerEntry, SceneQueryControllerEntryType, SceneQueryControllerLike, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneRefreshPickerState, SceneRouteMatch, SceneScopesBridge, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneUrlSyncOptions, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UrlSyncManagerLike, UseStateHookOptions, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableGetOptionsArgs, VariableValue, VariableValueControl, VariableValueOption, VariableValueSelectWrapper, VariableValueSelectors, VariableValueSingle, VizConfig, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelExploreButton, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getExploreURL, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, renderSelectForVariable, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync };
+export { AdHocFilterWithLabels, AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLabel, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataProviderProxy, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, ExtraQueryDataProcessor, ExtraQueryDescriptor, ExtraQueryProvider, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, FilterOrigin, FiltersRequestEnricher, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, LazyLoader, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, MultiValueVariableState, NestedScene, NewSceneObjectAddedEvent, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SafeSerializableSceneObject, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderState, SceneDataLayerSet, SceneDataLayerSetBase, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataQuery, SceneDataState, SceneDataTransformer, SceneDataTransformerState, SceneDeactivationHandler, SceneDebugger, SceneFlexItem, SceneFlexItemLike, SceneFlexItemState, SceneFlexLayout, SceneGridItem, SceneGridItemLike, SceneGridItemStateLike, SceneGridLayout, SceneGridLayoutDragStartEvent, SceneGridRow, SceneInteractionProfileEvent, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryControllerEntry, SceneQueryControllerEntryType, SceneQueryControllerLike, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneRefreshPickerState, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneUrlSyncOptions, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UrlSyncManagerLike, UseStateHookOptions, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableGetOptionsArgs, VariableValue, VariableValueControl, VariableValueOption, VariableValueSelectWrapper, VariableValueSelectors, VariableValueSingle, VizConfig, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelExploreButton, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getExploreURL, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, renderSelectForVariable, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync };