wip

wip

docs

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

@@ -17,6 +17,7 @@ export interface ISearchSetup
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [aggs](./kibana-plugin-plugins-data-public.isearchsetup.aggs.md) | <code>AggsSetup</code> |  |
-|  [session](./kibana-plugin-plugins-data-public.isearchsetup.session.md) | <code>ISessionService</code> | session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
+|  [session](./kibana-plugin-plugins-data-public.isearchsetup.session.md) | <code>ISessionService</code> | Current session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
+|  [sessionsClient](./kibana-plugin-plugins-data-public.isearchsetup.sessionsclient.md) | <code>ISessionsClient</code> | Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md) |
 |  [usageCollector](./kibana-plugin-plugins-data-public.isearchsetup.usagecollector.md) | <code>SearchUsageCollector</code> |  |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.session.md

@@ -4,7 +4,7 @@
 
 ## ISearchSetup.session property
 
-session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
+Current session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
 
 <b>Signature:</b>
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchsetup.sessionsclient.md

@@ -0,0 +1,13 @@
+<!-- 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; [ISearchSetup](./kibana-plugin-plugins-data-public.isearchsetup.md) &gt; [sessionsClient](./kibana-plugin-plugins-data-public.isearchsetup.sessionsclient.md)
+
+## ISearchSetup.sessionsClient property
+
+Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md)
+
+<b>Signature:</b>
+
+```typescript
+sessionsClient: ISessionsClient;
+```

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

@@ -19,6 +19,7 @@ export interface ISearchStart
 |  [aggs](./kibana-plugin-plugins-data-public.isearchstart.aggs.md) | <code>AggsStart</code> | agg config sub service [AggsStart](./kibana-plugin-plugins-data-public.aggsstart.md) |
 |  [search](./kibana-plugin-plugins-data-public.isearchstart.search.md) | <code>ISearchGeneric</code> | low level search [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) |
 |  [searchSource](./kibana-plugin-plugins-data-public.isearchstart.searchsource.md) | <code>ISearchStartSearchSource</code> | high level search [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) |
-|  [session](./kibana-plugin-plugins-data-public.isearchstart.session.md) | <code>ISessionService</code> | session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
+|  [session](./kibana-plugin-plugins-data-public.isearchstart.session.md) | <code>ISessionService</code> | Current session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |
+|  [sessionsClient](./kibana-plugin-plugins-data-public.isearchstart.sessionsclient.md) | <code>ISessionsClient</code> | Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md) |
 |  [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md) | <code>(e: Error) =&gt; void</code> |  |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.session.md

@@ -4,7 +4,7 @@
 
 ## ISearchStart.session property
 
