Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into feature-integ…
Browse files Browse the repository at this point in the history
…rations-manager
  • Loading branch information
John Schulz committed Oct 15, 2019
2 parents b308d0c + d7b9400 commit 133495f
Show file tree
Hide file tree
Showing 673 changed files with 16,273 additions and 9,631 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ module.exports = {
'src/core/server/**/*',
'!src/core/server/index.ts',
'!src/core/server/mocks.ts',
'!src/core/server/types.ts',
'!src/core/server/*.test.mocks.ts',

'src/plugins/**/public/**/*',
Expand Down
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,8 @@ IntelliJ | Settings » Languages & Frameworks » JavaScript » Code Quality To

Another tool we use for enforcing consistent coding style is EditorConfig, which can be set up by installing a plugin in your editor that dynamically updates its configuration. Take a look at the [EditorConfig](http://editorconfig.org/#download) site to find a plugin for your editor, and browse our [`.editorconfig`](https://github.com/elastic/kibana/blob/master/.editorconfig) file to see what config rules we set up.

#### Setup Guide for VS Code Users

Note that for VSCode, to enable "live" linting of TypeScript (and other) file types, you will need to modify your local settings, as shown below. The default for the ESLint extension is to only lint JavaScript file types.

```json
Expand All @@ -317,6 +319,14 @@ Note that for VSCode, to enable "live" linting of TypeScript (and other) file ty
]
```

`eslint` can automatically fix trivial lint errors when you save a file by adding this line in your setting.

```json
"eslint.autoFixOnSave": true,
```

It is **not** recommended to use `prettier` plugin on Kibana project. Because settings are in `eslintrc.js` file and it is applied to too many files that shouldn't be prettier-ized.

### Internationalization

All user-facing labels and info texts in Kibana should be internationalized. Please take a look at the [readme](packages/kbn-i18n/README.md) and the [guideline](packages/kbn-i18n/GUIDELINE.md) of the i18n package on how to do so.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md) &gt; [dev](./kibana-plugin-public.environmentmode.dev.md)

## EnvironmentMode.dev property

<b>Signature:</b>

```typescript
dev: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md)

## EnvironmentMode interface


<b>Signature:</b>

```typescript
export interface EnvironmentMode
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [dev](./kibana-plugin-public.environmentmode.dev.md) | <code>boolean</code> | |
| [name](./kibana-plugin-public.environmentmode.name.md) | <code>'development' &#124; 'production'</code> | |
| [prod](./kibana-plugin-public.environmentmode.prod.md) | <code>boolean</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md) &gt; [name](./kibana-plugin-public.environmentmode.name.md)

## EnvironmentMode.name property

<b>Signature:</b>

```typescript
name: 'development' | 'production';
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [EnvironmentMode](./kibana-plugin-public.environmentmode.md) &gt; [prod](./kibana-plugin-public.environmentmode.prod.md)

## EnvironmentMode.prod property

<b>Signature:</b>

```typescript
prod: boolean;
```
2 changes: 2 additions & 0 deletions docs/development/core/public/kibana-plugin-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the <code>Plugin</code> setup lifecycle |
| [CoreStart](./kibana-plugin-public.corestart.md) | Core services exposed to the <code>Plugin</code> start lifecycle |
| [DocLinksStart](./kibana-plugin-public.doclinksstart.md) | |
| [EnvironmentMode](./kibana-plugin-public.environmentmode.md) | |
| [ErrorToastOptions](./kibana-plugin-public.errortoastoptions.md) | |
| [FatalErrorInfo](./kibana-plugin-public.fatalerrorinfo.md) | Represents the <code>message</code> and <code>stack</code> of a fatal Error |
| [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. |
Expand All @@ -68,6 +69,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) | |
| [OverlayRef](./kibana-plugin-public.overlayref.md) | |
| [OverlayStart](./kibana-plugin-public.overlaystart.md) | |
| [PackageInfo](./kibana-plugin-public.packageinfo.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> |
| [SavedObject](./kibana-plugin-public.savedobject.md) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [branch](./kibana-plugin-public.packageinfo.branch.md)

## PackageInfo.branch property

<b>Signature:</b>

```typescript
branch: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [buildNum](./kibana-plugin-public.packageinfo.buildnum.md)

## PackageInfo.buildNum property

<b>Signature:</b>

```typescript
buildNum: number;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [buildSha](./kibana-plugin-public.packageinfo.buildsha.md)

## PackageInfo.buildSha property

<b>Signature:</b>

```typescript
buildSha: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [dist](./kibana-plugin-public.packageinfo.dist.md)

