@algolia/client-search 5.0.0-alpha.1 → 5.0.0-alpha.10

package/dist/builds/browser.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAYhE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,iBAAiB,GAC1B,YAAY,CA8Bd"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAY5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CA8Bd"}

package/dist/builds/node.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAWhE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,iBAAiB,GAC1B,YAAY,CAwBd"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CAwBd"}

package/dist/client-search.cjs.js

@@ -6,7 +6,7 @@ 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.1';
+const apiClientVersion = '5.0.0-alpha.10';
 function getDefaultHosts(appId) {
     return [
         {
@@ -60,6 +60,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
     });
     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.
          */
@@ -76,38 +89,57 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             transporter.algoliaAgent.add({ segment, version });
         },
         /**
-         * Helper: Wait for a task to complete with `indexName` and `taskID`.
+         * Helper: Wait for a task to be published (completed) for a given `indexName` and `taskID`.
          *
-         * @summary Wait for a task to complete.
+         * @summary Helper method that waits for a task to be published (completed).
          * @param waitForTaskOptions - The waitForTaskOptions object.
          * @param waitForTaskOptions.indexName - The `indexName` where the operation was performed.
          * @param waitForTaskOptions.taskID - The `taskID` returned in the method response.
+         * @param waitForTaskOptions.maxRetries - The maximum number of retries. 50 by default.
+         * @param waitForTaskOptions.timeout - The function to decide how long to wait between retries.
          * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
          */
