simen-keyboard-listener 1.0.5 → 1.0.7

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Simen
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Simen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,69 +1,69 @@
-# simen-keyboard-listener
-
-Native global keyboard listener for macOS and Windows. Captures keyboard events system-wide, including special keys like FN that cannot be detected via standard DOM events.
-
-## Installation
-
-```bash
-npm install simen-keyboard-listener
-```
-
-## Usage
-
-```typescript
-import { getGlobalKeyboardListener } from 'simen-keyboard-listener';
-
-const listener = getGlobalKeyboardListener();
-
-listener.addListener((event, isDown) => {
-  console.log(`Key: ${event.name}, State: ${event.state}`);
-});
-
-// Later, to stop listening:
-listener.removeListener(myListener);
-```
-
-## API
-
-### `getGlobalKeyboardListener(): IGlobalKeyboardListener`
-
-Returns the singleton keyboard listener instance.
-
-### `IGlobalKeyboardListener`
-
-- `addListener(listener: IGlobalKeyListener): void` - Add a key event listener
-- `removeListener(listener: IGlobalKeyListener): void` - Remove a listener
-- `kill(): void` - Stop the listener (only when no listeners remain)
-
-### `IGlobalKeyEvent`
-
-```typescript
-interface IGlobalKeyEvent {
-  readonly name: string;   // e.g. "FN", "LEFT SHIFT", "A", "ESCAPE"
-  readonly state: 'DOWN' | 'UP';
-}
-```
-
-## Supported Keys
-
-- **Modifiers**: FN (macOS), SHIFT, CTRL, ALT, META (Cmd/Win)
-- **Letters**: A-Z
-- **Numbers**: 0-9
-- **Function keys**: F1-F12 (Windows)
-- **Special**: ESCAPE, SPACE, RETURN, TAB, BACKSPACE, DELETE
-- **Arrows**: UP, DOWN, LEFT, RIGHT
-
-## Platform Support
-
-- macOS (x64, arm64)
-- Windows (x64, arm64)
-
-## Requirements
-
-- Node.js >= 18.0.0
-- macOS: Accessibility permission required
-- Windows: No special permissions needed
-
-## License
-
-MIT
+# simen-keyboard-listener
+
+Native global keyboard listener for macOS and Windows. Captures keyboard events system-wide, including special keys like FN that cannot be detected via standard DOM events.
+
+## Installation
+
+```bash
+npm install simen-keyboard-listener
+```
+
+## Usage
+
+```typescript
+import { getGlobalKeyboardListener } from 'simen-keyboard-listener';
+
+const listener = getGlobalKeyboardListener();
+
+listener.addListener((event, isDown) => {
+  console.log(`Key: ${event.name}, State: ${event.state}`);
+});
+
+// Later, to stop listening:
+listener.removeListener(myListener);
+```
+
+## API
+
+### `getGlobalKeyboardListener(): IGlobalKeyboardListener`
+
+Returns the singleton keyboard listener instance.
+
+### `IGlobalKeyboardListener`
+
+- `addListener(listener: IGlobalKeyListener): void` - Add a key event listener
+- `removeListener(listener: IGlobalKeyListener): void` - Remove a listener
+- `kill(): void` - Stop the listener (only when no listeners remain)
+
+### `IGlobalKeyEvent`
+
+```typescript
+interface IGlobalKeyEvent {
+  readonly name: string;   // e.g. "FN", "LEFT SHIFT", "A", "ESCAPE"
+  readonly state: 'DOWN' | 'UP';
+}
+```
+
+## Supported Keys
+
+- **Modifiers**: FN (macOS), SHIFT, CTRL, ALT, META (Cmd/Win)
+- **Letters**: A-Z
+- **Numbers**: 0-9
+- **Function keys**: F1-F12 (Windows)
+- **Special**: ESCAPE, SPACE, RETURN, TAB, BACKSPACE, DELETE
+- **Arrows**: UP, DOWN, LEFT, RIGHT
+
+## Platform Support
+
+- macOS (x64, arm64)
+- Windows (x64, arm64)
+
+## Requirements
+
+- Node.js >= 18.0.0
+- macOS: Accessibility permission required
+- Windows: No special permissions needed
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -23,5 +23,14 @@ declare function getGlobalKeyboardListener(): IGlobalKeyboardListener;
  * This function is kept for backward compatibility but now returns the singleton.
  */
 declare function createGlobalKeyboardListener(): IGlobalKeyboardListener;
