@auxcode/auxta 1.3.110 → 1.3.113

package/README.md

@@ -1,11 +1,37 @@
 # AuxTA
 
+## Guidelines for the Frontend Programmers
+
+Every HTML element on a web page can be a selector, which can be used to create AuxTA scenarios.
+
+Of course, not all HTML elemets are used as selectors to create AuxTA scenarios.
+
+Those HTML elements, which will be used as selectors for AuxTA scenarios, should have a Unique ID. This way AuxTA scenarios are created the fastest.
+
+The best candidate for this is the HTML "id" attribute.
+
+The ID value should reflect the functionality of the place.
+
+To create a unique ID, make it multipart, beginning with more general parts which are guaranteed to be unique. This way one creates namespaces, which make it easier after that to end up with a unique ID.
+
+For expmple:
+
+id="shop_cart_button_submit"
+
+More than one of the same element, For example several tables on one page, each should have a unique ID.
+
+If it has nested elements they can have the same selectors as in the other elements, but it’s not necessary.
+
 ## Implementing
 
 The main thing is a `scenario`.
 
 `Scenarios` consts of `steps.
 
+### Helpers
+
+Change so that there is one function per helper file.
+
 ### Clicking
 
 All clicks wait for the selector by default and timeout w/ the standard timeout unless different is specified.
@@ -28,6 +54,14 @@ waitforseelctorbytext `depreciated`
 
 ### Complex Workflows
 
+#### Use Bulilding Blocks
+
+Building Blocks do one simple thing each and allow you to build State Scripts and Scenrios.
+
+#### Use State Scripts
+
+State Scripts bring the system to a desired state from which a specific scenario begins.
+
 #### Email
 
 * (AuxTA) We do some action on the website.
@@ -106,4 +140,10 @@ control click go to source directory
 
 Also some improvements to the platform in general:
 
-* get the console state after a fail, this would increase the value of each failed report.
+* get the console state after a fail, this would increase the value of each failed report.
+
+# Backlog
+
+## 13 October 2024
+
+Make so that there can be more than one helper file and that we have one function per helper file.

package/build/auxta/services/log.service.d.ts

@@ -24,7 +24,7 @@ export declare class LogSteps {
     };
     private stepLog;
     private lastStepTime;
-    private _tag;
+    private _tags;
     addSuggestion(text: string): void;
     addPerformanceFail(text: string, screenshot?: ArrayBuffer): void;
     clear(): void;
@@ -33,6 +33,7 @@ export declare class LogSteps {
     getStatusCount(status: StatusOfStep): number;
     get tag(): string;
     set tag(value: string);
+    clearTag(): void;
 }
 declare const log: LogSteps;
 export default log;

package/build/auxta/services/log.service.js

@@ -14,12 +14,12 @@ class LogSteps {
         };
         this.stepLog = [];
         this.lastStepTime = new Date().getTime();
-        this._tag = 'default';
+        this._tags = ['default'];
     }
     addSuggestion(text) {
         this.statusCounter[status_of_step_1.StatusOfStep.SUGGESTION]++;
         this.stepLog.push({
-            keyword: 'Suggestion', tag: this._tag, name: text, imageCompareKey: '', result: { status: status_of_step_1.StatusOfStep.SUGGESTION, duration: 0 }
+            keyword: 'Suggestion', tag: this.tag, name: text, imageCompareKey: '', result: { status: status_of_step_1.StatusOfStep.SUGGESTION, duration: 0 }
         });
     }
     addPerformanceFail(text, screenshot = new ArrayBuffer(0)) {
@@ -32,7 +32,7 @@ class LogSteps {
             };
             this.stepLog.push({
                 keyword: 'PerformanceFail',
-                tag: this._tag,
+                tag: this.tag,
                 name: text,
                 imageCompareKey: '',
                 result: { status: status_of_step_1.StatusOfStep.PERFORMANCE_FAIL, duration: currentStep - this.lastStepTime, embedding: embedding }
@@ -41,7 +41,7 @@ class LogSteps {
         else {
             this.stepLog.push({
                 keyword: 'PerformanceFail',
-                tag: this._tag,
+                tag: this.tag,
                 name: text,
                 imageCompareKey: '',
                 result: { status: status_of_step_1.StatusOfStep.PERFORMANCE_FAIL, duration: currentStep - this.lastStepTime }
@@ -95,10 +95,13 @@ class LogSteps {
         return this.statusCounter[status];
     }
     get tag() {
-        return this._tag;
+        return this._tags.length === 1 ? this._tags[0] : this._tags[1];
     }
     set tag(value) {
-        this._tag = value;
+        this._tags.push(value);
+    }
+    clearTag() {
+        this._tags.pop();
     }
 }
 exports.LogSteps = LogSteps;

package/build/macros/helpers/code.helper.d.ts

@@ -7,6 +7,7 @@ export declare class FunctionHelper extends ExtendDefaultPage {
     log(keyword: string, name: string, status: StatusOfStep, screenshot?: ArrayBuffer): void;
     setTag(tag: string): void;
     clearTag(): void;
+    callREST(method: string, url: string, headers?: object, body?: object): Promise<import("axios").AxiosResponse<any, any>>;
     screenshot(page?: import("puppeteer").Page): Promise<Buffer | undefined>;
     screenshotCompare(key: string, threshold?: number, page?: import("puppeteer").Page): Promise<void>;
     suggest(name: string): void;
@@ -27,6 +28,7 @@ export declare class FunctionHelper extends ExtendDefaultPage {
     closeLastPage(page?: import("puppeteer").Page): Promise<void>;
     microsoftLogin(button: string, email: string, password: string, page?: import("puppeteer").Page, newPage?: boolean, staySignIn?: boolean): Promise<void>;
     private getEscapedText;
+    callAPI(url: string, body: {}, token: string): Promise<import("axios").AxiosResponse<any, any>>;
 }
 declare const _default: FunctionHelper;
 export default _default;

package/build/macros/helpers/code.helper.js

@@ -21,17 +21,27 @@ const extend_default_page_1 = require("./extend-default-page");
 const puppeteer_2 = require("puppeteer");
 const screenshot_helper_1 = require("../../auxta/utilities/screenshot.helper");
 const report_service_1 = require("../../auxta/services/report.service");
+const axios_1 = __importDefault(require("axios"));
 class FunctionHelper extends extend_default_page_1.ExtendDefaultPage {
     log(keyword, name, status, screenshot) {
         log_service_1.default.push(keyword, log_service_1.default.tag, name, status, screenshot);
     }
     setTag(tag) {
-        if (!log_service_1.default.tag || log_service_1.default.tag === '' || log_service_1.default.tag === 'default') {
-            log_service_1.default.tag = tag;
-        }
+        log_service_1.default.tag = tag;
     }
     clearTag() {
-        log_service_1.default.tag = '';
+        log_service_1.default.clearTag();
+    }
+    callREST(method, url, headers, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield (0, axios_1.default)({
+                method: method,
+                url: url,
+                headers: headers,
+                data: body
+            });
+            return response;
+        });
     }
     screenshot(page = puppeteer_1.default.defaultPage) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -273,6 +283,16 @@ class FunctionHelper extends extend_default_page_1.ExtendDefaultPage {
         const splitedQuotes = text.replace(/'/g, `', "'", '`);
         return `concat('${splitedQuotes}', '')`;
     }
+    callAPI(url, body, token) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield axios_1.default.post(url, body, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    'Authorization': `Bearer ${token}`
+                }
+            });
+        });
+    }
 }
 exports.FunctionHelper = FunctionHelper;
 exports.default = new FunctionHelper();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auxcode/auxta",
-  "version": "1.3.110",
+  "version": "1.3.113",
   "description": "",
   "main": "./build/AuxTA.js",
   "types": "./build/AuxTA.d.ts",