[Lens] Integrate Config Builder into APIs and transforms

.github/CODEOWNERS

@@ -522,6 +522,7 @@ src/platform/packages/shared/kbn-io-ts-utils @elastic/obs-knowledge-team
 src/platform/packages/shared/kbn-jest-benchmarks @elastic/obs-ui-devex-team
 src/platform/packages/shared/kbn-lazy-object @elastic/kibana-operations
 src/platform/packages/shared/kbn-lens-common @elastic/kibana-visualizations
+src/platform/packages/shared/kbn-lens-common-2 @elastic/kibana-visualizations
 src/platform/packages/shared/kbn-lens-embeddable-utils @elastic/kibana-visualizations
 src/platform/packages/shared/kbn-licensing-types @elastic/kibana-core
 src/platform/packages/shared/kbn-lock-manager @elastic/obs-ai-assistant

package.json

@@ -688,6 +688,7 @@
     "@kbn/langgraph-checkpoint-saver": "link:x-pack/platform/packages/shared/kbn-langgraph-checkpoint-saver",
     "@kbn/language-documentation": "link:src/platform/packages/private/kbn-language-documentation",
     "@kbn/lens-common": "link:src/platform/packages/shared/kbn-lens-common",
+    "@kbn/lens-common-2": "link:src/platform/packages/shared/kbn-lens-common-2",
     "@kbn/lens-config-builder-example-plugin": "link:x-pack/examples/lens_config_builder_example",
     "@kbn/lens-embeddable-utils": "link:src/platform/packages/shared/kbn-lens-embeddable-utils",
     "@kbn/lens-formula-docs": "link:src/platform/packages/private/kbn-lens-formula-docs",

packages/kbn-optimizer/limits.yml

@@ -93,7 +93,7 @@ pageLoadAssetSize:
   kibanaReact: 22503
   kibanaUsageCollection: 1736
   kibanaUtils: 54848
-  lens: 65189
+  lens: 71747
   licenseManagement: 8265
   licensing: 10078
   links: 8620

src/platform/packages/shared/kbn-lens-common-2/README.md

@@ -0,0 +1,7 @@
+# @kbn/lens-common-2
+
+Split off of `@kbn/lens-common` because of circular dependence issues importing LensApiSchemaType.
+
+```ts
+import type { LensApiSchemaType } from '@kbn/lens-embeddable-utils';
+```

src/platform/packages/shared/kbn-lens-common-2/index.ts

