askui 0.2.5 → 0.2.6

package/dist/cjs/execution/credentials-args.d.ts

@@ -0,0 +1,4 @@
+export interface CredentialArgs {
+    workspaceId: string;
+    token: string;
+}

package/dist/cjs/execution/credentials-args.js

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

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

@@ -3,9 +3,12 @@ import { ControlCommand } from '../core/ui-control-commands';
 import { CustomElement } from '../core/model/test-case-dto';
 import { Annotation } from '../core/annotation/annotation';
 export declare class InferenceClient {
-    url: string;
+    baseUrl: string;
     httpClient: HttpClientGot;
-    constructor(url: string, httpClient: HttpClientGot);
+    readonly workspaceId?: string | undefined;
+    apiVersion: string;
+    url: string;
+    constructor(baseUrl: string, httpClient: HttpClientGot, workspaceId?: string | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
     predictControlCommand(instruction: string, customElements?: CustomElement[], image?: string): Promise<ControlCommand>;

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

@@ -18,9 +18,13 @@ const ui_control_commands_1 = require("../core/ui-control-commands");
 const annotation_1 = require("../core/annotation/annotation");
 const transformations_1 = require("../utils/transformations");
 class InferenceClient {
-    constructor(url, httpClient) {
-        this.url = url;
+    constructor(baseUrl, httpClient, workspaceId, apiVersion = 'v2') {
+        this.baseUrl = baseUrl;
         this.httpClient = httpClient;
+        this.workspaceId = workspaceId;
+        this.apiVersion = apiVersion;
+        const versionedBaseUrl = (0, url_join_1.default)(this.baseUrl, 'api', this.apiVersion);
+        this.url = workspaceId ? (0, url_join_1.default)(versionedBaseUrl, 'workspaces', workspaceId) : versionedBaseUrl;
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -49,7 +53,7 @@ class InferenceClient {
                 instruction,
                 customElements,
             };
-            const url = (0, url_join_1.default)(this.url, 'api', 'v1', 'predict-command');
+            const url = (0, url_join_1.default)(this.url, 'predict-command');
             const httpResponse = yield this.httpClient.post(url, httpBody);
             return ui_control_commands_1.ControlCommand.fromJson(httpResponse, resizedImage.resizeRatio);
         });

package/dist/cjs/execution/read-environment-credentials.d.ts

@@ -1,2 +1,2 @@
-import { CredentialArgs } from '../utils/http/credentials';
+import { CredentialArgs } from './credentials-args';
 export declare function envCredentials(): CredentialArgs | undefined;

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

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

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

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

package/dist/cjs/execution/ui-control-client.d.ts

@@ -7,6 +7,7 @@ import { ClientArgs } from './ui-controller-client-interface';
 export declare class UiControlClient extends FluentCommand {
     private httpClient;
     private clientArgs;
+    private workspaceId?;
     private _uiControllerClient?;
     private constructor();
     static build(clientArgs?: ClientArgs): Promise<UiControlClient>;

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

@@ -25,10 +25,11 @@ const read_environment_credentials_1 = require("./read-environment-credentials")
 const analytics_1 = require("../utils/analytics");
 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) {
+    constructor(httpClient, clientArgs, workspaceId) {
         super();
         this.httpClient = httpClient;
         this.clientArgs = clientArgs;
+        this.workspaceId = workspaceId;
         this.secretText = undefined;
     }
     static build(clientArgs) {
@@ -36,8 +37,9 @@ class UiControlClient extends dsl_1.FluentCommand {
             const analytics = new analytics_1.Analytics();
             const analyticsHeaders = yield analytics.getAnalyticsHeaders();
             const cas = getClientArgsWithDefaults(clientArgs);
-            const httpClient = new http_client_got_1.HttpClientGot(cas.credentials || (0, read_environment_credentials_1.envCredentials)(), analyticsHeaders);
-            return new UiControlClient(httpClient, cas);
+            const credentialArgs = cas.credentials || (0, read_environment_credentials_1.envCredentials)();
+            const httpClient = new http_client_got_1.HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders);
+            return new UiControlClient(httpClient, cas, credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.workspaceId);
         });
     }
     get uiControllerClient() {
@@ -47,7 +49,7 @@ class UiControlClient extends dsl_1.FluentCommand {
         return this._uiControllerClient;
     }
     get inferenceClient() {
-        return new inference_client_1.InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient);
+        return new inference_client_1.InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.workspaceId);
     }
     get executionRuntime() {
         return new execution_runtime_1.ExecutionRuntime(this.uiControllerClient, this.inferenceClient);

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

@@ -1,5 +1,5 @@
-import { CredentialArgs } from '../utils/http/credentials';
 import { AnnotationLevel } from './annotation-level';
+import { CredentialArgs } from './credentials-args';
 /**
  * Configuration options for the askui UI Control Client
  *

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

@@ -1,12 +1,6 @@
-export interface CredentialArgs {
-    workspaceId: string;
-    email: string;
-    token: string;
-}
 export declare class Credentials {
-    private credentials;
-    constructor(credentials: CredentialArgs);
+    private token;
+    constructor(token: string);
     get base64Encoded(): string;
     private get buffered();
-    private get userName();
 }

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

@@ -2,17 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Credentials = void 0;
 class Credentials {
-    constructor(credentials) {
-        this.credentials = credentials;
+    constructor(token) {
+        this.token = token;
     }
     get base64Encoded() {
         return this.buffered.toString('base64');
     }
     get buffered() {
-        return Buffer.from(`${this.userName}:${this.credentials.token}`);
-    }
-    get userName() {
-        return `${this.credentials.workspaceId}|${this.credentials.email}`;
+        return Buffer.from(`${this.token}`);
     }
 }
 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({ workspaceId: 'id123', email: 'name@tenant.com', token: 'password' });
-            expect(credentials.base64Encoded).toBe('aWQxMjN8bmFtZUB0ZW5hbnQuY29tOnBhc3N3b3Jk');
+            const credentials = new credentials_1.Credentials('password');
+            expect(credentials.base64Encoded).toBe('cGFzc3dvcmQ=');
         });
     });
 });

package/dist/cjs/utils/http/http-client-got.d.ts

@@ -1,10 +1,9 @@
 import { OptionsOfJSONResponseBody } from 'got';
-import { CredentialArgs } from './credentials';
 export declare class HttpClientGot {
-    readonly credentialArgs?: CredentialArgs | undefined;
+    readonly token?: string | undefined;
     readonly customHeaders?: Record<string, string> | undefined;
     private headers;
-    constructor(credentialArgs?: CredentialArgs | undefined, customHeaders?: Record<string, string> | undefined);
+    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined);
     private initHeaders;
     private injectHeaders;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;

package/dist/cjs/utils/http/http-client-got.js

@@ -17,14 +17,14 @@ const got_1 = __importDefault(require("got"));
 const credentials_1 = require("./credentials");
 const custom_errors_1 = require("./custom-errors");
 class HttpClientGot {
-    constructor(credentialArgs, customHeaders) {
-        this.credentialArgs = credentialArgs;
+    constructor(token, customHeaders) {
+        this.token = token;
         this.customHeaders = customHeaders;
         this.headers = {};
-        this.initHeaders(credentialArgs, customHeaders);
+        this.initHeaders(token, customHeaders);
     }
-    initHeaders(credentialArgs, customHeaders = {}) {
-        const credentials = credentialArgs ? new credentials_1.Credentials(credentialArgs) : undefined;
+    initHeaders(token, customHeaders = {}) {
+        const credentials = token ? new credentials_1.Credentials(token) : undefined;
         this.headers = Object.assign(Object.assign({}, (credentials ? { Authorization: `Basic ${credentials === null || credentials === void 0 ? void 0 : credentials.base64Encoded}` } : {})), customHeaders);
     }
     injectHeaders(options) {

package/dist/esm/execution/credentials-args.d.ts

@@ -0,0 +1,4 @@
+export interface CredentialArgs {
+    workspaceId: string;
+    token: string;
+}

package/dist/esm/execution/credentials-args.js

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

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

@@ -3,9 +3,12 @@ import { ControlCommand } from '../core/ui-control-commands';
 import { CustomElement } from '../core/model/test-case-dto';
 import { Annotation } from '../core/annotation/annotation';
 export declare class InferenceClient {
-    url: string;
+    baseUrl: string;
     httpClient: HttpClientGot;
-    constructor(url: string, httpClient: HttpClientGot);
+    readonly workspaceId?: string | undefined;
+    apiVersion: string;
+    url: string;
+    constructor(baseUrl: string, httpClient: HttpClientGot, workspaceId?: string | undefined, apiVersion?: string);
     isImageRequired(instruction: string): Promise<boolean>;
     private resizeIfNeeded;
     predictControlCommand(instruction: string, customElements?: CustomElement[], image?: string): Promise<ControlCommand>;

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

@@ -12,9 +12,13 @@ import { ControlCommand } from '../core/ui-control-commands';
 import { Annotation } from '../core/annotation/annotation';
 import { resizeBase64ImageWithSameRatio } from '../utils/transformations';
 export class InferenceClient {
-    constructor(url, httpClient) {
-        this.url = url;
+    constructor(baseUrl, httpClient, workspaceId, apiVersion = 'v2') {
+        this.baseUrl = baseUrl;
         this.httpClient = httpClient;
+        this.workspaceId = workspaceId;
+        this.apiVersion = apiVersion;
+        const versionedBaseUrl = urljoin(this.baseUrl, 'api', this.apiVersion);
+        this.url = workspaceId ? urljoin(versionedBaseUrl, 'workspaces', workspaceId) : versionedBaseUrl;
     }
     isImageRequired(instruction) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -43,7 +47,7 @@ export class InferenceClient {
                 instruction,
                 customElements,
             };
-            const url = urljoin(this.url, 'api', 'v1', 'predict-command');
+            const url = urljoin(this.url, 'predict-command');
             const httpResponse = yield this.httpClient.post(url, httpBody);
             return ControlCommand.fromJson(httpResponse, resizedImage.resizeRatio);
         });

package/dist/esm/execution/read-environment-credentials.d.ts

@@ -1,2 +1,2 @@
-import { CredentialArgs } from '../utils/http/credentials';
+import { CredentialArgs } from './credentials-args';
 export declare function envCredentials(): CredentialArgs | undefined;

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

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

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

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

package/dist/esm/execution/ui-control-client.d.ts

@@ -7,6 +7,7 @@ import { ClientArgs } from './ui-controller-client-interface';
 export declare class UiControlClient extends FluentCommand {
     private httpClient;
     private clientArgs;
+    private workspaceId?;
     private _uiControllerClient?;
     private constructor();
     static build(clientArgs?: ClientArgs): Promise<UiControlClient>;

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

@@ -22,10 +22,11 @@ import { envCredentials } from './read-environment-credentials';
 import { Analytics } from '../utils/analytics';
 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) {
+    constructor(httpClient, clientArgs, workspaceId) {
         super();
         this.httpClient = httpClient;
         this.clientArgs = clientArgs;
+        this.workspaceId = workspaceId;
         this.secretText = undefined;
     }
     static build(clientArgs) {
@@ -33,8 +34,9 @@ export class UiControlClient extends FluentCommand {
             const analytics = new Analytics();
             const analyticsHeaders = yield analytics.getAnalyticsHeaders();
             const cas = getClientArgsWithDefaults(clientArgs);
-            const httpClient = new HttpClientGot(cas.credentials || envCredentials(), analyticsHeaders);
-            return new UiControlClient(httpClient, cas);
+            const credentialArgs = cas.credentials || envCredentials();
+            const httpClient = new HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders);
+            return new UiControlClient(httpClient, cas, credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.workspaceId);
         });
     }
     get uiControllerClient() {
@@ -44,7 +46,7 @@ export class UiControlClient extends FluentCommand {
         return this._uiControllerClient;
     }
     get inferenceClient() {
-        return new InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient);
+        return new InferenceClient(this.clientArgs.inferenceServerUrl, this.httpClient, this.workspaceId);
     }
     get executionRuntime() {
         return new ExecutionRuntime(this.uiControllerClient, this.inferenceClient);

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

@@ -1,5 +1,5 @@
-import { CredentialArgs } from '../utils/http/credentials';
 import { AnnotationLevel } from './annotation-level';
+import { CredentialArgs } from './credentials-args';
 /**
  * Configuration options for the askui UI Control Client
  *

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

@@ -1,12 +1,6 @@
-export interface CredentialArgs {
-    workspaceId: string;
-    email: string;
-    token: string;
-}
 export declare class Credentials {
-    private credentials;
-    constructor(credentials: CredentialArgs);
+    private token;
+    constructor(token: string);
     get base64Encoded(): string;
     private get buffered();
-    private get userName();
 }

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

@@ -1,14 +1,11 @@
 export class Credentials {
-    constructor(credentials) {
-        this.credentials = credentials;
+    constructor(token) {
+        this.token = token;
     }
     get base64Encoded() {
         return this.buffered.toString('base64');
     }
     get buffered() {
-        return Buffer.from(`${this.userName}:${this.credentials.token}`);
-    }
-    get userName() {
-        return `${this.credentials.workspaceId}|${this.credentials.email}`;
+        return Buffer.from(`${this.token}`);
     }
 }

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({ workspaceId: 'id123', email: 'name@tenant.com', token: 'password' });
-            expect(credentials.base64Encoded).toBe('aWQxMjN8bmFtZUB0ZW5hbnQuY29tOnBhc3N3b3Jk');
+            const credentials = new Credentials('password');
+            expect(credentials.base64Encoded).toBe('cGFzc3dvcmQ=');
         });
     });
 });

package/dist/esm/utils/http/http-client-got.d.ts

@@ -1,10 +1,9 @@
 import { OptionsOfJSONResponseBody } from 'got';
-import { CredentialArgs } from './credentials';
 export declare class HttpClientGot {
-    readonly credentialArgs?: CredentialArgs | undefined;
+    readonly token?: string | undefined;
     readonly customHeaders?: Record<string, string> | undefined;
     private headers;
-    constructor(credentialArgs?: CredentialArgs | undefined, customHeaders?: Record<string, string> | undefined);
+    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined);
     private initHeaders;
     private injectHeaders;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;

package/dist/esm/utils/http/http-client-got.js

@@ -11,14 +11,14 @@ import got from 'got';
 import { Credentials } from './credentials';
 import { httpClientErrorHandler } from './custom-errors';
 export class HttpClientGot {
-    constructor(credentialArgs, customHeaders) {
-        this.credentialArgs = credentialArgs;
+    constructor(token, customHeaders) {
+        this.token = token;
         this.customHeaders = customHeaders;
         this.headers = {};
-        this.initHeaders(credentialArgs, customHeaders);
+        this.initHeaders(token, customHeaders);
     }
-    initHeaders(credentialArgs, customHeaders = {}) {
-        const credentials = credentialArgs ? new Credentials(credentialArgs) : undefined;
+    initHeaders(token, customHeaders = {}) {
+        const credentials = token ? new Credentials(token) : undefined;
         this.headers = Object.assign(Object.assign({}, (credentials ? { Authorization: `Basic ${credentials === null || credentials === void 0 ? void 0 : credentials.base64Encoded}` } : {})), customHeaders);
     }
     injectHeaders(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.2.5",
+    "version": "0.2.6",
     "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",