pdf-lite 1.4.0 → 1.6.0

package/dist/annotations/PdfAnnotationWriter.d.ts

@@ -1,20 +0,0 @@
-import { PdfDocument } from '../pdf/pdf-document.js';
-import { PdfDictionary } from '../core/objects/pdf-dictionary.js';
-import { PdfArray } from '../core/objects/pdf-array.js';
-import { PdfObjectReference } from '../core/objects/pdf-object-reference.js';
-/**
- * Manages page Annots arrays during AcroForm write operations.
- */
-export declare class PdfAnnotationWriter {
-    static getPageAnnotsArray(document: PdfDocument, pageDict: PdfDictionary): Promise<{
-        annotsArray: PdfArray<PdfObjectReference>;
-        isIndirect: boolean;
-        objectNumber?: number;
-        generationNumber?: number;
-    }>;
-    static addFieldsToAnnots(annotsArray: PdfArray<PdfObjectReference>, fieldRefs: PdfObjectReference[]): void;
-    static updatePageAnnotations(document: PdfDocument, fieldsByPage: Map<string, {
-        pageRef: PdfObjectReference;
-        fieldRefs: PdfObjectReference[];
-    }>): Promise<void>;
-}

package/dist/annotations/PdfAnnotationWriter.js

@@ -1,76 +0,0 @@
-import { PdfDictionary } from '../core/objects/pdf-dictionary.js';
-import { PdfArray } from '../core/objects/pdf-array.js';
-import { PdfObjectReference } from '../core/objects/pdf-object-reference.js';
-import { PdfIndirectObject } from '../core/objects/pdf-indirect-object.js';
-/**
- * Manages page Annots arrays during AcroForm write operations.
- */
-export class PdfAnnotationWriter {
-    static async getPageAnnotsArray(document, pageDict) {
-        const annotsRef = pageDict.get('Annots');
-        if (annotsRef instanceof PdfObjectReference) {
-            const annotsObj = await document.readObject({
-                objectNumber: annotsRef.objectNumber,
-                generationNumber: annotsRef.generationNumber,
-            });
-            return {
-                annotsArray: annotsObj.content
-                    .as((PdfArray))
-                    .clone(),
-                isIndirect: true,
-                objectNumber: annotsRef.objectNumber,
-                generationNumber: annotsRef.generationNumber,
-            };
-        }
-        else if (annotsRef instanceof PdfArray) {
-            return {
-                annotsArray: annotsRef.as((PdfArray)).clone(),
-                isIndirect: false,
-            };
-        }
-        else {
-            const newArray = new PdfArray();
-            pageDict.set('Annots', newArray);
-            return {
-                annotsArray: newArray,
-                isIndirect: false,
-            };
-        }
-    }
-    static addFieldsToAnnots(annotsArray, fieldRefs) {
-        for (const fieldRef of fieldRefs) {
-            const exists = annotsArray.items.some((ref) => ref.equals(fieldRef));
-            if (!exists) {
-                annotsArray.push(fieldRef);
-            }
-        }
-    }
-    static async updatePageAnnotations(document, fieldsByPage) {
-        for (const { pageRef, fieldRefs } of fieldsByPage.values()) {
-            const pageObj = await document.readObject({
-                objectNumber: pageRef.objectNumber,
-                generationNumber: pageRef.generationNumber,
-            });
-            if (!pageObj)
-                continue;
-            const pageDict = pageObj.content.as(PdfDictionary).clone();
-            const annotsInfo = await PdfAnnotationWriter.getPageAnnotsArray(document, pageDict);
-            PdfAnnotationWriter.addFieldsToAnnots(annotsInfo.annotsArray, fieldRefs);
-            if (annotsInfo.isIndirect &&
-                annotsInfo.objectNumber !== undefined) {
-                const annotsIndirect = new PdfIndirectObject({
-                    objectNumber: annotsInfo.objectNumber,
-                    generationNumber: annotsInfo.generationNumber,
-                    content: annotsInfo.annotsArray,
-                });
-                document.add(annotsIndirect);
-            }
-            const pageIndirect = new PdfIndirectObject({
-                objectNumber: pageRef.objectNumber,
-                generationNumber: pageRef.generationNumber,
-                content: pageDict,
-            });
-            document.add(pageIndirect);
-        }
-    }
-}

