Merge pull request #55 from nut-tree/develop

Release 1.0.0

Author: s1hofmann

README.md

@@ -1,10 +1,10 @@
 # nut.js (Native UI Toolkit) [![Build Status](https://travis-ci.com/nut-tree/nut.js.svg?branch=master)](https://travis-ci.com/nut-tree/nut.js) [![Greenkeeper badge](https://badges.greenkeeper.io/nut-tree/nut.js.svg)](https://greenkeeper.io/) [![SonarCloud badge](https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=alert_status)](https://sonarcloud.io/dashboard?id=nut-tree%3Anut.js) [![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)
 <p align="center">
-Native UI testing / controlling with node.js
+Native UI testing / automation with node.js
 </p>
 <br/>
 <p align="center">
-	<a target="_blank" href="http://getrobot.net">
+	<a target="_blank" href="https://robotjs.io/">
 		<img src="https://img.shields.io/badge/Built_with-ROBOT-C86414.svg?style=flat-square" alt="Built with Robot" />
 	</a>
 	<a target="_blank" href="https://github.com/justadudewhohacks/opencv4nodejs">
@@ -28,13 +28,13 @@ The following snippet shows a valid NUT example (on macOS)
 ```js
 "use strict";
 
-const { keyboard, Key, mouse, movement } = require("@nut-tree/nut-js");
+const { keyboard, Key, mouse, left, right, up, down } = require("@nut-tree/nut-js");
 
 const square = async () => {
-  await mouse.move(movement.right(500));
-  await mouse.move(movement.down(500));
-  await mouse.move(movement.left(500));
-  await mouse.move(movement.up(500));
+  await mouse.move(right(500));
+  await mouse.move(down(500));
+  await mouse.move(left(500));
+  await mouse.move(up(500));
 };
 
 const openSpotlight = async () => {
@@ -55,6 +55,43 @@ describe("Basic test", () => {
 
 ```
 
+# Installation
+
+Running 
+
+```bash
+npm i @nut-tree/nut-js
+```
+
+or
+
+```bash
+yarn add @nut-tree/nut-js
+```
+
+will install nut.js and its required dependencies.
+
+The installation process assumes you do not have an existing OpenCV installation and will try to build it from source via [opencv4nodejs](https://github.com/justadudewhohacks/opencv4nodejs).
+
+Building OpenCV from scratch requires a [cmake](https://cmake.org/) installation.
+
+In case you already have an OpenCV installation (version 3.x.x required, e.g. via `brew install opencv@3` or [else](https://docs.opencv.org/3.4/df/d65/tutorial_table_of_content_introduction.html)), you can disable the build process via environment variable:
+
+```bash
+export OPENCV4NODEJS_DISABLE_AUTOBUILD=1
+```
+
+or 
+
+```bash
+set OPENCV4NODEJS_DISABLE_AUTOBUILD=1
+```
+
+Please make sure to also install all required peer dependencies:
+ 
+- [opencv4nodejs](https://github.com/justadudewhohacks/opencv4nodejs#how-to-install)
+- [robotjs](http://robotjs.io/docs/building)
+
 # Examples
 
 [nut-tree/trailmix](https://github.com/nut-tree/trailmix) contains a set of ready to use examples which demo the usage ot nut.js.
@@ -88,8 +125,8 @@ It's work in progress and will undergo constant modification.
 ## Screen
 
 - [x] findOnScreen
-- [ ] waitFor
-- [ ] Hooks to trigger actions based on images
+- [x] waitFor
+- [x] Hooks to trigger actions based on images
 
 ## Integration
 

index.e2e.spec.ts

@@ -1,8 +1,7 @@
-import { assert, Key, keyboard, Location, mouse, movement, screen } from "./index";
+import { assert, centerOf, Key, keyboard, mouse, screen, straightTo } from "./index";
 
 const openXfceMenu = async () => {
-  const menu = await screen.find("menu.png");
-  await mouse.move(await movement.straightTo(Location.centerOf(menu)));
+  await mouse.move(straightTo(centerOf(screen.find("menu.png"))));
   await mouse.leftClick();
   await mouse.leftClick();
 };
@@ -14,22 +13,18 @@ const run = async (cmd: string) => {
 };
 
 const calculate = async () => {
-  const plus = await screen.find("plus.png");
-  await mouse.move(await movement.straightTo(Location.centerOf(plus)));
+  await mouse.move(straightTo(centerOf(screen.find("plus.png"))));
   await mouse.leftClick();
-  const one = await screen.find("one.png");
-  await mouse.move(await movement.straightTo(Location.centerOf(one)));
+  await mouse.move(straightTo(centerOf(screen.find("one.png"))));
   await mouse.leftClick();
-  const zero = await screen.find("zero.png");
-  await mouse.move(await movement.straightTo(Location.centerOf(zero)));
+  await mouse.move(straightTo(centerOf(screen.find("zero.png"))));
   await mouse.leftClick();
   await mouse.leftClick();
   await keyboard.type(Key.Enter);
 };
 
 const close = async () => {
-  const x = await screen.find("close.png");
-  await mouse.move(await movement.straightTo(Location.centerOf(x)));
+  await mouse.move(straightTo(centerOf(screen.find("close.png"))));
   await mouse.leftClick();
 };
 

index.ts

@@ -4,28 +4,40 @@ import { Assert } from "./lib/assert.class";
 import { Clipboard } from "./lib/clipboard.class";
 import { Keyboard } from "./lib/keyboard.class";
 import { Mouse } from "./lib/mouse.class";
-import { Movement } from "./lib/movement.class";
+import { createMovementApi } from "./lib/movement.function";
 import { Screen } from "./lib/screen.class";
 import { LineHelper } from "./lib/util/linehelper.class";
 
 export { jestMatchers } from "./lib/expect/jest.matcher.function";
 export { Image } from "./lib/image.class";
 export { Key } from "./lib/key.enum";
-export { Location } from "./lib/location.class";
+export { centerOf, randomPointIn } from "./lib/location.function";
 export { LocationParameters } from "./lib/locationparameters.class";
-export { Movement } from "./lib/movement.class";
-export { MovementType } from "./lib/movementtype.class";
+export { linear } from "./lib/movementtype.function";
 export { Point } from "./lib/point.class";
 export { Region } from "./lib/region.class";
 
 const screenActions = new VisionAdapter();
 const nativeActions = new NativeAdapter();
+const lineHelper = new LineHelper();
 
 const clipboard = new Clipboard(nativeActions);
 const keyboard = new Keyboard(nativeActions);
 const mouse = new Mouse(nativeActions);
-const movement = new Movement(nativeActions, new LineHelper());
 const screen = new Screen(screenActions);
 const assert = new Assert(screen);
 
-export { clipboard, keyboard, mouse, movement, screen, assert };
+const {straightTo, up, down, left, right} = createMovementApi(nativeActions, lineHelper);
+
+export {
+  clipboard,
+  keyboard,
+  mouse,
+  screen,
+  assert,
+  straightTo,
+  up,
+  down,
+  left,
+  right,
+};