Add lang settings and search params, add test

Author: flevi29

src/types/types.ts

@@ -130,6 +130,9 @@ export type SearchParams = Query &
     hybrid?: HybridSearch;
     distinct?: string;
     retrieveVectors?: boolean;
+    // @TODO: Either explicitly type this (that implies keeping it up to date),
+    //        or link to the docs where the available locales are listed
+    locales?: string[];
   };
 
 // Search parameters for searches made with the GET method
@@ -428,6 +431,14 @@ export type PaginationSettings = {
 
 export type SearchCutoffMs = number | null;
 
+export type LocalizedAttribute = {
+  attributePatterns: string[];
+  // @TODO: Type or link to docs
+  locales: string[];
+};
+
+export type LocalizedAttributes = LocalizedAttribute[] | null;
+
 export type Settings = {
   filterableAttributes?: FilterableAttributes;
   distinctAttribute?: DistinctAttribute;
@@ -446,6 +457,7 @@ export type Settings = {
   proximityPrecision?: ProximityPrecision;
   embedders?: Embedders;
   searchCutoffMs?: SearchCutoffMs;
+  localizedAttributes?: LocalizedAttributes;
 };
 
 /*

tests/search.test.ts

@@ -992,6 +992,30 @@ describe.each([
       client.index(index.uid).search('prince', {}),
     ).rejects.toHaveProperty('cause.code', ErrorStatusCode.INDEX_NOT_FOUND);
   });
+
+  test.only(`${permission} key: Search with locales`, async () => {
+    const ind = (await getClient(permission)).index(index.uid),
+      masterInd = (await getClient('Master')).index(index.uid);
+
+    await masterInd.waitForTask(
+      (
+        await masterInd.updateSettings({
+          localizedAttributes: [
+            {
+              attributePatterns: ['title', 'comment'],
+              locales: ['fra', 'eng'],
+            },
+          ],
+        })
+      ).taskUid,
+    );
+
+    const response = await ind.search('french', {
+      locales: ['fra', 'eng'],
+    });
+
+    expect(response.hits.length).toEqual(2);
+  });
 });
 
 describe.each([{ permission: 'No' }])(