Contact
Open source · IoT & Edge

MQTT Topic Contract Validator

Validate MQTT topics, QoS choices, retained messages and payload versions.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Offline, read-only validator of exported MQTT topic contracts and message metadata. It does not connect to a broker, subscribe, publish, retain, or parse payload bodies. Node.js 22+, zero dependencies. src/index.mjs exports validateMqttContracts(fixtures, policy, {now, deadline}) and TOOLID.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/mqtt-topic-contract-validator.mjs --root examples --policy policy.json --fixtures passing-fixtures.json
node bin/mqtt-topic-contract-validator.mjs --root examples --policy policy.json --fixtures failing-fixtures.json

Read the result

The synthetic examples exit 0 and 1. --help prints usage to stderr; normal runs print a bounded human summary to stderr. Stdout contains only the v1 JSON report.