@nira-opencrvs/toolkit 1.9.11-rc.39d8d68

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

@@ -0,0 +1,824 @@
+import { EventDocument } from '../events/EventDocument';
+import { EventState } from '../events/ActionDocument';
+import { ITokenPayload as TokenPayload, Scope } from '../authentication';
+import { PartialSchema as AjvJSONSchemaType } from 'ajv/dist/types/json-schema';
+import { userSerializer } from '../events/serializers/user/serializer';
+import { UUID } from '../uuid';
+import { todayDateTimeValueSerializer } from '../events/serializers/date/serializer';
+import { FieldReference } from '../events/FieldConfig';
+/** @knipignore */
+export type JSONSchema = {
+    $id: string;
+    readonly __nominal__type: 'JSONSchema';
+};
+export declare function defineConditional(schema: any): JSONSchema;
+export declare function defineFormConditional(schema: Record<string, unknown>): JSONSchema;
+type CommonConditionalParameters = {
+    $now: string;
+    $online: boolean;
+};
+export type UserConditionalParameters = CommonConditionalParameters & {
+    $user: TokenPayload;
+};
+export type EventConditionalParameters = CommonConditionalParameters & {
+    $event: EventDocument;
+};
+export type FormConditionalParameters = CommonConditionalParameters & {
+    $form: EventState | Record<string, unknown>;
+    $leafAdminStructureLocationIds?: Array<{
+        id: UUID;
+    }>;
+};
+export type ConditionalParameters = UserConditionalParameters | EventConditionalParameters | FormConditionalParameters;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+type AjvJSONSchema = AjvJSONSchemaType<UnionToIntersection<ConditionalParameters>>;
+/**
+ * Returns an empty JSON Schema object, which is treated as always valid.
+ *
+ * @returns {AjvJSONSchema} An empty schema object `{}` that always evaluates to true.
+ */
+export declare function alwaysTrue(): AjvJSONSchema;
+/**
+ * Universal boolean connector to be used with any type of conditional. (user, event, field)
+ *
+ * @example and(field('foo').isEqualTo('bar'), field('baz').isUndefined())
+ */
+export declare function and(...conditions: AjvJSONSchema[]): JSONSchema;
+/**
+ * Universal boolean connector to be used with any type of conditional. (user, event, field)
+ *
+ * @example or(field('foo').isEqualTo('bar'), field('baz').isUndefined())
+ */
+export declare function or(...conditions: AjvJSONSchema[]): JSONSchema;
+/**
+ * Universal boolean connector to be used with any type of conditional. (user, event, field)
+ *
+ * @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 current date
+ */
+export declare const now: typeof todayDateTimeValueSerializer;
+/**
+ *
+ * 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: {
+            $location: string;
+        };
+    };
+};
+export declare function isFieldReference(value: unknown): value is FieldReference;
+export declare function isEventFieldReference(value: unknown): value is FieldReference;
+/**
+ * Generate conditional rules for a form field.
+ *
+ * @param fieldId - The field ID condition is applied to.
+ * @example to combine multiple conditions, utilise connectors like `and`, `or`, `not`:
+ *  and(field('foo').isEqualTo('bar'), field('baz').isUndefined())
+ *
+ */
+export declare function createFieldConditionals(fieldId: string): {
+    /**
+     * @private Internal property used for field reference tracking.
+     */
+    $$field: string;
+    /**
+     * @private Internal property used for solving a object path within field's value
+     */
+    $$subfield: string[];
+    get(fieldPath: string): {
+        $$subfield: string[];
+        /**
+         * @private Internal property used for field reference tracking.
+         */
+        $$field: string;
+        get(fieldPath: string): any;
+        getByPath(fieldPath: string[]): {
+            $$subfield: string[];
+            /**
+             * @private Internal property used for field reference tracking.
+             */
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => JSONSchema;
+                };
+                date: (date: string | FieldReference) => JSONSchema;
+                now: () => JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => 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;
+            /**
+             * 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(): 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(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => JSONSchema;
+            };
+            date: (date: string | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => 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;
+        /**
+         * 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(): 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;
+    };
+    getByPath(fieldPath: string[]): {
+        $$subfield: string[];
+        /**
+         * @private Internal property used for field reference tracking.
+         */
+        $$field: string;
+        get(fieldPath: string): {
+            $$subfield: string[];
+            /**
+             * @private Internal property used for field reference tracking.
+             */
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => JSONSchema;
+                };
+                date: (date: string | FieldReference) => JSONSchema;
+                now: () => JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => 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;
+            /**
+             * 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(): 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;
+        };
+        getByPath(fieldPath: string[]): any;
+        asDob(): {
+            $$subfield: string[];
+            /**
+             * @private Internal property used for field reference tracking.
+             */
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => JSONSchema;
+                };
+                date: (date: string | FieldReference) => JSONSchema;
+                now: () => JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => 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;
+            /**
+             * 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(): 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;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => JSONSchema;
+                };
+                date: (date: string | FieldReference) => JSONSchema;
+                now: () => JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => 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;
+            /**
+             * 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(): 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;
+        };
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => JSONSchema;
+            };
+            date: (date: string | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => 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;
+        /**
+         * 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(): 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;
+        getByPath(fieldPath: string[]): {
+            $$subfield: string[];
+            /**
+             * @private Internal property used for field reference tracking.
+             */
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => JSONSchema;
+                };
+                date: (date: string | FieldReference) => JSONSchema;
+                now: () => JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => 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;
+            /**
+             * 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(): 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(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => JSONSchema;
+            };
+            date: (date: string | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => 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;
+        /**
+         * 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(): 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;
+        getByPath(fieldPath: string[]): {
+            $$subfield: string[];
+            /**
+             * @private Internal property used for field reference tracking.
+             */
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => JSONSchema;
+                };
+                date: (date: string | FieldReference) => JSONSchema;
+                now: () => JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => JSONSchema;
+                    inFuture: () => JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                    fromNow: () => 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;
+            /**
+             * 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(): 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(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => JSONSchema;
+            };
+            date: (date: string | FieldReference) => JSONSchema;
+            now: () => JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => JSONSchema;
+                inFuture: () => JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+                fromNow: () => 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;
+        /**
+         * 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(): 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;
+    };
+    isAfter(): {
+        days: (days: number) => {
+            inPast: () => JSONSchema;
+            inFuture: () => JSONSchema;
+            fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+            fromNow: () => JSONSchema;
+        };
+        date: (date: string | FieldReference) => JSONSchema;
+        now: () => JSONSchema;
+    };
+    isBefore(): {
+        days: (days: number) => {
+            inPast: () => JSONSchema;
+            inFuture: () => JSONSchema;
+            fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
+            fromNow: () => 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;
+    /**
+     * 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(): 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;
+};
+export {};
+//# sourceMappingURL=conditionals.d.ts.map