@algolia/client-common 5.0.0-alpha.3 → 5.0.0-alpha.6

package/dist/client-common.cjs.js

@@ -73,43 +73,43 @@ function createEchoRequester({
   };
 }
 
-const DEFAULT_MAX_RETRIES = 50;
-const DEFAULT_TIMEOUT = retryCount => Math.min(retryCount * 200, 5000);
 /**
- * Return a promise that retry a task until it meets the condition.
+ * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
  *
- * @param createRetryablePromiseOptions - The createRetryablePromise options.
- * @param createRetryablePromiseOptions.func - The function to run, which returns a promise.
- * @param createRetryablePromiseOptions.validate - The validator function. It receives the resolved return of `func`.
- * @param createRetryablePromiseOptions.maxRetries - The maximum number of retries. 50 by default.
- * @param createRetryablePromiseOptions.timeout - The function to decide how long to wait between retries.
+ * @param createIterator - The createIterator options.
+ * @param createIterator.func - The function to run, which returns a promise.
+ * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
+ * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
+ * @param createIterator.error - The `validate` condition to throw an error, and its message.
+ * @param createIterator.timeout - The function to decide how long to wait between iterations.
  */
-
-function createRetryablePromise({
+function createIterablePromise({
   func,
   validate,
-  maxRetries = DEFAULT_MAX_RETRIES,
-  timeout = DEFAULT_TIMEOUT
+  aggregator,
+  error,
+  timeout = () => 0
 }) {
-  let retryCount = 0;
-
-  const retry = () => {
+  const retry = previousResponse => {
     return new Promise((resolve, reject) => {
-      func().then(response => {
-        const isValid = validate(response);
+      func(previousResponse).then(response => {
+        if (aggregator) {
+          aggregator(response);
+        }
 
-        if (isValid) {
-          resolve(response);
-        } else if (retryCount + 1 >= maxRetries) {
-          reject(new Error(`The maximum number of retries exceeded. (${retryCount + 1}/${maxRetries})`));
-        } else {
-          retryCount += 1;
-          setTimeout(() => {
-            retry().then(resolve).catch(reject);
-          }, timeout(retryCount));
+        if (validate(response)) {
+          return resolve(response);
         }
-      }).catch(error => {
-        reject(error);
+
+        if (error && error.validate(response)) {
+          return reject(new Error(error.message(response)));
+        }
+
+        return setTimeout(() => {
+          retry(response).then(resolve).catch(reject);
+        }, timeout());
+      }).catch(err => {
+        reject(err);
       });
     });
   };
@@ -779,10 +779,8 @@ exports.AlgoliaError = AlgoliaError;
 exports.ApiError = ApiError;
 exports.DEFAULT_CONNECT_TIMEOUT_BROWSER = DEFAULT_CONNECT_TIMEOUT_BROWSER;
 exports.DEFAULT_CONNECT_TIMEOUT_NODE = DEFAULT_CONNECT_TIMEOUT_NODE;
-exports.DEFAULT_MAX_RETRIES = DEFAULT_MAX_RETRIES;
 exports.DEFAULT_READ_TIMEOUT_BROWSER = DEFAULT_READ_TIMEOUT_BROWSER;
 exports.DEFAULT_READ_TIMEOUT_NODE = DEFAULT_READ_TIMEOUT_NODE;
-exports.DEFAULT_TIMEOUT = DEFAULT_TIMEOUT;
 exports.DEFAULT_WRITE_TIMEOUT_BROWSER = DEFAULT_WRITE_TIMEOUT_BROWSER;
 exports.DEFAULT_WRITE_TIMEOUT_NODE = DEFAULT_WRITE_TIMEOUT_NODE;
 exports.DeserializationError = DeserializationError;
@@ -793,9 +791,9 @@ exports.createAuth = createAuth;
 exports.createBrowserLocalStorageCache = createBrowserLocalStorageCache;
 exports.createEchoRequester = createEchoRequester;
 exports.createFallbackableCache = createFallbackableCache;
+exports.createIterablePromise = createIterablePromise;
 exports.createMemoryCache = createMemoryCache;
 exports.createNullCache = createNullCache;
-exports.createRetryablePromise = createRetryablePromise;
 exports.createStatefulHost = createStatefulHost;
 exports.createTransporter = createTransporter;
 exports.deserializeFailure = deserializeFailure;

package/dist/client-common.esm.node.js

@@ -69,43 +69,43 @@ function createEchoRequester({
   };
 }
 
-const DEFAULT_MAX_RETRIES = 50;
-const DEFAULT_TIMEOUT = retryCount => Math.min(retryCount * 200, 5000);
 /**
- * Return a promise that retry a task until it meets the condition.
+ * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
  *
- * @param createRetryablePromiseOptions - The createRetryablePromise options.
- * @param createRetryablePromiseOptions.func - The function to run, which returns a promise.
- * @param createRetryablePromiseOptions.validate - The validator function. It receives the resolved return of `func`.
- * @param createRetryablePromiseOptions.maxRetries - The maximum number of retries. 50 by default.
- * @param createRetryablePromiseOptions.timeout - The function to decide how long to wait between retries.
+ * @param createIterator - The createIterator options.
+ * @param createIterator.func - The function to run, which returns a promise.
+ * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
+ * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
+ * @param createIterator.error - The `validate` condition to throw an error, and its message.
+ * @param createIterator.timeout - The function to decide how long to wait between iterations.
  */
-
-function createRetryablePromise({
+function createIterablePromise({
   func,
   validate,
-  maxRetries = DEFAULT_MAX_RETRIES,
-  timeout = DEFAULT_TIMEOUT
+  aggregator,
+  error,
+  timeout = () => 0
 }) {
-  let retryCount = 0;
-
-  const retry = () => {
+  const retry = previousResponse => {
     return new Promise((resolve, reject) => {
-      func().then(response => {
-        const isValid = validate(response);
+      func(previousResponse).then(response => {
+        if (aggregator) {
+          aggregator(response);
+        }
 
-        if (isValid) {
-          resolve(response);
-        } else if (retryCount + 1 >= maxRetries) {
-          reject(new Error(`The maximum number of retries exceeded. (${retryCount + 1}/${maxRetries})`));
-        } else {
-          retryCount += 1;
-          setTimeout(() => {
-            retry().then(resolve).catch(reject);
-          }, timeout(retryCount));
+        if (validate(response)) {
+          return resolve(response);
         }
-      }).catch(error => {
-        reject(error);
+
+        if (error && error.validate(response)) {
+          return reject(new Error(error.message(response)));
+        }
+
+        return setTimeout(() => {
+          retry(response).then(resolve).catch(reject);
+        }, timeout());
+      }).catch(err => {
+        reject(err);
       });
     });
   };
@@ -771,4 +771,4 @@ const DEFAULT_CONNECT_TIMEOUT_NODE = 2000;
 const DEFAULT_READ_TIMEOUT_NODE = 5000;
 const DEFAULT_WRITE_TIMEOUT_NODE = 30000;
 
-export { AlgoliaError, ApiError, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_MAX_RETRIES, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_TIMEOUT, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, ErrorWithStackTrace, RetryError, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createEchoRequester, createFallbackableCache, createMemoryCache, createNullCache, createRetryablePromise, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials };
+export { AlgoliaError, ApiError, DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_NODE, DeserializationError, ErrorWithStackTrace, RetryError, createAlgoliaAgent, createAuth, createBrowserLocalStorageCache, createEchoRequester, createFallbackableCache, createIterablePromise, createMemoryCache, createNullCache, createStatefulHost, createTransporter, deserializeFailure, deserializeSuccess, getAlgoliaAgent, isNetworkError, isRetryable, isSuccess, serializeData, serializeHeaders, serializeQueryParameters, serializeUrl, shuffle, stackFrameWithoutCredentials, stackTraceWithoutCredentials };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export * from './src/createAuth';
 export * from './src/createEchoRequester';
-export * from './src/createRetryablePromise';
+export * from './src/createIterablePromise';
 export * from './src/cache';
 export * from './src/transporter';
 export * from './src/createAlgoliaAgent';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}

package/dist/src/createIterablePromise.d.ts

@@ -0,0 +1,13 @@
+import type { CreateIterablePromise } from './types/createIterablePromise';
+/**
+ * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
+ *
+ * @param createIterator - The createIterator options.
+ * @param createIterator.func - The function to run, which returns a promise.
+ * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
+ * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
+ * @param createIterator.error - The `validate` condition to throw an error, and its message.
+ * @param createIterator.timeout - The function to decide how long to wait between iterations.
+ */
+export declare function createIterablePromise<TResponse>({ func, validate, aggregator, error, timeout, }: CreateIterablePromise<TResponse>): Promise<TResponse>;
+//# sourceMappingURL=createIterablePromise.d.ts.map

package/dist/src/createIterablePromise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createIterablePromise.d.ts","sourceRoot":"","sources":["../../../../packages/client-common/src/createIterablePromise.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAE3E;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,EAC/C,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,KAAK,EACL,OAAyB,GAC1B,EAAE,qBAAqB,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CA4BvD"}

package/dist/src/types/{Cache.d.ts → cache.d.ts}

@@ -44,4 +44,4 @@ export declare type FallbackableCacheOptions = {
      */
     caches: Cache[];
 };
-//# sourceMappingURL=Cache.d.ts.map
+//# sourceMappingURL=cache.d.ts.map

package/dist/src/types/{Cache.d.ts.map → cache.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"Cache.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/Cache.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,GAAG,EAAE,CAAC,MAAM,EACV,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EACjC,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACnC,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,KACzB,OAAO,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,GAAG,EAAE,CAAC,MAAM,EACV,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EACjC,KAAK,EAAE,MAAM,KACV,OAAO,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;OAEG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B,CAAC;AAEF,oBAAY,WAAW,CAAC,MAAM,IAAI;IAChC;;OAEG;IACH,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CACvC,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/cache.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,GAAG,EAAE,CAAC,MAAM,EACV,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EACjC,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACnC,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,KACzB,OAAO,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,GAAG,EAAE,CAAC,MAAM,EACV,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EACjC,KAAK,EAAE,MAAM,KACV,OAAO,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;OAEG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B,CAAC;AAEF,oBAAY,WAAW,CAAC,MAAM,IAAI;IAChC;;OAEG;IACH,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CACvC,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC"}

package/dist/src/types/{CreateClient.d.ts → createClient.d.ts}

@@ -1,4 +1,4 @@
-import type { AlgoliaAgentOptions, TransporterOptions } from './Transporter';
+import type { AlgoliaAgentOptions, TransporterOptions } from './transporter';
 export declare type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
 declare type OverriddenTransporterOptions = 'baseHeaders' | 'baseQueryParameters' | 'hosts';
 export declare type CreateClientOptions = Omit<TransporterOptions, OverriddenTransporterOptions | 'algoliaAgent'> & Partial<Pick<TransporterOptions, OverriddenTransporterOptions>> & {
@@ -9,4 +9,4 @@ export declare type CreateClientOptions = Omit<TransporterOptions, OverriddenTra
 };
 export declare type ClientOptions = Partial<Omit<CreateClientOptions, 'apiKey' | 'appId'>>;
 export {};
-//# sourceMappingURL=CreateClient.d.ts.map
+//# sourceMappingURL=createClient.d.ts.map

package/dist/src/types/{CreateClient.d.ts.map → createClient.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"CreateClient.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/CreateClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAE7E,oBAAY,QAAQ,GAAG,eAAe,GAAG,uBAAuB,CAAC;AAEjE,aAAK,4BAA4B,GAC7B,aAAa,GACb,qBAAqB,GACrB,OAAO,CAAC;AAEZ,oBAAY,mBAAmB,GAAG,IAAI,CACpC,kBAAkB,EAClB,4BAA4B,GAAG,cAAc,CAC9C,GACC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,GAAG;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,aAAa,EAAE,mBAAmB,EAAE,CAAC;CACtC,CAAC;AAEJ,oBAAY,aAAa,GAAG,OAAO,CACjC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,CAAC,CAC9C,CAAC"}
+{"version":3,"file":"createClient.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/createClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAE7E,oBAAY,QAAQ,GAAG,eAAe,GAAG,uBAAuB,CAAC;AAEjE,aAAK,4BAA4B,GAC7B,aAAa,GACb,qBAAqB,GACrB,OAAO,CAAC;AAEZ,oBAAY,mBAAmB,GAAG,IAAI,CACpC,kBAAkB,EAClB,4BAA4B,GAAG,cAAc,CAC9C,GACC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,4BAA4B,CAAC,CAAC,GAAG;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,aAAa,EAAE,mBAAmB,EAAE,CAAC;CACtC,CAAC;AAEJ,oBAAY,aAAa,GAAG,OAAO,CACjC,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,CAAC,CAC9C,CAAC"}

package/dist/src/types/createIterablePromise.d.ts

@@ -0,0 +1,36 @@
+export declare type IterableOptions<TResponse> = Partial<{
+    /**
+     * The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
+     */
+    aggregator: (response: TResponse) => void;
+    /**
+     * The `validate` condition to throw an error and its message.
+     */
+    error: {
+        /**
+         * The function to validate the error condition.
+         */
+        validate: (response: TResponse) => boolean;
+        /**
+         * The error message to throw.
+         */
+        message: (response: TResponse) => string;
+    };
+    /**
+     * The function to decide how long to wait between iterations.
+     */
+    timeout: () => number;
+}>;
+export declare type CreateIterablePromise<TResponse> = IterableOptions<TResponse> & {
+    /**
+     * The function to run, which returns a promise.
+     *
+     * The `previousResponse` parameter (`undefined` on the first call) allows you to build your request with incremental logic, to iterate on `page` or `cursor` for example.
+     */
+    func: (previousResponse?: TResponse) => Promise<TResponse>;
+    /**
+     * The validator function. It receive the resolved return of the API call.
+     */
+    validate: (response: TResponse) => boolean;
+};
+//# sourceMappingURL=createIterablePromise.d.ts.map

package/dist/src/types/createIterablePromise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createIterablePromise.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/createIterablePromise.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe,CAAC,SAAS,IAAI,OAAO,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI,CAAC;IAE1C;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,OAAO,CAAC;QAE3C;;WAEG;QACH,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,MAAM,CAAC;KAC1C,CAAC;IAEF;;OAEG;IACH,OAAO,EAAE,MAAM,MAAM,CAAC;CACvB,CAAC,CAAC;AAEH,oBAAY,qBAAqB,CAAC,SAAS,IAAI,eAAe,CAAC,SAAS,CAAC,GAAG;IAC1E;;;;OAIG;IACH,IAAI,EAAE,CAAC,gBAAgB,CAAC,EAAE,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IAE3D;;OAEG;IACH,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,OAAO,CAAC;CAC5C,CAAC"}

package/dist/src/types/{Host.d.ts → host.d.ts}

@@ -30,4 +30,4 @@ export declare type StatefulHost = Host & {
      */
     isTimedOut: () => boolean;
 };
-//# sourceMappingURL=Host.d.ts.map
+//# sourceMappingURL=host.d.ts.map

package/dist/src/types/{Host.d.ts.map → host.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"Host.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/Host.ts"],"names":[],"mappings":"AAAA,oBAAY,IAAI,GAAG;IACjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC;IAEvC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B,CAAC;AAEF,oBAAY,YAAY,GAAG,IAAI,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC;CAC3B,CAAC"}
+{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/host.ts"],"names":[],"mappings":"AAAA,oBAAY,IAAI,GAAG;IACjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC;IAEvC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B,CAAC;AAEF,oBAAY,YAAY,GAAG,IAAI,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC;CAC3B,CAAC"}

package/dist/src/types/index.d.ts

@@ -1,7 +1,7 @@
-export * from './Cache';
-export * from './CreateClient';
-export * from './CreateRetryablePromise';
-export * from './Host';
-export * from './Requester';
-export * from './Transporter';
+export * from './cache';
+export * from './createClient';
+export * from './createIterablePromise';
+export * from './host';
+export * from './requester';
+export * from './transporter';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC;AACxC,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}

package/dist/src/types/{Requester.d.ts → requester.d.ts}

@@ -1,4 +1,4 @@
-import type { Headers, QueryParameters } from './Transporter';
+import type { Headers, QueryParameters } from './transporter';
 /**
  * The method of the request.
  */
@@ -63,4 +63,4 @@ export declare type EchoResponse = Omit<EndRequest, 'data'> & Pick<Request, 'dat
     algoliaAgent: string;
     searchParams?: Record<string, string>;
 };
-//# sourceMappingURL=Requester.d.ts.map
+//# sourceMappingURL=requester.d.ts.map

package/dist/src/types/{Requester.d.ts.map → requester.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"Requester.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/Requester.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAE9D;;GAEG;AACH,oBAAY,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,eAAe,CAAC;IACjC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,oBAAY,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE,SAAS,GAAG,QAAQ,CAAC,GAAG;IAC7D;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAClD,CAAC;AAEF,oBAAY,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GACjD,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC,CAAC"}
+{"version":3,"file":"requester.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/requester.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAE9D;;GAEG;AACH,oBAAY,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,eAAe,CAAC;IACjC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,oBAAY,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE,SAAS,GAAG,QAAQ,CAAC,GAAG;IAC7D;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAClD,CAAC;AAEF,oBAAY,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GACjD,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC,CAAC"}

package/dist/src/types/{Transporter.d.ts → transporter.d.ts}

@@ -1,6 +1,6 @@
-import type { Cache } from './Cache';
-import type { Host } from './Host';
-import type { Request, Requester, EndRequest, Response } from './Requester';
+import type { Cache } from './cache';
+import type { Host } from './host';
+import type { Request, Requester, EndRequest, Response } from './requester';
 export declare type Headers = Record<string, string>;
 export declare type QueryParameters = Record<string, any>;
 export declare type RequestOptions = Pick<Request, 'cacheable'> & {
@@ -125,4 +125,4 @@ export declare type Transporter = TransporterOptions & {
      */
     request: <TResponse>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<TResponse>;
 };
-//# sourceMappingURL=Transporter.d.ts.map
+//# sourceMappingURL=transporter.d.ts.map

package/dist/src/types/{Transporter.d.ts.map → transporter.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"Transporter.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/Transporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5E,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAElD,oBAAY,cAAc,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG;IACxD;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACzD,CAAC;AAEF,oBAAY,UAAU,GAAG;IACvB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,YAAY,CAAC;CACrD,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;;;OAKG;IACH,aAAa,EAAE,KAAK,CAAC;IAErB;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,mBAAmB,EAAE,eAAe,CAAC;IAErC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,oBAAY,WAAW,GAAG,kBAAkB,GAAG;IAC7C;;;OAGG;IACH,OAAO,EAAE,CAAC,SAAS,EACjB,WAAW,EAAE,OAAO,EACpB,kBAAkB,CAAC,EAAE,cAAc,KAChC,OAAO,CAAC,SAAS,CAAC,CAAC;CACzB,CAAC"}
+{"version":3,"file":"transporter.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/transporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5E,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAElD,oBAAY,cAAc,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG;IACxD;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACzD,CAAC;AAEF,oBAAY,UAAU,GAAG;IACvB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,YAAY,CAAC;CACrD,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC;IAElB;;;;OAIG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;;;OAKG;IACH,aAAa,EAAE,KAAK,CAAC;IAErB;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,mBAAmB,EAAE,eAAe,CAAC;IAErC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,oBAAY,WAAW,GAAG,kBAAkB,GAAG;IAC7C;;;OAGG;IACH,OAAO,EAAE,CAAC,SAAS,EACjB,WAAW,EAAE,OAAO,EACpB,kBAAkB,CAAC,EAAE,cAAc,KAChC,OAAO,CAAC,SAAS,CAAC,CAAC;CACzB,CAAC"}

package/index.ts

@@ -1,6 +1,6 @@
 export * from './src/createAuth';
 export * from './src/createEchoRequester';
-export * from './src/createRetryablePromise';
+export * from './src/createIterablePromise';
 export * from './src/cache';
 export * from './src/transporter';
 export * from './src/createAlgoliaAgent';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-common",
-  "version": "5.0.0-alpha.3",
+  "version": "5.0.0-alpha.6",
   "description": "Common package for the Algolia JavaScript API client.",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -19,7 +19,7 @@
   },
   "devDependencies": {
     "@types/jest": "28.1.6",
-    "@types/node": "16.11.45",
+    "@types/node": "16.11.47",
     "jest": "28.1.3",
     "jest-environment-jsdom": "28.1.3",
     "ts-jest": "28.0.7",

package/src/__tests__/create-iterable-promise.test.ts

@@ -0,0 +1,238 @@
+import { createIterablePromise } from '../createIterablePromise';
+
+describe('createIterablePromise', () => {
+  describe('func', () => {
+    it('provides the `previousResponse` parameter', async () => {
+      const responses: Array<string | undefined> = [];
+      const promise = createIterablePromise<string | undefined>({
+        func: (previousResponse) => {
+          return new Promise((resolve) => {
+            resolve(previousResponse === undefined ? 'yes' : 'no');
+          });
+        },
+        validate: () => responses.length === 3,
+        aggregator: (response) => responses.push(response),
+      });
+
+      await expect(promise).resolves.toEqual('no');
+      expect(responses).toEqual(['yes', 'no', 'no']);
+    });
+  });
+
+  describe('validate', () => {
+    it('iterates on a `func` until `validate` is met', async () => {
+      let calls = 0;
+      const promise = createIterablePromise({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve(`success #${calls}`);
+          });
+        },
+        validate: () => calls >= 3,
+      });
+
+      await expect(promise).resolves.toEqual('success #3');
+      expect(calls).toBe(3);
+    });
+
+    it('forward the response of the `func`', async () => {
+      let calls = 0;
+      const promise = createIterablePromise<number>({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve(calls);
+          });
+        },
+        validate: (response) => response >= 3,
+      });
+
+      await expect(promise).resolves.toEqual(3);
+      expect(calls).toBe(3);
+    });
+  });
+
+  describe('aggregator', () => {
+    it('is called before iterating', async () => {
+      let calls = 0;
+      let count = 0;
+      const promise = createIterablePromise({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve(`success #${calls}`);
+          });
+        },
+        validate: () => calls >= 3,
+        aggregator: () => (count += 3),
+      });
+
+      await expect(promise).resolves.toEqual('success #3');
+      expect(calls).toBe(3);
+      expect(count).toBe(3 * 3);
+    });
+
+    it('forward the response of the `func`', async () => {
+      let calls = 0;
+      const responses: string[] = [];
+      const promise = createIterablePromise<string>({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve(`success #${calls}`);
+          });
+        },
+        validate: () => calls >= 3,
+        aggregator: (response) => {
+          responses.push(response);
+        },
+      });
+
+      await expect(promise).resolves.toEqual('success #3');
+      expect(calls).toBe(3);
+      expect(responses).toEqual(['success #1', 'success #2', 'success #3']);
+    });
+  });
+
+  describe('timeout', () => {
+    it('defaults to no timeout (0)', async () => {
+      let calls = 0;
+      const before = Date.now();
+      const promise = createIterablePromise({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve(`success #${calls}`);
+          });
+        },
+        validate: () => calls >= 2,
+      });
+
+      await expect(promise).resolves.toEqual('success #2');
+
+      expect(Date.now() - before).toBeGreaterThanOrEqual(0);
+      expect(Date.now() - before).toBeLessThanOrEqual(10);
+      expect(calls).toBe(2);
+    });
+
+    it('waits before calling the `func` again', async () => {
+      let calls = 0;
+      const before = Date.now();
+      const promise = createIterablePromise({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve(`success #${calls}`);
+          });
+        },
+        validate: () => calls >= 2,
+        timeout: () => 2000,
+      });
+
+      await expect(promise).resolves.toEqual('success #2');
+
+      expect(Date.now() - before).toBeGreaterThanOrEqual(2000);
+      expect(Date.now() - before).toBeLessThanOrEqual(2010);
+      expect(calls).toBe(2);
+    });
+  });
+
+  describe('error', () => {
+    it('gets the rejection of the given promise via reject', async () => {
+      let calls = 0;
+
+      const promise = createIterablePromise({
+        func: () => {
+          return new Promise((resolve, reject) => {
+            calls += 1;
+            if (calls <= 3) {
+              resolve('okay');
+            } else {
+              reject(new Error('nope'));
+            }
+          });
+        },
+        validate: () => false,
+      });
+
+      await expect(promise).rejects.toEqual(
+        expect.objectContaining({ message: 'nope' })
+      );
+    });
+
+    it('gets the rejection of the given promise via throw', async () => {
+      let calls = 0;
+
+      const promise = createIterablePromise({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            if (calls <= 3) {
+              resolve('okay');
+            } else {
+              throw new Error('nope');
+            }
+          });
+        },
+        validate: () => false,
+      });
+
+      await expect(promise).rejects.toEqual(
+        expect.objectContaining({ message: 'nope' })
+      );
+    });
+
+    it('rejects with the given `message` when `validate` hits', async () => {
+      const MAX_RETRIES = 3;
+      let calls = 0;
+
+      const promise = createIterablePromise({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve('okay');
+          });
+        },
+        validate: () => false,
+        error: {
+          validate: () => calls >= MAX_RETRIES,
+          message: () => `Error is thrown: ${calls}/${MAX_RETRIES}`,
+        },
+      });
+
+      await expect(promise).rejects.toEqual(
+        expect.objectContaining({
+          message: 'Error is thrown: 3/3',
+        })
+      );
+      expect(calls).toBe(MAX_RETRIES);
+    });
+
+    it('forward the response of the `func`', async () => {
+      const MAX_RETRIES = 3;
+      let calls = 0;
+
+      const promise = createIterablePromise<number>({
+        func: () => {
+          return new Promise((resolve) => {
+            calls += 1;
+            resolve(calls);
+          });
+        },
+        validate: () => false,
+        error: {
+          validate: (response) => response >= MAX_RETRIES,
+          message: (response) => `Error is thrown: ${response}/${MAX_RETRIES}`,
+        },
+      });
+
+      await expect(promise).rejects.toEqual(
+        expect.objectContaining({
+          message: 'Error is thrown: 3/3',
+        })
+      );
+      expect(calls).toBe(MAX_RETRIES);
+    });
+  });
+});

