bulltrackers-module 1.0.31 → 1.0.32

package/functions/generic-api/index.js

@@ -5,8 +5,50 @@
 
 const express = require('express');
 const cors = require('cors');
+// FieldPath is needed to query by document ID
+const { FieldPath } = require('@google-cloud/firestore'); 
 const { buildCalculationMap, createApiHandler } = require('./helpers/api_helpers.js');
 
+/**
+ * Recursively creates a snippet of a data object, limiting arrays and large maps.
+ * @param {*} data - The data to snippet.
+ * @param {number} [maxKeys=20] - Max keys before an object is considered a "large map".
+ * @returns {*} - The snippet.
+ */
+function createStructureSnippet(data, maxKeys = 20) {
+    // Handle primitives and null
+    if (data === null || typeof data !== 'object') {
+        return data;
+    }
+
+    // Handle arrays: return a snippet of the first element
+    if (Array.isArray(data)) {
+        if (data.length === 0) {
+            return "<empty array>";
+        }
+        // Recursively snippet the first item
+        return [ createStructureSnippet(data[0], maxKeys) ];
+    }
+
+    // Handle objects
+    const newObj = {};
+    const keys = Object.keys(data);
+
+    // If it's a large map (e.g., user IDs), just show one example
+    if (keys.length > maxKeys) {
+        const firstKey = keys[0];
+        newObj[firstKey] = createStructureSnippet(data[firstKey], maxKeys);
+        newObj[`... (${keys.length - 1} more keys)`] = "<object>";
+    } else {
+        // Otherwise, it's a structural object, so map all keys
+        for (const key of keys) {
+            newObj[key] = createStructureSnippet(data[key], maxKeys);
+        }
+    }
+    return newObj;
+}
+
+
 /**
  * Creates and configures the Express app for the Generic API.
  * @param {object} config - The Generic API V2 configuration object.
@@ -19,7 +61,6 @@ function createApiApp(config, dependencies, unifiedCalculations) {
     const { firestore, logger } = dependencies; // Extract dependencies
 
     // --- Pre-compute Calculation Map ---
-    // This doesn't need config directly
     const calcMap = buildCalculationMap(unifiedCalculations);
 
     // --- Middleware ---
@@ -27,7 +68,6 @@ function createApiApp(config, dependencies, unifiedCalculations) {
     app.use(express.json());
 
     // --- Main API Endpoint ---
-    // The handler is created with its dependencies and config injected
     app.get('/', createApiHandler(config, firestore, logger, calcMap));
 
     // --- Health Check Endpoint ---
@@ -35,7 +75,7 @@ function createApiApp(config, dependencies, unifiedCalculations) {
         res.status(200).send('OK');
     });
 
-    // --- NEW: Debug Endpoint to list all computation keys ---
+    // --- Debug Endpoint to list all computation keys ---
     app.get('/list-computations', (req, res) => {
         try {
             const computationKeys = Object.keys(calcMap);
@@ -50,38 +90,62 @@ function createApiApp(config, dependencies, unifiedCalculations) {
         }
     });
 
-    // --- NEW: Debug Endpoint to get the structure of a computation ---
-    app.get('/structure/:computationName', (req, res) => {
+    // --- REVISED: Debug Endpoint to get the structure from Firestore ---
+    app.get('/structure/:computationName', async (req, res) => {
         const { computationName } = req.params;
         try {
+            // 1. Find the computation category
             const pathInfo = calcMap[computationName];
             if (!pathInfo) {
-                return res.status(404).send({ status: 'error', message: `Computation '${computationName}' not found.` });
+                return res.status(404).send({ status: 'error', message: `Computation '${computationName}' not found in calculation map.` });
             }
-
             const { category } = pathInfo;
-            const CalculationClass = unifiedCalculations[category]?.[computationName];
 
-            if (typeof CalculationClass !== 'function') {
-                logger.log('WARN', `API /structure: No calculation class found for ${category}/${computationName}.`);
-                return res.status(404).send({ status: 'error', message: `Could not find calculation class for '${computationName}'.` });
+            // 2. Get collection names from config
+            const insightsCollection = config.unifiedInsightsCollection || 'unified_insights';
+            const resultsSub = config.resultsSubcollection || 'results';
+            const compsSub = config.computationsSubcollection || 'computations';
+
+            // 3. Find the most recent date document in Firestore
+            const dateQuery = firestore.collection(insightsCollection)
+                .orderBy(FieldPath.documentId(), 'desc')
+                .limit(1);
+                
+            const dateSnapshot = await dateQuery.get();
+
+            if (dateSnapshot.empty) {
+                return res.status(404).send({ status: 'error', message: `No data found in insights collection '${insightsCollection}'.` });
             }
+            
+            const recentDate = dateSnapshot.docs[0].id;
+
+            // 4. Construct the path to the actual computation document
+            const docRef = firestore.collection(insightsCollection).doc(recentDate)
+                .collection(resultsSub).doc(category)
+                .collection(compsSub).doc(computationName);
+
+            const doc = await docRef.get();
 
-            // Instantiate the class and get its default result
-            const calcInstance = new CalculationClass();
-            if (typeof calcInstance.getResult === 'function') {
-                const structure = calcInstance.getResult();
-                res.status(200).send({
-                    status: 'success',
-                    computation: computationName,
-                    category: category,
-                    structure: structure || {}, // Ensure it returns at least an empty object
+            if (!doc.exists) {
+                return res.status(404).send({ 
+                    status: 'error', 
+                    message: `Data for '${computationName}' not found for the most recent date (${recentDate}).`,
+                    checkedPath: docRef.path
                 });
-            } else {
-                logger.log('WARN', `API /structure: Class ${category}/${computationName} has no getResult() method.`);
-                return res.status(501).send({ status: 'error', message: `Calculation '${computationName}' exists but does not have a getResult() method to determine structure.` });
             }
 
+            // 5. Generate and return the snippet
+            const fullData = doc.data();
+            const snippet = createStructureSnippet(fullData);
+
+            res.status(200).send({
+                status: 'success',
+                computation: computationName,
+                category: category,
+                exampleDate: recentDate,
+                structureSnippet: snippet,
+            });
+
         } catch (error) {
             logger.log('ERROR', `API /structure/${computationName} failed.`, { errorMessage: error.message, stack: error.stack });
             res.status(500).send({ status: 'error', message: `An internal error occurred while processing '${computationName}'.` });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bulltrackers-module",
-  "version": "1.0.31",
+  "version": "1.0.32",
   "description": "Helper Functions for Bulltrackers.",
   "main": "index.js",
   "files": [