homebridge-yoto 0.0.28 → 0.0.31

package/lib/sanitize-name.js

@@ -0,0 +1,49 @@
+/**
+ * @fileoverview Utility functions for the plugin
+ *
+ * Includes code adapted from `homebridge-plugin-utils`:
+ * - Source: https://github.com/hjdhjd/homebridge-plugin-utils/blob/main/src/util.ts
+ *
+ * ISC License
+ * ===========
+ *
+ * Copyright (c) 2017-2025, HJD https://github.com/hjdhjd
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any purpose
+ * with or without fee is hereby granted, provided that the above copyright notice
+ * and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+ * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+ * THIS SOFTWARE.
+ */
+
+/**
+ * Sanitize an accessory/service name according to HomeKit naming conventions.
+ *
+ * Starts and ends with a letter or number. Exception: may end with a period.
+ * May have the following special characters: -"',.#&.
+ * Must not include emojis.
+ *
+ * @param {string} name - The name to sanitize
+ * @returns {string} The HomeKit-sanitized version of the name
+ */
+export function sanitizeName (name) {
+  return name
+    // Replace any disallowed char (including emojis) with a space.
+    .replace(/[^\p{L}\p{N}\-"'.,#&\s]/gu, ' ')
+    // Collapse multiple spaces to one.
+    .replace(/\s+/g, ' ')
+    // Trim spaces at the beginning and end of the string.
+    .trim()
+    // Strip any leading non-letter/number.
+    .replace(/^[^\p{L}\p{N}]+/u, '')
+    // Collapse two or more trailing periods into one.
+    .replace(/\.{2,}$/g, '.')
+    // Remove any other trailing char that's not letter/number/period.
+    .replace(/[^\p{L}\p{N}.]$/u, '')
+}

package/lib/settings.js

@@ -0,0 +1,16 @@
+import { configSchema } from '../config.schema.cjs'
+
+/**
+ * This is the name of the platform that users will use to register the plugin in the Homebridge config.json
+ */
+export const PLATFORM_NAME = 'Yoto'
+
+/**
+ * This must match the name of your plugin as defined the package.json `name` property
+ */
+export const PLUGIN_NAME = 'homebridge-yoto'
+
+/**
+ * Default OAuth Client ID from config schema
+ */
+export const DEFAULT_CLIENT_ID = configSchema.schema.properties.clientId.default

package/lib/sync-service-names.js

@@ -0,0 +1,34 @@
+/** @import { Service, Characteristic } from 'homebridge' */
+import { sanitizeName } from './sanitize-name.js'
+
+/**
+ * Apply HomeKit-visible naming to a service.
+ *
+ * We set both `Name` and `ConfiguredName` on every service we manage so HomeKit tiles are consistently labeled.
+ *
+ * @param {object} params
+ * @param {Service} params.service
+ * @param {string} params.name
+ * @param {typeof Characteristic} params.Characteristic
+ * @returns {void}
+ */
+export function syncServiceNames ({
+  Characteristic,
+  service,
+  name
+}) {
+  const sanitizedName = sanitizeName(name)
+  service.displayName = sanitizedName
+
+  service.updateCharacteristic(Characteristic.Name, sanitizedName)
+
+  // Set ConfiguredName on all services, not just ones that say they support it.
+  // This is the only way to set the service name inside an accessory.
+  // const hasConfiguredNameCharacteristic = service.characteristics.some(c => c.UUID === Characteristic.ConfiguredName.UUID)
+  // const hasConfiguredNameOptional = service.optionalCharacteristics.some(c => c.UUID === Characteristic.ConfiguredName.UUID)
+  // if (!hasConfiguredNameCharacteristic && !hasConfiguredNameOptional) {
+  //   service.addOptionalCharacteristic(Characteristic.ConfiguredName)
+  // }
+
+  service.updateCharacteristic(Characteristic.ConfiguredName, sanitizedName)
+}

package/package.json

@@ -1,28 +1,30 @@
 {
   "name": "homebridge-yoto",
   "description": "Control your Yoto players through Apple HomeKit with real-time MQTT updates",
-  "version": "0.0.28",
+  "version": "0.0.31",
   "author": "Bret Comnes <bcomnes@gmail.com> (https://bret.io)",
   "bugs": {
     "url": "https://github.com/bcomnes/homebridge-yoto/issues"
   },
   "dependencies": {
-    "homebridge-lib": "^7.2.0",
-    "mqtt": "^5.14.1"
+    "@homebridge/plugin-ui-utils": "^2.1.2",
+    "color-convert": "3.1.3",
+    "yoto-nodejs-client": "^0.0.7"
   },
   "devDependencies": {
     "@types/node": "^25.0.0",
     "@voxpelli/tsconfig": "^16.1.0",
     "auto-changelog": "^2.0.0",
     "c8": "^10.0.0",
+    "eslint": "^9.39.2",
     "gh-release": "^7.0.0",
-    "homebridge": "^1.6.1",
+    "homebridge": "^2.0.0-beta.66",
     "neostandard": "^0.12.0",
     "npm-run-all2": "^8.0.1",
     "typescript": "~5.9.3"
   },
   "engines": {
-    "node": ">=20",
+    "node": ">=22",
     "npm": ">=10",
     "homebridge": "^1.8.0 || ^2.0.0-beta.0"
   },
@@ -40,22 +42,6 @@
     "type": "git",
     "url": "https://github.com/bcomnes/homebridge-yoto.git"
   },
-  "scripts": {
-    "prepublishOnly": "npm run build && git push --follow-tags && gh-release -y",
-    "postpublish": "npm run clean",
-    "test": "run-s test:*",
-    "test:lint": "eslint",
-    "test:tsc": "tsc",
-    "test:node-test": "c8 node --test --test-reporter spec",
-    "version": "run-s version:*",
-    "version:changelog": "auto-changelog -p --template keepachangelog auto-changelog --breaking-pattern 'BREAKING CHANGE:'",
-    "version:git": "git add CHANGELOG.md",
-    "build": "npm run clean && run-p build:*",
-    "build:declaration": "tsc -p declaration.tsconfig.json",
-    "clean": "run-p clean:*",
-    "clean:declarations-top": "rm -rf $(find . -maxdepth 1 -type f -name '*.d.ts*')",
-    "clean:declarations-lib": "rm -rf $(find lib -type f -name '*.d.ts*' ! -name '*-types.d.ts')"
-  },
   "funding": {
     "type": "individual",
     "url": "https://github.com/sponsors/bcomnes"
@@ -65,5 +51,14 @@
       "lcov",
       "text"
     ]
+  },
+  "scripts": {
+    "test": "run-s test:*",
+    "test:lint": "eslint",
+    "test:tsc": "tsc",
+    "test:node-test": "c8 node --test --test-reporter spec",
+    "version": "run-s version:*",
+    "version:changelog": "auto-changelog -p --template keepachangelog auto-changelog --breaking-pattern 'BREAKING CHANGE:'",
+    "version:git": "git add CHANGELOG.md"
   }
-}
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+strictDepBuilds: true
+
+ignoredBuiltDependencies:
+  - unrs-resolver

