feat(store): add serializing capabilities

Author: rayrutjes

src/helper-serializer.js

@@ -0,0 +1,34 @@
+import algoliaClient from 'algoliasearch';
+import algoliaHelper from 'algoliasearch-helper';
+
+export const serialize = function(helper) {
+  if (!(helper instanceof algoliaHelper.AlgoliaSearchHelper)) {
+    throw new TypeError('Serialize expects an algolia helper instance.');
+  }
+
+  const client = helper.getClient();
+
+  const serialized = {
+    searchParameters: Object.assign({}, helper.state),
+    appId: client.applicationID,
+    apiKey: client.apiKey,
+    response: helper.lastResults._rawResults,
+  };
+
+  return serialized;
+};
+
+export const unserialize = function(data) {
+  const client = algoliaClient(data.appId, data.apiKey);
+  const helper = algoliaHelper(
+    client,
+    data.searchParameters.index,
+    data.searchParameters
+  );
+  helper.lastResults = new algoliaHelper.SearchResults(
+    helper.state,
+    data.response
+  );
+
+  return helper;
+};

src/instantsearch.js

@@ -6,6 +6,7 @@ import {
   HIGHLIGHT_POST_TAG,
   createFromAlgoliaCredentials,
   createFromAlgoliaClient,
+  createFromSerialized,
   Store,
 } from './store';
 
@@ -85,6 +86,7 @@ export {
   HIGHLIGHT_POST_TAG,
   createFromAlgoliaCredentials,
   createFromAlgoliaClient,
+  createFromSerialized,
   Store,
   Index,
   Highlight,

src/store.js

@@ -1,6 +1,10 @@
 import algolia from 'algoliasearch';
 import algoliaHelper from 'algoliasearch-helper';
 import { version } from '../package.json';
+import {
+  serialize as serializeHelper,
+  unserialize as unserializeHelper,
+} from './helper-serializer';
 
 export const FACET_AND = 'and';
 export const FACET_OR = 'or';
@@ -30,6 +34,12 @@ export const createFromAlgoliaClient = client => {
   return new Store(helper);
 };
 
+export const createFromSerialized = data => {
+  const helper = unserializeHelper(data);
+
+  return new Store(helper);
+};
+
 const onHelperChange = function() {
   if (this._stoppedCounter === 0) {
     this.refresh();
@@ -319,6 +329,10 @@ export class Store {
     this._helper.setState(newSearchParameters);
   }
 
+  serialize() {
+    return serializeHelper(this._helper);
+  }
+
   // Todo: find a better name for this function.
   refresh() {
     this._helper.search();