@bolttech/form-engine-core 0.0.1-beta.17 → 0.0.1-beta.18

package/README.md

@@ -7,6 +7,7 @@ Achieve form logic re-usage with forms expressed in json format.
 1. [Basic setup](#markdown-header-basic-setup)
 2. [Step by step](#markdown-header-step-by-step)
 3. [Form Features](#markdown-header-available-features)
+
 - 3.1. [Validations - Allow form to run validations in the field](#markdown-header-validations)
   - 3.1.1. [Named Validations](#markdown-header-validations)
   - 3.1.2. [Error Messages](#markdown-header-validations)
@@ -277,16 +278,18 @@ You can also specify the error messages you want.
 ```json
 {
   "validations": {
-    "ON_FIELD_BLUR": {
-      "require": true
-    },
-    "ON_FIELD_CHANGE": {
+    "methods": {
+      "require": true,
       "email": true
+    },
+    "eventMessages": {
+      "ON_FIELD_BLUR": ["required"],
+      "ON_FIELD_CHANGE": ["email"]
+    },
+    "messages": {
+      "default": "Default error message",
+      "email": "Invalid e-mail"
     }
-  },
-  "errorMessages": {
-    "default": "Default error message",
-    "email": "Invalid e-mail"
   }
 }
 ```
@@ -303,28 +306,29 @@ If you have a named validation, you can use its name in the error messages, havi
 ```json
 {
   "validations": {
-    "ON_FIELD_BLUR": {
+    "methods": {
       "blurRequire": {
         "require": true
-      }
-    },
-    "ON_FIELD_CHANGE": {
+      },
       "email": true,
       "changeRequire": {
         "require": true
       },
       "changeRestOfValidations": {
         "length": 50
-        //...
       }
+    },
+    "eventMessages": {
+      "ON_FIELD_BLUR": ["blurRequire"],
+      "ON_FIELD_CHANGE": ["email", "changeRequire", "changeRestOfValidations"]
+    },
+    "messages": {
+      "default": "Default error message",
+      "email": "Invalid e-mail",
+      "blurRequire": "When you blur, this component is required",
+      "changeRequire": "You should not leave the field blank",
+      "changeRestOfValidations": "You are changing into an incorrect state"
     }
-  },
-  "errorMessages": {
-    "default": "Default error message",
-    "email": "Invalid e-mail",
-    "blurRequire": "When you blur, this component is required",
-    "changeRequire": "You should not leave the field blank",
-    "changeRestOfValidations": "You are changing into an incorrect state"
   }
 }
 ```
@@ -624,10 +628,6 @@ Refer to the `TAvailableValidations` types here:
    * Allow to define a maximum length for the input to have no error
    */
   length?: number;
-  /**
-   * Will look into the input length and send an error if if not greater than this value
-   */
-  greaterThan?: number | string;
 
   /**
    * Specifies a regular expression pattern that the value should match.
@@ -669,7 +669,7 @@ Refer to the `TAvailableValidations` types here:
    * @param value - The value to be validated.
    * @returns An object with validation results.
    */
-  callback?(value: string | number): { fail: boolean; errorMessage?: string };
+  callback?(value: string | number): boolean;
 
   /**
    * Specifies a numeric range for the value.
@@ -1371,14 +1371,17 @@ Templates are already a great power of form-engine, but we can go further allowi
 {
   "component": "input",
   "name": "password",
-  "errorMessages": {
-    "required": "Password is required",
-    "value": "Error value must be varOps.concatenate(${fields.email.value||0},${fields.email2.value||0})"
-  },
   "validations": {
-    "ON_FIELD_CHANGE": {
+    "methods": {
       "required": true,
       "value": "varOps.concatenate(${fields.email.value||0},${fields.email2.value||0})"
+    },
+    "eventMessages": {
+      "ON_FIELD_CHANGE": ["required", "value" ]
+    },
+    "messages": {
+      "required": "Password is required",
+      "value": "Error value must be varOps.concatenate(${fields.email.value||0},${fields.email2.value||0})"
     }
   },
   "props": {
@@ -1416,9 +1419,12 @@ Since we are already using [templates](#templates) to run our varOps and subscri
 
 ```json
 {
-  "errorMessages": {
-    "required": "Password is required",
-    "value": "Error value must be foo_bar"
+  "validations": {
+    ...,
+    "messages": {
+      "required": "Password is required",
+      "value": "Error value must be foo_bar"
+    }
   }
 }
 ```
@@ -1576,9 +1582,7 @@ Or Simply using the form reference in a button outside the form, for example:
 {
   const ref = useRef < TFormRefActions > null;
 
-  return (
-    <Form id="form" ref={ref} onClick={() => ref.current?.stepForward()} />
-  );
+  return <Form id="form" ref={ref} onClick={() => ref.current?.stepForward()} />;
 }
 
 // --------------------- OR --------------------- //

package/index.esm.js

@@ -1,6 +1,6 @@
 import { Subject, Subscription, combineLatest, startWith, groupBy, mergeMap, debounceTime, filter, map } from 'rxjs';
 import creditCardType from 'credit-card-type';
-import { isNumber as isNumber$1, isEqual, get, isNil, set } from 'lodash';
+import { isNumber as isNumber$1, isFunction, isEqual, get, isNil, set } from 'lodash';
 import { getCurrencySymbol } from '@gaignoux/currency';
 
 var TMutationEnum;
@@ -2117,6 +2117,34 @@ const validDate = (value, validations) => {
   return !isValidDate;
 };
 
+/**
+ * @internal
+ * Runs a set of validation handlers against a given value.
+ *
+ * @param {unknown} value - The value to be validated.
+ * @param {TValidationMethods} handlers - An object containing validation methods to be applied.
+ * @param {TValidationHandler} validations - An object containing every validation methods to be executed.
+ * @returns {boolean[]} - An array of boolean results for each validation method.
+ *
+ * @example
+ * const handlers = {
+ *   max: { max: 10 },
+ *   required: true,
+ *   email: true
+ * };
+ * const results = run('test@example.com', handlers);
+ * console.log(results); // [false, false, true] (value fails 'max', passes 'required', passes 'email')
+ */
+function runner(value, handlers, validations) {
+  const runner = [];
+  Object.keys(handlers).forEach(rule => {
+    runner.push(validations[rule](value, {
+      [rule]: handlers[rule]
+    }));
+  });
+  return runner;
+}
+
 /**
  * @internal
  * An object mapping validation keys to their respective validation functions.
@@ -2127,7 +2155,7 @@ const validDate = (value, validations) => {
  * const isValid = validations.max(5, { max: 10 });
  * console.log(isValid); // false (5 is not greater than 10)
  */
-const validations$1 = {
+const validations$2 = {
   max,
   min,
   length,
@@ -2151,44 +2179,17 @@ const validations$1 = {
   notEmpty,
   bool,
   exists,
-  greaterThan: () => true,
   isNumber,
   conditions,
   validDate,
   date,
   betweenDates
 };
-/**
- * @internal
- * Runs a set of validation handlers against a given value.
- *
- * @param {unknown} value - The value to be validated.
- * @param {TValidationMethods} handlers - An object containing validation methods to be applied.
- * @returns {boolean[]} - An array of boolean results for each validation method.
- *
- * @example
- * const handlers = {
- *   max: { max: 10 },
- *   required: true,
- *   email: true
- * };
- * const results = run('test@example.com', handlers);
- * console.log(results); // [false, false, true] (value fails 'max', passes 'required', passes 'email')
- */
-const run = (value, handlers) => {
-  const runner = [];
-  Object.keys(handlers).forEach(rule => {
-    runner.push(validations$1[rule](value, {
-      [rule]: handlers[rule]
-    }));
-  });
-  return runner;
-};
 /**
  * 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
@@ -2213,18 +2214,18 @@ const run = (value, handlers) => {
  * console.log(result2); // false
  * ```
  */
-const multipleValidations = (value, validations) => {
-  if (!validations.multipleValidations) return false;
-  const runner = run(value, validations.multipleValidations.validations);
+const multipleValidations = (value, methods) => {
+  if (!methods.multipleValidations) return false;
+  const runner$1 = runner(value, methods.multipleValidations.validations, validations$2);
   const rulesMapper = {
-    AND: () => runner.every(validation => validation),
-    OR: () => runner.some(validation => validation),
-    NOT: () => !runner.every(validation => validation)
+    AND: () => runner$1.every(validation => validation),
+    OR: () => runner$1.some(validation => validation),
+    NOT: () => !runner$1.every(validation => validation)
   };
-  return rulesMapper[validations.multipleValidations.rule]();
+  return rulesMapper[methods.multipleValidations.rule]();
 };
 
-const validations = {
+const validations$1 = {
   max,
   min,
   length,
@@ -2248,7 +2249,6 @@ const validations = {
   notEmpty,
   bool,
   exists,
-  greaterThan: () => true,
   isNumber,
   conditions,
   multipleValidations,
@@ -2273,6 +2273,100 @@ class SafeSubject extends Subject {
   }
 }
 
+/**
+ * @internal
+ * An object mapping validation keys to their respective validation functions.
+ *
+ * @type {Record<keyof TAvailableValidations, (value: unknown, validations: TAvailableValidations) => boolean>}
+ *
+ * @example
+ * const isValid = validations.max(5, { max: 10 });
+ * console.log(isValid); // false (5 is not greater than 10)
+ */
+const validations = {
+  max,
+  min,
+  length,
+  regex,
+  url,
+  email,
+  onlyLetters,
+  notAllowSpaces,
+  callback,
+  hasNoExtraSpaces,
+  between,
+  sequential,
+  includes,
+  repeated,
+  document,
+  isCreditCard,
+  isCreditCodeMatch,
+  isCreditCardAndLength,
+  required,
+  value,
+  notEmpty,
+  bool,
+  exists,
+  isNumber,
+  conditions,
+  validDate,
+  date,
+  betweenDates,
+  multipleValidations
+};
+/**
+ * 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.
+ * @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
+ */
+var namedRule = ((value, methods) => {
+  if (!methods) return false;
+  return runner(value, methods, validations).some(validation => validation);
+});
+
+/**
+ * @internal
+ * Handles the validation of a given value based on specified validation methods and rules.
+ *
+ * @param {string | number | boolean | unknown} value - The value to be validated.
+ * @param {TSchemaValidation} validations - The schema validations to be applied.
+ * @param {TValidationHandler} methods - The validation handler methods.
+ * @param {keyof TValidationMethods} key - The specific key of the validation method to be used.
+ * @returns {boolean} - Returns true if the value passes the validation, otherwise false.
+ *
+ * @example
+ * const value = 'example@example.com';
+ * const validations = {
+ *   required: true,
+ *   customName: { email: true }
+ * };
+ * const methods = {
+ *   email: (value) => /\S+@\S+\.\S+/.test(value)
+ * };
+ * const key = 'required';
+ *
+ * const isValid = handleValidation(value, validations, methods, key);
+ * console.log(isValid); // Output: true
+ */
+function handleValidation(value, validations, methods, key) {
+  if (isFunction(methods[key])) {
+    return methods[key](value, validations);
+  }
+  return namedRule(value, validations[key]);
+}
+
 /**
  * Represents a form field with observables for managing form state, validations, and API requests.
  */
@@ -2663,7 +2757,7 @@ class FormField {
     const errors = {};
     const schemaValidations = (_a = this.validations) === null || _a === void 0 ? void 0 : _a.methods;
     schemaValidations && Object.keys(schemaValidations).forEach(validationKey => {
-      const error = validations[validationKey](this.value, schemaValidations);
+      const error = handleValidation(this.value, schemaValidations, validations$1, validationKey);
       // setting valid flag
       valid = !error && valid;
       // setting error messages
@@ -2723,7 +2817,7 @@ class FormField {
     let valid = true;
     const preConditions = config.preConditions;
     preConditions && Object.keys(preConditions).forEach(validationKey => {
-      const error = validations[validationKey](this.value, preConditions);
+      const error = handleValidation(this.value, preConditions, validations$1, validationKey);
       valid = valid && !error;
     });
     if (config.blockRequestWhenInvalid) {
@@ -3203,7 +3297,7 @@ class FormCore {
     structVisibility.forEach(structElement => {
       if (!structElement.events.includes(event)) return;
       Object.keys(structElement.validations).forEach(validationKey => {
-        const error = validations[validationKey](field.value, structElement.validations);
+        const error = handleValidation(field.value, structElement.validations, validations$1, validationKey);
         if (Array.isArray(structElement.fields)) {
           structElement.fields.forEach(fieldKey => {
             if (!this.fields.has(fieldKey)) console.warn(`failed to update visibility onto field ${fieldKey}`);else this.fields.get(fieldKey).visibility = !error;
@@ -3231,7 +3325,7 @@ class FormCore {
     structResetValue.forEach(structElement => {
       if (!structElement.events.includes(event)) return;
       Object.keys(structElement.validations).forEach(validationKey => {
-        const error = validations[validationKey](field.value, structElement.validations);
+        const error = handleValidation(field.value, structElement.validations, validations$1, validationKey);
         if (!error) {
           if (Array.isArray(structElement.fields)) {
             structElement.fields.forEach((fieldKey, index) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bolttech/form-engine-core",
-  "version": "0.0.1-beta.17",
+  "version": "0.0.1-beta.18",
   "module": "./index.esm.js",
   "type": "module",
   "main": "./index.esm.js",

package/src/helpers/validation/handler.d.ts

@@ -0,0 +1,27 @@
+import { TSchemaValidation, TValidationMethods } from '../../types/schema';
+import { TValidationHandler } from '../../validations/handler';
+/**
+ * @internal
+ * Handles the validation of a given value based on specified validation methods and rules.
+ *
+ * @param {string | number | boolean | unknown} value - The value to be validated.
+ * @param {TSchemaValidation} validations - The schema validations to be applied.
+ * @param {TValidationHandler} methods - The validation handler methods.
+ * @param {keyof TValidationMethods} key - The specific key of the validation method to be used.
+ * @returns {boolean} - Returns true if the value passes the validation, otherwise false.
+ *
+ * @example
+ * const value = 'example@example.com';
+ * const validations = {
+ *   required: true,
+ *   customName: { email: true }
+ * };
+ * const methods = {
+ *   email: (value) => /\S+@\S+\.\S+/.test(value)
+ * };
+ * const key = 'required';
+ *
+ * const isValid = handleValidation(value, validations, methods, key);
+ * console.log(isValid); // Output: true
+ */
+export default function handleValidation(value: string | number | boolean | unknown, validations: TSchemaValidation, methods: TValidationHandler, key: keyof TValidationMethods): boolean;

package/src/helpers/validation/runner.d.ts

@@ -0,0 +1,21 @@
+import { TValidationMethods } from '../../types/schema';
+import { TValidationHandler } from '../../validations/handler';
+/**
+ * @internal
+ * Runs a set of validation handlers against a given value.
+ *
+ * @param {unknown} value - The value to be validated.
+ * @param {TValidationMethods} handlers - An object containing validation methods to be applied.
+ * @param {TValidationHandler} validations - An object containing every validation methods to be executed.
+ * @returns {boolean[]} - An array of boolean results for each validation method.
+ *
+ * @example
+ * const handlers = {
+ *   max: { max: 10 },
+ *   required: true,
+ *   email: true
+ * };
+ * const results = run('test@example.com', handlers);
+ * console.log(results); // [false, false, true] (value fails 'max', passes 'required', passes 'email')
+ */
+export default function runner(value: unknown, handlers: TValidationMethods, validations: TValidationHandler): boolean[];

package/src/types/schema.d.ts

@@ -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,7 +618,7 @@ type TMasks = {
  * @type TVisibility
  * Represents the visibility conditions for form fields based on validations.
  *
- * @property {TValidationMethods} validations - The validation methods to determine visibility.
+ * @property {TSchemaValidation} validations - The validation methods to determine visibility.
  * @property {string[] | string} fields - The fields to be shown or hidden based on validations.
  *
  * @example
@@ -591,7 +630,7 @@ type TMasks = {
  * ```
  */
 type TVisibility = {
-    validations: TValidationMethods;
+    validations: TSchemaValidation;
     fields: string[] | string;
     events: Partial<TEvents>[];
 };
@@ -622,7 +661,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 +686,7 @@ type TApiConfig = {
     headers?: OutgoingHttpHeaders;
     resultPath?: string;
     fallbackValue?: unknown;
-    preConditions?: TValidationMethods;
+    preConditions?: TSchemaValidation;
     blockRequestWhenInvalid?: boolean;
 };
 /**
@@ -659,7 +698,7 @@ type TProps = Record<string, unknown>;
  * @type TValidations
  * Represents the validation configuration for form fields, including methods, event-specific messages, and error messages.
  *
- * @property {TValidationMethods} methods - The validation methods to be applied.
+ * @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.
  *
@@ -683,7 +722,7 @@ type TProps = Record<string, unknown>;
  * };
  */
 type TValidations = {
-    methods: TValidationMethods;
+    methods: TSchemaValidation;
     eventMessages?: Partial<Record<TEvents, string[]>>;
     messages?: TErrorMessages;
 };
@@ -700,7 +739,7 @@ type TValidations = {
  * };
  * ```
  */
-type TErrorMessages = Partial<Record<keyof TValidationMethods & 'default', string>>;
+type TErrorMessages = Partial<Record<keyof TSchemaValidation & 'default', string>>;
 /**
  * Represents an event configuration with a specific type.
  *
@@ -746,4 +785,4 @@ type TSchemaFormConfig = {
     defaultAPIdebounceTimeMS?: number;
     defaultStateRefreshTimeMS?: number;
 };
-export { TApiConfig, TErrorMessages, 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/validations/handler.d.ts

@@ -1,2 +1,3 @@
 import { TValidationMethods } from '../types/schema';
-export declare const validations: Record<keyof TValidationMethods, (value: unknown, validations: TValidationMethods) => boolean>;
+export type TValidationHandler = Record<string, (value: unknown, validations: TValidationMethods) => boolean>;
+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,20 @@
+import { TValidationMethods } from '../types/schema';
+/**
+ * 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.
+ * @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) => boolean;
+export default _default;