@algolia/client-common 5.0.0-alpha.11 → 5.0.0-alpha.111

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

@@ -1,7 +1,7 @@
-export * from './cache';
-export * from './createClient';
-export * from './createIterablePromise';
-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/requester.d.ts

@@ -1,66 +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>;
-};
+import type { Headers, QueryParameters } from './transporter';
+/**
+ * The method of the request.
+ */
+export type Method = 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
+export 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 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 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 type Requester = {
+    /**
+     * Sends the given `request` to the server.
+     */
+    send: (request: EndRequest) => Promise<Response>;
+};
+export 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

@@ -1 +1 @@
-{"version":3,"file":"requester.d.ts","sourceRoot":"","sources":["../../../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":["../../../src/types/requester.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAEjE,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,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

@@ -1,128 +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>;
-};
+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>;
+export 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 type StackFrame = {
+    request: EndRequest;
+    response: Response;
+    host: Host;
+    triesLeft: number;
+};
+export type AlgoliaAgentOptions = {
+    /**
+     * The segment. Usually the integration name.
+     */
+    segment: string;
+    /**
+     * The version. Usually the integration version.
+     */
+    version?: string;
+};
+export 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 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 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 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

@@ -1 +1 @@
-{"version":3,"file":"transporter.d.ts","sourceRoot":"","sources":["../../../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":["../../../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,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAElD,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,YAAY,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,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/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@algolia/client-common",
-  "version": "5.0.0-alpha.11",
+  "version": "5.0.0-alpha.111",
   "description": "Common package for the Algolia JavaScript API client.",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
-  "main": "dist/client-common.cjs.js",
+  "type": "module",
+  "main": "dist/client-common.cjs",
   "module": "dist/client-common.esm.node.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -19,12 +20,14 @@
     "test": "jest"
   },
   "devDependencies": {
-    "@types/jest": "28.1.7",
-    "@types/node": "16.11.47",
-    "jest": "28.1.3",
-    "jest-environment-jsdom": "28.1.3",
-    "ts-jest": "28.0.8",
-    "typescript": "4.7.4"
+    "@babel/preset-env": "7.24.3",
+    "@babel/preset-typescript": "7.24.1",
+    "@types/jest": "29.5.12",
+    "@types/node": "20.11.30",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "ts-jest": "29.1.2",
+    "typescript": "5.4.3"
   },
   "engines": {
     "node": ">= 14.0.0"

package/src/__tests__/cache/browser-local-storage-cache.test.ts

@@ -39,6 +39,24 @@ describe('browser local storage cache', () => {
     expect(missMock.mock.calls.length).toBe(1);
   });
 
+  it('reads unexpired timeToLive keys', async () => {
+    const cache = createBrowserLocalStorageCache({
+      key: version,
+      timeToLive: 5,
+    });
+    await cache.set({ key: 'foo' }, { bar: 1 });
+
+    const defaultValue = (): DefaultValue => Promise.resolve({ bar: 2 });
+
+    expect(
+      await cache.get({ key: 'foo' }, defaultValue, {
+        miss: () => Promise.resolve(missMock()),
+      })
+    ).toMatchObject({ bar: 1 });
+
+    expect(missMock.mock.calls.length).toBe(0);
+  });
+
   it('deletes keys', async () => {
     const cache = createBrowserLocalStorageCache({ key: version });
 
@@ -53,19 +71,43 @@ describe('browser local storage cache', () => {
     expect(missMock.mock.calls.length).toBe(1);
   });
 
+  it('deletes expired keys', async () => {
+    const cache = createBrowserLocalStorageCache({
+      key: version,
+      timeToLive: -1,
+    });
+    await cache.set({ key: 'foo' }, { bar: 1 });
+
+    const defaultValue = (): DefaultValue => Promise.resolve({ bar: 2 });
+
+    expect(
+      await cache.get({ key: 'foo' }, defaultValue, {
+        miss: () => Promise.resolve(missMock()),
+      })
+    ).toMatchObject({ bar: 2 });
+
+    expect(missMock.mock.calls.length).toBe(1);
+  });
+
   it('can be cleared', async () => {
     const cache = createBrowserLocalStorageCache({ key: version });
-
     await cache.set({ key: 'foo' }, { bar: 1 });
+
     await cache.clear();
 
-    const defaultValue = (): DefaultValue => Promise.resolve({ bar: 2 });
+    const defaultValue = (): Promise<void> => Promise.resolve({ bar: 2 });
 
-    expect(await cache.get({ key: 'foo' }, defaultValue, events)).toMatchObject(
-      { bar: 2 }
-    );
-    expect(missMock.mock.calls.length).toBe(1);
     expect(localStorage.length).toBe(0);
+
+    expect(
+      await cache.get({ key: 'foo' }, defaultValue, {
+        miss: () => Promise.resolve(missMock()),
+      })
+    ).toMatchObject({ bar: 2 });
+
+    expect(missMock.mock.calls.length).toBe(1);
+
+    expect(localStorage.getItem(`algolia-client-js-${version}`)).toEqual('{}');
   });
 
   it('do throws localstorage exceptions on access', async () => {
@@ -122,13 +164,23 @@ describe('browser local storage cache', () => {
     });
     const key = { foo: 'bar' };
     const value = 'foo';
-
     expect(localStorage.getItem(`algolia-client-js-${version}`)).toBeNull();
 
     await cache.set(key, value);
 
-    expect(localStorage.getItem(`algolia-client-js-${version}`)).toBe(
-      '{"{\\"foo\\":\\"bar\\"}":"foo"}'
+    const expectedValue = expect.objectContaining({
+      [JSON.stringify(key)]: {
+        timestamp: expect.any(Number),
+        value,
+      },
+    });
+
+    const localStorageValue = localStorage.getItem(
+      `algolia-client-js-${version}`
+    );
+
+    expect(JSON.parse(localStorageValue ? localStorageValue : '{}')).toEqual(
+      expectedValue
     );
   });
 });

package/src/cache/createBrowserLocalStorageCache.ts

@@ -1,4 +1,9 @@
-import type { BrowserLocalStorageOptions, Cache, CacheEvents } from '../types';
+import type {
+  BrowserLocalStorageCacheItem,
+  BrowserLocalStorageOptions,
+  Cache,
+  CacheEvents,
+} from '../types';
 
 export function createBrowserLocalStorageCache(
   options: BrowserLocalStorageOptions
@@ -19,20 +24,61 @@ export function createBrowserLocalStorageCache(
     return JSON.parse(getStorage().getItem(namespaceKey) || '{}');
   }
 
+  function setNamespace(namespace: Record<string, any>): void {
+    getStorage().setItem(namespaceKey, JSON.stringify(namespace));
+  }
+
+  function removeOutdatedCacheItems(): void {
+    const timeToLive = options.timeToLive ? options.timeToLive * 1000 : null;
+    const namespace = getNamespace<BrowserLocalStorageCacheItem>();
+
+    const filteredNamespaceWithoutOldFormattedCacheItems = Object.fromEntries(
+      Object.entries(namespace).filter(([, cacheItem]) => {
+        return cacheItem.timestamp !== undefined;
+      })
+    );
+
+    setNamespace(filteredNamespaceWithoutOldFormattedCacheItems);
+
+    if (!timeToLive) {
+      return;
+    }
+
+    const filteredNamespaceWithoutExpiredItems = Object.fromEntries(
+      Object.entries(filteredNamespaceWithoutOldFormattedCacheItems).filter(
+        ([, cacheItem]) => {
+          const currentTimestamp = new Date().getTime();
+          const isExpired = cacheItem.timestamp + timeToLive < currentTimestamp;
+
+          return !isExpired;
+        }
+      )
+    );
+
+    setNamespace(filteredNamespaceWithoutExpiredItems);
+  }
+
   return {
     get<TValue>(
       key: Record<string, any> | string,
       defaultValue: () => Promise<TValue>,
       events: CacheEvents<TValue> = {
-        miss: (): Promise<void> => Promise.resolve(),
+        miss: () => Promise.resolve(),
       }
     ): Promise<TValue> {
       return Promise.resolve()
         .then(() => {
-          const keyAsString = JSON.stringify(key);
-          const value = getNamespace<TValue>()[keyAsString];
+          removeOutdatedCacheItems();
 
-          return Promise.all([value || defaultValue(), value !== undefined]);
+          return getNamespace<Promise<BrowserLocalStorageCacheItem>>()[
+            JSON.stringify(key)
+          ];
+        })
+        .then((value) => {
+          return Promise.all([
+            value ? value.value : defaultValue(),
+            value !== undefined,
+          ]);
         })
         .then(([value, exists]) => {
           return Promise.all([value, exists || events.miss(value)]);
@@ -47,7 +93,10 @@ export function createBrowserLocalStorageCache(
       return Promise.resolve().then(() => {
         const namespace = getNamespace();
 
-        namespace[JSON.stringify(key)] = value;
+        namespace[JSON.stringify(key)] = {
+          timestamp: new Date().getTime(),
+          value,
+        };
 
         getStorage().setItem(namespaceKey, JSON.stringify(namespace));