Merge branch 'expose-is-kibana-response-helper' of github.com:miltonh…

…ultgren/kibana into expose-is-kibana-response-helper

examples/embeddable_examples/kibana.jsonc

@@ -18,6 +18,6 @@
       "developerExamples",
       "dataViewFieldEditor"
     ],
-    "requiredBundles": ["presentationUtil", "kibanaUtils", "kibanaReact"]
+    "requiredBundles": ["dashboard", "presentationUtil", "kibanaUtils", "kibanaReact"]
   }
 }

examples/embeddable_examples/public/app/register_embeddable.tsx

@@ -12,19 +12,24 @@ import { EuiCodeBlock, EuiSpacer, EuiText } from '@elastic/eui';
 import registerSearchEmbeddableSource from '!!raw-loader!../react_embeddables/search/register_search_embeddable';
 // @ts-ignore
 import registerAttachActionSource from '!!raw-loader!../react_embeddables/search/register_add_search_panel_action';
+// @ts-ignore
+import registerFieldListEmbeddableSource from '!!raw-loader!../react_embeddables/field_list/register_field_list_embeddable';
+// @ts-ignore
+import registerReactEmbeddableSavedObjectSource from '!!raw-loader!../react_embeddables/register_saved_object_example';
 
 export const RegisterEmbeddable = () => {
   return (
     <>
       <EuiText>
+        <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.
         </p>
       </EuiText>
-
+      <EuiSpacer size="s" />
       <EuiCodeBlock language="jsx" fontSize="m" paddingSize="m">
         {registerSearchEmbeddableSource}
       </EuiCodeBlock>
@@ -36,17 +41,58 @@ export const RegisterEmbeddable = () => {
           Run the example embeddables by creating a dashboard, clicking <em>Add panel</em> button,
           and then selecting <em>Embeddable examples</em> group.
         </p>
+      </EuiText>
+
+      <EuiSpacer size="l" />
+
+      <EuiText>
+        <h2>Show embeddables in the Add panel menu</h2>
         <p>
           Add your own embeddables to <em>Add panel</em> menu by attaching an action to the{' '}
           <strong>ADD_PANEL_TRIGGER</strong> trigger. Notice usage of <strong>grouping</strong> to
           nest related panel types and avoid bloating <em>Add panel</em> menu. Please reach out to
           @elastic/kibana-presentation team to coordinate menu updates.
         </p>
       </EuiText>
-
+      <EuiSpacer size="s" />
       <EuiCodeBlock language="jsx" fontSize="m" paddingSize="m">
         {registerAttachActionSource}
       </EuiCodeBlock>
+
+      <EuiSpacer size="l" />
+
+      <EuiText>
+        <h2>Configure initial dashboard placement (optional)</h2>
+        <p>
+          Add an entry to <strong>registerDashboardPanelPlacementSetting</strong> to configure
+          initial dashboard placement. Panel placement lets you configure the width, height, and
+          placement strategy when panels get added to a dashboard. In the example below, the Field
+          List embeddable will be added to dashboards as a narrow and tall panel.
+        </p>
+      </EuiText>
+      <EuiSpacer size="s" />
+
+      <EuiCodeBlock language="jsx" fontSize="m" paddingSize="m">
+        {registerFieldListEmbeddableSource}
+      </EuiCodeBlock>
+
+      <EuiSpacer size="l" />
+
+      <EuiText>
+        <h2>Saved object embeddables</h2>
+        <p>
+          Embeddable factories, such as Lens, Maps, Links, that can reference saved objects should
+          register their saved object types using{' '}
+          <strong>registerReactEmbeddableSavedObject</strong>. The <em>Add from library</em> flyout
+          on Dashboards uses this registry to list saved objects. The example function below could
+          be called from the public start contract for a plugin.
+        </p>
+      </EuiText>
+      <EuiSpacer size="s" />
+
+      <EuiCodeBlock language="jsx" fontSize="m" paddingSize="m">
+        {registerReactEmbeddableSavedObjectSource}
+      </EuiCodeBlock>
     </>
   );
 };

examples/embeddable_examples/public/plugin.ts

@@ -24,8 +24,9 @@ import { DATA_TABLE_ID } from './react_embeddables/data_table/constants';
 import { registerCreateDataTableAction } from './react_embeddables/data_table/create_data_table_action';
 import { EUI_MARKDOWN_ID } from './react_embeddables/eui_markdown/constants';
 import { registerCreateEuiMarkdownAction } from './react_embeddables/eui_markdown/create_eui_markdown_action';
-import { FIELD_LIST_ID } from './react_embeddables/field_list/constants';
 import { registerCreateFieldListAction } from './react_embeddables/field_list/create_field_list_action';
+import { FIELD_LIST_ID } from './react_embeddables/field_list/constants';
+import { registerFieldListPanelPlacementSetting } from './react_embeddables/field_list/register_field_list_embeddable';
 import { registerAddSearchPanelAction } from './react_embeddables/search/register_add_search_panel_action';
 import { registerSearchEmbeddable } from './react_embeddables/search/register_search_embeddable';
 
@@ -58,6 +59,7 @@ export class EmbeddableExamplesPlugin implements Plugin<void, void, SetupDeps, S
       );
       return getFieldListFactory(core, deps);
     });
