matterbridge 2.2.5-dev.4 → 2.2.5

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 (152) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/dist/cli.d.ts +29 -0
  3. package/dist/cli.d.ts.map +1 -0
  4. package/dist/cli.js +37 -2
  5. package/dist/cli.js.map +1 -0
  6. package/dist/cluster/export.d.ts +2 -0
  7. package/dist/cluster/export.d.ts.map +1 -0
  8. package/dist/cluster/export.js +2 -0
  9. package/dist/cluster/export.js.map +1 -0
  10. package/dist/defaultConfigSchema.d.ts +27 -0
  11. package/dist/defaultConfigSchema.d.ts.map +1 -0
  12. package/dist/defaultConfigSchema.js +23 -0
  13. package/dist/defaultConfigSchema.js.map +1 -0
  14. package/dist/deviceManager.d.ts +114 -0
  15. package/dist/deviceManager.d.ts.map +1 -0
  16. package/dist/deviceManager.js +94 -1
  17. package/dist/deviceManager.js.map +1 -0
  18. package/dist/frontend.d.ts +221 -0
  19. package/dist/frontend.d.ts.map +1 -0
  20. package/dist/frontend.js +328 -22
  21. package/dist/frontend.js.map +1 -0
  22. package/dist/index.d.ts +35 -0
  23. package/dist/index.d.ts.map +1 -0
  24. package/dist/index.js +28 -1
  25. package/dist/index.js.map +1 -0
  26. package/dist/logger/export.d.ts +2 -0
  27. package/dist/logger/export.d.ts.map +1 -0
  28. package/dist/logger/export.js +1 -0
  29. package/dist/logger/export.js.map +1 -0
  30. package/dist/matter/behaviors.d.ts +2 -0
  31. package/dist/matter/behaviors.d.ts.map +1 -0
  32. package/dist/matter/behaviors.js +2 -0
  33. package/dist/matter/behaviors.js.map +1 -0
  34. package/dist/matter/clusters.d.ts +2 -0
  35. package/dist/matter/clusters.d.ts.map +1 -0
  36. package/dist/matter/clusters.js +2 -0
  37. package/dist/matter/clusters.js.map +1 -0
  38. package/dist/matter/devices.d.ts +2 -0
  39. package/dist/matter/devices.d.ts.map +1 -0
  40. package/dist/matter/devices.js +2 -0
  41. package/dist/matter/devices.js.map +1 -0
  42. package/dist/matter/endpoints.d.ts +2 -0
  43. package/dist/matter/endpoints.d.ts.map +1 -0
  44. package/dist/matter/endpoints.js +2 -0
  45. package/dist/matter/endpoints.js.map +1 -0
  46. package/dist/matter/export.d.ts +5 -0
  47. package/dist/matter/export.d.ts.map +1 -0
  48. package/dist/matter/export.js +2 -0
  49. package/dist/matter/export.js.map +1 -0
  50. package/dist/matter/types.d.ts +3 -0
  51. package/dist/matter/types.d.ts.map +1 -0
  52. package/dist/matter/types.js +2 -0
  53. package/dist/matter/types.js.map +1 -0
  54. package/dist/matterbridge.d.ts +422 -0
  55. package/dist/matterbridge.d.ts.map +1 -0
  56. package/dist/matterbridge.js +743 -46
  57. package/dist/matterbridge.js.map +1 -0
  58. package/dist/matterbridgeAccessoryPlatform.d.ts +39 -0
  59. package/dist/matterbridgeAccessoryPlatform.d.ts.map +1 -0
  60. package/dist/matterbridgeAccessoryPlatform.js +33 -0
  61. package/dist/matterbridgeAccessoryPlatform.js.map +1 -0
  62. package/dist/matterbridgeBehaviors.d.ts +1056 -0
  63. package/dist/matterbridgeBehaviors.d.ts.map +1 -0
  64. package/dist/matterbridgeBehaviors.js +32 -1
  65. package/dist/matterbridgeBehaviors.js.map +1 -0
  66. package/dist/matterbridgeDeviceTypes.d.ts +177 -0
  67. package/dist/matterbridgeDeviceTypes.d.ts.map +1 -0
  68. package/dist/matterbridgeDeviceTypes.js +112 -11
  69. package/dist/matterbridgeDeviceTypes.js.map +1 -0
  70. package/dist/matterbridgeDynamicPlatform.d.ts +39 -0
  71. package/dist/matterbridgeDynamicPlatform.d.ts.map +1 -0
  72. package/dist/matterbridgeDynamicPlatform.js +33 -0
  73. package/dist/matterbridgeDynamicPlatform.js.map +1 -0
  74. package/dist/matterbridgeEndpoint.d.ts +835 -0
  75. package/dist/matterbridgeEndpoint.d.ts.map +1 -0
  76. package/dist/matterbridgeEndpoint.js +690 -6
  77. package/dist/matterbridgeEndpoint.js.map +1 -0
  78. package/dist/matterbridgeEndpointHelpers.d.ts +2275 -0
  79. package/dist/matterbridgeEndpointHelpers.d.ts.map +1 -0
  80. package/dist/matterbridgeEndpointHelpers.js +118 -9
  81. package/dist/matterbridgeEndpointHelpers.js.map +1 -0
  82. package/dist/matterbridgePlatform.d.ts +278 -0
  83. package/dist/matterbridgePlatform.d.ts.map +1 -0
  84. package/dist/matterbridgePlatform.js +210 -7
  85. package/dist/matterbridgePlatform.js.map +1 -0
  86. package/dist/matterbridgeTypes.d.ts +178 -0
  87. package/dist/matterbridgeTypes.d.ts.map +1 -0
  88. package/dist/matterbridgeTypes.js +24 -0
  89. package/dist/matterbridgeTypes.js.map +1 -0
  90. package/dist/pluginManager.d.ts +236 -0
  91. package/dist/pluginManager.d.ts.map +1 -0
  92. package/dist/pluginManager.js +229 -3
  93. package/dist/pluginManager.js.map +1 -0
  94. package/dist/shelly.d.ts +77 -0
  95. package/dist/shelly.d.ts.map +1 -0
  96. package/dist/shelly.js +121 -6
  97. package/dist/shelly.js.map +1 -0
  98. package/dist/storage/export.d.ts +2 -0
  99. package/dist/storage/export.d.ts.map +1 -0
  100. package/dist/storage/export.js +1 -0
  101. package/dist/storage/export.js.map +1 -0
  102. package/dist/update.d.ts +32 -0
  103. package/dist/update.d.ts.map +1 -0
  104. package/dist/update.js +45 -0
  105. package/dist/update.js.map +1 -0
  106. package/dist/utils/colorUtils.d.ts +61 -0
  107. package/dist/utils/colorUtils.d.ts.map +1 -0
  108. package/dist/utils/colorUtils.js +205 -2
  109. package/dist/utils/colorUtils.js.map +1 -0
  110. package/dist/utils/copyDirectory.d.ts +32 -0
  111. package/dist/utils/copyDirectory.d.ts.map +1 -0
  112. package/dist/utils/copyDirectory.js +37 -1
  113. package/dist/utils/copyDirectory.js.map +1 -0
  114. package/dist/utils/createZip.d.ts +38 -0
  115. package/dist/utils/createZip.d.ts.map +1 -0
  116. package/dist/utils/createZip.js +42 -2
  117. package/dist/utils/createZip.js.map +1 -0
  118. package/dist/utils/deepCopy.d.ts +31 -0
  119. package/dist/utils/deepCopy.d.ts.map +1 -0
  120. package/dist/utils/deepCopy.js +40 -0
  121. package/dist/utils/deepCopy.js.map +1 -0
  122. package/dist/utils/deepEqual.d.ts +53 -0
  123. package/dist/utils/deepEqual.d.ts.map +1 -0
  124. package/dist/utils/deepEqual.js +65 -1
  125. package/dist/utils/deepEqual.js.map +1 -0
  126. package/dist/utils/export.d.ts +10 -0
  127. package/dist/utils/export.d.ts.map +1 -0
  128. package/dist/utils/export.js +1 -0
  129. package/dist/utils/export.js.map +1 -0
  130. package/dist/utils/isvalid.d.ts +87 -0
  131. package/dist/utils/isvalid.d.ts.map +1 -0
  132. package/dist/utils/isvalid.js +86 -0
  133. package/dist/utils/isvalid.js.map +1 -0
  134. package/dist/utils/network.d.ts +70 -0
  135. package/dist/utils/network.d.ts.map +1 -0
  136. package/dist/utils/network.js +77 -5
  137. package/dist/utils/network.js.map +1 -0
  138. package/dist/utils/parameter.d.ts +44 -0
  139. package/dist/utils/parameter.d.ts.map +1 -0
  140. package/dist/utils/parameter.js +41 -0
  141. package/dist/utils/parameter.js.map +1 -0
  142. package/dist/utils/wait.d.ts +43 -0
  143. package/dist/utils/wait.d.ts.map +1 -0
  144. package/dist/utils/wait.js +48 -5
  145. package/dist/utils/wait.js.map +1 -0
  146. package/frontend/build/asset-manifest.json +3 -3
  147. package/frontend/build/index.html +1 -1
  148. package/frontend/build/static/js/{main.839276c2.js → main.66936fef.js} +3 -3
  149. package/frontend/build/static/js/{main.839276c2.js.map → main.66936fef.js.map} +1 -1
  150. package/npm-shrinkwrap.json +2 -2
  151. package/package.json +2 -1
  152. /package/frontend/build/static/js/{main.839276c2.js.LICENSE.txt → main.66936fef.js.LICENSE.txt} +0 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"matterbridgePlatform.d.ts","sourceRoot":"","sources":["../src/matterbridgePlatform.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAKjE,OAAO,EAAE,UAAU,EAAgB,QAAQ,EAAU,MAAM,oBAAoB,CAAC;AAGhF,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAStE,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;AAEjG,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEjE,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;IACf,oBAAoB,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;AAEjG,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEjE;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B,YAAY,EAAE,YAAY,CAAC;IAC3B,GAAG,EAAE,UAAU,CAAC;IAChB,MAAM,EAAE,cAAc,CAAM;IAC5B,IAAI,SAAM;IACV,IAAI,SAAM;IACV,OAAO,SAAW;IAGlB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,OAAO,CAAC,EAAE,WAAW,CAAC;IAGtB,QAAQ,CAAC,YAAY;gBAA6B,MAAM;cAAQ,MAAM;oBAAc,MAAM;eAAS,MAAM;mBAAa;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE;OAAM;IAClL,QAAQ,CAAC,YAAY;cAA2B,MAAM;qBAAe,MAAM;eAAS,MAAM;OAAM;IAGhG,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,yBAAyB,CAAgB;IACjD,OAAO,CAAC,yBAAyB,CAAgB;IACjD,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAGrB,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA2C;IAChF,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAA2C;IAGtF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+F;IAE9H;;;;;OAKG;gBACS,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc;IA8C/E;;;;;;OAMG;IACG,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;IAK7B;;;;OAIG;IACG,WAAW;IAUjB;;;;;OAKG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM;IAsBhC;;;OAGG;IACG,mBAAmB,CAAC,QAAQ,EAAE,QAAQ;IAI5C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM;IAI1D;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,cAAc;IAI5C;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAI1C;;;OAGG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB;IAcjD;;;OAGG;IACG,gBAAgB,CAAC,MAAM,EAAE,oBAAoB;IAMnD;;OAEG;IACG,oBAAoB;IAM1B;;;;;;;OAOG;YACW,WAAW;IAczB;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAMlC;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,IAAI;IAazJ;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI;IAQ/G;;;;OAIG;IACH,gBAAgB,IAAI;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,EAAE;IAQhL;;;;;;;OAOG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAIvE;;;;OAIG;IACH,iBAAiB,IAAI;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE;IAQ/F;;;;OAIG;IACH,yBAAyB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO;IAwB3D;;OAEG;IACH,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,UAAO,GAAG,OAAO;IAI5E;;;;;;;;OAQG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,GAAG,UAAO,GAAG,OAAO;IAuB9D;;OAEG;IACH,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAO,GAAG,OAAO;IAI5E;;;;;;;;OAQG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAO,GAAG,OAAO;IAgBnE;;;;;;;;OAQG;IACG,oBAAoB;CAsC3B"}