@@ -0,0 +1,109 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import type {
+  HasEditCapabilities,
+  HasLibraryTransforms,
+  HasSupportedTriggers,
+  PublishesBlockingError,
+  PublishesDataLoading,
+  PublishesDataViews,
+  PublishesDisabledActionIds,
+  PublishesRendered,
+  PublishesSavedObjectId,
+  PublishesUnifiedSearch,
+  PublishesViewMode,
+  PublishesWritableDescription,
+  PublishesWritableTitle,
+} from '@kbn/presentation-publishing';
+import type { LensApiSchemaType } from '@kbn/lens-embeddable-utils';
+import type { Simplify } from '@kbn/chart-expressions-common';
+import type {
+  LensByValueBase,
+  LensSerializedSharedState,
+  LensByRefSerializedState,
+  LensInspectorAdapters,
+  LensRequestHandlersProps,
+  LensApiCallbacks,
+  LensHasEditPanel,
+  LensSerializedState,
+} from '@kbn/lens-common';
+import type { PublishesSearchSession } from '@kbn/presentation-publishing/interfaces/fetch/publishes_search_session';
+import type { DefaultEmbeddableApi } from '@kbn/embeddable-plugin/public';
+
+type LensByValueAPIConfigBase = Omit<LensByValueBase, 'attributes'> & {
+  // Temporarily allow both old and new attributes until all are new types are supported and feature flag removed
+  attributes: LensApiSchemaType | LensByValueBase['attributes'];
+};
+
+export type LensByValueSerializedAPIConfig = Simplify<
+  LensSerializedSharedState & LensByValueAPIConfigBase
+>;
+export type LensByRefSerializedAPIConfig = LensByRefSerializedState;
+
+/**
+ * Combined properties of API config used in dashboard API for lens panels
+ *
+ *  Includes:
+ * - Lens document state (for by-value)
+ * - Panel settings
+ * - other props from the embeddable
+ */
+export type LensSerializedAPIConfig = LensByRefSerializedAPIConfig | LensByValueSerializedAPIConfig;
+
+export interface LegacyLensStateApi {
+  /**
+   * Returns legacy serialized state to avoid duplicate transformations
+   *
+   * @deprecated use `serializeState` instead
+   */
+  getLegacySerializedState: () => LensSerializedState;
+}
+
+export type LensApi = Simplify<
+  DefaultEmbeddableApi<LensSerializedAPIConfig> &
+    // This is used by actions to operate the edit action
+    HasEditCapabilities &
+    // for blocking errors leverage the embeddable panel UI
+    PublishesBlockingError &
+    // This is used by dashboard/container to show filters/queries on the panel
+    PublishesUnifiedSearch &
+    // Forward the search session id
+    PublishesSearchSession &
+    // Let the container know the loading state
+    PublishesDataLoading &
+    // Let the container know when the rendering has completed rendering
+    PublishesRendered &
+    // Let the container know the used data views
+    PublishesDataViews &
+    // Let the container operate on panel title/description
+    PublishesWritableTitle &
+    PublishesWritableDescription &
+    // This embeddable can narrow down specific triggers usage
+    HasSupportedTriggers &
+    PublishesDisabledActionIds &
+    // Offers methods to operate from/on the linked saved object
+    HasLibraryTransforms<LensSerializedAPIConfig, LensSerializedAPIConfig> &
+    // Let the container know the view mode
+    PublishesViewMode &
+    // Let the container know the saved object id
+    PublishesSavedObjectId &
+    // Lens specific API methods:
+    // Let the container know when the data has been loaded/updated
+    LensInspectorAdapters &
+    LensRequestHandlersProps &
+    LensApiCallbacks &
+    LensHasEditPanel &
+    LegacyLensStateApi
+>;
+
+/**
+ * Backward compatibility types
+ */
+export type LensEmbeddableOutput = LensApi;

src/platform/packages/shared/kbn-lens-common-2/jest.config.js

@@ -0,0 +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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+module.exports = {
+  preset: '@kbn/test/jest_node',
+  rootDir: '../../../../..',
+  roots: ['<rootDir>/src/platform/packages/shared/kbn-lens-common-2'],
+};

src/platform/packages/shared/kbn-lens-common-2/kibana.jsonc

@@ -0,0 +1,7 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/lens-common-2",
+  "owner": "@elastic/kibana-visualizations",
+  "group": "platform",
+  "visibility": "private"
+}

src/platform/packages/shared/kbn-lens-common-2/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@kbn/lens-common-2",
+  "private": true,
+  "version": "1.0.0",
+  "license": "Elastic License 2.0 OR AGPL-3.0-only OR SSPL-1.0"
+}

src/platform/packages/shared/kbn-lens-common-2/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "extends": "../../../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "target/types",
+    "types": [
+      "jest",
+      "node"
+    ]
+  },
+  "include": [
+    "**/*.ts",
+  ],
+  "exclude": [
+    "target/**/*"
+  ],
+  "kbn_references": [
+    "@kbn/lens-common",
+    "@kbn/presentation-publishing",
+    "@kbn/lens-embeddable-utils",
+    "@kbn/chart-expressions-common",
+    "@kbn/embeddable-plugin"
+  ]
+}

src/platform/packages/shared/kbn-lens-common/embeddable/types.ts

