From 5ed29a7b91fe8ee946edb3b4b135e193e533c04c Mon Sep 17 00:00:00 2001 From: spalger Date: Wed, 8 Jul 2020 09:33:46 -0700 Subject: [PATCH] update core api docs to mention requiredBundles property --- .../kibana-plugin-core-server.discoveredplugin.md | 1 + ...-core-server.discoveredplugin.requiredbundles.md | 13 +++++++++++++ .../kibana-plugin-core-server.pluginmanifest.md | 1 + ...in-core-server.pluginmanifest.requiredbundles.md | 13 +++++++++++++ src/core/server/server.api.md | 8 +++++--- 5 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md create mode 100644 docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md diff --git a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.md b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.md index 0e2b9bd60ab670b..5a3f498b03c2428 100644 --- a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.md +++ b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.md @@ -19,5 +19,6 @@ export interface DiscoveredPlugin | [configPath](./kibana-plugin-core-server.discoveredplugin.configpath.md) | ConfigPath | Root configuration path used by the plugin, defaults to "id" in snake\_case format. | | [id](./kibana-plugin-core-server.discoveredplugin.id.md) | PluginName | Identifier of the plugin. | | [optionalPlugins](./kibana-plugin-core-server.discoveredplugin.optionalplugins.md) | readonly PluginName[] | An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. | +| [requiredBundles](./kibana-plugin-core-server.discoveredplugin.requiredbundles.md) | readonly PluginName[] | An optional list of the other plugins which are imported by the UI bundles of this plugin. If the plugins listed here are disabled their bundles will still be loaded into the browser. Required by the @kbn/optimizer to allow cross plugin imports. "core" and plugins listed in "requiredPlugins" do not need to be listed here. | | [requiredPlugins](./kibana-plugin-core-server.discoveredplugin.requiredplugins.md) | readonly PluginName[] | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. | diff --git a/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md new file mode 100644 index 000000000000000..89daf9799a8da1b --- /dev/null +++ b/docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) > [requiredBundles](./kibana-plugin-core-server.discoveredplugin.requiredbundles.md) + +## DiscoveredPlugin.requiredBundles property + +An optional list of the other plugins which are imported by the UI bundles of this plugin. If the plugins listed here are disabled their bundles will still be loaded into the browser. Required by the @kbn/optimizer to allow cross plugin imports. "core" and plugins listed in "requiredPlugins" do not need to be listed here. + +Signature: + +```typescript +readonly requiredBundles: readonly PluginName[]; +``` diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md index 5edee51d6c523d1..6b9e5501ed46ad0 100644 --- a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md +++ b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.md @@ -25,6 +25,7 @@ Should never be used in code outside of Core but is exported for documentation p | [id](./kibana-plugin-core-server.pluginmanifest.id.md) | PluginName | Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc. | | [kibanaVersion](./kibana-plugin-core-server.pluginmanifest.kibanaversion.md) | string | The version of Kibana the plugin is compatible with, defaults to "version". | | [optionalPlugins](./kibana-plugin-core-server.pluginmanifest.optionalplugins.md) | readonly PluginName[] | An optional list of the other plugins that if installed and enabled \*\*may be\*\* leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly. | +| [requiredBundles](./kibana-plugin-core-server.pluginmanifest.requiredbundles.md) | readonly string[] | An optional list of the other plugins which are imported by the UI bundles of this plugin. If the plugins listed here are disabled their bundles will still be loaded into the browser. Required by the @kbn/optimizer to allow cross plugin imports. "core" and plugins listed in "requiredPlugins" do not need to be listed here. | | [requiredPlugins](./kibana-plugin-core-server.pluginmanifest.requiredplugins.md) | readonly PluginName[] | An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly. | | [server](./kibana-plugin-core-server.pluginmanifest.server.md) | boolean | Specifies whether plugin includes some server-side specific functionality. | | [ui](./kibana-plugin-core-server.pluginmanifest.ui.md) | boolean | Specifies whether plugin includes some client/browser specific functionality that should be included into client bundle via public/ui_plugin.js file. | diff --git a/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md new file mode 100644 index 000000000000000..4b1861c0e9f0bd0 --- /dev/null +++ b/docs/development/core/server/kibana-plugin-core-server.pluginmanifest.requiredbundles.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [PluginManifest](./kibana-plugin-core-server.pluginmanifest.md) > [requiredBundles](./kibana-plugin-core-server.pluginmanifest.requiredbundles.md) + +## PluginManifest.requiredBundles property + +An optional list of the other plugins which are imported by the UI bundles of this plugin. If the plugins listed here are disabled their bundles will still be loaded into the browser. Required by the @kbn/optimizer to allow cross plugin imports. "core" and plugins listed in "requiredPlugins" do not need to be listed here. + +Signature: + +```typescript +readonly requiredBundles: readonly string[]; +``` diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 107edf11bb6f434..6839c69ac8e8119 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -631,6 +631,7 @@ export interface DiscoveredPlugin { readonly configPath: ConfigPath; readonly id: PluginName; readonly optionalPlugins: readonly PluginName[]; + readonly requiredBundles: readonly PluginName[]; readonly requiredPlugins: readonly PluginName[]; } @@ -1678,6 +1679,7 @@ export interface PluginManifest { readonly id: PluginName; readonly kibanaVersion: string; readonly optionalPlugins: readonly PluginName[]; + readonly requiredBundles: readonly string[]; readonly requiredPlugins: readonly PluginName[]; readonly server: boolean; readonly ui: boolean; @@ -2699,8 +2701,8 @@ export const validBodyOutput: readonly ["data", "stream"]; // src/core/server/legacy/types.ts:165:3 - (ae-forgotten-export) The symbol "LegacyNavLinkSpec" needs to be exported by the entry point index.d.ts // src/core/server/legacy/types.ts:166:3 - (ae-forgotten-export) The symbol "LegacyAppSpec" needs to be exported by the entry point index.d.ts // src/core/server/legacy/types.ts:167:16 - (ae-forgotten-export) The symbol "LegacyPluginSpec" needs to be exported by the entry point index.d.ts -// src/core/server/plugins/types.ts:238:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts -// src/core/server/plugins/types.ts:238:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts -// src/core/server/plugins/types.ts:240:3 - (ae-forgotten-export) The symbol "PathConfigType" needs to be exported by the entry point index.d.ts +// src/core/server/plugins/types.ts:260:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts +// src/core/server/plugins/types.ts:260:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts +// src/core/server/plugins/types.ts:262:3 - (ae-forgotten-export) The symbol "PathConfigType" needs to be exported by the entry point index.d.ts ```