update generated doc

elastic · Oct 28, 2019 · 6840ed2 · 6840ed2
1 parent 1fbd21e
commit 6840ed2
Show file tree

Hide file tree

Showing 17 changed files with 78 additions and 26 deletions.
diff --git a/docs/development/core/public/kibana-plugin-public.ianonymouspaths.isanonymous.md b/docs/development/core/public/kibana-plugin-public.ianonymouspaths.isanonymous.md
@@ -4,7 +4,7 @@
 
 ## IAnonymousPaths.isAnonymous() method
 
-Determines whether the provided path doesn't require authentication
+Determines whether the provided path doesn't require authentication. `path` should include the current basePath.
 
 <b>Signature:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.ianonymouspaths.md b/docs/development/core/public/kibana-plugin-public.ianonymouspaths.md
@@ -16,6 +16,6 @@ export interface IAnonymousPaths
 
 |  Method | Description |
 |  --- | --- |
-|  [isAnonymous(path)](./kibana-plugin-public.ianonymouspaths.isanonymous.md) | Determines whether the provided path doesn't require authentication |
-|  [register(path)](./kibana-plugin-public.ianonymouspaths.register.md) | Register <code>path</code> as not requiring authentication |
+|  [isAnonymous(path)](./kibana-plugin-public.ianonymouspaths.isanonymous.md) | Determines whether the provided path doesn't require authentication. <code>path</code> should include the current basePath. |
+|  [register(path)](./kibana-plugin-public.ianonymouspaths.register.md) | Register <code>path</code> as not requiring authentication. <code>path</code> should not include the current basePath. |
 
diff --git a/docs/development/core/public/kibana-plugin-public.ianonymouspaths.register.md b/docs/development/core/public/kibana-plugin-public.ianonymouspaths.register.md
@@ -4,7 +4,7 @@
 
 ## IAnonymousPaths.register() method
 
-Register `path` as not requiring authentication
+Register `path` as not requiring authentication. `path` should not include the current basePath.
 
 <b>Signature:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.md b/docs/development/core/public/kibana-plugin-public.md
@@ -109,6 +109,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [HttpStart](./kibana-plugin-public.httpstart.md) | See [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) |
 |  [IContextProvider](./kibana-plugin-public.icontextprovider.md) | A function that returns a context value for a specific key of given context type. |
 |  [IToasts](./kibana-plugin-public.itoasts.md) | Methods for adding and removing global toast messages. See [ToastsApi](./kibana-plugin-public.toastsapi.md)<!-- -->. |
+|  [MountPoint](./kibana-plugin-public.mountpoint.md) | A function that will mount the banner inside the provided element. |
 |  [OverlayBannerMount](./kibana-plugin-public.overlaybannermount.md) | A function that will mount the banner inside the provided element. |
 |  [OverlayBannerUnmount](./kibana-plugin-public.overlaybannerunmount.md) | A function that will unmount the banner from the element. |
 |  [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. |
@@ -117,9 +118,11 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [SavedObjectAttribute](./kibana-plugin-public.savedobjectattribute.md) | Type definition for a Saved Object attribute value |
 |  [SavedObjectAttributeSingle](./kibana-plugin-public.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-public.savedobjectattribute.md) |
 |  [SavedObjectsClientContract](./kibana-plugin-public.savedobjectsclientcontract.md) | SavedObjectsClientContract as implemented by the [SavedObjectsClient](./kibana-plugin-public.savedobjectsclient.md) |
+|  [Toast](./kibana-plugin-public.toast.md) |  |
 |  [ToastInput](./kibana-plugin-public.toastinput.md) | Inputs for [IToasts](./kibana-plugin-public.itoasts.md) APIs. |
 |  [ToastInputFields](./kibana-plugin-public.toastinputfields.md) | Allowed fields for [ToastInput](./kibana-plugin-public.toastinput.md)<!-- -->. |
 |  [ToastsSetup](./kibana-plugin-public.toastssetup.md) | [IToasts](./kibana-plugin-public.itoasts.md) |
 |  [ToastsStart](./kibana-plugin-public.toastsstart.md) | [IToasts](./kibana-plugin-public.itoasts.md) |
 |  [UiSettingsClientContract](./kibana-plugin-public.uisettingsclientcontract.md) | [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) |
+|  [UnmountCallback](./kibana-plugin-public.unmountcallback.md) | A function that will unmount the element previously mounted by the associated [MountPoint](./kibana-plugin-public.mountpoint.md) |
 
diff --git a/docs/development/core/public/kibana-plugin-public.mountpoint.md b/docs/development/core/public/kibana-plugin-public.mountpoint.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [MountPoint](./kibana-plugin-public.mountpoint.md)
+
+## MountPoint type
+
+A function that will mount the banner inside the provided element.
+
+<b>Signature:</b>
+
+```typescript
+export declare type MountPoint = (element: HTMLElement) => UnmountCallback;
+```
diff --git a/docs/development/core/public/kibana-plugin-public.toast.md b/docs/development/core/public/kibana-plugin-public.toast.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Toast](./kibana-plugin-public.toast.md)
+
+## Toast type
+
+<b>Signature:</b>
+
+```typescript
+export declare type Toast = ToastInputFields & {
+    id: string;
+};
+```
diff --git a/docs/development/core/public/kibana-plugin-public.toastinput.md b/docs/development/core/public/kibana-plugin-public.toastinput.md
@@ -9,5 +9,5 @@ Inputs for [IToasts](./kibana-plugin-public.itoasts.md) APIs.
 <b>Signature:</b>
 
 ```typescript
-export declare type ToastInput = string | ToastInputFields | Promise<ToastInputFields>;
+export declare type ToastInput = string | ToastInputFields;
 ```
