genkitx-playwright 0.3.0

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+  Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   

package/README.md

@@ -0,0 +1,144 @@
+# genkitx-playwright
+
+A [Genkit](https://genkit.dev) middleware that gives LLMs access to a real web
+browser via [Playwright](https://playwright.dev). The model can navigate,
+"read" pages through accessibility snapshots, click, type, fill forms, manage
+tabs, handle dialogs, and more — all scoped safely to a single `generate` call.
+
+## Installation
+
+```bash
+npm install genkitx-playwright playwright
+# Install the browser binaries (one-time)
+npx playwright install chromium
+```
+
+> `genkitx-playwright` lists `playwright` as a dependency and `genkit` (>= 1.37)
+> as a peer dependency.
+
+## Usage
+
+Register the plugin once (this is where you configure the **browser** — engine,
+headless mode, viewport, etc.), then opt into the tools per `generate` call
+(this is where you configure **policy** — allowed domains, read-only, etc.).
+
+```ts
+import { genkit } from 'genkit';
+import { googleAI } from '@genkit-ai/google-genai';
+import { playwright } from 'genkitx-playwright';
+
+const ai = genkit({
+  plugins: [
+    googleAI(),
+    playwright.plugin({ browser: 'chromium', headless: true }),
+  ],
+});
+
+const { text } = await ai.generate({
+  model: googleAI.model('gemini-flash-latest'),
+  prompt: 'Go to example.com and tell me the main heading.',
+  use: [playwright()],
+});
+```
+
+A fresh browser is launched **lazily** on the first browser tool call and is
+**closed automatically** when the generation finishes (success or failure), so
+there are no lingering browser processes.
+
+## How the model "sees" the page
+
+Rather than guessing CSS selectors, the model calls `browser_snapshot` to get an
+accessibility tree where each interactive element is tagged with a stable
+`ref` (e.g. `[ref=e12]`). Interaction tools (`browser_click`, `browser_type`,
+…) take that `ref`. This is the same approach used by the official Playwright
+MCP server and is far more reliable for LLMs.
+
+## Options
+
+### Plugin (browser-level) — `playwright.plugin(options)`
+
+| Option           | Type                                      | Default      | Description                                              |
+| ---------------- | ----------------------------------------- | ------------ | -------------------------------------------------------- |
+| `browser`        | `'chromium' \| 'firefox' \| 'webkit'`     | `'chromium'` | Browser engine to launch.                               |
+| `headless`       | `boolean`                                 | `true`       | Run without a visible window.                            |
+| `launchOptions`  | Playwright `LaunchOptions`                | —            | Passed through to `browserType.launch()`.               |
+| `contextOptions` | Playwright `BrowserContextOptions`        | —            | Passed through to `browser.newContext()` (viewport, …). |
+
+### Per-generate (policy-level) — `playwright(options)`
+
+| Option           | Type                | Default | Description                                                        |
+| ---------------- | ------------------- | ------- | ------------------------------------------------------------------ |
+| `readOnly`       | `boolean`           | `false` | Inject only observe-only tools (no click/type/etc.).               |
+| `allowEvaluate`  | `boolean`           | `false` | Enable the `browser_evaluate` arbitrary-JS escape hatch.           |
+| `tools`          | `PlaywrightToolName[]` | all  | Allow-list of tools to inject.                                     |
+| `allowedDomains` | `string[]`          | —       | Restrict navigation to these hostnames (suffix match).             |
+| `blockedDomains` | `string[]`          | —       | Block navigation to these hostnames (suffix match).                |
+| `toolNamePrefix` | `string`            | `''`    | Prefix prepended to every injected tool name.                      |
+
+## Tools
+
+**Navigation**
+
+- `browser_navigate(url)` — go to a URL
+- `browser_navigate_back()` / `browser_navigate_forward()`
+
+**Observation**
+
+- `browser_snapshot()` — accessibility tree with `ref` ids
+- `browser_screenshot({ fullPage? })` — captures a PNG; the image is injected
+  into the conversation as a real multimodal part (not a JSON blob), so the
+  model actually "sees" it on its next turn
+- `browser_get_console_logs()` — page console messages
+
+- `browser_get_network_requests()` — resources loaded by the page
+
+**Interaction**
+
+- `browser_click(ref, { doubleClick? })`
+- `browser_type(ref, text, { submit? })`
+- `browser_fill(ref, value)`
+- `browser_press_key(key, { ref? })`
+- `browser_hover(ref)`
+- `browser_select_option(ref, values[])`
+- `browser_scroll({ direction?, ref? })`
+- `browser_drag(startRef, endRef)`
+- `browser_file_upload(ref, paths[])`
+
+**Synchronization**
+
+- `browser_wait_for({ text?, textGone?, time? })`
+
+**Tabs**
+
+- `browser_tab_list()` / `browser_tab_new({ url? })` / `browser_tab_select(index)` / `browser_tab_close({ index? })`
+
+**Dialogs**
+
+- `browser_handle_dialog({ accept, promptText? })`
+
+**Escape hatch** (opt-in via `allowEvaluate`)
+
+- `browser_evaluate(script)` — run arbitrary JS in the page
+
+## Safety notes
+
+- Use `allowedDomains` / `blockedDomains` to constrain where the model can go.
+- `readOnly: true` removes every mutating tool — handy for research/scraping.
+- `browser_evaluate` is **off by default**; only enable it when you trust the
+  prompt and need the flexibility.
+- Combine with the
+  [`toolApproval` middleware](https://github.com/genkit-ai/genkit/tree/main/js/plugins/middleware)
+  to require human confirmation before sensitive actions.
+
+## Running the sample
+
+```bash
+npm install
+npx playwright install chromium
+export GEMINI_API_KEY=...   # or GOOGLE_API_KEY
+npm run run-sample
+```
+
+## License
+
+Apache-2.0

package/lib/index.d.mts

@@ -0,0 +1,145 @@
+import { z, GenerateMiddleware, MessageData } from 'genkit';
+import { LaunchOptions, BrowserContextOptions, Page, Dialog } from 'playwright';
+
+type BrowserType = 'chromium' | 'firefox' | 'webkit';
+/** Browser-level configuration, supplied via `playwright.plugin()`. */
+interface BrowserOptions {
+    /** Which browser engine to use. Defaults to `chromium`. */
+    browser?: BrowserType;
+    /** Run the browser without a visible UI. Defaults to `true`. */
+    headless?: boolean;
+    /** Raw Playwright launch options, merged with the above. */
+    launchOptions?: LaunchOptions;
+    /** Raw Playwright browser-context options (viewport, userAgent, etc.). */
+    contextOptions?: BrowserContextOptions;
+}
+/** A captured console message. */
+interface ConsoleLogEntry {
+    type: string;
+    text: string;
+}
+/** A pending dialog awaiting a decision from the model. */
+interface PendingDialog {
+    type: string;
+    message: string;
+    defaultValue: string;
+}
+/**
+ * Manages a single Playwright browser + context for the lifetime of one
+ * `ai.generate()` call. The browser is launched lazily on first use and must
+ * be closed via {@link close} when generation completes.
+ */
+declare class BrowserSession {
+    private readonly options;
+    private browser?;
+    private context?;
+    private launchPromise?;
+    /** Captured console messages for the active page. */
+    readonly consoleLogs: ConsoleLogEntry[];
+    /** The most recent dialog the page raised, awaiting handling. */
+    pendingDialog?: PendingDialog;
+    constructor(options?: BrowserOptions);
+    /** Ensures the browser + context are launched (idempotent). */
+    private ensureLaunched;
+    /** Returns the active page, creating one (and the browser) if needed. */
+    getPage(): Promise<Page>;
+    /** Creates and wires up a new page (tab). */
+    newPage(): Promise<Page>;
+    /** Returns all open pages (tabs). */
+    getPages(): Promise<Page[]>;
+    private attachListeners;
+    /** The raw Playwright dialog object awaiting a response, if any. */
+    activeDialog?: Dialog;
+    /** Closes the browser and releases all resources. Safe to call repeatedly. */
+    close(): Promise<void>;
+}
+
+/**
+ * Browser-level options for the Playwright plugin, passed to
+ * `playwright.plugin(...)`. These apply to every browser launched by the
+ * middleware.
+ */
+type PlaywrightPluginOptions = BrowserOptions;
+/**
+ * Per-generation configuration for the Playwright middleware, passed to
+ * `playwright(...)` in a `generate({ use: [...] })` call.
+ */
+declare const PlaywrightOptionsSchema: z.ZodObject<{
+    readOnly: z.ZodOptional<z.ZodBoolean>;
+    allowEvaluate: z.ZodOptional<z.ZodBoolean>;
+    tools: z.ZodOptional<z.ZodArray<z.ZodEnum<["browser_navigate", "browser_navigate_back", "browser_navigate_forward", "browser_snapshot", "browser_screenshot", "browser_get_console_logs", "browser_get_network_requests", "browser_click", "browser_type", "browser_fill", "browser_press_key", "browser_hover", "browser_select_option", "browser_scroll", "browser_drag", "browser_file_upload", "browser_wait_for", "browser_tab_list", "browser_tab_new", "browser_tab_select", "browser_tab_close", "browser_handle_dialog", "browser_evaluate"]>, "many">>;
+    allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    blockedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    toolNamePrefix: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    readOnly?: boolean | undefined;
+    allowEvaluate?: boolean | undefined;
+    tools?: ("browser_navigate" | "browser_navigate_back" | "browser_navigate_forward" | "browser_snapshot" | "browser_screenshot" | "browser_get_console_logs" | "browser_get_network_requests" | "browser_click" | "browser_type" | "browser_fill" | "browser_press_key" | "browser_hover" | "browser_select_option" | "browser_scroll" | "browser_drag" | "browser_file_upload" | "browser_wait_for" | "browser_tab_list" | "browser_tab_new" | "browser_tab_select" | "browser_tab_close" | "browser_handle_dialog" | "browser_evaluate")[] | undefined;
+    allowedDomains?: string[] | undefined;
+    blockedDomains?: string[] | undefined;
+    toolNamePrefix?: string | undefined;
+}, {
+    readOnly?: boolean | undefined;
+    allowEvaluate?: boolean | undefined;
+    tools?: ("browser_navigate" | "browser_navigate_back" | "browser_navigate_forward" | "browser_snapshot" | "browser_screenshot" | "browser_get_console_logs" | "browser_get_network_requests" | "browser_click" | "browser_type" | "browser_fill" | "browser_press_key" | "browser_hover" | "browser_select_option" | "browser_scroll" | "browser_drag" | "browser_file_upload" | "browser_wait_for" | "browser_tab_list" | "browser_tab_new" | "browser_tab_select" | "browser_tab_close" | "browser_handle_dialog" | "browser_evaluate")[] | undefined;
+    allowedDomains?: string[] | undefined;
+    blockedDomains?: string[] | undefined;
+    toolNamePrefix?: string | undefined;
+}>;
+type PlaywrightOptions = z.infer<typeof PlaywrightOptionsSchema>;
+/**
+ * Genkit middleware that gives the model access to a real browser via
+ * Playwright.
+ *
+ * Register the plugin once to configure the browser engine, then opt into the
+ * tools per `generate` call:
+ *
+ * ```ts
+ * import { genkit } from 'genkit';
+ * import { playwright } from 'genkitx-playwright';
+ *
+ * const ai = genkit({ plugins: [playwright.plugin({ headless: true })] });
+ *
+ * await ai.generate({
+ *   prompt: 'Go to example.com and tell me the heading.',
+ *   use: [playwright()],
+ * });
+ * ```
+ *
+ * A fresh browser is launched lazily on the first tool call and closed
+ * automatically when the generation completes.
+ */
+declare const playwright: GenerateMiddleware<typeof PlaywrightOptionsSchema, PlaywrightPluginOptions>;
+
+/** Names of all tools this middleware can inject. */
+declare const ALL_TOOL_NAMES: readonly ["browser_navigate", "browser_navigate_back", "browser_navigate_forward", "browser_snapshot", "browser_screenshot", "browser_get_console_logs", "browser_get_network_requests", "browser_click", "browser_type", "browser_fill", "browser_press_key", "browser_hover", "browser_select_option", "browser_scroll", "browser_drag", "browser_file_upload", "browser_wait_for", "browser_tab_list", "browser_tab_new", "browser_tab_select", "browser_tab_close", "browser_handle_dialog", "browser_evaluate"];
+type PlaywrightToolName = (typeof ALL_TOOL_NAMES)[number];
+interface ToolFactoryOptions {
+    /** The active browser session. */
+    session: BrowserSession;
+    /**
+     * Queue of messages to inject into the conversation history. Tools that
+     * produce media (e.g. screenshots) push `user` messages here; the middleware
+     * drains the queue into the request on the next turn so the content enters
+     * the model's context as proper multimodal parts instead of a JSON blob.
+     */
+    messageQueue?: MessageData[];
+    /** Prefix to prepend to every tool name. */
+    toolNamePrefix?: string;
+    /** If true, only observe-only (non-mutating) tools are created. */
+    readOnly?: boolean;
+    /** If true, the `browser_evaluate` JS escape-hatch tool is created. */
+    allowEvaluate?: boolean;
+    /** Optional allow-list of (unprefixed) tool names to create. */
+    tools?: PlaywrightToolName[];
+    /** Restrict navigation to these hostnames (suffix match). */
+    allowedDomains?: string[];
+    /** Block navigation to these hostnames (suffix match). */
+    blockedDomains?: string[];
+}
+/**
+ * Creates the set of Playwright browser tools for a single generation.
+ */
+declare function createPlaywrightTools(opts: ToolFactoryOptions): any[];
+
+export { ALL_TOOL_NAMES, type BrowserOptions, BrowserSession, type BrowserType, type PlaywrightOptions, PlaywrightOptionsSchema, type PlaywrightPluginOptions, type PlaywrightToolName, type ToolFactoryOptions, createPlaywrightTools, playwright };

package/lib/index.d.ts

@@ -0,0 +1,145 @@
+import { z, GenerateMiddleware, MessageData } from 'genkit';
+import { LaunchOptions, BrowserContextOptions, Page, Dialog } from 'playwright';
+
+type BrowserType = 'chromium' | 'firefox' | 'webkit';
+/** Browser-level configuration, supplied via `playwright.plugin()`. */
+interface BrowserOptions {
+    /** Which browser engine to use. Defaults to `chromium`. */
+    browser?: BrowserType;
+    /** Run the browser without a visible UI. Defaults to `true`. */
+    headless?: boolean;
+    /** Raw Playwright launch options, merged with the above. */
+    launchOptions?: LaunchOptions;
+    /** Raw Playwright browser-context options (viewport, userAgent, etc.). */
+    contextOptions?: BrowserContextOptions;
+}
+/** A captured console message. */
+interface ConsoleLogEntry {
+    type: string;
+    text: string;
+}
+/** A pending dialog awaiting a decision from the model. */
+interface PendingDialog {
+    type: string;
+    message: string;
+    defaultValue: string;
+}
+/**
+ * Manages a single Playwright browser + context for the lifetime of one
+ * `ai.generate()` call. The browser is launched lazily on first use and must
+ * be closed via {@link close} when generation completes.
+ */
+declare class BrowserSession {
+    private readonly options;
+    private browser?;
+    private context?;
+    private launchPromise?;
+    /** Captured console messages for the active page. */
+    readonly consoleLogs: ConsoleLogEntry[];
+    /** The most recent dialog the page raised, awaiting handling. */
+    pendingDialog?: PendingDialog;
+    constructor(options?: BrowserOptions);
+    /** Ensures the browser + context are launched (idempotent). */
+    private ensureLaunched;
+    /** Returns the active page, creating one (and the browser) if needed. */
+    getPage(): Promise<Page>;
+    /** Creates and wires up a new page (tab). */
+    newPage(): Promise<Page>;
+    /** Returns all open pages (tabs). */
+    getPages(): Promise<Page[]>;
+    private attachListeners;
+    /** The raw Playwright dialog object awaiting a response, if any. */
+    activeDialog?: Dialog;
+    /** Closes the browser and releases all resources. Safe to call repeatedly. */
+    close(): Promise<void>;
+}
+
+/**
+ * Browser-level options for the Playwright plugin, passed to
+ * `playwright.plugin(...)`. These apply to every browser launched by the
+ * middleware.
+ */
+type PlaywrightPluginOptions = BrowserOptions;
+/**
+ * Per-generation configuration for the Playwright middleware, passed to
+ * `playwright(...)` in a `generate({ use: [...] })` call.
+ */
+declare const PlaywrightOptionsSchema: z.ZodObject<{
+    readOnly: z.ZodOptional<z.ZodBoolean>;
+    allowEvaluate: z.ZodOptional<z.ZodBoolean>;
+    tools: z.ZodOptional<z.ZodArray<z.ZodEnum<["browser_navigate", "browser_navigate_back", "browser_navigate_forward", "browser_snapshot", "browser_screenshot", "browser_get_console_logs", "browser_get_network_requests", "browser_click", "browser_type", "browser_fill", "browser_press_key", "browser_hover", "browser_select_option", "browser_scroll", "browser_drag", "browser_file_upload", "browser_wait_for", "browser_tab_list", "browser_tab_new", "browser_tab_select", "browser_tab_close", "browser_handle_dialog", "browser_evaluate"]>, "many">>;
+    allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    blockedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    toolNamePrefix: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    readOnly?: boolean | undefined;
+    allowEvaluate?: boolean | undefined;
+    tools?: ("browser_navigate" | "browser_navigate_back" | "browser_navigate_forward" | "browser_snapshot" | "browser_screenshot" | "browser_get_console_logs" | "browser_get_network_requests" | "browser_click" | "browser_type" | "browser_fill" | "browser_press_key" | "browser_hover" | "browser_select_option" | "browser_scroll" | "browser_drag" | "browser_file_upload" | "browser_wait_for" | "browser_tab_list" | "browser_tab_new" | "browser_tab_select" | "browser_tab_close" | "browser_handle_dialog" | "browser_evaluate")[] | undefined;
+    allowedDomains?: string[] | undefined;
+    blockedDomains?: string[] | undefined;
+    toolNamePrefix?: string | undefined;
+}, {
+    readOnly?: boolean | undefined;
+    allowEvaluate?: boolean | undefined;
+    tools?: ("browser_navigate" | "browser_navigate_back" | "browser_navigate_forward" | "browser_snapshot" | "browser_screenshot" | "browser_get_console_logs" | "browser_get_network_requests" | "browser_click" | "browser_type" | "browser_fill" | "browser_press_key" | "browser_hover" | "browser_select_option" | "browser_scroll" | "browser_drag" | "browser_file_upload" | "browser_wait_for" | "browser_tab_list" | "browser_tab_new" | "browser_tab_select" | "browser_tab_close" | "browser_handle_dialog" | "browser_evaluate")[] | undefined;
+    allowedDomains?: string[] | undefined;
+    blockedDomains?: string[] | undefined;
+    toolNamePrefix?: string | undefined;
+}>;
+type PlaywrightOptions = z.infer<typeof PlaywrightOptionsSchema>;
+/**
+ * Genkit middleware that gives the model access to a real browser via
+ * Playwright.
+ *
+ * Register the plugin once to configure the browser engine, then opt into the
+ * tools per `generate` call:
+ *
+ * ```ts
+ * import { genkit } from 'genkit';
+ * import { playwright } from 'genkitx-playwright';
+ *
+ * const ai = genkit({ plugins: [playwright.plugin({ headless: true })] });
+ *
+ * await ai.generate({
+ *   prompt: 'Go to example.com and tell me the heading.',
+ *   use: [playwright()],
+ * });
+ * ```
+ *
+ * A fresh browser is launched lazily on the first tool call and closed
+ * automatically when the generation completes.
+ */
+declare const playwright: GenerateMiddleware<typeof PlaywrightOptionsSchema, PlaywrightPluginOptions>;
+
+/** Names of all tools this middleware can inject. */
+declare const ALL_TOOL_NAMES: readonly ["browser_navigate", "browser_navigate_back", "browser_navigate_forward", "browser_snapshot", "browser_screenshot", "browser_get_console_logs", "browser_get_network_requests", "browser_click", "browser_type", "browser_fill", "browser_press_key", "browser_hover", "browser_select_option", "browser_scroll", "browser_drag", "browser_file_upload", "browser_wait_for", "browser_tab_list", "browser_tab_new", "browser_tab_select", "browser_tab_close", "browser_handle_dialog", "browser_evaluate"];
+type PlaywrightToolName = (typeof ALL_TOOL_NAMES)[number];
+interface ToolFactoryOptions {
+    /** The active browser session. */
+    session: BrowserSession;
+    /**
+     * Queue of messages to inject into the conversation history. Tools that
+     * produce media (e.g. screenshots) push `user` messages here; the middleware
+     * drains the queue into the request on the next turn so the content enters
+     * the model's context as proper multimodal parts instead of a JSON blob.
+     */
+    messageQueue?: MessageData[];
+    /** Prefix to prepend to every tool name. */
+    toolNamePrefix?: string;
+    /** If true, only observe-only (non-mutating) tools are created. */
+    readOnly?: boolean;
+    /** If true, the `browser_evaluate` JS escape-hatch tool is created. */
+    allowEvaluate?: boolean;
+    /** Optional allow-list of (unprefixed) tool names to create. */
+    tools?: PlaywrightToolName[];
+    /** Restrict navigation to these hostnames (suffix match). */
+    allowedDomains?: string[];
+    /** Block navigation to these hostnames (suffix match). */
+    blockedDomains?: string[];
+}
+/**
+ * Creates the set of Playwright browser tools for a single generation.
+ */
+declare function createPlaywrightTools(opts: ToolFactoryOptions): any[];
+
+export { ALL_TOOL_NAMES, type BrowserOptions, BrowserSession, type BrowserType, type PlaywrightOptions, PlaywrightOptionsSchema, type PlaywrightPluginOptions, type PlaywrightToolName, type ToolFactoryOptions, createPlaywrightTools, playwright };