playwright-cucumber-ts-steps 1.1.12 → 1.2.0

package/dist/backend/actions/find.js

@@ -1,230 +1,198 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StoreElementText = exports.FindTextareaByLabel = exports.FindInputByValue = exports.FindInputByPlaceholder = exports.FindInputByName = exports.FindInputById = exports.GetFocusedElement = exports.GetNthElement = exports.GetLastElement = exports.GetFirstElement = exports.FindButtonsByText = exports.FindHeadingsByText = exports.FindElementsBySelector = exports.FindElementByName = exports.FindHeadingByText = exports.FindLinkByText = exports.FindElementByAltText = exports.FindElementByLabel = exports.FindElementByPlaceholder = exports.FindElementByRole = exports.FindElementByTestId = exports.FindElementByTitle = exports.FindElementByText = exports.FindElementBySelector = void 0;
+exports.findElementBySelector = findElementBySelector;
+exports.findElementByText = findElementByText;
+exports.findElementByTitle = findElementByTitle;
+exports.findElementByTestId = findElementByTestId;
+exports.findElementByRole = findElementByRole;
+exports.findElementByPlaceholder = findElementByPlaceholder;
+exports.findElementByLabel = findElementByLabel;
+exports.findElementByAltText = findElementByAltText;
+exports.findLinkByText = findLinkByText;
+exports.findHeadingByText = findHeadingByText;
+exports.findElementByName = findElementByName;
+exports.findElementsBySelector = findElementsBySelector;
+exports.findHeadingsByText = findHeadingsByText;
+exports.findButtonsByText = findButtonsByText;
+exports.getFirstElement = getFirstElement;
+exports.getLastElement = getLastElement;
+exports.getNthElement = getNthElement;
+exports.getFocusedElement = getFocusedElement;
+exports.findInputById = findInputById;
+exports.findInputByName = findInputByName;
+exports.findInputByPlaceholder = findInputByPlaceholder;
+exports.findInputByValue = findInputByValue;
+exports.findTextareaByLabel = findTextareaByLabel;
+exports.storeElementText = storeElementText;
 const test_1 = require("@playwright/test");
 const registry_1 = require("../../core/registry");
 const state_1 = require("../utils/state");
-// =============================
-// 1. GENERAL FINDING (Single)
-// =============================
+// ==================================================
+// CORE FUNCTIONS
+// ==================================================
 /**
  * Finds a single element using a CSS or XPath selector.
  * Asserts that exactly one element is found.
- *
- * ```gherkin
+ * @example
  * When I find element by selector ".nav-bar"
- * ```
- *
  * @param selector - The CSS or XPath selector string.
  */
-exports.FindElementBySelector = (0, registry_1.Step)("I find element by selector {string}", async (page, selector) => {
+async function findElementBySelector(page, selector) {
     const element = page.locator(selector);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by selector: "${selector}"`);
-});
+}
 /**
  * Finds an element containing the exact text provided.
- *
- * ```gherkin
+ * @example
  * When I find element by text "Submit Order"
- * ```
- *
  * @param text - The exact text content to match.
  */
-exports.FindElementByText = (0, registry_1.Step)("I find element by text {string}", async (page, text) => {
+async function findElementByText(page, text) {
     const element = page.getByText(text, { exact: true });
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by exact text: "${text}"`);
-});
+}
 /**
  * Finds an element by its `title` attribute.
- *
- * ```gherkin
+ * @example
  * When I find element by title "Close Modal"
- * ```
- *
  * @param title - The value of the title attribute.
  */
-exports.FindElementByTitle = (0, registry_1.Step)("I find element by title {string}", async (page, title) => {
+async function findElementByTitle(page, title) {
     const element = page.getByTitle(title);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by title: "${title}"`);
-});
+}
 /**
  * Finds an element by its test ID (usually `data-testid`).
- *
- * ```gherkin
+ * @example
  * When I find element by testid "login-form"
- * ```
- *
  * @param testid - The data-testid attribute value.
  */
-exports.FindElementByTestId = (0, registry_1.Step)("I find element by testid {string}", async (page, testid) => {
+async function findElementByTestId(page, testid) {
     const element = page.getByTestId(testid);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by testid: "${testid}"`);
-});
+}
 /**
  * Finds an element by its ARIA role.
- *
- * ```gherkin
+ * @example
  * When I find element by role "button"
- * ```
- *
  * @param role - The ARIA role (e.g., "button", "link", "heading").
  */
