energy-visualization-sankey 1.0.11 → 1.0.13

package/dist/sankey.esm.js

@@ -1,3 +1,39 @@
+/**
+ * Type Definitions for Energy Sankey Library
+ *
+ * Comprehensive TypeScript type definitions for energy visualization data structures,
+ * configuration options, service interfaces, and mathematical computation types.
+ *
+ * Key Type Categories:
+ * - Error types: Custom error classes with detailed context
+ * - Data structures: Energy data points, summaries, and flow calculations
+ * - Configuration: Visual constants, fuel definitions, and styling
+ * - Mathematical types: Graph data, positioning, and computational results
+ * - Service interfaces: D3 selections, render data, and layout structures
+ *
+ * Type Safety Features:
+ * - Immutable readonly properties for data integrity
+ * - Strict type constraints for fuel and sector names
+ * - Comprehensive interface coverage for all service operations
+ * - Generic types for flexible service composition
+ *
+ */
+// Error types
+class SankeyError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+        this.name = 'SankeyError';
+    }
+}
+class DataValidationError extends SankeyError {
+    constructor(message, field) {
+        super(message, 'DATA_VALIDATION');
+        this.field = field;
+        this.name = 'DataValidationError';
+    }
+}
+
 function ascending$1(a, b) {
   return a == null || b == null ? NaN : a < b ? -1 : a > b ? 1 : a >= b ? 0 : NaN;
 }
@@ -4311,42 +4347,6 @@ class EventBus {
     }
 }
 
