pdf-lite 1.5.0 → 1.6.0

package/EXAMPLES.md

@@ -10,38 +10,11 @@ import { PdfArray } from 'pdf-lite/core/objects/pdf-array'
 import { PdfDictionary } from 'pdf-lite/core/objects/pdf-dictionary'
 import { PdfIndirectObject } from 'pdf-lite/core/objects/pdf-indirect-object'
 import { PdfName } from 'pdf-lite/core/objects/pdf-name'
-import { PdfNumber } from 'pdf-lite/core/objects/pdf-number'
 import { PdfObjectReference } from 'pdf-lite/core/objects/pdf-object-reference'
 import { PdfStream } from 'pdf-lite/core/objects/pdf-stream'
 import { PdfDocument } from 'pdf-lite/pdf/pdf-document'
-
-function createPage(
-    contentStreamRef: PdfObjectReference,
-): PdfIndirectObject<PdfDictionary> {
-    const pageDict = new PdfDictionary()
-    pageDict.set('Type', new PdfName('Page'))
-    pageDict.set(
-        'MediaBox',
-        new PdfArray([
-            new PdfNumber(0),
-            new PdfNumber(0),
-            new PdfNumber(612),
-            new PdfNumber(792),
-        ]),
-    )
-    pageDict.set('Contents', contentStreamRef)
-    return new PdfIndirectObject({ content: pageDict })
-}
-
-function createPages(
-    pages: PdfIndirectObject<PdfDictionary>[],
-): PdfIndirectObject<PdfDictionary> {
-    const pagesDict = new PdfDictionary()
-    pagesDict.set('Type', new PdfName('Pages'))
-    pagesDict.set('Kids', new PdfArray(pages.map((x) => x.reference)))
-    pagesDict.set('Count', new PdfNumber(pages.length))
-    return new PdfIndirectObject({ content: pagesDict })
-}
+import { PdfPage } from 'pdf-lite/pdf/pdf-page'
+import { PdfPages } from 'pdf-lite/pdf/pdf-pages'
 
 function createCatalog(
     pagesRef: PdfObjectReference,
@@ -89,16 +62,18 @@ const contentStream = new PdfIndirectObject({
     }),
 })
 
-// Create a page
-const page = createPage(contentStream.reference)
-// Add resources to the page
-page.content.set('Resources', resources.reference)
+// Create a page using PdfPage
+const page = new PdfPage()
+page.mediaBox = [0, 0, 612, 792]
+page.contents = contentStream.reference
+page.resources = resources.reference
 document.add(page)
 
-// Create pages collection
-const pages = createPages([page])
-// Set parent reference for the page
-page.content.set('Parent', pages.reference)
+// Create pages collection using PdfPages
+const pages = new PdfPages()
+pages.kids = new PdfArray([page.reference])
+pages.count = 1
+page.parent = pages
 document.add(pages)
 
 // Create catalog
@@ -109,7 +84,7 @@ document.add(catalog)
 document.trailerDict.set('Root', catalog.reference)
 
 document.add(contentStream)
-await document.commit()
+await document.finalize()
 
 const file = `${import.meta.dirname}/tmp/created.pdf`
 console.log(`Writing PDF to: ${file}`)
@@ -225,7 +200,7 @@ document.add(catalog)
 document.trailerDict.set('Root', catalog.reference)
 
 document.add(contentStream)
