matterbridge 3.1.5 → 3.1.6-dev-20250721-75fab6b

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.
Files changed (213) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/dist/cli.js +2 -91
  3. package/dist/cliEmitter.js +0 -30
  4. package/dist/clusters/export.js +0 -2
  5. package/dist/defaultConfigSchema.js +0 -24
  6. package/dist/deviceManager.js +1 -94
  7. package/dist/devices/batteryStorage.js +1 -48
  8. package/dist/devices/dishwasher.js +90 -0
  9. package/dist/devices/evse.js +10 -74
  10. package/dist/devices/export.js +2 -2
  11. package/dist/devices/extractorHood.js +35 -0
  12. package/dist/devices/heatPump.js +2 -50
  13. package/dist/devices/laundryDryer.js +6 -83
  14. package/dist/devices/laundryWasher.js +7 -91
  15. package/dist/devices/roboticVacuumCleaner.js +7 -93
  16. package/dist/devices/solarPower.js +0 -38
  17. package/dist/devices/waterHeater.js +2 -82
  18. package/dist/frontend.js +21 -429
  19. package/dist/globalMatterbridge.js +0 -47
  20. package/dist/helpers.js +0 -53
  21. package/dist/index.js +1 -30
  22. package/dist/logger/export.js +0 -1
  23. package/dist/matter/behaviors.js +0 -2
  24. package/dist/matter/clusters.js +0 -2
  25. package/dist/matter/devices.js +0 -2
  26. package/dist/matter/endpoints.js +0 -2
  27. package/dist/matter/export.js +0 -3
  28. package/dist/matter/types.js +0 -3
  29. package/dist/matterbridge.js +79 -802
  30. package/dist/matterbridgeAccessoryPlatform.js +0 -36
  31. package/dist/matterbridgeBehaviors.js +24 -61
  32. package/dist/matterbridgeDeviceTypes.js +15 -579
  33. package/dist/matterbridgeDynamicPlatform.js +0 -36
  34. package/dist/matterbridgeEndpoint.js +64 -1113
  35. package/dist/matterbridgeEndpointHelpers.js +12 -322
  36. package/dist/matterbridgePlatform.js +0 -233
  37. package/dist/matterbridgeTypes.js +0 -25
  38. package/dist/pluginManager.js +3 -249
  39. package/dist/shelly.js +7 -168
  40. package/dist/storage/export.js +0 -1
  41. package/dist/update.js +0 -54
  42. package/dist/utils/colorUtils.js +2 -263
  43. package/dist/utils/commandLine.js +0 -54
  44. package/dist/utils/copyDirectory.js +1 -38
  45. package/dist/utils/createDirectory.js +0 -33
  46. package/dist/utils/createZip.js +2 -47
  47. package/dist/utils/deepCopy.js +0 -39
  48. package/dist/utils/deepEqual.js +1 -72
  49. package/dist/utils/error.js +0 -41
  50. package/dist/utils/export.js +0 -1
  51. package/dist/utils/hex.js +0 -58
  52. package/dist/utils/isvalid.js +0 -101
  53. package/dist/utils/network.js +5 -81
  54. package/dist/utils/spawn.js +0 -40
  55. package/dist/utils/wait.js +9 -62
  56. package/npm-shrinkwrap.json +9 -9
  57. package/package.json +2 -3
  58. package/dist/cli.d.ts +0 -26
  59. package/dist/cli.d.ts.map +0 -1
  60. package/dist/cli.js.map +0 -1
  61. package/dist/cliEmitter.d.ts +0 -34
  62. package/dist/cliEmitter.d.ts.map +0 -1
  63. package/dist/cliEmitter.js.map +0 -1
  64. package/dist/clusters/export.d.ts +0 -2
  65. package/dist/clusters/export.d.ts.map +0 -1
  66. package/dist/clusters/export.js.map +0 -1
  67. package/dist/defaultConfigSchema.d.ts +0 -28
  68. package/dist/defaultConfigSchema.d.ts.map +0 -1
  69. package/dist/defaultConfigSchema.js.map +0 -1
  70. package/dist/deviceManager.d.ts +0 -112
  71. package/dist/deviceManager.d.ts.map +0 -1
  72. package/dist/deviceManager.js.map +0 -1
  73. package/dist/devices/batteryStorage.d.ts +0 -48
  74. package/dist/devices/batteryStorage.d.ts.map +0 -1
  75. package/dist/devices/batteryStorage.js.map +0 -1
  76. package/dist/devices/evse.d.ts +0 -75
  77. package/dist/devices/evse.d.ts.map +0 -1
  78. package/dist/devices/evse.js.map +0 -1
  79. package/dist/devices/export.d.ts +0 -9
  80. package/dist/devices/export.d.ts.map +0 -1
  81. package/dist/devices/export.js.map +0 -1
  82. package/dist/devices/heatPump.d.ts +0 -47
  83. package/dist/devices/heatPump.d.ts.map +0 -1
  84. package/dist/devices/heatPump.js.map +0 -1
  85. package/dist/devices/laundryDryer.d.ts +0 -87
  86. package/dist/devices/laundryDryer.d.ts.map +0 -1
  87. package/dist/devices/laundryDryer.js.map +0 -1
  88. package/dist/devices/laundryWasher.d.ts +0 -242
  89. package/dist/devices/laundryWasher.d.ts.map +0 -1
  90. package/dist/devices/laundryWasher.js.map +0 -1
  91. package/dist/devices/roboticVacuumCleaner.d.ts +0 -112
  92. package/dist/devices/roboticVacuumCleaner.d.ts.map +0 -1
  93. package/dist/devices/roboticVacuumCleaner.js.map +0 -1
  94. package/dist/devices/solarPower.d.ts +0 -40
  95. package/dist/devices/solarPower.d.ts.map +0 -1
  96. package/dist/devices/solarPower.js.map +0 -1
  97. package/dist/devices/waterHeater.d.ts +0 -111
  98. package/dist/devices/waterHeater.d.ts.map +0 -1
  99. package/dist/devices/waterHeater.js.map +0 -1
  100. package/dist/frontend.d.ts +0 -304
  101. package/dist/frontend.d.ts.map +0 -1
  102. package/dist/frontend.js.map +0 -1
  103. package/dist/globalMatterbridge.d.ts +0 -59
  104. package/dist/globalMatterbridge.d.ts.map +0 -1
  105. package/dist/globalMatterbridge.js.map +0 -1
  106. package/dist/helpers.d.ts +0 -48
  107. package/dist/helpers.d.ts.map +0 -1
  108. package/dist/helpers.js.map +0 -1
  109. package/dist/index.d.ts +0 -33
  110. package/dist/index.d.ts.map +0 -1
  111. package/dist/index.js.map +0 -1
  112. package/dist/logger/export.d.ts +0 -2
  113. package/dist/logger/export.d.ts.map +0 -1
  114. package/dist/logger/export.js.map +0 -1
  115. package/dist/matter/behaviors.d.ts +0 -2
  116. package/dist/matter/behaviors.d.ts.map +0 -1
  117. package/dist/matter/behaviors.js.map +0 -1
  118. package/dist/matter/clusters.d.ts +0 -2
  119. package/dist/matter/clusters.d.ts.map +0 -1
  120. package/dist/matter/clusters.js.map +0 -1
  121. package/dist/matter/devices.d.ts +0 -2
  122. package/dist/matter/devices.d.ts.map +0 -1
  123. package/dist/matter/devices.js.map +0 -1
  124. package/dist/matter/endpoints.d.ts +0 -2
  125. package/dist/matter/endpoints.d.ts.map +0 -1
  126. package/dist/matter/endpoints.js.map +0 -1
  127. package/dist/matter/export.d.ts +0 -5
  128. package/dist/matter/export.d.ts.map +0 -1
  129. package/dist/matter/export.js.map +0 -1
  130. package/dist/matter/types.d.ts +0 -3
  131. package/dist/matter/types.d.ts.map +0 -1
  132. package/dist/matter/types.js.map +0 -1
  133. package/dist/matterbridge.d.ts +0 -447
  134. package/dist/matterbridge.d.ts.map +0 -1
  135. package/dist/matterbridge.js.map +0 -1
  136. package/dist/matterbridgeAccessoryPlatform.d.ts +0 -42
  137. package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
  138. package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
  139. package/dist/matterbridgeBehaviors.d.ts +0 -1340
  140. package/dist/matterbridgeBehaviors.d.ts.map +0 -1
  141. package/dist/matterbridgeBehaviors.js.map +0 -1
  142. package/dist/matterbridgeDeviceTypes.d.ts +0 -709
  143. package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
  144. package/dist/matterbridgeDeviceTypes.js.map +0 -1
  145. package/dist/matterbridgeDynamicPlatform.d.ts +0 -42
  146. package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
  147. package/dist/matterbridgeDynamicPlatform.js.map +0 -1
  148. package/dist/matterbridgeEndpoint.d.ts +0 -1250
  149. package/dist/matterbridgeEndpoint.d.ts.map +0 -1
  150. package/dist/matterbridgeEndpoint.js.map +0 -1
  151. package/dist/matterbridgeEndpointHelpers.d.ts +0 -3198
  152. package/dist/matterbridgeEndpointHelpers.d.ts.map +0 -1
  153. package/dist/matterbridgeEndpointHelpers.js.map +0 -1
  154. package/dist/matterbridgePlatform.d.ts +0 -310
  155. package/dist/matterbridgePlatform.d.ts.map +0 -1
  156. package/dist/matterbridgePlatform.js.map +0 -1
  157. package/dist/matterbridgeTypes.d.ts +0 -195
  158. package/dist/matterbridgeTypes.d.ts.map +0 -1
  159. package/dist/matterbridgeTypes.js.map +0 -1
  160. package/dist/pluginManager.d.ts +0 -270
  161. package/dist/pluginManager.d.ts.map +0 -1
  162. package/dist/pluginManager.js.map +0 -1
  163. package/dist/shelly.d.ts +0 -174
  164. package/dist/shelly.d.ts.map +0 -1
  165. package/dist/shelly.js.map +0 -1
  166. package/dist/storage/export.d.ts +0 -2
  167. package/dist/storage/export.d.ts.map +0 -1
  168. package/dist/storage/export.js.map +0 -1
  169. package/dist/update.d.ts +0 -59
  170. package/dist/update.d.ts.map +0 -1
  171. package/dist/update.js.map +0 -1
  172. package/dist/utils/colorUtils.d.ts +0 -117
  173. package/dist/utils/colorUtils.d.ts.map +0 -1
  174. package/dist/utils/colorUtils.js.map +0 -1
  175. package/dist/utils/commandLine.d.ts +0 -59
  176. package/dist/utils/commandLine.d.ts.map +0 -1
  177. package/dist/utils/commandLine.js.map +0 -1
  178. package/dist/utils/copyDirectory.d.ts +0 -33
  179. package/dist/utils/copyDirectory.d.ts.map +0 -1
  180. package/dist/utils/copyDirectory.js.map +0 -1
  181. package/dist/utils/createDirectory.d.ts +0 -34
  182. package/dist/utils/createDirectory.d.ts.map +0 -1
  183. package/dist/utils/createDirectory.js.map +0 -1
  184. package/dist/utils/createZip.d.ts +0 -39
  185. package/dist/utils/createZip.d.ts.map +0 -1
  186. package/dist/utils/createZip.js.map +0 -1
  187. package/dist/utils/deepCopy.d.ts +0 -32
  188. package/dist/utils/deepCopy.d.ts.map +0 -1
  189. package/dist/utils/deepCopy.js.map +0 -1
  190. package/dist/utils/deepEqual.d.ts +0 -54
  191. package/dist/utils/deepEqual.d.ts.map +0 -1
  192. package/dist/utils/deepEqual.js.map +0 -1
  193. package/dist/utils/error.d.ts +0 -44
  194. package/dist/utils/error.d.ts.map +0 -1
  195. package/dist/utils/error.js.map +0 -1
  196. package/dist/utils/export.d.ts +0 -12
  197. package/dist/utils/export.d.ts.map +0 -1
  198. package/dist/utils/export.js.map +0 -1
  199. package/dist/utils/hex.d.ts +0 -49
  200. package/dist/utils/hex.d.ts.map +0 -1
  201. package/dist/utils/hex.js.map +0 -1
  202. package/dist/utils/isvalid.d.ts +0 -103
  203. package/dist/utils/isvalid.d.ts.map +0 -1
  204. package/dist/utils/isvalid.js.map +0 -1
  205. package/dist/utils/network.d.ts +0 -74
  206. package/dist/utils/network.d.ts.map +0 -1
  207. package/dist/utils/network.js.map +0 -1
  208. package/dist/utils/spawn.d.ts +0 -33
  209. package/dist/utils/spawn.d.ts.map +0 -1
  210. package/dist/utils/spawn.js.map +0 -1
  211. package/dist/utils/wait.d.ts +0 -56
  212. package/dist/utils/wait.d.ts.map +0 -1
  213. package/dist/utils/wait.js.map +0 -1