package/src/createIterablePromise.ts

@@ -0,0 +1,47 @@
+import type { CreateIterablePromise } from './types/createIterablePromise';
+
+/**
+ * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
+ *
+ * @param createIterator - The createIterator options.
+ * @param createIterator.func - The function to run, which returns a promise.
+ * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
+ * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
+ * @param createIterator.error - The `validate` condition to throw an error, and its message.
+ * @param createIterator.timeout - The function to decide how long to wait between iterations.
+ */
+export function createIterablePromise<TResponse>({
+  func,
+  validate,
+  aggregator,
+  error,
+  timeout = (): number => 0,
+}: CreateIterablePromise<TResponse>): Promise<TResponse> {
+  const retry = (previousResponse?: TResponse): Promise<TResponse> => {
+    return new Promise<TResponse>((resolve, reject) => {
+      func(previousResponse)
+        .then((response) => {
+          if (aggregator) {
+            aggregator(response);
+          }
+
+          if (validate(response)) {
+            return resolve(response);
+          }
+
+          if (error && error.validate(response)) {
+            return reject(new Error(error.message(response)));
+          }
+
+          return setTimeout(() => {
+            retry(response).then(resolve).catch(reject);
+          }, timeout());
+        })
+        .catch((err) => {
+          reject(err);
+        });
+    });
+  };
+
+  return retry();
+}

