askui 0.1.6 → 0.2.2

package/dist/cjs/execution/client.d.ts

@@ -1,25 +0,0 @@
-import { CustomElementJson } from '../core/model/test-case-dto';
-import { FluentCommand } from './dsl';
-import { ClientConnectionState } from './client-connection-state';
-import { Annotation } from '../core/annotation/annotation';
-import { AnnotationRequest } from '../core/model/annotation-result/annotation-interface';
-import { ClientArgs } from './client-interface';
-export declare class AskuiClient extends FluentCommand {
-    private clientArgs?;
-    private _controlYourUiClient?;
-    private httpClient;
-    constructor(clientArgs?: ClientArgs | undefined);
-    private get controlYourUiClient();
-    private get clientArgsWithDefaults();
-    private get api();
-    private get executionRuntime();
-    private annotateByDefault;
-    connect(): Promise<ClientConnectionState>;
-    annotate(annotationRequest?: AnnotationRequest): Promise<Annotation>;
-    annotateInteractively(): Promise<void>;
-    exec(instruction: string, customElementJson?: CustomElementJson[]): Promise<void>;
-    /**
-    * closes the connection to the controlui-server`.
-    */
-    close(): void;
-}

package/dist/cjs/execution/client.js

@@ -1,116 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AskuiClient = void 0;
-const test_case_dto_1 = require("../core/model/test-case-dto");
-const dsl_1 = require("./dsl");
-const http_client_got_1 = require("../utils/http/http-client-got");
-const control_your_ui_client_1 = require("./control-your-ui-client");
-const execution_runtime_1 = require("./execution-runtime");
-const control_your_ui_api_1 = require("./control-your-ui-api");
-const annotation_writer_1 = require("../core/annotation/annotation-writer");
-const logger_1 = require("../lib/logger");
-const test_case_result_dto_1 = require("../core/model/test-case-result-dto");
-const annotation_level_1 = require("./annotation-level");
-const client_error_1 = require("./client-error");
-const read_environment_credentials_1 = require("./read-environment-credentials");
-class AskuiClient extends dsl_1.FluentCommand {
-    constructor(clientArgs) {
-        var _a;
-        super();
-        this.clientArgs = clientArgs;
-        this.httpClient = new http_client_got_1.HttpClientGot(((_a = this.clientArgs) === null || _a === void 0 ? void 0 : _a.credentials) ? this.clientArgs.credentials : (0, read_environment_credentials_1.envCredentials)());
-    }
-    get controlYourUiClient() {
-        if (!this._controlYourUiClient) {
-            this._controlYourUiClient = new control_your_ui_client_1.ControlYourUiClient(this.clientArgsWithDefaults.controlServerUrl);
-        }
-        return this._controlYourUiClient;
-    }
-    get clientArgsWithDefaults() {
-        const defaults = {
-            controlServerUrl: 'http://localhost:6769',
-            controlYourUiApi: 'https://inference.askui.com',
-            annotationLevel: annotation_level_1.AnnotationLevel.DISABLED,
-        };
-        return Object.assign(defaults, this.clientArgs);
-    }
-    get api() {
-        return new control_your_ui_api_1.ControlYourUiApi(this.clientArgsWithDefaults.controlYourUiApi, this.httpClient);
-    }
-    get executionRuntime() {
-        return new execution_runtime_1.ExecutionRuntime(this.controlYourUiClient, this.api);
-    }
-    annotateByDefault(testStepState, customElements = []) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if ((testStepState === test_case_result_dto_1.TestStepState.FAILED
-                && this.clientArgsWithDefaults.annotationLevel === annotation_level_1.AnnotationLevel.DISABLED)
-                || (testStepState === test_case_result_dto_1.TestStepState.PASSED
-                    && this.clientArgsWithDefaults.annotationLevel !== annotation_level_1.AnnotationLevel.ALL)) {
-                return;
-            }
-            yield this.annotate({
-                customElements,
-                fileNamePrefix: `${testStepState.toLowerCase()}_testStep_annotation`,
-            });
-        });
-    }
-    connect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const connectionState = yield this.controlYourUiClient.connect();
-            return connectionState;
-        });
-    }
-    annotate(annotationRequest = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const annotation = yield this.executionRuntime.annotateImage(annotationRequest.imagePath, annotationRequest.customElements);
-            annotation_writer_1.AnnotationWriter.write(annotation.toHtml(), annotationRequest.outputPath, annotationRequest.fileNamePrefix);
-            return annotation;
-        });
-    }
-    annotateInteractively() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.executionRuntime.annotateInteractively();
-            }
-            catch (err) {
-                logger_1.logger.error(err);
-            }
-        });
-    }
-    exec(instruction, customElementJson) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let customElements = [];
-            if (customElementJson !== undefined) {
-                customElements = yield test_case_dto_1.CustomElement.fromJsonListWithImagePathOrImage(customElementJson);
-            }
-            try {
-                yield this.executionRuntime.executeTestStep({
-                    instruction,
-                    customElements,
-                });
-                yield this.annotateByDefault(test_case_result_dto_1.TestStepState.PASSED, customElements);
-                return yield Promise.resolve();
-            }
-            catch (error) {
-                yield this.annotateByDefault(test_case_result_dto_1.TestStepState.FAILED, customElements);
-                return Promise.reject(new client_error_1.ControlUiClientError(`A problem occures while executing the instruction: ${instruction}. Reason ${error}`));
-            }
-        });
-    }
-    /**
-    * closes the connection to the controlui-server`.
-    */
-    close() {
-        this.controlYourUiClient.close();
-    }
-}
-exports.AskuiClient = AskuiClient;

