Move Lens attribute builder to a package

.github/CODEOWNERS

@@ -460,6 +460,7 @@ src/plugins/kibana_usage_collection @elastic/kibana-core
 src/plugins/kibana_utils @elastic/kibana-app-services
 x-pack/plugins/kubernetes_security @elastic/sec-cloudnative-integrations
 packages/kbn-language-documentation-popover @elastic/kibana-visualizations
+packages/kbn-lens-embeddable-utils @elastic/kibana-visualizations
 x-pack/plugins/lens @elastic/kibana-visualizations
 x-pack/plugins/license_api_guard @elastic/platform-deployment-management
 x-pack/plugins/license_management @elastic/platform-deployment-management

package.json

@@ -481,6 +481,7 @@
     "@kbn/kibana-utils-plugin": "link:src/plugins/kibana_utils",
     "@kbn/kubernetes-security-plugin": "link:x-pack/plugins/kubernetes_security",
     "@kbn/language-documentation-popover": "link:packages/kbn-language-documentation-popover",
+    "@kbn/lens-embeddable-utils": "link:packages/kbn-lens-embeddable-utils",
     "@kbn/lens-plugin": "link:x-pack/plugins/lens",
     "@kbn/license-api-guard-plugin": "link:x-pack/plugins/license_api_guard",
     "@kbn/license-management-plugin": "link:x-pack/plugins/license_management",

packages/kbn-lens-embeddable-utils/README.md

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

x-pack/plugins/infra/public/common/visualizations/lens/README.md → packages/kbn-lens-embeddable-utils/attribute_builder/README.md

@@ -22,9 +22,9 @@ const metricChart = new MetricChart({
         },
       },
     },
-    formulaAPI,
   }),
   dataView,
+  formulaAPI
 });
 ```
 
@@ -45,9 +45,9 @@ const xyChart = new XYChart({
         },
       },
     }],
-    formulaAPI,
   })],
   dataView,
+  formulaAPI
 });
 ```
 
@@ -69,7 +69,6 @@ const xyChart = new XYChart({
           },
         },
       }],
-      formulaAPI,
     }),
     new XYReferenceLineLayer({
       data: [{
@@ -84,6 +83,7 @@ const xyChart = new XYChart({
     }),
   ],
   dataView,
+  formulaAPI
 });
 ```
 
@@ -114,10 +114,10 @@ const xyChart = new XYChart({
           decimals: 1,
         },
       },
-    }],
-    formulaAPI,
+    }]
   }),
   dataView,
+  formulaAPI
 });
 ```
 
@@ -150,10 +150,10 @@ const builder = new LensAttributesBuilder({
           },
         },
       },
-      formulaAPI,
     }),
     dataView,
-  })
+    formulaAPI
+  }),
 });
 
 const lensAttributes = builder.build();

x-pack/plugins/infra/public/common/visualizations/lens/data_view_cache.ts → packages/kbn-lens-embeddable-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-lens-embeddable-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',
@@ -106,10 +107,10 @@ describe('lens_attributes_builder', () => {
       const metriChart = new MetricChart({
         layers: new MetricLayer({
           data: getFormula(AVERAGE_CPU_USER_FORMULA),
-          formulaAPI,
         }),
 
         dataView: mockDataView,
+        formulaAPI,
       });
       const builder = new LensAttributesBuilder({ visualization: metriChart });
       const {
@@ -148,10 +149,10 @@ describe('lens_attributes_builder', () => {
           options: {
             showTrendLine: true,
           },
-          formulaAPI,
         }),
 
         dataView: mockDataView,
+        formulaAPI,
       });
       const builder = new LensAttributesBuilder({ visualization: metriChart });
       const {
@@ -204,10 +205,10 @@ describe('lens_attributes_builder', () => {
         layers: [
           new XYDataLayer({
             data: [getFormula(AVERAGE_CPU_USER_FORMULA)],
-            formulaAPI,
           }),
         ],
         dataView: mockDataView,
+        formulaAPI,
       });
       const builder = new LensAttributesBuilder({ visualization: xyChart });
       const {
@@ -248,13 +249,13 @@ describe('lens_attributes_builder', () => {
         layers: [
           new XYDataLayer({
             data: [getFormula(AVERAGE_CPU_USER_FORMULA)],
-            formulaAPI,
           }),
           new XYReferenceLinesLayer({
             data: [getFormula('1')],
           }),
         ],
         dataView: mockDataView,
+        formulaAPI,
       });
       const builder = new LensAttributesBuilder({ visualization: xyChart });
       const {
@@ -316,10 +317,10 @@ describe('lens_attributes_builder', () => {
         layers: [
           new XYDataLayer({
             data: [getFormula(AVERAGE_CPU_USER_FORMULA), getFormula(AVERAGE_CPU_SYSTEM_FORMULA)],
-            formulaAPI,
           }),
         ],
         dataView: mockDataView,
+        formulaAPI,
       });
       const builder = new LensAttributesBuilder({ visualization: xyChart });
       const {

x-pack/plugins/infra/public/common/visualizations/lens/lens_attributes_builder.ts → packages/kbn-lens-embeddable-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-lens-embeddable-utils/attribute_builder/types.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 BaseChartColumn {
+  getFormulaConfig(): FormulaConfig;
+}
+
+export interface ChartColumn extends BaseChartColumn {
+  getData(
+    id: string,
+    baseLayer: PersistedIndexPatternLayer,
+    dataView: DataView,
+    formulaAPI: FormulaPublicApi
+  ): PersistedIndexPatternLayer;
+}
+
+export interface StaticChartColumn extends BaseChartColumn {
+  getData(id: string, baseLayer: PersistedIndexPatternLayer): PersistedIndexPatternLayer;
+}
+
+// Layer
+export type LensLayerConfig = XYLayerConfig | MetricVisualizationState;
+
+export interface ChartLayer<TLayerConfig extends LensLayerConfig> {
+  getName(): string | undefined;
+  getLayer(
+    layerId: string,
+    accessorId: string,
+    dataView: DataView,
+    formulaAPI: FormulaPublicApi
+  ): 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>>
+> {
+  formulaAPI: FormulaPublicApi;
+  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-lens-embeddable-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-lens-embeddable-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-lens-embeddable-utils/attribute_builder/visualization_types/layers/columns/formula.ts

@@ -1,16 +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 { 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) {}
+  constructor(private formulaConfig: FormulaConfig) {}
 
   getFormulaConfig(): FormulaConfig {
     return this.formulaConfig;
@@ -19,10 +20,11 @@ export class FormulaColumn implements ChartColumn {
   getData(
     id: string,
     baseLayer: PersistedIndexPatternLayer,
-    dataView: DataView
+    dataView: DataView,
+    formulaAPI: FormulaPublicApi
   ): PersistedIndexPatternLayer {
     const { value, ...rest } = this.getFormulaConfig();
-    const formulaLayer = this.formulaAPI.insertOrReplaceFormulaColumn(
+    const formulaLayer = formulaAPI.insertOrReplaceFormulaColumn(
       id,
       { formula: value, ...rest },
       baseLayer,