@adnsistemas/pdf-lib 2.6.4 → 2.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adnsistemas/pdf-lib",
-  "version": "2.6.4",
+  "version": "2.7.1",
   "description": "Create and modify PDF files with JavaScript",
   "author": "Andrew Dillon <andrew.dillon.j@gmail.com>",
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e",
@@ -42,7 +42,8 @@
     "Phakorn Kiong (https://github.com/PhakornKiong)",
     "Donald Ness (https://github.com/programmarchy)",
     "Remus DRAICA (https://github.com/remdra)",
-    "David Abdala (https://github.com/adnsistemas)"
+    "David Abdala (https://github.com/adnsistemas)",
+    "Eran Ohayon (https://github.com/erano067)"
   ],
   "scripts": {
     "release": "yarn release:prep && release-it",
@@ -100,8 +101,8 @@
     "yarn.lock"
   ],
   "dependencies": {
+    "@adnsistemas/upng": "^1.0.3",
     "@pdf-lib/standard-fonts": "^1.0.0",
-    "@pdf-lib/upng": "^1.0.1",
     "color": "^4.2.3",
     "crypto-js": "^4.2.0",
     "node-html-better-parser": "^1.4.0",

package/src/api/PDFDocument.ts

@@ -1697,6 +1697,66 @@ export default class PDFDocument {
       .filter((ov) => ov.actual || ov.previous.length);
   }
 
+  /**
+   * Saves the current changes to the document as an incremental update, returns the full document,
+   * like save method, and modifies the internal state to be able to continue editing the document
+   * for another incremental update.
+   * This allows you to save multiple incremental updates without reloading the PDF.
+   *
+   * For example:
+   * ```js
+   * const pdfDoc = await PDFDocument.load(pdfBytes, { forIncrementalUpdate: true })
+   *
+   * const page = pdfDoc.getPage(0)
+   * page.drawText('First update')
+   * const firstsave = await pdfDoc.saveAndContinue()
+   *
+   * page.drawText('Second update', { y: 100 })
+   * const secondsave = await pdfDoc.saveAndContinue()
+   * ```
+   *
+   * @param options The options to be used when saving changes.
+   * @returns Resolves with the complete PDF bytes including all updates.
+   */
+  async saveAndContinue(
+    options: IncrementalSaveOptions = {},
+  ): Promise<Uint8Array> {
+    if (!this.context.pdfFileDetails.originalBytes || !this.context.snapshot) {
+      throw new Error(
+        'saveAndContinue() requires the document to be loaded with forIncrementalUpdate: true',
+      );
+    }
+    const originalBytes = this.context.pdfFileDetails.originalBytes;
+    const incrementalBytes = await this.saveIncremental(
+      this.context.snapshot,
+      options,
+    );
+
+    const newPdfBytes = new Uint8Array(
+      originalBytes.byteLength + incrementalBytes.byteLength,
+    );
+    newPdfBytes.set(originalBytes);
+    newPdfBytes.set(incrementalBytes, originalBytes.byteLength);
+
+    this.context.pdfFileDetails.originalBytes = newPdfBytes;
+    this.context.pdfFileDetails.pdfSize = newPdfBytes.byteLength;
+
+    const incrementalStr = new TextDecoder('latin1').decode(incrementalBytes);
+    const startxrefMatch = incrementalStr.match(/startxref\s+(\d+)/);
+    if (startxrefMatch) {
+      this.context.pdfFileDetails.prevStartXRef = parseInt(
+        startxrefMatch[1],
+        10,
+      );
+    } else {
+      this.context.pdfFileDetails.prevStartXRef = originalBytes.byteLength;
+    }
+
+    this.context.snapshot = this.takeSnapshot();
+
+    return newPdfBytes;
+  }
+
   private async prepareForSave(options: SaveOptions): Promise<void> {
     const { addDefaultPage = true, updateFieldAppearances = true } = options;
 

package/src/api/PDFFont.ts

@@ -38,7 +38,7 @@ export default class PDFFont implements Embeddable {
   /** The name of this font. */
   readonly name: string;
 
-  private modified = true;
+  private alreadyEmbedded = false;
   private readonly embedder: FontEmbedder;
 
   private constructor(ref: PDFRef, doc: PDFDocument, embedder: FontEmbedder) {
@@ -68,7 +68,6 @@ export default class PDFFont implements Embeddable {
    */
   encodeText(text: string): PDFHexString {
     assertIs(text, 'text', ['string']);
-    this.modified = true;
     return this.embedder.encodeText(text);
   }
 
@@ -145,10 +144,9 @@ export default class PDFFont implements Embeddable {
    * @returns Resolves when the embedding is complete.
    */
   async embed(): Promise<void> {
-    // TODO: Cleanup orphan embedded objects if a font is embedded multiple times...
-    if (this.modified) {
+    if (!this.alreadyEmbedded) {
       await this.embedder.embedIntoContext(this.doc.context, this.ref);
-      this.modified = false;
+      this.alreadyEmbedded = true;
     }
   }
 }

package/src/core/PDFContext.ts

@@ -429,7 +429,48 @@ class PDFContext {
   }
 
   registerObjectChange(obj: PDFObject) {
-    if (this.snapshot) this.snapshot.markObjForSave(obj);
+    if (!this.snapshot) return;
+
+    const ref = this.getObjectRef(obj);
+    if (ref) {
+      this.snapshot.markRefForSave(ref);
+      return;
+    }
+
+    const containingRef = this.findContainingIndirectObject(obj);
+    if (containingRef) {
+      this.snapshot.markRefForSave(containingRef);
+    }
+  }
+
+  private findContainingIndirectObject(target: PDFObject): PDFRef | undefined {
+    const entries = Array.from(this.indirectObjects.entries());
+    for (let idx = 0, len = entries.length; idx < len; idx++) {
+      const [ref, object] = entries[idx];
+      if (this.objectContains(object, target)) {
+        return ref;
+      }
+    }
+    return undefined;
+  }
+
+  private objectContains(container: PDFObject, target: PDFObject): boolean {
+    if (container === target) return true;
+
+    if (container instanceof PDFDict) {
+      const values = container.values();
+      for (let i = 0, len = values.length; i < len; i++) {
+        if (this.objectContains(values[i], target)) return true;
+      }
+    } else if (container instanceof PDFArray) {
+      for (let i = 0, len = container.size(); i < len; i++) {
+        if (this.objectContains(container.get(i), target)) return true;
+      }
+    } else if (container instanceof PDFStream) {
+      if (this.objectContains(container.dict, target)) return true;
+    }
+
+    return false;
   }
 
   getObjectVersions(ref: PDFRef): PDFObject[] {

package/src/core/objects/PDFArray.ts

@@ -30,10 +30,12 @@ class PDFArray extends PDFObject {
   }
 
   push(object: PDFObject): void {
+    this.registerChange();
     this.array.push(object);
   }
 
   insert(index: number, object: PDFObject): void {
+    this.registerChange();
     this.array.splice(index, 0, object);
   }
 
@@ -43,10 +45,12 @@ class PDFArray extends PDFObject {
   }
 
   remove(index: number): void {
+    this.registerChange();
     this.array.splice(index, 1);
   }
 
   set(idx: number, object: PDFObject): void {
+    this.registerChange();
     this.array[idx] = object;
   }
 
@@ -180,6 +184,10 @@ class PDFArray extends PDFObject {
       }
     }
   }
+
+  registerChange(): void {
+    this.context.registerObjectChange(this);
+  }
 }
 
 export default PDFArray;

package/src/core/objects/PDFRawStream.ts

@@ -45,6 +45,7 @@ class PDFRawStream extends PDFStream {
   }
 
   updateContents(contents: Uint8Array): void {
+    this.dict.registerChange();
     this.contents = contents;
   }
 }

package/src/utils/png.ts

@@ -1,4 +1,4 @@
-import UPNG from '@pdf-lib/upng';
+import UPNG from '@adnsistemas/upng';
 
 const getImageType = (ctype: number) => {
   if (ctype === 0) return PngType.Greyscale;

package/ts3.4/cjs/api/PDFDocument.d.ts

@@ -842,6 +842,28 @@ export default class PDFDocument {
      * @returns  {PDFObjectVersions[]} Objects modified in the update, and previous versions
      */
     getChangedObjects(lastUpdateMinusX?: number): PDFObjectVersions[];
+    /**
+     * Saves the current changes to the document as an incremental update, returns the full document,
+     * like save method, and modifies the internal state to be able to continue editing the document
+     * for another incremental update.
+     * This allows you to save multiple incremental updates without reloading the PDF.
+     *
+     * For example:
+     * ```js
+     * const pdfDoc = await PDFDocument.load(pdfBytes, { forIncrementalUpdate: true })
+     *
+     * const page = pdfDoc.getPage(0)
+     * page.drawText('First update')
+     * const firstsave = await pdfDoc.saveAndContinue()
+     *
+     * page.drawText('Second update', { y: 100 })
+     * const secondsave = await pdfDoc.saveAndContinue()
+     * ```
+     *
+     * @param options The options to be used when saving changes.
+     * @returns Resolves with the complete PDF bytes including all updates.
+     */
+    saveAndContinue(options?: IncrementalSaveOptions): Promise<Uint8Array>;
     private prepareForSave;
     private embedAll;
     private updateInfoDict;

package/ts3.4/cjs/api/PDFFont.d.ts

@@ -25,7 +25,7 @@ export default class PDFFont implements Embeddable {
     readonly doc: PDFDocument;
     /** The name of this font. */
     readonly name: string;
-    private modified;
+    private alreadyEmbedded;
     private readonly embedder;
     private constructor();
     /**

package/ts3.4/cjs/core/PDFContext.d.ts

@@ -119,6 +119,8 @@ declare class PDFContext {
     getPopGraphicsStateContentStream(): PDFRef;
     addRandomSuffix(prefix: string, suffixLength?: number): string;
     registerObjectChange(obj: PDFObject): void;
+    private findContainingIndirectObject;
+    private objectContains;
     getObjectVersions(ref: PDFRef): PDFObject[];
     listXrefEntries(xrefIndex?: number): Entry[];
 }

package/ts3.4/cjs/core/objects/PDFArray.d.ts

@@ -59,6 +59,7 @@ declare class PDFArray extends PDFObject {
     sizeInBytes(): number;
     copyBytesInto(buffer: Uint8Array, offset: number): number;
     scalePDFNumbers(x: number, y: number): void;
+    registerChange(): void;
 }
 export default PDFArray;
 //# sourceMappingURL=PDFArray.d.ts.map

package/ts3.4/es/api/PDFDocument.d.ts

@@ -842,6 +842,28 @@ export default class PDFDocument {
      * @returns  {PDFObjectVersions[]} Objects modified in the update, and previous versions
      */
     getChangedObjects(lastUpdateMinusX?: number): PDFObjectVersions[];
+    /**
+     * Saves the current changes to the document as an incremental update, returns the full document,
+     * like save method, and modifies the internal state to be able to continue editing the document
+     * for another incremental update.
+     * This allows you to save multiple incremental updates without reloading the PDF.
+     *
+     * For example:
+     * ```js
+     * const pdfDoc = await PDFDocument.load(pdfBytes, { forIncrementalUpdate: true })
+     *
+     * const page = pdfDoc.getPage(0)
+     * page.drawText('First update')
+     * const firstsave = await pdfDoc.saveAndContinue()
+     *
+     * page.drawText('Second update', { y: 100 })
+     * const secondsave = await pdfDoc.saveAndContinue()
+     * ```
+     *
+     * @param options The options to be used when saving changes.
+     * @returns Resolves with the complete PDF bytes including all updates.
+     */
+    saveAndContinue(options?: IncrementalSaveOptions): Promise<Uint8Array>;
     private prepareForSave;
     private embedAll;
     private updateInfoDict;

package/ts3.4/es/api/PDFFont.d.ts

@@ -25,7 +25,7 @@ export default class PDFFont implements Embeddable {
     readonly doc: PDFDocument;
     /** The name of this font. */
     readonly name: string;
-    private modified;
+    private alreadyEmbedded;
     private readonly embedder;
     private constructor();
     /**

package/ts3.4/es/core/PDFContext.d.ts

@@ -119,6 +119,8 @@ declare class PDFContext {
     getPopGraphicsStateContentStream(): PDFRef;
     addRandomSuffix(prefix: string, suffixLength?: number): string;
     registerObjectChange(obj: PDFObject): void;
+    private findContainingIndirectObject;
+    private objectContains;
     getObjectVersions(ref: PDFRef): PDFObject[];
     listXrefEntries(xrefIndex?: number): Entry[];
 }

package/ts3.4/es/core/objects/PDFArray.d.ts

@@ -59,6 +59,7 @@ declare class PDFArray extends PDFObject {
     sizeInBytes(): number;
     copyBytesInto(buffer: Uint8Array, offset: number): number;
     scalePDFNumbers(x: number, y: number): void;
+    registerChange(): void;
 }
 export default PDFArray;
 //# sourceMappingURL=PDFArray.d.ts.map