@dhyasama/totem-models 7.36.0 → 7.37.0

package/lib/Fund.js

@@ -8,7 +8,6 @@ module.exports = function(mongoose, config) {
   var env = process.env.NODE_ENV || 'development';
 
   var Fund = new Schema({
-
     name: { type: String, required: true, unique: true },
     slug: { type: String, required: true, unique: true },
     shortName: { type: String, required: true },
@@ -17,8 +16,12 @@ module.exports = function(mongoose, config) {
     hexColorCode: { type: String, required: true, default: '#cccccc' },
     closeDate: { type: Date },
     amount: { type: Number },
-    crunchbase: { uuid: { type: String, default: '', unique: true } }
-
+    crunchbase: { uuid: { type: String, default: '', unique: true } },
+    transactions: [{
+      type: { type: String, enum: ['fees', 'expenses', 'carry'] },
+      amount: { type: Number, default: 0 },
+      date: { type: Date, default: null },
+    }],
   });
 
   /************* BASIC FIELDS **********************/
@@ -169,6 +172,18 @@ module.exports = function(mongoose, config) {
 
   };
 
+  Fund.statics.removeTransactions = function removeTransactions(cb) {
+
+    var self = this;
+
+    var query = self.update(
+      { $set: { transactions: [] } },
+      { multi : true }
+    );
+    query.exec(cb);
+
+  };
+
   Fund.post('remove', function(doc) {
     // Debt.debts.internal.fund
     // Document.fundInvolved

package/lib/LimitedPartner.js

@@ -45,10 +45,11 @@ module.exports = function(mongoose, config) {
       quarterlyAccountStatement: { type: String, default: '' }
     },
 
-    fundsInvested: [{
+    transactions: [{
       fund: {type: Schema.ObjectId, ref: 'Fund'},
-      committed: {type: Number, default: 0},
-      called: {type: Number, default: 0}
+      type: { type: String, enum: ['commitment', 'contribution', 'distribution'] },
+      amount: { type: Number, default: 0 },
+      date: { type: Date, default: null },
     }],
 
     contact: {
@@ -194,9 +195,56 @@ module.exports = function(mongoose, config) {
 
 /////////////////////
 
-  LimitedPartner.virtual('totalCommitted').get(function () {
+  LimitedPartner.virtual('totalCommitment').get(function () {
     var self = this;
-    return _.reduce(self.fundsInvested, function(memo, fund) { return memo + (fund.committed > 0 ? fund.committed : 0); }, 0);
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type == 'commitment' && transaction.amount > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalContribution').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type == 'contribution' && transaction.amount > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalDistribution').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type == 'distribution' && transaction.amount > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('fundsInvested').get(function () {
+    
+    var self = this;
+    var fundsInvested = [];
+    
+    _.each(self.transactions, function(transaction) {
+      
+      var fundMatch = _.find(fundsInvested, function(fund) { return fund._id == transaction.fund._id; });
+      
+      if(!fundMatch) {
+        fundsInvested.push({
+          _id: transaction.fund._id,
+          name: transaction.fund.name,
+          shortName: transaction.fund.shortName,
+          abbreviation: transaction.fund.abbreviation,
+          commitment: 0,
+          contribution: 0,
+          distribution: 0
+        });
+        fundMatch = _.last(fundsInvested);
+      }
+
+      // and increment the transaction type by the transaction amount
+      fundMatch[transaction.type] += transaction.amount;
+
+    });
+   
+    return fundsInvested;
+  
   });
 
   LimitedPartner.virtual('email.primary').get(function () {
@@ -308,40 +356,7 @@ module.exports = function(mongoose, config) {
     });
 
   };
-
-  LimitedPartner.methods.fundPercentCalled = function(fundId) {
-
-    if (!fundId) return 0;
-
-    var match = _.find(this.fundsInvested, function(inv) {
-      return inv.fund == fundId || inv.fund.id == fundId;
-    });
-
-    if (!match) return 0;
-
-    return (match.called / match.committed) * 100;
-
-  };
-
-  LimitedPartner.methods.listActiveFunds = function(cb) {
-
-    var lp = this;
-    var funds = [];
-
-    lp.populate('fundsInvested.fund', function(err) {
-
-      if (err) return cb(err, null);
-
-      _.each(lp.fundsInvested, function(investment) {
-        if (investment.committed > 0) { funds.push(investment); }
-      });
-
-      return cb(null, funds);
-
-    });
-
-  };
-
+  
   LimitedPartner.methods.docSlugs = function() {
 
     var slugs = this.documentSlugs;
@@ -371,7 +386,7 @@ module.exports = function(mongoose, config) {
     var self = this;
     var query;
     var getLp = function() {
-      query.populate('fundsInvested.fund');
+      query.populate('transactions.fund');
       query.populate('people');
       query.populate('notes');
       query.deepPopulate([
@@ -397,7 +412,7 @@ module.exports = function(mongoose, config) {
       getLp();
     }
     else {
-      query = self.findOne({ '_id': id, 'fundsInvested.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
+      query = self.findOne({ '_id': id, 'transactions.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
       getLp();
     }
 
@@ -409,7 +424,7 @@ module.exports = function(mongoose, config) {
     var query;
 
     var getLps = function(q) {
-      q.populate('fundsInvested.fund')
+      q.populate('transactions.fund')
       q.populate('people', 'name')
       q.exec(function (err, lps) {
         if (err) return cb(err, null);
@@ -423,7 +438,7 @@ module.exports = function(mongoose, config) {
       getLps(query);
     }
     else {
-      query = self.find({'people': personId, 'fundsInvested.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
+      query = self.find({'people': personId, 'transactions.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
       getLps(query);
     }
 
@@ -435,7 +450,7 @@ module.exports = function(mongoose, config) {
     var query;
 
     var getLps = function() {
-      query.populate('fundsInvested.fund');
+      query.populate('transactions.fund');
       query.exec(cb);
     };
 
@@ -444,7 +459,7 @@ module.exports = function(mongoose, config) {
       getLps();
     }
     else {
-      query = self.find({'name': lpName, 'fundsInvested.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
+      query = self.find({'name': lpName, 'transactions.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
       getLps();
     }
 
@@ -563,7 +578,7 @@ module.exports = function(mongoose, config) {
     var query;
 
     var getLps = function(q) {
-      q.populate('fundsInvested.fund')
+      q.populate('transactions.fund')
       q.exec(function (err, lps) {
         if (err) return cb(err, null);
         lps = _.sortBy(lps, function(lp) { return lp.name ? lp.name.toLowerCase() : ''; });
@@ -576,7 +591,7 @@ module.exports = function(mongoose, config) {
       getLps(query);
     }
     else {
-      query = self.find({ 'fundsInvested.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
+      query = self.find({ 'transactions.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
       getLps(query);
     }
 
@@ -591,7 +606,7 @@ module.exports = function(mongoose, config) {
     var query;
 
     var getLps = function(q) {
-      q.populate('fundsInvested.fund')
+      q.populate('transactions.fund')
       q.exec(function (err, lps) {
         if (err) return cb(err, null);
         lps = _.sortBy(lps, function(lp) { return lp.name ? lp.name.toLowerCase() : ''; });
@@ -599,7 +614,7 @@ module.exports = function(mongoose, config) {
       });
     };
 
-    query = self.find({ 'fundsInvested.fund': { $in : fundIds }}, self.getReadFilterKeys(role));
+    query = self.find({ 'transactions.fund': { $in : fundIds }}, self.getReadFilterKeys(role));
     getLps(query);
 
   };
@@ -610,7 +625,7 @@ module.exports = function(mongoose, config) {
 
     this
       .find({'status.verified': false}, this.getReadFilterKeys(role))
-      .populate('fundsInvested.fund')
+      .populate('transactions.fund')
       .exec(function (err, lps) {
         cb(err, _.sortBy(lps, function(lp) { return lp.name; }));
       });
@@ -623,7 +638,7 @@ module.exports = function(mongoose, config) {
 
     this
       .find({'flagged.resolved': false, 'flagged.text': { $ne: '' }}, this.getReadFilterKeys(role))
-      .populate('fundsInvested.fund')
+      .populate('transactions.fund')
       .exec(function (err, lps) {
         cb(err, _.sortBy(lps, function(lp) { return lp.name; }));
       });
@@ -638,8 +653,8 @@ module.exports = function(mongoose, config) {
     var self = this;
 
     self
-      .find({ 'fundsInvested.fund': fundId }, self.getReadFilterKeys(role))
-      .populate('fundsInvested.fund')
+      .find({ 'transactions.fund': fundId }, self.getReadFilterKeys(role))
+      .populate('transactions.fund')
       .exec(function(err, lps) {
 
         if (err) return cb(err, null);
@@ -680,7 +695,7 @@ module.exports = function(mongoose, config) {
     var self = this;
     var query;
     var getLps = function() {
-      query.populate('fundsInvested.fund');
+      query.populate('transactions.fund');
       query.exec(function (err, lps) {
 
         if (err) return cb(err, null);
@@ -700,7 +715,7 @@ module.exports = function(mongoose, config) {
       getLps();
     }
     else {
-      query = self.find({ 'name': new RegExp(terms, "i"), 'fundsInvested.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
+      query = self.find({ 'name': new RegExp(terms, "i"), 'transactions.fund': { $in : self.customerFunds }}, self.getReadFilterKeys(role));
 
       getLps();
     }
@@ -713,13 +728,13 @@ module.exports = function(mongoose, config) {
     return self.customerFunds;
   };
 
-  LimitedPartner.statics.removeCustomerCommitments = function removeCustomerCommitments(customerId, cb) {
+  LimitedPartner.statics.removeCustomerTransactions = function removeCustomerTransactions(customerId, cb) {
 
     var self = this;
 
     var query = self.update(
       { 'customer': customerId },
-      { $set: { fundsInvested: [] } },
+      { $set: { transactions: [] } },
       { multi : true }
     );
     query.exec(cb);
@@ -929,14 +944,14 @@ module.exports = function(mongoose, config) {
 
   LimitedPartner.plugin(filter, {
     "readFilter": {
-      "admin": ["name", "shortName", "start", "people", "documentSlugs", "fundsInvested", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
-      "lp-full": ["name", "shortName", "start", "people", "documentSlugs", "fundsInvested", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
+      "admin": ["name", "shortName", "start", "people", "documentSlugs", "transactions", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
+      "lp-full": ["name", "shortName", "start", "people", "documentSlugs", "transactions", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
       "lp-names": ["name", "shortName", "flagged", "flags"],
       "none": []
     },
     "writeFilter": {
-      "admin": ["name", "shortName", "start", "people", "documentSlugs", "fundsInvested", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
-      "lp-full": ["name", "shortName", "start", "people", "documentSlugs", "fundsInvested", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
+      "admin": ["name", "shortName", "start", "people", "documentSlugs", "transactions", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
+      "lp-full": ["name", "shortName", "start", "people", "documentSlugs", "transactions", "contact", "distributions", "k1", "entered", "status", "flagged", "flags", "notes"],
       "lp-names": ["flagged", "flags"],
       "none": []
     },
@@ -957,4 +972,4 @@ module.exports = function(mongoose, config) {
 
   mongoose.model('LimitedPartner', LimitedPartner);
 
-};
+};

package/package.json

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