playwright-cucumber-ts-steps 1.1.12 → 1.2.0

package/dist/backend/actions/keyboard.js

@@ -1,98 +1,87 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReleaseKey = exports.HoldDownKey = exports.PressShortcut = exports.TypeKeysGlobal = exports.PressKeyOnElement = exports.PressKey = void 0;
+exports.pressKey = pressKey;
+exports.pressKeyOnElement = pressKeyOnElement;
+exports.typeKeysGlobal = typeKeysGlobal;
+exports.pressShortcut = pressShortcut;
+exports.holdDownKey = holdDownKey;
+exports.releaseKey = releaseKey;
 const registry_1 = require("../../core/registry");
 const state_1 = require("../utils/state");
 // ==================================================
-// KEYBOARD INTERACTIONS
+// CORE FUNCTIONS
 // ==================================================
 /**
  * Presses a specific key globally on the page.
- * This simulates a user pressing a key without targeting any specific element,
- * although the event will be delivered to the currently focused element.
- *
- * ```gherkin
+ * This simulates a user pressing a key without targeting any specific element.
+ * @example
  * When I press key "Enter"
  * When I press key "Escape"
- * ```
- *
  * @param key - The name of the key (e.g., "Enter", "Tab", "ArrowDown").
  */
-exports.PressKey = (0, registry_1.Step)("I press key {string}", async (page, key) => {
+async function pressKey(page, key) {
     await page.keyboard.press(key);
     console.log(`⌨️ Pressed key: "${key}"`);
-});
+}
 /**
  * Presses a specific key targeted at the currently stored (active) element.
- * This ensures the element is focused before the key is pressed.
- *
- * ```gherkin
+ * @example
  * When I press key "Enter" on element
- * ```
- *
  * @param key - The name of the key to press.
  */
-exports.PressKeyOnElement = (0, registry_1.Step)("I press key {string} on element", async (page, key) => {
+async function pressKeyOnElement(page, key) {
     const element = (0, state_1.getActiveElement)(page);
     await element.press(key);
     console.log(`⌨️ Pressed key "${key}" on stored element`);
-});
+}
 /**
  * Types text globally using the keyboard, character by character.
- * This acts like a real user typing on a physical keyboard, sending
- * `keydown`, `keypress`, and `keyup` events for each character.
- *
- * ```gherkin
+ * @example
  * When I press keys "Hello World"
- * ```
- *
  * @param text - The string of text to type.
  */
-exports.TypeKeysGlobal = (0, registry_1.Step)("I press keys {string}", async (page, text) => {
+async function typeKeysGlobal(page, text) {
     await page.keyboard.type(text);
     console.log(`⌨️ Typed keys: "${text}"`);
-});
+}
 /**
  * Performs a specific keyboard shortcut or combination.
- * Playwright supports combinations using the "+" delimiter.
- *
- * ```gherkin
+ * @example
  * When I press shortcut "Control+C"
  * When I press shortcut "Meta+Shift+P"
- * ```
- *
  * @param shortcut - The key combination string (e.g., "Control+V").
  */
-exports.PressShortcut = (0, registry_1.Step)("I press shortcut {string}", async (page, shortcut) => {
-    // Playwright's keyboard.press supports combinations like "Control+KeyC"
+async function pressShortcut(page, shortcut) {
     await page.keyboard.press(shortcut);
     console.log(`⌨️ Performed shortcut: "${shortcut}"`);
-});
+}
 /**
  * Holds down a specific key.
  * Useful for operations like multiple selections (holding Shift) or drag-and-drop.
- * **Important:** You must release the key later using `I release key`.
- *
- * ```gherkin
+ * @example
  * When I hold down key "Shift"
- * ```
- *
  * @param key - The name of the key to hold down.
  */
-exports.HoldDownKey = (0, registry_1.Step)("I hold down key {string}", async (page, key) => {
+async function holdDownKey(page, key) {
     await page.keyboard.down(key);
     console.log(`⬇️ Holding down key: "${key}"`);
-});
+}
 /**
  * Releases a specific key that was previously held down.
- *
- * ```gherkin
+ * @example
  * When I release key "Shift"
- * ```
- *
  * @param key - The name of the key to release.
  */