-await document.commit()
+await document.finalize()
 
 document.securityHandler = new PdfV2SecurityHandler({
     password: 'up',
@@ -577,14 +552,7 @@ document.add(catalog)
 // Set the catalog as the root
 document.trailerDict.set('Root', catalog.reference)
 
-// IMPORTANT: Add all signatures LAST - after all other objects
-// This ensures the ByteRange is calculated correctly for each signature
-allSignatures.forEach((sig) => {
-    document.startNewRevision()
-    document.add(sig)
-})
-
-await document.commit()
+await document.finalize()
 
 const tmpFolder = `${import.meta.dirname}/tmp`
 await fs.mkdir(tmpFolder, { recursive: true })
@@ -694,7 +662,7 @@ document.add(catalog)
 document.trailerDict.set('Root', catalog.reference)
 document.add(contentStream)
 
-await document.commit()
+await document.finalize()
 // Save the original PDF
 const originalPdfPath = `${tmpFolder}/original.pdf`
 await fs.writeFile(originalPdfPath, document.toBytes())
@@ -706,7 +674,9 @@ console.log('\nStep 2: Loading PDF and performing incremental update...')
 
 // Read the existing PDF
 const existingPdfBytes = await fs.readFile(originalPdfPath)
-const loadedDocument = await PdfDocument.fromBytes([existingPdfBytes])
+const loadedDocument = await PdfDocument.fromBytes([existingPdfBytes], {
+    incremental: true,
+})
 
 // Lock existing revisions to enable incremental mode
 // This ensures changes are added as new revisions instead of modifying existing ones
@@ -726,7 +696,7 @@ const newContentStream = new PdfIndirectObject({
 
 // Add the new content to the document
 loadedDocument.add(newContentStream)
-await loadedDocument.commit()
+await loadedDocument.finalize()
 
 // Save the incrementally updated PDF
 const updatedPdfPath = `${tmpFolder}/incremental-update.pdf`
@@ -768,7 +738,9 @@ console.log(`Original content preserved: ${originalBytesMatch ? 'Yes' : 'No'}`)
 // Step 4: Add another incremental revision
 console.log('\nStep 4: Adding another incremental revision...')
 
-const secondUpdate = await PdfDocument.fromBytes([updatedPdfBytes])
+const secondUpdate = await PdfDocument.fromBytes([updatedPdfBytes], {
+    incremental: true,
+})
 secondUpdate.setIncremental(true)
 
 const thirdRevisionContent = new PdfIndirectObject({
@@ -780,7 +752,7 @@ const thirdRevisionContent = new PdfIndirectObject({
 })
 
 secondUpdate.add(thirdRevisionContent)
-await secondUpdate.commit()
+await secondUpdate.finalize()
 
 const multiRevisionPdfPath = `${tmpFolder}/multi-revision.pdf`
 await fs.writeFile(multiRevisionPdfPath, secondUpdate.toBytes())
@@ -1092,7 +1064,7 @@ document.add(catalog)
 // Set the catalog as the root
 document.trailerDict.set('Root', catalog.reference)
 
-await document.commit()
+await document.finalize()
 
 // Save the empty form
 // This demonstrates creating a blank form that users can fill in
@@ -1109,7 +1081,7 @@ console.log('Created form-empty.pdf with empty form fields')
 const emptyFormBytes = await fs.readFile(`${tmpFolder}/form-empty.pdf`)
 const filledDocument = await PdfDocument.fromBytes([emptyFormBytes])
 
-const acroform = await filledDocument.acroForm.read()
+const acroform = filledDocument.acroform
 if (!acroform) {
     throw new Error('No AcroForm found in the document')
 }
@@ -1119,7 +1091,6 @@ acroform.importData({
     phone: '+1 (555) 123-4567',
     subscribe: 'Off', // For checkbox, use the "Yes/Off" value
 })
-await filledDocument.acroForm.write(acroform)
 
 // Save the filled form
 await fs.writeFile(`${tmpFolder}/form-filled.pdf`, filledDocument.toBytes())
@@ -1808,7 +1779,7 @@ allSignatures.forEach((sig) => {
     document.add(sig)
 })
 
-await document.commit()
+await document.finalize()
 
 const documentBytes = document.toBytes()
 const newDocument = await PdfDocument.fromBytes([documentBytes])
@@ -1885,7 +1856,7 @@ async function main() {
 
     document.add(pages, catalog)
     document.trailerDict.set('Root', catalog.reference)
-    await document.commit()
+    await document.finalize()
 
     // Build content stream with different fonts
     // F1=Helvetica-Bold, F2=Times-Roman, F3=Courier, F4=Roboto
@@ -1930,11 +1901,13 @@ async function main() {
         }),
     })
 
-    // Embed fonts - FontManager will automatically add them to the /Pages Resources
-    const helveticaBold =
-        await document.fonts.embedStandardFont('Helvetica-Bold')
-    const timesRoman = await document.fonts.embedStandardFont('Times-Roman')
-    const courier = await document.fonts.embedStandardFont('Courier')
+    // Create standard fonts and assign resource names to match the content stream
+    const helveticaBold = PdfFont.fromStandardFont('Helvetica-Bold')
+    helveticaBold.resourceName = 'F1'
+    const timesRoman = PdfFont.fromStandardFont('Times-Roman')
+    timesRoman.resourceName = 'F2'
+    const courier = PdfFont.fromStandardFont('Courier')
+    courier.resourceName = 'F3'
 
     console.log(
         `Embedded standard fonts: ${helveticaBold}, ${timesRoman}, ${courier}`,
@@ -1960,6 +1933,7 @@ async function main() {
     // - Creates a ready-to-use PdfFont instance
     // - Throws descriptive errors for unsupported formats (WOFF2, CFF-based OTF)
     const robotoFont = PdfFont.fromBytes(fontData)
+    robotoFont.resourceName = 'F4'
 
     console.log(
         `Created PdfFont from bytes - Font name: ${robotoFont.fontName}`,
@@ -1969,15 +1943,22 @@ async function main() {
         `  Embedded font data preserved: ${robotoFont.fontData ? 'Yes' : 'No'}`,
     )
 
-    // Write the font to the document
-    // FontManager.write() automatically:
-    // - Assigns a resource name (F1, F2, F3, etc.)
-    // - Creates the container indirect object
-    // - Adds the font to the /Pages node Resources dictionary
-    // - All child pages inherit these fonts (even pages added later!)
-    await document.fonts.write(robotoFont)
+    // Add all fonts to the document
+    document.add(helveticaBold, timesRoman, courier, robotoFont)
     console.log(`Embedded custom font in PDF: ${robotoFont}`)
 
+    // Build a Font resource dictionary mapping resource names to font references
+    const fontDict = new PdfDictionary()
+    fontDict.set(helveticaBold.resourceName, helveticaBold.reference)
+    fontDict.set(timesRoman.resourceName, timesRoman.reference)
+    fontDict.set(courier.resourceName, courier.reference)
+    fontDict.set(robotoFont.resourceName, robotoFont.reference)
+
+    // Add font resources to the /Pages node so all child pages inherit them
+    const resourcesDict = new PdfDictionary()
+    resourcesDict.set('Font', fontDict)
+    pages.content.set('Resources', resourcesDict)
+
     console.log(`\nFont resource mappings:`)
     console.log(`  ${helveticaBold.resourceName} = Helvetica-Bold`)
     console.log(`  ${timesRoman.resourceName} = Times-Roman`)
@@ -1992,7 +1973,7 @@ async function main() {
     pages.content.set('Count', new PdfNumber(1))
 
     document.add(contentStream, page)
-    await document.commit()
+    await document.finalize()
 
     console.log(`\nFont resource mappings:`)
     console.log(`  ${helveticaBold.resourceName} = Helvetica-Bold`)

package/README.md

@@ -4,7 +4,7 @@
 
 A low-level, minimal-dependency, type-safe PDF library that works in the browser and Node.js.
 
-> **Note**: This library is actively developed and may not support all PDF features yet. However, it is designed to be extensible and can be improved over time.
+> **Note**: This library is actively developed and may not support all PDF features yet. However, it is designed to be extensible and can be improved over time. I would also not expect the API to be stable until at least version 2.0 as a lot of features are still being added and the API is evolving.
 
 PRs and issues are welcome!
 

package/dist/acroform/appearance/pdf-button-appearance-stream.d.ts

@@ -9,5 +9,5 @@ export declare class PdfButtonAppearanceStream extends PdfAppearanceStream {
         height: number;
         contentStream: string;
     });
-    static buildYesContent(width: number, height: number, flags: number | PdfFormFieldFlags): string;
+    static buildYesContent(width: number, height: number, flags: number | PdfFormFieldFlags): PdfButtonAppearanceStream;
 }

package/dist/acroform/appearance/pdf-button-appearance-stream.js

@@ -10,7 +10,7 @@ export class PdfButtonAppearanceStream extends PdfAppearanceStream {
     constructor(ctx) {
         const resources = new PdfDictionary();
         const fonts = new PdfDictionary();
-        fonts.set('ZaDb', PdfFont.ZAPF_DINGBATS);
+        fonts.set('ZaDb', PdfFont.ZAPF_DINGBATS.dict.clone());
         resources.set('Font', fonts);
         super({
             width: ctx.width,
@@ -49,6 +49,10 @@ export class PdfButtonAppearanceStream extends PdfAppearanceStream {
             g.endText();
             g.restore();
         }
-        return g.build();
+        return new PdfButtonAppearanceStream({
+            width,
+            height,
+            contentStream: g.build(),
+        });
     }
 }

package/dist/acroform/fields/pdf-button-form-field.d.ts

@@ -1,8 +1,5 @@
 import { PdfFormField } from './pdf-form-field.js';
 import { PdfString } from '../../core/objects/pdf-string.js';
-import { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
-import type { PdfAppearanceStream } from '../appearance/pdf-appearance-stream.js';
-import type { PdfStream } from '../../core/objects/pdf-stream.js';
 /**
  * Button form field subtype (checkboxes, radio buttons, push buttons).
  */
@@ -11,12 +8,6 @@ export declare class PdfButtonFormField extends PdfFormField {
     protected _storeValue(val: string | PdfString, fieldParent: PdfFormField | undefined): boolean;
     get checked(): boolean;
     set checked(isChecked: boolean);
-    getAppearanceStream(): PdfStream | undefined;
-    getAppearanceStreamsForWriting(): {
-        primary: PdfAppearanceStream;
-        secondary?: PdfAppearanceStream;
-    } | undefined;
-    setAppearanceReference(appearanceStreamRef: PdfObjectReference, appearanceStreamYesRef?: PdfObjectReference): void;
     generateAppearance(options?: {
         makeReadOnly?: boolean;
     }): boolean;

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

@@ -2,7 +2,6 @@ import { PdfFormField } from './pdf-form-field.js';
 import { PdfButtonAppearanceStream } from '../appearance/pdf-button-appearance-stream.js';
 import { PdfName } from '../../core/objects/pdf-name.js';
 import { PdfString } from '../../core/objects/pdf-string.js';
-import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
 /**
  * Button form field subtype (checkboxes, radio buttons, push buttons).
  */
@@ -41,36 +40,6 @@ export class PdfButtonFormField extends PdfFormField {
             this.content.set('AS', new PdfName('Off'));
         }
     }
-    getAppearanceStream() {
-        if (this.checked && this._appearanceStreamYes) {
-            return this._appearanceStreamYes.content;
-        }
-        return this._appearanceStream?.content;
-    }
-    getAppearanceStreamsForWriting() {
-        if (!this._appearanceStream)
-            return undefined;
-        return {
-            primary: this._appearanceStream,
-            secondary: this._appearanceStreamYes,
-        };
-    }
-    setAppearanceReference(appearanceStreamRef, appearanceStreamYesRef) {
-        let apDict = this.appearanceStreamDict;
-        if (!apDict) {
-            apDict = new PdfDictionary();
-            this.appearanceStreamDict = apDict;
-        }
-        if (appearanceStreamYesRef) {
-            const stateDict = new PdfDictionary();
-            stateDict.set('Off', appearanceStreamRef);
-            stateDict.set('Yes', appearanceStreamYesRef);
-            apDict.set('N', stateDict);
-        }
-        else {
-            apDict.set('N', appearanceStreamRef);
-        }
-    }
     generateAppearance(options) {
         const rect = this.rect;
         if (!rect || rect.length !== 4)
@@ -78,19 +47,18 @@ export class PdfButtonFormField extends PdfFormField {
         const [x1, y1, x2, y2] = rect;
         const width = x2 - x1;
         const height = y2 - y1;
-        this._appearanceStream = new PdfButtonAppearanceStream({
-            width,
-            height,
-            contentStream: '',
-        });
         // Merge own flags with parent flags so inherited bits (e.g. Radio) are
         // not lost when a child widget has its own Ff entry (even Ff: 0).
         const effectiveFlags = this.flags.flags | (this.parent?.flags?.flags ?? 0);
-        const yesContent = PdfButtonAppearanceStream.buildYesContent(width, height, effectiveFlags);
-        this._appearanceStreamYes = new PdfButtonAppearanceStream({
+        const yesAppearance = PdfButtonAppearanceStream.buildYesContent(width, height, effectiveFlags);
+        const noAppearance = new PdfButtonAppearanceStream({
             width,
             height,
-            contentStream: yesContent,
+            contentStream: '',
+        });
+        this.setAppearanceStream({
+            Yes: yesAppearance,
+            Off: noAppearance,
         });
         if (options?.makeReadOnly) {
             this.readOnly = true;

package/dist/acroform/fields/pdf-choice-form-field.d.ts

@@ -1,4 +1,5 @@
 import { PdfFormField } from './pdf-form-field.js';
+import { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
 /**
  * Choice form field subtype (dropdowns, list boxes).
  */
@@ -11,7 +12,7 @@ export declare class PdfChoiceFormField extends PdfFormField {
     set options(values: {
         label: string;
         value: string;
-    }[] | string[] | undefined);
+    }[] | string[] | PdfObjectReference | undefined);
     generateAppearance(options?: {
         makeReadOnly?: boolean;
     }): boolean;

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

@@ -1,10 +1,10 @@
 import { PdfFormField } from './pdf-form-field.js';
 import { PdfDefaultAppearance } from './pdf-default-appearance.js';
 import { PdfChoiceAppearanceStream } from '../appearance/pdf-choice-appearance-stream.js';
-import { PdfDictionary } from '../../core/objects/pdf-dictionary.js';
 import { PdfObjectReference } from '../../core/objects/pdf-object-reference.js';
 import { PdfArray } from '../../core/objects/pdf-array.js';
 import { PdfString } from '../../core/objects/pdf-string.js';
+import { PdfIndirectObject } from '../../core/index.js';
 /**
  * Choice form field subtype (dropdowns, list boxes).
  */
@@ -16,14 +16,16 @@ export class PdfChoiceFormField extends PdfFormField {
         return this.options.findIndex((opt) => opt.value === this.value);
     }
     get options() {
-        const opt = this.content
-            .get('Opt')
-            ?.as((PdfArray)) ??
-            this.parent?.content
-                .get('Opt')
-                ?.as((PdfArray));
+        let opt = this.content.get('Opt') ?? this.parent?.content.get('Opt');
         if (!opt)
             return [];
+        if (opt instanceof PdfObjectReference) {
+            opt = opt
+                .resolve()
+                .as((PdfIndirectObject)).content;
+        }
+        if (!(opt instanceof PdfArray))
+            return [];
         return opt.items.map((item) => {
             if (item instanceof PdfArray && item.items.length >= 2) {
                 const label = item.items[1] instanceof PdfString
@@ -47,6 +49,10 @@ export class PdfChoiceFormField extends PdfFormField {
             this.content.delete('Opt');
             return;
         }
+        if (values instanceof PdfObjectReference) {
+            this.content.set('Opt', values);
+            return;
+        }
         if (values.length === 0) {
             this.content.delete('Opt');
             return;
@@ -81,36 +87,11 @@ export class PdfChoiceFormField extends PdfFormField {
         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 PdfChoiceAppearanceStream({
+        const font = this.font;
+        const fontResources = this.buildFontResources(parsed.fontName);
+        const isUnicode = font?.isUnicode ?? false;
+        const reverseEncodingMap = font?.reverseEncodingMap;
+        this.setAppearanceStream(new PdfChoiceAppearanceStream({
             rect: rect,
             value,
             da: parsed,
@@ -120,7 +101,7 @@ export class PdfChoiceFormField extends PdfFormField {
             reverseEncodingMap,
             displayOptions: this.options.map((opt) => opt.label),
             selectedIndex: this.selectedIndex,
-        });
+        }));
         if (options?.makeReadOnly) {
             this.readOnly = true;
             this.print = true;

package/dist/acroform/fields/pdf-form-field.d.ts

@@ -1,34 +1,43 @@
+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 { PdfFont } from '../../fonts/pdf-font.js';
 import { PdfStream } from '../../core/objects/pdf-stream.js';
 import { PdfWidgetAnnotation } from '../../annotations/pdf-widget-annotation.js';
-import type { PdfAppearanceStream } from '../appearance/pdf-appearance-stream.js';
-import type { FormContext, PdfFieldType } from './types.js';
+import type { PdfFieldType } from './types.js';
 import { PdfFormFieldFlags } from './pdf-form-field-flags.js';
+import { PdfDefaultResourcesDictionary } from '../../annotations/pdf-default-resources.js';
+import type { PdfAcroForm } from '../pdf-acro-form.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 declare abstract class PdfFormField extends PdfWidgetAnnotation {
-    private _parent?;
     defaultGenerateAppearance: boolean;
-    protected _appearanceStream?: PdfAppearanceStream;
-    protected _appearanceStreamYes?: PdfAppearanceStream;
-    form?: FormContext<PdfFormField>;
-    constructor(options?: {
-        other?: PdfIndirectObject;
-        form?: FormContext<PdfFormField>;
-        parent?: PdfFormField;
+    /** @internal */
+    _form?: PdfAcroForm;
+    constructor(other?: PdfIndirectObject | {
+        form?: PdfAcroForm;
     });
+    set form(f: PdfAcroForm);
+    static create(other?: PdfIndirectObject): PdfFormField;
     get parent(): PdfFormField | undefined;
-    set parent(field: PdfFormField | undefined);
+    set parent(field: PdfFormField | PdfIndirectObject | undefined);
     get children(): PdfFormField[];
     set children(fields: PdfFormField[]);
     get siblings(): PdfFormField[];
-    get encodingMap(): Map<number, string> | undefined;
+    get font(): PdfFont | null;
+    get defaultResources(): PdfDefaultResourcesDictionary | null;
+    set defaultResources(resources: PdfDefaultResourcesDictionary | null);
+    /**
+     * Builds a Resources dictionary containing the font entry for `fontName`,
+     * resolved from DR (handling indirect references) or from a loaded font.
+     * Returns undefined if neither source provides the font.
+     */
+    buildFontResources(fontName: string): PdfDictionary | undefined;
     get fieldType(): PdfFieldType | null;
     set fieldType(type: PdfFieldType | null);
     get name(): string;
@@ -43,9 +52,6 @@ export declare abstract class PdfFormField extends PdfWidgetAnnotation {
      * Override in subclasses to change the stored representation.
      */
     protected _storeValue(val: string | PdfString, fieldParent: PdfFormField | undefined): boolean;
-    protected tryGenerateAppearance(field: PdfFormField): void;
-    get checked(): boolean;
-    set checked(_isChecked: boolean);
     get fontSize(): number | null;
     set fontSize(size: number);
     get fontName(): string | null;
@@ -92,32 +98,21 @@ export declare abstract class PdfFormField extends PdfWidgetAnnotation {
     set defaultAppearance(da: string);
     get maxLen(): number | null;
     set maxLen(maxLen: number | null);
-    get kids(): PdfObjectReference[];
+    get kids(): PdfArray<PdfObjectReference> | undefined;
     set kids(kids: PdfObjectReference[]);
     abstract generateAppearance(options?: {
         makeReadOnly?: boolean;
         textYOffset?: number;
     }): boolean;
-    getAppearanceStream(): PdfStream | undefined;
-    getAppearanceStreamsForWriting(): {
-        primary: PdfAppearanceStream;
-        secondary?: PdfAppearanceStream;
-    } | undefined;
-    setAppearanceReference(appearanceStreamRef: PdfObjectReference, _appearanceStreamYesRef?: PdfObjectReference): void;
+    setAppearanceStream(stream: PdfIndirectObject | {
+        [key: string]: PdfIndirectObject;
+    }): void;
+    getAppearanceStream(setting?: string): PdfIndirectObject<PdfStream> | null;
     private static _fallbackCtor?;
     private static _registry;
-    static registerFieldType(ft: 'Sig' | 'Btn' | 'Tx' | 'Ch', ctor: new (options?: {
-        other?: PdfIndirectObject;
-        form?: FormContext<PdfFormField>;
-        parent?: PdfFormField;
-    }) => PdfFormField, options?: {
+    static registerFieldType(ft: 'Sig' | 'Btn' | 'Tx' | 'Ch', ctor: new (other?: PdfIndirectObject) => PdfFormField, options?: {
         fallback?: boolean;
     }): void;
-    static create(options: {
-        other: PdfIndirectObject;
-        form: FormContext<PdfFormField>;
-        parent?: PdfFormField;
-    }): PdfFormField;
 }
 /** Backward compatible alias */
 export { PdfFormField as PdfAcroFormField };