package/src/types/{CreateClient.ts → createClient.ts}

@@ -1,4 +1,4 @@
-import type { AlgoliaAgentOptions, TransporterOptions } from './Transporter';
+import type { AlgoliaAgentOptions, TransporterOptions } from './transporter';
 
 export type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
 

package/src/types/createIterablePromise.ts

@@ -0,0 +1,40 @@
+export type IterableOptions<TResponse> = Partial<{
+  /**
+   * The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
+   */
+  aggregator: (response: TResponse) => void;
+
+  /**
+   * The `validate` condition to throw an error and its message.
+   */
+  error: {
+    /**
+     * The function to validate the error condition.
+     */
+    validate: (response: TResponse) => boolean;
+
+    /**
+     * The error message to throw.
+     */
+    message: (response: TResponse) => string;
+  };
+
+  /**
+   * The function to decide how long to wait between iterations.
+   */
+  timeout: () => number;
+}>;
+
+export type CreateIterablePromise<TResponse> = IterableOptions<TResponse> & {
+  /**
+   * The function to run, which returns a promise.
+   *
+   * The `previousResponse` parameter (`undefined` on the first call) allows you to build your request with incremental logic, to iterate on `page` or `cursor` for example.
+   */
+  func: (previousResponse?: TResponse) => Promise<TResponse>;
+
+  /**
+   * The validator function. It receive the resolved return of the API call.
+   */
+  validate: (response: TResponse) => boolean;
+};

