playwright-cucumber-ts-steps 1.0.1 → 1.0.2

package/src/helpers/utils/fakerUtils.ts

@@ -1,64 +0,0 @@
-import { faker } from "@faker-js/faker";
-import dayjs from "dayjs";
-
-// Supports optional parameters
-type FakerMapping = Record<string, ((param?: string) => string) | (() => string)>;
-
-const fakerMapping: FakerMapping = {
-  "First Name": () => faker.person.middleName(),
-  Name: () => faker.person.middleName(),
-  "Last Name": () => faker.person.middleName(),
-  Email: () => faker.internet.email(),
-  "Phone Number": () => faker.string.numeric(10),
-  Number: () => faker.string.numeric(11),
-  "Complete Number": () => faker.string.numeric(11),
-  "App Colour": () => faker.color.rgb(),
-  "App Name": () => faker.commerce.productName(),
-  "Role Name": () => faker.person.jobTitle(),
-  "Company Name": () => faker.company.name(),
-  "Full Name": () => faker.person.fullName(),
-  "Disposable Email": () => faker.internet.email({ provider: "inboxkitten.com" }),
-  "ALpha Numeric": () => faker.string.numeric(11) + "e",
-  "Lorem Word": () => faker.lorem.sentences({ min: 1, max: 3 }),
-  Word: () => faker.lorem.word({ length: { min: 5, max: 11 } }),
-  "Current Date": () => dayjs().format("YYYY-MM-DD"),
-  "Current Date2": () => new Date().toISOString().split("T")[0],
-
-  MonthsFromNow: (months?: string) => {
-    const monthsToAdd = parseInt(months || "0", 10);
-    return dayjs().add(monthsToAdd, "month").format("YYYY-MM-DD");
-  },
-  MonthsAgo: (months?: string) => {
-    const monthsToSubtract = parseInt(months || "0", 10);
-    return dayjs().subtract(monthsToSubtract, "month").format("YYYY-MM-DD");
-  },
-
-  WeeksFromNow: (weeks?: string) => {
-    const weeksToAdd = parseInt(weeks || "0", 10);
-    return dayjs().add(weeksToAdd, "week").format("YYYY-MM-DD");
-  },
-  WeeksAgo: (weeks?: string) => {
-    const weeksToSubtract = parseInt(weeks || "0", 10);
-    return dayjs().subtract(weeksToSubtract, "week").format("YYYY-MM-DD");
-  },
-
-  DaysFromNow: (days?: string) => {
-    const daysToAdd = parseInt(days || "0", 10);
-    return dayjs().add(daysToAdd, "day").format("YYYY-MM-DD");
-  },
-  DaysAgo: (days?: string) => {
-    const daysToSubtract = parseInt(days || "0", 10);
-    return dayjs().subtract(daysToSubtract, "day").format("YYYY-MM-DD");
-  },
-};
-
-export function evaluateFaker(value: string): string {
-  const [key, param] = value.split(":");
-
-  const fn = fakerMapping[key];
-  if (typeof fn === "function") {
-    return fn(param);
-  }
-
-  return value; // fallback to raw value if not mapped
-}

package/src/helpers/utils/index.ts

@@ -1,4 +0,0 @@
-export * from "./fakerUtils";
-export * from "./optionsUtils";
-export * from "./resolveUtils";
-export * from "./sessionUtils";

package/src/helpers/utils/optionsUtils.ts

