@algolia/client-search 5.18.0 → 5.19.0

package/dist/worker.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/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.18.0",
+  "version": "5.19.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,16 +49,16 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.18.0",
-    "@algolia/requester-browser-xhr": "5.18.0",
-    "@algolia/requester-fetch": "5.18.0",
-    "@algolia/requester-node-http": "5.18.0"
+    "@algolia/client-common": "5.19.0",
+    "@algolia/requester-browser-xhr": "5.19.0",
+    "@algolia/requester-fetch": "5.19.0",
+    "@algolia/requester-node-http": "5.19.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.17.1",
-    "@types/node": "22.10.2",
+    "@arethetypeswrong/cli": "0.17.2",
+    "@types/node": "22.10.5",
     "publint": "0.2.12",
-    "rollup": "4.28.1",
+    "rollup": "4.29.1",
     "tsup": "8.3.5",
     "typescript": "5.7.2"
   },