-exports.FindElementByRole = (0, registry_1.Step)("I find element by role {string}", async (page, role) => {
+async function findElementByRole(page, role) {
     const element = page.getByRole(role);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by role: "${role}"`);
-});
+}
 /**
  * Finds an input element by its placeholder text.
- *
- * ```gherkin
+ * @example
  * When I find element by placeholder text "Enter your email"
- * ```
- *
  * @param text - The placeholder text value.
  */
-exports.FindElementByPlaceholder = (0, registry_1.Step)("I find element by placeholder text {string}", async (page, text) => {
+async function findElementByPlaceholder(page, text) {
     const element = page.getByPlaceholder(text);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by placeholder: "${text}"`);
-});
+}
 /**
  * Finds a form control associated with a specific label text.
- *
- * ```gherkin
+ * @example
  * When I find element by label text "Password"
- * ```
- *
  * @param label - The visible text of the label.
  */
-exports.FindElementByLabel = (0, registry_1.Step)("I find element by label text {string}", async (page, label) => {
+async function findElementByLabel(page, label) {
     const element = page.getByLabel(label);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by label: "${label}"`);
-});
+}
 /**
  * Finds an element (usually an image) by its alt text.
- *
- * ```gherkin
+ * @example
  * When I find element by alt text "Company Logo"
- * ```
- *
  * @param alt - The value of the alt attribute.
  */
-exports.FindElementByAltText = (0, registry_1.Step)("I find element by alt text {string}", async (page, alt) => {
+async function findElementByAltText(page, alt) {
     const element = page.getByAltText(alt);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by alt text: "${alt}"`);
-});
-// =============================
-// 2. SPECIFIC ELEMENTS (Link/Heading/Name)
-// =============================
+}
 /**
  * Finds a specific link by its visible text.
- * If multiple links match, selects the first one.
- *
- * ```gherkin
+ * @example
  * When I find link by text "Read More"
- * ```
- *
  * @param text - The visible text of the link.
  */
-exports.FindLinkByText = (0, registry_1.Step)("I find link by text {string}", async (page, text) => {
+async function findLinkByText(page, text) {
     const element = page.getByRole("link", { name: text });
-    // We use .first() here because links often have duplicates (e.g. footer/header)
-    // but strict mode usually prefers uniqueness.
     (0, state_1.setActiveElement)(page, element.first());
     console.log(`🔍 Found link by text: "${text}"`);
-});
+}
 /**
  * Finds a heading (h1-h6) by its text content.
- * If multiple headings match, selects the first one.
- *
- * ```gherkin
+ * @example
  * When I find heading by text "Dashboard"
- * ```
- *
  * @param text - The text content of the heading.
  */
-exports.FindHeadingByText = (0, registry_1.Step)("I find heading by text {string}", async (page, text) => {
+async function findHeadingByText(page, text) {
     const element = page.getByRole("heading", { name: text });
     (0, state_1.setActiveElement)(page, element.first());
     console.log(`🔍 Found heading by text: "${text}"`);
-});
+}
 /**
  * Finds an element by its `name` attribute.
- * Useful for form fields not easily accessible by label.
- *
- * ```gherkin
+ * @example
  * When I find element by name "csrf_token"
- * ```
- *
  * @param name - The value of the name attribute.
  */
