@opencrvs/toolkit 1.8.0-rc.fcd89ec → 1.8.0-rc.fcf7cb3

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

@@ -2,25 +2,12 @@ import { z } from 'zod';
 export declare const EventInput: z.ZodObject<{
     transactionId: z.ZodString;
     type: z.ZodString;
-    dateOfEvent: z.ZodOptional<z.ZodObject<{
-        fieldId: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        fieldId: string;
-    }, {
-        fieldId: string;
-    }>>;
 }, "strip", z.ZodTypeAny, {
     type: string;
     transactionId: string;
-    dateOfEvent?: {
-        fieldId: string;
-    } | undefined;
 }, {
     type: string;
     transactionId: string;
-    dateOfEvent?: {
-        fieldId: string;
-    } | undefined;
 }>;
 export type EventInput = z.infer<typeof EventInput>;
 //# sourceMappingURL=EventInput.d.ts.map

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

@@ -3,64 +3,59 @@ import { TranslationConfig } from './TranslationConfig';
 /**
  * Event statuses recognized by the system
  */
-export declare const EventStatus: {
-    readonly CREATED: "CREATED";
-    readonly NOTIFIED: "NOTIFIED";
-    readonly DECLARED: "DECLARED";
-    readonly VALIDATED: "VALIDATED";
-    readonly REGISTERED: "REGISTERED";
-    readonly CERTIFIED: "CERTIFIED";
-    readonly REJECTED: "REJECTED";
-    readonly ARCHIVED: "ARCHIVED";
+export declare const EventStatus: z.ZodEnum<["CREATED", "NOTIFIED", "DECLARED", "VALIDATED", "REGISTERED", "ARCHIVED"]>;
+export type EventStatus = z.infer<typeof EventStatus>;
+export declare const InherentFlags: {
+    readonly PENDING_CERTIFICATION: "pending-certification";
+    readonly INCOMPLETE: "incomplete";
+    readonly REJECTED: "rejected";
+    readonly CORRECTION_REQUESTED: "correction-requested";
 };
-export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];
-export declare const EventStatusEnum: z.ZodEnum<["CREATED", "NOTIFIED", "DECLARED", "VALIDATED", "REGISTERED", "CERTIFIED", "REJECTED", "ARCHIVED"]>;
-export declare const CustomFlags: {
-    readonly CERTIFICATE_PRINTED: "certificate-printed";
-};
-export type CustomFlags = (typeof CustomFlags)[keyof typeof CustomFlags];
+export type InherentFlags = (typeof InherentFlags)[keyof typeof InherentFlags];
+export declare const ActionFlag: z.ZodString;
 export declare const Flag: z.ZodUnion<[z.ZodString, z.ZodNativeEnum<{
-    readonly CERTIFICATE_PRINTED: "certificate-printed";
+    readonly PENDING_CERTIFICATION: "pending-certification";
+    readonly INCOMPLETE: "incomplete";
+    readonly REJECTED: "rejected";
+    readonly CORRECTION_REQUESTED: "correction-requested";
 }>]>;
+export type ActionFlag = z.infer<typeof ActionFlag>;
 export type Flag = z.infer<typeof Flag>;
