matterbridge 3.1.6-dev-20250720-88d6141 → 3.1.6

package/dist/devices/waterHeater.js

@@ -1,3 +1,26 @@
+/**
+ * @description This file contains the WaterHeater class.
+ * @file src/devices/waterHeater.ts
+ * @author Luca Liguori
+ * @contributor Ludovic BOUÉ
+ * @created 2025-05-18
+ * @version 1.1.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 { ModeBase } from '@matter/main/clusters/mode-base';
 import { WaterHeaterManagement } from '@matter/main/clusters/water-heater-management';
 import { WaterHeaterMode } from '@matter/main/clusters/water-heater-mode';
@@ -8,6 +31,29 @@ import { MatterbridgeServer } from '../matterbridgeBehaviors.js';
 import { electricalSensor, powerSource, waterHeater } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 export class WaterHeater extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the WaterHeater class.
+     *
+     * @param {string} name - The name of the water heater.
+     * @param {string} serial - The serial number of the water heater.
+     * @param {number} [waterTemperature] - The current water temperature. Defaults to 50.
+     * @param {number} [targetWaterTemperature] - The target water temperature. Defaults to 55.
+     * @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit. Defaults to 20.
+     * @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit. Defaults to 80.
+     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
+     * @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
+     * @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
+     * @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
+     * @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
+     * @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
+     * @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 90.
+     * @param {number} [voltage] - The voltage value in millivolts. Defaults to null if not provided.
+     * @param {number} [current] - The current value in milliamperes. Defaults to null if not provided.
+     * @param {number} [power] - The power value in milliwatts. Defaults to null if not provided.
+     * @param {number} [energy] - The total consumption value in mW/h. Defaults to null if not provided.
+     * @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
+     * @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
+     */
     constructor(name, serial, waterTemperature = 50, targetWaterTemperature = 55, minHeatSetpointLimit = 20, maxHeatSetpointLimit = 80, heaterTypes = { immersionElement1: true }, tankPercentage = 90, voltage = null, current = null, power = null, energy = null, absMinPower = 0, absMaxPower = 0) {
         super([waterHeater, powerSource, electricalSensor], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
@@ -22,15 +68,42 @@ export class WaterHeater extends MatterbridgeEndpoint {
             .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.WaterHeating, true, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
             .createDefaultDeviceEnergyManagementModeClusterServer();
     }
+    /**
+     * Creates a default WaterHeaterManagement Cluster Server.
+     *
+     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
+     * @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
+     * @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
+     * @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
+     * @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
+     * @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
+     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heatDemand] - Indicates if the water heater is heating water. Defaults to all heat sources unset.
+     * @param {boolean} heatDemand.immersionElement1 - Indicates if the water heater is heating water with immersion element 1. Defaults to false.
+     * @param {boolean} heatDemand.immersionElement2 - Indicates if the water heater is heating water with immersion element 2.
+     * @param {boolean} heatDemand.heatPump - Indicates if the water heater is heating water with a heat pump.
+     * @param {boolean} heatDemand.boiler - Indicates if the water heater is heating water with a boiler.
+     * @param {boolean} heatDemand.other - Indicates if the water heater is heating water with other types of heating sources.
+     * @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 100.
+     * @param {WaterHeaterManagement.BoostState} [boostState] - The current boost state of the WaterHeaterManagement cluster. Defaults to Inactive.
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
     createDefaultWaterHeaterManagementClusterServer(heaterTypes, heatDemand, tankPercentage, boostState) {
         this.behaviors.require(MatterbridgeWaterHeaterManagementServer.with(WaterHeaterManagement.Feature.TankPercent), {
-            heaterTypes: heaterTypes ?? { immersionElement1: true },
+            heaterTypes: heaterTypes ?? { immersionElement1: true }, // Fixed attribute
             heatDemand: heatDemand ?? {},
             tankPercentage: tankPercentage ?? 100,
             boostState: boostState ?? WaterHeaterManagement.BoostState.Inactive,
         });
         return this;
     }
+    /**
+     * Creates a default WaterHeaterMode Cluster Server.
+     *
+     * @param {number} [currentMode] - The current mode of the WaterHeaterMode cluster. Defaults to mode 1 (WaterHeaterMode.ModeTag.Auto).
+     * @param {WaterHeaterMode.ModeOption[]} [supportedModes] - The supported modes for the WaterHeaterMode cluster. Defaults all cluster modes.
+     *
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
     createDefaultWaterHeaterModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MatterbridgeWaterHeaterModeServer, {
             supportedModes: supportedModes ?? [
@@ -47,7 +120,7 @@ export class WaterHeater extends MatterbridgeEndpoint {
                 { label: 'Off', mode: 11, modeTags: [{ value: WaterHeaterMode.ModeTag.Off }] },
                 { label: 'Manual', mode: 12, modeTags: [{ value: WaterHeaterMode.ModeTag.Manual }] },
                 { label: 'Timed', mode: 13, modeTags: [{ value: WaterHeaterMode.ModeTag.Timed }] },
-            ],
+            ], // Fixed attribute
             currentMode: currentMode ?? 1,
         });
         return this;
@@ -60,6 +133,9 @@ export class MatterbridgeWaterHeaterManagementServer extends WaterHeaterManageme
         device.commandHandler.executeHandler('boost', { request, cluster: WaterHeaterManagementServer.id, attributes: this.state, endpoint: this.endpoint });
         device.log.debug(`MatterbridgeWaterHeaterManagementServer boost called with: ${JSON.stringify(request)}`);
         this.state.boostState = WaterHeaterManagement.BoostState.Active;
+        // The implementation is responsible for setting the device accordingly with the boostInfo of the boost command
+        // super.boost({ boostInfo });
+        // boost is not implemented in matter.js
     }
     cancelBoost() {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -67,6 +143,9 @@ export class MatterbridgeWaterHeaterManagementServer extends WaterHeaterManageme
         device.commandHandler.executeHandler('cancelBoost', { request: {}, cluster: WaterHeaterManagementServer.id, attributes: this.state, endpoint: this.endpoint });
         device.log.debug(`MatterbridgeWaterHeaterManagementServer cancelBoost called`);
         this.state.boostState = WaterHeaterManagement.BoostState.Inactive;
+        // The implementation is responsible for setting the device accordingly with the cancelBoost command
+        // super.cancelBoost();
+        // cancelBoost is not implemented in matter.js
     }
 }
 export class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
@@ -84,3 +163,4 @@ export class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
         return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
     }
 }
+//# sourceMappingURL=waterHeater.js.map

package/dist/devices/waterHeater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waterHeater.js","sourceRoot":"","sources":["../../src/devices/waterHeater.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAMH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,+CAA+C,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AACxF,OAAO,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AAEjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,MAAM,OAAO,WAAY,SAAQ,oBAAoB;IACnD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YACE,IAAY,EACZ,MAAc,EACd,gBAAgB,GAAG,EAAE,EACrB,sBAAsB,GAAG,EAAE,EAC3B,oBAAoB,GAAG,EAAE,EACzB,oBAAoB,GAAG,EAAE,EACzB,cAAmI,EAAE,iBAAiB,EAAE,IAAI,EAAE,EAC9J,cAAc,GAAG,EAAE,EACnB,UAAkC,IAAI,EACtC,UAAkC,IAAI,EACtC,QAAgC,IAAI,EACpC,SAAiC,IAAI,EACrC,cAAsB,CAAC,EACvB,cAAsB,CAAC;QAEvB,KAAK,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,gBAAgB,CAAC,EAAE,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7I,IAAI,CAAC,kCAAkC,EAAE;aACtC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,2BAA2B,CAAC;aACrH,0CAA0C,EAAE;aAC5C,2CAA2C,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,oBAAoB,CAAC;aACjI,+CAA+C,CAAC,WAAW,EAAE,EAAE,EAAE,cAAc,CAAC;aAChF,yCAAyC,EAAE;aAC3C,uCAAuC,EAAE;aACzC,oDAAoD,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC;aAC7E,qDAAqD,CAAC,MAAM,CAAC;aAC7D,gDAAgD,CAAC,sBAAsB,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,sBAAsB,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC;aACrK,oDAAoD,EAAE,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,+CAA+C,CAC7C,WAAiI,EACjI,UAAgI,EAChI,cAAuB,EACvB,UAA6C;QAE7C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,uCAAuC,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC9G,WAAW,EAAE,WAAW,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,EAAE,kBAAkB;YAC3E,UAAU,EAAE,UAAU,IAAI,EAAE;YAC5B,cAAc,EAAE,cAAc,IAAI,GAAG;YACrC,UAAU,EAAE,UAAU,IAAI,qBAAqB,CAAC,UAAU,CAAC,QAAQ;SACpE,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,yCAAyC,CAAC,WAAoB,EAAE,cAA6C;QAC3G,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,iCAAiC,EAAE;YACxD,cAAc,EAAE,cAAc,IAAI;gBAChC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE;gBAC/E,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;gBACjF,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;gBACjF,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;gBACvF,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE;gBACzF,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;gBACvF,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC7E,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC7E,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;gBACjF,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC9E,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC9E,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;gBACpF,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;aACnF,EAAE,kBAAkB;YACrB,WAAW,EAAE,WAAW,IAAI,CAAC;SAC9B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,OAAO,uCAAwC,SAAQ,2BAA2B;IAC7E,KAAK,CAAC,OAA2C;QACxD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QAC1F,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,2BAA2B,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrJ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,8DAA8D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC1G,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,qBAAqB,CAAC,UAAU,CAAC,MAAM,CAAC;QAChE,+GAA+G;QAC/G,8BAA8B;QAC9B,wCAAwC;IAC1C,CAAC;IAEQ,WAAW;QAClB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACjG,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,2BAA2B,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/J,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAC/E,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,qBAAqB,CAAC,UAAU,CAAC,QAAQ,CAAC;QAClE,oGAAoG;QACpG,uBAAuB;QACvB,8CAA8C;IAChD,CAAC;CACF;AAED,MAAM,OAAO,iCAAkC,SAAQ,qBAAqB;IACjE,YAAY,CAAC,OAAqC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,OAAO,cAAc,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACxH,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,qBAAqB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtJ,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,mFAAmF,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YACvH,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;QAC/F,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,sEAAsE,OAAO,CAAC,OAAO,OAAO,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QAChI,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IAC9E,CAAC;CACF"}

package/dist/dgram/dgram.d.ts

@@ -0,0 +1,140 @@
+/**
+ * @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 for all interfaces address '::'.
+     *
+     * @returns {string} The scope ID of the first found IPv6 address or an empty string.
+     */
+    getIpv6ScopeIdForAllInterfacesAddress(): 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

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

@@ -0,0 +1 @@
+{"version":3,"file":"dgram.d.ts","sourceRoot":"","sources":["../../src/dgram/dgram.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,YAAY,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC,OAAO,EAAE,UAAU,EAAoD,MAAM,kBAAkB,CAAC;AAEhG;;GAEG;AACH,UAAU,WAAW;IACnB,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACtB,KAAK,EAAE,EAAE,CAAC;IACV,OAAO,EAAE,EAAE,CAAC;IACZ,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAChD,SAAS,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAClC,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAC/D,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9B,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,YAAY,CAAC,WAAW,CAAC;IAClD,GAAG,aAAC;IACJ,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IACrB,KAAK,UAAS;IACd,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;OAQG;gBACS,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,SAAS,GAAE,OAAO,GAAG,SAAgB,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM;IA0C/I;;;;;;OAMG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAc3D,OAAO,CAAC,KAAK,EAAE,KAAK;IAIpB,OAAO;IAIP,SAAS;IAIT,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAI7D,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU;IAI9C,WAAW,CAAC,OAAO,EAAE,WAAW;IAKhC,OAAO,CAAC,OAAO,EAAE,WAAW;IAK5B;;;;;;;OAOG;IACH,uBAAuB,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAwCtE;;;;;;;OAOG;IACH,uBAAuB,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IA0DtE;;;;OAIG;IACH,kBAAkB,IAAI,MAAM,EAAE;IAW9B;;;;OAIG;IACH,qCAAqC,IAAI,MAAM;IAc/C;;;;;OAKG;IACH,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAchE;;;;;OAKG;IACH,UAAU,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAkBxD;;;;;;OAMG;IACH,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAUvG;;;;OAIG;IACH,uBAAuB,IAAI,MAAM;IAIjC;;OAEG;IACH,qBAAqB;CAYtB"}

package/dist/dgram/dgram.js

@@ -0,0 +1,348 @@
+/**
+ * @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.
+ */
+// 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';
+/**
+ * This class implements a dgram socket.
+ */
+export class Dgram extends EventEmitter {
+    log;
+    socket;
+    bound = false;
+    socketType;
+    interfaceName;
+    interfaceAddress;
+    interfaceNetmask;
+    /**
+     * 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, socketType, reuseAddr = true, interfaceName, interfaceAddress) {
+        super();
+        this.log = new AnsiLogger({ logName: name, logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
+        this.socket = dgram.createSocket({ type: socketType, reuseAddr });
+        this.socketType = socketType;
+        this.interfaceName = interfaceName;
+        this.interfaceAddress = interfaceAddress;
+        this.socket.on('error', (error) => {
+            this.log.debug(`Socket error: ${error instanceof Error ? error.message : error}`);
+            this.emit('error', error);
+            this.onError(error);
+        });
+        this.socket.on('close', () => {
+            this.log.debug('Socket closed');
+            this.bound = false;
+            this.emit('close');
+            this.onClose();
+        });
+        this.socket.on('connect', () => {
+            this.log.info('Socket connected');
+            this.emit('connect');
+            this.onConnect();
+        });
+        this.socket.on('message', (msg, rinfo) => {
+            this.log.debug(`Socket received a message from ${BLUE}${rinfo.family}${db} ${BLUE}${rinfo.address}${db}:${BLUE}${rinfo.port}${db}`);
+            this.emit('message', msg, rinfo);
+            this.onMessage(msg, rinfo);
+        });
+        this.socket.on('listening', () => {
+            this.bound = true;
+            const address = this.socket.address();
+            this.log.debug(`Socket listening on ${BLUE}${address.family}${db} ${BLUE}${address.address}${db}:${BLUE}${address.port}${db}`);
+            this.emit('listening', address);
+            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) {
+                this.log.error(`Socket failed to send a message: ${error instanceof Error ? error.message : error}`);
+                this.emit('error', error);
+                this.onError(error);
+            }
+            else {
+                this.log.debug(`Socket sent a message to ${BLUE}${serverAddress}${db}:${BLUE}${serverPort}${db}`);
+                this.emit('sent', msg, serverAddress, serverPort);
+                this.onSent(msg, serverAddress, serverPort);
+            }
+        });
+    }
+    onError(error) {
+        this.log.error(`Socket error: ${error instanceof Error ? error.message : error}`);
+    }
+    onClose() {
+        this.log.info(`Socket closed`);
+    }
+    onConnect() {
+        this.log.info(`Socket connected`);
+    }
+    onSent(msg, serverAddress, serverPort) {
+        this.log.info(`Socket sent a message to ${BLUE}${serverAddress}${db}:${BLUE}${serverPort}${db}`);
+    }
+    onMessage(msg, rinfo) {
+        this.log.info(`Socket received a message from ${BLUE}${rinfo.family}${nf} ${BLUE}${rinfo.address}${nf}:${BLUE}${rinfo.port}${nf}`);
+    }
+    onListening(address) {
+        this.log.info(`Socket listening on ${BLUE}${address.family}${nf} ${BLUE}${address.address}${nf}:${BLUE}${address.port}${nf}`);
+        this.onReady(address);
+    }
+    onReady(address) {
+        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 (!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;
+                        break;
+                    }
+                }
+                if (networkInterface)
+                    break;
+            }
+        }
+        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) {
+            throw new Error(`Interface ${networkInterface} does not have an external IPv4 address`);
+        }
+        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 (!interfaceDetails)
+                    continue;
+                for (const detail of interfaceDetails) {
+                    if (detail.family === 'IPv6' && !detail.internal) {
+                        networkInterface = interfaceName;
+                        break;
+                    }
+                }
+                if (networkInterface)
+                    break;
+            }
+        }
+        if (!networkInterface) {
+            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');
+            return uniqueLocalAddress.address;
+        }
+        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 = [];
+        for (const name in interfaces) {
+            if (interfaces[name]) {
+                interfaceNames.push(name);
+            }
+        }
+        return interfaceNames;
+    }
+    /**
+     *  Retrieves the scope ID for all interfaces address '::'.
+     *
+     * @returns {string} The scope ID of the first found IPv6 address or an empty string.
+     */
+    getIpv6ScopeIdForAllInterfacesAddress() {
+        const interfaces = os.networkInterfaces();
+        for (const name in interfaces) {
+            const iface = interfaces[name];
+            if (iface) {
+                const ipv6Address = iface.find((addr) => addr.family === 'IPv6' && !addr.internal && addr.scopeid);
+                if (ipv6Address) {
+                    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;
+                }
+            }
+        }
+        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 cleanedAddress = interfaceAddress.includes('%') ? interfaceAddress.split('%')[0] : interfaceAddress;
+        // Iterate over all interfaces.
+        const nets = os.networkInterfaces();
+        for (const ifaceName in nets) {
+            const ifaceAddresses = nets[ifaceName];
+            if (!ifaceAddresses)
+                continue;
+            for (const addr of ifaceAddresses) {
+                if (addr.address === cleanedAddress) {
+                    return addr.netmask;
+                }
+            }
+        }
+        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;
+        }
+        const ipParts = ipAddress.split('.').map(Number);
+        const maskParts = netmask.split('.').map(Number);
+        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)) {
+            if (!addresses)
+                continue;
+            this.log.debug(`Interface: ${idn}${name}${rs}${db}`);
+            for (const address of addresses) {
+                this.log.debug(`- address ${BLUE}${address.address}${db} netmask ${BLUE}${address.netmask}${db} ${address.mac ? 'MAC: ' + BLUE + address.mac + db : ''} type: ${BLUE}${address.family}${db} ${BLUE}${address.internal ? 'internal' : 'external'}${db} ${address.scopeid !== undefined ? 'scopeid: ' + BLUE + address.scopeid + db : ''} cidr: ${BLUE}${address.cidr}${db}`);
+            }
+        }
+    }
+}
+//# sourceMappingURL=dgram.js.map