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

[Core] Fix core api changes exit code (#36053) (#36101)

Browse source 
* Bump api-extractor to fix missing warning bug

* Fix api-extractor not failing build on api changes

Workaround for upstream bug

* Don't fail build for api-extractor warnings

Warnings like forgotten exports won't fail the build. Instead these
will be added as comments to the api review files. Thus even though
the build won't break, these warnings will show up in code review and
should be fixed by the author.

This is to allow us to merge the workaround for the upstream bugs
without breaking master until we've addressed all the warnings.
This commit is contained in:
Rudolf Meijering 2019-05-06 10:45:13 +02:00 • committed by GitHub
parent f0ecf26b28
commit dc22d2065a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
47 changed files with 400 additions and 143 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/development/core/public/kibana-plugin-public.capabilitiessetup.getcapabilities.md → docs/development/core/public/kibana-plugin-public.capabilitiesstart.getcapabilities.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md) &gt; [getCapabilities](./kibana-plugin-public.capabilitiessetup.getcapabilities.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CapabilitiesStart](./kibana-plugin-public.capabilitiesstart.md) &gt; [getCapabilities](./kibana-plugin-public.capabilitiesstart.getcapabilities.md)
## CapabilitiesSetup.getCapabilities property
## CapabilitiesStart.getCapabilities property
Gets the read-only capabilities.

8
docs/development/core/public/kibana-plugin-public.capabilitiessetup.md → docs/development/core/public/kibana-plugin-public.capabilitiesstart.md
View file

@ -1,20 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CapabilitiesStart](./kibana-plugin-public.capabilitiesstart.md)
## CapabilitiesSetup interface
## CapabilitiesStart interface
Capabilities Setup.
<b>Signature:</b>
```typescript
export interface CapabilitiesSetup
export interface CapabilitiesStart
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [getCapabilities](./kibana-plugin-public.capabilitiessetup.getcapabilities.md) | <code>() =&gt; Capabilities</code> | Gets the read-only capabilities. |
| [getCapabilities](./kibana-plugin-public.capabilitiesstart.getcapabilities.md) | <code>() =&gt; Capabilities</code> | Gets the read-only capabilities. |

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

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBadge](./kibana-plugin-public.chromebadge.md) &gt; [iconType](./kibana-plugin-public.chromebadge.icontype.md)
## ChromeBadge.iconType property

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

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBadge](./kibana-plugin-public.chromebadge.md)
## ChromeBadge interface

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

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBadge](./kibana-plugin-public.chromebadge.md) &gt; [text](./kibana-plugin-public.chromebadge.text.md)
## ChromeBadge.text property

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

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBadge](./kibana-plugin-public.chromebadge.md) &gt; [tooltip](./kibana-plugin-public.chromebadge.tooltip.md)
## ChromeBadge.tooltip property

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [capabilities](./kibana-plugin-public.coresetup.capabilities.md)
## CoreSetup.capabilities property
[CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md)
<b>Signature:</b>
```typescript
capabilities: CapabilitiesSetup;
```

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

@ -17,13 +17,11 @@ export interface CoreSetup
| Property | Type | Description |
| --- | --- | --- |
| [basePath](./kibana-plugin-public.coresetup.basepath.md) | <code>BasePathSetup</code> | [BasePathSetup](./kibana-plugin-public.basepathsetup.md) |
| [capabilities](./kibana-plugin-public.coresetup.capabilities.md) | <code>CapabilitiesSetup</code> | [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md) |
| [chrome](./kibana-plugin-public.coresetup.chrome.md) | <code>ChromeSetup</code> | [ChromeSetup](./kibana-plugin-public.chromesetup.md) |
| [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) |
| [http](./kibana-plugin-public.coresetup.http.md) | <code>HttpSetup</code> | [HttpSetup](./kibana-plugin-public.httpsetup.md) |
| [i18n](./kibana-plugin-public.coresetup.i18n.md) | <code>I18nSetup</code> | [I18nSetup](./kibana-plugin-public.i18nsetup.md) |
| [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md) | <code>InjectedMetadataSetup</code> | [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) |
| [notifications](./kibana-plugin-public.coresetup.notifications.md) | <code>NotificationsSetup</code> | [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) |
| [overlays](./kibana-plugin-public.coresetup.overlays.md) | <code>OverlaySetup</code> | [OverlaySetup](./kibana-plugin-public.overlaysetup.md) |
| [uiSettings](./kibana-plugin-public.coresetup.uisettings.md) | <code>UiSettingsSetup</code> | [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md) |

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

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [overlays](./kibana-plugin-public.coresetup.overlays.md)
## CoreSetup.overlays property
[OverlaySetup](./kibana-plugin-public.overlaysetup.md)
<b>Signature:</b>
```typescript
overlays: OverlaySetup;
```

13
docs/development/core/public/kibana-plugin-public.corestart.capabilities.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreStart](./kibana-plugin-public.corestart.md) &gt; [capabilities](./kibana-plugin-public.corestart.capabilities.md)
## CoreStart.capabilities property
[CapabilitiesStart](./kibana-plugin-public.capabilitiesstart.md)
<b>Signature:</b>
```typescript
capabilities: CapabilitiesStart;
```

13
docs/development/core/public/kibana-plugin-public.corestart.i18n.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreStart](./kibana-plugin-public.corestart.md) &gt; [i18n](./kibana-plugin-public.corestart.i18n.md)
## CoreStart.i18n property
[I18nStart](./kibana-plugin-public.i18nstart.md)
<b>Signature:</b>
```typescript
i18n: I18nStart;
```

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

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreStart](./kibana-plugin-public.corestart.md) &gt; [injectedMetadata](./kibana-plugin-public.corestart.injectedmetadata.md)
## CoreStart.injectedMetadata property
[InjectedMetadataStart](./kibana-plugin-public.injectedmetadatastart.md)
<b>Signature:</b>
```typescript
injectedMetadata: InjectedMetadataStart;
```

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

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreStart](./kibana-plugin-public.corestart.md)
## CoreStart interface
<b>Signature:</b>
```typescript
export interface CoreStart
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [capabilities](./kibana-plugin-public.corestart.capabilities.md) | <code>CapabilitiesStart</code> | [CapabilitiesStart](./kibana-plugin-public.capabilitiesstart.md) |
| [i18n](./kibana-plugin-public.corestart.i18n.md) | <code>I18nStart</code> | [I18nStart](./kibana-plugin-public.i18nstart.md) |
| [injectedMetadata](./kibana-plugin-public.corestart.injectedmetadata.md) | <code>InjectedMetadataStart</code> | [InjectedMetadataStart](./kibana-plugin-public.injectedmetadatastart.md) |
| [notifications](./kibana-plugin-public.corestart.notifications.md) | <code>NotificationsStart</code> | [NotificationsStart](./kibana-plugin-public.notificationsstart.md) |
| [overlays](./kibana-plugin-public.corestart.overlays.md) | <code>OverlayStart</code> | [OverlayStart](./kibana-plugin-public.overlaystart.md) |

