@matterbridge/types 3.11.2-dev-20261106-98b10ca → 3.11.3-dev-20261107-92e4713

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.
@@ -1,7 +1,7 @@
1
1
  import type { LogLevel } from 'node-ansi-logger';
2
- import type { ApiSelectDevice, ApiSelectEntity, ApiSettings, PluginStatusUpdate, RefreshRequiredChanged, WsMessageBroadcast } from './frontendTypes.js';
2
+ import type { PluginStatusUpdate, RefreshRequiredChanged, WsMessageBroadcast } from './frontendTypes.js';
3
3
  import type { PlatformConfig, PlatformMatterbridge, PlatformSchema } from './matterbridgePlatformTypes.js';
4
- import type { ApiClusters, ApiDevice, ApiMatter, ApiPlugin, BaseDevice, BridgeStatus, SharedMatterbridge, StoragePlugin } from './matterbridgeTypes.js';
4
+ import type { ApiClusters, ApiDevice, ApiMatter, ApiPlugin, ApiSelectDevice, ApiSelectEntity, ApiSettings, Device, BridgeStatus, SharedMatterbridge, StoragePlugin } from './matterbridgeTypes.js';
5
5
  import type { ThreadNames, WorkerData } from './workerTypes.js';
6
6
  export type WorkerSrcType = 'cli' | 'manager' | 'matterbridge' | 'plugins' | 'devices' | 'frontend' | 'matter' | 'platform' | 'spawn' | 'updates';
7
7
  export type WorkerDstType = 'cli' | 'manager' | 'matterbridge' | 'plugins' | 'devices' | 'frontend' | 'matter' | 'platform' | 'spawn' | 'updates' | 'all';
@@ -1032,26 +1032,26 @@ export type WorkerMessageTypes = {
1032
1032
  };
1033
1033
  response: {
1034
1034
  result: {
1035
- device: BaseDevice | undefined;
1035
+ device: Device | undefined;
1036
1036
  };
1037
1037
  };
1038
1038
  };
1039
1039
  devices_set: {
1040
1040
  request: {
1041
1041
  params: {
1042
- device: BaseDevice;
1042
+ device: Device;
1043
1043
  };
1044
1044
  };
1045
1045
  response: {
1046
1046
  result: {
1047
- device: BaseDevice;
1047
+ device: Device;
1048
1048
  };
1049
1049
  };
1050
1050
  };
1051
1051
  devices_remove: {
1052
1052
  request: {
1053
1053
  params: {
1054
- device: BaseDevice;
1054
+ device: Device;
1055
1055
  };
1056
1056
  };
1057
1057
  response: {
@@ -1070,7 +1070,7 @@ export type WorkerMessageTypes = {
1070
1070
  };
1071
1071
  };
1072
1072
  };
