n8n-nodes-make-pdf 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Frank Schelhorn
+
+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,98 @@
+# n8n-nodes-make-pdf
+
+This is an n8n community node that allows you to generate PDF files from HTML using [Gotenberg](https://gotenberg.dev/).
+
+[n8n](https://n8n.io/) is a fair-code licensed workflow automation platform.
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+### Community Nodes (Recommended)
+
+1. Go to **Settings > Community Nodes**
+2. Select **Install**
+3. Enter `n8n-nodes-make-pdf` in **Enter npm package name**
+4. Agree to the risks of using community nodes
+5. Select **Install**
+
+### Manual Installation
+
+To get started install the package in your n8n root directory:
+
+```bash
+npm install n8n-nodes-make-pdf
+```
+
+For Docker-based deployments add the package to your `package.json`:
+
+```json
+{
+  "dependencies": {
+    "n8n-nodes-make-pdf": "^1.0.1"
+  }
+}
+```
+
+## Prerequisites
+
+This node requires a running [Gotenberg](https://gotenberg.dev/) instance. Gotenberg is a Docker-powered stateless API for PDF generation.
+
+### Quick Start with Docker
+
+```bash
+docker run -d --name gotenberg -p 3000:3000 gotenberg/gotenberg:8
+```
+
+## Operations
+
+### Make PDF
+
+Converts HTML content to PDF format.
+
+**Input:**
+- Binary data containing HTML content
+- Gotenberg server URL (default: `http://gotenberg:3000/forms/chromium/convert/html`)
+
+**Output:**
+- Binary data containing the generated PDF
+
+## Configuration
+
+### Node Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| Input Binary Property | string | Yes | Name of the binary property containing HTML data (default: `data`) |
+| Output Binary Property | string | Yes | Name of the binary property to store the PDF result (default: `data`) |
+| Gotenberg URL | string | Yes | URL of your Gotenberg instance |
+
+## Example Workflow
+
+1. **HTTP Request** - Fetch HTML content or read from file
+2. **Make PDF** - Convert HTML to PDF
+3. **Write Binary File** - Save the PDF to disk
+
+## Compatibility
+
+Tested with n8n version 1.x
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+* [Gotenberg documentation](https://gotenberg.dev/)
+
+## Version History
+
+### 1.0.1
+- Improved error handling
+- Added proper binary data handling
+- Better TypeScript support
+- Enhanced property descriptions
+
+### 1.0.0
+- Initial release
+
+## License
+
+[MIT](LICENSE.md)

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

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

package/dist/nodes/MakePdf/MakePdf.node.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MakePdf = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
 class MakePdf {
     constructor() {
         this.description = {
@@ -17,16 +18,31 @@ class MakePdf {
             outputs: ['main'],
             properties: [
                 {
-                    displayName: 'Binary Property',
-                    name: 'binaryProperty',
+                    displayName: 'Input Binary Property',
+                    name: 'binaryPropertyName',
                     type: 'string',
                     default: 'data',
+                    required: true,
+                    description: 'Name of the binary property which contains the HTML data',
+                    placeholder: 'e.g. data',
+                },
+                {
+                    displayName: 'Output Binary Property',
+                    name: 'outputBinaryPropertyName',
+                    type: 'string',
+                    default: 'data',
+                    required: true,
+                    description: 'Name of the binary property to store the PDF result',
+                    placeholder: 'e.g. data',
                 },
                 {
                     displayName: 'Gotenberg URL',
                     name: 'gotenbergUrl',
                     type: 'string',
                     default: 'http://gotenberg:3000/forms/chromium/convert/html',
+                    required: true,
+                    description: 'The URL of your Gotenberg instance',
+                    placeholder: 'http://gotenberg:3000/forms/chromium/convert/html',
                 },
             ],
         };
@@ -35,30 +51,60 @@ class MakePdf {
         var _a;
         const items = this.getInputData();
         const returnData = [];
-        for (let i = 0; i < items.length; i++) {
-            const binaryProperty = this.getNodeParameter('binaryProperty', i);
-            const gotenbergUrl = this.getNodeParameter('gotenbergUrl', i);
-            const bin = (_a = items[i].binary) === null || _a === void 0 ? void 0 : _a[binaryProperty];
-            if (!(bin === null || bin === void 0 ? void 0 : bin.data)) {
-                throw new Error('No binary data found');
-            }
-            const response = await this.helpers.httpRequest({
-                method: 'POST',
-                url: gotenbergUrl,
-                body: Buffer.from(bin.data, 'base64'),
-                headers: {
-                    'Content-Type': 'text/html',
-                },
-                encoding: null,
-            });
-            items[i].binary = {
-                data: {
+        for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+            try {
+                const binaryPropertyName = this.getNodeParameter('binaryPropertyName', itemIndex);
+                const outputBinaryPropertyName = this.getNodeParameter('outputBinaryPropertyName', itemIndex);
+                const gotenbergUrl = this.getNodeParameter('gotenbergUrl', itemIndex);
+                const binaryData = (_a = items[itemIndex].binary) === null || _a === void 0 ? void 0 : _a[binaryPropertyName];
+                if (!binaryData) {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `No binary data found in property "${binaryPropertyName}"`, { itemIndex });
+                }
+                if (!binaryData.data) {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Binary property "${binaryPropertyName}" has no data`, { itemIndex });
+                }
+                // Convert base64 to Buffer
+                const htmlBuffer = Buffer.from(binaryData.data, 'base64');
+                // Make request to Gotenberg
+                const response = await this.helpers.httpRequest({
+                    method: 'POST',
+                    url: gotenbergUrl,
+                    body: htmlBuffer,
+                    headers: {
+                        'Content-Type': 'text/html',
+                    },
+                    encoding: 'arraybuffer',
+                    returnFullResponse: false,
+                });
+                // Create new binary data for PDF
+                const newBinaryData = {
                     data: Buffer.from(response).toString('base64'),
                     mimeType: 'application/pdf',
-                    fileName: 'output.pdf',
-                },
-            };
-            returnData.push(items[i]);
+                    fileName: binaryData.fileName ? binaryData.fileName.replace(/\.[^.]+$/, '.pdf') : 'output.pdf',
+                };
+                // Prepare output item
+                const newItem = {
+                    json: items[itemIndex].json,
+                    binary: {
+                        ...items[itemIndex].binary,
+                        [outputBinaryPropertyName]: newBinaryData,
+                    },
+                    pairedItem: itemIndex,
+                };
+                returnData.push(newItem);
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({
+                        json: {
+                            error: error.message,
+                        },
+                        pairedItem: itemIndex,
+                    });
+                    continue;
+                }
+                throw error;
+            }
         }
         return [returnData];
     }

package/package.json

@@ -1,15 +1,31 @@
 {
   "name": "n8n-nodes-make-pdf",
-  "version": "1.0.0",
-  "description": "Make PDF – Gotenberg wrapper node for n8n",
+  "version": "1.0.1",
+  "description": "n8n node to generate PDFs via Gotenberg - Convert HTML to PDF with ease",
+  "keywords": [
+    "n8n",
+    "n8n-node",
+    "n8n-community-node-package",
+    "pdf",
+    "gotenberg",
+    "html-to-pdf",
+    "pdf-generation"
+  ],
   "license": "MIT",
+  "author": {
+    "name": "Frank Schelhorn",
+    "email": "n8n.schelhorn@gmail.com"
+  },
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json && mkdir -p dist/nodes/MakePdf && cp src/nodes/MakePdf/icon.svg dist/nodes/MakePdf/icon.svg",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "dev": "npm run build -- --watch",
+    "lint": "tsc --noEmit"
   },
   "dependencies": {
     "n8n-workflow": "^1.0.0"
@@ -19,6 +35,7 @@
     "typescript": "^5.0.0"
   },
   "n8n": {
+    "n8nNodesApiVersion": 1,
     "nodes": [
       "dist/index.js"
     ]