yoto-nodejs-client 0.0.6 → 0.0.7

package/README.md

@@ -211,24 +211,21 @@ account.on('started', (metadata) => {
 
 
 
-// Listen for device-specific events from individual devices
-account.on('deviceAdded', (deviceId, deviceModel) => {
-  // Attach event listeners to each device as it's added
-  deviceModel.on('statusUpdate', (status, source) => {
-    console.log(`${deviceId} battery: ${status.batteryLevelPercentage}%`)
-  })
+// Listen for device events across all devices via the unified bus
+account.on('statusUpdate', ({ deviceId, status, source }) => {
+  console.log(`${deviceId} battery: ${status.batteryLevelPercentage}% (${source})`)
+})
 
-  deviceModel.on('online', (metadata) => {
-    console.log(`${deviceId} came online`)
-  })
+account.on('online', ({ deviceId }) => {
+  console.log(`${deviceId} came online`)
+})
 
-  deviceModel.on('offline', (metadata) => {
-    console.log(`${deviceId} went offline`)
-  })
+account.on('offline', ({ deviceId }) => {
+  console.log(`${deviceId} went offline`)
 })
 
 // Unified error handling
-account.on('error', (error, context) => {
+account.on('error', ({ error, context }) => {
   console.error(`Error in ${context.source}:`, error.message)
   if (context.deviceId) {
     console.error(`Device: ${context.deviceId}`)
@@ -970,10 +967,17 @@ Create a stateful device client that manages device state primarily from MQTT wi
 - `playbackUpdate(playback, changedFields)` - Playback state changed, passes (playback, changedFields)
 - `online(metadata)` - Device came online, passes metadata with reason and optional upTime
 - `offline(metadata)` - Device went offline, passes metadata with reason and optional shutDownReason or timeSinceLastSeen
-- `mqttConnect()` - MQTT client connected
+- `mqttConnect(metadata)` - MQTT client connected, passes CONNACK metadata
 - `mqttDisconnect(metadata)` - MQTT disconnect packet received, passes metadata with disconnect packet
 - `mqttClose(metadata)` - MQTT connection closed, passes metadata with close reason
 - `mqttReconnect()` - MQTT client is reconnecting
+- `mqttOffline()` - MQTT client goes offline
+- `mqttEnd()` - MQTT client end is called
+- `mqttStatus(topic, message)` - Raw MQTT status messages (documented status topic)
+- `mqttEvents(topic, message)` - Raw MQTT events messages
+- `mqttStatusLegacy(topic, message)` - Raw legacy MQTT status messages (undocumented status topic)
+- `mqttResponse(topic, message)` - Raw MQTT response messages
+- `mqttUnknown(topic, message)` - Raw MQTT messages that do not match known types
 - `error(error)` - Error occurred, passes error
 
 **Static Properties & Methods:**
@@ -1051,11 +1055,27 @@ Create an account manager that automatically discovers and manages all devices f
 **Events:**
 - `started(metadata)` - Account started (metadata: { deviceCount, devices })
 - `stopped()` - Account stopped
-- `deviceAdded(deviceId, deviceModel)` - Device was added
-- `deviceRemoved(deviceId)` - Device was removed
-- `error(error, context)` - Error occurred (context: { source, deviceId, operation })
-
-**Note:** To listen to individual device events (statusUpdate, configUpdate, playbackUpdate, online, offline, mqttConnect, mqttDisconnect, mqttClose, mqttReconnect, etc.), access the device models directly via `account.devices` or `account.getDevice(deviceId)` and attach listeners to them.
+- `deviceAdded({ deviceId })` - Device was added
+- `deviceRemoved({ deviceId })` - Device was removed
+- `statusUpdate({ deviceId, status, source, changedFields })` - Re-emitted device status update
+- `configUpdate({ deviceId, config, changedFields })` - Re-emitted config update
+- `playbackUpdate({ deviceId, playback, changedFields })` - Re-emitted playback update
+- `online({ deviceId, metadata })` - Re-emitted online event
+- `offline({ deviceId, metadata })` - Re-emitted offline event
+- `mqttConnect({ deviceId, metadata })` - Re-emitted MQTT connect
+- `mqttDisconnect({ deviceId, metadata })` - Re-emitted MQTT disconnect
+- `mqttClose({ deviceId, metadata })` - Re-emitted MQTT close
+- `mqttReconnect({ deviceId })` - Re-emitted MQTT reconnect
+- `mqttOffline({ deviceId })` - Re-emitted MQTT offline
+- `mqttEnd({ deviceId })` - Re-emitted MQTT end
+- `mqttStatus({ deviceId, topic, message })` - Re-emitted raw MQTT status
+- `mqttEvents({ deviceId, topic, message })` - Re-emitted raw MQTT events
+- `mqttStatusLegacy({ deviceId, topic, message })` - Re-emitted raw MQTT legacy status
+- `mqttResponse({ deviceId, topic, message })` - Re-emitted raw MQTT response
+- `mqttUnknown({ deviceId, topic, message })` - Re-emitted raw MQTT unknown message
+- `error({ error, context })` - Error occurred (context: { source, deviceId, operation })
+
+**Note:** You can still listen to individual device events by attaching listeners to each `YotoDeviceModel`, but the account now re-emits device and MQTT events with device context for unified handling.
 
 ```js
 import { YotoAccount } from 'yoto-nodejs-client'
@@ -1075,26 +1095,21 @@ const account = new YotoAccount({
 })
 
 // Account-level error handling
-account.on('error', (error, context) => {
+account.on('error', ({ error, context }) => {
   console.error(`Error in ${context.source}:`, error.message)
 })
 
-// Listen to device added events
-account.on('deviceAdded', (deviceId, deviceModel) => {
-  console.log(`Device ${deviceId} added`)
-  
-  // Attach listeners to individual devices
-  deviceModel.on('statusUpdate', (status, source) => {
-    console.log(`${deviceId} battery: ${status.batteryLevelPercentage}%`)
-  })
-  
-  deviceModel.on('online', (metadata) => {
-    console.log(`${deviceId} came online (${metadata.reason})`)
-  })
-  
-  deviceModel.on('offline', (metadata) => {
-    console.log(`${deviceId} went offline (${metadata.reason})`)
-  })
+// Unified device events across all devices
+account.on('statusUpdate', ({ deviceId, status, source }) => {
+  console.log(`${deviceId} battery: ${status.batteryLevelPercentage}% (${source})`)
+})
+
+account.on('online', ({ deviceId, metadata }) => {
+  console.log(`${deviceId} came online (${metadata.reason})`)
+})
+
+account.on('offline', ({ deviceId, metadata }) => {
+  console.log(`${deviceId} went offline (${metadata.reason})`)
 })
 
 await account.start()

package/lib/test-helpers/device-model-test-helpers.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @param {Promise<unknown>} promise
+ * @param {number} timeoutMs
+ * @param {string} label
+ * @returns {Promise<unknown>}
+ */
+export function withTimeout(promise: Promise<unknown>, timeoutMs: number, label: string): Promise<unknown>;
+/**
+ * @param {YotoDeviceModel} model
+ * @returns {Promise<void>}
+ */
+export function waitForModelReady(model: YotoDeviceModel): Promise<void>;
+/**
+ * @param {YotoDeviceModelConfig} config
+ */
+export function assertConfigShape(config: YotoDeviceModelConfig): void;
+/**
+ * @param {YotoPlaybackState} playback
+ */
+export function assertPlaybackShape(playback: YotoPlaybackState): void;
+/**
+ * @param {string | undefined} value
+ * @returns {string}
+ */
+export function toLower(value: string | undefined): string;
+import type { YotoDeviceModel } from '../yoto-device.js';
+import type { YotoDeviceModelConfig } from '../yoto-device.js';
+import type { YotoPlaybackState } from '../yoto-device.js';
+//# sourceMappingURL=device-model-test-helpers.d.ts.map

package/lib/test-helpers/device-model-test-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-model-test-helpers.d.ts","sourceRoot":"","sources":["device-model-test-helpers.js"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,qCALW,OAAO,CAAC,OAAO,CAAC,aAChB,MAAM,SACN,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAS5B;AAED;;;GAGG;AACH,yCAHW,eAAe,GACb,OAAO,CAAC,IAAI,CAAC,CAUzB;AAED;;GAEG;AACH,0CAFW,qBAAqB,QAkD/B;AAED;;GAEG;AACH,8CAFW,iBAAiB,QAkB3B;AAED;;;GAGG;AACH,+BAHW,MAAM,GAAG,SAAS,GAChB,MAAM,CAIlB;qCAnH8E,mBAAmB;2CAAnB,mBAAmB;uCAAnB,mBAAmB"}

package/lib/test-helpers/device-model-test-helpers.js

@@ -0,0 +1,116 @@
+/** @import { YotoDeviceModel, YotoDeviceModelConfig, YotoPlaybackState } from '../yoto-device.js' */
+
+import assert from 'node:assert/strict'
+import { once } from 'node:events'
+import { setTimeout as sleep } from 'node:timers/promises'
+
+/**
+ * @param {Promise<unknown>} promise
+ * @param {number} timeoutMs
+ * @param {string} label
+ * @returns {Promise<unknown>}
+ */
+export function withTimeout (promise, timeoutMs, label) {
+  return Promise.race([
+    promise,
+    sleep(timeoutMs).then(() => {
+      throw new Error(`${label} timed out after ${timeoutMs}ms`)
+    })
+  ])
+}
+
+/**
+ * @param {YotoDeviceModel} model
+ * @returns {Promise<void>}
+ */
+export async function waitForModelReady (model) {
+  const started = withTimeout(once(model, 'started'), 15000, 'started')
+  const statusUpdated = withTimeout(once(model, 'statusUpdate'), 15000, 'statusUpdate')
+  const configUpdated = withTimeout(once(model, 'configUpdate'), 15000, 'configUpdate')
+
+  await model.start()
+  await Promise.all([started, statusUpdated, configUpdated])
+  await sleep(1500)
+}
+
+/**
+ * @param {YotoDeviceModelConfig} config
+ */
+export function assertConfigShape (config) {
+  assert.ok(Array.isArray(config.alarms), 'alarms should be an array')
+  assert.equal(typeof config.ambientColour, 'string', 'ambientColour should be string')
+  assert.equal(typeof config.bluetoothEnabled, 'boolean', 'bluetoothEnabled should be boolean')
+  assert.equal(typeof config.btHeadphonesEnabled, 'boolean', 'btHeadphonesEnabled should be boolean')
+  assert.equal(typeof config.clockFace, 'string', 'clockFace should be string')
+  assert.equal(typeof config.dayDisplayBrightnessAuto, 'boolean', 'dayDisplayBrightnessAuto should be boolean')
+  if (config.dayDisplayBrightnessAuto) {
+    assert.equal(config.dayDisplayBrightness, null, 'dayDisplayBrightness should be null when auto')
+  } else {
+    assert.equal(typeof config.dayDisplayBrightness, 'number', 'dayDisplayBrightness should be number when not auto')
+  }
+  assert.equal(typeof config.dayTime, 'string', 'dayTime should be string')
+  assert.equal(typeof config.dayYotoDaily, 'string', 'dayYotoDaily should be string')
+  assert.equal(typeof config.dayYotoRadio, 'string', 'dayYotoRadio should be string')
+  assert.equal(typeof config.daySoundsOff, 'boolean', 'daySoundsOff should be boolean')
+  assert.equal(typeof config.displayDimBrightness, 'number', 'displayDimBrightness should be number')
+  assert.equal(typeof config.displayDimTimeout, 'number', 'displayDimTimeout should be number')
+  assert.equal(typeof config.headphonesVolumeLimited, 'boolean', 'headphonesVolumeLimited should be boolean')
+  assert.ok(config.hourFormat === 12 || config.hourFormat === 24, 'hourFormat should be 12 or 24')
+  assert.equal(typeof config.locale, 'string', 'locale should be string')
+  assert.equal(typeof config.logLevel, 'string', 'logLevel should be string')
+  assert.equal(typeof config.maxVolumeLimit, 'number', 'maxVolumeLimit should be number')
+  assert.equal(typeof config.nightAmbientColour, 'string', 'nightAmbientColour should be string')
+  assert.equal(typeof config.nightDisplayBrightnessAuto, 'boolean', 'nightDisplayBrightnessAuto should be boolean')
+  if (config.nightDisplayBrightnessAuto) {
+    assert.equal(config.nightDisplayBrightness, null, 'nightDisplayBrightness should be null when auto')
+  } else {
+    assert.equal(typeof config.nightDisplayBrightness, 'number', 'nightDisplayBrightness should be number when not auto')
+  }
+  assert.equal(typeof config.nightMaxVolumeLimit, 'number', 'nightMaxVolumeLimit should be number')
+  assert.equal(typeof config.nightTime, 'string', 'nightTime should be string')
+  assert.equal(typeof config.nightYotoDaily, 'string', 'nightYotoDaily should be string')
+  assert.equal(typeof config.nightYotoRadioEnabled, 'boolean', 'nightYotoRadioEnabled should be boolean')
+  if (config.nightYotoRadioEnabled) {
+    assert.equal(typeof config.nightYotoRadio, 'string', 'nightYotoRadio should be string when enabled')
+  } else {
+    assert.equal(config.nightYotoRadio, null, 'nightYotoRadio should be null when disabled')
+  }
+  assert.equal(typeof config.nightSoundsOff, 'boolean', 'nightSoundsOff should be boolean')
+  assert.equal(typeof config.pausePowerButton, 'boolean', 'pausePowerButton should be boolean')
+  assert.equal(typeof config.pauseVolumeDown, 'boolean', 'pauseVolumeDown should be boolean')
+  assert.equal(typeof config.repeatAll, 'boolean', 'repeatAll should be boolean')
+  assert.equal(typeof config.showDiagnostics, 'boolean', 'showDiagnostics should be boolean')
+  assert.equal(typeof config.shutdownTimeout, 'number', 'shutdownTimeout should be number')
+  assert.equal(typeof config.systemVolume, 'number', 'systemVolume should be number')
+  assert.equal(typeof config.timezone, 'string', 'timezone should be string')
+  assert.equal(typeof config.volumeLevel, 'string', 'volumeLevel should be string')
+}
+
+/**
+ * @param {YotoPlaybackState} playback
+ */
+export function assertPlaybackShape (playback) {
+  assert.ok(playback, 'playback should exist')
+  assert.equal(typeof playback.updatedAt, 'string', 'playback.updatedAt should be string')
+
+  assert.ok(playback.cardId === null || typeof playback.cardId === 'string', 'playback.cardId should be string or null')
+  assert.ok(playback.source === null || typeof playback.source === 'string', 'playback.source should be string or null')
+  assert.ok(playback.playbackStatus === null || typeof playback.playbackStatus === 'string', 'playback.playbackStatus should be string or null')
+  assert.ok(playback.trackTitle === null || typeof playback.trackTitle === 'string', 'playback.trackTitle should be string or null')
+  assert.ok(playback.trackKey === null || typeof playback.trackKey === 'string', 'playback.trackKey should be string or null')
+  assert.ok(playback.chapterTitle === null || typeof playback.chapterTitle === 'string', 'playback.chapterTitle should be string or null')
+  assert.ok(playback.chapterKey === null || typeof playback.chapterKey === 'string', 'playback.chapterKey should be string or null')
+  assert.ok(playback.position === null || typeof playback.position === 'number', 'playback.position should be number or null')
+  assert.ok(playback.trackLength === null || typeof playback.trackLength === 'number', 'playback.trackLength should be number or null')
+  assert.ok(playback.streaming === null || typeof playback.streaming === 'boolean', 'playback.streaming should be boolean or null')
+  assert.ok(playback.sleepTimerActive === null || typeof playback.sleepTimerActive === 'boolean', 'playback.sleepTimerActive should be boolean or null')
+  assert.ok(playback.sleepTimerSeconds === null || typeof playback.sleepTimerSeconds === 'number', 'playback.sleepTimerSeconds should be number or null')
+}
+
+/**
+ * @param {string | undefined} value
+ * @returns {string}
+ */
+export function toLower (value) {
+  return typeof value === 'string' ? value.toLowerCase() : ''
+}

package/lib/yoto-account.d.ts

@@ -17,14 +17,168 @@
  * @property {number} deviceCount - Number of devices managed
  * @property {string[]} devices - Array of device IDs
  */
+/**
+ * Device event wrapper
+ * @template T
+ * @typedef {{ deviceId: string } & T} YotoAccountDeviceEvent
+ */
+/**
+ * Device added event data
+ * @typedef {YotoAccountDeviceEvent<{}>} YotoAccountDeviceAddedEvent
+ */
+/**
+ * Device removed event data
+ * @typedef {YotoAccountDeviceEvent<{}>} YotoAccountDeviceRemovedEvent
+ */
+/**
+ * Device status update event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   status: YotoDeviceStatus,
+ *   source: string,
+ *   changedFields: Set<keyof YotoDeviceStatus>
+ * }>} YotoAccountStatusUpdateEvent
+ */
+/**
+ * Device config update event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   config: YotoDeviceModelConfig,
+ *   changedFields: Set<keyof YotoDeviceModelConfig>
+ * }>} YotoAccountConfigUpdateEvent
+ */
+/**
+ * Device playback update event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   playback: YotoPlaybackState,
+ *   changedFields: Set<keyof YotoPlaybackState>
+ * }>} YotoAccountPlaybackUpdateEvent
+ */
+/**
+ * Device online event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   metadata: YotoDeviceOnlineMetadata
+ * }>} YotoAccountOnlineEvent
+ */
+/**
+ * Device offline event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   metadata: YotoDeviceOfflineMetadata
+ * }>} YotoAccountOfflineEvent
+ */
+/**
+ * MQTT connect event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   metadata: YotoMqttConnectMetadata
+ * }>} YotoAccountMqttConnectEvent
+ */
+/**
+ * MQTT disconnect event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   metadata: YotoMqttDisconnectMetadata
+ * }>} YotoAccountMqttDisconnectEvent
+ */
+/**
+ * MQTT close event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   metadata: YotoMqttCloseMetadata
+ * }>} YotoAccountMqttCloseEvent
+ */
+/**
+ * MQTT reconnect event data
+ * @typedef {YotoAccountDeviceEvent<{}>} YotoAccountMqttReconnectEvent
+ */
+/**
+ * MQTT offline event data
+ * @typedef {YotoAccountDeviceEvent<{}>} YotoAccountMqttOfflineEvent
+ */
+/**
+ * MQTT end event data
+ * @typedef {YotoAccountDeviceEvent<{}>} YotoAccountMqttEndEvent
+ */
+/**
+ * MQTT status event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   topic: string,
+ *   message: YotoStatusMessage
+ * }>} YotoAccountMqttStatusEvent
+ */
+/**
+ * MQTT events event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   topic: string,
+ *   message: YotoEventsMessage
+ * }>} YotoAccountMqttEventsEvent
+ */
+/**
+ * MQTT legacy status event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   topic: string,
+ *   message: YotoStatusLegacyMessage
+ * }>} YotoAccountMqttStatusLegacyEvent
+ */
+/**
+ * MQTT response event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   topic: string,
+ *   message: YotoResponseMessage
+ * }>} YotoAccountMqttResponseEvent
+ */
+/**
+ * MQTT unknown event data
+ * @typedef {YotoAccountDeviceEvent<{
+ *   topic: string,
+ *   message: unknown
+ * }>} YotoAccountMqttUnknownEvent
+ */
+/**
+ * Account error event data
+ * @typedef {Object} YotoAccountErrorEvent
+ * @property {Error} error - Error instance
+ * @property {YotoAccountErrorContext} context - Error context
+ */
+/**
+ * Device event handler set
+ * @typedef {Object} YotoAccountDeviceEventHandlers
+ * @property {(status: YotoDeviceStatus, source: string, changedFields: Set<keyof YotoDeviceStatus>) => void} statusUpdate
+ * @property {(config: YotoDeviceModelConfig, changedFields: Set<keyof YotoDeviceModelConfig>) => void} configUpdate
+ * @property {(playback: YotoPlaybackState, changedFields: Set<keyof YotoPlaybackState>) => void} playbackUpdate
+ * @property {(metadata: YotoDeviceOnlineMetadata) => void} online
+ * @property {(metadata: YotoDeviceOfflineMetadata) => void} offline
+ * @property {(metadata: YotoMqttConnectMetadata) => void} mqttConnect
+ * @property {(metadata: YotoMqttDisconnectMetadata) => void} mqttDisconnect
+ * @property {(metadata: YotoMqttCloseMetadata) => void} mqttClose
+ * @property {() => void} mqttReconnect
+ * @property {() => void} mqttOffline
+ * @property {() => void} mqttEnd
+ * @property {(topic: string, message: YotoStatusMessage) => void} mqttStatus
+ * @property {(topic: string, message: YotoEventsMessage) => void} mqttEvents
+ * @property {(topic: string, message: YotoStatusLegacyMessage) => void} mqttStatusLegacy
+ * @property {(topic: string, message: YotoResponseMessage) => void} mqttResponse
+ * @property {(topic: string, message: unknown) => void} mqttUnknown
+ */
 /**
  * Event map for YotoAccount
  * @typedef {{
  *   'started': [YotoAccountStartedMetadata],
  *   'stopped': [],
- *   'deviceAdded': [string, YotoDeviceModel],
- *   'deviceRemoved': [string],
- *   'error': [Error, YotoAccountErrorContext]
+ *   'deviceAdded': [YotoAccountDeviceAddedEvent],
+ *   'deviceRemoved': [YotoAccountDeviceRemovedEvent],
+ *   'statusUpdate': [YotoAccountStatusUpdateEvent],
+ *   'configUpdate': [YotoAccountConfigUpdateEvent],
+ *   'playbackUpdate': [YotoAccountPlaybackUpdateEvent],
+ *   'online': [YotoAccountOnlineEvent],
+ *   'offline': [YotoAccountOfflineEvent],
+ *   'mqttConnect': [YotoAccountMqttConnectEvent],
+ *   'mqttDisconnect': [YotoAccountMqttDisconnectEvent],
+ *   'mqttClose': [YotoAccountMqttCloseEvent],
+ *   'mqttReconnect': [YotoAccountMqttReconnectEvent],
+ *   'mqttOffline': [YotoAccountMqttOfflineEvent],
+ *   'mqttEnd': [YotoAccountMqttEndEvent],
+ *   'mqttStatus': [YotoAccountMqttStatusEvent],
+ *   'mqttEvents': [YotoAccountMqttEventsEvent],
+ *   'mqttStatusLegacy': [YotoAccountMqttStatusLegacyEvent],
+ *   'mqttResponse': [YotoAccountMqttResponseEvent],
+ *   'mqttUnknown': [YotoAccountMqttUnknownEvent],
+ *   'error': [YotoAccountErrorEvent]
  * }} YotoAccountEventMap
  */
 /**
@@ -33,9 +187,10 @@
  * Events:
  * - 'started' - Emitted when account starts, passes metadata with deviceCount and devices array
  * - 'stopped' - Emitted when account stops
- * - 'deviceAdded' - Emitted when a device is added, passes (deviceId, deviceModel)
- * - 'deviceRemoved' - Emitted when a device is removed, passes deviceId
- * - 'error' - Emitted when an error occurs, passes (error, context)
+ * - 'deviceAdded' - Emitted when a device is added, passes { deviceId }
+ * - 'deviceRemoved' - Emitted when a device is removed, passes { deviceId }
+ * - Device events are re-emitted with device context, see event map for signatures
+ * - 'error' - Emitted when an error occurs, passes { error, context }
  *
  * Note: To listen to individual device events (statusUpdate, configUpdate, playbackUpdate, online, offline, etc.),
  * access the device models directly via account.devices or account.getDevice(deviceId) and attach listeners.
@@ -145,19 +300,194 @@ export type YotoAccountStartedMetadata = {
      */
     devices: string[];
 };
+/**
+ * Device event wrapper
+ */
+export type YotoAccountDeviceEvent<T> = {
+    deviceId: string;
+} & T;
+/**
+ * Device added event data
+ */
+export type YotoAccountDeviceAddedEvent = YotoAccountDeviceEvent<{}>;
+/**
+ * Device removed event data
+ */
+export type YotoAccountDeviceRemovedEvent = YotoAccountDeviceEvent<{}>;
+/**
+ * Device status update event data
+ */
+export type YotoAccountStatusUpdateEvent = YotoAccountDeviceEvent<{
+    status: YotoDeviceStatus;
+    source: string;
+    changedFields: Set<keyof YotoDeviceStatus>;
+}>;
+/**
+ * Device config update event data
+ */
+export type YotoAccountConfigUpdateEvent = YotoAccountDeviceEvent<{
+    config: YotoDeviceModelConfig;
+    changedFields: Set<keyof YotoDeviceModelConfig>;
+}>;
+/**
+ * Device playback update event data
+ */
+export type YotoAccountPlaybackUpdateEvent = YotoAccountDeviceEvent<{
+    playback: YotoPlaybackState;
+    changedFields: Set<keyof YotoPlaybackState>;
+}>;
+/**
+ * Device online event data
+ */
+export type YotoAccountOnlineEvent = YotoAccountDeviceEvent<{
+    metadata: YotoDeviceOnlineMetadata;
+}>;
+/**
+ * Device offline event data
+ */
+export type YotoAccountOfflineEvent = YotoAccountDeviceEvent<{
+    metadata: YotoDeviceOfflineMetadata;
+}>;
+/**
+ * MQTT connect event data
+ */
+export type YotoAccountMqttConnectEvent = YotoAccountDeviceEvent<{
+    metadata: YotoMqttConnectMetadata;
+}>;
+/**
+ * MQTT disconnect event data
+ */
+export type YotoAccountMqttDisconnectEvent = YotoAccountDeviceEvent<{
+    metadata: YotoMqttDisconnectMetadata;
+}>;
+/**
+ * MQTT close event data
+ */
+export type YotoAccountMqttCloseEvent = YotoAccountDeviceEvent<{
+    metadata: YotoMqttCloseMetadata;
+}>;
+/**
+ * MQTT reconnect event data
+ */
+export type YotoAccountMqttReconnectEvent = YotoAccountDeviceEvent<{}>;
+/**
+ * MQTT offline event data
+ */
+export type YotoAccountMqttOfflineEvent = YotoAccountDeviceEvent<{}>;
+/**
+ * MQTT end event data
+ */
+export type YotoAccountMqttEndEvent = YotoAccountDeviceEvent<{}>;
+/**
+ * MQTT status event data
+ */
+export type YotoAccountMqttStatusEvent = YotoAccountDeviceEvent<{
+    topic: string;
+    message: YotoStatusMessage;
+}>;
+/**
+ * MQTT events event data
+ */
+export type YotoAccountMqttEventsEvent = YotoAccountDeviceEvent<{
+    topic: string;
+    message: YotoEventsMessage;
+}>;
+/**
+ * MQTT legacy status event data
+ */
+export type YotoAccountMqttStatusLegacyEvent = YotoAccountDeviceEvent<{
+    topic: string;
+    message: YotoStatusLegacyMessage;
+}>;
+/**
+ * MQTT response event data
+ */
+export type YotoAccountMqttResponseEvent = YotoAccountDeviceEvent<{
+    topic: string;
+    message: YotoResponseMessage;
+}>;
+/**
+ * MQTT unknown event data
+ */
+export type YotoAccountMqttUnknownEvent = YotoAccountDeviceEvent<{
+    topic: string;
+    message: unknown;
+}>;
+/**
+ * Account error event data
+ */
+export type YotoAccountErrorEvent = {
+    /**
+     * - Error instance
+     */
+    error: Error;
+    /**
+     * - Error context
+     */
+    context: YotoAccountErrorContext;
+};
+/**
+ * Device event handler set
+ */
+export type YotoAccountDeviceEventHandlers = {
+    statusUpdate: (status: YotoDeviceStatus, source: string, changedFields: Set<keyof YotoDeviceStatus>) => void;
+    configUpdate: (config: YotoDeviceModelConfig, changedFields: Set<keyof YotoDeviceModelConfig>) => void;
+    playbackUpdate: (playback: YotoPlaybackState, changedFields: Set<keyof YotoPlaybackState>) => void;
+    online: (metadata: YotoDeviceOnlineMetadata) => void;
+    offline: (metadata: YotoDeviceOfflineMetadata) => void;
+    mqttConnect: (metadata: YotoMqttConnectMetadata) => void;
+    mqttDisconnect: (metadata: YotoMqttDisconnectMetadata) => void;
+    mqttClose: (metadata: YotoMqttCloseMetadata) => void;
+    mqttReconnect: () => void;
+    mqttOffline: () => void;
+    mqttEnd: () => void;
+    mqttStatus: (topic: string, message: YotoStatusMessage) => void;
+    mqttEvents: (topic: string, message: YotoEventsMessage) => void;
+    mqttStatusLegacy: (topic: string, message: YotoStatusLegacyMessage) => void;
+    mqttResponse: (topic: string, message: YotoResponseMessage) => void;
+    mqttUnknown: (topic: string, message: unknown) => void;
+};
 /**
  * Event map for YotoAccount
  */
 export type YotoAccountEventMap = {
     "started": [YotoAccountStartedMetadata];
     "stopped": [];
-    "deviceAdded": [string, YotoDeviceModel];
-    "deviceRemoved": [string];
-    "error": [Error, YotoAccountErrorContext];
+    "deviceAdded": [YotoAccountDeviceAddedEvent];
+    "deviceRemoved": [YotoAccountDeviceRemovedEvent];
+    "statusUpdate": [YotoAccountStatusUpdateEvent];
+    "configUpdate": [YotoAccountConfigUpdateEvent];
+    "playbackUpdate": [YotoAccountPlaybackUpdateEvent];
+    "online": [YotoAccountOnlineEvent];
+    "offline": [YotoAccountOfflineEvent];
+    "mqttConnect": [YotoAccountMqttConnectEvent];
+    "mqttDisconnect": [YotoAccountMqttDisconnectEvent];
+    "mqttClose": [YotoAccountMqttCloseEvent];
+    "mqttReconnect": [YotoAccountMqttReconnectEvent];
+    "mqttOffline": [YotoAccountMqttOfflineEvent];
+    "mqttEnd": [YotoAccountMqttEndEvent];
+    "mqttStatus": [YotoAccountMqttStatusEvent];
+    "mqttEvents": [YotoAccountMqttEventsEvent];
+    "mqttStatusLegacy": [YotoAccountMqttStatusLegacyEvent];
+    "mqttResponse": [YotoAccountMqttResponseEvent];
+    "mqttUnknown": [YotoAccountMqttUnknownEvent];
+    "error": [YotoAccountErrorEvent];
 };
 import { EventEmitter } from 'events';
 import { YotoClient } from './api-client.js';
 import { YotoDeviceModel } from './yoto-device.js';
 import type { YotoClientConstructorOptions } from './api-client.js';
 import type { YotoDeviceModelOptions } from './yoto-device.js';
+import type { YotoDeviceStatus } from './yoto-device.js';
+import type { YotoDeviceModelConfig } from './yoto-device.js';
+import type { YotoPlaybackState } from './yoto-device.js';
+import type { YotoDeviceOnlineMetadata } from './yoto-device.js';
+import type { YotoDeviceOfflineMetadata } from './yoto-device.js';
+import type { YotoMqttConnectMetadata } from './yoto-device.js';
+import type { YotoMqttDisconnectMetadata } from './yoto-device.js';
+import type { YotoMqttCloseMetadata } from './yoto-device.js';
+import type { YotoStatusMessage } from './mqtt/client.js';
+import type { YotoEventsMessage } from './mqtt/client.js';
+import type { YotoStatusLegacyMessage } from './mqtt/client.js';
+import type { YotoResponseMessage } from './mqtt/client.js';
 //# sourceMappingURL=yoto-account.d.ts.map

package/lib/yoto-account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"yoto-account.d.ts","sourceRoot":"","sources":["yoto-account.js"],"names":[],"mappings":"AAaA;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;;;;;GASG;AAMH;;;;;;;;;;;;;;GAcG;AACH;IAOE;;;QAGI;IACJ,qBAFY,kBAAkB,EAS7B;IAMD;;;OAGG;IACH,cAFa,UAAU,CAEc;IAErC;;;OAGG;IACH,eAFa,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAEF;IAEvC;;;OAGG;IACH,eAFa,OAAO,CAEmB;IAEvC;;;OAGG;IACH,mBAFa,OAAO,CAE2B;IAE/C;;;;OAIG;IACH,oBAHW,MAAM,GACJ,eAAe,GAAG,SAAS,CAEmB;IAE3D;;;OAGG;IACH,gBAFa,MAAM,EAAE,CAEsC;IAM3D;;;;OAIG;IACH,SAHa,OAAO,CAAC,IAAI,CAAC,CAyDzB;IAED;;;OAGG;IACH,QAFa,OAAO,CAAC,IAAI,CAAC,CAwCzB;IAED;;;OAGG;IACH,WAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,kBAFa,OAAO,CAAC,IAAI,CAAC,CAwEzB;;CAqBF;;;;;;;;mBAnUa,4BAA4B;;;;mBAC5B,sBAAsB;;;;;;;;;YAMtB,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;aACN,MAAM,EAAE;;;;;kCAKT;IACZ,SAAa,EAAE,CAAC,0BAA0B,CAAC,CAAC;IAC5C,SAAa,EAAE,EAAE,CAAC;IAClB,aAAiB,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,eAAmB,EAAE,CAAC,MAAM,CAAC,CAAC;IAC9B,OAAW,EAAE,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAA;CAC1C;6BAtCyB,QAAQ;2BACV,iBAAiB;gCACZ,kBAAkB;kDAND,iBAAiB;4CACvB,kBAAkB"}
+{"version":3,"file":"yoto-account.d.ts","sourceRoot":"","sources":["yoto-account.js"],"names":[],"mappings":"AAcA;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;;GAOG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAMH;;;;;;;;;;;;;;;GAeG;AACH;IAQE;;;QAGI;IACJ,qBAFY,kBAAkB,EAS7B;IAMD;;;OAGG;IACH,cAFa,UAAU,CAEc;IAErC;;;OAGG;IACH,eAFa,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAEF;IAEvC;;;OAGG;IACH,eAFa,OAAO,CAEmB;IAEvC;;;OAGG;IACH,mBAFa,OAAO,CAE2B;IAE/C;;;;OAIG;IACH,oBAHW,MAAM,GACJ,eAAe,GAAG,SAAS,CAEmB;IAE3D;;;OAGG;IACH,gBAFa,MAAM,EAAE,CAEsC;IAM3D;;;;OAIG;IACH,SAHa,OAAO,CAAC,IAAI,CAAC,CAkEzB;IAED;;;OAGG;IACH,QAFa,OAAO,CAAC,IAAI,CAAC,CAgDzB;IAED;;;OAGG;IACH,WAFa,OAAO,CAAC,IAAI,CAAC,CAKzB;IAED;;;OAGG;IACH,kBAFa,OAAO,CAAC,IAAI,CAAC,CAqFzB;;CAyLF;;;;;;;;mBAtrBa,4BAA4B;;;;mBAC5B,sBAAsB;;;;;;;;;YAMtB,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;aACN,MAAM,EAAE;;;;;mCAKT,CAAC,IACD;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC;;;;0CAKxB,sBAAsB,CAAC,EAAE,CAAC;;;;4CAK1B,sBAAsB,CAAC,EAAE,CAAC;;;;2CAK1B,sBAAsB,CAAC;IAC/B,MAAM,EAAE,gBAAgB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,GAAG,CAAC,MAAM,gBAAgB,CAAC,CAAA;CAC3C,CAAC;;;;2CAKQ,sBAAsB,CAAC;IAC/B,MAAM,EAAE,qBAAqB,CAAC;IAC9B,aAAa,EAAE,GAAG,CAAC,MAAM,qBAAqB,CAAC,CAAA;CAChD,CAAC;;;;6CAKQ,sBAAsB,CAAC;IAC/B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,GAAG,CAAC,MAAM,iBAAiB,CAAC,CAAA;CAC5C,CAAC;;;;qCAKQ,sBAAsB,CAAC;IAC/B,QAAQ,EAAE,wBAAwB,CAAA;CACnC,CAAC;;;;sCAKQ,sBAAsB,CAAC;IAC/B,QAAQ,EAAE,yBAAyB,CAAA;CACpC,CAAC;;;;0CAKQ,sBAAsB,CAAC;IAC/B,QAAQ,EAAE,uBAAuB,CAAA;CAClC,CAAC;;;;6CAKQ,sBAAsB,CAAC;IAC/B,QAAQ,EAAE,0BAA0B,CAAA;CACrC,CAAC;;;;wCAKQ,sBAAsB,CAAC;IAC/B,QAAQ,EAAE,qBAAqB,CAAA;CAChC,CAAC;;;;4CAKQ,sBAAsB,CAAC,EAAE,CAAC;;;;0CAK1B,sBAAsB,CAAC,EAAE,CAAC;;;;sCAK1B,sBAAsB,CAAC,EAAE,CAAC;;;;yCAK1B,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,iBAAiB,CAAA;CAC3B,CAAC;;;;yCAKQ,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,iBAAiB,CAAA;CAC3B,CAAC;;;;+CAKQ,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,uBAAuB,CAAA;CACjC,CAAC;;;;2CAKQ,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,mBAAmB,CAAA;CAC7B,CAAC;;;;0CAKQ,sBAAsB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAA;CACjB,CAAC;;;;;;;;WAMS,KAAK;;;;aACL,uBAAuB;;;;;;kBAMvB,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,CAAC,MAAM,gBAAgB,CAAC,KAAK,IAAI;kBAC9F,CAAC,MAAM,EAAE,qBAAqB,EAAE,aAAa,EAAE,GAAG,CAAC,MAAM,qBAAqB,CAAC,KAAK,IAAI;oBACxF,CAAC,QAAQ,EAAE,iBAAiB,EAAE,aAAa,EAAE,GAAG,CAAC,MAAM,iBAAiB,CAAC,KAAK,IAAI;YAClF,CAAC,QAAQ,EAAE,wBAAwB,KAAK,IAAI;aAC5C,CAAC,QAAQ,EAAE,yBAAyB,KAAK,IAAI;iBAC7C,CAAC,QAAQ,EAAE,uBAAuB,KAAK,IAAI;oBAC3C,CAAC,QAAQ,EAAE,0BAA0B,KAAK,IAAI;eAC9C,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI;mBACzC,MAAM,IAAI;iBACV,MAAM,IAAI;aACV,MAAM,IAAI;gBACV,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,KAAK,IAAI;gBACnD,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,KAAK,IAAI;sBACnD,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB,KAAK,IAAI;kBACzD,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,IAAI;iBACrD,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI;;;;;kCAK1C;IACZ,SAAa,EAAE,CAAC,0BAA0B,CAAC,CAAC;IAC5C,SAAa,EAAE,EAAE,CAAC;IAClB,aAAiB,EAAE,CAAC,2BAA2B,CAAC,CAAC;IACjD,eAAmB,EAAE,CAAC,6BAA6B,CAAC,CAAC;IACrD,cAAkB,EAAE,CAAC,4BAA4B,CAAC,CAAC;IACnD,cAAkB,EAAE,CAAC,4BAA4B,CAAC,CAAC;IACnD,gBAAoB,EAAE,CAAC,8BAA8B,CAAC,CAAC;IACvD,QAAY,EAAE,CAAC,sBAAsB,CAAC,CAAC;IACvC,SAAa,EAAE,CAAC,uBAAuB,CAAC,CAAC;IACzC,aAAiB,EAAE,CAAC,2BAA2B,CAAC,CAAC;IACjD,gBAAoB,EAAE,CAAC,8BAA8B,CAAC,CAAC;IACvD,WAAe,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAC7C,eAAmB,EAAE,CAAC,6BAA6B,CAAC,CAAC;IACrD,aAAiB,EAAE,CAAC,2BAA2B,CAAC,CAAC;IACjD,SAAa,EAAE,CAAC,uBAAuB,CAAC,CAAC;IACzC,YAAgB,EAAE,CAAC,0BAA0B,CAAC,CAAC;IAC/C,YAAgB,EAAE,CAAC,0BAA0B,CAAC,CAAC;IAC/C,kBAAsB,EAAE,CAAC,gCAAgC,CAAC,CAAC;IAC3D,cAAkB,EAAE,CAAC,4BAA4B,CAAC,CAAC;IACnD,aAAiB,EAAE,CAAC,2BAA2B,CAAC,CAAC;IACjD,OAAW,EAAE,CAAC,qBAAqB,CAAC,CAAA;CACjC;6BArNyB,QAAQ;2BACV,iBAAiB;gCACZ,kBAAkB;kDAPD,iBAAiB;4CACsK,kBAAkB;sCAAlB,kBAAkB;2CAAlB,kBAAkB;uCAAlB,kBAAkB;8CAAlB,kBAAkB;+CAAlB,kBAAkB;6CAAlB,kBAAkB;gDAAlB,kBAAkB;2CAAlB,kBAAkB;uCACnJ,kBAAkB;uCAAlB,kBAAkB;6CAAlB,kBAAkB;yCAAlB,kBAAkB"}