@thefehr/foundry-playwright 0.2.1

package/dist/ui/base.js

@@ -0,0 +1,43 @@
+/**
+ * Default UI adapter for standard Foundry VTT interface.
+ */
+export class DefaultUIAdapter {
+    id = "default";
+    getActorSheetSelector() {
+        return ".window-app.sheet.actor";
+    }
+    async switchAppTab(page, appSelector, tabName) {
+        const app = page.locator(appSelector);
+        // Support for both V1 (nav.tabs a.item) and V2 (nav.tabs [data-tab])
+        const tabSelectors = [
+            `nav.tabs [data-tab]:has-text("${tabName}")`,
+            `nav.tabs [data-action="tab"]:has-text("${tabName}")`,
+            `nav.tabs a.item:has-text("${tabName}")`,
+            `[data-tab]:has-text("${tabName}")`,
+        ];
+        let clicked = false;
+        for (const selector of tabSelectors) {
+            const candidate = app.locator(selector).first();
+            if ((await candidate.count()) > 0 && (await candidate.isVisible())) {
+                await candidate.click();
+                clicked = true;
+                break;
+            }
+        }
+        if (!clicked) {
+            throw new Error(`Could not find tab "${tabName}" in application ${appSelector}`);
+        }
+    }
+    async handleCollapsibleSection(page, appSelector, sectionName) {
+        const app = page.locator(appSelector);
+        const section = app.locator(".form-group, .section, details").filter({ hasText: sectionName });
+        // Core Foundry doesn't have many collapsible sections by default,
+        // but we'll check for 'details' or custom classes
+        const details = section.locator("details").first();
+        if ((await details.count()) > 0) {
+            const isOpen = await details.evaluate((el) => el.open);
+            if (!isOpen)
+                await details.locator("summary").click();
+        }
+    }
+}

package/dist/ui/dnd5e.d.ts

@@ -0,0 +1,8 @@
+import { DefaultUIAdapter } from "./base.js";
+/**
+ * UI adapter for the standard Dungeons & Dragons Fifth Edition sheets.
+ */
+export declare class DnD5eUIAdapter extends DefaultUIAdapter {
+    id: string;
+    getActorSheetSelector(): string;
+}

package/dist/ui/dnd5e.js

@@ -0,0 +1,10 @@
+import { DefaultUIAdapter } from "./base.js";
+/**
+ * UI adapter for the standard Dungeons & Dragons Fifth Edition sheets.
+ */
+export class DnD5eUIAdapter extends DefaultUIAdapter {
+    id = "dnd5e";
+    getActorSheetSelector() {
+        return "foundry-app, .window-app.dnd5e.sheet.actor, [id^='dnd5e-actor-'], [id^='actor-character-']";
+    }
+}

package/dist/ui/index.d.ts

@@ -0,0 +1,45 @@
+import { Page } from "@playwright/test";
+import { UIAdapter } from "./base.js";
+/**
+ * Gets a UI adapter by its ID.
+ */
+export declare function getUIAdapter(id: string): UIAdapter;
+/**
+ * Registers a new UI adapter.
+ */
+export declare function registerUIAdapter(adapter: UIAdapter): void;
+/**
+ * Provides methods for interacting with the Foundry VTT UI.
+ */
+export declare class FoundryUI {
+    private page;
+    private adapter;
+    constructor(page: Page, adapterId?: string);
+    /**
+     * Sets the UI adapter to use.
+     */
+    setAdapter(adapterId: string): void;
+    /**
+     * Gets the CSS selector for actor sheets.
+     */
+    getActorSheetSelector(): string;
+    /**
+     * Switches to a specific tab on an application.
+     */
+    switchTab(appSelector: string, tabName: string): Promise<void>;
+    /**
+     * Switches to a specific tab on an actor sheet.
+     */
+    switchActorTab(actorName: string, tabName: string): Promise<void>;
+    /**
+     * Expands a collapsible section if it is currently collapsed.
+     */
+    handleCollapsibleSection(appSelector: string, sectionName: string): Promise<void>;
+    /**
+     * Simulates a drag-and-drop event in Foundry VTT.
+     */
+    simulateDrop(targetSelector: string, data: any): Promise<void>;
+}
+export * from "./base.js";
+export * from "./tidy5e.js";
+export * from "./dnd5e.js";

package/dist/ui/index.js

