@opencrvs/toolkit 1.8.0-rc.ff2e7b6 → 1.8.0-rc.ffe8c17

package/dist/events/index.js

@@ -51,6 +51,7 @@ __export(events_exports, {
   Clause: () => Clause,
   Conditional: () => Conditional,
   ConditionalType: () => ConditionalType,
+  DataFieldValue: () => DataFieldValue,
   DateValue: () => DateValue,
   DeclareActionInput: () => DeclareActionInput,
   DeduplicationConfig: () => DeduplicationConfig,
@@ -81,6 +82,8 @@ __export(events_exports, {
   MarkedAsDuplicateActionInput: () => MarkedAsDuplicateActionInput,
   NotifyActionInput: () => NotifyActionInput,
   NumberFieldValue: () => NumberFieldValue,
+  PageConfig: () => PageConfig,
+  PageType: () => PageType,
   PrintCertificateActionInput: () => PrintCertificateActionInput,
   RegisterActionInput: () => RegisterActionInput,
   RejectCorrectionActionInput: () => RejectCorrectionActionInput,
@@ -97,17 +100,21 @@ __export(events_exports, {
   UrbanAddressUpdateValue: () => UrbanAddressUpdateValue,
   UrbanAddressValue: () => UrbanAddressValue,
   ValidateActionInput: () => ValidateActionInput,
+  VerificationPage: () => VerificationPage,
+  VerificationPageConfig: () => VerificationPageConfig,
   WorkqueueConfig: () => WorkqueueConfig,
   alwaysTrue: () => alwaysTrue,
   and: () => and,
   applyDraftsToEventIndex: () => applyDraftsToEventIndex,
   compositeFieldTypes: () => compositeFieldTypes,
+  createEmptyDraft: () => createEmptyDraft,
   createValidationSchema: () => createValidationSchema,
   deepDropNulls: () => deepDropNulls,
   defineConditional: () => defineConditional,
   defineConfig: () => defineConfig,
   defineForm: () => defineForm,
-  defineFormPage: () => defineFormPage,
+  definePage: () => definePage,
+  errorMessages: () => errorMessages,
   event: () => event,
   eventMetadataLabelMap: () => eventMetadataLabelMap,
   eventPayloadGenerator: () => eventPayloadGenerator,
@@ -119,6 +126,7 @@ __export(events_exports, {
   findActiveActionForm: () => findActiveActionForm,
   findActiveActionFormFields: () => findActiveActionFormFields,
   findActiveActionFormPages: () => findActiveActionFormPages,
+  findActiveDrafts: () => findActiveDrafts,
   findInputPageFields: () => findInputPageFields,
   findPageFields: () => findPageFields,
   generateActionDocument: () => generateActionDocument,
@@ -141,6 +149,7 @@ __export(events_exports, {
   isBulletListFieldType: () => isBulletListFieldType,
   isCheckboxFieldType: () => isCheckboxFieldType,
   isCountryFieldType: () => isCountryFieldType,
+  isDataFieldType: () => isDataFieldType,
   isDateFieldType: () => isDateFieldType,
   isDividerFieldType: () => isDividerFieldType,
   isEmailFieldType: () => isEmailFieldType,
@@ -164,6 +173,7 @@ __export(events_exports, {
   isTextAreaFieldType: () => isTextAreaFieldType,
   isTextFieldType: () => isTextFieldType,
   isUndeclaredDraft: () => isUndeclaredDraft,
+  mapFieldTypeToEmptyValue: () => mapFieldTypeToEmptyValue,
   mapFieldTypeToMockValue: () => mapFieldTypeToMockValue,
   mapFieldTypeToZod: () => mapFieldTypeToZod,
   not: () => not,
@@ -247,7 +257,8 @@ var FieldType = {
   ADMINISTRATIVE_AREA: "ADMINISTRATIVE_AREA",
   FACILITY: "FACILITY",
   OFFICE: "OFFICE",
-  SIGNATURE: "SIGNATURE"
+  SIGNATURE: "SIGNATURE",
+  DATA: "DATA"
 };
 var fieldTypes = Object.values(FieldType);
 var compositeFieldTypes = [
@@ -332,6 +343,7 @@ var FieldValue = import_zod4.z.union([
   UrbanAddressValue,
   RuralAddressValue
 ]);
+var DataFieldValue = import_zod4.z.record(import_zod4.z.string(), FieldValue);
 var FieldUpdateValue = import_zod4.z.union([
   TextValue,
   DateValue,
@@ -543,6 +555,14 @@ var Address = BaseField.extend({
   type: import_zod5.z.literal(FieldType.ADDRESS),
   defaultValue: AddressFieldValue.optional()
 }).describe("Address input field \u2013 a combination of location and text fields");
+var Data = BaseField.extend({
+  type: import_zod5.z.literal(FieldType.DATA),
+  configuration: import_zod5.z.object({
+    title: TranslationConfig.optional(),
+    subtitle: TranslationConfig.optional(),
+    data: import_zod5.z.array(import_zod5.z.object({ fieldId: import_zod5.z.string() }))
+  })
+}).describe("Data field for displaying read-only data");
 var FieldConfig = import_zod5.z.discriminatedUnion("type", [
   Address,
   TextField,
@@ -564,15 +584,44 @@ var FieldConfig = import_zod5.z.discriminatedUnion("type", [
   Office,
   SignatureField,
   EmailField,
-  FileUploadWithOptions
+  FileUploadWithOptions,
+  Data
 ]);
 
 // ../commons/src/events/FormConfig.ts
+var PageType = /* @__PURE__ */ ((PageType2) => {
+  PageType2["FORM"] = "FORM";
+  PageType2["VERIFICATION"] = "VERIFICATION";
+  return PageType2;
+})(PageType || {});
 var FormPage = import_zod6.z.object({
   id: import_zod6.z.string().describe("Unique identifier for the page"),
   title: TranslationConfig.describe("Header title of the page"),
-  fields: import_zod6.z.array(FieldConfig).describe("Fields to be rendered on the page")
+  fields: import_zod6.z.array(FieldConfig).describe("Fields to be rendered on the page"),
+  type: import_zod6.z.literal("FORM" /* FORM */).default("FORM" /* FORM */)
 });
+var VerificationPageConfig = import_zod6.z.object({
+  verify: import_zod6.z.object({ label: TranslationConfig }),
+  cancel: import_zod6.z.object({
+    label: TranslationConfig,
+    confirmation: import_zod6.z.object({
+      title: TranslationConfig,
+      body: TranslationConfig
+    })
+  })
+}).describe("Actions available on the verification page");
+var VerificationPage = FormPage.extend({
+  type: import_zod6.z.literal("VERIFICATION" /* VERIFICATION */),
+  actions: VerificationPageConfig
+});
+var PageConfig = import_zod6.z.preprocess(
+  (data) => ({
+    type: data.type ?? "FORM" /* FORM */,
+    // Default type to "FORM" if not provided
+    ...data
+  }),
+  import_zod6.z.discriminatedUnion("type", [FormPage, VerificationPage])
+);
 var FormConfig = import_zod6.z.object({
   label: TranslationConfig.describe("Human readable description of the form"),
   version: import_zod6.z.object({
@@ -584,7 +633,7 @@ var FormConfig = import_zod6.z.object({
     )
   }),
   active: import_zod6.z.boolean().default(false).describe("Whether the form is active"),
-  pages: import_zod6.z.array(FormPage),
+  pages: import_zod6.z.array(PageConfig),
   review: import_zod6.z.object({
     title: TranslationConfig.describe(
       "Title of the form to show in review page"
@@ -639,23 +688,17 @@ var ValidateConfig = ActionConfigBase.merge(
 );
 var RejectDeclarationConfig = ActionConfigBase.merge(
   import_zod7.z.object({
-    type: import_zod7.z.literal(ActionType.REJECT),
-    comment: import_zod7.z.string(),
-    isDuplicate: import_zod7.z.boolean()
+    type: import_zod7.z.literal(ActionType.REJECT)
   })
 );
 var MarkedAsDuplicateConfig = ActionConfigBase.merge(
   import_zod7.z.object({
-    type: import_zod7.z.literal(ActionType.MARKED_AS_DUPLICATE),
-    comment: import_zod7.z.string(),
-    duplicates: import_zod7.z.array(import_zod7.z.string()).describe("UUIDs of duplicate records")
+    type: import_zod7.z.literal(ActionType.MARKED_AS_DUPLICATE)
   })
 );
 var ArchiveConfig = ActionConfigBase.merge(
   import_zod7.z.object({
-    type: import_zod7.z.literal(ActionType.ARCHIVE),
-    comment: import_zod7.z.string(),
-    isDuplicate: import_zod7.z.boolean()
+    type: import_zod7.z.literal(ActionType.ARCHIVE)
   })
 );
 var RegisterConfig = ActionConfigBase.merge(
@@ -676,8 +719,8 @@ var PrintCertificateActionConfig = ActionConfigBase.merge(
 var RequestCorrectionConfig = ActionConfigBase.merge(
   import_zod7.z.object({
     type: import_zod7.z.literal(ActionType.REQUEST_CORRECTION),
-    onboardingForm: import_zod7.z.array(FormPage),
-    additionalDetailsForm: import_zod7.z.array(FormPage)
+    onboardingForm: import_zod7.z.array(PageConfig),
+    additionalDetailsForm: import_zod7.z.array(PageConfig)
   })
 );
 var RejectCorrectionConfig = ActionConfigBase.merge(
@@ -1119,6 +1162,9 @@ function mapFieldTypeToZod(type, required) {
     case FieldType.ADDRESS:
       schema = AddressFieldUpdateValue;
       break;
+    case FieldType.DATA:
+      schema = DataFieldValue;
+      break;
   }
   return required ? schema : schema.nullish();
 }
@@ -1174,6 +1220,53 @@ function mapFieldTypeToMockValue(field2, i) {
       };
     case FieldType.FILE_WITH_OPTIONS:
       return null;
+    case FieldType.DATA:
+      return {};
+  }
+}
+function mapFieldTypeToEmptyValue(field2) {
+  switch (field2.type) {
+    case FieldType.DIVIDER:
+    case FieldType.TEXT:
+    case FieldType.TEXTAREA:
+    case FieldType.BULLET_LIST:
+    case FieldType.PAGE_HEADER:
+    case FieldType.LOCATION:
+    case FieldType.SELECT:
+    case FieldType.COUNTRY:
+    case FieldType.RADIO_GROUP:
+    case FieldType.SIGNATURE:
+    case FieldType.PARAGRAPH:
+    case FieldType.ADMINISTRATIVE_AREA:
+    case FieldType.FACILITY:
+    case FieldType.OFFICE:
+    case FieldType.NUMBER:
+    case FieldType.EMAIL:
+    case FieldType.DATE:
+    case FieldType.CHECKBOX:
+    case FieldType.DATA:
+      return null;
+    case FieldType.ADDRESS:
+      return {
+        country: null,
+        province: null,
+        district: null,
+        urbanOrRural: "URBAN",
+        // Default to urban needed for validation
+        town: null,
+        residentialArea: null,
+        street: null,
+        number: null,
+        zipCode: null
+      };
+    case FieldType.FILE:
+      return {
+        filename: "",
+        originalFilename: "",
+        type: ""
+      };
+    case FieldType.FILE_WITH_OPTIONS:
+      return [];
   }
 }
 var isParagraphFieldType = (field2) => {
@@ -1239,6 +1332,9 @@ var isFacilityFieldType = (field2) => {
 var isOfficeFieldType = (field2) => {
   return field2.config.type === FieldType.OFFICE;
 };
+var isDataFieldType = (field2) => {
+  return field2.config.type === FieldType.DATA;
+};
 
 // ../commons/src/conditionals/validate.ts
 var ajv = new import_ajv.default({
@@ -1275,49 +1371,66 @@ function isFieldVisible(field2, form) {
 function isFieldEnabled(field2, form) {
   return isFieldConditionMet(field2, form, ConditionalType.ENABLE);
 }
+var errorMessages = {
+  hiddenField: {
+    id: "v2.error.hidden",
+    defaultMessage: "Hidden or disabled field should not receive a value",
+    description: "Error message when field is hidden or disabled, but a value was received"
+  },
+  invalidDate: {
+    defaultMessage: "Invalid date field",
+    description: "Error message when date field is invalid",
+    id: "v2.error.invalidDate"
+  },
+  invalidEmail: {
+    defaultMessage: "Invalid email address",
+    description: "Error message when email address is invalid",
+    id: "v2.error.invalidEmail"
+  },
+  requiredField: {
+    defaultMessage: "Required for registration",
+    description: "Error message when required field is missing",
+    id: "v2.error.required"
+  },
+  invalidInput: {
+    defaultMessage: "Invalid input",
+    description: "Error message when generic field is invalid",
+    id: "v2.error.invalid"
+  }
+};
+var createIntlError = (message) => ({
+  message: {
+    message
+  }
+});
 var zodToIntlErrorMap = (issue, _ctx) => {
-  if (issue.code === "invalid_string" && issue.validation === "date") {
-    return {
-      message: {
-        message: {
-          defaultMessage: "Invalid date. Please use the format YYYY-MM-DD",
-          description: "This is the error message for invalid date fields",
-          id: "v2.error.invalidDate"
-        }
+  switch (issue.code) {
+    case "invalid_string": {
+      if (_ctx.data === "") {
+        return createIntlError(errorMessages.requiredField);
       }
-    };
-  }
-  if (issue.code === "invalid_string" && issue.validation === "email") {
-    return {
-      message: {
-        message: {
-          defaultMessage: "Invalid email address",
-          description: "This is the error message for invalid email fields",
-          id: "v2.error.invalidEmail"
-        }
+      if (issue.validation === "date") {
+        return createIntlError(errorMessages.invalidDate);
       }
-    };
-  }
-  if (issue.code === "invalid_type" && issue.expected !== issue.received && issue.received === "undefined" || issue.code === "too_small" && issue.message === void 0) {
-    return {
-      message: {
-        message: {
-          defaultMessage: "Required for registration",
-          description: "This is the error message for required fields",
-          id: "v2.error.required"
-        }
+      if (issue.validation === "email") {
+        return createIntlError(errorMessages.invalidEmail);
       }
-    };
-  }
-  return {
-    message: {
-      message: {
-        defaultMessage: "Invalid input",
-        description: "This is the error message for invalid field value",
-        id: "v2.error.invalid"
+      break;
+    }
+    case "invalid_type": {
+      if (issue.expected !== issue.received && issue.received === "undefined") {
+        return createIntlError(errorMessages.requiredField);
       }
+      break;
     }
-  };
+    case "too_small": {
+      if (issue.message === void 0) {
+        return createIntlError(errorMessages.requiredField);
+      }
+      break;
+    }
+  }
+  return createIntlError(errorMessages.invalidInput);
 };
 function getFieldValidationErrors({
   field: field2,
@@ -1332,11 +1445,7 @@ function getFieldValidationErrors({
       return {
         errors: [
           {
-            message: {
-              id: "v2.error.hidden",
-              defaultMessage: "Hidden or disabled field should not receive a value",
-              description: "Error message when field is hidden or disabled, but a value was received"
-            }
+            message: errorMessages.hiddenField
           }
         ]
       };
@@ -1354,8 +1463,8 @@ function getFieldValidationErrors({
     conditionalParameters
   });
   return {
-    // Assumes that custom validation errors are more important than field validation errors
-    errors: [...customValidationResults, ...fieldValidationResult]
+    // Assumes that custom validation errors are based on the field type, and extend the validation.
+    errors: [...fieldValidationResult, ...customValidationResults]
   };
 }
 function runCustomFieldValidations({
@@ -1388,6 +1497,12 @@ function getOrThrow(x, message) {
   return x;
 }
 
+// ../commons/src/uuid.ts
+var import_uuid = require("uuid");
+function getUUID() {
+  return (0, import_uuid.v4)();
+}
+
 // ../commons/src/events/utils.ts
 function isMetadataField(field2) {
   return field2 in eventMetadataLabelMap;
@@ -1457,7 +1572,7 @@ function validateWorkqueueConfig(workqueueConfigs) {
     );
     if (!rootWorkqueue) {
       throw new Error(
-        `Invalid workqueue configuration: workqueue not found with id:  ${workqueue.id}`
+        `Invalid workqueue configuration: workqueue not found with id: ${workqueue.id}`
       );
     }
   });
@@ -1522,6 +1637,27 @@ function stripHiddenFields(fields, data) {
     return !isFieldVisible(field2, data);
   });
 }
+function findActiveDrafts(event2, drafts) {
+  const actions = event2.actions.slice().sort((a, b) => a.createdAt.localeCompare(b.createdAt));
+  const lastAction = actions[actions.length - 1];
+  return drafts.filter(({ createdAt }) => createdAt >= lastAction.createdAt).filter(({ eventId }) => eventId === event2.id);
+}
+function createEmptyDraft(eventId, draftId, actionType) {
+  return {
+    id: draftId,
+    eventId,
+    createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+    transactionId: getUUID(),
+    action: {
+      type: actionType,
+      data: {},
+      metadata: {},
+      createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+      createdBy: "@todo",
+      createdAtLocation: "@todo"
+    }
+  };
+}
 
 // ../commons/src/events/EventConfig.ts
 var EventConfig = import_zod18.z.object({
@@ -1563,7 +1699,7 @@ var EventConfig = import_zod18.z.object({
 
 // ../commons/src/events/EventConfigInput.ts
 var defineForm = (form) => FormConfig.parse(form);
-var defineFormPage = (formPage) => FormPage.parse(formPage);
+var definePage = (formPage) => PageConfig.parse(formPage);
 
 // ../commons/src/events/Draft.ts
 var import_zod21 = require("zod");
@@ -1955,9 +2091,8 @@ function getCurrentEventState(event2) {
   });
 }
 function getCurrentEventStateWithDrafts(event2, drafts) {
-  const actions = event2.actions.slice().sort();
-  const lastAction = actions[actions.length - 1];
-  const activeDrafts = drafts.filter(({ eventId }) => eventId === event2.id).filter(({ createdAt }) => createdAt > lastAction.createdAt).map((draft) => draft.action).flatMap((action) => {
+  const actions = event2.actions.slice().sort((a, b) => a.createdAt.localeCompare(b.createdAt));
+  const activeDrafts = findActiveDrafts(event2, drafts).map((draft) => draft.action).flatMap((action) => {
     if (action.type === ActionType.REQUEST_CORRECTION) {
       return [
         action,
@@ -2018,12 +2153,6 @@ var defineConfig = (config) => {
   });
 };
 
-// ../commons/src/uuid.ts
-var import_uuid = require("uuid");
-function getUUID() {
-  return (0, import_uuid.v4)();
-}
-
 // ../commons/src/events/transactions.ts
 function generateTransactionId() {
   return getUUID();
@@ -3443,6 +3572,24 @@ var tennisClubMembershipEvent = defineConfig({
           })
         }
       ]
+    },
+    {
+      type: ActionType.ARCHIVE,
+      label: {
+        id: "v2.event.tennis-club-membership.action.archive.label",
+        defaultMessage: "Archive",
+        description: "This is shown as the action name anywhere the user can trigger the action from"
+      },
+      forms: [TENNIS_CLUB_FORM]
+    },
+    {
+      type: ActionType.REJECT,
+      label: {
+        id: "v2.event.tennis-club-membership.action.reject.label",
+        defaultMessage: "Reject",
+        description: "This is shown as the action name anywhere the user can trigger the action from"
+      },
+      forms: [TENNIS_CLUB_FORM]
     }
   ],
   advancedSearch: [
@@ -3525,7 +3672,7 @@ var eventPayloadGenerator = {
     archive: (eventId, input = {}, isDuplicate) => ({
       type: ActionType.ARCHIVE,
       transactionId: input.transactionId ?? getUUID(),
-      data: input.data ?? {},
+      data: input.data ?? generateActionInput(tennisClubMembershipEvent, ActionType.ARCHIVE),
       metadata: { isDuplicate: isDuplicate ?? false },
       duplicates: [],
       eventId
@@ -3533,7 +3680,7 @@ var eventPayloadGenerator = {
     reject: (eventId, input = {}) => ({
       type: ActionType.REJECT,
       transactionId: input.transactionId ?? getUUID(),
-      data: input.data ?? {},
+      data: input.data ?? generateActionInput(tennisClubMembershipEvent, ActionType.REJECT),
       duplicates: [],
       eventId
     }),
@@ -3592,7 +3739,9 @@ function generateActionDocument({
   defaults = {}
 }) {
   const actionBase = {
-    createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+    // Offset is needed so the createdAt timestamps for events, actions and drafts make logical sense in storybook tests.
+    // @TODO: This should be fixed in the future.
+    createdAt: new Date(Date.now() - 500).toISOString(),
     createdBy: getUUID(),
     id: getUUID(),
     createdAtLocation: "TODO",
@@ -3647,9 +3796,13 @@ function generateEventDocument({
     actions: actions.map(
       (action) => generateActionDocument({ configuration, action })
     ),
-    createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+    // Offset is needed so the createdAt timestamps for events, actions and drafts make logical sense in storybook tests.
+    // @TODO: This should be fixed in the future.
+    createdAt: new Date(Date.now() - 1e3).toISOString(),
     id: getUUID(),
-    updatedAt: (/* @__PURE__ */ new Date()).toISOString()
+    // Offset is needed so the createdAt timestamps for events, actions and drafts make logical sense in storybook tests.
+    // @TODO: This should be fixed in the future.
+    updatedAt: new Date(Date.now() - 1e3).toISOString()
   };
 }
 function generateEventDraftDocument(eventId, actionType = ActionType.DECLARE, data = {}) {

package/package.json

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