@opencrvs/toolkit 1.8.1-rc.8c25e85 → 1.8.1-rc.a372970

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

@@ -1,4 +1,3 @@
-export * from './Constants';
 export * from './ActionConfig';
 export * from './offline';
 export * from './EventConfig';
@@ -7,8 +6,6 @@ export * from './FieldConfig';
 export * from './PageConfig';
 export * from './SummaryConfig';
 export * from './WorkqueueConfig';
-export * from './WorkqueueColumnConfig';
-export * from './workqueueDefaultColumns';
 export * from './Draft';
 export * from './EventMetadata';
 export * from './EventInput';
@@ -33,11 +30,6 @@ export * from './Conditional';
 export * from './AdvancedSearchConfig';
 export * from './test.utils';
 export * from './TemplateConfig';
-export * from './scopes';
-export * from './serializer';
-export * from './state/availableActions';
 export * from '../conditionals/conditionals';
 export * from '../conditionals/validate';
-export * from './field';
-export * from './event';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1,39 +1,53 @@
-import { UUID } from '../uuid';
-import { ActionDocument, EventState } from './ActionDocument';
-import { ApproveCorrectionActionInput, ArchiveActionInput, AssignActionInput, DeclareActionInput, NotifyActionInput, RegisterActionInput, RejectCorrectionActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
+import { ActionDocument, ActionUpdate } from './ActionDocument';
+import { ArchiveActionInput, AssignActionInput, DeclareActionInput, 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 { 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;
-};
-/**
- * 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): {
+import { TranslationConfig } from './TranslationConfig';
+export declare function generateActionDeclarationInput(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 generateActionAnnotationInput(configuration: EventConfig, action: ActionType): {};
+export declare const eventPayloadGenerator: {
     create: (input?: Partial<EventInput>) => {
         transactionId: string;
         type: string;
@@ -43,17 +57,17 @@ export declare function eventPayloadGenerator(rng: () => number): {
         type: string;
         id: string;
     };
-    draft: ({ eventId, actionType, annotation }: {
-        eventId: UUID;
+    draft: ({ eventId, actionType }: {
+        eventId: string;
         actionType: ActionType;
-        annotation?: Record<string, any>;
     }, input?: Partial<Draft>) => Draft;
     actions: {
-        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation">>) => {
+            type: "DECLARE";
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -66,10 +80,6 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
-            } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
-                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
@@ -90,26 +100,24 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
-            }[] | {
-                start: string;
-                end: string;
-            } | null | undefined>;
+            }[] | 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">>) => {
+        notify: (eventId: string, input?: {
+            transactionId?: string;
+            declaration?: Partial<ActionUpdate>;
+        }) => {
             type: "NOTIFY";
             transactionId: string;
-            declaration: Record<string, string | number | boolean | {
+            declaration: Partial<Record<string, string | number | boolean | {
                 type: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -122,10 +130,6 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
-            } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
-                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
@@ -146,20 +150,17 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
-            }[] | {
-                start: string;
-                end: string;
-            } | null | undefined>;
+            }[] | undefined>>;
             eventId: string;
-            keepAssignment: boolean | undefined;
         };
-        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation">>) => {
+            type: "VALIDATE";
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -172,10 +173,6 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
-            } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
-                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
@@ -196,15 +193,10 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
-            }[] | {
-                start: string;
-                end: string;
-            } | null | undefined>;
+            }[] | undefined>;
             annotation: {};
-            keepAssignment?: boolean | undefined;
-            type: "VALIDATE";
             duplicates: never[];
             eventId: string;
         };
@@ -222,80 +214,30 @@ export declare function eventPayloadGenerator(rng: () => number): {
             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;
-                path: 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 | null | undefined;
-                surname?: string | null | undefined;
-                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;
-                path: string;
-                originalFilename: string;
-            }[] | {
-                start: string;
-                end: string;
-            } | null | undefined>;
-            keepAssignment?: boolean | undefined;
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration">>, isDuplicate?: boolean) => {
             type: "ARCHIVE";
-            annotation: {};
-            duplicates: never[];
-            eventId: string;
-            reason: {
-                message: string;
+            transactionId: string;
+            declaration: {};
+            annotation: {
                 isDuplicate: boolean;
             };
+            duplicates: never[];
+            eventId: string;
         };
-        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
-            transactionId: string;
-            annotation: {};
-            keepAssignment?: boolean | undefined;
+        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation">>) => {
             type: "REJECT";
+            transactionId: string;
             declaration: {};
+            annotation: {};
             duplicates: never[];
             eventId: string;
-            reason: {
-                message: string;
-            };
         };
-        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment" | "registrationNumber">>) => {
+        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation">>) => {
+            type: "REGISTER";
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -308,10 +250,6 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 residentialArea?: string | null | undefined;
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
-            } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
-                middlename?: string | null | undefined;
             } | {
                 country: string;
                 district: string;
@@ -332,33 +270,26 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                path: string;
+                filename: string;
                 originalFilename: string;
-            }[] | {
-                start: string;
-                end: string;
-            } | null | undefined>;
+            }[] | 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;
+        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "annotation">>) => {
             type: "PRINT_CERTIFICATE";
+            transactionId: string;
             declaration: {};
+            annotation: {};
             eventId: string;
         };
         correction: {
-            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation">>) => {
                 type: "REQUEST_CORRECTION";
                 transactionId: string;
                 declaration: Record<string, string | number | boolean | {
                     type: string;
-                    path: string;
+                    filename: string;
                     originalFilename: string;
                 } | {
                     country: string;
@@ -371,10 +302,6 @@ export declare function eventPayloadGenerator(rng: () => number): {
                     residentialArea?: string | null | undefined;
                     street?: string | null | undefined;
                     zipCode?: string | null | undefined;
-                } | {
-                    firstname?: string | null | undefined;
-                    surname?: string | null | undefined;
-                    middlename?: string | null | undefined;
                 } | {
                     country: string;
                     district: string;
@@ -395,84 +322,41 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 } | {
                     type: string;
                     option: string;
-                    path: string;
+                    filename: string;
                     originalFilename: string;
-                }[] | {
-                    start: string;
-                    end: string;
-                } | null | undefined>;
+                }[] | undefined>;
                 annotation: {};
                 eventId: string;
-                keepAssignment: boolean | undefined;
             };
-            approve: (eventId: string, requestId: string, input?: Partial<Pick<ApproveCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
+            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
                 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">>) => {
+            reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
                 type: "REJECT_CORRECTION";
                 transactionId: string;
                 declaration: {};
                 annotation: {};
                 eventId: string;
                 requestId: string;
-                keepAssignment: boolean | undefined;
             };
         };
     };
 };
-export declare function generateActionDocument({ configuration, action, rng, defaults, user }: {
+export declare function generateActionDocument({ configuration, action, defaults }: {
     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, rng, user }: {
+export declare function generateEventDocument({ configuration, actions }: {
     configuration: EventConfig;
     actions: ActionType[];
-    rng?: () => number;
-    user?: Partial<{
-        signature: string;
-        primaryOfficeId: UUID;
-        role: TestUserRole;
-        id: string;
-    }>;
 }): EventDocument;
-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 function generateEventDraftDocument(eventId: string, actionType?: ActionType, declaration?: Record<string, FieldValue>): Draft;
+export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>) => 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

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