askui 0.3.1 → 0.3.2

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

@@ -36,9 +36,10 @@ class UiControlClient extends dsl_1.FluentCommand {
         return __awaiter(this, void 0, void 0, function* () {
             const analytics = new analytics_1.Analytics();
             const analyticsHeaders = yield analytics.getAnalyticsHeaders();
+            const analyticsCookies = yield analytics.getAnalyticsCookies();
             const cas = getClientArgsWithDefaults(clientArgs);
             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);
+            const httpClient = new http_client_got_1.HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders, analyticsCookies);
             return new UiControlClient(httpClient, cas, credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.workspaceId);
         });
     }

package/dist/cjs/utils/analytics/analytics.d.ts

@@ -2,4 +2,5 @@ import { AnalyticsInterface } from './analytics-interface';
 export declare class Analytics implements AnalyticsInterface {
     private userIdentifier;
     getAnalyticsHeaders(): Promise<Record<string, string>>;
+    getAnalyticsCookies(): Promise<Record<string, string>>;
 }

package/dist/cjs/utils/analytics/analytics.js

@@ -34,5 +34,13 @@ class Analytics {
             return headers;
         });
     }
+    getAnalyticsCookies() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userID = yield this.userIdentifier.userId();
+            return {
+                'askui-user-id': userID,
+            };
+        });
+    }
 }
 exports.Analytics = Analytics;

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

@@ -2,10 +2,11 @@ import { OptionsOfJSONResponseBody } from 'got';
 export declare class HttpClientGot {
     readonly token?: string | undefined;
     readonly customHeaders?: Record<string, string> | undefined;
+    private readonly cookies;
     private headers;
-    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined);
+    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>);
     private initHeaders;
-    private injectHeaders;
+    private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;
     get<T>(url: string, options?: OptionsOfJSONResponseBody): Promise<T>;
 }

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

@@ -14,12 +14,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpClientGot = void 0;
 const got_1 = __importDefault(require("got"));
+const tough_cookie_1 = require("tough-cookie");
 const credentials_1 = require("./credentials");
 const custom_errors_1 = require("./custom-errors");
 class HttpClientGot {
-    constructor(token, customHeaders) {
+    constructor(token, customHeaders, cookies = {}) {
         this.token = token;
         this.customHeaders = customHeaders;
+        this.cookies = cookies;
         this.headers = {};
         this.initHeaders(token, customHeaders);
     }
@@ -27,12 +29,16 @@ class HttpClientGot {
         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) {
-        return Object.assign(Object.assign({}, options), { headers: this.headers });
+    injectHeadersAndCookies(url, options) {
+        const cookieJar = new tough_cookie_1.CookieJar();
+        Object.keys(this.cookies).map((key) => `${key}=${this.cookies[key]}`).forEach((cookie) => {
+            cookieJar.setCookieSync(cookie, url);
+        });
+        return Object.assign(Object.assign({}, options), { headers: this.headers, cookieJar });
     }
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const options = this.injectHeaders({ json: data, responseType: 'json', throwHttpErrors: false });
+            const options = this.injectHeadersAndCookies(url, { json: data, responseType: 'json', throwHttpErrors: false });
             const { body, statusCode } = yield got_1.default.post(url, options);
             if (statusCode !== 200) {
                 throw (0, custom_errors_1.httpClientErrorHandler)(statusCode, JSON.stringify(body));
@@ -42,7 +48,7 @@ class HttpClientGot {
     }
     get(url, options = { responseType: 'json' }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield got_1.default.get(url, this.injectHeaders(options));
+            const response = yield got_1.default.get(url, this.injectHeadersAndCookies(url, options));
             return response.body;
         });
     }

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

@@ -33,9 +33,10 @@ export class UiControlClient extends FluentCommand {
         return __awaiter(this, void 0, void 0, function* () {
             const analytics = new Analytics();
             const analyticsHeaders = yield analytics.getAnalyticsHeaders();
+            const analyticsCookies = yield analytics.getAnalyticsCookies();
             const cas = getClientArgsWithDefaults(clientArgs);
             const credentialArgs = cas.credentials || envCredentials();
-            const httpClient = new HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders);
+            const httpClient = new HttpClientGot(credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.token, analyticsHeaders, analyticsCookies);
             return new UiControlClient(httpClient, cas, credentialArgs === null || credentialArgs === void 0 ? void 0 : credentialArgs.workspaceId);
         });
     }

package/dist/esm/utils/analytics/analytics.d.ts

@@ -2,4 +2,5 @@ import { AnalyticsInterface } from './analytics-interface';
 export declare class Analytics implements AnalyticsInterface {
     private userIdentifier;
     getAnalyticsHeaders(): Promise<Record<string, string>>;
+    getAnalyticsCookies(): Promise<Record<string, string>>;
 }

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

@@ -28,4 +28,12 @@ export class Analytics {
             return headers;
         });
     }
