@algolia/recommend 4.14.2 → 5.0.0-alpha.3

package/dist/recommend.esm.browser.js

@@ -1,509 +1,530 @@
-function createBrowserLocalStorageCache(options) {
-    const namespaceKey = `algoliasearch-client-js-${options.key}`;
-    // eslint-disable-next-line functional/no-let
-    let storage;
-    const getStorage = () => {
-        if (storage === undefined) {
-            storage = options.localStorage || window.localStorage;
-        }
-        return storage;
-    };
-    const getNamespace = () => {
-        return JSON.parse(getStorage().getItem(namespaceKey) || '{}');
-    };
-    return {
-        get(key, defaultValue, events = {
-            miss: () => Promise.resolve(),
-        }) {
-            return Promise.resolve()
-                .then(() => {
-                const keyAsString = JSON.stringify(key);
-                const value = getNamespace()[keyAsString];
-                return Promise.all([value || defaultValue(), value !== undefined]);
-            })
-                .then(([value, exists]) => {
-                return Promise.all([value, exists || events.miss(value)]);
-            })
-                .then(([value]) => value);
-        },
-        set(key, value) {
-            return Promise.resolve().then(() => {
-                const namespace = getNamespace();
-                // eslint-disable-next-line functional/immutable-data
-                namespace[JSON.stringify(key)] = value;
-                getStorage().setItem(namespaceKey, JSON.stringify(namespace));
-                return value;
-            });
-        },
-        delete(key) {
-            return Promise.resolve().then(() => {
-                const namespace = getNamespace();
-                // eslint-disable-next-line functional/immutable-data
-                delete namespace[JSON.stringify(key)];
-                getStorage().setItem(namespaceKey, JSON.stringify(namespace));
-            });
-        },
-        clear() {
-            return Promise.resolve().then(() => {
-                getStorage().removeItem(namespaceKey);
-            });
-        },
-    };
+function createAuth(appId, apiKey, authMode = 'WithinHeaders') {
+  const credentials = {
+    'x-algolia-api-key': apiKey,
+    'x-algolia-application-id': appId
+  };
+  return {
+    headers() {
+      return authMode === 'WithinHeaders' ? credentials : {};
+    },
+
+    queryParameters() {
+      return authMode === 'WithinQueryParameters' ? credentials : {};
+    }
+
+  };
 }
 
-// @todo Add logger on options to debug when caches go wrong.
-function createFallbackableCache(options) {
-    const caches = [...options.caches];
-    const current = caches.shift(); // eslint-disable-line functional/immutable-data
-    if (current === undefined) {
-        return createNullCache();
-    }
-    return {
-        get(key, defaultValue, events = {
-            miss: () => Promise.resolve(),
-        }) {
-            return current.get(key, defaultValue, events).catch(() => {
-                return createFallbackableCache({ caches }).get(key, defaultValue, events);
-            });
-        },
-        set(key, value) {
-            return current.set(key, value).catch(() => {
-                return createFallbackableCache({ caches }).set(key, value);
-            });
-        },
-        delete(key) {
-            return current.delete(key).catch(() => {
-                return createFallbackableCache({ caches }).delete(key);
-            });
-        },
-        clear() {
-            return current.clear().catch(() => {
-                return createFallbackableCache({ caches }).clear();
-            });
-        },
-    };
+function createBrowserLocalStorageCache(options) {
+  let storage; // We've changed the namespace to avoid conflicts with v4, as this version is a huge breaking change
+
+  const namespaceKey = `algolia-client-js-${options.key}`;
+
+  function getStorage() {
+    if (storage === undefined) {
+      storage = options.localStorage || window.localStorage;
+    }
+
+    return storage;
+  }
+
+  function getNamespace() {
+    return JSON.parse(getStorage().getItem(namespaceKey) || '{}');
+  }
+
+  return {
+    get(key, defaultValue, events = {
+      miss: () => Promise.resolve()
+    }) {
+      return Promise.resolve().then(() => {
+        const keyAsString = JSON.stringify(key);
+        const value = getNamespace()[keyAsString];
+        return Promise.all([value || defaultValue(), value !== undefined]);
+      }).then(([value, exists]) => {
+        return Promise.all([value, exists || events.miss(value)]);
+      }).then(([value]) => value);
+    },
+
+    set(key, value) {
+      return Promise.resolve().then(() => {
+        const namespace = getNamespace();
+        namespace[JSON.stringify(key)] = value;
+        getStorage().setItem(namespaceKey, JSON.stringify(namespace));
+        return value;
+      });
+    },
+
+    delete(key) {
+      return Promise.resolve().then(() => {
+        const namespace = getNamespace();
+        delete namespace[JSON.stringify(key)];
+        getStorage().setItem(namespaceKey, JSON.stringify(namespace));
+      });
+    },
+
+    clear() {
+      return Promise.resolve().then(() => {
+        getStorage().removeItem(namespaceKey);
+      });
+    }
+
+  };
 }
 
-function createNullCache() {
-    return {
-        get(_key, defaultValue, events = {
-            miss: () => Promise.resolve(),
-        }) {
-            const value = defaultValue();
-            return value
-                .then(result => Promise.all([result, events.miss(result)]))
-                .then(([result]) => result);
-        },
-        set(_key, value) {
-            return Promise.resolve(value);
-        },
-        delete(_key) {
-            return Promise.resolve();
-        },
-        clear() {
-            return Promise.resolve();
-        },
-    };
+function createNullCache() {
+  return {
+    get(_key, defaultValue, events = {
+      miss: () => Promise.resolve()
+    }) {
+      const value = defaultValue();
+      return value.then(result => Promise.all([result, events.miss(result)])).then(([result]) => result);
+    },
+
+    set(_key, value) {
+      return Promise.resolve(value);
+    },
+
+    delete(_key) {
+      return Promise.resolve();
+    },
+
+    clear() {
+      return Promise.resolve();
+    }
+
+  };
 }
 
-function createInMemoryCache(options = { serializable: true }) {
-    // eslint-disable-next-line functional/no-let
-    let cache = {};
-    return {
-        get(key, defaultValue, events = {
-            miss: () => Promise.resolve(),
-        }) {
-            const keyAsString = JSON.stringify(key);
-            if (keyAsString in cache) {
-                return Promise.resolve(options.serializable ? JSON.parse(cache[keyAsString]) : cache[keyAsString]);
-            }
-            const promise = defaultValue();
-            const miss = (events && events.miss) || (() => Promise.resolve());
-            return promise.then((value) => miss(value)).then(() => promise);
-        },
-        set(key, value) {
-            // eslint-disable-next-line functional/immutable-data
-            cache[JSON.stringify(key)] = options.serializable ? JSON.stringify(value) : value;
-            return Promise.resolve(value);
-        },
-        delete(key) {
-            // eslint-disable-next-line functional/immutable-data
-            delete cache[JSON.stringify(key)];
-            return Promise.resolve();
-        },
-        clear() {
-            cache = {};
-            return Promise.resolve();
-        },
-    };
+function createFallbackableCache(options) {
+  const caches = [...options.caches];
+  const current = caches.shift();
+
+  if (current === undefined) {
+    return createNullCache();
+  }
+
+  return {
+    get(key, defaultValue, events = {
+      miss: () => Promise.resolve()
+    }) {
+      return current.get(key, defaultValue, events).catch(() => {
+        return createFallbackableCache({
+          caches
+        }).get(key, defaultValue, events);
+      });
+    },
+
+    set(key, value) {
+      return current.set(key, value).catch(() => {
+        return createFallbackableCache({
+          caches
+        }).set(key, value);
+      });
+    },
+
+    delete(key) {
+      return current.delete(key).catch(() => {
+        return createFallbackableCache({
+          caches
+        }).delete(key);
+      });
+    },
+
+    clear() {
+      return current.clear().catch(() => {
+        return createFallbackableCache({
+          caches
+        }).clear();
+      });
+    }
+
+  };
 }
 
-function createAuth(authMode, appId, apiKey) {
-    const credentials = {
-        'x-algolia-api-key': apiKey,
-        'x-algolia-application-id': appId,
-    };
-    return {
-        headers() {
-            return authMode === AuthMode.WithinHeaders ? credentials : {};
-        },
-        queryParameters() {
-            return authMode === AuthMode.WithinQueryParameters ? credentials : {};
-        },
-    };
+function createMemoryCache(options = {
+  serializable: true
+}) {
+  let cache = {};
+  return {
+    get(key, defaultValue, events = {
+      miss: () => Promise.resolve()
+    }) {
+      const keyAsString = JSON.stringify(key);
+
+      if (keyAsString in cache) {
+        return Promise.resolve(options.serializable ? JSON.parse(cache[keyAsString]) : cache[keyAsString]);
+      }
+
+      const promise = defaultValue();
+      return promise.then(value => events.miss(value)).then(() => promise);
+    },
+
+    set(key, value) {
+      cache[JSON.stringify(key)] = options.serializable ? JSON.stringify(value) : value;
+      return Promise.resolve(value);
+    },
+
+    delete(key) {
+      delete cache[JSON.stringify(key)];
+      return Promise.resolve();
+    },
+
+    clear() {
+      cache = {};
+      return Promise.resolve();
+    }
+
+  };
 }
 
-// eslint-disable-next-line functional/prefer-readonly-type
-function shuffle(array) {
-    let c = array.length - 1; // eslint-disable-line functional/no-let
-    // eslint-disable-next-line functional/no-loop-statement
-    for (c; c > 0; c--) {
-        const b = Math.floor(Math.random() * (c + 1));
-        const a = array[c];
-        array[c] = array[b]; // eslint-disable-line functional/immutable-data, no-param-reassign
-        array[b] = a; // eslint-disable-line functional/immutable-data, no-param-reassign
-    }
-    return array;
-}
-function addMethods(base, methods) {
-    if (!methods) {
-        return base;
-    }
-    Object.keys(methods).forEach(key => {
-        // eslint-disable-next-line functional/immutable-data, no-param-reassign
-        base[key] = methods[key](base);
-    });
-    return base;
-}
-function encode(format, ...args) {
-    // eslint-disable-next-line functional/no-let
-    let i = 0;
-    return format.replace(/%s/g, () => encodeURIComponent(args[i++]));
+// By default, API Clients at Algolia have expiration delay of 5 mins.
+// In the JavaScript client, we have 2 mins.
+const EXPIRATION_DELAY = 2 * 60 * 1000;
+function createStatefulHost(host, status = 'up') {
+  const lastUpdate = Date.now();
+
+  function isUp() {
+    return status === 'up' || Date.now() - lastUpdate > EXPIRATION_DELAY;
+  }
+
+  function isTimedOut() {
+    return status === 'timed out' && Date.now() - lastUpdate <= EXPIRATION_DELAY;
+  }
+
+  return { ...host,
+    status,
+    lastUpdate,
+    isUp,
+    isTimedOut
+  };
 }
 
-const version = '4.14.2';
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+
+  return obj;
+}
+
+class AlgoliaError extends Error {
+  constructor(message, name) {
+    super(message);
+
+    _defineProperty(this, "name", 'AlgoliaError');
+
+    if (name) {
+      this.name = name;
+    }
+  }
 
-const AuthMode = {
-    /**
-     * If auth credentials should be in query parameters.
-     */
-    WithinQueryParameters: 0,
-    /**
-     * If auth credentials should be in headers.
-     */
-    WithinHeaders: 1,
-};
-
-const LogLevelEnum = {
-    Debug: 1,
-    Info: 2,
-    Error: 3,
-};
-
-/* eslint no-console: 0 */
-function createConsoleLogger(logLevel) {
-    return {
-        debug(message, args) {
-            if (LogLevelEnum.Debug >= logLevel) {
-                console.debug(message, args);
-            }
-            return Promise.resolve();
-        },
-        info(message, args) {
-            if (LogLevelEnum.Info >= logLevel) {
-                console.info(message, args);
-            }
-            return Promise.resolve();
-        },
-        error(message, args) {
-            console.error(message, args);
-            return Promise.resolve();
-        },
-    };
 }
+class ErrorWithStackTrace extends AlgoliaError {
+  constructor(message, stackTrace, name) {
+    super(message, name); // the array and object should be frozen to reflect the stackTrace at the time of the error
+
+    _defineProperty(this, "stackTrace", void 0);
+
+    this.stackTrace = stackTrace;
+  }
 
-function createBrowserXhrRequester() {
-    return {
-        send(request) {
-            return new Promise((resolve) => {
-                const baseRequester = new XMLHttpRequest();
-                baseRequester.open(request.method, request.url, true);
-                Object.keys(request.headers).forEach(key => baseRequester.setRequestHeader(key, request.headers[key]));
-                const createTimeout = (timeout, content) => {
-                    return setTimeout(() => {
-                        baseRequester.abort();
-                        resolve({
-                            status: 0,
-                            content,
-                            isTimedOut: true,
-                        });
-                    }, timeout * 1000);
-                };
-                const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
-                // eslint-disable-next-line functional/no-let
-                let responseTimeout;
-                // eslint-disable-next-line functional/immutable-data
-                baseRequester.onreadystatechange = () => {
-                    if (baseRequester.readyState > baseRequester.OPENED && responseTimeout === undefined) {
-                        clearTimeout(connectTimeout);
-                        responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
-                    }
-                };
-                // eslint-disable-next-line functional/immutable-data
-                baseRequester.onerror = () => {
-                    // istanbul ignore next
-                    if (baseRequester.status === 0) {
-                        clearTimeout(connectTimeout);
-                        clearTimeout(responseTimeout);
-                        resolve({
-                            content: baseRequester.responseText || 'Network request failed',
-                            status: baseRequester.status,
-                            isTimedOut: false,
-                        });
-                    }
-                };
-                //  eslint-disable-next-line functional/immutable-data
-                baseRequester.onload = () => {
-                    clearTimeout(connectTimeout);
-                    clearTimeout(responseTimeout);
-                    resolve({
-                        content: baseRequester.responseText,
-                        status: baseRequester.status,
-                        isTimedOut: false,
-                    });
-                };
-                baseRequester.send(request.data);
-            });
-        },
-    };
 }
+class RetryError extends ErrorWithStackTrace {
+  constructor(stackTrace) {
+    super('Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.', stackTrace, 'RetryError');
+  }
 
-function createMappedRequestOptions(requestOptions, timeout) {
-    const options = requestOptions || {};
-    const data = options.data || {};
-    Object.keys(options).forEach(key => {
-        if (['timeout', 'headers', 'queryParameters', 'data', 'cacheable'].indexOf(key) === -1) {
-            data[key] = options[key]; // eslint-disable-line functional/immutable-data
-        }
-    });
-    return {
-        data: Object.entries(data).length > 0 ? data : undefined,
-        timeout: options.timeout || timeout,
-        headers: options.headers || {},
-        queryParameters: options.queryParameters || {},
-        cacheable: options.cacheable,
-    };
 }
+class ApiError extends ErrorWithStackTrace {
+  constructor(message, status, stackTrace) {
+    super(message, stackTrace, 'ApiError');
+
+    _defineProperty(this, "status", void 0);
+
+    this.status = status;
+  }
 
-const CallEnum = {
-    /**
-     * If the host is read only.
-     */
-    Read: 1,
-    /**
-     * If the host is write only.
-     */
-    Write: 2,
-    /**
-     * If the host is both read and write.
-     */
-    Any: 3,
-};
-
-const HostStatusEnum = {
-    Up: 1,
-    Down: 2,
-    Timeouted: 3,
-};
-
-// By default, API Clients at Algolia have expiration delay
-// of 5 mins. In the JavaScript client, we have 2 mins.
-const EXPIRATION_DELAY = 2 * 60 * 1000;
-function createStatefulHost(host, status = HostStatusEnum.Up) {
-    return {
-        ...host,
-        status,
-        lastUpdate: Date.now(),
-    };
-}
-function isStatefulHostUp(host) {
-    return host.status === HostStatusEnum.Up || Date.now() - host.lastUpdate > EXPIRATION_DELAY;
-}
-function isStatefulHostTimeouted(host) {
-    return (host.status === HostStatusEnum.Timeouted && Date.now() - host.lastUpdate <= EXPIRATION_DELAY);
 }
+class DeserializationError extends AlgoliaError {
+  constructor(message, response) {
+    super(message, 'DeserializationError');
+
+    _defineProperty(this, "response", void 0);
+
+    this.response = response;
+  }
 
-function createStatelessHost(options) {
-    if (typeof options === 'string') {
-        return {
-            protocol: 'https',
-            url: options,
-            accept: CallEnum.Any,
-        };
-    }
-    return {
-        protocol: options.protocol || 'https',
-        url: options.url,
-        accept: options.accept || CallEnum.Any,
-    };
 }
 
-const MethodEnum = {
-    Delete: 'DELETE',
-    Get: 'GET',
-    Post: 'POST',
-    Put: 'PUT',
-};
-
-function createRetryableOptions(hostsCache, statelessHosts) {
-    return Promise.all(statelessHosts.map(statelessHost => {
-        return hostsCache.get(statelessHost, () => {
-            return Promise.resolve(createStatefulHost(statelessHost));
-        });
-    })).then(statefulHosts => {
-        const hostsUp = statefulHosts.filter(host => isStatefulHostUp(host));
-        const hostsTimeouted = statefulHosts.filter(host => isStatefulHostTimeouted(host));
-        /**
-         * Note, we put the hosts that previously timeouted on the end of the list.
-         */
-        const hostsAvailable = [...hostsUp, ...hostsTimeouted];
-        const statelessHostsAvailable = hostsAvailable.length > 0
-            ? hostsAvailable.map(host => createStatelessHost(host))
-            : statelessHosts;
-        return {
-            getTimeout(timeoutsCount, baseTimeout) {
-                /**
-                 * Imagine that you have 4 hosts, if timeouts will increase
-                 * on the following way: 1 (timeouted) > 4 (timeouted) > 5 (200)
-                 *
-                 * Note that, the very next request, we start from the previous timeout
-                 *
-                 *  5 (timeouted) > 6 (timeouted) > 7 ...
-                 *
-                 * This strategy may need to be reviewed, but is the strategy on the our
-                 * current v3 version.
-                 */
-                const timeoutMultiplier = hostsTimeouted.length === 0 && timeoutsCount === 0
-                    ? 1
-                    : hostsTimeouted.length + 3 + timeoutsCount;
-                return timeoutMultiplier * baseTimeout;
-            },
-            statelessHosts: statelessHostsAvailable,
-        };
-    });
+function shuffle(array) {
+  const shuffledArray = array;
+
+  for (let c = array.length - 1; c > 0; c--) {
+    const b = Math.floor(Math.random() * (c + 1));
+    const a = array[c];
+    shuffledArray[c] = array[b];
+    shuffledArray[b] = a;
+  }
+
+  return shuffledArray;
 }
+function serializeUrl(host, path, queryParameters) {
+  const queryParametersAsString = serializeQueryParameters(queryParameters);
+  let url = `${host.protocol}://${host.url}/${path.charAt(0) === '/' ? path.substr(1) : path}`;
 
-const isNetworkError = ({ isTimedOut, status }) => {
-    return !isTimedOut && ~~status === 0;
-};
-const isRetryable = (response) => {
-    const status = response.status;
-    const isTimedOut = response.isTimedOut;
-    return (isTimedOut || isNetworkError(response) || (~~(status / 100) !== 2 && ~~(status / 100) !== 4));
-};
-const isSuccess = ({ status }) => {
-    return ~~(status / 100) === 2;
-};
-const retryDecision = (response, outcomes) => {
-    if (isRetryable(response)) {
-        return outcomes.onRetry(response);
-    }
-    if (isSuccess(response)) {
-        return outcomes.onSuccess(response);
-    }
-    return outcomes.onFail(response);
-};
+  if (queryParametersAsString.length) {
+    url += `?${queryParametersAsString}`;
+  }
+
+  return url;
+}
+function serializeQueryParameters(parameters) {
+  const isObjectOrArray = value => Object.prototype.toString.call(value) === '[object Object]' || Object.prototype.toString.call(value) === '[object Array]';
+
+  return Object.keys(parameters).map(key => `${key}=${isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key]}`).join('&');
+}
+function serializeData(request, requestOptions) {
+  if (request.method === 'GET' || request.data === undefined && requestOptions.data === undefined) {
+    return undefined;
+  }
+
+  const data = Array.isArray(request.data) ? request.data : { ...request.data,
+    ...requestOptions.data
+  };
+  return JSON.stringify(data);
+}
+function serializeHeaders(baseHeaders, requestHeaders, requestOptionsHeaders) {
+  const headers = {
+    Accept: 'application/json',
+    ...baseHeaders,
+    ...requestHeaders,
+    ...requestOptionsHeaders
+  };
+  const serializedHeaders = {};
+  Object.keys(headers).forEach(header => {
+    const value = headers[header];
+    serializedHeaders[header.toLowerCase()] = value;
+  });
+  return serializedHeaders;
+}
+function deserializeSuccess(response) {
+  try {
+    return JSON.parse(response.content);
+  } catch (e) {
+    throw new DeserializationError(e.message, response);
+  }
+}
+function deserializeFailure({
+  content,
+  status
+}, stackFrame) {
+  let message = content;
+
+  try {
+    message = JSON.parse(content).message;
+  } catch (e) {// ..
+  }
+
+  return new ApiError(message, status, stackFrame);
+}
+
+function isNetworkError({
+  isTimedOut,
+  status
+}) {
+  return !isTimedOut && ~~status === 0;
+}
+function isRetryable({
+  isTimedOut,
+  status
+}) {
+  return isTimedOut || isNetworkError({
+    isTimedOut,
+    status
+  }) || ~~(status / 100) !== 2 && ~~(status / 100) !== 4;
+}
+function isSuccess({
+  status
+}) {
+  return ~~(status / 100) === 2;
+}
+
+function stackTraceWithoutCredentials(stackTrace) {
+  return stackTrace.map(stackFrame => stackFrameWithoutCredentials(stackFrame));
+}
+function stackFrameWithoutCredentials(stackFrame) {
+  const modifiedHeaders = stackFrame.request.headers['x-algolia-api-key'] ? {
+    'x-algolia-api-key': '*****'
+  } : {};
+  return { ...stackFrame,
+    request: { ...stackFrame.request,
+      headers: { ...stackFrame.request.headers,
+        ...modifiedHeaders
+      }
+    }
+  };
+}
 
-function retryableRequest(transporter, statelessHosts, request, requestOptions) {
-    const stackTrace = []; // eslint-disable-line functional/prefer-readonly-type
+function createTransporter({
+  hosts,
+  hostsCache,
+  baseHeaders,
+  baseQueryParameters,
+  algoliaAgent,
+  timeouts,
+  requester,
+  requestsCache,
+  responsesCache
+}) {
+  async function createRetryableOptions(compatibleHosts) {
+    const statefulHosts = await Promise.all(compatibleHosts.map(compatibleHost => {
+      return hostsCache.get(compatibleHost, () => {
+        return Promise.resolve(createStatefulHost(compatibleHost));
+      });
+    }));
+    const hostsUp = statefulHosts.filter(host => host.isUp());
+    const hostsTimedOut = statefulHosts.filter(host => host.isTimedOut()); // Note, we put the hosts that previously timed out on the end of the list.
+
+    const hostsAvailable = [...hostsUp, ...hostsTimedOut];
+    const compatibleHostsAvailable = hostsAvailable.length > 0 ? hostsAvailable : compatibleHosts;
+    return {
+      hosts: compatibleHostsAvailable,
+
+      getTimeout(timeoutsCount, baseTimeout) {
+        /**
+         * Imagine that you have 4 hosts, if timeouts will increase
+         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
+         *
+         * Note that, the very next request, we start from the previous timeout.
+         *
+         *  5 (timed out) > 6 (timed out) > 7 ...
+         *
+         * This strategy may need to be reviewed, but is the strategy on the our
+         * current v3 version.
+         */
+        const timeoutMultiplier = hostsTimedOut.length === 0 && timeoutsCount === 0 ? 1 : hostsTimedOut.length + 3 + timeoutsCount;
+        return timeoutMultiplier * baseTimeout;
+      }
+
+    };
+  }
+
+  async function retryableRequest(request, requestOptions, isRead = true) {
+    const stackTrace = [];
     /**
      * First we prepare the payload that do not depend from hosts.
-     */
-    const data = serializeData(request, requestOptions);
-    const headers = serializeHeaders(transporter, requestOptions);
-    const method = request.method;
-    // On `GET`, the data is proxied to query parameters.
-    const dataQueryParameters = request.method !== MethodEnum.Get
-        ? {}
-        : {
-            ...request.data,
-            ...requestOptions.data,
-        };
-    const queryParameters = {
-        'x-algolia-agent': transporter.userAgent.value,
-        ...transporter.queryParameters,
-        ...dataQueryParameters,
-        ...requestOptions.queryParameters,
-    };
-    let timeoutsCount = 0; // eslint-disable-line functional/no-let
-    const retry = (hosts, // eslint-disable-line functional/prefer-readonly-type
-    getTimeout) => {
+     */
+
+    const data = serializeData(request, requestOptions);
+    const headers = serializeHeaders(baseHeaders, request.headers, requestOptions.headers); // On `GET`, the data is proxied to query parameters.
+
+    const dataQueryParameters = request.method === 'GET' ? { ...request.data,
+      ...requestOptions.data
+    } : {};
+    const queryParameters = {
+      'x-algolia-agent': algoliaAgent.value,
+      ...baseQueryParameters,
+      ...request.queryParameters,
+      ...dataQueryParameters
+    };
+
+    if (requestOptions && requestOptions.queryParameters) {
+      for (const key of Object.keys(requestOptions.queryParameters)) {
+        // We want to keep `undefined` and `null` values,
+        // but also avoid stringifying `object`s, as they are
+        // handled in the `serializeUrl` step right after.
+        if (!requestOptions.queryParameters[key] || Object.prototype.toString.call(requestOptions.queryParameters[key]) === '[object Object]') {
+          queryParameters[key] = requestOptions.queryParameters[key];
+        } else {
+          queryParameters[key] = requestOptions.queryParameters[key].toString();
+        }
+      }
+    }
+
+    let timeoutsCount = 0;
+
+    const retry = async (retryableHosts, getTimeout) => {
+      /**
+       * We iterate on each host, until there is no host left.
+       */
+      const host = retryableHosts.pop();
+
+      if (host === undefined) {
+        throw new RetryError(stackTraceWithoutCredentials(stackTrace));
+      }
+
+      let responseTimeout = requestOptions.timeout;
+
+      if (responseTimeout === undefined) {
+        responseTimeout = isRead ? timeouts.read : timeouts.write;
+      }
+
+      const payload = {
+        data,
+        headers,
+        method: request.method,
+        url: serializeUrl(host, request.path, queryParameters),
+        connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
+        responseTimeout: getTimeout(timeoutsCount, responseTimeout)
+      };
+      /**
+       * The stackFrame is pushed to the stackTrace so we
+       * can have information about onRetry and onFailure
+       * decisions.
+       */
+
+      const pushToStackTrace = response => {
+        const stackFrame = {
+          request: payload,
+          response,
+          host,
+          triesLeft: retryableHosts.length
+        };
+        stackTrace.push(stackFrame);
+        return stackFrame;
+      };
+
+      const response = await requester.send(payload);
+
+      if (isRetryable(response)) {
+        const stackFrame = pushToStackTrace(response); // If response is a timeout, we increase the number of timeouts so we can increase the timeout later.
+
+        if (response.isTimedOut) {
+          timeoutsCount++;
+        }
         /**
-         * We iterate on each host, until there is no host left.
-         */
-        const host = hosts.pop(); // eslint-disable-line functional/immutable-data
-        if (host === undefined) {
-            throw createRetryError(stackTraceWithoutCredentials(stackTrace));
-        }
-        const payload = {
-            data,
-            headers,
-            method,
-            url: serializeUrl(host, request.path, queryParameters),
-            connectTimeout: getTimeout(timeoutsCount, transporter.timeouts.connect),
-            responseTimeout: getTimeout(timeoutsCount, requestOptions.timeout),
-        };
+         * Failures are individually sent to the logger, allowing
+         * the end user to debug / store stack frames even
+         * when a retry error does not happen.
+         */
+        // eslint-disable-next-line no-console -- this will be fixed by exposing a `logger` to the transporter
+
+
+        console.log('Retryable failure', stackFrameWithoutCredentials(stackFrame));
         /**
-         * The stackFrame is pushed to the stackTrace so we
-         * can have information about onRetry and onFailure
-         * decisions.
-         */
-        const pushToStackTrace = (response) => {
-            const stackFrame = {
-                request: payload,
-                response,
-                host,
-                triesLeft: hosts.length,
-            };
-            // eslint-disable-next-line functional/immutable-data
-            stackTrace.push(stackFrame);
-            return stackFrame;
-        };
-        const decisions = {
-            onSuccess: response => deserializeSuccess(response),
-            onRetry(response) {
-                const stackFrame = pushToStackTrace(response);
-                /**
-                 * If response is a timeout, we increaset the number of
-                 * timeouts so we can increase the timeout later.
-                 */
-                if (response.isTimedOut) {
-                    timeoutsCount++;
-                }
-                return Promise.all([
-                    /**
-                     * Failures are individually send the logger, allowing
-                     * the end user to debug / store stack frames even
-                     * when a retry error does not happen.
-                     */
-                    transporter.logger.info('Retryable failure', stackFrameWithoutCredentials(stackFrame)),
-                    /**
-                     * We also store the state of the host in failure cases. If the host, is
-                     * down it will remain down for the next 2 minutes. In a timeout situation,
-                     * this host will be added end of the list of hosts on the next request.
-                     */
-                    transporter.hostsCache.set(host, createStatefulHost(host, response.isTimedOut ? HostStatusEnum.Timeouted : HostStatusEnum.Down)),
-                ]).then(() => retry(hosts, getTimeout));
-            },
-            onFail(response) {
-                pushToStackTrace(response);
-                throw deserializeFailure(response, stackTraceWithoutCredentials(stackTrace));
-            },
-        };
-        return transporter.requester.send(payload).then(response => {
-            return retryDecision(response, decisions);
-        });
-    };
+         * We also store the state of the host in failure cases. If the host, is
+         * down it will remain down for the next 2 minutes. In a timeout situation,
+         * this host will be added end of the list of hosts on the next request.
+         */
+
+        await hostsCache.set(host, createStatefulHost(host, response.isTimedOut ? 'timed out' : 'down'));
+        return retry(retryableHosts, getTimeout);
+      }
+
+      if (isSuccess(response)) {
+        return deserializeSuccess(response);
+      }
+
+      pushToStackTrace(response);
+      throw deserializeFailure(response, stackTrace);
+    };
     /**
      * Finally, for each retryable host perform request until we got a non
      * retryable response. Some notes here:
@@ -511,387 +532,426 @@ function retryableRequest(transporter, statelessHosts, request, requestOptions)
      * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
      * 2. We also get from the retryable options a timeout multiplier that is tailored
      * for the current context.
-     */
-    return createRetryableOptions(transporter.hostsCache, statelessHosts).then(options => {
-        return retry([...options.statelessHosts].reverse(), options.getTimeout);
-    });
-}
+     */
 
-function createTransporter(options) {
-    const { hostsCache, logger, requester, requestsCache, responsesCache, timeouts, userAgent, hosts, queryParameters, headers, } = options;
-    const transporter = {
-        hostsCache,
-        logger,
-        requester,
-        requestsCache,
-        responsesCache,
-        timeouts,
-        userAgent,
-        headers,
-        queryParameters,
-        hosts: hosts.map(host => createStatelessHost(host)),
-        read(request, requestOptions) {
-            /**
-             * First, we compute the user request options. Now, keep in mind,
-             * that using request options the user is able to modified the intire
-             * payload of the request. Such as headers, query parameters, and others.
-             */
-            const mappedRequestOptions = createMappedRequestOptions(requestOptions, transporter.timeouts.read);
-            const createRetryableRequest = () => {
-                /**
-                 * Then, we prepare a function factory that contains the construction of
-                 * the retryable request. At this point, we may *not* perform the actual
-                 * request. But we want to have the function factory ready.
-                 */
-                return retryableRequest(transporter, transporter.hosts.filter(host => (host.accept & CallEnum.Read) !== 0), request, mappedRequestOptions);
-            };
-            /**
-             * Once we have the function factory ready, we need to determine of the
-             * request is "cacheable" - should be cached. Note that, once again,
-             * the user can force this option.
-             */
-            const cacheable = mappedRequestOptions.cacheable !== undefined
-                ? mappedRequestOptions.cacheable
-                : request.cacheable;
-            /**
-             * If is not "cacheable", we immediatly trigger the retryable request, no
-             * need to check cache implementations.
-             */
-            if (cacheable !== true) {
-                return createRetryableRequest();
-            }
-            /**
-             * If the request is "cacheable", we need to first compute the key to ask
-             * the cache implementations if this request is on progress or if the
-             * response already exists on the cache.
-             */
-            const key = {
-                request,
-                mappedRequestOptions,
-                transporter: {
-                    queryParameters: transporter.queryParameters,
-                    headers: transporter.headers,
-                },
-            };
-            /**
-             * With the computed key, we first ask the responses cache
-             * implemention if this request was been resolved before.
-             */
-            return transporter.responsesCache.get(key, () => {
-                /**
-                 * If the request has never resolved before, we actually ask if there
-                 * is a current request with the same key on progress.
-                 */
-                return transporter.requestsCache.get(key, () => {
-                    return (transporter.requestsCache
-                        /**
-                         * Finally, if there is no request in progress with the same key,
-                         * this `createRetryableRequest()` will actually trigger the
-                         * retryable request.
-                         */
-                        .set(key, createRetryableRequest())
-                        .then(response => Promise.all([transporter.requestsCache.delete(key), response]), err => Promise.all([transporter.requestsCache.delete(key), Promise.reject(err)]))
-                        .then(([_, response]) => response));
-                });
-            }, {
-                /**
-                 * Of course, once we get this response back from the server, we
-                 * tell response cache to actually store the received response
-                 * to be used later.
-                 */
-                miss: response => transporter.responsesCache.set(key, response),
-            });
-        },
-        write(request, requestOptions) {
-            /**
-             * On write requests, no cache mechanisms are applied, and we
-             * proxy the request immediately to the requester.
-             */
-            return retryableRequest(transporter, transporter.hosts.filter(host => (host.accept & CallEnum.Write) !== 0), request, createMappedRequestOptions(requestOptions, transporter.timeouts.write));
-        },
-    };
-    return transporter;
-}
 
-function createUserAgent(version) {
-    const userAgent = {
-        value: `Algolia for JavaScript (${version})`,
-        add(options) {
-            const addedUserAgent = `; ${options.segment}${options.version !== undefined ? ` (${options.version})` : ''}`;
-            if (userAgent.value.indexOf(addedUserAgent) === -1) {
-                // eslint-disable-next-line functional/immutable-data
-                userAgent.value = `${userAgent.value}${addedUserAgent}`;
-            }
-            return userAgent;
-        },
-    };
-    return userAgent;
-}
+    const compatibleHosts = hosts.filter(host => host.accept === 'readWrite' || (isRead ? host.accept === 'read' : host.accept === 'write'));
+    const options = await createRetryableOptions(compatibleHosts);
+    return retry([...options.hosts].reverse(), options.getTimeout);
+  }
 
-function deserializeSuccess(response) {
-    // eslint-disable-next-line functional/no-try-statement
-    try {
-        return JSON.parse(response.content);
-    }
-    catch (e) {
-        throw createDeserializationError(e.message, response);
-    }
-}
-function deserializeFailure({ content, status }, stackFrame) {
-    // eslint-disable-next-line functional/no-let
-    let message = content;
-    // eslint-disable-next-line functional/no-try-statement
-    try {
-        message = JSON.parse(content).message;
-    }
-    catch (e) {
-        // ..
-    }
-    return createApiError(message, status, stackFrame);
-}
+  function createRequest(request, requestOptions = {}) {
+    /**
+     * A read request is either a `GET` request, or a request that we make
+     * via the `read` transporter (e.g. `search`).
+     */
+    const isRead = request.useReadTransporter || request.method === 'GET';
+
+    if (!isRead) {
+      /**
+       * On write requests, no cache mechanisms are applied, and we
+       * proxy the request immediately to the requester.
+       */
+      return retryableRequest(request, requestOptions, isRead);
+    }
+
+    const createRetryableRequest = () => {
+      /**
+       * Then, we prepare a function factory that contains the construction of
+       * the retryable request. At this point, we may *not* perform the actual
+       * request. But we want to have the function factory ready.
+       */
+      return retryableRequest(request, requestOptions);
+    };
+    /**
+     * Once we have the function factory ready, we need to determine of the
+     * request is "cacheable" - should be cached. Note that, once again,
+     * the user can force this option.
+     */
 
-function serializeUrl(host, path, queryParameters) {
-    const queryParametersAsString = serializeQueryParameters(queryParameters);
-    // eslint-disable-next-line functional/no-let
-    let url = `${host.protocol}://${host.url}/${path.charAt(0) === '/' ? path.substr(1) : path}`;
-    if (queryParametersAsString.length) {
-        url += `?${queryParametersAsString}`;
-    }
-    return url;
-}
-function serializeQueryParameters(parameters) {
-    const isObjectOrArray = (value) => Object.prototype.toString.call(value) === '[object Object]' ||
-        Object.prototype.toString.call(value) === '[object Array]';
-    return Object.keys(parameters)
-        .map(key => encode('%s=%s', key, isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key]))
-        .join('&');
-}
-function serializeData(request, requestOptions) {
-    if (request.method === MethodEnum.Get ||
-        (request.data === undefined && requestOptions.data === undefined)) {
-        return undefined;
-    }
-    const data = Array.isArray(request.data)
-        ? request.data
-        : { ...request.data, ...requestOptions.data };
-    return JSON.stringify(data);
-}
-function serializeHeaders(transporter, requestOptions) {
-    const headers = {
-        ...transporter.headers,
-        ...requestOptions.headers,
-    };
-    const serializedHeaders = {};
-    Object.keys(headers).forEach(header => {
-        const value = headers[header];
-        // @ts-ignore
-        // eslint-disable-next-line functional/immutable-data
-        serializedHeaders[header.toLowerCase()] = value;
-    });
-    return serializedHeaders;
-}
 
-function stackTraceWithoutCredentials(stackTrace) {
-    return stackTrace.map(stackFrame => stackFrameWithoutCredentials(stackFrame));
-}
-function stackFrameWithoutCredentials(stackFrame) {
-    const modifiedHeaders = stackFrame.request.headers['x-algolia-api-key']
-        ? { 'x-algolia-api-key': '*****' }
-        : {};
-    return {
-        ...stackFrame,
-        request: {
-            ...stackFrame.request,
-            headers: {
-                ...stackFrame.request.headers,
-                ...modifiedHeaders,
-            },
-        },
-    };
+    const cacheable = requestOptions.cacheable || request.cacheable;
+    /**
+     * If is not "cacheable", we immediately trigger the retryable request, no
+     * need to check cache implementations.
+     */
+
+    if (cacheable !== true) {
+      return createRetryableRequest();
+    }
+    /**
+     * If the request is "cacheable", we need to first compute the key to ask
+     * the cache implementations if this request is on progress or if the
+     * response already exists on the cache.
+     */
+
+
+    const key = {
+      request,
+      requestOptions,
+      transporter: {
+        queryParameters: baseQueryParameters,
+        headers: baseHeaders
+      }
+    };
+    /**
+     * With the computed key, we first ask the responses cache
+     * implementation if this request was been resolved before.
+     */
+
+    return responsesCache.get(key, () => {
+      /**
+       * If the request has never resolved before, we actually ask if there
+       * is a current request with the same key on progress.
+       */
+      return requestsCache.get(key, () =>
+      /**
+       * Finally, if there is no request in progress with the same key,
+       * this `createRetryableRequest()` will actually trigger the
+       * retryable request.
+       */
+      requestsCache.set(key, createRetryableRequest()).then(response => Promise.all([requestsCache.delete(key), response]), err => Promise.all([requestsCache.delete(key), Promise.reject(err)])).then(([_, response]) => response));
+    }, {
+      /**
+       * Of course, once we get this response back from the server, we
+       * tell response cache to actually store the received response
+       * to be used later.
+       */
+      miss: response => responsesCache.set(key, response)
+    });
+  }
+
+  return {
+    hostsCache,
+    requester,
+    timeouts,
+    algoliaAgent,
+    baseHeaders,
+    baseQueryParameters,
+    hosts,
+    request: createRequest,
+    requestsCache,
+    responsesCache
+  };
 }
 
-function createApiError(message, status, transporterStackTrace) {
-    return {
-        name: 'ApiError',
-        message,
-        status,
-        transporterStackTrace,
-    };
+function createAlgoliaAgent(version) {
+  const algoliaAgent = {
+    value: `Algolia for JavaScript (${version})`,
+
+    add(options) {
+      const addedAlgoliaAgent = `; ${options.segment}${options.version !== undefined ? ` (${options.version})` : ''}`;
+
+      if (algoliaAgent.value.indexOf(addedAlgoliaAgent) === -1) {
+        algoliaAgent.value = `${algoliaAgent.value}${addedAlgoliaAgent}`;
+      }
+
+      return algoliaAgent;
+    }
+
+  };
+  return algoliaAgent;
 }
 
-function createDeserializationError(message, response) {
-    return {
-        name: 'DeserializationError',
-        message,
-        response,
-    };
+function getAlgoliaAgent({
+  algoliaAgents,
+  client,
+  version
+}) {
+  const defaultAlgoliaAgent = createAlgoliaAgent(version).add({
+    segment: client,
+    version
+  });
+  algoliaAgents.forEach(algoliaAgent => defaultAlgoliaAgent.add(algoliaAgent));
+  return defaultAlgoliaAgent;
 }
 
-function createRetryError(transporterStackTrace) {
-    return {
-        name: 'RetryError',
-        message: 'Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.',
-        transporterStackTrace,
-    };
+const DEFAULT_CONNECT_TIMEOUT_BROWSER = 1000;
+const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
+const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
+
+function createXhrRequester() {
+    function send(request) {
+        return new Promise((resolve) => {
+            const baseRequester = new XMLHttpRequest();
+            baseRequester.open(request.method, request.url, true);
+            Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
+            const createTimeout = (timeout, content) => {
+                return setTimeout(() => {
+                    baseRequester.abort();
+                    resolve({
+                        status: 0,
+                        content,
+                        isTimedOut: true,
+                    });
+                }, timeout);
+            };
+            const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
+            let responseTimeout;
+            baseRequester.onreadystatechange = () => {
+                if (baseRequester.readyState > baseRequester.OPENED &&
+                    responseTimeout === undefined) {
+                    clearTimeout(connectTimeout);
+                    responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
+                }
+            };
+            baseRequester.onerror = () => {
+                // istanbul ignore next
+                if (baseRequester.status === 0) {
+                    clearTimeout(connectTimeout);
+                    clearTimeout(responseTimeout);
+                    resolve({
+                        content: baseRequester.responseText || 'Network request failed',
+                        status: baseRequester.status,
+                        isTimedOut: false,
+                    });
+                }
+            };
+            baseRequester.onload = () => {
+                clearTimeout(connectTimeout);
+                clearTimeout(responseTimeout);
+                resolve({
+                    content: baseRequester.responseText,
+                    status: baseRequester.status,
+                    isTimedOut: false,
+                });
+            };
+            baseRequester.send(request.data);
+        });
+    }
+    return { send };
 }
 
-const createRecommendClient = options => {
-    const appId = options.appId;
-    const auth = createAuth(options.authMode !== undefined ? options.authMode : AuthMode.WithinHeaders, appId, options.apiKey);
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+const apiClientVersion = '5.0.0-alpha.3';
+function getDefaultHosts(appId) {
+    return [
+        {
+            url: `${appId}-dsn.algolia.net`,
+            accept: 'read',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}.algolia.net`,
+            accept: 'write',
+            protocol: 'https',
+        },
+    ].concat(shuffle([
+        {
+            url: `${appId}-1.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-2.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-3.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+    ]));
+}
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
+    const auth = createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = createTransporter({
-        hosts: [
-            { url: `${appId}-dsn.algolia.net`, accept: CallEnum.Read },
-            { url: `${appId}.algolia.net`, accept: CallEnum.Write },
-        ].concat(shuffle([
-            { url: `${appId}-1.algolianet.com` },
-            { url: `${appId}-2.algolianet.com` },
-            { url: `${appId}-3.algolianet.com` },
-        ])),
+        hosts: getDefaultHosts(appIdOption),
         ...options,
-        headers: {
+        algoliaAgent: getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Recommend',
+            version: apiClientVersion,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
             ...auth.headers(),
-            ...{ 'content-type': 'application/x-www-form-urlencoded' },
-            ...options.headers,
+            ...options.baseHeaders,
         },
-        queryParameters: {
+        baseQueryParameters: {
             ...auth.queryParameters(),
-            ...options.queryParameters,
+            ...options.baseQueryParameters,
         },
     });
-    const base = {
+    return {
         transporter,
-        appId,
+        /**
+         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+         */
+        get _ua() {
+            return transporter.algoliaAgent.value;
+        },
+        /**
+         * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+         *
+         * @param segment - The algolia agent (user-agent) segment to add.
+         * @param version - The version of the agent.
+         */
         addAlgoliaAgent(segment, version) {
-            transporter.userAgent.add({ segment, version });
+            transporter.algoliaAgent.add({ segment, version });
         },
-        clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param del - The del object.
+         * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+         * @param del.parameters - Query parameters to be applied to the current query.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        del({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `del`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param get - The get object.
+         * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+         * @param get.parameters - Query parameters to be applied to the current query.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        get({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `get`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns recommendations or trending results, for a specific model and `objectID`.
+         *
+         * @summary Get results.
+         * @param getRecommendationsParams - The getRecommendationsParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getRecommendations(getRecommendationsParams, requestOptions) {
+            if (!getRecommendationsParams) {
+                throw new Error('Parameter `getRecommendationsParams` is required when calling `getRecommendations`.');
+            }
+            if (!getRecommendationsParams.requests) {
+                throw new Error('Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.');
+            }
+            const requestPath = '/1/indexes/*/recommendations';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: getRecommendationsParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param post - The post object.
+         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+         * @param post.parameters - Query parameters to be applied to the current query.
+         * @param post.body - The parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        post({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `post`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param put - The put object.
+         * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+         * @param put.parameters - Query parameters to be applied to the current query.
+         * @param put.body - The parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        put({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `put`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
         },
     };
-    return addMethods(base, options.methods);
-};
-
-const getRecommendations = base => {
-    return (queries, requestOptions) => {
-        const requests = queries.map(query => ({
-            ...query,
-            // The `threshold` param is required by the endpoint to make it easier
-            // to provide a default value later, so we default it in the client
-            // so that users don't have to provide a value.
-            threshold: query.threshold || 0,
-        }));
-        return base.transporter.read({
-            method: MethodEnum.Post,
-            path: '1/indexes/*/recommendations',
-            data: {
-                requests,
-            },
-            cacheable: true,
-        }, requestOptions);
-    };
-};
-
-const getFrequentlyBoughtTogether = base => {
-    return (queries, requestOptions) => {
-        return getRecommendations(base)(queries.map(query => ({
-            ...query,
-            fallbackParameters: {},
-            model: 'bought-together',
-        })), requestOptions);
-    };
-};
-
-const getRelatedProducts = base => {
-    return (queries, requestOptions) => {
-        return getRecommendations(base)(queries.map(query => ({
-            ...query,
-            model: 'related-products',
-        })), requestOptions);
-    };
-};
-
-const getTrendingFacets = base => {
-    return (queries, requestOptions) => {
-        const requests = queries.map(query => ({
-            ...query,
-            model: 'trending-facets',
-            // The `threshold` param is required by the endpoint to make it easier
-            // to provide a default value later, so we default it in the client
-            // so that users don't have to provide a value.
-            threshold: query.threshold || 0,
-        }));
-        return base.transporter.read({
-            method: MethodEnum.Post,
-            path: '1/indexes/*/recommendations',
-            data: {
-                requests,
-            },
-            cacheable: true,
-        }, requestOptions);
-    };
-};
-
-const getTrendingItems = base => {
-    return (queries, requestOptions) => {
-        const requests = queries.map(query => ({
-            ...query,
-            model: 'trending-items',
-            // The `threshold` param is required by the endpoint to make it easier
-            // to provide a default value later, so we default it in the client
-            // so that users don't have to provide a value.
-            threshold: query.threshold || 0,
-        }));
-        return base.transporter.read({
-            method: MethodEnum.Post,
-            path: '1/indexes/*/recommendations',
-            data: {
-                requests,
-            },
-            cacheable: true,
-        }, requestOptions);
-    };
-};
+}
 
-function recommend(appId, apiKey, options) {
-    const commonOptions = {
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+function recommendClient(appId, apiKey, options) {
+    if (!appId || typeof appId !== 'string') {
+        throw new Error('`appId` is missing.');
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+        throw new Error('`apiKey` is missing.');
+    }
+    return createRecommendClient({
         appId,
         apiKey,
         timeouts: {
-            connect: 1,
-            read: 2,
-            write: 30,
-        },
-        requester: createBrowserXhrRequester(),
-        logger: createConsoleLogger(LogLevelEnum.Error),
-        responsesCache: createInMemoryCache(),
-        requestsCache: createInMemoryCache({ serializable: false }),
+            connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
+            read: DEFAULT_READ_TIMEOUT_BROWSER,
+            write: DEFAULT_WRITE_TIMEOUT_BROWSER,
+        },
+        requester: createXhrRequester(),
+        algoliaAgents: [{ segment: 'Browser' }],
+        authMode: 'WithinQueryParameters',
+        responsesCache: createMemoryCache(),
+        requestsCache: createMemoryCache({ serializable: false }),
         hostsCache: createFallbackableCache({
             caches: [
-                createBrowserLocalStorageCache({ key: `${version}-${appId}` }),
-                createInMemoryCache(),
+                createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }),
+                createMemoryCache(),
             ],
         }),
-        userAgent: createUserAgent(version)
-            .add({ segment: 'Recommend', version })
-            .add({ segment: 'Browser' }),
-        authMode: AuthMode.WithinQueryParameters,
-    };
-    return createRecommendClient({
-        ...commonOptions,
         ...options,
-        methods: {
-            getFrequentlyBoughtTogether,
-            getRecommendations,
-            getRelatedProducts,
-            getTrendingFacets,
-            getTrendingItems,
-        },
     });
-}
-// eslint-disable-next-line functional/immutable-data
-recommend.version = version;
+}
 
-export default recommend;
+export { apiClientVersion, recommendClient };