Advanced settings component registry ⇒ kibana platform plugin

.i18nrc.json

@@ -23,6 +23,7 @@
  "kbn": "src/legacy/core_plugins/kibana",
  "kbnDocViews": "src/legacy/core_plugins/kbn_doc_views",
  "management": ["src/legacy/core_plugins/management", "src/plugins/management"],
+ "advancedSettings": "src/plugins/advanced_settings",
  "kibana_react": "src/legacy/core_plugins/kibana_react",
  "kibana-react": "src/plugins/kibana_react",
  "kibana_utils": "src/plugins/kibana_utils",

rfcs/text/0006_management_section_service.md

@@ -257,15 +257,7 @@ Current public contracts owned by the legacy service:
 ```js
 // ui/management/index
 interface API {
- PAGE_TITLE_COMPONENT: string; // actually related to advanced settings?
- PAGE_SUBTITLE_COMPONENT: string; // actually related to advanced settings?
- PAGE_FOOTER_COMPONENT: string; // actually related to advanced settings?
  SidebarNav: React.FC<any>;
- registerSettingsComponent: (
- id: string,
- component: string | React.FC<any>,
- allowOverride: boolean
- ) => void;
  management: new ManagementSection();
  MANAGEMENT_BREADCRUMB: {
  text: string;

src/legacy/core_plugins/kibana/public/management/sections/settings/advanced_settings.test.tsx

@@ -215,6 +215,17 @@ function mockConfig() {
  core: {
  uiSettings: config,
  },
+ plugins: {
+ advancedSettings: {
+ componentRegistry: {
+ get: () => <div>Hello</div>,
+ componentType: {
+ PAGE_TITLE_COMPONENT: 'page_title_component',
+ PAGE_SUBTITLE_COMPONENT: 'page_subtitle_component',
+ },
+ },
+ },
+ },
  };
 }
 

src/legacy/core_plugins/kibana/public/management/sections/settings/advanced_settings.tsx

@@ -31,14 +31,6 @@ import { getAriaName, toEditableConfig, DEFAULT_CATEGORY } from './lib';
 
 import { FieldSetting, IQuery } from './types';
 
-import {
- registerDefaultComponents,
- PAGE_TITLE_COMPONENT,
- PAGE_SUBTITLE_COMPONENT,
- PAGE_FOOTER_COMPONENT,
-} from './components/default_component_registry';
-import { getSettingsComponent } from './components/component_registry';
-
 interface AdvancedSettingsProps {
  queryText: string;
  enableSaving: boolean;
@@ -75,8 +67,6 @@ export class AdvancedSettings extends Component<AdvancedSettingsProps, AdvancedS
  footerQueryMatched: false,
  filteredSettings: this.mapSettings(Query.execute(parsedQuery, this.settings)),
  };
-
- registerDefaultComponents();
  }
 
  init(config: IUiSettingsClient) {
@@ -166,10 +156,13 @@ export class AdvancedSettings extends Component<AdvancedSettingsProps, AdvancedS
 
  render() {
  const { filteredSettings, query, footerQueryMatched } = this.state;
+ const componentRegistry = npStart.plugins.advancedSettings.componentRegistry;
 
- const PageTitle = getSettingsComponent(PAGE_TITLE_COMPONENT);
- const PageSubtitle = getSettingsComponent(PAGE_SUBTITLE_COMPONENT);
- const PageFooter = getSettingsComponent(PAGE_FOOTER_COMPONENT);
+ const PageTitle = componentRegistry.get(componentRegistry.componentType.PAGE_TITLE_COMPONENT);
+ const PageSubtitle = componentRegistry.get(
+ componentRegistry.componentType.PAGE_SUBTITLE_COMPONENT
+ );
+ const PageFooter = componentRegistry.get(componentRegistry.componentType.PAGE_FOOTER_COMPONENT);
 
  return (
  <div>

src/legacy/core_plugins/telemetry/public/views/management/management.js

@@ -19,14 +19,15 @@
 import React from 'react';
 import routes from 'ui/routes';
 
-import { registerSettingsComponent, PAGE_FOOTER_COMPONENT } from 'ui/management';
+import { npStart } from 'ui/new_platform';
 import { TelemetryOptInProvider } from '../../services';
 import { TelemetryForm } from '../../components';
 
 routes.defaults(/\/management/, {
  resolve: {
  telemetryManagementSection: function(Private) {
  const telemetryOptInProvider = Private(TelemetryOptInProvider);
+ const componentRegistry = npStart.plugins.advancedSettings.componentRegistry;
 
  const Component = props => (
  <TelemetryForm
@@ -36,7 +37,11 @@ routes.defaults(/\/management/, {
  />
  );
 
- registerSettingsComponent(PAGE_FOOTER_COMPONENT, Component, true);
+ componentRegistry.register(
+ componentRegistry.componentType.PAGE_FOOTER_COMPONENT,
+ Component,
+ true
+ );
  },
  },
 });

src/legacy/ui/public/management/index.d.ts

@@ -18,15 +18,7 @@
  */
 
 declare module 'ui/management' {
- export const PAGE_TITLE_COMPONENT: string;
- export const PAGE_SUBTITLE_COMPONENT: string;
- export const PAGE_FOOTER_COMPONENT: string;
  export const SidebarNav: React.FC<any>;
- export function registerSettingsComponent(
- id: string,
- component: string | React.FC<any>,
- allowOverride: boolean
- ): void;
  export const management: any; // TODO - properly provide types
  export const MANAGEMENT_BREADCRUMB: {
  text: string;

src/legacy/ui/public/management/index.js

@@ -17,12 +17,6 @@
  * under the License.
  */
 
-export {
- PAGE_TITLE_COMPONENT,
- PAGE_SUBTITLE_COMPONENT,
- PAGE_FOOTER_COMPONENT,
-} from '../../../core_plugins/kibana/public/management/sections/settings/components/default_component_registry';
-export { registerSettingsComponent } from '../../../core_plugins/kibana/public/management/sections/settings/components/component_registry';
 export { MANAGEMENT_BREADCRUMB } from './breadcrumbs';
 import { npStart } from 'ui/new_platform';
 export const management = npStart.plugins.management.legacy;

src/legacy/ui/public/new_platform/new_platform.karma_mock.js

@@ -58,6 +58,15 @@ const mockCore = {
 export const npSetup = {
  core: mockCore,
  plugins: {
+ advancedSettings: {
+ componentRegistry: {
+ register: sinon.fake(),
+ componentType: {
+ PAGE_TITLE_COMPONENT: 'page_title_component',
+ PAGE_SUBTITLE_COMPONENT: 'page_subtitle_component',
+ },
+ },
+ },
  usageCollection: {
  allowTrackUserAgent: sinon.fake(),
  reportUiStats: sinon.fake(),

src/legacy/ui/public/new_platform/new_platform.ts

@@ -33,6 +33,10 @@ import { KibanaLegacySetup, KibanaLegacyStart } from '../../../../plugins/kibana
 import { HomePublicPluginSetup, HomePublicPluginStart } from '../../../../plugins/home/public';
 import { SharePluginSetup, SharePluginStart } from '../../../../plugins/share/public';
 import { ManagementStart } from '../../../../plugins/management/public';
+import {
+ AdvancedSettingsSetup,
+ AdvancedSettingsStart,
+} from '../../../../plugins/advanced_settings/public';
 import { BfetchPublicSetup, BfetchPublicStart } from '../../../../plugins/bfetch/public';
 import { UsageCollectionSetup } from '../../../../plugins/usage_collection/public';
 import {
@@ -54,6 +58,7 @@ export interface PluginsSetup {
  kibana_legacy: KibanaLegacySetup;
  share: SharePluginSetup;
  usageCollection: UsageCollectionSetup;
+ advancedSettings: AdvancedSettingsSetup;
 }
 
 export interface PluginsStart {
@@ -70,6 +75,7 @@ export interface PluginsStart {
  kibana_legacy: KibanaLegacyStart;
  share: SharePluginStart;
  management: ManagementStart;
+ advancedSettings: AdvancedSettingsStart;
 }
 
 export const npSetup = {

src/plugins/advanced_settings/kibana.json

@@ -0,0 +1,7 @@
+{
+ "id": "advancedSettings",
+ "version": "kibana",
+ "server": false,
+ "ui": true,
+ "requiredPlugins": []
+}

src/plugins/advanced_settings/public/component_registry/index.ts

@@ -0,0 +1,38 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { registerSettingsComponent, getSettingsComponent } from './component_registry';
+import {
+ registerDefaultComponents,
+ PAGE_TITLE_COMPONENT,
+ PAGE_SUBTITLE_COMPONENT,
+ PAGE_FOOTER_COMPONENT,
+} from './default_component_registry';
+
+registerDefaultComponents();
+
+export const componentRegistry = {
+ register: registerSettingsComponent,
+ get: getSettingsComponent,
+ componentType: {
+ PAGE_TITLE_COMPONENT,
+ PAGE_SUBTITLE_COMPONENT,
+ PAGE_FOOTER_COMPONENT,
+ },
+};

src/legacy/core_plugins/kibana/public/management/sections/settings/components/page_title/page_title.tsx → src/plugins/advanced_settings/public/component_registry/page_title/page_title.tsx

@@ -25,7 +25,7 @@ export const PageTitle = () => {
  return (
  <EuiText>
  <h1 data-test-subj="managementSettingsTitle">
- <FormattedMessage id="kbn.management.settings.pageTitle" defaultMessage="Settings" />
+ <FormattedMessage id="advancedSettings.pageTitle" defaultMessage="Settings" />
  </h1>
  </EuiText>
  );

src/plugins/advanced_settings/public/index.ts

@@ -0,0 +1,26 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { PluginInitializerContext } from 'kibana/public';
+import { AdvancedSettingsPlugin } from './plugin';
+export { AdvancedSettingsSetup, AdvancedSettingsStart } from './types';
+
+export function plugin(initializerContext: PluginInitializerContext) {
+ return new AdvancedSettingsPlugin();
+}

src/plugins/advanced_settings/public/plugin.ts

@@ -0,0 +1,37 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { CoreSetup, CoreStart, Plugin } from 'kibana/public';
+import { componentRegistry } from './component_registry';
+import { AdvancedSettingsSetup, AdvancedSettingsStart } from './types';
+
+export class AdvancedSettingsPlugin
+ implements Plugin<AdvancedSettingsSetup, AdvancedSettingsStart> {
+ public setup(core: CoreSetup) {
+ return {
+ componentRegistry,
+ };
+ }
+
+ public start(core: CoreStart) {
+ return {
+ componentRegistry,
+ };
+ }
+}

src/plugins/advanced_settings/public/types.ts

@@ -0,0 +1,27 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { componentRegistry } from './component_registry';
+
+export interface AdvancedSettingsSetup {
+ componentRegistry: typeof componentRegistry;
+}
+export interface AdvancedSettingsStart {
+ componentRegistry: typeof componentRegistry;
+}