@opencrvs/toolkit 1.8.0-rc.fd8a78f → 1.8.0-rc.fde35f6

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

@@ -1,3 +1,4 @@
+import { ActionType } from './ActionType';
 import { EventFieldId } from './AdvancedSearchConfig';
 import { SelectOption } from './FieldConfig';
 import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConfig';
@@ -10,36 +11,36 @@ import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConf
  */
 declare function eventFn(fieldId: EventFieldId, options?: SelectOption[]): {
     range: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
         options: {
             value: string;
             label: import("./TranslationConfig").TranslationConfig;
-        }[] | undefined;
-        fieldType: "event";
+        }[];
     } & {
         config: {
             type: "range";
         };
     };
     exact: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
         options: {
             value: string;
             label: import("./TranslationConfig").TranslationConfig;
-        }[] | undefined;
-        fieldType: "event";
+        }[];
     } & {
         config: {
             type: "exact";
         };
     };
     fuzzy: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
         options: {
             value: string;
             label: import("./TranslationConfig").TranslationConfig;
-        }[] | undefined;
-        fieldType: "event";
+        }[];
     } & {
         config: {
             type: "fuzzy";
@@ -47,8 +48,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,16 +1,25 @@
 import { FieldConditional } from './Conditional';
 import { TranslationConfig } from './TranslationConfig';
+import { SelectOption, 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.
  * @returns An object combining conditional methods and configuration builders.
  */
 export declare function field(fieldId: string, options?: {
+    options?: SelectOption[];
+    excludeInSearchQuery?: boolean;
+    alternateFieldIds?: string[];
     conditionals?: FieldConditional[];
+    validations?: ValidationConfig[];
     searchCriteriaLabelPrefix?: TranslationConfig;
 }): {
     range: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
         conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -20,7 +29,11 @@ export declare function field(fieldId: string, options?: {
         };
     };
     exact: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
         conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "field";
@@ -30,7 +43,11 @@ export declare function field(fieldId: string, options?: {
         };
     };
     fuzzy: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
         conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
         searchCriteriaLabelPrefix?: TranslationConfig;
         fieldId: string;
         fieldType: "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,18 @@ 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;
@@ -30,16 +43,17 @@ export declare function eventPayloadGenerator(rng: () => number): {
         type: string;
         id: string;
     };
-    draft: ({ eventId, actionType }: {
-        eventId: string;
+    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" | "keepAssignment">>) => {
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -53,8 +67,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname: string;
-                surname: string;
+                firstname?: string | null | undefined;
+                surname?: string | null | undefined;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -76,9 +90,12 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             annotation: {};
             keepAssignment?: boolean | undefined;
             type: "DECLARE";
@@ -92,7 +109,7 @@ export declare function eventPayloadGenerator(rng: () => number): {
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -106,8 +123,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname: string;
-                surname: string;
+                firstname?: string | null | undefined;
+                surname?: string | null | undefined;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -129,9 +146,12 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             eventId: string;
             keepAssignment: boolean | undefined;
         };
@@ -139,7 +159,7 @@ export declare function eventPayloadGenerator(rng: () => number): {
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -153,8 +173,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname: string;
-                surname: string;
+                firstname?: string | null | undefined;
+                surname?: string | null | undefined;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -176,9 +196,12 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             annotation: {};
             keepAssignment?: boolean | undefined;
             type: "VALIDATE";
@@ -203,7 +226,7 @@ export declare function eventPayloadGenerator(rng: () => number): {
             transactionId: string;
             declaration: Record<string, string | number | boolean | {
                 type: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -217,8 +240,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname: string;
-                surname: string;
+                firstname?: string | null | undefined;
+                surname?: string | null | undefined;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -240,9 +263,12 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             keepAssignment?: boolean | undefined;
             type: "ARCHIVE";
             annotation: {};
@@ -265,11 +291,11 @@ 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;
-                filename: string;
+                path: string;
                 originalFilename: string;
             } | {
                 country: string;
@@ -283,8 +309,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname: string;
-                surname: string;
+                firstname?: string | null | undefined;
+                surname?: string | null | undefined;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -306,10 +332,14 @@ export declare function eventPayloadGenerator(rng: () => number): {
             } | {
                 type: string;
                 option: string;
-                filename: string;
+                path: string;
                 originalFilename: string;
-            }[] | [string, string] | null | undefined>;
+            }[] | {
+                start: string;
+                end: string;
+            } | null | undefined>;
             annotation: {};
+            registrationNumber?: string | undefined;
             keepAssignment?: boolean | undefined;
             type: "REGISTER";
             eventId: string;
@@ -328,7 +358,7 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 transactionId: string;
                 declaration: Record<string, string | number | boolean | {
                     type: string;
-                    filename: string;
+                    path: string;
                     originalFilename: string;
                 } | {
                     country: string;
@@ -342,8 +372,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                     street?: string | null | undefined;
                     zipCode?: string | null | undefined;
                 } | {
-                    firstname: string;
-                    surname: string;
+                    firstname?: string | null | undefined;
+                    surname?: string | null | undefined;
                     middlename?: string | null | undefined;
                 } | {
                     country: string;
@@ -365,9 +395,12 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 } | {
                     type: string;
                     option: string;
-                    filename: string;
+                    path: string;
                     originalFilename: string;
-                }[] | [string, string] | null | undefined>;
+                }[] | {
+                    start: string;
+                    end: string;
+                } | null | undefined>;
                 annotation: {};
                 eventId: string;
                 keepAssignment: boolean | undefined;
@@ -393,19 +426,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 +464,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