@zaflun/lumio-protocol 0.1.1 → 0.2.4

package/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to `@zaflun/lumio-protocol` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.2.4
+
+Wire-format types for the Lumio Extension Platform — the contract for
+communication between extension iframes/workers and the Lumio host. Ships as an
+ESM build with generated `.d.ts` declarations; `zod` is a runtime dependency for
+the validated schemas.
+
+### Exports
+
+- **Events** (`src/events.ts`)
+  - `LUMIO_EVENT_TYPES` — 54 platform event types across Twitch, YouTube, Kick,
+    Trovo, Spotify, StreamElements, and per-platform + cross-platform chat, with
+    `LumioEventType` and the `lumioEventTypeSchema` Zod enum.
+  - `ACTION_TYPES` — 21 action types (Chat, OBS, Spotify, Events, Overlay), with
+    `LumioActionType` and `lumioActionTypeSchema`.
+  - Sound-system event payloads `SoundPlayEvent` / `SoundStopEvent`.
+  - `STORAGE_SCOPES` (`instance`, `overlay`, `account`, `global`) with
+    `StorageScope` and `storageScopeSchema`.
+- **Messages** (`src/messages.ts`)
+  - Theme schemas (`themeSchema`, colors/fonts/border-radius) and
+    `extensionConfigSchema`.
+  - `MESSAGE_TYPES` — 10 host↔iframe message types, individual per-type Zod
+    schemas, and the `lumioMessageSchema` discriminated union with `LumioMessage`.
+- **Components** (`src/components.ts`)
+  - `LUMIO_COMPONENT_TYPES` — 30 serialized-UI component types with
+    `LumioComponentType` and the `LumioComponentNode` tree interface.
+  - JSON-RPC 2.0 wire types (`JsonRpcRequest` / `JsonRpcResponse` /
+    `JsonRpcNotification`), worker↔host param interfaces, the `Sound` data type,
+    and the `WORKER_METHODS` / `HOST_METHODS` method-name constants (including
+    `sound.play` / `sound.stop` / `sound.list`).
+
+### Notes
+
+- Adds the sound-system surface (`SoundPlayEvent` / `SoundStopEvent`, `Sound`,
+  and the `SOUND_PLAY` / `SOUND_STOP` / `SOUND_LIST` worker methods) that mirrors
+  the host sound-management contract.
+- First release published with a changelog. Prior public releases: `0.2.3`,
+  `0.1.1`, `0.1.0`.

package/README.md

@@ -10,10 +10,10 @@ npm install @zaflun/lumio-protocol
 
 ## What's included
 
-- **49 Event Types** — Twitch, YouTube, Kick, Trovo, Spotify, StreamElements, Chat
+- **54 Event Types** — Twitch, YouTube, Kick, Trovo, Spotify, StreamElements, Chat
 - **21 Action Types** — Chat, OBS, Spotify, Events, Overlay
 - **Message Schemas** — JSON-RPC 2.0 wire format (Zod validated)
-- **Component Types** — `LumioComponentNode` for serialized UI trees
+- **30 Component Types** — `LumioComponentNode` for serialized UI trees
 
 ## Usage
 
@@ -35,4 +35,4 @@ const eventType: LumioEventType = "twitch:cheer";
 
 ## License
 