@@ -7,9 +7,6 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import type { BehaviorSubject } from 'rxjs';
-
-import type { HasSerializedChildState } from '@kbn/presentation-containers';
 import type {
   AggregateQuery,
   ExecutionContextSearch,
@@ -31,23 +28,10 @@ import type { AllowedPartitionOverrides } from '@kbn/expression-partition-vis-pl
 import type { AllowedGaugeOverrides } from '@kbn/expression-gauge-plugin/common';
 import type { Reference } from '@kbn/content-management-utils';
 import type {
-  HasEditCapabilities,
-  HasLibraryTransforms,
-  HasSupportedTriggers,
-  PublishesBlockingError,
-  PublishesDataLoading,
   PublishesDataViews,
-  PublishesDisabledActionIds,
-  PublishesRendered,
-  PublishesSavedObjectId,
-  PublishesUnifiedSearch,
-  PublishesViewMode,
-  PublishesWritableDescription,
-  PublishesWritableTitle,
   PublishingSubject,
   SerializedTitles,
   ViewMode,
-  useSearchApi,
 } from '@kbn/presentation-publishing';
 import type { Action } from '@kbn/ui-actions-plugin/public';
 import type {
@@ -59,8 +43,6 @@ import type { PaletteOutput } from '@kbn/coloring';
 import type { ESQLControlVariable } from '@kbn/esql-types';
 import type { Adapters } from '@kbn/inspector-plugin/common';
 import type { InspectorOptions } from '@kbn/inspector-plugin/public';
-import type { DefaultEmbeddableApi } from '@kbn/embeddable-plugin/public';
-import type { PublishesSearchSession } from '@kbn/presentation-publishing/interfaces/fetch/publishes_search_session';
 import type { DynamicActionsSerializedState } from '@kbn/embeddable-enhanced-plugin/public';
 import type { DefaultInspectorAdapters, RenderMode } from '@kbn/expressions-plugin/common';
 import type { CanAddNewPanel } from '@kbn/presentation-containers';
@@ -249,7 +231,7 @@ export interface LensSharedProps {
   esqlVariables?: ESQLControlVariable[];
 }
 
-interface LensRequestHandlersProps {
+export interface LensRequestHandlersProps {
   /**
    * Custom abort controller to be used for the ES client
    */
@@ -265,7 +247,7 @@ interface LensRequestHandlersProps {
  * * Panel settings
  * * other props from the embeddable
  */
-type LensSerializedSharedState = Simplify<
+export type LensSerializedSharedState = Simplify<
   LensOverrides &
     LensWithReferences &
     LensUnifiedSearchContext &
@@ -377,42 +359,6 @@ export interface LensInspectorAdapters {
   adapters$: PublishingSubject<Adapters>;
 }
 
-export type LensApi = Simplify<
-  DefaultEmbeddableApi<LensSerializedState> &
-    // This is used by actions to operate the edit action
-    HasEditCapabilities &
-    // for blocking errors leverage the embeddable panel UI
-    PublishesBlockingError &
-    // This is used by dashboard/container to show filters/queries on the panel
-    PublishesUnifiedSearch &
-    // Forward the search session id
-    PublishesSearchSession &
-    // Let the container know the loading state
-    PublishesDataLoading &
-    // Let the container know when the rendering has completed rendering
-    PublishesRendered &
-    // Let the container know the used data views
-    PublishesDataViews &
-    // Let the container operate on panel title/description
-    PublishesWritableTitle &
-    PublishesWritableDescription &
-    // This embeddable can narrow down specific triggers usage
-    HasSupportedTriggers &
-    PublishesDisabledActionIds &
-    // Offers methods to operate from/on the linked saved object
-    HasLibraryTransforms<LensSerializedState, LensSerializedState> &
-    // Let the container know the view mode
-    PublishesViewMode &
-    // Let the container know the saved object id
-    PublishesSavedObjectId &
-    // Lens specific API methods:
-    // Let the container know when the data has been loaded/updated
-    LensInspectorAdapters &
-    LensRequestHandlersProps &
-    LensApiCallbacks &
-    LensHasEditPanel
->;
-
 // This is an API only used internally to the embeddable but not exported elsewhere
 // there's some overlapping between this and the LensApi but they are shared references
 export type LensInternalApi = Simplify<
@@ -528,33 +474,9 @@ export type LensByValueInput = Omit<LensRendererPrivateProps, 'savedObjectId'>;
 export type LensByReferenceInput = Omit<LensRendererPrivateProps, 'attributes'>;
 export type TypedLensByValueInput = Omit<LensRendererProps, 'savedObjectId'>;
 export type LensEmbeddableInput = LensByValueInput | LensByReferenceInput;
-export type LensEmbeddableOutput = LensApi;
 
 export interface ESQLVariablesCompatibleDashboardApi {
   esqlVariables$: PublishingSubject<ESQLControlVariable[]>;
   controlGroupApi$: PublishingSubject<Partial<CanAddNewPanel> | undefined>;
   children$: PublishingSubject<{ [key: string]: unknown }>;
 }
-
-type SearchApi = ReturnType<typeof useSearchApi>;
-
-interface GeneralLensApi {
-  searchSessionId$: BehaviorSubject<string | undefined>;
-  disabledActionIds$: BehaviorSubject<string[] | undefined>;
-  setDisabledActionIds: (ids: string[] | undefined) => void;
-  viewMode$: BehaviorSubject<ViewMode | undefined>;
-  settings: {
-    syncColors$: BehaviorSubject<boolean>;
-    syncCursor$: BehaviorSubject<boolean>;
-    syncTooltips$: BehaviorSubject<boolean>;
-  };
-  forceDSL?: boolean;
-  esqlVariables$: BehaviorSubject<ESQLControlVariable[] | undefined>;
-  hideTitle$: BehaviorSubject<boolean | undefined>;
-  reload$: BehaviorSubject<void>;
-}
-
-export type LensParentApi = SearchApi &
-  LensRuntimeState &
-  GeneralLensApi &
-  HasSerializedChildState<LensSerializedState>;

src/platform/packages/shared/kbn-lens-common/index.ts

@@ -244,6 +244,7 @@ export type {
   LensEmbeddableInput,
   TypedLensByValueInput,
   LensSerializedState,
+  LensSerializedSharedState,
   LensByReferenceInput,
   LensSavedObjectAttributes,
   VisualizationContextHelper,
@@ -258,6 +259,7 @@ export type {
   IntegrationCallbacks,
   LensPublicCallbacks,
   LensApiCallbacks,
+  LensRequestHandlersProps,
   LensUnifiedSearchContext,
   LensPanelProps,
   LensSharedProps,
@@ -267,15 +269,12 @@ export type {
   LensRuntimeState,
   LensHasEditPanel,
   LensInspectorAdapters,
-  LensApi,
-  LensParentApi,
   LensInternalApi,
   ExpressionWrapperProps,
   GetStateType,
   StructuredDatasourceStates,
   LensByValueInput,
   TypedLensSerializedState,
-  LensEmbeddableOutput,
   ESQLVariablesCompatibleDashboardApi,
   LensByValueBase,
 } from './embeddable/types';
@@ -296,6 +295,7 @@ export {
   LENS_RANGE_MODES,
 } from './datasources/constants';
 export {
+  LENS_UNKNOWN_VIS,
   LENS_CATEGORY_DISPLAY,
   LENS_NUMBER_DISPLAY,
   LENS_LEGEND_DISPLAY,

src/platform/packages/shared/kbn-lens-common/visualizations/constants.ts

@@ -7,6 +7,8 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+export const LENS_UNKNOWN_VIS = 'UNKNOWN';
+
 export const LENS_CATEGORY_DISPLAY = {
   DEFAULT: 'default',
   INSIDE: 'inside',