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

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './src/createAuth';
+export * from './src/createEchoRequester';
+export * from './src/createRetryablePromise';
+export * from './src/cache';
+export * from './src/transporter';
+export * from './src/createAlgoliaAgent';
+export * from './src/getAlgoliaAgent';
+export * from './src/types';
+export * from './src/constants';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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"}

package/dist/src/cache/createBrowserLocalStorageCache.d.ts

@@ -0,0 +1,3 @@
+import type { BrowserLocalStorageOptions, Cache } from '../types';
+export declare function createBrowserLocalStorageCache(options: BrowserLocalStorageOptions): Cache;
+//# sourceMappingURL=createBrowserLocalStorageCache.d.ts.map

package/dist/src/cache/createBrowserLocalStorageCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createBrowserLocalStorageCache.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/cache/createBrowserLocalStorageCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,KAAK,EAAe,MAAM,UAAU,CAAC;AAE/E,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,0BAA0B,GAClC,KAAK,CAqEP"}

package/dist/src/cache/createFallbackableCache.d.ts

@@ -0,0 +1,3 @@
+import type { FallbackableCacheOptions, Cache } from '../types';
+export declare function createFallbackableCache(options: FallbackableCacheOptions): Cache;
+//# sourceMappingURL=createFallbackableCache.d.ts.map

package/dist/src/cache/createFallbackableCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFallbackableCache.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/cache/createFallbackableCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,KAAK,EAAe,MAAM,UAAU,CAAC;AAI7E,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,wBAAwB,GAChC,KAAK,CA8CP"}

package/dist/src/cache/createMemoryCache.d.ts

@@ -0,0 +1,3 @@
+import type { Cache, MemoryCacheOptions } from '../types';
+export declare function createMemoryCache(options?: MemoryCacheOptions): Cache;
+//# sourceMappingURL=createMemoryCache.d.ts.map

package/dist/src/cache/createMemoryCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMemoryCache.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/cache/createMemoryCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAe,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEvE,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,kBAA2C,GACnD,KAAK,CAmDP"}

package/dist/src/cache/createNullCache.d.ts

@@ -0,0 +1,3 @@
+import type { Cache } from '../types';
+export declare function createNullCache(): Cache;
+//# sourceMappingURL=createNullCache.d.ts.map

package/dist/src/cache/createNullCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createNullCache.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/cache/createNullCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAe,MAAM,UAAU,CAAC;AAEnD,wBAAgB,eAAe,IAAI,KAAK,CA+BvC"}

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

@@ -0,0 +1,5 @@
+export * from './createBrowserLocalStorageCache';
+export * from './createFallbackableCache';
+export * from './createMemoryCache';
+export * from './createNullCache';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/cache/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}

package/dist/src/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const DEFAULT_CONNECT_TIMEOUT_BROWSER = 1000;
+export declare const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
+export declare const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
+export declare const DEFAULT_CONNECT_TIMEOUT_NODE = 2000;
+export declare const DEFAULT_READ_TIMEOUT_NODE = 5000;
+export declare const DEFAULT_WRITE_TIMEOUT_NODE = 30000;
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../packages/client-common/src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,+BAA+B,OAAO,CAAC;AACpD,eAAO,MAAM,4BAA4B,OAAO,CAAC;AACjD,eAAO,MAAM,6BAA6B,QAAQ,CAAC;AAEnD,eAAO,MAAM,4BAA4B,OAAO,CAAC;AACjD,eAAO,MAAM,yBAAyB,OAAO,CAAC;AAC9C,eAAO,MAAM,0BAA0B,QAAQ,CAAC"}

package/dist/src/createAlgoliaAgent.d.ts

@@ -0,0 +1,3 @@
+import type { AlgoliaAgent } from './types';
+export declare function createAlgoliaAgent(version: string): AlgoliaAgent;
+//# sourceMappingURL=createAlgoliaAgent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createAlgoliaAgent.d.ts","sourceRoot":"","sources":["../../../../packages/client-common/src/createAlgoliaAgent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAuB,YAAY,EAAE,MAAM,SAAS,CAAC;AAEjE,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,CAiBhE"}

package/dist/src/createAuth.d.ts

