@ecrvs/opencrvs-toolkit 1.8.1-rc.a7ee8fb

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

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const EventInput: z.ZodObject<{
+    transactionId: z.ZodString;
+    type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    transactionId: string;
+}, {
+    type: string;
+    transactionId: string;
+}>;
+export type EventInput = z.infer<typeof EventInput>;
+//# sourceMappingURL=EventInput.d.ts.map

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

@@ -0,0 +1,408 @@
+import { z } from 'zod';
+import { TranslationConfig } from './TranslationConfig';
+/**
+ * Event statuses recognized by the system
+ */
+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";
+    readonly POTENTIAL_DUPLICATE: "potential-duplicate";
+};
+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 PENDING_CERTIFICATION: "pending-certification";
+    readonly INCOMPLETE: "incomplete";
+    readonly REJECTED: "rejected";
+    readonly CORRECTION_REQUESTED: "correction-requested";
+    readonly POTENTIAL_DUPLICATE: "potential-duplicate";
+}>]>;
+export type ActionFlag = z.infer<typeof ActionFlag>;
+export type Flag = z.infer<typeof Flag>;
+export declare const ZodDate: z.ZodString;
+export declare const ActionCreationMetadata: z.ZodObject<{
+    createdAt: z.ZodString;
+    createdBy: 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;
+    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.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, {
+    createdAt: string;
+    createdBy: string;
+    createdByRole: string;
+    registrationNumber: string;
+    acceptedAt: string;
+    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>;
+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.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;
+        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.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, {
+        createdAt: string;
+        createdBy: string;
+        createdByRole: string;
+        registrationNumber: string;
+        acceptedAt: string;
+        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, {
+    DECLARED?: {
+        createdAt: string;
+        createdBy: string;
+        createdByRole: string;
+        acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
+    } | null | undefined;
+    REGISTERED?: {
+        createdAt: string;
+        createdBy: string;
+        createdByRole: string;
+        registrationNumber: string;
+        acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
+    } | null | undefined;
+}, {
+    DECLARED?: {
+        createdAt: string;
+        createdBy: string;
+        createdByRole: string;
+        acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: string | null | undefined;
+    } | null | undefined;
+    REGISTERED?: {
+        createdAt: string;
+        createdBy: string;
+        createdByRole: string;
+        registrationNumber: string;
+        acceptedAt: string;
+        createdByUserType?: "system" | "user" | null | undefined;
+        createdBySignature?: string | null | undefined;
+        createdAtLocation?: string | null | undefined;
+    } | null | undefined;
+}>;
+/**
+ * Event metadata exposed to client.
+ *
+ * Accessed through `event.` in configuration.
+ */
+export declare const EventMetadata: z.ZodObject<{
+    id: z.ZodBranded<z.ZodString, "UUID">;
+    type: z.ZodString;
+    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.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;
+            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.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, {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            registrationNumber: string;
+            acceptedAt: string;
+            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, {
+        DECLARED?: {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
+        } | null | undefined;
+        REGISTERED?: {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            registrationNumber: string;
+            acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
+        } | null | undefined;
+    }, {
+        DECLARED?: {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: string | null | undefined;
+        } | null | undefined;
+        REGISTERED?: {
+            createdAt: string;
+            createdBy: string;
+            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.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;
+    potentialDuplicates: z.ZodArray<z.ZodObject<{
+        id: z.ZodBranded<z.ZodString, "UUID">;
+        trackingId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string & z.BRAND<"UUID">;
+        trackingId: string;
+    }, {
+        id: string;
+        trackingId: string;
+    }>, "many">;
+    flags: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNativeEnum<{
+        readonly PENDING_CERTIFICATION: "pending-certification";
+        readonly INCOMPLETE: "incomplete";
+        readonly REJECTED: "rejected";
+        readonly CORRECTION_REQUESTED: "correction-requested";
+        readonly POTENTIAL_DUPLICATE: "potential-duplicate";
+    }>]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    id: string & z.BRAND<"UUID">;
+    status: "ARCHIVED" | "DECLARED" | "REGISTERED" | "VALIDATED" | "CREATED" | "NOTIFIED";
+    createdAt: string;
+    createdBy: string;
+    trackingId: string;
+    updatedAt: string;
+    legalStatuses: {
+        DECLARED?: {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
+        } | null | undefined;
+        REGISTERED?: {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            registrationNumber: string;
+            acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
+        } | null | undefined;
+    };
+    updatedByUserRole: string;
+    potentialDuplicates: {
+        id: string & z.BRAND<"UUID">;
+        trackingId: string;
+    }[];
+    flags: string[];
+    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 & z.BRAND<"UUID">) | null | undefined;
+    updatedBy?: string | null | undefined;
+}, {
+    type: string;
+    id: string;
+    status: "ARCHIVED" | "DECLARED" | "REGISTERED" | "VALIDATED" | "CREATED" | "NOTIFIED";
+    createdAt: string;
+    createdBy: string;
+    trackingId: string;
+    updatedAt: string;
+    legalStatuses: {
+        DECLARED?: {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: string | null | undefined;
+        } | null | undefined;
+        REGISTERED?: {
+            createdAt: string;
+            createdBy: string;
+            createdByRole: string;
+            registrationNumber: string;
+            acceptedAt: string;
+            createdByUserType?: "system" | "user" | null | undefined;
+            createdBySignature?: string | null | undefined;
+            createdAtLocation?: string | null | undefined;
+        } | null | undefined;
+    };
+    updatedByUserRole: string;
+    potentialDuplicates: {
+        id: string;
+        trackingId: string;
+    }[];
+    flags: string[];
+    createdByUserType?: "system" | "user" | null | undefined;
+    createdBySignature?: string | null | undefined;
+    createdAtLocation?: string | null | undefined;
+    assignedTo?: string | null | undefined;
+    dateOfEvent?: string | null | undefined;
+    updatedAtLocation?: string | null | undefined;
+    updatedBy?: string | null | undefined;
+}>;
+export type EventMetadata = z.infer<typeof EventMetadata>;
+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>;
+/**
+ * Mapping of event metadata keys to translation configuration.
+ * Consider introducing type in same manner as we have in FieldConfig.
+ * We need a way to know how to parse it.
+ */
+export declare const eventMetadataLabelMap: Record<Exclude<`event.${EventMetadataKeys}`, 'event.legalStatuses'>, TranslationConfig>;
+//# sourceMappingURL=EventMetadata.d.ts.map