askui 0.2.2 → 0.2.3

package/README.md

@@ -45,8 +45,8 @@ Visit our [documentation](https://docs.askui.com) for examples and a full list o
 ### Notes
 
 Important note for Linux users: Currently, Wayland is not supported.
-You can read more in our [troubleshooting chapter](https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller#wayland).
-If you want to use the askui library libfuse2 is needed ([libfuse2 installation](https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller#libfuse2)).
+You can read more in our [troubleshooting chapter](https://docs.askui.com/docs/general/Troubleshooting/linux#wayland).
+If you want to use the askui library libfuse2 is needed ([libfuse2 installation](https://docs.askui.com/docs/general/Troubleshooting/linux#libfuse2)).
 
 ## Example
 

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

@@ -426,6 +426,15 @@ export declare class FluentFilters extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelations}
      */
     icon(): FluentFiltersOrRelations;
@@ -461,6 +470,22 @@ export declare class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     withText(text: string): FluentFiltersOrRelations;
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    withTextRegex(regex_pattern: string): FluentFiltersOrRelations;
     /**
      * Filters for equal text.
      *
@@ -1060,6 +1085,15 @@ export declare class FluentFiltersCondition extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     icon(): FluentFiltersOrRelationsCondition;
@@ -1095,6 +1129,22 @@ export declare class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     withText(text: string): FluentFiltersOrRelationsCondition;
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    withTextRegex(regex_pattern: string): FluentFiltersOrRelationsCondition;
     /**
      * Filters for equal text.
      *
@@ -1331,7 +1381,7 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     typeIn(text: string): FluentFilters;
     /**
-     * Moves mouse to the filtered element and scrolls in the x and y direction
+     * Moves mouse to the filtered element and scrolls in the x and y direction.
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.

package/dist/cjs/execution/dsl.js

@@ -2,6 +2,7 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
 /* eslint-disable @typescript-eslint/naming-convention */
 /* eslint-disable max-classes-per-file */
+/* eslint-disable max-len */
 // Autogenerated from typescript.template file
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FluentCommand = exports.FluentFiltersOrRelationsCondition = exports.FluentFiltersCondition = exports.FluentFiltersOrRelations = exports.FluentFilters = exports.Exec = void 0;
@@ -650,6 +651,15 @@ class FluentFilters extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelations}
      */
     icon() {
@@ -695,7 +705,26 @@ class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     withText(text) {
-        this._textStr = `with text "${text}"`;
+        this._textStr = `with text <|string|>${text}<|string|>`;
+        return new FluentFiltersOrRelations(this);
+    }
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    withTextRegex(regex_pattern) {
+        this._textStr = `match regex pattern <|string|>${regex_pattern}<|string|>`;
         return new FluentFiltersOrRelations(this);
     }
     /**
@@ -717,7 +746,7 @@ class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     withExactText(text) {
-        this._textStr = `equals text "${text}"`;
+        this._textStr = `equals text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelations(this);
     }
     /**
@@ -735,7 +764,7 @@ class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     containsText(text) {
-        this._textStr = `contain text "${text}"`;
+        this._textStr = `contain text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelations(this);
     }
     /**
@@ -1534,6 +1563,15 @@ class FluentFiltersCondition extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     icon() {
@@ -1579,7 +1617,26 @@ class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     withText(text) {
-        this._textStr = `with text "${text}"`;
+        this._textStr = `with text <|string|>${text}<|string|>`;
+        return new FluentFiltersOrRelationsCondition(this);
+    }
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    withTextRegex(regex_pattern) {
+        this._textStr = `match regex pattern <|string|>${regex_pattern}<|string|>`;
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
@@ -1601,7 +1658,7 @@ class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     withExactText(text) {
-        this._textStr = `equals text "${text}"`;
+        this._textStr = `equals text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
@@ -1619,7 +1676,7 @@ class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     containsText(text) {
-        this._textStr = `contain text "${text}"`;
+        this._textStr = `contain text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
@@ -1868,11 +1925,11 @@ class FluentCommand extends FluentBase {
      * @return {FluentFilters}
      */
     typeIn(text) {
-        this._textStr = `Type "${text}" in`;
+        this._textStr = `Type <|string|>${text}<|string|> in`;
         return new FluentFilters(this);
     }
     /**
-     * Moves mouse to the filtered element and scrolls in the x and y direction
+     * Moves mouse to the filtered element and scrolls in the x and y direction.
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
@@ -1916,7 +1973,7 @@ class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     type(text) {
-        this._textStr = `Type "${text}"`;
+        this._textStr = `Type <|string|>${text}<|string|>`;
         return new Exec(this);
     }
     /**
@@ -1965,7 +2022,7 @@ class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     execOnShell(shell_command) {
-        this._textStr = `Execute shell command "${shell_command}"`;
+        this._textStr = `Execute shell command <|string|>${shell_command}<|string|>`;
         return new Exec(this);
     }
     /**

package/dist/cjs/execution/read-environment-credentials.js

@@ -4,12 +4,12 @@ exports.envCredentials = void 0;
 const lib_1 = require("../lib");
 function envCredentials() {
     const envToken = process.env['ASKUI_TOKEN'];
-    const envTenant = process.env['ASKUI_TENANT'];
+    const envWorkspaceId = process.env['ASKUI_WORKSPACE_ID'];
     const envEmail = process.env['ASKUI_EMAIL'];
-    if (envToken && envTenant && envEmail) {
-        lib_1.logger.info('Credentials are used from ENV variables: ASKUI_TOKEN, ASKUI_TENANT and ASKUI_EMAIL');
+    if (envToken && envWorkspaceId && envEmail) {
+        lib_1.logger.info('Credentials are used from ENV variables: ASKUI_TOKEN, ASKUI_WORKSPACE_ID and ASKUI_EMAIL');
         return {
-            tenant: envTenant,
+            workspaceId: envWorkspaceId,
             email: envEmail,
             token: envToken,
         };

package/dist/cjs/execution/read-environment-credentials.spec.js

@@ -4,9 +4,9 @@ const read_environment_credentials_1 = require("./read-environment-credentials")
 describe('envCredentials()', () => {
     test('should read the credentials from the environment variables', () => {
         process.env['ASKUI_TOKEN'] = 'token';
-        process.env['ASKUI_TENANT'] = 'tenant';
+        process.env['ASKUI_WORKSPACE_ID'] = 'id123';
         process.env['ASKUI_EMAIL'] = 'name@tenant.com';
         const credentialsFromTheEnv = (0, read_environment_credentials_1.envCredentials)();
-        expect(credentialsFromTheEnv).toStrictEqual({ tenant: 'tenant', email: 'name@tenant.com', token: 'token' });
+        expect(credentialsFromTheEnv).toStrictEqual({ workspaceId: 'id123', email: 'name@tenant.com', token: 'token' });
     });
 });

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

@@ -23,7 +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 getClientArgsWithDefaults = (clientArgs = {}) => (Object.assign({ uiControllerUrl: 'http://localhost:6769', inferenceServerUrl: 'https://inference.askui.com', annotationLevel: annotation_level_1.AnnotationLevel.DISABLED }, clientArgs));
+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.FluentCommand {
     constructor(httpClient, clientArgs) {
         super();

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

@@ -3,7 +3,7 @@ import { AnnotationLevel } from './annotation-level';
 /**
  * Configuration options for the askui UI Control Client
  *
- * @param {string} uiControllerUrl - Default: http://localhost:6769
+ * @param {string} uiControllerUrl - Default: http://127.0.0.1:6769
  * The adress of the askui UI Controller server.
  * @param {string} inferenceClientUrl - Default: https://inference.askui.com`
  * Address of the askui Inference server.

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

@@ -129,7 +129,7 @@ class UiControllerFacade {
             }
             catch (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`);
+      Check this website for more information: https://docs.askui.com/docs/general/Troubleshooting`);
             }
         });
     }

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

@@ -27,7 +27,7 @@ class UiControllerLinux extends ui_controller_facade_1.UiControllerFacade {
             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#wayland');
+                throw new wayland_error_1.WaylandError('Wayland is not supported: https://docs.askui.com/docs/general/Troubleshooting/linux#wayland');
             }
             /* First we want to check if the user is using a debian distribution.
             * and in the following if libfuse2 is installed.
@@ -44,7 +44,7 @@ class UiControllerLinux extends ui_controller_facade_1.UiControllerFacade {
                 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#libfuse2');
+                throw new libfuse_error_1.LibfuseError('Libfuse2 package is missing: https://docs.askui.com/docs/general/Troubleshooting/linux#libfuse2');
             }
         });
     }

package/dist/cjs/utils/http/credentials.d.ts

@@ -1,5 +1,5 @@
 export interface CredentialArgs {
-    tenant: string;
+    workspaceId: string;
     email: string;
     token: string;
 }

package/dist/cjs/utils/http/credentials.js

@@ -12,7 +12,7 @@ class Credentials {
         return Buffer.from(`${this.userName}:${this.credentials.token}`);
     }
     get userName() {
-        return `${this.credentials.tenant}|${this.credentials.email}`;
+        return `${this.credentials.workspaceId}|${this.credentials.email}`;
     }
 }
 exports.Credentials = Credentials;

package/dist/cjs/utils/http/credentials.spec.js

@@ -4,8 +4,8 @@ const credentials_1 = require("./credentials");
 describe('Credentials', () => {
     describe('base64Encoded()', () => {
         test('should return base64-encoded credentials', () => {
-            const credentials = new credentials_1.Credentials({ tenant: 'tenant', email: 'name@tenant.com', token: 'password' });
-            expect(credentials.base64Encoded).toBe('dGVuYW50fG5hbWVAdGVuYW50LmNvbTpwYXNzd29yZA==');
+            const credentials = new credentials_1.Credentials({ workspaceId: 'id123', email: 'name@tenant.com', token: 'password' });
+            expect(credentials.base64Encoded).toBe('aWQxMjN8bmFtZUB0ZW5hbnQuY29tOnBhc3N3b3Jk');
         });
     });
 });

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

@@ -426,6 +426,15 @@ export declare class FluentFilters extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelations}
      */
     icon(): FluentFiltersOrRelations;
@@ -461,6 +470,22 @@ export declare class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     withText(text: string): FluentFiltersOrRelations;
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    withTextRegex(regex_pattern: string): FluentFiltersOrRelations;
     /**
      * Filters for equal text.
      *
@@ -1060,6 +1085,15 @@ export declare class FluentFiltersCondition extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     icon(): FluentFiltersOrRelationsCondition;
@@ -1095,6 +1129,22 @@ export declare class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     withText(text: string): FluentFiltersOrRelationsCondition;
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    withTextRegex(regex_pattern: string): FluentFiltersOrRelationsCondition;
     /**
      * Filters for equal text.
      *
@@ -1331,7 +1381,7 @@ export declare abstract class FluentCommand extends FluentBase {
      */
     typeIn(text: string): FluentFilters;
     /**
-     * Moves mouse to the filtered element and scrolls in the x and y direction
+     * Moves mouse to the filtered element and scrolls in the x and y direction.
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.

package/dist/esm/execution/dsl.js

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
 /* eslint-disable @typescript-eslint/naming-convention */
 /* eslint-disable max-classes-per-file */
+/* eslint-disable max-len */
 // Autogenerated from typescript.template file
 class FluentBase {
     constructor(prev) {
@@ -646,6 +647,15 @@ export class FluentFilters extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelations}
      */
     icon() {
@@ -691,7 +701,26 @@ export class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     withText(text) {
-        this._textStr = `with text "${text}"`;
+        this._textStr = `with text <|string|>${text}<|string|>`;
+        return new FluentFiltersOrRelations(this);
+    }
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelations}
+     */
+    withTextRegex(regex_pattern) {
+        this._textStr = `match regex pattern <|string|>${regex_pattern}<|string|>`;
         return new FluentFiltersOrRelations(this);
     }
     /**
@@ -713,7 +742,7 @@ export class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     withExactText(text) {
-        this._textStr = `equals text "${text}"`;
+        this._textStr = `equals text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelations(this);
     }
     /**
@@ -731,7 +760,7 @@ export class FluentFilters extends FluentBase {
      * @return {FluentFiltersOrRelations}
      */
     containsText(text) {
-        this._textStr = `contain text "${text}"`;
+        this._textStr = `contain text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelations(this);
     }
     /**
@@ -1528,6 +1557,15 @@ export class FluentFiltersCondition extends FluentBase {
     /**
      * Filters for an UI element 'icon'.
      *
+     * You can combine it with the 'withText' command to look for a specific icon.
+     *
+     * **Examples:**
+     * ```typescript
+     * icon().withText('plus')
+     * ```
+     *
+     * Note: This is an alpha feature. The prediction of the icon name is sometimes unstable. Use custom elements as an alternative.
+     *
      * @return {FluentFiltersOrRelationsCondition}
      */
     icon() {
@@ -1573,7 +1611,26 @@ export class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     withText(text) {
-        this._textStr = `with text "${text}"`;
+        this._textStr = `with text <|string|>${text}<|string|>`;
+        return new FluentFiltersOrRelationsCondition(this);
+    }
+    /**
+     * Filters for texts, which match the regex pattern.
+     *
+     * **Examples:**
+     *
+     * ```typescript
+     * 'The rain in Spain' === withTextRegex('\b[Ss]\w+') => true
+     * 'The rain in Portugal' === withTextRegex('\b[Ss]\w+') => false
+     * 'The rain in switzerland' === withTextRegex('\b[Ss]\w+') => true
+     * ```
+     *
+     * @param {string} regex_pattern - An regex pattern
+     *
+     * @return {FluentFiltersOrRelationsCondition}
+     */
+    withTextRegex(regex_pattern) {
+        this._textStr = `match regex pattern <|string|>${regex_pattern}<|string|>`;
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
@@ -1595,7 +1652,7 @@ export class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     withExactText(text) {
-        this._textStr = `equals text "${text}"`;
+        this._textStr = `equals text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
@@ -1613,7 +1670,7 @@ export class FluentFiltersCondition extends FluentBase {
      * @return {FluentFiltersOrRelationsCondition}
      */
     containsText(text) {
-        this._textStr = `contain text "${text}"`;
+        this._textStr = `contain text <|string|>${text}<|string|>`;
         return new FluentFiltersOrRelationsCondition(this);
     }
     /**
@@ -1860,11 +1917,11 @@ export class FluentCommand extends FluentBase {
      * @return {FluentFilters}
      */
     typeIn(text) {
-        this._textStr = `Type "${text}" in`;
+        this._textStr = `Type <|string|>${text}<|string|> in`;
         return new FluentFilters(this);
     }
     /**
-     * Moves mouse to the filtered element and scrolls in the x and y direction
+     * Moves mouse to the filtered element and scrolls in the x and y direction.
      *
      * @param {number} x_offset - A (positive/negative) x direction.
      * @param {number} y_offset - A (positive/negative) y direction.
@@ -1908,7 +1965,7 @@ export class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     type(text) {
-        this._textStr = `Type "${text}"`;
+        this._textStr = `Type <|string|>${text}<|string|>`;
         return new Exec(this);
     }
     /**
@@ -1957,7 +2014,7 @@ export class FluentCommand extends FluentBase {
      * @return {Exec}
      */
     execOnShell(shell_command) {
-        this._textStr = `Execute shell command "${shell_command}"`;
+        this._textStr = `Execute shell command <|string|>${shell_command}<|string|>`;
         return new Exec(this);
     }
     /**

package/dist/esm/execution/read-environment-credentials.js

@@ -1,12 +1,12 @@
 import { logger } from '../lib';
 export function envCredentials() {
     const envToken = process.env['ASKUI_TOKEN'];
-    const envTenant = process.env['ASKUI_TENANT'];
+    const envWorkspaceId = process.env['ASKUI_WORKSPACE_ID'];
     const envEmail = process.env['ASKUI_EMAIL'];
-    if (envToken && envTenant && envEmail) {
-        logger.info('Credentials are used from ENV variables: ASKUI_TOKEN, ASKUI_TENANT and ASKUI_EMAIL');
+    if (envToken && envWorkspaceId && envEmail) {
+        logger.info('Credentials are used from ENV variables: ASKUI_TOKEN, ASKUI_WORKSPACE_ID and ASKUI_EMAIL');
         return {
-            tenant: envTenant,
+            workspaceId: envWorkspaceId,
             email: envEmail,
             token: envToken,
         };

package/dist/esm/execution/read-environment-credentials.spec.js

@@ -2,9 +2,9 @@ import { envCredentials } from './read-environment-credentials';
 describe('envCredentials()', () => {
     test('should read the credentials from the environment variables', () => {
         process.env['ASKUI_TOKEN'] = 'token';
-        process.env['ASKUI_TENANT'] = 'tenant';
+        process.env['ASKUI_WORKSPACE_ID'] = 'id123';
         process.env['ASKUI_EMAIL'] = 'name@tenant.com';
         const credentialsFromTheEnv = envCredentials();
-        expect(credentialsFromTheEnv).toStrictEqual({ tenant: 'tenant', email: 'name@tenant.com', token: 'token' });
+        expect(credentialsFromTheEnv).toStrictEqual({ workspaceId: 'id123', email: 'name@tenant.com', token: 'token' });
     });
 });

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

@@ -20,7 +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';
-const getClientArgsWithDefaults = (clientArgs = {}) => (Object.assign({ uiControllerUrl: 'http://localhost:6769', inferenceServerUrl: 'https://inference.askui.com', annotationLevel: AnnotationLevel.DISABLED }, clientArgs));
+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 FluentCommand {
     constructor(httpClient, clientArgs) {
         super();

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

@@ -3,7 +3,7 @@ import { AnnotationLevel } from './annotation-level';
 /**
  * Configuration options for the askui UI Control Client
  *
- * @param {string} uiControllerUrl - Default: http://localhost:6769
+ * @param {string} uiControllerUrl - Default: http://127.0.0.1:6769
  * The adress of the askui UI Controller server.
  * @param {string} inferenceClientUrl - Default: https://inference.askui.com`
  * Address of the askui Inference server.

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

@@ -123,7 +123,7 @@ export class UiControllerFacade {
             }
             catch (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`);
+      Check this website for more information: https://docs.askui.com/docs/general/Troubleshooting`);
             }
         });
     }

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

@@ -24,7 +24,7 @@ export class UiControllerLinux extends UiControllerFacade {
             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');
+                throw new WaylandError('Wayland is not supported: https://docs.askui.com/docs/general/Troubleshooting/linux#wayland');
             }
             /* First we want to check if the user is using a debian distribution.
             * and in the following if libfuse2 is installed.
@@ -41,7 +41,7 @@ export class UiControllerLinux extends UiControllerFacade {
                 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');
+                throw new LibfuseError('Libfuse2 package is missing: https://docs.askui.com/docs/general/Troubleshooting/linux#libfuse2');
             }
         });
     }

package/dist/esm/utils/http/credentials.d.ts

@@ -1,5 +1,5 @@
 export interface CredentialArgs {
-    tenant: string;
+    workspaceId: string;
     email: string;
     token: string;
 }

package/dist/esm/utils/http/credentials.js

@@ -9,6 +9,6 @@ export class Credentials {
         return Buffer.from(`${this.userName}:${this.credentials.token}`);
     }
     get userName() {
-        return `${this.credentials.tenant}|${this.credentials.email}`;
+        return `${this.credentials.workspaceId}|${this.credentials.email}`;
     }
 }

package/dist/esm/utils/http/credentials.spec.js

@@ -2,8 +2,8 @@ import { Credentials } from './credentials';
 describe('Credentials', () => {
     describe('base64Encoded()', () => {
         test('should return base64-encoded credentials', () => {
-            const credentials = new Credentials({ tenant: 'tenant', email: 'name@tenant.com', token: 'password' });
-            expect(credentials.base64Encoded).toBe('dGVuYW50fG5hbWVAdGVuYW50LmNvbTpwYXNzd29yZA==');
+            const credentials = new Credentials({ workspaceId: 'id123', email: 'name@tenant.com', token: 'password' });
+            expect(credentials.base64Encoded).toBe('aWQxMjN8bmFtZUB0ZW5hbnQuY29tOnBhc3N3b3Jk');
         });
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.2.2",
+    "version": "0.2.3",
     "main": "./dist/cjs/main.js",
     "module": "./dist/esm/main.js",
     "bin": {
@@ -22,6 +22,10 @@
         "dist/bin/",
         "dist/example_projects_templates/"
     ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/askui/askui.git"
+    },
     "dependencies": {
         "commander": "~8.3.0",
         "fkill": "~7.2.1",
@@ -55,4 +59,4 @@
     "lint-staged": {
         "./**/*.{js,ts}": "eslint --cache --fix --max-warnings 0"
     }
-}
+}