@@ -0,0 +1,6 @@
+import type { AuthMode, Headers, QueryParameters } from './types';
+export declare function createAuth(appId: string, apiKey: string, authMode?: AuthMode): {
+    readonly headers: () => Headers;
+    readonly queryParameters: () => QueryParameters;
+};
+//# sourceMappingURL=createAuth.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createAuth.d.ts","sourceRoot":"","sources":["../../../../packages/client-common/src/createAuth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAElE,wBAAgB,UAAU,CACxB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,GAAE,QAA0B,GACnC;IACD,QAAQ,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC;IAChC,QAAQ,CAAC,eAAe,EAAE,MAAM,eAAe,CAAC;CACjD,CAeA"}

package/dist/src/createEchoRequester.d.ts

@@ -0,0 +1,7 @@
+import type { Requester } from './types';
+export declare type EchoRequesterParams = {
+    getURL: (url: string) => URL;
+    status?: number;
+};
+export declare function createEchoRequester({ getURL, status, }: EchoRequesterParams): Requester;
+//# sourceMappingURL=createEchoRequester.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createEchoRequester.d.ts","sourceRoot":"","sources":["../../../../packages/client-common/src/createEchoRequester.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA4B,SAAS,EAAY,MAAM,SAAS,CAAC;AAE7E,oBAAY,mBAAmB,GAAG;IAChC,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,GAAG,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AA2BF,wBAAgB,mBAAmB,CAAC,EAClC,MAAM,EACN,MAAY,GACb,EAAE,mBAAmB,GAAG,SAAS,CAuBjC"}

package/dist/src/createRetryablePromise.d.ts

@@ -0,0 +1,14 @@
+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

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

@@ -0,0 +1,8 @@
+import type { AlgoliaAgentOptions, AlgoliaAgent } from './types';
+export declare type GetAlgoliaAgent = {
+    algoliaAgents: AlgoliaAgentOptions[];
+    client: string;
+    version: string;
+};
+export declare function getAlgoliaAgent({ algoliaAgents, client, version, }: GetAlgoliaAgent): AlgoliaAgent;
+//# sourceMappingURL=getAlgoliaAgent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getAlgoliaAgent.d.ts","sourceRoot":"","sources":["../../../../packages/client-common/src/getAlgoliaAgent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEjE,oBAAY,eAAe,GAAG;IAC5B,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wBAAgB,eAAe,CAAC,EAC9B,aAAa,EACb,MAAM,EACN,OAAO,GACR,EAAE,eAAe,GAAG,YAAY,CAWhC"}

package/dist/src/transporter/createStatefulHost.d.ts

@@ -0,0 +1,3 @@
+import type { Host, StatefulHost } from '../types';
+export declare function createStatefulHost(host: Host, status?: StatefulHost['status']): StatefulHost;
+//# sourceMappingURL=createStatefulHost.d.ts.map

package/dist/src/transporter/createStatefulHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createStatefulHost.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/transporter/createStatefulHost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAMnD,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,MAAM,GAAE,YAAY,CAAC,QAAQ,CAAQ,GACpC,YAAY,CAcd"}

package/dist/src/transporter/createTransporter.d.ts

@@ -0,0 +1,3 @@
+import type { TransporterOptions, Transporter } from '../types';
+export declare function createTransporter({ hosts, hostsCache, baseHeaders, baseQueryParameters, algoliaAgent, timeouts, requester, requestsCache, responsesCache, }: TransporterOptions): Transporter;
+//# sourceMappingURL=createTransporter.d.ts.map

package/dist/src/transporter/createTransporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTransporter.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/transporter/createTransporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAOV,kBAAkB,EAClB,WAAW,EAEZ,MAAM,UAAU,CAAC;AAsBlB,wBAAgB,iBAAiB,CAAC,EAChC,KAAK,EACL,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,aAAa,EACb,cAAc,GACf,EAAE,kBAAkB,GAAG,WAAW,CAgTlC"}

package/dist/src/transporter/errors.d.ts

