matterbridge 3.1.0-dev-20250627-94e7f6e → 3.1.0

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 (187) hide show
  1. package/CHANGELOG.md +4 -8
  2. package/dist/cli.d.ts +29 -0
  3. package/dist/cli.d.ts.map +1 -0
  4. package/dist/cli.js +91 -2
  5. package/dist/cli.js.map +1 -0
  6. package/dist/clusters/export.d.ts +2 -0
  7. package/dist/clusters/export.d.ts.map +1 -0
  8. package/dist/clusters/export.js +2 -0
  9. package/dist/clusters/export.js.map +1 -0
  10. package/dist/defaultConfigSchema.d.ts +28 -0
  11. package/dist/defaultConfigSchema.d.ts.map +1 -0
  12. package/dist/defaultConfigSchema.js +24 -0
  13. package/dist/defaultConfigSchema.js.map +1 -0
  14. package/dist/deviceManager.d.ts +112 -0
  15. package/dist/deviceManager.d.ts.map +1 -0
  16. package/dist/deviceManager.js +94 -1
  17. package/dist/deviceManager.js.map +1 -0
  18. package/dist/devices/export.d.ts +5 -0
  19. package/dist/devices/export.d.ts.map +1 -0
  20. package/dist/devices/export.js +2 -0
  21. package/dist/devices/export.js.map +1 -0
  22. package/dist/evse.d.ts +72 -0
  23. package/dist/evse.d.ts.map +1 -0
  24. package/dist/evse.js +70 -9
  25. package/dist/evse.js.map +1 -0
  26. package/dist/frontend.d.ts +285 -0
  27. package/dist/frontend.d.ts.map +1 -0
  28. package/dist/frontend.js +413 -16
  29. package/dist/frontend.js.map +1 -0
  30. package/dist/globalMatterbridge.d.ts +59 -0
  31. package/dist/globalMatterbridge.d.ts.map +1 -0
  32. package/dist/globalMatterbridge.js +47 -0
  33. package/dist/globalMatterbridge.js.map +1 -0
  34. package/dist/helpers.d.ts +48 -0
  35. package/dist/helpers.d.ts.map +1 -0
  36. package/dist/helpers.js +53 -0
  37. package/dist/helpers.js.map +1 -0
  38. package/dist/index.d.ts +38 -0
  39. package/dist/index.d.ts.map +1 -0
  40. package/dist/index.js +32 -1
  41. package/dist/index.js.map +1 -0
  42. package/dist/laundryWasher.d.ts +243 -0
  43. package/dist/laundryWasher.d.ts.map +1 -0
  44. package/dist/laundryWasher.js +92 -7
  45. package/dist/laundryWasher.js.map +1 -0
  46. package/dist/logger/export.d.ts +2 -0
  47. package/dist/logger/export.d.ts.map +1 -0
  48. package/dist/logger/export.js +1 -0
  49. package/dist/logger/export.js.map +1 -0
  50. package/dist/matter/behaviors.d.ts +2 -0
  51. package/dist/matter/behaviors.d.ts.map +1 -0
  52. package/dist/matter/behaviors.js +2 -0
  53. package/dist/matter/behaviors.js.map +1 -0
  54. package/dist/matter/clusters.d.ts +2 -0
  55. package/dist/matter/clusters.d.ts.map +1 -0
  56. package/dist/matter/clusters.js +2 -0
  57. package/dist/matter/clusters.js.map +1 -0
  58. package/dist/matter/devices.d.ts +2 -0
  59. package/dist/matter/devices.d.ts.map +1 -0
  60. package/dist/matter/devices.js +2 -0
  61. package/dist/matter/devices.js.map +1 -0
  62. package/dist/matter/endpoints.d.ts +2 -0
  63. package/dist/matter/endpoints.d.ts.map +1 -0
  64. package/dist/matter/endpoints.js +2 -0
  65. package/dist/matter/endpoints.js.map +1 -0
  66. package/dist/matter/export.d.ts +5 -0
  67. package/dist/matter/export.d.ts.map +1 -0
  68. package/dist/matter/export.js +3 -0
  69. package/dist/matter/export.js.map +1 -0
  70. package/dist/matter/types.d.ts +3 -0
  71. package/dist/matter/types.d.ts.map +1 -0
  72. package/dist/matter/types.js +3 -0
  73. package/dist/matter/types.js.map +1 -0
  74. package/dist/matterbridge.d.ts +450 -0
  75. package/dist/matterbridge.d.ts.map +1 -0
  76. package/dist/matterbridge.js +809 -55
  77. package/dist/matterbridge.js.map +1 -0
  78. package/dist/matterbridgeAccessoryPlatform.d.ts +42 -0
  79. package/dist/matterbridgeAccessoryPlatform.d.ts.map +1 -0
  80. package/dist/matterbridgeAccessoryPlatform.js +36 -0
  81. package/dist/matterbridgeAccessoryPlatform.js.map +1 -0
  82. package/dist/matterbridgeBehaviors.d.ts +1334 -0
  83. package/dist/matterbridgeBehaviors.d.ts.map +1 -0
  84. package/dist/matterbridgeBehaviors.js +55 -1
  85. package/dist/matterbridgeBehaviors.js.map +1 -0
  86. package/dist/matterbridgeDeviceTypes.d.ts +709 -0
  87. package/dist/matterbridgeDeviceTypes.d.ts.map +1 -0
  88. package/dist/matterbridgeDeviceTypes.js +579 -15
  89. package/dist/matterbridgeDeviceTypes.js.map +1 -0
  90. package/dist/matterbridgeDynamicPlatform.d.ts +42 -0
  91. package/dist/matterbridgeDynamicPlatform.d.ts.map +1 -0
  92. package/dist/matterbridgeDynamicPlatform.js +36 -0
  93. package/dist/matterbridgeDynamicPlatform.js.map +1 -0
  94. package/dist/matterbridgeEndpoint.d.ts +1173 -0
  95. package/dist/matterbridgeEndpoint.d.ts.map +1 -0
  96. package/dist/matterbridgeEndpoint.js +1023 -41
  97. package/dist/matterbridgeEndpoint.js.map +1 -0
  98. package/dist/matterbridgeEndpointHelpers.d.ts +3198 -0
  99. package/dist/matterbridgeEndpointHelpers.d.ts.map +1 -0
  100. package/dist/matterbridgeEndpointHelpers.js +322 -12
  101. package/dist/matterbridgeEndpointHelpers.js.map +1 -0
  102. package/dist/matterbridgePlatform.d.ts +310 -0
  103. package/dist/matterbridgePlatform.d.ts.map +1 -0
  104. package/dist/matterbridgePlatform.js +233 -0
  105. package/dist/matterbridgePlatform.js.map +1 -0
  106. package/dist/matterbridgeTypes.d.ts +184 -0
  107. package/dist/matterbridgeTypes.d.ts.map +1 -0
  108. package/dist/matterbridgeTypes.js +25 -0
  109. package/dist/matterbridgeTypes.js.map +1 -0
  110. package/dist/pluginManager.d.ts +291 -0
  111. package/dist/pluginManager.d.ts.map +1 -0
  112. package/dist/pluginManager.js +269 -3
  113. package/dist/pluginManager.js.map +1 -0
  114. package/dist/roboticVacuumCleaner.d.ts +104 -0
  115. package/dist/roboticVacuumCleaner.d.ts.map +1 -0
  116. package/dist/roboticVacuumCleaner.js +83 -6
  117. package/dist/roboticVacuumCleaner.js.map +1 -0
  118. package/dist/shelly.d.ts +174 -0
  119. package/dist/shelly.d.ts.map +1 -0
  120. package/dist/shelly.js +168 -7
  121. package/dist/shelly.js.map +1 -0
  122. package/dist/storage/export.d.ts +2 -0
  123. package/dist/storage/export.d.ts.map +1 -0
  124. package/dist/storage/export.js +1 -0
  125. package/dist/storage/export.js.map +1 -0
  126. package/dist/update.d.ts +59 -0
  127. package/dist/update.d.ts.map +1 -0
  128. package/dist/update.js +54 -0
  129. package/dist/update.js.map +1 -0
  130. package/dist/utils/colorUtils.d.ts +117 -0
  131. package/dist/utils/colorUtils.d.ts.map +1 -0
  132. package/dist/utils/colorUtils.js +263 -2
  133. package/dist/utils/colorUtils.js.map +1 -0
  134. package/dist/utils/commandLine.d.ts +59 -0
  135. package/dist/utils/commandLine.d.ts.map +1 -0
  136. package/dist/utils/commandLine.js +54 -0
  137. package/dist/utils/commandLine.js.map +1 -0
  138. package/dist/utils/copyDirectory.d.ts +33 -0
  139. package/dist/utils/copyDirectory.d.ts.map +1 -0
  140. package/dist/utils/copyDirectory.js +38 -1
  141. package/dist/utils/copyDirectory.js.map +1 -0
  142. package/dist/utils/createDirectory.d.ts +34 -0
  143. package/dist/utils/createDirectory.d.ts.map +1 -0
  144. package/dist/utils/createDirectory.js +33 -0
  145. package/dist/utils/createDirectory.js.map +1 -0
  146. package/dist/utils/createZip.d.ts +39 -0
  147. package/dist/utils/createZip.d.ts.map +1 -0
  148. package/dist/utils/createZip.js +47 -2
  149. package/dist/utils/createZip.js.map +1 -0
  150. package/dist/utils/deepCopy.d.ts +32 -0
  151. package/dist/utils/deepCopy.d.ts.map +1 -0
  152. package/dist/utils/deepCopy.js +39 -0
  153. package/dist/utils/deepCopy.js.map +1 -0
  154. package/dist/utils/deepEqual.d.ts +54 -0
  155. package/dist/utils/deepEqual.d.ts.map +1 -0
  156. package/dist/utils/deepEqual.js +72 -1
  157. package/dist/utils/deepEqual.js.map +1 -0
  158. package/dist/utils/export.d.ts +12 -0
  159. package/dist/utils/export.d.ts.map +1 -0
  160. package/dist/utils/export.js +1 -0
  161. package/dist/utils/export.js.map +1 -0
  162. package/dist/utils/hex.d.ts +49 -0
  163. package/dist/utils/hex.d.ts.map +1 -0
  164. package/dist/utils/hex.js +58 -0
  165. package/dist/utils/hex.js.map +1 -0
  166. package/dist/utils/isvalid.d.ts +103 -0
  167. package/dist/utils/isvalid.d.ts.map +1 -0
  168. package/dist/utils/isvalid.js +101 -0
  169. package/dist/utils/isvalid.js.map +1 -0
  170. package/dist/utils/network.d.ts +76 -0
  171. package/dist/utils/network.d.ts.map +1 -0
  172. package/dist/utils/network.js +83 -5
  173. package/dist/utils/network.js.map +1 -0
  174. package/dist/utils/spawn.d.ts +14 -0
  175. package/dist/utils/spawn.d.ts.map +1 -0
  176. package/dist/utils/spawn.js +18 -0
  177. package/dist/utils/spawn.js.map +1 -0
  178. package/dist/utils/wait.d.ts +56 -0
  179. package/dist/utils/wait.d.ts.map +1 -0
  180. package/dist/utils/wait.js +62 -9
  181. package/dist/utils/wait.js.map +1 -0
  182. package/dist/waterHeater.d.ts +106 -0
  183. package/dist/waterHeater.d.ts.map +1 -0
  184. package/dist/waterHeater.js +77 -2
  185. package/dist/waterHeater.js.map +1 -0
  186. package/npm-shrinkwrap.json +2 -2
  187. package/package.json +2 -1
