node-server-engine 2.2.0 → 2.3.0

package/README.md

@@ -238,6 +238,8 @@ The main function of the endpoint is called the **handler**. This function shoul
 
 An endpoint usually has a **validator**. A validator is a schema that will be compared to the incoming request. The request will be denied if it contains illegal or malformed arguments. For more detail see the documentation of the underlying package [express-validator](https://express-validator.github.io/docs/schema-validation.html).
 
+A request that fails validation is answered `400` with `errorCode: 'invalid-request'` and `details`, one entry per failed field: `{ field, location, message }` (the submitted values are not echoed back).
+
 ```javascript
 import { Endpoint, EndpointMethod } from 'node-server-engine';
 

package/dist/entities/ValidationError/ValidationError.js

@@ -29,13 +29,22 @@ let ValidationError = exports.ValidationError = /*#__PURE__*/function (_WebError
       ...hint,
       [error.type]: error.msg
     }), {});
+    // Which fields failed and why, so a client can point at them. The submitted values are left out.
+    const details = errors.map(error => error.type === 'field' ? {
+      field: error.path,
+      location: error.location,
+      message: error.msg
+    } : {
+      message: error.msg
+    });
     return _callSuper(this, ValidationError, [{
       message: 'Request did not pass validation',
       errorCode: 'invalid-request',
       statusCode: 400,
       severity: _const.LogSeverity.WARNING,
       data: hint,
-      hint
+      hint,
+      details
     }]);
   }
   (0, _inherits2.default)(ValidationError, _WebError);

package/dist/entities/ValidationError/ValidationError.js.map

@@ -1 +1 @@
-{"version":3,"file":"ValidationError.js","names":["_const","require","_EngineError","_WebError2","_callSuper","t","o","e","_getPrototypeOf2","default","_possibleConstructorReturn2","_isNativeReflectConstruct","Reflect","construct","constructor","apply","Boolean","prototype","valueOf","call","ValidationError","exports","_WebError","validationResult","_classCallCheck2","isEmpty","EngineError","message","errors","array","hint","reduce","error","type","msg","errorCode","statusCode","severity","LogSeverity","WARNING","data","_inherits2","_createClass2","WebError"],"sources":["../../../src/entities/ValidationError/ValidationError.ts"],"sourcesContent":["import {\n  ValidationError as ExpressValidationError,\n  Result\n} from 'express-validator';\nimport { LogSeverity } from 'const';\nimport { EngineError } from 'entities/EngineError';\nimport { WebError } from 'entities/WebError';\n\n/** Error class for request/message validation errors */\nexport class ValidationError extends WebError {\n  /** Create an ValidationError this represents errors in parsing incoming messages/requests */\n  public constructor(validationResult: Result<ExpressValidationError>) {\n    if (validationResult.isEmpty())\n      throw new EngineError({\n        message:\n          'Attempted to create a validation error while validation was successful'\n      });\n\n    const errors = validationResult.array();\n    // Hint that is sent to the client as logged as data\n    const hint = errors.reduce(\n      (hint, error) => ({ ...hint, [error.type]: error.msg as string }),\n      {}\n    );\n    super({\n      message: 'Request did not pass validation',\n      errorCode: 'invalid-request',\n      statusCode: 400,\n      severity: LogSeverity.WARNING,\n      data: hint,\n      hint\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAIA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AAA6C,SAAAG,WAAAC,CAAA,EAAAC,CAAA,EAAAC,CAAA,WAAAD,CAAA,OAAAE,gBAAA,CAAAC,OAAA,EAAAH,CAAA,OAAAI,2BAAA,CAAAD,OAAA,EAAAJ,CAAA,EAAAM,yBAAA,KAAAC,OAAA,CAAAC,SAAA,CAAAP,CAAA,EAAAC,CAAA,YAAAC,gBAAA,CAAAC,OAAA,EAAAJ,CAAA,EAAAS,WAAA,IAAAR,CAAA,CAAAS,KAAA,CAAAV,CAAA,EAAAE,CAAA;AAAA,SAAAI,0BAAA,cAAAN,CAAA,IAAAW,OAAA,CAAAC,SAAA,CAAAC,OAAA,CAAAC,IAAA,CAAAP,OAAA,CAAAC,SAAA,CAAAG,OAAA,iCAAAX,CAAA,aAAAM,yBAAA,YAAAA,CAAA,aAAAN,CAAA;AAE7C;AAAA,IACae,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAAE,SAAA;EAC1B;EACA,SAAAF,gBAAmBG,gBAAgD,EAAE;IAAA,IAAAC,gBAAA,CAAAf,OAAA,QAAAW,eAAA;IACnE,IAAIG,gBAAgB,CAACE,OAAO,CAAC,CAAC,EAC5B,MAAM,IAAIC,wBAAW,CAAC;MACpBC,OAAO,EACL;IACJ,CAAC,CAAC;IAEJ,MAAMC,MAAM,GAAGL,gBAAgB,CAACM,KAAK,CAAC,CAAC;IACvC;IACA,MAAMC,IAAI,GAAGF,MAAM,CAACG,MAAM,CACxB,CAACD,IAAI,EAAEE,KAAK,MAAM;MAAE,GAAGF,IAAI;MAAE,CAACE,KAAK,CAACC,IAAI,GAAGD,KAAK,CAACE;IAAc,CAAC,CAAC,EACjE,CAAC,CACH,CAAC;IAAC,OAAA9B,UAAA,OAAAgB,eAAA,GACI;MACJO,OAAO,EAAE,iCAAiC;MAC1CQ,SAAS,EAAE,iBAAiB;MAC5BC,UAAU,EAAE,GAAG;MACfC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;MAC7BC,IAAI,EAAEV,IAAI;MACVA;IACF,CAAC;EACH;EAAC,IAAAW,UAAA,CAAAhC,OAAA,EAAAW,eAAA,EAAAE,SAAA;EAAA,WAAAoB,aAAA,CAAAjC,OAAA,EAAAW,eAAA;AAAA,EAvBkCuB,mBAAQ","ignoreList":[]}
+{"version":3,"file":"ValidationError.js","names":["_const","require","_EngineError","_WebError2","_callSuper","t","o","e","_getPrototypeOf2","default","_possibleConstructorReturn2","_isNativeReflectConstruct","Reflect","construct","constructor","apply","Boolean","prototype","valueOf","call","ValidationError","exports","_WebError","validationResult","_classCallCheck2","isEmpty","EngineError","message","errors","array","hint","reduce","error","type","msg","details","map","field","path","location","errorCode","statusCode","severity","LogSeverity","WARNING","data","_inherits2","_createClass2","WebError"],"sources":["../../../src/entities/ValidationError/ValidationError.ts"],"sourcesContent":["import {\n  ValidationError as ExpressValidationError,\n  Result\n} from 'express-validator';\nimport { LogSeverity } from 'const';\nimport { EngineError } from 'entities/EngineError';\nimport { WebError } from 'entities/WebError';\n\n/** Error class for request/message validation errors */\nexport class ValidationError extends WebError {\n  /** Create an ValidationError this represents errors in parsing incoming messages/requests */\n  public constructor(validationResult: Result<ExpressValidationError>) {\n    if (validationResult.isEmpty())\n      throw new EngineError({\n        message:\n          'Attempted to create a validation error while validation was successful'\n      });\n\n    const errors = validationResult.array();\n    // Hint that is sent to the client as logged as data\n    const hint = errors.reduce(\n      (hint, error) => ({ ...hint, [error.type]: error.msg as string }),\n      {}\n    );\n    // Which fields failed and why, so a client can point at them. The submitted values are left out.\n    const details = errors.map((error) =>\n      error.type === 'field'\n        ? {\n            field: error.path,\n            location: error.location,\n            message: error.msg as string\n          }\n        : { message: error.msg as string }\n    );\n    super({\n      message: 'Request did not pass validation',\n      errorCode: 'invalid-request',\n      statusCode: 400,\n      severity: LogSeverity.WARNING,\n      data: hint,\n      hint,\n      details\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAIA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AAA6C,SAAAG,WAAAC,CAAA,EAAAC,CAAA,EAAAC,CAAA,WAAAD,CAAA,OAAAE,gBAAA,CAAAC,OAAA,EAAAH,CAAA,OAAAI,2BAAA,CAAAD,OAAA,EAAAJ,CAAA,EAAAM,yBAAA,KAAAC,OAAA,CAAAC,SAAA,CAAAP,CAAA,EAAAC,CAAA,YAAAC,gBAAA,CAAAC,OAAA,EAAAJ,CAAA,EAAAS,WAAA,IAAAR,CAAA,CAAAS,KAAA,CAAAV,CAAA,EAAAE,CAAA;AAAA,SAAAI,0BAAA,cAAAN,CAAA,IAAAW,OAAA,CAAAC,SAAA,CAAAC,OAAA,CAAAC,IAAA,CAAAP,OAAA,CAAAC,SAAA,CAAAG,OAAA,iCAAAX,CAAA,aAAAM,yBAAA,YAAAA,CAAA,aAAAN,CAAA;AAE7C;AAAA,IACae,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAAE,SAAA;EAC1B;EACA,SAAAF,gBAAmBG,gBAAgD,EAAE;IAAA,IAAAC,gBAAA,CAAAf,OAAA,QAAAW,eAAA;IACnE,IAAIG,gBAAgB,CAACE,OAAO,CAAC,CAAC,EAC5B,MAAM,IAAIC,wBAAW,CAAC;MACpBC,OAAO,EACL;IACJ,CAAC,CAAC;IAEJ,MAAMC,MAAM,GAAGL,gBAAgB,CAACM,KAAK,CAAC,CAAC;IACvC;IACA,MAAMC,IAAI,GAAGF,MAAM,CAACG,MAAM,CACxB,CAACD,IAAI,EAAEE,KAAK,MAAM;MAAE,GAAGF,IAAI;MAAE,CAACE,KAAK,CAACC,IAAI,GAAGD,KAAK,CAACE;IAAc,CAAC,CAAC,EACjE,CAAC,CACH,CAAC;IACD;IACA,MAAMC,OAAO,GAAGP,MAAM,CAACQ,GAAG,CAAEJ,KAAK,IAC/BA,KAAK,CAACC,IAAI,KAAK,OAAO,GAClB;MACEI,KAAK,EAAEL,KAAK,CAACM,IAAI;MACjBC,QAAQ,EAAEP,KAAK,CAACO,QAAQ;MACxBZ,OAAO,EAAEK,KAAK,CAACE;IACjB,CAAC,GACD;MAAEP,OAAO,EAAEK,KAAK,CAACE;IAAc,CACrC,CAAC;IAAC,OAAA9B,UAAA,OAAAgB,eAAA,GACI;MACJO,OAAO,EAAE,iCAAiC;MAC1Ca,SAAS,EAAE,iBAAiB;MAC5BC,UAAU,EAAE,GAAG;MACfC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;MAC7BC,IAAI,EAAEf,IAAI;MACVA,IAAI;MACJK;IACF,CAAC;EACH;EAAC,IAAAW,UAAA,CAAArC,OAAA,EAAAW,eAAA,EAAAE,SAAA;EAAA,WAAAyB,aAAA,CAAAtC,OAAA,EAAAW,eAAA;AAAA,EAlCkC4B,mBAAQ","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-server-engine",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Framework used to develop backend services. This package ships with a lot of features to standardize the creation of services, letting you focus on the business logic.",
   "main": "dist/index.js",
   "scripts": {