refactor: add clearExistingSynonyms option and its handling in saveSynonyms method

Author: VladislavFitz

algolia/internal/gen/options.go

@@ -114,7 +114,7 @@ var options = []Option{
 	{"enabled", Other, true, ""}, // Used to enable the rule by default
 
 	// Personalization
-	{"enablePersonalization", Search|Settings, false, ""},
+	{"enablePersonalization", Search | Settings, false, ""},
 	{"personalizationImpact", Search, 100, ""},
 	{"userToken", Search, "", ""},
 	{"enableReRanking", Search | Settings, true, ""},
@@ -155,6 +155,7 @@ var options = []Option{
 	{"query", Other, "", ""},
 	{"autoGenerateObjectIDIfNotExist", Other, false, ""},
 	{"clearExistingRules", Other, false, ""},
+	{"clearExistingSynonyms", Other, false, ""},
 	{"replaceExistingSynonyms", Other, false, ""},
 	{"type", Other, nil, ""},
 	{"createIfNotExists", Other, true, ""},

algolia/internal/opt/clear_existing_synonyms.go

@@ -46,9 +46,14 @@ func (i *Index) SaveSynonym(synonym Synonym, opts ...interface{}) (res UpdateTas
 // Unlike SaveObjects, this method does not batch the given synonyms i.e. all synonyms
 // are sent in a single call.
 func (i *Index) SaveSynonyms(synonyms []Synonym, opts ...interface{}) (res UpdateTaskRes, err error) {
-	if replaceExistingSynonyms := iopt.ExtractReplaceExistingSynonyms(opts...); replaceExistingSynonyms != nil {
+
+	if clearExistingSynonyms := iopt.ExtractClearExistingSynonyms(opts...); clearExistingSynonyms != nil {
+		opts = opt.InsertExtraURLParam(opts, "replaceExistingSynonyms", clearExistingSynonyms.Get())
+	} else if replaceExistingSynonyms := iopt.ExtractReplaceExistingSynonyms(opts...); replaceExistingSynonyms != nil {
+		// if clearExistingSynonyms parameter is missing, attempt to parse legacy replaceExistingSynonyms option
 		opts = opt.InsertExtraURLParam(opts, "replaceExistingSynonyms", replaceExistingSynonyms.Get())
 	}
+
 	path := i.path("/synonyms/batch")
 	err = i.transport.Request(&res, http.MethodPost, path, synonyms, call.Write, opts...)
 	res.wait = i.WaitTask