-/**
- * Type Definitions for Energy Sankey Library
- *
- * Comprehensive TypeScript type definitions for energy visualization data structures,
- * configuration options, service interfaces, and mathematical computation types.
- *
- * Key Type Categories:
- * - Error types: Custom error classes with detailed context
- * - Data structures: Energy data points, summaries, and flow calculations
- * - Configuration: Visual constants, fuel definitions, and styling
- * - Mathematical types: Graph data, positioning, and computational results
- * - Service interfaces: D3 selections, render data, and layout structures
- *
- * Type Safety Features:
- * - Immutable readonly properties for data integrity
- * - Strict type constraints for fuel and sector names
- * - Comprehensive interface coverage for all service operations
- * - Generic types for flexible service composition
- *
- */
-// Error types
-class SankeyError extends Error {
-    constructor(message, code) {
-        super(message);
-        this.code = code;
-        this.name = 'SankeyError';
-    }
-}
-class DataValidationError extends SankeyError {
-    constructor(message, field) {
-        super(message, 'DATA_VALIDATION');
-        this.field = field;
-        this.name = 'DataValidationError';
-    }
-}
-
 /**
  * Performance Monitoring and Debug Logging Utility
  *
@@ -4488,22 +4488,22 @@ class ConfigurationService {
         // ===================== COORDINATE POSITIONING CONSTANTS =====================
         // LEFT COLUMN POSITIONING: Fuel source boxes alignment
         this.LEFT_X = 10; // X-coordinate for left column (fuel sources)
-        this.TOP_Y = 100; // Y-coordinate for top margin (visual breathing space)
+        this.LEFT_Y = 100; // Y-coordinate for top margin (visual breathing space)
         // ==================== MATHEMATICAL SCALING CONSTANTS ====================
         // ENERGY-TO-PIXEL CONVERSION: Critical scaling factor for proportional representation
         this.SCALE = 0.02; // Converts Quads to pixels: 1 Quad = 0.02 pixels height
         // Calibrated for typical US energy consumption (0-100+ Quads)
         // Example: 50 Quads × 0.02 = 1.0 pixel height
         // ELECTRICITY BOX POSITIONING: Special coordinates for electricity box (bidirectional flows)
-        this.ELEC_BOX_X = 320;
-        this.ELEC_BOX_Y = 120;
+        this.ELECTRICITY_BOX_X = 320;
+        this.ELECTRICITY_BOX_Y = 120;
         this.HEAT_BOX_X = 750;
         this.HEAT_BOX_Y = 200;
-        // X=350: Positioned between fuel sources (left) and sectors (right)
-        // Y=120: Offset below title area for visual clarity
         // ======================== VISUAL SPACING CONSTANTS ========================
         // VERTICAL GAPS: Spacing between stacked elements for visual clarity
         this.LEFT_GAP = 30; // Gap between fuel boxes (left column)
+        // ANIMATION PARAMETERS: Timing and transition control
+        this.SPEED = 200; // Animation speed in milliseconds (from user options, default 200)
         this.BLEED = 0.5; // Edge bleed factor for smooth visual transitions
         // =================== GEOMETRIC CALCULATION CONSTANTS ===================
         // MATHEMATICS: Mathematical constants
@@ -4513,7 +4513,7 @@ class ConfigurationService {
         // FLOW PATH SPACING: Visual separation between parallel energy flows
         this.PATH_GAP = 20; // Pixel gap between parallel flow paths
         // Prevents visual overlap while maintaining readability
-        this.ELEC_GAP = 19; // Special gap for electricity flows (slightly smaller)
+        this.ELECTRICITY_GAP = 19; // Special gap for electricity flows (slightly smaller)
         // Optimized for electricity box's central position
         // ====================== ENERGY SOURCE DEFINITIONS ======================
         // Comprehensive fuel type configuration with energy industry standard categorization
@@ -4565,7 +4565,30 @@ class ConfigurationService {
         this.FUEL_NAMES = this.FUELS.map(fuel => fuel.fuel);
         // Calculate computed properties
         this.RIGHT_GAP = this.LEFT_GAP * 2.1;
-        this.SPEED = options.animationSpeed || 200;
+        if (options.animationSpeed) {
+            this.SPEED = options.animationSpeed;
+        }
+        if (options.scale) {
+            this.SCALE = options.scale;
+        }
+        if (options.leftX) {
+            this.LEFT_X = options.leftX;
+        }
+        if (options.leftY) {
+            this.LEFT_Y = options.leftY;
+        }
+        if (options.electricityBoxX) {
+            this.ELECTRICITY_BOX_X = options.electricityBoxX;
+        }
+        if (options.electricityBoxY) {
+            this.ELECTRICITY_BOX_Y = options.electricityBoxY;
+        }
+        if (options.heatBoxX) {
+            this.HEAT_BOX_X = options.heatBoxX;
+        }
+        if (options.heatBoxY) {
+            this.HEAT_BOX_Y = options.heatBoxY;
+        }
         this.FLOW_PATHS_ORDER = {
             "elec": this.BOXES_DEFAULT_FLOW_PATHS_ORDER,
             "heat": this.BOXES_DEFAULT_FLOW_PATHS_ORDER,
@@ -4737,43 +4760,55 @@ class ConfigurationService {
     validateConfiguration() {
         // Validate dimensions
         if (this.WIDTH <= 0 || this.HEIGHT <= 0) {
-            throw new Error('ConfigurationService: Invalid dimensions');
+            throw new Error('Invalid dimensions');
         }
         // Validate box positioning
         if (this.BOX_WIDTH <= 0 || this.BOX_HEIGHT <= 0) {
-            throw new Error('ConfigurationService: Invalid box dimensions');
+            throw new Error('Invalid box dimensions');
+        }
+        // Validate scaling factors
+        if (this.SPEED <= 0) {
+            throw new Error('Invalid animation speed');
         }
         // Validate scaling factors
         if (this.SCALE <= 0) {
-            throw new Error('ConfigurationService: Invalid scale factor');
+            throw new Error('Invalid scale factor');
+        }
+        // Validate left source positioning
+        if (this.LEFT_X <= 0 || this.LEFT_Y <= 0) {
+            throw new Error('Invalid left sources position');
         }
         // Validate electricity box positioning
-        if (this.ELEC_BOX_X <= 0 || this.ELEC_BOX_X <= 0) {
-            throw new Error('ConfigurationService: Invalid electricity box position');
+        if (this.ELECTRICITY_BOX_X <= 0 || this.ELECTRICITY_BOX_Y <= 0) {
+            throw new Error('Invalid electricity box position');
+        }
+        // Validate heat box positioning
+        if (this.HEAT_BOX_X <= 0 || this.HEAT_BOX_Y <= 0) {
+            throw new Error('Invalid heat box position');
         }
         // Validate fuel definitions
         if (this.FUELS.length === 0) {
-            throw new Error('ConfigurationService: No fuels defined');
+            throw new Error('No fuels defined');
         }
         // Validate sector definitions
         if (this.BOXES.length === 0) {
-            throw new Error('ConfigurationService: No sectors defined');
+            throw new Error('No sectors defined');
         }
         // Validate required fuels exist
         const requiredFuels = ['elec', 'solar', 'nuclear', 'hydro', 'wind', 'geo', 'gas', 'coal', 'bio', 'petro'];
         for (const fuel of requiredFuels) {
             if (!this.FUEL_NAMES.includes(fuel)) {
-                console.warn(`ConfigurationService: Missing required fuel: ${fuel}`);
+                console.warn(`Missing required fuel: ${fuel}`);
             }
         }
         // Validate required sectors exist
         const requiredSectors = ['elec', 'res', 'ag', 'indus', 'trans'];
         for (const sector of requiredSectors) {
             if (!this.BOX_NAMES.includes(sector)) {
-                console.warn(`ConfigurationService: Missing required sector: ${sector}`);
+                console.warn(`Missing required sector: ${sector}`);
             }
         }
-        this.logger.log('ConfigurationService: All configuration validated successfully');
+        this.logger.log('All configuration validated successfully');
     }
     // ==================== UTILITY METHODS ====================
     /**
@@ -5425,9 +5460,9 @@ class SummaryService {
         // Measured improvement: 5-10% reduction in execution time
         const FUELS = this.configService.FUELS; // Energy source types array
         const BOX_NAMES = this.configService.BOX_NAMES; // Consumption sector names  
-        const ELEC_BOX_Y = this.configService.ELEC_BOX_Y; // Electricity box Y-coordinate
+        const ELEC_BOX_Y = this.configService.ELECTRICITY_BOX_Y; // Electricity box Y-coordinate
         const HEAT_BOX_Y = this.configService.HEAT_BOX_Y; // Heat box Y-coordinate
-        const TOP_Y = this.configService.TOP_Y; // Top margin for fuel labels
+        const TOP_Y = this.configService.LEFT_Y; // Top margin for fuel labels
         const SCALE = this.configService.SCALE; // Energy-to-pixel conversion (0.02)
         const LEFT_GAP = this.configService.LEFT_GAP; // Visual gap between fuel boxes
         // RESULT ARRAYS: Initialize output data structures
@@ -5647,7 +5682,7 @@ class SummaryService {
         // ELEC_BOX_Y: Base Y-coordinate for electricity box (right-hand column)
         // +50: Visual offset below electricity box for residential sector
         this.boxTops = {
-            res: this.configService.ELEC_BOX_Y + 50, // Base position for residential
+            res: this.configService.ELECTRICITY_BOX_Y + 50, // Base position for residential
             heat: this.configService.HEAT_BOX_Y + 50, // Base position for residential
             ag: 0, // Will be calculated based on residential
             indus: 0, // Will be calculated based on agriculture  
@@ -5753,13 +5788,13 @@ class GraphService {
         // Eliminates repeated property access during O(n³) loop execution
         // Performance improvement: 5-10% reduction in execution time
         const SCALE = this.configService.SCALE; // Energy-to-pixel conversion (0.02)
-        const ELEC_BOX_X = this.configService.ELEC_BOX_X; // Electricity box X-coordinate
-        const ELEC_BOX_Y = this.configService.ELEC_BOX_Y; // Electricity box Y-coordinate
+        const ELEC_BOX_X = this.configService.ELECTRICITY_BOX_X; // Electricity box X-coordinate
+        const ELEC_BOX_Y = this.configService.ELECTRICITY_BOX_Y; // Electricity box Y-coordinate
         const HEAT_BOX_X = this.configService.HEAT_BOX_X; // Heat box X-coordinate
         const HEAT_BOX_Y = this.configService.HEAT_BOX_Y; // Heat box Y-coordinate
         const BOX_WIDTH = this.configService.BOX_WIDTH; // Standard box width
         const LEFT_X = this.configService.LEFT_X; // Left column X-coordinate
-        const TOP_Y = this.configService.TOP_Y; // Top margin Y-coordinate
+        const TOP_Y = this.configService.LEFT_Y; // Top margin Y-coordinate
         const SR3 = this.configService.SR3; // Slope ratio (height/3)
         const PATH_GAP = this.configService.PATH_GAP; // Visual gap between flow paths
         const LEFT_GAP = this.configService.LEFT_GAP; // Gap between fuel boxes
@@ -6004,7 +6039,7 @@ class GraphService {
         const BOX_WIDTH = this.configService.BOX_WIDTH;
         const SCALE = this.configService.SCALE;
         const SR3 = this.configService.SR3;
-        const ELEC_GAP = this.configService.ELEC_GAP;
+        const ELEC_GAP = this.configService.ELECTRICITY_GAP;
         const HSR3 = this.configService.HSR3;
         for (let i = 0; i < this.graphs.length; ++i) {
             let current_box = null;
@@ -6036,8 +6071,8 @@ class GraphService {
         const BOX_WIDTH = this.configService.BOX_WIDTH;
         const SR3 = this.configService.SR3;
         const HSR3 = this.configService.HSR3;
-        const ELEC_GAP = this.configService.ELEC_GAP;
-        const ELEC_BOX_Y = this.configService.ELEC_BOX_Y;
+        const ELEC_GAP = this.configService.ELECTRICITY_GAP;
+        const ELEC_BOX_Y = this.configService.ELECTRICITY_BOX_Y;
         for (let i = 0; i < this.graphs.length; ++i) {
             let current_box = null;
             this.graphs[i].graph
@@ -6364,7 +6399,7 @@ class RenderingService {
             .attr('x', this.configService.LEFT_X) // X-position: left column alignment
             .attr('y', (d, i) => {
             // Calculate cumulative Y position for this fuel
-            let cumulativeTop = this.configService.TOP_Y;
+            let cumulativeTop = this.configService.LEFT_Y;
             for (let j = 0; j < i; j++) {
                 const prevFuel = leftFuels[j];
                 const prevFuelTotal = totals[prevFuel.fuel] || 0;
@@ -6420,8 +6455,8 @@ class RenderingService {
             // CONDITIONAL POSITIONING ALGORITHM: Electricity vs. Regular Sectors
             if (boxConfig.box === 'elec') {
                 // ELECTRICITY BOX: Special central positioning
-                x = this.configService.ELEC_BOX_X; // Configured X-position
-                y = this.configService.ELEC_BOX_Y - totals.elec * this.configService.SCALE; // Dynamic Y-position
+                x = this.configService.ELECTRICITY_BOX_X; // Configured X-position
+                y = this.configService.ELECTRICITY_BOX_Y - totals.elec * this.configService.SCALE; // Dynamic Y-position
             }
             else if (boxConfig.box === 'heat') {
                 // ELECTRICITY BOX: Special central positioning
@@ -6776,7 +6811,6 @@ class Sankey {
                 timestamp: Date.now(),
                 source: 'SankeyVisualization',
                 data: {
-                    version: '7.0.0',
                     services: [], // Will be populated as services come online
                     initTime: 0 // Will be updated when initialization completes
                 }
@@ -6827,7 +6861,6 @@ class Sankey {
                 timestamp: Date.now(),
                 source: 'SankeyVisualization',
                 data: {
-                    version: '7.0.0',
                     totalInitTime: totalInitializationTime,
                     dataPointCount: this.options.data.length,
                     yearRange: [
@@ -7163,7 +7196,7 @@ class Sankey {
             waste: {}
         };
         for (let i = 0; i < graphs.length; ++i) {
-            let top = this.services.configurationService.TOP_Y;
+            let top = this.services.configurationService.LEFT_Y;
             const y = graphs[i].year;
             graphNest.strokes[y] = {};
             graphNest.tops[y] = {};
@@ -7174,7 +7207,7 @@ class Sankey {
                 const f = fuel.fuel;
                 graphNest.strokes[y][f] = {};
                 if (f == 'elec') {
-                    graphNest.tops[y][f] = this.services.configurationService.ELEC_BOX_Y - summary.totals[i].elec * SCALE;
+                    graphNest.tops[y][f] = this.services.configurationService.ELECTRICITY_BOX_Y - summary.totals[i].elec * SCALE;
                 }
                 else if (f == 'heat') {
                     graphNest.tops[y][f] = this.services.configurationService.HEAT_BOX_Y - summary.totals[i].heat * SCALE;
@@ -7498,16 +7531,12 @@ class Sankey {
     mergeOptionsWithDefaults(options) {
         // Merge user options with system defaults
         return {
-            data: options.data,
-            country: options.country,
+            ...options,
             includeControls: options.includeControls !== false,
             includeTimeline: options.includeTimeline !== false,
             includeWasteToggle: options.includeWasteToggle !== false,
             autoPlay: options.autoPlay || false,
             showWasteHeat: options.showWasteHeat !== false,
-            animationSpeed: options.animationSpeed || 200,
-            width: options.width || null,
-            height: options.height || 620,
             loopAnimation: options.loopAnimation !== undefined ? options.loopAnimation : false
         };
     }
@@ -8338,8 +8367,8 @@ class AnimationService {
 }
 
 var AnimationService$1 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  AnimationService: AnimationService
+    __proto__: null,
+    AnimationService: AnimationService
 });
 
 /**
@@ -9145,9 +9174,9 @@ class InteractionService {
 }
 
 var InteractionService$1 = /*#__PURE__*/Object.freeze({
-  __proto__: null,
-  InteractionService: InteractionService
+    __proto__: null,
+    InteractionService: InteractionService
 });
 
-export { Sankey as default };
+export { DataValidationError, SankeyError, Sankey as default };
 //# sourceMappingURL=sankey.esm.js.map