package/dist/cjs/lib/askui-control-server.d.ts

@@ -1,8 +0,0 @@
-import { ControlUiServerArgs } from './control-ui-server-args';
-export declare class AskuiControlServer {
-    private args?;
-    private server;
-    constructor(args?: ControlUiServerArgs | undefined);
-    start(timeoutInSeconds?: number): Promise<void>;
-    stop(forceStop?: boolean): Promise<void>;
-}

package/dist/cjs/lib/control-ui-server-args.d.ts

@@ -1,21 +0,0 @@
-import { LogLevels } from '../shared/log-levels';
-export interface ControlUiServerArgs {
-    readonly display?: number;
-    readonly binaryVersion?: string;
-    readonly port?: number;
-    readonly host?: string;
-    readonly minimize?: boolean;
-    readonly overWriteBinary?: boolean;
-    readonly logLevel?: LogLevels;
-    readonly logFilePath?: string;
-}
-export interface ControlUiServerArgsWithDefaults extends ControlUiServerArgs {
-    readonly display: number;
-    readonly binaryVersion: string;
-    readonly overWriteBinary: boolean;
-    readonly port: number;
-    readonly host: string;
-    readonly logLevel?: LogLevels;
-}
-export declare function createArgsWithDefaults(args?: ControlUiServerArgs): ControlUiServerArgsWithDefaults;
-export declare function createCliFlagsFromArgs(args: ControlUiServerArgsWithDefaults): string[];

package/dist/cjs/lib/control-ui-server-darwin.d.ts

@@ -1,6 +0,0 @@
-import { ControlUiServerFacade } from './control-ui-server-facade';
-export declare class ControlUiServerDarwin extends ControlUiServerFacade {
-    protected makeBinaryExecutable(): void;
-    protected getStartingCommand(): string;
-    private makeDiskImageExecutable;
-}

package/dist/cjs/lib/control-ui-server-facade.d.ts

@@ -1,16 +0,0 @@
-import { ControlUiServerArgs, ControlUiServerArgsWithDefaults } from './control-ui-server-args';
-export declare abstract class ControlUiServerFacade {
-    protected binaryPath: string;
-    protected serverLogFile: string;
-    protected readonly DefaultmaxWaitingForStartingInMs: number;
-    start(args?: ControlUiServerArgs, maxWaitingForStartingInSeconds?: number): Promise<void>;
-    stop(args?: ControlUiServerArgs, forceStop?: boolean): Promise<void>;
-    protected serverLogFilePath(args?: ControlUiServerArgsWithDefaults): ControlUiServerArgsWithDefaults;
-    protected killPort(port: number, forceStop?: boolean): Promise<void>;
-    protected getStartingCommand(): string;
-    protected makeBinaryExecutable(): void;
-    protected waitUntilStarted(args: ControlUiServerArgsWithDefaults, maxWaitingForStartingInSeconds?: number): Promise<void>;
-    private isBinaryValid;
-    private getBinary;
-    private startWithDefaults;
-}

package/dist/cjs/lib/control-ui-server-linux.d.ts

@@ -1,4 +0,0 @@
-import { ControlUiServerFacade } from './control-ui-server-facade';
-export declare class ControlUiServerLinux extends ControlUiServerFacade {
-    protected makeBinaryExecutable(): void;
-}

