matterbridge 3.0.4 → 3.0.5-dev-20250526-422f029

package/dist/matterbridgeEndpointHelpers.js

@@ -1,8 +1,5 @@
-// src\matterbridgeEndpointHelpers.ts
-// @matter
 import { Lifecycle } from '@matter/main';
 import { getClusterNameById } from '@matter/main/types';
-// @matter clusters
 import { PowerSource } from '@matter/main/clusters/power-source';
 import { UserLabel } from '@matter/main/clusters/user-label';
 import { FixedLabel } from '@matter/main/clusters/fixed-label';
@@ -45,7 +42,6 @@ import { Pm10ConcentrationMeasurement } from '@matter/main/clusters/pm10-concent
 import { RadonConcentrationMeasurement } from '@matter/main/clusters/radon-concentration-measurement';
 import { TotalVolatileOrganicCompoundsConcentrationMeasurement } from '@matter/main/clusters/total-volatile-organic-compounds-concentration-measurement';
 import { OperationalState } from '@matter/main/clusters/operational-state';
-// @matter behaviors
 import { PowerSourceServer } from '@matter/main/behaviors/power-source';
 import { UserLabelServer } from '@matter/main/behaviors/user-label';
 import { FixedLabelServer } from '@matter/main/behaviors/fixed-label';
@@ -75,10 +71,8 @@ import { Pm25ConcentrationMeasurementServer } from '@matter/main/behaviors/pm25-
 import { Pm10ConcentrationMeasurementServer } from '@matter/main/behaviors/pm10-concentration-measurement';
 import { RadonConcentrationMeasurementServer } from '@matter/main/behaviors/radon-concentration-measurement';
 import { TotalVolatileOrganicCompoundsConcentrationMeasurementServer } from '@matter/main/behaviors/total-volatile-organic-compounds-concentration-measurement';
-// Other modules
 import { createHash } from 'node:crypto';
 import { BLUE, CYAN, db, debugStringify, er, hk, or, YELLOW, zb } from 'node-ansi-logger';
