mirror of
https://github.com/HabitRPG/habitica.git
synced 2025-12-16 06:07:21 +01:00
Deprecate API v2 (was Revert "Revert "Deprecate API v2"") (#7802)
* Revert "Revert "Deprecate API v2"" * fix path in shops controller
This commit is contained in:
79
website/server/libs/baseModel.js
Normal file
79
website/server/libs/baseModel.js
Normal file
@@ -0,0 +1,79 @@
|
||||
import { v4 as uuid } from 'uuid';
|
||||
import validator from 'validator';
|
||||
import objectPath from 'object-path'; // TODO use lodash's unset once v4 is out
|
||||
import _ from 'lodash';
|
||||
|
||||
module.exports = function baseModel (schema, options = {}) {
|
||||
if (options._id !== false) {
|
||||
schema.add({
|
||||
_id: {
|
||||
type: String,
|
||||
default: uuid,
|
||||
validate: [validator.isUUID, 'Invalid uuid.'],
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
if (options.timestamps) {
|
||||
schema.add({
|
||||
createdAt: {
|
||||
type: Date,
|
||||
default: Date.now,
|
||||
},
|
||||
updatedAt: {
|
||||
type: Date,
|
||||
default: Date.now,
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
if (options.timestamps) {
|
||||
schema.pre('save', function updateUpdatedAt (next) {
|
||||
if (!this.isNew) this.updatedAt = Date.now();
|
||||
next();
|
||||
});
|
||||
|
||||
schema.pre('update', function preUpdateModel () {
|
||||
this.update({}, { $set: { updatedAt: new Date() } });
|
||||
});
|
||||
}
|
||||
|
||||
let noSetFields = ['createdAt', 'updatedAt'];
|
||||
let privateFields = ['__v'];
|
||||
|
||||
if (Array.isArray(options.noSet)) noSetFields.push(...options.noSet);
|
||||
// This method accepts an additional array of fields to be sanitized that can be passed at runtime
|
||||
schema.statics.sanitize = function sanitize (objToSanitize = {}, additionalFields = []) {
|
||||
noSetFields.concat(additionalFields).forEach((fieldPath) => {
|
||||
objectPath.del(objToSanitize, fieldPath);
|
||||
});
|
||||
|
||||
// Allow a sanitize transform function to be used
|
||||
return options.sanitizeTransform ? options.sanitizeTransform(objToSanitize) : objToSanitize;
|
||||
};
|
||||
|
||||
if (Array.isArray(options.private)) privateFields.push(...options.private);
|
||||
|
||||
if (!schema.options.toJSON) schema.options.toJSON = {};
|
||||
schema.options.toJSON.transform = function transformToObject (doc, plainObj) {
|
||||
privateFields.forEach((fieldPath) => {
|
||||
objectPath.del(plainObj, fieldPath);
|
||||
});
|
||||
|
||||
// Always return `id`
|
||||
if (!plainObj.id && plainObj._id) plainObj.id = plainObj._id;
|
||||
|
||||
// Allow an additional toJSON transform function to be used
|
||||
return options.toJSONTransform ? options.toJSONTransform(plainObj, doc) : plainObj;
|
||||
};
|
||||
|
||||
schema.statics.getModelPaths = function getModelPaths () {
|
||||
return _.reduce(this.schema.paths, (result, field, path) => {
|
||||
if (privateFields.indexOf(path) === -1) {
|
||||
result[path] = field.instance || 'Boolean';
|
||||
}
|
||||
|
||||
return result;
|
||||
}, {});
|
||||
};
|
||||
};
|
||||
Reference in New Issue
Block a user