pdf-lite 1.3.1 → 1.3.3

package/README.md

@@ -13,10 +13,10 @@ PRs and issues are welcome!
 
 ## Features
 
-- **Zero dependencies**: No external libraries are required, making it lightweight and easy to integrate.
 - **Type-safe**: Built with TypeScript, ensuring type safety and reducing runtime errors.
 - **Browser and Node.js support**: Works seamlessly in both environments, allowing for versatile usage.
 - **Low-level API**: Provides a low-level API for advanced users who want to manipulate PDF files directly, as well as a higher-level API for easier usage.
+- **Minimal dependencies**: A small number external libraries are required, making it lightweight and easy to integrate.
 
 ## Installation
 

package/dist/acroform/acroform.d.ts

@@ -62,7 +62,7 @@ export declare class PdfAcroFormField extends PdfIndirectObject<PdfDictionary<{
     MaxLen?: PdfNumber;
     Opt?: PdfArray<PdfString>;
 }>> {
-    parent?: PdfAcroFormField;
+    private _parent?;
     defaultGenerateAppearance: boolean;
     private _appearanceStream?;
     private _appearanceStreamYes?;
@@ -71,6 +71,11 @@ export declare class PdfAcroFormField extends PdfIndirectObject<PdfDictionary<{
         other?: PdfIndirectObject;
         form?: PdfAcroForm;
     });
