matterbridge 2.0.0 → 2.1.0-dev.2

package/dist/matterbridgePlatform.js

@@ -1,59 +1,23 @@
-/**
- * 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 = ''; // Will be set by the loadPlugin() method using the package.json value.
-    type = ''; // Will be set by the extending classes.
-    version = ''; // Will be set by the loadPlugin() method using the package.json value.
+    name = '';
+    type = '';
+    version = '1.0.0';
     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)}`);
@@ -65,74 +29,36 @@ 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) => {
@@ -157,27 +83,9 @@ 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];
@@ -207,27 +115,9 @@ 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)
@@ -246,15 +136,6 @@ 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;
@@ -294,4 +175,3 @@ export class MatterbridgePlatform {
         return endpointMap.size;
     }
 }
-//# sourceMappingURL=matterbridgePlatform.js.map

package/dist/matterbridgeTypes.js

@@ -1,31 +1,3 @@
-/**
- * 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 { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
-// Default colors
 export const plg = '\u001B[38;5;33m';
 export const dev = '\u001B[38;5;79m';
 export const typ = '\u001B[38;5;207m';
-// Define an alias for MatterbridgeEndpoint by extending it
-export class MatterbridgeDevice extends MatterbridgeEndpoint {
-}
-//# sourceMappingURL=matterbridgeTypes.js.map