@opencrvs/toolkit 1.8.0-rc.ff2e7b6 → 1.8.0-rc.ff62f9e

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

@@ -5,8 +5,10 @@ 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 { FormConfig, FormPageConfig } from './FormConfig';
+import { Draft } from './Draft';
+import { EventDocument } from './EventDocument';
 /**
  * @returns All the fields in the event configuration input.
  */
@@ -38,11 +40,31 @@ export declare const resolveLabelsFromKnownFields: ({ pageFields, refFields }: {
     label?: TranslationConfig;
 }[];
 export declare function getAllFields(configuration: EventConfig): import("./FieldConfig").Inferred[];
-export declare function getAllPages(configuration: EventConfig): {
+export declare function getAllPages(configuration: EventConfig): ({
+    type: "FORM";
     id: string;
     title: TranslationConfig;
     fields: import("./FieldConfig").Inferred[];
-}[];
+    conditional?: import(".").JSONSchema | undefined;
+} | {
+    type: "VERIFICATION";
+    id: string;
+    title: TranslationConfig;
+    actions: {
+        verify: {
+            label: TranslationConfig;
+        };
+        cancel: {
+            label: TranslationConfig;
+            confirmation: {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            };
+        };
+    };
+    fields: import("./FieldConfig").Inferred[];
+    conditional?: import(".").JSONSchema | undefined;
+})[];
 export declare function validateWorkqueueConfig(workqueueConfigs: WorkqueueConfig[]): void;
 export declare const findActiveActionForm: (configuration: EventConfig, action: ActionType) => {
     active: boolean;
@@ -51,22 +73,64 @@ export declare const findActiveActionForm: (configuration: EventConfig, action:
         label: TranslationConfig;
     };
     label: TranslationConfig;
-    pages: {
+    pages: ({
+        type: "FORM";
         id: string;
         title: TranslationConfig;
         fields: import("./FieldConfig").Inferred[];
-    }[];
+        conditional?: import(".").JSONSchema | undefined;
+    } | {
+        type: "VERIFICATION";
+        id: string;
+        title: TranslationConfig;
+        actions: {
+            verify: {
+                label: TranslationConfig;
+            };
+            cancel: {
+                label: TranslationConfig;
+                confirmation: {
+                    title: TranslationConfig;
+                    body: TranslationConfig;
+                };
+            };
+        };
+        fields: import("./FieldConfig").Inferred[];
+        conditional?: import(".").JSONSchema | undefined;
+    })[];
     review: {
         title: TranslationConfig;
         fields: import("./FieldConfig").Inferred[];
     };
 } | undefined;
-export declare const findActiveActionFormPages: (configuration: EventConfig, action: ActionType) => {
+export declare const findActiveActionFormPages: (configuration: EventConfig, action: ActionType) => ({
+    type: "FORM";
+    id: string;
+    title: TranslationConfig;
+    fields: import("./FieldConfig").Inferred[];
+    conditional?: import(".").JSONSchema | undefined;
+} | {
+    type: "VERIFICATION";
     id: string;
     title: TranslationConfig;
+    actions: {
+        verify: {
+            label: TranslationConfig;
+        };
+        cancel: {
+            label: TranslationConfig;
+            confirmation: {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            };
+        };
+    };
     fields: import("./FieldConfig").Inferred[];
-}[] | undefined;
+    conditional?: import(".").JSONSchema | undefined;
+})[] | undefined;
 export declare const getFormFields: (formConfig: FormConfig) => import("./FieldConfig").Inferred[];
+export declare function isPageVisible(page: FormPageConfig, formValues: ActionUpdate): boolean;
+export declare const getVisiblePagesFormFields: (formConfig: FormConfig, formData: ActionUpdate) => import("./FieldConfig").Inferred[];
 /**
  * Returns only form fields for the action type, if any, excluding review fields.
  */
@@ -74,12 +138,32 @@ export declare const findActiveActionFormFields: (configuration: EventConfig, ac
 /**
  * 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) => {
+export declare const findActiveActionFields: (configuration: EventConfig, action: ActionType, formData?: ActionUpdate) => FieldConfig[] | undefined;
+export declare const getActiveActionFormPages: (configuration: EventConfig, action: ActionType) => ({
+    type: "FORM";
     id: string;
     title: TranslationConfig;
     fields: import("./FieldConfig").Inferred[];
-}[];
+    conditional?: import(".").JSONSchema | undefined;
+} | {
+    type: "VERIFICATION";
+    id: string;
+    title: TranslationConfig;
+    actions: {
+        verify: {
+            label: TranslationConfig;
+        };
+        cancel: {
+            label: TranslationConfig;
+            confirmation: {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            };
+        };
+    };
+    fields: import("./FieldConfig").Inferred[];
+    conditional?: import(".").JSONSchema | undefined;
+})[];
 /**
  * Returns all fields for the action type, including review fields, or throws
  */
@@ -92,6 +176,7 @@ export declare function stripHiddenFields(fields: FieldConfig[], data: EventStat
 } | {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -102,13 +187,145 @@ export declare function stripHiddenFields(fields: FieldConfig[], data: EventStat
 } | {
     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 findActiveDrafts(event: EventDocument, drafts: Draft[]): {
+    id: string;
+    createdAt: string;
+    eventId: string;
+    transactionId: string;
+    action: {
+        type: ActionType;
+        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>;
+        createdAt: string;
+        createdBy: string;
+        createdAtLocation: string;
+        metadata?: 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;
+    };
+}[];
+export declare function createEmptyDraft(eventId: string, draftId: string, actionType: ActionType): {
+    id: string;
+    eventId: string;
+    createdAt: string;
+    transactionId: import("../uuid").UUID;
+    action: {
+        type: ActionType;
+        data: {};
+        metadata: {};
+        createdAt: string;
+        createdBy: string;
+        createdAtLocation: string;
+    };
+};
+export declare function isVerificationPage(page: FormPageConfig): page is {
+    type: "VERIFICATION";
+    id: string;
+    title: TranslationConfig;
+    actions: {
+        verify: {
+            label: TranslationConfig;
+        };
+        cancel: {
+            label: TranslationConfig;
+            confirmation: {
+                title: TranslationConfig;
+                body: TranslationConfig;
+            };
+        };
+    };
+    fields: import("./FieldConfig").Inferred[];
+    conditional?: import(".").JSONSchema | undefined;
+};
 //# sourceMappingURL=utils.d.ts.map

package/dist/conditionals/index.js

@@ -239,6 +239,23 @@ function field(fieldId) {
         }
       },
       required: ["$form"]
+    }),
+    isValidEnglishName: () => defineConditional({
+      type: "object",
+      properties: {
+        $form: {
+          type: "object",
+          properties: {
+            [fieldId]: {
+              type: "string",
+              pattern: "^[\\p{Script=Latin}0-9'._-]*(\\([\\p{Script=Latin}0-9'._-]+\\))?[\\p{Script=Latin}0-9'._-]*( [\\p{Script=Latin}0-9'._-]*(\\([\\p{Script=Latin}0-9'._-]+\\))?[\\p{Script=Latin}0-9'._-]*)*$",
+              description: "Name must contain only letters, numbers, and allowed special characters ('._-). No double spaces."
+            }
+          },
+          required: [fieldId]
+        }
+      },
+      required: ["$form"]
     })
   };
 }