@mendable/n8n-nodes-firecrawl 2.1.3 → 2.2.0

package/dist/nodes/Firecrawl/api/common.js

@@ -113,13 +113,14 @@ function formatOperationName(name) {
         .join(' ');
 }
 exports.formatOperationName = formatOperationName;
-function createOperationNotice(resourceName, operationName, method = 'POST') {
+function createOperationNotice(resourceName, operationName, text, options = {}) {
+    var _a;
     return {
-        displayName: `${method} /${operationName}`,
-        name: 'operation',
+        displayName: text,
+        name: `${operationName}Notice`,
         type: 'notice',
         typeOptions: {
-            theme: 'info',
+            theme: (_a = options.theme) !== null && _a !== void 0 ? _a : 'info',
         },
         default: '',
         displayOptions: {
@@ -173,46 +174,49 @@ function createActionsProperty(operationName, omitDisplayOptions = false, useNes
                 name: 'items',
                 values: [
                     {
-                        displayName: 'Type',
+                        displayName: 'Direction',
                         type: 'options',
-                        default: 'wait',
+                        default: 'down',
+                        description: 'Direction for `scroll` action',
+                        name: 'direction',
                         options: [
                             {
-                                name: 'Click',
-                                value: 'click',
-                            },
-                            {
-                                name: 'Press',
-                                value: 'press',
-                            },
-                            {
-                                name: 'Screenshot',
-                                value: 'screenshot',
+                                name: 'Down',
+                                value: 'down',
                             },
                             {
-                                name: 'Scroll',
-                                value: 'scroll',
+                                name: 'Up',
+                                value: 'up',
                             },
-                            {
-                                name: 'Wait',
-                                value: 'wait',
+                        ],
+                        displayOptions: {
+                            show: {
+                                type: ['scroll'],
                             },
-                            {
-                                name: 'Write',
-                                value: 'write',
+                        },
+                    },
+                    {
+                        displayName: 'Full Page',
+                        type: 'boolean',
+                        default: false,
+                        description: 'Whether the screenshot should be full-page or viewport sized',
+                        name: 'fullPage',
+                        displayOptions: {
+                            show: {
+                                type: ['screenshot'],
                             },
-                        ],
-                        name: 'type',
+                        },
                     },
                     {
-                        displayName: 'Selector',
+                        displayName: 'Key',
                         type: 'string',
                         default: '',
-                        description: 'CSS selector to target an element (e.g., "#submit-btn", ".load-more", "[data-testid=login]"). Used for click, write, and scroll actions.',
-                        name: 'selector',
+                        placeholder: 'e.g. Enter',
+                        description: 'Keyboard key to press (e.g., "Enter", "Tab", "Escape", "ArrowDown"). Use for form submission, navigation, or triggering keyboard shortcuts.',
+                        name: 'key',
                         displayOptions: {
                             show: {
-                                type: ['click', 'scroll'],
+                                type: ['press'],
                             },
                         },
                     },
@@ -229,14 +233,15 @@ function createActionsProperty(operationName, omitDisplayOptions = false, useNes
                         },
                     },
                     {
-                        displayName: 'Full Page',
-                        type: 'boolean',
-                        default: false,
-                        description: 'Whether the screenshot should be full-page or viewport sized',
-                        name: 'fullPage',
+                        displayName: 'Selector',
+                        type: 'string',
+                        default: '',
+                        placeholder: 'e.g. #submit-btn',
+                        description: 'CSS selector to target an element (e.g., "#submit-btn", ".load-more", "[data-testid=login]"). Used for click, write, and scroll actions.',
+                        name: 'selector',
                         displayOptions: {
                             show: {
-                                type: ['screenshot'],
+                                type: ['click', 'scroll'],
                             },
                         },
                     },
@@ -244,6 +249,7 @@ function createActionsProperty(operationName, omitDisplayOptions = false, useNes
                         displayName: 'Text',
                         type: 'string',
                         default: '',
+                        placeholder: 'e.g. n8n automation',
                         description: 'Text to type into an input field. Use with selector to target the input element. Useful for search boxes, login forms, or any text input.',
                         name: 'text',
                         displayOptions: {
@@ -253,38 +259,36 @@ function createActionsProperty(operationName, omitDisplayOptions = false, useNes
                         },
                     },
                     {
-                        displayName: 'Key',
-                        type: 'string',
-                        default: '',
-                        description: 'Keyboard key to press (e.g., "Enter", "Tab", "Escape", "ArrowDown"). Use for form submission, navigation, or triggering keyboard shortcuts.',
-                        name: 'key',
-                        displayOptions: {
-                            show: {
-                                type: ['press'],
-                            },
-                        },
-                    },
-                    {
-                        displayName: 'Direction',
+                        displayName: 'Type',
                         type: 'options',
-                        default: 'down',
-                        description: 'Direction for `scroll` action',
-                        name: 'direction',
+                        default: 'wait',
                         options: [
                             {
-                                name: 'Down',
-                                value: 'down',
+                                name: 'Click',
+                                value: 'click',
                             },
                             {
-                                name: 'Up',
-                                value: 'up',
+                                name: 'Press',
+                                value: 'press',
                             },
-                        ],
-                        displayOptions: {
-                            show: {
-                                type: ['scroll'],
+                            {
+                                name: 'Screenshot',
+                                value: 'screenshot',
                             },
-                        },
+                            {
+                                name: 'Scroll',
+                                value: 'scroll',
+                            },
+                            {
+                                name: 'Wait',
+                                value: 'wait',
+                            },
+                            {
+                                name: 'Write',
+                                value: 'write',
+                            },
+                        ],
+                        name: 'type',
                     },
                 ],
             },
@@ -372,6 +376,7 @@ function createLocationProperty(operationName, omitDisplayOptions = false, useNe
                                         name: 'code',
                                         type: 'string',
                                         default: '',
+                                        placeholder: 'e.g. en',
                                         description: "Language code (e.g., 'en', 'fr', 'de', 'ja')",
                                     },
                                 ],
@@ -429,7 +434,7 @@ function createIncludeTagsProperty(operationName, omitDisplayOptions = false, us
                         name: 'tag',
                         type: 'string',
                         default: '',
-                        placeholder: 'header',
+                        placeholder: 'e.g. header',
                         description: 'Tag to include in the output',
                     },
                 ],
@@ -473,7 +478,7 @@ function createBatchUrlsProperty(operationName, defaultUrl = 'https://firecrawl.
         default: defaultUrl,
         required: true,
         description: 'URLs to scrape in batch. Accepts multiple formats: a single URL, multiple URLs separated by commas or newlines, a JSON array like ["url1", "url2"], or an array expression from a previous node. Each URL is scraped independently with the same settings. Example: "https://example.com/page1, https://example.com/page2" or paste one URL per line.',
-        placeholder: 'https://example.com/page1\nhttps://example.com/page2',
+        placeholder: 'e.g. https://example.com/page1\nhttps://example.com/page2',
         routing: {
             request: {
                 body: {
@@ -531,7 +536,7 @@ function createExcludeTagsProperty(operationName, omitDisplayOptions = false, us
                         name: 'tag',
                         type: 'string',
                         default: '',
-                        placeholder: 'footer',
+                        placeholder: 'e.g. footer',
                         description: 'Tag to exclude from the output',
                     },
                 ],
@@ -583,6 +588,7 @@ function createBatchSpecificProperties() {
                             type: 'string',
                             required: true,
                             default: '',
+                            placeholder: 'e.g. https://example.com/webhook',
                             description: 'The URL to send the webhook to. Triggers for batchScrape.started, batchScrape.page, batchScrape.completed, or batchScrape.failed events.',
                         },
                         {
@@ -604,6 +610,7 @@ function createBatchSpecificProperties() {
                                             name: 'key',
                                             type: 'string',
                                             default: '',
+                                            placeholder: 'e.g. X-Api-Key',
                                             description: 'Header key',
                                         },
                                         {
@@ -611,6 +618,7 @@ function createBatchSpecificProperties() {
                                             name: 'value',
                                             type: 'string',
                                             default: '',
+                                            placeholder: 'e.g. abc123',
                                             description: 'Header value',
                                         },
                                     ],
@@ -715,6 +723,13 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                 displayName: 'Options',
                 name: 'options',
                 values: [
+                    {
+                        displayName: 'Block Ads',
+                        name: 'blockAds',
+                        type: 'boolean',
+                        default: true,
+                        description: 'Whether to enable ad-blocking and cookie consent popup blocking for cleaner content extraction. Recommended for most scraping tasks.',
+                    },
                     {
                         displayName: 'Formats',
                         name: 'formats',
@@ -731,51 +746,36 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                 name: 'format',
                                 values: [
                                     {
-                                        displayName: 'Type',
-                                        name: 'type',
-                                        type: 'options',
-                                        default: 'markdown',
-                                        description: 'Output format for scraped content. Use "Summary" when user asks for a summary, overview, or condensed version of page content. Use "Markdown" for full content in AI-readable format.',
-                                        options: [
-                                            {
-                                                name: 'Change Tracking',
-                                                value: 'changeTracking',
-                                                description: 'Track changes between page versions over time',
+                                        displayName: 'Full Page',
+                                        name: 'fullPage',
+                                        type: 'boolean',
+                                        default: false,
+                                        description: 'Whether to capture the full page screenshot',
+                                        displayOptions: {
+                                            show: {
+                                                type: ['screenshot'],
                                             },
+                                        },
+                                    },
+                                    {
+                                        displayName: 'Modes',
+                                        name: 'modes',
+                                        type: 'multiOptions',
+                                        default: ['git-diff'],
+                                        description: 'Modes for change tracking. At least one mode must be selected.',
+                                        displayOptions: {
+                                            show: {
+                                                type: ['changeTracking'],
+                                            },
+                                        },
+                                        options: [
                                             {
-                                                name: 'HTML',
-                                                value: 'html',
-                                                description: 'Clean HTML with scripts and styles removed',
+                                                name: 'Git Diff',
+                                                value: 'git-diff',
                                             },
                                             {
                                                 name: 'JSON',
                                                 value: 'json',
-                                                description: 'Extract structured data using AI with a schema',
-                                            },
-                                            {
-                                                name: 'Links',
-                                                value: 'links',
-                                                description: 'Extract all links from the page',
-                                            },
-                                            {
-                                                name: 'Markdown',
-                                                value: 'markdown',
-                                                description: 'Full page content as markdown - best for AI/LLM processing and reading full content',
-                                            },
-                                            {
-                                                name: 'Raw HTML',
-                                                value: 'rawHtml',
-                                                description: 'Original HTML including scripts and styles',
-                                            },
-                                            {
-                                                name: 'Screenshot',
-                                                value: 'screenshot',
-                                                description: 'Visual screenshot of the page as base64 image',
-                                            },
-                                            {
-                                                name: 'Summary',
-                                                value: 'summary',
-                                                description: 'AI-generated concise summary of page content - USE THIS when user asks for a summary, overview, brief description, or wants to quickly understand what a page is about',
                                             },
                                         ],
                                     },
@@ -784,6 +784,7 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                         name: 'prompt',
                                         type: 'string',
                                         default: '',
+                                        placeholder: 'e.g. Extract the product name and price',
                                         description: 'Prompt for JSON format extraction',
                                         displayOptions: {
                                             show: {
@@ -792,57 +793,52 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                         },
                                     },
                                     {
-                                        displayName: 'Schema',
-                                        name: 'schema',
-                                        type: 'json',
-                                        default: '{}',
-                                        description: 'JSON schema for JSON format extraction',
+                                        displayName: 'Prompt',
+                                        name: 'prompt',
+                                        type: 'string',
+                                        default: '',
+                                        placeholder: 'e.g. Track changes to pricing only',
+                                        description: 'Prompt for change tracking',
                                         displayOptions: {
                                             show: {
-                                                type: ['json'],
+                                                type: ['changeTracking'],
                                             },
                                         },
                                     },
                                     {
-                                        displayName: 'Modes',
-                                        name: 'modes',
-                                        type: 'multiOptions',
-                                        default: ['git-diff'],
-                                        description: 'Modes for change tracking. At least one mode must be selected.',
+                                        displayName: 'Quality',
+                                        name: 'quality',
+                                        type: 'number',
+                                        typeOptions: {
+                                            minValue: 1,
+                                            maxValue: 100,
+                                        },
+                                        default: 100,
+                                        description: 'Screenshot quality (1-100)',
                                         displayOptions: {
                                             show: {
-                                                type: ['changeTracking'],
+                                                type: ['screenshot'],
                                             },
                                         },
-                                        options: [
-                                            {
-                                                name: 'Git Diff',
-                                                value: 'git-diff',
-                                            },
-                                            {
-                                                name: 'JSON',
-                                                value: 'json',
-                                            },
-                                        ],
                                     },
                                     {
                                         displayName: 'Schema',
                                         name: 'schema',
                                         type: 'json',
                                         default: '{}',
-                                        description: 'JSON schema for change tracking',
+                                        description: 'JSON schema for JSON format extraction',
                                         displayOptions: {
                                             show: {
-                                                type: ['changeTracking'],
+                                                type: ['json'],
                                             },
                                         },
                                     },
                                     {
-                                        displayName: 'Prompt',
-                                        name: 'prompt',
-                                        type: 'string',
-                                        default: '',
-                                        description: 'Prompt for change tracking',
+                                        displayName: 'Schema',
+                                        name: 'schema',
+                                        type: 'json',
+                                        default: '{}',
+                                        description: 'JSON schema for change tracking',
                                         displayOptions: {
                                             show: {
                                                 type: ['changeTracking'],
@@ -854,6 +850,7 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                         name: 'tag',
                                         type: 'string',
                                         default: '',
+                                        placeholder: 'e.g. pricing-page',
                                         description: 'Tag for change tracking',
                                         displayOptions: {
                                             show: {
@@ -862,27 +859,63 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                         },
                                     },
                                     {
-                                        displayName: 'Full Page',
-                                        name: 'fullPage',
-                                        type: 'boolean',
-                                        default: false,
-                                        description: 'Whether to capture the full page screenshot',
-                                        displayOptions: {
-                                            show: {
-                                                type: ['screenshot'],
+                                        displayName: 'Type',
+                                        name: 'type',
+                                        type: 'options',
+                                        default: 'markdown',
+                                        description: 'Output format for scraped content. Use "Summary" when user asks for a summary, overview, or condensed version of page content. Use "Markdown" for full content in AI-readable format.',
+                                        options: [
+                                            {
+                                                name: 'Change Tracking',
+                                                value: 'changeTracking',
+                                                description: 'Track changes between page versions over time',
                                             },
-                                        },
+                                            {
+                                                name: 'HTML',
+                                                value: 'html',
+                                                description: 'Clean HTML with scripts and styles removed',
+                                            },
+                                            {
+                                                name: 'JSON',
+                                                value: 'json',
+                                                description: 'Extract structured data using AI with a schema',
+                                            },
+                                            {
+                                                name: 'Links',
+                                                value: 'links',
+                                                description: 'Extract all links from the page',
+                                            },
+                                            {
+                                                name: 'Markdown',
+                                                value: 'markdown',
+                                                description: 'Full page content as markdown - best for AI/LLM processing and reading full content',
+                                            },
+                                            {
+                                                name: 'Raw HTML',
+                                                value: 'rawHtml',
+                                                description: 'Original HTML including scripts and styles',
+                                            },
+                                            {
+                                                name: 'Screenshot',
+                                                value: 'screenshot',
+                                                description: 'Visual screenshot of the page as base64 image',
+                                            },
+                                            {
+                                                name: 'Summary',
+                                                value: 'summary',
+                                                description: 'AI-generated concise summary of page content - USE THIS when user asks for a summary, overview, brief description, or wants to quickly understand what a page is about',
+                                            },
+                                        ],
                                     },
                                     {
-                                        displayName: 'Quality',
-                                        name: 'quality',
+                                        displayName: 'Viewport Height',
+                                        name: 'viewportHeight',
                                         type: 'number',
                                         typeOptions: {
                                             minValue: 1,
-                                            maxValue: 100,
                                         },
-                                        default: 100,
-                                        description: 'Screenshot quality (1-100)',
+                                        default: 768,
+                                        description: 'Viewport height for screenshot',
                                         displayOptions: {
                                             show: {
                                                 type: ['screenshot'],
@@ -904,21 +937,6 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                             },
                                         },
                                     },
-                                    {
-                                        displayName: 'Viewport Height',
-                                        name: 'viewportHeight',
-                                        type: 'number',
-                                        typeOptions: {
-                                            minValue: 1,
-                                        },
-                                        default: 768,
-                                        description: 'Viewport height for screenshot',
-                                        displayOptions: {
-                                            show: {
-                                                type: ['screenshot'],
-                                            },
-                                        },
-                                    },
                                 ],
                             },
                         ],
@@ -930,13 +948,6 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                             },
                         },
                     },
-                    {
-                        displayName: 'Only Main Content',
-                        name: 'onlyMainContent',
-                        type: 'boolean',
-                        default: true,
-                        description: 'Whether to automatically remove navigation, headers, footers, sidebars, and other boilerplate content. Best for extracting article text or primary page content. Disable to capture the full page.',
-                    },
                     createIncludeTagsProperty(operationName, true, useNestedScrapeOptions),
                     createExcludeTagsProperty(operationName, true, useNestedScrapeOptions),
                     {
@@ -951,6 +962,7 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                 name: 'key',
                                 type: 'string',
                                 default: '',
+                                placeholder: 'e.g. Authorization',
                                 description: 'Key of the header',
                             },
                             {
@@ -958,17 +970,11 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                                 name: 'value',
                                 type: 'string',
                                 default: '',
+                                placeholder: 'e.g. Bearer abc123',
                                 description: 'Value of the header',
                             },
                         ],
                     },
-                    {
-                        displayName: 'Wait For (Ms)',
-                        name: 'waitFor',
-                        type: 'number',
-                        default: 0,
-                        description: 'Additional wait time in milliseconds after page load before extracting content. Use for JavaScript-heavy sites where content renders dynamically. 0 uses intelligent auto-detection.',
-                    },
                     {
                         displayName: 'Mobile',
                         name: 'mobile',
@@ -977,21 +983,29 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                         description: 'Whether to emulate a mobile device when scraping. Useful for sites with mobile-specific content, responsive layouts, or mobile-only features. Changes viewport and user-agent.',
                     },
                     {
-                        displayName: 'Skip TLS Verification',
-                        name: 'skipTlsVerification',
+                        displayName: 'Only Main Content',
+                        name: 'onlyMainContent',
                         type: 'boolean',
-                        default: false,
-                        description: 'Whether to bypass SSL/TLS certificate validation. Enable for sites with self-signed or expired certificates. Use with caution as it reduces security.',
+                        default: true,
+                        description: 'Whether to automatically remove navigation, headers, footers, sidebars, and other boilerplate content. Best for extracting article text or primary page content. Disable to capture the full page.',
                     },
                     {
-                        displayName: 'Timeout (Ms)',
-                        name: 'timeout',
-                        type: 'number',
-                        default: 30000,
-                        description: 'Maximum time in milliseconds to wait for the page to load. Increase for slow sites or complex pages. Default 30000ms (30 seconds).',
+                        displayName: 'Proxy',
+                        name: 'proxy',
+                        type: 'options',
+                        default: 'basic',
+                        description: 'Proxy strategy for bypassing anti-bot measures. Basic is faster and cheaper. Stealth uses residential proxies for better success on protected sites.',
+                        options: [
+                            {
+                                name: 'Basic',
+                                value: 'basic',
+                            },
+                            {
+                                name: 'Stealth',
+                                value: 'stealth',
+                            },
+                        ],
                     },
-                    createActionsProperty(operationName, true, useNestedScrapeOptions),
-                    createLocationProperty(operationName, true, useNestedScrapeOptions),
                     {
                         displayName: 'Remove Base64 Images',
                         name: 'removeBase64Images',
@@ -999,12 +1013,14 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                         default: true,
                         description: 'Whether to strip embedded base64 images from output while preserving alt text. Reduces output size significantly. Disable if you need inline image data.',
                     },
+                    createActionsProperty(operationName, true, useNestedScrapeOptions),
+                    createLocationProperty(operationName, true, useNestedScrapeOptions),
                     {
-                        displayName: 'Block Ads',
-                        name: 'blockAds',
+                        displayName: 'Skip TLS Verification',
+                        name: 'skipTlsVerification',
                         type: 'boolean',
-                        default: true,
-                        description: 'Whether to enable ad-blocking and cookie consent popup blocking for cleaner content extraction. Recommended for most scraping tasks.',
+                        default: false,
+                        description: 'Whether to bypass SSL/TLS certificate validation. Enable for sites with self-signed or expired certificates. Use with caution as it reduces security.',
                     },
                     {
                         displayName: 'Store In Cache',
@@ -1014,21 +1030,18 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
                         description: 'Whether to cache the scraped page for faster subsequent requests. Disable for real-time data needs, sensitive content, or when privacy is a concern.',
                     },
                     {
-                        displayName: 'Proxy',
-                        name: 'proxy',
-                        type: 'options',
-                        default: 'basic',
-                        description: 'Proxy strategy for bypassing anti-bot measures. Basic is faster and cheaper. Stealth uses residential proxies for better success on protected sites.',
-                        options: [
-                            {
-                                name: 'Basic',
-                                value: 'basic',
-                            },
-                            {
-                                name: 'Stealth',
-                                value: 'stealth',
-                            },
-                        ],
+                        displayName: 'Timeout (Ms)',
+                        name: 'timeout',
+                        type: 'number',
+                        default: 30000,
+                        description: 'Maximum time in milliseconds to wait for the page to load. Increase for slow sites or complex pages. Default 30000ms (30 seconds).',
+                    },
+                    {
+                        displayName: 'Wait For (Ms)',
+                        name: 'waitFor',
+                        type: 'number',
+                        default: 0,
+                        description: 'Additional wait time in milliseconds after page load before extracting content. Use for JavaScript-heavy sites where content renders dynamically. 0 uses intelligent auto-detection.',
                     },
                     ...(batchMode ? createBatchSpecificProperties() : []),
                 ],
@@ -1051,22 +1064,23 @@ function createScrapeOptionsProperty(operationName, useNestedScrapeOptions = tru
     };
 }
 exports.createScrapeOptionsProperty = createScrapeOptionsProperty;
-function createOperationOption(name, action) {
+function createOperationOption(operationName, displayName, action, description) {
     return {
-        name: action,
-        value: name,
+        name: displayName,
+        value: operationName,
         action,
+        description,
         routing: {
             request: {
                 method: 'POST',
-                url: `=/${name}`,
+                url: `=/${operationName}`,
             },
         },
     };
 }
 exports.createOperationOption = createOperationOption;
-function buildApiProperties(name, action, properties) {
-    const option = createOperationOption(name, action);
+function buildApiProperties(operationName, displayName, action, description, properties = []) {
+    const option = createOperationOption(operationName, displayName, action, description);
     return (0, helpers_1.buildPropertiesWithOptions)(option, properties);
 }
 exports.buildApiProperties = buildApiProperties;