@pdfme/pdf-lib 6.0.3 → 6.0.4-dev.1

package/dist/api/PDFDocumentOptions.d.ts

@@ -0,0 +1,38 @@
+import { EmbeddedFileOptions } from '../core/embedders/FileEmbedder';
+import { TypeFeatures } from '../types/fontkit';
+export declare enum ParseSpeeds {
+    Fastest = Infinity,
+    Fast = 1500,
+    Medium = 500,
+    Slow = 100
+}
+export interface AttachmentOptions extends EmbeddedFileOptions {
+}
+export interface SaveOptions {
+    useObjectStreams?: boolean;
+    addDefaultPage?: boolean;
+    objectsPerTick?: number;
+    updateFieldAppearances?: boolean;
+}
+export interface Base64SaveOptions extends SaveOptions {
+    dataUri?: boolean;
+}
+export interface LoadOptions {
+    ignoreEncryption?: boolean;
+    parseSpeed?: ParseSpeeds | number;
+    throwOnInvalidObject?: boolean;
+    updateMetadata?: boolean;
+    capNumbers?: boolean;
+    password?: string;
+}
+export interface CreateOptions {
+    updateMetadata?: boolean;
+}
+export interface EmbedFontOptions {
+    subset?: boolean;
+    customName?: string;
+    features?: TypeFeatures;
+}
+export interface SetTitleOptions {
+    showInWindowTitleBar: boolean;
+}

package/dist/api/PDFEmbeddedFile.d.ts

@@ -0,0 +1,38 @@
+import Embeddable from './Embeddable';
+import PDFDocument from './PDFDocument';
+import FileEmbedder from '../core/embedders/FileEmbedder';
+import { PDFRef } from '../core';
+/**
+ * Represents a file that has been embedded in a [[PDFDocument]].
+ */
+export default class PDFEmbeddedFile implements Embeddable {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.attach]] method, which will create
+     * instances of [[PDFEmbeddedFile]] for you.
+     *
+     * Create an instance of [[PDFEmbeddedFile]] from an existing ref and embedder
+     *
+     * @param ref The unique reference for this file.
+     * @param doc The document to which the file will belong.
+     * @param embedder The embedder that will be used to embed the file.
+     */
+    static of: (ref: PDFRef, doc: PDFDocument, embedder: FileEmbedder) => PDFEmbeddedFile;
+    /** The unique reference assigned to this embedded file within the document. */
+    readonly ref: PDFRef;
+    /** The document to which this embedded file belongs. */
+    readonly doc: PDFDocument;
+    private alreadyEmbedded;
+    private readonly embedder;
+    private constructor();
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all embeddable files get embedded.
+     *
+     * Embed this embeddable file in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    embed(): Promise<void>;
+}

package/dist/api/PDFEmbeddedPage.d.ts

@@ -0,0 +1,73 @@
+import Embeddable from './Embeddable';
+import PDFDocument from './PDFDocument';
+import { PDFPageEmbedder, PDFRef } from '../core';
+/**
+ * Represents a PDF page that has been embedded in a [[PDFDocument]].
+ */
+export default class PDFEmbeddedPage implements Embeddable {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.embedPdf]] and
+     * > [[PDFDocument.embedPage]] methods, which will create instances of
+     * > [[PDFEmbeddedPage]] for you.
+     *
+     * Create an instance of [[PDFEmbeddedPage]] from an existing ref and embedder
+     *
+     * @param ref The unique reference for this embedded page.
+     * @param doc The document to which the embedded page will belong.
+     * @param embedder The embedder that will be used to embed the page.
+     */
+    static of: (ref: PDFRef, doc: PDFDocument, embedder: PDFPageEmbedder) => PDFEmbeddedPage;
+    /** The unique reference assigned to this embedded page within the document. */
+    readonly ref: PDFRef;
+    /** The document to which this embedded page belongs. */
+    readonly doc: PDFDocument;
+    /** The width of this page in pixels. */
+    readonly width: number;
+    /** The height of this page in pixels. */
+    readonly height: number;
+    private alreadyEmbedded;
+    private readonly embedder;
+    private constructor();
+    /**
+     * Compute the width and height of this page after being scaled by the
+     * given `factor`. For example:
+     * ```js
+     * embeddedPage.width  // => 500
+     * embeddedPage.height // => 250
+     *
+     * const scaled = embeddedPage.scale(0.5)
+     * scaled.width  // => 250
+     * scaled.height // => 125
+     * ```
+     * This operation is often useful before drawing a page with
+     * [[PDFPage.drawPage]] to compute the `width` and `height` options.
+     * @param factor The factor by which this page should be scaled.
+     * @returns The width and height of the page after being scaled.
+     */
+    scale(factor: number): {
+        width: number;
+        height: number;
+    };
+    /**
+     * Get the width and height of this page. For example:
+     * ```js
+     * const { width, height } = embeddedPage.size()
+     * ```
+     * @returns The width and height of the page.
+     */
+    size(): {
+        width: number;
+        height: number;
+    };
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all embeddable pages get embedded.
+     *
+     * Embed this embeddable page in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    embed(): Promise<void>;
+}

