askui 0.3.2 → 0.5.0

package/README.md

@@ -14,28 +14,22 @@ To use **askui** follow these steps:
 npm init
 ```
 
-### 1. Install askui
+### 1. Install askui with Needed Dependencies
 
 ```
-npm i -D askui
+npm i -D askui typescript ts-node @types/jest ts-jest jest
 ```
 
-### 2. Install a testing framework
+### 2. Create your First Test
 
 ```
-npm i -D jest
-```
-
-### 3. Install Typescript
-
-```
-npm i -D @types/jest ts-jest ts-node typescript
+npx askui init
 ```
 
-### 4. Create a first test suite
+### 3. Execute the Test
 
 ```
-npx askui init
+npx jest test/my-first-askui-test-suite.test.ts --config ./test/jest.config.ts 
 ```
 
 ## Documentation

package/dist/cjs/core/annotation/annotation-writer.js

@@ -10,10 +10,8 @@ const logger_1 = require("../../lib/logger");
 class AnnotationWriter {
     static write(html, outputFolder = 'report', fileNamePrefix = 'annotation') {
         const currentDateTime = new Date();
-        const formattedTime = `${currentDateTime.getDay()}-${currentDateTime.getMonth()}`
-            + `-${currentDateTime.getFullYear()}_${currentDateTime.getHours()}`
-            + `-${currentDateTime.getMinutes()}-${currentDateTime.getSeconds()}`;
-        const fileName = `${fileNamePrefix}_${formattedTime}.html`;
+        const currentTimeStringOnlyNumbers = currentDateTime.toISOString().replace(/\D/g, '');
+        const fileName = `${currentTimeStringOnlyNumbers}_${fileNamePrefix}.html`;
         const outputFilePath = path_1.default.join(outputFolder, fileName);
         if (!(fs_1.default.existsSync(outputFolder))) {
             fs_1.default.mkdirSync(outputFolder, { recursive: true });

package/dist/cjs/core/annotation/annotation.d.ts

@@ -1,11 +1,10 @@
 import { JSDOM } from 'jsdom';
 import { DetectedElement } from '../model/annotation-result/detected-element';
-import { AnnotationJson } from './annotation-json';
 export declare class Annotation {
     image: string;
-    objects: DetectedElement[];
-    constructor(image: string, objects?: DetectedElement[]);
+    detected_elements: DetectedElement[];
+    constructor(image: string, detected_elements?: DetectedElement[]);
     toHtml(): JSDOM;
-    static fromJson(json: AnnotationJson, resizeRatio?: number): Annotation;
+    static fromJson(json: unknown, resizeRatio?: number): Annotation;
     private static getHtmlTemplate;
 }

package/dist/cjs/core/annotation/annotation.js

@@ -9,9 +9,9 @@ const path_1 = __importDefault(require("path"));
 const jsdom_1 = require("jsdom");
 const detected_element_1 = require("../model/annotation-result/detected-element");
 class Annotation {
-    constructor(image, objects = []) {
+    constructor(image, detected_elements = []) {
         this.image = image;
-        this.objects = objects;
+        this.detected_elements = detected_elements;
     }
     toHtml() {
         const template = Annotation.getHtmlTemplate();
@@ -20,13 +20,14 @@ class Annotation {
       var el = document.getElementsByTagName("bounding-box-renderer");
       el[0].setAttribute("shouldrenderimage", true);
       el[0].setAttribute("imagestr", "${this.image.trim()}"); 
-      el[0].setAttribute("detectedobjects", JSON.stringify(${JSON.stringify(this.objects)}));
+      el[0].setAttribute("detectedobjects", JSON.stringify(${JSON.stringify(this.detected_elements)}));
     `;
         template.window.document.body.appendChild(script);
         return template;
     }
     static fromJson(json, resizeRatio = 1) {
-        return new Annotation(json.image, json.objects.map((object) => detected_element_1.DetectedElement.fromJson(object, resizeRatio)));
+        const annotation = json;
+        return new Annotation(annotation.image, annotation.detected_elements.map((data) => detected_element_1.DetectedElement.fromJson(data, resizeRatio)));
     }
     static getHtmlTemplate() {
         const templatePath = path_1.default.join(__dirname, 'template.html');

package/dist/cjs/core/inference-response/inference-response.d.ts

@@ -0,0 +1,15 @@
+import { ControlCommand } from '../ui-control-commands/control-command';
+import { Annotation } from '../annotation/annotation';
+export declare class InferenceResponse {
+    type: string;
+    data: ControlCommand | Annotation;
+    constructor(type: string, data: ControlCommand | Annotation);
+    static fromJson(json: unknown, resizeRatio?: number, image?: string): ControlCommand | Annotation;
+    static createModels(type: string, data: ControlCommand | Annotation, resizeRatio: number, image?: string): ControlCommand | Annotation;
+    static models: Models;
+}
+interface Models {
+    DETECTED_ELEMENTS: CallableFunction;
+    COMMANDS: CallableFunction;
+}
+export {};

package/dist/cjs/core/inference-response/inference-response.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InferenceResponse = void 0;
+const control_command_1 = require("../ui-control-commands/control-command");
+const annotation_1 = require("../annotation/annotation");
+class InferenceResponse {
+    constructor(type, data) {
+        this.type = type;
+        this.data = data;
+    }
+    static fromJson(json, resizeRatio = 1, image) {
+        const inferenceResponse = json;
+        return this.createModels(inferenceResponse.type, inferenceResponse.data, resizeRatio, image);
+    }
+    static createModels(type, data, resizeRatio, image) {
+        return this.models[type](data, resizeRatio, image);
+    }
+}
+exports.InferenceResponse = InferenceResponse;
+InferenceResponse.models = {
+    DETECTED_ELEMENTS: (data, resizeRatio, image) => annotation_1.Annotation
+        .fromJson({ image, detected_elements: data.detected_elements }, resizeRatio),
+    COMMANDS: (data, resizeRatio) => control_command_1.ControlCommand
+        .fromJson(data, resizeRatio),
+};

package/dist/cjs/core/model/annotation-result/boundary-box.d.ts

@@ -1,3 +1,14 @@
+/**
+*
+* @remarks
+* The screen top left corner is the origin
+*
+* @param {number} xmin - The bounding box xmin coordinate in pixels
+* @param {number} ymin - The bounding box ymin coordinate in pixels
+* @param {number} xmax - The bounding box xmax coordinate in pixels
+* @param {number} ymax - The bounding box ymax coordinate in pixels
+*
+*/
 export declare class BoundingBox {
     xmin: number;
     ymin: number;
@@ -5,4 +16,16 @@ export declare class BoundingBox {
     ymax: number;
     constructor(xmin: number, ymin: number, xmax: number, ymax: number);
     static fromJson(boundinBox: BoundingBox, resizeRatio?: number): BoundingBox;
+    /**
+    *
+    * @returns {number} The bounding box height in pixels
+    *
+    */
+    get_height(): number;
+    /**
+    *
+    * @returns {number} The bounding box width in pixels
+    *
+    */
+    get_width(): number;
 }

package/dist/cjs/core/model/annotation-result/boundary-box.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BoundingBox = void 0;
+/**
+*
+* @remarks
+* The screen top left corner is the origin
+*
+* @param {number} xmin - The bounding box xmin coordinate in pixels
+* @param {number} ymin - The bounding box ymin coordinate in pixels
+* @param {number} xmax - The bounding box xmax coordinate in pixels
+* @param {number} ymax - The bounding box ymax coordinate in pixels
+*
+*/
 class BoundingBox {
     constructor(xmin, ymin, xmax, ymax) {
         this.xmin = xmin;
@@ -11,5 +22,21 @@ class BoundingBox {
     static fromJson(boundinBox, resizeRatio = 1) {
         return new BoundingBox(boundinBox.xmin * resizeRatio, boundinBox.ymin * resizeRatio, boundinBox.xmax * resizeRatio, boundinBox.ymax * resizeRatio);
     }
+    /**
+    *
+    * @returns {number} The bounding box height in pixels
+    *
+    */
+    get_height() {
+        return this.ymax - this.ymin;
+    }
+    /**
+    *
+    * @returns {number} The bounding box width in pixels
+    *
+    */
+    get_width() {
+        return this.xmax - this.xmin;
+    }
 }
 exports.BoundingBox = BoundingBox;

package/dist/cjs/core/model/annotation-result/detected-element.d.ts

@@ -1,11 +1,17 @@
 import { BoundingBox } from './boundary-box';
+/**
+*
+* @param {string} name - The element type e.g text, button
+* @param {string} text - The detected text inside the element
+* @param {string[]} colors - The element top 3 dominate colors
+* @param {BoundingBox} bndbox - The element bounding box
+*
+*/
 export declare class DetectedElement {
     name: string;
-    truncated: number;
-    difficult: number;
     text: string;
     colors: string[];
     bndbox: BoundingBox;
-    constructor(name: string, truncated: number, difficult: number, text: string, colors: string[], bndbox: BoundingBox);
+    constructor(name: string, text: string, colors: string[], bndbox: BoundingBox);
     static fromJson(detectedElement: DetectedElement, resizeRatio?: number): DetectedElement;
 }

package/dist/cjs/core/model/annotation-result/detected-element.js

@@ -2,17 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DetectedElement = void 0;
 const boundary_box_1 = require("./boundary-box");
+/**
+*
+* @param {string} name - The element type e.g text, button
+* @param {string} text - The detected text inside the element
+* @param {string[]} colors - The element top 3 dominate colors
+* @param {BoundingBox} bndbox - The element bounding box
+*
+*/
 class DetectedElement {
-    constructor(name, truncated, difficult, text, colors, bndbox) {
+    constructor(name, text, colors, bndbox) {
         this.name = name;
-        this.truncated = truncated;
-        this.difficult = difficult;
         this.text = text;
         this.colors = colors;
         this.bndbox = bndbox;
     }
     static fromJson(detectedElement, resizeRatio = 1) {
-        return new DetectedElement(detectedElement.name, detectedElement.truncated, detectedElement.difficult, detectedElement.text, detectedElement.colors, boundary_box_1.BoundingBox.fromJson(detectedElement.bndbox, resizeRatio));
+        return new DetectedElement(detectedElement.name, detectedElement.text, detectedElement.colors, boundary_box_1.BoundingBox.fromJson(detectedElement.bndbox, resizeRatio));
     }
 }
 exports.DetectedElement = DetectedElement;

package/dist/cjs/core/ui-control-commands/control-command.d.ts

@@ -5,6 +5,6 @@ export declare class ControlCommand {
     actions: Action[];
     tryToRepeat: boolean;
     constructor(code: ControlCommandCode, actions: Action[], tryToRepeat?: boolean);
-    static fromJson(json: ControlCommand, resizeRatio?: number): ControlCommand;
+    static fromJson(json: unknown, resizeRatio?: number): ControlCommand;
     setTextToBeTyped(text: string): void;
 }

package/dist/cjs/core/ui-control-commands/control-command.js

@@ -11,7 +11,8 @@ class ControlCommand {
         this.tryToRepeat = tryToRepeat;
     }
     static fromJson(json, resizeRatio = 1) {
-        return new ControlCommand(control_command_code_1.ControlCommandCode[json.code], json.actions.map((action) => action_1.Action.fromJson(action, resizeRatio)), json.tryToRepeat);
+        const controlCommand = json;
+        return new ControlCommand(control_command_code_1.ControlCommandCode[controlCommand.code], controlCommand.actions.map((action) => action_1.Action.fromJson(action, resizeRatio)), controlCommand.tryToRepeat);
     }
     setTextToBeTyped(text) {
         this.actions = this.actions.map((action) => ([input_event_1.InputEvent.TYPE, input_event_1.InputEvent.TYPE_TEXT].includes(action.inputEvent)

package/dist/cjs/core/ui-control-commands/index.d.ts

@@ -1,2 +1,3 @@
 export { ControlCommand } from './control-command';
 export { ControlCommandCode } from './control-command-code';
+export { InferenceResponse } from '../inference-response/inference-response';

package/dist/cjs/core/ui-control-commands/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlCommandCode = exports.ControlCommand = void 0;
+exports.InferenceResponse = exports.ControlCommandCode = exports.ControlCommand = void 0;
 var control_command_1 = require("./control-command");
 Object.defineProperty(exports, "ControlCommand", { enumerable: true, get: function () { return control_command_1.ControlCommand; } });
 var control_command_code_1 = require("./control-command-code");
 Object.defineProperty(exports, "ControlCommandCode", { enumerable: true, get: function () { return control_command_code_1.ControlCommandCode; } });
+var inference_response_1 = require("../inference-response/inference-response");
+Object.defineProperty(exports, "InferenceResponse", { enumerable: true, get: function () { return inference_response_1.InferenceResponse; } });