matterbridge-webhooks 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -8,6 +8,36 @@ If you like this project and find it useful, please consider giving it a star on
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
+## [0.0.3] - 2025-05-01
+
+### Added
+
+- [readme]: Added the possibility to test the hook before confirming the changes in the config editor.
+
+### Changed
+
+- [package]: Require matterbridge 3.0.0.
+- [package]: Updated package.
+- [package]: Updated dependencies.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
+## [0.0.2] - 2025-03-30
+
+### Added
+
+- [readme]: Added some examples for Shelly Trv gen 1.
+
+### Fixed
+
+- [select]: Fixed missing clearSelect on start.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [0.0.1] - 2025-03-19
 
 First published release.

package/README.md

@@ -19,6 +19,7 @@ This plugin allows you to expose any webhooks to Matter.
 Features:
 
 - The webhooks parameters can easily be entered in the frontend.
+- It is possible to choose how to expose the webhooks: Switch, Outlet or Light.
 - It is possible to choose the method: GET or POST.
 - The webhook can be tested in the frontend.
 
@@ -54,12 +55,32 @@ See the complete guidelines on [Matterbridge](https://github.com/Luligu/matterbr
 
 ## How to add a webhook
 
-In the frontend open the plugin config: add a new webhook, enter the webhook name in the first field (replace newKey with the name you want to give to the webhook), select GET or POST and enter the webhook url. The webhook name will be the device name on the controller. The webhook will be exposed like a switch or like a plug, when you turn it on the webhook is called and in a few seconds the switch or the plug will revert to off.
+In the frontend open the plugin config: add a new webhook, enter the webhook name in the first field (replace newKey with the name you want to give to the webhook), select GET or POST and enter the webhook url. The webhook name will be the device name on the controller. The webhook will be exposed like a switch, like an outlet or like a light. When you turn it on, the webhook is called and in a few seconds the switch or the outlet or the light will revert to off.
 
 It is possible to test directly the webhook from the config editor.
 
 ## Examples
 
-## Shelly webhooks
+## Shelly webhooks examples
 
-For example to turn on a shelly gen 1 device with ip 192.168.1.155 the url is http://192.168.1.155/light/0?turn=on.
+Change 192.168.1.XXX with your device IP address.
+
+### Shelly 1 Gen 1
+
+To turn on a shelly gen 1 device with ip 192.168.1.155 the url is http://192.168.1.XXX/light/0?turn=on.
+
+To turn off a shelly gen 1 device with ip 192.168.1.155 the url is http://192.168.1.XXX/light/0?turn=off.
+
+### Shelly Trv Gen 1
+
+The following examples allows to fully control a Shelly Trv Gen 1, adding Boost, Schedule and Profile (provided by https://github.com/vandan380).
+
+"Boost 30min": method: POST, Url: "http://192.168.1.XXX/thermostats/0?boost_minutes=30"
+
+"Schedule Enable": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule=1"
+
+"Schedule Disable": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule=0"
+
+"Profile Working Day": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule_profile=1"
+
+"Profile Holiday": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule_profile=2"

package/dist/fetch.js

@@ -44,7 +44,7 @@ export async function fetch(url, method = 'GET', data = {}, timeout = 5000) {
                 clearTimeout(timeoutId);
                 res.resume();
                 req.destroy();
-                return reject(new Error(`Request failed with status code: ${res.statusCode}`));
+                reject(new Error(`Request failed with status code: ${res.statusCode}`));
             }
             res.on('data', (chunk) => {
                 responseData += chunk;

package/dist/platform.js

@@ -1,12 +1,13 @@
 import { bridgedNode, MatterbridgeDynamicPlatform, MatterbridgeEndpoint, onOffLight, onOffOutlet, onOffSwitch } from 'matterbridge';
+import { isValidObject } from 'matterbridge/utils';
 import { fetch } from './fetch.js';
 export class Platform extends MatterbridgeDynamicPlatform {
     webhooks;
     bridgedDevices = new Map();
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('2.2.5')) {
-            throw new Error(`This plugin requires Matterbridge version >= "2.2.5". Please update Matterbridge to the latest version in the frontend.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.0')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.0.0". Please update Matterbridge to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
         this.webhooks = this.config.webhooks;
@@ -14,6 +15,8 @@ export class Platform extends MatterbridgeDynamicPlatform {
     }
     async onStart(reason) {
         this.log.info('onStart called with reason:', reason ?? 'none');
+        await this.ready;
+        await this.clearSelect();
         let i = 1;
         for (const webhookName in this.webhooks) {
             if (Object.prototype.hasOwnProperty.call(this.webhooks, webhookName)) {
@@ -48,9 +51,33 @@ export class Platform extends MatterbridgeDynamicPlatform {
             await device.setAttribute('onOff', 'onOff', false, device.log);
         });
     }
-    async onAction(action, value, id) {
+    async onAction(action, value, id, formData) {
         this.log.info('onAction called with action:', action, 'and value:', value ?? 'none', 'and id:', id ?? 'none');
+        this.log.debug('onAction called with formData:', formData ?? 'none');
+        if (id?.startsWith('root_webhooks_'))
+            id = id.replace('root_webhooks_', '');
+        if (id?.endsWith('_test'))
+            id = id.replace('_test', '');
         if (action === 'test') {
+            if (isValidObject(formData, 1) && isValidObject(formData.webhooks, 1)) {
+                const webhooks = formData.webhooks;
+                for (const webhookName in webhooks) {
+                    if (Object.prototype.hasOwnProperty.call(webhooks, webhookName)) {
+                        const webhook = webhooks[webhookName];
+                        if (id?.includes(webhookName)) {
+                            this.log.info(`Testing new webhook ${webhookName} method ${webhook.method} url ${webhook.httpUrl}`);
+                            fetch(webhook.httpUrl, webhook.method)
+                                .then(() => {
+                                this.log.notice(`Webhook test ${webhookName} successful!`);
+                            })
+                                .catch((err) => {
+                                this.log.error(`Webhook test ${webhookName} failed: ${err instanceof Error ? err.message : err}`);
+                            });
+                        }
+                    }
+                }
+                return;
+            }
             for (const webhookName in this.webhooks) {
                 if (Object.prototype.hasOwnProperty.call(this.webhooks, webhookName)) {
                     const webhook = this.webhooks[webhookName];

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-webhooks",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-webhooks",
-      "version": "0.0.1",
+      "version": "0.0.3",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "^3.0.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-webhooks",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Matterbridge webhooks plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",

package/tsconfig.jest.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    // enable isolatedModules just for ts-jest
+    "isolatedModules": true
+  },
+  "include": ["**/*.spec.ts", "**/*.test.ts", "**/__test__/*"]
+}