@@ -0,0 +1,21 @@
+import type { Response, StackFrame } from '../types';
+export declare class AlgoliaError extends Error {
+    name: string;
+    constructor(message: string, name: string);
+}
+export declare class ErrorWithStackTrace extends AlgoliaError {
+    stackTrace: StackFrame[];
+    constructor(message: string, stackTrace: StackFrame[], name: string);
+}
+export declare class RetryError extends ErrorWithStackTrace {
+    constructor(stackTrace: StackFrame[]);
+}
+export declare class ApiError extends ErrorWithStackTrace {
+    status: number;
+    constructor(message: string, status: number, stackTrace: StackFrame[]);
+}
+export declare class DeserializationError extends AlgoliaError {
+    response: Response;
+    constructor(message: string, response: Response);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/src/transporter/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/transporter/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAErD,qBAAa,YAAa,SAAQ,KAAK;IACrC,IAAI,EAAE,MAAM,CAAkB;gBAElB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAO1C;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,UAAU,EAAE,UAAU,EAAE,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM;CAKpE;AAED,qBAAa,UAAW,SAAQ,mBAAmB;gBACrC,UAAU,EAAE,UAAU,EAAE;CAOrC;AAED,qBAAa,QAAS,SAAQ,mBAAmB;IAC/C,MAAM,EAAE,MAAM,CAAC;gBAEH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE;CAItE;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,QAAQ,EAAE,QAAQ,CAAC;gBAEP,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;CAIhD"}

package/dist/src/transporter/helpers.d.ts

@@ -0,0 +1,9 @@
+import type { Headers, Host, QueryParameters, Request, RequestOptions, Response, StackFrame } from '../types';
+export declare function shuffle<TData>(array: TData[]): TData[];
+export declare function serializeUrl(host: Host, path: string, queryParameters: QueryParameters): string;
+export declare function serializeQueryParameters(parameters: QueryParameters): string;
+export declare function serializeData(request: Request, requestOptions: RequestOptions): string | undefined;
+export declare function serializeHeaders(baseHeaders: Headers, requestHeaders: Headers, requestOptionsHeaders?: Headers): Headers;
+export declare function deserializeSuccess<TObject>(response: Response): TObject;
+export declare function deserializeFailure({ content, status }: Response, stackFrame: StackFrame[]): Error;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/src/transporter/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/transporter/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,eAAe,EACf,OAAO,EACP,cAAc,EACd,QAAQ,EACR,UAAU,EACX,MAAM,UAAU,CAAC;AAIlB,wBAAgB,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAYtD;AAED,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,eAAe,GAC/B,MAAM,CAWR;AAED,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,eAAe,GAAG,MAAM,CAe5E;AAED,wBAAgB,aAAa,CAC3B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,cAAc,GAC7B,MAAM,GAAG,SAAS,CAapB;AAED,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,OAAO,EACpB,cAAc,EAAE,OAAO,EACvB,qBAAqB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAeT;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAMvE;AAED,wBAAgB,kBAAkB,CAChC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAC7B,UAAU,EAAE,UAAU,EAAE,GACvB,KAAK,CAQP"}

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

@@ -0,0 +1,7 @@
+export * from './createTransporter';
+export * from './createStatefulHost';
+export * from './errors';
+export * from './helpers';
+export * from './responses';
+export * from './stackTrace';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/transporter/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/dist/src/transporter/responses.d.ts

@@ -0,0 +1,5 @@
+import type { Response } from '../types';
+export declare function isNetworkError({ isTimedOut, status, }: Omit<Response, 'content'>): boolean;
+export declare function isRetryable({ isTimedOut, status, }: Omit<Response, 'content'>): boolean;
+export declare function isSuccess({ status }: Pick<Response, 'status'>): boolean;
+//# sourceMappingURL=responses.d.ts.map

package/dist/src/transporter/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/transporter/responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEzC,wBAAgB,cAAc,CAAC,EAC7B,UAAU,EACV,MAAM,GACP,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,OAAO,CAErC;AAED,wBAAgB,WAAW,CAAC,EAC1B,UAAU,EACV,MAAM,GACP,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,OAAO,CAMrC;AAED,wBAAgB,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,OAAO,CAEvE"}

package/dist/src/transporter/stackTrace.d.ts

@@ -0,0 +1,4 @@
+import type { StackFrame } from '../types';
+export declare function stackTraceWithoutCredentials(stackTrace: StackFrame[]): StackFrame[];
+export declare function stackFrameWithoutCredentials(stackFrame: StackFrame): StackFrame;
+//# sourceMappingURL=stackTrace.d.ts.map

package/dist/src/transporter/stackTrace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stackTrace.d.ts","sourceRoot":"","sources":["../../../../../packages/client-common/src/transporter/stackTrace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,UAAU,EAAE,MAAM,UAAU,CAAC;AAEpD,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,UAAU,EAAE,GACvB,UAAU,EAAE,CAId;AAED,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,UAAU,GACrB,UAAU,CAiBZ"}

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

@@ -0,0 +1,47 @@
+export declare type Cache = {
+    /**
+     * Gets the value of the given `key`.
+     */
+    get: <TValue>(key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events?: CacheEvents<TValue>) => Promise<TValue>;
+    /**
+     * Sets the given value with the given `key`.
+     */
+    set: <TValue>(key: Record<string, any> | string, value: TValue) => Promise<TValue>;
+    /**
+     * Deletes the given `key`.
+     */
+    delete: (key: Record<string, any> | string) => Promise<void>;
+    /**
+     * Clears the cache.
+     */
+    clear: () => Promise<void>;
+};
+export declare type CacheEvents<TValue> = {
+    /**
+     * The callback when the given `key` is missing from the cache.
+     */
+    miss: (value: TValue) => Promise<any>;
+};
+export declare type MemoryCacheOptions = {
+    /**
+     * If keys and values should be serialized using `JSON.stringify`.
+     */
+    serializable?: boolean;
+};
+export declare type BrowserLocalStorageOptions = {
+    /**
+     * The cache key.
+     */
+    key: string;
+    /**
+     * The native local storage implementation.
+     */
+    localStorage?: Storage;
+};
+export declare type FallbackableCacheOptions = {
+    /**
+     * List of caches order by priority.
+     */
+    caches: Cache[];
+};
+//# sourceMappingURL=Cache.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,12 @@
+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>> & {
+    appId: string;
+    apiKey: string;
+    authMode?: AuthMode;
+    algoliaAgents: AlgoliaAgentOptions[];
+};
+export declare type ClientOptions = Partial<Omit<CreateClientOptions, 'apiKey' | 'appId'>>;
+export {};
+//# sourceMappingURL=CreateClient.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,19 @@
+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

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

@@ -0,0 +1,33 @@
+export declare type Host = {
+    /**
+     * The host URL.
+     */
+    url: string;
+    /**
+     * The accepted transporter.
+     */
+    accept: 'read' | 'readWrite' | 'write';
+    /**
+     * The protocol of the host URL.
+     */
+    protocol: 'http' | 'https';
+};
+export declare type StatefulHost = Host & {
+    /**
+     * The status of the host.
+     */
+    status: 'down' | 'timed out' | 'up';
+    /**
+     * The last update of the host status, used to compare with the expiration delay.
+     */
+    lastUpdate: number;
+    /**
+     * Returns whether the host is up or not.
+     */
+    isUp: () => boolean;
+    /**
+     * Returns whether the host is timed out or not.
+     */
+    isTimedOut: () => boolean;
+};
+//# sourceMappingURL=Host.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,66 @@
+import type { Headers, QueryParameters } from './Transporter';
+/**
+ * The method of the request.
+ */
+export declare type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
+export declare type Request = {
+    method: Method;
+    /**
+     * The path of the REST API to send the request to.
+     */
+    path: string;
+    queryParameters: QueryParameters;
+    data?: Array<Record<string, any>> | Record<string, any>;
+    headers: Headers;
+    /**
+     * If the given request should persist on the cache. Keep in mind,
+     * that some methods may have this option enabled by default.
+     */
+    cacheable?: boolean;
+    /**
+     * Some POST methods in the Algolia REST API uses the `read` transporter.
+     * This information is defined at the spec level.
+     */
+    useReadTransporter?: boolean;
+};
+export declare type EndRequest = Pick<Request, 'headers' | 'method'> & {
+    /**
+     * The full URL of the REST API.
+     */
+    url: string;
+    /**
+     * The connection timeout, in milliseconds.
+     */
+    connectTimeout: number;
+    /**
+     * The response timeout, in milliseconds.
+     */
+    responseTimeout: number;
+    data?: string;
+};
+export declare type Response = {
+    /**
+     * The body of the response.
+     */
+    content: string;
+    /**
+     * Whether the API call is timed out or not.
+     */
+    isTimedOut: boolean;
+    /**
+     * The HTTP status code of the response.
+     */
+    status: number;
+};
+export declare type Requester = {
+    /**
+     * Sends the given `request` to the server.
+     */
+    send: (request: EndRequest) => Promise<Response>;
+};
+export declare type EchoResponse = Omit<EndRequest, 'data'> & Pick<Request, 'data' | 'path'> & {
+    host: string;
+    algoliaAgent: string;
+    searchParams?: Record<string, string>;
+};
+//# sourceMappingURL=Requester.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,128 @@
+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'> & {
+    /**
+     * Custom timeout for the request. Note that, in normal situations
+     * the given timeout will be applied. But the transporter layer may
+     * increase this timeout if there is need for it.
+     */
+    timeout?: number;
+    /**
+     * Custom headers for the request. This headers are
+     * going to be merged the transporter headers.
+     */
+    headers?: Headers;
+    /**
+     * Custom query parameters for the request. This query parameters are
+     * going to be merged the transporter query parameters.
+     */
+    queryParameters?: QueryParameters;
+    /**
+     * Custom data for the request. This data is
+     * going to be merged the transporter data.
+     */
+    data?: Array<Record<string, any>> | Record<string, any>;
+};
+export declare type StackFrame = {
+    request: EndRequest;
+    response: Response;
+    host: Host;
+    triesLeft: number;
+};
+export declare type AlgoliaAgentOptions = {
+    /**
+     * The segment. Usually the integration name.
+     */
+    segment: string;
+    /**
+     * The version. Usually the integration version.
+     */
+    version?: string;
+};
+export declare type AlgoliaAgent = {
+    /**
+     * The raw value of the user agent.
+     */
+    value: string;
+    /**
+     * Mutates the current user agent adding the given user agent options.
+     */
+    add: (options: AlgoliaAgentOptions) => AlgoliaAgent;
+};
+export declare type Timeouts = {
+    /**
+     * Timeout in milliseconds before the connection is established.
+     */
+    connect: number;
+    /**
+     * Timeout in milliseconds before reading the response on a read request.
+     */
+    read: number;
+    /**
+     * Timeout in milliseconds before reading the response on a write request.
+     */
+    write: number;
+};
+export declare type TransporterOptions = {
+    /**
+     * The cache of the hosts. Usually used to persist
+     * the state of the host when its down.
+     */
+    hostsCache: Cache;
+    /**
+     * The underlying requester used. Should differ
+     * depending of the environment where the client
+     * will be used.
+     */
+    requester: Requester;
+    /**
+     * The cache of the requests. When requests are
+     * `cacheable`, the returned promised persists
+     * in this cache to shared in similar requests
+     * before being resolved.
+     */
+    requestsCache: Cache;
+    /**
+     * The cache of the responses. When requests are
+     * `cacheable`, the returned responses persists
+     * in this cache to shared in similar requests.
+     */
+    responsesCache: Cache;
+    /**
+     * The timeouts used by the requester. The transporter
+     * layer may increase this timeouts as defined on the
+     * retry strategy.
+     */
+    timeouts: Timeouts;
+    /**
+     * The hosts used by the requester.
+     */
+    hosts: Host[];
+    /**
+     * The headers used by the requester. The transporter
+     * layer may add some extra headers during the request
+     * for the user agent, and others.
+     */
+    baseHeaders: Headers;
+    /**
+     * The query parameters used by the requester. The transporter
+     * layer may add some extra headers during the request
+     * for the user agent, and others.
+     */
+    baseQueryParameters: QueryParameters;
+    /**
+     * The user agent used. Sent on query parameters.
+     */
+    algoliaAgent: AlgoliaAgent;
+};
+export declare type Transporter = TransporterOptions & {
+    /**
+     * Performs a request.
+     * The `baseRequest` and `baseRequestOptions` will be merged accordingly.
+     */
+    request: <TResponse>(baseRequest: Request, baseRequestOptions?: RequestOptions) => Promise<TResponse>;
+};
+//# sourceMappingURL=Transporter.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,7 @@
+export * from './Cache';
+export * from './CreateClient';
+export * from './CreateRetryablePromise';
+export * from './Host';
+export * from './Requester';
+export * from './Transporter';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

package/index.ts

@@ -0,0 +1,9 @@
+export * from './src/createAuth';
+export * from './src/createEchoRequester';
+export * from './src/createRetryablePromise';
+export * from './src/cache';
+export * from './src/transporter';
+export * from './src/createAlgoliaAgent';
+export * from './src/getAlgoliaAgent';
+export * from './src/types';
+export * from './src/constants';