@miniben90/x-win 1.9.2 → 1.10.1

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,6 +1,6 @@
 # @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)
@@ -150,6 +150,31 @@ setTimeout(() => unsubscribeActiveWindow(c), 5000);
 setTimeout(() => unsubscribeAllActiveWindow(), 10000);
 ```
 
+### Get icon from `WindoInfo`
+
+It is possible to get an icon from the `WindowInfo` class object using `getIcon` or `getIconAsync`, which will return an `IconInfo` struct.
+The icon will be stored in `IconInfo.data` in base64 PNG format.
+
+Example:
+
+```typescript
+import { activeWindow, type WindowInfo, type IconInfo } from '@miniben90/x-win';
+
+const window: WindowInfo = activeWindow();
+const iconInfo: IconInfo = window.getIcon();
+console.log(console);
+```
+
+Response:
+
+```javascript
+{
+  height: 32,
+  width: 32,
+  data: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAD/0lEQVR4Ae3gAZAkSZIkSRKLqpm7R0REZmZmVlVVVVV3d3d3d/fMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMdHd3d3dXV1VVVVVmZkZGRIS7m5kKz0xmV3d1d3dPz8zMzMxMovjvhfjvhfjvhfjvhXimW7+LvwJemhfNLvA6D34f/pp/H8Qz3fpdmH+dXeB1Hvw+/DX/dohneuq3Yf4Vth/0+px59JtC2+NfrTvz17rpw14GQDzT474W8yLoNq9l56aX55pHvQas7+DfJBboEV8mAPFMfupnmBdV2wOP/HvoUd8oAPFMfsIHm/9CevQ3C0A8kx//gea/kB7zrQIQz+THv7/5L6THfLsAxDP5ce9r/gvpsd8pAPFMftx7m/9Ceux3C0A8k//hPc1zsXkW869gkHgWieehF/teAYhn8t+/u3km29iQNjakDeZfRQJJSCCJEEjifnrx7xeAeCb//bsaINO0NK2ZcUpaMy2NDca8KISQoBRRQtQa1CJKiJBAoBf/QQGIZ/LfvbNtyEyGyQxj8nOrD+Kn73gU/x5vfdMTeYvZN9P3ha6KEkISeokfFoB4Jv/dO9pppjTrITlaTrz/rV/L+aPGv8epjcK3P+Qj2ZhXZl1QiggJveSPCkA8k//27W2bqZnlunFwNPEOT/xa/iP8xKM/io1FYd4XahUhoZf8cQGIZ/LfvK1tMzWzXDcOjibe4Ulfz3+En3jUR7AxL8xnhVpFSOilflIA4pn8N29t20zNLFeNg6OJd3jyN/If4Sce9WFszAvzWaEWESH0Uj8tAPFM/uu3tG2mZparxsGy8Q5P/kae2/c96IMoISJEiMvSkGkyzbs/41t4bj/xyA9lY16Yzwq1ipDQS/+sAMQz+a/ezDZMzSzXjYOjxts/8et5bj/2yA9jPiv0XVALl00NhjFZD8nbP/HreW4/+ZgPZ2NWmM+CWoMQ6GV+QQDimfyXb2AnTM0s142Do8bbPeEbeG4/8ZgPY2NWmM+CWgXANJn1kCzXyds87ut5bj/12A9nYx7M+6DWIAR6uV8TgHgm/+mr2IapJct1cnCUvM3jv53n9tOPfX825sG8D7oqAMbJrMfkaJW81T98O8/tZx77/mwsgnkf1CIihF7xjwQgnsl/9BJ/5eSlpzSrdXKwTN7qcd/Lc/u5F3tPFvNg3otaBMDUzHowy7V587//Hp7bz734e7IxC2a9qEWE9Nd61b97GQDxQrz8F/6BeS5//qmvJl6Il//CPzDP5c8/9dXE84f474X474X474X478U/AiZPaTD3cWUhAAAAAElFTkSuQmCC"
+}
+```
+
 ## Linux
 
 Dependencies are required to be installed for development purposes.
@@ -158,11 +183,11 @@ 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**<br />
+> libc.so.6 is needed<br />
+> ⚠️**Warning**<br />
 > Recovery url is not available on linux
 
-
 ### 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).

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,18 +36,6 @@ export interface WindowPosition {
   height: number
   isFullScreen: boolean
 }
-/**
- * Struct to store all informations of the window
-*/
-export interface WindowInfo {
-  id: number
-  os: string
-  title: string
-  position: WindowPosition
-  info: ProcessInfo
-  usage: UsageInfo
-  url: string
-}
 /**
  * Retrieve information the about currently active window.
  * Returns an object of `WindowInfo`.
@@ -68,7 +64,7 @@ export interface WindowInfo {
  *
  * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
 */
-export function activeWindow(): WindowInfo
+export declare function activeWindow(): WindowInfo
 /**
  * Retrieve information about the currently active window as a promise.
  * Returns an object of `WindowInfo`.
@@ -99,7 +95,7 @@ export function activeWindow(): WindowInfo
  *
  * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
 */
-export function activeWindowAsync(): Promise<WindowInfo>
+export declare function activeWindowAsync(): Promise<WindowInfo>
 /**
  * Retrieve information about the currently open windows.
  * Returns an array of `WindowInfo`, each containing details about a specific open window.
@@ -132,7 +128,7 @@ export function activeWindowAsync(): Promise<WindowInfo>
  *
  * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
 */
-export function openWindows(): Array<WindowInfo>
+export declare function openWindows(): Array<WindowInfo>
 /**
  * Retrieve information about the currently open windows as a promise.
  * Returns an array of `WindowInfo`, each containing details about a specific open window.
@@ -169,7 +165,7 @@ export function openWindows(): Array<WindowInfo>
  *
  * It is recommended to use this function within a worker to mitigate potential recovery issues on MacOS.
 */
-export function openWindowsAsync(): Promise<Array<WindowInfo>>
+export declare function openWindowsAsync(): Promise<Array<WindowInfo>>
 /**
  * Subscribe an observer thread to monitor changes in the active window.
  *
@@ -212,7 +208,7 @@ export function openWindowsAsync(): Promise<Array<WindowInfo>>
  * ```
  *
 */
