pdf-lite 1.3.3 → 1.4.0

package/dist/acroform/fields/PdfFormField.js

@@ -0,0 +1,499 @@
+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 { 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 { PdfFieldType as PdfFieldTypeConst } from './types.js';
+/**
+ * Abstract base form field class. Extends PdfWidgetAnnotation with form-specific properties:
+ * FT, V, DA, Ff, T (name), field hierarchy (parent/children/siblings).
+ * Subclasses must implement generateAppearance().
+ */
+export class PdfFormField extends PdfWidgetAnnotation {
+    _parent;
+    defaultGenerateAppearance = true;
+    _appearanceStream;
+    _appearanceStreamYes;
+    form;
+    constructor(options) {
+        super({ other: options?.other });
+        this.form = options?.form;
+        if (options?.parent) {
+            this._parent = options.parent;
+        }
+    }
+    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) {
+        if (this._parent) {
+            this._parent.kids = this._parent.kids.filter((k) => k.objectNumber !== this.objectNumber ||
+                k.generationNumber !== this.generationNumber);
+        }
+        this._parent = field;
+        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) {
+        for (const child of this.children) {
+            child._parent = undefined;
+        }
+        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)
+            return undefined;
+        return this.form?.fontEncodingMaps?.get(fontName);
+    }
+    get fieldType() {
+        const ft = this.content.get('FT')?.as(PdfName)?.value ??
+            this.parent?.content.get('FT')?.as(PdfName)?.value;
+        switch (ft) {
+            case 'Tx':
+                return 'Text';
+            case 'Btn':
+                return 'Button';
+            case 'Ch':
+                return 'Choice';
+            case 'Sig':
+                return 'Signature';
+            default:
+                return null;
+        }
+    }
+    set fieldType(type) {
+        if (type === null) {
+            this.content.delete('FT');
+        }
+        else {
+            this.content.set('FT', new PdfName(PdfFieldTypeConst[type]));
+        }
+    }
+    get name() {
+        const parentName = this.parent?.name ?? '';
+        const ownName = this.content.get('T')?.as(PdfString)?.value ?? '';
+        if (parentName && ownName) {
+            return `${parentName}.${ownName}`;
+        }
+        return parentName || ownName;
+    }
+    set name(name) {
+        this.content.set('T', new PdfString(name));
+    }
+    get defaultValue() {
+        const dv = this.content.get('DV') ?? this.parent?.content.get('DV');
+        if (dv instanceof PdfString)
+            return dv.value;
+        if (dv instanceof PdfName)
+            return dv.value;
+        return '';
+    }
+    set defaultValue(val) {
+        if (this.fieldType === 'Button') {
+            this.content.set('DV', new PdfName(val));
+        }
+        else {
+            this.content.set('DV', new PdfString(val));
+        }
+    }
+    get value() {
+        const v = this.content.get('V') ?? this.parent?.content.get('V');
+        if (v instanceof PdfString) {
+            if (v.isUTF16BE)
+                return v.value;
+            if (this.encodingMap) {
+                return decodeWithFontEncoding(v.raw, this.encodingMap);
+            }
+            return v.value;
+        }
+        else if (v instanceof PdfName) {
+            return v.value;
+        }
+        return '';
+    }
+    set value(val) {
+        if (this.value === val)
+            return;
+        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();
+            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') ?? 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'));
+            }
+        }
+    }
+    get fontSize() {
+        const da = this.defaultAppearance || '';
+        const parsed = PdfDefaultAppearance.parse(da);
+        return parsed?.fontSize ?? null;
+    }
+    set fontSize(size) {
+        const da = this.defaultAppearance || '';
+        if (!da) {
+            this.content.set('DA', new PdfDefaultAppearance('F1', size, '0 g'));
+            return;
+        }
+        const parsed = PdfDefaultAppearance.parse(da);
+        if (parsed) {
+            parsed.fontSize = size;
+            this.content.set('DA', parsed);
+        }
+    }
+    get fontName() {
+        const da = this.defaultAppearance || '';
+        const parsed = PdfDefaultAppearance.parse(da);
+        return parsed?.fontName ?? null;
+    }
+    set fontName(fontName) {
+        const da = this.defaultAppearance || '';
+        if (!da) {
+            this.content.set('DA', new PdfDefaultAppearance(fontName, 12, '0 g'));
+            return;
+        }
+        const parsed = PdfDefaultAppearance.parse(da);
+        if (parsed) {
+            parsed.fontName = fontName;
+            this.content.set('DA', parsed);
+        }
+    }
+    set font(font) {
+        if (font === null) {
+            this.content.set('DA', new PdfString(''));
+            return;
+        }
+        const resourceName = font.resourceName;
+        const currentSize = this.fontSize ?? 12;
+        const da = this.defaultAppearance || '';
+        if (!da) {
+            this.content.set('DA', new PdfDefaultAppearance(resourceName, currentSize, '0 g'));
+            return;
+        }
+        const parsed = PdfDefaultAppearance.parse(da);
+        if (parsed) {
+            parsed.fontName = resourceName;
+            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));
+    }
+    getFlag(bit) {
+        return (this.flags & bit) !== 0;
+    }
+    setFlag(bit, value) {
+        if (value) {
+            this.flags = this.flags | bit;
+        }
+        else {
+            this.flags = this.flags & ~bit;
+        }
+    }
+    get readOnly() {
+        return this.getFlag(1);
+    }
+    set readOnly(v) {
+        this.setFlag(1, v);
+    }
+    get required() {
+        return this.getFlag(2);
+    }
+    set required(v) {
+        this.setFlag(2, v);
+    }
+    get multiline() {
+        return this.getFlag(4096);
+    }
+    set multiline(v) {
+        this.setFlag(4096, v);
+    }
+    get password() {
+        return this.getFlag(8192);
+    }
+    set password(v) {
+        this.setFlag(8192, v);
+    }
+    get comb() {
+        return this.getFlag(16777216);
+    }
+    get combField() {
+        return this.getFlag(16777216);
+    }
+    set combField(v) {
+        this.setFlag(16777216, v);
+    }
+    get combo() {
+        return this.getFlag(131072);
+    }
+    set combo(v) {
+        this.setFlag(131072, v);
+    }
+    get radio() {
+        return this.getFlag(32768);
+    }
+    set radio(v) {
+        this.setFlag(32768, v);
+    }
+    get noToggleToOff() {
+        return this.getFlag(16384);
+    }
+    set noToggleToOff(v) {
+        this.setFlag(16384, v);
+    }
+    get noExport() {
+        return this.getFlag(4);
+    }
+    set noExport(v) {
+        this.setFlag(4, v);
+    }
+    get pushButton() {
+        return this.getFlag(65536);
+    }
+    set pushButton(v) {
+        this.setFlag(65536, v);
+    }
+    get edit() {
+        return this.getFlag(262144);
+    }
+    set edit(v) {
+        this.setFlag(262144, v);
+    }
+    get sort() {
+        return this.getFlag(524288);
+    }
+    set sort(v) {
+        this.setFlag(524288, v);
+    }
+    get multiSelect() {
+        return this.getFlag(2097152);
+    }
+    set multiSelect(v) {
+        this.setFlag(2097152, v);
+    }
+    get doNotSpellCheck() {
+        return this.getFlag(4194304);
+    }
+    set doNotSpellCheck(v) {
+        this.setFlag(4194304, v);
+    }
+    get doNotScroll() {
+        return this.getFlag(8388608);
+    }
+    set doNotScroll(v) {
+        this.setFlag(8388608, v);
+    }
+    get commitOnSelChange() {
+        return this.getFlag(67108864);
+    }
+    set commitOnSelChange(v) {
+        this.setFlag(67108864, v);
+    }
+    get quadding() {
+        return (this.content.get('Q')?.as(PdfNumber)?.value ??
+            this.parent?.content.get('Q')?.as(PdfNumber)?.value ??
+            0);
+    }
+    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 ??
+            this.form?.defaultAppearance ??
+            null);
+    }
+    set defaultAppearance(da) {
+        this.content.set('DA', new PdfString(da));
+    }
+    get maxLen() {
+        return this.content.get('MaxLen')?.as(PdfNumber)?.value ?? null;
+    }
+    set maxLen(maxLen) {
+        if (maxLen === null) {
+            this.content.delete('MaxLen');
+        }
+        else {
+            this.content.set('MaxLen', new PdfNumber(maxLen));
+        }
+    }
+    get kids() {
+        const kidsArray = this.content
+            .get('Kids')
+            ?.as((PdfArray));
+        if (!kidsArray)
+            return [];
+        return kidsArray.items;
+    }
+    set kids(kids) {
+        if (kids.length === 0) {
+            this.content.delete('Kids');
+            return;
+        }
+        const kidsArray = new PdfArray(kids);
+        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) {
+        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);
+        }
+    }
+    static _fallbackCtor;
+    static _registry = new Map();
+    static registerFieldType(ft, ctor, options) {
+        PdfFormField._registry.set(ft, ctor);
+        if (options?.fallback) {
+            PdfFormField._fallbackCtor = ctor;
+        }
+    }
+    static create(options) {
+        let ft;
+        try {
+            const dict = options.other.content.as(PdfDictionary);
+            ft = dict.get('FT')?.as(PdfName)?.value;
+        }
+        catch {
+            // content may not be a dictionary
+        }
+        if (!ft && options.parent) {
+            try {
+                ft = options.parent.content.get('FT')?.as(PdfName)?.value;
+            }
+            catch {
+                // ignore
+            }
+        }
+        const Ctor = ft ? PdfFormField._registry.get(ft) : undefined;
+        if (!Ctor) {
+            // Fields without FT are parent/container nodes — use the
+            // fallback type (typically Text) as a concrete stand-in.
+            if (!PdfFormField._fallbackCtor) {
+                throw new Error(`Unknown field type: ${ft ?? '(none)'}`);
+            }
+            return new PdfFormField._fallbackCtor(options);
+        }
+        return new Ctor(options);
+    }
+}
+/** Backward compatible alias */
+export { PdfFormField as PdfAcroFormField };

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

