playwright-cucumber-ts-steps 0.1.7 → 1.0.0

package/lib/actions/cookieSteps.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// e2e/step_definitions/common/actions/cookieSteps.ts
-const cucumber_1 = require("@cucumber/cucumber");
-(0, cucumber_1.When)("I clear all cookies", async function () {
-    await this.page.context().clearCookies();
-    this.log("Cleared all cookies");
-});
-(0, cucumber_1.When)("I clear cookies", async function () {
-    await this.page.context().clearCookies();
-    this.log("Cleared cookies (alias)");
-});
-(0, cucumber_1.When)("I clear cookie {string}", async function (name) {
-    await this.page.context().addCookies([
-        {
-            name,
-            value: "",
-            domain: new URL(this.page.url()).hostname,
-            path: "/",
-            expires: 0,
-        },
-    ]);
-    this.log(`Cleared cookie: ${name}`);
-});
-(0, cucumber_1.When)("I log all cookies", async function () {
-    const cookies = await this.page.context().cookies();
-    console.log("Cookies:", cookies);
-});

package/lib/actions/debugSteps.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/actions/debugSteps.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// e2e/step_definitions/common/actions/debugSteps.ts
-const cucumber_1 = require("@cucumber/cucumber");
-(0, cucumber_1.When)("I debug with message {string}", async function (message) {
-    await this.page.pause();
-    this.log(`Paused test for debugging: ${message}`);
-});

package/lib/actions/elementFindSteps.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/actions/elementFindSteps.js

