@pagecrawl/n8n-nodes-pagecrawl 0.1.0

package/dist/nodes/PageCrawl/descriptions/ScreenshotDescription.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.screenshotFields = exports.screenshotOperations = void 0;
+exports.screenshotOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['screenshot'],
+            },
+        },
+        options: [
+            {
+                name: 'Get Check Screenshot',
+                value: 'getCheckScreenshot',
+                description: 'Get screenshot for a specific check',
+                action: 'Get check screenshot',
+            },
+            {
+                name: 'Get Check Screenshot Diff',
+                value: 'getCheckDiff',
+                description: 'Get screenshot diff for a specific check',
+                action: 'Get check screenshot diff',
+            },
+            {
+                name: 'Get Latest Screenshot',
+                value: 'getLatest',
+                description: 'Get latest full-page screenshot',
+                action: 'Get latest screenshot',
+            },
+            {
+                name: 'Get Latest Screenshot Diff',
+                value: 'getLatestDiff',
+                description: 'Get latest screenshot diff',
+                action: 'Get latest screenshot diff',
+            },
+        ],
+        default: 'getLatest',
+    },
+];
+exports.screenshotFields = [
+    // ========================================
+    // screenshot:all
+    // ========================================
+    {
+        displayName: 'Page ID',
+        name: 'pageId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['screenshot'],
+            },
+        },
+        default: '',
+        description: 'The ID or slug of the page',
+    },
+    // ========================================
+    // screenshot:getCheckScreenshot, getCheckDiff
+    // ========================================
+    {
+        displayName: 'Check ID',
+        name: 'checkId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['screenshot'],
+                operation: ['getCheckScreenshot', 'getCheckDiff'],
+            },
+        },
+        default: '',
+        description: 'The check ID (use "latest" for most recent)',
+    },
+];

package/dist/nodes/PageCrawl/descriptions/WebhookDescription.d.ts

@@ -0,0 +1,3 @@
+import { INodeProperties } from 'n8n-workflow';
+export declare const webhookOperations: INodeProperties[];
+export declare const webhookFields: INodeProperties[];

package/dist/nodes/PageCrawl/descriptions/WebhookDescription.js

