effect-playwright 0.1.1 → 0.2.0

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import { a as NewPageOptions, c as PlaywrightPageService, i as NewContextOptions, l as PlaywrightLocator, n as PlaywrightService, o as PlaywrightBrowser, r as LaunchOptions, s as PlaywrightPage, t as Playwright, u as PlaywrightLocatorService } from "./index-DnbVDccF.mjs";
-export { LaunchOptions, NewContextOptions, NewPageOptions, Playwright, PlaywrightBrowser, PlaywrightLocator, PlaywrightLocatorService, PlaywrightPage, PlaywrightPageService, PlaywrightService };
+import { S as PlaywrightErrorReason, _ as PlaywrightWorker, a as NewPageOptions, b as PlaywrightLocatorService, c as PlaywrightBrowserContext, d as PlaywrightPageService, f as PlaywrightDialog, g as PlaywrightResponse, h as PlaywrightRequest, i as NewContextOptions, l as PlaywrightBrowserContextService, m as PlaywrightFileChooser, n as PlaywrightService, o as PlaywrightBrowser, p as PlaywrightDownload, r as LaunchOptions, s as PlaywrightBrowserService, t as Playwright, u as PlaywrightPage, x as PlaywrightError, y as PlaywrightLocator } from "./index-K6LNMeXC.mjs";
+export { LaunchOptions, NewContextOptions, NewPageOptions, Playwright, PlaywrightBrowser, PlaywrightBrowserContext, PlaywrightBrowserContextService, PlaywrightBrowserService, PlaywrightDialog, PlaywrightDownload, PlaywrightError, PlaywrightErrorReason, PlaywrightFileChooser, PlaywrightLocator, PlaywrightLocatorService, PlaywrightPage, PlaywrightPageService, PlaywrightRequest, PlaywrightResponse, PlaywrightService, PlaywrightWorker };

package/dist/index.mjs

@@ -1,3 +1,3 @@
-import { i as PlaywrightLocator, n as PlaywrightBrowser, r as PlaywrightPage, t as Playwright } from "./src-BGGNNney.mjs";
+import { a as PlaywrightDownload, c as PlaywrightResponse, d as PlaywrightLocator, f as PlaywrightError, i as PlaywrightDialog, l as PlaywrightWorker, n as PlaywrightBrowser, o as PlaywrightFileChooser, r as PlaywrightBrowserContext, s as PlaywrightRequest, t as Playwright, u as PlaywrightPage } from "./src-Bf0XqK7M.mjs";
 
-export { Playwright, PlaywrightBrowser, PlaywrightLocator, PlaywrightPage };
+export { Playwright, PlaywrightBrowser, PlaywrightBrowserContext, PlaywrightDialog, PlaywrightDownload, PlaywrightError, PlaywrightFileChooser, PlaywrightLocator, PlaywrightPage, PlaywrightRequest, PlaywrightResponse, PlaywrightWorker };

package/dist/{src-BGGNNney.mjs → src-Bf0XqK7M.mjs}

@@ -1,7 +1,18 @@
 import { Context, Data, Effect, Layer, Option, Stream, identity } from "effect";
+import { Readable } from "node:stream";
 import { chromium, errors } from "playwright-core";
 
 //#region src/errors.ts
