askui 0.2.0 → 0.2.3

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/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/esm/execution/execution-runtime.js

@@ -27,6 +27,11 @@ export 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.
      */
@@ -35,15 +40,13 @@ export class ExecutionRuntime {
         return __awaiter(this, void 0, void 0, function* () {
             const controlCommand = yield this.predictCommandWithRetry(step);
             if (controlCommand.code === 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 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 ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
         });
     }
     executeCommandRepeatedly(step) {
@@ -60,8 +63,8 @@ export class ExecutionRuntime {
                 if (controlCommand.code === ControlCommandCode.OK) {
                     break;
                 }
-                else if (controlCommand.tryToRepeat) {
-                    yield this.uiControllerClient.requestControl(controlCommand);
+                if (controlCommand.tryToRepeat) {
+                    yield this.requestControl(controlCommand);
                 }
                 else {
                     throw new ControlCommandError(((_a = controlCommand.actions[0]) === null || _a === void 0 ? void 0 : _a.text) || '');
@@ -91,15 +94,24 @@ export 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/esm/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/esm/execution/inference-client.js

@@ -35,7 +35,7 @@ export class InferenceClient {
             return 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/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.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.

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

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { CustomElement } from '../core/model/test-case-dto';
-import { FluentCommand } from './dsl';
+import { FluentCommand, } from './dsl';
 import { HttpClientGot } from '../utils/http/http-client-got';
 import { UiControllerClient } from './ui-controller-client';
 import { ExecutionRuntime } from './execution-runtime';
@@ -20,12 +20,13 @@ 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();
         this.httpClient = httpClient;
         this.clientArgs = clientArgs;
+        this.secretText = undefined;
     }
     static build(clientArgs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -85,16 +86,15 @@ export class UiControlClient extends FluentCommand {
             }
         });
     }
-    exec(instruction, customElementJson) {
+    exec(instruction, customElementJson = []) {
         return __awaiter(this, void 0, void 0, function* () {
-            let customElements = [];
-            if (customElementJson !== undefined) {
-                customElements = yield CustomElement.fromJsonListWithImagePathOrImage(customElementJson);
-            }
+            const customElements = yield CustomElement.fromJsonListWithImagePathOrImage(customElementJson);
+            const { secretText } = this;
             try {
                 yield this.executionRuntime.executeTestStep({
                     instruction,
                     customElements,
+                    secretText,
                 });
                 yield this.annotateByDefault(TestStepState.PASSED, customElements);
                 return yield Promise.resolve();
@@ -105,6 +105,56 @@ export class UiControlClient extends FluentCommand {
             }
         });
     }
+    /**
+     * 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, { isSecret = false, secretMask = '****' } = {}) {
+        if (isSecret) {
+            this.secretText = text;
+            return super.typeIn(secretMask);
+        }
+        return super.typeIn(text);
+    }
+    /**
+     * 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, { isSecret = false, secretMask = '****' } = {}) {
+        if (isSecret) {
+            this.secretText = text;
+            return super.type(secretMask);
+        }
+        return super.type(text);
+    }
     /**
      * Waits for `<delayInMs>` ms, e.g., 1000 ms. The exact delay may be a little longer
      * than `<delayInMs>` but never shorter than that.

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/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) {
@@ -28,7 +29,7 @@ function buildBinaryNotAvailbleError(binaryVersion) {
     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/askui-ui-controller/${binaryVersion}`;

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-starting-problems#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-starting-problems#libfuse2');
+                throw new LibfuseError('Libfuse2 package is missing: https://docs.askui.com/docs/general/Troubleshooting/linux#libfuse2');
             }
         });
     }

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

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import os from 'os';
 import { UserIdentifier } from './user-identifier';
+import { InstallationTimestamp } from './installation-timestamp';
 export class Analytics {
     constructor() {
         this.userIdentifier = new UserIdentifier();
@@ -16,10 +17,15 @@ export class Analytics {
     getAnalyticsHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const userID = yield this.userIdentifier.userId();
-            return {
+            const headers = {
                 'askui-user-id': userID,
                 'askui-user-agent': `os:${os.platform()};arch:${os.arch()}`,
             };
+            const askuiInstalledAt = yield InstallationTimestamp.get();
+            if (askuiInstalledAt) {
+                headers['askui-installed-at'] = askuiInstalledAt.toISOString();
+            }
+            return headers;
         });
     }
 }

package/dist/esm/utils/analytics/installation-timestamp-create-error.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+export declare class InstallationTimestampCreateError extends Error {
+    constructor(err: NodeJS.ErrnoException);
+}

package/dist/esm/utils/analytics/installation-timestamp-create-error.js

@@ -0,0 +1,5 @@
+export class InstallationTimestampCreateError extends Error {
+    constructor(err) {
+        super(`Installation timestamp could not be created. \n${err.message}`);
+    }
+}

package/dist/esm/utils/analytics/installation-timestamp-get-error.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+export declare class InstallationTimestampGetError extends Error {
+    constructor(err: NodeJS.ErrnoException);
+}

package/dist/esm/utils/analytics/installation-timestamp-get-error.js

@@ -0,0 +1,5 @@
+export class InstallationTimestampGetError extends Error {
+    constructor(err) {
+        super(`Installation timestamp does not exist. Try reinstalling the lib to create it. \n${err.message}`);
+    }
+}

package/dist/esm/utils/analytics/installation-timestamp.d.ts

@@ -0,0 +1,7 @@
+export declare abstract class InstallationTimestamp {
+    private static fileName;
+    private static value?;
+    static create(): Promise<void>;
+    static get(): Promise<Date | null>;
+    private static getFromFile;
+}