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

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

@@ -1,99 +1,57 @@
-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[];
+    conditional?: import(".").JSONSchema | undefined;
 }[];
-export declare function validateWorkqueueConfig(workqueueConfigs: WorkqueueConfig[]): void;
-export declare const findActiveActionForm: (configuration: EventConfig, action: ActionType) => {
-    active: boolean;
-    version: {
-        id: string;
-        label: TranslationConfig;
-    };
-    label: TranslationConfig;
+export declare function getDeclaration(configuration: EventConfig): {
+    label: import("./TranslationConfig").TranslationConfig;
     pages: {
+        type: "FORM";
         id: string;
-        title: TranslationConfig;
+        title: import("./TranslationConfig").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) => {
-    id: string;
-    title: 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) => {
-    id: string;
-    title: TranslationConfig;
+};
+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;
 } | {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -104,29 +62,43 @@ 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: "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;
@@ -137,25 +109,35 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
         } | {
             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;
-        }[]>;
-        createdAt: string;
-        createdBy: string;
+        }[] | undefined>;
         createdAtLocation: string;
-        metadata?: Record<string, string | number | boolean | {
+        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;
@@ -166,15 +148,27 @@ export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]):
         } | {
             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> | undefined;
+        originalActionId?: string | undefined;
     };
 }[];
 export declare function createEmptyDraft(eventId: string, draftId: string, actionType: ActionType): {
@@ -184,11 +178,50 @@ 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 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>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/conditionals/index.js

@@ -126,6 +126,10 @@ function field(fieldId) {
     required: ["$form"]
   });
   return {
+    /**
+     * @private Internal property used for field reference tracking.
+     */
+    _returning: fieldId,
     isAfter: () => ({
       days: (days) => ({
         inPast: () => defineConditional(
@@ -150,25 +154,54 @@ function field(fieldId) {
       date: (date) => defineConditional(getDateRange(date, "formatMaximum")),
       now: () => defineConditional(getDateRange(getDateFromNow(0), "formatMaximum"))
     }),
-    isEqualTo: (value) => defineConditional({
-      type: "object",
-      properties: {
-        $form: {
+    // TODO CIHAN: typing
+    isEqualTo: (value) => {
+      if (typeof value === "object" && value._returning) {
+        const comparedFieldId = value._returning;
+        return defineConditional({
           type: "object",
           properties: {
-            [fieldId]: {
-              oneOf: [
-                { type: "string", const: value },
-                { type: "boolean", const: value }
-              ],
-              const: value
+            $form: {
+              type: "object",
+              properties: {
+                [fieldId]: { type: ["string", "boolean"] },
+                [comparedFieldId]: { type: ["string", "boolean"] }
+              },
+              required: [fieldId, comparedFieldId],
+              allOf: [
+                {
+                  properties: {
+                    [fieldId]: {
+                      const: { $data: `1/${comparedFieldId}` }
+                    }
+                  }
+                }
+              ]
             }
           },
-          required: [fieldId]
-        }
-      },
-      required: ["$form"]
-    }),
+          required: ["$form"]
+        });
+      }
+      return defineConditional({
+        type: "object",
+        properties: {
+          $form: {
+            type: "object",
+            properties: {
+              [fieldId]: {
+                oneOf: [
+                  { type: "string", const: value },
+                  { type: "boolean", const: value }
+                ],
+                const: value
+              }
+            },
+            required: [fieldId]
+          }
+        },
+        required: ["$form"]
+      });
+    },
     /**
      * Use case: Some fields are rendered when selection is not made, or boolean false is explicitly selected.
      * @example field('recommender.none').isFalsy() vs not(field('recommender.none').isEqualTo(true))
@@ -239,6 +272,78 @@ 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"]
+    }),
+    isValidNationalId: () => defineConditional({
+      type: "object",
+      properties: {
+        $form: {
+          type: "object",
+          properties: {
+            [fieldId]: {
+              type: "string",
+              pattern: "^[0-9]{9}$",
+              description: "The National ID can only be numeric and must be 9 digits long."
+            }
+          },
+          required: [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"]
     })
   };
 }