pdf-lite 1.4.0 → 1.5.0

package/dist/acroform/fields/{PdfFormField.js → pdf-form-field.js}

@@ -4,9 +4,10 @@ import { PdfString } from '../../core/objects/pdf-string.js';
 import { PdfName } from '../../core/objects/pdf-name.js';
 import { PdfNumber } from '../../core/objects/pdf-number.js';
 import { decodeWithFontEncoding } from '../../utils/decodeWithFontEncoding.js';
-import { PdfWidgetAnnotation } from '../../annotations/PdfWidgetAnnotation.js';
-import { PdfDefaultAppearance } from './PdfDefaultAppearance.js';
+import { PdfWidgetAnnotation } from '../../annotations/pdf-widget-annotation.js';
+import { PdfDefaultAppearance } from './pdf-default-appearance.js';
 import { PdfFieldType as PdfFieldTypeConst } from './types.js';
+import { PdfFormFieldFlags } from './pdf-form-field-flags.js';
 /**
  * Abstract base form field class. Extends PdfWidgetAnnotation with form-specific properties:
  * FT, V, DA, Ff, T (name), field hierarchy (parent/children/siblings).
@@ -115,12 +116,7 @@ export class PdfFormField extends PdfWidgetAnnotation {
         return '';
     }
     set defaultValue(val) {
-        if (this.fieldType === 'Button') {
-            this.content.set('DV', new PdfName(val));
-        }
-        else {
-            this.content.set('DV', new PdfString(val));
-        }
+        this.content.set('DV', new PdfString(val));
     }
     get value() {
         const v = this.content.get('V') ?? this.parent?.content.get('V');
@@ -143,54 +139,37 @@ export class PdfFormField extends PdfWidgetAnnotation {
         const fieldParent = this.parent?.content.get('FT')
             ? this.parent
             : undefined;
-        const fieldType = this.fieldType;
-        if (fieldType === 'Button') {
-            val = val instanceof PdfString ? val.value : val;
-            if (val.trim() === '') {
-                this.content.delete('V');
-                fieldParent?.content.delete('V');
-                this.content.delete('AS');
-                return;
-            }
-            this.content.set('V', new PdfName(val));
-            fieldParent?.content.set('V', new PdfName(val));
-            this.content.set('AS', new PdfName(val));
-        }
-        else {
-            const pdfVal = val instanceof PdfString ? val : new PdfString(val);
-            this.content.set('V', pdfVal);
-            fieldParent?.content.set('V', pdfVal);
-        }
-        if (this.defaultGenerateAppearance) {
-            this.generateAppearance();
+        const generateAppearance = this._storeValue(val, fieldParent);
+        if (generateAppearance && this.defaultGenerateAppearance) {
+            this.tryGenerateAppearance(this);
             for (const sibling of this.siblings) {
                 if (sibling !== this &&
                     sibling.rect &&
                     sibling.defaultGenerateAppearance) {
-                    sibling.generateAppearance();
+                    this.tryGenerateAppearance(sibling);
                 }
             }
         }
     }
+    /**
+     * Writes the value to the dictionary. Returns true if appearance generation
+     * should proceed, false to skip it (e.g. when value was cleared).
+     * Override in subclasses to change the stored representation.
+     */
+    _storeValue(val, fieldParent) {
+        const pdfVal = val instanceof PdfString ? val : new PdfString(val);
+        this.content.set('V', pdfVal);
+        fieldParent?.content.set('V', pdfVal);
+        return true;
+    }
+    tryGenerateAppearance(field) {
+        field.generateAppearance();
+    }
     get checked() {
-        if (this.fieldType === 'Button') {
-            const v = this.content.get('V') ?? this.parent?.content.get('V');
-            return v instanceof PdfName && v.value === 'Yes';
-        }
         return false;
     }
