@tyndall/test-playwright 0.0.1

package/dist/steps/expect.js

@@ -0,0 +1,71 @@
+import { AssertionError } from "../errors.js";
+import { defaultExpectRegistry } from "../extensibility/ExpectRegistry.js";
+const EXPECT_TIMEOUT_MS = 2000;
+const EXPECT_POLL_INTERVAL_MS = 50;
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+const buildSelectorExpectationError = (selector, expect) => {
+    if (expect.exists === true) {
+        return new AssertionError(`Expected selector ${selector} to exist`);
+    }
+    if (expect.exists === false) {
+        return new AssertionError(`Expected selector ${selector} to not exist`);
+    }
+    if (typeof expect.text === "string") {
+        return new AssertionError(`Expected ${selector} text to be "${expect.text}"`);
+    }
+    if (typeof expect.contains === "string") {
+        return new AssertionError(`Expected ${selector} text to include "${expect.contains}"`);
+    }
+    return new AssertionError(`Expectation failed for selector ${selector}`);
+};
+const matchesSelectorExpectation = (textContent, expect) => {
+    if (expect.exists === true && textContent === null) {
+        return false;
+    }
+    if (expect.exists === false && textContent !== null) {
+        return false;
+    }
+    if (typeof expect.text === "string" && textContent !== expect.text) {
+        return false;
+    }
+    if (typeof expect.contains === "string" && !textContent?.includes(expect.contains)) {
+        return false;
+    }
+    return true;
+};
+const waitForSelectorExpectation = async (selector, expect, context) => {
+    const deadline = Date.now() + EXPECT_TIMEOUT_MS;
+    while (Date.now() <= deadline) {
+        const textContent = await context.page.textContent(selector);
+        if (matchesSelectorExpectation(textContent, expect)) {
+            return;
+        }
+        await sleep(EXPECT_POLL_INTERVAL_MS);
+    }
+    throw buildSelectorExpectationError(selector, expect);
+};
+export const runExpectStep = async (step, context) => {
+    const { expect } = step;
+    if (expect.selector) {
+        await waitForSelectorExpectation(expect.selector, expect, context);
+    }
+    if (expect.network) {
+        throw new AssertionError("Network expectations are not implemented yet");
+    }
+    if (expect.dynamicManifest) {
+        if (!context.manifestObserver) {
+            throw new AssertionError("Dynamic manifest observer is not configured");
+        }
+        context.manifestObserver.assert(expect.dynamicManifest);
+    }
+    if (expect.custom) {
+        const registry = context.expectRegistry ?? defaultExpectRegistry;
+        for (const [name, value] of Object.entries(expect.custom)) {
+            const handler = registry.get(name);
+            if (!handler) {
+                throw new AssertionError(`Unknown expectation: ${name}`);
+            }
+            await handler(value, context);
+        }
+    }
+};

package/dist/steps/goto.d.ts

@@ -0,0 +1,6 @@
+import type { StepContext } from "./types.js";
+export interface GotoStep {
+    goto: string;
+}
+export declare const runGotoStep: (step: GotoStep, context: StepContext) => Promise<void>;
+//# sourceMappingURL=goto.d.ts.map

package/dist/steps/goto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"goto.d.ts","sourceRoot":"","sources":["../../src/steps/goto.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,eAAO,MAAM,WAAW,GAAU,MAAM,QAAQ,EAAE,SAAS,WAAW,kBAKrE,CAAC"}

package/dist/steps/goto.js

@@ -0,0 +1,6 @@
+export const runGotoStep = async (step, context) => {
+    const target = step.goto.startsWith("http")
+        ? step.goto
+        : `${context.baseUrl}${step.goto}`;
+    await context.page.goto(target);
+};

package/dist/steps/index.d.ts

@@ -0,0 +1,16 @@
+import type { StepContext } from "./types.js";
+import type { ExpectSpec } from "../types/scenario.js";
+export interface StepHandlerMap {
+    goto: (step: {
+        goto: string;
+    }, context: StepContext) => Promise<void>;
+    click: (step: {
+        click: string;
+    }, context: StepContext) => Promise<void>;
+    expect: (step: {
+        expect: ExpectSpec;
+    }, context: StepContext) => Promise<void>;
+}
+export declare const defaultStepHandlers: StepHandlerMap;
+export type { StepContext } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/steps/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/steps/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,MAAM,EAAE,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,UAAU,CAAA;KAAE,EAAE,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/E;AAED,eAAO,MAAM,mBAAmB,EAAE,cAIjC,CAAC;AAEF,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}

