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

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

@@ -1,10 +1,8 @@
 import { EventDocument } from '../events/EventDocument';
 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';
+import { userSerializer } from '../events/serializers/user/serializer';
 /** @knipignore */
 export type JSONSchema = {
     readonly __nominal__type: 'JSONSchema';
@@ -60,19 +58,11 @@ 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: {
-    hasAction: (action: ActionType) => JSONSchema;
-};
 type FieldReference = {
-    _fieldId: string;
-    [key: string]: unknown;
+    $$field: string;
 };
 /**
  * Generate conditional rules for a form field.
@@ -82,11 +72,11 @@ type FieldReference = {
  *  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.
      */
-    _fieldId: string;
+    $$field: string;
     isAfter: () => {
         days: (days: number) => {
             inPast: () => JSONSchema;
@@ -123,69 +113,10 @@ export declare function field(fieldId: string): {
      */
     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: () => {
+    getId: () => {
         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";
     };
+    object: (options: Record<string, any>) => JSONSchema;
 };
 export {};
 //# sourceMappingURL=conditionals.d.ts.map

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

@@ -3,7 +3,10 @@ import { EventState, ActionUpdate } from '../events/ActionDocument';
 import { FieldConfig } from '../events/FieldConfig';
 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 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;
@@ -33,6 +36,16 @@ export declare const errorMessages: {
         description: string;
         id: string;
     };
+    unexpectedField: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    correctionNotAllowed: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
 };
 /**
  * Custom error map for Zod to override the default error messages in intl-formik format.
@@ -55,12 +68,7 @@ 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 }: {
+export declare function runFieldValidations({ field, values }: {
     field: FieldConfig;
     values: ActionUpdate;
 }): {
@@ -68,4 +76,5 @@ export declare function getFieldValidationErrors({ field, values }: {
         message: TranslationConfig;
     }[];
 };
+export declare function getValidatorsForField(fieldId: FieldConfig['id'], validations: NonNullable<FieldConfig['validation']>): NonNullable<FieldConfig['validation']>;
 //# sourceMappingURL=validate.d.ts.map