@zaflun/lumio-protocol 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 +38 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @zaflun/lumio-protocol
|
|
2
|
+
|
|
3
|
+
Wire-format types for the Lumio Extension Platform. Defines message schemas, event types, action types, and component node types used for communication between extension iframes and the Lumio host.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @zaflun/lumio-protocol
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## What's included
|
|
12
|
+
|
|
13
|
+
- **49 Event Types** — Twitch, YouTube, Kick, Trovo, Spotify, StreamElements, Chat
|
|
14
|
+
- **21 Action Types** — Chat, OBS, Spotify, Events, Overlay
|
|
15
|
+
- **Message Schemas** — JSON-RPC 2.0 wire format (Zod validated)
|
|
16
|
+
- **Component Types** — `LumioComponentNode` for serialized UI trees
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { LUMIO_EVENT_TYPES, lumioEventTypeSchema } from "@zaflun/lumio-protocol";
|
|
22
|
+
import type { LumioEventType, LumioComponentNode } from "@zaflun/lumio-protocol";
|
|
23
|
+
|
|
24
|
+
// Validate an event type
|
|
25
|
+
const result = lumioEventTypeSchema.safeParse("twitch:follower");
|
|
26
|
+
|
|
27
|
+
// Type-safe event handling
|
|
28
|
+
const eventType: LumioEventType = "twitch:cheer";
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Documentation
|
|
32
|
+
|
|
33
|
+
- [Developer Docs](https://developers.lumio.vision)
|
|
34
|
+
- [API Reference](https://developers.lumio.vision/api-reference/types)
|
|
35
|
+
|
|
36
|
+
## License
|
|
37
|
+
|
|
38
|
+
MIT © [Zaflun](https://lumio.vision)
|