pdf-lite 1.6.4 → 1.7.0

package/dist/acroform/xfa/pdf-xfa-data.js

@@ -1,4 +1,5 @@
 import { PdfIndirectObject } from '../../core/objects/pdf-indirect-object.js';
+import { Xml } from '../../utils/xml.js';
 /**
  * Wraps an XFA datasets stream as a typed PDF indirect object.
  * Provides methods to read/write XML and update individual field values.
@@ -26,15 +27,10 @@ export class PdfXfaData extends PdfIndirectObject {
         this.xml = xml;
     }
     getFieldValue(name) {
-        const xml = this.xml;
-        const segments = name.split('.');
-        const leafSegment = segments[segments.length - 1];
-        const leafName = leafSegment.replace(/\[\d+\]$/, '');
-        if (leafName.startsWith('#'))
+        const leafName = PdfXfaData.leafName(name);
+        if (!leafName)
             return null;
-        const contentRegex = new RegExp(`<${PdfXfaData.escapeRegex(leafName)}(?:\\s[^>]*)?>([\\s\\S]*?)</${PdfXfaData.escapeRegex(leafName)}\\s*>`);
-        const match = xml.match(contentRegex);
-        return match ? match[1] : null;
+        return Xml.getElementContent(this.xml, leafName);
     }
     importData(fields) {
         for (const field in fields) {
@@ -45,28 +41,40 @@ export class PdfXfaData extends PdfIndirectObject {
         }
     }
     static updateFieldValue(xml, fieldName, value) {
-        const segments = fieldName.split('.');
-        const leafSegment = segments[segments.length - 1];
-        const leafName = leafSegment.replace(/\[\d+\]$/, '');
-        if (leafName.startsWith('#'))
+        const leaf = PdfXfaData.leafName(fieldName);
+        if (!leaf)
             return xml;
-        const escapedValue = value
-            .replace(/&/g, '&amp;')
-            .replace(/</g, '&lt;')
-            .replace(/>/g, '&gt;')
-            .replace(/"/g, '&quot;')
-            .replace(/'/g, '&apos;');
-        const selfClosingRegex = new RegExp(`<${PdfXfaData.escapeRegex(leafName)}\\s*/>`);
-        if (selfClosingRegex.test(xml)) {
-            return xml.replace(selfClosingRegex, `<${leafName}>${escapedValue}</${leafName}>`);
-        }
-        const contentRegex = new RegExp(`(<${PdfXfaData.escapeRegex(leafName)}(?:\\s[^>]*)?>)[\\s\\S]*?(</${PdfXfaData.escapeRegex(leafName)}\\s*>)`);
-        if (contentRegex.test(xml)) {
-            return xml.replace(contentRegex, `$1${escapedValue}$2`);
+        const escapedValue = Xml.escapeValue(value);
+        // Try updating an existing element
+        const updated = Xml.setElementContent(xml, leaf, escapedValue);
+        if (updated !== xml)
+            return updated;
+        // Element doesn't exist — create the missing hierarchy
+        const segments = PdfXfaData.cleanSegments(fieldName);
+        if (segments.length === 0)
+            return xml;
+        // Find the deepest existing ancestor (skip the leaf itself)
+        let insertAt = -1;
+        for (let i = segments.length - 2; i >= 0; i--) {
+            if (Xml.hasElement(xml, segments[i])) {
+                insertAt = i;
+                break;
+            }
         }
-        return xml;
+        if (insertAt === -1)
+            return xml;
+        const childXml = Xml.wrapInElements(escapedValue, segments.slice(insertAt + 1));
+        return Xml.insertChild(xml, segments[insertAt], childXml);
+    }
+    static leafName(fieldName) {
+        const segments = fieldName.split('.');
+        const leaf = segments[segments.length - 1].replace(/\[\d+\]$/, '');
+        return leaf.startsWith('#') ? null : leaf;
     }
-    static escapeRegex(str) {
-        return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    static cleanSegments(fieldName) {
+        return fieldName
+            .split('.')
+            .map((s) => s.replace(/\[\d+\]$/, ''))
+            .filter((s) => !s.startsWith('#'));
     }
 }

package/dist/annotations/pdf-annotation.d.ts

@@ -31,7 +31,7 @@ export declare class PdfAnnotation extends PdfIndirectObject<PdfDictionary<{
     Kids: PdfArray<PdfObjectReference>;
     Rect: PdfArray<PdfNumber>;
     F: PdfNumber;
-    AP?: PdfAppearanceStreamDictionary;
+    AP?: PdfAppearanceStreamDictionary | PdfObjectReference;
     P?: PdfObjectReference;
     Parent?: PdfObjectReference<PdfPage>;
     A?: PdfDictionary<{

package/dist/annotations/pdf-annotation.js

@@ -87,10 +87,24 @@ export class PdfAnnotation extends PdfIndirectObject {
         this.flags_.locked = value;
     }
     get appearanceStreamDict() {
-        const apDict = this.content.get('AP')?.as(PdfDictionary);
+        const apDict = this.content.get('AP');
         if (!apDict)
             return null;
-        return apDict;
+        if (apDict instanceof PdfObjectReference) {
+            const resolved = apDict.resolve();
+            if (resolved.content instanceof PdfDictionary) {
+                return resolved.content;
+            }
+            else {
+                throw new Error('Invalid AP reference: not a dictionary');
+            }
+        }
+        else if (apDict instanceof PdfDictionary) {
+            return apDict;
+        }
+        else {
+            throw new Error('Invalid AP entry: must be a dictionary or reference');
+        }
     }
     set appearanceStreamDict(dict) {
         if (dict === null) {

package/dist/core/objects/pdf-array.d.ts

@@ -1,4 +1,5 @@
 import { PdfObjectReference } from '../index.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfWhitespaceToken } from '../tokens/whitespace-token.js';
 import { PdfIndirectObject } from './pdf-indirect-object.js';
 import { PdfObject } from './pdf-object.js';
@@ -9,8 +10,12 @@ export declare class PdfArray<T extends PdfObject = PdfObject> extends PdfObject
     static refs(items: PdfIndirectObject[]): PdfArray<PdfObjectReference>;
     get length(): number;
     push(item: T): void;
+    toJSON(): {
+        type: string;
+        items: object[];
+    };
     get isTrailingDelimited(): boolean;
-    protected tokenize(): import("../index.js").PdfToken[];
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
     setModified(modified?: boolean): void;
     isModified(): boolean;

package/dist/core/objects/pdf-array.js

@@ -20,6 +20,9 @@ export class PdfArray extends PdfObject {
     push(item) {
         this.items.push(item);
     }
+    toJSON() {
+        return { type: 'array', items: this.items.map((item) => item.toJSON()) };
+    }
     get isTrailingDelimited() {
         return true;
     }

package/dist/core/objects/pdf-boolean.d.ts

@@ -1,8 +1,12 @@
-import { PdfBooleanToken } from '../tokens/boolean-token.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfObject } from './pdf-object.js';
 export declare class PdfBoolean extends PdfObject {
     value: boolean;
     constructor(value: boolean);
-    protected tokenize(): PdfBooleanToken[];
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
+    toJSON(): {
+        type: string;
+        value: boolean;
+    };
 }

package/dist/core/objects/pdf-boolean.js

@@ -13,4 +13,7 @@ export class PdfBoolean extends PdfObject {
         const cloned = new PdfBoolean(this.value);
         return cloned;
     }
+    toJSON() {
+        return { type: 'boolean', value: this.value };
+    }
 }

package/dist/core/objects/pdf-comment.d.ts

@@ -1,5 +1,5 @@
 import { ByteArray } from '../../types.js';
-import { PdfCommentToken } from '../tokens/comment-token.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfObject } from './pdf-object.js';
 export declare class PdfComment extends PdfObject {
     static EOF: PdfComment;
@@ -13,6 +13,10 @@ export declare class PdfComment extends PdfObject {
     isVersionComment(): boolean;
     isEOFComment(): boolean;
     static versionComment(version: string): PdfComment;
-    protected tokenize(): PdfCommentToken[];
+    toJSON(): {
+        type: string;
+        value: string;
+    };
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
 }

package/dist/core/objects/pdf-comment.js

@@ -30,6 +30,9 @@ export class PdfComment extends PdfObject {
         comment.postTokens = [PdfWhitespaceToken.NEWLINE];
         return comment;
     }
+    toJSON() {
+        return { type: 'comment', value: this.asString() };
+    }
     tokenize() {
         return [new PdfCommentToken(this.raw)];
     }

package/dist/core/objects/pdf-date.d.ts

@@ -1,5 +1,9 @@
 import { PdfString } from './pdf-string.js';
 export declare class PdfDate extends PdfString {
     constructor(date: Date);
+    toJSON(): {
+        type: string;
+        value: string;
+    };
     get date(): Date;
 }

package/dist/core/objects/pdf-date.js

@@ -15,6 +15,9 @@ export class PdfDate extends PdfString {
         const dateString = `D:${year}${month}${day}${hours}${minutes}${seconds}${sign}${offsetHours}'${offsetMins}'`;
         super(dateString);
     }
+    toJSON() {
+        return { type: 'date', value: this.date.toISOString() };
+    }
     get date() {
         const str = new TextDecoder().decode(this.raw);
         const match = /^D:(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})([+\-Z])?(\d{2})?'?(\d{2})?'?/.exec(str);

package/dist/core/objects/pdf-dictionary.d.ts

@@ -10,6 +10,7 @@ export declare class PdfDictionary<T extends PdfDictionaryEntries = PdfDictionar
     constructor(entries?: T | PdfDictionaryMap);
     keys(): PdfName[];
     get<K extends Extract<keyof T, string>>(key: PdfName<K> | K): T[K] | undefined;
+    move<K extends Extract<keyof T, string>>(fromKey: PdfName<K> | K, toKey: PdfName<K> | K): void;
     set<K extends Extract<keyof T, string>>(key: PdfName<K> | K, value: T[K]): void;
     delete<K extends Extract<keyof T, string>>(key: PdfName<K> | K): void;
     has<K extends Extract<keyof T, string>>(key: PdfName<K> | K): boolean;
@@ -21,6 +22,10 @@ export declare class PdfDictionary<T extends PdfDictionaryEntries = PdfDictionar
      * Each entry is a tuple of [key string, value].
      */
     entries(): IterableIterator<[string, PdfObject | undefined]>;
+    toJSON(): {
+        type: string;
+        entries: Record<string, object>;
+    };
     get isTrailingDelimited(): boolean;
     protected tokenize(): PdfToken[];
     /** Factory-style type conversion: constructs a new instance passing `this` as the first argument */

package/dist/core/objects/pdf-dictionary.js

@@ -31,6 +31,13 @@ export class PdfDictionary extends PdfObject {
             }
         }
     }
+    move(fromKey, toKey) {
+        const value = this.get(fromKey);
+        if (value !== undefined) {
+            this.set(toKey, value);
+            this.delete(fromKey);
+        }
+    }
     set(key, value) {
         const currentValue = this.get(key);
         if (currentValue !== value && !currentValue?.equals(value)) {
@@ -95,6 +102,15 @@ export class PdfDictionary extends PdfObject {
         const entries = Array.from(this.#entries.entries()).map(([key, value]) => [key.value, value]);
         return entries[Symbol.iterator]();
     }
+    toJSON() {
+        const entries = {};
+        for (const [key, value] of this.entries()) {
+            if (value) {
+                entries[key] = value.toJSON();
+            }
+        }
+        return { type: 'dictionary', entries };
+    }
     get isTrailingDelimited() {
         return true;
     }

package/dist/core/objects/pdf-hexadecimal.d.ts

@@ -1,5 +1,5 @@
 import { ByteArray } from '../../types.js';
-import { PdfHexadecimalToken } from '../tokens/hexadecimal-token.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfObject } from './pdf-object.js';
 export declare class PdfHexadecimal extends PdfObject {
     /**
@@ -19,7 +19,11 @@ export declare class PdfHexadecimal extends PdfObject {
     get bytes(): ByteArray;
     toHexBytes(): ByteArray;
     toHexString(): string;
+    toJSON(): {
+        type: string;
+        value: string;
+    };
     get isTrailingDelimited(): boolean;
-    protected tokenize(): PdfHexadecimalToken[];
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
 }

package/dist/core/objects/pdf-hexadecimal.js

@@ -48,6 +48,9 @@ export class PdfHexadecimal extends PdfObject {
     toHexString() {
         return bytesToString(this.toHexBytes());
     }
+    toJSON() {
+        return { type: 'hexadecimal', value: this.toHexString() };
+    }
     get isTrailingDelimited() {
         return true;
     }

package/dist/core/objects/pdf-indirect-object.d.ts

@@ -1,3 +1,4 @@
+import { PdfToken } from '../tokens/token.js';
 import { PdfNull } from './pdf-null.js';
 import { PdfObject } from './pdf-object.js';
 import { PdfObjectReference } from './pdf-object-reference.js';
@@ -25,9 +26,15 @@ export declare class PdfIndirectObject<T extends PdfObject = PdfObject> extends
     static createPlaceholder<T extends PdfObject>(objectNumber?: number, generationNumber?: number, content?: T): PdfIndirectObject<T extends unknown ? PdfNull : T>;
     inPdf(): boolean;
     matchesReference(ref?: PdfObjectReference): boolean;
-    protected tokenize(): import("../index.js").PdfToken[];
+    protected tokenize(): PdfToken[];
     copyFrom(other: PdfIndirectObject): void;
     cloneImpl(): this;
+    toJSON(): {
+        type: string;
+        objectNumber: number;
+        generationNumber: number;
+        content: object;
+    };
     order(): number;
     setModified(modified?: boolean): void;
     isModified(): boolean;

package/dist/core/objects/pdf-indirect-object.js

@@ -126,6 +126,14 @@ export class PdfIndirectObject extends PdfObject {
             compressed: this.compressed,
         });
     }
+    toJSON() {
+        return {
+            type: 'indirect-object',
+            objectNumber: this.objectNumber,
+            generationNumber: this.generationNumber,
+            content: this.content.toJSON(),
+        };
+    }
     order() {
         return this.orderIndex ?? 0;
     }
@@ -156,6 +164,9 @@ export class PdfIndirectObject extends PdfObject {
         const savedGenerationNumber = this.generationNumber;
         const savedOffset = this.offset;
         const savedContent = this.content;
+        const savedModified = this.modified;
+        const savedEncryptable = this.encryptable;
+        const savedCompressed = this.compressed;
         const newObject = new cls(this);
         Object.setPrototypeOf(this, cls.prototype);
         Object.assign(this, newObject);
@@ -163,6 +174,9 @@ export class PdfIndirectObject extends PdfObject {
         this.generationNumber = savedGenerationNumber;
         this.offset = savedOffset;
         this.content = savedContent;
+        this.modified = savedModified;
+        this.encryptable = savedEncryptable;
+        this.compressed = savedCompressed;
         return this;
     }
     resolve(cls) {

package/dist/core/objects/pdf-name.d.ts

@@ -1,10 +1,14 @@
-import { PdfNameToken } from '../tokens/name-token.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfObject } from './pdf-object.js';
 export declare class PdfName<T extends string = string> extends PdfObject {
     value: T;
     constructor(value: T);
-    protected tokenize(): PdfNameToken[];
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
+    toJSON(): {
+        type: string;
+        value: T;
+    };
     /**
      * Escapes a PDF name according to PDF specification.
      * PDF names can't contain spaces or certain special chars except # for escaping.

package/dist/core/objects/pdf-name.js

@@ -13,6 +13,9 @@ export class PdfName extends PdfObject {
         const cloned = new PdfName(this.value);
         return cloned;
     }
+    toJSON() {
+        return { type: 'name', value: this.value };
+    }
     /**
      * Escapes a PDF name according to PDF specification.
      * PDF names can't contain spaces or certain special chars except # for escaping.

package/dist/core/objects/pdf-null.d.ts

@@ -1,7 +1,10 @@
 import { PdfObject } from './pdf-object.js';
-import { PdfNullToken } from '../tokens/null-token.js';
+import { PdfToken } from '../tokens/token.js';
 export declare class PdfNull extends PdfObject {
     static readonly NULL: PdfNull;
-    protected tokenize(): PdfNullToken[];
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
+    toJSON(): {
+        type: string;
+    };
 }

package/dist/core/objects/pdf-null.js

@@ -9,4 +9,7 @@ export class PdfNull extends PdfObject {
         const cloned = new PdfNull();
         return cloned;
     }
+    toJSON() {
+        return { type: 'null' };
+    }
 }

package/dist/core/objects/pdf-number.d.ts

@@ -1,5 +1,6 @@
 import { Ref } from '../ref.js';
 import { PdfNumberToken } from '../tokens/number-token.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfObject } from './pdf-object.js';
 export declare class PdfNumber extends PdfObject {
     #private;
@@ -16,8 +17,12 @@ export declare class PdfNumber extends PdfObject {
     set value(value: number);
     onChange(callback: (value: number) => void): void;
     toToken(): PdfNumberToken;
-    protected tokenize(): PdfNumberToken[];
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
+    toJSON(): {
+        type: string;
+        value: number;
+    };
     setModified(modified?: boolean): void;
     isModified(): boolean;
 }

package/dist/core/objects/pdf-number.js

@@ -69,6 +69,9 @@ export class PdfNumber extends PdfObject {
         });
         return cloned;
     }
+    toJSON() {
+        return { type: 'number', value: this.value };
+    }
     setModified(modified) {
         super.setModified(modified);
         this.#value.setModified(modified);

package/dist/core/objects/pdf-object-reference.d.ts

@@ -11,6 +11,11 @@ export declare class PdfObjectReference<T extends PdfIndirectObject = PdfIndirec
     constructor(objectNumber: number, generationNumber: number);
     protected tokenize(): PdfToken[];
     cloneImpl(): this;
+    toJSON(): {
+        type: string;
+        objectNumber: number;
+        generationNumber: number;
+    };
     resolve<U extends PdfIndirectObject = T>(cls?: new (options: PdfIndirectObject) => U): U;
     get key(): string;
 }

package/dist/core/objects/pdf-object-reference.js

@@ -18,6 +18,13 @@ export class PdfObjectReference extends PdfObject {
         const cloned = new PdfObjectReference(this.objectNumber, this.generationNumber);
         return cloned;
     }
+    toJSON() {
+        return {
+            type: 'reference',
+            objectNumber: this.objectNumber,
+            generationNumber: this.generationNumber,
+        };
+    }
     resolve(cls) {
         if (!this.resolver) {
             throw new Error(`No resolver set for PdfObjectReference '${this.objectNumber} ${this.generationNumber}'`);

package/dist/core/objects/pdf-object.d.ts

@@ -49,4 +49,5 @@ export declare abstract class PdfObject {
      * @returns A promise that resolves to the PDF document as a Base64 string
      */
     toBase64(): string;
+    abstract toJSON(): object;
 }

package/dist/core/objects/pdf-start-xref.d.ts

@@ -1,10 +1,15 @@
 import { Ref } from '../ref.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfNumber } from './pdf-number.js';
 import { PdfObject } from './pdf-object.js';
 export declare class PdfStartXRef extends PdfObject {
     offset: PdfNumber;
     constructor(offset?: number | PdfNumber | Ref<number>);
-    protected tokenize(): import("../index.js").PdfToken[];
+    toJSON(): {
+        type: string;
+        offset: number;
+    };
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
     setModified(modified?: boolean): void;
     isModified(): boolean;

package/dist/core/objects/pdf-start-xref.js

@@ -13,6 +13,9 @@ export class PdfStartXRef extends PdfObject {
                 : new PdfNumber({ value: offset });
         this.offset.isByteOffset = true;
     }
+    toJSON() {
+        return { type: 'start-xref', offset: this.offset.value };
+    }
     tokenize() {
         const whiteSpaceTokens = this.offset.preTokens
             ? []

package/dist/core/objects/pdf-stream.d.ts

@@ -75,6 +75,14 @@ export declare class PdfStream<T extends PdfDictionary = PdfDictionary> extends
         isModified?: boolean;
     }) => T): T;
     protected tokenize(): PdfToken[];
+    toJSON(): {
+        type: string;
+        header: {
+            type: string;
+            entries: Record<string, object>;
+        };
+        dataLength: number;
+    };
     isType(name: string): boolean;
     static getFilter(name: PdfStreamFilterType): PdfFilter;
     static getAllFilters(): {

package/dist/core/objects/pdf-stream.js

@@ -436,6 +436,13 @@ export class PdfStream extends PdfObject {
             new PdfEndStreamToken(),
         ];
     }
+    toJSON() {
+        return {
+            type: 'stream',
+            header: this.header.toJSON(),
+            dataLength: this.raw.length,
+        };
+    }
     isType(name) {
         const type = this.header.get('Type');
         return type instanceof PdfName && type.value === name;

package/dist/core/objects/pdf-string.d.ts

@@ -1,5 +1,5 @@
 import { ByteArray } from '../../types.js';
-import { PdfStringToken } from '../tokens/string-token.js';
+import { PdfToken } from '../tokens/token.js';
 import { PdfObject } from './pdf-object.js';
 export declare class PdfString extends PdfObject {
     /**
@@ -22,6 +22,12 @@ export declare class PdfString extends PdfObject {
     set value(str: string);
     get value(): string;
     get isTrailingDelimited(): boolean;
-    protected tokenize(): PdfStringToken[];
+    protected tokenize(): PdfToken[];
     cloneImpl(): this;
+    toJSON(): {
+        type: string;
+        value: string;
+    };
+    trim(): string;
+    get length(): number;
 }

package/dist/core/objects/pdf-string.js

@@ -80,4 +80,13 @@ export class PdfString extends PdfObject {
             : undefined);
         return cloned;
     }
+    toJSON() {
+        return { type: 'string', value: this.value };
+    }
+    trim() {
+        return this.value.trim();
+    }
+    get length() {
+        return this.value.length;
+    }
 }

package/dist/core/objects/pdf-trailer.d.ts

@@ -20,6 +20,13 @@ export declare class PdfTrailer extends PdfObject {
     dict: PdfTrailerDictionary;
     offset: Ref<number>;
     constructor(entries: PdfTrailerEntries | PdfDictionary<PdfTrailerEntries>);
+    toJSON(): {
+        type: string;
+        dict: {
+            type: string;
+            entries: Record<string, object>;
+        };
+    };
     protected tokenize(): PdfToken[];
     cloneImpl(): this;
     setModified(modified?: boolean): void;

package/dist/core/objects/pdf-trailer.js

@@ -14,6 +14,9 @@ export class PdfTrailer extends PdfObject {
                 ? entries
                 : new PdfDictionary(entries);
     }
+    toJSON() {
+        return { type: 'trailer', dict: this.dict.toJSON() };
+    }
     tokenize() {
         return [
             new PdfByteOffsetToken(this.offset),