askui 0.5.0 → 0.6.1

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

@@ -0,0 +1,5 @@
+import { DetectedElement } from '../model/annotation-result/detected-element';
+export interface AnnotationJson {
+    image: string;
+    objects: DetectedElement[];
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/execution/config-error.d.ts

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

package/dist/cjs/execution/config-error.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationError = void 0;
+class ConfigurationError extends Error {
+}
+exports.ConfigurationError = ConfigurationError;

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

@@ -6,10 +6,11 @@ import { DetectedElement } from '../core/model/annotation-result/detected-elemen
 export declare class InferenceClient {
     baseUrl: string;
     httpClient: HttpClientGot;
+    resize?: number | undefined;
     readonly workspaceId?: string | undefined;
     apiVersion: string;
     url: string;
-    constructor(baseUrl: string, httpClient: HttpClientGot, workspaceId?: string | undefined, apiVersion?: string);
+    constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
     inference(customElements?: CustomElement[], image?: string, instruction?: string): Promise<ControlCommand | Annotation>;

package/dist/cjs/execution/inference-client.js

@@ -18,14 +18,20 @@ const ui_control_commands_1 = require("../core/ui-control-commands");
 const annotation_1 = require("../core/annotation/annotation");
 const transformations_1 = require("../utils/transformations");
 const inference_response_error_1 = require("./inference-response-error");
+const config_error_1 = require("./config-error");
 class InferenceClient {
-    constructor(baseUrl, httpClient, workspaceId, apiVersion = 'v3') {
+    constructor(baseUrl, httpClient, resize, workspaceId, apiVersion = 'v3') {
         this.baseUrl = baseUrl;
         this.httpClient = httpClient;
+        this.resize = resize;
         this.workspaceId = workspaceId;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = (0, url_join_1.default)(this.baseUrl, 'api', this.apiVersion);
         this.url = workspaceId ? (0, url_join_1.default)(versionedBaseUrl, 'workspaces', workspaceId) : versionedBaseUrl;
+        if (this.resize !== undefined && this.resize <= 0) {
+            throw new config_error_1.ConfigurationError(`Resize must be a positive number. The current resize value "${this.resize}" is not valid.`);
+        }
+        this.resize = this.resize ? Math.ceil(this.resize) : this.resize;
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40,10 +46,10 @@ class InferenceClient {
     // eslint-disable-next-line class-methods-use-this
     resizeIfNeeded(customElements, image) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!(image) || customElements.length > 0) {
+            if (!(image) || customElements.length > 0 || this.resize === undefined) {
                 return { base64Image: image, resizeRatio: 1 };
             }
-            return (0, transformations_1.resizeBase64ImageWithSameRatio)(image);
+            return (0, transformations_1.resizeBase64ImageWithSameRatio)(image, this.resize);
         });
     }
     inference(customElements = [], image, instruction) {

package/dist/cjs/execution/ui-control-client.js

@@ -23,6 +23,7 @@ const annotation_level_1 = require("./annotation-level");
 const ui_control_client_error_1 = require("./ui-control-client-error");
 const read_environment_credentials_1 = require("./read-environment-credentials");
 const analytics_1 = require("../utils/analytics");
+const proxy_builder_1 = require("../utils/proxy/proxy-builder");
 const getClientArgsWithDefaults = (clientArgs = {}) => (Object.assign({ uiControllerUrl: 'http://127.0.0.1:6769', inferenceServerUrl: 'https://inference.askui.com', annotationLevel: annotation_level_1.AnnotationLevel.DISABLED }, clientArgs));
 class UiControlClient extends dsl_1.ApiCommands {
     constructor(httpClient, clientArgs, workspaceId) {
@@ -39,7 +40,8 @@ class UiControlClient extends dsl_1.ApiCommands {
             const analyticsCookies = yield analytics.getAnalyticsCookies();
             const cas = getClientArgsWithDefaults(clientArgs);
             const credentialArgs = cas.credentials || (0, read_environment_credentials_1.envCredentials)();
-            const httpClient = new http_client_got_1.HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders, analyticsCookies);
+            const proxyAgentArgs = cas.proxyAgents || (yield (0, proxy_builder_1.buildProxyAgentArgsFromEnvironment)());
+            const httpClient = new http_client_got_1.HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders, analyticsCookies, proxyAgentArgs);
             return new UiControlClient(httpClient, cas, credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.workspaceId);
         });
     }
@@ -50,7 +52,7 @@ class UiControlClient extends dsl_1.ApiCommands {
         return this._uiControllerClient;
     }
     get inferenceClient() {
-        return new inference_client_1.InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.workspaceId);
+        return new inference_client_1.InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.clientArgs.resize, this.workspaceId);
     }
     get executionRuntime() {
         return new execution_runtime_1.ExecutionRuntime(this.uiControllerClient, this.inferenceClient);

package/dist/cjs/execution/ui-controller-client-interface.d.ts

@@ -1,10 +1,19 @@
 import { AnnotationLevel } from './annotation-level';
 import { CredentialArgs } from './credentials-args';
+import { ProxyAgentArgs } from '../shared/proxy-agent-args';
 /**
  * Configuration options for the askui UI Control Client
  *
  * @param {string} uiControllerUrl - Default: http://127.0.0.1:6769
  * The adress of the askui UI Controller server.
+ * @param {(number | undefined)} resize - Default: undefined
+ * The resizing will be skipped if it's undefined.
+ * The side length of the target image to resize to in px.
+ * Your screenshot image will be resized with the original aspect ratio,
+ *  and the lengths image side will be equal to this number.
+ * This can be used to reduce the inference time by reducing
+ *  the request size in case of a bad internet connection.
+ * But it can cause a decrease in the prediction quality.
  * @param {string} inferenceClientUrl - Default: https://inference.askui.com`
  * Address of the askui Inference server.
  * @param {AnnotationLevel} annotationLevel - Default: AnnotationLevel.DISABLED
@@ -13,12 +22,16 @@ import { CredentialArgs } from './credentials-args';
  * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
  * @param {CredentialArgs} credentials - We need to provide credentials for
  * the authentication of the askui Inference Server.
+ * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
+ * @param {ProxyAgentArgs} proxyAgents - To configure the proxy agents for http(s) requests.
  */
 export interface ClientArgs {
     readonly uiControllerUrl?: string;
     readonly inferenceServerUrl?: string;
     readonly annotationLevel?: AnnotationLevel;
     readonly credentials?: CredentialArgs;
+    readonly proxyAgents?: ProxyAgentArgs;
+    readonly resize?: number;
 }
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;

package/dist/cjs/lib/download-binaries.d.ts

@@ -1,3 +1,6 @@
+/// <reference types="node" />
+import http from 'http';
+import https from 'https';
 declare enum SupportedPlatform {
     LINUX = "linux",
     DARWIN = "darwin",
@@ -5,5 +8,8 @@ declare enum SupportedPlatform {
 }
 export declare function platform(): SupportedPlatform;
 export declare function getBinaryPath(version: string): string;
-export declare function downloadServerBinaries(binaryVersion: string): Promise<void>;
+export declare function downloadServerBinaries(binaryVersion: string, proxyAgent?: {
+    http: http.Agent;
+    https: https.Agent;
+}): Promise<void>;
 export {};

package/dist/cjs/lib/download-binaries.js

@@ -44,7 +44,7 @@ function getBinaryDownloadUrl(binaryVersion) {
     const arch = os_1.default.arch();
     return `${baseUrl}/${platform()}/${arch}/${binarySubPathsByPlatform[platform()][1]}`;
 }
-function downloadServerBinaries(binaryVersion) {
+function downloadServerBinaries(binaryVersion, proxyAgent) {
     return new Promise((resolve, reject) => {
         const url = getBinaryDownloadUrl(binaryVersion);
         const binaryOutputPath = getBinaryPath(binaryVersion);
@@ -53,7 +53,7 @@ function downloadServerBinaries(binaryVersion) {
         if (!(fs_1.default.existsSync(binaryFolder))) {
             fs_1.default.mkdirSync(binaryFolder, { recursive: true });
         }
-        const downloadStream = got_1.default.stream(url);
+        const downloadStream = got_1.default.stream(url, proxyAgent ? { agent: proxyAgent } : {});
         const fileWriterStream = fs_1.default.createWriteStream(binaryOutputPath);
         downloadStream.on('error', () => {
             reject();

package/dist/cjs/lib/ui-controller-args.d.ts

@@ -1,3 +1,4 @@
+import { ProxyAgentArgs } from '../shared/proxy-agent-args';
 import { LogLevels } from '../shared/log-levels';
 /**
  * Configuration options for the askui UI Controller
@@ -5,6 +6,7 @@ import { LogLevels } from '../shared/log-levels';
  * @param {number} display - Default: `0`
  * You can choose on which display you want to excecute all tests.
  * 0 is your main monitor.
+ *
  * If you want to use your second monitor you can change
  * the value to `1` (`2` for your third monitor etc.).
  * @param {string} binaryVersion - Default: `'latest'`
@@ -26,6 +28,7 @@ import { LogLevels } from '../shared/log-levels';
  * @param {string} logFilePath - Default: `'<temp-dir>/askui/askui-server.log'`
  * It is possible to specify a path for your log files.
  * Per default we create the askui-server.log file and askui folder in your temp folder.
+ * @param {ProxyAgentArgs} proxyAgents - To configure the proxy agents for our http(s) requests.
  */
 export interface UiControllerArgs {
     readonly display?: number;
@@ -37,6 +40,7 @@ export interface UiControllerArgs {
     readonly overWriteBinary?: boolean;
     readonly logLevel?: LogLevels;
     readonly logFilePath?: string;
+    readonly proxyAgents?: ProxyAgentArgs;
 }
 export interface UiControllerArgsWithDefaults extends UiControllerArgs {
     readonly display: number;

package/dist/cjs/lib/ui-controller-facade.js

@@ -24,6 +24,7 @@ const download_binaries_1 = require("./download-binaries");
 const logger_1 = require("./logger");
 const timeout_error_1 = require("./timeout-error");
 const unkown_error_1 = require("./unkown-error");
+const proxy_builder_1 = require("../utils/proxy/proxy-builder");
 class UiControllerFacade {
     constructor() {
         this.binaryPath = (0, download_binaries_1.getBinaryPath)('latest');
@@ -35,7 +36,7 @@ class UiControllerFacade {
             const argsWithDefaults = (0, ui_controller_args_1.createArgsWithDefaults)(args);
             const argsWithLogPath = this.serverLogFilePath(argsWithDefaults);
             this.binaryPath = (0, download_binaries_1.getBinaryPath)(argsWithLogPath.binaryVersion);
-            yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary);
+            yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary, argsWithLogPath.proxyAgents || (yield (0, proxy_builder_1.buildProxyAgentArgsFromEnvironment)()));
             this.makeBinaryExecutable();
             logger_1.logger.debug(`UI Controller log path "${this.serverLogFile}"`);
             yield this.startWithDefaults(argsWithLogPath, maxWaitingForStartingInSeconds);
@@ -109,11 +110,11 @@ class UiControllerFacade {
         const binarysizeInMB = fs_extra_1.default.statSync(this.binaryPath).size / (1024 * 1024);
         return binarysizeInMB > sizeThresholdInMB;
     }
-    getBinary(binaryVersion, overWriteBinary = false) {
+    getBinary(binaryVersion, overWriteBinary = false, proxyAgent) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!fs_extra_1.default.existsSync(this.binaryPath) || overWriteBinary || !this.isBinaryValid()) {
                 logger_1.logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryPath}"`);
-                yield (0, download_binaries_1.downloadServerBinaries)(binaryVersion);
+                yield (0, download_binaries_1.downloadServerBinaries)(binaryVersion, proxyAgent);
             }
             else {
                 logger_1.logger.debug(`Binary of UI Controller is already present at "${this.binaryPath}".`);

package/dist/cjs/shared/proxy-agent-args.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="node" />
+import http from 'http';
+import https from 'https';
+/**
+ * Proxy agent configuration for HTTP(S) requests
+ *
+ * All modules which implement the `http.Agent`'s or `https.Agent`'s
+ * interface, respectively, can be used.
+ * We recommend to use [hpagent](https://github.com/delvedore/hpagent).
+ *
+ * Installation:
+ * ```shell
+ * npm install --save hpagent
+ * ```
+ *
+ * Configuration:
+ * ```typescript
+ *  const httpProxyUrl = "http://your-proxy:3128";
+ *  const httpsProxyUrl = "https://your-proxy:3129";
+ *
+ *  const aui = await UiControlClient.build({
+ *    proxyAgents: {
+ *      http: new HttpProxyAgent({ proxy: httpProxyUrl }),
+ *      https: new HttpsProxyAgent({ proxy: httpsProxyUrl }),
+ *    },
+ *  });
+ * ```
+ *
+ * @param {http.Agent} http - Agent for http requests
+ * @param {https.Agent} https - Agent for https requests
+ ** */
+export interface ProxyAgentArgs {
+    http: http.Agent;
+    https: https.Agent;
+}

package/dist/cjs/shared/proxy-agent-args.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/utils/http/http-client-got.d.ts

@@ -1,10 +1,20 @@
 import { OptionsOfJSONResponseBody } from 'got';
+import http from 'http';
+import https from 'https';
 export declare class HttpClientGot {
     readonly token?: string | undefined;
     readonly customHeaders?: Record<string, string> | undefined;
     private readonly cookies;
+    readonly proxyAgents?: {
+        http: http.Agent;
+        https: https.Agent;
+    } | undefined;
     private headers;
-    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>);
+    private askuiGot;
+    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>, proxyAgents?: {
+        http: http.Agent;
+        https: https.Agent;
+    } | undefined);
     private initHeaders;
     private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;

package/dist/cjs/utils/http/http-client-got.js

@@ -19,12 +19,14 @@ const lib_1 = require("../../lib");
 const credentials_1 = require("./credentials");
 const custom_errors_1 = require("./custom-errors");
 class HttpClientGot {
-    constructor(token, customHeaders, cookies = {}) {
+    constructor(token, customHeaders, cookies = {}, proxyAgents) {
         this.token = token;
         this.customHeaders = customHeaders;
         this.cookies = cookies;
+        this.proxyAgents = proxyAgents;
         this.headers = {};
         this.initHeaders(token, customHeaders);
+        this.askuiGot = got_1.default.extend(proxyAgents ? { agent: proxyAgents } : {});
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new credentials_1.Credentials(token) : undefined;
@@ -40,7 +42,7 @@ class HttpClientGot {
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.injectHeadersAndCookies(url, { json: data, responseType: 'json', throwHttpErrors: false });
-            const { body, statusCode, headers } = yield got_1.default.post(url, options);
+            const { body, statusCode, headers } = yield this.askuiGot.post(url, options);
             if (headers['deprecation'] !== undefined) {
                 lib_1.logger.warn(headers['deprecation']);
             }
@@ -52,7 +54,7 @@ class HttpClientGot {
     }
     get(url, options = { responseType: 'json' }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield got_1.default.get(url, this.injectHeadersAndCookies(url, options));
+            const response = yield this.askuiGot.get(url, this.injectHeadersAndCookies(url, options));
             return response.body;
         });
     }

package/dist/cjs/utils/proxy/proxy-builder.d.ts

@@ -0,0 +1,4 @@
+import { ProxyAgentArgs } from '../../shared/proxy-agent-args';
+export declare class ProxyImportError extends Error {
+}
+export declare function buildProxyAgentArgsFromEnvironment(): Promise<ProxyAgentArgs | undefined>;

package/dist/cjs/utils/proxy/proxy-builder.js

@@ -0,0 +1,67 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.buildProxyAgentArgsFromEnvironment = exports.ProxyImportError = void 0;
+const logger_1 = require("../../lib/logger");
+class ProxyImportError extends Error {
+}
+exports.ProxyImportError = ProxyImportError;
+function dynmicImportHpagent() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // eslint-disable-next-line import/no-extraneous-dependencies
+            return yield Promise.resolve().then(() => __importStar(require('hpagent')));
+        }
+        catch (err) {
+            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy! Please, install hpagent for proxy support with "npm install --save-dev hpagent".');
+        }
+    });
+}
+function buildProxyAgentArgsFromEnvironment() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const httpProxyUrl = process.env['HTTP_PROXY'];
+        const httpsProxyUrl = process.env['HTTPS_PROXY'];
+        if (httpProxyUrl === undefined && httpsProxyUrl === undefined) {
+            logger_1.logger.debug('No proxy defined. "HTTPS_PROXY" and "HTTP_PROXY" environment variables are empty.');
+            return undefined;
+        }
+        const hpagent = yield dynmicImportHpagent();
+        logger_1.logger.info('Using proxy! One of following environment variables are defined: "HTTPS_PROXY", "https_proxy", "HTTP_PROXY" and "http_proxy"');
+        return {
+            http: new hpagent.HttpProxyAgent({
+                proxy: (httpProxyUrl || httpsProxyUrl),
+            }),
+            https: new hpagent.HttpsProxyAgent({
+                proxy: (httpsProxyUrl || httpProxyUrl),
+            }),
+        };
+    });
+}
+exports.buildProxyAgentArgsFromEnvironment = buildProxyAgentArgsFromEnvironment;

package/dist/esm/core/annotation/annotation-json.d.ts

@@ -0,0 +1,5 @@
+import { DetectedElement } from '../model/annotation-result/detected-element';
+export interface AnnotationJson {
+    image: string;
+    objects: DetectedElement[];
+}

package/dist/esm/core/annotation/annotation-json.js

@@ -0,0 +1 @@
+export {};

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

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

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

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

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

@@ -6,10 +6,11 @@ import { DetectedElement } from '../core/model/annotation-result/detected-elemen
 export declare class InferenceClient {
     baseUrl: string;
     httpClient: HttpClientGot;
+    resize?: number | undefined;
     readonly workspaceId?: string | undefined;
     apiVersion: string;
     url: string;
-    constructor(baseUrl: string, httpClient: HttpClientGot, workspaceId?: string | undefined, apiVersion?: string);
+    constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
     inference(customElements?: CustomElement[], image?: string, instruction?: string): Promise<ControlCommand | Annotation>;

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

@@ -12,14 +12,20 @@ import { ControlCommand, InferenceResponse } from '../core/ui-control-commands';
 import { Annotation } from '../core/annotation/annotation';
 import { resizeBase64ImageWithSameRatio } from '../utils/transformations';
 import { InferenceResponseError } from './inference-response-error';
+import { ConfigurationError } from './config-error';
 export class InferenceClient {
-    constructor(baseUrl, httpClient, workspaceId, apiVersion = 'v3') {
+    constructor(baseUrl, httpClient, resize, workspaceId, apiVersion = 'v3') {
         this.baseUrl = baseUrl;
         this.httpClient = httpClient;
+        this.resize = resize;
         this.workspaceId = workspaceId;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = urljoin(this.baseUrl, 'api', this.apiVersion);
         this.url = workspaceId ? urljoin(versionedBaseUrl, 'workspaces', workspaceId) : versionedBaseUrl;
+        if (this.resize !== undefined && this.resize <= 0) {
+            throw new ConfigurationError(`Resize must be a positive number. The current resize value "${this.resize}" is not valid.`);
+        }
+        this.resize = this.resize ? Math.ceil(this.resize) : this.resize;
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -34,10 +40,10 @@ export class InferenceClient {
     // eslint-disable-next-line class-methods-use-this
     resizeIfNeeded(customElements, image) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!(image) || customElements.length > 0) {
+            if (!(image) || customElements.length > 0 || this.resize === undefined) {
                 return { base64Image: image, resizeRatio: 1 };
             }
-            return resizeBase64ImageWithSameRatio(image);
+            return resizeBase64ImageWithSameRatio(image, this.resize);
         });
     }
     inference(customElements = [], image, instruction) {

package/dist/esm/execution/ui-control-client.js

@@ -20,6 +20,7 @@ import { AnnotationLevel } from './annotation-level';
 import { UiControlClientError } from './ui-control-client-error';
 import { envCredentials } from './read-environment-credentials';
 import { Analytics } from '../utils/analytics';
+import { buildProxyAgentArgsFromEnvironment } from '../utils/proxy/proxy-builder';
 const getClientArgsWithDefaults = (clientArgs = {}) => (Object.assign({ uiControllerUrl: 'http://127.0.0.1:6769', inferenceServerUrl: 'https://inference.askui.com', annotationLevel: AnnotationLevel.DISABLED }, clientArgs));
 export class UiControlClient extends ApiCommands {
     constructor(httpClient, clientArgs, workspaceId) {
@@ -36,7 +37,8 @@ export class UiControlClient extends ApiCommands {
             const analyticsCookies = yield analytics.getAnalyticsCookies();
             const cas = getClientArgsWithDefaults(clientArgs);
             const credentialArgs = cas.credentials || envCredentials();
-            const httpClient = new HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders, analyticsCookies);
+            const proxyAgentArgs = cas.proxyAgents || (yield buildProxyAgentArgsFromEnvironment());
+            const httpClient = new HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders, analyticsCookies, proxyAgentArgs);
             return new UiControlClient(httpClient, cas, credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.workspaceId);
         });
     }
@@ -47,7 +49,7 @@ export class UiControlClient extends ApiCommands {
         return this._uiControllerClient;
     }
     get inferenceClient() {
-        return new InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.workspaceId);
+        return new InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.clientArgs.resize, this.workspaceId);
     }
     get executionRuntime() {
         return new ExecutionRuntime(this.uiControllerClient, this.inferenceClient);

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

@@ -1,10 +1,19 @@
 import { AnnotationLevel } from './annotation-level';
 import { CredentialArgs } from './credentials-args';
+import { ProxyAgentArgs } from '../shared/proxy-agent-args';
 /**
  * Configuration options for the askui UI Control Client
  *
  * @param {string} uiControllerUrl - Default: http://127.0.0.1:6769
  * The adress of the askui UI Controller server.
+ * @param {(number | undefined)} resize - Default: undefined
+ * The resizing will be skipped if it's undefined.
+ * The side length of the target image to resize to in px.
+ * Your screenshot image will be resized with the original aspect ratio,
+ *  and the lengths image side will be equal to this number.
+ * This can be used to reduce the inference time by reducing
+ *  the request size in case of a bad internet connection.
+ * But it can cause a decrease in the prediction quality.
  * @param {string} inferenceClientUrl - Default: https://inference.askui.com`
  * Address of the askui Inference server.
  * @param {AnnotationLevel} annotationLevel - Default: AnnotationLevel.DISABLED
@@ -13,12 +22,16 @@ import { CredentialArgs } from './credentials-args';
  * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
  * @param {CredentialArgs} credentials - We need to provide credentials for
  * the authentication of the askui Inference Server.
+ * You have three options: `DISABLED`, `ON_FAILURE`, `ALL`.
+ * @param {ProxyAgentArgs} proxyAgents - To configure the proxy agents for http(s) requests.
  */
 export interface ClientArgs {
     readonly uiControllerUrl?: string;
     readonly inferenceServerUrl?: string;
     readonly annotationLevel?: AnnotationLevel;
     readonly credentials?: CredentialArgs;
+    readonly proxyAgents?: ProxyAgentArgs;
+    readonly resize?: number;
 }
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;

package/dist/esm/lib/download-binaries.d.ts

@@ -1,3 +1,6 @@
+/// <reference types="node" />
+import http from 'http';
+import https from 'https';
 declare enum SupportedPlatform {
     LINUX = "linux",
     DARWIN = "darwin",
@@ -5,5 +8,8 @@ declare enum SupportedPlatform {
 }
 export declare function platform(): SupportedPlatform;
 export declare function getBinaryPath(version: string): string;
-export declare function downloadServerBinaries(binaryVersion: string): Promise<void>;
+export declare function downloadServerBinaries(binaryVersion: string, proxyAgent?: {
+    http: http.Agent;
+    https: https.Agent;
+}): Promise<void>;
 export {};

package/dist/esm/lib/download-binaries.js

@@ -36,7 +36,7 @@ function getBinaryDownloadUrl(binaryVersion) {
     const arch = os.arch();
     return `${baseUrl}/${platform()}/${arch}/${binarySubPathsByPlatform[platform()][1]}`;
 }
-export function downloadServerBinaries(binaryVersion) {
+export function downloadServerBinaries(binaryVersion, proxyAgent) {
     return new Promise((resolve, reject) => {
         const url = getBinaryDownloadUrl(binaryVersion);
         const binaryOutputPath = getBinaryPath(binaryVersion);
@@ -45,7 +45,7 @@ export function downloadServerBinaries(binaryVersion) {
         if (!(fs.existsSync(binaryFolder))) {
             fs.mkdirSync(binaryFolder, { recursive: true });
         }
-        const downloadStream = got.stream(url);
+        const downloadStream = got.stream(url, proxyAgent ? { agent: proxyAgent } : {});
         const fileWriterStream = fs.createWriteStream(binaryOutputPath);
         downloadStream.on('error', () => {
             reject();

package/dist/esm/lib/ui-controller-args.d.ts

@@ -1,3 +1,4 @@
+import { ProxyAgentArgs } from '../shared/proxy-agent-args';
 import { LogLevels } from '../shared/log-levels';
 /**
  * Configuration options for the askui UI Controller
@@ -5,6 +6,7 @@ import { LogLevels } from '../shared/log-levels';
  * @param {number} display - Default: `0`
  * You can choose on which display you want to excecute all tests.
  * 0 is your main monitor.
+ *
  * If you want to use your second monitor you can change
  * the value to `1` (`2` for your third monitor etc.).
  * @param {string} binaryVersion - Default: `'latest'`
@@ -26,6 +28,7 @@ import { LogLevels } from '../shared/log-levels';
  * @param {string} logFilePath - Default: `'<temp-dir>/askui/askui-server.log'`
  * It is possible to specify a path for your log files.
  * Per default we create the askui-server.log file and askui folder in your temp folder.
+ * @param {ProxyAgentArgs} proxyAgents - To configure the proxy agents for our http(s) requests.
  */
 export interface UiControllerArgs {
     readonly display?: number;
@@ -37,6 +40,7 @@ export interface UiControllerArgs {
     readonly overWriteBinary?: boolean;
     readonly logLevel?: LogLevels;
     readonly logFilePath?: string;
+    readonly proxyAgents?: ProxyAgentArgs;
 }
 export interface UiControllerArgsWithDefaults extends UiControllerArgs {
     readonly display: number;

package/dist/esm/lib/ui-controller-facade.js

@@ -18,6 +18,7 @@ import { downloadServerBinaries, getBinaryPath } from './download-binaries';
 import { logger } from './logger';
 import { TimeoutError } from './timeout-error';
 import { UnkownError } from './unkown-error';
+import { buildProxyAgentArgsFromEnvironment } from '../utils/proxy/proxy-builder';
 export class UiControllerFacade {
     constructor() {
         this.binaryPath = getBinaryPath('latest');
@@ -29,7 +30,7 @@ export class UiControllerFacade {
             const argsWithDefaults = createArgsWithDefaults(args);
             const argsWithLogPath = this.serverLogFilePath(argsWithDefaults);
             this.binaryPath = getBinaryPath(argsWithLogPath.binaryVersion);
-            yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary);
+            yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary, argsWithLogPath.proxyAgents || (yield buildProxyAgentArgsFromEnvironment()));
             this.makeBinaryExecutable();
             logger.debug(`UI Controller log path "${this.serverLogFile}"`);
             yield this.startWithDefaults(argsWithLogPath, maxWaitingForStartingInSeconds);
@@ -103,11 +104,11 @@ export class UiControllerFacade {
         const binarysizeInMB = fs.statSync(this.binaryPath).size / (1024 * 1024);
         return binarysizeInMB > sizeThresholdInMB;
     }
-    getBinary(binaryVersion, overWriteBinary = false) {
+    getBinary(binaryVersion, overWriteBinary = false, proxyAgent) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!fs.existsSync(this.binaryPath) || overWriteBinary || !this.isBinaryValid()) {
                 logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryPath}"`);
-                yield downloadServerBinaries(binaryVersion);
+                yield downloadServerBinaries(binaryVersion, proxyAgent);
             }
             else {
                 logger.debug(`Binary of UI Controller is already present at "${this.binaryPath}".`);

package/dist/esm/shared/proxy-agent-args.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="node" />
+import http from 'http';
+import https from 'https';
+/**
+ * Proxy agent configuration for HTTP(S) requests
+ *
+ * All modules which implement the `http.Agent`'s or `https.Agent`'s
+ * interface, respectively, can be used.
+ * We recommend to use [hpagent](https://github.com/delvedore/hpagent).
+ *
+ * Installation:
+ * ```shell
+ * npm install --save hpagent
+ * ```
+ *
+ * Configuration:
+ * ```typescript
+ *  const httpProxyUrl = "http://your-proxy:3128";
+ *  const httpsProxyUrl = "https://your-proxy:3129";
+ *
+ *  const aui = await UiControlClient.build({
+ *    proxyAgents: {
+ *      http: new HttpProxyAgent({ proxy: httpProxyUrl }),
+ *      https: new HttpsProxyAgent({ proxy: httpsProxyUrl }),
+ *    },
+ *  });
+ * ```
+ *
+ * @param {http.Agent} http - Agent for http requests
+ * @param {https.Agent} https - Agent for https requests
+ ** */
+export interface ProxyAgentArgs {
+    http: http.Agent;
+    https: https.Agent;
+}

package/dist/esm/shared/proxy-agent-args.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/utils/http/http-client-got.d.ts

@@ -1,10 +1,20 @@
 import { OptionsOfJSONResponseBody } from 'got';
+import http from 'http';
+import https from 'https';
 export declare class HttpClientGot {
     readonly token?: string | undefined;
     readonly customHeaders?: Record<string, string> | undefined;
     private readonly cookies;
+    readonly proxyAgents?: {
+        http: http.Agent;
+        https: https.Agent;
+    } | undefined;
     private headers;
-    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>);
+    private askuiGot;
+    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>, proxyAgents?: {
+        http: http.Agent;
+        https: https.Agent;
+    } | undefined);
     private initHeaders;
     private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;

package/dist/esm/utils/http/http-client-got.js

@@ -13,12 +13,14 @@ import { logger } from '../../lib';
 import { Credentials } from './credentials';
 import { httpClientErrorHandler } from './custom-errors';
 export class HttpClientGot {
-    constructor(token, customHeaders, cookies = {}) {
+    constructor(token, customHeaders, cookies = {}, proxyAgents) {
         this.token = token;
         this.customHeaders = customHeaders;
         this.cookies = cookies;
+        this.proxyAgents = proxyAgents;
         this.headers = {};
         this.initHeaders(token, customHeaders);
+        this.askuiGot = got.extend(proxyAgents ? { agent: proxyAgents } : {});
     }
     initHeaders(token, customHeaders = {}) {
         const credentials = token ? new Credentials(token) : undefined;
@@ -34,7 +36,7 @@ export class HttpClientGot {
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.injectHeadersAndCookies(url, { json: data, responseType: 'json', throwHttpErrors: false });
-            const { body, statusCode, headers } = yield got.post(url, options);
+            const { body, statusCode, headers } = yield this.askuiGot.post(url, options);
             if (headers['deprecation'] !== undefined) {
                 logger.warn(headers['deprecation']);
             }
@@ -46,7 +48,7 @@ export class HttpClientGot {
     }
     get(url, options = { responseType: 'json' }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield got.get(url, this.injectHeadersAndCookies(url, options));
+            const response = yield this.askuiGot.get(url, this.injectHeadersAndCookies(url, options));
             return response.body;
         });
     }

package/dist/esm/utils/proxy/proxy-builder.d.ts

@@ -0,0 +1,4 @@
+import { ProxyAgentArgs } from '../../shared/proxy-agent-args';
+export declare class ProxyImportError extends Error {
+}
+export declare function buildProxyAgentArgsFromEnvironment(): Promise<ProxyAgentArgs | undefined>;

package/dist/esm/utils/proxy/proxy-builder.js

@@ -0,0 +1,43 @@
+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 { logger } from '../../lib/logger';
+export class ProxyImportError extends Error {
+}
+function dynmicImportHpagent() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // eslint-disable-next-line import/no-extraneous-dependencies
+            return yield import('hpagent');
+        }
+        catch (err) {
+            throw new ProxyImportError('Can\'t find "hpagent" module to configure proxy! Please, install hpagent for proxy support with "npm install --save-dev hpagent".');
+        }
+    });
+}
+export function buildProxyAgentArgsFromEnvironment() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const httpProxyUrl = process.env['HTTP_PROXY'];
+        const httpsProxyUrl = process.env['HTTPS_PROXY'];
+        if (httpProxyUrl === undefined && httpsProxyUrl === undefined) {
+            logger.debug('No proxy defined. "HTTPS_PROXY" and "HTTP_PROXY" environment variables are empty.');
+            return undefined;
+        }
+        const hpagent = yield dynmicImportHpagent();
+        logger.info('Using proxy! One of following environment variables are defined: "HTTPS_PROXY", "https_proxy", "HTTP_PROXY" and "http_proxy"');
+        return {
+            http: new hpagent.HttpProxyAgent({
+                proxy: (httpProxyUrl || httpsProxyUrl),
+            }),
+            https: new hpagent.HttpsProxyAgent({
+                proxy: (httpsProxyUrl || httpProxyUrl),
+            }),
+        };
+    });
+}

package/dist/example_projects_templates/typescript_jest/test/helper/jest.setup.ts

@@ -31,9 +31,9 @@ beforeAll(async () => {
 });
 
 afterAll(async () => {
-  await uiController.stop();
-
   aui.close();
+
+  await uiController.stop();
 });
 
 export { aui };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.5.0",
+    "version": "0.6.1",
     "license": "MIT",
     "author": "askui GmbH <info@askui.com> (http://www.askui.com/)",
     "description": "Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on",
@@ -39,7 +39,7 @@
         "copyExampleProject": "shx cp  -r example_projects_templates/ dist/  && shx cp -r bin/* dist/",
         "lint": "eslint --cache --fix --max-warnings 0 \"./**/*.{js,ts}\"",
         "lint:staged": "lint-staged",
-        "test": "jest '/src'",
+        "test": "NODE_EXTRA_CA_CERTS='test/proxy/certs/unit_test.pem' jest '/src'",
         "postinstall": "node -e \"require('./bin/askui-postinstall')\""
     },
     "files": [
@@ -73,7 +73,10 @@
         "@types/url-join": "4.0.1",
         "@types/webrtc": "0.0.30",
         "@types/ws": "7.4.4",
+        "hpagent": "^1.2.0",
         "jest": "28.1.1",
+        "proxy": "^1.0.2",
+        "proxy-agent": "^5.0.0",
         "sharp": "0.30.6",
         "shx": "0.3.4",
         "ts-jest": "28.0.4",