github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[package arch] Move Core's browser-side injectedMetadata service into packages (#133298)

Browse source 
* Create the injected-metadata packages

* already rename the thing

* move ALL the things

* fix mocks

* start fixing mock imports

* lint

* a few more

* update generated doc

* lint
This commit is contained in:
Pierre Gayvallet 2022-06-02 08:49:40 +02:00 • committed by GitHub
parent d8a235f3ac
commit 6cb2898d2e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
87 changed files with 1128 additions and 624 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md
View file

@ -4,8 +4,6 @@
## ChromeHelpMenuActions.hideHelpMenu property
The action provides the capability to hide the help menu from within the help extension content components.
<b>Signature:</b>
```typescript

2
docs/development/core/public/kibana-plugin-core-public.chromehelpmenuactions.md
View file

@ -4,6 +4,7 @@
## ChromeHelpMenuActions interface
<b>Signature:</b>
```typescript
@ -15,3 +16,4 @@ export interface ChromeHelpMenuActions
| Property | Type | Description |
| --- | --- | --- |
| [hideHelpMenu](./kibana-plugin-core-public.chromehelpmenuactions.hidehelpmenu.md) | () =&gt; void | |

10
docs/development/core/public/kibana-plugin-core-public.coresetup.injectedmetadata.md
View file

@ -4,17 +4,9 @@
## CoreSetup.injectedMetadata property
> Warning: This API is now obsolete.
>
> 8.8.0
>
exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform.
<b>Signature:</b>
```typescript
injectedMetadata: {
getInjectedVar: (name: string, defaultValue?: any) => unknown;
};
injectedMetadata: InjectedMetadataSetup;
```

2
docs/development/core/public/kibana-plugin-core-public.coresetup.md
View file

@ -22,7 +22,7 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
| [fatalErrors](./kibana-plugin-core-public.coresetup.fatalerrors.md) | FatalErrorsSetup | [FatalErrorsSetup](./kibana-plugin-core-public.fatalerrorssetup.md) |
| [getStartServices](./kibana-plugin-core-public.coresetup.getstartservices.md) | StartServicesAccessor&lt;TPluginsStart, TStart&gt; | [StartServicesAccessor](./kibana-plugin-core-public.startservicesaccessor.md) |
| [http](./kibana-plugin-core-public.coresetup.http.md) | HttpSetup | [HttpSetup](./kibana-plugin-core-public.httpsetup.md) |
| [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) | { getInjectedVar: (name: string, defaultValue?: any) =&gt; unknown; } | exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform. |
| [injectedMetadata](./kibana-plugin-core-public.coresetup.injectedmetadata.md) | InjectedMetadataSetup | |
| [notifications](./kibana-plugin-core-public.coresetup.notifications.md) | NotificationsSetup | [NotificationsSetup](./kibana-plugin-core-public.notificationssetup.md) |
| [theme](./kibana-plugin-core-public.coresetup.theme.md) | ThemeServiceSetup | [ThemeServiceSetup](./kibana-plugin-core-public.themeservicesetup.md) |
| [uiSettings](./kibana-plugin-core-public.coresetup.uisettings.md) | IUiSettingsClient | [IUiSettingsClient](./kibana-plugin-core-public.iuisettingsclient.md) |

10
docs/development/core/public/kibana-plugin-core-public.corestart.injectedmetadata.md
View file

@ -4,17 +4,9 @@
## CoreStart.injectedMetadata property
> Warning: This API is now obsolete.
>
> 8.8.0
>
exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform.
<b>Signature:</b>
```typescript
injectedMetadata: {
getInjectedVar: (name: string, defaultValue?: any) => unknown;
};
injectedMetadata: InjectedMetadataStart;
```

2
docs/development/core/public/kibana-plugin-core-public.corestart.md
View file

