@opencrvs/toolkit 2.0.0-rc.ff04b30 → 2.0.0-rc.ff1424b

package/dist/commons/events/FieldType.d.ts

@@ -75,4 +75,5 @@ export type FieldType = (typeof fieldTypes)[number];
  */
 export declare const compositeFieldTypes: ("NAME" | "ADDRESS" | "DATE_RANGE" | "FILE" | "FILE_WITH_OPTIONS" | "DATA" | "ID_READER")[];
 export declare const FieldTypesToHideInReview: ("IMAGE_VIEW" | "PARAGRAPH" | "PAGE_HEADER" | "BULLET_LIST" | "DIVIDER" | "DATA" | "ALPHA_PRINT_BUTTON" | "HTTP" | "QUERY_PARAM_READER" | "ID_READER" | "LOADER" | "ALPHA_HIDDEN")[];
+export declare const HiddenFieldTypes: ("HTTP" | "QUERY_PARAM_READER" | "ALPHA_HIDDEN")[];
 //# sourceMappingURL=FieldType.d.ts.map

package/dist/commons/events/FieldTypeMapping.d.ts

@@ -690,7 +690,7 @@ export declare const isHiddenFieldType: (field: {
     value: undefined;
     config: HiddenField;
 };
-export type NonInteractiveFieldType = Divider | PageHeader | ImageViewField | Paragraph | Heading | BulletList | DataField | AlphaPrintButton | HttpField | LinkButtonField | QueryParamReaderField | LoaderField | AutocompleteField;
+export type NonInteractiveFieldType = Divider | PageHeader | ImageViewField | Paragraph | Heading | BulletList | DataField | AlphaPrintButton | LinkButtonField | LoaderField | AutocompleteField;
 export type InteractiveFieldType = Exclude<FieldConfig, NonInteractiveFieldType>;
 export declare const isNonInteractiveFieldType: (field: FieldConfig) => field is NonInteractiveFieldType;
 export {};

package/dist/commons/events/FieldValue.d.ts

@@ -58,6 +58,12 @@ export declare const CheckboxFieldValue: z.ZodBoolean;
 export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
 export declare const NumberFieldValue: z.ZodNumber;
 export type NumberFieldValue = z.infer<typeof NumberFieldValue>;
+export declare const SignatureFieldValue: z.ZodObject<{
+    path: z.core.$ZodBranded<z.ZodString, "DocumentPath", "out">;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+}, z.core.$strip>;
+export type SignatureFieldValue = z.infer<typeof SignatureFieldValue>;
 export declare const ButtonFieldValue: z.ZodNumber;
 export type ButtonFieldValue = z.infer<typeof ButtonFieldValue>;
 export declare const VerificationStatusValue: z.ZodEnum<{

package/dist/commons/events/WorkqueueConfig.d.ts

@@ -677,6 +677,7 @@ export declare const WorkqueueConfig: z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>>>;
     icon: z.ZodEnum<{
+        File: "File";
         Archived: "Archived";
         Assigned: "Assigned";
         Briefcase: "Briefcase";
@@ -722,7 +723,6 @@ export declare const WorkqueueConfig: z.ZodObject<{
         Eye: "Eye";
         EyeSlash: "EyeSlash";
         Envelope: "Envelope";
-        File: "File";
         FileSearch: "FileSearch";
         FileMinus: "FileMinus";
         FilePlus: "FilePlus";
@@ -786,6 +786,7 @@ export declare const WorkqueueConfig: z.ZodObject<{
 export declare const WorkqueueConfigWithoutQuery: z.ZodObject<{
     name: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, z.core.$strip>;
     icon: z.ZodEnum<{
+        File: "File";
         Archived: "Archived";
         Assigned: "Assigned";
         Briefcase: "Briefcase";
@@ -831,7 +832,6 @@ export declare const WorkqueueConfigWithoutQuery: z.ZodObject<{
         Eye: "Eye";
         EyeSlash: "EyeSlash";
         Envelope: "Envelope";
-        File: "File";
         FileSearch: "FileSearch";
         FileMinus: "FileMinus";
         FilePlus: "FilePlus";
@@ -951,6 +951,7 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>>>;
     icon: z.ZodEnum<{
+        File: "File";
         Archived: "Archived";
         Assigned: "Assigned";
         Briefcase: "Briefcase";
@@ -996,7 +997,6 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
         Eye: "Eye";
         EyeSlash: "EyeSlash";
         Envelope: "Envelope";
-        File: "File";
         FileSearch: "FileSearch";
         FileMinus: "FileMinus";
         FilePlus: "FilePlus";
@@ -2282,7 +2282,7 @@ export declare function defineWorkqueue(workqueueInput: WorkqueueConfigInput): {
             $event: "id" | "title" | "type" | "updatedAt" | "placeOfEvent" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "status" | "assignedTo" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
         };
     }[];
-    icon: "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "File" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
+    icon: "File" | "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
     action?: {
         type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
     } | undefined;
@@ -2591,7 +2591,7 @@ export declare function defineWorkqueues(workqueues: WorkqueueConfigInputWithV19
             $event: "id" | "title" | "type" | "updatedAt" | "placeOfEvent" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "status" | "assignedTo" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
         };
     }[];
-    icon: "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "File" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
+    icon: "File" | "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
     action?: {
         type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
     } | undefined;

package/dist/commons/events/field.d.ts

@@ -1,6 +1,31 @@
+import { FormConditionalParameters } from '../conditionals/conditionals';
 import { FieldConditional } from './Conditional';
 import { TranslationConfig } from './TranslationConfig';
-import { SelectOption, ValidationConfig } from './FieldConfig';
+import { JurisdictionReference } from '../users/userReferences';
+import { ComputedDefaultValue, SelectOption, ValidationConfig } from './FieldConfig';
+/**
+ * Creates a {@link ComputedDefaultValue} descriptor for use in a field's `defaultValue`.
+ *
+ * Unlike `field(id).customClientEvaluation(fn)`, this builder is **not tied to any
+ * specific field**. Use it when the initial value should be derived purely from
+ * context variables (`$now`, `$online`, system variables such as `$user`) rather
+ * than from another field's current value.
+ *
+ * The serialised function receives `(undefined, context)` at runtime, where
+ * `context` is a {@link FormConditionalParameters} object.
+ *
+ * External references (e.g. lodash) are **not** available inside the function body —
+ * all logic must be self-contained so the code survives serialisation.
+ *
+ * @example
+ * // Default a date field to today
+ * defaultValue: evaluate((_, ctx) => ctx.$now)
+ *
+ * @example
+ * // Default to the current user's role
+ * defaultValue: evaluate((_, ctx) => ctx.user.role)
+ */
+export declare function evaluate(computationFn: (fieldValue: undefined, context: FormConditionalParameters) => unknown): ComputedDefaultValue;
 /**
  * Entry point for defining conditional logic or configuration for a form field.
  * @param fieldId - The ID of the field to define rules or config for.
@@ -11,12 +36,14 @@ export declare function field(fieldId: string, options?: {
     conditionals?: FieldConditional[];
     validations?: ValidationConfig[];
     searchCriteriaLabelPrefix?: TranslationConfig;
+    allowedLocations?: JurisdictionReference;
 }): {
     range: () => {
         options?: SelectOption[];
         conditionals?: FieldConditional[];
         validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
+        allowedLocations?: JurisdictionReference;
         fieldId: string;
         fieldType: "field";
     } & {
@@ -29,6 +56,7 @@ export declare function field(fieldId: string, options?: {
         conditionals?: FieldConditional[];
         validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
+        allowedLocations?: JurisdictionReference;
         fieldId: string;
         fieldType: "field";
     } & {
@@ -41,6 +69,7 @@ export declare function field(fieldId: string, options?: {
         conditionals?: FieldConditional[];
         validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
+        allowedLocations?: JurisdictionReference;
         fieldId: string;
         fieldType: "field";
     } & {
@@ -53,6 +82,7 @@ export declare function field(fieldId: string, options?: {
         conditionals?: FieldConditional[];
         validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
+        allowedLocations?: JurisdictionReference;
         fieldId: string;
         fieldType: "field";
     } & {
@@ -107,6 +137,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asDob(): any;
         asAge(): any;
@@ -144,6 +176,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     getByPath(fieldPath: string[]): {
         $$subfield: string[];
@@ -189,6 +223,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         getByPath(fieldPath: string[]): any;
         asDob(): {
@@ -232,6 +268,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asAge(): {
             $$subfield: string[];
@@ -274,6 +312,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         isAfter(): {
             days: (days: number) => {
@@ -309,6 +349,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     asDob(): {
         $$subfield: string[];
@@ -355,6 +397,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asDob(): any;
         asAge(): any;
@@ -392,6 +436,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     asAge(): {
         $$subfield: string[];
@@ -438,6 +484,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asDob(): any;
         asAge(): any;
@@ -475,6 +523,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     isAfter(): {
         days: (days: number) => {
@@ -510,5 +560,7 @@ export declare function field(fieldId: string, options?: {
         fieldId: string;
     };
     object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+    customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+    customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
 };
 //# sourceMappingURL=field.d.ts.map

package/dist/commons/events/index.d.ts

@@ -22,6 +22,7 @@ export * from './FieldValue';
 export * from './FormConfig';
 export * from './CompositeFieldValue';
 export * from './state';
+export * from './state/flags';
 export * from './utils';
 export * from './defineConfig';
 export * from './DeduplicationConfig';
@@ -37,6 +38,7 @@ export * from './scopes';
 export * from './serializer';
 export * from './state/availableActions';
 export * from './FileUtils';
+export * from './mocks.test.utils';
 export * from '../conditionals/conditionals';
 export * from '../conditionals/validate';
 export * from './field';

package/dist/commons/events/state/flags.d.ts

@@ -1,6 +1,9 @@
+import { Action, RequestedCorrectionAction } from '../ActionDocument';
 import { Flag, CustomFlag } from '../Flag';
 import { EventConfig } from '../EventConfig';
 import { EventDocument } from '../EventDocument';
+export declare function findPendingCorrectionAction(writeActions: Action[]): RequestedCorrectionAction | undefined;
+export declare function isPotentialDuplicate(actions: Action[]): boolean;
 /**
  * This function resolves custom flags for an event based on its actions.
  * Flags are not stored to the event state or any database directly, instead they are always computed/evaluated from the event actions.
@@ -18,5 +21,18 @@ import { EventDocument } from '../EventDocument';
  * // Returns: ['flag-1', 'flag-3']
  */
 export declare function resolveEventCustomFlags(event: EventDocument, eventConfiguration: EventConfig): CustomFlag[];
+/**
+ * Computes all flags (inherent, action status, and custom) that should be attached to the given event,
+ * based on its actions and event-specific configuration.
+ *
+ * Flags are determined by combining:
+ *  - Action status flags (format 'ActionType:ActionStatus')
+ *  - Inherent flags (e.g. incomplete, rejected, correction requested, potential duplicate, edit in progress)
+ *  - Event type-specific custom flags defined in the event configuration
+ *
+ * @param event - The EventDocument containing the action history and payload
+ * @param config - The EventConfig providing rules for custom flag evaluation
+ * @returns An array of flags currently relevant/applicable to the event
+ */
 export declare function getEventFlags(event: EventDocument, config: EventConfig): Flag[];
 //# sourceMappingURL=flags.d.ts.map

package/dist/commons/events/state/utils.d.ts

@@ -1,279 +1,17 @@
 import { Action } from '../ActionDocument';
 /**
- * Given action type and actions, returns the action creation metadata for the event.
- * Since we do not consistently store the request action, we need to check if it exists.
- * @returns details of last user who triggered **Declaration** action.
- * @see EventIndex for the description of the returned object.
+ * Returns the creation metadata of the last update action (Requested or Accepted).
+ * Requested actions are included so that async flows (202) correctly reflect the
+ * metadata of the user who triggered the action before country config accepts it.
  *
- * */
-export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REGISTER";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    registrationNumber?: string | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "DUPLICATE_DETECTED";
-    content: {
-        duplicates: {
-            id: string & import("zod").$brand<"UUID">;
-            trackingId: string;
-        }[];
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "EDIT";
-    content: {
-        comment?: string | undefined;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "PRINT_CERTIFICATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    content?: {
-        templateId?: string | undefined;
-    } | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REQUEST_CORRECTION";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "CUSTOM";
-    customActionType: string;
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "CREATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REJECT";
-    content: {
-        reason: string;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "MARK_AS_NOT_DUPLICATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "MARK_AS_DUPLICATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    content?: {
-        duplicateOf: string & import("zod").$brand<"UUID">;
-    } | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "ARCHIVE";
-    content: {
-        reason: string;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "NOTIFY";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "DECLARE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "ASSIGN";
-    assignedTo: string;
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "APPROVE_CORRECTION";
-    requestId: string;
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REJECT_CORRECTION";
-    requestId: string;
-    content: {
-        reason: string;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "UNASSIGN";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
+ * When an Accepted action carries an originalActionId, its metadata is sourced from
+ * the original Requested action (the human who triggered it), not from the system
+ * or 3rd party that accepted it.
+ *
+ * @returns metadata of the last user who triggered a status-changing action.
+ * @see EventIndex for the description of the returned object.
+ */
+export declare function getActionUpdateMetadata(actions: Action[]): Pick<{
     id: string & import("zod").$brand<"UUID">;
     transactionId: string;
     createdByUserType: "user" | "system";
@@ -281,25 +19,12 @@ export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
     createdBy: string;
     declaration: Record<string, import("..").FieldUpdateValue>;
     status: "Requested" | "Accepted" | "Rejected";
-    type: "READ";
     createdByRole?: string | undefined;
     createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
     createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
     annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
     originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    type: "CUSTOM" | "NOTIFY" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION";
-    status: "Rejected";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-}>;
+}, "createdByUserType" | "createdAt" | "createdBy" | "createdByRole" | "createdAtLocation">;
 /**
  * @returns the legal statuses of the event. Event is considered legal if it has been accepted.
  * @see EventIndex for the description of the returned object.