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

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/Cache.d.ts.map

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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/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/dist/src/types/Host.d.ts.map

@@ -1 +0,0 @@
-{"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/Requester.d.ts.map

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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/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;
-};