@opencrvs/toolkit 1.8.0-rc.feaeeb7 → 1.8.0-rc.fef85f2

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

@@ -0,0 +1,335 @@
+import { z } from 'zod';
+import { TranslationConfig } from './TranslationConfig';
+export declare const PageTypes: z.ZodEnum<["FORM", "VERIFICATION"]>;
+export type PageType = z.infer<typeof PageTypes>;
+export declare const FormPageConfig: z.ZodObject<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>;
+    fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").InferredInput>, "many">;
+    conditional: z.ZodOptional<z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>>;
+}, {
+    type: z.ZodDefault<z.ZodLiteral<"FORM">>;
+}>, "strip", z.ZodTypeAny, {
+    type: "FORM";
+    id: string;
+    title: TranslationConfig;
+    fields: import("./FieldConfig").Inferred[];
+    conditional?: import(".").JSONSchema | undefined;
+}, {
+    id: string;
+    title: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    };
+    fields: import("./FieldConfig").InferredInput[];
+    type?: "FORM" | undefined;
+    conditional?: import(".").JSONSchema | undefined;
+}>;
+export type FormPageConfig = z.infer<typeof FormPageConfig>;
+export type FormPageConfigInput = z.input<typeof FormPageConfig>;
+export declare const VerificationActionConfig: z.ZodObject<{
+    verify: z.ZodObject<{
+        label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        label: TranslationConfig;
+    }, {
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    }>;
+    cancel: z.ZodObject<{
+        label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+        confirmation: z.ZodObject<{
+            title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            }>;
+            body: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            title: TranslationConfig;
+            body: TranslationConfig;
+        }, {
+            title: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+            body: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        label: TranslationConfig;
+        confirmation: {
+            title: TranslationConfig;
+            body: TranslationConfig;
+        };
+    }, {
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+        confirmation: {
+            title: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+            body: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    verify: {
+        label: TranslationConfig;
+    };
+    cancel: {
+        label: TranslationConfig;
+        confirmation: {
+            title: TranslationConfig;
+            body: TranslationConfig;
+        };
+    };
+}, {
+    verify: {
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+    };
+    cancel: {
+        label: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+        confirmation: {
+            title: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+            body: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        };
+    };
+}>;
+export declare const VerificationPageConfig: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>;
+    fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").InferredInput>, "many">;
+    conditional: z.ZodOptional<z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>>;
+}, {
+    type: z.ZodDefault<z.ZodLiteral<"FORM">>;
+}>, {
+    type: z.ZodLiteral<"VERIFICATION">;
+    actions: z.ZodObject<{
+        verify: z.ZodObject<{
+            label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            label: TranslationConfig;
+        }, {
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        }>;
+        cancel: z.ZodObject<{
+            label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            }>;
+            confirmation: z.ZodObject<{
+                title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                }>;
+                body: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            }, {
+                title: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+                body: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            label: TranslationConfig;
+            confirmation: {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            };
+        }, {
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+            confirmation: {
+                title: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+                body: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+            };
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        verify: {
+            label: TranslationConfig;
+        };
+        cancel: {
+            label: TranslationConfig;
+            confirmation: {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            };
+        };
+    }, {
+        verify: {
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        };
+        cancel: {
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+            confirmation: {
+                title: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+                body: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+            };
+        };
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "VERIFICATION";
+    id: string;
+    title: TranslationConfig;
+    actions: {
+        verify: {
+            label: TranslationConfig;
+        };
+        cancel: {
+            label: TranslationConfig;
+            confirmation: {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            };
+        };
+    };
+    fields: import("./FieldConfig").Inferred[];
+    conditional?: import(".").JSONSchema | undefined;
+}, {
+    type: "VERIFICATION";
+    id: string;
+    title: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    };
+    actions: {
+        verify: {
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+        };
+        cancel: {
+            label: {
+                id: string;
+                description: string;
+                defaultMessage: string;
+            };
+            confirmation: {
+                title: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+                body: {
+                    id: string;
+                    description: string;
+                    defaultMessage: string;
+                };
+            };
+        };
+    };
+    fields: import("./FieldConfig").InferredInput[];
+    conditional?: import(".").JSONSchema | undefined;
+}>;
+export type VerificationPageConfig = z.infer<typeof VerificationPageConfig>;
+type AllPageConfig = typeof VerificationPageConfig | typeof FormPageConfig;
+export declare const PageConfig: z.ZodDiscriminatedUnion<"type", AllPageConfig[]>;
+export type PageConfig = z.infer<typeof PageConfig>;
+export type PageConfigInput = z.input<typeof PageConfig>;
+export {};
+//# sourceMappingURL=PageConfig.d.ts.map

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

@@ -30,7 +30,23 @@ export declare const SummaryConfig: z.ZodObject<{
             defaultMessage: string;
         } | undefined;
     }>;