@ -25,7 +25,7 @@ export interface CoreStart
| [fatalErrors](./kibana-plugin-core-public.corestart.fatalerrors.md) | FatalErrorsStart | [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) |
| [http](./kibana-plugin-core-public.corestart.http.md) | HttpStart | [HttpStart](./kibana-plugin-core-public.httpstart.md) |
| [i18n](./kibana-plugin-core-public.corestart.i18n.md) | I18nStart | [I18nStart](./kibana-plugin-core-public.i18nstart.md) |
| [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) | { getInjectedVar: (name: string, defaultValue?: any) =&gt; unknown; } | exposed temporarily until https://github.com/elastic/kibana/issues/41990 done use \*only\* to retrieve config values. There is no way to set injected values in the new platform. |
| [injectedMetadata](./kibana-plugin-core-public.corestart.injectedmetadata.md) | InjectedMetadataStart | |
| [notifications](./kibana-plugin-core-public.corestart.notifications.md) | NotificationsStart | [NotificationsStart](./kibana-plugin-core-public.notificationsstart.md) |
| [overlays](./kibana-plugin-core-public.corestart.overlays.md) | OverlayStart | [OverlayStart](./kibana-plugin-core-public.overlaystart.md) |
| [savedObjects](./kibana-plugin-core-public.corestart.savedobjects.md) | SavedObjectsStart | [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) |

2
docs/development/core/public/kibana-plugin-core-public.md
View file

@ -46,7 +46,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) | |
| [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) | |
| [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) | |
| [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) | List of actions in order to manipulate with the help menu from the help extensions content components. |
| [ChromeHelpMenuActions](./kibana-plugin-core-public.chromehelpmenuactions.md) | |
| [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) | |
| [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. |
| [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) | |

13
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.configpath.md
View file

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) &gt; [configPath](./kibana-plugin-core-server.discoveredplugin.configpath.md)
## DiscoveredPlugin.configPath property
Root configuration path used by the plugin, defaults to "id" in snake\_case format.
<b>Signature:</b>
```typescript
readonly configPath: ConfigPath;
```

13
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.enabledonanonymouspages.md
View file

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) &gt; [enabledOnAnonymousPages](./kibana-plugin-core-server.discoveredplugin.enabledonanonymouspages.md)
## DiscoveredPlugin.enabledOnAnonymousPages property
Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false.
<b>Signature:</b>
```typescript
readonly enabledOnAnonymousPages?: boolean;
```

13
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.id.md
View file

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) &gt; [id](./kibana-plugin-core-server.discoveredplugin.id.md)
## DiscoveredPlugin.id property
Identifier of the plugin.
<b>Signature:</b>
```typescript
readonly id: PluginName;
```

26
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.md
View file

