matterbridge 3.4.7 → 3.5.0-dev-20260113-96c82db

package/dist/dgram/mdns.d.ts

@@ -1,25 +1,3 @@
-/**
- * @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';
@@ -116,13 +94,13 @@ export declare const enum DnsRecordType {
     DLV = 32769
 }
 export declare const enum DnsClass {
-    IN = 1,// Internet
-    CH = 3,// Chaos
-    HS = 4,// Hesiod
+    IN = 1,
+    CH = 3,
+    HS = 4,
     ANY = 255
 }
 export declare const enum DnsClassFlag {
-    FLUSH = 32768,// For answers (resource records)
+    FLUSH = 32768,
     QU = 32768
 }
 export interface MdnsMessage {
@@ -156,26 +134,8 @@ 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, {
@@ -188,143 +148,30 @@ 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;
@@ -332,40 +179,10 @@ 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