@dhyasama/totem-models 8.3.0 → 8.4.0

package/index.js

@@ -64,6 +64,7 @@ var bootstrap = function(mongoose, config) {
   require('./lib/Message.js')(mongoose, config);
   require('./lib/News.js')(mongoose, config);
   require('./lib/Snapshot.js')(mongoose, config);
+  require('./lib/Sync.js')(mongoose, config);
   require('./lib/Webhook.js')(mongoose, config);
 
 };

package/lib/Financials.js

@@ -121,10 +121,10 @@ module.exports = function(mongoose, config) {
 
         company: {
 
-          sendTo: {
+          sendTo: [{
             email: { type: String, trim: true },
             name: { type: String, trim: true }
-          },
+          }],
 
           initial: {
             sendOn: { type: Date, required: false },
@@ -343,7 +343,7 @@ module.exports = function(mongoose, config) {
     let query = self.find({
       'snapshots': {
         $elemMatch: {
-          'notifications.company.sendTo.email': { $ne: null },
+          'notifications.company.sendTo': { $gt: [] },
           'notifications.company.initial.sendOn': { $lte: now },
           'notifications.company.initial.sentOn': null,
           'submittedOn': null
@@ -363,7 +363,7 @@ module.exports = function(mongoose, config) {
 
       snapshots = _.filter(snapshots, function(snapshot) {
 
-        let bool = !!snapshot.notifications.company.sendTo.email;
+        let bool = !!snapshot.notifications.company.sendTo.length > 0;
         bool = bool && snapshot.notifications.company.initial.sendOn < now;
         bool = bool && !snapshot.notifications.company.initial.sentOn;
 
@@ -385,7 +385,7 @@ module.exports = function(mongoose, config) {
     let query = self.find({
       'snapshots': {
         $elemMatch: {
-          'notifications.company.sendTo.email': { $ne: null },
+          'notifications.company.sendTo': { $gt: [] },
           'notifications.company.reminder.sendOn': { $lte: now },
           'notifications.company.reminder.sentOn': null,
           'submittedOn': null
@@ -405,7 +405,7 @@ module.exports = function(mongoose, config) {
 
       snapshots = _.filter(snapshots, function(snapshot) {
 
-        let bool = !!snapshot.notifications.company.sendTo.email;
+        let bool = !!snapshot.notifications.company.sendTo.length > 0;
         bool = bool && snapshot.notifications.company.reminder.sendOn < now;
         bool = bool && !snapshot.notifications.company.reminder.sentOn;
 

package/lib/Fund.js

@@ -7,7 +7,6 @@ module.exports = function(mongoose, config) {
   var _ = require('underscore');
 
   var Fund = new Schema({
-
     name: { type: String, required: true, unique: true },
     slug: { type: String, required: true, unique: true },
     shortName: { type: String, required: true },
@@ -16,8 +15,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 **********************/
@@ -175,6 +178,18 @@ module.exports = function(mongoose, config) {
 
   };
 
+  Fund.statics.removeTransactions = function removeTransactions(cb) {
+
+    const self = this;
+
+    let query = self.update(
+      { $set: { transactions: [] } },
+      { multi : true }
+    );
+    query.exec(cb);
+
+  };
+
   Fund.set('autoIndex', false);
   Fund.on('index', function(err) { console.log('error building fund indexes: ' + err); });
 

package/lib/Investment.js

@@ -63,7 +63,8 @@ module.exports = function(mongoose, config) {
     // Catch-all for customer specific key-value pairs from sheet that aren't supported by our schema
     details: [{
       key: { type: String, trim: true, required: true },
-      value: { type: String, trim: true, required: true },
+      value: { type: Schema.Types.Mixed, required: true },
+      format: { type: String, enum: [null, 'number', 'decimal', 'money', 'percentage', 'date']},
       _id: false
     }],
 
@@ -129,6 +130,10 @@ module.exports = function(mongoose, config) {
   };
 
   Investment.statics.upsert = function upsert(investment, cb) {
+
+    // Required for mixed types
+    investment.markModified('details');
+
     if (!investment) { return cb(new Error('investment is required'), null); }
     investment.save(cb);
   };

package/lib/LimitedPartner.js

@@ -37,10 +37,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: {
@@ -98,7 +99,61 @@ module.exports = function(mongoose, config) {
 
   LimitedPartner.virtual('totalCommitted').get(function () {
     const self = this;
-    return _.reduce(self.fundsInvested, function(memo, fund) { return memo + (fund.committed > 0 ? fund.committed : 0); }, 0);
+    return _.reduce(self.fundsInvested, function (memo, fund) {
+      return memo + (fund.committed > 0 ? fund.committed : 0);
+    }, 0);
+  });
+
+  LimitedPartner.virtual('totalCommitment').get(function () {
+    var self = this;
+    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 () {
@@ -300,7 +355,7 @@ module.exports = function(mongoose, config) {
       query = self.findOne({ '_id': id, customer: options.CUSTOMER_ID }, self.getReadFilterKeys(options.role));
     }
 
-    query.populate('fundsInvested.fund');
+    query.populate('transactions.fund');
     query.populate('people');
     query.populate({
       path: 'notes',
@@ -350,7 +405,8 @@ module.exports = function(mongoose, config) {
     if (!options.isWorkerProcess) { return cb(null, []); }
 
     let query = self.findOne({'name': lpName}, this.getReadFilterKeys(options.role));
-    query.populate('fundsInvested.fund');
+
+    query.populate('transactions.fund');
     query.exec(cb);
 
   };
@@ -377,7 +433,7 @@ module.exports = function(mongoose, config) {
       query = self.find({'people': personId, customer: options.CUSTOMER_ID }, self.getReadFilterKeys(options.role));
     }
 
-    query.populate('fundsInvested.fund');
+    query.populate('transactions.fund');
     query.populate('people', 'name');
 
     query.exec(function (err, lps) {
@@ -453,7 +509,7 @@ module.exports = function(mongoose, config) {
   LimitedPartner.statics.getSources = function(lpid, options, cb) {
 
     const self = this;
-    
+
     if (!cb) { throw new Error('cb is required'); }
     if (!lpid) { return cb(new Error('lpid is required'), null); }
     if (!mongoose.Types.ObjectId.isValid(lpid)) { return cb(new Error('lpid is not a valid ObjectId'), null); }
@@ -474,44 +530,44 @@ module.exports = function(mongoose, config) {
 
     query.exec(function(err, lp) {
 
-        if (err) { return cb(err, null); }
-        if (!lp) { return cb(null, null); }
-
-        Organization.collection.findById(options.CUSTOMER_ID, function(err, customer) {
+      if (err) { return cb(err, null); }
+      if (!lp) { return cb(null, null); }
 
-          if (err) { return cb(err, null); }
-          if (!customer) { return cb(null, null); }
+      Organization.collection.findById(options.CUSTOMER_ID, function(err, customer) {
 
-          let current = [];
-          let past = [];
-          let all = [];
-          let lpSources = helpers.getPeopleSources(lp.people);
+        if (err) { return cb(err, null); }
+        if (!customer) { return cb(null, null); }
 
-          _.each(customer.people, function(p) {
+        let current = [];
+        let past = [];
+        let all = [];
+        let lpSources = helpers.getPeopleSources(lp.people);
 
-            let source = _.find(lpSources, function(ls) {
-              if (!ls || !ls.person || !ls.person._id) return false;
-              return ls.person._id.toString() === p.person.toString();
-            });
+        _.each(customer.people, function(p) {
 
-            if (!source) { return; }
+          let source = _.find(lpSources, function(ls) {
+            if (!ls || !ls.person || !ls.person._id) return false;
+            return ls.person._id.toString() === p.person.toString();
+          });
 
-            if (p.current) { current.push(source); }
-            if (!p.current) { past.push(source); }
-            all.push(source);
+          if (!source) { return; }
 
-          });
+          if (p.current) { current.push(source); }
+          if (!p.current) { past.push(source); }
+          all.push(source);
 
-          return cb(null, {
-            all: helpers.sortPeopleSources(all, options.CUSTOMER_ID),
-            current: helpers.sortPeopleSources(current, options.CUSTOMER_ID),
-            past: helpers.sortPeopleSources(past, options.CUSTOMER_ID)
-          });
+        });
 
+        return cb(null, {
+          all: helpers.sortPeopleSources(all, options.CUSTOMER_ID),
+          current: helpers.sortPeopleSources(current, options.CUSTOMER_ID),
+          past: helpers.sortPeopleSources(past, options.CUSTOMER_ID)
         });
 
       });
 
+    });
+
   };
 
   LimitedPartner.statics.listByFund = function (fundId, options, cb) {
@@ -527,9 +583,9 @@ module.exports = function(mongoose, config) {
 
     options = helpers.getDefaultOptions(options);
 
-    let query = self.find({ 'fundsInvested.fund': fundId, customer: options.CUSTOMER_ID }, self.getReadFilterKeys(options.role));
+    let query = self.find({ 'transactions.fund': fundId, customer: options.CUSTOMER_ID }, self.getReadFilterKeys(options.role));
 
-    query.populate('fundsInvested.fund');
+    query.populate('transactions.fund');
     query.sort({ 'name': -1 });
     query.exec(cb);
 
@@ -555,15 +611,20 @@ module.exports = function(mongoose, config) {
 
   };
 
-  LimitedPartner.statics.removeCustomerCommitments = function removeCustomerCommitments(customerId, cb) {
+  LimitedPartner.statics.removeCustomerTransactions = function removeCustomerTransactions(customerId, cb) {
 
     const 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); }
+
     let query = self.update(
       { 'customer': customerId },
-      { $set: { fundsInvested: [] } },
+      { $set: { transactions: [] } },
       { multi : true }
     );
+
     query.exec(cb);
 
   };
@@ -591,7 +652,7 @@ module.exports = function(mongoose, config) {
       query = self.find({ 'name': new RegExp(terms, 'i'), customer: options.CUSTOMER_ID }, self.getReadFilterKeys(options.role));
     }
 
-    query.populate('fundsInvested.fund');
+    query.populate('transactions.fund');
     query.sort({ 'name': -1 });
     query.exec(cb);
 
@@ -649,4 +710,4 @@ module.exports = function(mongoose, config) {
 
   mongoose.model('LimitedPartner', LimitedPartner);
 
-};
+};

package/lib/Organization.js

@@ -179,6 +179,8 @@ module.exports = function(mongoose, config) {
 
         },
 
+        locale: { type: String, default: 'en-us', trim: true },
+
         beanstalk: {
           environmentName: { type: String, trim: true },
           restartOnPull: { type: Boolean, default: true }

package/lib/Round.js

@@ -147,6 +147,7 @@ module.exports = function(mongoose, config) {
       // construct the org
       var org = {
         _id: rounds[0].organization._id,
+        slug: rounds[0].organization.slug,
         name: rounds[0].organization.name,
         logoUrl: rounds[0].organization.logoUrl,
         description: rounds[0].organization.description,
@@ -650,7 +651,7 @@ module.exports = function(mongoose, config) {
     let query = self.find({ 'vehicles.fund': fundId });
 
     query.select('organization vehicles preMoneyValuation');
-    query.populate('organization', 'name logoUrl description contact filters status ipo closed acquired operating website websiteAliases');
+    query.populate('organization', 'name slug logoUrl description contact filters status ipo closed acquired operating website websiteAliases');
     query.populate('vehicles.fund');
 
     if (options.isWorkerProcess) {
@@ -698,7 +699,7 @@ module.exports = function(mongoose, config) {
     let query = self.find({ 'vehicles.fund': { $in: fundIds } });
 
     query.select('organization vehicles preMoneyValuation');
-    query.populate('organization', 'name logoUrl description contact chairs filters status ipo closed acquired operating website websiteAliases');
+    query.populate('organization', 'name slug logoUrl description contact chairs filters status ipo closed acquired operating website websiteAliases');
     query.deepPopulate([
       'organization.chairs.first',
       'organization.chairs.second',

package/lib/Sync.js

@@ -0,0 +1,47 @@
+"use strict";
+
+module.exports = function(mongoose, config) {
+
+  var
+
+    Schema = mongoose.Schema,
+    env = process.env.NODE_ENV || 'development',
+    _ = require('underscore');
+
+  var Sync = new Schema({
+    customer: { type: String, required: true },
+    syncedOn: { type: Date, required: true },
+    completedOn: { type: Date },
+    syncedBy: { type: String, trim: true },
+    steps: [{ 
+      _id: false,
+      name: { type: String, trim: true },
+      tasks: [{
+        _id: false,
+        name: { type: String, trim: true },
+        issues: [{ type: String, trim: true }],
+      }]
+    }]
+  });
+
+  Sync.statics.getById = function (id, customerId, cb) {
+
+    var self = this;
+
+    self.findOne({
+      '_id': id,
+      'customer': customerId
+    }).exec(cb);
+
+  };
+
+  Sync.statics.upsert = function(sync, cb) {
+    sync.syncedOn = new Date();
+    sync.save(cb);
+  };
+
+  Sync.set('autoIndex', false);
+
+  mongoose.model('Sync', Sync, 'syncs');
+
+};

package/package.json

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

package/test/LimitedPartner.js

@@ -116,10 +116,25 @@ describe('Limited Partner', function() {
     lp.name = 'United Testers';
     lp.customer = organization;
 
-    lp.fundsInvested.push({
+    // transactions: [{
+    //   fund: {type: Schema.ObjectId, ref: 'Fund'},
+    //   type: { type: String, enum: ['commitment', 'contribution', 'distribution'] },
+    //   amount: { type: Number, default: 0 },
+    //   date: { type: Date, default: null },
+    // }],
+
+    lp.transactions.push({
       fund: fund,
-      committed: 1000000,
-      called: 400000
+      type: 'commitment',
+      amount: 100000,
+      date: new Date()
+    });
+
+    lp.transactions.push({
+      fund: fund,
+      type: 'contribution',
+      amount: 400000,
+      date: new Date()
     });
 
     lp.contact.phone.push({