package/declaration.tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "declaration": true,
-    "declarationMap": true,
-    "noEmit": false,
-    "emitDeclarationOnly": true
-  },
-  "exclude": [
-    "**/*.test.js",
-    "node_modules",
-    "coverage",
-    ".github"
-  ]
-}

package/lib/auth.js

@@ -1,237 +0,0 @@
-/**
- * @fileoverview OAuth2 Device Authorization Flow implementation for Yoto API
- */
-
-/** @import { Logger } from 'homebridge' */
-/** @import { YotoApiTokenResponse, YotoApiDeviceCodeResponse } from './types.js' */
-
-import {
-  YOTO_OAUTH_DEVICE_CODE_URL,
-  YOTO_OAUTH_TOKEN_URL,
-  OAUTH_CLIENT_ID,
-  OAUTH_AUDIENCE,
-  OAUTH_SCOPE,
-  OAUTH_POLLING_INTERVAL,
-  OAUTH_DEVICE_CODE_TIMEOUT,
-  ERROR_MESSAGES,
-  LOG_PREFIX
-} from './constants.js'
-
-/**
- * OAuth2 authentication handler for Yoto API
- */
-export class YotoAuth {
-  /**
-   * @param {Logger} log - Homebridge logger
-   * @param {string} [clientId] - OAuth client ID (uses default if not provided)
-   */
-  constructor (log, clientId) {
-    this.log = log
-    this.clientId = clientId || OAUTH_CLIENT_ID
-  }
-
-  /**
-   * Initiate device authorization flow
-   * @returns {Promise<YotoApiDeviceCodeResponse>}
-   */
-  async initiateDeviceFlow () {
-    this.log.debug(LOG_PREFIX.AUTH, 'Initiating device authorization flow...')
-    this.log.debug(LOG_PREFIX.AUTH, `Client ID: ${this.clientId}`)
-    this.log.debug(LOG_PREFIX.AUTH, `Endpoint: ${YOTO_OAUTH_DEVICE_CODE_URL}`)
-    this.log.debug(LOG_PREFIX.AUTH, `Scope: ${OAUTH_SCOPE}`)
-    this.log.debug(LOG_PREFIX.AUTH, `Audience: ${OAUTH_AUDIENCE}`)
-
-    try {
-      const params = new URLSearchParams({
-        client_id: this.clientId,
-        scope: OAUTH_SCOPE,
-        audience: OAUTH_AUDIENCE
-      })
-      this.log.debug(LOG_PREFIX.AUTH, 'Request body:', params.toString())
-
-      const response = await fetch(YOTO_OAUTH_DEVICE_CODE_URL, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/x-www-form-urlencoded'
-        },
-        body: params
-      })
-
-      this.log.debug(LOG_PREFIX.AUTH, `Response status: ${response.status}`)
-      this.log.debug(LOG_PREFIX.AUTH, 'Response headers:', Object.fromEntries(response.headers.entries()))
-
-      if (!response.ok) {
-        const errorText = await response.text()
-        this.log.error(LOG_PREFIX.AUTH, `Device code request failed with status ${response.status}`)
-        this.log.error(LOG_PREFIX.AUTH, `Error response: ${errorText}`)
-        throw new Error(`Device code request failed: ${response.status} ${errorText}`)
-      }
-
-      const data = /** @type {YotoApiDeviceCodeResponse} */ (await response.json())
-
-      this.log.info(LOG_PREFIX.AUTH, '='.repeat(60))
-      this.log.info(LOG_PREFIX.AUTH, 'YOTO AUTHENTICATION REQUIRED')
-      this.log.info(LOG_PREFIX.AUTH, '='.repeat(60))
-      this.log.info(LOG_PREFIX.AUTH, '')
-      this.log.info(LOG_PREFIX.AUTH, `1. Visit: ${data.verification_uri}`)
-      this.log.info(LOG_PREFIX.AUTH, `2. Enter code: ${data.user_code}`)
-      this.log.info(LOG_PREFIX.AUTH, '')
-      this.log.info(LOG_PREFIX.AUTH, `Or visit: ${data.verification_uri_complete}`)
-      this.log.info(LOG_PREFIX.AUTH, '')
-      this.log.info(LOG_PREFIX.AUTH, `Code expires in ${Math.floor(data.expires_in / 60)} minutes`)
-      this.log.info(LOG_PREFIX.AUTH, '='.repeat(60))
-
-      return data
-    } catch (error) {
-      this.log.error(LOG_PREFIX.AUTH, 'Failed to initiate device flow:', error)
-      throw error
-    }
-  }
-
-  /**
-   * Poll for authorization completion
-   * @param {string} deviceCode - Device code from initiation
-   * @returns {Promise<YotoApiTokenResponse>}
-   */
-  async pollForAuthorization (deviceCode) {
-    const startTime = Date.now()
-    const timeout = OAUTH_DEVICE_CODE_TIMEOUT
-
-    this.log.debug(LOG_PREFIX.AUTH, 'Waiting for user authorization...')
-
-    while (Date.now() - startTime < timeout) {
-      try {
-        const params = new URLSearchParams({
-          grant_type: 'urn:ietf:params:oauth:grant-type:device_code',
-          device_code: deviceCode,
-          client_id: this.clientId,
-          audience: OAUTH_AUDIENCE
-        })
-
-        const response = await fetch(YOTO_OAUTH_TOKEN_URL, {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/x-www-form-urlencoded'
-          },
-          body: params
-        })
-
-        if (response.ok) {
-          const tokenData = /** @type {YotoApiTokenResponse} */ (await response.json())
-          this.log.info(LOG_PREFIX.AUTH, '✓ Authorization successful!')
-          return tokenData
-        }
-
-        const errorData = /** @type {any} */ (await response.json().catch(() => ({})))
-
-        // Handle specific OAuth errors
-        if (errorData.error === 'authorization_pending') {
-          // Still waiting for user to authorize
-          await this.sleep(OAUTH_POLLING_INTERVAL)
-          continue
-        }
-
-        if (errorData.error === 'slow_down') {
-          // Server wants us to slow down polling
-          await this.sleep(OAUTH_POLLING_INTERVAL * 2)
-          continue
-        }
-
-        if (errorData.error === 'expired_token') {
-          throw new Error('Device code expired. Please restart the authorization process.')
-        }
-
-        if (errorData.error === 'access_denied') {
-          throw new Error('Authorization was denied by the user.')
-        }
-
-        // Unknown error
-        throw new Error(`Authorization failed: ${errorData.error || response.statusText}`)
-      } catch (error) {
-        if (error instanceof Error && error.message.includes('expired')) {
-          throw error
-        }
-        this.log.debug(LOG_PREFIX.AUTH, 'Polling error:', error)
-        await this.sleep(OAUTH_POLLING_INTERVAL)
-      }
-    }
-
-    throw new Error('Authorization timed out. Please try again.')
-  }
-
-  /**
-   * Refresh access token using refresh token
-   * @param {string} refreshToken - Refresh token
-   * @returns {Promise<YotoApiTokenResponse>}
-   */
-  async refreshAccessToken (refreshToken) {
-    this.log.debug(LOG_PREFIX.AUTH, 'Refreshing access token...')
-
-    try {
-      const params = new URLSearchParams({
-        grant_type: 'refresh_token',
-        refresh_token: refreshToken,
-        client_id: this.clientId
-      })
-
-      const response = await fetch(YOTO_OAUTH_TOKEN_URL, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/x-www-form-urlencoded'
-        },
-        body: params
-      })
-
-      if (!response.ok) {
-        const errorText = await response.text()
-        throw new Error(`Token refresh failed: ${response.status} ${errorText}`)
-      }
-
-      const tokenData = /** @type {YotoApiTokenResponse} */ (await response.json())
-      this.log.info(LOG_PREFIX.AUTH, '✓ Token refreshed successfully')
-      return tokenData
-    } catch (error) {
-      this.log.error(LOG_PREFIX.AUTH, ERROR_MESSAGES.TOKEN_REFRESH_FAILED, error)
-      throw error
-    }
-  }
-
-  /**
-   * Complete device authorization flow
-   * @returns {Promise<YotoApiTokenResponse>}
-   */
-  async authorize () {
-    const deviceCodeResponse = await this.initiateDeviceFlow()
-    const tokenResponse = await this.pollForAuthorization(deviceCodeResponse.device_code)
-    return tokenResponse
-  }
-
-  /**
-   * Check if token is expired or expiring soon
-   * @param {number} expiresAt - Token expiration timestamp (seconds since epoch)
-   * @param {number} bufferSeconds - Seconds before expiry to consider expired
-   * @returns {boolean}
-   */
-  isTokenExpired (expiresAt, bufferSeconds = 300) {
-    const now = Math.floor(Date.now() / 1000)
-    return expiresAt <= now + bufferSeconds
-  }
-
-  /**
-   * Calculate token expiration timestamp
-   * @param {number} expiresIn - Seconds until token expires
-   * @returns {number} - Unix timestamp when token expires
-   */
-  calculateExpiresAt (expiresIn) {
-    return Math.floor(Date.now() / 1000) + expiresIn
-  }
-
-  /**
-   * Sleep for specified milliseconds
-   * @param {number} ms - Milliseconds to sleep
-   * @returns {Promise<void>}
-   */
-  sleep (ms) {
-    return new Promise(resolve => setTimeout(resolve, ms))
-  }
-}