pdf-lite 1.5.0 → 1.6.1

package/dist/pdf/pdf-document.d.ts

@@ -4,16 +4,15 @@ import { PdfIndirectObject } from '../core/objects/pdf-indirect-object.js';
 import { PdfComment } from '../core/objects/pdf-comment.js';
 import { PdfToken } from '../core/tokens/token.js';
 import { PdfDictionary } from '../core/objects/pdf-dictionary.js';
-import { PdfObjectReference } from '../core/objects/pdf-object-reference.js';
+import { IPdfObjectResolver, PdfObjectReference } from '../core/objects/pdf-object-reference.js';
 import { PdfXrefLookup } from './pdf-xref-lookup.js';
 import { PdfRevision } from './pdf-revision.js';
 import { PdfEncryptionDictionaryObject } from '../security/types.js';
 import { PdfTrailerEntries } from '../core/objects/pdf-trailer.js';
-import { PdfDocumentSecurityStoreObject } from '../signing/document-security-store.js';
 import { ByteArray } from '../types.js';
 import { PdfDocumentVerificationResult, PdfSigner } from '../signing/signer.js';
-import { PdfAcroFormManager } from '../acroform/manager.js';
-import { PdfFontManager } from '../fonts/manager.js';
+import { PdfAcroForm } from '../acroform/pdf-acro-form.js';
+import { PdfPages } from './pdf-pages.js';
 /**
  * Represents a PDF document with support for reading, writing, and modifying PDF files.
  * Handles document structure, revisions, encryption, and digital signatures.
@@ -31,18 +30,23 @@ import { PdfFontManager } from '../fonts/manager.js';
  * await document.commit()
  * ```
  */
