@bolttech/form-engine-core 0.0.1-beta.3 → 0.0.1-beta.31

package/src/types/schema.d.ts

@@ -159,7 +159,7 @@ type TConditionsValidation = {
     set: TConditionsValidationSet[];
     conditions?: TConditionsValidation;
 };
-type TAvailableValidations = Omit<TValidationMethods, 'multipleValidations'>;
+type TAvailableValidations = Omit<TValidationMethods, 'multipleValidations'> | TGenericValidationRule;
 /**
  * @type TMultipleValidation
  * Represents a set of multiple validation methods combined with a logical rule.
@@ -313,7 +313,6 @@ type TDateValidation = {
  * @property {number} [min] - Minimum value or length.
  * @property {TLengthValidation} [length] - Length validation rule.
  * @property {boolean} [required] - Indicates if the field is required.
- * @property {number} [greaterThan] - Value must be greater than this number.
  * @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.
@@ -397,7 +396,6 @@ type TValidationMethods = {
     min?: number;
     length?: TLengthValidation;
     required?: boolean;
-    greaterThan?: number;
     value?: unknown;
     regex?: string;
     email?: boolean;
@@ -424,6 +422,47 @@ type TValidationMethods = {
     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
@@ -579,19 +618,24 @@ type TMasks = {
  * @type TVisibility
  * Represents the visibility conditions for form fields based on validations.
  *
- * @property {TValidationMethods} validations - The validation methods to determine visibility.
+ * @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']
+ *   fields: ['fieldName'],
+ *   events: ['ON_FIELD_CHANGE']
  * };
  * ```
  */
 type TVisibility = {
-    validations: TValidationMethods;
+    showOnlyIfTrue?: boolean;
+    validations: TSchemaValidation;
     fields: string[] | string;
     events: Partial<TEvents>[];
 };
