@zaflun/lumio-protocol 0.6.0 → 0.10.0

package/CHANGELOG.md

@@ -5,6 +5,100 @@ 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.10.0
+
+### Added
+
+- **Shopify event types** — `shopify:order`, `shopify:order_paid` and
+  `shopify:product` in `LUMIO_EVENT_TYPES`, with payload schemas. Every
+  Shopify payload names its store in `shop { domain, label }`; `label` is the
+  store's label in Lumio when the event arrived. `shop` is optional: events
+  stored before stores carried it have none. Order payloads carry
+  `total_price` / `currency` and `line_items` only as the store's settings
+  allow, and `customer_display` only with the buyer's consent (untrusted
+  buyer text). Golden fixtures in `fixtures/events/shopify/`.
+
+### Changed
+
+- **zod `^4.6.7`** — the `zod` dependency range moves up from `^4.3.6`.
+- **Built with tsup 9** — the type declarations emit `export type { … }`
+  instead of `export { type … }`; the exported types are unchanged.
+
+## 0.9.0
+
+### Added
+
+- **Typed event payloads** — `LUMIO_EVENT_PAYLOAD_SCHEMAS` holds one zod
+  schema per `LUMIO_EVENT_TYPES` entry for the `data` of an `event.platform`
+  notification (the backend's event `raw`; a `ChatMessageInput` for the chat
+  types). `LumioEventPayloadMap` / `LumioEventPayload<K>` are the inferred
+  types, `ChatMessagePayload` and `ModerationLogPayload` the shared ones.
+  `lumioEventPayloadSchema(type)` and `parseLumioEventPayload(type, data)`
+  validate a payload. The map is checked with `satisfies` against
+  `LumioEventType`, so a new event type without a schema fails typecheck. The
+  shapes follow the golden fixtures the backend exports to `fixtures/events/`.
+  Object schemas are loose: fields the backend adds later are kept, typed
+  `unknown`. The wire format is unchanged.
+
+### Changed
+
+- **`twitch:gift_sub` is now `twitch:gift`** in `LUMIO_EVENT_TYPES`. The
+  backend has always emitted gifted subs as `twitch:gift`, so no event ever
+  matched `twitch:gift_sub`. Replace the type in `useLumioEvent()` calls and
+  `event()` triggers. Breaking.
+
+## 0.8.0
+
+### Added
+
+- **`SERVER_FUNCTION_ERRORS`** — the JSON-RPC error codes a host answers a
+  failed `server.query` / `server.mutation` with (`INVALID_REQUEST`,
+  `UNAVAILABLE`, `DENIED`, `UNKNOWN_FUNCTION`, `INVALID_PARAMS`, `FAILED`),
+  and the `ServerFunctionErrorCode` type. `ServerQueryParams` /
+  `ServerMutationParams` document their results: `server.query` resolves with
+  the rows, `server.mutation` with the written row or `null`. Additive.
+- **`server.realtime`** — `HOST_METHODS.SERVER_REALTIME` (`"server.realtime"`)
+  is the host → worker notification that carries a message a handler of the
+  install pushed with `ctx.realtime.push(topic, payload)`, with
+  `ServerRealtimeParams` (`{ topic; payload }`). `REALTIME_LIMITS` holds the
+  push rules (`TOPIC_PATTERN`, `MAX_PAYLOAD_BYTES` 16 KiB,
+  `MAX_PUSHES_PER_INVOCATION` 32, `MAX_PUSHES_PER_MINUTE` 300 and
+  `MAX_BYTES_PER_MINUTE` 1 MiB per install). Additive.
+
+### Removed
+
+- **`interactive` target** — `LifecycleInitParams["target"]` and the
+  `extensionConfigSchema` `target` enum accept only `editor` and `layer`. No
+  host ever rendered an `interactive` surface; viewers interact through chat
+  commands and channel point rewards (`twitch:reward`, `kick:reward`) that a
+  bot-module handler turns into `ctx.realtime.push`, received with
+  `server.realtime`.
+
+  **Breaking for consumers** that pass or `switch` over `"interactive"`. Drop
+  that arm; an init message carrying `target: "interactive"` now fails
+  validation.
+
+## 0.7.0
+
+### Added
+
+- **`action.execute`** — `WORKER_METHODS.ACTION_EXECUTE` (`"action.execute"`)
+  is the worker → host request `useLumioAction()` sends, with
+  `ActionExecuteParams` (`{ action: LumioActionType; params }`) and
+  `ActionExecuteResult` (`{ data }`). `ACTION_EXECUTE_ERRORS` lists the
+  JSON-RPC error codes a host answers a failed action with (`INVALID_REQUEST`,
+  `UNAVAILABLE`, `DENIED`, `UNKNOWN_ACTION`, `INVALID_PARAMS`, `FAILED`).
+  Additive.
+- **Twitch reward lifecycle event types** — `twitch:reward_status`,
+  `twitch:reward_add`, `twitch:reward_update` and `twitch:reward_remove` are in
+  `LUMIO_EVENT_TYPES`, `LumioEventType` and the `lumioEventTypeSchema` Zod enum.
+  `twitch:reward_status` is a redemption's status change (`fulfilled` /
+  `canceled`) with the same shape as `twitch:reward`. `twitch:reward_add` /
+  `_update` / `_remove` fire when the streamer creates, changes or deletes a
+  channel-point reward on Twitch and carry the Twitch custom-reward object; they
+  are delivered live only (`broadcast_only`) and never appear in the event
+  history. Additive.
+
 ## 0.6.0
 
 ### Added

package/README.md

@@ -10,7 +10,7 @@ npm install @zaflun/lumio-protocol
 
 ## What's included
 
-- **54 Event Types** — Twitch, YouTube, Kick, Spotify, StreamElements, Chat
+- **65 Event Types** — Twitch, YouTube, Kick, Spotify, StreamElements, Shopify, Chat
 - **21 Action Types** — Chat, OBS, Spotify, Events, Overlay
 - **Message Schemas** — JSON-RPC 2.0 wire format (Zod validated)
 - **30 Component Types** — `LumioComponentNode` for serialized UI trees