@ -1,26 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md)
## DiscoveredPlugin interface
Small container object used to expose information about discovered plugins that may or may not have been started.
<b>Signature:</b>
```typescript
export interface DiscoveredPlugin
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [configPath](./kibana-plugin-core-server.discoveredplugin.configpath.md) | ConfigPath | Root configuration path used by the plugin, defaults to "id" in snake\_case format. |
| [enabledOnAnonymousPages?](./kibana-plugin-core-server.discoveredplugin.enabledonanonymouspages.md) | boolean | <i>(Optional)</i> Specifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when configured, etc.) Default is false. |
| [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\[\] | List of plugin ids that this plugin's UI code imports modules from that are not in <code>requiredPlugins</code>. |
| [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. |
| [type](./kibana-plugin-core-server.discoveredplugin.type.md) | PluginType | Type of the plugin, defaults to <code>standard</code>. |

13
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.optionalplugins.md
View file

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) &gt; [optionalPlugins](./kibana-plugin-core-server.discoveredplugin.optionalplugins.md)
## DiscoveredPlugin.optionalPlugins property
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.
<b>Signature:</b>
```typescript
readonly optionalPlugins: readonly PluginName[];
```

18
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredbundles.md
View file

@ -1,18 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) &gt; [requiredBundles](./kibana-plugin-core-server.discoveredplugin.requiredbundles.md)
## DiscoveredPlugin.requiredBundles property
List of plugin ids that this plugin's UI code imports modules from that are not in `requiredPlugins`<!-- -->.
<b>Signature:</b>
```typescript
readonly requiredBundles: readonly PluginName[];
```
## Remarks
The plugins listed here will be loaded in the browser, even if the plugin is disabled. Required by `@kbn/optimizer` to support cross-plugin imports. "core" and plugins already listed in `requiredPlugins` do not need to be duplicated here.

13
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.requiredplugins.md
View file

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) &gt; [requiredPlugins](./kibana-plugin-core-server.discoveredplugin.requiredplugins.md)
## DiscoveredPlugin.requiredPlugins property
An optional list of the other plugins that \*\*must be\*\* installed and enabled for this plugin to function properly.
<b>Signature:</b>
```typescript
readonly requiredPlugins: readonly PluginName[];
```

13
docs/development/core/server/kibana-plugin-core-server.discoveredplugin.type.md
View file

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) &gt; [type](./kibana-plugin-core-server.discoveredplugin.type.md)
## DiscoveredPlugin.type property
Type of the plugin, defaults to `standard`<!-- -->.
<b>Signature:</b>
```typescript
readonly type: PluginType;
```

4
docs/development/core/server/kibana-plugin-core-server.kibanaresponsefactory.md
View file

@ -10,7 +10,7 @@ Set of helpers used to create `KibanaResponse` to form HTTP response on an incom
```typescript
kibanaResponseFactory: {
custom: <T extends string | Record<string, any> | Error | Buffer | {
custom: <T extends string | Record<string, any> | Buffer | Error | {
message: string | Error;
attributes?: ResponseErrorAttributes | undefined;
} | Stream | undefined>(options: CustomHttpResponseOptions<T>) => KibanaResponse<T>;
@ -34,7 +34,7 @@ kibanaResponseFactory: {
message: string | Error;
attributes?: ResponseErrorAttributes | undefined;
}>;
customError: (options: CustomHttpResponseOptions<ResponseError | Buffer | Stream>) => KibanaResponse<string | Error | Buffer | {
customError: (options: CustomHttpResponseOptions<ResponseError | Buffer | Stream>) => KibanaResponse<string | Buffer | Error | {
message: string | Error;
attributes?: ResponseErrorAttributes | undefined;
} | Stream>;

2
docs/development/core/server/kibana-plugin-core-server.md
View file

@ -37,7 +37,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| --- | --- |
| [AuthResultType](./kibana-plugin-core-server.authresulttype.md) | |
| [AuthStatus](./kibana-plugin-core-server.authstatus.md) | Status indicating an outcome of the authentication. |
| [PluginType](./kibana-plugin-core-server.plugintype.md) | |
## Interfaces
@ -68,7 +67,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [DeprecationsClient](./kibana-plugin-core-server.deprecationsclient.md) | Server-side client that provides access to fetch all Kibana deprecations |
| [DeprecationSettings](./kibana-plugin-core-server.deprecationsettings.md) | UiSettings deprecation field options. |
| [DeprecationsServiceSetup](./kibana-plugin-core-server.deprecationsservicesetup.md) | The deprecations service provides a way for the Kibana platform to communicate deprecated features and configs with its users. These deprecations are only communicated if the deployment is using these features. Allowing for a user tailored experience for upgrading the stack version.<!-- -->The Deprecation service is consumed by the upgrade assistant to assist with the upgrade experience.<!-- -->If a deprecated feature can be resolved without manual user intervention. Using correctiveActions.api allows the Upgrade Assistant to use this api to correct the deprecation upon a user trigger. |
| [DiscoveredPlugin](./kibana-plugin-core-server.discoveredplugin.md) | Small container object used to expose information about discovered plugins that may or may not have been started. |
| [DocLinksServiceSetup](./kibana-plugin-core-server.doclinksservicesetup.md) | |
| [ElasticsearchConfigPreboot](./kibana-plugin-core-server.elasticsearchconfigpreboot.md) | A limited set of Elasticsearch configuration entries exposed to the <code>preboot</code> plugins at <code>setup</code>. |
| [ElasticsearchErrorDetails](./kibana-plugin-core-server.elasticsearcherrordetails.md) | |

20
docs/development/core/server/kibana-plugin-core-server.plugintype.md
View file

@ -1,20 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [PluginType](./kibana-plugin-core-server.plugintype.md)
## PluginType enum
<b>Signature:</b>
```typescript
export declare enum PluginType
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| preboot | <code>&quot;preboot&quot;</code> | Preboot plugins are special-purpose plugins that only function during preboot stage. |
| standard | <code>&quot;standard&quot;</code> | Standard plugins are plugins that start to function as soon as Kibana is fully booted and are active until it shuts down. |