[Shared UX][packages] Move No Data Page components; model service com…

…position (#133593) * [Shared UX] Move No Data Page components to packages * Fix type export. * Fix Kibana dependency miss; exported type * Address feedback; add docs * More updates after merge * Move comment Co-authored-by: Kibana Machine <[email protected]>
elastic · Jun 14, 2022 · 8882a50 · 8882a50
1 parent cde209b
commit 8882a50
Show file tree

Hide file tree

Showing 41 changed files with 923 additions and 693 deletions.
diff --git a/package.json b/package.json
@@ -203,6 +203,7 @@
     "@kbn/shared-ux-components": "link:bazel-bin/packages/kbn-shared-ux-components",
     "@kbn/shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app",
     "@kbn/shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data",
+    "@kbn/shared-ux-page-kibana-no-data": "link:bazel-bin/packages/shared-ux/page/kibana_no_data",
     "@kbn/shared-ux-prompt-no-data-views": "link:bazel-bin/packages/shared-ux/prompt/no_data_views",
     "@kbn/shared-ux-services": "link:bazel-bin/packages/kbn-shared-ux-services",
     "@kbn/shared-ux-storybook": "link:bazel-bin/packages/kbn-shared-ux-storybook",
@@ -729,6 +730,7 @@
     "@types/kbn__shared-ux-components": "link:bazel-bin/packages/kbn-shared-ux-components/npm_module_types",
     "@types/kbn__shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app/npm_module_types",
     "@types/kbn__shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data/npm_module_types",
+    "@types/kbn__shared-ux-page-kibana-no-data": "link:bazel-bin/packages/shared-ux/page/kibana_no_data/npm_module_types",
     "@types/kbn__shared-ux-prompt-no-data-views": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/npm_module_types",
     "@types/kbn__shared-ux-services": "link:bazel-bin/packages/kbn-shared-ux-services/npm_module_types",
     "@types/kbn__shared-ux-storybook": "link:bazel-bin/packages/kbn-shared-ux-storybook/npm_module_types",

diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel
@@ -136,6 +136,7 @@ filegroup(
     "//packages/shared-ux/button/exit_full_screen:build",
     "//packages/shared-ux/link/redirect_app:build",
     "//packages/shared-ux/page/analytics_no_data:build",
+    "//packages/shared-ux/page/kibana_no_data:build",
     "//packages/shared-ux/prompt/no_data_views:build",
   ],
 )
@@ -256,6 +257,7 @@ filegroup(
     "//packages/shared-ux/button/exit_full_screen:build_types",
     "//packages/shared-ux/link/redirect_app:build_types",
     "//packages/shared-ux/page/analytics_no_data:build_types",
+    "//packages/shared-ux/page/kibana_no_data:build_types",
     "//packages/shared-ux/prompt/no_data_views:build_types",
   ],
 )

diff --git a/packages/kbn-shared-ux-components/src/empty_state/kibana_no_data_page.mdx b/packages/kbn-shared-ux-components/src/empty_state/kibana_no_data_page.mdx
diff --git a/packages/kbn-shared-ux-components/src/empty_state/kibana_no_data_page.stories.tsx b/packages/kbn-shared-ux-components/src/empty_state/kibana_no_data_page.stories.tsx
diff --git a/packages/kbn-shared-ux-components/src/index.ts b/packages/kbn-shared-ux-components/src/index.ts
@@ -6,27 +6,11 @@
  * Side Public License, v 1.
  */
 
-import React from 'react';
-import { withSuspense } from '@kbn/shared-ux-utility';
-
 export { ToolbarButton, IconButtonGroup, AddFromLibraryButton, ToolbarPopover } from './toolbar';
 export { KibanaPageTemplateSolutionNav } from './page_template/solution_nav';
-export type { KibanaPageTemplateProps } from './page_template';
-export { KibanaPageTemplate } from './page_template';
 
-/**
- *  A `KibanaNoDataPage` component, with service hooks. Consumers should use `React.Suspennse` or the
- * `withSuspense` HOC to load this component.
- */
-export const KibanaNoDataPageLazy = React.lazy(() =>
-  import('./empty_state').then(({ KibanaNoDataPage }) => ({
-    default: KibanaNoDataPage,
-  }))
-);
+// TODO: clintandrewhall - NoDataPageProps is a temporary addition until it is split into its own package
+export type { KibanaPageTemplateProps, NoDataPageProps } from './page_template';
 
