# barchart/alerting-service-public architecture

> Architecture diagram of the GitHub repository barchart/alerting-service-public, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/barchart/alerting-service-public
- Repository: https://github.com/barchart/alerting-service-public

## Overview

This repository is a JavaScript SDK for Barchart’s remote Alerting Service. An application uses the SDK to define conditional alerts, publishers and schedules, then the AlertManager creates or manages them through a transport adapter; the service continuously evaluates conditions and sends notifications. The SDK also exposes alert and trigger monitoring, templates, market-data metadata and publisher defaults. The source excerpts establish the main manager, HTTP adapter, builders, validation and JWT behavior; several documented capabilities have unsampled implementations, so their internal links are intentionally limited.

Main entry points: [`lib/AlertManager.js`](https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js) (AlertManager), [`lib/builder/builders/AlertBuilder.js`](https://github.com/barchart/alerting-service-public/blob/master/lib/builder/builders/AlertBuilder.js) (Alert builder), [`lib/adapters/AdapterBase.js`](https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterBase.js) (Transport contract), [`lib/adapters/AdapterForHttp.js`](https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterForHttp.js) (HTTP adapter)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_authoring["Alert authoring"]
  node_builders["Alert builder<br/>[AlertBuilder.js]"]
  node_conditions["Condition builder"]
  node_publishers["Publisher builder"]
  node_alertdata["Alert model<br/>[Alert.js]"]
end

subgraph group_management["Alert management"]
  node_manager["AlertManager<br/>[AlertManager.js]"]
  node_subscriptions["Alert subscriptions<br/>[AlertManager.js]"]
  node_triggers["Trigger monitoring<br/>[AlertManager.js]"]
  node_templates["Template management<br/>[AlertManager.js]"]
  node_marketdata["Market data lookup<br/>[AlertManager.js]"]
  node_metadata["Alert metadata<br/>[AlertManager.js]"]
  node_servicecapabilities["Service configuration<br/>[AdapterBase.js]"]
end

subgraph group_transport["Service transport"]
  node_adapterbase["Transport contract<br/>[AdapterBase.js]"]
  node_http["HTTP adapter<br/>[AdapterForHttp.js]"]
  node_socket["Socket.IO adapter"]
end

subgraph group_support["SDK support"]
  node_validators["Request validators"]
  node_jwt["JWT provider<br/>[JwtProvider.js]"]
  node_config["Environment configuration<br/>[Configuration.js]"]
end

node_app(("Client application"))
node_service{{"Barchart Alerting Service"}}

node_app -->|"uses SDK"| node_manager
node_app -->|"defines alerts"| node_builders
node_builders -->|"builds conditions"| node_conditions
node_builders -->|"builds publishers"| node_publishers
node_builders -->|"constructs model"| node_alertdata
node_manager -->|"validates requests"| node_validators
node_manager -->|"uses transport contract"| node_adapterbase
node_adapterbase -->|"implemented by"| node_http
node_adapterbase -->|"implemented by"| node_socket
node_http -->|"sends API requests"| node_service
node_manager -->|"manages"| node_subscriptions
node_manager -->|"monitors"| node_triggers
node_manager -->|"manages"| node_templates
node_manager -->|"looks up instruments"| node_marketdata
node_manager -->|"retrieves metadata"| node_metadata
node_adapterbase -->|"defines operations"| node_servicecapabilities
node_jwt -->|"reads host config"| node_config
node_jwt -->|"requests impersonation token"| node_service
node_http -->|"authenticates requests"| node_jwt

click node_manager "https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js"
click node_builders "https://github.com/barchart/alerting-service-public/blob/master/lib/builder/builders/AlertBuilder.js"
click node_conditions "https://github.com/barchart/alerting-service-public/blob/master/lib/builder/builders/ConditionBuilder.js"
click node_publishers "https://github.com/barchart/alerting-service-public/blob/master/lib/builder/builders/PublisherBuilder.js"
click node_alertdata "https://github.com/barchart/alerting-service-public/blob/master/lib/builder/data/Alert.js"
click node_validators "https://github.com/barchart/alerting-service-public/tree/master/lib/data/validators"
click node_adapterbase "https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterBase.js"
click node_http "https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterForHttp.js"
click node_socket "https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterForSocketIo.js"
click node_jwt "https://github.com/barchart/alerting-service-public/blob/master/lib/security/JwtProvider.js"
click node_config "https://github.com/barchart/alerting-service-public/blob/master/lib/common/Configuration.js"
click node_subscriptions "https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js"
click node_triggers "https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js"
click node_templates "https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js"
click node_marketdata "https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js"
click node_metadata "https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js"
click node_servicecapabilities "https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterBase.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_builders,node_conditions,node_publishers,node_alertdata,node_app toneBlue
class node_manager,node_subscriptions,node_triggers,node_templates,node_marketdata,node_metadata,node_servicecapabilities toneAmber
class node_adapterbase,node_http,node_socket toneMint
class node_validators,node_jwt,node_config toneRose
class node_service toneIndigo
```

## Components

### Alert authoring

- [Alert builder](https://github.com/barchart/alerting-service-public/blob/master/lib/builder/builders/AlertBuilder.js): `lib/builder/builders/AlertBuilder.js`
- [Condition builder](https://github.com/barchart/alerting-service-public/blob/master/lib/builder/builders/ConditionBuilder.js): `lib/builder/builders/ConditionBuilder.js`
- [Publisher builder](https://github.com/barchart/alerting-service-public/blob/master/lib/builder/builders/PublisherBuilder.js): `lib/builder/builders/PublisherBuilder.js`
- [Alert model](https://github.com/barchart/alerting-service-public/blob/master/lib/builder/data/Alert.js): `lib/builder/data/Alert.js`

### Alert management

- [AlertManager](https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js): `lib/AlertManager.js`
- [Alert subscriptions](https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js): `lib/AlertManager.js`
- [Trigger monitoring](https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js): `lib/AlertManager.js`
- [Template management](https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js): `lib/AlertManager.js`
- [Market data lookup](https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js): `lib/AlertManager.js`
- [Alert metadata](https://github.com/barchart/alerting-service-public/blob/master/lib/AlertManager.js): `lib/AlertManager.js`
- [Service configuration](https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterBase.js): `lib/adapters/AdapterBase.js`

### Service transport

- [Transport contract](https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterBase.js): `lib/adapters/AdapterBase.js`
- [HTTP adapter](https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterForHttp.js): `lib/adapters/AdapterForHttp.js`
- [Socket.IO adapter](https://github.com/barchart/alerting-service-public/blob/master/lib/adapters/AdapterForSocketIo.js): `lib/adapters/AdapterForSocketIo.js`

### SDK support

- [Request validators](https://github.com/barchart/alerting-service-public/tree/master/lib/data/validators): `lib/data/validators`
- [JWT provider](https://github.com/barchart/alerting-service-public/blob/master/lib/security/JwtProvider.js): `lib/security/JwtProvider.js`
- [Environment configuration](https://github.com/barchart/alerting-service-public/blob/master/lib/common/Configuration.js): `lib/common/Configuration.js`

### Other components

- **Client application**
- **Barchart Alerting Service**

## Connections

- Client application → AlertManager: uses SDK (evidence: `README.md`)
- Client application → Alert builder: defines alerts (evidence: `README.md`)
- Alert builder → Condition builder: builds conditions (evidence: `lib/builder/builders/AlertBuilder.js`)
- Alert builder → Publisher builder: builds publishers (evidence: `lib/builder/builders/AlertBuilder.js`)
- Alert builder → Alert model: constructs model (evidence: `lib/builder/builders/AlertBuilder.js`)
- AlertManager → Request validators: validates requests (evidence: `lib/AlertManager.js`)
- AlertManager → Transport contract: uses transport contract (evidence: `lib/AlertManager.js`)
- Transport contract → HTTP adapter: implemented by (evidence: `lib/adapters/AdapterBase.js`)
- Transport contract → Socket.IO adapter: implemented by (evidence: `lib/adapters/AdapterBase.js`)
- HTTP adapter → Barchart Alerting Service: sends API requests (evidence: `lib/adapters/AdapterForHttp.js`)
- AlertManager → Alert subscriptions: manages (evidence: `lib/AlertManager.js`)
- AlertManager → Trigger monitoring: monitors (evidence: `lib/AlertManager.js`)
- AlertManager → Template management: manages (evidence: `lib/AlertManager.js`)
- AlertManager → Market data lookup: looks up instruments (evidence: `lib/AlertManager.js`)
- AlertManager → Alert metadata: retrieves metadata (evidence: `lib/AlertManager.js`)
- Transport contract → Service configuration: defines operations (evidence: `lib/adapters/AdapterBase.js`)
- JWT provider → Environment configuration: reads host config (evidence: `lib/security/JwtProvider.js`)
- JWT provider → Barchart Alerting Service: requests impersonation token (evidence: `lib/security/JwtProvider.js`)
- HTTP adapter → JWT provider: authenticates requests (evidence: `lib/adapters/AdapterForHttp.js`)