-MIT © [Zaflun](https://lumio.vision)
+MIT © [zaflun](https://withzaflun.com)

package/dist/index.d.ts

@@ -58,7 +58,7 @@ declare const extensionConfigSchema: z.ZodObject<{
     settings: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 }, z.core.$strip>;
 type ExtensionConfig = z.infer<typeof extensionConfigSchema>;
-declare const MESSAGE_TYPES: readonly ["INIT", "CONFIG_UPDATE", "EVENT", "ACTION", "STORAGE_UPDATE", "THEME_CHANGE", "READY", "ERROR"];
+declare const MESSAGE_TYPES: readonly ["INIT", "CONFIG_UPDATE", "EVENT", "ACTION", "STORAGE_UPDATE", "THEME_CHANGE", "READY", "ERROR", "NODE_CONFIG_REQUEST", "NODE_CONFIG_UPDATE"];
 type MessageType = (typeof MESSAGE_TYPES)[number];
 declare const initMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"INIT">;
@@ -169,6 +169,19 @@ declare const errorMessageSchema: z.ZodObject<{
     message: z.ZodString;
 }, z.core.$strip>;
 type ErrorMessage = z.infer<typeof errorMessageSchema>;
+declare const nodeConfigRequestMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"NODE_CONFIG_REQUEST">;
+    node_id: z.ZodString;
+    install_id: z.ZodString;
+}, z.core.$strip>;
+type NodeConfigRequestMessage = z.infer<typeof nodeConfigRequestMessageSchema>;
+declare const nodeConfigUpdateMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"NODE_CONFIG_UPDATE">;
+    node_id: z.ZodString;
+    install_id: z.ZodString;
+    config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+type NodeConfigUpdateMessage = z.infer<typeof nodeConfigUpdateMessageSchema>;
 declare const lumioMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"INIT">;
     config: z.ZodObject<{
@@ -262,6 +275,15 @@ declare const lumioMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"ERROR">;
     code: z.ZodString;
     message: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"NODE_CONFIG_REQUEST">;
+    node_id: z.ZodString;
+    install_id: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"NODE_CONFIG_UPDATE">;
+    node_id: z.ZodString;
+    install_id: z.ZodString;
+    config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 }, z.core.$strip>], "type">;
 type LumioMessage = z.infer<typeof lumioMessageSchema>;
 
@@ -348,20 +370,37 @@ declare const lumioActionTypeSchema: z.ZodEnum<{
     "events:emit": "events:emit";
     "overlay:update_layer": "overlay:update_layer";
 }>;
+interface SoundPlayEvent {
+    sound_id: string;
+    stream_path: string;
+    name: string;
+    volume: number;
+    target?: {
+        type: "widget" | "overlay";
+        id: string;
+    } | null;
+}
+interface SoundStopEvent {
+    sound_id: string;
+    target?: {
+        type: "widget" | "overlay";
+        id: string;
+    } | null;
+}
 declare const STORAGE_SCOPES: readonly ["instance", "overlay", "account", "global"];
 type StorageScope = (typeof STORAGE_SCOPES)[number];
 declare const storageScopeSchema: z.ZodEnum<{
-    instance: "instance";
     overlay: "overlay";
+    instance: "instance";
     account: "account";
     global: "global";
 }>;
 
-declare const LUMIO_COMPONENT_TYPES: readonly ["Box", "VStack", "HStack", "CompactView", "List", "Text", "Image", "Button", "Toggle", "TextField", "TextArea", "NumberField", "Dropdown", "Slider"];
+declare const LUMIO_COMPONENT_TYPES: readonly ["Box", "VStack", "HStack", "CompactView", "List", "Text", "Image", "Button", "Toggle", "TextField", "TextArea", "NumberField", "Dropdown", "Slider", "IconPicker", "IconDisplay", "EditorInput", "EditorTextarea", "EditorSelect", "EditorCheckbox", "EditorSlider", "EditorColorPicker", "EditorGroup", "EditorLabel", "EditorDivider", "EditorInfo", "EditorFontRow", "EditorButton", "EditorFontPicker", "EditorChannelRow"];
 type LumioComponentType = (typeof LUMIO_COMPONENT_TYPES)[number];
 interface LumioComponentNode {
     _id: string;
-    type: LumioComponentType;
+    type: LumioComponentType | (string & {});
     props: Record<string, unknown>;
     children: LumioComponentNode[];
 }
@@ -410,6 +449,23 @@ interface ServerMutationParams {
     fn: string;
     params: Record<string, unknown>;
 }
