Suggestions: Update ownership of core files and improve some types (#113254)

packages/grafana-data/src/index.ts

@@ -651,12 +651,7 @@ export {
   type PanelMenuItem,
   type AngularPanelMenuItem,
   type PanelPluginDataSupport,
-  type VisualizationSuggestion,
-  type VisualizationSuggestionsSupplier,
   VizOrientation,
-  VisualizationSuggestionScore,
-  VisualizationSuggestionsBuilder,
-  VisualizationSuggestionsListAppender,
 } from './types/panel';
 export {
   type DataSourcePluginOptionsEditorProps,
@@ -717,6 +712,13 @@ export {
   type ApplyFieldOverrideOptions,
   FieldConfigProperty,
 } from './types/fieldOverrides';
+export {
+  type VisualizationSuggestion,
+  type VisualizationSuggestionsSupplier,
+  VisualizationSuggestionScore,
+  VisualizationSuggestionsBuilder,
+  VisualizationSuggestionsListAppender,
+} from './types/suggestions';
 export {
   type MatcherConfig,
   type DataTransformContext,

packages/grafana-data/src/panel/PanelPlugin.ts

@@ -7,7 +7,6 @@ import { PanelModel } from '../types/dashboard';
 import { FieldConfigProperty, FieldConfigSource } from '../types/fieldOverrides';
 import {
   PanelPluginMeta,
-  VisualizationSuggestionsSupplier,
   PanelProps,
   PanelEditorProps,
   PanelMigrationHandler,
@@ -15,6 +14,7 @@ import {
   PanelPluginDataSupport,
 } from '../types/panel';
 import { GrafanaPlugin } from '../types/plugin';
+import { VisualizationSuggestionsSupplier } from '../types/suggestions';
 import { FieldConfigEditorBuilder, PanelOptionsEditorBuilder } from '../utils/OptionsUIBuilders';
 import { deprecationWarning } from '../utils/deprecationWarning';
 

packages/grafana-data/src/types/panel.ts

@@ -1,8 +1,5 @@
-import { defaultsDeep } from 'lodash';
-
 import { EventBus } from '../events/types';
 import { StandardEditorProps } from '../field/standardFieldConfigEditorRegistry';
-import { PanelDataSummary, getPanelDataSummary } from '../panel/suggestions/getPanelDataSummary';
 import { Registry } from '../utils/Registry';
 
 import { OptionsEditorItem } from './OptionsUIRegistryBuilder';
@@ -17,7 +14,6 @@ import { IconName } from './icon';
 import { OptionEditorConfig } from './options';
 import { PluginMeta } from './plugin';
 import { AbsoluteTimeRange, TimeRange, TimeZone } from './time';
-import { DataTransformerConfig } from './transformations';
 
 export type InterpolateFunction = (value: string, scopedVars?: ScopedVars, format?: string | Function) => string;
 
@@ -219,95 +215,3 @@ export interface PanelPluginDataSupport {
   annotations: boolean;
   alertStates: boolean;
 }
-
-/**
- * @alpha
- */
-export interface VisualizationSuggestion<TOptions = any, TFieldConfig = any> {
-  /** Name of suggestion */
-  name: string;
-  /** Description */
-  description?: string;
-  /** Panel plugin id */
-  pluginId: string;
-  /** Panel plugin options */
-  options?: Partial<TOptions>;
-  /** Panel plugin field options */
-  fieldConfig?: FieldConfigSource<Partial<TFieldConfig>>;
-  /** Data transformations */
-  transformations?: DataTransformerConfig[];
-  /** Options for how to render suggestion card */
-  cardOptions?: {
-    /** Tweak for small preview */
-    previewModifier?: (suggestion: VisualizationSuggestion) => void;
-    icon?: string;
-    imgSrc?: string;
-  };
-  /** A value between 0-100 how suitable suggestion is */
-  score?: VisualizationSuggestionScore;
-}
-
-/**
- * @alpha
- */
-export enum VisualizationSuggestionScore {
-  /** We are pretty sure this is the best possible option */
-  Best = 100,
-  /** Should be a really good option */
-  Good = 70,
-  /** Can be visualized but there are likely better options. If no score is set this score is assumed */
-  OK = 50,
-}
-
-/**
- * @alpha
- */
-export class VisualizationSuggestionsBuilder {
-  /** Current data */
-  data?: PanelData;
-  /** Current panel & options */
-  panel?: PanelModel;
-  /** Summary stats for current data */
-  dataSummary: PanelDataSummary;
-
-  private list: VisualizationSuggestion[] = [];
-
-  constructor(data?: PanelData, panel?: PanelModel) {
-    this.data = data;
-    this.panel = panel;
-    this.dataSummary = getPanelDataSummary(this.data?.series);
-  }
-
-  getListAppender<TOptions, TFieldConfig>(defaults: VisualizationSuggestion<TOptions, TFieldConfig>) {
-    return new VisualizationSuggestionsListAppender<TOptions, TFieldConfig>(this.list, defaults);
-  }
-
-  getList() {
-    return this.list;
-  }
-}
-
-/**
- * @alpha
- */
-export type VisualizationSuggestionsSupplier = {
-  /**
-   * Adds good suitable suggestions for the current data
-   */
-  getSuggestionsForData: (builder: VisualizationSuggestionsBuilder) => void;
-};
-
-/**
- * Helps with typings and defaults
- * @alpha
- */
-export class VisualizationSuggestionsListAppender<TOptions, TFieldConfig> {
-  constructor(
-    private list: VisualizationSuggestion[],
-    private defaults: VisualizationSuggestion<TOptions, TFieldConfig>
-  ) {}
-
-  append(overrides: Partial<VisualizationSuggestion<TOptions, TFieldConfig>>) {
-    this.list.push(defaultsDeep(overrides, this.defaults));
-  }
-}

packages/grafana-data/src/types/suggestions.ts

@@ -0,0 +1,100 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { defaultsDeep } from 'lodash';
+
+import { DataTransformerConfig } from '@grafana/schema';
+
+import { PanelDataSummary, getPanelDataSummary } from '../panel/suggestions/getPanelDataSummary';
+
+import { PanelModel } from './dashboard';
+import { FieldConfigSource } from './fieldOverrides';
+import { PanelData } from './panel';
+
+/**
+ * @alpha
+ */
+export interface VisualizationSuggestion<TOptions = any, TFieldConfig = any> {
+  /** Name of suggestion */
+  name: string;
+  /** Description */
+  description?: string;
+  /** Panel plugin id */
+  pluginId: string;
+  /** Panel plugin options */
+  options?: Partial<TOptions>;
+  /** Panel plugin field options */
+  fieldConfig?: FieldConfigSource<Partial<TFieldConfig>>;
+  /** Data transformations */
+  transformations?: DataTransformerConfig[];
+  /** Options for how to render suggestion card */
+  cardOptions?: {
+    /** Tweak for small preview */
+    previewModifier?: (suggestion: VisualizationSuggestion) => void;
+    icon?: string;
+    imgSrc?: string;
+  };
+  /** A value between 0-100 how suitable suggestion is */
+  score?: VisualizationSuggestionScore;
+}
+
+/**
+ * @alpha
+ */
+export enum VisualizationSuggestionScore {
+  /** We are pretty sure this is the best possible option */
+  Best = 100,
+  /** Should be a really good option */
+  Good = 70,
+  /** Can be visualized but there are likely better options. If no score is set this score is assumed */
+  OK = 50,
+}
+
+/**
+ * @alpha
+ */
+export class VisualizationSuggestionsBuilder {
+  /** Summary stats for current data */
+  dataSummary: PanelDataSummary;
+  private list: VisualizationSuggestion[] = [];
+
+  constructor(
+    /** Current data */
+    public data?: PanelData,
+    /** Current panel & options */
+    public panel?: PanelModel
+  ) {
+    this.dataSummary = getPanelDataSummary(data?.series);
+  }
+
+  getListAppender<TOptions, TFieldConfig>(defaults: VisualizationSuggestion<TOptions, TFieldConfig>) {
+    return new VisualizationSuggestionsListAppender<TOptions, TFieldConfig>(this.list, defaults);
+  }
+
+  getList() {
+    return this.list;
+  }
+}
+
+/**
+ * @alpha
+ */
+export type VisualizationSuggestionsSupplier = {
+  /**
+   * Adds good suitable suggestions for the current data
+   */
+  getSuggestionsForData: (builder: VisualizationSuggestionsBuilder) => void;
+};
+
+/**
+ * Helps with typings and defaults
+ * @alpha
+ */
+export class VisualizationSuggestionsListAppender<TOptions, TFieldConfig> {
+  constructor(
+    private list: VisualizationSuggestion[],
+    private defaults: VisualizationSuggestion<TOptions, TFieldConfig>
+  ) {}
+
+  append(overrides: Partial<VisualizationSuggestion<TOptions, TFieldConfig>>) {
+    this.list.push(defaultsDeep(overrides, this.defaults));
+  }
+}