algoliasearch 5.0.0-alpha.53 → 5.0.0-alpha.54

package/dist/lite/builds/browser.d.ts

@@ -1,6 +1,6 @@
-import type { ClientOptions } from '@algolia/client-common';
-import type { LiteClient } from '../src/liteClient';
-export { apiClientVersion, LiteClient } from '../src/liteClient';
-export * from '../model';
-export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
+import type { ClientOptions } from '@algolia/client-common';
+import type { LiteClient } from '../src/liteClient';
+export { apiClientVersion, LiteClient } from '../src/liteClient';
+export * from '../model';
+export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
 //# sourceMappingURL=browser.d.ts.map

package/dist/lite/builds/node.d.ts

@@ -1,6 +1,6 @@
-import type { ClientOptions } from '@algolia/client-common';
-import type { LiteClient } from '../src/liteClient';
-export { apiClientVersion, LiteClient } from '../src/liteClient';
-export * from '../model';
-export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
+import type { ClientOptions } from '@algolia/client-common';
+import type { LiteClient } from '../src/liteClient';
+export { apiClientVersion, LiteClient } from '../src/liteClient';
+export * from '../model';
+export declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
 //# sourceMappingURL=node.d.ts.map

package/dist/lite/lite.cjs.js

@@ -5,191 +5,191 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion = '5.0.0-alpha.53';
-function getDefaultHosts(appId) {
-    return [
-        {
-            url: `${appId}-dsn.algolia.net`,
-            accept: 'read',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}.algolia.net`,
-            accept: 'write',
-            protocol: 'https',
-        },
-    ].concat(clientCommon.shuffle([
-        {
-            url: `${appId}-1.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}-2.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}-3.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-    ]));
-}
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
-    const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
-    const transporter = clientCommon.createTransporter({
-        hosts: getDefaultHosts(appIdOption),
-        ...options,
-        algoliaAgent: clientCommon.getAlgoliaAgent({
-            algoliaAgents,
-            client: 'Lite',
-            version: apiClientVersion,
-        }),
-        baseHeaders: {
-            'content-type': 'text/plain',
-            ...auth.headers(),
-            ...options.baseHeaders,
-        },
-        baseQueryParameters: {
-            ...auth.queryParameters(),
-            ...options.baseQueryParameters,
-        },
-    });
-    return {
-        transporter,
-        /**
-         * The `appId` currently in use.
-         */
-        appId: appIdOption,
-        /**
-         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-         */
-        clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
-        },
-        /**
-         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-         */
-        get _ua() {
-            return transporter.algoliaAgent.value;
-        },
-        /**
-         * Adds a `segment` to the `x-algolia-agent` sent with every requests.
-         *
-         * @param segment - The algolia agent (user-agent) segment to add.
-         * @param version - The version of the agent.
-         */
-        addAlgoliaAgent(segment, version) {
-            transporter.algoliaAgent.add({ segment, version });
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param post - The post object.
-         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param post.parameters - Query parameters to be applied to the current query.
-         * @param post.body - The parameters to send with the custom request.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        post({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `post`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'POST',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: body ? body : {},
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * Perform a search operation targeting one or many indices.
-         *
-         * @summary Search multiple indices.
-         * @param searchMethodParams - The `search` requests and strategy.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        search(searchMethodParams, requestOptions) {
-            if (searchMethodParams && Array.isArray(searchMethodParams)) {
-                const newSignatureRequest = {
-                    requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
-                        if (legacyRequest.type === 'facet') {
-                            return {
-                                ...legacyRequest,
-                                ...params,
-                                type: 'facet',
-                            };
-                        }
-                        return {
-                            ...legacyRequest,
-                            ...params,
-                            facet: undefined,
-                            maxFacetHits: undefined,
-                            facetQuery: undefined,
-                        };
-                    }),
-                };
-                // eslint-disable-next-line no-param-reassign
-                searchMethodParams = newSignatureRequest;
-            }
-            if (!searchMethodParams) {
-                throw new Error('Parameter `searchMethodParams` is required when calling `search`.');
-            }
-            if (!searchMethodParams.requests) {
-                throw new Error('Parameter `searchMethodParams.requests` is required when calling `search`.');
-            }
-            const requestPath = '/1/indexes/*/queries';
-            const headers = {};
-            const queryParameters = {};
-            const request = {
-                method: 'POST',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: searchMethodParams,
-                useReadTransporter: true,
-                cacheable: true,
-            };
-            return transporter.request(request, requestOptions);
-        },
-    };
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+const apiClientVersion = '5.0.0-alpha.54';
+function getDefaultHosts(appId) {
+    return [
+        {
+            url: `${appId}-dsn.algolia.net`,
+            accept: 'read',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}.algolia.net`,
+            accept: 'write',
+            protocol: 'https',
+        },
+    ].concat(clientCommon.shuffle([
+        {
+            url: `${appId}-1.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-2.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-3.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+    ]));
+}
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
+    const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = clientCommon.createTransporter({
+        hosts: getDefaultHosts(appIdOption),
+        ...options,
+        algoliaAgent: clientCommon.getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Lite',
+            version: apiClientVersion,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * The `appId` currently in use.
+         */
+        appId: appIdOption,
+        /**
+         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+         */
+        clearCache() {
+            return Promise.all([
+                transporter.requestsCache.clear(),
+                transporter.responsesCache.clear(),
+            ]).then(() => undefined);
+        },
+        /**
+         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+         */
+        get _ua() {
+            return transporter.algoliaAgent.value;
+        },
+        /**
+         * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+         *
+         * @param segment - The algolia agent (user-agent) segment to add.
+         * @param version - The version of the agent.
+         */
+        addAlgoliaAgent(segment, version) {
+            transporter.algoliaAgent.add({ segment, version });
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param post - The post object.
+         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+         * @param post.parameters - Query parameters to be applied to the current query.
+         * @param post.body - The parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        post({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `post`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Perform a search operation targeting one or many indices.
+         *
+         * @summary Search multiple indices.
+         * @param searchMethodParams - The `search` requests and strategy.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        search(searchMethodParams, requestOptions) {
+            if (searchMethodParams && Array.isArray(searchMethodParams)) {
+                const newSignatureRequest = {
+                    requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
+                        if (legacyRequest.type === 'facet') {
+                            return {
+                                ...legacyRequest,
+                                ...params,
+                                type: 'facet',
+                            };
+                        }
+                        return {
+                            ...legacyRequest,
+                            ...params,
+                            facet: undefined,
+                            maxFacetHits: undefined,
+                            facetQuery: undefined,
+                        };
+                    }),
+                };
+                // eslint-disable-next-line no-param-reassign
+                searchMethodParams = newSignatureRequest;
+            }
+            if (!searchMethodParams) {
+                throw new Error('Parameter `searchMethodParams` is required when calling `search`.');
+            }
+            if (!searchMethodParams.requests) {
+                throw new Error('Parameter `searchMethodParams.requests` is required when calling `search`.');
+            }
+            const requestPath = '/1/indexes/*/queries';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchMethodParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+    };
 }
 
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-function liteClient(appId, apiKey, options) {
-    if (!appId || typeof appId !== 'string') {
-        throw new Error('`appId` is missing.');
-    }
-    if (!apiKey || typeof apiKey !== 'string') {
-        throw new Error('`apiKey` is missing.');
-    }
-    return createLiteClient({
-        appId,
-        apiKey,
-        timeouts: {
-            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
-            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: requesterNodeHttp.createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: clientCommon.createNullCache(),
-        requestsCache: clientCommon.createNullCache(),
-        hostsCache: clientCommon.createMemoryCache(),
-        ...options,
-    });
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+function liteClient(appId, apiKey, options) {
+    if (!appId || typeof appId !== 'string') {
+        throw new Error('`appId` is missing.');
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+        throw new Error('`apiKey` is missing.');
+    }
+    return createLiteClient({
+        appId,
+        apiKey,
+        timeouts: {
+            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
+            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
+            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
+        },
+        requester: requesterNodeHttp.createHttpRequester(),
+        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+        responsesCache: clientCommon.createNullCache(),
+        requestsCache: clientCommon.createNullCache(),
+        hostsCache: clientCommon.createMemoryCache(),
+        ...options,
+    });
 }
 
 exports.apiClientVersion = apiClientVersion;