@@ -1,104 +0,0 @@
-//optionsUtils.ts
-import type { DataTable } from "@cucumber/cucumber";
-import type { Locator } from "@playwright/test";
-
-type ClickOptions = Parameters<Locator["click"]>[0];
-type DblClickOptions = Parameters<Locator["dblclick"]>[0];
-type HoverOptions = Parameters<Locator["hover"]>[0];
-type FillOptions = Parameters<Locator["fill"]>[1];
-type TypeOptions = Parameters<Locator["type"]>[1];
-type CheckOptions = Parameters<Locator["check"]>[0];
-type UncheckOptions = Parameters<Locator["uncheck"]>[0];
-type SelectOptionOptions = Parameters<Locator["selectOption"]>[1];
-
-type KeyboardModifier = NonNullable<NonNullable<ClickOptions>["modifiers"]>[number];
-
-export function parseClickOptions(table?: DataTable): Partial<ClickOptions> {
-  return parseGenericOptions(table) as Partial<ClickOptions>;
-}
-
-export function parseDblClickOptions(table?: DataTable): Partial<DblClickOptions> {
-  return parseGenericOptions(table) as Partial<DblClickOptions>;
-}
-
-export function parseHoverOptions(table?: DataTable): Partial<HoverOptions> {
-  return parseGenericOptions(table) as Partial<HoverOptions>;
-}
-
-export function parseTypeOptions(table?: DataTable): Partial<TypeOptions> {
-  return parseGenericOptions(table) as unknown as Partial<TypeOptions>;
-}
-
-export function parseFillOptions(table?: DataTable): Partial<FillOptions> {
-  return parseGenericOptions(table) as Partial<FillOptions>;
-}
-
-export function parseCheckOptions(table?: DataTable): Partial<CheckOptions> {
-  return parseGenericOptions(table) as Partial<CheckOptions>;
-}
-
-export function parseUncheckOptions(table?: DataTable): Partial<UncheckOptions> {
-  return parseGenericOptions(table) as Partial<UncheckOptions>;
-}
-
-export function parseSelectOptions(table?: DataTable): Partial<SelectOptionOptions> {
-  return parseGenericOptions(table) as Partial<SelectOptionOptions>;
-}
-
-export function parseGenericOptions(table?: DataTable): Record<string, any> {
-  if (!table) return {};
-
-  const options: Record<string, any> = {};
-  const rows = table.raw();
-
-  for (const [key, value] of rows) {
-    switch (key) {
-      case "timeout":
-      case "delay":
-      case "clickCount":
-        options[key] = Number(value);
-        break;
-
-      case "force":
-      case "noWaitAfter":
-      case "strict":
-      case "trial":
-        options[key] = value === "true";
-        break;
-
-      case "modifiers":
-        options.modifiers = value.split(",").map((v) => v.trim() as KeyboardModifier);
-        break;
-
-      case "button":
-        if (["left", "middle", "right"].includes(value)) {
-          options.button = value;
-        } else {
-          throw new Error(`Invalid button option: "${value}"`);
-        }
-        break;
-
-      case "position":
-        const [x, y] = value.split(",").map((n) => Number(n.trim()));
-        if (isNaN(x) || isNaN(y)) {
-          throw new Error(`Invalid position format: "${value}"`);
-        }
-        options.position = { x, y };
-        break;
-
-      default:
-        console.warn(`[⚠️ parseGenericOptions] Unknown option "${key}"`);
-        break;
-    }
-  }
-
-  return options;
-}
-export function parseExpectOptions(table?: DataTable): { timeout?: number; log?: boolean } {
-  if (!table) return {};
-  const obj = Object.fromEntries(table.rows());
-  return {
-    timeout: obj.timeout ? Number(obj.timeout) : undefined,
-    log: obj.log === "true",
-  };
-}

package/src/helpers/utils/resolveUtils.ts

@@ -1,74 +0,0 @@
-// src/helpers/utils/resolveUtils.ts
-import fs from "fs";
-import path from "path";
-import { devices } from "@playwright/test";
-import type { CustomWorld } from "../world";
-// Dynamic resolver
-export function resolveValue(input: string): string {
-  // 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.resolve("e2e/support/helper/test-data", `${fileName}.json`);
-    if (fs.existsSync(jsonPath)) {
-      const json = JSON.parse(fs.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;
-}
-
-export function resolveLoginValue(raw: string, world: CustomWorld): string | undefined {
-  // ✅ 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.resolve("test-data", `${filename}.json`);
-    if (!fs.existsSync(filePath)) {
-      throw new Error(`JSON fixture not found: ${filename}.json`);
-    }
-    const fileData = JSON.parse(fs.readFileSync(filePath, "utf-8"));
-    return fileData[key];
-  }
-
-  // ✅ Fallback to raw value
-  return raw;
-}
-// Determine session name from email or username
-export function deriveSessionName(emailOrUser: string, fallback = "default"): string {
-  if (!emailOrUser) return `${fallback}User`;
-
-  const base = emailOrUser.includes("@") ? emailOrUser.split("@")[0] : emailOrUser;
-
-  return `${base}User`;
-}
-
-export function resolveSessionPath(world: CustomWorld, name: string) {
-  const dir = path.resolve(world.data.artifactDir || "test-artifacts", "auth-cookies");
-  fs.mkdirSync(dir, { recursive: true });
-  return path.resolve(dir, name.endsWith(".json") ? name : `${name}.json`);
-}
-export function normalizeDeviceName(name: string): string {
-  return (
-    Object.keys(devices).find(
-      (device) =>
-        device.toLowerCase().replace(/\s+/g, "") === name.toLowerCase().replace(/[-_\s]+/g, "")
-    ) || ""
-  );
-}

package/src/helpers/utils/sessionUtils.ts

@@ -1,36 +0,0 @@
-//sessionUtils.ts
-import fs from "fs";
-import path from "path";
-import { BrowserContext } from "playwright";
-
-export async function injectStorage(world: any, type: string, key: string, value: string) {
-  const page = world.page;
-
-  if (type === "localStorage") {
-    await page.evaluate(([k, v]: [string, string]) => localStorage.setItem(k, v), [key, value]);
-  } else if (type === "sessionStorage") {
-    await page.evaluate(([k, v]: [string, string]) => 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",
-      },
-    ]);
-  }
-}
-
-export async function saveSessionData(context: BrowserContext, file: string) {
-  const storageState = await context.storageState();
-  const outDir = "test-artifacts/auth-cookies";
-  const outPath = path.resolve(outDir, file);
-
-  fs.mkdirSync(outDir, { recursive: true });
-  fs.writeFileSync(outPath, JSON.stringify(storageState, null, 2));
-  console.log(`💾 Saved session to ${outPath}`);
-}