-exports.ReleaseKey = (0, registry_1.Step)("I release key {string}", async (page, key) => {
+async function releaseKey(page, key) {
     await page.keyboard.up(key);
     console.log(`⬆️ Released key: "${key}"`);
-});
+}
+// ==================================================
+// GLUE STEPS
+// ==================================================
+(0, registry_1.Step)("I press key {string}", pressKey);
+(0, registry_1.Step)("I press key {string} on element", pressKeyOnElement);
+(0, registry_1.Step)("I press keys {string}", typeKeysGlobal);
+(0, registry_1.Step)("I press shortcut {string}", pressShortcut);
+(0, registry_1.Step)("I hold down key {string}", holdDownKey);
+(0, registry_1.Step)("I release key {string}", releaseKey);

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

@@ -1,135 +1,95 @@
 /**
  * Pauses execution for a specified number of milliseconds.
- *
- * ```gherkin
+ * @example
  * When I wait for 1000 milliseconds
- * ```
- *
  * @param ms - The duration to wait in milliseconds.
- * @remarks
- * **Note:** Use sparse waits to avoid flaky tests. Prefer explicit waits like `I wait for element to be visible`.
  */
-export declare const WaitMilliseconds: void;
+export declare function waitMilliseconds(page: any, ms: number): Promise<void>;
 /**
  * Pauses execution for a specified number of seconds.
- *
- * ```gherkin
+ * @example
  * When I wait for 5 seconds
- * ```
- *
  * @param seconds - The duration to wait in seconds.
  */
-export declare const WaitSeconds: void;
+export declare function waitSeconds(page: any, seconds: number): Promise<void>;
 /**
  * Pauses the test execution and opens the Playwright Inspector.
- * This is incredibly useful for manual debugging during a test run.
- * You can inspect elements, view console logs, and step through execution.
- *
- * ```gherkin
+ * @example
  * When I pause
- * ```
  */
-export declare const PauseExecution: void;
+export declare function pauseExecution(page: any): Promise<void>;
 /**
- * Alias for `I pause`. Pauses execution for debugging.
- *
- * ```gherkin
+ * Alias for pauseExecution. Pauses execution for debugging.
+ * @example
  * When I debug
- * ```
  */
-export declare const DebugExecution: void;
+export declare function debugExecution(page: any): Promise<void>;
 /**
  * Prints a custom message to the console logs.
- * Useful for marking sections of a test output or debugging variable states.
- *
- * ```gherkin
+ * @example
  * When I log "Starting Login Flow"
- * ```
- *
  * @param message - The string to log.
  */
-export declare const LogMessage: void;
+export declare function logMessage(page: any, message: string): Promise<void>;
 /**
  * Focuses on the currently stored (active) element.
- *
- * ```gherkin
+ * @example
  * When I focus
- * ```
  */
-export declare const FocusElement: void;
+export declare function focusElement(page: any): Promise<void>;
 /**
  * Blurs (removes focus from) the currently stored element.
- *
- * ```gherkin
+ * @example
  * When I blur
- * ```
  */
-export declare const BlurElement: void;
+export declare function blurElement(page: any): Promise<void>;
 /**
  * Sets a cookie for the current context/URL.
- *
- * ```gherkin
+ * @example
  * When I set cookie "session_id" to "12345ABC"
- * ```
- *
  * @param name - The name of the cookie.
  * @param value - The value of the cookie.
  */
-export declare const SetCookie: void;
+export declare function setCookie(page: any, name: string, value: string): Promise<void>;
 /**
  * Clears all cookies for the current browser context.
- *
- * ```gherkin
+ * @example
  * When I clear all cookies
- * ```
  */
-export declare const ClearAllCookies: void;
+export declare function clearAllCookies(page: any): Promise<void>;
 /**
  * Sets an item in Local Storage.
- *
- * ```gherkin
+ * @example
  * When I set local storage item "theme" to "dark"
- * ```
- *
  * @param key - The local storage key.
  * @param value - The value to store.
  */
