feat(saveSynonyms): replaceExistingSynonyms -> clearExistingSynonyms (#1226)

fixes #1224

Author: Haroenv

packages/algoliasearch/src/builds/browser.ts

@@ -451,7 +451,10 @@ export type SearchIndex = BaseSearchIndex & {
   readonly replaceAllSynonyms: (
     synonyms: readonly Synonym[],
     requestOptions?: RequestOptions &
-      Pick<SaveSynonymsOptions, Exclude<keyof SaveSynonymsOptions, 'replaceExistingSynonyms'>>
+      Pick<
+        SaveSynonymsOptions,
+        Exclude<keyof SaveSynonymsOptions, 'clearExistingSynonyms' | 'replaceExistingSynonyms'>
+      >
   ) => Readonly<WaitablePromise<SaveSynonymsResponse>>;
   readonly searchRules: (
     query: string,

packages/algoliasearch/src/builds/node.ts

@@ -454,7 +454,10 @@ export type SearchIndex = BaseSearchIndex & {
   readonly replaceAllSynonyms: (
     synonyms: readonly Synonym[],
     requestOptions?: RequestOptions &
-      Pick<SaveSynonymsOptions, Exclude<keyof SaveSynonymsOptions, 'replaceExistingSynonyms'>>
+      Pick<
+        SaveSynonymsOptions,
+        Exclude<keyof SaveSynonymsOptions, 'clearExistingSynonyms' | 'replaceExistingSynonyms'>
+      >
   ) => Readonly<WaitablePromise<SaveSynonymsResponse>>;
   readonly searchRules: (
     query: string,

packages/client-search/src/methods/index/replaceAllSynonyms.ts

@@ -9,11 +9,14 @@ export const replaceAllSynonyms = (base: SearchIndex) => {
   return (
     synonyms: readonly Synonym[],
     requestOptions?: RequestOptions &
-      Pick<SaveSynonymsOptions, Exclude<keyof SaveSynonymsOptions, 'replaceExistingSynonyms'>>
+      Pick<
+        SaveSynonymsOptions,
+        Exclude<keyof SaveSynonymsOptions, 'clearExistingSynonyms' | 'replaceExistingSynonyms'>
+      >
   ): Readonly<WaitablePromise<SaveSynonymsResponse>> => {
     return saveSynonyms(base)(synonyms, {
       ...requestOptions,
-      replaceExistingSynonyms: true,
+      clearExistingSynonyms: true,
     });
   };
 };

packages/client-search/src/methods/index/saveSynonyms.ts

@@ -10,14 +10,15 @@ export const saveSynonyms = (base: SearchIndex) => {
     synonyms: readonly Synonym[],
     requestOptions?: SaveSynonymsOptions & RequestOptions
   ): Readonly<WaitablePromise<SaveSynonymsResponse>> => {
-    const { forwardToReplicas, replaceExistingSynonyms, ...options } = requestOptions || {};
+    const { forwardToReplicas, clearExistingSynonyms, replaceExistingSynonyms, ...options } =
+      requestOptions || {};
     const mappedRequestOptions = createMappedRequestOptions(options);
 
     if (forwardToReplicas) {
       mappedRequestOptions.queryParameters.forwardToReplicas = 1; // eslint-disable-line functional/immutable-data
     }
 
-    if (replaceExistingSynonyms) {
+    if (replaceExistingSynonyms || clearExistingSynonyms) {
       mappedRequestOptions.queryParameters.replaceExistingSynonyms = 1; // eslint-disable-line functional/immutable-data
     }
 

packages/client-search/src/types/SaveSynonymsOptions.ts

@@ -6,6 +6,12 @@ export type SaveSynonymsOptions = {
 
   /**
    * If the existing synonyms should be removed.
+   * @deprecated use clearExistingSynonyms
    */
   readonly replaceExistingSynonyms?: boolean;
+
+  /**
+   * If the existing synonyms should be removed.
+   */
+  readonly clearExistingSynonyms?: boolean;
 };