@pdfme/pdf-lib 1.18.4 → 5.4.0-dev.42

package/dist/types/src/api/operations.d.ts

@@ -0,0 +1,226 @@
+import { Color } from './colors';
+import { LineCapStyle, FillRule } from './operators';
+import { Rotation } from './rotations';
+import { PDFHexString, PDFName, PDFNumber, PDFOperator } from '../core';
+import type { Space, TransformationMatrix } from '../types';
+export interface DrawTextOptions {
+    color: Color;
+    font: string | PDFName;
+    size: number | PDFNumber;
+    rotate: Rotation;
+    xSkew: Rotation;
+    ySkew: Rotation;
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    graphicsState?: string | PDFName;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
+}
+export declare const drawText: (line: PDFHexString, options: DrawTextOptions) => PDFOperator[];
+export interface DrawLinesOfTextOptions extends DrawTextOptions {
+    lineHeight: number | PDFNumber;
+}
+export declare const drawLinesOfText: (lines: PDFHexString[], options: DrawLinesOfTextOptions) => PDFOperator[];
+export declare const drawImage: (name: string | PDFName, options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    rotate: Rotation;
+    xSkew: Rotation;
+    ySkew: Rotation;
+    graphicsState?: string | PDFName;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
+}) => PDFOperator[];
+export declare const drawPage: (name: string | PDFName, options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    xScale: number | PDFNumber;
+    yScale: number | PDFNumber;
+    rotate: Rotation;
+    xSkew: Rotation;
+    ySkew: Rotation;
+    graphicsState?: string | PDFName;
+}) => PDFOperator[];
+export declare const drawLine: (options: {
+    start: {
+        x: number | PDFNumber;
+        y: number | PDFNumber;
+    };
+    end: {
+        x: number | PDFNumber;
+        y: number | PDFNumber;
+    };
+    thickness: number | PDFNumber;
+    color: Color | undefined;
+    dashArray?: (number | PDFNumber)[];
+    dashPhase?: number | PDFNumber;
+    lineCap?: LineCapStyle;
+    graphicsState?: string | PDFName;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
+}) => PDFOperator[];
+export declare const drawRectangle: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    borderWidth: number | PDFNumber;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    rotate: Rotation;
+    xSkew: Rotation;
+    ySkew: Rotation;
+    borderLineCap?: LineCapStyle;
+    borderDashArray?: (number | PDFNumber)[];
+    borderDashPhase?: number | PDFNumber;
+    graphicsState?: string | PDFName;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
+    radius?: number | PDFNumber;
+}) => PDFOperator[];
+/** @deprecated */
+export declare const drawEllipsePath: (config: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    xScale: number | PDFNumber;
+    yScale: number | PDFNumber;
+}) => PDFOperator[];
+export declare const drawEllipse: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    xScale: number | PDFNumber;
+    yScale: number | PDFNumber;
+    rotate?: Rotation;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    borderWidth: number | PDFNumber;
+    borderDashArray?: (number | PDFNumber)[];
+    borderDashPhase?: number | PDFNumber;
+    graphicsState?: string | PDFName;
+    borderLineCap?: LineCapStyle;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
+}) => PDFOperator[];
+export declare const drawSvgPath: (path: string, options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    rotate?: Rotation;
+    scale: number | PDFNumber | undefined;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    borderWidth: number | PDFNumber;
+    borderDashArray?: (number | PDFNumber)[];
+    borderDashPhase?: number | PDFNumber;
+    borderLineCap?: LineCapStyle;
+    graphicsState?: string | PDFName;
+    fillRule?: FillRule;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
+}) => PDFOperator[];
+export declare const drawCheckMark: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    size: number | PDFNumber;
+    thickness: number | PDFNumber;
+    color: Color | undefined;
+}) => PDFOperator[];
+export declare const rotateInPlace: (options: {
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    rotation: 0 | 90 | 180 | 270;
+}) => PDFOperator[];
+export declare const drawCheckBox: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    thickness: number | PDFNumber;
+    borderWidth: number | PDFNumber;
+    markColor: Color | undefined;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    filled: boolean;
+}) => PDFOperator[];
+export declare const drawRadioButton: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    borderWidth: number | PDFNumber;
+    dotColor: Color | undefined;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    filled: boolean;
+}) => PDFOperator[];
+export declare const drawButton: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    borderWidth: number | PDFNumber;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    textLines: {
+        encoded: PDFHexString;
+        x: number;
+        y: number;
+    }[];
+    textColor: Color;
+    font: string | PDFName;
+    fontSize: number | PDFNumber;
+}) => PDFOperator[];
+export interface DrawTextLinesOptions {
+    color: Color;
+    font: string | PDFName;
+    size: number | PDFNumber;
+    rotate: Rotation;
+    xSkew: Rotation;
+    ySkew: Rotation;
+}
+export declare const drawTextLines: (lines: {
+    encoded: PDFHexString;
+    x: number;
+    y: number;
+}[], options: DrawTextLinesOptions) => PDFOperator[];
+export declare const drawTextField: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    borderWidth: number | PDFNumber;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    textLines: {
+        encoded: PDFHexString;
+        x: number;
+        y: number;
+    }[];
+    textColor: Color;
+    font: string | PDFName;
+    fontSize: number | PDFNumber;
+    padding: number | PDFNumber;
+}) => PDFOperator[];
+export declare const drawOptionList: (options: {
+    x: number | PDFNumber;
+    y: number | PDFNumber;
+    width: number | PDFNumber;
+    height: number | PDFNumber;
+    borderWidth: number | PDFNumber;
+    color: Color | undefined;
+    borderColor: Color | undefined;
+    textLines: {
+        encoded: PDFHexString;
+        x: number;
+        y: number;
+        height: number;
+    }[];
+    textColor: Color;
+    font: string | PDFName;
+    fontSize: number | PDFNumber;
+    lineHeight: number | PDFNumber;
+    selectedLines: number[];
+    selectedColor: Color;
+    padding: number | PDFNumber;
+}) => PDFOperator[];

