v6.2.0

.jsdoc.json

@@ -0,0 +1,24 @@
+{
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc"]
+    },
+    "source": {
+        "include": ["app", "lib", "package.json", "README.md"],
+        "includePattern": ".js$",
+        "excludePattern": "(node_modules/|docs)"
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": true,
+        "useLongnameInNav": false,
+        "showInheritedInNav": true
+    },
+    "opts": {
+        "destination": "./docs/",
+        "encoding": "utf8",
+        "private": true,
+        "recurse": true,
+        "template": "./node_modules/minami"
+    }
+}

README.md

@@ -78,8 +78,8 @@ Use tags to add emoji to notifications, e.g.: add  `{video}` to show a 📺 with
 1. [Installation](#installation)
 1. [Developers](#development)
 1. [Continuous Integration](#continuous-integration)
-1. [Up Next](#up-next)
-1. [Contact](#contact)
+1. [Roadmap](#roadmap)
+1. [Contribute](#contribute)
 1. [Author](#author)
 
 
@@ -219,20 +219,25 @@ Backed by the open-source-friendly guys at [Travis](http://travis-ci.org/) and A
 1. There is no step 3
 
 
-## <a name="up-next"/></a> Roadmap
+## <a name="roadmap"/></a> Roadmap
 
 - [ ] Signed binaries
 - [ ] End-To-End Tests (see [Spectron](https://github.com/electron/spectron))
 
 
-## <a name="contribute"/></a> Contact ![Contributions Wanted](https://img.shields.io/badge/contributions-wanted-red.svg?style=flat-square)
+## <a name="contribute"/></a> Contribute ![Contributions Wanted](https://img.shields.io/badge/contributions-wanted-red.svg?style=flat-square)
 
 Read the [contribution documentation](https://github.com/sidneys/pb-for-desktop/blob/master/CONTRIBUTING.md) first.
 
 - [Dev Chat](http://gitter.im/sidneys/pb-for-desktop): Talk about features and suggestions.
 - [Issues](http;//github.com/sidneys/pb-for-desktop/issues) File bugs and document issues.
 
 
+## <a name="license"/></a> License
+
+MIT
+
+
 ## <a name="author"/></a> Author
 
 [sidneys](http://sidneys.github.io) 2017

RELEASENOTES.json

@@ -1,5 +1,21 @@
 {
-    "6.1.1": {
+    "6.2.0": {
+        "💎 improved": [
+            "Augments start-up & background resource usage (#67)",
+            "Simplified network reachability detection & on-/offline handling"
+        ],
+        "🚨 fixed": [
+            "Fixes snooze wake-up scheduler",
+            "Fixes static snooze tray item display state",
+            "Fixes markdown release note formatting"
+        ],
+        "👷 internals": [
+            "Upgrades `node_modules`",
+            "Upgrades `services`",
+            "Upgrades `lib`"
+        ]
+    },
+    "6.1.7": {
         "🍾 features": [
             "Adds improved `webview` user interface controls",
             "Updated sound file support: `.m4a`, `.mp3`, `.mp4`, `.ogg`, `.wav`"

app/scripts/main/managers/configuration-manager.js

@@ -72,14 +72,14 @@ const appSoundDirectory = path.join(appRootPath, 'sounds').replace('app.asar', '
  * @default
  */
 const defaultInterval = 1000;
-const defaultDebounce = 300;
+const defaultDebounce = 1000;
 
 
 /**
- * Get mainWindow
- * @returns {Electron.BrowserWindow}
+ * Get primary BrowserWindow
+ * @returns {BrowserWindow}
  */
-let getMainWindow = () => global.mainWindow;
+let getPrimaryWindow = () => global.mainWindow;
 
 /**
  * Show app in menubar or task bar only
@@ -89,8 +89,10 @@ let setAppTrayOnly = (trayOnly) => {
     logger.debug('setAppTrayOnly');
 
     let interval = setInterval(() => {
-        const mainWindow = getMainWindow();
-        if (!mainWindow) { return; }
+        const primaryWindow = getPrimaryWindow();
+        if (!primaryWindow) { return; }
+        if (!primaryWindow.getBounds()) { return; }
+
 
         switch (platformHelper.type) {
             case 'darwin':
@@ -99,10 +101,10 @@ let setAppTrayOnly = (trayOnly) => {
                 } else { app.dock.show(); }
                 break;
             case 'win32':
-                mainWindow.setSkipTaskbar(trayOnly);
+                primaryWindow.setSkipTaskbar(trayOnly);
                 break;
             case 'linux':
-                mainWindow.setSkipTaskbar(trayOnly);
+                primaryWindow.setSkipTaskbar(trayOnly);
                 break;
         }
 
@@ -276,13 +278,13 @@ let configurationItems = {
 
             // Wait for window
             let interval = setInterval(() => {
-                const mainWindow = getMainWindow();
-                if (!mainWindow) { return; }
-                if (!mainWindow.getBounds()) { return; }
+                const primaryWindow = getPrimaryWindow();
+                if (!primaryWindow) { return; }
+                if (!primaryWindow.getBounds()) { return; }
 
                 // Observe future changes
-                mainWindow.on('move', event => this.set(event.sender.getBounds()));
-                mainWindow.on('resize', event => this.set(event.sender.getBounds()));
+                primaryWindow.on('move', event => this.set(event.sender.getBounds()));
+                primaryWindow.on('resize', event => this.set(event.sender.getBounds()));
 
                 // Apply saved value
                 this.implement(this.get());
@@ -296,20 +298,21 @@ let configurationItems = {
             return electronSettings.get(this.keypath);
         },
         set(value) {
-            logger.debug(this.keypath, 'set', util.inspect(value));
+            logger.debug(this.keypath, 'set', value);
 
             let debounced = _.debounce(() => {
                 electronSettings.set(this.keypath, value);
             }, defaultDebounce);
             debounced();
         },
         implement(value) {
-            logger.debug(this.keypath, 'implement', util.inspect(value));
+            logger.debug(this.keypath, 'implement', value);
 
-            const mainWindow = getMainWindow();
-            if (!mainWindow) { return; }
+            const primaryWindow = getPrimaryWindow();
+            if (!primaryWindow) { return; }
+            if (!primaryWindow.getBounds()) { return; }
 
-            mainWindow.setBounds(value);
+            primaryWindow.setBounds(value);
         }
     },
     /**
@@ -323,8 +326,9 @@ let configurationItems = {
 
             // Wait for window
             let interval = setInterval(() => {
-                const mainWindow = getMainWindow();
-                if (!mainWindow) { return; }
+                const primaryWindow = getPrimaryWindow();
+                if (!primaryWindow) { return; }
+                if (!primaryWindow.getBounds()) { return; }
 
                 this.implement(this.get());
 
@@ -361,12 +365,13 @@ let configurationItems = {
 
             // Wait for window
             let interval = setInterval(() => {
-                const mainWindow = getMainWindow();
-                if (!mainWindow) { return; }
+                const primaryWindow = getPrimaryWindow();
+                if (!primaryWindow) { return; }
+                if (!primaryWindow.getBounds()) { return; }
 
                 // Observe future changes
-                mainWindow.on('show', event => this.set(event.sender.isVisible()));
-                mainWindow.on('hide', event => this.set(event.sender.isVisible()));
+                primaryWindow.on('hide', () => this.set(false));
+                primaryWindow.on('show', () => this.set(true));
 
                 // Apply saved value
                 this.implement(this.get());
@@ -391,10 +396,11 @@ let configurationItems = {
         implement(value) {
             logger.debug(this.keypath, 'implement', value);
 
-            const mainWindow = getMainWindow();
-            if (!mainWindow) { return; }
+            const primaryWindow = getPrimaryWindow();
+            if (!primaryWindow) { return; }
+            if (!primaryWindow.getBounds()) { return; }
 
-            value === true ? mainWindow.show() : mainWindow.hide();
+            value === true ? primaryWindow.show() : primaryWindow.hide();
         }
     },
     /**

app/scripts/main/menus/tray-menu.js

@@ -294,27 +294,27 @@ let createTrayMenuTemplate = () => {
             icon: trayMenuItemImageSnooze,
             submenu: [
                 {
-                    label: 'Snooze for 1 Hour',
+                    label: '1 hour snooze',
                     id: 'snooze-60',
                     type: 'checkbox',
                     click(menuItem) {
-                        getSnoozerService().snooze(menuItem, 1);
+                        getSnoozerService().startSnooze(60, menuItem);
                     }
                 },
                 {
-                    label: 'Snooze for 4 Hours',
+                    label: '4 hour snooze',
                     id: 'snooze-240',
                     type: 'checkbox',
                     click(menuItem) {
-                        getSnoozerService().snooze(menuItem, 240);
+                        getSnoozerService().startSnooze(240, menuItem);
                     }
                 },
                 {
-                    label: 'Snooze for 8 Hours',
+                    label: '8 hour snooze',
                     id: 'snooze-480',
                     type: 'checkbox',
                     click(menuItem) {
-                        getSnoozerService().snooze(menuItem, 480);
+                        getSnoozerService().startSnooze(480, menuItem);
                     }
                 }
             ]
@@ -379,28 +379,28 @@ class TrayMenu extends Tray {
         });
 
         /**
-         * @listens ipcMain#networkState
+         * @listens ipcMain
          */
-        ipcMain.on('network', (event, networkState) => {
-            logger.debug('ipcMain#network');
+        ipcMain.on('online', (event, isOnline) => {
+            logger.debug('ipcMain#online', 'isOnline', isOnline);
 
-            switch (networkState) {
-                case 'offline':
-                    this.setImageName('transparent');
-                    break;
-                case 'online':
+            switch (isOnline) {
+                case true:
                     this.setImageName('default');
                     break;
+                case false:
+                    this.setImageName('transparent');
+                    break;
             }
         });
 
         /**
-         * @listens ipcMain#snooze
+         * @listens ipcMain:
          */
-        ipcMain.on('snooze', (event, snoozeState) => {
-            logger.debug('ipcMain#snooze');
+        ipcMain.on('snooze', (event, isSnoozing) => {
+            logger.debug('ipcMain#snooze', 'isSnoozing', isSnoozing);
 
-            switch (snoozeState) {
+            switch (isSnoozing) {
                 case true:
                     this.setImageName('transparent-pause');
                     break;

app/scripts/main/providers/notification-provider.js

@@ -6,7 +6,6 @@
  * Node
  * @constant
  */
-const os = require('os');
 const path = require('path');
 
 /**
@@ -31,16 +30,8 @@ const appRootPath = require('app-root-path')['path'];
  * @constant
  */
 const logger = require(path.join(appRootPath, 'lib', 'logger'))({ write: true });
-const platformHelper = require(path.join(appRootPath, 'lib', 'platform-helper'));
 
 
-/**
- * Application
- * @constant
- * @default
- */
-const appName = global.manifest.name;
-
 /**
  * Notification defaults
  * @constant
@@ -55,7 +46,7 @@ const defaultOptions = {
 /**
  * Create
  * @param {Object|String|Number} options - Notification Options
- * @return {Electron.Notification|ToastNotification} - Native Notification
+ * @return {Notification} - Native Notification
  */
 let create = (options) => {
     logger.debug('create');