+    getAnalyticsCookies() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userID = yield this.userIdentifier.userId();
+            return {
+                'askui-user-id': userID,
+            };
+        });
+    }
 }

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

@@ -2,10 +2,11 @@ import { OptionsOfJSONResponseBody } from 'got';
 export declare class HttpClientGot {
     readonly token?: string | undefined;
     readonly customHeaders?: Record<string, string> | undefined;
+    private readonly cookies;
     private headers;
-    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined);
+    constructor(token?: string | undefined, customHeaders?: Record<string, string> | undefined, cookies?: Record<string, string>);
     private initHeaders;
-    private injectHeaders;
+    private injectHeadersAndCookies;
     post<T>(url: string, data: Record<string | number | symbol, unknown>): Promise<T>;
     get<T>(url: string, options?: OptionsOfJSONResponseBody): Promise<T>;
 }

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

@@ -8,12 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import got from 'got';
+import { CookieJar } from 'tough-cookie';
 import { Credentials } from './credentials';
 import { httpClientErrorHandler } from './custom-errors';
 export class HttpClientGot {
-    constructor(token, customHeaders) {
+    constructor(token, customHeaders, cookies = {}) {
         this.token = token;
         this.customHeaders = customHeaders;
+        this.cookies = cookies;
         this.headers = {};
         this.initHeaders(token, customHeaders);
     }
@@ -21,12 +23,16 @@ export class HttpClientGot {
         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) {
-        return Object.assign(Object.assign({}, options), { headers: this.headers });
+    injectHeadersAndCookies(url, options) {
+        const cookieJar = new CookieJar();
+        Object.keys(this.cookies).map((key) => `${key}=${this.cookies[key]}`).forEach((cookie) => {
+            cookieJar.setCookieSync(cookie, url);
+        });
+        return Object.assign(Object.assign({}, options), { headers: this.headers, cookieJar });
     }
     post(url, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            const options = this.injectHeaders({ json: data, responseType: 'json', throwHttpErrors: false });
+            const options = this.injectHeadersAndCookies(url, { json: data, responseType: 'json', throwHttpErrors: false });
             const { body, statusCode } = yield got.post(url, options);
             if (statusCode !== 200) {
                 throw httpClientErrorHandler(statusCode, JSON.stringify(body));
@@ -36,7 +42,7 @@ export class HttpClientGot {
     }
     get(url, options = { responseType: 'json' }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield got.get(url, this.injectHeaders(options));
+            const response = yield got.get(url, this.injectHeadersAndCookies(url, options));
             return response.body;
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "askui",
-    "version": "0.3.1",
+    "version": "0.3.2",
     "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",
@@ -58,6 +58,7 @@
         "pino": "7.8.1",
         "pino-pretty": "7.5.3",
         "sharp": "0.30.6",
+        "tough-cookie": "4.1.2",
         "url-join": "4.0.1",
         "wait-port": "0.2.9",
         "ws": "7.4.4",