[Enterprise Search] Reuse serverless panels on Enterprise Search (#16…

…3179) ## Summary Reuse Serverless panels for API index overview. Updated Enterprise Search overview to latests designs. Note: There will be another PR for layout changes on overview afterwards. https://github.com/elastic/kibana/assets/1410658/51537e57-e822-4b9f-b9ed-49d82d192690 https://github.com/elastic/kibana/assets/1410658/a3696897-40a5-4cb3-9fe6-53ce5b8f560f https://github.com/elastic/kibana/assets/1410658/de752063-04ff-42a3-8538-7fb10a9df1ca ![Screenshot 2023-08-09 at 01 55 33](https://github.com/elastic/kibana/assets/1410658/083504c4-7fa6-424b-a833-89dd73c61e49) ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Liam Thompson <[email protected]>
elastic · Aug 11, 2023 · 1e7efae · 1e7efae
1 parent 04d8a26
commit 1e7efae
Show file tree

Hide file tree

Showing 81 changed files with 3,383 additions and 1,037 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -588,6 +588,7 @@ examples/screenshot_mode_example @elastic/kibana-app-services
 src/plugins/screenshot_mode @elastic/appex-sharedux
 x-pack/examples/screenshotting_example @elastic/appex-sharedux
 x-pack/plugins/screenshotting @elastic/kibana-reporting-services
+packages/kbn-search-api-panels @elastic/enterprise-search-frontend
 examples/search_examples @elastic/kibana-data-discovery
 packages/kbn-search-response-warnings @elastic/kibana-data-discovery
 x-pack/plugins/searchprofiler @elastic/platform-deployment-management

diff --git a/.i18nrc.json b/.i18nrc.json
@@ -92,6 +92,7 @@
     "server": "src/legacy/server",
     "share": "src/plugins/share",
     "sharedUXPackages": "packages/shared-ux",
+    "searchApiPanels": "packages/kbn-search-api-panels/",
     "searchResponseWarnings": "packages/kbn-search-response-warnings",
     "securitySolutionPackages": "x-pack/packages/security-solution",
     "serverlessPackages": "packages/serverless",

diff --git a/package.json b/package.json
@@ -591,6 +591,7 @@
     "@kbn/screenshot-mode-plugin": "link:src/plugins/screenshot_mode",
     "@kbn/screenshotting-example-plugin": "link:x-pack/examples/screenshotting_example",
     "@kbn/screenshotting-plugin": "link:x-pack/plugins/screenshotting",
+    "@kbn/search-api-panels": "link:packages/kbn-search-api-panels",
     "@kbn/search-examples-plugin": "link:examples/search_examples",
     "@kbn/search-response-warnings": "link:packages/kbn-search-response-warnings",
     "@kbn/searchprofiler-plugin": "link:x-pack/plugins/searchprofiler",