## PackageInfo.dist property

<b>Signature:</b>

```typescript
dist: boolean;
```
23 changes: 23 additions & 0 deletions docs/development/core/public/kibana-plugin-public.packageinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md)

## PackageInfo interface


<b>Signature:</b>

```typescript
export interface PackageInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [branch](./kibana-plugin-public.packageinfo.branch.md) | <code>string</code> | |
| [buildNum](./kibana-plugin-public.packageinfo.buildnum.md) | <code>number</code> | |
| [buildSha](./kibana-plugin-public.packageinfo.buildsha.md) | <code>string</code> | |
| [dist](./kibana-plugin-public.packageinfo.dist.md) | <code>boolean</code> | |
| [version](./kibana-plugin-public.packageinfo.version.md) | <code>string</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PackageInfo](./kibana-plugin-public.packageinfo.md) &gt; [version](./kibana-plugin-public.packageinfo.version.md)

## PackageInfo.version property

<b>Signature:</b>

```typescript
version: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md) &gt; [env](./kibana-plugin-public.plugininitializercontext.env.md)

## PluginInitializerContext.env property

<b>Signature:</b>

```typescript
readonly env: {
mode: Readonly<EnvironmentMode>;
packageInfo: Readonly<PackageInfo>;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ export interface PluginInitializerContext

| Property | Type | Description |
| --- | --- | --- |
| [env](./kibana-plugin-public.plugininitializercontext.env.md) | <code>{</code><br/><code> mode: Readonly&lt;EnvironmentMode&gt;;</code><br/><code> packageInfo: Readonly&lt;PackageInfo&gt;;</code><br/><code> }</code> | |
| [opaqueId](./kibana-plugin-public.plugininitializercontext.opaqueid.md) | <code>PluginOpaqueId</code> | A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md) &gt; [dev](./kibana-plugin-server.environmentmode.dev.md)

## EnvironmentMode.dev property

<b>Signature:</b>

```typescript
dev: boolean;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md)

## EnvironmentMode interface


<b>Signature:</b>

```typescript
export interface EnvironmentMode
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [dev](./kibana-plugin-server.environmentmode.dev.md) | <code>boolean</code> | |
| [name](./kibana-plugin-server.environmentmode.name.md) | <code>'development' &#124; 'production'</code> | |
| [prod](./kibana-plugin-server.environmentmode.prod.md) | <code>boolean</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md) &gt; [name](./kibana-plugin-server.environmentmode.name.md)

## EnvironmentMode.name property

<b>Signature:</b>

```typescript
name: 'development' | 'production';
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [EnvironmentMode](./kibana-plugin-server.environmentmode.md) &gt; [prod](./kibana-plugin-server.environmentmode.prod.md)

## EnvironmentMode.prod property

<b>Signature:</b>

