matterbridge 2.1.4-dev.2 → 2.1.4

package/CHANGELOG.md

@@ -25,13 +25,15 @@ You need to update all plugins you use and Matterbridge in the same moment.
 
 I suggest to first update all plugins without restarting and then to update Matterbridge so when it restarts, all versions will be the latest.
 
+If you use docker, all plugins are already installed in the image so you just need to pull the new image.
+
 Compatibility list:
 matterbridge-shelly v. 1.1.5
 matterbridge-zigbee2mqtt v. 2.4.4
 matterbridge-somfy-tahoma v. 1.2.3
 matterbridge-hass v. 0.0.8
 
-## [2.1.4] - 2025-02-06
+## [2.1.4] - 2025-02-07
 
 ### Added
 
@@ -42,6 +44,7 @@ matterbridge-hass v. 0.0.8
 ### Changed
 
 - [package]: Update matter.js to 0.12.3.
+- [matter.js]: Since matter.js storage cannot properly encode non latin names, they are encoded before passing them to matter.js.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="./yellow-button.png" alt="Buy me a coffee" width="120">

package/README-DOCKER.md

@@ -48,11 +48,13 @@ The container must have full access to the host network (needed for mdns).
 
 ```
 sudo docker run --name matterbridge \
-  -v ${HOME}/Matterbridge:/root/Matterbridge \
-  -v ${HOME}/.matterbridge:/root/.matterbridge \
+  -v /home/<USER>/Matterbridge:/root/Matterbridge \
+  -v /home/<USER>/.matterbridge:/root/.matterbridge \
   --network host --restart always -d luligu/matterbridge:latest
 ```
 
+Replace USER with your user name (i.e. ubuntu or pi).
+
 You may need to adapt the script to your setup.
 
 ### Run with docker compose
@@ -63,14 +65,16 @@ The docker-compose.yml file is available in the docker directory of the package
 services:
   matterbridge:
     container_name: matterbridge
-    image: luligu/matterbridge:latest                     # Matterbridge image with the latest tag
-    network_mode: host                                    # Ensures the Matter mdns works
-    restart: always                                       # Ensures the container always restarts automatically
+    image: luligu/matterbridge:latest                         # Matterbridge image with the tag latest
+    network_mode: host                                        # Ensures the Matter mdns works
+    restart: always                                           # Ensures the container always restarts automatically
     volumes:
