@grafana/scenes 5.36.3--canary.1021.12630599445.0 → 5.36.4--canary.858.12706496691.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/esm/behaviors/SceneQueryController.js +60 -5
  3. package/dist/esm/behaviors/SceneQueryController.js.map +1 -1
  4. package/dist/esm/behaviors/SceneRenderProfiler.js +169 -0
  5. package/dist/esm/behaviors/SceneRenderProfiler.js.map +1 -0
  6. package/dist/esm/components/SceneRefreshPicker.js +6 -1
  7. package/dist/esm/components/SceneRefreshPicker.js.map +1 -1
  8. package/dist/esm/components/VizPanel/VizPanel.js +8 -1
  9. package/dist/esm/components/VizPanel/VizPanel.js.map +1 -1
  10. package/dist/esm/core/SceneTimeRange.js +3 -0
  11. package/dist/esm/core/SceneTimeRange.js.map +1 -1
  12. package/dist/esm/core/sceneGraph/getQueryController.js +19 -0
  13. package/dist/esm/core/sceneGraph/getQueryController.js.map +1 -0
  14. package/dist/esm/core/sceneGraph/index.js +3 -3
  15. package/dist/esm/core/sceneGraph/index.js.map +1 -1
  16. package/dist/esm/core/sceneGraph/sceneGraph.js +1 -26
  17. package/dist/esm/core/sceneGraph/sceneGraph.js.map +1 -1
  18. package/dist/esm/index.js.map +1 -1
  19. package/dist/esm/querying/registerQueryWithController.js +18 -2
  20. package/dist/esm/querying/registerQueryWithController.js.map +1 -1
  21. package/dist/esm/utils/getDataSource.js +17 -1
  22. package/dist/esm/utils/getDataSource.js.map +1 -1
  23. package/dist/esm/variables/adhoc/AdHocFiltersVariable.js +1 -1
  24. package/dist/esm/variables/adhoc/AdHocFiltersVariable.js.map +1 -1
  25. package/dist/esm/variables/adhoc/AdHocFiltersVariableUrlSyncHandler.js +1 -1
  26. package/dist/esm/variables/adhoc/AdHocFiltersVariableUrlSyncHandler.js.map +1 -1
  27. package/dist/esm/variables/components/VariableValueSelect.js +5 -0
  28. package/dist/esm/variables/components/VariableValueSelect.js.map +1 -1
  29. package/dist/esm/variables/variants/MultiValueVariable.js +2 -2
  30. package/dist/esm/variables/variants/MultiValueVariable.js.map +1 -1
  31. package/dist/esm/variables/variants/TestVariable.js.map +1 -1
  32. package/dist/index.d.ts +46 -33
  33. package/dist/index.js +469 -214
  34. package/dist/index.js.map +1 -1
  35. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -543,6 +543,7 @@ interface AdHocFilterWithLabels extends AdHocVariableFilter {
543
543
  keyLabel?: string;
544
544
  valueLabels?: string[];
545
545
  forceEdit?: boolean;
546
+ hidden?: boolean;
546
547
  }
547
548
  type AdHocControlsLayout = ControlsLayout | 'combobox';