+/**
+* Error type that is returned when a Playwright error occurs.
+* Reason can either be "Timeout" or "Unknown".
+*
+* Timeout errors occur when a timeout is reached. All other errors are
+* grouped under "Unknown".
+*
+* @category error
+* @since 0.1.0
+*/
 var PlaywrightError = class extends Data.TaggedError("PlaywrightError") {};
 function wrapError(error) {
 	if (error instanceof errors.TimeoutError) return new PlaywrightError({
@@ -20,12 +31,155 @@ function wrapError(error) {
 const useHelper = (api) => (userFunction) => Effect.tryPromise(() => userFunction(api)).pipe(Effect.mapError(wrapError));
 
 //#endregion
-//#region src/common.ts
-var PlaywrightFrame = class PlaywrightFrame extends Data.TaggedClass("PlaywrightFrame") {
+//#region src/locator.ts
+/**
+* A service that provides a `PlaywrightLocator` instance.
+*
+* @since 0.1.0
+* @category tag
+*/
+var PlaywrightLocator = class PlaywrightLocator extends Context.Tag("effect-playwright/PlaywrightLocator")() {
+	/**
+	* Creates a `PlaywrightLocator` from a Playwright `Locator` instance. This is mostly for internal use.
+	* But you could use this if you have used `use` or similar to wrap the locator.
+	*
+	* @example
+	* ```ts
+	* const playwrightNativeLocator = yield* page.use((p) => p.locator("button"));
+	* const locator = PlaywrightLocator.make(playwrightNativeLocator);
+	* ```
+	*
+	* @param locator - The Playwright `Locator` instance to wrap.
+	* @since 0.1.0
+	* @category constructor
+	*/
+	static make(locator) {
+		const use = useHelper(locator);
+		return PlaywrightLocator.of({
+			click: (options) => use((l) => l.click(options)),
+			fill: (value, options) => use((l) => l.fill(value, options)),
+			getAttribute: (name, options) => use((l) => l.getAttribute(name, options)),
+			innerText: (options) => use((l) => l.innerText(options)),
+			innerHTML: (options) => use((l) => l.innerHTML(options)),
+			inputValue: (options) => use((l) => l.inputValue(options)),
+			textContent: (options) => use((l) => l.textContent(options)),
+			count: use((l) => l.count()),
+			first: () => PlaywrightLocator.make(locator.first()),
+			last: () => PlaywrightLocator.make(locator.last()),
+			nth: (index) => PlaywrightLocator.make(locator.nth(index)),
+			evaluate: (pageFunction, arg, options) => use((l) => l.evaluate(pageFunction, arg, options)),
+			use
+		});
+	}
+};
+
+//#endregion
+//#region src/frame.ts
+/**
+* @category tag
+* @since 0.1.2
+*/
+var PlaywrightFrame = class PlaywrightFrame extends Context.Tag("effect-playwright/PlaywrightFrame")() {
+	/**
+	* Creates a `PlaywrightFrame` from a Playwright `Frame` instance.
+	*
+	* @param frame - The Playwright `Frame` instance to wrap.
+	* @since 0.1.2
+	*/
 	static make(frame) {
-		return new PlaywrightFrame({ use: useHelper(frame) });
+		const use = useHelper(frame);
+		return PlaywrightFrame.of({
+			goto: (url, options) => use((f) => f.goto(url, options)),
+			waitForURL: (url, options) => use((f) => f.waitForURL(url, options)),
+			waitForLoadState: (state, options) => use((f) => f.waitForLoadState(state, options)),
+			evaluate: (f, arg) => use((frame$1) => frame$1.evaluate(f, arg)),
+			title: use((f) => f.title()),
+			use,
+			locator: (selector, options) => PlaywrightLocator.make(frame.locator(selector, options)),
+			getByRole: (role, options) => PlaywrightLocator.make(frame.getByRole(role, options)),
+			getByText: (text, options) => PlaywrightLocator.make(frame.getByText(text, options)),
+			getByLabel: (label, options) => PlaywrightLocator.make(frame.getByLabel(label, options)),
+			getByTestId: (testId) => PlaywrightLocator.make(frame.getByTestId(testId)),
+			url: Effect.sync(() => frame.url()),
+			content: use((f) => f.content()),
+			name: Effect.sync(() => frame.name()),
+			click: (selector, options) => use((f) => f.click(selector, options))
+		});
 	}
 };
+
+//#endregion
+//#region src/page.ts
+const eventMappings$2 = {
+	close: (page) => PlaywrightPage.make(page),
+	console: identity,
+	crash: (page) => PlaywrightPage.make(page),
+	dialog: (dialog) => PlaywrightDialog.make(dialog),
+	domcontentloaded: (page) => PlaywrightPage.make(page),
+	download: (download) => PlaywrightDownload.make(download),
+	filechooser: (fileChooser) => PlaywrightFileChooser.make(fileChooser),
+	frameattached: (frame) => PlaywrightFrame.make(frame),
+	framedetached: (frame) => PlaywrightFrame.make(frame),
+	framenavigated: (frame) => PlaywrightFrame.make(frame),
+	load: (page) => PlaywrightPage.make(page),
+	pageerror: identity,
+	popup: (page) => PlaywrightPage.make(page),
+	request: (request) => PlaywrightRequest.make(request),
+	requestfailed: (request) => PlaywrightRequest.make(request),
+	requestfinished: (request) => PlaywrightRequest.make(request),
+	response: (response) => PlaywrightResponse.make(response),
+	websocket: identity,
+	worker: (worker) => PlaywrightWorker.make(worker)
+};
+/**
+* @category tag
+*/
+var PlaywrightPage = class PlaywrightPage extends Context.Tag("effect-playwright/PlaywrightPage")() {
+	/**
+	* Creates a `PlaywrightPage` from a Playwright `Page` instance.
+	*
+	* @param page - The Playwright `Page` instance to wrap.
+	* @since 0.1.0
+	*/
+	static make(page) {
+		const use = useHelper(page);
+		return PlaywrightPage.of({
+			goto: (url, options) => use((p) => p.goto(url, options)),
+			waitForURL: (url, options) => use((p) => p.waitForURL(url, options)),
+			waitForLoadState: (state, options) => use((p) => p.waitForLoadState(state, options)),
+			title: use((p) => p.title()),
+			evaluate: (f, arg) => use((p) => p.evaluate(f, arg)),
+			locator: (selector, options) => PlaywrightLocator.make(page.locator(selector, options)),
+			getByRole: (role, options) => PlaywrightLocator.make(page.getByRole(role, options)),
+			getByText: (text, options) => PlaywrightLocator.make(page.getByText(text, options)),
+			getByLabel: (label, options) => PlaywrightLocator.make(page.getByLabel(label, options)),
+			getByTestId: (testId) => PlaywrightLocator.make(page.getByTestId(testId)),
+			url: Effect.sync(() => page.url()),
+			frames: use((p) => Promise.resolve(p.frames().map(PlaywrightFrame.make))),
+			reload: use((p) => p.reload()),
+			close: use((p) => p.close()),
+			click: (selector, options) => use((p) => p.click(selector, options)),
+			eventStream: (event) => Stream.asyncPush((emit) => Effect.acquireRelease(Effect.sync(() => {
+				page.on(event, emit.single);
+				page.once("close", emit.end);
+			}), () => Effect.sync(() => {
+				page.off(event, emit.single);
+				page.off("close", emit.end);
+			}))).pipe(Stream.map((e) => {
+				const mapping = eventMappings$2[event];
+				return mapping(e);
+			})),
+			use
+		});
+	}
+};
+
+//#endregion
+//#region src/common.ts
+/**
+* @category model
+* @since 0.1.2
+*/
 var PlaywrightRequest = class PlaywrightRequest extends Data.TaggedClass("PlaywrightRequest") {
 	static make(request) {
 		const use = useHelper(request);
@@ -52,6 +206,10 @@ var PlaywrightRequest = class PlaywrightRequest extends Data.TaggedClass("Playwr
 		});
 	}
 };
+/**
+* @category model
+* @since 0.1.2
+*/
 var PlaywrightResponse = class PlaywrightResponse extends Data.TaggedClass("PlaywrightResponse") {
 	static make(response) {
 		const use = useHelper(response);
@@ -77,6 +235,10 @@ var PlaywrightResponse = class PlaywrightResponse extends Data.TaggedClass("Play
 		});
 	}
 };
+/**
+* @category model
+* @since 0.1.2
+*/
 var PlaywrightWorker = class PlaywrightWorker extends Data.TaggedClass("PlaywrightWorker") {
 	static make(worker) {
 		const use = useHelper(worker);
@@ -86,6 +248,10 @@ var PlaywrightWorker = class PlaywrightWorker extends Data.TaggedClass("Playwrig
 		});
 	}
 };
+/**
+* @category model
+* @since 0.1.2
+*/
 var PlaywrightDialog = class PlaywrightDialog extends Data.TaggedClass("PlaywrightDialog") {
 	static make(dialog) {
 		const use = useHelper(dialog);
@@ -99,6 +265,10 @@ var PlaywrightDialog = class PlaywrightDialog extends Data.TaggedClass("Playwrig
 		});
 	}
 };
+/**
+* @category model
+* @since 0.1.2
+*/
 var PlaywrightFileChooser = class PlaywrightFileChooser extends Data.TaggedClass("PlaywrightFileChooser") {
 	static make(fileChooser) {
 		const use = useHelper(fileChooser);
@@ -110,12 +280,16 @@ var PlaywrightFileChooser = class PlaywrightFileChooser extends Data.TaggedClass
 		});
 	}
 };
