askui 0.8.0 → 0.9.0

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

@@ -3,14 +3,16 @@ import { ControlCommand } from '../core/ui-control-commands';
 import { CustomElement } from '../core/model/test-case-dto';
 import { Annotation } from '../core/annotation/annotation';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
+import { ModelCompositionBranch } from './model-composition-branch';
 export declare class InferenceClient {
     baseUrl: string;
     httpClient: HttpClientGot;
     resize?: number | undefined;
     readonly workspaceId?: string | undefined;
+    readonly modelComposition?: ModelCompositionBranch[] | undefined;
     apiVersion: string;
     url: string;
-    constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, apiVersion?: string);
+    constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, modelComposition?: ModelCompositionBranch[] | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
     inference(customElements?: CustomElement[], image?: string, instruction?: string): Promise<ControlCommand | Annotation>;

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

@@ -21,11 +21,12 @@ const inference_response_error_1 = require("./inference-response-error");
 const config_error_1 = require("./config-error");
 const logger_1 = require("../lib/logger");
 class InferenceClient {
-    constructor(baseUrl, httpClient, resize, workspaceId, apiVersion = 'v3') {
+    constructor(baseUrl, httpClient, resize, workspaceId, modelComposition, apiVersion = 'v3') {
         this.baseUrl = baseUrl;
         this.httpClient = httpClient;
         this.resize = resize;
         this.workspaceId = workspaceId;
+        this.modelComposition = modelComposition;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = (0, url_join_1.default)(this.baseUrl, 'api', this.apiVersion);
         this.url = workspaceId
@@ -62,6 +63,7 @@ class InferenceClient {
                 image: resizedImage.base64Image,
                 instruction,
                 customElements,
+                modelComposition: this.modelComposition,
             };
             const url = (0, url_join_1.default)(this.url, 'inference');
             const response = yield this.httpClient.post(url, requestBody);

package/dist/cjs/execution/model-composition-branch.d.ts

@@ -0,0 +1,8 @@
+export interface ModelCompositionBranch {
+    task: string;
+    architecture: string;
+    version: string;
+    interface: string;
+    useCase: string;
+    tags: string[];
+}

package/dist/cjs/execution/model-composition-branch.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -52,7 +52,7 @@ class UiControlClient extends dsl_1.ApiCommands {
         return this._uiControllerClient;
     }
     get inferenceClient() {
-        return new inference_client_1.InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.clientArgs.resize, this.workspaceId);
+        return new inference_client_1.InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.clientArgs.resize, this.workspaceId, this.clientArgs.modelComposition);
     }
     get executionRuntime() {
         return new execution_runtime_1.ExecutionRuntime(this.uiControllerClient, this.inferenceClient);

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

@@ -1,6 +1,7 @@
 import { AnnotationLevel } from './annotation-level';
 import { CredentialArgs } from './credentials-args';
 import { ProxyAgentArgs } from '../shared/proxy-agent-args';
+import { ModelCompositionBranch } from './model-composition-branch';
 /**
  * Configuration options for the askui UI Control Client
  *
@@ -32,6 +33,7 @@ export interface ClientArgs {
     readonly credentials?: CredentialArgs;
     readonly proxyAgents?: ProxyAgentArgs;
     readonly resize?: number;
+    readonly modelComposition?: ModelCompositionBranch[];
 }
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;

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

@@ -48,7 +48,7 @@ class UiControllerClient {
                 this.ws.on('error', (error) => {
                     this.connectionState = ui_controller_client_connection_state_1.UiControllerClientConnectionState.ERROR;
                     reject(new ui_control_client_error_1.UiControlClientError(`Connection to UI Controller cannot be established,
-          Probably it was not started. Makse sure you started UI Controller with this 
+          Probably it was not started. Make sure you started UI Controller with this 
           Url ${this.url}. Error message  ${error.message}`));
                 });
             }

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

@@ -3,14 +3,16 @@ import { ControlCommand } from '../core/ui-control-commands';
 import { CustomElement } from '../core/model/test-case-dto';
 import { Annotation } from '../core/annotation/annotation';
 import { DetectedElement } from '../core/model/annotation-result/detected-element';
+import { ModelCompositionBranch } from './model-composition-branch';
 export declare class InferenceClient {
     baseUrl: string;
     httpClient: HttpClientGot;
     resize?: number | undefined;
     readonly workspaceId?: string | undefined;
+    readonly modelComposition?: ModelCompositionBranch[] | undefined;
     apiVersion: string;
     url: string;
-    constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, apiVersion?: string);
+    constructor(baseUrl: string, httpClient: HttpClientGot, resize?: number | undefined, workspaceId?: string | undefined, modelComposition?: ModelCompositionBranch[] | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
     inference(customElements?: CustomElement[], image?: string, instruction?: string): Promise<ControlCommand | Annotation>;

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

@@ -15,11 +15,12 @@ import { InferenceResponseError } from './inference-response-error';
 import { ConfigurationError } from './config-error';
 import { logger } from '../lib/logger';
 export class InferenceClient {
-    constructor(baseUrl, httpClient, resize, workspaceId, apiVersion = 'v3') {
+    constructor(baseUrl, httpClient, resize, workspaceId, modelComposition, apiVersion = 'v3') {
         this.baseUrl = baseUrl;
         this.httpClient = httpClient;
         this.resize = resize;
         this.workspaceId = workspaceId;
+        this.modelComposition = modelComposition;
         this.apiVersion = apiVersion;
         const versionedBaseUrl = urljoin(this.baseUrl, 'api', this.apiVersion);
         this.url = workspaceId
@@ -56,6 +57,7 @@ export class InferenceClient {
                 image: resizedImage.base64Image,
                 instruction,
                 customElements,
+                modelComposition: this.modelComposition,
             };
             const url = urljoin(this.url, 'inference');
             const response = yield this.httpClient.post(url, requestBody);

package/dist/esm/execution/model-composition-branch.d.ts

@@ -0,0 +1,8 @@
+export interface ModelCompositionBranch {
+    task: string;
+    architecture: string;
+    version: string;
+    interface: string;
+    useCase: string;
+    tags: string[];
+}

package/dist/esm/execution/model-composition-branch.js

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

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

@@ -49,7 +49,7 @@ export class UiControlClient extends ApiCommands {
         return this._uiControllerClient;
     }
     get inferenceClient() {
-        return new InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.clientArgs.resize, this.workspaceId);
+        return new InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.clientArgs.resize, this.workspaceId, this.clientArgs.modelComposition);
     }
     get executionRuntime() {
         return new ExecutionRuntime(this.uiControllerClient, this.inferenceClient);

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

@@ -1,6 +1,7 @@
 import { AnnotationLevel } from './annotation-level';
 import { CredentialArgs } from './credentials-args';
 import { ProxyAgentArgs } from '../shared/proxy-agent-args';
+import { ModelCompositionBranch } from './model-composition-branch';
 /**
  * Configuration options for the askui UI Control Client
  *
@@ -32,6 +33,7 @@ export interface ClientArgs {
     readonly credentials?: CredentialArgs;
     readonly proxyAgents?: ProxyAgentArgs;
     readonly resize?: number;
+    readonly modelComposition?: ModelCompositionBranch[];
 }
 export interface ClientArgsWithDefaults extends ClientArgs {
     readonly uiControllerUrl: string;

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

@@ -42,7 +42,7 @@ export class UiControllerClient {
                 this.ws.on('error', (error) => {
                     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 
+          Probably it was not started. Make sure you started UI Controller with this 
           Url ${this.url}. Error message  ${error.message}`));
                 });
             }

package/dist/example_projects_templates/typescript_jest/test/README.md

@@ -12,9 +12,9 @@ Use following command to set up Jest:
 npm i -D jest @types/jest ts-jest typescript
 ```
 
-## How to execute the example test
+## How to execute the example
 
-This test can be executed with the following command:
+This can be executed with the following command:
 ```shell
 npx jest --config ./test/jest.config.ts
 ```

package/dist/example_projects_templates/typescript_jest/test/my-first-askui-test-suite.test.ts

@@ -1,14 +1,14 @@
 import { aui } from './helper/jest.setup';
 
 describe('jest with askui', () => {
-
   it('should generate an interactive annotation', async () => {
     await aui.annotateInteractively();
   });
 
   it('should click on my element', async () => {
     await aui
-      .click()
-      // <INSERT YOUR COPIED FILTER HERE AND UNCOMMENT THIS LINE>.exec();
+      .click();
+    // <INSERT YOUR COPIED ELEMENT DESCRIPTION HERE AND UNCOMMENT THIS AND THE NEXT LINE>
+    // .exec();
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.8.0",
+    "version": "0.9.0",
     "license": "MIT",
     "author": "askui GmbH <info@askui.com> (http://www.askui.com/)",
     "description": "Reliable, automated end-to-end-testing that depends on what is shown on your screen instead of the technology you are running on",