pdf-lite 1.4.0 → 1.6.0

package/dist/acroform/fields/PdfChoiceFormField.js

@@ -1,46 +0,0 @@
-import { PdfFormField } from './PdfFormField.js';
-import { PdfDefaultAppearance } from './PdfDefaultAppearance.js';
-import { PdfChoiceAppearanceStream } from '../appearance/PdfChoiceAppearanceStream.js';
-import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
-/**
- * Choice form field subtype (dropdowns, list boxes).
- */
-export class PdfChoiceFormField extends PdfFormField {
-    static {
-        PdfFormField.registerFieldType('Ch', PdfChoiceFormField);
-    }
-    generateAppearance(options) {
-        const rect = this.rect;
-        if (!rect || rect.length !== 4)
-            return false;
-        const da = this.defaultAppearance;
-        if (!da)
-            return false;
-        const value = this.value;
-        if (!value)
-            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;
-        if (drFonts) {
-            fontResources = new PdfDictionary();
-            fontResources.set('Font', drFonts);
-        }
-        this._appearanceStream = new PdfChoiceAppearanceStream({
-            rect: rect,
-            value,
-            da: parsed,
-            flags: this.flags,
-            fontResources,
-        });
-        if (options?.makeReadOnly) {
-            this.readOnly = true;
-            this.print = true;
-            this.noZoom = true;
-        }
-        return true;
-    }
-}

package/dist/acroform/fields/PdfFormField.js

@@ -1,499 +0,0 @@
-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/manager.d.ts

@@ -1,33 +0,0 @@
-import { PdfDocument } from '../pdf/pdf-document.js';
-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 declare class PdfAcroFormManager {
-    private document;
-    private _xfa;
-    constructor(document: PdfDocument);
-    /**
-     * Gets the XFA form wrapper, loading it lazily on first access.
-     * @returns The PdfXfaForm or null if no XFA forms exist
-     */
-    getXfa(): Promise<PdfXfaForm | null>;
-    /**
-     * Checks if the document contains AcroForm fields.
-     * @returns True if the document has AcroForm fields, false otherwise
-     */
-    exists(): Promise<boolean>;
-    /**
-     * Gets the AcroForm object from the document catalog.
-     * @returns The AcroForm object or null if not found
-     */
-    read(): Promise<PdfAcroForm | null>;
-    /**
-     * 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>;
-}

package/dist/acroform/manager.js

@@ -1,51 +0,0 @@
-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;
-    constructor(document) {
-        this.document = document;
-    }
-    /**
-     * Gets the XFA form wrapper, loading it lazily on first access.
-     * @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;
-    }
-    /**
-     * Checks if the document contains AcroForm fields.
-     * @returns True if the document has AcroForm fields, false otherwise
-     */
-    async exists() {
-        try {
-            const acroForm = await this.read();
-            return acroForm !== null;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * Gets the AcroForm object from the document catalog.
-     * @returns The AcroForm object or null if not found
-     */
-    async read() {
-        return await PdfAcroForm.fromDocument(this.document);
-    }
-    /**
-     * 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.
-     */
-    async write(acroForm) {
-        await acroForm.write(this.document);
-    }
-}

package/dist/acroform/xfa/PdfXfaForm.d.ts

@@ -1,12 +0,0 @@
-import { PdfDocument } from '../../pdf/pdf-document.js';
-import { PdfArray } from '../../core/objects/pdf-array.js';
-import { PdfXfaData } from './PdfXfaData.js';
-/**
- * Typed wrapper around the XFA name/stream-ref array.
- * Holds eagerly-loaded references to component streams like datasets.
- */
-export declare class PdfXfaForm extends PdfArray {
-    datasets: PdfXfaData | null;
-    static fromDocument(document: PdfDocument): Promise<PdfXfaForm | null>;
-    write(document: PdfDocument): void;
-}

package/dist/acroform/xfa/PdfXfaForm.js

@@ -1,64 +0,0 @@
-import { PdfArray } from '../../core/objects/pdf-array.js';
-import { PdfDictionary } from '../../core/objects/pdf-dictionary.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 { PdfXfaData } from './PdfXfaData.js';
-/**
- * Typed wrapper around the XFA name/stream-ref array.
- * Holds eagerly-loaded references to component streams like datasets.
- */
-export class PdfXfaForm extends PdfArray {
-    datasets = null;
-    static async fromDocument(document) {
-        const catalog = document.root;
-        const acroFormRef = catalog.content.get('AcroForm');
-        if (!acroFormRef)
-            return null;
-        let acroFormDict;
-        if (acroFormRef instanceof PdfObjectReference) {
-            const acroFormObject = await document.readObject({
-                objectNumber: acroFormRef.objectNumber,
-                generationNumber: acroFormRef.generationNumber,
-            });
-            if (!acroFormObject)
-                return null;
-            acroFormDict = acroFormObject.content.as(PdfDictionary);
-        }
-        else if (acroFormRef instanceof PdfDictionary) {
-            acroFormDict = acroFormRef;
-        }
-        else {
-            return null;
-        }
-        const xfaArray = acroFormDict.get('XFA');
-        if (!(xfaArray instanceof PdfArray))
-            return null;
-        const form = new PdfXfaForm(xfaArray.items.slice());
-        // Find the datasets reference in the name/ref pairs
-        const items = xfaArray.items;
-        for (let i = 0; i < items.length - 1; i += 2) {
-            const name = items[i];
-            const ref = items[i + 1];
-            if (name instanceof PdfString &&
-                name.value === 'datasets' &&
-                ref instanceof PdfObjectReference) {
-                const datasetObject = (await document.readObject({
-                    objectNumber: ref.objectNumber,
-                    generationNumber: ref.generationNumber,
-                    allowUnindexed: true,
-                }))?.as((PdfIndirectObject));
-                if (datasetObject) {
-                    form.datasets = new PdfXfaData(datasetObject);
-                }
-                break;
-            }
-        }
-        return form;
-    }
-    write(document) {
-        if (this.datasets?.isModified()) {
-            document.add(this.datasets);
-        }
-    }
-}