@opencrvs/toolkit 1.8.0-rc.fca3e39 → 1.8.0-rc.fd31705

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

@@ -1,29 +1,37 @@
+import { z } from 'zod';
 /**
  * Actions recognized by the system
  */
 export declare const ActionType: {
+    readonly DELETE: "DELETE";
     readonly CREATE: "CREATE";
-    readonly ASSIGN: "ASSIGN";
-    readonly UNASSIGN: "UNASSIGN";
-    readonly REGISTER: "REGISTER";
-    readonly VALIDATE: "VALIDATE";
-    readonly REQUEST_CORRECTION: "REQUEST_CORRECTION";
-    readonly REJECT_CORRECTION: "REJECT_CORRECTION";
-    readonly APPROVE_CORRECTION: "APPROVE_CORRECTION";
-    readonly DETECT_DUPLICATE: "DETECT_DUPLICATE";
     readonly NOTIFY: "NOTIFY";
     readonly DECLARE: "DECLARE";
-    readonly DELETE: "DELETE";
-    readonly PRINT_CERTIFICATE: "PRINT_CERTIFICATE";
-    readonly CUSTOM: "CUSTOM";
+    readonly VALIDATE: "VALIDATE";
+    readonly REGISTER: "REGISTER";
+    readonly DETECT_DUPLICATE: "DETECT_DUPLICATE";
     readonly REJECT: "REJECT";
     readonly MARKED_AS_DUPLICATE: "MARKED_AS_DUPLICATE";
     readonly ARCHIVE: "ARCHIVE";
+    readonly PRINT_CERTIFICATE: "PRINT_CERTIFICATE";
+    readonly REQUEST_CORRECTION: "REQUEST_CORRECTION";
+    readonly REJECT_CORRECTION: "REJECT_CORRECTION";
+    readonly APPROVE_CORRECTION: "APPROVE_CORRECTION";
+    readonly READ: "READ";
+    readonly ASSIGN: "ASSIGN";
+    readonly UNASSIGN: "UNASSIGN";
 };
-/**
- * Actions that can be attached to an event document
- * even if they are not in event configuration
- */
-export declare const LatentActions: ("REJECT" | "ARCHIVE")[];
 export type ActionType = (typeof ActionType)[keyof typeof ActionType];
