matterbridge 3.5.0 → 3.5.1-dev-20260122-6461be3

package/dist/matterbridgeEndpointTypes.d.ts

@@ -1,26 +1,3 @@
-/**
- * This file contains the types for MatterbridgeEndpoint.
- *
- * @file matterbridgeEndpointTypes.ts
- * @author Luca Liguori
- * @created 2025-11-10
- * @version 1.0.0
- * @license Apache-2.0
- *
- * 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 { Semtag } from '@matter/types/globals';
 import { ClusterId, EndpointNumber } from '@matter/types/datatype';
 import { HandlerFunction } from '@matter/general';
@@ -111,56 +88,9 @@ export interface SerializedMatterbridgeEndpoint {
     id: string | undefined;
     clusterServersId: ClusterId[];
 }
-/**
- *  MatterbridgeEndpointOptions interface is used to define the options for a Matterbridge endpoint.
- *
- *  @remarks
- *  - tagList?: Semtag[]. It is used to disambiguate the sibling child endpoints (9.2.3. Disambiguation rule).
- *    - mfgCode: VendorId | null,
- *    - namespaceId: number,
- *    - tag: number,
- *    - label: string | undefined | null
- *  - mode?: 'server' | 'matter'. It is used to activate a special mode for the endpoint.
- *  - id?: string. It is the unique storage key for the endpoint.
- *  - number?: EndpointNumber. It is the endpoint number for the endpoint.
- */
 export interface MatterbridgeEndpointOptions {
-    /**
-     *  The semantic tags array for the endpoint.
-     *  The tagList is used to disambiguate the sibling child endpoints (9.2.3. Disambiguation rule).
-     *  The tagList is used to identify the endpoint and to provide additional information about the endpoint.
-     *
-     *  @remarks
-     *    - mfgCode: VendorId | null,
-     *    - namespaceId: number,
-     *    - tag: number,
-     *    - label: string | undefined | null
-     */
     tagList?: Semtag[];
-    /**
-     * Activates a special mode for this endpoint.
-     * - 'server': it creates the device server node and add the device as Matter device that needs to be paired individually.
-     *   In this case the Matterbridge bridge mode (bridge or childbridge) is not relevant. The device is independent.
-     *
-     * - 'matter': it adds the device directly to the Matterbridge server node as Matter device alongside the aggregator. In this case the implementation must respect
-     *   the 9.2.3. Disambiguation rule (i.e. use taglist if needed cause the device doesn't have nodeLabel).
-     *   Furthermore the device will be a part of the bridge (i.e. will have the same name and will be in the same room).
-     *   See 9.12.2.2. Native Matter functionality in Bridge.
-     *
-     * @remarks
-     * Always use createDefaultBasicInformationClusterServer() to create the BasicInformation cluster server when using mode 'server' or 'matter'.
-     */
     mode?: 'server' | 'matter';
-    /**
-     * The unique storage key for the endpoint.
-     * If not provided, a default key will be used.
-     */
     id?: string;
-    /**
-     * The endpoint number for the endpoint.
-     * If not provided, the endpoint will be created with the next available endpoint number.
-     * If provided, the endpoint will be created with the specified endpoint number.
-     */
     number?: EndpointNumber;
 }
-//# sourceMappingURL=matterbridgeEndpointTypes.d.ts.map

package/dist/matterbridgeEndpointTypes.js

@@ -1,28 +1,3 @@
-/**
- * This file contains the types for MatterbridgeEndpoint.
- *
- * @file matterbridgeEndpointTypes.ts
- * @author Luca Liguori
- * @created 2025-11-10
- * @version 1.0.0
- * @license Apache-2.0
- *
- * 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.
- */
-// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mMatterbridgeEndpointTypes loaded.\u001B[40;0m');
 export {};
-//# sourceMappingURL=matterbridgeEndpointTypes.js.map

package/dist/matterbridgePlatform.d.ts

@@ -1,35 +1,10 @@
-/**
- * This file contains the class MatterbridgePlatform.
- *
- * @file matterbridgePlatform.ts
- * @author Luca Liguori
- * @created 2024-03-21
- * @version 1.6.1
- * @license Apache-2.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 { AnsiLogger, LogLevel } from 'node-ansi-logger';
 import { NodeStorage } from 'node-persist-manager';
 import { EndpointNumber, VendorId } from '@matter/types/datatype';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { ApiSelectDevice, ApiSelectEntity } from './frontendTypes.js';
 import { SystemInformation } from './matterbridgeTypes.js';
-/** Platform configuration value type. */
 export type PlatformConfigValue = string | number | boolean | bigint | object | undefined | null;
