Support * in attributesToSnippet

Author: daniel-shuy

src/adapter/search-response-adapter/highlight-adapter.ts

@@ -104,10 +104,11 @@ function adaptSnippet(
   attributesToSnippet = attributesToSnippet.map(
     (attribute) => attribute.split(':')[0]
   ) as any[]
+  const snippetAll = attributesToSnippet.includes('*');
   // formattedHit is the `_formatted` object returned by MeiliSearch.
   // It contains all the highlighted and croped attributes
   return (Object.keys(formattedHit) as any[]).reduce((result, key) => {
-    if (attributesToSnippet?.includes(key)) {
+    if (snippetAll || attributesToSnippet?.includes(key)) {
       ;(result[key] as any) = {
         value: snippetValue(
           formattedHit[key],

tests/snippets.tests.ts

@@ -49,6 +49,43 @@ describe('Snippet Browser test', () => {
     expect(snippeted?.overview?.value).toEqual('While...')
   })
 
+  test('Test * attributesToSnippet on specific query', async () => {
+    const response = await searchClient.search<Movies>([
+      {
+        indexName: 'movies',
+        params: {
+          query: 'judg',
+          attributesToSnippet: ['*:2'],
+          snippetEllipsisText: '...',
+        },
+      },
+    ])
+    const highlighted = response.results[0]?.hits[0]?._highlightResult
+    const snippeted = response.results[0].hits[0]._snippetResult
+    expect(highlighted?.id?.value).toEqual('6')
+    expect(highlighted?.title?.value).toEqual('__ais-highlight__Judg__/ais-highlight__ment Night')
+    expect(highlighted?.overview?.value).toEqual('While')
+// requires HightlightResult to include Array types
+//     expect(highlighted?.genres?.value).toEqual(
+// `[
+//   "Action",
+//   "Thriller",
+//   "Crime"
+// ]`)
+    expect(highlighted?.release_date?.value).toEqual('750643200')
+    expect(snippeted?.id?.value).toEqual('6')
+    expect(snippeted?.title?.value).toEqual('__ais-highlight__Judg__/ais-highlight__ment Night...')
+    expect(snippeted?.overview?.value).toEqual('While...')
+// requires SnippetResult to include Array types
+//     expect(snippeted?.genres?.value).toEqual(
+// `[
+//   "Action",
+//   "Thriller",
+//   "Crime"
+// ]`)
+    expect(snippeted?.release_date?.value).toEqual('750643200')
+  })
+
   test('Test two attributesToSnippet on specific query with one hit empty string', async () => {
     const response = await searchClient.search<Movies>([
       {