-export declare const SetLocalStorageItem: void;
+export declare function setLocalStorageItem(page: any, key: string, value: string): Promise<void>;
 /**
  * Retrieves a Local Storage item and logs it to the console.
- *
- * ```gherkin
+ * @example
  * When I get local storage item "authToken"
- * ```
- *
  * @param key - The key of the item to retrieve.
  */
-export declare const GetLocalStorageItem: void;
+export declare function getLocalStorageItem(page: any, key: string): Promise<void>;
 /**
  * Clears all data from Local Storage.
- *
- * ```gherkin
+ * @example
  * When I clear local storage
- * ```
  */
-export declare const ClearLocalStorage: void;
+export declare function clearLocalStorage(page: any): Promise<void>;
 /**
  * Sets an item in Session Storage.
- *
- * ```gherkin
+ * @example
  * When I set session storage item "user_role" to "admin"
- * ```
- *
  * @param key - The session storage key.
  * @param value - The value to store.
  */
-export declare const SetSessionStorageItem: void;
+export declare function setSessionStorageItem(page: any, key: string, value: string): Promise<void>;
 /**
  * Clears all data from Session Storage.
- *
- * ```gherkin
+ * @example
  * When I clear session storage
- * ```
  */
-export declare const ClearSessionStorage: void;
+export declare function clearSessionStorage(page: any): Promise<void>;
 //# sourceMappingURL=misc.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"misc.d.ts","sourceRoot":"","sources":["../../../src/backend/actions/misc.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,MAG3B,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,MAGtB,CAAC;AAMH;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,MAGzB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,MAGzB,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,MAErB,CAAC;AAMH;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,MAIvB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,MAOtB,CAAC;AAMH;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,MAMpB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,MAI1B,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,mBAAmB,MAS/B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,MAG9B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,MAG5B,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,MASjC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,MAG9B,CAAC"}