+export declare const ConfirmableActions: readonly ["NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "REJECT", "ARCHIVE", "PRINT_CERTIFICATE"];
+/** Testing building types from enums as an alternative */
+export declare const ActionTypes: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
+/** Actions which change event data (declaration) before registration / during declaration. */
+export declare const DeclarationActions: z.ZodEnum<["DECLARE", "VALIDATE", "REGISTER"]>;
+export type DeclarationActionType = z.infer<typeof DeclarationActions>;
+/** Actions that can modify declaration data. Request can be corrected after declaring it. */
+export declare const DeclarationUpdateActions: z.ZodEnum<["DECLARE", "VALIDATE", "REGISTER", "REQUEST_CORRECTION"]>;
+export type DeclarationUpdateActionType = z.infer<typeof DeclarationUpdateActions>;
+/** Actions which update annotation or status of an event. */
+export declare const annotationActions: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
+export type AnnotationActionType = z.infer<typeof annotationActions>;
 //# sourceMappingURL=ActionType.d.ts.map

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

@@ -1,15 +1,15 @@
 import { JSONSchema } from '../conditionals/conditionals';
 import { z } from 'zod';
-export declare function Conditional(): z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
+export declare const Conditional: z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
 /**
  * By default, when conditionals are undefined, action is visible and enabled to everyone.
  */
 export declare const ConditionalType: {
-    /** When 'SHOW' conditional is defined, the action is shown to the user only if the condition is met */
     readonly SHOW: "SHOW";
-    /** If 'ENABLE' conditional is defined, the action is enabled only if the condition is met */
     readonly ENABLE: "ENABLE";
+    readonly DISPLAY_ON_REVIEW: "DISPLAY_ON_REVIEW";
 };
+export type ConditionalType = (typeof ConditionalType)[keyof typeof ConditionalType];
 export declare const ShowConditional: z.ZodObject<{
     type: z.ZodLiteral<"SHOW">;
     conditional: z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
@@ -31,9 +31,25 @@ export declare const EnableConditional: z.ZodObject<{
     conditional: JSONSchema;
 }>;
 /** @knipignore */
-export type AllActionConditionalFields = typeof ShowConditional | typeof EnableConditional;
+export type ActionConditionalType = typeof ShowConditional | typeof EnableConditional;
 /** @knipignore */
 export type InferredActionConditional = z.infer<typeof ShowConditional> | z.infer<typeof EnableConditional>;
-export declare const ActionConditional: z.ZodDiscriminatedUnion<"type", AllActionConditionalFields[]>;
+export declare const ActionConditional: z.ZodDiscriminatedUnion<"type", ActionConditionalType[]>;
 export type ActionConditional = InferredActionConditional;
+export declare const DisplayOnReviewConditional: z.ZodObject<{
+    type: z.ZodLiteral<"DISPLAY_ON_REVIEW">;
+    conditional: z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
+}, "strip", z.ZodTypeAny, {
+    type: "DISPLAY_ON_REVIEW";
+    conditional: JSONSchema;
+}, {
+    type: "DISPLAY_ON_REVIEW";
+    conditional: JSONSchema;
+}>;
+/** @knipignore */
+export type FieldConditionalType = typeof ShowConditional | typeof EnableConditional | typeof DisplayOnReviewConditional;
+/** @knipignore */
+export type InferredFieldConditional = z.infer<typeof ShowConditional> | z.infer<typeof EnableConditional> | z.infer<typeof DisplayOnReviewConditional>;
+export declare const FieldConditional: z.ZodDiscriminatedUnion<"type", FieldConditionalType[]>;
+export type FieldConditional = z.infer<typeof FieldConditional>;
 //# sourceMappingURL=Conditional.d.ts.map

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

@@ -1,5 +1,4 @@
 import { z } from 'zod';
-import { ActionType } from './ActionType';
 export declare const Draft: z.ZodObject<{
     id: z.ZodString;
     eventId: z.ZodString;
@@ -9,7 +8,7 @@ export declare const Draft: z.ZodObject<{
         id: z.ZodString;
         createdAt: z.ZodString;
         createdBy: z.ZodString;
-        data: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+        declaration: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
             filename: z.ZodString;
             originalFilename: z.ZodString;
             type: z.ZodString;
@@ -92,7 +91,7 @@ export declare const Draft: z.ZodObject<{
             province: string;
             urbanOrRural: "RURAL";
             village?: string | null | undefined;
-        }>, z.ZodObject<{
+        }>, z.ZodUndefined, z.ZodObject<{
             country: z.ZodString;
             addressType: z.ZodLiteral<"INTERNATIONAL">;
             state: z.ZodString;
@@ -123,7 +122,7 @@ export declare const Draft: z.ZodObject<{
             addressLine3?: string | null | undefined;
             postcodeOrZip?: string | null | undefined;
         }>]>>;
-        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+        annotation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
             filename: z.ZodString;
             originalFilename: z.ZodString;
             type: z.ZodString;
@@ -206,7 +205,7 @@ export declare const Draft: z.ZodObject<{
             province: string;
             urbanOrRural: "RURAL";
             village?: string | null | undefined;
-        }>, z.ZodObject<{
+        }>, z.ZodUndefined, z.ZodObject<{
             country: z.ZodString;
             addressType: z.ZodLiteral<"INTERNATIONAL">;
             state: z.ZodString;
@@ -238,11 +237,16 @@ export declare const Draft: z.ZodObject<{
             postcodeOrZip?: string | null | undefined;
         }>]>>>;
         createdAtLocation: z.ZodString;
+        status: z.ZodEnum<["Requested", "Accepted", "Rejected"]>;
+        originalActionId: z.ZodOptional<z.ZodString>;
     }, {
-        type: z.ZodEnum<[ActionType, ...ActionType[]]>;
+        type: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
     }>, "id">, "strip", z.ZodTypeAny, {
-        type: ActionType;
-        data: Record<string, string | number | boolean | {
+        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";
+        createdAt: string;
+        createdBy: string;
+        declaration: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -279,11 +283,9 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]>;
-        createdAt: string;
-        createdBy: string;
+        }[] | undefined>;
         createdAtLocation: string;
-        metadata?: Record<string, string | number | boolean | {
+        annotation?: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -320,10 +322,14 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]> | undefined;
+        }[] | undefined> | undefined;
+        originalActionId?: string | undefined;
     }, {
-        type: ActionType;
-        data: Record<string, string | number | boolean | {
+        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";
+        createdAt: string;
+        createdBy: string;
+        declaration: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -360,11 +366,9 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]>;
-        createdAt: string;
-        createdBy: string;
+        }[] | undefined>;
         createdAtLocation: string;
-        metadata?: Record<string, string | number | boolean | {
+        annotation?: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -401,7 +405,8 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]> | undefined;
+        }[] | undefined> | undefined;
+        originalActionId?: string | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     id: string;
@@ -409,8 +414,11 @@ export declare const Draft: z.ZodObject<{
     eventId: string;
     transactionId: string;
     action: {
-        type: ActionType;
-        data: Record<string, string | number | boolean | {
+        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";
+        createdAt: string;
+        createdBy: string;
+        declaration: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -447,11 +455,9 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]>;
-        createdAt: string;
-        createdBy: string;
+        }[] | undefined>;
         createdAtLocation: string;
-        metadata?: Record<string, string | number | boolean | {
+        annotation?: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -488,7 +494,8 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]> | undefined;
+        }[] | undefined> | undefined;
+        originalActionId?: string | undefined;
     };
 }, {
     id: string;
@@ -496,8 +503,11 @@ export declare const Draft: z.ZodObject<{
     eventId: string;
     transactionId: string;
     action: {
-        type: ActionType;
-        data: Record<string, string | number | boolean | {
+        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";
+        createdAt: string;
+        createdBy: string;
+        declaration: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -534,11 +544,9 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]>;
-        createdAt: string;
-        createdBy: string;
+        }[] | undefined>;
         createdAtLocation: string;
-        metadata?: Record<string, string | number | boolean | {
+        annotation?: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -575,13 +583,14 @@ export declare const Draft: z.ZodObject<{
             option: string;
             filename: string;
             originalFilename: string;
-        }[]> | undefined;
+        }[] | undefined> | undefined;
+        originalActionId?: string | undefined;
     };
 }>;
 export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
     eventId: z.ZodString;
     transactionId: z.ZodString;
