pdfbooklet 1.0.3 → 1.0.5

package/README.md

@@ -1,3 +1,7 @@
+# Generate booklet format of a PDF file for printing
+
+Save paper, save trees and save lives.
+
 To install
 
 ```
@@ -7,11 +11,14 @@ npm i -g pdfbooklet
 To use
 
 ```
-pdfbooklet <input.pdf>
+pdfbooklet [options] <INPUT-FILE.pdf>
 
 OPTIONS:
- --paper-size           (a4|letter), default is letter
- --margin-inset X       reduce margin of the original pdf on all sides by X (in inches)
- --margin-inset X,Y     reduce margin X on top and bottom, Y on left and right
- --margin-inset X,Y,Z,A reduce margin-top by X, right by Y, bottom by Z, left by A     
+ --margin-inset X         reduce margin of the original pdf on all sides by X inches
+ --margin-inset X,Y       reduce margin X on top and bottom, Y on left and right, in inches
+ --margin-inset T,R,B,L   reduce margin-top by T, right by R, bottom by B, left by L, in inches
+ --output FILENAME        default is INPUT_FILE-booklet.pdf.
+ --paper-size (a4|letter) default is letter
+ --range X-Y,+N,A-B,...   select page X to Y from input, insert N blank pages, 
+                          then from page A to B
 ```    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdfbooklet",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Create booklet from a pdf file suitable for compact printing",
   "main": "pdfbooklet.js",
   "bin": {

package/pdfbooklet.js

@@ -5,33 +5,42 @@ const {PDFDocument, degrees, grayscale} = require('pdf-lib');
 
 const INCH = 72;
 const marginInsets = {
-    left: 0,
-    right: 0,
-    top: 0,
-    bottom: 0,
+  left: 0,
+  right: 0,
+  top: 0,
+  bottom: 0,
 }
 const pageSize = {
-    width: 11 * INCH,
-    height: 8.5 * INCH,
+  width: 11 * INCH,
+  height: 8.5 * INCH,
 }
 
+// a list of 0-based indexes to the original pdf file,
+// -1 means blank page.
+let inputPageNumbers = []
+let inputPdfPath = undefined
+let outputPdfPath = undefined
+
 const err = (msg, exitCode) => {
-    console.error(msg);
-    process.exit(exitCode ?? 1);
+  console.error(msg);
+  process.exit(exitCode ?? 1);
 }
 
 const usage = (msg) => {
-    if (msg) console.error(msg);
-    console.log(`
-pdfbooklet <input.pdf>
+  if (msg) console.error(msg);
+  console.log(`
+pdfbooklet [options] <INPUT-FILE.pdf>
 
 OPTIONS:
- --paper-size (a4|letter), default is letter
- --margin-inset X reduce margin of the original pdf on all sides by X (in inches)
- --margin-inset X,Y reduce margin X on top and bottom, Y on left and right
- --margin-inset X,Y,Z,A reduce margin-top by X, right by Y, bottom by Z, left by A     
+ --margin-inset X         reduce margin of the original pdf on all sides by X inches
+ --margin-inset X,Y       reduce margin X on top and bottom, Y on left and right, in inches
+ --margin-inset T,R,B,L   reduce margin-top by T, right by R, bottom by B, left by L, in inches
+ --output FILENAME        default is INPUT_FILE-booklet.pdf.
+ --paper-size (a4|letter) default is letter
+ --range X-Y,+N,A-B,...   select page X to Y from input, insert N blank pages, 
+                          then from page A to B
     `)
