mongoose-lockdown
Install via npm:
npm install --save mongoose-lockdown
What Does it Do?
This module is a Mongoose plugin that sets a limit on how many times a field can be saved. Additionally, it allows for a reset time period, after which the field may be saved again.
Usage
Require the plugin like so:
var lockdown = require('mongoose-lockdown');
Then attach it to a schema declaration with .plugin(lockdown).
In your schema, indicate which fields should be locked down by giving the fields a lockdown: maxNumberOfSaves option:
username: {
type: String,
lockdown: 3
}
Using lockdown: true defaults to a 1 save maximum. When a document is first created and a field is declared, this counts as the first save on that field. In other words, the default lockdown: 1 will prevent any further changes to a field after that field is added to a document.
Resets
If you want to prevent changes over a period of time, but allow changes after that time period expires, add a lockdownReset option to your locked field:
username: {
type: String,
lockdown: true,
lockdownReset: {
length: 12,
period: 'hours'
}
}
In the above, username cannot be changed in a given document for a period of 12 hours. You can use milliseconds, seconds, minutes, hours, days, months, and years.
Examples
Example with Max Save and Reset
var UserSchema = new Schema({
name: String,
username: {
type: String,
lockdown: true
},
email: {
type: String,
lockdown: 3,
lockdownReset: {
length: 30,
period: 'days'
}
}
}).plugin(lockdown);
var User = mongoose.model('User', UserSchema);
var user = new User({
name: 'Colin',
username: 'bombsheltersoftware',
email: 'colin@bombsheltersoftware.com'
});
user.save(function(err) {
// this will create the document, so no validation error should occur
user.username = 'thebomb';
user.save(function(err) {
// this should return a validation err, since username is locked down
});
});
In this example, as soon as user is first created, both username and email have been saved once. Since the max saves on username is 1, lockdown will prevent any further changes to that field. If we attempt to change the email multiple times, the changes will go through until the number of saves reaches 3. If we wait until 30 days after the most recent save, the lockdown will reset, and saves will go through again. The reset will re-initialize the field so that, again, only 3 saves can be performed before another reset is needed.
Custom Error Messages
A locked field will cause the save to fail, and we send back a Mongoose error which looks like this:
Error: FIELDNAME has been locked.
If you want to send your users something more appropriate, like a less terrible, non present perfect voice, you can declare a custom message on the lockdown fields:
username: {
type: String,
lockdown: true,
lockdownMessage: 'You cannot change your username at this time.'
}
Future Development
This plugin currently only works for Mongoose save(), which is not triggered during queries such as update() and findOneAndUpdate(). Mongoose 4.0 added distinct hooks for these queries, so we hope to add support for locking those types of updates shortly.
Version History
- 0.1.2 Supports paths with
.in them. #2 - 0.1.1 Supports custom error messages, like it should have to begin with.
- 0.1.0 Initial release.