1073
- devices_basearray: {
1073
+ devices_array: {
1074
1074
  request: {
1075
1075
  params: {
1076
1076
  pluginName?: string;
@@ -1078,20 +1078,7 @@ export type WorkerMessageTypes = {
1078
1078
  };
1079
1079
  response: {
1080
1080
  result: {
1081
- devices: BaseDevice[];
1082
- };
1083
- };
1084
- };
1085
- devices_apidevicearray: {
1086
- request: {
1087
- params: {
1088
- pluginName?: string;
1089
- extended?: boolean;
1090
- };
1091
- };
1092
- response: {
1093
- result: {
1094
- devices: ApiDevice[];
1081
+ devices: Device[];
1095
1082
  };
1096
1083
  };
1097
1084
  };
@@ -1,43 +1,6 @@
1
1
  import type { PlatformConfig } from './matterbridgePlatformTypes.js';
2
- import type { ApiClusters, ApiDevice, ApiMatter, ApiPlugin, BridgeStatus, MatterbridgeInformation, SystemInformation } from './matterbridgeTypes.js';
2
+ import type { ApiClusters, ApiDevice, ApiMatter, ApiPlugin, ApiSelectDevice, ApiSelectEntity, ApiSettings, ApiSystemUpdate, BridgeStatus, Device } from './matterbridgeTypes.js';
3
3
  export type RefreshRequiredChanged = 'settings' | 'plugins' | 'devices' | 'matter';
4
- export interface ApiSettings {
5
- matterbridgeInformation: MatterbridgeInformation;
6
- systemInformation: SystemInformation;
7
- }
8
- export interface ApiSelectDevice {
9
- plugin: string;
10
- serialNumber: string;
11
- deviceName: string;
12
- configUrl?: string;
13
- icon?: string;
14
- entities?: ApiSelectDeviceEntity[];
15
- }
16
- export interface ApiSelectDeviceEntity {
17
- name: string;
18
- description: string;
19
- icon?: string;
20
- }
21
- export interface ApiSelectEntity {
22
- plugin: string;
23
- name: string;
24
- description: string;
25
- icon?: string;
26
- }
27
- export interface ApiSystemUpdate {
28
- systemUptime: string;
29
- processUptime: string;
30
- totalMemory: string;
31
- freeMemory: string;
32
- constrainedMemory: string;
33
- rss: string;
34
- heapTotal: string;
35
- heapUsed: string;
36
- external: string;
37
- arrayBuffers: string;
38
- cpuUsage: number;
39
- processCpuUsage: number;
40
- }
41
4
  export interface WsMessage {
42
5
  id: number;
43
6
  src: string;
@@ -148,14 +111,14 @@ export interface WsMessageApiRestartPluginResponse extends WsMessageSuccessApiRe
148
111
  method: '/api/restartplugin';
149
112
  }
150
113
  export interface WsMessageApiSavePluginConfigRequest extends WsMessageBaseApiRequest {
151
- method: '/api/savepluginconfig';
114
+ method: '/api/save-plugin-config';
152
115
  params: {
153
116
  pluginName: string;
154
117
  formData: PlatformConfig;
155
118
  };
156
119
  }
157
120
  export interface WsMessageApiSavePluginConfigResponse extends WsMessageSuccessApiResponse {
158
- method: '/api/savepluginconfig';
121
+ method: '/api/save-plugin-config';
159
122
  }
160
123
  export interface WsMessageApiCheckUpdatesRequest extends WsMessageBaseApiRequest {
161
124
  method: '/api/checkupdates';
@@ -224,17 +187,17 @@ export interface WsMessageApiFactoryResetResponse extends WsMessageSuccessApiRes
224
187
  method: '/api/factoryreset';
225
188
  }
226
189
  export interface WsMessageApiViewHistoryPageRequest extends WsMessageBaseApiRequest {
227
- method: '/api/viewhistorypage';
190
+ method: '/api/view-historypage';
228
191
  }
229
192
  export interface WsMessageApiViewHistoryPageResponse extends WsMessageSuccessApiResponse {
230
- method: '/api/viewhistorypage';
193
+ method: '/api/view-historypage';
231
194
  success: true;
232
195
  }
233
196
  export interface WsMessageApiDownloadHistoryPageRequest extends WsMessageBaseApiRequest {
234
- method: '/api/downloadhistorypage';
197
+ method: '/api/download-historypage';
235
198
  }
236
199
  export interface WsMessageApiDownloadHistoryPageResponse extends WsMessageSuccessApiResponse {
237
- method: '/api/downloadhistorypage';
200
+ method: '/api/download-historypage';
238
201
  success: true;
239
202
  }
240
203
  export interface WsMessageApiMatterRequest extends WsMessageBaseApiRequest {
@@ -270,11 +233,22 @@ export interface WsMessageApiDevicesRequest extends WsMessageBaseApiRequest {
270
233
  method: '/api/devices';
271
234
  params: {
272
235
  pluginName?: string;
273
- extended: boolean;
274
236
  };
275
237
  }
276
238
  export interface WsMessageApiDevicesResponse extends WsMessageSuccessApiResponse {
277
239
  method: '/api/devices';
240
+ response: Device[];
241
+ }
242
+ export interface WsMessageApiPlatformDevicesRequest extends WsMessageBaseApiRequest {
243
+ method: '/api/platform-devices';
244
+ params: {
245
+ pluginName: string;
246
+ extended: boolean;
247
+ };
248
+ }
249
+ export interface WsMessageApiPlatformDevicesResponse extends WsMessageSuccessApiResponse {
250
+ method: '/api/platform-devices';
251
+ pluginName: string;
278
252
  response: ApiDevice[];
279
253
  }
280
254
  export interface WsMessageApiUnregisterDeviceRequest extends WsMessageBaseApiRequest {
@@ -314,23 +288,23 @@ export interface WsMessageApiClustersResponse extends WsMessageSuccessApiRespons
314
288
  response: ApiClusters;
315
289
  }
316
290
  export interface WsMessageApiSelectDevicesRequest extends WsMessageBaseApiRequest {
317
- method: '/api/select/devices';
291
+ method: '/api/select-devices';
318
292
  params: {
319
293
  plugin: string;
320
294
  };
321
295
  }
322
296
  export interface WsMessageApiSelectDevicesResponse extends WsMessageSuccessApiResponse {
323
- method: '/api/select/devices';
297
+ method: '/api/select-devices';
324
298
  response: ApiSelectDevice[];
325
299
  }
326
300
  export interface WsMessageApiSelectEntitiesRequest extends WsMessageBaseApiRequest {
327
- method: '/api/select/entities';
301
+ method: '/api/select-entities';
328
302
  params: {
329
303
  plugin: string;
330
304
  };
331
305
  }
332
306
  export interface WsMessageApiSelectEntitiesResponse extends WsMessageSuccessApiResponse {
333
- method: '/api/select/entities';
307
+ method: '/api/select-entities';
334
308
  response: ApiSelectEntity[];
335
309
  }
336
310
  export interface WsMessageApiActionRequest extends WsMessageBaseApiRequest {
@@ -484,8 +458,8 @@ export interface WsMessageApiArchive extends WsMessageSuccessApiResponse {
484
458
  destinationPath: string;
485
459
  };
486
460
  }
487
- export type WsMessageApiRequest = WsMessagePingRequest | WsMessageApiLoginRequest | WsMessageApiInstallRequest | WsMessageApiUninstallRequest | WsMessageApiAddPluginRequest | WsMessageApiRemovePluginRequest | WsMessageApiEnablePluginRequest | WsMessageApiDisablePluginRequest | WsMessageApiRestartPluginRequest | WsMessageApiSavePluginConfigRequest | WsMessageApiCheckUpdatesRequest | WsMessageApiRestartRequest | WsMessageApiShutdownRequest | WsMessageApiCreateBackupRequest | WsMessageApiCreateMatterbridgeStorageBackupRequest | WsMessageApiCreateMatterStorageBackupRequest | WsMessageApiCreatePluginBackupRequest | WsMessageApiCreateConfigBackupRequest | WsMessageApiUnregisterRequest | WsMessageApiResetRequest | WsMessageApiFactoryResetRequest | WsMessageApiViewHistoryPageRequest | WsMessageApiDownloadHistoryPageRequest | WsMessageApiMatterRequest | WsMessageApiSettingsRequest | WsMessageApiPluginsRequest | WsMessageApiDevicesRequest | WsMessageApiUnregisterDeviceRequest | WsMessageApiRenameDeviceRequest | WsMessageApiClustersRequest | WsMessageApiSelectDevicesRequest | WsMessageApiSelectEntitiesRequest | WsMessageApiActionRequest | WsMessageApiConfigRequest | WsMessageApiCommandRequest;
488
- export type WsMessageApiResponse = WsMessagePingResponse | WsMessageApiLoginResponse | WsMessageApiInstallResponse | WsMessageApiUninstallResponse | WsMessageApiAddPluginResponse | WsMessageApiRemovePluginResponse | WsMessageApiEnablePluginResponse | WsMessageApiDisablePluginResponse | WsMessageApiRestartPluginResponse | WsMessageApiSavePluginConfigResponse | WsMessageApiCheckUpdatesResponse | WsMessageApiRestartResponse | WsMessageApiShutdownResponse | WsMessageApiCreateBackupResponse | WsMessageApiCreateMatterbridgeStorageBackupResponse | WsMessageApiCreateMatterStorageBackupResponse | WsMessageApiCreatePluginBackupResponse | WsMessageApiCreateConfigBackupResponse | WsMessageApiUnregisterResponse | WsMessageApiResetResponse | WsMessageApiFactoryResetResponse | WsMessageApiViewHistoryPageResponse | WsMessageApiDownloadHistoryPageResponse | WsMessageApiMatterResponse | WsMessageApiSettingsResponse | WsMessageApiPluginsResponse | WsMessageApiDevicesResponse | WsMessageApiUnregisterDeviceResponse | WsMessageApiRenameDeviceResponse | WsMessageApiClustersResponse | WsMessageApiSelectDevicesResponse | WsMessageApiSelectEntitiesResponse | WsMessageApiActionResponse | WsMessageApiConfigResponse | WsMessageApiCommandResponse | WsMessageApiLog | WsMessageApiRefreshRequired | WsMessageApiRestartRequired | WsMessageApiRestartNotRequired | WsMessageApiUpdateRequired | WsMessageApiPluginUpdateRequired | WsMessageApiPluginStatusUpdate | WsMessageApiMatterbridgeStatusUpdate | WsMessageApiSystemUpdate | WsMessageApiStateUpdate | WsMessageApiSnackbar | WsMessageApiCloseSnackbar | WsMessageApiArchive;
461
+ export type WsMessageApiRequest = WsMessagePingRequest | WsMessageApiLoginRequest | WsMessageApiInstallRequest | WsMessageApiUninstallRequest | WsMessageApiAddPluginRequest | WsMessageApiRemovePluginRequest | WsMessageApiEnablePluginRequest | WsMessageApiDisablePluginRequest | WsMessageApiRestartPluginRequest | WsMessageApiSavePluginConfigRequest | WsMessageApiCheckUpdatesRequest | WsMessageApiRestartRequest | WsMessageApiShutdownRequest | WsMessageApiCreateBackupRequest | WsMessageApiCreateMatterbridgeStorageBackupRequest | WsMessageApiCreateMatterStorageBackupRequest | WsMessageApiCreatePluginBackupRequest | WsMessageApiCreateConfigBackupRequest | WsMessageApiUnregisterRequest | WsMessageApiResetRequest | WsMessageApiFactoryResetRequest | WsMessageApiViewHistoryPageRequest | WsMessageApiDownloadHistoryPageRequest | WsMessageApiMatterRequest | WsMessageApiSettingsRequest | WsMessageApiPluginsRequest | WsMessageApiDevicesRequest | WsMessageApiPlatformDevicesRequest | WsMessageApiUnregisterDeviceRequest | WsMessageApiRenameDeviceRequest | WsMessageApiClustersRequest | WsMessageApiSelectDevicesRequest | WsMessageApiSelectEntitiesRequest | WsMessageApiActionRequest | WsMessageApiConfigRequest | WsMessageApiCommandRequest;
462
+ export type WsMessageApiResponse = WsMessagePingResponse | WsMessageApiLoginResponse | WsMessageApiInstallResponse | WsMessageApiUninstallResponse | WsMessageApiAddPluginResponse | WsMessageApiRemovePluginResponse | WsMessageApiEnablePluginResponse | WsMessageApiDisablePluginResponse | WsMessageApiRestartPluginResponse | WsMessageApiSavePluginConfigResponse | WsMessageApiCheckUpdatesResponse | WsMessageApiRestartResponse | WsMessageApiShutdownResponse | WsMessageApiCreateBackupResponse | WsMessageApiCreateMatterbridgeStorageBackupResponse | WsMessageApiCreateMatterStorageBackupResponse | WsMessageApiCreatePluginBackupResponse | WsMessageApiCreateConfigBackupResponse | WsMessageApiUnregisterResponse | WsMessageApiResetResponse | WsMessageApiFactoryResetResponse | WsMessageApiViewHistoryPageResponse | WsMessageApiDownloadHistoryPageResponse | WsMessageApiMatterResponse | WsMessageApiSettingsResponse | WsMessageApiPluginsResponse | WsMessageApiDevicesResponse | WsMessageApiPlatformDevicesResponse | WsMessageApiUnregisterDeviceResponse | WsMessageApiRenameDeviceResponse | WsMessageApiClustersResponse | WsMessageApiSelectDevicesResponse | WsMessageApiSelectEntitiesResponse | WsMessageApiActionResponse | WsMessageApiConfigResponse | WsMessageApiCommandResponse | WsMessageApiLog | WsMessageApiRefreshRequired | WsMessageApiRestartRequired | WsMessageApiRestartNotRequired | WsMessageApiUpdateRequired | WsMessageApiPluginUpdateRequired | WsMessageApiPluginStatusUpdate | WsMessageApiMatterbridgeStatusUpdate | WsMessageApiSystemUpdate | WsMessageApiStateUpdate | WsMessageApiSnackbar | WsMessageApiCloseSnackbar | WsMessageApiArchive;
489
463
  export type WsMessageBroadcast = WsMessageApiLog | WsMessageApiRefreshRequired | WsMessageApiRestartRequired | WsMessageApiRestartNotRequired | WsMessageApiUpdateRequired | WsMessageApiPluginUpdateRequired | WsMessageApiPluginStatusUpdate | WsMessageApiMatterbridgeStatusUpdate | WsMessageApiSystemUpdate | WsMessageApiStateUpdate | WsMessageApiSnackbar | WsMessageApiCloseSnackbar | WsMessageApiArchive;
490
464
  export declare function isApiRequest(msg: WsMessage): msg is WsMessageApiRequest;
491
465
  export declare function isApiResponse(msg: WsMessage): msg is WsMessageApiResponse;
@@ -154,6 +154,24 @@ export interface MatterbridgeInformation {
154
154
  runningTimes: number;
155
155
  runningDays: number;
156
156
  }
157
+ export interface ApiSettings {
158
+ matterbridgeInformation: MatterbridgeInformation;
159
+ systemInformation: SystemInformation;
160
+ }
161
+ export interface ApiSystemUpdate {
162
+ systemUptime: string;
163
+ processUptime: string;
164
+ totalMemory: string;
165
+ freeMemory: string;
166
+ constrainedMemory: string;
167
+ rss: string;
168
+ heapTotal: string;
169
+ heapUsed: string;
170
+ external: string;
171
+ arrayBuffers: string;
172
+ cpuUsage: number;
173
+ processCpuUsage: number;
174
+ }
157
175
  export interface SanitizedExposedFabricInformation {
158
176
  fabricIndex: FabricIndex;
159
177
  fabricId: string;
@@ -182,14 +200,14 @@ export interface ApiDevice {
182
200
  serialNumber: string;
183
201
  uniqueId: string;
184
202
  productUrl: string;
185
- configUrl?: string;
203
+ configUrl: string | undefined;
186
204
  reachable: boolean;
187
205
  powerSource?: 'ac' | 'dc' | 'ok' | 'warning' | 'critical';
188
206
  batteryLevel?: number;
189
207
  cluster: string;
190
208
  matter?: ApiMatter;
191
209
  }
192
- export interface BaseDevice {
210
+ export interface Device {
193
211
  mode: 'server' | 'matter' | undefined;
194
212
  plugin: string | undefined;
195
213
  configUrl: string | undefined;
@@ -215,6 +233,25 @@ export interface BaseDevice {
215
233
  number: number | undefined;
216
234
  id: string | undefined;
217
235
  }
236
+ export interface ApiSelectDevice {
237
+ plugin: string;
238
+ serialNumber: string;
239
+ deviceName: string;
240
+ configUrl?: string;
241
+ icon?: string;
242
+ entities?: ApiSelectDeviceEntity[];
243
+ }
244
+ export interface ApiSelectDeviceEntity {
245
+ name: string;
246
+ description: string;
247
+ icon?: string;
248
+ }
249
+ export interface ApiSelectEntity {
250
+ plugin: string;
251
+ name: string;
252
+ description: string;
253
+ icon?: string;
254
+ }
218
255
  export interface ApiMatter {
219
256
  id: string;
220
257
  online: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@matterbridge/types",
3
- "version": "3.11.2-dev-20261106-98b10ca",
3
+ "version": "3.11.3-dev-20261107-92e4713",
4
4
  "description": "Matterbridge types library",
5
5
  "author": "https://github.com/Luligu",
6
6
  "homepage": "https://matterbridge.io/",