ff-automationv2 1.0.0 → 2.0.1-beta.0

package/src/ai/llmprompts/systemPrompts/visionPrompt.ts

@@ -1,28 +1,28 @@
-
-type visionPrompt = {
-    currentStep: string,
-    priorAndNextSteps: string[]
-}
-export async function visionPrompt(
-    { currentStep, priorAndNextSteps }: visionPrompt
-): Promise<string> {
-
-    const customPromptText = `
-You are a precise automation assistant.
-Context: ${priorAndNextSteps}
-- Use the context to understand the step and select the closest semantic match to ${currentStep} and return only its index, else Fire-Flink-0.
-- **If u can't find the element, return Fire-Flink-0. dont return any other elements index.**
-- Using the provided annotated screenshot and ${currentStep}, identify the correct element index from the image.
-- Match the index to the text or action described in ${currentStep} as accurately as possible.
-- Return only the Fire-Flink-xx for the target element.
-- Do not provide any additional text or explanation. The output must be strictly Fire-Flink-xx.
-Now, Analyze the step:
-Step: "${currentStep}"
-
-Respond only with JSON using this format:
-{fireflinkIndex: Fire-Flink-xx.}
-
-`.trim();
-
-    return customPromptText;
-}
+
+type visionPrompt = {
+    currentStep: string,
+    priorAndNextSteps: string[]
+}
+export async function visionPrompt(
+    { currentStep, priorAndNextSteps }: visionPrompt
+): Promise<string> {
+
+    const customPromptText = `
+You are a precise automation assistant.
+Context: ${priorAndNextSteps}
+- Use the context to understand the step and select the closest semantic match to ${currentStep} and return only its index, else Fire-Flink-0.
+- **If u can't find the element, return Fire-Flink-0. dont return any other elements index.**
+- Using the provided annotated screenshot and ${currentStep}, identify the correct element index from the image.
+- Match the index to the text or action described in ${currentStep} as accurately as possible.
+- Return only the Fire-Flink-xx for the target element.
+- Do not provide any additional text or explanation. The output must be strictly Fire-Flink-xx.
+Now, Analyze the step:
+Step: "${currentStep}"
+
+Respond only with JSON using this format:
+{fireflinkIndex: Fire-Flink-xx.}
+
+`.trim();
+
+    return customPromptText;
+}

package/src/automation/actions/executor.ts