@@ -0,0 +1,72 @@
+import { DefaultUIAdapter } from "./base.js";
+import { Tidy5eUIAdapter } from "./tidy5e.js";
+import { DnD5eUIAdapter } from "./dnd5e.js";
+const adapters = {
+    default: new DefaultUIAdapter(),
+    "tidy5e-sheet": new Tidy5eUIAdapter(),
+    dnd5e: new DnD5eUIAdapter(),
+};
+/**
+ * Gets a UI adapter by its ID.
+ */
+export function getUIAdapter(id) {
+    return adapters[id] || adapters["default"];
+}
+/**
+ * Registers a new UI adapter.
+ */
+export function registerUIAdapter(adapter) {
+    adapters[adapter.id] = adapter;
+}
+/**
+ * Provides methods for interacting with the Foundry VTT UI.
+ */
+export class FoundryUI {
+    page;
+    adapter;
+    constructor(page, adapterId = "default") {
+        this.page = page;
+        this.adapter = getUIAdapter(adapterId);
+    }
+    /**
+     * Sets the UI adapter to use.
+     */
+    setAdapter(adapterId) {
+        this.adapter = getUIAdapter(adapterId);
+    }
+    /**
+     * Gets the CSS selector for actor sheets.
+     */
+    getActorSheetSelector() {
+        return this.adapter.getActorSheetSelector();
+    }
+    /**
+     * Switches to a specific tab on an application.
+     */
+    async switchTab(appSelector, tabName) {
+        await this.adapter.switchAppTab(this.page, appSelector, tabName);
+    }
+    /**
+     * Switches to a specific tab on an actor sheet.
+     */
+    async switchActorTab(actorName, tabName) {
+        const selector = `${this.adapter.getActorSheetSelector()}:has-text("${actorName}")`;
+        await this.switchTab(selector, tabName);
+    }
+    /**
+     * Expands a collapsible section if it is currently collapsed.
+     */
+    async handleCollapsibleSection(appSelector, sectionName) {
+        await this.adapter.handleCollapsibleSection(this.page, appSelector, sectionName);
+    }
+    /**
+     * Simulates a drag-and-drop event in Foundry VTT.
+     */
+    async simulateDrop(targetSelector, data) {
+        const { simulateFoundryDrop } = await import("../helpers.js");
+        await simulateFoundryDrop(this.page, targetSelector, data);
+    }
+}
+export * from "./base.js";
+export * from "./tidy5e.js";
+export * from "./dnd5e.js";

package/dist/ui/tidy5e.d.ts

@@ -0,0 +1,11 @@
+import { Page } from "@playwright/test";
+import { DefaultUIAdapter } from "./base.js";
+/**
+ * UI adapter for the Tidy 5e Sheets module.
+ */
+export declare class Tidy5eUIAdapter extends DefaultUIAdapter {
+    id: string;
+    getActorSheetSelector(): string;
+    switchAppTab(page: Page, appSelector: string, tabName: string): Promise<void>;
+    handleCollapsibleSection(page: Page, appSelector: string, sectionName: string): Promise<void>;
+}

package/dist/ui/tidy5e.js

@@ -0,0 +1,30 @@
+import { expect } from "@playwright/test";
+import { DefaultUIAdapter } from "./base.js";
+/**
+ * UI adapter for the Tidy 5e Sheets module.
+ */
+export class Tidy5eUIAdapter extends DefaultUIAdapter {
+    id = "tidy5e-sheet";
+    getActorSheetSelector() {
+        return ".tidy5e-sheet.actor, .tidy5e-sheet.group";
+    }
+    async switchAppTab(page, appSelector, tabName) {
+        const app = page.locator(appSelector);
+        // Tidy5e might use different navigation or tab structures, especially for Group actors
+        const tabItem = app
+            .locator(".tidy-tabs [data-tab], nav.tabs a.item, .navigation .item")
+            .filter({ hasText: tabName })
+            .first();
+        await tabItem.evaluate((el) => el.click());
+        // In Tidy5e, the active state might be checked differently, but usually it's still a class
+        await expect(tabItem).toHaveClass(/active|selected/);
+    }
+    async handleCollapsibleSection(page, appSelector, sectionName) {
+        const app = page.locator(appSelector);
+        const section = app.locator(".tidy-collapsible").filter({ hasText: sectionName });
+        const isCollapsed = await section.evaluate((el) => el.classList.contains("collapsed"));
+        if (isCollapsed) {
+            await section.locator(".tidy-collapsible-header").click();
+        }
+    }
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@thefehr/foundry-playwright",
+  "version": "0.2.1",
+  "description": "A robust, multi-version E2E testing library for FoundryVTT modules and systems, powered by Playwright.",
+  "keywords": [
+    "e2e",
+    "foundryvtt",
+    "playwright",
+    "testing"
+  ],
+  "homepage": "https://github.com/TheFehr/foundry-playwright#readme",
+  "bugs": {
+    "url": "https://github.com/TheFehr/foundry-playwright/issues"
+  },
+  "license": "MIT",
+  "author": "TheFehr",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TheFehr/foundry-playwright.git"
+  },
+  "bin": {
+    "foundry-playwright": "./dist/cli/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "test:e2e": "playwright test",
+    "lint": "oxlint .",
+    "format": "oxfmt . --check",
+    "format:fix": "oxfmt .",
+    "verify:local": "tsx scripts/verify-local.ts",
+    "release": "release-it",
+    "prepublishOnly": "npm run build",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "commander": "^14.0.3"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.40.0",
+    "@release-it/conventional-changelog": "^11.0.0",
+    "@types/node": "^20.10.0",
+    "dotenv": "^17.4.2",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.0.2",
+    "oxfmt": "^0.48.0",
+    "oxlint": "^1.63.0",
+    "release-it": "^20.0.1",
+    "tsx": "^4.21.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.40.0"
+  },
+  "lint-staged": {
+    "**/*.{ts,json,js,md,yml}": "npm run format:fix",
+    "{src,e2e,scripts}/**/*.{ts,js}": "oxlint"
+  }
+}