-    data: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+    declaration: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
         filename: z.ZodString;
         originalFilename: z.ZodString;
         type: z.ZodString;
@@ -664,7 +673,7 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         province: string;
         urbanOrRural: "RURAL";
         village?: string | null | undefined;
-    }>, z.ZodObject<{
+    }>, z.ZodUndefined, z.ZodObject<{
         country: z.ZodString;
         addressType: z.ZodLiteral<"INTERNATIONAL">;
         state: z.ZodString;
@@ -695,7 +704,7 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         addressLine3?: string | null | undefined;
         postcodeOrZip?: string | null | undefined;
     }>]>>;
-    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+    annotation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
         filename: z.ZodString;
         originalFilename: z.ZodString;
         type: z.ZodString;
@@ -778,7 +787,7 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         province: string;
         urbanOrRural: "RURAL";
         village?: string | null | undefined;
-    }>, z.ZodObject<{
+    }>, z.ZodUndefined, z.ZodObject<{
         country: z.ZodString;
         addressType: z.ZodLiteral<"INTERNATIONAL">;
         state: z.ZodString;
@@ -809,11 +818,12 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         addressLine3?: string | null | undefined;
         postcodeOrZip?: string | null | undefined;
     }>]>>>;
+    originalActionId: z.ZodOptional<z.ZodString>;
 }, {
-    type: z.ZodEnum<[ActionType, ...ActionType[]]>;
+    type: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
 }>, "strip", z.ZodTypeAny, {
-    type: ActionType;
-    data: Record<string, string | number | boolean | {
+    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";
+    declaration: Record<string, string | number | boolean | {
         type: string;
         filename: string;
         originalFilename: string;
@@ -850,10 +860,10 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         option: string;
         filename: string;
         originalFilename: string;
-    }[]>;
+    }[] | undefined>;
     eventId: string;
     transactionId: string;
-    metadata?: Record<string, string | number | boolean | {
+    annotation?: Record<string, string | number | boolean | {
         type: string;
         filename: string;
         originalFilename: string;
@@ -890,10 +900,11 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         option: string;
         filename: string;
         originalFilename: string;
-    }[]> | undefined;
+    }[] | undefined> | undefined;
+    originalActionId?: string | undefined;
 }, {
-    type: ActionType;
-    data: Record<string, string | number | boolean | {
+    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";
+    declaration: Record<string, string | number | boolean | {
         type: string;
         filename: string;
         originalFilename: string;
@@ -930,10 +941,10 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         option: string;
         filename: string;
         originalFilename: string;
-    }[]>;
+    }[] | undefined>;
     eventId: string;
     transactionId: string;
-    metadata?: Record<string, string | number | boolean | {
+    annotation?: Record<string, string | number | boolean | {
         type: string;
         filename: string;
         originalFilename: string;
@@ -970,7 +981,8 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
         option: string;
         filename: string;
         originalFilename: string;
-    }[]> | undefined;
+    }[] | undefined> | undefined;
+    originalActionId?: string | undefined;
 }>;
 export type Draft = z.infer<typeof Draft>;
 export type DraftInput = z.infer<typeof DraftInput>;