placeOfEvent configuration

Author: tareq89

CHANGELOG.md

@@ -11,6 +11,7 @@ HTTP input now accepts `field('..')` references in the HTTP body definition.
 #### Jurisdiction
 
 - Elasticsearch now stores location IDs as a full administrative hierarchy, with the leaf representing the actual event location. This enables searching events by any jurisdiction level (district, province, office, health facility etc.).
+- Added configurable placeOfEvent in EventConfig, allowing multiple location fields to be defined, with only one becoming the active place of event per document (based on conditionals), enabling jurisdiction-specific search by event location (e.g., birth location, child’s home address, death location).
 
 ## 1.9.1
 

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

@@ -52,6 +52,7 @@ const COLUMNS = {
   ICON_WITH_NAME_EVENT: 'iconWithNameEvent',
   EVENT: 'type',
   DATE_OF_EVENT: 'dateOfEvent',
+  PLACE_OF_EVENT: 'placeOfEvent',
   SENT_FOR_REVIEW: 'sentForReview',
   SENT_FOR_UPDATES: 'sentForUpdates',
   SENT_FOR_APPROVAL: 'sentForApproval',
@@ -98,6 +99,9 @@ function changeSortedColumn(
     case COLUMNS.DATE_OF_EVENT:
       newSortedCol = COLUMNS.DATE_OF_EVENT
       break
+    case COLUMNS.PLACE_OF_EVENT:
+      newSortedCol = COLUMNS.PLACE_OF_EVENT
+      break
     case COLUMNS.SENT_FOR_REVIEW:
       newSortedCol = COLUMNS.SENT_FOR_REVIEW
       break

packages/commons/src/events/EventConfig.ts

@@ -17,7 +17,7 @@ import { findAllFields, getDeclarationFields } from './utils'
 import { DeclarationFormConfig } from './FormConfig'
 
 import { FieldType } from './FieldType'
-import { FieldReference } from './FieldConfig'
+import { FieldReference, LOCATIONS_FIELD_TYPES } from './FieldConfig'
 import { FlagConfig } from './Flag'
 
 /**
@@ -35,6 +35,12 @@ export const EventConfig = z
     dateOfEvent: FieldReference.optional().describe(
       'Reference to the field capturing the date of the event (e.g. date of birth). Defaults to the event creation date if unspecified.'
     ),
+    placeOfEvent: z
+      .array(FieldReference)
+      .optional()
+      .describe(
+        'Reference to the field capturing the place of the event (e.g. place of birth). Defaults to the meta.createdAtLocation if unspecified.'
+      ),
     title: TranslationConfig.describe(
       'Title template for the singular event, supporting variables (e.g. "{applicant.name.firstname} {applicant.name.surname}").'
     ),
@@ -134,6 +140,33 @@ export const EventConfig = z
       }
     }
 
+    if (event.placeOfEvent) {
+      const eventPlaceFieldId = getDeclarationFields(event).find(
+        ({ id }) =>
+          Array.isArray(event.placeOfEvent) &&
+          event.placeOfEvent.find((config) => config.$$field === id)
+      )
+      if (!eventPlaceFieldId) {
+        ctx.addIssue({
+          code: 'custom',
+          message: `Place of event field id must match a field id in fields array.
+          Invalid place of event field ID for event ${event.id}: ${event.placeOfEvent.map((x) => x.$$field).toString()}`,
+          path: ['placeOfEvent']
+        })
+      } else if (
+        !(LOCATIONS_FIELD_TYPES as readonly FieldType[]).includes(
+          eventPlaceFieldId.type
+        )
+      ) {
+        ctx.addIssue({
+          code: 'custom',
+          message: `Field specified for place of event is of type: ${eventPlaceFieldId.type}, 
+          but it needs to be any one of these type: ${LOCATIONS_FIELD_TYPES.join(', ')}`,
+          path: ['placeOfEvent.fieldType']
+        })
+      }
+    }
+
     // Validate that all referenced action flags are configured in the event flags array.
     const configuredFlagIds = event.flags.map((flag) => flag.id)
     const actionFlagIds = event.actions.flatMap((action) =>

packages/commons/src/events/EventMetadata.ts

@@ -96,6 +96,7 @@ export const EventMetadata = z.object({
     .datetime()
     .describe('The timestamp when the event was first created and saved.'),
   dateOfEvent: ZodDate.nullish(),
+  placeOfEvent: CreatedAtLocation,
   createdBy: z.string().describe('ID of the user who created the event.'),
   createdByUserType: z
     .enum(['user', 'system'])
@@ -148,6 +149,7 @@ export const EventMetadataKeysArray = [
   'status',
   'createdAt',
   'dateOfEvent',
+  'placeOfEvent',
   'createdBy',
   'createdByUserType',
   'updatedByUserRole',
@@ -193,6 +195,11 @@ export const eventMetadataLabelMap: Record<
     defaultMessage: 'Date of Event',
     description: 'Date of Event'
   },
+  'event.placeOfEvent': {
+    id: 'event.placeOfEvent.label',
+    defaultMessage: 'Place of Event',
+    description: 'Place of Event'
+  },
   'event.createdAtLocation': {
     id: 'event.createdAtLocation.label',
     defaultMessage: 'Location',

packages/commons/src/events/FieldConfig.ts

@@ -930,3 +930,12 @@ export type FieldTypeToFieldConfig<T extends FieldType> = Extract<
   FieldConfigInput,
   { type: T }
 >
+
+export const LOCATIONS_FIELD_TYPES = [
+  FieldType.ADMINISTRATIVE_AREA,
+  FieldType.FACILITY,
+  FieldType.OFFICE,
+  FieldType.LOCATION,
+  FieldType.COUNTRY,
+  FieldType.ADDRESS
+] as const

packages/commons/src/events/state/index.test.ts

@@ -193,7 +193,7 @@ describe('getCurrentEventState()', () => {
         createdAt: '2023-01-01T00:00:00.000Z',
         createdBy: 'user1',
         createdByUserType: TokenUserType.enum.user,
-        createdAtLocation: 'location1' as UUID,
+        createdAtLocation: getUUID(),
         createdBySignature: '/ocrvs/signature.png',
         createdByRole: 'FIELD_AGENT'
       }
@@ -208,7 +208,7 @@ describe('getCurrentEventState()', () => {
         createdAt: '2023-02-01T00:00:00.000Z',
         createdBy: 'user1',
         createdByUserType: TokenUserType.enum.user,
-        createdAtLocation: 'location1' as UUID,
+        createdAtLocation: getUUID(),
         createdBySignature: '/ocrvs/signature.png',
         createdByRole: 'FIELD_AGENT'
       }
@@ -312,6 +312,7 @@ describe('getCurrentEventState()', () => {
         declareRequestAction.declaration
       ) as EventState,
       dateOfEvent: event.createdAt.split('T')[0],
+      placeOfEvent: createAction.createdAtLocation,
       flags: [InherentFlags.PENDING_CERTIFICATION],
       potentialDuplicates: [],
       legalStatuses: {
@@ -350,7 +351,7 @@ describe('getCurrentEventState()', () => {
         createdByUserType: TokenUserType.enum.user,
         createdBy: 'user1',
         createdBySignature: '/ocrvs/signature.png',
-        createdAtLocation: 'location1' as UUID,
+        createdAtLocation: getUUID(),
         createdByRole: 'FIELD_AGENT'
       }
     })
@@ -365,7 +366,7 @@ describe('getCurrentEventState()', () => {
         createdByUserType: TokenUserType.enum.user,
         createdBy: 'user1',
         createdBySignature: '/ocrvs/signature.png',
-        createdAtLocation: 'location1' as UUID,
+        createdAtLocation: getUUID(),
         createdByRole: 'FIELD_AGENT'
       }
     })
@@ -432,6 +433,7 @@ describe('getCurrentEventState()', () => {
       updatedAtLocation: registerAcceptAction.createdAtLocation,
       declaration: deepDropNulls(declareAcceptAction.declaration) as EventState,
       dateOfEvent: event.createdAt.split('T')[0],
+      placeOfEvent: createAction.createdAtLocation,
       flags: [InherentFlags.PENDING_CERTIFICATION],
       potentialDuplicates: [],
       legalStatuses: {

packages/commons/src/events/state/index.ts

@@ -20,7 +20,7 @@ import {
 } from '../ActionDocument'
 import { EventDocument } from '../EventDocument'
 import { EventIndex } from '../EventIndex'
-import { EventStatus, ZodDate } from '../EventMetadata'
+import { EventMetadata, EventStatus, ZodDate } from '../EventMetadata'
 import { Draft } from '../Draft'
 import {
   aggregateActionDeclarations,
@@ -37,6 +37,10 @@ import {
   FullDocumentPath,
   FullDocumentUrl
 } from '../../documents'
+import { mapFieldTypeToZod } from '../FieldTypeMapping'
+import { FieldType } from '../FieldType'
+import { AddressFieldUpdateValue, AddressType } from '../CompositeFieldValue'
+import { isFieldVisible, LOCATIONS_FIELD_TYPES } from '..'
 
 export function getStatusFromActions(actions: Array<Action>) {
   return actions
@@ -163,6 +167,69 @@ export function resolveDateOfEvent(
   return parsedDate.success ? parsedDate.data : undefined
 }
 
+export const DEFAULT_PLACE_OF_EVENT_PROPERTY =
+  'createdAtLocation' satisfies keyof EventMetadata
+
+function getParsedUUID(id: unknown) {
+  const parsed = UUID.safeParse(id)
+  return parsed.success ? parsed.data : undefined
+}
+
+export function resolvePlaceOfEvent(
+  eventMetadata: {
+    createdAtLocation?: UUID | null | undefined
+  },
+  declaration: EventState,
+  config: EventConfig
+): UUID | undefined {
+  if (!config.placeOfEvent || config.placeOfEvent.length === 0) {
+    return getParsedUUID(eventMetadata.createdAtLocation)
+  }
+  const fieldConfigs = config.declaration.pages.flatMap((x) => x.fields)
+
+  // Find first valid location from configured fields
+  for (const { $$field } of config.placeOfEvent) {
+    const value = declaration[$$field]
+    if (value === null || value === undefined) {
+      continue
+    }
+
+    const fieldConfig = fieldConfigs.find((f) => f.id === $$field)
+
+    if (!fieldConfig) {
+      continue
+    }
+    if (
+      !(LOCATIONS_FIELD_TYPES as readonly FieldType[]).includes(
+        fieldConfig.type
+      )
+    ) {
+      continue
+    }
+    if (!isFieldVisible(fieldConfig, declaration, {})) {
+      continue
+    }
+
+    // Try parsing as address field first (domestic addresses use administrative area)
+    const addressField = AddressFieldUpdateValue.safeParse(value)
+    if (
+      addressField.success &&
+      addressField.data?.addressType === AddressType.DOMESTIC
+    ) {
+      return getParsedUUID(addressField.data.administrativeArea)
+    }
+
+    // Otherwise parse as standard location field
+    const zodType = mapFieldTypeToZod(fieldConfig, ActionType.CREATE)
+    const parsed = zodType.safeParse(value)
+    if (parsed.success) {
+      return getParsedUUID(parsed.data)
+    }
+  }
+  // When no value can not be resolved, it defaults again to registrar office location, (ex: AddressType.DOMESTIC etc)
+  return getParsedUUID(eventMetadata.createdAtLocation)
+}
+
 export function extractPotentialDuplicatesFromActions(
   actions: Action[]
 ): PotentialDuplicate[] {
@@ -182,6 +249,7 @@ export function extractPotentialDuplicatesFromActions(
 
 /**
  * NOTE: This function should not run field validations. It should return the state based on the actions, without considering context (users, roles, permissions, etc).
+createdAtLocation: CreatedAtLocation
  *
  * If you update this function, please ensure @EventIndex type is updated accordingly.
  * In most cases, you won't need to add new parameters to this function. Discuss with the team before doing so.
@@ -237,6 +305,11 @@ export function getCurrentEventState(
     trackingId: event.trackingId,
     updatedByUserRole: requestActionMetadata.createdByRole,
     dateOfEvent: resolveDateOfEvent(event, declaration, config),
+    placeOfEvent: resolvePlaceOfEvent(
+      { createdAtLocation: creationAction.createdAtLocation },
+      declaration,
+      config
+    ),
     potentialDuplicates: extractPotentialDuplicatesFromActions(sortedActions),
     flags: getEventFlags(event, config)
   })
@@ -305,6 +378,11 @@ export function applyDeclarationToEventIndex(
       updatedDeclaration,
       eventConfiguration
     ),
+    placeOfEvent: resolvePlaceOfEvent(
+      eventIndex,
+      updatedDeclaration,
+      eventConfiguration
+    ),
     declaration: updatedDeclaration
   }
 }