build: update packaging files

Author: Aetherinox

.all-contributorsrc

@@ -1,5 +1,5 @@
 {
-    "projectName": "node-toasted",
+    "projectName": "toasted-notifier",
     "projectOwner": "Aetherinox",
     "repoType": "github",
     "repoHost": "https://github.com",

.github/workflows/npm-publish.yml

@@ -14,13 +14,13 @@ on:
 
       # ---------------------------------------------------------------------------------------
       #   Name of the plugin to use when creating the release zip filename
-      #     e.g: node-toasted-v1.0.0.zip
+      #     e.g: toasted-notifier-v1.0.0.zip
       # ---------------------------------------------------------------------------------------
 
       PLUGIN_NAME:
         description:  "📦 Name of Plugin"
         required:     true
-        default:      'node-toasted'
+        default:      'toasted-notifier'
         type:         string
 
       # ---------------------------------------------------------------------------------------
@@ -61,11 +61,11 @@ on:
       # ---------------------------------------------------------------------------------------
       #   Release Candidate version number
       #   this will be added to the end of your released app in the releases page.
-      #     e.g: node-toasted-v1.0.0-rc.1
+      #     e.g: toasted-notifier-v1.0.0-rc.1
       # ---------------------------------------------------------------------------------------
 
       VERSION_RC:
-        description:  "🧪 RC (Pre-release) Ver (node-toasted-rc.v1)"
+        description:  "🧪 RC (Pre-release) Ver (toasted-notifier-rc.v1)"
         required:     false
         type:         string
         default:      "1"
@@ -248,8 +248,8 @@ jobs:
         - name: "🔎 Find and Replace (Start)"
           uses: jacobtomlinson/gha-find-replace@v3
           with:
-            find: '"name": "node-toasted"'
-            replace: '"name": "@aetherinox/node-toasted"'
+            find: '"name": "toasted-notifier"'
+            replace: '"name": "@aetherinox/toasted-notifier"'
             include: "package.json"
             regex: true
 
@@ -303,8 +303,8 @@ jobs:
         - name: "🔎 Find and Replace (Finish)"
           uses: jacobtomlinson/gha-find-replace@v3
           with:
-            find: '"name": "@aetherinox/node-toasted"'
-            replace: '"name": "node-toasted"'
+            find: '"name": "@aetherinox/toasted-notifier"'
+            replace: '"name": "toasted-notifier"'
             include: "package.json"
             regex: true
 
@@ -372,7 +372,7 @@ jobs:
             - name: "🪪 Generate IDs"
               id: task_release_npm_env_generate
               run: |
-                npm run node-toasted:generate
+                npm run ntfy:generate
 
             # ---------------------------------------------------------------------------------------
             #   Get guid and uuid from env variable

.gitignore

@@ -81,7 +81,7 @@
 !*.npmignore
 !*.all-contributorsrc
 !*.editorconfig
-!*node-toasted.js
+!*ntfy.js
 !*index.js
 !*manifest.json
 !*package.json

README.md

@@ -71,12 +71,11 @@ This library is packaged with [ntfy-desktop](https://github.com/Aetherinox/ntfy-
   - [Help](#help)
     - [How to change text `NtfyToast` at the top of notifications](#how-to-change-text-ntfytoast-at-the-top-of-notifications)
     - [Can't use Windows Toast notifications in WSL2](#cant-use-windows-toast-notifications-in-wsl2)
-    - [Distributing Toasted-Notifer with Electron](#distributing-toasted-notifer-with-electron)
+    - [Distributing with Electron](#distributing-with-electron)
     - [Using Webpack](#using-webpack)
     - [Windows: Where are shortcut / .lnk files placed](#windows-where-are-shortcut--lnk-files-placed)
     - [Usage in tmux session](#usage-in-tmux-session)
 
-
 <br />
 
 ---
@@ -102,7 +101,7 @@ The correct notification package will be used by Toasted Node depending on the e
 <br />
 
 ## What is ntfy-toast
-[ntfy-toast](https://github.com/Aetherinox/ntfy-toast) is a notification system for Windows 8 - 11. It is one of the libraries used by Toasted Notifier to display notifications for users.
+[ntfy-toast](https://github.com/Aetherinox/ntfy-toast) is a package included in this repo, which services notifications for users running Windows 8 - 11.
 
 It is based on [SnoreToast](https://github.com/KDE/snoretoast), but has been updated with numerous features.
 
@@ -724,7 +723,7 @@ You can add a `postinstall` action in the `package.json`:
 
 <br />
 
-### Distributing Toasted-Notifer with Electron
+### Distributing with Electron
 If you package your Electron based app as an asar; toasted-notifier will fail to load. This is because of how a asar package works. You cannot execute a binary from within an asar package. 
 
 Is solution is that when packaging the app into an asar, make sure you `--unpack` the `vendor/` folder of toasted-notifier so that the module still has access to the notification vendor binaries.

ntfy.js

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+
+/*
+    build toasted-notifier by running
+        npm run build
+
+    guid and uuid will be automatically generated and placed
+    inside .env file which will then be read by the github workflow
+    build script.
+*/
+
+/*
+    This script handles the following:
+        - read package.json
+        - create .env file
+        - return uuid, guid, version
+
+    can be called with the following external commands:
+        - node ntfy.js                  returns version of toasted-notifier
+        - node ntfy.js generate         generates uuid / guid and shows all env vars in console
+        - node ntfy.js uuid             returns toasted-notifier uuid
+        - node ntfy.js guid             returns toasted-notifier guid
+        - node ntfy.js versiom          returns version of toasted-notifier
+
+    can be called with the following toasted-notifier commands:
+        - npm run ntfy
+        - npm run ntfy:generate
+        - npm run env-ntfy
+        - npm run env-uuid
+        - npm run env-guid
+        - npm run env-version
+*/
+
+const fs = require('fs');
+const { v5: uuid } = require('uuid');
+
+/*
+ *    declrations > package.json
+ */
+
+const { version, repository } = JSON.parse(fs.readFileSync('package.json'));
+const args = process.argv.slice(2, process.argv.length);
+const action = args[0];
+// const a       = args[ 1 ];
+// const b       = args[ 2 ];
+
+if (action === 'guid') {
+    console.log(`${process.env.GUID}`);
+} else if (action === 'setup') {
+    fs.writeFileSync('.env', '', (err) => {
+        if (err) {
+            console.error(err);
+        } else {
+            console.log('Wrote to .env successfully');
+        }
+    });
+} else if (action === 'generate') {
+    const buildGuid = uuid(`${repository.url}`, uuid.URL);
+    const buildUuid = uuid(version, buildGuid);
+
+    const ids = `
+VERSION=${version}
+GUID=${buildGuid}
+UUID=${buildUuid}
+`;
+
+    console.log(version);
+    console.log(buildGuid);
+    console.log(buildUuid);
+
+    fs.writeFileSync('.env', ids, (err) => {
+        if (err) {
+            console.error(`Could not write env vars: ${err}`);
+        } else {
+            console.log('Wrote env vars to .env');
+        }
+    });
+} else if (action === 'uuid') {
+    console.log(`${process.env.UUID}`);
+} else {
+    console.log(version);
+}
+
+process.exit(0);

package.json

@@ -56,8 +56,8 @@
         "prepare": "husky install",
         "contrib:add": "all-contributors add",
         "contrib:generate": "all-contributors generate",
-        "ntfy-toast-node": "node ntfy.js",
-        "ntfy-toast-node:generate": "node ntfy.js generate",
+        "ntfy": "node ntfy.js",
+        "ntfy:generate": "node ntfy.js generate",
         "env-base": "npx --quiet env-cmd --no-override node ntfy.js",
         "env-uuid": "npx --quiet env-cmd --no-override node ntfy.js uuid",
         "env-guid": "npx --quiet env-cmd --no-override node ntfy.js guid",