@empiricalrun/test-gen 0.35.6 → 0.35.9

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @empiricalrun/test-gen
 
+## 0.35.9
+
+### Patch Changes
+
+- 04ca7f3: feat: add locator.press action
+
+## 0.35.8
+
+### Patch Changes
+
+- 461f3dd: fix: add logs for generation stopped due to stop session requested
+
+## 0.35.7
+
+### Patch Changes
+
+- 2145207: fix: vitest config to exclude browser tests
+
 ## 0.35.6
 
 ### Patch Changes

package/browser-injected-scripts/annotate-elements.spec.ts

@@ -157,7 +157,7 @@ test("should annotate all important items on quizizz page", async ({
         (item) =>
           item.innerText.includes("accommodations") &&
           item.href ===
-            "https://quizizz.com/admin/differentiation/accommodations",
+          "https://quizizz.com/admin/differentiation/accommodations",
       ),
     )
     .toBeTruthy();

package/dist/actions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/actions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIlC,OAAO,EAAE,YAAY,EAA6B,MAAM,UAAU,CAAC;AAWnE,qBAAa,iBAAiB;IAShB,OAAO,CAAC,IAAI;IARxB,OAAO,CAAC,gBAAgB,CAA8B;IACtD,OAAO,CAAC,eAAe,CAInB;IACJ,OAAO,CAAC,cAAc,CAA2B;gBAE7B,IAAI,EAAE,IAAI;IAexB,aAAa,CACjB,IAAI,oBAAa,EACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,KAAK,CAAC,EAAE,WAAW;IAgDrB,wBAAwB,IAAI,YAAY,EAAE;IAkB1C,sBAAsB,IAAI,YAAY,EAAE;IAUxC,YAAY,IAAI;QACd,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,EAAE,CAAC;KACvB;IAUD,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAO9B;;;;;;OAMG;IACH,aAAa,IAAI,OAAO;IAQxB,UAAU;CAUX"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/actions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIlC,OAAO,EAAE,YAAY,EAA6B,MAAM,UAAU,CAAC;AAYnE,qBAAa,iBAAiB;IAShB,OAAO,CAAC,IAAI;IARxB,OAAO,CAAC,gBAAgB,CAA8B;IACtD,OAAO,CAAC,eAAe,CAInB;IACJ,OAAO,CAAC,cAAc,CAA2B;gBAE7B,IAAI,EAAE,IAAI;IAgBxB,aAAa,CACjB,IAAI,oBAAa,EACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,KAAK,CAAC,EAAE,WAAW;IAgDrB,wBAAwB,IAAI,YAAY,EAAE;IAmB1C,sBAAsB,IAAI,YAAY,EAAE;IAUxC,YAAY,IAAI;QACd,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,EAAE,CAAC;KACvB;IAUD,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAO9B;;;;;;OAMG;IACH,aAAa,IAAI,OAAO;IAQxB,UAAU;CAUX"}

package/dist/actions/index.js

@@ -9,6 +9,7 @@ const done_1 = require("./done");
 const fill_1 = require("./fill");
 const goto_1 = require("./goto");
 const hover_1 = require("./hover");
+const press_1 = require("./press");
 const reload_page_1 = require("./reload-page");
 const skill_1 = require("./skill");
 const text_content_1 = require("./text-content");
