homebridge-config-ui-x 5.0.0-beta.3 → 5.0.0-beta.31

package/CHANGELOG.md

@@ -6,7 +6,7 @@ All notable changes to `homebridge-config-ui-x` will be documented in this file.
 
 ### ⚠️ Breaking Changes
 
-- This version of the Homebridge UI will drop support for:
+- This version of the Homebridge UI drops support for:
   - Node.js `v16` and earlier, so please update to `v18` or `v20` or `v22` - [more info on updating](https://github.com/homebridge/homebridge/wiki/How-To-Update-Node.js)
   - Raspberry Pi devices running on the `armv6` architecture (like the Pi 1 and Pi Zero) - please update your hardware
   - Instances using `pnpm` as the package manager - consider updating your Homebridge instance to use npm instead - [more info on updating](https://github.com/homebridge/homebridge-apt-pkg/blob/latest/README.md#using-apt)
@@ -28,11 +28,11 @@ Plugin developers:
 - Please do not rely on this validation and assume that a user's configuration will be valid
 - All plugins should still validate a configuration when the plugin is started
 - Remember that some users do not use the UI at all, and other users may prefer to configure using raw `JSON` rather than config screens
-- Please report any cases where the validation is not working as expected, or where the 'Save' button is incorrectly disabled when using custom UIs
+- Please report any cases where the validation is not working as expected
 
 ### UI Changes
 
-- implement and allow switching to scoped plugins
+- updates to the `fi.json` language file (#2253) (@l1500s)
 - add plugin config validation functionality
 - refactor status and child bridge widgets
 - update default dashboard layout
@@ -40,14 +40,190 @@ Plugin developers:
 ### Other Changes
 
 - retire use of `pnpm` and code references
-- enable strict config validation for the UI
 - bump the default node version from 20 to 22
-- update angular from `v18` to `v19`
+- make terminal enabled by default on new macOS hb-service installs
+- improvements to GH actions and build processes (@NorthernMan54)
 
 ### Homebridge Dependencies
 
-- `@homebridge/hap-client` @ `v2.0.4`
+- `@homebridge/hap-client` @ `v2.0.5`
 - `@homebridge/node-pty-prebuilt-multiarch` @ `v0.12.0-beta`
+- `@homebridge/plugin-ui-utils` @ `v2.0.0`
+
+## v4.68.0 (2025-01-07)
+
+Happy 2025 to all our users! 🎉
+
+### UI Changes
+
+- updates to the `cs.json` language file (#2311) (@DavidHuljak)
+- improved messaging on plugin child bridge modal
+- further improvements to plugin search
+- implement and allow switching to scoped plugins
+- merge plugin info and verified modals
+  - condensing plugin card into title + three lines of description
+- consistent formatting of child bridge names across the ui
+- general improvements across the ui
+  - status page:
+    - individual widget setting form design made consistent with other forms
+    - added pairing status to qr code widget
+  - plugins page:
+    - visual improvements to plugin child bridge settings modal
+    - allow plugins to disable/enable the save button in custom uis (see below section)
+    - allow configuring [multiple accessories on the same child bridge](https://github.com/homebridge/homebridge/wiki/Child-Bridges#multiple-accessories-on-the-same-child-bridge) via the ui
+  - accessories page:
+    - changed accessory spanner icon to info icon (more descriptive)
+    - accessory info modal redesigned and provides more info where possible like the accessory UUID (including a link to remove from the cache)
+    - added support modal with some info about rooms and accessories (visible on desktop)
+  - json config page:
+    - redesigned restore modal to be more consistent with other modals
+  - settings page:
+    - chevron icons replaced with arrow-right icons
+    - removed restore modal from settings page and is accessible from the backup modal
+    - backup modal redesigned to be more consistent with other modals
+    - added new display -> menu mode setting which allows keeping the side menu from expanding out on desktop
+    - redesigned and improved accessories and bridges sections and modals
+  - users page:
+    - add user and edit user modals redesigned to be more consistent with other modals
+    - user card updated with icon buttons for edit/delete rather than text buttons
+
+### Plugin Custom UI Changes
+
+The UI has recently been updated with `@homebridge/plugin-ui-utils` @ `v2.0.0`, which includes a new feature to allow plugin developers to dynamically enable and disable the `Save` button in the custom UI modal.
+Two new methods have been added for this purpose:
+
+- `homebridge.disableSaveButton()`
+- `homebridge.enableSaveButton()`
+
+Developers: to maintain compatibility with older versions of the Homebridge UI, it is recommended to check if the methods exist before calling them in your custom UIs:
+
+- `homebridge.disableSaveButton?.()`
+- `homebridge.enableSaveButton?.()`
+
+### Other Changes
+
+- auto-fix ui theme setting property if existing value is not valid
+- do not allow `armv6l` users to update to UI `v5`
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.0`
+
+## v4.67.0 (2024-12-28)
+
+### UI Changes
+
+- add explanation of deleting child bridges when un-toggling
+- add filtering to search to improve results (#2286) (@justjam2013) (fixes [#2266](https://github.com/homebridge/homebridge-config-ui-x/issues/2266))
+- fix spacing issue with hidden accessories
+- make margins consistent of un/lock buttons on status screen
+- fix ui not restarting properly after updating the ui
+- use broom icon in remove bridge accessories (to match similar modal from plugin menu)
+
+### Other Changes
+
+- improve and finish up previous angular migration
+- update `hap-client` + `plugin-ui-utils` hb dependencies
+- update dependencies
+- improve lint sorting of imports
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v2.0.5`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v2.0.0`
+
+## v4.66.0 (2024-12-25)
+
+### UI Changes
+
+- fix verified plugins link in support module (fixes [#2295](https://github.com/homebridge/homebridge-config-ui-x/issues/2295))
+- add missing modal footer `<div>`s to accessory control modals
+- fix radio button groups in certain accessory control modals (fixes [#2294](https://github.com/homebridge/homebridge-config-ui-x/issues/2294))
+
+### Other Changes
+
+- format svg files nicely as part of lint
+- upgrade angular from `v18` to `v19`
+- delete unpaired bridges when toggling bridges off (#2284) (@justjam2013) (fixes [#2257](https://github.com/homebridge/homebridge-config-ui-x/issues/2257))
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.65.2 (2024-12-15)
+
+### UI Changes
+
+- Rollback recent changes to plugin search (#2289) (@justjam2013)
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.65.1 (2024-12-13)
+
+### UI Changes
+
+- updates to the `th.json` language file (#2271) (@tomzt)
+- updates to the `de.json` language file (#2250) (@Staubgeborener)
+- Remove unrelated plugins from search (#2272) (@justjam2013)
+
+### Other Changes
+
+- fix types + update dependencies
+- fix attach artifacts to release workflow
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.65.0 (2024-12-08)
+
+### UI Changes
+
+- updates to the `uk.json` language file (#2262) (@xrust83)
+- logo and `homebridge` text should link to status page
+- Add icons for shower head and water faucet valve types (#2267) (@justjam2013)
+- Removed conditional for displaying search exit component (#2269) (@justjam2013)
+
+### Other Changes
+
+- Fix typo in console message (#2264) (@markholland)
+- updated dependencies
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
+- `@homebridge/plugin-ui-utils` @ `v1.0.3`
+
+## v4.64.0 (2024-11-30)
+
+### UI Changes
+
+- updates to the `de.json` language file (#2249) (@Staubgeborener)
+- updates to the `ko.json` language file (#2251) (@alphaorderly)
+- updates to the `uk.json` language file (#2255) (@xrust83)
+- add reload menu item when using as a PWA
+
+### Other Changes
+
+- dependency updates
+- fix npm search max character limit
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-client` @ `v1.10.2`
+- `@homebridge/node-pty-prebuilt-multiarch` @ `v0.11.14`
 - `@homebridge/plugin-ui-utils` @ `v1.0.3`
 
 ## v4.63.0 (2024-11-17)
@@ -73,8 +249,6 @@ Plugin developers:
 - migrate `@zajsf/*` to `@ng-formworks/*` for plugin schema forms
 - check for service mode when querying child bridge status
 - perform a full restart when updating `homebridge`
-- make terminal enabled by default on new macOS hb-service installs
-- update node pty beta `v0.12.0-beta`
 
 ### Homebridge Dependencies
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 Homebridge
+Copyright (c) 2023-2025 Homebridge
 Copyright (c) 2017-2023 oznu <dev@oz.nu>
 Copyright (c) 2017 Michael Kellsy
 

package/README.md

@@ -28,8 +28,6 @@
 
 Homebridge UI also provides a tool called [`hb-service`](https://github.com/homebridge/homebridge-config-ui-x/wiki/Homebridge-Service-Command) which makes it easy to set up Homebridge as a service on Linux/Raspbian, macOS and Windows 10.
 
-[![Status](screenshots/homebridge-config-ui-x-darkmode-status.png?2020-01-07)](#usage)
-
 ## Installation Instructions
 
 For detailed instructions on how to set up Node.js and Homebridge with Homebridge UI as a service, see the guides on the wiki:
@@ -54,35 +52,35 @@ The UI can be accessed via web browser by default on port `8581` (e.g. `http://l
 
 This shows an overview of your Homebridge system. The dashboard is widget-based and completely customisable with a number of themes available.
 
-![Status](screenshots/homebridge-config-ui-x-status.png?2020-01-07)
+![Status](screenshots/homebridge-config-ui-x-status.png)
 
 ### Plugin Screen
 
 This shows you the currently installed plugins and allows you to install, configure, update and remove plugins.
 
-![Plugin](screenshots/homebridge-config-ui-x-darkmode-plugins.png?2020-01-07)
+![Plugin](screenshots/homebridge-config-ui-x-darkmode-plugins.png)
 
 You can configure supported plugins using the graphical settings editor, or by editing the config JSON directly.
 
-![Plugin Settings](screenshots/homebridge-config-ui-x-darkmode-alexa-settings.png?2020-01-07)
+![Plugin Settings](screenshots/homebridge-config-ui-x-darkmode-alexa-settings.png)
 
 ### Configuration Screen
 
 The configuration screen allows you to modify your Homebridge `config.json`. The built-in editor automatically syntax-checks your JSON and makes a backup of your config every time you make a change.
 
-![Config](screenshots/homebridge-config-ui-x-config.png?2020-01-07)
+![Config](screenshots/homebridge-config-ui-x-config.png)
 
 ### Log Screen
 
 This shows you the Homebridge rolling log. This is helpful for troubleshooting.
 
-![Log](screenshots/homebridge-config-ui-x-logs.png?2020-01-07)
+![Log](screenshots/homebridge-config-ui-x-logs.png)
 
 ### Accessories Screen
 
 This shows you the Homebridge accessories for all the Homebridge instances on your network. You can use this to control accessories from a web browser and works well on mobile devices which allows users to control Homebridge from non-Apple devices.
 
-![Accessories](screenshots/homebridge-config-ui-x-accessories.png?2020-01-07)
+![Accessories](screenshots/homebridge-config-ui-x-accessories.png)
 
 ## Plugin Development
 

package/config.schema.json

@@ -156,6 +156,26 @@
           }
         ]
       },
+      "menuMode": {
+        "title": "Menu Mode",
+        "description": "Modes for the UI side menu.",
+        "type": "string",
+        "default": "default",
+        "oneOf": [
+          {
+            "title": "Default",
+            "enum": [
+              "default"
+            ]
+          },
+          {
+            "title": "Freeze",
+            "enum": [
+              "freeze"
+            ]
+          }
+        ]
+      },
       "restart": {
         "title": "Custom Restart Command",
         "type": "string",
@@ -163,7 +183,7 @@
         "placeholder": "eg. sudo systemctl restart homebridge"
       },
       "temp": {
-        "title": "Path to OS Temp File",
+        "title": "OS Temp File Path",
         "type": "string",
         "placeholder": "eg. /sys/class/thermal/thermal_zone0/temp",
         "description": "If you are running Homebridge on a Raspberry Pi, you can enter the path to the OS temp file here. This will display the current temperature on the Homebridge status page."
@@ -373,7 +393,7 @@
         ]
       },
       "loginWallpaper": {
-        "title": "Path to Login Wallpaper Image File",
+        "title": "Login Wallpaper Path",
         "description": "The full path to the .jpg file.",
         "type": "string",
         "placeholder": "eg. /home/pi/mywallpaper.jpg"
@@ -390,7 +410,7 @@
         "placeholder": "eg. /usr/local/lib/node_modules/homebridge"
       },
       "noFork": {
-        "title": "Do not run the Config UI web server in a separate process/thread",
+        "title": "Do not run the UI server in a separate process/thread",
         "type": "boolean",
         "description": "If you are running Homebridge in a container, you may need to enable this option."
       },
@@ -398,11 +418,11 @@
         "title": "Host IP Address",
         "type": "string",
         "pattern": "^[^{}/ :\\\\]+(?::\\d+)?$",
-        "description": "The host ip address to listen on. In most cases this will be '::' or '0.0.0.0'",
+        "description": "The host IP address to listen on. In most cases this will be '::' or '0.0.0.0'.",
         "placeholder": "eg. 0.0.0.0"
       },
       "debug": {
-        "title": " Enable / disable debug level logging",
+        "title": "Enable Debug Logging",
         "type": "boolean",
         "description": "If enabled, the Homebridge UI will log debug level messages to the console."
       },
@@ -412,7 +432,7 @@
         "description": "If you are running Homebridge in a container, you may need to enable this option."
       },
       "sessionTimeout": {
-        "title": "Session Timeout (in seconds)",
+        "title": "Session Timeout (Seconds)",
         "type": "integer",
         "placeholder": 28800,
         "minimum": 600,
@@ -492,14 +512,14 @@
           },
           "tail": {
             "type": "string",
-            "description": "Depreciated",
+            "description": "Depreciated.",
             "condition": {
               "functionBody": "return (model.log && (model.log.method==='custom' || model.log.method==='systemd' || model.log.method==='file'))"
             }
           },
           "systemd": {
             "type": "string",
-            "description": "Depreciated",
+            "description": "Depreciated.",
             "condition": {
               "functionBody": "return (model.log && (model.log.method==='custom' || model.log.method==='systemd' || model.log.method==='file'))"
             }
@@ -525,19 +545,19 @@
         "description": "The SSL settings for the Homebridge UI.",
         "properties": {
           "key": {
-            "title": "Path To Private Key",
+            "title": "Private Key Path",
             "type": "string",
             "description": "The full path to the private key file.",
             "placeholder": "eg. /Users/homebridge/.homebridge/certs/server.key"
           },
           "cert": {
-            "title": "Path To Certificate",
+            "title": "Certificate Path",
             "type": "string",
             "description": "The full path to the certificate file.",
             "placeholder": "eg. /Users/homebridge/.homebridge/certs/server.crt"
           },
           "pfx": {
-            "title": "Path To PKCS#12 Certificate",
+            "title": "PKCS#12 Certificate Path",
             "type": "string",
             "description": "The full path to the PKCS#12 certificate file.",
             "placeholder": "eg. /Users/homebridge/.homebridge/certs/server.pfx"
@@ -556,14 +576,14 @@
         "description": "The accessory control settings for the Homebridge UI.",
         "properties": {
           "debug": {
-            "title": " Enable / disable debug level logging for accessory control via the web UI",
+            "title": "Enable Accessory Control Debug Logging",
             "type": "boolean",
             "description": "If enabled, the Homebridge UI will log debug level messages to the console."
           },
           "instanceBlacklist": {
-            "title": "Blacklisted Instances",
+            "title": "Blacklisted Bridges/Instances",
             "type": "array",
-            "description": "A list of instances that should not be controlled via the web UI.",
+            "description": "A list of instances (or bridge usernames) that should not be controlled via the web UI.",
             "placeholder": "eg. 00:00:00:00:00:00",
             "items": {
               "title": "Instance Username",
@@ -600,8 +620,8 @@
         "description": "When running behind a reverse proxy you may need to enter the hostname you use to access the UI."
       },
       "scheduledBackupPath": {
-        "title": "Scheduled backup destination path",
-        "description": "The full path to where the service should save daily scheduled backups archives",
+        "title": "Scheduled Backup Destination",
+        "description": "The full path to where the service should save daily scheduled backups archives.",
         "type": "string",
         "placeholder": "eg. /home/pi/homebridge-backups",
         "condition": {
@@ -611,12 +631,12 @@
       "scheduledBackupDisable": {
         "title": "Disable Scheduled Backups",
         "type": "boolean",
-        "description": "When enabled, the Homebridge UI will not create daily scheduled backups"
+        "description": "When enabled, the Homebridge UI will not create daily scheduled backups."
       },
       "disableServerMetricsMonitoring": {
         "title": "Disable Server Metrics Monitoring",
         "type": "boolean",
-        "description": "When enabled, the Homebridge UI will not collect or report cpu / memory stats"
+        "description": "When enabled, the Homebridge UI will not collect or report CPU or memory stats."
       }
     }
   },

package/dist/bin/fork.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/bin/fork.js.map

@@ -1 +1 @@
-{"version":3,"file":"fork.js","sourceRoot":"","sources":["../../src/bin/fork.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAkC;AAElC,sBAAO,CAAC,KAAK,GAAG,wBAAwB,CAAA;AAExC,WAAW,CAAC,GAAG,EAAE;IACf,IAAI,CAAC,sBAAO,CAAC,SAAS,EAAE,CAAC;QACvB,sBAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC,EAAE,KAAK,CAAC,CAAA;AAET,sBAAO,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;IAC5B,sBAAO,CAAC,IAAI,EAAE,CAAA;AAChB,CAAC,CAAC,CAAA;AAEF,kDAAO,SAAS,IAAC"}
+{"version":3,"file":"fork.js","sourceRoot":"","sources":["../../src/bin/fork.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAAkC;AAElC,sBAAO,CAAC,KAAK,GAAG,wBAAwB,CAAA;AAExC,WAAW,CAAC,GAAG,EAAE;IACf,IAAI,CAAC,sBAAO,CAAC,SAAS,EAAE,CAAC;QACvB,sBAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC,EAAE,KAAK,CAAC,CAAA;AAET,sBAAO,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;IAC5B,sBAAO,CAAC,IAAI,EAAE,CAAA;AAChB,CAAC,CAAC,CAAA;AAEF,kDAAO,SAAS,IAAC"}

package/dist/bin/hb-service.d.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import type { ExtractOptions } from 'tar';
+import type { TarOptionsWithAliases } from 'tar';
 export declare class HomebridgeServiceHelper {
     action: 'install' | 'uninstall' | 'start' | 'stop' | 'restart' | 'rebuild' | 'run' | 'add' | 'remove' | 'logs' | 'view' | 'update-node' | 'before-start' | 'status';
     selfPath: string;
@@ -65,7 +65,7 @@ export declare class HomebridgeServiceHelper {
     private fixDockerPermissions;
     private checkForNodejsUpdates;
     downloadNodejs(downloadUrl: string): Promise<string>;
-    extractNodejs(targetVersion: string, extractConfig: ExtractOptions): Promise<void>;
+    extractNodejs(targetVersion: string, extractConfig: TarOptionsWithAliases): Promise<void>;
     removeNpmPackage(npmInstallPath: string): Promise<void>;
     private checkStatus;
     private parseNpmPackageString;