-/** Platform configuration type. */
 export type PlatformConfig = {
     name: string;
     type: string;
@@ -37,11 +12,8 @@ export type PlatformConfig = {
     debug: boolean;
     unregisterOnShutdown: boolean;
 } & Record<string, PlatformConfigValue>;
-/** Platform schema value type. */
 export type PlatformSchemaValue = string | number | boolean | bigint | object | undefined | null;
-/** Platform schema type. */
 export type PlatformSchema = Record<string, PlatformSchemaValue>;
-/** A type representing a subset of readonly properties of Matterbridge for platform use. */
 export type PlatformMatterbridge = {
     readonly systemInformation: Readonly<Pick<SystemInformation, 'interfaceName' | 'macAddress' | 'ipv4Address' | 'ipv6Address' | 'nodeVersion' | 'hostname' | 'user' | 'osType' | 'osRelease' | 'osPlatform' | 'osArch' | 'totalMemory' | 'freeMemory' | 'systemUptime' | 'processUptime' | 'cpuUsage' | 'processCpuUsage' | 'rss' | 'heapTotal' | 'heapUsed'>>;
     readonly rootDirectory: string;
@@ -62,349 +34,58 @@ export type PlatformMatterbridge = {
     readonly aggregatorProductId: number;
     readonly aggregatorProductName: string;
 };
-/**
- * Represents the base Matterbridge platform. It is extended by the MatterbridgeAccessoryPlatform and MatterbridgeServicePlatform classes.
- *
- */
 export declare class MatterbridgePlatform {
     #private;
-    /** The PlatformMatterbridge instance of this Platform. */
     readonly matterbridge: PlatformMatterbridge;
-    /** The logger instance for this platform. Created by the PluginManager.load() method. */
     readonly log: AnsiLogger;
-    /** The configuration for this platform. Set by the PluginManager.load() method using the stored config file. */
     config: PlatformConfig;
-    /** The name of the platform. Set by the PluginManager.load() method using the package.json name value. */
     name: string;
-    /** The type of the platform. Set by the extending classes: MatterbridgeDynamicPlatform and MatterbridgeAccessoryPlatform */
     type: 'DynamicPlatform' | 'AccessoryPlatform' | 'AnyPlatform';
-    /** The version of the platform. Set by the PluginManager.load() method using the package.json version value. */
     version: string;
-    /** Platform context in the storage of matterbridgeDirectory. Use await platform.ready to access it early. */
     context?: NodeStorage;
-    /** Indicates whether the platform is is fully initialized (including context and selects). */
     isReady: boolean;
-    /** Indicates whether the platform has been loaded. */
     isLoaded: boolean;
-    /** Indicates whether the platform has been started. */
     isStarted: boolean;
-    /** Indicates whether the platform has been configured. */
     isConfigured: boolean;
-    /** Indicates whether the platform is shutting down. */
     isShuttingDown: boolean;
-    /** The ready promise for the platform, which resolves when the platform is fully initialized (including context and selects). Await platform.ready if you access the platform context or select early. */
     readonly ready: Promise<void>;
-    /**
-     * MatterNode helpers injected by the PluginManager.load() method
-     *
-     * @param {(pluginName: string, device: MatterbridgeEndpoint) => Promise<void>} addBridgedEndpoint - Function to add a bridged endpoint.
-     * @param {(pluginName: string, device: MatterbridgeEndpoint) => Promise<void>} removeBridgedEndpoint - Function to remove a bridged endpoint.
-     * @param {(pluginName: string, delay?: number) => Promise<void>} removeAllBridgedEndpoints - Function to remove all bridged endpoints.
-     * @param {(pluginName: string, name: string, type: 'light' | 'outlet' | 'switch' | 'mounted_switch', callback: () => Promise<void>) => Promise<boolean>} addVirtualEndpoint - Function to add a virtual endpoint.
-     */
     private setMatterNode;
-    /**
-     * Creates an instance of the base MatterbridgePlatform.
-     * Each plugin must extend the MatterbridgeDynamicPlatform or MatterbridgeAccessoryPlatform class.
-     * MatterbridgePlatform cannot be instantiated directly, it can only be extended by the MatterbridgeDynamicPlatform or MatterbridgeAccessoryPlatform class.
-     *
-     * @param {PlatformMatterbridge} matterbridge - The PlatformMatterbridge instance.
-     * @param {AnsiLogger} log - The logger instance.
-     * @param {PlatformConfig} config - The platform configuration.
-     */
     protected constructor(matterbridge: PlatformMatterbridge, log: AnsiLogger, config: PlatformConfig);
-    /**
-     * Destroys the platform, cleaning up memory, closing storage and broadcast server.
-     */
     private destroy;
-    /**
-     * This method shall be overridden in the extended class.
-     * It is called when the platform is started.
-     * Use this method to create the MatterbridgeEndpoints and call this.registerDevice().
-     *
-     * @param {string} [reason] - The reason for starting.
-     * @throws {Error} - Throws an error if the method is not overridden.
-     */
     onStart(reason?: string): Promise<void>;
-    /**
-     * This method can be overridden in the extended class. In this case always call super.onConfigure() to save the select and run checkEndpointNumbers().
-     * It is called after the platform has started.
-     * Use this method to perform any configuration of your devices and to override the value of the attributes that are persistent and stored in the
-     * matter storage (i.e. the onOff attribute of the OnOff cluster).
-     */
     onConfigure(): Promise<void>;
-    /**
-     * This method can be overridden in the extended class. In this case always call super.onShutdown() to save the selects, run checkEndpointNumbers() and cleanup memory.
-     * It is called when the platform is shutting down.
-     * Use this method to clean up any resources you used in the constructor or onStart.
-     *
-     * @param {string} [reason] - The reason for shutting down.
-     */
     onShutdown(reason?: string): Promise<void>;
-    /**
-     * Called when the logger level is changed.
-     *
-     * @param {LogLevel} logLevel The new logger level.
-     */
     onChangeLoggerLevel(logLevel: LogLevel): Promise<void>;
-    /**
-     * Called when a plugin config includes an action button or an action button with text field.
-     *
-     * @param {string} action The action triggered by the button in plugin config.
-     * @param {string} value The value of the field of the action button.
-     * @param {string} id The id of the schema associated with the action.
-     * @param {PlatformConfig} formData The changed form data of the plugin.
-     *
-     * @remarks
-     * This method can be overridden in the extended class.
-     *
-     * @example
-     * Use this method to handle the action defined in the plugin schema:
-     * ```json
-     *  "addDevice": {
-     *      "description": "Manually add a device that has not been discovered with mdns:",
-     *      "type": "boolean",
-     *      "buttonText": "ADD",      // The text on the button. This is used when the action doesn't include a text field.
-     *      "buttonField": "ADD",     // The text on the button. This is used when the action includes a text field.
-     *      "buttonClose": false,     // optional, default is false. When true, the dialog will close after the action is sent.
-     *      "buttonSave": false,      // optional, default is false. When true, the dialog will close and trigger the restart required after the action is sent.
-     *      "textPlaceholder": "Enter the device IP address",   // optional: the placeholder text for the text field.
-     *      "default": false
-     *  },
-     * ```
-     */
     onAction(action: string, value?: string, id?: string, formData?: PlatformConfig): Promise<void>;
-    /**
-     * Called when the plugin config has been updated.
-     *
-     * @param {PlatformConfig} config The new plugin config.
-     */
     onConfigChanged(config: PlatformConfig): Promise<void>;
-    /**
-     * Save the platform configuration to the platform config JSON.
-     *
-     * @param {PlatformConfig} [config] - The platform configuration to save.
-     * @returns {void}
-     */
     saveConfig(config: PlatformConfig): void;
-    /**
-     * Get the platform schema for the config editor. This will retrieve the schema from the Matterbridge plugin manager.
-     *
-     * @returns {Promise<PlatformSchema | undefined>} The platform schema.
-     */
     getSchema(): Promise<PlatformSchema | undefined>;
-    /**
-     * Set the platform schema for the config editor. This will update the schema in the Matterbridge plugin manager but will not change the schema file.
-     * It must be called from onStart() to update the schema in the plugin.
-     * Calling this method from the platform constructor will have no effect.
-     *
-     * @param {PlatformSchema} [schema] - The platform schema to set.
-     * @returns {void}
-     */
     setSchema(schema: PlatformSchema): void;
-    /**
-     * Sends a restart required message to the frontend.
-     *
-     * @param {boolean} [snackbar] - If true, shows a snackbar notification. Default is true.
-     * @param {boolean} [fixed] - If true, shows a fixed notification. Default is false.
-     * @returns {void}
-     */
     wssSendRestartRequired(snackbar?: boolean, fixed?: boolean): void;
-    /**
-     * Sends an open snackbar message to all connected clients.
-     *
-     * @param {string} message - The message to send.
-     * @param {number} timeout - The timeout in seconds for the snackbar message. Default is 5 seconds.
-     * @param {'info' | 'warning' | 'error' | 'success'} severity - The severity of the message.
-     * possible values are: 'info', 'warning', 'error', 'success'. Default is 'info'.
-     *
-     * @remarks
-     * If timeout is 0, the snackbar message will be displayed until closed by the user.
-     */
     wssSendSnackbarMessage(message: string, timeout?: number, severity?: 'error' | 'success' | 'info' | 'warning'): void;
-    /**
-     * Retrieves the number of devices registered with the platform.
-     *
-     * @returns {number} The number of registered devices.
-     */
     size(): number;
-    /**
-     * Retrieves the devices registered with the platform.
-     *
-     * @returns {MatterbridgeEndpoint[]} The registered devices.
-     */
     getDevices(): MatterbridgeEndpoint[];
-    /**
-     * Retrieves a registered device by its name.
-     *
-     * @param {string} deviceName - The device name to search for.
-     * @returns {MatterbridgeEndpoint | undefined} The registered device or undefined if not found.
-     */
     getDeviceByName(deviceName: string): MatterbridgeEndpoint | undefined;
-    /**
-     * Retrieves a registered device by its uniqueId.
-     *
-     * @param {string} uniqueId - The device unique ID to search for.
-     * @returns {MatterbridgeEndpoint | undefined} The registered device or undefined if not found.
-     */
     getDeviceByUniqueId(uniqueId: string): MatterbridgeEndpoint | undefined;
-    /**
-     * Retrieves a registered device by its serialNumber.
-     *
-     * @param {string} serialNumber - The device serial number to search for.
-     * @returns {MatterbridgeEndpoint | undefined} The registered device or undefined if not found.
-     */
     getDeviceBySerialNumber(serialNumber: string): MatterbridgeEndpoint | undefined;
-    /**
-     * Retrieves a registered device by its id.
-     *
-     * @param {string} id - The device id to search for.
-     * @returns {MatterbridgeEndpoint | undefined} The registered device or undefined if not found.
-     */
     getDeviceById(id: string): MatterbridgeEndpoint | undefined;
-    /**
-     * Retrieves a registered device by its originalId.
-     *
-     * @param {string} originalId - The device originalId to search for.
-     * @returns {MatterbridgeEndpoint | undefined} The registered device or undefined if not found.
-     */
     getDeviceByOriginalId(originalId: string): MatterbridgeEndpoint | undefined;
-    /**
-     * Retrieves a registered device by its number.
-     *
-     * @param {EndpointNumber | number} number - The device number to search for.
-     * @returns {MatterbridgeEndpoint | undefined} The registered device or undefined if not found.
-     */
     getDeviceByNumber(number: EndpointNumber | number): MatterbridgeEndpoint | undefined;
-    /**
-     * Checks if a device with this name is already registered in the platform.
-     *
-     * @param {string} deviceName - The device name to check.
-     * @returns {boolean} True if the device is already registered, false otherwise.
-     */
     hasDeviceName(deviceName: string): boolean;
-    /**
-     * Checks if a device with this uniqueId is already registered in the platform.
-     *
-     * @param {string} deviceUniqueId - The device unique ID to check.
-     * @returns {boolean} True if the device is already registered, false otherwise.
-     */
     hasDeviceUniqueId(deviceUniqueId: string): boolean;
-    /**
-     * Registers a virtual device with the Matterbridge platform.
-     * Virtual devices are only supported in bridge mode and childbridge mode with a DynamicPlatform.
-     *
-     * The virtual device is created as an instance of `Endpoint` with the provided device type.
-     * When the virtual device is turned on, the provided callback function is executed.
-     * The onOff state of the virtual device always reverts to false when the device is turned on.
-     *
-     * @param { string } name - The name of the virtual device.
-     * @param { 'light' | 'outlet' | 'switch' | 'mounted_switch' } type - The type of the virtual device.
-     * @param { () => Promise<void> } callback - The callback to call when the virtual device is turned on.
-     *
-     * @returns {Promise<boolean>} A promise that resolves to true if the virtual device was successfully registered, false otherwise.
-     *
-     * @remarks
-     * The virtual devices don't show up in the device list of the frontend.
-     * Type 'switch' is not supported by Alexa and 'mounted_switch' is not supported by Apple Home.
-     */
     registerVirtualDevice(name: string, type: 'light' | 'outlet' | 'switch' | 'mounted_switch', callback: () => Promise<void>): Promise<boolean>;
-    /**
-     * Registers a device with the Matterbridge platform and performs validation checks.
-     *
-     * This method also checks if the implementation called createDefaultBasicInformationClusterServer() instead of createDefaultBridgedDeviceBasicInformationClusterServer().
-     *
-     * This is correct with Accessory platforms so we check if we are running in bridge mode and add the bridgedNode and the BridgedDeviceBasicInformation cluster.
-     *
-     * If we are in bridge mode, we add the bridgedNode device type and the BridgedDeviceBasicInformation cluster.
-     *
-     * If we are in childbridge mode and the plugin is a 'DynamicPlatform', we add the bridgedNode device type and the BridgedDeviceBasicInformation cluster.
-     *
-     * if we are in childbridge mode and the plugin is a 'AccessoryPlatform', the device is not bridged so no action is taken.
-     *
-     * If the device.mode = 'server', the device is not bridged so no action is taken.
-     *
-     * If the device.mode = 'matter', the device is not bridged so no action is taken.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to register.
-     */
     registerDevice(device: MatterbridgeEndpoint): Promise<void>;
-    /**
-     * Unregisters a device registered with the Matterbridge platform.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to unregister.
-     */
     unregisterDevice(device: MatterbridgeEndpoint): Promise<void>;
-    /**
-     * Unregisters all devices registered with the Matterbridge platform.
-     *
-     * @param {number} [delay] - The delay in milliseconds between removing each bridged endpoint (default: 0).
-     */
     unregisterAllDevices(delay?: number): Promise<void>;
-    /**
-     * Saves the select devices and entities to storage.
-     *
-     * This method saves the current state of `selectDevice` and `selectEntity` maps to their respective storage.
-     * It logs the number of items being saved and ensures that the storage is properly closed after saving.
-     *
-     * @returns {Promise<void>} A promise that resolves when the save operation is complete.
-     */
     private saveSelects;
-    /**
-     * Clears all the select device and entity maps and saves the changes to the storage.
-     *
-     * @returns {void}
-     */
     clearSelect(): Promise<void>;
-    /**
-     * Clears the select for a single device and saves the changes to the storage.
-     *
-     * @param {string} serial - The serial of the device to clear.
-     * @returns {void}
-     */
     clearDeviceSelect(serial: string): Promise<void>;
-    /**
-     * Clears the select for a single entity and saves the changes to the storage.
-     *
-     * @param {string} name - The name of the entity to clear.
-     * @returns {void}
-     */
     clearEntitySelect(name: string): Promise<void>;
-    /**
-     * Set the select device in the platform map.
-     *
-     * @param {string} serial - The serial number of the device.
-     * @param {string} name - The name of the device.
-     * @param {string} [configUrl] - The configuration URL of the device.
-     * @param {string} [icon] - The icon of the device: 'wifi', 'ble', 'hub'
-     * @param {Array<{ name: string; description: string; icon?: string }>} [entities] - The entities associated with the device.
-     * @returns {void}
-     *
-     * @remarks
-     * In the schema use selectFrom: 'serial' or 'name'
-     * ```json
-     * "whiteList": {
-     *   "description": "Only the devices in the list will be exposed.",
-     *   "type": "array",
-     *   "items": {
-     *     "type": "string"
-     *   },
-     *   "uniqueItems": true,
-     *   "selectFrom": "name"
-     * },
-     * ```
-     */
     setSelectDevice(serial: string, name: string, configUrl?: string, icon?: string, entities?: {
         name: string;
         description: string;
         icon?: string;
     }[]): void;
-    /**
-     * Retrieve a select device by serial.
-     *
-     * @param {string} serial - The serial number of the device.
-     * @returns {{ serial: string; name: string; configUrl?: string; icon?: string; entities?: { name: string; description: string; icon?: string }[] } | undefined} The select device or undefined if not found.
-     */
     getSelectDevice(serial: string): {
         serial: string;
         name: string;
@@ -416,124 +97,18 @@ export declare class MatterbridgePlatform {
             icon?: string;
         }[];
     } | undefined;
-    /**
-     * Set the select device entity in the platform map.
-     *
-     * @param {string} serial - The serial number of the device.
-     * @param {string} entityName - The name of the entity.
-     * @param {string} entityDescription - The description of the entity.
-     * @param {string} [entityIcon] - The icon of the entity: 'wifi', 'ble', 'hub', 'component', 'matter'
-     * @returns {void}
-     *
-     * @remarks
-     * In the schema use selectDeviceEntityFrom: 'name' or 'description'
-     * ```json
-     * "deviceEntityBlackList": {
-     *   "description": "List of entities not to be exposed for a single device.",
-     *   "type": "object",
-     *   "uniqueItems": true,
-     *   "selectFrom": "name",
-     *   "additionalProperties": {
-     *     "description": "List of entities not to be exposed for this device.",
-     *     "type": "array",
-     *     "items": {
-     *       "type": "string"
-     *     },
-     *     "uniqueItems": true,
-     *     "selectDeviceEntityFrom": "name"
-     *   }
-     * },
-     * ```
-     */
     setSelectDeviceEntity(serial: string, entityName: string, entityDescription: string, entityIcon?: string): void;
-    /**
-     * Retrieves the select devices from the platform map.
-     *
-     * @returns {ApiSelectDevice[]} The selected devices array.
-     */
     getSelectDevices(): ApiSelectDevice[];
-    /**
-     * Set the select entity in the platform map.
-     *
-     * @param {string} name - The entity name.
-     * @param {string} description - The entity description.
-     * @param {string} [icon] - The entity icon: 'wifi', 'ble', 'hub', 'component', 'matter'
-     * @returns {void}
-     *
-     * @remarks
-     * In the schema use selectEntityFrom: 'name' or 'description'
-     * ```json
-     * "entityBlackList": {
-     *   "description": "The entities in the list will not be exposed.",
-     *   "type": "array",
-     *   "items": {
-     *     "type": "string"
-     *   },
-     *   "uniqueItems": true,
-     *   "selectEntityFrom": "name"
-     * },
-     * ```
-     */
     setSelectEntity(name: string, description: string, icon?: string): void;
-    /**
-     * Retrieve a select entity by name.
-     *
-     * @param {string} name - The name of the entity.
-     * @returns {{ name: string; description: string; icon?: string } | undefined} The select entity or undefined if not found.
-     */
     getSelectEntity(name: string): {
         name: string;
         description: string;
         icon?: string | undefined;
     } | undefined;
-    /**
-     * Retrieve the select entities.
-     *
-     * @returns {ApiSelectEntity[]} The select entities array.
-     */
     getSelectEntities(): ApiSelectEntity[];
-    /**
-     * Verifies if the Matterbridge version meets the required version.
-     * If not, it destroys the platform cause the implementation may not call destroy().
-     *
-     * @param {string} requiredVersion - The required version to compare against.
-     * @param {boolean} [destroy] - Whether to destroy the platform if the version check fails. Default is true.
-     * @returns {boolean} True if the Matterbridge version meets or exceeds the required version, false otherwise.
-     */
     verifyMatterbridgeVersion(requiredVersion: string, destroy?: boolean): boolean;
-    /**
-     * 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] - Whether to log the validation result.
-     * @returns {boolean} - Returns true if the device is allowed, false otherwise.
-     */
     validateDevice(device: string | string[], log?: boolean): boolean;
-    /**
-     * 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] - Whether to log the validation result.
-     * @returns {boolean} - Returns true if the entity is allowed, false otherwise.
-     */
     validateEntity(device: string, entity: string, log?: boolean): boolean;
-    /**
-     * Clears all stored endpoint numbers for checkEndpointNumbers().
-     *
-     * @returns {Promise<void>} A promise that resolves when the endpoint numbers have been cleared.
-     */
     private clearEndpointNumbers;
-    /**
-     * 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.
-     */
     private checkEndpointNumbers;
 }
-//# sourceMappingURL=matterbridgePlatform.d.ts.map