playwright-cucumber-ts-steps 1.0.1 → 1.0.3

package/lib/helpers/utils/resolveUtils.js

@@ -1,72 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveValue = resolveValue;
-exports.resolveLoginValue = resolveLoginValue;
-exports.deriveSessionName = deriveSessionName;
-exports.resolveSessionPath = resolveSessionPath;
-exports.normalizeDeviceName = normalizeDeviceName;
-// src/helpers/utils/resolveUtils.ts
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const test_1 = require("@playwright/test");
-// Dynamic resolver
-function resolveValue(input) {
-    // Uppercase = environment variable (e.g. TEST_USER)
-    if (/^[A-Z0-9_]+$/.test(input)) {
-        const envVal = process.env[input];
-        if (!envVal) {
-            throw new Error(`Environment variable ${input} not found.`);
-        }
-        return envVal;
-    }
-    // Dot = JSON reference (e.g. userData.email)
-    if (input.includes(".")) {
-        const [fileName, fieldName] = input.split(".");
-        const jsonPath = path_1.default.resolve("e2e/support/helper/test-data", `${fileName}.json`);
-        if (fs_1.default.existsSync(jsonPath)) {
-            const json = JSON.parse(fs_1.default.readFileSync(jsonPath, "utf-8"));
-            const value = json[fieldName];
-            if (value !== undefined)
-                return value;
-            throw new Error(`Field "${fieldName}" not found in ${fileName}.json`);
-        }
-    }
-    // Default to hardcoded value
-    return input;
-}
-function resolveLoginValue(raw, world) {
-    // ✅ Alias: @aliasName
-    if (raw.startsWith("@")) {
-        return world.data[raw.slice(1)];
-    }
-    // ✅ JSON: user.json:key
-    if (raw.includes(".json:")) {
-        const [filename, key] = raw.split(".json:");
-        const filePath = path_1.default.resolve("test-data", `${filename}.json`);
-        if (!fs_1.default.existsSync(filePath)) {
-            throw new Error(`JSON fixture not found: ${filename}.json`);
-        }
-        const fileData = JSON.parse(fs_1.default.readFileSync(filePath, "utf-8"));
-        return fileData[key];
-    }
-    // ✅ Fallback to raw value
-    return raw;
-}
-// Determine session name from email or username
-function deriveSessionName(emailOrUser, fallback = "default") {
-    if (!emailOrUser)
-        return `${fallback}User`;
-    const base = emailOrUser.includes("@") ? emailOrUser.split("@")[0] : emailOrUser;
-    return `${base}User`;
-}
-function resolveSessionPath(world, name) {
-    const dir = path_1.default.resolve(world.data.artifactDir || "test-artifacts", "auth-cookies");
-    fs_1.default.mkdirSync(dir, { recursive: true });
-    return path_1.default.resolve(dir, name.endsWith(".json") ? name : `${name}.json`);
-}
-function normalizeDeviceName(name) {
-    return (Object.keys(test_1.devices).find((device) => device.toLowerCase().replace(/\s+/g, "") === name.toLowerCase().replace(/[-_\s]+/g, "")) || "");
-}

package/lib/helpers/utils/sessionUtils.d.ts

@@ -1,3 +0,0 @@
-import { BrowserContext } from "playwright";
-export declare function injectStorage(world: any, type: string, key: string, value: string): Promise<void>;
-export declare function saveSessionData(context: BrowserContext, file: string): Promise<void>;

package/lib/helpers/utils/sessionUtils.js

@@ -1,40 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.injectStorage = injectStorage;
-exports.saveSessionData = saveSessionData;
-//sessionUtils.ts
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-async function injectStorage(world, type, key, value) {
-    const page = world.page;
-    if (type === "localStorage") {
-        await page.evaluate(([k, v]) => localStorage.setItem(k, v), [key, value]);
-    }
-    else if (type === "sessionStorage") {
-        await page.evaluate(([k, v]) => sessionStorage.setItem(k, v), [key, value]);
-    }
-    else if (type === "cookie") {
-        await page.context.addCookies([
-            {
-                name: key,
-                value,
-                domain: new URL(page.url()).hostname,
-                path: "/",
-                httpOnly: false,
-                secure: true,
-                sameSite: "Lax",
-            },
-        ]);
-    }
-}
-async function saveSessionData(context, file) {
-    const storageState = await context.storageState();
-    const outDir = "test-artifacts/auth-cookies";
-    const outPath = path_1.default.resolve(outDir, file);
-    fs_1.default.mkdirSync(outDir, { recursive: true });
-    fs_1.default.writeFileSync(outPath, JSON.stringify(storageState, null, 2));
-    console.log(`💾 Saved session to ${outPath}`);
-}

package/lib/helpers/world.d.ts

@@ -1,34 +0,0 @@
-import { World, ITestCaseHookParameter } from "@cucumber/cucumber";
-import { Browser, Page, BrowserContext, Locator, FrameLocator } from "@playwright/test";
-export interface TestConfig {
-    enableScreenshots: boolean;
-    enableVisualTest: boolean;
-    artifactDir: string;
-}
-export declare class CustomWorld extends World {
-    browser: Browser;
-    context: BrowserContext;
-    page: Page;
-    elements?: Locator;
-    element?: Locator;
-    frame?: FrameLocator;
-    currentLocator?: Locator;
-    data: Record<string, any>;
-    logs: string[];
-    testName?: string;
-    fakeTimersActive: boolean;
-    config: TestConfig;
-    constructor(options: import("@cucumber/cucumber").IWorldOptions);
-    init(testInfo?: ITestCaseHookParameter): Promise<void>;
-    /**
-     * Returns the current interaction scope: either the main page or active frame.
-     */
-    getScope(): Page | FrameLocator;
-    /**
-     * Returns a Locator scoped to the current iframe or page.
-     */
-    getLocator(selector: string): Locator;
-    exitIframe(): void;
-    log: (message: string) => void;
-    cleanup(testInfo?: ITestCaseHookParameter): Promise<void>;
-}

