playwright-cucumber-ts-steps 0.1.7 → 1.0.1

package/README.md

@@ -1,17 +1,22 @@
 # 🎭 playwright-cucumber-ts-steps
 
-[![npm version](https://img.shields.io/npm/v/playwright-cucumber-ts-steps.svg)](https://www.npmjs.com/package/playwright-cucumber-ts-steps)
-[![license](https://img.shields.io/npm/l/playwright-cucumber-ts-steps.svg)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/blob/main/LICENSE)
-[![build](https://img.shields.io/github/actions/workflow/status/qaPaschalE/playwright-cucumber-ts-steps/ci.yml?branch=main)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/actions)
-[![types](https://img.shields.io/npm/types/playwright-cucumber-ts-steps.svg)](https://www.npmjs.com/package/playwright-cucumber-ts-steps)
-[![GitHub issues](https://img.shields.io/github/issues/qaPaschalE/playwright-cucumber-ts-steps)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/issues)
-[![GitHub stars](https://img.shields.io/github/stars/qaPaschalE/playwright-cucumber-ts-steps)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/stargazers)
+[![NPM](https://nodei.co/npm/playwright-cucumber-ts-steps.png?downloads=true&downloadRank=true&stars=true&height=3)](https://nodei.co/npm/playwright-cucumber-ts-steps/)
 
-> A collection of reusable Playwright step definitions for Cucumber in TypeScript, designed to streamline end-to-end testing across web, API, and mobile applications.
+<table align="center" style="margin-bottom:30px;"><tr><td align="center" width="9999" heigth="9999" >
+ <img src="https://github.com/qaPaschalE/k6-cucumber-steps/blob/main/assets/paschal%20logo%20(2).png?raw=true" alt="paschal Logo" style="margin-top:25px;" align="center"/>
+</td></tr></table>
 
-Here's the updated **README** with all the latest features and corrections integrated into your `playwright-cucumber-ts-steps` package:
+[![npm](https://img.shields.io/npm/v/playwright-cucumber-ts-steps?logo=npm)](https://www.npmjs.com/package/playwright-cucumber-ts-steps)
+[![License](https://img.shields.io/github/license/qaPaschalE/playwright-cucumber-ts-steps?logo=github)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/blob/main/LICENSE)
+[![Node.js](https://img.shields.io/badge/node-%3E=18-green?logo=node.js)](https://nodejs.org/)
+[![Build Status](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/actions)
+[![TypeScript](https://img.shields.io/badge/types-TypeScript-blue?logo=typescript)](https://www.npmjs.com/package/playwright-cucumber-ts-steps)
+[![Issues](https://img.shields.io/github/issues/qaPaschalE/playwright-cucumber-ts-steps?logo=github)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/issues)
+[![Stars](https://img.shields.io/github/stars/qaPaschalE/playwright-cucumber-ts-steps?logo=github)](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/stargazers)
 
----
+> A collection of reusable Playwright step definitions for Cucumber in TypeScript, designed to streamline end-to-end testing across web, API, and mobile applications.
+
+> **Note:** This package is designed for advanced Cucumber+Playwright+TypeScript setups. For basic Playwright usage, see the [official Playwright docs](https://playwright.dev/).
 
 ## ✨ Features
 
@@ -54,6 +59,10 @@ npm install --save-dev @playwright/test @cucumber/cucumber typescript ts-node
 npx playwright install
 ```
 
+## 📘 Step Definition Documentation
+
+👉 [View Steps Documentation](https://qapaschale.github.io/playwright-cucumber-ts-steps/) and [examples](https://github.com/qaPaschale/playwright-cucumber-ts-steps/tree/master/playwright/e2e).
+
 ---
 
 ## 🛠️ Usage
@@ -229,8 +238,9 @@ const ARTIFACT_DIR = process.env.TEST_ARTIFACT_DIR || "test-artifacts";
 const defaultWorldParams = {
   artifactDir: ARTIFACT_DIR,
   payloadDir: "payloads",
-  enableScreenshots: process.env.ENABLE_SCREENSHOTS !== "false",
-  enableVideos: process.env.ENABLE_VIDEOS !== "false",
+  enableTrace: process.env.ENABLE_TRACE || "fail", // "false" | "fail" | "all"
+  enableScreenshots: process.env.ENABLE_SCREENSHOTS || "fail", // "false" | "fail" | "all"
+  enableVideos: process.env.ENABLE_VIDEOS || "all", // "false" | "fail" | "all"
   enableVisualTest: process.env.ENABLE_VISUAL_TEST === "true",
   device: process.env.MOBILE_DEVICE || undefined, // e.g., "Pixel 5"
 };

package/lib/actions/clickSteps.d.ts

@@ -1 +1,251 @@
-export {};
+import { DataTable } from "@cucumber/cucumber";
+import { CustomWorld } from "../helpers/world";
+/**
+ * Clicks on the previously stored element.
+ *
+ * ```gherkin
+ * When I click
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click
+ * ```
+ * @remarks
+ * Requires a previous step that stores an element.
+ * @category Click Steps
+ */
+export declare function When_I_click(this: CustomWorld, ...rest: any[]): Promise<void>;
+/**
+ * Clicks on an element matching the given selector.
+ *
+ * ```gherkin
+ * When I click on element {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click on element ".my-class"
+ * ```
+ * @remarks
+ * Stores the clicked element for later use.
+ * @category Click Steps
+ */
+export declare function When_I_click_on_element(this: CustomWorld, selector: string, ...rest: any[]): Promise<void>;
+/**
+ * Clicks on a button with the given label.
+ *
+ * ```gherkin
+ * When I click on button {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click on button "Submit"
+ * ```
+ * @remarks
+ * Stores the clicked button for later use.
+ * @category Click Steps
+ */
+export declare function When_I_click_on_button(this: CustomWorld, label: string, ...rest: any[]): Promise<void>;
+/**
+ * Clicks on a link with the given text.
+ *
+ * ```gherkin
+ * When I click on link {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click on link "Home"
+ * ```
+ * @remarks
+ * Stores the clicked link for later use.
+ * @category Click Steps
+ */
+export declare function When_I_click_on_link(this: CustomWorld, text: string, ...rest: any[]): Promise<void>;
+/**
+ * Clicks on a label with the given text.
+ *
+ * ```gherkin
+ * When I click on label {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click on label "Username"
+ * ```
+ * @remarks
+ * Stores the clicked label for later use.
+ * @category Click Steps
+ */
+export declare function When_I_click_on_label(this: CustomWorld, labelText: string, ...rest: any[]): Promise<void>;
+/**
+ * Clicks on an element containing the given text (not exact match). Supports aliasing with @alias.
+ *
+ * ```gherkin
+ * When I click on text {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click on text "Welcome"
+ * When I click on text "@username"
+ * ```
+ * @remarks
+ * Stores the clicked element for later use.
+ * @category Click Steps
+ */
+export declare function When_I_click_on_text(this: CustomWorld, rawText: string, ...rest: any[]): Promise<void>;
+/**
+ * Clicks on an element containing the exact given text.
+ *
+ * ```gherkin
+ * When I click on exact text {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click on exact text "Log out"
+ * ```
+ * @remarks
+ * Stores the clicked element for later use.
+ * @category Click Steps
+ */
+export declare function When_I_click_on_exact_text(this: CustomWorld, exactText: string, ...rest: any[]): Promise<void>;
+/**
+ * Clicks all previously stored elements.
+ *
+ * ```gherkin
+ * When I click all
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click all
+ * ```
+ * @remarks
+ * Requires a previous step that stores elements.
+ * @category Click Steps
+ */
+export declare function When_I_click_all(this: CustomWorld, ...rest: any[]): Promise<void>;
+/**
+ * Double-clicks on an element containing the given text.
+ *
+ * ```gherkin
+ * When I double click on text {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I double click on text "Edit"
+ * ```
+ * @remarks
+ * Uses the previously stored element if available.
+ * @category Click Steps
+ */
+export declare function When_I_double_click_on_text(this: CustomWorld, text: string, ...rest: any[]): Promise<void>;
+/**
+ * Double-clicks at the given page coordinates.
+ *
+ * ```gherkin
+ * When I double click position {int} {int}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I double click position 100 200
+ * ```
+ * @category Click Steps
+ */
+export declare function When_I_double_click_position(this: CustomWorld, x: number, y: number, ...rest: any[]): Promise<void>;
+/**
+ * Double-clicks on the previously stored element.
+ *
+ * ```gherkin
+ * When I double click
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I double click
+ * ```
+ * @remarks
+ * Requires a previous step that stores an element.
+ * @category Click Steps
+ */
+export declare function When_I_double_click(this: CustomWorld, ...rest: any[]): Promise<void>;
+/**
+ * Right-clicks on the previously stored element.
+ *
+ * ```gherkin
+ * When I right click
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I right click
+ * ```
+ * @remarks
+ * Requires a previous step that stores an element.
+ * @category Click Steps
+ */
+export declare function When_I_right_click(this: CustomWorld, ...rest: any[]): Promise<void>;
+/**
+ * Right-clicks on an element containing the given text.
+ *
+ * ```gherkin
+ * When I right click on text {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I right click on text "Options"
+ * ```
+ * @category Click Steps
+ */
+export declare function When_I_right_click_on_text(this: CustomWorld, text: string, ...rest: any[]): Promise<void>;
+/**
+ * Right-clicks at the given page coordinates.
+ *
+ * ```gherkin
+ * When I right click position {int} {int}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I right click position 50 50
+ * ```
+ * @category Click Steps
+ */
+export declare function When_I_right_click_position(this: CustomWorld, x: number, y: number, ...rest: any[]): Promise<void>;
+/**
+ * Clicks all stored elements (alternative signature).
+ *
+ * ```gherkin
+ * When I click all
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click all
+ * ```
+ * @remarks
+ * Requires a previous step that stores elements.
+ * @category Click Steps
+ */
+export declare function When_I_click_all_alt(this: CustomWorld, dataTable?: DataTable): Promise<void>;
+/**
+ * Clicks on an element matching the given selector (regex step).
+ *
+ * ```gherkin
+ * When I click on selector {string}
+ * ```
+ *
+ * @example
+ * ```gherkin
+ * When I click on selector ".my-selector"
+ * ```
+ * @category Click Steps
+ */
+export declare function When_I_click_on_selector(this: CustomWorld, selector: string): Promise<void>;