package/dist/utils/hex.js CHANGED
@@ -1,27 +1,85 @@
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
+ */
1
38
  export function bufferToHex(buffer) {
39
+ // Check if the input is an ArrayBuffer or ArrayBufferView
2
40
  if (!(buffer instanceof ArrayBuffer || ArrayBuffer.isView(buffer))) {
3
41
  throw new TypeError('Expected input to be an ArrayBuffer or ArrayBufferView');
4
42
  }
43
+ // Create a Uint8Array view over the buffer
5
44
  const bytes = buffer instanceof Uint8Array ? buffer : new Uint8Array(buffer);
45
+ // Convert each byte to 2-digit hex
6
46
  return Array.from(bytes)
7
47
  .map((byte) => byte.toString(16).padStart(2, '0'))
8
48
  .join('');
9
49
  }
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
+ */
10
59
  export function hexToBuffer(hex) {
60
+ // Ensure the input is a string
11
61
  if (typeof hex !== 'string') {
12
62
  throw new TypeError('Expected a string for hex input');
13
63
  }
64
+ // Trim any whitespace from the input string
14
65
  const cleaned = hex.trim();
66
+ // Check if the length of the hex string is even
15
67
  if (cleaned.length % 2 !== 0) {
16
68
  throw new Error('Invalid hex string length, must be even');
17
69
  }
70
+ // Validate that the string contains only valid hex characters
18
71
  if (!/^[0-9a-fA-F]*$/.test(cleaned)) {
19
72
  throw new Error('Invalid hex string, contains non-hex characters');
20
73
  }
74
+ // Calculate the length of the resulting Uint8Array
21
75
  const length = cleaned.length / 2;
76
+ // Create a Uint8Array to hold the binary data
22
77
  const result = new Uint8Array(length);
78
+ // Convert each pair of hex characters into a byte
23
79
  for (let i = 0; i < length; i++) {
24
80
  result[i] = parseInt(cleaned.substr(i * 2, 2), 16);
25
81
  }
82
+ // Return the resulting Uint8Array
26
83
  return result;
27
84
  }