-export function subscribeActiveWindow(callback: (info: WindowInfo) => void): number
+export declare function subscribeActiveWindow(callback: (info: WindowInfo) => void): number
 /**
  * Terminate and unsubscribe a specific observer using their ID.
  *
@@ -258,7 +254,7 @@ export function subscribeActiveWindow(callback: (info: WindowInfo) => void): num
  * unsubscribeActiveWindow(c);
  * ```
 */
-export function unsubscribeActiveWindow(threadId: number): void
+export declare function unsubscribeActiveWindow(threadId: number): void
 /**
  * Terminate and unsubscribe all observer threads monitoring changes in the active window.
  *
@@ -300,26 +296,47 @@ export function unsubscribeActiveWindow(threadId: number): void
  * unsubscribeAllActiveWindow();
  * ```
 */
-export function unsubscribeAllActiveWindow(): void
+export declare 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
+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.
 */
-export function uninstallExtension(): boolean
+export declare 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
+export declare 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
+export declare function disableExtension(): boolean
+/**
+ * Struct to store all informations of the window
+*/
+export class WindowInfo {
+  id: number
+  os: string
+  title: string
+  position: WindowPosition
+  info: ProcessInfo
+  usage: UsageInfo
+  url: string
+  constructor(id: number, os: string, title: string, position: WindowPosition, info: ProcessInfo, usage: UsageInfo, url: string)
+  /**
+  * Funciton who help to recover icon of application and will return `IconInfo`.
+  */
+  getIcon(): IconInfo
+  /**
+  * Promise funciton who help to recover icon of application and will return `IconInfo`.
+  */
+  getIconAsync(): Promise<IconInfo>
+}

package/index.js

@@ -310,8 +310,9 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { activeWindow, activeWindowAsync, openWindows, openWindowsAsync, subscribeActiveWindow, unsubscribeActiveWindow, unsubscribeAllActiveWindow, installExtension, uninstallExtension, enableExtension, disableExtension } = nativeBinding
+const { WindowInfo, activeWindow, activeWindowAsync, openWindows, openWindowsAsync, subscribeActiveWindow, unsubscribeActiveWindow, unsubscribeAllActiveWindow, installExtension, uninstallExtension, enableExtension, disableExtension } = nativeBinding
 
+module.exports.WindowInfo = WindowInfo
 module.exports.activeWindow = activeWindow
 module.exports.activeWindowAsync = activeWindowAsync
 module.exports.openWindows = openWindows

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.9.2",
+  "version": "1.10.1",
   "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,12 +42,16 @@
     "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",
-    "failFast": true
+    "failFast": true,
+    "files": [
+      "__test__/**/*.mjs"
+    ]
   },
   "engines": {
     "node": ">= 14"
@@ -58,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.9.2",
-    "@miniben90/x-win-darwin-x64": "1.9.2",
-    "@miniben90/x-win-linux-x64-gnu": "1.9.2",
-    "@miniben90/x-win-darwin-arm64": "1.9.2",
-    "@miniben90/x-win-win32-arm64-msvc": "1.9.2",
-    "@miniben90/x-win-win32-ia32-msvc": "1.9.2",
-    "@miniben90/x-win-darwin-universal": "1.9.2"
+    "@miniben90/x-win-win32-x64-msvc": "1.10.1",
+    "@miniben90/x-win-darwin-x64": "1.10.1",
+    "@miniben90/x-win-linux-x64-gnu": "1.10.1",
+    "@miniben90/x-win-darwin-arm64": "1.10.1",
+    "@miniben90/x-win-win32-arm64-msvc": "1.10.1",
+    "@miniben90/x-win-win32-ia32-msvc": "1.10.1",
+    "@miniben90/x-win-darwin-universal": "1.10.1",
+    "@miniben90/x-win-linux-x64-musl": "1.10.1"
   }
 }