@pdfgeneratorapi/n8n-nodes-pdf-generator-api 0.2.2

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,174 @@
+# n8n-nodes-pdf-generator-api
+
+This is an n8n community node. It lets you use PDF Generator API in your n8n workflows.
+
+PDF Generator API is a powerful service that allows you to generate PDFs from templates, convert HTML/URLs to PDF, and perform various PDF operations like watermarking, encryption, optimization, and form field manipulation.
+
+[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)  
+[Usage](#usage)  
+[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.
+
+Use the package name: `n8n-nodes-pdf-generator-api`
+
+## Operations
+
+This node supports the following operations organized by resource:
+
+### Document
+- **Generate** - Generate a PDF document from a template with data
+- **Generate (Async)** - Generate a PDF document asynchronously with callback
+- **Generate (Batch)** - Generate multiple PDF documents in batch
+- **Generate (Batch + Async)** - Generate multiple PDF documents in batch asynchronously
+- **List** - List generated documents stored in the API
+- **Get** - Retrieve a specific document by public ID
+- **Delete** - Delete a document from storage
+
+### Template
+- **Create** - Create a new PDF template
+- **Update** - Update an existing template configuration
+- **Get** - Retrieve template configuration
+- **Delete** - Delete a template
+- **List** - List available templates
+- **Copy** - Create a copy of an existing template
+- **Get Data Fields** - Extract data fields used in a template
+- **Open Editor** - Get URL to open template editor
+- **Validate** - Validate template configuration
+
+### Conversion
+- **HTML to PDF** - Convert HTML content directly to PDF
+- **URL to PDF** - Convert a public URL to PDF
+
+### PDF Services
+- **Add Watermark** - Add text or image watermarks to PDF documents
+- **Encrypt Document** - Encrypt PDF documents with password protection
+- **Decrypt Document** - Decrypt encrypted PDF documents
+- **Optimize Document** - Optimize PDF file size for better performance
+- **Extract Form Fields** - Extract form fields and metadata from PDF documents
+- **Fill Form Fields** - Fill form fields in PDF documents with provided data
+
+### Workspace
+- **Create** - Create a new workspace for organizing templates
+- **List** - List all workspaces in organization
+- **Get** - Get workspace information
+- **Delete** - Delete a workspace
+
+## Credentials
+
+To use this node, you need to authenticate with PDF Generator API:
+
+### Prerequisites
+1. Sign up for a [PDF Generator API account](https://pdfgeneratorapi.com/signup)
+2. Get your API Key and API Secret from Account Settings
+
+### Authentication Setup
+1. In n8n, create new credentials for "PDF Generator API"
+2. Enter your **API Key** and **API Secret**
+
+### JWT Authentication
+The node automatically handles JWT token generation using your API credentials. Tokens are generated server-side and include:
+- Issuer (iss): Your API Key
+- Subject (sub): Workspace identifier
+- Expiration (exp): Short-lived tokens for security
+
+## Compatibility
+
+- **Minimum n8n version**: 0.199.0
+- **Tested with**: n8n versions 0.199.0+
+- **Node API version**: 1
+
+## Usage
+
+### Basic Document Generation
+1. Select **Resource**: Document
+2. Select **Operation**: Generate
+3. Choose your template from the dropdown
+4. Provide JSON data to merge with the template
+5. Select output format (Base64, URL, or File)
+
+### HTML to PDF Conversion
+1. Select **Resource**: Conversion
+2. Select **Operation**: HTML to PDF
+3. Enter your HTML content
+4. Configure paper size and orientation
+5. Specify filename and output format
+
+### PDF Processing
+- **Watermarking**: Add text or image watermarks with positioning options
+- **Encryption**: Protect PDFs with owner and user passwords
+- **Decryption**: Remove password protection from encrypted PDFs
+- **Optimization**: Reduce file size while maintaining quality
+- **Form Fields**: Extract form field metadata and fill PDF forms with data
+
+#### Form Fields Operations
+1. **Extract Form Fields**: Analyze PDF forms to discover available fields
+2. **Fill Form Fields**: Populate PDF forms with data
+
+Example form data:
+```json
+{
+  "firstName": "John",
+  "lastName": "Doe",
+  "email": "john.doe@example.com",
+  "subscribe": true
+}
+```
+
+### Output Formats
+- **Base64**: Returns PDF as base64 encoded string in JSON
+- **URL**: Returns download URL (files stored for 30 days)
+- **File**: Returns binary PDF data for direct download
+
+### Error Handling
+The node includes comprehensive error handling for:
+- Authentication failures
+- Invalid template configurations
+- Missing required parameters
+- API rate limiting
+- Network connectivity issues
+
+For workflows that should continue on errors, enable "Continue on Fail" in node settings.
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+* [PDF Generator API Documentation](https://docs.pdfgeneratorapi.com)
+* [PDF Generator API Support](https://support.pdfgeneratorapi.com)
+* [Template Editor Guide](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/)
+* [Expression Language Documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/)
+
+## Version history
+
+### 0.2.2
+- 🧹 **Cleanup**: Removed example nodes and credentials from package
+- 🔧 **Improved**: Build process now only includes production files
+- 📦 **Optimized**: Package structure for better n8n compatibility
+
+### 0.2.1
+- 🐛 **Fixed**: Fixed npm publish script in package.json
+- 📝 **Updated**: Package metadata and repository information
+
+### 0.2.0
+- ✨ **New**: Added PDF form fields operations
+  - Extract Form Fields: Analyze and extract form field metadata
+  - Fill Form Fields: Populate PDF forms with data
+- 🐛 **Fixed**: Improved error handling for PDF services operations
+- 📝 **Docs**: Enhanced documentation and examples
+
+### 0.1.0
+- 🎉 **Initial Release**: Complete PDF Generator API integration
+  - Document generation from templates
+  - HTML/URL to PDF conversion
+  - PDF processing (watermark, encrypt, decrypt, optimize)
+  - Template and workspace management
+  - Support for all output formats (Base64, URL, File)
+  - Comprehensive error handling and validation 

package/dist/credentials/PdfGeneratorApi.credentials.d.ts

@@ -0,0 +1,11 @@
+import { ICredentialDataDecryptedObject, ICredentialTestRequest, ICredentialType, IHttpRequestOptions, INodeProperties } from 'n8n-workflow';
+export declare class PdfGeneratorApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    private validateCredentials;
+    authenticate(credentials: ICredentialDataDecryptedObject, requestOptions: IHttpRequestOptions): Promise<IHttpRequestOptions>;
+    private generateJWT;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/PdfGeneratorApi.credentials.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PdfGeneratorApi = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+class PdfGeneratorApi {
+    constructor() {
+        this.name = 'pdfGeneratorApi';
+        this.displayName = 'PDF Generator API';
+        this.documentationUrl = 'https://docs.pdfgeneratorapi.com/v4';
+        this.properties = [
+            {
+                displayName: 'API KEY',
+                name: 'jwtIss',
+                type: 'string',
+                required: true,
+                default: '',
+                description: 'JWT issuer claim',
+            },
+            {
+                displayName: 'Secret',
+                name: 'jwtSecret',
+                type: 'string',
+                required: true,
+                default: '',
+                typeOptions: {
+                    password: true,
+                },
+                description: 'Your JWT secret key for signing tokens',
+            },
+            {
+                displayName: 'Email/workspace',
+                name: 'workspace',
+                type: 'string',
+                required: true,
+                default: '',
+                description: 'Your email address (workspace identifier and JWT subject)',
+            },
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                required: false,
+                default: 'https://us1.pdfgeneratorapi.com/api/v4',
+                description: 'API base URL (leave default for production, change for local development)',
+            },
+        ];
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.baseUrl || "https://us1.pdfgeneratorapi.com/api/v4"}}',
+                url: '/workspaces',
+                method: 'GET',
+            },
+            rules: [
+                {
+                    type: 'responseSuccessBody',
+                    properties: {
+                        key: 'response',
+                        value: {},
+                        message: 'Invalid credentials. Please check your API Key, Secret, and Email/workspace.',
+                    },
+                },
+            ],
+        };
+    }
+    validateCredentials(credentials) {
+        if (!credentials.jwtIss || !credentials.jwtSecret || !credentials.workspace) {
+            throw new n8n_workflow_1.NodeOperationError({}, 'Missing required credentials. Please provide API Key, Secret, and Email/workspace.');
+        }
+        const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+        if (!emailRegex.test(credentials.workspace)) {
+            throw new n8n_workflow_1.NodeOperationError({}, 'Email/workspace must be a valid email address.');
+        }
+    }
+    async authenticate(credentials, requestOptions) {
+        this.validateCredentials(credentials);
+        const token = this.generateJWT(credentials);
+        requestOptions.headers = {
+            ...requestOptions.headers,
+            'Authorization': `Bearer ${token}`,
+        };
+        return requestOptions;
+    }
+    generateJWT(credentials) {
+        const crypto = require('crypto');
+        const header = {
+            'typ': 'JWT',
+            'alg': 'HS256'
+        };
+        const currentTimestamp = Math.floor(Date.now() / 1000);
+        const data = {
+            'iss': credentials.jwtIss,
+            'sub': credentials.workspace,
+            'exp': currentTimestamp + 60,
+            'partner_id': 'n8n-node',
+        };
+        function base64url(source) {
+            let encodedSource = source.toString('base64');
+            encodedSource = encodedSource.replace(/=+$/, '');
+            encodedSource = encodedSource.replace(/\+/g, '-');
+            encodedSource = encodedSource.replace(/\//g, '_');
+            return encodedSource;
+        }
+        const stringifiedHeader = Buffer.from(JSON.stringify(header));
+        const encodedHeader = base64url(stringifiedHeader);
+        const stringifiedData = Buffer.from(JSON.stringify(data));
+        const encodedData = base64url(stringifiedData);
+        const token = `${encodedHeader}.${encodedData}`;
+        const signature = crypto.createHmac('sha256', credentials.jwtSecret).update(token).digest();
+        const encodedSignature = base64url(signature);
+        const signedToken = `${token}.${encodedSignature}`;
+        return signedToken;
+    }
+}
+exports.PdfGeneratorApi = PdfGeneratorApi;
+//# sourceMappingURL=PdfGeneratorApi.credentials.js.map

package/dist/credentials/PdfGeneratorApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PdfGeneratorApi.credentials.js","sourceRoot":"","sources":["../../credentials/PdfGeneratorApi.credentials.ts"],"names":[],"mappings":";;;AAAA,+CAOsB;AAEtB,MAAa,eAAe;IAA5B;QACC,SAAI,GAAG,iBAAiB,CAAC;QACzB,gBAAW,GAAG,mBAAmB,CAAC;QAClC,qBAAgB,GAAG,qCAAqC,CAAC;QACzD,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,kBAAkB;aAC/B;YACD;gBACC,WAAW,EAAE,QAAQ;gBACrB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,WAAW,EAAE,wCAAwC;aACrD;YACD;gBACC,WAAW,EAAE,iBAAiB;gBAC9B,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,2DAA2D;aACxE;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,wCAAwC;gBACjD,WAAW,EAAE,2EAA2E;aACxF;SACD,CAAC;QAgGF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,uEAAuE;gBAChF,GAAG,EAAE,aAAa;gBAClB,MAAM,EAAE,KAAK;aACb;YACD,KAAK,EAAE;gBACN;oBACC,IAAI,EAAE,qBAAqB;oBAC3B,UAAU,EAAE;wBACX,GAAG,EAAE,UAAU;wBACf,KAAK,EAAE,EAAE;wBACT,OAAO,EAAE,8EAA8E;qBACvF;iBACD;aACD;SACD,CAAC;IACH,CAAC;IA9GQ,mBAAmB,CAAC,WAA2C;QACtE,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;YAC7E,MAAM,IAAI,iCAAkB,CAC3B,EAAS,EACT,oFAAoF,CACpF,CAAC;QACH,CAAC;QAGD,MAAM,UAAU,GAAG,4BAA4B,CAAC;QAChD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,SAAmB,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,iCAAkB,CAC3B,EAAS,EACT,gDAAgD,CAChD,CAAC;QACH,CAAC;IACF,CAAC;IAGD,KAAK,CAAC,YAAY,CACjB,WAA2C,EAC3C,cAAmC;QAGnC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAGtC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAG5C,cAAc,CAAC,OAAO,GAAG;YACxB,GAAG,cAAc,CAAC,OAAO;YACzB,eAAe,EAAE,UAAU,KAAK,EAAE;SAClC,CAAC;QAEF,OAAO,cAAc,CAAC;IACvB,CAAC;IAGO,WAAW,CAAC,WAA2C;QAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAGjC,MAAM,MAAM,GAAG;YACd,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,OAAO;SACd,CAAC;QAGF,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAEvD,MAAM,IAAI,GAAG;YACZ,KAAK,EAAE,WAAW,CAAC,MAAgB;YACnC,KAAK,EAAE,WAAW,CAAC,SAAmB;YACtC,KAAK,EAAE,gBAAgB,GAAG,EAAE;YAC5B,YAAY,EAAE,UAAU;SACxB,CAAC;QAGF,SAAS,SAAS,CAAC,MAAc;YAEhC,IAAI,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAG9C,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAGjD,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAClD,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAElD,OAAO,aAAa,CAAC;QACtB,CAAC;QAGD,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9D,MAAM,aAAa,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAGnD,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;QAG/C,MAAM,KAAK,GAAG,GAAG,aAAa,IAAI,WAAW,EAAE,CAAC;QAGhD,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,SAAmB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QACtG,MAAM,gBAAgB,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,GAAG,KAAK,IAAI,gBAAgB,EAAE,CAAC;QAEnD,OAAO,WAAW,CAAC;IACpB,CAAC;CAoBD;AAzJD,0CAyJC"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { PdfGeneratorApi } from './nodes/PdfGeneratorApi/PdfGeneratorApi.node';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PdfGeneratorApi = void 0;
+var PdfGeneratorApi_node_1 = require("./nodes/PdfGeneratorApi/PdfGeneratorApi.node");
+Object.defineProperty(exports, "PdfGeneratorApi", { enumerable: true, get: function () { return PdfGeneratorApi_node_1.PdfGeneratorApi; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,qFAA+E;AAAtE,uHAAA,eAAe,OAAA"}

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

@@ -0,0 +1,10 @@
+import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodeType, INodeTypeDescription, INodeListSearchResult } from 'n8n-workflow';
+export declare class PdfGeneratorApi implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        listSearch: {
+            searchTemplates(this: ILoadOptionsFunctions, filter?: string): Promise<INodeListSearchResult>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}