Sharing saved objects phase 3.5

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

@@ -14,6 +14,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 
 |  Class | Description |
 |  --- | --- |
+|  [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) | This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md)<!-- -->.<!-- -->It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. |
 |  [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state. The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects. |
 |  [ScopedHistory](./kibana-plugin-core-public.scopedhistory.md) | A wrapper around a <code>History</code> instance that is scoped to a particular base path of the history stack. Behaves similarly to the <code>basename</code> option except that this wrapper hides any history stack entries from outside the scope of this base path.<!-- -->This wrapper also allows Core and Plugins to share a single underlying global <code>History</code> instance without exposing the history of other applications.<!-- -->The [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) method is particularly useful for applications that contain any number of "sub-apps" which should not have access to the main application's history or basePath. |
 |  [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) | This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md)<!-- -->.<!-- -->It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. |
@@ -125,6 +126,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [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. |
+|  [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) |  |
 |  [SavedObjectsStart](./kibana-plugin-core-public.savedobjectsstart.md) |  |
 |  [SavedObjectsUpdateOptions](./kibana-plugin-core-public.savedobjectsupdateoptions.md) |  |
 |  [ToastOptions](./kibana-plugin-core-public.toastoptions.md) | Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. |

docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject._constructor_.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; [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) &gt; [(constructor)](./kibana-plugin-core-public.resolvedsimplesavedobject._constructor_.md)
+
+## ResolvedSimpleSavedObject.(constructor)
+
+Constructs a new instance of the `ResolvedSimpleSavedObject` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(savedObject: SimpleSavedObject<T>, outcome: SavedObjectsResolveResponse['outcome'], aliasTargetId: SavedObjectsResolveResponse['aliasTargetId']);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  savedObject | <code>SimpleSavedObject&lt;T&gt;</code> |  |
+|  outcome | <code>SavedObjectsResolveResponse['outcome']</code> |  |
+|  aliasTargetId | <code>SavedObjectsResolveResponse['aliasTargetId']</code> |  |
+

docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.aliastargetid.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; [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) &gt; [aliasTargetId](./kibana-plugin-core-public.resolvedsimplesavedobject.aliastargetid.md)
+
+## ResolvedSimpleSavedObject.aliasTargetId property
+
+<b>Signature:</b>
+
+```typescript
+aliasTargetId: SavedObjectsResolveResponse['aliasTargetId'];
+```

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

@@ -0,0 +1,30 @@
+<!-- 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; [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md)
+
+## ResolvedSimpleSavedObject class
+
+This class is a very simple wrapper for SavedObjects loaded from the server with the [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md)<!-- -->.
+
+It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ResolvedSimpleSavedObject<T = unknown> 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(savedObject, outcome, aliasTargetId)](./kibana-plugin-core-public.resolvedsimplesavedobject._constructor_.md) |  | Constructs a new instance of the <code>ResolvedSimpleSavedObject</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [aliasTargetId](./kibana-plugin-core-public.resolvedsimplesavedobject.aliastargetid.md) |  | <code>SavedObjectsResolveResponse['aliasTargetId']</code> |  |
+|  [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md) |  | <code>SavedObjectsResolveResponse['outcome']</code> |  |
+|  [savedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.savedobject.md) |  | <code>SimpleSavedObject&lt;T&gt;</code> |  |
+

docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.outcome.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; [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) &gt; [outcome](./kibana-plugin-core-public.resolvedsimplesavedobject.outcome.md)
+
+## ResolvedSimpleSavedObject.outcome property
+
+<b>Signature:</b>
+
+```typescript
+outcome: SavedObjectsResolveResponse['outcome'];
+```

docs/development/core/public/kibana-plugin-core-public.resolvedsimplesavedobject.savedobject.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; [ResolvedSimpleSavedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.md) &gt; [savedObject](./kibana-plugin-core-public.resolvedsimplesavedobject.savedobject.md)
+
+## ResolvedSimpleSavedObject.savedObject property
+
+<b>Signature:</b>
+
+```typescript
+savedObject: SimpleSavedObject<T>;
+```

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

