@playq/core 0.2.77

package/dist/helper/actions/web/webNavigation.d.ts

@@ -0,0 +1,104 @@
+import { Page } from "@playwright/test";
+/**
+ * [ACTION] Open a browser page (Playwright/Cucumber hybrid support).
+ *
+ * Opens the given URL in a new browser page or reuses the existing page based on the runner context.
+ * Supports automatic screenshot and log attachments.
+ *
+ * @param pageOverride - Optional Playwright Page object (used in Playwright tests). Not required in Cucumber.
+ * @param url - The URL to open (e.g., "https://example.com").
+ * @param options - JSON string or object for additional behaviors:
+ *   - screenshot [boolean]: Capture screenshot after navigation. Default: false.
+ *   - screenshotText [string]: Description for screenshot attachment. Default: "".
+ *   - screenshotFullPage [boolean]: Full page screenshot or viewport only. Default: true.
+ *
+ * @returns void
+ *
+ * @example
+ * // Playwright Test
+ * test('Open Google', async ({ page }) => {
+ *   await openBrowser('https://google.com', '{screenshot: true, screenshotText: "Homepage"}', page);
+ * });
+ *
+ * @example
+ * // Cucumber Step
+ * Given("Web: Open Browser -url: {param} -options: {param}", openBrowser);
+ *
+ * @throws Error if page is not initialized or navigation fails.
+ */
+export declare function openBrowser(page: Page, url: string, options?: string | Record<string, any>): Promise<void>;
+/**
+   * Web: Refresh Page -options: {param}
+   *
+   * Reloads the current page.
+   *
+   * @param page Playwright Page instance
+   * @param options Optional JSON string or object (reserved for consistency)
+   */
+export declare function refreshPage(page: Page, options?: string | Record<string, any>): Promise<void>;
+/**
+ * Web: Switch Tab -index: {param} -options: {param}
+ *
+ * Brings the specified tab to the front by index.
+ *
+ * @param page Playwright Page instance
+ * @param index Zero-based tab index (default: 0)
+ * @param options Optional JSON string or object (reserved for consistency)
+ */
+export declare function switchTab(page: Page, index?: number, options?: string | Record<string, any>): Promise<void>;
+/**
+ * Web: Close Tab -options: {param}
+ *
+ * Closes the current tab.
+ *
+ * @param page Playwright Page instance
+ * @param options Optional JSON string or object (reserved for consistency)
+ */
+export declare function closeTab(page: Page, options?: string | Record<string, any>): Promise<void>;
+/**
+ * Web: Open New Tab -url: {param} -options: {param}
+ *
+ * Opens a new tab within the current browser context and optionally navigates to a URL.
+ * Returns the created Page instance so tests can interact with it without direct Playwright APIs.
+ *
+ * @param page Playwright Page instance (used to derive the context)
+ * @param url Optional URL to navigate the new tab to
+ * @param options Optional JSON string or object:
+ *   - screenshot: [boolean] Capture a screenshot after opening/navigating. Default: false.
+ *   - screenshotText: [string] Description for the screenshot attachment. Default: "".
+ *   - screenshotFullPage: [boolean] Capture full page screenshot. Default: true.
+ *
+ * @returns The newly opened Playwright Page
+ */
+export declare function openNewTab(page: Page, url?: string, options?: string | Record<string, any>): Promise<any>;
+/**
+ * Web: Navigate by Path -relativePath: {param} -options: {param}
+ *
+ * Appends a relative path to the current page's URL and navigates to it.
+ *
+ * @param relativePath - The path to append (e.g., "/settings", "profile/edit")
+ * @param options - (optional) JSON string or object:
+ *   - screenshot: [boolean] Capture a screenshot after navigation. Default: false.
+ *   - screenshotText: [string] Text description for the screenshot. Default: "".
+ *   - screenshotFullPage: [boolean] Capture full page screenshot. Default: true.
+ *
+ * @example
+ *  Web: Navigate by Path -relativePath: "/profile/edit" -options: "{screenshot: true, screenshotText: 'Profile Page'}"
+ */
+export declare function navigateByPath(page: Page, relativePath: string, options?: string | Record<string, any>): Promise<void>;
+/**
+ * Web: Reload Page -options: {param}
+ *
+ * Reloads the current page and optionally takes a screenshot.
+ *
+ * @param page - Playwright Page instance
+ * @param options - Optional string or object:
+ *   - actionTimeout: [number] Timeout in ms (default: 30000)
+ *   - screenshot: [boolean] Capture screenshot after reload (default: false)
+ *   - screenshotText: [string] Description for screenshot
+ *   - screenshotFullPage: [boolean] Full page screenshot (default: true)
+ *
+ * @example
+ *   await reloadPage(page, { screenshot: true, screenshotText: "After reload" });
+ */
+export declare function reloadPage(page: Page, options?: string | Record<string, any>): Promise<void>;

