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

package/dist/events/index.js

@@ -77,7 +77,6 @@ __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,
@@ -100,6 +99,7 @@ __export(events_exports, {
   DraftInput: () => DraftInput,
   DuplicateDetectedAction: () => DuplicateDetectedAction,
   DuplicateDetectedActionInput: () => DuplicateDetectedActionInput,
+  EditActionInput: () => EditActionInput,
   EmailField: () => EmailField,
   EmailValue: () => EmailValue,
   EnableConditional: () => EnableConditional,
@@ -138,7 +138,6 @@ __export(events_exports, {
   FormPageConfig: () => FormPageConfig,
   Fuzzy: () => Fuzzy,
   GeographicalArea: () => GeographicalArea,
-  HiddenFieldValue: () => HiddenFieldValue,
   HttpFieldUpdateValue: () => HttpFieldUpdateValue,
   HttpFieldValue: () => HttpFieldValue,
   IdReaderFieldValue: () => IdReaderFieldValue,
@@ -334,7 +333,6 @@ __export(events_exports, {
   isFieldVisible: () => isFieldVisible,
   isFileFieldType: () => isFileFieldType,
   isFileFieldWithOptionType: () => isFileFieldWithOptionType,
-  isHiddenFieldType: () => isHiddenFieldType,
   isHttpFieldType: () => isHttpFieldType,
   isIdFieldType: () => isIdFieldType,
   isIdReaderFieldType: () => isIdReaderFieldType,
@@ -379,7 +377,6 @@ __export(events_exports, {
   or: () => or,
   pickRandom: () => pickRandom,
   resolveDateOfEvent: () => resolveDateOfEvent,
-  resolvePlaceOfEvent: () => resolvePlaceOfEvent,
   runFieldValidations: () => runFieldValidations,
   runStructuralValidations: () => runStructuralValidations,
   safeUnion: () => safeUnion,
@@ -428,6 +425,7 @@ var ActionType = {
   DECLARE: "DECLARE",
   VALIDATE: "VALIDATE",
   REGISTER: "REGISTER",
+  EDIT: "EDIT",
   // Declaration system actions. Non-configurable.
   DUPLICATE_DETECTED: "DUPLICATE_DETECTED",
   REJECT: "REJECT",
@@ -450,6 +448,7 @@ var ActionType = {
 var ConfirmableActions = [
   ActionType.NOTIFY,
   ActionType.DECLARE,
+  ActionType.EDIT,
   ActionType.VALIDATE,
   ActionType.REGISTER,
   ActionType.REJECT,
@@ -465,6 +464,7 @@ var ActionTypes = z2.enum([
   "CREATE",
   "NOTIFY",
   "DECLARE",
+  "EDIT",
   "VALIDATE",
   "REGISTER",
   "DUPLICATE_DETECTED",
@@ -486,6 +486,7 @@ var ClientSpecificAction = {
 };
 var declarationActionValues = [
   ActionTypes.enum.DECLARE,
+  ActionTypes.enum.EDIT,
   ActionTypes.enum.VALIDATE,
   ActionTypes.enum.REGISTER,
   ActionTypes.enum.NOTIFY,
@@ -618,8 +619,7 @@ var FieldType = {
   QUERY_PARAM_READER: "QUERY_PARAM_READER",
   QR_READER: "QR_READER",
   ID_READER: "ID_READER",
-  LOADER: "LOADER",
-  HIDDEN: "HIDDEN"
+  LOADER: "LOADER"
 };
 var FileFieldType = z4.enum([
   FieldType.FILE,
@@ -753,7 +753,6 @@ 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({
@@ -879,8 +878,7 @@ var FieldUpdateValue = safeUnion([
   DataFieldValue.describe("DataFieldValue"),
   NameFieldUpdateValue.describe("NameFieldUpdateValue"),
   HttpFieldUpdateValue.describe("HttpFieldUpdateValue"),
-  QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue"),
-  HiddenFieldValue.describe("HiddenFieldValue")
+  QueryParamReaderFieldUpdateValue.describe("QueryParamReaderFieldUpdateValue")
 ]);
 
 // ../commons/src/uuid.ts
@@ -1141,6 +1139,7 @@ var RecordScopeType = z10.enum([
   "record.read",
   "record.declare",
   "record.notify",
+  "record.declared.edit",
   "record.declared.validate",
   "record.declared.reject",
   "record.declared.archive",
@@ -1498,6 +1497,11 @@ var NotifiedAction = ActionBase.extend(
     type: z12.literal(ActionType.NOTIFY)
   }).shape
 );
+var EditAction = ActionBase.extend(
+  z12.object({
+    type: z12.literal(ActionType.EDIT)
+  }).shape
+);
 var PrintContent = z12.object({
   templateId: z12.string().optional()
 });
@@ -1556,6 +1560,7 @@ var ActionDocument = z12.discriminatedUnion("type", [
   UnassignedAction.meta({ id: "UnassignedAction" }),
   PrintCertificateAction.meta({ id: "PrintCertificateAction" }),
   ReadAction.meta({ id: "ReadAction" }),
+  EditAction.meta({ id: "EditAction" }),
   CustomAction.meta({ id: "CustomAction" })
 ]).meta({
   id: "ActionDocument"
@@ -1578,7 +1583,8 @@ var InherentFlags = {
   INCOMPLETE: "incomplete",
   REJECTED: "rejected",
   CORRECTION_REQUESTED: "correction-requested",
-  POTENTIAL_DUPLICATE: "potential-duplicate"
+  POTENTIAL_DUPLICATE: "potential-duplicate",
+  EDIT_IN_PROGRESS: "edit-in-progress"
 };
 var ActionFlag = z13.string().regex(
   new RegExp(
@@ -1649,7 +1655,6 @@ 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."),
@@ -1679,7 +1684,6 @@ var EventMetadataKeysArray = [
   "status",
   "createdAt",
   "dateOfEvent",
-  "placeOfEvent",
   "createdBy",
   "createdByUserType",
   "updatedByUserRole",
@@ -1714,11 +1718,6 @@ 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",
@@ -2459,13 +2458,6 @@ 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,
@@ -2505,8 +2497,7 @@ var FieldConfig = z16.discriminatedUnion("type", [
   IdReaderField,
   QueryParamReaderField,
   LoaderField,
-  SearchField,
-  HiddenField
+  SearchField
 ]).meta({
   description: "Form field configuration",
   id: "FieldConfig"
@@ -3138,7 +3129,6 @@ 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:
@@ -3222,7 +3212,6 @@ function mapFieldTypeToEmptyValue(field3) {
     case FieldType.QR_READER:
     case FieldType.ID_READER:
     case FieldType.LOADER:
-    case FieldType.HIDDEN:
       return null;
     case FieldType.ADDRESS:
       return {
@@ -3359,9 +3348,6 @@ 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;
 };
@@ -3806,7 +3792,7 @@ function getActionConfig({
     if (a.type === ActionType.CUSTOM && customActionType) {
       return a.customActionType === customActionType;
     }
-    if (actionType === ActionType.NOTIFY) {
+    if (actionType === ActionType.NOTIFY || actionType === ActionType.EDIT) {
       return a.type === ActionType.DECLARE;
     }
     if (actionType === ActionType.APPROVE_CORRECTION || actionType === ActionType.REJECT_CORRECTION) {
@@ -3868,9 +3854,13 @@ var findRecordActionPages = (config, actionType) => {
   return [];
 };
 function getActionReview(configuration, actionType) {
-  const [actionConfig] = configuration.actions.filter(
-    (a) => a.type === actionType
-  );
+  const actionConfig = getActionConfig({
+    eventConfiguration: configuration,
+    actionType
+  });
+  if (!actionConfig) {
+    throw "Tried to get action review for an action that is not a declaration action";
+  }
   if ("review" in actionConfig) {
     return actionConfig.review;
   }
@@ -4150,9 +4140,6 @@ 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}").'
   ),
@@ -4227,19 +4214,6 @@ 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(
@@ -5203,6 +5177,11 @@ var DeclareActionInput = BaseActionInput.extend(
     type: z33.literal(ActionType.DECLARE).default(ActionType.DECLARE)
   }).shape
 );
+var EditActionInput = BaseActionInput.extend(
+  z33.object({
+    type: z33.literal(ActionType.EDIT).default(ActionType.EDIT)
+  }).shape
+);
 var PrintCertificateActionInput = BaseActionInput.extend(
   z33.object({
     type: z33.literal(ActionType.PRINT_CERTIFICATE).default(ActionType.PRINT_CERTIFICATE),
@@ -5314,7 +5293,8 @@ var ActionInput = z33.discriminatedUnion("type", [
     id: "ApproveCorrectionActionInput"
   }),
   ReadActionInput.meta({ id: "ReadActionInput" }),
-  CustomActionInput.meta({ id: "CustomActionInput" })
+  CustomActionInput.meta({ id: "CustomActionInput" }),
+  EditActionInput.meta({ id: "EditActionInput" })
 ]).meta({
   id: "ActionInput"
 });
@@ -5457,6 +5437,9 @@ function getLegalStatuses(actions) {
 // ../commons/src/events/state/flags.ts
 var import_lodash3 = require("lodash");
 var import_date_fns3 = require("date-fns");
+function isEditInProgress(actions) {
+  return actions.at(-1)?.type === ActionType.EDIT;
+}
 function isPendingCertification(actions) {
   if (getStatusFromActions(actions) !== EventStatus.enum.REGISTERED) {
     return false;
@@ -5519,8 +5502,14 @@ function isFlagConditionMet(conditional, form, action) {
   });
 }
 function resolveEventCustomFlags(event2, eventConfiguration) {
-  const acceptedActions = getAcceptedActions(event2);
-  const actions = acceptedActions.filter(({ type }) => !isMetaAction(type)).sort((a, b) => a.createdAt.localeCompare(b.createdAt));
+  const sortedActions = getAcceptedActions(event2).filter(({ type }) => !isMetaAction(type)).sort((a, b) => a.createdAt.localeCompare(b.createdAt));
+  const declareIndexes = sortedActions.map((a, i) => a.type === ActionType.DECLARE ? i : -1).filter((i) => i !== -1);
+  let actions = sortedActions;
+  if (declareIndexes.length >= 2) {
+    const secondLast = declareIndexes[declareIndexes.length - 2];
+    const last = declareIndexes[declareIndexes.length - 1];
+    actions = sortedActions.filter((_, idx) => idx < secondLast || idx >= last);
+  }
   return actions.reduce((acc, action, idx) => {
     let actionConfig;
     if (isActionConfigType(action.type)) {
@@ -5582,6 +5571,9 @@ function getEventFlags(event2, config) {
   if (isPotentialDuplicate(sortedActions)) {
     flags.push(InherentFlags.POTENTIAL_DUPLICATE);
   }
+  if (isEditInProgress(sortedActions)) {
+    flags.push(InherentFlags.EDIT_IN_PROGRESS);
+  }
   return [...flags, ...resolveEventCustomFlags(event2, config)];
 }
 
@@ -5611,8 +5603,8 @@ function getStatusFromActions(actions) {
       case ActionType.MARK_AS_DUPLICATE:
       case ActionType.REJECT_CORRECTION:
       case ActionType.READ:
-      case ActionType.CUSTOM:
       case ActionType.VALIDATE:
+      case ActionType.EDIT:
       default:
         return status2;
     }
@@ -5667,33 +5659,6 @@ 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) {
@@ -5738,11 +5703,6 @@ 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)
   });
@@ -5787,11 +5747,6 @@ function applyDeclarationToEventIndex(eventIndex, declaration, eventConfiguratio
       updatedDeclaration,
       eventConfiguration
     ),
-    placeOfEvent: resolvePlaceOfEvent(
-      eventIndex,
-      updatedDeclaration,
-      eventConfiguration
-    ),
     declaration: updatedDeclaration
   };
 }
@@ -8099,7 +8054,6 @@ 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";
@@ -8326,6 +8280,14 @@ function eventPayloadGenerator(rng, configuration = tennisClubMembershipEvent) {
           keepAssignment: input.keepAssignment
         };
       },
+      edit: (eventId, input = {}) => ({
+        type: ActionType.EDIT,
+        transactionId: input.transactionId ?? getUUID(),
+        declaration: input.declaration ?? generateActionDeclarationInput(configuration, ActionType.EDIT, rng),
+        annotation: input.annotation ?? generateActionAnnotationInput(configuration, ActionType.EDIT, rng),
+        eventId,
+        ...input
+      }),
       validate: (eventId, input = {}) => ({
         type: ActionType.VALIDATE,
         transactionId: input.transactionId ?? getUUID(),
@@ -8517,22 +8479,25 @@ function generateActionDocument({
     ...defaults
   };
   switch (action) {
+    case ActionType.READ:
+    case ActionType.MARK_AS_NOT_DUPLICATE:
+    case ActionType.DECLARE:
+    case ActionType.UNASSIGN:
+    case ActionType.CREATE:
+    case ActionType.NOTIFY:
+    case ActionType.VALIDATE:
+    case ActionType.REGISTER:
+    case ActionType.REQUEST_CORRECTION:
+    case ActionType.EDIT:
+      return { ...actionBase, type: action };
     case ActionType.CUSTOM:
       return {
         ...actionBase,
         type: action,
         customActionType: "CUSTOM_ACTION_TYPE"
       };
-    case ActionType.READ:
-      return { ...actionBase, type: action };
-    case ActionType.MARK_AS_NOT_DUPLICATE:
-      return { ...actionBase, type: action };
     case ActionType.MARK_AS_DUPLICATE:
       return { ...actionBase, type: action, content: void 0 };
-    case ActionType.DECLARE:
-      return { ...actionBase, type: action };
-    case ActionType.UNASSIGN:
-      return { ...actionBase, type: action };
     case ActionType.ASSIGN: {
       const assignActionDefaults = defaults;
       return {
@@ -8541,16 +8506,10 @@ function generateActionDocument({
         type: action
       };
     }
-    case ActionType.VALIDATE:
-      return { ...actionBase, type: action };
     case ActionType.ARCHIVE:
       return { ...actionBase, type: action, content: { reason: "Archive" } };
     case ActionType.REJECT:
       return { ...actionBase, type: action, content: { reason: "Reject" } };
-    case ActionType.CREATE:
-      return { ...actionBase, type: action };
-    case ActionType.NOTIFY:
-      return { ...actionBase, type: action };
     case ActionType.PRINT_CERTIFICATE: {
       const printActionDefaults = defaults;
       return {
@@ -8559,8 +8518,6 @@ function generateActionDocument({
         content: printActionDefaults?.content
       };
     }
-    case ActionType.REQUEST_CORRECTION:
-      return { ...actionBase, type: action };
     case ActionType.APPROVE_CORRECTION:
       return { ...actionBase, requestId: getUUID(), type: action };
     case ActionType.REJECT_CORRECTION:
@@ -8570,11 +8527,6 @@ function generateActionDocument({
         type: action,
         content: { reason: "Correction rejection" }
       };
-    case ActionType.REGISTER:
-      return {
-        ...actionBase,
-        type: action
-      };
     case ActionType.DUPLICATE_DETECTED: {
       const duplicateActionDefaults = defaults;
       return {
@@ -8800,6 +8752,7 @@ var ACTION_SCOPE_MAP = {
     "record.declared.validate",
     "record.register"
   ],
+  [ActionType.EDIT]: ["record.declared.edit"],
   [ActionType.DELETE]: ["record.declare"],
   [ActionType.VALIDATE]: ["record.declared.validate", "record.register"],
   [ActionType.REGISTER]: ["record.register"],
@@ -8940,7 +8893,8 @@ var AVAILABLE_ACTIONS_BY_EVENT_STATUS = {
     ActionType.MARK_AS_DUPLICATE,
     ActionType.ARCHIVE,
     ActionType.REJECT,
-    ActionType.CUSTOM
+    ActionType.CUSTOM,
+    ActionType.EDIT
   ],
   [EventStatus.enum.REGISTERED]: [
     ActionType.READ,
@@ -8966,6 +8920,7 @@ var ACTION_FILTERS = {
   [ActionType.REJECT_CORRECTION]: (flags) => flags.includes(InherentFlags.CORRECTION_REQUESTED) && !flags.some((flag2) => flag2.endsWith(":requested")),
   [ActionType.MARK_AS_DUPLICATE]: (flags) => flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
   [ActionType.VALIDATE]: (flags) => !flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
+  [ActionType.EDIT]: (flags) => !flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
   [ActionType.REGISTER]: (flags) => !flags.includes(InherentFlags.POTENTIAL_DUPLICATE) && !flags.some((flag2) => flag2.endsWith(":requested")),
   [ActionType.REJECT]: (flags) => !flags.includes(InherentFlags.REJECTED) && !flags.some((flag2) => flag2.endsWith(":requested")),
   [ActionType.ARCHIVE]: (flags) => !flags.some((flag2) => flag2.endsWith(":requested"))
@@ -8994,6 +8949,9 @@ function getAvailableActionsWithoutFlagFilters(status2, flags) {
           flags.filter((flag2) => flag2 !== InherentFlags.REJECTED)
         ).filter((action) => action !== ActionType.DELETE).concat(ActionType.ARCHIVE);
       }
+      if (flags.includes(InherentFlags.EDIT_IN_PROGRESS)) {
+        return [ActionType.DECLARE, ActionType.REGISTER];
+      }
       return AVAILABLE_ACTIONS_BY_EVENT_STATUS[status2];
     }
     case EventStatus.enum.REGISTERED: {