init

Author: AnechaS

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

.gitignore

@@ -0,0 +1,2 @@
+globalConfig.json
+node_modules

README.md

@@ -0,0 +1,16 @@
+# Mongoose Validation Failed Handler
+
+## Usage
+
+```javascripts
+const mongooseErrorHandler = require('mongoose-validation-error-message-handler');
+
+const error = mongooseErrorHandler(mongoose.Error.ValidationError, {
+    messages: {
+      [kind]: String
+    },
+    paths: {
+      [path]: Object
+    }
+});
+```

jest-mongodb-config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  mongodbMemoryServerOptions: {
+    instance: {
+      dbName: 'jest',
+      port: 27001,
+    },
+    binary: {
+      version: '4.0.3',
+      skipMD5: true
+    },
+    autoStart: false
+  }
+};

lib/index.js

@@ -0,0 +1,49 @@
+const { defaultsDeep, lowerFirst, isObject, omit, isEmpty } = require('lodash');
+const format = require('string-template');
+const messages = require('./messages');
+const { transformsError, errorx } = require('./utils');
+
+function mongooseErrorHandler(error, options) {
+  options = defaultsDeep(options, {
+    capitalize: false,
+    humanize: false,
+    messages: messages,
+    paths: {},
+  });
+
+  if (error.name === 'ValidationError') {
+    const attr = Object.keys(error.errors).shift();
+    const err = error.errors[attr];
+    const { path, kind, value, properties, stringValue } = transformsError(err);
+    const ex = errorx({ path, kind, value });
+    const agrs = {
+      path,
+      value: stringValue,
+      ...properties,
+    };
+
+    if (!isEmpty(options.paths) && options.paths[path]) {
+      const po = options.paths[path];
+      if (
+        po.original === true &&
+        (isEmpty(po.kind) || (po.kind && po.kind === kind))
+      ) {
+        return ex(err.message);
+      }
+
+      if (po.message && (isEmpty(po.kind) || (po.kind && po.kind === kind))) {
+        return ex(format(po.message, agrs));
+      }
+    }
+
+    if (options.messages[kind]) {
+      return ex(format(options.messages[kind], agrs));
+    }
+
+    return ex(format(options.messages.base, agrs));
+  }
+
+  return error;
+}
+
+module.exports = mongooseErrorHandler;

lib/messages.js

@@ -0,0 +1,23 @@
+module.exports = {
+  base: '{path} is invalid',
+  required: '{path} is required',
+  enum: '{path} is invalid',
+
+  string: '{path} must be a string',
+  maxlength: '{path} length must be less than or equal to {maxlength} characters long',
+  minlength: '{path} length must be at least {minlength} characters long',
+  regexp: '{path} format is invalid',
+
+  number: '{path} must be a number',
+  'number.max': '{path} must be greater than or equal to {max}',
+  'number.min': '{path} must be less than or equal to {{#limit}}',
+
+  date: '{path} must be a date',
+  'date.max': '{path} must be less than or equal to {max}',
+  'date.min': '{path} must be greater than or equal to {min}',
+
+  buffer: '{path} must be a buffer',
+  boolean: '{path} must be a boolean',
+  objectId: '{path} must be a objectId',
+  map: '{path} must be a map',
+};

lib/utils.js

@@ -0,0 +1,72 @@
+const { lowerFirst, omit, pickBy, isUndefined } = require('lodash');
+
+/**
+ * Get mongoose validator error data.
+ * @param {Error} error
+ * @return {Object}
+ */
+exports.transformsError = function (error) {
+  const o = {};
+  o.path = error.path;
+  o.value = error.value;
+  o.stringValue = error.stringValue;
+  o.message = error.message;
+
+  if (error.kind) {
+    o.kind = lowerFirst(error.kind);
+  }
+  
+  if (typeof error.properties !== 'undefined') {
+    o.properties = omit(error.properties, [
+      'validator',
+      'message',
+      'type',
+      'path',
+      'value',
+    ]);
+
+    switch (o.kind) {
+      case 'max': {
+        if (typeof o.properties['max'] === 'number') {
+          o.kind = 'number.max';
+        } else {
+          o.kind = 'date.max';
+        }
+        break;
+      }
+      case 'min': {
+        if (typeof o.properties['min'] === 'number') {
+          o.kind = 'number.min';
+        } else {
+          o.kind = 'date.min';
+        }
+        break;
+      }
+      default: {
+        break;
+      }
+    }
+  }
+
+  return pickBy(o, (o) => typeof o !== 'undefined');
+};
+
+/**
+ * Mongoose validator error
+ *
+ * @param {Object} attributes Error attributes
+ * @return {Error}
+ *
+ * @example
+ * error({ message, path, kind, value });
+ */
+exports.errorx = function ({ path, kind, value }) {
+  return function (message) {
+    let error = new Error(message);
+    error.name = 'MongooseValidatorError';
+    error.path = path;
+    error.kind = kind;
+    error.value = value;
+    return error;
+  };
+};