diff --git a/docs/development/core/public/kibana-plugin-public.toastinputfields.md b/docs/development/core/public/kibana-plugin-public.toastinputfields.md
@@ -9,7 +9,10 @@ Allowed fields for [ToastInput](./kibana-plugin-public.toastinput.md)<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-export declare type ToastInputFields = Pick<Toast, Exclude<keyof Toast, 'id'>>;
+export declare type ToastInputFields = Pick<EuiToast, Exclude<keyof EuiToast, 'id' | 'text' | 'title'>> & {
+    title?: string | MountPoint;
+    text?: string | MountPoint;
+};
 ```
 
 ## Remarks

diff --git a/docs/development/core/public/kibana-plugin-public.toastsapi.add.md b/docs/development/core/public/kibana-plugin-public.toastsapi.add.md
@@ -22,5 +22,5 @@ add(toastOrTitle: ToastInput): Toast;
 
 `Toast`
 
-a 
+a [Toast](./kibana-plugin-public.toast.md)
 
diff --git a/docs/development/core/public/kibana-plugin-public.toastsapi.adddanger.md b/docs/development/core/public/kibana-plugin-public.toastsapi.adddanger.md
@@ -22,5 +22,5 @@ addDanger(toastOrTitle: ToastInput): Toast;
 
 `Toast`
 
-a 
+a [Toast](./kibana-plugin-public.toast.md)
 
diff --git a/docs/development/core/public/kibana-plugin-public.toastsapi.adderror.md b/docs/development/core/public/kibana-plugin-public.toastsapi.adderror.md
@@ -23,5 +23,5 @@ addError(error: Error, options: ErrorToastOptions): Toast;
 
 `Toast`
 
-a 
+a [Toast](./kibana-plugin-public.toast.md)
 
diff --git a/docs/development/core/public/kibana-plugin-public.toastsapi.addsuccess.md b/docs/development/core/public/kibana-plugin-public.toastsapi.addsuccess.md
@@ -22,5 +22,5 @@ addSuccess(toastOrTitle: ToastInput): Toast;
 
 `Toast`
 
-a 
+a [Toast](./kibana-plugin-public.toast.md)
 
diff --git a/docs/development/core/public/kibana-plugin-public.toastsapi.addwarning.md b/docs/development/core/public/kibana-plugin-public.toastsapi.addwarning.md
@@ -22,5 +22,5 @@ addWarning(toastOrTitle: ToastInput): Toast;
 
 `Toast`
 
-a 
+a [Toast](./kibana-plugin-public.toast.md)
 
diff --git a/docs/development/core/public/kibana-plugin-public.toastsapi.md b/docs/development/core/public/kibana-plugin-public.toastsapi.md
@@ -28,5 +28,5 @@ export declare class ToastsApi implements IToasts
 |  [addSuccess(toastOrTitle)](./kibana-plugin-public.toastsapi.addsuccess.md) |  | Adds a new toast pre-configured with the success color and check icon. |
 |  [addWarning(toastOrTitle)](./kibana-plugin-public.toastsapi.addwarning.md) |  | Adds a new toast pre-configured with the warning color and help icon. |
 |  [get$()](./kibana-plugin-public.toastsapi.get_.md) |  | Observable of the toast messages to show to the user. |
-|  [remove(toast)](./kibana-plugin-public.toastsapi.remove.md) |  | Removes a toast from the current array of toasts if present. |
+|  [remove(toastOrId)](./kibana-plugin-public.toastsapi.remove.md) |  | Removes a toast from the current array of toasts if present. |
 
diff --git a/docs/development/core/public/kibana-plugin-public.toastsapi.remove.md b/docs/development/core/public/kibana-plugin-public.toastsapi.remove.md
@@ -9,14 +9,14 @@ Removes a toast from the current array of toasts if present.
 <b>Signature:</b>
 
 ```typescript