-exports.FindElementByName = (0, registry_1.Step)("I find element by name {string}", async (page, name) => {
-    // Broad selector for name attribute
+async function findElementByName(page, name) {
     const element = page.locator(`[name="${name}"]`);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found element by name: "${name}"`);
-});
-// =============================
-// 3. GENERAL FINDING (Multiple)
-// =============================
+}
 /**
  * Finds all elements matching a CSS selector and stores them as a list.
- *
- * ```gherkin
+ * @example
  * When I find elements by selector "ul > li"
- * ```
- *
  * @param selector - The CSS selector.
  */
-exports.FindElementsBySelector = (0, registry_1.Step)("I find elements by selector {string}", async (page, selector) => {
+async function findElementsBySelector(page, selector) {
     const elements = page.locator(selector);
     const count = await elements.count();
     (0, state_1.setActiveElements)(page, elements);
     console.log(`🔍 Found ${count} elements with selector: "${selector}"`);
-});
+}
 /**
  * Finds all headings matching specific text.
- *
- * ```gherkin
+ * @example
  * When I find headings by text "Article Title"
- * ```
- *
  * @param text - The text to match headings against.
  */
-exports.FindHeadingsByText = (0, registry_1.Step)("I find headings by text {string}", async (page, text) => {
+async function findHeadingsByText(page, text) {
     const elements = page.getByRole("heading", { name: text });
     (0, state_1.setActiveElements)(page, elements);
     console.log(`🔍 Found headings matching "${text}"`);
-});
+}
 /**
  * Finds all buttons matching specific text.
  * Supports variable aliasing (e.g., "@buttonName").
- *
- * ```gherkin
+ * @example
  * When I find buttons by text "Add to Cart"
- * ```
- *
  * @param text - The button text or an alias (e.g., "@myBtn").
  */
-exports.FindButtonsByText = (0, registry_1.Step)("I find buttons by text {string}", async (page, text) => {
+async function findButtonsByText(page, text) {
     let searchText = text;
-    // Handle Alias
     if (text.startsWith("@")) {
         const alias = text.slice(1);
         const val = (0, state_1.getVariable)(page, alias);
@@ -235,128 +203,99 @@ exports.FindButtonsByText = (0, registry_1.Step)("I find buttons by text {string
     const elements = page.getByRole("button", { name: searchText });
     (0, state_1.setActiveElements)(page, elements);
     console.log(`🔍 Found buttons matching "${searchText}"`);
-});
-// =============================
-// 4. GET / REFINE SELECTION
-// =============================
+}
 /**
  * Selects the first element from the currently stored list of elements.
- *
- * ```gherkin
+ * @example
  * When I get first element
- * ```
  */
-exports.GetFirstElement = (0, registry_1.Step)("I get first element", async (page) => {
+async function getFirstElement(page) {
     const elements = (0, state_1.getActiveElements)(page);
     const element = elements.first();
     (0, state_1.setActiveElement)(page, element);
     console.log("👉 Selected FIRST element");
-});
+}
 /**
  * Selects the last element from the currently stored list of elements.
- *
- * ```gherkin
+ * @example
  * When I get last element
- * ```
  */
-exports.GetLastElement = (0, registry_1.Step)("I get last element", async (page) => {
+async function getLastElement(page) {
     const elements = (0, state_1.getActiveElements)(page);
     const element = elements.last();
     (0, state_1.setActiveElement)(page, element);
     console.log("👉 Selected LAST element");
-});
+}
 /**
  * Selects the nth element from the currently stored list.
  * Uses 1-based indexing (e.g., 1st, 2nd, 3rd).
- *
- * ```gherkin
+ * @example
  * When I get 2nd element
  * When I get 10th element
- * ```
- *
  * @param indexStr - The number captured from the regex (e.g., "2").
  */
-exports.GetNthElement = (0, registry_1.Step)(/^I get (\d+)(?:st|nd|rd|th) element$/, async (page, indexStr) => {
+async function getNthElement(page, indexStr) {
     const index = parseInt(indexStr, 10);
     const elements = (0, state_1.getActiveElements)(page);
     const count = await elements.count();
     if (index < 1 || index > count) {
         throw new Error(`❌ Cannot get element #${index} — only ${count} found.`);
     }
-    // Playwright is 0-based, Gherkin is 1-based
     const element = elements.nth(index - 1);
     (0, state_1.setActiveElement)(page, element);
     console.log(`👉 Selected element #${index}`);
-});
+}
 /**
  * Selects the element that currently has browser focus.
- *
- * ```gherkin
+ * @example
  * When I get focused element
- * ```
  */
-exports.GetFocusedElement = (0, registry_1.Step)("I get focused element", async (page) => {
-    // Use CSS selector for focused element
+async function getFocusedElement(page) {
     const element = page.locator("*:focus");
     (0, state_1.setActiveElement)(page, element);
     console.log("👉 Selected FOCUSED element");
-});
-// =============================
-// 5. INPUTS & TEXTAREAS SPECIFICS
-// =============================
+}
 /**
  * Finds an input field by its ID attribute.
- *
- * ```gherkin
+ * @example
  * When I find input by ID "user_email"
- * ```
- *
  * @param id - The ID string.
  */
