n8n-nodes-compdf 0.1.0

package/README.md

@@ -0,0 +1,165 @@
+# n8n-nodes-compdf
+
+An **n8n community node** for integrating with the **ComPDF API**, allowing you to upload PDF files for asynchronous processing and query task status directly within n8n workflows.
+
+This node is designed according to the official n8n Community Node guidelines and fully supports n8n binary data storage (`filesystem-v2`) without file corruption.
+
+---
+
+## Features
+
+- ✅ Asynchronous PDF file processing via ComPDF API
+- ✅ Task status polling until completion
+- ✅ Correct handling of n8n binary data (filesystem-v2)
+- ✅ Safe multipart/form-data file uploads
+- ✅ Supports large files
+- ✅ Compatible with n8n Community Nodes Registry
+
+---
+
+## Installation
+
+### Community Nodes (Recommended)
+
+Once the node is available in the n8n Community Nodes registry:
+
+1. Open **n8n**
+2. Go to **Settings → Community Nodes**
+3. Search for **ComPDF**
+4. Install and restart n8n
+
+### Manual Installation
+
+```bash
+npm install n8n-nodes-compdf
+```
+
+Restart n8n after installation.
+
+---
+
+## Credentials
+
+This node requires a **ComPDF API Key**.
+
+### Create Credentials
+
+1. Open **n8n → Credentials**
+2. Create a new credential of type **ComPDF API**
+3. Enter your API Key
+
+The API key is securely stored by n8n and is never logged or exposed.
+
+---
+
+## Nodes
+
+### ComPDF
+
+The ComPDF node supports two operations.
+
+---
+
+### Operation: File Processing (Async)
+
+Uploads a PDF file to the ComPDF API for asynchronous processing.
+
+#### Inputs
+
+- **Binary file**
+  - Common source nodes:
+    - HTTP Request (Download, Response Format: File)
+    - Webhook
+    - Read Binary File
+
+#### Parameters
+
+- **Execute Type URL**  
+  The specific ComPDF processing type appended to the API endpoint.
+
+- **Parameter**  
+  Processing parameters required by the ComPDF API.
+
+- **Language**  
+  Language code used by ComPDF (default: `2`).
+
+- **Binary Property Name**  
+  The name of the binary property containing the file (default: `data`).
+
+#### Output
+
+Returns a JSON response containing a `taskId` for asynchronous processing.
+
+---
+
+### Operation: Get Task Information
+
+Queries the ComPDF API to retrieve the execution status of a previously submitted task.
+
+#### Parameters
+
+- **Task ID**  
+  The task ID returned from the File Processing operation.
+
+- **Max Wait Time (Seconds)**  
+  Maximum time to wait for task completion before timing out (default: `600` seconds).
+
+#### Output
+
+Returns task status information when the task reaches one of the final states:
+- `TaskFinish`
+- `TaskError`
+- `TaskCancel`
+- `Timeout`
+
+---
+
+## Example Workflow
+
+A typical asynchronous PDF processing workflow:
+
+1. **HTTP Request**  
+   - Method: GET  
+   - URL: PDF file URL  
+   - Response Format: File
+
+2. **ComPDF – File Processing (Async)**  
+   - Upload the PDF file to ComPDF
+
+3. **ComPDF – Get Task Information**  
+   - Poll the task status until completion
+
+4. **HTTP Request / Write Binary File**  
+   - Download or store the processed file
+
+---
+
+## Binary File Handling
+
+This node uses n8n’s built-in binary data helpers and correctly supports:
+
+- `filesystem-v2`
+- Large files
+- Multipart uploads without manual base64 conversion
+
+No additional binary configuration is required.
+
+---
+
+## Compatibility
+
+- **n8n**: >= 1.0
+- **Node.js**: >= 20.19
+- **Operating Systems**: Windows, macOS, Linux
+
+---
+
+## License
+
+MIT
+
+---
+
+## Support
+
+For bug reports or feature requests, please open an issue in the project repository.

package/dist/credentials/CompdfApi.credentials.d.ts