-    set checked(isChecked) {
-        if (this.fieldType === 'Button') {
-            const target = this.parent ?? this;
-            if (isChecked) {
-                target.content.set('V', new PdfName('Yes'));
-                this.content.set('AS', new PdfName('Yes'));
-            }
-            else {
-                target.content.set('V', new PdfName('Off'));
-                this.content.set('AS', new PdfName('Off'));
-            }
-        }
+    set checked(_isChecked) {
+        // no-op for non-button fields; overridden in PdfButtonFormField
     }
     get fontSize() {
         const da = this.defaultAppearance || '';
@@ -244,125 +223,114 @@ export class PdfFormField extends PdfWidgetAnnotation {
             this.content.set('DA', parsed);
         }
     }
-    // Field flags (Ff) - with parent inheritance
     get flags() {
-        const own = this.content.get('Ff')?.as(PdfNumber)?.value;
-        if (own !== undefined)
-            return own;
-        return this.parent?.flags ?? 0;
-    }
-    set flags(flags) {
-        this.content.set('Ff', new PdfNumber(flags));
+        const flags = new PdfFormFieldFlags(this.content.get('Ff') ?? this.parent?.content.get('Ff') ?? 0);
+        flags.onChange(() => {
+            this.flags = flags;
+        });
+        return flags;
     }
-    getFlag(bit) {
-        return (this.flags & bit) !== 0;
-    }
-    setFlag(bit, value) {
-        if (value) {
-            this.flags = this.flags | bit;
-        }
-        else {
-            this.flags = this.flags & ~bit;
-        }
+    set flags(v) {
+        this.content.set('Ff', v);
     }
     get readOnly() {
-        return this.getFlag(1);
+        return this.flags.readOnly;
     }
     set readOnly(v) {
-        this.setFlag(1, v);
+        this.flags.readOnly = v;
     }
     get required() {
-        return this.getFlag(2);
+        return this.flags.required;
     }
     set required(v) {
-        this.setFlag(2, v);
+        this.flags.required = v;
     }
     get multiline() {
-        return this.getFlag(4096);
+        return this.flags.multiline;
     }
     set multiline(v) {
-        this.setFlag(4096, v);
+        this.flags.multiline = v;
     }
     get password() {
-        return this.getFlag(8192);
+        return this.flags.password;
     }
     set password(v) {
-        this.setFlag(8192, v);
+        this.flags.password = v;
     }
     get comb() {
-        return this.getFlag(16777216);
+        return this.flags.comb;
     }
     get combField() {
-        return this.getFlag(16777216);
+        return this.flags.comb;
     }
     set combField(v) {
-        this.setFlag(16777216, v);
+        this.flags.comb = v;
     }
     get combo() {
-        return this.getFlag(131072);
+        return this.flags.combo;
     }
     set combo(v) {
-        this.setFlag(131072, v);
+        this.flags.combo = v;
     }
     get radio() {
-        return this.getFlag(32768);
+        return this.flags.radio;
     }
     set radio(v) {
-        this.setFlag(32768, v);
+        this.flags.radio = v;
     }
     get noToggleToOff() {
-        return this.getFlag(16384);
+        return this.flags.noToggleToOff;
     }
     set noToggleToOff(v) {
-        this.setFlag(16384, v);
+        this.flags.noToggleToOff = v;
     }
     get noExport() {
-        return this.getFlag(4);
+        return this.flags.noExport;
     }
     set noExport(v) {
-        this.setFlag(4, v);
+        this.flags.noExport = v;
     }
     get pushButton() {
-        return this.getFlag(65536);
+        return this.flags.pushButton;
     }
     set pushButton(v) {
-        this.setFlag(65536, v);
+        this.flags.pushButton = v;
     }
     get edit() {
-        return this.getFlag(262144);
+        return this.flags.edit;
     }
     set edit(v) {
-        this.setFlag(262144, v);
+        this.flags.edit = v;
     }
     get sort() {
-        return this.getFlag(524288);
+        return this.flags.sort;
     }
     set sort(v) {
-        this.setFlag(524288, v);
+        this.flags.sort = v;
     }
     get multiSelect() {
-        return this.getFlag(2097152);
+        return this.flags.multiSelect;
     }
     set multiSelect(v) {
-        this.setFlag(2097152, v);
+        this.flags.multiSelect = v;
     }
     get doNotSpellCheck() {
-        return this.getFlag(4194304);
+        return this.flags.doNotSpellCheck;
     }
     set doNotSpellCheck(v) {
-        this.setFlag(4194304, v);
+        this.flags.doNotSpellCheck = v;
     }
     get doNotScroll() {
-        return this.getFlag(8388608);
+        return this.flags.doNotScroll;
     }
     set doNotScroll(v) {
-        this.setFlag(8388608, v);
+        this.flags.doNotScroll = v;
     }
     get commitOnSelChange() {
-        return this.getFlag(67108864);
+        return this.flags.commitOnSelChange;
     }
     set commitOnSelChange(v) {
-        this.setFlag(67108864, v);
+        this.flags.commitOnSelChange = v;
     }
     get quadding() {
         return (this.content.get('Q')?.as(PdfNumber)?.value ??
@@ -372,21 +340,6 @@ export class PdfFormField extends PdfWidgetAnnotation {
     set quadding(q) {
         this.content.set('Q', new PdfNumber(q));
     }
-    get options() {
-        const opt = this.content.get('Opt')?.as((PdfArray)) ??
-            this.parent?.content.get('Opt')?.as((PdfArray));
-        if (!opt)
-            return [];
-        return opt.items.map((item) => item.value);
-    }
-    set options(options) {
-        if (options.length === 0) {
-            this.content.delete('Opt');
-            return;
-        }
-        const optArray = new PdfArray(options.map((opt) => new PdfString(opt)));
-        this.content.set('Opt', optArray);
-    }
     get defaultAppearance() {
         return (this.content.get('DA')?.as(PdfString)?.value ??
             this.parent?.content.get('DA')?.as(PdfString)?.value ??
@@ -424,39 +377,20 @@ export class PdfFormField extends PdfWidgetAnnotation {
         this.content.set('Kids', kidsArray);
     }
     getAppearanceStream() {
-        if (this.fieldType === 'Button') {
-            if (this.checked && this._appearanceStreamYes) {
-                return this._appearanceStreamYes?.content;
-            }
-            return this._appearanceStream?.content;
-        }
         return this._appearanceStream?.content;
     }
     getAppearanceStreamsForWriting() {
         if (!this._appearanceStream)
             return undefined;
-        return {
-            primary: this._appearanceStream,
-            secondary: this.fieldType === 'Button'
-                ? this._appearanceStreamYes
-                : undefined,
-        };
-    }
-    setAppearanceReference(appearanceStreamRef, appearanceStreamYesRef) {
+        return { primary: this._appearanceStream };
+    }
+    setAppearanceReference(appearanceStreamRef, _appearanceStreamYesRef) {
         let apDict = this.appearanceStreamDict;
         if (!apDict) {
             apDict = new PdfDictionary();
             this.appearanceStreamDict = apDict;
         }
-        if (appearanceStreamYesRef && this.fieldType === 'Button') {
-            const stateDict = new PdfDictionary();
-            stateDict.set('Off', appearanceStreamRef);
-            stateDict.set('Yes', appearanceStreamYesRef);
-            apDict.set('N', stateDict);
-        }
-        else {
-            apDict.set('N', appearanceStreamRef);
-        }
+        apDict.set('N', appearanceStreamRef);
     }
     static _fallbackCtor;
     static _registry = new Map();

package/dist/acroform/fields/{PdfSignatureFormField.d.ts → pdf-signature-form-field.d.ts}

@@ -1,4 +1,4 @@
-import { PdfFormField } from './PdfFormField.js';
+import { PdfFormField } from './pdf-form-field.js';
 /**
  * Signature form field subtype.
  */

package/dist/acroform/fields/{PdfSignatureFormField.js → pdf-signature-form-field.js}

@@ -1,4 +1,4 @@
-import { PdfFormField } from './PdfFormField.js';
+import { PdfFormField } from './pdf-form-field.js';
 /**
  * Signature form field subtype.
  */

package/dist/acroform/fields/{PdfTextFormField.d.ts → pdf-text-form-field.d.ts}

@@ -1,4 +1,4 @@
-import { PdfFormField } from './PdfFormField.js';
+import { PdfFormField } from './pdf-form-field.js';
 /**
  * Text form field subtype.
  */

package/dist/acroform/fields/pdf-text-form-field.js

@@ -0,0 +1,77 @@
+import { PdfFormField } from './pdf-form-field.js';
+import { PdfDefaultAppearance } from './pdf-default-appearance.js';
+import { PdfTextAppearanceStream } from '../appearance/pdf-text-appearance-stream.js';
+import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
+import { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
+/**
+ * Text form field subtype.
+ */
+export class PdfTextFormField extends PdfFormField {
+    static {
+        PdfFormField.registerFieldType('Tx', PdfTextFormField, {
+            fallback: true,
+        });
+    }
+    generateAppearance(options) {
+        const rect = this.rect;
+        if (!rect || rect.length !== 4)
+            return false;
+        const da = this.defaultAppearance;
+        if (!da)
+            return false;
+        const parsed = PdfDefaultAppearance.parse(da);
+        if (!parsed)
+            return false;
+        let fontResources;
+        const drFontValue = this.form?.defaultResources?.get('Font');
+        const drFonts = drFontValue instanceof PdfDictionary ? drFontValue : undefined;
+        const daFontRef = this.form?.fontRefs?.get(parsed.fontName);
+        if (drFonts || daFontRef) {
+            // Build a fresh font dict using clean PdfObjectReferences (no
+            // pre/postTokens inherited from the original parse context).
+            const fontDict = new PdfDictionary();
+            if (drFonts) {
+                for (const [key, val] of drFonts.entries()) {
+                    if (val instanceof PdfObjectReference) {
+                        fontDict.set(key, new PdfObjectReference(val.objectNumber, val.generationNumber));
+                    }
+                    else if (val != null) {
+                        fontDict.set(key, val);
+                    }
+                }
+            }
+            if (daFontRef && !fontDict.has(parsed.fontName)) {
+                fontDict.set(parsed.fontName, new PdfObjectReference(daFontRef.objectNumber, daFontRef.generationNumber));
+            }
+            fontResources = new PdfDictionary();
+            fontResources.set('Font', fontDict);
+        }
+        const isUnicode = this.form?.isFontUnicode(parsed.fontName) ?? false;
+        const encodingMap = this.form?.fontEncodingMaps?.get(parsed.fontName);
+        const reverseEncodingMap = encodingMap
+            ? new Map(Array.from(encodingMap, ([code, char]) => [char, code]))
+            : undefined;
+        this._appearanceStream = new PdfTextAppearanceStream({
+            rect: rect,
+            value: this.value,
+            da: parsed,
+            multiline: this.multiline,
+            comb: this.comb,
+            maxLen: this.maxLen,
+            fontResources,
+            isUnicode,
+            reverseEncodingMap,
+        });
+        if (options?.makeReadOnly) {
+            this.readOnly = true;
+            if (!this.print)
+                this.print = true;
+            this.noZoom = true;
+        }
+        else {
+            if (!this.print)
+                this.print = true;
+        }
+        return true;
+    }
+}

package/dist/acroform/fields/types.d.ts

@@ -1,4 +1,5 @@
 import type { PdfDefaultResourcesDictionary } from '../acroform.js';
+import type { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
 /**
  * Field types for AcroForm fields
  */
@@ -17,5 +18,9 @@ export interface FormContext<TField = any> {
     defaultResources: PdfDefaultResourcesDictionary | null;
     defaultAppearance: string | null;
     fontEncodingMaps: Map<string, Map<number, string>>;
+    /** Object references for all resolved fonts, keyed by resource name. */
+    fontRefs: Map<string, PdfObjectReference>;
     fields: TField[];
+    isFontUnicode: (fontName: string) => boolean;
+    needAppearances: boolean;
 }

package/dist/acroform/index.d.ts

@@ -1,6 +1,6 @@
 export * from './manager.js';
-export * from './PdfAcroForm.js';
+export * from './pdf-acro-form.js';
 export * from './fields/index.js';
 export * from './appearance/index.js';
 export * from './xfa/index.js';
-export { PdfFontEncodingCache } from './PdfFontEncodingCache.js';
+export { PdfFontEncodingCache } from './pdf-font-encoding-cache.js';

package/dist/acroform/index.js

@@ -1,6 +1,6 @@
 export * from './manager.js';
-export * from './PdfAcroForm.js';
+export * from './pdf-acro-form.js';
 export * from './fields/index.js';
 export * from './appearance/index.js';
 export * from './xfa/index.js';
-export { PdfFontEncodingCache } from './PdfFontEncodingCache.js';
+export { PdfFontEncodingCache } from './pdf-font-encoding-cache.js';

package/dist/acroform/manager.d.ts

@@ -1,13 +1,13 @@
 import { PdfDocument } from '../pdf/pdf-document.js';
 import { PdfAcroForm } from './acroform.js';
-import { PdfXfaForm } from './xfa/PdfXfaForm.js';
+import { PdfXfaForm } from './xfa/pdf-xfa-form.js';
 /**
  * Manages AcroForm fields in PDF documents.
  * Provides methods to read and write form field values.
  */
 export declare class PdfAcroFormManager {
     private document;
-    private _xfa;
+    private _acroform;
     constructor(document: PdfDocument);
     /**
      * Gets the XFA form wrapper, loading it lazily on first access.
@@ -24,10 +24,14 @@ export declare class PdfAcroFormManager {
      * @returns The AcroForm object or null if not found
      */
     read(): Promise<PdfAcroForm | null>;
+    /**
+     * Explicitly sets the XFA form instance, bypassing the lazy load on next write.
+     */
+    setXfa(xfa: PdfXfaForm): Promise<void>;
     /**
      * Writes the provided AcroForm to the associated PDF document.
      * @param acroForm The AcroForm instance to serialize into the document.
      * @throws Error If writing the AcroForm to the document fails.
      */
-    write(acroForm: PdfAcroForm): Promise<void>;
+    write(acroForm?: PdfAcroForm): Promise<void>;
 }

package/dist/acroform/manager.js

@@ -1,12 +1,11 @@
 import { PdfAcroForm } from './acroform.js';
-import { PdfXfaForm } from './xfa/PdfXfaForm.js';
 /**
  * Manages AcroForm fields in PDF documents.
  * Provides methods to read and write form field values.
  */
 export class PdfAcroFormManager {
     document;
-    _xfa = undefined;
+    _acroform = null;
     constructor(document) {
         this.document = document;
     }
@@ -15,10 +14,7 @@ export class PdfAcroFormManager {
      * @returns The PdfXfaForm or null if no XFA forms exist
      */
     async getXfa() {
-        if (this._xfa === undefined) {
-            this._xfa = await PdfXfaForm.fromDocument(this.document);
-        }
-        return this._xfa;
+        return (await (await this.read())?.getXfa()) || null;
     }
     /**
      * Checks if the document contains AcroForm fields.
@@ -38,7 +34,17 @@ export class PdfAcroFormManager {
      * @returns The AcroForm object or null if not found
      */
     async read() {
-        return await PdfAcroForm.fromDocument(this.document);
+        if (this._acroform)
+            return this._acroform;
+        this._acroform = await PdfAcroForm.fromDocument(this.document);
+        return this._acroform;
+    }
+    /**
+     * Explicitly sets the XFA form instance, bypassing the lazy load on next write.
+     */
+    async setXfa(xfa) {
+        ;
+        (await this.read())?.setXfa(xfa);
     }
     /**
      * Writes the provided AcroForm to the associated PDF document.
@@ -46,6 +52,6 @@ export class PdfAcroFormManager {
      * @throws Error If writing the AcroForm to the document fails.
      */
     async write(acroForm) {
-        await acroForm.write(this.document);
+        await (acroForm ?? (await this.read()))?.write(this.document);
     }
 }

package/dist/acroform/{PdfAcroForm.d.ts → pdf-acro-form.d.ts}

@@ -6,11 +6,12 @@ import { PdfObjectReference } from '../core/objects/pdf-object-reference.js';
 import { PdfIndirectObject } from '../core/objects/pdf-indirect-object.js';
 import { PdfBoolean } from '../core/objects/pdf-boolean.js';
 import { PdfNumber } from '../core/objects/pdf-number.js';
-import { PdfFormField } from './fields/PdfFormField.js';
-import './fields/PdfTextFormField.js';
-import './fields/PdfButtonFormField.js';
-import './fields/PdfChoiceFormField.js';
-import './fields/PdfSignatureFormField.js';
+import { PdfXfaForm } from './xfa/pdf-xfa-form.js';
+import { PdfFormField } from './fields/pdf-form-field.js';
+import './fields/pdf-text-form-field.js';
+import './fields/pdf-button-form-field.js';
+import './fields/pdf-choice-form-field.js';
+import './fields/pdf-signature-form-field.js';
 import type { FormContext } from './fields/types.js';
 export type PdfDefaultResourcesDictionary = PdfDictionary<{
     Font?: PdfDictionary;
@@ -34,6 +35,7 @@ export declare class PdfAcroForm<T extends Record<string, string> = Record<strin
     fields: PdfFormField[];
     private _fontEncodingCache?;
     private document?;
+    private _xfa?;
     constructor(options?: {
         other?: PdfIndirectObject;
         fields?: PdfFormField[];
@@ -41,6 +43,8 @@ export declare class PdfAcroForm<T extends Record<string, string> = Record<strin
     });
     private get fontEncodingCache();
     get fontEncodingMaps(): Map<string, Map<number, string>>;
+    get fontRefs(): Map<string, PdfObjectReference>;
+    setXfa(xfa: PdfXfaForm | null): void;
     isModified(): boolean;
     get needAppearances(): boolean;
     set needAppearances(value: boolean);
@@ -56,8 +60,10 @@ export declare class PdfAcroForm<T extends Record<string, string> = Record<strin
     importData(fields: T): void;
     exportData(): Partial<T>;
     getFontEncodingMap(fontName: string): Promise<Map<number, string> | null>;
+    isFontUnicode(fontName: string): boolean;
     static fromDocument(document: PdfDocument): Promise<PdfAcroForm | null>;
     private cacheAllFontEncodings;
     private updatePageAnnotations;
-    write(document: PdfDocument): Promise<void>;
+    getXfa(document?: PdfDocument): Promise<PdfXfaForm | null>;
+    write(document?: PdfDocument): Promise<void>;
 }