-      - "${HOME}/Matterbridge:/root/Matterbridge"         # Mounts the Matterbridge plugin directory
-      - "${HOME}/.matterbridge:/root/.matterbridge"       # Mounts the Matterbridge storage directory
+      - "/home/<USER>/Matterbridge:/root/Matterbridge"        # Mounts the Matterbridge plugin directory
+      - "/home/<USER>/.matterbridge:/root/.matterbridge"      # Mounts the Matterbridge storage directory
 ```
 
+Replace USER with your user name (i.e. ubuntu or pi).
+
 copy it in the home directory or edit the existing one to add the matterbridge service.
 
 Then start docker compose with:

package/dist/cli.d.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+/**
+ * This file contains the CLI entry point of Matterbridge.
+ *
+ * @file cli.ts
+ * @author Luca Liguori
+ * @date 2023-12-29
+ * @version 1.0.11
+ *
+ * Copyright 2023, 2024, 2025 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;GAqBG"}

package/dist/cli.js

@@ -1,4 +1,27 @@
 #!/usr/bin/env node
+/**
+ * This file contains the CLI entry point of Matterbridge.
+ *
+ * @file cli.ts
+ * @author Luca Liguori
+ * @date 2023-12-29
+ * @version 1.0.11
+ *
+ * Copyright 2023, 2024, 2025 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+/* eslint-disable no-console */
 import { Matterbridge } from './matterbridge.js';
 let instance;
 const cli = '\u001B[32m';
@@ -34,10 +57,13 @@ async function restart() {
 async function update() {
     if (process.argv.includes('-debug'))
         console.log(cli + 'CLI: received update event, updating...' + rs);
+    // TODO: Implement update logic outside of matterbridge
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
 process.title = 'matterbridge';
+// Run the main function
 main().catch((error) => {
     console.error(er + `CLI: Matterbridge.loadInstance() failed with error: ${error}` + rs);
 });
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,+BAA+B;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,IAAI,QAAkC,CAAC;AACvC,MAAM,GAAG,GAAG,YAAY,CAAC;AACzB,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAC5B,MAAM,EAAE,GAAG,cAAc,CAAC;AAE1B,KAAK,UAAU,IAAI;IACjB,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,QAAQ,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,cAAc,wBAAwB,GAAG,EAAE,CAAC,CAAC;IAClK,QAAQ,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjD,gBAAgB,EAAE,CAAC;IACnB,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,QAAQ,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,cAAc,wBAAwB,GAAG,EAAE,CAAC,CAAC;AACpK,CAAC;AAED,SAAS,gBAAgB;IACvB,IAAI,QAAQ;QAAE,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9D,IAAI,QAAQ;QAAE,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,IAAI,QAAQ;QAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,KAAK,UAAU,QAAQ;IACrB,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,0CAA0C,GAAG,EAAE,CAAC,CAAC;IACxG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,OAAO;IACpB,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,yCAAyC,GAAG,EAAE,CAAC,CAAC;IACvG,QAAQ,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjD,gBAAgB,EAAE,CAAC;AACrB,CAAC;AAED,KAAK,UAAU,MAAM;IACnB,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,yCAAyC,GAAG,EAAE,CAAC,CAAC;IACvG,uDAAuD;IACvD,QAAQ,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjD,gBAAgB,EAAE,CAAC;AACrB,CAAC;AAED,OAAO,CAAC,KAAK,GAAG,cAAc,CAAC;AAE/B,wBAAwB;AACxB,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,uDAAuD,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;AAC1F,CAAC,CAAC,CAAC"}

package/dist/cluster/export.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=export.d.ts.map

package/dist/cluster/export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../src/cluster/export.ts"],"names":[],"mappings":""}

package/dist/cluster/export.js

@@ -1 +1,3 @@
 export {};
+// Nothing to export right now
+//# sourceMappingURL=export.js.map

package/dist/cluster/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/cluster/export.ts"],"names":[],"mappings":";AAAA,8BAA8B"}

package/dist/defaultConfigSchema.d.ts

@@ -0,0 +1,27 @@
+/**
+ * This file contains the default config for the plugins.
+ *
+ * @file defaultConfigSchema.ts
+ * @author Luca Liguori
+ * @date 2024-05-07
+ * @version 1.0.1
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+import { PlatformConfig } from './matterbridgePlatform.js';
+export declare const zigbee2mqtt_config: PlatformConfig;
+export declare const somfytahoma_config: PlatformConfig;
+export declare const shelly_config: PlatformConfig;
+//# sourceMappingURL=defaultConfigSchema.d.ts.map

package/dist/defaultConfigSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultConfigSchema.d.ts","sourceRoot":"","sources":["../src/defaultConfigSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,eAAO,MAAM,kBAAkB,EAAE,cAiBhC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,cAWhC,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,cAkC3B,CAAC"}

package/dist/defaultConfigSchema.js

@@ -1,3 +1,25 @@
+/**
+ * This file contains the default config for the plugins.
+ *
+ * @file defaultConfigSchema.ts
+ * @author Luca Liguori
+ * @date 2024-05-07
+ * @version 1.0.1
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
 export const zigbee2mqtt_config = {
     name: 'matterbridge-zigbee2mqtt',
     type: 'DynamicPlatform',
@@ -63,3 +85,4 @@ export const shelly_config = {
     debugWs: false,
     unregisterOnShutdown: false,
 };
+//# sourceMappingURL=defaultConfigSchema.js.map

package/dist/defaultConfigSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultConfigSchema.js","sourceRoot":"","sources":["../src/defaultConfigSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,MAAM,CAAC,MAAM,kBAAkB,GAAmB;IAChD,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,gBAAgB,EAAE,EAAE;IACpB,sBAAsB,EAAE,EAAE;IAC1B,KAAK,EAAE,KAAK;IACZ,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAmB;IAChD,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE,iBAAiB;IACvB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,gBAAgB,EAAE,EAAE;IACpB,KAAK,EAAE,KAAK;IACZ,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAmB;IAC3C,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,iBAAiB;IACvB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,YAAY,EAAE,QAAQ;IACtB,UAAU,EAAE,EAAE;IACd,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,WAAW,EAAE,WAAW;IACxB,gBAAgB,EAAE,EAAE;IACpB,kBAAkB,EAAE,EAAE;IACtB,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE,WAAW;IAC7B,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,UAAU;IAC5B,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,eAAe,EAAE,EAAE;IACnB,qBAAqB,EAAE,EAAE;IACzB,WAAW,EAAE,EAAE;IACf,QAAQ,EAAE,EAAE;IACZ,kBAAkB,EAAE,IAAI;IACxB,qBAAqB,EAAE,IAAI;IAC3B,oBAAoB,EAAE,KAAK;IAC3B,oBAAoB,EAAE,KAAK;IAC3B,iBAAiB,EAAE,IAAI;IACvB,aAAa,EAAE,CAAC;IAChB,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,KAAK;IACZ,SAAS,EAAE,KAAK;IAChB,SAAS,EAAE,KAAK;IAChB,OAAO,EAAE,KAAK;IACd,oBAAoB,EAAE,KAAK;CAC5B,CAAC"}

package/dist/deviceManager.d.ts

@@ -0,0 +1,114 @@
+/**
+ * This file contains the DeviceManager class.
+ *
+ * @file devices.ts
+ * @author Luca Liguori
+ * @date 2024-07-26
+ * @version 1.0.9
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+import { LogLevel } from './logger/export.js';
+import { NodeStorage } from './storage/export.js';
+import { Matterbridge } from './matterbridge.js';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+/**
+ * Manages Matterbridge devices.
+ */
+export declare class DeviceManager {
+    private readonly _devices;
+    private readonly matterbridge;
+    private readonly nodeContext;
+    private readonly log;
+    /**
+     * Creates an instance of DeviceManager.
+     *
+     * @param {Matterbridge} matterbridge - The Matterbridge instance.
+     * @param {NodeStorage} nodeContext - The node storage context.
+     */
+    constructor(matterbridge: Matterbridge, nodeContext: NodeStorage);
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
+    get length(): number;
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
+    get size(): number;
+    /**
+     * Checks if a device with the specified unique ID exists.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {boolean} True if the device exists, false otherwise.
+     */
+    has(uniqueId: string): boolean;
+    /**
+     * Gets a device by its unique ID.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
+     */
+    get(uniqueId: string): MatterbridgeEndpoint | undefined;
+    /**
+     * Adds a device to the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to add.
+     * @returns {MatterbridgeEndpoint} The added device.
+     * @throws {Error} If the device does not have a unique ID.
+     */
+    set(device: MatterbridgeEndpoint): MatterbridgeEndpoint;
+    /**
+     * Removes a device from the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to remove.
+     * @returns {boolean} True if the device was removed, false otherwise.
+     * @throws {Error} If the device does not have a unique ID.
+     */
+    remove(device: MatterbridgeEndpoint): boolean;
+    /**
+     * Clears all devices from the manager.
+     */
+    clear(): void;
+    /**
+     * Gets an array of all devices.
+     *
+     * @returns {MatterbridgeEndpoint[]} An array of all devices.
+     */
+    array(): MatterbridgeEndpoint[];
+    /**
+     * Iterates over all devices.
+     *
+     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
+     */
+    [Symbol.iterator](): MapIterator<MatterbridgeEndpoint>;
+    /**
+     * Asynchronously iterates over each device and calls the provided callback function.
+     *
+     * @param {Function} callback - The callback function to call with each device.
+     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
+     */
+    forEach(callback: (device: MatterbridgeEndpoint) => Promise<void>): Promise<void>;
+    /**
+     * Sets the log level.
+     *
+     * @param {LogLevel} logLevel - The log level to set.
+     */
+    set logLevel(logLevel: LogLevel);
+}
+//# sourceMappingURL=deviceManager.d.ts.map

package/dist/deviceManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceManager.d.ts","sourceRoot":"","sources":["../src/deviceManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAwB,QAAQ,EAAmB,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAGjE;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2C;IACpE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAa;IAEjC;;;;;OAKG;gBACS,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW;IAOhE;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI9B;;;;;OAKG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS;IAIvD;;;;;;OAMG;IACH,GAAG,CAAC,MAAM,EAAE,oBAAoB,GAAG,oBAAoB;IAOvD;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO;IAM7C;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;OAIG;IACH,KAAK,IAAI,oBAAoB,EAAE;IAI/B;;;;OAIG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB;;;;;OAKG;IACG,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAavF;;;;OAIG;IACH,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;CACF"}

package/dist/deviceManager.js

@@ -1,28 +1,89 @@
+/**
+ * This file contains the DeviceManager class.
+ *
+ * @file devices.ts
+ * @author Luca Liguori
+ * @date 2024-07-26
+ * @version 1.0.9
+ *
+ * Copyright 2024, 2025, 2026 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+// NodeStorage and AnsiLogger modules
 import { AnsiLogger, BLUE, er } from './logger/export.js';
 import { dev } from './matterbridgeTypes.js';
+/**
+ * Manages Matterbridge devices.
+ */
 export class DeviceManager {
     _devices = new Map();
     matterbridge;
     nodeContext;
     log;
+    /**
+     * Creates an instance of DeviceManager.
+     *
+     * @param {Matterbridge} matterbridge - The Matterbridge instance.
+     * @param {NodeStorage} nodeContext - The node storage context.
+     */
     constructor(matterbridge, nodeContext) {
         this.matterbridge = matterbridge;
         this.nodeContext = nodeContext;
-        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
+        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
         this.log.debug('Matterbridge device manager starting...');
     }
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
     get length() {
         return this._devices.size;
     }
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
     get size() {
         return this._devices.size;
     }
+    /**
+     * Checks if a device with the specified unique ID exists.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {boolean} True if the device exists, false otherwise.
+     */
     has(uniqueId) {
         return this._devices.has(uniqueId);
     }
+    /**
+     * Gets a device by its unique ID.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
+     */
     get(uniqueId) {
         return this._devices.get(uniqueId);
     }
+    /**
+     * Adds a device to the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to add.
+     * @returns {MatterbridgeEndpoint} The added device.
+     * @throws {Error} If the device does not have a unique ID.
+     */
     set(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -31,6 +92,13 @@ export class DeviceManager {
         this._devices.set(device.uniqueId, device);
         return device;
     }
+    /**
+     * Removes a device from the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to remove.
+     * @returns {boolean} True if the device was removed, false otherwise.
+     * @throws {Error} If the device does not have a unique ID.
+     */
     remove(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -38,15 +106,34 @@ export class DeviceManager {
             this.log.error(`The device ${dev}${device.deviceName}${er} with uniqueId ${BLUE}${device.uniqueId}${er} serialNumber ${BLUE}${device.serialNumber}${er} is not registered in the device manager`);
         return this._devices.delete(device.uniqueId);
     }
+    /**
+     * Clears all devices from the manager.
+     */
     clear() {
         this._devices.clear();
     }
+    /**
+     * Gets an array of all devices.
+     *
+     * @returns {MatterbridgeEndpoint[]} An array of all devices.
+     */
     array() {
         return Array.from(this._devices.values());
     }
+    /**
+     * Iterates over all devices.
+     *
+     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
+     */
     [Symbol.iterator]() {
         return this._devices.values();
     }
+    /**
+     * Asynchronously iterates over each device and calls the provided callback function.
+     *
+     * @param {Function} callback - The callback function to call with each device.
+     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
+     */
     async forEach(callback) {
         if (this.size === 0)
             return;
@@ -60,7 +147,13 @@ export class DeviceManager {
         });
         await Promise.all(tasks);
     }
+    /**
+     * Sets the log level.
+     *
+     * @param {LogLevel} logLevel - The log level to set.
+     */
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
     }
 }
+//# sourceMappingURL=deviceManager.js.map

package/dist/deviceManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceManager.js","sourceRoot":"","sources":["../src/deviceManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,qCAAqC;AACrC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAA6B,MAAM,oBAAoB,CAAC;AAMrF,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAE7C;;GAEG;AACH,MAAM,OAAO,aAAa;IACP,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;IACnD,YAAY,CAAe;IAC3B,WAAW,CAAc;IACzB,GAAG,CAAa;IAEjC;;;;;OAKG;IACH,YAAY,YAA0B,EAAE,WAAwB;QAC9D,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,EAAE,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9I,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,MAA4B;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,iDAAiD,CAAC,CAAC;QACnI,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,kBAAkB,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,iBAAiB,IAAI,GAAG,MAAM,CAAC,YAAY,GAAG,EAAE,mCAAmC,CAAC,CAAC;QACnO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAA4B;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,iDAAiD,CAAC,CAAC;QACnI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,kBAAkB,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,iBAAiB,IAAI,GAAG,MAAM,CAAC,YAAY,GAAG,EAAE,0CAA0C,CAAC,CAAC;QAC3O,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,QAAyD;QACrE,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QAE5B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACpE,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,iBAAiB,IAAI,GAAG,MAAM,CAAC,YAAY,GAAG,EAAE,cAAc,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YACrL,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ,CAAC,QAAkB;QAC7B,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC/B,CAAC;CACF"}

package/dist/frontend.d.ts

@@ -0,0 +1,110 @@
+/**
+ * This file contains the class Frontend.
+ *
+ * @file frontend.ts
+ * @author Luca Liguori
+ * @date 2025-01-13
+ * @version 1.0.1
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+import { LogLevel } from './logger/export.js';
+import { Matterbridge } from './matterbridge.js';
+/**
+ * Websocket message ID for logging.
+ * @constant {number}
+ */
+export declare const WS_ID_LOG = 0;
+/**
+ * Websocket message ID indicating a refresh is needed.
+ * @constant {number}
+ */
+export declare const WS_ID_REFRESH_NEEDED = 1;
+/**
+ * Websocket message ID indicating a restart is needed.
+ * @constant {number}
+ */
+export declare const WS_ID_RESTART_NEEDED = 2;
+/**
+ * Initializes the frontend of Matterbridge.
+ *
+ * @param port The port number to run the frontend server on. Default is 8283.
+ */
+export declare class Frontend {
+    private matterbridge;
+    private log;
+    private port;
+    private initializeError;
+    private expressApp;
+    private httpServer;
+    private httpsServer;
+    private webSocketServer;
+    private prevCpus;
+    private memoryData;
+    private memoryInterval?;
+    private memoryTimeout?;
+    constructor(matterbridge: Matterbridge);
+    set logLevel(logLevel: LogLevel);
+    start(port?: number): Promise<void>;
+    stop(): Promise<void>;
+    private formatMemoryUsage;
+    private startCpuMemoryDump;
+    private stopCpuMemoryDump;
+    /**
+     * Retrieves the api settings data.
+     * @returns {Promise<object>} A promise that resolve in the api settings object.
+     */
+    private getApiSettings;
+    /**
+     * Retrieves the cluster text description from a given device.
+     * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
+     * @returns {string} The attributes description of the cluster servers in the device.
+     */
+    private getClusterTextFromDevice;
+    /**
+     * Retrieves the base registered plugins sanitized for res.json().
+     * @returns {BaseRegisteredPlugin[]} An array of BaseRegisteredPlugin.
+     */
+    private getBaseRegisteredPlugins;
+    /**
+     * Handles incoming websocket messages for the Matterbridge.
+     *
+     * @param {Matterbridge} this - The Matterbridge instance.
+     * @param {WebSocket} client - The websocket client that sent the message.
+     * @param {WebSocket.RawData} message - The raw data of the message received from the client.
+     * @returns {Promise<void>} A promise that resolves when the message has been handled.
+     */
+    private wsMessageHandler;
+    /**
+     * Sends a WebSocket message to all connected clients. The function is called by AnsiLogger.setGlobalCallback.
+     *
+     * @param {string} level - The logger level of the message: debug info notice warn error fatal...
+     * @param {string} time - The time string of the message
+     * @param {string} name - The logger name of the message
+     * @param {string} message - The content of the message.
+     */
+    wssSendMessage(level: string, time: string, name: string, message: string): void;
+    /**
+     * Sends a need to refresh WebSocket message to all connected clients.
+     *
+     */
+    wssSendRefreshRequired(): void;
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     */
+    wssSendRestartRequired(): void;
+}
+//# sourceMappingURL=frontend.d.ts.map

package/dist/frontend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontend.d.ts","sourceRoot":"","sources":["../src/frontend.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAeH,OAAO,EAA4C,QAAQ,EAA2E,MAAM,oBAAoB,CAAC;AAKjK,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD;;;GAGG;AACH,eAAO,MAAM,SAAS,IAAI,CAAC;AAE3B;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC;;;;GAIG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,GAAG,CAAa;IACxB,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,UAAU,CAAyB;IAC3C,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,eAAe,CAA8B;IAErD,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,UAAU,CAAgD;IAClE,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,aAAa,CAAC,CAAiB;gBAE3B,YAAY,EAAE,YAAY;IAKtC,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAEK,KAAK,CAAC,IAAI,SAAO;IAi0BjB,IAAI;IA+DV,OAAO,CAAC,iBAAiB,CAIvB;IAEF,OAAO,CAAC,kBAAkB;IAoD1B,OAAO,CAAC,iBAAiB;IAsBzB;;;OAGG;YACW,cAAc;IAyB5B;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAuFhC;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IA+BhC;;;;;;;OAOG;YACW,gBAAgB;IA2O9B;;;;;;;OAOG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAuCzE;;;OAGG;IACH,sBAAsB;IAWtB;;;OAGG;IACH,sBAAsB;CAUvB"}