@ecrvs/opencrvs-toolkit 1.8.1-rc.fb8610c → 1.9.0-rc.d21dcd8

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

@@ -11,20 +11,18 @@ export type JSONSchema = {
 };
 export declare function defineConditional(schema: any): JSONSchema;
 export declare function defineFormConditional(schema: Record<string, unknown>): JSONSchema;
-export type UserConditionalParameters = {
+type CommonConditionalParameters = {
     $now: string;
     $online: boolean;
+};
+export type UserConditionalParameters = CommonConditionalParameters & {
     $user: TokenPayload;
 };
-export type EventConditionalParameters = {
-    $now: string;
-    $online: boolean;
+export type EventConditionalParameters = CommonConditionalParameters & {
     $event: EventDocument;
 };
-export type FormConditionalParameters = {
-    $now: string;
-    $online: boolean;
-    $form: EventState | Record<string, any>;
+export type FormConditionalParameters = CommonConditionalParameters & {
+    $form: EventState | Record<string, unknown>;
     $locations?: Array<{
         id: UUID;
     }>;
@@ -62,12 +60,17 @@ export declare function not(condition: AjvJSONSchema): JSONSchema;
  * @returns {JSONSchema} An schema object that always evaluates to false.
  */
 export declare function never(): JSONSchema;
+type FieldReference = {
+    $$field: string;
+    $$subfield: string[];
+};
 /**
  *
  * Generate conditional rules for user.
  */
 export declare const user: typeof userSerializer & {
     hasScope: (scope: Scope) => JSONSchema;
+    hasRole: (role: string) => JSONSchema;
     isOnline: () => JSONSchema;
     locationLevel: (adminLevelId: string) => {
         $user: {
@@ -75,9 +78,7 @@ export declare const user: typeof userSerializer & {
         };
     };
 };
-type FieldReference = {
-    $$field: string;
-};
+export declare function isFieldReference(value: unknown): value is FieldReference;
 /**
  * Generate conditional rules for a form field.
  *
@@ -102,7 +103,139 @@ export declare function createFieldConditionals(fieldId: string): {
          */
         $$field: string;
         get(fieldPath: string): any;
-        isAfter: () => {
+        asDob(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+            };
+            date: (date: string | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+            };
+            date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isGreaterThan(value: number | FieldReference): JSONSchema;
+        isLessThan(value: number | FieldReference): JSONSchema;
+        isEqualTo(value: string | boolean | number | FieldReference): JSONSchema;
+        isEqualToSumOf(val1: FieldReference, val2: FieldReference): JSONSchema;
+        isAbbreviation(): JSONSchema;
+        isIllDefined(causesOfDeathFields: FieldReference[], threshold: number): 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))
+         * @returns whether the field is falsy (undefined, false, null, empty string)
+         *
+         * NOTE: For now, this only works with string, boolean, and null types. 0 is still allowed.
+         *
+         */
+        isFalsy(): JSONSchema;
+        isUndefined(): JSONSchema;
+        inArray(values: string[]): JSONSchema;
+        isValidEnglishName(isRequiredField?: boolean): JSONSchema;
+        isValidAdministrativeLeafLevel(): 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;
+        };
+        /**
+         * @deprecated
+         * use field(fieldId).get(nestedProperty) instead
+         * with 'and' combinator e.g.
+         * and(
+         *   field('child.name').get('firstname').isEqualTo('John'),
+         *   field('child.name').get('surname').isEqualTo('Doe')
+         * )
+         */
+        object: (options: Record<string, any>) => JSONSchema;
+    };
+    asDob(): {
+        $$subfield: string[];
+        /**
+         * @private Internal property used for field reference tracking.
+         */
+        $$field: string;
+        get(fieldPath: string): any;
+        asDob(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+            };
+            date: (date: string | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+            };
+            date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isGreaterThan(value: number | FieldReference): JSONSchema;
+        isLessThan(value: number | FieldReference): JSONSchema;
+        isEqualTo(value: string | boolean | number | FieldReference): JSONSchema;
+        isEqualToSumOf(val1: FieldReference, val2: FieldReference): JSONSchema;
+        isAbbreviation(): JSONSchema;
+        isIllDefined(causesOfDeathFields: FieldReference[], threshold: number): 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))
+         * @returns whether the field is falsy (undefined, false, null, empty string)
+         *
+         * NOTE: For now, this only works with string, boolean, and null types. 0 is still allowed.
+         *
+         */
+        isFalsy(): JSONSchema;
+        isUndefined(): JSONSchema;
+        inArray(values: string[]): JSONSchema;
+        isValidEnglishName(isRequiredField?: boolean): JSONSchema;
+        isValidAdministrativeLeafLevel(): 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;
+        };
+        /**
+         * @deprecated
+         * use field(fieldId).get(nestedProperty) instead
+         * with 'and' combinator e.g.
+         * and(
+         *   field('child.name').get('firstname').isEqualTo('John'),
+         *   field('child.name').get('surname').isEqualTo('Doe')
+         * )
+         */
+        object: (options: Record<string, any>) => JSONSchema;
+    };
+    asAge(): {
+        $$subfield: string[];
+        /**
+         * @private Internal property used for field reference tracking.
+         */
+        $$field: string;
+        get(fieldPath: string): any;
+        asDob(): any;
+        asAge(): any;
+        isAfter(): {
             days: (days: number) => {
                 inPast: () => JSONSchema;
                 inFuture: () => JSONSchema;
@@ -110,7 +243,7 @@ export declare function createFieldConditionals(fieldId: string): {
             date: (date: string | FieldReference) => JSONSchema;
             now: () => JSONSchema;
         };
-        isBefore: () => {
+        isBefore(): {
             days: (days: number) => {
                 inPast: () => JSONSchema;
                 inFuture: () => JSONSchema;
@@ -118,11 +251,12 @@ export declare function createFieldConditionals(fieldId: string): {
             date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
             now: () => JSONSchema;
         };
-        isGreaterThan: (value: number | FieldReference) => JSONSchema;
-        isLessThan: (value: number | FieldReference) => JSONSchema;
-        isEqualTo(value: string | boolean | FieldReference): JSONSchema;
+        isGreaterThan(value: number | FieldReference): JSONSchema;
+        isLessThan(value: number | FieldReference): JSONSchema;
+        isEqualTo(value: string | boolean | number | FieldReference): JSONSchema;
         isEqualToSumOf(val1: FieldReference, val2: FieldReference): JSONSchema;
         isAbbreviation(): JSONSchema;
+        isIllDefined(causesOfDeathFields: FieldReference[], threshold: number): 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))
@@ -133,22 +267,31 @@ export declare function createFieldConditionals(fieldId: string): {
          */
         isFalsy(): JSONSchema;
         isUndefined(): JSONSchema;
-        inArray: (values: string[]) => JSONSchema;
-        isValidEnglishName: () => JSONSchema;
-        isValidAdministrativeLeafLevel: () => JSONSchema;
+        inArray(values: string[]): JSONSchema;
+        isValidEnglishName(isRequiredField?: boolean): JSONSchema;
+        isValidAdministrativeLeafLevel(): 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;
+        matches(pattern: string): JSONSchema;
+        isBetween(min: number, max: number): JSONSchema;
         getId: () => {
             fieldId: string;
         };
+        /**
+         * @deprecated
+         * use field(fieldId).get(nestedProperty) instead
+         * with 'and' combinator e.g.
+         * and(
+         *   field('child.name').get('firstname').isEqualTo('John'),
+         *   field('child.name').get('surname').isEqualTo('Doe')
+         * )
+         */
         object: (options: Record<string, any>) => JSONSchema;
     };
-    isAfter: () => {
+    isAfter(): {
         days: (days: number) => {
             inPast: () => JSONSchema;
             inFuture: () => JSONSchema;
@@ -156,7 +299,7 @@ export declare function createFieldConditionals(fieldId: string): {
         date: (date: string | FieldReference) => JSONSchema;
         now: () => JSONSchema;
     };
-    isBefore: () => {
+    isBefore(): {
         days: (days: number) => {
             inPast: () => JSONSchema;
             inFuture: () => JSONSchema;
@@ -164,11 +307,12 @@ export declare function createFieldConditionals(fieldId: string): {
         date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
         now: () => JSONSchema;
     };
-    isGreaterThan: (value: number | FieldReference) => JSONSchema;
-    isLessThan: (value: number | FieldReference) => JSONSchema;
-    isEqualTo(value: string | boolean | FieldReference): JSONSchema;
+    isGreaterThan(value: number | FieldReference): JSONSchema;
+    isLessThan(value: number | FieldReference): JSONSchema;
+    isEqualTo(value: string | boolean | number | FieldReference): JSONSchema;
     isEqualToSumOf(val1: FieldReference, val2: FieldReference): JSONSchema;
     isAbbreviation(): JSONSchema;
+    isIllDefined(causesOfDeathFields: FieldReference[], threshold: number): 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))
@@ -179,19 +323,28 @@ export declare function createFieldConditionals(fieldId: string): {
      */
     isFalsy(): JSONSchema;
     isUndefined(): JSONSchema;
-    inArray: (values: string[]) => JSONSchema;
-    isValidEnglishName: () => JSONSchema;
-    isValidAdministrativeLeafLevel: () => JSONSchema;
+    inArray(values: string[]): JSONSchema;
+    isValidEnglishName(isRequiredField?: boolean): JSONSchema;
+    isValidAdministrativeLeafLevel(): 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;
+    matches(pattern: string): JSONSchema;
+    isBetween(min: number, max: number): JSONSchema;
     getId: () => {
         fieldId: string;
     };
+    /**
+     * @deprecated
+     * use field(fieldId).get(nestedProperty) instead
+     * with 'and' combinator e.g.
+     * and(
+     *   field('child.name').get('firstname').isEqualTo('John'),
+     *   field('child.name').get('surname').isEqualTo('Doe')
+     * )
+     */
     object: (options: Record<string, any>) => JSONSchema;
 };
 export {};

package/dist/commons/conditionals/ill-defined.d.ts

@@ -0,0 +1,2 @@
+export declare const illDefinedConditions: string[];
+//# sourceMappingURL=ill-defined.d.ts.map

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

@@ -2,49 +2,23 @@ import { ConditionalParameters, JSONSchema } from './conditionals';
 import { ActionUpdate, EventState } from '../events/ActionDocument';
 import { FieldConditional } from '../events/Conditional';
 import { FieldConfig } from '../events/FieldConfig';
-import { FieldUpdateValue } from '../events/FieldValue';
+import { FieldUpdateValue, FieldValue } from '../events/FieldValue';
 import { TranslationConfig } from '../events/TranslationConfig';
+import { ITokenPayload } from '../authentication';
 import { UUID } from '../uuid';
 export declare function validate(schema: JSONSchema, data: ConditionalParameters): boolean;
 export declare function isOnline(): 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 getOnlyVisibleFormValues(field: FieldConfig[], form: EventState): Record<string, string | number | boolean | {
-    type: string;
-    path: string;
-    originalFilename: string;
-} | {
-    firstname: string;
-    surname: string;
-    middlename?: string | undefined;
-} | {
-    firstname: string;
-    surname: string;
-    middlename?: string | null | undefined;
-} | Record<string, string> | {
-    country: string;
-    addressType: "DOMESTIC" | "INTERNATIONAL";
-    administrativeArea?: string | undefined;
-    streetLevelDetails?: Record<string, string> | undefined;
-} | {
-    type: string;
-    option: string;
-    path: string;
-    originalFilename: string;
-}[] | {
-    loading: boolean;
-    data?: any;
-    error?: {
-        message: string;
-        statusCode: number;
-    } | null | undefined;
-} | {
-    start: string;
-    end: string;
-} | null | undefined>;
-export declare function isFieldEnabled(field: FieldConfig, form: ActionUpdate | EventState): boolean;
-export declare function isFieldDisplayedOnReview(field: FieldConfig, form: ActionUpdate | EventState): boolean;
+export declare function isConditionMet(conditional: JSONSchema, values: Record<string, FieldValue>, context: ValidatorContext): boolean;
+export declare function areConditionsMet(conditions: FieldConditional[], values: Record<string, FieldValue>, context: ValidatorContext): boolean;
+export type ValidatorContext = {
+    user?: ITokenPayload;
+    leafAdminStructureLocationIds?: Array<{
+        id: UUID;
+    }>;
+};
+export declare function isFieldVisible(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
+export declare function isFieldEnabled(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
+export declare function isFieldDisplayedOnReview(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
 export declare const errorMessages: {
     hiddenField: {
         id: string;
@@ -103,27 +77,20 @@ export declare function validateFieldInput({ field, value }: {
 }): {
     message: TranslationConfig;
 }[];
-export declare function runStructuralValidations({ field, values }: {
+export declare function runStructuralValidations({ field, values, context }: {
     field: FieldConfig;
     values: ActionUpdate;
+    context: ValidatorContext;
 }): {
-    errors: {
-        message: TranslationConfig;
-    }[];
-};
+    message: TranslationConfig;
+}[];
 export declare function runFieldValidations({ field, values, context }: {
     field: FieldConfig;
     values: ActionUpdate;
-    context?: {
-        leafAdminStructureLocationIds: Array<{
-            id: UUID;
-        }>;
-    };
+    context: ValidatorContext;
 }): {
-    errors: {
-        message: TranslationConfig;
-    }[];
-};
+    message: TranslationConfig;
+}[];
 export declare function getValidatorsForField(fieldId: FieldConfig['id'], validations: NonNullable<FieldConfig['validation']>): NonNullable<FieldConfig['validation']>;
-export declare function areCertificateConditionsMet(conditions: FieldConditional[], values: Record<string, unknown>): boolean;
+export declare function areCertificateConditionsMet(conditions: FieldConditional[], values: ConditionalParameters): boolean;
 //# sourceMappingURL=validate.d.ts.map