diff --git a/.changeset/readme-rule-scenario-counts.md b/.changeset/readme-rule-scenario-counts.md new file mode 100644 index 0000000..b66d7ac --- /dev/null +++ b/.changeset/readme-rule-scenario-counts.md @@ -0,0 +1,5 @@ +--- +'@ocpp-debugkit/toolkit': patch +--- + +Correct the package README, which advertised 10 detection rules and 10 predefined scenarios. The toolkit ships 16 detection rules (4 critical, 10 warning, 2 info) and 15 scenarios. diff --git a/CURRENT_STATE.md b/CURRENT_STATE.md index 7e7f10b..890217d 100644 --- a/CURRENT_STATE.md +++ b/CURRENT_STATE.md @@ -4,15 +4,15 @@ ## Current Version -`0.3.0` — Integrations & OSS Credibility (published) +`0.3.1` — Integrations & OSS Credibility (published) ## Active Milestone **v1.0.0 — Stable FOSS Ecosystem (next)** -v0.3.0 is published to npm. Adds trace diffing, rich scenario assertions, -CI/anonymize/diff CLI commands, 15 detection rules, 15 scenarios, integration -examples, and contributor onboarding. +v0.3.1 is published to npm. The v0.3 line adds trace diffing, rich scenario +assertions, CI/anonymize/diff CLI commands, 16 detection rules, 15 scenarios, +integration examples, and contributor onboarding. ## What's Done @@ -219,6 +219,11 @@ examples, and contributor onboarding. - ✅ `REPEATED_BOOT_NOTIFICATION` — flags 2+ BootNotification calls within five minutes. Added as the 16th detection rule (Issue #105). +### v0.3.1 Release + +- ✅ `@ocpp-debugkit/toolkit@0.3.1` published to npm +- ✅ Git tag `v0.3.1` + GitHub release `v0.3.1` created + ## What's Next 1. **v1.0.0 — Stable FOSS Ecosystem** — API stabilization, 20+ scenarios, docs @@ -234,7 +239,7 @@ examples, and contributor onboarding. | Package | Status | Version | |---------|--------|---------| -| `@ocpp-debugkit/toolkit` | published | 0.3.0 | +| `@ocpp-debugkit/toolkit` | published | 0.3.1 | | `@ocpp-debugkit/core` | deprecated | 0.1.1 | | `@ocpp-debugkit/scenarios` | deprecated | 0.1.1 | | `@ocpp-debugkit/reporter` | deprecated | 0.1.1 | diff --git a/README.md b/README.md index c1dcd3f..381df72 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,14 @@ validate behavior against known scenarios. - **Trace Inspector** — Load OCPP traces, view session timelines, inspect individual messages, and identify failures. -- **Failure Detection** — 10 detection rules covering common failure patterns - (failed authorization, connector faults, station offline, heartbeat timeout, - meter value gaps, invalid stop reasons, status transition violations, - diagnostics failures, firmware update failures, unexpected starts). -- **Scenario Evaluator** — 10 predefined scenarios with expected failure +- **Failure Detection** — 16 detection rules (4 critical, 10 warning, 2 info) + covering common failure patterns: failed authorization, connector faults, + station offline, heartbeat timeout, meter value gaps, invalid stop reasons, + unexpected starts, status transition violations, diagnostics failures, + firmware update failures, suspicious session duration, slow CSMS responses, + heartbeat interval violations, meter value anomalies, unresponsive CSMS, and + repeated boot notifications. +- **Scenario Evaluator** — 15 predefined scenarios with expected failure outcomes for testing the analysis engine. Supports external scenario files. - **Replay Engine** — Deterministic, pure replay engine with step forward/back, jump-to-event, and configurable playback speed. diff --git a/packages/toolkit/README.md b/packages/toolkit/README.md index b108ecb..1613b6f 100644 --- a/packages/toolkit/README.md +++ b/packages/toolkit/README.md @@ -8,11 +8,14 @@ report generation, React components, and CLI. - **Trace Parser** — Parse OCPP 1.6 JSON traces in JSON Object, JSONL, or bare array format. Safe parsing with size and event-count limits. -- **Failure Detection** — 10 detection rules covering common failure patterns - (failed authorization, connector faults, station offline, heartbeat timeout, - meter value gaps, invalid stop reasons, status transition violations, - diagnostics failures, firmware update failures, unexpected starts). -- **Scenario Evaluator** — 10 predefined scenarios with expected failure +- **Failure Detection** — 16 detection rules (4 critical, 10 warning, 2 info) + covering common failure patterns: failed authorization, connector faults, + station offline, heartbeat timeout, meter value gaps, invalid stop reasons, + unexpected starts, status transition violations, diagnostics failures, + firmware update failures, suspicious session duration, slow CSMS responses, + heartbeat interval violations, meter value anomalies, unresponsive CSMS, and + repeated boot notifications. +- **Scenario Evaluator** — 15 predefined scenarios with expected failure outcomes for testing the analysis engine. Supports external scenario files. - **Replay Engine** — Deterministic, pure replay engine with step forward/back, jump-to-event, and configurable playback speed. No timers or I/O.