playwright-cucumber-ts-steps 1.0.1 → 1.0.3

package/dist/core/runner.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.runTests = runTests;
+// src/core/runner.ts
+const test_1 = require("@playwright/test");
+const fs = __importStar(require("fs"));
+const glob_1 = require("glob");
+const registry_1 = require("./registry");
+// LOAD BACKEND LIBRARIES
+require("../backend/actions/index");
+require("../backend/assertions/index");
+require("../backend/elements/index");
+require("../backend/api/index");
+require("../backend/auth/index");
+const state_1 = require("../backend/db/state");
+require("../backend/db/index"); // Register DB steps
+/**
+ * The main test runner. Parses feature files and executes them as Playwright tests.
+ * Includes support for Data Tables and Auto-Screenshots.
+ */
+function runTests(featureGlob, options) {
+    // 1. Register DB Adapter if provided
+    if (options?.dbQuery) {
+        state_1.dbState.setAdapter(options.dbQuery);
+    }
+    const files = (0, glob_1.globSync)(featureGlob);
+    for (const file of files) {
+        const content = fs.readFileSync(file, "utf8");
+        const featureMatch = content.match(/Feature:\s*(.+)/);
+        const featureName = featureMatch
+            ? featureMatch[1].trim()
+            : "Unnamed Feature";
+        test_1.test.describe(featureName, () => {
+            const scenarioRegex = /(?:(@[\w\s@]+)\s+)?Scenario:\s*(.+)/g;
+            let match;
+            while ((match = scenarioRegex.exec(content)) !== null) {
+                // 1. CAPTURE DATA IMMEDIATELY
+                const foundTags = match[1] || "";
+                const scenarioName = match[2].trim();
+                const startIndex = match.index + match[0].length;
+                const nextMatchIndex = content.slice(startIndex).search(/Scenario:/);
+                const blockEnd = nextMatchIndex === -1 ? content.length : startIndex + nextMatchIndex;
+                const scenarioBlock = content.slice(startIndex, blockEnd);
+                if (options?.tags && !foundTags.includes(options.tags)) {
+                    continue;
+                }
+                (0, test_1.test)(scenarioName, async ({ page }, testInfo) => {
+                    const lines = scenarioBlock
+                        .trim()
+                        .split("\n")
+                        .map((l) => l.trim())
+                        .filter((l) => l);
+                    // CHANGED: Use index loop to handle Data Tables (look-ahead)
+                    for (let i = 0; i < lines.length; i++) {
+                        const stepText = lines[i];
+                        if (stepText.startsWith("#") ||
+                            stepText.startsWith("@") ||
+                            stepText === "")
+                            continue;
+                        // 2. CHECK FOR DATA TABLE
+                        // We look at the NEXT lines to see if they start with a pipe '|'
+                        const tableData = [];
+                        while (i + 1 < lines.length && lines[i + 1].startsWith("|")) {
+                            i++; // Move the index forward so we don't process this line as a step
+                            const row = lines[i]
+                                .split("|")
+                                .map((cell) => cell.trim())
+                                .filter((cell) => cell !== ""); // Remove empty start/end strings from split
+                            tableData.push(row);
+                        }
+                        // 3. CLEAN STEP TEXT
+                        // Remove "Given/When/..." and trailing colons ":"
+                        const cleanStep = stepText
+                            .replace(/^(Given|When|Then|And|But)\s+/i, "")
+                            .replace(/:$/, "")
+                            .trim();
+                        const stepDef = findMatchingStep(cleanStep);
+                        if (!stepDef) {
+                            throw new Error(`❌ Undefined Step: "${cleanStep}"`);
+                        }
+                        // 4. EXECUTE WITH ERROR HANDLING
+                        try {
+                            // Construct arguments: Regex args + Table data (if exists)
+                            const args = [...stepDef.args];
+                            if (tableData.length > 0) {
+                                args.push(tableData);
+                            }
+                            // Pass 'page' + args to the step function
+                            await stepDef.fn(page, ...args);
+                        }
+                        catch (error) {
+                            console.error(`❌ Failed at step: "${stepText}"`);
+                            // Take a screenshot immediately
+                            const screenshot = await page.screenshot({
+                                fullPage: true,
+                                type: "png",
+                            });
+                            await testInfo.attach("failure-screenshot", {
+                                body: screenshot,
+                                contentType: "image/png",
+                            });
+                            throw error;
+                        }
+                    }
+                });
+            }
+        });
+    }
+}
+function findMatchingStep(text) {
+    for (const step of registry_1.stepRegistry) {
+        const match = step.expression.match(text);
+        if (match) {
+            return { fn: step.fn, args: match.map((arg) => arg.getValue(null)) };
+        }
+    }
+    return null;
+}

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReporters = exports.Step = exports.runTests = void 0;
+// src/index.ts
+var runner_1 = require("./core/runner");
+Object.defineProperty(exports, "runTests", { enumerable: true, get: function () { return runner_1.runTests; } });
+var registry_1 = require("./core/registry"); // Export this in case users want to add custom steps
+Object.defineProperty(exports, "Step", { enumerable: true, get: function () { return registry_1.Step; } });
+var index_1 = require("./reporting/index");
+Object.defineProperty(exports, "getReporters", { enumerable: true, get: function () { return index_1.getReporters; } });

