prepare for v1.0.0

ipv4-mapped ipv6 address change

Co-Authored-By: Supereg <[email protected]>

CHANGELOG.md

@@ -2,7 +2,12 @@
 
 All notable changes to `hap-nodejs` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).
 
-## v0.12.3 (2024-06-24)
+## ALPHA
+
+### Breaking Changes
+
+* **The minimum Node.js version required is now `v18`.**
+* **Important notice:** This update bring true semver support.
 
 ### Other Changes
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hap-nodejs",
-  "version": "0.12.3",
+  "version": "1.0.0",
   "description": "HAP-NodeJS is a Node.js implementation of HomeKit Accessory Server.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -52,7 +52,7 @@
     "@types"
   ],
   "dependencies": {
-    "@homebridge/ciao": "^1.2.0",
+    "@homebridge/ciao": "^2.0.0-alpha.4",
     "@homebridge/dbus-native": "^0.6.0",
     "bonjour-hap": "^3.7.3",
     "debug": "^4.3.5",

src/lib/Characteristic.ts

@@ -2881,8 +2881,8 @@ export class Characteristic extends EventEmitter {
 
       // mirrors the case value = null at the beginning
       if (value.length <= 1 && (this.UUID === Characteristic.Model.UUID || this.UUID === Characteristic.SerialNumber.UUID)) {
-        this.characteristicWarning(`[${this.displayName}] characteristic must have a length of more than 1 character otherwise \
-        HomeKit will reject this accessory, ignoring new value`, warningType);
+        this.characteristicWarning(`[${this.displayName}] characteristic must have a length of more than 1 character otherwise`
+          + ` HomeKit will reject this accessory, ignoring new value ${warningType}`);
         return this.value; // just return the current value
       }
 
@@ -2893,7 +2893,7 @@ export class Characteristic extends EventEmitter {
       }
 
       if (this.UUID === "000000E3-0000-1000-8000-0026BB765291") {
-        checkName("unknown", this.displayName, value);
+        checkName(this.displayName, "ConfiguredName", value);
       }
 
       return value;

src/lib/util/checkName.ts

@@ -6,11 +6,12 @@
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
 export function checkName(displayName: string, name: string, value: any): void {
-  const validHK = /^[a-zA-Z0-9\s'-.]+$/;   // Ensure only letter, numbers, apostrophe, or dash
+  const empty = !value ? true : false;    // Check if value is empty
+  const validHK = /^[a-zA-Z0-9\s'-.]+$/;  // Ensure only letter, numbers, apostrophe, or dash
   const startWith = /^[a-zA-Z0-9]/;       // Ensure only letters or numbers are at the beginning of string
   const endWith = /[a-zA-Z0-9]$/;         // Ensure only letters or numbers are at the end of string
 
-  if (!validHK.test(value) || !startWith.test(value) || !endWith.test(value)) {
+  if (empty || !validHK.test(value) || !startWith.test(value) || !endWith.test(value)) {
     console.warn("HAP-NodeJS WARNING: The accessory '" + displayName + "' is getting published with the characteristic '" +
       name + "'" + " not following HomeKit naming rules ('" + value + "'). " +
       "Use only alphanumeric, space, and apostrophe characters, start and end with an alphabetic or numeric character, and don't include emojis. " +

src/lib/util/eventedhttp.ts

@@ -844,21 +844,42 @@ export class HAPConnection extends EventEmitter {
   }
 
   private static getLocalNetworkInterface(socket: Socket): string {
+    function formatIPv4MappedIPv6Address(address: string): string {
+      // Check if the address is an IPv4-mapped IPv6 address without the 'ffff:' part
+      if (address.startsWith("::") && !address.startsWith("::ffff:")) {
+        // Attempt to correct the format by adding 'ffff:' after '::'
+        return address.replace("::", "::ffff:");
+      }
+      return address;
+    }
+
     let localAddress = socket.localAddress as string;
 
-    if (localAddress.startsWith("::ffff:")) { // IPv4-Mapped IPv6 Address https://tools.ietf.org/html/rfc4291#section-2.5.5.2
+    localAddress = formatIPv4MappedIPv6Address(localAddress);
+
+    // Check if the address is an IPv4-Mapped IPv6 Address (e.g., ::ffff:192.0.2.128)
+    // These addresses are IPv6 addresses that represent an IPv4 address
+    // See: https://tools.ietf.org/html/rfc4291#section-2.5.5.2 for more details
+    if (localAddress.startsWith("::ffff:")) {
+      // Extract the IPv4 part from the IPv4-Mapped IPv6 address
+      // This converts the address from ::ffff:192.0.2.128 to 192.0.2.128
       localAddress = localAddress.substring(7);
     } else {
+      // For other types of addresses, such as link-local IPv6 addresses,
+      // remove the interface part (if present) to get the pure address
       const index = localAddress.indexOf("%");
-      if (index !== -1) { // link-local ipv6
+      if (index !== -1) { // If it's a link-local ipv6 address
         localAddress = localAddress.substring(0, index);
       }
     }
 
+    // Retrieve the network interfaces available on this system
     const interfaces = os.networkInterfaces();
+    // Iterate over each interface to find a match with the localAddress
     for (const [name, infos] of Object.entries(interfaces)) {
       if (infos) {
         for (const info of infos) {
+        // If the address matches, return the name of the network interface
           if (info.address === localAddress) {
             return name;
           }
@@ -883,8 +904,8 @@ export class HAPConnection extends EventEmitter {
       }
     }
 
-    console.log(`WARNING couldn't map socket coming from remote address ${socket.remoteAddress}:${socket.remotePort} \
-    at local address ${socket.localAddress} to a interface!`);
+    console.log(`WARNING couldn't map socket coming from remote address ${socket.remoteAddress}:${socket.remotePort} `
+      + `at local address ${socket.localAddress} to a interface!`);
 
     return Object.keys(interfaces)[1]; // just use the first interface after the loopback interface as fallback
   }