@grafana/scenes 6.50.0--canary.1315.20233534152.0 → 6.50.0--canary.1312.20242044820.0

package/dist/index.d.ts

@@ -31,11 +31,6 @@ import { Options as Options$h, FieldConfig as FieldConfig$8 } from '@grafana/sch
 import { Options as Options$i } from '@grafana/schema/dist/esm/raw/composable/xychart/panelcfg/x/XYChartPanelCfg_types.gen';
 import { ResourceLoader } from '@grafana/i18n';
 
-interface ControlSourceRef {
-    uid: string;
-    sourceId: string;
-    sourceType: string;
-}
 interface SceneVariableState extends SceneObjectState {
     type: VariableType;
     name: string;
@@ -45,7 +40,6 @@ interface SceneVariableState extends SceneObjectState {
     loading?: boolean;
     error?: any | null;
     description?: string | null;
-    source?: ControlSourceRef;
 }
 interface SceneVariable<TState extends SceneVariableState = SceneVariableState> extends SceneObject<TState> {
     /**
@@ -999,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;
 
@@ -1011,6 +1011,47 @@ declare class AdHocFiltersVariableUrlSyncHandler implements SceneObjectUrlSyncHa
     updateFromUrl(values: SceneObjectUrlValues): void;
 }
 
+interface AdHocFiltersRecommendationsState extends SceneObjectState {
+    /** Recent filters */
+    recentFilters?: AdHocFilterWithLabels[];
+    /** Recommended filters */
+    recommendedFilters?: AdHocFilterWithLabels[];
+}
+/**
+ * Scene object component that manages recommendations for AdHocFiltersVariable.
+ * It handles fetching recommended drilldowns, verifying applicability of recent filters,
+ * and storing/displaying recent filters.
+ */
+declare class AdHocFiltersRecommendations extends SceneObjectBase<AdHocFiltersRecommendationsState> {
+    static Component: typeof AdHocFiltersRecommendationsRenderer;
+    private _scopedVars;
+    private _parentVariable;
+    constructor(parent: AdHocFiltersVariable);
+    /**
+     * Get the parent variable
+     */
+    get parent(): AdHocFiltersVariable;
+    private _activationHandler;
+    private _getStorageKey;
+    private _fetchRecommendedDrilldowns;
+    private _verifyRecentFiltersApplicability;
+    private _getFiltersApplicabilityForQueries;
+    /**
+     * 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;
+    /**
+     * Get the current filters from the parent variable
+     */
+    getParentFilters(): AdHocFilterWithLabels[];
+    /**
+     * Add a filter to the parent variable
+     */
+    addFilterToParent(filter: AdHocFilterWithLabels): void;
+}
+declare function AdHocFiltersRecommendationsRenderer({ model }: SceneComponentProps<AdHocFiltersRecommendations>): React__default.JSX.Element;
+
 interface AdHocFilterWithLabels<M extends Record<string, any> = {}> extends AdHocVariableFilter {
     keyLabel?: string;
     valueLabels?: string[];
@@ -1106,6 +1147,15 @@ interface AdHocFiltersVariableState extends SceneVariableState {
      * state for checking whether drilldown applicability is enabled
      */
     applicabilityEnabled?: boolean;
+    /**
+     * Value recommendations - manages recent and recommended filters
+     * @internal
+     */
+    _valueRecommendations?: AdHocFiltersRecommendations;
+    /**
+     * enables drilldown recommendations
+     */
+    drilldownRecommendationsEnabled?: boolean;
 }
 type AdHocVariableExpressionBuilderFn = (filters: AdHocFilterWithLabels[]) => string;
 type OnAddCustomValueFn = (item: SelectableValue<string> & {
@@ -1141,6 +1191,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.
@@ -1361,6 +1412,50 @@ declare class QueryVariable extends MultiValueVariable<QueryVariableState> {
     static Component: ({ model }: SceneComponentProps<MultiValueVariable>) => React__default.JSX.Element;
 }
 
+interface GroupByRecommendationsState extends SceneObjectState {
+    /** Recent groupings */
+    recentGrouping?: Array<SelectableValue<VariableValueSingle>>;
+    /** Recommended groupings */
+    recommendedGrouping?: Array<SelectableValue<VariableValueSingle>>;
+}
+/**
+ * Scene object component that manages recommendations for GroupByVariable.
+ * It handles fetching recommended drilldowns, verifying applicability of recent groupings,
+ * and storing/displaying recent groupings.
+ */
+declare class GroupByRecommendations extends SceneObjectBase<GroupByRecommendationsState> {
+    static Component: typeof GroupByRecommendationsRenderer;
+    private _scopedVars;
+    private _parentVariable;
+    constructor(parent: GroupByVariable);
+    /**
+     * Get the parent variable
+     */
+    get parent(): GroupByVariable;
+    private _activationHandler;
+    private _getStorageKey;
+    private _fetchRecommendedDrilldowns;
+    private _verifyRecentGroupingsApplicability;
+    private _getGroupByApplicabilityForQueries;
+    /**
+     * 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;
+    /**
+     * Get the current values from the parent variable
+     */
+    getParentValues(): {
+        value: VariableValueSingle[];
+        text: string[];
+    };
+    /**
+     * Add a grouping value to the parent variable
+     */
+    addValueToParent(newValue: VariableValueSingle, newText?: string): void;
+}
+declare function GroupByRecommendationsRenderer({ model }: SceneComponentProps<GroupByRecommendations>): React__default.JSX.Element;
+
 interface GroupByVariableState extends MultiValueVariableState {
     /** Defaults to "Group" */
     name: string;
@@ -1408,6 +1503,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;
@@ -1422,7 +1526,7 @@ declare class GroupByVariable extends MultiValueVariable<GroupByVariableState> {
     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;
@@ -1431,6 +1535,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
      */
@@ -2492,6 +2597,9 @@ interface AdHocFiltersControllerState {
     onAddCustomValue?: OnAddCustomValueFn;
     wip?: AdHocFilterWithLabels;
     inputPlaceholder?: string;
+    /** Value recommendations component - manages recent and recommended filters */
+    valueRecommendations?: AdHocFiltersRecommendations;
+    drilldownRecommendationsEnabled?: boolean;
 }
 /**
  * Controller interface for adhoc filters combobox UI.
@@ -2523,6 +2631,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
@@ -2579,6 +2696,10 @@ 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;
@@ -3614,5 +3735,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 type { AdHocFilterWithLabels, AdHocFiltersController, AdHocFiltersControllerState, CancelActivationHandler, ControlSourceRef, 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 };
+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 };