@@ -1,217 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cucumber_1 = require("@cucumber/cucumber");
-const test_1 = require("@playwright/test");
-// =============================
-// WHEN I FIND ELEMENT(S)
-// =============================
-(0, cucumber_1.When)("I find element by selector {string}", async function (selector) {
-    this.element = this.page.locator(selector);
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find link by text {string}", async function (text) {
-    this.currentLocator = this.getScope().getByRole("link", { name: text });
-});
-(0, cucumber_1.When)("I find heading by text {string}", async function (text) {
-    this.currentLocator = this.getScope().getByRole("heading", { name: text });
-});
-(0, cucumber_1.When)("I find headings by text {string}", async function (text) {
-    this.currentLocator = this.getScope().getByRole("heading", { name: text });
-});
-(0, cucumber_1.When)("I find elements by selector {string}", async function (selector) {
-    this.elements = this.page.locator(selector);
-    const count = await this.elements.count();
-    this.log?.(`Found ${count} elements with selector ${selector}`);
-});
-(0, cucumber_1.When)("I find element by text {string}", async function (text) {
-    this.element = this.page.getByText(text, { exact: true });
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find element by title {string}", async function (title) {
-    this.element = this.page.getByTitle(title);
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find element by testid {string}", async function (testid) {
-    this.element = this.page.getByTestId(testid);
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find element by role {string}", async function (role) {
-    this.element = this.page.getByRole(role);
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find element by placeholder text {string}", async function (text) {
-    this.element = this.page.getByPlaceholder(text);
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find element by label text {string}", async function (label) {
-    this.element = this.page.getByLabel(label);
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find elements by label text {string}", async function (label) {
-    this.currentLocator = this.getScope().getByLabel(label);
-});
-(0, cucumber_1.When)("I find element by alt text {string}", async function (alt) {
-    this.element = this.page.getByAltText(alt);
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find element by name {string}", async function (name) {
-    this.element = this.page.getByRole("textbox", { name });
-    await (0, test_1.expect)(this.element).toHaveCount(1);
-});
-(0, cucumber_1.When)("I find elements by name {string}", async function (name) {
-    this.currentLocator = this.getScope().locator(`[name="${name}"]`);
-});
-(0, cucumber_1.When)("I find buttons by text {string}", async function (buttonText) {
-    // 🧠 Resolve alias
-    if (buttonText.startsWith("@")) {
-        const alias = buttonText.slice(1);
-        buttonText = this.data?.[alias];
-        if (!buttonText) {
-            throw new Error(`No value found for alias "@${alias}"`);
-        }
-    }
-    // 🔍 Locate all matching buttons
-    this.elements = this.page.getByRole("button", {
-        name: buttonText,
-        exact: false,
-    });
-    this.log?.(`🔘 Stored all buttons matching text "${buttonText}"`);
-});
-// =============================
-// WHEN I GET ELEMENT(S)
-// =============================
-(0, cucumber_1.When)("I get element by selector {string}", async function (selector) {
-    this.element = this.page.locator(selector).first();
-});
-(0, cucumber_1.When)("I get elements by selector {string}", async function (selector) {
-    this.elements = this.page.locator(selector);
-});
-(0, cucumber_1.When)("I get first element", async function () {
-    if (!this.elements)
-        throw new Error("No element collection found");
-    this.element = this.elements.first();
-});
-(0, cucumber_1.When)("I get last element", async function () {
-    if (!this.elements)
-        throw new Error("No element collection found");
-    this.element = this.elements.last();
-});
-(0, cucumber_1.When)(/^I get (\d+)(?:st|nd|rd|th) element$/, async function (index) {
-    if (!this.elements)
-        throw new Error("No elements stored to pick from");
-    const count = await this.elements.count();
-    if (index < 1 || index > count) {
-        throw new Error(`Cannot get element ${index} — only ${count} found`);
-    }
-    this.element = this.elements.nth(index - 1);
-    this.log?.(`Selected ${index} element from stored elements`);
-});
-(0, cucumber_1.When)("I find elements by role {string}", async function (role) {
-    const locator = this.page.getByRole(role);
-    const count = await locator.count();
-    if (count === 0) {
-        throw new Error(`No elements found with role "${role}"`);
-    }
-    this.elements = locator;
-    this.log?.(`Stored ${count} elements with role "${role}"`);
-});
-(0, cucumber_1.When)("I get {int}rd element", async function (index) {
-    if (!this.elements)
-        throw new Error("No element collection found");
-    this.element = this.elements.nth(index);
-});
-(0, cucumber_1.When)("I get focused element", async function () {
-    this.element = (await this.page.evaluateHandle(() => document.activeElement));
-});
-(0, cucumber_1.When)("I store element text as {string}", async function (alias) {
-    const element = this.element;
-    if (!element)
-        throw new Error("No element selected");
-    const text = await element.textContent();
-    this.data[alias] = text?.trim();
-    this.log?.(`Stored text "${text}" as "${alias}"`);
-});
-(0, cucumber_1.When)("I find textarea by label text {string}", async function (label) {
-    this.element = this.page.getByLabel(label);
-    this.log?.(`Stored textarea with label "${label}"`);
-});
-(0, cucumber_1.When)("I find textarea by placeholder text {string}", async function (placeholder) {
-    this.element = this.page.getByPlaceholder(placeholder);
-    this.log?.(`Stored textarea with placeholder "${placeholder}"`);
-});
-(0, cucumber_1.When)("I find textareas by label text {string}", async function (label) {
-    this.elements = this.page.locator(`label:has-text("${label}") + textarea`);
-    this.log?.(`Stored multiple textareas with label "${label}"`);
-});
-(0, cucumber_1.When)("I find textarea by name {string}", async function (name) {
-    this.element = this.page.locator(`textarea[name="${name}"]`);
-    this.log?.(`Stored textarea with name "${name}"`);
-});
-(0, cucumber_1.When)("I find textareas by ID {string}", async function (id) {
-    this.elements = this.page.locator(`textarea#${id}`);
-    this.log?.(`Stored multiple textareas with ID "${id}"`);
-});
-(0, cucumber_1.When)("I find input by ID {string}", async function (id) {
-    this.element = this.page.locator(`input#${id}`);
-    this.log?.(`Stored input with ID "${id}"`);
-});
-(0, cucumber_1.When)("I find inputs by ID {string}", async function (id) {
-    this.elements = this.page.locator(`input#${id}`);
-    this.log?.(`Stored multiple inputs with ID "${id}"`);
-});
-(0, cucumber_1.When)("I find textareas by placeholder text {string}", async function (placeholder) {
-    this.elements = this.page.locator(`textarea[placeholder="${placeholder}"]`);
-    this.log?.(`Stored multiple textareas with placeholder "${placeholder}"`);
-});
-(0, cucumber_1.When)("I find input by label text {string}", async function (label) {
-    this.element = this.page.getByLabel(label);
-    this.log?.(`Stored input with label "${label}"`);
-});
-(0, cucumber_1.When)("I find input by name {string}", async function (name) {
-    this.element = this.page.locator(`input[name="${name}"]`);
-    this.log?.(`Stored input with name "${name}"`);
-});
-(0, cucumber_1.When)("I find input by placeholder text {string}", async function (placeholder) {
-    this.element = this.page.getByPlaceholder(placeholder);
-    this.log?.(`Stored input with placeholder "${placeholder}"`);
-});
-(0, cucumber_1.When)("I find inputs by name {string}", async function (name) {
-    this.elements = this.page.locator(`input[name="${name}"]`);
-    this.log?.(`Stored multiple inputs with name "${name}"`);
-});
-(0, cucumber_1.When)("I find inputs by placeholder text {string}", async function (placeholder) {
-    this.elements = this.page.locator(`input[placeholder="${placeholder}"]`);
-    this.log?.(`Stored multiple inputs with placeholder "${placeholder}"`);
-});
-(0, cucumber_1.When)("I find inputs by label text {string}", async function (label) {
-    this.elements = this.page.locator(`label:has-text("${label}") + input`);
-    this.log?.(`Stored multiple inputs with label "${label}"`);
-});
-(0, cucumber_1.When)("I find inputs by display value {string}", async function (value) {
-    // 🧠 Handle alias
-    if (value.startsWith("@")) {
-        const alias = value.slice(1);
-        value = this.data?.[alias];
-        if (!value) {
-            throw new Error(`No value found for alias "@${alias}"`);
-        }
-    }
-    // 🔍 Find all matching inputs
-    this.elements = this.page.locator(`input[value="${value}"]`);
-    this.log?.(`📦 Stored multiple inputs with display value "${value}"`);
-});
-(0, cucumber_1.When)("I find input by display value {string}", async function (value) {
-    // 🧠 Handle alias
-    if (value.startsWith("@")) {
-        const alias = value.slice(1);
-        value = this.data?.[alias];
-        if (!value) {
-            throw new Error(`No value found for alias "@${alias}"`);
-        }
-    }
-    // 🎯 Try to find input element with matching display value
-    const locator = this.page.locator(`input[value="${value}"]`);
-    await (0, test_1.expect)(locator).toBeVisible({ timeout: 5000 });
-    this.element = locator;
-    this.log?.(`🔍 Found input with value: "${value}"`);
-});

