@algolia/client-search 5.50.2 → 5.52.0

package/dist/src/searchClient.js

@@ -7,7 +7,7 @@ import {
   getAlgoliaAgent,
   shuffle
 } from "@algolia/client-common";
-var apiClientVersion = "5.50.2";
+var apiClientVersion = "5.52.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -117,14 +117,14 @@ function createSearchClient({
      * @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.maxRetries - The maximum number of retries. 100 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,
-      maxRetries = 50,
+      maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
       let retryCount = 0;
@@ -134,7 +134,7 @@ function createSearchClient({
         aggregator: () => retryCount += 1,
         error: {
           validate: () => retryCount >= maxRetries,
-          message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`
+          message: () => `Stopped waiting for the task after ${maxRetries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher maxRetries.`
         },
         timeout: () => timeout(retryCount)
       });
@@ -145,13 +145,13 @@ function createSearchClient({
      * @summary Helper method that waits for a task to be published (completed).
      * @param waitForAppTaskOptions - The `waitForTaskOptions` object.
      * @param waitForAppTaskOptions.taskID - The `taskID` returned in the method response.
-     * @param waitForAppTaskOptions.maxRetries - The maximum number of retries. 50 by default.
+     * @param waitForAppTaskOptions.maxRetries - The maximum number of retries. 100 by default.
      * @param waitForAppTaskOptions.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.
      */
     waitForAppTask({
       taskID,
-      maxRetries = 50,
+      maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
       let retryCount = 0;
@@ -161,7 +161,7 @@ function createSearchClient({
         aggregator: () => retryCount += 1,
         error: {
           validate: () => retryCount >= maxRetries,
-          message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`
+          message: () => `Stopped waiting for the task after ${maxRetries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher maxRetries.`
         },
         timeout: () => timeout(retryCount)
       });
@@ -174,7 +174,7 @@ function createSearchClient({
      * @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.maxRetries - The maximum number of retries. 100 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.
      */
@@ -182,7 +182,7 @@ function createSearchClient({
       operation,
       key,
       apiKey,
-      maxRetries = 50,
+      maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
       let retryCount = 0;
@@ -190,7 +190,7 @@ function createSearchClient({
         aggregator: () => retryCount += 1,
         error: {
           validate: () => retryCount >= maxRetries,
-          message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`
+          message: () => `Stopped waiting for the API key operation after ${maxRetries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher maxRetries.`
         },
         timeout: () => timeout(retryCount)
       };
@@ -2002,11 +2002,11 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
+     * Runs multiple search queries against one or more indices in a single API request.  Use cases include:  - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters.  If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
      *
      * Required API Key ACLs:
      *  - search
-     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search(searchMethodParams, requestOptions) {