homebridge 2.5.1-beta.2 → 2.5.1-beta.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 (332) hide show
  1. package/dist/api.d.ts +253 -35
  2. package/dist/api.js +93 -5
  3. package/dist/api.js.map +1 -1
  4. package/dist/bridgeService.d.ts +63 -6
  5. package/dist/bridgeService.js +401 -99
  6. package/dist/bridgeService.js.map +1 -1
  7. package/dist/childBridgeFork.d.ts +12 -9
  8. package/dist/childBridgeFork.js +126 -40
  9. package/dist/childBridgeFork.js.map +1 -1
  10. package/dist/childBridgeService.d.ts +107 -28
  11. package/dist/childBridgeService.js +225 -28
  12. package/dist/childBridgeService.js.map +1 -1
  13. package/dist/cli.d.ts +0 -1
  14. package/dist/cli.js +28 -7
  15. package/dist/cli.js.map +1 -1
  16. package/dist/externalPortService.d.ts +4 -1
  17. package/dist/externalPortService.js +16 -4
  18. package/dist/externalPortService.js.map +1 -1
  19. package/dist/index.d.ts +36 -10
  20. package/dist/index.js +20 -4
  21. package/dist/index.js.map +1 -1
  22. package/dist/ipcService.d.ts +27 -12
  23. package/dist/ipcService.js +19 -6
  24. package/dist/ipcService.js.map +1 -1
  25. package/dist/logger.d.ts +10 -4
  26. package/dist/logger.js +27 -14
  27. package/dist/logger.js.map +1 -1
  28. package/dist/matter/BaseMatterManager.d.ts +36 -1
  29. package/dist/matter/BaseMatterManager.js +96 -39
  30. package/dist/matter/BaseMatterManager.js.map +1 -1
  31. package/dist/matter/ChildBridgeMatterManager.d.ts +27 -14
  32. package/dist/matter/ChildBridgeMatterManager.js +220 -62
  33. package/dist/matter/ChildBridgeMatterManager.js.map +1 -1
  34. package/dist/matter/ChildBridgeMatterMessageHandler.d.ts +3 -9
  35. package/dist/matter/ChildBridgeMatterMessageHandler.js +21 -7
  36. package/dist/matter/ChildBridgeMatterMessageHandler.js.map +1 -1
  37. package/dist/matter/ClusterCommandMapper.d.ts +21 -14
  38. package/dist/matter/ClusterCommandMapper.js +143 -84
  39. package/dist/matter/ClusterCommandMapper.js.map +1 -1
  40. package/dist/matter/ExternalMatterAccessoryPublisher.d.ts +2 -1
  41. package/dist/matter/ExternalMatterAccessoryPublisher.js +29 -18
  42. package/dist/matter/ExternalMatterAccessoryPublisher.js.map +1 -1
  43. package/dist/matter/MatterAPIImpl.d.ts +62 -41
  44. package/dist/matter/MatterAPIImpl.js +62 -47
  45. package/dist/matter/MatterAPIImpl.js.map +1 -1
  46. package/dist/matter/MatterBridgeManager.d.ts +2 -1
  47. package/dist/matter/MatterBridgeManager.js +58 -35
  48. package/dist/matter/MatterBridgeManager.js.map +1 -1
  49. package/dist/matter/MatterError.d.ts +15 -1
  50. package/dist/matter/MatterError.js +53 -1
  51. package/dist/matter/MatterError.js.map +1 -1
  52. package/dist/matter/MatterPortAllocator.d.ts +6 -1
  53. package/dist/matter/MatterPortAllocator.js +8 -0
  54. package/dist/matter/MatterPortAllocator.js.map +1 -1
  55. package/dist/matter/SwitchAPI.d.ts +0 -1
  56. package/dist/matter/accessoryCache.d.ts +49 -2
  57. package/dist/matter/accessoryCache.js +106 -3
  58. package/dist/matter/accessoryCache.js.map +1 -1
  59. package/dist/matter/behaviors/BehaviorRegistry.d.ts +39 -12
  60. package/dist/matter/behaviors/BehaviorRegistry.js +102 -63
  61. package/dist/matter/behaviors/BehaviorRegistry.js.map +1 -1
  62. package/dist/matter/behaviors/ClosureControlBehavior.d.ts +0 -19
  63. package/dist/matter/behaviors/ClosureControlBehavior.js +102 -68
  64. package/dist/matter/behaviors/ClosureControlBehavior.js.map +1 -1
  65. package/dist/matter/behaviors/ColorControlBehavior.d.ts +30 -10
  66. package/dist/matter/behaviors/ColorControlBehavior.js +130 -175
  67. package/dist/matter/behaviors/ColorControlBehavior.js.map +1 -1
  68. package/dist/matter/behaviors/DeviceEnergyManagementBehavior.d.ts +3 -6
  69. package/dist/matter/behaviors/DeviceEnergyManagementBehavior.js +35 -91
  70. package/dist/matter/behaviors/DeviceEnergyManagementBehavior.js.map +1 -1
  71. package/dist/matter/behaviors/DoorLockBehavior.d.ts +9 -10
  72. package/dist/matter/behaviors/DoorLockBehavior.js +41 -62
  73. package/dist/matter/behaviors/DoorLockBehavior.js.map +1 -1
  74. package/dist/matter/behaviors/EndpointContext.d.ts +7 -1
  75. package/dist/matter/behaviors/EndpointContext.js +8 -0
  76. package/dist/matter/behaviors/EndpointContext.js.map +1 -1
  77. package/dist/matter/behaviors/EnergyEvseBehavior.d.ts +6 -4
  78. package/dist/matter/behaviors/EnergyEvseBehavior.js +52 -76
  79. package/dist/matter/behaviors/EnergyEvseBehavior.js.map +1 -1
  80. package/dist/matter/behaviors/FanControlBehavior.d.ts +1 -6
  81. package/dist/matter/behaviors/FanControlBehavior.js +34 -56
  82. package/dist/matter/behaviors/FanControlBehavior.js.map +1 -1
  83. package/dist/matter/behaviors/IdentifyBehavior.d.ts +2 -5
  84. package/dist/matter/behaviors/IdentifyBehavior.js +26 -25
  85. package/dist/matter/behaviors/IdentifyBehavior.js.map +1 -1
  86. package/dist/matter/behaviors/KeypadInputBehavior.d.ts +0 -5
  87. package/dist/matter/behaviors/KeypadInputBehavior.js +18 -13
  88. package/dist/matter/behaviors/KeypadInputBehavior.js.map +1 -1
  89. package/dist/matter/behaviors/LevelControlBehavior.d.ts +41 -10
  90. package/dist/matter/behaviors/LevelControlBehavior.js +173 -191
  91. package/dist/matter/behaviors/LevelControlBehavior.js.map +1 -1
  92. package/dist/matter/behaviors/MediaPlaybackBehavior.d.ts +0 -5
  93. package/dist/matter/behaviors/MediaPlaybackBehavior.js +14 -10
  94. package/dist/matter/behaviors/MediaPlaybackBehavior.js.map +1 -1
  95. package/dist/matter/behaviors/OnOffBehavior.d.ts +1 -6
  96. package/dist/matter/behaviors/OnOffBehavior.js +41 -76
  97. package/dist/matter/behaviors/OnOffBehavior.js.map +1 -1
  98. package/dist/matter/behaviors/RegistryManager.d.ts +0 -1
  99. package/dist/matter/behaviors/RvcCleanModeBehavior.d.ts +0 -5
  100. package/dist/matter/behaviors/RvcCleanModeBehavior.js +9 -47
  101. package/dist/matter/behaviors/RvcCleanModeBehavior.js.map +1 -1
  102. package/dist/matter/behaviors/RvcOperationalStateBehavior.d.ts +5 -8
  103. package/dist/matter/behaviors/RvcOperationalStateBehavior.js +41 -38
  104. package/dist/matter/behaviors/RvcOperationalStateBehavior.js.map +1 -1
  105. package/dist/matter/behaviors/RvcRunModeBehavior.d.ts +3 -14
  106. package/dist/matter/behaviors/RvcRunModeBehavior.js +4 -50
  107. package/dist/matter/behaviors/RvcRunModeBehavior.js.map +1 -1
  108. package/dist/matter/behaviors/ServiceAreaBehavior.d.ts +1 -6
  109. package/dist/matter/behaviors/ServiceAreaBehavior.js +42 -51
  110. package/dist/matter/behaviors/ServiceAreaBehavior.js.map +1 -1
  111. package/dist/matter/behaviors/ThermostatBehavior.d.ts +6 -6
  112. package/dist/matter/behaviors/ThermostatBehavior.js +83 -106
  113. package/dist/matter/behaviors/ThermostatBehavior.js.map +1 -1
  114. package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.d.ts +0 -5
  115. package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.js +34 -57
  116. package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.js.map +1 -1
  117. package/dist/matter/behaviors/WaterHeaterBehavior.d.ts +1 -4
  118. package/dist/matter/behaviors/WaterHeaterBehavior.js +14 -62
  119. package/dist/matter/behaviors/WaterHeaterBehavior.js.map +1 -1
  120. package/dist/matter/behaviors/WindowCoveringBehavior.d.ts +19 -10
  121. package/dist/matter/behaviors/WindowCoveringBehavior.js +94 -141
  122. package/dist/matter/behaviors/WindowCoveringBehavior.js.map +1 -1
  123. package/dist/matter/behaviors/handlerResponse.d.ts +47 -0
  124. package/dist/matter/behaviors/handlerResponse.js +79 -0
  125. package/dist/matter/behaviors/handlerResponse.js.map +1 -0
  126. package/dist/matter/behaviors/handlerScope.d.ts +16 -0
  127. package/dist/matter/behaviors/handlerScope.js +23 -0
  128. package/dist/matter/behaviors/handlerScope.js.map +1 -0
  129. package/dist/matter/behaviors/index.d.ts +0 -3
  130. package/dist/matter/behaviors/index.js +0 -7
  131. package/dist/matter/behaviors/index.js.map +1 -1
  132. package/dist/matter/behaviors/pluginUpdates.d.ts +35 -0
  133. package/dist/matter/behaviors/pluginUpdates.js +74 -0
  134. package/dist/matter/behaviors/pluginUpdates.js.map +1 -0
  135. package/dist/matter/behaviors/revertFailedChange.d.ts +28 -0
  136. package/dist/matter/behaviors/revertFailedChange.js +40 -0
  137. package/dist/matter/behaviors/revertFailedChange.js.map +1 -0
  138. package/dist/matter/behaviors/stateLock.d.ts +20 -0
  139. package/dist/matter/behaviors/stateLock.js +36 -0
  140. package/dist/matter/behaviors/stateLock.js.map +1 -0
  141. package/dist/matter/clusterFeatures.d.ts +0 -1
  142. package/dist/matter/clusterFeatures.js.map +1 -1
  143. package/dist/matter/clusterHandlerMap.d.ts +116 -25
  144. package/dist/matter/clusterHandlerMap.js +8 -0
  145. package/dist/matter/clusterHandlerMap.js.map +1 -1
  146. package/dist/matter/clusterStateMap.d.ts +9 -3
  147. package/dist/matter/clusterTypes.d.ts +66 -7
  148. package/dist/matter/clusterTypes.js +5 -3
  149. package/dist/matter/clusterTypes.js.map +1 -1
  150. package/dist/matter/config.d.ts +2 -3
  151. package/dist/matter/config.js +30 -31
  152. package/dist/matter/config.js.map +1 -1
  153. package/dist/matter/configValidator.d.ts +11 -1
  154. package/dist/matter/configValidator.js +36 -14
  155. package/dist/matter/configValidator.js.map +1 -1
  156. package/dist/matter/errorHandler.d.ts +22 -5
  157. package/dist/matter/errorHandler.js +62 -17
  158. package/dist/matter/errorHandler.js.map +1 -1
  159. package/dist/matter/errors.d.ts +0 -1
  160. package/dist/matter/index.d.ts +0 -1
  161. package/dist/matter/ipc-types.d.ts +40 -2
  162. package/dist/matter/logFormatter.d.ts +17 -1
  163. package/dist/matter/logFormatter.js +32 -32
  164. package/dist/matter/logFormatter.js.map +1 -1
  165. package/dist/matter/managerTypes.d.ts +10 -45
  166. package/dist/matter/processConfig.d.ts +15 -0
  167. package/dist/matter/processConfig.js +60 -0
  168. package/dist/matter/processConfig.js.map +1 -0
  169. package/dist/matter/server/AccessoryManager.d.ts +83 -19
  170. package/dist/matter/server/AccessoryManager.js +447 -226
  171. package/dist/matter/server/AccessoryManager.js.map +1 -1
  172. package/dist/matter/server/AccessoryQuery.d.ts +3 -3
  173. package/dist/matter/server/AccessoryQuery.js +40 -12
  174. package/dist/matter/server/AccessoryQuery.js.map +1 -1
  175. package/dist/matter/server/BehaviorMap.d.ts +4 -20
  176. package/dist/matter/server/BehaviorMap.js +4 -28
  177. package/dist/matter/server/BehaviorMap.js.map +1 -1
  178. package/dist/matter/server/CommissioningManager.d.ts +3 -16
  179. package/dist/matter/server/CommissioningManager.js +109 -137
  180. package/dist/matter/server/CommissioningManager.js.map +1 -1
  181. package/dist/matter/server/FabricManager.d.ts +9 -22
  182. package/dist/matter/server/FabricManager.js +32 -170
  183. package/dist/matter/server/FabricManager.js.map +1 -1
  184. package/dist/matter/server/ServerConfig.d.ts +0 -5
  185. package/dist/matter/server/ServerConfig.js +1 -4
  186. package/dist/matter/server/ServerConfig.js.map +1 -1
  187. package/dist/matter/server/ServerLifecycle.d.ts +64 -19
  188. package/dist/matter/server/ServerLifecycle.js +268 -174
  189. package/dist/matter/server/ServerLifecycle.js.map +1 -1
  190. package/dist/matter/server/StateManager.d.ts +17 -2
  191. package/dist/matter/server/StateManager.js +104 -52
  192. package/dist/matter/server/StateManager.js.map +1 -1
  193. package/dist/matter/server/index.d.ts +2 -3
  194. package/dist/matter/server/index.js +2 -2
  195. package/dist/matter/server/index.js.map +1 -1
  196. package/dist/matter/server/storageLock.d.ts +35 -0
  197. package/dist/matter/server/storageLock.js +121 -0
  198. package/dist/matter/server/storageLock.js.map +1 -0
  199. package/dist/matter/server.d.ts +20 -22
  200. package/dist/matter/server.js +129 -66
  201. package/dist/matter/server.js.map +1 -1
  202. package/dist/matter/serverHelpers.d.ts +17 -71
  203. package/dist/matter/serverHelpers.js +88 -207
  204. package/dist/matter/serverHelpers.js.map +1 -1
  205. package/dist/matter/sharedTypes.d.ts +7 -2
  206. package/dist/matter/sharedTypes.js.map +1 -1
  207. package/dist/matter/types.d.ts +121 -88
  208. package/dist/matter/types.js +62 -22
  209. package/dist/matter/types.js.map +1 -1
  210. package/dist/matter/utils.d.ts +32 -5
  211. package/dist/matter/utils.js +63 -14
  212. package/dist/matter/utils.js.map +1 -1
  213. package/dist/matterExports.d.ts +30 -0
  214. package/dist/matterExports.js +23 -0
  215. package/dist/matterExports.js.map +1 -0
  216. package/dist/platformAccessory.d.ts +54 -9
  217. package/dist/platformAccessory.js +38 -5
  218. package/dist/platformAccessory.js.map +1 -1
  219. package/dist/plugin.d.ts +0 -4
  220. package/dist/plugin.js +65 -33
  221. package/dist/plugin.js.map +1 -1
  222. package/dist/pluginManager.d.ts +38 -4
  223. package/dist/pluginManager.js +123 -66
  224. package/dist/pluginManager.js.map +1 -1
  225. package/dist/server.d.ts +38 -11
  226. package/dist/server.js +286 -118
  227. package/dist/server.js.map +1 -1
  228. package/dist/storageService.d.ts +12 -6
  229. package/dist/storageService.js +39 -16
  230. package/dist/storageService.js.map +1 -1
  231. package/dist/user.d.ts +0 -1
  232. package/dist/util/errorMessage.d.ts +6 -0
  233. package/dist/util/errorMessage.js +15 -0
  234. package/dist/util/errorMessage.js.map +1 -0
  235. package/dist/util/ipc.d.ts +12 -0
  236. package/dist/util/ipc.js +25 -0
  237. package/dist/util/ipc.js.map +1 -0
  238. package/dist/util/mac.d.ts +1 -2
  239. package/dist/util/mac.js.map +1 -1
  240. package/dist/util/pin.d.ts +19 -0
  241. package/dist/util/pin.js +43 -0
  242. package/dist/util/pin.js.map +1 -0
  243. package/dist/util/port.d.ts +11 -0
  244. package/dist/util/port.js +24 -0
  245. package/dist/util/port.js.map +1 -0
  246. package/dist/version.d.ts +0 -1
  247. package/package.json +28 -17
  248. package/dist/api.d.ts.map +0 -1
  249. package/dist/bridgeService.d.ts.map +0 -1
  250. package/dist/childBridgeFork.d.ts.map +0 -1
  251. package/dist/childBridgeService.d.ts.map +0 -1
  252. package/dist/cli.d.ts.map +0 -1
  253. package/dist/externalPortService.d.ts.map +0 -1
  254. package/dist/index.d.ts.map +0 -1
  255. package/dist/ipcService.d.ts.map +0 -1
  256. package/dist/logger.d.ts.map +0 -1
  257. package/dist/matter/BaseMatterManager.d.ts.map +0 -1
  258. package/dist/matter/ChildBridgeMatterManager.d.ts.map +0 -1
  259. package/dist/matter/ChildBridgeMatterMessageHandler.d.ts.map +0 -1
  260. package/dist/matter/ClusterCommandMapper.d.ts.map +0 -1
  261. package/dist/matter/ExternalMatterAccessoryPublisher.d.ts.map +0 -1
  262. package/dist/matter/MatterAPIImpl.d.ts.map +0 -1
  263. package/dist/matter/MatterBridgeManager.d.ts.map +0 -1
  264. package/dist/matter/MatterError.d.ts.map +0 -1
  265. package/dist/matter/MatterPortAllocator.d.ts.map +0 -1
  266. package/dist/matter/SwitchAPI.d.ts.map +0 -1
  267. package/dist/matter/accessoryCache.d.ts.map +0 -1
  268. package/dist/matter/behaviors/AirQualityBehavior.d.ts +0 -44
  269. package/dist/matter/behaviors/AirQualityBehavior.d.ts.map +0 -1
  270. package/dist/matter/behaviors/AirQualityBehavior.js +0 -48
  271. package/dist/matter/behaviors/AirQualityBehavior.js.map +0 -1
  272. package/dist/matter/behaviors/BehaviorRegistry.d.ts.map +0 -1
  273. package/dist/matter/behaviors/ClosureControlBehavior.d.ts.map +0 -1
  274. package/dist/matter/behaviors/ColorControlBehavior.d.ts.map +0 -1
  275. package/dist/matter/behaviors/ConcentrationMeasurementBehavior.d.ts +0 -117
  276. package/dist/matter/behaviors/ConcentrationMeasurementBehavior.d.ts.map +0 -1
  277. package/dist/matter/behaviors/ConcentrationMeasurementBehavior.js +0 -132
  278. package/dist/matter/behaviors/ConcentrationMeasurementBehavior.js.map +0 -1
  279. package/dist/matter/behaviors/DeviceEnergyManagementBehavior.d.ts.map +0 -1
  280. package/dist/matter/behaviors/DoorLockBehavior.d.ts.map +0 -1
  281. package/dist/matter/behaviors/EndpointContext.d.ts.map +0 -1
  282. package/dist/matter/behaviors/EnergyEvseBehavior.d.ts.map +0 -1
  283. package/dist/matter/behaviors/FanControlBehavior.d.ts.map +0 -1
  284. package/dist/matter/behaviors/IdentifyBehavior.d.ts.map +0 -1
  285. package/dist/matter/behaviors/KeypadInputBehavior.d.ts.map +0 -1
  286. package/dist/matter/behaviors/LevelControlBehavior.d.ts.map +0 -1
  287. package/dist/matter/behaviors/MediaPlaybackBehavior.d.ts.map +0 -1
  288. package/dist/matter/behaviors/OnOffBehavior.d.ts.map +0 -1
  289. package/dist/matter/behaviors/RegistryManager.d.ts.map +0 -1
  290. package/dist/matter/behaviors/RvcCleanModeBehavior.d.ts.map +0 -1
  291. package/dist/matter/behaviors/RvcOperationalStateBehavior.d.ts.map +0 -1
  292. package/dist/matter/behaviors/RvcRunModeBehavior.d.ts.map +0 -1
  293. package/dist/matter/behaviors/ServiceAreaBehavior.d.ts.map +0 -1
  294. package/dist/matter/behaviors/ThermostatBehavior.d.ts.map +0 -1
  295. package/dist/matter/behaviors/ValveConfigurationAndControlBehavior.d.ts.map +0 -1
  296. package/dist/matter/behaviors/WaterHeaterBehavior.d.ts.map +0 -1
  297. package/dist/matter/behaviors/WindowCoveringBehavior.d.ts.map +0 -1
  298. package/dist/matter/behaviors/index.d.ts.map +0 -1
  299. package/dist/matter/clusterFeatures.d.ts.map +0 -1
  300. package/dist/matter/clusterHandlerMap.d.ts.map +0 -1
  301. package/dist/matter/clusterStateMap.d.ts.map +0 -1
  302. package/dist/matter/clusterTypes.d.ts.map +0 -1
  303. package/dist/matter/config.d.ts.map +0 -1
  304. package/dist/matter/configValidator.d.ts.map +0 -1
  305. package/dist/matter/errorHandler.d.ts.map +0 -1
  306. package/dist/matter/errors.d.ts.map +0 -1
  307. package/dist/matter/index.d.ts.map +0 -1
  308. package/dist/matter/ipc-types.d.ts.map +0 -1
  309. package/dist/matter/logFormatter.d.ts.map +0 -1
  310. package/dist/matter/managerTypes.d.ts.map +0 -1
  311. package/dist/matter/server/AccessoryManager.d.ts.map +0 -1
  312. package/dist/matter/server/AccessoryQuery.d.ts.map +0 -1
  313. package/dist/matter/server/BehaviorMap.d.ts.map +0 -1
  314. package/dist/matter/server/CommissioningManager.d.ts.map +0 -1
  315. package/dist/matter/server/FabricManager.d.ts.map +0 -1
  316. package/dist/matter/server/ServerConfig.d.ts.map +0 -1
  317. package/dist/matter/server/ServerLifecycle.d.ts.map +0 -1
  318. package/dist/matter/server/StateManager.d.ts.map +0 -1
  319. package/dist/matter/server/index.d.ts.map +0 -1
  320. package/dist/matter/server.d.ts.map +0 -1
  321. package/dist/matter/serverHelpers.d.ts.map +0 -1
  322. package/dist/matter/sharedTypes.d.ts.map +0 -1
  323. package/dist/matter/types.d.ts.map +0 -1
  324. package/dist/matter/utils.d.ts.map +0 -1
  325. package/dist/platformAccessory.d.ts.map +0 -1
  326. package/dist/plugin.d.ts.map +0 -1
  327. package/dist/pluginManager.d.ts.map +0 -1
  328. package/dist/server.d.ts.map +0 -1
  329. package/dist/storageService.d.ts.map +0 -1
  330. package/dist/user.d.ts.map +0 -1
  331. package/dist/util/mac.d.ts.map +0 -1
  332. package/dist/version.d.ts.map +0 -1