@@ -1,30 +1,71 @@
1
+ /**
2
+ * This file contains the class MatterbridgeAccessoryPlatform.
3
+ *
4
+ * @file matterbridgePlatform.ts
5
+ * @author Luca Liguori
6
+ * @date 2024-03-21
7
+ * @version 1.1.0
8
+ *
9
+ * Copyright 2024, 2025, 2026 Luca Liguori.
10
+ *
11
+ * Licensed under the Apache License, Version 2.0 (the "License");
12
+ * you may not use this file except in compliance with the License.
13
+ * You may obtain a copy of the License at
14
+ *
15
+ * http://www.apache.org/licenses/LICENSE-2.0
16
+ *
17
+ * Unless required by applicable law or agreed to in writing, software
18
+ * distributed under the License is distributed on an "AS IS" BASIS,
19
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
+ * See the License for the specific language governing permissions and
21
+ * limitations under the License. *
22
+ */
1
23
  import { checkNotLatinCharacters } from './matterbridgeEndpointHelpers.js';
2
24
  import { isValidArray, isValidObject, isValidString } from './utils/export.js';
25
+ // AnsiLogger module
3
26
  import { CYAN, db, er, nf, wr } from './logger/export.js';
27
+ // Storage module
4
28
  import { NodeStorageManager } from './storage/export.js';
