@opencrvs/toolkit 1.8.0-rc.ffe8c17 → 1.8.1-rc.020858b

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

@@ -1,39 +1,39 @@
-import { ActionDocument } from './ActionDocument';
-import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
+import { UUID } from '../uuid';
+import { ActionDocument, EventState } from './ActionDocument';
+import { ApproveCorrectionActionInput, ArchiveActionInput, AssignActionInput, DeclareActionInput, NotifyActionInput, RegisterActionInput, RejectCorrectionActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
 import { Draft } from './Draft';
 import { EventConfig } from './EventConfig';
 import { EventDocument } from './EventDocument';
 import { EventIndex } from './EventIndex';
 import { EventInput } from './EventInput';
+import { TranslationConfig } from './TranslationConfig';
+import { FieldConfig } from './FieldConfig';
+import { WorkqueueConfig } from './WorkqueueConfig';
 import { FieldValue } from './FieldValue';
-export declare function generateActionInput(configuration: EventConfig, action: ActionType): import("lodash").Dictionary<string | number | boolean | {
-    type: string;
-    filename: string;
-    originalFilename: string;
-} | {
-    country: string;
-    district: string;
-    province: string;
-    urbanOrRural: "URBAN";
-    number?: string | undefined;
-    town?: string | undefined;
-    residentialArea?: string | undefined;
-    street?: string | undefined;
-    zipCode?: string | undefined;
-} | {
-    country: string;
-    district: string;
-    province: string;
-    urbanOrRural: "RURAL";
-    village?: string | undefined;
-} | {
-    type: string;
-    option: string;
-    filename: string;
-    originalFilename: string;
-}[]>;
-export declare const eventPayloadGenerator: {
+import { z } from 'zod';
+/**
+ * IANA timezone used in testing. Used for queries that expect similar results independent of the users location (e.g. when event was registered.)
+ * Since we query by range, providing UTC offset will result to different results when DST changes during the range.
+ */
+export declare const TEST_SYSTEM_IANA_TIMEZONE = "Asia/Dhaka";
+/**
+ * In real application, the roles are defined in the countryconfig.
+ * These are just for testing purposes to generate realistic mock data.
+ */
+export declare const TestUserRole: z.ZodEnum<["FIELD_AGENT", "LOCAL_REGISTRAR", "LOCAL_SYSTEM_ADMIN", "NATIONAL_REGISTRAR", "REGISTRATION_AGENT"]>;
+export type TestUserRole = z.infer<typeof TestUserRole>;
+export declare function generateRandomName(rng: () => number): {
+    firstname: string;
+    surname: string;
+};
+/**
+ * Quick-and-dirty mock data generator for event actions.
+ */
+export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number, rng: () => number): FieldValue;
+export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType, rng: () => number): EventState;
+export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType, rng: () => number): {};
+export declare function eventPayloadGenerator(rng: () => number): {
     create: (input?: Partial<EventInput>) => {
         transactionId: string;
         type: string;
@@ -43,41 +43,22 @@ export declare const eventPayloadGenerator: {
         type: string;
         id: string;
     };
-    draft: (eventId: string, input?: Partial<Draft>) => {
-        id: import("../uuid").UUID;
-        eventId: string;
-        createdAt: string;
-        transactionId: import("../uuid").UUID;
-        action: {
-            type: "REQUEST_CORRECTION";
-            data: {
-                'applicant.firstname': string;
-                'applicant.surname': string;
-                'applicant.dob': string;
-                'recommender.none': boolean;
-            };
-            metadata: {
-                'correction.requester.relationship': string;
-                'correction.request.reason': string;
-            };
-            createdAt: string;
-            createdBy: string;
-            createdAtLocation: string;
-        };
-    } & Partial<{
-        id: string;
-        createdAt: string;
-        eventId: string;
-        transactionId: string;
-        action: {
-            type: ActionType;
-            data: Record<string, string | number | boolean | {
+    draft: ({ eventId, actionType, annotation }: {
+        eventId: UUID;
+        actionType: ActionType;
+        annotation?: Record<string, any>;
+    }, input?: Partial<Draft>) => Draft;
+    actions: {
+        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+            transactionId: string;
+            declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "URBAN";
                 number?: string | null | undefined;
@@ -85,60 +66,55 @@ export declare const eventPayloadGenerator: {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "RURAL";
                 village?: string | null | undefined;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[]>;
-            createdAt: string;
-            createdBy: string;
-            createdAtLocation: string;
-            metadata?: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
             } | {
                 country: string;
-                district: string;
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: string | null | undefined;
+                state: string;
+                addressType: "INTERNATIONAL";
+                district2: string;
+                cityOrTown?: string | null | undefined;
+                addressLine1?: string | null | undefined;
+                addressLine2?: string | null | undefined;
+                addressLine3?: string | null | undefined;
+                postcodeOrZip?: string | null | undefined;
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[]> | undefined;
-        };
-    }>;
-    actions: {
-        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "data">>) => {
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
             type: "DECLARE";
+            eventId: string;
+        };
+        /**
+         * Notify allows sending incomplete data. Think it as 'partial declare' for now.
+         */
+        notify: (eventId: string, input?: Partial<Pick<NotifyActionInput, "transactionId" | "declaration" | "keepAssignment">>) => {
+            type: "NOTIFY";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "URBAN";
                 number?: string | null | undefined;
@@ -146,30 +122,49 @@ export declare const eventPayloadGenerator: {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "RURAL";
                 village?: string | null | undefined;
+            } | {
+                country: string;
+                state: string;
+                addressType: "INTERNATIONAL";
+                district2: string;
+                cityOrTown?: string | null | undefined;
+                addressLine1?: string | null | undefined;
+                addressLine2?: string | null | undefined;
+                addressLine3?: string | null | undefined;
+                postcodeOrZip?: string | null | undefined;
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[]>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             eventId: string;
+            keepAssignment: boolean | undefined;
         };
-        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "data">>) => {
-            type: "VALIDATE";
+        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "URBAN";
                 number?: string | null | undefined;
@@ -177,31 +172,66 @@ export declare const eventPayloadGenerator: {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "RURAL";
                 village?: string | null | undefined;
+            } | {
+                country: string;
+                state: string;
+                addressType: "INTERNATIONAL";
+                district2: string;
+                cityOrTown?: string | null | undefined;
+                addressLine1?: string | null | undefined;
+                addressLine2?: string | null | undefined;
+                addressLine3?: string | null | undefined;
+                postcodeOrZip?: string | null | undefined;
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[]>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "VALIDATE";
             duplicates: never[];
             eventId: string;
         };
-        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
-            type: "ARCHIVE";
+        assign: (eventId: string, input?: Partial<Pick<AssignActionInput, "transactionId" | "assignedTo">>) => {
+            type: "ASSIGN";
+            transactionId: string;
+            declaration: {};
+            assignedTo: string;
+            eventId: string;
+        };
+        unassign: (eventId: string, input?: Partial<Pick<UnassignActionInput, "transactionId">>) => {
+            type: "UNASSIGN";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: {};
+            assignedTo: null;
+            eventId: string;
+        };
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration" | "keepAssignment">>, isDuplicate?: boolean) => {
+            transactionId: string;
+            declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "URBAN";
                 number?: string | null | undefined;
@@ -209,66 +239,68 @@ export declare const eventPayloadGenerator: {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "RURAL";
                 village?: string | null | undefined;
+            } | {
+                country: string;
+                state: string;
+                addressType: "INTERNATIONAL";
+                district2: string;
+                cityOrTown?: string | null | undefined;
+                addressLine1?: string | null | undefined;
+                addressLine2?: string | null | undefined;
+                addressLine3?: string | null | undefined;
+                postcodeOrZip?: string | null | undefined;
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[]>;
-            metadata: {
-                isDuplicate: boolean;
-            };
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
+            keepAssignment?: boolean | undefined;
+            type: "ARCHIVE";
+            annotation: {};
             duplicates: never[];
             eventId: string;
+            reason: {
+                message: string;
+                isDuplicate: boolean;
+            };
         };
-        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "data">>) => {
-            type: "REJECT";
+        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
             transactionId: string;
-            data: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: string | null | undefined;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[]>;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "REJECT";
+            declaration: {};
             duplicates: never[];
             eventId: string;
+            reason: {
+                message: string;
+            };
         };
-        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data">>) => {
-            type: "REGISTER";
+        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment" | "registrationNumber">>) => {
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "URBAN";
                 number?: string | null | undefined;
@@ -276,62 +308,62 @@ export declare const eventPayloadGenerator: {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
+                addressType: "DOMESTIC";
                 province: string;
                 urbanOrRural: "RURAL";
                 village?: string | null | undefined;
+            } | {
+                country: string;
+                state: string;
+                addressType: "INTERNATIONAL";
+                district2: string;
+                cityOrTown?: string | null | undefined;
+                addressLine1?: string | null | undefined;
+                addressLine2?: string | null | undefined;
+                addressLine3?: string | null | undefined;
+                postcodeOrZip?: string | null | undefined;
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[]>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
+            annotation: {};
+            registrationNumber?: string | undefined;
+            keepAssignment?: boolean | undefined;
+            type: "REGISTER";
             eventId: string;
         };
-        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data">>) => {
-            type: "PRINT_CERTIFICATE";
+        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
             transactionId: string;
-            data: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: string | null | undefined;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[]>;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "PRINT_CERTIFICATE";
+            declaration: {};
             eventId: string;
         };
         correction: {
-            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
                 type: "REQUEST_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
+                declaration: Record<string, string | number | boolean | {
                     type: string;
-                    filename: string;
+                    path: string;
                     originalFilename: string;
                 } | {
                     country: string;
                     district: string;
+                    addressType: "DOMESTIC";
                     province: string;
                     urbanOrRural: "URBAN";
                     number?: string | null | undefined;
@@ -339,97 +371,112 @@ export declare const eventPayloadGenerator: {
                     residentialArea?: string | null | undefined;
                     street?: string | null | undefined;
                     zipCode?: string | null | undefined;
+                } | {
+                    firstname: string;
+                    surname: string;
+                    middlename?: string | null | undefined;
                 } | {
                     country: string;
                     district: string;
+                    addressType: "DOMESTIC";
                     province: string;
                     urbanOrRural: "RURAL";
                     village?: string | null | undefined;
+                } | {
+                    country: string;
+                    state: string;
+                    addressType: "INTERNATIONAL";
+                    district2: string;
+                    cityOrTown?: string | null | undefined;
+                    addressLine1?: string | null | undefined;
+                    addressLine2?: string | null | undefined;
+                    addressLine3?: string | null | undefined;
+                    postcodeOrZip?: string | null | undefined;
                 } | {
                     type: string;
                     option: string;
-                    filename: string;
+                    path: string;
                     originalFilename: string;
-                }[]>;
-                metadata: {};
+                }[] | {
+                    start: string;
+                    end: string;
+                } | null | undefined>;
+                annotation: {};
                 eventId: string;
+                keepAssignment: boolean | undefined;
             };
-            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            approve: (eventId: string, requestId: string, input?: Partial<Pick<ApproveCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
                 type: "APPROVE_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
-                    type: string;
-                    filename: string;
-                    originalFilename: string;
-                } | {
-                    country: string;
-                    district: string;
-                    province: string;
-                    urbanOrRural: "URBAN";
-                    number?: string | null | undefined;
-                    town?: string | null | undefined;
-                    residentialArea?: string | null | undefined;
-                    street?: string | null | undefined;
-                    zipCode?: string | null | undefined;
-                } | {
-                    country: string;
-                    district: string;
-                    province: string;
-                    urbanOrRural: "RURAL";
-                    village?: string | null | undefined;
-                } | {
-                    type: string;
-                    option: string;
-                    filename: string;
-                    originalFilename: string;
-                }[]>;
+                declaration: {};
+                annotation: {};
                 eventId: string;
                 requestId: string;
+                keepAssignment: boolean | undefined;
             };
-            reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            reject: (eventId: string, requestId: string, input: Partial<Pick<RejectCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment" | "reason">>) => {
                 type: "REJECT_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
-                    type: string;
-                    filename: string;
-                    originalFilename: string;
-                } | {
-                    country: string;
-                    district: string;
-                    province: string;
-                    urbanOrRural: "URBAN";
-                    number?: string | null | undefined;
-                    town?: string | null | undefined;
-                    residentialArea?: string | null | undefined;
-                    street?: string | null | undefined;
-                    zipCode?: string | null | undefined;
-                } | {
-                    country: string;
-                    district: string;
-                    province: string;
-                    urbanOrRural: "RURAL";
-                    village?: string | null | undefined;
-                } | {
-                    type: string;
-                    option: string;
-                    filename: string;
-                    originalFilename: string;
-                }[]>;
+                declaration: {};
+                annotation: {};
                 eventId: string;
                 requestId: string;
+                keepAssignment: boolean | undefined;
+                reason: {
+                    message: string;
+                    isDuplicate?: boolean | undefined;
+                };
             };
         };
     };
 };