@@ -0,0 +1,6 @@
+import { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class CompdfApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/CompdfApi.credentials.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompdfApi = void 0;
+class CompdfApi {
+    constructor() {
+        this.name = 'compdfApi';
+        this.displayName = 'ComPDF API';
+        this.properties = [
+            {
+                displayName: 'Public API Key',
+                name: 'apiKey',
+                type: 'string',
+                default: '',
+                required: true,
+            },
+        ];
+    }
+}
+exports.CompdfApi = CompdfApi;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { Compdf } from './nodes/Compdf/Compdf.node';
+import { CompdfApi } from './credentials/CompdfApi.credentials';
+export declare const nodes: (typeof Compdf)[];
+export declare const credentials: (typeof CompdfApi)[];

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.credentials = exports.nodes = void 0;
+const Compdf_node_1 = require("./nodes/Compdf/Compdf.node");
+const CompdfApi_credentials_1 = require("./credentials/CompdfApi.credentials");
+exports.nodes = [
+    Compdf_node_1.Compdf,
+];
+exports.credentials = [
+    CompdfApi_credentials_1.CompdfApi,
+];

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

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

package/dist/nodes/Compdf/Compdf.node.js

@@ -0,0 +1,180 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Compdf = void 0;
+const form_data_1 = __importDefault(require("form-data"));
+class Compdf {
+    constructor() {
+        this.description = {
+            displayName: 'ComPDF API Integration',
+            name: 'ComPDF API Integration',
+            icon: 'file:compdf.svg',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter.operation}}',
+            description: 'Integrates with the ComPDF API to automate PDF processing tasks such as generation, editing, annotations, conversion, merging, and intelligent document extraction and parsing.',
+            defaults: {
+                name: 'ComPDF API Integration',
+            },
+            inputs: ['main'],
+            outputs: ['main'],
+            credentials: [
+                {
+                    name: 'compdfApi',
+                    required: true,
+                },
+            ],
+            properties: [
+                {
+                    displayName: 'Operation',
+                    name: 'operation',
+                    type: 'options',
+                    options: [
+                        {
+                            name: 'File Processing (Async)',
+                            value: 'fileProcessing',
+                        },
+                        {
+                            name: 'Get Task Information',
+                            value: 'getTaskInfo',
+                        },
+                    ],
+                    default: 'fileProcessing',
+                },
+                {
+                    displayName: 'Execute Type URL',
+                    name: 'executeTypeUrl',
+                    type: 'string',
+                    required: true,
+                    displayOptions: {
+                        show: {
+                            operation: ['fileProcessing'],
+                        },
+                    },
+                    default: '',
+                },
+                {
+                    displayName: 'Binary Property',
+                    name: 'binaryPropertyName',
+                    type: 'string',
+                    default: 'data',
+                    description: 'Binary property name that contains the file',
+                    displayOptions: {
+                        show: {
+                            operation: ['fileProcessing'],
+                        },
+                    },
+                },
+                {
+                    displayName: 'Parameter',
+                    name: 'parameter',
+                    type: 'string',
+                    required: true,
+                    displayOptions: {
+                        show: {
+                            operation: ['fileProcessing'],
+                        },
+                    },
+                    default: '',
+                },
+                {
+                    displayName: 'Language',
+                    name: 'language',
+                    type: 'string',
+                    default: '2',
+                    displayOptions: {
+                        show: {
+                            operation: ['fileProcessing'],
+                        },
+                    },
+                },
+                {
+                    displayName: 'Task ID',
+                    name: 'taskId',
+                    type: 'string',
+                    required: true,
+                    displayOptions: {
+                        show: {
+                            operation: ['getTaskInfo'],
+                        },
+                    },
+                    default: '',
+                },
+                {
+                    displayName: 'Max Wait Time (Seconds)',
+                    name: 'maxWaitTime',
+                    type: 'string',
+                    displayOptions: {
+                        show: {
+                            operation: ['getTaskInfo'],
+                        },
+                    },
+                    default: '600',
+                },
+            ],
+        };
+    }
+    async execute() {
+        var _a, _b, _c;
+        const operation = this.getNodeParameter('operation', 0);
+        const credentials = await this.getCredentials('compdfApi');
+        const apiKey = credentials.apiKey;
+        if (operation === 'fileProcessing') {
+            const binaryPropertyName = this.getNodeParameter('binaryPropertyName', 0);
+            const binaryData = this.helpers.assertBinaryData(0, binaryPropertyName);
+            const fileBuffer = await this.helpers.getBinaryDataBuffer(0, binaryPropertyName);
+            const form = new form_data_1.default();
+            form.append('file', fileBuffer, {
+                filename: (_a = binaryData.fileName) !== null && _a !== void 0 ? _a : 'input.pdf',
+                contentType: (_b = binaryData.mimeType) !== null && _b !== void 0 ? _b : 'application/octet-stream',
+            });
+            form.append('parameter', this.getNodeParameter('parameter', 0));
+            form.append('language', this.getNodeParameter('language', 0));
+            const executeTypeUrl = this.getNodeParameter('executeTypeUrl', 0);
+            const response = await this.helpers.httpRequest({
+                method: 'POST',
+                url: `https://api-server.compdf.com/server/v2/processAsync/${executeTypeUrl}`,
+                headers: {
+                    'x-api-key': apiKey,
+                    ...form.getHeaders(),
+                },
+                body: form,
+                encoding: null,
+            });
+            return [[{ json: response }]];
+        }
+        if (operation === 'getTaskInfo') {
+            const taskId = this.getNodeParameter('taskId', 0);
+            const maxWaitTime = this.getNodeParameter('maxWaitTime', 0);
+            const startTime = Date.now();
+            while (true) {
+                const res = await this.helpers.httpRequest({
+                    method: 'GET',
+                    url: 'https://api-server.compdf.com/server/v2/task/taskInfo',
+                    headers: {
+                        'x-api-key': apiKey,
+                    },
+                    qs: { taskId },
+                });
+                const status = (_c = res === null || res === void 0 ? void 0 : res.data) === null || _c === void 0 ? void 0 : _c.taskStatus;
+                if (status === 'TaskFinish') {
+                    return [[{ json: res.data }]];
+                }
+                if ((Date.now() - startTime) / 1000 > maxWaitTime) {
+                    return [[{
+                                json: {
+                                    taskId,
+                                    finalStatus: 'Timeout',
+                                    waitedSeconds: Math.floor((Date.now() - startTime) / 1000),
+                                },
+                            }]];
+                }
+                await new Promise((resolve) => setTimeout(resolve, 5000));
+            }
+        }
+        return [[]];
+    }
+}
+exports.Compdf = Compdf;