@@ -0,0 +1,46 @@
+import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
+/**
+ * Field-specific Ff flag accessors for form fields.
+ * These are separate from annotation flags (F field).
+ */
+export declare class PdfFormFieldFlags {
+    dict: PdfDictionary;
+    parentDict?: PdfDictionary;
+    constructor(dict: PdfDictionary, parentDict?: PdfDictionary);
+    get flags(): number;
+    set flags(flags: number);
+    private getFlag;
+    private setFlag;
+    get readOnly(): boolean;
+    set readOnly(v: boolean);
+    get required(): boolean;
+    set required(v: boolean);
+    get noExport(): boolean;
+    set noExport(v: boolean);
+    get multiline(): boolean;
+    set multiline(v: boolean);
+    get password(): boolean;
+    set password(v: boolean);
+    get noToggleToOff(): boolean;
+    set noToggleToOff(v: boolean);
+    get radio(): boolean;
+    set radio(v: boolean);
+    get pushButton(): boolean;
+    set pushButton(v: boolean);
+    get combo(): boolean;
+    set combo(v: boolean);
+    get edit(): boolean;
+    set edit(v: boolean);
+    get sort(): boolean;
+    set sort(v: boolean);
+    get multiSelect(): boolean;
+    set multiSelect(v: boolean);
+    get doNotSpellCheck(): boolean;
+    set doNotSpellCheck(v: boolean);
+    get doNotScroll(): boolean;
+    set doNotScroll(v: boolean);
+    get comb(): boolean;
+    set comb(v: boolean);
+    get commitOnSelChange(): boolean;
+    set commitOnSelChange(v: boolean);
+}

