@opencrvs/toolkit 1.8.0-rc.f7910f3 → 1.8.0-rc.f7aaf07

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

@@ -1,53 +1,33 @@
-import { ActionDocument } from './ActionDocument';
-import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
+import { ActionDocument, EventState } from './ActionDocument';
+import { ArchiveActionInput, AssignActionInput, DeclareActionInput, NotifyActionInput, RegisterActionInput, 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 { FieldValue } from './FieldValue';
 import { TranslationConfig } from './TranslationConfig';
-export declare function generateActionInput(configuration: EventConfig, action: ActionType): import("lodash").Dictionary<string | number | boolean | {
-    type: string;
-    filename: string;
-    originalFilename: string;
-} | {
-    country: string;
-    district: string;
-    addressType: "DOMESTIC";
-    province: string;
-    urbanOrRural: "URBAN";
-    number?: string | undefined;
-    town?: string | undefined;
-    residentialArea?: string | undefined;
-    street?: string | undefined;
-    zipCode?: string | undefined;
-} | {
-    country: string;
-    district: string;
-    addressType: "DOMESTIC";
-    province: string;
-    urbanOrRural: "RURAL";
-    village?: string | undefined;
-} | {
-    country: string;
-    state: string;
-    addressType: "INTERNATIONAL";
-    district2: string;
-    cityOrTown?: string | undefined;
-    addressLine1?: string | undefined;
-    addressLine2?: string | undefined;
-    addressLine3?: string | undefined;
-    postcodeOrZip?: string | undefined;
-} | {
-    type: string;
-    option: string;
-    filename: string;
-    originalFilename: string;
-}[] | undefined>;
-export declare function generateActionMetadataInput(configuration: EventConfig, action: ActionType): {};
-export declare const eventPayloadGenerator: {
+import { FieldConfig } from './FieldConfig';
+import { WorkqueueConfig } from './WorkqueueConfig';
+import { FieldValue } from './FieldValue';
+import { z } from 'zod';
+/**
+ * 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;
@@ -57,35 +37,14 @@ 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;
+    draft: ({ eventId, actionType }: {
         eventId: string;
-        transactionId: string;
-        action: {
-            type: ActionType;
-            data: Record<string, string | number | boolean | {
+        actionType: ActionType;
+    }, 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;
                 originalFilename: string;
@@ -101,46 +60,9 @@ export declare const eventPayloadGenerator: {
                 street?: string | null | undefined;
                 zipCode?: 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;
-                originalFilename: string;
-            }[] | undefined>;
-            createdAt: string;
-            createdBy: string;
-            createdAtLocation: string;
-            metadata?: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
@@ -163,14 +85,19 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined> | undefined;
-        };
-    }>;
-    actions: {
-        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "data">>) => {
+            }[] | [string, 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;
                 originalFilename: string;
@@ -185,6 +112,10 @@ 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;
@@ -207,13 +138,13 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
+            }[] | [string, 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;
                 originalFilename: string;
@@ -228,6 +159,10 @@ 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;
@@ -250,14 +185,30 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
+            }[] | [string, 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;
-            data: Record<string, string | number | boolean | {
+            declaration: {};
+            assignedTo: string;
+            eventId: string;
+        };
+        unassign: (eventId: string, input?: Partial<Pick<UnassignActionInput, "transactionId">>) => {
+            type: "UNASSIGN";
+            transactionId: string;
+            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;
                 originalFilename: string;
@@ -272,6 +223,10 @@ 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;
@@ -294,61 +249,32 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
-            metadata: {
-                isDuplicate: boolean;
-            };
+            }[] | [string, 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;
-                addressType: "DOMESTIC";
-                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;
-                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;
-                originalFilename: string;
-            }[] | undefined>;
+            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">>) => {
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -363,6 +289,10 @@ 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;
@@ -385,58 +315,25 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
+            }[] | [string, string] | null | undefined>;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "REGISTER";
             eventId: string;
         };
-        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data" | "metadata">>) => {
-            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;
-                addressType: "DOMESTIC";
-                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;
-                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;
-                originalFilename: string;
-            }[] | undefined>;
-            metadata: {};
+            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;
                     originalFilename: string;
@@ -451,6 +348,10 @@ 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;
@@ -473,111 +374,71 @@ export declare const eventPayloadGenerator: {
                     option: string;
                     filename: string;
                     originalFilename: string;
-                }[] | undefined>;
-                metadata: {};
+                }[] | [string, 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<RequestCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
                 type: "APPROVE_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
-                    type: string;
-                    filename: string;
-                    originalFilename: string;
-                } | {
-                    country: string;
-                    district: string;
-                    addressType: "DOMESTIC";
-                    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;
-                    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;
-                    originalFilename: string;
-                }[] | undefined>;
+                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<RequestCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
                 type: "REJECT_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
-                    type: string;
-                    filename: string;
-                    originalFilename: string;
-                } | {
-                    country: string;
-                    district: string;
-                    addressType: "DOMESTIC";
-                    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;
-                    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;
-                    originalFilename: string;
-                }[] | undefined>;
+                declaration: {};
+                annotation: {};
                 eventId: string;
                 requestId: string;
+                keepAssignment: boolean | undefined;
             };
         };
     };
 };
-export declare function generateActionDocument({ configuration, action, defaults }: {
+export declare function generateActionDocument({ configuration, action, rng, defaults }: {
     configuration: EventConfig;
     action: ActionType;
+    rng?: () => number;
     defaults?: Partial<ActionDocument>;
+    user?: Partial<{
+        signature: string;
+        primaryOfficeId: string;
+        role: TestUserRole;
+        id: string;
+    }>;
 }): ActionDocument;
-export declare function generateEventDocument({ configuration, actions }: {
+export declare function generateEventDocument({ configuration, actions, rng }: {
     configuration: EventConfig;
     actions: ActionType[];
+    rng?: () => number;
 }): 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: string;
+    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 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