Move Lens attribute builder to a package

.github/CODEOWNERS

@@ -774,6 +774,7 @@ src/plugins/vis_types/vega @elastic/kibana-visualizations
 src/plugins/vis_types/vislib @elastic/kibana-visualizations
 src/plugins/vis_types/xy @elastic/kibana-visualizations
 packages/kbn-visualization-ui-components @elastic/kibana-visualizations
+packages/kbn-visualization-utils @elastic/kibana-visualizations
 src/plugins/visualizations @elastic/kibana-visualizations
 x-pack/plugins/watcher @elastic/platform-deployment-management
 packages/kbn-web-worker-stub @elastic/kibana-operations

package.json

@@ -762,6 +762,7 @@
     "@kbn/vis-type-vislib-plugin": "link:src/plugins/vis_types/vislib",
     "@kbn/vis-type-xy-plugin": "link:src/plugins/vis_types/xy",
     "@kbn/visualization-ui-components": "link:packages/kbn-visualization-ui-components",
+    "@kbn/visualization-utils": "link:packages/kbn-visualization-utils",
     "@kbn/visualizations-plugin": "link:src/plugins/visualizations",
     "@kbn/watcher-plugin": "link:x-pack/plugins/watcher",
     "@loaders.gl/core": "^3.4.7",

packages/kbn-visualization-utils/README.md

@@ -0,0 +1,3 @@
+# @kbn/visualization-utils
+
+A shared utils package for Lens.

x-pack/plugins/infra/public/common/visualizations/lens/data_view_cache.ts → packages/kbn-visualization-utils/attribute_builder/data_view_cache.ts

@@ -1,13 +1,14 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import { DataViewSpec, DataView } from '@kbn/data-plugin/common';
 
