@aaqu/node-red-aaqu-pdf 0.2.0 → 0.3.0

package/README.md

@@ -1,8 +1,24 @@
+## Important Information
+
+Your support in the ongoing development of this library would be sincerely appreciated. 🙂
+
+[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-%23FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black)](https://buymeacoffee.com/mazuralbert)
+
 # @aaqu/node-red-aaqu-pdf
 
-A [Node-RED](https://nodered.org/) node for extracting a single page from a PDF document.
+A [Node-RED](https://nodered.org/) node for operating on a PDF document.
+
+This module provides a custom Node-RED node that:
+- get single page from pdf
+- display single page in flow
+
+Get single page form pdf (file, http)
+
+![example.png](img/example.png)
 
-This module provides a custom Node-RED node that takes a **PDF buffer** as input and outputs a **new PDF buffer** containing only the specified page.
+Display page in flow - need [node-red-contrib-image-tools](https://flows.nodered.org/node/node-red-contrib-image-tools) -> viewer
+
+![example2.png](img/example2.png)
 
 ---
 
@@ -12,6 +28,7 @@ This module provides a custom Node-RED node that takes a **PDF buffer** as input
 - Page number can be set either in the **node configuration** or dynamically via `msg.pdfPage`.
 - Outputs a new `Buffer` containing a PDF with only the selected page.
 - Simple integration with existing Node-RED flows.
+- Convert pdf page to base64
 
 ---
 
@@ -27,36 +44,48 @@ Then restart Node-RED and the new node will appear in the editor palette.
 
 ---
 
-## Usage
+## Nodes
+_pdf-get-page_
 
-1. Provide a PDF file (e.g., using the **file in** node).
-2. Pass the PDF buffer to the **aaqu-pdf** node.
-3. Configure the page number in the node’s settings, or pass it dynamically using `msg.pdfPage`.
-   > **Note:** Page numbering starts from `1`.
-4. The node will return a new PDF buffer containing only the requested page.
+![node-pdf-get-page.png](img/node-pdf-get-page.png)
+- **msg.payload** - pdf buffer
+- **msg.pdfPage** – optional runtime override for the page number (starting at `1`).
 
-### Example Flow
+_pdf-to-img_
+
+![node-pdf-to-img.png](img/node-pdf-to-img.png)
+- **msg.payload** - pdf buffer input
+---
+
+## Usage
+
+_**pdf-get-page**_
 
 ```text
-[file in] → [aaqu-pdf] → [file out]
+[pdf multi page buffer] → [pdf-get-page] → [pdf single page buffer]
 ```
 
 Where:
-- **file in** reads the original PDF into `msg.payload` (as a buffer).
-- **aaqu-pdf** extracts the configured page (or the page defined in `msg.pdfPage`).
-- **file out** writes the single-page PDF back to disk.
+- **pdf multi page buffer** input multi page buffer.
+- **pdf-get-page** extracts the configured page (or the page defined in `msg.pdfPage`) default page no 1.
+- **pdf single page buffer** return single page buffer.
 
----
+_**pdf-to-img**_
 
-## Configuration
+```text
+[pdf buffer] → [pdf-to-img] → [out base64]
+```
 
-- **msg.payload** - pdf buffer
-- **msg.pdfPage** – optional runtime override for the page number (starting at `1`).
+Where:
+- **pdf buffer** a pdf file.
+- **aaqu-pdf** extracts the page to image.
+- **out base64** return image in base64 (to display use node-red-contrib-image-tools -> viewer).
 
 ---
 
 ## Use cases
 
+- Fast display pdf in flow editor.
 - Extracting pages from automatically generated reports.
 - Preparing single-page documents for downstream processing.
 - Splitting large PDFs into smaller parts.

package/examples/pdf-to-img.json

@@ -0,0 +1,96 @@
+[
+  {
+    "id": "849ed833a220e0de",
+    "type": "http request",
+    "z": "19cb94d5b096ef08",
+    "name": "http request pdf",
+    "method": "GET",
+    "ret": "bin",
+    "paytoqs": "ignore",
+    "url": "https://www.w3.org/2014/02/wot/slides/conway-jones.pdf",
+    "tls": "",
+    "persist": false,
+    "proxy": "",
+    "insecureHTTPParser": false,
+    "authType": "",
+    "senderr": false,
+    "headers": [],
+    "x": 500,
+    "y": 1180,
+    "wires": [
+      [
+        "14a6d0b0d27a8ab9"
+      ]
+    ]
+  },
+  {
+    "id": "b00a362a3fa631ce",
+    "type": "image viewer",
+    "z": "19cb94d5b096ef08",
+    "name": "",
+    "width": "400",
+    "data": "payload",
+    "dataType": "msg",
+    "active": true,
+    "x": 1070,
+    "y": 1180,
+    "wires": [
+      []
+    ]
+  },
+  {
+    "id": "6f454b1857d84482",
+    "type": "inject",
+    "z": "19cb94d5b096ef08",
+    "name": "",
+    "props": [],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 330,
+    "y": 1180,
+    "wires": [
+      [
+        "849ed833a220e0de"
+      ]
+    ]
+  },
+  {
+    "id": "14a6d0b0d27a8ab9",
+    "type": "pdf-get-page",
+    "z": "19cb94d5b096ef08",
+    "name": "",
+    "pdfPage": "3",
+    "x": 690,
+    "y": 1180,
+    "wires": [
+      [
+        "97821b079b898c3a"
+      ]
+    ]
+  },
+  {
+    "id": "97821b079b898c3a",
+    "type": "pdf-to-img",
+    "z": "19cb94d5b096ef08",
+    "name": "",
+    "x": 870,
+    "y": 1180,
+    "wires": [
+      [
+        "b00a362a3fa631ce"
+      ]
+    ]
+  },
+  {
+    "id": "53c5d60a126b2217",
+    "type": "global-config",
+    "env": [],
+    "modules": {
+      "node-red-contrib-image-tools": "2.1.1",
+      "@aaqu/node-red-aaqu-pdf": "0.3.0"
+    }
+  }
+]

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@aaqu/node-red-aaqu-pdf",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "node-red pdf creator",
-  "main": "index.js",
+  "main": "pdf-get-page.js",
   "scripts": {
     "node-red": "node-red"
   },
@@ -12,16 +12,24 @@
   "node-red": {
     "version": ">=4.0.0",
     "nodes": {
-      "pdf-get-page": "index.js"
+      "pdf-get-page": "pdf-get-page.js",
+      "pdf-to-img": "pdf-to-img.js"
     }
   },
-  "keywords": ["node-red", "pdf", "aaqu"],
+  "keywords": [
+    "node-red",
+    "pdf",
+    "aaqu"
+  ],
   "author": {
     "name": "Mazur Albert",
-    "url": "https://mazuralbert.pl"
+    "url": "https://mazuralbert.pl",
+    "email": "kontakt@mazuralbert.pl"
   },
   "dependencies": {
-    "pdf-lib": "^1.17.1"
+    "canvas": "^3.2.0",
+    "pdf-lib": "^1.17.1",
+    "pdf-to-img": "^5.0.0"
   },
   "devDependencies": {
     "prettier": "^3.6.2"

package/pdf-to-img.html

@@ -0,0 +1,34 @@
+<script type="text/javascript">
+  RED.nodes.registerType("pdf-to-img", {
+    category: "function",
+    color: "#a6bbcf",
+    defaults: {
+      name: { value: "" },
+      // pdfPage: { value: 1, required: false, validate: RED.validators.number() },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "file.svg",
+    label: function () {
+      return this.name || "pdf-to-img";
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="pdf-to-img">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="Name" />
+  </div>
+
+  <!--  <div class="form-row">-->
+  <!--    <label for="node-input-pdfPage"-->
+  <!--      ><i class="fa fa-tag"></i> Select pdf page</label-->
+  <!--    >-->
+  <!--    <input type="number" id="node-input-pdfPage" placeholder="Page" />-->
+  <!--  </div>-->
+</script>
+
+<script type="text/html" data-help-name="pdf-to-img">
+  <p>A simple node that input pdf buffer and return img.</p>
+</script>

package/pdf-to-img.js

@@ -0,0 +1,29 @@
+const { pdf } = require("pdf-to-img");
+
+module.exports = function (RED) {
+  function PDFToImageNode(config) {
+    RED.nodes.createNode(this, config);
+    // this.pdfPage = config.scale;
+    var node = this;
+    node.on("input", async function (msg) {
+      try {
+        const pdfBuffer = msg.payload;
+
+        const document = await pdf(pdfBuffer, { scale: 3 });
+        const page12buffer = await document.getPage(1);
+
+        msg.payload = page12buffer;
+        node.send(msg);
+      } catch (err) {
+        this.status({
+          fill: "red",
+          shape: "square",
+          text: "Error parsing PDF to Image",
+        });
+
+        node.error(err);
+      }
+    });
+  }
+  RED.nodes.registerType("pdf-to-img", PDFToImageNode);
+};