package/dist/api/PDFFont.d.ts

@@ -0,0 +1,94 @@
+import Embeddable from './Embeddable';
+import PDFDocument from './PDFDocument';
+import { CustomFontEmbedder, PDFHexString, PDFRef, StandardFontEmbedder } from '../core';
+export type FontEmbedder = CustomFontEmbedder | StandardFontEmbedder;
+/**
+ * Represents a font that has been embedded in a [[PDFDocument]].
+ */
+export default class PDFFont implements Embeddable {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.embedFont]] and
+     * > [[PDFDocument.embedStandardFont]] methods, which will create instances
+     * > of [[PDFFont]] for you.
+     *
+     * Create an instance of [[PDFFont]] from an existing ref and embedder
+     *
+     * @param ref The unique reference for this font.
+     * @param doc The document to which the font will belong.
+     * @param embedder The embedder that will be used to embed the font.
+     */
+    static of: (ref: PDFRef, doc: PDFDocument, embedder: FontEmbedder) => PDFFont;
+    /** The unique reference assigned to this font within the document. */
+    readonly ref: PDFRef;
+    /** The document to which this font belongs. */
+    readonly doc: PDFDocument;
+    /** The name of this font. */
+    readonly name: string;
+    private modified;
+    private readonly embedder;
+    private constructor();
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFPage.drawText]] method will automatically encode the text it is
+     * > given.
+     *
+     * Encodes a string of text in this font.
+     *
+     * @param text The text to be encoded.
+     * @returns The encoded text as a hex string.
+     */
+    encodeText(text: string): PDFHexString;
+    /**
+     * Measure the width of a string of text drawn in this font at a given size.
+     * For example:
+     * ```js
+     * const width = font.widthOfTextAtSize('Foo Bar Qux Baz', 36)
+     * ```
+     * @param text The string of text to be measured.
+     * @param size The font size to be used for this measurement.
+     * @returns The width of the string of text when drawn in this font at the
+     *          given size.
+     */
+    widthOfTextAtSize(text: string, size: number): number;
+    /**
+     * Measure the height of this font at a given size. For example:
+     * ```js
+     * const height = font.heightAtSize(24)
+     * ```
+     *
+     * The `options.descender` value controls whether or not the font's
+     * descender is included in the height calculation.
+     *
+     * @param size The font size to be used for this measurement.
+     * @param options The options to be used when computing this measurement.
+     * @returns The height of this font at the given size.
+     */
+    heightAtSize(size: number, options?: {
+        descender?: boolean;
+    }): number;
+    /**
+     * Compute the font size at which this font is a given height. For example:
+     * ```js
+     * const fontSize = font.sizeAtHeight(12)
+     * ```
+     * @param height The height to be used for this calculation.
+     * @returns The font size at which this font is the given height.
+     */
+    sizeAtHeight(height: number): number;
+    /**
+     * Get the set of unicode code points that can be represented by this font.
+     * @returns The set of unicode code points supported by this font.
+     */
+    getCharacterSet(): number[];
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all fonts get embedded.
+     *
+     * Embed this font in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    embed(): Promise<void>;
+}

package/dist/api/PDFImage.d.ts