85
+ //# sourceMappingURL=hex.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hex.js","sourceRoot":"","sources":["../../src/utils/hex.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CAAC,MAAuB;IACjD,0DAA0D;IAC1D,IAAI,CAAC,CAAC,MAAM,YAAY,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,SAAS,CAAC,wDAAwD,CAAC,CAAC;IAChF,CAAC;IAED,2CAA2C;IAC3C,MAAM,KAAK,GAAG,MAAM,YAAY,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAE7E,mCAAmC;IACnC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;SACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SACjD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,+BAA+B;IAC/B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;IACzD,CAAC;IAED,4CAA4C;IAC5C,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAE3B,gDAAgD;IAChD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,8DAA8D;IAC9D,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,mDAAmD;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAElC,8CAA8C;IAC9C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAEtC,kDAAkD;IAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,kCAAkC;IAClC,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -0,0 +1,103 @@
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
+ export declare function isValidIpv4Address(ipv4Address: string): boolean;
31
+ /**
32
+ * Checks if a value is a valid number within the specified range.
33
+ *
34
+ * @param {any} value - The value to be checked.
35
+ * @param {number} min - The minimum value allowed (optional).
36
+ * @param {number} max - The maximum value allowed (optional).
37
+ * @returns {value is number} Returns true if the value is a valid number within the specified range, otherwise false.
38
+ */
39
+ export declare function isValidNumber(value: any, min?: number, max?: number): value is number;
40
+ /**
41
+ * Checks if a value is a valid boolean.
42
+ *
43
+ * @param {any} value - The value to be checked.
44
+ * @returns {value is boolean} `true` if the value is a valid boolean, `false` otherwise.
45
+ */
46
+ export declare function isValidBoolean(value: any): value is boolean;
47
+ /**
48
+ * Checks if a value is a valid string.
49
+ *
50
+ * @param {any} value - The value to be checked.
51
+ * @param {number} minLength - The min string length (optional).
52
+ * @param {number} maxLength - The max string length (optional).
53
+ * @returns {value is string} A boolean indicating whether the value is a valid string.
54
+ */
55
+ export declare function isValidString(value: any, minLength?: number, maxLength?: number): value is string;
56
+ /**
57
+ * Checks if a value is a valid RegExp.
58
+ *
59
+ * @param {any} value - The value to be checked.
60
+ * @returns {value is RegExp} A boolean indicating whether the value is a valid RegExp.
61
+ */
62
+ export declare function isValidRegExp(value: any): value is RegExp;
63
+ /**
64
+ * Checks if a value is a valid object.
65
+ *
66
+ * @param {any} value - The value to be checked.
67
+ * @param {number} minLength - The min number of keys (optional).
68
+ * @param {number} maxLength - The max number of keys (optional).
69
+ * @returns {value is object} A boolean indicating whether the value is a valid object.
70
+ */
71
+ export declare function isValidObject(value: any, minLength?: number, maxLength?: number): value is object;
72
+ /**
73
+ * Checks if a value is a valid array.
74
+ *
75
+ * @param {any} value - The value to be checked.
76
+ * @param {number} minLength - The min number of elements (optional).
77
+ * @param {number} maxLength - The max number of elements (optional).
78
+ * @returns {value is unknown[]} A boolean indicating whether the value is a valid array.
79
+ */
80
+ export declare function isValidArray(value: any, minLength?: number, maxLength?: number): value is unknown[];
81
+ /**
82
+ * Checks if the given value is null.
83
+ *
84
+ * @param {any} value - The value to check.
85
+ * @returns {value is null} `true` if the value is null, `false` otherwise.
86
+ */
87
+ export declare function isValidNull(value: any): value is null;
88
+ /**
89
+ * Checks if a value is undefined.
90
+ *
91
+ * @param {any} value - The value to check.
92
+ * @returns {value is undefined} `true` if the value is undefined, `false` otherwise.
93
+ */
94
+ export declare function isValidUndefined(value: any): value is undefined;
95
+ /**
96
+ * Converts a semantic version string like "6.11.0-1011-raspi" to a numeric version code like 61100.
97
+ * Format: major * 10000 + minor * 100 + patch
98
+ *
99
+ * @param {string} versionString The version string to parse
100
+ * @returns {number | undefined} A numeric version code or undefined if parsing fails
101
+ */
102
+ export declare function parseVersionString(versionString: string): number | undefined;
103
+ //# sourceMappingURL=isvalid.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"isvalid.d.ts","sourceRoot":"","sources":["../../src/utils/isvalid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAG/D;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKrF;AAED;;;;;GAKG;AAEH,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,OAAO,CAE3D;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAKjG;AAED;;;;;GAKG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,CAEzD;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAMjG;AAED;;;;;;;GAOG;AAEH,wBAAgB,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,IAAI,OAAO,EAAE,CAKnG;AAED;;;;;GAKG;AAEH,wBAAgB,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,IAAI,CAErD;AAED;;;;;GAKG;AAEH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE/D;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB5E"}
@@ -1,7 +1,45 @@
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
+ */
1
30
  export function isValidIpv4Address(ipv4Address) {
2
31
  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]?)$/;
