[7.x] Expose saved object import/export from core (#42022) (#42458)

* expose saved object import/export from core

* additional tests

* removing unused mock

* updater snapshots

* add objectLimit to saved objects service

* don't export the import/export functionality from core; only types

* documenting exported types

* export missing type

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

@@ -58,12 +58,23 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) |  |
 |  [SavedObjectsBulkGetObject](./kibana-plugin-server.savedobjectsbulkgetobject.md) |  |
 |  [SavedObjectsBulkResponse](./kibana-plugin-server.savedobjectsbulkresponse.md) |  |
-|  [SavedObjectsClientWrapperOptions](./kibana-plugin-server.savedobjectsclientwrapperoptions.md) |  |
+|  [SavedObjectsClientProviderOptions](./kibana-plugin-server.savedobjectsclientprovideroptions.md) | Options to control the creation of the Saved Objects Client. |
+|  [SavedObjectsClientWrapperOptions](./kibana-plugin-server.savedobjectsclientwrapperoptions.md) | Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance. |
 |  [SavedObjectsCreateOptions](./kibana-plugin-server.savedobjectscreateoptions.md) |  |
+|  [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) | Options controlling the export operation. |
 |  [SavedObjectsFindOptions](./kibana-plugin-server.savedobjectsfindoptions.md) |  |
 |  [SavedObjectsFindResponse](./kibana-plugin-server.savedobjectsfindresponse.md) |  |
