energy-visualization-sankey 1.0.11 → 1.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "energy-visualization-sankey",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "A modern TypeScript library for creating interactive Sankey diagrams that visualize energy flows from sources to consumption sectors.",
   "keywords": [
     "sankey",
@@ -30,11 +30,11 @@
       "import": "./dist/sankey.esm.js",
       "require": "./dist/sankey.umd.js"
     },
-    "./styles": "./dist/styles.css"
+    "./styles": "./dist/sankey.css"
   },
   "scripts": {
     "dev": "rollup -c -w",
-    "build": "rollup -c",
+    "build": "rollup -c && tsc-alias -p tsconfig.json",
     "build:dev": "rollup -c",
     "type-check": "tsc --noEmit",
     "clean": "rm -rf dist",
@@ -73,6 +73,7 @@
     "rollup": "^4.6.1",
     "rollup-plugin-postcss": "^4.0.2",
     "rollup-plugin-typescript2": "^0.36.0",
+    "tsc-alias": "^1.8.16",
     "tslib": "^2.6.0",
     "typescript": "^5.3.0"
   }

package/rollup.config.js

@@ -27,7 +27,7 @@ const cssConfig = {
 };
 
 const baseConfig = {
-    input: 'src/core/Sankey.ts',
+    input: 'src/index.ts',
     // Embed D3 in the bundle for standalone distribution
     external: [],
     plugins: [
@@ -41,7 +41,16 @@ const baseConfig = {
             clean: true,
             abortOnError: false,
             rollupCommonJSResolveHack: false,
-            typescript: ts
+            typescript: ts,
+            tsconfigOverride: {
+                compilerOptions: {
+                    declaration: true,
+                    declarationMap: true,
+                    declarationDir: './dist/types',
+                    baseUrl: '.',
+                    paths: {}
+                }
+            }
         })
     ]
 };

package/src/core/Sankey.ts

@@ -205,7 +205,6 @@ export default 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
                 }