548
549
  interface AdHocFiltersVariableState extends SceneVariableState {
@@ -788,7 +789,7 @@ declare abstract class MultiValueVariable<TState extends MultiValueVariableState
788
789
  * This helper function is to counter the contravariance of setState
789
790
  */
790
791
  private setStateHelper;
791
- getOptionsForSelect(): VariableValueOption[];
792
+ getOptionsForSelect(includeCurrentValue?: boolean): VariableValueOption[];
792
793
  refreshOptions(): void;
793
794
  /**
794
795
  * Can be used by subclasses to do custom handling of option search based on search input
@@ -976,20 +977,6 @@ declare class UserActionEvent extends BusEventWithPayload<UserActionEventPayload
976
977
  */
977
978
  declare function lookupVariable(name: string, sceneObject: SceneObject): SceneVariable | null;
978
979
 
979
- /**
980
- * Will walk up the scene object graph to the closest $timeRange scene object
981
- */
982
- declare function getTimeRange(sceneObject: SceneObject): SceneTimeRangeLike;
983
-
984
- interface SceneQueryStateControllerState extends SceneObjectState {
985
- isRunning: boolean;
986
- }
987
- interface SceneQueryControllerLike extends SceneObject<SceneQueryStateControllerState> {
988
- isQueryController: true;
989
- cancelAll(): void;
990
- queryStarted(entry: SceneQueryControllerEntry): void;
991
- queryCompleted(entry: SceneQueryControllerEntry): void;
992
- }
993
980
  interface QueryResultWithState {
994
981
  state: LoadingState;
995
982
  }
@@ -999,17 +986,40 @@ interface SceneQueryControllerEntry {
999
986
  origin: SceneObject;
1000
987
  cancel?: () => void;
1001
988
  }
1002
- type SceneQueryControllerEntryType = 'data' | 'annotations' | 'variable' | 'alerts';
1003
- declare class SceneQueryController extends SceneObjectBase<SceneQueryStateControllerState> implements SceneQueryControllerLike {
1004
- #private;
989
+ type SceneQueryControllerEntryType = 'data' | 'annotations' | 'variable' | 'alerts' | 'plugin';
990
+ interface SceneInteractionProfileEvent {
991
+ origin: string;
992
+ duration: number;
993
+ networkDuration: number;
994
+ jsHeapSizeLimit: number;
995
+ usedJSHeapSize: number;
996
+ totalJSHeapSize: number;
997
+ crumbs: string[];
998
+ }
999
+ interface SceneQueryStateControllerState extends SceneObjectState {
1000
+ isRunning: boolean;
1001
+ enableProfiling?: boolean;
1002
+ onProfileComplete?(event: SceneInteractionProfileEvent): void;
1003
+ }
1004
+ interface SceneQueryControllerLike extends SceneObject<SceneQueryStateControllerState> {
1005
1005
  isQueryController: true;
1006
- constructor();
1006
+ cancelAll(): void;
1007
1007
  queryStarted(entry: SceneQueryControllerEntry): void;
1008
1008
  queryCompleted(entry: SceneQueryControllerEntry): void;
1009
- private changeRunningQueryCount;
1010
- cancelAll(): void;
1009
+ startProfile(source: SceneObject): void;
1010
+ runningQueriesCount(): number;
1011
1011
  }
1012
1012
 
1013
+ /**
1014
+ * Returns the closest query controller undefined if none found
1015
+ */
1016
+ declare function getQueryController(sceneObject: SceneObject): SceneQueryControllerLike | undefined;
1017
+
1018
+ /**
1019
+ * Will walk up the scene object graph to the closest $timeRange scene object
1020
+ */
1021
+ declare function getTimeRange(sceneObject: SceneObject): SceneTimeRangeLike;
1022
+
1013
1023
  interface UrlSyncManagerLike {
1014
1024
  initSync(root: SceneObject): void;
1015
1025
  cleanUp(root: SceneObject): void;
@@ -1112,15 +1122,6 @@ declare function getAncestor<ParentType>(sceneObject: SceneObject, ancestorType:
1112
1122
  * This will search down the full scene graph, looking for objects that match the provided descendentType type.
1113
1123
  */
1114
1124
  declare function findDescendents<T extends SceneObject>(scene: SceneObject, descendentType: SceneType<T>): T[];
1115
- /**
1116
- * Returns the closest query controller undefined if none found
1117
- */
1118
- declare function getQueryController(sceneObject: SceneObject): SceneQueryControllerLike | undefined;
1119
- /**
1120
- * Returns the closest SceneObject that has a state property with the
1121
- * name urlSyncManager that is of type UrlSyncManager
1122
- */
1123
- declare function getUrlSyncManager(sceneObject: SceneObject): UrlSyncManagerLike | undefined;
1124
1125
 
1125
1126
  declare const sceneGraph: {
1126
1127
  getVariables: typeof getVariables;
@@ -1136,9 +1137,8 @@ declare const sceneGraph: {
1136
1137
  findObject: typeof findObject;
1137
1138
  findAllObjects: typeof findAllObjects;
1138
1139
  getAncestor: typeof getAncestor;
1139
- findDescendents: typeof findDescendents;
1140
1140
  getQueryController: typeof getQueryController;
1141
- getUrlSyncManager: typeof getUrlSyncManager;
1141
+ findDescendents: typeof findDescendents;
1142
1142
  };
1143
1143
 
1144
1144
  interface ActWhenVariableChangedState extends SceneObjectState {
@@ -1184,6 +1184,19 @@ declare class PanelContextEventBus implements EventBus {
1184
1184
  newScopedBus(key: string, filter: EventFilterOptions): EventBus;
1185
1185
  }
1186
1186
 
1187
+ declare class SceneQueryController extends SceneObjectBase<SceneQueryStateControllerState> implements SceneQueryControllerLike {
1188
+ #private;
1189
+ isQueryController: true;
1190
+ private profiler;
1191
+ constructor(state?: Partial<SceneQueryStateControllerState>);
1192
+ runningQueriesCount: () => number;
1193
+ startProfile(source: SceneObject): void;
1194
+ queryStarted(entry: SceneQueryControllerEntry): void;
1195
+ queryCompleted(entry: SceneQueryControllerEntry): void;
1196
+ private changeRunningQueryCount;
1197
+ cancelAll(): void;
1198
+ }
1199
+
1187
1200
  interface LiveNowTimerState extends SceneObjectState {
1188
1201
  enabled: boolean;
1189
1202
  }
@@ -2862,4 +2875,4 @@ declare const sceneUtils: {
2862
2875
  isGroupByVariable: typeof isGroupByVariable;
2863
2876
  };
2864
2877
 
2865
- export { AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLabel, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataProviderProxy, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, ExtraQueryDataProcessor, ExtraQueryDescriptor, ExtraQueryProvider, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, FiltersRequestEnricher, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, 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, SceneGridRow, 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 };
2878
+ export { AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLabel, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataProviderProxy, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, ExtraQueryDataProcessor, ExtraQueryDescriptor, ExtraQueryProvider, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, FiltersRequestEnricher, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, 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, 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 };