matterbridge 3.4.3-dev-20251209-e6cb85f → 3.4.3

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 (324) hide show
  1. package/README.md +2 -3
  2. package/dist/broadcastServer.d.ts +144 -0
  3. package/dist/broadcastServer.d.ts.map +1 -0
  4. package/dist/broadcastServer.js +119 -0
  5. package/dist/broadcastServer.js.map +1 -0
  6. package/dist/broadcastServerTypes.d.ts +841 -0
  7. package/dist/broadcastServerTypes.d.ts.map +1 -0
  8. package/dist/broadcastServerTypes.js +24 -0
  9. package/dist/broadcastServerTypes.js.map +1 -0
  10. package/dist/cli.d.ts +30 -0
  11. package/dist/cli.d.ts.map +1 -0
  12. package/dist/cli.js +97 -1
  13. package/dist/cli.js.map +1 -0
  14. package/dist/cliEmitter.d.ts +50 -0
  15. package/dist/cliEmitter.d.ts.map +1 -0
  16. package/dist/cliEmitter.js +37 -0
  17. package/dist/cliEmitter.js.map +1 -0
  18. package/dist/cliHistory.d.ts +48 -0
  19. package/dist/cliHistory.d.ts.map +1 -0
  20. package/dist/cliHistory.js +38 -0
  21. package/dist/cliHistory.js.map +1 -0
  22. package/dist/clusters/export.d.ts +2 -0
  23. package/dist/clusters/export.d.ts.map +1 -0
  24. package/dist/clusters/export.js +2 -0
  25. package/dist/clusters/export.js.map +1 -0
  26. package/dist/deviceManager.d.ts +135 -0
  27. package/dist/deviceManager.d.ts.map +1 -0
  28. package/dist/deviceManager.js +113 -1
  29. package/dist/deviceManager.js.map +1 -0
  30. package/dist/devices/airConditioner.d.ts +98 -0
  31. package/dist/devices/airConditioner.d.ts.map +1 -0
  32. package/dist/devices/airConditioner.js +57 -0
  33. package/dist/devices/airConditioner.js.map +1 -0
  34. package/dist/devices/batteryStorage.d.ts +48 -0
  35. package/dist/devices/batteryStorage.d.ts.map +1 -0
  36. package/dist/devices/batteryStorage.js +48 -1
  37. package/dist/devices/batteryStorage.js.map +1 -0
  38. package/dist/devices/cooktop.d.ts +61 -0
  39. package/dist/devices/cooktop.d.ts.map +1 -0
  40. package/dist/devices/cooktop.js +56 -0
  41. package/dist/devices/cooktop.js.map +1 -0
  42. package/dist/devices/dishwasher.d.ts +71 -0
  43. package/dist/devices/dishwasher.d.ts.map +1 -0
  44. package/dist/devices/dishwasher.js +57 -0
  45. package/dist/devices/dishwasher.js.map +1 -0
  46. package/dist/devices/evse.d.ts +76 -0
  47. package/dist/devices/evse.d.ts.map +1 -0
  48. package/dist/devices/evse.js +74 -10
  49. package/dist/devices/evse.js.map +1 -0
  50. package/dist/devices/export.d.ts +17 -0
  51. package/dist/devices/export.d.ts.map +1 -0
  52. package/dist/devices/export.js +5 -0
  53. package/dist/devices/export.js.map +1 -0
  54. package/dist/devices/extractorHood.d.ts +46 -0
  55. package/dist/devices/extractorHood.d.ts.map +1 -0
  56. package/dist/devices/extractorHood.js +43 -0
  57. package/dist/devices/extractorHood.js.map +1 -0
  58. package/dist/devices/heatPump.d.ts +47 -0
  59. package/dist/devices/heatPump.d.ts.map +1 -0
  60. package/dist/devices/heatPump.js +50 -2
  61. package/dist/devices/heatPump.js.map +1 -0
  62. package/dist/devices/laundryDryer.d.ts +67 -0
  63. package/dist/devices/laundryDryer.d.ts.map +1 -0
  64. package/dist/devices/laundryDryer.js +62 -3
  65. package/dist/devices/laundryDryer.js.map +1 -0
  66. package/dist/devices/laundryWasher.d.ts +81 -0
  67. package/dist/devices/laundryWasher.d.ts.map +1 -0
  68. package/dist/devices/laundryWasher.js +70 -4
  69. package/dist/devices/laundryWasher.js.map +1 -0
  70. package/dist/devices/microwaveOven.d.ts +168 -0
  71. package/dist/devices/microwaveOven.d.ts.map +1 -0
  72. package/dist/devices/microwaveOven.js +88 -5
  73. package/dist/devices/microwaveOven.js.map +1 -0
  74. package/dist/devices/oven.d.ts +105 -0
  75. package/dist/devices/oven.d.ts.map +1 -0
  76. package/dist/devices/oven.js +85 -0
  77. package/dist/devices/oven.js.map +1 -0
  78. package/dist/devices/refrigerator.d.ts +118 -0
  79. package/dist/devices/refrigerator.d.ts.map +1 -0
  80. package/dist/devices/refrigerator.js +102 -0
  81. package/dist/devices/refrigerator.js.map +1 -0
  82. package/dist/devices/roboticVacuumCleaner.d.ts +112 -0
  83. package/dist/devices/roboticVacuumCleaner.d.ts.map +1 -0
  84. package/dist/devices/roboticVacuumCleaner.js +100 -9
  85. package/dist/devices/roboticVacuumCleaner.js.map +1 -0
  86. package/dist/devices/solarPower.d.ts +40 -0
  87. package/dist/devices/solarPower.d.ts.map +1 -0
  88. package/dist/devices/solarPower.js +38 -0
  89. package/dist/devices/solarPower.js.map +1 -0
  90. package/dist/devices/speaker.d.ts +87 -0
  91. package/dist/devices/speaker.d.ts.map +1 -0
  92. package/dist/devices/speaker.js +84 -0
  93. package/dist/devices/speaker.js.map +1 -0
  94. package/dist/devices/temperatureControl.d.ts +166 -0
  95. package/dist/devices/temperatureControl.d.ts.map +1 -0
  96. package/dist/devices/temperatureControl.js +24 -3
  97. package/dist/devices/temperatureControl.js.map +1 -0
  98. package/dist/devices/waterHeater.d.ts +111 -0
  99. package/dist/devices/waterHeater.d.ts.map +1 -0
  100. package/dist/devices/waterHeater.js +82 -2
  101. package/dist/devices/waterHeater.js.map +1 -0
  102. package/dist/dgram/coap.d.ts +205 -0
  103. package/dist/dgram/coap.d.ts.map +1 -0
  104. package/dist/dgram/coap.js +126 -13
  105. package/dist/dgram/coap.js.map +1 -0
  106. package/dist/dgram/dgram.d.ts +141 -0
  107. package/dist/dgram/dgram.d.ts.map +1 -0
  108. package/dist/dgram/dgram.js +114 -2
  109. package/dist/dgram/dgram.js.map +1 -0
  110. package/dist/dgram/mb_coap.d.ts +24 -0
  111. package/dist/dgram/mb_coap.d.ts.map +1 -0
  112. package/dist/dgram/mb_coap.js +41 -3
  113. package/dist/dgram/mb_coap.js.map +1 -0
  114. package/dist/dgram/mb_mdns.d.ts +24 -0
  115. package/dist/dgram/mb_mdns.d.ts.map +1 -0
  116. package/dist/dgram/mb_mdns.js +80 -15
  117. package/dist/dgram/mb_mdns.js.map +1 -0
  118. package/dist/dgram/mdns.d.ts +290 -0
  119. package/dist/dgram/mdns.d.ts.map +1 -0
  120. package/dist/dgram/mdns.js +299 -137
  121. package/dist/dgram/mdns.js.map +1 -0
  122. package/dist/dgram/multicast.d.ts +67 -0
  123. package/dist/dgram/multicast.d.ts.map +1 -0
  124. package/dist/dgram/multicast.js +62 -1
  125. package/dist/dgram/multicast.js.map +1 -0
  126. package/dist/dgram/unicast.d.ts +56 -0
  127. package/dist/dgram/unicast.d.ts.map +1 -0
  128. package/dist/dgram/unicast.js +54 -0
  129. package/dist/dgram/unicast.js.map +1 -0
  130. package/dist/frontend.d.ts +238 -0
  131. package/dist/frontend.d.ts.map +1 -0
  132. package/dist/frontend.js +455 -35
  133. package/dist/frontend.js.map +1 -0
  134. package/dist/frontendTypes.d.ts +529 -0
  135. package/dist/frontendTypes.d.ts.map +1 -0
  136. package/dist/frontendTypes.js +45 -0
  137. package/dist/frontendTypes.js.map +1 -0
  138. package/dist/helpers.d.ts +48 -0
  139. package/dist/helpers.d.ts.map +1 -0
  140. package/dist/helpers.js +53 -0
  141. package/dist/helpers.js.map +1 -0
  142. package/dist/index.d.ts +34 -0
  143. package/dist/index.d.ts.map +1 -0
  144. package/dist/index.js +25 -0
  145. package/dist/index.js.map +1 -0
  146. package/dist/jestutils/export.d.ts +2 -0
  147. package/dist/jestutils/export.d.ts.map +1 -0
  148. package/dist/jestutils/export.js +1 -0
  149. package/dist/jestutils/export.js.map +1 -0
  150. package/dist/jestutils/jestHelpers.d.ts +345 -0
  151. package/dist/jestutils/jestHelpers.d.ts.map +1 -0
  152. package/dist/jestutils/jestHelpers.js +371 -14
  153. package/dist/jestutils/jestHelpers.js.map +1 -0
  154. package/dist/logger/export.d.ts +2 -0
  155. package/dist/logger/export.d.ts.map +1 -0
  156. package/dist/logger/export.js +1 -0
  157. package/dist/logger/export.js.map +1 -0
  158. package/dist/matter/behaviors.d.ts +2 -0
  159. package/dist/matter/behaviors.d.ts.map +1 -0
  160. package/dist/matter/behaviors.js +2 -0
  161. package/dist/matter/behaviors.js.map +1 -0
  162. package/dist/matter/clusters.d.ts +2 -0
  163. package/dist/matter/clusters.d.ts.map +1 -0
  164. package/dist/matter/clusters.js +2 -0
  165. package/dist/matter/clusters.js.map +1 -0
  166. package/dist/matter/devices.d.ts +2 -0
  167. package/dist/matter/devices.d.ts.map +1 -0
  168. package/dist/matter/devices.js +2 -0
  169. package/dist/matter/devices.js.map +1 -0
  170. package/dist/matter/endpoints.d.ts +2 -0
  171. package/dist/matter/endpoints.d.ts.map +1 -0
  172. package/dist/matter/endpoints.js +2 -0
  173. package/dist/matter/endpoints.js.map +1 -0
  174. package/dist/matter/export.d.ts +5 -0
  175. package/dist/matter/export.d.ts.map +1 -0
  176. package/dist/matter/export.js +3 -0
  177. package/dist/matter/export.js.map +1 -0
  178. package/dist/matter/types.d.ts +3 -0
  179. package/dist/matter/types.d.ts.map +1 -0
  180. package/dist/matter/types.js +3 -0
  181. package/dist/matter/types.js.map +1 -0
  182. package/dist/matterNode.d.ts +342 -0
  183. package/dist/matterNode.d.ts.map +1 -0
  184. package/dist/matterNode.js +369 -8
  185. package/dist/matterNode.js.map +1 -0
  186. package/dist/matterbridge.d.ts +492 -0
  187. package/dist/matterbridge.d.ts.map +1 -0
  188. package/dist/matterbridge.js +811 -46
  189. package/dist/matterbridge.js.map +1 -0
  190. package/dist/matterbridgeAccessoryPlatform.d.ts +41 -0
  191. package/dist/matterbridgeAccessoryPlatform.d.ts.map +1 -0
  192. package/dist/matterbridgeAccessoryPlatform.js +38 -0
  193. package/dist/matterbridgeAccessoryPlatform.js.map +1 -0
  194. package/dist/matterbridgeBehaviors.d.ts +2404 -0
  195. package/dist/matterbridgeBehaviors.d.ts.map +1 -0
  196. package/dist/matterbridgeBehaviors.js +68 -5
  197. package/dist/matterbridgeBehaviors.js.map +1 -0
  198. package/dist/matterbridgeDeviceTypes.d.ts +698 -0
  199. package/dist/matterbridgeDeviceTypes.d.ts.map +1 -0
  200. package/dist/matterbridgeDeviceTypes.js +635 -14
  201. package/dist/matterbridgeDeviceTypes.js.map +1 -0
  202. package/dist/matterbridgeDynamicPlatform.d.ts +41 -0
  203. package/dist/matterbridgeDynamicPlatform.d.ts.map +1 -0
  204. package/dist/matterbridgeDynamicPlatform.js +38 -0
  205. package/dist/matterbridgeDynamicPlatform.js.map +1 -0
  206. package/dist/matterbridgeEndpoint.d.ts +1507 -0
  207. package/dist/matterbridgeEndpoint.d.ts.map +1 -0
  208. package/dist/matterbridgeEndpoint.js +1444 -53
  209. package/dist/matterbridgeEndpoint.js.map +1 -0
  210. package/dist/matterbridgeEndpointHelpers.d.ts +787 -0
  211. package/dist/matterbridgeEndpointHelpers.d.ts.map +1 -0
  212. package/dist/matterbridgeEndpointHelpers.js +483 -20
  213. package/dist/matterbridgeEndpointHelpers.js.map +1 -0
  214. package/dist/matterbridgeEndpointTypes.d.ts +166 -0
  215. package/dist/matterbridgeEndpointTypes.d.ts.map +1 -0
  216. package/dist/matterbridgeEndpointTypes.js +25 -0
  217. package/dist/matterbridgeEndpointTypes.js.map +1 -0
  218. package/dist/matterbridgePlatform.d.ts +539 -0
  219. package/dist/matterbridgePlatform.d.ts.map +1 -0
  220. package/dist/matterbridgePlatform.js +451 -1
  221. package/dist/matterbridgePlatform.js.map +1 -0
  222. package/dist/matterbridgeTypes.d.ts +251 -0
  223. package/dist/matterbridgeTypes.d.ts.map +1 -0
  224. package/dist/matterbridgeTypes.js +26 -0
  225. package/dist/matterbridgeTypes.js.map +1 -0
  226. package/dist/pluginManager.d.ts +372 -0
  227. package/dist/pluginManager.d.ts.map +1 -0
  228. package/dist/pluginManager.js +341 -5
  229. package/dist/pluginManager.js.map +1 -0
  230. package/dist/shelly.d.ts +181 -0
  231. package/dist/shelly.d.ts.map +1 -0
  232. package/dist/shelly.js +178 -7
  233. package/dist/shelly.js.map +1 -0
  234. package/dist/storage/export.d.ts +2 -0
  235. package/dist/storage/export.d.ts.map +1 -0
  236. package/dist/storage/export.js +1 -0
  237. package/dist/storage/export.js.map +1 -0
  238. package/dist/update.d.ts +84 -0
  239. package/dist/update.d.ts.map +1 -0
  240. package/dist/update.js +93 -1
  241. package/dist/update.js.map +1 -0
  242. package/dist/utils/colorUtils.d.ts +101 -0
  243. package/dist/utils/colorUtils.d.ts.map +1 -0
  244. package/dist/utils/colorUtils.js +97 -2
  245. package/dist/utils/colorUtils.js.map +1 -0
  246. package/dist/utils/commandLine.d.ts +66 -0
  247. package/dist/utils/commandLine.d.ts.map +1 -0
  248. package/dist/utils/commandLine.js +60 -0
  249. package/dist/utils/commandLine.js.map +1 -0
  250. package/dist/utils/copyDirectory.d.ts +35 -0
  251. package/dist/utils/copyDirectory.d.ts.map +1 -0
  252. package/dist/utils/copyDirectory.js +37 -0
  253. package/dist/utils/copyDirectory.js.map +1 -0
  254. package/dist/utils/createDirectory.d.ts +34 -0
  255. package/dist/utils/createDirectory.d.ts.map +1 -0
  256. package/dist/utils/createDirectory.js +33 -0
  257. package/dist/utils/createDirectory.js.map +1 -0
  258. package/dist/utils/createZip.d.ts +39 -0
  259. package/dist/utils/createZip.d.ts.map +1 -0
  260. package/dist/utils/createZip.js +47 -2
  261. package/dist/utils/createZip.js.map +1 -0
  262. package/dist/utils/deepCopy.d.ts +32 -0
  263. package/dist/utils/deepCopy.d.ts.map +1 -0
  264. package/dist/utils/deepCopy.js +39 -0
  265. package/dist/utils/deepCopy.js.map +1 -0
  266. package/dist/utils/deepEqual.d.ts +54 -0
  267. package/dist/utils/deepEqual.d.ts.map +1 -0
  268. package/dist/utils/deepEqual.js +72 -1
  269. package/dist/utils/deepEqual.js.map +1 -0
  270. package/dist/utils/error.d.ts +45 -0
  271. package/dist/utils/error.d.ts.map +1 -0
  272. package/dist/utils/error.js +42 -0
  273. package/dist/utils/error.js.map +1 -0
  274. package/dist/utils/export.d.ts +13 -0
  275. package/dist/utils/export.d.ts.map +1 -0
  276. package/dist/utils/export.js +1 -0
  277. package/dist/utils/export.js.map +1 -0
  278. package/dist/utils/format.d.ts +53 -0
  279. package/dist/utils/format.d.ts.map +1 -0
  280. package/dist/utils/format.js +49 -0
  281. package/dist/utils/format.js.map +1 -0
  282. package/dist/utils/hex.d.ts +89 -0
  283. package/dist/utils/hex.d.ts.map +1 -0
  284. package/dist/utils/hex.js +124 -0
  285. package/dist/utils/hex.js.map +1 -0
  286. package/dist/utils/inspector.d.ts +87 -0
  287. package/dist/utils/inspector.d.ts.map +1 -0
  288. package/dist/utils/inspector.js +69 -1
  289. package/dist/utils/inspector.js.map +1 -0
  290. package/dist/utils/isvalid.d.ts +103 -0
  291. package/dist/utils/isvalid.d.ts.map +1 -0
  292. package/dist/utils/isvalid.js +101 -0
  293. package/dist/utils/isvalid.js.map +1 -0
  294. package/dist/utils/network.d.ts +111 -0
  295. package/dist/utils/network.d.ts.map +1 -0
  296. package/dist/utils/network.js +96 -5
  297. package/dist/utils/network.js.map +1 -0
  298. package/dist/utils/spawn.d.ts +33 -0
  299. package/dist/utils/spawn.d.ts.map +1 -0
  300. package/dist/utils/spawn.js +71 -1
  301. package/dist/utils/spawn.js.map +1 -0
  302. package/dist/utils/tracker.d.ts +108 -0
  303. package/dist/utils/tracker.d.ts.map +1 -0
  304. package/dist/utils/tracker.js +64 -1
  305. package/dist/utils/tracker.js.map +1 -0
  306. package/dist/utils/wait.d.ts +54 -0
  307. package/dist/utils/wait.d.ts.map +1 -0
  308. package/dist/utils/wait.js +60 -8
  309. package/dist/utils/wait.js.map +1 -0
  310. package/dist/workerGlobalPrefix.d.ts +25 -0
  311. package/dist/workerGlobalPrefix.d.ts.map +1 -0
  312. package/dist/workerGlobalPrefix.js +37 -5
  313. package/dist/workerGlobalPrefix.js.map +1 -0
  314. package/dist/workerTypes.d.ts +52 -0
  315. package/dist/workerTypes.d.ts.map +1 -0
  316. package/dist/workerTypes.js +24 -0
  317. package/dist/workerTypes.js.map +1 -0
  318. package/dist/workers.d.ts +69 -0
  319. package/dist/workers.d.ts.map +1 -0
  320. package/dist/workers.js +68 -4
  321. package/dist/workers.js.map +1 -0
  322. package/npm-shrinkwrap.json +2 -2
  323. package/package.json +2 -1
  324. package/scripts/data_model.mjs +2058 -0