package/lib/helpers/world.js

@@ -1,110 +0,0 @@
-"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.CustomWorld = void 0;
-const cucumber_1 = require("@cucumber/cucumber");
-const test_1 = require("@playwright/test");
-const dotenv = __importStar(require("dotenv"));
-const playwright_1 = require("playwright");
-dotenv.config();
-const isHeadless = process.env.HEADLESS !== "false";
-const slowMo = process.env.SLOWMO ? Number(process.env.SLOWMO) : 0;
-class CustomWorld extends cucumber_1.World {
-    constructor(options) {
-        super(options);
-        this.data = {};
-        this.logs = [];
-        this.config = {
-            enableScreenshots: true,
-            enableVisualTest: false,
-            artifactDir: "test-artifacts",
-        };
-        this.log = (message) => {
-            this.logs.push(message);
-            console.log(`[LOG] ${message}`);
-        };
-        this.fakeTimersActive = false;
-    }
-    async init(testInfo) {
-        const info = testInfo ?? this.parameters?.testInfo;
-        const isMobile = info?.pickle.tags.some((tag) => tag.name === "@mobile");
-        const device = isMobile ? test_1.devices["Pixel 5"] : undefined;
-        this.browser = await playwright_1.chromium.launch({ headless: isHeadless, slowMo });
-        this.context = await this.browser.newContext({
-            ...(device || {}),
-            recordVideo: { dir: `${this.config.artifactDir}/videos` },
-        });
-        // Important: Initialize clock mocking *before* navigating or interacting with the page
-        // if you intend to use page.clock. This typically involves addInitScript.
-        // However, the context.clock API does not usually require an init script for its methods.
-        // If you explicitly loaded a mocking library, you'd do it here.
-        // For just context.clock methods, they should be available.
-        this.page = await this.context.newPage();
-        this.testName = info?.pickle.name;
-        this.log(`🧪 Initialized context${isMobile ? " (mobile)" : ""}`);
-    }
-    /**
-     * Returns the current interaction scope: either the main page or active frame.
-     */
-    getScope() {
-        return this.frame ?? this.page;
-    }
-    /**
-     * Returns a Locator scoped to the current iframe or page.
-     */
-    getLocator(selector) {
-        return this.getScope().locator(selector);
-    }
-    exitIframe() {
-        this.frame = undefined;
-        this.log("⬅️ Exited iframe, scope is now main page");
-    }
-    async cleanup(testInfo) {
-        try {
-            await this.page?.close();
-        }
-        catch (err) {
-            this.log(`⚠️ Error closing page: ${err.message}`);
-        }
-        try {
-            await this.context?.close();
-        }
-        catch (err) {
-            this.log(`⚠️ Error closing context: ${err.message}`);
-        }
-    }
-}
-exports.CustomWorld = CustomWorld;
-(0, cucumber_1.setWorldConstructor)(CustomWorld);

package/lib/iframes/frames.d.ts

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

package/lib/iframes/frames.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cucumber_1 = require("@cucumber/cucumber");
-(0, cucumber_1.When)("I find href in iframe {string} and store as {string}", async function (iframeSelector, key) {
-    const iframe = this.page.frameLocator(iframeSelector);
-    const link = await iframe.locator("a[href]").first();
-    const href = await link.getAttribute("href");
-    if (!href)
-        throw new Error("No link found in iframe.");
-    this.data[key] = href;
-});

package/lib/index.d.ts

@@ -1,10 +0,0 @@
-export * from "./iframes/frames";
-export * from "./custom_setups/loginHooks";
-export * from "./helpers/compareSnapshots";
-export * from "./helpers/hooks";
-export * from "./helpers/utils";
-export * from "./helpers/world";
-export type { CustomWorld } from "./helpers/world";
-export * from "./actions";
-export * from "./assertions";
-export * from "./custom_setups/loginHooks";

package/lib/index.js

@@ -1,28 +0,0 @@
-"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 __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 });
-// Iframes
-__exportStar(require("./iframes/frames"), exports);
-// Setup (custom hooks, login, etc.)
-__exportStar(require("./custom_setups/loginHooks"), exports);
-// Core helpers and utilities
-__exportStar(require("./helpers/compareSnapshots"), exports);
-__exportStar(require("./helpers/hooks"), exports);
-__exportStar(require("./helpers/utils"), exports);
-__exportStar(require("./helpers/world"), exports);
-__exportStar(require("./actions"), exports);
-__exportStar(require("./assertions"), exports);
-__exportStar(require("./custom_setups/loginHooks"), exports);

package/lib/register.d.ts

@@ -1 +0,0 @@
-import "./index";

package/lib/register.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// src/register.ts
-const checkPeerDeps_1 = require("./helpers/checkPeerDeps");
-(0, checkPeerDeps_1.checkPeerDependencies)(["@cucumber/cucumber", "@playwright/test", "@faker-js/faker"]);
-require("./index");