Merge branch 'main' into sharedux/cleanup-tomountpoint-deprecations-xii-observabilitysolution

Author: tsullivan

dev_docs/key_concepts/embeddables.mdx

@@ -7,5 +7,4 @@ date: 2024-05-09
 tags: ['kibana', 'dev', 'contributor', 'api docs']
 ---
 
-Embeddable documentation and examples are bundled with Kibana and accessable by running `yarn start --run-examples`.
-Navigate to `http://localhost:5601/app/embeddablesApp`.
+Embeddable documentation available at [/src/plugins/embeddable/README.md](https://github.com/elastic/kibana/blob/main/src/plugins/embeddable/README.md)

docs/developer/plugin-list.asciidoc

@@ -99,8 +99,7 @@ This API doesn't support angular, for registering angular dev tools, bootstrap a
 
 
 |{kib-repo}blob/{branch}/src/plugins/embeddable/README.md[embeddable]
-|Embeddable documentation and examples are bundled with Kibana and accessable by running yarn start --run-examples.
-Navigate to http://localhost:5601/app/embeddablesApp.
+|Embeddables are React components that manage their own state, can be serialized and deserialized, and return an API that can be used to interact with them imperatively.
 
 
 |{kib-repo}blob/{branch}/src/plugins/es_ui_shared/README.md[esUiShared]

examples/embeddable_examples/public/app/overview.tsx

@@ -7,16 +7,19 @@
  */
 
 import React from 'react';
-
-import { EuiText } from '@elastic/eui';
+import { css } from '@emotion/react';
+import { EuiMarkdownFormat } from '@elastic/eui';
+// @ts-ignore
+import overviewMarkdown from '!!raw-loader!@kbn/embeddable-plugin/README.md';
 
 export const Overview = () => {
   return (
-    <EuiText>
-      <p>
-        Embeddables are React components that manage their own state, can be serialized and
-        deserialized, and return an API that can be used to interact with them imperatively.
-      </p>
-    </EuiText>
+    <EuiMarkdownFormat
+      css={css`
+        width: 75%;
+      `}
+    >
+      {overviewMarkdown}
+    </EuiMarkdownFormat>
   );
 };

examples/embeddable_examples/public/app/register_embeddable.tsx

@@ -24,9 +24,9 @@ export const RegisterEmbeddable = () => {
         <h2>Register a new embeddable type</h2>
         <p>
           This plugin registers several embeddable types with{' '}
-          <strong>registerReactEmbeddableFactory</strong> during plugin start. The code example
-          below shows Search embeddable registration. Notice how the embeddable factory is imported
-          asynchronously to limit initial page load size.
+          <strong>registerReactEmbeddableFactory</strong>. The code example below shows Search
+          embeddable registration. The embeddable factory is imported asynchronously to limit
+          initial page load size.
         </p>
       </EuiText>
       <EuiSpacer size="s" />

examples/embeddable_examples/public/react_embeddables/search/search_embeddable_renderer.tsx

@@ -41,13 +41,11 @@ export function SearchEmbeddableRenderer(props: Props) {
   }, [props.timeRange, parentApi.timeRange$]);
 
   return (
-    <div className="mapEmbeddableContainer">
-      <ReactEmbeddableRenderer<SearchSerializedState, SearchApi>
-        type={SEARCH_EMBEDDABLE_ID}
-        state={initialState}
-        parentApi={parentApi}
-        hidePanelChrome={true}
-      />
-    </div>
+    <ReactEmbeddableRenderer<SearchSerializedState, SearchApi>
+      type={SEARCH_EMBEDDABLE_ID}
+      state={initialState}
+      parentApi={parentApi}
+      hidePanelChrome={true}
+    />
   );
 }

package.json

@@ -1097,7 +1097,7 @@
     "pretty-ms": "6.0.0",
     "prop-types": "^15.8.1",
     "proxy-from-env": "1.0.0",
-    "puppeteer": "22.3.0",
+    "puppeteer": "22.8.1",
     "query-string": "^6.13.2",
     "rbush": "^3.0.1",
     "re-resizable": "^6.9.9",

packages/presentation/presentation_publishing/index.ts

@@ -109,6 +109,7 @@ export {
 export {
   apiPublishesPanelDescription,
   apiPublishesWritablePanelDescription,
+  getPanelDescription,
   type PublishesPanelDescription,
   type PublishesWritablePanelDescription,
 } from './interfaces/titles/publishes_panel_description';

packages/presentation/presentation_publishing/interfaces/titles/publishes_panel_description.test.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 { BehaviorSubject } from 'rxjs';
+import { getPanelDescription } from './publishes_panel_description';
+
+describe('getPanelDescription', () => {
+  test('should return default description when description is undefined', () => {
+    const api = {
+      panelDescription: new BehaviorSubject<string | undefined>(undefined),
+      defaultPanelDescription: new BehaviorSubject<string | undefined>('default description'),
+    };
+    expect(getPanelDescription(api)).toBe('default description');
+  });
+
+  test('should return empty description when description is empty string', () => {
+    const api = {
+      panelDescription: new BehaviorSubject<string | undefined>(''),
+      defaultPanelDescription: new BehaviorSubject<string | undefined>('default description'),
+    };
+    expect(getPanelDescription(api)).toBe('');
+  });
+
+  test('should return description when description is provided', () => {
+    const api = {
+      panelDescription: new BehaviorSubject<string | undefined>('custom description'),
+      defaultPanelDescription: new BehaviorSubject<string | undefined>('default description'),
+    };
+    expect(getPanelDescription(api)).toBe('custom description');
+  });
+});

packages/presentation/presentation_publishing/interfaces/titles/publishes_panel_description.ts

@@ -13,6 +13,10 @@ export interface PublishesPanelDescription {
   defaultPanelDescription?: PublishingSubject<string | undefined>;
 }
 
+export function getPanelDescription(api: Partial<PublishesPanelDescription>): string | undefined {
+  return api.panelDescription?.value ?? api.defaultPanelDescription?.value;
+}
+
 export type PublishesWritablePanelDescription = PublishesPanelDescription & {
   setPanelDescription: (newTitle: string | undefined) => void;
 };

packages/presentation/presentation_publishing/interfaces/titles/publishes_panel_title.test.ts

@@ -18,12 +18,12 @@ describe('getPanelTitle', () => {
     expect(getPanelTitle(api)).toBe('default title');
   });
 
-  test('should return default title when title is empty string', () => {
+  test('should return empty title when title is empty string', () => {
     const api = {
       panelTitle: new BehaviorSubject<string | undefined>(''),
       defaultPanelTitle: new BehaviorSubject<string | undefined>('default title'),
     };
-    expect(getPanelTitle(api)).toBe('default title');
+    expect(getPanelTitle(api)).toBe('');
   });
 
   test('should return title when title is provided', () => {