# highcharts/node-export-server architecture

> Architecture diagram of the GitHub repository highcharts/node-export-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/highcharts/node-export-server
- Repository: https://github.com/highcharts/node-export-server

## Overview

Highcharts Node.js Export Server converts chart-option JSON or SVG into PNG, JPEG, SVG, or PDF. Users can invoke it through the CLI, an HTTP service, or the Node.js module API. In each mode, configuration and initialization lead to export work; pooled Puppeteer workers render the chart, and the result is returned to the caller. The README also documents Highcharts CDN caching and optional npm-based scripts. Some implementation files were not excerpted, so edges involving them rely on the SOURCE INDEX or README; uncertain wiring is omitted.

Main entry points: [`lib/index.js`](https://github.com/highcharts/node-export-server/blob/master/lib/index.js) (Module API), [`lib/server/server.js`](https://github.com/highcharts/node-export-server/blob/master/lib/server/server.js) (HTTP server), [`lib/pool.js`](https://github.com/highcharts/node-export-server/blob/master/lib/pool.js) (Worker pool), [`lib/export.js`](https://github.com/highcharts/node-export-server/blob/master/lib/export.js) (Rendering and export)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry points"]
  node_cli["CLI<br/>[cli.js]"]
  node_public_api["Module API<br/>[index.js]"]
end

subgraph group_setup["Configuration and setup"]
  node_configuration["Configuration<br/>[config.js]"]
  node_defaults["Default settings<br/>[config.js]"]
  node_environment["Environment parsing<br/>[envs.js]"]
  node_cache[("Highcharts cache<br/>[cache.js]")]
  node_fetch["Script fetching<br/>[fetch.js]"]
end

subgraph group_render["Export runtime"]
  node_chart["Chart preparation<br/>[chart.js]"]
  node_sanitization["Input sanitization<br/>[sanitize.js]"]
  node_pool["Worker pool<br/>[pool.js]"]
  node_browser["Puppeteer browser<br/>[browser.js]"]
  node_exporter["Rendering and export<br/>[export.js]"]
  node_highcharts["Highcharts loader<br/>[highcharts.js]"]
  node_svg_template["SVG export template<br/>[svg_export.js]"]
end

subgraph group_service["HTTP service"]
  node_server["HTTP server<br/>[server.js]"]
  node_export_route["Export endpoint<br/>[export.js]"]
  node_health_route["Health endpoint<br/>[health.js]"]
  node_version_route["Version endpoint"]
  node_ui_route["UI endpoint<br/>[ui.js]"]
end

subgraph group_support["Runtime support"]
  node_resource_release["Resource cleanup"]
  node_logger["Logging<br/>[logger.js]"]
  node_errors["Export errors<br/>[ExportError.js]"]
end

node_cli_user(("CLI user"))
node_module_user(("Module caller"))
node_http_user(("HTTP client"))
node_cdn["Highcharts CDN"]

node_cli_user -->|"runs"| node_cli
node_cli -->|"invokes"| node_public_api
node_module_user -->|"calls"| node_public_api
node_http_user -->|"sends requests"| node_server
node_public_api -->|"configures"| node_configuration
node_configuration -->|"loads defaults"| node_defaults
node_configuration -->|"uses parsed values"| node_environment
node_public_api -->|"updates cache"| node_cache
node_cache -->|"fetches scripts"| node_fetch
node_fetch -->|"retrieves scripts"| node_cdn
node_public_api -->|"initializes pool"| node_pool
node_public_api -->|"starts server"| node_server
node_public_api -->|"exports charts"| node_chart
node_chart -->|"dispatches work"| node_pool
node_chart -->|"sanitizes input"| node_sanitization
node_chart -->|"reads options"| node_configuration
node_pool -->|"creates pages"| node_browser
node_pool -->|"runs export"| node_exporter
node_exporter -->|"renders in"| node_browser
node_exporter -->|"uses cached scripts"| node_cache
node_exporter -->|"loads scripts"| node_highcharts
node_exporter -->|"uses template"| node_svg_template
node_server -->|"registers route"| node_export_route
node_server -->|"registers route"| node_health_route
node_server -->|"registers route"| node_version_route
node_server -->|"registers route"| node_ui_route
node_export_route -->|"requests export"| node_chart
node_health_route -->|"checks pool"| node_pool
node_health_route -->|"checks browser"| node_browser
node_health_route -->|"checks cache"| node_cache
node_version_route -->|"updates cache"| node_cache
node_public_api -->|"cleans resources"| node_resource_release
node_pool -->|"raises errors"| node_errors

click node_cli "https://github.com/highcharts/node-export-server/blob/master/bin/cli.js"
click node_public_api "https://github.com/highcharts/node-export-server/blob/master/lib/index.js"
click node_configuration "https://github.com/highcharts/node-export-server/blob/master/lib/config.js"
click node_defaults "https://github.com/highcharts/node-export-server/blob/master/lib/schemas/config.js"
click node_environment "https://github.com/highcharts/node-export-server/blob/master/lib/envs.js"
click node_cache "https://github.com/highcharts/node-export-server/blob/master/lib/cache.js"
click node_fetch "https://github.com/highcharts/node-export-server/blob/master/lib/fetch.js"
click node_chart "https://github.com/highcharts/node-export-server/blob/master/lib/chart.js"
click node_sanitization "https://github.com/highcharts/node-export-server/blob/master/lib/sanitize.js"
click node_pool "https://github.com/highcharts/node-export-server/blob/master/lib/pool.js"
click node_browser "https://github.com/highcharts/node-export-server/blob/master/lib/browser.js"
click node_exporter "https://github.com/highcharts/node-export-server/blob/master/lib/export.js"
click node_highcharts "https://github.com/highcharts/node-export-server/blob/master/lib/highcharts.js"
click node_svg_template "https://github.com/highcharts/node-export-server/blob/master/templates/svg_export/svg_export.js"
click node_server "https://github.com/highcharts/node-export-server/blob/master/lib/server/server.js"
click node_export_route "https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/export.js"
click node_health_route "https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/health.js"
click node_version_route "https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/change_hc_version.js"
click node_ui_route "https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/ui.js"
click node_resource_release "https://github.com/highcharts/node-export-server/blob/master/lib/resource_release.js"
click node_logger "https://github.com/highcharts/node-export-server/blob/master/lib/logger.js"
click node_errors "https://github.com/highcharts/node-export-server/blob/master/lib/errors/ExportError.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_public_api,node_cli_user,node_http_user toneBlue
class node_configuration,node_defaults,node_environment,node_cache,node_fetch toneAmber
class node_chart,node_sanitization,node_pool,node_browser,node_exporter,node_highcharts,node_svg_template toneMint
class node_server,node_export_route,node_health_route,node_version_route,node_ui_route toneRose
class node_resource_release,node_logger,node_errors,node_module_user,node_cdn toneIndigo
```

## Components

### Entry points

- [CLI](https://github.com/highcharts/node-export-server/blob/master/bin/cli.js): `bin/cli.js`
- [Module API](https://github.com/highcharts/node-export-server/blob/master/lib/index.js): `lib/index.js`

### Configuration and setup

- [Configuration](https://github.com/highcharts/node-export-server/blob/master/lib/config.js): `lib/config.js`
- [Default settings](https://github.com/highcharts/node-export-server/blob/master/lib/schemas/config.js): `lib/schemas/config.js`
- [Environment parsing](https://github.com/highcharts/node-export-server/blob/master/lib/envs.js): `lib/envs.js`
- [Highcharts cache](https://github.com/highcharts/node-export-server/blob/master/lib/cache.js): `lib/cache.js`
- [Script fetching](https://github.com/highcharts/node-export-server/blob/master/lib/fetch.js): `lib/fetch.js`

### Export runtime

- [Chart preparation](https://github.com/highcharts/node-export-server/blob/master/lib/chart.js): `lib/chart.js`
- [Input sanitization](https://github.com/highcharts/node-export-server/blob/master/lib/sanitize.js): `lib/sanitize.js`
- [Worker pool](https://github.com/highcharts/node-export-server/blob/master/lib/pool.js): `lib/pool.js`
- [Puppeteer browser](https://github.com/highcharts/node-export-server/blob/master/lib/browser.js): `lib/browser.js`
- [Rendering and export](https://github.com/highcharts/node-export-server/blob/master/lib/export.js): `lib/export.js`
- [Highcharts loader](https://github.com/highcharts/node-export-server/blob/master/lib/highcharts.js): `lib/highcharts.js`
- [SVG export template](https://github.com/highcharts/node-export-server/blob/master/templates/svg_export/svg_export.js): `templates/svg_export/svg_export.js`

### HTTP service

- [HTTP server](https://github.com/highcharts/node-export-server/blob/master/lib/server/server.js): `lib/server/server.js`
- [Export endpoint](https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/export.js): `lib/server/routes/export.js`
- [Health endpoint](https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/health.js): `lib/server/routes/health.js`
- [Version endpoint](https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/change_hc_version.js): `lib/server/routes/change_hc_version.js`
- [UI endpoint](https://github.com/highcharts/node-export-server/blob/master/lib/server/routes/ui.js): `lib/server/routes/ui.js`

### Runtime support

- [Resource cleanup](https://github.com/highcharts/node-export-server/blob/master/lib/resource_release.js): `lib/resource_release.js`
- [Logging](https://github.com/highcharts/node-export-server/blob/master/lib/logger.js): `lib/logger.js`
- [Export errors](https://github.com/highcharts/node-export-server/blob/master/lib/errors/ExportError.js): `lib/errors/ExportError.js`

### Other components

- **CLI user**
- **Module caller**
- **HTTP client**
- **Highcharts CDN**

## Connections

- CLI user → CLI: runs (evidence: `README.md`)
- CLI → Module API: invokes (evidence: `bin/cli.js`)
- Module caller → Module API: calls (evidence: `README.md`)
- HTTP client → HTTP server: sends requests (evidence: `README.md`)
- Module API → Configuration: configures (evidence: `lib/index.js`)
- Configuration → Default settings: loads defaults (evidence: `lib/config.js`)
- Configuration → Environment parsing: uses parsed values (evidence: `lib/config.js`)
- Module API → Highcharts cache: updates cache (evidence: `lib/index.js`)
- Highcharts cache → Script fetching: fetches scripts (evidence: `lib/cache.js`)
- Script fetching → Highcharts CDN: retrieves scripts (evidence: `README.md`)
- Module API → Worker pool: initializes pool (evidence: `lib/index.js`)
- Module API → HTTP server: starts server (evidence: `lib/index.js`)
- Module API → Chart preparation: exports charts (evidence: `lib/index.js`)
- Chart preparation → Worker pool: dispatches work (evidence: `lib/chart.js`)
- Chart preparation → Input sanitization: sanitizes input (evidence: `lib/chart.js`)
- Chart preparation → Configuration: reads options (evidence: `lib/chart.js`)
- Worker pool → Puppeteer browser: creates pages (evidence: `lib/pool.js`)
- Worker pool → Rendering and export: runs export (evidence: `lib/pool.js`)
- Rendering and export → Puppeteer browser: renders in (evidence: `lib/export.js`)
- Rendering and export → Highcharts cache: uses cached scripts (evidence: `lib/export.js`)
- Rendering and export → Highcharts loader: loads scripts (evidence: `lib/export.js`)
- Rendering and export → SVG export template: uses template (evidence: `lib/export.js`)
- HTTP server → Export endpoint: registers route (evidence: `lib/server/server.js`)
- HTTP server → Health endpoint: registers route (evidence: `lib/server/server.js`)
- HTTP server → Version endpoint: registers route (evidence: `lib/server/server.js`)
- HTTP server → UI endpoint: registers route (evidence: `lib/server/server.js`)
- Export endpoint → Chart preparation: requests export (evidence: `lib/server/routes/export.js`)
- Health endpoint → Worker pool: checks pool (evidence: `lib/server/routes/health.js`)
- Health endpoint → Puppeteer browser: checks browser (evidence: `lib/server/routes/health.js`)
- Health endpoint → Highcharts cache: checks cache (evidence: `lib/server/routes/health.js`)
- Version endpoint → Highcharts cache: updates cache (evidence: `lib/server/routes/change_hc_version.js`)
- Module API → Resource cleanup: cleans resources (evidence: `lib/index.js`)
- Worker pool → Export errors: raises errors (evidence: `lib/pool.js`)
