@dhyasama/totem-models 8.77.0 → 8.79.0

package/lib/Financials.js

@@ -41,7 +41,7 @@ module.exports = function(mongoose, config) {
       form: [{
         _id: false,
         name: { type: String, trim: true },
-        type: { type: String, enum: [null, 'block', 'document', 'metric', 'question']}
+        type: { type: String, enum: [null, 'block', 'message', 'document', 'metric', 'question']}
       }],
 
       cash: {

package/lib/Organization.js

@@ -193,6 +193,15 @@ module.exports = function(mongoose, config) {
           active: { type: Boolean, default: false }
         },
 
+        sheet: {
+          id: { type: String, trim: true, unique: true, partialFilterExpression : { type :"string" } },
+          format: {
+            transformRounds: { type: Boolean, default: false },
+            transformUnrealized: { type: Boolean, default: false },
+            transformRealized: { type: Boolean, default: false }
+          }
+        },
+
         portfolio: {
 
           reports: [{
@@ -215,71 +224,75 @@ module.exports = function(mongoose, config) {
               width: { type: Number, default: 150 }
             }],
             view: { type: String, trim: true }
-          }],
+          }]
 
-          financials: {
-            active: { type: Boolean, default: false },
-            managedServices: { type: Boolean, default: false },
-            reminders: { type: [Number], default: [7, 7, 7] },
+        },
 
-            messages: [{
-              _id: false,
-              name: { type: String, trim: true },
-              html: { type: String, trim: true }
-            }],
-            templates: [{
-              _id: false,
-              name: { type: String, trim: true },
-              form: [{
-                _id: false,
-                name: { type: String, trim: true },
-                type: { type: String, enum: [null, 'block', 'document', 'metric', 'question']}
-              }]
-            }],
-            documents: [{
-              _id: false,
-              name: { type: String, trim: true },
-              description: { type: String, trim: true },
-              required: { type: Boolean, default: false }
-            }],
-            metrics: [{
-              _id: false,
-              name: { type: String, trim: true },
-              description: { type: String, trim: true },
-              format: { type: String, enum: [null, 'number', 'money', 'percentage', 'variance']},
-              required: { type: Boolean, default: false }
-            }],
-            questions: [{
-              _id: false,
-              prompt: { type: String, trim: true },
-              required: { type: Boolean, default: false }
-            }]
-          },
+        financials: {
 
-          irr: {
-            active: { type: Boolean, default: false },
-          },
+          active: { type: Boolean, default: false },
+          
+          managedServices: { type: Boolean, default: false },
+          reminders: { type: [Number], default: [7, 7, 7] },
 
           carta: {
-            active: { type: Boolean, default: false },
-            firmid: { type: String, unique: true, partialFilterExpression : { type :"string" }, trim: true }
+            active: { type: Boolean, default: false }
           },
 
-          investmentsSheet: {
-            sheet: { type: String, trim: true, unique: true, partialFilterExpression : { type :"string" } },
-            format: {
-              transformRounds: { type: Boolean, default: false },
-              transformUnrealized: { type: Boolean, default: false },
-              transformRealized: { type: Boolean, default: false }
+          messages: [{
+            _id: false,
+            name: { type: String, trim: true },
+            html: { type: String, trim: true }
+          }],
+          templates: [{
+            _id: false,
+            name: { type: String, trim: true },
+            form: [{
+              _id: false,
+              name: { type: String, trim: true },
+              type: { type: String, enum: [null, 'block', 'document', 'metric', 'question']}
+            }]
+          }],
+          documents: [{
+            _id: false,
+            name: { type: String, trim: true },
+            description: { type: String, trim: true },
+            required: { type: Boolean, default: false }
+          }],
+          metrics: [{
+            _id: false,
+            name: { type: String, trim: true },
+            description: { type: String, trim: true },
+            format: { type: String, enum: [null, 'number', 'money', 'percentage', 'variance']},
+            required: { type: Boolean, default: false }
+          }],
+          questions: [{
+            _id: false,
+            prompt: { type: String, trim: true },
+            required: { type: Boolean, default: false }
+          }],
+
+          reports: [{
+            name: { type: String, trim: true },
+            filters: [{
+              _id: false,
+              key: { type: String, trim: true },
+              condition: { type: String, enum: [null, 'equals', 'doesNotEqual', 'contains', 'doesNotContain', 'lessThan', 'greaterThan']},
+              values: [{ type: String, trim: true }]
+            }],
+            sort: { 
+              by: { type: String, trim: true },
+              reverse: { type: Boolean, default: false }
             },
-            googleSheetCreds: {
-              private_key_id: { type: String, trim: true, unique: true, partialFilterExpression : { type :"string" } },
-              private_key: { type: String, trim: true, unique: true, partialFilterExpression : { type :"string" } },
-              client_email: { type: String, trim: true, unique: true, partialFilterExpression : { type :"string" } },
-              client_id: { type: String, trim: true, unique: true, partialFilterExpression : { type :"string" } },
-              type: { type: String, trim: true }
-            }
-          }
+            fields: [{
+              _id: false,
+              key: { type: String, trim: true },
+              label: { type: String, trim: true },
+              total: { type: String, enum: [null, 'sum', 'average', 'count', 'multiple']},
+              width: { type: Number, default: 150 }
+            }],
+            view: { type: String, trim: true }
+          }]
 
         },
 
@@ -295,146 +308,97 @@ module.exports = function(mongoose, config) {
           }],
 
           sourceTypes: { type: Array, default: ['Cold Inbound', 'Cold Outbound', 'Met at Event', 'Was Referred', 'Other'] },