@@ -266,7 +265,6 @@ export default class Sankey {
                 timestamp: Date.now(),
                 source: 'SankeyVisualization',
                 data: {
-                    version: '7.0.0',
                     totalInitTime: totalInitializationTime,
                     dataPointCount: this.options.data.length,
                     yearRange: [
@@ -672,7 +670,7 @@ export default class Sankey {
         };
 
         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] = {};
@@ -686,7 +684,7 @@ export default class Sankey {
                 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;
                 } else {
@@ -1053,16 +1051,12 @@ export default class Sankey {
     private mergeOptionsWithDefaults(options: SankeyOptions): SankeyOptions {
         // 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
         };
     }

package/src/index.ts

@@ -23,13 +23,13 @@ export type {
     YearTotals,
     BoxMaxes,
     BoxTops
-} from '@/types/index';
+} from './types/index';
 
 // Export error handling types
 export {
     SankeyError,
     DataValidationError
-} from '@/types/index';
+} from './types/index';
 
 // Export the main visualization class
-export {default as default} from '@/core/Sankey';
+export {default as default} from './core/Sankey';

package/src/services/ConfigurationService.ts

@@ -61,24 +61,22 @@ export class ConfigurationService {
     // ===================== COORDINATE POSITIONING CONSTANTS =====================
 
     // LEFT COLUMN POSITIONING: Fuel source boxes alignment
-    public readonly LEFT_X = 10;                        // X-coordinate for left column (fuel sources)
-    public readonly TOP_Y = 100;                        // Y-coordinate for top margin (visual breathing space)
+    public readonly LEFT_X: number = 10;                        // X-coordinate for left column (fuel sources)
+    public readonly LEFT_Y: number = 100;                        // Y-coordinate for top margin (visual breathing space)
 
     // ==================== MATHEMATICAL SCALING CONSTANTS ====================
 
     // ENERGY-TO-PIXEL CONVERSION: Critical scaling factor for proportional representation
-    public readonly SCALE = 0.02;                       // Converts Quads to pixels: 1 Quad = 0.02 pixels height
+    public readonly SCALE: number = 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)
-    public readonly ELEC_BOX_X = 320 as const;
-    public readonly ELEC_BOX_Y = 120 as const;
+    public readonly ELECTRICITY_BOX_X: number = 320 as const;
+    public readonly ELECTRICITY_BOX_Y: number = 120 as const;
 
-    public readonly HEAT_BOX_X = 750 as const;
-    public readonly HEAT_BOX_Y = 200 as const;
-    // X=350: Positioned between fuel sources (left) and sectors (right)
-    // Y=120: Offset below title area for visual clarity
+    public readonly HEAT_BOX_X: number = 750 as const;
+    public readonly HEAT_BOX_Y: number = 200 as const;
 
     // ======================== VISUAL SPACING CONSTANTS ========================
 
@@ -87,7 +85,7 @@ export class ConfigurationService {
     public readonly RIGHT_GAP: number;                  // Gap between sector boxes (right column) - computed as LEFT_GAP × 2.1
 
     // ANIMATION PARAMETERS: Timing and transition control
-    public readonly SPEED: number;                      // Animation speed in milliseconds (from user options, default 200)
+    public readonly SPEED: number = 200;                      // Animation speed in milliseconds (from user options, default 200)
     public readonly BLEED = 0.5;                        // Edge bleed factor for smooth visual transitions
 
     // =================== GEOMETRIC CALCULATION CONSTANTS ===================
@@ -100,7 +98,7 @@ export class ConfigurationService {
     // FLOW PATH SPACING: Visual separation between parallel energy flows
     public readonly PATH_GAP: number = 20;                      // Pixel gap between parallel flow paths
     // Prevents visual overlap while maintaining readability
-    public readonly ELEC_GAP = 19;                      // Special gap for electricity flows (slightly smaller)
+    public readonly ELECTRICITY_GAP = 19;                      // Special gap for electricity flows (slightly smaller)
     // Optimized for electricity box's central position
 
     // ====================== ENERGY SOURCE DEFINITIONS ======================
@@ -165,7 +163,31 @@ export class ConfigurationService {
     ) {
         // 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,
@@ -366,39 +388,54 @@ export class ConfigurationService {
     private validateConfiguration(): void {
         // 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}`);
             }
         }
 
@@ -406,11 +443,11 @@ export class ConfigurationService {
         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 ====================

package/src/services/RenderingService.ts

@@ -172,7 +172,7 @@ export class RenderingService {
             .attr('x', this.configService.LEFT_X)                           // X-position: left column alignment
             .attr('y', (d: any, i: number) => {                            // Y-position: calculated per fuel
                 // 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;
@@ -236,8 +236,8 @@ export 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
                 x = this.configService.HEAT_BOX_X;                         // Configured X-position

package/src/services/calculation/GraphService.ts

@@ -97,13 +97,13 @@ export 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
@@ -382,7 +382,7 @@ export 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) {
@@ -415,8 +415,8 @@ export 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: string | null = null;

package/src/services/calculation/SummaryService.ts

@@ -118,9 +118,9 @@ export 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
 
@@ -372,7 +372,7 @@ export 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  

package/src/types/index.ts

@@ -74,8 +74,15 @@ export interface SankeyOptions {
     readonly autoPlay?: boolean;
     readonly showWasteHeat?: boolean;
     readonly animationSpeed?: number;
-    readonly width?: number | null;
+    readonly width?: number;
     readonly height?: number;
+    readonly scale?: number;
+    readonly leftX?: number;
+    readonly leftY?: number;
+    readonly electricityBoxX?: number;
+    readonly electricityBoxY?: number;
+    readonly heatBoxX?: number;
+    readonly heatBoxY?: number;
     readonly loopAnimation?: boolean;
     readonly debugLogging?: boolean;
 }

package/tsconfig.json

@@ -24,6 +24,7 @@
     "declaration": true,
     "declarationMap": true,
     "outDir": "./dist",
+    "declarationDir": "./dist/types",
     "rootDir": "./src",
     "strict": true,
     "noImplicitAny": true,