-    fields: z.ZodArray<z.ZodObject<{
+    fields: z.ZodArray<z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+        emptyValueMessage: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>>;
+        conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+            type: z.ZodLiteral<"SHOW">;
+            conditional: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
+        }, "strip", z.ZodTypeAny, {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }, {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }>, "many">>>;
+    }, {
         id: z.ZodString;
         value: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
             id: string;
@@ -47,10 +63,14 @@ export declare const SummaryConfig: z.ZodObject<{
             description: string;
             defaultMessage: string;
         }>>;
-    }, "strip", z.ZodTypeAny, {
+    }>, "strip", z.ZodTypeAny, {
         id: string;
         value: TranslationConfig;
         label: TranslationConfig;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
         emptyValueMessage?: TranslationConfig | undefined;
     }, {
         id: string;
@@ -64,24 +84,75 @@ export declare const SummaryConfig: z.ZodObject<{
             description: string;
             defaultMessage: string;
         };
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
+        emptyValueMessage?: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        } | undefined;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        emptyValueMessage: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>>;
+        conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+            type: z.ZodLiteral<"SHOW">;
+            conditional: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
+        }, "strip", z.ZodTypeAny, {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }, {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }>, "many">>>;
+    }, {
+        fieldId: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        fieldId: string;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
+        emptyValueMessage?: TranslationConfig | undefined;
+    }, {
+        fieldId: string;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
         emptyValueMessage?: {
             id: string;
             description: string;
             defaultMessage: string;
         } | undefined;
-    }>, "many">;
+    }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     title: {
         id: string;
         label: TranslationConfig;
         emptyValueMessage?: TranslationConfig | undefined;
     };
-    fields: {
+    fields: ({
+        fieldId: string;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
+        emptyValueMessage?: TranslationConfig | undefined;
+    } | {
         id: string;
         value: TranslationConfig;
         label: TranslationConfig;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
         emptyValueMessage?: TranslationConfig | undefined;
-    }[];
+    })[];
 }, {
     title: {
         id: string;
@@ -96,7 +167,18 @@ export declare const SummaryConfig: z.ZodObject<{
             defaultMessage: string;
         } | undefined;
     };
-    fields: {
+    fields: ({
+        fieldId: string;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
+        emptyValueMessage?: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        } | undefined;
+    } | {
         id: string;
         value: {
             id: string;
@@ -108,12 +190,16 @@ export declare const SummaryConfig: z.ZodObject<{
             description: string;
             defaultMessage: string;
         };
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
         emptyValueMessage?: {
             id: string;
             description: string;
             defaultMessage: string;
         } | undefined;
-    }[];
+    })[];
 }>;
 export type SummaryConfig = z.infer<typeof SummaryConfig>;
 //# sourceMappingURL=SummaryConfig.d.ts.map

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

@@ -1,18 +1,38 @@
+/**
+ * TemplateConfig defines configuration rules for system-based variables (e.g. $user.province).
+ * They are currently used for providing default values in FieldConfig.
+ */
 import { FieldValue } from './FieldValue';
-export type DefaultValue = FieldValue | MetaFieldsDotted | Record<string, MetaFieldsDotted | FieldValue>;
-export declare function isTemplateVariable(value: DefaultValue): value is MetaFieldsDotted;
-export declare function isFieldValue(value: DefaultValue): value is FieldValue;
-export declare function isFieldValueWithoutTemplates(value: DefaultValue): value is FieldValue;
-export declare function isDefaultValue(value: any): value is DefaultValue;
-export interface MetaFields {
+/**
+ * Available system variables for configuration.
+ */
+export type SystemVariables = {
     $user: {
         province: string;
         district: string;
     };
-}
-type DottedKeys<T, Prefix extends string = ''> = {
-    [K in keyof T]: T[K] extends Record<string, string> ? DottedKeys<T[K], `${Prefix}${K & string}.`> : `${Prefix}${K & string}`;
+};
+/**
+ * Recursively flatten the keys of an object. Used to limit types when configuring default values in country config.
+ * @example
+ * type Test = FlattenedKeyStrings<{ a: { b: string, c: { d: string } } }>
+ * // 'a.b' | 'a.c.d' but not 'a' or 'a.c'
+ */
+type FlattenedKeyStrings<T, Prefix extends string = ''> = {
+    [K in keyof T]: T[K] extends Record<string, any> ? FlattenedKeyStrings<T[K], `${Prefix}${K & string}.`> : `${Prefix}${K & string}`;
 }[keyof T];
-export type MetaFieldsDotted = DottedKeys<MetaFields>;
+export type FlattenenedSystemVariables = FlattenedKeyStrings<SystemVariables>;
+/**
+ * Default value for a field when configuring a form.
+ */
+export type FieldConfigDefaultValue = FieldValue | FlattenenedSystemVariables | Record<string, FlattenenedSystemVariables | FieldValue>;
+export declare function isTemplateVariable(value: FieldConfigDefaultValue): value is FlattenenedSystemVariables;
+export declare function isFieldValue(value: FieldConfigDefaultValue): value is FieldValue;
+/**
+ * Checks if given value is valid for a field, and known template variables are already resolved.
+ * @todo: Extend functionality to arbitrary depth objects. Currently only checks first level since our compoosite fields are only 1 level deep.
+ */
+export declare function isFieldValueWithoutTemplates(value: FieldConfigDefaultValue): value is FieldValue;
+export declare function isFieldConfigDefaultValue(value: any): value is FieldConfigDefaultValue;
 export {};
 //# sourceMappingURL=TemplateConfig.d.ts.map

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

@@ -6,5 +6,10 @@ export type User = {
         family: string;
     }[];
     role: string;
+    /**
+     * The filename of the user's signature stored in MinIO, ex: 'a552f64a-31c4-4e78-b44f-292c3179e2ef.png'.
+     * This is used to retrieve the signature file from storage.
+     */
+    signatureFilename?: string;
 };
 //# sourceMappingURL=User.d.ts.map