@playq/core 0.2.77

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

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertLog = void 0;
+exports.logInfo = logInfo;
+exports.logPass = logPass;
+exports.logFail = logFail;
+exports.assert = assert;
+/**
+ * @file reportingActions.ts
+ *
+ * Lightweight reporting helpers for PlayQ web actions.
+ * Attaches info/pass/fail messages to the test report via comm fixture.
+ *
+ * Authors: PlayQ Team
+ * Version: v1.0.0
+ */
+const global_1 = require("../../../global");
+/**
+ * Web: Log Info -message: {param}
+ *
+ * Attaches an informational log message to the test report.
+ *
+ * @param message - Message to attach
+ */
+async function logInfo(message) { await global_1.comm.attachLog(message, 'text/plain', 'INFO'); }
+/**
+ * Web: Log Pass -message: {param}
+ *
+ * Attaches a success log message to the test report.
+ *
+ * @param message - Message to attach
+ */
+async function logPass(message) { await global_1.comm.attachLog(`✅ ${message}`, 'text/plain', 'PASS'); }
+/**
+ * Web: Log Fail -message: {param}
+ *
+ * Attaches a failure log message to the test report.
+ *
+ * @param message - Message to attach
+ */
+async function logFail(message) { await global_1.comm.attachLog(`❌ ${message}`, 'text/plain', 'FAIL'); }
+/**
+ * Web: Assert -condition: {param} -message: {param}
+ *
+ * Asserts a condition and logs pass/fail. Throws on failure.
+ *
+ * @param condition - Condition to assert
+ * @param message - Optional message to include in logs and error
+ */
+async function assert(condition, message) {
+    if (!condition) {
+        await logFail(message || 'Assertion failed');
+        throw new Error(message || 'Assertion failed');
+    }
+    await logPass(message || 'Assertion passed');
+}
+// Friendly aliases
+exports.assertLog = assert;

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

@@ -0,0 +1,34 @@
+import { Page, Locator } from "@playwright/test";
+/**
+ * Takes a screenshot of the provided Playwright page.
+ *
+ * @param page - The Playwright Page object to capture.
+ * @param options - Optional screenshot configuration. Can be a JSON string or an object.
+ *   - `screenshot_text` (string): Optional text to annotate the screenshot.
+ *   - `screenshot_fullPage` (boolean): Whether to capture the full page (default: true).
+ * @throws Will throw an error if the page is not initialized.
+ * @remarks
+ * Waits for the page to load before taking the screenshot.
+ */
+export declare function takeScreenshot(page: Page, options?: string | Record<string, any>): Promise<void>;
+/**
+ * Web: Process Screenshot -options: {param}
+ *
+ * Internal helper to capture and attach a screenshot.
+ *
+ * @param page - Playwright Page instance
+ * @param shouldTake - Whether to capture
+ * @param text - Attachment text
+ * @param fullPage - Full page flag
+ * @param selector - Optional Locator to screenshot
+ */
+export declare function processScreenshot(page: Page, shouldTake: boolean, text?: string, fullPage?: boolean, selector?: Locator): Promise<void>;
+/**
+ * Web: Take Full Screenshot -options: {param}
+ *
+ * Captures a full-page screenshot by delegating to `takeScreenshot` with defaults.
+ *
+ * @param page - Playwright Page instance
+ * @param options - Optional JSON string or object (merged with defaults)
+ */
+export declare function takeFullScreenshot(page: Page, options?: string | Record<string, any>): Promise<void>;

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

