@ospp/protocol

TypeScript SDK for the OSPP (Open Station Payment Protocol) v0.2.5.

Install

npm install @ospp/protocol

What's included

• 27 MQTT actions with full TypeScript types for all request/response/event payloads
• 102 error codes with severity, recoverable, and HTTP status metadata
• 41 configuration keys with type, access mode, mutability, and default values
• 5 state machines (Bay, Session, Reservation, Firmware, Diagnostics) with enforced transitions
• HMAC-SHA256 canonical JSON serialization, signing, and timing-safe verification
• ECDSA P-256 signing and verification
• HMAC signing classification per (action, messageType) with Critical/All/None modes
• JSON Schema validation (Ajv Draft 2020-12) with 64 bundled schemas
• MQTT topic builders with shared subscription support

Usage

import {
  OsppAction,
  createEnvelope,
  MessageType,
  MessageSource,
  SchemaValidator,
  BayStateMachine,
  computeMac,
  verifyMac,
  requiresHmac,
  toServerTopic,
} from '@ospp/protocol';

Build

npm run build

Test

npm test

License

See LICENSE file.