effect-playwright 0.1.0 → 0.1.2

package/dist/index-aR0Fa_4Y.d.mts

@@ -1,584 +0,0 @@
-import { Context, Effect, Layer, Scope, Stream } from "effect";
-import { Browser, BrowserContext, BrowserType, ConnectOverCDPOptions, ConsoleMessage, Dialog, Download, ElementHandle, FileChooser, Frame, JSHandle, Locator, Page, Request, Response, WebSocket, Worker, chromium } from "playwright-core";
-import { Scope as Scope$1 } from "effect/Scope";
-import * as effect_Types0 from "effect/Types";
-import * as effect_Cause0 from "effect/Cause";
-
-//#region src/errors.d.ts
-type PlaywrightErrorReason = "Timeout" | "Unknown";
-declare const PlaywrightError_base: new <A extends Record<string, any> = {}>(args: effect_Types0.Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P] }) => effect_Cause0.YieldableError & {
-  readonly _tag: "PlaywrightError";
-} & Readonly<A>;
-declare class PlaywrightError extends PlaywrightError_base<{
-  reason: PlaywrightErrorReason;
-  cause: unknown;
-}> {}
-//#endregion
-//#region src/playwright-types.d.ts
-/**
- * Extracted from `playwright-core/types/structs.d.ts` because it is not exported over the package boundary.
- * These types are necessary to correctly type `evaluate` functions that unwrap handles.
- */
-type NoHandles<Arg> = Arg extends JSHandle ? never : Arg extends object ? { [Key in keyof Arg]: NoHandles<Arg[Key]> } : Arg;
-type Unboxed<Arg> = Arg extends ElementHandle<infer T> ? T : Arg extends JSHandle<infer T> ? T : Arg extends NoHandles<Arg> ? Arg : Arg extends [infer A0] ? [Unboxed<A0>] : Arg extends [infer A0, infer A1] ? [Unboxed<A0>, Unboxed<A1>] : Arg extends [infer A0, infer A1, infer A2] ? [Unboxed<A0>, Unboxed<A1>, Unboxed<A2>] : Arg extends [infer A0, infer A1, infer A2, infer A3] ? [Unboxed<A0>, Unboxed<A1>, Unboxed<A2>, Unboxed<A3>] : Arg extends Array<infer T> ? Array<Unboxed<T>> : Arg extends object ? { [Key in keyof Arg]: Unboxed<Arg[Key]> } : Arg;
-type PageFunction<Arg, R> = string | ((arg: Unboxed<Arg>) => R | Promise<R>);
-//#endregion
-//#region src/locator.d.ts
-/**
- * Interface for a Playwright locator.
- * @category model
- */
-interface PlaywrightLocatorService {
-  /**
-   * Clicks the element.
-   *
-   * @see {@link Locator.click}
-   * @since 0.1.0
-   */
-  readonly click: (options?: Parameters<Locator["click"]>[0]) => Effect.Effect<void, PlaywrightError>;
-  /**
-   * Fills the input field.
-   *
-   * @see {@link Locator.fill}
-   * @since 0.1.0
-   */
-  readonly fill: (value: string, options?: Parameters<Locator["fill"]>[1]) => Effect.Effect<void, PlaywrightError>;
-  /**
-   * Gets an attribute value.
-   *
-   * @see {@link Locator.getAttribute}
-   * @since 0.1.0
-   */
-  readonly getAttribute: (name: string, options?: Parameters<Locator["getAttribute"]>[1]) => Effect.Effect<string | null, PlaywrightError>;
-  /**
-   * Gets the inner text.
-   *
-   * @see {@link Locator.innerText}
-   * @since 0.1.0
-   */
-  readonly innerText: (options?: Parameters<Locator["innerText"]>[0]) => Effect.Effect<string, PlaywrightError>;
-  /**
-   * Gets the inner HTML.
-   *
-   * @see {@link Locator.innerHTML}
-   * @since 0.1.0
-   */
-  readonly innerHTML: (options?: Parameters<Locator["innerHTML"]>[0]) => Effect.Effect<string, PlaywrightError>;
-  /**
-   * Gets the input value.
-   *
-   * @see {@link Locator.inputValue}
-   * @since 0.1.0
-   */
-  readonly inputValue: (options?: Parameters<Locator["inputValue"]>[0]) => Effect.Effect<string, PlaywrightError>;
-  /**
-   * Gets the text content.
-   *
-   * @see {@link Locator.textContent}
-   * @since 0.1.0
-   */
-  readonly textContent: (options?: Parameters<Locator["textContent"]>[0]) => Effect.Effect<string | null, PlaywrightError>;
-  /**
-   * Counts the number of matched elements.
-   *
-   * @see {@link Locator.count}
-   * @since 0.1.0
-   */
-  readonly count: Effect.Effect<number, PlaywrightError>;
-  /**
-   * Returns a locator that points to the first matched element.
-   * @see {@link Locator.first}
-   * @since 0.1.0
-   */
-  readonly first: () => PlaywrightLocatorService;
-  /**
-   * Returns a locator that points to the last matched element.
-   *
-   * @see {@link Locator.last}
-   * @since 0.1.0
-   */
-  readonly last: () => PlaywrightLocatorService;
-  /**
-   * Returns a locator that points to the nth matched element.
-   *
-   * @see {@link Locator.nth}
-   * @since 0.1.0
-   */
-  readonly nth: (index: number) => PlaywrightLocatorService;
-  /**
-   * Evaluates a function on the matched element.
-   *
-   * @example
-   * ```ts
-   * import { PlaywrightBrowser } from "effect-playwright";
-   * import { PlaywrightEnvironment } from "effect-playwright/experimental";
-   * import { chromium } from "@playwright/test";
-   * import { Effect } from "effect";
-   *
-   * const program = Effect.gen(function* () {
-   *   const browser = yield* PlaywrightBrowser;
-   *   const page = yield* browser.newPage();
-   *   const locator = yield* page.locator("button");
-   *   const buttonContent = yield* locator.evaluate((button) => button.textContent());
-   * }).pipe(PlaywrightEnvironment.provideBrowser, Effect.provide(PlaywrightEnvironment.layer(chromium)));
-   * ```
-   *
-   * @see {@link Locator.evaluate}
-   * @since 0.1.0
-   */
-  readonly evaluate: <R, Arg = void, E extends SVGElement | HTMLElement = SVGElement | HTMLElement>(pageFunction: (element: E, arg: Unboxed<Arg>) => R | Promise<R>, arg?: Arg, options?: {
-    timeout?: number;
-  }) => Effect.Effect<R, PlaywrightError>;
-  /**
-   * A generic utility to execute any promise-based method on the underlying Playwright `Locator`.
-   * Can be used to access any Locator functionality not directly exposed by this service.
-   *
-   * @example
-   * ```typescript
-   * const isVisible = yield* locator.use((l) => l.isVisible());
-   * ```
-   *
-   * @param f - A function that takes the Playwright `Locator` and returns a `Promise`.
-   * @returns An effect that wraps the promise and returns its result.
-   * @see {@link Locator}
-   * @since 0.1.0
-   */
-  readonly use: <T$1>(f: (locator: Locator) => Promise<T$1>) => Effect.Effect<T$1, PlaywrightError>;
-}
-declare const PlaywrightLocator_base: Context.TagClass<PlaywrightLocator, "effect-playwright/PlaywrightLocator", PlaywrightLocatorService>;
-/**
- * A service that provides a `PlaywrightLocator` instance.
- *
- * @since 0.1.0
- * @category tag
- */
-declare class PlaywrightLocator extends PlaywrightLocator_base {
-  /**
-   * 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: Locator): typeof PlaywrightLocator.Service;
-}
-//#endregion
-//#region src/page.d.ts
-interface PlaywrightPageEvents {
-  close: Page;
-  console: ConsoleMessage;
-  crash: Page;
-  dialog: Dialog;
-  domcontentloaded: Page;
-  download: Download;
-  filechooser: FileChooser;
-  frameattached: Frame;
-  framedetached: Frame;
-  framenavigated: Frame;
-  load: Page;
-  pageerror: Error;
-  popup: Page;
-  request: Request;
-  requestfailed: Request;
-  requestfinished: Request;
-  response: Response;
-  websocket: WebSocket;
-  worker: Worker;
-}
-interface PlaywrightPageService {
-  /**
-   * Navigates the page to the given URL.
-   *
-   * @example
-   * ```ts
-   * yield* page.goto("https://google.com");
-   * ```
-   *
-   * @see {@link Page.goto}
-   * @since 0.1.0
-   */
-  readonly goto: (url: string, options?: Parameters<Page["goto"]>[1]) => Effect.Effect<void, PlaywrightError>;
-  /**
-   * Waits for the page to navigate to the given URL.
-   *
-   * @example
-   * ```ts
-   * yield* page.waitForURL("https://google.com");
-   * ```
-   *
-   * @see {@link Page.waitForURL}
-   * @since 0.1.0
-   */
-  readonly waitForURL: (url: Parameters<Page["waitForURL"]>[0], options?: Parameters<Page["waitForURL"]>[1]) => Effect.Effect<void, PlaywrightError>;
-  /**
-   * Evaluates a function in the context of the page.
-   *
-   * @example
-   * ```ts
-   * const dimensions = yield* page.evaluate(() => ({
-   *   width: document.documentElement.clientWidth,
-   *   height: document.documentElement.clientHeight
-   * }));
-   * ```
-   *
-   * @see {@link Page.evaluate}
-   * @since 0.1.0
-   */
-  readonly evaluate: <R, Arg = void>(pageFunction: PageFunction<Arg, R>, arg?: Arg) => Effect.Effect<R, PlaywrightError>;
-  /**
-   * Returns the page title.
-   *
-   * @example
-   * ```ts
-   * const title = yield* page.title;
-   * ```
-   *
-   * @see {@link Page.title}
-   * @since 0.1.0
-   */
-  readonly title: Effect.Effect<string, PlaywrightError>;
-  /**
-   * A generic utility to execute any promise-based method on the underlying Playwright `Page`.
-   * Can be used to access any Page functionality not directly exposed by this service.
-   *
-   * @example
-   * ```ts
-   * const title = yield* page.use((p) => p.title());
-   * ```
-   *
-   * @see {@link Page}
-   * @since 0.1.0
-   */
-  readonly use: <T$1>(f: (page: Page) => Promise<T$1>) => Effect.Effect<T$1, PlaywrightError>;
-  /**
-   * Returns a locator for the given selector.
-   *
-   * @see {@link Page.locator}
-   * @since 0.1.0
-   */
-  readonly locator: (selector: string, options?: Parameters<Page["locator"]>[1]) => typeof PlaywrightLocator.Service;
-  /**
-   * Returns a locator that matches the given role.
-   *
-   * @see {@link Page.getByRole}
-   * @since 0.1.0
-   */
-  readonly getByRole: (role: Parameters<Page["getByRole"]>[0], options?: Parameters<Page["getByRole"]>[1]) => typeof PlaywrightLocator.Service;
-  /**
-   * Returns a locator that matches the given text.
-   *
-   * @see {@link Page.getByText}
-   * @since 0.1.0
-   */
-  readonly getByText: (text: Parameters<Page["getByText"]>[0], options?: Parameters<Page["getByText"]>[1]) => typeof PlaywrightLocator.Service;
-  /**
-   * Returns a locator that matches the given label.
-   *
-   * @see {@link Page.getByLabel}
-   * @since 0.1.0
-   */
-  readonly getByLabel: (label: Parameters<Page["getByLabel"]>[0], options?: Parameters<Page["getByLabel"]>[1]) => typeof PlaywrightLocator.Service;
-  /**
-   * Returns a locator that matches the given test id.
-   *
-   * @see {@link Page.getByTestId}
-   * @since 0.1.0
-   */
-  readonly getByTestId: (testId: Parameters<Page["getByTestId"]>[0]) => typeof PlaywrightLocator.Service;
-  /**
-   * Reloads the page.
-   *
-   * @see {@link Page.reload}
-   * @since 0.1.0
-   */
-  readonly reload: Effect.Effect<void, PlaywrightError>;
-  /**
-   * Closes the page.
-   *
-   * @see {@link Page.close}
-   * @since 0.1.0
-   */
-  readonly close: Effect.Effect<void, PlaywrightError>;
-  /**
-   * Returns the current URL of the page.
-   *
-   * @example
-   * ```ts
-   * const url = yield* page.url;
-   * ```
-   *
-   * @see {@link Page.url}
-   * @since 0.1.0
-   */
-  readonly url: Effect.Effect<string, PlaywrightError>;
-  /**
-   * Creates a stream of the given event from the page.
-   *
-   * @example
-   * ```ts
-   * const consoleStream = page.eventStream("console");
-   * ```
-   *
-   * @see {@link Page.on}
-   * @since 0.1.0
-   */
-  readonly eventStream: <K extends keyof PlaywrightPageEvents>(event: K) => Stream.Stream<PlaywrightPageEvents[K]>;
-  /**
-   * Clicks an element matching the given selector.
-   *
-   * @example
-   * ```ts
-   * yield* page.click("button#submit");
-   * ```
-   * @deprecated Use {@link PlaywrightPageService.locator} to create a locator and then call `click` on it instead.
-   * @see {@link Page.click}
-   * @since 0.1.0
-   * @category deprecated
-   */
-  readonly click: (selector: string, options?: Parameters<Page["click"]>[1]) => Effect.Effect<void, PlaywrightError>;
-}
-declare const PlaywrightPage_base: Context.TagClass<PlaywrightPage, "effect-playwright/PlaywrightPage", PlaywrightPageService>;
-/**
- * @category tag
- */
-declare class PlaywrightPage extends PlaywrightPage_base {
-  /**
-   * Creates a `PlaywrightPage` from a Playwright `Page` instance.
-   *
-   * @param page - The Playwright `Page` instance to wrap.
-   * @since 0.1.0
-   */
-  static make(page: Page): PlaywrightPageService;
-}
-//#endregion
-//#region src/browser-context.d.ts
-declare const PlaywrightBrowserContext_base: Context.TagClass<PlaywrightBrowserContext, "cehs/backend/lib/playwright/PlaywrightBrowserContext", {
-  readonly pages: Effect.Effect<Array<typeof PlaywrightPage.Service>>;
-  readonly newPage: Effect.Effect<typeof PlaywrightPage.Service, PlaywrightError>;
-  readonly close: Effect.Effect<void, PlaywrightError>;
-}>;
-declare class PlaywrightBrowserContext extends PlaywrightBrowserContext_base {
-  static make(context: BrowserContext): {
-    readonly pages: Effect.Effect<Array<typeof PlaywrightPage.Service>>;
-    readonly newPage: Effect.Effect<typeof PlaywrightPage.Service, PlaywrightError>;
-    readonly close: Effect.Effect<void, PlaywrightError>;
-  };
-}
-//#endregion
-//#region src/browser.d.ts
-type LaunchOptions$1 = Parameters<typeof chromium.launch>[0];
-type NewPageOptions = Parameters<Browser["newPage"]>[0];
-type NewContextOptions = Parameters<Browser["newContext"]>[0];
-declare const PlaywrightBrowser_base: Context.TagClass<PlaywrightBrowser, "cehs/backend/lib/playwright/PlaywrightBrowser", {
-  /**
-   * Opens a new page in the browser.
-   *
-   * @example
-   * ```typescript
-   * const page = yield* browser.newPage();
-   * ```
-   *
-   * @param options - Optional options for creating the new page.
-   * @returns An effect that resolves to a `PlaywrightPage` service.
-   * @see {@link Browser.newPage}
-   */
-  readonly newPage: (options?: NewPageOptions) => Effect.Effect<typeof PlaywrightPage.Service, PlaywrightError>;
-  /**
-   * A generic utility to execute any promise-based method on the underlying Playwright `Browser`.
-   * Can be used to access any Browser functionality not directly exposed by this service.
-   *
-   * @example
-   * ```typescript
-   * const contexts = yield* browser.use((b) => b.contexts());
-   * ```
-   *
-   * @param f - A function that takes the Playwright `Browser` and returns a `Promise`.
-   * @returns An effect that wraps the promise and returns its result.
-   * @see {@link Browser}
-   */
-  readonly use: <T$1>(f: (browser: Browser) => Promise<T$1>) => Effect.Effect<T$1, PlaywrightError>;
-  /**
-   * An Effect that closes the browser and all of its pages.
-   * @see {@link Browser.close}
-   */
-  readonly close: Effect.Effect<void, PlaywrightError>;
-  /**
-   * An Effect that returns the list of all open browser contexts.
-   * @see {@link Browser.contexts}
-   */
-  readonly contexts: Effect.Effect<Array<typeof PlaywrightBrowserContext.Service>>;
-  readonly newContext: (options?: NewContextOptions) => Effect.Effect<typeof PlaywrightBrowserContext.Service, PlaywrightError, Scope$1>;
-  /**
-   * An Effect that returns the browser type (chromium, firefox or webkit) that the browser belongs to.
-   * @see {@link Browser.browserType}
-   */
-  readonly browserType: Effect.Effect<BrowserType>;
-  /**
-   * An Effect that returns the version of the browser.
-   * @see {@link Browser.version}
-   */
-  readonly version: Effect.Effect<string>;
-  /**
-   * An Effect that returns whether the browser is connected.
-   * @see {@link Browser.isConnected}
-   */
-  readonly isConnected: Effect.Effect<boolean>;
-}>;
-/**
- * @category tag
- */
-declare class PlaywrightBrowser extends PlaywrightBrowser_base {
-  /**
-   * @category constructor
-   */
-  static make(browser: Browser): {
-    /**
-     * Opens a new page in the browser.
-     *
-     * @example
-     * ```typescript
-     * const page = yield* browser.newPage();
-     * ```
-     *
-     * @param options - Optional options for creating the new page.
-     * @returns An effect that resolves to a `PlaywrightPage` service.
-     * @see {@link Browser.newPage}
-     */
-    readonly newPage: (options?: NewPageOptions) => Effect.Effect<typeof PlaywrightPage.Service, PlaywrightError>;
-    /**
-     * A generic utility to execute any promise-based method on the underlying Playwright `Browser`.
-     * Can be used to access any Browser functionality not directly exposed by this service.
-     *
-     * @example
-     * ```typescript
-     * const contexts = yield* browser.use((b) => b.contexts());
-     * ```
-     *
-     * @param f - A function that takes the Playwright `Browser` and returns a `Promise`.
-     * @returns An effect that wraps the promise and returns its result.
-     * @see {@link Browser}
-     */
-    readonly use: <T$1>(f: (browser: Browser) => Promise<T$1>) => Effect.Effect<T$1, PlaywrightError>;
-    /**
-     * An Effect that closes the browser and all of its pages.
-     * @see {@link Browser.close}
-     */
-    readonly close: Effect.Effect<void, PlaywrightError>;
-    /**
-     * An Effect that returns the list of all open browser contexts.
-     * @see {@link Browser.contexts}
-     */
-    readonly contexts: Effect.Effect<Array<typeof PlaywrightBrowserContext.Service>>;
-    readonly newContext: (options?: NewContextOptions) => Effect.Effect<typeof PlaywrightBrowserContext.Service, PlaywrightError, Scope$1>;
-    /**
-     * An Effect that returns the browser type (chromium, firefox or webkit) that the browser belongs to.
-     * @see {@link Browser.browserType}
-     */
-    readonly browserType: Effect.Effect<BrowserType>;
-    /**
-     * An Effect that returns the version of the browser.
-     * @see {@link Browser.version}
-     */
-    readonly version: Effect.Effect<string>;
-    /**
-     * An Effect that returns whether the browser is connected.
-     * @see {@link Browser.isConnected}
-     */
-    readonly isConnected: Effect.Effect<boolean>;
-  };
-}
-//#endregion
-//#region src/playwright.d.ts
-interface PlaywrightService {
-  /**
-   * Launches a new browser instance.
-   *
-   * It is the caller's responsibility to manage the browser's lifecycle and close
-   * it when no longer needed. For automatic scope-based management, use
-   * {@link launchScoped} instead.
-   *
-   * ```ts
-   * import { Effect } from "effect";
-   * import { Playwright } from "effect-playwright";
-   * import { chromium } from "playwright-core";
-   *
-   * const program = Effect.gen(function* () {
-   *   const browser = yield* Playwright.launch(chromium);
-   *   // ... use browser ...
-   *   yield* browser.close;
-   * });
-   *
-   * await Effect.runPromise(program);
-   * ```
-   *
-   * @param browserType - The browser type to launch (e.g. chromium, firefox, webkit).
-   * @param options - Optional launch options.
-   * @since 0.1.0
-   */
-  launch: (browserType: BrowserType, options?: LaunchOptions$1) => Effect.Effect<typeof PlaywrightBrowser.Service, PlaywrightError>;
-  /**
-   * Launches a new browser instance managed by a Scope.
-   *
-   * This method automatically closes the browser when the scope is closed.
-   *
-   * ```ts
-   * import { Effect } from "effect";
-   * import { Playwright } from "effect-playwright";
-   * import { chromium } from "playwright-core";
-   *
-   * const program = Effect.gen(function* () {
-   *   const browser = yield* Playwright.launchScoped(chromium);
-   *   // Browser will be closed automatically when scope closes
-   * });
-   *
-   * await Effect.runPromise(program);
-   * ```
-   *
-   * @param browserType - The browser type to launch (e.g. chromium, firefox, webkit).
-   * @param options - Optional launch options.
-   * @since 0.1.0
-   */
-  launchScoped: (browserType: BrowserType, options?: LaunchOptions$1) => Effect.Effect<typeof PlaywrightBrowser.Service, PlaywrightError, Scope.Scope>;
-  /**
-   * Connects to a browser instance via Chrome DevTools Protocol (CDP).
-   *
-   * Unlike {@link launchScoped}, this method does **not** close the browser when the
-   * scope is closed. It is the caller's responsibility to manage the browser's
-   * lifecycle.
-   *
-   * If you want to close the browser using a scope simply add a finalizer:
-   *
-   * ```ts
-   * import { Effect } from "effect";
-   * import { Playwright } from "effect-playwright";
-   *
-   * const program = Effect.gen(function* () {
-   *   const browser = yield* Playwright.connectCDP(cdpUrl);
-   *   yield* Effect.addFinalizer(() => browser.close.pipe(Effect.ignore));
-   * });
-   *
-   * await Effect.runPromise(program);
-   * ```
-   *
-   * @param cdpUrl - The CDP URL to connect to.
-   * @param options - Optional options for connecting to the CDP URL.
-   * @since 0.1.0
-   */
-  connectCDP: (cdpUrl: string, options?: ConnectOverCDPOptions) => Effect.Effect<typeof PlaywrightBrowser.Service, PlaywrightError>;
-}
-declare const Playwright_base: Context.TagClass<Playwright, "effect-playwright/index/Playwright", PlaywrightService>;
-declare class Playwright extends Playwright_base {
-  /**
-   * @category layer
-   */
-  static readonly layer: Layer.Layer<Playwright, never, never>;
-}
-//#endregion
-export { NewPageOptions as a, PlaywrightPageService as c, PlaywrightError as d, NewContextOptions as i, PlaywrightLocator as l, PlaywrightService as n, PlaywrightBrowser as o, LaunchOptions$1 as r, PlaywrightPage as s, Playwright as t, PlaywrightLocatorService as u };