playwright-cucumber-ts-steps 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export * from "./src";
-export * from "./helpers/world";
-export * from "./helpers/utils";
+export * from "./src/helpers/world";
+export * from "./src/helpers/utils";

package/dist/index.js

@@ -1,4 +1,4 @@
 // index.ts
 export * from "./src";
-export * from "./helpers/world";
-export * from "./helpers/utils";
+export * from "./src/helpers/world";
+export * from "./src/helpers/utils";

package/index.ts

@@ -1,4 +1,4 @@
 // index.ts
 export * from "./src";
-export * from "./helpers/world";
-export * from "./helpers/utils";
+export * from "./src/helpers/world";
+export * from "./src/helpers/utils";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-cucumber-ts-steps",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A collection of reusable Playwright step definitions for Cucumber in TypeScript, designed to streamline end-to-end testing across web, API, and mobile applications.",
   "type": "module",
   "types": "dist/index.d.ts",
@@ -8,6 +8,12 @@
   "scripts": {
     "build": "tsc"
   },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/qaPaschalE/playwright-cucumber-ts-steps.git"

package/register.ts

@@ -0,0 +1,31 @@
+// src/register.ts
+import "./src/helpers/world.js";
+
+// Custom setups
+import "./custom_setups/global-login.js";
+import "./custom_setups/loginHooks.js";
+
+// Actions
+import "./actions/Interception & Requests.js";
+import "./actions/clickSteps.js";
+import "./actions/cookieSteps.js";
+import "./actions/debugSteps.js";
+import "./actions/elementFindSteps.js";
+import "./actions/inputSteps.js";
+import "./actions/mouseSteps.js";
+import "./actions/miscSteps.js";
+import "./actions/scrollSteps.js";
+import "./actions/storageSteps.js";
+
+// Assertions
+import "./assertions/button_and_text_visibility.js";
+import "./assertions/cookieSteps.js";
+import "./assertions/elementSteps.js";
+import "./assertions/formInputSteps.js";
+import "./assertions/locationSteps.js";
+import "./assertions/roleTestIdSteps.js";
+import "./assertions/semanticSteps.js";
+import "./assertions/storageSteps.js";
+
+// Iframes
+import "./iframes/frames.js";

package/helpers/utils/fakerUtils.ts

@@ -1,68 +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/helpers/utils/index.ts

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

package/helpers/utils/optionsUtils.ts

@@ -1,106 +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>;
-}
-
-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;
-}

package/helpers/utils/resolveUtils.ts

@@ -1,69 +0,0 @@
-import fs from "fs";
-import path from "path";
-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`;
-}

package/helpers/world.ts

@@ -1,91 +0,0 @@
-// support/world.ts
-import {
-  setWorldConstructor,
-  World,
-  ITestCaseHookParameter,
-} from "@cucumber/cucumber";
-import {
-  Browser,
-  Page,
-  BrowserContext,
-  Locator,
-  FrameLocator,
-  devices,
-} from "@playwright/test";
-import { chromium } from "playwright";
-import * as dotenv from "dotenv";
-
-dotenv.config();
-
-const isHeadless = process.env.HEADLESS !== "false";
-const slowMo = process.env.SLOWMO ? Number(process.env.SLOWMO) : 0;
-
-export class CustomWorld extends World {
-  browser!: Browser;
-  context!: BrowserContext;
-  page!: Page;
-
-  elements?: Locator;
-  element?: Locator;
-  frame?: FrameLocator;
-
-  data: Record<string, any> = {};
-  logs: string[] = [];
-  testName?: string;
-
-  async init(testInfo?: ITestCaseHookParameter) {
-    const isMobile = testInfo?.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: "e2e/test-artifacts/videos" },
-    });
-
-    this.page = await this.context.newPage();
-    this.testName = testInfo?.pickle.name;
-    this.log(`🧪 Initialized context${isMobile ? " (mobile)" : ""}`);
-  }
-
-  getScope(): Page | FrameLocator {
-    return this.frame ?? this.page;
-  }
-
-  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) {
-    const failed = testInfo?.result?.status === "FAILED";
-
-    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}`);
-    }
-
-    try {
-      await this.browser?.close();
-    } catch (err) {
-      this.log(`⚠️ Error closing browser: ${(err as Error).message}`);
-    }
-  }
-}
-
-setWorldConstructor(CustomWorld);