matterbridge 3.3.7 → 3.3.8-dev-20251115-920acfc

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';
-// Net 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.
-     * @param {string} [interfaceName] - The name of the network interface to bind to.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to.
-     * @param {string} [outgoingInterfaceAddress] - The address of the outgoing network interface.
-     */
     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.
-     * @param {string} [interfaceName] - The name of the network interface to bind to.
-     * @param {string} [interfaceAddress] - The address of the network interface to bind to.
-     * @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,20 +16,12 @@ 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.socket.bind(this.port, this.interfaceAddress, () => {
             const address = this.socket.address();
             this.log.debug(`Dgram unicast socket bound to ${BLUE}${address.family}${db} ${BLUE}${address.address}${db}:${BLUE}${address.port}${db}`);
             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);
@@ -79,13 +29,9 @@ export class Unicast extends Dgram {
         this.emit('ready', address);
         this.onReady(address);
     }
-    /**
-     * 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