matterbridge 3.4.7-dev-20260112-bd9e311 → 3.4.7

package/packages/dgram/dist/dgram.js

@@ -1,8 +1,35 @@
+/**
+ * @description This file contains the class Dgram.
+ * @file dgram.ts
+ * @author Luca Liguori
+ * @created 2025-03-22
+ * @version 1.0.3
+ * @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.
+ */
+// Node.js imports
 import dgram from 'node:dgram';
 import EventEmitter from 'node:events';
 import os from 'node:os';
+// AnsiLogger imports
 import { AnsiLogger, BLUE, db, idn, nf, rs } from 'node-ansi-logger';
 import { hasParameter } from '@matterbridge/utils';
+/**
+ * This class implements a dgram socket.
+ */
 export class Dgram extends EventEmitter {
     verbose = hasParameter('v') || hasParameter('verbose');
     debug = hasParameter('d') || hasParameter('debug') || hasParameter('v') || hasParameter('verbose');
@@ -15,12 +42,21 @@ export class Dgram extends EventEmitter {
     interfaceAddress;
     interfaceNetmask;
     excludedInterfaceNamePattern = /(tailscale|wireguard|wintun|openvpn|\bwg\d*\b|\btun\d*\b|\btap\d*\b|\butun\d*\b|zerotier|hamachi|hyper-?v|v\s*ethernet|wsl|default switch|vmware|vmnet|vbox|virtualbox|virbr|docker|podman|\bveth\b|\bbr-\b|cni|kube|flannel|calico|teredo|isatap)/i;
+    /**
+     * Creates an instance of Dgram.
+     *
+     * @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.
+     * @param {string} [interfaceAddress] - The address of the network interface to bind to.
+     */
     constructor(name, socketType, reuseAddr = true, interfaceName, interfaceAddress) {
         super();
         this.log = new AnsiLogger({
             logName: name,
-            logTimestampFormat: 4,
-            logLevel: this.debug ? "debug" : this.silent ? "notice" : "info",
+            logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */,
+            logLevel: this.debug ? "debug" /* LogLevel.DEBUG */ : this.silent ? "notice" /* LogLevel.NOTICE */ : "info" /* LogLevel.INFO */,
         });
         this.socket = dgram.createSocket({ type: socketType, reuseAddr });
         this.socketType = socketType;
@@ -56,6 +92,13 @@ export class Dgram extends EventEmitter {
             this.onListening(address);
         });
     }
+    /**
+     * Sends a message to the specified server.
+     *
+     * @param {Buffer} msg - The message buffer to send.
+     * @param {string} serverAddress - The IPv4 address of the destination server.
+     * @param {number} serverPort - The port of the destination server.
+     */
     send(msg, serverAddress, serverPort) {
         this.socket.send(msg, 0, msg.length, serverPort, serverAddress, (error) => {
             if (error) {
@@ -93,20 +136,32 @@ export class Dgram extends EventEmitter {
         this.log.info(`Socket ready on ${BLUE}${address.family}${nf} ${BLUE}${address.address}${nf}:${BLUE}${address.port}${nf}`);
         this.emit('ready', address);
     }
+    /**
+     * Retrieves the IPv4 address of the specified network interface or the first external IPv4 interface if no interface is specified.
+     * Throws an error if no suitable interface or address is found.
+     *
+     * @param {string} networkInterface - The name of the network interface to retrieve the IPv4 address from. If not specified, the first external IPv4 interface will be used.
+     * @returns {string | undefined} The IPv4 address of the specified network interface or the first external IPv4 interface.
+     * @throws {Error} if no suitable interface or address is found.
+     */
     getIpv4InterfaceAddress(networkInterface) {
+        // Normalize the interface name: treat an empty string as undefined.
         if (networkInterface === '')
             networkInterface = undefined;
         const interfaces = os.networkInterfaces();
+        // If a specific interface is provided but not found, warn and fall back.
         if (networkInterface && !interfaces[networkInterface]) {
             this.log.warn(`Interface "${networkInterface}" not found. Using first external IPv4 interface.`);
             networkInterface = undefined;
         }
+        // If no interface was specified or the provided one doesn't exist, find the first external IPv4 interface.
         if (!networkInterface) {
             for (const [interfaceName, interfaceDetails] of Object.entries(interfaces)) {
                 if (!networkInterface && this.excludedInterfaceNamePattern.test(interfaceName))
                     continue;
                 if (!interfaceDetails)
                     continue;
+                // Check if at least one external IPv4 address exists on this interface.
                 for (const detail of interfaceDetails) {
                     if (detail.family === 'IPv4' && !detail.internal) {
                         networkInterface = interfaceName;
@@ -120,6 +175,7 @@ export class Dgram extends EventEmitter {
         if (!networkInterface) {
             throw new Error(`Didn't find an external IPv4 network interface`);
         }
+        // Select the first external IPv4 address from the interface.
         const addresses = interfaces[networkInterface];
         const ipv4Address = addresses?.find((addr) => addr.family === 'IPv4' && !addr.internal);
         if (!ipv4Address) {
@@ -127,14 +183,25 @@ export class Dgram extends EventEmitter {
         }
         return ipv4Address.address;
     }
+    /**
+     * Retrieves the IPv6 address of the specified network interface or the first external IPv6 interface if no interface is specified.
+     * Throws an error if no suitable interface or address is found.
+     *
+     * @param {string} [networkInterface] - The name of the network interface to retrieve the IPv6 address from. If not specified, the first external IPv6 interface will be used.
+     * @returns {string | undefined} The IPv6 address of the specified network interface or the first external IPv6 interface.
+     * @throws {Error} If no suitable interface or address is found.
+     */
     getIpv6InterfaceAddress(networkInterface) {
+        // Normalize the interface name: treat an empty string as undefined.
         if (networkInterface === '')
             networkInterface = undefined;
         const interfaces = os.networkInterfaces();
+        // If a specific interface is provided, verify it exists. Otherwise, warn and use the first external IPv6 interface.
         if (networkInterface && !interfaces[networkInterface]) {
             this.log.warn(`Interface "${networkInterface}" not found. Using first external IPv6 interface.`);
             networkInterface = undefined;
         }
+        // If no network interface was specified, search for the first external IPv6 interface.
         if (!networkInterface) {
             for (const [interfaceName, interfaceDetails] of Object.entries(interfaces)) {
                 if (!networkInterface && this.excludedInterfaceNamePattern.test(interfaceName))
@@ -155,18 +222,21 @@ export class Dgram extends EventEmitter {
             throw new Error(`Didn't find an external IPv6 network interface`);
         }
         const addresses = interfaces[networkInterface];
+        // Try to find a link-local address and use scopeid
         const linkLocalAddress = addresses?.find((addr) => addr.family === 'IPv6' && !addr.internal && addr.address.startsWith('fe80'));
         if (linkLocalAddress) {
             this.log.debug('Found IPv6 link-local address');
             return linkLocalAddress.scopeid ? `${linkLocalAddress.address}%${process.platform !== 'win32' ? networkInterface : linkLocalAddress.scopeid}` : linkLocalAddress.address;
         }
         this.log.debug('No IPv6 link-local address found');
+        // Try to find a unique local address
         const ulaAddress = addresses?.find((addr) => addr.family === 'IPv6' && !addr.internal && addr.address.startsWith('fd') && addr.netmask === 'ffff:ffff:ffff:ffff::');
         if (ulaAddress) {
             this.log.debug('Found IPv6 Unique Local Addresses (ULA) unicast address');
             return ulaAddress.address;
         }
         this.log.debug('No IPv6 Unique Local Addresses (ULA) unicast address found');
+        // Try to find a unique local address
         const uniqueLocalAddress = addresses?.find((addr) => addr.family === 'IPv6' && !addr.internal && addr.address.startsWith('fd'));
         if (uniqueLocalAddress) {
             this.log.debug('Found IPv6 Unique Local Addresses (ULA) address');
@@ -175,6 +245,11 @@ export class Dgram extends EventEmitter {
         this.log.debug('No IPv6 Unique Local Addresses (ULA) address found');
         throw new Error(`Interface ${networkInterface} does not have a suitable external IPv6 address`);
     }
+    /**
+     * Retrieves the names of all available network interfaces.
+     *
+     * @returns {string[]} An array of network interface names.
+     */
     getInterfacesNames() {
         const interfaces = os.networkInterfaces();
         const interfaceNames = [];
@@ -185,6 +260,12 @@ export class Dgram extends EventEmitter {
         }
         return interfaceNames;
     }
+    /**
+     *  Retrieves the scope ID of the first found IPv6 address on the specified network interface or on any interface if none is specified.
+     *
+     * @param {string} [interfaceName] - The name of the network interface. If not provided, the first found IPv6 address will be used.
+     * @returns {string} The scope ID of the first found IPv6 address or an empty string.
+     */
     getIpv6ScopeId(interfaceName) {
         const interfaces = os.networkInterfaces();
         for (const name in interfaces) {
@@ -196,17 +277,24 @@ export class Dgram extends EventEmitter {
             if (iface) {
                 const ipv6Address = iface.find((addr) => addr.family === 'IPv6' && !addr.internal && addr.scopeid);
                 if (ipv6Address) {
-                    return process.platform === 'win32' ? '%' + String(ipv6Address.scopeid) : '%' + name;
+                    return process.platform === 'win32' ? '%' + String(ipv6Address.scopeid) : '%' + name; // Use the scope ID for Windows, or the interface name for non-Windows platforms
                 }
             }
         }
         return '';
     }
+    /**
+     * Retrieves the interface name from the scope id of an IPv6 address.
+     *
+     * @param {number} scopeId - The scope id of the IPv6 address.
+     * @returns {string | undefined} The interface name or undefined if not found.
+     */
     getInterfaceNameFromScopeId(scopeId) {
         const nets = os.networkInterfaces();
         for (const ifaceName in nets) {
             const addresses = nets[ifaceName] || [];
             for (const addr of addresses) {
+                // Check for IPv6 addresses with a matching scope id.
                 if (addr.family === 'IPv6' && addr.scopeid === scopeId) {
                     return ifaceName;
                 }
@@ -214,8 +302,16 @@ export class Dgram extends EventEmitter {
         }
         return undefined;
     }
+    /**
+     * Retrieves the netmask of the specified interface address.
+     *
+     * @param {string} interfaceAddress - The interface address for which to retrieve the netmask.
+     * @returns {string | undefined} The netmask of the specified interface address or undefined if not found.
+     */
     getNetmask(interfaceAddress) {
+        // Remove zone index if present (e.g. for IPv6 "fe80::1%eth0")
         const noZoneAddress = interfaceAddress.includes('%') ? interfaceAddress.split('%')[0] : interfaceAddress;
+        // Iterate over all interfaces.
         const nets = os.networkInterfaces();
         for (const ifaceName in nets) {
             const ifaceAddresses = nets[ifaceName];
@@ -229,6 +325,13 @@ export class Dgram extends EventEmitter {
         }
         return undefined;
     }
+    /**
+     * Computes the broadcast address given an IPv4 address and netmask.
+     *
+     * @param {string | undefined} [ipAddress] - The IPv4 address e.g. "192.168.1.20"
+     * @param {string | undefined} [netmask] - The IPv4 netmask e.g. "255.255.255.0"
+     * @returns {string | undefined} The computed broadcast address, e.g. "192.168.1.255"
+     */
     getIpv4BroadcastAddress(ipAddress, netmask) {
         if (!ipAddress || !netmask) {
             return undefined;
@@ -238,9 +341,17 @@ export class Dgram extends EventEmitter {
         const broadcastParts = ipParts.map((octet, i) => (octet & maskParts[i]) | (255 - maskParts[i]));
         return broadcastParts.join('.');
     }
+    /**
+     * Returns the broadcast IPv6 address.
+     *
+     * @returns {string} The broadcast IPv6 address, e.g. "ff02::1"
+     */
     getIpv6BroadcastAddress() {
         return 'ff02::1';
     }
+    /**
+     * Logs all available network interfaces and their details.
+     */
     listNetworkInterfaces() {
         const interfaces = os.networkInterfaces();
         for (const [name, addresses] of Object.entries(interfaces)) {
@@ -253,3 +364,4 @@ export class Dgram extends EventEmitter {
         }
     }
 }
+//# sourceMappingURL=dgram.js.map

package/packages/dgram/dist/dgram.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dgram.js","sourceRoot":"","sources":["../src/dgram.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,kBAAkB;AAClB,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,YAAY,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB,qBAAqB;AACrB,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAY,EAAE,EAAE,EAAE,EAAmB,MAAM,kBAAkB,CAAC;AAChG,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAgBnD;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,YAAyB;IAClD,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACvD,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACnG,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;IACrD,GAAG,CAAa;IAChB,MAAM,CAAe;IACrB,KAAK,GAAG,KAAK,CAAC;IACd,UAAU,CAAkB;IAC5B,aAAa,CAAU;IACvB,gBAAgB,CAAU;IAC1B,gBAAgB,CAAU;IAC1B,4BAA4B,GAC1B,qPAAqP,CAAC;IAExP;;;;;;;;OAQG;IACH,YAAY,IAAY,EAAE,UAA2B,EAAE,YAAiC,IAAI,EAAE,aAAsB,EAAE,gBAAyB;QAC7I,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC;YACxB,OAAO,EAAE,IAAI;YACb,kBAAkB,qCAA6B;YAC/C,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,8BAAgB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,gCAAiB,CAAC,2BAAc;SACtF,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,0BAA0B,IAAI,GAAG,UAAU,GAAG,EAAE,iBAAiB,IAAI,GAAG,aAAa,IAAI,KAAK,GAAG,EAAE,iBAAiB,IAAI,GAAG,gBAAgB,IAAI,KAAK,GAAG,EAAE,cAAc,IAAI,GAAG,SAAS,GAAG,EAAE,EAAE,CAC/L,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YAClF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACnB,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAC7B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACrB,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;YACpI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAC/B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACtC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;YAC/H,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,GAAW,EAAE,aAAqB,EAAE,UAAkB;QACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC,KAAmB,EAAE,EAAE;YACtF,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;gBACrG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC1B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,IAAI,GAAG,aAAa,GAAG,EAAE,IAAI,IAAI,GAAG,UAAU,GAAG,EAAE,EAAE,CAAC,CAAC;gBAClG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;gBAClD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,KAAY;QAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,OAAO;QACL,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACjC,CAAC;IAED,SAAS;QACP,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,GAAW,EAAE,aAAqB,EAAE,UAAkB;QAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,IAAI,GAAG,aAAa,GAAG,EAAE,IAAI,IAAI,GAAG,UAAU,GAAG,EAAE,EAAE,CAAC,CAAC;IACnG,CAAC;IAED,SAAS,CAAC,GAAW,EAAE,KAAuB;QAC5C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kCAAkC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;IACrI,CAAC;IAED,WAAW,CAAC,OAAoB;QAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;QAC9H,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,OAAoB;QAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;QAC1H,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,uBAAuB,CAAC,gBAAyB;QAC/C,oEAAoE;QACpE,IAAI,gBAAgB,KAAK,EAAE;YAAE,gBAAgB,GAAG,SAAS,CAAC;QAE1D,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QAE1C,yEAAyE;QACzE,IAAI,gBAAgB,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,gBAAgB,mDAAmD,CAAC,CAAC;YACjG,gBAAgB,GAAG,SAAS,CAAC;QAC/B,CAAC;QAED,2GAA2G;QAC3G,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3E,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC;oBAAE,SAAS;gBACzF,IAAI,CAAC,gBAAgB;oBAAE,SAAS;gBAChC,wEAAwE;gBACxE,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;oBACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;wBACjD,gBAAgB,GAAG,aAAa,CAAC;wBACjC,MAAM;oBACR,CAAC;gBACH,CAAC;gBACD,IAAI,gBAAgB;oBAAE,MAAM;YAC9B,CAAC;QACH,CAAC;QACD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QAED,6DAA6D;QAC7D,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,aAAa,gBAAgB,yCAAyC,CAAC,CAAC;QAC1F,CAAC;QAED,OAAO,WAAW,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACH,uBAAuB,CAAC,gBAAyB;QAC/C,oEAAoE;QACpE,IAAI,gBAAgB,KAAK,EAAE;YAAE,gBAAgB,GAAG,SAAS,CAAC;QAE1D,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QAE1C,oHAAoH;QACpH,IAAI,gBAAgB,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,gBAAgB,mDAAmD,CAAC,CAAC;YACjG,gBAAgB,GAAG,SAAS,CAAC;QAC/B,CAAC;QAED,uFAAuF;QACvF,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3E,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC;oBAAE,SAAS;gBACzF,IAAI,CAAC,gBAAgB;oBAAE,SAAS;gBAChC,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;oBACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;wBACjD,gBAAgB,GAAG,aAAa,CAAC;wBACjC,MAAM;oBACR,CAAC;gBACH,CAAC;gBACD,IAAI,gBAAgB;oBAAE,MAAM;YAC9B,CAAC;QACH,CAAC;QACD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAE/C,mDAAmD;QACnD,MAAM,gBAAgB,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAChI,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;YAChD,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC;QAC3K,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAEnD,qCAAqC;QACrC,MAAM,UAAU,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,uBAAuB,CAAC,CAAC;QACpK,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;YAC1E,OAAO,UAAU,CAAC,OAAO,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAE7E,qCAAqC;QACrC,MAAM,kBAAkB,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAChI,IAAI,kBAAkB,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAC;YAClE,OAAO,kBAAkB,CAAC,OAAO,CAAC;QACpC,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;QAErE,MAAM,IAAI,KAAK,CAAC,aAAa,gBAAgB,iDAAiD,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,kBAAkB;QAChB,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QAC1C,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;YAC9B,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,aAAsB;QACnC,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;YAC9B,IAAI,aAAa,IAAI,IAAI,KAAK,aAAa;gBAAE,SAAS;YACtD,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC;gBAAE,SAAS;YAC7E,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAC/B,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;gBACnG,IAAI,WAAW,EAAE,CAAC;oBAChB,OAAO,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,gFAAgF;gBACxK,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACH,2BAA2B,CAAC,OAAe;QACzC,MAAM,IAAI,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QACpC,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YACxC,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;gBAC7B,qDAAqD;gBACrD,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;oBACvD,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,gBAAwB;QACjC,8DAA8D;QAC9D,MAAM,aAAa,GAAG,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAEzG,+BAA+B;QAC/B,MAAM,IAAI,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QACpC,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YACvC,IAAI,CAAC,cAAc;gBAAE,SAAS;YAC9B,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;gBAClC,IAAI,IAAI,CAAC,OAAO,KAAK,aAAa,EAAE,CAAC;oBACnC,OAAO,IAAI,CAAC,OAAO,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,SAA6B,EAAE,OAA2B;QAChF,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC;YAC3B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChG,OAAO,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,uBAAuB;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;QAC1C,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,SAAS;gBAAE,SAAS;YACzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;YACrD,KAAK,MAAM,OAAO,IAAI,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,aAAa,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,EAAE,YAAY,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,EAAE,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,EAAE,EAAE,CAC5V,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/packages/dgram/dist/export.d.ts

@@ -3,3 +3,4 @@ export * from './multicast.js';
 export * from './unicast.js';
 export * from './mdns.js';
 export * from './coap.js';
+//# sourceMappingURL=export.d.ts.map

package/packages/dgram/dist/export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../src/export.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}

package/packages/dgram/dist/export.js

@@ -3,3 +3,4 @@ export * from './multicast.js';
 export * from './unicast.js';
 export * from './mdns.js';
 export * from './coap.js';
+//# sourceMappingURL=export.js.map

package/packages/dgram/dist/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../src/export.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}

package/packages/dgram/dist/mdns.d.ts

@@ -1,3 +1,25 @@
+/**
+ * @description This file contains the class Mdns.
+ * @file mdns.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 dgram from 'node:dgram';
 import { AnsiLogger } from 'node-ansi-logger';
 import { Multicast } from './multicast.js';
@@ -94,13 +116,13 @@ export declare const enum DnsRecordType {
     DLV = 32769
 }
 export declare const enum DnsClass {
-    IN = 1,
-    CH = 3,
-    HS = 4,
+    IN = 1,// Internet
+    CH = 3,// Chaos
+    HS = 4,// Hesiod
     ANY = 255
 }
 export declare const enum DnsClassFlag {
-    FLUSH = 32768,
+    FLUSH = 32768,// For answers (resource records)
     QU = 32768
 }
 export interface MdnsMessage {
@@ -134,8 +156,26 @@ interface MdnsRecord {
     ttl: number;
     data: string;
 }
+/**
+ * Checks if a given message is an mDNS message.
+ *
+ * @param {Buffer} message - The message buffer to check.
+ * @returns {boolean} True if the message is an mDNS message, false otherwise.
+ */
 export declare function isMdns(message: Buffer): boolean;
+/**
+ * Checks if a given mDNS message is a query.
+ *
+ * @param {Buffer} message - The mDNS message buffer to check.
+ * @returns {boolean} True if the message is a query, false otherwise.
+ */
 export declare function isMdnsQuery(message: Buffer): boolean;
+/**
+ * Checks if a given mDNS message is a query.
+ *
+ * @param {Buffer} message - The mDNS message buffer to check.
+ * @returns {boolean} True if the message is a query, false otherwise.
+ */
 export declare function isMdnsResponse(message: Buffer): boolean;
 export declare class Mdns extends Multicast {
     deviceQueries: Map<string, {
@@ -148,30 +188,143 @@ export declare class Mdns extends Multicast {
         dataPTR?: string;
     }>;
     filters: string[];
+    /**
+     * Creates an instance of the Mdns class.
+     *
+     * @param {string} name - The internal name of the mDNS server for the logs.
+     * @param {string} multicastAddress - The multicast address for mDNS (i.e. 224.0.0.251 for udp4 or ff02::fb for udp6).
+     * @param {number} multicastPort - The port for mDNS (i.e. 5353).
+     * @param {('udp4' | 'udp6')} socketType - The type of socket to create (either 'udp4' or 'udp6').
+     * @param {boolean} [reuseAddr] - Whether to reuse the address. Defaults to true.
+     * @param {string} [interfaceName] - The optional name of the network interface to use.
+     * @param {string} [interfaceAddress] - The optional IP address of the network interface to use.
+     * @param {string} [outgoingInterfaceAddress] - The address of the outgoing network interface.
+     */
     constructor(name: string, multicastAddress: string, multicastPort: number, socketType: 'udp4' | 'udp6', reuseAddr?: boolean | undefined, interfaceName?: string, interfaceAddress?: string, outgoingInterfaceAddress?: string);
     onQuery(rinfo: dgram.RemoteInfo, _query: MdnsMessage): void;
     onResponse(rinfo: dgram.RemoteInfo, _response: MdnsMessage): void;
     onMessage(msg: Buffer, rinfo: dgram.RemoteInfo): void;
+    /**
+     * Decodes an mDNS message, including the header, question section, answer section,
+     * authority section, and additional section.
+     *
+     * @param {Buffer} msg - The raw mDNS message buffer.
+     * @returns {MdnsMessage} An object representing the decoded mDNS message.
+     * @throws {Error} if the message is too short.
+     */
     decodeMdnsMessage(msg: Buffer): MdnsMessage;
+    /**
+     * Decodes a DNS name from a buffer, handling compression.
+     *
+     * @param {Buffer} msg - The full mDNS message buffer.
+     * @param {number} offset - The offset at which the DNS name starts.
+     * @returns {{ name: string; newOffset: number }} An object with the decoded name and the new offset.
+     * @throws {Error} if the offset exceeds the buffer length or too many iterations are performed.
+     */
     decodeDnsName(msg: Buffer, offset: number): {
         name: string;
         newOffset: number;
     };
+    /**
+     * Encodes a domain name into the DNS label format.
+     *
+     * For example, "example.local" becomes:
+     * [7] "example" [5] "local" [0]
+     *
+     * @param {string} name - The domain name to encode.
+     * @returns {Buffer} The encoded domain name as a Buffer.
+     */
     encodeDnsName(name: string): Buffer;
+    /**
+     * Encodes TXT record RDATA.
+     *
+     * In DNS/mDNS, TXT RDATA is a sequence of one or more <character-string>,
+     * each encoded as: [length byte][UTF-8 bytes].
+     *
+     * @param {string[]} txt - Array of TXT entries, e.g. ["key=value", "path=/"].
+     * @returns {Buffer} Encoded TXT RDATA.
+     * @throws {Error} If any entry exceeds 255 bytes.
+     *
+     * @example
+     * const txtRdata = mdns.encodeTxtRdata(['txtvers=1', 'path=/']);
+     * mdns.sendResponse([
+     *   { name: 'example._http._tcp.local', rtype: DnsRecordType.TXT, rclass: DnsClass.IN | DnsClassFlag.FLUSH, ttl: 120, rdata: txtRdata },
+     * ]);
+     */
     encodeTxtRdata(txt: string[]): Buffer;
+    /**
+     * Encodes SRV record RDATA.
+     *
+     * SRV RDATA layout (RFC 2782):
+     * - priority (2 bytes)
+     * - weight   (2 bytes)
+     * - port     (2 bytes)
+     * - target   (DNS name)
+     *
+     * @param {number} priority - SRV priority.
+     * @param {number} weight - SRV weight.
+     * @param {number} port - Service port.
+     * @param {string} target - Target hostname (e.g. "matterbridge.local").
+     * @returns {Buffer} Encoded SRV RDATA.
+     */
     encodeSrvRdata(priority: number, weight: number, port: number, target: string): Buffer;
+    /**
+     * Encodes an IPv4 address for an A record RDATA (4 bytes).
+     *
+     * @param {string} ipv4 - IPv4 address, e.g. "192.168.1.10".
+     * @returns {Buffer} 4-byte buffer.
+     * @throws {Error} If the address is not a valid dotted-quad.
+     */
     encodeA(ipv4: string): Buffer;
+    /**
+     * Encodes an IPv6 address for an AAAA record RDATA (16 bytes).
+     *
+     * Supports the "::" zero-compression form and ignores an optional scope id
+     * suffix (e.g. "fe80::1%12" or "fe80::1%eth0").
+     *
+     * @param {string} ipv6WithOptionalScope - IPv6 address (optionally with scope id).
+     * @returns {Buffer} 16-byte buffer.
+     * @throws {Error} If the address is not a valid IPv6 literal.
+     */
     encodeAAAA(ipv6WithOptionalScope: string): Buffer;
+    /**
+     * Decodes a DNS resource record.
+     *
+     * @param {Buffer} msg - The full mDNS message buffer.
+     * @param {number} offset - The offset at which the resource record starts.
+     * @returns {{ record: MdnsRecord; newOffset: number }} An object containing the decoded record and the new offset.
+     */
     decodeResourceRecord(msg: Buffer, offset: number): {
         record: MdnsRecord;
         newOffset: number;
     };
+    /**
+     * Sends a DNS query with multiple questions.
+     *
+     * @param {Array<{ name: string; type: number; class: number; unicastResponse?: boolean }>} questions - Array of questions
+     * to include in the query.
+     * @returns {Buffer<ArrayBuffer>} The constructed query buffer.
+     *
+     * @remarks
+     * Each question should have a name (e.g., "_http._tcp.local"), type (e.g., DnsRecordType.PTR), class (e.g., DnsClass.IN),
+     * and an optional unicastResponse flag (this will add the DnsClassFlag.QU flag to the query).
+     */
     sendQuery(questions: {
         name: string;
         type: number;
         class: number;
         unicastResponse?: boolean;
     }[]): Buffer<ArrayBuffer>;
+    /**
+     * Constructs an mDNS response packet and sends it to the multicast address and port.
+     *
+     * @param {Array<{ name: string; rtype: number; rclass: number; ttl: number; rdata: Buffer }>} answers - Array of answer records.
+     * @returns {Buffer<ArrayBuffer>} The constructed response buffer.
+     *
+     * @example
+     *   const ptrRdata = mdnsIpv4.encodeDnsName('matterbridge._http._tcp.local');
+     *   mdnsIpv4.sendResponse([{ name: '_http._tcp.local', rtype: DnsRecordType.PTR, rclass: DnsClass.IN, ttl: 120, rdata: ptrRdata }]);
+     */
     sendResponse(answers: {
         name: string;
         rtype: number;
@@ -179,10 +332,40 @@ export declare class Mdns extends Multicast {
         ttl: number;
         rdata: Buffer;
     }[]): Buffer<ArrayBuffer>;
+    /**
+     * Converts a DNS record type numeric value to its string representation.
+     *
+     * @param {number} type - The numeric DNS record type.
+     * @returns {string} The string representation of the record type.
+     */
     dnsTypeToString(type: number): string;
+    /**
+     * Converts a DNS response class numeric value to its string representation.
+     *
+     * @param {number} cls - The numeric DNS class.
+     * @returns {string} The string representation of the DNS class.
+     */
     dnsResponseClassToString(cls: number): string;
+    /**
+     * Converts a DNS question class to a human-readable string.
+     * Adds support for mDNS QU (unicast-response) bit.
+     *
+     * @param {number} cls - The numeric question class.
+     * @returns {string} The string representation, e.g. "IN|QU"
+     */
     dnsQuestionClassToString(cls: number): string;
+    /**
+     * Logs the decoded mDNS message header.
+     *
+     * @param {MdnsMessage} msg - The mDNS message header object.
+     * @param {AnsiLogger} [log] - The logger to use (defaults to this.log).
+     * @param {string} [text] - Optional additional text to include in the log.
+     */
     logMdnsMessage(msg: MdnsMessage, log?: AnsiLogger, text?: string): void;
+    /**
+     * Logs the discovered devices from the mDNS queries and responses.
+     */
     logDevices(): void;
 }
 export {};
+//# sourceMappingURL=mdns.d.ts.map

package/packages/dgram/dist/mdns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdns.d.ts","sourceRoot":"","sources":["../src/mdns.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,KAAK,MAAM,YAAY,CAAC;AAG/B,OAAO,EAAE,UAAU,EAA+C,MAAM,kBAAkB,CAAC;AAK3F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,0BAAkB,aAAa;IAC7B,CAAC,IAAI;IACL,EAAE,IAAI;IACN,EAAE,IAAI;IACN,EAAE,IAAI;IACN,KAAK,IAAI;IACT,GAAG,IAAI;IACP,EAAE,IAAI;IACN,EAAE,IAAI;IACN,EAAE,IAAI;IACN,IAAI,KAAK;IACT,GAAG,KAAK;IACR,GAAG,KAAK;IACR,KAAK,KAAK;IACV,KAAK,KAAK;IACV,EAAE,KAAK;IACP,GAAG,KAAK;IACR,EAAE,KAAK;IACP,KAAK,KAAK;IACV,GAAG,KAAK;IACR,IAAI,KAAK;IACT,EAAE,KAAK;IACP,IAAI,KAAK;IACT,QAAQ,KAAK;IACb,GAAG,KAAK;IACR,GAAG,KAAK;IACR,EAAE,KAAK;IACP,IAAI,KAAK;IACT,IAAI,KAAK;IACT,GAAG,KAAK;IACR,GAAG,KAAK;IACR,GAAG,KAAK;IACR,MAAM,KAAK;IACX,GAAG,KAAK;IACR,IAAI,KAAK;IACT,KAAK,KAAK;IACV,EAAE,KAAK;IACP,IAAI,KAAK;IACT,EAAE,KAAK;IACP,KAAK,KAAK;IACV,IAAI,KAAK;IACT,GAAG,KAAK;IACR,GAAG,KAAK;IACR,EAAE,KAAK;IACP,KAAK,KAAK;IACV,QAAQ,KAAK;IACb,KAAK,KAAK;IACV,IAAI,KAAK;IACT,MAAM,KAAK;IACX,KAAK,KAAK;IACV,KAAK,KAAK;IACV,UAAU,KAAK;IACf,IAAI,KAAK;IACT,MAAM,KAAK;IACX,GAAG,KAAK;IACR,KAAK,KAAK;IACV,IAAI,KAAK;IACT,MAAM,KAAK;IACX,GAAG,KAAK;IACR,OAAO,KAAK;IACZ,UAAU,KAAK;IACf,KAAK,KAAK;IACV,MAAM,KAAK;IACX,IAAI,KAAK;IACT,KAAK,KAAK;IACV,GAAG,KAAK;IACR,KAAK,MAAM;IACX,GAAG,MAAM;IACT,GAAG,MAAM;IACT,MAAM,MAAM;IACZ,GAAG,MAAM;IACT,GAAG,MAAM;IACT,GAAG,MAAM;IACT,EAAE,MAAM;IACR,KAAK,MAAM;IACX,KAAK,MAAM;IACX,IAAI,MAAM;IACV,IAAI,MAAM;IACV,IAAI,MAAM;IACV,IAAI,MAAM;IACV,KAAK,MAAM;IACX,KAAK,MAAM;IACX,GAAG,MAAM;IACT,GAAG,MAAM;IACT,GAAG,MAAM;IACT,GAAG,MAAM;IACT,GAAG,MAAM;IACT,QAAQ,MAAM;IACd,WAAW,MAAM;IAEjB,EAAE,QAAQ;IACV,GAAG,QAAQ;CACZ;AAED,0BAAkB,QAAQ;IACxB,EAAE,IAAI,CAAE,WAAW;IACnB,EAAE,IAAI,CAAE,QAAQ;IAChB,EAAE,IAAI,CAAE,SAAS;IACjB,GAAG,MAAM;CACV;AAED,0BAAkB,YAAY;IAC5B,KAAK,QAAS,CAAE,iCAAiC;IAEjD,EAAE,QAAS;CACZ;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,OAAO,CAAC;IACZ,EAAE,EAAE,OAAO,CAAC;IACZ,EAAE,EAAE,OAAO,CAAC;IACZ,EAAE,EAAE,OAAO,CAAC;IACZ,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B;AAED,UAAU,WAAW;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,UAAU;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAID;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAI/C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAOvD;AAED,qBAAa,IAAK,SAAQ,SAAS;IACjC,aAAa;eAA+B,KAAK,CAAC,UAAU;eAAS,WAAW;OAAM;IACtF,eAAe;eAA+B,KAAK,CAAC,UAAU;kBAAY,WAAW;kBAAY,MAAM;OAAM;IAC7G,OAAO,EAAE,MAAM,EAAE,CAAM;IAEvB;;;;;;;;;;;OAWG;gBAED,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,GAAG,MAAM,EAC3B,SAAS,GAAE,OAAO,GAAG,SAAgB,EACrC,aAAa,CAAC,EAAE,MAAM,EACtB,gBAAgB,CAAC,EAAE,MAAM,EACzB,wBAAwB,CAAC,EAAE,MAAM;IAKnC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW;IAIpD,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,WAAW;IAIjD,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IA0C9D;;;;;;;OAOG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAgF3C;;;;;;;OAOG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;IA8C/E;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAWnC;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM;IASrC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAQtF;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAQ7B;;;;;;;;;OASG;IACH,UAAU,CAAC,qBAAqB,EAAE,MAAM,GAAG,MAAM;IAkCjD;;;;;;OAMG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG;QAAE,MAAM,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;IA6G5F;;;;;;;;;;OAUG;IACH,SAAS,CAAC,SAAS,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,OAAO,CAAA;KAAE,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC;IAmCrH;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC;IAqDzH;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAiGrC;;;;;OAKG;IACH,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAyB7C;;;;;;OAMG;IACH,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAyB7C;;;;;;OAMG;IACH,cAAc,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,GAAE,UAAqB,EAAE,IAAI,GAAE,MAA+B,GAAG,IAAI;IA2BzG;;OAEG;IACH,UAAU;CAyCX"}