package/src/types/index.ts

@@ -1,6 +1,6 @@
-export * from './Cache';
-export * from './CreateClient';
-export * from './CreateRetryablePromise';
-export * from './Host';
-export * from './Requester';
-export * from './Transporter';
+export * from './cache';
+export * from './createClient';
+export * from './createIterablePromise';
+export * from './host';
+export * from './requester';
+export * from './transporter';

package/src/types/{Requester.ts → requester.ts}

@@ -1,4 +1,4 @@
-import type { Headers, QueryParameters } from './Transporter';
+import type { Headers, QueryParameters } from './transporter';
 
 /**
  * The method of the request.

package/src/types/{Transporter.ts → transporter.ts}

@@ -1,6 +1,6 @@
-import type { Cache } from './Cache';
-import type { Host } from './Host';
-import type { Request, Requester, EndRequest, Response } from './Requester';
+import type { Cache } from './cache';
+import type { Host } from './host';
+import type { Request, Requester, EndRequest, Response } from './requester';
 
 export type Headers = Record<string, string>;
 export type QueryParameters = Record<string, any>;

package/dist/src/createRetryablePromise.d.ts

@@ -1,14 +0,0 @@
-import type { CreateRetryablePromiseOptions } from './types/CreateRetryablePromise';
-export declare const DEFAULT_MAX_RETRIES = 50;
-export declare const DEFAULT_TIMEOUT: (retryCount: number) => number;
-/**
- * Return a promise that retry a task until it meets the condition.
- *
- * @param createRetryablePromiseOptions - The createRetryablePromise options.
- * @param createRetryablePromiseOptions.func - The function to run, which returns a promise.
- * @param createRetryablePromiseOptions.validate - The validator function. It receives the resolved return of `func`.
- * @param createRetryablePromiseOptions.maxRetries - The maximum number of retries. 50 by default.
- * @param createRetryablePromiseOptions.timeout - The function to decide how long to wait between retries.
- */
-export declare function createRetryablePromise<TResponse>({ func, validate, maxRetries, timeout, }: CreateRetryablePromiseOptions<TResponse>): Promise<TResponse>;
-//# sourceMappingURL=createRetryablePromise.d.ts.map

