@dhyasama/totem-models 8.110.0 → 9.0.0

package/lib/CapTable.js

@@ -31,14 +31,14 @@ module.exports = function(mongoose, config) {
     // preferably the date in the cap table document, not the date added to our system
     asOfDate: { type: Date, required: true, default: Date.now },
 
-    // so customers can download full file
-    originalDocumentUrl: { type: String, trim: true },
+    // optional reference to download the cap table file
+    document: { type: Schema.ObjectId, ref: 'Document', required: false },
 
     // single pool of unissued options for the org
-    unissuedOptions: { type: Number, default: 0 },
+    unissued: { type: Number, default: 0 },
 
     // computed on save (via pre-save hook); don't set directly;
-    fullyDiluted: { type: Number, default: 0 },
+    shares: { type: Number, default: 0 },
 
     stakeholders: [{
 
@@ -110,34 +110,17 @@ module.exports = function(mongoose, config) {
         }
       },
 
-      // Put stakes in a bucket for their type.
-      // Note we are grouping all stakes for the current stakeholder.
-
-      common: [{
-        round: { type: String, trim: true, required: true },
-        shares: { type: Number, default: 0 }
-      }],
-
-      options: [{
-        round: { type: String, trim: true, required: true },
-        shares: { type: Number, default: 0 }
-      }],
-
-      preferred: [{
-        round: { type: String, trim: true, required: true },
-        shares: { type: Number, default: 0 }
-      }],
-
-      warrants: [{
+      rounds: [{
         round: { type: String, trim: true, required: true },
-        shares: { type: Number, default: 0 }
+        shares: { type: Number, default: 0 },
+        ownership: { type: Number, default: 0 }
       }],
 
       // computed on save (via pre-save hook); don't set directly;
-      fullyDiluted: { type: Number, default: 0 },
+      shares: { type: Number, default: 0 },
 
       // computed on save (via pre-save hook); don't set directly;
-      fullyDilutedPercentage: { type: Number, default: 0 }
+      ownership: { type: Number, default: 0 }
 
     }],
 
@@ -157,59 +140,28 @@ module.exports = function(mongoose, config) {
 
   CapTable.virtual('stakeholdersByRound').get(function () {
 
-    // Returns list of tuples, one for each round on this cap table along with participants in each round
-
     var self = this;
 
-    var buildRoundList = function buildRoundList(stakeholders) {
-
-      var roundList = [];
+    var stakeholdersByRound = [];
 
-      _.each(stakeholders, function(stakeholder) {
-        roundList = roundList.concat(_.pluck(stakeholder.common, 'round'));
-        roundList = roundList.concat(_.pluck(stakeholder.options, 'round'));
-        roundList = roundList.concat(_.pluck(stakeholder.preferred, 'round'));
-        roundList = roundList.concat(_.pluck(stakeholder.warrants, 'round'));
-      });
-
-      roundList = _.uniq(roundList);
-
-      return roundList;
-
-    };
-
-    var matchStakeholderToRound = function matchStakeholderToRound(arr, participants, name, round) {
-      var match = _.find(arr, function(i) { return round == i.round; });
-      if (match) { participants.push(name); }
-    };
-
-    var roundList = buildRoundList(self.stakeholders);
-
-    var stakeholders = [];
-
-    _.each(roundList, function(round) {
+    _.each(self.stakeholders, function(stakeholder) {
+      _.each(stakeholder.rounds, function(round) {
 
-      // List of each participant in this round
-      var participants = [];
+        var roundMatch = _.find(stakeholdersByRound, function(r) { return r.round == round.round });
 
-      _.each(self.stakeholders, function(stakeholder) {
-        matchStakeholderToRound(stakeholder.common, participants, stakeholder.name, round);
-        matchStakeholderToRound(stakeholder.options, participants, stakeholder.name, round);
-        matchStakeholderToRound(stakeholder.preferred, participants, stakeholder.name, round);
-        matchStakeholderToRound(stakeholder.warrants, participants, stakeholder.name, round);
-      });
+        if(roundMatch) {
+          roundMatch.stakeholders.push(stakeholder);
+        }
 
-      participants = _.uniq(participants);
+        else {
+          stakeholdersByRound.push({round: round.round, stakeholders: []});
+          _.last(stakeholdersByRound).stakeholders.push(stakeholder);
+        }
 
-      // return tuple of round name and participants in the round
-      stakeholders.push({
-        round: round,
-        participants: participants
       });
-
     });
 
-    return stakeholders;
+    return stakeholdersByRound;
 
   });
 
@@ -230,10 +182,10 @@ module.exports = function(mongoose, config) {
 
     self
       .findOne({customer: customerId, organization: orgId })
-      query.populate('stakeholders.fund', 'name shortName')
-      query.populate('stakeholders.lp', 'name')
-      query.populate('stakeholders.org', 'name logoUrl')
-      query.populate('stakeholders.person', 'name avatarUrl title')
+      .populate('stakeholders.fund', 'name shortName')
+      .populate('stakeholders.lp', 'name')
+      .populate('stakeholders.org', 'name logoUrl')
+      .populate('stakeholders.person', 'name avatarUrl title')
       .exec(cb);
 
   };
@@ -393,20 +345,6 @@ module.exports = function(mongoose, config) {
 
   };
 
-  CapTable.statics.updateOriginalDocumentUrl = function updateOriginalDocumentUrl(id, originalDocumentUrl, cb) {
-
-    var self = this;
-
-    self
-      .findByIdAndUpdate(
-        id,
-        { $set: { originalDocumentUrl: originalDocumentUrl } },
-        { new: true, upsert: false },
-        cb
-      );
-
-  };
-
   CapTable.statics.upsert = function upsert(capTable, cb) {
 
     if (!capTable) { return cb(new Error('cap table is required'), null); }
@@ -429,39 +367,27 @@ module.exports = function(mongoose, config) {
 
     var self = this;
 
-    // Sum each stakeholders fully diluted shares
+    // Sum each stakeholders shares
     _.each(self.stakeholders, function(stakeholder) {
 
-      var common = _.reduce(stakeholder.common, function(memo, i) {
+      var shares = _.reduce(stakeholder.rounds, function(rounds, i) {
         return memo + i.shares;
       }, 0);
 
-      var options = _.reduce(stakeholder.options, function(memo, i) {
-        return memo + i.shares;
-      }, 0);
-
-      var preferred = _.reduce(stakeholder.preferred, function(memo, i) {
-        return memo + i.shares;
-      }, 0);
-
-      var warrants = _.reduce(stakeholder.warrants, function(memo, i) {
-        return memo + i.shares;
-      }, 0);
-
-      stakeholder.fullyDiluted = common + options + preferred + warrants;
+      stakeholder.shares = shares;
 
     });
 
-    // Sum total fully diluted
-    self.fullyDiluted = _.reduce(self.stakeholders, function(memo, stakeholder) {
-      return memo + stakeholder.fullyDiluted;
+    // Sum total shares
+    self.shares = _.reduce(self.stakeholders, function(memo, stakeholder) {
+      return memo + stakeholder.shares;
     }, 0);
-    self.fullyDiluted = self.fullyDiluted + self.unissuedOptions;
+    self.shares = self.shares + self.unissued;
 
-    // Calculate each stakeholders fully diluted percentage
+    // Calculate each stakeholders ownership
     _.each(self.stakeholders, function(stakeholder) {
-      if (self.fullyDiluted == 0) { stakeholder.fullyDiluted = 0; }
-      else { stakeholder.fullyDilutedPercentage = ((stakeholder.fullyDiluted / self.fullyDiluted) * 100).toFixed(2); }
+      if (self.shares == 0) stakeholder.shares = 0;
+      else stakeholder.ownership = ((stakeholder.shares / self.shares) * 100).toFixed(2);
     });
 
     return next();
@@ -470,14 +396,12 @@ module.exports = function(mongoose, config) {
 
   CapTable.post('init', function(doc, next) {
 
-    doc.stakeholders = _.sortBy(doc.stakeholders, 'fullyDilutedPercentage').reverse();
+    doc.stakeholders = _.sortBy(doc.stakeholders, 'ownership').reverse();
 
     return next();
 
   });
 
-
-
   ///////////////////////////////////////////////////////////////////////////////////////
   // CONFIG
   ///////////////////////////////////////////////////////////////////////////////////////

package/package.json

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