@adnsistemas/pdf-lib 1.18.0 → 2.4.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,20 @@ 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 PDFSvg from './PDFSvg';
 import {
   PDFPageDrawCircleOptions,
   PDFPageDrawEllipseOptions,
@@ -30,9 +32,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 +45,7 @@ import {
   PDFRef,
   PDFDict,
   PDFArray,
-} from 'src/core';
+} from '../core';
 import {
   assertEachIs,
   assertIs,
@@ -54,7 +57,8 @@ import {
   lineSplit,
   assertRangeOrUndefined,
   assertIsOneOfOrUndefined,
-} from 'src/utils';
+} from '../utils';
+import { drawSvg } from './svg';
 
 /**
  * Represents a single page of a [[PDFDocument]].
@@ -977,6 +981,11 @@ export default class PDFPage {
     assertOrUndefined(options.maxWidth, 'options.maxWidth', ['number']);
     assertOrUndefined(options.wordBreaks, 'options.wordBreaks', [Array]);
     assertIsOneOfOrUndefined(options.blendMode, 'options.blendMode', BlendMode);
+    assertOrUndefined(options.strokeColor, 'options.strokeColor', [
+      [Object, 'Color'],
+    ]);
+    assertOrUndefined(options.strokeWidth, 'options.strokeWidth', ['number']);
+    assertOrUndefined(options.renderMode, 'options.renderMode', ['number']);
 
     const { oldFont, newFont, newFontKey } = this.setOrEmbedFont(options.font);
     const fontSize = options.size || this.fontSize;
@@ -1011,6 +1020,11 @@ export default class PDFPage {
         y: options.y ?? this.y,
         lineHeight: options.lineHeight ?? this.lineHeight,
         graphicsState: graphicsStateKey,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces,
+        strokeColor: options.strokeColor,
+        strokeWidth: options.strokeWidth,
+        renderMode: options.renderMode,
       }),
     );
 
@@ -1076,6 +1090,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 +1160,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 +1254,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 +1280,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 +1341,8 @@ export default class PDFPage {
         dashPhase: options.dashPhase ?? undefined,
         lineCap: options.lineCap ?? undefined,
         graphicsState: graphicsStateKey,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces,
       }),
     );
   }
@@ -1333,6 +1355,8 @@ export default class PDFPage {
    * page.drawRectangle({
    *   x: 25,
    *   y: 75,
+   *   rx: 5, // This is the border radius
+   *   ry: 5,
    *   width: 250,
    *   height: 75,
    *   rotate: degrees(-15),
@@ -1355,7 +1379,9 @@ export default class PDFPage {
     assertOrUndefined(options.ySkew, 'options.ySkew', [[Object, 'Rotation']]);
     assertOrUndefined(options.borderWidth, 'options.borderWidth', ['number']);
     assertOrUndefined(options.color, 'options.color', [[Object, 'Color']]);
-    assertRangeOrUndefined(options.opacity, 'opacity.opacity', 0, 1);
+    assertRangeOrUndefined(options.opacity, 'options.opacity', 0, 1);
+    assertOrUndefined(options.rx, 'options.rx', ['number']);
+    assertOrUndefined(options.ry, 'options.ry', ['number']);
     assertOrUndefined(options.borderColor, 'options.borderColor', [
       [Object, 'Color'],
     ]);
@@ -1400,11 +1426,15 @@ export default class PDFPage {
         ySkew: options.ySkew ?? degrees(0),
         borderWidth: options.borderWidth ?? 0,
         color: options.color ?? undefined,
+        rx: options.rx ?? 0,
+        ry: options.ry ?? 0,
         borderColor: options.borderColor ?? undefined,
         borderDashArray: options.borderDashArray ?? undefined,
         borderDashPhase: options.borderDashPhase ?? undefined,
         graphicsState: graphicsStateKey,
         borderLineCap: options.borderLineCap ?? undefined,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces,
       }),
     );
   }
@@ -1508,6 +1538,8 @@ export default class PDFPage {
         borderDashPhase: options.borderDashPhase ?? undefined,
         borderLineCap: options.borderLineCap ?? undefined,
         graphicsState: graphicsStateKey,
+        matrix: options.matrix,
+        clipSpaces: options.clipSpaces,
       }),
     );
   }
@@ -1549,7 +1581,48 @@ 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 })
+   * ```
+   *
+   * If the svg contains images, you must call embedSvg from the document that contains that page first:
+   * ```js
+   * const svg = '<svg><image href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII="/></svg>'
+   *
+   * // Draw svg
+   * const pdfSvg = await pdfDoc.embedSvg(svg)
+   * page.drawSvg(pdfSvg, { x: 25, y: 75 })
+   * ```
+   * @param svg The SVG to be drawn.
+   * @param options The options to be used when drawing the SVG.
+   */
+  drawSvg(
+    svg: PDFSvg | string,
+    options: PDFPageDrawSVGElementOptions = {},
+  ): void {
+    assertIs(svg, 'svg', ['string', [PDFSvg, 'PDFSvg']]);
+    assertOrUndefined(options.x, 'options.x', ['number']);
+    assertOrUndefined(options.y, 'options.y', ['number']);
+    assertOrUndefined(options.width, 'options.width', ['number']);
+    assertOrUndefined(options.height, 'options.height', ['number']);
+    assertIsOneOfOrUndefined(options.blendMode, 'options.blendMode', BlendMode);
+
+    drawSvg(this, svg, {
+      x: options.x ?? this.x,
+      y: options.y ?? this.y,
+      fonts: options.fonts,
+      width: options.width,
+      height: options.height,
+      blendMode: options.blendMode,
+    });
+  }
+
+  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, TextRenderingMode } 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;
@@ -32,9 +38,12 @@ export interface PDFPageDrawTextOptions {
   lineHeight?: number;
   maxWidth?: number;
   wordBreaks?: string[];
+  strokeWidth?: number;
+  strokeColor?: Color;
+  renderMode?: TextRenderingMode;
 }
 
