@c8y/ngx-components
Version:
Angular modules for Cumulocity IoT applications
103 lines • 12.9 kB
JavaScript
import { FormControl } from '@angular/forms';
import { forkJoin, of } from 'rxjs';
import { map } from 'rxjs/operators';
export const ARRAY_VALIDATION_PREFIX = 'INNER_ARRAY_ERROR_';
/**
* This method can alter how validators work. It can be used in cases where there is need to validate FormControl
* that as value, takes array of elements. This allows to reuse validators, that works for such elements.
* For example if Validators.minLength(3) is used on control that takes string as value, validator will return error
* if string is less than 3 characters. If same is done on array of strings, validator will return error if array
* has less than 3 elements.
*
* validateArrayElements(Validators.minLength(3)) method makes it possible to check every member of array if it has minimum 3 characters.
* If there are elements that raise error, it will be possible to extract these errors using item index.
*
* As a example, this can be used for custom form elements, which manipulates array of elements,
* and there is need to display corresponding error messages for every array member that is displayed, while still using
* Angular's Validation approach.
*
* Errors that are generated by this helper are prefixed with 'INNER_ARRAY_ERROR_'. Reason for this is to prevent overwriting normal validation
* errors that could have same key
*
* @Example
*
* let control = new FormControl(['1234', '123456', '123', [Validators.minLength(5), validateArrayElements(Validators.minLength(5))] ])
*
* this FormControl has validation errors:
*
* {
* "INNER_ARRAY_ERROR_minlength": {
* isArrayError: true,
* originalKey: "minlength",
* entries: [
* {
* index: 0,
* errorData: {
* requiredLength: 5,
* actualLength: 4
* }
* },
* {
* index: 2,
* errorData: {
* requiredLength: 5,
* actualLength: 3
* }
* },
* ]
* },
* "minlength": {
* requiredLength: 5,
* actualLength: 3
* }
* }
*
* @param validator A standard Angular synchronous validator function.
*/
export function validateArrayElements(validator) {
return (control) => {
const values = control.value;
if (!Array.isArray(values)) {
return { valueNotArray: true };
}
const validationErrors = values.map(value => validator(new FormControl(value)));
const convertedErrors = generateArrayRelatedErrors(validationErrors);
return convertedErrors;
};
}
/**
* Async version of validateArrayElements.
*
* Note that Angular by design doesn't execute async validators if synchronous validators returns any error.
* @param validator A standard Angular asynchronous validator function.
*/
export function asyncValidateArrayElements(validator) {
return (control) => {
const values = control.value;
if (!Array.isArray(values)) {
return of({ valueNotArray: true });
}
const observables = values.map(value => validator(new FormControl(value)));
return forkJoin(observables).pipe(map(errors => generateArrayRelatedErrors(errors)));
};
}
function generateArrayRelatedErrors(errors) {
const errorObject = {};
errors.forEach((error, index) => {
if (!error) {
return;
}
const errorKeys = Object.keys(error);
if (errorKeys.length) {
errorKeys.forEach(key => {
const prefixedKey = ARRAY_VALIDATION_PREFIX + key;
if (!errorObject[prefixedKey]) {
errorObject[prefixedKey] = { isArrayError: true, originalKey: key, entries: [] };
}
errorObject[prefixedKey].entries.push({ index, errorData: error[key] });
});
}
});
return Object.keys(errorObject).length ? errorObject : null;
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"validate-array-elements.js","sourceRoot":"","sources":["../../../../core/forms/validate-array-elements.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EAGZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAc,EAAE,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,MAAM,CAAC,MAAM,uBAAuB,GAAG,oBAAoB,CAAC;AAY5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,UAAU,qBAAqB,CAAC,SAAsB;IAC1D,OAAO,CAAC,OAAwB,EAA6C,EAAE;QAC7E,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;QACjC,CAAC;QACD,MAAM,gBAAgB,GAAuB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAC9D,SAAS,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,CAClC,CAAC;QACF,MAAM,eAAe,GAA0B,0BAA0B,CAAC,gBAAgB,CAAC,CAAC;QAC5F,OAAO,eAAe,CAAC;IACzB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,SAA2B;IACpE,OAAO,CAAC,OAAwB,EAAgC,EAAE;QAChE,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QACrC,CAAC;QACD,MAAM,WAAW,GAEb,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE3D,OAAO,QAAQ,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,MAAsC;IACxE,MAAM,WAAW,GAA0B,EAAE,CAAC;IAE9C,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrB,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,MAAM,WAAW,GAAG,uBAAuB,GAAG,GAAG,CAAC;gBAClD,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC9B,WAAW,CAAC,WAAW,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;gBACnF,CAAC;gBACD,WAAW,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC1E,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9D,CAAC","sourcesContent":["import {\n  AbstractControl,\n  AsyncValidatorFn,\n  FormControl,\n  ValidationErrors,\n  ValidatorFn\n} from '@angular/forms';\nimport { forkJoin, Observable, of } from 'rxjs';\nimport { map } from 'rxjs/operators';\n\nexport const ARRAY_VALIDATION_PREFIX = 'INNER_ARRAY_ERROR_';\n\nexport type ArrayValidationErrors = {\n  [key: string]: ArrayValidationErrorValue;\n};\n\nexport type ArrayValidationErrorValue = {\n  isArrayError: true;\n  originalKey: string;\n  entries: Array<{ index: number; errorData: unknown }>;\n};\n\n/**\n * This method can alter how validators work. It can be used in cases where there is need to validate FormControl\n * that as value, takes array of elements. This allows to reuse validators, that works for such elements.\n * For example if  Validators.minLength(3) is used on control that takes string as value, validator will return error\n * if string is less than 3 characters. If same is done on array of strings, validator will return error if array\n * has less than 3 elements.\n *\n * validateArrayElements(Validators.minLength(3)) method makes it possible to check every member of array if it has minimum 3 characters.\n * If there are elements that raise error, it will be possible to extract these errors using item index.\n *\n * As a example, this can be used for custom form elements, which manipulates array of elements,\n * and there is need to display corresponding error messages for every array member that is displayed, while still using\n * Angular's Validation approach.\n *\n * Errors that are generated by this helper are prefixed with 'INNER_ARRAY_ERROR_'. Reason for this is to prevent overwriting normal validation\n * errors that could have same key\n *\n * @Example\n *\n * let control = new FormControl(['1234', '123456', '123', [Validators.minLength(5), validateArrayElements(Validators.minLength(5))] ])\n *\n * this FormControl has validation errors:\n *\n * {\n *   \"INNER_ARRAY_ERROR_minlength\": {\n *      isArrayError: true,\n *      originalKey: \"minlength\",\n *      entries: [\n *        {\n *          index: 0,\n *          errorData: {\n *            requiredLength: 5,\n *            actualLength: 4\n *          }\n *        },\n *        {\n *          index: 2,\n *          errorData: {\n *            requiredLength: 5,\n *            actualLength: 3\n *          }\n *        },\n *      ]\n *    },\n *   \"minlength\": {\n *     requiredLength: 5,\n *     actualLength: 3\n *   }\n * }\n *\n * @param validator A standard Angular synchronous validator function.\n */\nexport function validateArrayElements(validator: ValidatorFn): ValidatorFn {\n  return (control: AbstractControl): { valueNotArray } | ArrayValidationErrors => {\n    const values = control.value;\n    if (!Array.isArray(values)) {\n      return { valueNotArray: true };\n    }\n    const validationErrors: ValidationErrors[] = values.map(value =>\n      validator(new FormControl(value))\n    );\n    const convertedErrors: ArrayValidationErrors = generateArrayRelatedErrors(validationErrors);\n    return convertedErrors;\n  };\n}\n\n/**\n * Async version of validateArrayElements.\n *\n * Note that Angular by design doesn't execute async validators if synchronous validators returns any error.\n * @param validator A standard Angular asynchronous validator function.\n */\nexport function asyncValidateArrayElements(validator: AsyncValidatorFn): AsyncValidatorFn {\n  return (control: AbstractControl): Observable<ValidationErrors> => {\n    const values = control.value;\n    if (!Array.isArray(values)) {\n      return of({ valueNotArray: true });\n    }\n    const observables: Array<\n      Promise<ValidationErrors | null> | Observable<ValidationErrors | null>\n    > = values.map(value => validator(new FormControl(value)));\n\n    return forkJoin(observables).pipe(map(errors => generateArrayRelatedErrors(errors)));\n  };\n}\n\nfunction generateArrayRelatedErrors(errors: Array<ValidationErrors | null>): ArrayValidationErrors {\n  const errorObject: ArrayValidationErrors = {};\n\n  errors.forEach((error, index) => {\n    if (!error) {\n      return;\n    }\n    const errorKeys = Object.keys(error);\n    if (errorKeys.length) {\n      errorKeys.forEach(key => {\n        const prefixedKey = ARRAY_VALIDATION_PREFIX + key;\n        if (!errorObject[prefixedKey]) {\n          errorObject[prefixedKey] = { isArrayError: true, originalKey: key, entries: [] };\n        }\n        errorObject[prefixedKey].entries.push({ index, errorData: error[key] });\n      });\n    }\n  });\n  return Object.keys(errorObject).length ? errorObject : null;\n}\n"]}