You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

286 lines
10 KiB

4 years ago
  1. # Changelog
  2. ### `v5.4.3`
  3. - Reverts breaking dependency upgrades from `v5.4.2` as some dependencies has removed Node 6 which is a breaking change.
  4. ### `v5.4.2`
  5. - Updates dependencies
  6. ### `v5.4.1`
  7. - Reverts changes to default timeout as they are causing some issues. See [#271](https://github.com/mikaelbr/node-notifier/pull/271)
  8. ### `v5.4.0`
  9. - Prevent Spotlight from indexing terminal-notifier.app ([#238](https://github.com/mikaelbr/node-notifier/pull/238))
  10. - Changes from legacy url.parse api
  11. - Adds default timeout to notification center
  12. - Adds mapping from timeout to expire time for linux
  13. - Enables the use of WindowsToaster when using WSL ([#260](https://github.com/mikaelbr/node-notifier/pull/260))
  14. ### `v5.3.0`
  15. - Re-adds `notifu` update.
  16. ### `v5.2.1`
  17. - Rollback `notifu` update as it triggered Avast virus scan.
  18. ### `v5.2.0`
  19. - Updates `terminal-notifier` dependency to `v1.7.2`, fixing memory leak. But not to `v1.8.0` as this breaks how icons work.
  20. - Updates `notifu` with new subtitle "Notification"
  21. - Fix: issue with `appID` by removing default empty string (see README Windows section)
  22. - Fix: link notifier time property to notify-send expire-time flag
  23. - Minor change: use a more specific condition for enabling debug logging ([#171](https://github.com/mikaelbr/node-notifier/pull/171))
  24. ### `v5.1.2`
  25. - Adds temporary workaround for `terminal-notifier` memory leak as seen in https://github.com/facebook/jest/issues/2999 and https://github.com/julienXX/terminal-notifier/issues/173.
  26. - Add appName option and hide snoreToast if not setted ([#158](https://github.com/mikaelbr/node-notifier/pull/158))
  27. ### `v5.0.2`
  28. Non-obligatory fail. Fixes issue with multiple actions for macOS.
  29. ### `v5.0.1`
  30. Obligatory fail. Fixes minor issue with non-JSON output for macOS.
  31. ### `v5.0.0`
  32. #### Breaking Changes
  33. _Note/TL;DR_: If you are just using `node-notifier` with things like `message`, `title` and `icon`, v5 should work just as before.
  34. 1. CLI is now removed. Can be found in separate project: https://github.com/mikaelbr/node-notifier-cli. This means you no longer get the `notify` bin when installing `node-notifier`. To get this do `npm i [-g] node-notifier-cli`
  35. 2. Changed toaster implementation from `toast.exe` to [Snoretoast](https://github.com/KDE/snoretoast). This means if you are using your custom fork, you need to change. SnoreToast has some better default implemented functionality.
  36. 3. [terminal-notifier](https://github.com/julienXX/terminal-notifier) dependency has been bumped to `v1.7.1`. With that there can be changes in the API, and supports now reply and buttons. Output has changed to JSON by default, this means the output of some functions of the terminal-notifier has broken. See https://github.com/julienXX/terminal-notifier for more details. See [README](https://github.com/mikaelbr/node-notifier#usage-notificationcenter) for documentation on how to use the new features, or [an example file](https://github.com/mikaelbr/node-notifier/blob/master/example/macInput.js).
  37. 4. `notify` method will now throw error if second argument is something else than function (still optional): [#138](https://github.com/mikaelbr/node-notifier/pull/138).
  38. #### Additions
  39. 1. Now supports \*BSD systems: [#142](https://github.com/mikaelbr/node-notifier/pull/142).
  40. 2. With the new toaster implementation you can do more! For instance customize sound and close notification. See all options:
  41. ```javascript
  42. {
  43. title: void 0, // String. Required
  44. message: void 0, // String. Required if remove is not defined
  45. icon: void 0, // String. Absolute path to Icon
  46. sound: false, // Bool | String (as defined by http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx)
  47. wait: false, // Bool. Wait for User Action against Notification or times out
  48. id: void 0, // Number. ID to use for closing notification.
  49. appID: void 0, // String. App.ID. Don't create a shortcut but use the provided app id.
  50. remove: void 0, // Number. Refer to previously created notification to close.
  51. install: void 0 // String (path, application, app id). Creates a shortcut <path> in the start menu which point to the executable <application>, appID used for the notifications.
  52. }
  53. ```
  54. #### Fixes
  55. 1. Fixes new lines on messages on Windows: [#123](https://github.com/mikaelbr/node-notifier/issues/123)
  56. #### Technical Changes
  57. _Internal changes for those who might be interested_.
  58. 1. Dependencies bumped
  59. 2. Unnecessary dependencies removed (`lodash.deepClone`). Now uses JSON serialize/deserialize instead.
  60. 3. Project is auto-formatted by [`prettier`](https://github.com/jlongster/prettier).
  61. 4. [Linting is added](https://github.com/mikaelbr/node-notifier/blob/master/.eslintrc)
  62. 5. Added way to better debug what is happening by setting `DEBUG` env-var to `true`. See [CONTRIBUTE.md](https://github.com/mikaelbr/node-notifier/blob/master/CONTRIBUTE.md) for more details.
  63. ### `v4.6.1`
  64. 1. Adds npm ignore file, ignoring tests and examples from package.
  65. 2. Fixes CI builds.
  66. ### `v4.6.0`
  67. 1. Adds support for Icon URL in Growl ([by @gucong3000](https://github.com/mikaelbr/node-notifier/pull/115))
  68. 2. Adds options for passing host and port to cli tool ([reported by @el-davo](https://github.com/mikaelbr/node-notifier/issues/106))
  69. 3. Fixes sanitize response on `notify` callback ([by @MadLittleMods](https://github.com/mikaelbr/node-notifier/commit/a44454a11eff452a8b55f9fbe291e189ed088708))
  70. 4. Fixes use of new line in messages ([by @gucong3000](https://github.com/mikaelbr/node-notifier/pull/115))
  71. 5. Fixes use of `file:///xxx` protocol icon paths for Windows 8.1 ([by @gucong3000](https://github.com/mikaelbr/node-notifier/pull/118))
  72. 6. Fixes non-TTY usage and piping messages ([reported by @simensen](https://github.com/mikaelbr/node-notifier/issues/109))
  73. 7. Updates vendor terminal-notifier version to 1.6.3 ([reported by @kid-icarus](https://github.com/mikaelbr/node-notifier/pull/120))
  74. ### `v4.5.0`
  75. #### Additions
  76. 1. Adds syntactic sugar for `notify`. Now able to just pass message:
  77. ```js
  78. notifier.notify('My message');
  79. ```
  80. See [#45](https://github.com/mikaelbr/node-notifier/issues/45) for more info.
  81. #### Fixes
  82. 1. Improvements to docs and examples
  83. 2. Updates `semver` dependency to support Webpacking with Electron.
  84. ### `v4.4.0`
  85. 1. Changes to exec terminal-notifier through execFile to allow for asar-packages
  86. 2. Adds support for remote growl server
  87. 3. Adds support for win7 with electron asar-package
  88. ### `v4.3.1`
  89. Obligatory patch fix:
  90. 1. Adds new stdin CLI options to docs
  91. ### `v4.3.0`
  92. 1. Adds support for piping messages in to CLI.
  93. (With `node-notifier` installed as a CLI `npm i -g node-notifier`)
  94. ```shell
  95. ➜ echo "Message" | notify
  96. ➜ echo "Message" | notify -t "My Title"
  97. ➜ echo "Some message" | notify -t "My Title" -s
  98. ```
  99. ### `v4.2.3`
  100. 1. Fixed input arguments to CLI to be strings where they should be strings.
  101. ### `v4.2.2`
  102. 1. Fixed no notification when no message for the CLI. [#58](https://github.com/mikaelbr/node-notifier/pull/58)
  103. 2. Changes `which` test to be sync, avoiding some edge cases with multiple notifications.
  104. ### `v4.2.1`
  105. 1. Minor fix for docs in CLI usage
  106. ### `v4.2.0`
  107. 1. Adds CLI support.
  108. 2. Fixes Debug "HRESULT : 0xC00CE508" exception on Win8. PR [#49](https://github.com/mikaelbr/node-notifier/pull/49)
  109. ### `v4.1.2`
  110. 1. Fixes correct terminal-notifier (own fork https://github.com/mikaelbr/terminal-notifier)
  111. to support activate / click.
  112. ### `v4.1.1`
  113. 1. Fixes proper error codes for balloon: #42
  114. 2. Removes unused debug files: #41
  115. 3. Patches differences between subtitle for notify-send: #43
  116. 4. Updates terminal-notifier dependency (removing black borders) #44 #18
  117. ### `v4.1.0`
  118. 1. Adds support for changing host and port for Growl.
  119. ### `v4.0.3`
  120. 1. Fixes Notification center issue with multiple callback events.
  121. 2. Fixes error in source code: Fixes long-spaces to proper spaces
  122. ### `v4.0.2`
  123. 1. Fixes issue with immidiate notifu notifications (with `wait : false`)
  124. 2. Fixes issue with boolean flags for notifu.
  125. 3. Restructures directories. Making it easier to require notifiers directly.
  126. ### `v4.0.1`
  127. 1. Fixes issue with optional callback for notify-send
  128. ### `v4.0.0`
  129. Major changes and breaking API.
  130. 1. require('node-notifier') now returns an instance with fallbackable notifications.
  131. ```js
  132. var notifier = require('node-notifier');
  133. notifier.notify();
  134. ```
  135. 2. Introduced a `wait` property (default `false`), to get user input for
  136. Notification Center, Windows Toaster, Windows Balloons and Growl. Sadly not
  137. for notify-send.
  138. ```js
  139. var notifier = require('node-notifier');
  140. notifier.notify({ wait: true }, function(err, response) {
  141. // response is response after user have interacted
  142. // with the notification or the notification has timed out.
  143. });
  144. ```
  145. 3. All notification instances are now event emitters, emitting events
  146. `click` or `timeout`. This is only applicable if `{ wait: true }`.
  147. ```js
  148. var notifier = require('node-notifier');
  149. notifier.on('click', function(notificationObject, options) {
  150. // options.someArbitraryData === 'foo'
  151. });
  152. notifier.notify({ wait: true, someArbitraryData: 'foo' });
  153. ```
  154. 4. WindowsToaster and NotificationCenter now can have sounds by doing `{ sound: true }`.
  155. Default NotificationCenter sound is Bottle. Can still use define sound on
  156. Mac:
  157. ```js
  158. var notifier = require('node-notifier');
  159. notifier.notify({ sound: true });
  160. // For mac (same as sound: true on Windows 8)
  161. notifier.notify({ sound: 'Morse' });
  162. ```
  163. ### `v3.4.0`
  164. 1. Adds Growl as priority over Balloons
  165. ### `v3.3.0`
  166. 1. Adds support for native Windows 7 and earlier (through task bar balloons)
  167. 2. Changes growl implementation. Adds better support for GNTP
  168. ### `v3.2.1`
  169. 1. Fixes support for notifications from folders with spaces on Windows.
  170. ### `v3.2.0`
  171. 1. Adds native Windows 8 support.
  172. ### `v3.1.0`
  173. 1. Adds Growl as fallback for Mac OS X pre 10.8.
  174. ### `v3.0.6`
  175. 1. Fixes typo: Changes Growl app name from `Gulp` to `Node`.
  176. ### `v3.0.5`
  177. 1. Maps common options between the different notifiers. Allowing for common usage with different notifiers.
  178. ### `v3.0.4`
  179. 1. Fixes expires for notify-send (Issue #13)
  180. ### `v3.0.2`
  181. 1. Fixes version check for Mac OS X Yosemite
  182. ### `v3.0.0`
  183. 1. Updates terminal-notifier to version 1.6.0; adding support for appIcon and contentImage
  184. 2. Removes parsing of output sent from notifier (Notification Center)