matterbridge 3.0.0-edge.8 → 3.0.0

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,cA2B3B,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',
@@ -56,3 +78,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,UAAU,EAAE,EAAE;IACd,SAAS,EAAE,EAAE;IACb,gBAAgB,EAAE,EAAE;IACpB,kBAAkB,EAAE,EAAE;IACtB,iBAAiB,EAAE,EAAE;IACrB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,eAAe,EAAE,EAAE;IACnB,qBAAqB,EAAE,EAAE;IACzB,WAAW,EAAE,EAAE;IACf,kBAAkB,EAAE,IAAI;IACxB,qBAAqB,EAAE,IAAI;IAC3B,oBAAoB,EAAE,KAAK;IAC3B,iBAAiB,EAAE,IAAI;IACvB,aAAa,EAAE,CAAC;IAChB,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,KAAK;IACjB,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;AAGrF,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. *
+ */
+// AnsiLogger module
 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,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAA6B,MAAM,oBAAoB,CAAC;AAQrF,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,222 @@
+/**
+ * This file contains the class Frontend.
+ *
+ * @file frontend.ts
+ * @author Luca Liguori
+ * @date 2025-01-13
+ * @version 1.0.2
+ *
+ * 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;
+/**
+ * Websocket message ID indicating a cpu update.
+ * @constant {number}
+ */
+export declare const WS_ID_CPU_UPDATE = 3;
+/**
+ * Websocket message ID indicating a memory update.
+ * @constant {number}
+ */
+export declare const WS_ID_MEMORY_UPDATE = 4;
+/**
+ * Websocket message ID indicating an uptime update.
+ * @constant {number}
+ */
+export declare const WS_ID_UPTIME_UPDATE = 5;
+/**
+ * Websocket message ID indicating a snackbar message.
+ * @constant {number}
+ */
+export declare const WS_ID_SNACKBAR = 6;
+/**
+ * Websocket message ID indicating matterbridge has un update available.
+ * @constant {number}
+ */
+export declare const WS_ID_UPDATE_NEEDED = 7;
+/**
+ * Websocket message ID indicating a state update.
+ * @constant {number}
+ */
+export declare const WS_ID_STATEUPDATE = 8;
+/**
+ * Websocket message ID indicating a shelly system update.
+ * check:
+ * curl -k http://127.0.0.1:8101/api/updates/sys/check
+ * perform:
+ * curl -k http://127.0.0.1:8101/api/updates/sys/perform
+ * @constant {number}
+ */
+export declare const WS_ID_SHELLY_SYS_UPDATE = 100;
+/**
+ * Websocket message ID indicating a shelly main update.
+ * check:
+ * curl -k http://127.0.0.1:8101/api/updates/main/check
+ * perform:
+ * curl -k http://127.0.0.1:8101/api/updates/main/perform
+ * @constant {number}
+ */
+export declare const WS_ID_SHELLY_MAIN_UPDATE = 101;
+export declare class Frontend {
+    private matterbridge;
+    private log;
+    private port;
+    private initializeError;
+    private expressApp;
+    private httpServer;
+    private httpsServer;
+    private webSocketServer;
+    private prevCpus;
+    private lastCpuUsage;
+    private memoryData;
+    private memoryInterval?;
+    private memoryTimeout?;
+    constructor(matterbridge: Matterbridge);
+    set logLevel(logLevel: LogLevel);
+    start(port?: number): Promise<void>;
+    stop(): Promise<void>;
+    private formatMemoryUsage;
+    private formatOsUpTime;
+    /**
+     * Retrieves the api settings data.
+     * @returns {Promise<object>} A promise that resolve in the api settings object.
+     */
+    private getApiSettings;
+    /**
+     * Retrieves the reachable attribute.
+     * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
+     * @returns {boolean} The reachable attribute.
+     */
+    private getReachability;
+    private getPowerSource;
+    /**
+     * 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 frontend.
+     *
+     * @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.
+     *
+     * @param {string} changed - The changed value. If null, the whole page will be refreshed.
+     * possible values:
+     * - 'matterbridgeLatestVersion'
+     * - 'matterbridgeAdvertise'
+     * - 'online'
+     * - 'offline'
+     * - 'reachability'
+     * - 'settings'
+     * - 'plugins'
+     * - 'devices'
+     * - 'fabrics'
+     * - 'sessions'
+     */
+    wssSendRefreshRequired(changed?: string | null): void;
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     */
+    wssSendRestartRequired(snackbar?: boolean): void;
+    /**
+     * Sends a need to update WebSocket message to all connected clients.
+     *
+     */
+    wssSendUpdateRequired(): void;
+    /**
+     * Sends a memory update message to all connected clients.
+     *
+     */
+    wssSendCpuUpdate(cpuUsage: number): void;
+    /**
+     * Sends a cpu update message to all connected clients.
+     *
+     */
+    wssSendMemoryUpdate(totalMemory: string, freeMemory: string, rss: string, heapTotal: string, heapUsed: string, external: string, arrayBuffers: string): void;
+    /**
+     * Sends a memory update message to all connected clients.
+     *
+     */
+    wssSendUptimeUpdate(systemUptime: string, processUptime: string): void;
+    /**
+     * Sends a cpu update message to all connected clients.
+     * @param {string} message - The message to send.
+     * @param {number} timeout - The timeout in seconds for the snackbar message.
+     * @param {'info' | 'warning' | 'error' | 'success'} severity - The severity of the snackbar message (default info).
+     *
+     */
+    wssSendSnackbarMessage(message: string, timeout?: number, severity?: 'info' | 'warning' | 'error' | 'success'): void;
+    /**
+     * Sends an attribute update message to all connected WebSocket clients.
+     *
+     * @param {string | undefined} plugin - The name of the plugin.
+     * @param {string | undefined} serialNumber - The serial number of the device.
+     * @param {string | undefined} uniqueId - The unique identifier of the device.
+     * @param {string} cluster - The cluster name where the attribute belongs.
+     * @param {string} attribute - The name of the attribute that changed.
+     * @param {number | string | boolean} value - The new value of the attribute.
+     *
+     * @remarks
+     * This method logs a debug message and sends a JSON-formatted message to all connected WebSocket clients
+     * with the updated attribute information.
+     */
+    wssSendAttributeChangedMessage(plugin: string | undefined, serialNumber: string | undefined, uniqueId: string | undefined, cluster: string, attribute: string, value: number | string | boolean): void;
+    /**
+     * Sends a message to all connected clients.
+     * @param {number} id - The message id.
+     * @param {string} method - The message method.
+     * @param {Record<string, string | number | boolean>} params - The message parameters.
+     *
+     */
+    wssBroadcastMessage(id: number, method?: string, params?: Record<string, string | number | boolean>): 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;AAkBH,OAAO,EAAc,QAAQ,EAA6G,MAAM,oBAAoB,CAAC;AAKrK,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAMjD;;;GAGG;AACH,eAAO,MAAM,SAAS,IAAI,CAAC;AAE3B;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C,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,CAAqC;IACrD,OAAO,CAAC,YAAY,CAAK;IACzB,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;IAs7BjB,IAAI;IA+CV,OAAO,CAAC,iBAAiB,CAQvB;IAGF,OAAO,CAAC,cAAc,CAcpB;IAEF;;;OAGG;YACW,cAAc;IAiC5B;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,cAAc;IAuBtB;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAsGhC;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAsChC;;;;;;OAMG;YACW,gBAAgB;IAmY9B;;;;;;;OAOG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAyCzE;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CAAC,OAAO,GAAE,MAAM,GAAG,IAAW;IAUpD;;;OAGG;IACH,sBAAsB,CAAC,QAAQ,UAAO;IAYtC;;;OAGG;IACH,qBAAqB;IAWrB;;;OAGG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAUjC;;;OAGG;IACH,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAUrJ;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAU/D;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,SAAI,EAAE,QAAQ,GAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAkB;IAUhH;;;;;;;;;;;;;OAaG;IACH,8BAA8B,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAU/L;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CASpG"}