-remove(toast: Toast): void;
+remove(toastOrId: Toast | string): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  toast | <code>Toast</code> | a  returned by  |
+|  toastOrId | <code>Toast &#124; string</code> | a [Toast](./kibana-plugin-public.toast.md) returned by [ToastsApi.add()](./kibana-plugin-public.toastsapi.add.md) or it's id |
 
 <b>Returns:</b>
 

diff --git a/docs/development/core/public/kibana-plugin-public.unmountcallback.md b/docs/development/core/public/kibana-plugin-public.unmountcallback.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UnmountCallback](./kibana-plugin-public.unmountcallback.md)
+
+## UnmountCallback type
+
+A function that will unmount the element previously mounted by the associated [MountPoint](./kibana-plugin-public.mountpoint.md)
+
+<b>Signature:</b>
+
+```typescript
+export declare type UnmountCallback = () => void;
+```
diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -5,12 +5,12 @@
 ```ts
 
 import { Breadcrumb } from '@elastic/eui';
+import { EuiGlobalToastListToast } from '@elastic/eui';
 import { IconType } from '@elastic/eui';
 import { Observable } from 'rxjs';
 import React from 'react';
 import * as Rx from 'rxjs';
 import { ShallowPromise } from '@kbn/utility-types';
-import { EuiGlobalToastListToast as Toast } from '@elastic/eui';
 
 // @public
 export interface App extends AppBase {
@@ -616,6 +616,9 @@ export interface LegacyNavLink {
     url: string;
 }
 
+// @public
+export type MountPoint = (element: HTMLElement) => UnmountCallback;
+
 // @public (undocumented)
 export interface NotificationsSetup {
     // (undocumented)
@@ -914,35 +917,36 @@ export class SimpleSavedObject<T extends SavedObjectAttributes> {
     _version?: SavedObject<T>['version'];
 }
 
-export { Toast }
+// Warning: (ae-missing-release-tag) "Toast" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+// 
+// @public (undocumented)
+export type Toast = ToastInputFields & {
+    id: string;
+};
 
 // @public
-export type ToastInput = string | ToastInputFields | Promise<ToastInputFields>;
+export type ToastInput = string | ToastInputFields;
 
 // @public
-export type ToastInputFields = Pick<Toast, Exclude<keyof Toast, 'id'>>;
+export type ToastInputFields = Pick<EuiGlobalToastListToast, Exclude<keyof EuiGlobalToastListToast, 'id' | 'text' | 'title'>> & {
+    title?: string | MountPoint;
+    text?: string | MountPoint;
+};
 
 // @public
 export class ToastsApi implements IToasts {
     constructor(deps: {
         uiSettings: UiSettingsClientContract;
     });
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
     add(toastOrTitle: ToastInput): Toast;
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
     addDanger(toastOrTitle: ToastInput): Toast;
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
     addError(error: Error, options: ErrorToastOptions): Toast;
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
     addSuccess(toastOrTitle: ToastInput): Toast;
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
     addWarning(toastOrTitle: ToastInput): Toast;
     get$(): Rx.Observable<Toast[]>;
     // @internal (undocumented)
     registerOverlays(overlays: OverlayStart): void;
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
-    // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "kibana" does not have an export "ToastApi"
-    remove(toast: Toast): void;
+    remove(toastOrId: Toast | string): void;
     }
 
 // @public (undocumented)
@@ -991,5 +995,8 @@ export interface UiSettingsState {
     [key: string]: InjectedUiSettingsDefault & InjectedUiSettingsUser;
 }
 
+// @public
+export type UnmountCallback = () => void;
+
 
 ```