+interface SoundPlayParams {
+    sound_id: string;
+    volume?: number;
+}
+interface SoundStopParams {
+    sound_id: string;
+}
+interface SoundGetListParams {
+}
+interface Sound {
+    id: string;
+    name: string;
+    file_size: number;
+    duration_ms: number | null;
+    created_at: string;
+    source_extension_name: string | null;
+}
 interface LifecycleInitParams {
     extensionId: string;
     installId: string;
@@ -443,6 +499,11 @@ declare const WORKER_METHODS: {
     readonly STORAGE_GET: "storage.get";
     readonly SERVER_QUERY: "server.query";
     readonly SERVER_MUTATION: "server.mutation";
+    readonly CONFIG_UPDATE: "config.update";
+    readonly UI_ACTION: "ui.action";
+    readonly SOUND_PLAY: "sound.play";
+    readonly SOUND_STOP: "sound.stop";
+    readonly SOUND_LIST: "sound.list";
 };
 declare const HOST_METHODS: {
     readonly LIFECYCLE_INIT: "lifecycle.init";
@@ -451,6 +512,7 @@ declare const HOST_METHODS: {
     readonly EVENT_PLATFORM: "event.platform";
     readonly STORAGE_UPDATE: "storage.update";
     readonly THEME_CHANGE: "theme.change";
+    readonly CONFIG_UPDATE: "config.update";
 };
 
-export { ACTION_TYPES, type ActionMessage, type ConfigUpdateMessage, type ErrorMessage, type EventCallbackParams, type EventMessage, type EventPlatformParams, type ExtensionConfig, HOST_METHODS, type InitMessage, type JsonRpcMessage, type JsonRpcNotification, type JsonRpcRequest, type JsonRpcResponse, LUMIO_COMPONENT_TYPES, LUMIO_EVENT_TYPES, type LifecycleDestroyParams, type LifecycleInitParams, type LumioActionType, type LumioComponentNode, type LumioComponentType, type LumioEventType, type LumioMessage, MESSAGE_TYPES, type MessageType, type ReadyMessage, STORAGE_SCOPES, type ServerMutationParams, type ServerQueryParams, type StorageGetParams, type StorageScope, type StorageSetParams, type StorageUpdateMessage, type StorageUpdateParams, type Theme, type ThemeBorderRadius, type ThemeChangeMessage, type ThemeChangeParams, type ThemeColors, type ThemeFonts, type UiKeyframesParams, type UiReadyParams, type UiRenderParams, WORKER_METHODS, actionMessageSchema, configUpdateMessageSchema, errorMessageSchema, eventMessageSchema, extensionConfigSchema, initMessageSchema, lumioActionTypeSchema, lumioEventTypeSchema, lumioMessageSchema, readyMessageSchema, storageScopeSchema, storageUpdateMessageSchema, themeBorderRadiusSchema, themeChangeMessageSchema, themeColorsSchema, themeFontsSchema, themeSchema };
+export { ACTION_TYPES, type ActionMessage, type ConfigUpdateMessage, type ErrorMessage, type EventCallbackParams, type EventMessage, type EventPlatformParams, type ExtensionConfig, HOST_METHODS, type InitMessage, type JsonRpcMessage, type JsonRpcNotification, type JsonRpcRequest, type JsonRpcResponse, LUMIO_COMPONENT_TYPES, LUMIO_EVENT_TYPES, type LifecycleDestroyParams, type LifecycleInitParams, type LumioActionType, type LumioComponentNode, type LumioComponentType, type LumioEventType, type LumioMessage, MESSAGE_TYPES, type MessageType, type NodeConfigRequestMessage, type NodeConfigUpdateMessage, type ReadyMessage, STORAGE_SCOPES, type ServerMutationParams, type ServerQueryParams, type Sound, type SoundGetListParams, type SoundPlayEvent, type SoundPlayParams, type SoundStopEvent, type SoundStopParams, type StorageGetParams, type StorageScope, type StorageSetParams, type StorageUpdateMessage, type StorageUpdateParams, type Theme, type ThemeBorderRadius, type ThemeChangeMessage, type ThemeChangeParams, type ThemeColors, type ThemeFonts, type UiKeyframesParams, type UiReadyParams, type UiRenderParams, WORKER_METHODS, actionMessageSchema, configUpdateMessageSchema, errorMessageSchema, eventMessageSchema, extensionConfigSchema, initMessageSchema, lumioActionTypeSchema, lumioEventTypeSchema, lumioMessageSchema, nodeConfigRequestMessageSchema, nodeConfigUpdateMessageSchema, readyMessageSchema, storageScopeSchema, storageUpdateMessageSchema, themeBorderRadiusSchema, themeChangeMessageSchema, themeColorsSchema, themeFontsSchema, themeSchema };

package/dist/index.js

@@ -41,7 +41,9 @@ var MESSAGE_TYPES = [
   "STORAGE_UPDATE",
   "THEME_CHANGE",
   "READY",
-  "ERROR"
+  "ERROR",
+  "NODE_CONFIG_REQUEST",
+  "NODE_CONFIG_UPDATE"
 ];
 var initMessageSchema = z.object({
   type: z.literal("INIT"),
@@ -80,6 +82,17 @@ var errorMessageSchema = z.object({
   code: z.string(),
   message: z.string()
 });
+var nodeConfigRequestMessageSchema = z.object({
+  type: z.literal("NODE_CONFIG_REQUEST"),
+  node_id: z.string(),
+  install_id: z.string()
+});
+var nodeConfigUpdateMessageSchema = z.object({
+  type: z.literal("NODE_CONFIG_UPDATE"),
+  node_id: z.string(),
+  install_id: z.string(),
+  config: z.record(z.string(), z.unknown())
+});
 var lumioMessageSchema = z.discriminatedUnion("type", [
   initMessageSchema,
   configUpdateMessageSchema,
@@ -88,7 +101,9 @@ var lumioMessageSchema = z.discriminatedUnion("type", [
   storageUpdateMessageSchema,
   themeChangeMessageSchema,
   readyMessageSchema,
-  errorMessageSchema
+  errorMessageSchema,
+  nodeConfigRequestMessageSchema,
+  nodeConfigUpdateMessageSchema
 ]);
 
 // src/events.ts
@@ -210,7 +225,23 @@ var LUMIO_COMPONENT_TYPES = [
   "TextArea",
   "NumberField",
   "Dropdown",
-  "Slider"
+  "Slider",
+  "IconPicker",
+  "IconDisplay",
+  "EditorInput",
+  "EditorTextarea",
+  "EditorSelect",
+  "EditorCheckbox",
+  "EditorSlider",
+  "EditorColorPicker",
+  "EditorGroup",
+  "EditorLabel",
+  "EditorDivider",
+  "EditorInfo",
+  "EditorFontRow",
+  "EditorButton",
+  "EditorFontPicker",
+  "EditorChannelRow"
 ];
 var WORKER_METHODS = {
   UI_RENDER: "ui.render",
@@ -219,7 +250,12 @@ var WORKER_METHODS = {
   STORAGE_SET: "storage.set",
   STORAGE_GET: "storage.get",
   SERVER_QUERY: "server.query",
-  SERVER_MUTATION: "server.mutation"
+  SERVER_MUTATION: "server.mutation",
+  CONFIG_UPDATE: "config.update",
+  UI_ACTION: "ui.action",
+  SOUND_PLAY: "sound.play",
+  SOUND_STOP: "sound.stop",
+  SOUND_LIST: "sound.list"
 };
 var HOST_METHODS = {
   LIFECYCLE_INIT: "lifecycle.init",
@@ -227,7 +263,8 @@ var HOST_METHODS = {
   EVENT_CALLBACK: "event.callback",
   EVENT_PLATFORM: "event.platform",
   STORAGE_UPDATE: "storage.update",
-  THEME_CHANGE: "theme.change"
+  THEME_CHANGE: "theme.change",
+  CONFIG_UPDATE: "config.update"
 };
 export {
   ACTION_TYPES,
@@ -246,6 +283,8 @@ export {
   lumioActionTypeSchema,
   lumioEventTypeSchema,
   lumioMessageSchema,
+  nodeConfigRequestMessageSchema,
+  nodeConfigUpdateMessageSchema,
   readyMessageSchema,
   storageScopeSchema,
   storageUpdateMessageSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zaflun/lumio-protocol",
-  "version": "0.1.1",
+  "version": "0.2.4",
   "description": "Wire-format types for Lumio extension iframe-to-host communication",
   "type": "module",
   "main": "dist/index.js",
@@ -15,7 +15,8 @@
     "access": "public"
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "dependencies": {
     "zod": "^4.3.6"