@miniben90/x-win 1.10.0 → 1.10.2

package/LICENSE

@@ -1,7 +1,5 @@
 MIT License
 
-Copyright (c) 2023 BENKHADRA Hocine
-
 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

package/README.md

@@ -1,12 +1,13 @@
 # @miniben90/x-win
 
-[![CI](https://github.com/miniben-90/x-win/actions/workflows/CI.yml/badge.svg)](https://github.com/miniben-90/x-win/actions/workflows/CI.yml)
+[![ci-rs](https://github.com/miniben-90/x-win/actions/workflows/ci-rs.yml/badge.svg)](https://github.com/miniben-90/x-win/actions/workflows/ci-rs.yml)
+[![ci-napi](https://github.com/miniben-90/x-win/actions/workflows/ci-napi.yml/badge.svg)](https://github.com/miniben-90/x-win/actions/workflows/ci-napi.yml)
 [![Node version](https://img.shields.io/node/v/@miniben90/x-win.svg)](https://www.npmjs.com/package/@miniben90/x-win)
 ![npm type definitions](https://img.shields.io/npm/types/@miniben90/x-win)
-![NPM License](https://img.shields.io/npm/l/@miniben90/x-win)
+![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), [Linux (with Gnome =< 45)](#GNOME), 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)](#wayland), and [macOS 10.6+](#darwin).
 
 ## How to install
 
@@ -183,14 +184,12 @@ Dependencies are required to be installed for development purposes.
 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
-
-> ⚠️**Warning**
+> ⚠️**Warning**<br />
+> libc.so.6 is needed<br />
+> ⚠️**Warning**<br />
 > Recovery url is not available on linux
 
-
-### GNOME (Wayland)
+### 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).
 
@@ -204,7 +203,9 @@ After executing this function, it's vital to **restart the user session** to loa
 | Ubuntu 22.04.4 Desktop | ✅ |
 | Debian 12 Desktop | ✅ |
 
-### Darwin (version 10.6+)
+## Darwin
+
+> ⚠️**Warning**<br /> This project work only for macos version 10.6+
 
 ## Screen recording permission introduced in macOS 10.15 Catalina
 

package/index.d.ts

@@ -4,10 +4,12 @@
 /* auto-generated by NAPI-RS */
 
 /**
- * Struct to store usage data of the window
+ * Struct to store process information of the window
 */
-export interface UsageInfo {
-  memory: number
+export interface IconInfo {
+  data: string
+  height: number
+  width: number
 }
 /**
  * Struct to store process information of the window
@@ -18,6 +20,12 @@ export interface ProcessInfo {
   name: string
   execName: string
 }
+/**
+ * Struct to store usage data of the window
+*/
+export interface UsageInfo {
+  memory: number
+}
 /**
  * Struct to store position and size of the window
 */
@@ -28,14 +36,6 @@ export interface WindowPosition {
   height: number
   isFullScreen: boolean
 }
-/**
- * Struct to store process information of the window
-*/
-export interface IconInfo {
-  data: string
-  height: number
-  width: number
-}
 /**
  * Retrieve information the about currently active window.
  * Returns an object of `WindowInfo`.
@@ -298,15 +298,15 @@ export declare function unsubscribeActiveWindow(threadId: number): void
 */
 export declare function unsubscribeAllActiveWindow(): void
 /**
- * Install Gnome extensions required for Linux using Gnome > 41.
+ * Install "@mininben90/x-win" Gnome extension 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.
+ * **Restart session will be require to install the gnome extension.**
 */
 export declare 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.
+ * Uninstall "@mininben90/x-win" Gnome extension.
+ * This function will disable and remove extension files.
+ * **Restart session will be require to remove the gnome extension.**
 */
 export declare function uninstallExtension(): boolean
 /**
@@ -322,7 +322,7 @@ export declare function disableExtension(): boolean
 /**
  * Struct to store all informations of the window
 */
-export class WindowInfo {
+export declare class WindowInfo {
   id: number
   os: string
   title: string

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.10.0",
+  "version": "1.10.2",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -17,7 +17,8 @@
         "aarch64-apple-darwin",
         "aarch64-pc-windows-msvc",
         "i686-pc-windows-msvc",
-        "universal-apple-darwin"
+        "universal-apple-darwin",
+        "x86_64-unknown-linux-musl"
       ]
     }
   },
@@ -41,8 +42,9 @@
     "open"
   ],
   "devDependencies": {
-    "@napi-rs/cli": "^2.18.3",
-    "ava": "^6.1.3"
+    "@napi-rs/cli": "^2.18.4",
+    "ava": "^6.1.3",
+    "husky": "^9.1.4"
   },
   "ava": {
     "timeout": "3m",
@@ -61,16 +63,18 @@
     "prepublishOnly": "napi prepublish -t npm",
     "test": "ava",
     "universal": "napi universal",
-    "version": "napi version"
+    "version": "napi version",
+    "prepare": "husky"
   },
   "packageManager": "yarn@4.1.1",
   "optionalDependencies": {
-    "@miniben90/x-win-win32-x64-msvc": "1.10.0",
-    "@miniben90/x-win-darwin-x64": "1.10.0",
-    "@miniben90/x-win-linux-x64-gnu": "1.10.0",
-    "@miniben90/x-win-darwin-arm64": "1.10.0",
-    "@miniben90/x-win-win32-arm64-msvc": "1.10.0",
-    "@miniben90/x-win-win32-ia32-msvc": "1.10.0",
-    "@miniben90/x-win-darwin-universal": "1.10.0"
+    "@miniben90/x-win-win32-x64-msvc": "1.10.2",
+    "@miniben90/x-win-darwin-x64": "1.10.2",
+    "@miniben90/x-win-linux-x64-gnu": "1.10.2",
+    "@miniben90/x-win-darwin-arm64": "1.10.2",
+    "@miniben90/x-win-win32-arm64-msvc": "1.10.2",
+    "@miniben90/x-win-win32-ia32-msvc": "1.10.2",
+    "@miniben90/x-win-darwin-universal": "1.10.2",
+    "@miniben90/x-win-linux-x64-musl": "1.10.2"
   }
 }