+|  [SavedObjectsImportConflictError](./kibana-plugin-server.savedobjectsimportconflicterror.md) | Represents a failure to import due to a conflict. |
+|  [SavedObjectsImportError](./kibana-plugin-server.savedobjectsimporterror.md) | Represents a failure to import. |
+|  [SavedObjectsImportMissingReferencesError](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.md) | Represents a failure to import due to missing references. |
+|  [SavedObjectsImportOptions](./kibana-plugin-server.savedobjectsimportoptions.md) | Options to control the import operation. |
+|  [SavedObjectsImportResponse](./kibana-plugin-server.savedobjectsimportresponse.md) | The response describing the result of an import. |
+|  [SavedObjectsImportRetry](./kibana-plugin-server.savedobjectsimportretry.md) | Describes a retry operation for importing a saved object. |
+|  [SavedObjectsImportUnknownError](./kibana-plugin-server.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. |
+|  [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-server.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. |
 |  [SavedObjectsMigrationVersion](./kibana-plugin-server.savedobjectsmigrationversion.md) | A dictionary of saved object type -<!-- -->&gt; version used to determine what migrations need to be applied to a saved object. |
 |  [SavedObjectsRawDoc](./kibana-plugin-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. |
+|  [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. |
 |  [SavedObjectsService](./kibana-plugin-server.savedobjectsservice.md) |  |
 |  [SavedObjectsUpdateOptions](./kibana-plugin-server.savedobjectsupdateoptions.md) |  |
 |  [SavedObjectsUpdateResponse](./kibana-plugin-server.savedobjectsupdateresponse.md) |  |
@@ -89,5 +100,5 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [ResponseError](./kibana-plugin-server.responseerror.md) | Error message and optional data send to the client in case of error. |
 |  [RouteMethod](./kibana-plugin-server.routemethod.md) | The set of common HTTP methods supported by Kibana routing. |
 |  [SavedObjectsClientContract](./kibana-plugin-server.savedobjectsclientcontract.md) | \#\# SavedObjectsClient errors<!-- -->Since the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:<!-- -->1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md)<!-- -->Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the <code>isXYZError()</code> helpers exposed at <code>SavedObjectsErrorHelpers</code> should be used to understand and manage error responses from the <code>SavedObjectsClient</code>.<!-- -->Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for <code>error.body.error.type</code> or doing substring checks on <code>error.body.error.reason</code>, just use the helpers to understand the meaning of the error:<!-- -->\`\`\`<!-- -->js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }<!-- -->if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }<!-- -->// always rethrow the error unless you handle it throw error; \`\`\`<!-- -->\#\#\# 404s from missing index<!-- -->From the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistance and that index might be missing.<!-- -->At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.<!-- -->From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.<!-- -->\#\#\# 503s from missing index<!-- -->Unlike all other methods, create requests are supposed to succeed even when the Kibana index does not exist because it will be automatically created by elasticsearch. When that is not the case it is because Elasticsearch's <code>action.auto_create_index</code> setting prevents it from being created automatically so we throw a special 503 with the intention of informing the user that their Elasticsearch settings need to be updated.<!-- -->See [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) |
-|  [SavedObjectsClientWrapperFactory](./kibana-plugin-server.savedobjectsclientwrapperfactory.md) |  |
+|  [SavedObjectsClientWrapperFactory](./kibana-plugin-server.savedobjectsclientwrapperfactory.md) | Describes the factory used to create instances of Saved Objects Client Wrappers. |
 

docs/development/core/server/kibana-plugin-server.savedobjectsclientprovideroptions.excludedwrappers.md

@@ -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; [SavedObjectsClientProviderOptions](./kibana-plugin-server.savedobjectsclientprovideroptions.md) &gt; [excludedWrappers](./kibana-plugin-server.savedobjectsclientprovideroptions.excludedwrappers.md)
+
+## SavedObjectsClientProviderOptions.excludedWrappers property
+
+<b>Signature:</b>
+
+```typescript
+excludedWrappers?: string[];
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsClientProviderOptions](./kibana-plugin-server.savedobjectsclientprovideroptions.md)
+
+## SavedObjectsClientProviderOptions interface
+
+Options to control the creation of the Saved Objects Client.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsClientProviderOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [excludedWrappers](./kibana-plugin-server.savedobjectsclientprovideroptions.excludedwrappers.md) | <code>string[]</code> |  |
+

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

@@ -4,6 +4,8 @@
 
 ## SavedObjectsClientWrapperFactory type
 
+Describes the factory used to create instances of Saved Objects Client Wrappers.
+
 <b>Signature:</b>
 
 ```typescript

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

@@ -4,6 +4,8 @@
 
 ## SavedObjectsClientWrapperOptions interface
 
+Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance.
+
 <b>Signature:</b>
 
 ```typescript

docs/development/core/server/kibana-plugin-server.savedobjectsexportoptions.exportsizelimit.md

@@ -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; [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) &gt; [exportSizeLimit](./kibana-plugin-server.savedobjectsexportoptions.exportsizelimit.md)
+
+## SavedObjectsExportOptions.exportSizeLimit property
+
+<b>Signature:</b>
+
+```typescript
+exportSizeLimit: number;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsexportoptions.includereferencesdeep.md

@@ -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; [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) &gt; [includeReferencesDeep](./kibana-plugin-server.savedobjectsexportoptions.includereferencesdeep.md)
+
+## SavedObjectsExportOptions.includeReferencesDeep property
+
+<b>Signature:</b>
+
+```typescript
+includeReferencesDeep?: boolean;
+```

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md)
+
+## SavedObjectsExportOptions interface
+
+Options controlling the export operation.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsExportOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [exportSizeLimit](./kibana-plugin-server.savedobjectsexportoptions.exportsizelimit.md) | <code>number</code> |  |
+|  [includeReferencesDeep](./kibana-plugin-server.savedobjectsexportoptions.includereferencesdeep.md) | <code>boolean</code> |  |
+|  [namespace](./kibana-plugin-server.savedobjectsexportoptions.namespace.md) | <code>string</code> |  |
+|  [objects](./kibana-plugin-server.savedobjectsexportoptions.objects.md) | <code>Array&lt;{</code><br/><code>        id: string;</code><br/><code>        type: string;</code><br/><code>    }&gt;</code> |  |
+|  [savedObjectsClient](./kibana-plugin-server.savedobjectsexportoptions.savedobjectsclient.md) | <code>SavedObjectsClientContract</code> |  |
+|  [types](./kibana-plugin-server.savedobjectsexportoptions.types.md) | <code>string[]</code> |  |
+

docs/development/core/server/kibana-plugin-server.savedobjectsexportoptions.namespace.md

@@ -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; [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) &gt; [namespace](./kibana-plugin-server.savedobjectsexportoptions.namespace.md)
+
+## SavedObjectsExportOptions.namespace property
+
+<b>Signature:</b>
+
+```typescript
+namespace?: string;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsexportoptions.objects.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) &gt; [objects](./kibana-plugin-server.savedobjectsexportoptions.objects.md)
+
+## SavedObjectsExportOptions.objects property
+
+<b>Signature:</b>
+
+```typescript
+objects?: Array<{
+        id: string;
+        type: string;
+    }>;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsexportoptions.savedobjectsclient.md

@@ -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; [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) &gt; [savedObjectsClient](./kibana-plugin-server.savedobjectsexportoptions.savedobjectsclient.md)
+
+## SavedObjectsExportOptions.savedObjectsClient property
+
+<b>Signature:</b>
+
+```typescript
+savedObjectsClient: SavedObjectsClientContract;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsexportoptions.types.md

@@ -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; [SavedObjectsExportOptions](./kibana-plugin-server.savedobjectsexportoptions.md) &gt; [types](./kibana-plugin-server.savedobjectsexportoptions.types.md)
+
+## SavedObjectsExportOptions.types property
+
+<b>Signature:</b>
+
+```typescript
+types?: string[];
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsImportConflictError](./kibana-plugin-server.savedobjectsimportconflicterror.md)
+
+## SavedObjectsImportConflictError interface
+
+Represents a failure to import due to a conflict.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsImportConflictError 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [type](./kibana-plugin-server.savedobjectsimportconflicterror.type.md) | <code>'conflict'</code> |  |
+

docs/development/core/server/kibana-plugin-server.savedobjectsimportconflicterror.type.md

@@ -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; [SavedObjectsImportConflictError](./kibana-plugin-server.savedobjectsimportconflicterror.md) &gt; [type](./kibana-plugin-server.savedobjectsimportconflicterror.type.md)
+
+## SavedObjectsImportConflictError.type property
+
+<b>Signature:</b>
+
+```typescript
+type: 'conflict';
+```

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

@@ -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; [SavedObjectsImportError](./kibana-plugin-server.savedobjectsimporterror.md) &gt; [error](./kibana-plugin-server.savedobjectsimporterror.error.md)
+
+## SavedObjectsImportError.error property
+
+<b>Signature:</b>
+
+```typescript
+error: SavedObjectsImportConflictError | SavedObjectsImportUnsupportedTypeError | SavedObjectsImportMissingReferencesError | SavedObjectsImportUnknownError;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsimporterror.id.md

@@ -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; [SavedObjectsImportError](./kibana-plugin-server.savedobjectsimporterror.md) &gt; [id](./kibana-plugin-server.savedobjectsimporterror.id.md)
+
+## SavedObjectsImportError.id property
+
+<b>Signature:</b>
+
+```typescript
+id: string;
+```

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

@@ -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; [SavedObjectsImportError](./kibana-plugin-server.savedobjectsimporterror.md)
+
+## SavedObjectsImportError interface
+
+Represents a failure to import.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsImportError 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [error](./kibana-plugin-server.savedobjectsimporterror.error.md) | <code>SavedObjectsImportConflictError &#124; SavedObjectsImportUnsupportedTypeError &#124; SavedObjectsImportMissingReferencesError &#124; SavedObjectsImportUnknownError</code> |  |
+|  [id](./kibana-plugin-server.savedobjectsimporterror.id.md) | <code>string</code> |  |
+|  [title](./kibana-plugin-server.savedobjectsimporterror.title.md) | <code>string</code> |  |
+|  [type](./kibana-plugin-server.savedobjectsimporterror.type.md) | <code>string</code> |  |
+

docs/development/core/server/kibana-plugin-server.savedobjectsimporterror.title.md

@@ -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; [SavedObjectsImportError](./kibana-plugin-server.savedobjectsimporterror.md) &gt; [title](./kibana-plugin-server.savedobjectsimporterror.title.md)
+
+## SavedObjectsImportError.title property
+
+<b>Signature:</b>
+
+```typescript
+title?: string;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsimporterror.type.md

@@ -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; [SavedObjectsImportError](./kibana-plugin-server.savedobjectsimporterror.md) &gt; [type](./kibana-plugin-server.savedobjectsimporterror.type.md)
+
+## SavedObjectsImportError.type property
+
+<b>Signature:</b>
+
+```typescript
+type: string;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsimportmissingreferenceserror.blocking.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsImportMissingReferencesError](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.md) &gt; [blocking](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.blocking.md)
+
+## SavedObjectsImportMissingReferencesError.blocking property
+
+<b>Signature:</b>
+
+```typescript
+blocking: Array<{
+        type: string;
+        id: string;
+    }>;
+```

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsImportMissingReferencesError](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.md)
+
+## SavedObjectsImportMissingReferencesError interface
+
+Represents a failure to import due to missing references.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsImportMissingReferencesError 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [blocking](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.blocking.md) | <code>Array&lt;{</code><br/><code>        type: string;</code><br/><code>        id: string;</code><br/><code>    }&gt;</code> |  |
+|  [references](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.references.md) | <code>Array&lt;{</code><br/><code>        type: string;</code><br/><code>        id: string;</code><br/><code>    }&gt;</code> |  |
+|  [type](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.type.md) | <code>'missing_references'</code> |  |
+

docs/development/core/server/kibana-plugin-server.savedobjectsimportmissingreferenceserror.references.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsImportMissingReferencesError](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.md) &gt; [references](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.references.md)
+
+## SavedObjectsImportMissingReferencesError.references property
+
+<b>Signature:</b>
+
+```typescript
+references: Array<{
+        type: string;
+        id: string;
+    }>;
+```

docs/development/core/server/kibana-plugin-server.savedobjectsimportmissingreferenceserror.type.md

@@ -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; [SavedObjectsImportMissingReferencesError](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.md) &gt; [type](./kibana-plugin-server.savedobjectsimportmissingreferenceserror.type.md)
+
+## SavedObjectsImportMissingReferencesError.type property
+
+<b>Signature:</b>
+
+```typescript
+type: 'missing_references';
+```