@@ -26,6 +26,7 @@ The constructor for this class is marked as internal. Third-party code should no
 |  [delete](./kibana-plugin-core-public.savedobjectsclient.delete.md) |  | <code>(type: string, id: string, options?: SavedObjectsDeleteOptions &#124; undefined) =&gt; ReturnType&lt;SavedObjectsApi['delete']&gt;</code> | Deletes an object |
 |  [find](./kibana-plugin-core-public.savedobjectsclient.find.md) |  | <code>&lt;T = unknown, A = unknown&gt;(options: SavedObjectsFindOptions) =&gt; Promise&lt;SavedObjectsFindResponsePublic&lt;T, unknown&gt;&gt;</code> | Search for objects |
 |  [get](./kibana-plugin-core-public.savedobjectsclient.get.md) |  | <code>&lt;T = unknown&gt;(type: string, id: string) =&gt; Promise&lt;SimpleSavedObject&lt;T&gt;&gt;</code> | Fetches a single object |
+|  [resolve](./kibana-plugin-core-public.savedobjectsclient.resolve.md) |  | <code>&lt;T = unknown&gt;(type: string, id: string) =&gt; Promise&lt;ResolvedSimpleSavedObject&lt;T&gt;&gt;</code> | Resolves a single object |
 
 ## Methods
 

docs/development/core/public/kibana-plugin-core-public.savedobjectsclient.resolve.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; [SavedObjectsClient](./kibana-plugin-core-public.savedobjectsclient.md) &gt; [resolve](./kibana-plugin-core-public.savedobjectsclient.resolve.md)
+
+## SavedObjectsClient.resolve property
+
+Resolves a single object
+
+<b>Signature:</b>
+
+```typescript
+resolve: <T = unknown>(type: string, id: string) => Promise<ResolvedSimpleSavedObject<T>>;
+```

docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.aliastargetid.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; [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) &gt; [aliasTargetId](./kibana-plugin-core-public.savedobjectsresolveresponse.aliastargetid.md)
+
+## SavedObjectsResolveResponse.aliasTargetId property
+
+The ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+aliasTargetId?: string;
+```

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

@@ -0,0 +1,21 @@
+<!-- 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; [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md)
+
+## SavedObjectsResolveResponse interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsResolveResponse<T = unknown> 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [aliasTargetId](./kibana-plugin-core-public.savedobjectsresolveresponse.aliastargetid.md) | <code>string</code> | The ID of the object that the legacy URL alias points to. This is only defined when the outcome is <code>'aliasMatch'</code> or <code>'conflict'</code>. |
+|  [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md) | <code>'exactMatch' &#124; 'aliasMatch' &#124; 'conflict'</code> | The outcome for a successful <code>resolve</code> call is one of the following values:<!-- -->\* <code>'exactMatch'</code> -- One document exactly matched the given ID. \* <code>'aliasMatch'</code> -- One document with a legacy URL alias matched the given ID; in this case the <code>saved_object.id</code> field is different than the given ID. \* <code>'conflict'</code> -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the <code>saved_object</code> object is the exact match, and the <code>saved_object.id</code> field is the same as the given ID. |
+|  [saved\_object](./kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md) | <code>SavedObject&lt;T&gt;</code> |  |
+

docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.outcome.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; [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) &gt; [outcome](./kibana-plugin-core-public.savedobjectsresolveresponse.outcome.md)
+
+## SavedObjectsResolveResponse.outcome property
+
+The outcome for a successful `resolve` call is one of the following values:
+
+\* `'exactMatch'` -- One document exactly matched the given ID. \* `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different than the given ID. \* `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID.
+
+<b>Signature:</b>
+
+```typescript
+outcome: 'exactMatch' | 'aliasMatch' | 'conflict';
+```

docs/development/core/public/kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.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; [SavedObjectsResolveResponse](./kibana-plugin-core-public.savedobjectsresolveresponse.md) &gt; [saved\_object](./kibana-plugin-core-public.savedobjectsresolveresponse.saved_object.md)
+
+## SavedObjectsResolveResponse.saved\_object property
+
+<b>Signature:</b>
+
+```typescript
+saved_object: SavedObject<T>;
+```

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

@@ -9,13 +9,13 @@ Constructs a new instance of the `SimpleSavedObject` class
 <b>Signature:</b>
 
 ```typescript
-constructor(client: SavedObjectsClientContract, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, }: SavedObjectType<T>);
+constructor(client: SavedObjectsClientContract, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, }: SavedObjectType<T>);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  client | <code>SavedObjectsClientContract</code> |  |
-|  { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, } | <code>SavedObjectType&lt;T&gt;</code> |  |
+|  { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, } | <code>SavedObjectType&lt;T&gt;</code> |  |
 

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

@@ -18,7 +18,7 @@ export declare class SimpleSavedObject<T = unknown>
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(client, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, })](./kibana-plugin-core-public.simplesavedobject._constructor_.md) |  | Constructs a new instance of the <code>SimpleSavedObject</code> class |
+|  [(constructor)(client, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, })](./kibana-plugin-core-public.simplesavedobject._constructor_.md) |  | Constructs a new instance of the <code>SimpleSavedObject</code> class |
 
 ## Properties
 
@@ -30,6 +30,7 @@ export declare class SimpleSavedObject<T = unknown>
 |  [error](./kibana-plugin-core-public.simplesavedobject.error.md) |  | <code>SavedObjectType&lt;T&gt;['error']</code> |  |
 |  [id](./kibana-plugin-core-public.simplesavedobject.id.md) |  | <code>SavedObjectType&lt;T&gt;['id']</code> |  |
 |  [migrationVersion](./kibana-plugin-core-public.simplesavedobject.migrationversion.md) |  | <code>SavedObjectType&lt;T&gt;['migrationVersion']</code> |  |