-        waitForTask({ indexName, taskID, ...createRetryablePromiseOptions }, requestOptions) {
-            return clientCommon.createRetryablePromise({
-                ...createRetryablePromiseOptions,
+        waitForTask({ indexName, taskID, maxRetries = 50, timeout = (retryCount) => Math.min(retryCount * 200, 5000), }, requestOptions) {
+            let retryCount = 0;
+            return clientCommon.createIterablePromise({
                 func: () => this.getTask({ indexName, taskID }, requestOptions),
                 validate: (response) => response.status === 'published',
+                aggregator: () => (retryCount += 1),
+                error: {
+                    validate: () => retryCount >= maxRetries,
+                    message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`,
+                },
+                timeout: () => timeout(retryCount),
             });
         },
         /**
          * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
          *
-         * @summary Wait for an API key task to be processed.
+         * @summary Helper method that waits for an API key task to be processed.
          * @param waitForApiKeyOptions - The waitForApiKeyOptions object.
          * @param waitForApiKeyOptions.operation - The `operation` that was done on a `key`.
          * @param waitForApiKeyOptions.key - The `key` that has been added, deleted or updated.
          * @param waitForApiKeyOptions.apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.
+         * @param waitForApiKeyOptions.maxRetries - The maximum number of retries. 50 by default.
+         * @param waitForApiKeyOptions.timeout - The function to decide how long to wait between retries.
          * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
          */
-        waitForApiKey({ operation, key, apiKey, ...createRetryablePromiseOptions }, requestOptions) {
+        waitForApiKey({ operation, key, apiKey, maxRetries = 50, timeout = (retryCount) => Math.min(retryCount * 200, 5000), }, requestOptions) {
+            let retryCount = 0;
+            const baseIteratorOptions = {
+                aggregator: () => (retryCount += 1),
+                error: {
+                    validate: () => retryCount >= maxRetries,
+                    message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`,
+                },
+                timeout: () => timeout(retryCount),
+            };
             if (operation === 'update') {
                 if (!apiKey) {
                     throw new Error('`apiKey` is required when waiting for an `update` operation.');
                 }
-                return clientCommon.createRetryablePromise({
-                    ...createRetryablePromiseOptions,
+                return clientCommon.createIterablePromise({
+                    ...baseIteratorOptions,
                     func: () => this.getApiKey({ key }, requestOptions),
                     validate: (response) => {
                         for (const field of Object.keys(apiKey)) {
@@ -125,12 +157,99 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                     },
                 });
             }
-            return clientCommon.createRetryablePromise({
-                ...createRetryablePromiseOptions,
+            return clientCommon.createIterablePromise({
+                ...baseIteratorOptions,
                 func: () => this.getApiKey({ key }, requestOptions).catch((error) => error),
                 validate: (error) => operation === 'add' ? error.status !== 404 : error.status === 404,
             });
         },
+        /**
+         * Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
+         *
+         * @summary Helper method that iterates on the `browse` method.
+         * @param browseObjects - The browseObjects object.
+         * @param browseObjects.indexName - The index in which to perform the request.
+         * @param browseObjects.browseParams - The `browse` parameters.
+         * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
+         * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
+         */
+        browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
+            return clientCommon.createIterablePromise({
+                func: (previousResponse) => {
+                    return this.browse({
+                        indexName,
+                        browseParams: {
+                            cursor: previousResponse ? previousResponse.cursor : undefined,
+                            ...browseParams,
+                        },
+                    }, requestOptions);
+                },
+                validate: (response) => response.cursor === undefined,
+                ...browseObjectsOptions,
+            });
+        },
+        /**
+         * Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
+         *
+         * @summary Helper method that iterates on the `searchRules` method.
+         * @param browseObjects - The browseObjects object.
+         * @param browseObjects.indexName - The index in which to perform the request.
+         * @param browseObjects.searchRulesParams - The `searchRules` method parameters.
+         * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
+         * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
+         */
+        browseRules({ indexName, searchRulesParams, ...browseRulesOptions }, requestOptions) {
+            const params = {
+                hitsPerPage: 1000,
+                ...searchRulesParams,
+            };
+            return clientCommon.createIterablePromise({
+                func: (previousResponse) => {
+                    return this.searchRules({
+                        indexName,
+                        searchRulesParams: {
+                            ...params,
+                            page: previousResponse
+                                ? previousResponse.page + 1
+                                : params.page || 0,
+                        },
+                    }, requestOptions);
+                },
+                validate: (response) => response.nbHits < params.hitsPerPage,
+                ...browseRulesOptions,
+            });
+        },
+        /**
+         * Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index.
+         *
+         * @summary Helper method that iterates on the `searchSynonyms` method.
+         * @param browseObjects - The browseObjects object.
+         * @param browseObjects.indexName - The index in which to perform the request.
+         * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
+         * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
+         */
+        browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }, requestOptions) {
+            const params = {
+                hitsPerPage: 1000,
+                ...browseSynonymsOptions,
+            };
+            return clientCommon.createIterablePromise({
+                func: (previousResponse) => {
+                    return this.searchSynonyms({
+                        ...params,
+                        indexName,
+                        page: previousResponse
+                            ? previousResponse.page + 1
+                            : browseSynonymsOptions.page || 0,
+                    }, requestOptions);
+                },
+                validate: (response) => response.nbHits < params.hitsPerPage,
+                ...browseSynonymsOptions,
+            });
+        },
         /**
          * Add a new API Key with specific permissions/restrictions.
          *
@@ -264,6 +383,9 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!batchWriteParams) {
                 throw new Error('Parameter `batchWriteParams` is required when calling `batch`.');
             }
+            if (!batchWriteParams.requests) {
+                throw new Error('Parameter `batchWriteParams.requests` is required when calling `batch`.');
+            }
             const requestPath = '/1/indexes/{indexName}/batch'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
@@ -350,10 +472,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Retrieve all index content.
          * @param browse - The browse object.
          * @param browse.indexName - The index in which to perform the request.
-         * @param browse.browseRequest - The browseRequest object.
+         * @param browse.browseParams - The browseParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        browse({ indexName, browseRequest }, requestOptions) {
+        browse({ indexName, browseParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `browse`.');
             }
@@ -365,7 +487,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: browseRequest ? browseRequest : {},
+                data: browseParams ? browseParams : {},
             };
             return transporter.request(request, requestOptions);
         },
@@ -756,7 +878,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param getLogs.type - Type of log entries to retrieve. When omitted, all log entries are retrieved.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getLogs({ offset, length, indexName, type }, requestOptions) {
+        getLogs({ offset, length, indexName, type } = {}, requestOptions = undefined) {
             const requestPath = '/1/logs';
             const headers = {};
             const queryParameters = {};
@@ -824,6 +946,9 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!getObjectsParams) {
                 throw new Error('Parameter `getObjectsParams` is required when calling `getObjects`.');
             }
+            if (!getObjectsParams.requests) {
+                throw new Error('Parameter `getObjectsParams.requests` is required when calling `getObjects`.');
+            }
             const requestPath = '/1/indexes/*/objects';
             const headers = {};
             const queryParameters = {};
@@ -1015,7 +1140,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param hasPendingMappings.getClusters - If the clusters pending mapping state should be on the response.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        hasPendingMappings({ getClusters }, requestOptions) {
+        hasPendingMappings({ getClusters } = {}, requestOptions = undefined) {
             const requestPath = '/1/clusters/mapping/pending';
             const headers = {};
             const queryParameters = {};
@@ -1074,7 +1199,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param listIndices.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        listIndices({ page }, requestOptions) {
+        listIndices({ page } = {}, requestOptions = undefined) {
             const requestPath = '/1/indexes';
             const headers = {};
             const queryParameters = {};
@@ -1098,7 +1223,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param listUserIds.hitsPerPage - Maximum number of objects to retrieve.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        listUserIds({ page, hitsPerPage }, requestOptions) {
+        listUserIds({ page, hitsPerPage } = {}, requestOptions = undefined) {
             const requestPath = '/1/clusters/mapping';
             const headers = {};
             const queryParameters = {};
@@ -1127,6 +1252,9 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!batchParams) {
                 throw new Error('Parameter `batchParams` is required when calling `multipleBatch`.');
             }
+            if (!batchParams.requests) {
+                throw new Error('Parameter `batchParams.requests` is required when calling `multipleBatch`.');
+            }
             const requestPath = '/1/indexes/*/batch';
             const headers = {};
             const queryParameters = {};
@@ -1180,19 +1308,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param partialUpdateObject - The partialUpdateObject object.
          * @param partialUpdateObject.indexName - The index in which to perform the request.
          * @param partialUpdateObject.objectID - Unique identifier of an object.
-         * @param partialUpdateObject.attributeOrBuiltInOperation - List of attributes to update.
+         * @param partialUpdateObject.attributesToUpdate - Map of attribute(s) to update.
          * @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        partialUpdateObject({ indexName, objectID, attributeOrBuiltInOperation, createIfNotExists, }, requestOptions) {
+        partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `partialUpdateObject`.');
             }
             if (!objectID) {
                 throw new Error('Parameter `objectID` is required when calling `partialUpdateObject`.');
             }
-            if (!attributeOrBuiltInOperation) {
-                throw new Error('Parameter `attributeOrBuiltInOperation` is required when calling `partialUpdateObject`.');
+            if (!attributesToUpdate) {
+                throw new Error('Parameter `attributesToUpdate` is required when calling `partialUpdateObject`.');
             }
             const requestPath = '/1/indexes/{indexName}/{objectID}/partial'
                 .replace('{indexName}', encodeURIComponent(indexName))
@@ -1207,7 +1335,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: attributeOrBuiltInOperation,
+                data: attributesToUpdate,
             };
             return transporter.request(request, requestOptions);
         },
@@ -1408,17 +1536,17 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @summary Save a batch of rules.
          * @param saveRules - The saveRules object.
          * @param saveRules.indexName - The index in which to perform the request.
-         * @param saveRules.rule - The rule object.
+         * @param saveRules.rules - The rules object.
          * @param saveRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
          * @param saveRules.clearExistingRules - When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        saveRules({ indexName, rule, forwardToReplicas, clearExistingRules, }, requestOptions) {
+        saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `saveRules`.');
             }
-            if (!rule) {
-                throw new Error('Parameter `rule` is required when calling `saveRules`.');
+            if (!rules) {
+                throw new Error('Parameter `rules` is required when calling `saveRules`.');
             }
             const requestPath = '/1/indexes/{indexName}/rules/batch'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
@@ -1434,7 +1562,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: rule,
+                data: rules,
             };
             return transporter.request(request, requestOptions);
         },
@@ -1645,9 +1773,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `searchRules`.');
             }
-            if (!searchRulesParams) {
-                throw new Error('Parameter `searchRulesParams` is required when calling `searchRules`.');
-            }
             const requestPath = '/1/indexes/{indexName}/rules/search'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
@@ -1656,7 +1781,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: searchRulesParams,
+                data: searchRulesParams ? searchRulesParams : {},
                 useReadTransporter: true,
                 cacheable: true,
             };
@@ -1675,9 +1800,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `searchSingleIndex`.');
             }
-            if (!searchParams) {
-                throw new Error('Parameter `searchParams` is required when calling `searchSingleIndex`.');
-            }
             const requestPath = '/1/indexes/{indexName}/query'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
@@ -1686,7 +1808,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: searchParams,
+                data: searchParams ? searchParams : {},
                 useReadTransporter: true,
                 cacheable: true,
             };