+{"version":3,"file":"misc.d.ts","sourceRoot":"","sources":["../../../src/backend/actions/misc.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAG7D;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAG7D;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAI3D;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAM1D;AAED;;;;;;GAMG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKrF;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAI9D;AAED;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM9F;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG/E;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAGhE;AAED;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMhG;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAGlE"}

package/dist/backend/actions/misc.js

@@ -1,208 +1,187 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClearSessionStorage = exports.SetSessionStorageItem = exports.ClearLocalStorage = exports.GetLocalStorageItem = exports.SetLocalStorageItem = exports.ClearAllCookies = exports.SetCookie = exports.BlurElement = exports.FocusElement = exports.LogMessage = exports.DebugExecution = exports.PauseExecution = exports.WaitSeconds = exports.WaitMilliseconds = void 0;
+exports.waitMilliseconds = waitMilliseconds;
+exports.waitSeconds = waitSeconds;
+exports.pauseExecution = pauseExecution;
+exports.debugExecution = debugExecution;
+exports.logMessage = logMessage;
+exports.focusElement = focusElement;
+exports.blurElement = blurElement;
+exports.setCookie = setCookie;
+exports.clearAllCookies = clearAllCookies;
+exports.setLocalStorageItem = setLocalStorageItem;
+exports.getLocalStorageItem = getLocalStorageItem;
+exports.clearLocalStorage = clearLocalStorage;
+exports.setSessionStorageItem = setSessionStorageItem;
+exports.clearSessionStorage = clearSessionStorage;
 const registry_1 = require("../../core/registry");
 const state_1 = require("../utils/state");
 // ==================================================
-// 1. TIMING & WAITS
+// CORE FUNCTIONS
 // ==================================================
 /**
  * Pauses execution for a specified number of milliseconds.
- *
- * ```gherkin
+ * @example
  * When I wait for 1000 milliseconds
- * ```
- *
  * @param ms - The duration to wait in milliseconds.
- * @remarks
- * **Note:** Use sparse waits to avoid flaky tests. Prefer explicit waits like `I wait for element to be visible`.
  */
-exports.WaitMilliseconds = (0, registry_1.Step)("I wait for {int} milliseconds", async (page, ms) => {
+async function waitMilliseconds(page, ms) {
     await page.waitForTimeout(ms);
     console.log(`⏳ Waited for ${ms}ms`);
-});
+}
 /**
  * Pauses execution for a specified number of seconds.
- *
- * ```gherkin
+ * @example
  * When I wait for 5 seconds
- * ```
- *
  * @param seconds - The duration to wait in seconds.
  */
-exports.WaitSeconds = (0, registry_1.Step)("I wait for {int} seconds", async (page, seconds) => {
+async function waitSeconds(page, seconds) {
     await page.waitForTimeout(seconds * 1000);
     console.log(`⏳ Waited for ${seconds}s`);
-});
-// ==================================================
-// 2. DEBUGGING
-// ==================================================
+}
 /**
  * Pauses the test execution and opens the Playwright Inspector.
- * This is incredibly useful for manual debugging during a test run.
- * You can inspect elements, view console logs, and step through execution.
- *
- * ```gherkin
+ * @example
  * When I pause
- * ```
  */
-exports.PauseExecution = (0, registry_1.Step)("I pause", async (page) => {
+async function pauseExecution(page) {
     console.log("⏸️ Pausing test execution...");
     await page.pause();
-});
+}
 /**
- * Alias for `I pause`. Pauses execution for debugging.
- *
- * ```gherkin
+ * Alias for pauseExecution. Pauses execution for debugging.
+ * @example
  * When I debug
- * ```
  */
-exports.DebugExecution = (0, registry_1.Step)("I debug", async (page) => {
+async function debugExecution(page) {
     console.log("🐞 Debugging...");
     await page.pause();
-});
+}
 /**
  * Prints a custom message to the console logs.
- * Useful for marking sections of a test output or debugging variable states.
- *
- * ```gherkin
+ * @example
  * When I log "Starting Login Flow"
- * ```
- *
  * @param message - The string to log.
  */
-exports.LogMessage = (0, registry_1.Step)("I log {string}", async (page, message) => {
+async function logMessage(page, message) {
     console.log(`📝 LOG: ${message}`);
-});
-// ==================================================
-// 3. FOCUS & BLUR
-// ==================================================
+}
 /**
  * Focuses on the currently stored (active) element.
- *
- * ```gherkin
+ * @example
  * When I focus
- * ```
  */
-exports.FocusElement = (0, registry_1.Step)("I focus", async (page) => {
+async function focusElement(page) {
     const element = (0, state_1.getActiveElement)(page);
     await element.focus();
     console.log("👀 Focused on stored element");
-});
+}
 /**
  * Blurs (removes focus from) the currently stored element.
- *
- * ```gherkin
+ * @example
  * When I blur
- * ```
  */
-exports.BlurElement = (0, registry_1.Step)("I blur", async (page) => {
+async function blurElement(page) {
     const element = (0, state_1.getActiveElement)(page);
-    // Playwright doesn't have a direct .blur(), so we use JS evaluation
     await element.evaluate((el) => {
         if (el instanceof HTMLElement)
             el.blur();
     });
     console.log("🌫️ Blurred stored element");
-});
-// ==================================================
-// 4. BROWSER STORAGE (Cookies / Local Storage)
-// ==================================================
+}
 /**
  * Sets a cookie for the current context/URL.
- *
- * ```gherkin
+ * @example
  * When I set cookie "session_id" to "12345ABC"
- * ```
- *
  * @param name - The name of the cookie.
  * @param value - The value of the cookie.
  */
-exports.SetCookie = (0, registry_1.Step)("I set cookie {string} to {string}", async (page, name, value) => {
+async function setCookie(page, name, value) {
     const context = page.context();
     const url = page.url();
-    // We need a domain or url to set cookies. We use the current page URL.
     await context.addCookies([{ name, value, url }]);
     console.log(`🍪 Set cookie "${name}"`);
-});
+}
 /**
  * Clears all cookies for the current browser context.
- *
- * ```gherkin
+ * @example
  * When I clear all cookies
- * ```
  */
-exports.ClearAllCookies = (0, registry_1.Step)("I clear all cookies", async (page) => {
+async function clearAllCookies(page) {
     const context = page.context();
     await context.clearCookies();
     console.log("🍪 Cleared all cookies");
-});
+}
 /**
  * Sets an item in Local Storage.
- *
- * ```gherkin
+ * @example
  * When I set local storage item "theme" to "dark"
- * ```
- *
  * @param key - The local storage key.
  * @param value - The value to store.
  */
-exports.SetLocalStorageItem = (0, registry_1.Step)("I set local storage item {string} to {string}", async (page, key, value) => {
-    await page.evaluate(({ k, v }) => localStorage.setItem(k, v), {
+async function setLocalStorageItem(page, key, value) {
+    await page.evaluate((args) => localStorage.setItem(args.k, args.v), {
         k: key,
         v: value,
     });
     console.log(`📦 Set local storage "${key}" = "${value}"`);
-});
+}
 /**
  * Retrieves a Local Storage item and logs it to the console.
- *
- * ```gherkin
+ * @example
  * When I get local storage item "authToken"
- * ```
- *
  * @param key - The key of the item to retrieve.
  */
-exports.GetLocalStorageItem = (0, registry_1.Step)("I get local storage item {string}", async (page, key) => {
+async function getLocalStorageItem(page, key) {
     const value = await page.evaluate((k) => localStorage.getItem(k), key);
     console.log(`📦 Local Storage "${key}": ${value}`);
-});
+}
 /**
  * Clears all data from Local Storage.
- *
- * ```gherkin
+ * @example
  * When I clear local storage
- * ```
  */
-exports.ClearLocalStorage = (0, registry_1.Step)("I clear local storage", async (page) => {
+async function clearLocalStorage(page) {
     await page.evaluate(() => localStorage.clear());
     console.log("📦 Cleared local storage");
-});
+}
 /**
  * Sets an item in Session Storage.
- *
- * ```gherkin
+ * @example
  * When I set session storage item "user_role" to "admin"
- * ```
- *
  * @param key - The session storage key.
  * @param value - The value to store.
  */
-exports.SetSessionStorageItem = (0, registry_1.Step)("I set session storage item {string} to {string}", async (page, key, value) => {
-    await page.evaluate(({ k, v }) => sessionStorage.setItem(k, v), {
+async function setSessionStorageItem(page, key, value) {
+    await page.evaluate((args) => sessionStorage.setItem(args.k, args.v), {
         k: key,
         v: value,
     });
     console.log(`📦 Set session storage "${key}" = "${value}"`);
-});
+}
 /**
  * Clears all data from Session Storage.
- *
- * ```gherkin
+ * @example
  * When I clear session storage
- * ```
  */
-exports.ClearSessionStorage = (0, registry_1.Step)("I clear session storage", async (page) => {
+async function clearSessionStorage(page) {
     await page.evaluate(() => sessionStorage.clear());
     console.log("📦 Cleared session storage");
-});
+}
+// ==================================================
+// GLUE STEPS
+// ==================================================
+(0, registry_1.Step)("I wait for {int} milliseconds", waitMilliseconds);
+(0, registry_1.Step)("I wait for {int} seconds", waitSeconds);
+(0, registry_1.Step)("I pause", pauseExecution);
+(0, registry_1.Step)("I debug", debugExecution);
+(0, registry_1.Step)("I log {string}", logMessage);
+(0, registry_1.Step)("I focus", focusElement);
+(0, registry_1.Step)("I blur", blurElement);
+(0, registry_1.Step)("I set cookie {string} to {string}", setCookie);
+(0, registry_1.Step)("I clear all cookies", clearAllCookies);
+(0, registry_1.Step)("I set local storage item {string} to {string}", setLocalStorageItem);
+(0, registry_1.Step)("I get local storage item {string}", getLocalStorageItem);
+(0, registry_1.Step)("I clear local storage", clearLocalStorage);
+(0, registry_1.Step)("I set session storage item {string} to {string}", setSessionStorageItem);
+(0, registry_1.Step)("I clear session storage", clearSessionStorage);