@opencrvs/toolkit 1.8.0-rc.fc43738 → 1.8.0-rc.fc76588

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

@@ -1,13 +1,15 @@
 import { EventDocument } from '../events/EventDocument';
-import { ActionFormData } from '../events/ActionDocument';
+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 { userSerializer } from '../events/serializers/user/serializer';
 /** @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;
@@ -18,7 +20,7 @@ export type EventConditionalParameters = {
 };
 export type FormConditionalParameters = {
     $now: string;
-    $form: ActionFormData | Record<string, any>;
+    $form: EventState | Record<string, any>;
 };
 export type ConditionalParameters = UserConditionalParameters | EventConditionalParameters | FormConditionalParameters;
 type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
@@ -47,20 +49,33 @@ 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.
  */
-export declare const user: {
+export declare const user: typeof userSerializer & {
     hasScope: (scope: Scope) => JSONSchema;
 };
 /**
  *
  * Generate conditional rules for event.
  */
-export declare const event: {
+export declare function createEventConditionals(): {
+    /**
+     * Checks if the event contains a specific action type.
+     * @param action - The action type to check for.
+     */
     hasAction: (action: ActionType) => JSONSchema;
 };
+type FieldReference = {
+    $$field: string;
+};
 /**
  * Generate conditional rules for a form field.
  *
@@ -69,13 +84,17 @@ export declare const event: {
  *  and(field('foo').isEqualTo('bar'), field('baz').isUndefined())
  *
  */
-export declare function field(fieldId: string): {
+export declare function createFieldConditionals(fieldId: string): {
+    /**
+     * @private Internal property used for field reference tracking.
+     */
+    $$field: string;
     isAfter: () => {
         days: (days: number) => {
             inPast: () => JSONSchema;
             inFuture: () => JSONSchema;
         };
-        date: (date: string) => JSONSchema;
+        date: (date: string | FieldReference) => JSONSchema;
         now: () => JSONSchema;
     };
     isBefore: () => {
@@ -83,10 +102,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 +117,18 @@ 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;
+    getId: () => {
+        fieldId: string;
+    };
+    object: (options: Record<string, any>) => JSONSchema;
 };
 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

@@ -1,11 +1,47 @@
 import { ConditionalParameters, JSONSchema } from './conditionals';
-import { ActionFormData } from '../events/ActionDocument';
+import { EventState, ActionUpdate } from '../events/ActionDocument';
 import { FieldConfig } from '../events/FieldConfig';
-import { FieldValue } from '../events/FieldValue';
+import { FieldUpdateValue } from '../events/FieldValue';
 import { TranslationConfig } from '../events/TranslationConfig';
+import { FieldConditional } from '../events/Conditional';
 export declare function validate(schema: JSONSchema, data: ConditionalParameters): boolean;
-export declare function isFieldVisible(field: FieldConfig, form: ActionFormData): boolean;
-export declare function isFieldEnabled(field: FieldConfig, form: ActionFormData): boolean;
+export declare function isConditionMet(conditional: JSONSchema, values: Record<string, unknown>): boolean;
+export declare function areConditionsMet(conditions: FieldConditional[], values: Record<string, unknown>): 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;
+    };
+    unexpectedField: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
 /**
  * Custom error map for Zod to override the default error messages in intl-formik format.
  */
@@ -16,23 +52,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: ActionFormData;
-}): {
-    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.
@@ -40,8 +59,17 @@ export declare function getFieldValidationErrors({ field, values }: {
  */
 export declare function validateFieldInput({ field, value }: {
     field: FieldConfig;
-    value: FieldValue;
+    value: FieldUpdateValue;
 }): {
     message: TranslationConfig;
 }[];
+export declare function runFieldValidations({ field, values }: {
+    field: FieldConfig;
+    values: ActionUpdate;
+}): {
+    errors: {
+        message: TranslationConfig;
+    }[];
+};
+export declare function getValidatorsForField(fieldId: FieldConfig['id'], validations: NonNullable<FieldConfig['validation']>): NonNullable<FieldConfig['validation']>;
 //# sourceMappingURL=validate.d.ts.map

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

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