matterbridge 3.4.6 → 3.4.7-dev-20260104-6b10cee

package/dist/dgram/mdnsReflectorClient.js

@@ -1,25 +1,3 @@
-/**
- * @description This file contains the class MdnsReflectorClient.
- * @file src/dgram/mdnsReflectorClient.ts
- * @author Luca Liguori
- * @created 2025-12-25
- * @version 1.1.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 import crypto from 'node:crypto';
 import { AnsiLogger, BLUE, nt, nf } from 'node-ansi-logger';
 import { getStringArrayParameter, hasParameter } from '../utils/commandLine.js';
@@ -31,7 +9,7 @@ export class MdnsReflectorClient {
     verbose = hasParameter('v') || hasParameter('verbose');
     debug = hasParameter('d') || hasParameter('debug') || hasParameter('v') || hasParameter('verbose');
     silent = hasParameter('s') || hasParameter('silent');
-    log = new AnsiLogger({ logName: 'MdnsReflectorClient', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: this.debug ? "debug" /* LogLevel.DEBUG */ : this.silent ? "notice" /* LogLevel.NOTICE */ : "info" /* LogLevel.INFO */ });
+    log = new AnsiLogger({ logName: 'MdnsReflectorClient', logTimestampFormat: 4, logLevel: this.debug ? "debug" : this.silent ? "notice" : "info" });
     mdnsIpv4 = new Mdns('mDNS udp4 Server', MDNS_MULTICAST_IPV4_ADDRESS, MDNS_MULTICAST_PORT, 'udp4', true, undefined, MDNS_REFLECTOR_BIND_ADDRESS_IPV4);
     mdnsIpv6 = new Mdns('mDNS udp6 Server', MDNS_MULTICAST_IPV6_ADDRESS, MDNS_MULTICAST_PORT, 'udp6', true, undefined, MDNS_REFLECTOR_BIND_ADDRESS_IPV6);
     unicastIpv4 = new Unicast('mDNS udp4 Reflector Client', 'udp4', false, undefined, MDNS_REFLECTOR_BIND_ADDRESS_IPV4);
