Update highlighting metadata logic

Author: Strift

packages/autocomplete-client/src/search/__tests__/fetchMeilisearchResults.test.ts

@@ -79,26 +79,22 @@ describe('fetchMeilisearchResults', () => {
     })
   })
 
-  // test('with fully highlighted match', async () => {
-  //   const results = await fetchMeilisearchResults({
-  //     searchClient,
-  //     queries: [
-  //       {
-  //         indexName: 'testUid',
-  //         query: 'Hit 2',
-  //         params: {
-  //           highlightPreTag: '<test>',
-  //           highlightPostTag: '</test>',
-  //         },
-  //       },
-  //     ],
-  //   })
+  test('with fully highlighted match', async () => {
+    const results = await fetchMeilisearchResults({
+      searchClient,
+      queries: [
+        {
+          indexName: 'testUid',
+          query: 'Hit',
+        },
+      ],
+    })
 
-  //   expect(results[0].hits[0]._highlightResult?.label).toEqual({
-  //     value: '<test>Hit</test> <test>2</test>',
-  //     fullyHighlighted: true,
-  //     matchLevel: 'full',
-  //     matchedWords: ['Hit', '2'],
-  //   })
-  // })
+    expect(results[0].hits[0]._highlightResult?.label).toEqual({
+      value: `${HIGHLIGHT_PRE_TAG}Hit${HIGHLIGHT_POST_TAG} ${HIGHLIGHT_PRE_TAG}2${HIGHLIGHT_POST_TAG}`,
+      fullyHighlighted: true,
+      matchLevel: 'partial',
+      matchedWords: ['Hit'],
+    })
+  })
 })

packages/autocomplete-client/src/search/fetchMeilisearchResults.ts

@@ -78,23 +78,26 @@ function calculateHighlightMetadata(
   preTag: string = HIGHLIGHT_PRE_TAG,
   postTag: string = HIGHLIGHT_POST_TAG
 ): HighlightMetadata {
-  // Find all highlighted words
+  // Extract all highlighted segments
   const highlightRegex = new RegExp(`${preTag}(.*?)${postTag}`, 'g')
   const matches: string[] = []
   let match
   while ((match = highlightRegex.exec(value)) !== null) {
     matches.push(match[1])
   }
-  const matchedWords = matches
 
-  // Remove highlight tags for comparison
+  // Remove highlight tags to get the original, unhighlighted text
   const cleanValue = value.replace(new RegExp(`${preTag}|${postTag}`, 'g'), '')
 
-  // Calculate if fully highlighted
+  // Determine if the entire attribute is highlighted
+  // fullyHighlighted = true if cleanValue and the concatenation of all matched segments are identical
   const highlightedText = matches.join('')
   const fullyHighlighted = cleanValue === highlightedText
 
-  // Determine match level
+  // Determine match level:
+  // - 'none' if no matches
+  // - 'partial' if some matches but not fully highlighted
+  // - 'full' if all text is fully highlighted
   let matchLevel: 'none' | 'partial' | 'full' = 'none'
   if (matches.length > 0) {
     matchLevel = fullyHighlighted ? 'full' : 'partial'
@@ -104,6 +107,6 @@ function calculateHighlightMetadata(
     value,
     fullyHighlighted,
     matchLevel,
-    matchedWords,
+    matchedWords: matches,
   }
 }