package/dist/cjs/lib/control-ui-server-linux.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlUiServerLinux = void 0;
-const child_process_1 = require("child_process");
-const control_ui_server_facade_1 = require("./control-ui-server-facade");
-const logger_1 = require("./logger");
-class ControlUiServerLinux extends control_ui_server_facade_1.ControlUiServerFacade {
-    // eslint-disable-next-line class-methods-use-this
-    makeBinaryExecutable() {
-        (0, child_process_1.exec)(`chmod +x ${this.binaryPath}`, (_exception, stdout) => logger_1.logger.debug(stdout));
-    }
-}
-exports.ControlUiServerLinux = ControlUiServerLinux;

package/dist/cjs/lib/control-ui-server-win32.d.ts

@@ -1,3 +0,0 @@
-import { ControlUiServerFacade } from './control-ui-server-facade';
-export declare class ControlUiServerWin32 extends ControlUiServerFacade {
-}

package/dist/cjs/lib/control-ui-server-win32.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlUiServerWin32 = void 0;
-const control_ui_server_facade_1 = require("./control-ui-server-facade");
-class ControlUiServerWin32 extends control_ui_server_facade_1.ControlUiServerFacade {
-}
-exports.ControlUiServerWin32 = ControlUiServerWin32;

package/dist/cjs/utils/image-resize-errors/invalid-base64-image-error.d.ts

@@ -1,3 +0,0 @@
-import { ImageResizingError } from './image-resizing-base-error';
-export declare class InvalidBase64Image extends ImageResizingError {
-}

package/dist/cjs/utils/image-resize-errors/invalid-base64-image-error.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidBase64Image = void 0;
-const image_resizing_base_error_1 = require("./image-resizing-base-error");
-class InvalidBase64Image extends image_resizing_base_error_1.ImageResizingError {
-}
-exports.InvalidBase64Image = InvalidBase64Image;

package/dist/esm/execution/client-connection-state.js

@@ -1,7 +0,0 @@
-export var ClientConnectionState;
-(function (ClientConnectionState) {
-    ClientConnectionState[ClientConnectionState["NOT_CONNECTED"] = 0] = "NOT_CONNECTED";
-    ClientConnectionState[ClientConnectionState["CONNECTING"] = 1] = "CONNECTING";
-    ClientConnectionState[ClientConnectionState["CONNECTED"] = 2] = "CONNECTED";
-    ClientConnectionState[ClientConnectionState["ERROR"] = 3] = "ERROR";
-})(ClientConnectionState || (ClientConnectionState = {}));

package/dist/esm/execution/client-error.d.ts

@@ -1,2 +0,0 @@
-export declare class ControlUiClientError extends Error {
-}

package/dist/esm/execution/client-error.js

@@ -1,2 +0,0 @@
-export class ControlUiClientError extends Error {
-}

package/dist/esm/execution/client-interface.d.ts

@@ -1,13 +0,0 @@
-import { CredentialArgs } from '../utils/http/credentials';
-import { AnnotationLevel } from './annotation-level';
-export interface ClientArgs {
-    readonly controlServerUrl?: string;
-    readonly controlYourUiApi?: string;
-    readonly annotationLevel?: AnnotationLevel;
-    readonly credentials?: CredentialArgs;
-}
-export interface ClientArgsWithDefaults extends ClientArgs {
-    readonly controlServerUrl: string;
-    readonly controlYourUiApi: string;
-    readonly annotationLevel: AnnotationLevel;
-}

package/dist/esm/execution/client.d.ts

@@ -1,25 +0,0 @@
-import { CustomElementJson } from '../core/model/test-case-dto';
-import { FluentCommand } from './dsl';
-import { ClientConnectionState } from './client-connection-state';
-import { Annotation } from '../core/annotation/annotation';
-import { AnnotationRequest } from '../core/model/annotation-result/annotation-interface';
-import { ClientArgs } from './client-interface';
-export declare class AskuiClient extends FluentCommand {
-    private clientArgs?;
-    private _controlYourUiClient?;
-    private httpClient;
-    constructor(clientArgs?: ClientArgs | undefined);
-    private get controlYourUiClient();
-    private get clientArgsWithDefaults();
-    private get api();
-    private get executionRuntime();
-    private annotateByDefault;
-    connect(): Promise<ClientConnectionState>;
-    annotate(annotationRequest?: AnnotationRequest): Promise<Annotation>;
-    annotateInteractively(): Promise<void>;
-    exec(instruction: string, customElementJson?: CustomElementJson[]): Promise<void>;
-    /**
-    * closes the connection to the controlui-server`.
-    */
-    close(): void;
-}