package/dist/types/src/api/operators.d.ts

@@ -0,0 +1,90 @@
+import { PDFHexString, PDFName, PDFNumber, PDFOperator } from '../core';
+export declare const clip: () => PDFOperator;
+export declare const clipEvenOdd: () => PDFOperator;
+export declare const concatTransformationMatrix: (a: number | PDFNumber, b: number | PDFNumber, c: number | PDFNumber, d: number | PDFNumber, e: number | PDFNumber, f: number | PDFNumber) => PDFOperator;
+export declare const translate: (xPos: number | PDFNumber, yPos: number | PDFNumber) => PDFOperator;
+export declare const scale: (xPos: number | PDFNumber, yPos: number | PDFNumber) => PDFOperator;
+export declare const rotateRadians: (angle: number | PDFNumber) => PDFOperator;
+export declare const rotateDegrees: (angle: number | PDFNumber) => PDFOperator;
+export declare const skewRadians: (xSkewAngle: number | PDFNumber, ySkewAngle: number | PDFNumber) => PDFOperator;
+export declare const skewDegrees: (xSkewAngle: number | PDFNumber, ySkewAngle: number | PDFNumber) => PDFOperator;
+export declare const setDashPattern: (dashArray: (number | PDFNumber)[], dashPhase: number | PDFNumber) => PDFOperator;
+export declare const restoreDashPattern: () => PDFOperator;
+export declare enum LineCapStyle {
+    Butt = 0,
+    Round = 1,
+    Projecting = 2
+}
+export declare const setLineCap: (style: LineCapStyle) => PDFOperator;
+export declare enum LineJoinStyle {
+    Miter = 0,
+    Round = 1,
+    Bevel = 2
+}
+export declare const setLineJoin: (style: LineJoinStyle) => PDFOperator;
+export declare const setGraphicsState: (state: string | PDFName) => PDFOperator;
+export declare const pushGraphicsState: () => PDFOperator;
+export declare const popGraphicsState: () => PDFOperator;
+export declare const setLineWidth: (width: number | PDFNumber) => PDFOperator;
+export declare const appendBezierCurve: (x1: number | PDFNumber, y1: number | PDFNumber, x2: number | PDFNumber, y2: number | PDFNumber, x3: number | PDFNumber, y3: number | PDFNumber) => PDFOperator;
+export declare const appendQuadraticCurve: (x1: number | PDFNumber, y1: number | PDFNumber, x2: number | PDFNumber, y2: number | PDFNumber) => PDFOperator;
+export declare const closePath: () => PDFOperator;
+export declare const moveTo: (xPos: number | PDFNumber, yPos: number | PDFNumber) => PDFOperator;
+export declare const lineTo: (xPos: number | PDFNumber, yPos: number | PDFNumber) => PDFOperator;
+/**
+ * @param xPos x coordinate for the lower left corner of the rectangle
+ * @param yPos y coordinate for the lower left corner of the rectangle
+ * @param width width of the rectangle
+ * @param height height of the rectangle
+ */
+export declare const rectangle: (xPos: number | PDFNumber, yPos: number | PDFNumber, width: number | PDFNumber, height: number | PDFNumber) => PDFOperator;
+/**
+ * @param xPos x coordinate for the lower left corner of the square
+ * @param yPos y coordinate for the lower left corner of the square
+ * @param size width and height of the square
+ */
+export declare const square: (xPos: number, yPos: number, size: number) => PDFOperator;
+export declare const stroke: () => PDFOperator;
+export declare enum FillRule {
+    NonZero = "f",
+    EvenOdd = "f*"
+}
+export declare const fill: () => PDFOperator;
+export declare const fillEvenOdd: () => PDFOperator;
+export declare const fillAndStroke: () => PDFOperator;
+export declare const endPath: () => PDFOperator;
+export declare const nextLine: () => PDFOperator;
+export declare const moveText: (x: number | PDFNumber, y: number | PDFNumber) => PDFOperator;
+export declare const showText: (text: PDFHexString) => PDFOperator;
+export declare const beginText: () => PDFOperator;
+export declare const endText: () => PDFOperator;
+export declare const setFontAndSize: (name: string | PDFName, size: number | PDFNumber) => PDFOperator;
+export declare const setCharacterSpacing: (spacing: number | PDFNumber) => PDFOperator;
+export declare const setWordSpacing: (spacing: number | PDFNumber) => PDFOperator;
+/** @param squeeze horizontal character spacing */
+export declare const setCharacterSqueeze: (squeeze: number | PDFNumber) => PDFOperator;
+export declare const setLineHeight: (lineHeight: number | PDFNumber) => PDFOperator;
+export declare const setTextRise: (rise: number | PDFNumber) => PDFOperator;
+export declare enum TextRenderingMode {
+    Fill = 0,
+    Outline = 1,
+    FillAndOutline = 2,
+    Invisible = 3,
+    FillAndClip = 4,
+    OutlineAndClip = 5,
+    FillAndOutlineAndClip = 6,
+    Clip = 7
+}
+export declare const setTextRenderingMode: (mode: TextRenderingMode) => PDFOperator;
+export declare const setTextMatrix: (a: number | PDFNumber, b: number | PDFNumber, c: number | PDFNumber, d: number | PDFNumber, e: number | PDFNumber, f: number | PDFNumber) => PDFOperator;
+export declare const rotateAndSkewTextRadiansAndTranslate: (rotationAngle: number | PDFNumber, xSkewAngle: number | PDFNumber, ySkewAngle: number | PDFNumber, x: number | PDFNumber, y: number | PDFNumber) => PDFOperator;
+export declare const rotateAndSkewTextDegreesAndTranslate: (rotationAngle: number | PDFNumber, xSkewAngle: number | PDFNumber, ySkewAngle: number | PDFNumber, x: number | PDFNumber, y: number | PDFNumber) => PDFOperator;
+export declare const drawObject: (name: string | PDFName) => PDFOperator;
+export declare const setFillingGrayscaleColor: (gray: number | PDFNumber) => PDFOperator;
+export declare const setStrokingGrayscaleColor: (gray: number | PDFNumber) => PDFOperator;
+export declare const setFillingRgbColor: (red: number | PDFNumber, green: number | PDFNumber, blue: number | PDFNumber) => PDFOperator;
+export declare const setStrokingRgbColor: (red: number | PDFNumber, green: number | PDFNumber, blue: number | PDFNumber) => PDFOperator;
+export declare const setFillingCmykColor: (cyan: number | PDFNumber, magenta: number | PDFNumber, yellow: number | PDFNumber, key: number | PDFNumber) => PDFOperator;
+export declare const setStrokingCmykColor: (cyan: number | PDFNumber, magenta: number | PDFNumber, yellow: number | PDFNumber, key: number | PDFNumber) => PDFOperator;
+export declare const beginMarkedContent: (tag: string | PDFName) => PDFOperator;
+export declare const endMarkedContent: () => PDFOperator;

