@grafana/scenes 6.50.0--canary.1316.20252812955.0 → 6.50.0--canary.1312.20268893264.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _grafana_data from '@grafana/data';
-import { BusEventWithPayload, EventBus, BusEvent, BusEventType, BusEventHandler, PanelMenuItem, DataQueryRequest, FieldConfigSource, PanelPlugin, AbsoluteTimeRange, PanelData, InterpolateFunction, PanelModel, TimeRange, DataTransformContext, DataFrame, DataSourceGetTagKeysOptions, DataSourceGetTagValuesOptions, IconName, PageLayoutType, UrlQueryMap, DataQuery as DataQuery$1, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, SelectableValue, GetTagResponse, MetricFindValue, DrilldownsApplicability, VariableRegexApplyTo, VariableRefresh as VariableRefresh$1, VariableSort, Scope, EventFilterOptions, AnnotationEvent, AnnotationQuery, DataTransformerConfig, TimeOption, FieldConfig, FieldType, FieldValueMatcherConfig, ScopedVar, RawTimeRange } from '@grafana/data';
+import { BusEventWithPayload, EventBus, BusEvent, BusEventType, BusEventHandler, PanelMenuItem, DataQueryRequest, FieldConfigSource, PanelPlugin, AbsoluteTimeRange, PanelData, InterpolateFunction, PanelModel, TimeRange, DataTransformContext, DataFrame, DataSourceGetTagKeysOptions, DataSourceGetTagValuesOptions, IconName, PageLayoutType, UrlQueryMap, DataQuery as DataQuery$1, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, ScopedVar, SelectableValue, GetTagResponse, MetricFindValue, DrilldownsApplicability, VariableRegexApplyTo, VariableRefresh as VariableRefresh$1, VariableSort, Scope, EventFilterOptions, AnnotationEvent, AnnotationQuery, DataTransformerConfig, TimeOption, FieldConfig, FieldType, FieldValueMatcherConfig, RawTimeRange } from '@grafana/data';
 import * as _grafana_schema from '@grafana/schema';
 import { VariableType, VariableHide, LoadingState, TimeZone, DataQuery, DataTopic, DataSourceRef, VariableRefresh, DashboardCursorSync, MatcherConfig, TableFieldOptions } from '@grafana/schema';
 import * as React$1 from 'react';
@@ -993,6 +993,12 @@ declare function registerVariableMacro(name: string, macro: MacroVariableConstru
 declare function renderPrometheusLabelFilters(filters: AdHocVariableFilter[]): string;
 declare function escapeLabelValueInExactSelector(labelValue: string): string;
 declare function escapeLabelValueInRegexSelector(labelValue: string): string;
+/**
+ * Get all queries in the scene that have the same datasource as provided source object
+ */
+declare function getQueriesForVariables(sourceObject: SceneObject<SceneObjectState & {
+    datasource: DataSourceRef | null;
+}>): SceneDataQuery[];
 declare function escapeUrlPipeDelimiters(value: string | undefined): string;
 declare function escapeURLDelimiters(value: string | undefined): string;
 
@@ -1005,6 +1011,31 @@ declare class AdHocFiltersVariableUrlSyncHandler implements SceneObjectUrlSyncHa
     updateFromUrl(values: SceneObjectUrlValues): void;
 }
 
