Skip to content

Commit 0688520

Browse files
kibanamachinekibanamachine
authored
Merge branch '7.x' into backport/7.x/pr-88688
2 parents efb0560 + 97f89e2 commit 0688520

118 files changed

Lines changed: 1212 additions & 558 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/developer/plugin/migrating-legacy-plugins-examples.asciidoc‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,20 @@ export function plugin(initializerContext: PluginInitializerContext) {
7171
*plugins/my_plugin/(public|server)/plugin.ts*
7272
[source,typescript]
7373
----
74-
import type { Observable } from 'rxjs';
75-
import { first } from 'rxjs/operators';
7674
import { CoreSetup, Logger, Plugin, PluginInitializerContext, PluginName } from 'kibana/server';
7775
import type { MyPluginConfig } from './config';
7876
7977
export class MyPlugin implements Plugin {
80-
private readonly config$: Observable<MyPluginConfig>;
78+
private readonly config: MyPluginConfig;
8179
private readonly log: Logger;
8280
8381
constructor(private readonly initializerContext: PluginInitializerContext) {
8482
this.log = initializerContext.logger.get();
85-
this.config$ = initializerContext.config.create();
83+
this.config = initializerContext.config.get<MyPluginConfig>();
8684
}
8785
88-
public async setup(core: CoreSetup, deps: Record<PluginName, unknown>) {
89-
const isEnabled = await this.config$.pipe(first()).toPromise();
86+
public setup(core: CoreSetup, deps: Record<PluginName, unknown>) {
87+
const { someConfigValue } = this.config;
9088
}
9189
}
9290
----
@@ -96,7 +94,7 @@ Additionally, some plugins need to access the runtime env configuration.
9694
[source,typescript]
9795
----
9896
export class MyPlugin implements Plugin {
99-
public async setup(core: CoreSetup, deps: Record<PluginName, unknown>) {
97+
public setup(core: CoreSetup, deps: Record<PluginName, unknown>) {
10098
const { mode: { dev }, packageInfo: { version } } = this.initializerContext.env
10199
}
102100
----

‎docs/development/core/public/kibana-plugin-core-public.asyncplugin.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [AsyncPlugin](./kibana-plugin-core-public.asyncplugin.md)
4+
5+
## AsyncPlugin interface
6+
7+
> Warning: This API is now obsolete.
8+
>
9+
> Asynchronous lifecycles are deprecated, and should be migrated to sync [plugin](./kibana-plugin-core-public.plugin.md)
10+
>
11+
12+
A plugin with asynchronous lifecycle methods.
13+
14+
<b>Signature:</b>
15+
16+
```typescript
17+
export interface AsyncPlugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object>
18+
```
19+
20+
## Methods
21+
22+
| Method | Description |
23+
| --- | --- |
24+
| [setup(core, plugins)](./kibana-plugin-core-public.asyncplugin.setup.md) | |
25+
| [start(core, plugins)](./kibana-plugin-core-public.asyncplugin.start.md) | |
26+
| [stop()](./kibana-plugin-core-public.asyncplugin.stop.md) | |
27+

‎docs/development/core/public/kibana-plugin-core-public.asyncplugin.setup.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [AsyncPlugin](./kibana-plugin-core-public.asyncplugin.md) &gt; [setup](./kibana-plugin-core-public.asyncplugin.setup.md)
4+
5+
## AsyncPlugin.setup() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
setup(core: CoreSetup<TPluginsStart, TStart>, plugins: TPluginsSetup): TSetup | Promise<TSetup>;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| core | <code>CoreSetup&lt;TPluginsStart, TStart&gt;</code> | |
18+
| plugins | <code>TPluginsSetup</code> | |
19+
20+
<b>Returns:</b>
21+
22+
`TSetup | Promise<TSetup>`
23+

‎docs/development/core/public/kibana-plugin-core-public.asyncplugin.start.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [AsyncPlugin](./kibana-plugin-core-public.asyncplugin.md) &gt; [start](./kibana-plugin-core-public.asyncplugin.start.md)
4+
5+
## AsyncPlugin.start() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
start(core: CoreStart, plugins: TPluginsStart): TStart | Promise<TStart>;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| core | <code>CoreStart</code> | |
18+
| plugins | <code>TPluginsStart</code> | |
19+
20+
<b>Returns:</b>
21+
22+
`TStart | Promise<TStart>`
23+

‎docs/development/core/public/kibana-plugin-core-public.asyncplugin.stop.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [AsyncPlugin](./kibana-plugin-core-public.asyncplugin.md) &gt; [stop](./kibana-plugin-core-public.asyncplugin.stop.md)
4+
5+
## AsyncPlugin.stop() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
stop?(): void;
11+
```
12+
<b>Returns:</b>
13+
14+
`void`
15+

‎docs/development/core/public/kibana-plugin-core-public.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
3939
| [ApplicationStart](./kibana-plugin-core-public.applicationstart.md) | |
4040
| [AppMeta](./kibana-plugin-core-public.appmeta.md) | Input type for meta data for an application.<!-- -->Meta fields include <code>keywords</code> and <code>searchDeepLinks</code> Keywords is an array of string with which to associate the app, must include at least one unique string as an array. <code>searchDeepLinks</code> is an array of links that represent secondary in-app locations for the app. |
4141
| [AppMountParameters](./kibana-plugin-core-public.appmountparameters.md) | |
42+
| [AsyncPlugin](./kibana-plugin-core-public.asyncplugin.md) | A plugin with asynchronous lifecycle methods. |
4243
| [Capabilities](./kibana-plugin-core-public.capabilities.md) | The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. |
4344
| [ChromeBadge](./kibana-plugin-core-public.chromebadge.md) | |
4445
| [ChromeBrand](./kibana-plugin-core-public.chromebrand.md) | |

‎docs/development/core/public/kibana-plugin-core-public.plugin.setup.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<b>Signature:</b>
88

99
```typescript
10-
setup(core: CoreSetup<TPluginsStart, TStart>, plugins: TPluginsSetup): TSetup | Promise<TSetup>;
10+
setup(core: CoreSetup<TPluginsStart, TStart>, plugins: TPluginsSetup): TSetup;
1111
```
1212

1313
## Parameters
@@ -19,5 +19,5 @@ setup(core: CoreSetup<TPluginsStart, TStart>, plugins: TPluginsSetup): TSetup |
1919

2020
<b>Returns:</b>
2121

22-
`TSetup | Promise<TSetup>`
22+
`TSetup`
2323

‎docs/development/core/public/kibana-plugin-core-public.plugin.start.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<b>Signature:</b>
88

99
```typescript
10-
start(core: CoreStart, plugins: TPluginsStart): TStart | Promise<TStart>;
10+
start(core: CoreStart, plugins: TPluginsStart): TStart;
1111
```
1212

1313
## Parameters
@@ -19,5 +19,5 @@ start(core: CoreStart, plugins: TPluginsStart): TStart | Promise<TStart>;
1919

2020
<b>Returns:</b>
2121

22-
`TStart | Promise<TStart>`
22+
`TStart`
2323

‎docs/development/core/public/kibana-plugin-core-public.plugininitializer.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The `plugin` export at the root of a plugin's `public` directory should conform
99
<b>Signature:</b>
1010

1111
```typescript
12-
export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
12+
export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart> | AsyncPlugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
1313
```

‎docs/development/core/server/kibana-plugin-core-server.asyncplugin.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [AsyncPlugin](./kibana-plugin-core-server.asyncplugin.md)
4+
5+
## AsyncPlugin interface
6+
7+
> Warning: This API is now obsolete.
8+
>
9+
> Asynchronous lifecycles are deprecated, and should be migrated to sync [plugin](./kibana-plugin-core-server.plugin.md)
10+
>
11+
12+
A plugin with asynchronous lifecycle methods.
13+
14+
<b>Signature:</b>
15+
16+
```typescript
17+
export interface AsyncPlugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object>
18+
```
19+
20+
## Methods
21+
22+
| Method | Description |
23+
| --- | --- |
24+
| [setup(core, plugins)](./kibana-plugin-core-server.asyncplugin.setup.md) | |
25+
| [start(core, plugins)](./kibana-plugin-core-server.asyncplugin.start.md) | |
26+
| [stop()](./kibana-plugin-core-server.asyncplugin.stop.md) | |
27+

0 commit comments

Comments
 (0)