Win-Toast-Notifier Node.js Wrapper

Node.js wrapper for win-toast-notifier. Allows to interact with user via windows toast notifications.

See examples in notifier.test.ts

Install

npm i node-win-toast-notifier

Application id

In order to send desktop notifications application should have registered ID. More details: https://learn.microsoft.com/en-us/windows/win32/shell/appids

Usage in electron

1import {registerOnSquirrelStartup} from "node-win-toast-notifier";
2import {build} from "./../package.json"
3
4// register appid during electron squirrel startup
5if (require("electron-squirrel-startup")) {
6  (async () => {
7    await registerOnSquirrelStartup('com.squirrel.my-app', 'my app', options.icons.green.big_png_win);
8    app.quit();
9  })();
10}
11
12app.on("ready", async () => {
13  const notifier = await createNotifier({
14    application_id: 'com.squirrel.my-app'
15  });
16  
17  const notification = await notifier.notify({
18    body: 'Hello',
19    audio: {src: NotificationSounds.SMS},
20    actions: [
21      {
22        actionType: 'input',
23        type: 'selection',
24        id: 'selectOptions',
25        defaultInput: 'option1',
26        selection: [
27          {
28            id: 'option1',
29            content: 'Option 1'
30          },
31          {
32            id: 'option2',
33            content: 'Option 2'
34          }
35        ]
36      },
37      {
38        actionType: 'action',
39        content: 'Button 1',
40        arguments: 'button1Pressed'
41      }
42    ]
43  });
44  notification.onChange(statusMessage => {
45    if (statusMessage.type == StatusMessageType.Activated){
46      if (statusMessage.info?.arguments === 'button1Pressed'){
47        console.log(`You pressed button 1`)
48      }
49    }
50  });
51});

Sending raw xml notification

You can validate xml content via app https://www.microsoft.com/store/productid/9NBLGGH5XSL1

1var notificationXML = `
2<toast>
3    <visual>
4        <binding template='ToastGeneric'>
5            <text >Hello</text>
6        </binding>
7    </visual>
8</toast>`;
9const notification = await notifier.notifyRaw(notificationXML);

How to copy binary during vite build

vite.main.config.ts

1export default defineConfig(async ({command, mode}) => {
2
3  let viteConfig: ResolvedConfig = null, notifierCopied: boolean;
4  return {
5    plugins: [
6      {
7        name: 'copy-notifier',
8        configResolved(config) {
9          viteConfig = config;
10        },
11        async writeBundle(){
12          if (!notifierCopied) {
13            notifierCopied = true;
14            let source = path.resolve(__dirname, `./node_modules/node-win-toast-notifier/bin/win-toast-notifier.exe`);
15            let dest = path.resolve(viteConfig.build.outDir, '../bin');
16            fs.mkdirSync(dest);
17            fs.copyFileSync(source, path.resolve(dest, "win-toast-notifier.exe"));
18            console.info('cimon-desktop-notifier.exe copied!')
19          }
20          return Promise.resolve(null);
21        }
22      } as Plugin
23    ],
24  }
25});
26