feat(clients): add optionnal scopes to replaceAllObjects [skip-bc] (g…

…enerated) algolia/api-clients-automation#4296 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
algolia · Jan 7, 2025 · e297b32 · e297b32
1 parent aaf5e87
commit e297b32
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/packages/client-search/model/clientMethodProps.ts b/packages/client-search/model/clientMethodProps.ts
@@ -23,6 +23,7 @@ import type { OperationIndexParams } from '../model/operationIndexParams';
 
 import type { Rule } from '../model/rule';
 
+import type { ScopeType } from '../model/scopeType';
 import type { SearchDictionaryEntriesParams } from '../model/searchDictionaryEntriesParams';
 
 import type { SearchForFacetValuesRequest } from '../model/searchForFacetValuesRequest';
@@ -870,4 +871,9 @@ export 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>;
 };
diff --git a/packages/client-search/src/searchClient.ts b/packages/client-search/src/searchClient.ts
@@ -633,23 +633,28 @@ export 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 }: ReplaceAllObjectsOptions,
+      { indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions,
       requestOptions?: RequestOptions,
     ): Promise<ReplaceAllObjectsResponse> {
       const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
 
+      if (scopes === undefined) {
+        scopes = ['settings', 'rules', 'synonyms'];
+      }
+
       try {
         let copyOperationResponse = await this.operationIndex(
           {
             indexName,
             operationIndexParams: {
               operation: 'copy',
               destination: tmpIndexName,
-              scope: ['settings', 'rules', 'synonyms'],
+              scope: scopes,
             },
           },
           requestOptions,
@@ -671,7 +676,7 @@ export function createSearchClient({
             operationIndexParams: {
               operation: 'copy',
               destination: tmpIndexName,
-              scope: ['settings', 'rules', 'synonyms'],
+              scope: scopes,
             },
           },
           requestOptions,