simen-keyboard-listener 1.0.5 → 1.0.6

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,6 +1,6 @@
 {
   "name": "simen-keyboard-listener",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Native global keyboard listener for macOS and Windows",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -23,7 +23,7 @@
     "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",
+    "prebuild": "prebuildify --napi --strip --cwd src/native --out ../../prebuilds",
     "prepublishOnly": "npm run build:ts"
   },
   "keywords": [

package/src/native/simen_keyboard_listener.cc

@@ -70,6 +70,16 @@ void emitKeyEvent(const std::string& name, const std::string& state) {
 
 namespace {
 
+// Check if the app has accessibility permission (required for CGEventTap)
+static bool macHasAccessibilityPermission() {
+	// AXIsProcessTrusted returns true if the app has accessibility permission
+	return AXIsProcessTrusted();
+}
+
+} // namespace
+
+namespace {
+
 CFMachPortRef g_eventTap = nullptr;
 CFRunLoopSourceRef g_runLoopSource = nullptr;
 CFRunLoopRef g_runLoop = nullptr;
@@ -226,6 +236,13 @@ static CGEventRef macEventTapCallback(CGEventTapProxy /*proxy*/, CGEventType typ
 }
 
 static void macThreadMain() {
+	// Pre-check accessibility permission before attempting to create event tap
+	if (!macHasAccessibilityPermission()) {
+		g_running.store(false);
+		setStartResult(-1);
+		return;
+	}
+
 	CGEventMask mask = CGEventMaskBit(kCGEventKeyDown) |
 		CGEventMaskBit(kCGEventKeyUp) |
 		CGEventMaskBit(kCGEventFlagsChanged);
@@ -617,10 +634,26 @@ static Napi::Value IsRunning(const Napi::CallbackInfo& info) {
 	return Napi::Boolean::New(info.Env(), g_running.load());
 }
 
+// Check if the app has permission to listen to global keyboard events
+// Returns: true if permission granted, false otherwise
+// On Windows, always returns true (no special permission needed)
+// On macOS, checks accessibility permission
+static Napi::Value CheckPermission(const Napi::CallbackInfo& info) {
+#if defined(__APPLE__)
+	return Napi::Boolean::New(info.Env(), macHasAccessibilityPermission());
+#elif defined(_WIN32)
+	// Windows doesn't require special permission for keyboard hooks
+	return Napi::Boolean::New(info.Env(), true);
+#else
+	return Napi::Boolean::New(info.Env(), false);
+#endif
+}
+
 static Napi::Object Init(Napi::Env env, Napi::Object exports) {
 	exports.Set("start", Napi::Function::New(env, Start));
 	exports.Set("stop", Napi::Function::New(env, Stop));
 	exports.Set("isRunning", Napi::Function::New(env, IsRunning));
+	exports.Set("checkPermission", Napi::Function::New(env, CheckPermission));
 	return exports;
 }