-/**
- * A `KibanaNoDataPage` component. The component is wrapped by the `withSuspense` HOC.
- * This component can be used directly by consumers and will load the `KibanaNoDataPageLazy` lazily with
- * a predefined fallback and error boundary.
- */
-export const KibanaNoDataPage = withSuspense(KibanaNoDataPageLazy);
+// TODO: clintandrewhall - NoDataConfigPage is a temporary addition until it is split into its own package
+export { KibanaPageTemplate, NoDataConfigPage } from './page_template';
diff --git a/packages/kbn-shared-ux-services/src/index.ts b/packages/kbn-shared-ux-services/src/index.ts
@@ -8,6 +8,7 @@
 
 export type { ServiceFactory, SharedUxServices, SharedUxServicesContext } from './types';
 export type {
+  MockServicesFactoryParams,
   SharedUxApplicationService,
   SharedUxDocLinksService,
   SharedUxEditorsService,

diff --git a/packages/kbn-shared-ux-services/src/services/index.ts b/packages/kbn-shared-ux-services/src/services/index.ts
@@ -13,6 +13,7 @@ export type { SharedUxHttpService } from './http';
 export type { SharedUxUserPermissionsService } from './permissions';
 export type { SharedUxPlatformService } from './platform';
 export type { SharedUxDataService } from './data';
+export type { MockServicesFactoryParams } from './mock';
 
 export { mockServicesFactory, mockServiceFactories } from './mock';
 export { stubServicesFactory, stubServiceFactories } from './stub';
diff --git a/packages/shared-ux/page/analytics_no_data/BUILD.bazel b/packages/shared-ux/page/analytics_no_data/BUILD.bazel
@@ -39,11 +39,9 @@ NPM_MODULE_EXTRA_FILES = [
 #    eg. "@npm//lodash"
 RUNTIME_DEPS = [
   "@npm//react",
-  "@npm//rxjs",
+  "@npm//@testing-library",
   "//packages/kbn-i18n",
-  "//packages/kbn-shared-ux-services",
-  "//packages/kbn-shared-ux-components",
-  "//packages/kbn-shared-ux-storybook"
+  "//packages/shared-ux/page/kibana_no_data",
 ]
 
 # In this array place dependencies necessary to build the types, which will include the
@@ -60,9 +58,7 @@ TYPES_DEPS = [
   "@npm//@types/jest",
   "@npm//@types/react",
   "//packages/kbn-i18n:npm_module_types",
-  "//packages/kbn-shared-ux-services:npm_module_types",
-  "//packages/kbn-shared-ux-storybook:npm_module_types",
-  "//packages/kbn-shared-ux-components:npm_module_types",
+  "//packages/shared-ux/page/kibana_no_data:npm_module_types",
   "//packages/kbn-ambient-ui-types",
 ]
 

diff --git a/packages/shared-ux/page/analytics_no_data/README.mdx b/packages/shared-ux/page/analytics_no_data/README.mdx
@@ -1,15 +1,22 @@
 ---
-id: sharedUX/Components/AnalyticsNoDataPage
-slug: /shared-ux/components/analytics-no-data-page
+id: sharedUX/Page/AnalyticsNoDataPage
+slug: /shared-ux/page/analytics-no-data-page
 title: Analytics "No Data" Page
 summary: An entire page that can be displayed when Kibana "has no data", specifically for Analytics.
 tags: ['shared-ux', 'component']
 date: 2021-12-28
 ---
 
-## Description
+This is an Analytics-specific version of `KibanaNoDataPage`, which defaults most of the fields appropriate for Analytics solutions.
 
-This is an Analytics-specific version of `KibanaNoDataPage`, which defaults most of the fields to give a consistent set of terms for Analytics solutions.
+## API
+
+| Export | Description |
+|---|---|
+| `AnalyticsNoDataPageProvider` | Provides contextual services to `AnalyticsNoDataPage`. |
+| `AnalyticsNoDataPageKibanaProvider` | Maps Kibana dependencies to provide contextual services to `AnalyticsNoDataPage`. |
+| `AnalyticsNoDataPage` | Uses a `Provider` to access contextual services to populate props on the `AnalyticsNoDataPageComponent`. |
+| `AnalyticsNoDataPageComponent` | The pure component. |
 
 ## EUI Promotion Status