13
docs/development/core/public/kibana-plugin-public.corestart.notifications.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreStart](./kibana-plugin-public.corestart.md) &gt; [notifications](./kibana-plugin-public.corestart.notifications.md)
## CoreStart.notifications property
[NotificationsStart](./kibana-plugin-public.notificationsstart.md)
<b>Signature:</b>
```typescript
notifications: NotificationsStart;
```

13
docs/development/core/public/kibana-plugin-public.corestart.overlays.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreStart](./kibana-plugin-public.corestart.md) &gt; [overlays](./kibana-plugin-public.corestart.overlays.md)
## CoreStart.overlays property
[OverlayStart](./kibana-plugin-public.overlaystart.md)
<b>Signature:</b>
```typescript
overlays: OverlayStart;
```

11
docs/development/core/public/kibana-plugin-public.i18nstart.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [I18nStart](./kibana-plugin-public.i18nstart.md)
## I18nStart type
<b>Signature:</b>
```typescript
export declare type I18nStart = I18nSetup;
```

12
docs/development/core/public/kibana-plugin-public.injectedmetadatastart.md Normal file
View file

@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataStart](./kibana-plugin-public.injectedmetadatastart.md)
## InjectedMetadataStart type
<b>Signature:</b>
```typescript
export declare type InjectedMetadataStart = InjectedMetadataSetup;
```

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