29
+ // Node.js module
5
30
  import path from 'node:path';
31
+ /**
32
+ * Represents the base Matterbridge platform. It is extended by the MatterbridgeAccessoryPlatform and MatterbridgeServicePlatform classes.
33
+ *
34
+ */
6
35
  export class MatterbridgePlatform {
7
36
  matterbridge;
8
37
  log;
9
38
  config = {};
10
- name = '';
11
- type = '';
12
- version = '1.0.0';
39
+ name = ''; // Will be set by the loadPlugin() method using the package.json value.
40
+ type = ''; // Will be set by the extending classes.
41
+ version = '1.0.0'; // Will be set by the loadPlugin() method using the package.json value.
42
+ // Platform storage
13
43
  storage;
14
44
  context;
45
+ // Device and entity selection
15
46
  selectDevice = new Map();
16
47
  selectEntity = new Map();
48
+ // Promises for storage
17
49
  _contextReady;
18
50
  _selectDeviceContextReady;
19
51
  _selectEntityContextReady;
20
52
  ready;
21
- _registeredEndpoints = new Map();
22
- _registeredEndpointsByName = new Map();
23
- _storedDevices = new Map();
53
+ // Registered devices
54
+ _registeredEndpoints = new Map(); // uniqueId, MatterbridgeEndpoint
55
+ _registeredEndpointsByName = new Map(); // deviceName, MatterbridgeEndpoint
56
+ // Stored devices
57
+ _storedDevices = new Map(); // serial, { serial, name }
58
+ /**
59
+ * Creates an instance of the base MatterbridgePlatform. It is extended by the MatterbridgeAccessoryPlatform and MatterbridgeServicePlatform classes.
60
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
61
+ * @param {AnsiLogger} log - The logger instance.
62
+ * @param {PlatformConfig} config - The platform configuration.
63
+ */
24
64
  constructor(matterbridge, log, config) {
25
65
  this.matterbridge = matterbridge;
26
66
  this.log = log;
27
67
  this.config = config;
68
+ // create the NodeStorageManager for the plugin platform
28
69
  if (!isValidString(this.config.name) || this.config.name === '')
29
70
  throw new Error('Platform: the plugin name is missing or invalid.');
30
71
  this.log.debug(`Creating storage for plugin ${this.config.name} in ${path.join(this.matterbridge.matterbridgeDirectory, this.config.name)}`);
@@ -35,12 +76,14 @@ export class MatterbridgePlatform {
35
76
  logging: false,
36
77
  forgiveParseErrors: true,
37
78
  });
79
+ // create the context storage for the plugin platform
38
80
  this.log.debug(`Creating context for plugin ${this.config.name}`);
39
81
  this._contextReady = this.storage.createStorage('context').then((context) => {
40
82
  this.context = context;
41
- this.context.remove('endpointMap');
83
+ this.context.remove('endpointMap'); // Remove the old endpointMap TODO: remove in future versions
42
84
  this.log.debug(`Created context for plugin ${this.config.name}`);
43
85
  });
86
+ // create the selectDevice storage for the plugin platform
44
87
  this.log.debug(`Loading selectDevice for plugin ${this.config.name}`);
45
88
  this._selectDeviceContextReady = this.storage.createStorage('selectDevice').then(async (context) => {
46
89
  const selectDevice = await context.get('selectDevice', []);
@@ -48,6 +91,7 @@ export class MatterbridgePlatform {
48
91
  this.selectDevice.set(device.serial, device);
49
92
  this.log.debug(`Loaded ${this.selectDevice.size} selectDevice for plugin ${this.config.name}`);
50
93
  });
94
+ // create the selectEntity storage for the plugin platform
51
95
  this.log.debug(`Loading selectEntity for plugin ${this.config.name}`);
52
96
  this._selectEntityContextReady = this.storage.createStorage('selectEntity').then(async (context) => {
53
97
  const selectEntity = await context.get('selectEntity', []);
@@ -55,44 +99,107 @@ export class MatterbridgePlatform {
55
99
  this.selectEntity.set(entity.name, entity);
56
100
  this.log.debug(`Loaded ${this.selectEntity.size} selectEntity for plugin ${this.config.name}`);
57
101
  });
102
+ // Create the `ready` promise for the platform
58
103
  this.ready = Promise.all([this._contextReady, this._selectDeviceContextReady, this._selectEntityContextReady]).then(() => {
59
104
  this.log.debug(`MatterbridgePlatform for plugin ${this.config.name} is fully initialized`);
60
105
  });
61
106
  }
107
+ /**
108
+ * This method must be overridden in the extended class.
109
+ * It is called when the platform is started.
110
+ * Use this method to create the MatterbridgeDevice and call this.registerDevice().
111
+ * @param {string} [reason] - The reason for starting.
112
+ * @throws {Error} - Throws an error if the method is not overridden.
113
+ */
62
114
  async onStart(reason) {
63
115
  this.log.error('Plugins must override onStart.', reason);
64
116
  throw new Error('Plugins must override onStart.');
65
117
  }
118
+ /**
119
+ * This method can be overridden in the extended class. Call super.onConfigure() to run checkEndpointNumbers().
120
+ * It is called after the platform has started.
121
+ * Use this method to perform any configuration of your devices.
122
+ */
66
123
  async onConfigure() {
67
124
  this.log.debug(`Configuring platform ${this.name}`);
125
+ // Save the selectDevice and selectEntity
68
126
  await this.saveSelects();
127
+ // Check and update the endpoint numbers
69
128
  await this.checkEndpointNumbers();
70
129
  }
130
+ /**
131
+ * 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.
132
+ * It is called when the platform is shutting down.
133
+ * Use this method to clean up any resources.
134
+ * @param {string} [reason] - The reason for shutting down.
135
+ */
71
136
  async onShutdown(reason) {
72
137
  this.log.debug(`Shutting down platform ${this.name}`, reason);
138
+ // Save the selectDevice and selectEntity
73
139
  await this.saveSelects();
140
+ // Check and update the endpoint numbers
74
141
  await this.checkEndpointNumbers();
142
+ // Cleanup memory
75
143
  this.selectDevice.clear();
76
144
  this.selectEntity.clear();
77
145
  this._registeredEndpoints.clear();
78
146
  this._registeredEndpointsByName.clear();
79
147
  this._storedDevices.clear();
148
+ // Close the storage
80
149
  await this.context?.close();
81
150
  this.context = undefined;
82
151
  await this.storage?.close();
83
152
  }
153
+ /**
154
+ * Sets the logger level and logs a debug message indicating that the plugin doesn't override this method.
155
+ * @param {LogLevel} logLevel The new logger level.
156
+ */
84
157
  async onChangeLoggerLevel(logLevel) {
85
158
  this.log.debug(`The plugin doesn't override onChangeLoggerLevel. Logger level set to: ${logLevel}`);
86
159
  }
160
+ /**
161
+ * Called when a plugin config includes an action button or an action button with text field.
162
+ * @param {string} action The action triggered by the button in plugin config.
163
+ * @param {string} value The value of the field of the action button.
164
+ * @param {string} id The id of the schema associated with the action.
165
+ *
166
+ * @remarks
167
+ * This method can be overridden in the extended class.
168
+ *
169
+ * Use this method to handle the action defined in the plugin schema:
170
+ * "addDevice": {
171
+ * "description": "Manually add a device that has not been discovered with mdns:",
172
+ * "type": "boolean",
173
+ * "buttonText": "ADD", // The text on the button.
174
+ * "buttonField": "ADD", // The text on the button. This is used when the action includes a text field.
175
+ * "buttonClose": false, // optional, default is false. When true, the dialog will close after the action is sent.
176
+ * "buttonSave": false, // optional, default is false. When true, the dialog will close and trigger the restart required after the action is sent.
177
+ * "textPlaceholder": "Enter the device IP address", // optional: the placeholder text for the text field.
178
+ * "default": false
179
+ * },
180
+ */
87
181
  async onAction(action, value, id) {
88
182
  this.log.debug(`The plugin doesn't override onAction. Received action ${CYAN}${action}${db}${value ? ' with ' + CYAN + value + db : ''} ${id ? ' for schema ' + CYAN + id + db : ''}`);
89
183
  }
184
+ /**
185
+ * Called when the plugin config has been updated.
186
+ * @param {PlatformConfig} config The new plugin config.
187
+ */
90
188
  async onConfigChanged(config) {
91
189
  this.log.debug(`The plugin ${CYAN}${config.name}${db} doesn't override onConfigChanged. Received new config.`);
92
190
  }
191
+ /**
192
+ * Check if a device with this name is already registered in the platform.
193
+ * @param {string} deviceName - The device name to check.
194
+ * @returns {boolean} True if the device is already registered, false otherwise.
195
+ */
93
196
  hasDeviceName(deviceName) {
94
197
  return this._registeredEndpointsByName.has(deviceName);
95
198
  }
199
+ /**
200
+ * Registers a device with the Matterbridge platform.
201
+ * @param {MatterbridgeEndpoint} device - The device to register.
202
+ */
96
203
  async registerDevice(device) {
97
204
  device.plugin = this.name;
98
205
  if (device.deviceName && this._registeredEndpointsByName.has(device.deviceName)) {
@@ -108,6 +215,10 @@ export class MatterbridgePlatform {
108
215
  if (device.deviceName)
109
216
  this._registeredEndpointsByName.set(device.deviceName, device);
110
217
  }
218
+ /**
219
+ * Unregisters a device registered with the Matterbridge platform.
220
+ * @param {MatterbridgeEndpoint} device - The device to unregister.
221
+ */
111
222
  async unregisterDevice(device) {
112
223
  await this.matterbridge.removeBridgedEndpoint(this.name, device);
113
224
  if (device.uniqueId)
@@ -115,11 +226,22 @@ export class MatterbridgePlatform {
115
226
  if (device.deviceName)
116
227
  this._registeredEndpointsByName.delete(device.deviceName);
117
228
  }
229
+ /**
230
+ * Unregisters all devices registered with the Matterbridge platform.
231
+ */
118
232
  async unregisterAllDevices() {
119
233
  await this.matterbridge.removeAllBridgedEndpoints(this.name);
120
234
  this._registeredEndpoints.clear();
121
235
  this._registeredEndpointsByName.clear();
122
236
  }
237
+ /**
238
+ * Saves the select devices and entities to storage.
239
+ *
240
+ * This method saves the current state of `selectDevice` and `selectEntity` maps to their respective storage.
241
+ * It logs the number of items being saved and ensures that the storage is properly closed after saving.
242
+ *
243
+ * @returns {Promise<void>} A promise that resolves when the save operation is complete.
244
+ */
123
245
  async saveSelects() {
124
246
  if (this.storage) {
125
247
  this.log.debug(`Saving ${this.selectDevice.size} selectDevice...`);
@@ -132,11 +254,26 @@ export class MatterbridgePlatform {
132
254
  await selectEntity.close();
133
255
  }
134
256
  }
257
+ /**
258
+ * Clears the select device and entity maps.
259
+ *
260
+ * @returns {void}
261
+ */
135
262
  async clearSelect() {
136
263
  this.selectDevice.clear();
137
264
  this.selectEntity.clear();
138
265
  await this.saveSelects();
139
266
  }
267
+ /**
268
+ * Set the select device in the platform map.
269
+ *
270
+ * @param {string} serial - The serial number of the device.
271
+ * @param {string} name - The name of the device.
272
+ * @param {string} [configUrl] - The configuration URL of the device.
273
+ * @param {string} [icon] - The icon of the device.
274
+ * @param {Array<{ name: string; description: string; icon?: string }>} [entities] - The entities associated with the device.
275
+ * @returns {void}
276
+ */
140
277
  setSelectDevice(serial, name, configUrl, icon, entities) {
141
278
  const device = this.selectDevice.get(serial);
142
279
  if (device) {
@@ -153,6 +290,15 @@ export class MatterbridgePlatform {
153
290
  this.selectDevice.set(serial, { serial, name, configUrl, icon, entities });
154
291
  }
155
292
  }
293
+ /**
294
+ * Set the select device entity in the platform map.
295
+ *
296
+ * @param {string} serial - The serial number of the device.
297
+ * @param {string} entityName - The name of the entity.
298
+ * @param {string} entityDescription - The description of the entity.
299
+ * @param {string} [entityIcon] - The icon of the entity.
300
+ * @returns {void}
301
+ */
156
302
  setSelectDeviceEntity(serial, entityName, entityDescription, entityIcon) {
157
303
  const device = this.selectDevice.get(serial);
158
304
  if (device) {
@@ -162,6 +308,11 @@ export class MatterbridgePlatform {
162
308
  device.entities.push({ name: entityName, description: entityDescription, icon: entityIcon });
163
309
  }
164
310
  }
311
+ /**
312
+ * Retrieves the select devices from the platform map.
313
+ *
314
+ * @returns {{ pluginName: string; serial: string; name: string; configUrl?: string; icon?: string; entities?: { name: string; description: string; icon?: string }[] }[]} The selected devices array.
315
+ */
165
316
  getSelectDevices() {
166
317
  const selectDevices = [];
167
318
  this.selectDevice.values().forEach((device) => {
@@ -169,9 +320,22 @@ export class MatterbridgePlatform {
169
320
  });
170
321
  return selectDevices;
171
322
  }
323
+ /**
324
+ * Set the select entity in the platform map.
325
+ *
326
+ * @param {string} name - The entity name.
327
+ * @param {string} description - The entity description.
328
+ * @param {string} [icon] - The entity icon.
329
+ * @returns {void}
330
+ */
172
331
  setSelectEntity(name, description, icon) {
173
332
  this.selectEntity.set(name, { name, description, icon });
174
333
  }
334
+ /**
335
+ * Retrieve the select entities.
336
+ *
337
+ * @returns {{ pluginName: string; name: string; description: string; icon?: string }[]} The select entities array.
338
+ */
175
339
  getSelectEntities() {
176
340
  const selectEntities = [];
177
341
  this.selectEntity.values().forEach((entity) => {
@@ -179,6 +343,11 @@ export class MatterbridgePlatform {
179
343
  });
180
344
  return selectEntities;
181
345
  }
346
+ /**
347
+ * Verifies if the Matterbridge version meets the required version.
348
+ * @param {string} requiredVersion - The required version to compare against.
349
+ * @returns {boolean} True if the Matterbridge version meets or exceeds the required version, false otherwise.
350
+ */
182
351
  verifyMatterbridgeVersion(requiredVersion) {
183
352
  const compareVersions = (matterbridgeVersion, requiredVersion) => {
184
353
  const stripTag = (v) => {
@@ -203,9 +372,21 @@ export class MatterbridgePlatform {
203
372
  return false;
204
373
  return true;
205
374
  }
375
+ /**
376
+ * @deprecated This method is deprecated and will be removed in future versions. Use validateDevice instead.
377
+ */
206
378
  validateDeviceWhiteBlackList(device, log = true) {
207
379
  return this.validateDevice(device, log);
208
380
  }
381
+ /**
382
+ * Validates if a device is allowed based on the whitelist and blacklist configurations.
383
+ * The blacklist has priority over the whitelist.
384
+ *
385
+ * @param {string | string[]} device - The device name(s) to validate.
386
+ * @param {boolean} [log=true] - Whether to log the validation result.
387
+ * @returns {boolean} - Returns true if the device is allowed, false otherwise.
388
+ *
389
+ */
209
390
  validateDevice(device, log = true) {
210
391
  if (!Array.isArray(device))
211
392
  device = [device];
@@ -235,9 +416,21 @@ export class MatterbridgePlatform {
235
416
  this.log.info(`Skipping device ${CYAN}${device.join(', ')}${nf} because not in whitelist`);
236
417
  return false;
237
418
  }
419
+ /**
420
+ * @deprecated This method is deprecated and will be removed in future versions. Use validateEntity instead.
421
+ */
238
422
  validateEntityBlackList(device, entity, log = true) {
239
423
  return this.validateEntity(device, entity, log);
240
424
  }
425
+ /**
426
+ * Validates if an entity is allowed based on the entity blacklist and device-entity blacklist configurations.
427
+ *
428
+ * @param {string} device - The device to which the entity belongs.
429
+ * @param {string} entity - The entity to validate.
430
+ * @param {boolean} [log=true] - Whether to log the validation result.
431
+ * @returns {boolean} - Returns true if the entity is allowed, false otherwise.
432
+ *
433
+ */
241
434
  validateEntity(device, entity, log = true) {
242
435
  if (isValidArray(this.config.entityBlackList, 1) && this.config.entityBlackList.find((e) => e === entity)) {
243
436
  if (log)
@@ -256,6 +449,15 @@ export class MatterbridgePlatform {
256
449
  }
257
450
  return true;
258
451
  }
452
+ /**
453
+ * Checks and updates the endpoint numbers for Matterbridge devices.
454
+ *
455
+ * This method retrieves the list of Matterbridge devices and their child endpoints,
456
+ * compares their current endpoint numbers with the stored ones, and updates the storage
457
+ * if there are any changes. It logs the changes and updates the endpoint numbers accordingly.
458
+ *
459
+ * @returns {Promise<number>} The size of the updated endpoint map, or -1 if storage is not available.
460
+ */
259
461
  async checkEndpointNumbers() {
260
462
  if (!this.storage)
261
463
  return -1;
@@ -296,3 +498,4 @@ export class MatterbridgePlatform {
296
498
  return endpointMap.size;
297
499
  }
298
500
  }
501
+ //# sourceMappingURL=matterbridgePlatform.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"matterbridgePlatform.js","sourceRoot":"","sources":["../src/matterbridgePlatform.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAE/E,oBAAoB;AACpB,OAAO,EAAc,IAAI,EAAE,EAAE,EAAE,EAAE,EAAY,EAAE,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAEhF,iBAAiB;AACjB,OAAO,EAAe,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAKtE,iBAAiB;AACjB,OAAO,IAAI,MAAM,WAAW,CAAC;AAqB7B;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAC/B,YAAY,CAAe;IAC3B,GAAG,CAAa;IAChB,MAAM,GAAmB,EAAE,CAAC;IAC5B,IAAI,GAAG,EAAE,CAAC,CAAC,uEAAuE;IAClF,IAAI,GAAG,EAAE,CAAC,CAAC,wCAAwC;IACnD,OAAO,GAAG,OAAO,CAAC,CAAC,uEAAuE;IAE1F,mBAAmB;IACnB,OAAO,CAAqB;IAC5B,OAAO,CAAe;IAEtB,8BAA8B;IACrB,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,KAAK,CAAgB;IAErB,qBAAqB;IACJ,oBAAoB,GAAG,IAAI,GAAG,EAAgC,CAAC,CAAC,iCAAiC;IACjG,0BAA0B,GAAG,IAAI,GAAG,EAAgC,CAAC,CAAC,mCAAmC;IAE1H,iBAAiB;IACA,cAAc,GAAG,IAAI,GAAG,EAAoF,CAAC,CAAC,2BAA2B;IAE1J;;;;;OAKG;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,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACrI,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,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,6DAA6D;YACjG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,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;QACjG,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;QACjG,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;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;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;;;;OAIG;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;;;;;OAKG;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;QACxC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,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;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,QAAkB;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yEAAyE,QAAQ,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAc,EAAE,KAAc,EAAE,EAAW;QACxD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yDAAyD,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,CAAC,CAAC;IACzL,CAAC;IAED;;;OAGG;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,aAAa,CAAC,UAAkB;QAC9B,OAAO,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;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;;;OAGG;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;;OAEG;IACH,KAAK,CAAC,oBAAoB;QACxB,MAAM,IAAI,CAAC,YAAY,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,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;;;;;;;;;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,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC5C,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QACH,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,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC5C,cAAc,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;OAIG;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;;OAEG;IACH,4BAA4B,CAAC,MAAyB,EAAE,GAAG,GAAG,IAAI;QAChE,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;OAQG;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;;OAEG;IACH,uBAAuB,CAAC,MAAc,EAAE,MAAc,EAAE,GAAG,GAAG,IAAI;QAChE,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;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,178 @@
1
+ /**
2
+ * This file contains the types for Matterbridge.
3
+ *
4
+ * @file matterbridgeTypes.ts
5
+ * @author Luca Liguori
6
+ * @date 2024-07-12
7
+ * @version 1.0.2
8
+ *
9
+ * Copyright 2023, 2024, 2025 Luca Liguori.
10
+ *
11
+ * Licensed under the Apache License, Version 2.0 (the "License");
12
+ * you may not use this file except in compliance with the License.
13
+ * You may obtain a copy of the License at
14
+ *
15
+ * http://www.apache.org/licenses/LICENSE-2.0
16
+ *
17
+ * Unless required by applicable law or agreed to in writing, software
18
+ * distributed under the License is distributed on an "AS IS" BASIS,
19
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
+ * See the License for the specific language governing permissions and
21
+ * limitations under the License. *
22
+ */
23
+ import { NodeStorage } from './storage/export.js';
24
+ import { LogLevel } from './logger/export.js';
25
+ import { MatterbridgePlatform, PlatformConfig, PlatformSchema } from './matterbridgePlatform.js';
26
+ import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
27
+ import { FabricIndex, NodeId, VendorId, StorageContext, ServerNode, EndpointNumber, Endpoint as EndpointNode } from '@matter/main';
28
+ import { ExposedFabricInformation } from '@matter/main/protocol';
29
+ import { AggregatorEndpoint } from '@matter/main/endpoints/aggregator';
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
+ locked?: boolean;
51
+ error?: boolean;
52
+ enabled?: boolean;
53
+ loaded?: boolean;
54
+ started?: boolean;
55
+ configured?: boolean;
56
+ paired?: boolean;
57
+ restartRequired?: boolean;
58
+ fabricInformations?: SanitizedExposedFabricInformation[];
59
+ sessionInformations?: SanitizedSessionInformation[];
60
+ registeredDevices?: number;
61
+ addedDevices?: number;
62
+ qrPairingCode?: string;
63
+ manualPairingCode?: string;
64
+ configJson?: PlatformConfig;
65
+ schemaJson?: PlatformSchema;
66
+ hasWhiteList?: boolean;
67
+ hasBlackList?: boolean;
68
+ }
69
+ export interface SystemInformation {
70
+ interfaceName: string;
71
+ macAddress: string;
72
+ ipv4Address: string;
73
+ ipv6Address: string;
74
+ nodeVersion: string;
75
+ hostname: string;
76
+ user: string;
77
+ osType: string;
78
+ osRelease: string;
79
+ osPlatform: string;
80
+ osArch: string;
81
+ totalMemory: string;
82
+ freeMemory: string;
83
+ systemUptime: string;
84
+ processUptime: string;
85
+ cpuUsage: string;
86
+ rss: string;
87
+ heapTotal: string;
88
+ heapUsed: string;
89
+ }
90
+ export interface MatterbridgeInformation {
91
+ homeDirectory: string;
92
+ rootDirectory: string;
93
+ matterbridgeDirectory: string;
94
+ matterbridgePluginDirectory: string;
95
+ globalModulesDirectory: string;
96
+ matterbridgeVersion: string;
97
+ matterbridgeLatestVersion: string;
98
+ matterbridgeQrPairingCode: string | undefined;
99
+ matterbridgeManualPairingCode: string | undefined;
100
+ matterbridgeFabricInformations: SanitizedExposedFabricInformation[] | undefined;
101
+ matterbridgeSessionInformations: SanitizedSessionInformation[] | undefined;
102
+ matterbridgePaired: boolean | undefined;
103
+ matterbridgeAdvertise: boolean | undefined;
104
+ bridgeMode: string;
105
+ restartMode: string;
106
+ readOnly: boolean;
107
+ shellyBoard: boolean;
108
+ shellySysUpdate: boolean;
109
+ shellyMainUpdate: boolean;
110
+ profile?: string;
111
+ loggerLevel: LogLevel;
112
+ fileLogger: boolean;
113
+ matterLoggerLevel: number;
114
+ matterFileLogger: boolean;
115
+ mattermdnsinterface: string | undefined;
116
+ matteripv4address: string | undefined;
117
+ matteripv6address: string | undefined;
118
+ matterPort: number;
119
+ matterDiscriminator: number | undefined;
120
+ matterPasscode: number | undefined;
121
+ restartRequired: boolean;
122
+ updateRequired: boolean;
123
+ }
124
+ export interface SanitizedExposedFabricInformation {
125
+ fabricIndex: FabricIndex;
126
+ fabricId: string;
127
+ nodeId: string;
128
+ rootNodeId: string;
129
+ rootVendorId: VendorId;
130
+ rootVendorName: string;
131
+ label: string;
132
+ }
133
+ export interface SessionInformation {
134
+ name: string;
135
+ nodeId: NodeId;
136
+ peerNodeId: NodeId;
137
+ fabric?: ExposedFabricInformation;
138
+ isPeerActive: boolean;
139
+ secure: boolean;
140
+ lastInteractionTimestamp?: number;
141
+ lastActiveTimestamp?: number;
142
+ numberOfActiveSubscriptions: number;
143
+ }
144
+ export interface SanitizedSessionInformation {
145
+ name: string;
146
+ nodeId: string;
147
+ peerNodeId: string;
148
+ fabric?: SanitizedExposedFabricInformation;
149
+ isPeerActive: boolean;
150
+ secure: 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
+ cluster: string;
166
+ }
167
+ export interface ApiClusters {
168
+ endpoint: string;
169
+ id: string;
170
+ deviceTypes: number[];
171
+ clusterName: string;
172
+ clusterId: string;
173
+ attributeName: string;
174
+ attributeId: string;
175
+ attributeValue: string;
176
+ attributeLocalValue: unknown;
177
+ }
178
+ //# sourceMappingURL=matterbridgeTypes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"matterbridgeTypes.d.ts","sourceRoot":"","sources":["../src/matterbridgeTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG9C,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAGjE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,cAAc,CAAC;AACnI,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAGvE,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,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,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kBAAkB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IACzD,mBAAmB,CAAC,EAAE,2BAA2B,EAAE,CAAC;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,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,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,sBAAsB,EAAE,MAAM,CAAC;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,yBAAyB,EAAE,MAAM,CAAC;IAClC,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,2BAA2B,EAAE,GAAG,SAAS,CAAC;IAC3E,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,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,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,OAAO,CAAC;IAChB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,2BAA2B;IAC1C,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,MAAM,EAAE,OAAO,CAAC;IAChB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,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,OAAO,EAAE,MAAM,CAAC;CACjB;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"}
@@ -1,3 +1,27 @@
1
+ /**
2
+ * This file contains the types for Matterbridge.
3
+ *
4
+ * @file matterbridgeTypes.ts
5
+ * @author Luca Liguori
6
+ * @date 2024-07-12
7
+ * @version 1.0.2
8
+ *
9
+ * Copyright 2023, 2024, 2025 Luca Liguori.
10
+ *
11
+ * Licensed under the Apache License, Version 2.0 (the "License");
12
+ * you may not use this file except in compliance with the License.
13
+ * You may obtain a copy of the License at
14
+ *
15
+ * http://www.apache.org/licenses/LICENSE-2.0
16
+ *
17
+ * Unless required by applicable law or agreed to in writing, software
18
+ * distributed under the License is distributed on an "AS IS" BASIS,
19
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
+ * See the License for the specific language governing permissions and
21
+ * limitations under the License. *
22
+ */
23
+ // Default colors
1
24
  export const plg = '\u001B[38;5;33m';
2
25
  export const dev = '\u001B[38;5;79m';
3
26
  export const typ = '\u001B[38;5;207m';
27
+ //# sourceMappingURL=matterbridgeTypes.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"matterbridgeTypes.js","sourceRoot":"","sources":["../src/matterbridgeTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAeH,iBAAiB;AACjB,MAAM,CAAC,MAAM,GAAG,GAAG,iBAAiB,CAAC;AACrC,MAAM,CAAC,MAAM,GAAG,GAAG,iBAAiB,CAAC;AACrC,MAAM,CAAC,MAAM,GAAG,GAAG,kBAAkB,CAAC"}