n8n-nodes-playwright-chromium-cdp 1.0.0

package/dist/nodes/Playwright/Playwright.node.options.js

@@ -0,0 +1,681 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeDescription = void 0;
+exports.nodeDescription = {
+    displayName: 'Playwright CDP',
+    name: 'playwrightCdp',
+    group: ['transform'],
+    version: 1,
+    description: 'Automate browser interactions using Playwright with remote browser via CDP',
+    defaults: {
+        name: 'Playwright CDP',
+        color: '#2EAD33',
+    },
+    icon: 'file:playwright.svg',
+    inputs: ['main'],
+    outputs: ['main'],
+    usableAsTool: true,
+    credentials: [
+        {
+            name: 'playwrightCdpApi',
+            required: true,
+        },
+    ],
+    properties: [
+        {
+            displayName: 'URL',
+            name: 'url',
+            type: 'string',
+            required: true,
+            default: '',
+            displayOptions: {
+                show: {
+                    operation: ['getPageContent', 'getScreenshot', 'getPDF'],
+                },
+            },
+        },
+        {
+            displayName: 'Operation',
+            name: 'operation',
+            type: 'options',
+            options: [
+                {
+                    name: 'Get Page Content',
+                    value: 'getPageContent',
+                    description: 'Gets the full HTML contents of the page',
+                },
+                {
+                    name: 'Get PDF',
+                    value: 'getPDF',
+                    description: 'Captures all or part of the page as a PDF',
+                },
+                {
+                    name: 'Get Screenshot',
+                    value: 'getScreenshot',
+                    description: 'Captures all or part of the page as an image',
+                },
+                {
+                    name: 'Run Custom Script',
+                    value: 'runCustomScript',
+                    description: 'Runs custom code to perform specific actions on the page',
+                },
+            ],
+            default: 'getPageContent',
+        },
+        {
+            displayName: 'Script Code',
+            name: 'scriptCode',
+            type: 'string',
+            typeOptions: {
+                editor: 'codeNodeEditor',
+                editorLanguage: 'javaScript',
+            },
+            required: true,
+            default: '// Navigate to an IP lookup service\nawait $page.goto(\'https://httpbin.org/ip\');\n\n// Extract the IP address from the page content\nconst ipData = await $page.evaluate(() => {\n    const response = document.body.innerText;\n    const parsed = JSON.parse(response);\n    return parsed.origin;  // Extract the \'origin\' field, which typically contains the IP address\n});\n\nconsole.log("Hello, world!");\n\nconsole.log("IP Address", ipData);\n\n// Return the result in the required format\nreturn [{ ip: ipData, ...$json }];',
+            description: 'JavaScript code to execute with Playwright. You have access to the $browser, $context and $page objects.',
+            noDataExpression: false,
+            displayOptions: {
+                show: {
+                    operation: ['runCustomScript'],
+                },
+            },
+        },
+        {
+            displayName: 'Use <code>$page</code>, <code>$context</code>, <code>$browser</code>, or <code>$playwright</code> vars to access Playwright. <a target="_blank" href="https://docs.n8n.io/code-examples/methods-variables-reference/">Special vars/methods</a> are available. <br><br>Debug by using <code>console.log()</code> statements and viewing their output in the browser console.',
+            name: 'notice',
+            type: 'notice',
+            displayOptions: {
+                show: {
+                    operation: ['runCustomScript'],
+                },
+            },
+            default: '',
+        },
+        {
+            displayName: 'Property Name',
+            name: 'dataPropertyName',
+            type: 'string',
+            required: true,
+            default: 'data',
+            description: 'Name of the binary property in which to store the image or PDF data.',
+            displayOptions: {
+                show: {
+                    operation: ['getScreenshot', 'getPDF'],
+                },
+            },
+        },
+        {
+            displayName: 'Page Ranges',
+            name: 'pageRanges',
+            type: 'string',
+            required: false,
+            default: '',
+            description: 'Paper ranges to print, e.g. 1-5, 8, 11-13.',
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+        },
+        {
+            displayName: 'Scale',
+            name: 'scale',
+            type: 'number',
+            typeOptions: {
+                minValue: 0.1,
+                maxValue: 2,
+            },
+            default: 1.0,
+            required: true,
+            description: 'Scales the rendering of the web page. Amount must be between 0.1 and 2.',
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+        },
+        {
+            displayName: 'Prefer CSS Page Size',
+            name: 'preferCSSPageSize',
+            type: 'boolean',
+            required: true,
+            default: true,
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+            description: 'Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.',
+        },
+        {
+            displayName: 'Format',
+            name: 'format',
+            type: 'options',
+            options: [
+                {
+                    name: 'Letter',
+                    value: 'Letter',
+                    description: '8.5in x 11in',
+                },
+                {
+                    name: 'Legal',
+                    value: 'Legal',
+                    description: '8.5in x 14in',
+                },
+                {
+                    name: 'Tabloid',
+                    value: 'Tabloid',
+                    description: '11in x 17in',
+                },
+                {
+                    name: 'Ledger',
+                    value: 'Ledger',
+                    description: '17in x 11in',
+                },
+                {
+                    name: 'A0',
+                    value: 'A0',
+                    description: '33.1in x 46.8in',
+                },
+                {
+                    name: 'A1',
+                    value: 'A1',
+                    description: '23.4in x 33.1in',
+                },
+                {
+                    name: 'A2',
+                    value: 'A2',
+                    description: '16.54in x 23.4in',
+                },
+                {
+                    name: 'A3',
+                    value: 'A3',
+                    description: '11.7in x 16.54in',
+                },
+                {
+                    name: 'A4',
+                    value: 'A4',
+                    description: '8.27in x 11.7in',
+                },
+                {
+                    name: 'A5',
+                    value: 'A5',
+                    description: '5.83in x 8.27in',
+                },
+                {
+                    name: 'A6',
+                    value: 'A6',
+                    description: '4.13in x 5.83in',
+                },
+            ],
+            default: 'Letter',
+            description: 'Valid paper format types when printing a PDF. eg: Letter, A4',
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                    preferCSSPageSize: [false],
+                },
+            },
+        },
+        {
+            displayName: 'Height',
+            name: 'height',
+            type: 'string',
+            default: '',
+            required: false,
+            description: 'Sets the height of paper. You can pass in a number or a string with a unit.',
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                    preferCSSPageSize: [false],
+                },
+            },
+        },
+        {
+            displayName: 'Width',
+            name: 'width',
+            type: 'string',
+            default: '',
+            required: false,
+            description: 'Sets the width of paper. You can pass in a number or a string with a unit.',
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                    preferCSSPageSize: [false],
+                },
+            },
+        },
+        {
+            displayName: 'Landscape',
+            name: 'landscape',
+            type: 'boolean',
+            required: true,
+            default: true,
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+            description: 'Whether to print in landscape orientation.',
+        },
+        {
+            displayName: 'Margin',
+            name: 'margin',
+            type: 'collection',
+            placeholder: 'Add Margin',
+            default: {},
+            description: 'Set the PDF margins.',
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+            options: [
+                {
+                    displayName: 'Top',
+                    name: 'top',
+                    type: 'string',
+                    default: '',
+                    required: false,
+                },
+                {
+                    displayName: 'Bottom',
+                    name: 'bottom',
+                    type: 'string',
+                    default: '',
+                    required: false,
+                },
+                {
+                    displayName: 'Left',
+                    name: 'left',
+                    type: 'string',
+                    default: '',
+                    required: false,
+                },
+                {
+                    displayName: 'Right',
+                    name: 'right',
+                    type: 'string',
+                    default: '',
+                    required: false,
+                },
+            ],
+        },
+        {
+            displayName: 'Display Header/Footer',
+            name: 'displayHeaderFooter',
+            type: 'boolean',
+            required: true,
+            default: false,
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+            description: 'Whether to show the header and footer.',
+        },
+        {
+            displayName: 'Header Template',
+            name: 'headerTemplate',
+            typeOptions: {
+                rows: 5,
+            },
+            type: 'string',
+            default: "",
+            description: `HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: - date formatted print date
+
+            - title document title
+
+            - url document location
+
+            - pageNumber current page number
+
+            - totalPages total pages in the document`,
+            noDataExpression: true,
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                    displayHeaderFooter: [true],
+                },
+            },
+        },
+        {
+            displayName: 'Footer Template',
+            name: 'footerTemplate',
+            typeOptions: {
+                rows: 5,
+            },
+            type: 'string',
+            default: "",
+            description: "HTML template for the print footer. Should be valid HTML with the following classes used to inject values into them: - date formatted print date",
+            noDataExpression: true,
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                    displayHeaderFooter: [true],
+                },
+            },
+        },
+        {
+            displayName: 'Transparent Background',
+            name: 'omitBackground',
+            type: 'boolean',
+            required: true,
+            default: false,
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+            description: 'Hides default white background and allows generating pdfs with transparency.',
+        },
+        {
+            displayName: 'Background Graphics',
+            name: 'printBackground',
+            type: 'boolean',
+            required: true,
+            default: false,
+            displayOptions: {
+                show: {
+                    operation: ['getPDF'],
+                },
+            },
+            description: 'Set to true to include background graphics.',
+        },
+        {
+            displayName: 'Type',
+            name: 'imageType',
+            type: 'options',
+            options: [
+                {
+                    name: 'JPEG',
+                    value: 'jpeg',
+                },
+                {
+                    name: 'PNG',
+                    value: 'png',
+                },
+            ],
+            displayOptions: {
+                show: {
+                    operation: ['getScreenshot'],
+                },
+            },
+            default: 'png',
+            description: 'The image type to use. PNG and JPEG are supported.',
+        },
+        {
+            displayName: 'Quality',
+            name: 'quality',
+            type: 'number',
+            typeOptions: {
+                minValue: 0,
+                maxValue: 100,
+            },
+            default: 100,
+            displayOptions: {
+                show: {
+                    operation: ['getScreenshot'],
+                    imageType: ['jpeg'],
+                },
+            },
+            description: 'The quality of the image, between 0-100. Not applicable to png images.',
+        },
+        {
+            displayName: 'Full Page',
+            name: 'fullPage',
+            type: 'boolean',
+            required: true,
+            default: false,
+            displayOptions: {
+                show: {
+                    operation: ['getScreenshot'],
+                },
+            },
+            description: 'When true, takes a screenshot of the full scrollable page.',
+        },
+        {
+            displayName: 'Query Parameters',
+            name: 'queryParameters',
+            placeholder: 'Add Parameter',
+            type: 'fixedCollection',
+            typeOptions: {
+                multipleValues: true,
+            },
+            displayOptions: {
+                show: {
+                    operation: ['getPageContent', 'getScreenshot', 'getPDF'],
+                },
+            },
+            description: 'The query parameter to send.',
+            default: {},
+            options: [
+                {
+                    name: 'parameters',
+                    displayName: 'Parameters',
+                    values: [
+                        {
+                            displayName: 'Name',
+                            name: 'name',
+                            type: 'string',
+                            default: '',
+                            description: 'Name of the parameter.',
+                        },
+                        {
+                            displayName: 'Value',
+                            name: 'value',
+                            type: 'string',
+                            default: '',
+                            description: 'Value of the parameter.',
+                        },
+                    ],
+                },
+            ],
+        },
+        {
+            displayName: 'Options',
+            name: 'options',
+            type: 'collection',
+            placeholder: 'Add Option',
+            default: {},
+            options: [
+                {
+                    displayName: 'Batch Size',
+                    name: 'batchSize',
+                    type: 'number',
+                    typeOptions: {
+                        minValue: 1,
+                    },
+                    default: 1,
+                    description: 'Maximum number of pages to open simultaneously. More pages will consume more memory and CPU.',
+                },
+                {
+                    displayName: 'Emulate Device',
+                    name: 'device',
+                    type: 'options',
+                    description: 'Emulate a specific device.',
+                    default: '',
+                    typeOptions: {
+                        loadOptionsMethod: 'getDevices',
+                    },
+                    required: false,
+                },
+                {
+                    displayName: 'Extra Headers',
+                    name: 'headers',
+                    placeholder: 'Add Header',
+                    type: 'fixedCollection',
+                    typeOptions: {
+                        multipleValues: true,
+                    },
+                    description: 'The headers to send.',
+                    default: {},
+                    options: [
+                        {
+                            name: 'parameter',
+                            displayName: 'Header',
+                            values: [
+                                {
+                                    displayName: 'Name',
+                                    name: 'name',
+                                    type: 'string',
+                                    default: '',
+                                    description: 'Name of the header.',
+                                },
+                                {
+                                    displayName: 'Value',
+                                    name: 'value',
+                                    type: 'string',
+                                    default: '',
+                                    description: 'Value to set for the header.',
+                                },
+                            ],
+                        },
+                    ],
+                },
+                {
+                    displayName: 'File Name',
+                    name: 'fileName',
+                    type: 'string',
+                    default: '',
+                    description: 'File name to set in binary data. Only applies to \'Get PDF\' and \'Get Screenshot\' operations.',
+                },
+                {
+                    displayName: 'Timeout',
+                    name: 'timeout',
+                    type: 'number',
+                    typeOptions: {
+                        minValue: 0,
+                    },
+                    default: 30000,
+                    description: 'Maximum navigation time in milliseconds. Pass 0 to disable timeout. Has no effect on the \'Run Custom Script\' operation.',
+                },
+                {
+                    displayName: 'Wait Until',
+                    name: 'waitUntil',
+                    type: 'options',
+                    options: [
+                        {
+                            name: 'load',
+                            value: 'load',
+                            description: 'The load event is fired',
+                        },
+                        {
+                            name: 'domcontentloaded',
+                            value: 'domcontentloaded',
+                            description: 'The domcontentloaded event is fired',
+                        },
+                        {
+                            name: 'networkidle',
+                            value: 'networkidle',
+                            description: 'No network connections for at least 500 ms',
+                        },
+                        {
+                            name: 'commit',
+                            value: 'commit',
+                            description: 'When network response is received and the document started loading',
+                        },
+                    ],
+                    default: 'load',
+                    description: 'When to consider navigation succeeded. Has no effect on the \'Run Custom Script\' operation.',
+                },
+                {
+                    displayName: 'Viewport Width',
+                    name: 'viewportWidth',
+                    type: 'number',
+                    typeOptions: {
+                        minValue: 1,
+                    },
+                    default: 1280,
+                    description: 'Page viewport width in pixels.',
+                },
+                {
+                    displayName: 'Viewport Height',
+                    name: 'viewportHeight',
+                    type: 'number',
+                    typeOptions: {
+                        minValue: 1,
+                    },
+                    default: 720,
+                    description: 'Page viewport height in pixels.',
+                },
+                {
+                    displayName: 'User Agent',
+                    name: 'userAgent',
+                    type: 'string',
+                    default: '',
+                    description: 'Custom user agent to use.',
+                },
+                {
+                    displayName: 'Locale',
+                    name: 'locale',
+                    type: 'string',
+                    default: '',
+                    placeholder: 'en-US',
+                    description: 'Specify user locale, for example en-GB, de-DE, etc.',
+                },
+                {
+                    displayName: 'Timezone',
+                    name: 'timezone',
+                    type: 'string',
+                    default: '',
+                    placeholder: 'America/New_York',
+                    description: 'Changes the timezone of the context. See ICU\'s metaZones.txt for a list of supported timezone IDs.',
+                },
+                {
+                    displayName: 'Geolocation',
+                    name: 'geolocation',
+                    type: 'collection',
+                    placeholder: 'Add Geolocation',
+                    default: {},
+                    description: 'Set geolocation.',
+                    options: [
+                        {
+                            displayName: 'Latitude',
+                            name: 'latitude',
+                            type: 'number',
+                            default: 0,
+                            description: 'Latitude between -90 and 90.',
+                        },
+                        {
+                            displayName: 'Longitude',
+                            name: 'longitude',
+                            type: 'number',
+                            default: 0,
+                            description: 'Longitude between -180 and 180.',
+                        },
+                        {
+                            displayName: 'Accuracy',
+                            name: 'accuracy',
+                            type: 'number',
+                            default: 0,
+                            description: 'Non-negative accuracy value.',
+                        },
+                    ],
+                },
+                {
+                    displayName: 'Ignore HTTPS Errors',
+                    name: 'ignoreHTTPSErrors',
+                    type: 'boolean',
+                    default: false,
+                    description: 'Whether to ignore HTTPS errors when sending network requests.',
+                },
+                {
+                    displayName: 'JavaScript Enabled',
+                    name: 'javaScriptEnabled',
+                    type: 'boolean',
+                    default: true,
+                    description: 'Whether to enable JavaScript in the context.',
+                },
+                {
+                    displayName: 'Bypass CSP',
+                    name: 'bypassCSP',
+                    type: 'boolean',
+                    default: false,
+                    description: 'Toggles bypassing page\'s Content-Security-Policy.',
+                },
+            ],
+        },
+    ],
+};
+//# sourceMappingURL=Playwright.node.options.js.map