@pdfme/pdf-lib 1.17.3 → 1.18.3

package/src/api/PDFPage.ts

@@ -1,4 +1,4 @@
-import { Color, rgb } from 'src/api/colors';
+import { Color, rgb } from './colors';
 import {
   drawImage,
   drawLine,
@@ -7,18 +7,19 @@ import {
   drawRectangle,
   drawSvgPath,
   drawEllipse,
-} from 'src/api/operations';
+} from './operations';
 import {
   popGraphicsState,
   pushGraphicsState,
   translate,
   LineCapStyle,
   scale,
-} from 'src/api/operators';
-import PDFDocument from 'src/api/PDFDocument';
-import PDFEmbeddedPage from 'src/api/PDFEmbeddedPage';
-import PDFFont from 'src/api/PDFFont';
-import PDFImage from 'src/api/PDFImage';
+  FillRule,
+} from './operators';
+import PDFDocument from './PDFDocument';
+import PDFEmbeddedPage from './PDFEmbeddedPage';
+import PDFFont from './PDFFont';
+import PDFImage from './PDFImage';
 import {
   PDFPageDrawCircleOptions,
   PDFPageDrawEllipseOptions,
@@ -30,9 +31,10 @@ import {
   PDFPageDrawSVGOptions,
   PDFPageDrawTextOptions,
   BlendMode,
-} from 'src/api/PDFPageOptions';
-import { degrees, Rotation, toDegrees } from 'src/api/rotations';
-import { StandardFonts } from 'src/api/StandardFonts';
+  PDFPageDrawSVGElementOptions,
+} from './PDFPageOptions';
+import { degrees, Rotation, toDegrees } from './rotations';
+import { StandardFonts } from './StandardFonts';
 import {
   PDFContentStream,
   PDFHexString,
@@ -42,7 +44,7 @@ import {
   PDFRef,
   PDFDict,
   PDFArray,
-} from 'src/core';
+} from '../core';
 import {
   assertEachIs,
   assertIs,
@@ -54,7 +56,8 @@ import {
   lineSplit,
   assertRangeOrUndefined,
   assertIsOneOfOrUndefined,
-} from 'src/utils';
+} from '../utils';
+import { drawSvg } from './svg';
 
 /**
  * Represents a single page of a [[PDFDocument]].
@@ -1011,6 +1014,8 @@ export default class PDFPage {
         y: options.y ?? this.y,
         lineHeight: options.lineHeight ?? this.lineHeight,
         graphicsState: graphicsStateKey,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces
       }),
     );
 
@@ -1076,6 +1081,8 @@ export default class PDFPage {
         xSkew: options.xSkew ?? degrees(0),
         ySkew: options.ySkew ?? degrees(0),
         graphicsState: graphicsStateKey,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces
       }),
     );
   }
@@ -1144,16 +1151,16 @@ export default class PDFPage {
 
     // prettier-ignore
     const xScale = (
-        options.width  !== undefined ? options.width / embeddedPage.width
-      : options.xScale !== undefined ? options.xScale
-      : 1
+      options.width !== undefined ? options.width / embeddedPage.width
+        : options.xScale !== undefined ? options.xScale
+          : 1
     );
 
     // prettier-ignore
     const yScale = (
-        options.height !== undefined ? options.height / embeddedPage.height
-      : options.yScale !== undefined ? options.yScale
-      : 1
+      options.height !== undefined ? options.height / embeddedPage.height
+        : options.yScale !== undefined ? options.yScale
+          : 1
     );
 
     const contentStream = this.getContentStream();
@@ -1238,6 +1245,7 @@ export default class PDFPage {
       1,
     );
     assertIsOneOfOrUndefined(options.blendMode, 'options.blendMode', BlendMode);
+    assertIsOneOfOrUndefined(options.fillRule, 'options.fillRule', FillRule);
 
     const graphicsStateKey = this.maybeEmbedGraphicsState({
       opacity: options.opacity,
@@ -1263,6 +1271,9 @@ export default class PDFPage {
         borderDashPhase: options.borderDashPhase ?? undefined,
         borderLineCap: options.borderLineCap ?? undefined,
         graphicsState: graphicsStateKey,
+        fillRule: options.fillRule,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces
       }),
     );
   }
@@ -1321,6 +1332,8 @@ export default class PDFPage {
         dashPhase: options.dashPhase ?? undefined,
         lineCap: options.lineCap ?? undefined,
         graphicsState: graphicsStateKey,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces,
       }),
     );
   }
@@ -1405,6 +1418,8 @@ export default class PDFPage {
         borderDashPhase: options.borderDashPhase ?? undefined,
         graphicsState: graphicsStateKey,
         borderLineCap: options.borderLineCap ?? undefined,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces,
       }),
     );
   }
@@ -1508,6 +1523,8 @@ export default class PDFPage {
         borderDashPhase: options.borderDashPhase ?? undefined,
         borderLineCap: options.borderLineCap ?? undefined,
         graphicsState: graphicsStateKey,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces,
       }),
     );
   }
@@ -1549,7 +1566,37 @@ export default class PDFPage {
     return { oldFont, oldFontKey, newFont, newFontKey };
   }
 
-  private getFont(): [PDFFont, PDFName] {
+  /**
+   * Draw an SVG on this page. For example:
+   * ```js
+   * const svg = '<svg><path d="M 0,20 L 100,160 Q 130,200 150,120 C 190,-40 200,200 300,150 L 400,90"></path></svg>'
+   *
+   * // Draw svg
+   * page.drawSvg(svg, { x: 25, y: 75 })
+   * ```
+   * @param svg The SVG to be drawn.
+   * @param options The options to be used when drawing the SVG.
+   */
+  async drawSvg(
+    svg: string,
+    options: PDFPageDrawSVGElementOptions = {},
+  ): Promise<void> {
+    assertIs(svg, 'svg', ['string']);
+    assertOrUndefined(options.x, 'options.x', ['number']);
+    assertOrUndefined(options.y, 'options.y', ['number']);
+    assertOrUndefined(options.width, 'options.width', ['number']);
+    assertOrUndefined(options.height, 'options.height', ['number']);
+
+    await drawSvg(this, svg, {
+      x: options.x ?? this.x,
+      y: options.y ?? this.y,
+      fonts: options.fonts,
+      width: options.width,
+      height: options.height,
+    });
+  }
+
+  getFont(): [PDFFont, PDFName] {
     if (!this.font || !this.fontKey) {
       const font = this.doc.embedStandardFont(StandardFonts.Helvetica);
       this.setFont(font);

package/src/api/PDFPageOptions.ts

@@ -1,7 +1,13 @@
-import { Color } from 'src/api/colors';
-import PDFFont from 'src/api/PDFFont';
-import { Rotation } from 'src/api/rotations';
-import { LineCapStyle } from 'src/api/operators';
+import { Color } from './colors';
+import PDFFont from './PDFFont';
+import { Rotation } from './rotations';
+import { FillRule, LineCapStyle } from './operators';
+import type { Space, TransformationMatrix } from '../types'
+
+interface SvgOptions {
+  matrix?: TransformationMatrix
+  clipSpaces?: Space[]
+}
 
 export enum BlendMode {
   Normal = 'Normal',
@@ -18,7 +24,7 @@ export enum BlendMode {
   Exclusion = 'Exclusion',
 }
 
-export interface PDFPageDrawTextOptions {
+export interface PDFPageDrawTextOptions extends SvgOptions {
   color?: Color;
   opacity?: number;
   blendMode?: BlendMode;
@@ -34,7 +40,7 @@ export interface PDFPageDrawTextOptions {
   wordBreaks?: string[];
 }
 
-export interface PDFPageDrawImageOptions {
+export interface PDFPageDrawImageOptions extends SvgOptions {
   x?: number;
   y?: number;
   width?: number;
@@ -60,7 +66,7 @@ export interface PDFPageDrawPageOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawSVGOptions {
+export interface PDFPageDrawSVGOptions extends SvgOptions {
   x?: number;
   y?: number;
   scale?: number;
@@ -74,9 +80,10 @@ export interface PDFPageDrawSVGOptions {
   borderDashPhase?: number;
   borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
+  fillRule?: FillRule
 }
 
-export interface PDFPageDrawLineOptions {
+export interface PDFPageDrawLineOptions extends SvgOptions {
   start: { x: number; y: number };
   end: { x: number; y: number };
   thickness?: number;
@@ -88,7 +95,7 @@ export interface PDFPageDrawLineOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawRectangleOptions {
+export interface PDFPageDrawRectangleOptions extends SvgOptions {
   x?: number;
   y?: number;
   width?: number;
@@ -107,7 +114,7 @@ export interface PDFPageDrawRectangleOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawSquareOptions {
+export interface PDFPageDrawSquareOptions extends SvgOptions {
   x?: number;
   y?: number;
   size?: number;
@@ -125,7 +132,7 @@ export interface PDFPageDrawSquareOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawEllipseOptions {
+export interface PDFPageDrawEllipseOptions extends SvgOptions {
   x?: number;
   y?: number;
   xScale?: number;
@@ -142,7 +149,7 @@ export interface PDFPageDrawEllipseOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawCircleOptions {
+export interface PDFPageDrawCircleOptions extends SvgOptions {
   x?: number;
   y?: number;
   size?: number;
@@ -156,3 +163,12 @@ export interface PDFPageDrawCircleOptions {
   borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
 }
+
+export interface PDFPageDrawSVGElementOptions {
+  x?: number;
+  y?: number;
+  width?: number;
+  height?: number;
+  fontSize?: number;
+  fonts?: { [fontName: string]: PDFFont };
+}

package/src/api/colors.ts

@@ -5,8 +5,9 @@ import {
   setStrokingCmykColor,
   setStrokingGrayscaleColor,
   setStrokingRgbColor,
-} from 'src/api/operators';
-import { assertRange, error } from 'src/utils';
+} from './operators';
+import { assertRange, assertIs, error } from '../utils';
+import ColorParser from 'color';
 
 export enum ColorTypes {
   Grayscale = 'Grayscale',
@@ -61,6 +62,15 @@ export const cmyk = (
   return { type: ColorTypes.CMYK, cyan, magenta, yellow, key };
 };
 
+export const colorString = (color: string): { rgb: Color; alpha?: number } => {
+  assertIs(color, 'color', ['string']);
+  const colorDescription = ColorParser(color).unitObject();
+  return {
+    rgb: rgb(colorDescription.r, colorDescription.g, colorDescription.b),
+    alpha: colorDescription.alpha,
+  };
+};
+
 const { Grayscale, RGB, CMYK } = ColorTypes;
 
 // prettier-ignore

package/src/api/form/PDFButton.ts

@@ -1,27 +1,27 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFPage from 'src/api/PDFPage';
-import PDFFont from 'src/api/PDFFont';
-import PDFImage from 'src/api/PDFImage';
-import { ImageAlignment } from 'src/api/image/alignment';
+import PDFDocument from '../PDFDocument';
+import PDFPage from '../PDFPage';
+import PDFFont from '../PDFFont';
+import PDFImage from '../PDFImage';
+import { ImageAlignment } from '../image/alignment';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
   defaultButtonAppearanceProvider,
-} from 'src/api/form/appearances';
+} from './appearances';
 import PDFField, {
   FieldAppearanceOptions,
   assertFieldAppearanceOptions,
-} from 'src/api/form/PDFField';
-import { rgb } from 'src/api/colors';
-import { degrees } from 'src/api/rotations';
+} from './PDFField';
+import { rgb } from '../colors';
+import { degrees } from '../rotations';
 
 import {
   PDFRef,
   PDFStream,
   PDFAcroPushButton,
   PDFWidgetAnnotation,
-} from 'src/core';
-import { assertIs, assertOrUndefined, assertPositive } from 'src/utils';
+} from '../../core';
+import { assertIs, assertOrUndefined, assertPositive } from '../../utils';
 
 /**
  * Represents a button field of a [[PDFForm]].

package/src/api/form/PDFCheckBox.ts

@@ -1,16 +1,16 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFPage from 'src/api/PDFPage';
+import PDFDocument from '../PDFDocument';
+import PDFPage from '../PDFPage';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
   defaultCheckBoxAppearanceProvider,
-} from 'src/api/form/appearances';
-import { rgb } from 'src/api/colors';
-import { degrees } from 'src/api/rotations';
+} from './appearances';
+import { rgb } from '../colors';
+import { degrees } from '../rotations';
 import PDFField, {
   FieldAppearanceOptions,
   assertFieldAppearanceOptions,
-} from 'src/api/form/PDFField';
+} from './PDFField';
 
 import {
   PDFName,
@@ -18,8 +18,8 @@ import {
   PDFDict,
   PDFAcroCheckBox,
   PDFWidgetAnnotation,
-} from 'src/core';
-import { assertIs, assertOrUndefined } from 'src/utils';
+} from '../../core';
+import { assertIs, assertOrUndefined } from '../../utils';
 
 /**
  * Represents a check box field of a [[PDFForm]].

package/src/api/form/PDFDropdown.ts

@@ -1,17 +1,17 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFPage from 'src/api/PDFPage';
-import PDFFont from 'src/api/PDFFont';
+import PDFDocument from '../PDFDocument';
+import PDFPage from '../PDFPage';
+import PDFFont from '../PDFFont';
 import PDFField, {
   FieldAppearanceOptions,
   assertFieldAppearanceOptions,
-} from 'src/api/form/PDFField';
+} from './PDFField';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
   defaultDropdownAppearanceProvider,
-} from 'src/api/form/appearances';
-import { rgb } from 'src/api/colors';
-import { degrees } from 'src/api/rotations';
+} from './appearances';
+import { rgb } from '../colors';
+import { degrees } from '../rotations';
 
 import {
   PDFHexString,
@@ -21,8 +21,8 @@ import {
   PDFWidgetAnnotation,
   PDFAcroComboBox,
   AcroChoiceFlags,
-} from 'src/core';
-import { assertIs, assertOrUndefined, assertPositive } from 'src/utils';
+} from '../../core';
+import { assertIs, assertOrUndefined, assertPositive } from '../../utils';
 
 /**
  * Represents a dropdown field of a [[PDFForm]].

package/src/api/form/PDFField.ts

@@ -1,7 +1,7 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFFont from 'src/api/PDFFont';
-import { AppearanceMapping } from 'src/api/form/appearances';
-import { Color, colorToComponents, setFillingColor } from 'src/api/colors';
+import PDFDocument from '../PDFDocument';
+import PDFFont from '../PDFFont';
+import { AppearanceMapping } from './appearances';
+import { Color, colorToComponents, setFillingColor } from '../colors';
 import {
   Rotation,
   toDegrees,
@@ -9,7 +9,7 @@ import {
   reduceRotation,
   adjustDimsForRotation,
   degrees,
-} from 'src/api/rotations';
+} from '../rotations';
 
 import {
   PDFRef,
@@ -21,8 +21,8 @@ import {
   AcroFieldFlags,
   PDFAcroTerminal,
   AnnotationFlags,
-} from 'src/core';
-import { assertIs, assertMultiple, assertOrUndefined } from 'src/utils';
+} from '../../core';
+import { assertIs, assertMultiple, assertOrUndefined } from '../../utils';
 import { ImageAlignment } from '../image';
 import PDFImage from '../PDFImage';
 import { drawImage, rotateInPlace } from '../operations';

package/src/api/form/PDFForm.ts

@@ -1,28 +1,28 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFPage from 'src/api/PDFPage';
-import PDFField from 'src/api/form/PDFField';
-import PDFButton from 'src/api/form/PDFButton';
-import PDFCheckBox from 'src/api/form/PDFCheckBox';
-import PDFDropdown from 'src/api/form/PDFDropdown';
-import PDFOptionList from 'src/api/form/PDFOptionList';
-import PDFRadioGroup from 'src/api/form/PDFRadioGroup';
-import PDFSignature from 'src/api/form/PDFSignature';
-import PDFTextField from 'src/api/form/PDFTextField';
+import PDFDocument from '../PDFDocument';
+import PDFPage from '../PDFPage';
+import PDFField from './PDFField';
+import PDFButton from './PDFButton';
+import PDFCheckBox from './PDFCheckBox';
+import PDFDropdown from './PDFDropdown';
+import PDFOptionList from './PDFOptionList';
+import PDFRadioGroup from './PDFRadioGroup';
+import PDFSignature from './PDFSignature';
+import PDFTextField from './PDFTextField';
 import {
   NoSuchFieldError,
   UnexpectedFieldTypeError,
   FieldAlreadyExistsError,
   InvalidFieldNamePartError,
-} from 'src/api/errors';
-import PDFFont from 'src/api/PDFFont';
-import { StandardFonts } from 'src/api/StandardFonts';
-import { rotateInPlace } from 'src/api/operations';
+} from '../errors';
+import PDFFont from '../PDFFont';
+import { StandardFonts } from '../StandardFonts';
+import { rotateInPlace } from '../operations';
 import {
   drawObject,
   popGraphicsState,
   pushGraphicsState,
   translate,
-} from 'src/api/operators';
+} from '../operators';
 import {
   PDFAcroForm,
   PDFAcroField,
@@ -40,8 +40,8 @@ import {
   createPDFAcroFields,
   PDFName,
   PDFWidgetAnnotation,
-} from 'src/core';
-import { assertIs, Cache, assertOrUndefined } from 'src/utils';
+} from '../../core';
+import { assertIs, Cache, assertOrUndefined } from '../../utils';
 
 export interface FlattenOptions {
   updateFieldAppearances: boolean;
@@ -546,22 +546,26 @@ export default class PDFForm {
       const widgets = field.acroField.getWidgets();
 
       for (let j = 0, lenWidgets = widgets.length; j < lenWidgets; j++) {
-        const widget = widgets[j];
-        const page = this.findWidgetPage(widget);
-        const widgetRef = this.findWidgetAppearanceRef(field, widget);
-
-        const xObjectKey = page.node.newXObject('FlatWidget', widgetRef);
-
-        const rectangle = widget.getRectangle();
-        const operators = [
-          pushGraphicsState(),
-          translate(rectangle.x, rectangle.y),
-          ...rotateInPlace({ ...rectangle, rotation: 0 }),
-          drawObject(xObjectKey),
-          popGraphicsState(),
-        ].filter(Boolean) as PDFOperator[];
-
-        page.pushOperators(...operators);
+        try {
+          const widget = widgets[j];
+          const page = this.findWidgetPage(widget);
+          const widgetRef = this.findWidgetAppearanceRef(field, widget);
+
+          const xObjectKey = page.node.newXObject('FlatWidget', widgetRef);
+
+          const rectangle = widget.getRectangle();
+          const operators = [
+            pushGraphicsState(),
+            translate(rectangle.x, rectangle.y),
+            ...rotateInPlace({ ...rectangle, rotation: 0 }),
+            drawObject(xObjectKey),
+            popGraphicsState(),
+          ].filter(Boolean) as PDFOperator[];
+
+          page.pushOperators(...operators);
+        } catch(err) {
+          console.error(err)
+        }
       }
 
       this.removeField(field);
@@ -583,13 +587,17 @@ export default class PDFForm {
     const pages: Set<PDFPage> = new Set();
 
     for (let i = 0, len = widgets.length; i < len; i++) {
-      const widget = widgets[i];
-      const widgetRef = this.findWidgetAppearanceRef(field, widget);
+      try {
+        const widget = widgets[i];
+        const widgetRef = this.findWidgetAppearanceRef(field, widget);
 
-      const page = this.findWidgetPage(widget);
-      pages.add(page);
+        const page = this.findWidgetPage(widget);
+        pages.add(page);
 
-      page.node.removeAnnot(widgetRef);
+        page.node.removeAnnot(widgetRef);
+      } catch(err) {
+        console.error(err)
+      }
     }
 
     pages.forEach((page) => page.node.removeAnnot(field.ref));

package/src/api/form/PDFOptionList.ts

@@ -1,17 +1,17 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFPage from 'src/api/PDFPage';
-import PDFFont from 'src/api/PDFFont';
+import PDFDocument from '../PDFDocument';
+import PDFPage from '../PDFPage';
+import PDFFont from '../PDFFont';
 import PDFField, {
   FieldAppearanceOptions,
   assertFieldAppearanceOptions,
-} from 'src/api/form/PDFField';
+} from './PDFField';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
   defaultOptionListAppearanceProvider,
-} from 'src/api/form/appearances';
-import { rgb } from 'src/api/colors';
-import { degrees } from 'src/api/rotations';
+} from './appearances';
+import { rgb } from '../colors';
+import { degrees } from '../rotations';
 
 import {
   PDFRef,
@@ -21,13 +21,13 @@ import {
   PDFAcroListBox,
   AcroChoiceFlags,
   PDFWidgetAnnotation,
-} from 'src/core';
+} from '../../core';
 import {
   assertIs,
   assertIsSubset,
   assertOrUndefined,
   assertPositive,
-} from 'src/utils';
+} from '../../utils';
 
 /**
  * Represents an option list field of a [[PDFForm]].

package/src/api/form/PDFRadioGroup.ts

@@ -1,16 +1,16 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFPage from 'src/api/PDFPage';
+import PDFDocument from '../PDFDocument';
+import PDFPage from '../PDFPage';
 import PDFField, {
   FieldAppearanceOptions,
   assertFieldAppearanceOptions,
-} from 'src/api/form/PDFField';
+} from './PDFField';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
   defaultRadioGroupAppearanceProvider,
-} from 'src/api/form/appearances';
-import { rgb } from 'src/api/colors';
-import { degrees } from 'src/api/rotations';
+} from './appearances';
+import { rgb } from '../colors';
+import { degrees } from '../rotations';
 
 import {
   PDFName,
@@ -20,8 +20,8 @@ import {
   PDFWidgetAnnotation,
   PDFAcroRadioButton,
   AcroButtonFlags,
-} from 'src/core';
-import { assertIs, assertOrUndefined, assertIsOneOf } from 'src/utils';
+} from '../../core';
+import { assertIs, assertOrUndefined, assertIsOneOf } from '../../utils';
 
 /**
  * Represents a radio group field of a [[PDFForm]].

package/src/api/form/PDFSignature.ts

@@ -1,8 +1,8 @@
-import PDFDocument from 'src/api/PDFDocument';
-import PDFField from 'src/api/form/PDFField';
+import PDFDocument from '../PDFDocument';
+import PDFField from './PDFField';
 
-import { PDFRef, PDFAcroSignature } from 'src/core';
-import { assertIs } from 'src/utils';
+import { PDFRef, PDFAcroSignature } from '../../core';
+import { assertIs } from '../../utils';
 
 /**
  * Represents a signature field of a [[PDFForm]].