diff --git a/packages/kbn-search-api-panels/README.md b/packages/kbn-search-api-panels/README.md
@@ -0,0 +1,3 @@
+# @kbn/search-api-panels
+
+Empty package generated by @kbn/generate
diff --git a/...blic/application/components/code_box.scss → ...earch-api-panels/components/code_box.scss b/...blic/application/components/code_box.scss → ...earch-api-panels/components/code_box.scss
diff --git a/...ublic/application/components/code_box.tsx → ...search-api-panels/components/code_box.tsx b/...ublic/application/components/code_box.tsx → ...search-api-panels/components/code_box.tsx
@@ -1,10 +1,13 @@
 /*
  * 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 React, { useState } from 'react';
+
 import {
   EuiButtonEmpty,
   EuiCodeBlock,
@@ -19,49 +22,46 @@ import {
   EuiThemeProvider,
 } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
-import React, { useState } from 'react';
-import { PLUGIN_ID } from '../../../common';
-import { useKibanaServices } from '../hooks/use_kibana';
-import { consoleDefinition } from './languages/console';
-import { LanguageDefinition, LanguageDefinitionSnippetArguments } from './languages/types';
+import type { HttpStart } from '@kbn/core-http-browser';
+import type { ApplicationStart } from '@kbn/core-application-browser';
+import type { SharePluginStart } from '@kbn/share-plugin/public';
+
+import { LanguageDefinition } from '../types';
 import { TryInConsoleButton } from './try_in_console_button';
 import './code_box.scss';
 
 interface CodeBoxProps {
   languages: LanguageDefinition[];
-  code: keyof LanguageDefinition;
-  codeArgs: LanguageDefinitionSnippetArguments;
+  codeSnippet: string;
   // overrides the language type for syntax highlighting
   languageType?: string;
   selectedLanguage: LanguageDefinition;
   setSelectedLanguage: (language: LanguageDefinition) => void;
+  http: HttpStart;
+  pluginId: string;
+  application?: ApplicationStart;
+  sharePlugin: SharePluginStart;
+  showTryInConsole: boolean;
 }
 
-const getCodeSnippet = (
-  language: Partial<LanguageDefinition>,
-  key: keyof LanguageDefinition,
-  args: LanguageDefinitionSnippetArguments
-): string => {
-  const snippetVal = language[key];
-  if (snippetVal === undefined) return '';
-  if (typeof snippetVal === 'string') return snippetVal;
-  return snippetVal(args);
-};
-
 export const CodeBox: React.FC<CodeBoxProps> = ({
-  code,
-  codeArgs,
-  languages,
+  application,
+  codeSnippet,
+  http,
   languageType,
+  languages,
+  pluginId,
   selectedLanguage,
   setSelectedLanguage,
+  sharePlugin,
+  showTryInConsole,
 }) => {
   const [isPopoverOpen, setIsPopoverOpen] = useState<boolean>(false);
-  const { http } = useKibanaServices();
+
   const items = languages.map((language) => (
     <EuiContextMenuItem
       key={language.id}
-      icon={http.basePath.prepend(`/plugins/${PLUGIN_ID}/assets/${language.iconType}`)}
+      icon={http.basePath.prepend(`/plugins/${pluginId}/assets/${language.iconType}`)}
       onClick={() => {
         setSelectedLanguage(language);
         setIsPopoverOpen(false);
@@ -74,7 +74,7 @@ export const CodeBox: React.FC<CodeBoxProps> = ({
   const button = (
     <EuiThemeProvider colorMode="dark">
       <EuiButtonEmpty
-        aria-label={i18n.translate('xpack.serverlessSearch.codeBox.selectAriaLabel', {
+        aria-label={i18n.translate('searchApiPanels.welcomeBanner.codeBox.selectAriaLabel', {
           defaultMessage: 'Select a programming language',
         })}
         color="text"
@@ -86,8 +86,6 @@ export const CodeBox: React.FC<CodeBoxProps> = ({
       </EuiButtonEmpty>
     </EuiThemeProvider>
   );
-  const codeSnippet = getCodeSnippet(selectedLanguage, code, codeArgs);
-  const showTryInConsole = code in consoleDefinition;
 
   return (
     <EuiThemeProvider colorMode="dark">
@@ -110,7 +108,7 @@ export const CodeBox: React.FC<CodeBoxProps> = ({
             <EuiCopy textToCopy={codeSnippet}>
               {(copy) => (
                 <EuiButtonEmpty color="text" iconType="copy" size="s" onClick={copy}>
-                  {i18n.translate('xpack.serverlessSearch.codeBox.copyButtonLabel', {
+                  {i18n.translate('searchApiPanels.welcomeBanner.codeBox.copyButtonLabel', {
                     defaultMessage: 'Copy',
                   })}
                 </EuiButtonEmpty>
@@ -119,7 +117,11 @@ export const CodeBox: React.FC<CodeBoxProps> = ({
           </EuiFlexItem>
           {showTryInConsole && (
             <EuiFlexItem grow={false}>
-              <TryInConsoleButton request={getCodeSnippet(consoleDefinition, code, codeArgs)} />
+              <TryInConsoleButton
+                request={codeSnippet}
+                application={application}
+                sharePlugin={sharePlugin}
+              />
             </EuiFlexItem>
           )}
         </EuiFlexGroup>

diff --git a/...ication/components/shared/github_link.tsx → ...rch-api-panels/components/github_link.tsx b/...ication/components/shared/github_link.tsx → ...rch-api-panels/components/github_link.tsx
@@ -1,21 +1,26 @@
 /*
  * 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 { EuiFlexGroup, EuiFlexItem, EuiIcon, EuiText, EuiLink } from '@elastic/eui';
 import React from 'react';
-import { PLUGIN_ID } from '../../../../common';
-import { useKibanaServices } from '../../hooks/use_kibana';
 
-export const GithubLink: React.FC<{ label: string; href: string }> = ({ label, href }) => {
-  const { http } = useKibanaServices();
+import { EuiFlexGroup, EuiFlexItem, EuiIcon, EuiText, EuiLink } from '@elastic/eui';
+import { HttpStart } from '@kbn/core-http-browser';
+
+export const GithubLink: React.FC<{
+  label: string;
+  href: string;
+  http: HttpStart;
+  pluginId: string;
+}> = ({ label, href, http, pluginId }) => {
   return (
     <EuiFlexGroup alignItems="center" gutterSize="xs" justifyContent="flexEnd">
       <EuiFlexItem grow={false}>
-        <EuiIcon size="s" type={http.basePath.prepend(`/plugins/${PLUGIN_ID}/assets/github.svg`)} />
+        <EuiIcon size="s" type={http.basePath.prepend(`/plugins/${pluginId}/assets/github.svg`)} />
       </EuiFlexItem>
       <EuiFlexItem grow={false}>
         <EuiText size="s">

diff --git a/...omponents/overview_panels/ingest_data.tsx → ...rch-api-panels/components/ingest_data.tsx b/...omponents/overview_panels/ingest_data.tsx → ...rch-api-panels/components/ingest_data.tsx
@@ -1,59 +1,80 @@
 /*
  * 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 React, { useState } from 'react';
+
 import { EuiCheckableCard, EuiFormFieldset, EuiSpacer, EuiText, EuiTitle } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
-import React, { useState } from 'react';
-import { docLinks } from '../../../../common/doc_links';
-import { CodeBox } from '../code_box';
-import { languageDefinitions } from '../languages/languages';
-import { LanguageDefinition, LanguageDefinitionSnippetArguments } from '../languages/types';
+import type { HttpStart } from '@kbn/core-http-browser';
+import type { ApplicationStart } from '@kbn/core-application-browser';
+import type { SharePluginStart } from '@kbn/share-plugin/public';
+import { CodeBox } from './code_box';
+import { LanguageDefinition } from '../types';
 import { OverviewPanel } from './overview_panel';
 import { IntegrationsPanel } from './integrations_panel';
 
 interface IngestDataProps {
-  codeArguments: LanguageDefinitionSnippetArguments;
+  codeSnippet: string;
   selectedLanguage: LanguageDefinition;
   setSelectedLanguage: (language: LanguageDefinition) => void;
+  docLinks: any;
+  http: HttpStart;
+  pluginId: string;
+  application?: ApplicationStart;
+  sharePlugin: SharePluginStart;
+  languages: LanguageDefinition[];
+  showTryInConsole: boolean;
 }
 
 export const IngestData: React.FC<IngestDataProps> = ({
-  codeArguments,
+  codeSnippet,
   selectedLanguage,
   setSelectedLanguage,
+  docLinks,
+  http,
+  pluginId,
+  application,
+  sharePlugin,
+  languages,
+  showTryInConsole,
 }) => {
   const [selectedIngestMethod, setSelectedIngestMethod] = useState<
     'ingestViaApi' | 'ingestViaIntegration'
   >('ingestViaApi');
   return (
     <OverviewPanel
-      description={i18n.translate('xpack.serverlessSearch.ingestData.description', {
+      description={i18n.translate('searchApiPanels.welcomeBanner.ingestData.description', {
         defaultMessage:
           'Add data to your data stream or index to make it searchable. Choose an ingestion method that fits your application and workflow.',
       })}
       leftPanelContent={
         selectedIngestMethod === 'ingestViaApi' ? (
           <CodeBox
-            code="ingestData"
-            codeArgs={codeArguments}
-            languages={languageDefinitions}
+            showTryInConsole={showTryInConsole}
+            codeSnippet={codeSnippet}
+            languages={languages}
             selectedLanguage={selectedLanguage}
             setSelectedLanguage={setSelectedLanguage}
+            http={http}
+            pluginId={pluginId}
+            application={application}
+            sharePlugin={sharePlugin}
           />
         ) : (
-          <IntegrationsPanel />
+          <IntegrationsPanel docLinks={docLinks} http={http} pluginId={pluginId} />
         )
       }
       links={[
         ...(selectedLanguage.apiReference
           ? [
               {
                 href: selectedLanguage.apiReference,
-                label: i18n.translate('xpack.serverlessSearch.ingestData.clientDocLink', {
+                label: i18n.translate('searchApiPanels.welcomeBanner.ingestData.clientDocLink', {
                   defaultMessage: '{languageName} API reference',
                   values: { languageName: selectedLanguage.name },
                 }),
@@ -62,18 +83,18 @@ export const IngestData: React.FC<IngestDataProps> = ({
           : []),
         {
           href: docLinks.integrations,
-          label: i18n.translate('xpack.serverlessSearch.ingestData.integrationsLink', {
+          label: i18n.translate('searchApiPanels.welcomeBanner.ingestData.integrationsLink', {
             defaultMessage: 'About Integrations',
           }),
         },
       ]}
-      title={i18n.translate('xpack.serverlessSearch.ingestData.title', {
+      title={i18n.translate('searchApiPanels.welcomeBanner.ingestData.title', {
         defaultMessage: 'Ingest data',
       })}
     >
       <EuiFormFieldset
         legend={{
-          children: i18n.translate('xpack.serverlessSearch.ingestData.ingestLegendLabel', {
+          children: i18n.translate('searchApiPanels.welcomeBanner.ingestData.ingestLegendLabel', {
             defaultMessage: 'Select an ingestion method',
           }),
           display: 'hidden',
@@ -85,7 +106,7 @@ export const IngestData: React.FC<IngestDataProps> = ({
           label={
             <EuiTitle size="xs">
               <h3>
-                {i18n.translate('xpack.serverlessSearch.ingestData.ingestApiLabel', {
+                {i18n.translate('searchApiPanels.welcomeBanner.ingestData.ingestApiLabel', {
                   defaultMessage: 'Ingest via API',
                 })}
               </h3>
@@ -96,7 +117,7 @@ export const IngestData: React.FC<IngestDataProps> = ({
           onChange={() => setSelectedIngestMethod('ingestViaApi')}
         >
           <EuiText>
-            {i18n.translate('xpack.serverlessSearch.ingestData.ingestApiDescription', {
+            {i18n.translate('searchApiPanels.welcomeBanner.ingestData.ingestApiDescription', {
               defaultMessage:
                 'The most flexible way to index data, enabling full control over your customization and optimization options.',
             })}
@@ -109,7 +130,7 @@ export const IngestData: React.FC<IngestDataProps> = ({
           label={
             <EuiTitle size="xs">
               <h3>
-                {i18n.translate('xpack.serverlessSearch.ingestData.ingestIntegrationLabel', {
+                {i18n.translate('searchApiPanels.welcomeBanner.ingestData.ingestIntegrationLabel', {
                   defaultMessage: 'Ingest via integration',
                 })}
               </h3>
@@ -120,10 +141,13 @@ export const IngestData: React.FC<IngestDataProps> = ({
           onChange={() => setSelectedIngestMethod('ingestViaIntegration')}
         >
           <EuiText>
-            {i18n.translate('xpack.serverlessSearch.ingestData.ingestIntegrationDescription', {
-              defaultMessage:
-                'Specialized ingestion tools optimized for transforming data and shipping it to Elasticsearch.',
-            })}
+            {i18n.translate(
+              'searchApiPanels.welcomeBanner.ingestData.ingestIntegrationDescription',
+              {
+                defaultMessage:
+                  'Specialized ingestion tools optimized for transforming data and shipping it to Elasticsearch.',
+              }
+            )}
           </EuiText>
         </EuiCheckableCard>
       </EuiFormFieldset>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# @kbn/search-api-panels

		Empty package generated by @kbn/generate