@dhyasama/totem-models 11.119.0 → 11.121.0

package/lib/Financials.js

@@ -97,12 +97,12 @@ module.exports = function(mongoose, config) {
         _id: false,
         name: { type: String, trim: true },
         document: { type: Schema.ObjectId, ref: 'Document' },
-        verified: { type: Boolean, default: false },
+        scenario: { type: String, enum: ['actual', 'budget', 'forecast'] },
         history: [{
           _id: false,
           timestamp: { type: Date, required: true, default: Date.now },
           user: { type: String, trim: true, required: true },
-          action: { type: String, enum: ['updated', 'deleted', 'verified'], required: true },
+          action: { type: String, enum: ['updated', 'deleted'], required: true },
         }]
       }],
 
@@ -136,12 +136,11 @@ module.exports = function(mongoose, config) {
         _id: false,
         prompt: { type: String, trim: true },
         response: { type: String, trim: true },
-        verified: { type: Boolean, default: false },
         history: [{
           _id: false,
           timestamp: { type: Date, required: true, default: Date.now },
           user: { type: String, trim: true, required: true },
-          action: { type: String, enum: ['updated', 'deleted', 'verified'], required: true },
+          action: { type: String, enum: ['updated', 'deleted'], required: true },
         }]
       }],
 

package/package.json

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

package/scripts/migrate-financials-schema.js

@@ -5,11 +5,15 @@
  *
  * Changes being migrated:
  * 1. Rename field: review → approval (in recurring and snapshots)
- * 2. Update status enum values in snapshots:
- *    - 'Overdue' → 'Delayed'
- *    - 'In Review' → 'Unapproved'
- * 3. Add verified: true to all existing documents[], metrics[], questions[]
- * 4. Convert metrics from actual/budget/forecast fields to scenario/value structure
+ * 2. Update status enum value: 'In Review' → 'Pending'
+ * 3. Populate history[] for documents[], questions[], and metrics[]
+ *    History is populated with submission and approval data from the snapshot
+ * 4. Add verified: true for metrics[] only
+ * 5. Convert metrics from old structure { name, actual, budget, forecast, breakdown }
+ *    to new structure { name, scenario, value, breakdown, source, verified, history }
+ * 6. Link metrics to their source financial statement documents (Income Statement,
+ *    Balance Sheet, Cash Flow Statement) when available
+ * 7. Remove projections array from root level
  *
  * Usage:
  *   node scripts/migrate-financials-schema.js <customerId> [--config <configPath>] [--dry-run]
@@ -146,94 +150,179 @@ async function migrateFinancials() {
         }
 
         // 2b. Update status enum values