+/**
+ * Check if the app has permission to listen to global keyboard events.
+ * - On macOS: checks accessibility permission (System Preferences > Security & Privacy > Accessibility)
+ * - On Windows: always returns true (no special permission needed)
+ * - On other platforms: returns false
+ *
+ * Call this before starting the listener to provide better UX when permission is missing.
+ */
+declare function checkKeyboardPermission(): boolean;
 
-export { type IGlobalKeyDownMap, type IGlobalKeyEvent, type IGlobalKeyListener, type IGlobalKeyState, type IGlobalKeyboardListener, createGlobalKeyboardListener, getGlobalKeyboardListener };
+export { type IGlobalKeyDownMap, type IGlobalKeyEvent, type IGlobalKeyListener, type IGlobalKeyState, type IGlobalKeyboardListener, checkKeyboardPermission, createGlobalKeyboardListener, getGlobalKeyboardListener };

package/dist/index.d.ts

@@ -23,5 +23,14 @@ declare function getGlobalKeyboardListener(): IGlobalKeyboardListener;
  * This function is kept for backward compatibility but now returns the singleton.
  */
 declare function createGlobalKeyboardListener(): IGlobalKeyboardListener;
+/**
+ * Check if the app has permission to listen to global keyboard events.
+ * - On macOS: checks accessibility permission (System Preferences > Security & Privacy > Accessibility)
+ * - On Windows: always returns true (no special permission needed)
+ * - On other platforms: returns false
+ *
+ * Call this before starting the listener to provide better UX when permission is missing.
+ */
+declare function checkKeyboardPermission(): boolean;
 
-export { type IGlobalKeyDownMap, type IGlobalKeyEvent, type IGlobalKeyListener, type IGlobalKeyState, type IGlobalKeyboardListener, createGlobalKeyboardListener, getGlobalKeyboardListener };
+export { type IGlobalKeyDownMap, type IGlobalKeyEvent, type IGlobalKeyListener, type IGlobalKeyState, type IGlobalKeyboardListener, checkKeyboardPermission, createGlobalKeyboardListener, getGlobalKeyboardListener };

package/dist/index.js

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  checkKeyboardPermission: () => checkKeyboardPermission,
   createGlobalKeyboardListener: () => createGlobalKeyboardListener,
   getGlobalKeyboardListener: () => getGlobalKeyboardListener
 });
@@ -161,8 +162,20 @@ function getGlobalKeyboardListener() {
 function createGlobalKeyboardListener() {
   return getGlobalKeyboardListener();
 }
+function checkKeyboardPermission() {
+  if (process.platform !== "darwin" && process.platform !== "win32") {
+    return false;
+  }
+  try {
+    const addon = getNativeAddon();
+    return addon.checkPermission();
+  } catch {
+    return false;
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  checkKeyboardPermission,
   createGlobalKeyboardListener,
   getGlobalKeyboardListener
 });

package/dist/index.mjs

@@ -132,7 +132,19 @@ function getGlobalKeyboardListener() {
 function createGlobalKeyboardListener() {
   return getGlobalKeyboardListener();
 }
+function checkKeyboardPermission() {
+  if (process.platform !== "darwin" && process.platform !== "win32") {
+    return false;
+  }
+  try {
+    const addon = getNativeAddon();
+    return addon.checkPermission();
+  } catch {
+    return false;
+  }
+}
 export {
+  checkKeyboardPermission,
   createGlobalKeyboardListener,
   getGlobalKeyboardListener
 };

package/package.json

@@ -1,57 +1,57 @@
-{
-  "name": "simen-keyboard-listener",
-  "version": "1.0.5",
-  "description": "Native global keyboard listener for macOS and Windows",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "prebuilds",
-    "src/native/binding.gyp",
-    "src/native/package.json",
-    "src/native/simen_keyboard_listener.cc"
-  ],
-  "scripts": {
-    "build:native": "node-gyp rebuild --directory=src/native",
-    "build:ts": "tsup src/index.ts --format cjs,esm --dts --clean",
-    "build": "npm run build:native && npm run build:ts",
-    "prebuild": "prebuildify --napi --strip --cwd src/native",
-    "prepublishOnly": "npm run build:ts"
-  },
-  "keywords": [
-    "keyboard",
-    "hotkey",
-    "global",
-    "native",
-    "addon",
-    "macos",
-    "windows"
-  ],
-  "author": "Simen",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/user/simen-keyboard-listener"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "dependencies": {
-    "node-addon-api": "^8.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "node-gyp": "^10.0.0",
-    "prebuildify": "^6.0.1",
-    "tsup": "^8.0.0",
-    "typescript": "^5.0.0"
-  }
-}
+{
+  "name": "simen-keyboard-listener",
+  "version": "1.0.7",
+  "description": "Native global keyboard listener for macOS and Windows",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "prebuilds",
+    "src/native/binding.gyp",
+    "src/native/package.json",
+    "src/native/simen_keyboard_listener.cc"
+  ],
+  "scripts": {
+    "build:native": "node-gyp rebuild --directory=src/native",
+    "build:ts": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "build": "npm run build:native && npm run build:ts",
+    "prebuild": "prebuildify --napi --strip --cwd src/native --out ../../prebuilds",
+    "prepublishOnly": "npm run build:ts"
+  },
+  "keywords": [
+    "keyboard",
+    "hotkey",
+    "global",
+    "native",
+    "addon",
+    "macos",
+    "windows"
+  ],
+  "author": "Simen",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/user/simen-keyboard-listener"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "node-addon-api": "^8.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "node-gyp": "^10.0.0",
+    "prebuildify": "^6.0.1",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  }
+}

