@opencrvs/toolkit 1.8.0-rc.fe799b0 → 1.8.0-rc.fea3888

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

@@ -1,36 +1,23 @@
 import { z } from 'zod';
 import { TranslationConfig } from './TranslationConfig';
 export declare const SummaryConfig: z.ZodObject<{
-    title: z.ZodObject<{
-        id: z.ZodString;
-        label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
-            id: string;
-            description: string;
-            defaultMessage: string;
-        }>;
+    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;
         }>>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        label: TranslationConfig;
-        emptyValueMessage?: TranslationConfig | undefined;
+        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: string;
-        label: {
-            id: string;
-            description: string;
-            defaultMessage: string;
-        };
-        emptyValueMessage?: {
-            id: string;
-            description: string;
-            defaultMessage: string;
-        } | undefined;
-    }>;
-    fields: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         value: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
             id: string;
@@ -47,10 +34,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,39 +55,83 @@ 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;
-    }>, "many">;
+    }>, 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">;
 }, "strip", z.ZodTypeAny, {
-    title: {
-        id: string;
-        label: TranslationConfig;
+    fields: ({
+        fieldId: string;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
         emptyValueMessage?: TranslationConfig | undefined;
-    };
-    fields: {
+    } | {
         id: string;
         value: TranslationConfig;
         label: TranslationConfig;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
         emptyValueMessage?: TranslationConfig | undefined;
-    }[];
+    })[];
 }, {
-    title: {
-        id: string;
-        label: {
-            id: string;
-            description: string;
-            defaultMessage: string;
-        };
+    fields: ({
+        fieldId: string;
+        conditionals?: {
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        }[] | undefined;
         emptyValueMessage?: {
             id: string;
             description: string;
             defaultMessage: string;
         } | undefined;
-    };
-    fields: {
+    } | {
         id: string;
         value: {
             id: string;
@@ -108,12 +143,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

@@ -0,0 +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';
+/**
+ * Available system variables for configuration.
+ */
+export type SystemVariables = {
+    $user: {
+        province: string;
+        district: 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 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

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

@@ -1,36 +1,60 @@
 import { z } from 'zod';
+import { TranslationConfig } from './TranslationConfig';
 /**
  * Configuration for workqueue. Workqueues are used to display a list of events.
  */
 export declare const WorkqueueConfig: z.ZodObject<{
-    id: z.ZodString;
-    filters: z.ZodArray<z.ZodObject<{
-        status: z.ZodArray<z.ZodNativeEnum<{
-            readonly CREATED: "CREATED";
-            readonly NOTIFIED: "NOTIFIED";
-            readonly DECLARED: "DECLARED";
-            readonly VALIDATED: "VALIDATED";
-            readonly REGISTERED: "REGISTERED";
-            readonly CERTIFIED: "CERTIFIED";
-            readonly REJECTED: "REJECTED";
-            readonly ARCHIVED: "ARCHIVED";
-        }>, "many">;
+    slug: z.ZodString;
+    name: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>;
+    /**
+     * Placeholder untill the following gets merged to develop
+     * https://github.com/opencrvs/opencrvs-core/blob/5fbe9854a88504a7a13fcc856b3e82594b70c38c/packages/commons/src/events/EventIndex.ts#L92-L93
+     */
+    query: z.ZodString;
+    actions: z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        conditionals: z.ZodOptional<z.ZodArray<z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>, "many">>;
     }, "strip", z.ZodTypeAny, {
-        status: ("ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED")[];
+        type: string;
+        conditionals?: import(".").JSONSchema[] | undefined;
     }, {
-        status: ("ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED")[];
+        type: string;
+        conditionals?: import(".").JSONSchema[] | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    id: string;
-    filters: {
-        status: ("ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED")[];
+    name: TranslationConfig;
+    actions: {
+        type: string;
+        conditionals?: import(".").JSONSchema[] | undefined;
     }[];
+    query: string;
+    slug: string;
 }, {
-    id: string;
-    filters: {
-        status: ("ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED")[];
+    name: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    };
+    actions: {
+        type: string;
+        conditionals?: import(".").JSONSchema[] | undefined;
     }[];
+    query: string;
+    slug: string;
 }>;
 export type WorkqueueConfig = z.infer<typeof WorkqueueConfig>;
 export type WorkqueueConfigInput = z.input<typeof WorkqueueConfig>;
+export declare function defineWorkqueue(workqueues: WorkqueueConfigInput[]): {
+    name: TranslationConfig;
+    actions: {
+        type: string;
+        conditionals?: import(".").JSONSchema[] | undefined;
+    }[];
+    query: string;
+    slug: string;
+}[];
 //# sourceMappingURL=WorkqueueConfig.d.ts.map