package/dist/fonts/font-manager.d.ts

@@ -1,127 +0,0 @@
-import { PdfDocument } from '../pdf/pdf-document.js';
-import { ByteArray } from '../types.js';
-import { FontDescriptor, UnicodeFontDescriptor } from './types.js';
-import { PdfFont } from './pdf-font.js';
-/**
- * Manages font embedding in PDF documents.
- * Provides methods to embed TrueType and other font formats.
- */
-export declare class PdfFontManager {
-    private document;
-    private fontResourceCounter;
-    constructor(document: PdfDocument);
-    findFontByName(fontName: string): Promise<PdfFont | undefined>;
-    /**
-     * Embeds a TrueType font into the PDF document.
-     *
-     * @param fontData - The font file bytes
-     * @param fontName - The name to use for this font in the PDF
-     * @param descriptor - Font metrics and properties
-     * @returns A PdfFont object representing the embedded font
-     */
-    embedTrueTypeFont(fontData: ByteArray, fontName: string, descriptor: FontDescriptor): Promise<PdfFont>;
-    /**
-     * Embeds a standard PDF font (Type1).
-     * These fonts don't require font data as they're built into PDF viewers.
-     *
-     * @param fontName - One of the 14 standard PDF fonts
-     * @returns A PdfFont object representing the embedded font
-     */
-    embedStandardFont(fontName: 'Helvetica' | 'Helvetica-Bold' | 'Helvetica-Oblique' | 'Helvetica-BoldOblique' | 'Times-Roman' | 'Times-Bold' | 'Times-Italic' | 'Times-BoldItalic' | 'Courier' | 'Courier-Bold' | 'Courier-Oblique' | 'Courier-BoldOblique' | 'Symbol' | 'ZapfDingbats'): Promise<PdfFont>;
-    /**
-     * Embeds a font from file data with automatic parsing and configuration.
-     * This is the recommended high-level API for embedding fonts.
-     *
-     * @param fontData - The font file bytes (TTF, OTF, or WOFF format)
-     * @param options - Optional configuration
-     * @param options.fontName - Custom font name (defaults to PostScript name from font)
-     * @param options.unicode - Use Unicode/Type0 encoding for non-ASCII characters
-     * @param options.unicodeMappings - Custom CID to Unicode mappings for Type0 fonts
-     * @returns A PdfFont object representing the embedded font
-     *
-     * @example
-     * ```typescript
-     * // Simple embedding with auto-generated name
-     * const font = await document.fonts.embedFromFile(fontData)
-     * field.font = font
-     *
-     * // With custom name and Unicode support
-     * const font = await document.fonts.embedFromFile(fontData, {
-     *     fontName: 'MyCustomFont',
-     *     unicode: true
-     * })
-     * ```
-     */
-    embedFromFile(fontData: ByteArray, options?: {
-        fontName?: string;
-        unicode?: boolean;
-        unicodeMappings?: Map<number, number>;
-    }): Promise<PdfFont>;
-    /**
-     * Gets the font reference by font name or resource name.
-     */
-    getFont(fontName: string): Promise<PdfFont | undefined>;
-    /**
-     * Writes a font to the PDF document.
-     * Assigns resource name, creates container object, commits all objects,
-     * and registers it in page resources.
-     *
-     * @param font - The PdfFont instance to write
-     * @param cacheKey - Unused, kept for API compatibility
-     * @returns The font with its resourceName and container set
-     * @internal
-     */
-    write(font: PdfFont): Promise<PdfFont>;
-    /**
-     * Gets all embedded fonts.
-     * Searches the PDF structure to find all fonts.
-     */
-    getAllFonts(): Promise<Map<string, PdfFont>>;
-    /**
-     * Embeds a TrueType font with Unicode/Type0 support.
-     * Use this for fonts that need to display non-ASCII characters.
-     *
-     * @param fontData - The font file bytes
-     * @param fontName - The name to use for this font in the PDF
-     * @param descriptor - Unicode font descriptor with CID metrics
-     * @param unicodeMappings - Map of CID to Unicode code point for ToUnicode CMap
-     * @returns A PdfFont object representing the embedded font
-     */
-    embedTrueTypeFontUnicode(fontData: ByteArray, fontName: string, descriptor: UnicodeFontDescriptor, unicodeMappings?: Map<number, number>): Promise<PdfFont>;
-    /**
-     * Loads existing fonts from the PDF document.
-     * Traverses the page tree and extracts font information from page resources.
-     *
-     * @returns Map of font names to their PdfFont objects
-     */
-    loadExistingFonts(): Promise<Map<string, PdfFont>>;
-    /**
-     * Traverses the page tree to find and load existing fonts.
-     */
-    private traversePageTreeForFonts;
-    /**
-     * Extracts font information from a page's resources.
-     */
-    private extractFontsFromPage;
-    /**
-     * Searches the PDF structure for a font by name.
-     * @internal
-     */
-    private searchFontInPdf;
-    /**
-     * Collects all fonts from the PDF structure.
-     * @internal
-     */
-    private collectAllFontsFromPdf;
-    /**
-     * Adds a font to the AcroForm default resources (DR) dictionary.
-     * This ensures fonts are available to form fields.
-     */
-    private addFontToAcroFormResources;
-    /**
-     * Adds a font to the global /Pages node Resources dictionary.
-     * All child pages will inherit these fonts automatically.
-     * This is more efficient than adding to each individual page.
-     */
-    private addFontToPageResources;
-}