package/dist/helper/actions/web/webNavigation.js

@@ -0,0 +1,288 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openBrowser = openBrowser;
+exports.refreshPage = refreshPage;
+exports.switchTab = switchTab;
+exports.closeTab = closeTab;
+exports.openNewTab = openNewTab;
+exports.navigateByPath = navigateByPath;
+exports.reloadPage = reloadPage;
+/**
+ * @file webNavigation.ts
+ *
+ * Navigation helpers for PlayQ web actions.
+ * Provides open/refresh/switch/close tab and path navigation utilities
+ * with runner-aware Allure step wrappers and screenshot options.
+ *
+ * Authors: PlayQ Team
+ * Version: v1.0.0
+ */
+const allure = __importStar(require("allure-js-commons"));
+const global_1 = require("../../../global");
+const screenshotActions_1 = require("./screenshotActions");
+const vars_1 = require("../../bundle/vars");
+const commActions_1 = require("../commActions");
+function isPlaywrightRunner() { return process.env.TEST_RUNNER === 'playwright'; }
+const __allureAny_nav = allure;
+if (typeof __allureAny_nav.step !== 'function') {
+    __allureAny_nav.step = async (_name, fn) => await fn();
+}
+// Allure compatibility shim: if step is unavailable, just run the body
+const __allureAny_web = allure;
+if (typeof __allureAny_web.step !== 'function') {
+    __allureAny_web.step = async (_name, fn) => await fn();
+}
+/**
+ * [ACTION] Open a browser page (Playwright/Cucumber hybrid support).
+ *
+ * Opens the given URL in a new browser page or reuses the existing page based on the runner context.
+ * Supports automatic screenshot and log attachments.
+ *
+ * @param pageOverride - Optional Playwright Page object (used in Playwright tests). Not required in Cucumber.
+ * @param url - The URL to open (e.g., "https://example.com").
+ * @param options - JSON string or object for additional behaviors:
+ *   - screenshot [boolean]: Capture screenshot after navigation. Default: false.
+ *   - screenshotText [string]: Description for screenshot attachment. Default: "".
+ *   - screenshotFullPage [boolean]: Full page screenshot or viewport only. Default: true.
+ *
+ * @returns void
+ *
+ * @example
+ * // Playwright Test
+ * test('Open Google', async ({ page }) => {
+ *   await openBrowser('https://google.com', '{screenshot: true, screenshotText: "Homepage"}', page);
+ * });
+ *
+ * @example
+ * // Cucumber Step
+ * Given("Web: Open Browser -url: {param} -options: {param}", openBrowser);
+ *
+ * @throws Error if page is not initialized or navigation fails.
+ */
+async function openBrowser(page, url, options) {
+    let resolvedUrl = global_1.vars.replaceVariables(url);
+    const options_json = typeof options === "string" ? (0, vars_1.parseLooseJson)(options) : options || {};
+    const { screenshot = false, screenshotText = "", screenshotFullPage = true, } = options_json !== null && options_json !== void 0 ? options_json : {};
+    if (isPlaywrightRunner()) {
+        await __allureAny_web.step(`Web: Open browser -url: ${resolvedUrl} -options: ${JSON.stringify(options_json)}`, async () => {
+            await doOpenBrowser();
+        });
+    }
+    else {
+        await doOpenBrowser();
+    }
+    async function doOpenBrowser() {
+        if (!page)
+            throw new Error("Page not initialised");
+        await page.goto(resolvedUrl, { waitUntil: "domcontentloaded" });
+        await (0, screenshotActions_1.processScreenshot)(page, screenshot, screenshotText, screenshotFullPage);
+    }
+}
+/**
+   * Web: Refresh Page -options: {param}
+   *
+   * Reloads the current page.
+   *
+   * @param page Playwright Page instance
+   * @param options Optional JSON string or object (reserved for consistency)
+   */
+async function refreshPage(page, options) {
+    const options_json = typeof options === "string" ? global_1.vars.parseLooseJson(options) : options || {};
+    const stepName = `Web: Refresh Page -options: ${JSON.stringify(options_json)}`;
+    if (isPlaywrightRunner()) {
+        await __allureAny_nav.step(stepName, async () => { await page.reload(); });
+    }
+    else {
+        await page.reload();
+    }
+}
+/**
+ * Web: Switch Tab -index: {param} -options: {param}
+ *
+ * Brings the specified tab to the front by index.
+ *
+ * @param page Playwright Page instance
+ * @param index Zero-based tab index (default: 0)
+ * @param options Optional JSON string or object (reserved for consistency)
+ */
+async function switchTab(page, index = 0, options) {
+    const options_json = typeof options === "string" ? global_1.vars.parseLooseJson(options) : options || {};
+    const ctx = page.context();
+    const stepName = `Web: Switch Tab -index: ${index} -options: ${JSON.stringify(options_json)}`;
+    if (isPlaywrightRunner()) {
+        await __allureAny_nav.step(stepName, async () => {
+            const target = ctx.pages()[index];
+            if (!target)
+                throw new Error(`No tab at index ${index}`);
+            await target.bringToFront();
+        });
+    }
+    else {
+        const target = ctx.pages()[index];
+        if (!target)
+            throw new Error(`No tab at index ${index}`);
+        await target.bringToFront();
+    }
+}
+/**
+ * Web: Close Tab -options: {param}
+ *
+ * Closes the current tab.
+ *
+ * @param page Playwright Page instance
+ * @param options Optional JSON string or object (reserved for consistency)
+ */
+async function closeTab(page, options) {
+    const options_json = typeof options === "string" ? global_1.vars.parseLooseJson(options) : options || {};
+    const stepName = `Web: Close Tab -options: ${JSON.stringify(options_json)}`;
+    if (isPlaywrightRunner()) {
+        await __allureAny_nav.step(stepName, async () => { await page.close(); });
+    }
+    else {
+        await page.close();
+    }
+}
+/**
+ * Web: Open New Tab -url: {param} -options: {param}
+ *
+ * Opens a new tab within the current browser context and optionally navigates to a URL.
+ * Returns the created Page instance so tests can interact with it without direct Playwright APIs.
+ *
+ * @param page Playwright Page instance (used to derive the context)
+ * @param url Optional URL to navigate the new tab to
+ * @param options Optional JSON string or object:
+ *   - screenshot: [boolean] Capture a screenshot after opening/navigating. Default: false.
+ *   - screenshotText: [string] Description for the screenshot attachment. Default: "".
+ *   - screenshotFullPage: [boolean] Capture full page screenshot. Default: true.
+ *
+ * @returns The newly opened Playwright Page
+ */
+async function openNewTab(page, url, options) {
+    const options_json = typeof options === "string" ? global_1.vars.parseLooseJson(options) : options || {};
+    const { screenshot = false, screenshotText = "", screenshotFullPage = true } = options_json !== null && options_json !== void 0 ? options_json : {};
+    const stepName = `Web: Open New Tab -url: ${url !== null && url !== void 0 ? url : ''} -options: ${JSON.stringify(options_json)}`;
+    async function run() {
+        if (!page)
+            throw new Error("Page not initialised");
+        const ctx = page.context();
+        const newPage = await ctx.newPage();
+        if (url && typeof url === 'string' && url.length > 0) {
+            const targetUrl = global_1.vars.replaceVariables(url);
+            await newPage.goto(targetUrl, { waitUntil: 'domcontentloaded' });
+            await newPage.waitForLoadState('networkidle');
+        }
+        await (0, screenshotActions_1.processScreenshot)(newPage, screenshot, screenshotText, screenshotFullPage);
+        return newPage;
+    }
+    if (isPlaywrightRunner()) {
+        return await __allureAny_nav.step(stepName, run);
+    }
+    else {
+        return await run();
+    }
+}
+/**
+ * Web: Navigate by Path -relativePath: {param} -options: {param}
+ *
+ * Appends a relative path to the current page's URL and navigates to it.
+ *
+ * @param relativePath - The path to append (e.g., "/settings", "profile/edit")
+ * @param options - (optional) JSON string or object:
+ *   - screenshot: [boolean] Capture a screenshot after navigation. Default: false.
+ *   - screenshotText: [string] Text description for the screenshot. Default: "".
+ *   - screenshotFullPage: [boolean] Capture full page screenshot. Default: true.
+ *
+ * @example
+ *  Web: Navigate by Path -relativePath: "/profile/edit" -options: "{screenshot: true, screenshotText: 'Profile Page'}"
+ */
+async function navigateByPath(page, relativePath, options) {
+    let resolvedRelativePath = global_1.vars.getValue(relativePath);
+    const options_json = typeof options === "string" ? (0, vars_1.parseLooseJson)(options) : options || {};
+    const { screenshot = false, screenshotText = "", screenshotFullPage = true, } = options_json !== null && options_json !== void 0 ? options_json : {};
+    if (isPlaywrightRunner()) {
+        await __allureAny_web.step(`Web: Navigate by Path -relativePath: ${relativePath} -options: ${JSON.stringify(options_json)}`, async () => {
+            await doNavigateByPath();
+        });
+    }
+    else {
+        await doNavigateByPath();
+    }
+    async function doNavigateByPath() {
+        if (!page)
+            throw new Error("Page not initialised");
+        const currentUrl = page.url();
+        const targetUrl = new URL(resolvedRelativePath, currentUrl).toString();
+        console.log(`🌐 Navigating to: ${targetUrl}`);
+        await page.goto(targetUrl, { waitUntil: "domcontentloaded" });
+        await page.waitForLoadState("networkidle");
+        await page.waitForLoadState("load");
+        await (0, screenshotActions_1.processScreenshot)(page, screenshot, screenshotText, screenshotFullPage);
+    }
+}
+/**
+ * Web: Reload Page -options: {param}
+ *
+ * Reloads the current page and optionally takes a screenshot.
+ *
+ * @param page - Playwright Page instance
+ * @param options - Optional string or object:
+ *   - actionTimeout: [number] Timeout in ms (default: 30000)
+ *   - screenshot: [boolean] Capture screenshot after reload (default: false)
+ *   - screenshotText: [string] Description for screenshot
+ *   - screenshotFullPage: [boolean] Full page screenshot (default: true)
+ *
+ * @example
+ *   await reloadPage(page, { screenshot: true, screenshotText: "After reload" });
+ */
+async function reloadPage(page, options) {
+    const options_json = typeof options === "string" ? (0, vars_1.parseLooseJson)(options) : options || {};
+    const { actionTimeout = Number(global_1.vars.getConfigValue("testExecution.actionTimeout")) || 30000, screenshot = false, screenshotText = "", screenshotFullPage = true, } = options_json;
+    if (!page)
+        throw new Error("Page not initialized");
+    if (isPlaywrightRunner()) {
+        await __allureAny_web.step(`Web: Reload Page -options: ${JSON.stringify(options_json)}`, async () => {
+            await doReloadPage();
+        });
+    }
+    else {
+        await doReloadPage();
+    }
+    async function doReloadPage() {
+        await page.reload({ timeout: actionTimeout, waitUntil: "domcontentloaded" });
+        await (0, commActions_1.attachLog)("✅ Page reloaded.", "text/plain");
+        await (0, screenshotActions_1.processScreenshot)(page, screenshot, screenshotText || "Page reloaded", screenshotFullPage);
+    }
+}

