matterbridge 3.4.2 → 3.4.3-dev-20251207-3ce5a0e
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 +25 -0
- package/README-SERVICE-LOCAL.md +3 -3
- package/README-SERVICE-OPT.md +3 -5
- package/README.md +8 -14
- package/dist/broadcastServer.js +0 -119
- package/dist/broadcastServerTypes.js +0 -24
- package/dist/cli.js +3 -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 +15 -80
- package/dist/dgram/mdns.js +137 -299
- package/dist/dgram/multicast.js +1 -62
- package/dist/dgram/unicast.js +0 -54
- package/dist/frontend.js +35 -455
- 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 +54 -817
- 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 -1444
- 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 -96
- 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/frontend/build/assets/index.js +4 -4
- package/frontend/build/assets/vendor_mui.js +1 -1
- package/frontend/package.json +1 -1
- package/npm-shrinkwrap.json +8 -7
- package/package.json +3 -4
- package/scripts/marked.mjs +132 -0
- package/scripts/markedFooter.html +42 -0
- package/scripts/markedHeader.html +78 -0
- 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 -141
- 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 -290
- package/dist/dgram/mdns.d.ts.map +0 -1
- package/dist/dgram/mdns.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 -56
- package/dist/dgram/unicast.d.ts.map +0 -1
- package/dist/dgram/unicast.js.map +0 -1
- package/dist/frontend.d.ts +0 -238
- 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 -492
- 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 -251
- 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 -111
- 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/deepEqual.js
CHANGED
|
@@ -1,89 +1,23 @@
|
|
|
1
|
-
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
2
|
-
/**
|
|
3
|
-
* This file contains the deepEqual function.
|
|
4
|
-
*
|
|
5
|
-
* @file deepEqual.ts
|
|
6
|
-
* @author Luca Liguori
|
|
7
|
-
* @created 2025-02-16
|
|
8
|
-
* @version 1.0.0
|
|
9
|
-
* @license Apache-2.0
|
|
10
|
-
*
|
|
11
|
-
* Copyright 2025, 2026, 2027 Luca Liguori.
|
|
12
|
-
*
|
|
13
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
14
|
-
* you may not use this file except in compliance with the License.
|
|
15
|
-
* You may obtain a copy of the License at
|
|
16
|
-
*
|
|
17
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
18
|
-
*
|
|
19
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
20
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
21
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
22
|
-
* See the License for the specific language governing permissions and
|
|
23
|
-
* limitations under the License.
|
|
24
|
-
*/
|
|
25
|
-
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
26
|
-
/**
|
|
27
|
-
* Performs a deep comparison between two values to determine if they are equivalent.
|
|
28
|
-
* This comparison includes primitive types, arrays, and objects, allowing for optional
|
|
29
|
-
* exclusion of specific properties from the comparison in objects.
|
|
30
|
-
*
|
|
31
|
-
* @param {any} a The first value to compare.
|
|
32
|
-
* @param {any} b The second value to compare.
|
|
33
|
-
* @param {string[]} [excludeProperties] An array of property names to exclude from the comparison in objects.
|
|
34
|
-
* @returns {boolean} True if the values are deeply equal, excluding any specified properties; otherwise, false.
|
|
35
|
-
*
|
|
36
|
-
* Note: This function utilizes recursion for deep comparison of nested structures and includes a debugging
|
|
37
|
-
* mechanism that can be toggled on or off for detailed comparison logging. It is important to ensure that
|
|
38
|
-
* objects do not contain circular references when enabling debug logging to avoid infinite loops.
|
|
39
|
-
*
|
|
40
|
-
* Example usage:
|
|
41
|
-
* ```
|
|
42
|
-
* const obj1 = { a: 1, b: { c: 2 } };
|
|
43
|
-
* const obj2 = { a: 1, b: { c: 2 } };
|
|
44
|
-
* console.log(deepEqual(obj1, obj2)); // true
|
|
45
|
-
*
|
|
46
|
-
* const arr1 = [1, 2, [3, 4]];
|
|
47
|
-
* const arr2 = [1, 2, [3, 4]];
|
|
48
|
-
* console.log(deepEqual(arr1, arr2)); // true
|
|
49
|
-
*
|
|
50
|
-
* const obj3 = { a: 1, b: { c: 2, d: 3 } };
|
|
51
|
-
* const obj4 = { a: 1, b: { c: 2 } };
|
|
52
|
-
* console.log(deepEqual(obj3, obj4, ['d'])); // true, excluding property 'd' from comparison
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
1
|
export function deepEqual(a, b, excludeProperties = []) {
|
|
56
|
-
// Toggle debugging on or off easily
|
|
57
|
-
// const debug = false;
|
|
58
|
-
// Helper function for conditional logging
|
|
59
2
|
const debugLog = (...messages) => {
|
|
60
|
-
// if (debug) {
|
|
61
|
-
// console.log(...messages);
|
|
62
|
-
// }
|
|
63
3
|
};
|
|
64
|
-
// If both are the same instance, return true (handles primitives and same object references)
|
|
65
4
|
if (a === b) {
|
|
66
5
|
return true;
|
|
67
6
|
}
|
|
68
|
-
// If types are different, return false
|
|
69
7
|
if (typeof a !== typeof b) {
|
|
70
8
|
debugLog(`deepEqual false for typeof a: ${typeof a} typeof b: ${typeof b}`);
|
|
71
9
|
return false;
|
|
72
10
|
}
|
|
73
|
-
// If one of them is null (and we know they are not equal from the first check), return false
|
|
74
11
|
if (a == null || b == null) {
|
|
75
12
|
debugLog('deepEqual false for == null');
|
|
76
13
|
return false;
|
|
77
14
|
}
|
|
78
|
-
// Handle Dates compare by timestamp
|
|
79
15
|
if (a instanceof Date && b instanceof Date) {
|
|
80
16
|
return a.getTime() === b.getTime();
|
|
81
17
|
}
|
|
82
|
-
// Handle Regexps compare by their source & flags
|
|
83
18
|
if (a instanceof RegExp && b instanceof RegExp) {
|
|
84
19
|
return a.source === b.source && a.flags === b.flags;
|
|
85
20
|
}
|
|
86
|
-
// Handle Arrays
|
|
87
21
|
if (Array.isArray(a) && Array.isArray(b)) {
|
|
88
22
|
if (a.length !== b.length) {
|
|
89
23
|
debugLog(`deepEqual false for array a.length(${a.length}) !== b.length(${b.length})`);
|
|
@@ -99,31 +33,26 @@ export function deepEqual(a, b, excludeProperties = []) {
|
|
|
99
33
|
}
|
|
100
34
|
return true;
|
|
101
35
|
}
|
|
102
|
-
// Handle Objects (and exclude null, functions, and arrays)
|
|
103
36
|
if (typeof a === 'object' && typeof b === 'object') {
|
|
104
37
|
const aProps = Object.getOwnPropertyNames(a).filter((prop) => !excludeProperties.includes(prop));
|
|
105
38
|
const bProps = Object.getOwnPropertyNames(b).filter((prop) => !excludeProperties.includes(prop));
|
|
106
|
-
// If their property lengths are different, they're different objects
|
|
107
39
|
if (aProps.length !== bProps.length) {
|
|
108
40
|
debugLog(`deepEqual false for aProps.length(${aProps.length}) !== bProps.length(${bProps.length})`);
|
|
109
41
|
debugLog(`- aProps.length(${aProps.length}):`, aProps);
|
|
110
42
|
debugLog(`- bProps.length(${bProps.length}):`, bProps);
|
|
111
43
|
return false;
|
|
112
44
|
}
|
|
113
|
-
// Check each property in 'a' to see if it's in 'b' and if it's equal (deep check)
|
|
114
45
|
for (const prop of aProps) {
|
|
115
46
|
if (!Object.prototype.hasOwnProperty.call(b, prop)) {
|
|
116
47
|
debugLog(`deepEqual false for !b.hasOwnProperty(${prop})`);
|
|
117
48
|
return false;
|
|
118
49
|
}
|
|
119
50
|
if (!deepEqual(a[prop], b[prop], excludeProperties)) {
|
|
120
|
-
debugLog(`deepEqual false for !deepEqual(a[${prop}], b[${prop}])`
|
|
51
|
+
debugLog(`deepEqual false for !deepEqual(a[${prop}], b[${prop}])`);
|
|
121
52
|
return false;
|
|
122
53
|
}
|
|
123
54
|
}
|
|
124
55
|
return true;
|
|
125
56
|
}
|
|
126
|
-
// If none of the above, the objects are not equal
|
|
127
57
|
return false;
|
|
128
58
|
}
|
|
129
|
-
//# sourceMappingURL=deepEqual.js.map
|
package/dist/utils/error.js
CHANGED
|
@@ -1,49 +1,8 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file contains the error functions.
|
|
3
|
-
*
|
|
4
|
-
* @file error.ts
|
|
5
|
-
* @author Luca Liguori
|
|
6
|
-
* @created 2025-07-17
|
|
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
1
|
import { inspect } from 'node:util';
|
|
25
2
|
import { RESET } from 'node-ansi-logger';
|
|
26
|
-
/**
|
|
27
|
-
* Logs an error message using the provided AnsiLogger instance.
|
|
28
|
-
*
|
|
29
|
-
* @param {AnsiLogger} log - The AnsiLogger instance to use for logging.
|
|
30
|
-
* @param {string} message - The error message to log.
|
|
31
|
-
* @param {unknown} error - The error object or value to log. If it's an Error instance,
|
|
32
|
-
* its message and stack trace will be included in the log.
|
|
33
|
-
*/
|
|
34
3
|
export function logError(log, message, error) {
|
|
35
4
|
log.error(`${message}: ${error instanceof Error ? error.message + ' \nStack: \n' + error.stack : error}`);
|
|
36
5
|
}
|
|
37
|
-
/**
|
|
38
|
-
* Logs an error message using the provided AnsiLogger instance with detailed inspection.
|
|
39
|
-
* Uses util.inspect to get a detailed view of the error with a stack depth of 10 levels.
|
|
40
|
-
* If the error is an Error instance, it also includes the error message.
|
|
41
|
-
*
|
|
42
|
-
* @param {AnsiLogger} log - The AnsiLogger instance to use for logging.
|
|
43
|
-
* @param {string} message - The error message to log.
|
|
44
|
-
* @param {unknown} error - The error object or value to log. Will be inspected with depth 10.
|
|
45
|
-
* @returns {string} - The full logged message.
|
|
46
|
-
*/
|
|
47
6
|
export function inspectError(log, message, error) {
|
|
48
7
|
const errorMessage = error instanceof Error ? `${error.message} \n` : '';
|
|
49
8
|
const inspectedError = inspect(error, { depth: 10, colors: true, showHidden: false });
|
|
@@ -51,4 +10,3 @@ export function inspectError(log, message, error) {
|
|
|
51
10
|
log.error(fullMessage);
|
|
52
11
|
return fullMessage;
|
|
53
12
|
}
|
|
54
|
-
//# sourceMappingURL=error.js.map
|
package/dist/utils/export.js
CHANGED
package/dist/utils/format.js
CHANGED
|
@@ -1,51 +1,9 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @description This file contains the format functions.
|
|
3
|
-
* @file format.ts
|
|
4
|
-
* @author Luca Liguori
|
|
5
|
-
* @created 2025-10-20
|
|
6
|
-
* @version 1.0.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
|
-
/**
|
|
24
|
-
* Format a timestamp into a human-readable string.
|
|
25
|
-
*
|
|
26
|
-
* @param {number} timestamp - The timestamp in milliseconds since the Unix epoch.
|
|
27
|
-
* @returns {string} - The formatted timestamp.
|
|
28
|
-
*/
|
|
29
1
|
export function formatTimeStamp(timestamp) {
|
|
30
2
|
return `${new Date(timestamp).toLocaleString()}`;
|
|
31
3
|
}
|
|
32
|
-
/**
|
|
33
|
-
* Format a percentage into a human-readable string.
|
|
34
|
-
*
|
|
35
|
-
* @param {number} percent - The percentage value.
|
|
36
|
-
* @param {number} digits - The number of decimal places.
|
|
37
|
-
* @returns {string} - The formatted percentage.
|
|
38
|
-
*/
|
|
39
4
|
export function formatPercent(percent, digits = 2) {
|
|
40
5
|
return `${percent.toFixed(digits)} %`;
|
|
41
6
|
}
|
|
42
|
-
/**
|
|
43
|
-
* Format bytes into a human-readable string.
|
|
44
|
-
*
|
|
45
|
-
* @param {number} bytes - The number of bytes.
|
|
46
|
-
* @param {number} digits - The number of decimal places.
|
|
47
|
-
* @returns {string} - The formatted byte string.
|
|
48
|
-
*/
|
|
49
7
|
export function formatBytes(bytes, digits = 2) {
|
|
50
8
|
if (bytes === 0)
|
|
51
9
|
return `${bytes.toFixed(digits)} B`;
|
|
@@ -54,12 +12,6 @@ export function formatBytes(bytes, digits = 2) {
|
|
|
54
12
|
const value = bytes / Math.pow(1024, idx);
|
|
55
13
|
return `${value.toFixed(digits)} ${units[idx]}`;
|
|
56
14
|
}
|
|
57
|
-
/**
|
|
58
|
-
* Function to format system uptime with only the most significant unit
|
|
59
|
-
*
|
|
60
|
-
* @param {number} seconds - The number of seconds to format
|
|
61
|
-
* @returns {string} The formatted uptime string
|
|
62
|
-
*/
|
|
63
15
|
export function formatUptime(seconds) {
|
|
64
16
|
if (seconds >= 86400) {
|
|
65
17
|
const days = Math.floor(seconds / 86400);
|
|
@@ -75,4 +27,3 @@ export function formatUptime(seconds) {
|
|
|
75
27
|
}
|
|
76
28
|
return `${seconds} second${seconds !== 1 ? 's' : ''}`;
|
|
77
29
|
}
|
|
78
|
-
//# sourceMappingURL=format.js.map
|
package/dist/utils/hex.js
CHANGED
|
@@ -1,114 +1,39 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file contains the hex functions.
|
|
3
|
-
*
|
|
4
|
-
* @file hex.ts
|
|
5
|
-
* @author Luca Liguori
|
|
6
|
-
* @created 2025-05-06
|
|
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
1
|
import { createPublicKey, createPrivateKey, X509Certificate } from 'node:crypto';
|
|
25
|
-
/**
|
|
26
|
-
* Converts an ArrayBuffer or Uint8Array to a hexadecimal string.
|
|
27
|
-
*
|
|
28
|
-
* Accepts any {ArrayBufferLike} input: a raw ArrayBuffer (binary data storage) or
|
|
29
|
-
* a Uint8Array (TypedArray view over an ArrayBuffer). While an ArrayBuffer holds
|
|
30
|
-
* the raw memory, a Uint8Array is a typed view into that memory, letting you access
|
|
31
|
-
* its bytes directly. This function normalizes both by creating a Uint8Array view
|
|
32
|
-
* before conversion.
|
|
33
|
-
*
|
|
34
|
-
* @param {ArrayBufferLike} buffer - The buffer or typed-array view to convert.
|
|
35
|
-
* @returns {string} A lowercase hex string representation of the buffer's bytes.
|
|
36
|
-
*
|
|
37
|
-
* @throws {TypeError} If the input is not an ArrayBuffer or ArrayBufferView.
|
|
38
|
-
*/
|
|
39
2
|
export function bufferToHex(buffer) {
|
|
40
|
-
// Check if the input is an ArrayBuffer or ArrayBufferView
|
|
41
3
|
if (!(buffer instanceof ArrayBuffer || ArrayBuffer.isView(buffer))) {
|
|
42
4
|
throw new TypeError('Expected input to be an ArrayBuffer or ArrayBufferView');
|
|
43
5
|
}
|
|
44
|
-
// Create a Uint8Array view over the buffer
|
|
45
6
|
const bytes = buffer instanceof Uint8Array ? buffer : new Uint8Array(buffer);
|
|
46
|
-
// Convert each byte to 2-digit hex
|
|
47
7
|
return Array.from(bytes)
|
|
48
8
|
.map((byte) => byte.toString(16).padStart(2, '0'))
|
|
49
9
|
.join('');
|
|
50
10
|
}
|
|
51
|
-
/**
|
|
52
|
-
* Converts a hexadecimal string to a Uint8Array.
|
|
53
|
-
*
|
|
54
|
-
* @param {string} hex - The hex string to convert. Can include uppercase or lowercase characters.
|
|
55
|
-
* @returns {Uint8Array} A Uint8Array representing the corresponding binary data.
|
|
56
|
-
*
|
|
57
|
-
* @throws {TypeError} If the input is not a string.
|
|
58
|
-
* @throws {Error} If the input length is odd or contains non-hex characters.
|
|
59
|
-
*/
|
|
60
11
|
export function hexToBuffer(hex) {
|
|
61
|
-
// Ensure the input is a string
|
|
62
12
|
if (typeof hex !== 'string') {
|
|
63
13
|
throw new TypeError('Expected a string for hex input');
|
|
64
14
|
}
|
|
65
|
-
// Trim any whitespace from the input string
|
|
66
15
|
const cleaned = hex.trim();
|
|
67
|
-
// Check if the length of the hex string is even
|
|
68
16
|
if (cleaned.length % 2 !== 0) {
|
|
69
17
|
throw new Error('Invalid hex string length, must be even');
|
|
70
18
|
}
|
|
71
|
-
// Validate that the string contains only valid hex characters
|
|
72
19
|
if (!/^[0-9a-fA-F]*$/.test(cleaned)) {
|
|
73
20
|
throw new Error('Invalid hex string, contains non-hex characters');
|
|
74
21
|
}
|
|
75
|
-
// Calculate the length of the resulting Uint8Array
|
|
76
22
|
const length = cleaned.length / 2;
|
|
77
|
-
// Create a Uint8Array to hold the binary data
|
|
78
23
|
const result = new Uint8Array(length);
|
|
79
|
-
// Convert each pair of hex characters into a byte
|
|
80
24
|
for (let i = 0; i < length; i++) {
|
|
81
25
|
result[i] = parseInt(cleaned.substr(i * 2, 2), 16);
|
|
82
26
|
}
|
|
83
|
-
// Return the resulting Uint8Array
|
|
84
27
|
return result;
|
|
85
28
|
}
|
|
86
|
-
/**
|
|
87
|
-
* Converts a PEM (Privacy-Enhanced Mail) formatted string to a Uint8Array.
|
|
88
|
-
*
|
|
89
|
-
* PEM format is a base64-encoded format commonly used for cryptographic keys and certificates,
|
|
90
|
-
* wrapped with header and footer lines like "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----".
|
|
91
|
-
* This function extracts the base64 content and converts it to binary data using Node.js Buffer API.
|
|
92
|
-
*
|
|
93
|
-
* @param {string} pem - The PEM formatted string to convert.
|
|
94
|
-
* @param {boolean} validate - Whether to validate the PEM content using Node.js crypto module. Default is false.
|
|
95
|
-
* @returns {Uint8Array} A Uint8Array representing the decoded binary data.
|
|
96
|
-
*
|
|
97
|
-
* @throws {TypeError} If the input is not a string.
|
|
98
|
-
* @throws {Error} If the PEM format is invalid, contains invalid base64 characters, or validation fails.
|
|
99
|
-
*/
|
|
100
29
|
export function pemToBuffer(pem, validate = false) {
|
|
101
|
-
// Ensure the input is a string
|
|
102
30
|
if (typeof pem !== 'string') {
|
|
103
31
|
throw new TypeError('Expected a string for PEM input');
|
|
104
32
|
}
|
|
105
|
-
// Trim whitespace from the input
|
|
106
33
|
const cleaned = pem.trim();
|
|
107
|
-
// Check if the string appears to be in PEM format
|
|
108
34
|
if (!cleaned.includes('-----BEGIN') || !cleaned.includes('-----END')) {
|
|
109
35
|
throw new Error('Invalid PEM format: missing BEGIN/END markers');
|
|
110
36
|
}
|
|
111
|
-
// Extract the base64 content between the header and footer
|
|
112
37
|
const lines = cleaned.split('\n');
|
|
113
38
|
const base64Lines = [];
|
|
114
39
|
let inContent = false;
|
|
@@ -129,114 +54,65 @@ export function pemToBuffer(pem, validate = false) {
|
|
|
129
54
|
if (base64Lines.length === 0) {
|
|
130
55
|
throw new Error('Invalid PEM format: no content found between BEGIN/END markers');
|
|
131
56
|
}
|
|
132
|
-
// Join all base64 lines together
|
|
133
57
|
const base64String = base64Lines.join('');
|
|
134
|
-
// Validate base64 string format
|
|
135
58
|
if (!/^[A-Za-z0-9+/]*={0,2}$/.test(base64String)) {
|
|
136
59
|
throw new Error('Invalid PEM format: contains invalid base64 characters');
|
|
137
60
|
}
|
|
138
61
|
try {
|
|
139
|
-
// Use Node.js Buffer API instead of legacy atob()
|
|
140
62
|
const buffer = Buffer.from(base64String, 'base64');
|
|
141
|
-
// Convert Buffer to Uint8Array
|
|
142
63
|
const result = new Uint8Array(buffer);
|
|
143
|
-
// Validate PEM content using Node.js crypto module if requested
|
|
144
64
|
if (validate) {
|
|
145
65
|
try {
|
|
146
|
-
// Determine PEM type from the header and validate accordingly
|
|
147
66
|
const pemType = cleaned.match(/-----BEGIN\s+([^-]+)-----/)?.[1]?.trim();
|
|
148
67
|
if (pemType?.includes('CERTIFICATE')) {
|
|
149
|
-
// Use X509Certificate for robust certificate validation
|
|
150
68
|
const cert = new X509Certificate(pem);
|
|
151
|
-
// Check validity period
|
|
152
69
|
if (cert.validFrom && cert.validTo) {
|
|
153
70
|
const now = Date.now();
|
|
154
71
|
const from = Date.parse(cert.validFrom);
|
|
155
72
|
const to = Date.parse(cert.validTo);
|
|
156
|
-
// istanbul ignore next if
|
|
157
73
|
if (now < from || now > to) {
|
|
158
74
|
throw new Error('Certificate is not currently valid');
|
|
159
75
|
}
|
|
160
76
|
}
|
|
161
|
-
// Check subject/issuer fields
|
|
162
|
-
// istanbul ignore next if
|
|
163
77
|
if (!cert.subject || !cert.issuer) {
|
|
164
78
|
throw new Error('Certificate missing subject or issuer');
|
|
165
79
|
}
|
|
166
|
-
// Optionally check signature (not possible without CA chain)
|
|
167
80
|
}
|
|
168
81
|
else if (pemType?.includes('PRIVATE KEY')) {
|
|
169
|
-
// For private keys, try to create a private key
|
|
170
82
|
createPrivateKey({ key: pem, format: 'pem' });
|
|
171
83
|
}
|
|
172
84
|
else if (pemType?.includes('PUBLIC KEY')) {
|
|
173
|
-
// For public keys, try to create a public key
|
|
174
85
|
createPublicKey({ key: pem, format: 'pem' });
|
|
175
86
|
}
|
|
176
|
-
// If no specific type is detected, skip validation
|
|
177
87
|
}
|
|
178
88
|
catch (validationError) {
|
|
179
|
-
// istanbul ignore next
|
|
180
89
|
throw new Error(`PEM validation failed: ${validationError instanceof Error ? validationError.message : String(validationError)}`);
|
|
181
90
|
}
|
|
182
91
|
}
|
|
183
92
|
return result;
|
|
184
93
|
}
|
|
185
94
|
catch (error) {
|
|
186
|
-
// istanbul ignore next
|
|
187
95
|
throw new Error(`Failed to decode base64 content: ${error instanceof Error ? error.message : String(error)}`);
|
|
188
96
|
}
|
|
189
97
|
}
|
|
190
|
-
/**
|
|
191
|
-
* Extracts the raw 32-byte private key scalar from an EC private key PEM.
|
|
192
|
-
*
|
|
193
|
-
* This function parses an EC private key in PEM format and extracts the raw
|
|
194
|
-
* 32-byte private scalar (the "d" value) used in elliptic curve cryptography.
|
|
195
|
-
* This is the actual secret key material.
|
|
196
|
-
*
|
|
197
|
-
* @param {string} pemPrivateKey - The EC private key in PEM format
|
|
198
|
-
* @returns {Uint8Array} The raw 32-byte private key scalar
|
|
199
|
-
* @throws {Error} If the input is not a valid EC private key PEM
|
|
200
|
-
*
|
|
201
|
-
* @example
|
|
202
|
-
* ```typescript
|
|
203
|
-
* const pemKey = `-----BEGIN EC PRIVATE KEY-----
|
|
204
|
-
* MHcCAQEEIFBxqFkUxMoN2JkUXLFeiZnLNUpftjLi0sKMbZ6uajHXoAoGCCqGSM49
|
|
205
|
-
* AwEHoUQDQgAEcJ3eH/rG3zf9WmqMjh5eBSkeXz3Cb4Fig1rTosfHmgyjx/WnLPEe
|
|
206
|
-
* BF4SHvLo0G2COJEHa/VDE5EiKWO9ZR6AOQ==
|
|
207
|
-
* -----END EC PRIVATE KEY-----`;
|
|
208
|
-
*
|
|
209
|
-
* const rawKey = extractPrivateKeyRaw(pemKey);
|
|
210
|
-
* console.log(rawKey.length); // 32
|
|
211
|
-
* console.log(bufferToHex(rawKey)); // hex representation of the private scalar
|
|
212
|
-
* ```
|
|
213
|
-
*/
|
|
214
98
|
export function extractPrivateKeyRaw(pemPrivateKey) {
|
|
215
99
|
if (typeof pemPrivateKey !== 'string') {
|
|
216
100
|
throw new TypeError('Expected a string for PEM private key input');
|
|
217
101
|
}
|
|
218
|
-
// Extract the private key block
|
|
219
102
|
const keyBlock = /-----BEGIN (?:EC )?PRIVATE KEY-----[^-]+-----END (?:EC )?PRIVATE KEY-----/s.exec(pemPrivateKey);
|
|
220
103
|
if (!keyBlock) {
|
|
221
104
|
throw new Error('No EC PRIVATE KEY block found in the supplied PEM');
|
|
222
105
|
}
|
|
223
106
|
try {
|
|
224
|
-
// Create a private key object
|
|
225
107
|
const privateKey = createPrivateKey(keyBlock[0]);
|
|
226
|
-
// Export as PKCS#8 DER format
|
|
227
108
|
const pkcs8Der = privateKey.export({ format: 'der', type: 'pkcs8' });
|
|
228
|
-
// For P-256 curves, the private scalar is the last 32 bytes of the PKCS#8 DER
|
|
229
|
-
// istanbul ignore next
|
|
230
109
|
if (pkcs8Der.length < 32) {
|
|
231
110
|
throw new Error('Invalid private key: DER data too short');
|
|
232
111
|
}
|
|
233
|
-
// Extract the last 32 bytes which contain the raw private scalar
|
|
234
112
|
const rawPrivateKey = pkcs8Der.subarray(pkcs8Der.length - 32);
|
|
235
113
|
return new Uint8Array(rawPrivateKey);
|
|
236
114
|
}
|
|
237
115
|
catch (error) {
|
|
238
|
-
// istanbul ignore next
|
|
239
116
|
throw new Error(`Failed to extract private key: ${error instanceof Error ? error.message : String(error)}`);
|
|
240
117
|
}
|
|
241
118
|
}
|
|
242
|
-
//# sourceMappingURL=hex.js.map
|
package/dist/utils/inspector.js
CHANGED
|
@@ -1,27 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file contains the Inspector class.
|
|
3
|
-
*
|
|
4
|
-
* @file inspector.ts
|
|
5
|
-
* @author Luca Liguori
|
|
6
|
-
* @created 2025-10-12
|
|
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[32mInspector loaded.\u001B[40;0m');
|
|
27
3
|
import EventEmitter from 'node:events';
|
|
@@ -45,7 +21,7 @@ export class Inspector extends EventEmitter {
|
|
|
45
21
|
if (process.argv.includes('--verbose') || process.argv.includes('-verbose')) {
|
|
46
22
|
this.verbose = true;
|
|
47
23
|
}
|
|
48
|
-
this.log = new AnsiLogger({ logName: this.name, logTimestampFormat: 4
|
|
24
|
+
this.log = new AnsiLogger({ logName: this.name, logTimestampFormat: 4, logLevel: this.debug ? "debug" : "info" });
|
|
49
25
|
this.log.logNameColor = YELLOW;
|
|
50
26
|
this.on('start', () => {
|
|
51
27
|
this.start();
|
|
@@ -60,15 +36,6 @@ export class Inspector extends EventEmitter {
|
|
|
60
36
|
this.runGarbageCollector();
|
|
61
37
|
});
|
|
62
38
|
}
|
|
63
|
-
/**
|
|
64
|
-
* Starts the inspector for heap sampling.
|
|
65
|
-
*
|
|
66
|
-
* This function is called when the -inspect parameter is passed to matterbridge.
|
|
67
|
-
*
|
|
68
|
-
* The -snapshotinterval parameter can be used to set the heap snapshot interval. Default is undefined. Minimum is 30000 ms.
|
|
69
|
-
* The snapshot is saved in the heap_profiles directory that is created in the current working directory.
|
|
70
|
-
* The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
|
|
71
|
-
*/
|
|
72
39
|
async start() {
|
|
73
40
|
if (this.session) {
|
|
74
41
|
this.log.warn('Inspector session already active.');
|
|
@@ -77,9 +44,7 @@ export class Inspector extends EventEmitter {
|
|
|
77
44
|
const { Session } = await import('node:inspector');
|
|
78
45
|
const { mkdirSync } = await import('node:fs');
|
|
79
46
|
this.log.debug(`Starting heap sampling...`);
|
|
80
|
-
// Create the heap profiles directory if it doesn't exist
|
|
81
47
|
mkdirSync('heap_profiles', { recursive: true });
|
|
82
|
-
// Create the heap snapshots directory if it doesn't exist
|
|
83
48
|
mkdirSync('heap_snapshots', { recursive: true });
|
|
84
49
|
try {
|
|
85
50
|
this.session = new Session();
|
|
@@ -88,7 +53,6 @@ export class Inspector extends EventEmitter {
|
|
|
88
53
|
this.session?.post('HeapProfiler.startSampling', (err) => (err ? reject(err) : resolve()));
|
|
89
54
|
});
|
|
90
55
|
this.log.debug(`Started heap sampling`);
|
|
91
|
-
// Set an interval to take heap snapshots
|
|
92
56
|
const { getIntParameter } = await import('./commandLine.js');
|
|
93
57
|
const interval = getIntParameter('snapshotinterval');
|
|
94
58
|
if (interval && interval >= 30000) {
|
|
@@ -117,10 +81,6 @@ export class Inspector extends EventEmitter {
|
|
|
117
81
|
return;
|
|
118
82
|
}
|
|
119
83
|
}
|
|
120
|
-
/**
|
|
121
|
-
* Stops the heap sampling and saves the profile to a file in the heap_profiles directory.
|
|
122
|
-
* This function is called when the inspector is stopped.
|
|
123
|
-
*/
|
|
124
84
|
async stop() {
|
|
125
85
|
if (!this.session) {
|
|
126
86
|
this.log.warn('No active inspector session.');
|
|
@@ -131,9 +91,7 @@ export class Inspector extends EventEmitter {
|
|
|
131
91
|
this.log.debug(`Stopping heap sampling...`);
|
|
132
92
|
if (this.snapshotInterval) {
|
|
133
93
|
this.log.debug(`Clearing heap snapshot interval...`);
|
|
134
|
-
// Clear the snapshot interval if it exists
|
|
135
94
|
clearInterval(this.snapshotInterval);
|
|
136
|
-
// Take a final heap snapshot before stopping
|
|
137
95
|
await this.takeHeapSnapshot();
|
|
138
96
|
}
|
|
139
97
|
try {
|
|
@@ -155,15 +113,6 @@ export class Inspector extends EventEmitter {
|
|
|
155
113
|
this.log.debug(`Stopped heap sampling`);
|
|
156
114
|
}
|
|
157
115
|
}
|
|
158
|
-
/**
|
|
159
|
-
* Takes a heap snapshot and saves it to the file name 'heap_snapshots/<timestamp>.heapsnapshot'.
|
|
160
|
-
* If triggers a full garbage collection before and after taking the snapshot to reduce noise.
|
|
161
|
-
*
|
|
162
|
-
* This function is called periodically based on the -snapshotinterval parameter.
|
|
163
|
-
* The -snapshotinterval parameter must at least 30000 ms.
|
|
164
|
-
* The snapshot is saved in the heap_snapshots directory that is created in the current working directory.
|
|
165
|
-
* The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
|
|
166
|
-
*/
|
|
167
116
|
async takeHeapSnapshot() {
|
|
168
117
|
if (!this.session) {
|
|
169
118
|
this.log.warn('No active inspector session.');
|
|
@@ -179,7 +128,6 @@ export class Inspector extends EventEmitter {
|
|
|
179
128
|
const path = await import('node:path');
|
|
180
129
|
const safeTimestamp = new Date().toISOString().replace(/[<>:"/\\|?*]/g, '-');
|
|
181
130
|
const filename = path.join('heap_snapshots', `${safeTimestamp}.heapsnapshot`);
|
|
182
|
-
// Trigger a garbage collection before taking the snapshot to reduce noise
|
|
183
131
|
this.runGarbageCollector('minor', 'async');
|
|
184
132
|
this.runGarbageCollector('major', 'async');
|
|
185
133
|
if (this.debug)
|
|
@@ -192,16 +140,13 @@ export class Inspector extends EventEmitter {
|
|
|
192
140
|
};
|
|
193
141
|
stream.once('error', onStreamError);
|
|
194
142
|
const chunksListener = (notification) => {
|
|
195
|
-
// notification.params.chunk is a string; write directly to the stream
|
|
196
143
|
if (!stream.write(notification.params.chunk)) {
|
|
197
|
-
// If backpressure engages, it's fine; the stream will buffer internally. We don't block the inspector.
|
|
198
144
|
}
|
|
199
145
|
};
|
|
200
146
|
this.session.on('HeapProfiler.addHeapSnapshotChunk', chunksListener);
|
|
201
147
|
try {
|
|
202
148
|
await new Promise((resolve) => {
|
|
203
149
|
this.session?.post('HeapProfiler.takeHeapSnapshot', (err) => {
|
|
204
|
-
// Detach chunk listener and close the stream, then perform post-actions
|
|
205
150
|
this.session?.off('HeapProfiler.addHeapSnapshotChunk', chunksListener);
|
|
206
151
|
const finalize = () => {
|
|
207
152
|
if (!err && !streamErrored) {
|
|
@@ -218,7 +163,6 @@ export class Inspector extends EventEmitter {
|
|
|
218
163
|
}
|
|
219
164
|
resolve();
|
|
220
165
|
};
|
|
221
|
-
// End stream and wait for finish or error
|
|
222
166
|
try {
|
|
223
167
|
stream.end(() => finalize());
|
|
224
168
|
}
|
|
@@ -233,17 +177,6 @@ export class Inspector extends EventEmitter {
|
|
|
233
177
|
this.snapshotInProgress = false;
|
|
234
178
|
}
|
|
235
179
|
}
|
|
236
|
-
/**
|
|
237
|
-
* Manually trigger garbage collection to free memory (if exposed with --expose-gc)
|
|
238
|
-
*
|
|
239
|
-
* @param {'major' | 'minor'} type - The type of garbage collection to perform ('major' or 'minor'). Default is 'major'.
|
|
240
|
-
* @param {'sync' | 'async'} execution - The execution mode of garbage collection ('sync' or 'async'). Default is 'async'.
|
|
241
|
-
*
|
|
242
|
-
* @remarks
|
|
243
|
-
* - major collection refers to old-generation mark-sweep/mark-compact cycles.
|
|
244
|
-
* - minor collection refers to young-generation collections (scavenges).
|
|
245
|
-
* - sync execution blocks the main thread until GC is complete, which can cause pauses.
|
|
246
|
-
*/
|
|
247
180
|
runGarbageCollector(type = 'major', execution = 'async') {
|
|
248
181
|
if (global.gc && typeof global.gc === 'function') {
|
|
249
182
|
try {
|
|
@@ -265,4 +198,3 @@ export class Inspector extends EventEmitter {
|
|
|
265
198
|
}
|
|
266
199
|
}
|
|
267
200
|
}
|
|
268
|
-
//# sourceMappingURL=inspector.js.map
|