@mdjhnson/homebridge-yoto 0.1.5 → 0.1.6

package/README.md

@@ -2,7 +2,7 @@
 
 <img src="https://github.com/homebridge/branding/raw/latest/logos/homebridge-wordmark-logo-vertical.png" width="150">
 
-<img src="https://raw.githubusercontent.com/mdjhnson/homebridge-yoto/master/logo.png" width="150">
+<img src="https://raw.githubusercontent.com/mdjhnson/homebridge-yoto/master/homebridge-ui/public/logo.png" width="100">
 
 </p>
 

package/config.schema.json

@@ -8,11 +8,16 @@
   "schema": {
     "type": "object",
     "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "default": "Yoto",
+        "description": "Name used for this plugin in the Homebridge log."
+      },
       "clientId": {
         "title": "OAuth Client ID",
         "type": "string",
         "default": "tpc_ot5BY24FLyZoCX9MnykipB",
-        "required": false,
         "description": "OAuth client ID for Yoto API authentication. The default works for most users. Only change if you've created your own OAuth app at yoto.dev.",
         "x-schema-form": {
           "hidden": false
@@ -21,7 +26,6 @@
       "accessToken": {
         "title": "Access Token",
         "type": "string",
-        "required": false,
         "description": "Automatically managed by the authentication flow. Do not edit manually.",
         "x-schema-form": {
           "type": "password"
@@ -30,7 +34,6 @@
       "refreshToken": {
         "title": "Refresh Token",
         "type": "string",
-        "required": false,
         "description": "Automatically managed by the authentication flow. Do not edit manually.",
         "x-schema-form": {
           "type": "password"
@@ -39,7 +42,6 @@
       "tokenExpiresAt": {
         "title": "Token Expiration",
         "type": "number",
-        "required": false,
         "description": "Automatically managed by the authentication flow. Do not edit manually.",
         "x-schema-form": {
           "hidden": true
@@ -50,7 +52,6 @@
         "type": "integer",
         "default": 60000,
         "minimum": 10000,
-        "required": false,
         "description": "How often to poll the Yoto API for device status and config as a fallback to MQTT updates. Defaults to 60000 (1 minute)."
       },
       "services": {
@@ -116,13 +117,11 @@
                 "label": {
                   "title": "Label",
                   "type": "string",
-                  "required": true,
                   "description": "Name shown in HomeKit for this card control."
                 },
                 "cardId": {
                   "title": "Card ID",
                   "type": "string",
-                  "required": true,
                   "description": "The Yoto card ID to play."
                 },
                 "playOnAll": {
@@ -131,7 +130,11 @@
                   "default": false,
                   "description": "Create a separate accessory that plays this card on every Yoto."
                 }
-              }
+              },
+              "required": [
+                "label",
+                "cardId"
+              ]
             }
           },
           "shortcuts": {
@@ -250,6 +253,7 @@
       "expandable": true,
       "expanded": false,
       "items": [
+        "name",
         "httpPollIntervalMs",
         {
           "type": "help",

package/homebridge-ui/public/client.js

@@ -16,6 +16,7 @@ const homebridge = window.homebridge
 /**
  * @typedef {Object} YotoConfig
  * @property {string} [platform] - Platform alias (always "Yoto")
+ * @property {string} [name] - Name used in the Homebridge log
  * @property {string} [clientId] - OAuth client ID (only stored when not the default)
  * @property {string} [refreshToken] - Stored refresh token
  * @property {string} [accessToken] - Stored access token
@@ -31,6 +32,8 @@ let authorizeUrl = null
 let pluginConfig = []
 /** @type {string | null} */
 let defaultClientId = null
+/** @type {string | null} */
+let defaultName = null
 /** @type {string[]} */
 let legacyClientIds = []
 
@@ -153,14 +156,13 @@ function getErrorMessage (error, fallback) {
 async function loadAuthConfig () {
   try {
     pluginConfig = await homebridge.getPluginConfig()
-    if (!pluginConfig.length) {
-      pluginConfig.push({ platform: 'Yoto' })
-    }
 
     /** @type {AuthConfigResponse} */
     const config = await homebridge.request('/auth/config')
     defaultClientId = config.defaultClientId
+    defaultName = config.defaultName
     legacyClientIds = config.legacyClientIds
+    getPlatformBlock()
 
     const redirectUriDisplay = document.getElementById('redirectUriDisplay')
     if (redirectUriDisplay) redirectUriDisplay.textContent = config.redirectUri
@@ -178,6 +180,18 @@ async function loadAuthConfig () {
   }
 }
 
+/**
+ * The plugin's config block, created if missing. Also fills in the name,
+ * which blocks saved by older versions don't have.
+ * @returns {YotoConfig}
+ */
+function getPlatformBlock () {
+  if (!pluginConfig[0]) pluginConfig[0] = { platform: 'Yoto' }
+  const config = pluginConfig[0]
+  if (!config.name && defaultName) config.name = defaultName
+  return config
+}
+
 /**
  * The client ID saved in config, ignoring retired ones
  * @returns {string | undefined}
@@ -265,8 +279,7 @@ async function finishAuthorization () {
       response: pasted,
     })
 
-    if (!pluginConfig[0]) pluginConfig[0] = { platform: 'Yoto' }
-    const config = pluginConfig[0]
+    const config = getPlatformBlock()
     config.refreshToken = result.refreshToken
     config.accessToken = result.accessToken
     config.tokenExpiresAt = result.tokenExpiresAt
@@ -306,11 +319,10 @@ async function logout () {
   try {
     homebridge.showSpinner()
 
-    if (pluginConfig[0]) {
-      delete pluginConfig[0].refreshToken
-      delete pluginConfig[0].accessToken
-      delete pluginConfig[0].tokenExpiresAt
-    }
+    const config = getPlatformBlock()
+    delete config.refreshToken
+    delete config.accessToken
+    delete config.tokenExpiresAt
 
     await homebridge.updatePluginConfig(pluginConfig)
     await homebridge.savePluginConfig()

package/homebridge-ui/public/index.html

@@ -2,6 +2,8 @@
 <script type="module" src="client.js"></script>
 
 <div class="card card-body">
+  <img src="logo.png" alt="Homebridge Yoto" width="80" height="80" class="d-block mx-auto mb-3" />
+
   <!-- Authentication Status -->
   <div id="authStatus">
     <h4>Authentication Status</h4>

package/homebridge-ui/server.js

@@ -11,6 +11,7 @@ import { HomebridgePluginUiServer, RequestError } from '@homebridge/plugin-ui-ut
 import { YotoClient } from 'yoto-nodejs-client'
 import {
   DEFAULT_CLIENT_ID,
+  DEFAULT_NAME,
   LEGACY_CLIENT_IDS,
   OAUTH_REDIRECT_URI,
   OAUTH_SCOPES,
@@ -59,6 +60,7 @@ class YotoUiServer extends HomebridgePluginUiServer {
  * Response from /auth/config endpoint
  * @typedef {Object} AuthConfigResponse
  * @property {string} defaultClientId - The default OAuth client ID
+ * @property {string} defaultName - The default plugin name, filled into config blocks that have none
  * @property {string[]} legacyClientIds - Client IDs that no longer support sign-in
  * @property {string} redirectUri - Redirect URI to register on a custom Yoto app
  */
@@ -70,6 +72,7 @@ class YotoUiServer extends HomebridgePluginUiServer {
 async function getAuthConfig () {
   return {
     defaultClientId: DEFAULT_CLIENT_ID,
+    defaultName: DEFAULT_NAME,
     legacyClientIds: LEGACY_CLIENT_IDS,
     redirectUri: OAUTH_REDIRECT_URI,
   }

package/lib/settings.js

@@ -15,6 +15,11 @@ export const PLUGIN_NAME = '@mdjhnson/homebridge-yoto'
  */
 export const DEFAULT_CLIENT_ID = configSchema.schema.properties.clientId.default
 
+/**
+ * Default plugin name (shown in the Homebridge log) from config schema
+ */
+export const DEFAULT_NAME = configSchema.schema.properties.name.default
+
 /**
  * OAuth redirect URI registered on the Yoto developer app. Nothing listens here:
  * the user copies the resulting address back into the plugin settings.

package/package.json

@@ -2,7 +2,7 @@
   "name": "@mdjhnson/homebridge-yoto",
   "displayName": "Homebridge Yoto",
   "description": "Control your Yoto players through Apple HomeKit with real-time MQTT updates",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "author": "mdjhnson (https://github.com/mdjhnson)",
   "contributors": [
     "Bret Comnes <bcomnes@gmail.com> (https://bret.io)"
@@ -22,6 +22,7 @@
   "devDependencies": {
     "@types/node": "^25.9.8",
     "@voxpelli/tsconfig": "^16.2.1",
+    "ajv": "^8.20.0",
     "auto-changelog": "^2.0.0",
     "c8": "^10.0.0",
     "eslint": "^9.39.2",