package/src/native/binding.gyp

@@ -1,40 +1,40 @@
-{
-  "targets": [
-    {
-      "target_name": "simen_keyboard_listener",
-      "sources": [
-        "simen_keyboard_listener.cc"
-      ],
-      "include_dirs": [
-        "<!@(node -p \"require('node-addon-api').include\")"
-      ],
-      "defines": [
-        "NAPI_DISABLE_CPP_EXCEPTIONS"
-      ],
-      "cflags!": [ "-fno-exceptions" ],
-      "cflags_cc!": [ "-fno-exceptions" ],
-      "xcode_settings": {
-        "GCC_ENABLE_CPP_EXCEPTIONS": "NO",
-        "CLANG_CXX_LIBRARY": "libc++",
-        "MACOSX_DEPLOYMENT_TARGET": "11.0"
-      },
-      "msvs_settings": {
-        "VCCLCompilerTool": { "ExceptionHandling": 0 }
-      },
-      "conditions": [
-        ["OS=='mac'", {
-          "xcode_settings": {
-            "OTHER_LDFLAGS": [
-              "-framework", "ApplicationServices"
-            ]
-          }
-        }],
-        ["OS=='win'", {
-          "libraries": [
-            "User32.lib"
-          ]
-        }]
-      ]
-    }
-  ]
-}
+{
+  "targets": [
+    {
+      "target_name": "simen_keyboard_listener",
+      "sources": [
+        "simen_keyboard_listener.cc"
+      ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      "defines": [
+        "NAPI_DISABLE_CPP_EXCEPTIONS"
+      ],
+      "cflags!": [ "-fno-exceptions" ],
+      "cflags_cc!": [ "-fno-exceptions" ],
+      "xcode_settings": {
+        "GCC_ENABLE_CPP_EXCEPTIONS": "NO",
+        "CLANG_CXX_LIBRARY": "libc++",
+        "MACOSX_DEPLOYMENT_TARGET": "11.0"
+      },
+      "msvs_settings": {
+        "VCCLCompilerTool": { "ExceptionHandling": 0 }
+      },
+      "conditions": [
+        ["OS=='mac'", {
+          "xcode_settings": {
+            "OTHER_LDFLAGS": [
+              "-framework", "ApplicationServices"
+            ]
+          }
+        }],
+        ["OS=='win'", {
+          "libraries": [
+            "User32.lib"
+          ]
+        }]
+      ]
+    }
+  ]
+}

package/src/native/package.json

@@ -1,14 +1,14 @@
-{
-  "name": "simen-keyboard-listener-native",
-  "version": "1.0.0",
-  "private": true,
-  "gypfile": true,
-  "scripts": {
-    "install": "node-gyp rebuild",
-    "build": "node-gyp rebuild",
-    "clean": "node-gyp clean"
-  },
-  "dependencies": {
-    "node-addon-api": "^8.0.0"
-  }
-}
+{
+  "name": "simen-keyboard-listener-native",
+  "version": "1.0.0",
+  "private": true,
+  "gypfile": true,
+  "scripts": {
+    "install": "node-gyp rebuild",
+    "build": "node-gyp rebuild",
+    "clean": "node-gyp clean"
+  },
+  "dependencies": {
+    "node-addon-api": "^8.0.0"
+  }
+}