package/lib/actions/fillFormSteps.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/actions/fillFormSteps.js

@@ -1,130 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const cucumber_1 = require("@cucumber/cucumber");
-const test_1 = require("@playwright/test");
-const resolveUtils_1 = require("../helpers/utils/resolveUtils");
-(0, cucumber_1.When)("I fill the following {string} form data:", async function (_formName, dataTable) {
-    // const scope = this.frame ?? this.page;
-    const rows = dataTable.hashes();
-    for (const row of rows) {
-        const target = row.Target.trim();
-        const rawValue = row.Value.trim();
-        const locator = this.getLocator(target);
-        const value = (0, resolveUtils_1.resolveLoginValue)(rawValue, this);
-        // ✅ Assertions
-        if (rawValue.startsWith("assert:")) {
-            const [, type, expected] = rawValue.split(":");
-            if (type === "visible") {
-                await (0, test_1.expect)(locator).toBeVisible();
-            }
-            else if (type === "text") {
-                await (0, test_1.expect)(locator).toHaveText(expected ?? "", {
-                    useInnerText: true,
-                });
-            }
-            else if (type === "value") {
-                await (0, test_1.expect)(locator).toHaveValue(expected ?? "");
-            }
-            else {
-                throw new Error(`❌ Unknown assertion: ${type}`);
-            }
-            continue;
-        }
-        // ✅ UI interactions
-        if (rawValue === "click") {
-            await locator.click();
-            continue;
-        }
-        if (rawValue === "check") {
-            await locator.check();
-            continue;
-        }
-        if (rawValue === "uncheck") {
-            await locator.uncheck();
-            continue;
-        }
-        if (rawValue === "select") {
-            await locator.selectOption({ index: 0 });
-            continue;
-        }
-        // ✅ File upload
-        if (rawValue.startsWith("upload:")) {
-            const filePath = rawValue.split("upload:")[1].trim();
-            const resolvedPath = path_1.default.resolve(filePath);
-            if (!fs_1.default.existsSync(resolvedPath))
-                throw new Error(`File not found: ${filePath}`);
-            await locator.setInputFiles(resolvedPath);
-            continue;
-        }
-        // ✅ Drag and drop
-        if (rawValue.startsWith("drag:")) {
-            const targetSelector = rawValue.split("drag:")[1].trim();
-            const targetLocator = this.getLocator(targetSelector);
-            await locator.dragTo(targetLocator);
-            continue;
-        }
-        // ✅ Local/sessionStorage
-        if (rawValue.startsWith("set:localStorage:")) {
-            const [, , key] = rawValue.split(":");
-            if (typeof key !== "string" || !key) {
-                throw new Error("Local storage key must be a non-empty string");
-            }
-            await this.page.evaluate(([k, v]) => localStorage.setItem(k, v), [key, value ?? ""]);
-            continue;
-        }
-        if (rawValue.startsWith("set:sessionStorage:")) {
-            const [, , key] = rawValue.split(":");
-            if (typeof key !== "string" || key === undefined) {
-                throw new Error("Session storage key must be a string");
-            }
-            await this.page.evaluate((args) => {
-                const [k, v] = args;
-                sessionStorage.setItem(k, v);
-            }, [key, value ?? ""]);
-            continue;
-        }
-        // ✅ Wait
-        if (rawValue.startsWith("wait:")) {
-            const [, timeMs] = rawValue.split(":");
-            const waitTime = Number(timeMs);
-            if (!isNaN(waitTime)) {
-                await this.page.waitForTimeout(waitTime);
-            }
-            continue;
-        }
-        // ✅ Reload
-        if (rawValue === "reload") {
-            await this.page.reload();
-            continue;
-        }
-        // ✅ Request handling
-        if (rawValue.startsWith("request:")) {
-            const [, method, url, file] = rawValue.replace("request:", "").split(":");
-            const payloadDir = row.PayloadDir || this.parameters?.payloadDir || "payload";
-            const filePath = path_1.default.resolve(payloadDir, file);
-            if (!fs_1.default.existsSync(filePath)) {
-                throw new Error(`Payload file not found: ${filePath}`);
-            }
-            const payload = JSON.parse(fs_1.default.readFileSync(filePath, "utf-8"));
-            const response = await this.page.request[method.toLowerCase()](url, {
-                data: payload,
-            });
-            const responseBody = await response.json();
-            this.data.lastApiResponse = responseBody;
-            this.data.lastStatusCode = response.status();
-            if (row.SaveAs) {
-                this.data[row.SaveAs] = responseBody;
-            }
-            continue;
-        }
-        // ✅ Default: fill
-        if (value !== undefined) {
-            await locator.fill(String(value));
-        }
-    }
-});

