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

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/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/defineConfig.d.ts

@@ -46,7 +46,7 @@ export declare const defineConfig: (config: EventConfigInput) => {
         };
         draft?: boolean | undefined;
     } | {
-        type: "REGISTER";
+        type: "REJECT";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -55,13 +55,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
             conditional: import(".").JSONSchema;
         })[];
         label: import("./TranslationConfig").TranslationConfig;
-        review: {
-            title: import("./TranslationConfig").TranslationConfig;
-            fields: import("./FieldConfig").Inferred[];
-        };
         draft?: boolean | undefined;
     } | {
-        type: "REJECT";
+        type: "MARKED_AS_DUPLICATE";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -72,7 +68,7 @@ export declare const defineConfig: (config: EventConfigInput) => {
         label: import("./TranslationConfig").TranslationConfig;
         draft?: boolean | undefined;
     } | {
-        type: "MARKED_AS_DUPLICATE";
+        type: "ARCHIVE";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -83,7 +79,7 @@ export declare const defineConfig: (config: EventConfigInput) => {
         label: import("./TranslationConfig").TranslationConfig;
         draft?: boolean | undefined;
     } | {
-        type: "ARCHIVE";
+        type: "REGISTER";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -92,6 +88,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
             conditional: import(".").JSONSchema;
         })[];
         label: import("./TranslationConfig").TranslationConfig;
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: import("./FieldConfig").Inferred[];
+        };
         draft?: boolean | undefined;
     } | {
         type: "DELETE";
@@ -255,10 +255,14 @@ export declare const defineConfig: (config: EventConfigInput) => {
     advancedSearch: {
         title: import("./TranslationConfig").TranslationConfig;
         fields: {
-            fieldId: string;
-            config?: {
+            config: {
                 type: "FUZZY" | "EXACT" | "RANGE";
-            } | undefined;
+            };
+            fieldId: string;
+            options?: {
+                value: string;
+                label: import("./TranslationConfig").TranslationConfig;
+            }[] | undefined;
         }[];
     }[];
 };

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;

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

@@ -1,23 +1,13 @@
-import { ActionType, DeclarationAction } from './ActionType';
+import { ActionType, DeclarationActionType } from './ActionType';
 import { EventConfig } from './EventConfig';
 import { FieldConfig } from './FieldConfig';
 import { WorkqueueConfig } from './WorkqueueConfig';
-import { ActionUpdate, EventState } from './ActionDocument';
+import { Action, ActionUpdate, EventState } from './ActionDocument';
 import { PageConfig, VerificationPageConfig } from './PageConfig';
 import { Draft } from './Draft';
 import { EventDocument } from './EventDocument';
 import { ActionConfig } from './ActionConfig';
 import { FormConfig } from './FormConfig';
-/**
- * @returns All the fields in the event configuration.
- */
-export declare const findAllFields: (config: EventConfig) => FieldConfig[];
-export declare const getAllAnnotationFields: (config: EventConfig) => FieldConfig[];
-export declare const getActionAnnotationFields: (actionConfig: ActionConfig) => import("./FieldConfig").Inferred[];
-/**
- * @TODO: Request correction should have same format as print certificate
- */
-export declare const findRecordActionPages: (config: EventConfig, actionType: ActionType) => PageConfig[];
 export declare function getDeclarationFields(configuration: EventConfig): FieldConfig[];
 export declare function getDeclarationPages(configuration: EventConfig): {
     type: "FORM";
@@ -36,15 +26,58 @@ export declare function getDeclaration(configuration: EventConfig): {
         conditional?: import(".").JSONSchema | undefined;
     }[];
 };
-export declare function getActionReviewFields(configuration: EventConfig, actionType: DeclarationAction): import("./FieldConfig").Inferred[];
+export declare const getActionAnnotationFields: (actionConfig: ActionConfig) => import("./FieldConfig").Inferred[];
+export declare const getAllAnnotationFields: (config: EventConfig) => FieldConfig[];
+/**
+ * @TODO: Request correction should have same format as print certificate
+ */
+export declare const findRecordActionPages: (config: EventConfig, actionType: ActionType) => PageConfig[];
 export declare function getActionReview(configuration: EventConfig, actionType: ActionType): {
     title: import("./TranslationConfig").TranslationConfig;
     fields: import("./FieldConfig").Inferred[];
 };
+export declare function getActionReviewFields(configuration: EventConfig, actionType: DeclarationActionType): import("./FieldConfig").Inferred[];
 export declare function validateWorkqueueConfig(workqueueConfigs: WorkqueueConfig[]): void;
 export declare function isPageVisible(page: PageConfig, formValues: ActionUpdate): boolean;
-export declare const getVisiblePagesFormFields: (formConfig: FormConfig, formData: ActionUpdate) => import("./FieldConfig").Inferred[];
-export declare function stripHiddenFields(fields: FieldConfig[], declaration: EventState): import("lodash").Dictionary<string | number | boolean | {
+export declare function omitHiddenFields(fields: FieldConfig[], values: EventState): import("lodash").Dictionary<string | number | boolean | {
+    type: string;
+    filename: string;
+    originalFilename: string;
+} | {
+    country: string;
+    district: string;
+    addressType: "DOMESTIC";
+    province: string;
+    urbanOrRural: "URBAN";
+    number?: string | undefined;
+    town?: string | undefined;
+    residentialArea?: string | undefined;
+    street?: string | undefined;
+    zipCode?: string | undefined;
+} | {
+    country: string;
+    district: string;
+    addressType: "DOMESTIC";
+    province: string;
+    urbanOrRural: "RURAL";
+    village?: string | undefined;
+} | {
+    country: string;
+    state: string;
+    addressType: "INTERNATIONAL";
+    district2: string;
+    cityOrTown?: string | undefined;
+    addressLine1?: string | undefined;
+    addressLine2?: string | undefined;
+    addressLine3?: string | undefined;
+    postcodeOrZip?: string | undefined;
+} | {
+    type: string;
+    option: string;
+    filename: string;
+    originalFilename: string;
+}[] | undefined>;
+export declare function omitHiddenPaginatedFields(formConfig: FormConfig, declaration: EventState): import("lodash").Dictionary<string | number | boolean | {
     type: string;
     filename: string;
     originalFilename: string;
@@ -89,6 +122,7 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
     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";
+        status: "Rejected" | "Requested" | "Accepted";
         createdAt: string;
         createdBy: string;
         declaration: Record<string, string | number | boolean | {
@@ -129,7 +163,6 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
             filename: string;
             originalFilename: string;
         }[] | undefined>;
-        createdAtLocation: string;
         annotation?: Record<string, string | number | boolean | {
             type: string;
             filename: string;
@@ -168,6 +201,8 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
             filename: string;
             originalFilename: string;
         }[] | undefined> | undefined;
+        createdAtLocation?: string | undefined;
+        updatedAtLocation?: string | undefined;
         originalActionId?: string | undefined;
     };
 }[];
@@ -186,42 +221,13 @@ export declare function createEmptyDraft(eventId: string, draftId: string, actio
     };
 };
 export declare function isVerificationPage(page: PageConfig): page is VerificationPageConfig;
-export declare function deepMerge(currentDocument: ActionUpdate, actionDocument: ActionUpdate): 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>;
+export declare function deepMerge<T extends Record<string, unknown>>(currentDocument: T, actionDocument: T): T;
+export declare function findLastAssignmentAction(actions: Action[]): Action | undefined;
+/** Tell compiler that accessing record with arbitrary key might result to undefined
+ * Use when you **cannot guarantee**  that key exists in the record
+ */
+export type IndexMap<T> = {
+    [id: string]: T | undefined;
+};
+export declare function isWriteAction(actionType: ActionType): boolean;
 //# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utils.test.d.ts.map