Merge branch 'develop'

Author: s1hofmann

.github/workflows/ci.yaml

@@ -4,11 +4,14 @@ on:
     branches-ignore:
       - develop
       - release/**
+    paths-ignore:
+      - '**/*.md'
   pull_request:
 
 jobs:
   sonar:
     runs-on: ubuntu-latest
+    if: '!contains(github.event.head_commit.message, ''skip ci'')'
     steps:
       - name: Set up Git repository
         uses: actions/checkout@v2

.github/workflows/orga.yaml

@@ -0,0 +1,22 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v5
+        with:
+          days-before-issue-stale: 30
+          days-before-issue-close: 14
+          stale-issue-label: "stale"
+          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
+          close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/snapshot_release.yaml

@@ -3,6 +3,8 @@ on:
   push:
     branches:
       - develop
+    paths-ignore:
+      - '**/*.md'
   repository_dispatch:
     types:
       - snapshot-release

CHANGELOG.md

@@ -2,8 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.1.0
+- Bugfix: Keyboard methods `pressKey` and `releaseKey` ignore updated autoDelayMs [(#188)](https://github.com/nut-tree/nut.js/issues/188)
+- Enhancement: Add mappings for missing numpad keys [(#367)](https://github.com/nut-tree/nut.js/issues/367)
+- Enhancement: macOS double click [(#373)](https://github.com/nut-tree/nut.js/issues/373)
+- Maintenance: Both `mouse.leftClick` and `mouse.rightClick` should reuse `click` [(#390)](https://github.com/nut-tree/nut.js/issues/390)
+- Feature: New image loader to fetch remote images [(#400)](https://github.com/nut-tree/nut.js/issues/400)
+- Bugfix: Mouse methods `pressButton` and `releaseButton` should respect auto delay [(#403)](https://github.com/nut-tree/nut.js/issues/403)
+
 ## 2.0.1
-- Bugfix: Issue with keyboard.type in to Spotlight on MacOS [(#152)](https://github.com/nut-tree/nut.js/issues/152)
+- Bugfix: Issue with `keyboard.type` in to Spotlight on MacOS [(#152)](https://github.com/nut-tree/nut.js/issues/152)
 - Enhancement: Numpad buttons don't work on Linux [(#360)](https://github.com/nut-tree/nut.js/issues/360)
 
 ## 2.0.0

README.md

@@ -9,6 +9,9 @@
 [![SonarCloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=coverage)](https://sonarcloud.io/component_measures?id=nut-tree%3Anut.js&metric=coverage)
 
 [![Downloads per month](https://img.shields.io/npm/dm/@nut-tree/nut-js)](https://www.npmjs.com/package/@nut-tree/nut-js)
+[![@nut-tree/nut-js](https://snyk.io/advisor/npm-package/@nut-tree/nut-js/badge.svg)](https://snyk.io/advisor/npm-package/@nut-tree/nut-js)
+
+<a href="https://console.dev" title="Visit Console - the best tools for developers"><img src="https://console.dev/img/badges/1.0/svg/console-badge-logo-dark.svg" alt="Console - Developer Tool of the Week" /></a>
 
 <p align="center">
 Please visit
@@ -54,7 +57,7 @@ Check out this demo video to get a first impression of what nut.js is capable of
 
 # Tutorials
 
-Please consult the project website at [nutjs.dev](https://nutjs.dev/docs/tutorial-first_steps/prerequisits) for in-depth tutorials
+Please consult the project website at [nutjs.dev](https://nutjs.dev/docs/tutorial-first_steps/prerequisites) for in-depth tutorials
 
 # Examples
 
@@ -66,7 +69,7 @@ nut.js provides [public API documentation](https://nut-tree.github.io/apidoc/) a
 
 # Community
 
-Feel free to join our [Discord community](https://discord.gg/sJkN7789XR)
+Feel free to join our [Discord community](https://discord.gg/U5csuM4Esp)
 
 # Modules
 

index.ts

@@ -52,6 +52,7 @@ const loadImage = providerRegistry.getImageReader().load;
 const saveImage = providerRegistry.getImageWriter().store;
 
 const imageResource = (fileName: string) => loadImageResource(providerRegistry, screen.config.resourceDirectory, fileName);
+export {fetchFromUrl} from "./lib/imageResources.function";
 
 export {
     clipboard,

lib/imageResources.function.spec.ts

@@ -1,8 +1,9 @@
-import {loadImageResource} from "./imageResources.function";
+import {fetchFromUrl, loadImageResource} from "./imageResources.function";
 import {mockPartial} from "sneer";
 import {ProviderRegistry} from "./provider/provider-registry.class";
 import {ImageReader} from "./provider";
 import {join} from "path";
+import {ColorMode} from "./colormode.enum";
 
 const loadMock = jest.fn();
 const providerRegistryMock = mockPartial<ProviderRegistry>({
@@ -25,4 +26,46 @@ describe('imageResources', () => {
         // THEN
         expect(loadMock).toBeCalledWith(join(resourceDirectoryPath, imageFileName));
     });
+});
+
+describe('fetchFromUrl', () => {
+    it('should throw on malformed URLs', async () => {
+        // GIVEN
+        const malformedUrl = "foo";
+
+        // WHEN
+        const SUT = () => fetchFromUrl(malformedUrl);
+
+        // THEN
+        await expect(SUT).rejects.toThrowError("Invalid URL");
+    });
+
+    it('should throw on non-image URLs', async () => {
+        // GIVEN
+        const nonImageUrl = 'https://www.npmjs.com/package/jimp';
+
+        // WHEN
+        const SUT = () => fetchFromUrl(nonImageUrl);
+
+        // THEN
+        await expect(SUT).rejects.toThrowError('Could not find MIME for Buffer');
+    });
+
+    it('should return an RGB image from a valid URL', async () => {
+        // GIVEN
+        const validImageUrl = 'https://github.com/nut-tree/nut.js/raw/master/.gfx/nut.png';
+        const expectedDimensions = {
+            width: 502,
+            height: 411
+        };
+        const expectedColorMode = ColorMode.RGB;
+
+        // WHEN
+        const rgbImage = await fetchFromUrl(validImageUrl);
+
+        // THEN
+        expect(rgbImage.colorMode).toBe(expectedColorMode);
+        expect(rgbImage.width).toBe(expectedDimensions.width);
+        expect(rgbImage.height).toBe(expectedDimensions.height);
+    });
 });

lib/imageResources.function.ts

@@ -1,7 +1,43 @@
 import {join, normalize} from "path";
 import {ProviderRegistry} from "./provider/provider-registry.class";
+import {URL} from "url";
+import {Image} from "./image.class";
+import Jimp from "jimp";
+import {ColorMode} from "./colormode.enum";
 
 export function loadImageResource(providerRegistry: ProviderRegistry, resourceDirectory: string, fileName: string) {
     const fullPath = normalize(join(resourceDirectory, fileName));
     return providerRegistry.getImageReader().load(fullPath);
+}
+
+/**
+ * fetchFromUrl loads remote image content at runtime to provide it for further use in on-screen image search
+ * @param url The remote URl to fetch an image from as string or {@link URL}
+ * @throws On malformed URL input or in case of non-image remote content
+ */
+export async function fetchFromUrl(url: string | URL): Promise<Image> {
+    let imageUrl: URL;
+    if (url instanceof URL) {
+        imageUrl = url;
+    } else {
+        try {
+            imageUrl = new URL(url);
+        } catch (e) {
+            throw e;
+        }
+    }
+    return Jimp.read(imageUrl.href)
+        .then((image) => {
+            return new Image(
+                image.bitmap.width,
+                image.bitmap.height,
+                image.bitmap.data,
+                4,
+                imageUrl.href,
+                ColorMode.RGB
+            );
+        })
+        .catch(err => {
+            throw err;
+        });
 }

lib/keyboard.class.spec.ts

@@ -149,4 +149,48 @@ describe("Keyboard", () => {
         // THEN
         expect(keyMock).toHaveBeenCalledTimes(payload.length);
     });
+
+    describe("autoDelayMs", () => {
+        it("pressKey should respect configured delay", async () => {
+            // GIVEN
+            const SUT = new KeyboardClass(providerRegistryMock);
+            const delay = 100;
+            SUT.config.autoDelayMs = delay;
+
+            const keyMock = jest.fn();
+            providerRegistryMock.getKeyboard = jest.fn(() => mockPartial<KeyboardProviderInterface>({
+                setKeyboardDelay: jest.fn(),
+                pressKey: keyMock
+            }));
+
+            // WHEN
+            const start = Date.now();
+            await SUT.pressKey(Key.A);
+            const duration = Date.now() - start;
+
+            // THEN
+            expect(duration).toBeGreaterThanOrEqual(delay);
+        });
+
+        it("should pass a list of input keys down to the releaseKey call.", async () => {
+            // GIVEN
+            const SUT = new KeyboardClass(providerRegistryMock);
+            const delay = 100;
+            SUT.config.autoDelayMs = delay;
+
+            const keyMock = jest.fn();
+            providerRegistryMock.getKeyboard = jest.fn(() => mockPartial<KeyboardProviderInterface>({
+                setKeyboardDelay: jest.fn(),
+                releaseKey: keyMock
+            }));
+
+            // WHEN
+            const start = Date.now();
+            await SUT.releaseKey(Key.A);
+            const duration = Date.now() - start;
+
+            // THEN
+            expect(duration).toBeGreaterThanOrEqual(delay);
+        });
+    });
 });

lib/keyboard.class.ts

@@ -73,6 +73,7 @@ export class KeyboardClass {
     public pressKey(...keys: Key[]): Promise<KeyboardClass> {
         return new Promise<KeyboardClass>(async (resolve, reject) => {
             try {
+                await sleep(this.config.autoDelayMs);
                 await this.providerRegistry.getKeyboard().pressKey(...keys);
                 resolve(this);
             } catch (e) {
@@ -95,6 +96,7 @@ export class KeyboardClass {
     public releaseKey(...keys: Key[]): Promise<KeyboardClass> {
         return new Promise<KeyboardClass>(async (resolve, reject) => {
             try {
+                await sleep(this.config.autoDelayMs);
                 await this.providerRegistry.getKeyboard().releaseKey(...keys);
                 resolve(this);
             } catch (e) {