@mendable/n8n-nodes-firecrawl 1.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+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,85 @@
+# n8n-nodes-firecrawl 🔥
+
+This is an n8n community node. It lets you use **[Firecrawl](https://firecrawl.dev)** in your n8n workflows.
+
+> 🔥 Turn entire websites into LLM-ready markdown or structured data. Scrape, crawl and extract with a single API.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+[Installation](#installation)  
+[Operations](#operations)  
+[Credentials](#credentials)  
+[Compatibility](#compatibility)  
+[Resources](#resources)  
+[Version history](#version-history)  
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+The **Firecrawl** node supports the following operations:
+
+### Map
+- Input a website and get all the website urls
+
+### Scrape
+- Scrapes a URL and get its content in LLM-ready format (markdown, structured data via LLM Extract, screenshot, html)
+
+### Crawl
+- Scrapes all the URLs of a web page and return content in LLM-ready format
+
+### Get Crawl Status
+- Check the current status of a crawl job
+
+### Extract Data
+- Get structured data from single page, multiple pages or entire websites with AI
+
+### Get Extract Status
+- Get the current status of an extraction job
+
+## Credentials
+
+To use the Firecrawl node, you need to:
+
+1. Sign up for a Firecrawl account at [https://firecrawl.dev](https://firecrawl.dev)
+2. Get your API key from the Firecrawl dashboard
+3. In n8n, add your Firecrawl API key to the node's credentials
+
+> [!CAUTION]  
+> The API key should be kept secure and never shared publicly
+
+## Compatibility
+
+- Minimum n8n version: 1.0.0
+- Tested against n8n versions: 1.0.0, 1.1.0, 1.2.0
+- Node.js version: 18 or higher
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+* [Firecrawl Documentation](https://firecrawl.dev/docs)
+* [Firecrawl API Reference](https://docs.firecrawl.dev/api-reference/introduction)
+
+## Version history
+
+### 1.0.0
+- Initial release
+- Support for all basic Firecrawl operations:
+  - Map URLs
+  - Scrape URL
+  - Crawl Website
+  - Get Crawl Status
+  - Extract Data
+  - Get Extract Status
+- Basic error handling and response processing
+- Support for custom body options
+
+## More information
+
+Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
+
+## License
+
+[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)

package/dist/credentials/FirecrawlApi.credentials.d.ts

@@ -0,0 +1,8 @@
+import type { IAuthenticateGeneric, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class FirecrawlApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+}

package/dist/credentials/FirecrawlApi.credentials.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirecrawlApi = void 0;
+class FirecrawlApi {
+    constructor() {
+        this.name = 'firecrawlApi';
+        this.displayName = 'Firecrawl API';
+        this.documentationUrl = 'https://docs.firecrawl.dev/introduction#api-key';
+        this.properties = [
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: 'https://api.firecrawl.dev/v1',
+            },
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Bearer {{$credentials.apiKey}}',
+                    _origin: 'n8n',
+                    _originType: 'integration',
+                },
+            },
+        };
+    }
+}
+exports.FirecrawlApi = FirecrawlApi;
+//# sourceMappingURL=FirecrawlApi.credentials.js.map

package/dist/credentials/FirecrawlApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FirecrawlApi.credentials.js","sourceRoot":"","sources":["../../credentials/FirecrawlApi.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,YAAY;IAAzB;QACC,SAAI,GAAG,cAAc,CAAC;QAEtB,gBAAW,GAAG,eAAe,CAAC;QAE9B,qBAAgB,GAAG,iDAAiD,CAAC;QAErE,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,8BAA8B;aACvC;YACD;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;aACX;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,iCAAiC;oBAChD,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,aAAa;iBAC1B;aACD;SACD,CAAC;IACH,CAAC;CAAA;AAjCD,oCAiCC"}

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

@@ -0,0 +1,21 @@
+import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Firecrawl implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions?: {
+            [key: string]: (this: import("n8n-workflow").ILoadOptionsFunctions) => Promise<import("n8n-workflow").INodePropertyOptions[]>;
+        } | undefined;
+        listSearch?: {
+            [key: string]: (this: import("n8n-workflow").ILoadOptionsFunctions, filter?: string | undefined, paginationToken?: string | undefined) => Promise<import("n8n-workflow").INodeListSearchResult>;
+        } | undefined;
+        credentialTest?: {
+            [functionName: string]: import("n8n-workflow").ICredentialTestFunction;
+        } | undefined;
+        resourceMapping?: {
+            [functionName: string]: (this: import("n8n-workflow").ILoadOptionsFunctions) => Promise<import("n8n-workflow").ResourceMapperFields>;
+        } | undefined;
+        actionHandler?: {
+            [functionName: string]: (this: import("n8n-workflow").ILoadOptionsFunctions, payload: string | import("n8n-workflow").IDataObject | undefined) => Promise<import("n8n-workflow").NodeParameterValueType>;
+        } | undefined;
+    } | undefined;
+}

package/dist/nodes/Firecrawl/Firecrawl.node.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Firecrawl = void 0;
+const methods_1 = require("./methods");
+const properties_1 = require("./properties");
+class Firecrawl {
+    constructor() {
+        this.description = {
+            displayName: 'Firecrawl',
+            name: 'firecrawl',
+            icon: 'file:firecrawl.svg',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+            description: 'Get data from Firecrawl API',
+            defaults: {
+                name: 'Firecrawl',
+            },
+            inputs: `={{["main"]}}`,
+            outputs: `={{["main"]}}`,
+            credentials: [
+                {
+                    name: 'firecrawlApi',
+                    required: true,
+                },
+            ],
+            requestDefaults: {
+                baseURL: 'https://api.firecrawl.dev/v1',
+                headers: {
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json',
+                },
+            },
+            properties: properties_1.allProperties,
+        };
+        this.methods = methods_1.allMethods;
+    }
+}
+exports.Firecrawl = Firecrawl;
+//# sourceMappingURL=Firecrawl.node.js.map

package/dist/nodes/Firecrawl/Firecrawl.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Firecrawl.node.js","sourceRoot":"","sources":["../../../nodes/Firecrawl/Firecrawl.node.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AACvC,6CAA6C;AAK7C,MAAa,SAAS;IAAtB;QACC,gBAAW,GAAyB;YACnC,WAAW,EAAE,WAAW;YACxB,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,oBAAoB;YAC1B,KAAK,EAAE,CAAC,WAAW,CAAC;YACpB,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,8DAA8D;YACxE,WAAW,EAAE,6BAA6B;YAC1C,QAAQ,EAAE;gBACT,IAAI,EAAE,WAAW;aACjB;YACD,MAAM,EAAE,eAAe;YACvB,OAAO,EAAE,eAAe;YACxB,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,cAAc;oBACpB,QAAQ,EAAE,IAAI;iBACd;aACD;YACD,eAAe,EAAE;gBAChB,OAAO,EAAE,8BAA8B;gBACvC,OAAO,EAAE;oBACR,MAAM,EAAE,kBAAkB;oBAC1B,cAAc,EAAE,kBAAkB;iBAClC;aACD;YACD,UAAU,EAAE,0BAAa;SACzB,CAAC;QAEF,YAAO,GAAG,oBAAU,CAAC;IACtB,CAAC;CAAA;AA/BD,8BA+BC"}

package/dist/nodes/Firecrawl/Firecrawl.node.json

@@ -0,0 +1,18 @@
+{
+    "node": "n8n-nodes-base.Firecrawl",
+    "nodeVersion": "1.0",
+    "codexVersion": "1.0",
+    "categories": ["Miscellaneous", "Development", "Developer Tools"],
+    "resources": {
+        "credentialDocumentation": [
+            {
+                "url": ""
+            }
+        ],
+        "primaryDocumentation": [
+            {
+                "url": ""
+            }
+        ]
+    }
+}

package/dist/nodes/Firecrawl/api/common.d.ts

@@ -0,0 +1,11 @@
+import { INodeProperties, INodePropertyOptions } from 'n8n-workflow';
+export declare function formatOperationName(name: string): string;
+export declare function createOperationNotice(resourceName: string, operationName: string, method?: string): INodeProperties;
+export declare function createUrlProperty(operationName: string, defaultUrl?: string, resourceName?: string): INodeProperties;
+export declare function createActionsProperty(operationName: string, omitDisplayOptions?: boolean, useNestedScrapeOptions?: boolean): INodeProperties;
+export declare function createLocationProperty(operationName: string, omitDisplayOptions?: boolean, useNestedScrapeOptions?: boolean): INodeProperties;
+export declare function createIncludeTagsProperty(operationName: string, omitDisplayOptions?: boolean, useNestedScrapeOptions?: boolean): INodeProperties;
+export declare function createExcludeTagsProperty(operationName: string, omitDisplayOptions?: boolean, useNestedScrapeOptions?: boolean): INodeProperties;
+export declare function createScrapeOptionsProperty(operationName: string, useNestedScrapeOptions?: boolean): INodeProperties;
+export declare function createOperationOption(name: string, action: string): INodePropertyOptions;
+export declare function buildApiProperties(name: string, action: string, properties: INodeProperties[]): import("../helpers").IPropertiesWithOptions;