@@ -0,0 +1,203 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webhookFields = exports.webhookOperations = void 0;
+const types_1 = require("../types");
+exports.webhookOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['webhook'],
+            },
+        },
+        options: [
+            {
+                name: 'Create',
+                value: 'create',
+                description: 'Create a new webhook',
+                action: 'Create a webhook',
+            },
+            {
+                name: 'Delete',
+                value: 'delete',
+                description: 'Delete a webhook',
+                action: 'Delete a webhook',
+            },
+            {
+                name: 'Get Many',
+                value: 'getAll',
+                description: 'Get all webhooks',
+                action: 'Get many webhooks',
+            },
+            {
+                name: 'Test',
+                value: 'test',
+                description: 'Test a webhook',
+                action: 'Test a webhook',
+            },
+            {
+                name: 'Update',
+                value: 'update',
+                description: 'Update a webhook',
+                action: 'Update a webhook',
+            },
+        ],
+        default: 'getAll',
+    },
+];
+exports.webhookFields = [
+    // ========================================
+    // webhook:getAll
+    // ========================================
+    {
+        displayName: 'Return All',
+        name: 'returnAll',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['webhook'],
+                operation: ['getAll'],
+            },
+        },
+        default: true,
+        description: 'Whether to return all results or only up to a given limit',
+    },
+    {
+        displayName: 'Limit',
+        name: 'limit',
+        type: 'number',
+        displayOptions: {
+            show: {
+                resource: ['webhook'],
+                operation: ['getAll'],
+                returnAll: [false],
+            },
+        },
+        typeOptions: {
+            minValue: 1,
+        },
+        default: 50,
+        description: 'Max number of results to return',
+    },
+    // ========================================
+    // webhook:create
+    // ========================================
+    {
+        displayName: 'Target URL',
+        name: 'target_url',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['webhook'],
+                operation: ['create'],
+            },
+        },
+        default: '',
+        placeholder: 'https://example.com/webhook',
+        description: 'The URL where webhook data will be sent',
+    },
+    {
+        displayName: 'Additional Fields',
+        name: 'additionalFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: {
+            show: {
+                resource: ['webhook'],
+                operation: ['create'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Page ID',
+                name: 'change_id',
+                type: 'string',
+                default: '',
+                description: 'Specific page ID to track (leave empty for all pages)',
+            },
+            {
+                displayName: 'Payload Fields',
+                name: 'payload_fields',
+                type: 'multiOptions',
+                options: types_1.WEBHOOK_PAYLOAD_FIELDS.map((field) => ({
+                    name: field.replace(/_/g, ' ').replace(/\b\w/g, (l) => l.toUpperCase()),
+                    value: field,
+                })),
+                default: [],
+                description: 'Fields to include in webhook payload (all if empty)',
+            },
+        ],
+    },
+    // ========================================
+    // webhook:update, delete, test
+    // ========================================
+    {
+        displayName: 'Webhook ID',
+        name: 'webhookId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['webhook'],
+                operation: ['update', 'delete', 'test'],
+            },
+        },
+        default: '',
+        description: 'The ID of the webhook',
+    },
+    // ========================================
+    // webhook:update
+    // ========================================
+    {
+        displayName: 'Update Fields',
+        name: 'updateFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: {
+            show: {
+                resource: ['webhook'],
+                operation: ['update'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Active',
+                name: 'is_active',
+                type: 'boolean',
+                default: true,
+                description: 'Whether the webhook is active',
+            },
+            {
+                displayName: 'Page ID',
+                name: 'change_id',
+                type: 'string',
+                default: '',
+                description: 'Specific page ID to track',
+            },
+            {
+                displayName: 'Payload Fields',
+                name: 'payload_fields',
+                type: 'multiOptions',
+                options: types_1.WEBHOOK_PAYLOAD_FIELDS.map((field) => ({
+                    name: field.replace(/_/g, ' ').replace(/\b\w/g, (l) => l.toUpperCase()),
+                    value: field,
+                })),
+                default: [],
+                description: 'Fields to include in webhook payload',
+            },
+            {
+                displayName: 'Target URL',
+                name: 'target_url',
+                type: 'string',
+                default: '',
+                description: 'The URL where webhook data will be sent',
+            },
+        ],
+    },
+];

package/dist/nodes/PageCrawl/pagecrawl.svg

@@ -0,0 +1,18 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64">
+  <!-- Background circle with outline -->
+  <circle cx="32" cy="32" r="28" fill="#2955c3" stroke="#1e3d8f" stroke-width="2"/>
+
+  <!-- PageCrawl logo paths (centered with more padding) -->
+  <g transform="translate(32, 32) scale(0.015, -0.015) translate(-1400, -1400)" fill="white" stroke="none">
+    <path d="M1290 2574 c-553 -67 -1049 -128 -1102 -134 -54 -7 -99 -17 -101 -24
+    -3 -6 8 -115 24 -241 16 -127 29 -236 29 -242 0 -14 28 -17 47 -5 9 5 5 59
+    -14 220 -15 117 -23 215 -19 219 6 6 2049 262 2096 263 13 0 20 -35 39 -192
+    31 -257 29 -248 57 -248 20 0 24 5 24 30 0 69 -53 456 -63 466 -9 8 -278 -21
+    -1017 -112z"/>
+    <path d="M2568 943 c-12 -3 -15 -12 -12 -36 25 -163 49 -409 40 -412 -29 -10
+    -2087 -257 -2099 -252 -9 3 -20 66 -36 203 -12 110 -25 207 -27 217 -3 10 -15
+    17 -30 17 -18 0 -24 -5 -24 -22 -1 -59 54 -464 64 -475 9 -9 257 18 1105 122
+    601 74 1097 135 1101 135 4 0 10 7 14 15 6 16 -49 469 -59 485 -6 10 -9 11
+    -37 3z"/>
+  </g>
+</svg>

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

