Initial server-side support for sharing saved-objects phase 1.5

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

@@ -113,11 +113,13 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [SavedObjectsCreateOptions](./kibana-plugin-core-public.savedobjectscreateoptions.md) |  |
 |  [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) |  |
 |  [SavedObjectsFindResponsePublic](./kibana-plugin-core-public.savedobjectsfindresponsepublic.md) | Return type of the Saved Objects <code>find()</code> method.<!-- -->\*Note\*: this type is different between the Public and Server Saved Objects clients. |
+|  [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) | Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. |
 |  [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. |
 |  [SavedObjectsImportError](./kibana-plugin-core-public.savedobjectsimporterror.md) | Represents a failure to import. |
 |  [SavedObjectsImportMissingReferencesError](./kibana-plugin-core-public.savedobjectsimportmissingreferenceserror.md) | Represents a failure to import due to missing references. |
 |  [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) | The response describing the result of an import. |
 |  [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) | Describes a retry operation for importing a saved object. |
+|  [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) | Represents a successful import. |
 |  [SavedObjectsImportUnknownError](./kibana-plugin-core-public.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. |
 |  [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-core-public.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. |
 |  [SavedObjectsMigrationVersion](./kibana-plugin-core-public.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |

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

@@ -8,7 +8,9 @@
 
 ```typescript
 error?: {
+        error: string;
         message: string;
         statusCode: number;
+        metadata?: Record<string, unknown>;
     };
 ```

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

@@ -15,10 +15,11 @@ export interface SavedObject<T = unknown>
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [attributes](./kibana-plugin-core-public.savedobject.attributes.md) | <code>T</code> | The data for a Saved Object is stored as an object in the <code>attributes</code> property. |
-|  [error](./kibana-plugin-core-public.savedobject.error.md) | <code>{</code><br/><code>        message: string;</code><br/><code>        statusCode: number;</code><br/><code>    }</code> |  |
+|  [error](./kibana-plugin-core-public.savedobject.error.md) | <code>{</code><br/><code>        error: string;</code><br/><code>        message: string;</code><br/><code>        statusCode: number;</code><br/><code>        metadata?: Record&lt;string, unknown&gt;;</code><br/><code>    }</code> |  |
 |  [id](./kibana-plugin-core-public.savedobject.id.md) | <code>string</code> | The ID of this Saved Object, guaranteed to be unique for all objects of the same <code>type</code> |
 |  [migrationVersion](./kibana-plugin-core-public.savedobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
 |  [namespaces](./kibana-plugin-core-public.savedobject.namespaces.md) | <code>string[]</code> | Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types. |
+|  [originId](./kibana-plugin-core-public.savedobject.originid.md) | <code>string</code> | The ID of the saved object this originated from. This is set if this object's <code>id</code> was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space. |
 |  [references](./kibana-plugin-core-public.savedobject.references.md) | <code>SavedObjectReference[]</code> | A reference to another saved object. |
 |  [type](./kibana-plugin-core-public.savedobject.type.md) | <code>string</code> | The type of Saved Object. Each plugin can define it's own custom Saved Object types. |
 |  [updated\_at](./kibana-plugin-core-public.savedobject.updated_at.md) | <code>string</code> | Timestamp of the last time this document had been updated. |

docs/development/core/public/kibana-plugin-core-public.savedobject.originid.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; [SavedObject](./kibana-plugin-core-public.savedobject.md) &gt; [originId](./kibana-plugin-core-public.savedobject.originid.md)
+
+## SavedObject.originId property
+
+The ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration from a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import to ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given space.
+
+<b>Signature:</b>
+
+```typescript
+originId?: string;
+```

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

@@ -21,6 +21,7 @@ export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions
 |  [hasReference](./kibana-plugin-core-public.savedobjectsfindoptions.hasreference.md) | <code>{</code><br/><code>        type: string;</code><br/><code>        id: string;</code><br/><code>    }</code> |  |
 |  [page](./kibana-plugin-core-public.savedobjectsfindoptions.page.md) | <code>number</code> |  |
 |  [perPage](./kibana-plugin-core-public.savedobjectsfindoptions.perpage.md) | <code>number</code> |  |
+|  [rawSearchFields](./kibana-plugin-core-public.savedobjectsfindoptions.rawsearchfields.md) | <code>string[]</code> | The fields to perform the parsed query against. Unlike the <code>searchFields</code> argument, these are expected to be raw and will not be modified. If used in conjunction with <code>searchFields</code>, both are concatenated together. |
 |  [search](./kibana-plugin-core-public.savedobjectsfindoptions.search.md) | <code>string</code> | Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String <code>query</code> argument for more information |
 |  [searchFields](./kibana-plugin-core-public.savedobjectsfindoptions.searchfields.md) | <code>string[]</code> | The fields to perform the parsed query against. See Elasticsearch Simple Query String <code>fields</code> argument for more information |
 |  [sortField](./kibana-plugin-core-public.savedobjectsfindoptions.sortfield.md) | <code>string</code> |  |

docs/development/core/public/kibana-plugin-core-public.savedobjectsfindoptions.rawsearchfields.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; [SavedObjectsFindOptions](./kibana-plugin-core-public.savedobjectsfindoptions.md) &gt; [rawSearchFields](./kibana-plugin-core-public.savedobjectsfindoptions.rawsearchfields.md)
+
+## SavedObjectsFindOptions.rawSearchFields property
+
+The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be raw and will not be modified. If used in conjunction with `searchFields`<!-- -->, both are concatenated together.
+
+<b>Signature:</b>
+
+```typescript
+rawSearchFields?: string[];
+```

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

@@ -0,0 +1,15 @@
+<!-- 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; [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) &gt; [destinations](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md)
+
+## SavedObjectsImportAmbiguousConflictError.destinations property
+
+<b>Signature:</b>
+
+```typescript
+destinations: Array<{
+        id: string;
+        title?: string;
+        updatedAt?: string;
+    }>;
+```

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

@@ -0,0 +1,22 @@
+<!-- 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; [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md)
+
+## SavedObjectsImportAmbiguousConflictError interface
+
+Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsImportAmbiguousConflictError 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [destinations](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.destinations.md) | <code>Array&lt;{</code><br/><code>        id: string;</code><br/><code>        title?: string;</code><br/><code>        updatedAt?: string;</code><br/><code>    }&gt;</code> |  |
+|  [sources](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.sources.md) | <code>Array&lt;{</code><br/><code>        id: string;</code><br/><code>        title?: string;</code><br/><code>        updatedAt?: string;</code><br/><code>    }&gt;</code> |  |
+|  [type](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md) | <code>'ambiguous_conflict'</code> |  |
+

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

@@ -0,0 +1,15 @@
+<!-- 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; [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) &gt; [sources](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.sources.md)
+
+## SavedObjectsImportAmbiguousConflictError.sources property
+
+<b>Signature:</b>
+
+```typescript
+sources: Array<{
+        id: string;
+        title?: string;
+        updatedAt?: string;
+    }>;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [SavedObjectsImportAmbiguousConflictError](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.md) &gt; [type](./kibana-plugin-core-public.savedobjectsimportambiguousconflicterror.type.md)
+
+## SavedObjectsImportAmbiguousConflictError.type property
+
+<b>Signature:</b>
+
+```typescript
+type: 'ambiguous_conflict';
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [SavedObjectsImportConflictError](./kibana-plugin-core-public.savedobjectsimportconflicterror.md) &gt; [destinationId](./kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md)
+
+## SavedObjectsImportConflictError.destinationId property
+
+<b>Signature:</b>
+
+```typescript
+destinationId?: string;
+```

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

@@ -16,5 +16,6 @@ export interface SavedObjectsImportConflictError
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [destinationId](./kibana-plugin-core-public.savedobjectsimportconflicterror.destinationid.md) | <code>string</code> |  |
 |  [type](./kibana-plugin-core-public.savedobjectsimportconflicterror.type.md) | <code>'conflict'</code> |  |
 

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

@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-error: SavedObjectsImportConflictError | SavedObjectsImportUnsupportedTypeError | SavedObjectsImportMissingReferencesError | SavedObjectsImportUnknownError;
+error: SavedObjectsImportConflictError | SavedObjectsImportAmbiguousConflictError | SavedObjectsImportUnsupportedTypeError | SavedObjectsImportMissingReferencesError | SavedObjectsImportUnknownError;
 ```

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

@@ -16,7 +16,7 @@ export interface SavedObjectsImportError
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [error](./kibana-plugin-core-public.savedobjectsimporterror.error.md) | <code>SavedObjectsImportConflictError &#124; SavedObjectsImportUnsupportedTypeError &#124; SavedObjectsImportMissingReferencesError &#124; SavedObjectsImportUnknownError</code> |  |
+|  [error](./kibana-plugin-core-public.savedobjectsimporterror.error.md) | <code>SavedObjectsImportConflictError &#124; SavedObjectsImportAmbiguousConflictError &#124; SavedObjectsImportUnsupportedTypeError &#124; SavedObjectsImportMissingReferencesError &#124; SavedObjectsImportUnknownError</code> |  |
 |  [id](./kibana-plugin-core-public.savedobjectsimporterror.id.md) | <code>string</code> |  |
 |  [title](./kibana-plugin-core-public.savedobjectsimporterror.title.md) | <code>string</code> |  |
 |  [type](./kibana-plugin-core-public.savedobjectsimporterror.type.md) | <code>string</code> |  |

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

@@ -19,4 +19,5 @@ export interface SavedObjectsImportResponse
 |  [errors](./kibana-plugin-core-public.savedobjectsimportresponse.errors.md) | <code>SavedObjectsImportError[]</code> |  |
 |  [success](./kibana-plugin-core-public.savedobjectsimportresponse.success.md) | <code>boolean</code> |  |
 |  [successCount](./kibana-plugin-core-public.savedobjectsimportresponse.successcount.md) | <code>number</code> |  |
+|  [successResults](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md) | <code>SavedObjectsImportSuccess[]</code> |  |
 

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

@@ -0,0 +1,11 @@
+<!-- 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; [SavedObjectsImportResponse](./kibana-plugin-core-public.savedobjectsimportresponse.md) &gt; [successResults](./kibana-plugin-core-public.savedobjectsimportresponse.successresults.md)
+
+## SavedObjectsImportResponse.successResults property
+
+<b>Signature:</b>
+
+```typescript
+successResults?: SavedObjectsImportSuccess[];
+```

docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.duplicate.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; [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) &gt; [duplicate](./kibana-plugin-core-public.savedobjectsimportretry.duplicate.md)
+
+## SavedObjectsImportRetry.duplicate property
+
+Resolve an import conflict by creating a duplicate object with a new (undefined) originId. Note: this attribute is mutually-exclusive with `overwrite`<!-- -->. If both are enabled, `overwrite` takes precedence.
+
+<b>Signature:</b>
+
+```typescript
+duplicate?: boolean;
+```

docs/development/core/public/kibana-plugin-core-public.savedobjectsimportretry.idtooverwrite.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; [SavedObjectsImportRetry](./kibana-plugin-core-public.savedobjectsimportretry.md) &gt; [idToOverwrite](./kibana-plugin-core-public.savedobjectsimportretry.idtooverwrite.md)
+
+## SavedObjectsImportRetry.idToOverwrite property
+
+The object ID that will be overwritten. Only used if `overwrite` == true. This is required to resolve ambiguous conflicts.
+
+<b>Signature:</b>
+
+```typescript
+idToOverwrite?: string;
+```

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

@@ -16,8 +16,10 @@ export interface SavedObjectsImportRetry
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [duplicate](./kibana-plugin-core-public.savedobjectsimportretry.duplicate.md) | <code>boolean</code> | Resolve an import conflict by creating a duplicate object with a new (undefined) originId. Note: this attribute is mutually-exclusive with <code>overwrite</code>. If both are enabled, <code>overwrite</code> takes precedence. |
 |  [id](./kibana-plugin-core-public.savedobjectsimportretry.id.md) | <code>string</code> |  |
-|  [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) | <code>boolean</code> |  |
+|  [idToOverwrite](./kibana-plugin-core-public.savedobjectsimportretry.idtooverwrite.md) | <code>string</code> | The object ID that will be overwritten. Only used if <code>overwrite</code> == true. This is required to resolve ambiguous conflicts. |
+|  [overwrite](./kibana-plugin-core-public.savedobjectsimportretry.overwrite.md) | <code>boolean</code> | Resolve an import conflict by overwriting a destination object. Note: this attribute is mutually-exclusive with <code>duplicate</code>. If both are enabled, <code>overwrite</code> takes precedence. |
 |  [replaceReferences](./kibana-plugin-core-public.savedobjectsimportretry.replacereferences.md) | <code>Array&lt;{</code><br/><code>        type: string;</code><br/><code>        from: string;</code><br/><code>        to: string;</code><br/><code>    }&gt;</code> |  |
 |  [type](./kibana-plugin-core-public.savedobjectsimportretry.type.md) | <code>string</code> |  |
 

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

@@ -4,6 +4,8 @@
 
 ## SavedObjectsImportRetry.overwrite property
 
+Resolve an import conflict by overwriting a destination object. Note: this attribute is mutually-exclusive with `duplicate`<!-- -->. If both are enabled, `overwrite` takes precedence.
+
 <b>Signature:</b>
 
 ```typescript

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

@@ -0,0 +1,11 @@
+<!-- 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; [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) &gt; [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md)
+
+## SavedObjectsImportSuccess.id property
+
+<b>Signature:</b>
+
+```typescript
+id: string;
+```

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

@@ -0,0 +1,22 @@
+<!-- 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; [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md)
+
+## SavedObjectsImportSuccess interface
+
+Represents a successful import.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsImportSuccess 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [id](./kibana-plugin-core-public.savedobjectsimportsuccess.id.md) | <code>string</code> |  |
+|  [newId](./kibana-plugin-core-public.savedobjectsimportsuccess.newid.md) | <code>string</code> | If <code>newId</code> is specified, the new object has a new ID that is different from the import ID. |
+|  [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md) | <code>string</code> |  |
+

docs/development/core/public/kibana-plugin-core-public.savedobjectsimportsuccess.newid.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; [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) &gt; [newId](./kibana-plugin-core-public.savedobjectsimportsuccess.newid.md)
+
+## SavedObjectsImportSuccess.newId property
+
+If `newId` is specified, the new object has a new ID that is different from the import ID.
+
+<b>Signature:</b>
+
+```typescript
+newId?: string;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [SavedObjectsImportSuccess](./kibana-plugin-core-public.savedobjectsimportsuccess.md) &gt; [type](./kibana-plugin-core-public.savedobjectsimportsuccess.type.md)
+
+## SavedObjectsImportSuccess.type property
+
+<b>Signature:</b>
+
+```typescript
+type: string;
+```