matterbridge 3.1.7-dev-20250723-8e073ce → 3.1.7

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 (248) hide show
  1. package/CHANGELOG.md +8 -17
  2. package/README-SERVICE.md +1 -0
  3. package/dist/cli.d.ts +26 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +91 -2
  6. package/dist/cli.js.map +1 -0
  7. package/dist/cliEmitter.d.ts +34 -0
  8. package/dist/cliEmitter.d.ts.map +1 -0
  9. package/dist/cliEmitter.js +30 -0
  10. package/dist/cliEmitter.js.map +1 -0
  11. package/dist/clusters/export.d.ts +2 -0
  12. package/dist/clusters/export.d.ts.map +1 -0
  13. package/dist/clusters/export.js +2 -0
  14. package/dist/clusters/export.js.map +1 -0
  15. package/dist/defaultConfigSchema.d.ts +28 -0
  16. package/dist/defaultConfigSchema.d.ts.map +1 -0
  17. package/dist/defaultConfigSchema.js +24 -0
  18. package/dist/defaultConfigSchema.js.map +1 -0
  19. package/dist/deviceManager.d.ts +112 -0
  20. package/dist/deviceManager.d.ts.map +1 -0
  21. package/dist/deviceManager.js +94 -1
  22. package/dist/deviceManager.js.map +1 -0
  23. package/dist/devices/batteryStorage.d.ts +48 -0
  24. package/dist/devices/batteryStorage.d.ts.map +1 -0
  25. package/dist/devices/batteryStorage.js +48 -1
  26. package/dist/devices/batteryStorage.js.map +1 -0
  27. package/dist/devices/dishwasher.d.ts +91 -0
  28. package/dist/devices/dishwasher.d.ts.map +1 -0
  29. package/dist/devices/dishwasher.js +78 -3
  30. package/dist/devices/dishwasher.js.map +1 -0
  31. package/dist/devices/evse.d.ts +75 -0
  32. package/dist/devices/evse.d.ts.map +1 -0
  33. package/dist/devices/evse.js +74 -10
  34. package/dist/devices/evse.js.map +1 -0
  35. package/dist/devices/export.d.ts +11 -0
  36. package/dist/devices/export.d.ts.map +1 -0
  37. package/dist/devices/export.js +2 -0
  38. package/dist/devices/export.js.map +1 -0
  39. package/dist/devices/extractorHood.d.ts +46 -0
  40. package/dist/devices/extractorHood.d.ts.map +1 -0
  41. package/dist/devices/extractorHood.js +42 -0
  42. package/dist/devices/extractorHood.js.map +1 -0
  43. package/dist/devices/heatPump.d.ts +47 -0
  44. package/dist/devices/heatPump.d.ts.map +1 -0
  45. package/dist/devices/heatPump.js +50 -2
  46. package/dist/devices/heatPump.js.map +1 -0
  47. package/dist/devices/laundryDryer.d.ts +87 -0
  48. package/dist/devices/laundryDryer.d.ts.map +1 -0
  49. package/dist/devices/laundryDryer.js +83 -6
  50. package/dist/devices/laundryDryer.js.map +1 -0
  51. package/dist/devices/laundryWasher.d.ts +242 -0
  52. package/dist/devices/laundryWasher.d.ts.map +1 -0
  53. package/dist/devices/laundryWasher.js +91 -7
  54. package/dist/devices/laundryWasher.js.map +1 -0
  55. package/dist/devices/roboticVacuumCleaner.d.ts +112 -0
  56. package/dist/devices/roboticVacuumCleaner.d.ts.map +1 -0
  57. package/dist/devices/roboticVacuumCleaner.js +93 -7
  58. package/dist/devices/roboticVacuumCleaner.js.map +1 -0
  59. package/dist/devices/solarPower.d.ts +40 -0
  60. package/dist/devices/solarPower.d.ts.map +1 -0
  61. package/dist/devices/solarPower.js +38 -0
  62. package/dist/devices/solarPower.js.map +1 -0
  63. package/dist/devices/waterHeater.d.ts +111 -0
  64. package/dist/devices/waterHeater.d.ts.map +1 -0
  65. package/dist/devices/waterHeater.js +82 -2
  66. package/dist/devices/waterHeater.js.map +1 -0
  67. package/dist/dgram/coap.d.ts +205 -0
  68. package/dist/dgram/coap.d.ts.map +1 -0
  69. package/dist/dgram/coap.js +126 -13
  70. package/dist/dgram/coap.js.map +1 -0
  71. package/dist/dgram/dgram.d.ts +140 -0
  72. package/dist/dgram/dgram.d.ts.map +1 -0
  73. package/dist/dgram/dgram.js +113 -2
  74. package/dist/dgram/dgram.js.map +1 -0
  75. package/dist/dgram/mb_coap.d.ts +24 -0
  76. package/dist/dgram/mb_coap.d.ts.map +1 -0
  77. package/dist/dgram/mb_coap.js +41 -3
  78. package/dist/dgram/mb_coap.js.map +1 -0
  79. package/dist/dgram/mb_mdns.d.ts +24 -0
  80. package/dist/dgram/mb_mdns.d.ts.map +1 -0
  81. package/dist/dgram/mb_mdns.js +51 -13
  82. package/dist/dgram/mb_mdns.js.map +1 -0
  83. package/dist/dgram/mdns.d.ts +288 -0
  84. package/dist/dgram/mdns.d.ts.map +1 -0
  85. package/dist/dgram/mdns.js +300 -135
  86. package/dist/dgram/mdns.js.map +1 -0
  87. package/dist/dgram/multicast.d.ts +65 -0
  88. package/dist/dgram/multicast.d.ts.map +1 -0
  89. package/dist/dgram/multicast.js +60 -1
  90. package/dist/dgram/multicast.js.map +1 -0
  91. package/dist/dgram/unicast.d.ts +56 -0
  92. package/dist/dgram/unicast.d.ts.map +1 -0
  93. package/dist/dgram/unicast.js +54 -0
  94. package/dist/dgram/unicast.js.map +1 -0
  95. package/dist/frontend.d.ts +304 -0
  96. package/dist/frontend.d.ts.map +1 -0
  97. package/dist/frontend.js +435 -21
  98. package/dist/frontend.js.map +1 -0
  99. package/dist/globalMatterbridge.d.ts +59 -0
  100. package/dist/globalMatterbridge.d.ts.map +1 -0
  101. package/dist/globalMatterbridge.js +47 -0
  102. package/dist/globalMatterbridge.js.map +1 -0
  103. package/dist/helpers.d.ts +48 -0
  104. package/dist/helpers.d.ts.map +1 -0
  105. package/dist/helpers.js +53 -0
  106. package/dist/helpers.js.map +1 -0
  107. package/dist/index.d.ts +33 -0
  108. package/dist/index.d.ts.map +1 -0
  109. package/dist/index.js +30 -1
  110. package/dist/index.js.map +1 -0
  111. package/dist/logger/export.d.ts +2 -0
  112. package/dist/logger/export.d.ts.map +1 -0
  113. package/dist/logger/export.js +1 -0
  114. package/dist/logger/export.js.map +1 -0
  115. package/dist/matter/behaviors.d.ts +2 -0
  116. package/dist/matter/behaviors.d.ts.map +1 -0
  117. package/dist/matter/behaviors.js +2 -0
  118. package/dist/matter/behaviors.js.map +1 -0
  119. package/dist/matter/clusters.d.ts +2 -0
  120. package/dist/matter/clusters.d.ts.map +1 -0
  121. package/dist/matter/clusters.js +2 -0
  122. package/dist/matter/clusters.js.map +1 -0
  123. package/dist/matter/devices.d.ts +2 -0
  124. package/dist/matter/devices.d.ts.map +1 -0
  125. package/dist/matter/devices.js +2 -0
  126. package/dist/matter/devices.js.map +1 -0
  127. package/dist/matter/endpoints.d.ts +2 -0
  128. package/dist/matter/endpoints.d.ts.map +1 -0
  129. package/dist/matter/endpoints.js +2 -0
  130. package/dist/matter/endpoints.js.map +1 -0
  131. package/dist/matter/export.d.ts +5 -0
  132. package/dist/matter/export.d.ts.map +1 -0
  133. package/dist/matter/export.js +3 -0
  134. package/dist/matter/export.js.map +1 -0
  135. package/dist/matter/types.d.ts +3 -0
  136. package/dist/matter/types.d.ts.map +1 -0
  137. package/dist/matter/types.js +3 -0
  138. package/dist/matter/types.js.map +1 -0
  139. package/dist/matterbridge.d.ts +463 -0
  140. package/dist/matterbridge.d.ts.map +1 -0
  141. package/dist/matterbridge.js +843 -58
  142. package/dist/matterbridge.js.map +1 -0
  143. package/dist/matterbridgeAccessoryPlatform.d.ts +42 -0
  144. package/dist/matterbridgeAccessoryPlatform.d.ts.map +1 -0
  145. package/dist/matterbridgeAccessoryPlatform.js +36 -0
  146. package/dist/matterbridgeAccessoryPlatform.js.map +1 -0
  147. package/dist/matterbridgeBehaviors.d.ts +1351 -0
  148. package/dist/matterbridgeBehaviors.d.ts.map +1 -0
  149. package/dist/matterbridgeBehaviors.js +65 -5
  150. package/dist/matterbridgeBehaviors.js.map +1 -0
  151. package/dist/matterbridgeDeviceTypes.d.ts +709 -0
  152. package/dist/matterbridgeDeviceTypes.d.ts.map +1 -0
  153. package/dist/matterbridgeDeviceTypes.js +579 -15
  154. package/dist/matterbridgeDeviceTypes.js.map +1 -0
  155. package/dist/matterbridgeDynamicPlatform.d.ts +42 -0
  156. package/dist/matterbridgeDynamicPlatform.d.ts.map +1 -0
  157. package/dist/matterbridgeDynamicPlatform.js +36 -0
  158. package/dist/matterbridgeDynamicPlatform.js.map +1 -0
  159. package/dist/matterbridgeEndpoint.d.ts +1348 -0
  160. package/dist/matterbridgeEndpoint.d.ts.map +1 -0
  161. package/dist/matterbridgeEndpoint.js +1220 -51
  162. package/dist/matterbridgeEndpoint.js.map +1 -0
  163. package/dist/matterbridgeEndpointHelpers.d.ts +406 -0
  164. package/dist/matterbridgeEndpointHelpers.d.ts.map +1 -0
  165. package/dist/matterbridgeEndpointHelpers.js +353 -18
  166. package/dist/matterbridgeEndpointHelpers.js.map +1 -0
  167. package/dist/matterbridgePlatform.d.ts +310 -0
  168. package/dist/matterbridgePlatform.d.ts.map +1 -0
  169. package/dist/matterbridgePlatform.js +233 -0
  170. package/dist/matterbridgePlatform.js.map +1 -0
  171. package/dist/matterbridgeTypes.d.ts +195 -0
  172. package/dist/matterbridgeTypes.d.ts.map +1 -0
  173. package/dist/matterbridgeTypes.js +25 -0
  174. package/dist/matterbridgeTypes.js.map +1 -0
  175. package/dist/pluginManager.d.ts +270 -0
  176. package/dist/pluginManager.d.ts.map +1 -0
  177. package/dist/pluginManager.js +249 -3
  178. package/dist/pluginManager.js.map +1 -0
  179. package/dist/shelly.d.ts +174 -0
  180. package/dist/shelly.d.ts.map +1 -0
  181. package/dist/shelly.js +168 -7
  182. package/dist/shelly.js.map +1 -0
  183. package/dist/storage/export.d.ts +2 -0
  184. package/dist/storage/export.d.ts.map +1 -0
  185. package/dist/storage/export.js +1 -0
  186. package/dist/storage/export.js.map +1 -0
  187. package/dist/update.d.ts +59 -0
  188. package/dist/update.d.ts.map +1 -0
  189. package/dist/update.js +54 -0
  190. package/dist/update.js.map +1 -0
  191. package/dist/utils/colorUtils.d.ts +117 -0
  192. package/dist/utils/colorUtils.d.ts.map +1 -0
  193. package/dist/utils/colorUtils.js +263 -2
  194. package/dist/utils/colorUtils.js.map +1 -0
  195. package/dist/utils/commandLine.d.ts +59 -0
  196. package/dist/utils/commandLine.d.ts.map +1 -0
  197. package/dist/utils/commandLine.js +54 -0
  198. package/dist/utils/commandLine.js.map +1 -0
  199. package/dist/utils/copyDirectory.d.ts +33 -0
  200. package/dist/utils/copyDirectory.d.ts.map +1 -0
  201. package/dist/utils/copyDirectory.js +38 -1
  202. package/dist/utils/copyDirectory.js.map +1 -0
  203. package/dist/utils/createDirectory.d.ts +34 -0
  204. package/dist/utils/createDirectory.d.ts.map +1 -0
  205. package/dist/utils/createDirectory.js +33 -0
  206. package/dist/utils/createDirectory.js.map +1 -0
  207. package/dist/utils/createZip.d.ts +39 -0
  208. package/dist/utils/createZip.d.ts.map +1 -0
  209. package/dist/utils/createZip.js +47 -2
  210. package/dist/utils/createZip.js.map +1 -0
  211. package/dist/utils/deepCopy.d.ts +32 -0
  212. package/dist/utils/deepCopy.d.ts.map +1 -0
  213. package/dist/utils/deepCopy.js +39 -0
  214. package/dist/utils/deepCopy.js.map +1 -0
  215. package/dist/utils/deepEqual.d.ts +54 -0
  216. package/dist/utils/deepEqual.d.ts.map +1 -0
  217. package/dist/utils/deepEqual.js +72 -1
  218. package/dist/utils/deepEqual.js.map +1 -0
  219. package/dist/utils/error.d.ts +44 -0
  220. package/dist/utils/error.d.ts.map +1 -0
  221. package/dist/utils/error.js +41 -0
  222. package/dist/utils/error.js.map +1 -0
  223. package/dist/utils/export.d.ts +12 -0
  224. package/dist/utils/export.d.ts.map +1 -0
  225. package/dist/utils/export.js +1 -0
  226. package/dist/utils/export.js.map +1 -0
  227. package/dist/utils/hex.d.ts +49 -0
  228. package/dist/utils/hex.d.ts.map +1 -0
  229. package/dist/utils/hex.js +58 -0
  230. package/dist/utils/hex.js.map +1 -0
  231. package/dist/utils/isvalid.d.ts +103 -0
  232. package/dist/utils/isvalid.d.ts.map +1 -0
  233. package/dist/utils/isvalid.js +101 -0
  234. package/dist/utils/isvalid.js.map +1 -0
  235. package/dist/utils/network.d.ts +74 -0
  236. package/dist/utils/network.d.ts.map +1 -0
  237. package/dist/utils/network.js +81 -5
  238. package/dist/utils/network.js.map +1 -0
  239. package/dist/utils/spawn.d.ts +33 -0
  240. package/dist/utils/spawn.d.ts.map +1 -0
  241. package/dist/utils/spawn.js +40 -0
  242. package/dist/utils/spawn.js.map +1 -0
  243. package/dist/utils/wait.d.ts +56 -0
  244. package/dist/utils/wait.d.ts.map +1 -0
  245. package/dist/utils/wait.js +62 -9
  246. package/dist/utils/wait.js.map +1 -0
  247. package/npm-shrinkwrap.json +2 -2
  248. package/package.json +2 -1
