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

package/dist/commons/events/field.d.ts

@@ -0,0 +1,514 @@
+import { FieldConditional } from './Conditional';
+import { TranslationConfig } from './TranslationConfig';
+import { SelectOption, ValidationConfig } from './FieldConfig';
+/**
+ * Entry point for defining conditional logic or configuration for a form field.
+ * @param fieldId - The ID of the field to define rules or config for.
+ * @returns An object combining conditional methods and configuration builders.
+ */
+export declare function field(fieldId: string, options?: {
+    options?: SelectOption[];
+    conditionals?: FieldConditional[];
+    validations?: ValidationConfig[];
+    searchCriteriaLabelPrefix?: TranslationConfig;
+}): {
+    range: () => {
+        options?: SelectOption[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "range";
+        };
+    };
+    exact: () => {
+        options?: SelectOption[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "exact";
+        };
+    };
+    fuzzy: () => {
+        options?: SelectOption[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "fuzzy";
+        };
+    };
+    within: () => {
+        options?: SelectOption[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "within";
+        };
+    };
+    $$field: string;
+    $$subfield: string[];
+    get(fieldPath: string): {
+        $$subfield: string[];
+        $$field: string;
+        get(fieldPath: string): any;
+        getByPath(fieldPath: string[]): {
+            $$subfield: string[];
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isFalsy(): import("../conditionals/conditionals").JSONSchema;
+            isUndefined(): import("../conditionals/conditionals").JSONSchema;
+            inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+            isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+            isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+            matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+            isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+            getId: () => {
+                fieldId: string;
+            };
+            object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        };
+        asDob(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isFalsy(): import("../conditionals/conditionals").JSONSchema;
+        isUndefined(): import("../conditionals/conditionals").JSONSchema;
+        inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+        isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+        isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+        matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+        isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+        getId: () => {
+            fieldId: string;
+        };
+        object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+    };
+    getByPath(fieldPath: string[]): {
+        $$subfield: string[];
+        $$field: string;
+        get(fieldPath: string): {
+            $$subfield: string[];
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isFalsy(): import("../conditionals/conditionals").JSONSchema;
+            isUndefined(): import("../conditionals/conditionals").JSONSchema;
+            inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+            isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+            isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+            matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+            isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+            getId: () => {
+                fieldId: string;
+            };
+            object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        };
+        getByPath(fieldPath: string[]): any;
+        asDob(): {
+            $$subfield: string[];
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isFalsy(): import("../conditionals/conditionals").JSONSchema;
+            isUndefined(): import("../conditionals/conditionals").JSONSchema;
+            inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+            isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+            isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+            matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+            isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+            getId: () => {
+                fieldId: string;
+            };
+            object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        };
+        asAge(): {
+            $$subfield: string[];
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isFalsy(): import("../conditionals/conditionals").JSONSchema;
+            isUndefined(): import("../conditionals/conditionals").JSONSchema;
+            inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+            isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+            isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+            matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+            isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+            getId: () => {
+                fieldId: string;
+            };
+            object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        };
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isFalsy(): import("../conditionals/conditionals").JSONSchema;
+        isUndefined(): import("../conditionals/conditionals").JSONSchema;
+        inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+        isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+        isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+        matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+        isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+        getId: () => {
+            fieldId: string;
+        };
+        object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+    };
+    asDob(): {
+        $$subfield: string[];
+        $$field: string;
+        get(fieldPath: string): any;
+        getByPath(fieldPath: string[]): {
+            $$subfield: string[];
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isFalsy(): import("../conditionals/conditionals").JSONSchema;
+            isUndefined(): import("../conditionals/conditionals").JSONSchema;
+            inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+            isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+            isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+            matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+            isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+            getId: () => {
+                fieldId: string;
+            };
+            object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        };
+        asDob(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isFalsy(): import("../conditionals/conditionals").JSONSchema;
+        isUndefined(): import("../conditionals/conditionals").JSONSchema;
+        inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+        isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+        isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+        matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+        isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+        getId: () => {
+            fieldId: string;
+        };
+        object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+    };
+    asAge(): {
+        $$subfield: string[];
+        $$field: string;
+        get(fieldPath: string): any;
+        getByPath(fieldPath: string[]): {
+            $$subfield: string[];
+            $$field: string;
+            get(fieldPath: string): any;
+            getByPath(fieldPath: string[]): any;
+            asDob(): any;
+            asAge(): any;
+            isAfter(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isBefore(): {
+                days: (days: number) => {
+                    inPast: () => import("../conditionals/conditionals").JSONSchema;
+                    inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                    fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                    fromNow: () => import("../conditionals/conditionals").JSONSchema;
+                };
+                date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                now: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+            isFalsy(): import("../conditionals/conditionals").JSONSchema;
+            isUndefined(): import("../conditionals/conditionals").JSONSchema;
+            inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+            isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+            isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+            matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+            isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+            getId: () => {
+                fieldId: string;
+            };
+            object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        };
+        asDob(): any;
+        asAge(): any;
+        isAfter(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isBefore(): {
+            days: (days: number) => {
+                inPast: () => import("../conditionals/conditionals").JSONSchema;
+                inFuture: () => import("../conditionals/conditionals").JSONSchema;
+                fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+                fromNow: () => import("../conditionals/conditionals").JSONSchema;
+            };
+            date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            now: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+        isFalsy(): import("../conditionals/conditionals").JSONSchema;
+        isUndefined(): import("../conditionals/conditionals").JSONSchema;
+        inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+        isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+        isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+        matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+        isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+        getId: () => {
+            fieldId: string;
+        };
+        object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+    };
+    isAfter(): {
+        days: (days: number) => {
+            inPast: () => import("../conditionals/conditionals").JSONSchema;
+            inFuture: () => import("../conditionals/conditionals").JSONSchema;
+            fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            fromNow: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+        now: () => import("../conditionals/conditionals").JSONSchema;
+    };
+    isBefore(): {
+        days: (days: number) => {
+            inPast: () => import("../conditionals/conditionals").JSONSchema;
+            inFuture: () => import("../conditionals/conditionals").JSONSchema;
+            fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+            fromNow: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
+        now: () => import("../conditionals/conditionals").JSONSchema;
+    };
+    isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+    isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+    isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
+    isFalsy(): import("../conditionals/conditionals").JSONSchema;
+    isUndefined(): import("../conditionals/conditionals").JSONSchema;
+    inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
+    isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
+    isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
+    matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
+    isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
+    getId: () => {
+        fieldId: string;
+    };
+    object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+};
+//# sourceMappingURL=field.d.ts.map

package/dist/commons/events/index.d.ts

@@ -0,0 +1,45 @@
+export * from './Constants';
+export * from './ActionConfig';
+export * from './offline';
+export * from './EventConfig';
+export * from './EventConfigInput';
+export * from './FieldConfig';
+export * from './PageConfig';
+export * from './SummaryConfig';
+export * from './WorkqueueConfig';
+export * from './WorkqueueColumnConfig';
+export * from './workqueueDefaultColumns';
+export * from './Draft';
+export * from './EventMetadata';
+export * from './EventInput';
+export * from './EventDocument';
+export * from './ActionInput';
+export * from './ActionDocument';
+export * from './EventIndex';
+export * from './TranslationConfig';
+export * from './FieldValue';
+export * from './FormConfig';
+export * from './CompositeFieldValue';
+export * from './state';
+export * from './utils';
+export * from './defineConfig';
+export * from './DeduplicationConfig';
+export * from './transactions';
+export * from './FieldType';
+export * from './ActionType';
+export * from './FieldTypeMapping';
+export * from './Conditional';
+export * from './AdvancedSearchConfig';
+export * from './test.utils';
+export * from './TemplateConfig';
+export * from './scopes';
+export * from './serializer';
+export * from './state/availableActions';
+export * from './FileUtils';
+export * from '../conditionals/conditionals';
+export * from '../conditionals/validate';
+export * from './field';
+export * from './event';
+export * from './locations';
+export { UUID } from '../uuid';
+//# sourceMappingURL=index.d.ts.map

package/dist/commons/events/locations.d.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+export declare const LocationType: z.ZodEnum<["ADMIN_STRUCTURE", "CRVS_OFFICE", "HEALTH_FACILITY"]>;
+export type LocationType = z.infer<typeof LocationType>;
+export declare const Location: z.ZodObject<{
+    id: z.ZodBranded<z.ZodString, "UUID">;
+    name: z.ZodString;
+    parentId: z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>;
+    validUntil: z.ZodNullable<z.ZodString>;
+    locationType: z.ZodNullable<z.ZodEnum<["ADMIN_STRUCTURE", "CRVS_OFFICE", "HEALTH_FACILITY"]>>;
+}, "strip", z.ZodTypeAny, {
+    id: string & z.BRAND<"UUID">;
+    name: string;
+    parentId: (string & z.BRAND<"UUID">) | null;
+    validUntil: string | null;
+    locationType: "ADMIN_STRUCTURE" | "HEALTH_FACILITY" | "CRVS_OFFICE" | null;
+}, {
+    id: string;
+    name: string;
+    parentId: string | null;
+    validUntil: string | null;
+    locationType: "ADMIN_STRUCTURE" | "HEALTH_FACILITY" | "CRVS_OFFICE" | null;
+}>;
+export type Location = z.infer<typeof Location>;
+//# sourceMappingURL=locations.d.ts.map

package/dist/commons/events/scopes.d.ts

@@ -0,0 +1,55 @@
+import { ConfigurableScopeType, Scope } from '../scopes';
+import { DisplayableAction } from './ActionType';
+import { EventIndex } from './EventIndex';
+export declare const ACTION_SCOPE_MAP: {
+    READ: "record.read"[];
+    CREATE: "record.create"[];
+    NOTIFY: "record.notify"[];
+    DECLARE: ("record.register" | "record.declare" | "record.declared.validate")[];
+    DELETE: "record.declare"[];
+    VALIDATE: ("record.register" | "record.declared.validate")[];
+    REGISTER: "record.register"[];
+    PRINT_CERTIFICATE: "record.registered.print-certified-copies"[];
+    REQUEST_CORRECTION: ("record.registered.request-correction" | "record.registered.correct")[];
+    REVIEW_CORRECTION_REQUEST: "record.registered.correct"[];
+    REJECT_CORRECTION: "record.registered.correct"[];
+    APPROVE_CORRECTION: "record.registered.correct"[];
+    MARK_AS_DUPLICATE: "record.declared.review-duplicates"[];
+    MARK_AS_NOT_DUPLICATE: "record.declared.review-duplicates"[];
+    ARCHIVE: "record.declared.archive"[];
+    REJECT: "record.declared.reject"[];
+    ASSIGN: null;
+    UNASSIGN: null;
+    DUPLICATE_DETECTED: never[];
+};
+export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
+export declare function configurableEventScopeAllowed(scopes: Scope[], allowedConfigurableScopes: ConfigurableScopeType[], eventType: string): boolean;
+/**
+ * Checks if a given action is allowed for the provided scopes and event type.
+ *
+ * This function determines whether the user, with the given set of scopes, is authorized
+ * to perform the specified action on an event of the given type. It checks both "plain" scopes
+ * (hardcoded, non-configurable) and "configurable" scopes (which may be tied to specific event types).
+ *
+ * @param {Scope[]} scopes - The list of scopes the user possesses.
+ * @param {DisplayableAction} action - The action to check authorization for.
+ * @param {string} eventType - The type of event for which the action is being checked.
+ * @returns {boolean} True if the action is in scope for the user, otherwise false.
+ */
+export declare function isActionInScope(scopes: Scope[], action: DisplayableAction, eventType: string): boolean;
+/**
+ * A shared utility to check if the user can read a record.
+ * This will be removed in 1.10 and implemented by scopes.
+ *
+ * In order for us to limit the usage of 'record.read' scope, we allow users to view records they have created on system-level.
+ *
+ * @deprecated - Will be removed in 1.10
+ */
+export declare function canUserReadEvent(event: EventIndex | {
+    createdBy: string;
+    type: string;
+}, { userId, scopes }: {
+    userId: string;
+    scopes: string[];
+}): boolean;
+//# sourceMappingURL=scopes.d.ts.map

package/dist/commons/events/serializer.d.ts

@@ -0,0 +1,2 @@
+export { deserializeQuery } from './serializers/user/deserializer';
+//# sourceMappingURL=serializer.d.ts.map