@opencrvs/toolkit 1.8.0-rc.f9911ed → 1.8.0-rc.faacbde

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

@@ -1,4 +1,4 @@
-import { ActionDocument } from './ActionDocument';
+import { ActionDocument, ActionUpdate } from './ActionDocument';
 import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
 import { Draft } from './Draft';
@@ -64,13 +64,13 @@ export declare const eventPayloadGenerator: {
         transactionId: import("../uuid").UUID;
         action: {
             type: "REQUEST_CORRECTION";
-            data: {
+            declaration: {
                 'applicant.firstname': string;
                 'applicant.surname': string;
                 'applicant.dob': string;
                 'recommender.none': boolean;
             };
-            metadata: {
+            annotation: {
                 'correction.requester.relationship': string;
                 'correction.request.reason': string;
             };
@@ -84,8 +84,10 @@ export declare const eventPayloadGenerator: {
         eventId: string;
         transactionId: string;
         action: {
-            type: ActionType;
-            data: Record<string, string | number | boolean | {
+            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;
@@ -123,10 +125,8 @@ export declare const eventPayloadGenerator: {
                 filename: string;
                 originalFilename: string;
             }[] | undefined>;
-            createdAt: string;
-            createdBy: string;
             createdAtLocation: string;
-            metadata?: Record<string, string | number | boolean | {
+            annotation?: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -167,10 +167,10 @@ export declare const eventPayloadGenerator: {
         };
     }>;
     actions: {
-        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "data">>) => {
+        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation">>) => {
             type: "DECLARE";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -208,12 +208,19 @@ export declare const eventPayloadGenerator: {
                 filename: string;
                 originalFilename: string;
             }[] | undefined>;
+            annotation: {};
             eventId: string;
         };
-        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "data">>) => {
-            type: "VALIDATE";
+        /**
+         * Notify allows sending incomplete data. Think it as 'partial declare' for now.
+         */
+        notify: (eventId: string, input?: {
+            transactionId?: string;
+            declaration?: Partial<ActionUpdate>;
+        }) => {
+            type: "NOTIFY";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Partial<Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -250,14 +257,13 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
-            duplicates: never[];
+            }[] | undefined>>;
             eventId: string;
         };
-        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
-            type: "ARCHIVE";
+        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation">>) => {
+            type: "VALIDATE";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -295,60 +301,32 @@ export declare const eventPayloadGenerator: {
                 filename: string;
                 originalFilename: string;
             }[] | undefined>;
-            metadata: {
+            annotation: {};
+            duplicates: never[];
+            eventId: string;
+        };
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration">>, isDuplicate?: boolean) => {
+            type: "ARCHIVE";
+            transactionId: string;
+            declaration: {};
+            annotation: {
                 isDuplicate: boolean;
             };
             duplicates: never[];
             eventId: string;
         };
-        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "data">>) => {
+        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation">>) => {
             type: "REJECT";
             transactionId: string;
-            data: 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>;
+            declaration: {};
+            annotation: {};
             duplicates: never[];
             eventId: string;
         };
-        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data">>) => {
+        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation">>) => {
             type: "REGISTER";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -386,57 +364,21 @@ export declare const eventPayloadGenerator: {
                 filename: string;
                 originalFilename: string;
             }[] | undefined>;
+            annotation: {};
             eventId: string;
         };
-        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data" | "metadata">>) => {
+        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "annotation">>) => {
             type: "PRINT_CERTIFICATE";
             transactionId: string;
-            data: 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>;
-            metadata: {};
+            declaration: {};
+            annotation: {};
             eventId: string;
         };
         correction: {
-            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation">>) => {
                 type: "REQUEST_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
+                declaration: Record<string, string | number | boolean | {
                     type: string;
                     filename: string;
                     originalFilename: string;
@@ -474,94 +416,22 @@ export declare const eventPayloadGenerator: {
                     filename: string;
                     originalFilename: string;
                 }[] | undefined>;
-                metadata: {};
+                annotation: {};
                 eventId: string;
             };
-            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
                 type: "APPROVE_CORRECTION";
                 transactionId: string;
-                data: 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>;
+                declaration: {};
+                annotation: {};
                 eventId: string;
                 requestId: string;
             };
-            reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
                 type: "REJECT_CORRECTION";
                 transactionId: string;
-                data: 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>;
+                declaration: {};
+                annotation: {};
                 eventId: string;
                 requestId: string;
             };
@@ -577,7 +447,7 @@ export declare function generateEventDocument({ configuration, actions }: {
     configuration: EventConfig;
     actions: ActionType[];
 }): EventDocument;
-export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, data?: Record<string, FieldValue>): Draft;
+export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, declaration?: Record<string, FieldValue>): Draft;
 export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>) => EventIndex;
 export declare const generateTranslationConfig: (message: string) => TranslationConfig;
 //# sourceMappingURL=test.utils.d.ts.map

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