-    process.exit(msg ? 1 : 0)
+  process.exit(msg ? 1 : 0)
 }
 
 /*
@@ -54,143 +63,166 @@ OPTIONS:
  * and when you fold it, it is in the natural order of A B C D.
  */
 async function createBooklet(inputPdfPath, outputPdfPath) {
-    // Read the input PDF
-    const existingPdfBytes = fs.readFileSync(inputPdfPath);
-    const pdfDoc = await PDFDocument.load(existingPdfBytes);
-    const totalPages = pdfDoc.getPageCount();
-
-    // Ensure the number of pages is a multiple of 4 (for booklet printing)
-    let numPagesToAdd = (4 - (totalPages % 4)) % 4;  // Calculate how many blank pages are needed
-    const adjustedTotalPages = totalPages + numPagesToAdd;
-
-    console.log(`Total pages in the input PDF: ${totalPages}`);
-    if (numPagesToAdd > 0) {
-        console.log(`Adding ${numPagesToAdd} blank pages to make it a multiple of 4.`);
-    }
-
-    // Create a new PDF for the booklet
-    const bookletPdf = await PDFDocument.create();
-
-    const getEmbedPage = async (i) => {
-        if (i < totalPages) {
-            const [a] = await bookletPdf.embedPdf(pdfDoc, [i]);
-            return a;
-        }
-    }
-
-
-    const leftBox = {
-        x: 0,
-        y: 0,  // Draw the first page on the left half
-        width: pageSize.width / 2,
-        height: pageSize.height,
-    }
-    const rightBox = {
-        x: pageSize.width / 2,
-        y: 0,  // Draw the first page on the left half
-        width: pageSize.width / 2,
-        height: pageSize.height,
-    }
-
-    const drawPageInBox = async (newPage, box, originPageIndex, flip) => {
-        const a = await getEmbedPage(originPageIndex)
-        if (a) {
-            const {width, height} = a.size()
-            const w = width - marginInsets.left - marginInsets.right;
-            const h = height - marginInsets.top - marginInsets.bottom;
-            const xScale = box.width / w;
-            const yScale = box.height / h;
-            const scale = xScale < yScale ? xScale : yScale;
-            const x = box.width / 2 + box.x - w * scale / 2 - marginInsets.left * scale;
-            const y = box.height / 2 + box.y - h * scale / 2 - marginInsets.bottom * scale;
-            newPage.drawPage(a, {
-                x, y,
-                xScale: scale,
-                yScale: scale,
-            })
-        }
+  // Read the input PDF
+  const existingPdfBytes = fs.readFileSync(inputPdfPath);
+  const pdfDoc = await PDFDocument.load(existingPdfBytes);
+  const totalPages = pdfDoc.getPageCount();
+
+  // If no page numbers specified, use the whole range
+  const pageNumbers = inputPageNumbers || Array.from({length: totalPages}, (_, i) => i);
+  // Align the numbers to a multiple of 4, use blank page for padding
+  while (pageNumbers.length % 4 !== 0) {
+    pageNumbers.push(-1);
+  }
+
+  console.log(`Total pages in the input PDF: ${totalPages}`);
+
+  // Create a new PDF for the booklet
+  const bookletPdf = await PDFDocument.create();
+
+  const getEmbedPage = async (i) => {
+    if (i < totalPages) {
+      const [a] = await bookletPdf.embedPdf(pdfDoc, [i]);
+      return a;
     }
-
-    // Booklet page order calculation
-    for (let i = 0; i < adjustedTotalPages; i += 4) {
-        const newPage1 = bookletPdf.addPage([pageSize.width, pageSize.height])
-        await drawPageInBox(newPage1, leftBox, i + 3)
-        await drawPageInBox(newPage1, rightBox, i)
-        const newPage2 = bookletPdf.addPage([pageSize.width, pageSize.height])
-        await drawPageInBox(newPage2, rightBox, i + 2,)
-        await drawPageInBox(newPage2, leftBox, i + 1,)
-        newPage2.setRotation(degrees(180))
+  }
+
+  const leftBox = {
+    x: 0,
+    y: 0,  // Draw the first page on the left half
+    width: pageSize.width / 2,
+    height: pageSize.height,
+  }
+  const rightBox = {
+    x: pageSize.width / 2,
+    y: 0,  // Draw the first page on the left half
+    width: pageSize.width / 2,
+    height: pageSize.height,
+  }
+
+  const drawPageInBox = async (newPage, box, originPageIndex, flip) => {
+    if (originPageIndex < 0) return;
+    const a = await getEmbedPage(originPageIndex)
+    if (a) {
+      const {width, height} = a.size()
+      const w = width - marginInsets.left - marginInsets.right;
+      const h = height - marginInsets.top - marginInsets.bottom;
+      const xScale = box.width / w;
+      const yScale = box.height / h;
+      const scale = xScale < yScale ? xScale : yScale;
+      const x = box.width / 2 + box.x - w * scale / 2 - marginInsets.left * scale;
+      const y = box.height / 2 + box.y - h * scale / 2 - marginInsets.bottom * scale;
+      newPage.drawPage(a, {
+        x, y,
+        xScale: scale,
+        yScale: scale,
+      })
     }
-
-    // Write the final booklet PDF to a file
-    const pdfBytes = await bookletPdf.save();
-    fs.writeFileSync(outputPdfPath, pdfBytes);
-    console.log(`Booklet PDF created: ${outputPdfPath} pages=${totalPages}`);
+  }
+
+  // Booklet page order calculation
+  for (let i = 0; i < pageNumbers.length; i += 4) {
+    const newPage1 = bookletPdf.addPage([pageSize.width, pageSize.height])
+    await drawPageInBox(newPage1, leftBox, pageNumbers[i + 3])
+    await drawPageInBox(newPage1, rightBox, pageNumbers[i])
+    const newPage2 = bookletPdf.addPage([pageSize.width, pageSize.height])
+    await drawPageInBox(newPage2, rightBox, pageNumbers[i + 2])
+    await drawPageInBox(newPage2, leftBox, pageNumbers[i + 1])
+    newPage2.setRotation(degrees(180))
+  }
+
+  // Write the final booklet PDF to a file
+  const pdfBytes = await bookletPdf.save();
+  fs.writeFileSync(outputPdfPath, pdfBytes);
+  console.log(`Booklet PDF created: ${outputPdfPath}, ${pageNumbers.length/2} pages`);
+  console.log(`Please print it in duplex mode.`);
 }
 
-let inputPdfPath;
 
 for (let i = 2; i < process.argv.length; i++) {
-    switch (process.argv[i]) {
-        case '--paper-size':
-            switch (process.argv[++i]) {
-                case 'a4':
-                    pageSize.width = 11.7 * INCH;
-                    pageSize.height = 8.3 * INCH;
-                    break;
-                case 'letter':
-                    pageSize.width = 11 * INCH;
-                    pageSize.height = 8.5 * INCH;
-                    break;
-
-                default:
-                    err("Unknown paper size")
-                    break;
-            }
-            break;
-        case '--margin-inset':
-            // follow css convention
-            const insets = process.argv[++i].split(',').map(x => parseFloat(x) * INCH);
-            if (insets.length === 1) {
-                marginInsets.left = insets[0];
-                marginInsets.right = insets[0];
-                marginInsets.bottom = insets[0];
-                marginInsets.top = insets[0];
-            } else if (insets.length === 2) {
-                marginInsets.top = insets[0];
-                marginInsets.bottom = insets[0];
-                marginInsets.left = insets[1];
-                marginInsets.right = insets[1];
-            } else if (insets.length === 4) {
-                marginInsets.top = insets[0];
-                marginInsets.right = insets[1];
-                marginInsets.bottom = insets[2];
-                marginInsets.left = insets[3];
-            } else {
-                err("Invalid insets");
-            }
-            break;
-        case '--help':
-            usage();
-            break;
+  switch (process.argv[i]) {
+    case '--output':
+      outputPdfPath = process.argv[++i];
+      break;
+    case '--range':
+      inputPageNumbers = process.argv[++i].split(',').map(x => {
+        const m = x.match(/^\+(\d+)$/);
+        if (m) {
+          return Array(parseInt(m[1])).fill(0)
+        }
+        if (x.match(/^\d+$/)) {
+          return parseInt(x);
+        }
+        const m2 = x.match(/^(\d+)-(\d+)$/);
+        if (!m2) {
+          throw new Error(`Bad range: ${x}`)
+        }
+        const begin = parseInt(m2[1]);
+        const end = parseInt(m2[2]);
+        return Array.from({length: end - begin + 1}, (v, i) => begin + i)
+      }).flat().map(x => x - 1); // convert to 0 based index
+      break;
+    case '--paper-size':
+      switch (process.argv[++i]) {
+        case 'a4':
+          pageSize.width = 11.7 * INCH;
+          pageSize.height = 8.3 * INCH;
+          break;
+        case 'letter':
+          pageSize.width = 11 * INCH;
+          pageSize.height = 8.5 * INCH;
+          break;
+
         default:
-            inputPdfPath = process.argv[i];
-            break;
-    }
+          err("Unknown paper size")
+          break;
+      }
+      break;
+    case '--margin-inset':
+      // follow css convention
+      const insets = process.argv[++i].split(',')
+        .map(x => parseFloat(x) * INCH);
+      if (insets.length === 1) {
+        marginInsets.left = insets[0];
+        marginInsets.right = insets[0];
+        marginInsets.bottom = insets[0];
+        marginInsets.top = insets[0];
+      } else if (insets.length === 2) {
+        marginInsets.top = insets[0];
+        marginInsets.bottom = insets[0];
+        marginInsets.left = insets[1];
+        marginInsets.right = insets[1];
+      } else if (insets.length === 4) {
+        marginInsets.top = insets[0];
+        marginInsets.right = insets[1];
+        marginInsets.bottom = insets[2];
+        marginInsets.left = insets[3];
+      } else {
+        err("Invalid insets");
+      }
+      break;
+    case '--help':
+      usage();
+      break;
+    default:
+      inputPdfPath = process.argv[i];
+      break;
+  }
 }
 
 if (!inputPdfPath) {
-    usage("Missing input file");
+  usage("Missing input file");
 }
 
 if (!fs.existsSync(inputPdfPath)) {
-    err(`File not found: ${inputPdfPath}`)
+  err(`File not found: ${inputPdfPath}`)
 }
 
 // Automatically generate the output filename by appending '-booklet' before '.pdf'
-const outputPdfPath = inputPdfPath.replace(/\.pdf$/i, '-booklet.pdf');
+outputPdfPath ||= inputPdfPath.replace(/\.pdf$/i, '-booklet.pdf');
+
 // Usage example
 createBooklet(inputPdfPath, outputPdfPath).catch(err => {
-    console.error('Error creating booklet:', err);
+  console.error('Error creating booklet:', err);
 });