playwright-cucumber-ts-steps 1.1.8 → 1.1.9

package/dist/backend/actions/find.js

@@ -1,5 +1,6 @@
 "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;
 const test_1 = require("@playwright/test");
 const registry_1 = require("../../core/registry");
 const state_1 = require("../utils/state");
@@ -7,80 +8,121 @@ const state_1 = require("../utils/state");
 // 1. GENERAL FINDING (Single)
 // =============================
 /**
- * Finds an element by CSS selector.
- * Pattern: When I find element by selector ".my-class"
+ * Finds a single element using a CSS or XPath selector.
+ * Asserts that exactly one element is found.
+ *
+ * ```gherkin
+ * When I find element by selector ".nav-bar"
+ * ```
+ *
+ * @param selector - The CSS or XPath selector string.
  */
-(0, registry_1.Step)("I find element by selector {string}", async (page, selector) => {
+exports.FindElementBySelector = (0, registry_1.Step)("I find element by selector {string}", async (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 by exact text.
- * Pattern: When I find element by text "Submit"
+ * Finds an element containing the exact text provided.
+ *
+ * ```gherkin
+ * When I find element by text "Submit Order"
+ * ```
+ *
+ * @param text - The exact text content to match.
  */
-(0, registry_1.Step)("I find element by text {string}", async (page, text) => {
+exports.FindElementByText = (0, registry_1.Step)("I find element by text {string}", async (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 title attribute.
- * Pattern: When I find element by title "Tooltip"
+ * Finds an element by its `title` attribute.
+ *
+ * ```gherkin
+ * When I find element by title "Close Modal"
+ * ```
+ *
+ * @param title - The value of the title attribute.
  */
-(0, registry_1.Step)("I find element by title {string}", async (page, title) => {
+exports.FindElementByTitle = (0, registry_1.Step)("I find element by title {string}", async (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 test id (data-testid).
- * Pattern: When I find element by testid "submit-btn"
+ * Finds an element by its test ID (usually `data-testid`).
+ *
+ * ```gherkin
+ * When I find element by testid "login-form"
+ * ```
+ *
+ * @param testid - The data-testid attribute value.
  */
-(0, registry_1.Step)("I find element by testid {string}", async (page, testid) => {
+exports.FindElementByTestId = (0, registry_1.Step)("I find element by testid {string}", async (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 ARIA role.
- * Pattern: When I find element by role "button"
+ * Finds an element by its ARIA role.
+ *
+ * ```gherkin
+ * When I find element by role "button"
+ * ```
+ *
+ * @param role - The ARIA role (e.g., "button", "link", "heading").
  */
-(0, registry_1.Step)("I find element by role {string}", async (page, role) => {
+exports.FindElementByRole = (0, registry_1.Step)("I find element by role {string}", async (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 element by placeholder.
- * Pattern: When I find element by placeholder text "Search..."
+ * Finds an input element by its placeholder text.
+ *
+ * ```gherkin
+ * When I find element by placeholder text "Enter your email"
+ * ```
+ *
+ * @param text - The placeholder text value.
  */
-(0, registry_1.Step)("I find element by placeholder text {string}", async (page, text) => {
+exports.FindElementByPlaceholder = (0, registry_1.Step)("I find element by placeholder text {string}", async (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 an element by label.
- * Pattern: When I find element by label text "Username"
+ * Finds a form control associated with a specific label text.
+ *
+ * ```gherkin
+ * When I find element by label text "Password"
+ * ```
+ *
+ * @param label - The visible text of the label.
  */
-(0, registry_1.Step)("I find element by label text {string}", async (page, label) => {
+exports.FindElementByLabel = (0, registry_1.Step)("I find element by label text {string}", async (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 by alt text (images).
- * Pattern: When I find element by alt text "Logo"
+ * Finds an element (usually an image) by its alt text.
+ *
+ * ```gherkin
+ * When I find element by alt text "Company Logo"
+ * ```
+ *
+ * @param alt - The value of the alt attribute.
  */
-(0, registry_1.Step)("I find element by alt text {string}", async (page, alt) => {
+exports.FindElementByAltText = (0, registry_1.Step)("I find element by alt text {string}", async (page, alt) => {
     const element = page.getByAltText(alt);
     await (0, test_1.expect)(element).toHaveCount(1);
     (0, state_1.setActiveElement)(page, element);
@@ -90,10 +132,16 @@ const state_1 = require("../utils/state");
 // 2. SPECIFIC ELEMENTS (Link/Heading/Name)
 // =============================
 /**
- * Finds a link by text.
- * Pattern: When I find link by text "Home"
+ * Finds a specific link by its visible text.
+ * If multiple links match, selects the first one.
+ *
+ * ```gherkin
+ * When I find link by text "Read More"
+ * ```
+ *
+ * @param text - The visible text of the link.
  */
-(0, registry_1.Step)("I find link by text {string}", async (page, text) => {
+exports.FindLinkByText = (0, registry_1.Step)("I find link by text {string}", async (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.
@@ -101,19 +149,31 @@ const state_1 = require("../utils/state");
     console.log(`🔍 Found link by text: "${text}"`);
 });
 /**
- * Finds a heading by text.
- * Pattern: When I find heading by text "Welcome"
+ * Finds a heading (h1-h6) by its text content.
+ * If multiple headings match, selects the first one.
+ *
+ * ```gherkin
+ * When I find heading by text "Dashboard"
+ * ```
+ *
+ * @param text - The text content of the heading.
  */
-(0, registry_1.Step)("I find heading by text {string}", async (page, text) => {
+exports.FindHeadingByText = (0, registry_1.Step)("I find heading by text {string}", async (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 name attribute.
- * Pattern: When I find element by name "email"
+ * Finds an element by its `name` attribute.
+ * Useful for form fields not easily accessible by label.
+ *
+ * ```gherkin
+ * When I find element by name "csrf_token"
+ * ```
+ *
+ * @param name - The value of the name attribute.
  */
-(0, registry_1.Step)("I find element by name {string}", async (page, name) => {
+exports.FindElementByName = (0, registry_1.Step)("I find element by name {string}", async (page, name) => {
     // Broad selector for name attribute
     const element = page.locator(`[name="${name}"]`);
     await (0, test_1.expect)(element).toHaveCount(1);
@@ -124,29 +184,45 @@ const state_1 = require("../utils/state");
 // 3. GENERAL FINDING (Multiple)
 // =============================
 /**
- * Finds all elements by selector.
- * Pattern: When I find elements by selector ".items"
+ * Finds all elements matching a CSS selector and stores them as a list.
+ *
+ * ```gherkin
+ * When I find elements by selector "ul > li"
+ * ```
+ *
+ * @param selector - The CSS selector.
  */
-(0, registry_1.Step)("I find elements by selector {string}", async (page, selector) => {
+exports.FindElementsBySelector = (0, registry_1.Step)("I find elements by selector {string}", async (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 by text.
- * Pattern: When I find headings by text "Chapter"
+ * Finds all headings matching specific text.
+ *
+ * ```gherkin
+ * When I find headings by text "Article Title"
+ * ```
+ *
+ * @param text - The text to match headings against.
  */
-(0, registry_1.Step)("I find headings by text {string}", async (page, text) => {
+exports.FindHeadingsByText = (0, registry_1.Step)("I find headings by text {string}", async (page, text) => {
     const elements = page.getByRole("heading", { name: text });
     (0, state_1.setActiveElements)(page, elements);
     console.log(`🔍 Found headings matching "${text}"`);
 });
 /**
- * Finds all buttons by text (supports alias).
- * Pattern: When I find buttons by text "Save"
+ * Finds all buttons matching specific text.
+ * Supports variable aliasing (e.g., "@buttonName").
+ *
+ * ```gherkin
+ * When I find buttons by text "Add to Cart"
+ * ```
+ *
+ * @param text - The button text or an alias (e.g., "@myBtn").
  */
-(0, registry_1.Step)("I find buttons by text {string}", async (page, text) => {
+exports.FindButtonsByText = (0, registry_1.Step)("I find buttons by text {string}", async (page, text) => {
     let searchText = text;
     // Handle Alias
     if (text.startsWith("@")) {
@@ -164,30 +240,43 @@ const state_1 = require("../utils/state");
 // 4. GET / REFINE SELECTION
 // =============================
 /**
- * Gets the first element from a stored list.
- * Pattern: When I get first element
+ * Selects the first element from the currently stored list of elements.
+ *
+ * ```gherkin
+ * When I get first element
+ * ```
  */
-(0, registry_1.Step)("I get first element", async (page) => {
+exports.GetFirstElement = (0, registry_1.Step)("I get first element", async (page) => {
     const elements = (0, state_1.getActiveElements)(page);
     const element = elements.first();
     (0, state_1.setActiveElement)(page, element);
     console.log("👉 Selected FIRST element");
 });
 /**
- * Gets the last element from a stored list.
- * Pattern: When I get last element
+ * Selects the last element from the currently stored list of elements.
+ *
+ * ```gherkin
+ * When I get last element
+ * ```
  */
-(0, registry_1.Step)("I get last element", async (page) => {
+exports.GetLastElement = (0, registry_1.Step)("I get last element", async (page) => {
     const elements = (0, state_1.getActiveElements)(page);
     const element = elements.last();
     (0, state_1.setActiveElement)(page, element);
     console.log("👉 Selected LAST element");
 });
 /**
- * Gets the nth element (1-based index).
- * Pattern: When I get 2nd element
+ * Selects the nth element from the currently stored list.
+ * Uses 1-based indexing (e.g., 1st, 2nd, 3rd).
+ *
+ * ```gherkin
+ * When I get 2nd element
+ * When I get 10th element
+ * ```
+ *
+ * @param indexStr - The number captured from the regex (e.g., "2").
  */
-(0, registry_1.Step)(/^I get (\d+)(?:st|nd|rd|th) element$/, async (page, indexStr) => {
+exports.GetNthElement = (0, registry_1.Step)(/^I get (\d+)(?:st|nd|rd|th) element$/, async (page, indexStr) => {
     const index = parseInt(indexStr, 10);
     const elements = (0, state_1.getActiveElements)(page);
     const count = await elements.count();
@@ -200,10 +289,13 @@ const state_1 = require("../utils/state");
     console.log(`👉 Selected element #${index}`);
 });
 /**
- * Gets the currently focused element.
- * Pattern: When I get focused element
+ * Selects the element that currently has browser focus.
+ *
+ * ```gherkin
+ * When I get focused element
+ * ```
  */
-(0, registry_1.Step)("I get focused element", async (page) => {
+exports.GetFocusedElement = (0, registry_1.Step)("I get focused element", async (page) => {
     // Use CSS selector for focused element
     const element = page.locator("*:focus");
     (0, state_1.setActiveElement)(page, element);
@@ -213,37 +305,58 @@ const state_1 = require("../utils/state");
 // 5. INPUTS & TEXTAREAS SPECIFICS
 // =============================
 /**
- * Finds input by ID.
- * Pattern: When I find input by ID "username"
+ * Finds an input field by its ID attribute.
+ *
+ * ```gherkin
+ * When I find input by ID "user_email"
+ * ```
+ *
+ * @param id - The ID string.
  */
-(0, registry_1.Step)("I find input by ID {string}", async (page, id) => {
+exports.FindInputById = (0, registry_1.Step)("I find input by ID {string}", async (page, id) => {
     const element = page.locator(`input#${id}`);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found input by ID: "${id}"`);
 });
 /**
- * Finds input by name.
- * Pattern: When I find input by name "email"
+ * Finds an input field by its name attribute.
+ *
+ * ```gherkin
+ * When I find input by name "password"
+ * ```
+ *
+ * @param name - The name attribute value.
  */
-(0, registry_1.Step)("I find input by name {string}", async (page, name) => {
+exports.FindInputByName = (0, registry_1.Step)("I find input by name {string}", async (page, name) => {
     const element = page.locator(`input[name="${name}"]`);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found input by name: "${name}"`);
 });
 /**
- * Finds input by placeholder.
- * Pattern: When I find input by placeholder text "Enter email"
+ * Finds an input field by its placeholder text.
+ *
+ * ```gherkin
+ * When I find input by placeholder text "Search products..."
+ * ```
+ *
+ * @param placeholder - The placeholder text.
  */
-(0, registry_1.Step)("I find input by placeholder text {string}", async (page, placeholder) => {
+exports.FindInputByPlaceholder = (0, registry_1.Step)("I find input by placeholder text {string}", async (page, placeholder) => {
     const element = page.locator(`input[placeholder="${placeholder}"]`);
     (0, state_1.setActiveElement)(page, element);
     console.log(`🔍 Found input by placeholder: "${placeholder}"`);
 });
 /**
- * Finds input by display value (supports alias).
- * Pattern: When I find input by display value "John Doe"
+ * Finds an input field that currently has a specific value.
+ * Supports variable aliasing (e.g., "@storedValue").
+ *
+ * ```gherkin
+ * When I find input by display value "John"
+ * ```
+ *
+ * @param value - The value to match.
  */
-(0, registry_1.Step)("I find input by display value {string}", async (page, value) => {
+exports.FindInputByValue = (0, registry_1.Step)("I find input by display value {string}", async (page, value) => {
     let searchValue = value;
     if (value.startsWith("@")) {
         const alias = value.slice(1);
@@ -258,10 +371,16 @@ const state_1 = require("../utils/state");
     console.log(`🔍 Found input with value: "${searchValue}"`);
 });
 /**
- * Finds textarea by label.
- * Pattern: When I find textarea by label text "Comments"
+ * 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
+ * When I find textarea by label text "Description"
+ * ```
+ *
+ * @param label - The visible text of the label.
  */
-(0, registry_1.Step)("I find textarea by label text {string}", async (page, label) => {
+exports.FindTextareaByLabel = (0, registry_1.Step)("I find textarea by label text {string}", async (page, label) => {
     const element = page.getByLabel(label).locator("textarea").first();
     // Fallback if strict label matching fails, try locator strategy
     const count = await element.count();
@@ -279,10 +398,15 @@ const state_1 = require("../utils/state");
 // 6. UTILITIES (Store Text)
 // =============================
 /**
- * Stores the text of the current element into a variable.
- * Pattern: When I store element text as "myVar"
+ * Reads the text content of the currently active element and stores it in a variable.
+ *
+ * ```gherkin
+ * When I store element text as "confirmationCode"
+ * ```
+ *
+ * @param alias - The name of the variable to store the text in (without "@").
  */
-(0, registry_1.Step)("I store element text as {string}", async (page, alias) => {
+exports.StoreElementText = (0, registry_1.Step)("I store element text as {string}", async (page, alias) => {
     const element = (0, state_1.getActiveElement)(page);
     const text = await element.textContent();
     const cleanText = text?.trim() || "";

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

@@ -1,2 +1,38 @@
-export {};
+/**
+ * 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).
+ *
+ * @example
+ * When I fill the following "Login Flow" form data:
+ * | Target                  | Value                |
+ * | #username               | myuser               |
+ * | #password               | @secretPassword      |
+ * | #login-btn              | click                |
+ * | wait                    | wait:500             |
+ * | .error-msg              | assert:visible       |
+ * | request:GET:/api/status | body: {}             |
+ */
+export declare const FillFormData: 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":""}
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../src/backend/actions/form.ts"],"names":[],"mappings":"AAkFA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,YAAY,MAgIxB,CAAC"}

package/dist/backend/actions/form.js

@@ -33,14 +33,19 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FillFormData = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const test_1 = require("@playwright/test");
 const registry_1 = require("../../core/registry");
 const state_1 = require("../utils/state");
 /**
- * Helper to convert raw runner table into Objects (ActionRow[])
- * Handles whitespace in headers (e.g., "| Target |" -> "Target")
+ * Helper to convert raw runner table into Objects (ActionRow[]).
+ * Handles whitespace in headers (e.g., "| Target |" -> "Target").
+ * Supports both Cucumber DataTables (hashes) and Raw Arrays (Custom Runner).
+ *
+ * @param table - The raw table object from the test runner.
+ * @returns An array of ActionRow objects.
  */
 function parseDataTable(table) {
     // Debug Log: See exactly what the runner is passing
@@ -65,6 +70,14 @@ function parseDataTable(table) {
     }
     return [];
 }
+/**
+ * Helper to resolve values, handling variable aliases.
+ * If a value starts with "@", it retrieves it from the global state.
+ *
+ * @param page - The Playwright Page object (for context).
+ * @param rawValue - The value string from the Gherkin table.
+ * @returns The resolved string value.
+ */
 function resolveValue(page, rawValue) {
     if (!rawValue)
         return "";
@@ -81,7 +94,43 @@ function resolveValue(page, rawValue) {
     }
     return trimmed;
 }
-(0, registry_1.Step)("I fill the following {string} form data", async (page, formName, table) => {
+/**
+ * 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).
+ *
+ * @example
+ * When I fill the following "Login Flow" form data:
+ * | Target                  | Value                |
+ * | #username               | myuser               |
+ * | #password               | @secretPassword      |
+ * | #login-btn              | click                |
+ * | wait                    | wait:500             |
+ * | .error-msg              | assert:visible       |
+ * | request:GET:/api/status | body: {}             |
+ */
+exports.FillFormData = (0, registry_1.Step)("I fill the following {string} form data", async (page, formName, table) => {
     console.log(`📝 Processing Form: "${formName}"`);
     // Parse the table
     const rows = parseDataTable(table);
@@ -101,6 +150,7 @@ function resolveValue(page, rawValue) {
         // ============================================
         // 1. SPECIAL ACTIONS
         // ============================================
+        // ✅ API Requests
         if (target.startsWith("request:")) {
             const parts = target.replace("request:", "").split(":");
             const method = parts[0].toUpperCase();
@@ -126,6 +176,7 @@ function resolveValue(page, rawValue) {
             }
             continue;
         }
+        // ✅ Local Storage
         if (target.startsWith("set:localStorage:")) {
             const key = target.split(":")[2];
             await page.evaluate(({ k, v }) => localStorage.setItem(k, v), {
@@ -135,6 +186,7 @@ function resolveValue(page, rawValue) {
             console.log(`📦 localStorage: Set "${key}"`);
             continue;
         }
+        // ✅ Explicit Waits
         if (target === "wait") {
             const time = parseInt(rawValue.replace("wait:", ""), 10);
             if (!isNaN(time)) {

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

@@ -1,2 +1,26 @@
-export {};
+/**
+ * Iterates through a provided Data Table to fill inputs, click elements, or perform assertions.
+ * This step is designed for bulk form interaction without writing repetitive "When I..." steps.
+ *
+ * ```gherkin
+ * When I fill the following "Login" test form data
+ * | #username | tomsmith |
+ * | #password | SuperSecretPassword! |
+ * | #login    | click |
+ * ```
+ *
+ * @param formName - A descriptive name for the form being filled (used for logging only).
+ * @param tableData - A 2D array representing the data table rows (automatically passed by the runner).
+ *
+ * @remarks
+ * **Supported Values in Column 2:**
+ * - `Any String`: Fills the input found by the selector in Column 1.
+ * - `"click"`: Clicks the element.
+ * - `"check"`: Checks a checkbox or radio button.
+ * - `"assert:visible"`: Asserts that the element is visible.
+ * - `"assert:text:EXPECTED"`: Asserts that the element contains the specific text.
+ *
+ * @throws {Error} If the Data Table is missing or invalid.
+ */
+export declare const FillTestFormData: void;
 //# sourceMappingURL=formTable.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"formTable.d.ts","sourceRoot":"","sources":["../../../src/backend/actions/formTable.ts"],"names":[],"mappings":""}
+{"version":3,"file":"formTable.d.ts","sourceRoot":"","sources":["../../../src/backend/actions/formTable.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,gBAAgB,MA8B5B,CAAC"}

package/dist/backend/actions/formTable.js

@@ -1,12 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const registry_1 = require("../../core/registry");
+exports.FillTestFormData = void 0;
 const test_1 = require("@playwright/test");
-// CHANGE: Removed the ':' at the end of the string below
-(0, registry_1.Step)("I fill the following {string} test form data", async (page, formName, tableData) => {
+const registry_1 = require("../../core/registry");
+/**
+ * Iterates through a provided Data Table to fill inputs, click elements, or perform assertions.
+ * This step is designed for bulk form interaction without writing repetitive "When I..." steps.
+ *
+ * ```gherkin
+ * When I fill the following "Login" test form data
+ * | #username | tomsmith |
+ * | #password | SuperSecretPassword! |
+ * | #login    | click |
+ * ```
+ *
+ * @param formName - A descriptive name for the form being filled (used for logging only).
+ * @param tableData - A 2D array representing the data table rows (automatically passed by the runner).
+ *
+ * @remarks
+ * **Supported Values in Column 2:**
+ * - `Any String`: Fills the input found by the selector in Column 1.
+ * - `"click"`: Clicks the element.
+ * - `"check"`: Checks a checkbox or radio button.
+ * - `"assert:visible"`: Asserts that the element is visible.
+ * - `"assert:text:EXPECTED"`: Asserts that the element contains the specific text.
+ *
+ * @throws {Error} If the Data Table is missing or invalid.
+ */
+exports.FillTestFormData = (0, registry_1.Step)("I fill the following {string} test form data", async (page, formName, tableData) => {
     console.log(`📝 Processing Form: ${formName}`);
-    // The runner passes the table data as the last argument
-    // tableData = [ ['#username', 'tomsmith'], ['#password', '...'] ]
     // Guard clause: Ensure tableData exists to prevent crashes if user forgets the table
     if (!tableData || !Array.isArray(tableData)) {
         throw new Error(`❌ The step "I fill the following '${formName}' form data" requires a Data Table below it.`);