3
32
  return ipv4Regex.test(ipv4Address);
4
33
  }
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
5
43
  export function isValidNumber(value, min, max) {
6
44
  if (value === undefined || value === null || typeof value !== 'number' || Number.isNaN(value) || !Number.isFinite(value))
7
45
  return false;
@@ -11,9 +49,25 @@ export function isValidNumber(value, min, max) {
11
49
  return false;
12
50
  return true;
13
51
  }
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
14
59
  export function isValidBoolean(value) {
15
60
  return value !== undefined && value !== null && typeof value === 'boolean';
16
61
  }
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
17
71
  export function isValidString(value, minLength, maxLength) {
18
72
  if (value === undefined || value === null || typeof value !== 'string')
19
73
  return false;
@@ -23,9 +77,25 @@ export function isValidString(value, minLength, maxLength) {
23
77
  return false;
24
78
  return true;
25
79
  }
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
26
87
  export function isValidRegExp(value) {
27
88
  return value !== undefined && value !== null && value instanceof RegExp;
28
89
  }
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
29
99
  export function isValidObject(value, minLength, maxLength) {
30
100
  if (value === undefined || value === null || typeof value !== 'object' || Array.isArray(value))
31
101
  return false;
@@ -36,6 +106,15 @@ export function isValidObject(value, minLength, maxLength) {
36
106
  return false;
37
107
  return true;
38
108
  }
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
39
118
  export function isValidArray(value, minLength, maxLength) {
40
119
  if (value === undefined || value === null || !Array.isArray(value))
41
120
  return false;
@@ -45,12 +124,33 @@ export function isValidArray(value, minLength, maxLength) {
45
124
  return false;
46
125
  return true;
47
126
  }
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
48
134
  export function isValidNull(value) {
49
135
  return value === null;
50
136
  }
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
51
144
  export function isValidUndefined(value) {
52
145
  return value === undefined;
53
146
  }
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
+ */
54
154
  export function parseVersionString(versionString) {
55
155
  if (!isValidString(versionString))
56
156
  return undefined;
@@ -67,3 +167,4 @@ export function parseVersionString(versionString) {
67
167
  }
68
168
  return major * 10000 + minor * 100 + patch;
69
169
  }
170
+ //# sourceMappingURL=isvalid.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"isvalid.js","sourceRoot":"","sources":["../../src/utils/isvalid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,WAAmB;IACpD,MAAM,SAAS,GAAG,kKAAkK,CAAC;IACrL,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,KAAU,EAAE,GAAY,EAAE,GAAY;IAClE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACvI,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,KAAK,CAAC;IACnD,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,KAAK,CAAC;IACnD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,UAAU,cAAc,CAAC,KAAU;IACvC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,KAAU,EAAE,SAAkB,EAAE,SAAkB;IAC9E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACrF,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,KAAU;IACtC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,YAAY,MAAM,CAAC;AAC1E,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,aAAa,CAAC,KAAU,EAAE,SAAkB,EAAE,SAAkB;IAC9E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7G,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACrE,IAAI,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACrE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,8DAA8D;AAC9D,MAAM,UAAU,YAAY,CAAC,KAAU,EAAE,SAAkB,EAAE,SAAkB;IAC7E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACjF,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,IAAI,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,KAAK,CAAC;IACtE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,UAAU,WAAW,CAAC,KAAU;IACpC,OAAO,KAAK,KAAK,IAAI,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,UAAU,gBAAgB,CAAC,KAAU;IACzC,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,aAAqB;IACtD,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,aAAa,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC;IACrC,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAE7B,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAErC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;QACrG,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,GAAG,GAAG,KAAK,CAAC;AAC7C,CAAC"}
@@ -0,0 +1,76 @@
1
+ /**
2
+ * This file contains the network functions.
3
+ *
4
+ * @file network.ts
5
+ * @author Luca Liguori
6
+ * @created 2024-02-17
7
+ * @version 1.0.0
8
+ * @license Apache-2.0
9
+ *
10
+ * Copyright 2024, 2025, 2026 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
+ * Retrieves the IPv4 address of the first non-internal network interface.
26
+ *
27
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
28
+ */
29
+ export declare function getIpv4InterfaceAddress(): string | undefined;
30
+ /**
31
+ * Retrieves the IPv6 address of the first non-internal network interface.
32
+ *
33
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
34
+ */
35
+ export declare function getIpv6InterfaceAddress(): string | undefined;
36
+ /**
37
+ * Retrieves the mac address of the first non-internal network interface.
38
+ *
39
+ * @returns {string | undefined} The mac address, or undefined if not found.
40
+ */
41
+ export declare function getMacAddress(): string | undefined;
42
+ /**
43
+ * Logs the available network interfaces and their details.
44
+ *
45
+ * @param {boolean} [debug] - Whether to enable logging of network interface details (default is true).
46
+ * @returns {void}
47
+ */
48
+ export declare function logInterfaces(debug?: boolean): void;
49
+ /**
50
+ * Resolves the given hostname to an IP address.
51
+ *
52
+ * @param {string} hostname - The hostname to resolve.
53
+ * @param {0 | 4 | 6} [family] - The address family to use (0 for any, 4 for IPv4, 6 for IPv6). Default is 4.
54
+ * @returns {Promise<string | null>} - A promise that resolves to the IP address or null if not found.
55
+ *
56
+ * @remarks
57
+ * This function uses DNS lookup to resolve the hostname, which can take some time to complete.
58
+ */
59
+ export declare function resolveHostname(hostname: string, family?: 0 | 4 | 6): Promise<string | null>;
60
+ /**
61
+ * Retrieves the version of an npm package from the npm registry.
62
+ *
63
+ * @param {string} packageName - The name of the npm package.
64
+ * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
65
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
66
+ * @returns {Promise<string>} A promise that resolves to the version string of the package.
67
+ * @throws {Error} If the request fails or the tag is not found.
68
+ */
69
+ export declare function getNpmPackageVersion(packageName: string, tag?: string, timeout?: number): Promise<string>;
70
+ /**
71
+ * Retrieves the path to the global Node.js modules directory.
72
+ *
73
+ * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
74
+ */
75
+ export declare function getGlobalNodeModules(): Promise<string>;
76
+ //# sourceMappingURL=network.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAUH;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAmB5D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAmB5D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAkBlD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,UAAO,QAezC;AAED;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,CAAC,GAAG,CAAC,GAAG,CAAK,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CASrG;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,SAAW,EAAE,OAAO,SAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CA+ChH;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC,CAW5D"}
@@ -1,8 +1,39 @@
1
+ /**
2
+ * This file contains the network functions.
3
+ *
4
+ * @file network.ts
5
+ * @author Luca Liguori
6
+ * @created 2024-02-17
7
+ * @version 1.0.0
8
+ * @license Apache-2.0
9
+ *
10
+ * Copyright 2024, 2025, 2026 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
+ // Node.js modules
1
25
  import os from 'node:os';
26
+ // AnsiLogger module
2
27
  import { AnsiLogger, idn, rs } from 'node-ansi-logger';
28
+ /**
29
+ * Retrieves the IPv4 address of the first non-internal network interface.
30
+ *
31
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
32
+ */
3
33
  export function getIpv4InterfaceAddress() {
4
34
  let ipv4Address;
5
35
  const networkInterfaces = os.networkInterfaces();
36
+ // console.log('Available Network Interfaces:', networkInterfaces);
6
37
  for (const interfaceDetails of Object.values(networkInterfaces)) {
7
38
  if (!interfaceDetails) {
8
39
  break;
@@ -16,11 +47,18 @@ export function getIpv4InterfaceAddress() {
16
47
  break;
17
48
  }
18
49
  }
50
+ // console.log('Selected Network Interfaces:', ipv4Address);
19
51
  return ipv4Address;
20
52
  }
53
+ /**
54
+ * Retrieves the IPv6 address of the first non-internal network interface.
55
+ *
56
+ * @returns {string | undefined} The IPv4 address of the selected network interface, or undefined if not found.
57
+ */
21
58
  export function getIpv6InterfaceAddress() {
22
59
  let ipv6Address;
23
60
  const networkInterfaces = os.networkInterfaces();
61
+ // console.log('Available Network Interfaces:', networkInterfaces);
24
62
  for (const interfaceDetails of Object.values(networkInterfaces)) {
25
63
  if (!interfaceDetails) {
26
64
  break;
@@ -34,11 +72,18 @@ export function getIpv6InterfaceAddress() {
34
72
  break;
35
73
  }
36
74
  }
75
+ // console.log('Selected Network Interfaces:', ipv6Address);
37
76
  return ipv6Address;
38
77
  }
78
+ /**
79
+ * Retrieves the mac address of the first non-internal network interface.
80
+ *
81
+ * @returns {string | undefined} The mac address, or undefined if not found.
82
+ */
39
83
  export function getMacAddress() {
40
84
  let macAddress;
41
85
  const networkInterfaces = os.networkInterfaces();
86
+ // console.log('Available Network Interfaces:', networkInterfaces);
42
87
  for (const interfaceDetails of Object.values(networkInterfaces)) {
43
88
  if (!interfaceDetails) {
44
89
  break;
@@ -54,9 +99,15 @@ export function getMacAddress() {
54
99
  }
55
100
  return macAddress;
56
101
  }
102
+ /**
103
+ * Logs the available network interfaces and their details.
104
+ *
105
+ * @param {boolean} [debug] - Whether to enable logging of network interface details (default is true).
106
+ * @returns {void}
107
+ */
57
108
  export function logInterfaces(debug = true) {
58
- const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4, logLevel: "info" });
59
- log.logLevel = "info";
109
+ const log = new AnsiLogger({ logName: 'MatterbridgeUtils', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "info" /* LogLevel.INFO */ });
110
+ log.logLevel = "info" /* LogLevel.INFO */;
60
111
  log.logName = 'LogInterfaces';
61
112
  const networkInterfaces = os.networkInterfaces();
62
113
  if (debug)
@@ -72,16 +123,36 @@ export function logInterfaces(debug = true) {
72
123
  }
73
124
  }
74
125
  }
126
+ /**
127
+ * Resolves the given hostname to an IP address.
128
+ *
129
+ * @param {string} hostname - The hostname to resolve.
130
+ * @param {0 | 4 | 6} [family] - The address family to use (0 for any, 4 for IPv4, 6 for IPv6). Default is 4.
131
+ * @returns {Promise<string | null>} - A promise that resolves to the IP address or null if not found.
132
+ *
133
+ * @remarks
134
+ * This function uses DNS lookup to resolve the hostname, which can take some time to complete.
135
+ */
75
136
  export async function resolveHostname(hostname, family = 4) {
76
137
  const dns = await import('node:dns');
77
138
  try {
78
- const addresses = await dns.promises.lookup(hostname.toLowerCase(), { family });
139
+ const addresses = await dns.promises.lookup(hostname.toLowerCase() /* + '.local'*/, { family });
79
140
  return addresses.address;
141
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
80
142
  }
81
143
  catch (error) {
82
144
  return null;
83
145
  }
84
146
  }
147
+ /**
148
+ * Retrieves the version of an npm package from the npm registry.
149
+ *
150
+ * @param {string} packageName - The name of the npm package.
151
+ * @param {string} [tag] - The tag of the package version to retrieve (default is 'latest').
152
+ * @param {number} [timeout] - The timeout duration in milliseconds (default is 10000ms).
153
+ * @returns {Promise<string>} A promise that resolves to the version string of the package.
154
+ * @throws {Error} If the request fails or the tag is not found.
155
+ */
85
156
  export async function getNpmPackageVersion(packageName, tag = 'latest', timeout = 10000) {
86
157
  const https = await import('node:https');
87
158
  return new Promise((resolve, reject) => {
@@ -95,8 +166,8 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
95
166
  let data = '';
96
167
  if (res.statusCode !== 200) {
97
168
  clearTimeout(timeoutId);
98
- res.resume();
99
- req.destroy();
169
+ res.resume(); // Discard response data to close the socket properly
170
+ req.destroy(); // Forcefully close the request
100
171
  reject(new Error(`Failed to fetch data. Status code: ${res.statusCode}`));
101
172
  return;
102
173
  }
@@ -107,6 +178,7 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
107
178
  clearTimeout(timeoutId);
108
179
  try {
109
180
  const jsonData = JSON.parse(data);
181
+ // console.log(`Package ${packageName} tag ${tag}`, jsonData);
110
182
  const version = jsonData['dist-tags']?.[tag];
111
183
  if (version) {
112
184
  resolve(version);
@@ -126,6 +198,11 @@ export async function getNpmPackageVersion(packageName, tag = 'latest', timeout
126
198
  });
127
199
  });
128
200
  }
201
+ /**
202
+ * Retrieves the path to the global Node.js modules directory.
203
+ *
204
+ * @returns {Promise<string>} A promise that resolves to the path of the global Node.js modules directory.
205
+ */
129
206
  export async function getGlobalNodeModules() {
130
207
  const { exec } = await import('node:child_process');
131
208
  return new Promise((resolve, reject) => {
@@ -139,3 +216,4 @@ export async function getGlobalNodeModules() {
139
216
  });
140
217
  });
141
218
  }
219
+ //# sourceMappingURL=network.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"network.js","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,kBAAkB;AAClB,OAAO,EAAE,MAAM,SAAS,CAAC;AAIzB,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAAE,GAAG,EAAY,EAAE,EAAmB,MAAM,kBAAkB,CAAC;AAElF;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,IAAI,WAA+B,CAAC;IACpC,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IACjD,mEAAmE;IACnE,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM;QACR,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9E,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM;QACR,CAAC;IACH,CAAC;IACD,4DAA4D;IAC5D,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,IAAI,WAA+B,CAAC;IACpC,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IACjD,mEAAmE;IACnE,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM;QACR,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9E,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;YAC/B,CAAC;QACH,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM;QACR,CAAC;IACH,CAAC;IACD,4DAA4D;IAC5D,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,IAAI,UAA8B,CAAC;IACnC,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IACjD,mEAAmE;IACnE,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM;QACR,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBACjD,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC;YAC1B,CAAC;QACH,CAAC;QACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAK,GAAG,IAAI;IACxC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,4BAAe,EAAE,CAAC,CAAC;IAEvI,GAAG,CAAC,QAAQ,6BAAgB,CAAC;IAC7B,GAAG,CAAC,OAAO,GAAG,eAAe,CAAC;IAE9B,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IACjD,IAAI,KAAK;QAAE,GAAG,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IACrD,KAAK,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAClF,IAAI,CAAC,gBAAgB;YAAE,MAAM;QAC7B,IAAI,KAAK;YAAE,GAAG,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,aAAa,GAAG,EAAE,EAAE,CAAC,CAAC;QAC9D,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;YACtC,IAAI,KAAK;gBAAE,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,QAAgB,EAAE,SAAoB,CAAC;IAC3E,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAChG,OAAO,SAAS,CAAC,OAAO,CAAC;QACzB,6DAA6D;IAC/D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,WAAmB,EAAE,GAAG,GAAG,QAAQ,EAAE,OAAO,GAAG,KAAK;IAC7F,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IACzC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,8BAA8B,WAAW,EAAE,CAAC;QACxD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,UAAU,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC;QACzE,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;YAChE,IAAI,IAAI,GAAG,EAAE,CAAC;YAEd,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC3B,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,qDAAqD;gBACnE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,+BAA+B;gBAC9C,MAAM,CAAC,IAAI,KAAK,CAAC,sCAAsC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC1E,OAAO;YACT,CAAC;YAED,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBACvB,IAAI,IAAI,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,IAAI,CAAC;oBACH,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAClC,8DAA8D;oBAC9D,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;oBAC7C,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,CAAC,OAAO,CAAC,CAAC;oBACnB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,GAAG,4BAA4B,WAAW,GAAG,CAAC,CAAC,CAAC;oBAC3E,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,KAAK,CAAC,kCAAkC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACxG,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACxB,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IACxC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,CAAC,aAAa,EAAE,CAAC,KAA2B,EAAE,MAAc,EAAE,EAAE;YAClE,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACzB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { Matterbridge } from '../matterbridge.js';
2
+ declare const _default: {
3
+ /**
4
+ * Spawns a child process with the given command and arguments.
5
+ *
6
+ * @param {Matterbridge} matterbridge - The Matterbridge instance to use for logging and sending messages.
7
+ * @param {string} command - The command to execute.
8
+ * @param {string[]} args - The arguments to pass to the command (default: []).
9
+ * @returns {Promise<boolean>} A promise that resolves when the child process exits successfully, or rejects if there is an error.
10
+ */
11
+ spawnCommand(matterbridge: Matterbridge, command: string, args: string[]): Promise<boolean>;
12
+ };
13
+ export default _default;
14
+ //# sourceMappingURL=spawn.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"spawn.d.ts","sourceRoot":"","sources":["../../src/utils/spawn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;;IAKhD;;;;;;;OAOG;+BAC8B,YAAY,WAAW,MAAM,QAAQ,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;;AATnG,wBAuFE"}