@pagecrawl/n8n-nodes-pagecrawl 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 PageCrawl.io
+
+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,227 @@
+# n8n-nodes-pagecrawl
+
+This is an n8n community node that provides integration with [PageCrawl.io](https://pagecrawl.io) for website monitoring and change detection.
+
+## Installation
+
+### Community Node (Recommended)
+
+You can install this node directly in n8n:
+
+1. Go to **Settings** > **Community Nodes**
+2. Search for `n8n-nodes-pagecrawl`
+3. Click **Install**
+
+### Manual Installation
+
+```bash
+npm install n8n-nodes-pagecrawl
+```
+
+### Local Development
+
+For development and testing:
+
+```bash
+# Clone the repository
+git clone https://github.com/pagecrawl/n8n-nodes-pagecrawl.git
+cd n8n-nodes-pagecrawl
+
+# Install dependencies
+npm install
+
+# Build the node
+npm run build
+
+# Run n8n with the node
+npm run dev
+```
+
+## Authentication
+
+To use this node, you'll need a PageCrawl.io API token.
+
+> **Note:** API access requires a paid PageCrawl.io plan. Free accounts do not have API access.
+
+1. Sign up or log in to [PageCrawl.io](https://pagecrawl.io)
+2. Upgrade to a paid plan if you haven't already
+3. Go to **Settings > API**
+4. Copy your API token
+5. In n8n, create new PageCrawl credentials and paste your token
+
+## Available Nodes
+
+### PageCrawl Node
+
+The main node for interacting with PageCrawl.io API, supporting the following resources:
+
+#### Page Operations
+- **List All Pages** - Get all tracked pages
+- **Get Page** - Get specific page configuration
+- **Create Page** - Create new tracked page with full configuration
+- **Create Simple Page** - Quick page creation with minimal options
+- **Update Page** - Update existing page configuration
+- **Delete Page** - Remove a tracked page
+- **Run Check Now** - Trigger an immediate check for a page
+
+#### Check Operations (History)
+- **Get History** - Retrieve check history for a page
+- **Get Text Diff HTML** - Get text differences as HTML
+- **Get Text Diff Image** - Get text differences as an image
+- **Get Text Diff Markdown** - Get text differences as Markdown
+
+#### Screenshot Operations
+- **Get Latest Screenshot** - Get the most recent full-page screenshot
+- **Get Latest Screenshot Diff** - Visual diff of latest vs previous
+- **Get Check Screenshot** - Screenshot for specific check
+- **Get Check Screenshot Diff** - Visual diff for specific check
+
+#### Webhook Operations
+- **List Webhooks** - Get all configured webhooks
+- **Create Webhook** - Set up a new webhook
+- **Update Webhook** - Modify webhook configuration
+- **Delete Webhook** - Remove a webhook
+- **Test Webhook** - Send test notification
+
+### PageCrawl Trigger Node
+
+Webhook trigger node that receives real-time notifications when changes are detected.
+
+Features:
+- Automatic webhook registration/deregistration
+- Configurable payload fields
+- Event filtering (changes, errors)
+- Simplified output option
+
+## Example Workflows
+
+### 1. Monitor Website and Send Email on Change
+
+```
+[PageCrawl Trigger] → [Gmail Send Email]
+```
+
+Configure the trigger to monitor specific pages and send notifications via email when changes are detected.
+
+### 2. Track Price Changes
+
+```
+[Schedule Trigger] → [PageCrawl Get Page] → [IF Price Changed] → [Slack Message]
+```
+
+Periodically check product prices and notify via Slack when they change.
+
+### 3. Archive Website Screenshots
+
+```
+[Schedule Trigger] → [PageCrawl Get Screenshot] → [Google Drive Upload]
+```
+
+Automatically save website screenshots to Google Drive for compliance or archival.
+
+### 4. Sync Changes to Database
+
+```
+[PageCrawl Trigger] → [MySQL Insert]
+```
+
+Store all detected changes in a database for analysis and reporting.
+
+## Configuration Options
+
+### Page Tracking Configuration
+
+- **URL**: The webpage to monitor
+- **Elements**: Specific page elements to track (CSS/XPath selectors)
+- **Frequency**: How often to check (3 minutes to weekly)
+- **Location**: Server location for checks (US, UK, CA, DE)
+- **Authentication**: HTTP Basic auth support
+- **Actions**: Pre-check actions (scroll, click, wait, etc.)
+- **Rules**: Conditional notifications based on content
+
+### Notification Settings
+
+- **Channels**: Email, Slack, Discord, Teams, Telegram
+- **Rules**: Text difference, content contains, number comparisons
+- **Advanced**: Headers, proxies, user agent customization
+
+## API Rate Limits
+
+- Default: 60 requests per minute
+- Contact support for higher limits
+- Rate limit errors return HTTP 429
+
+## Common Use Cases
+
+1. **E-commerce Price Monitoring** - Track competitor prices and stock levels
+2. **Content Updates** - Monitor news sites, blogs, or documentation
+3. **Compliance Monitoring** - Ensure website content meets requirements
+4. **SEO Tracking** - Monitor meta tags, titles, and content changes
+5. **Security Monitoring** - Detect unauthorized website changes
+6. **Data Extraction** - Regular scraping of structured data
+
+## Error Handling
+
+The node includes comprehensive error handling:
+- Validation errors (HTTP 422) with detailed messages
+- Rate limiting (HTTP 429) with retry guidance
+- Authentication errors with clear instructions
+- Network errors with appropriate retry logic
+
+## Support
+
+- **Documentation**: [PageCrawl.io Docs](https://pagecrawl.io/docs)
+- **API Reference**: [API Documentation](https://pagecrawl.io/docs/api)
+- **Issues**: [GitHub Issues](https://github.com/pagecrawl/n8n-nodes-pagecrawl/issues)
+- **Support**: support@pagecrawl.io
+
+## License
+
+MIT - See LICENSE file for details
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Open a Pull Request
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+# Run linter
+npm run lint
+
+# Fix linting issues
+npm run lint:fix
+
+# Test in n8n
+npm run dev
+```
+
+### Publishing
+
+```bash
+npm version patch
+npm publish
+```
+
+## Changelog
+
+### 0.1.0
+- Initial release
+- Full API coverage for Pages, Checks, Screenshots, and Webhooks
+- Trigger node for real-time notifications
+- Comprehensive error handling
+- TypeScript implementation

package/dist/credentials/PageCrawlApi.credentials.d.ts

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

package/dist/credentials/PageCrawlApi.credentials.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageCrawlApi = void 0;
+class PageCrawlApi {
+    constructor() {
+        this.name = 'pageCrawlApi';
+        this.displayName = 'PageCrawl.io API';
+        this.documentationUrl = 'https://pagecrawl.io/docs/api';
+        this.properties = [
+            {
+                displayName: 'API Token',
+                name: 'apiToken',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+                description: 'Your PageCrawl.io API token. API access requires a paid plan. You can find your token in Settings > API.',
+            },
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: 'https://pagecrawl.io',
+                description: 'The base URL for the PageCrawl.io API',
+                hint: 'Use https://pagecrawl.io for production',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Bearer {{$credentials.apiToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.baseUrl}}',
+                url: '/api/user',
+                method: 'GET',
+            },
+            rules: [
+                {
+                    type: 'responseSuccessBody',
+                    properties: {
+                        key: 'id',
+                        value: undefined,
+                        message: 'Authentication successful',
+                    },
+                },
+            ],
+        };
+    }
+}
+exports.PageCrawlApi = PageCrawlApi;

package/dist/icons/pagecrawl.svg

@@ -0,0 +1,24 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 60 60" width="60" height="60">
+  <!-- Background circle -->
+  <circle cx="30" cy="30" r="28" fill="#2955c3" stroke="#1e3d8f" stroke-width="2"/>
+
+  <!-- Page icon -->
+  <g transform="translate(15, 12)">
+    <!-- Page background -->
+    <rect x="0" y="0" width="22" height="28" rx="2" fill="white"/>
+
+    <!-- Page lines representing content -->
+    <rect x="4" y="6" width="14" height="2" rx="1" fill="#2955c3"/>
+    <rect x="4" y="11" width="14" height="2" rx="1" fill="#2955c3"/>
+    <rect x="4" y="16" width="10" height="2" rx="1" fill="#2955c3"/>
+
+    <!-- Change indicator (dot) -->
+    <circle cx="16" cy="22" r="3" fill="#4ade80"/>
+  </g>
+
+  <!-- Magnifying glass for monitoring -->
+  <g transform="translate(30, 30)">
+    <circle cx="0" cy="0" r="7" fill="none" stroke="white" stroke-width="2.5"/>
+    <line x1="5" y1="5" x2="10" y2="10" stroke="white" stroke-width="2.5" stroke-linecap="round"/>
+  </g>
+</svg>

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

@@ -0,0 +1,5 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class PageCrawl implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}