package/dist/src/createRetryablePromise.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createRetryablePromise.d.ts","sourceRoot":"","sources":["../../../../packages/client-common/src/createRetryablePromise.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAEpF,eAAO,MAAM,mBAAmB,KAAK,CAAC;AACtC,eAAO,MAAM,eAAe,eAAgB,MAAM,KAAG,MACnB,CAAC;AAEnC;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,EAChD,IAAI,EACJ,QAAQ,EACR,UAAgC,EAChC,OAAyB,GAC1B,EAAE,6BAA6B,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CA+B/D"}

package/dist/src/types/CreateRetryablePromise.d.ts

@@ -1,19 +0,0 @@
-export declare type CreateRetryablePromiseOptions<TResponse> = {
-    /**
-     * The function to run, which returns a promise.
-     */
-    func: () => Promise<TResponse>;
-    /**
-     * The validator function. It receives the resolved return of `func`.
-     */
-    validate: (response: TResponse) => boolean;
-    /**
-     * The maximum number of retry. 50 by default.
-     */
-    maxRetries?: number;
-    /**
-     * The function to decide how long to wait between retries.
-     */
-    timeout?: (retryCount: number) => number;
-};
-//# sourceMappingURL=CreateRetryablePromise.d.ts.map

package/dist/src/types/CreateRetryablePromise.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CreateRetryablePromise.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/types/CreateRetryablePromise.ts"],"names":[],"mappings":"AAAA,oBAAY,6BAA6B,CAAC,SAAS,IAAI;IACrD;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,OAAO,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAC;CAC1C,CAAC"}

