aiden-shared-calculations-unified 1.0.24 → 1.0.25

package/calculations/meta/capital_vintage_performance.js

@@ -0,0 +1,159 @@
+/**
+ * @fileoverview Meta-calculation (Pass 3) that tracks the performance 
+ * of capital "vintages" by analyzing the market returns of assets 
+ * that were bought following a crowd-wide deposit signal.
+ *
+ * This answers: "Does capital deployed from a fresh deposit event 
+ * outperform capital deployed earlier?"
+ */
+
+class CapitalVintagePerformance {
+    constructor() {
+        // How many days to look back/forward to measure performance
+        this.PERFORMANCE_WINDOW_DAYS = 7; 
+        this.dependenciesLoaded = false;
+        this.priceMap = null;
+        this.tickerToIdMap = null;
+    }
+
+    /**
+     * Helper to load all dependencies in parallel
+     */
+    async _loadDependencies(calculationUtils) {
+        if (this.dependenciesLoaded) return;
+        
+        const { loadAllPriceData, loadInstrumentMappings } = calculationUtils;
+        
+        const [priceData, mappings] = await Promise.all([
+            loadAllPriceData(),
+            loadInstrumentMappings()
+        ]);
+
+        this.priceMap = priceData;
+        
+        // Create a reverse map for easy lookup
+        this.tickerToIdMap = {};
+        if (mappings && mappings.instrumentToTicker) {
+            for (const [id, ticker] of Object.entries(mappings.instrumentToTicker)) {
+                this.tickerToIdMap[ticker] = id;
+            }
+        }
+        
+        this.dependenciesLoaded = true;
+    }
+
+    /**
+     * Helper to get a date string X days from a base date
+     */
+    _getDateStr(baseDateStr, daysOffset) {
+        const date = new Date(baseDateStr + 'T00:00:00Z');
+        date.setUTCDate(date.getUTCDate() + daysOffset);
+        return date.toISOString().slice(0, 10);
+    }
+
+    /**
+     * Helper to calculate the average return of a basket of assets
+     * over a specified period.
+     */
+    _calculateBasketPerformance(assets, startDateStr, endDateStr) {
+        if (!assets || assets.length === 0) {
+            return 0;
+        }
+
+        let totalReturn = 0;
+        let validAssets = 0;
+
+        for (const asset of assets) {
+            const ticker = asset.ticker;
+            const instrumentId = this.tickerToIdMap[ticker];
+
+            if (!instrumentId || !this.priceMap[instrumentId]) {
+                continue; // No price data for this ticker
+            }
+
+            const startPrice = this.priceMap[instrumentId][startDateStr];
+            const endPrice = this.priceMap[instrumentId][endDateStr];
+
+            if (startPrice && endPrice && startPrice > 0) {
+                const assetReturn = (endPrice - startPrice) / startPrice;
+                totalReturn += assetReturn;
+                validAssets++;
+            }
+        }
+
+        if (validAssets === 0) return 0;
+        return (totalReturn / validAssets) * 100; // Return as percentage
+    }
+
+    /**
+     * @param {string} dateStr The date to run the analysis for (e.g., "2025-10-31").
+     * @param {object} dependencies The shared dependencies (db, logger, calculationUtils).
+     * @param {object} config The computation system configuration.
+     * @returns {Promise<object|null>} The analysis result or null.
+     */
+    async process(dateStr, dependencies, config) {
+        const { db, logger, calculationUtils } = dependencies;
+        
+        // 1. Load all price/mapping data
+        await this._loadDependencies(calculationUtils);
+
+        // 2. Define and fetch dependency: cash-flow-deployment
+        const depRef = db.collection(config.resultsCollection).doc(dateStr)
+            .collection('results').doc('meta')
+            .collection('computations').doc('cash-flow-deployment');
+            
+        const snapshot = await depRef.get();
+
+        if (!snapshot.exists || snapshot.data().status !== 'analysis_complete') {
+            logger.log('WARN', `[CapitalVintage] Skipping ${dateStr}, no valid 'cash-flow-deployment' data found.`);
+            return null;
+        }
+
+        const data = snapshot.data();
+        const topAssets = data.top_deployment_assets; // [{ ticker: 'AAPL', ... }]
+        const signalDate = data.signal_date; // The day the deposit signal occurred
+        const deploymentDate = data.analysis_date; // The day the capital was spent (dateStr)
+
+        if (!topAssets || topAssets.length === 0) {
+             logger.log('INFO', `[CapitalVintage] No top assets deployed on ${dateStr}.`);
+             return { status: 'no_deployment' };
+        }
+
+        // 3. Define performance windows
+        // "Before" window: 7 days leading up to the signal
+        const preSignalStart = this._getDateStr(signalDate, -this.PERFORMANCE_WINDOW_DAYS);
+        const preSignalEnd = signalDate;
+        
+        // "After" window: 7 days starting from the deployment
+        const postDeployStart = deploymentDate;
+        const postDeployEnd = this._getDateStr(deploymentDate, this.PERFORMANCE_WINDOW_DAYS);
+
+        // 4. Calculate performance
+        const preSignalReturnPct = this._calculateBasketPerformance(
+            topAssets, preSignalStart, preSignalEnd
+        );
+        
+        const postDeploymentReturnPct = this._calculateBasketPerformance(
+            topAssets, postDeployStart, postDeployEnd
+        );
+        
+        const momentum = postDeploymentReturnPct - preSignalReturnPct;
+
+        return {
+            status: 'analysis_complete',
+            signal_date: signalDate,
+            deployment_date: deploymentDate,
+            performance_window_days: this.PERFORMANCE_WINDOW_DAYS,
+            deployed_assets: topAssets.map(a => a.ticker),
+            pre_signal_return_pct: preSignalReturnPct,
+            post_deployment_return_pct: postDeploymentReturnPct,
+            return_momentum: momentum,
+            interpretation: "Measures the 7-day return of deployed assets *after* deployment vs. 7-days *before* the signal."
+        };
+    }
+
+    async getResult() { return null; }
+    reset() {}
+}
+
+module.exports = CapitalVintagePerformance;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aiden-shared-calculations-unified",
-  "version": "1.0.24",
+  "version": "1.0.25",
   "description": "Shared calculation modules for the BullTrackers Computation System.",
   "main": "index.js",
   "files": [