check-rule-mate 0.5.1 → 0.5.3

package/README.md

@@ -13,6 +13,7 @@ It is designed for scenarios where traditional schema-based validators start to
 - Async checks
 - Reusable validation logic across multiple forms
 - Full control over execution flow and error handling
+- Lifecycle Hooks
 
 
 **Github repository:** [check-rule-mate repository](https://github.com/johnrock16/check-rule-mate)
@@ -31,6 +32,7 @@ Use **check-rule-mate** if you:
 - Need async validations (API calls, database checks, etc.)
 - Prefer rule-driven validation instead of tightly coupled schemas
 - Want clean separation between rules, data, and messages
+- You want to have auto documentation of your forms
 
 
 ## Core Concepts
@@ -55,6 +57,7 @@ This separation makes the system flexible, scalable, and easy to maintain.
 - Strict or loose schema matching
 - i18n-ready error messages
 - Framework-agnostic (frontend or backend)
+- Auto documentation (automatic generated by a CLI command)
 
 ## Table of Contents
 
@@ -64,6 +67,8 @@ This separation makes the system flexible, scalable, and easy to maintain.
   - [Running Tests](#Repository---Running-Tests)
 - [How It Works](#How-It-Works)
   - [Basic Usage](#Basic-Usage)
+  - [Lifecycle Hooks](#Lifecycle-Hooks)
+  - [Auto documentation](#Auto-Documentation)
 - [Defining Validation](#Defining-Validation)
   - [1. Schema](#Defining-a-Schema-What-to-validate)
   - [2. Rules](#Defining-Rules-How-to-validate)
@@ -164,6 +169,132 @@ When is **invalid** and **has errors**:
 }
 ```
 
+### Lifecycle Hooks
+The **check-rule-mate** lifecycle hooks allow you to observe, extend and react to the validation process without coupling logic to rules or helpers.
+
+Hooks are especially useful for:
+
+- Logging and debugging
+- Analytics and metrics
+- Custom side-effects
+- Integrating validation with UI or external systems
+- Advanced error handling and reporting
+- They provide fine-grained control over the validation lifecycle.
+
+```typescript
+hooks?: {
+  onValidateStart?: (payload) => void;
+  onValidateFieldStart?: (payload) => void;
+  onValidateFieldError?: (payload) => void;
+  onValidateFieldSuccess?: (payload) => void;
+  onValidateEnd?: (payload) => void;
+}
+```
+
+#### Hook Payloads
+
+##### `onValidateStart`
+Triggered once before validation begins.
+```typescript
+onValidateStart: ({ data }) => void
+```
+
+**Payload:**
+- `data`: Full form data object being validated
+
+##### `onValidateFieldStart`
+Triggered before validating each field.
+```typescript
+onValidateFieldStart: ({ field, value, schemaField }) => void
+```
+
+**Payload:**
+- `field`: Field name
+- `value`: Field value
+- `schemaField`: Schema configuration for the field (or `null` if missing)
+
+##### `onValidateFieldError`
+Triggered when a field fails validation.
+```typescript
+onValidateFieldError: ({ field, value, schemaField, error }) => void
+```
+
+**Payload:**
+- `field`: Field name
+- `value`: Field value
+- `schemaField`: Schema configuration for the field (or `null` if missing)
+- `error`: Validation error object
+
+##### `onValidateFieldSuccess`
+Triggered when a field is successfully validated.
+```typescript
+onValidateFieldSuccess: ({ field, value, schemaField }) => void
+```
+
+**Payload:**
+- `field`: Field name
+- `value`: Field value
+- `schemaField`: Schema configuration for the field (or `null` if missing)
+
+##### `onValidateEnd`
+Triggered once after validation finishes.
+```typescript
+onValidateEnd: ({ data, errors }) => void
+```
+
+**Payload:**
+- `data`: Full form data object being validated
+- `errors`: Validation errors (if any)
+If no errors occurred, `errors` may be `undefined`.
+
+#### Hooks -  Example Usage
+```javascript
+const validator = createValidator(fields, {
+  validationHelpers: myValidator,
+  rules: MY_RULES,
+  schema: CONTACT_US,
+  errorMessages: ERROR_MESSAGES,
+  hooks: {
+    onValidateStart: ({ data }) => {
+      console.log('Validation started', data);
+    },
+
+    onValidateFieldStart: ({ field, value }) => {
+      console.log(`Validating ${field}`, value);
+    },
+
+    onValidateFieldError: ({ field, error }) => {
+      console.error(`Error on ${field}`, error);
+    },
+
+    onValidateFieldSuccess: ({ field }) => {
+      console.log(`${field} validated successfully`);
+    },
+
+    onValidateEnd: ({ data, errors }) => {
+      if (errors) {
+        console.log('Validation finished with errors', errors);
+      } else {
+        console.log('Validation finished successfully');
+      }
+    }
+  }
+});
+
+await validator.validate();
+```
+
+### Auto Documentation
+
+**check-rule-mate** contains a script to generate **automatic documentation** based in your rules, schemas and error messages.
+
+To use that it is simple, you only need to run this command:
+
+```bash
+npx check-rule-mate-auto-docs --rules rules-path --schemas schemas-path --errors errors-path --out file.html
+```
+
+This will generate a HTML file containing the rules, schemas and errors.
 
 ## Defining Validation
 

package/bin/generate-docs.js

@@ -0,0 +1,434 @@
+#!/usr/bin/env node
+/**
+ * check-rule-mate — Auto Documentation Generator
+ */
+
+// import fs from "fs";
+// import path from "path";
+// import process from "process";
+
+const fs = require('fs');
+const path = require('path');
+const process = require('process');
+
+/* ---------------------------------------
+ * CLI ARGS
+ * -------------------------------------*/
+const args = process.argv.slice(2);
+const getArg = (flag) => {
+  const index = args.indexOf(flag);
+  return index !== -1 ? args[index + 1] : null;
+};
+
+const RULES_DIR = getArg('--rules');
+const SCHEMAS_DIR = getArg('--schemas');
+const ERRORS_DIR = getArg('--errors')
+const OUTPUT = getArg('--out') || "check-rule-mate-docs.html";
+
+if (!RULES_DIR || !SCHEMAS_DIR) {
+  console.error(`
+Usage:
+npx check-rule-mate-auto-docs --rules ./rules --schemas ./schemas --errors ./errors --out docs.html
+`);
+  process.exit(1);
+}
+
+/* ---------------------------------------
+ * HELPERS
+ * -------------------------------------*/
+const readJSONFiles = (dir) => {
+  return fs.readdirSync(dir)
+    .filter(f => f.endsWith(".json"))
+    .map(file => ({
+      name: file.replace(".json", ""),
+      content: JSON.parse(fs.readFileSync(path.join(dir, file), "utf-8"))
+    }));
+};
+
+const rulesFiles = readJSONFiles(RULES_DIR);
+const schemasFiles = readJSONFiles(SCHEMAS_DIR);
+const errorsFiles = readJSONFiles(ERRORS_DIR);
+
+
+/* ---------------------------------------
+ * INDEX RELATIONSHIPS
+ * -------------------------------------*/
+const ruleUsageMap = {};
+const errorUsageMap = {}
+
+schemasFiles.forEach(schemaFile => {
+  Object.entries(schemaFile.content).forEach(([field, config]) => {
+    const ruleName = config.rule.split("--")[0];
+    if (!ruleUsageMap[ruleName]) ruleUsageMap[ruleName] = [];
+    ruleUsageMap[ruleName].push({
+      schema: schemaFile.name,
+      field,
+      rule: config.rule
+    });
+  });
+});
+
+rulesFiles.forEach(rulesFile => {
+  Object.entries(rulesFile.content).forEach(([field, config]) => {
+    Object.entries(config.error).forEach(([key, value]) => {
+      const errorName = value;
+      if (!errorUsageMap[errorName]) errorUsageMap[errorName] = [];
+      errorUsageMap[errorName].push({
+        file: rulesFile.name,
+        field,
+        error: value
+      });
+    });
+    if (config?.modifier) {
+      Object.entries(config.modifier).forEach(([modifierKey, modifier]) => {
+        if (modifier?.error) {
+          Object.entries(modifier.error).forEach(([key, value]) => {
+            const errorName = value;
+            if (!errorUsageMap[errorName]) errorUsageMap[errorName] = [];
+            errorUsageMap[errorName].push({
+              file: rulesFile.name,
+              field,
+              error: value
+            });
+          });
+        }
+      });
+    }
+  });
+});
+
+
+/* ---------------------------------------
+ * HTML GENERATION
+ * -------------------------------------*/
+const html = `
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8" />
+<title>check-rule-mate — Documentation</title>
+<style>
+${generateCSS()}
+</style>
+</head>
+<body>
+
+<aside class="sidebar">
+  <input id="search" placeholder="Search..." />
+
+  <h3>Schemas</h3>
+  ${schemasFiles.map(s => `
+    <a href="#schema-${s.name}">${s.name}</a>
+  `).join("")}
+
+  <h3>Rules</h3>
+  ${rulesFiles.map(rf =>
+    Object.keys(rf.content).map(rule => `
+      <a href="#rule-${rule}">${rf.name} - ${rule}</a>
+    `).join("")
+  ).join("")}
+
+  <h3>Errors</h3>
+  ${errorsFiles.map(errorFile =>
+    Object.keys(errorFile.content).map(error => `
+      <a href="#error-${error}">${errorFile.name} - ${error}</a>
+    `).join("")
+  ).join("")}
+</aside>
+
+<main>
+  <section>
+    <h1>check-rule-mate</h1>
+    <p class="muted">
+      Visual documentation of validation rules and schemas.
+    </p>
+  </section>
+
+  ${renderSchemas(schemasFiles)}
+  ${renderRules(rulesFiles, ruleUsageMap)}
+  ${renderErrors(errorsFiles, errorUsageMap)}
+</main>
+
+<script>
+${generateClientJS()}
+</script>
+
+</body>
+</html>
+`;
+
+fs.writeFileSync(OUTPUT, html);
+console.log(`✔ Documentation generated at ${OUTPUT}`);
+
+/* ---------------------------------------
+ * RENDERERS
+ * -------------------------------------*/
+function renderSchemas(schemas) {
+  return schemas.map(schema => `
+  <section id="schema-${schema.name}" class="card">
+    <h2>Schema: ${schema.name}</h2>
+
+    <table>
+      <thead>
+        <tr>
+          <th>Field</th>
+          <th>Rule</th>
+          <th class="text-center">Required</th>
+          <th class="text-center">Cache</th>
+        </tr>
+      </thead>
+      <tbody>
+        ${Object.entries(schema.content).map(([field, cfg]) => `
+          <tr>
+            <td>${field}</td>
+            <td>
+              <a href="#rule-${cfg.rule.split("--")[0]}">
+                ${cfg.rule}
+              </a>
+            </td>
+            <td class="text-center">${cfg.required ? "✔" : "optional"}</td>
+            <td class="text-center">${cfg.cache === false ? "off" : "✔"}</td>
+          </tr>
+        `).join("")}
+      </tbody>
+    </table>
+  </section>
+  `).join("");
+}
+
+function renderRules(rulesFiles, usageMap) {
+  return rulesFiles.map(file =>
+    Object.entries(file.content).map(([ruleName, rule]) => `
+    <section id="rule-${ruleName}" class="card">
+      <h2>Rule: ${ruleName} (${file.name})</h2>
+      ${rule?.docs?.description ?
+        `<p>${rule.docs.description}</p>`
+      : ''}
+
+      <h3>Validation Flow</h3>
+      <div class="flow">
+        ${rule.validate.map(v => `
+          <div class="flow-step">${v}</div>
+          <div class="flow-arrow">→</div>
+        `).join("")}
+        <div class="flow-step success">valid</div>
+      </div>
+
+      <h3>Error Codes</h3>
+      ${renderRulesErrors(rule.error)}
+
+      ${rule.modifier ? `
+        <h3>Modifiers</h3>
+        ${Object.entries(rule.modifier).map(([mod, modRule]) => `
+          <div class="modifier">
+            <span class="tag modifier">${mod}</span>
+            ${modRule?.docs?.description ? `<p>${modRule.docs.description}</p>` : ''}
+
+            <div class="flow">
+              ${modRule.validate.map(v => `
+                <div class="flow-step">${v}</div>
+                <div class="flow-arrow">→</div>
+              `).join("")}
+              <div class="flow-step success">valid</div>
+            </div>
+
+            <h4>Error Codes</h4>
+            ${renderRulesErrors(modRule.error)}
+          </div>
+        `).join("")}
+      ` : ""}
+
+      <h3>Used by Schemas</h3>
+      <ul>
+        ${(usageMap[ruleName] || []).map(u =>
+          `<li>${u.schema} → <strong>${u.field}</strong> (${u.rule})</li>`
+        ).join("") || "<li>Not used</li>"}
+      </ul>
+
+      ${rule?.docs?.notes ?
+      `
+        <h3>Notes</h3>
+        <div class="rule-notes">${rule?.docs?.notes}</div>
+      `
+      : ''}
+    </section>
+    `).join("")
+  ).join("");
+}
+
+function renderRulesErrors(errors = {}) {
+  return `
+    <ul>
+      ${Object.entries(errors).map(([k, v]) =>
+        `<li><a href="#error-${v.split('.')[0]}" class="tag error">${k}</a> ${v}</li>`
+      ).join("")}
+    </ul>
+  `;
+}
+
+function renderErrors(errorFiles, usageMap) {
+  return errorFiles.map(file =>
+    Object.entries(file.content).map(([errorName, errors]) => `
+    <section id="error-${errorName}" class="card">
+      <h2>Error: ${errorName} (${file.name})</h2>
+      <ul>
+      ${Object.entries(errors).map(([key, value]) => `
+        <li><span class="tag error">${key}</span> ${value} </li>
+      `).join('')}
+      </ul>
+
+      <h3>Used by Rules</h3>
+      <ul>
+        ${Object.entries(errors).map(([key, value]) => `
+          ${(usageMap[`${errorName}.${key}`] || []).map(u =>
+            `<li>${u.file} → <strong>${u.field}</strong> (${u.error})</li>`
+          ).join("") || "<li>Not used</li>"}
+        `).join('')}
+      </ul>
+    </section>
+  `).join('')).join('');
+}
+
+/* ---------------------------------------
+ * CSS
+ * -------------------------------------*/
+function generateCSS() {
+  return `
+  body {
+    margin: 0;
+    font-family: Inter, system-ui, sans-serif;
+    display: grid;
+    grid-template-columns: 280px 1fr;
+    background: #0f172a;
+    color: #e5e7eb;
+  }
+
+  .sidebar {
+    padding: 16px;
+    background: #020617;
+    overflow-y: auto;
+  }
+
+  .sidebar input {
+    width: 100%;
+    padding: 8px;
+    border-radius: 6px;
+    border: none;
+    margin-bottom: 16px;
+  }
+
+  .sidebar a {
+    display: block;
+    padding: 6px 10px;
+    color: #e5e7eb;
+    text-decoration: none;
+    border-radius: 6px;
+  }
+
+  .sidebar a:hover {
+    background: rgba(56,189,248,0.2);
+  }
+
+  a {
+    color: #e5e7eb;
+  }
+
+  main {
+    padding: 32px;
+    overflow-y: auto;
+  }
+
+  .card {
+    background: #020617;
+    border-radius: 12px;
+    padding: 24px;
+    margin-bottom: 32px;
+    border: 1px solid rgba(255,255,255,0.05);
+  }
+
+  .flow {
+    display: flex;
+    align-items: center;
+    gap: 12px;
+    flex-wrap: wrap;
+  }
+
+  .flow-step {
+    padding: 10px 14px;
+    border-radius: 8px;
+    background: rgba(56,189,248,0.15);
+  }
+
+  .flow-arrow {
+    opacity: 0.5;
+  }
+
+  .success {
+    background: rgba(34,197,94,0.2);
+  }
+
+  .tag {
+    padding: 4px 8px;
+    border-radius: 999px;
+    font-size: 14px;
+  }
+
+  .tag.error {
+    display: inline-block;
+    margin-bottom: 8px;
+    background: rgba(239,68,68,0.2);
+    text-decoration: none;
+  }
+
+  .tag.modifier {
+    display: inline-block;
+    font-size: 16px;
+    margin-bottom: 8px;
+    font-weight: 600;
+    background: rgba(167,139,250,0.2);
+  }
+
+  table {
+    width: 100%;
+    border-collapse: collapse;
+  }
+
+  td, th {
+    padding: 8px;
+    border-bottom: 1px solid rgba(255,255,255,0.05);
+  }
+
+  th {
+    text-align: left;
+    border-bottom: 1px solid #f4f4f4;
+  }
+
+  .rule-notes {
+    padding: 16px;
+    color: black;
+    background: #f4f4f4;
+    border-radius: 12px;
+  }
+
+  .text-center {
+    text-align: center;
+  }
+  `;
+}
+
+/* ---------------------------------------
+ * CLIENT JS
+ * -------------------------------------*/
+function generateClientJS() {
+  return `
+  const search = document.getElementById("search");
+  search.addEventListener("input", e => {
+    const value = e.target.value.toLowerCase();
+    document.querySelectorAll("section.card").forEach(card => {
+      card.style.display = card.innerText.toLowerCase().includes(value)
+        ? ""
+        : "none";
+    });
+  });
+  `;
+}

package/dist/main.cjs.js

@@ -1 +1 @@
-var V=Object.defineProperty;var j=Object.getOwnPropertyDescriptor;var D=Object.getOwnPropertyNames;var T=Object.prototype.hasOwnProperty;var U=(r,n)=>{for(var u in n)V(r,u,{get:n[u],enumerable:!0})},F=(r,n,u,i)=>{if(n&&typeof n=="object"||typeof n=="function")for(let y of D(n))!T.call(r,y)&&y!==u&&V(r,y,{get:()=>n[y],enumerable:!(i=j(n,y))||i.enumerable});return r};var L=r=>F(V({},"__esModule",{value:!0}),r);var x={};U(x,{createValidator:()=>E});module.exports=L(x);var m={propertiesMustMatch:!0,abortEarly:!1,cache:!0};function E(r,{validationHelpers:n={},rules:u,schema:i,errorMessages:y={},options:f=m}){f={...m,...f},r=r;let k={},a={},p={all:async e=>Promise.all([...e].map(async s=>await v(s,r))),first:async e=>{let s=[];for(let l of e){let c=await v(l,r);if(s.push(c),!c)return s}return s}};function g(e,s){if(!e||typeof s!="string")return;let l=s.split("."),c=e;for(let d of l){if(c[d]===void 0)return;c=c[d]}return c}async function v(e,s=null){var l,c;if(i[e.key]){let{rule:d,required:t}=i[e.key];if((((l=i[e.key])==null?void 0:l.cache)!==void 0?i[e.key].cache:f.cache)&&s[e.key]===((c=a[e.key])==null?void 0:c.value))return a[e.key].isValid;if((d&&t||!t&&e.value!="")&&d){let O=d.split("--")[0],q=d.split("--").length>1?d.split("--")[1]:"",P=_(e.value,u[O],q,n,s),{isValid:w,errorMessage:R,errorType:I}=await P.validate();return w||(k[e.key]={name:e.key,code:R,type:I,message:g(y,R)||""}),a[e.key]={isValid:w,value:s[e.key]},w}}else if(f.propertiesMustMatch)return k[e.key]={name:e.key,message:"Invalid property"},!1;return!0}async function M(e){return await v({key:e,value:r[e]},r)?{ok:!0}:{error:!0,errors:k[e]}}async function o(){k={};let e=Object.keys(r).map(s=>({key:s,value:r[s]}));if(e&&e.length>0){if(!Object.keys(i).every(t=>r.hasOwnProperty(t)))return{error:!0,errorMessage:"Missing properties"};if((f!=null&&f.abortEarly?await p.first(e):await p.all(e)).some(t=>!t))return{error:!0,errors:k};let l=Object.keys(i).map(t=>({key:t,required:i[t].required})),c=e.map(t=>t.key);if(!l.filter(t=>t.required).map(t=>t.key).every(t=>c.includes(t)))return{error:!0}}else if(!e||e.length===0)return{error:!0,errorMessage:"Missing fields for schema"};return{ok:!0}}function h(e){r=e}return{validate:o,validateField:M,setData:h}}function _(r,n,u=null,i=null,y=null){async function f(a){let p,g;return{isValid:!(await Promise.all(a.validate.map(async o=>{let h=!0;if(a.params&&a.params[o]&&a.params[o].length>0){let e=a.params[o].map(l=>typeof l=="string"&&l[0]==="$"?l.substring(1,l.length):l);h=await this[o](...e)}else h=await this[o]();return!h&&!p&&(a!=null&&a.error[o])&&(p=a.error[o],g=o),h}))).some(o=>!o),errorMessage:p,errorType:g}}async function k(){if(i&&typeof i=="function"){let p=i(r,n,u,y);Object.keys(p).forEach(g=>{this[g]=p[g]})}return u?await f.call(this,n.modifier[u]):await f.call(this,n)}return{validate:k}}0&&(module.exports={createValidator});
+var M=Object.defineProperty;var j=Object.getOwnPropertyDescriptor;var D=Object.getOwnPropertyNames;var U=Object.prototype.hasOwnProperty;var L=(r,a)=>{for(var u in a)M(r,u,{get:a[u],enumerable:!0})},_=(r,a,u,l)=>{if(a&&typeof a=="object"||typeof a=="function")for(let d of D(a))!U.call(r,d)&&d!==u&&M(r,d,{get:()=>a[d],enumerable:!(l=j(a,d))||l.enumerable});return r};var x=r=>_(M({},"__esModule",{value:!0}),r);var K={};L(K,{createValidator:()=>q});module.exports=x(K);var O={propertiesMustMatch:!0,abortEarly:!1,cache:!0};function q(r,{validationHelpers:a={},rules:u,schema:l,errorMessages:d={},hooks:g={},options:p=O}){p={...O,...p},r=r;let i={},y={},v={all:async e=>Promise.all([...e].map(async n=>await m(n,r))),first:async e=>{let n=[];for(let V of e){let t=await m(V,r);if(n.push(t),!t)return n}return n}};function w(e,n){if(!e||typeof n!="string")return;let V=n.split("."),t=e;for(let f of V){if(t[f]===void 0)return;t=t[f]}return t}async function m(e,n=null){var V,t;if(o("onValidateFieldStart",{field:e.key,value:e.value,schemaField:l[e.key]||null}),l[e.key]){let{rule:f,required:s}=l[e.key];if((((V=l[e.key])==null?void 0:V.cache)!==void 0?l[e.key].cache:p.cache)&&n[e.key]===((t=y[e.key])==null?void 0:t.value))return y[e.key].isValid;if((f&&s||!s&&e.value!="")&&f){let P=f.split("--")[0],S=f.split("--").length>1?f.split("--")[1]:"",I=B(e.value,u[P],S,a,n),{isValid:E,errorMessage:F,errorType:T}=await I.validate();if(E)o("onValidateFieldSuccess",{field:e.key,value:e.value,schemaField:l[e.key]});else{let R={name:e.key,field:e.key,code:F,type:T,message:w(d,F)||""};i[e.key]=R,o("onValidateFieldError",{field:e.key,value:e.value,schemaField:l[e.key],error:R})}return y[e.key]={isValid:E,value:n[e.key]},E}}else if(p.propertiesMustMatch){let f={name:e.key,field:e.key,message:"Invalid property",internal:!0};return i[e.key]=f,o("onValidateFieldError",{field:e.key,value:e.value,error:f}),!1}return o("onValidateFieldSuccess",{field:e.key,value:e.value}),!0}async function c(e){return await m({key:e,value:r[e]},r)?{ok:!0}:{error:!0,errors:i[e]}}async function k(){o("onValidateStart",{data:r}),i={};let e=Object.keys(r).map(n=>({key:n,value:r[n]}));if(e&&e.length>0){if(!Object.keys(l).every(s=>r.hasOwnProperty(s)))return o("onValidateEnd",{data:r,errors:[{name:"internal: schema - missing properties",message:"Missing properties",internal:!0}]}),{error:!0,errorMessage:"Missing properties"};if((p!=null&&p.abortEarly?await v.first(e):await v.all(e)).some(s=>!s))return o("onValidateEnd",{data:r,errors:i}),{error:!0,errors:i};let V=Object.keys(l).map(s=>({key:s,required:l[s].required})),t=e.map(s=>s.key);if(!V.filter(s=>s.required).map(s=>s.key).every(s=>t.includes(s))){let s={error:!0};return o("onValidateEnd",{data:r,errors:[{name:"internal: fields - required",message:"",internal:!0}]}),s}}else if(!e||e.length===0){let n={error:!0,errorMessage:"Missing fields for schema"};return o("onValidateEnd",{data:r,errors:[{name:"internal: schema - missing fields",message:n.errorMessage,internal:!0}]}),n}return o("onValidateEnd",{data:r}),{ok:!0}}function o(e,n){g!=null&&g[e]&&typeof g[e]=="function"&&g[e]({...n})}function h(e){r=e}return{validate:k,validateField:c,setData:h}}function B(r,a,u=null,l=null,d=null){async function g(i){let y,v;return{isValid:!(await Promise.all(i.validate.map(async c=>{let k=!0;if(i.params&&i.params[c]&&i.params[c].length>0){let o=i.params[c].map(e=>typeof e=="string"&&e[0]==="$"?e.substring(1,e.length):e);k=await this[c](...o)}else k=await this[c]();return!k&&!y&&(i!=null&&i.error[c])&&(y=i.error[c],v=c),k}))).some(c=>!c),errorMessage:y,errorType:v}}async function p(){if(l&&typeof l=="function"){let y=l(r,a,u,d);Object.keys(y).forEach(v=>{this[v]=y[v]})}return u?await g.call(this,a.modifier[u]):await g.call(this,a)}return{validate:p}}0&&(module.exports={createValidator});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-rule-mate",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "",
   "main": "./dist/main.cjs.js",
   "type": "commonjs",
@@ -17,6 +17,9 @@
     "check rule",
     "check rule mate"
   ],
+  "bin": {
+    "check-rule-mate-auto-docs": "./bin/generate-docs.js"
+  },
   "scripts": {
     "start": "node ./examples/vanilla/src/index.js",
     "build": "node build",

package/src/index.d.ts

@@ -86,6 +86,9 @@ export interface DataValidatorConfigs {
 
   /** Validator options */
   options: ValidatorOptions
+
+  /** Validator hooks */
+  hooks: ValidatorHooks
 }
 
 /**
@@ -100,9 +103,12 @@ export interface DataValidatorSuccessResponse {
  * Error object.
  */
 export interface CheckError {
-  /** Field name */
+  /** Error name */
   name: string
 
+  /** Field name */
+  field?: string
+
   /** Error path */
   code?: string
 
@@ -111,6 +117,9 @@ export interface CheckError {
 
   /** Error message */
   message?: string
+
+  /** Internal error flag */
+  internal?: boolean
 }
 
 /**
@@ -126,3 +135,94 @@ export interface DataValidatorErrorResponse {
   /** Additional error details */
   errors?: Record<string, CheckError>
 }
+
+export interface ValidatorHooks {
+  /** Executed before validation runs */
+  onValidateStart?: onValidateStart
+
+  /** Executed before validation runs for each field */
+  onValidateFieldStart?: onValidateFieldStart
+
+  /** Executed when validation fails for some field */
+  onValidateFieldError?: onValidateFieldError
+
+  /** Executed when validation has success for some field */
+  onValidateFieldSuccess?: onValidateFieldSuccess
+
+  /** Executed after validation runs */
+  onValidateEnd?: onValidateEnd
+}
+
+export interface onValidateStart {
+  /** Returns the payload of hook */
+  payload: onValidateStartPayload
+}
+
+export interface onValidateFieldStart {
+  /** Returns the payload of hook */
+  payload: onValidateFieldStartPayload
+}
+
+export interface onValidateFieldError {
+  /** Returns the payload of hook */
+  payload: onValidateFieldErrorPayload
+}
+
+export interface onValidateFieldSuccess {
+  /** Returns the payload of hook */
+  payload: onValidateFieldSuccessPayload
+}
+
+export interface onValidateEnd {
+  /** Returns the payload of hook */
+  payload: onValidateEndPayload
+}
+
+export interface onValidateStartPayload {
+  /** Form data object */
+  data: Object
+}
+
+export interface onValidateFieldStart {
+  /** Field name */
+  field: string
+
+  /** Field value */
+  value: any
+
+  /** Schema field */
+  schemaField: SchemaRuleField
+}
+
+export interface onValidateFieldError {
+  /** Field name */
+  field: string
+
+  /** Field value */
+  value: any
+
+  /** Schema field */
+  schemaField: SchemaRuleField
+
+  /** Field error */
+  error: CheckError
+}
+
+export interface onValidateFieldSuccess {
+  /** Field name */
+  field: string
+
+  /** Field value */
+  value: any
+
+  /** Schema field */
+  schemaField: SchemaRuleField
+}
+
+export interface onValidateEndPayload {
+  /** Form data object */
+  data: Object
+
+  /** Form errors  */
+  errors?: Record<string, CheckError>
+}

package/src/js/dataValidate.js

@@ -5,7 +5,7 @@ const DEFAUL_OPTIONS = { propertiesMustMatch: true, abortEarly: false, cache: tr
  * @param {[DataField]} data - All the data fields to be validate
  * @param {DataValidatorConfigs} config - The configs which will be followed during validation
  */
-export function createValidator(data, {validationHelpers = {}, rules, schema, errorMessages = {}, options = DEFAUL_OPTIONS}) {
+export function createValidator(data, {validationHelpers = {}, rules, schema, errorMessages = {}, hooks = {}, options = DEFAUL_OPTIONS}) {
     options = { ...DEFAUL_OPTIONS, ...options};
     data = data;
     let errors = {};
@@ -41,6 +41,7 @@ export function createValidator(data, {validationHelpers = {}, rules, schema, er
     }
 
     async function inputValidation(dataAttribute, data = null) {
+        hookTrigger('onValidateFieldStart', { field: dataAttribute.key, value: dataAttribute.value, schemaField: schema[dataAttribute.key] || null });
         if (schema[dataAttribute.key]) {
             const { rule, required } = schema[dataAttribute.key];
             const cacheEnabled = schema[dataAttribute.key]?.cache !== undefined ? schema[dataAttribute.key].cache : options.cache;
@@ -56,24 +57,36 @@ export function createValidator(data, {validationHelpers = {}, rules, schema, er
                     const dataAttributeValidation = dataAttributeValidator(dataAttribute.value, rules[INPUT_RULE], RULE_MODIFIER, validationHelpers, data);
                     const { isValid, errorMessage, errorType } = await dataAttributeValidation.validate();
                     if (!isValid) {
-                        errors[dataAttribute.key] = {
+                        const error = {
                             name: dataAttribute.key,
+                            field: dataAttribute.key,
                             code: errorMessage,
                             type: errorType,
                             message: getObjectValueByPath(errorMessages, errorMessage) || ''
-                        }
+                        };
+
+                        errors[dataAttribute.key] = error;
+                        hookTrigger('onValidateFieldError', { field: dataAttribute.key, value: dataAttribute.value, schemaField: schema[dataAttribute.key] , error: error });
+                    } else {
+                        hookTrigger('onValidateFieldSuccess', { field: dataAttribute.key, value: dataAttribute.value, schemaField: schema[dataAttribute.key] });
                     }
                     oldData[dataAttribute.key] = {isValid: isValid, value: data[dataAttribute.key]};
                     return isValid;
                 }
             }
         } else if (options.propertiesMustMatch) {
-            errors[dataAttribute.key] = {
+            const error = {
                 name: dataAttribute.key,
-                message: "Invalid property"
+                field: dataAttribute.key,
+                message: "Invalid property",
+                internal: true
             }
+
+            errors[dataAttribute.key] = error;
+            hookTrigger('onValidateFieldError', { field: dataAttribute.key, value: dataAttribute.value, error: error });
             return false;
         }
+        hookTrigger('onValidateFieldSuccess', { field: dataAttribute.key, value: dataAttribute.value });
         return true;
     }
 
@@ -95,15 +108,18 @@ export function createValidator(data, {validationHelpers = {}, rules, schema, er
      * @returns {DataValidatorSuccessResponse | DataValidatorErrorResponse} - The response of your validation
      */
     async function validate() {
+        hookTrigger('onValidateStart', { data });
         errors = {};
         let dataArr = Object.keys(data).map((key) => ({ key, value: data[key] }));
         if (dataArr && dataArr.length > 0) {
             if(!Object.keys(schema).every((key) => data.hasOwnProperty(key))) {
+                hookTrigger('onValidateEnd', { data, errors: [{name: 'internal: schema - missing properties' , message: 'Missing properties', internal: true}] });
                 return { error: true, errorMessage: "Missing properties"}
             }
             const dataValidators = options?.abortEarly ? await validateByStrategies.first(dataArr) : await validateByStrategies.all(dataArr);
 
             if (dataValidators.some((element) => !element)) {
+                hookTrigger('onValidateEnd', { data, errors: errors });
                 return { error: true, errors: errors };
             }
 
@@ -112,14 +128,27 @@ export function createValidator(data, {validationHelpers = {}, rules, schema, er
             const dataAttributesRequired = dataRuleArr.filter((rule) => rule.required).map((rule) => rule.key);
 
             if (!dataAttributesRequired.every((fieldRequired) => dataAttributesKey.includes(fieldRequired))) {
-                return { error: true };
+                const error = { error: true };
+
+                hookTrigger('onValidateEnd', { data, errors: [{name: 'internal: fields - required' , message: '', internal: true}] });
+                return error;
             }
         } else if (!dataArr || dataArr.length === 0) {
-            return { error: true, errorMessage: "Missing fields for schema"}
+            const error = { error: true, errorMessage: "Missing fields for schema"};
+
+            hookTrigger('onValidateEnd', { data, errors: [{name: 'internal: schema - missing fields' , message: error.errorMessage, internal: true}] });
+            return error;
         }
+        hookTrigger('onValidateEnd', { data });
         return { ok: true };
     }
 
+    function hookTrigger(hookName, parameters) {
+        if (hooks?.[hookName] && typeof hooks[hookName] === 'function') {
+            hooks[hookName]({...parameters});
+        }
+    }
+
     function setData(newData) {
         data = newData;
     }

package/src/types.js

@@ -16,6 +16,7 @@
  * @property {SchemaRule} schema - The rules you want to use per field
  * @property {Object} errorMessages - The error messages you want to show during errors
  * @property {ValidatorOptions} options - Options
+ * @property {ValidatorHooks} hooks - The hooks you want to execute in some specific phase of validation
  */
 
 /**
@@ -74,8 +75,78 @@
  *  Error Object
  *
  * @typedef {Object} CheckError
- * @property {string} name - Field name
+ * @property {string} name - Error name
+ * @property {string} field - Field name (optional)
  * @property {string} code - Error path (optional)
  * @property {string} type - Error type (optional)
  * @property {string} message - Error message (optional)
+ * @property {boolean} internal - Flag to know if it is a internal error (optional)
+ */
+
+
+/**
+ * @typedef {Object} ValidatorHooks
+ * @property {onValidateStart} onValidateStart - Executed before validation runs
+ * @property {onValidateFieldStart} onValidateFieldStart - Executed before validation runs for each field
+ * @property {onValidateFieldError} onValidateFieldError - Executed when validation fails for some field
+ * @property {onValidateFieldSuccess} onValidateFieldSuccess - Executed when validation has success for some field
+ * @property {onValidateEnd} onValidateEnd - Executed after validation runs
+ */
+
+/**
+ * @typedef {Function} onValidateStart
+ * @property {onValidateStartPayload} payload - Returns the payload of validate form hook
+ */
+
+/**
+ * @typedef {Object} onValidateStartPayload
+ * @property {Object} data - Returns the form data
+ */
+
+/**
+ * @typedef {Function} onValidateFieldStart
+ * @property {onValidateFieldStartPayload} payload - Returns the payload of validate field hook
+ */
+
+/**
+ * @typedef {Object} onValidateFieldStartPayload
+ * @property {string} field - Returns the field name
+ * @property {any} value - Returns the value of field
+ * @property {SchemaRuleField} schemaField - Returns the schema field
+ */
+
+/**
+ * @typedef {Function} onValidateFieldError
+ * @property {onValidateFieldErrorPayload} payload - Returns the payload of validate field error hook
+ */
+
+/**
+ * @typedef {Object} onValidateFieldErrorPayload
+ * @property {string} field - Returns the field name
+ * @property {string} value - Returns the value of field
+ * @property {SchemaRuleField} schemaField - Returns the schema field
+ * @property {CheckError} error - Returns the error data
+ */
+
+/**
+ * @typedef {Function} onValidateFieldSuccess
+ * @property {onValidateFieldSuccessPayload} payload - Returns the payload of validate field success hook
+ */
+
+/**
+ * @typedef {Object} onValidateFieldSuccessPayload
+ * @property {string} field - Returns the field name
+ * @property {string} value - Returns the value of field
+ * @property {SchemaRuleField} schemaField - Returns the schema field
+ */
+
+/**
+ * @typedef {Function} onValidateEnd
+ * @property {onValidateEndPayload} payload - Returns the payload of validate form hook
+ */
+
+/**
+ * @typedef {Object} onValidateEndPayload
+ * @property {Object} data - Returns the form data
+ * @property {DataValidatorErrorResponse} errors - Returns the errors of validation if had
  */