-exports.FindInputById = (0, registry_1.Step)("I find input by ID {string}", async (page, id) => {
+async function findInputById(page, id) {
     const element = page.locator(`input#${id}`);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found input by ID: "${id}"`);
-});
+}
 /**
  * Finds an input field by its name attribute.
- *
- * ```gherkin
+ * @example
  * When I find input by name "password"
- * ```
- *
  * @param name - The name attribute value.
  */
-exports.FindInputByName = (0, registry_1.Step)("I find input by name {string}", async (page, name) => {
+async function findInputByName(page, name) {
     const element = page.locator(`input[name="${name}"]`);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found input by name: "${name}"`);
-});
+}
 /**
  * Finds an input field by its placeholder text.
- *
- * ```gherkin
+ * @example
  * When I find input by placeholder text "Search products..."
- * ```
- *
  * @param placeholder - The placeholder text.
  */
-exports.FindInputByPlaceholder = (0, registry_1.Step)("I find input by placeholder text {string}", async (page, placeholder) => {
+async function findInputByPlaceholder(page, placeholder) {
     const element = page.locator(`input[placeholder="${placeholder}"]`);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found input by placeholder: "${placeholder}"`);
-});
+}
 /**
  * Finds an input field that currently has a specific value.
  * Supports variable aliasing (e.g., "@storedValue").
- *
- * ```gherkin
+ * @example
  * When I find input by display value "John"
- * ```
- *
  * @param value - The value to match.
  */
-exports.FindInputByValue = (0, registry_1.Step)("I find input by display value {string}", async (page, value) => {
+async function findInputByValue(page, value) {
     let searchValue = value;
     if (value.startsWith("@")) {
         const alias = value.slice(1);
@@ -369,23 +308,17 @@ exports.FindInputByValue = (0, registry_1.Step)("I find input by display value {
     await (0, test_1.expect)(element).toBeVisible();
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found input with value: "${searchValue}"`);
-});
+}
 /**
  * Finds a textarea associated with a specific label.
- * Fallback mechanism attempts to find the textarea via label if the standard getByLabel returns a generic element.
- *
- * ```gherkin
+ * @example
  * When I find textarea by label text "Description"
- * ```
- *
  * @param label - The visible text of the label.
  */
-exports.FindTextareaByLabel = (0, registry_1.Step)("I find textarea by label text {string}", async (page, label) => {
+async function findTextareaByLabel(page, label) {
     const element = page.getByLabel(label).locator("textarea").first();
-    // Fallback if strict label matching fails, try locator strategy
     const count = await element.count();
     if (count === 0) {
-        // Try generic label finding
         const altElement = page.getByLabel(label);
         (0, state_1.setActiveElement)(page, altElement);
     }
@@ -393,23 +326,44 @@ exports.FindTextareaByLabel = (0, registry_1.Step)("I find textarea by label tex
         (0, state_1.setActiveElement)(page, element);
     }
     console.log(`🔍 Found textarea by label: "${label}"`);
-});
-// =============================
-// 6. UTILITIES (Store Text)
-// =============================
+}
 /**
  * Reads the text content of the currently active element and stores it in a variable.
- *
- * ```gherkin
+ * @example
  * When I store element text as "confirmationCode"
- * ```
- *
  * @param alias - The name of the variable to store the text in (without "@").
  */
