@websolutespa/bom-mixer-forms 0.3.5 → 1.8.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @websolutespa/bom-mixer-forms
 
+## 1.8.1
+
+### Patch Changes
+
+- 15ad595: Added: Validators parametric error key
+
+## 1.8.0
+
+### Patch Changes
+
+- Updated dependencies [f8a1d97]
+  - @websolutespa/bom-core@1.8.0
+  - @websolutespa/bom-mixer-hooks@1.8.0
+
 ## 0.3.5
 
 ### Patch Changes

package/dist/index.d.ts

@@ -261,32 +261,32 @@ declare function stringToValue(value: string | string[] | undefined, options?: I
 /**
  * an email pattern validator
  */
-declare function EmailValidator(): FormValidator;
+declare function EmailValidator(key?: string): FormValidator;
 
 /**
  * an equality match validation on another field
  */
-declare function MatchValidator(getOtherValue: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => any): FormValidator;
+declare function MatchValidator(getOtherValue: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => any, key?: string): FormValidator;
 
 /**
  * a max string length validator
  */
-declare function MaxLengthValidator(maxlength: number): FormValidator;
+declare function MaxLengthValidator(maxlength: number, key?: string): FormValidator;
 
 /**
  * a max number value validator
  */
-declare function MaxValidator(max: number): FormValidator;
+declare function MaxValidator(max: number, key?: string): FormValidator;
 
 /**
  * a min string length validator
  */
-declare function MinLengthValidator(minlength: number): FormValidator;
+declare function MinLengthValidator(minlength: number, key?: string): FormValidator;
 
 /**
  * a min number value validator
  */
-declare function MinValidator(min: number): FormValidator;
+declare function MinValidator(min: number, key?: string): FormValidator;
 
 /**
  * a null validator
@@ -296,22 +296,22 @@ declare function NullValidator(): FormValidator;
 /**
  * a regex pattern validator
  */
-declare function PatternValidator(pattern: string | RegExp): FormValidator;
+declare function PatternValidator(pattern: string | RegExp, key?: string): FormValidator;
 
 /**
  * a required dependant on another field
  */
-declare function RequiredIfValidator(condition: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => boolean): FormValidator;
+declare function RequiredIfValidator(condition: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => boolean, key?: string): FormValidator;
 
 /**
  * a required and true validator
  */
-declare function RequiredTrueValidator(): FormValidator;
+declare function RequiredTrueValidator(key?: string): FormValidator;
 
 /**
  * a required validator
  */
-declare function RequiredValidator(): FormValidator;
+declare function RequiredValidator(key?: string): FormValidator;
 
 declare function useControl<T>(control: FormAbstract): [FormState<T>, (value: T | null) => void, () => void, () => void, FormAbstract];
 

package/dist/index.js

@@ -864,11 +864,11 @@ function formGroup(controls = {}, validators) {
 }
 
 // src/forms/validators/email.validator.ts
-function EmailValidator() {
+function EmailValidator(key = "email") {
   const regex = /^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
   return function(value) {
     if (typeof value === "string") {
-      return regex.test(value) ? null : { email: true };
+      return regex.test(value) ? null : { [key]: true };
     } else {
       return null;
     }
@@ -876,23 +876,23 @@ function EmailValidator() {
 }
 
 // src/forms/validators/match.validator.ts
-function MatchValidator(getOtherValue) {
+function MatchValidator(getOtherValue, key = "match") {
   return function(value, rootValue, control, root) {
     let otherValue = getOtherValue(value, rootValue, control, root);
     otherValue = validValue(otherValue);
-    return value !== otherValue ? { match: { value, match: otherValue } } : null;
+    return value !== otherValue ? { [key]: { value, match: otherValue } } : null;
   };
 }
 
 // src/forms/validators/max-length.validator.ts
-function MaxLengthValidator(maxlength) {
+function MaxLengthValidator(maxlength, key = "maxlength") {
   return function(value) {
     if (maxlength == null) {
       return null;
     }
     if (typeof value === "string") {
       const length = value ? value.length : 0;
-      return length > maxlength ? { minlength: { requiredLength: maxlength, actualLength: length } } : null;
+      return length > maxlength ? { [key]: { requiredLength: maxlength, actualLength: length } } : null;
     } else {
       return null;
     }
@@ -900,25 +900,25 @@ function MaxLengthValidator(maxlength) {
 }
 
 // src/forms/validators/max.validator.ts
-function MaxValidator(max) {
+function MaxValidator(max, key = "max") {
   return function(value) {
     value = typeof value === "string" ? parseFloat(value) : typeof value === "number" ? value : null;
     if (value == null || max == null) {
       return null;
     }
-    return !isNaN(value) && value > max ? { max: { max, actual: value } } : null;
+    return !isNaN(value) && value > max ? { [key]: { max, actual: value } } : null;
   };
 }
 
 // src/forms/validators/min-length.validator.ts
-function MinLengthValidator(minlength) {
+function MinLengthValidator(minlength, key = "minlength") {
   return function(value) {
     if (minlength == null) {
       return null;
     }
     if (typeof value === "string") {
       const length = value ? value.length : 0;
-      return length < minlength ? { minlength: { requiredLength: minlength, actualLength: length } } : null;
+      return length < minlength ? { [key]: { requiredLength: minlength, actualLength: length } } : null;
     } else {
       return null;
     }
@@ -926,13 +926,13 @@ function MinLengthValidator(minlength) {
 }
 
 // src/forms/validators/min.validator.ts
-function MinValidator(min) {
+function MinValidator(min, key = "min") {
   return function(value) {
     value = typeof value === "string" ? parseFloat(value) : typeof value === "number" ? value : null;
     if (value == null || min == null) {
       return null;
     }
-    return !isNaN(value) && value < min ? { min: { min, actual: value } } : null;
+    return !isNaN(value) && value < min ? { [key]: { min, actual: value } } : null;
   };
 }
 
@@ -944,14 +944,14 @@ function NullValidator() {
 }
 
 // src/forms/validators/pattern.validator.ts
-function PatternValidator(pattern) {
+function PatternValidator(pattern, key = "pattern") {
   return function(value) {
     if (pattern == null) {
       return null;
     }
     if (typeof value === "string") {
       const regex = patternToRegEx(pattern);
-      return regex.test(value) ? null : { pattern: { requiredPattern: regex.toString(), actualValue: value } };
+      return regex.test(value) ? null : { [key]: { requiredPattern: regex.toString(), actualValue: value } };
     } else {
       return null;
     }
@@ -971,13 +971,13 @@ function patternToRegEx(pattern) {
 
 // src/forms/validators/required-if.validator.ts
 var import_bom_core3 = require("@websolutespa/bom-core");
-function RequiredIfValidator(condition) {
+function RequiredIfValidator(condition, key = "required") {
   return function(value, rootValue, control, root) {
     if (Boolean(condition(value, rootValue, control, root)) === true) {
       if ((0, import_bom_core3.isArray)(value) || typeof value === "string") {
-        return value.length === 0 ? { required: true } : null;
+        return value.length === 0 ? { [key]: true } : null;
       } else {
-        return value == null ? { required: true } : null;
+        return value == null ? { [key]: true } : null;
       }
     } else {
       return null;
@@ -986,20 +986,20 @@ function RequiredIfValidator(condition) {
 }
 
 // src/forms/validators/required-true.validator.ts
-function RequiredTrueValidator() {
+function RequiredTrueValidator(key = "required") {
   return function(value) {
-    return value === true ? null : { required: true };
+    return value === true ? null : { [key]: true };
   };
 }
 
 // src/forms/validators/required.validator.ts
 var import_bom_core4 = require("@websolutespa/bom-core");
-function RequiredValidator() {
+function RequiredValidator(key = "required") {
   return function(value) {
     if ((0, import_bom_core4.isArray)(value) || typeof value === "string") {
-      return value.length === 0 ? { required: true } : null;
+      return value.length === 0 ? { [key]: true } : null;
     } else {
-      return value == null ? { required: true } : null;
+      return value == null ? { [key]: true } : null;
     }
   };
 }

package/dist/index.mjs

@@ -816,11 +816,11 @@ function formGroup(controls = {}, validators) {
 }
 
 // src/forms/validators/email.validator.ts
-function EmailValidator() {
+function EmailValidator(key = "email") {
   const regex = /^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
   return function(value) {
     if (typeof value === "string") {
-      return regex.test(value) ? null : { email: true };
+      return regex.test(value) ? null : { [key]: true };
     } else {
       return null;
     }
@@ -828,23 +828,23 @@ function EmailValidator() {
 }
 
 // src/forms/validators/match.validator.ts
-function MatchValidator(getOtherValue) {
+function MatchValidator(getOtherValue, key = "match") {
   return function(value, rootValue, control, root) {
     let otherValue = getOtherValue(value, rootValue, control, root);
     otherValue = validValue(otherValue);
-    return value !== otherValue ? { match: { value, match: otherValue } } : null;
+    return value !== otherValue ? { [key]: { value, match: otherValue } } : null;
   };
 }
 
 // src/forms/validators/max-length.validator.ts
-function MaxLengthValidator(maxlength) {
+function MaxLengthValidator(maxlength, key = "maxlength") {
   return function(value) {
     if (maxlength == null) {
       return null;
     }
     if (typeof value === "string") {
       const length = value ? value.length : 0;
-      return length > maxlength ? { minlength: { requiredLength: maxlength, actualLength: length } } : null;
+      return length > maxlength ? { [key]: { requiredLength: maxlength, actualLength: length } } : null;
     } else {
       return null;
     }
@@ -852,25 +852,25 @@ function MaxLengthValidator(maxlength) {
 }
 
 // src/forms/validators/max.validator.ts
-function MaxValidator(max) {
+function MaxValidator(max, key = "max") {
   return function(value) {
     value = typeof value === "string" ? parseFloat(value) : typeof value === "number" ? value : null;
     if (value == null || max == null) {
       return null;
     }
-    return !isNaN(value) && value > max ? { max: { max, actual: value } } : null;
+    return !isNaN(value) && value > max ? { [key]: { max, actual: value } } : null;
   };
 }
 
 // src/forms/validators/min-length.validator.ts
-function MinLengthValidator(minlength) {
+function MinLengthValidator(minlength, key = "minlength") {
   return function(value) {
     if (minlength == null) {
       return null;
     }
     if (typeof value === "string") {
       const length = value ? value.length : 0;
-      return length < minlength ? { minlength: { requiredLength: minlength, actualLength: length } } : null;
+      return length < minlength ? { [key]: { requiredLength: minlength, actualLength: length } } : null;
     } else {
       return null;
     }
@@ -878,13 +878,13 @@ function MinLengthValidator(minlength) {
 }
 
 // src/forms/validators/min.validator.ts
-function MinValidator(min) {
+function MinValidator(min, key = "min") {
   return function(value) {
     value = typeof value === "string" ? parseFloat(value) : typeof value === "number" ? value : null;
     if (value == null || min == null) {
       return null;
     }
-    return !isNaN(value) && value < min ? { min: { min, actual: value } } : null;
+    return !isNaN(value) && value < min ? { [key]: { min, actual: value } } : null;
   };
 }
 
@@ -896,14 +896,14 @@ function NullValidator() {
 }
 
 // src/forms/validators/pattern.validator.ts
-function PatternValidator(pattern) {
+function PatternValidator(pattern, key = "pattern") {
   return function(value) {
     if (pattern == null) {
       return null;
     }
     if (typeof value === "string") {
       const regex = patternToRegEx(pattern);
-      return regex.test(value) ? null : { pattern: { requiredPattern: regex.toString(), actualValue: value } };
+      return regex.test(value) ? null : { [key]: { requiredPattern: regex.toString(), actualValue: value } };
     } else {
       return null;
     }
@@ -923,13 +923,13 @@ function patternToRegEx(pattern) {
 
 // src/forms/validators/required-if.validator.ts
 import { isArray } from "@websolutespa/bom-core";
-function RequiredIfValidator(condition) {
+function RequiredIfValidator(condition, key = "required") {
   return function(value, rootValue, control, root) {
     if (Boolean(condition(value, rootValue, control, root)) === true) {
       if (isArray(value) || typeof value === "string") {
-        return value.length === 0 ? { required: true } : null;
+        return value.length === 0 ? { [key]: true } : null;
       } else {
-        return value == null ? { required: true } : null;
+        return value == null ? { [key]: true } : null;
       }
     } else {
       return null;
@@ -938,20 +938,20 @@ function RequiredIfValidator(condition) {
 }
 
 // src/forms/validators/required-true.validator.ts
-function RequiredTrueValidator() {
+function RequiredTrueValidator(key = "required") {
   return function(value) {
-    return value === true ? null : { required: true };
+    return value === true ? null : { [key]: true };
   };
 }
 
 // src/forms/validators/required.validator.ts
 import { isArray as isArray2 } from "@websolutespa/bom-core";
-function RequiredValidator() {
+function RequiredValidator(key = "required") {
   return function(value) {
     if (isArray2(value) || typeof value === "string") {
-      return value.length === 0 ? { required: true } : null;
+      return value.length === 0 ? { [key]: true } : null;
     } else {
-      return value == null ? { required: true } : null;
+      return value == null ? { [key]: true } : null;
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websolutespa/bom-mixer-forms",
-  "version": "0.3.5",
+  "version": "1.8.1",
   "description": "Mixer Forms module of the BOM Repository",
   "keywords": [
     "bom",
@@ -15,7 +15,7 @@
   "scripts": {
     "lint": "eslint *.ts*",
     "test": "jest",
-    "test-watch": "npm test -- --watch",
+    "test-watch": "npm test -- --watch --silent=false",
     "coverage:integration": "npm run test -- --coverage",
     "coverage": "run-s -c --silent coverage:*",
     "compile": "tsup ./src/index.ts --format esm,cjs --dts --external react",

package/src/forms/validators/email.validator.ts

@@ -3,11 +3,11 @@ import { FormValidator } from '../types';
 /**
  * an email pattern validator
  */
-export function EmailValidator(): FormValidator {
+export function EmailValidator(key: string = 'email'): FormValidator {
   const regex = /^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
   return function (value) {
     if (typeof value === 'string') {
-      return regex.test(value) ? null : { email: true };
+      return regex.test(value) ? null : { [key]: true };
     } else {
       return null;
     }

package/src/forms/validators/match.validator.ts

@@ -5,10 +5,13 @@ import { validValue } from '../utils';
 /**
  * an equality match validation on another field
  */
-export function MatchValidator(getOtherValue: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => any): FormValidator {
+export function MatchValidator(
+  getOtherValue: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => any,
+  key: string = 'match'
+): FormValidator {
   return function (value, rootValue, control, root) {
     let otherValue = getOtherValue(value, rootValue, control, root);
     otherValue = validValue(otherValue);
-    return value !== otherValue ? { match: { value: value, match: otherValue } } : null;
+    return value !== otherValue ? { [key]: { value: value, match: otherValue } } : null;
   };
 }

package/src/forms/validators/max-length.validator.ts

@@ -3,14 +3,14 @@ import { FormValidator } from '../types';
 /**
  * a max string length validator
  */
-export function MaxLengthValidator(maxlength: number): FormValidator {
+export function MaxLengthValidator(maxlength: number, key: string = 'maxlength'): FormValidator {
   return function (value) {
     if (maxlength == null) {
       return null;
     }
     if (typeof value === 'string') {
       const length = value ? value.length : 0;
-      return length > maxlength ? { minlength: { requiredLength: maxlength, actualLength: length } } : null;
+      return length > maxlength ? { [key]: { requiredLength: maxlength, actualLength: length } } : null;
     } else {
       return null;
     }

package/src/forms/validators/max.validator.ts

@@ -3,12 +3,12 @@ import { FormValidator } from '../types';
 /**
  * a max number value validator
  */
-export function MaxValidator(max: number): FormValidator {
+export function MaxValidator(max: number, key: string = 'max'): FormValidator {
   return function (value) {
     value = typeof value === 'string' ? parseFloat(value) : typeof value === 'number' ? value : null;
     if (value == null || max == null) { // loose
       return null;
     }
-    return !isNaN(value) && value > max ? { max: { max: max, actual: value } } : null;
+    return !isNaN(value) && value > max ? { [key]: { max: max, actual: value } } : null;
   };
 }

package/src/forms/validators/min-length.validator.ts

@@ -3,14 +3,14 @@ import { FormValidator } from '../types';
 /**
  * a min string length validator
  */
-export function MinLengthValidator(minlength: number): FormValidator {
+export function MinLengthValidator(minlength: number, key: string = 'minlength'): FormValidator {
   return function (value) {
     if (minlength == null) {
       return null;
     }
     if (typeof value === 'string') {
       const length = value ? value.length : 0;
-      return length < minlength ? { minlength: { requiredLength: minlength, actualLength: length } } : null;
+      return length < minlength ? { [key]: { requiredLength: minlength, actualLength: length } } : null;
     } else {
       return null;
     }

package/src/forms/validators/min.validator.ts

@@ -3,12 +3,12 @@ import { FormValidator } from '../types';
 /**
  * a min number value validator
  */
-export function MinValidator(min: number): FormValidator {
+export function MinValidator(min: number, key: string = 'min'): FormValidator {
   return function (value) {
     value = typeof value === 'string' ? parseFloat(value) : typeof value === 'number' ? value : null;
     if (value == null || min == null) { // loose
       return null;
     }
-    return !isNaN(value) && value < min ? { min: { min: min, actual: value } } : null;
+    return !isNaN(value) && value < min ? { [key]: { min: min, actual: value } } : null;
   };
 }

package/src/forms/validators/pattern.validator.ts

@@ -3,14 +3,14 @@ import { FormValidator } from '../types';
 /**
  * a regex pattern validator
  */
-export function PatternValidator(pattern: string | RegExp): FormValidator {
+export function PatternValidator(pattern: string | RegExp, key: string = 'pattern'): FormValidator {
   return function (value) {
     if (pattern == null) { // loose
       return null;
     }
     if (typeof value === 'string') {
       const regex = patternToRegEx(pattern);
-      return regex.test(value) ? null : { pattern: { requiredPattern: regex.toString(), actualValue: value } };
+      return regex.test(value) ? null : { [key]: { requiredPattern: regex.toString(), actualValue: value } };
     } else {
       return null;
     }

package/src/forms/validators/required-if.validator.ts

@@ -5,14 +5,14 @@ import { FormValidator, FormValue } from '../types';
 /**
  * a required dependant on another field
  */
-export function RequiredIfValidator(condition: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => boolean): FormValidator {
+export function RequiredIfValidator(condition: (value: FormValue, rootValue: FormValue, control?: FormAbstract, root?: FormAbstract) => boolean, key: string = 'required'): FormValidator {
   return function (value, rootValue, control, root) {
     // console.log('RequiredIfValidator', value, Boolean(condition(value, rootValue, control, root)));
     if (Boolean(condition(value, rootValue, control, root)) === true) {
       if (isArray(value) || typeof value === 'string') {
-        return (value.length === 0) ? { required: true } : null;
+        return (value.length === 0) ? { [key]: true } : null;
       } else {
-        return value == null ? { required: true } : null;
+        return value == null ? { [key]: true } : null;
       }
     } else {
       return null;

package/src/forms/validators/required-true.validator.ts

@@ -3,9 +3,9 @@ import { FormValidator } from '../types';
 /**
  * a required and true validator
  */
-export function RequiredTrueValidator(): FormValidator {
+export function RequiredTrueValidator(key: string = 'required'): FormValidator {
   return function (value) {
     // console.log('RequiredTrueValidator', value, value === true ? null : { required: true });
-    return value === true ? null : { required: true };
+    return value === true ? null : { [key]: true };
   };
 }

package/src/forms/validators/required.validator.ts

@@ -4,13 +4,13 @@ import { FormValidator } from '../types';
 /**
  * a required validator
  */
-export function RequiredValidator(): FormValidator {
+export function RequiredValidator(key: string = 'required'): FormValidator {
   return function (value) {
     // console.log('RequiredValidator', value, (value == null || value.length === 0) ? { required: true } : null);
     if (isArray(value) || typeof value === 'string') {
-      return (value.length === 0) ? { required: true } : null;
+      return (value.length === 0) ? { [key]: true } : null;
     } else {
-      return value == null ? { required: true } : null;
+      return value == null ? { [key]: true } : null;
     }
   };
   // return (value == null || value.length === 0) ? 'required' : null;