@@ -0,0 +1,98 @@
+export interface IPageElement {
+    type: 'text' | 'number' | 'fullpage';
+    selector: string;
+    label: string;
+}
+export interface INotificationRule {
+    type: 'text_difference' | 'added' | 'removed' | 'contains' | 'ncontains' | 'eq' | 'neq' | 'increased' | 'decreased' | 'is' | 'gt' | 'lt' | 'gte' | 'lte';
+    value: string | number;
+    element?: number;
+}
+export interface IPageAction {
+    type: 'scroll_to_bottom' | 'remove_dates' | 'remove_cookies' | 'remove_cookies_v2' | 'click' | 'hover' | 'type' | 'select' | 'remove_element' | 'wait_element' | 'wait' | 'javascript' | 'back';
+    selector?: string;
+    value?: string | number;
+}
+export interface IPage {
+    id: number;
+    name: string;
+    slug: string;
+    url: string;
+    url_tld: string;
+    created_at: string | null;
+    last_checked_at: string | null;
+    status: string;
+    failed: number;
+    disabled?: boolean;
+    frequency?: number;
+    location?: string;
+    folder_id?: number;
+    template_id?: number;
+    auth_id?: number;
+    skip_first_notification?: boolean;
+    notifications?: string[];
+    notification_emails?: string;
+    fail_silently?: number;
+    check_always?: boolean;
+    advanced?: boolean;
+    auth_username?: string;
+    auth_password?: string;
+    user_agent?: string;
+    proxies?: string;
+    headers?: any;
+    rules_enabled?: boolean;
+    rules_and?: boolean;
+    rules?: INotificationRule[];
+    actions?: IPageAction[];
+    elements?: IPageElement[];
+    tags?: string[];
+    latest?: {
+        numeric: boolean;
+        contents: string | null;
+        changed_at: string | null;
+        difference: number | null;
+        human_difference: string | null;
+        three_month_difference: number | null;
+        three_month_human_difference: string | null;
+    };
+}
+export interface ICheck {
+    id: number;
+    status: string;
+    seen: string | null;
+    created_at: string;
+    content_type: string | null;
+    visual_diff: number | null;
+    elements: ICheckElement[];
+}
+export interface ICheckElement {
+    id: number;
+    contents: string | null;
+    difference: number | null;
+    hash: string;
+    changed: boolean;
+    original: string | null;
+    elements: number;
+}
+export interface IWebhook {
+    id?: number;
+    change_id?: number;
+    target_url: string;
+    event_type?: string;
+    payload_fields?: string[];
+    is_active?: boolean;
+    failures?: number;
+}
+export declare const FREQUENCIES: {
+    value: number;
+    label: string;
+}[];
+export declare const LOCATIONS: {
+    value: string;
+    label: string;
+}[];
+export declare const NOTIFICATION_CHANNELS: {
+    value: string;
+    label: string;
+}[];
+export declare const WEBHOOK_PAYLOAD_FIELDS: string[];

package/dist/nodes/PageCrawl/types.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WEBHOOK_PAYLOAD_FIELDS = exports.NOTIFICATION_CHANNELS = exports.LOCATIONS = exports.FREQUENCIES = void 0;
+exports.FREQUENCIES = [
+    { value: 3, label: 'Every 3 minutes' },
+    { value: 5, label: 'Every 5 minutes' },
+    { value: 10, label: 'Every 10 minutes' },
+    { value: 15, label: 'Every 15 minutes' },
+    { value: 30, label: 'Every 30 minutes' },
+    { value: 60, label: 'Hourly' },
+    { value: 180, label: 'Every 3 hours' },
+    { value: 360, label: 'Every 6 hours' },
+    { value: 720, label: 'Every 12 hours' },
+    { value: 1440, label: 'Daily' },
+    { value: 2880, label: 'Every 2 days' },
+    { value: 10080, label: 'Weekly' },
+];
+exports.LOCATIONS = [
+    { value: 'random1', label: 'Random Proxy' },
+    { value: 'lon1', label: 'London, UK' },
+    { value: 'tor1', label: 'Toronto, CA' },
+    { value: 'ny1', label: 'New York, US' },
+    { value: 'fra1', label: 'Frankfurt, DE' },
+];
+exports.NOTIFICATION_CHANNELS = [
+    { value: 'mail', label: 'Email' },
+    { value: 'slack', label: 'Slack' },
+    { value: 'discord', label: 'Discord' },
+    { value: 'teams', label: 'Microsoft Teams' },
+    { value: 'telegram', label: 'Telegram' },
+];
+exports.WEBHOOK_PAYLOAD_FIELDS = [
+    'id',
+    'title',
+    'status',
+    'content_type',
+    'visual_diff',
+    'changed_at',
+    'contents',
+    'elements',
+    'original',
+    'difference',
+    'human_difference',
+    'page_screenshot_image',
+    'text_difference_image',
+    'html_difference',
+    'markdown_difference',
+    'page',
+    'page_elements',
+    'json',
+    'json_patch',
+    'previous_check',
+];

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