-export declare function generateActionDocument({ configuration, action, defaults }: {
+export declare function generateActionDocument({ configuration, action, rng, defaults, user }: {
     configuration: EventConfig;
     action: ActionType;
+    rng?: () => number;
     defaults?: Partial<ActionDocument>;
+    user?: Partial<{
+        signature: string;
+        primaryOfficeId: UUID;
+        role: TestUserRole;
+        id: string;
+    }>;
 }): ActionDocument;
-export declare function generateEventDocument({ configuration, actions }: {
+export declare function generateEventDocument({ configuration, actions, rng, user }: {
     configuration: EventConfig;
     actions: ActionType[];
+    rng?: () => number;
+    user?: Partial<{
+        signature: string;
+        primaryOfficeId: UUID;
+        role: TestUserRole;
+        id: string;
+    }>;
 }): EventDocument;
-export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, data?: Record<string, FieldValue>): Draft;
-export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>) => EventIndex;
+export declare function generateEventDraftDocument({ eventId, actionType, rng, declaration }: {
+    eventId: UUID;
+    actionType: ActionType;
+    rng?: () => number;
+    declaration?: EventState;
+}): Draft;
+export declare function getRandomDatetime(rng: () => number, start: Date, end: Date): string;
+export declare function getRandomDate(rng: () => number, start: string, end: string): string;
+/**
+ * Useful for testing when we need deterministic outcome.
+ * @param seed - Seed value for the pseudo-random number generator
+ *
+ * @returns A function that generates pseudo-random numbers between 0 and 1 [0, 1)
+ */
+export declare function createPrng(seed: number): () => number;
+export declare function generateUuid(rng?: () => number): UUID;
+export declare function generateRegistrationNumber(rng: () => number): string;
+export declare function generateRandomSignature(rng: () => number): string;
+export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>, seed?: number) => EventIndex;
+export declare const generateTranslationConfig: (message: string) => TranslationConfig;
+export declare const BearerTokenByUserType: {
+    fieldAgent: string;
+    registrationAgent: string;
+    localRegistrar: string;
+};
+export declare const generateWorkqueues: (slug?: string) => WorkqueueConfig[];
 //# sourceMappingURL=test.utils.d.ts.map