@opencrvs/toolkit 1.9.2-rc.cb144d0 → 1.9.2-rc.f1d7235

package/dist/events/index.js

@@ -77,6 +77,7 @@ __export(events_exports, {
   CustomActionInput: () => CustomActionInput,
   CustomFlag: () => CustomFlag,
   DEFAULT_DATE_OF_EVENT_PROPERTY: () => DEFAULT_DATE_OF_EVENT_PROPERTY,
+  DEFAULT_PLACE_OF_EVENT_PROPERTY: () => DEFAULT_PLACE_OF_EVENT_PROPERTY,
   DataEntry: () => DataEntry,
   DataFieldValue: () => DataFieldValue,
   DateCondition: () => DateCondition,
@@ -137,6 +138,7 @@ __export(events_exports, {
   FormPageConfig: () => FormPageConfig,
   Fuzzy: () => Fuzzy,
   GeographicalArea: () => GeographicalArea,
+  HiddenFieldValue: () => HiddenFieldValue,
   HttpFieldUpdateValue: () => HttpFieldUpdateValue,
   HttpFieldValue: () => HttpFieldValue,
   IdReaderFieldValue: () => IdReaderFieldValue,
@@ -216,6 +218,7 @@ __export(events_exports, {
   ZodDate: () => ZodDate,
   actionConfigTypes: () => actionConfigTypes,
   ageToDate: () => ageToDate,
+  aggregateActionAnnotations: () => aggregateActionAnnotations,
   aggregateActionDeclarations: () => aggregateActionDeclarations,
   alwaysTrue: () => alwaysTrue,
   and: () => and,
@@ -331,6 +334,7 @@ __export(events_exports, {
   isFieldVisible: () => isFieldVisible,
   isFileFieldType: () => isFileFieldType,
   isFileFieldWithOptionType: () => isFileFieldWithOptionType,
+  isHiddenFieldType: () => isHiddenFieldType,
   isHttpFieldType: () => isHttpFieldType,
   isIdFieldType: () => isIdFieldType,
   isIdReaderFieldType: () => isIdReaderFieldType,
@@ -375,6 +379,7 @@ __export(events_exports, {
   or: () => or,
   pickRandom: () => pickRandom,
   resolveDateOfEvent: () => resolveDateOfEvent,
+  resolvePlaceOfEvent: () => resolvePlaceOfEvent,
   runFieldValidations: () => runFieldValidations,
   runStructuralValidations: () => runStructuralValidations,
   safeUnion: () => safeUnion,
@@ -613,7 +618,8 @@ var FieldType = {
   QUERY_PARAM_READER: "QUERY_PARAM_READER",
   QR_READER: "QR_READER",
   ID_READER: "ID_READER",
-  LOADER: "LOADER"
+  LOADER: "LOADER",
+  HIDDEN: "HIDDEN"
 };
 var FileFieldType = z4.enum([
   FieldType.FILE,
@@ -747,6 +753,7 @@ var IdReaderFieldValue = ReadDataValue;
 
 // ../commons/src/events/FieldValue.ts
 var TextValue = z7.string();
+var HiddenFieldValue = z7.string();
 var NonEmptyTextValue = TextValue.min(1);
 var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
 var AgeValue = z7.object({
@@ -872,7 +879,8 @@ var FieldUpdateValue = safeUnion([
   DataFieldValue.describe("DataFieldValue"),
   NameFieldUpdateValue.describe("NameFieldUpdateValue"),
   HttpFieldUpdateValue.describe("HttpFieldUpdateValue"),
-  QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue")
+  QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue"),
+  HiddenFieldValue.describe("HiddenFieldValue")
 ]);
 
 // ../commons/src/uuid.ts
@@ -1641,6 +1649,7 @@ var EventMetadata = z14.object({
   ),
   createdAt: z14.iso.datetime().describe("The timestamp when the event was first created and saved."),
   dateOfEvent: ZodDate.nullish(),
+  placeOfEvent: CreatedAtLocation,
   createdBy: z14.string().describe("ID of the user who created the event."),
   createdByUserType: z14.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
   updatedByUserRole: z14.string().describe("Role of the user who last changed the status."),
@@ -1670,6 +1679,7 @@ var EventMetadataKeysArray = [
   "status",
   "createdAt",
   "dateOfEvent",
+  "placeOfEvent",
   "createdBy",
   "createdByUserType",
   "updatedByUserRole",
@@ -1704,6 +1714,11 @@ var eventMetadataLabelMap = {
     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",
@@ -2444,6 +2459,13 @@ var LoaderField = BaseField.extend({
 }).describe(
   "A non-interactive field that indicates an in progress operation in form"
 );
+var HiddenField = BaseField.extend({
+  type: z16.literal(FieldType.HIDDEN),
+  required: z16.literal(false).optional()
+  // Hidden fields cannot be required
+}).describe(
+  "A non-interactive, hidden field that only hold a value in the form"
+);
 var FieldConfig = z16.discriminatedUnion("type", [
   Address,
   TextField,
@@ -2483,7 +2505,8 @@ var FieldConfig = z16.discriminatedUnion("type", [
   IdReaderField,
   QueryParamReaderField,
   LoaderField,
-  SearchField
+  SearchField,
+  HiddenField
 ]).meta({
   description: "Form field configuration",
   id: "FieldConfig"
@@ -2997,6 +3020,7 @@ var EventFieldIdInput = z25.enum([
   "status",
   "legalStatuses.REGISTERED.acceptedAt",
   "legalStatuses.REGISTERED.createdAtLocation",
+  "legalStatuses.REGISTERED.registrationNumber",
   "updatedAt"
 ]);
 var METADATA_FIELD_PREFIX = "event.";
@@ -3005,6 +3029,7 @@ var EventFieldId = z25.enum([
   `${METADATA_FIELD_PREFIX}status`,
   `${METADATA_FIELD_PREFIX}legalStatuses.REGISTERED.acceptedAt`,
   `${METADATA_FIELD_PREFIX}legalStatuses.REGISTERED.createdAtLocation`,
+  `${METADATA_FIELD_PREFIX}legalStatuses.REGISTERED.registrationNumber`,
   `${METADATA_FIELD_PREFIX}updatedAt`
 ]);
 var EventFieldConfigSchema = BaseField3.extend({
@@ -3113,6 +3138,7 @@ function mapFieldTypeToZod(field3, actionType) {
     case FieldType.VERIFICATION_STATUS:
     case FieldType.ID:
     case FieldType.LOADER:
+    case FieldType.HIDDEN:
       schema = field3.required ? NonEmptyTextValue : TextValue;
       break;
     case FieldType.NUMBER:
@@ -3196,6 +3222,7 @@ function mapFieldTypeToEmptyValue(field3) {
     case FieldType.QR_READER:
     case FieldType.ID_READER:
     case FieldType.LOADER:
+    case FieldType.HIDDEN:
       return null;
     case FieldType.ADDRESS:
       return {
@@ -3332,6 +3359,9 @@ var isIdReaderFieldType = (field3) => {
 var isLoaderFieldType = (field3) => {
   return field3.config.type === FieldType.LOADER;
 };
+var isHiddenFieldType = (field3) => {
+  return field3.config.type === FieldType.HIDDEN;
+};
 var isNonInteractiveFieldType = (field3) => {
   return field3.type === FieldType.DIVIDER || field3.type === FieldType.PAGE_HEADER || field3.type === FieldType.PARAGRAPH || field3.type === FieldType.BULLET_LIST || field3.type === FieldType.DATA || field3.type === FieldType.ALPHA_PRINT_BUTTON || field3.type === FieldType.HTTP || field3.type === FieldType.LINK_BUTTON || field3.type === FieldType.QUERY_PARAM_READER || field3.type === FieldType.LOADER;
 };
@@ -4106,6 +4136,11 @@ function aggregateActionDeclarations(event2) {
     return getCompleteActionDeclaration(declaration, event2, action);
   }, {});
 }
+function aggregateActionAnnotations(actions) {
+  return actions.reduce((ann, sortedAction) => {
+    return deepMerge(ann, sortedAction.annotation ?? {});
+  }, {});
+}
 
 // ../commons/src/events/EventConfig.ts
 var EventConfig = z29.object({
@@ -4115,6 +4150,9 @@ var EventConfig = z29.object({
   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: 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}").'
   ),
@@ -4189,6 +4227,19 @@ var EventConfig = z29.object({
       });
     }
   }
+  if (event2.placeOfEvent) {
+    const eventPlaceFieldId = getDeclarationFields(event2).find(
+      ({ id }) => id === event2.placeOfEvent?.$$field
+    );
+    if (!eventPlaceFieldId) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Place of event field id must match a field id in the event.declaration fields.
+            Invalid place of event field ID for event ${event2.id}: ${event2.placeOfEvent.$$field}`,
+        path: ["placeOfEvent"]
+      });
+    }
+  }
   const isInherentFlag = (value) => Object.values(InherentFlags).includes(value);
   const configuredFlagIds = event2.flags.map((flag2) => flag2.id);
   const actionFlagIds = event2.actions.flatMap(
@@ -5487,7 +5538,7 @@ function resolveEventCustomFlags(event2, eventConfiguration) {
       actions: actions.slice(0, idx + 1)
     };
     const declaration = aggregateActionDeclarations(eventUpToThisAction);
-    const annotation = aggregateActionDeclarations(eventUpToThisAction);
+    const annotation = aggregateActionAnnotations(eventUpToThisAction.actions);
     const form = { ...declaration, ...annotation };
     const flagsWithMetConditions = actionConfig.flags.filter(
       ({ conditional }) => (
@@ -5616,6 +5667,33 @@ function resolveDateOfEvent(eventMetadata, declaration, config) {
   const parsedDate = ZodDate.safeParse(declaration[config.dateOfEvent.$$field]);
   return parsedDate.success ? parsedDate.data : void 0;
 }
+var DEFAULT_PLACE_OF_EVENT_PROPERTY = "createdAtLocation";
+function getParsedUUID(value, oldValue) {
+  const parsed = UUID.safeParse(value);
+  return parsed.success ? parsed.data : oldValue;
+}
+function resolvePlaceOfEvent(eventMetadata, declaration, config) {
+  let placeOfEvent = getParsedUUID(
+    eventMetadata[DEFAULT_PLACE_OF_EVENT_PROPERTY]
+  );
+  if (config.placeOfEvent) {
+    const addressFieldValue = AddressFieldValue.safeParse(
+      declaration[config.placeOfEvent.$$field]
+    );
+    if (addressFieldValue.success && addressFieldValue.data.addressType === AddressType.DOMESTIC && addressFieldValue.data.administrativeArea) {
+      placeOfEvent = getParsedUUID(
+        addressFieldValue.data.administrativeArea,
+        placeOfEvent
+      );
+    } else {
+      placeOfEvent = getParsedUUID(
+        declaration[config.placeOfEvent.$$field],
+        placeOfEvent
+      );
+    }
+  }
+  return placeOfEvent;
+}
 function extractPotentialDuplicatesFromActions(actions) {
   return actions.reduce((duplicates, action) => {
     if (action.type === ActionType.DUPLICATE_DETECTED) {
@@ -5660,6 +5738,11 @@ function getCurrentEventState(event2, config) {
     trackingId: event2.trackingId,
     updatedByUserRole: requestActionMetadata.createdByRole,
     dateOfEvent: resolveDateOfEvent(event2, declaration, config),
+    placeOfEvent: resolvePlaceOfEvent(
+      { createdAtLocation: creationAction.createdAtLocation },
+      declaration,
+      config
+    ),
     potentialDuplicates: extractPotentialDuplicatesFromActions(sortedActions),
     flags: getEventFlags(event2, config)
   });
@@ -5704,6 +5787,11 @@ function applyDeclarationToEventIndex(eventIndex, declaration, eventConfiguratio
       updatedDeclaration,
       eventConfiguration
     ),
+    placeOfEvent: resolvePlaceOfEvent(
+      eventIndex,
+      updatedDeclaration,
+      eventConfiguration
+    ),
     declaration: updatedDeclaration
   };
 }
@@ -8011,6 +8099,7 @@ function mapFieldTypeToMockValue(field3, i, rng) {
     case FieldType.OFFICE:
     case FieldType.LINK_BUTTON:
     case FieldType.LOADER:
+    case FieldType.HIDDEN:
       return `${field3.id}-${field3.type}-${i}`;
     case FieldType.VERIFICATION_STATUS:
       return "verified";

package/dist/notification/index.js

@@ -266,7 +266,8 @@ var FieldType = {
   QUERY_PARAM_READER: "QUERY_PARAM_READER",
   QR_READER: "QR_READER",
   ID_READER: "ID_READER",
-  LOADER: "LOADER"
+  LOADER: "LOADER",
+  HIDDEN: "HIDDEN"
 };
 var FileFieldType = z4.enum([
   FieldType.FILE,
@@ -396,6 +397,7 @@ var IdReaderFieldValue = ReadDataValue;
 
 // ../commons/src/events/FieldValue.ts
 var TextValue = z7.string();
+var HiddenFieldValue = z7.string();
 var NonEmptyTextValue = TextValue.min(1);
 var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
 var AgeValue = z7.object({
@@ -521,7 +523,8 @@ var FieldUpdateValue = safeUnion([
   DataFieldValue.describe("DataFieldValue"),
   NameFieldUpdateValue.describe("NameFieldUpdateValue"),
   HttpFieldUpdateValue.describe("HttpFieldUpdateValue"),
-  QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue")
+  QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue"),
+  HiddenFieldValue.describe("HiddenFieldValue")
 ]);
 
 // ../commons/src/uuid.ts
@@ -1236,6 +1239,7 @@ var EventMetadata = z14.object({
   ),
   createdAt: z14.iso.datetime().describe("The timestamp when the event was first created and saved."),
   dateOfEvent: ZodDate.nullish(),
+  placeOfEvent: CreatedAtLocation,
   createdBy: z14.string().describe("ID of the user who created the event."),
   createdByUserType: z14.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
   updatedByUserRole: z14.string().describe("Role of the user who last changed the status."),
@@ -1265,6 +1269,7 @@ var EventMetadataKeysArray = [
   "status",
   "createdAt",
   "dateOfEvent",
+  "placeOfEvent",
   "createdBy",
   "createdByUserType",
   "updatedByUserRole",
@@ -1958,6 +1963,13 @@ var LoaderField = BaseField.extend({
 }).describe(
   "A non-interactive field that indicates an in progress operation in form"
 );
+var HiddenField = BaseField.extend({
+  type: z16.literal(FieldType.HIDDEN),
+  required: z16.literal(false).optional()
+  // Hidden fields cannot be required
+}).describe(
+  "A non-interactive, hidden field that only hold a value in the form"
+);
 var FieldConfig = z16.discriminatedUnion("type", [
   Address,
   TextField,
@@ -1997,7 +2009,8 @@ var FieldConfig = z16.discriminatedUnion("type", [
   IdReaderField,
   QueryParamReaderField,
   LoaderField,
-  SearchField
+  SearchField,
+  HiddenField
 ]).meta({
   description: "Form field configuration",
   id: "FieldConfig"
@@ -2511,6 +2524,7 @@ var EventFieldIdInput = z25.enum([
   "status",
   "legalStatuses.REGISTERED.acceptedAt",
   "legalStatuses.REGISTERED.createdAtLocation",
+  "legalStatuses.REGISTERED.registrationNumber",
   "updatedAt"
 ]);
 var METADATA_FIELD_PREFIX = "event.";
@@ -2519,6 +2533,7 @@ var EventFieldId = z25.enum([
   `${METADATA_FIELD_PREFIX}status`,
   `${METADATA_FIELD_PREFIX}legalStatuses.REGISTERED.acceptedAt`,
   `${METADATA_FIELD_PREFIX}legalStatuses.REGISTERED.createdAtLocation`,
+  `${METADATA_FIELD_PREFIX}legalStatuses.REGISTERED.registrationNumber`,
   `${METADATA_FIELD_PREFIX}updatedAt`
 ]);
 var EventFieldConfigSchema = BaseField3.extend({
@@ -2675,6 +2690,9 @@ var EventConfig = z29.object({
   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: 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}").'
   ),
@@ -2749,6 +2767,19 @@ var EventConfig = z29.object({
       });
     }
   }
+  if (event2.placeOfEvent) {
+    const eventPlaceFieldId = getDeclarationFields(event2).find(
+      ({ id }) => id === event2.placeOfEvent?.$$field
+    );
+    if (!eventPlaceFieldId) {
+      ctx.addIssue({
+        code: "custom",
+        message: `Place of event field id must match a field id in the event.declaration fields.
+            Invalid place of event field ID for event ${event2.id}: ${event2.placeOfEvent.$$field}`,
+        path: ["placeOfEvent"]
+      });
+    }
+  }
   const isInherentFlag = (value) => Object.values(InherentFlags).includes(value);
   const configuredFlagIds = event2.flags.map((flag2) => flag2.id);
   const actionFlagIds = event2.actions.flatMap(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/toolkit",
-  "version": "1.9.2-rc.cb144d0",
+  "version": "1.9.2-rc.f1d7235",
   "description": "OpenCRVS toolkit for building country configurations",
   "license": "MPL-2.0",
   "exports": {