```typescript
prod: boolean;
```
2 changes: 2 additions & 0 deletions docs/development/core/server/kibana-plugin-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [DiscoveredPlugin](./kibana-plugin-server.discoveredplugin.md) | Small container object used to expose information about discovered plugins that may or may not have been started. |
| [ElasticsearchError](./kibana-plugin-server.elasticsearcherror.md) | |
| [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) | |
| [EnvironmentMode](./kibana-plugin-server.environmentmode.md) | |
| [ErrorHttpResponseOptions](./kibana-plugin-server.errorhttpresponseoptions.md) | HTTP response parameters |
| [FakeRequest](./kibana-plugin-server.fakerequest.md) | Fake request object created manually by Kibana plugins. |
| [HttpResponseOptions](./kibana-plugin-server.httpresponseoptions.md) | HTTP response parameters |
Expand All @@ -67,6 +68,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [LogMeta](./kibana-plugin-server.logmeta.md) | Contextual metadata |
| [OnPostAuthToolkit](./kibana-plugin-server.onpostauthtoolkit.md) | A tool set defining an outcome of OnPostAuth interceptor for incoming request. |
| [OnPreAuthToolkit](./kibana-plugin-server.onpreauthtoolkit.md) | A tool set defining an outcome of OnPreAuth interceptor for incoming request. |
| [PackageInfo](./kibana-plugin-server.packageinfo.md) | |
| [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. |
| [PluginManifest](./kibana-plugin-server.pluginmanifest.md) | Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [branch](./kibana-plugin-server.packageinfo.branch.md)

## PackageInfo.branch property

<b>Signature:</b>

```typescript
branch: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [buildNum](./kibana-plugin-server.packageinfo.buildnum.md)

## PackageInfo.buildNum property

<b>Signature:</b>

```typescript
buildNum: number;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [buildSha](./kibana-plugin-server.packageinfo.buildsha.md)

## PackageInfo.buildSha property

<b>Signature:</b>

```typescript
buildSha: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [dist](./kibana-plugin-server.packageinfo.dist.md)

## PackageInfo.dist property

<b>Signature:</b>

```typescript
dist: boolean;
```
23 changes: 23 additions & 0 deletions docs/development/core/server/kibana-plugin-server.packageinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md)

## PackageInfo interface


<b>Signature:</b>

```typescript
export interface PackageInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [branch](./kibana-plugin-server.packageinfo.branch.md) | <code>string</code> | |
| [buildNum](./kibana-plugin-server.packageinfo.buildnum.md) | <code>number</code> | |
| [buildSha](./kibana-plugin-server.packageinfo.buildsha.md) | <code>string</code> | |
| [dist](./kibana-plugin-server.packageinfo.dist.md) | <code>boolean</code> | |
| [version](./kibana-plugin-server.packageinfo.version.md) | <code>string</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [PackageInfo](./kibana-plugin-server.packageinfo.md) &gt; [version](./kibana-plugin-server.packageinfo.version.md)

## PackageInfo.version property

<b>Signature:</b>

```typescript
version: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@
```typescript
env: {
mode: EnvironmentMode;
packageInfo: Readonly<PackageInfo>;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface PluginInitializerContext<ConfigSchema = unknown>
| Property | Type | Description |
| --- | --- | --- |
| [config](./kibana-plugin-server.plugininitializercontext.config.md) | <code>{</code><br/><code> create: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T&gt;;</code><br/><code> createIfExists: &lt;T = ConfigSchema&gt;() =&gt; Observable&lt;T &#124; undefined&gt;;</code><br/><code> }</code> | |
| [env](./kibana-plugin-server.plugininitializercontext.env.md) | <code>{</code><br/><code> mode: EnvironmentMode;</code><br/><code> }</code> | |
| [env](./kibana-plugin-server.plugininitializercontext.env.md) | <code>{</code><br/><code> mode: EnvironmentMode;</code><br/><code> packageInfo: Readonly&lt;PackageInfo&gt;;</code><br/><code> }</code> | |
| [logger](./kibana-plugin-server.plugininitializercontext.logger.md) | <code>LoggerFactory</code> | |
| [opaqueId](./kibana-plugin-server.plugininitializercontext.opaqueid.md) | <code>PluginOpaqueId</code> | |

Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ export interface RouteConfig<P extends ObjectType, Q extends ObjectType, B exten
| --- | --- | --- |
| [options](./kibana-plugin-server.routeconfig.options.md) | <code>RouteConfigOptions</code> | Additional route options [RouteConfigOptions](./kibana-plugin-server.routeconfigoptions.md)<!-- -->. |
| [path](./kibana-plugin-server.routeconfig.path.md) | <code>string</code> | The endpoint \_within\_ the router path to register the route. E.g. if the router is registered at <code>/elasticsearch</code> and the route path is <code>/search</code>, the full path for the route is <code>/elasticsearch/search</code>. Supports: - named path segments <code>path/{name}</code>. - optional path segments <code>path/{position?}</code>. - multi-segments <code>path/{coordinates*2}</code>. Segments are accessible within a handler function as <code>params</code> property of [KibanaRequest](./kibana-plugin-server.kibanarequest.md) object. To have read access to <code>params</code> you \*must\* specify validation schema with [RouteConfig.validate](./kibana-plugin-server.routeconfig.validate.md)<!-- -->. |
| [validate](./kibana-plugin-server.routeconfig.validate.md) | <code>RouteSchemas&lt;P, Q, B&gt; &#124; false</code> | A schema created with <code>@kbn/config-schema</code> that every request will be validated against. You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify <code>false</code>. |
| [validate](./kibana-plugin-server.routeconfig.validate.md) | <code>RouteSchemas&lt;P, Q, B&gt; &#124; false</code> | A schema created with <code>@kbn/config-schema</code> that every request will be validated against. You \*must\* specify a validation schema to be able to read: - url path segments - request query - request body To opt out of validating the request, specify <code>validate: false</code>. In this case request params, query, and body will be \*\*empty\*\* objects and have no access to raw values. In some cases you may want to use another validation library. To do this, you need to instruct the <code>@kbn/config-schema</code> library to output \*\*non-validated values\*\* with setting schema as <code>schema.object({}, { allowUnknowns: true })</code>; |

Loading

0 comments on commit 133495f

Please sign in to comment.