@dhyasama/totem-models 7.58.0 → 8.0.0

package/lib/Deal.js

@@ -2,15 +2,14 @@
 
 module.exports = function(mongoose, config) {
 
-  var
+  let
 
     Schema = mongoose.Schema,
-    postFind = require('mongoose-post-find'),
     async = require('async'),
     _ = require('underscore'),
-    moment = require('moment');
+    utilities = require('@dhyasama/ffvc-utilities');
 
-  var Deal = new Schema({
+  let Deal = new Schema({
 
     customer: { type: Schema.ObjectId, ref: 'Organization', required: true },
 
@@ -65,29 +64,23 @@ module.exports = function(mongoose, config) {
 
   });
 
-  var customExample = {
-    revenue: 1000000,
-    note: 'love it',
-    international: false,
-    region: 'Northeast',
-    industries: ['AI', 'Logistics']
-  };
 
 
   ///////////////////////////////////////////////////////////////////////////////////////
   // VIRTUALS
   // Properties that are not persisted to the database
   ///////////////////////////////////////////////////////////////////////////////////////
+
   Deal.virtual('deck').get(function () {
 
-    var self = this;
+    const self = this;
     return _.find(self.documents, function(document) { return document.type == 'deck'; })
     
   });
 
   Deal.virtual('added').get(function () {
 
-    var self = this;
+    const self = this;
 
     if(self.history && self.history.length > 0) return self.history[0].timestamp;
     else return null;
@@ -96,7 +89,7 @@ module.exports = function(mongoose, config) {
 
   Deal.virtual('updated').get(function () {
 
-    var self = this;
+    const self = this;
 
     if(self.history && self.history.length > 0) return self.history[self.history.length - 1].timestamp;
     else return null;
@@ -116,58 +109,104 @@ module.exports = function(mongoose, config) {
   // Statics operate on the entire collection
   //////////////////////////////////////////////////////
 
-  Deal.statics.delete = function(id, cb) {
+  Deal.statics.delete = function(id, options, cb) {
 
-    var self = this;
+    let self = this;
+
+    if (!cb) { throw new Error('cb is required'); }
+    if (!id) { return cb(new Error('id 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); }
 
     // Not strictly necessary but provides verification that the document being deleted belongs to the customer doing the deleting
-    self.findOne({
+    let query = self.findOne({
       '_id': id,
-      'customer': config.CUSTOMER_ID
-    }, function(err, deal) {
+      'customer': options.CUSTOMER_ID
+    });
+
+    query.exec(function(err, deal) {
 
       if (err) return cb(err, null);
       else if (!deal) return cb(null, null);
 
+      // No population so no need to scrub
+
       deal.remove(cb);
 
     });
 
   };
 
-  Deal.statics.getAll = function (cb) {
-    this.find({}).exec(cb);
-  };
+  Deal.statics.getById = function (id, options, cb) {
 
-  Deal.statics.getById = function (id, cb) {
+    let self = this;
 
-    var self = this;
+    if (!cb) { throw new Error('cb is required'); }
+    if (!id) { return cb(new Error('id 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); }
+
+    let query = self.findOne({
+      '_id': id,
+      'customer': options.CUSTOMER_ID
+    });
+
+    query.populate({ path: 'documents', match: { customer: options.CUSTOMER_ID } });
+    query.populate({ path: 'messages', match: { customer: options.CUSTOMER_ID } });
+    query.populate('organization', 'name description logoUrl website websiteAliases chairs contact');
+    query.populate('history.account', 'person');
+    query.populate('referrer.person', 'name avatarUrl title');
+    query.populate('source.person', 'name avatarUrl title');
+
+    query.exec(cb);
 
-    self.findOne({
-        '_id': id,
-        'customer': config.CUSTOMER_ID
-      })
-      .populate('organization', 'name description logoUrl website websiteAliases chairs contact')
-      .populate('messages')
-      .populate('referrer.person', 'name avatarUrl title')
-      .populate({
-        path: 'documents',
-        match: { customer: config.CUSTOMER_ID }
-      })
-      .exec(cb);
   };
 
-  Deal.statics.getByIds = function (ids, cb) {
-    this
-      .find({customer: config.CUSTOMER_ID, '_id': { $in : ids } })
-      .populate('organization', 'name description logoUrl website websiteAliases chairs contact')
-      .populate('messages')
-      .populate('referrer.person', 'name avatarUrl title')
-      .populate({
-        path: 'documents',
-        match: { customer: config.CUSTOMER_ID }
-      })
-      .exec(cb);
+  Deal.statics.getByIds = function (ids, options, cb) {
+
+    let self = this;
+
+    if (!cb) { throw new Error('cb is required'); }
+    if (!ids) { return cb(new Error('ids 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); }
+
+    let query = self.find({
+      customer: options.CUSTOMER_ID,
+      '_id': { $in : ids }
+    });
+
+    query.populate({ path: 'documents', match: { customer: options.CUSTOMER_ID } });
+    query.populate({ path: 'messages', match: { customer: options.CUSTOMER_ID } });
+    query.populate('organization', 'name description logoUrl website websiteAliases chairs contact');
+    query.populate('referrer.person', 'name avatarUrl title');
+    query.populate('source.person', 'name avatarUrl title');
+
+    query.exec(function(err, deals) {
+
+      if (err) return cb(err, null);
+      else if (!deals || deals.length === 0) return cb(null, []);
+
+      let calls = [];
+
+      _.each(deals, function(deal) {
+        let func = function(callback) {
+          deal.deepPopulate('organization.chairs.first', {
+            populate: { 'organization.chairs.first': { select: 'name avatarUrl title doNotDisplay' } }
+          }, callback);
+        };
+        calls.push(func);
+      });
+
+      async.parallel(calls, cb);
+
+    });
+
   };
 
   // Get all deals belonging to a customer
@@ -177,132 +216,189 @@ module.exports = function(mongoose, config) {
     // not sure why chained deepPopulate isn't working (it throws an error)
     // it works to deepPopulate each result instance in parallel
 
-    var self = this;
+    let self = this;
+
+    if (!cb) { throw new Error('cb is required'); }
+    if (!customerId) { return cb(new Error('customerId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(customerId)) { return cb(new Error('customerId is not a valid ObjectId'), null); }
 
     options = options || {};
 
     // { history: { $elemMatch: { timestamp: { $gte: ISODate("2019-01-03T20:45:14.406+0000") } } } }
 
-    var terms = { 'customer': customerId };
+    let terms = { 'customer': customerId };
     if (options.stage) { terms['stage'] = { $in: options.stage }; }
     if (options.since) { terms['history'] = { $elemMatch: { timestamp: { $gte: options.since } } }; }
 
     self
       .find(terms)
+      .populate({ path: 'documents', match: { customer: customerId } })
+      .populate({ path: 'messages', match: { customer: customerId } })
       .populate('organization', 'name description logoUrl website websiteAliases chairs contact')
-      .populate('messages')
       .populate('referrer.person', 'name avatarUrl title')
-      .populate({
-        path: 'documents',
-        match: { customer: customerId }
-      }).exec(cb);
+
+      .exec(function(err, deals) {
+
+        if (err) { return cb(err, null); }
+        else if (!deals || deals.length === 0) { return cb(null, []); }
+
+        let calls = [];
+
+        _.each(deals, function(deal) {
+          let func = function(callback) {
+            deal.deepPopulate('organization.chairs.first', {
+              populate: { 'organization.chairs.first': { select: 'name avatarUrl title doNotDisplay' } }
+            }, callback);
+          };
+          calls.push(func);
+        });
+
+        async.parallel(calls, cb);
+
+      });
 
   };
 
-  Deal.statics.getByReferrer = function (personId, cb) {
+  Deal.statics.getByReferrer = function (personId, options, cb) {
 
-    var self = this;
+    let self = this;
 
-    self
-      .find({
-        'referrer.person': personId,
-        'customer': config.CUSTOMER_ID
-      })
-      .populate('organization', 'name description logoUrl website websiteAliases')
-      .exec(cb);
+    if (!cb) { throw new Error('cb is required'); }
+    if (!personId) { return cb(new Error('personId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(personId)) { return cb(new Error('personId 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); }
+
+    let query = self.find({
+      'referrer.person': personId,
+      'customer': options.CUSTOMER_ID
+    });
+
+    query.populate('organization', 'name description logoUrl website websiteAliases');
+
+    query.exec(cb);
 
   };
 
   // Get a deal for a org, belonging to current customer
-  Deal.statics.getForOrg = function (orgId, cb) {
+  Deal.statics.getForOrg = function (orgId, options, cb) {
 
-    var self = this;
+    const self = this;
+
+    if (!cb) { throw new Error('cb is required'); }
+    if (!orgId) { return cb(new Error('orgId is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(orgId)) { return cb(new Error('orgId 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); }
+
+    let query = self.findOne({
+      'organization': orgId,
+      'customer': options.CUSTOMER_ID
+    });
+
+    query.populate({ path: 'documents', match: { customer: options.CUSTOMER_ID } });
+    query.populate({ path: 'messages', match: { customer: options.CUSTOMER_ID } });
+    query.populate('organization', 'name logoUrl website websiteAliases');
+    query.populate('referrer.person', 'name avatarUrl title');
+    query.populate('source.person', 'name avatarUrl title');
+
+    query.exec(function(err, deal) {
+      if (deal && deal.history) {
+        deal.deepPopulate('history.account.person', {
+          populate: { 'history.account.person': { select: 'name avatarUrl title doNotDisplay' } }
+        }, cb);
+      }
+      else cb(err, deal);
+    });
 
-    self
-      .findOne({
-        'organization': orgId,
-        'customer': config.CUSTOMER_ID
-      })
-      .populate('organization', 'name logoUrl website websiteAliases')
-      .populate('messages')
-      .populate('referrer.person', 'name avatarUrl title')
-      .populate({
-        path: 'documents',
-        match: { customer: config.CUSTOMER_ID }
-      })
-      .exec(cb);
   };
 
-  Deal.statics.modifyById = function(id, update, cb) {
+  Deal.statics.modifyById = function(id, update, options, cb) {
 
     // VERY IMPORTANT NOTE
     // findByIdAndUpdate and findOneAndUpdate do not trigger pre-save hook so that code will not run here
 
-    if (!cb) throw new Error('cb is required');
+    let self = this;
+
+    if (!cb) { throw new Error('cb is required'); }
     if (!id) { return cb(new Error('id is required'), null); }
+    if (!mongoose.Types.ObjectId.isValid(id)) { return cb(new Error('id is not a valid ObjectId'), null); }
     if (!update) { return cb(new Error('update is required'), null); }
-
-    var self = this;
+    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); }
 
     // 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
 
-    self.findByIdAndUpdate(id, update, { upsert: false, new: true }, cb);
+    let query = self.findOneAndUpdate({ _id: id, customer: options.CUSTOMER_ID }, update, { upsert: false, new: true });
+
+    // No population so no need to scrub
+
+    query.exec(cb);
 
   };
 
-  Deal.statics.upsert = function upsert(deal, user, cb) {
+  Deal.statics.upsert = function upsert(deal, options, cb) {
 
     // Deal is dumb and doesn't validate customer stages or duplicate deals. That responsibility is with the org.
 
+    if (!cb) { throw new Error('cb is required'); }
     if (!deal) { return cb(new Error('deal is required'), null); }
+    if (!options) { return cb(new Error('options is required'), null); }
+    if (!options.account) { return cb(new Error('options.account 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 getLastStage = function() {
+    let getLastStage = function() {
 
-      if (!deal.history || deal.history.length == 0) return null;
+      if (!deal.history || deal.history.length === 0) return null;
 
-      var history = _.sortBy(deal.history);
-      var last = history[history.length - 1];
+      let history = _.sortBy(deal.history);
+      let last = history[history.length - 1];
 
       return last.stage;
 
     };
 
-    var getLastFundraiseAmount = function() {
+    let getLastFundraiseAmount = function() {
 
-      if (!deal.history || deal.history.length == 0) return null;
+      if (!deal.history || deal.history.length === 0) return null;
 
-      var history = _.sortBy(deal.history);
-      var last = history[history.length - 1];
+      let history = _.sortBy(deal.history);
+      let last = history[history.length - 1];
 
       return last.fundraise.amount;
       
     };
 
-    var getLastFundraiseValuation = function() {
+    let getLastFundraiseValuation = function() {
 
-      if (!deal.history || deal.history.length == 0) return null;
+      if (!deal.history || deal.history.length === 0) return null;
 
-      var history = _.sortBy(deal.history);
-      var last = history[history.length - 1];
+      let history = _.sortBy(deal.history);
+      let last = history[history.length - 1];
 
       return last.fundraise.valuation;
 
     };
 
-    var getLastFundraiseDetails = function () {
+    let getLastFundraiseDetails = function () {
 
-      if (!deal.history || deal.history.length == 0 || !deal.fundraise.details) return null;
+      if (!deal.history || deal.history.length === 0 || !deal.fundraise.details) return null;
 
-      var history = _.sortBy(deal.history);
-      var last = history[history.length - 1];
+      let history = _.sortBy(deal.history);
+      let last = history[history.length - 1];
 
       return last.fundraise.details;
 
     };
 
-    var formatMoney = function(n, c, d, t) {
+    let formatMoney = function(n, c, d, t) {
+
       var c = isNaN(c = Math.abs(c)) ? 2 : c,
         d = d == undefined ? "." : d,
         t = t == undefined ? "," : t,
@@ -311,31 +407,32 @@ module.exports = function(mongoose, config) {
         j = (j = i.length) > 3 ? j % 3 : 0;
 
       return s + (j ? i.substr(0, j) + t : "") + i.substr(j).replace(/(\d{3})(?=\d)/g, "$1" + t) + (c ? d + Math.abs(n - i).toFixed(c).slice(2) : "");
+
     };
 
-    var description = '';
-    var lastStage = getLastStage();
-    var lastFundraiseAmount = getLastFundraiseAmount();
-    var lastFundraiseValuation = getLastFundraiseValuation();
-    var lastFundraiseDetails = getLastFundraiseDetails();
+    let description = '';
+    let lastStage = getLastStage();
+    let lastFundraiseAmount = getLastFundraiseAmount();
+    let lastFundraiseValuation = getLastFundraiseValuation();
+    let lastFundraiseDetails = getLastFundraiseDetails();
 
-    if (lastStage == null) description = 'The deal was created';
+    if (lastStage === null) { description = 'The deal was created'; }
     else {
-      if (lastStage != deal.stage) description += 'The deal was updated from ' + lastStage + ' to ' + deal.stage;
-      if (lastFundraiseAmount != deal.fundraise.amount) description += 'Fundraise amount was updated from $' + formatMoney(lastFundraiseAmount, 0) + ' to $' + formatMoney(deal.fundraise.amount, 0);
-      if (lastFundraiseValuation != deal.fundraise.valuation) description += 'Fundraise valuation was updated from $' + formatMoney(lastFundraiseValuation, 0) + ' to $' + formatMoney(deal.fundraise.valuation, 0);
-      if (lastFundraiseDetails && lastFundraiseDetails != deal.fundraise.details) description += 'Fundraise details were updated from ' + lastFundraiseDetails + ' to ' + deal.fundraise.details;
-      if (!lastFundraiseDetails && deal.fundraise.details) description += 'Fundraise details were added: ' + deal.fundraise.details;
+      if (lastStage !== deal.stage) { description += 'The deal was updated from ' + lastStage + ' to ' + deal.stage; }
+      if (lastFundraiseAmount !== deal.fundraise.amount) { description += 'Fundraise amount was updated from $' + formatMoney(lastFundraiseAmount, 0) + ' to $' + formatMoney(deal.fundraise.amount, 0); }
+      if (lastFundraiseValuation !== deal.fundraise.valuation) { description += 'Fundraise valuation was updated from $' + formatMoney(lastFundraiseValuation, 0) + ' to $' + formatMoney(deal.fundraise.valuation, 0); }
+      if (lastFundraiseDetails && lastFundraiseDetails !== deal.fundraise.details) { description += 'Fundraise details were updated from ' + lastFundraiseDetails + ' to ' + deal.fundraise.details; }
+      if (!lastFundraiseDetails && deal.fundraise.details) { description += 'Fundraise details were added: ' + deal.fundraise.details; }
     }
 
     // only add history if the description is set from the above conditions
-    if(description != '') {
+    if (description !== '') {
 
       deal.history = deal.history || [];
 
       deal.history.push({
         timestamp: new Date(),
-        account: user,
+        account: options.account,
         stage: deal.stage,
         fundraise: deal.fundraise,
         description: description
@@ -345,54 +442,21 @@ module.exports = function(mongoose, config) {
 
     // Required for mixed types
     deal.markModified('customFields');
-
+    
     deal.save(cb);
 
   };
-
-  Deal.plugin(postFind, {
-
-    find: function(results, done) {
-
-      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;
-      });
-
-      return done(null, results);
-
-    },
-
-    findOne: function(result, done) {
-
-      var CUSTOMER_ID = config.CUSTOMER_ID;
-
-      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);
-
-    }
-
-  });
-
-
-
+  
   ///////////////////////////////////////////////////////////////////////////////////////
   // CONFIG
   ///////////////////////////////////////////////////////////////////////////////////////
 
-  Deal.set('usePushEach', true);
   Deal.set('toJSON', { virtuals: true });
   Deal.set('autoIndex', false);
-  Deal.set('usePushEach', true);
+  
   Deal.on('index', function(err) { console.log('error building deal indexes: ' + err); });
 
-  var deepPopulate = require('mongoose-deep-populate')(mongoose);
+  const deepPopulate = require('mongoose-deep-populate')(mongoose);
   Deal.plugin(deepPopulate);
 
   mongoose.model('Deal', Deal);