Merge pull request #10820 from opencrvs/ocrvs-10617

Add multi-field advanced search support

Author: tumbledwyer

CHANGELOG.md

@@ -11,6 +11,7 @@
 - Add Import/Export system client and `record.export` scope to enable data migrations [#10415](https://github.com/opencrvs/opencrvs-core/issues/10415)
 - Add an Alpha version of configurable "Print" button that will be refactored in a later release - this button can be used to print certificates during declaration/correction flow. [#10039](https://github.com/opencrvs/opencrvs-core/issues/10039)
 - Add bulk import endpoint [#10590](https://github.com/opencrvs/opencrvs-core/pull/10590)
+- Add multi-field search with a single component [#10617](https://github.com/opencrvs/opencrvs-core/issues/10617)
 
 ### Improvements
 

packages/client/src/v2-events/features/events/Search/SearchResultIndex.tsx

@@ -71,7 +71,11 @@ export const SearchResultIndex = () => {
    * re-evaluated, which leads to an infinite loop.
    */
   const queryData = searchEvent.useQuery({
-    query: toAdvancedSearchQueryType(searchQuery, eventType),
+    query: toAdvancedSearchQueryType(
+      searchQuery,
+      eventConfig.advancedSearch.flatMap((section) => section.fields),
+      eventType
+    ),
     ...typedSearchParams
   }).data ?? {
     results: [],

packages/client/src/v2-events/features/events/Search/utils.test.ts

@@ -11,6 +11,8 @@
 
 import {
   EventStatus,
+  QueryInputType,
+  SearchField,
   tennisClubMembershipEvent
 } from '@opencrvs/commons/client'
 import {
@@ -20,7 +22,8 @@ import {
   deserializeSearchParams,
   buildQuickSearchQuery,
   resolveAdvancedSearchConfig,
-  getAdvancedSearchFieldErrors
+  getAdvancedSearchFieldErrors,
+  toAdvancedSearchQueryType
 } from './utils'
 
 describe('getAdvancedSearchFieldErrors', () => {
@@ -235,3 +238,298 @@ describe('buildQuickSearchQuery', () => {
     })
   })
 })
+
+describe('Nested Query Generation with searchFields', () => {
+  it('creates OR clauses for fields with multiple searchFields', () => {
+    const searchParams = {
+      'person-name': 'Bob',
+      'child.dob': '1985-01-01'
+    }
+    const searchFieldConfigs: SearchField[] = [
+      {
+        fieldId: 'person-name',
+        fieldType: 'field',
+        type: 'NAME',
+        config: {
+          type: 'fuzzy',
+          searchFields: [
+            'child.name.firstname',
+            'child.name.surname',
+            'mother.name.firstname',
+            'father.name.firstname'
+          ]
+        }
+      },
+      {
+        fieldId: 'child.dob',
+        fieldType: 'field',
+        config: { type: 'exact' }
+      }
+    ]
+
+    const result = toAdvancedSearchQueryType(
+      searchParams as unknown as QueryInputType,
+      searchFieldConfigs,
+      'birth'
+    )
+
+    expect(result).toEqual({
+      type: 'and',
+      clauses: [
+        {
+          eventType: 'birth'
+        },
+        {
+          type: 'or',
+          clauses: [
+            {
+              data: { 'child.name.firstname': 'Bob' }
+            },
+            {
+              data: { 'child.name.surname': 'Bob' }
+            },
+            {
+              data: { 'mother.name.firstname': 'Bob' }
+            },
+            {
+              data: { 'father.name.firstname': 'Bob' }
+            }
+          ]
+        },
+        {
+          data: { 'child.dob': '1985-01-01' }
+        }
+      ]
+    })
+  })
+
+  it('creates individual clauses for fields without searchFields', () => {
+    const searchParams = {
+      'child.name.firstname': 'Alice',
+      'child.dob': '1990-01-01'
+    }
+    const searchFieldConfigs: SearchField[] = [
+      {
+        fieldId: 'child.name.firstname',
+        fieldType: 'field',
+        config: { type: 'fuzzy' }
+      },
+      {
+        fieldId: 'child.dob',
+        fieldType: 'field',
+        config: { type: 'exact' }
+      }
+    ]
+
+    const result = toAdvancedSearchQueryType(
+      searchParams as unknown as QueryInputType,
+      searchFieldConfigs,
+      'birth'
+    )
+
+    expect(result).toEqual({
+      type: 'and',
+      clauses: [
+        {
+          eventType: 'birth'
+        },
+        {
+          data: { 'child.name.firstname': 'Alice' }
+        },
+        {
+          data: { 'child.dob': '1990-01-01' }
+        }
+      ]
+    })
+  })
+
+  it('handles single searchField as individual clause', () => {
+    const searchParams = {
+      'custom-field': 'test-value'
+    }
+    const searchFieldConfigs: SearchField[] = [
+      {
+        fieldId: 'custom-field',
+        fieldType: 'field',
+        config: {
+          type: 'exact',
+          searchFields: ['mapped.database.field'] // Single field
+        }
+      }
+    ]
+
+    const result = toAdvancedSearchQueryType(
+      searchParams as unknown as QueryInputType,
+      searchFieldConfigs,
+      'birth'
+    )
+
+    expect(result).toEqual({
+      type: 'and',
+      clauses: [
+        {
+          eventType: 'birth'
+        },
+        {
+          type: 'or',
+          clauses: [
+            {
+              data: { 'mapped.database.field': 'test-value' }
+            }
+          ]
+        }
+      ]
+    })
+  })
+
+  it('handles metadata fields correctly', () => {
+    const searchParams = {
+      'event.trackingId': 'ABC123',
+      'person-name': 'Bob'
+    }
+
+    const searchFieldConfigs: SearchField[] = [
+      {
+        fieldId: 'event.trackingId',
+        fieldType: 'event',
+        config: { type: 'exact' }
+      },
+      {
+        fieldId: 'person-name',
+        fieldType: 'field',
+        config: {
+          type: 'fuzzy',
+          searchFields: ['child.name.firstname', 'mother.name.firstname']
+        }
+      }
+    ]
+
+    const result = toAdvancedSearchQueryType(
+      searchParams as unknown as QueryInputType,
+      searchFieldConfigs,
+      'birth'
+    )
+
+    expect(result).toEqual({
+      type: 'and',
+      clauses: [
+        {
+          trackingId: 'ABC123',
+          eventType: 'birth'
+        },
+        {
+          type: 'or',
+          clauses: [
+            {
+              data: { 'child.name.firstname': 'Bob' }
+            },
+            {
+              data: { 'mother.name.firstname': 'Bob' }
+            }
+          ]
+        }
+      ]
+    })
+  })
+
+  it('handles complex multi-field scenario', () => {
+    const searchParams = {
+      'applicant-name': 'John',
+      'contact-info': '[email protected]',
+      'event.status': 'REGISTERED',
+      'birth.date': '1980-01-01'
+    }
+
+    const searchFieldConfigs: SearchField[] = [
+      {
+        fieldId: 'applicant-name',
+        fieldType: 'field',
+        config: {
+          type: 'fuzzy',
+          searchFields: [
+            'child.name.firstname',
+            'child.name.surname',
+            'informant.name.firstname',
+            'informant.name.surname'
+          ]
+        }
+      },
+      {
+        fieldId: 'contact-info',
+        fieldType: 'field',
+        config: {
+          type: 'exact',
+          searchFields: [
+            'child.email',
+            'informant.email',
+            'child.phone',
+            'informant.phone'
+          ]
+        }
+      },
+      {
+        fieldId: 'event.status',
+        fieldType: 'event',
+        config: { type: 'exact' }
+      },
+      {
+        fieldId: 'birth.date',
+        fieldType: 'field',
+        config: { type: 'exact' }
+      }
+    ]
+
+    const result = toAdvancedSearchQueryType(
+      searchParams as unknown as QueryInputType,
+      searchFieldConfigs,
+      'birth'
+    )
+
+    expect(result).toEqual({
+      type: 'and',
+      clauses: [
+        {
+          status: 'REGISTERED',
+          eventType: 'birth'
+        },
+        {
+          type: 'or',
+          clauses: [
+            {
+              data: { 'child.name.firstname': 'John' }
+            },
+            {
+              data: { 'child.name.surname': 'John' }
+            },
+            {
+              data: { 'informant.name.firstname': 'John' }
+            },
+            {
+              data: { 'informant.name.surname': 'John' }
+            }
+          ]
+        },
+        {
+          type: 'or',
+          clauses: [
+            {
+              data: { 'child.email': '[email protected]' }
+            },
+            {
+              data: { 'informant.email': '[email protected]' }
+            },
+            {
+              data: { 'child.phone': '[email protected]' }
+            },
+            {
+              data: { 'informant.phone': '[email protected]' }
+            }
+          ]
+        },
+        {
+          data: { 'birth.date': '1980-01-01' }
+        }
+      ]
+    })
+  })
+})