package/src/helpers/world.ts

@@ -1,119 +0,0 @@
-import { setWorldConstructor, World, ITestCaseHookParameter } from "@cucumber/cucumber";
-import { Browser, Page, BrowserContext, Locator, FrameLocator, devices } from "@playwright/test";
-import * as dotenv from "dotenv";
-import { chromium } from "playwright";
-
-dotenv.config();
-
-const isHeadless = process.env.HEADLESS !== "false";
-const slowMo = process.env.SLOWMO ? Number(process.env.SLOWMO) : 0;
-
-// Define a minimal interface for the clock object you expect
-// This is to help TypeScript understand the shape of context.clock
-// interface PlaywrightClock {
-//   setFixedTime(time: number | Date): Promise<void>;
-//   tick(ms: number): Promise<void>;
-//   restore(): Promise<void>;
-// }
-
-// If you need to extend the Clock type, do it via module augmentation with compatible types.
-// Otherwise, do not redeclare the 'clock' property to avoid type conflicts.
-// Remove the BrowserContext augmentation for 'clock' to resolve the type error.
-
-export interface TestConfig {
-  enableScreenshots: boolean;
-  enableVisualTest: boolean;
-  artifactDir: string;
-}
-
-export 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 = {
-    enableScreenshots: true,
-    enableVisualTest: false,
-    artifactDir: "test-artifacts",
-  };
-
-  constructor(options: import("@cucumber/cucumber").IWorldOptions) {
-    super(options);
-    this.fakeTimersActive = false;
-  }
-
-  async init(testInfo?: ITestCaseHookParameter) {
-    const info =
-      testInfo ?? ((this as any).parameters?.testInfo as ITestCaseHookParameter | undefined);
-    const isMobile = info?.pickle.tags.some((tag) => tag.name === "@mobile");
-    const device = isMobile ? devices["Pixel 5"] : undefined;
-
-    this.browser = await 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(): Page | FrameLocator {
-    return this.frame ?? this.page;
-  }
-
-  /**
-   * Returns a Locator scoped to the current iframe or page.
-   */
-  getLocator(selector: string): Locator {
-    return this.getScope().locator(selector);
-  }
-
-  exitIframe() {
-    this.frame = undefined;
-    this.log("⬅️ Exited iframe, scope is now main page");
-  }
-
-  log = (message: string) => {
-    this.logs.push(message);
-    console.log(`[LOG] ${message}`);
-  };
-
-  async cleanup(testInfo?: ITestCaseHookParameter) {
-    try {
-      await this.page?.close();
-    } catch (err) {
-      this.log(`⚠️ Error closing page: ${(err as Error).message}`);
-    }
-
-    try {
-      await this.context?.close();
-    } catch (err) {
-      this.log(`⚠️ Error closing context: ${(err as Error).message}`);
-    }
-  }
-}
-
-setWorldConstructor(CustomWorld);

package/src/iframes/frames.ts

@@ -1,15 +0,0 @@
-import { When } from "@cucumber/cucumber";
-// import { expect } from "@playwright/test";
-import type { CustomWorld } from "../helpers/world";
-
-When(
-  "I find href in iframe {string} and store as {string}",
-  async function (this: CustomWorld, iframeSelector: string, key: string) {
-    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/src/index.ts

@@ -1,18 +0,0 @@
-// Iframes
-export * from "./iframes/frames";
-
-// Setup (custom hooks, login, etc.)
-export * from "./custom_setups/loginHooks";
-
-// Core helpers and utilities
-export * from "./helpers/compareSnapshots";
-export * from "./helpers/hooks";
-export * from "./helpers/utils";
-export * from "./helpers/world";
-
-// Types
-export type { CustomWorld } from "./helpers/world";
-
-export * from "./actions";
-export * from "./assertions";
-export * from "./custom_setups/loginHooks";

package/src/register.ts

@@ -1,4 +0,0 @@
-// src/register.ts
-import { checkPeerDependencies } from "./helpers/checkPeerDeps";
-checkPeerDependencies(["@cucumber/cucumber", "@playwright/test", "@faker-js/faker"]);
-import "./index";