@dhyasama/totem-models 11.112.0 → 11.114.0

package/lib/Financials.js

@@ -61,7 +61,7 @@ module.exports = function(mongoose, config) {
         month: { type: Number, default: 12 },
         day: { type: Number, default: 31 },
       },
-      review: { type: Boolean, default: false },
+      approval: { type: Boolean, default: false },
 
       // For reminding customer about upcoming collections
       // Don't store recipients, just query admins at time of sending or check postmark post-facto
@@ -78,9 +78,9 @@ module.exports = function(mongoose, config) {
 
       currency: { type: String, default: 'USD' },
 
-      review: { type: Boolean, default: false },
+      approval:{ type: Boolean, default: false },
 
-      status: { type: String, enum: ['Created', 'Scheduled', 'Delivered', 'Opened', 'Overdue', 'In Review', 'Completed', 'Archived'] },
+      status: { type: String, enum: ['Created', 'Scheduled', 'Delivered', 'Opened', 'Delayed', 'Unapproved', 'Completed', 'Archived'] },
 
       year: { type: Number, default: 0 },
       period: { type: String, enum: ['FY', 'H1', 'H2', 'Q1', 'Q2', 'Q3', 'Q4', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'] },
@@ -88,6 +88,8 @@ module.exports = function(mongoose, config) {
       form: [{
         name: { type: String, trim: true },
         type: { type: String, enum: [null, 'header', 'block', 'document', 'metric', 'question'] },
+        budget: { type: Number },
+        forecast: { type: Number },
         required: { type: Boolean, default: false }
       }],
       
@@ -95,19 +97,36 @@ module.exports = function(mongoose, config) {
         _id: false,
         name: { type: String, trim: true },
         document: { type: Schema.ObjectId, ref: 'Document' },
+        verified: { type: Boolean, default: false },
       }],
 
       metrics: [{
         _id: false,
         name: { type: String, trim: true },
-        actual: { type: Number },
-        breakdown: { type: Schema.Types.Mixed }
+        scenario: { type: String, enum: ['actual', 'budget', 'forecast'] },
+        value: { type: Number },
+        breakdown: { type: Schema.Types.Mixed },
+        source: {
+          _id: false,
+          model: {
+            type: String,
+            enum: ['Document', 'Meeting', 'Message', 'Note'],
+            required: true,
+          },
+          ref: {
+            type: Schema.Types.ObjectId,
+            required: true,
+            refPath: 'metrics.source.model',
+          },
+        },
+        verified: { type: Boolean, default: false },
       }],
       
       questions: [{
         _id: false,
         prompt: { type: String, trim: true },
         response: { type: String, trim: true },
+        verified: { type: Boolean, default: false },
       }],
 
       dueOn: { type: Date, index: false },
@@ -203,11 +222,7 @@ module.exports = function(mongoose, config) {
 
       }
 
-    }],
-
-    projections: [
-
-    ]
+    }]
     
   });
 
@@ -927,14 +942,14 @@ module.exports = function(mongoose, config) {
 
   };
 
-  Financials.statics.getPassivelyOverdue = function getPassivelyOverdue(cb) {
+  Financials.statics.getOverdue = function getOverdue(cb) {
 
     const self = this;
 
     const query = self.find({
       'snapshots': {
         $elemMatch: {
-          'status': { $nin: ['Completed', 'Archived', 'Overdue'] },
+          'status': { $nin: ['Completed', 'Archived', 'Delayed'] },
           'dueOn': { $lte: new Date() }
         }
       }
@@ -944,14 +959,6 @@ module.exports = function(mongoose, config) {
 
   };
 
-  Financials.statics.markAsOverdue = function markAsOverdue(financials, cb) {
-
-    if (!financials) { return cb(new Error('financials is required'), null); }
-
-    financials.save(cb);
-
-  };
-
   Financials.statics.updateProperty = function updateProperty(id, key, value, cb) {
 
     const self = this;
@@ -1000,12 +1007,12 @@ module.exports = function(mongoose, config) {
 
       if (!snapshot) return;
 
-      var needsReview = snapshot.review;
+      var needsApproval = snapshot.approval;
       var isSubmitted = snapshot.submittedOn;
       var isApproved = snapshot.approvedOn;
       var isRejected = snapshot.rejectedOn && snapshot.rejection;
       var isArchived = snapshot.archivedOn;
-      var isOverdue = snapshot.dueOn ? moment(new Date()).isAfter(moment(snapshot.dueOn)) : false;
+      var isDelayed = snapshot.dueOn ? moment(new Date()).isAfter(moment(snapshot.dueOn)) : false;
 
       var isOpened = false;
       var isDelivered = false;
@@ -1017,12 +1024,12 @@ module.exports = function(mongoose, config) {
       }
 
       if(!snapshot.uuid) snapshot.status = 'Completed'; // no uuid means the snapshot was created from the google sheet and should always be completed
-      else if(needsReview && isApproved) snapshot.status = 'Completed';
-      else if(!needsReview && isSubmitted) snapshot.status = 'Completed';
+      else if(needsApproval && isApproved) snapshot.status = 'Completed';
+      else if(!needsApproval && isSubmitted) snapshot.status = 'Completed';
       else if(isArchived) snapshot.status = 'Archived';
-      else if(needsReview && isSubmitted && !isRejected) snapshot.status = 'In Review';
-      else if(needsReview && isSubmitted && isRejected) snapshot.status = 'Opened';
-      else if(isOverdue) snapshot.status = 'Overdue';
+      else if(needsApproval && isSubmitted && !isRejected) snapshot.status = 'Unapproved';
+      else if(needsApproval && isSubmitted && isRejected) snapshot.status = 'Opened';
+      else if(isDelayed) snapshot.status = 'Delayed';
       else if(isDelivered && isOpened) snapshot.status = 'Opened';
       else if(isDelivered) snapshot.status = 'Delivered';
       else if(isScheduled) snapshot.status = 'Scheduled'; // when a snapshot is scheduled, but not yet sent (checks every 5 minutes)

package/package.json

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