package/dist/esm/execution/client.js

@@ -1,112 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { CustomElement } from '../core/model/test-case-dto';
-import { FluentCommand } from './dsl';
-import { HttpClientGot } from '../utils/http/http-client-got';
-import { ControlYourUiClient } from './control-your-ui-client';
-import { ExecutionRuntime } from './execution-runtime';
-import { ControlYourUiApi } from './control-your-ui-api';
-import { AnnotationWriter } from '../core/annotation/annotation-writer';
-import { logger } from '../lib/logger';
-import { TestStepState } from '../core/model/test-case-result-dto';
-import { AnnotationLevel } from './annotation-level';
-import { ControlUiClientError } from './client-error';
-import { envCredentials } from './read-environment-credentials';
-export class AskuiClient extends FluentCommand {
-    constructor(clientArgs) {
-        var _a;
-        super();
-        this.clientArgs = clientArgs;
-        this.httpClient = new HttpClientGot(((_a = this.clientArgs) === null || _a === void 0 ? void 0 : _a.credentials) ? this.clientArgs.credentials : envCredentials());
-    }
-    get controlYourUiClient() {
-        if (!this._controlYourUiClient) {
-            this._controlYourUiClient = new ControlYourUiClient(this.clientArgsWithDefaults.controlServerUrl);
-        }
-        return this._controlYourUiClient;
-    }
-    get clientArgsWithDefaults() {
-        const defaults = {
-            controlServerUrl: 'http://localhost:6769',
-            controlYourUiApi: 'https://inference.askui.com',
-            annotationLevel: AnnotationLevel.DISABLED,
-        };
-        return Object.assign(defaults, this.clientArgs);
-    }
-    get api() {
-        return new ControlYourUiApi(this.clientArgsWithDefaults.controlYourUiApi, this.httpClient);
-    }
-    get executionRuntime() {
-        return new ExecutionRuntime(this.controlYourUiClient, this.api);
-    }
-    annotateByDefault(testStepState, customElements = []) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if ((testStepState === TestStepState.FAILED
-                && this.clientArgsWithDefaults.annotationLevel === AnnotationLevel.DISABLED)
-                || (testStepState === TestStepState.PASSED
-                    && this.clientArgsWithDefaults.annotationLevel !== AnnotationLevel.ALL)) {
-                return;
-            }
-            yield this.annotate({
-                customElements,
-                fileNamePrefix: `${testStepState.toLowerCase()}_testStep_annotation`,
-            });
-        });
-    }
-    connect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const connectionState = yield this.controlYourUiClient.connect();
-            return connectionState;
-        });
-    }
-    annotate(annotationRequest = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const annotation = yield this.executionRuntime.annotateImage(annotationRequest.imagePath, annotationRequest.customElements);
-            AnnotationWriter.write(annotation.toHtml(), annotationRequest.outputPath, annotationRequest.fileNamePrefix);
-            return annotation;
-        });
-    }
-    annotateInteractively() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.executionRuntime.annotateInteractively();
-            }
-            catch (err) {
-                logger.error(err);
-            }
-        });
-    }
-    exec(instruction, customElementJson) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let customElements = [];
-            if (customElementJson !== undefined) {
-                customElements = yield CustomElement.fromJsonListWithImagePathOrImage(customElementJson);
-            }
-            try {
-                yield this.executionRuntime.executeTestStep({
-                    instruction,
-                    customElements,
-                });
-                yield this.annotateByDefault(TestStepState.PASSED, customElements);
-                return yield Promise.resolve();
-            }
-            catch (error) {
-                yield this.annotateByDefault(TestStepState.FAILED, customElements);
-                return Promise.reject(new ControlUiClientError(`A problem occures while executing the instruction: ${instruction}. Reason ${error}`));
-            }
-        });
-    }
-    /**
-    * closes the connection to the controlui-server`.
-    */
-    close() {
-        this.controlYourUiClient.close();
-    }
-}

package/dist/esm/lib/askui-control-server.d.ts

@@ -1,8 +0,0 @@
-import { ControlUiServerArgs } from './control-ui-server-args';
-export declare class AskuiControlServer {
-    private args?;
-    private server;
-    constructor(args?: ControlUiServerArgs | undefined);
-    start(timeoutInSeconds?: number): Promise<void>;
-    stop(forceStop?: boolean): Promise<void>;
-}