+declare class AdHocFiltersRecommendations {
+    private _recentFilters?;
+    private _recommendedFilters?;
+    private adHocFilter;
+    private scopesSubscription;
+    private _scopedVars;
+    constructor(adHocFilter: AdHocFiltersVariable, scopedVars: {
+        __sceneObject: ScopedVar;
+    });
+    get recentFilters(): AdHocFilterWithLabels[] | undefined;
+    get recommendedFilters(): AdHocFilterWithLabels[] | undefined;
+    init(): void;
+    deinit(): void;
+    private _getStorageKey;
+    private _fetchRecommendedDrilldowns;
+    private _verifyRecentFiltersApplicability;
+    /**
+     * Stores a recent filter in localStorage and updates state.
+     * Should be called by the parent variable when a filter is added/updated.
+     */
+    storeRecentFilter(filter: AdHocFilterWithLabels): void;
+    addFilterToParent(filter: AdHocFilterWithLabels): void;
+    render(): React__default.JSX.Element;
+}
+
 interface AdHocFilterWithLabels<M extends Record<string, any> = {}> extends AdHocVariableFilter {
     keyLabel?: string;
     valueLabels?: string[];
@@ -1101,10 +1132,14 @@ interface AdHocFiltersVariableState extends SceneVariableState {
      */
     applicabilityEnabled?: boolean;
     /**
-     * When true, enables a collapse button that appears when filters wrap to multiple lines.
-     * Allows users to collapse the filter UI to save vertical space.
+     * Value recommendations - manages recent and recommended filters
+     * @internal
      */
-    collapsible?: boolean;
+    _valueRecommendations?: AdHocFiltersRecommendations;
+    /**
+     * enables drilldown recommendations
+     */
+    drilldownRecommendationsEnabled?: boolean;
 }
 type AdHocVariableExpressionBuilderFn = (filters: AdHocFilterWithLabels[]) => string;
 type OnAddCustomValueFn = (item: SelectableValue<string> & {
@@ -1140,6 +1175,7 @@ declare class AdHocFiltersVariable extends SceneObjectBase<AdHocFiltersVariableS
     constructor(state: Partial<AdHocFiltersVariableState>);
     private _activationHandler;
     private _updateScopesFilters;
+    private verifyApplicabilityAndStoreRecentFilter;
     setState(update: Partial<AdHocFiltersVariableState>): void;
     /**
      * Updates the variable's `filters` and `filterExpression` state.
@@ -1151,10 +1187,6 @@ declare class AdHocFiltersVariable extends SceneObjectBase<AdHocFiltersVariableS
         forcePublish?: boolean;
     }): void;
     restoreOriginalFilter(filter: AdHocFilterWithLabels): void;
-    /**
-     * Clear all user-added filters and restore origin filters to their original values.
-     */
-    clearAll(): void;
     getValue(fieldPath?: string): VariableValue | undefined;
     _updateFilter(filter: AdHocFilterWithLabels, update: Partial<AdHocFilterWithLabels>): void;
     updateToMatchAll(filter: AdHocFilterWithLabels): void;
@@ -1364,6 +1396,34 @@ declare class QueryVariable extends MultiValueVariable<QueryVariableState> {
     static Component: ({ model }: SceneComponentProps<MultiValueVariable>) => React__default.JSX.Element;
 }
 
+declare class GroupByRecommendations {
+    private _recentGrouping?;
+    private _recommendedGrouping?;
+    private groupBy;
+    private scopesSubscription;
+    private _scopedVars;
+    constructor(groupByVariable: GroupByVariable, scopedVars: {
+        __sceneObject: ScopedVar;
+    });
+    get recentGrouping(): Array<SelectableValue<VariableValueSingle>> | undefined;
+    get recommendedGrouping(): Array<SelectableValue<VariableValueSingle>> | undefined;
+    init(): void;
+    deinit(): void;
+    private _getStorageKey;
+    private _fetchRecommendedDrilldowns;
+    private _verifyRecentGroupingsApplicability;
+    /**
+     * Stores recent groupings in localStorage and updates state.
+     * Should be called by the parent variable when a grouping is added/updated.
+     */
+    storeRecentGrouping(applicableValues: string[]): void;
+    /**
+     * Add a grouping value to the parent variable
+     */
+    addValueToParent(newValue: VariableValueSingle, newText?: string): void;
+    render(): React__default.JSX.Element;
+}
+
 interface GroupByVariableState extends MultiValueVariableState {
     /** Defaults to "Group" */
     name: string;
@@ -1411,6 +1471,15 @@ interface GroupByVariableState extends MultiValueVariableState {
      * state for checking whether drilldown applicability is enabled
      */
     applicabilityEnabled?: boolean;
+    /**
+     * Value recommendations scene object - manages recent and recommended groupings
+     * @internal
+     */
+    _valueRecommendations?: GroupByRecommendations;
+    /**
+     * enables drilldown recommendations
+     */
+    drilldownRecommendationsEnabled?: boolean;
 }
 type getTagKeysProvider = (set: GroupByVariable, currentKey: string | null) => Promise<{
     replace?: boolean;
@@ -1420,12 +1489,13 @@ declare class GroupByVariable extends MultiValueVariable<GroupByVariableState> {
     static Component: typeof GroupByVariableRenderer;
     isLazy: boolean;
     protected _urlSync: SceneObjectUrlSyncHandler;
+    private _scopedVars;
     validateAndUpdate(): Observable<ValidateAndUpdateResult>;
     private _updateValueGivenNewOptions;
     getValueOptions(args: VariableGetOptionsArgs): Observable<VariableValueOption[]>;
     constructor(initialState: Partial<GroupByVariableState>);
     private _activationHandler;
-    getApplicableKeys(): VariableValue;
+    getApplicableKeys(): string[];
     getGroupByApplicabilityForQueries(value: VariableValue, queries: SceneDataQuery[]): Promise<DrilldownsApplicability[] | undefined>;
     _verifyApplicability(): Promise<void>;
     checkIfRestorable(values: VariableValue): boolean;
@@ -1434,6 +1504,7 @@ declare class GroupByVariable extends MultiValueVariable<GroupByVariableState> {
      * Get possible keys given current filters. Do not call from plugins directly
      */
     _getKeys: (ds: DataSourceApi) => Promise<GetTagResponse | MetricFindValue[]>;
+    _verifyApplicabilityAndStoreRecentGrouping(): Promise<void>;
     /**
      * Allows clearing the value of the variable to an empty value. Overrides default behavior of a MultiValueVariable
      */
@@ -2495,10 +2566,8 @@ interface AdHocFiltersControllerState {
     onAddCustomValue?: OnAddCustomValueFn;
     wip?: AdHocFilterWithLabels;
     inputPlaceholder?: string;
-    /**
-     * When true, enables a collapse button that appears when filters wrap to multiple lines.
-     */
-    collapsible?: boolean;
+    valueRecommendations?: AdHocFiltersRecommendations;
+    drilldownRecommendationsEnabled?: boolean;
 }
 /**
  * Controller interface for adhoc filters combobox UI.
@@ -2530,6 +2599,15 @@ interface AdHocFiltersController {
      * @param update - Partial filter properties to update
      */
     updateFilter(filter: AdHocFilterWithLabels, update: Partial<AdHocFilterWithLabels>): void;
+    /**
+     * Update filters list
+     * @param filters
+     * @param options
+     */
+    updateFilters?(filters: AdHocFilterWithLabels[], options?: {
+        skipPublish?: boolean;
+        forcePublish?: boolean;
+    }): void;
     /**
      * Update a filter to match all values (=~ .*)
      * @param filter - The filter to update
@@ -2558,10 +2636,6 @@ interface AdHocFiltersController {
      * @param filter - The filter to restore
      */
     restoreOriginalFilter(filter: AdHocFilterWithLabels): void;
-    /**
-     * Clear all user-added filters and restore origin filters to original values.
-     */
-    clearAll(): void;
     /**
      * Optional: Start profiling an interaction (for performance tracking).
      * @param name - The interaction name
@@ -2590,13 +2664,16 @@ declare class AdHocFiltersVariableController implements AdHocFiltersController {
     getValuesFor(filter: AdHocFilterWithLabels): Promise<Array<SelectableValue<string>>>;
     getOperators(): Array<SelectableValue<string>>;
     updateFilter(filter: AdHocFilterWithLabels, update: Partial<AdHocFilterWithLabels>): void;
+    updateFilters(filters: AdHocFilterWithLabels[], options?: {
+        skipPublish?: boolean;
+        forcePublish?: boolean;
+    }): void;
     updateToMatchAll(filter: AdHocFilterWithLabels): void;
     removeFilter(filter: AdHocFilterWithLabels): void;
     removeLastFilter(): void;
     handleComboboxBackspace(filter: AdHocFilterWithLabels): void;
     addWip(): void;
     restoreOriginalFilter(filter: AdHocFilterWithLabels): void;
-    clearAll(): void;
     startProfile(name: string): void;
     startInteraction(name: string): void;
     stopInteraction(): void;
@@ -3626,5 +3703,5 @@ declare const sceneUtils: {
     buildPathIdFor: typeof buildPathIdFor;
 };
 
-export { AdHocFiltersComboboxRenderer, AdHocFiltersVariable, AdHocFiltersVariableController, ConstantVariable, ControlsLabel, CustomVariable, DataProviderProxy, DataSourceVariable, EmbeddedScene, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, GroupByVariable, IntervalVariable, LazyLoader, LocalValueVariable, MultiOrSingleValueSelect, MultiValueVariable, NestedScene, NewSceneObjectAddedEvent, PATH_ID_SEPARATOR, 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, SwitchVariable, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UserActionEvent, VariableDependencyConfig, VariableValueControl, VariableValueSelectWrapper, VariableValueSelectors, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelExploreButton, VizPanelMenu, index$2 as behaviors, index as dataLayers, escapeUrlPipeDelimiters, formatRegistry, getExploreURL, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, loadResources, index$1 as performanceUtils, registerQueryWithController, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync, writePerformanceLog };
+export { AdHocFiltersComboboxRenderer, AdHocFiltersVariable, AdHocFiltersVariableController, ConstantVariable, ControlsLabel, CustomVariable, DataProviderProxy, DataSourceVariable, EmbeddedScene, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, GroupByVariable, IntervalVariable, LazyLoader, LocalValueVariable, MultiOrSingleValueSelect, MultiValueVariable, NestedScene, NewSceneObjectAddedEvent, PATH_ID_SEPARATOR, 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, SwitchVariable, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UserActionEvent, VariableDependencyConfig, VariableValueControl, VariableValueSelectWrapper, VariableValueSelectors, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelExploreButton, VizPanelMenu, index$2 as behaviors, index as dataLayers, escapeUrlPipeDelimiters, formatRegistry, getExploreURL, getQueriesForVariables, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, loadResources, index$1 as performanceUtils, registerQueryWithController, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync, writePerformanceLog };
 export type { AdHocFilterWithLabels, AdHocFiltersController, AdHocFiltersControllerState, 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, 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, VariableValueOptionProperties, VariableValueSingle, VizConfig, VizPanelState };