@opencrvs/toolkit 1.8.0-rc.f8aa0c5 → 1.8.0-rc.f8e0ee5

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

@@ -1,6 +1,5 @@
 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.
@@ -8,12 +7,10 @@ import { ValidationConfig } from './FieldConfig';
  */
 export declare function field(fieldId: string, options?: {
     conditionals?: FieldConditional[];
-    validations?: ValidationConfig[];
     searchCriteriaLabelPrefix?: TranslationConfig;
 }): {
     range: () => {
         conditionals?: FieldConditional[];
-        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -24,7 +21,6 @@ export declare function field(fieldId: string, options?: {
     };
     exact: () => {
         conditionals?: FieldConditional[];
-        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -35,7 +31,6 @@ export declare function field(fieldId: string, options?: {
     };
     fuzzy: () => {
         conditionals?: FieldConditional[];
-        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -74,9 +69,5 @@ 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,7 +35,6 @@ 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,4 +1,5 @@
 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: {
@@ -10,7 +11,7 @@ export declare const ACTION_ALLOWED_SCOPES: {
     VALIDATE: ["record.declaration-submit-for-approval", "record.register"];
     REGISTER: ["record.register"];
     PRINT_CERTIFICATE: ["record.registration-print&issue-certified-copies"];
-    REQUEST_CORRECTION: ["record.registration-request-correction"];
+    REQUEST_CORRECTION: ["record.registration-request-correction", "record.registration-correct"];
     REJECT_CORRECTION: ["record.registration-correct"];
     APPROVE_CORRECTION: ["record.registration-correct"];
     MARKED_AS_DUPLICATE: ["record.declaration-archive"];
@@ -39,6 +40,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,5 @@
-import { UUID } from '../uuid';
-import { ActionDocument, EventState } from './ActionDocument';
-import { ArchiveActionInput, AssignActionInput, DeclareActionInput, NotifyActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
+import { ActionDocument, ActionUpdate, EventState } 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';
@@ -8,27 +7,10 @@ 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';
-/**
- * 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): {
+export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType): EventState;
+export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType): {};
+export declare const eventPayloadGenerator: {
     create: (input?: Partial<EventInput>) => {
         transactionId: string;
         type: string;
@@ -39,11 +21,12 @@ export declare function eventPayloadGenerator(rng: () => number): {
         id: string;
     };
     draft: ({ eventId, actionType }: {
-        eventId: UUID;
+        eventId: string;
         actionType: ActionType;
     }, 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;
@@ -60,10 +43,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;
@@ -86,19 +65,20 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | [string, string] | 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;
                 filename: string;
                 originalFilename: string;
@@ -113,10 +93,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;
@@ -139,11 +115,11 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | [string, string] | 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;
@@ -160,10 +136,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;
@@ -186,10 +158,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | [string, string] | undefined>;
             annotation: {};
-            keepAssignment?: boolean | undefined;
-            type: "VALIDATE";
             duplicates: never[];
             eventId: string;
         };
@@ -207,52 +177,10 @@ 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;
-                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 | 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;
-                filename: string;
-                originalFilename: string;
-            }[] | [string, string] | null | undefined>;
-            keepAssignment?: boolean | undefined;
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration">>, isDuplicate?: boolean) => {
             type: "ARCHIVE";
+            transactionId: string;
+            declaration: {};
             annotation: {};
             duplicates: never[];
             eventId: string;
@@ -261,19 +189,19 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 isDuplicate: boolean;
             };
         };
-        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;
@@ -290,10 +218,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;
@@ -316,23 +240,19 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | [string, string] | 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 | {
@@ -350,10 +270,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;
@@ -376,72 +292,47 @@ export declare function eventPayloadGenerator(rng: () => number): {
                     option: string;
                     filename: string;
                     originalFilename: string;
-                }[] | [string, string] | null | undefined>;
+                }[] | [string, string] | undefined>;
                 annotation: {};
                 eventId: string;
-                keepAssignment: boolean | undefined;
             };
-            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "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<RequestCorrectionActionInput, "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 generateEventDraftDocument(eventId: string, actionType?: ActionType, 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)
+ * @returns A function that generates pseudo-random numbers between 0 and 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 createPseudoRandomNumberGenerator(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;

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