package/dist/esm/lib/control-ui-server-args.d.ts

@@ -1,21 +0,0 @@
-import { LogLevels } from '../shared/log-levels';
-export interface ControlUiServerArgs {
-    readonly display?: number;
-    readonly binaryVersion?: string;
-    readonly port?: number;
-    readonly host?: string;
-    readonly minimize?: boolean;
-    readonly overWriteBinary?: boolean;
-    readonly logLevel?: LogLevels;
-    readonly logFilePath?: string;
-}
-export interface ControlUiServerArgsWithDefaults extends ControlUiServerArgs {
-    readonly display: number;
-    readonly binaryVersion: string;
-    readonly overWriteBinary: boolean;
-    readonly port: number;
-    readonly host: string;
-    readonly logLevel?: LogLevels;
-}
-export declare function createArgsWithDefaults(args?: ControlUiServerArgs): ControlUiServerArgsWithDefaults;
-export declare function createCliFlagsFromArgs(args: ControlUiServerArgsWithDefaults): string[];

package/dist/esm/lib/control-ui-server-darwin.d.ts

@@ -1,6 +0,0 @@
-import { ControlUiServerFacade } from './control-ui-server-facade';
-export declare class ControlUiServerDarwin extends ControlUiServerFacade {
-    protected makeBinaryExecutable(): void;
-    protected getStartingCommand(): string;
-    private makeDiskImageExecutable;
-}

package/dist/esm/lib/control-ui-server-facade.d.ts

@@ -1,16 +0,0 @@
-import { ControlUiServerArgs, ControlUiServerArgsWithDefaults } from './control-ui-server-args';
-export declare abstract class ControlUiServerFacade {
-    protected binaryPath: string;
-    protected serverLogFile: string;
-    protected readonly DefaultmaxWaitingForStartingInMs: number;
-    start(args?: ControlUiServerArgs, maxWaitingForStartingInSeconds?: number): Promise<void>;
-    stop(args?: ControlUiServerArgs, forceStop?: boolean): Promise<void>;
-    protected serverLogFilePath(args?: ControlUiServerArgsWithDefaults): ControlUiServerArgsWithDefaults;
-    protected killPort(port: number, forceStop?: boolean): Promise<void>;
-    protected getStartingCommand(): string;
-    protected makeBinaryExecutable(): void;
-    protected waitUntilStarted(args: ControlUiServerArgsWithDefaults, maxWaitingForStartingInSeconds?: number): Promise<void>;
-    private isBinaryValid;
-    private getBinary;
-    private startWithDefaults;
-}

package/dist/esm/lib/control-ui-server-linux.d.ts

@@ -1,4 +0,0 @@
-import { ControlUiServerFacade } from './control-ui-server-facade';
-export declare class ControlUiServerLinux extends ControlUiServerFacade {
-    protected makeBinaryExecutable(): void;
-}

package/dist/esm/lib/control-ui-server-linux.js

@@ -1,9 +0,0 @@
-import { exec } from 'child_process';
-import { ControlUiServerFacade } from './control-ui-server-facade';
-import { logger } from './logger';
-export class ControlUiServerLinux extends ControlUiServerFacade {
-    // eslint-disable-next-line class-methods-use-this
-    makeBinaryExecutable() {
-        exec(`chmod +x ${this.binaryPath}`, (_exception, stdout) => logger.debug(stdout));
-    }
-}

package/dist/esm/lib/control-ui-server-win32.d.ts

@@ -1,3 +0,0 @@
-import { ControlUiServerFacade } from './control-ui-server-facade';
-export declare class ControlUiServerWin32 extends ControlUiServerFacade {
-}

package/dist/esm/lib/control-ui-server-win32.js

@@ -1,3 +0,0 @@
-import { ControlUiServerFacade } from './control-ui-server-facade';
-export class ControlUiServerWin32 extends ControlUiServerFacade {
-}

package/dist/esm/utils/image-resize-errors/invalid-base64-image-error.d.ts

@@ -1,3 +0,0 @@
-import { ImageResizingError } from './image-resizing-base-error';
-export declare class InvalidBase64Image extends ImageResizingError {
-}

package/dist/esm/utils/image-resize-errors/invalid-base64-image-error.js

@@ -1,3 +0,0 @@
-import { ImageResizingError } from './image-resizing-base-error';
-export class InvalidBase64Image extends ImageResizingError {
-}