n8n-nodes-playwright-chromium-cdp 1.0.0

package/LICENSE.md

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2025 rctphone
+Copyright (c) 2022-2024 Nicholas Penree <nick@penree.com>
+
+This project is a fork of [n8n-nodes-puppeteer](https://github.com/drudge/n8n-nodes-puppeteer) 
+by Nicholas Penree, modified to use Playwright with CDP connection instead of Puppeteer.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,186 @@
+# n8n-nodes-playwright-chromium-cdp
+
+This is an n8n community node for browser automation using [Playwright](https://playwright.dev/) with a **remote browser via CDP (Chrome DevTools Protocol)**.
+
+Unlike other browser automation nodes, this one does **not** install or launch browsers locally. Instead, it connects to an already running browser instance via CDP endpoint.
+
+## Credits
+
+This project is based on [n8n-nodes-puppeteer](https://github.com/drudge/n8n-nodes-puppeteer) by [Nicholas Penree](https://github.com/drudge). The original Puppeteer implementation has been replaced with Playwright, focusing on remote browser connection via CDP.
+
+## Features
+
+- **Remote Browser Connection**: Connect to any browser that exposes a CDP endpoint
+- **No Local Browser Installation**: Perfect for containerized environments
+- **Full Playwright API Access**: Use the powerful Playwright API for automation
+- **Device Emulation**: Emulate various devices (mobile, tablet, desktop)
+- **Screenshot & PDF Generation**: Capture pages as images or PDFs
+- **Custom Scripts**: Run custom JavaScript code with full Playwright access
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+```bash
+npm install n8n-nodes-playwright-chromium-cdp
+```
+
+## Prerequisites
+
+You need a running browser with CDP enabled. Here are some options:
+
+### Option 1: Run Chrome/Chromium with CDP
+
+```bash
+# macOS
+/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
+
+# Linux
+google-chrome --remote-debugging-port=9222
+
+# Windows
+"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222
+```
+
+### Option 2: Use Docker
+
+```bash
+docker run -d -p 9222:9222 zenika/alpine-chrome --no-sandbox --remote-debugging-address=0.0.0.0 --remote-debugging-port=9222
+```
+
+### Option 3: Use browserless.io or similar services
+
+Many services provide remote browsers with CDP access.
+
+## Credentials
+
+Create credentials with the CDP endpoint URL:
+
+- **CDP Endpoint URL**: The URL to connect to (e.g., `http://localhost:9222`)
+- **Timeout**: Connection timeout in milliseconds
+
+## Operations
+
+### Get Page Content
+Retrieves the full HTML content of a page.
+
+### Get Screenshot
+Captures a screenshot of the page (PNG or JPEG).
+
+### Get PDF
+Generates a PDF from the page (Chromium-based browsers only).
+
+### Run Custom Script
+Execute custom JavaScript code with access to Playwright objects:
+
+```javascript
+// Available variables:
+// $browser - Browser instance (connected via playwright.chromium.connectOverCDP())
+// $context - Browser context
+// $page - Page instance  
+// $playwright - Playwright module with { chromium, devices }
+
+// Navigate and extract data
+await $page.goto('https://example.com');
+
+const title = await $page.title();
+const content = await $page.textContent('body');
+
+// Return data (must be an array)
+return [{ title, content, ...$json }];
+```
+
+## Options
+
+- **Batch Size**: Process multiple items in parallel
+- **Emulate Device**: Emulate specific devices (iPhone, Pixel, etc.)
+- **Viewport**: Set custom viewport dimensions
+- **User Agent**: Custom user agent string
+- **Locale/Timezone**: Set browser locale and timezone
+- **Geolocation**: Set fake geolocation
+- **Extra Headers**: Add custom HTTP headers
+- **Wait Until**: Navigation wait strategy (load, domcontentloaded, networkidle, commit)
+- **Timeout**: Navigation timeout
+- **Ignore HTTPS Errors**: Bypass SSL certificate errors
+- **JavaScript Enabled**: Toggle JavaScript execution
+- **Bypass CSP**: Bypass Content Security Policy
+
+## Example: Storing and Reusing Cookies
+
+### Node 1: Login and save cookies
+
+```javascript
+await $page.goto('https://example.com/login');
+
+await $page.fill('#username', 'user');
+await $page.fill('#password', 'pass');
+await $page.click('#login-button');
+
+// Wait for navigation
+await $page.waitForLoadState('networkidle');
+
+// Get cookies from context
+const cookies = await $context.cookies();
+
+return [{ cookies }];
+```
+
+### Node 2: Use saved cookies
+
+```javascript
+const { cookies } = $input.first().json;
+
+// Set cookies
+await $context.addCookies(cookies);
+
+// Navigate to authenticated page
+await $page.goto('https://example.com/dashboard');
+
+const data = await $page.textContent('.dashboard-content');
+
+return [{ data }];
+```
+
+## Example: Taking Screenshots
+
+```javascript
+await $page.goto('https://example.com');
+
+// Wait for content to load
+await $page.waitForSelector('.main-content');
+
+// Take screenshot as base64
+const screenshot = await $page.screenshot({ 
+  type: 'png',
+  fullPage: true 
+});
+
+return [{
+  binary: {
+    screenshot: {
+      data: screenshot.toString('base64'),
+      mimeType: 'image/png',
+      fileName: 'screenshot.png',
+    },
+  },
+}];
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build the node
+npm run build
+
+# Watch for changes
+npm run dev
+```
+
+## License
+
+MIT License - see [LICENSE.md](LICENSE.md)
+
+Based on [n8n-nodes-puppeteer](https://github.com/drudge/n8n-nodes-puppeteer) by Nicholas Penree.

package/dist/credentials/PlaywrightCdpApi.credentials.d.ts

@@ -0,0 +1,9 @@
+import { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class PlaywrightCdpApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    icon: "file:playwright.svg";
+    properties: INodeProperties[];
+}
+//# sourceMappingURL=PlaywrightCdpApi.credentials.d.ts.map

package/dist/credentials/PlaywrightCdpApi.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightCdpApi.credentials.d.ts","sourceRoot":"","sources":["../../credentials/PlaywrightCdpApi.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,eAAe,EACf,eAAe,EACf,MAAM,cAAc,CAAC;AAEtB,qBAAa,gBAAiB,YAAW,eAAe;IACvD,IAAI,SAAsB;IAC1B,WAAW,SAAoB;IAC/B,gBAAgB,SAAqF;IACrG,IAAI,EAAG,qBAAqB,CAAU;IACtC,UAAU,EAAE,eAAe,EAAE,CAgB3B;CACF"}

package/dist/credentials/PlaywrightCdpApi.credentials.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightCdpApi = void 0;
+class PlaywrightCdpApi {
+    constructor() {
+        this.name = 'playwrightCdpApi';
+        this.displayName = 'Playwright CDP';
+        this.documentationUrl = 'https://playwright.dev/docs/api/class-browsertype#browser-type-connect-over-cdp';
+        this.icon = 'file:playwright.svg';
+        this.properties = [
+            {
+                displayName: 'CDP Endpoint URL',
+                name: 'cdpEndpoint',
+                type: 'string',
+                default: 'http://localhost:9222',
+                placeholder: 'http://localhost:9222',
+                description: 'The CDP endpoint URL to connect to the remote browser. Can be HTTP or WebSocket URL (e.g., http://localhost:9222 or ws://localhost:9222/devtools/browser/xxx)',
+            },
+            {
+                displayName: 'Timeout (ms)',
+                name: 'timeout',
+                type: 'number',
+                default: 30000,
+                description: 'Maximum time in milliseconds to wait for the connection to be established',
+            },
+        ];
+    }
+}
+exports.PlaywrightCdpApi = PlaywrightCdpApi;
+//# sourceMappingURL=PlaywrightCdpApi.credentials.js.map

package/dist/credentials/PlaywrightCdpApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightCdpApi.credentials.js","sourceRoot":"","sources":["../../credentials/PlaywrightCdpApi.credentials.ts"],"names":[],"mappings":";;;AAKA,MAAa,gBAAgB;IAA7B;QACC,SAAI,GAAG,kBAAkB,CAAC;QAC1B,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,qBAAgB,GAAG,iFAAiF,CAAC;QACrG,SAAI,GAAG,qBAA8B,CAAC;QACtC,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,uBAAuB;gBAChC,WAAW,EAAE,uBAAuB;gBACpC,WAAW,EAAE,+JAA+J;aAC5K;YACD;gBACC,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,KAAK;gBACd,WAAW,EAAE,2EAA2E;aACxF;SACD,CAAC;IACH,CAAC;CAAA;AAtBD,4CAsBC"}

package/dist/credentials/playwright.svg

@@ -0,0 +1,14 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 400 400">
+  <defs>
+    <linearGradient id="grad1" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" style="stop-color:#2EAD33;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#45BF55;stop-opacity:1" />
+    </linearGradient>
+  </defs>
+  <circle cx="200" cy="200" r="180" fill="url(#grad1)"/>
+  <g fill="#fff">
+    <path d="M120 140 L120 260 L160 260 L160 220 L200 220 L200 260 L240 260 L240 140 L200 140 L200 180 L160 180 L160 140 Z"/>
+    <circle cx="280" cy="200" r="40"/>
+  </g>
+</svg>
+

package/dist/nodes/Playwright/Playwright.node.d.ts

@@ -0,0 +1,12 @@
+import { type IExecuteFunctions, type ILoadOptionsFunctions, type INodeExecutionData, type INodePropertyOptions, type INodeType, type INodeTypeDescription } from 'n8n-workflow';
+export declare const vmResolver: import("@n8n/vm2").Resolver;
+export declare class Playwright implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getDevices(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=Playwright.node.d.ts.map

package/dist/nodes/Playwright/Playwright.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Playwright.node.d.ts","sourceRoot":"","sources":["../../../nodes/Playwright/Playwright.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,SAAS,EACd,KAAK,oBAAoB,EAEzB,MAAM,cAAc,CAAC;AAatB,eAAO,MAAM,UAAU,6BAQrB,CAAC;AA6ZH,qBAAa,UAAW,YAAW,SAAS;IAC3C,WAAW,EAAE,oBAAoB,CAAmB;IAEpD,OAAO;;6BAGE,qBAAqB,GACzB,OAAO,CAAC,oBAAoB,EAAE,CAAC;;MAkBlC;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAwOvE"}