n8n-nodes-pdfkraft 0.1.0 → 0.2.0

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

@@ -1,5 +1,10 @@
-import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription } from 'n8n-workflow';
 export declare class PDFKraft implements INodeType {
     description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getTemplates(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+        };
+    };
     execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
 }

package/dist/nodes/PDFKraft/PDFKraft.node.js

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PDFKraft = void 0;
 const n8n_workflow_1 = require("n8n-workflow");
+const MIME_TYPES = {
+    pdf: 'application/pdf',
+    png: 'image/png',
+    jpg: 'image/jpeg',
+    webp: 'image/webp',
+};
 class PDFKraft {
     constructor() {
         this.description = {
@@ -23,58 +29,172 @@ class PDFKraft {
                     type: 'options',
                     noDataExpression: true,
                     options: [
-                        { name: 'Generate Document', value: 'generateDocument', description: 'Generate a PDF or image from a template' },
-                        { name: 'Generate Document (Sync)', value: 'generateDocumentSync', description: 'Generate and wait for the result' },
-                        { name: 'Get Document', value: 'getDocument', description: 'Get document status and download URL' },
-                        { name: 'List Templates', value: 'listTemplates', description: 'List all available templates' },
-                        { name: 'Download Document', value: 'downloadDocument', description: 'Download document as binary data' },
+                        {
+                            name: 'Generate Document',
+                            value: 'generateDocument',
+                            description: 'Queue a document for generation and return immediately with a document ID',
+                            action: 'Generate a document',
+                        },
+                        {
+                            name: 'Generate Document and Wait',
+                            value: 'generateAndWait',
+                            description: 'Generate a document and poll until it is complete — returns the final result with download URL',
+                            action: 'Generate a document and wait for result',
+                        },
+                        {
+                            name: 'Get Document',
+                            value: 'getDocument',
+                            description: 'Get the status and download URL of a generated document',
+                            action: 'Get a document',
+                        },
+                        {
+                            name: 'Download Document',
+                            value: 'downloadDocument',
+                            description: 'Download a completed document as binary data',
+                            action: 'Download a document',
+                        },
+                        {
+                            name: 'List Documents',
+                            value: 'listDocuments',
+                            description: 'List recently generated documents for your account',
+                            action: 'List documents',
+                        },
+                        {
+                            name: 'List Templates',
+                            value: 'listTemplates',
+                            description: 'List all published templates for your account',
+                            action: 'List templates',
+                        },
                     ],
-                    default: 'generateDocument',
+                    default: 'generateAndWait',
                 },
-                // generateDocument / generateDocumentSync fields
+                // ── Template picker ──────────────────────────────────────────────────
                 {
-                    displayName: 'Template ID',
+                    displayName: 'Template',
                     name: 'templateId',
-                    type: 'string',
+                    type: 'options',
+                    typeOptions: { loadOptionsMethod: 'getTemplates' },
                     default: '',
                     required: true,
-                    displayOptions: { show: { operation: ['generateDocument', 'generateDocumentSync'] } },
-                    description: 'The UUID of the template to use',
+                    displayOptions: { show: { operation: ['generateDocument', 'generateAndWait'] } },
+                    description: 'The template to generate from. Only published templates appear. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
                 },
+                // ── Generate fields ──────────────────────────────────────────────────
                 {
                     displayName: 'Payload',
                     name: 'payload',
                     type: 'json',
                     default: '{}',
-                    displayOptions: { show: { operation: ['generateDocument', 'generateDocumentSync'] } },
-                    description: 'JSON data to merge into the template',
+                    displayOptions: { show: { operation: ['generateDocument', 'generateAndWait'] } },
+                    description: 'JSON object with variables to merge into the template. Use Liquid syntax in your template: {{ variable_name }}.',
+                    hint: 'Tip: use n8n expressions to pass data from previous nodes, e.g. <code>{{ $json.customer_name }}</code>',
                 },
                 {
                     displayName: 'Filename',
                     name: 'filename',
                     type: 'string',
                     default: '',
-                    displayOptions: { show: { operation: ['generateDocument', 'generateDocumentSync'] } },
-                    description: 'Output filename. Supports {{variable}} from payload.',
+                    placeholder: 'invoice-{{order_id}}.pdf',
+                    displayOptions: { show: { operation: ['generateDocument', 'generateAndWait'] } },
+                    description: 'Output filename. Supports {{variable}} placeholders using values from the payload. Leave blank to use the template default.',
                 },
                 {
-                    displayName: 'Meta',
-                    name: 'meta',
-                    type: 'json',
-                    default: '{}',
-                    displayOptions: { show: { operation: ['generateDocument', 'generateDocumentSync'] } },
+                    displayName: 'Additional Options',
+                    name: 'additionalOptions',
+                    type: 'collection',
+                    placeholder: 'Add option',
+                    default: {},
+                    displayOptions: { show: { operation: ['generateDocument', 'generateAndWait'] } },
+                    options: [
+                        {
+                            displayName: 'Meta',
+                            name: 'meta',
+                            type: 'json',
+                            default: '{}',
+                            description: 'Arbitrary metadata to attach to the document (returned in webhook payloads and API responses)',
+                        },
+                    ],
+                },
+                // ── Generate and Wait specific ───────────────────────────────────────
+                {
+                    displayName: 'Timeout (Seconds)',
+                    name: 'timeoutSeconds',
+                    type: 'number',
+                    default: 60,
+                    typeOptions: { minValue: 5, maxValue: 300 },
+                    displayOptions: { show: { operation: ['generateAndWait'] } },
+                    description: 'How long to wait for the document to complete before failing',
                 },
-                // getDocument / downloadDocument fields
+                // ── Document ID fields ───────────────────────────────────────────────
                 {
                     displayName: 'Document ID',
                     name: 'documentId',
                     type: 'string',
                     default: '',
                     required: true,
+                    placeholder: 'b8f63e36-cad3-4e57-9058-8d7e85824a4d',
                     displayOptions: { show: { operation: ['getDocument', 'downloadDocument'] } },
+                    description: 'The document ID returned by the Generate Document operation',
+                },
+                // ── Download options ─────────────────────────────────────────────────
+                {
+                    displayName: 'Output Field Name',
+                    name: 'binaryPropertyName',
+                    type: 'string',
+                    default: 'data',
+                    displayOptions: { show: { operation: ['downloadDocument'] } },
+                    description: 'Name of the output field to put the binary file data into',
+                },
+                // ── List documents options ───────────────────────────────────────────
+                {
+                    displayName: 'Status Filter',
+                    name: 'statusFilter',
+                    type: 'options',
+                    options: [
+                        { name: 'All', value: '' },
+                        { name: 'Success', value: 'success' },
+                        { name: 'Failure', value: 'failure' },
+                        { name: 'Pending', value: 'pending' },
+                    ],
+                    default: '',
+                    displayOptions: { show: { operation: ['listDocuments'] } },
+                    description: 'Filter documents by status',
+                },
+                {
+                    displayName: 'Limit',
+                    name: 'limit',
+                    type: 'number',
+                    default: 20,
+                    typeOptions: { minValue: 1, maxValue: 100 },
+                    displayOptions: { show: { operation: ['listDocuments'] } },
+                    description: 'Maximum number of documents to return',
                 },
             ],
         };
+        this.methods = {
+            loadOptions: {
+                async getTemplates() {
+                    const credentials = await this.getCredentials('pdfKraftApi');
+                    const baseUrl = credentials.baseUrl.replace(/\/$/, '');
+                    const apiKey = credentials.apiKey;
+                    const response = await this.helpers.request({
+                        method: 'GET',
+                        url: `${baseUrl}/document_template_cards`,
+                        headers: { Authorization: `Bearer ${apiKey}` },
+                        json: true,
+                    });
+                    const templates = (response.data ?? []).filter(t => t.published_at);
+                    if (templates.length === 0) {
+                        return [{ name: 'No published templates found — publish one in PDFKraft first', value: '' }];
+                    }
+                    return templates.map(t => ({
+                        name: `${t.name} (${t.output_type.toUpperCase()})`,
+                        value: t.id,
+                        description: t.identifier,
+                    }));
+                },
+            },
+        };
     }
     async execute() {
         const items = this.getInputData();
@@ -82,32 +202,75 @@ class PDFKraft {
         const credentials = await this.getCredentials('pdfKraftApi');
         const baseUrl = credentials.baseUrl.replace(/\/$/, '');
         const apiKey = credentials.apiKey;
-        const headers = {
-            Authorization: `Bearer ${apiKey}`,
-            'Content-Type': 'application/json',
-        };
+        const headers = { Authorization: `Bearer ${apiKey}`, 'Content-Type': 'application/json' };
         for (let i = 0; i < items.length; i++) {
             const operation = this.getNodeParameter('operation', i);
-            if (operation === 'generateDocument' || operation === 'generateDocumentSync') {
+            // ── Generate Document (fire and forget) ────────────────────────────
+            if (operation === 'generateDocument') {
                 const templateId = this.getNodeParameter('templateId', i);
                 const payloadRaw = this.getNodeParameter('payload', i);
                 const filename = this.getNodeParameter('filename', i);
-                const metaRaw = this.getNodeParameter('meta', i);
+                const additionalOptions = this.getNodeParameter('additionalOptions', i);
                 const payload = typeof payloadRaw === 'string' ? JSON.parse(payloadRaw) : payloadRaw;
-                const meta = typeof metaRaw === 'string' ? JSON.parse(metaRaw) : metaRaw;
+                const meta = additionalOptions.meta
+                    ? (typeof additionalOptions.meta === 'string' ? JSON.parse(additionalOptions.meta) : additionalOptions.meta)
+                    : {};
                 const body = { document_template_id: templateId, payload, meta };
                 if (filename)
                     body.filename = filename;
-                const endpoint = operation === 'generateDocumentSync' ? '/documents/sync' : '/documents';
                 const response = await this.helpers.request({
                     method: 'POST',
-                    url: `${baseUrl}${endpoint}`,
+                    url: `${baseUrl}/documents`,
                     headers,
                     body: JSON.stringify(body),
                     json: true,
                 });
                 results.push({ json: response });
             }
+            // ── Generate and Wait (poll until complete) ────────────────────────
+            if (operation === 'generateAndWait') {
+                const templateId = this.getNodeParameter('templateId', i);
+                const payloadRaw = this.getNodeParameter('payload', i);
+                const filename = this.getNodeParameter('filename', i);
+                const additionalOptions = this.getNodeParameter('additionalOptions', i);
+                const timeoutSeconds = this.getNodeParameter('timeoutSeconds', i);
+                const payload = typeof payloadRaw === 'string' ? JSON.parse(payloadRaw) : payloadRaw;
+                const meta = additionalOptions.meta
+                    ? (typeof additionalOptions.meta === 'string' ? JSON.parse(additionalOptions.meta) : additionalOptions.meta)
+                    : {};
+                const body = { document_template_id: templateId, payload, meta };
+                if (filename)
+                    body.filename = filename;
+                const created = await this.helpers.request({
+                    method: 'POST',
+                    url: `${baseUrl}/documents`,
+                    headers,
+                    body: JSON.stringify(body),
+                    json: true,
+                });
+                const documentId = created.id;
+                const deadline = Date.now() + timeoutSeconds * 1000;
+                let doc = {};
+                while (Date.now() < deadline) {
+                    await new Promise(r => setTimeout(r, 2000));
+                    doc = await this.helpers.request({
+                        method: 'GET',
+                        url: `${baseUrl}/document_cards/${documentId}`,
+                        headers,
+                        json: true,
+                    });
+                    if (doc.status === 'success' || doc.status === 'failure')
+                        break;
+                }
+                if (doc.status !== 'success' && doc.status !== 'failure') {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Document ${documentId} did not complete within ${timeoutSeconds}s`, { itemIndex: i });
+                }
+                if (doc.status === 'failure') {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Document generation failed: ${doc.failure_cause ?? 'unknown error'}`, { itemIndex: i });
+                }
+                results.push({ json: doc });
+            }
+            // ── Get Document ───────────────────────────────────────────────────
             if (operation === 'getDocument') {
                 const documentId = this.getNodeParameter('documentId', i);
                 const response = await this.helpers.request({
@@ -118,20 +281,23 @@ class PDFKraft {
                 });
                 results.push({ json: response });
             }
-            if (operation === 'listTemplates') {
-                const response = await this.helpers.request({
+            // ── Download Document ──────────────────────────────────────────────
+            if (operation === 'downloadDocument') {
+                const documentId = this.getNodeParameter('documentId', i);
+                const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i);
+                // Fetch document metadata to get filename and output type
+                const doc = await this.helpers.request({
                     method: 'GET',
-                    url: `${baseUrl}/document_template_cards`,
+                    url: `${baseUrl}/document_cards/${documentId}`,
                     headers,
                     json: true,
                 });
-                const res = response;
-                for (const t of res.data ?? []) {
-                    results.push({ json: t });
+                if (doc.status !== 'success') {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Document is not ready — status is "${doc.status}"`, { itemIndex: i });
                 }
-            }
-            if (operation === 'downloadDocument') {
-                const documentId = this.getNodeParameter('documentId', i);
+                const outputType = doc.output_type ?? 'pdf';
+                const filename = doc.filename ?? `document.${outputType}`;
+                const mimeType = MIME_TYPES[outputType] ?? 'application/octet-stream';
                 const buffer = await this.helpers.request({
                     method: 'GET',
                     url: `${baseUrl}/documents/${documentId}/download`,
@@ -139,8 +305,36 @@ class PDFKraft {
                     encoding: null,
                     resolveWithFullResponse: false,
                 });
-                const binaryData = await this.helpers.prepareBinaryData(buffer, 'document.pdf', 'application/pdf');
-                results.push({ json: { documentId }, binary: { data: binaryData } });
+                const binaryData = await this.helpers.prepareBinaryData(buffer, filename, mimeType);
+                results.push({ json: { documentId, filename, output_type: outputType }, binary: { [binaryPropertyName]: binaryData } });
+            }
+            // ── List Documents ─────────────────────────────────────────────────
+            if (operation === 'listDocuments') {
+                const statusFilter = this.getNodeParameter('statusFilter', i);
+                const limit = this.getNodeParameter('limit', i);
+                const params = new URLSearchParams({ page: '1' });
+                if (statusFilter)
+                    params.set('status', statusFilter);
+                const response = await this.helpers.request({
+                    method: 'GET',
+                    url: `${baseUrl}/document_cards?${params}`,
+                    headers,
+                    json: true,
+                });
+                const docs = (response.data ?? []).slice(0, limit);
+                for (const doc of docs)
+                    results.push({ json: doc });
+            }
+            // ── List Templates ─────────────────────────────────────────────────
+            if (operation === 'listTemplates') {
+                const response = await this.helpers.request({
+                    method: 'GET',
+                    url: `${baseUrl}/document_template_cards`,
+                    headers,
+                    json: true,
+                });
+                for (const t of response.data ?? [])
+                    results.push({ json: t });
             }
         }
         return [results];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-pdfkraft",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "n8n community node for PDFKraft — generate PDFs and images via the PDFKraft API",
   "keywords": ["n8n-community-node-package"],
   "main": "dist/index.js",