@bolttech/form-engine-core 0.0.1-beta.9 → 0.0.2-beta.1

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 --------------------- //