matterbridge 3.4.3-dev-20251209-e6cb85f → 3.4.3

package/dist/dgram/coap.d.ts

@@ -0,0 +1,205 @@
+/**
+ * @description This file contains the class Coap.
+ * @file src/dgram/coap.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 { Multicast } from './multicast.js';
+/**
+ * Represents a CoAP message.
+ *
+ * A CoAP message is structured with a fixed header, an optional token, a series of options,
+ * and an optional payload. The header consists of version, type, token length, code, and message ID.
+ * The token is used to match responses with requests, options provide additional metadata, and
+ * the payload carries the message content.
+ */
+export interface CoapMessage {
+    /**
+     * The CoAP protocol version.
+     * Typically, this is 1.
+     * (Stored in the top 2 bits of the first header byte.)
+     */
+    version: number;
+    /**
+     * The message type.
+     * It indicates whether the message is Confirmable, Non-confirmable, Acknowledgement, or Reset.
+     * (Stored in bits 5-4 of the first header byte.)
+     * 0: Confirmable (CON)
+     * 1: Non-confirmable (NON)
+     * 2: Acknowledgement (ACK)
+     * 3: Reset (RST)
+     */
+    type: number;
+    /**
+     * The token length.
+     * This value (0-8) specifies the length of the token field.
+     * (Stored in the lower 4 bits of the first header byte.)
+     */
+    tokenLength: number;
+    /**
+     * The message code.
+     * It indicates the method or response code, e.g., GET, POST, or a success/error response.
+     * (Stored in the second header byte.)
+     * CoAP uses an 8‑bit Code field divided into a 3‑bit class and a 5‑bit detail. The code can be represented as X.XX (e.g. 0.01) and is defined in RFC 7252. Here are the standard CoAP codes:
+     * Request Codes (Class 0)
+     * 0.01 – 1-GET
+     * Retrieve a resource.
+     * 0.02 – 2-POST
+     * Create a resource or trigger an action.
+     * 0.03 – 3-PUT
+     * Update or create a resource.
+     * 0.04 – 4-DELETE
+     * Remove a resource.
+     * Success Response Codes (Class 2)
+     * 2.00 – Empty / Success
+     * Indicates an empty message or a successful request with no payload.
+     * 2.01 – Created
+     * The request resulted in a new resource being created.
+     * 2.02 – Deleted
+     * The resource was successfully deleted.
+     * 2.03 – Valid
+     * The response indicates that the resource is still valid (used with caching).
+     * 2.04 – Changed
+     * The resource was successfully modified.
+     * 2.05 – Content
+     * The response contains the requested content.
+     * Client Error Response Codes (Class 4)
+     * 4.00 – Bad Request
+     * The request was malformed.
+     * 4.01 – Unauthorized
+     * The request requires authentication.
+     * 4.02 – Bad Option
+     * An option in the request was not understood or is unacceptable.
+     * 4.03 – Forbidden
+     * The server refuses to fulfill the request.
+     * 4.04 – Not Found
+     * The requested resource was not found.
+     * 4.05 – Method Not Allowed
+     * The request method is not supported for the target resource.
+     * 4.06 – Not Acceptable
+     * The server cannot generate a response matching the list of acceptable values.
+     * 4.12 – Precondition Failed
+     * A precondition given in the request evaluated to false.
+     * 4.13 – Request Entity Too Large
+     * The request payload is too large.
+     * 4.15 – Unsupported Content-Format
+     * The server does not support the content format of the request payload.
+     * Server Error Response Codes (Class 5)
+     * 5.00 – Internal Server Error
+     * The server encountered an unexpected condition.
+     * 5.01 – Not Implemented
+     * The server does not support the requested method.
+     * 5.02 – Bad Gateway
+     * The server, while acting as a gateway or proxy, received an invalid response.
+     * 5.03 – Service Unavailable
+     * The server is currently unable to handle the request.
+     * 5.04 – Gateway Timeout
+     * The server did not receive a timely response from an upstream server.
+     * 5.05 – Proxying Not Supported
+     * The server does not support proxying for the requested resource.
+     */
+    code: number;
+    /**
+     * The message identifier.
+     * This 16-bit field is used to match messages of type Acknowledgement/Reset with their corresponding requests.
+     * (Stored in bytes 2-3 of the header.)
+     */
+    messageId: number;
+    /**
+     * The token.
+     * A variable-length sequence (0-8 bytes) that helps match a request with its response.
+     */
+    token: Buffer;
+    /**
+     * An array of options.
+     * Options carry additional information such as URI path, content format, etc., and are encoded using a delta mechanism.
+     */
+    options: CoapOption[];
+    /**
+     * The payload.
+     * The actual content of the message, if present. It follows a payload marker (0xFF) if non-empty.
+     */
+    payload?: Buffer;
+}
+interface CoapOption {
+    number: number;
+    value: Buffer;
+}
+export declare const COAP_OPTION_URI_PATH = 11;
+export declare const COIOT_OPTION_DEVID = 3332;
+export declare const COIOT_OPTION_VALIDITY = 3412;
+export declare const COIOT_OPTION_SERIAL = 3420;
+export declare const COIOT_REQUEST_STATUS_ID = 56831;
+export declare const COIOT_REQUEST_DESCRIPTION_ID = 56832;
+export declare class Coap extends Multicast {
+    constructor(name: string, multicastAddress: string, multicastPort: number, socketType: 'udp4' | 'udp6', reuseAddr?: boolean | undefined, interfaceName?: string, interfaceAddress?: string);
+    onCoapMessage(message: CoapMessage, rinfo: dgram.RemoteInfo): void;
+    onMessage(msg: Buffer, rinfo: dgram.RemoteInfo): void;
+    /**
+     * Decodes a CoAP message from a Buffer.
+     *
+     * @param {Buffer} msg - The Buffer containing the raw CoAP message.
+     * @returns {CoapMessage} A parsed CoAP message object.
+     * @throws {Error} if the message is malformed.
+     */
+    decodeCoapMessage(msg: Buffer): CoapMessage;
+    /**
+     * Encodes a CoAP message into a Buffer.
+     *
+     * @param {CoapMessage} msg - The CoAP message to encode.
+     * @returns {Buffer} A Buffer representing the encoded CoAP message.
+     * @throws {Error} if the message is malformed.
+     */
+    encodeCoapMessage(msg: CoapMessage): Buffer;
+    /**
+     * Converts a CoAP message type numeric value to its string representation.
+     *
+     * CoAP message types are:
+     *  - 0: Confirmable (CON)
+     *  - 1: Non-confirmable (NON)
+     *  - 2: Acknowledgement (ACK)
+     *  - 3: Reset (RST)
+     *
+     * @param {number} type - The numeric CoAP message type.
+     * @returns {string} The string representation of the message type.
+     */
+    coapTypeToString(type: number): string;
+    /**
+     * Converts a CoAP code numeric value to its string representation.
+     *
+     * The CoAP code is split into a 3-bit class and a 5-bit detail.
+     * For example:
+     *   - 0.01: GET
+     *   - 0.02: POST
+     *   - 0.03: PUT
+     *   - 0.04: DELETE
+     *   - 2.05: Content (success response)
+     *   - 4.04: Not Found (client error)
+     *   - 5.00: Internal Server Error (server error)
+     *
+     * @param {number} code - The numeric CoAP code.
+     * @returns {string} The string representation of the code.
+     */
+    coapCodeToString(code: number): string;
+    sendRequest(messageId: number, options: CoapOption[], payload: Record<string, any> | undefined, token: string | undefined, address: string | undefined, port: number | undefined): void;
+    logCoapMessage(msg: CoapMessage): void;
+}
+export {};
+//# sourceMappingURL=coap.d.ts.map