@@ -1,75 +1,75 @@
-import type { IActionExecutor } from "../../core/interfaces/actionInterface.js";
-import { navigate } from './navigation/navigate.js';
-import { goBack } from './navigation/goBack.js';
-import { pageRefresh } from './navigation/refresh.js';
-import { click } from './interaction/click.js';
-import { wait } from "./wait/wait.js"
-import { enterInput } from "./interaction/enterInput.js";
-import { ScriptDataAppender } from "../../fireflinkData/fireflinkScript/scriptGenrationData.js";
-import { ElementGetter } from "../../fireflinkData/fireflinkLocators/getListOfLocators.js";
-export class ActionExecutor implements IActionExecutor {
-    constructor(private readonly browser: WebdriverIO.Browser,
-        private scriptDataAppender: ScriptDataAppender,
-        private elementGetter: ElementGetter,
-        private platform: string) { }
-
-
-
-    async navigate(url: string): Promise<void> {
-        await navigate({
-            browser: this.browser,
-            url,
-            scriptDataAppender: this.scriptDataAppender
-        });
-    }
-
-    async goBack(): Promise<void> {
-        await goBack({
-            browser: this.browser,
-            scriptDataAppender: this.scriptDataAppender
-        });
-    }
-
-    async refresh(): Promise<void> {
-        await pageRefresh({
-            browser: this.browser,
-            scriptDataAppender: this.scriptDataAppender
-        });
-    }
-
-
-    async wait(time: string): Promise<void> {
-        await wait({
-            browser: this.browser,
-            time,
-            scriptDataAppender: this.scriptDataAppender
-        });
-    }
-    async click(pageDOM: string, selector: string, fireflinkIndex: string, elementName: string, elementType: string): Promise<void> {
-        await click({
-            browser: this.browser,
-            selector,
-            scriptDataAppender: this.scriptDataAppender,
-            elementGetter: this.elementGetter,
-            fireflinkIndex,
-            pageDOM,
-            elementName,
-            elementType,
-            platform: this.platform
-        });
-    }
-    async enterInput(selector: string, value: string, fireflinkIndex: string, pageDOM: string, elementName: string, elementType: string): Promise<void> {
-        await enterInput({
-            browser: this.browser,
-            selector: selector,
-            value,
-            scriptDataAppender: this.scriptDataAppender,
-            elementGetter: this.elementGetter,
-            fireflinkIndex,
-            pageDOM,
-            elementName,
-            elementType,
-            platform: this.platform
-        });
-    }
+import type { IActionExecutor } from "../../core/interfaces/actionInterface.js";
+import { navigate } from './navigation/navigate.js';
+import { goBack } from './navigation/goBack.js';
+import { pageRefresh } from './navigation/refresh.js';
+import { click } from './interaction/click.js';
+import { wait } from "./wait/wait.js"
+import { enterInput } from "./interaction/enterInput.js";
+import { ScriptDataAppender } from "../../fireflinkData/fireflinkScript/scriptGenrationData.js";
+import { ElementGetter } from "../../fireflinkData/fireflinkLocators/getListOfLocators.js";
+export class ActionExecutor implements IActionExecutor {
+    constructor(private readonly browser: WebdriverIO.Browser,
+        private scriptDataAppender: ScriptDataAppender,
+        private elementGetter: ElementGetter,
+        private platform: string) { }
+
+
+
+    async navigate(url: string): Promise<void> {
+        await navigate({
+            browser: this.browser,
+            url,
+            scriptDataAppender: this.scriptDataAppender
+        });
+    }
+
+    async goBack(): Promise<void> {
+        await goBack({
+            browser: this.browser,
+            scriptDataAppender: this.scriptDataAppender
+        });
+    }
+
+    async refresh(): Promise<void> {
+        await pageRefresh({
+            browser: this.browser,
+            scriptDataAppender: this.scriptDataAppender
+        });
+    }
+
+
+    async wait(time: string): Promise<void> {
+        await wait({
+            browser: this.browser,
+            time,
+            scriptDataAppender: this.scriptDataAppender
+        });
+    }
+    async click(pageDOM: string, selector: string, fireflinkIndex: string, elementName: string, elementType: string): Promise<void> {
+        await click({
+            browser: this.browser,
+            selector,
+            scriptDataAppender: this.scriptDataAppender,
+            elementGetter: this.elementGetter,
+            fireflinkIndex,
+            pageDOM,
+            elementName,
+            elementType,
+            platform: this.platform
+        });
+    }
+    async enterInput(selector: string, value: string, fireflinkIndex: string, pageDOM: string, elementName: string, elementType: string): Promise<void> {
+        await enterInput({
+            browser: this.browser,
+            selector: selector,
+            value,
+            scriptDataAppender: this.scriptDataAppender,
+            elementGetter: this.elementGetter,
+            fireflinkIndex,
+            pageDOM,
+            elementName,
+            elementType,
+            platform: this.platform
+        });
+    }
 }

package/src/automation/actions/interaction/enterInput.ts

@@ -1,27 +1,27 @@
-import { EnterInputInterface } from "../interface/interactionActionInterface.js";
-export async function enterInput(args: EnterInputInterface): Promise<void> {
-    try {
-        const element = args.browser.$(args.selector);
-        await element.scrollIntoView({ block: 'center', inline: 'center' });
-        await element.setValue(args.value);
-        const ffElement: any = await args.elementGetter.getFireFlinkElement(
-            args.pageDOM,
-            `[ff-inspect="${args.fireflinkIndex}"]`
-        );
-        args.scriptDataAppender.add({
-            nlpName: 'SendKeys',
-            stepInputs: [args.value],
-            elementsData: [{
-                elementName: args.elementName,
-                type: args.elementType,
-                locators: ffElement.locators,
-                platform: args.platform
-            }]
-        });
-
-    }
-    catch (error: any) {
-        throw new Error("enter action failed", { cause: error });
-    }
-
-}
+import { EnterInputInterface } from "../interface/interactionActionInterface.js";
+export async function enterInput(args: EnterInputInterface): Promise<void> {
+    try {
+        const element = args.browser.$(args.selector);
+        await element.scrollIntoView({ block: 'center', inline: 'center' });
+        await element.setValue(args.value);
+        const ffElement: any = await args.elementGetter.getFireFlinkElement(
+            args.pageDOM,
+            `[ff-inspect="${args.fireflinkIndex}"]`
+        );
+        args.scriptDataAppender.add({
+            nlpName: 'SendKeys',
+            stepInputs: [args.value],
+            elementsData: [{
+                elementName: args.elementName,
+                type: args.elementType,
+                locators: ffElement.locators,
+                platform: args.platform
+            }]
+        });
+
+    }
+    catch (error: any) {
+        throw new Error("enter action failed", { cause: error });
+    }
+
+}

package/src/automation/actions/interface/interactionActionInterface.ts

@@ -1,27 +1,27 @@
-import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
-import { ElementGetter } from "../../../fireflinkData/fireflinkLocators/getListOfLocators.js";
-export interface ClickInterface {
-  browser: WebdriverIO.Browser;
-  selector: string;
-  scriptDataAppender: ScriptDataAppender;
-  elementGetter: ElementGetter;
-  fireflinkIndex: string;
-  pageDOM: string;
-  elementName: string;
-  elementType: any;
-  platform: string;
-}
-
-
-export interface EnterInputInterface {
-  browser: WebdriverIO.Browser;
-  selector: string;
-  value: string;
-  scriptDataAppender: ScriptDataAppender;
-  elementGetter: ElementGetter;
-  fireflinkIndex: string;
-  pageDOM: string;
-  elementName: string;
-  elementType: any;
-  platform: string;
+import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
+import { ElementGetter } from "../../../fireflinkData/fireflinkLocators/getListOfLocators.js";
+export interface ClickInterface {
+  browser: WebdriverIO.Browser;
+  selector: string;
+  scriptDataAppender: ScriptDataAppender;
+  elementGetter: ElementGetter;
+  fireflinkIndex: string;
+  pageDOM: string;
+  elementName: string;
+  elementType: any;
+  platform: string;
+}
+
+
+export interface EnterInputInterface {
+  browser: WebdriverIO.Browser;
+  selector: string;
+  value: string;
+  scriptDataAppender: ScriptDataAppender;
+  elementGetter: ElementGetter;
+  fireflinkIndex: string;
+  pageDOM: string;
+  elementName: string;
+  elementType: any;
+  platform: string;
 }

package/src/automation/actions/interface/navigationActionInterface.ts

@@ -1,22 +1,22 @@
-import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
-
-export interface getTitleInterface {
-  browser: WebdriverIO.Browser;
-  scriptDataAppender: ScriptDataAppender;
-}
-
-export interface goBackInterface {
-  browser: WebdriverIO.Browser;
-  scriptDataAppender: ScriptDataAppender;
-}
-
-export interface navigateToUrlInterface {
-  browser: WebdriverIO.Browser;
-  scriptDataAppender: ScriptDataAppender;
-    url: string;
-}
-
-export interface refreshInterface {
-  browser: WebdriverIO.Browser;
-  scriptDataAppender: ScriptDataAppender;
+import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
+
+export interface getTitleInterface {
+  browser: WebdriverIO.Browser;
+  scriptDataAppender: ScriptDataAppender;
+}
+
+export interface goBackInterface {
+  browser: WebdriverIO.Browser;
+  scriptDataAppender: ScriptDataAppender;
+}
+
+export interface navigateToUrlInterface {
+  browser: WebdriverIO.Browser;
+  scriptDataAppender: ScriptDataAppender;
+    url: string;
+}
+
+export interface refreshInterface {
+  browser: WebdriverIO.Browser;
+  scriptDataAppender: ScriptDataAppender;
 }

package/src/automation/actions/interface/waitActionInterface.ts

@@ -1,6 +1,6 @@
-import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
-export interface waitInterface {
-    browser: WebdriverIO.Browser;
-    scriptDataAppender: ScriptDataAppender;
-    time: string;
+import { ScriptDataAppender } from "../../../fireflinkData/fireflinkScript/scriptGenrationData.js";
+export interface waitInterface {
+    browser: WebdriverIO.Browser;
+    scriptDataAppender: ScriptDataAppender;
+    time: string;
 }

package/src/automation/actions/navigation/getTitle.ts

@@ -1,9 +1,9 @@
-import { getTitleInterface } from "../interface/navigationActionInterface.js";
-export async function getTitle(args: getTitleInterface): Promise<void> {
-    try {
-        const title = await args.browser.getTitle();
-        args.scriptDataAppender.add({ nlpName: 'getTitle', elementsData: [], stepInputs: [title] });
-    } catch (error: any) {
-        throw new Error("Get title action failed", { cause: error });
-    }
+import { getTitleInterface } from "../interface/navigationActionInterface.js";
+export async function getTitle(args: getTitleInterface): Promise<void> {
+    try {
+        const title = await args.browser.getTitle();
+        args.scriptDataAppender.add({ nlpName: 'getTitle', elementsData: [], stepInputs: [title] });
+    } catch (error: any) {
+        throw new Error("Get title action failed", { cause: error });
+    }
 }

package/src/automation/actions/navigation/goBack.ts

@@ -1,9 +1,9 @@
-import { goBackInterface } from "../interface/navigationActionInterface.js";
-export async function goBack(args: goBackInterface): Promise<void> {
-    try {
-        await args.browser.back();
-        args.scriptDataAppender.add({ nlpName: 'goBack', elementsData: [], stepInputs: [] });
-    } catch (error: any) {
-        throw new Error("Navigate action failed", { cause: error });
-    }
+import { goBackInterface } from "../interface/navigationActionInterface.js";
+export async function goBack(args: goBackInterface): Promise<void> {
+    try {
+        await args.browser.back();
+        args.scriptDataAppender.add({ nlpName: 'goBack', elementsData: [], stepInputs: [] });
+    } catch (error: any) {
+        throw new Error("Navigate action failed", { cause: error });
+    }
 }

package/src/automation/actions/navigation/navigate.ts

@@ -1,10 +1,10 @@
-import { navigateToUrlInterface } from "../interface/navigationActionInterface.js";
-export async function navigate(args: navigateToUrlInterface): Promise<void> {
-    try {
-        await args.browser.url(args.url);
-        args.scriptDataAppender.add({ nlpName: 'NavigateToURL', elementsData: [], stepInputs: [args.url] });
-
-    } catch (error: any) {
-        throw new Error("Navigate action failed", { cause: error });
-    }
+import { navigateToUrlInterface } from "../interface/navigationActionInterface.js";
+export async function navigate(args: navigateToUrlInterface): Promise<void> {
+    try {
+        await args.browser.url(args.url);
+        args.scriptDataAppender.add({ nlpName: 'NavigateToURL', elementsData: [], stepInputs: [args.url] });
+
+    } catch (error: any) {
+        throw new Error("Navigate action failed", { cause: error });
+    }
 }

package/src/automation/actions/navigation/refresh.ts

@@ -1,9 +1,9 @@
-import { refreshInterface } from "../interface/navigationActionInterface.js";
-export async function pageRefresh(args: refreshInterface): Promise<void> {
-    try {
-        await args.browser.refresh();
-        args.scriptDataAppender.add({ nlpName: 'refresh', elementsData: [], stepInputs: [] });
-    } catch (error: any) {
-        throw new Error("Refresh action failed", { cause: error });
-    }
+import { refreshInterface } from "../interface/navigationActionInterface.js";
+export async function pageRefresh(args: refreshInterface): Promise<void> {
+    try {
+        await args.browser.refresh();
+        args.scriptDataAppender.add({ nlpName: 'refresh', elementsData: [], stepInputs: [] });
+    } catch (error: any) {
+        throw new Error("Refresh action failed", { cause: error });
+    }
 }

package/src/automation/actions/wait/wait.ts

@@ -1,10 +1,10 @@
-import { waitInterface } from "../interface/waitActionInterface.js";
-export async function wait(args: waitInterface): Promise<void> {
-    try {
-        await args.browser.pause(Number(args.time) * 1000);
-        args.scriptDataAppender.add({ nlpName: 'Sleep', elementsData: [], stepInputs: [args.time] });
-
-    } catch (error: any) {
-        throw new Error("Navigate action failed", { cause: error });
-    }
+import { waitInterface } from "../interface/waitActionInterface.js";
+export async function wait(args: waitInterface): Promise<void> {
+    try {
+        await args.browser.pause(Number(args.time) * 1000);
+        args.scriptDataAppender.add({ nlpName: 'Sleep', elementsData: [], stepInputs: [args.time] });
+
+    } catch (error: any) {
+        throw new Error("Navigate action failed", { cause: error });
+    }
 }

package/src/automation/browserSession/initiateBrowserSession.ts

@@ -1,81 +1,81 @@
-import { remote } from "webdriverio";
-import { browserCapabilities } from "../../core/interfaces/browserCapabilitiesInterface.js";
-
-export class BrowserSession {
-    private browser: WebdriverIO.Browser | null = null;
-
-    private async openBrowser(capabilities: browserCapabilities): Promise<WebdriverIO.Browser> {
-        try {
-            const browser = await remote(
-                {
-                    capabilities: {
-                        browserName: capabilities.browserName,
-                    },
-                    logLevel: "silent"
-                }
-            );
-            browser.setTimeout({ 'pageLoad': capabilities.pageLoad, 'implicit': capabilities.implicit });
-            await browser.waitUntil(async () => {
-                const state = await browser.execute(() => document.readyState);
-                return state === "complete";
-            });
-
-            return browser;
-        } catch (error: any) {
-            throw new Error("Browser failed to open", { cause: error });
-        }
-    }
-
-
-    async open(capabilities: browserCapabilities): Promise<void> {
-        this.browser = await this.openBrowser(capabilities);
-
-    }
-
-    async close(): Promise<void> {
-        if (this.browser) {
-            await this.browser.deleteSession();
-            this.browser = null;
-        }
-    }
-
-    async getCurrentBrowser(): Promise<WebdriverIO.Browser> {
-        if (!this.browser) {
-            throw new Error("Browser is not initialized");
-        }
-        return this.browser;
-    }
-
-
-    async waitForStableDOM(timeout = 10000): Promise<void> {
-        if (!this.browser) throw new Error("Browser session not found");
-
-        let lastHTML = "";
-        let stableCount = 0;
-
-        try {
-            await this.browser.waitUntil(async () => {
-                if (!this.browser) return;
-                const currentHTML = await this.browser.execute(() =>
-                    document.documentElement.outerHTML
-                );
-                if (currentHTML === lastHTML) {
-                    stableCount++;
-                } else {
-                    stableCount = 0;
-                }
-
-                lastHTML = currentHTML;
-
-                return stableCount >= 3;
-            }, {
-                timeout,
-                interval: 500
-            });
-        } catch {
-            return;
-        }
-    }
-
-
-}
+import { remote } from "webdriverio";
+import { browserCapabilities } from "../../core/interfaces/browserCapabilitiesInterface.js";
+
+export class BrowserSession {
+    private browser: WebdriverIO.Browser | null = null;
+
+    private async openBrowser(capabilities: browserCapabilities): Promise<WebdriverIO.Browser> {
+        try {
+            const browser = await remote(
+                {
+                    capabilities: {
+                        browserName: capabilities.browserName,
+                    },
+                    logLevel: "silent"
+                }
+            );
+            browser.setTimeout({ 'pageLoad': capabilities.pageLoad, 'implicit': capabilities.implicit });
+            await browser.waitUntil(async () => {
+                const state = await browser.execute(() => document.readyState);
+                return state === "complete";
+            });
+
+            return browser;
+        } catch (error: any) {
+            throw new Error("Browser failed to open", { cause: error });
+        }
+    }
+
+
+    async open(capabilities: browserCapabilities): Promise<void> {
+        this.browser = await this.openBrowser(capabilities);
+
+    }
+
+    async close(): Promise<void> {
+        if (this.browser) {
+            await this.browser.deleteSession();
+            this.browser = null;
+        }
+    }
+
+    async getCurrentBrowser(): Promise<WebdriverIO.Browser> {
+        if (!this.browser) {
+            throw new Error("Browser is not initialized");
+        }
+        return this.browser;
+    }
+
+
+    async waitForStableDOM(timeout = 10000): Promise<void> {
+        if (!this.browser) throw new Error("Browser session not found");
+
+        let lastHTML = "";
+        let stableCount = 0;
+
+        try {
+            await this.browser.waitUntil(async () => {
+                if (!this.browser) return;
+                const currentHTML = await this.browser.execute(() =>
+                    document.documentElement.outerHTML
+                );
+                if (currentHTML === lastHTML) {
+                    stableCount++;
+                } else {
+                    stableCount = 0;
+                }
+
+                lastHTML = currentHTML;
+
+                return stableCount >= 3;
+            }, {
+                timeout,
+                interval: 500
+            });
+        } catch {
+            return;
+        }
+    }
+
+
+}

package/src/core/constants/supportedActions.ts

@@ -1,8 +1,8 @@
-export const INPUTLESS_ACTIONS = [
-    "open",
-    "goBack",
-    "refresh",
-    "navigate"
-];
-
+export const INPUTLESS_ACTIONS = [
+    "open",
+    "goBack",
+    "refresh",
+    "navigate"
+];
+
 export const ELEMENTLESS_ACTION = ["wait"]