@bolttech/form-engine-core 1.0.10 → 1.1.0

package/src/types/schema.d.ts

@@ -0,0 +1,1001 @@
+/** @virtual */
+import { TCurrencyCode, TCurrencyLocalCode } from '@gaignoux/currency';
+import { TEvents } from './event';
+import { TFormValues } from './form';
+import { ALLOWED_RESET_PROPS_MUTATIONS } from '../constants/constants';
+type TAllowedResetPropsMutations = (typeof ALLOWED_RESET_PROPS_MUTATIONS)[number];
+/**
+ * @type TAllowedResetPropsMutationsEnum
+ * Represents the allowed properties to be changed on resetPropertyValues.
+ *
+ * @property {never} api - api property
+ * @property {never} apiSchema - apiSchema property
+ * @property {never} props - props property
+ * @property {never} validations - validations property
+ * @property {never} visibilityConditions - visibilityConditions property
+ * @property {never} resetValues - resetValues property
+ *
+ * @interface
+ */
+type TAllowedResetPropsMutationsEnum = Record<TAllowedResetPropsMutations, never>;
+/**
+ * @type TLengthValidation
+ * Represents the validation rules based on the length of the input.
+ *
+ * @property {'equal' | 'notEqual' | 'less' | 'lessOrEqual' | 'greater' | 'greaterOrEqual'} rule - The rule to apply.
+ * @property {number} target - The target value to compare against.
+ *
+ * @example
+ * ```typescript
+ * const lengthValidation: TLengthValidation = { rule: 'greaterOrEqual', target: 8 };
+ * ```
+ */
+type TLengthValidation = {
+    rule: 'equal' | 'notEqual' | 'less' | 'lessOrEqual' | 'greater' | 'greaterOrEqual';
+    target: number;
+};
+/**
+ * @type TCallbackValidation
+ * A custom validation function.
+ *
+ * @param {unknown} value - The value to validate.
+ * @returns {boolean} - The result of the validation.
+ *
+ * @example
+ * ```typescript
+ * const callbackValidation: TCallbackValidation = (value) => typeof value === 'string';
+ * ```
+ */
+type TCallbackValidation = (value: unknown, formValues: Pick<TFormValues<unknown>, 'values' | 'metadata'>) => boolean;
+/**
+ * @type TBetweenValidation
+ * Represents validation rules that check if a value is between a range.
+ *
+ * @property {number} start - The start of the range.
+ * @property {number} end - The end of the range.
+ *
+ * @example
+ * ```typescript
+ * const betweenValidation: TBetweenValidation = { start: 1, end: 10 };
+ * ```
+ */
+type TBetweenValidation = {
+    start: number;
+    end: number;
+};
+/**
+ * @type TCreditCardMatch
+ * Represents the options for credit card matching.
+ *
+ * @property {string} numberCard - The credit card number.
+ * @property {string[]} availableOptions - The available options for matching.
+ *
+ * @example
+ * ```typescript
+ * const creditCardMatch: TCreditCardMatch = { numberCard: '1234', availableOptions: ['Visa', 'MasterCard'] };
+ * ```
+ */
+type TCreditCardMatch = {
+    numberCard: string;
+    availableOptions: string[];
+};
+/**
+ * @type TDocumentValidation
+ * Represents validation for specific document types.
+ *
+ * @property {'NIF' | 'NIE' | 'CIF' | 'IBAN'} type - The type of document.
+ * @property {TCurrencyLocalCode} [locale] - The locale code for validation.
+ *
+ * @example
+ * ```typescript
+ * const documentValidation: TDocumentValidation = { type: 'NIF', locale: 'ES' };
+ * ```
+ */
+type TDocumentValidation = {
+    type: 'NIF' | 'NIE' | 'CIF' | 'IBAN';
+    locale?: TCurrencyLocalCode;
+};
+/**
+ * @type TDateOperatorsValidation
+ * Represents the operators used for date validation conditions.
+ *
+ * @property {'<' | '>' | '===' | '>=' | '<=' | '!==' | '!!origin'}
+ *
+ * @example
+ * ```typescript
+ * const operator: TDateOperatorsValidation = '<';
+ * ```
+ */
+type TDateOperatorsValidation = '<' | '>' | '===' | '>=' | '<=' | '!==' | '!!origin';
+/**
+ * @type TConditionsValidationSet
+ * Represents a single validation condition set.
+ *
+ * @property {boolean} [forceDefinedOrigin] - Flag to force the origin value to be defined.
+ * @property {boolean} [forceDefinedTarget] - Flag to force the target value to be defined.
+ * @property {string | number | boolean} [origin] - The origin value for the condition.
+ * @property {TDateOperatorsValidation} condition - The validation condition operator.
+ * @property {string | number | boolean} [target] - The target value for the condition.
+ *
+ * @example
+ * ```typescript
+ * const conditionSet: TConditionsValidationSet = {
+ *   forceDefinedOrigin: true,
+ *   forceDefinedTarget: true,
+ *   origin: '2023-01-01',
+ *   condition: '>',
+ *   target: '2022-01-01'
+ * };
+ * ```
+ */
+type TConditionsValidationSet = {
+    forceDefinedOrigin?: boolean;
+    forceDefinedTarget?: boolean;
+    origin?: string | number | boolean | null;
+    condition: TDateOperatorsValidation;
+    target?: string | number | boolean;
+};
+/**
+ * @type TConditionsValidation
+ * Represents a set of validation conditions.
+ *
+ * @property {'and' | 'or'} rule - The logical rule to combine the conditions (AND/OR).
+ * @property {TConditionsValidationSet[]} set - The array of validation condition sets.
+ * @property {TConditionsValidation} [conditions] - Nested conditions for more complex validation logic.
+ *
+ * @example
+ * ```typescript
+ * const conditionsValidation: TConditionsValidation = {
+ *   rule: 'and',
+ *   set: [
+ *     {
+ *       forceDefinedOrigin: true,
+ *       forceDefinedTarget: true,
+ *       origin: '2023-01-01',
+ *       condition: '>',
+ *       target: '2022-01-01'
+ *     }
+ *   ],
+ *   conditions: {
+ *     rule: 'or',
+ *     set: [
+ *       {
+ *         origin: true,
+ *         condition: '!!origin',
+ *         target: false
+ *       }
+ *     ]
+ *   }
+ * };
+ * ```
+ */
+type TConditionsValidation = {
+    rule: 'and' | 'or';
+    set: TConditionsValidationSet[];
+    conditions?: TConditionsValidation;
+};
+type TAvailableValidations = Omit<TValidationMethods, 'multipleValidations'> | TGenericValidationRule;
+/**
+ * @type TMultipleValidation
+ * Represents a set of multiple validation methods combined with a logical rule.
+ *
+ * @property {'AND' | 'OR' | 'NOT'} rule - The logical rule to combine the validation methods (AND, OR, NOT).
+ * @property {TAvailableValidations} validations - The validation methods to be combined.
+ *
+ * @example
+ * ```typescript
+ * const multipleValidation: TMultipleValidation = {
+ *   rule: 'AND',
+ *   validations: {
+ *     required: true,
+ *     min: 5,
+ *     max: 10
+ *   }
+ * };
+ * ```
+ */
+type TMultipleValidation = {
+    rule: 'AND' | 'OR' | 'NOT';
+    validations: TAvailableValidations;
+};
+/**
+ * @type TBetweenDatesValidation
+ * Represents a validation method to check if a value falls between specified dates.
+ *
+ * @property {TDateValidation[]} [TBetweenDatesValidation] - An array of date validation methods.
+ *
+ * @example
+ * ```typescript
+ * const betweenDatesValidation: TBetweenDatesValidation = [
+ *    {
+ *      onlyValidDate: true,
+ *      operator: '>=',
+ *      origin: {
+ *        format: 'MMDDYYYY',
+ *        intervals: {
+ *          years: 1
+ *        }
+ *      },
+ *      target: {
+ *        value: Date.now(),
+ *        format: 'timestamp',
+ *        value: '01/01/2023',
+ *      }
+ *    },
+ *    {
+ *      onlyValidDate: true,
+ *      operator: '<=',
+ *      origin: {
+ *        format: 'MMDDYYYY',
+ *        intervals: {
+ *          years: 1
+ *        }
+ *      },
+ *      target: {
+ *        format: 'timestamp',
+ *        value: '31/12/2023',
+ *      }
+ *    }
+ * ];
+ * ```
+ */
+type TBetweenDatesValidation = TDateValidation[];
+/**
+ * @type TDateFormatsValidation
+ * Represents the supported date formats for validation.
+ *
+ * @type {'MMDDYYYY' | 'DDMMYYYY' | 'YYYYMMDD' | 'YYYYDDMM' | 'timestamp'}
+ *
+ * @example
+ * ```typescript
+ * const dateFormat: TDateFormatsValidation = 'MMDDYYYY';
+ * ```
+ */
+type TDateFormatsValidation = 'MMDDYYYY' | 'DDMMYYYY' | 'YYYYMMDD' | 'YYYYDDMM' | 'timestamp';
+type TDateInterval = {
+    years?: number;
+    months?: number;
+    days?: number;
+};
+/**
+ * @type TDateValidation
+ * Represents a validation method for date values.
+ *
+ * @property {boolean} [onlyValidDate] - Flag to validate only if the date is valid.
+ * @property {TDateOperatorsValidation} operator - The validation operator to be used.
+ * @property {Object} origin - The origin date configuration.
+ * @property {string | number} [origin.value] - The origin date value.
+ * @property {TDateFormatsValidation} origin.format - The format of the origin date.
+ * @property {Object} [origin.intervals] - The intervals to add to the origin date for comparison.
+ * @property {number} [origin.intervals.years] - The number of years to add.
+ * @property {number} [origin.intervals.months] - The number of months to add.
+ * @property {number} [origin.intervals.days] - The number of days to add.
+ * @property {Object} [target] - The target date configuration.
+ * @property {string | number} target.value - The target date value.
+ * @property {TDateFormatsValidation} target.format - The format of the target date.
+ *
+ * @example
+ * ```typescript
+ * const dateValidation: TDateValidation = {
+ *   onlyValidDate: true,
+ *   operator: '===',
+ *   origin: {
+ *     value: '10/10/2022',
+ *     format: 'MMDDYYYY',
+ *     intervals: {
+ *       years: 1
+ *     }
+ *   },
+ *   target: {
+ *     value: Date.now(),
+ *     format: 'timestamp'
+ *   }
+ * };
+ * ```
+ */
+type TDateValidation = {
+    onlyValidDate?: boolean;
+    operator: TDateOperatorsValidation;
+    origin: {
+        value?: string | number;
+        format: TDateFormatsValidation;
+        /**
+         * Intervals to compare with the original date.
+         *
+         * It will use today's date for comparison.
+         *
+         * @example
+         * ```typescript
+         * origin date = 10/10/2022
+         * interval.year = 1
+         * operator = '==='
+         * ```
+         *
+         * It will compare (10/10/2022 + 1) with the current date and check if they are the same
+         */
+        intervals?: TDateInterval;
+    };
+    target?: {
+        value: string | number;
+        format: TDateFormatsValidation;
+    };
+};
+/**
+ * @type TValidationMethods
+ * Represents the various validation methods that can be applied to form fields.
+ *
+ * @property {number} [max] - Maximum value or length.
+ * @property {number} [min] - Minimum value or length.
+ * @property {number} [lessThan] - Minimum value or length.
+ * @property {number} [greaterThan] - Minimum value or length.
+ * @property {TLengthValidation} [length] - Length validation rule.
+ * @property {boolean} [required] - Indicates if the field is required.
+ * @property {unknown} [value] - Specific value to match.
+ * @property {string} [regex] - Regular expression for validation.
+ * @property {boolean} [email] - Indicates if the value should be a valid email.
+ * @property {boolean} [url] - Indicates if the value should be a valid URL.
+ * @property {boolean} [onlyLetters] - Indicates if the value should contain only letters.
+ * @property {boolean} [notAllowSpaces] - Indicates if spaces are not allowed.
+ * @property {TCallbackValidation} [callback] - Custom validation callback function.
+ * @property {boolean} [isNumber] - Indicates if the value should be a number.
+ * @property {boolean} [bool] - Indicates if the value should be a boolean or a string that can be converted to a boolean.
+ * @property {boolean | string} [exists] - Indicates if the value should exist or match a specific existence condition.
+ * @property {boolean} [hasNoExtraSpaces] - Indicates if there should be no extra spaces.
+ * @property {boolean} [notEmpty] - Indicates if the field should not be empty.
+ * @property {TBetweenValidation} [between] - Validation rule for range between two values.
+ * @property {boolean} [sequential] - Indicates if the value should be sequential.
+ * @property {boolean} [repeated] - Indicates if the value should not be repeated.
+ * @property {string[] | number[]} [includes] - Array of values that should be included.
+ * @property {string[]} [isCreditCard] - Array of valid credit card numbers.
+ * @property {TCreditCardMatch} [isCreditCodeMatch] - Validation rule for credit card matching.
+ * @property {string[]} [isCreditCardAndLength] - Array of valid credit card numbers with length check.
+ * @property {TDocumentValidation} [document] - Document validation rule.
+ * @property {TConditionsValidation} [conditions] - Conditional validation rules.
+ * @property {TMultipleValidation} [multipleValidations] - Multiple validation rules combined with a logical rule.
+ * @property {TBetweenDatesValidation} [betweenDates] - Validation rule for checking if a date falls between two dates.
+ * @property {TDateValidation} [date] - Validation rule for date values.
+ * @property {TDateFormatsValidation} [validDate] - Validation rule for valid date formats.
+ *
+ * @example
+ * ```typescript
+ * const validationMethods: TValidationMethods = {
+ *   max: 100,
+ *   min: 1,
+ *   lessThan: 1995,
+ *   greaterThan: 82000,
+ *   length: { rule: 'greaterOrEqual', target: 8 },
+ *   required: true,
+ *   regex: '^[a-zA-Z0-9]+$',
+ *   email: true,
+ *   conditions: {
+ *     rule: 'and',
+ *     set: [
+ *       {
+ *         forceDefinedOrigin: true,
+ *         forceDefinedTarget: true,
+ *         origin: '2023-01-01',
+ *         condition: '>',
+ *         target: '2022-01-01'
+ *       }
+ *     ]
+ *   },
+ *   multipleValidations: {
+ *     rule: 'AND',
+ *     validations: {
+ *       required: true,
+ *       min: 5,
+ *       max: 10
+ *     }
+ *   },
+ *   betweenDates: {
+ *     start: Date.parse('2023-01-01'),
+ *     end: Date.parse('2023-12-31'),
+ *     isIncludedBoundaries: true
+ *   },
+ *   date: {
+ *     operator: '===',
+ *     origin: {
+ *       value: '10/10/2022',
+ *       format: 'MMDDYYYY',
+ *       intervals: {
+ *         years: 1
+ *       }
+ *     },
+ *     target: {
+ *       value: Date.now(),
+ *       format: 'timestamp'
+ *     }
+ *   },
+ *   validDate: 'MMDDYYYY'
+ * };
+ * ```
+ */
+type TValidationMethods = {
+    /** Maximum value or length. */
+    max?: number;
+    /** Minimum value or length. */
+    min?: number;
+    /** Minimum value or length. */
+    lessThan?: number;
+    /** Minimum value or length. */
+    greaterThan?: number;
+    /** Length validation rule. */
+    length?: TLengthValidation;
+    /** Indicates if the field is required. */
+    required?: boolean;
+    /** Specific value to match. */
+    value?: unknown;
+    /** Regular expression for validation. */
+    regex?: string;
+    /** Indicates if the value should be a valid email. */
+    email?: boolean;
+    /** Indicates if the value should be a valid URL. */
+    url?: boolean;
+    /** Indicates if the value should contain only letters. */
+    onlyLetters?: boolean;
+    /** Indicates if spaces are not allowed. */
+    notAllowSpaces?: boolean;
+    /** Custom validation callback function. */
+    callback?: TCallbackValidation;
+    /** Indicates if the value should be a number. */
+    isNumber?: boolean;
+    /** Indicates if the value should be a boolean or a string that can be converted to a boolean. */
+    bool?: boolean | string;
+    /** Indicates if the value should exist or match a specific existence condition. */
+    exists?: boolean | string;
+    /** Indicates if there should be no extra spaces. */
+    hasNoExtraSpaces?: boolean;
+    /** Indicates if the field should not be empty. */
+    notEmpty?: boolean;
+    /** Validation rule for range between two values. */
+    between?: TBetweenValidation;
+    /** Indicates if the value should be sequential. */
+    sequential?: boolean;
+    /** Indicates if the value should not be repeated. */
+    repeated?: boolean;
+    /** Array of values that should be included. */
+    includes?: (string | number)[];
+    /** Array of valid credit card numbers. */
+    isCreditCard?: string[];
+    /** Validation rule for credit card matching. */
+    isCreditCodeMatch?: TCreditCardMatch;
+    /** Array of valid credit card numbers with length check. */
+    isCreditCardAndLength?: string[];
+    /** Document validation rule. */
+    document?: TDocumentValidation;
+    /** Conditional validation rules. */
+    conditions?: TConditionsValidation;
+    /** Multiple validation rules combined with a logical rule. */
+    multipleValidations?: TMultipleValidation;
+    /** Validation rule for checking if a date falls between two dates. */
+    betweenDates?: TBetweenDatesValidation;
+    /** Validation rule for date values. */
+    date?: TDateValidation;
+    /** Validation rule for valid date formats. */
+    validDate?: TDateFormatsValidation;
+};
+/**
+ * @type {Object.<string, TValidationMethods>} TGenericValidationRule
+ * Represents a generic validation rule where each key is associated with a set of validation methods.
+ *
+ * @example
+ * const genericValidationRule = {
+ *   email: {
+ *     required: true,
+ *     email: true,
+ *   },
+ *   password: {
+ *     required: true,
+ *     minLength: 8,
+ *   },
+ * };
+ */
+type TGenericValidationRule = Record<string, TValidationMethods>;
+/**
+ * @type {TValidationMethods | TGenericValidationRule} TSchemaValidation
+ * Represents the schema validation which can be either a set of validation methods or a generic validation rule.
+ *
+ * @example
+ * const schemaValidation = {
+ *   required: true,
+ *   maxLength: 10,
+ * };
+ *
+ * const genericSchemaValidation = {
+ *   email: {
+ *     required: true,
+ *     email: true,
+ *   },
+ *   password: {
+ *     required: true,
+ *     minLength: 8,
+ *   },
+ * };
+ * @interface
+ */
+type TSchemaValidation = TValidationMethods | TGenericValidationRule;
+/**
+ * Formatter types
+ * @type TSplitterFormatterValue
+ * Represents a value and its position for splitting or formatting purposes.
+ *
+ * @property {string} value - The value to be split or formatted.
+ * @property {number} position - The position for splitting or formatting.
+ *
+ * @example
+ * ```typescript
+ * const splitterFormatter: TSplitterFormatterValue = { value: '-', position: 3 };
+ * ```
+ */
+type TSplitterFormatterValue = {
+    value: string;
+    position: number;
+};
+/**
+ * @type TFormatters
+ * Represents the various formatting options that can be applied to form field values.
+ *
+ * @property {boolean} [dotEvery3chars] - Add a dot every 3 characters.
+ * @property {boolean} [capitalize] - Capitalize the value.
+ * @property {boolean} [uppercase] - Convert the value to uppercase.
+ * @property {boolean} [onlyNumbers] - Allow only numbers.
+ * @property {boolean} [onlyLetters] - Allow only letters.
+ * @property {Pick<TCurrencyMask, 'precision' | 'decimal'>} [onlyFloatNumber] - Allow only float numbers with specific precision and decimal.
+ * @property {string} [regex] - Regular expression for formatting.
+ * @property {string[]} [gapsCreditCard] - Gaps to insert in credit card numbers.
+ * @property {(value: unknown) => unknown} [callback] - Custom formatter callback function.
+ * @property {TSplitterFormatterValue[]} [splitter] - Splitter values for formatting.
+ * @property {boolean} [trim] - Removes whitespace from both ends of this string and returns a new string, without modifying the original string.
+ * @property {number} [maxLength] - Truncates the input value to a specified maximum length if necessary.
+ *
+ * @example
+ * ```json
+ * {
+ *   formatters: {
+ *      dotEvery3chars: true,
+ *      capitalize: true,
+ *      uppercase: true,
+ *      onlyNumbers: true,
+ *      regex: '^[a-zA-Z0-9]+$',
+ *      gapsCreditCard: [' ', ' '],
+ *      callback: (value) => value.toString().toUpperCase(),
+ *      splitter: [{ value: '-', position: 3 }],
+ *      trim: true,
+ *      maxLength: 15
+ *   }
+ * }
+ * ```
+ */
+type TFormatters = {
+    /** Add a dot every 3 characters. */
+    dotEvery3chars?: boolean;
+    /** Capitalize the value. */
+    capitalize?: boolean;
+    /** Convert the value to uppercase. */
+    uppercase?: boolean;
+    /** Allow only numbers. */
+    onlyNumbers?: boolean;
+    /** Allow only letters. */
+    onlyLetters?: boolean;
+    /** Allow only float numbers with specific precision and decimal. */
+    onlyFloatNumber?: Pick<TCurrencyMask, 'precision' | 'decimal'>;
+    /** Regular expression for formatting. */
+    regex?: string;
+    gapsCreditCard?: string[] | boolean;
+    callback?: ((value: unknown) => unknown) | null;
+    splitter?: TSplitterFormatterValue[];
+    /** Removes whitespace from both ends of this string and returns a new string, without modifying the original string. */
+    trim?: boolean;
+    /** Truncates the input value to a specified maximum length if necessary. */
+    maxLength?: number;
+};
+/**
+ * Mask types
+ * @type TCurrencyMask
+ * Represents the mask configuration for currency values.
+ *
+ * @property {'left' | 'right'} [align] - The alignment of the currency symbol. (default: right)
+ * @property {string} [decimal] - The decimal separator. (default: '.')
+ * @property {number} [precision] - The number of decimal places. (default: 2)
+ * @property {TCurrencyCode} [prefix] - The currency symbol prefix. (default: '$')
+ * @property {string} [thousands] - The thousands separator. (default: ',')
+ *
+ * @example
+ * ```typescript
+ * const currencyMask: TCurrencyMask = {
+ *   align: 'left',
+ *   decimal: '.',
+ *   precision: 2,
+ *   prefix: '$',
+ *   thousands: ','
+ * };
+ * ```
+ */
+type TCurrencyMask = {
+    align?: 'left' | 'right';
+    decimal?: string;
+    precision?: number;
+    prefix?: TCurrencyCode;
+    thousands?: string;
+};
+/**
+ * @type TMaskGeneric
+ * Represents a generic mask configuration.
+ *
+ * @property {number} to - The ending position of the mask.
+ * @property {number} from - The starting position of the mask.
+ * @property {string} mask - The mask pattern to apply.
+ *
+ * @example
+ * ```typescript
+ * const maskGeneric: TMaskGeneric = { to: 4, from: 0, mask: '****' };
+ * ```
+ */
+type TMaskGeneric = {
+    to: number;
+    from: number;
+    mask: string;
+};
+/**
+ * @type TMasks
+ * Represents the different types of masks that can be applied to form field values.
+ *
+ * @property {TCurrencyMask} [currency] - Mask for currency values.
+ * @property {TMaskGeneric[]} [generic] - Array of generic masks.
+ * @property {string} [custom] - Custom mask pattern.
+ * @property {boolean} [secureCreditCard] - Mask for securing credit card values.
+ * @property {boolean} [card] - Mask for card values.
+ * @property {boolean} [cardDate] - Mask for card date values.
+ * @property {boolean} [fein] - Mask for FEIN (Federal Employer Identification Number).
+ * @property {string | number} [replaceAll] - Value to replace all matches.
+ * @property {(value: unknown) => string} [callback] - Custom mask callback function.
+ *
+ * @example
+ * ```typescript
+ * const masks: TMasks = {
+ *   currency: { align: 'left', decimal: '.', precision: 2, prefix: '$', thousands: ',' },
+ *   generic: [{ to: 4, from: 0, mask: '****' }],
+ *   custom: '###-##-####',
+ *   secureCreditCard: true,
+ *   card: true,
+ *   cardDate: true,
+ *   fein: true,
+ *   replaceAll: '*',
+ *   callback: (value) => value.toString().replace(/\d/g, '*')
+ * };
+ * ```
+ */
+type TMasks = {
+    /** Mask for currency values. */
+    currency?: TCurrencyMask;
+    /** Array of generic masks. */
+    generic?: TMaskGeneric[];
+    /** Custom mask pattern. */
+    custom?: string | null;
+    /** Mask for securing credit card values. */
+    secureCreditCard?: boolean;
+    /** Mask for card values. */
+    card?: boolean;
+    /** Mask for card date values. */
+    cardDate?: boolean;
+    /** Mask for FEIN (Federal Employer Identification Number). */
+    fein?: boolean;
+    /** Value to replace all matches. */
+    replaceAll?: string | number;
+    /** Custom mask callback function. */
+    callback?: (value: unknown) => string;
+};
+/**
+ * @type TVisibility
+ * Represents the visibility conditions for form fields based on validations.
+ *
+ * @property {boolean} showOnlyIfTrue - Enables visibility of fields only if any or all validation conditions are positive.
+ * @property {TSchemaValidation} validations - The validation methods to determine visibility.
+ * @property {string[] | string} fields - The fields to be shown or hidden based on validations.
+ * @property {string[]} events - Events where visibility will occur.
+ *
+ * @example
+ * ```typescript
+ * const visibility: TVisibility = {
+ *   showOnlyIfTrue: false,
+ *   validations: { required: true },
+ *   fields: ['fieldName'],
+ *   events: ['ON_FIELD_CHANGE']
+ * };
+ * ```
+ */
+type TVisibility = {
+    showOnlyIfTrue?: boolean;
+    validations: TSchemaValidation;
+    fields: string[] | string;
+    events: TEvents[];
+};
+/**
+ * @type TResetValueMethods
+ * @extends TVisibility with methods to reset values.
+ * @summary schema method to reset values from event
+ * much cool such wow
+ *
+ * @property {unknown[] | unknown} resettledValue - The values to reset.
+ * @property {Partial<TEvents>[]} events - events that will react to the value reset
+ * @property {string | string[]} fields - fields that will react to the value reset
+ * @property {TSchemaValidation} validations - validations to trigger the property reset
+ *
+ *
+ * @example
+ * ```typescript
+ * const resetValueMethods: TResetValueMethods = {
+ *   validations: { required: true },
+ *   fields: ['fieldName'],
+ *   resettledValue: [''],
+ *   events: ['ON_FIELD_CHANGE]
+ * };
+ * ```
+ * @interface
+ */
+type TResetValueMethods = Omit<TVisibility, 'showOnlyIfTrue' | 'validations'> & {
+    resettledValue: unknown[] | unknown;
+    validations?: TSchemaValidation;
+};
+/**
+ * @type TResetPathMethods
+ * Method to reset some field properties other than component props or field value
+ *
+ * @property {TAllowedResetPropsMutations} property property to be changed, ex: api, resetValues, etc..
+ * @property {string} path path where the property to be changed is located
+ * @property {string} field field that will recieve the property change
+ * @property {unknown} resettledValue value to be replaced onto the property
+ * @property {TSchemaValidation} validations validations rules to be validated to change the property value
+ * @property {Partial<TEvents>[]} events events to listen to apply this change
+ *
+ * @example
+ * ```typescript
+ * const resetValueMethods: TResetValueMethods = {
+ *   validations: { required: true },
+ *   fields: ['fieldName'],
+ *   resettledValue: ['']
+ * };
+ * ```
+ */
+type TResetPathMethods = {
+    property: TAllowedResetPropsMutations;
+    path: string;
+    field: string;
+    resettledValue: unknown;
+    validations: TSchemaValidation;
+    events: Partial<TEvents>[];
+};
+/**
+ * @type TApiConfig
+ * Represents the configuration for an API request.
+ *
+ * @property {'GET' | 'POST'} method - The HTTP method for the request.
+ * @property {string} url - The URL for the request.
+ * @property {Record<string, string>} [headers] - The headers for the request.
+ * @property {Record<string, string>} queryParams - query parameters for request.
+ * @property {string} [resultPath] - The path to extract the result from the response.
+ * @property {unknown} [fallbackValue] - The fallback value if the request fails.
+ * @property {TSchemaValidation} preConditions - validation conditions to execute the API call
+ * @property {boolean} blockRequestWhenInvalid - blocks request when field validation fails
+ *
+ * @example
+ * ```typescript
+ * const apiConfig: TApiConfig = {
+ *   method: 'POST',
+ *   url: 'https://api.example.com/data',
+ *   headers: { 'Content-Type': 'application/json' },
+ *   resultPath: 'data.results',
+ *   fallbackValue: [],
+ *   preConditions: {
+ *     required: true,
+ *   }
+ *   blockRequestWhenInvalid: true,
+ * };
+ * ```
+ */
+type TApiConfig = {
+    /** The HTTP method for the request. */
+    method: 'GET' | 'POST';
+    /** The URL for the request. */
+    url: string;
+    /** The body payload for the request. */
+    body?: Record<string, unknown>;
+    /** The headers for the request. */
+    headers?: Record<string, string>;
+    /** Query parameters for the request. */
+    queryParams?: Record<string, string>;
+    /** The path to extract the result from the response. */
+    resultPath?: string;
+    /** The fallback value if the request fails. */
+    fallbackValue?: unknown;
+    /** Validation conditions to execute the API call. */
+    preConditions?: TSchemaValidation;
+    /** Blocks request when field validation fails. */
+    blockRequestWhenInvalid?: boolean;
+    /** Custom transform callback for the request payload. */
+    transform?: {
+        callback(callbackPayload: {
+            payload: unknown;
+            formValues: TFormValues<unknown>;
+        }): unknown;
+    };
+};
+/**
+ * @type TProps
+ * Represents the properties for a component.
+ */
+type TProps = Record<string, unknown>;
+/**
+ * @type TValidations
+ * Represents the validation configuration for form fields, including methods, event-specific messages, and error messages.
+ *
+ * @property {TSchemaValidation} methods - The validation methods to be applied.
+ * @property {Partial<Record<TEvents, string[]>>} eventMessages - The messages to be displayed for specific validation events.
+ * @property {TErrorMessages} messages - The general error messages for validation methods.
+ *
+ * @interface
+ *
+ * @example
+ * ```typescript
+ * const validations: TValidations = {
+ *   methods: {
+ *     max: 100,
+ *     required: true,
+ *     regex: '^[a-zA-Z0-9]+$',
+ *   },
+ *   eventMessages: {
+ *     ON_FIELD_MOUNT: ['required'],
+ *     ON_FIELD_CHANGE: ['regex', 'required'],
+ *     ON_FIELD_BLUR: ['max', 'required'],
+ *   },
+ *   messages: {
+ *     default: 'This field is required',
+ *     max: 'Value exceeds the maximum limit',
+ *     regex: 'Value does not match the pattern',
+ *   },
+ * };
+ * ```
+ */
+type TValidations = {
+    methods: TSchemaValidation;
+    eventMessages?: TEventMessages;
+    messages?: TErrorMessages;
+};
+/**
+ * @type TValidations
+ * Represents the validation configuration for form fields, including methods, event-specific messages, and error messages.
+ *
+ * @property {TSchemaValidation} methods - The validation methods to be applied.
+ * @property {Partial<Record<TEvents, string[]>>} eventMessages - The messages to be displayed for specific validation events.
+ * @property {TErrorMessages} messages - The general error messages for validation methods.
+ *
+ * @example
+ * ```typescript
+ * const eventMessages: {
+ *     ON_FIELD_MOUNT: ['required'],
+ *     ON_FIELD_CHANGE: ['regex', 'required'],
+ *     ON_FIELD_BLUR: ['max', 'required'],
+ *   },
+ * ```
+ * @interface
+ */
+type TEventMessages = Partial<Record<TEvents, TEventMessagesValidationMethods[]>>;
+/**
+ * @type TEventMessagesValidationMethods
+ *
+ * allowed validation methods to trigger the event messages desc
+ *
+ * @property {keyof TValidationMethods | TAnyKey;} TEventMessagesValidationMethods - allowed validation methods to trigger the event messages
+ */
+type TEventMessagesValidationMethods = keyof TValidationMethods | TAnyKey;
+type TAnyKey = string & NonNullable<unknown>;
+/**
+ * @type TErrorMessages
+ * Represents the error messages for different validation methods.
+ * @property {string} default - the message to display regardless the validation
+ *
+ * @example
+ * ```typescript
+ * const errorMessages: TErrorMessages = {
+ *   required: 'This field is required.',
+ *   max: 'The value cannot exceed the maximum limit.'
+ *   default: 'Default error message'
+ * };
+ * ```
+ * @interface
+ */
+type TErrorMessages = Partial<Record<keyof TSchemaValidation | 'default' | (string & NonNullable<unknown>), string>>;
+/**
+ * Represents an event configuration with a specific type.
+ *
+ * @template T
+ * @property {T} config - The configuration of the event.
+ * @property {Partial<TEvents>[]} events - The events associated with the configuration.
+ */
+type TEvent<T> = {
+    config: T;
+    events: TEvents[];
+};
+/**
+ * Represents the API event configurations.
+ *
+ * @property {TEvent<TApiConfig>} [defaultConfig] - The default event configuration.
+ * @property {Record<string, TEvent<TApiConfig>>} [configs] - Named event configurations.
+ *
+ * @example
+ * ```typescript
+ * const apiEvent: TApiEvent = {
+ *   defaultConfig: {
+ *     config: {
+ *       method: 'POST',
+ *       url: 'https://api.example.com/data',
+ *       headers: { 'Content-Type': 'application/json' },
+ *       resultPath: 'data.results',
+ *       fallbackValue: [],
+ *       preConditions: {
+ *         required: true,
+ *       },
+ *       blockRequestWhenInvalid: true,
+ *     },
+ *     events: ['ON_FIELD_MOUNT', 'ON_FIELD_CHANGE'],
+ *   },
+ *   configs: {
+ *     example_config_name: {
+ *       config: {
+ *         method: 'POST',
+ *         url: 'https://api.example.com/data',
+ *         headers: { 'Content-Type': 'application/json' },
+ *         resultPath: 'data.results',
+ *         fallbackValue: [],
+ *         preConditions: {
+ *           required: true,
+ *         },
+ *         blockRequestWhenInvalid: true,
+ *       },
+ *       events: ['ON_FIELD_MOUNT', 'ON_FIELD_CHANGE'],
+ *     },
+ *   },
+ * };
+ * ```
+ */
+type TApiEvent = {
+    defaultConfig?: TEvent<TApiConfig>;
+    configs?: Record<string, TEvent<TApiConfig>>;
+};
+/**
+ * Represents the API response return payload for handling.
+ *
+ * @property {unknown} response - The default response.
+ * @property {number | null} status - response http status number.
+ */
+type TApiResponsePayload = {
+    response: unknown;
+    status: number | null;
+};
+/**
+ * Represents the API response structure.
+ *
+ * @property {TApiResponsePayload} default - The default response.
+ * @property {Record<string, TApiResponsePayload>} [named] - Named responses.
+ */
+type TApiResponse = {
+    default: TApiResponsePayload;
+    named?: Record<string, TApiResponsePayload>;
+    apiState: {
+        loading: boolean;
+        lastEvent?: TEvents;
+    };
+};
+/**
+ * Represents the schema config structure
+ *
+ * @property {number} defaultAPIdebounceTimeMS - default API debounce time between request events.
+ * @property {boolean} defaultLogVerbose - flag to turn warning log messages on client.
+ * @property {number} [defaultStateRefreshTimeMS] - default state refresh between events side effects.
+ */
+type TSchemaFormConfig = {
+    defaultAPIdebounceTimeMS?: number;
+    defaultStateRefreshTimeMS?: number;
+    defaultLogVerbose?: boolean;
+};
+export { TApiConfig, TErrorMessages, TValidations, TMasks, TProps, TResetValueMethods, TResetPathMethods, TFormatters, TValidationMethods, TGenericValidationRule, TSchemaValidation, TEvent, TVisibility, TApiEvent, TApiResponsePayload, TApiResponse, TSchemaFormConfig, TLengthValidation, TCreditCardMatch, TDocumentValidation, TCallbackValidation, TBetweenValidation, TMaskGeneric, TSplitterFormatterValue, TCurrencyMask, TDateOperatorsValidation, TConditionsValidationSet, TConditionsValidation, TMultipleValidation, TAvailableValidations, TDateValidation, TBetweenDatesValidation, TDateFormatsValidation, TDateInterval, TEventMessages, TEventMessagesValidationMethods, TAllowedResetPropsMutationsEnum, };