illuma-rpa 1.0.0

package/libnut-core/CHANGELOG.md

@@ -0,0 +1,122 @@
+# libnut change log
+
+All notable changes to this project will be documented in this file.
+
+# 2.7.1
+
+- Bugfix: Re-build broken Windows release
+
+# 2.7.0
+
+- Enhancement: Adding support for numpad 'Enter' key [PR #168)](https://github.com/nut-tree/libnut-core/pull/168) Contributed by [@smithkyle](https://github.com/smithkyle)
+- Enhancement: Adding support for 'Fn' modifier key [PR #169)](https://github.com/nut-tree/libnut-core/pull/169) Contributed by [@smithkyle](https://github.com/smithkyle)
+- Maintenance: Version upgrades, CI updates, etc.
+
+## 2.6.0
+
+- Feature: Move/focus/resize window [(#18)](https://github.com/nut-tree/libnut-core/issues/18) Contributed by [@ekrenzin](https://github.com/ekrenzin)
+- Enhancement: Adding support for numpad 'clear' key [PR #166)](https://github.com/nut-tree/libnut-core/pull/166) Contributed by [@smithkyle](https://github.com/smithkyle)
+- Maintenance: Version upgrades, CI updates, etc.
+
+## 2.5.2
+
+- Bugfix: Screen capture broken on macOS 13 [(nut-tree/nut.js#469)](https://github.com/nut-tree/nut.js/issues/469)
+- Enhancement: Enable newly introduced keys to be used as modifiers [(nut-tree/nut.js#490)](https://github.com/nut-tree/nut.js/issues/490)
+- Bugfix: screen.highlight closes Electron window [(nut-tree/nut.js#505)](https://github.com/nut-tree/nut.js/issues/505)
+
+## 2.5.1
+- Bugfix: Fix rounding to mouse move on Window to fix mouse drift [(#126)](https://github.com/nut-tree/libnut-core/issues/126)
+
+## 2.5.0
+- Bugfix: Update permissionCheck.js to cache permission check results and only ask for permissions on actual function call by wrapping it in a HOF [(nut-tree/nut.js#477)](https://github.com/nut-tree/nut.js/issues/477)
+- Bugfix: Add rounding to mouse move on Window to fix mouse drift [(#126)](https://github.com/nut-tree/libnut-core/issues/126)
+- Enhancement: Add additional keys [(nut-tree/nut.js#457)](https://github.com/nut-tree/nut.js/issues/457)
+
+## 2.4.1
+
+- Bugfix: Update permission handling on macOS [(nut-tree/nut.js#469)](https://github.com/nut-tree/nut.js/issues/469)
+
+## 2.4.0
+
+- Bugfix: Fix `ReferenceError: b is not defined` [(PR#148)](https://github.com/nut-tree/libnut/pull/148)
+- Enhancement: Improved permission handling on macOS [(#141)](https://github.com/nut-tree/libnut/issues/141)
+- Bugfix: Limit calls to SetThreadDPIAwarenessContext to Windows 10 clients [(#136)](https://github.com/nut-tree/libnut/issues/136)
+
+## 2.3.0
+
+- Bugfix: Segmentation Fault when retrieving window title [(nut-tree/nut-js#377)](https://github.com/nut-tree/nut.js/issues/377)
+- Enhancement: Automatically check and request required permissions on macOS [(nut-tree/nut-js#377)](https://github.com/nut-tree/nut.js/issues/377)
+
+## 2.2.0
+
+- Enhancement: Add Windows runtime files [(PR #130)](https://github.com/nut-tree/libnut/pull/130)
+- Bugfix: Fix capture region x,y offset when DPI scaling on Windows [(PR #131)](https://github.com/nut-tree/libnut/pull/131)
+- Bugfix: Fix wrong keycode for CapsLock [(PR #132)](https://github.com/nut-tree/libnut/pull/132)
+
+## 2.1.8
+
+- Bugfix: Modifier keys are not properly released on macOS [(nut-tree/nut-js#264)](https://github.com/nut-tree/nut.js/issues/264)
+- Bugfix: Fix mouse clicks with modifiers on macOS [(nut-tree/nut-js#273)](https://github.com/nut-tree/nut.js/issues/273)
+
+## 2.1.7
+
+- Enhancement: Disable microsleep between keypresses on Windows and Linux [(#101)](https://github.com/nut-tree/libnut/issues/101)
+- Enhancement: Add mappings for missing numpad keys [(#102)](https://github.com/nut-tree/libnut/pull/102)
+- Enhancement: Added missing key mappings [(#103)](https://github.com/nut-tree/libnut/pull/103)
+- Bugfix: Revert keyboardInput to use scancodes [(PR #107)](https://github.com/nut-tree/libnut/pull/107)
+- Bugfix: Updated doubleClick implementation to fire two up/down cycles [(nut-tree/nut-js#373)](https://github.com/nut-tree/nut.js/issues/373)
+- Enhancement: Determine Windows doubleclick interval [(#116)](https://github.com/nut-tree/libnut/issues/116)
+- Bugfix: Mouse click doesn't work on external monitor with negative x and y [(#71)](https://github.com/nut-tree/libnut/issues/71)
+- Bugfix: macOS doubleclick fires two doubleclick events [(#120)](https://github.com/nut-tree/libnut/issues/120)
+
+## 2.1.6
+
+- Enhancement: Numpad buttons don't work on Linux [(nut-tree/nut.js#360)](https://github.com/nut-tree/nut.js/issues/360)
+- Bugfix: Issue with keyboard.type in to Spotlight on MacOS [(nut-tree/nut.js#152)](https://github.com/nut-tree/nut.js/issues/152)
+
+## 2.1.5
+
+- Bugfix: Keypresses not properly caught on Windows [(#94)](https://github.com/nut-tree/libnut/issues/94)
+- Enhancement: Enable some kind of warning / info message in case system requirements are not met [(#91)](https://github.com/nut-tree/libnut/issues/91)
+
+## 2.1.4
+
+- Bugfix: Windows display scaling is applied in wrong direction [(#92)](https://github.com/nut-tree/libnut/issues/92)
+
+## 2.1.3
+
+- Enhancement: Fix undefined behaviour of BufferFinalizer [(#47)](https://github.com/nut-tree/libnut/issues/47)
+- Bugfix: Fix for screen highlight window minimized intead close [(PR #77)](https://github.com/nut-tree/libnut/pull/77)
+- Enhancement: SendInput for mouse movement on Windows [(#26)](https://github.com/nut-tree/libnut/issues/26)
+- Bugfix: Windows Scaling issues: screen functions broken [(nut-tree/nut.js#249)](https://github.com/nut-tree/nut.js/issues/249)
+- Enhancement: Support Apple Silicon [(nut-tree/nut.js#306)](https://github.com/nut-tree/nut.js/issues/306)
+- Bugfix: Remove scan code KEYUP block [(PR #87)](https://github.com/nut-tree/libnut/pull/87)
+ 
+## 2.1.2
+
+- Maintenance: Upgrade CI [(#56)](https://github.com/nut-tree/libnut/issues/56)
+- Enhancement: Fix compiler warnings [(#58)](https://github.com/nut-tree/libnut/issues/58)
+- Enhancement: Windows: Support for HDPI displays [(#59)](https://github.com/nut-tree/libnut/issues/59)
+- Enhancement: macOS: Support for M1 chips [(PR #50)](https://github.com/nut-tree/libnut/pull/50)
+- Enhancement: Remove static keyboard delay [(PR #64)](https://github.com/nut-tree/libnut/pull/64)
+ 
+## 2.1.1
+
+- Enhancement: Snapshot releases [(#4)](https://github.com/nut-tree/libnut/issues/4)
+- Enhancement: Update CI configs [(#7)](https://github.com/nut-tree/libnut/issues/7)
+- Enhancement: Split OS specific implementation into separate files [(#20)](https://github.com/nut-tree/libnut/issues/20)
+- Enhancement: Linux: Update XGetMainDisplay to avoid receiving `Invalid MIT-MAGIC-COOKIE-1 key` [(#27)](https://github.com/nut-tree/libnut/issues/27)
+- Enhancement: Enable GitHub Actions [(#40)](https://github.com/nut-tree/libnut/issues/40)
+- Enhancement: Trigger snapshot build for https://github.com/nut-tree/libnut-install after snapshot release [(#42)](https://github.com/nut-tree/libnut/issues/42)
+- Bugfix: Region captures can't capture the whole screen [(#45)](https://github.com/nut-tree/libnut/issues/45)
+
+## 2.1.0
+
+- Enhancement: Retrieve coordinates of current active window [(#15)](https://github.com/nut-tree/libnut/issues/15)
+- Enhancement: Retrieve dimensions for a window specified via its window handle [(#17)](https://github.com/nut-tree/libnut/issues/17)
+- Enhancement: Separate folders for OS specific implementation [(#19)](https://github.com/nut-tree/libnut/issues/19)
+- Enhancement: Retrieve window name for a given window handle [(#22)](https://github.com/nut-tree/libnut/issues/22)
+
+## 2.0.1
+
+- Bugfix: Fix hanging shift key after keyboard input on Windows [(#12)](https://github.com/nut-tree/libnut/issues/12)

package/libnut-core/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/libnut-core/README.md

@@ -0,0 +1,26 @@
+## Building
+
+Please ensure you have the required dependencies before installing:
+
+* Windows
+  * windows-build-tools npm package (`npm install --global --production windows-build-tools` from an elevated PowerShell or CMD.exe)
+* Mac
+  * Xcode Command Line Tools.
+* Linux
+  * cmake
+  * A C/C++ compiler like GCC.
+  * libxtst-dev and libpng++-dev (`sudo apt-get install libxtst-dev libpng++-dev`).
+
+### Release build
+
+```
+npm install
+npm run build:release
+```
+
+### Debug build
+
+```
+npm install
+npm run build:debug
+```

package/libnut-core/index.d.ts

@@ -0,0 +1,82 @@
+export interface Bitmap {
+  width: number;
+  height: number;
+  image: any;
+  byteWidth: number;
+  bitsPerPixel: number;
+  bytesPerPixel: number;
+}
+
+export interface Screen {
+  capture(x?: number, y?: number, width?: number, height?: number): Bitmap;
+  highlight(x: number, y: number, width: number, height: number, duration: number, opacity: number): void;
+}
+
+export interface Point {
+  x: number;
+  y: number
+}
+
+export interface Size {
+  width: number;
+  height: number;
+}
+
+export interface Rect {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export function setKeyboardDelay(ms: number): void;
+export function keyTap(key: string, modifier?: string | string[]): void;
+export function keyToggle(
+  key: string,
+  down: string,
+  modifier?: string | string[]
+): void;
+export function typeString(string: string): void;
+export function typeStringDelayed(string: string, cpm: number): void;
+export function setMouseDelay(delay: number): void;
+export function moveMouse(x: number, y: number): void;
+export function moveMouseSmooth(x: number, y: number): void;
+export function mouseClick(button?: string, double?: boolean): void;
+export function mouseToggle(down?: string, button?: string): void;
+export function dragMouse(x: number, y: number): void;
+export function scrollMouse(x: number, y: number): void;
+export function getMousePos(): Point;
+export function getScreenSize(): Size;
+export function getWindows(): number[];
+export function getActiveWindow(): number;
+export function getWindowRect(handle: number): Rect;
+export function getWindowTitle(handle: number): string;
+
+/**
+ * Sets the focus to a specific window using its handle.
+ *
+ * @param {number} handle - The handle ID of the window to be focused.
+ * @returns {void}
+ */
+export function focusWindow(handle: number): void
+
+/**
+* Resizes a window by its handle to the given width and height.
+* The window is moved to the x & y coordinates if specified.
+*
+* @param {number} handle - The handle ID of the window to be resized.
+* @param {Size} newSize - The new size of the window.
+* @returns {void}
+*/
+export function resizeWindow(handle: number, newSize: Size): void
+
+/**
+ * Moves a window by its handle to the given x and y coordinates.
+ *
+ * @param {number} handle - The handle ID of the window to be resized.
+ * @param {Point} newOrigin - The new size of the window.
+ * @returns {void}
+ */
+export function moveWindow(handle: number, newOrigin: Point): void
+
+export const screen: Screen;

package/libnut-core/index.js

@@ -0,0 +1,51 @@
+let libnut;
+if (process.platform === 'darwin') {
+    libnut = require("./permissionCheck");
+} else {
+    libnut = require("bindings")("libnut");
+}
+
+module.exports = libnut;
+
+module.exports.screen = {};
+
+function bitmap(width, height, byteWidth, bitsPerPixel, bytesPerPixel, image) {
+    this.width = width;
+    this.height = height;
+    this.byteWidth = byteWidth;
+    this.bitsPerPixel = bitsPerPixel;
+    this.bytesPerPixel = bytesPerPixel;
+    this.image = image;
+}
+
+module.exports.screen.highlight = function (x, y, width, height, duration, opacity) {
+    let highlightOpacity = (opacity < 0) ? 0 : opacity;
+    highlightOpacity = (highlightOpacity > 1) ? 1 : highlightOpacity;
+    const highlightDuration = (duration < 0) ? 0 : duration;
+
+    libnut.highlight(x, y, width, height, highlightDuration, highlightOpacity);
+}
+
+module.exports.screen.capture = function (x, y, width, height) {
+    let b;
+    //If coords have been passed, use them.
+    if (
+        typeof x !== "undefined" &&
+        typeof y !== "undefined" &&
+        typeof width !== "undefined" &&
+        typeof height !== "undefined"
+    ) {
+        b = libnut.captureScreen(x, y, width, height);
+    } else {
+        b = libnut.captureScreen();
+    }
+
+    return new bitmap(
+        b.width,
+        b.height,
+        b.byteWidth,
+        b.bitsPerPixel,
+        b.bytesPerPixel,
+        b.image
+    );
+};