package/src/__tests__/create-retryable-promise.test.ts

@@ -1,86 +0,0 @@
-import { createRetryablePromise } from '../createRetryablePromise';
-
-describe('createRetryablePromise', () => {
-  it('resolves promise after some retries', async () => {
-    let calls = 0;
-    const promise = createRetryablePromise({
-      func: () => {
-        return new Promise((resolve) => {
-          calls += 1;
-          resolve(`success #${calls}`);
-        });
-      },
-      validate: () => calls >= 3,
-    });
-
-    await expect(promise).resolves.toEqual('success #3');
-    expect(calls).toBe(3);
-  });
-
-  it('gets the rejection of the given promise via reject', async () => {
-    let calls = 0;
-
-    const promise = createRetryablePromise({
-      func: () => {
-        return new Promise((resolve, reject) => {
-          calls += 1;
-          if (calls <= 3) {
-            resolve('okay');
-          } else {
-            reject(new Error('nope'));
-          }
-        });
-      },
-      validate: () => false,
-    });
-
-    await expect(promise).rejects.toEqual(
-      expect.objectContaining({ message: 'nope' })
-    );
-  });
-
-  it('gets the rejection of the given promise via throw', async () => {
-    let calls = 0;
-
-    const promise = createRetryablePromise({
-      func: () => {
-        return new Promise((resolve) => {
-          calls += 1;
-          if (calls <= 3) {
-            resolve('okay');
-          } else {
-            throw new Error('nope');
-          }
-        });
-      },
-      validate: () => false,
-    });
-
-    await expect(promise).rejects.toEqual(
-      expect.objectContaining({ message: 'nope' })
-    );
-  });
-
-  it('gets the rejection when it exceeds the max retries number', async () => {
-    const MAX_RETRIES = 3;
-    let calls = 0;
-
-    const promise = createRetryablePromise({
-      func: () => {
-        return new Promise((resolve) => {
-          calls += 1;
-          resolve('okay');
-        });
-      },
-      validate: () => false,
-      maxRetries: MAX_RETRIES,
-    });
-
-    await expect(promise).rejects.toEqual(
-      expect.objectContaining({
-        message: 'The maximum number of retries exceeded. (3/3)',
-      })
-    );
-    expect(calls).toBe(MAX_RETRIES);
-  });
-});