+|  [namespaces](./kibana-plugin-core-public.simplesavedobject.namespaces.md) |  | <code>SavedObjectType&lt;T&gt;['namespaces']</code> |  |
 |  [references](./kibana-plugin-core-public.simplesavedobject.references.md) |  | <code>SavedObjectType&lt;T&gt;['references']</code> |  |
 |  [type](./kibana-plugin-core-public.simplesavedobject.type.md) |  | <code>SavedObjectType&lt;T&gt;['type']</code> |  |
 

docs/development/core/public/kibana-plugin-core-public.simplesavedobject.namespaces.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; [SimpleSavedObject](./kibana-plugin-core-public.simplesavedobject.md) &gt; [namespaces](./kibana-plugin-core-public.simplesavedobject.namespaces.md)
+
+## SimpleSavedObject.namespaces property
+
+<b>Signature:</b>
+
+```typescript
+namespaces: SavedObjectType<T>['namespaces'];
+```

src/core/public/index.ts

@@ -97,7 +97,7 @@ export type {
   NavigateToAppOptions,
 } from './application';
 
-export { SimpleSavedObject } from './saved_objects';
+export { ResolvedSimpleSavedObject, SimpleSavedObject } from './saved_objects';
 export type {
   SavedObjectsBatchResponse,
   SavedObjectsBulkCreateObject,
@@ -106,6 +106,7 @@ export type {
   SavedObjectsBulkUpdateOptions,
   SavedObjectsCreateOptions,
   SavedObjectsFindResponsePublic,
+  SavedObjectsResolveResponse,
   SavedObjectsUpdateOptions,
   SavedObject,
   SavedObjectAttribute,

src/core/public/public.api.md

@@ -1095,6 +1095,17 @@ export type ResolveDeprecationResponse = {
     reason: string;
 };
 
+// @public
+export class ResolvedSimpleSavedObject<T = unknown> {
+    constructor(savedObject: SimpleSavedObject<T>, outcome: SavedObjectsResolveResponse['outcome'], aliasTargetId: SavedObjectsResolveResponse['aliasTargetId']);
+    // (undocumented)
+    aliasTargetId: SavedObjectsResolveResponse['aliasTargetId'];
+    // (undocumented)
+    outcome: SavedObjectsResolveResponse['outcome'];
+    // (undocumented)
+    savedObject: SimpleSavedObject<T>;
+}
+
 // Warning: (ae-missing-release-tag) "SavedObject" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -1224,6 +1235,7 @@ export class SavedObjectsClient {
     // Warning: (ae-forgotten-export) The symbol "SavedObjectsFindOptions" needs to be exported by the entry point index.d.ts
     find: <T = unknown, A = unknown>(options: SavedObjectsFindOptions_2) => Promise<SavedObjectsFindResponsePublic<T, unknown>>;
     get: <T = unknown>(type: string, id: string) => Promise<SimpleSavedObject<T>>;
+    resolve: <T = unknown>(type: string, id: string) => Promise<ResolvedSimpleSavedObject<T>>;
     update<T = unknown>(type: string, id: string, attributes: T, { version, references, upsert }?: SavedObjectsUpdateOptions): Promise<SimpleSavedObject<T>>;
 }
 
@@ -1444,6 +1456,14 @@ export interface SavedObjectsMigrationVersion {
 // @public
 export type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic';
 
+// @public (undocumented)
+export interface SavedObjectsResolveResponse<T = unknown> {
+    aliasTargetId?: string;
+    outcome: 'exactMatch' | 'aliasMatch' | 'conflict';
+    // (undocumented)
+    saved_object: SavedObject<T>;
+}
+
 // @public (undocumented)
 export interface SavedObjectsStart {
     // (undocumented)
@@ -1481,7 +1501,7 @@ export class ScopedHistory<HistoryLocationState = unknown> implements History<Hi
 
 // @public
 export class SimpleSavedObject<T = unknown> {
-    constructor(client: SavedObjectsClientContract, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, }: SavedObject<T>);
+    constructor(client: SavedObjectsClientContract, { id, type, version, attributes, error, references, migrationVersion, coreMigrationVersion, namespaces, }: SavedObject<T>);
     // (undocumented)
     attributes: T;
     // (undocumented)
@@ -1499,6 +1519,8 @@ export class SimpleSavedObject<T = unknown> {
     // (undocumented)
     migrationVersion: SavedObject<T>['migrationVersion'];
     // (undocumented)
+    namespaces: SavedObject<T>['namespaces'];
+    // (undocumented)
     references: SavedObject<T>['references'];
     // (undocumented)
     save(): Promise<SimpleSavedObject<T>>;

src/core/public/saved_objects/index.ts

@@ -17,8 +17,10 @@ export type {
   SavedObjectsCreateOptions,
   SavedObjectsFindResponsePublic,
   SavedObjectsUpdateOptions,
+  SavedObjectsResolveResponse,
   SavedObjectsBulkUpdateOptions,
 } from './saved_objects_client';
+export { ResolvedSimpleSavedObject } from './resolved_simple_saved_object';
 export { SimpleSavedObject } from './simple_saved_object';
 export type { SavedObjectsStart } from './saved_objects_service';
 export type {