@dhyasama/totem-models 9.4.2 → 9.6.0

package/lib/CapTable.js

@@ -34,41 +34,21 @@ module.exports = function(mongoose, config) {
     // optional reference to download the cap table file
     document: { type: Schema.ObjectId, ref: 'Document', required: false },
 
-    // computed on save (via pre-save hook); don't set directly;
-    shares: { type: Number, default: 0 },
-
     stakeholders: [{
+      
+      _id: false,
 
-      // verbatim text from the cap table
+      // the raw stakeholder name on the cap table
       name: { type: String, trim: true, required: true },
 
+      // the stakeholders shares broken down by round
       rounds: [{
-        round: { type: String, trim: true, required: true },
+        _id: false,
+        name: { type: String, trim: true, required: true },
         shares: { type: Number, default: 0 },
       }],
 
-      // computed on save (via pre-save hook); don't set directly;
-      shares: { type: Number, default: 0 },
-
-      // computed on save (via pre-save hook); don't set directly;
-      ownership: { type: Number, default: 0 },
-
-      // link stakeholder to a fund in our system
-      fund: {
-        type: Schema.ObjectId,
-        ref: 'Fund',
-        default: null,
-        required: false,
-        validate: {
-          validator: function(v) {
-            if (v && (this.lp || this.org || this.person)) return false;
-            else return true;
-          },
-          message: 'A stakeholder can only be linked to one of the following: fund, lp, org, person'
-        }
-      },
-
-      // link stakeholder to a lp in our system
+      // stakeholder reference to an lp
       lp: {
         type: Schema.ObjectId,
         ref: 'LimitedPartner',
@@ -76,14 +56,14 @@ module.exports = function(mongoose, config) {
         required: false,
         validate: {
           validator: function(v) {
-            if (v && (this.fund || this.org || this.person)) return false;
+            if (v && (this.org || this.person)) return false;
             else return true;
           },
-          message: 'A stakeholder can only be linked to one of the following: fund, lp, org, person'
+          message: 'A stakeholder can only be linked to one of the following: lp, org, person'
         }
       },
 
-      // link stakeholder to a person in our system
+      // stakeholder reference to an org
       org: {
         type: Schema.ObjectId,
         ref: 'Organization',
@@ -91,14 +71,14 @@ module.exports = function(mongoose, config) {
         required: false,
         validate: {
           validator: function(v) {
-            if (v && (this.fund || this.lp || this.person)) return false;
+            if (v && (this.lp || this.person)) return false;
             else return true;
           },
-          message: 'A stakeholder can only be linked to one of the following: fund, lp, org, person'
+          message: 'A stakeholder can only be linked to one of the following: lp, org, person'
         }
       },
 
-      // link stakeholder to a person in our system
+      // stakeholder reference to an person
       person: {
         type: Schema.ObjectId,
         ref: 'Person',
@@ -106,12 +86,12 @@ module.exports = function(mongoose, config) {
         required: false,
         validate: {
           validator: function(v) {
-            if (v && (this.fund || this.lp || this.org)) return false;
+            if (v && (this.lp || this.org)) return false;
             else return true;
           },
-          message: 'A stakeholder can only be linked to one of the following: fund, lp, org, person'
+          message: 'A stakeholder can only be linked to one of the following: lp, org, person'
         }
-      },
+      }
 
     }],
 
@@ -127,30 +107,19 @@ module.exports = function(mongoose, config) {
   // Properties that are not persisted to the database
   ///////////////////////////////////////////////////////////////////////////////////////
 
-  CapTable.virtual('stakeholdersByRound').get(function () {
+   CapTable.virtual('shares').get(function() {
 
     var self = this;
 
-    var stakeholdersByRound = [];
+    var shares = 0;
 
     _.each(self.stakeholders, function(stakeholder) {
       _.each(stakeholder.rounds, function(round) {
-
-        var roundMatch = _.find(stakeholdersByRound, function(r) { return r.round == round.round });
-
-        if(roundMatch) {
-          roundMatch.stakeholders.push(stakeholder);
-        }
-
-        else {
-          stakeholdersByRound.push({round: round.round, stakeholders: []});
-          _.last(stakeholdersByRound).stakeholders.push(stakeholder);
-        }
-
+        shares += round.shares;
       });
     });
 
-    return stakeholdersByRound;
+    return shares;
 
   });
 
@@ -165,21 +134,7 @@ module.exports = function(mongoose, config) {
   // Statics operate on the entire collection
   //////////////////////////////////////////////////////
 
-  CapTable.statics.getForCustomer = function getForCustomer(orgId, customerId, cb) {
-
-    var self = this;
-
-    self
-      .findOne({customer: customerId, organization: orgId })
-      .populate('stakeholders.fund', 'name shortName')
-      .populate('stakeholders.lp', 'name')
-      .populate('stakeholders.org', 'name logoUrl')
-      .populate('stakeholders.person', 'name avatarUrl title')
-      .exec(cb);
-
-  };
-
-  CapTable.statics.getAllForCustomer = function getAllForCustomer(options, cb) {
+  CapTable.statics.getForCustomer = function getForCustomer(options, cb) {
 
     var self = this;
 
@@ -197,7 +152,6 @@ module.exports = function(mongoose, config) {
     query.populate('organization', 'name logoUrl');
 
     if(options.populateStakeholders) {
-      query.populate('stakeholders.fund', 'name shortName')
       query.populate('stakeholders.lp', 'name')
       query.populate('stakeholders.org', 'name logoUrl')
       query.populate('stakeholders.person', 'name avatarUrl title')
@@ -207,61 +161,100 @@ module.exports = function(mongoose, config) {
 
   };
 
-  CapTable.statics.deleteAllForCustomer = function deleteAllForCustomer(customerId, cb) {
+  CapTable.statics.deleteForCustomer = function deleteForCustomer(options, cb) {
+
     var self = this;
-    self.remove({ customer: customerId, 'entered.by': { $ne: 'carta-parser' } }, 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); }
+
+    self.remove({ customer: options.CUSTOMER_ID, 'entered.by': { $ne: 'carta-parser' } }, cb);
+
   };
 
-  CapTable.statics.getByFunds = function getByFunds(fundIds, cb) {
+  CapTable.statics.getForOrg = function getForOrg(options, cb) {
 
     var self = this;
 
-    self
-      .find({ 'stakeholders.fund': { $in: fundIds } })
-      .populate('organization', 'name logoUrl')
-      .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); }
 
-  };
+    var query;
 
-  CapTable.statics.getByFund = function getByFund(fundId, cb) {
+    query = self.find({
+      customer: options.CUSTOMER_ID,
+      organization: options.orgId
+    });
 
-    var self = this;
+    query.populate('organization', 'name logoUrl');
 
-    self
-      .find({ 'stakeholders.fund': fundId })
-      .populate('organization', 'name logoUrl')
-      .exec(cb);
+    if(options.populateStakeholders) {
+      query.populate('stakeholders.lp', 'name')
+      query.populate('stakeholders.org', 'name logoUrl')
+      query.populate('stakeholders.person', 'name avatarUrl title')
+    }
 
   };
 
-  CapTable.statics.getByLP = function getByLP(lpId, cb) {
+  CapTable.statics.getByLP = function getByLP(options, cb) {
 
     var self = this;
 
+    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); }
+
+    query = self.find({
+      customer: options.CUSTOMER_ID,
+      'stakeholders.lp': options.lpId
+    });
+
     self
-      .find({ 'stakeholders.lp': lpId })
       .populate('organization', 'name logoUrl')
       .exec(cb);
 
   };
 
-  CapTable.statics.getByOrg = function getByOrg(orgId, cb) {
+  CapTable.statics.getByOrg = function getByOrg(options, cb) {
 
     var self = this;
 
+    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); }
+
+    query = self.find({
+      customer: options.CUSTOMER_ID,
+      'stakeholders.org': options.orgId
+    });
+
     self
-      .find({ 'stakeholders.org': orgId })
       .populate('organization', 'name logoUrl')
       .exec(cb);
 
   };
 
-  CapTable.statics.getByPerson = function getByPerson(personId, cb) {
+  CapTable.statics.getByPerson = function getByPerson(options, cb) {
 
     var self = this;
 
+    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); }
+
+    query = self.find({
+      customer: options.CUSTOMER_ID,
+      'stakeholders.person': options.personId
+    });
+
     self
-      .find({ 'stakeholders.person': personId })
       .populate('organization', 'name logoUrl')
       .exec(cb);
 
@@ -298,12 +291,7 @@ module.exports = function(mongoose, config) {
     capTable.entered.by = username;
     capTable.entered.on = new Date();
 
-    self.update(
-      { '_id': capTable._id },
-      capTable,
-      { upsert: false, multi: false, overwrite: true },
-      cb
-    );
+    self.update({ '_id': capTable._id }, capTable, { upsert: false, multi: false, overwrite: true }, cb);
 
   };
 
@@ -324,8 +312,7 @@ module.exports = function(mongoose, config) {
     query = self.find({
       customer: options.CUSTOMER_ID,
       'stakeholders.name': new RegExp(terms, 'i'),
-      'stakeholders.person': null,
-      'stakeholders.fund': null
+      'stakeholders.person': null
     });
 
     query.populate('organization', 'name logoUrl');
@@ -352,44 +339,6 @@ module.exports = function(mongoose, config) {
   // Pre-save: fired on every document before it is saved
   ///////////////////////////////////////////////////////////////////////////////////////
 
-  CapTable.pre('save', function(next) {
-
-    var self = this;
-
-    // Sum each stakeholders shares
-    _.each(self.stakeholders, function(stakeholder) {
-
-      var shares = _.reduce(stakeholder.rounds, function(memo, i) {
-        return memo + i.shares;
-      }, 0);
-
-      stakeholder.shares = shares;
-
-    });
-
-    // Sum total shares
-    self.shares = _.reduce(self.stakeholders, function(memo, stakeholder) {
-      return memo + stakeholder.shares;
-    }, 0);
-
-    // Calculate each stakeholders ownership
-    _.each(self.stakeholders, function(stakeholder) {
-      if (self.shares == 0) stakeholder.shares = 0;
-      else stakeholder.ownership = ((stakeholder.shares / self.shares) * 100).toFixed(2);
-    });
-
-    return next();
-
-  });
-
-  CapTable.post('init', function(doc, next) {
-
-    doc.stakeholders = _.sortBy(doc.stakeholders, 'ownership').reverse();
-
-    return next();
-
-  });
-
   ///////////////////////////////////////////////////////////////////////////////////////
   // CONFIG
   ///////////////////////////////////////////////////////////////////////////////////////

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhyasama/totem-models",
-  "version": "9.4.2",
+  "version": "9.6.0",
   "author": "Jason Reynolds",
   "license": "UNLICENSED",
   "description": "Models for Totem platform",