askui 0.1.6 → 0.2.2

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

@@ -1,19 +1,19 @@
 import WebSocket from 'ws';
 import { CaptureScreenshotRequest, ControlRequest, StartRecordingRequest, StopRecordingRequest, ReadRecordingRequest, InteractiveAnnotationRequest, GetProcessPidRequest, } from '../core/runner-protocol';
 import { logger } from '../lib/logger';
-import { ClientConnectionState } from './client-connection-state';
+import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
 import { ReadRecordingResponseStreamHandler } from './read-recording-response-stream-handler';
-import { ControlUiClientError } from './client-error';
-export class ControlYourUiClient {
-    constructor(controlServerUrl) {
-        this.controlServerUrl = controlServerUrl;
-        this.connectionState = ClientConnectionState.NOT_CONNECTED;
-        this.currentReject = ControlYourUiClient.EMPTY_REJECT;
-        this.currentResolve = ControlYourUiClient.EMPTY_RESOLVE;
+import { UiControlClientError } from './ui-control-client-error';
+export class UiControllerClient {
+    constructor(url) {
+        this.url = url;
+        this.connectionState = 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);
@@ -30,24 +30,24 @@ export class ControlYourUiClient {
         this.clearResponse();
     }
     connect() {
-        this.connectionState = ClientConnectionState.CONNECTING;
+        this.connectionState = UiControllerClientConnectionState.CONNECTING;
         return new Promise((resolve, reject) => {
             try {
-                this.ws = new WebSocket(this.controlServerUrl);
+                this.ws = new WebSocket(this.url);
                 this.ws.on('message', (data) => { this.onMessage(data); });
                 this.ws.on('open', () => {
-                    this.connectionState = ClientConnectionState.CONNECTED;
+                    this.connectionState = UiControllerClientConnectionState.CONNECTED;
                     resolve(this.connectionState);
                 });
                 this.ws.on('error', (error) => {
-                    this.connectionState = ClientConnectionState.ERROR;
-                    reject(new 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 = UiControllerClientConnectionState.ERROR;
+                    reject(new 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 ControlUiClientError(`Connection to Control UI Server cannot be established. Reason: ${error}`));
+                reject(new UiControlClientError(`Connection to UI Controller cannot be established. Reason: ${error}`));
             }
         });
     }
@@ -55,21 +55,21 @@ export 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.');
         }
@@ -107,6 +107,6 @@ export class ControlYourUiClient {
         return this.sendAndReceive(new ControlRequest(controlCommand));
     }
 }
-ControlYourUiClient.EMPTY_REJECT = (_reason) => { };
-ControlYourUiClient.EMPTY_RESOLVE = (_value) => { };
-ControlYourUiClient.REQUEST_TIMEOUT_IN_MS = 30000;
+UiControllerClient.EMPTY_REJECT = (_reason) => { };
+UiControllerClient.EMPTY_RESOLVE = (_value) => { };
+UiControllerClient.REQUEST_TIMEOUT_IN_MS = 30000;

package/dist/esm/lib/copy-example-project.js

@@ -1,6 +1,7 @@
 import { Command } from 'commander';
 import path from 'path';
 import fs from 'fs-extra';
+import { getPathToNodeModulesRoot } from '../utils/path';
 const createProgram = () => {
     const program = new Command('askui');
     program.usage('<command> [options]');
@@ -8,7 +9,7 @@ const createProgram = () => {
 };
 function copyExampleProject() {
     const exampleProjectPath = path.join('example_projects_templates', 'typescript_jest');
-    fs.copySync(path.join(__dirname, '..', '..', exampleProjectPath), '.');
+    fs.copySync(path.join(getPathToNodeModulesRoot(), exampleProjectPath), '.');
 }
 export function init(argv) {
     const args = argv || process.argv;

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

@@ -2,6 +2,7 @@ import fs from 'fs';
 import got from 'got';
 import os from 'os';
 import path from 'path';
+import { getPathToNodeModulesRoot } from '../utils/path';
 import { logger } from './logger';
 var SupportedPlatform;
 (function (SupportedPlatform) {
@@ -10,9 +11,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);
@@ -25,13 +26,13 @@ export function platform() {
     throw new Error(`Platform "${pf}" is not supported.`);
 }
 function buildBinaryNotAvailbleError(binaryVersion) {
-    return new Error(`It seems that the askui server binary version "${binaryVersion}" for your system "${platform()} ${os.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.arch}" is not availble, Please contact as at info@askui.com for more information`);
 }
 export function getBinaryPath(version) {
-    return path.join(__dirname, '..', '..', 'release', version, ...binarySubPathsByPlatform[platform()]);
+    return path.join(getPathToNodeModulesRoot(), 'release', version, ...binarySubPathsByPlatform[platform()]);
 }
 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.arch();
     return `${baseUrl}/${platform()}/${arch}/${binarySubPathsByPlatform[platform()][1]}`;
 }
@@ -40,7 +41,7 @@ export function downloadServerBinaries(binaryVersion) {
         const url = getBinaryDownloadUrl(binaryVersion);
         const binaryOutputPath = getBinaryPath(binaryVersion);
         const binaryFolder = path.dirname(binaryOutputPath);
-        logger.info(`Start downloading askui server binary version "${binaryVersion}"`);
+        logger.info(`Start downloading UI Controller version "${binaryVersion}"`);
         if (!(fs.existsSync(binaryFolder))) {
             fs.mkdirSync(binaryFolder, { recursive: true });
         }
@@ -57,8 +58,8 @@ export function downloadServerBinaries(binaryVersion) {
             reject(new Error('oops, an error during the downloaded occurred, try again with fresh install'));
         })
             .on('finish', () => {
-            logger.info(`askui server binary version ${binaryVersion} for your system "${platform()} ${os.arch}" was downloaded`);
-            logger.debug(`Binary of Control UI Server is located at "${binaryOutputPath}".`);
+            logger.info(`UI Controller version ${binaryVersion} for your system "${platform()} ${os.arch}" was downloaded`);
+            logger.debug(`Binary of UI Controller is located at "${binaryOutputPath}".`);
             resolve();
         });
         downloadStream.pipe(fileWriterStream);

package/dist/esm/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/esm/lib/index.js

@@ -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/esm/lib/libfuse-error.d.ts

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

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

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

package/dist/esm/lib/logger.js

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

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

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

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

@@ -1,7 +1,2 @@
 export class TimeoutError extends Error {
-    constructor(message) {
-        super(message);
-        this.contructorName = this.constructor.name;
-        this.name = this.contructorName;
-    }
 }

package/dist/esm/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/esm/lib/{control-ui-server-args.spec.js → ui-controller-args.spec.js}

@@ -1,4 +1,4 @@
-import { createArgsWithDefaults, createCliFlagsFromArgs } from './control-ui-server-args';
+import { createArgsWithDefaults, createCliFlagsFromArgs } from './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'];

package/dist/esm/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/esm/lib/{control-ui-server-darwin.js → ui-controller-darwin.js}

@@ -1,14 +1,14 @@
 import { exec, execSync } from 'child_process';
 import fs from 'fs-extra';
 import path from 'path';
-import { ControlUiServerFacade } from './control-ui-server-facade';
+import { UiControllerFacade } from './ui-controller-facade';
 import { logger } from './logger';
-export class ControlUiServerDarwin extends ControlUiServerFacade {
+export class UiControllerDarwin extends UiControllerFacade {
     makeBinaryExecutable() {
         this.makeDiskImageExecutable();
     }
     getStartingCommand() {
-        return `${path.dirname(this.binaryPath)}/controlui-server.app/Contents/MacOS/controlui-server`;
+        return `"${path.dirname(this.binaryPath)}/controlui-server.app/Contents/MacOS/controlui-server"`;
     }
     makeDiskImageExecutable() {
         const mountPoint = '/Volumes/controlui-server.dmg';
@@ -18,14 +18,14 @@ export class ControlUiServerDarwin extends ControlUiServerFacade {
             '-quiet',
             '-noautofsck',
             '-noautoopen',
-            `-mountpoint ${mountPoint}`,
-            this.binaryPath,
+            `-mountpoint "${mountPoint}"`,
+            `"${this.binaryPath}"`,
         ].join(' '));
         const appBaseName = 'controlui-server.app';
         const appSrcPath = `${mountPoint}/${appBaseName}`;
         const appDestPath = `${path.dirname(this.binaryPath)}/${appBaseName}`;
         fs.removeSync(appDestPath);
         fs.copySync(appSrcPath, appDestPath);
-        exec(`hdiutil detach ${mountPoint}`, (_exception, stdout) => logger.debug(stdout));
+        exec(`hdiutil detach "${mountPoint}"`, (_exception, stdout) => logger.debug(stdout));
     }
 }

package/dist/esm/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/esm/lib/{control-ui-server-facade.js → ui-controller-facade.js}

@@ -13,24 +13,25 @@ import waitPort from 'wait-port';
 import fkill from 'fkill';
 import os from 'os';
 import path from 'path';
-import { createArgsWithDefaults, createCliFlagsFromArgs, } from './control-ui-server-args';
+import { createArgsWithDefaults, createCliFlagsFromArgs, } from './ui-controller-args';
 import { downloadServerBinaries, getBinaryPath } from './download-binaries';
 import { logger } from './logger';
 import { TimeoutError } from './timeout-error';
 import { UnkownError } from './unkown-error';
-export class ControlUiServerFacade {
+export class UiControllerFacade {
     constructor() {
         this.binaryPath = getBinaryPath('latest');
         this.DefaultmaxWaitingForStartingInMs = 30 * 1000;
     }
     start(args, maxWaitingForStartingInSeconds) {
         return __awaiter(this, void 0, void 0, function* () {
+            yield this.runPreStartChecks();
             const argsWithDefaults = createArgsWithDefaults(args);
             const argsWithLogPath = this.serverLogFilePath(argsWithDefaults);
             this.binaryPath = getBinaryPath(argsWithLogPath.binaryVersion);
             yield this.getBinary(argsWithLogPath.binaryVersion, argsWithLogPath.overWriteBinary);
             this.makeBinaryExecutable();
-            logger.debug(`AskuiServer log path "${this.serverLogFile}"`);
+            logger.debug(`UI Controller log path "${this.serverLogFile}"`);
             yield this.startWithDefaults(argsWithLogPath, maxWaitingForStartingInSeconds);
         });
     }
@@ -41,7 +42,7 @@ export class ControlUiServerFacade {
                 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}`);
             }
         });
     }
@@ -51,7 +52,7 @@ export class ControlUiServerFacade {
             return args;
         }
         const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'askui'));
-        this.serverLogFile = path.join(tmpDir, 'askui-server.log');
+        this.serverLogFile = path.join(tmpDir, 'askui-ui-controller.log');
         const argPath = { logFilePath: this.serverLogFile };
         return Object.assign(argPath, args);
     }
@@ -63,13 +64,17 @@ export 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 {
@@ -89,7 +94,7 @@ export class ControlUiServerFacade {
                 });
             }
             catch (err) {
-                reject(new UnkownError(`An unknown error occured while waiting for the askui server: ${err}`));
+                reject(new UnkownError(`An unknown error occured while waiting for the UI Controller: ${err}`));
             }
         });
     }
@@ -101,23 +106,24 @@ export class ControlUiServerFacade {
     getBinary(binaryVersion, overWriteBinary = false) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!fs.existsSync(this.binaryPath) || overWriteBinary || !this.isBinaryValid()) {
-                logger.debug(`Currently, no binary of the Control UI Server is available at "${this.binaryPath}"`);
+                logger.debug(`Currently, no binary of the UI Controller is available at "${this.binaryPath}"`);
                 yield downloadServerBinaries(binaryVersion);
             }
             else {
-                logger.debug(`Binary of Control UI Server is already present at "${this.binaryPath}".`);
+                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.debug('Starting the Control UI Server...');
+                logger.debug('Starting the UI Controller...');
                 spawn(this.getStartingCommand(), 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`);
             }
         });
     }

package/dist/esm/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/esm/lib/ui-controller-linux.js

@@ -0,0 +1,48 @@
+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 { exec } from 'child_process';
+import { promisify } from 'util';
+import { UiControllerFacade } from './ui-controller-facade';
+import { logger } from './logger';
+import { WaylandError } from './wayland-error';
+import { LibfuseError } from './libfuse-error';
+export class UiControllerLinux extends UiControllerFacade {
+    // eslint-disable-next-line class-methods-use-this
+    makeBinaryExecutable() {
+        exec(`chmod +x "${this.binaryPath}"`, (_exception, stdout) => logger.debug(stdout));
+    }
+    // eslint-disable-next-line class-methods-use-this
+    runPreStartChecks() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const runCommand = promisify(exec);
+            const waylandStatus = yield runCommand('echo $WAYLAND_DISPLAY');
+            if (waylandStatus.stdout.trim().includes('wayland')) {
+                throw new WaylandError('Wayland is not supported: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller#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 LibfuseError('Libfuse2 package is missing: https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller#libfuse2');
+            }
+        });
+    }
+}

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

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

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

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