package/dist/acroform/fields/PdfFormFieldFlags.js

@@ -0,0 +1,128 @@
+import { PdfNumber } from '../../core/objects/pdf-number.js';
+/**
+ * Field-specific Ff flag accessors for form fields.
+ * These are separate from annotation flags (F field).
+ */
+export class PdfFormFieldFlags {
+    dict;
+    parentDict;
+    constructor(dict, parentDict) {
+        this.dict = dict;
+        this.parentDict = parentDict;
+    }
+    get flags() {
+        return (this.dict.get('Ff')?.as(PdfNumber)?.value ??
+            this.parentDict?.get('Ff')?.as(PdfNumber)?.value ??
+            0);
+    }
+    set flags(flags) {
+        this.dict.set('Ff', new PdfNumber(flags));
+    }
+    getFlag(bit) {
+        return (this.flags & bit) !== 0;
+    }
+    setFlag(bit, value) {
+        if (value) {
+            this.flags = this.flags | bit;
+        }
+        else {
+            this.flags = this.flags & ~bit;
+        }
+    }
+    get readOnly() {
+        return this.getFlag(1);
+    }
+    set readOnly(v) {
+        this.setFlag(1, v);
+    }
+    get required() {
+        return this.getFlag(2);
+    }
+    set required(v) {
+        this.setFlag(2, v);
+    }
+    get noExport() {
+        return this.getFlag(4);
+    }
+    set noExport(v) {
+        this.setFlag(4, v);
+    }
+    get multiline() {
+        return this.getFlag(4096);
+    }
+    set multiline(v) {
+        this.setFlag(4096, v);
+    }
+    get password() {
+        return this.getFlag(8192);
+    }
+    set password(v) {
+        this.setFlag(8192, v);
+    }
+    get noToggleToOff() {
+        return this.getFlag(16384);
+    }
+    set noToggleToOff(v) {
+        this.setFlag(16384, v);
+    }
+    get radio() {
+        return this.getFlag(32768);
+    }
+    set radio(v) {
+        this.setFlag(32768, v);
+    }
+    get pushButton() {
+        return this.getFlag(65536);
+    }
+    set pushButton(v) {
+        this.setFlag(65536, v);
+    }
+    get combo() {
+        return this.getFlag(131072);
+    }
+    set combo(v) {
+        this.setFlag(131072, v);
+    }
+    get edit() {
+        return this.getFlag(262144);
+    }
+    set edit(v) {
+        this.setFlag(262144, v);
+    }
+    get sort() {
+        return this.getFlag(524288);
+    }
+    set sort(v) {
+        this.setFlag(524288, v);
+    }
+    get multiSelect() {
+        return this.getFlag(2097152);
+    }
+    set multiSelect(v) {
+        this.setFlag(2097152, v);
+    }
+    get doNotSpellCheck() {
+        return this.getFlag(4194304);
+    }
+    set doNotSpellCheck(v) {
+        this.setFlag(4194304, v);
+    }
+    get doNotScroll() {
+        return this.getFlag(8388608);
+    }
+    set doNotScroll(v) {
+        this.setFlag(8388608, v);
+    }
+    get comb() {
+        return this.getFlag(16777216);
+    }
+    set comb(v) {
+        this.setFlag(16777216, v);
+    }
+    get commitOnSelChange() {
+        return this.getFlag(67108864);
+    }
+    set commitOnSelChange(v) {
+        this.setFlag(67108864, v);
+    }
+}

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

@@ -0,0 +1,7 @@
+import { PdfFormField } from './PdfFormField.js';
+/**
+ * Signature form field subtype.
+ */
+export declare class PdfSignatureFormField extends PdfFormField {
+    generateAppearance(): boolean;
+}

package/dist/acroform/fields/PdfSignatureFormField.js

@@ -0,0 +1,12 @@
+import { PdfFormField } from './PdfFormField.js';
+/**
+ * Signature form field subtype.
+ */
+export class PdfSignatureFormField extends PdfFormField {
+    static {
+        PdfFormField.registerFieldType('Sig', PdfSignatureFormField);
+    }
+    generateAppearance() {
+        return false;
+    }
+}

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

@@ -0,0 +1,10 @@
+import { PdfFormField } from './PdfFormField.js';
+/**
+ * Text form field subtype.
+ */
+export declare class PdfTextFormField extends PdfFormField {
+    generateAppearance(options?: {
+        makeReadOnly?: boolean;
+        textYOffset?: number;
+    }): boolean;
+}