package/dist/reporting/index.js

@@ -0,0 +1,43 @@
+"use strict";
+// src/reporting/index.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReporters = getReporters;
+/**
+ * Helper to generate Playwright Reporter configuration.
+ * * @param options - Select which reporters to enable ('html', 'slack', etc.)
+ * @returns An array suitable for the 'reporter' field in playwright.config.ts
+ */
+function getReporters(options) {
+    const reporters = [];
+    // 1. ALWAYS ADD LIST (So they see progress in terminal)
+    reporters.push(["list"]);
+    // 2. HTML REPORTER (Priority 1)
+    if (options.on.includes("html")) {
+        reporters.push([
+            "html",
+            { open: "on-failure", outputFolder: "playwright-report" },
+        ]);
+    }
+    // 3. JSON REPORTER (Useful for CI)
+    if (options.on.includes("json")) {
+        reporters.push(["json", { outputFile: "results.json" }]);
+    }
+    // 4. SLACK REPORTER (Requires external package)
+    if (options.on.includes("slack")) {
+        if (!options.slackWebhookUrl) {
+            console.warn("⚠️ Slack reporter requested but no Webhook URL provided.");
+        }
+        else {
+            // We assume the user has installed 'playwright-slack-report'
+            // We return the config string that Playwright expects
+            reporters.push([
+                "playwright-slack-report",
+                {
+                    sendResults: "always", // 'always' | 'on-failure' | 'off'
+                    slackWebHookUrl: options.slackWebhookUrl,
+                },
+            ]);
+        }
+    }
+    return reporters;
+}

package/package.json

@@ -1,113 +1,31 @@
 {
   "name": "playwright-cucumber-ts-steps",
-  "version": "1.0.1",
-  "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": "commonjs",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "exports": {
-    ".": {
-      "import": "./lib/index.js"
-    },
-    "./register": {
-      "import": "./lib/register.js"
-    }
-  },
-  "sideEffects": false,
-  "typesVersions": {
-    "*": {
-      "*": [
-        "lib/*"
-      ]
-    }
-  },
+  "version": "1.0.3",
+  "private": false,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "docs": "typedoc",
-    "docs:deploy": "gh-pages -d temp-docs",
-    "prepare": "husky",
-    "lint": "eslint . --ext .ts",
-    "lint:fix": "eslint . --ext .ts --fix",
-    "lint:tsc": "tsc --noEmit",
-    "format": "prettier --write .",
-    "clean": "rm -rf playwright/report",
-    "test": "npm run clean && cucumber-js --config playwright/config/cucumber.js",
-    "commitlint": "commitlint --edit"
-  },
-  "lint-staged": {
-    "*.{js,ts,tsx,json,md}": [
-      "eslint --fix",
-      "prettier --write"
-    ]
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
+    "prepublishOnly": "npm run build"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/qaPaschalE/playwright-cucumber-ts-steps.git"
-  },
-  "keywords": [
-    "playwright",
-    "cucumber",
-    "typescript",
-    "e2e",
-    "steps",
-    "step-definitions",
-    "testing",
-    "automation",
-    "bdd",
-    "api",
-    "ui",
-    "web",
-    "end-to-end",
-    "behavior-driven",
-    "mobile",
-    "visual-testing"
-  ],
-  "author": "qaPaschalE <paschal.enyimiri@gmail.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/qaPaschalE/playwright-cucumber-ts-steps/issues"
+  "dependencies": {
+    "@cucumber/cucumber-expressions": "^17.1.0",
+    "@cucumber/gherkin": "^27.0.0",
+    "@cucumber/messages": "^22.0.0",
+    "glob": "^10.3.10"
   },
