@algolia/client-search 5.18.0 → 5.19.0

package/dist/fetch.d.ts

@@ -3019,15 +3019,23 @@ type ReplaceAllObjectsOptions = {
      * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      */
     batchSize?: number;
+    /**
+     * The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+     */
+    scopes?: Array<ScopeType>;
 };
 
-declare const apiClientVersion = "5.18.0";
+declare const apiClientVersion = "5.19.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
      * The `appId` currently in use.
      */
     appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -3183,9 +3191,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+     * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @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 }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
+    replaceAllObjects({ indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
     indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.

package/dist/node.d.cts

@@ -3019,15 +3019,23 @@ type ReplaceAllObjectsOptions = {
      * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      */
     batchSize?: number;
+    /**
+     * The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+     */
+    scopes?: Array<ScopeType>;
 };
 
-declare const apiClientVersion = "5.18.0";
+declare const apiClientVersion = "5.19.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
      * The `appId` currently in use.
      */
     appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -3183,9 +3191,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+     * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @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 }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
+    replaceAllObjects({ indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
     indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.

package/dist/node.d.ts

@@ -3019,15 +3019,23 @@ type ReplaceAllObjectsOptions = {
      * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      */
     batchSize?: number;
+    /**
+     * The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+     */
+    scopes?: Array<ScopeType>;
 };
 
-declare const apiClientVersion = "5.18.0";
+declare const apiClientVersion = "5.19.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
      * The `appId` currently in use.
      */
     appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -3183,9 +3191,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+     * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @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 }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
+    replaceAllObjects({ indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
     indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.

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.18.0";
+var apiClientVersion = "5.19.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -90,6 +90,10 @@ function createSearchClient({
      * The `appId` currently in use.
      */
     appId: appIdOption,
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -448,57 +452,66 @@ function createSearchClient({
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+     * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @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.
      */
-    async replaceAllObjects({ indexName, objects, batchSize }, requestOptions) {
+    async replaceAllObjects({ indexName, objects, batchSize, scopes }, requestOptions) {
       const randomSuffix = Math.floor(Math.random() * 1e6) + 1e5;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
-      let copyOperationResponse = await this.operationIndex(
-        {
-          indexName,
-          operationIndexParams: {
-            operation: "copy",
-            destination: tmpIndexName,
-            scope: ["settings", "rules", "synonyms"]
-          }
-        },
-        requestOptions
-      );
-      const batchResponses = await this.chunkedBatch(
-        { indexName: tmpIndexName, objects, waitForTasks: true, batchSize },
-        requestOptions
-      );
-      await this.waitForTask({
-        indexName: tmpIndexName,
-        taskID: copyOperationResponse.taskID
-      });
-      copyOperationResponse = await this.operationIndex(
-        {
-          indexName,
-          operationIndexParams: {
-            operation: "copy",
-            destination: tmpIndexName,
-            scope: ["settings", "rules", "synonyms"]
-          }
-        },
-        requestOptions
-      );
-      await this.waitForTask({
-        indexName: tmpIndexName,
-        taskID: copyOperationResponse.taskID
-      });
-      const moveOperationResponse = await this.operationIndex(
-        {
+      if (scopes === void 0) {
+        scopes = ["settings", "rules", "synonyms"];
+      }
+      try {
+        let copyOperationResponse = await this.operationIndex(
+          {
+            indexName,
+            operationIndexParams: {
+              operation: "copy",
+              destination: tmpIndexName,
+              scope: scopes
+            }
+          },
+          requestOptions
+        );
+        const batchResponses = await this.chunkedBatch(
+          { indexName: tmpIndexName, objects, waitForTasks: true, batchSize },
+          requestOptions
+        );
+        await this.waitForTask({
           indexName: tmpIndexName,
-          operationIndexParams: { operation: "move", destination: indexName }
-        },
-        requestOptions
-      );
-      await this.waitForTask({
-        indexName: tmpIndexName,
-        taskID: moveOperationResponse.taskID
-      });
-      return { copyOperationResponse, batchResponses, moveOperationResponse };
+          taskID: copyOperationResponse.taskID
+        });
+        copyOperationResponse = await this.operationIndex(
+          {
+            indexName,
+            operationIndexParams: {
+              operation: "copy",
+              destination: tmpIndexName,
+              scope: scopes
+            }
+          },
+          requestOptions
+        );
+        await this.waitForTask({
+          indexName: tmpIndexName,
+          taskID: copyOperationResponse.taskID
+        });
+        const moveOperationResponse = await this.operationIndex(
+          {
+            indexName: tmpIndexName,
+            operationIndexParams: { operation: "move", destination: indexName }
+          },
+          requestOptions
+        );
+        await this.waitForTask({
+          indexName: tmpIndexName,
+          taskID: moveOperationResponse.taskID
+        });
+        return { copyOperationResponse, batchResponses, moveOperationResponse };
+      } catch (error) {
+        await this.deleteIndex({ indexName: tmpIndexName });
+        throw error;
+      }
     },
     async indexExists({ indexName }) {
       try {