package/dist/nodes/Compdf/compdf.svg

@@ -0,0 +1,14 @@
+<svg width="230" height="230" viewBox="0 0 230 230" fill="none" xmlns="http://www.w3.org/2000/svg">
+<mask id="mask0_1_4476" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="230" height="230">
+<path d="M0 6.10352e-05H229.333V229.333H0V6.10352e-05Z" fill="white"/>
+</mask>
+<g mask="url(#mask0_1_4476)">
+<path d="M161.946 78.867C167.349 78.867 171.729 83.263 171.729 88.6843V162.319C171.729 167.74 167.349 172.136 161.946 172.136H93.4731C88.0704 172.136 83.6904 167.74 83.6904 162.319V150.864H145.644V127.956H119.558C112.354 127.956 106.516 122.095 106.516 114.866C106.516 107.636 112.354 101.775 119.558 101.775H145.644V78.867H161.946Z" fill="#03C29F"/>
+</g>
+<mask id="mask1_1_4476" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="230" height="230">
+<path d="M0 -3.05176e-05H229.333V229.333H0V-3.05176e-05Z" fill="white"/>
+</mask>
+<g mask="url(#mask1_1_4476)">
+<path d="M135.861 57.5949H67.3863C61.985 57.5949 57.605 61.9909 57.605 67.4123V141.047C57.605 146.47 61.985 150.864 67.3863 150.864H119.557C99.749 150.864 83.6903 134.747 83.6903 114.866C83.6903 94.9843 99.749 78.8669 119.557 78.8669H145.642V67.4123C145.642 61.9909 141.264 57.5949 135.861 57.5949Z" fill="#0471F3"/>
+</g>
+</svg>

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "n8n-nodes-compdf",
+  "version": "0.1.0",
+  "description": "n8n community node for ComPDF API",
+  "author": "ComPDF",
+  "license": "MIT",
+  "keywords": [
+    "n8n-community-node-package",
+    "n8n",
+    "compdf",
+    "pdf"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ]
+}