homebridge-tuya-plus 3.5.1 → 3.5.3

package/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test Code
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "23"
+
+      - run: npm ci
+
+      - name: Run Jest
+        run: npm run test

package/config.schema.json

@@ -7,23 +7,27 @@
   "schema": {
     "type": "object",
     "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "default": "Tuya LAN"
+      },
       "discoverTimeout": {
         "title": "Device IP auto-discovery timeout",
         "type": "integer",
         "minimum": 0,
         "placeholder": "Timeout (millisecond) for device IP address discovery",
-        "default": 60000,
-        "required": false
+        "default": 60000
       },
       "devices": {
         "type": "array",
         "orderable": false,
         "items": {
           "type": "object",
+          "required": ["type", "name", "id", "key"],
           "properties": {
             "type": {
               "type": "string",
-              "required": true,
               "default": "null",
               "oneOf": [
                 {
@@ -107,7 +111,6 @@
             "name": {
               "type": "string",
               "description": "Anything you'd like to use to identify this device. You can always change the name from within the Home app later.",
-              "required": true,
               "condition": {
                 "functionBody": "return model.devices && model.devices[arrayIndices].type !== 'null';"
               }
@@ -116,7 +119,6 @@
               "type": "string",
               "title": "Tuya ID",
               "description": "If you don't have the Tuya ID or Key, follow the steps found on the <a href='https://github.com/adrianjagielak/homebridge-tuya-plus/blob/main/wiki/Get-Local-Keys-for-Your-Devices.md' target='_blank'>Setup Instructions</a> page.",
-              "required": true,
               "condition": {
                 "functionBody": "return model.devices && model.devices[arrayIndices].type !== 'null';"
               }
@@ -124,7 +126,6 @@
             "key": {
               "title": "Tuya Key",
               "type": "string",
-              "required": true,
               "condition": {
                 "functionBody": "return model.devices && model.devices[arrayIndices].type !== 'null';"
               }
@@ -132,7 +133,6 @@
             "ip": {
               "title": "IP Address",
               "type": "string",
-              "required": false,
               "condition": {
                 "functionBody": "return model.devices && model.devices[arrayIndices].type !== 'null';"
               }

package/lib/CustomMultiOutletAccessory.js

@@ -30,7 +30,7 @@ class CustomMultiOutletAccessory extends BaseAccessory {
                 throw new Error('The outlet definition #${i} is missing or is malformed: ' + outlet);
 
             const name = ((outlet.name || '').trim() || 'Unnamed') + ' - ' + this.device.context.name;
-            let service = this.accessory.getServiceById(Service.Outlet.UUID, 'outlet ' + outlet.dp);
+            let service = this.accessory.getServiceById(Service.Outlet, 'outlet ' + outlet.dp);
             if (service) this._checkServiceName(service, name);
             else service = this.accessory.addService(Service.Outlet, name, 'outlet ' + outlet.dp);
 

package/lib/MultiOutletAccessory.js

@@ -24,7 +24,7 @@ class MultiOutletAccessory extends BaseAccessory {
         const outletCount = parseInt(this.device.context.outletCount) || 1;
         const _validServices = [];
         for (let i = 0; i++ < outletCount;) {
-            let service = this.accessory.getServiceById(Service.Outlet.UUID, 'outlet ' + i);
+            let service = this.accessory.getServiceById(Service.Outlet, 'outlet ' + i);
             if (service) this._checkServiceName(service, this.device.context.name + ' ' + i);
             else service = this.accessory.addService(Service.Outlet, this.device.context.name + ' ' + i, 'outlet ' + i);
 

package/lib/OilDiffuserAccessory.js

@@ -34,12 +34,12 @@ class OilDiffuserAccessory extends BaseAccessory {
         const {Service} = this.hap;
 
         const humidifierName = this.device.context.name;
-        let humidifierService = this.accessory.getServiceById(Service.HumidifierDehumidifier.UUID, 'humidifier');
+        let humidifierService = this.accessory.getServiceById(Service.HumidifierDehumidifier, 'humidifier');
         if (humidifierService) this._checkServiceName(humidifierService, humidifierName);
         else humidifierService = this.accessory.addService(Service.HumidifierDehumidifier, humidifierName, 'humidifier');
 
         const lightName = this.device.context.name + ' Light';
-        let lightService = this.accessory.getServiceById(Service.Lightbulb.UUID, 'lightbulb');
+        let lightService = this.accessory.getServiceById(Service.Lightbulb, 'lightbulb');
         if (lightService) this._checkServiceName(lightService, lightName);
         else lightService = this.accessory.addService(Service.Lightbulb, lightName, 'lightbulb');
 
@@ -55,8 +55,8 @@ class OilDiffuserAccessory extends BaseAccessory {
 
         const {Service, AdaptiveLightingController, Characteristic} = this.hap;
 
-        const humidifierService = this.accessory.getServiceById(Service.HumidifierDehumidifier.UUID, 'humidifier');
-        const lightService = this.accessory.getServiceById(Service.Lightbulb.UUID, 'lightbulb');
+        const humidifierService = this.accessory.getServiceById(Service.HumidifierDehumidifier, 'humidifier');
+        const lightService = this.accessory.getServiceById(Service.Lightbulb, 'lightbulb');
 
         this.dpLight = this._getCustomDP(this.device.context.dpLight) || '5';
         this.dpMode = this._getCustomDP(this.device.context.dpMode) || '6';

package/lib/RGBTWOutletAccessory.js

@@ -22,12 +22,12 @@ class RGBTWOutletAccessory extends BaseAccessory {
         const {Service} = this.hap;
 
         const outletName = 'Outlet - ' + this.device.context.name;
-        let outletService = this.accessory.getServiceById(Service.Outlet.UUID, 'outlet');
+        let outletService = this.accessory.getServiceById(Service.Outlet, 'outlet');
         if (outletService) this._checkServiceName(outletService, outletName);
         else outletService = this.accessory.addService(Service.Outlet, outletName, 'outlet');
 
         const lightName = 'RGBTWLight - ' + this.device.context.name;
-        let lightService = this.accessory.getServiceById(Service.Lightbulb.UUID, 'lightbulb');
+        let lightService = this.accessory.getServiceById(Service.Lightbulb, 'lightbulb');
         if (lightService) this._checkServiceName(lightService, lightName);
         else lightService = this.accessory.addService(Service.Lightbulb, lightName, 'lightbulb');
 
@@ -43,8 +43,8 @@ class RGBTWOutletAccessory extends BaseAccessory {
 
         const {Service, Characteristic, EnergyCharacteristics} = this.hap;
 
-        const outletService = this.accessory.getServiceById(Service.Outlet.UUID, 'outlet');
-        const lightService = this.accessory.getServiceById(Service.Lightbulb.UUID, 'lightbulb');
+        const outletService = this.accessory.getServiceById(Service.Outlet, 'outlet');
+        const lightService = this.accessory.getServiceById(Service.Lightbulb, 'lightbulb');
 
         this.dpLight = this._getCustomDP(this.device.context.dpLight) || '1';
         this.dpMode = this._getCustomDP(this.device.context.dpMode) || '2';

package/lib/SwitchAccessory.js

@@ -24,7 +24,7 @@ class SwitchAccessory extends BaseAccessory {
         const switchCount = parseInt(this.device.context.switchCount) || 1;
         const _validServices = [];
         for (let i = 0; i++ < switchCount;) {
-            let service = this.accessory.getServiceById(Service.Switch.UUID, 'switch ' + i);
+            let service = this.accessory.getServiceById(Service.Switch, 'switch ' + i);
             if (service) this._checkServiceName(service, this.device.context.name + ' ' + i);
             else service = this.accessory.addService(Service.Switch, this.device.context.name + ' ' + i, 'switch ' + i);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tuya-plus",
-  "version": "3.5.1",
+  "version": "3.5.3",
   "description": "A community-maintained Homebridge plugin for controlling Tuya devices locally over LAN. Includes new features, fixes, and updated device support.",
   "main": "index.js",
   "scripts": {

package/test/uuidStability.test.js

@@ -0,0 +1,75 @@
+'use strict';
+
+// Regression guard for HomeKit accessory identity.
+//
+// HomeKit identifies accessories by UUID. Every UUID this plugin produces
+// must be derived from the legacy seed 'homebridge-tuya' (the PLUGIN_NAME
+// used in v3.4.0 and earlier) - NOT from the current npm package name
+// 'homebridge-tuya-plus'. v3.5.0 broke this and reset every device in
+// HomeKit; v3.5.1 restored it.
+//
+// These tests fail loudly if anyone "cleans up" the seed back to PLUGIN_NAME.
+
+const crypto = require('crypto');
+const fs = require('fs');
+const path = require('path');
+
+const indexSource = fs.readFileSync(path.join(__dirname, '..', 'index.js'), 'utf8');
+
+// HAP-NodeJS's uuid.generate algorithm, reproduced here so the test does not
+// require pulling in homebridge or hap-nodejs. Matches
+// https://github.com/homebridge/HAP-NodeJS/blob/master/src/lib/util/uuid.ts
+function hapGenerate(data) {
+    const sha1 = crypto.createHash('sha1').update(data).digest('hex');
+    let i = -1;
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
+        i += 1;
+        if (c === 'y') return ((parseInt(sha1[i], 16) & 0x3) | 0x8).toString(16);
+        return sha1[i];
+    });
+}
+
+describe('index.js UUID seed constants', () => {
+    test("UUID_SEED is 'homebridge-tuya' (legacy v3.4.0 PLUGIN_NAME)", () => {
+        expect(indexSource).toMatch(/const\s+UUID_SEED\s*=\s*'homebridge-tuya'\s*;/);
+    });
+
+    test("PLUGIN_NAME is 'homebridge-tuya-plus' (current npm package name)", () => {
+        expect(indexSource).toMatch(/const\s+PLUGIN_NAME\s*=\s*'homebridge-tuya-plus'\s*;/);
+    });
+
+    test('every UUID.generate(...) call uses UUID_SEED, never PLUGIN_NAME', () => {
+        const calls = indexSource.match(/UUID\.generate\([^)]*\)/g) || [];
+        expect(calls.length).toBeGreaterThan(0);
+        for (const call of calls) {
+            expect(call).toMatch(/UUID_SEED/);
+            expect(call).not.toMatch(/PLUGIN_NAME/);
+        }
+    });
+});
+
+describe('UUID stability against v3.4.0', () => {
+    // Pinned outputs derived from `homebridge-tuya:<deviceId>` (the v3.4.0
+    // seed). If any of these change, every existing user's HomeKit identity
+    // resets on upgrade.
+    const fixtures = [
+        {
+            seed: 'homebridge-tuya:bf1234567890abcdef1234',
+            uuid: 'f7bd0a51-7bb8-4405-9ea6-d3da81023f2f',
+        },
+        {
+            seed: 'homebridge-tuya:fake:device-001',
+            uuid: '4922e84f-cbd0-415f-8ad4-43d7891ace87',
+        },
+    ];
+
+    test.each(fixtures)('UUID for "$seed" is stable', ({ seed, uuid }) => {
+        expect(hapGenerate(seed)).toBe(uuid);
+    });
+
+    test('legacy seed and v3.5.0 broken seed produce different UUIDs', () => {
+        const id = 'bf1234567890abcdef1234';
+        expect(hapGenerate('homebridge-tuya:' + id))
+            .not.toBe(hapGenerate('homebridge-tuya-plus:' + id));
+    });
+});