@ -1,46 +1,50 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md)
## kibana-plugin-public package
## Classes
| Class | Description |
| --- | --- |
| [FlyoutRef](./kibana-plugin-public.flyoutref.md) | A FlyoutRef is a reference to an opened flyout panel. It offers methods to close the flyout panel again. If you open a flyout panel you should make sure you call <code>close()</code> when it should be closed. Since a flyout could also be closed by a user or from another flyout being opened, you must bind to the <code>onClose</code> Promise on the FlyoutRef instance. The Promise will resolve whenever the flyout was closed at which point you should discard the FlyoutRef. |
| [ToastsSetup](./kibana-plugin-public.toastssetup.md) | |
| [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) | |
## Interfaces
| Interface | Description |
| --- | --- |
| [BasePathSetup](./kibana-plugin-public.basepathsetup.md) | Provides access to the 'server.basePath' configuration option in kibana.yml |
| [Capabilities](./kibana-plugin-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. |
| [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md) | Capabilities Setup. |
| [ChromeBadge](./kibana-plugin-public.chromebadge.md) | |
| [ChromeBrand](./kibana-plugin-public.chromebrand.md) | |
| [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) | |
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the start lifecycle |
| [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
| [I18nSetup](./kibana-plugin-public.i18nsetup.md) | I18nSetup.Context is required by any localizable React component from @<!-- -->kbn/i18n and @<!-- -->elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. |
| [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) | Provides access to the metadata injected by the server into the page |
| [OverlaySetup](./kibana-plugin-public.overlaysetup.md) | |
| [Plugin](./kibana-plugin-public.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
| [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md) | The available core services passed to a <code>PluginInitializer</code> |
| [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) | The available core services passed to a plugin's <code>Plugin#setup</code> method. |
| [UiSettingsState](./kibana-plugin-public.uisettingsstate.md) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) | |
| [ChromeSetup](./kibana-plugin-public.chromesetup.md) | |
| [HttpSetup](./kibana-plugin-public.httpsetup.md) | |
| [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) | |
| [PluginInitializer](./kibana-plugin-public.plugininitializer.md) | The <code>plugin</code> export at the root of a plugin's <code>public</code> directory should conform to this interface. |
| [ToastInput](./kibana-plugin-public.toastinput.md) | |
| [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md) | |
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md)
## kibana-plugin-public package
## Classes
| Class | Description |
| --- | --- |
| [FlyoutRef](./kibana-plugin-public.flyoutref.md) | A FlyoutRef is a reference to an opened flyout panel. It offers methods to close the flyout panel again. If you open a flyout panel you should make sure you call <code>close()</code> when it should be closed. Since a flyout could also be closed by a user or from another flyout being opened, you must bind to the <code>onClose</code> Promise on the FlyoutRef instance. The Promise will resolve whenever the flyout was closed at which point you should discard the FlyoutRef. |
| [ToastsApi](./kibana-plugin-public.toastsapi.md) | |
| [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) | |
## Interfaces
| Interface | Description |
| --- | --- |
| [BasePathSetup](./kibana-plugin-public.basepathsetup.md) | Provides access to the 'server.basePath' configuration option in kibana.yml |
| [Capabilities](./kibana-plugin-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. |
| [CapabilitiesStart](./kibana-plugin-public.capabilitiesstart.md) | Capabilities Setup. |
| [ChromeBadge](./kibana-plugin-public.chromebadge.md) | |
| [ChromeBrand](./kibana-plugin-public.chromebrand.md) | |
| [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) | |
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the start lifecycle |
| [CoreStart](./kibana-plugin-public.corestart.md) | |
| [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
| [I18nSetup](./kibana-plugin-public.i18nsetup.md) | I18nSetup.Context is required by any localizable React component from @<!-- -->kbn/i18n and @<!-- -->elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. |
| [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) | Provides access to the metadata injected by the server into the page |
| [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) | |
| [OverlayStart](./kibana-plugin-public.overlaystart.md) | |
| [Plugin](./kibana-plugin-public.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
| [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md) | The available core services passed to a <code>PluginInitializer</code> |
| [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) | The available core services passed to a plugin's <code>Plugin#setup</code> method. |
| [UiSettingsState](./kibana-plugin-public.uisettingsstate.md) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) | |
| [ChromeSetup](./kibana-plugin-public.chromesetup.md) | |
| [HttpSetup](./kibana-plugin-public.httpsetup.md) | |
| [I18nStart](./kibana-plugin-public.i18nstart.md) | |
| [InjectedMetadataStart](./kibana-plugin-public.injectedmetadatastart.md) | |
| [NotificationsStart](./kibana-plugin-public.notificationsstart.md) | |
| [PluginInitializer](./kibana-plugin-public.plugininitializer.md) | The <code>plugin</code> export at the root of a plugin's <code>public</code> directory should conform to this interface. |
| [ToastInput](./kibana-plugin-public.toastinput.md) | |
| [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md) | |

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

@ -2,11 +2,18 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [NotificationsSetup](./kibana-plugin-public.notificationssetup.md)
## NotificationsSetup type
## NotificationsSetup interface
<b>Signature:</b>
```typescript
export declare type NotificationsSetup = ReturnType<NotificationsService['setup']>;
export interface NotificationsSetup
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [toasts](./kibana-plugin-public.notificationssetup.toasts.md) | <code>ToastsApi</code> | |

11
docs/development/core/public/kibana-plugin-public.notificationssetup.toasts.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) &gt; [toasts](./kibana-plugin-public.notificationssetup.toasts.md)
## NotificationsSetup.toasts property
<b>Signature:</b>
```typescript
toasts: ToastsApi;
```

12
docs/development/core/public/kibana-plugin-public.notificationsstart.md Normal file
View file

@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [NotificationsStart](./kibana-plugin-public.notificationsstart.md)
## NotificationsStart type
<b>Signature:</b>
```typescript
export declare type NotificationsStart = NotificationsSetup;
```

8
docs/development/core/public/kibana-plugin-public.overlaysetup.md → docs/development/core/public/kibana-plugin-public.overlaystart.md
View file

@ -1,19 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [OverlaySetup](./kibana-plugin-public.overlaysetup.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [OverlayStart](./kibana-plugin-public.overlaystart.md)
## OverlaySetup interface
## OverlayStart interface
<b>Signature:</b>
```typescript
export interface OverlaySetup
export interface OverlayStart
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [openFlyout](./kibana-plugin-public.overlaysetup.openflyout.md) | <code>(flyoutChildren: React.ReactNode, flyoutProps?: {`<p/>` closeButtonAriaLabel?: string;`<p/>` 'data-test-subj'?: string;`<p/>` }) =&gt; FlyoutRef</code> | |
| [openFlyout](./kibana-plugin-public.overlaystart.openflyout.md) | <code>(flyoutChildren: React.ReactNode, flyoutProps?: {`<p/>` closeButtonAriaLabel?: string;`<p/>` 'data-test-subj'?: string;`<p/>` }) =&gt; FlyoutRef</code> | |

4
docs/development/core/public/kibana-plugin-public.overlaysetup.openflyout.md → docs/development/core/public/kibana-plugin-public.overlaystart.openflyout.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [OverlaySetup](./kibana-plugin-public.overlaysetup.md) &gt; [openFlyout](./kibana-plugin-public.overlaysetup.openflyout.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [OverlayStart](./kibana-plugin-public.overlaystart.md) &gt; [openFlyout](./kibana-plugin-public.overlaystart.openflyout.md)
## OverlaySetup.openFlyout property
## OverlayStart.openFlyout property
<b>Signature:</b>

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

@ -9,7 +9,7 @@ The interface that should be returned by a `PluginInitializer`<!-- -->.
<b>Signature:</b>
```typescript
export interface Plugin<TSetup, TPluginsSetup extends Record<string, unknown> =
export interface Plugin<TSetup, TStart, TPluginsSetup extends Record<string, unknown> = {}, TPluginsStart extends Record<string, unknown> = {}>
```
## Properties
@ -17,5 +17,6 @@ export interface Plugin<TSetup, TPluginsSetup extends Record<string, unknown> =
| Property | Type | Description |
| --- | --- | --- |
| [setup](./kibana-plugin-public.plugin.setup.md) | <code>(core: PluginSetupContext, plugins: TPluginsSetup) =&gt; TSetup &#124; Promise&lt;TSetup&gt;</code> | |
| [start](./kibana-plugin-public.plugin.start.md) | <code>(core: PluginStartContext, plugins: TPluginsStart) =&gt; TStart &#124; Promise&lt;TStart&gt;</code> | |
| [stop](./kibana-plugin-public.plugin.stop.md) | <code>() =&gt; void</code> | |

11
docs/development/core/public/kibana-plugin-public.plugin.start.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Plugin](./kibana-plugin-public.plugin.md) &gt; [start](./kibana-plugin-public.plugin.start.md)
## Plugin.start property
<b>Signature:</b>
```typescript
start: (core: PluginStartContext, plugins: TPluginsStart) => TStart | Promise<TStart>;
```

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

@ -9,5 +9,5 @@ The `plugin` export at the root of a plugin's `public` directory should conform
<b>Signature:</b>
```typescript
export declare type PluginInitializer<TSetup, TPluginsSetup extends Record<string, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TPluginsSetup>;
export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<string, unknown> = {}, TPluginsStart extends Record<string, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
```

4
docs/development/core/public/kibana-plugin-public.toastssetup.add.md → docs/development/core/public/kibana-plugin-public.toastsapi.add.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [add](./kibana-plugin-public.toastssetup.add.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [add](./kibana-plugin-public.toastsapi.add.md)
## ToastsSetup.add() method
## ToastsApi.add() method
<b>Signature:</b>

4
docs/development/core/public/kibana-plugin-public.toastssetup.adddanger.md → docs/development/core/public/kibana-plugin-public.toastsapi.adddanger.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addDanger](./kibana-plugin-public.toastssetup.adddanger.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [addDanger](./kibana-plugin-public.toastsapi.adddanger.md)
## ToastsSetup.addDanger() method
## ToastsApi.addDanger() method
<b>Signature:</b>

4
docs/development/core/public/kibana-plugin-public.toastssetup.addsuccess.md → docs/development/core/public/kibana-plugin-public.toastsapi.addsuccess.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addSuccess](./kibana-plugin-public.toastssetup.addsuccess.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [addSuccess](./kibana-plugin-public.toastsapi.addsuccess.md)
## ToastsSetup.addSuccess() method
## ToastsApi.addSuccess() method
<b>Signature:</b>

4
docs/development/core/public/kibana-plugin-public.toastssetup.addwarning.md → docs/development/core/public/kibana-plugin-public.toastsapi.addwarning.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addWarning](./kibana-plugin-public.toastssetup.addwarning.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [addWarning](./kibana-plugin-public.toastsapi.addwarning.md)
## ToastsSetup.addWarning() method
## ToastsApi.addWarning() method
<b>Signature:</b>

4
docs/development/core/public/kibana-plugin-public.toastssetup.get$.md → docs/development/core/public/kibana-plugin-public.toastsapi.get$.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [get$](./kibana-plugin-public.toastssetup.get$.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [get$](./kibana-plugin-public.toastsapi.get$.md)
## ToastsSetup.get$() method
## ToastsApi.get$() method
<b>Signature:</b>

24
docs/development/core/public/kibana-plugin-public.toastsapi.md Normal file
View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md)
## ToastsApi class
<b>Signature:</b>
```typescript
export declare class ToastsApi
```
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [add(toastOrTitle)](./kibana-plugin-public.toastsapi.add.md) | | |
| [addDanger(toastOrTitle)](./kibana-plugin-public.toastsapi.adddanger.md) | | |
| [addSuccess(toastOrTitle)](./kibana-plugin-public.toastsapi.addsuccess.md) | | |
| [addWarning(toastOrTitle)](./kibana-plugin-public.toastsapi.addwarning.md) | | |
| [get$()](./kibana-plugin-public.toastsapi.get$.md) | | |
| [remove(toast)](./kibana-plugin-public.toastsapi.remove.md) | | |

4
docs/development/core/public/kibana-plugin-public.toastssetup.remove.md → docs/development/core/public/kibana-plugin-public.toastsapi.remove.md
View file

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [remove](./kibana-plugin-public.toastssetup.remove.md)
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsApi](./kibana-plugin-public.toastsapi.md) &gt; [remove](./kibana-plugin-public.toastsapi.remove.md)
## ToastsSetup.remove() method
## ToastsApi.remove() method
<b>Signature:</b>

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

@ -1,24 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md)
## ToastsSetup class
<b>Signature:</b>
```typescript
export declare class ToastsSetup
```
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [add(toastOrTitle)](./kibana-plugin-public.toastssetup.add.md) | | |
| [addDanger(toastOrTitle)](./kibana-plugin-public.toastssetup.adddanger.md) | | |
| [addSuccess(toastOrTitle)](./kibana-plugin-public.toastssetup.addsuccess.md) | | |
| [addWarning(toastOrTitle)](./kibana-plugin-public.toastssetup.addwarning.md) | | |
| [get$()](./kibana-plugin-public.toastssetup.get$.md) | | |
| [remove(toast)](./kibana-plugin-public.toastssetup.remove.md) | | |

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

@ -15,4 +15,5 @@ export interface CoreStart
| Property | Type | Description |
| --- | --- | --- |
| [http](./kibana-plugin-server.corestart.http.md) | <code>HttpServiceStart</code> | |
| [plugins](./kibana-plugin-server.corestart.plugins.md) | <code>PluginsServiceStart</code> | |

11
docs/development/core/server/kibana-plugin-server.corestart.plugins.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [CoreStart](./kibana-plugin-server.corestart.md) &gt; [plugins](./kibana-plugin-server.corestart.plugins.md)
## CoreStart.plugins property
<b>Signature:</b>
```typescript
plugins: PluginsServiceStart;
```

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

@ -31,6 +31,7 @@
| [Plugin](./kibana-plugin-server.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
| [PluginInitializerContext](./kibana-plugin-server.plugininitializercontext.md) | Context that's available to plugins during initialization stage. |
| [PluginSetupContext](./kibana-plugin-server.pluginsetupcontext.md) | Context passed to the plugins <code>setup</code> method. |
| [PluginStartContext](./kibana-plugin-server.pluginstartcontext.md) | Context passed to the plugins <code>start</code> method. |
## Type Aliases

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

@ -9,13 +9,14 @@ The interface that should be returned by a `PluginInitializer`<!-- -->.
<b>Signature:</b>
```typescript
export interface Plugin<TSetup, TPluginsSetup extends Record<PluginName, unknown> =
export interface Plugin<TSetup, TStart, TPluginsSetup extends Record<PluginName, unknown> = {}, TPluginsStart extends Record<PluginName, unknown> = {}>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [setup](./kibana-plugin-server.plugin.setup.md) | <code>(pluginSetupContext: PluginSetupContext, plugins: TPluginsSetup) =&gt; TSetup &#124; Promise&lt;TSetup&gt;</code> | |
| [setup](./kibana-plugin-server.plugin.setup.md) | <code>(core: PluginSetupContext, plugins: TPluginsSetup) =&gt; TSetup &#124; Promise&lt;TSetup&gt;</code> | |
| [start](./kibana-plugin-server.plugin.start.md) | <code>(core: PluginStartContext, plugins: TPluginsStart) =&gt; TStart &#124; Promise&lt;TStart&gt;</code> | |
| [stop](./kibana-plugin-server.plugin.stop.md) | <code>() =&gt; void</code> | |

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

@ -7,5 +7,5 @@
<b>Signature:</b>
```typescript
setup: (pluginSetupContext: PluginSetupContext, plugins: TPluginsSetup) => TSetup | Promise<TSetup>;
setup: (core: PluginSetupContext, plugins: TPluginsSetup) => TSetup | Promise<TSetup>;
```

11
docs/development/core/server/kibana-plugin-server.plugin.start.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [Plugin](./kibana-plugin-server.plugin.md) &gt; [start](./kibana-plugin-server.plugin.start.md)
## Plugin.start property
<b>Signature:</b>
```typescript
start: (core: PluginStartContext, plugins: TPluginsStart) => TStart | Promise<TStart>;
```

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

@ -9,5 +9,5 @@ The `plugin` export at the root of a plugin's `server` directory should conform
<b>Signature:</b>
```typescript
export declare type PluginInitializer<TSetup, TPluginsSetup extends Record<PluginName, unknown> = {}> = (coreContext: PluginInitializerContext) => Plugin<TSetup, TPluginsSetup>;
export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<PluginName, unknown> = {}, TPluginsStart extends Record<PluginName, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
```

13
docs/development/core/server/kibana-plugin-server.pluginstartcontext.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PluginStartContext](./kibana-plugin-server.pluginstartcontext.md)
## PluginStartContext interface
Context passed to the plugins `start` method.
<b>Signature:</b>
```typescript
export interface PluginStartContext
```

2
package.json
View file

@ -267,7 +267,7 @@
"@kbn/plugin-generator": "1.0.0",
"@kbn/test": "1.0.0",
"@microsoft/api-documenter": "7.0.49",
"@microsoft/api-extractor": "7.0.41",
"@microsoft/api-extractor": "7.1.1",
"@octokit/rest": "^15.10.0",
"@types/angular": "1.6.50",
"@types/angular-mocks": "^1.7.0",

24
src/core/public/public.api.md
View file

@ -64,6 +64,8 @@ export interface ChromeBreadcrumb {
// @public (undocumented)
export type ChromeHelpExtension = (element: HTMLDivElement) => (() => void);
// Warning: (ae-forgotten-export) The symbol "ChromeService" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type ChromeSetup = ReturnType<ChromeService['setup']>;
@ -91,6 +93,8 @@ export interface CoreSetup {
uiSettings: UiSettingsSetup;
}
// Warning: (ae-missing-release-tag) "CoreStart" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface CoreStart {
// (undocumented)
@ -107,6 +111,7 @@ export interface CoreStart {
// @internal
export class CoreSystem {
// Warning: (ae-forgotten-export) The symbol "Params" needs to be exported by the entry point index.d.ts
constructor(params: Params);
// (undocumented)
setup(): Promise<{
@ -121,6 +126,7 @@ export class CoreSystem {
// @public
export interface FatalErrorsSetup {
add: (error: string | Error, source?: string) => never;
// Warning: (ae-forgotten-export) The symbol "ErrorInfo" needs to be exported by the entry point index.d.ts
get$: () => Rx.Observable<ErrorInfo>;
}
@ -131,6 +137,8 @@ export class FlyoutRef {
readonly onClose: Promise<void>;
}
// Warning: (ae-forgotten-export) The symbol "HttpService" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type HttpSetup = ReturnType<HttpService['setup']>;
@ -141,6 +149,8 @@ export interface I18nSetup {
}) => JSX.Element;
}
// Warning: (ae-missing-release-tag) "I18nStart" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type I18nStart = I18nSetup;
@ -235,6 +245,8 @@ export type NotificationsStart = NotificationsSetup;
// @public (undocumented)
export interface OverlayStart {
// Warning: (ae-forgotten-export) The symbol "React" needs to be exported by the entry point index.d.ts
//
// (undocumented)
openFlyout: (flyoutChildren: React.ReactNode, flyoutProps?: {
closeButtonAriaLabel?: string;
@ -246,6 +258,8 @@ export interface OverlayStart {
export interface Plugin<TSetup, TStart, TPluginsSetup extends Record<string, unknown> = {}, TPluginsStart extends Record<string, unknown> = {}> {
// (undocumented)
setup: (core: PluginSetupContext, plugins: TPluginsSetup) => TSetup | Promise<TSetup>;
// Warning: (ae-forgotten-export) The symbol "PluginStartContext" needs to be exported by the entry point index.d.ts
//
// (undocumented)
start: (core: PluginStartContext, plugins: TPluginsStart) => TStart | Promise<TStart>;
// (undocumented)
@ -318,6 +332,8 @@ export class UiSettingsClient {
isDefault(key: string): boolean;
isOverridden(key: string): boolean;
overrideLocalDefault(key: string, newDefault: any): void;
// Warning: (ae-forgotten-export) The symbol "UiSettingsClientParams" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly params: UiSettingsClientParams;
remove(key: string): Promise<boolean>;
@ -330,11 +346,19 @@ export type UiSettingsSetup = UiSettingsClient;
// @public (undocumented)
export interface UiSettingsState {
// Warning: (ae-forgotten-export) The symbol "InjectedUiSettingsDefault" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "InjectedUiSettingsUser" needs to be exported by the entry point index.d.ts
//
// (undocumented)
[key: string]: InjectedUiSettingsDefault & InjectedUiSettingsUser;
}
// Warnings were encountered during analysis:
//
// src/core/public/injected_metadata/injected_metadata_service.ts:38:7 - (ae-forgotten-export) The symbol "PluginName" needs to be exported by the entry point index.d.ts
// src/core/public/injected_metadata/injected_metadata_service.ts:39:7 - (ae-forgotten-export) The symbol "DiscoveredPlugin" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)
```

53
src/core/server/server.api.md
View file

@ -20,6 +20,9 @@ import { TypeOf } from '@kbn/config-schema';
// @public (undocumented)
export type APICaller = (endpoint: string, clientParams: Record<string, unknown>, options?: CallAPIOptions) => Promise<unknown>;
// Warning: (ae-forgotten-export) The symbol "SessionStorage" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "AuthResult" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type AuthenticationHandler<T> = (request: Request, sessionStorage: SessionStorage<T>, t: AuthToolkit) => Promise<AuthResult>;
@ -32,6 +35,8 @@ export interface AuthToolkit {
}) => AuthResult;
}
// Warning: (ae-forgotten-export) The symbol "BootstrapArgs" needs to be exported by the entry point index.d.ts
//
// @internal (undocumented)
export function bootstrap({ configs, cliArgs, applyConfigOverrides, features, }: BootstrapArgs): Promise<void>;
@ -52,7 +57,11 @@ export class ClusterClient {
// @public (undocumented)
export class ConfigService {
// Warning: (ae-forgotten-export) The symbol "Config" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "Env" needs to be exported by the entry point index.d.ts
constructor(config$: Observable<Config>, env: Env, logger: LoggerFactory);
// Warning: (ae-forgotten-export) The symbol "ConfigPath" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ConfigWithSchema" needs to be exported by the entry point index.d.ts
atPath<TSchema extends Type<any>, TConfig>(path: ConfigPath, ConfigClass: ConfigWithSchema<TSchema, TConfig>): Observable<TConfig>;
getConfig$(): Observable<Config>;
// (undocumented)
@ -70,14 +79,22 @@ export interface CoreSetup {
elasticsearch: ElasticsearchServiceSetup;
// (undocumented)
http: HttpServiceSetup;
// Warning: (ae-incompatible-release-tags) The symbol "plugins" is marked as @public, but its signature references "PluginsServiceSetup" which is marked as @internal
//
// (undocumented)
plugins: PluginsServiceSetup;
}
// Warning: (ae-missing-release-tag) "CoreStart" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface CoreStart {
// (undocumented)
http: HttpServiceStart;
// Warning: (ae-incompatible-release-tags) The symbol "plugins" is marked as @public, but its signature references "PluginsServiceStart" which is marked as @internal
//
// (undocumented)
plugins: PluginsServiceStart;
}
// @internal
@ -88,6 +105,8 @@ export interface DiscoveredPlugin {
readonly requiredPlugins: ReadonlyArray<PluginName>;
}
// Warning: (ae-forgotten-export) The symbol "ElasticsearchConfig" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type ElasticsearchClientConfig = Pick<ConfigOptions, 'keepAlive' | 'log' | 'plugins'> & Pick<ElasticsearchConfig, 'apiVersion' | 'customHeaders' | 'logQueries' | 'requestHeadersWhitelist' | 'sniffOnStart' | 'sniffOnConnectionFault' | 'hosts' | 'username' | 'password'> & {
pingTimeout?: ElasticsearchConfig['pingTimeout'] | ConfigOptions['pingTimeout'];
@ -113,6 +132,8 @@ export interface ElasticsearchServiceSetup {
// @public (undocumented)
export type Headers = Record<string, string | string[] | undefined>;
// Warning: (ae-forgotten-export) The symbol "HttpServerSetup" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type HttpServiceSetup = HttpServerSetup;
@ -126,6 +147,7 @@ export class KibanaRequest<Params, Query, Body> {
constructor(req: Request, params: Params, query: Query, body: Body);
// (undocumented)
readonly body: Body;
// Warning: (ae-forgotten-export) The symbol "RouteSchemas" needs to be exported by the entry point index.d.ts
static from<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(req: Request, routeSchemas: RouteSchemas<P, Q, B> | undefined): KibanaRequest<P["type"], Q["type"], B["type"]>;
// (undocumented)
getFilteredHeaders(headersToKeep: string[]): Pick<Record<string, string | string[] | undefined>, string>;
@ -167,6 +189,8 @@ export class LogLevel {
// (undocumented)
static readonly Fatal: LogLevel;
static fromId(level: LogLevelId): LogLevel;
// Warning: (ae-forgotten-export) The symbol "LogLevelId" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly id: LogLevelId;
// (undocumented)
@ -206,6 +230,8 @@ export interface LogRecord {
timestamp: Date;
}
// Warning: (ae-forgotten-export) The symbol "OnRequestResult" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type OnRequestHandler<Params = any, Query = any, Body = any> = (req: KibanaRequest<Params, Query, Body>, t: OnRequestToolkit) => OnRequestResult | Promise<OnRequestResult>;
@ -219,15 +245,17 @@ export interface OnRequestToolkit {
}
// @public
export interface Plugin<TSetup, TPluginsSetup extends Record<PluginName, unknown> = {}> {
export interface Plugin<TSetup, TStart, TPluginsSetup extends Record<PluginName, unknown> = {}, TPluginsStart extends Record<PluginName, unknown> = {}> {
// (undocumented)
setup: (pluginSetupContext: PluginSetupContext, plugins: TPluginsSetup) => TSetup | Promise<TSetup>;
setup: (core: PluginSetupContext, plugins: TPluginsSetup) => TSetup | Promise<TSetup>;
// (undocumented)
start: (core: PluginStartContext, plugins: TPluginsStart) => TStart | Promise<TStart>;
// (undocumented)
stop?: () => void;
}
// @public
export type PluginInitializer<TSetup, TPluginsSetup extends Record<PluginName, unknown> = {}> = (coreContext: PluginInitializerContext) => Plugin<TSetup, TPluginsSetup>;
export type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<PluginName, unknown> = {}, TPluginsStart extends Record<PluginName, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
// @public
export interface PluginInitializerContext {
@ -272,16 +300,30 @@ export interface PluginsServiceSetup {
};
}
// @internal (undocumented)
export interface PluginsServiceStart {
// (undocumented)
contracts: Map<PluginName, unknown>;
}
// @public
export interface PluginStartContext {
}
// @public (undocumented)
export class Router {
constructor(path: string);
delete<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>): void;
// Warning: (ae-forgotten-export) The symbol "RouteConfig" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "RequestHandler" needs to be exported by the entry point index.d.ts
get<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>): void;
getRoutes(): Readonly<RouterRoute>[];
// (undocumented)
readonly path: string;
post<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>): void;
put<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>): void;
// Warning: (ae-forgotten-export) The symbol "RouterRoute" needs to be exported by the entry point index.d.ts
//
// (undocumented)
routes: Array<Readonly<RouterRoute>>;
}
@ -294,6 +336,11 @@ export class ScopedClusterClient {
}
// Warnings were encountered during analysis:
//
// src/core/server/plugins/plugin_context.ts:36:10 - (ae-forgotten-export) The symbol "EnvironmentMode" needs to be exported by the entry point index.d.ts
// src/core/server/plugins/plugins_service.ts:37:5 - (ae-forgotten-export) The symbol "DiscoveredPluginInternal" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)
```

11
src/dev/run_check_core_api_changes.ts
View file

@ -57,6 +57,7 @@ const apiExtractorConfig = (folder: string): ExtractorConfig => {
extractorMessageReporting: {
default: {
logLevel: 'warning' as ExtractorLogLevel.Warning,
addToApiReportFile: true,
},
'ae-internal-missing-underscore': {
logLevel: 'none' as ExtractorLogLevel.None,
@ -103,7 +104,7 @@ const runApiExtractor = (
const config = apiExtractorConfig(folder);
const options = {
// Indicates that API Extractor is running as part of a local build,
// e.g. on developer's machine. For example, if the *.api.ts output file
// e.g. on developer's machine. For example, if the *.api.md output file
// has differences, it will be automatically overwritten for a
// local build, whereas this should report an error for a production build.
localBuild: acceptChanges,
@ -123,7 +124,7 @@ const runApiExtractor = (
// ConsoleMessageId.ApiReportCopied
log.warning(`You have changed the signature of the ${folder} Core API`);
log.warning(
"Please commit the updated API documentation and the review file in '" +
"Please commit the updated API documentation and the API review file: '" +
config.reportFilePath
);
message.handled = true;
@ -220,8 +221,10 @@ async function run(folder: string): Promise<boolean> {
log.info(`Core ${folder} API: updated documentation ✔`);
}
// If any errors or warnings occured, exit with an error
return succeeded;
// If the api signature changed or any errors or warnings occured, exit with an error
// NOTE: Because of https://github.com/Microsoft/web-build-tools/issues/1258
// api-extractor will not return `succeeded: false` when the API changes.
return !apiReportChanged && succeeded;
}
(async () => {

19
yarn.lock
View file

@ -1755,12 +1755,21 @@
"@microsoft/tsdoc" "0.12.8"
"@types/node" "8.5.8"
"@microsoft/api-extractor@7.0.41":
version "7.0.41"
resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.0.41.tgz#26931b0cc4ecb38dfbc71ec04318cc71dabfbd44"
integrity sha512-dO3qyQKKgKhZVDA6lJkyTBeV6qa6vbhES3I0dTJEtg6FA/UsLjvidgBbeRwlNIq4u+38xbhq+L7Qb6O7teVQDw==
"@microsoft/api-extractor-model@7.1.0":
version "7.1.0"
resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.1.0.tgz#57e9805ba0f2322dd12945bb0588eeda522519cd"
integrity sha512-DvaJ1fEpwega9TVMR4xR0jeNV/9JHNMxN/t8TuBftZHSLZzTczh8HyqyFxKo2IwDDCoZy5FmXZsq/vo5JQvRMQ==
dependencies:
"@microsoft/api-extractor-model" "7.0.28"
"@microsoft/node-core-library" "3.13.0"
"@microsoft/tsdoc" "0.12.9"
"@types/node" "8.5.8"
"@microsoft/api-extractor@7.1.1":
version "7.1.1"
resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.1.1.tgz#b3a92be9fc813112ee0ea43f3ad8033730ff9fd7"
integrity sha512-U5gFHDxjyNBjpO+tXD87atxSVkwpgIw27c5vNvmn4z5CTk783fH1Gz4BEYdZecKHkb5xpuNBTOmEdulpBD5vyQ==
dependencies:
"@microsoft/api-extractor-model" "7.1.0"
"@microsoft/node-core-library" "3.13.0"
"@microsoft/ts-command-line" "4.2.3"
"@microsoft/tsdoc" "0.12.9"