matterbridge 2.1.1-dev.2 → 2.1.1

package/dist/matterbridgePlatform.js

@@ -1,23 +1,59 @@
+/**
+ * This file contains the class MatterbridgeAccessoryPlatform.
+ *
+ * @file matterbridgePlatform.ts
+ * @author Luca Liguori
+ * @date 2024-03-21
+ * @version 1.1.0
+ *
+ * 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 { isValidArray, isValidObject, isValidString } from './utils/utils.js';
+// AnsiLogger module
 import { CYAN, db, nf, wr } from './logger/export.js';
+// Storage module
 import { NodeStorageManager } from './storage/export.js';
+// Node.js module
 import path from 'path';
+/**
+ * Represents the base Matterbridge platform.
+ *
+ */
 export class MatterbridgePlatform {
     matterbridge;
     log;
     config = {};
-    name = '';
-    type = '';
-    version = '1.0.0';
+    name = ''; // Will be set by the loadPlugin() method using the package.json value.
+    type = ''; // Will be set by the extending classes.
+    version = '1.0.0'; // Will be set by the loadPlugin() method using the package.json value.
     storage;
     context;
     selectDevice = new Map();
     selectEntity = new Map();
     registeredEndpoints = new Map();
+    /**
+     * Creates an instance of the base MatterbridgePlatform.
+     * @param {Matterbridge} matterbridge - The Matterbridge instance.
+     * @param {AnsiLogger} log - The logger instance.
+     * @param {PlatformConfig} config - The platform configuration.
+     */
     constructor(matterbridge, log, config) {
         this.matterbridge = matterbridge;
         this.log = log;
         this.config = config;
+        // create the NodeStorageManager for the plugin platform
         if (!isValidString(this.config.name))
             return;
         this.log.debug(`Creating storage for plugin ${this.config.name} in ${path.join(this.matterbridge.matterbridgeDirectory, this.config.name)}`);
@@ -29,36 +65,74 @@ export class MatterbridgePlatform {
             forgiveParseErrors: true,
         });
     }
+    /**
+     * This method must be overridden in the extended class.
+     * It is called when the platform is started.
+     * Use this method to create the MatterbridgeDevice and call this.registerDevice().
+     * @param {string} [reason] - The reason for starting.
+     * @throws {Error} - Throws an error if the method is not overridden.
+     */
     async onStart(reason) {
         this.log.error('Plugins must override onStart.', reason);
         throw new Error('Plugins must override onStart.');
     }
+    /**
+     * This method can be overridden in the extended class.
+     * It is called after the platform has been commissioned.
+     * Use this method to perform any configuration of your devices.
+     */
     async onConfigure() {
         this.log.debug(`Configuring platform ${this.name}`);
         await this.checkEndpointNumbers();
     }
+    /**
+     * This method can be overridden in the extended class.
+     * It is called when the platform is shutting down.
+     * Use this method to clean up any resources.
+     * @param {string} [reason] - The reason for shutting down.
+     */
     async onShutdown(reason) {
         this.log.debug(`Shutting down platform ${this.name}`, reason);
         await this.checkEndpointNumbers();
     }
+    /**
+     * Sets the logger level and logs a debug message indicating that the plugin doesn't override this method.
+     * @param {LogLevel} logLevel The new logger level.
+     */
     async onChangeLoggerLevel(logLevel) {
         this.log.debug(`The plugin doesn't override onChangeLoggerLevel. Logger level set to: ${logLevel}`);
     }
+    /**
+     * Registers a device with the Matterbridge platform.
+     * @param {MatterbridgeEndpoint} device - The device to register.
+     */
     async registerDevice(device) {
         device.plugin = this.name;
         await this.matterbridge.addBridgedEndpoint(this.name, device);
         if (device.uniqueId)
             this.registeredEndpoints.set(device.uniqueId, device);
     }
+    /**
+     * Unregisters a device registered with the Matterbridge platform.
+     * @param {MatterbridgeEndpoint} device - The device to unregister.
+     */
     async unregisterDevice(device) {
         await this.matterbridge.removeBridgedEndpoint(this.name, device);
         if (device.uniqueId)
             this.registeredEndpoints.delete(device.uniqueId);
     }
+    /**
+     * Unregisters all devices registered with the Matterbridge platform.
+     */
     async unregisterAllDevices() {
         await this.matterbridge.removeAllBridgedEndpoints(this.name);
         this.registeredEndpoints.clear();
     }
