Merge branch 'develop'

Author: s1hofmann

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.3.0
+- Bugfix: Segmentation Fault when retrieving window title [(#377)](https://github.com/nut-tree/nut.js/issues/377)
+- Enhancement: Automatically check and request required permissions on macOS [(#377)](https://github.com/nut-tree/nut.js/issues/377)
+
 ## 2.2.1
 - Enhancement: Scale easing function result by base speed before applying [(#425)](https://github.com/nut-tree/nut.js/issues/425)
 - Maintenance: Resolve security vulnerabilities [(#422)](https://github.com/nut-tree/nut.js/issues/422)
@@ -161,4 +165,4 @@ All notable changes to this project will be documented in this file.
 
 ## 0.1.0-beta.1
 
-- Enabled pre-built OpenCV bindings via `opencv4nodejs-prebuilt`
+- Enabled pre-built OpenCV bindings via `opencv4nodejs-prebuilt`

README.md

@@ -160,17 +160,24 @@ You can install them by running
 xcode-select --install
 ```
 
-**Attention**:
+**Permissions**:
+
+nut.js requires the executing application, e.g. your terminal, to be given both `Accessibility` and `Screen Recording` permissions.
 
-In case you're experiencing problems like your mouse not moving or your keyboard not typing,
-please make sure to give the process you're executing your tests with accessibility permissions.
+Starting with release `2.3.0`, nut.js will check for and request these permissions automatically:
 
-nut.js will give you a subtle hint in case permissions are lacking:
+<p align="center">
+    <img src="https://github.com/nut-tree/nut.js/raw/develop/.gfx/permissions_popup.png" alt="Popup requesting screen recording permissions"/>
+</p>
 
-`##### WARNING! The application running this script is not a trusted process! Please visit https://github.com/nut-tree/nut.js#macos #####`
+It will also give you a subtle hint in case permissions are lacking:
+
+- Accessibility: `##### WARNING! The application running this script is not a trusted process! Please visit https://github.com/nut-tree/nut.js#macos #####`
+- Screen Recording: `##### WARNING! The application running this script is not allowed to capture screen content! Please visit https://github.com/nut-tree/nut.js#macos #####`
+
+**Attention**:
 
-When an application wants to use accessibility features, a permission pop-up should be shown.
-If not, you could try to manually add the application you're running the script from.
+Prior to release `2.3.0` you'll have to grant these permissions manually.
 
 `Settings -> Security & Privacy -> Privacy tab -> Accessibility -> Add...`
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@nut-tree/nut-js",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "license": "Apache-2.0",
   "main": "dist/index",
   "typings": "dist/index",
@@ -60,13 +60,12 @@
     "typedoc": "typedoc --options ./typedoc.js --entryPointStrategy expand ./lib"
   },
   "dependencies": {
-    "@nut-tree/libnut": "2.2.0",
+    "@nut-tree/libnut": "2.3.0",
     "clipboardy": "2.3.0",
     "jimp": "0.16.2",
     "node-abort-controller": "2.0.0"
   },
   "devDependencies": {
-    "@types/clipboardy": "2.0.1",
     "@types/jest": "27.0.1",
     "@types/node": "16.7.10",
     "istanbul-merge": "1.1.1",