@adnsistemas/pdf-lib 2.7.2 → 2.8.0

package/src/core/structures/PDFCatalog.ts

@@ -5,6 +5,7 @@ import PDFContext from '../PDFContext';
 import PDFPageTree from './PDFPageTree';
 import { PDFAcroForm } from '../acroform';
 import ViewerPreferences from '../interactive/ViewerPreferences';
+import PDFArray from '../objects/PDFArray';
 
 class PDFCatalog extends PDFDict {
   static withContextAndPages = (
@@ -28,6 +29,14 @@ class PDFCatalog extends PDFDict {
     return this.lookupMaybe(PDFName.of('AcroForm'), PDFDict);
   }
 
+  Names(): PDFDict | undefined {
+    return this.lookupMaybe(PDFName.of('Names'), PDFDict);
+  }
+
+  AttachedFiles(): PDFArray | undefined {
+    return this.lookupMaybe(PDFName.of('AF'), PDFArray);
+  }
+
   getAcroForm(): PDFAcroForm | undefined {
     const dict = this.AcroForm();
     if (!dict) return undefined;

package/src/core/writers/PDFWriter.ts

@@ -62,27 +62,48 @@ class PDFWriter {
    */
   protected _largestSkippedObjectNum: number = 0;
 
+  /**
+   * Used to check wheter an object should be saved or not, preserves the object number of the
+   * last XRef Stream object, if there is one.
+   */
+  protected _lastXRefObjectNumber: number = 0;
   /**
    * For incremental saves, defers the decision to the snapshot.
-   * For full saves, checks that the object is not an XRef stream object.
+   * For full saves, checks that the object is not the last XRef stream object.
    * @param {boolean} incremental If making an incremental save, or a full save of the PDF
    * @param {number} objNum Object number
-   * @param {PDFObject} object PDFObject used to check if it is an XRef stream, when not 'incremental' saving
+   * @param {[PDFRef, PDFObject][]} objects List of objects that form the PDF
    * @returns {boolean} whether the object should be saved or not
    */
   protected shouldSave(
     incremental: boolean,
     objNum: number,
-    object: PDFObject,
+    objects: [PDFRef, PDFObject][],
   ): boolean {
     let should = true;
     if (incremental) {
       should = this.snapshot.shouldSave(objNum);
     } else {
-      should = !(
-        object instanceof PDFRawStream &&
-        object.dict.lookup(PDFName.of('Type')) === PDFName.of('XRef')
-      );
+      // only the last XRef Stream will be regenerated on save
+      if (!this._lastXRefObjectNumber) {
+        // if no XRef Stream, then nothing should be skipped
+        this._lastXRefObjectNumber = this.context.largestObjectNumber + 1;
+        const checkWatermark = this._lastXRefObjectNumber - 10; // max number of objects in the final part of the PDF to check
+        // search the last XRef Stream, if there is one, objects are expected to be in object number order
+        for (let idx = objects.length - 1; idx > 0; idx--) {
+          // if not in last 'rangeToCheck' objects, there is none that should be skipped, most probably a linearized PDF, or without XRef Streams
+          if (objects[idx][0].objectNumber < checkWatermark) break;
+          const object = objects[idx][1];
+          if (
+            object instanceof PDFRawStream &&
+            object.dict.lookup(PDFName.of('Type')) === PDFName.of('XRef')
+          ) {
+            this._lastXRefObjectNumber = objects[idx][0].objectNumber;
+            break;
+          }
+        }
+      }
+      should = objNum !== this._lastXRefObjectNumber;
     }
     if (!should && this._largestSkippedObjectNum < objNum)
       this._largestSkippedObjectNum = objNum;
@@ -106,7 +127,7 @@ class PDFWriter {
     for (let idx = 0, len = indirectObjects.length; idx < len; idx++) {
       const [ref, object] = indirectObjects[idx];
 
-      if (!this.shouldSave(incremental, ref.objectNumber, object)) {
+      if (!this.shouldSave(incremental, ref.objectNumber, indirectObjects)) {
         continue;
       }
 
@@ -189,6 +210,7 @@ class PDFWriter {
     incremental: boolean,
   ): Promise<SerializationInfo> {
     this._largestSkippedObjectNum = 0;
+    this._lastXRefObjectNumber = 0;
     const header = PDFHeader.forVersion(1, 7);
 
     let size = this.snapshot.pdfSize;
@@ -206,7 +228,8 @@ class PDFWriter {
     for (let idx = 0, len = indirectObjects.length; idx < len; idx++) {
       const indirectObject = indirectObjects[idx];
       const [ref, object] = indirectObject;
-      if (!this.shouldSave(incremental, ref.objectNumber, object)) continue;
+      if (!this.shouldSave(incremental, ref.objectNumber, indirectObjects))
+        continue;
       if (security) this.encrypt(ref, object, security);
       xref.addEntry(ref, size);
       size += this.computeIndirectObjectSize(indirectObject);

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

@@ -4,17 +4,18 @@ import PDFImage from './PDFImage';
 import PDFPage from './PDFPage';
 import PDFForm from './form/PDFForm';
 import { StandardFonts } from './StandardFonts';
-import { PageBoundingBox, PDFCatalog, PDFContext } from '../core';
+import { PageBoundingBox, PDFCatalog, PDFContext, PDFDict } from '../core';
 import { AttachmentOptions, SaveOptions, Base64SaveOptions, LoadOptions, CreateOptions, EmbedFontOptions, SetTitleOptions, IncrementalSaveOptions } from './PDFDocumentOptions';
 import PDFObject from '../core/objects/PDFObject';
 import PDFRef from '../core/objects/PDFRef';
 import { Fontkit } from '../types/fontkit';
 import { TransformationMatrix } from '../types/matrix';
 import { AFRelationship } from '../core/embedders/FileEmbedder';
+import PDFEmbeddedFile from './PDFEmbeddedFile';
 import PDFSvg from './PDFSvg';
 import { SecurityOptions } from '../core/security/PDFSecurity';
 import { DocumentSnapshot } from './snapshot';
-export type PDFAttachment = {
+export type BasePDFAttachment = {
     name: string;
     data: Uint8Array;
     mimeType: string | undefined;
@@ -23,6 +24,14 @@ export type PDFAttachment = {
     creationDate: Date | undefined;
     modificationDate: Date | undefined;
 };
+export type SavedPDFAttachment = BasePDFAttachment & {
+    embeddedFileDict: PDFDict;
+    specRef: PDFRef;
+};
+export type UnsavedPDFAttachment = BasePDFAttachment & {
+    pdfEmbeddedFile: PDFEmbeddedFile;
+};
+export type PDFAttachment = UnsavedPDFAttachment | SavedPDFAttachment;
 export type PDFObjectVersions = {
     ref: PDFRef;
     actual: PDFObject | undefined;
@@ -575,6 +584,11 @@ export default class PDFDocument {
      * @returns Array of attachments with name and data
      */
     getAttachments(): PDFAttachment[];
+    /**
+     * Removes an attachment from PDF, based on name.
+     * @param {string} name Name of the attachmet to remove.
+     */
+    detach(name: string): void;
     /**
      * Embed a font into this document. The input data can be provided in multiple
      * formats:

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

@@ -40,5 +40,11 @@ export default class PDFEmbeddedFile implements Embeddable {
      * @returns the embedder.
      */
     getEmbedder(): FileEmbedder;
+    /**
+     * Returns whether or not this file has already been embedded.
+     * @returns true if the file has already been embedded, false otherwise.
+     */
+    getAlreadyEmbedded(): boolean;
+    getRef(): PDFRef;
 }
 //# sourceMappingURL=PDFEmbeddedFile.d.ts.map

package/ts3.4/cjs/api/snapshot/IncrementalDocumentSnapshot.d.ts

@@ -8,7 +8,7 @@ export declare class IncrementalDocumentSnapshot implements DocumentSnapshot {
     private lastObjectNumber;
     private changedObjects;
     context: PDFContext;
-    constructor(lastObjectNumber: number, indirectObjects: number[], pdfSize: number, prevStartXRef: number, context: PDFContext);
+    constructor(lastObjectNumber: number, indirectObjects: Set<number>, pdfSize: number, prevStartXRef: number, context: PDFContext);
     shouldSave(objectNumber: number): boolean;
     markRefForSave(ref: PDFRef): void;
     markRefsForSave(refs: PDFRef[]): void;

package/ts3.4/cjs/core/structures/PDFCatalog.d.ts

@@ -4,11 +4,14 @@ import PDFContext from '../PDFContext';
 import PDFPageTree from './PDFPageTree';
 import { PDFAcroForm } from '../acroform';
 import ViewerPreferences from '../interactive/ViewerPreferences';
+import PDFArray from '../objects/PDFArray';
 declare class PDFCatalog extends PDFDict {
     static withContextAndPages: (context: PDFContext, pages: PDFPageTree | PDFRef) => PDFCatalog;
     static fromMapWithContext: (map: DictMap, context: PDFContext) => PDFCatalog;
     Pages(): PDFPageTree;
     AcroForm(): PDFDict | undefined;
+    Names(): PDFDict | undefined;
+    AttachedFiles(): PDFArray | undefined;
     getAcroForm(): PDFAcroForm | undefined;
     getOrCreateAcroForm(): PDFAcroForm;
     ViewerPreferences(): PDFDict | undefined;

package/ts3.4/cjs/core/writers/PDFWriter.d.ts

@@ -33,15 +33,23 @@ declare class PDFWriter {
      * be corrected, to be accurate.
      */
     protected _largestSkippedObjectNum: number;
+    /**
+     * Used to check wheter an object should be saved or not, preserves the object number of the
+     * last XRef Stream object, if there is one.
+     */
+    protected _lastXRefObjectNumber: number;
     /**
      * For incremental saves, defers the decision to the snapshot.
-     * For full saves, checks that the object is not an XRef stream object.
+     * For full saves, checks that the object is not the last XRef stream object.
      * @param {boolean} incremental If making an incremental save, or a full save of the PDF
      * @param {number} objNum Object number
-     * @param {PDFObject} object PDFObject used to check if it is an XRef stream, when not 'incremental' saving
+     * @param {[PDFRef, PDFObject][]} objects List of objects that form the PDF
      * @returns {boolean} whether the object should be saved or not
      */
-    protected shouldSave(incremental: boolean, objNum: number, object: PDFObject): boolean;
+    protected shouldSave(incremental: boolean, objNum: number, objects: [
+        PDFRef,
+        PDFObject
+    ][]): boolean;
     serializeToBuffer(): Promise<Uint8Array>;
     protected computeIndirectObjectSize([ref, object]: [
         PDFRef,

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

@@ -4,17 +4,18 @@ import PDFImage from './PDFImage';
 import PDFPage from './PDFPage';
 import PDFForm from './form/PDFForm';
 import { StandardFonts } from './StandardFonts';
-import { PageBoundingBox, PDFCatalog, PDFContext } from '../core';
+import { PageBoundingBox, PDFCatalog, PDFContext, PDFDict } from '../core';
 import { AttachmentOptions, SaveOptions, Base64SaveOptions, LoadOptions, CreateOptions, EmbedFontOptions, SetTitleOptions, IncrementalSaveOptions } from './PDFDocumentOptions';
 import PDFObject from '../core/objects/PDFObject';
 import PDFRef from '../core/objects/PDFRef';
 import { Fontkit } from '../types/fontkit';
 import { TransformationMatrix } from '../types/matrix';
 import { AFRelationship } from '../core/embedders/FileEmbedder';
+import PDFEmbeddedFile from './PDFEmbeddedFile';
 import PDFSvg from './PDFSvg';
 import { SecurityOptions } from '../core/security/PDFSecurity';
 import { DocumentSnapshot } from './snapshot';
-export type PDFAttachment = {
+export type BasePDFAttachment = {
     name: string;
     data: Uint8Array;
     mimeType: string | undefined;
@@ -23,6 +24,14 @@ export type PDFAttachment = {
     creationDate: Date | undefined;
     modificationDate: Date | undefined;
 };
+export type SavedPDFAttachment = BasePDFAttachment & {
+    embeddedFileDict: PDFDict;
+    specRef: PDFRef;
+};
+export type UnsavedPDFAttachment = BasePDFAttachment & {
+    pdfEmbeddedFile: PDFEmbeddedFile;
+};
+export type PDFAttachment = UnsavedPDFAttachment | SavedPDFAttachment;
 export type PDFObjectVersions = {
     ref: PDFRef;
     actual: PDFObject | undefined;
@@ -575,6 +584,11 @@ export default class PDFDocument {
      * @returns Array of attachments with name and data
      */
     getAttachments(): PDFAttachment[];
+    /**
+     * Removes an attachment from PDF, based on name.
+     * @param {string} name Name of the attachmet to remove.
+     */
+    detach(name: string): void;
     /**
      * Embed a font into this document. The input data can be provided in multiple
      * formats:

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

@@ -40,5 +40,11 @@ export default class PDFEmbeddedFile implements Embeddable {
      * @returns the embedder.
      */
     getEmbedder(): FileEmbedder;
+    /**
+     * Returns whether or not this file has already been embedded.
+     * @returns true if the file has already been embedded, false otherwise.
+     */
+    getAlreadyEmbedded(): boolean;
+    getRef(): PDFRef;
 }
 //# sourceMappingURL=PDFEmbeddedFile.d.ts.map

package/ts3.4/es/api/snapshot/IncrementalDocumentSnapshot.d.ts

@@ -8,7 +8,7 @@ export declare class IncrementalDocumentSnapshot implements DocumentSnapshot {
     private lastObjectNumber;
     private changedObjects;
     context: PDFContext;
-    constructor(lastObjectNumber: number, indirectObjects: number[], pdfSize: number, prevStartXRef: number, context: PDFContext);
+    constructor(lastObjectNumber: number, indirectObjects: Set<number>, pdfSize: number, prevStartXRef: number, context: PDFContext);
     shouldSave(objectNumber: number): boolean;
     markRefForSave(ref: PDFRef): void;
     markRefsForSave(refs: PDFRef[]): void;

package/ts3.4/es/core/structures/PDFCatalog.d.ts

@@ -4,11 +4,14 @@ import PDFContext from '../PDFContext';
 import PDFPageTree from './PDFPageTree';
 import { PDFAcroForm } from '../acroform';
 import ViewerPreferences from '../interactive/ViewerPreferences';
+import PDFArray from '../objects/PDFArray';
 declare class PDFCatalog extends PDFDict {
     static withContextAndPages: (context: PDFContext, pages: PDFPageTree | PDFRef) => PDFCatalog;
     static fromMapWithContext: (map: DictMap, context: PDFContext) => PDFCatalog;
     Pages(): PDFPageTree;
     AcroForm(): PDFDict | undefined;
+    Names(): PDFDict | undefined;
+    AttachedFiles(): PDFArray | undefined;
     getAcroForm(): PDFAcroForm | undefined;
     getOrCreateAcroForm(): PDFAcroForm;
     ViewerPreferences(): PDFDict | undefined;

package/ts3.4/es/core/writers/PDFWriter.d.ts

@@ -33,15 +33,23 @@ declare class PDFWriter {
      * be corrected, to be accurate.
      */
     protected _largestSkippedObjectNum: number;
+    /**
+     * Used to check wheter an object should be saved or not, preserves the object number of the
+     * last XRef Stream object, if there is one.
+     */
+    protected _lastXRefObjectNumber: number;
     /**
      * For incremental saves, defers the decision to the snapshot.
-     * For full saves, checks that the object is not an XRef stream object.
+     * For full saves, checks that the object is not the last XRef stream object.
      * @param {boolean} incremental If making an incremental save, or a full save of the PDF
      * @param {number} objNum Object number
-     * @param {PDFObject} object PDFObject used to check if it is an XRef stream, when not 'incremental' saving
+     * @param {[PDFRef, PDFObject][]} objects List of objects that form the PDF
      * @returns {boolean} whether the object should be saved or not
      */
-    protected shouldSave(incremental: boolean, objNum: number, object: PDFObject): boolean;
+    protected shouldSave(incremental: boolean, objNum: number, objects: [
+        PDFRef,
+        PDFObject
+    ][]): boolean;
     serializeToBuffer(): Promise<Uint8Array>;
     protected computeIndirectObjectSize([ref, object]: [
         PDFRef,