Incremental PDF update, with automatic change tracking, or manual tracking of changes. Fixes issue #816

apps/deno/index.ts

@@ -1,4 +1,3 @@
-import { readLines } from 'https://deno.land/[email protected]/io/bufio.ts';
 import { SEP, dirname } from 'https://deno.land/[email protected]/path/mod.ts';
 
 import { default as test1 } from './tests/test1.ts';
@@ -19,11 +18,15 @@ import { default as test15 } from './tests/test15.ts';
 import { default as test16 } from './tests/test16.ts';
 import { default as test17 } from './tests/test17.ts';
 import { default as test18 } from './tests/test18.ts';
+import { default as test19 } from './tests/test19.ts';
+import test20 from './tests/test20.ts';
 
 const promptToContinue = () => {
   const prompt = 'Press <enter> to run the next test...';
   Deno.stdout.write(new TextEncoder().encode(prompt));
-  return readLines(Deno.stdin).next();
+
+  const buff = new Uint8Array(128);
+  return Deno.stdin.read(buff);
 };
 
 // This needs to be more sophisticated to work on Linux as well.
@@ -38,9 +41,13 @@ const openPdf = (path: string, reader: string = '') => {
   } else if (Deno.build.os === 'windows') {
     // Opens with the default PDF Reader, has room for improvment
     Deno.run({ cmd: ['cmd', '/c', 'start', path] });
+  } else if (Deno.build.os === 'linux') {
+    Deno.run({ cmd: ['xdg-open', path] });
   } else {
-    const msg1 = `Note: Automatically opening PDFs currently only works on Macs and Windows. If you're using a Linux machine, please consider contributing to expand support for this feature`;
-    const msg2 = `(https://github.com/Hopding/pdf-lib/blob/master/apps/node/index.ts#L8-L17)\n`;
+    const msg1 =
+      "Note: Automatically opening PDFs currently only works on Macs and Windows. If you're using a Linux machine, please consider contributing to expand support for this feature";
+    const msg2 =
+      '(https://github.com/Hopding/pdf-lib/blob/master/apps/node/index.ts#L8-L17)\n';
     console.warn(msg1);
     console.warn(msg2);
   }
@@ -135,6 +142,7 @@ const assets = {
     fancy_fields: readPdf('fancy_fields.pdf'),
     form_to_flatten: readPdf('form_to_flatten.pdf'),
     with_annots: readPdf('with_annots.pdf'),
+    simple: readPdf('simple.pdf'),
   },
 };
 
