askui 0.1.4 → 0.2.0

package/dist/cjs/execution/{control-your-ui-client.d.ts → ui-controller-client.d.ts}

@@ -2,21 +2,21 @@ import WebSocket from 'ws';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
 import { CaptureScreenshotResponse, ControlResponse, StartRecordingResponse, StopRecordingResponse, ReadRecordingPartResponse, InteractiveAnnotationResponse, GetProcessPidResponse } from '../core/runner-protocol';
 import { ControlCommand } from '../core/ui-control-commands';
-import { ClientConnectionState } from './client-connection-state';
-export declare class ControlYourUiClient {
-    controlServerUrl: string;
+import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
+export declare class UiControllerClient {
+    url: string;
     private static readonly EMPTY_REJECT;
     private static readonly EMPTY_RESOLVE;
     private static readonly REQUEST_TIMEOUT_IN_MS;
     ws: WebSocket;
-    connectionState: ClientConnectionState;
+    connectionState: UiControllerClientConnectionState;
     private timeout?;
     private currentReject;
     private currentResolve;
-    constructor(controlServerUrl: string);
+    constructor(url: string);
     private clearResponse;
     private onMessage;
-    connect(): Promise<ClientConnectionState>;
+    connect(): Promise<UiControllerClientConnectionState>;
     close(): void;
     private sendAndReceive;
     private send;

package/dist/cjs/execution/{control-your-ui-client.js → ui-controller-client.js}

@@ -3,23 +3,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlYourUiClient = void 0;
+exports.UiControllerClient = void 0;
 const ws_1 = __importDefault(require("ws"));
 const runner_protocol_1 = require("../core/runner-protocol");
 const logger_1 = require("../lib/logger");
-const client_connection_state_1 = require("./client-connection-state");
+const ui_controller_client_connection_state_1 = require("./ui-controller-client-connection-state");
 const read_recording_response_stream_handler_1 = require("./read-recording-response-stream-handler");
-const client_error_1 = require("./client-error");
-class ControlYourUiClient {
-    constructor(controlServerUrl) {
-        this.controlServerUrl = controlServerUrl;
-        this.connectionState = client_connection_state_1.ClientConnectionState.NOT_CONNECTED;
-        this.currentReject = ControlYourUiClient.EMPTY_REJECT;
-        this.currentResolve = ControlYourUiClient.EMPTY_RESOLVE;
+const ui_control_client_error_1 = require("./ui-control-client-error");
+class UiControllerClient {
+    constructor(url) {
+        this.url = url;
+        this.connectionState = ui_controller_client_connection_state_1.UiControllerClientConnectionState.NOT_CONNECTED;
+        this.currentReject = UiControllerClient.EMPTY_REJECT;
+        this.currentResolve = UiControllerClient.EMPTY_RESOLVE;
     }
     clearResponse() {
-        this.currentReject = ControlYourUiClient.EMPTY_REJECT;
-        this.currentResolve = ControlYourUiClient.EMPTY_RESOLVE;
+        this.currentReject = UiControllerClient.EMPTY_REJECT;
+        this.currentResolve = UiControllerClient.EMPTY_RESOLVE;
     }
     onMessage(data) {
         clearTimeout(this.timeout);
@@ -36,24 +36,24 @@ class ControlYourUiClient {
         this.clearResponse();
     }
     connect() {
-        this.connectionState = client_connection_state_1.ClientConnectionState.CONNECTING;
+        this.connectionState = ui_controller_client_connection_state_1.UiControllerClientConnectionState.CONNECTING;
         return new Promise((resolve, reject) => {
             try {
-                this.ws = new ws_1.default(this.controlServerUrl);
+                this.ws = new ws_1.default(this.url);
                 this.ws.on('message', (data) => { this.onMessage(data); });
                 this.ws.on('open', () => {
-                    this.connectionState = client_connection_state_1.ClientConnectionState.CONNECTED;
+                    this.connectionState = ui_controller_client_connection_state_1.UiControllerClientConnectionState.CONNECTED;
                     resolve(this.connectionState);
                 });
                 this.ws.on('error', (error) => {
-                    this.connectionState = client_connection_state_1.ClientConnectionState.ERROR;
-                    reject(new client_error_1.ControlUiClientError(`Connection to Control UI Server cannot be established,
-          Probably it was not started. Makse sure you started the server with this 
-          Url ${this.controlServerUrl}. Error message  ${error.message}`));
+                    this.connectionState = ui_controller_client_connection_state_1.UiControllerClientConnectionState.ERROR;
+                    reject(new ui_control_client_error_1.UiControlClientError(`Connection to UI Controller cannot be established,
+          Probably it was not started. Makse sure you started UI Controller with this 
+          Url ${this.url}. Error message  ${error.message}`));
                 });
             }
             catch (error) {
-                reject(new client_error_1.ControlUiClientError(`Connection to Control UI Server cannot be established. Reason: ${error}`));
+                reject(new ui_control_client_error_1.UiControlClientError(`Connection to UI Controller cannot be established. Reason: ${error}`));
             }
         });
     }
@@ -61,21 +61,21 @@ class ControlYourUiClient {
         var _a;
         (_a = this.ws) === null || _a === void 0 ? void 0 : _a.close();
     }
-    sendAndReceive(msg, requestTimeout = ControlYourUiClient.REQUEST_TIMEOUT_IN_MS) {
+    sendAndReceive(msg, requestTimeout = UiControllerClient.REQUEST_TIMEOUT_IN_MS) {
         return new Promise((resolve, reject) => {
             this.currentResolve = resolve;
             this.currentReject = reject;
             try {
                 this.send(msg, requestTimeout);
-                this.timeout = setTimeout(() => this.currentReject(`Request to Control UI Server timed out.
-          it seems that the server is down, Please make sure the server is up`), ControlYourUiClient.REQUEST_TIMEOUT_IN_MS);
+                this.timeout = setTimeout(() => this.currentReject(`Request to UI Controller timed out.
+          It seems that the UI Controller is not running. Please, make sure that it is running when executing tests.`), UiControllerClient.REQUEST_TIMEOUT_IN_MS);
             }
             catch (error) {
-                this.currentReject(`The communication to the ControlUI Server is broken. Reason: ${error}`);
+                this.currentReject(`The communication to the UI Controller is broken. Reason: ${error}`);
             }
         });
     }
-    send(msg, _requestTimeout = ControlYourUiClient.REQUEST_TIMEOUT_IN_MS) {
+    send(msg, _requestTimeout = UiControllerClient.REQUEST_TIMEOUT_IN_MS) {
         if (!this.currentReject || !this.currentResolve) {
             throw Error('Request is not finished! It is not possible to have multiple requests at the same time.');
         }
@@ -113,7 +113,7 @@ class ControlYourUiClient {
         return this.sendAndReceive(new runner_protocol_1.ControlRequest(controlCommand));
     }
 }
-exports.ControlYourUiClient = ControlYourUiClient;
-ControlYourUiClient.EMPTY_REJECT = (_reason) => { };
-ControlYourUiClient.EMPTY_RESOLVE = (_value) => { };
-ControlYourUiClient.REQUEST_TIMEOUT_IN_MS = 30000;
+exports.UiControllerClient = UiControllerClient;
+UiControllerClient.EMPTY_REJECT = (_reason) => { };
+UiControllerClient.EMPTY_RESOLVE = (_value) => { };
+UiControllerClient.REQUEST_TIMEOUT_IN_MS = 30000;

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

@@ -16,9 +16,9 @@ var SupportedPlatform;
     SupportedPlatform["WIN32"] = "win32";
 })(SupportedPlatform || (SupportedPlatform = {}));
 const binarySubPathsByPlatform = {
-    linux: ['linux', 'controlui-server.AppImage'],
-    darwin: ['darwin', 'controlui-server.dmg'],
-    win32: ['windows', 'controlui-server.exe'],
+    linux: ['linux', 'askui-ui-controller.AppImage'],
+    darwin: ['darwin', 'askui-ui-controller.dmg'],
+    win32: ['windows', 'askui-ui-controller.exe'],
 };
 function isSupportedPlatform(value) {
     return Object.values(SupportedPlatform).includes(value);
@@ -32,14 +32,14 @@ function platform() {
 }
 exports.platform = platform;
 function buildBinaryNotAvailbleError(binaryVersion) {
-    return new Error(`It seems that the askui server binary version "${binaryVersion}" for your system "${platform()} ${os_1.default.arch}" is not availble, Please contact as at info@askui.com for more information`);
+    return new Error(`It seems that the UI Controller version "${binaryVersion}" for your system "${platform()} ${os_1.default.arch}" is not availble, Please contact as at info@askui.com for more information`);
 }
 function getBinaryPath(version) {
     return path_1.default.join(__dirname, '..', '..', 'release', version, ...binarySubPathsByPlatform[platform()]);
 }
 exports.getBinaryPath = getBinaryPath;
 function getBinaryDownloadUrl(binaryVersion) {
-    const baseUrl = `https://askui-public.s3.eu-central-1.amazonaws.com/releases/controlui-server/${binaryVersion}`;
+    const baseUrl = `https://askui-public.s3.eu-central-1.amazonaws.com/releases/askui-ui-controller/${binaryVersion}`;
     const arch = os_1.default.arch();
     return `${baseUrl}/${platform()}/${arch}/${binarySubPathsByPlatform[platform()][1]}`;
 }
@@ -48,7 +48,7 @@ function downloadServerBinaries(binaryVersion) {
         const url = getBinaryDownloadUrl(binaryVersion);
         const binaryOutputPath = getBinaryPath(binaryVersion);
         const binaryFolder = path_1.default.dirname(binaryOutputPath);
-        logger_1.logger.info(`Start downloading askui server binary version "${binaryVersion}"`);
+        logger_1.logger.info(`Start downloading UI Controller version "${binaryVersion}"`);
         if (!(fs_1.default.existsSync(binaryFolder))) {
             fs_1.default.mkdirSync(binaryFolder, { recursive: true });
         }
@@ -65,8 +65,8 @@ function downloadServerBinaries(binaryVersion) {
             reject(new Error('oops, an error during the downloaded occurred, try again with fresh install'));
         })
             .on('finish', () => {
-            logger_1.logger.info(`askui server binary version ${binaryVersion} for your system "${platform()} ${os_1.default.arch}" was downloaded`);
-            logger_1.logger.debug(`Binary of Control UI Server is located at "${binaryOutputPath}".`);
+            logger_1.logger.info(`UI Controller version ${binaryVersion} for your system "${platform()} ${os_1.default.arch}" was downloaded`);
+            logger_1.logger.debug(`Binary of UI Controller is located at "${binaryOutputPath}".`);
             resolve();
         });
         downloadStream.pipe(fileWriterStream);

package/dist/cjs/lib/index.d.ts

@@ -1,4 +1,4 @@
 export { UnkownError } from './unkown-error';
 export { TimeoutError } from './timeout-error';
-export { AskuiControlServer } from './askui-control-server';
+export { UiController } from './ui-controller';
 export { logger } from './logger';

package/dist/cjs/lib/index.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = exports.AskuiControlServer = exports.TimeoutError = exports.UnkownError = void 0;
+exports.logger = exports.UiController = exports.TimeoutError = exports.UnkownError = void 0;
 var unkown_error_1 = require("./unkown-error");
 Object.defineProperty(exports, "UnkownError", { enumerable: true, get: function () { return unkown_error_1.UnkownError; } });
 var timeout_error_1 = require("./timeout-error");
 Object.defineProperty(exports, "TimeoutError", { enumerable: true, get: function () { return timeout_error_1.TimeoutError; } });
-var askui_control_server_1 = require("./askui-control-server");
-Object.defineProperty(exports, "AskuiControlServer", { enumerable: true, get: function () { return askui_control_server_1.AskuiControlServer; } });
+var ui_controller_1 = require("./ui-controller");
+Object.defineProperty(exports, "UiController", { enumerable: true, get: function () { return ui_controller_1.UiController; } });
 var logger_1 = require("./logger");
 Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });

package/dist/cjs/lib/libfuse-error.d.ts

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

package/dist/cjs/lib/libfuse-error.js

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

package/dist/cjs/lib/logger.js

@@ -23,7 +23,7 @@ const stream = (0, pino_pretty_1.default)({
 const defaultLogLevel = 'info';
 const pinoLevel = isProcessEnvLogLevelValid() ? process.env['LOG_LEVEL'] : defaultLogLevel;
 const logger = (0, pino_1.default)({
-    name: 'askuiClient',
+    name: 'askuiUiControlClient',
     level: pinoLevel,
     customLevels: {
         verbose: 5,

package/dist/cjs/lib/timeout-error.d.ts

@@ -1,4 +1,2 @@
 export declare class TimeoutError extends Error {
-    contructorName: string;
-    constructor(message: string);
 }

package/dist/cjs/lib/timeout-error.js

@@ -2,10 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TimeoutError = void 0;
 class TimeoutError extends Error {
-    constructor(message) {
-        super(message);
-        this.contructorName = this.constructor.name;
-        this.name = this.contructorName;
-    }
 }
 exports.TimeoutError = TimeoutError;

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

@@ -0,0 +1,47 @@
+import { LogLevels } from '../shared/log-levels';
+/**
+ * Configuration options for the askui UI Controller
+ *
+ * @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'`
+ *  Choose the version of the askui UI Controller Server.
+ * @param {number} port - Default: `6769`
+ * The port the askui UI Controller is running on.
+ * @param {string} host - Default: `'127.0.0.1'`
+ * The host the askui UI Controller is running on.
+ * @param {boolean} minimize - Default: `true`
+ * askui UI Controller will be started as minimized window.
+ * @param {boolean} overWriteBinary - Default: `false`
+ * Download the provided Version of askui UI Controller.
+ * If a version is already downloaded. This version will be overwritten
+ * @param {LogLevels} logLevel - Default: `'debug'`
+ * You can use different types of Log Level.
+ * Options: "fatal", "error", "warn", "info", "debug", "trace", "silent", "verbose".
+ * @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.
+ */
+export interface UiControllerArgs {
+    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 UiControllerArgsWithDefaults extends UiControllerArgs {
+    readonly display: number;
+    readonly binaryVersion: string;
+    readonly overWriteBinary: boolean;
+    readonly port: number;
+    readonly host: string;
+    readonly logLevel?: LogLevels;
+}
+export declare function createArgsWithDefaults(args?: UiControllerArgs): UiControllerArgsWithDefaults;
+export declare function createCliFlagsFromArgs(args: UiControllerArgsWithDefaults): string[];

package/dist/cjs/lib/{control-ui-server-args.spec.js → ui-controller-args.spec.js}

@@ -1,23 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const control_ui_server_args_1 = require("./control-ui-server-args");
+const ui_controller_args_1 = require("./ui-controller-args");
 describe('createCliFlagsFromArgs()', () => {
     test('test createCliFlagsFromArgs should return -d 0 as default output', () => {
         const expected = ['-d 0', '-p 6769', '--host 127.0.0.1', '-m ', '--log-level debug'];
-        const argsWithDefaults = (0, control_ui_server_args_1.createArgsWithDefaults)();
-        const actual = (0, control_ui_server_args_1.createCliFlagsFromArgs)(argsWithDefaults);
+        const argsWithDefaults = (0, ui_controller_args_1.createArgsWithDefaults)();
+        const actual = (0, ui_controller_args_1.createCliFlagsFromArgs)(argsWithDefaults);
         expect(actual).toStrictEqual(expected);
     });
     test('test createCliFlagsFromArgs  output should include -d 0 when no display was selected', () => {
         const expected = ['-d 0', '-p 6777', '--host 0.0.0.0', '-m ', '--log-level debug'];
-        const argsWithDefaults = (0, control_ui_server_args_1.createArgsWithDefaults)({ port: 6777, host: '0.0.0.0' });
-        const actual = (0, control_ui_server_args_1.createCliFlagsFromArgs)(argsWithDefaults);
+        const argsWithDefaults = (0, ui_controller_args_1.createArgsWithDefaults)({ port: 6777, host: '0.0.0.0' });
+        const actual = (0, ui_controller_args_1.createCliFlagsFromArgs)(argsWithDefaults);
         expect(actual).toStrictEqual(expected);
     });
     test('test createCliFlagsFromArgs  output should include the display that was selected ', () => {
         const expected = ['-d 99', '-p 6777', '--host 0.0.0.0', '-m ', '--log-level debug'];
-        const argsWithDefaults = (0, control_ui_server_args_1.createArgsWithDefaults)({ port: 6777, host: '0.0.0.0', display: 99 });
-        const actual = (0, control_ui_server_args_1.createCliFlagsFromArgs)(argsWithDefaults);
+        const argsWithDefaults = (0, ui_controller_args_1.createArgsWithDefaults)({ port: 6777, host: '0.0.0.0', display: 99 });
+        const actual = (0, ui_controller_args_1.createCliFlagsFromArgs)(argsWithDefaults);
         expect(actual).toStrictEqual(expected);
     });
 });

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

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

package/dist/cjs/lib/{control-ui-server-darwin.js → ui-controller-darwin.js}

@@ -3,18 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlUiServerDarwin = void 0;
+exports.UiControllerDarwin = void 0;
 const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
-const control_ui_server_facade_1 = require("./control-ui-server-facade");
+const ui_controller_facade_1 = require("./ui-controller-facade");
 const logger_1 = require("./logger");
-class ControlUiServerDarwin extends control_ui_server_facade_1.ControlUiServerFacade {
+class UiControllerDarwin extends ui_controller_facade_1.UiControllerFacade {
     makeBinaryExecutable() {
         this.makeDiskImageExecutable();
     }
     getStartingCommand() {
-        return `${path_1.default.dirname(this.binaryPath)}/controlui-server.app/Contents/MacOS/controlui-server`;
+        return `"${path_1.default.dirname(this.binaryPath)}/controlui-server.app/Contents/MacOS/controlui-server"`;
     }
     makeDiskImageExecutable() {
         const mountPoint = '/Volumes/controlui-server.dmg';
@@ -24,15 +24,15 @@ class ControlUiServerDarwin extends control_ui_server_facade_1.ControlUiServerFa
             '-quiet',
             '-noautofsck',
             '-noautoopen',
-            `-mountpoint ${mountPoint}`,
-            this.binaryPath,
+            `-mountpoint "${mountPoint}"`,
+            `"${this.binaryPath}"`,
         ].join(' '));
         const appBaseName = 'controlui-server.app';
         const appSrcPath = `${mountPoint}/${appBaseName}`;
         const appDestPath = `${path_1.default.dirname(this.binaryPath)}/${appBaseName}`;
         fs_extra_1.default.removeSync(appDestPath);
         fs_extra_1.default.copySync(appSrcPath, appDestPath);
-        (0, child_process_1.exec)(`hdiutil detach ${mountPoint}`, (_exception, stdout) => logger_1.logger.debug(stdout));
+        (0, child_process_1.exec)(`hdiutil detach "${mountPoint}"`, (_exception, stdout) => logger_1.logger.debug(stdout));
     }
 }
-exports.ControlUiServerDarwin = ControlUiServerDarwin;
+exports.UiControllerDarwin = UiControllerDarwin;

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

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

package/dist/cjs/lib/{control-ui-server-facade.js → ui-controller-facade.js}

@@ -12,42 +12,43 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlUiServerFacade = void 0;
+exports.UiControllerFacade = void 0;
 const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const wait_port_1 = __importDefault(require("wait-port"));
 const fkill_1 = __importDefault(require("fkill"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
-const control_ui_server_args_1 = require("./control-ui-server-args");
+const ui_controller_args_1 = require("./ui-controller-args");
 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");
-class ControlUiServerFacade {
+class UiControllerFacade {
     constructor() {
         this.binaryPath = (0, download_binaries_1.getBinaryPath)('latest');
         this.DefaultmaxWaitingForStartingInMs = 30 * 1000;
     }
     start(args, maxWaitingForStartingInSeconds) {
         return __awaiter(this, void 0, void 0, function* () {
-            const argsWithDefaults = (0, control_ui_server_args_1.createArgsWithDefaults)(args);
+            yield this.runPreStartChecks();
+            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);
             this.makeBinaryExecutable();
-            logger_1.logger.debug(`AskuiServer log path "${this.serverLogFile}"`);
+            logger_1.logger.debug(`UI Controller log path "${this.serverLogFile}"`);
             yield this.startWithDefaults(argsWithLogPath, maxWaitingForStartingInSeconds);
         });
     }
     stop(args, forceStop) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const argsWithDefaults = (0, control_ui_server_args_1.createArgsWithDefaults)(args);
+                const argsWithDefaults = (0, ui_controller_args_1.createArgsWithDefaults)(args);
                 yield this.killPort(argsWithDefaults.port, forceStop);
             }
             catch (err) {
-                throw new Error(`An unknown error occured while closing of the askui server. Log file: "${this.serverLogFile}". ErrorReason: ${err}`);
+                throw new Error(`An unknown error occured while closing of the UI Controller. Log file: "${this.serverLogFile}". ErrorReason: ${err}`);
             }
         });
     }
@@ -57,7 +58,7 @@ class ControlUiServerFacade {
             return args;
         }
         const tmpDir = fs_extra_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), 'askui'));
-        this.serverLogFile = path_1.default.join(tmpDir, 'askui-server.log');
+        this.serverLogFile = path_1.default.join(tmpDir, 'askui-ui-controller.log');
         const argPath = { logFilePath: this.serverLogFile };
         return Object.assign(argPath, args);
     }
@@ -69,13 +70,17 @@ class ControlUiServerFacade {
         });
     }
     getStartingCommand() {
-        return this.binaryPath;
+        return `"${this.binaryPath}"`;
     }
     // eslint-disable-next-line class-methods-use-this
     makeBinaryExecutable() {
         /* Executable out of the box */
     }
     // eslint-disable-next-line class-methods-use-this
+    runPreStartChecks() {
+        return Promise.resolve();
+    }
+    // eslint-disable-next-line class-methods-use-this
     waitUntilStarted(args, maxWaitingForStartingInSeconds) {
         return new Promise((resolve, reject) => {
             try {
@@ -95,7 +100,7 @@ class ControlUiServerFacade {
                 });
             }
             catch (err) {
-                reject(new unkown_error_1.UnkownError(`An unknown error occured while waiting for the askui server: ${err}`));
+                reject(new unkown_error_1.UnkownError(`An unknown error occured while waiting for the UI Controller: ${err}`));
             }
         });
     }
@@ -107,25 +112,26 @@ class ControlUiServerFacade {
     getBinary(binaryVersion, overWriteBinary = false) {
         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 Control UI Server is available at "${this.binaryPath}"`);
+                logger_1.logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryPath}"`);
                 yield (0, download_binaries_1.downloadServerBinaries)(binaryVersion);
             }
             else {
-                logger_1.logger.debug(`Binary of Control UI Server is already present at "${this.binaryPath}".`);
+                logger_1.logger.debug(`Binary of UI Controller is already present at "${this.binaryPath}".`);
             }
         });
     }
     startWithDefaults(args, maxWaitingForStartingInSeconds) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                logger_1.logger.debug('Starting the Control UI Server...');