@@ -0,0 +1,12 @@
+import { IHookFunctions, IWebhookFunctions, INodeType, INodeTypeDescription, IWebhookResponseData } from 'n8n-workflow';
+export declare class PageCrawlTrigger implements INodeType {
+    description: INodeTypeDescription;
+    webhookMethods: {
+        default: {
+            checkExists(this: IHookFunctions): Promise<boolean>;
+            create(this: IHookFunctions): Promise<boolean>;
+            delete(this: IHookFunctions): Promise<boolean>;
+        };
+    };
+    webhook(this: IWebhookFunctions): Promise<IWebhookResponseData>;
+}

package/dist/nodes/PageCrawlTrigger/PageCrawlTrigger.node.js

@@ -0,0 +1,221 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageCrawlTrigger = void 0;
+const types_1 = require("../PageCrawl/types");
+class PageCrawlTrigger {
+    constructor() {
+        this.description = {
+            displayName: 'PageCrawl Trigger',
+            name: 'pageCrawlTrigger',
+            icon: 'file:pagecrawl.svg',
+            group: ['trigger'],
+            version: 1,
+            subtitle: '=Monitor: {{$parameter["event"]}}',
+            description: 'Receive notifications when PageCrawl.io detects changes',
+            defaults: {
+                name: 'PageCrawl Trigger',
+            },
+            inputs: [],
+            outputs: ['main'],
+            credentials: [
+                {
+                    name: 'pageCrawlApi',
+                    required: true,
+                },
+            ],
+            webhooks: [
+                {
+                    name: 'default',
+                    httpMethod: 'POST',
+                    responseMode: 'onReceived',
+                    path: 'pagecrawl',
+                },
+            ],
+            properties: [
+                {
+                    displayName: 'Events',
+                    name: 'events',
+                    type: 'multiOptions',
+                    options: [
+                        {
+                            name: 'Change Detected',
+                            value: 'change',
+                            description: 'Trigger when any change is detected',
+                        },
+                        {
+                            name: 'Error',
+                            value: 'error',
+                            description: 'Trigger when page check fails',
+                        },
+                    ],
+                    default: ['change'],
+                    required: true,
+                    description: 'The events to listen for',
+                },
+                {
+                    displayName: 'Page',
+                    name: 'pageId',
+                    type: 'string',
+                    default: '',
+                    description: 'Specific page ID to monitor (leave empty for all pages)',
+                },
+                {
+                    displayName: 'Payload Fields',
+                    name: 'payloadFields',
+                    type: 'multiOptions',
+                    options: types_1.WEBHOOK_PAYLOAD_FIELDS.map((field) => ({
+                        name: field.replace(/_/g, ' ').replace(/\b\w/g, (l) => l.toUpperCase()),
+                        value: field,
+                    })),
+                    default: ['id', 'title', 'status', 'changed_at', 'difference', 'page'],
+                    description: 'Fields to include in the webhook payload',
+                },
+                {
+                    displayName: 'Options',
+                    name: 'options',
+                    type: 'collection',
+                    placeholder: 'Add Option',
+                    default: {},
+                    options: [
+                        {
+                            displayName: 'Simplify Output',
+                            name: 'simplify',
+                            type: 'boolean',
+                            default: true,
+                            description: 'Whether to return simplified output format',
+                        },
+                    ],
+                },
+            ],
+        };
+        this.webhookMethods = {
+            default: {
+                async checkExists() {
+                    const webhookData = this.getWorkflowStaticData('node');
+                    const webhookUrl = this.getNodeWebhookUrl('default');
+                    const credentials = await this.getCredentials('pageCrawlApi');
+                    const baseUrl = (credentials.baseUrl || 'https://pagecrawl.io').replace(/\/+$/, '');
+                    if (!webhookData.webhookId) {
+                        return false;
+                    }
+                    try {
+                        const response = await this.helpers.requestWithAuthentication.call(this, 'pageCrawlApi', {
+                            method: 'GET',
+                            url: `${baseUrl}/api/hooks`,
+                            json: true,
+                        });
+                        const existingWebhook = response.find((webhook) => webhook.id === webhookData.webhookId);
+                        if (!existingWebhook || existingWebhook.target_url !== webhookUrl) {
+                            return false;
+                        }
+                        return true;
+                    }
+                    catch (error) {
+                        return false;
+                    }
+                },
+                async create() {
+                    const webhookUrl = this.getNodeWebhookUrl('default');
+                    const webhookData = this.getWorkflowStaticData('node');
+                    const pageId = this.getNodeParameter('pageId', '');
+                    const payloadFields = this.getNodeParameter('payloadFields', []);
+                    const credentials = await this.getCredentials('pageCrawlApi');
+                    const baseUrl = (credentials.baseUrl || 'https://pagecrawl.io').replace(/\/+$/, '');
+                    const body = {
+                        target_url: webhookUrl,
+                        event_type: 'n8n',
+                    };
+                    if (pageId) {
+                        body.change_id = pageId;
+                    }
+                    if (payloadFields.length > 0) {
+                        body.payload_fields = payloadFields;
+                    }
+                    try {
+                        const response = await this.helpers.requestWithAuthentication.call(this, 'pageCrawlApi', {
+                            method: 'POST',
+                            url: `${baseUrl}/api/hooks`,
+                            body,
+                            json: true,
+                        });
+                        if (!response.id) {
+                            throw new Error('Failed to create webhook');
+                        }
+                        webhookData.webhookId = response.id;
+                        return true;
+                    }
+                    catch (error) {
+                        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                        throw new Error(`Failed to create PageCrawl webhook: ${errorMessage}`);
+                    }
+                },
+                async delete() {
+                    const webhookData = this.getWorkflowStaticData('node');
+                    const credentials = await this.getCredentials('pageCrawlApi');
+                    const baseUrl = (credentials.baseUrl || 'https://pagecrawl.io').replace(/\/+$/, '');
+                    if (!webhookData.webhookId) {
+                        return true;
+                    }
+                    try {
+                        await this.helpers.requestWithAuthentication.call(this, 'pageCrawlApi', {
+                            method: 'DELETE',
+                            url: `${baseUrl}/api/hooks/${webhookData.webhookId}`,
+                            json: true,
+                        });
+                    }
+                    catch (error) {
+                        // If webhook is already deleted, consider it a success
+                        if (error.statusCode !== 404) {
+                            const errorMessage = error.response?.body?.message || error.message || 'Unknown error';
+                            throw new Error(`Failed to delete PageCrawl webhook: ${errorMessage}`);
+                        }
+                    }
+                    finally {
+                        // Always clean up the webhook ID, even if deletion failed
+                        delete webhookData.webhookId;
+                    }
+                    return true;
+                },
+            },
+        };
+    }
+    async webhook() {
+        const req = this.getRequestObject();
+        const events = this.getNodeParameter('events', []);
+        const options = this.getNodeParameter('options', {});
+        const webhookData = req.body;
+        // Filter based on event type
+        if (webhookData.status === 'error' && !events.includes('error')) {
+            // Skip error events if not subscribed
+            return {
+                workflowData: [],
+            };
+        }
+        if (webhookData.status !== 'error' && !events.includes('change')) {
+            // Skip change events if not subscribed
+            return {
+                workflowData: [],
+            };
+        }
+        // Simplify output if requested
+        let responseData = webhookData;
+        if (options.simplify) {
+            responseData = {
+                id: webhookData.id,
+                title: webhookData.title,
+                status: webhookData.status,
+                changedAt: webhookData.changed_at,
+                difference: webhookData.difference,
+                humanDifference: webhookData.human_difference,
+                pageUrl: webhookData.page ? webhookData.page.url : undefined,
+                pageName: webhookData.page ? webhookData.page.name : undefined,
+                pageLink: webhookData.page ? webhookData.page.link : undefined,
+                contents: webhookData.contents,
+            };
+        }
+        return {
+            workflowData: [this.helpers.returnJsonArray(responseData)],
+        };
+    }
+}
+exports.PageCrawlTrigger = PageCrawlTrigger;