@@ -165,7 +173,8 @@ const main = async () => {
   // prettier-ignore
   const allTests = [
       test1, test2, test3, test4, test5, test6, test7, test8, test9, test10,
-      test11, test12, test13, test14, test15, test16, test17, test18
+      test11, test12, test13, test14, test15, test16, test17, test18, test19,
+      test20
     ];
 
   const tests = testIdx ? [allTests[testIdx - 1]] : allTests;

apps/deno/tests/test1.ts

@@ -609,7 +609,7 @@ export default async (assets: Assets) => {
   const multilineTf = form.createTextField('moi.multiline.text.field');
   multilineTf.enableMultiline();
   multilineTf.setText(
-    `In the morning, when you can't get out of bed, tell yourself: "I'm getting up to do the work only a man can do. How can I possibly hesitate or complain when I'm about to accomplish the task for which I was born? Was I made for lying warm in bed under a pile of blankets?"\n\n"But I enjoy it here."\n\nWas it for enjoyment you were born? Are you designed to act or to be acted upon?\n\n\t\t\t\t\t\t\t\t\t\t - Marcus Aurelius`,
+    'In the morning, when you can\'t get out of bed, tell yourself: "I\'m getting up to do the work only a man can do. How can I possibly hesitate or complain when I\'m about to accomplish the task for which I was born? Was I made for lying warm in bed under a pile of blankets?"\n\n"But I enjoy it here."\n\nWas it for enjoyment you were born? Are you designed to act or to be acted upon?\n\n\t\t\t\t\t\t\t\t\t\t - Marcus Aurelius',
   );
   multilineTf.addToPage(page5, {
     x: fPadding * 3 + fWidth / 2 + fWidth * 2.5,

apps/deno/tests/test10.ts

@@ -9,30 +9,30 @@ import {
 
 // prettier-ignore
 const winAnsiCodePoints = [
-  0x0020, 0x0021, 0x0022, 0x0023, 0x0024, 0x0025, 0x0026, 0x0027, 0x0028, 
-  0x0029, 0x002a, 0x002b, 0x002c, 0x002d, 0x002e, 0x002f, 0x0030, 0x0031, 
-  0x0032, 0x0033, 0x0034, 0x0035, 0x0036, 0x0037, 0x0038, 0x0039, 0x003a, 
-  0x003b, 0x003c, 0x003d, 0x003e, 0x003f, 0x0040, 0x0041, 0x0042, 0x0043, 
-  0x0044, 0x0045, 0x0046, 0x0047, 0x0048, 0x0049, 0x004a, 0x004b, 0x004c, 
-  0x004d, 0x004e, 0x004f, 0x0050, 0x0051, 0x0052, 0x0053, 0x0054, 0x0055, 
-  0x0056, 0x0057, 0x0058, 0x0059, 0x005a, 0x005b, 0x005c, 0x005d, 0x005e, 
-  0x005f, 0x0060, 0x0061, 0x0062, 0x0063, 0x0064, 0x0065, 0x0066, 0x0067, 
-  0x0068, 0x0069, 0x006a, 0x006b, 0x006c, 0x006d, 0x006e, 0x006f, 0x0070, 
-  0x0071, 0x0072, 0x0073, 0x0074, 0x0075, 0x0076, 0x0077, 0x0078, 0x0079, 
-  0x007a, 0x007b, 0x007c, 0x007d, 0x007e, 0x00a0, 0x00a1, 0x00a2, 0x00a3, 
-  0x00a4, 0x00a5, 0x00a6, 0x00a7, 0x00a8, 0x00a9, 0x00aa, 0x00ab, 0x00ac, 
-  0x00ad, 0x00ae, 0x00af, 0x00b0, 0x00b1, 0x00b2, 0x00b3, 0x00b4, 0x00b5, 
-  0x00b6, 0x00b7, 0x00b8, 0x00b9, 0x00ba, 0x00bb, 0x00bc, 0x00bd, 0x00be, 
-  0x00bf, 0x00c0, 0x00c1, 0x00c2, 0x00c3, 0x00c4, 0x00c5, 0x00c6, 0x00c7, 
-  0x00c8, 0x00c9, 0x00ca, 0x00cb, 0x00cc, 0x00cd, 0x00ce, 0x00cf, 0x00d0, 
-  0x00d1, 0x00d2, 0x00d3, 0x00d4, 0x00d5, 0x00d6, 0x00d7, 0x00d8, 0x00d9, 
-  0x00da, 0x00db, 0x00dc, 0x00dd, 0x00de, 0x00df, 0x00e0, 0x00e1, 0x00e2, 
-  0x00e3, 0x00e4, 0x00e5, 0x00e6, 0x00e7, 0x00e8, 0x00e9, 0x00ea, 0x00eb, 
-  0x00ec, 0x00ed, 0x00ee, 0x00ef, 0x00f0, 0x00f1, 0x00f2, 0x00f3, 0x00f4, 
-  0x00f5, 0x00f6, 0x00f7, 0x00f8, 0x00f9, 0x00fa, 0x00fb, 0x00fc, 0x00fd, 
-  0x00fe, 0x00ff, 0x0152, 0x0153, 0x0160, 0x0161, 0x0178, 0x017d, 0x017e, 
-  0x0192, 0x02c6, 0x02dc, 0x2013, 0x2014, 0x2018, 0x2019, 0x201a, 0x201c, 
-  0x201d, 0x201e, 0x2020, 0x2021, 0x2022, 0x2026, 0x2030, 0x2039, 0x203a, 
+  0x0020, 0x0021, 0x0022, 0x0023, 0x0024, 0x0025, 0x0026, 0x0027, 0x0028,
+  0x0029, 0x002a, 0x002b, 0x002c, 0x002d, 0x002e, 0x002f, 0x0030, 0x0031,
+  0x0032, 0x0033, 0x0034, 0x0035, 0x0036, 0x0037, 0x0038, 0x0039, 0x003a,
+  0x003b, 0x003c, 0x003d, 0x003e, 0x003f, 0x0040, 0x0041, 0x0042, 0x0043,
+  0x0044, 0x0045, 0x0046, 0x0047, 0x0048, 0x0049, 0x004a, 0x004b, 0x004c,
+  0x004d, 0x004e, 0x004f, 0x0050, 0x0051, 0x0052, 0x0053, 0x0054, 0x0055,
+  0x0056, 0x0057, 0x0058, 0x0059, 0x005a, 0x005b, 0x005c, 0x005d, 0x005e,
+  0x005f, 0x0060, 0x0061, 0x0062, 0x0063, 0x0064, 0x0065, 0x0066, 0x0067,
+  0x0068, 0x0069, 0x006a, 0x006b, 0x006c, 0x006d, 0x006e, 0x006f, 0x0070,
+  0x0071, 0x0072, 0x0073, 0x0074, 0x0075, 0x0076, 0x0077, 0x0078, 0x0079,
+  0x007a, 0x007b, 0x007c, 0x007d, 0x007e, 0x00a0, 0x00a1, 0x00a2, 0x00a3,
+  0x00a4, 0x00a5, 0x00a6, 0x00a7, 0x00a8, 0x00a9, 0x00aa, 0x00ab, 0x00ac,
+  0x00ad, 0x00ae, 0x00af, 0x00b0, 0x00b1, 0x00b2, 0x00b3, 0x00b4, 0x00b5,
+  0x00b6, 0x00b7, 0x00b8, 0x00b9, 0x00ba, 0x00bb, 0x00bc, 0x00bd, 0x00be,
+  0x00bf, 0x00c0, 0x00c1, 0x00c2, 0x00c3, 0x00c4, 0x00c5, 0x00c6, 0x00c7,
+  0x00c8, 0x00c9, 0x00ca, 0x00cb, 0x00cc, 0x00cd, 0x00ce, 0x00cf, 0x00d0,
+  0x00d1, 0x00d2, 0x00d3, 0x00d4, 0x00d5, 0x00d6, 0x00d7, 0x00d8, 0x00d9,
+  0x00da, 0x00db, 0x00dc, 0x00dd, 0x00de, 0x00df, 0x00e0, 0x00e1, 0x00e2,
+  0x00e3, 0x00e4, 0x00e5, 0x00e6, 0x00e7, 0x00e8, 0x00e9, 0x00ea, 0x00eb,
+  0x00ec, 0x00ed, 0x00ee, 0x00ef, 0x00f0, 0x00f1, 0x00f2, 0x00f3, 0x00f4,
+  0x00f5, 0x00f6, 0x00f7, 0x00f8, 0x00f9, 0x00fa, 0x00fb, 0x00fc, 0x00fd,
+  0x00fe, 0x00ff, 0x0152, 0x0153, 0x0160, 0x0161, 0x0178, 0x017d, 0x017e,
+  0x0192, 0x02c6, 0x02dc, 0x2013, 0x2014, 0x2018, 0x2019, 0x201a, 0x201c,
+  0x201d, 0x201e, 0x2020, 0x2021, 0x2022, 0x2026, 0x2030, 0x2039, 0x203a,
   0x20ac, 0x2122,
 ];
 

apps/deno/tests/test12.ts

@@ -153,7 +153,7 @@ const thirdPage = async (pdfDoc: PDFDocument, assets: Assets) => {
     blendMode: BlendMode.Normal,
   });
 
-  page.drawText(`pdf-lib Blend Mode Test`, {
+  page.drawText('pdf-lib Blend Mode Test', {
     size: 24,
     x: 45,
     y: 735,

apps/deno/tests/test15.ts

@@ -1,12 +1,7 @@
 import { Assets } from '../index.ts';
 
 // @deno-types="../dummy.d.ts"
-import {
-  PDFDocument,
-  StandardFonts,
-  rgb,
-  TextAlignment,
-} from '../../../dist/pdf-lib.esm.js';
+import { PDFDocument, rgb, TextAlignment } from '../../../dist/pdf-lib.esm.js';
 
 export default async (assets: Assets) => {
   const pdfDoc = await PDFDocument.load(assets.pdfs.dod_character);
@@ -18,7 +13,7 @@ export default async (assets: Assets) => {
 
   form.getTextField('CharacterName 2').setText('Mario');
   form.getTextField('Age').setText('24 years');
-  form.getTextField('Height').setText(`5' 1"`);
+  form.getTextField('Height').setText('5\' 1"');
   form.getTextField('Weight').setText('196 lbs');
   form.getTextField('Eyes').setText('blue');
   form.getTextField('Skin').setText('white');
@@ -30,38 +25,38 @@ export default async (assets: Assets) => {
     .getTextField('Allies')
     .setText(
       [
-        `Allies:`,
-        `  • Princess Daisy`,
-        `  • Princess Peach`,
-        `  • Rosalina`,
-        `  • Geno`,
-        `  • Luigi`,
-        `  • Donkey Kong`,
-        `  • Yoshi`,
-        `  • Diddy Kong`,
-        ``,
-        `Organizations:`,
-        `  • Italian Plumbers Association`,
+        'Allies:',
+        '  • Princess Daisy',
+        '  • Princess Peach',
+        '  • Rosalina',
+        '  • Geno',
+        '  • Luigi',
+        '  • Donkey Kong',
+        '  • Yoshi',
+        '  • Diddy Kong',
+        '',
+        'Organizations:',
+        '  • Italian Plumbers Association',
       ].join('\n'),
     );
 
-  form.getTextField('FactionName').setText(`Mario's Emblem`);
+  form.getTextField('FactionName').setText("Mario's Emblem");
   form.getTextField('Faction Symbol Image').setImage(emblemImage);
 
   form
     .getTextField('Backstory')
     .setText(
-      `Mario is a fictional character in the Mario video game franchise, owned by Nintendo and created by Japanese video game designer Shigeru Miyamoto. Serving as the company's mascot and the eponymous protagonist of the series, Mario has appeared in over 200 video games since his creation. Depicted as a short, pudgy, Italian plumber who resides in the Mushroom Kingdom, his adventures generally center upon rescuing Princess Peach from the Koopa villain Bowser. His younger brother and sidekick is Luigi.`,
+      "Mario is a fictional character in the Mario video game franchise, owned by Nintendo and created by Japanese video game designer Shigeru Miyamoto. Serving as the company's mascot and the eponymous protagonist of the series, Mario has appeared in over 200 video games since his creation. Depicted as a short, pudgy, Italian plumber who resides in the Mushroom Kingdom, his adventures generally center upon rescuing Princess Peach from the Koopa villain Bowser. His younger brother and sidekick is Luigi.",
     );
 
   form
     .getTextField('Feat+Traits')
     .setText(
       [
-        `Mario can use three basic three power-ups:`,
-        `  • the Super Mushroom, which causes Mario to grow larger`,
-        `  • the Fire Flower, which allows Mario to throw fireballs`,
-        `  • the Starman, which gives Mario temporary invincibility`,
+        'Mario can use three basic three power-ups:',
+        '  • the Super Mushroom, which causes Mario to grow larger',
+        '  • the Fire Flower, which allows Mario to throw fireballs',
+        '  • the Starman, which gives Mario temporary invincibility',
       ].join('\n'),
     );
 

apps/deno/tests/test18.ts

@@ -71,7 +71,7 @@ const loadB = async (assets: Assets) => {
 
   form.getTextField('CharacterName 2').setText('Mario');
   form.getTextField('Age').setText('24 years');
-  form.getTextField('Height').setText(`5' 1"`);
+  form.getTextField('Height').setText('5\' 1"');
   form.getTextField('Weight').setText('196 lbs');
   form.getTextField('Eyes').setText('blue');
   form.getTextField('Skin').setText('white');

apps/deno/tests/test19.ts

@@ -0,0 +1,28 @@
+import { Assets } from '../index.ts';
+
+import { PDFDocument, StandardFonts } from '../../../dist/pdf-lib.esm.js';
+
+export default async (assets: Assets) => {
+  const pdfDoc = await PDFDocument.load(assets.pdfs.simple);
+  const snapshot = pdfDoc.takeSnapshot();
+  const page = pdfDoc.getPage(0);
+  snapshot.markRefForSave(page.ref);
+  const timesRomanFont = await pdfDoc.embedFont(StandardFonts.TimesRoman);
+  const fontSize = 30;
+  const { height } = page.getSize();
+  page.drawText('Incremental saving is also awesome!', {
+    x: 50,
+    y: height - 8 * fontSize,
+    size: fontSize,
+    font: timesRomanFont,
+  });
+
+  const pdfIncrementalBytes = await pdfDoc.saveIncremental(snapshot);
+
+  const pdfBytes = new Uint8Array([
+    ...assets.pdfs.simple,
+    ...pdfIncrementalBytes,
+  ]);
+
+  return pdfBytes;
+};