matterbridge 3.4.5 → 3.4.6-dev-20251228-e06f048
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/dist/broadcastServer.js +0 -117
- package/dist/broadcastServerTypes.js +0 -24
- package/dist/cli.js +1 -97
- package/dist/cliEmitter.js +0 -37
- package/dist/cliHistory.js +0 -38
- package/dist/clusters/export.js +0 -2
- package/dist/deviceManager.js +1 -113
- package/dist/devices/airConditioner.js +0 -57
- package/dist/devices/batteryStorage.js +1 -48
- package/dist/devices/cooktop.js +0 -56
- package/dist/devices/dishwasher.js +0 -57
- package/dist/devices/evse.js +10 -74
- package/dist/devices/export.js +0 -5
- package/dist/devices/extractorHood.js +0 -43
- package/dist/devices/heatPump.js +2 -50
- package/dist/devices/laundryDryer.js +3 -62
- package/dist/devices/laundryWasher.js +4 -70
- package/dist/devices/microwaveOven.js +5 -88
- package/dist/devices/oven.js +0 -85
- package/dist/devices/refrigerator.js +0 -102
- package/dist/devices/roboticVacuumCleaner.js +9 -100
- package/dist/devices/solarPower.js +0 -38
- package/dist/devices/speaker.js +0 -84
- package/dist/devices/temperatureControl.js +3 -24
- package/dist/devices/waterHeater.js +2 -82
- package/dist/dgram/coap.js +13 -126
- package/dist/dgram/dgram.js +2 -114
- package/dist/dgram/mb_coap.js +3 -41
- package/dist/dgram/mb_mdns.js +22 -76
- package/dist/dgram/mdns.js +137 -351
- package/dist/dgram/mdnsReflectorClient.js +5 -29
- package/dist/dgram/mdnsReflectorServer.js +8 -49
- package/dist/dgram/mdnsReflectorTypes.js +1 -24
- package/dist/dgram/multicast.js +1 -62
- package/dist/dgram/unicast.js +0 -60
- package/dist/frontend.js +38 -485
- package/dist/frontendTypes.js +0 -45
- package/dist/helpers.js +0 -53
- package/dist/index.js +0 -25
- package/dist/jestutils/export.js +0 -1
- package/dist/jestutils/jestHelpers.js +14 -371
- package/dist/logger/export.js +0 -1
- package/dist/matter/behaviors.js +0 -2
- package/dist/matter/clusters.js +0 -2
- package/dist/matter/devices.js +0 -2
- package/dist/matter/endpoints.js +0 -2
- package/dist/matter/export.js +0 -3
- package/dist/matter/types.js +0 -3
- package/dist/matterNode.js +8 -369
- package/dist/matterbridge.js +46 -824
- package/dist/matterbridgeAccessoryPlatform.js +0 -38
- package/dist/matterbridgeBehaviors.js +5 -68
- package/dist/matterbridgeDeviceTypes.js +14 -635
- package/dist/matterbridgeDynamicPlatform.js +0 -38
- package/dist/matterbridgeEndpoint.js +53 -1457
- package/dist/matterbridgeEndpointHelpers.js +20 -483
- package/dist/matterbridgeEndpointTypes.js +0 -25
- package/dist/matterbridgePlatform.js +1 -451
- package/dist/matterbridgeTypes.js +0 -26
- package/dist/pluginManager.js +5 -341
- package/dist/shelly.js +7 -178
- package/dist/storage/export.js +0 -1
- package/dist/update.js +1 -93
- package/dist/utils/colorUtils.js +2 -97
- package/dist/utils/commandLine.js +0 -60
- package/dist/utils/copyDirectory.js +0 -37
- package/dist/utils/createDirectory.js +0 -33
- package/dist/utils/createZip.js +2 -47
- package/dist/utils/deepCopy.js +0 -39
- package/dist/utils/deepEqual.js +1 -72
- package/dist/utils/error.js +0 -42
- package/dist/utils/export.js +0 -1
- package/dist/utils/format.js +0 -49
- package/dist/utils/hex.js +0 -124
- package/dist/utils/inspector.js +1 -69
- package/dist/utils/isvalid.js +0 -101
- package/dist/utils/network.js +5 -103
- package/dist/utils/spawn.js +1 -71
- package/dist/utils/tracker.js +1 -64
- package/dist/utils/wait.js +8 -60
- package/dist/workerGlobalPrefix.js +5 -37
- package/dist/workerTypes.js +0 -24
- package/dist/workers.js +4 -68
- package/npm-shrinkwrap.json +2 -2
- package/package.json +1 -2
- package/dist/broadcastServer.d.ts +0 -144
- package/dist/broadcastServer.d.ts.map +0 -1
- package/dist/broadcastServer.js.map +0 -1
- package/dist/broadcastServerTypes.d.ts +0 -841
- package/dist/broadcastServerTypes.d.ts.map +0 -1
- package/dist/broadcastServerTypes.js.map +0 -1
- package/dist/cli.d.ts +0 -30
- package/dist/cli.d.ts.map +0 -1
- package/dist/cli.js.map +0 -1
- package/dist/cliEmitter.d.ts +0 -50
- package/dist/cliEmitter.d.ts.map +0 -1
- package/dist/cliEmitter.js.map +0 -1
- package/dist/cliHistory.d.ts +0 -48
- package/dist/cliHistory.d.ts.map +0 -1
- package/dist/cliHistory.js.map +0 -1
- package/dist/clusters/export.d.ts +0 -2
- package/dist/clusters/export.d.ts.map +0 -1
- package/dist/clusters/export.js.map +0 -1
- package/dist/deviceManager.d.ts +0 -135
- package/dist/deviceManager.d.ts.map +0 -1
- package/dist/deviceManager.js.map +0 -1
- package/dist/devices/airConditioner.d.ts +0 -98
- package/dist/devices/airConditioner.d.ts.map +0 -1
- package/dist/devices/airConditioner.js.map +0 -1
- package/dist/devices/batteryStorage.d.ts +0 -48
- package/dist/devices/batteryStorage.d.ts.map +0 -1
- package/dist/devices/batteryStorage.js.map +0 -1
- package/dist/devices/cooktop.d.ts +0 -61
- package/dist/devices/cooktop.d.ts.map +0 -1
- package/dist/devices/cooktop.js.map +0 -1
- package/dist/devices/dishwasher.d.ts +0 -71
- package/dist/devices/dishwasher.d.ts.map +0 -1
- package/dist/devices/dishwasher.js.map +0 -1
- package/dist/devices/evse.d.ts +0 -76
- package/dist/devices/evse.d.ts.map +0 -1
- package/dist/devices/evse.js.map +0 -1
- package/dist/devices/export.d.ts +0 -17
- package/dist/devices/export.d.ts.map +0 -1
- package/dist/devices/export.js.map +0 -1
- package/dist/devices/extractorHood.d.ts +0 -46
- package/dist/devices/extractorHood.d.ts.map +0 -1
- package/dist/devices/extractorHood.js.map +0 -1
- package/dist/devices/heatPump.d.ts +0 -47
- package/dist/devices/heatPump.d.ts.map +0 -1
- package/dist/devices/heatPump.js.map +0 -1
- package/dist/devices/laundryDryer.d.ts +0 -67
- package/dist/devices/laundryDryer.d.ts.map +0 -1
- package/dist/devices/laundryDryer.js.map +0 -1
- package/dist/devices/laundryWasher.d.ts +0 -81
- package/dist/devices/laundryWasher.d.ts.map +0 -1
- package/dist/devices/laundryWasher.js.map +0 -1
- package/dist/devices/microwaveOven.d.ts +0 -168
- package/dist/devices/microwaveOven.d.ts.map +0 -1
- package/dist/devices/microwaveOven.js.map +0 -1
- package/dist/devices/oven.d.ts +0 -105
- package/dist/devices/oven.d.ts.map +0 -1
- package/dist/devices/oven.js.map +0 -1
- package/dist/devices/refrigerator.d.ts +0 -118
- package/dist/devices/refrigerator.d.ts.map +0 -1
- package/dist/devices/refrigerator.js.map +0 -1
- package/dist/devices/roboticVacuumCleaner.d.ts +0 -112
- package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
- package/dist/devices/roboticVacuumCleaner.js.map +0 -1
- package/dist/devices/solarPower.d.ts +0 -40
- package/dist/devices/solarPower.d.ts.map +0 -1
- package/dist/devices/solarPower.js.map +0 -1
- package/dist/devices/speaker.d.ts +0 -87
- package/dist/devices/speaker.d.ts.map +0 -1
- package/dist/devices/speaker.js.map +0 -1
- package/dist/devices/temperatureControl.d.ts +0 -166
- package/dist/devices/temperatureControl.d.ts.map +0 -1
- package/dist/devices/temperatureControl.js.map +0 -1
- package/dist/devices/waterHeater.d.ts +0 -111
- package/dist/devices/waterHeater.d.ts.map +0 -1
- package/dist/devices/waterHeater.js.map +0 -1
- package/dist/dgram/coap.d.ts +0 -205
- package/dist/dgram/coap.d.ts.map +0 -1
- package/dist/dgram/coap.js.map +0 -1
- package/dist/dgram/dgram.d.ts +0 -143
- package/dist/dgram/dgram.d.ts.map +0 -1
- package/dist/dgram/dgram.js.map +0 -1
- package/dist/dgram/mb_coap.d.ts +0 -24
- package/dist/dgram/mb_coap.d.ts.map +0 -1
- package/dist/dgram/mb_coap.js.map +0 -1
- package/dist/dgram/mb_mdns.d.ts +0 -24
- package/dist/dgram/mb_mdns.d.ts.map +0 -1
- package/dist/dgram/mb_mdns.js.map +0 -1
- package/dist/dgram/mdns.d.ts +0 -350
- package/dist/dgram/mdns.d.ts.map +0 -1
- package/dist/dgram/mdns.js.map +0 -1
- package/dist/dgram/mdnsReflectorClient.d.ts +0 -39
- package/dist/dgram/mdnsReflectorClient.d.ts.map +0 -1
- package/dist/dgram/mdnsReflectorClient.js.map +0 -1
- package/dist/dgram/mdnsReflectorServer.d.ts +0 -54
- package/dist/dgram/mdnsReflectorServer.d.ts.map +0 -1
- package/dist/dgram/mdnsReflectorServer.js.map +0 -1
- package/dist/dgram/mdnsReflectorTypes.d.ts +0 -28
- package/dist/dgram/mdnsReflectorTypes.d.ts.map +0 -1
- package/dist/dgram/mdnsReflectorTypes.js.map +0 -1
- package/dist/dgram/multicast.d.ts +0 -67
- package/dist/dgram/multicast.d.ts.map +0 -1
- package/dist/dgram/multicast.js.map +0 -1
- package/dist/dgram/unicast.d.ts +0 -64
- package/dist/dgram/unicast.d.ts.map +0 -1
- package/dist/dgram/unicast.js.map +0 -1
- package/dist/frontend.d.ts +0 -245
- package/dist/frontend.d.ts.map +0 -1
- package/dist/frontend.js.map +0 -1
- package/dist/frontendTypes.d.ts +0 -529
- package/dist/frontendTypes.d.ts.map +0 -1
- package/dist/frontendTypes.js.map +0 -1
- package/dist/helpers.d.ts +0 -48
- package/dist/helpers.d.ts.map +0 -1
- package/dist/helpers.js.map +0 -1
- package/dist/index.d.ts +0 -34
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/jestutils/export.d.ts +0 -2
- package/dist/jestutils/export.d.ts.map +0 -1
- package/dist/jestutils/export.js.map +0 -1
- package/dist/jestutils/jestHelpers.d.ts +0 -345
- package/dist/jestutils/jestHelpers.d.ts.map +0 -1
- package/dist/jestutils/jestHelpers.js.map +0 -1
- package/dist/logger/export.d.ts +0 -2
- package/dist/logger/export.d.ts.map +0 -1
- package/dist/logger/export.js.map +0 -1
- package/dist/matter/behaviors.d.ts +0 -2
- package/dist/matter/behaviors.d.ts.map +0 -1
- package/dist/matter/behaviors.js.map +0 -1
- package/dist/matter/clusters.d.ts +0 -2
- package/dist/matter/clusters.d.ts.map +0 -1
- package/dist/matter/clusters.js.map +0 -1
- package/dist/matter/devices.d.ts +0 -2
- package/dist/matter/devices.d.ts.map +0 -1
- package/dist/matter/devices.js.map +0 -1
- package/dist/matter/endpoints.d.ts +0 -2
- package/dist/matter/endpoints.d.ts.map +0 -1
- package/dist/matter/endpoints.js.map +0 -1
- package/dist/matter/export.d.ts +0 -5
- package/dist/matter/export.d.ts.map +0 -1
- package/dist/matter/export.js.map +0 -1
- package/dist/matter/types.d.ts +0 -3
- package/dist/matter/types.d.ts.map +0 -1
- package/dist/matter/types.js.map +0 -1
- package/dist/matterNode.d.ts +0 -342
- package/dist/matterNode.d.ts.map +0 -1
- package/dist/matterNode.js.map +0 -1
- package/dist/matterbridge.d.ts +0 -505
- package/dist/matterbridge.d.ts.map +0 -1
- package/dist/matterbridge.js.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.d.ts +0 -41
- package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
- package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
- package/dist/matterbridgeBehaviors.d.ts +0 -2404
- package/dist/matterbridgeBehaviors.d.ts.map +0 -1
- package/dist/matterbridgeBehaviors.js.map +0 -1
- package/dist/matterbridgeDeviceTypes.d.ts +0 -698
- package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
- package/dist/matterbridgeDeviceTypes.js.map +0 -1
- package/dist/matterbridgeDynamicPlatform.d.ts +0 -41
- package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
- package/dist/matterbridgeDynamicPlatform.js.map +0 -1
- package/dist/matterbridgeEndpoint.d.ts +0 -1507
- package/dist/matterbridgeEndpoint.d.ts.map +0 -1
- package/dist/matterbridgeEndpoint.js.map +0 -1
- package/dist/matterbridgeEndpointHelpers.d.ts +0 -787
- package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
- package/dist/matterbridgeEndpointHelpers.js.map +0 -1
- package/dist/matterbridgeEndpointTypes.d.ts +0 -166
- package/dist/matterbridgeEndpointTypes.d.ts.map +0 -1
- package/dist/matterbridgeEndpointTypes.js.map +0 -1
- package/dist/matterbridgePlatform.d.ts +0 -539
- package/dist/matterbridgePlatform.d.ts.map +0 -1
- package/dist/matterbridgePlatform.js.map +0 -1
- package/dist/matterbridgeTypes.d.ts +0 -252
- package/dist/matterbridgeTypes.d.ts.map +0 -1
- package/dist/matterbridgeTypes.js.map +0 -1
- package/dist/pluginManager.d.ts +0 -372
- package/dist/pluginManager.d.ts.map +0 -1
- package/dist/pluginManager.js.map +0 -1
- package/dist/shelly.d.ts +0 -181
- package/dist/shelly.d.ts.map +0 -1
- package/dist/shelly.js.map +0 -1
- package/dist/storage/export.d.ts +0 -2
- package/dist/storage/export.d.ts.map +0 -1
- package/dist/storage/export.js.map +0 -1
- package/dist/update.d.ts +0 -84
- package/dist/update.d.ts.map +0 -1
- package/dist/update.js.map +0 -1
- package/dist/utils/colorUtils.d.ts +0 -101
- package/dist/utils/colorUtils.d.ts.map +0 -1
- package/dist/utils/colorUtils.js.map +0 -1
- package/dist/utils/commandLine.d.ts +0 -66
- package/dist/utils/commandLine.d.ts.map +0 -1
- package/dist/utils/commandLine.js.map +0 -1
- package/dist/utils/copyDirectory.d.ts +0 -35
- package/dist/utils/copyDirectory.d.ts.map +0 -1
- package/dist/utils/copyDirectory.js.map +0 -1
- package/dist/utils/createDirectory.d.ts +0 -34
- package/dist/utils/createDirectory.d.ts.map +0 -1
- package/dist/utils/createDirectory.js.map +0 -1
- package/dist/utils/createZip.d.ts +0 -39
- package/dist/utils/createZip.d.ts.map +0 -1
- package/dist/utils/createZip.js.map +0 -1
- package/dist/utils/deepCopy.d.ts +0 -32
- package/dist/utils/deepCopy.d.ts.map +0 -1
- package/dist/utils/deepCopy.js.map +0 -1
- package/dist/utils/deepEqual.d.ts +0 -54
- package/dist/utils/deepEqual.d.ts.map +0 -1
- package/dist/utils/deepEqual.js.map +0 -1
- package/dist/utils/error.d.ts +0 -45
- package/dist/utils/error.d.ts.map +0 -1
- package/dist/utils/error.js.map +0 -1
- package/dist/utils/export.d.ts +0 -13
- package/dist/utils/export.d.ts.map +0 -1
- package/dist/utils/export.js.map +0 -1
- package/dist/utils/format.d.ts +0 -53
- package/dist/utils/format.d.ts.map +0 -1
- package/dist/utils/format.js.map +0 -1
- package/dist/utils/hex.d.ts +0 -89
- package/dist/utils/hex.d.ts.map +0 -1
- package/dist/utils/hex.js.map +0 -1
- package/dist/utils/inspector.d.ts +0 -87
- package/dist/utils/inspector.d.ts.map +0 -1
- package/dist/utils/inspector.js.map +0 -1
- package/dist/utils/isvalid.d.ts +0 -103
- package/dist/utils/isvalid.d.ts.map +0 -1
- package/dist/utils/isvalid.js.map +0 -1
- package/dist/utils/network.d.ts +0 -117
- package/dist/utils/network.d.ts.map +0 -1
- package/dist/utils/network.js.map +0 -1
- package/dist/utils/spawn.d.ts +0 -33
- package/dist/utils/spawn.d.ts.map +0 -1
- package/dist/utils/spawn.js.map +0 -1
- package/dist/utils/tracker.d.ts +0 -108
- package/dist/utils/tracker.d.ts.map +0 -1
- package/dist/utils/tracker.js.map +0 -1
- package/dist/utils/wait.d.ts +0 -54
- package/dist/utils/wait.d.ts.map +0 -1
- package/dist/utils/wait.js.map +0 -1
- package/dist/workerGlobalPrefix.d.ts +0 -25
- package/dist/workerGlobalPrefix.d.ts.map +0 -1
- package/dist/workerGlobalPrefix.js.map +0 -1
- package/dist/workerTypes.d.ts +0 -52
- package/dist/workerTypes.d.ts.map +0 -1
- package/dist/workerTypes.js.map +0 -1
- package/dist/workers.d.ts +0 -69
- package/dist/workers.d.ts.map +0 -1
- package/dist/workers.js.map +0 -1
package/dist/utils/isvalid.js
CHANGED
|
@@ -1,45 +1,7 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file contains the validation functions.
|
|
3
|
-
*
|
|
4
|
-
* @file isvalid.ts
|
|
5
|
-
* @author Luca Liguori
|
|
6
|
-
* @created 2025-02-16
|
|
7
|
-
* @version 1.0.0
|
|
8
|
-
* @license Apache-2.0
|
|
9
|
-
*
|
|
10
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
11
|
-
*
|
|
12
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
13
|
-
* you may not use this file except in compliance with the License.
|
|
14
|
-
* You may obtain a copy of the License at
|
|
15
|
-
*
|
|
16
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
17
|
-
*
|
|
18
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
19
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
20
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
21
|
-
* See the License for the specific language governing permissions and
|
|
22
|
-
* limitations under the License.
|
|
23
|
-
*/
|
|
24
|
-
/**
|
|
25
|
-
* Checks if a given string is a valid IPv4 address.
|
|
26
|
-
*
|
|
27
|
-
* @param {string} ipv4Address - The string to be checked.
|
|
28
|
-
* @returns {boolean} - Returns true if the string is a valid IPv4 address, otherwise returns false.
|
|
29
|
-
*/
|
|
30
1
|
export function isValidIpv4Address(ipv4Address) {
|
|
31
2
|
const ipv4Regex = /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
|
|
32
3
|
return ipv4Regex.test(ipv4Address);
|
|
33
4
|
}
|
|
34
|
-
/**
|
|
35
|
-
* Checks if a value is a valid number within the specified range.
|
|
36
|
-
*
|
|
37
|
-
* @param {any} value - The value to be checked.
|
|
38
|
-
* @param {number} min - The minimum value allowed (optional).
|
|
39
|
-
* @param {number} max - The maximum value allowed (optional).
|
|
40
|
-
* @returns {value is number} Returns true if the value is a valid number within the specified range, otherwise false.
|
|
41
|
-
*/
|
|
42
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
43
5
|
export function isValidNumber(value, min, max) {
|
|
44
6
|
if (value === undefined || value === null || typeof value !== 'number' || Number.isNaN(value) || !Number.isFinite(value))
|
|
45
7
|
return false;
|
|
@@ -49,25 +11,9 @@ export function isValidNumber(value, min, max) {
|
|
|
49
11
|
return false;
|
|
50
12
|
return true;
|
|
51
13
|
}
|
|
52
|
-
/**
|
|
53
|
-
* Checks if a value is a valid boolean.
|
|
54
|
-
*
|
|
55
|
-
* @param {any} value - The value to be checked.
|
|
56
|
-
* @returns {value is boolean} `true` if the value is a valid boolean, `false` otherwise.
|
|
57
|
-
*/
|
|
58
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
59
14
|
export function isValidBoolean(value) {
|
|
60
15
|
return value !== undefined && value !== null && typeof value === 'boolean';
|
|
61
16
|
}
|
|
62
|
-
/**
|
|
63
|
-
* Checks if a value is a valid string.
|
|
64
|
-
*
|
|
65
|
-
* @param {any} value - The value to be checked.
|
|
66
|
-
* @param {number} minLength - The min string length (optional).
|
|
67
|
-
* @param {number} maxLength - The max string length (optional).
|
|
68
|
-
* @returns {value is string} A boolean indicating whether the value is a valid string.
|
|
69
|
-
*/
|
|
70
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
71
17
|
export function isValidString(value, minLength, maxLength) {
|
|
72
18
|
if (value === undefined || value === null || typeof value !== 'string')
|
|
73
19
|
return false;
|
|
@@ -77,25 +23,9 @@ export function isValidString(value, minLength, maxLength) {
|
|
|
77
23
|
return false;
|
|
78
24
|
return true;
|
|
79
25
|
}
|
|
80
|
-
/**
|
|
81
|
-
* Checks if a value is a valid RegExp.
|
|
82
|
-
*
|
|
83
|
-
* @param {any} value - The value to be checked.
|
|
84
|
-
* @returns {value is RegExp} A boolean indicating whether the value is a valid RegExp.
|
|
85
|
-
*/
|
|
86
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
87
26
|
export function isValidRegExp(value) {
|
|
88
27
|
return value !== undefined && value !== null && value instanceof RegExp;
|
|
89
28
|
}
|
|
90
|
-
/**
|
|
91
|
-
* Checks if a value is a valid object.
|
|
92
|
-
*
|
|
93
|
-
* @param {any} value - The value to be checked.
|
|
94
|
-
* @param {number} minLength - The min number of keys (optional).
|
|
95
|
-
* @param {number} maxLength - The max number of keys (optional).
|
|
96
|
-
* @returns {value is object} A boolean indicating whether the value is a valid object.
|
|
97
|
-
*/
|
|
98
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
99
29
|
export function isValidObject(value, minLength, maxLength) {
|
|
100
30
|
if (value === undefined || value === null || typeof value !== 'object' || Array.isArray(value))
|
|
101
31
|
return false;
|
|
@@ -106,15 +36,6 @@ export function isValidObject(value, minLength, maxLength) {
|
|
|
106
36
|
return false;
|
|
107
37
|
return true;
|
|
108
38
|
}
|
|
109
|
-
/**
|
|
110
|
-
* Checks if a value is a valid array.
|
|
111
|
-
*
|
|
112
|
-
* @param {any} value - The value to be checked.
|
|
113
|
-
* @param {number} minLength - The min number of elements (optional).
|
|
114
|
-
* @param {number} maxLength - The max number of elements (optional).
|
|
115
|
-
* @returns {value is unknown[]} A boolean indicating whether the value is a valid array.
|
|
116
|
-
*/
|
|
117
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
118
39
|
export function isValidArray(value, minLength, maxLength) {
|
|
119
40
|
if (value === undefined || value === null || !Array.isArray(value))
|
|
120
41
|
return false;
|
|
@@ -124,33 +45,12 @@ export function isValidArray(value, minLength, maxLength) {
|
|
|
124
45
|
return false;
|
|
125
46
|
return true;
|
|
126
47
|
}
|
|
127
|
-
/**
|
|
128
|
-
* Checks if the given value is null.
|
|
129
|
-
*
|
|
130
|
-
* @param {any} value - The value to check.
|
|
131
|
-
* @returns {value is null} `true` if the value is null, `false` otherwise.
|
|
132
|
-
*/
|
|
133
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
134
48
|
export function isValidNull(value) {
|
|
135
49
|
return value === null;
|
|
136
50
|
}
|
|
137
|
-
/**
|
|
138
|
-
* Checks if a value is undefined.
|
|
139
|
-
*
|
|
140
|
-
* @param {any} value - The value to check.
|
|
141
|
-
* @returns {value is undefined} `true` if the value is undefined, `false` otherwise.
|
|
142
|
-
*/
|
|
143
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
144
51
|
export function isValidUndefined(value) {
|
|
145
52
|
return value === undefined;
|
|
146
53
|
}
|
|
147
|
-
/**
|
|
148
|
-
* Converts a semantic version string like "6.11.0-1011-raspi" to a numeric version code like 61100.
|
|
149
|
-
* Format: major * 10000 + minor * 100 + patch
|
|
150
|
-
*
|
|
151
|
-
* @param {string} versionString The version string to parse
|
|
152
|
-
* @returns {number | undefined} A numeric version code or undefined if parsing fails
|
|
153
|
-
*/
|
|
154
54
|
export function parseVersionString(versionString) {
|
|
155
55
|
if (!isValidString(versionString))
|
|
156
56
|
return undefined;
|
|
@@ -167,4 +67,3 @@ export function parseVersionString(versionString) {
|
|
|
167
67
|
}
|
|
168
68
|
return major * 10000 + minor * 100 + patch;
|
|
169
69
|
}
|
|
170
|
-
//# sourceMappingURL=isvalid.js.map
|
package/dist/utils/network.js
CHANGED
|
@@ -1,34 +1,5 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the network functions.
|
|
3
|
-
* @file network.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2024-02-17
|
|
6
|
-
* @version 1.0.1
|
|
7
|
-
* @license Apache-2.0
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2024, 2025, 2026 Luca Liguori.
|
|
10
|
-
*
|
|
11
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
-
* you may not use this file except in compliance with the License.
|
|
13
|
-
* You may obtain a copy of the License at
|
|
14
|
-
*
|
|
15
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
-
*
|
|
17
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
-
* See the License for the specific language governing permissions and
|
|
21
|
-
* limitations under the License.
|
|
22
|
-
*/
|
|
23
|
-
// Node.js modules
|
|
24
1
|
import os from 'node:os';
|
|
25
|
-
// AnsiLogger module
|
|
26
2
|
import { AnsiLogger, BLUE, CYAN, nf } from 'node-ansi-logger';
|
|
27
|
-
/**
|
|
28
|
-
* Retrieves the first non-internal network interface details.
|
|
29
|
-
*
|
|
30
|
-
* @returns {os.NetworkInterfaceInfo | undefined} The details of the selected network interface, or undefined if not found.
|
|
31
|
-
*/
|
|
32
3
|
export function getInterfaceDetails() {
|
|
33
4
|
const result = { interfaceName: '', ipv4Address: undefined, ipv6Address: undefined, macAddress: undefined };
|
|
34
5
|
for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
|
|
@@ -50,11 +21,6 @@ export function getInterfaceDetails() {
|
|
|
50
21
|
if (result.interfaceName)
|
|
51
22
|
return result;
|
|
52
23
|
}
|
|
53
|
-
/**
|
|
54
|
-
* Retrieves the first non-internal network interface name.
|
|
55
|
-
*
|
|
56
|
-
* @returns {string | undefined} The name of the selected network interface, or undefined if not found.
|
|
57
|
-
*/
|
|
58
24
|
export function getInterfaceName() {
|
|
59
25
|
for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
|
|
60
26
|
if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
|
|
@@ -65,11 +31,6 @@ export function getInterfaceName() {
|
|
|
65
31
|
}
|
|
66
32
|
}
|
|
67
33
|
}
|
|
68
|
-
/**
|
|
69
|
-
* Retrieves the IPv4 address of the first non-internal network interface.
|
|
70
|
-
*
|
|
71
|
-
* @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
|
|
72
|
-
*/
|
|
73
34
|
export function getIpv4InterfaceAddress() {
|
|
74
35
|
for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
|
|
75
36
|
if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
|
|
@@ -80,17 +41,6 @@ export function getIpv4InterfaceAddress() {
|
|
|
80
41
|
}
|
|
81
42
|
}
|
|
82
43
|
}
|
|
83
|
-
/**
|
|
84
|
-
* Retrieves the IPv6 address of the first non-internal network interface.
|
|
85
|
-
*
|
|
86
|
-
* If `scope` is true, appends a zone id (scope) for link-local addresses when
|
|
87
|
-
* available:
|
|
88
|
-
* - On Windows: uses `%<scopeid>` (e.g. `%11`)
|
|
89
|
-
* - On other platforms: uses `%<interfaceName>` (e.g. `%eth0`)
|
|
90
|
-
*
|
|
91
|
-
* @param {boolean} [scope] - Whether to append a zone id when available.
|
|
92
|
-
* @returns {string | undefined} The IPv6 address of the selected network interface, or undefined if not found.
|
|
93
|
-
*/
|
|
94
44
|
export function getIpv6InterfaceAddress(scope = false) {
|
|
95
45
|
for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
|
|
96
46
|
if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
|
|
@@ -100,7 +50,6 @@ export function getIpv6InterfaceAddress(scope = false) {
|
|
|
100
50
|
const address = detail.address;
|
|
101
51
|
if (!scope)
|
|
102
52
|
return address;
|
|
103
|
-
// If already has a zone id, keep it.
|
|
104
53
|
if (address.includes('%'))
|
|
105
54
|
return address;
|
|
106
55
|
const isWindows = os.platform() === 'win32';
|
|
@@ -113,11 +62,6 @@ export function getIpv6InterfaceAddress(scope = false) {
|
|
|
113
62
|
}
|
|
114
63
|
}
|
|
115
64
|
}
|
|
116
|
-
/**
|
|
117
|
-
* Retrieves the mac address of the first non-internal network interface.
|
|
118
|
-
*
|
|
119
|
-
* @returns {string | undefined} The mac address, or undefined if not found.
|
|
120
|
-
*/
|
|
121
65
|
export function getMacAddress() {
|
|
122
66
|
for (const [interfaceName, interfaceDetails] of Object.entries(os.networkInterfaces())) {
|
|
123
67
|
if (!interfaceName || !interfaceDetails || interfaceDetails.length === 0)
|
|
@@ -128,14 +72,9 @@ export function getMacAddress() {
|
|
|
128
72
|
}
|
|
129
73
|
}
|
|
130
74
|
}
|
|
131
|
-
/**
|
|
132
|
-
* Logs the available network interfaces and their details.
|
|
133
|
-
*
|
|
134
|
-
* @returns {void}
|
|
135
|
-
*/
|
|
136
75
|
export function logInterfaces() {
|
|
137
|
-
const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4
|
|
138
|
-
log.logLevel = "info"
|
|
76
|
+
const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4, logLevel: "info" });
|
|
77
|
+
log.logLevel = "info";
|
|
139
78
|
log.logName = 'LogInterfaces';
|
|
140
79
|
log.info('Available Network Interfaces:');
|
|
141
80
|
const availableAddresses = Object.entries(os.networkInterfaces());
|
|
@@ -149,36 +88,16 @@ export function logInterfaces() {
|
|
|
149
88
|
}
|
|
150
89
|
}
|
|
151
90
|
}
|
|
152
|
-
/**
|
|
153
|
-
* Resolves the given hostname to an IP address.
|
|
154
|
-
*
|
|
155
|
-
* @param {string} hostname - The hostname to resolve.
|
|
156
|
-
* @param {0 | 4 | 6} [family] - The address family to use (0 for any, 4 for IPv4, 6 for IPv6). Default is 4.
|
|
157
|
-
* @returns {Promise<string | null>} - A promise that resolves to the IP address or null if not found.
|
|
158
|
-
*
|
|
159
|
-
* @remarks
|
|
160
|
-
* This function uses DNS lookup to resolve the hostname, which can take some time to complete.
|
|
161
|
-
*/
|
|
162
91
|
export async function resolveHostname(hostname, family = 4) {
|
|
163
92
|
const dns = await import('node:dns');
|
|
164
93
|
try {
|
|
165
|
-
const addresses = await dns.promises.lookup(hostname.toLowerCase()
|
|
94
|
+
const addresses = await dns.promises.lookup(hostname.toLowerCase(), { family });
|
|
166
95
|
return addresses.address;
|
|
167
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
168
96
|
}
|
|
169
97
|
catch (error) {
|
|
170
98
|
return null;
|
|
171
99
|
}
|
|
172
100
|
}
|
|
173
|
-
/**
|
|
174
|
-
* Retrieves the version of an npm package from the npm registry.
|
|
175
|
-
*
|
|
176
|
-
* @param {string} packageName - The name of the npm package.
|
|
177
|
-
* @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
|
|
178
|
-
* @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
|
|
179
|
-
* @returns {Promise<string>} A promise that resolves to the version string of the package.
|
|
180
|
-
* @throws {Error} If the request fails or the tag is not found.
|
|
181
|
-
*/
|
|
182
101
|
export async function getNpmPackageVersion(packageName, tag = 'latest', timeout = 10000) {
|
|
183
102
|
const https = await import('node:https');
|
|
184
103
|
return new Promise((resolve, reject) => {
|
|
@@ -192,7 +111,7 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
|
|
|
192
111
|
let data = '';
|
|
193
112
|
if (res.statusCode !== 200) {
|
|
194
113
|
clearTimeout(timeoutId);
|
|
195
|
-
res.resume();
|
|
114
|
+
res.resume();
|
|
196
115
|
reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
|
|
197
116
|
return;
|
|
198
117
|
}
|
|
@@ -203,7 +122,6 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
|
|
|
203
122
|
clearTimeout(timeoutId);
|
|
204
123
|
try {
|
|
205
124
|
const jsonData = JSON.parse(data);
|
|
206
|
-
// console.log(`Package ${packageName} tag ${tag}`, jsonData);
|
|
207
125
|
const version = jsonData['dist-tags']?.[tag];
|
|
208
126
|
if (version) {
|
|
209
127
|
resolve(version);
|
|
@@ -223,15 +141,6 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
|
|
|
223
141
|
});
|
|
224
142
|
});
|
|
225
143
|
}
|
|
226
|
-
/**
|
|
227
|
-
* Retrieves a file from the public directory of the Matterbridge GitHub repository.
|
|
228
|
-
*
|
|
229
|
-
* @param {string} branch - The branch from which to fetch the file.
|
|
230
|
-
* @param {string} file - The file path to fetch.
|
|
231
|
-
* @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
|
|
232
|
-
* @returns {Promise<Record<string, boolean | string | number>>} A promise that resolves to the parsed JSON object from the file.
|
|
233
|
-
* @throws {Error} If the request fails or the JSON parsing fails.
|
|
234
|
-
*/
|
|
235
144
|
export async function getGitHubUpdate(branch, file, timeout = 10000) {
|
|
236
145
|
const https = await import('node:https');
|
|
237
146
|
return new Promise((resolve, reject) => {
|
|
@@ -245,7 +154,7 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
|
|
|
245
154
|
let data = '';
|
|
246
155
|
if (res.statusCode !== 200) {
|
|
247
156
|
clearTimeout(timeoutId);
|
|
248
|
-
res.resume();
|
|
157
|
+
res.resume();
|
|
249
158
|
reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
|
|
250
159
|
return;
|
|
251
160
|
}
|
|
@@ -263,18 +172,12 @@ export async function getGitHubUpdate(branch, file, timeout = 10000) {
|
|
|
263
172
|
}
|
|
264
173
|
});
|
|
265
174
|
});
|
|
266
|
-
// istanbul ignore next cause it's just a precaution for network errors
|
|
267
175
|
req.on('error', (error) => {
|
|
268
176
|
clearTimeout(timeoutId);
|
|
269
177
|
reject(new Error(`Request failed: ${error instanceof Error ? error.message : error}`));
|
|
270
178
|
});
|
|
271
179
|
});
|
|
272
180
|
}
|
|
273
|
-
/**
|
|
274
|
-
* Retrieves the path to the global Node.js modules directory.
|
|
275
|
-
*
|
|
276
|
-
* @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
|
|
277
|
-
*/
|
|
278
181
|
export async function getGlobalNodeModules() {
|
|
279
182
|
const { exec } = await import('node:child_process');
|
|
280
183
|
return new Promise((resolve, reject) => {
|
|
@@ -288,4 +191,3 @@ export async function getGlobalNodeModules() {
|
|
|
288
191
|
});
|
|
289
192
|
});
|
|
290
193
|
}
|
|
291
|
-
//# sourceMappingURL=network.js.map
|
package/dist/utils/spawn.js
CHANGED
|
@@ -1,69 +1,28 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the spawn functions.
|
|
3
|
-
* @file spawn.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2025-02-16
|
|
6
|
-
* @version 1.2.0
|
|
7
|
-
* @license Apache-2.0
|
|
8
|
-
*
|
|
9
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
10
|
-
*
|
|
11
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
12
|
-
* you may not use this file except in compliance with the License.
|
|
13
|
-
* You may obtain a copy of the License at
|
|
14
|
-
*
|
|
15
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
-
*
|
|
17
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
18
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
-
* See the License for the specific language governing permissions and
|
|
21
|
-
* limitations under the License.
|
|
22
|
-
*/
|
|
23
1
|
import { AnsiLogger } from 'node-ansi-logger';
|
|
24
2
|
import { BroadcastServer } from '../broadcastServer.js';
|
|
25
3
|
import { hasParameter } from './commandLine.js';
|
|
26
|
-
/**
|
|
27
|
-
* Spawns a child process with the given command and arguments.
|
|
28
|
-
*
|
|
29
|
-
* @param {string} command - The command to execute.
|
|
30
|
-
* @param {string[]} args - The arguments to pass to the command (default: []).
|
|
31
|
-
* @param {'install' | 'uninstall'} packageCommand - The optional package command being executed (e.g., 'install', 'uninstall').
|
|
32
|
-
* @param {string} [packageName] - The optional name of the package being installed.
|
|
33
|
-
* @returns {Promise<boolean>} A promise that resolves to true if the command executed successfully, false otherwise.
|
|
34
|
-
*/
|
|
35
4
|
export async function spawnCommand(command, args, packageCommand, packageName) {
|
|
36
5
|
const { spawn } = await import('node:child_process');
|
|
37
|
-
/** Broadcast server */
|
|
38
6
|
const debug = hasParameter('debug') || hasParameter('verbose');
|
|
39
7
|
const verbose = hasParameter('verbose');
|
|
40
|
-
const log = new AnsiLogger({ logName: 'Spawn', logTimestampFormat: 4
|
|
8
|
+
const log = new AnsiLogger({ logName: 'Spawn', logTimestampFormat: 4, logLevel: debug ? "debug" : "info" });
|
|
41
9
|
const server = new BroadcastServer('spawn', log);
|
|
42
10
|
const sendLog = (name, message) => {
|
|
43
11
|
try {
|
|
44
12
|
server.request({ type: 'frontend_logmessage', src: 'spawn', dst: 'frontend', params: { level: 'spawn', time: log.now(), name, message } });
|
|
45
13
|
}
|
|
46
14
|
catch (err) {
|
|
47
|
-
// istanbul ignore next cause it's a precaution
|
|
48
15
|
log.debug(`Failed to send log message to frontend: ${err instanceof Error ? err.message : String(err)}`);
|
|
49
16
|
}
|
|
50
17
|
};
|
|
51
18
|
if (verbose)
|
|
52
19
|
log.debug(`Spawning command: ${command} with ${args.join(' ')} ${packageCommand} ${packageName}`);
|
|
53
|
-
/*
|
|
54
|
-
* npm > npm.cmd on windows
|
|
55
|
-
* cmd.exe ['dir'] on windows
|
|
56
|
-
*/
|
|
57
20
|
const cmdLine = command + ' ' + args.join(' ');
|
|
58
21
|
if (process.platform === 'win32' && command === 'npm') {
|
|
59
|
-
// Must be spawn('cmd.exe', ['/c', 'npm -g install <package>']);
|
|
60
22
|
const argstring = 'npm ' + args.join(' ');
|
|
61
23
|
args.splice(0, args.length, '/c', argstring);
|
|
62
24
|
command = 'cmd.exe';
|
|
63
25
|
}
|
|
64
|
-
// Decide when using sudo on linux and macOS
|
|
65
|
-
// When you need sudo: Spawn stderr: npm error Error: EACCES: permission denied
|
|
66
|
-
// When you don't need sudo: Failed to start child process "npm install -g matterbridge-eve-door": spawn sudo ENOENT
|
|
67
26
|
if (hasParameter('sudo') || (process.platform !== 'win32' && command === 'npm' && !hasParameter('docker') && !hasParameter('nosudo'))) {
|
|
68
27
|
args.unshift(command);
|
|
69
28
|
command = 'sudo';
|
|
@@ -119,20 +78,6 @@ export async function spawnCommand(command, args, packageCommand, packageName) {
|
|
|
119
78
|
sendLog('Matterbridge:spawn', line);
|
|
120
79
|
}
|
|
121
80
|
});
|
|
122
|
-
/*
|
|
123
|
-
childProcess.stdout.on('close', () => {
|
|
124
|
-
log.debug(`Spawn output (stdout): closed`);
|
|
125
|
-
resolve(true);
|
|
126
|
-
});
|
|
127
|
-
childProcess.stdout.on('end', () => {
|
|
128
|
-
log.debug(`Spawn output (stdout): ended`);
|
|
129
|
-
resolve(true);
|
|
130
|
-
});
|
|
131
|
-
childProcess.stdout.on('error', () => {
|
|
132
|
-
log.debug(`Spawn output (stdout): error`);
|
|
133
|
-
resolve(true);
|
|
134
|
-
});
|
|
135
|
-
*/
|
|
136
81
|
}
|
|
137
82
|
if (childProcess.stderr) {
|
|
138
83
|
childProcess.stderr.on('data', (data) => {
|
|
@@ -143,23 +88,8 @@ export async function spawnCommand(command, args, packageCommand, packageName) {
|
|
|
143
88
|
sendLog('Matterbridge:spawn', line);
|
|
144
89
|
}
|
|
145
90
|
});
|
|
146
|
-
/*
|
|
147
|
-
childProcess.stderr.on('close', () => {
|
|
148
|
-
log.debug(`Spawn verbose (stderr): closed`);
|
|
149
|
-
resolve(true);
|
|
150
|
-
});
|
|
151
|
-
childProcess.stderr.on('end', () => {
|
|
152
|
-
log.debug(`Spawn verbose (stderr): ended`);
|
|
153
|
-
resolve(true);
|
|
154
|
-
});
|
|
155
|
-
childProcess.stderr.on('error', () => {
|
|
156
|
-
log.debug(`Spawn verbose (stderr): error`);
|
|
157
|
-
resolve(true);
|
|
158
|
-
});
|
|
159
|
-
*/
|
|
160
91
|
}
|
|
161
92
|
});
|
|
162
93
|
server.close();
|
|
163
94
|
return success;
|
|
164
95
|
}
|
|
165
|
-
//# sourceMappingURL=spawn.js.map
|
package/dist/utils/tracker.js
CHANGED
|
@@ -1,27 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file contains the Tracker class.
|
|
3
|
-
*
|
|
4
|
-
* @file tracker.ts
|
|
5
|
-
* @author Luca Liguori
|
|
6
|
-
* @created 2025-10-10
|
|
7
|
-
* @version 1.0.0
|
|
8
|
-
* @license Apache-2.0
|
|
9
|
-
*
|
|
10
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
11
|
-
*
|
|
12
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
13
|
-
* you may not use this file except in compliance with the License.
|
|
14
|
-
* You may obtain a copy of the License at
|
|
15
|
-
*
|
|
16
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
17
|
-
*
|
|
18
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
19
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
20
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
21
|
-
* See the License for the specific language governing permissions and
|
|
22
|
-
* limitations under the License.
|
|
23
|
-
*/
|
|
24
|
-
/* eslint-disable no-console */
|
|
25
1
|
if (process.argv.includes('--loader') || process.argv.includes('-loader'))
|
|
26
2
|
console.log('\u001B[32mTracker loaded.\u001B[40;0m');
|
|
27
3
|
import os from 'node:os';
|
|
@@ -34,7 +10,6 @@ export class Tracker extends EventEmitter {
|
|
|
34
10
|
verbose;
|
|
35
11
|
trackerInterval;
|
|
36
12
|
static historyIndex = 0;
|
|
37
|
-
// History for 8h at 1 sample each 10 seconds = 2880 entries
|
|
38
13
|
static historySize = 2880;
|
|
39
14
|
static history = Array.from({ length: this.historySize }, () => ({
|
|
40
15
|
timestamp: 0,
|
|
@@ -71,7 +46,7 @@ export class Tracker extends EventEmitter {
|
|
|
71
46
|
if (process.argv.includes('--verbose') || process.argv.includes('-verbose')) {
|
|
72
47
|
this.verbose = true;
|
|
73
48
|
}
|
|
74
|
-
this.log = new AnsiLogger({ logName: name, logTimestampFormat: 4
|
|
49
|
+
this.log = new AnsiLogger({ logName: name, logTimestampFormat: 4, logLevel: this.debug ? "debug" : "info" });
|
|
75
50
|
this.log.logNameColor = YELLOW;
|
|
76
51
|
if (this.verbose) {
|
|
77
52
|
this.log.debug(`os.cpus():\n${RESET}`, os.cpus());
|
|
@@ -91,11 +66,6 @@ export class Tracker extends EventEmitter {
|
|
|
91
66
|
this.runGarbageCollector();
|
|
92
67
|
});
|
|
93
68
|
}
|
|
94
|
-
/**
|
|
95
|
-
* Start tracking cpu and memory usage with a given interval in ms
|
|
96
|
-
*
|
|
97
|
-
* @param {number} sampleIntervalMs Sample interval in milliseconds. Default is 10000 (10 seconds).
|
|
98
|
-
*/
|
|
99
69
|
start(sampleIntervalMs = 10000) {
|
|
100
70
|
if (this.trackerInterval)
|
|
101
71
|
return;
|
|
@@ -104,21 +74,15 @@ export class Tracker extends EventEmitter {
|
|
|
104
74
|
this.prevCpus = os.cpus();
|
|
105
75
|
this.prevCpuUsage = process.cpuUsage();
|
|
106
76
|
this.trackerInterval = setInterval(() => {
|
|
107
|
-
// Increment tryGcCount and check if we can run garbage collector each hour cause memory might grow over time because of our even small allocations
|
|
108
77
|
tryGcCount += sampleIntervalMs / 1000;
|
|
109
78
|
if (tryGcCount > 60 * 60) {
|
|
110
79
|
this.runGarbageCollector();
|
|
111
80
|
tryGcCount = 0;
|
|
112
81
|
}
|
|
113
|
-
// Get current history entry in circular buffer
|
|
114
82
|
const entry = Tracker.history[Tracker.historyIndex];
|
|
115
|
-
// Get previous history entry in circular buffer
|
|
116
83
|
const prevEntry = Tracker.history[(Tracker.historyIndex + Tracker.historySize - 1) % Tracker.historySize];
|
|
117
|
-
// Set the timestamp
|
|
118
84
|
entry.timestamp = Date.now();
|
|
119
|
-
// Emit uptime event
|
|
120
85
|
this.emit('uptime', os.uptime(), process.uptime());
|
|
121
|
-
// Track CPU usage
|
|
122
86
|
const currentCpus = os.cpus();
|
|
123
87
|
const loads = currentCpus.map((cpu, idx) => {
|
|
124
88
|
const prev = this.prevCpus[idx]?.times;
|
|
@@ -130,7 +94,6 @@ export class Tracker extends EventEmitter {
|
|
|
130
94
|
const totalDelta = busyDelta + idleDelta;
|
|
131
95
|
if (totalDelta <= 0)
|
|
132
96
|
return 0;
|
|
133
|
-
// istanbul ignore next cause is practically impossible to hit this branch
|
|
134
97
|
return busyDelta / totalDelta;
|
|
135
98
|
});
|
|
136
99
|
this.prevCpus = currentCpus;
|
|
@@ -138,16 +101,13 @@ export class Tracker extends EventEmitter {
|
|
|
138
101
|
const osCpu = Number((avgLoad * 100).toFixed(2));
|
|
139
102
|
entry.osCpu = osCpu;
|
|
140
103
|
entry.peakOsCpu = Math.max(prevEntry.peakOsCpu, osCpu);
|
|
141
|
-
// Track process CPU usage
|
|
142
104
|
const diff = process.cpuUsage(this.prevCpuUsage);
|
|
143
105
|
this.prevCpuUsage = process.cpuUsage();
|
|
144
106
|
const totalMs = (diff.user + diff.system) / 1000;
|
|
145
107
|
const processCpu = Number((((totalMs / sampleIntervalMs) * 100) / currentCpus.length).toFixed(2));
|
|
146
108
|
entry.processCpu = processCpu;
|
|
147
109
|
entry.peakProcessCpu = Math.max(prevEntry.peakProcessCpu, processCpu);
|
|
148
|
-
// Emit cpu event
|
|
149
110
|
this.emit('cpu', entry.osCpu, entry.processCpu);
|
|
150
|
-
// Track memory usage
|
|
151
111
|
entry.freeMemory = os.freemem();
|
|
152
112
|
entry.peakFreeMemory = Math.max(prevEntry.peakFreeMemory, entry.freeMemory);
|
|
153
113
|
entry.totalMemory = os.totalmem();
|
|
@@ -164,9 +124,7 @@ export class Tracker extends EventEmitter {
|
|
|
164
124
|
entry.arrayBuffers = mem.arrayBuffers;
|
|
165
125
|
entry.peakArrayBuffers = Math.max(prevEntry.peakArrayBuffers, mem.arrayBuffers);
|
|
166
126
|
this.emit('memory', entry.freeMemory, entry.totalMemory, entry.rss, entry.heapUsed, entry.heapTotal, entry.external, entry.arrayBuffers);
|
|
167
|
-
// Emit tracker event with current snapshot
|
|
168
127
|
this.emit('snapshot', entry);
|
|
169
|
-
// Debug output
|
|
170
128
|
if (this.debug) {
|
|
171
129
|
this.log.debug(`Time: ${formatTimeStamp(entry.timestamp)} ` +
|
|
172
130
|
`os ${CYAN}${BRIGHT}${formatPercent(entry.osCpu)}${RESET}${db} (${entry.peakOsCpu > prevEntry.peakOsCpu ? RED : ''}${formatPercent(entry.peakOsCpu)}${db}) ` +
|
|
@@ -177,14 +135,10 @@ export class Tracker extends EventEmitter {
|
|
|
177
135
|
`external: ${CYAN}${BRIGHT}${formatBytes(entry.external)}${RESET}${db} (${entry.peakExternal > prevEntry.peakExternal ? RED : ''}${formatBytes(entry.peakExternal)}${db}) ` +
|
|
178
136
|
`arrayBuffers: ${CYAN}${BRIGHT}${formatBytes(entry.arrayBuffers)}${RESET}${db} (${entry.peakArrayBuffers > prevEntry.peakArrayBuffers ? RED : ''}${formatBytes(entry.peakArrayBuffers)}${db})`);
|
|
179
137
|
}
|
|
180
|
-
// Move to next history index of circular buffer
|
|
181
138
|
Tracker.historyIndex = (Tracker.historyIndex + 1) % Tracker.historySize;
|
|
182
139
|
}, sampleIntervalMs);
|
|
183
140
|
this.log.debug(`Tracker started`);
|
|
184
141
|
}
|
|
185
|
-
/**
|
|
186
|
-
* Reset peak values to the currently stored values
|
|
187
|
-
*/
|
|
188
142
|
resetPeaks() {
|
|
189
143
|
const prevHistoryIndex = (Tracker.historyIndex + Tracker.historySize - 1) % Tracker.historySize;
|
|
190
144
|
Tracker.history[prevHistoryIndex].peakOsCpu = 0;
|
|
@@ -198,17 +152,6 @@ export class Tracker extends EventEmitter {
|
|
|
198
152
|
this.log.debug(`${CYAN}${BRIGHT}Peaks reset at ${new Date(Date.now()).toLocaleString()}.${RESET}${db}`);
|
|
199
153
|
this.emit('reset_peaks_done');
|
|
200
154
|
}
|
|
201
|
-
/**
|
|
202
|
-
* Manually trigger garbage collection to free memory (if exposed with --expose-gc)
|
|
203
|
-
*
|
|
204
|
-
* @param {'major' | 'minor'} type - The type of garbage collection to perform ('major' or 'minor'). Default is 'major'.
|
|
205
|
-
* @param {'sync' | 'async'} execution - The execution mode of garbage collection ('sync' or 'async'). Default is 'async'.
|
|
206
|
-
*
|
|
207
|
-
* @remarks
|
|
208
|
-
* - major collection refers to old-generation mark-sweep/mark-compact cycles.
|
|
209
|
-
* - minor collection refers to young-generation collections (scavenges).
|
|
210
|
-
* - sync execution blocks the main thread until GC is complete, which can cause pauses.
|
|
211
|
-
*/
|
|
212
155
|
runGarbageCollector(type = 'major', execution = 'async') {
|
|
213
156
|
if (global.gc && typeof global.gc === 'function') {
|
|
214
157
|
try {
|
|
@@ -229,20 +172,15 @@ export class Tracker extends EventEmitter {
|
|
|
229
172
|
this.log.debug(`${CYAN}${BRIGHT}Garbage collection not exposed. Start Node.js with --expose-gc to enable manual garbage collection.${RESET}${db}`);
|
|
230
173
|
}
|
|
231
174
|
}
|
|
232
|
-
/**
|
|
233
|
-
* Stop tracking, clear interval, log history
|
|
234
|
-
*/
|
|
235
175
|
stop() {
|
|
236
176
|
this.log.debug(`Tracker stopping...`);
|
|
237
177
|
if (this.trackerInterval) {
|
|
238
178
|
clearInterval(this.trackerInterval);
|
|
239
179
|
this.trackerInterval = undefined;
|
|
240
180
|
}
|
|
241
|
-
// Log all history entries
|
|
242
181
|
if (this.debug) {
|
|
243
182
|
this.log.debug(`Tracker history for ${YELLOW}${BRIGHT}${this.name}:${RESET}`);
|
|
244
183
|
this.log.debug('Timestamp Host cpu Process cpu Rss Heap Used Heap Total External ArrayBuffers');
|
|
245
|
-
// 10/10/2025, 20:52:12 4.76 % ( 4.76 %) 0.16 % ( 0.16 %) 38.45 MB ( 38.45 MB) 3.75 MB ( 3.75 MB) 5.29 MB ( 5.29 MB) 1.66 MB ( 1.66 MB) 10.25 KB ( 10.25 KB)
|
|
246
184
|
for (let i = 0; i < Tracker.historySize; i++) {
|
|
247
185
|
const index = (Tracker.historyIndex + i) % Tracker.historySize;
|
|
248
186
|
const entry = Tracker.history[index];
|
|
@@ -261,4 +199,3 @@ export class Tracker extends EventEmitter {
|
|
|
261
199
|
this.log.debug(`Tracker stopped`);
|
|
262
200
|
}
|
|
263
201
|
}
|
|
264
|
-
//# sourceMappingURL=tracker.js.map
|