@dhyasama/totem-models 6.35.0 → 7.0.0

package/lib/Financials.js

@@ -23,13 +23,29 @@ module.exports = function(mongoose, config) {
 
     currency: { type: String, required: true, default: 'USD' },
 
+    notifications: {
+
+      company: {
+
+        contact: {
+
+          exclude: { type: Boolean, default: false, required: true },
+          email: { type: String, trim: true },
+          name: { type: String, trim: true }
+
+        }
+
+      }
+
+    },
+
     snapshots: [{
-      
+
       uuid: { type: String },
-      
+
       year: { type: Number, default: 0 },
-      quarter: { type: String, enum: ['all', 'q1', 'q2', 'q3', 'q4'] },
-      
+      period: { type: String, enum: ['Annual', 'Q1', 'Q2', 'Q3', 'Q4', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'] },
+
       cash: {
         amount: { type: Number, default: 0 },
       },
@@ -42,11 +58,11 @@ module.exports = function(mongoose, config) {
       },
       runway: {
         amount: { type: Number, default: 0 },
-        period: { type: String, enum: [null, 'monthly', 'quarterly', 'yearly']},        
+        period: { type: String, enum: [null, 'monthly', 'quarterly', 'yearly']},
       },
 
       // income statement
-      revenue: { 
+      revenue: {
         amount: { type: Number, default: 0 },
         projected: { type: Number, default: 0 },
         breakdown: [{
@@ -55,7 +71,7 @@ module.exports = function(mongoose, config) {
           _id: false
         }]
       },
-      operatingExpenses: { 
+      operatingExpenses: {
         amount: { type: Number, default: 0 },
         projected: { type: Number, default: 0 },
         breakdown: [{
@@ -64,7 +80,7 @@ module.exports = function(mongoose, config) {
           _id: false
         }]
       },
-      grossProfit: { 
+      grossProfit: {
         amount: { type: Number, default: 0 },
         projected: { type: Number, default: 0 },
         breakdown: [{
@@ -73,7 +89,7 @@ module.exports = function(mongoose, config) {
           _id: false
         }]
       },
-      operatingIncome: { 
+      operatingIncome: {
         amount: { type: Number, default: 0 },
         projected: { type: Number, default: 0 },
         breakdown: [{
@@ -95,13 +111,61 @@ module.exports = function(mongoose, config) {
         _id: false
       }],
 
+      // Catch-all for customer specific key-value pairs from sheet that aren't supported by our schema
+      details: [{
+        key: { type: String, trim: true },
+        value: { type: String, trim: true },
+        _id: false
+      }],
+
       comment: { type: String, trim: true },
       documents: [ { type: Schema.ObjectId, ref: 'Document' } ],
 
       submittedOn: { type: Date, index: false },
-      submittedBy: { type: String, trim: true }
-      
-    }],
+      submittedBy: { type: String, trim: true },
+
+      notifications: {
+
+        company: {
+
+          sendTo: {
+            email: { type: String, trim: true },
+            name: { type: String, trim: true }
+          },
+
+          initial: {
+            sendOn: { type: Date, required: false },
+            sentOn: { type: Date, required: false },
+            postmarkMessageId: { type: String, trim: true },
+            status: { type: String, enum: [null, 'Sent', 'Bounced', 'Delivered', 'Opened', 'Clicked']}
+          },
+
+          reminder: {
+            sendOn: { type: Date, required: false },
+            sentOn: { type: Date, required: false },
+            postmarkMessageId: { type: String, trim: true },
+            status: { type: String, enum: [null, 'Sent', 'Bounced', 'Delivered', 'Opened', 'Clicked']}
+          },
+
+          history: [{
+            email: { type: String, trim: true },
+            postmarkMessageId: { type: String, trim: true },
+            status: { type: String, enum: [null, 'Sent', 'Bounced', 'Delivered', 'Opened', 'Clicked']}
+          }]
+
+        },
+
+        share: {
+          recipients: [{
+            email: { type: String, trim: true },
+            postmarkMessageId: { type: String, trim: true },
+            status: { type: String, enum: [null, 'Sent', 'Bounced', 'Delivered', 'Opened', 'Clicked']}
+          }]
+        }
+
+      }
+
+    }]
     
   });
 
@@ -110,6 +174,36 @@ module.exports = function(mongoose, config) {
   // Properties that are not persisted to the database
   ///////////////////////////////////////////////////////////////////////////////////////
 
+  Financials.virtual('snapshotNames').get(function () {
+    return _.map(this.snapshots, function(snapshot) {
+      return snapshot.year + ' ' + snapshot.period;
+    });
+  });
+
+
+
+  ///////////////////////////////////////////////////////////////////////////////////////
+  // METHODS
+  // Methods operate on a single document
+  ///////////////////////////////////////////////////////////////////////////////////////
+
+  Financials.methods.snapshotStatus = function(uuid) {
+
+    if (!uuid) { return null; }
+
+    var snapshot = _.find(this.snapshots, function(s) {
+      if (!s || !s.uuid) { return; }
+      return s.uuid.toLowerCase() === uuid.toLowerCase();
+    });
+
+    if (!snapshot) { return null; }
+    else if (snapshot.submittedOn) { return "Submitted"; }
+    else if (snapshot.notifications.company.reminder.status) { return snapshot.notifications.company.reminder.status; }
+    else if (snapshot.notifications.company.initial.status) { return snapshot.notifications.company.initial.status; }
+    else { return null; }
+
+  };
+
 
 
   //////////////////////////////////////////////////////
@@ -121,7 +215,7 @@ module.exports = function(mongoose, config) {
 
     var self = this;
 
-    var query = self.find({
+    var query = self.findOne({
       'customer': customerId,
       'organization': orgId
     }).populate({
@@ -133,20 +227,138 @@ module.exports = function(mongoose, config) {
 
   };
 
+  Financials.statics.getByPostmarkMessageId = function getByPostmarkMessageId(postmarkMessageId, cb) {
+
+    var self = this;
+
+    var query = self.findOne({
+      $or: [
+        { "snapshots.notifications.company.initial.postmarkMessageId": postmarkMessageId },
+        { "snapshots.notifications.company.reminder.postmarkMessageId": postmarkMessageId }
+      ]
+    });
+
+    query.exec(cb);
+
+  };
+
   Financials.statics.getByUUID = function getByUUID(customerId, uuid, cb) {
 
     var self = this;
 
+    var query = self.findOne({
+      'customer': customerId,
+      'snapshots.uuid': uuid
+    });
+
+    query.populate('organization', 'name logoUrl');
+    query.populate('customer', 'name logoUrl ');
+    query.populate({
+      path: 'snapshots.documents',
+      match: { customer: customerId }
+    });
+
+    query.exec(cb);
+
+  };
+
+  Financials.statics.getForCampaign = function getForCampaign(customerId, cb) {
+
+    var self = this;
+
     var query = self.find({
       'customer': customerId,
+      'notification.contact.exclude': { $ne: true }, // null, false, or non-existing field
+      'notification.contact.email': { $ne: null } // field exists and has a value
+    });
+
+    query.exec(cb);
+
+  };
+
+  Financials.statics.getForCustomer = function getForCustomer(customerId, cb) {
+
+    var self = this;
+
+    var query = self.find({
+      'customer': customerId
+    });
+
+    query.exec(cb);
+
+  };
+
+  Financials.statics.getToSend = function getToSend(uuid, cb) {
+
+    var self = this;
+
+    var query = self.findOne({
       'snapshots.uuid': uuid
     });
 
-    query.populate('organization', 'name logoUrl')
+    query.populate('organization', 'name logoUrl');
+    query.populate('customer', 'name logoUrl customer.totemUrl');
+
     query.exec(cb);
 
   };
 
+  Financials.statics.getUUIDsToSendInitial = function getUUIDsToSendInitial(cb) {
+
+    var self = this;
+    var now = new Date();
+
+    var query = self.find({
+      "snapshots.notifications.company.initial.sendOn": { $lte: now },
+      "snapshots.notifications.company.initial.sentOn": null
+    });
+
+    query.exec(function(err, result) {
+
+      if (err) { return cb(err, null); }
+
+      var snapshots = _.pluck(result || [], 'snapshots');
+
+      snapshots = _.flatten(snapshots);
+
+      snapshots = _.filter(snapshots, function(snapshot) {
+        return snapshot.notifications.company.initial.sendOn < now && !snapshot.notifications.company.initial.sentOn;
+      });
+
+      return cb(null, _.pluck(snapshots, 'uuid'));
+
+    });
+
+  };
+
+  Financials.statics.getUUIDsToSendReminder = function getUUIDsToSendReminder(cb) {
+
+    var self = this;
+    var now = new Date();
+
+    var query = self.find({
+      "snapshots.notifications.company.reminder.sendOn": { $lte: now },
+      "snapshots.notifications.company.reminder.sentOn": null
+    });
+
+    query.exec(function(err, result) {
+
+      if (err) { return cb(err, null); }
+
+      var snapshots = _.pluck(result || [], 'snapshots');
+
+      snapshots = _.flatten(snapshots);
+
+      snapshots = _.filter(snapshots, function(snapshot) {
+        return snapshot.notifications.company.reminder.sendOn < now && !snapshot.notifications.company.reminder.sentOn;
+      });
+
+      return cb(null, _.pluck(snapshots, 'uuid'));
+
+    });
+
+  };
+
   Financials.statics.removeCustomerFinancials = function removeCustomerFinancials(customerId, cb) {
 
     // this is only used to wipe out financials created by the google sheet import process
@@ -164,10 +376,11 @@ module.exports = function(mongoose, config) {
   };
 
   Financials.statics.upsert = function upsert(financials, cb) {
+
     if (!financials) { return cb(new Error('financials is required'), null); }
-    financials.save(function(err, result) {
-      return cb(null, result);
-    });
+
+    financials.save(cb);
+
   };
 
 

package/lib/Organization.js

@@ -401,7 +401,19 @@ module.exports = function(mongoose, config) {
       // Funds belonging to this organization (which is typically, but not necessarily, what we'd call an investor)
       // An example of a non-"investor" with funds would be Slack with it's Slack Fund
       // Another way to put it, these are funds from which this organization makes investments
-      funds: [{ type: Schema.ObjectId, ref: 'Fund' }]
+      funds: [{ type: Schema.ObjectId, ref: 'Fund' }],
+
+      financials: [{
+
+        customer: { type: Schema.ObjectId, ref: 'Organization' },
+
+        // ok to send emails to collect financials
+        allowed: { type: Boolean, default: true },
+
+        // email to send link to
+        email: { type: String, trim: true }
+
+      }]
 
     });
 

package/package.json

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