package/dist/dgram/coap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coap.d.ts","sourceRoot":"","sources":["../../src/dgram/coap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,KAAK,MAAM,YAAY,CAAC;AAM/B,OAAO,EAAoD,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;;OAQG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6DG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,UAAU;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,kBAAkB,OAAO,CAAC;AACvC,eAAO,MAAM,qBAAqB,OAAO,CAAC;AAC1C,eAAO,MAAM,mBAAmB,OAAO,CAAC;AACxC,eAAO,MAAM,uBAAuB,QAAQ,CAAC;AAC7C,eAAO,MAAM,4BAA4B,QAAQ,CAAC;AAElD,qBAAa,IAAK,SAAQ,SAAS;gBACrB,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;IAIhM,aAAa,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAIzD,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,GAAG,IAAI;IAW9D;;;;;;OAMG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAwG3C;;;;;;OAMG;IACH,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,MAAM;IA6F3C;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAetC;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAQtC,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,UAAU,EAAE,EAErB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,EACxC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,IAAI,EAAE,MAAM,GAAG,SAAS,GACvB,IAAI;IAeP,cAAc,CAAC,GAAG,EAAE,WAAW;CAuDhC"}

package/dist/dgram/coap.js

@@ -1,4 +1,28 @@
+/**
+ * @description This file contains the class Coap.
+ * @file src/dgram/coap.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, GREEN, MAGENTA, nf } from 'node-ansi-logger';
+// Net imports
 import { COAP_MULTICAST_IPV4_ADDRESS, COAP_MULTICAST_PORT, Multicast } from './multicast.js';
 export const COAP_OPTION_URI_PATH = 11;
 export const COIOT_OPTION_DEVID = 3332;
@@ -24,16 +48,26 @@ export class Coap extends Multicast {
             this.log.error(`Error decoding CoAP message: ${error instanceof Error ? error.message : error}`);
         }
     }
+    /**
+     * Decodes a CoAP message from a Buffer.
+     *
+     * @param {Buffer} msg - The Buffer containing the raw CoAP message.
+     * @returns {CoapMessage} A parsed CoAP message object.
+     * @throws {Error} if the message is malformed.
+     */
     decodeCoapMessage(msg) {
+        // A valid CoAP message must have at least 4 bytes for the header.
         if (msg.length < 4) {
             throw new Error('Message too short to be a valid CoAP message');
         }
-        const version = (msg[0] & 0xc0) >> 6;
-        const type = (msg[0] & 0x30) >> 4;
-        const tokenLength = msg[0] & 0x0f;
-        const code = msg[1];
-        const messageId = msg.readUInt16BE(2);
+        // Parse the 4-byte fixed header.
+        const version = (msg[0] & 0xc0) >> 6; // Bits 7-6: Version
+        const type = (msg[0] & 0x30) >> 4; // Bits 5-4: Type
+        const tokenLength = msg[0] & 0x0f; // Bits 3-0: Token Length
+        const code = msg[1]; // 8-bit Code
+        const messageId = msg.readUInt16BE(2); // 16-bit Message ID
         let offset = 4;
+        // Parse token if present.
         let token = Buffer.alloc(0);
         if (tokenLength > 0) {
             if (msg.length < offset + tokenLength) {
@@ -42,16 +76,20 @@ export class Coap extends Multicast {
             token = msg.slice(offset, offset + tokenLength);
             offset += tokenLength;
         }
+        // Parse options.
         const options = [];
         let currentOptionNumber = 0;
         while (offset < msg.length) {
+            // Payload marker: 0xFF indicates the beginning of the payload.
             if (msg[offset] === 0xff) {
-                offset++;
+                offset++; // Skip the marker.
                 break;
             }
+            // Read the option header byte.
             const optionHeader = msg[offset++];
-            let delta = (optionHeader & 0xf0) >> 4;
-            let length = optionHeader & 0x0f;
+            let delta = (optionHeader & 0xf0) >> 4; // High nibble: option delta.
+            let length = optionHeader & 0x0f; // Low nibble: option length.
+            // Extended delta handling.
             if (delta === 13) {
                 if (offset >= msg.length) {
                     throw new Error('Invalid extended option delta');
@@ -68,6 +106,7 @@ export class Coap extends Multicast {
             else if (delta === 15) {
                 throw new Error('Reserved option delta value encountered');
             }
+            // Extended length handling.
             if (length === 13) {
                 if (offset >= msg.length) {
                     throw new Error('Invalid extended option length');
@@ -84,7 +123,9 @@ export class Coap extends Multicast {
             else if (length === 15) {
                 throw new Error('Reserved option length value encountered');
             }
+            // Calculate the actual option number.
             currentOptionNumber += delta;
+            // Ensure that the option's value fits in the remaining message.
             if (offset + length > msg.length) {
                 throw new Error('Option length exceeds message length');
             }
@@ -95,6 +136,7 @@ export class Coap extends Multicast {
                 value: optionValue,
             });
         }
+        // Parse payload if any remains.
         const payload = offset < msg.length ? msg.slice(offset) : undefined;
         return {
             version,
@@ -107,23 +149,38 @@ export class Coap extends Multicast {
             payload,
         };
     }
+    /**
+     * Encodes a CoAP message into a Buffer.
+     *
+     * @param {CoapMessage} msg - The CoAP message to encode.
+     * @returns {Buffer} A Buffer representing the encoded CoAP message.
+     * @throws {Error} if the message is malformed.
+     */
     encodeCoapMessage(msg) {
         const parts = [];
+        // Determine token length (ensure it's consistent with msg.token)
         const token = msg.token || Buffer.alloc(0);
         const tokenLength = token.length;
         if (tokenLength > 8) {
             throw new Error('Token length cannot exceed 8 bytes');
         }
+        // Create header (4 bytes):
+        //   Byte 0: Version (2 bits), Type (2 bits), Token Length (4 bits)
+        //   Byte 1: Code (8 bits)
+        //   Bytes 2-3: Message ID (16 bits)
         const header = Buffer.alloc(4);
         header[0] = ((msg.version & 0x03) << 6) | ((msg.type & 0x03) << 4) | (tokenLength & 0x0f);
         header[1] = msg.code;
         header.writeUInt16BE(msg.messageId, 2);
         parts.push(header);
+        // Append token if present.
         if (tokenLength > 0) {
             parts.push(token);
         }
+        // Sort options by option number in ascending order.
         const sortedOptions = msg.options.slice().sort((a, b) => a.number - b.number);
         let previousOptionNumber = 0;
+        // Encode each option.
         for (const option of sortedOptions) {
             const optionDelta = option.number - previousOptionNumber;
             const optionValueLength = option.value.length;
@@ -131,6 +188,7 @@ export class Coap extends Multicast {
             let deltaExtended = null;
             let lengthNibble;
             let lengthExtended = null;
+            // Determine option delta nibble and extended delta field.
             if (optionDelta < 13) {
                 deltaNibble = optionDelta;
             }
@@ -143,6 +201,7 @@ export class Coap extends Multicast {
                 deltaExtended = Buffer.alloc(2);
                 deltaExtended.writeUInt16BE(optionDelta - 269, 0);
             }
+            // Determine option length nibble and extended length field.
             if (optionValueLength < 13) {
                 lengthNibble = optionValueLength;
             }
@@ -155,24 +214,42 @@ export class Coap extends Multicast {
                 lengthExtended = Buffer.alloc(2);
                 lengthExtended.writeUInt16BE(optionValueLength - 269, 0);
             }
+            // Option header byte: high nibble is delta, low nibble is length.
             const optionHeader = Buffer.alloc(1);
             optionHeader[0] = (deltaNibble << 4) | (lengthNibble & 0x0f);
             parts.push(optionHeader);
+            // Append extended delta if needed.
             if (deltaExtended) {
                 parts.push(deltaExtended);
             }
+            // Append extended length if needed.
             if (lengthExtended) {
                 parts.push(lengthExtended);
             }
+            // Append the option value.
             parts.push(option.value);
+            // Update previous option number.
             previousOptionNumber = option.number;
         }
+        // If a payload is present, add the payload marker (0xFF) followed by the payload.
         if (msg.payload && msg.payload.length > 0) {
-            parts.push(Buffer.from([0xff]));
+            parts.push(Buffer.from([0xff])); // Payload marker.
             parts.push(msg.payload);
         }
         return Buffer.concat(parts);
     }
+    /**
+     * Converts a CoAP message type numeric value to its string representation.
+     *
+     * CoAP message types are:
+     *  - 0: Confirmable (CON)
+     *  - 1: Non-confirmable (NON)
+     *  - 2: Acknowledgement (ACK)
+     *  - 3: Reset (RST)
+     *
+     * @param {number} type - The numeric CoAP message type.
+     * @returns {string} The string representation of the message type.
+     */
     coapTypeToString(type) {
         switch (type) {
             case 0:
@@ -187,18 +264,37 @@ export class Coap extends Multicast {
                 return `Unknown Type (${type})`;
         }
     }
+    /**
+     * Converts a CoAP code numeric value to its string representation.
+     *
+     * The CoAP code is split into a 3-bit class and a 5-bit detail.
+     * For example:
+     *   - 0.01: GET
+     *   - 0.02: POST
+     *   - 0.03: PUT
+     *   - 0.04: DELETE
+     *   - 2.05: Content (success response)
+     *   - 4.04: Not Found (client error)
+     *   - 5.00: Internal Server Error (server error)
+     *
+     * @param {number} code - The numeric CoAP code.
+     * @returns {string} The string representation of the code.
+     */
     coapCodeToString(code) {
+        // Split the code: the upper 3 bits form the class and the lower 5 bits form the detail.
         const cls = code >> 5;
         const detail = code & 0x1f;
         const codeStr = `${cls}.${detail.toString().padStart(2, '0')}`;
         return codeStr;
     }
-    sendRequest(messageId, options, payload, token, address, port) {
+    sendRequest(messageId, options, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    payload, token, address, port) {
         const coapMessage = {
             version: 1,
-            type: 1,
+            type: 1, // e.g., Confirmable
             tokenLength: token ? Buffer.from(token).length : 0,
-            code: 1,
+            code: 1, // e.g., GET
             messageId,
             token: token ? Buffer.from(token) : Buffer.alloc(0),
             options,
@@ -217,6 +313,10 @@ export class Coap extends Multicast {
                 this.log.info(`Option: COAP_OPTION_URI_PATH => ${GREEN}${option.value}${nf}`);
             }
             else if (option.number === COIOT_OPTION_DEVID) {
+                /*
+                 * First defined option is COIOT_OPTION_GLOBAL_DEVID. This is a global option and must be present in all CoIoT packages with request or payload.
+                 * Its value is a string in format <devtype>#<devid>#<version> for example SHSEN-1#4B3F9E#1 The whole option should be less than 50 bytes.
+                 */
                 const parts = option.value.toString().split('#');
                 const deviceModel = parts[0];
                 const deviceMac = parts[1];
@@ -224,10 +324,22 @@ export class Coap extends Multicast {
                 this.log.info(`Option: COIOT_OPTION_DEVID => ${option.value} => Model: ${GREEN}${deviceModel}${nf}, MAC: ${GREEN}${deviceMac}${nf}, Protocol: ${GREEN}${protocolRevision}${nf}`);
             }
             else if (option.number === COIOT_OPTION_SERIAL) {
+                /*
+                 * This option is mandatory in status response and publishes. It is a uint16_t in network byte order which indicates a change in the status report.
+                 * When a new status report is handled, all payload processing can be skipped if the serial number does not change from the last processed payload.
+                 * The value 0 is reserved and should not be sent. This allows easy initialization in the receiving devices.
+                 */
                 const serial = option.value.readUInt16BE(0);
                 this.log.info(`Option: COIOT_OPTION_SERIAL => 0x${option.value.toString('hex')} => serial: ${GREEN}${serial}${nf}`);
             }
             else if (option.number === COIOT_OPTION_VALIDITY) {
+                /*
+                 * COIOT_OPTION_STATUS_VALIDITY is a uint16_t in network byte order (big endian) that states the maximal time between this and the next status publish.
+                 * This way a device can state its report interval. If a report is not received from this device after the interval has passed the device should be considered offline.
+                 * The LS bit of this option controls how the value is scaled:
+                 * - If the LS bit is 0, the value is number of 1/10 of seconds in the validity period, so 2 is 0.2 seconds, 10 is a second, 600 is a minute, 65534 is 109 minutes and 13 seconds.
+                 * - If the LS bit is 1, the value is number of 4 seconds interval in the whole interval. So 3 is 12 seconds, 11 is 44 seconds and 65535 is more than 3 days.
+                 */
                 const validity = option.value.readUInt16BE(0);
                 let validFor = 0;
                 if ((validity & 0x1) === 0) {
@@ -242,7 +354,7 @@ export class Coap extends Multicast {
                 this.log.info(`Option: ${option.number} - ${option.value
                     .toString('hex')
                     .match(/.{1,2}/g)
-                    ?.join(' ')}`);
+                    ?.join(' ')}`); // Split into pairs of hex characters
         });
         if (msg.payload && msg.payload.length > 0)
             this.log.info(`Payload:`, JSON.parse(msg.payload.toString()), '\n');
@@ -250,3 +362,4 @@ export class Coap extends Multicast {
             this.log.info(`No payload`, '\n');
     }
 }
+//# sourceMappingURL=coap.js.map

package/dist/dgram/coap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coap.js","sourceRoot":"","sources":["../../src/dgram/coap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH,qBAAqB;AACrB,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAEhE,cAAc;AACd,OAAO,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AA4H7F,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,CAAC,MAAM,qBAAqB,GAAG,IAAI,CAAC;AAC1C,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAC;AACxC,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAC7C,MAAM,CAAC,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAElD,MAAM,OAAO,IAAK,SAAQ,SAAS;IACjC,YAAY,IAAY,EAAE,gBAAwB,EAAE,aAAqB,EAAE,UAA2B,EAAE,YAAiC,IAAI,EAAE,aAAsB,EAAE,gBAAyB;QAC9L,KAAK,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC;IACvG,CAAC;IAED,aAAa,CAAC,OAAoB,EAAE,KAAuB;QACzD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,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;IAClI,CAAC;IAEQ,SAAS,CAAC,GAAW,EAAE,KAAuB;QACrD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,uDAAuD,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;QACxJ,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;YAC3C,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACnG,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,GAAW;QAC3B,kEAAkE;QAClE,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,iCAAiC;QACjC,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,oBAAoB;QAC1D,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB;QACpD,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,yBAAyB;QAC5D,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa;QAClC,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB;QAE3D,IAAI,MAAM,GAAG,CAAC,CAAC;QAEf,0BAA0B;QAC1B,IAAI,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;YACpB,IAAI,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,WAAW,EAAE,CAAC;gBACtC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;YACtE,CAAC;YACD,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC;YAChD,MAAM,IAAI,WAAW,CAAC;QACxB,CAAC;QAED,iBAAiB;QACjB,MAAM,OAAO,GAAiB,EAAE,CAAC;QACjC,IAAI,mBAAmB,GAAG,CAAC,CAAC;QAE5B,OAAO,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;YAC3B,+DAA+D;YAC/D,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;gBACzB,MAAM,EAAE,CAAC,CAAC,mBAAmB;gBAC7B,MAAM;YACR,CAAC;YAED,+BAA+B;YAC/B,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACnC,IAAI,KAAK,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,6BAA6B;YACrE,IAAI,MAAM,GAAG,YAAY,GAAG,IAAI,CAAC,CAAC,6BAA6B;YAE/D,2BAA2B;YAC3B,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBACjB,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBACzB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;gBACnD,CAAC;gBACD,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YAC7B,CAAC;iBAAM,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBACxB,IAAI,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBAC7B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;gBACnD,CAAC;gBACD,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;gBACvC,MAAM,IAAI,CAAC,CAAC;YACd,CAAC;iBAAM,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC7D,CAAC;YAED,4BAA4B;YAC5B,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;gBAClB,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBACzB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YAC9B,CAAC;iBAAM,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;gBACzB,IAAI,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBAC7B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;gBACpD,CAAC;gBACD,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;gBACxC,MAAM,IAAI,CAAC,CAAC;YACd,CAAC;iBAAM,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAC9D,CAAC;YAED,sCAAsC;YACtC,mBAAmB,IAAI,KAAK,CAAC;YAE7B,gEAAgE;YAChE,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;YAC1D,CAAC;YACD,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,MAAM,CAAC;YAEjB,OAAO,CAAC,IAAI,CAAC;gBACX,MAAM,EAAE,mBAAmB;gBAC3B,KAAK,EAAE,WAAW;aACnB,CAAC,CAAC;QACL,CAAC;QAED,gCAAgC;QAChC,MAAM,OAAO,GAAG,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpE,OAAO;YACL,OAAO;YACP,IAAI;YACJ,WAAW;YACX,IAAI;YACJ,SAAS;YACT,KAAK;YACL,OAAO;YACP,OAAO;SACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,GAAgB;QAChC,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,iEAAiE;QACjE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC;QACjC,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,2BAA2B;QAC3B,mEAAmE;QACnE,0BAA0B;QAC1B,oCAAoC;QACpC,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;QAC1F,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEnB,2BAA2B;QAC3B,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;QAED,oDAAoD;QACpD,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;QAC9E,IAAI,oBAAoB,GAAG,CAAC,CAAC;QAE7B,sBAAsB;QACtB,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE,CAAC;YACnC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,GAAG,oBAAoB,CAAC;YACzD,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;YAC9C,IAAI,WAAmB,CAAC;YACxB,IAAI,aAAa,GAAkB,IAAI,CAAC;YACxC,IAAI,YAAoB,CAAC;YACzB,IAAI,cAAc,GAAkB,IAAI,CAAC;YAEzC,0DAA0D;YAC1D,IAAI,WAAW,GAAG,EAAE,EAAE,CAAC;gBACrB,WAAW,GAAG,WAAW,CAAC;YAC5B,CAAC;iBAAM,IAAI,WAAW,GAAG,GAAG,EAAE,CAAC;gBAC7B,WAAW,GAAG,EAAE,CAAC;gBACjB,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,EAAE,CAAC;gBACjB,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChC,aAAa,CAAC,aAAa,CAAC,WAAW,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;YACpD,CAAC;YAED,4DAA4D;YAC5D,IAAI,iBAAiB,GAAG,EAAE,EAAE,CAAC;gBAC3B,YAAY,GAAG,iBAAiB,CAAC;YACnC,CAAC;iBAAM,IAAI,iBAAiB,GAAG,GAAG,EAAE,CAAC;gBACnC,YAAY,GAAG,EAAE,CAAC;gBAClB,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,YAAY,GAAG,EAAE,CAAC;gBAClB,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjC,cAAc,CAAC,aAAa,CAAC,iBAAiB,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;YAC3D,CAAC;YAED,kEAAkE;YAClE,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACrC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;YAC7D,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAEzB,mCAAmC;YACnC,IAAI,aAAa,EAAE,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC5B,CAAC;YAED,oCAAoC;YACpC,IAAI,cAAc,EAAE,CAAC;gBACnB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC7B,CAAC;YAED,2BAA2B;YAC3B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAEzB,iCAAiC;YACjC,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC;QACvC,CAAC;QAED,kFAAkF;QAClF,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB;YACnD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,IAAY;QAC3B,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,CAAC;gBACJ,OAAO,mBAAmB,CAAC;YAC7B,KAAK,CAAC;gBACJ,OAAO,uBAAuB,CAAC;YACjC,KAAK,CAAC;gBACJ,OAAO,uBAAuB,CAAC;YACjC,KAAK,CAAC;gBACJ,OAAO,aAAa,CAAC;YACvB;gBACE,OAAO,iBAAiB,IAAI,GAAG,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,IAAY;QAC3B,wFAAwF;QACxF,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,CAAC;QACtB,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;QAC3B,MAAM,OAAO,GAAG,GAAG,GAAG,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;QAC/D,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,WAAW,CACT,SAAiB,EACjB,OAAqB;IACrB,8DAA8D;IAC9D,OAAwC,EACxC,KAAyB,EACzB,OAA2B,EAC3B,IAAwB;QAExB,MAAM,WAAW,GAAgB;YAC/B,OAAO,EAAE,CAAC;YACV,IAAI,EAAE,CAAC,EAAE,oBAAoB;YAC7B,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAClD,IAAI,EAAE,CAAC,EAAE,YAAY;YACrB,SAAS;YACT,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACnD,OAAO;YACP,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;SACpE,CAAC;QACF,MAAM,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,IAAI,2BAA2B,EAAE,IAAI,IAAI,mBAAmB,CAAC,CAAC;IAChG,CAAC;IAED,cAAc,CAAC,GAAgB;QAC7B,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,iCAAiC,OAAO,GAAG,GAAG,CAAC,OAAO,GAAG,EAAE,SAAS,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG;YACnH,QAAQ,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,OAAO,GAAG,GAAG,CAAC,SAAS,GAAG,EAAE,GAAG;YACnG,eAAe,OAAO,GAAG,GAAG,CAAC,WAAW,GAAG,EAAE,UAAU,OAAO,GAAG,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG;YACtI,WAAW,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,EAAE,YAAY,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CACnI,CAAC;QACF,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC7B,IAAI,MAAM,CAAC,MAAM,KAAK,oBAAoB,EAAE,CAAC;gBAC3C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAmC,KAAK,GAAG,MAAM,CAAC,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC;YAChF,CAAC;iBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,kBAAkB,EAAE,CAAC;gBAChD;;;mBAGG;gBACH,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjD,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7B,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC3B,MAAM,gBAAgB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iCAAiC,MAAM,CAAC,KAAK,cAAc,KAAK,GAAG,WAAW,GAAG,EAAE,UAAU,KAAK,GAAG,SAAS,GAAG,EAAE,eAAe,KAAK,GAAG,gBAAgB,GAAG,EAAE,EAAE,CAAC,CAAC;YACnL,CAAC;iBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,mBAAmB,EAAE,CAAC;gBACjD;;;;mBAIG;gBACH,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAC5C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oCAAoC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,KAAK,GAAG,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC;YACtH,CAAC;iBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,qBAAqB,EAAE,CAAC;gBACnD;;;;;;mBAMG;gBACH,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;gBAC9C,IAAI,QAAQ,GAAG,CAAC,CAAC;gBACjB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3B,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACN,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC;gBAC1B,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sCAAsC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,kBAAkB,KAAK,GAAG,QAAQ,GAAG,EAAE,UAAU,CAAC,CAAC;YACrI,CAAC;;gBACC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,WAAW,MAAM,CAAC,MAAM,MAAM,MAAM,CAAC,KAAK;qBACvC,QAAQ,CAAC,KAAK,CAAC;qBACf,KAAK,CAAC,SAAS,CAAC;oBACjB,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAChB,CAAC,CAAC,qCAAqC;QAC5C,CAAC,CAAC,CAAC;QACH,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;;YAC1G,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;CACF"}

package/dist/dgram/dgram.d.ts

@@ -0,0 +1,141 @@
+/**
+ * @description This file contains the class Dgram.
+ * @file dgram.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 EventEmitter from 'node:events';
+import { AddressInfo } from 'node:net';
+import { AnsiLogger } from 'node-ansi-logger';
+/**
+ * Represents the Dgram events.
+ */
+interface DgramEvents {
+    error: [error: Error];
+    close: [];
+    connect: [];
+    message: [msg: Buffer, rinfo: dgram.RemoteInfo];
+    listening: [address: AddressInfo];
+    sent: [msg: Buffer, serverAddress: string, serverPort: number];
+    ready: [address: AddressInfo];
+    bound: [address: AddressInfo];
+}
+/**
+ * This class implements a dgram socket.
+ */
+export declare class Dgram extends EventEmitter<DgramEvents> {
+    log: AnsiLogger;
+    socket: dgram.Socket;
+    bound: boolean;
+    socketType: 'udp4' | 'udp6';
+    interfaceName?: string;
+    interfaceAddress?: string;
+    interfaceNetmask?: string;
+    /**
+     * 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.
+     * @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: string, socketType: 'udp4' | 'udp6', reuseAddr?: boolean | undefined, interfaceName?: string, interfaceAddress?: string);
+    /**
+     * 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: Buffer, serverAddress: string, serverPort: number): void;
+    onError(error: Error): void;
+    onClose(): void;
+    onConnect(): void;
+    onSent(msg: Buffer, serverAddress: string, serverPort: number): void;
+    onMessage(msg: Buffer, rinfo: dgram.RemoteInfo): void;
+    onListening(address: AddressInfo): void;
+    onReady(address: AddressInfo): void;
+    /**
+     * 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?: string): string | undefined;
+    /**
+     * 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?: string): string | undefined;
+    /**
+     * Retrieves the names of all available network interfaces.
+     *
+     * @returns {string[]} An array of network interface names.
+     */
+    getInterfacesNames(): string[];
+    /**
+     *  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?: string): string;
+    /**
+     * 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: number): string | 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: string): string | 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: string | undefined, netmask: string | undefined): string | undefined;
+    /**
+     * Returns the broadcast IPv6 address.
+     *
+     * @returns {string} The broadcast IPv6 address, e.g. "ff02::1"
+     */
+    getIpv6BroadcastAddress(): string;
+    /**
+     * Logs all available network interfaces and their details.
+     */
+    listNetworkInterfaces(): void;
+}
+export {};
+//# sourceMappingURL=dgram.d.ts.map