@ocpp-debugkit/core 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +69 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# @ocpp-debugkit/core
|
|
2
|
+
|
|
3
|
+
> Core data model, parser, normalizer, timeline, and failure detection for OCPP DebugKit.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ocpp-debugkit/core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Parse a trace
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { parseTrace } from '@ocpp-debugkit/core';
|
|
17
|
+
|
|
18
|
+
const result = parseTrace(traceString);
|
|
19
|
+
// result.events — normalized Event[]
|
|
20
|
+
// result.warnings — ParseWarning[] for malformed entries
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Accepts JSON Object, JSONL, and bare array formats.
|
|
24
|
+
|
|
25
|
+
### Build session timeline
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { buildSessionTimeline } from '@ocpp-debugkit/core';
|
|
29
|
+
|
|
30
|
+
const sessions = buildSessionTimeline(result.events);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Detect failures
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import { detectFailures } from '@ocpp-debugkit/core';
|
|
37
|
+
|
|
38
|
+
const failures = detectFailures(result.events, sessions);
|
|
39
|
+
// Three detection rules: FAILED_AUTHORIZATION, CONNECTOR_FAULT,
|
|
40
|
+
// STATION_OFFLINE_DURING_SESSION
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Generate summaries
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import { summarizeSessions } from '@ocpp-debugkit/core';
|
|
47
|
+
|
|
48
|
+
const summaries = summarizeSessions(sessions, failures);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Validate messages
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import { validateMessage } from '@ocpp-debugkit/core';
|
|
55
|
+
|
|
56
|
+
const result = validateMessage(event);
|
|
57
|
+
// result.valid, result.errors
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Key Types
|
|
61
|
+
|
|
62
|
+
- `Event` — canonical normalized OCPP message
|
|
63
|
+
- `Session` — logical charging session
|
|
64
|
+
- `Failure` — detected failure with severity and suggested steps
|
|
65
|
+
- `Scenario` — predefined trace fixture with expected failures
|
|
66
|
+
|
|
67
|
+
## License
|
|
68
|
+
|
|
69
|
+
Apache 2.0
|