@@ -0,0 +1,95 @@
+import Embeddable from './Embeddable';
+import PDFDocument from './PDFDocument';
+import { JpegEmbedder, PDFRef, PngEmbedder } from '../core';
+export type ImageEmbedder = JpegEmbedder | PngEmbedder;
+/**
+ * Represents an image that has been embedded in a [[PDFDocument]].
+ */
+export default class PDFImage implements Embeddable {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.embedPng]] and [[PDFDocument.embedJpg]]
+     * > methods, which will create instances of [[PDFImage]] for you.
+     *
+     * Create an instance of [[PDFImage]] from an existing ref and embedder
+     *
+     * @param ref The unique reference for this image.
+     * @param doc The document to which the image will belong.
+     * @param embedder The embedder that will be used to embed the image.
+     */
+    static of: (ref: PDFRef, doc: PDFDocument, embedder: ImageEmbedder) => PDFImage;
+    /** The unique reference assigned to this image within the document. */
+    readonly ref: PDFRef;
+    /** The document to which this image belongs. */
+    readonly doc: PDFDocument;
+    /** The width of this image in pixels. */
+    readonly width: number;
+    /** The height of this image in pixels. */
+    readonly height: number;
+    private embedder;
+    private embedTask;
+    private constructor();
+    /**
+     * Compute the width and height of this image after being scaled by the
+     * given `factor`. For example:
+     * ```js
+     * image.width  // => 500
+     * image.height // => 250
+     *
+     * const scaled = image.scale(0.5)
+     * scaled.width  // => 250
+     * scaled.height // => 125
+     * ```
+     * This operation is often useful before drawing an image with
+     * [[PDFPage.drawImage]] to compute the `width` and `height` options.
+     * @param factor The factor by which this image should be scaled.
+     * @returns The width and height of the image after being scaled.
+     */
+    scale(factor: number): {
+        width: number;
+        height: number;
+    };
+    /**
+     * Get the width and height of this image after scaling it as large as
+     * possible while maintaining its aspect ratio and not exceeding the
+     * specified `width` and `height`. For example:
+     * ```
+     * image.width  // => 500
+     * image.height // => 250
+     *
+     * const scaled = image.scaleToFit(750, 1000)
+     * scaled.width  // => 750
+     * scaled.height // => 375
+     * ```
+     * The `width` and `height` parameters can also be thought of as the width
+     * and height of a box that the scaled image must fit within.
+     * @param width The bounding box's width.
+     * @param height The bounding box's height.
+     * @returns The width and height of the image after being scaled.
+     */
+    scaleToFit(width: number, height: number): {
+        width: number;
+        height: number;
+    };
+    /**
+     * Get the width and height of this image. For example:
+     * ```js
+     * const { width, height } = image.size()
+     * ```
+     * @returns The width and height of the image.
+     */
+    size(): {
+        width: number;
+        height: number;
+    };
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all images get embedded.
+     *
+     * Embed this image in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    embed(): Promise<void>;
+}

package/dist/api/PDFJavaScript.d.ts

@@ -0,0 +1,38 @@
+import Embeddable from './Embeddable';
+import PDFDocument from './PDFDocument';
+import JavaScriptEmbedder from '../core/embedders/JavaScriptEmbedder';
+import { PDFRef } from '../core';
+/**
+ * Represents JavaScript that has been embedded in a [[PDFDocument]].
+ */
+export default class PDFJavaScript implements Embeddable {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.addJavaScript]] method, which will
+     * create instances of [[PDFJavaScript]] for you.
+     *
+     * Create an instance of [[PDFJavaScript]] from an existing ref and script
+     *
+     * @param ref The unique reference for this script.
+     * @param doc The document to which the script will belong.
+     * @param embedder The embedder that will be used to embed the script.
+     */
+    static of: (ref: PDFRef, doc: PDFDocument, embedder: JavaScriptEmbedder) => PDFJavaScript;
+    /** The unique reference assigned to this embedded script within the document. */
+    readonly ref: PDFRef;
+    /** The document to which this embedded script belongs. */
+    readonly doc: PDFDocument;
+    private alreadyEmbedded;
+    private readonly embedder;
+    private constructor();
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all JavaScripts get embedded.
+     *
+     * Embed this JavaScript in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    embed(): Promise<void>;
+}