package/dist/fonts/font-manager.js

@@ -1,378 +0,0 @@
-import { PdfDictionary } from '../core/objects/pdf-dictionary.js';
-import { PdfIndirectObject } from '../core/objects/pdf-indirect-object.js';
-import { PdfName } from '../core/objects/pdf-name.js';
-import { PdfArray } from '../core/objects/pdf-array.js';
-import { PdfObjectReference } from '../core/objects/pdf-object-reference.js';
-import { PdfFont } from './pdf-font.js';
-import { parseFont } from './parsers/font-parser.js';
-/**
- * Manages font embedding in PDF documents.
- * Provides methods to embed TrueType and other font formats.
- */
-export class PdfFontManager {
-    document;
-    fontResourceCounter = 0;
-    constructor(document) {
-        this.document = document;
-    }
-    async findFontByName(fontName) {
-        return await this.searchFontInPdf(fontName);
-    }
-    /**
-     * Embeds a TrueType font into the PDF document.
-     *
-     * @param fontData - The font file bytes
-     * @param fontName - The name to use for this font in the PDF
-     * @param descriptor - Font metrics and properties
-     * @returns A PdfFont object representing the embedded font
-     */
-    async embedTrueTypeFont(fontData, fontName, descriptor) {
-        // Create font using factory
-        const font = PdfFont.fromTrueTypeData(fontData, fontName, descriptor);
-        // Write to PDF
-        return await this.write(font);
-    }
-    /**
-     * Embeds a standard PDF font (Type1).
-     * These fonts don't require font data as they're built into PDF viewers.
-     *
-     * @param fontName - One of the 14 standard PDF fonts
-     * @returns A PdfFont object representing the embedded font
-     */
-    async embedStandardFont(fontName) {
-        // Create font using factory
-        const font = PdfFont.fromStandardFont(fontName);
-        // Write to PDF
-        return await this.write(font);
-    }
-    /**
-     * Embeds a font from file data with automatic parsing and configuration.
-     * This is the recommended high-level API for embedding fonts.
-     *
-     * @param fontData - The font file bytes (TTF, OTF, or WOFF format)
-     * @param options - Optional configuration
-     * @param options.fontName - Custom font name (defaults to PostScript name from font)
-     * @param options.unicode - Use Unicode/Type0 encoding for non-ASCII characters
-     * @param options.unicodeMappings - Custom CID to Unicode mappings for Type0 fonts
-     * @returns A PdfFont object representing the embedded font
-     *
-     * @example
-     * ```typescript
-     * // Simple embedding with auto-generated name
-     * const font = await document.fonts.embedFromFile(fontData)
-     * field.font = font
-     *
-     * // With custom name and Unicode support
-     * const font = await document.fonts.embedFromFile(fontData, {
-     *     fontName: 'MyCustomFont',
-     *     unicode: true
-     * })
-     * ```
-     */
-    async embedFromFile(fontData, options) {
-        // Parse the font to extract metadata
-        const parser = parseFont(fontData);
-        const info = parser.getFontInfo();
-        // Auto-generate font name from metadata if not provided
-        const fontName = options?.fontName ?? info.postScriptName ?? info.fullName;
-        // Get the appropriate descriptor based on unicode option
-        const descriptor = parser.getFontDescriptor(fontName);
-        // Embed using the appropriate method and return PdfFont
-        if (options?.unicode) {
-            // For Unicode fonts, we need a UnicodeFontDescriptor
-            // Create one by extending the base descriptor
-            const unicodeDescriptor = {
-                ...descriptor,
-                defaultWidth: 1000,
-                cidToGidMap: 'Identity',
-            };
-            return await this.embedTrueTypeFontUnicode(fontData, fontName, unicodeDescriptor, options.unicodeMappings);
-        }
-        else {
-            // Use standard TrueType embedding
-            return await this.embedTrueTypeFont(fontData, fontName, descriptor);
-        }
-    }
-    /**
-     * Gets the font reference by font name or resource name.
-     */
-    async getFont(fontName) {
-        return await this.searchFontInPdf(fontName);
-    }
-    /**
-     * Writes a font to the PDF document.
-     * Assigns resource name, creates container object, commits all objects,
-     * and registers it in page resources.
-     *
-     * @param font - The PdfFont instance to write
-     * @param cacheKey - Unused, kept for API compatibility
-     * @returns The font with its resourceName and container set
-     * @internal
-     */
-    async write(font) {
-        // Assign resource name
-        this.fontResourceCounter++;
-        const resourceName = `F${this.fontResourceCounter}`;
-        font.resourceName = resourceName;
-        // Create container that wraps the font dictionary
-        const fontObject = new PdfIndirectObject({
-            content: font,
-        });
-        font.container = fontObject;
-        // Get all objects to commit (auxiliary objects + container)
-        const objectsToCommit = font.getObjectsToCommit();
-        if (objectsToCommit.length > 0) {
-            await this.document.commit(...objectsToCommit);
-        }
-        // Register in page resources
-        await this.addFontToPageResources(resourceName, fontObject);
-        return font;
-    }
-    /**
-     * Gets all embedded fonts.
-     * Searches the PDF structure to find all fonts.
-     */
-    async getAllFonts() {
-        return await this.collectAllFontsFromPdf();
-    }
-    /**
-     * Embeds a TrueType font with Unicode/Type0 support.
-     * Use this for fonts that need to display non-ASCII characters.
-     *
-     * @param fontData - The font file bytes
-     * @param fontName - The name to use for this font in the PDF
-     * @param descriptor - Unicode font descriptor with CID metrics
-     * @param unicodeMappings - Map of CID to Unicode code point for ToUnicode CMap
-     * @returns A PdfFont object representing the embedded font
-     */
-    async embedTrueTypeFontUnicode(fontData, fontName, descriptor, unicodeMappings) {
-        // Create font using factory
-        const font = PdfFont.fromType0Data(fontData, fontName, descriptor, unicodeMappings);
-        // Write to PDF
-        return await this.write(font);
-    }
-    /**
-     * Loads existing fonts from the PDF document.
-     * Traverses the page tree and extracts font information from page resources.
-     *
-     * @returns Map of font names to their PdfFont objects
-     */
-    async loadExistingFonts() {
-        return await this.collectAllFontsFromPdf();
-    }
-    /**
-     * Traverses the page tree to find and load existing fonts.
-     */
-    async traversePageTreeForFonts(nodeRef, fonts) {
-        const nodeObject = await this.document.readObject({
-            objectNumber: nodeRef.objectNumber,
-            generationNumber: nodeRef.generationNumber,
-        });
-        if (!nodeObject)
-            return;
-        const nodeDict = nodeObject.content.as(PdfDictionary);
-        const type = nodeDict.get('Type')?.as(PdfName);
-        if (type?.value === 'Page') {
-            await this.extractFontsFromPage(nodeObject, nodeDict, fonts);
-        }
-        else if (type?.value === 'Pages') {
-            const kids = nodeDict.get('Kids')?.as(PdfArray);
-            if (kids) {
-                for (const kidRef of kids.items) {
-                    if (kidRef instanceof PdfObjectReference) {
-                        await this.traversePageTreeForFonts(kidRef, fonts);
-                    }
-                }
-            }
-        }
-    }
-    /**
-     * Extracts font information from a page's resources.
-     */
-    async extractFontsFromPage(_pageObject, pageDict, fonts) {
-        // Get Resources - could be direct dict or reference
-        let resources = pageDict.get('Resources')?.as(PdfDictionary);
-        if (!resources) {
-            const resourcesRef = pageDict
-                .get('Resources')
-                ?.as(PdfObjectReference);
-            if (resourcesRef) {
-                const resourcesObj = await this.document.readObject({
-                    objectNumber: resourcesRef.objectNumber,
-                    generationNumber: resourcesRef.generationNumber,
-                });
-                resources = resourcesObj?.content.as(PdfDictionary);
-            }
-        }
-        if (!resources)
-            return;
-        // Get Font dictionary - could be direct dict or reference
-        let fontDict = resources.get('Font')?.as(PdfDictionary);
-        if (!fontDict) {
-            const fontRef = resources.get('Font')?.as(PdfObjectReference);
-            if (fontRef) {
-                const fontObj = await this.document.readObject({
-                    objectNumber: fontRef.objectNumber,
-                    generationNumber: fontRef.generationNumber,
-                });
-                fontDict = fontObj?.content.as(PdfDictionary);
-            }
-        }
-        if (!fontDict)
-            return;
-        // Iterate through fonts in the Font dictionary
-        for (const [resourceName, fontValue] of fontDict.entries()) {
-            // Skip if already in this collection
-            if (fonts.has(resourceName))
-                continue;
-            let fontObjDict;
-            let fontIndirectObj;
-            const fontRef = fontValue.as(PdfObjectReference);
-            if (fontRef) {
-                const obj = await this.document.readObject({
-                    objectNumber: fontRef.objectNumber,
-                    generationNumber: fontRef.generationNumber,
-                });
-                fontObjDict = obj?.content.as(PdfDictionary);
-                fontIndirectObj = obj;
-            }
-            else {
-                fontObjDict = fontValue.as(PdfDictionary);
-            }
-            if (!fontObjDict || !fontIndirectObj)
-                continue;
-            const baseFont = fontObjDict.get('BaseFont')?.as(PdfName)?.value;
-            const encoding = fontObjDict.get('Encoding')?.as(PdfName)?.value;
-            if (baseFont) {
-                const pdfFont = new PdfFont({
-                    fontName: baseFont,
-                    resourceName: resourceName,
-                    encoding: encoding,
-                    manager: this,
-                    container: fontIndirectObj,
-                });
-                fonts.set(resourceName, pdfFont);
-                // Also register by baseFont name for lookup convenience
-                if (!fonts.has(baseFont)) {
-                    fonts.set(baseFont, pdfFont);
-                }
-            }
-        }
-    }
-    /**
-     * Searches the PDF structure for a font by name.
-     * @internal
-     */
-    async searchFontInPdf(fontName) {
-        const fonts = await this.collectAllFontsFromPdf();
-        return fonts?.get(fontName);
-    }
-    /**
-     * Collects all fonts from the PDF structure.
-     * @internal
-     */
-    async collectAllFontsFromPdf() {
-        const fonts = new Map();
-        const catalog = this.document.root;
-        if (!catalog)
-            return fonts;
-        const pagesRef = catalog.content.get('Pages');
-        if (!pagesRef)
-            return fonts;
-        const pagesObjRef = pagesRef.as(PdfObjectReference);
-        if (!pagesObjRef)
-            return fonts;
-        await this.traversePageTreeForFonts(pagesObjRef, fonts);
-        return fonts;
-    }
-    /**
-     * Adds a font to the AcroForm default resources (DR) dictionary.
-     * This ensures fonts are available to form fields.
-     */
-    async addFontToAcroFormResources(resourceName, fontObject) {
-        const catalog = this.document.root;
-        if (!catalog)
-            return;
-        // Get AcroForm dictionary
-        const acroFormRef = catalog.content.get('AcroForm');
-        if (!acroFormRef)
-            return;
-        let acroFormDict;
-        let acroFormContainer;
-        if (acroFormRef instanceof PdfObjectReference) {
-            const acroFormObject = await this.document.readObject({
-                objectNumber: acroFormRef.objectNumber,
-                generationNumber: acroFormRef.generationNumber,
-            });
-            if (acroFormObject) {
-                acroFormDict = acroFormObject.content.as(PdfDictionary);
-                acroFormContainer = acroFormObject;
-            }
-        }
-        else {
-            acroFormDict = acroFormRef.as(PdfDictionary);
-        }
-        if (!acroFormDict)
-            return;
-        // Get or create DR (Default Resources) dictionary
-        let dr = acroFormDict.get('DR')?.as(PdfDictionary);
-        if (!dr) {
-            dr = new PdfDictionary();
-            acroFormDict.set('DR', dr);
-        }
-        // Get or create Font dictionary within DR
-        let fontDict = dr.get('Font')?.as(PdfDictionary);
-        if (!fontDict) {
-            fontDict = new PdfDictionary();
-            dr.set('Font', fontDict);
-        }
-        // Add the font reference
-        fontDict.set(resourceName, fontObject.reference);
-        // Commit the modified AcroForm object if it's an indirect object
-        if (acroFormContainer) {
-            await this.document.commit(acroFormContainer);
-        }
-    }
-    /**
-     * Adds a font to the global /Pages node Resources dictionary.
-     * All child pages will inherit these fonts automatically.
-     * This is more efficient than adding to each individual page.
-     */
-    async addFontToPageResources(resourceName, fontObject) {
-        const catalog = this.document.root;
-        const pagesRef = catalog.content.get('Pages');
-        if (!pagesRef)
-            return;
-        const pagesObjRef = pagesRef.as(PdfObjectReference);
-        if (!pagesObjRef)
-            return;
-        // Read the root /Pages object
-        const pagesObject = await this.document.readObject({
-            objectNumber: pagesObjRef.objectNumber,
-            generationNumber: pagesObjRef.generationNumber,
-        });
-        if (!pagesObject)
-            return;
-        const pagesDict = pagesObject.content.as(PdfDictionary);
-        if (!pagesDict)
-            return;
-        // Get or create Resources dictionary on the /Pages node
-        let resources = pagesDict.get('Resources')?.as(PdfDictionary);
-        if (!resources) {
-            resources = new PdfDictionary();
-            pagesDict.set('Resources', resources);
-        }
-        // Get or create Font dictionary within Resources
-        let fontDict = resources.get('Font')?.as(PdfDictionary);
-        if (!fontDict) {
-            fontDict = new PdfDictionary();
-            resources.set('Font', fontDict);
-        }
-        // Add the font reference to the global dictionary
-        fontDict.set(resourceName, fontObject.reference);
-        // Commit the modified /Pages object
-        await this.document.commit(pagesObject);
-        // Also add to AcroForm DR if AcroForm exists
-        await this.addFontToAcroFormResources(resourceName, fontObject);
-    }
-}

package/dist/pdf/errors.d.ts

@@ -1,6 +0,0 @@
-/**
- * Error thrown when attempting to access a compressed object
- * that requires decompression from an object stream.
- */
-export declare class FoundCompressedObjectError extends Error {
-}

package/dist/pdf/errors.js

@@ -1,6 +0,0 @@
-/**
- * Error thrown when attempting to access a compressed object
- * that requires decompression from an object stream.
- */
-export class FoundCompressedObjectError extends Error {
-}