-exports.StoreElementText = (0, registry_1.Step)("I store element text as {string}", async (page, alias) => {
+async function storeElementText(page, alias) {
     const element = (0, state_1.getActiveElement)(page);
     const text = await element.textContent();
     const cleanText = text?.trim() || "";
     (0, state_1.setVariable)(page, alias, cleanText);
     console.log(`💾 Stored text "${cleanText}" as variable "@${alias}"`);
-});
+}
+// ==================================================
+// GLUE STEPS
+// ==================================================
+(0, registry_1.Step)("I find element by selector {string}", findElementBySelector);
+(0, registry_1.Step)("I find element by text {string}", findElementByText);
+(0, registry_1.Step)("I find element by title {string}", findElementByTitle);
+(0, registry_1.Step)("I find element by testid {string}", findElementByTestId);
+(0, registry_1.Step)("I find element by role {string}", findElementByRole);
+(0, registry_1.Step)("I find element by placeholder text {string}", findElementByPlaceholder);
+(0, registry_1.Step)("I find element by label text {string}", findElementByLabel);
+(0, registry_1.Step)("I find element by alt text {string}", findElementByAltText);
+(0, registry_1.Step)("I find link by text {string}", findLinkByText);
+(0, registry_1.Step)("I find heading by text {string}", findHeadingByText);
+(0, registry_1.Step)("I find element by name {string}", findElementByName);
+(0, registry_1.Step)("I find elements by selector {string}", findElementsBySelector);
+(0, registry_1.Step)("I find headings by text {string}", findHeadingsByText);
+(0, registry_1.Step)("I find buttons by text {string}", findButtonsByText);
+(0, registry_1.Step)("I get first element", getFirstElement);
+(0, registry_1.Step)("I get last element", getLastElement);
+(0, registry_1.Step)(/^I get (\d+)(?:st|nd|rd|th) element$/, getNthElement);
+(0, registry_1.Step)("I get focused element", getFocusedElement);
+(0, registry_1.Step)("I find input by ID {string}", findInputById);
+(0, registry_1.Step)("I find input by name {string}", findInputByName);
+(0, registry_1.Step)("I find input by placeholder text {string}", findInputByPlaceholder);
+(0, registry_1.Step)("I find input by display value {string}", findInputByValue);
+(0, registry_1.Step)("I find textarea by label text {string}", findTextareaByLabel);
+(0, registry_1.Step)("I store element text as {string}", storeElementText);

package/dist/backend/actions/form.d.ts

@@ -1,29 +1,6 @@
 /**
- * A "Swiss Army Knife" step for filling forms, performing assertions, and executing mixed workflows.
- * It iterates through a Data Table and performs actions based on the `Target` and `Value` columns.
- *
- * ```gherkin
- * When I fill the following {string} form data
- * ```
- *
- * @remarks
- * **Columns:**
- * - `Target`: The CSS selector, or a special keyword (request:, set:localStorage:, wait).
- * - `Value`: The value to input, the action (click, check), or assertion pattern.
- *
- * **Supported UI Actions:**
- * - **Fill:** Default behavior. Types `Value` into `Target`.
- * - **Click:** Set `Value` to "click".
- * - **Check:** Set `Value` to "check".
- * - **Select:** Set `Value` to "select" (selects first option).
- * - **Assert Visible:** Set `Value` to "assert:visible".
- * - **Assert Text:** Set `Value` to "assert:text:Expected Text".
- *
- * **Supported Special Actions:**
- * - **API Request:** Target = `request:METHOD:URL`, Value = `payload_filename.json`.
- * - **Local Storage:** Target = `set:localStorage:key`, Value = `value`.
- * - **Wait:** Target = `wait`, Value = `wait:1000` (ms).
- *
+ * A "Swiss Army Knife" function for filling forms, performing assertions, and executing mixed workflows.
+ * Iterates through a Data Table and performs actions based on the Target and Value columns.
  * @example
  * When I fill the following "Login Flow" form data:
  * | Target                  | Value                |
@@ -33,6 +10,21 @@
  * | wait                    | wait:500             |
  * | .error-msg              | assert:visible       |
  * | request:GET:/api/status | body: {}             |
+ * @remarks
+ * **Columns:**
+ * - Target: The CSS selector, or a special keyword (request:, set:localStorage:, wait).
+ * - Value: The value to input, the action (click, check), or assertion pattern.
+ * **Supported UI Actions:**
+ * - Fill: Default behavior. Types Value into Target.
+ * - Click: Set Value to "click".
+ * - Check: Set Value to "check".
+ * - Select: Set Value to "select".
+ * - Assert Visible: Set Value to "assert:visible".
+ * - Assert Text: Set Value to "assert:text:Expected Text".
+ * **Supported Special Actions:**
+ * - API Request: Target = "request:METHOD:URL", Value = "payload_filename.json".
+ * - Local Storage: Target = "set:localStorage:key", Value = "value".
+ * - Wait: Target = "wait", Value = "wait:1000" (ms).
  */
-export declare const FillFormData: void;
+export declare function fillFormData(page: any, formName: string, table: any): Promise<void>;
 //# sourceMappingURL=form.d.ts.map

package/dist/backend/actions/form.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../src/backend/actions/form.ts"],"names":[],"mappings":"AAkFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,YAAY,MAgIxB,CAAC"}
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../src/backend/actions/form.ts"],"names":[],"mappings":"AAuFA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CA6HzF"}