-                (0, child_process_1.spawn)(this.getStartingCommand(), (0, control_ui_server_args_1.createCliFlagsFromArgs)(args), { shell: true });
+                logger_1.logger.debug('Starting the UI Controller...');
+                (0, child_process_1.spawn)(this.getStartingCommand(), (0, ui_controller_args_1.createCliFlagsFromArgs)(args), { shell: true });
                 yield this.waitUntilStarted(args, maxWaitingForStartingInSeconds);
             }
             catch (err) {
-                throw new Error(`The Control UI Server could not be started. Log file :  ${this.serverLogFile}. ErrorReason: ${err}`);
+                throw new Error(`The UI Controller could not be started. Log file :  ${this.serverLogFile}. ErrorReason: ${err}
+      Check this website for more information: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller-starting-problems`);
             }
         });
     }
 }
-exports.ControlUiServerFacade = ControlUiServerFacade;
+exports.UiControllerFacade = UiControllerFacade;

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

@@ -0,0 +1,5 @@
+import { UiControllerFacade } from './ui-controller-facade';
+export declare class UiControllerLinux extends UiControllerFacade {
+    protected makeBinaryExecutable(): void;
+    protected runPreStartChecks(): Promise<void>;
+}

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

@@ -0,0 +1,52 @@
+"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.UiControllerLinux = void 0;
+const child_process_1 = require("child_process");
+const util_1 = require("util");
+const ui_controller_facade_1 = require("./ui-controller-facade");
+const logger_1 = require("./logger");
+const wayland_error_1 = require("./wayland-error");
+const libfuse_error_1 = require("./libfuse-error");
+class UiControllerLinux extends ui_controller_facade_1.UiControllerFacade {
+    // 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));
+    }
+    // eslint-disable-next-line class-methods-use-this
+    runPreStartChecks() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const runCommand = (0, util_1.promisify)(child_process_1.exec);
+            const waylandStatus = yield runCommand('echo $WAYLAND_DISPLAY');
+            if (waylandStatus.stdout.trim().includes('wayland')) {
+                throw new wayland_error_1.WaylandError('Wayland is not supported: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller-starting-problems#wayland');
+            }
+            /* First we want to check if the user is using a debian distribution.
+            * and in the following if libfuse2 is installed.
+            * With Ubunutu 22.04 libfuse2 is not installed per default.
+            * For more information: https://discourse.joplinapp.org/t/appimage-incompatibility-in-ubuntu-22-04/25173
+            */
+            try {
+                yield runCommand('dpkg --version');
+            }
+            catch (err) {
+                return;
+            }
+            try {
+                yield runCommand('dpkg -s libfuse2 | grep Status');
+            }
+            catch (_a) {
+                throw new libfuse_error_1.LibfuseError('Libfuse2 package is missing: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller-starting-problems#libfuse2');
+            }
+        });
+    }
+}
+exports.UiControllerLinux = UiControllerLinux;

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

@@ -0,0 +1,3 @@
+import { UiControllerFacade } from './ui-controller-facade';
+export declare class UiControllerWin32 extends UiControllerFacade {
+}

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiControllerWin32 = void 0;
+const ui_controller_facade_1 = require("./ui-controller-facade");
+class UiControllerWin32 extends ui_controller_facade_1.UiControllerFacade {
+}
+exports.UiControllerWin32 = UiControllerWin32;

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

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