-
           referrerTypes: { type: Array, default: ['Founder', 'Investor', 'Service Provider', 'Friends & Family', 'Limited Partner', 'Other'] },
 
-          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 }
+          reports: [{
+            name: { type: String, trim: true },
+            filters: [{
+              _id: false,
+              key: { type: String, trim: true },
+              condition: { type: String, enum: [null, 'equals', 'doesNotEqual', 'contains', 'doesNotContain', 'lessThan', 'greaterThan']},
+              values: [{ type: String, trim: true }]
+            }],
+            sort: { 
+              by: { type: String, trim: true },
+              reverse: { type: Boolean, default: false }
             },
+            fields: [{
+              _id: false,
+              key: { type: String, trim: true },
+              label: { type: String, trim: true },
+              total: { type: String, enum: [null, 'sum', 'average', 'count', 'multiple']},
+              width: { type: Number, default: 150 }
+            }],
+            view: { type: String, trim: true }
+          }]
 
-            valuation: {
-              order: { type: Number, default: 99 },
-              colspan: { type: Number, default: 1 },
-              showOnFilter: { type: Boolean, default: true },
-              showOnList: { type: Boolean, default: true }
-            },
+        },
 
-            sourcePerson: {
-              order: { type: Number, default: 99 },
-              colspan: { type: Number, default: 1 },
-              showOnFilter: { type: Boolean, default: true },
-              showOnList: { type: Boolean, default: true }
-            },
+        funds: {
 
-            sourceType: {
-              order: { type: Number, default: 99 },
-              colspan: { type: Number, default: 1 },
-              showOnFilter: { type: Boolean, default: true },
-              showOnList: { type: Boolean, default: true }
-            },
+          irr: {
+            active: { type: Boolean, default: false },
+          },
 
-            referrerPerson: {
-              order: { type: Number, default: 99 },
-              colspan: { type: Number, default: 1 },
-              showOnFilter: { type: Boolean, default: true },
-              showOnList: { type: Boolean, default: true }
+          reports: [{
+            name: { type: String, trim: true },
+            filters: [{
+              _id: false,
+              key: { type: String, trim: true },
+              condition: { type: String, enum: [null, 'equals', 'doesNotEqual', 'contains', 'doesNotContain', 'lessThan', 'greaterThan']},
+              values: [{ type: String, trim: true }]
+            }],
+            sort: { 
+              by: { type: String, trim: true },
+              reverse: { type: Boolean, default: false }
             },
+            fields: [{
+              _id: false,
+              key: { type: String, trim: true },
+              label: { type: String, trim: true },
+              total: { type: String, enum: [null, 'sum', 'average', 'count', 'multiple']},
+              width: { type: Number, default: 150 }
+            }],
+            view: { type: String, trim: 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 }
-            },
+        lps: {
 
-            location: {
-              order: { type: Number, default: 99 },
-              colspan: { type: Number, default: 1 },
-              showOnFilter: { type: Boolean, default: true },
-              showOnList: { type: Boolean, default: true }
-            }
+          active: { type: Boolean, default: false },
 
+          irr: {
+            active: { type: Boolean, default: false },
           },
 
-          customFields: [{
-
-            // Data stored on deals will be accessed with this key
-            // It must follow standard js variable naming rules
-            // Whenever possible, just use the label and replace spaces with underscore
-            // Will not be displayed
-            // Changing it after data is in the system will make data on deal inaccessible
-            key: { type: String, trim: true },
-
-            // User friendly text, will be displayed
-            label: { type: String, trim: true },
-
-            // Dictates the type of control rendered on form
-            // Also impacts data validation
-            type: { type: String, enum: ['Text', 'Number', 'Money', 'Tags', 'Poll', 'Checkbox', 'Single Select', 'Multiple Select'] },
-
-            // These will be the choices in polls, single-selects and multi-selects
-            options: [{
-
-              // This is the option shown to users
+          reports: [{
+            name: { type: String, trim: true },
+            filters: [{
+              _id: false,
+              key: { type: String, trim: true },
+              condition: { type: String, enum: [null, 'equals', 'doesNotEqual', 'contains', 'doesNotContain', 'lessThan', 'greaterThan']},
+              values: [{ type: String, trim: true }]
+            }],
+            sort: { 
+              by: { type: String, trim: true },
+              reverse: { type: Boolean, default: false }
+            },
+            fields: [{
+              _id: false,
+              key: { type: String, trim: true },
               label: { type: String, trim: true },
-
-              // This is the value that gets stored
-              value: { type: String, trim: true },
-
-              // This is used to aggregate answers for polls
-              type: { type: String, enum: ['String', 'Number', 'Boolean'] }
-
+              total: { type: String, enum: [null, 'sum', 'average', 'count', 'multiple']},
+              width: { type: Number, default: 150 }
             }],
-
-            // For controlling display on web pages
-            display: {
-
-              // sets the order to render fields on list, org page deal section and deal edit form
-              // order is co-mingled with order for standard fields
-              order: { type: Number },
-
-              // colspan is for the number of columns the field should take up on the list page
-              colspan: { type: Number, default: 1 },
-
-              // 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 }
-
-            }
-
+            view: { type: String, trim: true }
           }]
 
         },
 
-        lps: {
-
-          active: {type: Boolean, default: false},
-
-        },
-
         lists: {
 
-          active: {type: Boolean, default: false},
+          active: { type: Boolean, default: false },
 
         }
 
@@ -451,22 +415,9 @@ module.exports = function(mongoose, config) {
       // Another way to put it, these are funds from which this organization makes investments
       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 }
-
-      }]
-
     });
 
 
-
   ///////////////////////////////////////////////////////////////////////////////////////
   // VIRTUALS
   // Properties that are not persisted to the database
@@ -600,169 +551,6 @@ module.exports = function(mongoose, config) {
 
   });
 
-  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;
-
-    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',
-        type: 'Reference',
-        key: 'source.person',
-        isStandard: true,
-        order: standardFields.sourcePerson.order * 10,
-        colspan: standardFields.sourcePerson.colspan || 1,
-        showOnFilter: standardFields.sourcePerson.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',
-        type: 'Reference',
-        key: 'referrer.person',
-        isStandard: true,
-        order: standardFields.referrerPerson.order * 10,
-        colspan: standardFields.referrerPerson.colspan || 1,
-        showOnFilter: standardFields.referrerPerson.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
-      });
-    }
-
-    if (standardFields.location.showOnList) {
-      result.push({
-        name: 'Location',
-        type: 'Location',
-        key: 'organization.contact.address',
-        isStandard: true,
-        order: standardFields.location.order * 10,
-        colspan: standardFields.location.colspan || 1,
-        showOnFilter: standardFields.location.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;
-
-  });
-
   Organization.virtual('employees.all').get(function () {
 
     var self = this;

package/package.json

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