@opencrvs/toolkit 1.8.0-rc.f876361 → 1.8.0-rc.f8a9481

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

@@ -2,30 +2,6 @@ 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 PageConfigBase: z.ZodObject<{
-    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>>;
-}, "strip", z.ZodTypeAny, {
-    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[];
-    conditional?: import(".").JSONSchema | undefined;
-}>;
 export declare const FormPageConfig: z.ZodObject<z.objectUtil.extendShape<{
     id: z.ZodString;
     title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {

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

@@ -6,12 +6,12 @@ import { FieldValue } from './FieldValue';
 /**
  * Available system variables for configuration.
  */
-export interface MetaFields {
+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
@@ -21,12 +21,12 @@ export interface MetaFields {
 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 FlattenedMetaFields = FlattenedKeyStrings<MetaFields>;
+export type FlattenenedSystemVariables = FlattenedKeyStrings<SystemVariables>;
 /**
  * Default value for a field when configuring a form.
  */
-export type FieldConfigDefaultValue = FieldValue | FlattenedMetaFields | Record<string, FlattenedMetaFields | FieldValue>;
-export declare function isTemplateVariable(value: FieldConfigDefaultValue): value is FlattenedMetaFields;
+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.

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

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

@@ -234,19 +234,24 @@ export declare const defineConfig: (config: EventConfigInput) => {
             label: import("./TranslationConfig").TranslationConfig;
             emptyValueMessage?: import("./TranslationConfig").TranslationConfig | undefined;
         };
-        fields: {
+        fields: ({
+            fieldId: string;
+            conditionals?: {
+                type: "SHOW";
+                conditional: import(".").JSONSchema;
+            }[] | undefined;
+            emptyValueMessage?: import("./TranslationConfig").TranslationConfig | undefined;
+        } | {
             id: string;
             value: import("./TranslationConfig").TranslationConfig;
             label: import("./TranslationConfig").TranslationConfig;
+            conditionals?: {
+                type: "SHOW";
+                conditional: import(".").JSONSchema;
+            }[] | undefined;
             emptyValueMessage?: import("./TranslationConfig").TranslationConfig | undefined;
-        }[];
+        })[];
     };
-    workqueues: {
-        id: string;
-        filters: {
-            status: ("ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED")[];
-        }[];
-    }[];
     deduplication: {
         id: string;
         label: import("./TranslationConfig").TranslationConfig;

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

@@ -30,6 +30,7 @@ export * from './Conditional';
 export * from './AdvancedSearchConfig';
 export * from './test.utils';
 export * from './TemplateConfig';
+export * from './scopes';
 export * from '../conditionals/conditionals';
 export * from '../conditionals/validate';
 //# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,25 @@
+import { Scope } from '../scopes';
+import { ActionType } from './ActionType';
+export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
+export declare const CONFIG_GET_ALLOWED_SCOPES: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records", "config", "config.update:all"];
+export declare const ACTION_ALLOWED_SCOPES: {
+    READ: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records"];
+    CREATE: ["record.declare-birth", "record.declaration-submit-incomplete", "record.declaration-submit-for-review"];
+    NOTIFY: ["record.declaration-submit-incomplete"];
+    DECLARE: ["record.declare-birth", "record.declaration-submit-for-approval", "record.register"];
+    DELETE: ["record.declare-birth"];
+    VALIDATE: ["record.declaration-submit-for-approval", "record.register"];
+    REGISTER: ["record.register"];
+    PRINT_CERTIFICATE: ["record.registration-print&issue-certified-copies"];
+    REQUEST_CORRECTION: ["record.registration-request-correction"];
+    REJECT_CORRECTION: ["record.registration-correct"];
+    APPROVE_CORRECTION: ["record.registration-correct"];
+    MARKED_AS_DUPLICATE: ["record.declaration-archive"];
+    ARCHIVE: ["record.declaration-archive"];
+    REJECT: ["record.declaration-submit-for-updates"];
+    ASSIGN: null;
+    UNASSIGN: null;
+    DETECT_DUPLICATE: [];
+};
+export declare function filterUnallowedActions(actions: ActionType[], userScopes: Scope[]): ActionType[];
+//# sourceMappingURL=scopes.d.ts.map

package/dist/commons/events/test.utils.d.ts

@@ -1,5 +1,5 @@
 import { ActionDocument, ActionUpdate } from './ActionDocument';
-import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
+import { ArchiveActionInput, AssignActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
 import { Draft } from './Draft';
 import { EventConfig } from './EventConfig';
@@ -8,7 +8,7 @@ import { EventIndex } from './EventIndex';
 import { EventInput } from './EventInput';
 import { FieldValue } from './FieldValue';
 import { TranslationConfig } from './TranslationConfig';
-export declare function generateActionInput(configuration: EventConfig, action: ActionType): import("lodash").Dictionary<string | number | boolean | {
+export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType): import("lodash").Dictionary<string | number | boolean | {
     type: string;
     filename: string;
     originalFilename: string;
@@ -46,7 +46,7 @@ export declare function generateActionInput(configuration: EventConfig, action:
     filename: string;
     originalFilename: string;
 }[] | undefined>;
-export declare function generateActionMetadataInput(configuration: EventConfig, action: ActionType): {};
+export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType): {};
 export declare const eventPayloadGenerator: {
     create: (input?: Partial<EventInput>) => {
         transactionId: string;
@@ -57,116 +57,10 @@ export declare const eventPayloadGenerator: {
         type: string;
         id: string;
     };
-    draft: (eventId: string, input?: Partial<Draft>) => {
-        id: import("../uuid").UUID;
+    draft: ({ eventId, actionType }: {
         eventId: string;
-        createdAt: string;
-        transactionId: import("../uuid").UUID;
-        action: {
-            type: "REQUEST_CORRECTION";
-            declaration: {
-                'applicant.firstname': string;
-                'applicant.surname': string;
-                'applicant.dob': string;
-                'recommender.none': boolean;
-            };
-            annotation: {
-                'correction.requester.relationship': string;
-                'correction.request.reason': string;
-            };
-            createdAt: string;
-            createdBy: string;
-            createdAtLocation: string;
-        };
-    } & Partial<{
-        id: string;
-        createdAt: string;
-        eventId: string;
-        transactionId: string;
-        action: {
-            type: "DECLARE" | "REGISTER" | "VALIDATE" | "DELETE" | "CREATE" | "NOTIFY" | "DETECT_DUPLICATE" | "REJECT" | "MARKED_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION" | "READ" | "ASSIGN" | "UNASSIGN";
-            createdAt: string;
-            createdBy: string;
-            declaration: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: 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;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[] | undefined>;
-            createdAtLocation: string;
-            annotation?: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: 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;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[] | undefined> | undefined;
-            originalActionId?: string | undefined;
-        };
-    }>;
+        actionType: ActionType;
+    }, input?: Partial<Draft>) => Draft;
     actions: {
         declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation">>) => {
             type: "DECLARE";
@@ -306,6 +200,20 @@ export declare const eventPayloadGenerator: {
             duplicates: never[];
             eventId: string;
         };
+        assign: (eventId: string, input?: Partial<Pick<AssignActionInput, "transactionId" | "assignedTo">>) => {
+            type: "ASSIGN";
+            transactionId: string;
+            declaration: {};
+            assignedTo: string;
+            eventId: string;
+        };
+        unassign: (eventId: string, input?: Partial<Pick<UnassignActionInput, "transactionId">>) => {
+            type: "UNASSIGN";
+            transactionId: string;
+            declaration: {};
+            assignedTo: null;
+            eventId: string;
+        };
         archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration">>, isDuplicate?: boolean) => {
             type: "ARCHIVE";
             transactionId: string;