-// Matterbridge
 import { deepCopy, deepEqual, isValidArray } from './utils/export.js';
 import { MatterbridgeIdentifyServer, MatterbridgeOnOffServer, MatterbridgeLevelControlServer, MatterbridgeColorControlServer, MatterbridgeLiftWindowCoveringServer, MatterbridgeThermostatServer, MatterbridgeFanControlServer, MatterbridgeDoorLockServer, MatterbridgeModeSelectServer, MatterbridgeValveConfigurationAndControlServer, MatterbridgeSmokeCoAlarmServer, MatterbridgeBooleanStateConfigurationServer, MatterbridgeOperationalStateServer, } from './matterbridgeBehaviors.js';
 export function capitalizeFirstLetter(name) {
@@ -93,19 +87,19 @@ export function lowercaseFirstLetter(name) {
 }
 export function checkNotLatinCharacters(deviceName) {
     const nonLatinRegexList = [
-        /[\u0400-\u04FF\u0500-\u052F]/, // Cyrillic
-        /[\u2E80-\u9FFF]/, // CJK (Chinese, Japanese, Korean)
-        /[\uAC00-\uD7AF]/, // Korean Hangul
-        /[\u0600-\u06FF\u0750-\u077F]/, // Arabic, Persian
-        /[\u0590-\u05FF]/, // Hebrew
-        /[\u0900-\u097F]/, // Devanagari (Hindi, Sanskrit)
-        /[\u0E00-\u0E7F]/, // Thai
-        /[\u1200-\u137F]/, // Ethiopic (Amharic, Tigrinya)
+        /[\u0400-\u04FF\u0500-\u052F]/,
+        /[\u2E80-\u9FFF]/,
+        /[\uAC00-\uD7AF]/,
+        /[\u0600-\u06FF\u0750-\u077F]/,
+        /[\u0590-\u05FF]/,
+        /[\u0900-\u097F]/,
+        /[\u0E00-\u0E7F]/,
+        /[\u1200-\u137F]/,
     ];
     return nonLatinRegexList.some((regex) => regex.test(deviceName));
 }
 export function generateUniqueId(deviceName) {
-    return createHash('md5').update(deviceName).digest('hex'); // MD5 hash of the device name
+    return createHash('md5').update(deviceName).digest('hex');
 }
 export function createUniqueId(param1, param2, param3, param4) {
     const hash = createHash('md5');
@@ -113,7 +107,6 @@ export function createUniqueId(param1, param2, param3, param4) {
     return hash.digest('hex');
 }
 export function getBehaviourTypesFromClusterServerIds(clusterServerList) {
-    // Map Server ClusterId to Behavior.Type
     const behaviorTypes = [];
     clusterServerList.forEach((clusterId) => {
         behaviorTypes.push(getBehaviourTypeFromClusterServerId(clusterId));
@@ -121,15 +114,12 @@ export function getBehaviourTypesFromClusterServerIds(clusterServerList) {
     return behaviorTypes;
 }
 export function getBehaviourTypesFromClusterClientIds(clusterClientList) {
-    // Map Client ClusterId to Behavior.Type
     const behaviorTypes = [];
     clusterClientList.forEach((_clusterId) => {
-        // behaviorTypes.push(getBehaviourTypeFromClusterClientId(clusterId));
     });
     return behaviorTypes;
 }
 export function getBehaviourTypeFromClusterServerId(clusterId) {
-    // Map ClusterId to Server Behavior.Type
     if (clusterId === PowerSource.Cluster.id)
         return PowerSourceServer.with(PowerSource.Feature.Wired);
     if (clusterId === UserLabel.Cluster.id)
@@ -217,8 +207,6 @@ export function getBehaviourTypeFromClusterServerId(clusterId) {
     return MatterbridgeIdentifyServer;
 }
 export function getBehaviourTypeFromClusterClientId(_clusterId) {
-    // Map ClusterId to Client Behavior.Type
-    // return IdentifyClient;
 }
 export function getBehavior(endpoint, cluster) {
     let behavior;
@@ -236,11 +224,6 @@ export function getBehavior(endpoint, cluster) {
     }
     return behavior;
 }
-/**
- * Invokes a command on the specified behavior of the endpoint. Used ONLY in Jest tests.
- *
- * @deprecated Used ONLY in Jest tests.
- */
 export async function invokeBehaviorCommand(endpoint, cluster, command, params) {
     const behaviorId = getBehavior(endpoint, cluster)?.id;
     if (!behaviorId) {
@@ -248,7 +231,6 @@ export async function invokeBehaviorCommand(endpoint, cluster, command, params)
         return false;
     }
     await endpoint.act((agent) => {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
         const behavior = agent[behaviorId];
         if (!(command in behavior) || typeof behavior[command] !== 'function') {
             endpoint.log?.error(`invokeBehaviorCommand error: command ${hk}${command}${er} not found on agent for endpoint ${or}${endpoint.maybeId}${er}:${or}${endpoint.maybeNumber}${er}`);
@@ -286,13 +268,6 @@ export function addOptionalClusterServers(endpoint) {
     });
     addClusterServers(endpoint, optionalServerList);
 }
-/**
- * Adds cluster servers to the specified endpoint based on the provided server list.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
- * @param {ClusterId[]} serverList - The list of cluster IDs to add.
- * @returns void
- */
 export function addClusterServers(endpoint, serverList) {
     if (serverList.includes(PowerSource.Cluster.id))
         endpoint.createDefaultPowerSourceWiredClusterServer();
@@ -368,16 +343,7 @@ export function addClusterServers(endpoint, serverList) {
         endpoint.createDefaultRadonConcentrationMeasurementClusterServer();
     if (serverList.includes(TotalVolatileOrganicCompoundsConcentrationMeasurement.Cluster.id))
         endpoint.createDefaultTvocMeasurementClusterServer();
-    // if (serverList.includes(DeviceEnergyManagement.Cluster.id)) endpoint.createDefaultDeviceEnergyManagementClusterServer();
-    // if (serverList.includes(DeviceEnergyManagementMode.Cluster.id)) endpoint.createDefaultDeviceEnergyManagementModeClusterServer();
 }
-/**
- * Adds a fixed label to the FixedLabel cluster. The FixedLabel cluster is created if it does not exist.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
- * @param {string} label - The label to add.
- * @param {string} value - The value of the label.
- */
 export async function addFixedLabel(endpoint, label, value) {
     if (!endpoint.hasClusterServer(FixedLabel.Cluster.id)) {
         endpoint.log.debug(`addFixedLabel: add cluster ${hk}FixedLabel${db}:${hk}fixedLabel${db} with label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
@@ -394,13 +360,6 @@ export async function addFixedLabel(endpoint, label, value) {
         await endpoint.setAttribute(FixedLabel.Cluster.id, 'labelList', labelList, endpoint.log);
     }
 }
-/**
- * Adds a user label to the UserLabel cluster. The UserLabel cluster is created if it does not exist.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to add the cluster servers to.
- * @param {string} label - The label to add.
- * @param {string} value - The value of the label.
- */
 export async function addUserLabel(endpoint, label, value) {
     if (!endpoint.hasClusterServer(UserLabel.Cluster.id)) {
         endpoint.log.debug(`addUserLabel: add cluster ${hk}UserLabel${db}:${hk}userLabel${db} with label ${CYAN}${label}${db} value ${CYAN}${value}${db}`);
@@ -425,18 +384,8 @@ export function getClusterId(endpoint, cluster) {
 }
 export function getAttributeId(endpoint, cluster, attribute) {
     const clusterBehavior = endpoint.behaviors.supported[lowercaseFirstLetter(cluster)];
-    return clusterBehavior?.cluster.attributes[lowercaseFirstLetter(attribute)]?.id;
+    return clusterBehavior?.cluster?.attributes[lowercaseFirstLetter(attribute)]?.id;
 }
-/**
- * Retrieves the value of the provided attribute from the given cluster.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to retrieve the attribute from.
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to retrieve the attribute from.
- * @param {string} attribute - The name of the attribute to retrieve.
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the retrieve. Errors are logged to the endpoint logger.
- * @returns {any} The value of the attribute, or undefined if the attribute is not found.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function getAttribute(endpoint, cluster, attribute, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
@@ -459,16 +408,6 @@ export function getAttribute(endpoint, cluster, attribute, log) {
     log?.info(`${db}Get endpoint ${or}${endpoint.id}${db}:${or}${endpoint.number}${db} attribute ${hk}${capitalizeFirstLetter(clusterName)}${db}.${hk}${attribute}${db} value ${YELLOW}${value !== null && typeof value === 'object' ? debugStringify(value) : value}${db}`);
     return value;
 }
-/**
- * Sets the value of an attribute on a cluster server.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to set the attribute on.
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to set the attribute on.
- * @param {string} attribute - The name of the attribute.
- * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the set. Errors are logged to the endpoint logger.
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
- */
 export async function setAttribute(endpoint, cluster, attribute, value, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
@@ -494,16 +433,6 @@ export async function setAttribute(endpoint, cluster, attribute, value, log) {
         `to ${YELLOW}${value !== null && typeof value === 'object' ? debugStringify(value) : value}${db}`);
     return true;
 }
-/**
- * Sets the value of an attribute on a cluster server.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to update the attribute on.
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to update the attribute on.
- * @param {string} attribute - The name of the attribute.
- * @param {boolean | number | bigint | string | object | null} value - The value to set for the attribute.
- * @param {AnsiLogger} [log] - (Optional) The logger to use for logging the update. Errors are logged to the endpoint logger.
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the attribute was successfully set.
- */
 export async function updateAttribute(endpoint, cluster, attribute, value, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
@@ -534,24 +463,7 @@ export async function updateAttribute(endpoint, cluster, attribute, value, log)
         `to ${YELLOW}${value !== null && typeof value === 'object' ? debugStringify(value) : value}${db}`);
     return true;
 }
-/**
- * Subscribes to the provided attribute on a cluster.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to subscribe the attribute to.
- * @param {Behavior.Type | ClusterType | ClusterId | string} cluster - The cluster to subscribe the attribute to.
- * @param {string} attribute - The name of the attribute to subscribe to.
- * @param {(newValue: any, oldValue: any, context: ActionContext) => void} listener - A callback function that will be called when the attribute value changes. When context.offline === true then the change is locally generated and not from the controller.
- * @param {AnsiLogger} [log] - Optional logger for logging errors and information.
- * @returns {boolean} - A boolean indicating whether the subscription was successful.
- *
- * @remarks The listener function (cannot be async) will receive three parameters:
- * - `newValue`: The new value of the attribute.
- * - `oldValue`: The old value of the attribute.
- * - `context`: The action context, which includes information about the action that triggered the change. When context.offline === true then the change is locally generated and not from the controller.
- */
-export async function subscribeAttribute(endpoint, cluster, attribute, 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-listener, log) {
+export async function subscribeAttribute(endpoint, cluster, attribute, listener, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
         endpoint.log.error(`subscribeAttribute ${hk}${attribute}${er} error: cluster not found on endpoint ${or}${endpoint.maybeId}${er}:${or}${endpoint.maybeNumber}${er}`);
@@ -561,7 +473,6 @@ listener, log) {
         endpoint.log.debug(`subscribeAttribute ${hk}${clusterName}.${attribute}${db}: Endpoint ${or}${endpoint.maybeId}${db}:${or}${endpoint.maybeNumber}${db} is in the ${BLUE}${endpoint.construction.status}${db} state`);
         await endpoint.construction.ready;
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const events = endpoint.events;
     attribute = lowercaseFirstLetter(attribute) + '$Changed';
     if (!(clusterName in events) || !(attribute in events[clusterName])) {
@@ -572,16 +483,6 @@ listener, log) {
     log?.info(`${db}Subscribed endpoint ${or}${endpoint.id}${db}:${or}${endpoint.number}${db} attribute ${hk}${capitalizeFirstLetter(clusterName)}${db}.${hk}${attribute}${db}`);
     return true;
 }
-/**
- * Triggers an event on the specified cluster.
- *
- * @param {MatterbridgeEndpoint} endpoint - The endpoint to trigger the event on.
- * @param {ClusterId} clusterId - The ID of the cluster.
- * @param {string} event - The name of the event to trigger.
- * @param {Record<string, boolean | number | bigint | string | object | undefined | null>} payload - The payload to pass to the event.
- * @param {AnsiLogger} [log] - Optional logger for logging information.
- * @returns {Promise<boolean>} - A promise that resolves to a boolean indicating whether the event was successfully triggered.
- */
 export async function triggerEvent(endpoint, cluster, event, payload, log) {
     const clusterName = getBehavior(endpoint, cluster)?.id;
     if (!clusterName) {
@@ -592,23 +493,15 @@ export async function triggerEvent(endpoint, cluster, event, payload, log) {
         endpoint.log.error(`triggerEvent ${hk}${clusterName}.${event}${er} error: Endpoint ${or}${endpoint.maybeId}${er}:${or}${endpoint.maybeNumber}${er} is in the ${BLUE}${endpoint.construction.status}${er} state`);
         return false;
     }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const events = endpoint.events;
     if (!(clusterName in events) || !(event in events[clusterName])) {
         endpoint.log.error(`triggerEvent ${hk}${event}${er} error: cluster ${clusterName} not found on endpoint ${or}${endpoint.id}${er}:${or}${endpoint.number}${er}`);
         return false;
     }
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
     await endpoint.act((agent) => agent[clusterName].events[event].emit(payload, agent.context));
     log?.info(`${db}Trigger event ${hk}${capitalizeFirstLetter(clusterName)}${db}.${hk}${event}${db} with ${debugStringify(payload)}${db} on endpoint ${or}${endpoint.id}${db}:${or}${endpoint.number}${db} `);
     return true;
 }
-/**
- * Get the default OperationalState Cluster Server.
- *
- * @param {OperationalState.OperationalStateEnum} operationalState - The initial operational state.
- */
 export function getDefaultOperationalStateClusterServer(operationalState = OperationalState.OperationalStateEnum.Stopped) {
     return optionsFor(MatterbridgeOperationalStateServer, {
         phaseList: [],
@@ -623,13 +516,6 @@ export function getDefaultOperationalStateClusterServer(operationalState = Opera
         operationalError: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
     });
 }
-/**
- * Get the default TemperatureMeasurement cluster server options.
- *
- * @param {number | null} measuredValue - The measured value of the temperature x 100.
- * @param {number | null} minMeasuredValue - The minimum measured value of the temperature x 100.
- * @param {number | null} maxMeasuredValue - The maximum measured value of the temperature x 100.
- */
 export function getDefaultTemperatureMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
     return optionsFor(TemperatureMeasurementServer, {
         measuredValue,
@@ -638,13 +524,6 @@ export function getDefaultTemperatureMeasurementClusterServer(measuredValue = nu
         tolerance: 0,
     });
 }
-/**
- * Get the default RelativeHumidityMeasurement cluster server options.
- *
- * @param {number | null} measuredValue - The measured value of the relative humidity x 100.
- * @param {number | null} minMeasuredValue - The minimum measured value of the relative humidity x 100.
- * @param {number | null} maxMeasuredValue - The maximum measured value of the relative humidity x 100.
- */
 export function getDefaultRelativeHumidityMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
     return optionsFor(RelativeHumidityMeasurementServer, {
         measuredValue,
@@ -653,13 +532,6 @@ export function getDefaultRelativeHumidityMeasurementClusterServer(measuredValue
         tolerance: 0,
     });
 }
-/**
- * Get the default PressureMeasurement cluster server options.
- *
- * @param {number | null} measuredValue - The measured value for the pressure.
- * @param {number | null} minMeasuredValue - The minimum measured value for the pressure.
- * @param {number | null} maxMeasuredValue - The maximum measured value for the pressure.
- */
 export function getDefaultPressureMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
     return optionsFor(PressureMeasurementServer, {
         measuredValue,
@@ -668,19 +540,6 @@ export function getDefaultPressureMeasurementClusterServer(measuredValue = null,
         tolerance: 0,
     });
 }
-/**
- * Get the default IlluminanceMeasurement cluster server options.
- *
- * @param {number | null} measuredValue - The measured value of illuminance.
- * @param {number | null} minMeasuredValue - The minimum measured value of illuminance.
- * @param {number | null} maxMeasuredValue - The maximum measured value of illuminance.
- * @remark The default value for the illuminance measurement is null.
- * This attribute SHALL indicate the illuminance in Lux (symbol lx) as follows:
- * •  MeasuredValue = 10,000 x log10(illuminance) + 1,
- *    where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE.
- * • 0 indicates a value of illuminance that is too low to be measured
- * • null indicates that the illuminance measurement is invalid.
- */
 export function getDefaultIlluminanceMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
     return optionsFor(IlluminanceMeasurementServer, {
         measuredValue,
@@ -689,13 +548,6 @@ export function getDefaultIlluminanceMeasurementClusterServer(measuredValue = nu
         tolerance: 0,
     });
 }
-/**
- * Get the default FlowMeasurement cluster server options.
- *
- * @param {number | null} measuredValue - The measured value of the flow in 10 x m3/h.
- * @param {number | null} minMeasuredValue - The minimum measured value of the flow in 10 x m3/h.
- * @param {number | null} maxMeasuredValue - The maximum measured value of the flow in 10 x m3/h.
- */
 export function getDefaultFlowMeasurementClusterServer(measuredValue = null, minMeasuredValue = null, maxMeasuredValue = null) {
     return optionsFor(FlowMeasurementServer, {
         measuredValue,
@@ -704,19 +556,6 @@ export function getDefaultFlowMeasurementClusterServer(measuredValue = null, min
         tolerance: 0,
     });
 }
-/**
- * Get the default OccupancySensing cluster server options.
- *
- * @param {boolean} occupied - A boolean indicating whether the occupancy is occupied or not. Default is false.
- * @param {number} holdTime - The hold time in seconds. Default is 30.
- * @param {number} holdTimeMin - The minimum hold time in seconds. Default is 1.
- * @param {number} holdTimeMax - The maximum hold time in seconds. Default is 300.
- *
- * @remark The default value for the occupancy sensor type is PIR.
- * Servers SHALL set these attributes for backward compatibility with clients implementing a cluster revision <= 4 as
- * described in OccupancySensorType and OccupancySensorTypeBitmap Attributes.
- * This replaces the 9 legacy attributes PIROccupiedToUnoccupiedDelay through PhysicalContactUnoccupiedToOccupiedThreshold.
- */
 export function getDefaultOccupancySensingClusterServer(occupied = false, holdTime = 30, holdTimeMin = 1, holdTimeMax = 300) {
     return optionsFor(OccupancySensingServer.with(OccupancySensing.Feature.PassiveInfrared), {
         occupancy: { occupied },
@@ -728,4 +567,3 @@ export function getDefaultOccupancySensingClusterServer(occupied = false, holdTi
         holdTimeLimits: { holdTimeMin, holdTimeMax, holdTimeDefault: holdTime },
     });
 }
-//# sourceMappingURL=matterbridgeEndpointHelpers.js.map