@dhyasama/totem-models 11.122.0 → 11.124.0

package/lib/Financials.js

@@ -88,9 +88,6 @@ module.exports = function(mongoose, config) {
       form: [{
         name: { type: String, trim: true },
         type: { type: String, enum: [null, 'header', 'block', 'document', 'metric', 'question'] },
-        scenario: { type: String, enum: ['actual', 'budget', 'forecast'] },
-        budget: { type: Number },
-        forecast: { type: Number },
         required: { type: Boolean, default: false }
       }],
       
@@ -334,8 +331,8 @@ module.exports = function(mongoose, config) {
         // Check if the metric update was successful
         const snapshot = updatedDocument.snapshots.find(s => s.uuid === snapshotUUID);
         if (snapshot) {
-          const updatedMetric = snapshot.metrics.find(m => m.name === metric.name);
-          if (updatedMetric && updatedMetric.actual === metric.actual) {
+          const updatedMetric = snapshot.metrics.find(m => m.name === metric.name && m.scenario === metric.scenario);
+          if (updatedMetric && updatedMetric.value === metric.value) {
             console.log('Metric was successfully updated:', updatedMetric);
             result = true;
           } else {
@@ -364,7 +361,8 @@ module.exports = function(mongoose, config) {
 
         console.log('Upserting metric:', metric);
         console.log('Upserting metric name:', metric.name);
-        console.log('Upserting metric actual:', metric.actual);
+        console.log('Upserting metric scenario:', metric.scenario);
+        console.log('Upserting metric value:', metric.value);
         console.log('Upserting metric breakdown:', metric.breakdown);
 
         // Check if the metric exists and update it
@@ -372,16 +370,25 @@ module.exports = function(mongoose, config) {
           {
             _id: financialsId,
             'snapshots.uuid': snapshotUUID,
-            'snapshots.metrics.name': metric.name
+            'snapshots.metrics.name': metric.name,
+            'snapshots.metrics.scenario': metric.scenario
           },
           {
             $set: {
-              'snapshots.$.metrics.$[metric].actual': metric.actual,
+              'snapshots.$.metrics.$[metric].value': metric.value,
               'snapshots.$.metrics.$[metric].breakdown': metric.breakdown,
+              'snapshots.$.metrics.$[metric].source': metric.source,
+              'snapshots.$.metrics.$[metric].verified': metric.verified
+            },
+            $push: {
+              'snapshots.$.metrics.$[metric].history': {
+                $each: metric.history || [],
+                $position: 0
+              }
             }
           },
           {
-            arrayFilters: [{ 'metric.name': metric.name }],
+            arrayFilters: [{ 'metric.name': metric.name, 'metric.scenario': metric.scenario }],
             new: true,
             session: _session
           }

package/lib/Organization.js

@@ -320,7 +320,6 @@ module.exports = function(mongoose, config) {
               _id: false,
               name: { type: String, trim: true },
               type: { type: String, enum: [null, 'header', 'block', 'document', 'metric', 'question'] },
-              scenario: { type: String, enum: ['actual', 'budget', 'forecast'] },
               required: { type: Boolean, default: false }
             }]
           }],

package/package.json

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

package/scripts/migrate-financials-schema.js

@@ -6,14 +6,21 @@
  * Changes being migrated:
  * 1. Rename field: review → approval (in recurring and snapshots)
  * 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 }
+ * 3. Remove budget, forecast, and scenario fields from form[] template (commits 71c84ac, 4bca5a3)
+ * 4. Populate history[] for documents[], questions[], and metrics[]
+ *    - For documents and questions: history uses actions ['updated', 'deleted'] only
+ *      History populated with submission entry only (1 entry if submitted)
+ *    - For metrics: history uses actions ['updated', 'deleted', 'verified']
+ *      History populated with submission and approval entries (2 entries if approved)
+ * 5. Set scenario to 'actual' for all existing documents[] (historical data is actual)
+ * 6. Remove verified field from documents[] (removed in commit 300a22a)
+ * 7. Remove verified field from questions[] (removed in commit 300a22a)
+ * 8. Add verified: true for metrics[] only
+ * 9. 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
+ * 10. Link metrics to their source financial statement documents (Income Statement,
+ *     Balance Sheet, Cash Flow Statement) when available
+ * 11. Remove projections array from root level
  *
  * Usage:
  *   node scripts/migrate-financials-schema.js <customerId> [--config <configPath>] [--dry-run]
@@ -155,8 +162,51 @@ async function migrateFinancials() {
           changes.push(`  - Snapshot ${index}: Changed status 'In Review' → 'Pending'`);
         }
 
+        // 2c. Remove budget, forecast, and scenario fields from form[] template
+        if (snapshot.form && snapshot.form.length > 0) {
+          snapshot.form.forEach((formItem, fIndex) => {
+            let fieldsRemoved = [];
+            if ('budget' in formItem) {
+              updates.$unset = updates.$unset || {};
+              updates.$unset[`snapshots.${index}.form.${fIndex}.budget`] = '';
+              fieldsRemoved.push('budget');
+            }
+            if ('forecast' in formItem) {
+              updates.$unset = updates.$unset || {};
+              updates.$unset[`snapshots.${index}.form.${fIndex}.forecast`] = '';
+              fieldsRemoved.push('forecast');
+            }
+            if ('scenario' in formItem) {
+              updates.$unset = updates.$unset || {};
+              updates.$unset[`snapshots.${index}.form.${fIndex}.scenario`] = '';
+              fieldsRemoved.push('scenario');
+            }
+            if (fieldsRemoved.length > 0) {
+              changes.push(`  - Snapshot ${index}: Removed ${fieldsRemoved.join(', ')} from form[${fIndex}]`);
+            }
+          });
+        }
+
         // Build history array from snapshot submission/approval data
-        const buildHistory = () => {
+        // Note: For documents and questions, only 'updated' and 'deleted' actions are valid
+        // Documents/questions are not verified individually - only the snapshot is approved
+        // For metrics, 'verified' is also valid since they can be individually verified
+        const buildHistoryForDocumentsAndQuestions = () => {
+          const history = [];
+
+          // Add submission history entry only (no approval/verification for individual docs/questions)
+          if (snapshot.submittedOn && snapshot.submittedBy) {
+            history.push({
+              timestamp: snapshot.submittedOn,
+              user: snapshot.submittedBy,
+              action: 'updated'
+            });
+          }
+
+          return history;
+        };
+
+        const buildHistoryForMetrics = () => {
           const history = [];
 
           // Add submission history entry
@@ -168,7 +218,7 @@ async function migrateFinancials() {
             });
           }
 
-          // Add approval history entry
+          // Add approval history entry (use 'verified' for metrics)
           if (snapshot.approvedOn && snapshot.approvedBy) {
             history.push({
               timestamp: snapshot.approvedOn,
@@ -180,29 +230,47 @@ async function migrateFinancials() {
           return history;
         };
 
-        const historyArray = buildHistory();
+        const historyArrayForDocumentsAndQuestions = buildHistoryForDocumentsAndQuestions();
+        const historyArrayForMetrics = buildHistoryForMetrics();
 
-        // 2c. Add history to documents
+        // 2d. Add history to documents, set scenario to 'actual', and remove verified field
         if (snapshot.documents && snapshot.documents.length > 0) {
           snapshot.documents.forEach((doc, docIndex) => {
             if (!('history' in doc)) {
-              updates[`snapshots.${index}.documents.${docIndex}.history`] = historyArray;
-              changes.push(`  - Snapshot ${index}: Added history (${historyArray.length} entries) to document ${docIndex}`);
+              updates[`snapshots.${index}.documents.${docIndex}.history`] = historyArrayForDocumentsAndQuestions;
+              changes.push(`  - Snapshot ${index}: Added history (${historyArrayForDocumentsAndQuestions.length} entries) to document ${docIndex}`);
+            }
+            // Set scenario to 'actual' for all existing documents (historical data is actual)
+            if (!('scenario' in doc)) {
+              updates[`snapshots.${index}.documents.${docIndex}.scenario`] = 'actual';
+              changes.push(`  - Snapshot ${index}: Set scenario to 'actual' for document ${docIndex}`);
+            }
+            // Remove verified field if it exists (removed in commit 300a22a)
+            if ('verified' in doc) {
+              updates.$unset = updates.$unset || {};
+              updates.$unset[`snapshots.${index}.documents.${docIndex}.verified`] = '';
+              changes.push(`  - Snapshot ${index}: Removed verified field from document ${docIndex}`);
             }
           });
         }
 
-        // 2d. Add history to questions
+        // 2e. Add history to questions and remove verified field
         if (snapshot.questions && snapshot.questions.length > 0) {
           snapshot.questions.forEach((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}`);
+              updates[`snapshots.${index}.questions.${qIndex}.history`] = historyArrayForDocumentsAndQuestions;
+              changes.push(`  - Snapshot ${index}: Added history (${historyArrayForDocumentsAndQuestions.length} entries) to question ${qIndex}`);
+            }
+            // Remove verified field if it exists (removed in commit 300a22a)
+            if ('verified' in question) {
+              updates.$unset = updates.$unset || {};
+              updates.$unset[`snapshots.${index}.questions.${qIndex}.verified`] = '';
+              changes.push(`  - Snapshot ${index}: Removed verified field from question ${qIndex}`);
             }
           });
         }
 
-        // 2e. Migrate metrics structure
+        // 2f. Migrate metrics structure
         if (snapshot.metrics && snapshot.metrics.length > 0) {
           const oldMetrics = [...snapshot.metrics];
           const newMetrics = [];
@@ -256,7 +324,7 @@ async function migrateFinancials() {
                   value: metric.actual,
                   breakdown: metric.breakdown || {},
                   verified: true,
-                  history: historyArray
+                  history: historyArrayForMetrics
                 };
                 if (source) newMetric.source = source;
                 newMetrics.push(newMetric);
@@ -269,7 +337,7 @@ async function migrateFinancials() {
                   value: metric.budget,
                   breakdown: {},
                   verified: true,
-                  history: historyArray
+                  history: historyArrayForMetrics
                 };
                 if (source) newMetric.source = source;
                 newMetrics.push(newMetric);
@@ -282,7 +350,7 @@ async function migrateFinancials() {
                   value: metric.forecast,
                   breakdown: {},
                   verified: true,
-                  history: historyArray
+                  history: historyArrayForMetrics
                 };
                 if (source) newMetric.source = source;
                 newMetrics.push(newMetric);
@@ -300,8 +368,8 @@ async function migrateFinancials() {
                 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}`);
+                updates[`snapshots.${index}.metrics.${mIndex}.history`] = historyArrayForMetrics;
+                changes.push(`  - Snapshot ${index}: Added history (${historyArrayForMetrics.length} entries) to metric ${mIndex}`);
               }
               if (!('source' in metric)) {
                 const source = getSourceForMetric(metric.name);