@@ -0,0 +1,151 @@
+"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.takeScreenshot = takeScreenshot;
+exports.processScreenshot = processScreenshot;
+exports.takeFullScreenshot = takeFullScreenshot;
+/**
+ * @file screenshotActions.ts
+ *
+ * Screenshot helpers for PlayQ web actions.
+ * Provides takeScreenshot and internal processScreenshot with hybrid
+ * runner support (Playwright/Cucumber) and robust attachment fallbacks.
+ *
+ * Authors: PlayQ Team
+ * Version: v1.0.0
+ */
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const allure = __importStar(require("allure-js-commons"));
+const global_1 = require("../../../global");
+const waitActions_1 = require("./waitActions");
+const vars_1 = require("../../bundle/vars");
+function isPlaywrightRunner() { return process.env.TEST_RUNNER === 'playwright'; }
+function isCucumberRunner() { return process.env.TEST_RUNNER === 'cucumber'; }
+const __allureAny_shot = allure;
+if (typeof __allureAny_shot.step !== 'function') {
+    __allureAny_shot.step = async (_name, fn) => await fn();
+}
+/**
+ * Takes a screenshot of the provided Playwright page.
+ *
+ * @param page - The Playwright Page object to capture.
+ * @param options - Optional screenshot configuration. Can be a JSON string or an object.
+ *   - `screenshot_text` (string): Optional text to annotate the screenshot.
+ *   - `screenshot_fullPage` (boolean): Whether to capture the full page (default: true).
+ * @throws Will throw an error if the page is not initialized.
+ * @remarks
+ * Waits for the page to load before taking the screenshot.
+ */
+async function takeScreenshot(page, options) {
+    const options_json = typeof options === "string" ? (0, vars_1.parseLooseJson)(options) : options || {};
+    const { screenshot_text = "", screenshot_fullPage = true } = options_json;
+    if (!page)
+        throw new Error("Page not initialized");
+    await (0, waitActions_1.waitForPageToLoad)(page);
+    await processScreenshot(page, true, screenshot_text, screenshot_fullPage);
+}
+function persistScreenshotToDisk(buffer, text) {
+    try {
+        const baseDir = path.resolve(process.cwd(), "test-results", "screenshots");
+        fs.mkdirSync(baseDir, { recursive: true });
+        const safe = (text || "screenshot").toString().toLowerCase().replace(/[^a-z0-9-_]+/gi, "_").slice(0, 80);
+        const file = path.join(baseDir, `${Date.now()}_${safe || "shot"}.png`);
+        fs.writeFileSync(file, buffer);
+        console.log(`📸 Screenshot saved to: ${file}`);
+    }
+    catch (e) {
+        console.warn(`⚠️ Failed to save screenshot to disk: ${(e === null || e === void 0 ? void 0 : e.message) || e}`);
+    }
+}
+/**
+ * Web: Process Screenshot -options: {param}
+ *
+ * Internal helper to capture and attach a screenshot.
+ *
+ * @param page - Playwright Page instance
+ * @param shouldTake - Whether to capture
+ * @param text - Attachment text
+ * @param fullPage - Full page flag
+ * @param selector - Optional Locator to screenshot
+ */
+async function processScreenshot(page, shouldTake, text = "Screenshot", fullPage = true, selector) {
+    if (!shouldTake)
+        return;
+    if (!page)
+        throw new Error("Page not initialized for screenshot");
+    const screenshotBuffer = selector
+        ? await selector.screenshot()
+        : await page.screenshot({ fullPage });
+    try {
+        if (isCucumberRunner()) {
+            const world = global_1.webFixture.getWorld();
+            if (world && typeof world.attach === "function") {
+                await world.attach(screenshotBuffer, "image/png");
+                await world.attach(`Screenshot Text: ${text}`, "text/plain");
+                console.log(`✅ Screenshot attached via Cucumber World: ${text}`);
+            }
+            else {
+                console.warn(`⚠️ No Cucumber World context. Screenshot not attached.`);
+            }
+        }
+        else if (isPlaywrightRunner()) {
+            const { test } = await Promise.resolve().then(() => __importStar(require("@playwright/test")));
+            await test
+                .info()
+                .attach(text, { body: screenshotBuffer, contentType: "image/png" });
+            console.log(`✅ Screenshot attached via Playwright: ${text}`);
+        }
+        else {
+            console.warn(`⚠️ Unknown runner context. Screenshot not attached.`);
+        }
+    }
+    catch (error) {
+        console.warn(`⚠️ Error attaching screenshot: ${error.message}`);
+    }
+}
+/**
+ * Web: Take Full Screenshot -options: {param}
+ *
+ * Captures a full-page screenshot by delegating to `takeScreenshot` with defaults.
+ *
+ * @param page - Playwright Page instance
+ * @param options - Optional JSON string or object (merged with defaults)
+ */
+async function takeFullScreenshot(page, options) {
+    const defaults = { screenshot: true, screenshotFullPage: true };
+    let opts = typeof options === 'string' ? defaults : { ...defaults, ...(options || {}) };
+    return takeScreenshot(page, opts);
+}

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

@@ -0,0 +1,21 @@
+/**
+ * Web: Load Test Data JSON -file: {param}
+ *
+ * Loads and parses JSON test data from a file.
+ *
+ * @param filePath - Path to JSON file
+ * @returns Parsed JSON content
+ * @throws Error if file does not exist or JSON parsing fails
+ */
+export declare function loadFromJson(filePath: string): Promise<any>;
+/**
+ * Web: Load Test Data CSV -file: {param}
+ *
+ * Loads CSV test data from a file and returns an array of objects.
+ *
+ * @param filePath - Path to CSV file
+ * @returns Array of row objects keyed by header names
+ * @throws Error if file does not exist or CSV is empty/invalid
+ */
+export declare function loadFromCsv(filePath: string): Promise<any[]>;
+export declare function generateSampleData(schema?: Record<string, any>): Promise<any>;

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

