@dhyasama/totem-models 7.57.0 → 8.0.0

package/lib/List.js

@@ -2,15 +2,14 @@
 
 module.exports = function(mongoose, config) {
 
-  var
+  let
 
     Schema = mongoose.Schema,
     env = process.env.NODE_ENV || 'development',
     utils = require('@dhyasama/ffvc-utilities'),
-    _ = require('underscore'),
-    postFind = require('mongoose-post-find');
+    _ = require('underscore');
 
-  var List = new Schema({
+  let List = new Schema({
 
     customer: { type: Schema.ObjectId, ref: 'Organization', index: true, required: true },
 
@@ -32,26 +31,6 @@ module.exports = function(mongoose, config) {
 
   });
 
-  var cleanDoc = function cleanDoc(doc) {
-
-    var dedupeArray = function dedupeArray(arr) {
-      return _.uniq(arr, function(item) {
-        return (utils.isValidObjectId(item) ? item : item._id).toString();
-      });
-    };
-
-    // enforce unique items in arrays
-    doc.limitedPartners = dedupeArray(doc.limitedPartners);
-    doc.organizations = dedupeArray(doc.organizations);
-    doc.people = dedupeArray(doc.people);
-
-    // remove falsy values
-    doc.limitedPartners = _.compact(doc.limitedPartners);
-    doc.organizations = _.compact(doc.organizations);
-    doc.people = _.compact(doc.people);
-
-  };
-
   // Items are kept separate to facilitate population
   // This is a convenience function to get the full list of items
   List.virtual('items').get(function () {
@@ -83,17 +62,28 @@ module.exports = function(mongoose, config) {
 
   });
 
-  List.statics.addItem = function(listId, itemId, collection, cb) {
+  List.statics.addItem = function(listId, itemId, collection, options, cb) {
 
-    var self = this;
+    if (!cb) { throw new Error('cb is required'); }
+    if (!listId) { return cb(new Error('listId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(listId)) { return cb(new Error('listId is not a valid ObjectId'), null); }
+    if (!itemId) { return cb(new Error('itemId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(itemId)) { return cb(new Error('itemId is not a valid ObjectId'), null); }
+    if (!collection) { return cb(new Error('collection is required'), null); }
+    if (!options) { return cb(new Error('options is required'), null); }
+    if (!options.CUSTOMER_ID) { return cb(new Error('options.CUSTOMER_ID is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { return cb(new Error('options.CUSTOMER_ID is not a valid ObjectId'), null); }
 
-    self.findOne({
+    const self = this;
+    let query = self.findOne({
       '_id': listId,
-      'customer': config.CUSTOMER_ID
-    }, function(err, result) {
+      'customer': options.CUSTOMER_ID
+    });
+
+    query.exec(function(err, result) {
 
-      if (err) return cb(err, null);
-      if (!result) return cb(null, null);
+      if (err) { return cb(err, null); }
+      if (!result) { return cb(null, null); }
 
       result[collection].push(itemId);
 
@@ -103,18 +93,20 @@ module.exports = function(mongoose, config) {
 
   };
 
-  List.statics.createList = function(name, items, creator, cb) {
+  List.statics.createList = function(name, items, creator, options, cb) {
 
-    var self = this;
-    var CUSTOMER_ID = config.CUSTOMER_ID;
+    if (!cb) { throw new Error('cb is required'); }
+    if (!name) { return cb(new Error('name is required'), null); }
+    if (!items) { return cb(new Error('items is required'), null); }
+    if (!creator) { return cb(new Error('creator is required'), null); }
+    if (!options) { return cb(new Error('options is required'), null); }
+    if (!options.CUSTOMER_ID) { return cb(new Error('options.CUSTOMER_ID is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { return cb(new Error('options.CUSTOMER_ID is not a valid ObjectId'), null); }
 
-    if (CUSTOMER_ID == 'GLOBAL_PROCESS') throw new Error('Cannot create lists in a global process');
-    if (!name) throw new Error('Name is required');
-    if (!items) items = {};
-    if (!cb) throw new Error('cb is required');
+    const self = this;
 
-    var list = new self();
-    list.customer = config.CUSTOMER_ID;
+    let list = new self();
+    list.customer = options.CUSTOMER_ID;
     list.name = name;
     list.createdOn = new Date();
     list.createdBy = creator;
@@ -129,83 +121,47 @@ module.exports = function(mongoose, config) {
 
   };
 
-  List.statics.getById = function (id, cb) {
-    this
-      .findOne({
-        '_id': id,
-        'customer': config.CUSTOMER_ID
-      })
-      .populate('createdBy', 'name avatarUrl')
-      .populate('limitedPartners', 'name logoUrl fundsInvested')
-      .populate('organizations', 'name logoUrl contact')
-      .populate('people', 'name title avatarUrl contact')
-      .exec(cb);
-  };
-
-  // Get all lists that contain an lp
-  List.statics.getByLP = function(lpId, cb) {
-
-    var self = this;
-
-    // DANGER
-    // Note this is not filtered by customer!
-    // It is used for merging which spans customers
-
-    self
-      .find({ limitedPartners: lpId })
-      .populate('limitedPartners', 'name logoUrl')
-      .populate('organizations', 'name logoUrl')
-      .populate('people', 'name title avatarUrl')
-      .exec(cb);
+  List.statics.getById = function (id, options, cb) {
 
-  };
+    if (!cb) { throw new Error('cb is required'); }
+    if (!id) { return cb(new Error('name is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(id)) { return cb(new Error('id is not a valid ObjectId'), null); }
+    if (!options) { return cb(new Error('options is required'), null); }
+    if (!options.CUSTOMER_ID) { return cb(new Error('options.CUSTOMER_ID is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { return cb(new Error('options.CUSTOMER_ID is not a valid ObjectId'), null); }
 
-  // Get all lists that contain an org
-  List.statics.getByOrg = function(orgId, cb) {
+    const self = this;
 
-    var self = this;
+    let query = self.findOne({
+        '_id': id,
+        'customer': options.CUSTOMER_ID
+      });
 
-    // DANGER
-    // Note this is not filtered by customer!
-    // It is used for merging which spans customers
+    query.populate('createdBy', 'name avatarUrl');
+    query.populate('limitedPartners', 'name logoUrl fundsInvested');
+    query.populate('organizations', 'name logoUrl contact');
+    query.populate('people', 'name title avatarUrl contact');
 
-    self
-      .find({ organizations: orgId })
-      .populate('limitedPartners', 'name logoUrl')
-      .populate('organizations', 'name logoUrl')
-      .populate('people', 'name title avatarUrl')
-      .exec(cb);
+    query.exec(cb);
 
   };
 
-  // Get all lists that contain a person
-  List.statics.getByPerson = function(personId, cb) {
-
-    var self = this;
-
-    // DANGER
-    // Note this is not filtered by customer!
-    // It is used for merging which spans customers
+  List.statics.getLists = function(options, cb) {
 
-    self
-      .find({ people: personId })
-      .populate('limitedPartners', 'name logoUrl')
-      .populate('organizations', 'name logoUrl')
-      .populate('people', 'name title avatarUrl')
-      .exec(cb);
+    if (!cb) { throw new Error('cb is required'); }
+    if (!options) { return cb(new Error('options is required'), null); }
+    if (!options.CUSTOMER_ID) { return cb(new Error('options.CUSTOMER_ID is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { return cb(new Error('options.CUSTOMER_ID is not a valid ObjectId'), null); }
 
-  };
+    const self = this;
 
-  List.statics.getLists = function(cb) {
+    let query = self.find({ 'customer': options.CUSTOMER_ID });
 
-    var self = this;
+    query.populate('limitedPartners', 'name logoUrl');
+    query.populate('organizations', 'name logoUrl');
+    query.populate('people', 'name title avatarUrl');
 
-    self
-      .find({ 'customer': config.CUSTOMER_ID })
-      .populate('limitedPartners', 'name logoUrl')
-      .populate('organizations', 'name logoUrl')
-      .populate('people', 'name title avatarUrl')
-      .exec(cb);
+    query.exec(cb);
 
   };
 
@@ -218,9 +174,8 @@ module.exports = function(mongoose, config) {
     if (!id) { return cb(new Error('id is required'), null); }
     if (!update) { return cb(new Error('update is required'), null); }
 
-    var self = this;
+    let self = this;
 
-    // https://mongoosejs.com/docs/api.html#model_Model.findOneAndUpdate
     // options runValidators defaults false which is ok since we have upsert false
     // new returns the updated document
 
@@ -228,23 +183,44 @@ module.exports = function(mongoose, config) {
 
   };
 
-  List.statics.remove = function(id, cb) {
-    this.findOneAndRemove({
+  List.statics.remove = function(id, options, cb) {
+
+    if (!cb) { throw new Error('cb is required'); }
+    if (!id) { return cb(new Error('name is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(id)) { return cb(new Error('id is not a valid ObjectId'), null); }
+    if (!options) { return cb(new Error('options is required'), null); }
+    if (!options.CUSTOMER_ID) { return cb(new Error('options.CUSTOMER_ID is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { return cb(new Error('options.CUSTOMER_ID is not a valid ObjectId'), null); }
+
+    const self = this;
+
+    self.findOneAndRemove({
       '_id': id,
-      'customer': config.CUSTOMER_ID
+      'customer': options.CUSTOMER_ID
     }, cb);
+
   };
 
-  List.statics.removeItem = function(listId, itemId, collection, cb) {
+  List.statics.removeItem = function(listId, itemId, collection, options, cb) {
 
-    var self = this;
+    if (!cb) { throw new Error('cb is required'); }
+    if (!listId) { return cb(new Error('listId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(listId)) { return cb(new Error('listId is not a valid ObjectId'), null); }
+    if (!itemId) { return cb(new Error('itemId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(itemId)) { return cb(new Error('itemId is not a valid ObjectId'), null); }
+    if (!collection) { return cb(new Error('collection is required'), null); }
+    if (!options) { return cb(new Error('options is required'), null); }
+    if (!options.CUSTOMER_ID) { return cb(new Error('options.CUSTOMER_ID is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(options.CUSTOMER_ID)) { return cb(new Error('options.CUSTOMER_ID is not a valid ObjectId'), null); }
 
-    var update = {};
+    const self = this;
+
+    let update = {};
     update[collection] = itemId;
 
     self.findOneAndUpdate({
       '_id': listId,
-      'customer': config.CUSTOMER_ID
+      'customer': options.CUSTOMER_ID
     }, { $pull: update }, { new: true }, cb);
 
   };
@@ -255,49 +231,31 @@ module.exports = function(mongoose, config) {
 
   List.pre('save', function(next) {
 
-    var self = this;
-
-    cleanDoc(self);
-
-    next();
-
-  });
-
-  List.set('autoIndex', (env == 'development'));
-  List.set('toJSON', { virtuals: true });
-
-  List.plugin(postFind, {
-
-    find: function(results, done) {
+    let doc = this;
 
-      var CUSTOMER_ID = config.CUSTOMER_ID;
-
-      if (CUSTOMER_ID == 'GLOBAL_PROCESS') return done(null, results);
-
-      // Reject any item that is for a different customer
-      results = _.reject(results, function(item) {
-        return item.customer.toString() != CUSTOMER_ID;
+    let dedupeArray = function dedupeArray(arr) {
+      return _.uniq(arr, function(item) {
+        return (utils.isValidObjectId(item) ? item : item._id).toString();
       });
+    };
 
-      return done(null, results);
-
-    },
-
-    findOne: function(result, done) {
-
-      var CUSTOMER_ID = config.CUSTOMER_ID;
+    // enforce unique items in arrays
+    doc.limitedPartners = dedupeArray(doc.limitedPartners);
+    doc.organizations = dedupeArray(doc.organizations);
+    doc.people = dedupeArray(doc.people);
 
-      if (!result) return done(null, null);
-      else if (CUSTOMER_ID == 'GLOBAL_PROCESS') return done(null, result);
-      else if (result.customer.toString() == CUSTOMER_ID) return done(null, result);
-      else return done(null, null);
+    // remove falsy values
+    doc.limitedPartners = _.compact(doc.limitedPartners);
+    doc.organizations = _.compact(doc.organizations);
+    doc.people = _.compact(doc.people);
 
-    }
+    next();
 
   });
 
+  List.set('autoIndex', (env === 'development'));
+  List.set('toJSON', { virtuals: true });
   List.set('autoIndex', false);
-  List.set('usePushEach', true);
   List.on('index', function(err) { console.log('error building list indexes: ' + err); });
 
   mongoose.model('List', List);