@miniben90/x-win 0.3.0 → 0.4.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 BENKHADRA Hocine
+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
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -4,13 +4,10 @@
 
 # @miniben90/x-win
 
-> This project work with Rust and napi-rs to make easy to have active window or an array of open windows.
-> It work with Microsoft Windows (10, 11), Linux (With Xserver) and Macos(*).
+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](#darwin).
 
 ## How to install
 
-Easy to install:
-
 ```sh
 # With npm
 npm i @miniben90/x-win
@@ -21,9 +18,10 @@ yarn add @miniben90/x-win
 
 ## How to use
 
-### Get information of current active window
+### Get information about the currently active window
 
 `exemple.ts`:
+
 ```typescript
 import { activeWindow, type WindowInfo } from '@miniben90/x-win';
 
@@ -33,7 +31,8 @@ console.log(currentWindow);
 ```
 
 `response`:
-```json
+
+```javascript
 {
   id: 26148,
   info: {
@@ -56,9 +55,10 @@ console.log(currentWindow);
 }
 ```
 
-### Get List of open windows with informations
+### Get a list of open windows with information
 
 `exemple.ts`:
+
 ```typescript
 import { openWindows, type WindowInfo } from '@miniben90/x-win';
 
@@ -68,7 +68,8 @@ console.log(windows);
 ```
 
 `response`:
-```json
+
+```javascript
 [{
   id: 26148,
   info: {
@@ -91,15 +92,26 @@ console.log(windows);
 }]
 ```
 
+# 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
+```
+
+# Darwin
 
-## For Darwin
+## Screen recording permission introduced in macOS 10.15 Catalina
 
-> ### Record screen required for macos
-> Macos require to grant access for recording screen. If your project don't have it the title will have `<unknown>` as value.
+> macOS requires you to grant access for screen recording. If your project does not have it, the title will display `<unknown>` as its value.
 
 <hr class="padding-top: 30px;padding-bottom:30px">
 
-**This project was inspired by:**
+# Project References
+
+**Project Inspirations:**
+
 * [active-win](https://github.com/sindresorhus/active-win)
 * [active-win-pos-rs](https://github.com/dimusic/active-win-pos-rs)
 * This project was generated with [@napi-rs/cli](https://github.com/napi-rs)

package/index.js

@@ -1,3 +1,9 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
 const { existsSync, readFileSync } = require('fs')
 const { join } = require('path')
 
@@ -249,4 +255,4 @@ if (!nativeBinding) {
 const { activeWindow, openWindows } = nativeBinding
 
 module.exports.activeWindow = activeWindow
-module.exports.openWindows = openWindows
+module.exports.openWindows = openWindows

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@miniben90/x-win",
-  "version": "0.3.0",
+  "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": "0.4.1",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
@@ -13,9 +14,9 @@
     "name": "x-win",
     "triples": {
       "additional": [
+        "aarch64-apple-darwin",
         "aarch64-pc-windows-msvc",
         "i686-pc-windows-msvc",
-        "aarch64-apple-darwin",
         "universal-apple-darwin"
       ]
     }
@@ -27,15 +28,27 @@
   },
   "repository": "https://github.com/miniben-90/x-win.git",
   "license": "MIT",
+  "keywords": [
+    "active",
+    "window",
+    "windows",
+    "active-window",
+    "active",
+    "current",
+    "position",
+    "title",
+    "list",
+    "open"
+  ],
   "devDependencies": {
-    "@napi-rs/cli": "^2.14.5",
+    "@napi-rs/cli": "^2.15.2",
     "ava": "^5.1.1"
   },
   "ava": {
     "timeout": "3m"
   },
   "engines": {
-    "node": ">= 10"
+    "node": ">= 14"
   },
   "scripts": {
     "artifacts": "napi artifacts",
@@ -46,15 +59,14 @@
     "universal": "napi universal",
     "version": "napi version"
   },
-  "packageManager": "yarn@3.3.1",
-  "description": "Get position, size, title and a few other properties of the active or open window(s) on Windows, MacOS and Linux.",
+  "packageManager": "yarn@3.5.0",
   "optionalDependencies": {
-    "@miniben90/x-win-win32-x64-msvc": "0.3.0",
-    "@miniben90/x-win-darwin-x64": "0.3.0",
-    "@miniben90/x-win-linux-x64-gnu": "0.3.0",
-    "@miniben90/x-win-win32-arm64-msvc": "0.3.0",
-    "@miniben90/x-win-win32-ia32-msvc": "0.3.0",
-    "@miniben90/x-win-darwin-arm64": "0.3.0",
-    "@miniben90/x-win-darwin-universal": "0.3.0"
+    "@miniben90/x-win-win32-x64-msvc": "0.4.1",
+    "@miniben90/x-win-darwin-x64": "0.4.1",
+    "@miniben90/x-win-linux-x64-gnu": "0.4.1",
+    "@miniben90/x-win-darwin-arm64": "0.4.1",
+    "@miniben90/x-win-win32-arm64-msvc": "0.4.1",
+    "@miniben90/x-win-win32-ia32-msvc": "0.4.1",
+    "@miniben90/x-win-darwin-universal": "0.4.1"
   }
 }