@algolia/client-search 5.56.0 → 5.59.0

package/dist/fetch.d.ts

@@ -748,6 +748,10 @@ type LogQuery = {
 };
 
 type Log = {
+    /**
+     * Correlation ID of the logged API request, also returned in that request\'s `Correlation-ID` response header.
+     */
+    cid?: string | undefined;
     /**
      * Date and time of the API request, in RFC 3339 format.
      */
@@ -3242,7 +3246,7 @@ type AccountCopyIndexOptions = ChunkedHelperOptions & {
     batchSize?: number | undefined;
 };
 
-declare const apiClientVersion = "5.56.0";
+declare const apiClientVersion = "5.59.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.TransporterWithHttpInfo;
     /**
@@ -3407,6 +3411,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
+     * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
+     *
      * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * @param replaceAllObjects - The `replaceAllObjects` object.
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -3417,7 +3423,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
     replaceAllObjects({ indexName, objects, batchSize, scopes, maxRetries, }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<ReplaceAllObjectsResponse>;
-    indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
+    indexExists({ indexName }: GetSettingsProps, requestOptions?: RequestOptions | undefined): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
      * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.

package/dist/node.d.cts

@@ -748,6 +748,10 @@ type LogQuery = {
 };
 
 type Log = {
+    /**
+     * Correlation ID of the logged API request, also returned in that request\'s `Correlation-ID` response header.
+     */
+    cid?: string | undefined;
     /**
      * Date and time of the API request, in RFC 3339 format.
      */
@@ -3242,7 +3246,7 @@ type AccountCopyIndexOptions = ChunkedHelperOptions & {
     batchSize?: number | undefined;
 };
 
-declare const apiClientVersion = "5.56.0";
+declare const apiClientVersion = "5.59.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.TransporterWithHttpInfo;
     /**
@@ -3407,6 +3411,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
+     * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
+     *
      * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * @param replaceAllObjects - The `replaceAllObjects` object.
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -3417,7 +3423,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
     replaceAllObjects({ indexName, objects, batchSize, scopes, maxRetries, }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<ReplaceAllObjectsResponse>;
-    indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
+    indexExists({ indexName }: GetSettingsProps, requestOptions?: RequestOptions | undefined): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
      * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.

package/dist/node.d.ts

@@ -748,6 +748,10 @@ type LogQuery = {
 };
 
 type Log = {
+    /**
+     * Correlation ID of the logged API request, also returned in that request\'s `Correlation-ID` response header.
+     */
+    cid?: string | undefined;
     /**
      * Date and time of the API request, in RFC 3339 format.
      */
@@ -3242,7 +3246,7 @@ type AccountCopyIndexOptions = ChunkedHelperOptions & {
     batchSize?: number | undefined;
 };
 
-declare const apiClientVersion = "5.56.0";
+declare const apiClientVersion = "5.59.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.TransporterWithHttpInfo;
     /**
@@ -3407,6 +3411,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
+     * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
+     *
      * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * @param replaceAllObjects - The `replaceAllObjects` object.
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -3417,7 +3423,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
     replaceAllObjects({ indexName, objects, batchSize, scopes, maxRetries, }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<ReplaceAllObjectsResponse>;
-    indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
+    indexExists({ indexName }: GetSettingsProps, requestOptions?: RequestOptions | undefined): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
      * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.

package/dist/src/searchClient.cjs

@@ -25,7 +25,7 @@ __export(searchClient_exports, {
 });
 module.exports = __toCommonJS(searchClient_exports);
 var import_client_common = require("@algolia/client-common");
-var apiClientVersion = "5.56.0";
+var apiClientVersion = "5.59.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -145,6 +145,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
       let retryCount = 0;
       return (0, import_client_common.createIterablePromise)({
         func: () => this.getTask({ indexName, taskID }, requestOptions),
@@ -172,6 +173,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
       let retryCount = 0;
       return (0, import_client_common.createIterablePromise)({
         func: () => this.getAppTask({ taskID }, requestOptions),
@@ -203,6 +205,7 @@ function createSearchClient({
       maxRetries = 100,
       timeout = (retryCount) => Math.min(retryCount * 200, 5e3)
     }, requestOptions) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
       let retryCount = 0;
       const baseIteratorOptions = {
         aggregator: () => retryCount += 1,
@@ -258,6 +261,7 @@ function createSearchClient({
      * @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) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
       return (0, import_client_common.createIterablePromise)({
         func: (previousResponse) => {
           return this.browse(
@@ -288,6 +292,7 @@ function createSearchClient({
      * @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) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
       const params = {
         ...searchRulesParams,
         hitsPerPage: (searchRulesParams == null ? void 0 : searchRulesParams.hitsPerPage) || 1e3
@@ -325,13 +330,14 @@ function createSearchClient({
       searchSynonymsParams,
       ...browseSynonymsOptions
     }, requestOptions) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
       const params = {
         ...searchSynonymsParams,
         page: (searchSynonymsParams == null ? void 0 : searchSynonymsParams.page) || 0,
         hitsPerPage: 1e3
       };
       return (0, import_client_common.createIterablePromise)({
-        func: (_) => {
+        func: (__) => {
           const resp = this.searchSynonyms(
             {
               indexName,
@@ -370,6 +376,7 @@ function createSearchClient({
       batchSize = 1e3,
       maxRetries = 100
     }, requestOptions) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
       let requests = [];
       const responses = [];
       const objectEntries = objects.entries();
@@ -382,7 +389,7 @@ function createSearchClient({
       }
       if (waitForTasks) {
         for (const resp of responses) {
-          await this.waitForTask({ indexName, taskID: resp.taskID, maxRetries });
+          await this.waitForTask({ indexName, taskID: resp.taskID, maxRetries }, requestOptions);
         }
       }
       return responses;
@@ -460,6 +467,8 @@ function createSearchClient({
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
      *
+     * Warning: calling this method with an empty `objects` list replaces the index with an empty one, deleting all existing records.
+     *
      * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * @param replaceAllObjects - The `replaceAllObjects` object.
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
@@ -476,6 +485,13 @@ function createSearchClient({
       scopes,
       maxRetries = import_client_common.DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES
     }, requestOptions) {
+      requestOptions = (0, import_client_common.withRequestId)(transporter, requestOptions);
+      if (objects.length === 0) {
+        (0, import_client_common.logWarning)(
+          transporter.logger,
+          `replaceAllObjects was called with an empty list of objects, which will delete all records currently in the "${indexName}" index.`
+        );
+      }
       const randomSuffix = Math.floor(Math.random() * 1e6) + 1e5;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
       if (scopes === void 0) {
@@ -497,11 +513,14 @@ function createSearchClient({
           { indexName: tmpIndexName, objects, waitForTasks: true, batchSize, maxRetries },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: copyOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         copyOperationResponse = await this.operationIndex(
           {
             indexName,
@@ -513,11 +532,14 @@ function createSearchClient({
           },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: copyOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: copyOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         const moveOperationResponse = await this.operationIndex(
           {
             indexName: tmpIndexName,
@@ -525,20 +547,23 @@ function createSearchClient({
           },
           requestOptions
         );
-        await this.waitForTask({
-          indexName: tmpIndexName,
-          taskID: moveOperationResponse.taskID,
-          maxRetries
-        });
+        await this.waitForTask(
+          {
+            indexName: tmpIndexName,
+            taskID: moveOperationResponse.taskID,
+            maxRetries
+          },
+          requestOptions
+        );
         return { copyOperationResponse, batchResponses, moveOperationResponse };
       } catch (error) {
-        await this.deleteIndex({ indexName: tmpIndexName });
+        await this.deleteIndex({ indexName: tmpIndexName }, requestOptions);
         throw error;
       }
     },
-    async indexExists({ indexName }) {
+    async indexExists({ indexName }, requestOptions) {
       try {
-        await this.getSettings({ indexName });
+        await this.getSettings({ indexName }, requestOptions);
       } catch (error) {
         if (error instanceof import_client_common.ApiError && error.status === 404) {
           return false;