package/dist/api.js CHANGED
@@ -7,24 +7,47 @@ import { PluginManager } from './pluginManager.js';
7
7
  import { User } from './user.js';
8
8
  import getVersion from './version.js';
9
9
  const log = Logger.internal;
10
+ /**
11
+ * The two kinds of plugin: an accessory plugin or a platform plugin.
12
+ *
13
+ * This is a `const enum`. A plugin built with plain `tsc` gets the value written into its code at
14
+ * compile time. A plugin built with `isolatedModules` or `verbatimModuleSyntax` (esbuild, tsx, swc,
15
+ * Vite) can not use it: TypeScript reports TS2748 ("Cannot access ambient const enums"). Write the text
16
+ * value instead: `'accessory'` or `'platform'`.
17
+ * It stays a `const enum` for now: as a normal enum, every plugin built with plain `tsc` would start
18
+ * to import the `homebridge` package at run time.
19
+ */
10
20
  // eslint-disable-next-line no-restricted-syntax
11
21
  export var PluginType;
12
22
  (function (PluginType) {
13
23
  PluginType["ACCESSORY"] = "accessory";
14
24
  PluginType["PLATFORM"] = "platform";
15
25
  })(PluginType || (PluginType = {}));
26
+ /**
27
+ * The events a plugin can listen for on the {@link API} object.
28
+ *
29
+ * This is a `const enum`. A plugin built with plain `tsc` gets the value written into its code at
30
+ * compile time. A plugin built with `isolatedModules` or `verbatimModuleSyntax` (esbuild, tsx, swc,
31
+ * Vite) can not use it: TypeScript reports TS2748 ("Cannot access ambient const enums"). Write the text
32
+ * value instead, which is typed the same: `api.on('didFinishLaunching', ...)`, `api.on('shutdown', ...)`.
33
+ * It stays a `const enum` for now: as a normal enum, every plugin built with plain `tsc` would start
34
+ * to import the `homebridge` package at run time.
35
+ */
16
36
  // eslint-disable-next-line no-restricted-syntax