package/dist/types/src/api/rotations.d.ts

@@ -0,0 +1,38 @@
+export declare enum RotationTypes {
+    Degrees = "degrees",
+    Radians = "radians"
+}
+export interface Radians {
+    type: RotationTypes.Radians;
+    angle: number;
+}
+export interface Degrees {
+    type: RotationTypes.Degrees;
+    angle: number;
+}
+export type Rotation = Radians | Degrees;
+export declare const radians: (radianAngle: number) => Radians;
+export declare const degrees: (degreeAngle: number) => Degrees;
+export declare const degreesToRadians: (degree: number) => number;
+export declare const radiansToDegrees: (radian: number) => number;
+export declare const toRadians: (rotation: Rotation) => number;
+export declare const toDegrees: (rotation: Rotation) => number;
+export declare const reduceRotation: (degreeAngle?: number) => 0 | 90 | 180 | 270;
+export declare const adjustDimsForRotation: (dims: {
+    width: number;
+    height: number;
+}, degreeAngle?: number) => {
+    width: number;
+    height: number;
+};
+export declare const rotateRectangle: (rectangle: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}, borderWidth?: number, degreeAngle?: number) => {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};

package/dist/types/src/api/sizes.d.ts

@@ -0,0 +1,52 @@
+export declare const PageSizes: {
+    '4A0': [number, number];
+    '2A0': [number, number];
+    A0: [number, number];
+    A1: [number, number];
+    A2: [number, number];
+    A3: [number, number];
+    A4: [number, number];
+    A5: [number, number];
+    A6: [number, number];
+    A7: [number, number];
+    A8: [number, number];
+    A9: [number, number];
+    A10: [number, number];
+    B0: [number, number];
+    B1: [number, number];
+    B2: [number, number];
+    B3: [number, number];
+    B4: [number, number];
+    B5: [number, number];
+    B6: [number, number];
+    B7: [number, number];
+    B8: [number, number];
+    B9: [number, number];
+    B10: [number, number];
+    C0: [number, number];
+    C1: [number, number];
+    C2: [number, number];
+    C3: [number, number];
+    C4: [number, number];
+    C5: [number, number];
+    C6: [number, number];
+    C7: [number, number];
+    C8: [number, number];
+    C9: [number, number];
+    C10: [number, number];
+    RA0: [number, number];
+    RA1: [number, number];
+    RA2: [number, number];
+    RA3: [number, number];
+    RA4: [number, number];
+    SRA0: [number, number];
+    SRA1: [number, number];
+    SRA2: [number, number];
+    SRA3: [number, number];
+    SRA4: [number, number];
+    Executive: [number, number];
+    Folio: [number, number];
+    Legal: [number, number];
+    Letter: [number, number];
+    Tabloid: [number, number];
+};

