askui 0.2.0 → 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-starting-problems#wayland).
-If you want to use the askui library libfuse2 is needed ([libfuse2 installation](https://docs.askui.com/docs/general/Troubleshooting/askui-ui-controller-starting-problems#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/bin/askui-postinstall

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+const { access } = require('fs/promises');
+const { join } = require('path');
+
+async function shouldBeExecuted() {
+  try {
+    await access(join(__dirname, '../.no-askui-postinstall'));
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      return true;
+    }
+    // eslint-disable-next-line no-console
+    console.error(err);
+  }
+  return false;
+}
+
+async function createInstallationTimestamp() {
+  try {
+    const { InstallationTimestamp } = require('../dist/cjs/utils/analytics/installation-timestamp');
+    InstallationTimestamp.create();
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.error(err);
+  }
+}
+
+async function main() {
+  if (await shouldBeExecuted()) {
+    await createInstallationTimestamp();
+  }
+}
+
+main();

package/dist/cjs/core/model/test-case-dto/index.js

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStep = exports.CustomElement = void 0;
+exports.CustomElement = void 0;
 var custom_element_1 = require("./custom-element");
 Object.defineProperty(exports, "CustomElement", { enumerable: true, get: function () { return custom_element_1.CustomElement; } });
-var test_step_1 = require("./test-step");
-Object.defineProperty(exports, "TestStep", { enumerable: true, get: function () { return test_step_1.TestStep; } });

package/dist/cjs/core/model/test-case-dto/test-step.d.ts

@@ -1,10 +1,6 @@
 import { CustomElement } from './custom-element';
-import { CustomElementJson } from './custom-element-json';
-export declare class TestStep {
+export interface TestStep {
     instruction: string;
-    customElements: CustomElement[];
-    constructor(instruction: string, customElements?: CustomElement[]);
-    static fromJson(step: TestStep & {
-        customElements: CustomElementJson[];
-    }): TestStep;
+    customElements?: CustomElement[];
+    secretText?: string | undefined;
 }

package/dist/cjs/core/model/test-case-dto/test-step.js

@@ -1,14 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestStep = void 0;
-const custom_element_1 = require("./custom-element");
-class TestStep {
-    constructor(instruction, customElements = []) {
-        this.instruction = instruction;
-        this.customElements = customElements;
-    }
-    static fromJson(step) {
-        return new TestStep(step.instruction, (step.customElements || []).map((customELement) => custom_element_1.CustomElement.fromJson(customELement)));
-    }
-}
-exports.TestStep = TestStep;

package/dist/cjs/core/ui-control-commands/control-command.d.ts

@@ -6,4 +6,5 @@ export declare class ControlCommand {
     tryToRepeat: boolean;
     constructor(code: ControlCommandCode, actions: Action[], tryToRepeat?: boolean);
     static fromJson(json: ControlCommand, resizeRatio?: number): ControlCommand;
+    setTextToBeTyped(text: string): void;
 }

package/dist/cjs/core/ui-control-commands/control-command.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ControlCommand = void 0;
 const action_1 = require("./action");
 const control_command_code_1 = require("./control-command-code");
+const input_event_1 = require("./input-event");
 class ControlCommand {
     constructor(code, actions, tryToRepeat = false) {
         this.code = code;
@@ -12,5 +13,9 @@ class ControlCommand {
     static fromJson(json, resizeRatio = 1) {
         return new ControlCommand(control_command_code_1.ControlCommandCode[json.code], json.actions.map((action) => action_1.Action.fromJson(action, resizeRatio)), json.tryToRepeat);
     }
+    setTextToBeTyped(text) {
+        this.actions = this.actions.map((action) => ([input_event_1.InputEvent.TYPE, input_event_1.InputEvent.TYPE_TEXT].includes(action.inputEvent)
+            ? new action_1.Action(action.inputEvent, action.position, text) : action));
+    }
 }
 exports.ControlCommand = ControlCommand;

package/dist/cjs/core/ui-control-commands/input-event.d.ts

@@ -16,6 +16,5 @@ export declare enum InputEvent {
     MOUSE_MOVE = "MOUSE_MOVE",
     MOUSE_DOWN = "MOUSE_DOWN",
     MOUSE_UP = "MOUSE_UP",
-    EXECUTE_COMMAND = "EXECUTE_COMMAND",
-    WAIT = "WAIT"
+    EXECUTE_COMMAND = "EXECUTE_COMMAND"
 }

package/dist/cjs/core/ui-control-commands/input-event.js

@@ -21,5 +21,4 @@ var InputEvent;
     InputEvent["MOUSE_DOWN"] = "MOUSE_DOWN";
     InputEvent["MOUSE_UP"] = "MOUSE_UP";
     InputEvent["EXECUTE_COMMAND"] = "EXECUTE_COMMAND";
-    InputEvent["WAIT"] = "WAIT";
 })(InputEvent = exports.InputEvent || (exports.InputEvent = {}));

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/execution-runtime.d.ts

@@ -8,6 +8,7 @@ export declare class ExecutionRuntime {
     private inferenceClient;
     constructor(uiControllerClient: UiControllerClient, inferenceClient: InferenceClient);
     executeTestStep(step: TestStep): Promise<void>;
+    private requestControl;
     /**
      * @param {TestStep} step - Test step used for predicting command.
      */
@@ -20,6 +21,7 @@ export declare class ExecutionRuntime {
      * --> retry with linear back-off
      */
     private predictCommandWithRetry;
+    private getImageIfRequired;
     private predictCommand;
     annotateInteractively(): Promise<void>;
     takeScreenshotIfImageisNotProvided(imagePath?: string): Promise<string>;

package/dist/cjs/execution/execution-runtime.js

@@ -30,6 +30,11 @@ class ExecutionRuntime {
             yield this.executeCommand(step);
         });
     }
+    requestControl(controlCommand) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.uiControllerClient.requestControl(controlCommand);
+        });
+    }
     /**
      * @param {TestStep} step - Test step used for predicting command.
      */
