@grafana/scenes 6.41.1--canary.1289.18910649091.0 → 6.42.0--canary.1272.18911329941.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, GetTagResponse, MetricFindValue, SelectableValue, VariableRefresh as VariableRefresh$1, VariableSort, DrilldownsApplicability, 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, SelectableValue, GetTagResponse, MetricFindValue, VariableRefresh as VariableRefresh$1, VariableSort, DrilldownsApplicability, Scope, EventFilterOptions, AnnotationEvent, AnnotationQuery, DataTransformerConfig, TimeOption, FieldConfig, FieldType, FieldValueMatcherConfig, ScopedVar, 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';
@@ -740,7 +740,6 @@ interface SceneDataLayerProviderState extends SceneDataState {
     description?: string;
     isEnabled?: boolean;
     isHidden?: boolean;
-    placement?: 'inControlsMenu';
 }
 interface SceneDataLayerProvider extends SceneDataProvider<SceneDataLayerProviderState> {
     isDataLayer: true;
@@ -2448,6 +2447,121 @@ declare class LocalValueVariable extends SceneObjectBase<LocalValueVariableState
     isAncestorLoading(): boolean;
 }
 
+/**
+ * Controller state returned by useState hook
+ */
+interface AdHocFiltersControllerState {
+    filters: AdHocFilterWithLabels[];
+    originFilters?: AdHocFilterWithLabels[];
+    readOnly?: boolean;
+    allowCustomValue?: boolean;
+    supportsMultiValueOperators?: boolean;
+    onAddCustomValue?: OnAddCustomValueFn;
+    wip?: AdHocFilterWithLabels;
+    inputPlaceholder?: string;
+}
+/**
+ * Controller interface for adhoc filters combobox UI.
+ * Decouples the UI from AdHocFiltersVariable, allowing usage with or without a variable.
+ */
+interface AdHocFiltersController {
+    /**
+     * React hook to access controller state.
+     * Components should call this to get current filters and configuration.
+     */
+    useState(): AdHocFiltersControllerState;
+    /**
+     * Get possible keys given current filters.
+     * @param currentKey - The key being edited (to exclude from filter context)
+     */
+    getKeys(currentKey: string | null): Promise<Array<SelectableValue<string>>>;
+    /**
+     * Get possible values for a specific filter key.
+     * @param filter - The filter to get values for
+     */
+    getValuesFor(filter: AdHocFilterWithLabels): Promise<Array<SelectableValue<string>>>;
+    /**
+     * Get available operators based on configuration.
+     */
+    getOperators(): Array<SelectableValue<string>>;
+    /**
+     * Update a filter with partial changes.
+     * @param filter - The filter to update
+     * @param update - Partial filter properties to update
+     */
+    updateFilter(filter: AdHocFilterWithLabels, update: Partial<AdHocFilterWithLabels>): void;
+    /**
+     * Update a filter to match all values (=~ .*)
+     * @param filter - The filter to update
+     */
+    updateToMatchAll(filter: AdHocFilterWithLabels): void;
+    /**
+     * Remove a filter.
+     * @param filter - The filter to remove
+     */
+    removeFilter(filter: AdHocFilterWithLabels): void;
+    /**
+     * Remove the last filter in the list.
+     */
+    removeLastFilter(): void;
+    /**
+     * Handle backspace key in combobox (removes filter or navigates to previous).
+     * @param filter - The filter where backspace was pressed
+     */
+    handleComboboxBackspace(filter: AdHocFilterWithLabels): void;
+    /**
+     * Add a new work-in-progress filter.
+     */
+    addWip(): void;
+    /**
+     * Restore an origin filter to its original value.
+     * @param filter - The filter to restore
+     */
+    restoreOriginalFilter(filter: AdHocFilterWithLabels): void;
+    /**
+     * Optional: Start profiling an interaction (for performance tracking).
+     * @param name - The interaction name
+     */
+    startProfile?(name: string): void;
+    /**
+     * Optional: Start tracking an interaction (for analytics).
+     * @param name - The interaction name
+     */
+    startInteraction?(name: string): void;
+    /**
+     * Optional: Stop tracking the current interaction.
+     */
+    stopInteraction?(): void;
+}
+
+/**
+ * Adapter that wraps AdHocFiltersVariable to implement the AdHocFiltersController interface.
+ * This allows the combobox UI to work with the variable while keeping the UI decoupled.
+ */
+declare class AdHocFiltersVariableController implements AdHocFiltersController {
+    private model;
+    constructor(model: AdHocFiltersVariable);
+    useState(): AdHocFiltersControllerState;
+    getKeys(currentKey: string | null): Promise<Array<SelectableValue<string>>>;
+    getValuesFor(filter: AdHocFilterWithLabels): Promise<Array<SelectableValue<string>>>;
+    getOperators(): Array<SelectableValue<string>>;
+    updateFilter(filter: AdHocFilterWithLabels, update: Partial<AdHocFilterWithLabels>): void;
+    updateToMatchAll(filter: AdHocFilterWithLabels): void;
+    removeFilter(filter: AdHocFilterWithLabels): void;
+    removeLastFilter(): void;
+    handleComboboxBackspace(filter: AdHocFilterWithLabels): void;
+    addWip(): void;
+    restoreOriginalFilter(filter: AdHocFilterWithLabels): void;
+    startProfile(name: string): void;
+    startInteraction(name: string): void;
+    stopInteraction(): void;
+}
+
+interface Props$2 {
+    controller: AdHocFiltersController;
+}
+declare const AdHocFiltersComboboxRenderer: React__default.NamedExoticComponent<Props$2>;
+
 declare function useUrlSync(sceneRoot: SceneObject, options?: SceneUrlSyncOptions): boolean;
 
 interface UrlSyncContextProviderProps extends SceneUrlSyncOptions {
@@ -3437,6 +3551,8 @@ declare const loadResources: ResourceLoader;
 
 
 
+
+
 
 
 
@@ -3465,5 +3581,5 @@ declare const sceneUtils: {
     buildPathIdFor: typeof buildPathIdFor;
 };
 
-export { AdHocFiltersVariable, 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, 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, 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, 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, VariableValueSingle, VizConfig, VizPanelState };