@@ -39,62 +17,32 @@ export class MdnsReflectorClient {
     reflectedIpv4 = new Map();
     reflectedIpv6 = new Map();
     TTL_MS = 1500;
-    /**
-     * Creates an instance of MdnsReflectorClient.
-     * The MdnsReflectorClient must run inside a Docker container.
-     * The MdnsReflectorClient sends mDNS messages from the container to the MdnsReflectorServer running on the host machine.
-     * The MdnsReflectorClient also reflects mDNS messages from the MdnsReflectorServer to the container.
-     * Parameters:
-     * --filter <string[]> - filters to apply to incoming mDNS messages.
-     * --localhost - use localhost addresses to send messages to the container.
-     */
     constructor() {
         this.log.logNameColor = '\x1b[38;5;97m';
         this.mdnsIpv4.log.logNameColor = '\x1b[38;5;97m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.mdnsIpv4.log.logLevel = "warn" /* LogLevel.WARN */;
+            this.mdnsIpv4.log.logLevel = "warn";
         this.mdnsIpv6.log.logNameColor = '\x1b[38;5;97m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.mdnsIpv6.log.logLevel = "warn" /* LogLevel.WARN */;
+            this.mdnsIpv6.log.logLevel = "warn";
         this.unicastIpv4.log.logNameColor = '\x1b[38;5;97m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.unicastIpv4.log.logLevel = "warn" /* LogLevel.WARN */;
+            this.unicastIpv4.log.logLevel = "warn";
         this.unicastIpv6.log.logNameColor = '\x1b[38;5;97m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.unicastIpv6.log.logLevel = "warn" /* LogLevel.WARN */;
-        // Apply filters if any
+            this.unicastIpv6.log.logLevel = "warn";
         const filters = getStringArrayParameter('filter');
         if (filters)
             this.mdnsIpv4.filters.push(...filters);
         if (filters)
             this.mdnsIpv6.filters.push(...filters);
     }
-    /**
-     * Generates a fingerprint for a given buffer using SHA1 hash.
-     *
-     * @param {Buffer} buf - The buffer to generate the fingerprint for.
-     * @returns {string} The SHA1 hash of the buffer as a hexadecimal string.
-     */
     fingerprint(buf) {
         return crypto.createHash('sha1').update(buf).digest('hex');
     }
-    /**
-     * Remembers a key in the cache with a time-to-live (TTL).
-     *
-     * @param {RecentCache} cache - The cache to store the key in.
-     * @param {string} key - The key to remember.
-     * @param {number} ttlMs - The time-to-live in milliseconds.
-     */
     remember(cache, key, ttlMs) {
         cache.set(key, Date.now() + ttlMs);
     }
-    /**
-     * Checks if a key has been seen recently in the cache.
-     *
-     * @param {RecentCache} cache - The cache to check.
-     * @param {string} key - The key to check.
-     * @returns {boolean} True if the key has been seen recently, false otherwise.
-     */
     seenRecently(cache, key) {
         const exp = cache.get(key);
         if (!exp)
@@ -105,20 +53,12 @@ export class MdnsReflectorClient {
         }
         return true;
     }
-    /**
-     * Prunes expired entries from the cache and limits its size.
-     *
-     * @param {RecentCache} cache - The cache to prune.
-     */
     prune(cache) {
         const now = Date.now();
         for (const [k, exp] of cache)
             if (exp < now)
                 cache.delete(k);
     }
-    /**
-     * Starts the mDNS Reflector Client.
-     */
     async start() {
         this.log.notice('mDNS Reflector Client starting...');
         this.mdnsIpv4.on('error', (err) => {
@@ -158,7 +98,6 @@ export class MdnsReflectorClient {
                 this.log.info(`Ignoring recently reflected ${isMdnsQuery(msg) ? 'query' : 'response'} message from mDNS ipv4 multicast ${BLUE}${rinfo.address}${nf}:${BLUE}${rinfo.port}${nf}`);
                 return;
             }
-            //   if (rinfo.address === '127.0.0.1') return; // Ignore messages coming from the reflector itself
             this.log.notice(`Sending ${isMdnsQuery(msg) ? 'query' : 'response'} message from mDNS ipv4 multicast ${BLUE}${rinfo.address}${nt}:${BLUE}${rinfo.port}${nt} to ipv4 reflector server`);
             this.unicastIpv4.send(msg, MDNS_REFLECTOR_HOST_DOCKER, MDNS_REFLECTOR_PORT);
             this.unicastIpv4.send(msg, MDNS_REFLECTOR_ADDRESS, MDNS_REFLECTOR_PORT);
@@ -168,7 +107,6 @@ export class MdnsReflectorClient {
                 this.log.info(`Ignoring recently reflected ${isMdnsQuery(msg) ? 'query' : 'response'} message from mDNS ipv6 multicast ${BLUE}${rinfo.address}${nf}:${BLUE}${rinfo.port}${nf}`);
                 return;
             }
-            //   if (rinfo.address === '::1') return; // Ignore messages coming from the reflector itself
             this.log.notice(`Sending ${isMdnsQuery(msg) ? 'query' : 'response'} message from mDNS ipv6 multicast ${BLUE}${rinfo.address}${nt}:${BLUE}${rinfo.port}${nt} to ipv6 reflector server`);
             this.unicastIpv6.send(msg, MDNS_REFLECTOR_HOST_DOCKER, MDNS_REFLECTOR_PORT);
             this.unicastIpv6.send(msg, MDNS_REFLECTOR_ADDRESS, MDNS_REFLECTOR_PORT);
@@ -209,9 +147,6 @@ export class MdnsReflectorClient {
         this.unicastIpv6.send(Buffer.from('Ipv6 reflector client started'), MDNS_REFLECTOR_ADDRESS, MDNS_REFLECTOR_PORT);
         this.log.notice('mDNS Reflector Client started.');
     }
-    /**
-     * Stops the mDNS Reflector Client.
-     */
     async stop() {
         this.log.notice('mDNS Reflector Client stopping...');
         const promises = [];
@@ -239,4 +174,3 @@ export class MdnsReflectorClient {
         this.log.notice('mDNS Reflector Client stopped.');
     }
 }
-//# sourceMappingURL=mdnsReflectorClient.js.map

package/dist/dgram/mdnsReflectorServer.js

@@ -1,25 +1,3 @@
-/**
- * @description This file contains the class MdnsReflectorServer.
- * @file src/dgram/mdnsReflectorServer.ts
- * @author Luca Liguori
- * @created 2025-12-25
- * @version 1.1.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 import os from 'node:os';
 import { AnsiLogger, BLUE, nt, nf } from 'node-ansi-logger';
 import { hasParameter, getStringArrayParameter } from '../utils/commandLine.js';
@@ -31,52 +9,33 @@ export class MdnsReflectorServer {
     verbose = hasParameter('v') || hasParameter('verbose');
     debug = hasParameter('d') || hasParameter('debug') || hasParameter('v') || hasParameter('verbose');
     silent = hasParameter('s') || hasParameter('silent');
-    log = new AnsiLogger({ logName: 'MdnsReflectorServer', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: this.debug ? "debug" /* LogLevel.DEBUG */ : this.silent ? "notice" /* LogLevel.NOTICE */ : "info" /* LogLevel.INFO */ });
+    log = new AnsiLogger({ logName: 'MdnsReflectorServer', logTimestampFormat: 4, logLevel: this.debug ? "debug" : this.silent ? "notice" : "info" });
     mdnsIpv4 = new Mdns('mDNS udp4 Server', MDNS_MULTICAST_IPV4_ADDRESS, MDNS_MULTICAST_PORT, 'udp4', true, undefined, MDNS_REFLECTOR_BIND_ADDRESS_IPV4);
     mdnsIpv6 = new Mdns('mDNS udp6 Server', MDNS_MULTICAST_IPV6_ADDRESS, MDNS_MULTICAST_PORT, 'udp6', true, undefined, MDNS_REFLECTOR_BIND_ADDRESS_IPV6);
     unicastIpv4 = new Unicast('mDNS udp4 Reflector Server', 'udp4', true, undefined, MDNS_REFLECTOR_BIND_ADDRESS_IPV4, MDNS_REFLECTOR_PORT);
     unicastIpv6 = new Unicast('mDNS udp6 Reflector Server', 'udp6', true, undefined, MDNS_REFLECTOR_BIND_ADDRESS_IPV6, MDNS_REFLECTOR_PORT);
     ipv4Clients = new Map();
     ipv6Clients = new Map();
-    /**
-     * Creates an instance of MdnsReflectorServer.
-     * The MdnsReflectorServer must run on the host machine.
-     * The MdnsReflectorServer reflects mDNS messages from the lan to the Ipv4 and IPv6 reflector clients running inside Docker containers.
-     * The MdnsReflectorServer also reflects mDNS messages from the Ipv4 and IPv6 reflector clients to the lan.
-     * The MdnsReflectorServer also upgrades the A and AAAA records from the Docker environment to point to the host machine IP addresses.
-     * Parameters:
-     * --filter <string[]> - filters to apply to incoming mDNS messages.
-     * --broadcast - use broadcast addresses to reflect messages to the lan.
-     * --localhost - use localhost addresses to reflect messages to the lan.
-     * --share-with-clients - share messages between reflector clients.
-     */
     constructor() {
         this.log.logNameColor = '\x1b[38;5;115m';
         this.mdnsIpv4.log.logNameColor = '\x1b[38;5;115m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.mdnsIpv4.log.logLevel = "warn" /* LogLevel.WARN */;
+            this.mdnsIpv4.log.logLevel = "warn";
         this.mdnsIpv6.log.logNameColor = '\x1b[38;5;115m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.mdnsIpv6.log.logLevel = "warn" /* LogLevel.WARN */;
+            this.mdnsIpv6.log.logLevel = "warn";
         this.unicastIpv4.log.logNameColor = '\x1b[38;5;115m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.unicastIpv4.log.logLevel = "warn" /* LogLevel.WARN */;
+            this.unicastIpv4.log.logLevel = "warn";
         this.unicastIpv6.log.logNameColor = '\x1b[38;5;115m';
         if (!this.debug && !this.verbose && !this.silent)
-            this.unicastIpv6.log.logLevel = "warn" /* LogLevel.WARN */;
-        // Apply filters if any
+            this.unicastIpv6.log.logLevel = "warn";
         const filters = getStringArrayParameter('filter');
         if (filters)
             this.mdnsIpv4.filters.push(...filters);
         if (filters)
             this.mdnsIpv6.filters.push(...filters);
     }
-    /**
-     * Get the broadcast address for the given Mdns instance.
-     *
-     * @param {Mdns} mdns - The Mdns instance.
-     * @returns {string | undefined} The broadcast address or undefined if not found.
-     */
     getBroadcastAddress(mdns) {
         try {
             const address = mdns.socketType === 'udp4' ? mdns.getIpv4InterfaceAddress(mdns.interfaceName) : mdns.getIpv6InterfaceAddress(mdns.interfaceName);
@@ -88,18 +47,7 @@ export class MdnsReflectorServer {
             mdns.log.error(`Error getting broadcast address: ${error.message}`);
         }
     }
-    /**
-     * Decode and upgrade the A and AAAA records from Docker environment to point the host machine.
-     * Matterbridge running inside Docker Desktop containers register mDNS records with the container's IP address,
-     * which is not reachable from outside the Docker network.
-     * To make these services reachable, we need to upgrade the A and AAAA records using the host machine IP addresses.
-     * The reflector server runs on the host, while mDNS advertisements come from containers.
-     *
-     * @param {Buffer<ArrayBufferLike>} msg - The mDNS message buffer.
-     * @returns {Buffer<ArrayBufferLike>} The upgraded mDNS message buffer.
-     */
     upgradeAddress(msg) {
-        // Safety: if it's not even a DNS header, do nothing.
         if (!msg || msg.length < 12)
             return msg;
         const preferredInterfaceName = this.mdnsIpv4.interfaceName ?? this.mdnsIpv6.interfaceName;
@@ -135,7 +83,6 @@ export class MdnsReflectorServer {
         this.log.debug(`UpgradeAddress Host IPv6 for address upgrade: ${hostIpv6List.length > 0 ? hostIpv6List.join(', ') : 'N/A'}`);
         if (!hostIpv4 && hostIpv6List.length === 0)
             return msg;
-        // Copy the message so callers can safely re-use the original buffer.
         const upgradedMsg = Buffer.from(msg);
         const qdCount = upgradedMsg.readUInt16BE(4);
         const anCount = upgradedMsg.readUInt16BE(6);
@@ -143,11 +90,9 @@ export class MdnsReflectorServer {
         const arCount = upgradedMsg.readUInt16BE(10);
         let offset = 12;
         try {
-            // Skip questions
             for (let i = 0; i < qdCount; i++) {
                 const qnameResult = this.mdnsIpv4.decodeDnsName(upgradedMsg, offset);
                 offset = qnameResult.newOffset;
-                // QTYPE + QCLASS
                 offset += 4;
                 if (offset > upgradedMsg.length)
                     return msg;
@@ -163,9 +108,7 @@ export class MdnsReflectorServer {
                         return;
                     const type = upgradedMsg.readUInt16BE(offset);
                     offset += 2;
-                    // class (unused)
                     offset += 2;
-                    // ttl (unused)
                     offset += 4;
                     const rdlength = upgradedMsg.readUInt16BE(offset);
                     offset += 2;
@@ -173,10 +116,10 @@ export class MdnsReflectorServer {
                     const endOfRdata = rdataOffset + rdlength;
                     if (endOfRdata > upgradedMsg.length)
                         return;
-                    if (type === 1 /* DnsRecordType.A */ && rdlength === 4 && hostA) {
+                    if (type === 1 && rdlength === 4 && hostA) {
                         hostA.copy(upgradedMsg, rdataOffset);
                     }
-                    else if (type === 28 /* DnsRecordType.AAAA */ && rdlength === 16 && hostAAAAs.length > 0) {
+                    else if (type === 28 && rdlength === 16 && hostAAAAs.length > 0) {
                         const hostAAAA = hostAAAAs[Math.min(hostAAAAIndex, hostAAAAs.length - 1)];
                         hostAAAA.copy(upgradedMsg, rdataOffset);
                         hostAAAAIndex++;
@@ -184,7 +127,6 @@ export class MdnsReflectorServer {
                     offset = endOfRdata;
                 }
             };
-            // Walk RR sections and patch A/AAAA in-place.
             upgradeResourceRecords(anCount);
             upgradeResourceRecords(nsCount);
             upgradeResourceRecords(arCount);
@@ -207,9 +149,6 @@ export class MdnsReflectorServer {
         }
         return upgradedMsg;
     }
-    /**
-     * Starts the mDNS Reflector Server.
-     */
     async start() {
         this.log.notice('mDNS Reflector Server starting...');
         this.mdnsIpv4.on('error', (err) => {
@@ -324,9 +263,6 @@ export class MdnsReflectorServer {
         });
         this.log.notice('mDNS Reflector Server started.');
     }
-    /**
-     * Stops the mDNS Reflector Server.
-     */
     async stop() {
         this.log.notice('mDNS Reflector Server stopping...');
         for (const client of this.ipv4Clients.values()) {
@@ -337,7 +273,7 @@ export class MdnsReflectorServer {
             this.log.debug(`Notifying ipv6 client ${client.address}:${client.port} about server stopping`);
             this.unicastIpv6.send(Buffer.from('mDNS Reflector Server is stopping'), client.address, client.port);
         }
-        await new Promise((resolve) => setTimeout(resolve, 100)); // Wait a bit to allow messages to be sent
+        await new Promise((resolve) => setTimeout(resolve, 100));
         const promises = [];
         promises[0] = new Promise((resolve) => {
             this.mdnsIpv4.once('close', () => resolve());
@@ -363,4 +299,3 @@ export class MdnsReflectorServer {
         this.log.notice('mDNS Reflector Server stopped.');
     }
 }
-//# sourceMappingURL=mdnsReflectorServer.js.map

package/dist/dgram/mdnsReflectorTypes.js

@@ -1,28 +1,5 @@
-/**
- * @description This file contains the definitions for the mDNS reflector classes.
- * @file src/dgram/mdnsReflectorTypes.ts
- * @author Luca Liguori
- * @created 2025-12-25
- * @version 1.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 export const MDNS_REFLECTOR_BIND_ADDRESS_IPV4 = '0.0.0.0';
 export const MDNS_REFLECTOR_BIND_ADDRESS_IPV6 = '::';
-export const MDNS_REFLECTOR_ADDRESS = 'localhost'; // Use 'localhost' to support both IPv4 and IPv6 and to avoid issues in Docker with EPERM
+export const MDNS_REFLECTOR_ADDRESS = 'localhost';
 export const MDNS_REFLECTOR_HOST_DOCKER = 'host.docker.internal';
 export const MDNS_REFLECTOR_PORT = 15353;
-//# sourceMappingURL=mdnsReflectorTypes.js.map

package/dist/dgram/multicast.js

@@ -1,29 +1,5 @@
-/**
- * @description This file contains the class Multicast.
- * @file multicast.ts
- * @author Luca Liguori
- * @created 2025-03-22
- * @version 1.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 import os from 'node:os';
-// AnsiLogger imports
 import { BLUE, CYAN, db, RED, YELLOW } from 'node-ansi-logger';
-// Dgram imports
 import { Dgram } from './dgram.js';
 export const MDNS_MULTICAST_IPV4_ADDRESS = '224.0.0.251';
 export const MDNS_MULTICAST_IPV6_ADDRESS = 'ff02::fb';
@@ -31,37 +7,18 @@ export const MDNS_MULTICAST_PORT = 5353;
 export const COAP_MULTICAST_IPV4_ADDRESS = '224.0.1.187';
 export const COAP_MULTICAST_IPV6_ADDRESS = 'ff02::fd';
 export const COAP_MULTICAST_PORT = 5683;
-/**
- * This class implements a multicast dgram socket.
- */
 export class Multicast extends Dgram {
     multicastAddress;
     multicastPort;
     outgoingInterfaceAddress;
     joinedInterfaces = [];
-    /**
-     * Creates an instance of Multicast.
-     *
-     * @param {string} name - The name of the socket.
-     * @param {string} multicastAddress - The multicast address to join.
-     * @param {number} multicastPort - The port number to bind to.
-     * @param {'udp4' | 'udp6'} socketType - The type of the socket (IPv4 or IPv6).
-     * @param {boolean | undefined} reuseAddr - Whether to allow address reuse. Defaults to true.
-     * @param {string} [interfaceName] - The name of the network interface to bind to. If provided, the interfaceAddress will be determined based on this name if not explicitly provided.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to. If not provided, it will be determined based on the interfaceName.
-     * @param {string} [outgoingInterfaceAddress] - The address of the outgoing network interface. If not provided, it will use the interfaceAddress.
-     */
     constructor(name, multicastAddress, multicastPort, socketType, reuseAddr = true, interfaceName, interfaceAddress, outgoingInterfaceAddress) {
         super(name, socketType, reuseAddr, interfaceName, interfaceAddress);
         this.multicastAddress = multicastAddress;
         this.multicastPort = multicastPort;
         this.outgoingInterfaceAddress = outgoingInterfaceAddress;
     }
-    /**
-     * Starts the dgram multicast socket.
-     */
     start() {
-        // Get the local ipv4 or ipv6 address to bind to.
         if (this.socketType === 'udp4') {
             this.log.debug(`Starting ipv4 dgram multicast socket...`);
             this.interfaceAddress = this.interfaceAddress ?? this.getIpv4InterfaceAddress(this.interfaceName);
@@ -77,11 +34,6 @@ export class Multicast extends Dgram {
             this.emit('bound', address);
         });
     }
-    /**
-     * Event handler for the 'listening' event. This event is emitted when the socket starts listening for datagram messages.
-     *
-     * @param {AddressInfo} [address] - The address info.
-     */
     onListening(address) {
         this.log.debug(`Dgram multicast socket listening on ${BLUE}${address.family}${db} ${BLUE}${address.address}${db}:${BLUE}${address.port}${db}`);
         this.socket.setBroadcast(true);
@@ -92,46 +44,39 @@ export class Multicast extends Dgram {
         this.log.debug(`Dgram multicast socket multicast TTL set to 255`);
         this.socket.setMulticastLoopback(true);
         this.log.debug(`Dgram multicast socket multicast loopback enabled`);
-        // Find the correct network interfaces and join the multicast group on each interface. For IPv6, we will use the scope ID if available. If not available, we will use the Unique Local Address.
         Object.entries(os.networkInterfaces()).forEach(([name, interfaces]) => {
             this.log.debug(`Dgram multicast socket processing interface ${CYAN}${name}${db}`);
             if (!interfaces)
                 return;
             if (this.interfaceName && name !== this.interfaceName)
-                return; // Only process the specified interface
+                return;
             let iface;
             let membershipInterface;
-            // Find the first ipv4 interface
             const ifaceIpv4 = interfaces.find((iface) => iface.family === 'IPv4' && this.socketType === 'udp4');
             if (ifaceIpv4) {
                 iface = ifaceIpv4;
                 membershipInterface = ifaceIpv4.address;
             }
-            // Find the first IPv6 Address
             const ifaceIpv6 = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6');
             if (ifaceIpv6) {
                 iface = ifaceIpv6;
                 membershipInterface = ifaceIpv6.address + (ifaceIpv6.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceIpv6.scopeid) : '%' + name) : '');
             }
-            // Find the first Unique Local Address (ULA) IPv6
             const ifaceUla = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6' && iface.address.startsWith('fd'));
             if (ifaceUla) {
                 iface = ifaceUla;
                 membershipInterface = ifaceUla.address + (ifaceUla.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceUla.scopeid) : '%' + name) : '');
             }
-            // Find the first Unique Local Address (ULA) IPv6 with prefix length /64 (netmask ffff:ffff:ffff:ffff::)
             const ifaceUla64 = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6' && iface.address.startsWith('fd') && iface.netmask === 'ffff:ffff:ffff:ffff::');
             if (ifaceUla64) {
                 iface = ifaceUla64;
                 membershipInterface = ifaceUla64.address + (ifaceUla64.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceUla64.scopeid) : '%' + name) : '');
             }
-            // Find the first Link-local IPv6 Address
             const ifaceLinkLocal = interfaces.find((iface) => iface.family === 'IPv6' && this.socketType === 'udp6' && iface.address.startsWith('fe80'));
             if (ifaceLinkLocal) {
                 iface = ifaceLinkLocal;
                 membershipInterface = ifaceLinkLocal.address + (ifaceLinkLocal.scopeid !== undefined ? (process.platform === 'win32' ? '%' + String(ifaceLinkLocal.scopeid) : '%' + name) : '');
             }
-            // Add the interface address to the multicast group
             if (iface && membershipInterface) {
                 try {
                     this.socket.addMembership(this.multicastAddress, membershipInterface);
@@ -144,11 +89,9 @@ export class Multicast extends Dgram {
             }
         });
         let interfaceAddress = this.outgoingInterfaceAddress || this.interfaceAddress;
-        // If the interfaceAddress is 0.0.0.0, we need to set the default outgoing multicast interface to the first found IPv4 address.
         if (!this.outgoingInterfaceAddress && this.socketType === 'udp4' && this.interfaceAddress === '0.0.0.0') {
             interfaceAddress = this.getIpv4InterfaceAddress(this.interfaceName);
         }
-        // If the interfaceAddress is '::', we need to set the default outgoing multicast interface to '::' + the scope ID.
         if (!this.outgoingInterfaceAddress && this.socketType === 'udp6' && this.interfaceAddress === '::') {
             interfaceAddress = '::' + this.getIpv6ScopeId(this.interfaceName);
         }
@@ -157,9 +100,6 @@ export class Multicast extends Dgram {
         this.log.debug(`Dgram multicast socket multicastInterface set to ${BLUE}${interfaceAddress}${db}`);
         this.emit('ready', address);
     }
-    /**
-     * Stops the dgram multicast socket.
-     */
     stop() {
         this.log.debug('Stopping dgram multicast socket...');
         this.joinedInterfaces.forEach((membershipInterface) => {
@@ -176,4 +116,3 @@ export class Multicast extends Dgram {
         this.log.debug('Stopped dgram multicast socket.');
     }
 }
-//# sourceMappingURL=multicast.js.map

package/dist/dgram/unicast.js

@@ -1,54 +1,12 @@
-/**
- * @description This file contains the class Unicast.
- * @file unicast.ts
- * @author Luca Liguori
- * @created 2025-03-22
- * @version 1.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-// AnsiLogger imports
 import { BLUE, db } from 'node-ansi-logger';
-// Net imports
 import { Dgram } from './dgram.js';
-/**
- * This class implements a unicast dgram socket.
- */
 export class Unicast extends Dgram {
     port;
-    /**
-     * Creates an instance of Unicast.
-     *
-     * @param {string} name - The name of the socket.
-     * @param {'udp4' | 'udp6'} socketType - The type of the socket (IPv4 or IPv6).
-     * @param {boolean | undefined} reuseAddr - Whether to allow address reuse. Defaults to true.
-     * @param {string} [interfaceName] - The name of the network interface to bind to. If provided, the interfaceAddress will be determined based on this name if not explicitly provided.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to. If not provided, it will be determined based on the interfaceName.
-     * @param {number} [port] - The port number to bind to. If not provided, it will bind to any available port.
-     */
     constructor(name, socketType, reuseAddr = true, interfaceName, interfaceAddress, port) {
         super(name, socketType, reuseAddr, interfaceName, interfaceAddress);
         this.port = port;
     }
-    /**
-     * Starts the dgram unicast socket.
-     */
     start() {
-        // Get the local ipv4 or ipv6 interfaceAddress to bind to. If not provided and interfaceName has been provided, use the first one found.
-        // If neither interfaceAddress nor interfaceName is provided, use undefined to bind to any available address. In this case broadcast will not work.
         if (this.socketType === 'udp4') {
             this.log.debug(`Starting ipv4 dgram unicast socket...`);
             this.interfaceAddress = this.interfaceAddress ?? (this.interfaceName ? this.getIpv4InterfaceAddress(this.interfaceName) : undefined);
@@ -58,9 +16,6 @@ export class Unicast extends Dgram {
             this.interfaceAddress = this.interfaceAddress ?? (this.interfaceName ? this.getIpv6InterfaceAddress(this.interfaceName) : undefined);
         }
         this.interfaceNetmask = this.interfaceAddress ? this.getNetmask(this.interfaceAddress) : undefined;
-        // Bind to the local address and port:
-        // port 0 or undefined means "assign any available port"
-        // address 0.0.0.0 or :: means "bind to all available addresses"
         this.log.debug(`Binding dgram unicast socket to ${BLUE}${this.interfaceAddress || 'all available addresses'}${db} on port ${BLUE}${this.port || 'any available port'}${db}...`);
         this.socket.bind(this.port, this.interfaceAddress, () => {
             const address = this.socket.address();
@@ -68,33 +23,18 @@ export class Unicast extends Dgram {
             this.emit('bound', address);
         });
     }
-    /**
-     * Event handler for the 'listening' event. This event is emitted when the socket starts listening for datagram messages.
-     *
-     * @param {AddressInfo} [address] - The address info.
-     */
     onListening(address) {
         this.log.debug(`Dgram unicast socket listening on ${BLUE}${address.family}${db} ${BLUE}${address.address}${db}:${BLUE}${address.port}${db}`);
         this.socket.setBroadcast(true);
         this.log.debug(`Dgram unicast socket broadcast enabled`);
         this.emit('ready', address);
     }
-    /**
-     * Event handler for the 'message' event. This event is emitted when a datagram message is received.
-     *
-     * @param {Buffer} msg - The message buffer.
-     * @param {RemoteInfo} rinfo - The remote info.
-     */
     onMessage(msg, rinfo) {
         this.log.debug(`Socket received a message from ${BLUE}${rinfo.family}${db} ${BLUE}${rinfo.address}${db}:${BLUE}${rinfo.port}${db}`);
     }
-    /**
-     * Stops the dgram unicast socket.
-     */
     stop() {
         this.log.debug('Stopping dgram unicast socket...');
         this.socket.close();
         this.log.debug('Stopped dgram unicast socket.');
     }
 }
-//# sourceMappingURL=unicast.js.map