package/dist/types/src/api/svg.d.ts

@@ -0,0 +1,70 @@
+import { HTMLElement } from 'node-html-better-parser';
+import { Color } from './colors';
+import { Degrees } from './rotations';
+import PDFPage from './PDFPage';
+import { PDFPageDrawSVGElementOptions } from './PDFPageOptions';
+import { LineCapStyle, LineJoinStyle, FillRule } from './operators';
+import { TransformationMatrix } from '../types/matrix';
+import { Space } from '../types';
+interface Position {
+    x: number;
+    y: number;
+}
+interface Size {
+    width: number;
+    height: number;
+}
+type Box = Position & Size;
+type InheritedAttributes = {
+    width: number;
+    height: number;
+    fill?: Color;
+    fillOpacity?: number;
+    stroke?: Color;
+    strokeWidth?: number;
+    strokeOpacity?: number;
+    strokeLineCap?: LineCapStyle;
+    fillRule?: FillRule;
+    strokeLineJoin?: LineJoinStyle;
+    fontFamily?: string;
+    fontStyle?: string;
+    fontWeight?: string;
+    fontSize?: number;
+    rotation?: Degrees;
+    viewBox: Box;
+};
+type SVGAttributes = {
+    rotate?: Degrees;
+    scale?: number;
+    skewX?: Degrees;
+    skewY?: Degrees;
+    width?: number;
+    height?: number;
+    x?: number;
+    y?: number;
+    cx?: number;
+    cy?: number;
+    r?: number;
+    rx?: number;
+    ry?: number;
+    x1?: number;
+    y1?: number;
+    x2?: number;
+    y2?: number;
+    d?: string;
+    src?: string;
+    textAnchor?: string;
+    preserveAspectRatio?: string;
+    strokeWidth?: number;
+    dominantBaseline?: string;
+    points?: string;
+};
+type TransformAttributes = {
+    matrix: TransformationMatrix;
+    clipSpaces: Space[];
+};
+export type SVGElement = HTMLElement & {
+    svgAttributes: InheritedAttributes & SVGAttributes & TransformAttributes;
+};
+export declare const drawSvg: (page: PDFPage, svg: string, options: PDFPageDrawSVGElementOptions) => Promise<void>;
+export {};