package/src/createRetryablePromise.ts

@@ -1,52 +0,0 @@
-import type { CreateRetryablePromiseOptions } from './types/CreateRetryablePromise';
-
-export const DEFAULT_MAX_RETRIES = 50;
-export const DEFAULT_TIMEOUT = (retryCount: number): number =>
-  Math.min(retryCount * 200, 5000);
-
-/**
- * Return a promise that retry a task until it meets the condition.
- *
- * @param createRetryablePromiseOptions - The createRetryablePromise options.
- * @param createRetryablePromiseOptions.func - The function to run, which returns a promise.
- * @param createRetryablePromiseOptions.validate - The validator function. It receives the resolved return of `func`.
- * @param createRetryablePromiseOptions.maxRetries - The maximum number of retries. 50 by default.
- * @param createRetryablePromiseOptions.timeout - The function to decide how long to wait between retries.
- */
-export function createRetryablePromise<TResponse>({
-  func,
-  validate,
-  maxRetries = DEFAULT_MAX_RETRIES,
-  timeout = DEFAULT_TIMEOUT,
-}: CreateRetryablePromiseOptions<TResponse>): Promise<TResponse> {
-  let retryCount = 0;
-  const retry = (): Promise<TResponse> => {
-    return new Promise<TResponse>((resolve, reject) => {
-      func()
-        .then((response) => {
-          const isValid = validate(response);
-          if (isValid) {
-            resolve(response);
-          } else if (retryCount + 1 >= maxRetries) {
-            reject(
-              new Error(
-                `The maximum number of retries exceeded. (${
-                  retryCount + 1
-                }/${maxRetries})`
-              )
-            );
-          } else {
-            retryCount += 1;
-            setTimeout(() => {
-              retry().then(resolve).catch(reject);
-            }, timeout(retryCount));
-          }
-        })
-        .catch((error) => {
-          reject(error);
-        });
-    });
-  };
-
-  return retry();
-}

package/src/types/CreateRetryablePromise.ts

@@ -1,21 +0,0 @@
-export type CreateRetryablePromiseOptions<TResponse> = {
-  /**
-   * The function to run, which returns a promise.
-   */
-  func: () => Promise<TResponse>;
-
-  /**
-   * The validator function. It receives the resolved return of `func`.
-   */
-  validate: (response: TResponse) => boolean;
-
-  /**
-   * The maximum number of retry. 50 by default.
-   */
-  maxRetries?: number;
-
-  /**
-   * The function to decide how long to wait between retries.
-   */
-  timeout?: (retryCount: number) => number;
-};