-export interface PDFPageDrawImageOptions {
+export interface PDFPageDrawImageOptions extends SvgOptions {
   x?: number;
   y?: number;
   width?: number;
@@ -60,7 +69,7 @@ export interface PDFPageDrawPageOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawSVGOptions {
+export interface PDFPageDrawSVGOptions extends SvgOptions {
   x?: number;
   y?: number;
   scale?: number;
@@ -74,9 +83,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,9 +98,11 @@ export interface PDFPageDrawLineOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawRectangleOptions {
+export interface PDFPageDrawRectangleOptions extends SvgOptions {
   x?: number;
   y?: number;
+  rx?: number;
+  ry?: number;
   width?: number;
   height?: number;
   rotate?: Rotation;
@@ -107,7 +119,7 @@ export interface PDFPageDrawRectangleOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawSquareOptions {
+export interface PDFPageDrawSquareOptions extends SvgOptions {
   x?: number;
   y?: number;
   size?: number;
@@ -125,7 +137,7 @@ export interface PDFPageDrawSquareOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawEllipseOptions {
+export interface PDFPageDrawEllipseOptions extends SvgOptions {
   x?: number;
   y?: number;
   xScale?: number;
@@ -142,7 +154,7 @@ export interface PDFPageDrawEllipseOptions {
   blendMode?: BlendMode;
 }
 
-export interface PDFPageDrawCircleOptions {
+export interface PDFPageDrawCircleOptions extends SvgOptions {
   x?: number;
   y?: number;
   size?: number;
@@ -156,3 +168,13 @@ export interface PDFPageDrawCircleOptions {
   borderLineCap?: LineCapStyle;
   blendMode?: BlendMode;
 }
+
+export interface PDFPageDrawSVGElementOptions {
+  x?: number;
+  y?: number;
+  width?: number;
+  height?: number;
+  fontSize?: number;
+  fonts?: { [fontName: string]: PDFFont };
+  blendMode?: BlendMode;
+}

package/src/api/PDFSvg.ts

@@ -0,0 +1,10 @@
+import PDFImage from './PDFImage';
+
+export default class PDFSvg {
+  svg: string;
+  images: Record<string, PDFImage>;
+  constructor(svg: string, images: Record<string, PDFImage> = {}) {
+    this.svg = svg;
+    this.images = images;
+  }
+}

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,20 +62,27 @@ export const cmyk = (
   return { type: ColorTypes.CMYK, cyan, magenta, yellow, key };
 };
 
-const { Grayscale, RGB, CMYK } = ColorTypes;
+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,
+  };
+};
 
 // prettier-ignore
-export const setFillingColor = (color: Color) => 
-    color.type === Grayscale ? setFillingGrayscaleColor(color.gray)
-  : color.type === RGB       ? setFillingRgbColor(color.red, color.green, color.blue)
-  : color.type === CMYK      ? setFillingCmykColor(color.cyan, color.magenta, color.yellow, color.key)
+export const setFillingColor = (color: Color) =>
+    color.type === ColorTypes.Grayscale ? setFillingGrayscaleColor(color.gray)
+  : color.type === ColorTypes.RGB       ? setFillingRgbColor(color.red, color.green, color.blue)
+  : color.type === ColorTypes.CMYK      ? setFillingCmykColor(color.cyan, color.magenta, color.yellow, color.key)
   : error(`Invalid color: ${JSON.stringify(color)}`);
 
 // prettier-ignore
-export const setStrokingColor = (color: Color) => 
-    color.type === Grayscale ? setStrokingGrayscaleColor(color.gray)
-  : color.type === RGB       ? setStrokingRgbColor(color.red, color.green, color.blue)
-  : color.type === CMYK      ? setStrokingCmykColor(color.cyan, color.magenta, color.yellow, color.key)
+export const setStrokingColor = (color: Color) =>
+    color.type === ColorTypes.Grayscale ? setStrokingGrayscaleColor(color.gray)
+  : color.type === ColorTypes.RGB       ? setStrokingRgbColor(color.red, color.green, color.blue)
+  : color.type === ColorTypes.CMYK      ? setStrokingCmykColor(color.cyan, color.magenta, color.yellow, color.key)
   : error(`Invalid color: ${JSON.stringify(color)}`);
 
 // prettier-ignore
@@ -83,14 +91,14 @@ export const componentsToColor = (comps?: number[], scale = 1) => (
       comps[0] * scale,
     )
   : comps?.length === 3 ? rgb(
-      comps[0] * scale, 
-      comps[1] * scale, 
+      comps[0] * scale,
+      comps[1] * scale,
       comps[2] * scale,
     )
   : comps?.length === 4 ? cmyk(
-      comps[0] * scale, 
-      comps[1] * scale, 
-      comps[2] * scale, 
+      comps[0] * scale,
+      comps[1] * scale,
+      comps[2] * scale,
       comps[3] * scale,
     )
   : undefined
@@ -98,7 +106,7 @@ export const componentsToColor = (comps?: number[], scale = 1) => (
 
 // prettier-ignore
 export const colorToComponents = (color: Color) =>
-    color.type === Grayscale ? [color.gray]
-  : color.type === RGB       ? [color.red, color.green, color.blue]
-  : color.type === CMYK      ? [color.cyan, color.magenta, color.yellow, color.key]
+    color.type === ColorTypes.Grayscale ? [color.gray]
+  : color.type === ColorTypes.RGB       ? [color.red, color.green, color.blue]
+  : color.type === ColorTypes.CMYK      ? [color.cyan, color.magenta, color.yellow, color.key]
   : error(`Invalid color: ${JSON.stringify(color)}`);

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';