matterbridge 3.0.4-dev-20250525-c88cf84 → 3.0.4

package/dist/waterHeater.js

@@ -1,8 +1,42 @@
+/**
+ * This file contains the WaterHeater class.
+ *
+ * @file waterHeater.ts
+ * @author Luca Liguori
+ * @date 2025-05-18
+ * @version 1.0.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. *
+ */
+// Matterbridge
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { waterHeater } from './matterbridgeDeviceTypes.js';
 import { MatterbridgeWaterHeaterManagementServer, MatterbridgeWaterHeaterModeServer } from './matterbridgeBehaviors.js';
+// Matter.js
 import { WaterHeaterManagement, WaterHeaterMode } from '@matter/main/clusters';
 export class WaterHeater extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the WaterHeater class.
+     *
+     * @param {string} name - The name of the water heater.
+     * @param {string} serial - The serial number of the water heater.
+     * @param {number} [waterTemperature=50] - The current water temperature. Defaults to 50.
+     * @param {number} [minHeatSetpointLimit=20] - The minimum heat setpoint limit. Defaults to 20.
+     * @param {number} [maxHeatSetpointLimit=80] - The maximum heat setpoint limit. Defaults to 80.
+     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
+     */
     constructor(name, serial, waterTemperature = 50, minHeatSetpointLimit = 20, maxHeatSetpointLimit = 80, heaterTypes = { immersionElement1: true }) {
         super(waterHeater, { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
@@ -12,6 +46,15 @@ export class WaterHeater extends MatterbridgeEndpoint {
             .createDefaultWaterHeaterManagementClusterServer(heaterTypes)
             .createDefaultWaterHeaterModeClusterServer();
     }
+    /**
+     * Creates a default WaterHeaterManagement Cluster Server.
+     *
+     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
+     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heatDemand] - Indicates if the water heater is heating water. Defaults to all heat sources unset.
+     * @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 100.
+     * @param {WaterHeaterManagement.BoostState} [boostState] - The current boost state of the WaterHeaterManagement cluster. Defaults to Inactive.
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
     createDefaultWaterHeaterManagementClusterServer(heaterTypes, heatDemand, tankPercentage, boostState) {
         this.behaviors.require(MatterbridgeWaterHeaterManagementServer.with(WaterHeaterManagement.Feature.TankPercent), {
             heaterTypes: heaterTypes ?? { immersionElement1: true },
@@ -21,6 +64,14 @@ export class WaterHeater extends MatterbridgeEndpoint {
         });
         return this;
     }
+    /**
+     * Creates a default WaterHeaterMode Cluster Server.
+     *
+     * @param {number} [currentMode] - The current mode of the WaterHeaterMode cluster. Defaults to mode 1 (WaterHeaterMode.ModeTag.Auto).
+     * @param {WaterHeaterMode.ModeOption[]} [supportedModes] - The supported modes for the WaterHeaterMode cluster. Defaults all cluster modes.
+     *
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
     createDefaultWaterHeaterModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MatterbridgeWaterHeaterModeServer, {
             supportedModes: supportedModes ?? [
@@ -43,3 +94,4 @@ export class WaterHeater extends MatterbridgeEndpoint {
         return this;
     }
 }
+//# sourceMappingURL=waterHeater.js.map

package/dist/waterHeater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waterHeater.js","sourceRoot":"","sources":["../src/waterHeater.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,eAAe;AACf,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,uCAAuC,EAAE,iCAAiC,EAAE,MAAM,4BAA4B,CAAC;AAExH,YAAY;AACZ,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE/E,MAAM,OAAO,WAAY,SAAQ,oBAAoB;IACnD;;;;;;;;;OASG;IACH,YACE,IAAY,EACZ,MAAc,EACd,gBAAgB,GAAG,EAAE,EACrB,oBAAoB,GAAG,EAAE,EACzB,oBAAoB,GAAG,EAAE,EACzB,cAAmI,EAAE,iBAAiB,EAAE,IAAI,EAAE;QAE9J,KAAK,CAAC,WAAW,EAAE,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC5G,IAAI,CAAC,kCAAkC,EAAE;aACtC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,2BAA2B,CAAC;aACrH,0CAA0C,EAAE;aAC5C,2CAA2C,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,oBAAoB,CAAC;aAC3H,+CAA+C,CAAC,WAAW,CAAC;aAC5D,yCAAyC,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACH,+CAA+C,CAC7C,WAAiI,EACjI,UAAgI,EAChI,cAAuB,EACvB,UAA6C;QAE7C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,uCAAuC,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC9G,WAAW,EAAE,WAAW,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE;YACvD,UAAU,EAAE,UAAU,IAAI,EAAE;YAC5B,cAAc,EAAE,cAAc,IAAI,GAAG;YACrC,UAAU,EAAE,UAAU,IAAI,qBAAqB,CAAC,UAAU,CAAC,QAAQ;SACpE,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,yCAAyC,CAAC,WAAoB,EAAE,cAA6C;QAC3G,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,iCAAiC,EAAE;YACxD,cAAc,EAAE,cAAc,IAAI;gBAChC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE;gBAC/E,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;gBACjF,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;gBACjF,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;gBACvF,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE;gBACzF,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;gBACvF,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC7E,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC7E,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;gBACjF,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC9E,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC9E,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;gBACpF,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;aACnF;YACD,WAAW,EAAE,WAAW,IAAI,CAAC;SAC9B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.0.4-dev-20250525-c88cf84",
+  "version": "3.0.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.0.4-dev-20250525-c88cf84",
+      "version": "3.0.4",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.13.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.0.4-dev-20250525-c88cf84",
+  "version": "3.0.4",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
@@ -41,6 +41,7 @@
   ],
   "type": "module",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
     "matterbridge": "dist/cli.js"
   },