package/dist/helper/actions/webActions.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @file webActions.ts
+ *
+ * Unified web actions bridging Playwright and Cucumber.
+ * Provides navigation, interaction, validation, and reporting helpers.
+ *
+ * Key Features:
+ * - Hybrid context: Playwright Runner (page) and Cucumber World (webFixture)
+ * - Rich options for screenshots, timeouts, locators, and assertions
+ * - Robust error handling, logging, and Allure-compatible step wrappers
+ *
+ * Authors: Renish Kozhithottathil [Lead Automation Principal, NCS]
+ * Version: v1.0.0
+ *
+ * Note: This file adheres to the PlayQ Enterprise Automation Standards.
+ */
+export * from "./web/alertActions";
+export * from "./web/cookieActions";
+export * from "./web/downloadActions";
+export * from "./web/elementReaderActions";
+export * from "./web/formActions";
+export * from "./web/iframeActions";
+export * from "./web/javascriptActions";
+export * from "./web/keyboardActions";
+export * from "./web/localStorageActions";
+export * from "./web/mouseActions";
+export * from "./web/reportingActions";
+export * from "./web/screenshotActions";
+export * from "./web/testDataActions";
+export * from "./web/validationActions";
+export * from "./web/waitActions";
+export * from "./web/webNavigation";

