feat: include IRectangle and move all interfaces into folder interfaces (#63)

SvetoslavTsenov · web-flow · commit f7c5b806d313 · 2017-11-21T18:14:19.000+02:00
* feat: include IRectanlge and move interfaces into folder intefaces

* fix: exclude colors dep.
diff --git a/index.d.ts b/index.d.ts
@@ -6,6 +6,7 @@ export { SearchOptions } from "./lib/search-options";
 export { Locator } from "./lib/locators";
 export { Direction } from "./lib/direction";
 export { DeviceManger } from "./lib/device-controller";
+export { IRectangle } from "./lib/interfaces/rectangle";
 export declare function startServer(port?: number): Promise<void>;
 export declare function stopServer(): Promise<void>;
 export declare function createDriver(): Promise<any>;
diff --git a/index.ts b/index.ts
@@ -13,6 +13,7 @@ export { SearchOptions } from "./lib/search-options";
 export { Locator } from "./lib/locators";
 export { Direction } from "./lib/direction";
 export { DeviceManger } from "./lib/device-controller";
+export { IRectangle } from "./lib/interfaces/rectangle";
 
 const nsCapabilities = new NsCapabilities();
 const appiumServer = new AppiumServer(nsCapabilities);
diff --git a/lib/appium-driver.d.ts b/lib/appium-driver.d.ts
@@ -4,7 +4,7 @@ import { SearchOptions } from "./search-options";
 import { UIElement } from "./ui-element";
 import { Direction } from "./direction";
 import { Locator } from "./locators";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { Point } from "./point";
 import { ImageHelper } from "./image-helper";
 export declare class AppiumDriver {
diff --git a/lib/appium-driver.ts b/lib/appium-driver.ts
@@ -1,4 +1,3 @@
-require('colors');
 var chai = require("chai");
 import * as wd from "wd";
 var chaiAsPromised = require("chai-as-promised");
@@ -21,7 +20,7 @@ import {
     calculateOffset,
     scroll
 } from "./utils";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { Point } from "./point";
 import { ImageHelper } from "./image-helper";
 import { ImageOptions } from "./image-options"
diff --git a/lib/appium-server.d.ts b/lib/appium-server.d.ts
@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import * as child_process from "child_process";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 export declare class AppiumServer {
     private _args;
     private _server;
diff --git a/lib/appium-server.ts b/lib/appium-server.ts
@@ -1,6 +1,6 @@
 import * as child_process from "child_process";
 import { log, resolve, waitForOutput, shutdown, fileExists, isWin, executeCommand } from "./utils";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { DeviceManger } from "./device-controller";
 
 export class AppiumServer {
diff --git a/lib/device-controller.d.ts b/lib/device-controller.d.ts
@@ -1,4 +1,4 @@
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { IDevice } from "mobile-devices-controller";
 export declare class DeviceManger {
     private static _emulators;
diff --git a/lib/device-controller.ts b/lib/device-controller.ts
@@ -1,6 +1,6 @@
 import { waitForOutput, resolve, log, isWin, shutdown, executeCommand } from "./utils";
 import * as child_process from "child_process";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 
 import {
     IDevice,
diff --git a/lib/element-helper.d.ts b/lib/element-helper.d.ts
@@ -1,4 +1,4 @@
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 export declare class ElementHelper {
     private _args;
     private locators;
diff --git a/lib/element-helper.ts b/lib/element-helper.ts
@@ -1,6 +1,6 @@
 import { contains } from "./utils";
 import { log } from "./utils";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { Locator } from "./locators";
 
 export class ElementHelper {
diff --git a/lib/image-helper.d.ts b/lib/image-helper.d.ts
@@ -1,22 +1,14 @@
 import { ImageOptions } from "./image-options";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
+import { IRectangle } from "./interfaces/rectangle";
 export declare class ImageHelper {
     private _args;
-    private _cropImageRec;
+    private _cropImageRect;
     private _blockOutAreas;
     constructor(_args: INsCapabilities);
-    cropImageRec: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-    blockOutAreas: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    }[];
+    readonly cropImageRect: IRectangle;
+    cropImageRec: IRectangle;
+    blockOutAreas: IRectangle[];
     imageOutputLimit(): ImageOptions;
     thresholdType(): ImageOptions;
     threshold(): number;
diff --git a/lib/image-helper.ts b/lib/image-helper.ts
@@ -1,28 +1,29 @@
 import * as blinkDiff from "blink-diff";
 import { ImageOptions } from "./image-options";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
+import { IRectangle } from "./interfaces/rectangle";
 
 export class ImageHelper {
 
-    private _cropImageRec: { x: number, y: number, width: number, height: number };
-    private _blockOutAreas: { x: number, y: number, width: number, height: number }[];
+    private _cropImageRect: IRectangle;
+    private _blockOutAreas: IRectangle[];
 
     constructor(private _args: INsCapabilities) {
     }
 
-    get cropImageRec() {
-        return this._cropImageRec;
+    get cropImageRect() {
+        return this._cropImageRect;
     }
 
-    set cropImageRec(rect: { x: number, y: number, width: number, height: number }) {
-        this._cropImageRec = rect;
+    set cropImageRec(rect: IRectangle) {
+        this._cropImageRect = rect;
     }
 
     get blockOutAreas() {
         return this._blockOutAreas;
     }
 
-    set blockOutAreas(rectangles: { x: number, y: number, width: number, height: number }[]) {
+    set blockOutAreas(rectangles: IRectangle[]) {
         this._blockOutAreas = rectangles;
     }
 
@@ -76,7 +77,7 @@ export class ImageHelper {
     }
 
     public compareImages(actual: string, expected: string, output: string, valueThreshold: number = this.threshold(), typeThreshold: any = ImageOptions.pixel) {
-        const rectToCrop = this._cropImageRec || ImageHelper.cropImageDefaultParams(this._args);
+        const rectToCrop = this._cropImageRect || ImageHelper.cropImageDefaultParams(this._args);
         let diff = new blinkDiff({
 
             imageAPath: actual,
diff --git a/lib/interfaces/ins-capabilities.d.ts b/lib/interfaces/ins-capabilities.d.ts
@@ -0,0 +1,21 @@
+import { IDevice } from "mobile-devices-controller";
+export interface INsCapabilities {
+    projectDir: string;
+    projectBinary: string;
+    pluginRoot: string;
+    pluginBinary: string;
+    port: number;
+    verbose: boolean;
+    appiumCapsLocation: string;
+    appiumCaps: any;
+    testFolder: string;
+    runType: string;
+    isSauceLab: boolean;
+    appPath: string;
+    emulatorOptions: string;
+    storage: string;
+    testReports: string;
+    reuseDevice: boolean;
+    device: IDevice;
+    ignoreDeviceController: boolean;
+}
diff --git a/lib/interfaces/ns-capabilities.d.ts b/lib/interfaces/ns-capabilities.d.ts
diff --git a/lib/interfaces/ns-capabilities.ts b/lib/interfaces/ns-capabilities.ts
diff --git a/lib/interfaces/rectangle.d.ts b/lib/interfaces/rectangle.d.ts
@@ -0,0 +1,6 @@
+export interface IRectangle {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
diff --git a/lib/interfaces/rectangle.ts b/lib/interfaces/rectangle.ts
@@ -0,0 +1,6 @@
+export interface IRectangle {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
diff --git a/lib/locators.d.ts b/lib/locators.d.ts
@@ -1,4 +1,4 @@
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 export declare class Locator {
     private _args;
     private _elementsList;
diff --git a/lib/locators.ts b/lib/locators.ts
@@ -1,4 +1,4 @@
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 
 export class Locator {
 
diff --git a/lib/ns-capabilities.d.ts b/lib/ns-capabilities.d.ts
@@ -1,4 +1,4 @@
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { IDevice } from "mobile-devices-controller";
 export declare class NsCapabilities implements INsCapabilities {
     private _projectDir;
diff --git a/lib/ns-capabilities.ts b/lib/ns-capabilities.ts
@@ -1,5 +1,5 @@
 import * as parser from "./parser"
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { resolveCapabilities } from "./capabilities-helper";
 import { getAppPath, fileExists, logErr } from "./utils";
 import { IDevice } from "mobile-devices-controller";
diff --git a/lib/utils.d.ts b/lib/utils.d.ts
@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import * as childProcess from "child_process";
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { Point } from "./point";
 import { Direction } from "./direction";
 export declare function resolve(mainPath: any, ...args: any[]): any;
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -3,8 +3,7 @@ import * as fs from "fs";
 import * as childProcess from "child_process";
 import * as glob from "glob";
 
-require('colors');
-import { INsCapabilities } from "./ins-capabilities";
+import { INsCapabilities } from "./interfaces/ns-capabilities";
 import { Point } from "./point";
 import { Direction } from "./direction";
 
diff --git a/package.json b/package.json
@@ -36,7 +36,6 @@
     "yargs": "^8.0.2",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
-    "colors": "^1.1.2",
     "glob": "*",
     "portastic": "^1.0.1",
     "@types/node": "^7.0.5",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { INsCapabilities } from "./ins-capabilities";`
	`1`	`+import { INsCapabilities } from "./interfaces/ns-capabilities";`
`2`	`2`	`import { IDevice } from "mobile-devices-controller";`
`3`	`3`	`export declare class DeviceManger {`
`4`	`4`	`private static _emulators;`