package/dist/types/src/api/svgPath.d.ts

@@ -0,0 +1,2 @@
+import { PDFOperator } from '../core';
+export declare const svgPathToOperators: (path: string) => PDFOperator[];

package/dist/types/src/api/text/alignment.d.ts

@@ -0,0 +1,5 @@
+export declare enum TextAlignment {
+    Left = 0,
+    Center = 1,
+    Right = 2
+}

package/dist/types/src/api/text/index.d.ts

@@ -0,0 +1,2 @@
+export * from './alignment';
+export * from './layout';

package/dist/types/src/api/text/layout.d.ts

@@ -0,0 +1,54 @@
+import PDFFont from '../PDFFont';
+import { TextAlignment } from './alignment';
+import { PDFHexString } from '../../core';
+export interface TextPosition {
+    text: string;
+    encoded: PDFHexString;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface LayoutBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface LayoutTextOptions {
+    alignment: TextAlignment;
+    fontSize?: number;
+    font: PDFFont;
+    bounds: LayoutBounds;
+}
+export interface MultilineTextLayout {
+    bounds: LayoutBounds;
+    lines: TextPosition[];
+    fontSize: number;
+    lineHeight: number;
+}
+export declare const layoutMultilineText: (text: string, { alignment, fontSize, font, bounds }: LayoutTextOptions) => MultilineTextLayout;
+export interface LayoutCombedTextOptions {
+    fontSize?: number;
+    font: PDFFont;
+    bounds: LayoutBounds;
+    cellCount: number;
+}
+export interface CombedTextLayout {
+    bounds: LayoutBounds;
+    cells: TextPosition[];
+    fontSize: number;
+}
+export declare const layoutCombedText: (text: string, { fontSize, font, bounds, cellCount }: LayoutCombedTextOptions) => CombedTextLayout;
+export interface LayoutSinglelineTextOptions {
+    alignment: TextAlignment;
+    fontSize?: number;
+    font: PDFFont;
+    bounds: LayoutBounds;
+}
+export interface SinglelineTextLayout {
+    bounds: LayoutBounds;
+    line: TextPosition;
+    fontSize: number;
+}
+export declare const layoutSinglelineText: (text: string, { alignment, fontSize, font, bounds }: LayoutSinglelineTextOptions) => SinglelineTextLayout;

package/dist/types/src/core/PDFContext.d.ts

@@ -0,0 +1,84 @@
+import PDFHeader from './document/PDFHeader';
+import PDFArray from './objects/PDFArray';
+import PDFBool from './objects/PDFBool';
+import PDFDict from './objects/PDFDict';
+import PDFHexString from './objects/PDFHexString';
+import PDFName from './objects/PDFName';
+import PDFNull from './objects/PDFNull';
+import PDFNumber from './objects/PDFNumber';
+import PDFObject from './objects/PDFObject';
+import PDFRawStream from './objects/PDFRawStream';
+import PDFRef from './objects/PDFRef';
+import PDFStream from './objects/PDFStream';
+import PDFString from './objects/PDFString';
+import PDFOperator from './operators/PDFOperator';
+import PDFContentStream from './structures/PDFContentStream';
+import { SimpleRNG } from '../utils/rng';
+type LookupKey = PDFRef | PDFObject | undefined;
+interface LiteralObject {
+    [name: string]: Literal | PDFObject;
+}
+interface LiteralArray {
+    [index: number]: Literal | PDFObject;
+}
+type Literal = LiteralObject | LiteralArray | string | number | boolean | null | undefined;
+declare class PDFContext {
+    isDecrypted: boolean;
+    static create: () => PDFContext;
+    largestObjectNumber: number;
+    header: PDFHeader;
+    trailerInfo: {
+        Root?: PDFObject;
+        Encrypt?: PDFObject;
+        Info?: PDFObject;
+        ID?: PDFObject;
+    };
+    rng: SimpleRNG;
+    private readonly indirectObjects;
+    private pushGraphicsStateContentStreamRef?;
+    private popGraphicsStateContentStreamRef?;
+    private constructor();
+    assign(ref: PDFRef, object: PDFObject): void;
+    nextRef(): PDFRef;
+    register(object: PDFObject): PDFRef;
+    delete(ref: PDFRef): boolean;
+    lookupMaybe(ref: LookupKey, type: typeof PDFArray): PDFArray | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFBool): PDFBool | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFDict): PDFDict | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFHexString): PDFHexString | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFName): PDFName | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFNull): typeof PDFNull | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFNumber): PDFNumber | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFStream): PDFStream | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFRef): PDFRef | undefined;
+    lookupMaybe(ref: LookupKey, type: typeof PDFString): PDFString | undefined;
+    lookupMaybe(ref: LookupKey, type1: typeof PDFString, type2: typeof PDFHexString): PDFString | PDFHexString | undefined;
+    lookup(ref: LookupKey): PDFObject | undefined;
+    lookup(ref: LookupKey, type: typeof PDFArray): PDFArray;
+    lookup(ref: LookupKey, type: typeof PDFBool): PDFBool;
+    lookup(ref: LookupKey, type: typeof PDFDict): PDFDict;
+    lookup(ref: LookupKey, type: typeof PDFHexString): PDFHexString;
+    lookup(ref: LookupKey, type: typeof PDFName): PDFName;
+    lookup(ref: LookupKey, type: typeof PDFNull): typeof PDFNull;
+    lookup(ref: LookupKey, type: typeof PDFNumber): PDFNumber;
+    lookup(ref: LookupKey, type: typeof PDFStream): PDFStream;
+    lookup(ref: LookupKey, type: typeof PDFRef): PDFRef;
+    lookup(ref: LookupKey, type: typeof PDFString): PDFString;
+    lookup(ref: LookupKey, type1: typeof PDFString, type2: typeof PDFHexString): PDFString | PDFHexString;
+    getObjectRef(pdfObject: PDFObject): PDFRef | undefined;
+    enumerateIndirectObjects(): [PDFRef, PDFObject][];
+    obj(literal: null | undefined): typeof PDFNull;
+    obj(literal: string): PDFName;
+    obj(literal: number): PDFNumber;
+    obj(literal: boolean): PDFBool;
+    obj(literal: LiteralObject): PDFDict;
+    obj(literal: LiteralArray): PDFArray;
+    stream(contents: string | Uint8Array, dict?: LiteralObject): PDFRawStream;
+    flateStream(contents: string | Uint8Array, dict?: LiteralObject): PDFRawStream;
+    contentStream(operators: PDFOperator[], dict?: LiteralObject): PDFContentStream;
+    formXObject(operators: PDFOperator[], dict?: LiteralObject): PDFContentStream;
+    getPushGraphicsStateContentStream(): PDFRef;
+    getPopGraphicsStateContentStream(): PDFRef;
+    addRandomSuffix(prefix: string, suffixLength?: number): string;
+}
+export default PDFContext;