-  "homepage": "https://github.com/qaPaschalE/playwright-cucumber-ts-steps#readme",
   "peerDependencies": {
-    "@cucumber/cucumber": "*",
-    "@playwright/test": "*"
-  },
-  "files": [
-    "lib/",
-    "src/"
-  ],
-  "dependencies": {
-    "@cucumber/tag-expressions": "^6.2.0",
-    "@faker-js/faker": "^9.8.0",
-    "dayjs": "^1.11.13",
-    "dotenv-cli": "^8.0.0",
-    "glob": "^11.0.3",
-    "parse": "^6.1.1",
-    "pixelmatch": "^7.1.0",
-    "pngjs": "^7.0.0"
+    "@playwright/test": "^1.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@types/pngjs": "^6.0.5",
-    "eslint": "^9.29.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-import": "^2.32.0",
-    "gh-pages": "^6.3.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.1.2",
-    "prettier": "^3.5.3",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.28.5",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.34.1"
+    "@playwright/test": "^1.41.0",
+    "@types/glob": "^8.1.0",
+    "@types/node": "^20.11.0",
+    "typedoc": "^0.28.15",
+    "typescript": "^5.3.3"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Chetachi (Paschal) Enyimiri 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/lib/actions/clickSteps.d.ts

@@ -1,251 +0,0 @@
-import { DataTable } from "@cucumber/cucumber";
-import { CustomWorld } from "../helpers/world";
-/**
- * Clicks on the previously stored element.
- *
- * ```gherkin
- * When I click
- * ```
- *
- * @example
- * ```gherkin
- * When I click
- * ```
- * @remarks
- * Requires a previous step that stores an element.
- * @category Click Steps
- */
-export declare function When_I_click(this: CustomWorld, ...rest: any[]): Promise<void>;
-/**
- * Clicks on an element matching the given selector.
- *
- * ```gherkin
- * When I click on element {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I click on element ".my-class"
- * ```
- * @remarks
- * Stores the clicked element for later use.
- * @category Click Steps
- */
-export declare function When_I_click_on_element(this: CustomWorld, selector: string, ...rest: any[]): Promise<void>;
-/**
- * Clicks on a button with the given label.
- *
- * ```gherkin
- * When I click on button {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I click on button "Submit"
- * ```
- * @remarks
- * Stores the clicked button for later use.
- * @category Click Steps
- */
-export declare function When_I_click_on_button(this: CustomWorld, label: string, ...rest: any[]): Promise<void>;
-/**
- * Clicks on a link with the given text.
- *
- * ```gherkin
- * When I click on link {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I click on link "Home"
- * ```
- * @remarks
- * Stores the clicked link for later use.
- * @category Click Steps
- */
-export declare function When_I_click_on_link(this: CustomWorld, text: string, ...rest: any[]): Promise<void>;
-/**
- * Clicks on a label with the given text.
- *
- * ```gherkin
- * When I click on label {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I click on label "Username"
- * ```
- * @remarks
- * Stores the clicked label for later use.
- * @category Click Steps
- */
-export declare function When_I_click_on_label(this: CustomWorld, labelText: string, ...rest: any[]): Promise<void>;
-/**
- * Clicks on an element containing the given text (not exact match). Supports aliasing with @alias.
- *
- * ```gherkin
- * When I click on text {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I click on text "Welcome"
- * When I click on text "@username"
- * ```
- * @remarks
- * Stores the clicked element for later use.
- * @category Click Steps
- */
-export declare function When_I_click_on_text(this: CustomWorld, rawText: string, ...rest: any[]): Promise<void>;
-/**
- * Clicks on an element containing the exact given text.
- *
- * ```gherkin
- * When I click on exact text {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I click on exact text "Log out"
- * ```
- * @remarks
- * Stores the clicked element for later use.
- * @category Click Steps
- */
-export declare function When_I_click_on_exact_text(this: CustomWorld, exactText: string, ...rest: any[]): Promise<void>;
-/**
- * Clicks all previously stored elements.
- *
- * ```gherkin
- * When I click all
- * ```
- *
- * @example
- * ```gherkin
- * When I click all
- * ```
- * @remarks
- * Requires a previous step that stores elements.
- * @category Click Steps
- */
-export declare function When_I_click_all(this: CustomWorld, ...rest: any[]): Promise<void>;
-/**
- * Double-clicks on an element containing the given text.
- *
- * ```gherkin
- * When I double click on text {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I double click on text "Edit"
- * ```
- * @remarks
- * Uses the previously stored element if available.
- * @category Click Steps
- */
-export declare function When_I_double_click_on_text(this: CustomWorld, text: string, ...rest: any[]): Promise<void>;
-/**
- * Double-clicks at the given page coordinates.
- *
- * ```gherkin
- * When I double click position {int} {int}
- * ```
- *
- * @example
- * ```gherkin
- * When I double click position 100 200
- * ```
- * @category Click Steps
- */
-export declare function When_I_double_click_position(this: CustomWorld, x: number, y: number, ...rest: any[]): Promise<void>;
-/**
- * Double-clicks on the previously stored element.
- *
- * ```gherkin
- * When I double click
- * ```
- *
- * @example
- * ```gherkin
- * When I double click
- * ```
- * @remarks
- * Requires a previous step that stores an element.
- * @category Click Steps
- */
-export declare function When_I_double_click(this: CustomWorld, ...rest: any[]): Promise<void>;
-/**
- * Right-clicks on the previously stored element.
- *
- * ```gherkin
- * When I right click
- * ```
- *
- * @example
- * ```gherkin
- * When I right click
- * ```
- * @remarks
- * Requires a previous step that stores an element.
- * @category Click Steps
- */
-export declare function When_I_right_click(this: CustomWorld, ...rest: any[]): Promise<void>;
-/**
- * Right-clicks on an element containing the given text.
- *
- * ```gherkin
- * When I right click on text {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I right click on text "Options"
- * ```
- * @category Click Steps
- */
-export declare function When_I_right_click_on_text(this: CustomWorld, text: string, ...rest: any[]): Promise<void>;
-/**
- * Right-clicks at the given page coordinates.
- *
- * ```gherkin
- * When I right click position {int} {int}
- * ```
- *
- * @example
- * ```gherkin
- * When I right click position 50 50
- * ```
- * @category Click Steps
- */
-export declare function When_I_right_click_position(this: CustomWorld, x: number, y: number, ...rest: any[]): Promise<void>;
-/**
- * Clicks all stored elements (alternative signature).
- *
- * ```gherkin
- * When I click all
- * ```
- *
- * @example
- * ```gherkin
- * When I click all
- * ```
- * @remarks
- * Requires a previous step that stores elements.
- * @category Click Steps
- */
-export declare function When_I_click_all_alt(this: CustomWorld, dataTable?: DataTable): Promise<void>;
-/**
- * Clicks on an element matching the given selector (regex step).
- *
- * ```gherkin
- * When I click on selector {string}
- * ```
- *
- * @example
- * ```gherkin
- * When I click on selector ".my-selector"
- * ```
- * @category Click Steps
- */
-export declare function When_I_click_on_selector(this: CustomWorld, selector: string): Promise<void>;