iobroker.gotify-ws 0.1.1 → 0.1.3

package/README.md

@@ -41,6 +41,7 @@ Spotify-WS currently supports the following notification services
 
 * e-mail
 * Matrix
+* Notification-Manager
 * Pushover
 * Discord
 * Signal
@@ -64,6 +65,14 @@ You can then configure a notification service of your choice for forwarding.
 ---
 <!-- ### **WORK IN PROGRESS** -->
 ## Changelog
+### 0.1.3 (2024-07-17)
+* (simatec) Fix Test & Release
+* (simatec) Fix Timeout
+
+### 0.1.2 (2024-06-26)
+* (simatec) Fix io-package
+* (simatec) Notification-Manager added
+
 ### 0.1.1 (2024-06-19)
 * (simatec) Fix Branch
 

package/admin/i18n/en/translations.json

@@ -13,6 +13,7 @@
 	"If you like this project and would like to support its development, you are welcome to leave a donation.": "If you like this project and would like to support its development, you are welcome to leave a donation.",
 	"Matrix Instance": "Matrix Instance",
 	"Notification Settings": "Notification Settings",
+	"Notification-Manager Instance": "Notification-Manager Instance",
 	"Notification type": "Notification type",
 	"Pushover Instance": "Pushover Instance",
 	"Signal Instance": "Signal Instance",

package/admin/jsonConfig.json

@@ -42,14 +42,14 @@
 			"label": "Gotify Port"
 		},
 		"token": {
-			"type": "text",
+			"type": "password",
+			"visible": true,
 			"label": "Gotify Token",
 			"sm": 12,
 			"md": 8,
 			"lg": 4,
 			"validator": "data.token",
 			"validatorNoSaveOnError": true,
-			"placeholder": "XXXxxXXXxxxXXXX",
 			"help": "Gotify Token"
 		},
 		"notificationSettings": {
@@ -74,6 +74,10 @@
 					"label": "Matrix",
 					"value": "matrix-org"
 				},
