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

package/dist/commons/conditionals/conditionals.d.ts

@@ -3,11 +3,14 @@ import { EventState } from '../events/ActionDocument';
 import { ITokenPayload as TokenPayload, Scope } from '../authentication';
 import { ActionType } from '../events/ActionType';
 import { PartialSchema as AjvJSONSchemaType } from 'ajv/dist/types/json-schema';
+import { SelectOption } from '../events/FieldConfig';
+import { MetadataField } from '../utils';
 /** @knipignore */
 export type JSONSchema = {
     readonly __nominal__type: 'JSONSchema';
 };
 export declare function defineConditional(schema: any): JSONSchema;
+export declare function defineFormConditional(schema: Record<string, unknown>): JSONSchema;
 export type UserConditionalParameters = {
     $now: string;
     $user: TokenPayload;
@@ -47,6 +50,12 @@ export declare function or(...conditions: AjvJSONSchema[]): JSONSchema;
  * @example not(field('foo').isEqualTo('bar'))
  */
 export declare function not(condition: AjvJSONSchema): JSONSchema;
+/**
+ * Returns an JSON Schema object, which is treated as always invalid.
+ *
+ * @returns {JSONSchema} An schema object that always evaluates to false.
+ */
+export declare function never(): JSONSchema;
 /**
  *
  * Generate conditional rules for user.
@@ -61,6 +70,10 @@ export declare const user: {
 export declare const event: {
     hasAction: (action: ActionType) => JSONSchema;
 };
+type FieldReference = {
+    _fieldId: string;
+    [key: string]: unknown;
+};
 /**
  * Generate conditional rules for a form field.
  *
@@ -70,12 +83,16 @@ export declare const event: {
  *
  */
 export declare function field(fieldId: string): {
+    /**
+     * @private Internal property used for field reference tracking.
+     */
+    _fieldId: string;
     isAfter: () => {
         days: (days: number) => {
             inPast: () => JSONSchema;
             inFuture: () => JSONSchema;
         };
-        date: (date: string) => JSONSchema;
+        date: (date: string | FieldReference) => JSONSchema;
         now: () => JSONSchema;
     };
     isBefore: () => {
@@ -83,10 +100,10 @@ export declare function field(fieldId: string): {
             inPast: () => JSONSchema;
             inFuture: () => JSONSchema;
         };
-        date: (date: string) => JSONSchema;
+        date: (date: string | FieldReference) => JSONSchema;
         now: () => JSONSchema;
     };
-    isEqualTo: (value: string | boolean) => JSONSchema;
+    isEqualTo: (value: string | boolean | FieldReference) => JSONSchema;
     /**
      * 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))
@@ -98,6 +115,77 @@ export declare function field(fieldId: string): {
     isFalsy: () => JSONSchema;
     isUndefined: () => JSONSchema;
     inArray: (values: string[]) => JSONSchema;
+    isValidEnglishName: () => JSONSchema;
+    /**
+     * 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: string) => JSONSchema;
+    isBetween: (min: number, max: number) => JSONSchema;
+    /**
+     * Creates a range configuration for the specified field.
+     *
+     * @returns An object containing the field ID and a configuration object with a type of 'RANGE'.
+     *
+     * @example field('age').range()
+     * // {
+     * //   fieldId: 'age',
+     * //   config: { type: 'RANGE' }
+     * // }
+     */
+    range: () => {
+        fieldId: string;
+        config: {
+            type: "RANGE";
+        };
+    };
+    /**
+     * Creates a configuration for exact matching of the specified field.
+     * @returns  An object containing the field ID and a configuration object with a type of 'EXACT'.
+     * @example field('dob').exact()
+     * // {
+     * //   fieldId: 'dob',
+     * //   config: { type: 'EXACT' }
+     * // }
+     */
+    exact: () => {
+        fieldId: string;
+        config: {
+            type: "EXACT";
+        };
+    };
+    /**
+     * Creates a configuration for fuzzy matching of the specified field.
+     * @returns  An object containing the field ID and a configuration object with a type of 'EXACT'.
+     * @example field('name').fuzzy()
+     * // {
+     * //   fieldId: 'name',
+     * //   config: { type: 'FUZZY' }
+     * // }
+     */
+    fuzzy: () => {
+        fieldId: string;
+        config: {
+            type: "FUZZY";
+        };
+    };
+};
+/**
+ * @param fieldId - The field ID condition is applied to.
+ * @param options - The options for the select field.
+ * @returns An object containing the configuration for the searching the metadata fields of an event.
+ * @example eventField('status', [{ label: 'Option 1', value: '1' }])
+ */
+export declare function eventField(fieldId: MetadataField, options?: SelectOption[]): {
+    fieldId: "status" | "trackingId";
+    options: {
+        value: string;
+        label: import("..").TranslationConfig;
+    }[] | undefined;
+    config: {
+        type: "EXACT";
+    };
 };
 export {};
 //# sourceMappingURL=conditionals.d.ts.map

package/dist/commons/conditionals/validate-address.test.d.ts

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

package/dist/commons/conditionals/validate.d.ts

@@ -6,6 +6,34 @@ import { TranslationConfig } from '../events/TranslationConfig';
 export declare function validate(schema: JSONSchema, data: ConditionalParameters): boolean;
 export declare function isFieldVisible(field: FieldConfig, form: ActionUpdate | EventState): boolean;
 export declare function isFieldEnabled(field: FieldConfig, form: ActionUpdate | EventState): boolean;
+export declare function isFieldDisplayedOnReview(field: FieldConfig, form: ActionUpdate | EventState): boolean;
+export declare const errorMessages: {
+    hiddenField: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    invalidDate: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    invalidEmail: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    requiredField: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    invalidInput: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
 /**
  * Custom error map for Zod to override the default error messages in intl-formik format.
  */
@@ -16,23 +44,6 @@ export type CustomZodToIntlErrorMap = {
         message: TranslationConfig;
     };
 };
-/**
- * Checks if a field has validation errors based on its type and custom conditionals.
- *
- * @returns an array of error messages for the field
- */
-export declare function getFieldValidationErrors({ field, values }: {
-    field: FieldConfig;
-    values: ActionUpdate;
-}): {
-    errors: {
-        message: {
-            id: string;
-            defaultMessage: string;
-            description: string;
-        };
-    }[];
-};
 /**
  * Validates primitive fields defined by the FieldConfig type.
  * e.g. email is proper format, date is a valid date, etc.
@@ -44,4 +55,17 @@ export declare function validateFieldInput({ field, value }: {
 }): {
     message: TranslationConfig;
 }[];
+/**
+ * Gets applicable validation errors based on its type and custom validators.
+ *
+ * @returns an array of error messages for the field
+ */
+export declare function getFieldValidationErrors({ field, values }: {
+    field: FieldConfig;
+    values: ActionUpdate;
+}): {
+    errors: {
+        message: TranslationConfig;
+    }[];
+};
 //# sourceMappingURL=validate.d.ts.map

package/dist/commons/conditionals/validate.test.d.ts

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