Merge pull request #1693 from flevi29/feature-lang-settings-search-pa…

…rams Add language settings & search parameter
meilisearch · Aug 21, 2024 · a2d46d5 · a2d46d5
2 parents a0a27cc + 74b48ab
commit a2d46d5
Show file tree

Hide file tree

Showing 6 changed files with 313 additions and 2 deletions.
diff --git a/src/indexes.ts b/src/indexes.ts
@@ -54,6 +54,7 @@ import {
   Embedders,
   SearchCutoffMs,
   SearchSimilarDocumentsParams,
+  LocalizedAttributes,
 } from './types';
 import { removeUndefinedFromObject } from './utils';
 import { HttpRequests } from './http-requests';
@@ -1393,6 +1394,47 @@ class Index<T extends Record<string, any> = Record<string, any>> {
 
     return new EnqueuedTask(task);
   }
+
+  ///
+  /// LOCALIZED ATTRIBUTES SETTINGS
+  ///
+
+  /**
+   * Get the localized attributes settings.
+   *
+   * @returns Promise containing object of localized attributes settings
+   */
+  async getLocalizedAttributes(): Promise<LocalizedAttributes> {
+    const url = `indexes/${this.uid}/settings/localized-attributes`;
+    return await this.httpRequest.get<LocalizedAttributes>(url);
+  }
+
+  /**
+   * Update the localized attributes settings.
+   *
+   * @param localizedAttributes - Localized attributes object
+   * @returns Promise containing an EnqueuedTask
+   */
+  async updateLocalizedAttributes(
+    localizedAttributes: LocalizedAttributes,
+  ): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/localized-attributes`;
+    const task = await this.httpRequest.put(url, localizedAttributes);
+
+    return new EnqueuedTask(task);
+  }
+
+  /**
+   * Reset the localized attributes settings.
+   *
+   * @returns Promise containing an EnqueuedTask
+   */
+  async resetLocalizedAttributes(): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/localized-attributes`;
+    const task = await this.httpRequest.delete(url);
+
+    return new EnqueuedTask(task);
+  }
 }
 
 export { Index };
diff --git a/src/types/types.ts b/src/types/types.ts
@@ -108,6 +108,9 @@ export type HybridSearch = {
   semanticRatio?: number;
 };
 
+// https://www.meilisearch.com/docs/reference/api/settings#localized-attributes
+export type Locale = string;
+
 export type SearchParams = Query &
   Pagination &
   Highlight &
@@ -130,6 +133,7 @@ export type SearchParams = Query &
     hybrid?: HybridSearch;
     distinct?: string;
     retrieveVectors?: boolean;
+    locales?: Locale[];
   };
 
 // Search parameters for searches made with the GET method
@@ -152,6 +156,7 @@ export type SearchRequestGET = Pagination &
     rankingScoreThreshold?: number;
     distinct?: string;
     retrieveVectors?: boolean;
+    locales?: Locale[];
   };
 
 export type MultiSearchQuery = SearchParams & { indexUid: string };
@@ -428,6 +433,13 @@ export type PaginationSettings = {
 
 export type SearchCutoffMs = number | null;
 
+export type LocalizedAttribute = {
+  attributePatterns: string[];
+  locales: Locale[];
+};
+
+export type LocalizedAttributes = LocalizedAttribute[] | null;
+
 export type Settings = {
   filterableAttributes?: FilterableAttributes;
   distinctAttribute?: DistinctAttribute;
@@ -446,6 +458,7 @@ export type Settings = {
   proximityPrecision?: ProximityPrecision;
   embedders?: Embedders;
   searchCutoffMs?: SearchCutoffMs;
+  localizedAttributes?: LocalizedAttributes;
 };
 
 /*
@@ -677,9 +690,9 @@ export interface FetchError extends Error {
 
 export type MeiliSearchErrorResponse = {
   message: string;
-  // @TODO: Could be typed, but will it be kept updated? https://www.meilisearch.com/docs/reference/errors/error_codes
+  // https://www.meilisearch.com/docs/reference/errors/error_codes
   code: string;
-  // @TODO: Could be typed https://www.meilisearch.com/docs/reference/errors/overview#errors
+  // https://www.meilisearch.com/docs/reference/errors/overview#errors
   type: string;
   link: string;
 };
@@ -992,6 +1005,10 @@ export const ErrorStatusCode = {
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_settings_search_cutoff_ms */
   INVALID_SETTINGS_SEARCH_CUTOFF_MS: 'invalid_settings_search_cutoff_ms',
 
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_settings_search_cutoff_ms */
+  INVALID_SETTINGS_LOCALIZED_ATTRIBUTES:
+    'invalid_settings_localized_attributes',
+
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_task_before_enqueued_at */
   INVALID_TASK_BEFORE_ENQUEUED_AT: 'invalid_task_before_enqueued_at',
 

diff --git a/tests/__snapshots__/settings.test.ts.snap b/tests/__snapshots__/settings.test.ts.snap
@@ -14,6 +14,7 @@ exports[`Test on settings Admin key: Get default settings of an index 1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -61,6 +62,7 @@ exports[`Test on settings Admin key: Get default settings of empty index with pr
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -108,6 +110,7 @@ exports[`Test on settings Admin key: Reset embedders settings  1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -155,6 +158,7 @@ exports[`Test on settings Admin key: Reset settings 1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -202,6 +206,7 @@ exports[`Test on settings Admin key: Reset settings of empty index 1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -257,6 +262,7 @@ exports[`Test on settings Admin key: Update embedders settings  1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -304,6 +310,7 @@ exports[`Test on settings Admin key: Update searchableAttributes settings on emp
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -351,6 +358,7 @@ exports[`Test on settings Admin key: Update searchableAttributes settings on emp
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -403,6 +411,7 @@ exports[`Test on settings Admin key: Update settings 1`] = `
   "filterableAttributes": [
     "title",
   ],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [
     "&sep",
     "/",
@@ -466,6 +475,7 @@ exports[`Test on settings Admin key: Update settings on empty index with primary
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -511,6 +521,7 @@ exports[`Test on settings Admin key: Update settings with all null values 1`] =
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -558,6 +569,7 @@ exports[`Test on settings Master key: Get default settings of an index 1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -605,6 +617,7 @@ exports[`Test on settings Master key: Get default settings of empty index with p
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -652,6 +665,7 @@ exports[`Test on settings Master key: Reset embedders settings  1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -699,6 +713,7 @@ exports[`Test on settings Master key: Reset settings 1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -746,6 +761,7 @@ exports[`Test on settings Master key: Reset settings of empty index 1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -801,6 +817,7 @@ exports[`Test on settings Master key: Update embedders settings  1`] = `
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -848,6 +865,7 @@ exports[`Test on settings Master key: Update searchableAttributes settings on em
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -895,6 +913,7 @@ exports[`Test on settings Master key: Update searchableAttributes settings on em
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -947,6 +966,7 @@ exports[`Test on settings Master key: Update settings 1`] = `
   "filterableAttributes": [
     "title",
   ],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [
     "&sep",
     "/",
@@ -1010,6 +1030,7 @@ exports[`Test on settings Master key: Update settings on empty index with primar
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,
@@ -1055,6 +1076,7 @@ exports[`Test on settings Master key: Update settings with all null values 1`] =
     },
   },
   "filterableAttributes": [],
+  "localizedAttributes": null,
   "nonSeparatorTokens": [],
   "pagination": {
     "maxTotalHits": 1000,