package/dist/esm/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>;
+}

package/dist/esm/lib/{askui-control-server.js → ui-controller.js}

@@ -7,22 +7,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { ControlUiServerDarwin } from './control-ui-server-darwin';
-import { ControlUiServerLinux } from './control-ui-server-linux';
-import { ControlUiServerWin32 } from './control-ui-server-win32';
+import { UiControllerDarwin } from './ui-controller-darwin';
+import { UiControllerLinux } from './ui-controller-linux';
+import { UiControllerWin32 } from './ui-controller-win32';
 import { platform } from './download-binaries';
-export class AskuiControlServer {
+export class UiController {
     constructor(args) {
         this.args = args;
         switch (platform()) {
             case 'darwin':
-                this.server = new ControlUiServerDarwin();
+                this.server = new UiControllerDarwin();
                 break;
             case 'linux':
-                this.server = new ControlUiServerLinux();
+                this.server = new UiControllerLinux();
                 break;
             case 'win32':
-                this.server = new ControlUiServerWin32();
+                this.server = new UiControllerWin32();
                 break;
             default:
                 throw new Error(`Platform "${platform()}" not supported.`);

package/dist/esm/lib/unkown-error.d.ts

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

package/dist/esm/lib/unkown-error.js

@@ -1,7 +1,2 @@
 export class UnkownError extends Error {
-    constructor(message) {
-        super(message);
-        this.contructorName = this.constructor.name;
-        this.name = this.contructorName;
-    }
 }

package/dist/esm/lib/wayland-error.d.ts

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

package/dist/esm/lib/wayland-error.js

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

package/dist/esm/main.d.ts

@@ -1,2 +1,3 @@
-export { AskuiControlServer } from './lib';
-export { AskuiClient } from './execution';
+export { UiController } from './lib';
+export { UiControlClient, AnnotationLevel } from './execution';
+export { LogLevels } from './shared';

package/dist/esm/main.js

@@ -1,2 +1,3 @@
-export { AskuiControlServer } from './lib';
-export { AskuiClient } from './execution';
+export { UiController } from './lib';
+export { UiControlClient, AnnotationLevel } from './execution';
+export { LogLevels } from './shared';

package/dist/esm/shared/index.d.ts

@@ -0,0 +1 @@
+export { LogLevels } from './log-levels';

package/dist/esm/shared/index.js

@@ -0,0 +1 @@
+export { LogLevels } from './log-levels';

package/dist/esm/utils/analytics/analytics-interface.d.ts

@@ -0,0 +1,3 @@
+export interface AnalyticsInterface {
+    getAnalyticsHeaders(): Promise<Record<string, string>>;
+}

package/dist/esm/utils/analytics/analytics-interface.js

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

package/dist/esm/utils/analytics/analytics.d.ts

@@ -0,0 +1,5 @@
+import { AnalyticsInterface } from './analytics-interface';
+export declare class Analytics implements AnalyticsInterface {
+    private userIdentifier;
+    getAnalyticsHeaders(): Promise<Record<string, string>>;
+}