package/dist/types/src/core/PDFObjectCopier.d.ts

@@ -0,0 +1,37 @@
+import PDFObject from './objects/PDFObject';
+import PDFContext from './PDFContext';
+/**
+ * PDFObjectCopier copies PDFObjects from a src context to a dest context.
+ * The primary use case for this is to copy pages between PDFs.
+ *
+ * _Copying_ an object with a PDFObjectCopier is different from _cloning_ an
+ * object with its [[PDFObject.clone]] method:
+ *
+ * ```
+ *   const src: PDFContext = ...
+ *   const dest: PDFContext = ...
+ *   const originalObject: PDFObject = ...
+ *   const copiedObject = PDFObjectCopier.for(src, dest).copy(originalObject);
+ *   const clonedObject = originalObject.clone();
+ * ```
+ *
+ * Copying an object is equivalent to cloning it and then copying over any other
+ * objects that it references. Note that only dictionaries, arrays, and streams
+ * (or structures build from them) can contain indirect references to other
+ * objects. Copying a PDFObject that is not a dictionary, array, or stream is
+ * supported, but is equivalent to cloning it.
+ */
+declare class PDFObjectCopier {
+    static for: (src: PDFContext, dest: PDFContext) => PDFObjectCopier;
+    private readonly src;
+    private readonly dest;
+    private readonly traversedObjects;
+    private constructor();
+    copy: <T extends PDFObject>(object: T) => T;
+    private copyPDFPage;
+    private copyPDFDict;
+    private copyPDFArray;
+    private copyPDFStream;
+    private copyPDFIndirectObject;
+}
+export default PDFObjectCopier;