-        if (snapshot.status === 'Overdue') {
-          updates[`snapshots.${index}.status`] = 'Delayed';
-          changes.push(`  - Snapshot ${index}: Changed status 'Overdue' → 'Delayed'`);
-        } else if (snapshot.status === 'In Review') {
-          updates[`snapshots.${index}.status`] = 'Unapproved';
-          changes.push(`  - Snapshot ${index}: Changed status 'In Review' → 'Unapproved'`);
+        if (snapshot.status === 'In Review') {
+          updates[`snapshots.${index}.status`] = 'Pending';
+          changes.push(`  - Snapshot ${index}: Changed status 'In Review' → 'Pending'`);
         }
 
-        // 2c. Add verified: true to documents
+        // Build history array from snapshot submission/approval data
+        const buildHistory = () => {
+          const history = [];
+
+          // Add submission history entry
+          if (snapshot.submittedOn && snapshot.submittedBy) {
+            history.push({
+              timestamp: snapshot.submittedOn,
+              user: snapshot.submittedBy,
+              action: 'updated'
+            });
+          }
+
+          // Add approval history entry
+          if (snapshot.approvedOn && snapshot.approvedBy) {
+            history.push({
+              timestamp: snapshot.approvedOn,
+              user: snapshot.approvedBy,
+              action: 'verified'
+            });
+          }
+
+          return history;
+        };
+
+        const historyArray = buildHistory();
+
+        // 2c. Add history to documents
         if (snapshot.documents && snapshot.documents.length > 0) {
           snapshot.documents.forEach((doc, docIndex) => {
-            if (!('verified' in doc)) {
-              updates[`snapshots.${index}.documents.${docIndex}.verified`] = true;
-              changes.push(`  - Snapshot ${index}: Added verified to document ${docIndex}`);
+            if (!('history' in doc)) {
+              updates[`snapshots.${index}.documents.${docIndex}.history`] = historyArray;
+              changes.push(`  - Snapshot ${index}: Added history (${historyArray.length} entries) to document ${docIndex}`);
             }
           });
         }
 
-        // 2d. Add verified: true to questions
+        // 2d. Add history to questions
         if (snapshot.questions && snapshot.questions.length > 0) {
           snapshot.questions.forEach((question, qIndex) => {
-            if (!('verified' in question)) {
-              updates[`snapshots.${index}.questions.${qIndex}.verified`] = true;
-              changes.push(`  - Snapshot ${index}: Added verified to question ${qIndex}`);
+            if (!('history' in question)) {
+              updates[`snapshots.${index}.questions.${qIndex}.history`] = historyArray;
+              changes.push(`  - Snapshot ${index}: Added history (${historyArray.length} entries) to question ${qIndex}`);
             }
           });
         }
 
-        // 2e. Migrate metrics structure and add verified
+        // 2e. Migrate metrics structure
         if (snapshot.metrics && snapshot.metrics.length > 0) {
           const oldMetrics = [...snapshot.metrics];
           const newMetrics = [];
 
+          // Document to metric mappings
+          const incomeStatementFields = ['Revenue', 'COGS', 'Gross Profit', 'Operating Expenses', 'EBITDA', 'Operating Income', 'Net Income'];
+          const balanceSheetFields = ['Assets', 'Liabilities', 'Equity'];
+          const cashFlowStatementFields = ['Operating Activities', 'Investing Activities', 'Financing Activities'];
+
+          // Find financial statement documents in this snapshot
+          const findDocument = (namePattern) => {
+            if (!snapshot.documents) return null;
+            return snapshot.documents.find(doc =>
+              doc.name && doc.name.toLowerCase().includes(namePattern.toLowerCase())
+            );
+          };
+
+          const incomeStatementDoc = findDocument('Income Statement');
+          const balanceSheetDoc = findDocument('Balance Sheet');
+          const cashFlowStatementDoc = findDocument('Cash Flow Statement');
+
+          // Helper to get source object for a metric name
+          const getSourceForMetric = (metricName) => {
+            if (incomeStatementFields.includes(metricName) && incomeStatementDoc && incomeStatementDoc.document) {
+              return { model: 'Document', ref: incomeStatementDoc.document };
+            }
+            if (balanceSheetFields.includes(metricName) && balanceSheetDoc && balanceSheetDoc.document) {
+              return { model: 'Document', ref: balanceSheetDoc.document };
+            }
+            if (cashFlowStatementFields.includes(metricName) && cashFlowStatementDoc && cashFlowStatementDoc.document) {
+              return { model: 'Document', ref: cashFlowStatementDoc.document };
+            }
+            return undefined;
+          };
+
           // Check if metrics need conversion from old structure
           const needsConversion = oldMetrics.some(m =>
             ('actual' in m || 'budget' in m || 'forecast' in m) && !('scenario' in m)
           );
 
           if (needsConversion) {
-            // Convert old structure (actual/budget/forecast) to new structure (scenario/value)
+            // Convert old structure { name, actual, budget, forecast, breakdown } to new structure
             oldMetrics.forEach((metric) => {
-              // Create separate metric entries for each scenario
+              const source = getSourceForMetric(metric.name);
+
+              // Create separate metric entries for each scenario that has a value
               if ('actual' in metric && metric.actual !== undefined && metric.actual !== null) {
-                newMetrics.push({
+                const newMetric = {
                   name: metric.name,
                   scenario: 'actual',
                   value: metric.actual,
-                  breakdown: metric.breakdown,
-                  verified: true
-                });
+                  breakdown: metric.breakdown || {},
+                  verified: true,
+                  history: historyArray
+                };
+                if (source) newMetric.source = source;
+                newMetrics.push(newMetric);
               }
 
               if ('budget' in metric && metric.budget !== undefined && metric.budget !== null) {
-                newMetrics.push({
+                const newMetric = {
                   name: metric.name,
                   scenario: 'budget',
                   value: metric.budget,
-                  breakdown: metric.breakdown,
-                  verified: true
-                });
+                  breakdown: {},
+                  verified: true,
+                  history: historyArray
+                };
+                if (source) newMetric.source = source;
+                newMetrics.push(newMetric);
               }
 
               if ('forecast' in metric && metric.forecast !== undefined && metric.forecast !== null) {
-                newMetrics.push({
+                const newMetric = {
                   name: metric.name,
                   scenario: 'forecast',
                   value: metric.forecast,
-                  breakdown: metric.breakdown,
-                  verified: true
-                });
+                  breakdown: {},
+                  verified: true,
+                  history: historyArray
+                };
+                if (source) newMetric.source = source;
+                newMetrics.push(newMetric);
               }
             });
 
+            const metricsWithSource = newMetrics.filter(m => m.source).length;
             updates[`snapshots.${index}.metrics`] = newMetrics;
-            changes.push(`  - Snapshot ${index}: Converted ${oldMetrics.length} metric(s) to new structure (${newMetrics.length} entries)`);
+            changes.push(`  - Snapshot ${index}: Converted ${oldMetrics.length} metric(s) to new structure (${newMetrics.length} entries, ${metricsWithSource} with source)`);
           } else {
-            // Already in new structure, just add verified if missing
+            // Already in new structure, just add verified, history, and source if missing
             oldMetrics.forEach((metric, mIndex) => {
               if (!('verified' in metric)) {
                 updates[`snapshots.${index}.metrics.${mIndex}.verified`] = true;
                 changes.push(`  - Snapshot ${index}: Added verified to metric ${mIndex}`);
               }
+              if (!('history' in metric)) {
+                updates[`snapshots.${index}.metrics.${mIndex}.history`] = historyArray;
+                changes.push(`  - Snapshot ${index}: Added history (${historyArray.length} entries) to metric ${mIndex}`);
+              }
+              if (!('source' in metric)) {
+                const source = getSourceForMetric(metric.name);
+                if (source) {
+                  updates[`snapshots.${index}.metrics.${mIndex}.source`] = source;
+                  changes.push(`  - Snapshot ${index}: Added source to metric ${mIndex} (${metric.name})`);
+                }
+              }
             });
           }
         }
       });
     }
 