@@ -0,0 +1,372 @@
1
+ /**
2
+ * This file contains the Plugins class.
3
+ *
4
+ * @file plugins.ts
5
+ * @author Luca Liguori
6
+ * @created 2024-07-14
7
+ * @version 1.3.5
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
+ import EventEmitter from 'node:events';
25
+ import { LogLevel } from 'node-ansi-logger';
26
+ import type { Matterbridge } from './matterbridge.js';
27
+ import type { MatterbridgePlatform, PlatformConfig, PlatformSchema } from './matterbridgePlatform.js';
28
+ import { ApiPlugin, Plugin, PluginName, StoragePlugin } from './matterbridgeTypes.js';
29
+ interface PluginManagerEvents {
30
+ added: [name: string];
31
+ removed: [name: string];
32
+ loaded: [name: string];
33
+ enabled: [name: string];
34
+ disabled: [name: string];
35
+ installed: [name: string, version: string | undefined];
36
+ uninstalled: [name: string];
37
+ started: [name: string];
38
+ configured: [name: string];
39
+ shutdown: [name: string];
40
+ }
41
+ /**
42
+ * Manages Matterbridge plugins.
43
+ */
44
+ export declare class PluginManager extends EventEmitter<PluginManagerEvents> {
45
+ private readonly matterbridge;
46
+ private readonly _plugins;
47
+ private readonly log;
48
+ private readonly server;
49
+ private readonly debug;
50
+ private readonly verbose;
51
+ /**
52
+ * Creates an instance of PluginManager.
53
+ *
54
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
55
+ */
56
+ constructor(matterbridge: Matterbridge);
57
+ destroy(): void;
58
+ private msgHandler;
59
+ /**
60
+ * Gets the number of plugins.
61
+ *
62
+ * @returns {number} The number of plugins.
63
+ */
64
+ get length(): number;
65
+ /**
66
+ * Gets the number of plugins.
67
+ *
68
+ * @returns {number} The number of plugins.
69
+ */
70
+ get size(): number;
71
+ /**
72
+ * Checks if a plugin with the specified name exists.
73
+ *
74
+ * @param {string} name - The name of the plugin.
75
+ * @returns {boolean} True if the plugin exists, false otherwise.
76
+ */
77
+ has(name: string): boolean;
78
+ /**
79
+ * Gets a plugin by its name.
80
+ *
81
+ * @param {string} name - The name of the plugin.
82
+ * @returns {Plugin | undefined} The plugin, or undefined if not found.
83
+ */
84
+ get(name: string): Plugin | undefined;
85
+ /**
86
+ * Adds a plugin to the manager.
87
+ *
88
+ * @param {Plugin} plugin - The plugin to add.
89
+ * @returns {Plugin} The added plugin.
90
+ */
91
+ set(plugin: Plugin): Plugin;
92
+ /**
93
+ * Clears all plugins from the manager.
94
+ */
95
+ clear(): void;
96
+ /**
97
+ * Converts a plugin or API plugin to a storage plugin.
98
+ *
99
+ * @param {Plugin | ApiPlugin} plugin - The plugin or API plugin to convert.
100
+ * @returns {StoragePlugin} The converted storage plugin.
101
+ */
102
+ private toStoragePlugin;
103
+ /**
104
+ * Converts a plugin to an API plugin.
105
+ *
106
+ * @param {Plugin} plugin - The plugin to convert.
107
+ * @returns {ApiPlugin} The converted API plugin.
108
+ */
109
+ private toApiPlugin;
110
+ /**
111
+ * Gets an array of all plugins.
112
+ *
113
+ * @returns {Plugin[]} An array of all plugins.
114
+ */
115
+ array(): Plugin[];
116
+ /**
117
+ * Gets a StoragePlugin array of all plugins suitable for serialization.
118
+ *
119
+ * @returns {StoragePlugin[]} An array of all plugins.
120
+ */
121
+ storagePluginArray(): StoragePlugin[];
122
+ /**
123
+ * Gets an ApiPlugin array of all plugins suitable for serialization.
124
+ *
125
+ * @returns {ApiPlugin[]} An array of all plugins.
126
+ */
127
+ apiPluginArray(): ApiPlugin[];
128
+ /**
129
+ * Gets an iterator for the plugins.
130
+ *
131
+ * @returns {IterableIterator<Plugin>} An iterator for the plugins.
132
+ */
133
+ [Symbol.iterator](): MapIterator<Plugin>;
134
+ /**
135
+ * Executes a provided function once for each plugin.
136
+ *
137
+ * @param {Function} callback - The function to execute for each plugin.
138
+ * @returns {Promise<void>}
139
+ */
140
+ forEach(callback: (plugin: Plugin) => Promise<void>): Promise<void>;
141
+ /**
142
+ * Sets the log level for the plugin manager.
143
+ *
144
+ * @param {LogLevel} logLevel - The log level to set.
145
+ */
146
+ set logLevel(logLevel: LogLevel);
147
+ /**
148
+ * Loads registered plugins from storage.
149
+ *
150
+ * @returns {Promise<StoragePlugin[]>} A promise that resolves to an array of registered plugins.
151
+ */
152
+ loadFromStorage(): Promise<StoragePlugin[]>;
153
+ /**
154
+ * Saves registered plugins to storage.
155
+ *
156
+ * @returns {Promise<number>} A promise that resolves to the number of registered plugins.
157
+ */
158
+ saveToStorage(): Promise<number>;
159
+ /**
160
+ * Resolves the name of a plugin by loading and parsing its package.json file.
161
+ * It will first try to resolve the path as is, then in the global modules directory, and finally in the matterbridge plugin directory.
162
+ *
163
+ * @param {string} nameOrPath - The name of the plugin or the path to the plugin's package.json file.
164
+ * @returns {Promise<string | null>} A promise that resolves to the path of the plugin's package.json file or null if it could not be resolved.
165
+ */
166
+ resolve(nameOrPath: string): Promise<string | null>;
167
+ /**
168
+ * Installs a package globally using npm.
169
+ *
170
+ * @param {string} packageName - The name of the package to install.
171
+ * @returns {Promise<boolean>} A promise that resolves to true if the installation was successful, false otherwise.
172
+ */
173
+ install(packageName: string): Promise<boolean>;
174
+ /**
175
+ * Uninstalls a package globally using npm.
176
+ *
177
+ * @param {string} packageName - The name of the package to uninstall.
178
+ * @returns {Promise<boolean>} A promise that resolves to true if the uninstallation was successful, false otherwise.
179
+ */
180
+ uninstall(packageName: string): Promise<boolean>;
181
+ /**
182
+ * Get the author of a plugin from its package.json.
183
+ *
184
+ * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
185
+ * @returns {string} The author of the plugin, or 'Unknown author' if not found.
186
+ */
187
+ getAuthor(packageJson: Record<string, string | number | Record<string, string | number | object>>): string;
188
+ /**
189
+ * Get the homepage of a plugin from its package.json.
190
+ *
191
+ * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
192
+ * @returns {string | undefined} The homepage of the plugin, or undefined if not found.
193
+ */
194
+ getHomepage(packageJson: Record<string, string | number | Record<string, string | number | object>>): string | undefined;
195
+ /**
196
+ * Get the help URL of a plugin from its package.json.
197
+ *
198
+ * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
199
+ * @returns {string | undefined} The URL to the help page or to the README file, or undefined if not found.
200
+ */
201
+ getHelp(packageJson: Record<string, string | number | Record<string, string | number | object>>): string | undefined;
202
+ /**
203
+ * Get the changelog URL of a plugin from its package.json.
204
+ *
205
+ * @param {Record<string, string | number | Record<string, string | number | object>>} packageJson - The package.json object of the plugin.
206
+ * @returns {string | undefined} The URL to the CHANGELOG file, or undefined if not found.
207
+ */
208
+ getChangelog(packageJson: Record<string, string | number | Record<string, string | number | object>>): string | undefined;
209
+ /**
210
+ * Get the first funding URL(s) of a plugin from its package.json.
211
+ *
212
+ * @param {Record<string, any>} packageJson - The package.json object of the plugin.
213
+ * @returns {string | undefined} The first funding URLs, or undefined if not found.
214
+ */
215
+ getFunding(packageJson: Record<string, any>): string | undefined;
216
+ /**
217
+ * Parses the plugin package.json and returns it.
218
+ * It will also log warnings and errors for missing or invalid fields.
219
+ * It will return null if critical errors are found.
220
+ *
221
+ * @param {Plugin | PluginName} plugin - The plugin to load the package from.
222
+ * @returns {Promise<Record<string, string | number | object> | null>} A promise that resolves to the parsed package.json object or null if it could not be parsed.
223
+ */
224
+ parse(plugin: Plugin | PluginName): Promise<Record<string, string | number | object> | null>;
225
+ /**
226
+ * Enables a plugin by its name or path.
227
+ *
228
+ * This method enables a plugin by setting its `enabled` property to `true` and saving the updated
229
+ * plugin information to storage. It first checks if the plugin is already registered in the `_plugins` map.
230
+ * If not, it attempts to resolve the plugin's `package.json` file to retrieve its name and enable it.
231
+ *
232
+ * @param {string} nameOrPath - The name or path of the plugin to enable.
233
+ * @returns {Promise<Plugin | null>} A promise that resolves to the enabled plugin object, or null if the plugin could not be enabled.
234
+ */
235
+ enable(nameOrPath: string): Promise<Plugin | null>;
236
+ /**
237
+ * Disables a plugin by its name or path.
238
+ *
239
+ * This method disables a plugin by setting its `enabled` property to `false` and saving the updated
240
+ * plugin information to storage. It first checks if the plugin is already registered in the `_plugins` map.
241
+ * If not, it attempts to resolve the plugin's `package.json` file to retrieve its name and disable it.
242
+ *
243
+ * @param {string} nameOrPath - The name or path of the plugin to enable.
244
+ * @returns {Promise<Plugin | null>} A promise that resolves to the disabled plugin object, or null if the plugin could not be disabled.
245
+ */
246
+ disable(nameOrPath: string): Promise<Plugin | null>;
247
+ /**
248
+ * Removes a plugin by its name or path.
249
+ *
250
+ * This method removes a plugin from the `_plugins` map and saves the updated plugin information to storage.
251
+ * It first checks if the plugin is already registered in the `_plugins` map. If not, it attempts to resolve
252
+ * the plugin's `package.json` file to retrieve its name and remove it.
253
+ *
254
+ * @param {string} nameOrPath - The name or path of the plugin to remove.
255
+ * @returns {Promise<Plugin | null>} A promise that resolves to the removed plugin object, or null if the plugin could not be removed.
256
+ */
257
+ remove(nameOrPath: string): Promise<Plugin | null>;
258
+ /**
259
+ * Adds a plugin by its name or path.
260
+ *
261
+ * This method adds a plugin to the plugins map and saves the updated plugin information to storage.
262
+ * It first resolves the plugin's `package.json` file to retrieve its details. If the plugin is already
263
+ * registered, it logs an info message and returns null. Otherwise, it registers the plugin, enables it,
264
+ * and saves the updated plugin information to storage.
265
+ *
266
+ * @param {string} nameOrPath - The name or path of the plugin to add.
267
+ * @returns {Promise<Plugin | null>} A promise that resolves to the added plugin object, or null if the plugin could not be added.
268
+ */
269
+ add(nameOrPath: string): Promise<Plugin | null>;
270
+ /**
271
+ * Loads a plugin and returns the corresponding MatterbridgePlatform instance.
272
+ *
273
+ * @param {Plugin | PluginName} plugin - The plugin to load.
274
+ * @param {boolean} start - Optional flag indicating whether to start the plugin after loading. Default is false.
275
+ * @param {string} message - Optional message to pass to the plugin when starting.
276
+ * @param {boolean} configure - Optional flag indicating whether to configure the plugin after loading. Default is false.
277
+ * @returns {Promise<MatterbridgePlatform | undefined>} A Promise that resolves to the loaded MatterbridgePlatform instance or undefined.
278
+ */
279
+ load(plugin: Plugin | PluginName, start?: boolean, message?: string, configure?: boolean): Promise<MatterbridgePlatform | undefined>;
280
+ /**
281
+ * Starts a plugin.
282
+ *
283
+ * @param {Plugin | PluginName} plugin - The plugin to start.
284
+ * @param {string} [message] - Optional message to pass to the plugin's onStart method.
285
+ * @param {boolean} [configure] - Indicates whether to configure the plugin after starting (default false).
286
+ * @returns {Promise<Plugin | undefined>} A promise that resolves when the plugin is started successfully, or rejects with an error if starting the plugin fails.
287
+ */
288
+ start(plugin: Plugin | PluginName, message?: string, configure?: boolean): Promise<Plugin | undefined>;
289
+ /**
290
+ * Configures a plugin.
291
+ *
292
+ * @param {Plugin | PluginName} plugin - The plugin to configure.
293
+ * @returns {Promise<Plugin | undefined>} A promise that resolves when the plugin is configured successfully, or rejects with an error if configuration fails.
294
+ */
295
+ configure(plugin: Plugin | PluginName): Promise<Plugin | undefined>;
296
+ /**
297
+ * Shuts down a plugin.
298
+ *
299
+ * This method shuts down a plugin by calling its `onShutdown` method and resetting its state.
300
+ * It logs the shutdown process and optionally removes all devices associated with the plugin.
301
+ *
302
+ * @param {Plugin | PluginName} plugin - The plugin to shut down.
303
+ * @param {string} [reason] - The reason for shutting down the plugin.
304
+ * @param {boolean} [removeAllDevices] - Whether to remove all devices associated with the plugin.
305
+ * @param {boolean} [force] - Whether to force the shutdown even if the plugin is not loaded or started.
306
+ * @returns {Promise<Plugin | undefined>} A promise that resolves to the shut down plugin object, or undefined if the shutdown failed.
307
+ */
308
+ shutdown(plugin: Plugin | PluginName, reason?: string, removeAllDevices?: boolean, force?: boolean): Promise<Plugin | undefined>;
309
+ /**
310
+ * Loads the configuration for a plugin.
311
+ * If the configuration file exists, it reads the file and returns the parsed JSON data.
312
+ * If the configuration file does not exist, it creates a new file with default configuration and returns it.
313
+ * If any error occurs during file access or creation, it logs an error and return un empty config.
314
+ *
315
+ * @param {Plugin} plugin - The plugin for which to load the configuration.
316
+ * @returns {Promise<PlatformConfig>} A promise that resolves to the loaded or created configuration.
317
+ */
318
+ loadConfig(plugin: Plugin): Promise<PlatformConfig>;
319
+ /**
320
+ * Saves the configuration of a plugin to a file.
321
+ *
322
+ * This method saves the configuration of the specified plugin to a JSON file in the matterbridge directory.
323
+ * If the plugin's configuration is not found, it logs an error and rejects the promise. If the configuration
324
+ * is successfully saved, it logs a debug message. If an error occurs during the file write operation, it logs
325
+ * the error and rejects the promise.
326
+ *
327
+ * @param {Plugin} plugin - The plugin whose configuration is to be saved.
328
+ * @param {boolean} [restartRequired] - Indicates whether a restart is required after saving the configuration.
329
+ * @returns {Promise<void>} A promise that resolves when the configuration is successfully saved, or rejects if an error occurs.
330
+ * @throws {Error} If the plugin's configuration is not found.
331
+ */
332
+ saveConfigFromPlugin(plugin: Plugin, restartRequired?: boolean): Promise<void>;
333
+ /**
334
+ * Saves the configuration of a plugin from a JSON object to a file.
335
+ *
336
+ * This method saves the provided configuration of the specified plugin to a JSON file in the matterbridge directory.
337
+ * It first checks if the configuration data is valid by ensuring it contains the correct name and type, and matches
338
+ * the plugin's name. If the configuration data is invalid, it logs an error and returns. If the configuration is
339
+ * successfully saved, it updates the plugin's `configJson` property and logs a debug message. If an error occurs
340
+ * during the file write operation, it logs the error and returns.
341
+ *
342
+ * @param {Plugin} plugin - The plugin whose configuration is to be saved.
343
+ * @param {PlatformConfig} config - The configuration data to be saved.
344
+ * @param {boolean} [restartRequired] - Indicates whether a restart is required after saving the configuration.
345
+ * @returns {Promise<void>} A promise that resolves when the configuration is successfully saved, or returns if an error occurs.
346
+ */
347
+ saveConfigFromJson(plugin: Plugin, config: PlatformConfig, restartRequired?: boolean): Promise<void>;
348
+ /**
349
+ * Loads the schema for a plugin.
350
+ *
351
+ * This method attempts to load the schema file for the specified plugin. If the schema file is found,
352
+ * it reads and parses the file, updates the schema's title and description, and logs the process.
353
+ * If the schema file is not found, it logs the event and loads a default schema for the plugin.
354
+ *
355
+ * @param {Plugin} plugin - The plugin whose schema is to be loaded.
356
+ * @returns {Promise<PlatformSchema>} A promise that resolves to the loaded schema object, or the default schema if the schema file is not found.
357
+ */
358
+ loadSchema(plugin: Plugin): Promise<PlatformSchema>;
359
+ /**
360
+ * Returns the default schema for a plugin.
361
+ *
362
+ * This method generates a default schema object for the specified plugin. The schema includes
363
+ * metadata such as the plugin's title, description, version, and author. It also defines the
364
+ * properties of the schema, including the plugin's name, type, debug flag, and unregisterOnShutdown flag.
365
+ *
366
+ * @param {Plugin} plugin - The plugin for which the default schema is to be generated.
367
+ * @returns {PlatformSchema} The default schema object for the plugin.
368
+ */
369
+ getDefaultSchema(plugin: Plugin): PlatformSchema;
370
+ }
371
+ export {};
372
+ //# sourceMappingURL=pluginManager.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pluginManager.d.ts","sourceRoot":"","sources":["../src/pluginManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,YAAY,MAAM,aAAa,CAAC;AAGvC,OAAO,EAAc,QAAQ,EAAgG,MAAM,kBAAkB,CAAC;AAGtJ,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAwB,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC5H,OAAO,EAAE,SAAS,EAAO,MAAM,EAAE,UAAU,EAAE,aAAa,EAAO,MAAM,wBAAwB,CAAC;AAMhG,UAAU,mBAAmB;IAC3B,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACzB,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACvD,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5B,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxB,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,YAAY,CAAC,mBAAmB,CAAC;IAYtD,OAAO,CAAC,QAAQ,CAAC,YAAY;IAXzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAa;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IACzC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoD;IAC1E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IAEnD;;;;OAIG;gBAC0B,YAAY,EAAE,YAAY;IASvD,OAAO,IAAI,IAAI;YAKD,UAAU;IA0LxB;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIrC;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAK3B;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAYvB;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IA8BnB;;;;OAIG;IACH,KAAK,IAAI,MAAM,EAAE;IAIjB;;;;OAIG;IACH,kBAAkB,IAAI,aAAa,EAAE;IAQrC;;;;OAIG;IACH,cAAc,IAAI,SAAS,EAAE;IAQ7B;;;;OAIG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB;;;;;OAKG;IACG,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAazE;;;;OAIG;IACH,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAED;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAWjD;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAsBtC;;;;;;OAMG;IACG,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAiGzD;;;;;OAKG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBpD;;;;;OAKG;IACG,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBtD;;;;;OAKG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM;IAM1G;;;;;OAKG;IACH,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS;IAQxH;;;;;OAKG;IACH,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS;IAWpH;;;;;OAKG;IACH,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS;IAWzH;;;;;OAKG;IAEH,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,SAAS;IAmBhE;;;;;;;OAOG;IACG,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;IAoFlG;;;;;;;;;OASG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAkCxD;;;;;;;;;OASG;IACG,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAkCzD;;;;;;;;;OASG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAkCxD;;;;;;;;;;OAUG;IACG,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAsCrD;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,KAAK,GAAE,OAAe,EAAE,OAAO,GAAE,MAAW,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IA+F5J;;;;;;;OAOG;IACG,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAsCnH;;;;;OAKG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAwCzE;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,GAAE,OAAe,EAAE,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAsDpJ;;;;;;;;OAQG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAgDzD;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB3F;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjH;;;;;;;;;OASG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAkBzD;;;;;;;;;OASG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc;CA6BjD"}