+    registerFieldListPanelPlacementSetting();
 
     registerCreateEuiMarkdownAction(deps.uiActions);
     registerReactEmbeddableFactory(EUI_MARKDOWN_ID, async () => {

examples/embeddable_examples/public/react_embeddables/field_list/field_list_react_embeddable.tsx

@@ -8,17 +8,11 @@
 
 import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
 import { css } from '@emotion/react';
-import { ChartsPluginStart } from '@kbn/charts-plugin/public';
 import { Reference } from '@kbn/content-management-utils';
 import { CoreStart } from '@kbn/core-lifecycle-browser';
-import { DataPublicPluginStart } from '@kbn/data-plugin/public';
 import { DataView } from '@kbn/data-views-plugin/common';
-import {
-  DataViewsPublicPluginStart,
-  DATA_VIEW_SAVED_OBJECT_TYPE,
-} from '@kbn/data-views-plugin/public';
+import { DATA_VIEW_SAVED_OBJECT_TYPE } from '@kbn/data-views-plugin/public';
 import { ReactEmbeddableFactory } from '@kbn/embeddable-plugin/public';
-import { FieldFormatsStart } from '@kbn/field-formats-plugin/public';
 import { i18n } from '@kbn/i18n';
 import { initializeTitles, useBatchedPublishingSubjects } from '@kbn/presentation-publishing';
 import { LazyDataViewPicker, withSuspense } from '@kbn/presentation-util-plugin/public';
@@ -31,7 +25,7 @@ import { cloneDeep } from 'lodash';
 import React, { useEffect } from 'react';
 import { BehaviorSubject, skip, Subscription, switchMap } from 'rxjs';
 import { FIELD_LIST_DATA_VIEW_REF_NAME, FIELD_LIST_ID } from './constants';
-import { FieldListApi, FieldListSerializedStateState } from './types';
+import { FieldListApi, Services, FieldListSerializedStateState } from './types';
 
 const DataViewPicker = withSuspense(LazyDataViewPicker, null);
 
@@ -48,17 +42,7 @@ const getCreationOptions: UnifiedFieldListSidebarContainerProps['getCreationOpti
 
 export const getFieldListFactory = (
   core: CoreStart,
-  {
-    dataViews,
-    data,
-    charts,
-    fieldFormats,
-  }: {
-    dataViews: DataViewsPublicPluginStart;
-    data: DataPublicPluginStart;
-    charts: ChartsPluginStart;
-    fieldFormats: FieldFormatsStart;
-  }
+  { dataViews, data, charts, fieldFormats }: Services
 ) => {
   const fieldListEmbeddableFactory: ReactEmbeddableFactory<
     FieldListSerializedStateState,

examples/embeddable_examples/public/react_embeddables/field_list/register_field_list_embeddable.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 {
+  registerDashboardPanelPlacementSetting,
+  PanelPlacementStrategy,
+} from '@kbn/dashboard-plugin/public';
+import { FIELD_LIST_ID } from './constants';
+import { FieldListSerializedStateState } from './types';
+
+const getPanelPlacementSetting = (serializedState?: FieldListSerializedStateState) => {
+  // Consider using the serialized state to determine the width, height, and strategy
+  return {
+    width: 12,
+    height: 36,
+    strategy: PanelPlacementStrategy.placeAtTop,
+  };
+};
+
+export function registerFieldListPanelPlacementSetting() {
+  registerDashboardPanelPlacementSetting(FIELD_LIST_ID, getPanelPlacementSetting);
+}

examples/embeddable_examples/public/react_embeddables/field_list/types.ts

@@ -6,7 +6,11 @@
  * Side Public License, v 1.
  */
 
+import { ChartsPluginStart } from '@kbn/charts-plugin/public';
+import { DataPublicPluginStart } from '@kbn/data-plugin/public';
+import { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public';
 import { DefaultEmbeddableApi } from '@kbn/embeddable-plugin/public';
+import { FieldFormatsStart } from '@kbn/field-formats-plugin/public';
 import { PublishesDataViews, SerializedTitles } from '@kbn/presentation-publishing';
 import { PublishesSelectedFields } from './publishes_selected_fields';
 
@@ -16,3 +20,10 @@ export type FieldListSerializedStateState = SerializedTitles & {
 };
 
 export type FieldListApi = DefaultEmbeddableApi & PublishesSelectedFields & PublishesDataViews;
+
+export interface Services {
+  dataViews: DataViewsPublicPluginStart;
+  data: DataPublicPluginStart;
+  charts: ChartsPluginStart;
+  fieldFormats: FieldFormatsStart;
+}

examples/embeddable_examples/public/react_embeddables/register_saved_object_example.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 { registerReactEmbeddableSavedObject } from '@kbn/embeddable-plugin/public';
+
+const MY_EMBEDDABLE_TYPE = 'myEmbeddableType';
+const MY_SAVED_OBJECT_TYPE = 'mySavedObjectType';
+const APP_ICON = 'logoKibana';
+
+export const registerMyEmbeddableSavedObject = () =>
+  registerReactEmbeddableSavedObject({
+    onAdd: (container, savedObject) => {
+      container.addNewPanel({
+        panelType: MY_EMBEDDABLE_TYPE,
+        initialState: savedObject.attributes,
+      });
+    },
+    embeddableType: MY_EMBEDDABLE_TYPE,
+    savedObjectType: MY_SAVED_OBJECT_TYPE,
+    savedObjectName: 'Some saved object',
+    getIconForSavedObject: () => APP_ICON,
+  });

examples/embeddable_examples/tsconfig.json

@@ -15,6 +15,7 @@
   "kbn_references": [
     "@kbn/core",
     "@kbn/ui-actions-plugin",
+    "@kbn/dashboard-plugin",
     "@kbn/embeddable-plugin",
     "@kbn/presentation-publishing",
     "@kbn/ui-theme",

packages/kbn-doc-links/src/get_doc_links.ts

@@ -480,6 +480,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
       privileges: `${SECURITY_SOLUTION_DOCS}endpoint-management-req.html`,
       manageDetectionRules: `${SECURITY_SOLUTION_DOCS}rules-ui-management.html`,
       createEsqlRuleType: `${SECURITY_SOLUTION_DOCS}rules-ui-create.html#create-esql-rule`,
+      ruleUiAdvancedParams: `${SECURITY_SOLUTION_DOCS}rules-ui-create.html#rule-ui-advanced-params`,
       entityAnalytics: {
         riskScorePrerequisites: `${SECURITY_SOLUTION_DOCS}ers-requirements.html`,
         hostRiskScore: `${SECURITY_SOLUTION_DOCS}host-risk-score.html`,

packages/kbn-doc-links/src/types.ts

@@ -355,6 +355,7 @@ export interface DocLinks {
     readonly privileges: string;
     readonly manageDetectionRules: string;
     readonly createEsqlRuleType: string;
+    readonly ruleUiAdvancedParams: string;
     readonly entityAnalytics: {
       readonly riskScorePrerequisites: string;
       readonly hostRiskScore: string;