+    /**
+     * Verifies if the Matterbridge version meets the required version.
+     * @param {string} requiredVersion - The required version to compare against.
+     * @returns {boolean} True if the Matterbridge version meets or exceeds the required version, false otherwise.
+     */
     verifyMatterbridgeVersion(requiredVersion) {
         const compareVersions = (matterbridgeVersion, requiredVersion) => {
             const stripTag = (v) => {
@@ -83,9 +157,27 @@ export class MatterbridgePlatform {
             return false;
         return true;
     }
+    /**
+     * Validates if a device is allowed based on the whitelist and blacklist configurations.
+     * The blacklist has priority over the whitelist.
+     *
+     * @param {string | string[]} device - The device name(s) to validate.
+     * @param {boolean} [log=true] - Whether to log the validation result.
+     * @returns {boolean} - Returns true if the device is allowed, false otherwise.
+     */
     validateDevice(device, log = true) {
         return this.validateDeviceWhiteBlackList(device, log);
     }
+    /**
+     * Validates if a device is allowed based on the whitelist and blacklist configurations.
+     * The blacklist has priority over the whitelist.
+     *
+     * @param {string | string[]} device - The device name(s) to validate.
+     * @param {boolean} [log=true] - Whether to log the validation result.
+     * @returns {boolean} - Returns true if the device is allowed, false otherwise.
+     *
+     * @deprecated This method is deprecated and will be removed in future versions. Use validateDevice instead.
+     */
     validateDeviceWhiteBlackList(device, log = true) {
         if (!Array.isArray(device))
             device = [device];
@@ -115,9 +207,27 @@ export class MatterbridgePlatform {
             this.log.info(`Skipping device ${CYAN}${device.join(', ')}${nf} because not in whitelist`);
         return false;
     }
+    /**
+     * Validates if an entity is allowed based on the entity whitelist and blacklist and the device-entity blacklist configurations.
+     *
+     * @param {string} device - The device to which the entity belongs.
+     * @param {string} entity - The entity to validate.
+     * @param {boolean} [log=true] - Whether to log the validation result.
+     * @returns {boolean} - Returns true if the entity is allowed, false otherwise.
+     */
     validateEntity(device, entity, log = true) {
         return this.validateEntityBlackList(device, entity, log);
     }
+    /**
+     * Validates if an entity is allowed based on the entity blacklist and device-entity blacklist configurations.
+     *
+     * @param {string} device - The device to which the entity belongs.
+     * @param {string} entity - The entity to validate.
+     * @param {boolean} [log=true] - Whether to log the validation result.
+     * @returns {boolean} - Returns true if the entity is allowed, false otherwise.
+     *
+     * @deprecated This method is deprecated and will be removed in future versions. Use validateEntity instead.
+     */
     validateEntityBlackList(device, entity, log = true) {
         if (isValidArray(this.config.entityBlackList, 1) && this.config.entityBlackList.find((e) => e === entity)) {
             if (log)
@@ -136,6 +246,15 @@ export class MatterbridgePlatform {
         }
         return true;
     }
+    /**
+     * Checks and updates the endpoint numbers for Matterbridge devices.
+     *
+     * This method retrieves the list of Matterbridge devices and their child endpoints,
+     * compares their current endpoint numbers with the stored ones, and updates the storage
+     * if there are any changes. It logs the changes and updates the endpoint numbers accordingly.
+     *
+     * @returns {Promise<number>} The size of the updated endpoint map, or -1 if storage is not available.
+     */
     async checkEndpointNumbers() {
         if (!this.storage)
             return -1;
@@ -175,3 +294,4 @@ export class MatterbridgePlatform {
         return endpointMap.size;
     }
 }
+//# sourceMappingURL=matterbridgePlatform.js.map

package/dist/matterbridgePlatform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matterbridgePlatform.js","sourceRoot":"","sources":["../src/matterbridgePlatform.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE9E,oBAAoB;AACpB,OAAO,EAAc,IAAI,EAAE,EAAE,EAAY,EAAE,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAE5E,iBAAiB;AACjB,OAAO,EAAe,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAKtE,iBAAiB;AACjB,OAAO,IAAI,MAAM,MAAM,CAAC;AAWxB;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IACxB,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;IAC1F,OAAO,CAAiC;IACxC,OAAO,CAA0B;IACjC,YAAY,GAAG,IAAI,GAAG,EAA8H,CAAC;IACrJ,YAAY,GAAG,IAAI,GAAG,EAAgE,CAAC;IACvF,mBAAmB,GAAG,IAAI,GAAG,EAAgC,CAAC;IAErE;;;;;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;YAAE,OAAO;QAC7C,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;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;QACpD,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;QAC9D,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,QAAkB;QAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yEAAyE,QAAQ,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,MAA4B;QAC/C,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9D,IAAI,MAAM,CAAC,QAAQ;YAAE,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7E,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,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB;QACxB,MAAM,IAAI,CAAC,YAAY,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;IACnC,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;;;;;;;OAOG;IACH,cAAc,CAAC,MAAyB,EAAE,GAAG,GAAG,IAAI;QAClD,OAAO,IAAI,CAAC,4BAA4B,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;OASG;IACH,4BAA4B,CAAC,MAAyB,EAAE,GAAG,GAAG,IAAI;QAChE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3C,KAAK,MAAM,CAAC,IAAI,MAAM;gBAAE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAAE,gBAAgB,EAAE,CAAC;QACpF,CAAC;QACD,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,GAAG;gBAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;YAChG,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3C,KAAK,MAAM,CAAC,IAAI,MAAM;gBAAE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAAE,eAAe,EAAE,CAAC;QACnF,CAAC;;YAAM,eAAe,EAAE,CAAC;QACzB,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,GAAG;YAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,2BAA2B,CAAC,CAAC;QACpG,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,GAAG,GAAG,IAAI;QACvD,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,uBAAuB,CAAC,MAAc,EAAE,MAAc,EAAE,GAAG,GAAG,IAAI;QAChE,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,SAAS,CAAC,CAAC;QAC5D,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,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW;oBAAE,SAAS;gBAC7C,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;oBAC3I,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oCAAoC,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,GAAG,EAAE,iBAAiB,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,OAAO,IAAI,GAAG,KAAK,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,CAAC;oBACjO,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC5E,CAAC;gBACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;oBAC5D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4CAA4C,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,IAAI,IAAI,GAAG,OAAO,GAAG,EAAE,OAAO,IAAI,GAAG,KAAK,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,CAAC;oBACrJ,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,SAAS,GAAG,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC5E,CAAC;YACH,CAAC;QACH,CAAC;QACD,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACpD,OAAO,WAAW,CAAC,IAAI,CAAC;IAC1B,CAAC;CACF"}

package/dist/matterbridgeTypes.d.ts

@@ -0,0 +1,165 @@
+/**
+ * This file contains the types for Matterbridge.
+ *
+ * @file matterbridgeTypes.ts
+ * @author Luca Liguori
+ * @date 2024-07-12
+ * @version 1.0.2
+ *
+ * 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. *
+ */
+import { NodeStorage } from './storage/export.js';
+import { LogLevel } from './logger/export.js';
+import { MatterbridgePlatform, PlatformConfig, PlatformSchema } from './matterbridgePlatform.js';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+import { FabricIndex, NodeId, VendorId, StorageContext, ServerNode, EndpointNumber, Endpoint as EndpointNode } from '@matter/main';
+import { ExposedFabricInformation } from '@matter/main/protocol';
+import { AggregatorEndpoint } from '@matter/main/endpoints/aggregator';
+export declare const plg = "\u001B[38;5;33m";
+export declare const dev = "\u001B[38;5;79m";
+export declare const typ = "\u001B[38;5;207m";
+export interface RegisteredPlugin extends BaseRegisteredPlugin {
+    nodeContext?: NodeStorage;
+    storageContext?: StorageContext;
+    serverNode?: ServerNode<ServerNode.RootEndpoint>;
+    aggregatorNode?: EndpointNode<AggregatorEndpoint>;
+    device?: MatterbridgeEndpoint;
+    platform?: MatterbridgePlatform;
+    reachabilityTimeout?: NodeJS.Timeout;
+}
+export interface BaseRegisteredPlugin {
+    name: string;
+    version: string;
+    description: string;
+    author: string;
+    path: string;
+    type: string;
+    latestVersion?: string;
+    locked?: boolean;
+    error?: boolean;
+    enabled?: boolean;
+    loaded?: boolean;
+    started?: boolean;
+    configured?: boolean;
+    paired?: boolean;
+    fabricInformations?: SanitizedExposedFabricInformation[];
+    sessionInformations?: SanitizedSessionInformation[];
+    registeredDevices?: number;
+    addedDevices?: number;
+    qrPairingCode?: string;
+    manualPairingCode?: string;
+    configJson?: PlatformConfig;
+    schemaJson?: PlatformSchema;
+}
+export interface SystemInformation {
+    interfaceName: string;
+    macAddress: string;
+    ipv4Address: string;
+    ipv6Address: string;
+    nodeVersion: string;
+    hostname: string;
+    user: string;
+    osType: string;
+    osRelease: string;
+    osPlatform: string;
+    osArch: string;
+    totalMemory: string;
+    freeMemory: string;
+    systemUptime: string;
+}
+export interface MatterbridgeInformation {
+    homeDirectory: string;
+    rootDirectory: string;
+    matterbridgeDirectory: string;
+    matterbridgePluginDirectory: string;
+    globalModulesDirectory: string;
+    matterbridgeVersion: string;
+    matterbridgeLatestVersion: string;
+    matterbridgeQrPairingCode: string | undefined;
+    matterbridgeManualPairingCode: string | undefined;
+    matterbridgeFabricInformations: SanitizedExposedFabricInformation[] | undefined;
+    matterbridgeSessionInformations: SanitizedSessionInformation[] | undefined;
+    matterbridgePaired: boolean | undefined;
+    bridgeMode: string;
+    restartMode: string;
+    readOnly: boolean;
+    profile?: string;
+    loggerLevel: LogLevel;
+    fileLogger: boolean;
+    matterLoggerLevel: number;
+    matterFileLogger: boolean;
+    mattermdnsinterface: string | undefined;
+    matteripv4address: string | undefined;
+    matteripv6address: string | undefined;
+    matterPort: number;
+    matterDiscriminator: number | undefined;
+    matterPasscode: number | undefined;
+    restartRequired: boolean;
+    refreshRequired: boolean;
+}
+export interface SanitizedExposedFabricInformation {
+    fabricIndex: FabricIndex;
+    fabricId: string;
+    nodeId: string;
+    rootNodeId: string;
+    rootVendorId: VendorId;
+    rootVendorName: string;
+    label: string;
+}
+export interface SessionInformation {
+    name: string;
+    nodeId: NodeId;
+    peerNodeId: NodeId;
+    fabric?: ExposedFabricInformation;
+    isPeerActive: boolean;
+    secure: boolean;
+    lastInteractionTimestamp?: number;
+    lastActiveTimestamp?: number;
+    numberOfActiveSubscriptions: number;
+}
+export interface SanitizedSessionInformation {
+    name: string;
+    nodeId: string;
+    peerNodeId: string;
+    fabric?: SanitizedExposedFabricInformation;
+    isPeerActive: boolean;
+    secure: boolean;
+    lastInteractionTimestamp?: string;
+    lastActiveTimestamp?: string;
+    numberOfActiveSubscriptions: number;
+}
+export interface ApiDevices {
+    pluginName: string;
+    type: string;
+    endpoint: EndpointNumber | undefined;
+    name: string;
+    serial: string;
+    productUrl: string;
+    configUrl?: string;
+    uniqueId: string;
+    cluster: string;
+}
+export interface ApiClusters {
+    endpoint: string;
+    id: string;
+    deviceTypes: number[];
+    clusterName: string;
+    clusterId: string;
+    attributeName: string;
+    attributeId: string;
+    attributeValue: string;
+    attributeLocalValue: unknown;
+}
+//# sourceMappingURL=matterbridgeTypes.d.ts.map

package/dist/matterbridgeTypes.d.ts.map

@@ -0,0 +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,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;CAC7B;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;CACtB;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,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,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,eAAe,EAAE,OAAO,CAAC;CAC1B;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,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"}

package/dist/matterbridgeTypes.js

@@ -1,3 +1,27 @@
+/**
+ * This file contains the types for Matterbridge.
+ *
+ * @file matterbridgeTypes.ts
+ * @author Luca Liguori
+ * @date 2024-07-12
+ * @version 1.0.2
+ *
+ * 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. *
+ */
+// Default colors
 export const plg = '\u001B[38;5;33m';
 export const dev = '\u001B[38;5;79m';
 export const typ = '\u001B[38;5;207m';
+//# sourceMappingURL=matterbridgeTypes.js.map

package/dist/matterbridgeTypes.js.map

@@ -0,0 +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"}