@miniben90/x-win 1.7.1 → 1.8.0

package/README.md

@@ -6,7 +6,7 @@
 ![NPM License](https://img.shields.io/npm/l/@miniben90/x-win)
 ![NPM Version](https://img.shields.io/npm/v/%40miniben90%2Fx-win)
 
-This project uses Rust and napi-rs to make it easy to obtain the active window or an array of open windows. It works on Microsoft Windows (10, 11), [Linux (with X server)](#linux), and [macOS 10.6+](#darwin).
+This project uses Rust and napi-rs to make it easy to obtain the active window or an array of open windows. It works on Microsoft Windows (10, 11), [Linux (with X server)](#linux), [Linux (with Gnome =< 45)](#GNOME), and [macOS 10.6+](#darwin).
 
 ## How to install
 
@@ -128,7 +128,6 @@ Thread will be start to check every `100ms` for a new active window (checking wi
 * `unsubscribeActiveWindow`: Remove a specific subscription
 * `unsubscribeAllActiveWindow`: Remove all threads
 
-
 ```typescript
 import { subscribeActiveWindow, unsubscribeActiveWindow, unsubscribeAllActiveWindow } from '@miniben90/x-win';
 
@@ -140,7 +139,6 @@ const b = subscribeActiveWindow(activeWindow => {
   console.log('test b', activeWindow);
 });
 
-
 const c = subscribeActiveWindow(activeWindow => {
   console.log('test c', activeWindow);
 });
@@ -150,28 +148,44 @@ setTimeout(() => unsubscribeActiveWindow(c), 5000);
 setTimeout(() => unsubscribeAllActiveWindow(), 10000);
 ```
 
-# Linux
+## Linux
 
 Dependencies are required to be installed for development purposes.
 
 ```sh
-sudo apt install libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxcb-shm0-dev
+sudo apt install libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxcb-shm0-dev pkg-config build-essential
 ```
 
 > ⚠️**Warning**
+> libc.so.6 is needed
 > Recovery url is not available on linux
 
-# Darwin (version 10.6+)
+
+### GNOME (Wayland)
+
+In order to recover data, you'll need to install and activate an extension designed for systems running GNOME version 41 or newer (as evaluation is disabled from this version onward).
+
+The extension can be installed using the `installExtension` function, which will deposit it in `~/.local/share/gnome-shell/extensions/x-win@miniben90.org`.
+
+After executing this function, it's vital to **restart the user session** to load the new extension and then proceed to enable it using `enableExtension` to be able to use x-win.
+
+| Gnome Distrib. | Tested |
+|---|---|
+| Fedora Workstation 39 | ✅ |
+| Ubuntu 22.04.4 Desktop | ✅ |
+| Debian 12 Desktop | ✅ |
+
+### Darwin (version 10.6+)
 
 ## Screen recording permission introduced in macOS 10.15 Catalina
 
 > macOS requires you to grant access for screen recording. If your project does not have it, the title will be an empty value.
 
-# URLs (Only available for Darwin and Windows Systems)
+## URLs (Only available for Darwin and Windows Systems)
 
 It is possible to get URL of browsers window for macOS and Windows.
 
-## Windows
+### Windows
 
 | Browser name | Tested |
 |---|---|
@@ -192,7 +206,7 @@ It is possible to get URL of browsers window for macOS and Windows.
 | beaker |  |
 | beaker browser |  |
 
-## macOS
+### macOS
 
 It will use AppleScript to get informations for chromium browsers and safari
 
@@ -230,7 +244,7 @@ It will use AppleScript to get informations for chromium browsers and safari
 
 <hr class="padding-top: 30px;padding-bottom:30px">
 
-# Project References
+## Project References
 
 **Project Inspirations:**
 

package/index.d.ts

@@ -44,7 +44,21 @@ export interface WindowInfo {
  * Returns an object of `WindowInfo`.
  *
  * # Example
+ *
+ * ## Javascript example
+ *
  * ```javascript
+ * const { activeWindow } = require('@miniben90/x-win');
+ *
+ * const currentWindow = activeWindow();
+ * console.log(currentWindow);
+ * ```
+ *
+ * ## Typescript example
+ *
+ * ```typescript
+ * import { activeWindow } from '@miniben90/x-win';
+ *
  * const currentWindow = activeWindow();
  * console.log(currentWindow);
  * ```
@@ -59,8 +73,22 @@ export function activeWindow(): WindowInfo
  * Returns an object of `WindowInfo`.
  *
  * # Example
+ *
+ * ## Javascript example
+ *
  * ```javascript
- * activeWindow()
+ * activeWindowAsync()
+ * .then(currentWindow => {
+ *   console.log(currentWindow);
+ * });
+ * ```
+ *
+ * ## Typescript example
+ *
+ * ```typescript
+ * import { activeWindowAsync } from '@miniben90/x-win';
+ *
+ * activeWindowAsync()
  * .then(currentWindow => {
  *   console.log(currentWindow);
  * });
@@ -76,7 +104,23 @@ export function activeWindowAsync(): Promise<WindowInfo>
  * Returns an array of `WindowInfo`, each containing details about a specific open window.
  *
  * # Example
+ *
+ * ## Javascript example
+ *
  * ```javascript
+ * const { openWindows } = require('@miniben90/x-win');
+ *
+ * const windows = openWindows();
+ * for (let i = 0; i < windows.length; i++) {
+ *   console.log(i, windows[i]);
+ * }
+ * ```
+ *
+ * ## Typescript Example
+ *
+ * ```typescript
+ * import { openWindows } from '@miniben90/x-win';
+ *
  * const windows = openWindows();
  * for (let i = 0; i < windows.length; i++) {
  *   console.log(i, windows[i]);
@@ -93,8 +137,26 @@ export function openWindows(): Array<WindowInfo>
  * Returns an array of `WindowInfo`, each containing details about a specific open window.
  *
  * # Example
+ *
+ * ## Javascript example
+ *
  * ```javascript
- * openWindows()
+ * const { openWindowsAsync } = resuire('@miniben90/x-win');
+ *
+ * openWindowsAsync()
+ * .then(windows => {
+ *   for (let i = 0; i < windows.length; i++) {
+ *     console.log(i, windows[i]);
+ *   }
+ * });
+ * ```
+ *
+ * ## Typescript example
+ *
+ * ```typescript
+ * import { openWindowsAsync } from '@miniben90/x-win';
+ *
+ * openWindowsAsync()
  * .then(windows => {
  *   for (let i = 0; i < windows.length; i++) {
  *     console.log(i, windows[i]);
@@ -111,7 +173,30 @@ export function openWindowsAsync(): Promise<Array<WindowInfo>>
  * Subscribe an observer thread to monitor changes in the active window.
  *
  * # Example
+ *
+ * ## Javascript example
+ *
  * ```javascript
+ * const { subscribeActiveWindow, unsubscribeAllActiveWindow } = require('@miniben90/x-win');
+ *
+ * const a = subscribeActiveWindow((info) => {
+ *   t.log(a, info);
+ * });
+ * const b = subscribeActiveWindow((info) => {
+ *   t.log(b, info);
+ * });
+ * const c = subscribeActiveWindow((info) => {
+ *   t.log(c, info);
+ * });
+ *
+ * unsubscribeAllActiveWindow();
+ * ```
+ *
+ * ## Typescript example
+ *
+ * ```typescript
+ * import { subscribeActiveWindow, unsubscribeAllActiveWindow } from '@miniben90/x-win';
+ *
  * const a = subscribeActiveWindow((info) => {
  *   t.log(a, info);
  * });
@@ -124,13 +209,39 @@ export function openWindowsAsync(): Promise<Array<WindowInfo>>
  *
  * unsubscribeAllActiveWindow();
  * ```
+ *
 */
 export function subscribeActiveWindow(callback: (info: WindowInfo) => void): number
 /**
  * Terminate and unsubscribe a specific observer using their ID.
  *
  * # Example
+ *
+ * ## Javascript example
+ *
  * ```javascript
+ * const { subscribeActiveWindow, unsubscribeActiveWindow } = require('@miniben90/x-win');
+ *
+ * const a = subscribeActiveWindow((info) => {
+ *   t.log(a, info);
+ * });
+ * const b = subscribeActiveWindow((info) => {
+ *   t.log(b, info);
+ * });
+ * const c = subscribeActiveWindow((info) => {
+ *   t.log(c, info);
+ * });
+ *
+ * unsubscribeActiveWindow(a);
+ * unsubscribeActiveWindow(b);
+ * unsubscribeActiveWindow(c);
+ * ```
+ *
+ * ## Typescript example
+ *
+ * ```typescript
+ * import { subscribeActiveWindow, unsubscribeActiveWindow } from '@miniben90/x-win';
+ *
  * const a = subscribeActiveWindow((info) => {
  *   t.log(a, info);
  * });
@@ -151,7 +262,30 @@ export function unsubscribeActiveWindow(threadId: number): void
  * Terminate and unsubscribe all observer threads monitoring changes in the active window.
  *
  * # Example
+ *
+ * ## Javascript example
+ *
  * ```javascript
+ * const { subscribeActiveWindow, unsubscribeAllActiveWindow } = require('@miniben90/x-win');
+ *
+ * const a = subscribeActiveWindow((info) => {
+ *   t.log(a, info);
+ * });
+ * const b = subscribeActiveWindow((info) => {
+ *   t.log(b, info);
+ * });
+ * const c = subscribeActiveWindow((info) => {
+ *   t.log(c, info);
+ * });
+ *
+ * unsubscribeAllActiveWindow();
+ * ```
+ *
+ * ## Typescript example
+ *
+ * ```typescript
+ * import { subscribeActiveWindow, unsubscribeAllActiveWindow } from '@miniben90/x-win';
+ *
  * const a = subscribeActiveWindow((info) => {
  *   t.log(a, info);
  * });
@@ -166,3 +300,25 @@ export function unsubscribeActiveWindow(threadId: number): void
  * ```
 */
 export function unsubscribeAllActiveWindow(): void
+/**
+ * Install Gnome extensions required for Linux using Gnome > 41.
+ * This function will write extension files needed to correctly detect working windows with Wayland desktop environment.
+ * Restart session will be require to install the gnome extension.
+*/
+export function installExtension(): boolean
+/**
+ * Install Gnome extensions required for Linux using Gnome > 41.
+ * This function will write extension files needed to correctly detect working windows with Wayland desktop environment.
+ * Restart session will be require to remove the gnome extension.
+*/
+export function uninstallExtension(): boolean
+/**
+ * Enable Gnome extensions required for Linux using Gnome > 41.
+ * This function will enable extension needed to correctly detect working windows with Wayland desktop environment.
+*/
+export function enableExtension(): boolean
+/**
+ * Disable Gnome extensions required for Linux using Gnome > 41.
+ * This function will disable extension needed to correctly detect working windows with Wayland desktop environment.
+*/
+export function disableExtension(): boolean

package/index.js

@@ -266,6 +266,20 @@ switch (platform) {
           }
         }
         break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'x-win.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./x-win.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@miniben90/x-win-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
       default:
         throw new Error(`Unsupported architecture on Linux: ${arch}`)
     }
@@ -281,7 +295,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { activeWindow, activeWindowAsync, openWindows, openWindowsAsync, subscribeActiveWindow, unsubscribeActiveWindow, unsubscribeAllActiveWindow } = nativeBinding
+const { activeWindow, activeWindowAsync, openWindows, openWindowsAsync, subscribeActiveWindow, unsubscribeActiveWindow, unsubscribeAllActiveWindow, installExtension, uninstallExtension, enableExtension, disableExtension } = nativeBinding
 
 module.exports.activeWindow = activeWindow
 module.exports.activeWindowAsync = activeWindowAsync
@@ -290,3 +304,7 @@ module.exports.openWindowsAsync = openWindowsAsync
 module.exports.subscribeActiveWindow = subscribeActiveWindow
 module.exports.unsubscribeActiveWindow = unsubscribeActiveWindow
 module.exports.unsubscribeAllActiveWindow = unsubscribeAllActiveWindow
+module.exports.installExtension = installExtension
+module.exports.uninstallExtension = uninstallExtension
+module.exports.enableExtension = enableExtension
+module.exports.disableExtension = disableExtension

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@miniben90/x-win",
   "description": "This package allows you to retrieve precise information about active and open windows on Windows, MacOS, and Linux. You can obtain the position, size, title, and other memory of windows.",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -41,11 +41,12 @@
     "open"
   ],
   "devDependencies": {
-    "@napi-rs/cli": "^2.17.0",
-    "ava": "^6.0.1"
+    "@napi-rs/cli": "^2.18.0",
+    "ava": "^6.1.2"
   },
   "ava": {
-    "timeout": "3m"
+    "timeout": "3m",
+    "failFast": true
   },
   "engines": {
     "node": ">= 14"
@@ -61,12 +62,12 @@
   },
   "packageManager": "yarn@4.0.2",
   "optionalDependencies": {
-    "@miniben90/x-win-win32-x64-msvc": "1.7.1",
-    "@miniben90/x-win-darwin-x64": "1.7.1",
-    "@miniben90/x-win-linux-x64-gnu": "1.7.1",
-    "@miniben90/x-win-darwin-arm64": "1.7.1",
-    "@miniben90/x-win-win32-arm64-msvc": "1.7.1",
-    "@miniben90/x-win-win32-ia32-msvc": "1.7.1",
-    "@miniben90/x-win-darwin-universal": "1.7.1"
+    "@miniben90/x-win-win32-x64-msvc": "1.8.0",
+    "@miniben90/x-win-darwin-x64": "1.8.0",
+    "@miniben90/x-win-linux-x64-gnu": "1.8.0",
+    "@miniben90/x-win-darwin-arm64": "1.8.0",
+    "@miniben90/x-win-win32-arm64-msvc": "1.8.0",
+    "@miniben90/x-win-win32-ia32-msvc": "1.8.0",
+    "@miniben90/x-win-darwin-universal": "1.8.0"
   }
 }