@@ -1,29 +1,82 @@
1
+ /**
2
+ * This file contains the class MatterbridgePlatform.
3
+ *
4
+ * @file matterbridgePlatform.ts
5
+ * @author Luca Liguori
6
+ * @created 2024-03-21
7
+ * @version 1.2.1
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 module
1
25
  import path from 'node:path';
26
+ // AnsiLogger module
2
27
  import { CYAN, db, er, nf, wr } from 'node-ansi-logger';
28
+ // Storage module
3
29
  import { NodeStorageManager } from 'node-persist-manager';
4
30
  import { checkNotLatinCharacters } from './matterbridgeEndpointHelpers.js';
5
31
  import { isValidArray, isValidObject, isValidString } from './utils/export.js';
32
+ /**
33
+ * Represents the base Matterbridge platform. It is extended by the MatterbridgeAccessoryPlatform and MatterbridgeServicePlatform classes.
34
+ *
35
+ */
6
36
  export class MatterbridgePlatform {
37
+ /** The Matterbridge instance of this Platform. */
7
38
  matterbridge;
39
+ /** The logger instance for this platform. */
8
40
  log;
41
+ /** The configuration for this platform. */
9
42
  config = {};
43
+ /** The name of the platform. Will be set by the loadPlugin() method using the package.json value. */
10
44
  name = '';
45
+ /** The type of the platform. Will be set by the extending classes. */
11
46
  type = '';
47
+ /** The version of the platform. Will be set by the loadPlugin() method using the package.json value */
12
48
  version = '1.0.0';
49
+ /** Platform node storage manager. */
13
50
  storage;
51
+ /** Platform context storage. */
14
52
  context;
53
+ // Device and entity select in the plugin config UI
15
54
  selectDevice = new Map();
16
55
  selectEntity = new Map();
56
+ // Promises for storage
17
57
  _contextReady;
18
58
  _selectDeviceContextReady;
19
59
  _selectEntityContextReady;
60
+ /** The ready promise for the platform, which resolves when the platform is fully initialized. */
20
61
  ready;
62
+ /** Registered MatterbridgeEndpoint Map by uniqueId */
21
63
  _registeredEndpoints = new Map();
64
+ /** Registered MatterbridgeEndpoint Map by deviceName */
22
65
  _registeredEndpointsByName = new Map();
66
+ /**
67
+ * Creates an instance of the base MatterbridgePlatform.
68
+ * It is extended by the MatterbridgeAccessoryPlatform and MatterbridgeServicePlatform classes.
69
+ * Each plugin must extend the MatterbridgeAccessoryPlatform and MatterbridgeServicePlatform classes.
70
+ *
71
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
72
+ * @param {AnsiLogger} log - The logger instance.
73
+ * @param {PlatformConfig} config - The platform configuration.
74
+ */
23
75
  constructor(matterbridge, log, config) {
24
76
  this.matterbridge = matterbridge;
25
77
  this.log = log;
26
78
  this.config = config;
79
+ // create the NodeStorageManager for the plugin platform
27
80
  if (!isValidString(this.config.name, 1))
28
81
  throw new Error('Platform: the plugin name is missing or invalid.');
29
82
  this.log.debug(`Creating storage for plugin ${this.config.name} in ${path.join(this.matterbridge.matterbridgeDirectory, this.config.name)}`);
@@ -34,12 +87,14 @@ export class MatterbridgePlatform {
34
87
  logging: false,
35
88
  forgiveParseErrors: true,
36
89
  });
90
+ // create the context storage for the plugin platform
37
91
  this.log.debug(`Creating context for plugin ${this.config.name}`);
38
92
  this._contextReady = this.storage.createStorage('context').then((context) => {
39
93
  this.context = context;
40
94
  this.log.debug(`Created context for plugin ${this.config.name}`);
41
95
  return;
42
96
  });
97
+ // create the selectDevice storage for the plugin platform
43
98
  this.log.debug(`Loading selectDevice for plugin ${this.config.name}`);
44
99
  this._selectDeviceContextReady = this.storage.createStorage('selectDevice').then(async (context) => {
45
100
  const selectDevice = await context.get('selectDevice', []);
@@ -48,6 +103,7 @@ export class MatterbridgePlatform {
48
103
  this.log.debug(`Loaded ${this.selectDevice.size} selectDevice for plugin ${this.config.name}`);
49
104
  return;
50
105
  });
106
+ // create the selectEntity storage for the plugin platform
51
107
  this.log.debug(`Loading selectEntity for plugin ${this.config.name}`);
52
108
  this._selectEntityContextReady = this.storage.createStorage('selectEntity').then(async (context) => {
53
109
  const selectEntity = await context.get('selectEntity', []);
@@ -56,47 +112,126 @@ export class MatterbridgePlatform {
56
112
  this.log.debug(`Loaded ${this.selectEntity.size} selectEntity for plugin ${this.config.name}`);
57
113
  return;
58
114
  });
115
+ // Create the `ready` promise for the platform
59
116
  this.ready = Promise.all([this._contextReady, this._selectDeviceContextReady, this._selectEntityContextReady]).then(() => {
60
117
  this.log.debug(`MatterbridgePlatform for plugin ${this.config.name} is fully initialized`);
61
118
  return;
62
119
  });
63
120
  }
121
+ /**
122
+ * This method must be overridden in the extended class.
123
+ * It is called when the platform is started.
124
+ * Use this method to create the MatterbridgeEndpoints and call this.registerDevice().
125
+ *
126
+ * @param {string} [reason] - The reason for starting.
127
+ * @throws {Error} - Throws an error if the method is not overridden.
128
+ */
64
129
  async onStart(reason) {
65
130
  this.log.error('Plugins must override onStart.', reason);
66
131
  throw new Error('Plugins must override onStart.');
67
132
  }
133
+ /**
134
+ * This method can be overridden in the extended class. In this case always call super.onConfigure() to save the select and run checkEndpointNumbers().
135
+ * It is called after the platform has started.
136
+ * Use this method to perform any configuration of your devices and to override the value of the attributes that are persistent and stored in the
137
+ * matter storage (i.e. the onOff attribute of the OnOff cluster).
138
+ */
68
139
  async onConfigure() {
69
140
  this.log.debug(`Configuring platform ${this.name}`);
141
+ // Save the selectDevice and selectEntity
70
142
  await this.saveSelects();
143
+ // Check and update the endpoint numbers
71
144
  await this.checkEndpointNumbers();
72
145
  }
146
+ /**
147
+ * This method can be overridden in the extended class. In this case always call super.onShutdown() to save the selects, run checkEndpointNumbers() and cleanup memory.
148
+ * It is called when the platform is shutting down.
149
+ * Use this method to clean up any resources you used in the constructor or onStart.
150
+ *
151
+ * @param {string} [reason] - The reason for shutting down.
152
+ */
73
153
  async onShutdown(reason) {
74
154
  this.log.debug(`Shutting down platform ${this.name}`, reason);
155
+ // Save the selectDevice and selectEntity
75
156
  await this.saveSelects();
157
+ // Check and update the endpoint numbers
76
158
  await this.checkEndpointNumbers();
159
+ // Cleanup memory
77
160
  this.selectDevice.clear();
78
161
  this.selectEntity.clear();
79
162
  this._registeredEndpoints.clear();
80
163
  this._registeredEndpointsByName.clear();
164
+ // Close the storage
81
165
  await this.context?.close();
82
166
  this.context = undefined;
83
167
  await this.storage?.close();
84
168
  }
169
+ /**
170
+ * Called when the logger level is changed.
171
+ *
172
+ * @param {LogLevel} logLevel The new logger level.
173
+ */
85
174
  async onChangeLoggerLevel(logLevel) {
86
175
  this.log.debug(`The plugin doesn't override onChangeLoggerLevel. Logger level set to: ${logLevel}`);
87
176
  }
177
+ /**
178
+ * Called when a plugin config includes an action button or an action button with text field.
179
+ *
180
+ * @param {string} action The action triggered by the button in plugin config.
181
+ * @param {string} value The value of the field of the action button.
182
+ * @param {string} id The id of the schema associated with the action.
183
+ * @param {PlatformConfig} formData The changed form data of the plugin.
184
+ *
185
+ * @remarks
186
+ * This method can be overridden in the extended class.
187
+ *
188
+ * Use this method to handle the action defined in the plugin schema:
189
+ * ```json
190
+ * "addDevice": {
191
+ * "description": "Manually add a device that has not been discovered with mdns:",
192
+ * "type": "boolean",
193
+ * "buttonText": "ADD", // The text on the button. This is used when the action doesn't include a text field.
194
+ * "buttonField": "ADD", // The text on the button. This is used when the action includes a text field.
195
+ * "buttonClose": false, // optional, default is false. When true, the dialog will close after the action is sent.
196
+ * "buttonSave": false, // optional, default is false. When true, the dialog will close and trigger the restart required after the action is sent.
197
+ * "textPlaceholder": "Enter the device IP address", // optional: the placeholder text for the text field.
198
+ * "default": false
199
+ * },
200
+ * ```
201
+ */
88
202
  async onAction(action, value, id, formData) {
89
203
  this.log.debug(`The plugin ${CYAN}${this.name}${db} doesn't override onAction. Received action ${CYAN}${action}${db}${value ? ' with ' + CYAN + value + db : ''} ${id ? ' for schema ' + CYAN + id + db : ''}`, formData);
90
204
  }
205
+ /**
206
+ * Called when the plugin config has been updated.
207
+ *
208
+ * @param {PlatformConfig} config The new plugin config.
209
+ */
91
210
  async onConfigChanged(config) {
92
211
  this.log.debug(`The plugin ${CYAN}${config.name}${db} doesn't override onConfigChanged. Received new config.`);
93
212
  }
213
+ /**
214
+ * Retrieves the devices registered with the platform.
215
+ *
216
+ * @returns {MatterbridgeEndpoint[]} The registered devices.
217
+ */
94
218
  getDevices() {
95
219
  return Array.from(this._registeredEndpoints.values());
96
220
  }
221
+ /**
222
+ * Checks if a device with this name is already registered in the platform.
223
+ *
224
+ * @param {string} deviceName - The device name to check.
225
+ * @returns {boolean} True if the device is already registered, false otherwise.
226
+ */
97
227
  hasDeviceName(deviceName) {
98
228
  return this._registeredEndpointsByName.has(deviceName);
99
229
  }
230
+ /**
231
+ * Registers a device with the Matterbridge platform.
232
+ *
233
+ * @param {MatterbridgeEndpoint} device - The device to register.
234
+ */
100
235
  async registerDevice(device) {
101
236
  device.plugin = this.name;
102
237
  if (device.deviceName && this._registeredEndpointsByName.has(device.deviceName)) {
@@ -112,6 +247,11 @@ export class MatterbridgePlatform {
112
247
  if (device.deviceName)
113
248
  this._registeredEndpointsByName.set(device.deviceName, device);
114
249
  }
250
+ /**
251
+ * Unregisters a device registered with the Matterbridge platform.
252
+ *
253
+ * @param {MatterbridgeEndpoint} device - The device to unregister.
254
+ */
115
255
  async unregisterDevice(device) {
116
256
  await this.matterbridge.removeBridgedEndpoint(this.name, device);
117
257
  if (device.uniqueId)
@@ -119,11 +259,24 @@ export class MatterbridgePlatform {
119
259
  if (device.deviceName)
120
260
  this._registeredEndpointsByName.delete(device.deviceName);
121
261
  }
262
+ /**
263
+ * Unregisters all devices registered with the Matterbridge platform.
264
+ *
265
+ * @param {number} [delay] - The delay in milliseconds between removing each bridged endpoint (default: 0).
266
+ */
122
267
  async unregisterAllDevices(delay = 0) {
123
268
  await this.matterbridge.removeAllBridgedEndpoints(this.name, delay);
124
269
  this._registeredEndpoints.clear();
125
270
  this._registeredEndpointsByName.clear();
126
271
  }
272
+ /**
273
+ * Saves the select devices and entities to storage.
274
+ *
275
+ * This method saves the current state of `selectDevice` and `selectEntity` maps to their respective storage.
276
+ * It logs the number of items being saved and ensures that the storage is properly closed after saving.
277
+ *
278
+ * @returns {Promise<void>} A promise that resolves when the save operation is complete.
279
+ */
127
280
  async saveSelects() {
128
281
  if (this.storage) {
129
282
  this.log.debug(`Saving ${this.selectDevice.size} selectDevice...`);
@@ -136,15 +289,36 @@ export class MatterbridgePlatform {
136
289
  await selectEntity.close();
137
290
  }
138
291
  }
292
+ /**
293
+ * Clears all the select device and entity maps.
294
+ *
295
+ * @returns {void}
296
+ */
139
297
  async clearSelect() {
140
298
  this.selectDevice.clear();
141
299
  this.selectEntity.clear();
142
300
  await this.saveSelects();
143
301
  }
302
+ /**
303
+ * Clears the select for a single device.
304
+ *
305
+ * @param {string} serial - The serial of the device to clear.
306
+ * @returns {void}
307
+ */
144
308
  async clearDeviceSelect(serial) {
145
309
  this.selectDevice.delete(serial);
146
310
  await this.saveSelects();
147
311
  }
312
+ /**
313
+ * Set the select device in the platform map.
314
+ *
315
+ * @param {string} serial - The serial number of the device.
316
+ * @param {string} name - The name of the device.
317
+ * @param {string} [configUrl] - The configuration URL of the device.
318
+ * @param {string} [icon] - The icon of the device: 'wifi', 'ble', 'hub'
319
+ * @param {Array<{ name: string; description: string; icon?: string }>} [entities] - The entities associated with the device.
320
+ * @returns {void}
321
+ */
148
322
  setSelectDevice(serial, name, configUrl, icon, entities) {
149
323
  const device = this.selectDevice.get(serial);
150
324
  if (device) {
@@ -161,6 +335,15 @@ export class MatterbridgePlatform {
161
335
  this.selectDevice.set(serial, { serial, name, configUrl, icon, entities });
162
336
  }
163
337
  }
338
+ /**
339
+ * Set the select device entity in the platform map.
340
+ *
341
+ * @param {string} serial - The serial number of the device.
342
+ * @param {string} entityName - The name of the entity.
343
+ * @param {string} entityDescription - The description of the entity.
344
+ * @param {string} [entityIcon] - The icon of the entity: 'wifi', 'ble', 'hub', 'component', 'matter'
345
+ * @returns {void}
346
+ */
164
347
  setSelectDeviceEntity(serial, entityName, entityDescription, entityIcon) {
165
348
  const device = this.selectDevice.get(serial);
166
349
  if (device) {
@@ -170,6 +353,11 @@ export class MatterbridgePlatform {
170
353
  device.entities.push({ name: entityName, description: entityDescription, icon: entityIcon });
171
354
  }
172
355
  }
356
+ /**
357
+ * Retrieves the select devices from the platform map.
358
+ *
359
+ * @returns {{ pluginName: string; serial: string; name: string; configUrl?: string; icon?: string; entities?: { name: string; description: string; icon?: string }[] }[]} The selected devices array.
360
+ */
173
361
  getSelectDevices() {
174
362
  const selectDevices = [];
175
363
  for (const device of this.selectDevice.values()) {
@@ -177,9 +365,22 @@ export class MatterbridgePlatform {
177
365
  }
178
366
  return selectDevices;
179
367
  }
368
+ /**
369
+ * Set the select entity in the platform map.
370
+ *
371
+ * @param {string} name - The entity name.
372
+ * @param {string} description - The entity description.
373
+ * @param {string} [icon] - The entity icon: 'wifi', 'ble', 'hub', 'component', 'matter'
374
+ * @returns {void}
375
+ */
180
376
  setSelectEntity(name, description, icon) {
181
377
  this.selectEntity.set(name, { name, description, icon });
182
378
  }
379
+ /**
380
+ * Retrieve the select entities.
381
+ *
382
+ * @returns {{ pluginName: string; name: string; description: string; icon?: string }[]} The select entities array.
383
+ */
183
384
  getSelectEntities() {
184
385
  const selectEntities = [];
185
386
  for (const entity of this.selectEntity.values()) {
@@ -187,6 +388,12 @@ export class MatterbridgePlatform {
187
388
  }
188
389
  return selectEntities;
189
390
  }
391
+ /**
392
+ * Verifies if the Matterbridge version meets the required version.
393
+ *
394
+ * @param {string} requiredVersion - The required version to compare against.
395
+ * @returns {boolean} True if the Matterbridge version meets or exceeds the required version, false otherwise.
396
+ */
190
397
  verifyMatterbridgeVersion(requiredVersion) {
191
398
  const compareVersions = (matterbridgeVersion, requiredVersion) => {
192
399
  const stripTag = (v) => {
@@ -211,6 +418,14 @@ export class MatterbridgePlatform {
211
418
  return false;
212
419
  return true;
213
420
  }
421
+ /**
422
+ * Validates if a device is allowed based on the whitelist and blacklist configurations.
423
+ * The blacklist has priority over the whitelist.
424
+ *
425
+ * @param {string | string[]} device - The device name(s) to validate.
426
+ * @param {boolean} [log] - Whether to log the validation result.
427
+ * @returns {boolean} - Returns true if the device is allowed, false otherwise.
428
+ */
214
429
  validateDevice(device, log = true) {
215
430
  if (!Array.isArray(device))
216
431
  device = [device];
@@ -240,6 +455,14 @@ export class MatterbridgePlatform {
240
455
  this.log.info(`Skipping device ${CYAN}${device.join(', ')}${nf} because not in whitelist`);
241
456
  return false;
242
457
  }
458
+ /**
459
+ * Validates if an entity is allowed based on the entity blacklist and device-entity blacklist configurations.
460
+ *
461
+ * @param {string} device - The device to which the entity belongs.
462
+ * @param {string} entity - The entity to validate.
463
+ * @param {boolean} [log] - Whether to log the validation result.
464
+ * @returns {boolean} - Returns true if the entity is allowed, false otherwise.
465
+ */
243
466
  validateEntity(device, entity, log = true) {
244
467
  if (isValidArray(this.config.entityBlackList, 1) && this.config.entityBlackList.find((e) => e === entity)) {
245
468
  if (log)
@@ -258,6 +481,15 @@ export class MatterbridgePlatform {
258
481
  }
259
482
  return true;
260
483
  }
484
+ /**
485
+ * Checks and updates the endpoint numbers for Matterbridge devices.
486
+ *
487
+ * This method retrieves the list of Matterbridge devices and their child endpoints,
488
+ * compares their current endpoint numbers with the stored ones, and updates the storage
489
+ * if there are any changes. It logs the changes and updates the endpoint numbers accordingly.
490
+ *
491
+ * @returns {Promise<number>} The size of the updated endpoint map, or -1 if storage is not available.
492
+ */
261
493
  async checkEndpointNumbers() {
262
494
  if (!this.storage)
263
495
  return -1;
@@ -298,3 +530,4 @@ export class MatterbridgePlatform {
298
530
  return endpointMap.size;
299
531
  }
300
532
  }
533
+ //# sourceMappingURL=matterbridgePlatform.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"matterbridgePlatform.js","sourceRoot":"","sources":["../src/matterbridgePlatform.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,iBAAiB;AACjB,OAAO,IAAI,MAAM,WAAW,CAAC;AAI7B,oBAAoB;AACpB,OAAO,EAAc,IAAI,EAAE,EAAE,EAAE,EAAE,EAAY,EAAE,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAC9E,iBAAiB;AACjB,OAAO,EAAe,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAMvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAqB/E;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAC/B,kDAAkD;IAClD,YAAY,CAAe;IAC3B,6CAA6C;IAC7C,GAAG,CAAa;IAChB,2CAA2C;IAC3C,MAAM,GAAmB,EAAE,CAAC;IAC5B,qGAAqG;IACrG,IAAI,GAAG,EAAE,CAAC;IACV,sEAAsE;IACtE,IAAI,GAAG,EAAE,CAAC;IACV,uGAAuG;IACvG,OAAO,GAAG,OAAO,CAAC;IAElB,qCAAqC;IACrC,OAAO,CAAqB;IAC5B,gCAAgC;IAChC,OAAO,CAAe;IAEtB,mDAAmD;IAC1C,YAAY,GAAG,IAAI,GAAG,EAAkJ,CAAC;IACzK,YAAY,GAAG,IAAI,GAAG,EAAgE,CAAC;IAEhG,uBAAuB;IACf,aAAa,CAAgB;IAC7B,yBAAyB,CAAgB;IACzC,yBAAyB,CAAgB;IACjD,iGAAiG;IACjG,KAAK,CAAgB;IAErB,sDAAsD;IACrC,oBAAoB,GAAG,IAAI,GAAG,EAAgC,CAAC;IAChF,wDAAwD;IACvC,0BAA0B,GAAG,IAAI,GAAG,EAAgC,CAAC;IAEtF;;;;;;;;OAQG;IACH,YAAY,YAA0B,EAAE,GAAe,EAAE,MAAsB;QAC7E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,wDAAwD;QACxD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAC7G,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,IAAI,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7I,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAkB,CAAC;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACzE,UAAU,EAAE,KAAK;YACjB,eAAe,EAAE,SAAS;YAC1B,OAAO,EAAE,KAAK;YACd,kBAAkB,EAAE,IAAI;SACzB,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAClE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YAC1E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACjE,OAAO;QACT,CAAC,CAAC,CAAC;QAEH,0DAA0D;QAC1D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjG,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAuH,cAAc,EAAE,EAAE,CAAC,CAAC;YACjL,KAAK,MAAM,MAAM,IAAI,YAAY;gBAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAChF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,YAAY,CAAC,IAAI,4BAA4B,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/F,OAAO;QACT,CAAC,CAAC,CAAC;QAEH,0DAA0D;QAC1D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjG,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAyD,cAAc,EAAE,EAAE,CAAC,CAAC;YACnH,KAAK,MAAM,MAAM,IAAI,YAAY;gBAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9E,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,YAAY,CAAC,IAAI,4BAA4B,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/F,OAAO;QACT,CAAC,CAAC,CAAC;QAEH,8CAA8C;QAC9C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACvH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,IAAI,CAAC,MAAM,CAAC,IAAI,uBAAuB,CAAC,CAAC;YAC3F,OAAO;QACT,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,MAAe;QAC3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAEpD,yCAAyC;QACzC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,wCAAwC;QACxC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,MAAe;QAC9B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;QAE9D,yCAAyC;QACzC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAEzB,wCAAwC;QACxC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAElC,iBAAiB;QACjB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC,0BAA0B,CAAC,KAAK,EAAE,CAAC;QAExC,oBAAoB;QACpB,MAAM,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,MAAM,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,QAAkB;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yEAAyE,QAAQ,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAc,EAAE,KAAc,EAAE,EAAW,EAAE,QAAyB;QACnF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,EAAE,+CAA+C,IAAI,GAAG,MAAM,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC5N,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,MAAsB;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,yDAAyD,CAAC,CAAC;IACjH,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,UAAkB;QAC9B,OAAO,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAC,MAA4B;QAC/C,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YAChF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,sFAAsF,CAAC,CAAC;YACxJ,OAAO;QACT,CAAC;QACD,IAAI,MAAM,CAAC,UAAU,IAAI,uBAAuB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACpE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,4BAA4B,CAAC,CAAC;QAChG,CAAC;QACD,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9D,IAAI,MAAM,CAAC,QAAQ;YAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5E,IAAI,MAAM,CAAC,UAAU;YAAE,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,MAA4B;QACjD,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,QAAQ;YAAE,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvE,IAAI,MAAM,CAAC,UAAU;YAAE,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,oBAAoB,CAAC,QAAgB,CAAC;QAC1C,MAAM,IAAI,CAAC,YAAY,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACpE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,CAAC,0BAA0B,CAAC,KAAK,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,WAAW;QACvB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,CAAC;YACnE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YACtE,MAAM,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC/E,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC;YAE3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAAC,CAAC;YACnE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YACtE,MAAM,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC/E,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CAAC,MAAc;QACpC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAc,EAAE,IAAY,EAAE,SAAkB,EAAE,IAAa,EAAE,QAAiE;QAChJ,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;YACvB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;YACnB,IAAI,SAAS;gBAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;YAC5C,IAAI,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;YAC7B,IAAI,QAAQ;gBAAE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAc,EAAE,UAAkB,EAAE,iBAAyB,EAAE,UAAmB;QACtG,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC;gBAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QAClK,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,MAAM,aAAa,GAAiK,EAAE,CAAC;QACvL,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC;YAChD,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,IAAY,EAAE,WAAmB,EAAE,IAAa;QAC9D,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,MAAM,cAAc,GAA+E,EAAE,CAAC;QACtG,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC;YAChD,cAAc,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,yBAAyB,CAAC,eAAuB;QAC/C,MAAM,eAAe,GAAG,CAAC,mBAA2B,EAAE,eAAuB,EAAW,EAAE;YACxF,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE;gBAC7B,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC,CAAC;YACF,MAAM,OAAO,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrE,MAAM,OAAO,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClE,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC/B,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;oBACpB,OAAO,KAAK,CAAC;gBACf,CAAC;qBAAM,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;oBAC3B,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,eAAe,CAAC;YAAE,OAAO,KAAK,CAAC;QAC3F,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,MAAyB,EAAE,GAAG,GAAG,IAAI;QAClD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3C,KAAK,MAAM,CAAC,IAAI,MAAM;gBAAE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAAE,gBAAgB,EAAE,CAAC;QACpF,CAAC;QACD,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,GAAG;gBAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;YAChG,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3C,KAAK,MAAM,CAAC,IAAI,MAAM;gBAAE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAAE,eAAe,EAAE,CAAC;QACnF,CAAC;;YAAM,eAAe,EAAE,CAAC;QACzB,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,GAAG;YAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,2BAA2B,CAAC,CAAC;QACpG,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,GAAG,GAAG,IAAI;QACvD,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC;YAC1G,IAAI,GAAG;gBAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,MAAM,GAAG,EAAE,6BAA6B,CAAC,CAAC;YAC3F,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC;YAC3G,IAAI,GAAG;gBAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,MAAM,GAAG,EAAE,iCAAiC,CAAC,CAAC;YAC/F,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,qBAAqB,IAAK,IAAI,CAAC,MAAM,CAAC,qBAAkD,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACnM,IAAI,GAAG;gBAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,MAAM,GAAG,EAAE,eAAe,IAAI,GAAG,MAAM,GAAG,EAAE,mCAAmC,CAAC,CAAC;YAClI,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,oBAAoB;QACxB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,KAAK,CAAC;QACxB,MAAM,WAAW,GAAG,IAAI,GAAG,CAAyB,MAAM,OAAO,CAAC,GAAG,CAA6B,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC;QAEtH,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1F,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACtE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,MAAM,CAAC,UAAU,kCAAkC,CAAC,CAAC;gBAC3F,SAAS;YACX,CAAC;YACD,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC;gBAChG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8BAA8B,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,iBAAiB,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,IAAI,GAAG,MAAM,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,CAAC;gBAC/K,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sCAAsC,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,OAAO,IAAI,GAAG,MAAM,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,CAAC;gBACzH,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;YACvD,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,iBAAiB,EAA4B,EAAE,CAAC;gBACzE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW;oBAAE,SAAS;gBACnD,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;oBAC7I,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oCAAoC,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,IAAI,IAAI,GAAG,KAAK,CAAC,EAAE,GAAG,EAAE,iBAAiB,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,IAAI,GAAG,KAAK,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,CAAC;oBACnO,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC7E,CAAC;gBACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC7D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4CAA4C,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,IAAI,IAAI,GAAG,KAAK,CAAC,EAAE,GAAG,EAAE,OAAO,IAAI,GAAG,KAAK,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,CAAC;oBACtJ,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC7E,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC5C,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACpE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACpD,OAAO,WAAW,CAAC,IAAI,CAAC;IAC1B,CAAC;CACF"}
@@ -0,0 +1,195 @@
1
+ /**
2
+ * This file contains the types for Matterbridge.
3
+ *
4
+ * @file matterbridgeTypes.ts
5
+ * @author Luca Liguori
6
+ * @created 2024-07-12
7
+ * @version 1.0.2
8
+ * @license Apache-2.0
9
+ *
10
+ * Copyright 2023, 2024, 2025 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 { NodeStorage } from 'node-persist-manager';
25
+ import { LogLevel } from 'node-ansi-logger';
26
+ import { FabricIndex, VendorId, StorageContext, ServerNode, EndpointNumber, Endpoint as EndpointNode } from '@matter/main';
27
+ import { AggregatorEndpoint } from '@matter/main/endpoints/aggregator';
28
+ import { MatterbridgePlatform, PlatformConfig, PlatformSchema } from './matterbridgePlatform.js';
29
+ import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
30
+ export declare const plg = "\u001B[38;5;33m";
31
+ export declare const dev = "\u001B[38;5;79m";
32
+ export declare const typ = "\u001B[38;5;207m";
33
+ export interface RegisteredPlugin extends BaseRegisteredPlugin {
34
+ nodeContext?: NodeStorage;
35
+ storageContext?: StorageContext;
36
+ serverNode?: ServerNode<ServerNode.RootEndpoint>;
37
+ aggregatorNode?: EndpointNode<AggregatorEndpoint>;
38
+ device?: MatterbridgeEndpoint;
39
+ platform?: MatterbridgePlatform;
40
+ reachabilityTimeout?: NodeJS.Timeout;
41
+ }
42
+ export interface BaseRegisteredPlugin {
43
+ name: string;
44
+ version: string;
45
+ description: string;
46
+ author: string;
47
+ path: string;
48
+ type: string;
49
+ latestVersion?: string;
50
+ serialNumber?: string;
51
+ homepage?: string;
52
+ help?: string;
53
+ changelog?: string;
54
+ funding?: string;
55
+ locked?: boolean;
56
+ error?: boolean;
57
+ enabled?: boolean;
58
+ loaded?: boolean;
59
+ started?: boolean;
60
+ configured?: boolean;
61
+ restartRequired?: boolean;
62
+ registeredDevices?: number;
63
+ addedDevices?: number;
64
+ configJson?: PlatformConfig;
65
+ schemaJson?: PlatformSchema;
66
+ hasWhiteList?: boolean;
67
+ hasBlackList?: boolean;
68
+ }
69
+ export interface FrontendRegisteredPlugin extends BaseRegisteredPlugin {
70
+ paired?: boolean;
71
+ qrPairingCode?: string;
72
+ manualPairingCode?: string;
73
+ fabricInformations?: SanitizedExposedFabricInformation[];
74
+ sessionInformations?: SanitizedSession[];
75
+ }
76
+ export interface SystemInformation {
77
+ interfaceName: string;
78
+ macAddress: string;
79
+ ipv4Address: string;
80
+ ipv6Address: string;
81
+ nodeVersion: string;
82
+ hostname: string;
83
+ user: string;
84
+ osType: string;
85
+ osRelease: string;
86
+ osPlatform: string;
87
+ osArch: string;
88
+ totalMemory: string;
89
+ freeMemory: string;
90
+ systemUptime: string;
91
+ processUptime: string;
92
+ cpuUsage: string;
93
+ rss: string;
94
+ heapTotal: string;
95
+ heapUsed: string;
96
+ }
97
+ export interface MatterbridgeInformation {
98
+ homeDirectory: string;
99
+ rootDirectory: string;
100
+ matterbridgeDirectory: string;
101
+ matterbridgePluginDirectory: string;
102
+ matterbridgeCertDirectory: string;
103
+ globalModulesDirectory: string;
104
+ matterbridgeVersion: string;
105
+ matterbridgeLatestVersion: string;
106
+ matterbridgeDevVersion: string;
107
+ matterbridgeSerialNumber: string;
108
+ matterbridgeAdvertise: boolean | undefined;
109
+ matterbridgeEndAdvertise: boolean;
110
+ matterbridgePaired: boolean | undefined;
111
+ matterbridgeQrPairingCode: string | undefined;
112
+ matterbridgeManualPairingCode: string | undefined;
113
+ matterbridgeFabricInformations: SanitizedExposedFabricInformation[] | undefined;
114
+ matterbridgeSessionInformations: SanitizedSession[] | undefined;
115
+ bridgeMode: string;
116
+ restartMode: string;
117
+ virtualMode: 'disabled' | 'outlet' | 'light' | 'switch' | 'mounted_switch';
118
+ readOnly: boolean;
119
+ shellyBoard: boolean;
120
+ shellySysUpdate: boolean;
121
+ shellyMainUpdate: boolean;
122
+ profile?: string;
123
+ loggerLevel: LogLevel;
124
+ fileLogger: boolean;
125
+ matterLoggerLevel: number;
126
+ matterFileLogger: boolean;
127
+ mattermdnsinterface: string | undefined;
128
+ matteripv4address: string | undefined;
129
+ matteripv6address: string | undefined;
130
+ matterPort: number;
131
+ matterDiscriminator: number | undefined;
132
+ matterPasscode: number | undefined;
133
+ restartRequired: boolean;
134
+ updateRequired: boolean;
135
+ }
136
+ export interface SanitizedExposedFabricInformation {
137
+ fabricIndex: FabricIndex;
138
+ fabricId: string;
139
+ nodeId: string;
140
+ rootNodeId: string;
141
+ rootVendorId: VendorId;
142
+ rootVendorName: string;
143
+ label: string;
144
+ }
145
+ export interface SanitizedSession {
146
+ name: string;
147
+ nodeId: string;
148
+ peerNodeId: string;
149
+ fabric?: SanitizedExposedFabricInformation;
150
+ isPeerActive: boolean;
151
+ lastInteractionTimestamp: string;
152
+ lastActiveTimestamp: string;
153
+ numberOfActiveSubscriptions: number;
154
+ }
155
+ export interface ApiDevices {
156
+ pluginName: string;
157
+ type: string;
158
+ endpoint: EndpointNumber | undefined;
159
+ name: string;
160
+ serial: string;
161
+ productUrl: string;
162
+ configUrl?: string;
163
+ uniqueId: string;
164
+ reachable: boolean;
165
+ powerSource?: 'ac' | 'dc' | 'ok' | 'warning' | 'critical';
166
+ cluster: string;
167
+ matter?: ApiDevicesMatter;
168
+ }
169
+ export interface ApiDevicesMatter {
170
+ commissioned: boolean;
171
+ fabricInformations?: SanitizedExposedFabricInformation[];
172
+ sessionInformations?: SanitizedSession[];
173
+ qrPairingCode?: string;
174
+ manualPairingCode?: string;
175
+ }
176
+ export interface ApiClustersResponse {
177
+ plugin: string;
178
+ deviceName: string;
179
+ serialNumber: string;
180
+ endpoint: number;
181
+ deviceTypes: number[];
182
+ clusters: ApiClusters[];
183
+ }
184
+ export interface ApiClusters {
185
+ endpoint: string;
186
+ id: string;
187
+ deviceTypes: number[];
188
+ clusterName: string;
189
+ clusterId: string;
190
+ attributeName: string;
191
+ attributeId: string;
192
+ attributeValue: string;
193
+ attributeLocalValue: unknown;
194
+ }
195
+ //# sourceMappingURL=matterbridgeTypes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"matterbridgeTypes.d.ts","sourceRoot":"","sources":["../src/matterbridgeTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,cAAc,CAAC;AAC3H,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAGvE,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAGjE,eAAO,MAAM,GAAG,oBAAoB,CAAC;AACrC,eAAO,MAAM,GAAG,oBAAoB,CAAC;AACrC,eAAO,MAAM,GAAG,qBAAqB,CAAC;AAGtC,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IACjD,cAAc,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAClD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;CACtC;AAGD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAGD,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IACzD,mBAAmB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC1C;AAGD,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAGD,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,2BAA2B,EAAE,MAAM,CAAC;IACpC,yBAAyB,EAAE,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,yBAAyB,EAAE,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC;IACjC,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,wBAAwB,EAAE,OAAO,CAAC;IAClC,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,6BAA6B,EAAE,MAAM,GAAG,SAAS,CAAC;IAClD,8BAA8B,EAAE,iCAAiC,EAAE,GAAG,SAAS,CAAC;IAChF,+BAA+B,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAC;IAChE,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,gBAAgB,CAAC;IAC3E,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,QAAQ,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC;IAChD,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,QAAQ,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,iCAAiC,CAAC;IAC3C,YAAY,EAAE,OAAO,CAAC;IACtB,wBAAwB,EAAE,MAAM,CAAC;IACjC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,UAAU,CAAC;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IACzD,mBAAmB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;CAC9B"}