@@ -1,53 +1,17 @@
1
- /* eslint-disable @typescript-eslint/no-explicit-any */
2
- /**
3
- * This file contains the deepCopy function.
4
- *
5
- * @file deepCopy.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
- /**
26
- * Creates a deep copy of the given value.
27
- *
28
- * @template T - The type of the value being copied.
29
- * @param {T} value - The value to be copied.
30
- * @returns {T} - The deep copy of the value.
31
- */
32
1
  export function deepCopy(value) {
33
2
  if (typeof value !== 'object' || value === null) {
34
- // Primitive value (string, number, boolean, bigint, undefined, symbol) or null
35
3
  return value;
36
4
  }
37
5
  else if (Array.isArray(value)) {
38
- // Array: Recursively copy each element
39
6
  return value.map((item) => deepCopy(item));
40
7
  }
41
8
  else if (value instanceof Date) {
42
- // Date objects
43
9
  return new Date(value.getTime());
44
10
  }
45
11
  else if (value instanceof RegExp) {
46
- // RegExp objects
47
12
  return new RegExp(value.source, value.flags);
48
13
  }
49
14
  else if (value instanceof Map) {
50
- // Maps
51
15
  const mapCopy = new Map();
52
16
  for (const [origKey, origVal] of value.entries()) {
53
17
  const clonedKey = deepCopy(origKey);
@@ -57,7 +21,6 @@ export function deepCopy(value) {
57
21
  return mapCopy;
58
22
  }
59
23
  else if (value instanceof Set) {
60
- // Sets
61
24
  const setCopy = new Set();
62
25
  value.forEach((item) => {
63
26
  setCopy.add(deepCopy(item));
@@ -65,7 +28,6 @@ export function deepCopy(value) {
65
28
  return setCopy;
66
29
  }
67
30
  else {
68
- // Objects: Create a copy with the same prototype as the original
69
31
  const proto = Object.getPrototypeOf(value);
70
32
  const copy = Object.create(proto);
71
33
  for (const key in value) {
@@ -76,4 +38,3 @@ export function deepCopy(value) {
76
38
  return copy;
77
39
  }
78
40
  }
79
- //# sourceMappingURL=deepCopy.js.map
@@ -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}])` /* , 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
@@ -1,50 +1,9 @@
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
- /**
26
- * Logs an error message using the provided AnsiLogger instance.
27
- *
28
- * @param {AnsiLogger} log - The AnsiLogger instance to use for logging.
29
- * @param {string} message - The error message to log.
30
- * @param {unknown} error - The error object or value to log. If it's an Error instance,
31
- * its message and stack trace will be included in the log.
32
- */
33
2
  export function logError(log, message, error) {
34
3
  log.error(`${message}: ${error instanceof Error ? error.message + '\nStack:\n' + error.stack : error}`);
35
4
  }
36
- /**
37
- * Logs an error message using the provided AnsiLogger instance with detailed inspection.
38
- * Uses util.inspect to get a detailed view of the error with a stack depth of 10 levels.
39
- * If the error is an Error instance, it also includes the error message.
40
- *
41
- * @param {AnsiLogger} log - The AnsiLogger instance to use for logging.
42
- * @param {string} message - The error message to log.
43
- * @param {unknown} error - The error object or value to log. Will be inspected with depth 10.
44
- */
45
5
  export function inspectError(log, message, error) {
46
6
  const errorMessage = error instanceof Error ? `${error.message}\n` : '';
47
7
  const inspectedError = inspect(error, { depth: 10, colors: true, showHidden: false });
48
8
  log.error(`${message}: ${errorMessage}${inspectedError}`);
49
9
  }
50
- //# sourceMappingURL=error.js.map
@@ -9,4 +9,3 @@ export * from './createDirectory.js';
9
9
  export * from './createZip.js';
10
10
  export * from './wait.js';
11
11
  export * from './hex.js';
12
- //# sourceMappingURL=export.js.map
package/dist/utils/hex.js CHANGED
@@ -1,85 +1,27 @@
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
- /**
25
- * Converts an ArrayBuffer or Uint8Array to a hexadecimal string.
26
- *
27
- * Accepts any {ArrayBufferLike} input: a raw ArrayBuffer (binary data storage) or
28
- * a Uint8Array (TypedArray view over an ArrayBuffer). While an ArrayBuffer holds
29
- * the raw memory, a Uint8Array is a typed view into that memory, letting you access
30
- * its bytes directly. This function normalizes both by creating a Uint8Array view
31
- * before conversion.
32
- *
33
- * @param {ArrayBufferLike} buffer - The buffer or typed-array view to convert.
34
- * @returns {string} A lowercase hex string representation of the buffer's bytes.
35
- *
36
- * @throws {TypeError} If the input is not an ArrayBuffer or ArrayBufferView.
37
- */
38
1
  export function bufferToHex(buffer) {
39
- // Check if the input is an ArrayBuffer or ArrayBufferView
40
2
  if (!(buffer instanceof ArrayBuffer || ArrayBuffer.isView(buffer))) {
41
3
  throw new TypeError('Expected input to be an ArrayBuffer or ArrayBufferView');
42
4
  }
43
- // Create a Uint8Array view over the buffer
44
5
  const bytes = buffer instanceof Uint8Array ? buffer : new Uint8Array(buffer);
45
- // Convert each byte to 2-digit hex
46
6
  return Array.from(bytes)
47
7
  .map((byte) => byte.toString(16).padStart(2, '0'))
48
8
  .join('');
49
9
  }
50
- /**
51
- * Converts a hexadecimal string to a Uint8Array.
52
- *
53
- * @param {string} hex - The hex string to convert. Can include uppercase or lowercase characters.
54
- * @returns {Uint8Array} A Uint8Array representing the corresponding binary data.
55
- *
56
- * @throws {TypeError} If the input is not a string.
57
- * @throws {Error} If the input length is odd or contains non-hex characters.
58
- */
59
10
  export function hexToBuffer(hex) {
60
- // Ensure the input is a string
61
11
  if (typeof hex !== 'string') {
62
12
  throw new TypeError('Expected a string for hex input');
63
13
  }
64
- // Trim any whitespace from the input string
65
14
  const cleaned = hex.trim();
66
- // Check if the length of the hex string is even
67
15
  if (cleaned.length % 2 !== 0) {
68
16
  throw new Error('Invalid hex string length, must be even');
69
17
  }
70
- // Validate that the string contains only valid hex characters
71
18
  if (!/^[0-9a-fA-F]*$/.test(cleaned)) {
72
19
  throw new Error('Invalid hex string, contains non-hex characters');
73
20
  }
74
- // Calculate the length of the resulting Uint8Array
75
21
  const length = cleaned.length / 2;
76
- // Create a Uint8Array to hold the binary data
77
22
  const result = new Uint8Array(length);
78
- // Convert each pair of hex characters into a byte
79
23
  for (let i = 0; i < length; i++) {
80
24
  result[i] = parseInt(cleaned.substr(i * 2, 2), 16);
81
25
  }
82
- // Return the resulting Uint8Array
83
26
  return result;
84
27
  }
85
- //# sourceMappingURL=hex.js.map
@@ -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
@@ -1,38 +1,8 @@
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 IPv4 address of the first non-internal network interface.
29
- *
30
- * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
31
- */
32
3
  export function getIpv4InterfaceAddress() {
33
4
  let ipv4Address;
34
5
  const networkInterfaces = os.networkInterfaces();
35
- // console.log('Available Network Interfaces:', networkInterfaces);
36
6
  for (const interfaceDetails of Object.values(networkInterfaces)) {
37
7
  if (!interfaceDetails) {
38
8
  break;
@@ -46,18 +16,11 @@ export function getIpv4InterfaceAddress() {
46
16
  break;
47
17
  }
48
18
  }
49
- // console.log('Selected Network Interfaces:', ipv4Address);
50
19
  return ipv4Address;
51
20
  }
52
- /**
53
- * Retrieves the IPv6 address of the first non-internal network interface.
54
- *
55
- * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
56
- */
57
21
  export function getIpv6InterfaceAddress() {
58
22
  let ipv6Address;
59
23
  const networkInterfaces = os.networkInterfaces();
60
- // console.log('Available Network Interfaces:', networkInterfaces);
61
24
  for (const interfaceDetails of Object.values(networkInterfaces)) {
62
25
  if (!interfaceDetails) {
63
26
  break;
@@ -71,18 +34,11 @@ export function getIpv6InterfaceAddress() {
71
34
  break;
72
35
  }
73
36
  }
74
- // console.log('Selected Network Interfaces:', ipv6Address);
75
37
  return ipv6Address;
76
38
  }
77
- /**
78
- * Retrieves the mac address of the first non-internal network interface.
79
- *
80
- * @returns {string | undefined} The mac address, or undefined if not found.
81
- */
82
39
  export function getMacAddress() {
83
40
  let macAddress;
84
41
  const networkInterfaces = os.networkInterfaces();
85
- // console.log('Available Network Interfaces:', networkInterfaces);
86
42
  for (const interfaceDetails of Object.values(networkInterfaces)) {
87
43
  if (!interfaceDetails) {
88
44
  break;
@@ -98,14 +54,9 @@ export function getMacAddress() {
98
54
  }
99
55
  return macAddress;
100
56
  }
101
- /**
102
- * Logs the available network interfaces and their details.
103
- *
104
- * @returns {void}
105
- */
106
57
  export function logInterfaces() {
107
- const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
108
- log.logLevel = "info" /* LogLevel.INFO */;
58
+ const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4, logLevel: "info" });
59
+ log.logLevel = "info";
109
60
  log.logName = 'LogInterfaces';
110
61
  log.info('Available Network Interfaces:');
111
62
  const availableAddresses = Object.entries(os.networkInterfaces());
@@ -119,36 +70,16 @@ export function logInterfaces() {
119
70
  }
120
71
  }
121
72
  }
122
- /**
123
- * Resolves the given hostname to an IP address.
124
- *
125
- * @param {string} hostname - The hostname to resolve.
126
- * @param {0 | 4 | 6} [family] - The address family to use (0 for any, 4 for IPv4, 6 for IPv6). Default is 4.
127
- * @returns {Promise<string | null>} - A promise that resolves to the IP address or null if not found.
128
- *
129
- * @remarks
130
- * This function uses DNS lookup to resolve the hostname, which can take some time to complete.
131
- */
132
73
  export async function resolveHostname(hostname, family = 4) {
133
74
  const dns = await import('node:dns');
134
75
  try {
135
- const addresses = await dns.promises.lookup(hostname.toLowerCase() /* + '.local'*/, { family });
76
+ const addresses = await dns.promises.lookup(hostname.toLowerCase(), { family });
136
77
  return addresses.address;
137
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
138
78
  }
139
79
  catch (error) {
140
80
  return null;
141
81
  }
142
82
  }
143
- /**
144
- * Retrieves the version of an npm package from the npm registry.
145
- *
146
- * @param {string} packageName - The name of the npm package.
147
- * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
148
- * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
149
- * @returns {Promise<string>} A promise that resolves to the version string of the package.
150
- * @throws {Error} If the request fails or the tag is not found.
151
- */
152
83
  export async function getNpmPackageVersion(packageName, tag = 'latest', timeout = 10000) {
153
84
  const https = await import('node:https');
154
85
  return new Promise((resolve, reject) => {
@@ -162,8 +93,8 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
162
93
  let data = '';
163
94
  if (res.statusCode !== 200) {
164
95
  clearTimeout(timeoutId);
165
- res.resume(); // Discard response data to close the socket properly
166
- req.destroy(); // Forcefully close the request
96
+ res.resume();
97
+ req.destroy();
167
98
  reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
168
99
  return;
169
100
  }
@@ -174,7 +105,6 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
174
105
  clearTimeout(timeoutId);
175
106
  try {
176
107
  const jsonData = JSON.parse(data);
177
- // console.log(`Package ${packageName} tag ${tag}`, jsonData);
178
108
  const version = jsonData['dist-tags']?.[tag];
179
109
  if (version) {
180
110
  resolve(version);
@@ -194,11 +124,6 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
194
124
  });
195
125
  });
196
126
  }
197
- /**
198
- * Retrieves the path to the global Node.js modules directory.
199
- *
200
- * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
201
- */
202
127
  export async function getGlobalNodeModules() {
203
128
  const { exec } = await import('node:child_process');
204
129
  return new Promise((resolve, reject) => {
@@ -212,4 +137,3 @@ export async function getGlobalNodeModules() {
212
137
  });
213
138
  });
214
139
  }
215
- //# sourceMappingURL=network.js.map