matterbridge 3.4.5-dev-20251225-742588e → 3.4.5

package/dist/dgram/mdns.d.ts

@@ -0,0 +1,350 @@
+/**
+ * @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';
+export declare const enum DnsRecordType {
+    A = 1,
+    NS = 2,
+    MD = 3,
+    MF = 4,
+    CNAME = 5,
+    SOA = 6,
+    MB = 7,
+    MG = 8,
+    MR = 9,
+    NULL = 10,
+    WKS = 11,
+    PTR = 12,
+    HINFO = 13,
+    MINFO = 14,
+    MX = 15,
+    TXT = 16,
+    RP = 17,
+    AFSDB = 18,
+    X25 = 19,
+    ISDN = 20,
+    RT = 21,
+    NSAP = 22,
+    NSAP_PTR = 23,
+    SIG = 24,
+    KEY = 25,
+    PX = 26,
+    GPOS = 27,
+    AAAA = 28,
+    LOC = 29,
+    NXT = 30,
+    EID = 31,
+    NIMLOC = 32,
+    SRV = 33,
+    ATMA = 34,
+    NAPTR = 35,
+    KX = 36,
+    CERT = 37,
+    A6 = 38,
+    DNAME = 39,
+    SINK = 40,
+    OPT = 41,
+    APL = 42,
+    DS = 43,
+    SSHFP = 44,
+    IPSECKEY = 45,
+    RRSIG = 46,
+    NSEC = 47,
+    DNSKEY = 48,
+    DHCID = 49,
+    NSEC3 = 50,
+    NSEC3PARAM = 51,
+    TLSA = 52,
+    SMIMEA = 53,
+    HIP = 55,
+    NINFO = 56,
+    RKEY = 57,
+    TALINK = 58,
+    CDS = 59,
+    CDNSKEY = 60,
+    OPENPGPKEY = 61,
+    CSYNC = 62,
+    ZONEMD = 63,
+    SVCB = 64,
+    HTTPS = 65,
+    SPF = 99,
+    UINFO = 100,
+    UID = 101,
+    GID = 102,
+    UNSPEC = 103,
+    NID = 104,
+    L32 = 105,
+    L64 = 106,
+    LP = 107,
+    EUI48 = 108,
+    EUI64 = 109,
+    TKEY = 249,
+    TSIG = 250,
+    IXFR = 251,
+    AXFR = 252,
+    MAILB = 253,
+    MAILA = 254,
+    ANY = 255,
+    URI = 256,
+    CAA = 257,
+    AVC = 258,
+    DOA = 259,
+    AMTRELAY = 260,
+    ZONEVERSION = 261,
+    TA = 32768,
+    DLV = 32769
+}
+export declare const enum DnsClass {
+    IN = 1,// Internet
+    CH = 3,// Chaos
+    HS = 4,// Hesiod
+    ANY = 255
+}
+export declare const enum DnsClassFlag {
+    FLUSH = 32768,// For answers (resource records)
+    QU = 32768
+}
+export interface MdnsMessage {
+    id: number;
+    qr: number;
+    opcode: number;
+    aa: boolean;
+    tc: boolean;
+    rd: boolean;
+    ra: boolean;
+    z: number;
+    rcode: number;
+    qdCount: number;
+    anCount: number;
+    nsCount: number;
+    arCount: number;
+    questions?: DnsQuestion[];
+    answers?: MdnsRecord[];
+    authorities?: MdnsRecord[];
+    additionals?: MdnsRecord[];
+}
+interface DnsQuestion {
+    name: string;
+    type: number;
+    class: number;
+}
+interface MdnsRecord {
+    name: string;
+    type: number;
+    class: number;
+    ttl: number;
+    data: string;
+}
+export declare class Mdns extends Multicast {
+    deviceQueries: Map<string, {
+        rinfo: dgram.RemoteInfo;
+        query: MdnsMessage;
+    }>;
+    deviceResponses: Map<string, {
+        rinfo: dgram.RemoteInfo;
+        response: MdnsMessage;
+        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;
+        rclass: number;
+        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/dist/dgram/mdns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdns.d.ts","sourceRoot":"","sources":["../../src/dgram/mdns.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,KAAK,MAAM,YAAY,CAAC;AAG/B,OAAO,EAAE,UAAU,EAAmD,MAAM,kBAAkB,CAAC;AAM/F,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,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;gBACS,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,SAAS,GAAE,OAAO,GAAG,SAAgB,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,wBAAwB,CAAC,EAAE,MAAM;IAInO,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;IAyC9D;;;;;;;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;IA+BjD;;;;;;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;IAsCrH;;;;;;;;;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;IAuDzH;;;;;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;IAuBzG;;OAEG;IACH,UAAU;CAuCX"}