+/**
+* @category model
+* @since 0.1.2
+*/
 var PlaywrightDownload = class PlaywrightDownload extends Data.TaggedClass("PlaywrightDownload") {
 	static make(download) {
 		const use = useHelper(download);
 		return new PlaywrightDownload({
 			cancel: use(() => download.cancel()),
-			createReadStream: Stream.empty,
+			stream: use(() => download.createReadStream().then((s) => Readable.toWeb(s))).pipe(Effect.map((s) => Stream.fromReadableStream(() => s, wrapError)), Stream.unwrap),
 			delete: use(() => download.delete()),
 			failure: use(() => download.failure()).pipe(Effect.map(Option.fromNullable)),
 			page: () => PlaywrightPage.make(download.page()),
@@ -129,137 +303,57 @@ var PlaywrightDownload = class PlaywrightDownload extends Data.TaggedClass("Play
 };
 
 //#endregion
-//#region src/locator.ts
-/**
-* A service that provides a `PlaywrightLocator` instance.
-*
-* @since 0.1.0
-* @category tag
-*/
-var PlaywrightLocator = class PlaywrightLocator extends Context.Tag("effect-playwright/PlaywrightLocator")() {
-	/**
-	* Creates a `PlaywrightLocator` from a Playwright `Locator` instance. This is mostly for internal use.
-	* But you could use this if you have used `use` or similar to wrap the locator.
-	*
-	* @example
-	* ```ts
-	* const playwrightNativeLocator = yield* page.use((p) => p.locator("button"));
-	* const locator = PlaywrightLocator.make(playwrightNativeLocator);
-	* ```
-	*
-	* @param locator - The Playwright `Locator` instance to wrap.
-	* @since 0.1.0
-	* @category constructor
-	*/
-	static make(locator) {
-		const use = useHelper(locator);
-		return PlaywrightLocator.of({
-			click: (options) => use((l) => l.click(options)),
-			fill: (value, options) => use((l) => l.fill(value, options)),
-			getAttribute: (name, options) => use((l) => l.getAttribute(name, options)),
-			innerText: (options) => use((l) => l.innerText(options)),
-			innerHTML: (options) => use((l) => l.innerHTML(options)),
-			inputValue: (options) => use((l) => l.inputValue(options)),
-			textContent: (options) => use((l) => l.textContent(options)),
-			count: use((l) => l.count()),
-			first: () => PlaywrightLocator.make(locator.first()),
-			last: () => PlaywrightLocator.make(locator.last()),
-			nth: (index) => PlaywrightLocator.make(locator.nth(index)),
-			evaluate: (pageFunction, arg, options) => use((l) => l.evaluate(pageFunction, arg, options)),
-			use
-		});
-	}
+//#region src/browser-context.ts
+const eventMappings$1 = {
+	backgroundpage: (page) => PlaywrightPage.make(page),
+	close: (context) => PlaywrightBrowserContext.make(context),
+	console: identity,
+	dialog: (dialog) => PlaywrightDialog.make(dialog),
+	page: (page) => PlaywrightPage.make(page),
+	request: (request) => PlaywrightRequest.make(request),
+	requestfailed: (request) => PlaywrightRequest.make(request),
+	requestfinished: (request) => PlaywrightRequest.make(request),
+	response: (response) => PlaywrightResponse.make(response),
+	serviceworker: (worker) => PlaywrightWorker.make(worker),
+	weberror: identity
 };
-
-//#endregion
-//#region src/page.ts
 /**
 * @category tag
 */
-var PlaywrightPage = class PlaywrightPage extends Context.Tag("effect-playwright/PlaywrightPage")() {
+var PlaywrightBrowserContext = class PlaywrightBrowserContext extends Context.Tag("effect-playwright/PlaywrightBrowserContext")() {
 	/**
-	* Creates a `PlaywrightPage` from a Playwright `Page` instance.
+	* Creates a `PlaywrightBrowserContext` from a Playwright `BrowserContext` instance.
 	*
-	* @param page - The Playwright `Page` instance to wrap.
+	* @param context - The Playwright `BrowserContext` instance to wrap.
 	* @since 0.1.0
 	*/
-	static make(page) {
-		const use = useHelper(page);
-		return PlaywrightPage.of({
-			goto: (url, options) => use((p) => p.goto(url, options)),
-			waitForURL: (url, options) => use((p) => p.waitForURL(url, options)),
-			title: use((p) => p.title()),
-			evaluate: (f, arg) => use((p) => p.evaluate(f, arg)),
-			locator: (selector, options) => PlaywrightLocator.make(page.locator(selector, options)),
-			getByRole: (role, options) => PlaywrightLocator.make(page.getByRole(role, options)),
-			getByText: (text, options) => PlaywrightLocator.make(page.getByText(text, options)),
-			getByLabel: (label, options) => PlaywrightLocator.make(page.getByLabel(label, options)),
-			getByTestId: (testId) => PlaywrightLocator.make(page.getByTestId(testId)),
-			url: Effect.sync(() => page.url()),
-			reload: use((p) => p.reload()),
-			close: use((p) => p.close()),
-			click: (selector, options) => use((p) => p.click(selector, options)),
-			eventStream: (event) => Stream.asyncPush((emit) => Effect.acquireRelease(Effect.sync(() => {
-				const callback = emit.single;
-				const closeCallback = emit.end;
-				page.on(event, callback);
-				page.once("close", closeCallback);
-				return {
-					callback,
-					closeCallback
-				};
-			}), ({ callback, closeCallback }) => Effect.sync(() => {
-				page.off(event, callback);
-				page.off("close", closeCallback);
-			}))).pipe(Stream.map((e) => {
-				const mapper = eventMappings[event];
-				return mapper(e);
-			})),
-			use
-		});
-	}
-};
-const eventMappings = {
-	close: PlaywrightPage.make,
-	console: identity,
-	crash: PlaywrightPage.make,
-	dialog: PlaywrightDialog.make,
-	domcontentloaded: PlaywrightPage.make,
-	download: PlaywrightDownload.make,
-	filechooser: PlaywrightFileChooser.make,
-	frameattached: PlaywrightFrame.make,
-	framedetached: PlaywrightFrame.make,
-	framenavigated: PlaywrightFrame.make,
-	load: PlaywrightPage.make,
-	pageerror: identity,
-	popup: PlaywrightPage.make,
-	request: PlaywrightRequest.make,
-	requestfailed: PlaywrightRequest.make,
-	requestfinished: PlaywrightRequest.make,
-	response: PlaywrightResponse.make,
-	websocket: identity,
-	worker: PlaywrightWorker.make
-};
-
-//#endregion
-//#region src/browser-context.ts
-var PlaywrightBrowserContext = class PlaywrightBrowserContext extends Context.Tag("cehs/backend/lib/playwright/PlaywrightBrowserContext")() {
 	static make(context) {
 		const use = useHelper(context);
 		return PlaywrightBrowserContext.of({
 			pages: Effect.sync(() => context.pages().map(PlaywrightPage.make)),
 			newPage: use((c) => c.newPage().then(PlaywrightPage.make)),
-			close: use((c) => c.close())
+			close: use((c) => c.close()),
+			eventStream: (event) => Stream.asyncPush((emit) => Effect.acquireRelease(Effect.sync(() => {
+				context.on(event, emit.single);
+				context.once("close", emit.end);
+			}), () => Effect.sync(() => {
+				context.off(event, emit.single);
+				context.off("close", emit.end);
+			}))).pipe(Stream.map((e) => {
+				const mapping = eventMappings$1[event];
+				return mapping(e);
+			}))
 		});
 	}
 };
 
 //#endregion
 //#region src/browser.ts
+const eventMappings = { disconnected: (browser) => PlaywrightBrowser.make(browser) };
 /**
 * @category tag
 */
-var PlaywrightBrowser = class PlaywrightBrowser extends Context.Tag("cehs/backend/lib/playwright/PlaywrightBrowser")() {
+var PlaywrightBrowser = class PlaywrightBrowser extends Context.Tag("effect-playwright/PlaywrightBrowser")() {
 	/**
 	* @category constructor
 	*/
@@ -273,6 +367,16 @@ var PlaywrightBrowser = class PlaywrightBrowser extends Context.Tag("cehs/backen
 			browserType: Effect.sync(() => browser.browserType()),
 			version: Effect.sync(() => browser.version()),
 			isConnected: Effect.sync(() => browser.isConnected()),
+			eventStream: (event) => Stream.asyncPush((emit) => Effect.acquireRelease(Effect.sync(() => {
+				browser.on(event, emit.single);
+				browser.once("disconnected", emit.end);
+			}), () => Effect.sync(() => {
+				browser.off(event, emit.single);
+				browser.off("disconnected", emit.end);
+			}))).pipe(Stream.map((e) => {
+				const mapping = eventMappings[event];
+				return mapping(e);
+			})),
 			use
 		});
 	}
@@ -294,6 +398,10 @@ const connectCDP = Effect.fn(function* (cdpUrl, options) {
 	});
 	return PlaywrightBrowser.make(browser);
 });
+/**
+* @category tag
+* @since 0.1.0
+*/
 var Playwright = class Playwright extends Context.Tag("effect-playwright/index/Playwright")() {
 	/**
 	* @category layer
@@ -307,4 +415,4 @@ var Playwright = class Playwright extends Context.Tag("effect-playwright/index/P
 };
 
 //#endregion
-export { PlaywrightLocator as i, PlaywrightBrowser as n, PlaywrightPage as r, Playwright as t };
+export { PlaywrightDownload as a, PlaywrightResponse as c, PlaywrightLocator as d, PlaywrightError as f, PlaywrightDialog as i, PlaywrightWorker as l, PlaywrightBrowser as n, PlaywrightFileChooser as o, PlaywrightBrowserContext as r, PlaywrightRequest as s, Playwright as t, PlaywrightPage as u };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "effect-playwright",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "An Effect-based Playwright library.",
   "author": "Jobflow GmbH",
   "license": "ISC",
@@ -37,15 +37,16 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.3.11",
-    "@effect/language-service": "^0.65.0",
+    "@effect/language-service": "0.71.1",
     "@effect/platform": "^0.94.1",
     "@effect/platform-node": "^0.104.0",
     "@effect/vitest": "^0.27.0",
-    "@types/node": "^25.0.8",
+    "@types/node": "^25.0.9",
     "effect": "^3.19.14",
     "playwright": "^1.57.0",
-    "tsdown": "0.20.0-beta.1",
+    "tsdown": "0.20.0-beta.3",
     "tsx": "^4.21.0",
+    "typedoc": "^0.28.16",
     "typescript": "^5.9.3",
     "vitest": "^4.0.17"
   },
@@ -53,6 +54,8 @@
   "scripts": {
     "build": "tsdown",
     "test": "vitest run",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "generate-docs": "typedoc",
+    "format-fix": "biome format --fix"
   }
 }