@@ -1,165 +1,50 @@
-import { TranslationConfig } from './TranslationConfig';
-import { ActionType } from './ActionType';
+import { ActionType, DeclarationAction } from './ActionType';
 import { EventConfig } from './EventConfig';
-import { EventConfigInput } from './EventConfigInput';
-import { EventMetadataKeys } from './EventMetadata';
 import { FieldConfig } from './FieldConfig';
 import { WorkqueueConfig } from './WorkqueueConfig';
-import { EventState } from './ActionDocument';
-import { FormConfig } from './FormConfig';
+import { ActionUpdate, EventState } from './ActionDocument';
+import { PageConfig, VerificationPageConfig } from './PageConfig';
 import { Draft } from './Draft';
 import { EventDocument } from './EventDocument';
-/**
- * @returns All the fields in the event configuration input.
- */
-export declare const findInputPageFields: (config: EventConfigInput) => {
-    id: string;
-    label: TranslationConfig;
-}[];
+import { ActionConfig } from './ActionConfig';
+import { FormConfig } from './FormConfig';
 /**
  * @returns All the fields in the event configuration.
  */
-export declare const findPageFields: (config: EventConfig) => FieldConfig[];
+export declare const findAllFields: (config: EventConfig) => FieldConfig[];
+export declare const getAllAnnotationFields: (config: EventConfig) => FieldConfig[];
+export declare const getActionAnnotationFields: (actionConfig: ActionConfig) => import("./FieldConfig").Inferred[];
 /**
- *
- * @param pageFields - All the fields in the event configuration
- * @param refFields - The fields referencing values within the event configuration (e.g. summary fields) or within system provided metadata fields (e.g. createdAt, updatedBy)
- * @returns referenced fields with populated labels
+ * @TODO: Request correction should have same format as print certificate
  */
