feat(notification): add desktop notifications (#140)

Co-authored-by: Jef LeCompte <[email protected]>

README.md

@@ -62,6 +62,7 @@ Here is a list of variables that you can use to customize your newly copied `.en
 
 | **Environment variable** | **Description** | **Notes** |
 |:---:|---|---|
+| `DESKTOP_NOTIFICATIONS` | Display desktop notifications using [node-notifier](https://www.npmjs.com/package/node-notifier); optional | Default: `false` |
 | `DISCORD_NOTIFY_GROUP` | Discord group you would like to notify; optional | E.g.: @here |
 | `DISCORD_WEB_HOOK` | Discord Web Hook URL |
 | `EMAIL_USERNAME` | Gmail address | E.g.: `[email protected]` |

package.json

@@ -24,6 +24,7 @@
   "dependencies": {
     "dotenv": "^8.2.0",
     "messaging-api-telegram": "^1.0.0",
+    "node-notifier": "^8.0.0",
     "nodemailer": "^6.4.11",
     "open": "^7.2.1",
     "puppeteer": "^5.3.0",
@@ -39,6 +40,7 @@
     "@types/node": "^14.11.1",
     "@types/nodemailer": "^6.4.0",
     "@types/puppeteer": "^3.0.2",
+    "@types/node-notifier": "^8.0.0",
     "play-sound": "^1.1.3",
     "rimraf": "^3.0.2",
     "typescript": "^4.0.2",

src/config.ts

@@ -13,6 +13,7 @@ const browser = {
 const logLevel = process.env.LOG_LEVEL ?? 'info';
 
 const notifications = {
+	desktop: process.env.DESKTOP_NOTIFICATIONS === 'true',
 	discord: {
 		notifyGroup: process.env.DISCORD_NOTIFY_GROUP ?? '',
 		webHookUrl: process.env.DISCORD_WEB_HOOK ?? ''

src/notification/desktop.ts

@@ -0,0 +1,14 @@
+import notifier from 'node-notifier';
+import {Link} from '../store/model';
+
+export function sendDesktopNotification(cartUrl: string, link: Link) {
+	(async () => {
+		const title = link.brand + ' ' + link.model + ' IN STOCK';
+		const message = cartUrl;
+
+		notifier.notify({
+			title,
+			message
+		});
+	})();
+}

src/notification/notification.ts

@@ -6,6 +6,8 @@ import {sendSlackMessage} from './slack';
 import {sendPushoverNotification} from './pushover';
 import {sendTelegramMessage} from './telegram';
 import {sendDiscordMessage} from './discord';
+import {sendDesktopNotification} from './desktop';
+
 import {Link} from '../store/model';
 
 const notifications = Config.notifications;
@@ -41,4 +43,8 @@ export function sendNotification(cartUrl: string, link: Link) {
 	if (notifications.playSound) {
 		playSound();
 	}
+
+	if (notifications.desktop) {
+		sendDesktopNotification(cartUrl, link);
+	}
 }