@opencrvs/toolkit 1.8.0-rc.f9911ed → 1.8.0-rc.f9d33b7

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

@@ -1,29 +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";
 };
-/**
- * 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>;
+/** 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/AdvancedSearchConfig.d.ts

@@ -1,51 +1,397 @@
 import { z } from 'zod';
 import { TranslationConfig } from './TranslationConfig';
+export declare const MatchType: z.ZodEnum<["FUZZY", "EXACT", "RANGE", "ANY_OF"]>;
+export type MatchType = z.infer<typeof MatchType>;
+export declare const FieldConfigSchema: z.ZodObject<z.objectUtil.extendShape<{
+    config: z.ZodObject<{
+        type: z.ZodEnum<["FUZZY", "EXACT", "RANGE", "ANY_OF"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        label: TranslationConfig;
+    }, {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }>, "many">>;
+}, {
+    fieldId: z.ZodString;
+    fieldType: z.ZodLiteral<"field">;
+}>, "strip", z.ZodTypeAny, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: string;
+    fieldType: "field";
+    options?: {
+        value: string;
+        label: TranslationConfig;
+    }[] | undefined;
+}, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: string;
+    fieldType: "field";
+    options?: {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }[] | undefined;
+}>;
+export declare const EventFieldId: z.ZodEnum<["trackingId", "status"]>;
+export type EventFieldId = z.infer<typeof EventFieldId>;
+export declare const EventFieldConfigSchema: z.ZodObject<z.objectUtil.extendShape<{
+    config: z.ZodObject<{
+        type: z.ZodEnum<["FUZZY", "EXACT", "RANGE", "ANY_OF"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        label: TranslationConfig;
+    }, {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }>, "many">>;
+}, {
+    fieldId: z.ZodEnum<["trackingId", "status"]>;
+    fieldType: z.ZodLiteral<"event">;
+}>, "strip", z.ZodTypeAny, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: "status" | "trackingId";
+    fieldType: "event";
+    options?: {
+        value: string;
+        label: TranslationConfig;
+    }[] | undefined;
+}, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: "status" | "trackingId";
+    fieldType: "event";
+    options?: {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }[] | undefined;
+}>;
+export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObject<z.objectUtil.extendShape<{
+    config: z.ZodObject<{
+        type: z.ZodEnum<["FUZZY", "EXACT", "RANGE", "ANY_OF"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        label: TranslationConfig;
+    }, {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }>, "many">>;
+}, {
+    fieldId: z.ZodString;
+    fieldType: z.ZodLiteral<"field">;
+}>, "strip", z.ZodTypeAny, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: string;
+    fieldType: "field";
+    options?: {
+        value: string;
+        label: TranslationConfig;
+    }[] | undefined;
+}, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: string;
+    fieldType: "field";
+    options?: {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }[] | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    config: z.ZodObject<{
+        type: z.ZodEnum<["FUZZY", "EXACT", "RANGE", "ANY_OF"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }, {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    }>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        label: TranslationConfig;
+    }, {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }>, "many">>;
+}, {
+    fieldId: z.ZodEnum<["trackingId", "status"]>;
+    fieldType: z.ZodLiteral<"event">;
+}>, "strip", z.ZodTypeAny, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: "status" | "trackingId";
+    fieldType: "event";
+    options?: {
+        value: string;
+        label: TranslationConfig;
+    }[] | undefined;
+}, {
+    config: {
+        type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+    };
+    fieldId: "status" | "trackingId";
+    fieldType: "event";
+    options?: {
+        value: string;
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }[] | undefined;
+}>]>;
+export type SearchField = z.infer<typeof SearchField>;
 export declare const AdvancedSearchConfig: z.ZodObject<{
     title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
         id: string;
         description: string;
         defaultMessage: string;
     }>;
-    fields: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
-        fieldId: z.ZodString;
-        config: z.ZodOptional<z.ZodObject<{
-            type: z.ZodEnum<["FUZZY", "EXACT", "RANGE"]>;
+    fields: z.ZodArray<z.ZodDiscriminatedUnion<"fieldType", [z.ZodObject<z.objectUtil.extendShape<{
+        config: z.ZodObject<{
+            type: z.ZodEnum<["FUZZY", "EXACT", "RANGE", "ANY_OF"]>;
         }, "strip", z.ZodTypeAny, {
-            type: "FUZZY" | "EXACT" | "RANGE";
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
         }, {
-            type: "FUZZY" | "EXACT" | "RANGE";
-        }>>;
-    }, "strip", z.ZodTypeAny, {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        }>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            label: TranslationConfig;
+        }, {
+            value: string;
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }>, "many">>;
+    }, {
+        fieldId: z.ZodString;
+        fieldType: z.ZodLiteral<"field">;
+    }>, "strip", z.ZodTypeAny, {
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
         fieldId: string;
-        config?: {
-            type: "FUZZY" | "EXACT" | "RANGE";
-        } | undefined;
+        fieldType: "field";
+        options?: {
+            value: string;
+            label: TranslationConfig;
+        }[] | undefined;
     }, {
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
         fieldId: string;
-        config?: {
-            type: "FUZZY" | "EXACT" | "RANGE";
-        } | undefined;
-    }>, "many">>>;
+        fieldType: "field";
+        options?: {
+            value: string;
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }[] | undefined;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        config: z.ZodObject<{
+            type: z.ZodEnum<["FUZZY", "EXACT", "RANGE", "ANY_OF"]>;
+        }, "strip", z.ZodTypeAny, {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        }, {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        }>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            label: TranslationConfig;
+        }, {
+            value: string;
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }>, "many">>;
+    }, {
+        fieldId: z.ZodEnum<["trackingId", "status"]>;
+        fieldType: z.ZodLiteral<"event">;
+    }>, "strip", z.ZodTypeAny, {
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
+        fieldId: "status" | "trackingId";
+        fieldType: "event";
+        options?: {
+            value: string;
+            label: TranslationConfig;
+        }[] | undefined;
+    }, {
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
+        fieldId: "status" | "trackingId";
+        fieldType: "event";
+        options?: {
+            value: string;
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }[] | undefined;
+    }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     title: TranslationConfig;
-    fields: {
+    fields: ({
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
         fieldId: string;
-        config?: {
-            type: "FUZZY" | "EXACT" | "RANGE";
-        } | undefined;
-    }[];
+        fieldType: "field";
+        options?: {
+            value: string;
+            label: TranslationConfig;
+        }[] | undefined;
+    } | {
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
+        fieldId: "status" | "trackingId";
+        fieldType: "event";
+        options?: {
+            value: string;
+            label: TranslationConfig;
+        }[] | undefined;
+    })[];
 }, {
     title: {
         id: string;
         description: string;
         defaultMessage: string;
     };
-    fields?: {
+    fields: ({
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
         fieldId: string;
-        config?: {
-            type: "FUZZY" | "EXACT" | "RANGE";
-        } | undefined;
-    }[] | undefined;
+        fieldType: "field";
+        options?: {
+            value: string;
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }[] | undefined;
+    } | {
+        config: {
+            type: "FUZZY" | "EXACT" | "RANGE" | "ANY_OF";
+        };
+        fieldId: "status" | "trackingId";
+        fieldType: "event";
+        options?: {
+            value: string;
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }[] | undefined;
+    })[];
 }>;
+export type AdvancedSearchConfigInput = z.infer<typeof AdvancedSearchConfig>;
 export type AdvancedSearchConfig = z.infer<typeof AdvancedSearchConfig>;
 //# sourceMappingURL=AdvancedSearchConfig.d.ts.map

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

@@ -117,6 +117,7 @@ export declare const UrbanAddressUpdateValue: z.ZodObject<z.objectUtil.extendSha
     street?: string | null | undefined;
     zipCode?: string | null | undefined;
 }>;
+export type UrbanAddressUpdateValue = z.infer<typeof UrbanAddressUpdateValue>;
 export declare const RuralAddressUpdateValue: z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
     addressType: z.ZodLiteral<"DOMESTIC">;
@@ -140,6 +141,7 @@ export declare const RuralAddressUpdateValue: z.ZodObject<z.objectUtil.extendSha
     urbanOrRural: "RURAL";
     village?: string | null | undefined;
 }>;
+export type RuralAddressUpdateValue = z.infer<typeof RuralAddressUpdateValue>;
 export declare const GenericAddressValue: z.ZodObject<{
     country: z.ZodString;
     addressType: z.ZodLiteral<"INTERNATIONAL">;
@@ -289,6 +291,7 @@ export declare const GenericAddressUpdateValue: z.ZodObject<{
     addressLine3?: string | null | undefined;
     postcodeOrZip?: string | null | undefined;
 }>;
+export type GenericAddressUpdateValue = z.infer<typeof GenericAddressUpdateValue>;
 export declare const AddressFieldUpdateValue: z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
     addressType: z.ZodLiteral<"DOMESTIC">;

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