+    // 3. Remove projections array from root level
+    if ('projections' in financial) {
+      updates.$unset = updates.$unset || {};
+      updates.$unset['projections'] = '';
+      changes.push('  - Removed projections array');
+    }
+
     // Apply updates
     if (Object.keys(updates).length > 0 && !DRY_RUN) {
       const updateDoc = {};

package/migrations/social_handles.js

@@ -1,119 +0,0 @@
-"use strict";
-
-const mongoose = require('mongoose');
-const models = require('../index')(mongoose, { suppressDebugLog: true });
-const Organization = mongoose.model('Organization');
-const db_uri = "mongodb://jason:T576G150HPXLA5q4BJ2o2zj747B5030x@production-shard-00-00-gv0f3.mongodb.net:27017,production-shard-00-01-gv0f3.mongodb.net:27017,production-shard-00-02-gv0f3.mongodb.net:27017/production?replicaSet=Production-shard-0&ssl=true&authSource=admin";
-const _ = require('underscore');
-const async = require('async');
-
-let dirtyOrgs = [];
-let savedOrgCount = 0;
-
-const getHandle = function getHandle(url) {
-
-  let handle = "";
-
-  try {
-
-    const segments = url.split("/");
-
-    // normal case, e.g., http://facebook.com/hello
-    if (segments[segments.length - 1]) handle = segments[segments.length - 1];
-
-    // trailing slash, e.g., http://facebook.com/hello/
-    else if (segments[segments.length - 2]) handle = segments[segments.length - 2];
-
-    else handle = "";
-
-  }
-  catch (err) {
-    console.log('Error for url', url);
-    console.error(err);
-  }
-
-  //console.log(handle, url);
-
-  return handle;
-
-};
-
-const saveOrg = function(org, cb) {
-
-  Organization.upsert(org, 'social-handle-transformation', function(err) {
-    if (err) console.error(err);
-    else {
-      savedOrgCount += 1;
-      //console.log(org.name);
-    }
-    return cb();
-  });
-
-}
-
-mongoose.connect(db_uri, function(err) {
-
-  if (err) {
-    console.error(err);
-    process.exit();
-  }
-
-  const page = 9;
-  const limit = 10000;
-  const skip = (page - 1) * limit;
-
-  console.log('Getting page', page);
-
-  Organization
-    .find({
-      $and: [
-        { social: { $exists: true } },
-        {
-          $or: [
-            { "social.facebook": { $exists: true } },
-            { "social.twitter": { $exists: true } },
-            { "social.linkedin": { $exists: true } }
-          ]
-        }
-      ]
-    })
-    .skip(skip)
-    .limit(limit)
-    .sort({"name": "asc"})
-    .exec(function(err, orgs) {
-
-      if (err) {
-        console.error(err);
-        process.exit();
-      }
-
-      console.log('Found', orgs.length, 'orgs');
-
-      orgs.forEach(function(org) {
-
-        let dirty = false;
-
-          if (org.social.facebook || org.social.twitter || org.social.linkedin) {
-            dirty = true;
-          }
-
-          if (dirty) dirtyOrgs.push(org);
-
-      });
-
-      console.log(dirtyOrgs.length, 'orgs need to be saved');
-
-      async.each(dirtyOrgs, saveOrg, function(err) {
-
-        if (err) console.error(err);
-
-        console.log('Saved', savedOrgCount, 'orgs');
-        console.log('Done page', page);
-
-        process.exit();
-
-      });
-
-    });
-
-});