@nira-opencrvs/toolkit 1.9.11-rc.1f36427

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

@@ -0,0 +1,2 @@
+export * from './conditionals';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,101 @@
+import { ConditionalParameters, JSONSchema } from './conditionals';
+import { ActionUpdate, EventState } from '../events/ActionDocument';
+import { FieldConditional } from '../events/Conditional';
+import { FieldConfig } from '../events/FieldConfig';
+import { FieldUpdateValue, FieldValue } from '../events/FieldValue';
+import { TranslationConfig } from '../events/TranslationConfig';
+import { ITokenPayload } from '../authentication';
+import { UUID } from '../uuid';
+import { ActionType, EventDocument } from '../client';
+export declare function validate(schema: JSONSchema, data: ConditionalParameters): boolean;
+export declare function validateValue(schema: JSONSchema, data: unknown): boolean;
+export declare function isOnline(): boolean;
+export declare function isConditionMet(conditional: JSONSchema, values: EventState | ActionUpdate, 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;
+    }>;
+    event?: EventDocument;
+};
+export declare function isFieldVisible(field: FieldConfig, form: Partial<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;
+        defaultMessage: string;
+        description: string;
+    };
+    invalidDate: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    invalidEmail: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    requiredField: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    invalidInput: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    unexpectedField: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    correctionNotAllowed: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+/**
+ * Custom error map for Zod to override the default error messages in intl-formik format.
+ */
+export type CustomZodToIntlErrorMap = {
+    /** Zod by default expects { message: string } */
+    message: {
+        /** Override it to match current intl-formik model */
+        message: TranslationConfig;
+    };
+};
+/**
+ * Validates primitive fields defined by the FieldConfig type.
+ * e.g. email is proper format, date is a valid date, etc.
+ * for custom validations @see runCustomFieldValidations
+ */
+export declare function validateFieldInput({ field, value, actionType }: {
+    field: FieldConfig;
+    value: FieldUpdateValue;
+    actionType?: ActionType;
+}): {
+    message: TranslationConfig;
+}[];
+export declare function runStructuralValidations({ field, values, context, actionType }: {
+    field: FieldConfig;
+    values: ActionUpdate;
+    context: ValidatorContext;
+    actionType?: ActionType;
+}): {
+    message: TranslationConfig;
+}[];
+export declare function runFieldValidations({ field, values, context }: {
+    field: FieldConfig;
+    values: ActionUpdate;
+    context: ValidatorContext;
+}): {
+    message: TranslationConfig;
+}[];
+export declare function getValidatorsForField(fieldId: FieldConfig['id'], validations: NonNullable<FieldConfig['validation']>): NonNullable<FieldConfig['validation']>;
+export declare function areCertificateConditionsMet(conditions: FieldConditional[], values: ConditionalParameters): boolean;
+//# sourceMappingURL=validate.d.ts.map