-session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
+Current session management [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
 
 <b>Signature:</b>
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.sessionsclient.md

@@ -0,0 +1,13 @@
+<!-- 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; [ISearchStart](./kibana-plugin-plugins-data-public.isearchstart.md) &gt; [sessionsClient](./kibana-plugin-plugins-data-public.isearchstart.sessionsclient.md)
+
+## ISearchStart.sessionsClient property
+
+Background search sessions SO CRUD [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md)
+
+<b>Signature:</b>
+
+```typescript
+sessionsClient: ISessionsClient;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md)
+
+## ISessionsClient type
+
+<b>Signature:</b>
+
+```typescript
+export declare type ISessionsClient = PublicContract<SessionsClient>;
+```

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

@@ -2,28 +2,10 @@
 
 [Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md)
 
-## ISessionService interface
+## ISessionService type
 
 <b>Signature:</b>
 
 ```typescript
-export interface ISessionService 
+export declare type ISessionService = PublicContract<SessionService>;
 ```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [clear](./kibana-plugin-plugins-data-public.isessionservice.clear.md) | <code>() =&gt; void</code> | Clears the active session. |
-|  [delete](./kibana-plugin-plugins-data-public.isessionservice.delete.md) | <code>(sessionId: string) =&gt; Promise&lt;void&gt;</code> | Deletes a session |
-|  [find](./kibana-plugin-plugins-data-public.isessionservice.find.md) | <code>(options: SearchSessionFindOptions) =&gt; Promise&lt;SavedObjectsFindResponse&lt;BackgroundSessionSavedObjectAttributes&gt;&gt;</code> | Gets a list of saved sessions |
-|  [get](./kibana-plugin-plugins-data-public.isessionservice.get.md) | <code>(sessionId: string) =&gt; Promise&lt;SavedObject&lt;BackgroundSessionSavedObjectAttributes&gt;&gt;</code> | Gets a saved session |
-|  [getSession$](./kibana-plugin-plugins-data-public.isessionservice.getsession_.md) | <code>() =&gt; Observable&lt;string &#124; undefined&gt;</code> | Returns the observable that emits an update every time the session ID changes |
-|  [getSessionId](./kibana-plugin-plugins-data-public.isessionservice.getsessionid.md) | <code>() =&gt; string &#124; undefined</code> | Returns the active session ID |
-|  [isRestore](./kibana-plugin-plugins-data-public.isessionservice.isrestore.md) | <code>() =&gt; boolean</code> | Whether the active session is restored (i.e. reusing previous search IDs) |
-|  [isStored](./kibana-plugin-plugins-data-public.isessionservice.isstored.md) | <code>() =&gt; boolean</code> | Whether the active session is already saved (i.e. sent to background) |
-|  [restore](./kibana-plugin-plugins-data-public.isessionservice.restore.md) | <code>(sessionId: string) =&gt; Promise&lt;SavedObject&lt;BackgroundSessionSavedObjectAttributes&gt;&gt;</code> | Restores existing session |
-|  [save](./kibana-plugin-plugins-data-public.isessionservice.save.md) | <code>(name: string, url: string) =&gt; Promise&lt;SavedObject&lt;BackgroundSessionSavedObjectAttributes&gt;&gt;</code> | Saves a session |
-|  [start](./kibana-plugin-plugins-data-public.isessionservice.start.md) | <code>() =&gt; string</code> | Starts a new session |
-|  [update](./kibana-plugin-plugins-data-public.isessionservice.update.md) | <code>(sessionId: string, attributes: Partial&lt;BackgroundSessionSavedObjectAttributes&gt;) =&gt; Promise&lt;any&gt;</code> | Updates a session |
-

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

@@ -34,6 +34,7 @@
 |  [KBN\_FIELD\_TYPES](./kibana-plugin-plugins-data-public.kbn_field_types.md) | \* |
 |  [METRIC\_TYPES](./kibana-plugin-plugins-data-public.metric_types.md) |  |
 |  [QuerySuggestionTypes](./kibana-plugin-plugins-data-public.querysuggestiontypes.md) |  |
+|  [SessionState](./kibana-plugin-plugins-data-public.sessionstate.md) | Possible state that current session can be in |
 |  [SortDirection](./kibana-plugin-plugins-data-public.sortdirection.md) |  |
 |  [TimeoutErrorMode](./kibana-plugin-plugins-data-public.timeouterrormode.md) |  |
 
@@ -74,7 +75,6 @@
 |  [ISearchSetup](./kibana-plugin-plugins-data-public.isearchsetup.md) | The setup contract exposed by the Search plugin exposes the search strategy extension point. |
 |  [ISearchStart](./kibana-plugin-plugins-data-public.isearchstart.md) | search service |
 |  [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) | high level search service |
-|  [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |  |
 |  [KueryNode](./kibana-plugin-plugins-data-public.kuerynode.md) |  |
 |  [OptionedValueProp](./kibana-plugin-plugins-data-public.optionedvalueprop.md) |  |
 |  [QueryState](./kibana-plugin-plugins-data-public.querystate.md) | All query state service state |
@@ -89,6 +89,7 @@
 |  [SavedQueryService](./kibana-plugin-plugins-data-public.savedqueryservice.md) |  |
 |  [SearchError](./kibana-plugin-plugins-data-public.searcherror.md) |  |
 |  [SearchInterceptorDeps](./kibana-plugin-plugins-data-public.searchinterceptordeps.md) |  |
+|  [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md) | Provide info about current search session to be stored in backgroundSearch saved object |
 |  [SearchSourceFields](./kibana-plugin-plugins-data-public.searchsourcefields.md) | search source fields |
 |  [TabbedAggColumn](./kibana-plugin-plugins-data-public.tabbedaggcolumn.md) | \* |
 |  [TabbedTable](./kibana-plugin-plugins-data-public.tabbedtable.md) | \* |
@@ -165,6 +166,8 @@
 |  [InputTimeRange](./kibana-plugin-plugins-data-public.inputtimerange.md) |  |
 |  [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) |  |
 |  [ISearchSource](./kibana-plugin-plugins-data-public.isearchsource.md) | search source interface |
+|  [ISessionsClient](./kibana-plugin-plugins-data-public.isessionsclient.md) |  |
+|  [ISessionService](./kibana-plugin-plugins-data-public.isessionservice.md) |  |
 |  [KibanaContext](./kibana-plugin-plugins-data-public.kibanacontext.md) |  |
 |  [MatchAllFilter](./kibana-plugin-plugins-data-public.matchallfilter.md) |  |
 |  [ParsedInterval](./kibana-plugin-plugins-data-public.parsedinterval.md) |  |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.getname.md

@@ -0,0 +1,13 @@
+<!-- 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; [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md) &gt; [getName](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.getname.md)
+
+## SearchSessionRestorationInfoProvider.getName property
+
+User-facing name of the session. e.g. will be displayed in background sessions management list
+
+<b>Signature:</b>
+
+```typescript
+getName: () => Promise<string>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.geturlgeneratordata.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; [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md) &gt; [getUrlGeneratorData](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.geturlgeneratordata.md)
+
+## SearchSessionRestorationInfoProvider.getUrlGeneratorData property
+
+<b>Signature:</b>
+
+```typescript
+getUrlGeneratorData: () => Promise<{
+        urlGeneratorId: ID;
+        initialState: UrlGeneratorStateMapping[ID]['State'];
+        restoreState: UrlGeneratorStateMapping[ID]['State'];
+    }>;
+```

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

@@ -0,0 +1,21 @@
+<!-- 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; [SearchSessionRestorationInfoProvider](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.md)
+
+## SearchSessionRestorationInfoProvider interface
+
+Provide info about current search session to be stored in backgroundSearch saved object
+
+<b>Signature:</b>
+
+```typescript
+export interface SearchSessionRestorationInfoProvider<ID extends UrlGeneratorId = UrlGeneratorId> 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [getName](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.getname.md) | <code>() =&gt; Promise&lt;string&gt;</code> | User-facing name of the session. e.g. will be displayed in background sessions management list |
+|  [getUrlGeneratorData](./kibana-plugin-plugins-data-public.searchsessionrestorationinfoprovider.geturlgeneratordata.md) | <code>() =&gt; Promise&lt;{</code><br/><code>        urlGeneratorId: ID;</code><br/><code>        initialState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>        restoreState: UrlGeneratorStateMapping[ID]['State'];</code><br/><code>    }&gt;</code> |  |
+