@@ -24,6 +25,7 @@ class PlaywrightActions {
             goto_1.gotoActionGenerator,
             click_1.clickActionGenerator,
             hover_1.hoverActionGenerator,
+            press_1.pressActionGenerator,
             done_1.doneActionGenerator,
             assert_1.assertTextVisibilityActionGenerator,
             reload_page_1.reloadActionGenerator,
@@ -84,6 +86,7 @@ class PlaywrightActions {
             fill_1.fillActionGenerator,
             goto_1.gotoActionGenerator,
             click_1.clickActionGenerator,
+            press_1.pressActionGenerator,
             done_1.doneActionGenerator,
             assert_1.assertTextVisibilityActionGenerator,
             reload_page_1.reloadActionGenerator,

package/dist/actions/press.d.ts

@@ -0,0 +1,4 @@
+import { PlaywrightActionGenerator } from "../types";
+export declare const PLAYWRIGHT_PRESS_ACTION_NAME = "keyboard_press_on_element";
+export declare const pressActionGenerator: PlaywrightActionGenerator;
+//# sourceMappingURL=press.d.ts.map

package/dist/actions/press.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"press.d.ts","sourceRoot":"","sources":["../../src/actions/press.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAIrD,eAAO,MAAM,4BAA4B,8BAA8B,CAAC;AAExE,eAAO,MAAM,oBAAoB,EAAE,yBA4DlC,CAAC"}

package/dist/actions/press.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pressActionGenerator = exports.PLAYWRIGHT_PRESS_ACTION_NAME = void 0;
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+exports.PLAYWRIGHT_PRESS_ACTION_NAME = "keyboard_press_on_element";
+const pressActionGenerator = (page) => {
+    return {
+        execute: async ({ args }) => {
+            const css = args.css_selector;
+            const locator = await (0, utils_1.getPlaywrightLocatorUsingCssSelector)(css, args.xpath, page, args?.elementAnnotation);
+            const exec = new Function("page", `return page.${locator}.press("${args.key}", { timeout: 3000 })`);
+            await exec(page);
+            return {
+                locator,
+            };
+        },
+        // TODO: args transformer to be kept at a single place
+        template: (args, options) => {
+            return {
+                code: `await ${(0, utils_1.getPageVarName)()}.${options.locator}.press("${args.key}");`,
+            };
+        },
+        name: exports.PLAYWRIGHT_PRESS_ACTION_NAME,
+        schema: {
+            type: "function",
+            function: {
+                name: exports.PLAYWRIGHT_PRESS_ACTION_NAME,
+                description: "Focuses the matching element and presses a combination of the keys",
+                parameters: {
+                    type: "object",
+                    properties: {
+                        reason: {
+                            type: "string",
+                            description: constants_1.DEFAULT_ACTION_REASON_PROMPT,
+                        },
+                        key: {
+                            type: "string",
+                            description: "The key to press on the keyboard after focusing the element. Example: F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.",
+                        },
+                        xpath: {
+                            type: "string",
+                            description: "XPath selector to identify the element uniquely and click it. When creating XPATH selector, ensure they are unique and specific enough to select only one element, even if there are multiple elements of the same type (like multiple h1 elements)",
+                        },
+                        css_selector: {
+                            type: "string",
+                            description: "CSS selector to identify the element uniquely.When creating CSS selectors, ensure they are unique to the page and specific enough to select only one element.",
+                        },
+                    },
+                    required: ["reason", "key", "xpath", "css_selector"],
+                },
+            },
+        },
+    };
+};
+exports.pressActionGenerator = pressActionGenerator;

package/dist/browser-injected-scripts/annotate-elements.spec.ts

@@ -157,7 +157,7 @@ test("should annotate all important items on quizizz page", async ({
         (item) =>
           item.innerText.includes("accommodations") &&
           item.href ===
-            "https://quizizz.com/admin/differentiation/accommodations",
+          "https://quizizz.com/admin/differentiation/accommodations",
       ),
     )
     .toBeTruthy();

package/dist/session/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"AAkBA,iBAAS,iBAAiB;;;;;EAOzB;AAED,wBAAgB,iBAAiB,CAAC,EAChC,SAAS,EACT,YAAY,EACZ,UAAU,EACV,eAAe,GAChB,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;CACzB,QAIA;AAED,wBAAsB,iBAAiB,qBAGtC;AAED,wBAAsB,eAAe,0DAqBpC;AAED,wBAAsB,UAAU,kBAqB/B;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"AAmBA,iBAAS,iBAAiB;;;;;EAOzB;AAED,wBAAgB,iBAAiB,CAAC,EAChC,SAAS,EACT,YAAY,EACZ,UAAU,EACV,eAAe,GAChB,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;CACzB,QAIA;AAED,wBAAsB,iBAAiB,qBAStC;AAED,wBAAsB,eAAe,0DAqBpC;AAED,wBAAsB,UAAU,kBAqB/B;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/session/index.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSessionDetails = exports.endSession = exports.getSessionState = exports.shouldStopSession = exports.setSessionDetails = void 0;
 const package_json_1 = __importDefault(require("../../package.json"));
+const logger_1 = require("../bin/logger");
 const sessionDetails = {
     sessionId: undefined,
     version: package_json_1.default.version,
@@ -30,7 +31,11 @@ function setSessionDetails({ sessionId, generationId, testCaseId, projectRepoNam
 exports.setSessionDetails = setSessionDetails;
 async function shouldStopSession() {
     const sessionState = await getSessionState();
-    return sessionState !== "started";
+    const shouldStopSession = sessionState !== "started";
+    if (shouldStopSession) {
+        new logger_1.CustomLogger().warn(`Generation to be stopped due to session state marked as ${sessionState}`);
+    }
+    return shouldStopSession;
 }
 exports.shouldStopSession = shouldStopSession;
 async function getSessionState() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-gen",
-  "version": "0.35.6",
+  "version": "0.35.9",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -63,7 +63,7 @@
     "clean": "tsc --build --clean",
     "lint": "eslint .",
     "test": "vitest run",
-    "e2e-test": "npx playwright test",
+    "test-browser": "npx playwright test",
     "test:watch": "vitest",
     "test:watch-files": "vitest $0 --watch"
   }

package/vitest.config.ts

@@ -6,5 +6,6 @@ dotenvConfig({ path: [".env.local", ".env"] });
 export default defineConfig({
   test: {
     setupFiles: ["dotenv/config"],
+    include: ["src/**/*.test.ts"],
   },
 });