feat: zod driver, svk nested

zod driver, svk nested

#404

CHANGELOG.md

@@ -1,8 +1,13 @@
+# 6.6.0 (master)
+- Introduced ZOD validation driver
+- Added SVK support for array of objects
+- Fix: #404
+
 # 6.5.0 (master)
 - Deprecatad: `setHooks()` & `getHooks()` methods.
 - Handle `set()/get()` for `hooks` and `handlers`
 
-- # 6.4.0 (master)
+# 6.4.0 (master)
 - Feat: ability to define or override hooks after initialization.
 - Feat: Introduced `setHooks()` & `getHooks()` methods.
 

package.json

@@ -110,6 +110,7 @@
     "validatorjs": "^3.15.1",
     "webpack": "^5.70.0",
     "webpack-cli": "^4.9.2",
-    "yup": "^0.32.11"
+    "yup": "^0.32.11",
+    "zod": "^3.22.4"
   }
 }

src/Validator.ts

@@ -22,6 +22,7 @@ export default class Validator implements ValidatorInterface {
     dvr: undefined,
     svk: undefined,
     yup: undefined,
+    zod: undefined,
   };
 
   error: string | null = null;

src/models/ValidatorInterface.ts

@@ -20,6 +20,7 @@ export interface ValidationPlugins {
   dvr?: any;
   svk?: any;
   yup?: any;
+  zod?: any;
 }
 
 export interface ValidationPluginConstructor {

src/validators/SVK.ts

@@ -72,8 +72,7 @@ class SVK implements ValidationPluginInterface {
   }
 
   validate(field) {
-    const data = { [field.path]: field.validatedValue };
-    const validate = this.validator(this.parseValues(data));
+    const validate = this.validator(this.parseValues(field.state.form.validatedValues));
     // check if is $async schema
     if (isPromise(validate)) {
       const $p = validate
@@ -91,7 +90,7 @@ class SVK implements ValidationPluginInterface {
   }
 
   handleSyncError(field, errors) {
-    const fieldErrorObj = this.findError(field.key, errors);
+    const fieldErrorObj = this.findError(field.path, errors);
     // if fieldErrorObj is not undefined, the current field is invalid.
     if (_.isUndefined(fieldErrorObj)) return;
     // the current field is now invalid
@@ -117,9 +116,9 @@ class SVK implements ValidationPluginInterface {
     return _.find(errors, ({ dataPath }) => {
       let $dataPath;
       $dataPath = _.trimStart(dataPath, ".");
-      $dataPath = _.trim($dataPath, "['");
-      $dataPath = _.trim($dataPath, "']");
-      return _.includes($dataPath, `${path}`);
+      $dataPath = _.replace($dataPath, "]", "");
+      $dataPath = _.replace($dataPath, "[", ".");
+      return _.includes($dataPath, path);
     });
   }
 

src/validators/ZOD.ts

@@ -0,0 +1,55 @@
+import _ from "lodash";
+import {
+  ValidationPluginConstructor,
+  ValidationPluginInterface,
+} from "../models/ValidatorInterface";
+
+class ZOD implements ValidationPluginInterface {
+
+  promises = [];
+
+  config = null;
+
+  state = null;
+
+  extend = null;
+
+  validator = null;
+
+  schema = null;
+
+  constructor({
+    config = {},
+    state = null,
+    promises = [],
+  }: ValidationPluginConstructor) {
+    this.state = state;
+    this.promises = promises;
+    this.extend = config.extend;
+    this.validator = config.package || config;
+    this.schema = config.schema;
+    this.extendValidator();
+  }
+
+  extendValidator(): void {
+    // extend using "extend" callback
+    if (typeof this.extend === 'function') {
+      this.extend({
+        validator: this.validator,
+        form: this.state.form,
+      });
+    }
+  }
+
+  validate(field): void {
+    const result = this.schema.safeParse(field.state.form.validatedValues);
+    if (result.success) return;
+    const errors = _.get(result.error.format(), field.path)._errors;
+    if (errors.length) field.validationErrorStack = errors;
+  }
+}
+
+export default (config?: any) => ({
+  class: ZOD,
+  config,
+});

tests/data/_.nested.ts

@@ -8,6 +8,7 @@ import $B from "./forms/nested/form.b";
 import $C from "./forms/nested/form.c";
 import $D from "./forms/nested/form.d_";
 import $E from "./forms/nested/form.e";
+import $E2 from "./forms/nested/form.e2";
 import $F from "./forms/nested/form.f";
 import $G from "./forms/nested/form.g";
 import $H from "./forms/nested/form.h";
@@ -30,6 +31,8 @@ import $V2 from "./forms/nested/form.v2";
 import $V3 from "./forms/nested/form.v3";
 import $V4 from "./forms/nested/form.v4";
 import $Z from "./forms/nested/form.z";
+import $Z1 from "./forms/nested/form.z1";
+import $Z2 from "./forms/nested/form.z2";
 import $X from "./forms/nested/form.x";
 
 export default {
@@ -40,6 +43,7 @@ export default {
   $C,
   $D,
   $E,
+  $E2,
   $F,
   $G,
   $H,
@@ -62,5 +66,7 @@ export default {
   $V3,
   $V4,
   $Z,
+  $Z1,
+  $Z2,
   $X,
 };

tests/data/forms/fixes/form.u.ts

@@ -1,6 +1,7 @@
 import validatorjs from "validatorjs";
 import { Form } from "../../../../src";
 import { OptionsModel } from "../../../../src/models/OptionsModel";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 import dvr from "../../../../src/validators/DVR";
 
 const fields = ["from", "to"];
@@ -15,7 +16,7 @@ const labels = {
   to: "TO",
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   dvr: dvr(validatorjs),
 };
 

tests/data/forms/flat/form.b.ts

@@ -6,6 +6,7 @@ import svkExtend from "../../extension/svk";
 
 import dvr from "../../../../src/validators/DVR";
 import svk from "../../../../src/validators/SVK";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const fields = {
   username: {
@@ -33,7 +34,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   dvr: dvr(validatorjs),
   svk: svk({
     schema,

tests/data/forms/flat/form.c.ts

@@ -3,6 +3,7 @@ import { Form } from "../../../../src";
 import svkExtend from "../../extension/svk";
 import svk from "../../../../src/validators/SVK";
 import { FormInterface } from "../../../../src/models/FormInterface";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const fields = {
   username: {
@@ -33,7 +34,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   svk: svk({
     package: ajv,
     extend: svkExtend,

tests/data/forms/flat/form.e.ts

@@ -7,6 +7,7 @@ import svkExtend from "../../extension/svk";
 import vjf from "../../../../src/validators/VJF";
 import dvr from "../../../../src/validators/DVR";
 import svk from "../../../../src/validators/SVK";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const fields = {
   username: {
@@ -45,7 +46,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   vjf: vjf(),
   dvr: dvr(validatorjs),
   svk: svk({

tests/data/forms/flat/form.f.ts

@@ -5,6 +5,7 @@ import svkExtend from "../../extension/svk";
 
 import vjf from "../../../../src/validators/VJF";
 import svk from "../../../../src/validators/SVK";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const schema = {
   type: "object",
@@ -16,7 +17,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   vjf: vjf(),
   svk: svk({
     package: ajv,

tests/data/forms/flat/form.h.ts

@@ -2,6 +2,7 @@ import ajv from "ajv";
 import { Form } from "../../../../src";
 import svkExtend from "../../extension/svk";
 import svk from "../../../../src/validators/SVK";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const schema = {
   type: "object",
@@ -35,7 +36,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   svk: svk({
     package: ajv,
     extend: svkExtend,

tests/data/forms/flat/form.i.ts

@@ -3,6 +3,7 @@ import { Form } from "../../../../src";
 import svk from "../../../../src/validators/SVK";
 import { FormInterface } from "../../../../src/models/FormInterface";
 import { OptionsModel } from "../../../../src/models/OptionsModel";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const fields = {
   username: {
@@ -28,7 +29,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   svk: svk({
     package: ajv,
     schema,

tests/data/forms/flat/form.l.ts

@@ -3,6 +3,7 @@ import { Form } from "../../../../src";
 import svkExtend from "../../extension/svk";
 import svk from "../../../../src/validators/SVK";
 import { FormInterface } from "../../../../src/models/FormInterface";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const fields = {
   username: {
@@ -39,7 +40,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   svk: svk({
     package: ajv,
     extend: svkExtend,

tests/data/forms/flat/form.m.ts

@@ -8,6 +8,7 @@ import dvr from "../../../../src/validators/DVR";
 import svk from "../../../../src/validators/SVK";
 import { FormInterface } from "../../../../src/models/FormInterface";
 import { OptionsModel } from "../../../../src/models/OptionsModel";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const fields = {
   username: {
@@ -35,7 +36,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   svk: svk({
     package: ajv,
     schema,

tests/data/forms/flat/form.n.ts

@@ -6,6 +6,7 @@ import svk from "../../../../src/validators/SVK";
 import vjf from "../../../../src/validators/VJF";
 import { FormInterface } from "../../../../src/models/FormInterface";
 import { OptionsModel } from "../../../../src/models/OptionsModel";
+import { ValidationPlugins } from "../../../../src/models/ValidatorInterface";
 
 const fields = {
   username: {
@@ -32,7 +33,7 @@ const schema = {
   },
 };
 
-const plugins = {
+const plugins: ValidationPlugins = {
   vjf: vjf(),
   svk: svk({
     package: ajv,