@@ -622,7 +666,7 @@ type TResetValueMethods = TVisibility & {
  * @property {OutgoingHttpHeaders} [headers] - The headers for the request.
  * @property {string} [resultPath] - The path to extract the result from the response.
  * @property {unknown} [fallbackValue] - The fallback value if the request fails.
- * @property {TValidationMethods} preConditions - validation conditions to execute the API call
+ * @property {TSchemaValidation} preConditions - validation conditions to execute the API call
  * @property {boolean} blockRequestWhenInvalid - blocks request when field validation fails
  *
  * @example
@@ -647,7 +691,7 @@ type TApiConfig = {
     headers?: OutgoingHttpHeaders;
     resultPath?: string;
     fallbackValue?: unknown;
-    preConditions?: TValidationMethods;
+    preConditions?: TSchemaValidation;
     blockRequestWhenInvalid?: boolean;
 };
 /**
@@ -657,40 +701,36 @@ type TApiConfig = {
 type TProps = Record<string, unknown>;
 /**
  * @type TValidations
- * Represents the validation methods for different events.
+ * Represents the validation configuration for form fields, including methods, event-specific messages, and error messages.
  *
- * @example
- * ```typescript
- * const validations: TValidations = {
- *   ON_FIELD_BLUR: { required: true }
- * };
- * ```
- */
-type TValidations = Partial<Record<TEvents, TValidationMethods>>;
-/**
- * @type TVisibilityConditions
- * Represents the visibility conditions for different events.
- *
- * @example
- * ```typescript
- * const visibilityConditions: TVisibilityConditions = {
- *   ON_FIELD_BLUR: [{ validations: { required: true }, fields: ['fieldName'] }]
- * };
- * ```
- */
-type TVisibilityConditions = Partial<Record<TEvents, TVisibility[]>>;
-/**
- * @type TResetValues
- * Represents the reset value methods for different events.
+ * @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 resetValues: TResetValues = {
- *   ON_FIELD_BLUR: [{ validations: { required: true }, fields: ['fieldName'], resettledValue: [''] }]
+ * 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 TResetValues = Partial<Record<TEvents, TResetValueMethods[]>>;
+type TValidations = {
+    methods: TSchemaValidation;
+    eventMessages?: Partial<Record<TEvents, string[]>>;
+    messages?: TErrorMessages;
+};
 /**
  * @type TErrorMessages
  * Represents the error messages for different validation methods.
@@ -700,10 +740,11 @@ type TResetValues = Partial<Record<TEvents, TResetValueMethods[]>>;
  * const errorMessages: TErrorMessages = {
  *   required: 'This field is required.',
  *   max: 'The value cannot exceed the maximum limit.'
+ *   default: 'Default error message'
  * };
  * ```
  */
-type TErrorMessages = Partial<Record<keyof TValidationMethods, string>>;
+type TErrorMessages = Partial<Record<keyof TSchemaValidation & 'default', string>>;
 /**
  * Represents an event configuration with a specific type.
  *
@@ -749,4 +790,4 @@ type TSchemaFormConfig = {
     defaultAPIdebounceTimeMS?: number;
     defaultStateRefreshTimeMS?: number;
 };
-export { TApiConfig, TErrorMessages, TResetValues, TVisibilityConditions, TValidations, TMasks, TProps, TResetValueMethods, TFormatters, TValidationMethods, TEvent, TVisibility, TApiEvent, TApiResponse, TSchemaFormConfig, TLengthValidation, TCreditCardMatch, TDocumentValidation, TCallbackValidation, TBetweenValidation, TMaskGeneric, TSplitterFormatterValue, TCurrencyMask, TDateOperatorsValidation, TConditionsValidationSet, TConditionsValidation, TMultipleValidation, TAvailableValidations, TDateValidation, TBetweenDatesValidation, TDateFormatsValidation, TDateInterval, };
+export { TApiConfig, TErrorMessages, TValidations, TMasks, TProps, TResetValueMethods, TFormatters, TValidationMethods, TGenericValidationRule, TSchemaValidation, TEvent, TVisibility, TApiEvent, TApiResponse, TSchemaFormConfig, TLengthValidation, TCreditCardMatch, TDocumentValidation, TCallbackValidation, TBetweenValidation, TMaskGeneric, TSplitterFormatterValue, TCurrencyMask, TDateOperatorsValidation, TConditionsValidationSet, TConditionsValidation, TMultipleValidation, TAvailableValidations, TDateValidation, TBetweenDatesValidation, TDateFormatsValidation, TDateInterval, };

package/src/types/utility.d.ts

@@ -1,4 +1,6 @@
+import { TValidationMethods } from './schema';
 export type AllowOnly<T, K extends keyof T> = Pick<T, K> & {
     [P in keyof Omit<T, K>]?: never;
 };
 export type OneOf<T, K = keyof T> = K extends keyof T ? AllowOnly<T, K> : never;
+export type TValidationHandler = Record<string, (value: unknown, validations: TValidationMethods) => boolean>;

package/src/validations/date.d.ts

@@ -1,5 +1,6 @@
 import { TValidationMethods } from '../types/schema';
 /**
+ * @function betweenDates
  * Validates if a date value falls between two specified dates.
  *
  * @param {string} value - The date value to be validated in string format.

package/src/validations/handler.d.ts

@@ -1,2 +1,2 @@
-import { TValidationMethods } from '../types/schema';
-export declare const validations: Record<keyof TValidationMethods, (value: unknown, validations: TValidationMethods) => boolean>;
+import { TValidationHandler } from '../types/utility';
+export declare const validations: TValidationHandler;

package/src/validations/multiple.d.ts

@@ -3,7 +3,7 @@ import { TValidationMethods } from '../types/schema';
  * Validates that a value meets multiple validation rules.
  *
  * @param {number | string | boolean} value - The value to be validated.
- * @param {TValidationMethods} validations - The validation methods object containing the multipleValidations rule set.
+ * @param {TValidationMethods} methods - The validation methods object containing the multipleValidations rule set.
  * @returns {boolean} - Returns `true` if the value meets the specified multiple validation rules, otherwise `false`.
  *
  * @example
@@ -28,4 +28,4 @@ import { TValidationMethods } from '../types/schema';
  * console.log(result2); // false
  * ```
  */
-export declare const multipleValidations: (value: number | string | boolean, validations: TValidationMethods) => boolean;
+export declare const multipleValidations: (value: number | string | boolean, methods: TValidationMethods) => boolean;

package/src/validations/namedRule.d.ts

@@ -0,0 +1,22 @@
+import { TValidationMethods } from '../types/schema';
+import { TValidationHandler } from '../types/utility';
+/**
+ * Validates a given value based on specified validation methods inside a custom named validation.
+ *
+ * @param {unknown} value - The value to be validated.
+ * @param {TValidationMethods} methods - The validation methods to be applied.
+ * @param {TValidationHandler} validations - An object containing every validation methods to be executed.
+ * @returns {boolean} - Returns true if any of the validation methods pass, otherwise false.
+ *
+ * @example
+ * const value = 'example@example.com';
+ * const methods = {
+ *   required: true,
+ *   email: true
+ * };
+ *
+ * const isValid = validateValue(value, methods);
+ * console.log(isValid); // Output: true
+ */
+declare const _default: (value: unknown, methods: TValidationMethods, validations: TValidationHandler) => boolean;
+export default _default;