Move Nav APIs to new platform

docs/development/core/public/kibana-plugin-public.chromenavlink.active.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [active](./kibana-plugin-public.chromenavlink.active.md)
+
+## ChromeNavLink.active property
+
+Indicates whether or not this app is currently on the screen.
+
+NOTE: remove this when ApplicationService is implemented and managing apps.
+
+<b>Signature:</b>
+
+```typescript
+readonly active?: boolean;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.baseurl.md

@@ -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; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [baseUrl](./kibana-plugin-public.chromenavlink.baseurl.md)
+
+## ChromeNavLink.baseUrl property
+
+The base route used to open the root of an application.
+
+<b>Signature:</b>
+
+```typescript
+readonly baseUrl: string;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.disabled.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [disabled](./kibana-plugin-public.chromenavlink.disabled.md)
+
+## ChromeNavLink.disabled property
+
+Disables a link from being clickable.
+
+NOTE: this is only used by the ML and Graph plugins currently. They use this field to disable the nav link when the license is expired.
+
+<b>Signature:</b>
+
+```typescript
+readonly disabled?: boolean;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.euiicontype.md

@@ -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; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [euiIconType](./kibana-plugin-public.chromenavlink.euiicontype.md)
+
+## ChromeNavLink.euiIconType property
+
+A EUI iconType that will be used for the app's icon. This icon takes precendence over the `icon` property.
+
+<b>Signature:</b>
+
+```typescript
+readonly euiIconType?: string;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.hidden.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [hidden](./kibana-plugin-public.chromenavlink.hidden.md)
+
+## ChromeNavLink.hidden property
+
+Hides a link from the navigation.
+
+NOTE: remove this when ApplicationService is implemented. Instead, plugins should only register an Application if needed.
+
+<b>Signature:</b>
+
+```typescript
+readonly hidden?: boolean;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.icon.md

@@ -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; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [icon](./kibana-plugin-public.chromenavlink.icon.md)
+
+## ChromeNavLink.icon property
+
+A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided.
+
+<b>Signature:</b>
+
+```typescript
+readonly icon?: string;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.id.md

@@ -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; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [id](./kibana-plugin-public.chromenavlink.id.md)
+
+## ChromeNavLink.id property
+
+A unique identifier for looking up links.
+
+<b>Signature:</b>
+
+```typescript
+readonly id: string;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.linktolastsuburl.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [linkToLastSubUrl](./kibana-plugin-public.chromenavlink.linktolastsuburl.md)
+
+## ChromeNavLink.linkToLastSubUrl property
+
+Whether or not the subUrl feature should be enabled.
+
+NOTE: only read by legacy platform.
+
+<b>Signature:</b>
+
+```typescript
+readonly linkToLastSubUrl?: boolean;
+```

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

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md)
+
+## ChromeNavLink interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface ChromeNavLink 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [active](./kibana-plugin-public.chromenavlink.active.md) | <code>boolean</code> | Indicates whether or not this app is currently on the screen.<!-- -->NOTE: remove this when ApplicationService is implemented and managing apps. |
+|  [baseUrl](./kibana-plugin-public.chromenavlink.baseurl.md) | <code>string</code> | The base route used to open the root of an application. |
+|  [disabled](./kibana-plugin-public.chromenavlink.disabled.md) | <code>boolean</code> | Disables a link from being clickable.<!-- -->NOTE: this is only used by the ML and Graph plugins currently. They use this field to disable the nav link when the license is expired. |
+|  [euiIconType](./kibana-plugin-public.chromenavlink.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precendence over the <code>icon</code> property. |
+|  [hidden](./kibana-plugin-public.chromenavlink.hidden.md) | <code>boolean</code> | Hides a link from the navigation.<!-- -->NOTE: remove this when ApplicationService is implemented. Instead, plugins should only register an Application if needed. |
+|  [icon](./kibana-plugin-public.chromenavlink.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
+|  [id](./kibana-plugin-public.chromenavlink.id.md) | <code>string</code> | A unique identifier for looking up links. |
+|  [linkToLastSubUrl](./kibana-plugin-public.chromenavlink.linktolastsuburl.md) | <code>boolean</code> | Whether or not the subUrl feature should be enabled.<!-- -->NOTE: only read by legacy platform. |
+|  [order](./kibana-plugin-public.chromenavlink.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
+|  [subUrlBase](./kibana-plugin-public.chromenavlink.suburlbase.md) | <code>string</code> | A url base that legacy apps can set to match deep URLs to an applcation.<!-- -->NOTE: this should be removed once legacy apps are gone. |
+|  [title](./kibana-plugin-public.chromenavlink.title.md) | <code>string</code> | The title of the application. |
+|  [tooltip](./kibana-plugin-public.chromenavlink.tooltip.md) | <code>string</code> | A tooltip shown when hovering over an app link. |
+|  [url](./kibana-plugin-public.chromenavlink.url.md) | <code>string</code> | A url that legacy apps can set to deep link into their applications.<!-- -->NOTE: Currently used by the "lastSubUrl" feature legacy/ui/chrome. This should be removed once the ApplicationService is implemented and mounting apps. At that time, each app can handle opening to the previous location when they are mounted. |
+

docs/development/core/public/kibana-plugin-public.chromenavlink.order.md

@@ -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; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [order](./kibana-plugin-public.chromenavlink.order.md)
+
+## ChromeNavLink.order property
+
+An ordinal used to sort nav links relative to one another for display.
+
+<b>Signature:</b>
+
+```typescript
+readonly order: number;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.suburlbase.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [subUrlBase](./kibana-plugin-public.chromenavlink.suburlbase.md)
+
+## ChromeNavLink.subUrlBase property
+
+A url base that legacy apps can set to match deep URLs to an applcation.
+
+NOTE: this should be removed once legacy apps are gone.
+
+<b>Signature:</b>
+
+```typescript
+readonly subUrlBase?: string;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.title.md

@@ -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; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [title](./kibana-plugin-public.chromenavlink.title.md)
+
+## ChromeNavLink.title property
+
+The title of the application.
+
+<b>Signature:</b>
+
+```typescript
+readonly title: string;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.tooltip.md

