instantsearch.js 4.59.0 → 4.60.0

package/es/lib/InstantSearch.js

@@ -21,7 +21,7 @@ import { createMetadataMiddleware, isMetadataEnabled } from "../middlewares/crea
 import { createRouterMiddleware } from "../middlewares/createRouterMiddleware.js";
 import index from "../widgets/index/index.js";
 import createHelpers from "./createHelpers.js";
-import { createDocumentationMessageGenerator, createDocumentationLink, defer, noop, warning, setIndexHelperState, isIndexWidget } from "./utils/index.js";
+import { createDocumentationMessageGenerator, createDocumentationLink, defer, hydrateSearchClient, noop, warning, setIndexHelperState, isIndexWidget } from "./utils/index.js";
 import version from "./version.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'instantsearch'
@@ -449,6 +449,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
         uiState: this._initialUiState
       });
       if (this._initialResults) {
+        hydrateSearchClient(this.client, this._initialResults);
         var originalScheduleSearch = this.scheduleSearch;
         // We don't schedule a first search when initial results are provided
         // because we already have the results to render. This skips the initial

package/es/lib/utils/hydrateSearchClient.d.ts

@@ -0,0 +1,2 @@
+import type { InitialResults, SearchClient } from '../../types';
+export declare function hydrateSearchClient(client: SearchClient, results?: InitialResults): void;

package/es/lib/utils/hydrateSearchClient.js

@@ -0,0 +1,110 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+// @ts-nocheck (types to be fixed during actual implementation)
+
+export function hydrateSearchClient(client, results) {
+  if (!results) {
+    return;
+  }
+
+  // Disable cache hydration on:
+  // - Algoliasearch API Client < v4 with cache disabled
+  // - Third party clients (detected by the `addAlgoliaAgent` function missing)
+
+  if ((!client.transporter || client._cacheHydrated) && (!client._useCache || typeof client.addAlgoliaAgent !== 'function')) {
+    return;
+  }
+
+  // Algoliasearch API Client >= v4
+  // To hydrate the client we need to populate the cache with the data from
+  // the server (done in `hydrateSearchClientWithMultiIndexRequest` or
+  // `hydrateSearchClientWithSingleIndexRequest`). But since there is no way
+  // for us to compute the key the same way as `algoliasearch-client` we need
+  // to populate it on a custom key and override the `search` method to
+  // search on it first.
+  if (client.transporter && !client._cacheHydrated) {
+    client._cacheHydrated = true;
+    var baseMethod = client.search;
+    client.search = function (requests) {
+      for (var _len = arguments.length, methodArgs = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+        methodArgs[_key - 1] = arguments[_key];
+      }
+      var requestsWithSerializedParams = requests.map(function (request) {
+        return _objectSpread(_objectSpread({}, request), {}, {
+          params: serializeQueryParameters(request.params)
+        });
+      });
+      return client.transporter.responsesCache.get({
+        method: 'search',
+        args: [requestsWithSerializedParams].concat(methodArgs)
+      }, function () {
+        return baseMethod.apply(void 0, [requests].concat(methodArgs));
+      });
+    };
+
+    // Populate the cache with the data from the server
+    client.transporter.responsesCache.set({
+      method: 'search',
+      args: [Object.keys(results).reduce(function (acc, key) {
+        return acc.concat(results[key].results.map(function (request) {
+          return {
+            indexName: request.index,
+            params: request.params
+          };
+        }));
+      }, [])]
+    }, {
+      results: Object.keys(results).reduce(function (acc, key) {
+        return acc.concat(results[key].results);
+      }, [])
+    });
+  }
+
+  // Algoliasearch API Client < v4
+  // Prior to client v4 we didn't have a proper API to hydrate the client
+  // cache from the outside. The following code populates the cache with
+  // a single-index result. You can find more information about the
+  // computation of the key inside the client (see link below).
+  // https://github.com/algolia/algoliasearch-client-javascript/blob/c27e89ff92b2a854ae6f40dc524bffe0f0cbc169/src/AlgoliaSearchCore.js#L232-L240
+  if (!client.transporter) {
+    var cacheKey = "/1/indexes/*/queries_body_".concat(JSON.stringify({
+      requests: Object.keys(results).reduce(function (acc, key) {
+        return acc.concat(results[key].rawResults.map(function (request) {
+          return {
+            indexName: request.index,
+            params: request.params
+          };
+        }));
+      }, [])
+    }));
+    client.cache = _objectSpread(_objectSpread({}, client.cache), {}, _defineProperty({}, cacheKey, JSON.stringify({
+      results: Object.keys(results).reduce(function (acc, key) {
+        return acc.concat(results[key].rawResults);
+      }, [])
+    })));
+  }
+}
+
+// This function is copied from the algoliasearch v4 API Client. If modified,
+// consider updating it also in `serializeQueryParameters` from `@algolia/transporter`.
+function serializeQueryParameters(parameters) {
+  var isObjectOrArray = function isObjectOrArray(value) {
+    return Object.prototype.toString.call(value) === '[object Object]' || Object.prototype.toString.call(value) === '[object Array]';
+  };
+  var encode = function encode(format) {
+    for (var _len2 = arguments.length, args = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+      args[_key2 - 1] = arguments[_key2];
+    }
+    var i = 0;
+    return format.replace(/%s/g, function () {
+      return encodeURIComponent(args[i++]);
+    });
+  };
+  return Object.keys(parameters).map(function (key) {
+    return encode('%s=%s', key, isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key]);
+  }).join('&');
+}

package/es/lib/utils/index.d.ts

@@ -27,6 +27,7 @@ export * from './getRefinements';
 export * from './getWidgetAttribute';
 export * from './hits-absolute-position';
 export * from './hits-query-id';
+export * from './hydrateSearchClient';
 export * from './isDomElement';
 export * from './isEqual';
 export * from './isFacetRefined';

package/es/lib/utils/index.js

@@ -27,6 +27,7 @@ export * from "./getRefinements.js";
 export * from "./getWidgetAttribute.js";
 export * from "./hits-absolute-position.js";
 export * from "./hits-query-id.js";
+export * from "./hydrateSearchClient.js";
 export * from "./isDomElement.js";
 export * from "./isEqual.js";
 export * from "./isFacetRefined.js";

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.59.0";
+declare const _default: "4.60.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.59.0';
+export default '4.60.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.59.0",
+  "version": "4.60.0",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -55,9 +55,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.28.0",
-    "@instantsearch/tests": "1.28.0",
-    "@instantsearch/testutils": "1.17.0",
+    "@instantsearch/mocks": "1.29.0",
+    "@instantsearch/tests": "1.29.0",
+    "@instantsearch/testutils": "1.18.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
@@ -65,5 +65,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.41.5"
   },
-  "gitHead": "8fb537f2301a5e133e9e5df20c7c208cae16b3aa"
+  "gitHead": "cacb63f88ce9f215e8f65af2b497e615a58b296e"
 }