+    get parent(): PdfAcroFormField | undefined;
+    set parent(field: PdfAcroFormField | undefined);
+    get children(): PdfAcroFormField[];
+    set children(fields: PdfAcroFormField[]);
+    get siblings(): PdfAcroFormField[];
     get encodingMap(): Map<number, string> | undefined;
     /**
      * Convenience method to check if field dictionary is modified

package/dist/acroform/acroform.js

@@ -18,7 +18,7 @@ export const PdfFieldType = {
     Signature: 'Sig',
 };
 export class PdfAcroFormField extends PdfIndirectObject {
-    parent;
+    _parent;
     defaultGenerateAppearance = true;
     _appearanceStream;
     _appearanceStreamYes; // For button fields: checked state
@@ -28,6 +28,50 @@ export class PdfAcroFormField extends PdfIndirectObject {
             new PdfIndirectObject({ content: new PdfDictionary() }));
         this.form = options?.form;
     }
+    get parent() {
+        if (this._parent)
+            return this._parent;
+        if (!this.form)
+            return undefined;
+        return this.form.fields.find((f) => f !== this &&
+            f.kids.some((k) => k.objectNumber === this.objectNumber &&
+                k.generationNumber === this.generationNumber));
+    }
+    set parent(field) {
+        // Remove from old parent's Kids
+        if (this._parent) {
+            this._parent.kids = this._parent.kids.filter((k) => k.objectNumber !== this.objectNumber ||
+                k.generationNumber !== this.generationNumber);
+        }
+        this._parent = field;
+        // Add to new parent's Kids
+        if (field) {
+            const alreadyInKids = field.kids.some((k) => k.objectNumber === this.objectNumber &&
+                k.generationNumber === this.generationNumber);
+            if (!alreadyInKids) {
+                field.kids = [...field.kids, this.reference];
+            }
+        }
+    }
+    get children() {
+        if (!this.form)
+            return [];
+        return this.form.fields.filter((f) => f.parent === this);
+    }
+    set children(fields) {
+        // Clear existing children's parent
+        for (const child of this.children) {
+            child._parent = undefined;
+        }
+        // Set new children and update Kids array
+        this.kids = fields.map((f) => f.reference);
+        for (const child of fields) {
+            child._parent = this;
+        }
+    }
+    get siblings() {
+        return this.parent?.children ?? [];
+    }
     get encodingMap() {
         const fontName = this.fontName;
         if (!fontName)
@@ -44,7 +88,8 @@ export class PdfAcroFormField extends PdfIndirectObject {
      * Gets the field type
      */
     get fieldType() {
-        const ft = this.content.get('FT')?.value;
+        const ft = this.content.get('FT')?.value ??
+            this.parent?.content.get('FT')?.value;
         switch (ft) {
             case 'Tx':
                 return 'Text';
@@ -128,7 +173,7 @@ export class PdfAcroFormField extends PdfIndirectObject {
      * Gets the default value
      */
     get defaultValue() {
-        const dv = this.content.get('DV');
+        const dv = this.content.get('DV') ?? this.parent?.content.get('DV');
         if (dv instanceof PdfString) {
             return dv.value;
         }
@@ -150,7 +195,8 @@ export class PdfAcroFormField extends PdfIndirectObject {
         }
     }
     get value() {
-        const v = this.content.get('V');
+        // V may be on this field or inherited from parent (parent/kids split)
+        const v = this.content.get('V') ?? this.parent?.content.get('V');
         if (v instanceof PdfString) {
             // UTF-16BE strings should always use UTF-16BE decoding regardless of font encoding
             if (v.isUTF16BE) {
@@ -170,45 +216,56 @@ export class PdfAcroFormField extends PdfIndirectObject {
         if (this.value === val) {
             return;
         }
+        // In a parent/kids split, V should be set on the parent field
+        const target = this.parent ?? this;
         const fieldType = this.fieldType;
         if (fieldType === 'Button') {
             val = val instanceof PdfString ? val.value : val;
             if (val.trim() === '') {
-                this.content.delete('V');
+                target.content.delete('V');
                 this.content.delete('AS');
                 return;
             }
-            this.content.set('V', new PdfName(val));
+            target.content.set('V', new PdfName(val));
             this.content.set('AS', new PdfName(val));
         }
         else {
-            this.content.set('V', val instanceof PdfString ? val : new PdfString(val));
+            target.content.set('V', val instanceof PdfString ? val : new PdfString(val));
         }
         if (this.defaultGenerateAppearance) {
             this.generateAppearance();
+            // If this is a child widget with siblings, regenerate their appearances too
+            for (const sibling of this.siblings) {
+                if (sibling !== this &&
+                    sibling.rect &&
+                    sibling.defaultGenerateAppearance) {
+                    sibling.generateAppearance();
+                }
+            }
         }
     }
     get checked() {
         if (this.fieldType === 'Button') {
-            const v = this.content.get('V');
+            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) {
-                this.content.set('V', new PdfName('Yes'));
+                target.content.set('V', new PdfName('Yes'));
                 this.content.set('AS', new PdfName('Yes'));
             }
             else {
-                this.content.set('V', new PdfName('Off'));
+                target.content.set('V', new PdfName('Off'));
                 this.content.set('AS', new PdfName('Off'));
             }
         }
     }
     get fontSize() {
-        const da = this.content.get('DA')?.as(PdfString)?.value || '';
+        const da = this.defaultAppearance || '';
         const match = da.match(/\/[A-Za-z0-9_-]+\s+([\d.]+)\s+Tf/);
         if (match) {
             return parseFloat(match[1]);
@@ -216,7 +273,7 @@ export class PdfAcroFormField extends PdfIndirectObject {
         return null;
     }
     set fontSize(size) {
-        const da = this.content.get('DA')?.as(PdfString)?.value || '';
+        const da = this.defaultAppearance || '';
         if (!da) {
             this.content.set('DA', new PdfString(`/F1 ${size} Tf 0 g`));
             return;
@@ -225,7 +282,7 @@ export class PdfAcroFormField extends PdfIndirectObject {
         this.content.set('DA', new PdfString(updatedDa));
     }
     get fontName() {
-        const da = this.content.get('DA')?.as(PdfString)?.value || '';
+        const da = this.defaultAppearance || '';
         const match = da.match(/\/([A-Za-z0-9_-]+)\s+[\d.]+\s+Tf/);
         if (match) {
             return match[1];
@@ -233,7 +290,7 @@ export class PdfAcroFormField extends PdfIndirectObject {
         return null;
     }
     set fontName(fontName) {
-        const da = this.content.get('DA')?.as(PdfString)?.value || '';
+        const da = this.defaultAppearance || '';
         if (!da) {
             this.content.set('DA', new PdfString(`/${fontName} 12 Tf 0 g`));
             return;
@@ -253,7 +310,7 @@ export class PdfAcroFormField extends PdfIndirectObject {
         }
         const resourceName = font.resourceName;
         const currentSize = this.fontSize ?? 12;
-        const da = this.content.get('DA')?.as(PdfString)?.value || '';
+        const da = this.defaultAppearance || '';
         if (!da) {
             this.content.set('DA', new PdfString(`/${resourceName} ${currentSize} Tf 0 g`));
             return;
@@ -265,7 +322,9 @@ export class PdfAcroFormField extends PdfIndirectObject {
      * Gets field flags (bitwise combination of field attributes)
      */
     get flags() {
-        return this.content.get('Ff')?.as(PdfNumber)?.value ?? 0;
+        return (this.content.get('Ff')?.as(PdfNumber)?.value ??
+            this.parent?.content.get('Ff')?.as(PdfNumber)?.value ??
+            0);
     }
     /**
      * Sets field flags
@@ -364,7 +423,9 @@ export class PdfAcroFormField extends PdfIndirectObject {
      * 0 = left-justified, 1 = centered, 2 = right-justified
      */
     get quadding() {
-        return this.content.get('Q')?.as(PdfNumber)?.value ?? 0;
+        return (this.content.get('Q')?.as(PdfNumber)?.value ??
+            this.parent?.content.get('Q')?.as(PdfNumber)?.value ??
+            0);
     }
     /**
      * Sets the quadding (text alignment) for this field.
@@ -378,7 +439,8 @@ export class PdfAcroFormField extends PdfIndirectObject {
      * Returns an array of option strings.
      */
     get options() {
-        const opt = this.content.get('Opt')?.as((PdfArray));
+        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);
@@ -396,7 +458,9 @@ export class PdfAcroFormField extends PdfIndirectObject {
         this.content.set('Opt', optArray);
     }
     get defaultAppearance() {
-        return this.content.get('DA')?.as(PdfString)?.value ?? null;
+        return (this.content.get('DA')?.as(PdfString)?.value ??
+            this.parent?.content.get('DA')?.as(PdfString)?.value ??
+            null);
     }
     set defaultAppearance(da) {
         this.content.set('DA', new PdfString(da));
@@ -747,8 +811,9 @@ export class PdfAcroFormField extends PdfIndirectObject {
         const [x1, y1, x2, y2] = rect;
         const width = x2 - x1;
         const height = y2 - y1;
-        // Get the default appearance string
-        const da = this.content.get('DA')?.as(PdfString)?.value;
+        // Get the default appearance string (may be inherited from parent)
+        const da = this.content.get('DA')?.as(PdfString)?.value ??
+            this.parent?.content.get('DA')?.as(PdfString)?.value;
         if (!da)
             return false;
         // Get the field value
@@ -858,6 +923,25 @@ EMC
             new PdfNumber(width),
             new PdfNumber(height),
         ]));
+        // Add font resources so Acrobat can resolve the font name.
+        // Prefer the field's own DR (which has correctly resolved refs in incremental updates),
+        // then fall back to the AcroForm-level DR.
+        const fieldDR = this.content
+            .get('DR')
+            ?.as(PdfDictionary);
+        const acroformDR = this.form?.defaultResources;
+        const fontSource = fieldDR?.get('Font')?.as(PdfDictionary) ??
+            acroformDR?.get('Font')?.as(PdfDictionary);
+        if (fontSource && fontName) {
+            const fontRef = fontSource.get(fontName);
+            if (fontRef) {
+                const resourceFontDict = new PdfDictionary();
+                resourceFontDict.set(fontName, fontRef);
+                const resourcesDict = new PdfDictionary();
+                resourcesDict.set('Font', resourceFontDict);
+                appearanceDict.set('Resources', resourcesDict);
+            }
+        }
         const stream = new PdfStream({
             header: appearanceDict,
             original: contentStream,
@@ -978,8 +1062,9 @@ Q
         const [x1, y1, x2, y2] = rect;
         const width = x2 - x1;
         const height = y2 - y1;
-        // Get the default appearance string
-        const da = this.content.get('DA')?.as(PdfString)?.value;
+        // Get the default appearance string (may be inherited from parent)
+        const da = this.content.get('DA')?.as(PdfString)?.value ??
+            this.parent?.content.get('DA')?.as(PdfString)?.value;
         if (!da)
             return false;
         const value = this.value;
@@ -1045,6 +1130,23 @@ EMC
             new PdfNumber(width),
             new PdfNumber(height),
         ]));
+        // Add font resources so Acrobat can resolve the font name.
+        const fieldDR = this.content
+            .get('DR')
+            ?.as(PdfDictionary);
+        const acroformDR = this.form?.defaultResources;
+        const fontSource = fieldDR?.get('Font')?.as(PdfDictionary) ??
+            acroformDR?.get('Font')?.as(PdfDictionary);
+        if (fontSource && fontName) {
+            const fontRef = fontSource.get(fontName);
+            if (fontRef) {
+                const resourceFontDict = new PdfDictionary();
+                resourceFontDict.set(fontName, fontRef);
+                const resourcesDict = new PdfDictionary();
+                resourcesDict.set('Font', resourceFontDict);
+                appearanceDict.set('Resources', resourcesDict);
+            }
+        }
         const stream = new PdfStream({
             header: appearanceDict,
             original: contentStream,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf-lite",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "main": "dist/index.js",
   "type": "module",
   "exports": {