-export const DEFAULT_AD_HOC_DATA_VIEW_ID = 'infra_lens_ad_hoc_default';
+export const DEFAULT_AD_HOC_DATA_VIEW_ID = 'lens_ad_hoc_default';
 
 export class DataViewCache {
   private static instance: DataViewCache;

x-pack/plugins/infra/public/common/visualizations/lens/lens_attributes_builder.test.ts → packages/kbn-visualization-utils/attribute_builder/lens_attributes_builder.test.ts

@@ -1,8 +1,9 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import 'jest-canvas-mock';
@@ -19,7 +20,7 @@ import {
 } from './visualization_types';
 import type { FormulaPublicApi, GenericIndexPatternColumn } from '@kbn/lens-plugin/public';
 import { ReferenceBasedIndexPatternColumn } from '@kbn/lens-plugin/public/datasources/form_based/operations/definitions/column_types';
-import type { FormulaConfig } from '../types';
+import type { FormulaConfig } from './types';
 
 const mockDataView = {
   id: 'mock-id',

x-pack/plugins/infra/public/common/visualizations/lens/lens_attributes_builder.ts → packages/kbn-visualization-utils/attribute_builder/lens_attributes_builder.ts

@@ -1,28 +1,30 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
+
 import type {
   LensAttributes,
   LensVisualizationState,
   Chart,
   VisualizationAttributesBuilder,
-} from '../types';
+} from './types';
 import { DataViewCache } from './data_view_cache';
 import { getAdhocDataView } from './utils';
 
 export class LensAttributesBuilder<T extends Chart<LensVisualizationState>>
   implements VisualizationAttributesBuilder
 {
   private dataViewCache: DataViewCache;
-  constructor(private state: { visualization: T }) {
+  constructor(private lens: { visualization: T }) {
     this.dataViewCache = DataViewCache.getInstance();
   }
 
   build(): LensAttributes {
-    const { visualization } = this.state;
+    const { visualization } = this.lens;
     return {
       title: visualization.getTitle(),
       visualizationType: visualization.getVisualizationType(),
@@ -34,9 +36,12 @@ export class LensAttributesBuilder<T extends Chart<LensVisualizationState>>
           },
         },
         internalReferences: visualization.getReferences(),
+        // EmbeddableComponent receive filters.
         filters: [],
+        // EmbeddableComponent receive query.
         query: { language: 'kuery', query: '' },
         visualization: visualization.getVisualizationState(),
+        // Getting the spec from a data view is a heavy operation, that's why the result is cached.
         adHocDataViews: getAdhocDataView(this.dataViewCache.getSpec(visualization.getDataView())),
       },
     };

packages/kbn-visualization-utils/attribute_builder/types.ts

@@ -0,0 +1,76 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import type { SavedObjectReference } from '@kbn/core/server';
+import type { DataView } from '@kbn/data-views-plugin/common';
+import type {
+  FormBasedPersistedState,
+  MetricVisualizationState,
+  PersistedIndexPatternLayer,
+  TypedLensByValueInput,
+  XYState,
+  FormulaPublicApi,
+  XYLayerConfig,
+} from '@kbn/lens-plugin/public';
+export type LensAttributes = TypedLensByValueInput['attributes'];
+
+// Attributes
+export type LensVisualizationState = XYState | MetricVisualizationState;
+
+export interface VisualizationAttributesBuilder {
+  build(): LensAttributes;
+}
+
+// Column
+export interface ChartColumn {
+  getData(
+    id: string,
+    baseLayer: PersistedIndexPatternLayer,
+    dataView: DataView
+  ): PersistedIndexPatternLayer;
+  getFormulaConfig(): FormulaConfig;
+}
+
+// Layer
+export type LensLayerConfig = XYLayerConfig | MetricVisualizationState;
+
+export interface ChartLayer<TLayerConfig extends LensLayerConfig> {
+  getName(): string | undefined;
+  getLayer(
+    layerId: string,
+    accessorId: string,
+    dataView: DataView
+  ): FormBasedPersistedState['layers'];
+  getReference(layerId: string, dataView: DataView): SavedObjectReference[];
+  getLayerConfig(layerId: string, acessorId: string): TLayerConfig;
+}
+
+// Chart
+export interface Chart<TVisualizationState extends LensVisualizationState> {
+  getTitle(): string;
+  getVisualizationType(): string;
+  getLayers(): FormBasedPersistedState['layers'];
+  getVisualizationState(): TVisualizationState;
+  getReferences(): SavedObjectReference[];
+  getDataView(): DataView;
+}
+export interface ChartConfig<
+  TLayer extends ChartLayer<LensLayerConfig> | Array<ChartLayer<LensLayerConfig>>
+> {
+  dataView: DataView;
+  layers: TLayer;
+  title?: string;
+}
+
+// Formula
+type LensFormula = Parameters<FormulaPublicApi['insertOrReplaceFormulaColumn']>[1];
+export type FormulaConfig = Omit<LensFormula, 'format' | 'formula'> & {
+  color?: string;
+  format: NonNullable<LensFormula['format']>;
+  value: string;
+};

x-pack/plugins/infra/public/common/visualizations/lens/utils.ts → packages/kbn-visualization-utils/attribute_builder/utils.ts

@@ -1,10 +1,12 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
-import {
+
+import type {
   DateHistogramIndexPatternColumn,
   PersistedIndexPatternLayer,
   TermsIndexPatternColumn,

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/index.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/index.ts

@@ -1,8 +1,9 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 export { XYChart } from './xy_chart';

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/column/formula.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/layers/columns/formula.ts

@@ -1,13 +1,14 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import type { FormulaPublicApi, PersistedIndexPatternLayer } from '@kbn/lens-plugin/public';
 import type { DataView } from '@kbn/data-views-plugin/public';
-import type { FormulaConfig, ChartColumn } from '../../../../types';
+import type { FormulaConfig, ChartColumn } from '../../../types';
 
 export class FormulaColumn implements ChartColumn {
   constructor(private formulaConfig: FormulaConfig, private formulaAPI: FormulaPublicApi) {}

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/column/reference_line.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/layers/columns/reference_line.ts

@@ -1,13 +1,14 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import type { PersistedIndexPatternLayer } from '@kbn/lens-plugin/public';
 import type { ReferenceBasedIndexPatternColumn } from '@kbn/lens-plugin/public/datasources/form_based/operations/definitions/column_types';
-import type { FormulaConfig, ChartColumn } from '../../../../types';
+import type { FormulaConfig, ChartColumn } from '../../../types';
 
 export class ReferenceLineColumn implements ChartColumn {
   constructor(private formulaConfig: FormulaConfig) {}

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/index.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/layers/index.ts

@@ -1,13 +1,14 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 export { MetricLayer, type MetricLayerOptions } from './metric_layer';
 export { XYDataLayer, type XYLayerOptions } from './xy_data_layer';
 export { XYReferenceLinesLayer } from './xy_reference_lines_layer';
 
-export { FormulaColumn as FormulaDataColumn } from './column/formula';
-export { ReferenceLineColumn } from './column/reference_line';
+export { FormulaColumn as FormulaDataColumn } from './columns/formula';
+export { ReferenceLineColumn } from './columns/reference_line';

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/metric_layer.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/layers/metric_layer.ts

@@ -1,8 +1,9 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import type { SavedObjectReference } from '@kbn/core/server';
@@ -13,9 +14,9 @@ import type {
   MetricVisualizationState,
   PersistedIndexPatternLayer,
 } from '@kbn/lens-plugin/public';
-import type { ChartColumn, ChartLayer, FormulaConfig } from '../../../types';
+import type { ChartColumn, ChartLayer, FormulaConfig } from '../../types';
 import { getDefaultReferences, getHistogramColumn } from '../../utils';
-import { FormulaColumn } from './column/formula';
+import { FormulaColumn } from './columns/formula';
 
 const HISTOGRAM_COLUMN_NAME = 'x_date_histogram';
 

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/xy_data_layer.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/layers/xy_data_layer.ts

@@ -1,8 +1,9 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import type { SavedObjectReference } from '@kbn/core/server';
@@ -14,9 +15,9 @@ import type {
   XYDataLayerConfig,
   SeriesType,
 } from '@kbn/lens-plugin/public';
-import type { ChartColumn, ChartLayer, FormulaConfig } from '../../../types';
+import type { ChartColumn, ChartLayer, FormulaConfig } from '../../types';
 import { getDefaultReferences, getHistogramColumn, getTopValuesColumn } from '../../utils';
-import { FormulaColumn } from './column/formula';
+import { FormulaColumn } from './columns/formula';
 
 const BREAKDOWN_COLUMN_NAME = 'aggs_breakdown';
 const HISTOGRAM_COLUMN_NAME = 'x_date_histogram';

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/layers/xy_reference_lines_layer.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/layers/xy_reference_lines_layer.ts

@@ -1,8 +1,9 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import type { SavedObjectReference } from '@kbn/core/server';
@@ -12,9 +13,9 @@ import type {
   PersistedIndexPatternLayer,
   XYReferenceLineLayerConfig,
 } from '@kbn/lens-plugin/public';
-import type { ChartColumn, ChartLayer, FormulaConfig } from '../../../types';
+import type { ChartColumn, ChartLayer, FormulaConfig } from '../../types';
 import { getDefaultReferences } from '../../utils';
-import { ReferenceLineColumn } from './column/reference_line';
+import { ReferenceLineColumn } from './columns/reference_line';
 
 interface XYReferenceLinesLayerConfig {
   data: FormulaConfig[];

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/metric_chart.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/metric_chart.ts

@@ -1,17 +1,17 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import type { FormBasedPersistedState, MetricVisualizationState } from '@kbn/lens-plugin/public';
 import type { SavedObjectReference } from '@kbn/core/server';
 import type { DataView } from '@kbn/data-views-plugin/public';
+import type { Chart, ChartConfig, ChartLayer } from '../types';
 import { DEFAULT_LAYER_ID } from '../utils';
 
-import type { Chart, ChartConfig, ChartLayer } from '../../types';
-
 const ACCESSOR = 'metric_formula_accessor';
 
 export class MetricChart implements Chart<MetricVisualizationState> {

x-pack/plugins/infra/public/common/visualizations/lens/visualization_types/xy_chart.ts → packages/kbn-visualization-utils/attribute_builder/visualization_types/xy_chart.ts

@@ -1,15 +1,16 @@
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
- * 2.0; you may not use this file except in compliance with the Elastic License
- * 2.0.
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
  */
 
 import type { FormBasedPersistedState, XYLayerConfig, XYState } from '@kbn/lens-plugin/public';
 import type { DataView } from '@kbn/data-views-plugin/public';
 import type { SavedObjectReference } from '@kbn/core/server';
+import type { Chart, ChartConfig, ChartLayer } from '../types';
 import { DEFAULT_LAYER_ID } from '../utils';
-import type { Chart, ChartConfig, ChartLayer } from '../../types';
 
 const ACCESSOR = 'formula_accessor';