pdf-lite 1.0.4 → 1.0.6

package/dist/acroform/acroform-manager.js

@@ -0,0 +1,215 @@
+import { PdfDictionary } from '../core/objects/pdf-dictionary.js';
+import { PdfArray } from '../core/objects/pdf-array.js';
+import { PdfString } from '../core/objects/pdf-string.js';
+import { PdfObjectReference } from '../core/objects/pdf-object-reference.js';
+import { PdfIndirectObject } from '../core/objects/pdf-indirect-object.js';
+import { PdfName } from '../core/objects/pdf-name.js';
+import { PdfBoolean } from '../core/objects/pdf-boolean.js';
+/**
+ * Manages AcroForm fields in PDF documents.
+ * Provides methods to read and write form field values.
+ */
+export class PdfAcroFormManager {
+    document;
+    _acroForm;
+    constructor(document) {
+        this.document = document;
+    }
+    /**
+     * Checks if the document contains AcroForm fields.
+     * @returns True if the document has AcroForm fields, false otherwise
+     */
+    async hasAcroForm() {
+        try {
+            const acroForm = await this.getAcroForm();
+            return acroForm !== null;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Gets all form field values as a key-value map.
+     * @returns Object with field names as keys and values as strings
+     */
+    async getFieldValues() {
+        const acroForm = await this.getAcroForm();
+        if (!acroForm)
+            return null;
+        const fields = acroForm.get('Fields')?.as(PdfArray);
+        if (!fields)
+            return null;
+        const values = {};
+        await this.collectFieldValues(fields, values);
+        return values;
+    }
+    /**
+     * Sets a form field value by field name.
+     * @param fieldName The name of the field to set
+     * @param value The value to set
+     * @throws Error if the field is not found
+     */
+    async setFieldValues(newFields) {
+        const acroFormObject = await this.getAcroFormObject();
+        if (!acroFormObject) {
+            throw new Error('Document does not contain AcroForm');
+        }
+        const acroForm = acroFormObject.content.as(PdfDictionary);
+        const fields = acroForm.get('Fields')?.as(PdfArray);
+        if (!fields) {
+            throw new Error('AcroForm has no fields');
+        }
+        const isIncremental = this.document.isIncremental();
+        this.document.setIncremental(true);
+        // Update the AcroForm dictionary with NeedAppearances flag
+        const updatedAcroForm = new PdfIndirectObject({
+            ...acroFormObject,
+            content: acroFormObject.content.clone(),
+        });
+        const updatedAcroFormDict = updatedAcroForm.content.as(PdfDictionary);
+        // Let the PDF viewer know that appearances need to be regenerated
+        updatedAcroFormDict.set('NeedAppearances', new PdfBoolean(true));
+        await this.document.commit(updatedAcroForm);
+        for (const [fieldName, value] of Object.entries(newFields)) {
+            const fieldObject = await this.findFieldByName(fields, fieldName);
+            if (!fieldObject) {
+                throw new Error(`Field '${fieldName}' not found`);
+            }
+            const updatedField = new PdfIndirectObject({
+                ...fieldObject,
+                content: fieldObject.content.clone(),
+            });
+            const fieldDict = updatedField.content.as(PdfDictionary);
+            // Set appearance state (AS) for button fields (checkboxes, radio buttons)
+            // Button fields use PdfName for both V and AS, text fields use PdfString
+            const fieldType = fieldDict.get('FT')?.as(PdfName)?.value;
+            if (fieldType === 'Btn') {
+                fieldDict.set('V', new PdfName(value));
+                fieldDict.set('AS', new PdfName(value));
+            }
+            else {
+                fieldDict.set('V', new PdfString(value));
+            }
+            await this.document.commit(updatedField);
+        }
+        this.document.setIncremental(isIncremental);
+    }
+    /**
+     * Gets the AcroForm indirect object from the document catalog.
+     * @returns The AcroForm indirect object or null if not found
+     */
+    async getAcroFormObject() {
+        const catalog = this.document.rootDictionary;
+        if (!catalog)
+            return null;
+        const acroFormRef = catalog.get('AcroForm');
+        if (!acroFormRef)
+            return null;
+        if (acroFormRef instanceof PdfObjectReference) {
+            const acroFormObject = await this.document.readObject({
+                objectNumber: acroFormRef.objectNumber,
+                generationNumber: acroFormRef.generationNumber,
+            });
+            if (!acroFormObject)
+                return null;
+            return acroFormObject;
+        }
+        return null;
+    }
+    /**
+     * Gets the AcroForm dictionary from the document catalog.
+     * @returns The AcroForm dictionary or null if not found
+     */
+    async getAcroForm() {
+        if (this._acroForm) {
+            return this._acroForm;
+        }
+        const acroFormObject = await this.getAcroFormObject();
+        if (acroFormObject) {
+            this._acroForm = acroFormObject.content.as(PdfDictionary);
+            return this._acroForm;
+        }
+        const catalog = this.document.rootDictionary;
+        if (!catalog)
+            return null;
+        const acroFormRef = catalog.get('AcroForm');
+        if (acroFormRef instanceof PdfDictionary) {
+            this._acroForm = acroFormRef;
+            return this._acroForm;
+        }
+        return null;
+    }
+    /**
+     * Recursively collects field values from the field tree.
+     */
+    async collectFieldValues(fields, values, parentName = '') {
+        for (const fieldRef of fields.items) {
+            if (!(fieldRef instanceof PdfObjectReference))
+                continue;
+            // Check if we have a modified version cached
+            const fieldObject = await this.document.readObject({
+                objectNumber: fieldRef.objectNumber,
+                generationNumber: fieldRef.generationNumber,
+            });
+            if (!fieldObject)
+                continue;
+            const fieldDict = fieldObject.content.as(PdfDictionary);
+            const fieldName = this.getFieldName(fieldDict, parentName);
+            // Get field value (return empty string if no value set)
+            const value = fieldDict.get('V');
+            if (value instanceof PdfString) {
+                values[fieldName] = value.value;
+            }
+            else if (value instanceof PdfName) {
+                values[fieldName] = value.value;
+            }
+            else if (fieldName) {
+                // Include empty fields
+                values[fieldName] = '';
+            }
+            // Process child fields (Kids)
+            const kids = fieldDict.get('Kids')?.as(PdfArray);
+            if (kids) {
+                await this.collectFieldValues(kids, values, fieldName);
+            }
+        }
+    }
+    /**
+     * Finds a field by its fully qualified name.
+     */
+    async findFieldByName(fields, targetName, parentName = '') {
+        for (const fieldRef of fields.items) {
+            if (!(fieldRef instanceof PdfObjectReference))
+                continue;
+            // Check if we have a modified version cached
+            const fieldObject = await this.document.readObject({
+                objectNumber: fieldRef.objectNumber,
+                generationNumber: fieldRef.generationNumber,
+            });
+            if (!fieldObject)
+                continue;
+            const fieldDict = fieldObject.content.as(PdfDictionary);
+            const fieldName = this.getFieldName(fieldDict, parentName);
+            if (fieldName === targetName) {
+                return fieldObject;
+            }
+            // Search in child fields (Kids)
+            const kids = fieldDict.get('Kids')?.as(PdfArray);
+            if (kids) {
+                const found = await this.findFieldByName(kids, targetName, fieldName);
+                if (found)
+                    return found;
+            }
+        }
+        return null;
+    }
+    /**
+     * Gets the fully qualified field name.
+     */
+    getFieldName(fieldDict, parentName) {
+        const partialName = fieldDict.get('T')?.as(PdfString)?.value ?? '';
+        if (!parentName)
+            return partialName;
+        return `${parentName}.${partialName}`;
+    }
+}

package/dist/acroform/index.d.ts

@@ -0,0 +1 @@
+export { PdfAcroFormManager } from './acroform-manager.js';

package/dist/acroform/index.js

@@ -0,0 +1 @@
+export { PdfAcroFormManager } from './acroform-manager.js';

package/dist/core/generators.d.ts

@@ -1,5 +1,5 @@
-import { ByteArray } from '../types';
-import { PdfObject } from './objects/pdf-object';
+import { ByteArray } from '../types.js';
+import { PdfObject } from './objects/pdf-object.js';
 /**
  * Converts an iterable of byte arrays into PDF objects.
  * Processes bytes through tokenization and decoding.

package/dist/core/generators.js

@@ -1,6 +1,6 @@
-import { stringToBytes } from '../utils/stringToBytes';
-import { PdfDecoder } from './decoder';
-import { PdfByteStreamTokeniser } from './tokeniser';
+import { stringToBytes } from '../utils/stringToBytes.js';
+import { PdfDecoder } from './decoder.js';
+import { PdfByteStreamTokeniser } from './tokeniser.js';
 /**
  * Converts an iterable of byte arrays into PDF objects.
  * Processes bytes through tokenization and decoding.

package/dist/core/incremental-parser.d.ts

@@ -1,4 +1,4 @@
-import { Parser } from './parser';
+import { Parser } from './parser.js';
 /**
  * Error thrown when the parser needs more input to continue parsing.
  */

package/dist/core/incremental-parser.js

@@ -1,4 +1,4 @@
-import { Parser } from './parser';
+import { Parser } from './parser.js';
 /**
  * Error thrown when the parser needs more input to continue parsing.
  */

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

@@ -1,12 +1,12 @@
-import { PdfWhitespaceToken } from '../tokens/whitespace-token';
-import { PdfObject } from './pdf-object';
+import { PdfWhitespaceToken } from '../tokens/whitespace-token.js';
+import { PdfObject } from './pdf-object.js';
 export declare class PdfArray<T extends PdfObject = PdfObject> extends PdfObject {
     items: T[];
     innerTokens: PdfWhitespaceToken[];
     constructor(items?: T[]);
     get length(): number;
     push(item: T): void;
-    protected tokenize(): import("..").PdfToken[];
+    protected tokenize(): import("../index.js").PdfToken[];
     clone(): this;
     isModified(): boolean;
 }

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

@@ -1,7 +1,7 @@
-import { PdfEndArrayToken } from '../tokens/end-array-token';
-import { PdfStartArrayToken } from '../tokens/start-array-token';
-import { PdfWhitespaceToken } from '../tokens/whitespace-token';
-import { PdfObject } from './pdf-object';
+import { PdfEndArrayToken } from '../tokens/end-array-token.js';
+import { PdfStartArrayToken } from '../tokens/start-array-token.js';
+import { PdfWhitespaceToken } from '../tokens/whitespace-token.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfArray extends PdfObject {
     items;
     innerTokens = [];

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

@@ -1,5 +1,5 @@
-import { PdfBooleanToken } from '../tokens/boolean-token';
-import { PdfObject } from './pdf-object';
+import { PdfBooleanToken } from '../tokens/boolean-token.js';
+import { PdfObject } from './pdf-object.js';
 export declare class PdfBoolean extends PdfObject {
     value: boolean;
     constructor(value: boolean);

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

@@ -1,5 +1,5 @@
-import { PdfBooleanToken } from '../tokens/boolean-token';
-import { PdfObject } from './pdf-object';
+import { PdfBooleanToken } from '../tokens/boolean-token.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfBoolean extends PdfObject {
     value;
     constructor(value) {

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

@@ -1,6 +1,6 @@
-import { ByteArray } from '../../types';
-import { PdfCommentToken } from '../tokens/comment-token';
-import { PdfObject } from './pdf-object';
+import { ByteArray } from '../../types.js';
+import { PdfCommentToken } from '../tokens/comment-token.js';
+import { PdfObject } from './pdf-object.js';
 export declare class PdfComment extends PdfObject {
     static EOF: PdfComment;
     /**

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

@@ -1,7 +1,7 @@
-import { stringToBytes } from '../../utils/stringToBytes';
-import { PdfCommentToken } from '../tokens/comment-token';
-import { PdfWhitespaceToken } from '../tokens/whitespace-token';
-import { PdfObject } from './pdf-object';
+import { stringToBytes } from '../../utils/stringToBytes.js';
+import { PdfCommentToken } from '../tokens/comment-token.js';
+import { PdfWhitespaceToken } from '../tokens/whitespace-token.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfComment extends PdfObject {
     static EOF = new PdfComment('%EOF');
     /**

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

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

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

@@ -1,4 +1,4 @@
-import { PdfString } from './pdf-string';
+import { PdfString } from './pdf-string.js';
 export class PdfDate extends PdfString {
     constructor(date) {
         const pad = (n, width = 2) => n.toString().padStart(width, '0');

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

@@ -1,6 +1,6 @@
-import { PdfToken } from '../tokens/token';
-import { PdfName } from './pdf-name';
-import { PdfObject } from './pdf-object';
+import { PdfToken } from '../tokens/token.js';
+import { PdfName } from './pdf-name.js';
+import { PdfObject } from './pdf-object.js';
 export type PdfDictionaryEntry = PdfObject | undefined;
 export type PdfDictionaryEntries = Record<string, PdfDictionaryEntry>;
 export type PdfDictionaryMap = Map<PdfName, PdfObject | undefined>;

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

@@ -1,8 +1,8 @@
-import { PdfEndDictionaryToken } from '../tokens/end-dictionary-token';
-import { PdfStartDictionaryToken } from '../tokens/start-dictionary-token';
-import { PdfWhitespaceToken } from '../tokens/whitespace-token';
-import { PdfName } from './pdf-name';
-import { PdfObject } from './pdf-object';
+import { PdfEndDictionaryToken } from '../tokens/end-dictionary-token.js';
+import { PdfStartDictionaryToken } from '../tokens/start-dictionary-token.js';
+import { PdfWhitespaceToken } from '../tokens/whitespace-token.js';
+import { PdfName } from './pdf-name.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfDictionary extends PdfObject {
     #entries;
     innerTokens = [];

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

@@ -1,6 +1,6 @@
-import { ByteArray } from '../../types';
-import { PdfHexadecimalToken } from '../tokens/hexadecimal-token';
-import { PdfObject } from './pdf-object';
+import { ByteArray } from '../../types.js';
+import { PdfHexadecimalToken } from '../tokens/hexadecimal-token.js';
+import { PdfObject } from './pdf-object.js';
 export declare class PdfHexadecimal extends PdfObject {
     /**
      * The raw byte value represented by this hexadecimal object.

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

@@ -1,9 +1,9 @@
-import { bytesToHexBytes } from '../../utils/bytesToHexBytes';
-import { bytesToString } from '../../utils/bytesToString';
-import { hexBytesToBytes } from '../../utils/hexBytesToBytes';
-import { stringToBytes } from '../../utils/stringToBytes';
-import { PdfHexadecimalToken } from '../tokens/hexadecimal-token';
-import { PdfObject } from './pdf-object';
+import { bytesToHexBytes } from '../../utils/bytesToHexBytes.js';
+import { bytesToString } from '../../utils/bytesToString.js';
+import { hexBytesToBytes } from '../../utils/hexBytesToBytes.js';
+import { stringToBytes } from '../../utils/stringToBytes.js';
+import { PdfHexadecimalToken } from '../tokens/hexadecimal-token.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfHexadecimal extends PdfObject {
     /**
      * The raw byte value represented by this hexadecimal object.

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

@@ -1,7 +1,7 @@
-import { PdfNull } from './pdf-null';
-import { PdfObject } from './pdf-object';
-import { PdfObjectReference } from './pdf-object-reference';
-import { Ref } from '../ref';
+import { PdfNull } from './pdf-null.js';
+import { PdfObject } from './pdf-object.js';
+import { PdfObjectReference } from './pdf-object-reference.js';
+import { Ref } from '../ref.js';
 export declare class PdfIndirectObject<T extends PdfObject = PdfObject> extends PdfObjectReference {
     static readonly MAX_ORDER_INDEX = 2147483647;
     content: T;
@@ -20,7 +20,7 @@ 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("..").PdfToken[];
+    protected tokenize(): import("../index.js").PdfToken[];
     clone(): this;
     order(): number;
     isModified(): boolean;

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

@@ -1,12 +1,12 @@
-import { PdfEndObjectToken } from '../tokens/end-object-token';
-import { PdfStartObjectToken } from '../tokens/start-object-token';
-import { PdfWhitespaceToken } from '../tokens/whitespace-token';
-import { PdfNull } from './pdf-null';
-import { PdfObject } from './pdf-object';
-import { PdfObjectReference } from './pdf-object-reference';
-import { PdfStream } from './pdf-stream';
-import { Ref } from '../ref';
-import { PdfByteOffsetToken } from '../tokens/byte-offset-token';
+import { PdfEndObjectToken } from '../tokens/end-object-token.js';
+import { PdfStartObjectToken } from '../tokens/start-object-token.js';
+import { PdfWhitespaceToken } from '../tokens/whitespace-token.js';
+import { PdfNull } from './pdf-null.js';
+import { PdfObject } from './pdf-object.js';
+import { PdfObjectReference } from './pdf-object-reference.js';
+import { PdfStream } from './pdf-stream.js';
+import { Ref } from '../ref.js';
+import { PdfByteOffsetToken } from '../tokens/byte-offset-token.js';
 export class PdfIndirectObject extends PdfObjectReference {
     static MAX_ORDER_INDEX = 2147483647;
     content;

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

@@ -1,5 +1,5 @@
-import { PdfNameToken } from '../tokens/name-token';
-import { PdfObject } from './pdf-object';
+import { PdfNameToken } from '../tokens/name-token.js';
+import { PdfObject } from './pdf-object.js';
 export declare class PdfName<T extends string = string> extends PdfObject {
     value: T;
     constructor(value: T);

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

@@ -1,5 +1,5 @@
-import { PdfNameToken } from '../tokens/name-token';
-import { PdfObject } from './pdf-object';
+import { PdfNameToken } from '../tokens/name-token.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfName extends PdfObject {
     value;
     constructor(value) {

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

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

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

@@ -1,5 +1,5 @@
-import { PdfObject } from './pdf-object';
-import { PdfNullToken } from '../tokens/null-token';
+import { PdfObject } from './pdf-object.js';
+import { PdfNullToken } from '../tokens/null-token.js';
 export class PdfNull extends PdfObject {
     static NULL = new PdfNull();
     tokenize() {

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

@@ -1,6 +1,6 @@
-import { Ref } from '../ref';
-import { PdfNumberToken } from '../tokens/number-token';
-import { PdfObject } from './pdf-object';
+import { Ref } from '../ref.js';
+import { PdfNumberToken } from '../tokens/number-token.js';
+import { PdfObject } from './pdf-object.js';
 export declare class PdfNumber extends PdfObject {
     #private;
     padTo: number;

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

@@ -1,6 +1,6 @@
-import { Ref } from '../ref';
-import { PdfNumberToken } from '../tokens/number-token';
-import { PdfObject } from './pdf-object';
+import { Ref } from '../ref.js';
+import { PdfNumberToken } from '../tokens/number-token.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfNumber extends PdfObject {
     #value;
     padTo;

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

@@ -1,5 +1,5 @@
-import { PdfToken } from '../tokens/token';
-import { PdfObject } from './pdf-object';
+import { PdfToken } from '../tokens/token.js';
+import { PdfObject } from './pdf-object.js';
 export declare class PdfObjectReference extends PdfObject {
     objectNumber: number;
     generationNumber: number;

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

@@ -1,5 +1,5 @@
-import { PdfObjectReferenceToken } from '../tokens/object-reference-token';
-import { PdfObject } from './pdf-object';
+import { PdfObjectReferenceToken } from '../tokens/object-reference-token.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfObjectReference extends PdfObject {
     objectNumber;
     generationNumber;

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

@@ -1,10 +1,10 @@
-import { Ref } from '../ref';
-import { PdfNumber } from './pdf-number';
-import { PdfObject } from './pdf-object';
+import { Ref } from '../ref.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("..").PdfToken[];
+    protected tokenize(): import("../index.js").PdfToken[];
     clone(): this;
     isModified(): boolean;
 }

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

@@ -1,7 +1,7 @@
-import { PdfStartXRefToken } from '../tokens/start-xref-token';
-import { PdfWhitespaceToken } from '../tokens/whitespace-token';
-import { PdfNumber } from './pdf-number';
-import { PdfObject } from './pdf-object';
+import { PdfStartXRefToken } from '../tokens/start-xref-token.js';
+import { PdfWhitespaceToken } from '../tokens/whitespace-token.js';
+import { PdfNumber } from './pdf-number.js';
+import { PdfObject } from './pdf-object.js';
 export class PdfStartXRef extends PdfObject {
     offset;
     constructor(offset = -1) {

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

@@ -1,11 +1,11 @@
-import { PdfToken } from '../tokens/token';
-import { PdfDictionary } from './pdf-dictionary';
-import { PdfObject } from './pdf-object';
-import { ByteArray } from '../../types';
-import { PdfNumber } from './pdf-number';
-import { PdfIndirectObject } from './pdf-indirect-object';
-import { PdfXRefTableEntry } from './pdf-xref-table';
-import { PdfFilter, PdfStreamFilterType } from '../../filters/types';
+import { PdfToken } from '../tokens/token.js';
+import { PdfDictionary } from './pdf-dictionary.js';
+import { PdfObject } from './pdf-object.js';
+import { ByteArray } from '../../types.js';
+import { PdfNumber } from './pdf-number.js';
+import { PdfIndirectObject } from './pdf-indirect-object.js';
+import { PdfXRefTableEntry } from './pdf-xref-table.js';
+import { PdfFilter, PdfStreamFilterType } from '../../filters/types.js';
 export declare class PdfStream<T extends PdfDictionary = PdfDictionary> extends PdfObject {
     header: T;
     original: ByteArray;
@@ -54,6 +54,7 @@ export declare class PdfStream<T extends PdfDictionary = PdfDictionary> extends
     };
     static applyFilters(data: ByteArray, filters: PdfStreamFilterType[]): ByteArray;
     clone(): this;
+    static fromString(data: string): PdfStream;
 }
 export declare class PdfObjStream extends PdfStream {
     constructor(options: {