17
37
  export var APIEvent;
18
38
  (function (APIEvent) {
19
39
  /**
20
40
  * Event is fired once homebridge has finished with booting up and initializing all components and plugins.
21
41
  * When this event is fired it is possible that the Bridge accessory isn't published yet, if homebridge still needs
22
- * to wait for some {@see StaticPlatformPlugin | StaticPlatformPlugins} to finish accessory creation.
42
+ * to wait for some {@link StaticPlatformPlugin | StaticPlatformPlugins} to finish accessory creation.
23
43
  */
24
44
  APIEvent["DID_FINISH_LAUNCHING"] = "didFinishLaunching";
25
45
  /**
26
46
  * This event is fired when homebridge gets shutdown. This could be a regular shutdown or an unexpected crash.
27
47
  * At this stage all Accessories are already unpublished and all PlatformAccessories are already saved to disk!
48
+ *
49
+ * That is true for HomeKit only. The Matter servers are stopped, and the Matter accessory cache is
50
+ * saved, after this event: Matter accessories are still published while the listeners run.
28
51
  */
29
52
  APIEvent["SHUTDOWN"] = "shutdown";
30
53
  })(APIEvent || (APIEvent = {}));
@@ -47,7 +70,10 @@ export var InternalAPIEvent;
47
70
  })(InternalAPIEvent || (InternalAPIEvent = {}));