@@ -38,15 +43,13 @@ class ExecutionRuntime {
         return __awaiter(this, void 0, void 0, function* () {
             const controlCommand = yield this.predictCommandWithRetry(step);
             if (controlCommand.code === ui_control_commands_1.ControlCommandCode.OK) {
-                yield this.uiControllerClient.requestControl(controlCommand);
+                return this.requestControl(controlCommand);
             }
-            else if (controlCommand.tryToRepeat) {
-                yield this.uiControllerClient.requestControl(controlCommand);
-                this.executeCommandRepeatedly(step);
-            }
-            else {
-                throw new control_command_error_1.ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
+            if (controlCommand.tryToRepeat) {
+                yield this.requestControl(controlCommand);
+                return this.executeCommandRepeatedly(step);
             }
+            throw new control_command_error_1.ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
         });
     }
     executeCommandRepeatedly(step) {
@@ -63,8 +66,8 @@ class ExecutionRuntime {
                 if (controlCommand.code === ui_control_commands_1.ControlCommandCode.OK) {
                     break;
                 }
-                else if (controlCommand.tryToRepeat) {
-                    yield this.uiControllerClient.requestControl(controlCommand);
+                if (controlCommand.tryToRepeat) {
+                    yield this.requestControl(controlCommand);
                 }
                 else {
                     throw new control_command_error_1.ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
@@ -94,15 +97,24 @@ class ExecutionRuntime {
             return command;
         });
     }
+    getImageIfRequired(instruction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const isImageRequired = yield this.inferenceClient.isImageRequired(instruction);
+            if (!isImageRequired) {
+                return undefined;
+            }
+            const screenshotResponse = yield this.uiControllerClient.requestScreenshot();
+            return screenshotResponse.data.image;
+        });
+    }
     predictCommand(step) {
         return __awaiter(this, void 0, void 0, function* () {
-            const isImageRequired = yield this.inferenceClient.isImageRequired(step.instruction);
-            let image;
-            if (isImageRequired) {
-                const screenshotResponse = yield this.uiControllerClient.requestScreenshot();
-                image = screenshotResponse.data.image;
+            const image = yield this.getImageIfRequired(step.instruction);
+            const controlCommand = yield this.inferenceClient.predictControlCommand(step.instruction, step.customElements, image);
+            if (step.secretText !== undefined) {
+                controlCommand.setTextToBeTyped(step.secretText);
             }
-            return this.inferenceClient.predictControlCommand(step.instruction, step.customElements, image);
+            return controlCommand;
         });
     }
     annotateInteractively() {

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

@@ -8,6 +8,6 @@ export declare class InferenceClient {
     constructor(url: string, httpClient: HttpClientGot);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
-    predictControlCommand(instruction: string, customElements: CustomElement[], image?: string): Promise<ControlCommand>;
+    predictControlCommand(instruction: string, customElements?: CustomElement[], image?: string): Promise<ControlCommand>;
     predictImageAnnotation(image: string, customElements?: CustomElement[]): Promise<Annotation>;
 }

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

@@ -41,7 +41,7 @@ class InferenceClient {
             return (0, transformations_1.resizeBase64ImageWithSameRatio)(image);
         });
     }
-    predictControlCommand(instruction, customElements, image) {
+    predictControlCommand(instruction, customElements = [], image) {
         return __awaiter(this, void 0, void 0, function* () {
             const resizedImage = yield this.resizeIfNeeded(customElements, image);
             const httpBody = {

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.d.ts

@@ -1,5 +1,5 @@
 import { CustomElementJson } from '../core/model/test-case-dto';
-import { Executable, FluentCommand } from './dsl';
+import { Exec, Executable, FluentCommand, FluentFilters } from './dsl';
 import { UiControllerClientConnectionState } from './ui-controller-client-connection-state';
 import { Annotation } from '../core/annotation/annotation';
 import { AnnotationRequest } from '../core/model/annotation-result/annotation-interface';
@@ -18,6 +18,51 @@ export declare class UiControlClient extends FluentCommand {
     annotate(annotationRequest?: AnnotationRequest): Promise<Annotation>;
     annotateInteractively(): Promise<void>;
     exec(instruction: string, customElementJson?: CustomElementJson[]): Promise<void>;
+    private secretText;
+    /**
+     * Types a text inside the filtered element.
+     *
+     * By default, the `text` is included in the logs and sent over to the askui Inference server to
+     * predict in which context the typing has to occur. You can exclude the `text` from the logs
+     * and the request to the askui Inference server setting `options.isSecret` to `true`.
+     * This should not change the quality of the prediction of the askui Inference server. In this
+     * case, `options.secretMask` is included in logs and sent over instead of the `text`.
+     *
+     * @param {string} text - A text to type.
+     * @param {Object} [options]
+     * @param {boolean} [options.isSecret = false] - If set to `true`, `text` is neither included in
+     *   logs of askui nor sent over to askui Inference for prediction.
+     * @param {string} [options.secretMask = '****'] - If `options.isSecret` is set to `true`, this
+     *   is included in logs and sent over to askui Inference for prediction instead of the `text`.
+     *
+     * @return {FluentFilters}
+     */
+    typeIn(text: string, { isSecret, secretMask }?: {
+        isSecret?: boolean | undefined;
+        secretMask?: string | undefined;
+    }): FluentFilters;
+    /**
+     * Types a text at the current position.
+     *
+     * By default, the `text` is included in the logs and sent over to the askui Inference server to
+     * predict in which context the typing has to occur. You can exclude the `text` from the logs
+     * and the request to the askui Inference server setting `options.isSecret` to `true`.
+     * This should not change the quality of the prediction of the askui Inference server. In this
+     * case, `options.secretMask` is included in logs and sent over instead of the `text`.
+     *
+     * @param {string} text - A text to type.
+     * @param {Object} options
+     * @param {boolean} [options.isSecret = false] - If set to `true`, `text` is neither included in
+     *   logs of askui nor sent over to askui Inference for prediction.
+     * @param {string} [options.secretMask = '****'] - If `options.isSecret` is set to `true`, this
+     *   is included in logs and sent over to askui Inference for prediction instead of the `text`.
+     *
+     * @return {Exec}
+     */
+    type(text: string, { isSecret, secretMask }?: {
+        isSecret?: boolean | undefined;
+        secretMask?: string | undefined;
+    }): Exec;
     /**
      * Waits for `<delayInMs>` ms, e.g., 1000 ms. The exact delay may be a little longer
      * than `<delayInMs>` but never shorter than that.