mongoose-common-plugin

Common plugin for Mongoose with standard schema fields and localization support

Table of Contents

• Install
• Usage
• Options
• Localized Error Messages
• Contributors
• License

Install

npm:

1npm install mongoose-common-plugin

Usage

1const mongooseCommonPlugin = require('mongoose-common-plugin');
2const mongoose = require('mongoose');
3
4const User = new mongoose.Schema({});
5
6User.plugin(mongooseCommonPlugin, { object: 'user' });
7
8module.exports = mongoose.model('User', User);

Options

Default options shown below:

1{
2  // *REQUIRED*
3  // this should be the name of the model lower-cased (e.g. User)
4  // inspired by Stripe's API design (e.g. `"object": "charge"`)
5  object: '',
6
7  // whether or not your fields/database design is camelCased
8  camelCase: false,
9
10  // whether or not to add virtual getter/setter localization support
11  // (super useful for adding Mongoose validation errors that are localized)
12  locale: true,
13
14  // default locale used (e.g. you could use `i18n.defaultLocale()` if using @ladjs/i18n)
15  defaultLocale: 'en',
16
17  // whether or not to use `mongoose-omit-common-fields`
18  omitCommonFields: true,
19
20  // either an Array or Object
21  // these will get added to `mongoose-hidden`
22  // and are extra fields you'd like to ignore from toJSON calls
23  // (e.g. `omitExtraFields: [ 'some_field_to_ignore' ]`)
24  // note that we automatically add the `-` prefix to keys for Arrays passed
25  omitExtraFields: [],
26
27  // options to pass to `mongoose-unique-validator`
28  uniqueValidator: {
29    message: require('@ladjs/mongoose-error-messages').general.unique
30  },
31
32  // options to pass to `mongoose-validation-error-transform`
33  // <https://github.com/niftylettuce/mongoose-validation-error-transform>
34  validationErrorTransform: {},
35
36  // options to pass to `mongoose-hidden`
37  // <https://github.com/mblarsen/mongoose-hidden>
38  mongooseHidden: {}
39}

Localized Error Messages

By default the options.locale value is true. Therefore you can add localized error messages using i18n.

User model definition:

1const i18n = require('i18n');
2const mongoose = require('mongoose');
3const validator = require('validator');
4
5const User = new mongoose.Schema({
6  email: {
7    type: String,
8    required: true,
9    index: true,
10    validate: (val, fn) => {
11      if (validator.isEmail(val))
12        return fn();
13      fn(false, i18n.__({
14        phrase: 'Invalid email address',
15        locale: this.locale
16      });
17    }
18  }
19});

Route middleware (assumes you're using something like @ladjs/i18n):

1try {
2  user.locale = ctx.request.locale;
3  await user.validate();
4} catch (err) {
5  // will throw localized validation error message for `user.email`
6  return ctx.throw(Boom.badRequest(err));
7}

Contributors

Name	Website
Nick Baugh	http://niftylettuce.com/

License

MIT © Nick Baugh