package/lib/actions/inputSteps.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/actions/inputSteps.js

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// e2e/step_definitions/common/actions/inputSteps.ts
-// import fs from "fs";
-// import path from "path";
-const cucumber_1 = require("@cucumber/cucumber");
-const fakerUtils_1 = require("../helpers/utils/fakerUtils");
-const optionsUtils_1 = require("../helpers/utils/optionsUtils");
-(0, cucumber_1.When)("I check", async function (...rest) {
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseCheckOptions)(maybeTable) : {};
-    await this.element?.check(options);
-    this.log?.("✅ Checked stored checkbox");
-});
-(0, cucumber_1.When)("I uncheck", async function (...rest) {
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseCheckOptions)(maybeTable) : {};
-    await this.element?.uncheck(options);
-    this.log?.("✅ Unchecked stored checkbox");
-});
-(0, cucumber_1.When)("I check input", async function (...rest) {
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseCheckOptions)(maybeTable) : {};
-    if (!this.element)
-        throw new Error("No input selected");
-    await this.element.check(options);
-});
-(0, cucumber_1.When)("I uncheck input", async function (...rest) {
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseCheckOptions)(maybeTable) : {};
-    if (!this.element)
-        throw new Error("No input selected");
-    await this.element.uncheck(options);
-});
-// const DEFAULT_PAYLOAD_DIR = "payload";
-const typeStep = async function (textOrAlias, ...rest) {
-    if (!this.element)
-        throw new Error("No element selected");
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseFillOptions)(maybeTable) : {};
-    const text = textOrAlias.startsWith("@")
-        ? (this.data[textOrAlias.slice(1)] ??
-            (() => {
-                throw new Error(`No value found for alias "${textOrAlias}"`);
-            })())
-        : (0, fakerUtils_1.evaluateFaker)(textOrAlias);
-    await this.element.fill("");
-    await this.element.fill(text, options);
-    this.data.lastTyped = text;
-    this.log?.(`⌨️ Typed "${text}" into selected element`);
-};
-(0, cucumber_1.When)("I type {string}", typeStep);
-(0, cucumber_1.When)("I type stored {string}", typeStep);
-(0, cucumber_1.When)("I type random {string}", typeStep);
-(0, cucumber_1.When)("I set value {string}", async function (valueOrAlias, ...rest) {
-    if (!this.element)
-        throw new Error("No element selected");
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseFillOptions)(maybeTable) : {};
-    const value = valueOrAlias.startsWith("@")
-        ? (this.data[valueOrAlias.slice(1)] ??
-            (() => {
-                throw new Error(`No value found for alias "${valueOrAlias}"`);
-            })())
-        : (0, fakerUtils_1.evaluateFaker)(valueOrAlias);
-    await this.element.fill(value, options);
-    this.data.lastValueSet = value;
-    this.log?.(`📝 Set value to "${value}"`);
-});
-(0, cucumber_1.When)("I clear", async function () {
-    if (!this.element)
-        throw new Error("No element selected");
-    await this.element.fill("");
-    this.log?.("🧼 Cleared value of selected element");
-});
-(0, cucumber_1.When)("I submit", async function () {
-    // const maybeTable = rest[0];
-    const form = this.element ?? this.page.locator("form");
-    await form.evaluate((f) => f.submit());
-    this.log?.("📨 Submitted form");
-});
-(0, cucumber_1.When)("I select option {string}", async function (option, ...rest) {
-    if (!this.element)
-        throw new Error("No select element stored");
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseSelectOptions)(maybeTable) : {};
-    await this.element.selectOption({ label: option }, options);
-    this.log?.(`🔽 Selected option "${option}"`);
-});
-(0, cucumber_1.When)("I select file {string}", async function (filePath, ...rest) {
-    if (!this.element)
-        throw new Error("No file input selected");
-    const maybeTable = rest[0];
-    const options = maybeTable?.rowsHash ? (0, optionsUtils_1.parseSelectOptions)(maybeTable) : {};
-    await this.element.setInputFiles(filePath, options);
-    this.log?.(`📁 Set input file to "${filePath}"`);
-});

