@dhyasama/totem-models 9.9.1 → 9.11.0

package/lib/Fund.js

@@ -16,11 +16,6 @@ module.exports = function(mongoose, config) {
     closeDate: { type: Date },
     amount: { type: Number },
     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 },
-    }],
     customFields: { type: Schema.Types.Mixed },
     
     // the stakeholders names we match to on cap tables
@@ -143,15 +138,44 @@ module.exports = function(mongoose, config) {
 
   };
 
-  Fund.statics.removeTransactions = function removeTransactions(cb) {
+  Fund.statics.modify = function(filter, update, cb) {
 
-    const self = this;
+    // VERY IMPORTANT NOTE
+    // findByIdAndUpdate and findOneAndUpdate do not trigger pre-save hook so that code will not run here
+    // at this time, the only known and approved use of this method is for adding and removing roles in totem web
+
+    if (!cb) throw new Error('cb is required');
+    if (!filter) { return cb(new Error('filter is required'), null); }
+    if (!update) { return cb(new Error('update is required'), null); }
+
+    var 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
+
+    self.findOneAndUpdate(filter, update, { upsert: false, new: true }, cb);
+
+  };
+
+  Fund.statics.modifyById = function(id, update, cb) {
+
+    // VERY IMPORTANT NOTE
+    // findByIdAndUpdate and findOneAndUpdate do not trigger pre-save hook so that code will not run here
+    // at this time, the only known and approved use of this method is for the org edit form in totem web
+
+    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;
+
+    // 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
 
-    let query = self.update(
-      { $set: { transactions: [] } },
-      { multi : true }
-    );
-    query.exec(cb);
+    self.findByIdAndUpdate(id, update, { upsert: false, new: true }, cb);
 
   };
 

package/lib/LimitedPartner.js

@@ -39,9 +39,10 @@ module.exports = function(mongoose, config) {
 
     transactions: [{
       fund: {type: Schema.ObjectId, ref: 'Fund'},
-      type: { type: String, enum: ['commitment', 'contribution', 'distribution'] },
+      type: { type: String, enum: ['commitment', 'contribution', 'distribution', 'fee', 'expense', 'carry', 'income', 'realized', 'unrealized'] },
       amount: { type: Number, default: 0 },
       date: { type: Date, default: null },
+      description: { type: String, default: '' },
     }],
 
     contact: {
@@ -134,6 +135,48 @@ module.exports = function(mongoose, config) {
     }, 0);
   });
 
+  LimitedPartner.virtual('totalFee').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type === 'fee' && Math.abs(transaction.amount) > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalExpense').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type === 'expense' && Math.abs(transaction.amount) > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalCarry').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type === 'carry' && Math.abs(transaction.amount) > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalIncome').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type === 'income' && Math.abs(transaction.amount) > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalRealized').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type === 'realized' && Math.abs(transaction.amount) > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalUnrealized').get(function () {
+    var self = this;
+    return _.reduce(self.transactions, function(memo, transaction) {
+      return memo + ((transaction.type === 'unrealized' && Math.abs(transaction.amount) > 0) ? transaction.amount : 0);
+    }, 0);
+  });
+
   LimitedPartner.virtual('fundsInvested').get(function () {
     
     var self = this;
@@ -151,7 +194,13 @@ module.exports = function(mongoose, config) {
           abbreviation: transaction.fund.abbreviation,
           commitment: 0,
           contribution: 0,
-          distribution: 0
+          distribution: 0,
+          fee: 0,
+          expense: 0,
+          carry: 0,
+          income: 0,
+          realized: 0,
+          unrealized: 0
         });
         fundMatch = _.last(fundsInvested);
       }
@@ -637,17 +686,38 @@ module.exports = function(mongoose, config) {
 
   };
 
+  LimitedPartner.statics.modify = function(filter, update, cb) {
+
+    // VERY IMPORTANT NOTE
+    // findByIdAndUpdate and findOneAndUpdate do not trigger pre-save hook so that code will not run here
+    // at this time, the only known and approved use of this method is for adding and removing roles in totem web
+
+    if (!cb) throw new Error('cb is required');
+    if (!filter) { return cb(new Error('filter is required'), null); }
+    if (!update) { return cb(new Error('update is required'), null); }
+
+    var 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
+
+    self.findOneAndUpdate(filter, update, { upsert: false, new: true }, cb);
+
+  };
+
   LimitedPartner.statics.modifyById = function(id, update, cb) {
 
     // VERY IMPORTANT NOTE
     // findByIdAndUpdate and findOneAndUpdate do not trigger pre-save hook so that code will not run here
+    // at this time, the only known and approved use of this method is for the org edit form in totem web
 
-    if (!cb) { throw new Error('cb is required'); }
+    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('options is required'), null); }
+    if (!update) { return cb(new Error('update is required'), null); }
 
-    const self = this;
+    var self = this;
 
     // https://mongoosejs.com/docs/api.html#model_Model.findOneAndUpdate
     // options runValidators defaults false which is ok since we have upsert false

package/lib/Organization.js

@@ -1649,6 +1649,7 @@ module.exports = function(mongoose, config) {
 
     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;

package/lib/Person.js

@@ -594,16 +594,38 @@ module.exports = function(mongoose, config) {
     });
   };
 
+  Person.statics.modify = function(filter, update, cb) {
+
+    // VERY IMPORTANT NOTE
+    // findByIdAndUpdate and findOneAndUpdate do not trigger pre-save hook so that code will not run here
+    // at this time, the only known and approved use of this method is for adding and removing roles in totem web
+
+    if (!cb) throw new Error('cb is required');
+    if (!filter) { return cb(new Error('filter is required'), null); }
+    if (!update) { return cb(new Error('update is required'), null); }
+
+    var 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
+
+    self.findOneAndUpdate(filter, update, { upsert: false, new: true }, cb);
+
+  };
+
   Person.statics.modifyById = function(id, update, cb) {
 
     // VERY IMPORTANT NOTE
     // findByIdAndUpdate and findOneAndUpdate do not trigger pre-save hook so that code will not run here
+    // at this time, the only known and approved use of this method is for the org edit form in totem web
 
     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); }
 
-    const self = this;
+    var self = this;
 
     // https://mongoosejs.com/docs/api.html#model_Model.findOneAndUpdate
     // options runValidators defaults false which is ok since we have upsert false

package/package.json

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