+				{
+					"label": "Notification-Manager",
+					"value": "notification-manager"
+				},
 				{
 					"label": "Pushover",
 					"value": "pushover"
@@ -136,14 +140,25 @@
 		"matrixInstance": {
 			"type": "selectSendTo",
 			"command": "sendToInstance",
-			"jsonData": "{ \"type\": \"matrix\" }",
-			"hidden": "data.notificationType !== 'matrix'",
+			"jsonData": "{ \"type\": \"matrix-org\" }",
+			"hidden": "data.notificationType !== 'matrix-org'",
 			"label": "Matrix Instance",
 			"sm": 12,
 			"md": 8,
 			"lg": 4,
 			"help": "Matrix Instance"
 		},
+		"notificationManagerInstance": {
+			"type": "selectSendTo",
+			"command": "sendToInstance",
+			"jsonData": "{ \"type\": \"notification-manager\" }",
+			"hidden": "data.notificationType !== 'notification-manager'",
+			"label": "Notification-Manager Instance",
+			"sm": 12,
+			"md": 8,
+			"lg": 4,
+			"help": "Notification-Manager Instance"
+		},
 		"pushoverInstance": {
 			"type": "selectSendTo",
 			"command": "sendToInstance",

package/io-package.json

@@ -1,8 +1,34 @@
 {
   "common": {
     "name": "gotify-ws",
-    "version": "0.1.1",
+    "version": "0.1.3",
     "news": {
+      "0.1.3": {
+        "en": "Fix Test & Release\nFix Timeout",
+        "de": "Test und Release\nTimeout reparieren",
+        "ru": "Fix Test & Release\nВремя ожидания",
+        "pt": "Teste de Fix & Release\nFix Timeout",
+        "nl": "Repareren Test & Release\nTijdslimiet herstellen",
+        "fr": "Correction du test et de la libération\nCorrection du délai",
+        "it": "Prova di correzione e rilascio\nRisolto il timeout",
+        "es": "Reparación de prueba\nCorrección de tiempo",
+        "pl": "Napraw test i wydaj\nPopraw czas",
+        "uk": "Тестування та реліз\nВиправлення часу",
+        "zh-cn": "修复测试和释放\n修正超时"
+      },
+      "0.1.2": {
+        "en": "(simatec) Fix io-package\n(simatec) Notification-Manager added",
+        "de": "(simatec)\n(simatec) Notification-Manager hinzugefügt",
+        "ru": "Fix io-package\n(simatec)",
+        "pt": "(simatec) Fix io-package\n(simatec) Notificação-Manager adicionado",
+        "nl": "Fix io-package\n(simatec) Notification-Manager toegevoegd",
+        "fr": "(simatec) Correction de l'emballage\n(simatec) Avis-Gestionnaire ajouté",
+        "it": "(simatec) Fissare io-package\n(simatec) Notificazione-Manager aggiunto",
+        "es": "(simatec) Fija io-paquete\n(simatec) Notification-Manager añadido",
+        "pl": "(simatec) Napraw pakiet jo-\n(simatec) Notification-Manager dodany",
+        "uk": "(simatec) Фіксація io-package\n(simatec) Notification-Manager додано",
+        "zh-cn": "(静电)\n(simatec) 通知管理器添加"
+      },
       "0.1.1": {
         "en": "(simatec) Fix Branch",
         "de": "(simatec)",
@@ -79,14 +105,15 @@
       "Whatsapp",
       "Discord",
       "Mail",
-      "Pushover"
+      "Pushover",
+      "Notification-Manager",
+      "Signal"
     ],
     "licenseInformation": {
       "license": "MIT",
       "type": "free"
     },
     "platform": "Javascript/Node.js",
-    "main": "main.js",
     "icon": "gotify-ws.png",
     "enabled": true,
     "messagebox": true,
@@ -98,6 +125,7 @@
     "compact": true,
     "connectionType": "local",
     "dataSource": "poll",
+    "tier": 2,
     "adminUI": {
       "config": "json"
     },
@@ -115,22 +143,28 @@
   "native": {
     "ip": "",
     "port": 8080,
-    "token": "",
-    "notificationType": "telegram",
-    "emailInstance": "email.0",
-    "matrixInstance": "matrix.0",
-    "pushoverInstance": "pushover.0",
-    "discordInstance": "discord.0",
-    "signalInstance": "signal-cmb.0",
-    "telegramInstance": "telegram.0",
+    "notificationType": "notification-manager",
+    "emailInstance": "",
+    "matrixInstance": "",
+    "notificationManagerInstance": "",
+    "pushoverInstance": "",
+    "discordInstance": "",
+    "signalInstance": "",
+    "telegramInstance": "",
     "telegramUser": "allTelegramUsers",
-    "whatsappInstance": "whatsapp-cmb.0",
+    "whatsappInstance": "",
     "emailReceiver": "xxx@xxx.com",
     "emailSender": "xxx@xxx.com",
     "pushoverDeviceID": "",
     "pushoverSilentNotice": false,
     "discordTarget": "none"
   },
+  "encryptedNative": [
+    "token"
+  ],
+  "protectedNative": [
+    "token"
+  ],
   "objects": [],
   "instanceObjects": [
     {

package/main.js

@@ -21,6 +21,7 @@ class GotifyWs extends utils.Adapter {
 			name: adapterName,
 		});
 		this.on('ready', this.onReady.bind(this));
+		// @ts-ignore
 		this.on('message', this.onMessage.bind(this));
 		this.on('unload', this.onUnload.bind(this));
 	}
@@ -32,22 +33,22 @@ class GotifyWs extends utils.Adapter {
 			systemLang = sysLang.common.language;
 		}
 
-		this.setState('info.connection', false, true);
+		await this.setStateAsync('info.connection', false, true);
 		this.connectWebSocket();
 	}
 
 	/**
 	 * @param {() => void} callback
 	 */
-	onUnload(callback) {
-		this.setState('info.connection', false, true);
+	async onUnload(callback) {
+		await this.setStateAsync('info.connection', false, true);
 
 		try {
 			if (ws) {
 				stop = true;
 				ws.close();
 				ws.terminate();
-				clearTimeout(timer);
+				this.clearTimeout(timer);
 				timer = null;
 			}
 			callback();
@@ -171,6 +172,7 @@ class GotifyWs extends utils.Adapter {
 
 			ws = new WebSocket(uri, {
 				headers: {
+					// @ts-ignore
 					'X-Gotify-Key': this.config.token,
 				},
 			});
@@ -189,7 +191,7 @@ class GotifyWs extends utils.Adapter {
 				this.setState('info.connection', false, true);
 				this.log.info('WebSocket closed');
 				if (stop === false) {
-					timer = setTimeout(this.connectWebSocket, 5000);
+					timer = this.setTimeout(this.connectWebSocket, 5000);
 				}
 			});
 
@@ -218,7 +220,7 @@ class GotifyWs extends utils.Adapter {
 							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
 
 						try {
-							this.sendTo(this.config.telegramInstance, 'send', {
+							await this.sendToAsync(this.config.telegramInstance, 'send', {
 								parse_mode: 'HTML',
 								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
 							});
@@ -236,7 +238,7 @@ class GotifyWs extends utils.Adapter {
 							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
 
 						try {
-							this.sendTo(this.config.telegramInstance, 'send', {
+							await this.sendToAsync(this.config.telegramInstance, 'send', {
 								user: this.config.telegramUser,
 								parse_mode: 'HTML',
 								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
@@ -253,7 +255,7 @@ class GotifyWs extends utils.Adapter {
 						const title = line.title != '' ? line.title.replace(/[`]/g, '') : 'Gotifi WS Message';
 
 						try {
-							this.sendTo(this.config.emailInstance, 'send', {
+							await this.sendToAsync(this.config.emailInstance, 'send', {
 								text: formatMessage,
 								to: this.config.emailReceiver,
 								subject: title,
@@ -276,7 +278,7 @@ class GotifyWs extends utils.Adapter {
 							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
 
 						try {
-							this.sendTo(this.config.pushoverInstance, 'send', {
+							await this.sendToAsync(this.config.pushoverInstance, 'send', {
 								message: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
 								sound: '',
 								priority: -1,
@@ -294,7 +296,7 @@ class GotifyWs extends utils.Adapter {
 							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
 
 						try {
-							this.sendTo(this.config.pushoverInstance, 'send', {
+							await this.sendToAsync(this.config.pushoverInstance, 'send', {
 								message: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
 								sound: '',
 								title: title,
@@ -313,7 +315,7 @@ class GotifyWs extends utils.Adapter {
 						const title = line.title != '' ? `*${line.title.replace(/[`]/g, '')}*` : '*Gotifi WS Message*';
 
 						try {
-							this.sendTo(this.config.whatsappInstance, 'send', {
+							await this.sendToAsync(this.config.whatsappInstance, 'send', {
 								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
 							});
 						} catch (err) {
@@ -321,6 +323,22 @@ class GotifyWs extends utils.Adapter {
 						}
 					}
 					break;
+				case 'notification-manager':
+					if (this.config.notificationManagerInstance) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title = line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
+
+						try {
+							await this.sendToAsync(this.config.notificationManagerInstance, 'registerUserNotification', {
+								category: 'notify',
+								message: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending Notification-Manager message: ${err}`);
+						}
+					}
+					break;
 				case 'signal-cmb':
 					if (this.config.signalInstance) {
 						const message = line.message.replace(/[`]/g, '');
@@ -328,7 +346,7 @@ class GotifyWs extends utils.Adapter {
 						const title = line.title != '' ? line.title.replace(/[`]/g, '') : 'Gotifi WS Message';
 
 						try {
-							this.sendTo(this.config.signalInstance, 'send', {
+							await this.sendToAsync(this.config.signalInstance, 'send', {
 								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
 							});
 						} catch (err) {
@@ -336,7 +354,7 @@ class GotifyWs extends utils.Adapter {
 						}
 					}
 					break;
-				case 'matrix':
+				case 'matrix-org':
 					if (this.config.matrixInstance) {
 						const message = line.message.replace(/[`]/g, '');
 						const formatMessage = message.replace(/[']/g, '"');
@@ -344,7 +362,7 @@ class GotifyWs extends utils.Adapter {
 							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
 
 						try {
-							this.sendTo(this.config.matrixInstance, {
+							await this.sendToAsync(this.config.matrixInstance, {
 								html: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
 							});
 						} catch (err) {
@@ -362,7 +380,7 @@ class GotifyWs extends utils.Adapter {
 						if (this.config.discordTarget.match(/^\d+$/)) {
 							// send to a single user
 							try {
-								this.sendTo(this.config.discordInstance, 'sendMessage', {
+								await this.sendToAsync(this.config.discordInstance, 'sendMessage', {
 									userId: this.config.discordTarget,
 									content: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
 								});
@@ -373,7 +391,7 @@ class GotifyWs extends utils.Adapter {
 							// send to a server channel
 							const [serverId, channelId] = this.config.discordTarget.split('/');
 							try {
-								this.sendTo(this.config.discordInstance, 'sendMessage', {
+								await this.sendToAsync(this.config.discordInstance, 'sendMessage', {
 									serverId,
 									channelId,
 									content: `${title != '' ? `${title}\n` : ''}${formatMessage}`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.gotify-ws",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Gotify web socket for connection to various notification systems",
   "author": {
     "name": "simatec",
@@ -15,7 +15,9 @@
     "Whatsapp",
     "Discord",
     "Mail",
-    "Pushover"
+    "Pushover",
+    "Notification-Manager",
+    "Signal"
   ],
   "repository": {
     "type": "git",
@@ -26,12 +28,12 @@
   },
   "dependencies": {
     "@iobroker/adapter-core": "^3.1.6",
-    "ws": "^8.17.1",
+    "ws": "^8.18.0",
     "axios": "^1.7.2"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.7.0",
-    "@alcalzone/release-script-plugin-iobroker": "^3.7.1",
+    "@alcalzone/release-script": "^3.7.3",
+    "@alcalzone/release-script-plugin-iobroker": "^3.7.2",
     "@alcalzone/release-script-plugin-license": "^3.7.0",
     "@alcalzone/release-script-plugin-manual-review": "^3.7.0",
     "@iobroker/adapter-dev": "^1.3.0",
@@ -39,19 +41,19 @@
     "@tsconfig/node20": "^20.1.4",
     "@types/chai": "^4.3.16",
     "@types/chai-as-promised": "^7.1.8",
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.14.5",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^20.14.11",
     "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^17.0.3",
     "@types/sinon-chai": "^3.2.12",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.2",
-    "eslint": "^9.5.0",
-    "mocha": "^10.4.0",
+    "eslint": "^9.7.0",
+    "mocha": "^10.6.0",
     "proxyquire": "^2.1.3",
     "sinon": "^18.0.0",
     "sinon-chai": "^3.7.0",
-    "typescript": "~5.4.5"
+    "typescript": "~5.5.3"
   },
   "main": "main.js",
   "files": [
@@ -72,7 +74,9 @@
     "release-patch": "release-script patch --yes",
     "release-minor": "release-script minor --yes",
     "release-major": "release-script major --yes",
-    "translate": "translate-adapter"
+    "translate": "translate-adapter",
+    "dev-server-run": "dev-server run gotify-ws",
+    "dev-server-watch": "dev-server watch gotify-ws"
   },
   "bugs": {
     "url": "https://github.com/simatec/ioBroker.gotify-ws/issues"