package/dist/steps/index.js

@@ -0,0 +1,8 @@
+import { runGotoStep } from "./goto.js";
+import { runClickStep } from "./click.js";
+import { runExpectStep } from "./expect.js";
+export const defaultStepHandlers = {
+    goto: runGotoStep,
+    click: runClickStep,
+    expect: runExpectStep,
+};

package/dist/steps/types.d.ts

@@ -0,0 +1,17 @@
+export interface PageLike {
+    goto(url: string): Promise<unknown>;
+    click(selector: string): Promise<unknown>;
+    textContent(selector: string): Promise<string | null>;
+    addInitScript?: (options: {
+        path: string;
+    }) => Promise<unknown>;
+}
+import type { ManifestObserver } from "../dynamic/ManifestObserver.js";
+import type { ExpectRegistry } from "../extensibility/ExpectRegistry.js";
+export interface StepContext {
+    page: PageLike;
+    baseUrl: string;
+    manifestObserver?: ManifestObserver;
+    expectRegistry?: ExpectRegistry;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/steps/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/steps/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACtD,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACjE;AAED,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEzE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC"}

package/dist/steps/types.js

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

package/dist/types/result.d.ts

@@ -0,0 +1,25 @@
+import type { ScenarioCase } from "./scenario.js";
+export type StepStatus = "passed" | "failed" | "skipped";
+export interface StepResult {
+    status: StepStatus;
+    startedAt: number;
+    finishedAt: number;
+    error?: string;
+    errorType?: string;
+    screenshotPath?: string;
+}
+export interface ScenarioResult {
+    scenario: ScenarioCase;
+    steps: StepResult[];
+    status: StepStatus;
+    startedAt: number;
+    finishedAt: number;
+}
+export interface AggregatedResult {
+    name: string;
+    scenarios: ScenarioResult[];
+    status: StepStatus;
+    startedAt: number;
+    finishedAt: number;
+}
+//# sourceMappingURL=result.d.ts.map

package/dist/types/result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../../src/types/result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEzD,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/result.js

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

package/dist/types/scenario.d.ts

@@ -0,0 +1,44 @@
+export type ScenarioMode = "dev" | "ssg" | "ssr";
+export interface ScenarioSetup {
+    env?: Record<string, string>;
+}
+export interface DynamicManifestExpectation {
+    mode?: "meta" | "program";
+    pageId?: string;
+    version?: string;
+}
+export interface NetworkExpectation {
+    url?: string;
+    method?: string;
+    status?: number;
+    count?: number;
+}
+export interface ExpectSpec {
+    selector?: string;
+    text?: string;
+    contains?: string;
+    exists?: boolean;
+    network?: NetworkExpectation;
+    dynamicManifest?: DynamicManifestExpectation;
+    custom?: Record<string, unknown>;
+}
+export type Step = {
+    goto: string;
+} | {
+    click: string;
+} | {
+    expect: ExpectSpec;
+} | Record<string, unknown>;
+export interface ScenarioCase {
+    id: string;
+    name?: string;
+    steps: Step[];
+}
+export interface ScenarioDocument {
+    name: string;
+    mode?: ScenarioMode;
+    baseUrl?: string;
+    setup?: ScenarioSetup;
+    scenarios: ScenarioCase[];
+}
+//# sourceMappingURL=scenario.d.ts.map

package/dist/types/scenario.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scenario.d.ts","sourceRoot":"","sources":["../../src/types/scenario.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAEjD,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,eAAe,CAAC,EAAE,0BAA0B,CAAC;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,MAAM,IAAI,GACZ;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GACjB;IAAE,MAAM,EAAE,UAAU,CAAA;CAAE,GACtB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE5B,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,SAAS,EAAE,YAAY,EAAE,CAAC;CAC3B"}

package/dist/types/scenario.js

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

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@tyndall/test-playwright",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./src/index.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@tyndall/core": "workspace:*",
+    "playwright": "^1.44.0",
+    "yaml": "^2.4.5"
+  }
+}