@dhyasama/totem-models 6.11.8 → 6.11.10

package/lib/Deal.js

@@ -148,8 +148,8 @@ module.exports = function(mongoose, config) {
       })
       .populate('organization', 'name logoUrl website websiteAliases')
       .populate('messages')
-      .populate('sources.person', 'name avatarUrl title')
-      .populate('referrers.person', 'name avatarUrl title')
+      .populate('source.person', 'name avatarUrl title')
+      .populate('referrer.person', 'name avatarUrl title')
       .populate({
         path: 'documents',
         match: { customer: config.CUSTOMER_ID }
@@ -177,8 +177,8 @@ module.exports = function(mongoose, config) {
       .find(terms)
       .populate('organization', 'name description logoUrl website websiteAliases chairs')
       .populate('messages')
-      .populate('sources.person', 'name avatarUrl title')
-      .populate('referrers.person', 'name avatarUrl title')
+      .populate('source.person', 'name avatarUrl title')
+      .populate('referrer.person', 'name avatarUrl title')
       .populate({
         path: 'documents',
         match: { customer: customerId }
@@ -224,8 +224,8 @@ module.exports = function(mongoose, config) {
       })
       .populate('organization', 'name logoUrl website websiteAliases')
       .populate('messages')
-      .populate('sources.person', 'name avatarUrl title')
-      .populate('referrers.person', 'name avatarUrl title')
+      .populate('source.person', 'name avatarUrl title')
+      .populate('referrer.person', 'name avatarUrl title')
       .populate({
         path: 'documents',
         match: { customer: config.CUSTOMER_ID }

package/lib/Organization.js

@@ -206,14 +206,84 @@ module.exports = function(mongoose, config) {
 
           active: { type: Boolean, default: false },
 
-          stages: [{
+          statuses: [{
             name: { type: String, trim: true },
             order: { type: Number },
             active: { type: Boolean, default: true },
             color: { type: String, trim: true }
           }],
 
-          fields: [{
+          standardFields: {
+
+            // Standard fields are always "on" in the system
+            // They can be configured in how they work on the deal list page
+            // order for standard fields only sets the order on the list page. their position is fixed on the org page deal section and edit form.
+            // order is co-mingled with order for custom fields
+            // colspan is for the number of columns the field should take up on the list page
+            // showOnFilter controls whether values are extracted and used in filtering options on list page
+            // showOnList controls if the field will be on deal list page
+
+            action: {
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            },
+
+            raise: {
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            },
+
+            valuation: {
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            },
+
+            sourcePerson: {
+              types: [ { type: String, trim: true } ],
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            },
+
+            sourceType: {
+              types: [ { type: String, trim: true } ],
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            },
+
+            referrerPerson: {
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            },
+
+            referrerType: {
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            },
+
+            chairs: {
+              order: { type: Number, default: 99 },
+              colspan: { type: Number, default: 1 },
+              showOnFilter: { type: Boolean, default: true },
+              showOnList: { type: Boolean, default: true }
+            }
+
+          },
+
+          customFields: [{
 
             // Data stored on deals will be accessed with this key
             // It must follow standard js variable naming rules
@@ -222,9 +292,6 @@ module.exports = function(mongoose, config) {
             // Changing it after data is in the system will make data on deal inaccessible
             key: { type: String, trim: true },
 
-            // this sets whether the field is a custom field
-            isStandard: false,
-
             // User friendly text, will be displayed
             label: { type: String, trim: true },
 
@@ -256,12 +323,13 @@ module.exports = function(mongoose, config) {
               // colspan is for the number of columns the field should take up on the list page
               colspan: { type: Number, default: 1 },
 
-              // showOnList controls if the field will be on deal list page
-              showOnList: { type: Boolean, default: true },
-
               // showOnFilter controls whether values are extracted and used in filtering options on list page
               showOnFilter: { type: Boolean, default: true },
 
+              // showOnList controls if the field will be on deal list page
+              // fields are always shown on org pages and in edit forms
+              showOnList: { type: Boolean, default: true }
+
             }
 
           }]
@@ -440,7 +508,7 @@ module.exports = function(mongoose, config) {
 
   });
 
-  Organization.virtual('customer.deals.activeStages').get(function () {
+  Organization.virtual('customer.deals.activeStatuses').get(function () {
 
     var self = this;
 
@@ -450,12 +518,163 @@ module.exports = function(mongoose, config) {
     // Deals aren't on for customer
     else if (!self.customer.deals.active) return [];
 
-    // Get active stage names and sort them
-    var stages = _.filter(self.customer.deals.stages, function(s) { return s.active; });
-    stages = _.sortBy(stages, 'order');
-    stages = _.pluck(stages, 'name');
+    // Get active status names and sort them
+    var statuses = _.filter(self.customer.deals.statuses, function(s) { return s.active; });
+    statuses = _.sortBy(statuses, 'order');
+    statuses = _.pluck(statuses, 'name');
+
+    return statuses;
+
+  });
+
+  Organization.virtual('customer.deals.fields').get(function () {
+
+    // Combine standard fields and custom fields into a single list and sort by column order
+    // Fundraise is actually two fields, so multiply the order by ten to make room for the extra field
+
+    var self = this;
 
-    return stages;
+    var standardFields = self.customer.deals.standardFields;
+
+    // Defaulting to off so it will be immediately apparent the customer hasn't been properly configured
+    standardFields = standardFields || {
+      fundraise: {
+        showOnList: false
+      },
+      sources: {
+        showOnList: false
+      },
+      referrers: {
+        showOnList: false
+      }
+    };
+
+    var customFields = self.customer.deals.customFields;
+    var result = [];
+
+    // Add standard fields
+    if (standardFields.action.showOnList) {
+      result.push({
+        name: 'Next Steps',
+        type: 'Text',
+        key: 'action',
+        isStandard: true,
+        order: standardFields.action.order * 10,
+        colspan: standardFields.action.colspan || 1,
+        showOnFilter: standardFields.action.showOnFilter === true ? true : false
+      });
+    }
+
+    if (standardFields.raise.showOnList) {
+      result.push({
+        name: 'Raise',
+        type: 'Money',
+        key: 'fundraise.amount',
+        isStandard: true,
+        order: standardFields.raise.order * 10,
+        colspan: standardFields.raise.colspan || 1,
+        showOnFilter: standardFields.raise.showOnFilter === true ? true : false
+      });
+    }
+
+    if(standardFields.valuation.showOnList) {
+      result.push({
+        name: 'Valuation',
+        type: 'Money',
+        key: 'fundraise.valuation',
+        isStandard: true,
+        order: standardFields.valuation.order * 10 + 1,
+        colspan: standardFields.valuation.colspan || 1,
+        showOnFilter: standardFields.valuation.showOnFilter === true ? true : false
+      });
+    }
+
+    if (standardFields.sourcePerson.showOnList) {
+      result.push({
+        name: 'Source Person',
+        type: 'Reference',
+        key: 'source.person',
+        isStandard: true,
+        order: standardFields.sourceName.order * 10,
+        colspan: standardFields.sourceName.colspan || 1,
+        showOnFilter: standardFields.sourceName.showOnFilter === true ? true : false
+      });
+    }
+
+    if (standardFields.sourceType.showOnList) {
+      result.push({
+        name: 'Source Type',
+        type: 'Single Select',
+        key: 'source.type',
+        isStandard: true,
+        order: standardFields.sourceType.order * 10,
+        colspan: standardFields.sourceType.colspan || 1,
+        showOnFilter: standardFields.sourceType.showOnFilter === true ? true : false
+      });
+    }
+
+    if (standardFields.referrerPerson.showOnList) {
+      result.push({
+        name: 'Referrer Person',
+        type: 'Reference',
+        key: 'referrer.person',
+        isStandard: true,
+        order: standardFields.referrerName.order * 10,
+        colspan: standardFields.referrerName.colspan || 1,
+        showOnFilter: standardFields.referrerName.showOnFilter === true ? true : false
+      });
+    }
+
+    if (standardFields.referrerType.showOnList) {
+      result.push({
+        name: 'Referrer Type',
+        type: 'Single Select',
+        key: 'referrer.type',
+        isStandard: true,
+        order: standardFields.referrerType.order * 10,
+        colspan: standardFields.referrerType.colspan || 1,
+        showOnFilter: standardFields.referrerType.showOnFilter === true ? true : false
+      });
+    }
+
+    if (standardFields.chairs.showOnList) {
+      result.push({
+        name: 'Leads',
+        type: 'Reference',
+        key: 'organization.chairs',
+        isStandard: true,
+        order: standardFields.chairs.order * 10,
+        colspan: standardFields.chairs.colspan || 1,
+        showOnFilter: standardFields.chairs.showOnFilter === true ? true : false
+      });
+    }
+
+    // Add custom fields
+    _.each(customFields, function(field) {
+      if (field.display.showOnList) {
+        result.push({
+          name: field.label,
+          type: field.type,
+          isStandard: false,
+          key: field.key,
+          options: field.options,
+          order: field.display.order * 10,
+          colspan: field.display.colspan || 1,
+          showOnFilter: field.display.showOnFilter === true ? true : false
+        });
+      }
+    });
+
+    // Sort the combined standard and custom fields
+    result = _.sortBy(result, function(item) { return item.order; });
+
+    // Now that we have all fields combined and ordered, make column order zero-indexed and gap-free
+    result = _.map(result, function(item, index) {
+      item.order = index;
+      return item;
+    });
+
+    return result;
 
   });
 
@@ -755,10 +974,10 @@ module.exports = function(mongoose, config) {
         if (err) return callback(err, null);
         else if (!org) return callback(new Error('Customer not found'), null);
 
-        var stages = org.customer.deals.activeStatuses;
+        var statuses = org.customer.deals.activeStatuses;
 
-        var match = _.find(stages, function(stage) {
-          return stage == previous.deal.stage;
+        var match = _.find(statuses, function(status) {
+          return status == previous.deal.stage;
         });
 
         if (!match) return callback(new Error('This stage is not valid for this customer'), null);
@@ -1823,4 +2042,4 @@ module.exports = function(mongoose, config) {
 
   mongoose.model('Organization', Organization, 'organizations');
 
-};
+};

package/package.json

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