package/dist/helper/actions/webActions.js

@@ -0,0 +1,48 @@
+"use strict";
+/**
+ * @file webActions.ts
+ *
+ * Unified web actions bridging Playwright and Cucumber.
+ * Provides navigation, interaction, validation, and reporting helpers.
+ *
+ * Key Features:
+ * - Hybrid context: Playwright Runner (page) and Cucumber World (webFixture)
+ * - Rich options for screenshots, timeouts, locators, and assertions
+ * - Robust error handling, logging, and Allure-compatible step wrappers
+ *
+ * Authors: Renish Kozhithottathil [Lead Automation Principal, NCS]
+ * Version: v1.0.0
+ *
+ * Note: This file adheres to the PlayQ Enterprise Automation Standards.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./web/alertActions"), exports);
+__exportStar(require("./web/cookieActions"), exports);
+__exportStar(require("./web/downloadActions"), exports);
+__exportStar(require("./web/elementReaderActions"), exports);
+__exportStar(require("./web/formActions"), exports);
+__exportStar(require("./web/iframeActions"), exports);
+__exportStar(require("./web/javascriptActions"), exports);
+__exportStar(require("./web/keyboardActions"), exports);
+__exportStar(require("./web/localStorageActions"), exports);
+__exportStar(require("./web/mouseActions"), exports);
+__exportStar(require("./web/reportingActions"), exports);
+__exportStar(require("./web/screenshotActions"), exports);
+__exportStar(require("./web/testDataActions"), exports);
+__exportStar(require("./web/validationActions"), exports);
+__exportStar(require("./web/waitActions"), exports);
+__exportStar(require("./web/webNavigation"), exports);

package/dist/helper/actions/webStepDefs.d.ts

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