@ecrvs/opencrvs-toolkit 1.8.1-rc.11dbd54

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

@@ -0,0 +1,473 @@
+import { UUID } from '../uuid';
+import { ActionDocument, EventState } from './ActionDocument';
+import { ApproveCorrectionActionInput, ArchiveActionInput, AssignActionInput, DeclareActionInput, MarkAsDuplicateActionInput, MarkNotDuplicateActionInput, 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';
+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;
+};
+export declare function generateUuid(rng?: () => number): UUID;
+export declare function generateTrackingId(rng: () => number): string;
+export declare function generateRegistrationNumber(rng: () => number): string;
+export declare function generateRandomSignature(rng: () => number): 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, overrides?: Partial<EventState>): EventState;
+export declare function generateActionDuplicateDeclarationInput(...args: Parameters<typeof generateActionDeclarationInput>): ReturnType<typeof generateActionDeclarationInput>;
+export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType, rng: () => number): {};
+export declare function eventPayloadGenerator(rng: () => number, configuration?: EventConfig): {
+    create: (input?: Partial<EventInput>) => {
+        transactionId: string;
+        type: string;
+    };
+    patch: (id: string, input?: Partial<EventInput>) => {
+        transactionId: string;
+        type: string;
+        id: string;
+    };
+    draft: ({ eventId, actionType, annotation, omitFields }: {
+        eventId: UUID;
+        actionType: Draft["action"]["type"];
+        annotation?: Record<string, any>;
+        omitFields?: string[];
+    }, 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;
+                path: string;
+                originalFilename: string;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
+            } | Record<string, string> | {
+                country: string;
+                addressType: "DOMESTIC" | "INTERNATIONAL";
+                administrativeArea?: string | null | undefined;
+                streetLevelDetails?: Record<string, string> | null | undefined;
+            } | {
+                type: string;
+                option: string;
+                path: string;
+                originalFilename: string;
+            }[] | {
+                data?: any;
+                error?: {
+                    message: string;
+                    statusCode: number;
+                } | null | undefined;
+                loading?: boolean | null | undefined;
+            } | {
+                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;
+            declaration: Record<string, string | number | boolean | {
+                type: string;
+                path: string;
+                originalFilename: string;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
+            } | Record<string, string> | {
+                country: string;
+                addressType: "DOMESTIC" | "INTERNATIONAL";
+                administrativeArea?: string | null | undefined;
+                streetLevelDetails?: Record<string, string> | null | undefined;
+            } | {
+                type: string;
+                option: string;
+                path: string;
+                originalFilename: string;
+            }[] | {
+                data?: any;
+                error?: {
+                    message: string;
+                    statusCode: number;
+                } | null | undefined;
+                loading?: boolean | null | undefined;
+            } | {
+                start: string;
+                end: string;
+            } | null | undefined>;
+            eventId: string;
+            keepAssignment: boolean | undefined;
+        };
+        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+            transactionId: string;
+            declaration: Record<string, string | number | boolean | {
+                type: string;
+                path: string;
+                originalFilename: string;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
+            } | Record<string, string> | {
+                country: string;
+                addressType: "DOMESTIC" | "INTERNATIONAL";
+                administrativeArea?: string | null | undefined;
+                streetLevelDetails?: Record<string, string> | null | undefined;
+            } | {
+                type: string;
+                option: string;
+                path: string;
+                originalFilename: string;
+            }[] | {
+                data?: any;
+                error?: {
+                    message: string;
+                    statusCode: number;
+                } | null | undefined;
+                loading?: boolean | null | undefined;
+            } | {
+                start: string;
+                end: string;
+            } | null | undefined>;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "VALIDATE";
+            duplicates: never[];
+            eventId: string;
+        };
+        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;
+            declaration: {};
+            assignedTo: null;
+            eventId: string;
+        };
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration" | "keepAssignment">>) => {
+            transactionId: string;
+            declaration: Record<string, string | number | boolean | {
+                type: string;
+                path: string;
+                originalFilename: string;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
+            } | Record<string, string> | {
+                country: string;
+                addressType: "DOMESTIC" | "INTERNATIONAL";
+                administrativeArea?: string | null | undefined;
+                streetLevelDetails?: Record<string, string> | null | undefined;
+            } | {
+                type: string;
+                option: string;
+                path: string;
+                originalFilename: string;
+            }[] | {
+                data?: any;
+                error?: {
+                    message: string;
+                    statusCode: number;
+                } | null | undefined;
+                loading?: boolean | null | undefined;
+            } | {
+                start: string;
+                end: string;
+            } | null | undefined>;
+            keepAssignment?: boolean | undefined;
+            type: "ARCHIVE";
+            annotation: {};
+            duplicates: never[];
+            eventId: string;
+            content: {
+                reason: string;
+            };
+        };
+        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
+            transactionId: string;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "REJECT";
+            declaration: {};
+            duplicates: never[];
+            eventId: string;
+            content: {
+                reason: string;
+            };
+        };
+        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment" | "registrationNumber">>) => {
+            transactionId: string;
+            declaration: Record<string, string | number | boolean | {
+                type: string;
+                path: string;
+                originalFilename: string;
+            } | {
+                firstname: string;
+                surname: string;
+                middlename?: string | null | undefined;
+            } | Record<string, string> | {
+                country: string;
+                addressType: "DOMESTIC" | "INTERNATIONAL";
+                administrativeArea?: string | null | undefined;
+                streetLevelDetails?: Record<string, string> | null | undefined;
+            } | {
+                type: string;
+                option: string;
+                path: string;
+                originalFilename: string;
+            }[] | {
+                data?: any;
+                error?: {
+                    message: string;
+                    statusCode: number;
+                } | null | undefined;
+                loading?: boolean | null | undefined;
+            } | {
+                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" | "annotation" | "keepAssignment">>) => {
+            transactionId: string;
+            annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "PRINT_CERTIFICATE";
+            declaration: {};
+            eventId: string;
+        };
+        correction: {
+            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+                type: "REQUEST_CORRECTION";
+                transactionId: string;
+                declaration: Record<string, string | number | boolean | {
+                    type: string;
+                    path: string;
+                    originalFilename: string;
+                } | {
+                    firstname: string;
+                    surname: string;
+                    middlename?: string | null | undefined;
+                } | Record<string, string> | {
+                    country: string;
+                    addressType: "DOMESTIC" | "INTERNATIONAL";
+                    administrativeArea?: string | null | undefined;
+                    streetLevelDetails?: Record<string, string> | null | undefined;
+                } | {
+                    type: string;
+                    option: string;
+                    path: string;
+                    originalFilename: string;
+                }[] | {
+                    data?: any;
+                    error?: {
+                        message: string;
+                        statusCode: number;
+                    } | null | undefined;
+                    loading?: boolean | null | undefined;
+                } | {
+                    start: string;
+                    end: string;
+                } | null | undefined>;
+                annotation: {};
+                eventId: string;
+                keepAssignment: boolean | undefined;
+            };
+            approve: (eventId: string, requestId: string, input?: Partial<Pick<ApproveCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
+                type: "APPROVE_CORRECTION";
+                transactionId: string;
+                declaration: {};
+                annotation: {};
+                eventId: string;
+                requestId: string;
+                keepAssignment: boolean | undefined;
+            };
+            reject: (eventId: string, requestId: string, input: Partial<Pick<RejectCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment" | "content">>) => {
+                type: "REJECT_CORRECTION";
+                transactionId: string;
+                declaration: {};
+                annotation: {};
+                eventId: string;
+                requestId: string;
+                keepAssignment: boolean | undefined;
+                content: {
+                    reason: string;
+                };
+            };
+        };
+        duplicate: {
+            markAsDuplicate: (eventId: string, input?: Partial<Pick<MarkAsDuplicateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+                type: "MARK_AS_DUPLICATE";
+                transactionId: string;
+                declaration: Record<string, string | number | boolean | {
+                    type: string;
+                    path: string;
+                    originalFilename: string;
+                } | {
+                    firstname: string;
+                    surname: string;
+                    middlename?: string | null | undefined;
+                } | Record<string, string> | {
+                    country: string;
+                    addressType: "DOMESTIC" | "INTERNATIONAL";
+                    administrativeArea?: string | null | undefined;
+                    streetLevelDetails?: Record<string, string> | null | undefined;
+                } | {
+                    type: string;
+                    option: string;
+                    path: string;
+                    originalFilename: string;
+                }[] | {
+                    data?: any;
+                    error?: {
+                        message: string;
+                        statusCode: number;
+                    } | null | undefined;
+                    loading?: boolean | null | undefined;
+                } | {
+                    start: string;
+                    end: string;
+                } | null | undefined>;
+                annotation: {};
+                eventId: string;
+                keepAssignment: boolean | undefined;
+            };
+            markNotDuplicate: (eventId: string, input?: Partial<Pick<MarkNotDuplicateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+                type: "MARK_AS_NOT_DUPLICATE";
+                transactionId: string;
+                declaration: Record<string, string | number | boolean | {
+                    type: string;
+                    path: string;
+                    originalFilename: string;
+                } | {
+                    firstname: string;
+                    surname: string;
+                    middlename?: string | null | undefined;
+                } | Record<string, string> | {
+                    country: string;
+                    addressType: "DOMESTIC" | "INTERNATIONAL";
+                    administrativeArea?: string | null | undefined;
+                    streetLevelDetails?: Record<string, string> | null | undefined;
+                } | {
+                    type: string;
+                    option: string;
+                    path: string;
+                    originalFilename: string;
+                }[] | {
+                    data?: any;
+                    error?: {
+                        message: string;
+                        statusCode: number;
+                    } | null | undefined;
+                    loading?: boolean | null | undefined;
+                } | {
+                    start: string;
+                    end: string;
+                } | null | undefined>;
+                annotation: {};
+                eventId: string;
+                keepAssignment: boolean | undefined;
+            };
+        };
+    };
+};
+export declare function generateActionDocument<T extends ActionType>({ configuration, action, rng, defaults, declarationOverrides }: {
+    configuration: EventConfig;
+    action: T;
+    rng?: () => number;
+    defaults?: Partial<Extract<ActionDocument, {
+        type: T;
+    }>>;
+    declarationOverrides?: Partial<EventState>;
+}): ActionDocument;
+export declare function generateEventDocument({ configuration, actions, rng, user, declarationOverrides }: {
+    configuration: EventConfig;
+    actions: ActionType[];
+    rng?: () => number;
+    user?: Partial<{
+        signature: string;
+        primaryOfficeId: UUID;
+        role: TestUserRole;
+        id: string;
+    }>;
+    /**
+     * Overrides for default event state
+     */
+    declarationOverrides?: Partial<EventState>;
+}): EventDocument;
+export declare function generateEventDraftDocument({ eventId, actionType, rng, declaration }: {
+    eventId: UUID;
+    actionType: ActionType;
+    rng?: () => number;
+    declaration?: EventState;
+    annotation?: 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;
+/**
+ * @param overrides - Partial EventIndex object to override the default values.
+ * @param seed - Seed value for the pseudo-random number generator.
+ * @returns A mock EventIndex object with default values for tennis club
+ * membership events.
+ *
+ * N.B. Unless a different seed is provided, the generated values will be
+ * consistent across calls.
+ *
+ */
+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

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

@@ -0,0 +1,2 @@
+export declare function generateTransactionId(): string & import("zod").BRAND<"UUID">;
+//# sourceMappingURL=transactions.d.ts.map