ff-automationv2 1.0.0 → 2.0.1-beta.0

package/src/core/interfaces/StableDomInterface.ts

@@ -1,6 +1,6 @@
-export interface StableDOM {
-    browser: WebdriverIO.Browser | null,
-    timeout: number,
-    idleMs: number
-
+export interface StableDOM {
+    browser: WebdriverIO.Browser | null,
+    timeout: number,
+    idleMs: number
+
 }

package/src/core/interfaces/actionInterface.ts

@@ -1,13 +1,13 @@
-
-
-// Main action executor interface
-export interface IActionExecutor {
-  navigate(url: string): Promise<void>;
-  goBack(): Promise<void>;
-  refresh(): Promise<void>;
-  wait(time: string): Promise<void>;
-  click(pageDOM: string, selector: string, fireflinkIndex: string, elementName: string, elementType: string): Promise<void>;
-  enterInput(selector: string, value: string, fireflinkIndex: string, pageDOM: string, elementName: string, elementType: string, platform: string): Promise<void>;
-}
-
-
+
+
+// Main action executor interface
+export interface IActionExecutor {
+  navigate(url: string): Promise<void>;
+  goBack(): Promise<void>;
+  refresh(): Promise<void>;
+  wait(time: string): Promise<void>;
+  click(pageDOM: string, selector: string, fireflinkIndex: string, elementName: string, elementType: string): Promise<void>;
+  enterInput(selector: string, value: string, fireflinkIndex: string, pageDOM: string, elementName: string, elementType: string, platform: string): Promise<void>;
+}
+
+

package/src/core/interfaces/automationRunnerInterface.ts

@@ -1,3 +1,3 @@
-export interface IAutomationRunner {
-  run(): Promise<void>;
+export interface IAutomationRunner {
+  run(): Promise<void>;
 }

package/src/core/interfaces/browserCapabilitiesInterface.ts

@@ -1,5 +1,5 @@
-export interface browserCapabilities {
-    browserName: string;
-    pageLoad: number;
-    implicit: number;
+export interface browserCapabilities {
+    browserName: string;
+    pageLoad: number;
+    implicit: number;
 }

package/src/core/interfaces/browserConfigurationInterface.ts

@@ -1,3 +1,3 @@
-export interface BrowserConfig {
-    browserName: string;
+export interface BrowserConfig {
+    browserName: string;
 }

package/src/core/interfaces/domAnalysisInterface.ts

@@ -1,34 +1,34 @@
-export interface DomProcessingRequest {
-    keywords: string[] | string;
-    rawDom: any;
-    stepIndex: number;
-}
-
-
-export interface SimplifiedNode {
-    tag?: string;
-    "FF-inspecter"?: string;
-    "ff-xpath"?: string;
-    text?: string;
-    id?: string;
-    name?: string;
-    placeholder?: string;
-    "aria-label"?: string;
-    title?: string;
-    class?: string;
-    type?: string;
-    search?: string;
-}
-
-export interface StructuredNode extends SimplifiedNode {
-    relationship?: {
-        parent?: Partial<SimplifiedNode>;
-        children?: Partial<SimplifiedNode>[];
-        siblings?: Partial<SimplifiedNode>[];
-    };
-}
-
-
-export interface DomProcessingResult {
-    results: StructuredNode[];
-}
+export interface DomProcessingRequest {
+    keywords: string[] | string;
+    rawDom: any;
+    stepIndex: number;
+}
+
+
+export interface SimplifiedNode {
+    tag?: string;
+    "FF-inspecter"?: string;
+    "ff-xpath"?: string;
+    text?: string;
+    id?: string;
+    name?: string;
+    placeholder?: string;
+    "aria-label"?: string;
+    title?: string;
+    class?: string;
+    type?: string;
+    search?: string;
+}
+
+export interface StructuredNode extends SimplifiedNode {
+    relationship?: {
+        parent?: Partial<SimplifiedNode>;
+        children?: Partial<SimplifiedNode>[];
+        siblings?: Partial<SimplifiedNode>[];
+    };
+}
+
+
+export interface DomProcessingResult {
+    results: StructuredNode[];
+}

package/src/core/interfaces/executionDetails.ts

@@ -1,29 +1,29 @@
-import { BrowserConfig } from "./browserConfigurationInterface.js";
-export interface AutomationRequest {
-  userStory: string;
-  scriptName: string;
-  scriptType: string;
-  projectId: string;
-  testCaseId: string;
-  promptId: string;
-  pageDetails: any;
-  generatedBy: string;
-  webSocketId: string;
-  licenseType: string;
-  licenseId: string;
-  userId: string;
-  topic: string;
-  projectType: string;
-  serverData: any;
-  serviceProvider: string;
-  model: string;
-  apiKey: string; // base64 encoded
-  userName: string;
-  service_accounts: any;
-  serverHost: string;
-  browser: BrowserConfig;
-  platform: string;
-  token: string;
-  visionApikey: string;
-}
-
+import { BrowserConfig } from "./browserConfigurationInterface.js";
+export interface AutomationRequest {
+  userStory: string;
+  scriptName: string;
+  scriptType: string;
+  projectId: string;
+  testCaseId: string;
+  promptId: string;
+  pageDetails: any;
+  generatedBy: string;
+  webSocketId: string;
+  licenseType: string;
+  licenseId: string;
+  userId: string;
+  topic: string;
+  projectType: string;
+  serverData: any;
+  serviceProvider: string;
+  model: string;
+  apiKey: string; // base64 encoded
+  userName: string;
+  service_accounts: any;
+  serverHost: string;
+  browser: BrowserConfig;
+  platform: string;
+  token: string;
+  visionApikey: string;
+}
+

package/src/core/interfaces/fireflinkScriptPayloadInterface.ts

@@ -1,39 +1,39 @@
-export interface IStep {
-    nlpName: string;
-    elementsData: any[];
-    stepInputs: any[];
-}
-
-export interface IPayload {
-    scriptName: string,
-    scriptType: string,
-    projectId: string,
-    testCaseId: string,
-    promptId: string,
-    pageDetails: any,
-    generatedBy: string,
-    webSocketId: string,
-    licenseType: string,
-    licenseId: string,
-    userId: string,
-    topic: string,
-    projectType: string,
-    tokensConsumed: number,
-}
-
-export interface IFireFlinkApiService {
-    callFireFlinkApi(
-        headers: Record<string, string>,
-        body: any,
-        url: string
-    ): Promise<any>;
-}
-
-export interface IScriptRunner {
-    runScriptFromPayload(
-        result: any[] | [],
-        payload: IPayload,
-        token: string,
-        serverHost: string
-    ): Promise<any>;
-}
+export interface IStep {
+    nlpName: string;
+    elementsData: any[];
+    stepInputs: any[];
+}
+
+export interface IPayload {
+    scriptName: string,
+    scriptType: string,
+    projectId: string,
+    testCaseId: string,
+    promptId: string,
+    pageDetails: any,
+    generatedBy: string,
+    webSocketId: string,
+    licenseType: string,
+    licenseId: string,
+    userId: string,
+    topic: string,
+    projectType: string,
+    tokensConsumed: number,
+}
+
+export interface IFireFlinkApiService {
+    callFireFlinkApi(
+        headers: Record<string, string>,
+        body: any,
+        url: string
+    ): Promise<any>;
+}
+
+export interface IScriptRunner {
+    runScriptFromPayload(
+        result: any[] | [],
+        payload: IPayload,
+        token: string,
+        serverHost: string
+    ): Promise<any>;
+}

package/src/core/interfaces/llmConfigurationInterface.ts

@@ -1,3 +1,3 @@
-export interface IServiceProviderBaseUrlConfiguration {
-    getBaseUrl(provider: string): string;
+export interface IServiceProviderBaseUrlConfiguration {
+    getBaseUrl(provider: string): string;
 }

package/src/core/interfaces/llmResponseInterface.ts

@@ -1,38 +1,38 @@
-
-export interface IKeywordAction {
-    keywords: string[];
-    elementName: string;
-    action: string;
-}
-
-export interface IDragDropAction {
-    drag: string;
-    drop: string;
-    action: string | "Builtin_DragAndDropToElement";
-    drag_element_name: string;
-    drop_element_name: string;
-}
-
-export interface IInputAction {
-    action: string;
-    input_text: string | "None";
-}
-
-
-export interface IScrollOrAttributeAction {
-    attribute_value: string;
-    action: string;
-    input_text: string;
-    keyword: string[];
-    num_of_scrolls: number;
-    direction: "up" | "down";
-    elementType: string;
-}
-
-export interface IManualSteps {
-    manualSteps: string[];
-}
-
-export interface IFireFlinkIndex {
-    fireflinkIndex: string;
-}
+
+export interface IKeywordAction {
+    keywords: string[];
+    elementName: string;
+    action: string;
+}
+
+export interface IDragDropAction {
+    drag: string;
+    drop: string;
+    action: string | "Builtin_DragAndDropToElement";
+    drag_element_name: string;
+    drop_element_name: string;
+}
+
+export interface IInputAction {
+    action: string;
+    input_text: string | "None";
+}
+
+
+export interface IScrollOrAttributeAction {
+    attribute_value: string;
+    action: string;
+    input_text: string;
+    keyword: string[];
+    num_of_scrolls: number;
+    direction: "up" | "down";
+    elementType: string;
+}
+
+export interface IManualSteps {
+    manualSteps: string[];
+}
+
+export interface IFireFlinkIndex {
+    fireflinkIndex: string;
+}

package/src/core/interfaces/promptInterface.ts

@@ -1,21 +1,21 @@
-import { PromptType } from "../types/promptType.js";
-export interface PromptArgsMap {
-    [PromptType.USER_STORY_TO_LIST]: Record<string, any>;
-    [PromptType.KEYWORD_EXTRACTOR]: {
-        priorAndNextSteps: string[];
-    };
-    [PromptType.ERROR_DESCRIPTION]: Record<string, any>;
-    [PromptType.FF_INSPECTOR]: {
-        stepAction: string;
-        extractedDomJson: any;
-        priorAndNextSteps: string[];
-        isAlert?: boolean;
-        isDrag?: boolean;
-    };
-    [PromptType.VISION_PROMPT]: {
-        currentStep: string;
-        priorAndNextSteps: string[];
-    };
-}
-
-
+import { PromptType } from "../types/promptType.js";
+export interface PromptArgsMap {
+    [PromptType.USER_STORY_TO_LIST]: Record<string, any>;
+    [PromptType.KEYWORD_EXTRACTOR]: {
+        priorAndNextSteps: string[];
+    };
+    [PromptType.ERROR_DESCRIPTION]: Record<string, any>;
+    [PromptType.FF_INSPECTOR]: {
+        stepAction: string;
+        extractedDomJson: any;
+        priorAndNextSteps: string[];
+        isAlert?: boolean;
+        isDrag?: boolean;
+    };
+    [PromptType.VISION_PROMPT]: {
+        currentStep: string;
+        priorAndNextSteps: string[];
+    };
+}
+
+

package/src/core/interfaces/scriptGenrationDataInterface.ts

@@ -1,16 +1,16 @@
-
-export interface IElementData {
-  elementName: string;
-  type: string;
-  locators: any[];
-  platform: string;
-}
-
-
-export interface IScriptGenerationData {
-  nlpName: string;
-  elementsData: IElementData[] | [];
-  stepInputs: string[] | [];
-}
-
-
+
+export interface IElementData {
+  elementName: string;
+  type: string;
+  locators: any[];
+  platform: string;
+}
+
+
+export interface IScriptGenerationData {
+  nlpName: string;
+  elementsData: IElementData[] | [];
+  stepInputs: string[] | [];
+}
+
+

package/src/core/interfaces/toolsInterface.ts

@@ -1,5 +1,5 @@
-export interface ITool {
-  name: string;
-  description: string;
-  execute(input: any): Promise<any>;
-}
+export interface ITool {
+  name: string;
+  description: string;
+  execute(input: any): Promise<any>;
+}

package/src/core/main/actionHandlerFactory.ts

@@ -1,86 +1,86 @@
-import { ExecutionContext } from "../main/executionContext.js";
-import { ActionExecutor } from "../../automation/actions/executor.js";
-
-export function createActionHandlers(
-    context: ExecutionContext,
-    pageLoad: number,
-    implicit: number
-): Record<string, (result: any) => Promise<void>> {
-
-    return {
-
-        open: async () => {
-            await context.session.open({
-                browserName: "chrome",
-                pageLoad,
-                implicit
-            });
-
-            context.executor = new ActionExecutor(
-                await context.session.getCurrentBrowser(),
-                context.scriptAppender,
-                context.locator,
-                context.request.platform
-            );
-
-            context.scriptAppender.add({
-                nlpName: "OpenBrowser",
-                elementsData: [],
-                stepInputs: []
-            });
-        },
-
-        navigate: async (result: any) => {
-            if (!context.executor) {
-                throw new Error("Browser not initialized.");
-            }
-
-            await context.executor.navigate(result.response.keywords[0]);
-        },
-        goBack: async () => {
-            if (!context.executor) {
-                throw new Error("Browser not initialized.");
-            }
-            await context.executor.goBack();
-        },
-        refresh: async () => {
-            if (!context.executor) {
-                throw new Error("Browser not initialized.");
-            }
-            await context.executor.refresh();
-        },
-        wait: async (result: any) => {
-            if (!context.executor) {
-                throw new Error("Browser not initialized.");
-            }
-            await context.executor.wait(result.value);
-        },
-        click: async (result: any) => {
-            if (!context.executor) {
-                throw new Error("Browser not initialized.");
-            }
-            await context.executor.click(
-                result.pageDOM,
-                result.selector,
-                result.fireflinkIndex,
-                result.elementName,
-                result.elementType
-            );
-        },
-
-        enter: async (result: any) => {
-            if (!context.executor) {
-                throw new Error("Browser not initialized.");
-            }
-            await context.executor.enterInput(
-                result.selector,
-                result.value,
-                result.fireflinkIndex,
-                result.pageDOM,
-                result.elementName,
-                result.elementType
-            );
-        }
-
-    };
-}
+import { ExecutionContext } from "../main/executionContext.js";
+import { ActionExecutor } from "../../automation/actions/executor.js";
+
+export function createActionHandlers(
+    context: ExecutionContext,
+    pageLoad: number,
+    implicit: number
+): Record<string, (result: any) => Promise<void>> {
+
+    return {
+
+        open: async () => {
+            await context.session.open({
+                browserName: "chrome",
+                pageLoad,
+                implicit
+            });
+
+            context.executor = new ActionExecutor(
+                await context.session.getCurrentBrowser(),
+                context.scriptAppender,
+                context.locator,
+                context.request.platform
+            );
+
+            context.scriptAppender.add({
+                nlpName: "OpenBrowser",
+                elementsData: [],
+                stepInputs: []
+            });
+        },
+
+        navigate: async (result: any) => {
+            if (!context.executor) {
+                throw new Error("Browser not initialized.");
+            }
+
+            await context.executor.navigate(result.response.keywords[0]);
+        },
+        goBack: async () => {
+            if (!context.executor) {
+                throw new Error("Browser not initialized.");
+            }
+            await context.executor.goBack();
+        },
+        refresh: async () => {
+            if (!context.executor) {
+                throw new Error("Browser not initialized.");
+            }
+            await context.executor.refresh();
+        },
+        wait: async (result: any) => {
+            if (!context.executor) {
+                throw new Error("Browser not initialized.");
+            }
+            await context.executor.wait(result.value);
+        },
+        click: async (result: any) => {
+            if (!context.executor) {
+                throw new Error("Browser not initialized.");
+            }
+            await context.executor.click(
+                result.pageDOM,
+                result.selector,
+                result.fireflinkIndex,
+                result.elementName,
+                result.elementType
+            );
+        },
+
+        enter: async (result: any) => {
+            if (!context.executor) {
+                throw new Error("Browser not initialized.");
+            }
+            await context.executor.enterInput(
+                result.selector,
+                result.value,
+                result.fireflinkIndex,
+                result.pageDOM,
+                result.elementName,
+                result.elementType
+            );
+        }
+
+    };
+}

package/src/core/main/executionContext.ts

@@ -1,18 +1,18 @@
-import { BrowserSession } from "../../automation/browserSession/initiateBrowserSession.js";
-import { ActionExecutor } from "../../automation/actions/executor.js";
-import { ElementGetter } from "../../fireflinkData/fireflinkLocators/getListOfLocators.js";
-import { ScriptDataAppender } from "../../fireflinkData/fireflinkScript/scriptGenrationData.js";
-import { AutomationRequest } from "../interfaces/executionDetails.js";
-
-export class ExecutionContext {
-    public session: BrowserSession;
-    public executor: ActionExecutor | null = null;
-    public locator: ElementGetter;
-    public scriptAppender: ScriptDataAppender;
-
-    constructor(public request: AutomationRequest) {
-        this.session = new BrowserSession();
-        this.locator = new ElementGetter();
-        this.scriptAppender = new ScriptDataAppender();
-    }
-}
+import { BrowserSession } from "../../automation/browserSession/initiateBrowserSession.js";
+import { ActionExecutor } from "../../automation/actions/executor.js";
+import { ElementGetter } from "../../fireflinkData/fireflinkLocators/getListOfLocators.js";
+import { ScriptDataAppender } from "../../fireflinkData/fireflinkScript/scriptGenrationData.js";
+import { AutomationRequest } from "../interfaces/executionDetails.js";
+
+export class ExecutionContext {
+    public session: BrowserSession;
+    public executor: ActionExecutor | null = null;
+    public locator: ElementGetter;
+    public scriptAppender: ScriptDataAppender;
+
+    constructor(public request: AutomationRequest) {
+        this.session = new BrowserSession();
+        this.locator = new ElementGetter();
+        this.scriptAppender = new ScriptDataAppender();
+    }
+}