-export declare const resolveLabelsFromKnownFields: ({ pageFields, refFields }: {
-    pageFields: {
-        id: string;
-        label: TranslationConfig;
-    }[];
-    refFields: {
-        id: EventMetadataKeys | string;
-        label?: TranslationConfig;
-    }[];
-}) => {
-    id: EventMetadataKeys | string;
-    label?: TranslationConfig;
-}[];
-export declare function getAllFields(configuration: EventConfig): import("./FieldConfig").Inferred[];
-export declare function getAllPages(configuration: EventConfig): ({
+export declare const findRecordActionPages: (config: EventConfig, actionType: ActionType) => PageConfig[];
+export declare function getDeclarationFields(configuration: EventConfig): FieldConfig[];
+export declare function getDeclarationPages(configuration: EventConfig): {
     type: "FORM";
     id: string;
-    title: TranslationConfig;
+    title: import("./TranslationConfig").TranslationConfig;
     fields: import("./FieldConfig").Inferred[];
-} | {
-    type: "VERIFICATION";
-    id: string;
-    title: TranslationConfig;
-    actions: {
-        verify: {
-            label: TranslationConfig;
-        };
-        cancel: {
-            label: TranslationConfig;
-            confirmation: {
-                title: TranslationConfig;
-                body: TranslationConfig;
-            };
-        };
-    };
-    fields: import("./FieldConfig").Inferred[];
-})[];
-export declare function validateWorkqueueConfig(workqueueConfigs: WorkqueueConfig[]): void;
-export declare const findActiveActionForm: (configuration: EventConfig, action: ActionType) => {
-    active: boolean;
-    version: {
-        id: string;
-        label: TranslationConfig;
-    };
-    label: TranslationConfig;
-    pages: ({
+    conditional?: import(".").JSONSchema | undefined;
+}[];
+export declare function getDeclaration(configuration: EventConfig): {
+    label: import("./TranslationConfig").TranslationConfig;
+    pages: {
         type: "FORM";
         id: string;
-        title: TranslationConfig;
-        fields: import("./FieldConfig").Inferred[];
-    } | {
-        type: "VERIFICATION";
-        id: string;
-        title: TranslationConfig;
-        actions: {
-            verify: {
-                label: TranslationConfig;
-            };
-            cancel: {
-                label: TranslationConfig;
-                confirmation: {
-                    title: TranslationConfig;
-                    body: TranslationConfig;
-                };
-            };
-        };
-        fields: import("./FieldConfig").Inferred[];
-    })[];
-    review: {
-        title: TranslationConfig;
+        title: import("./TranslationConfig").TranslationConfig;
         fields: import("./FieldConfig").Inferred[];
-    };
-} | undefined;
-export declare const findActiveActionFormPages: (configuration: EventConfig, action: ActionType) => ({
-    type: "FORM";
-    id: string;
-    title: TranslationConfig;
-    fields: import("./FieldConfig").Inferred[];
-} | {
-    type: "VERIFICATION";
-    id: string;
-    title: TranslationConfig;
-    actions: {
-        verify: {
-            label: TranslationConfig;
-        };
-        cancel: {
-            label: TranslationConfig;
-            confirmation: {
-                title: TranslationConfig;
-                body: TranslationConfig;
-            };
-        };
-    };
-    fields: import("./FieldConfig").Inferred[];
-})[] | undefined;
-export declare const getFormFields: (formConfig: FormConfig) => import("./FieldConfig").Inferred[];
-/**
- * Returns only form fields for the action type, if any, excluding review fields.
- */
-export declare const findActiveActionFormFields: (configuration: EventConfig, action: ActionType) => FieldConfig[] | undefined;
-/**
- * Returns all fields for the action type, including review fields, if any.
- */
-export declare const findActiveActionFields: (configuration: EventConfig, action: ActionType) => FieldConfig[] | undefined;
-export declare const getActiveActionFormPages: (configuration: EventConfig, action: ActionType) => ({
-    type: "FORM";
-    id: string;
-    title: TranslationConfig;
-    fields: import("./FieldConfig").Inferred[];
-} | {
-    type: "VERIFICATION";
-    id: string;
-    title: TranslationConfig;
-    actions: {
-        verify: {
-            label: TranslationConfig;
-        };
-        cancel: {
-            label: TranslationConfig;
-            confirmation: {
-                title: TranslationConfig;
-                body: TranslationConfig;
-            };
-        };
-    };
+        conditional?: import(".").JSONSchema | undefined;
+    }[];
+};
+export declare function getActionReviewFields(configuration: EventConfig, actionType: DeclarationAction): import("./FieldConfig").Inferred[];
+export declare function getActionReview(configuration: EventConfig, actionType: ActionType): {
+    title: import("./TranslationConfig").TranslationConfig;
     fields: import("./FieldConfig").Inferred[];
-})[];
-/**
- * Returns all fields for the action type, including review fields, or throws
- */
-export declare function getActiveActionFields(configuration: EventConfig, action: ActionType): FieldConfig[];
-export declare function getEventConfiguration(eventConfigurations: EventConfig[], type: string): EventConfig;
-export declare function stripHiddenFields(fields: FieldConfig[], data: EventState): import("lodash").Dictionary<string | number | boolean | {
+};
+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 | {
     type: string;
     filename: string;
     originalFilename: string;
@@ -203,8 +88,10 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
     eventId: string;
     transactionId: string;
     action: {
-        type: ActionType;
-        data: Record<string, string | number | boolean | {
+        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;
@@ -242,10 +129,8 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
             filename: string;
             originalFilename: string;
         }[] | undefined>;
-        createdAt: string;
-        createdBy: string;
         createdAtLocation: string;
-        metadata?: Record<string, string | number | boolean | {
+        annotation?: Record<string, string | number | boolean | {
             type: string;
             filename: string;
             originalFilename: string;
@@ -292,12 +177,12 @@ export declare function createEmptyDraft(eventId: string, draftId: string, actio
     transactionId: import("../uuid").UUID;
     action: {
         type: ActionType;
-        data: {};
-        metadata: {};
+        declaration: {};
+        annotation: {};
         createdAt: string;
         createdBy: string;
         createdAtLocation: string;
     };
 };
-export declare function findActiveActionVerificationPageIds(configuration: EventConfig, action: ActionType): string[];
+export declare function isVerificationPage(page: PageConfig): page is VerificationPageConfig;
 //# sourceMappingURL=utils.d.ts.map

package/dist/conditionals/index.js

@@ -256,6 +256,44 @@ function field(fieldId) {
         }
       },
       required: ["$form"]
+    }),
+    /**
+     * Checks if the field value matches a given regular expression pattern.
+     * @param pattern - The regular expression pattern to match the field value against.
+     * @returns A JSONSchema conditional that validates the field value against the pattern.
+     */
+    matches: (pattern) => defineConditional({
+      type: "object",
+      properties: {
+        $form: {
+          type: "object",
+          properties: {
+            [fieldId]: {
+              type: "string",
+              pattern
+            }
+          },
+          required: [fieldId]
+        }
+      },
+      required: ["$form"]
+    }),
+    isBetween: (min, max) => defineConditional({
+      type: "object",
+      properties: {
+        $form: {
+          type: "object",
+          properties: {
+            [fieldId]: {
+              type: "number",
+              minimum: min,
+              maximum: max
+            }
+          },
+          required: [fieldId]
+        }
+      },
+      required: ["$form"]
     })
   };
 }