matterbridge-webhooks 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -8,6 +8,37 @@ 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.4] - 2025-05-05
+
+### Changed
+
+- [package]: Updated package.
+- [package]: Updated dependencies.
+
+### Fixed
+
+- [platform]: Fixed bug on unselected webhooks.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</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

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;
@@ -16,30 +17,29 @@ export class Platform extends MatterbridgeDynamicPlatform {
         this.log.info('onStart called with reason:', reason ?? 'none');
         await this.ready;
         await this.clearSelect();
-        let i = 1;
+        let i = 0;
         for (const webhookName in this.webhooks) {
-            if (Object.prototype.hasOwnProperty.call(this.webhooks, webhookName)) {
-                const webhook = this.webhooks[webhookName];
-                this.setSelectDevice('webhook' + i, webhookName, webhook.httpUrl, 'webhook');
-                if (!this.validateDevice(['webhook' + i, webhookName]))
-                    return;
-                this.log.info(`Registering device: ${webhookName}`, webhook.method, webhook.httpUrl);
-                const device = new MatterbridgeEndpoint([this.config.deviceType === 'Outlet' ? onOffOutlet : this.config.deviceType === 'Light' ? onOffLight : onOffSwitch, bridgedNode], { uniqueStorageKey: webhookName }, this.config.debug)
-                    .createDefaultBridgedDeviceBasicInformationClusterServer(webhookName, 'webhook' + i++, this.matterbridge.aggregatorVendorId, 'Matterbridge', 'Matterbridge Webhook', 0, this.config.version)
-                    .createOnOffClusterServer(false)
-                    .addRequiredClusterServers()
-                    .addCommandHandler('on', async () => {
-                    this.log.info(`Webhook ${webhookName} triggered.`);
-                    await device.setAttribute('onOff', 'onOff', false, device.log);
-                    fetch(webhook.httpUrl, webhook.method)
-                        .then(() => this.log.notice(`Webhook ${webhookName} successful!`))
-                        .catch((err) => {
-                        this.log.error(`Webhook ${webhookName} failed: ${err instanceof Error ? err.message : err}`);
-                    });
+            this.log.debug(`Loading webhook ${++i} ${webhookName} with method ${this.webhooks[webhookName].method} and url ${this.webhooks[webhookName].httpUrl}`);
+            const webhook = this.webhooks[webhookName];
+            this.setSelectDevice('webhook' + i, webhookName, undefined, 'hub');
+            if (!this.validateDevice(['webhook' + i, webhookName], true))
+                continue;
+            this.log.info(`Registering device: ${webhookName} with method ${webhook.method} and url ${webhook.httpUrl}`);
+            const device = new MatterbridgeEndpoint([this.config.deviceType === 'Outlet' ? onOffOutlet : this.config.deviceType === 'Light' ? onOffLight : onOffSwitch, bridgedNode], { uniqueStorageKey: webhookName }, this.config.debug)
+                .createDefaultBridgedDeviceBasicInformationClusterServer(webhookName, 'webhook' + i++, this.matterbridge.aggregatorVendorId, 'Matterbridge', 'Matterbridge Webhook', 0, this.config.version)
+                .createOnOffClusterServer(false)
+                .addRequiredClusterServers()
+                .addCommandHandler('on', async () => {
+                this.log.info(`Webhook ${webhookName} triggered.`);
+                await device.setAttribute('onOff', 'onOff', false, device.log);
+                fetch(webhook.httpUrl, webhook.method)
+                    .then(() => this.log.notice(`Webhook ${webhookName} successful!`))
+                    .catch((err) => {
+                    this.log.error(`Webhook ${webhookName} failed: ${err instanceof Error ? err.message : err}`);
                 });
-                await this.registerDevice(device);
-                this.bridgedDevices.set(webhookName, device);
-            }
+            });
+            await this.registerDevice(device);
+            this.bridgedDevices.set(webhookName, device);
         }
     }
     async onConfigure() {
@@ -50,9 +50,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.2",
+  "version": "0.0.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-webhooks",
-      "version": "0.0.2",
+      "version": "0.0.4",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "^3.0.1",

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "matterbridge-webhooks",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Matterbridge webhooks plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
+  "homepage": "https://www.npmjs.com/package/matterbridge-webhooks",
   "type": "module",
   "main": "dist/index.js",
   "repository": {

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__/*"]
+}