@bolttech/form-engine-core 1.0.2-beta.2 → 1.0.2

package/src/types/schema.d.ts

@@ -1,835 +0,0 @@
-/// <reference types="node" />
-/** @virtual */
-import { TCurrencyCode, TCurrencyLocalCode } from '@gaignoux/currency';
-import { OutgoingHttpHeaders } from 'http2';
-import { TEvents } from './event';
-import { TFormValues } from './form';
-import { ALLOWED_RESET_PROPS_MUTATIONS } from '../constants/constants';
-/**
- * @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) => 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;
-    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 = {
-    max?: number;
-    min?: number;
-    lessThan?: number;
-    greaterThan?: number;
-    length?: TLengthValidation;
-    required?: boolean;
-    value?: unknown;
-    regex?: string;
-    email?: boolean;
-    url?: boolean;
-    onlyLetters?: boolean;
-    notAllowSpaces?: boolean;
-    callback?: TCallbackValidation;
-    isNumber?: boolean;
-    bool?: boolean | string;
-    exists?: boolean | string;
-    hasNoExtraSpaces?: boolean;
-    notEmpty?: boolean;
-    between?: TBetweenValidation;
-    sequential?: boolean;
-    repeated?: boolean;
-    includes?: (string | number)[];
-    isCreditCard?: string[];
-    isCreditCodeMatch?: TCreditCardMatch;
-    isCreditCardAndLength?: string[];
-    document?: TDocumentValidation;
-    conditions?: TConditionsValidation;
-    multipleValidations?: TMultipleValidation;
-    betweenDates?: TBetweenDatesValidation;
-    date?: TDateValidation;
-    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 = {
-    [key: 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,
- *   },
- * };
- */
-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
- * ```typescript
- * const formatters: TFormatters = {
- *   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 = {
-    dotEvery3chars?: boolean;
-    capitalize?: boolean;
-    uppercase?: boolean;
-    onlyNumbers?: boolean;
-    onlyLetters?: boolean;
-    onlyFloatNumber?: Pick<TCurrencyMask, 'precision' | 'decimal'>;
-    regex?: string;
-    gapsCreditCard?: string[];
-    callback?: (value: unknown) => unknown;
-    splitter?: TSplitterFormatterValue[];
-    trim?: boolean;
-    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 = {
-    currency?: TCurrencyMask;
-    generic?: TMaskGeneric[];
-    custom?: string;
-    secureCreditCard?: boolean;
-    card?: boolean;
-    cardDate?: boolean;
-    fein?: boolean;
-    replaceAll?: string | number;
-    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: Partial<TEvents>[];
-};
-/**
- * @type TResetValueMethods
- * Extends TVisibility with methods to reset values.
- *
- * @property {string[] | string} resettledValue - The values to reset.
- *
- * @example
- * ```typescript
- * const resetValueMethods: TResetValueMethods = {
- *   validations: { required: true },
- *   fields: ['fieldName'],
- *   resettledValue: ['']
- * };
- * ```
- */
-type TResetValueMethods = Omit<TVisibility, 'showOnlyIfTrue' | 'validations'> & {
-    resettledValue: unknown[] | unknown;
-    validations?: TSchemaValidation;
-};
-type TResetPathMethods = {
-    property: (typeof ALLOWED_RESET_PROPS_MUTATIONS)[number];
-    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 {OutgoingHttpHeaders} [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 = {
-    method: 'GET' | 'POST';
-    url: string;
-    body?: Record<string, unknown>;
-    headers?: OutgoingHttpHeaders;
-    queryParams?: Record<string, string>;
-    resultPath?: string;
-    fallbackValue?: unknown;
-    preConditions?: TSchemaValidation;
-    blockRequestWhenInvalid?: boolean;
-    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.
- *
- * @example
- * 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?: Partial<Record<TEvents, Partial<keyof TValidationMethods | (string & NonNullable<unknown>)>[]>>;
-    messages?: TErrorMessages;
-};
-/**
- * @type TErrorMessages
- * Represents the error messages for different validation methods.
- *
- * @example
- * ```typescript
- * const errorMessages: TErrorMessages = {
- *   required: 'This field is required.',
- *   max: 'The value cannot exceed the maximum limit.'
- *   default: 'Default error message'
- * };
- * ```
- */
-type TErrorMessages = {
-    [K in keyof TSchemaValidation]?: string;
-} & {
-    default?: string;
-} & {
-    [key: string]: 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: Partial<TEvents>[];
-};
-/**
- * Represents the API event configurations.
- *
- * @property {TEvent<TApiConfig>} [defaultConfig] - The default event configuration.
- * @property {Record<string, TEvent<TApiConfig>>} [configs] - Named event configurations.
- */
-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 {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, };