package/lib/actions/interceptionSteps.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/actions/interceptionSteps.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// e2e/step_definitions/common/interceptionSteps.ts
-const cucumber_1 = require("@cucumber/cucumber");
-let lastResponse;
-(0, cucumber_1.When)("I intercept URL {string} and stub body:", async function (url, body) {
-    let parsedBody;
-    try {
-        parsedBody = JSON.parse(body);
-    }
-    catch (e) {
-        const message = e instanceof Error ? e.message : String(e);
-        throw new Error(`Failed to parse JSON body: ${message}`);
-    }
-    await this.page.route(url, (route) => {
-        route.fulfill({
-            status: 200,
-            contentType: "application/json",
-            body: JSON.stringify(parsedBody),
-        });
-    });
-    this.log(`Intercepted and stubbed URL "${url}" with body: ${JSON.stringify(parsedBody)}`);
-});
-//Making Direct API Requests (Optional, Advanced)
-(0, cucumber_1.When)("I make request to {string}", async function (url) {
-    const response = await this.page.request.get(url);
-    const status = response.status();
-    const body = await response.text();
-    this.data.lastResponse = { status, body };
-    this.log(`Made GET request to "${url}" — Status: ${status}`);
-});
-(0, cucumber_1.When)("I make a POST request to {string} with JSON body:", async function (url, docString) {
-    let payload;
-    try {
-        payload = JSON.parse(docString);
-    }
-    catch (e) {
-        const message = e instanceof Error ? e.message : String(e);
-        throw new Error(`Invalid JSON: ${message}`);
-    }
-    const response = await this.page.request.post(url, { data: payload });
-    const status = response.status();
-    const body = await response.text();
-    this.data.lastResponse = { status, body };
-    this.log(`Made POST request to "${url}" — Status: ${status}`);
-});
-(0, cucumber_1.When)("I intercept URL {string}", async function (url) {
-    await this.page.route(url, async (route) => {
-        await route.continue();
-    });
-});
-(0, cucumber_1.When)("I intercept URL {string} and stub body {string}", async function (url, body) {
-    await this.page.route(url, (route) => {
-        route.fulfill({
-            status: 200,
-            contentType: "application/json",
-            body,
-        });
-    });
-});
-(0, cucumber_1.When)("I make a request to {string}", async function (url) {
-    const response = await this.page.request.get(url);
-    this.data.lastResponse = response;
-});
-(0, cucumber_1.When)('I make a "{word}" request to {string}', async function (method, url, table) {
-    const options = table ? Object.fromEntries(table.rows()) : {};
-    if (options.body)
-        options.body = JSON.stringify(JSON.parse(options.body));
-    const res = await fetch(url, { method, ...options });
-    lastResponse = res;
-});

package/lib/actions/miscSteps.d.ts

@@ -1 +0,0 @@
-export {};