@opencrvs/toolkit 1.8.0-rc.fb5b9fe → 1.8.0-rc.fb5f1af

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

@@ -1,5 +1,5 @@
+import { ActionType } from './ActionType';
 import { EventFieldId } from './AdvancedSearchConfig';
-import { SelectOption } from './FieldConfig';
 import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConfig';
 /**
  * Creates a function that acts like a callable + static method container.
@@ -8,13 +8,9 @@ import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConf
  * event('status') // → returns search config
  * event.hasAction('CLICKED') // → returns conditional
  */
-declare function eventFn(fieldId: EventFieldId, options?: SelectOption[]): {
+declare function eventFn(fieldId: EventFieldId): {
     range: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
-        options: {
-            value: string;
-            label: import("./TranslationConfig").TranslationConfig;
-        }[] | undefined;
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
         fieldType: "event";
     } & {
         config: {
@@ -22,11 +18,7 @@ declare function eventFn(fieldId: EventFieldId, options?: SelectOption[]): {
         };
     };
     exact: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
-        options: {
-            value: string;
-            label: import("./TranslationConfig").TranslationConfig;
-        }[] | undefined;
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
         fieldType: "event";
     } & {
         config: {
@@ -34,11 +26,7 @@ declare function eventFn(fieldId: EventFieldId, options?: SelectOption[]): {
         };
     };
     fuzzy: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
-        options: {
-            value: string;
-            label: import("./TranslationConfig").TranslationConfig;
-        }[] | undefined;
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
         fieldType: "event";
     } & {
         config: {
@@ -47,8 +35,12 @@ declare function eventFn(fieldId: EventFieldId, options?: SelectOption[]): {
     };
 };
 declare const event: typeof eventFn & {
+    /**
+     * Checks if the event contains a specific action type.
+     * @param action - The action type to check for.
+     */
+    hasAction: (action: ActionType) => import("../conditionals/conditionals").JSONSchema;
     field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
-    hasAction: (action: import("./ActionType").ActionType) => import("../conditionals/conditionals").JSONSchema;
 };
 export { event };
 //# sourceMappingURL=event.d.ts.map

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

@@ -1,5 +1,6 @@
 import { FieldConditional } from './Conditional';
 import { TranslationConfig } from './TranslationConfig';
+import { ValidationConfig } from './FieldConfig';
 /**
  * Entry point for defining conditional logic or configuration for a form field.
  * @param fieldId - The ID of the field to define rules or config for.
@@ -7,10 +8,12 @@ import { TranslationConfig } from './TranslationConfig';
  */
 export declare function field(fieldId: string, options?: {
     conditionals?: FieldConditional[];
+    validations?: ValidationConfig[];
     searchCriteriaLabelPrefix?: TranslationConfig;
 }): {
     range: () => {
         conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -21,6 +24,7 @@ export declare function field(fieldId: string, options?: {
     };
     exact: () => {
         conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -31,6 +35,7 @@ export declare function field(fieldId: string, options?: {
     };
     fuzzy: () => {
         conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -69,5 +74,9 @@ export declare function field(fieldId: string, options?: {
     isValidEnglishName: () => import("../conditionals/conditionals").JSONSchema;
     matches: (pattern: string) => import("../conditionals/conditionals").JSONSchema;
     isBetween: (min: number, max: number) => import("../conditionals/conditionals").JSONSchema;
+    getId: () => {
+        fieldId: string;
+    };
+    object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
 };
 //# sourceMappingURL=field.d.ts.map

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

@@ -35,6 +35,7 @@ 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';

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

@@ -1,5 +1,4 @@
 import { Scope } from '../scopes';
-import { ActionType } from './ActionType';
 export declare const CONFIG_GET_ALLOWED_SCOPES: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records", "config", "config.update:all"];
 export declare const CONFIG_SEARCH_ALLOWED_SCOPES: ("search.birth:my-jurisdiction" | "search.birth" | "search.death:my-jurisdiction" | "search.death" | "search.marriage:my-jurisdiction" | "search.marriage")[];
 export declare const ACTION_ALLOWED_SCOPES: {
@@ -40,6 +39,6 @@ export declare const ACTION_ALLOWED_CONFIGURABLE_SCOPES: {
     UNASSIGN: never[];
     DETECT_DUPLICATE: never[];
 };
+export declare const WRITE_ACTION_SCOPES: ("record.declare-birth" | "record.declaration-submit-for-approval" | "record.register" | "record.registration-print&issue-certified-copies")[];
 export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
-export declare function filterUnallowedActions(actions: ActionType[], userScopes: Scope[]): ActionType[];
 //# sourceMappingURL=scopes.d.ts.map

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

@@ -1,6 +1,6 @@
 import { UUID } from '../uuid';
-import { ActionDocument, ActionUpdate, EventState } from './ActionDocument';
-import { ArchiveActionInput, AssignActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, 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';
@@ -8,10 +8,32 @@ import { EventDocument } from './EventDocument';
 import { EventIndex } from './EventIndex';
 import { EventInput } from './EventInput';
 import { TranslationConfig } from './TranslationConfig';
+import { FieldConfig } from './FieldConfig';
 import { WorkqueueConfig } from './WorkqueueConfig';
-export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType): EventState;
-export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType): {};
-export declare const eventPayloadGenerator: {
+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): {
     create: (input?: Partial<EventInput>) => {
         transactionId: string;
         type: string;
@@ -21,17 +43,17 @@ export declare const eventPayloadGenerator: {
         type: string;
         id: string;
     };
-    draft: ({ eventId, actionType }: {
+    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">>) => {
-            type: "DECLARE";
+        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;
@@ -44,6 +66,10 @@ export declare const eventPayloadGenerator: {
                 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;
@@ -64,24 +90,26 @@ export declare const eventPayloadGenerator: {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | 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?: {
-            transactionId?: string;
-            declaration?: Partial<ActionUpdate>;
-        }) => {
+        notify: (eventId: string, input?: Partial<Pick<NotifyActionInput, "transactionId" | "declaration" | "keepAssignment">>) => {
             type: "NOTIFY";
             transactionId: string;
-            declaration: Partial<Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -94,6 +122,10 @@ export declare const eventPayloadGenerator: {
                 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;
@@ -114,17 +146,20 @@ export declare const eventPayloadGenerator: {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | undefined>>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             eventId: string;
+            keepAssignment: boolean | undefined;
         };
-        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation">>) => {
-            type: "VALIDATE";
+        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -137,6 +172,10 @@ export declare const eventPayloadGenerator: {
                 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;
@@ -157,10 +196,15 @@ export declare const eventPayloadGenerator: {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | undefined>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "VALIDATE";
             duplicates: never[];
             eventId: string;
         };
@@ -178,10 +222,55 @@ export declare const eventPayloadGenerator: {
             assignedTo: null;
             eventId: string;
         };
-        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration">>, isDuplicate?: boolean) => {
-            type: "ARCHIVE";
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration" | "keepAssignment">>, isDuplicate?: boolean) => {
             transactionId: string;
-            declaration: {};
+            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;
+            type: "ARCHIVE";
             annotation: {};
             duplicates: never[];
             eventId: string;
@@ -190,23 +279,23 @@ export declare const eventPayloadGenerator: {
                 isDuplicate: boolean;
             };
         };
-        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation">>) => {
-            type: "REJECT";
+        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
             transactionId: string;
-            declaration: {};
             annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "REJECT";
+            declaration: {};
             duplicates: never[];
             eventId: string;
             reason: {
                 message: string;
             };
         };
-        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation">>) => {
-            type: "REGISTER";
+        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment" | "registrationNumber">>) => {
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -219,6 +308,10 @@ export declare const eventPayloadGenerator: {
                 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;
@@ -239,26 +332,33 @@ export declare const eventPayloadGenerator: {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | 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">>) => {
-            type: "PRINT_CERTIFICATE";
+        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
             transactionId: string;
-            declaration: {};
             annotation: {};
+            keepAssignment?: boolean | undefined;
+            type: "PRINT_CERTIFICATE";
+            declaration: {};
             eventId: string;
         };
         correction: {
-            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation">>) => {
+            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
                 type: "REQUEST_CORRECTION";
                 transactionId: string;
                 declaration: Record<string, string | number | boolean | {
                     type: string;
-                    filename: string;
+                    path: string;
                     originalFilename: string;
                 } | {
                     country: string;
@@ -271,6 +371,10 @@ export declare const eventPayloadGenerator: {
                     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;
@@ -291,49 +395,77 @@ export declare const eventPayloadGenerator: {
                 } | {
                     type: string;
                     option: string;
-                    filename: string;
+                    path: string;
                     originalFilename: string;
-                }[] | [string, string] | undefined>;
+                }[] | {
+                    start: string;
+                    end: string;
+                } | null | undefined>;
                 annotation: {};
                 eventId: string;
+                keepAssignment: boolean | undefined;
             };
-            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
+            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "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<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
+            reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation" | "keepAssignment">>) => {
                 type: "REJECT_CORRECTION";
                 transactionId: string;
                 declaration: {};
                 annotation: {};
                 eventId: string;
                 requestId: string;
+                keepAssignment: 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: UUID, actionType?: ActionType, declaration?: EventState): Draft;
+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
+ * @returns A function that generates pseudo-random numbers between 0 and 1 [0, 1)
  */
-export declare function createPseudoRandomNumberGenerator(seed: number): () => number;
+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;