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

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

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

@@ -1,4 +1,33 @@
-export type User = {
+import { z } from 'zod';
+export declare const User: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodArray<z.ZodObject<{
+        use: z.ZodString;
+        given: z.ZodArray<z.ZodString, "many">;
+        family: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        use: string;
+        given: string[];
+        family: string;
+    }, {
+        use: string;
+        given: string[];
+        family: string;
+    }>, "many">;
+    role: z.ZodString;
+    avatar: z.ZodOptional<z.ZodBranded<z.ZodString, "FullDocumentPath">>;
+    signature: z.ZodOptional<z.ZodBranded<z.ZodString, "FullDocumentPath">>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: {
+        use: string;
+        given: string[];
+        family: string;
+    }[];
+    role: string;
+    signature?: (string & z.BRAND<"FullDocumentPath">) | undefined;
+    avatar?: (string & z.BRAND<"FullDocumentPath">) | undefined;
+}, {
     id: string;
     name: {
         use: string;
@@ -6,5 +35,8 @@ export type User = {
         family: string;
     }[];
     role: string;
-};
+    signature?: string | undefined;
+    avatar?: string | undefined;
+}>;
+export type User = z.infer<typeof User>;
 //# sourceMappingURL=User.d.ts.map

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

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+import { TranslationConfig } from './TranslationConfig';
+export declare const WorkqueueColumnKeysArray: readonly ["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags", "title", "outbox"];
+export declare const WorkqueueColumnKeys: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags", "title", "outbox"]>;
+export type WorkqueueColumnKeys = z.infer<typeof WorkqueueColumnKeys>;
+export declare const WorkqueueColumnValue: z.ZodObject<{
+    $event: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags", "title", "outbox"]>;
+}, "strip", z.ZodTypeAny, {
+    $event: "type" | "id" | "status" | "title" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "updatedAt" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
+}, {
+    $event: "type" | "id" | "status" | "title" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "updatedAt" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
+}>;
+export type WorkqueueColumnValue = z.infer<typeof WorkqueueColumnValue>;
+/**
+ * Configuration for column header and value of cell of workqueue.
+ */
+export declare const WorkqueueColumn: z.ZodObject<{
+    label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>;
+    value: z.ZodObject<{
+        $event: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags", "title", "outbox"]>;
+    }, "strip", z.ZodTypeAny, {
+        $event: "type" | "id" | "status" | "title" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "updatedAt" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
+    }, {
+        $event: "type" | "id" | "status" | "title" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "updatedAt" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    value: {
+        $event: "type" | "id" | "status" | "title" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "updatedAt" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
+    };
+    label: TranslationConfig;
+}, {
+    value: {
+        $event: "type" | "id" | "status" | "title" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "updatedAt" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
+    };
+    label: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    };
+}>;
+export type WorkqueueColumn = z.infer<typeof WorkqueueColumn>;
+export type WorkqueueColumnInput = z.infer<typeof WorkqueueColumn>;
+export declare function defineWorkqueuesColumns(workqueueColumns: WorkqueueColumnInput[]): {
+    value: {
+        $event: "type" | "id" | "status" | "title" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "updatedAt" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
+    };
+    label: TranslationConfig;
+}[];
+//# sourceMappingURL=WorkqueueColumnConfig.d.ts.map