Merge branch 'master' into canvas-to-np

Author: elasticmachine

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [AppBase](./kibana-plugin-core-public.appbase.md) &gt; [defaultPath](./kibana-plugin-core-public.appbase.defaultpath.md)
+
+## AppBase.defaultPath property
+
+Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the `path` option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)<!-- -->\`<!-- -->, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar.
+
+<b>Signature:</b>
+
+```typescript
+defaultPath?: string;
+```

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

@@ -18,6 +18,7 @@ export interface AppBase
 |  [capabilities](./kibana-plugin-core-public.appbase.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
 |  [category](./kibana-plugin-core-public.appbase.category.md) | <code>AppCategory</code> | The category definition of the product See [AppCategory](./kibana-plugin-core-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
 |  [chromeless](./kibana-plugin-core-public.appbase.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
+|  [defaultPath](./kibana-plugin-core-public.appbase.defaultpath.md) | <code>string</code> | Allow to define the default path a user should be directed to when navigating to the app. When defined, this value will be used as a default for the <code>path</code> option when calling [navigateToApp](./kibana-plugin-core-public.applicationstart.navigatetoapp.md)<!-- -->\`<!-- -->, and will also be appended to the [application navLink](./kibana-plugin-core-public.chromenavlink.md) in the navigation bar. |
 |  [euiIconType](./kibana-plugin-core-public.appbase.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. |
 |  [icon](./kibana-plugin-core-public.appbase.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-core-public.appbase.id.md) | <code>string</code> | The unique identifier of the application |

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

@@ -9,5 +9,5 @@ Defines the list of fields that can be updated via an [AppUpdater](./kibana-plug
 <b>Signature:</b>
 
 ```typescript
-export declare type AppUpdatableFields = Pick<AppBase, 'status' | 'navLinkStatus' | 'tooltip'>;
+export declare type AppUpdatableFields = Pick<AppBase, 'status' | 'navLinkStatus' | 'tooltip' | 'defaultPath'>;
 ```

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

@@ -29,5 +29,5 @@ export interface ChromeNavLink
 |  [subUrlBase](./kibana-plugin-core-public.chromenavlink.suburlbase.md) | <code>string</code> | A url base that legacy apps can set to match deep URLs to an application. |
 |  [title](./kibana-plugin-core-public.chromenavlink.title.md) | <code>string</code> | The title of the application. |
 |  [tooltip](./kibana-plugin-core-public.chromenavlink.tooltip.md) | <code>string</code> | A tooltip shown when hovering over an app link. |
-|  [url](./kibana-plugin-core-public.chromenavlink.url.md) | <code>string</code> | A url that legacy apps can set to deep link into their applications. |
+|  [url](./kibana-plugin-core-public.chromenavlink.url.md) | <code>string</code> | The route used to open the [default path](./kibana-plugin-core-public.appbase.defaultpath.md) of an application. If unset, <code>baseUrl</code> will be used instead. |
 

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

@@ -4,11 +4,7 @@
 
 ## ChromeNavLink.url property
 
-> Warning: This API is now obsolete.
-> 
-> 
-
-A url that legacy apps can set to deep link into their applications.
+The route used to open the [default path](./kibana-plugin-core-public.appbase.defaultpath.md) of an application. If unset, `baseUrl` will be used instead.
 
 <b>Signature:</b>
 

docs/development/core/server/kibana-plugin-core-server.savedobjectmigrationfn.md

@@ -9,22 +9,36 @@ A migration function for a [saved object type](./kibana-plugin-core-server.saved
 <b>Signature:</b>
 
 ```typescript
-export declare type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, context: SavedObjectMigrationContext) => SavedObjectUnsanitizedDoc;
+export declare type SavedObjectMigrationFn<InputAttributes = unknown, MigratedAttributes = unknown> = (doc: SavedObjectUnsanitizedDoc<InputAttributes>, context: SavedObjectMigrationContext) => SavedObjectUnsanitizedDoc<MigratedAttributes>;
 ```
 
 ## Example
 
 
 ```typescript
-const migrateProperty: SavedObjectMigrationFn = (doc, { log }) => {
-  if(doc.attributes.someProp === null) {
-    log.warn('Skipping migration');
-  } else {
-    doc.attributes.someProp = migrateProperty(doc.attributes.someProp);
-  }
-
-  return doc;
+interface TypeV1Attributes {
+  someKey: string;
+  obsoleteProperty: number;
 }
 
+interface TypeV2Attributes {
+  someKey: string;
+  newProperty: string;
+}
+
+const migrateToV2: SavedObjectMigrationFn<TypeV1Attributes, TypeV2Attributes> = (doc, { log }) => {
+  const { obsoleteProperty, ...otherAttributes } = doc.attributes;
+  // instead of mutating `doc` we make a shallow copy so that we can use separate types for the input
+  // and output attributes. We don't need to make a deep copy, we just need to ensure that obsolete
+  // attributes are not present on the returned doc.
+  return {
+    ...doc,
+    attributes: {
+      ...otherAttributes,
+      newProperty: migrate(obsoleteProperty),
+    },
+  };
+};
+
 ```
 

docs/development/core/server/kibana-plugin-core-server.savedobjectsanitizeddoc.md

@@ -9,5 +9,5 @@ Describes Saved Object documents that have passed through the migration framewor
 <b>Signature:</b>
 
 ```typescript
-export declare type SavedObjectSanitizedDoc = SavedObjectDoc & Referencable;
+export declare type SavedObjectSanitizedDoc<T = unknown> = SavedObjectDoc<T> & Referencable;
 ```

docs/development/core/server/kibana-plugin-core-server.savedobjectunsanitizeddoc.md

@@ -9,5 +9,5 @@ Describes Saved Object documents from Kibana < 7.0.0 which don't have a `refe
 <b>Signature:</b>
 
 ```typescript
-export declare type SavedObjectUnsanitizedDoc = SavedObjectDoc & Partial<Referencable>;
+export declare type SavedObjectUnsanitizedDoc<T = unknown> = SavedObjectDoc<T> & Partial<Referencable>;
 ```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.gettime.md

@@ -7,7 +7,10 @@
 <b>Signature:</b>
 
 ```typescript
-export declare function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, forceNow?: Date): import("../..").RangeFilter | undefined;
+export declare function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, options?: {
+    forceNow?: Date;
+    fieldName?: string;
+}): import("../..").RangeFilter | undefined;
 ```
 
 ## Parameters
@@ -16,7 +19,7 @@ export declare function getTime(indexPattern: IIndexPattern | undefined, timeRan
 |  --- | --- | --- |
 |  indexPattern | <code>IIndexPattern &#124; undefined</code> |  |
 |  timeRange | <code>TimeRange</code> |  |
-|  forceNow | <code>Date</code> |  |
+|  options | <code>{</code><br/><code>    forceNow?: Date;</code><br/><code>    fieldName?: string;</code><br/><code>}</code> |  |
 
 <b>Returns:</b>
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iindexpattern.gettimefield.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IIndexPattern](./kibana-plugin-plugins-data-public.iindexpattern.md) &gt; [getTimeField](./kibana-plugin-plugins-data-public.iindexpattern.gettimefield.md)
+
+## IIndexPattern.getTimeField() method
+
+<b>Signature:</b>
+
+```typescript
+getTimeField?(): IFieldType | undefined;
+```
+<b>Returns:</b>
+
+`IFieldType | undefined`
+