@@ -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; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [tooltip](./kibana-plugin-public.chromenavlink.tooltip.md)
+
+## ChromeNavLink.tooltip property
+
+A tooltip shown when hovering over an app link.
+
+<b>Signature:</b>
+
+```typescript
+readonly tooltip?: string;
+```

docs/development/core/public/kibana-plugin-public.chromenavlink.url.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) &gt; [url](./kibana-plugin-public.chromenavlink.url.md)
+
+## ChromeNavLink.url property
+
+A url that legacy apps can set to deep link into their applications.
+
+NOTE: Currently used by the "lastSubUrl" feature legacy/ui/chrome. This should be removed once the ApplicationService is implemented and mounting apps. At that time, each app can handle opening to the previous location when they are mounted.
+
+<b>Signature:</b>
+
+```typescript
+readonly url?: string;
+```

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

@@ -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; [ChromeStart](./kibana-plugin-public.chromestart.md)
+
+## ChromeStart type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type ChromeStart = ReturnType<ChromeService['start']>;
+```

docs/development/core/public/kibana-plugin-public.corestart.chrome.md

@@ -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; [chrome](./kibana-plugin-public.corestart.chrome.md)
+
+## CoreStart.chrome property
+
+[ChromeStart](./kibana-plugin-public.chromestart.md)
+
+<b>Signature:</b>
+
+```typescript
+chrome: ChromeStart;
+```

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

@@ -18,6 +18,7 @@ export interface CoreStart
 |  --- | --- | --- |
 |  [application](./kibana-plugin-public.corestart.application.md) | <code>ApplicationStart</code> | [ApplicationStart](./kibana-plugin-public.applicationstart.md) |
 |  [basePath](./kibana-plugin-public.corestart.basepath.md) | <code>BasePathStart</code> | [BasePathStart](./kibana-plugin-public.basepathstart.md) |
+|  [chrome](./kibana-plugin-public.corestart.chrome.md) | <code>ChromeStart</code> | [ChromeStart](./kibana-plugin-public.chromestart.md) |
 |  [http](./kibana-plugin-public.corestart.http.md) | <code>HttpStart</code> | [HttpStart](./kibana-plugin-public.httpstart.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) |

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

@@ -22,6 +22,7 @@
 |  [ChromeBadge](./kibana-plugin-public.chromebadge.md) |  |
 |  [ChromeBrand](./kibana-plugin-public.chromebrand.md) |  |
 |  [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) |  |
+|  [ChromeNavLink](./kibana-plugin-public.chromenavlink.md) |  |
 |  [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the setup lifecycle |
 |  [CoreStart](./kibana-plugin-public.corestart.md) | Core services exposed to the start lifecycle |
 |  [FatalErrorInfo](./kibana-plugin-public.fatalerrorinfo.md) | Represents the <code>message</code> and <code>stack</code> of a fatal Error |
@@ -45,6 +46,7 @@
 |  [BasePathStart](./kibana-plugin-public.basepathstart.md) | Provides access to the 'server.basePath' configuration option in kibana.yml |
 |  [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) |  |
 |  [ChromeSetup](./kibana-plugin-public.chromesetup.md) |  |
+|  [ChromeStart](./kibana-plugin-public.chromestart.md) |  |
 |  [HttpSetup](./kibana-plugin-public.httpsetup.md) |  |
 |  [HttpStart](./kibana-plugin-public.httpstart.md) |  |
 |  [I18nStart](./kibana-plugin-public.i18nstart.md) |  |

docs/development/core/public/kibana-plugin-public.pluginstartcontext.chrome.md

@@ -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; [PluginStartContext](./kibana-plugin-public.pluginstartcontext.md) &gt; [chrome](./kibana-plugin-public.pluginstartcontext.chrome.md)
+
+## PluginStartContext.chrome property
+
+<b>Signature:</b>
+
+```typescript
+chrome: ChromeStart;
+```

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

@@ -18,6 +18,7 @@ export interface PluginStartContext
 |  --- | --- | --- |
 |  [application](./kibana-plugin-public.pluginstartcontext.application.md) | <code>Pick&lt;ApplicationStart, 'capabilities'&gt;</code> |  |
 |  [basePath](./kibana-plugin-public.pluginstartcontext.basepath.md) | <code>BasePathStart</code> |  |
+|  [chrome](./kibana-plugin-public.pluginstartcontext.chrome.md) | <code>ChromeStart</code> |  |
 |  [http](./kibana-plugin-public.pluginstartcontext.http.md) | <code>HttpStart</code> |  |
 |  [i18n](./kibana-plugin-public.pluginstartcontext.i18n.md) | <code>I18nStart</code> |  |
 |  [notifications](./kibana-plugin-public.pluginstartcontext.notifications.md) | <code>NotificationsStart</code> |  |

docs/development/core/server/kibana-plugin-server.configservice.atpath.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [atPath](./kibana-plugin-server.configservice.atpath.md)
+
+## ConfigService.atPath() method
+
+Reads the subset of the config at the specified `path` and validates it against the static `schema` on the given `ConfigClass`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+atPath<TSchema extends Type<any>, TConfig>(path: ConfigPath, ConfigClass: ConfigWithSchema<TSchema, TConfig>): Observable<TConfig>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  path | <code>ConfigPath</code> | The path to the desired subset of the config. |
+|  ConfigClass | <code>ConfigWithSchema&lt;TSchema, TConfig&gt;</code> | A class (not an instance of a class) that contains a static <code>schema</code> that we validate the config at the given <code>path</code> against. |
+
+<b>Returns:</b>
+
+`Observable<TConfig>`
+

docs/development/core/server/kibana-plugin-server.configservice.getconfig$.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [getConfig$](./kibana-plugin-server.configservice.getconfig$.md)
+
+## ConfigService.getConfig$() method
+
+Returns the full config object observable. This is not intended for "normal use", but for features that \_need\_ access to the full object.
+
+<b>Signature:</b>
+
+```typescript
+getConfig$(): Observable<Config>;
+```
+<b>Returns:</b>
+
+`Observable<Config>`
+

docs/development/core/server/kibana-plugin-server.configservice.getunusedpaths.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [getUnusedPaths](./kibana-plugin-server.configservice.getunusedpaths.md)
+
+## ConfigService.getUnusedPaths() method
+
+<b>Signature:</b>
+
+```typescript
+getUnusedPaths(): Promise<string[]>;
+```
+<b>Returns:</b>
+
+`Promise<string[]>`
+

docs/development/core/server/kibana-plugin-server.configservice.getusedpaths.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [getUsedPaths](./kibana-plugin-server.configservice.getusedpaths.md)
+
+## ConfigService.getUsedPaths() method
+
+<b>Signature:</b>
+
+```typescript
+getUsedPaths(): Promise<string[]>;
+```
+<b>Returns:</b>
+
+`Promise<string[]>`
+

docs/development/core/server/kibana-plugin-server.configservice.isenabledatpath.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [isEnabledAtPath](./kibana-plugin-server.configservice.isenabledatpath.md)
+
+## ConfigService.isEnabledAtPath() method
+
+<b>Signature:</b>
+
+```typescript
+isEnabledAtPath(path: ConfigPath): Promise<boolean>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  path | <code>ConfigPath</code> |  |
+
+<b>Returns:</b>
+
+`Promise<boolean>`
+