-export declare const eventStatuses: ("ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED")[];
-export declare const EventStatuses: z.ZodNativeEnum<{
-    readonly CREATED: "CREATED";
-    readonly NOTIFIED: "NOTIFIED";
-    readonly DECLARED: "DECLARED";
-    readonly VALIDATED: "VALIDATED";
-    readonly REGISTERED: "REGISTERED";
-    readonly CERTIFIED: "CERTIFIED";
-    readonly REJECTED: "REJECTED";
-    readonly ARCHIVED: "ARCHIVED";
-}>;
 export declare const ZodDate: z.ZodString;
 export declare const ActionCreationMetadata: z.ZodObject<{
     createdAt: z.ZodString;
     createdBy: z.ZodString;
-    createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
+    createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
     acceptedAt: z.ZodString;
     createdByRole: z.ZodString;
+    createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     createdAt: string;
     createdBy: string;
     createdByRole: string;
     acceptedAt: string;
-    createdAtLocation?: string | null | undefined;
+    createdByUserType?: "system" | "user" | null | undefined;
+    createdBySignature?: string | null | undefined;
+    createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
 }, {
     createdAt: string;
     createdBy: string;
     createdByRole: string;
     acceptedAt: string;
+    createdByUserType?: "system" | "user" | null | undefined;
+    createdBySignature?: string | null | undefined;
     createdAtLocation?: string | null | undefined;
 }>;
 export type ActionCreationMetadata = z.infer<typeof ActionCreationMetadata>;
 export declare const RegistrationCreationMetadata: z.ZodObject<z.objectUtil.extendShape<{
     createdAt: z.ZodString;
     createdBy: z.ZodString;
-    createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
+    createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
     acceptedAt: z.ZodString;
     createdByRole: z.ZodString;
+    createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, {
     registrationNumber: z.ZodString;
 }>, "strip", z.ZodTypeAny, {
@@ -69,13 +64,17 @@ export declare const RegistrationCreationMetadata: z.ZodObject<z.objectUtil.exte
     createdByRole: string;
     registrationNumber: string;
     acceptedAt: string;
-    createdAtLocation?: string | null | undefined;
+    createdByUserType?: "system" | "user" | null | undefined;
+    createdBySignature?: string | null | undefined;
+    createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
 }, {
     createdAt: string;
     createdBy: string;
     createdByRole: string;
     registrationNumber: string;
     acceptedAt: string;
+    createdByUserType?: "system" | "user" | null | undefined;
+    createdBySignature?: string | null | undefined;
     createdAtLocation?: string | null | undefined;
 }>;
 export type RegistrationCreationMetadata = z.infer<typeof RegistrationCreationMetadata>;
@@ -83,28 +82,36 @@ export declare const LegalStatuses: z.ZodObject<{
     DECLARED: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         createdAt: z.ZodString;
         createdBy: z.ZodString;
-        createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
+        createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
         acceptedAt: z.ZodString;
         createdByRole: z.ZodString;
+        createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         createdAt: string;
         createdBy: string;
         createdByRole: string;
         acceptedAt: string;
-        createdAtLocation?: string | null | undefined;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
     }, {
         createdAt: string;
         createdBy: string;
         createdByRole: string;
         acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
         createdAtLocation?: string | null | undefined;
     }>>>;
     REGISTERED: z.ZodOptional<z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
         createdAt: z.ZodString;
         createdBy: z.ZodString;
-        createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
+        createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
         acceptedAt: z.ZodString;
         createdByRole: z.ZodString;
+        createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, {
         registrationNumber: z.ZodString;
     }>, "strip", z.ZodTypeAny, {
@@ -113,13 +120,17 @@ export declare const LegalStatuses: z.ZodObject<{
         createdByRole: string;
         registrationNumber: string;
         acceptedAt: string;
-        createdAtLocation?: string | null | undefined;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
     }, {
         createdAt: string;
         createdBy: string;
         createdByRole: string;
         registrationNumber: string;
         acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
         createdAtLocation?: string | null | undefined;
     }>>>;
 }, "strip", z.ZodTypeAny, {
@@ -128,7 +139,9 @@ export declare const LegalStatuses: z.ZodObject<{
         createdBy: string;
         createdByRole: string;
         acceptedAt: string;
-        createdAtLocation?: string | null | undefined;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
     } | null | undefined;
     REGISTERED?: {
         createdAt: string;
@@ -136,7 +149,9 @@ export declare const LegalStatuses: z.ZodObject<{
         createdByRole: string;
         registrationNumber: string;
         acceptedAt: string;
-        createdAtLocation?: string | null | undefined;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
     } | null | undefined;
 }, {
     DECLARED?: {
@@ -144,6 +159,8 @@ export declare const LegalStatuses: z.ZodObject<{
         createdBy: string;
         createdByRole: string;
         acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
         createdAtLocation?: string | null | undefined;
     } | null | undefined;
     REGISTERED?: {
@@ -152,6 +169,8 @@ export declare const LegalStatuses: z.ZodObject<{
         createdByRole: string;
         registrationNumber: string;
         acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
         createdAtLocation?: string | null | undefined;
     } | null | undefined;
 }>;
@@ -161,44 +180,43 @@ export declare const LegalStatuses: z.ZodObject<{
  * Accessed through `event.` in configuration.
  */
 export declare const EventMetadata: z.ZodObject<{
-    id: z.ZodString;
+    id: z.ZodBranded<z.ZodString, "UUID">;
     type: z.ZodString;
-    status: z.ZodNativeEnum<{
-        readonly CREATED: "CREATED";
-        readonly NOTIFIED: "NOTIFIED";
-        readonly DECLARED: "DECLARED";
-        readonly VALIDATED: "VALIDATED";
-        readonly REGISTERED: "REGISTERED";
-        readonly CERTIFIED: "CERTIFIED";
-        readonly REJECTED: "REJECTED";
-        readonly ARCHIVED: "ARCHIVED";
-    }>;
+    status: z.ZodEnum<["CREATED", "NOTIFIED", "DECLARED", "VALIDATED", "REGISTERED", "ARCHIVED"]>;
     legalStatuses: z.ZodObject<{
         DECLARED: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             createdAt: z.ZodString;
             createdBy: z.ZodString;
-            createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
+            createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
             acceptedAt: z.ZodString;
             createdByRole: z.ZodString;
+            createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
             createdAt: string;
             createdBy: string;
             createdByRole: string;
             acceptedAt: string;
-            createdAtLocation?: string | null | undefined;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
         }, {
             createdAt: string;
             createdBy: string;
             createdByRole: string;
             acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
             createdAtLocation?: string | null | undefined;
         }>>>;
         REGISTERED: z.ZodOptional<z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
             createdAt: z.ZodString;
             createdBy: z.ZodString;
-            createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
+            createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
             acceptedAt: z.ZodString;
             createdByRole: z.ZodString;
+            createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         }, {
             registrationNumber: z.ZodString;
         }>, "strip", z.ZodTypeAny, {
@@ -207,13 +225,17 @@ export declare const EventMetadata: z.ZodObject<{
             createdByRole: string;
             registrationNumber: string;
             acceptedAt: string;
-            createdAtLocation?: string | null | undefined;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
         }, {
             createdAt: string;
             createdBy: string;
             createdByRole: string;
             registrationNumber: string;
             acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
             createdAtLocation?: string | null | undefined;
         }>>>;
     }, "strip", z.ZodTypeAny, {
@@ -222,7 +244,9 @@ export declare const EventMetadata: z.ZodObject<{
             createdBy: string;
             createdByRole: string;
             acceptedAt: string;
-            createdAtLocation?: string | null | undefined;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
         } | null | undefined;
         REGISTERED?: {
             createdAt: string;
@@ -230,7 +254,9 @@ export declare const EventMetadata: z.ZodObject<{
             createdByRole: string;
             registrationNumber: string;
             acceptedAt: string;
-            createdAtLocation?: string | null | undefined;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
         } | null | undefined;
     }, {
         DECLARED?: {
@@ -238,6 +264,8 @@ export declare const EventMetadata: z.ZodObject<{
             createdBy: string;
             createdByRole: string;
             acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
             createdAtLocation?: string | null | undefined;
         } | null | undefined;
         REGISTERED?: {
@@ -246,26 +274,33 @@ export declare const EventMetadata: z.ZodObject<{
             createdByRole: string;
             registrationNumber: string;
             acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
             createdAtLocation?: string | null | undefined;
         } | null | undefined;
     }>;
     createdAt: z.ZodString;
     dateOfEvent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     createdBy: z.ZodString;
+    createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
     updatedByUserRole: z.ZodString;
-    createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    updatedAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
+    createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    updatedAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
     updatedAt: z.ZodString;
     assignedTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     updatedBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     trackingId: z.ZodString;
     flags: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNativeEnum<{
-        readonly CERTIFICATE_PRINTED: "certificate-printed";
+        readonly PENDING_CERTIFICATION: "pending-certification";
+        readonly INCOMPLETE: "incomplete";
+        readonly REJECTED: "rejected";
+        readonly CORRECTION_REQUESTED: "correction-requested";
     }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     type: string;
-    id: string;
-    status: "ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED";
+    id: string & z.BRAND<"UUID">;
+    status: "ARCHIVED" | "DECLARED" | "REGISTERED" | "VALIDATED" | "CREATED" | "NOTIFIED";
     createdAt: string;
     createdBy: string;
     updatedAt: string;
@@ -276,7 +311,9 @@ export declare const EventMetadata: z.ZodObject<{
             createdBy: string;
             createdByRole: string;
             acceptedAt: string;
-            createdAtLocation?: string | null | undefined;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
         } | null | undefined;
         REGISTERED?: {
             createdAt: string;
@@ -284,20 +321,24 @@ export declare const EventMetadata: z.ZodObject<{
             createdByRole: string;
             registrationNumber: string;
             acceptedAt: string;
-            createdAtLocation?: string | null | undefined;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
         } | null | undefined;
     };
     updatedByUserRole: string;
     flags: string[];
-    createdAtLocation?: string | null | undefined;
+    createdByUserType?: "system" | "user" | null | undefined;
+    createdBySignature?: string | null | undefined;
+    createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
     assignedTo?: string | null | undefined;
     dateOfEvent?: string | null | undefined;
-    updatedAtLocation?: string | null | undefined;
+    updatedAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
     updatedBy?: string | null | undefined;
 }, {
     type: string;
     id: string;
-    status: "ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED";
+    status: "ARCHIVED" | "DECLARED" | "REGISTERED" | "VALIDATED" | "CREATED" | "NOTIFIED";
     createdAt: string;
     createdBy: string;
     updatedAt: string;
@@ -308,6 +349,8 @@ export declare const EventMetadata: z.ZodObject<{
             createdBy: string;
             createdByRole: string;
             acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
             createdAtLocation?: string | null | undefined;
         } | null | undefined;
         REGISTERED?: {
@@ -316,11 +359,15 @@ export declare const EventMetadata: z.ZodObject<{
             createdByRole: string;
             registrationNumber: string;
             acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
             createdAtLocation?: string | null | undefined;
         } | null | undefined;
     };
     updatedByUserRole: string;
     flags: string[];
+    createdByUserType?: "system" | "user" | null | undefined;
+    createdBySignature?: string | null | undefined;
     createdAtLocation?: string | null | undefined;
     assignedTo?: string | null | undefined;
     dateOfEvent?: string | null | undefined;
@@ -328,19 +375,9 @@ export declare const EventMetadata: z.ZodObject<{
     updatedBy?: string | null | undefined;
 }>;
 export type EventMetadata = z.infer<typeof EventMetadata>;
-export declare const EventMetadataKeys: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"]>;
+export declare const EventMetadataKeysArray: readonly ["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"];
+export declare const EventMetadataKeys: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"]>;
 export type EventMetadataKeys = z.infer<typeof EventMetadataKeys>;
-/**
- * This ensures `event.field()` takes a key from `EventMetadata`
- */
-export declare const EventMetadataParameter: z.ZodObject<{
-    $event: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"]>;
-}, "strip", z.ZodTypeAny, {
-    $event: "type" | "id" | "status" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "dateOfEvent" | "updatedAt" | "trackingId" | "legalStatuses" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags";
-}, {
-    $event: "type" | "id" | "status" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "dateOfEvent" | "updatedAt" | "trackingId" | "legalStatuses" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags";
-}>;
-export type EventMetadataParameter = z.infer<typeof EventMetadataParameter>;
 /**
  * Mapping of event metadata keys to translation configuration.
  * Consider introducing type in same manner as we have in FieldConfig.