feat: allow to use a reporter with a custom formatter, and also pass it to the schema options

Author: emyann

src/MorphismTree.ts

@@ -13,7 +13,7 @@ import {
   SCHEMA_OPTIONS_SYMBOL,
   isEmptyObject
 } from './helpers';
-import { ValidationError, ERRORS, targetHasErrors, ValidationErrors, reporter } from './validation/reporter';
+import { ValidationError, ERRORS, targetHasErrors, ValidationErrors, reporter, Reporter } from './validation/reporter';
 import { ValidatorError } from './validation/validators/ValidatorError';
 
 export enum NodeKind {
@@ -94,6 +94,12 @@ export interface SchemaOptions<Target = any> {
      * @type {boolean}
      */
     throw: boolean;
+    /**
+     * Custom reporter to use when throw option is set to true
+     * @default false
+     * @type {boolean}
+     */
+    reporter?: Reporter;
   };
 }
 
@@ -258,7 +264,11 @@ export class MorphismSchemaTree<Target, Source> {
               if (targetHasErrors(objectToCompute)) {
                 objectToCompute[ERRORS].addError(validationError);
               } else {
-                objectToCompute[ERRORS] = new ValidationErrors(reporter, objectToCompute);
+                if (this.schemaOptions.validation && this.schemaOptions.validation.reporter) {
+                  objectToCompute[ERRORS] = new ValidationErrors(this.schemaOptions.validation.reporter, objectToCompute);
+                } else {
+                  objectToCompute[ERRORS] = new ValidationErrors(reporter, objectToCompute);
+                }
                 objectToCompute[ERRORS].addError(validationError);
               }
             } else {

src/morphism.ts

@@ -6,7 +6,7 @@ import { Schema, StrictSchema, Constructable, SourceFromSchema, Mapper, Destinat
 import { MorphismSchemaTree, createSchema, SchemaOptions } from './MorphismTree';
 import { MorphismRegistry, IMorphismRegistry } from './MorphismRegistry';
 import { decorator } from './MorphismDecorator';
-import { Reporter, reporter, Formatter, targetHasErrors } from './validation/reporter';
+import { Reporter, reporter as defaultReporter, Formatter, targetHasErrors, ValidationErrors } from './validation/reporter';
 
 /**
  * Low Level transformer function.
@@ -68,7 +68,13 @@ function transformValuesFromObject<Source, Target>(
 function checkIfValidationShouldThrow<Target>(options: SchemaOptions<Target>, finalObject: Target) {
   if (options && options.validation && options.validation.throw) {
     if (targetHasErrors(finalObject)) {
-      const errors = reporter.extractErrors(finalObject);
+      let errors: ValidationErrors | null;
+      if (options.validation.reporter) {
+        const reporter = options.validation.reporter;
+        errors = reporter.extractErrors(finalObject);
+      } else {
+        errors = defaultReporter.extractErrors(finalObject);
+      }
       if (errors) {
         throw errors;
       }
@@ -230,5 +236,16 @@ morphismMixin.mappers = morphismRegistry.mappers;
 
 const Morphism: typeof morphism & IMorphismRegistry = morphismMixin;
 
-export { morphism, createSchema, Schema, StrictSchema, SchemaOptions, Mapper, SCHEMA_OPTIONS_SYMBOL, Reporter, reporter, Formatter };
+export {
+  morphism,
+  createSchema,
+  Schema,
+  StrictSchema,
+  SchemaOptions,
+  Mapper,
+  SCHEMA_OPTIONS_SYMBOL,
+  Reporter,
+  defaultReporter as reporter,
+  Formatter
+};
 export default Morphism;

src/validation/reporter.spec.ts

@@ -1,5 +1,5 @@
-import { morphism, createSchema } from '../morphism';
-import { defaultFormatter, reporter, ValidationError } from './reporter';
+import { morphism, createSchema, Reporter } from '../morphism';
+import { defaultFormatter, reporter, ValidationError, Formatter } from './reporter';
 import { Validation } from './Validation';
 
 describe('Reporter', () => {
@@ -50,6 +50,49 @@ describe('Reporter', () => {
       }).toThrow('Rule max has already been used');
     });
 
+    it('should allow to use a reporter with a custom formatter', () => {
+      interface Target {
+        t1: string;
+      }
+      const formatter: Formatter = error => {
+        const { expect, targetProperty, value } = error;
+        return `Expected ${expect} but received ${value} for property ${targetProperty}`;
+      };
+      const reporter = new Reporter(formatter);
+
+      const schema = createSchema<Target>({ t1: { path: 's1', validation: Validation.string() } });
+      const result = morphism(schema, { s1: 1234 });
+      const error = new ValidationError({ targetProperty: 't1', value: 1234, expect: 'value to be typeof string' });
+      const message = formatter(error);
+      const errors = reporter.report(result);
+      expect(errors).not.toBeNull();
+      if (errors) {
+        expect(errors[0]).toBe(message);
+      }
+    });
+
+    it('should allow to use a reporter with a custom formatter via schema options', () => {
+      interface Target {
+        t1: string;
+      }
+      const formatter: Formatter = error => {
+        const { expect, targetProperty, value } = error;
+        return `Expected ${expect} but received ${value} for property ${targetProperty}`;
+      };
+      const reporter = new Reporter(formatter);
+
+      const schema = createSchema<Target>(
+        { t1: { path: 's1', validation: Validation.string() } },
+        { validation: { throw: true, reporter } }
+      );
+
+      const error = new ValidationError({ targetProperty: 't1', value: 1234, expect: 'value to be typeof string' });
+      const message = formatter(error);
+      expect(() => {
+        morphism(schema, { s1: 1234 });
+      }).toThrow(message);
+    });
+
     describe('string', () => {
       it('should report error on string undefined', () => {
         interface S {