@@ -0,0 +1,211 @@
+"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.loadFromJson = loadFromJson;
+exports.loadFromCsv = loadFromCsv;
+exports.generateSampleData = generateSampleData;
+/**
+ * @file testDataActions.ts
+ *
+ * Test data helpers for PlayQ web actions.
+ * Supports JSON and CSV loading plus sample data generation via faker.
+ *
+ * Authors: PlayQ Team
+ * Version: v1.0.0
+ */
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const global_1 = require("../../../global");
+/**
+ * Web: Load Test Data JSON -file: {param}
+ *
+ * Loads and parses JSON test data from a file.
+ *
+ * @param filePath - Path to JSON file
+ * @returns Parsed JSON content
+ * @throws Error if file does not exist or JSON parsing fails
+ */
+async function loadFromJson(filePath) {
+    if (!filePath)
+        throw new Error("testData.loadFromJson: 'filePath' is required");
+    const abs = path.resolve(filePath);
+    if (!fs.existsSync(abs))
+        throw new Error(`testData.loadFromJson: File not found at '${abs}'`);
+    const content = fs.readFileSync(abs, 'utf-8');
+    try {
+        return JSON.parse(content);
+    }
+    catch (err) {
+        throw new Error(`testData.loadFromJson: Failed to parse JSON - ${(err === null || err === void 0 ? void 0 : err.message) || err}`);
+    }
+}
+/**
+ * Web: Load Test Data CSV -file: {param}
+ *
+ * Loads CSV test data from a file and returns an array of objects.
+ *
+ * @param filePath - Path to CSV file
+ * @returns Array of row objects keyed by header names
+ * @throws Error if file does not exist or CSV is empty/invalid
+ */
+async function loadFromCsv(filePath) {
+    if (!filePath)
+        throw new Error("testData.loadFromCsv: 'filePath' is required");
+    const abs = path.resolve(filePath);
+    if (!fs.existsSync(abs))
+        throw new Error(`testData.loadFromCsv: File not found at '${abs}'`);
+    const content = (fs.readFileSync(abs, 'utf-8') || '').trim();
+    if (!content)
+        throw new Error("testData.loadFromCsv: CSV file is empty");
+    const [headerLine, ...rows] = content.split(/\r?\n/);
+    if (!headerLine)
+        throw new Error("testData.loadFromCsv: Missing header line");
+    const headers = headerLine.split(',').map(h => h.trim());
+    return rows.filter(r => r && r.trim().length > 0).map(r => {
+        const cols = r.split(',');
+        const obj = {};
+        headers.forEach((h, i) => { var _a; return obj[h] = ((_a = cols[i]) !== null && _a !== void 0 ? _a : '').trim(); });
+        return obj;
+    });
+}
+/**
+ * Web: Generate Sample Data -schema: {param}
+ *
+ * Generates sample test data, optionally merged with a provided schema.
+ *
+ * @param schema - Optional object to override default generated fields
+ * @returns Object containing generated sample fields
+ */
+function generateValueByDescriptor(descriptor) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7;
+    const d = (descriptor || '').toString().toLowerCase().trim();
+    switch (d) {
+        case 'string':
+            return ((_b = (_a = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.lorem) === null || _a === void 0 ? void 0 : _a.word) === null || _b === void 0 ? void 0 : _b.call(_a)) || 'sample';
+        case 'number':
+        case 'int':
+        case 'integer':
+            return (_e = (_d = (_c = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.number) === null || _c === void 0 ? void 0 : _c.int) === null || _d === void 0 ? void 0 : _d.call(_c, { min: 0, max: 9999 })) !== null && _e !== void 0 ? _e : 0;
+        case 'float':
+        case 'decimal':
+            return (_h = (_g = (_f = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.number) === null || _f === void 0 ? void 0 : _f.float) === null || _g === void 0 ? void 0 : _g.call(_f, { min: 0, max: 9999, precision: 0.01 })) !== null && _h !== void 0 ? _h : 0.0;
+        case 'boolean':
+            return Math.random() < 0.5;
+        case 'email':
+            return ((_k = (_j = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.internet) === null || _j === void 0 ? void 0 : _j.email) === null || _k === void 0 ? void 0 : _k.call(_j)) || 'user@example.com';
+        case 'phone':
+        case 'phonenumber':
+            return ((_m = (_l = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.phone) === null || _l === void 0 ? void 0 : _l.number) === null || _m === void 0 ? void 0 : _m.call(_l)) || '1234567890';
+        case 'firstname':
+            return ((_p = (_o = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.person) === null || _o === void 0 ? void 0 : _o.firstName) === null || _p === void 0 ? void 0 : _p.call(_o)) || 'John';
+        case 'lastname':
+            return ((_r = (_q = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.person) === null || _q === void 0 ? void 0 : _q.lastName) === null || _r === void 0 ? void 0 : _r.call(_q)) || 'Doe';
+        case 'fullname':
+        case 'name':
+            return `${((_t = (_s = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.person) === null || _s === void 0 ? void 0 : _s.firstName) === null || _t === void 0 ? void 0 : _t.call(_s)) || 'John'} ${((_v = (_u = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.person) === null || _u === void 0 ? void 0 : _u.lastName) === null || _v === void 0 ? void 0 : _v.call(_u)) || 'Doe'}`;
+        case 'uuid':
+            return ((_x = (_w = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.string) === null || _w === void 0 ? void 0 : _w.uuid) === null || _x === void 0 ? void 0 : _x.call(_w)) || '00000000-0000-0000-0000-000000000000';
+        case 'date':
+            return new Date().toISOString().slice(0, 10);
+        case 'datetime':
+        case 'isodatetime':
+            return new Date().toISOString();
+        case 'timestamp':
+            return Date.now();
+        case 'url':
+            return ((_z = (_y = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.internet) === null || _y === void 0 ? void 0 : _y.url) === null || _z === void 0 ? void 0 : _z.call(_y)) || 'https://example.com';
+        case 'ip':
+        case 'ipv4':
+            return ((_1 = (_0 = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.internet) === null || _0 === void 0 ? void 0 : _0.ip) === null || _1 === void 0 ? void 0 : _1.call(_0)) || '127.0.0.1';
+        case 'city':
+            return ((_3 = (_2 = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.location) === null || _2 === void 0 ? void 0 : _2.city) === null || _3 === void 0 ? void 0 : _3.call(_2)) || 'Metropolis';
+        case 'country':
+            return ((_5 = (_4 = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.location) === null || _4 === void 0 ? void 0 : _4.country) === null || _5 === void 0 ? void 0 : _5.call(_4)) || 'Wonderland';
+        case 'company':
+            return ((_7 = (_6 = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.company) === null || _6 === void 0 ? void 0 : _6.name) === null || _7 === void 0 ? void 0 : _7.call(_6)) || 'ACME Inc.';
+        default:
+            // Unknown descriptor → return as-is to avoid surprises
+            return descriptor;
+    }
+}
+function generateFromSchema(schema) {
+    if (schema == null)
+        return schema;
+    if (Array.isArray(schema)) {
+        // If array has a single descriptor like ['string'], generate a small array of values
+        if (schema.length === 1 && typeof schema[0] === 'string') {
+            return [generateValueByDescriptor(schema[0]), generateValueByDescriptor(schema[0])];
+        }
+        // Otherwise, map values
+        return schema.map((v) => (typeof v === 'string' ? generateValueByDescriptor(v) : generateFromSchema(v)));
+    }
+    if (typeof schema === 'object') {
+        const out = {};
+        for (const [k, v] of Object.entries(schema)) {
+            if (typeof v === 'string') {
+                out[k] = generateValueByDescriptor(v);
+            }
+            else if (typeof v === 'number' || typeof v === 'boolean') {
+                out[k] = v;
+            }
+            else if (Array.isArray(v)) {
+                out[k] = generateFromSchema(v);
+            }
+            else if (typeof v === 'object' && v !== null) {
+                out[k] = generateFromSchema(v);
+            }
+            else {
+                out[k] = v;
+            }
+        }
+        return out;
+    }
+    if (typeof schema === 'string')
+        return generateValueByDescriptor(schema);
+    return schema;
+}
+async function generateSampleData(schema) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const sample = {
+        firstName: ((_b = (_a = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.person) === null || _a === void 0 ? void 0 : _a.firstName) === null || _b === void 0 ? void 0 : _b.call(_a)) || 'John',
+        lastName: ((_d = (_c = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.person) === null || _c === void 0 ? void 0 : _c.lastName) === null || _d === void 0 ? void 0 : _d.call(_c)) || 'Doe',
+        email: ((_f = (_e = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.internet) === null || _e === void 0 ? void 0 : _e.email) === null || _f === void 0 ? void 0 : _f.call(_e)) || 'john.doe@example.com',
+        phone: ((_h = (_g = global_1.faker === null || global_1.faker === void 0 ? void 0 : global_1.faker.phone) === null || _g === void 0 ? void 0 : _g.number) === null || _h === void 0 ? void 0 : _h.call(_g)) || '1234567890'
+    };
+    if (!schema)
+        return sample;
+    const interpreted = generateFromSchema(schema);
+    return { ...sample, ...interpreted };
+}