@opencrvs/toolkit 1.8.0-rc.fec1d5d → 1.8.0-rc.fef0fdd

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

@@ -9455,6 +9455,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 conditional: import(".").JSONSchema;
             })[] | undefined;
             searchCriteriaLabelPrefix?: import("./TranslationConfig").TranslationConfig | undefined;
+            validations?: {
+                message: import("./TranslationConfig").TranslationConfig;
+                validator: import(".").JSONSchema;
+            }[] | undefined;
         } | {
             config: {
                 type: "exact" | "fuzzy" | "range";
@@ -9476,6 +9480,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 conditional: import(".").JSONSchema;
             })[] | undefined;
             searchCriteriaLabelPrefix?: import("./TranslationConfig").TranslationConfig | undefined;
+            validations?: {
+                message: import("./TranslationConfig").TranslationConfig;
+                validator: import(".").JSONSchema;
+            }[] | undefined;
         })[];
     }[];
     dateOfEvent?: {

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";

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,3 +1,4 @@
+import { UUID } from '../uuid';
 import { ActionDocument, EventState } from './ActionDocument';
 import { ArchiveActionInput, AssignActionInput, DeclareActionInput, NotifyActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
@@ -10,6 +11,13 @@ 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;
@@ -31,7 +39,7 @@ export declare function eventPayloadGenerator(rng: () => number): {
         id: string;
     };
     draft: ({ eventId, actionType }: {
-        eventId: string;
+        eventId: UUID;
         actionType: ActionType;
     }, input?: Partial<Draft>) => Draft;
     actions: {
@@ -265,7 +273,7 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 message: string;
             };
         };
-        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment">>) => {
+        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation" | "keepAssignment" | "registrationNumber">>) => {
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
@@ -310,6 +318,7 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 originalFilename: string;
             }[] | [string, string] | null | undefined>;
             annotation: {};
+            registrationNumber?: string | undefined;
             keepAssignment?: boolean | undefined;
             type: "REGISTER";
             eventId: string;
@@ -393,19 +402,31 @@ export declare function eventPayloadGenerator(rng: () => number): {
         };
     };
 };
-export declare function generateActionDocument({ configuration, action, rng, 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, rng }: {
+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, actionType, rng, declaration }: {
-    eventId: string;
+    eventId: UUID;
     actionType: ActionType;
     rng?: () => number;
     declaration?: EventState;
@@ -419,6 +440,8 @@ export declare function getRandomDate(rng: () => number, start: string, end: str
  * @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 const generateTranslationConfig: (message: string) => TranslationConfig;

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

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

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

@@ -5,6 +5,7 @@ import { Action, ActionUpdate, EventState } from './ActionDocument';
 import { PageConfig, VerificationPageConfig } from './PageConfig';
 import { Draft } from './Draft';
 import { EventDocument } from './EventDocument';
+import { UUID } from '../uuid';
 import { ActionConfig } from './ActionConfig';
 import { FormConfig } from './FormConfig';
 export declare function getDeclarationFields(configuration: EventConfig): FieldConfig[];
@@ -4251,14 +4252,15 @@ export declare function omitHiddenPaginatedFields(formConfig: FormConfig, declar
     originalFilename: string;
 }[] | [string, string] | null | undefined>>;
 export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]): {
-    id: string;
+    id: string & import("zod").BRAND<"UUID">;
     transactionId: string;
     createdAt: string;
-    eventId: string;
+    eventId: string & import("zod").BRAND<"UUID">;
     action: {
         type: "DECLARE" | "REGISTER" | "VALIDATE" | "DELETE" | "CREATE" | "NOTIFY" | "DETECT_DUPLICATE" | "REJECT" | "MARKED_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION" | "READ" | "ASSIGN" | "UNASSIGN";
         status: "Rejected" | "Requested" | "Accepted";
         transactionId: string;
+        createdByUserType: "system" | "user";
         createdAt: string;
         createdBy: string;
         createdByRole: string;
@@ -4305,7 +4307,7 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
             originalFilename: string;
         }[] | [string, string] | null | undefined>;
         createdBySignature?: string | null | undefined;
-        createdAtLocation?: string | null | undefined;
+        createdAtLocation?: (string & import("zod").BRAND<"UUID">) | null | undefined;
         annotation?: Record<string, string | number | boolean | {
             type: string;
             filename: string;
@@ -4347,11 +4349,11 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
             option: string;
             filename: string;
             originalFilename: string;
-        }[] | [string, string] | null | undefined> | undefined;
-        originalActionId?: string | undefined;
+        }[] | [string, string] | null | undefined> | null | undefined;
+        originalActionId?: (string & import("zod").BRAND<"UUID">) | null | undefined;
     };
 }[];
-export declare function createEmptyDraft(eventId: string, draftId: string, actionType: ActionType): Draft;
+export declare function createEmptyDraft(eventId: UUID, draftId: UUID, actionType: ActionType): Draft;
 export declare function isVerificationPage(page: PageConfig): page is VerificationPageConfig;
 export declare function getVisibleVerificationPageIds(pages: PageConfig[], annotation: ActionUpdate): string[];
 export declare function getActionVerificationPageIds(actionConfig: ActionConfig, annotation: ActionUpdate): string[];
@@ -13905,6 +13907,10 @@ export declare function getEventConfigById(eventConfigs: EventConfig[], id: stri
                 conditional: import(".").JSONSchema;
             })[] | undefined;
             searchCriteriaLabelPrefix?: import("./TranslationConfig").TranslationConfig | undefined;
+            validations?: {
+                message: import("./TranslationConfig").TranslationConfig;
+                validator: import(".").JSONSchema;
+            }[] | undefined;
         } | {
             config: {
                 type: "exact" | "fuzzy" | "range";
@@ -13926,6 +13932,10 @@ export declare function getEventConfigById(eventConfigs: EventConfig[], id: stri
                 conditional: import(".").JSONSchema;
             })[] | undefined;
             searchCriteriaLabelPrefix?: import("./TranslationConfig").TranslationConfig | undefined;
+            validations?: {
+                message: import("./TranslationConfig").TranslationConfig;
+                validator: import(".").JSONSchema;
+            }[] | undefined;
         })[];
     }[];
     dateOfEvent?: {