@opencrvs/toolkit 1.8.0-rc.ffe8c17 → 1.8.1-rc.a372970

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

@@ -1,24 +1,39 @@
+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";
 };
 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>;
+/** Actions which requires the user to be assigned */
+export declare const writeActions: z.ZodEnum<["DELETE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION"]>;
 //# sourceMappingURL=ActionType.d.ts.map

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

@@ -6,6 +6,10 @@ export declare const GeographicalArea: {
     readonly URBAN: "URBAN";
     readonly RURAL: "RURAL";
 };
+export declare const AddressType: {
+    readonly DOMESTIC: "DOMESTIC";
+    readonly INTERNATIONAL: "INTERNATIONAL";
+};
 export declare const FileFieldValue: z.ZodObject<{
     filename: z.ZodString;
     originalFilename: z.ZodString;
@@ -22,6 +26,7 @@ export declare const FileFieldValue: z.ZodObject<{
 export type FileFieldValue = z.infer<typeof FileFieldValue>;
 export declare const UrbanAddressValue: z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -34,6 +39,7 @@ export declare const UrbanAddressValue: z.ZodObject<z.objectUtil.extendShape<{
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -44,6 +50,7 @@ export declare const UrbanAddressValue: z.ZodObject<z.objectUtil.extendShape<{
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -54,6 +61,7 @@ export declare const UrbanAddressValue: z.ZodObject<z.objectUtil.extendShape<{
 }>;
 export declare const RuralAddressValue: z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -62,18 +70,21 @@ export declare const RuralAddressValue: z.ZodObject<z.objectUtil.extendShape<{
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
 }>;
 export declare const UrbanAddressUpdateValue: z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -86,6 +97,7 @@ export declare const UrbanAddressUpdateValue: z.ZodObject<z.objectUtil.extendSha
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -96,6 +108,7 @@ export declare const UrbanAddressUpdateValue: z.ZodObject<z.objectUtil.extendSha
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -106,6 +119,7 @@ export declare const UrbanAddressUpdateValue: z.ZodObject<z.objectUtil.extendSha
 }>;
 export declare const RuralAddressUpdateValue: z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -114,18 +128,52 @@ export declare const RuralAddressUpdateValue: z.ZodObject<z.objectUtil.extendSha
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | null | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | null | undefined;
 }>;
-export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+export declare const GenericAddressValue: z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodString>;
+    addressLine1: z.ZodOptional<z.ZodString>;
+    addressLine2: z.ZodOptional<z.ZodString>;
+    addressLine3: z.ZodOptional<z.ZodString>;
+    postcodeOrZip: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | undefined;
+    addressLine1?: string | undefined;
+    addressLine2?: string | undefined;
+    addressLine3?: string | undefined;
+    postcodeOrZip?: string | undefined;
+}, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | undefined;
+    addressLine1?: string | undefined;
+    addressLine2?: string | undefined;
+    addressLine3?: string | undefined;
+    postcodeOrZip?: string | undefined;
+}>;
+export declare const AddressFieldValue: z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -138,6 +186,7 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -148,6 +197,7 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -157,6 +207,7 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
     zipCode?: string | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -165,18 +216,82 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
+}>]>, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodString>;
+    addressLine1: z.ZodOptional<z.ZodString>;
+    addressLine2: z.ZodOptional<z.ZodString>;
+    addressLine3: z.ZodOptional<z.ZodString>;
+    postcodeOrZip: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | undefined;
+    addressLine1?: string | undefined;
+    addressLine2?: string | undefined;
+    addressLine3?: string | undefined;
+    postcodeOrZip?: string | undefined;
+}, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | undefined;
+    addressLine1?: string | undefined;
+    addressLine2?: string | undefined;
+    addressLine3?: string | undefined;
+    postcodeOrZip?: string | undefined;
 }>]>;
-export declare const AddressFieldUpdateValue: z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+export declare const GenericAddressUpdateValue: z.ZodObject<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine3: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    postcodeOrZip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}>;
+export declare const AddressFieldUpdateValue: z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -189,6 +304,7 @@ export declare const AddressFieldUpdateValue: z.ZodDiscriminatedUnion<"urbanOrRu
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -199,6 +315,7 @@ export declare const AddressFieldUpdateValue: z.ZodDiscriminatedUnion<"urbanOrRu
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -208,6 +325,7 @@ export declare const AddressFieldUpdateValue: z.ZodDiscriminatedUnion<"urbanOrRu
     zipCode?: string | null | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -216,15 +334,47 @@ export declare const AddressFieldUpdateValue: z.ZodDiscriminatedUnion<"urbanOrRu
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | null | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | null | undefined;
+}>]>, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine3: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    postcodeOrZip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}, {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
 }>]>;
 export type AddressFieldValue = z.infer<typeof AddressFieldValue>;
 export declare const FileFieldValueWithOption: z.ZodObject<{

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