48
71
  // eslint-disable-next-line ts/no-unsafe-declaration-merging
49
72
  export class HomebridgeAPI extends EventEmitter {
50
- version = 2.7; // homebridge API version
73
+ /**
74
+ * @deprecated Fixed at `2.7` since Homebridge v1.3.0: it tells a plugin nothing. See {@link API.version}.
75
+ */
76
+ version = 2.7; // homebridge API version (kept at this value on purpose)
51
77
  serverVersion = getVersion(); // homebridge node module version
52
78
  // ------------------ LEGACY EXPORTS FOR PRE TYPESCRIPT ------------------
53
79
  user = User;
@@ -118,6 +144,9 @@ export class HomebridgeAPI extends EventEmitter {
118
144
  }
119
145
  if (!this._matterAPILoadPromise) {
120
146
  this._matterAPILoadPromise = (async () => {
147
+ // Before matter.js itself is loaded: it reads these switches once, then
148
+ const { configureMatterJsProcess } = await import('./matter/processConfig.js');
149
+ await configureMatterJsProcess();
121
150
  const { MatterAPIImpl } = await import('./matter/MatterAPIImpl.js');
122
151
  this._matterAPI = new MatterAPIImpl(this);
123
152
  // Mark Matter as enabled here, before plugins initialise. The later
@@ -132,8 +161,34 @@ export class HomebridgeAPI extends EventEmitter {
132
161
  }
133
162
  return this._matterAPILoadPromise;
134
163
  }
164
+ /**
165
+ * Load the Matter API, and say whether Matter can be used in this run.
166
+ *
167
+ * matter.js may fail to load at all (a package the installer left out, a
168
+ * Node.js version one of its packages does not accept). That must not stop
169
+ * a bridge that also serves HomeKit: the failure is logged once, Matter
170
+ * stays off (`api.matter` is undefined, `isMatterEnabled()` is false) and
171
+ * the caller carries on without it.
172
+ *
173
+ * @internal
174
+ */
175
+ async tryLoadMatterAPI() {
176
+ try {
177
+ await this.loadMatterAPI();
178
+ return true;
179
+ }
180
+ catch (error) {
181
+ log.error('Matter could not be loaded, so Matter is switched off for this run. HomeKit is not affected.', error);
182
+ return false;
183
+ }
184
+ }
135
185
  constructor() {
136
186
  super();
187
+ // Every platform adds its own `didFinishLaunching` (and often `shutdown`) listener, so a bridge
188
+ // with 11 or more platforms went past Node's default of 10 listeners per event and Node printed a
189
+ // "possible EventEmitter memory leak" warning for something that is not a leak.
190
+ // `Infinity` (not `0`) so the `+ 1` / `- 1` a child bridge does on this limit keeps it unlimited.
191
+ this.setMaxListeners(Number.POSITIVE_INFINITY);
137
192
  }
138
193
  /**
139
194
  * Set bridge-specific HAP enablement before plugin initialization.
@@ -175,6 +230,14 @@ export class HomebridgeAPI extends EventEmitter {
175
230
  _setMatterManager(manager) {
176
231
  this._matterManager = manager;
177
232
  }
233
+ /**
234
+ * Internal method to remember the promise of an external accessory registration
235
+ * Called by MatterAPIImpl before it asks the manager to publish the accessories
236
+ * @internal
237
+ */
238
+ _addPendingExternalRegistration(registrationId, resolve) {
239
+ this._pendingExternalRegistrations.set(registrationId, resolve);
240
+ }
178
241
  /**
179
242
  * Internal method to resolve pending external accessory registrations
180
243
  * Called by MatterBridgeManager when external accessories finish publishing
@@ -191,7 +254,12 @@ export class HomebridgeAPI extends EventEmitter {
191
254
  return semver.gte(this.serverVersion, version);
192
255
  }
193
256
  static isDynamicPlatformPlugin(platformPlugin) {
194
- return 'configureAccessory' in platformPlugin;
257
+ // A platform that only does Matter has configureMatterAccessory and no
258
+ // configureAccessory. It is a dynamic platform too: without this its
259
+ // cached Matter accessories had no platform to go back to, and were
260
+ // removed as orphans at every start. A static platform stays static.
261
+ return 'configureAccessory' in platformPlugin
262
+ || ('configureMatterAccessory' in platformPlugin && !HomebridgeAPI.isStaticPlatformPlugin(platformPlugin));
195
263
  }
196
264
  static isStaticPlatformPlugin(platformPlugin) {
197
265
  return 'accessories' in platformPlugin;
@@ -200,7 +268,20 @@ export class HomebridgeAPI extends EventEmitter {
200
268
  this.emit("didFinishLaunching" /* APIEvent.DID_FINISH_LAUNCHING */);
201
269
  }
202
270
  signalShutdown() {
203
- this.emit("shutdown" /* APIEvent.SHUTDOWN */);
271
+ // Each listener is called on its own. With a plain emit, the first plugin
272
+ // whose shutdown listener throws stopped every later listener (the other
273
+ // plugins, and Homebridge's own) and the rest of the teardown with it.
274
+ for (const listener of this.rawListeners("shutdown" /* APIEvent.SHUTDOWN */)) {
275
+ try {
276
+ const result = listener.call(this);
277
+ if (result instanceof Promise) {
278
+ result.catch((error) => log.error('A shutdown listener failed:', error));
279
+ }
280
+ }
281
+ catch (error) {
282
+ log.error('A shutdown listener failed:', error);
283
+ }
284
+ }
204
285
  }
205
286
  registerAccessory(pluginIdentifier, accessoryName, constructor) {
206
287
  if (typeof accessoryName === 'function') {
@@ -226,21 +307,27 @@ export class HomebridgeAPI extends EventEmitter {
226
307
  if (!PluginManager.isQualifiedPluginIdentifier(pluginIdentifier)) {
227
308
  log.info(`One of your plugins incorrectly registered an external accessory using the platform name (${pluginIdentifier}) and not the plugin identifier. Please report this to the developer!`);
228
309
  }
310
+ // check all of them before changing any: a bad one must not leave the others half registered
229
311
  accessories.forEach((accessory) => {
230
312
  // noinspection SuspiciousTypeOfGuard
231
313
  if (!(accessory instanceof PlatformAccessory)) {
232
314
  throw new TypeError(`${pluginIdentifier} attempt to register an accessory that isn't PlatformAccessory!`);
233
315
  }
316
+ });
317
+ accessories.forEach((accessory) => {
234
318
  accessory._associatedPlugin = pluginIdentifier;
235
319
  });
236
320
  this.emit("publishExternalAccessories" /* InternalAPIEvent.PUBLISH_EXTERNAL_ACCESSORIES */, accessories);
237
321
  }
238
322
  registerPlatformAccessories(pluginIdentifier, platformName, accessories) {
323
+ // check all of them before changing any: a bad one must not leave the others half registered
239
324
  accessories.forEach((accessory) => {
240
325
  // noinspection SuspiciousTypeOfGuard
241
326
  if (!(accessory instanceof PlatformAccessory)) {
242
327
  throw new TypeError(`${pluginIdentifier} - ${platformName} attempt to register an accessory that isn't PlatformAccessory!`);
243
328
  }
329
+ });
330
+ accessories.forEach((accessory) => {
244
331
  accessory._associatedPlugin = pluginIdentifier;
245
332
  accessory._associatedPlatform = platformName;
246
333
  });
@@ -271,7 +358,8 @@ export class HomebridgeAPI extends EventEmitter {
271
358
  return this.hapExternalsOnly;
272
359
  }
273
360
  /**
274
- * Check if Matter is available in this version of Homebridge
361
+ * Check if Matter is available in this version of Homebridge (always true on v2)
362
+ * @see API.isMatterAvailable
275
363
  * @returns true if Homebridge version satisfies >= 2.0.0-alpha.0
276
364
  */
277
365
  isMatterAvailable() {
package/dist/api.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,SAAS,MAAM,wBAAwB,CAAA;AAC9C,OAAO,MAAM,MAAM,QAAQ,CAAA;AAE3B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,UAAU,MAAM,cAAc,CAAA;AAErC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAA;AAc3B,gDAAgD;AAChD,MAAM,CAAN,IAAkB,UAGjB;AAHD,WAAkB,UAAU;IAC1B,qCAAuB,CAAA;IACvB,mCAAqB,CAAA;AACvB,CAAC,EAHiB,UAAU,KAAV,UAAU,QAG3B;AA8GD,gDAAgD;AAChD,MAAM,CAAN,IAAkB,QAajB;AAbD,WAAkB,QAAQ;IACxB;;;;OAIG;IACH,uDAA2C,CAAA;IAE3C;;;OAGG;IACH,iCAAqB,CAAA;AACvB,CAAC,EAbiB,QAAQ,KAAR,QAAQ,QAazB;AAED,gDAAgD;AAChD,MAAM,CAAN,IAAkB,gBAgBjB;AAhBD,WAAkB,gBAAgB;IAChC,4DAAwC,CAAA;IACxC,0DAAsC,CAAA;IAEtC,+EAA2D,CAAA;IAC3D,iFAA6D,CAAA;IAC7D,6EAAyD,CAAA;IACzD,qFAAiE,CAAA;IAEjE,uCAAuC;IACvC,4FAAwE,CAAA;IACxE,8FAA0E,CAAA;IAC1E,0FAAsE,CAAA;IACtE,kGAA8E,CAAA;IAC9E,kGAA8E,CAAA;IAC9E,gFAA4D,CAAA;AAC9D,CAAC,EAhBiB,gBAAgB,KAAhB,gBAAgB,QAgBjC;AA2bD,4DAA4D;AAC5D,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7B,OAAO,GAAG,GAAG,CAAA,CAAC,yBAAyB;IACvC,aAAa,GAAG,UAAU,EAAE,CAAA,CAAC,iCAAiC;IAE9E,2EAA2E;IAClE,IAAI,GAAG,IAAI,CAAA;IACX,GAAG,GAAG,SAAS,CAAA;IACf,cAAc,GAAG,SAAS,CAAC,WAAW,CAAA,CAAC,uCAAuC;IAC9E,iBAAiB,GAAG,iBAAiB,CAAA;IAC9C,2EAA2E;IAE3E;;OAEG;IACK,aAAa,GAAG,KAAK,CAAA;IACrB,mBAAmB,GAAG,KAAK,CAAA;IAEnC,yEAAyE;IACjE,UAAU,GAAG,IAAI,CAAA;IACjB,gBAAgB,GAAG,KAAK,CAAA;IAEhC;;;OAGG;IACI,aAAa,GAAwB,IAAI,CAAA;IAEhD;;;OAGG;IACI,cAAc,GAA6B,IAAI,CAAA;IAEtD;;;;OAIG;IACK,6BAA6B,GAA4B,IAAI,GAAG,EAAE,CAAA;IAE1E;;OAEG;IACK,UAAU,CAAY;IAE9B;;;;;;;;OAQG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;;;;OAMG;IACK,qBAAqB,CAAgB;IAE7C;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,IAAI,CAAC,qBAAqB,GAAG,CAAC,KAAK,IAAI,EAAE;gBACvC,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,CAAA;gBACnE,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAA;gBACzC,oEAAoE;gBACpE,+DAA+D;gBAC/D,mEAAmE;gBACnE,0DAA0D;gBAC1D,oDAAoD;gBACpD,mEAAmE;gBACnE,qBAAqB;gBACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;YAC3B,CAAC,CAAC,EAAE,CAAA;QACN,CAAC;QACD,OAAO,IAAI,CAAC,qBAAqB,CAAA;IACnC,CAAC;IAED;QACE,KAAK,EAAE,CAAA;IACT,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,OAAgB,EAAE,aAAa,GAAG,KAAK;QACpD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAA;QACzB,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAA;IACvC,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,OAAgB;QAChC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CAAC,aAAsB;QAC5C,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAA2B;QAC1C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;IAC7B,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,OAAiC;QACjD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAA;IAC/B,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,cAAsB;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QACtE,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,EAAE,CAAA;YACT,IAAI,CAAC,6BAA6B,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;QAC3D,CAAC;IACH,CAAC;IAEM,qBAAqB,CAAC,OAAe;QAC1C,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAChD,CAAC;IAEM,MAAM,CAAC,uBAAuB,CAAC,cAA8B;QAClE,OAAO,oBAAoB,IAAI,cAAc,CAAA;IAC/C,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAAC,cAA8B;QACjE,OAAO,aAAa,IAAI,cAAc,CAAA;IACxC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,0DAA+B,CAAA;IAC1C,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,oCAAmB,CAAA;IAC9B,CAAC;IAID,iBAAiB,CAAC,gBAAkD,EAAE,aAAyD,EAAE,WAAwC;QACvK,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;YACxC,WAAW,GAAG,aAAa,CAAA;YAC3B,aAAa,GAAG,gBAAgB,CAAA;YAChC,IAAI,CAAC,IAAI,gEAAsC,aAAa,EAAE,WAAW,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,gEAAsC,aAAa,EAAE,WAAY,EAAE,gBAAgB,CAAC,CAAA;QAC/F,CAAC;IACH,CAAC;IAID,gBAAgB,CAAC,gBAAiD,EAAE,YAAsD,EAAE,WAAuC;QACjK,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;YACvC,WAAW,GAAG,YAAY,CAAA;YAC1B,YAAY,GAAG,gBAAgB,CAAA;YAC/B,IAAI,CAAC,IAAI,8DAAqC,YAAY,EAAE,WAAW,CAAC,CAAA;QAC1E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,8DAAqC,YAAY,EAAE,WAAY,EAAE,gBAAgB,CAAC,CAAA;QAC7F,CAAC;IACH,CAAC;IAED,0BAA0B,CAAC,gBAAkC,EAAE,WAAgC;QAC7F,IAAI,CAAC,aAAa,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjE,GAAG,CAAC,IAAI,CAAC,6FAA6F,gBAAgB,uEAAuE,CAAC,CAAA;QAChM,CAAC;QAED,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,iEAAiE,CAAC,CAAA;YAC3G,CAAC;YAED,SAAS,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;QAChD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,mFAAgD,WAAW,CAAC,CAAA;IACvE,CAAC;IAED,2BAA2B,CAAC,gBAAkC,EAAE,YAA0B,EAAE,WAAgC;QAC1H,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,MAAM,YAAY,iEAAiE,CAAC,CAAA;YAC7H,CAAC;YAED,SAAS,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;YAC9C,SAAS,CAAC,mBAAmB,GAAG,YAAY,CAAA;QAC9C,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,qFAAiD,WAAW,CAAC,CAAA;IACxE,CAAC;IAED,yBAAyB,CAAC,WAAgC;QACxD,IAAI,CAAC,IAAI,iFAA+C,WAAW,CAAC,CAAA;IACtE,CAAC;IAED,6BAA6B,CAAC,gBAAkC,EAAE,YAA0B,EAAE,WAAgC;QAC5H,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,MAAM,YAAY,mEAAmE,CAAC,CAAA;YAC/H,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,yFAAmD,WAAW,CAAC,CAAA;IAC1E,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACH,iBAAiB;QACf,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,mBAAmB,CAAA;IACvD,CAAC;CACF"}
1
+ {"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,SAAS,MAAM,wBAAwB,CAAA;AAC9C,OAAO,MAAM,MAAM,QAAQ,CAAA;AAE3B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,UAAU,MAAM,cAAc,CAAA;AAErC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAA;AAc3B;;;;;;;;;GASG;AACH,gDAAgD;AAChD,MAAM,CAAN,IAAkB,UAGjB;AAHD,WAAkB,UAAU;IAC1B,qCAAuB,CAAA;IACvB,mCAAqB,CAAA;AACvB,CAAC,EAHiB,UAAU,KAAV,UAAU,QAG3B;AAyHD;;;;;;;;;GASG;AACH,gDAAgD;AAChD,MAAM,CAAN,IAAkB,QAgBjB;AAhBD,WAAkB,QAAQ;IACxB;;;;OAIG;IACH,uDAA2C,CAAA;IAE3C;;;;;;OAMG;IACH,iCAAqB,CAAA;AACvB,CAAC,EAhBiB,QAAQ,KAAR,QAAQ,QAgBzB;AAED,gDAAgD;AAChD,MAAM,CAAN,IAAkB,gBAgBjB;AAhBD,WAAkB,gBAAgB;IAChC,4DAAwC,CAAA;IACxC,0DAAsC,CAAA;IAEtC,+EAA2D,CAAA;IAC3D,iFAA6D,CAAA;IAC7D,6EAAyD,CAAA;IACzD,qFAAiE,CAAA;IAEjE,uCAAuC;IACvC,4FAAwE,CAAA;IACxE,8FAA0E,CAAA;IAC1E,0FAAsE,CAAA;IACtE,kGAA8E,CAAA;IAC9E,kGAA8E,CAAA;IAC9E,gFAA4D,CAAA;AAC9D,CAAC,EAhBiB,gBAAgB,KAAhB,gBAAgB,QAgBjC;AAimBD,4DAA4D;AAC5D,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C;;OAEG;IACa,OAAO,GAAG,GAAG,CAAA,CAAC,yDAAyD;IACvE,aAAa,GAAG,UAAU,EAAE,CAAA,CAAC,iCAAiC;IAE9E,2EAA2E;IAClE,IAAI,GAAG,IAAI,CAAA;IACX,GAAG,GAAG,SAAS,CAAA;IACf,cAAc,GAAG,SAAS,CAAC,WAAW,CAAA,CAAC,uCAAuC;IAC9E,iBAAiB,GAAG,iBAAiB,CAAA;IAC9C,2EAA2E;IAE3E;;OAEG;IACK,aAAa,GAAG,KAAK,CAAA;IACrB,mBAAmB,GAAG,KAAK,CAAA;IAEnC,yEAAyE;IACjE,UAAU,GAAG,IAAI,CAAA;IACjB,gBAAgB,GAAG,KAAK,CAAA;IAEhC;;;OAGG;IACI,aAAa,GAAwB,IAAI,CAAA;IAEhD;;;OAGG;IACI,cAAc,GAA6B,IAAI,CAAA;IAEtD;;;;OAIG;IACK,6BAA6B,GAA4B,IAAI,GAAG,EAAE,CAAA;IAE1E;;OAEG;IACK,UAAU,CAAY;IAE9B;;;;;;;;OAQG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;;;;OAMG;IACK,qBAAqB,CAAgB;IAE7C;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,IAAI,CAAC,qBAAqB,GAAG,CAAC,KAAK,IAAI,EAAE;gBACvC,wEAAwE;gBACxE,MAAM,EAAE,wBAAwB,EAAE,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,CAAA;gBAC9E,MAAM,wBAAwB,EAAE,CAAA;gBAChC,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC,CAAA;gBACnE,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAA;gBACzC,oEAAoE;gBACpE,+DAA+D;gBAC/D,mEAAmE;gBACnE,0DAA0D;gBAC1D,oDAAoD;gBACpD,mEAAmE;gBACnE,qBAAqB;gBACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;YAC3B,CAAC,CAAC,EAAE,CAAA;QACN,CAAC;QACD,OAAO,IAAI,CAAC,qBAAqB,CAAA;IACnC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,gBAAgB;QACpB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;YAC1B,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,GAAG,CAAC,KAAK,CAAC,8FAA8F,EAAE,KAAK,CAAC,CAAA;YAChH,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED;QACE,KAAK,EAAE,CAAA;QACP,gGAAgG;QAChG,kGAAkG;QAClG,gFAAgF;QAChF,kGAAkG;QAClG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAA;IAChD,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,OAAgB,EAAE,aAAa,GAAG,KAAK;QACpD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAA;QACzB,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAA;IACvC,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,OAAgB;QAChC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CAAC,aAAsB;QAC5C,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAA2B;QAC1C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;IAC7B,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,OAAiC;QACjD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAA;IAC/B,CAAC;IAED;;;;OAIG;IACH,+BAA+B,CAAC,cAAsB,EAAE,OAAmB;QACzE,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;IACjE,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,cAAsB;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QACtE,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,EAAE,CAAA;YACT,IAAI,CAAC,6BAA6B,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;QAC3D,CAAC;IACH,CAAC;IAEM,qBAAqB,CAAC,OAAe;QAC1C,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IAChD,CAAC;IAEM,MAAM,CAAC,uBAAuB,CAAC,cAA8B;QAClE,uEAAuE;QACvE,qEAAqE;QACrE,oEAAoE;QACpE,qEAAqE;QACrE,OAAO,oBAAoB,IAAI,cAAc;eACxC,CAAC,0BAA0B,IAAI,cAAc,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC,CAAA;IAC9G,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAAC,cAA8B;QACjE,OAAO,aAAa,IAAI,cAAc,CAAA;IACxC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,0DAA+B,CAAA;IAC1C,CAAC;IAED,cAAc;QACZ,0EAA0E;QAC1E,yEAAyE;QACzE,uEAAuE;QACvE,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,YAAY,oCAAmB,EAAE,CAAC;YAC5D,IAAI,CAAC;gBACH,MAAM,MAAM,GAAY,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC3C,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;oBAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC,CAAA;gBACnF,CAAC;YACH,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACxB,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAID,iBAAiB,CAAC,gBAAkD,EAAE,aAAyD,EAAE,WAAwC;QACvK,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;YACxC,WAAW,GAAG,aAAa,CAAA;YAC3B,aAAa,GAAG,gBAAgB,CAAA;YAChC,IAAI,CAAC,IAAI,gEAAsC,aAAa,EAAE,WAAW,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,gEAAsC,aAAa,EAAE,WAAY,EAAE,gBAAgB,CAAC,CAAA;QAC/F,CAAC;IACH,CAAC;IAID,gBAAgB,CAAC,gBAAiD,EAAE,YAAsD,EAAE,WAAuC;QACjK,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;YACvC,WAAW,GAAG,YAAY,CAAA;YAC1B,YAAY,GAAG,gBAAgB,CAAA;YAC/B,IAAI,CAAC,IAAI,8DAAqC,YAAY,EAAE,WAAW,CAAC,CAAA;QAC1E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,8DAAqC,YAAY,EAAE,WAAY,EAAE,gBAAgB,CAAC,CAAA;QAC7F,CAAC;IACH,CAAC;IAED,0BAA0B,CAAC,gBAAkC,EAAE,WAAgC;QAC7F,IAAI,CAAC,aAAa,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjE,GAAG,CAAC,IAAI,CAAC,6FAA6F,gBAAgB,uEAAuE,CAAC,CAAA;QAChM,CAAC;QAED,6FAA6F;QAC7F,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,iEAAiE,CAAC,CAAA;YAC3G,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,SAAS,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;QAChD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,mFAAgD,WAAW,CAAC,CAAA;IACvE,CAAC;IAED,2BAA2B,CAAC,gBAAkC,EAAE,YAA0B,EAAE,WAAgC;QAC1H,6FAA6F;QAC7F,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,MAAM,YAAY,iEAAiE,CAAC,CAAA;YAC7H,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,SAAS,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;YAC9C,SAAS,CAAC,mBAAmB,GAAG,YAAY,CAAA;QAC9C,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,qFAAiD,WAAW,CAAC,CAAA;IACxE,CAAC;IAED,yBAAyB,CAAC,WAAgC;QACxD,IAAI,CAAC,IAAI,iFAA+C,WAAW,CAAC,CAAA;IACtE,CAAC;IAED,6BAA6B,CAAC,gBAAkC,EAAE,YAA0B,EAAE,WAAgC;QAC5H,WAAW,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAChC,qCAAqC;YACrC,IAAI,CAAC,CAAC,SAAS,YAAY,iBAAiB,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,gBAAgB,MAAM,YAAY,mEAAmE,CAAC,CAAA;YAC/H,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,IAAI,yFAAmD,WAAW,CAAC,CAAA;IAC1E,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,mBAAmB,CAAA;IACvD,CAAC;CACF"}
@@ -49,7 +49,7 @@ export interface BridgeConfiguration {
49
49
  advertiser?: MDNSAdvertiser;
50
50
  port?: number;
51
51
  bind?: (InterfaceName | IPAddress) | (InterfaceName | IPAddress)[];
52
- /** 4-character HomeKit setup ID (alphanumeric, e.g. "ABCD"). Validated at runtime. */
52
+ /** 4-character HomeKit setup ID (0-9 and A-Z, e.g. "ABCD"). One that is not 4 characters long is ignored, with a warning. */
53
53
  setupID?: string;
54
54
  manufacturer?: string;
55
55
  model?: string;
@@ -65,7 +65,9 @@ export interface BridgeConfiguration {
65
65
  * accepted for back-compat and normalized to `{ enabled: <boolean> }` by
66
66
  * `validateHapConfig`. The type allows it so existing configs keep compiling.
67
67
  *
68
- * @deprecated Pass `hap` as a boolean is deprecated; use `{ enabled }` instead.
68
+ * Only the boolean form is deprecated: use `{ enabled }` instead. (There is
69
+ * no `deprecated` tag here on purpose. A tag marks the whole property, so
70
+ * editors and the docs would strike through the object form as well.)
69
71
  */
70
72
  hap?: BridgeHapConfig | boolean;
71
73
  matter?: MatterConfig;
@@ -135,7 +137,7 @@ export interface HomebridgeConfig {
135
137
  /**
136
138
  * @deprecated
137
139
  */
138
- mdns?: any;
140
+ mdns?: unknown;
139
141
  accessories: AccessoryConfig[];
140
142
  platforms: PlatformConfig[];
141
143
  plugins?: PluginIdentifier[];
@@ -176,8 +178,42 @@ export declare class BridgeService {
176
178
  private cachedAccessoriesFileLoaded;
177
179
  private readonly publishedExternalAccessories;
178
180
  private readonly publishedExternalAccessoriesMetadata;
181
+ private cacheSaveTimer?;
182
+ private cacheSavePending;
183
+ private shuttingDown;
184
+ private readonly unsavableAccessories;
185
+ private readonly characteristicWarningListeners;
179
186
  constructor(api: HomebridgeAPI, pluginManager: PluginManager, externalPortService: ExternalPortService, bridgeOptions: BridgeOptions, bridgeConfig: BridgeConfiguration);
187
+ /** The warnings {@link printCharacteristicWriteWarning} has taken, so the bridge does not print them again. */
188
+ private static readonly printedWarnings;
189
+ /**
190
+ * Print a characteristic warning that no plugin's accessory has taken, the
191
+ * way HAP-NodeJS prints one nobody listens for.
192
+ */
193
+ private static printUnclaimedCharacteristicWarning;
194
+ /**
195
+ * Print the characteristic warnings of a platform accessory under its
196
+ * plugin's name, with one listener per accessory however often the
197
+ * accessory is registered.
198
+ *
199
+ * A plugin may unregister an accessory and register the same object again.
200
+ * HAP-NodeJS up to v2.3.0 removed every listener from an accessory taken off
201
+ * the bridge, which hid that a new listener was added on each registration;
202
+ * from v2.3.1 it leaves the listeners alone, and each warning would be
203
+ * printed once per registration.
204
+ */
205
+ private watchCharacteristicWarnings;
206
+ /**
207
+ * Print a characteristic warning (for a read as well as a write) under the
208
+ * name of the plugin, with the accessory it came from.
209
+ */
180
210
  static printCharacteristicWriteWarning(plugin: Plugin, accessory: Accessory, opts: CharacteristicWarningOpts, warning: CharacteristicWarning): void;
211
+ /**
212
+ * Say so in plain words when the port set for the bridge is in use by
213
+ * another program. HAP-NodeJS can not listen on it then, and Homebridge
214
+ * stops with an EADDRINUSE error that does not name the setting.
215
+ */
216
+ checkBridgePort(): Promise<void>;
181
217
  publishBridge(): void;
182
218
  /**
183
219
  * Attempt to load the cached accessories from disk.
@@ -199,7 +235,20 @@ export declare class BridgeService {
199
235
  private restoreCachedAccessoriesBackup;
200
236
  restoreCachedPlatformAccessories(): void;
201
237
  /**
202
- * Save the cached accessories back to disk.
238
+ * Save the cached accessories after a plugin registered, updated or
239
+ * unregistered some, without writing the file more than once in
240
+ * {@link CACHE_SAVE_INTERVAL}.
241
+ *
242
+ * Every save writes the accessories of all plugins, and blocks while it
243
+ * does. Some plugins call `updatePlatformAccessories()` on each change of
244
+ * state, which was one full write per call. The first request is written at
245
+ * once; those that follow within the interval are written together when it
246
+ * ends. From the shutdown on every request is written at once, as nothing
247
+ * may be left for a timer then.
248
+ */
249
+ private requestCacheSave;
250
+ /**
251
+ * Save the cached accessories back to disk, now.
203
252
  */
204
253
  saveCachedPlatformAccessoriesOnDisk(): void;
205
254
  /**
@@ -214,7 +263,15 @@ export declare class BridgeService {
214
263
  handlePublishExternalAccessories(accessories: PlatformAccessory[]): Promise<void>;
215
264
  createHAPAccessory(plugin: Plugin, accessoryInstance: AccessoryPlugin, displayName: string, accessoryType: AccessoryName | AccessoryIdentifier, uuidBase?: string): Accessory | undefined;
216
265
  loadPlatformAccessories(plugin: Plugin, platformInstance: StaticPlatformPlugin, platformType: PlatformName | PlatformIdentifier, logger: Logging): Promise<void>;
217
- teardown(): void;
266
+ /**
267
+ * Take the bridge and its external accessories off the network, save the
268
+ * cache and tell the plugins that Homebridge is shutting down.
269
+ *
270
+ * Everything but the wait happens before this returns. The promise is for
271
+ * the goodbye that HAP-NodeJS sends for each accessory: it resolves when
272
+ * they are all sent, or after {@link UNPUBLISH_TIMEOUT} at the latest, and
273
+ * never rejects (a failed unpublish is logged).
274
+ */
275
+ teardown(): Promise<void>;
218
276
  private static strippingPinCode;
219
277
  }
220
- //# sourceMappingURL=bridgeService.d.ts.map