-export declare class PdfDocument extends PdfObject {
+export declare class PdfDocument extends PdfObject implements IPdfObjectResolver {
     /** List of document revisions for incremental updates */
     revisions: PdfRevision[];
     /** Signer instance for digital signature operations */
     signer: PdfSigner;
     /** Security handler for encryption/decryption operations */
     securityHandler?: PdfSecurityHandler;
-    /**  */
-    readonly acroForm: PdfAcroFormManager;
-    readonly fonts: PdfFontManager;
+    /** Whether the document is currently in incremental mode (appending changes as a new revision) */
+    private incremental;
+    private originalSecurityHandler?;
     private hasEncryptionDictionary?;
-    private toBeCommitted;
+    private _resolvedCache;
+    private _objStreamCache;
+    private _committing;
+    private _updating;
+    private _finalized;
+    private _signed;
     /**
      * Creates a new PDF document instance.
      *
@@ -62,6 +66,9 @@ export declare class PdfDocument extends PdfObject {
         securityHandler?: PdfSecurityHandler;
         signer?: PdfSigner;
     });
+    resolve(objectNumber: number, generationNumber: number): PdfIndirectObject;
+    get acroform(): PdfAcroForm | null;
+    get pages(): PdfPages;
     get header(): PdfComment | undefined;
     set header(comment: PdfComment | undefined);
     /**
@@ -79,6 +86,7 @@ export declare class PdfDocument extends PdfObject {
      * @returns The document instance for method chaining
      */
     startNewRevision(): PdfDocument;
+    hasObjectInLatestRevision(obj: PdfObject): boolean;
     /**
      * Adds objects to the document's latest revision.
      * Automatically starts a new revision if the current one is locked.
@@ -142,6 +150,7 @@ export declare class PdfDocument extends PdfObject {
      * @returns The metadata stream reference or undefined if not present
      */
     get metadataStreamReference(): PdfObjectReference | undefined;
+    resetSecurityHandler(): void;
     private getSecurityHandler;
     private initSecurityHandler;
     /**
@@ -166,14 +175,28 @@ export declare class PdfDocument extends PdfObject {
      */
     hasObject(obj: PdfObject): boolean;
     private isObjectEncryptable;
+    commitIncrementalUpdates(): void;
+    /**
+     * Decrypts all encrypted object data in-place without removing
+     * the encryption infrastructure. Useful in incremental mode where
+     * the original (encrypted) bytes are preserved via cached tokens
+     * but the live object data needs to be readable.
+     */
+    decryptObjects(): Promise<void>;
+    /**
+     * Re-encrypts all objects and updates the document structure.
+     * No-op if the document has no security handler (unencrypted document).
+     */
+    finalize(): Promise<void>;
     /**
      * Decrypts all encrypted objects in the document.
      * Removes the security handler and encryption dictionary after decryption.
      */
     decrypt(): Promise<void>;
     /**
-     * Encrypts all objects in the document using the security handler.
-     * Creates and adds an encryption dictionary to all revisions.
+     * Encrypts all encryptable objects using the security handler.
+     * Re-uses the existing encryption dictionary or creates one if needed,
+     * propagating it to all revisions.
      */
     encrypt(): Promise<void>;
     /**
@@ -186,7 +209,7 @@ export declare class PdfDocument extends PdfObject {
     findCompressedObject(options: {
         objectNumber: number;
         generationNumber?: number;
-    } | PdfObjectReference): Promise<PdfIndirectObject | undefined>;
+    } | PdfObjectReference): PdfIndirectObject | undefined;
     /**
      * Finds an uncompressed indirect object by its object number.
      *
@@ -212,13 +235,21 @@ export declare class PdfDocument extends PdfObject {
         objectNumber: number;
         generationNumber?: number;
         allowUnindexed?: boolean;
-    }): Promise<PdfIndirectObject | undefined>;
+        cloned?: boolean;
+    }): PdfIndirectObject | undefined;
+    /**
+     * Finds the revision that contains a given PDF object.
+     * Useful for determining the origin of an object across multiple revisions.
+     * @param obj - The PDF object to find the revision for
+     * @returns The PdfRevision that contains the object, or undefined if not found in any revision
+     */
+    findRevisionForObject(obj: PdfObject): PdfRevision | undefined;
     /**
      * Deletes an object from all revisions in the document.
      *
      * @param obj - The PDF object to delete
      */
-    deleteObject(obj: PdfObject | undefined): Promise<void>;
+    deleteObject(obj: PdfObject | undefined): void;
     /**
      * Sets the PDF version for the document.
      *
@@ -239,22 +270,6 @@ export declare class PdfDocument extends PdfObject {
      * @returns True if all revisions are locked for incremental updates
      */
     isIncremental(): boolean;
-    /**
-     * Commits pending objects to the document.
-     * Adds objects, applies encryption if configured, and updates the document structure.
-     *
-     * @param newObjects - Additional objects to add before committing
-     */
-    commit(...newObjects: PdfObject[]): Promise<void>;
-    private ensureEncryptionDictionary;
-    /**
-     * Sets the Document Security Store (DSS) for the document.
-     * Used for long-term validation of digital signatures.
-     *
-     * @param dss - The Document Security Store object to set
-     * @throws Error if the document has no root dictionary
-     */
-    setDocumentSecurityStore(dss: PdfDocumentSecurityStoreObject): Promise<void>;
     /**
      * Returns tokens paired with their source objects.
      * Useful for debugging and analysis of document structure.
@@ -266,23 +281,30 @@ export declare class PdfDocument extends PdfObject {
         object: PdfObject | undefined;
     }[];
     protected tokenize(): PdfToken[];
+    private wireResolvers;
+    private collectMissingReferences;
     private linkRevisions;
     private linkOffsets;
     private calculateOffsets;
     private updateRevisions;
+    /**
+     * Performs a full update cycle to ensure all revisions are consistent and offsets are correct.
+     */
     private update;
+    /**
+     * Walks all objects in the document and registers any newly created
+     * PdfIndirectObjects that are referenced but not yet part of the document
+     * (e.g. appearance streams created by generateAppearance).
+     */
+    private registerNewReferences;
+    private flushResolvedCache;
+    sign(): Promise<void>;
     /**
      * Serializes the document to a byte array.
      *
      * @returns The PDF document as a Uint8Array
      */
     toBytes(): ByteArray;
-    /**
-     * Serializes the document to a Base64-encoded string.
-     *
-     * @returns A promise that resolves to the PDF document as a Base64 string
-     */
-    toBase64(): string;
     /**
      * Creates a deep copy of the document.
      *
@@ -295,7 +317,11 @@ export declare class PdfDocument extends PdfObject {
      * @param input - Async or sync iterable of byte arrays
      * @returns A promise that resolves to the parsed PdfDocument
      */
-    static fromBytes(input: AsyncIterable<ByteArray> | Iterable<ByteArray>): Promise<PdfDocument>;
+    static fromBytes(input: AsyncIterable<ByteArray> | Iterable<ByteArray>, options?: {
+        password?: string;
+        ownerPassword?: string;
+        incremental?: boolean;
+    }): Promise<PdfDocument>;
     isModified(): boolean;
     /**
      * Verifies all digital signatures in the document.