@pdfme/pdf-lib 1.17.3 → 1.18.3

package/src/api/form/PDFTextField.ts

@@ -1,25 +1,25 @@
-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 PDFDocument from '../PDFDocument';
+import PDFPage from '../PDFPage';
+import PDFFont from '../PDFFont';
+import PDFImage from '../PDFImage';
 import PDFField, {
   FieldAppearanceOptions,
   assertFieldAppearanceOptions,
-} from 'src/api/form/PDFField';
+} from './PDFField';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
   defaultTextFieldAppearanceProvider,
-} 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 {
   RichTextFieldReadError,
   ExceededMaxLengthError,
   InvalidMaxLengthError,
-} from 'src/api/errors';
-import { ImageAlignment } from 'src/api/image/alignment';
-import { TextAlignment } from 'src/api/text/alignment';
+} from '../errors';
+import { ImageAlignment } from '../image/alignment';
+import { TextAlignment } from '../text/alignment';
 
 import {
   PDFHexString,
@@ -28,14 +28,14 @@ import {
   PDFAcroText,
   AcroTextFlags,
   PDFWidgetAnnotation,
-} from 'src/core';
+} from '../../core';
 import {
   assertIs,
   assertIsOneOf,
   assertOrUndefined,
   assertPositive,
   assertRangeOrUndefined,
-} from 'src/utils';
+} from '../../utils';
 
 /**
  * Represents a text field of a [[PDFForm]].

package/src/api/form/appearances.ts

@@ -1,13 +1,13 @@
-import { PDFOperator, PDFWidgetAnnotation } from 'src/core';
-import PDFFont from 'src/api/PDFFont';
-import PDFButton from 'src/api/form/PDFButton';
-import PDFCheckBox from 'src/api/form/PDFCheckBox';
-import PDFDropdown from 'src/api/form/PDFDropdown';
-import PDFField from 'src/api/form/PDFField';
-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 { PDFOperator, PDFWidgetAnnotation } from '../../core';
+import PDFFont from '../PDFFont';
+import PDFButton from '../form/PDFButton';
+import PDFCheckBox from '../form/PDFCheckBox';
+import PDFDropdown from '../form/PDFDropdown';
+import PDFField from '../form/PDFField';
+import PDFOptionList from '../form/PDFOptionList';
+import PDFRadioGroup from '../form/PDFRadioGroup';
+import PDFSignature from '../form/PDFSignature';
+import PDFTextField from '../form/PDFTextField';
 import {
   drawCheckBox,
   rotateInPlace,
@@ -15,7 +15,7 @@ import {
   drawButton,
   drawTextField,
   drawOptionList,
-} from 'src/api/operations';
+} from '../operations';
 import {
   rgb,
   componentsToColor,
@@ -23,17 +23,17 @@ import {
   grayscale,
   cmyk,
   Color,
-} from 'src/api/colors';
-import { reduceRotation, adjustDimsForRotation } from 'src/api/rotations';
+} from '../colors';
+import { reduceRotation, adjustDimsForRotation } from '../rotations';
 import {
   layoutMultilineText,
   layoutCombedText,
   TextPosition,
   layoutSinglelineText,
-} from 'src/api/text/layout';
-import { TextAlignment } from 'src/api/text/alignment';
-import { setFontAndSize } from 'src/api/operators';
-import { findLastMatch } from 'src/utils';
+} from '../text/layout';
+import { TextAlignment } from '../text/alignment';
+import { setFontAndSize } from '../operators';
+import { findLastMatch } from '../../utils';
 
 /*********************** Appearance Provider Types ****************************/
 
@@ -102,7 +102,7 @@ export type AppearanceProviderFor<T extends PDFField> =
 
 /********************* Appearance Provider Functions **************************/
 
-export const normalizeAppearance = <T>(
+export const normalizeAppearance = <T extends Object>(
   appearance: T | AppearanceMapping<T>,
 ): AppearanceMapping<T> => {
   if ('normal' in appearance) return appearance;
@@ -112,7 +112,8 @@ export const normalizeAppearance = <T>(
 // Examples:
 //   `/Helv 12 Tf` -> ['/Helv 12 Tf', 'Helv', '12']
 //   `/HeBo 8.00 Tf` -> ['/HeBo 8 Tf', 'HeBo', '8.00']
-const tfRegex = /\/([^\0\t\n\f\r\ ]+)[\0\t\n\f\r\ ]+(\d*\.\d+|\d+)[\0\t\n\f\r\ ]+Tf/;
+const tfRegex =
+  /\/([^\0\t\n\f\r\ ]+)[\0\t\n\f\r\ ]+(\d*\.\d+|\d+)[\0\t\n\f\r\ ]+Tf/;
 
 const getDefaultFontSize = (field: {
   getDefaultAppearance(): string | undefined;
@@ -127,7 +128,8 @@ const getDefaultFontSize = (field: {
 //   `0.3 g` -> ['0.3', 'g']
 //   `0.3 1 .3 rg` -> ['0.3', '1', '.3', 'rg']
 //   `0.3 1 .3 0 k` -> ['0.3', '1', '.3', '0', 'k']
-const colorRegex = /(\d*\.\d+|\d+)[\0\t\n\f\r\ ]*(\d*\.\d+|\d+)?[\0\t\n\f\r\ ]*(\d*\.\d+|\d+)?[\0\t\n\f\r\ ]*(\d*\.\d+|\d+)?[\0\t\n\f\r\ ]+(g|rg|k)/;
+const colorRegex =
+  /(\d*\.\d+|\d+)[\0\t\n\f\r\ ]*(\d*\.\d+|\d+)?[\0\t\n\f\r\ ]*(\d*\.\d+|\d+)?[\0\t\n\f\r\ ]*(\d*\.\d+|\d+)?[\0\t\n\f\r\ ]+(g|rg|k)/;
 
 const getDefaultColor = (field: {
   getDefaultAppearance(): string | undefined;
@@ -163,10 +165,9 @@ const updateDefaultAppearance = (
   field.setDefaultAppearance(da);
 };
 
-export const defaultCheckBoxAppearanceProvider: AppearanceProviderFor<PDFCheckBox> = (
-  checkBox,
-  widget,
-) => {
+export const defaultCheckBoxAppearanceProvider: AppearanceProviderFor<
+  PDFCheckBox
+> = (checkBox, widget) => {
   // The `/DA` entry can be at the widget or field level - so we handle both
   const widgetColor = getDefaultColor(widget);
   const fieldColor = getDefaultColor(checkBox.acroField);
@@ -245,10 +246,9 @@ export const defaultCheckBoxAppearanceProvider: AppearanceProviderFor<PDFCheckBo
   };
 };
 
-export const defaultRadioGroupAppearanceProvider: AppearanceProviderFor<PDFRadioGroup> = (
-  radioGroup,
-  widget,
-) => {
+export const defaultRadioGroupAppearanceProvider: AppearanceProviderFor<
+  PDFRadioGroup
+> = (radioGroup, widget) => {
   // The `/DA` entry can be at the widget or field level - so we handle both
   const widgetColor = getDefaultColor(widget);
   const fieldColor = getDefaultColor(radioGroup.acroField);
@@ -326,11 +326,9 @@ export const defaultRadioGroupAppearanceProvider: AppearanceProviderFor<PDFRadio
   };
 };
 
-export const defaultButtonAppearanceProvider: AppearanceProviderFor<PDFButton> = (
-  button,
-  widget,
-  font,
-) => {
+export const defaultButtonAppearanceProvider: AppearanceProviderFor<
+  PDFButton
+> = (button, widget, font) => {
   // The `/DA` entry can be at the widget or field level - so we handle both
   const widgetColor = getDefaultColor(widget);
   const fieldColor = getDefaultColor(button.acroField);
@@ -416,11 +414,9 @@ export const defaultButtonAppearanceProvider: AppearanceProviderFor<PDFButton> =
   };
 };
 
-export const defaultTextFieldAppearanceProvider: AppearanceProviderFor<PDFTextField> = (
-  textField,
-  widget,
-  font,
-) => {
+export const defaultTextFieldAppearanceProvider: AppearanceProviderFor<
+  PDFTextField
+> = (textField, widget, font) => {
   // The `/DA` entry can be at the widget or field level - so we handle both
   const widgetColor = getDefaultColor(widget);
   const fieldColor = getDefaultColor(textField.acroField);
@@ -508,11 +504,9 @@ export const defaultTextFieldAppearanceProvider: AppearanceProviderFor<PDFTextFi
   return [...rotate, ...drawTextField(options)];
 };
 
-export const defaultDropdownAppearanceProvider: AppearanceProviderFor<PDFDropdown> = (
-  dropdown,
-  widget,
-  font,
-) => {
+export const defaultDropdownAppearanceProvider: AppearanceProviderFor<
+  PDFDropdown
+> = (dropdown, widget, font) => {
   // The `/DA` entry can be at the widget or field level - so we handle both
   const widgetColor = getDefaultColor(widget);
   const fieldColor = getDefaultColor(dropdown.acroField);
@@ -575,11 +569,9 @@ export const defaultDropdownAppearanceProvider: AppearanceProviderFor<PDFDropdow
   return [...rotate, ...drawTextField(options)];
 };
 
-export const defaultOptionListAppearanceProvider: AppearanceProviderFor<PDFOptionList> = (
-  optionList,
-  widget,
-  font,
-) => {
+export const defaultOptionListAppearanceProvider: AppearanceProviderFor<
+  PDFOptionList
+> = (optionList, widget, font) => {
   // The `/DA` entry can be at the widget or field level - so we handle both
   const widgetColor = getDefaultColor(widget);
   const fieldColor = getDefaultColor(optionList.acroField);

package/src/api/form/index.ts

@@ -1,10 +1,10 @@
-export * from 'src/api/form/appearances';
-export { default as PDFButton } from 'src/api/form/PDFButton';
-export { default as PDFCheckBox } from 'src/api/form/PDFCheckBox';
-export { default as PDFDropdown } from 'src/api/form/PDFDropdown';
-export { default as PDFField } from 'src/api/form/PDFField';
-export { default as PDFForm } from 'src/api/form/PDFForm';
-export { default as PDFOptionList } from 'src/api/form/PDFOptionList';
-export { default as PDFRadioGroup } from 'src/api/form/PDFRadioGroup';
-export { default as PDFSignature } from 'src/api/form/PDFSignature';
-export { default as PDFTextField } from 'src/api/form/PDFTextField';
+export * from './appearances';
+export { default as PDFButton } from './PDFButton';
+export { default as PDFCheckBox } from './PDFCheckBox';
+export { default as PDFDropdown } from './PDFDropdown';
+export { default as PDFField } from './PDFField';
+export { default as PDFForm } from './PDFForm';
+export { default as PDFOptionList } from './PDFOptionList';
+export { default as PDFRadioGroup } from './PDFRadioGroup';
+export { default as PDFSignature } from './PDFSignature';
+export { default as PDFTextField } from './PDFTextField';

package/src/api/image/index.ts

@@ -1 +1 @@
-export * from 'src/api/image/alignment';
+export * from './alignment';

package/src/api/index.ts

@@ -1,20 +1,20 @@
-export * from 'src/api/form';
-export * from 'src/api/text';
-export * from 'src/api/colors';
-export * from 'src/api/errors';
-export * from 'src/api/image';
-export * from 'src/api/objects';
-export * from 'src/api/operations';
-export * from 'src/api/operators';
-export * from 'src/api/rotations';
-export * from 'src/api/sizes';
-export * from 'src/api/PDFPageOptions';
-export * from 'src/api/PDFDocumentOptions';
-export * from 'src/api/StandardFonts';
-export { default as PDFDocument } from 'src/api/PDFDocument';
-export { default as PDFFont } from 'src/api/PDFFont';
-export { default as PDFImage } from 'src/api/PDFImage';
-export { default as PDFPage } from 'src/api/PDFPage';
-export { default as PDFEmbeddedPage } from 'src/api/PDFEmbeddedPage';
-export { default as PDFJavaScript } from 'src/api/PDFJavaScript';
-export { default as Embeddable } from 'src/api/Embeddable';
+export * from './form';
+export * from './text';
+export * from './colors';
+export * from './errors';
+export * from './image';
+export * from './objects';
+export * from './operations';
+export * from './operators';
+export * from './rotations';
+export * from './sizes';
+export * from './PDFPageOptions';
+export * from './PDFDocumentOptions';
+export * from './StandardFonts';
+export { default as PDFDocument } from './PDFDocument';
+export { default as PDFFont } from './PDFFont';
+export { default as PDFImage } from './PDFImage';
+export { default as PDFPage } from './PDFPage';
+export { default as PDFEmbeddedPage } from './PDFEmbeddedPage';
+export { default as PDFJavaScript } from './PDFJavaScript';
+export { default as Embeddable } from './Embeddable';

package/src/api/objects.ts

@@ -1,4 +1,4 @@
-import { PDFName, PDFNumber } from 'src/core';
+import { PDFName, PDFNumber } from '../core';
 
 export const asPDFName = (name: string | PDFName) =>
   name instanceof PDFName ? name : PDFName.of(name);

package/src/api/operations.ts

@@ -1,4 +1,4 @@
-import { Color, setFillingColor, setStrokingColor } from 'src/api/colors';
+import { Color, setFillingColor, setStrokingColor } from './colors';
 import {
   beginText,
   closePath,
@@ -31,11 +31,15 @@ import {
   clip,
   endPath,
   appendBezierCurve,
-} from 'src/api/operators';
-import { Rotation, degrees, toRadians } from 'src/api/rotations';
-import { svgPathToOperators } from 'src/api/svgPath';
-import { PDFHexString, PDFName, PDFNumber, PDFOperator } from 'src/core';
-import { asNumber } from 'src/api/objects';
+  FillRule,
+  fillEvenOdd,
+  concatTransformationMatrix,
+} from './operators';
+import { Rotation, degrees, toRadians } from './rotations';
+import { svgPathToOperators } from './svgPath';
+import { PDFHexString, PDFName, PDFNumber, PDFOperator } from '../core';
+import { asNumber } from './objects';
+import type { Space, TransformationMatrix } from '../types'
 
 export interface DrawTextOptions {
   color: Color;
@@ -47,8 +51,27 @@ export interface DrawTextOptions {
   x: number | PDFNumber;
   y: number | PDFNumber;
   graphicsState?: string | PDFName;
+  matrix?: TransformationMatrix;
+  clipSpaces?: Space[];
 }
 
+const clipSpace = ({ 
+  topLeft,
+  topRight,
+  bottomRight,
+  bottomLeft
+}: Space) => 
+  [
+    moveTo(topLeft.x, topLeft.y),
+    lineTo(topRight.x, topRight.y),
+    lineTo(bottomRight.x, bottomRight.y),
+    lineTo(bottomLeft.x, bottomLeft.y),
+    closePath(),
+    clip(),
+    endPath(),
+  ]
+const clipSpaces = (spaces: Space[]) => spaces.flatMap(clipSpace)
+
 export const drawText = (
   line: PDFHexString,
   options: DrawTextOptions,
@@ -82,6 +105,8 @@ export const drawLinesOfText = (
   const operators = [
     pushGraphicsState(),
     options.graphicsState && setGraphicsState(options.graphicsState),
+    ...(options.clipSpaces ? clipSpaces(options.clipSpaces) : []),
+    options.matrix && concatTransformationMatrix(...options.matrix),
     beginText(),
     setFillingColor(options.color),
     setFontAndSize(options.font, options.size),
@@ -114,11 +139,15 @@ export const drawImage = (
     xSkew: Rotation;
     ySkew: Rotation;
     graphicsState?: string | PDFName;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
   },
 ): PDFOperator[] =>
   [
     pushGraphicsState(),
     options.graphicsState && setGraphicsState(options.graphicsState),
+    ...(options.clipSpaces ? clipSpaces(options.clipSpaces) : []),
+    options.matrix && concatTransformationMatrix(...options.matrix),
     translate(options.x, options.y),
     rotateRadians(toRadians(options.rotate)),
     scale(options.width, options.height),
@@ -160,10 +189,14 @@ export const drawLine = (options: {
   dashPhase?: number | PDFNumber;
   lineCap?: LineCapStyle;
   graphicsState?: string | PDFName;
+  matrix?: TransformationMatrix;
+  clipSpaces?: Space[];
 }) =>
   [
     pushGraphicsState(),
     options.graphicsState && setGraphicsState(options.graphicsState),
+    ...(options.clipSpaces ? clipSpaces(options.clipSpaces) : []),
+    options.matrix && concatTransformationMatrix(...options.matrix),
     options.color && setStrokingColor(options.color),
     setLineWidth(options.thickness),
     setDashPattern(options.dashArray ?? [], options.dashPhase ?? 0),
@@ -190,8 +223,9 @@ export const drawRectangle = (options: {
   borderDashArray?: (number | PDFNumber)[];
   borderDashPhase?: number | PDFNumber;
   graphicsState?: string | PDFName;
-}) =>
-  [
+  matrix?: TransformationMatrix;
+  clipSpaces?: Space[];
+}) => [
     pushGraphicsState(),
     options.graphicsState && setGraphicsState(options.graphicsState),
     options.color && setFillingColor(options.color),
@@ -199,6 +233,8 @@ export const drawRectangle = (options: {
     setLineWidth(options.borderWidth),
     options.borderLineCap && setLineCap(options.borderLineCap),
     setDashPattern(options.borderDashArray ?? [], options.borderDashPhase ?? 0),
+    ...(options.clipSpaces ? clipSpaces(options.clipSpaces) : []),
+    options.matrix && concatTransformationMatrix(...options.matrix),
     translate(options.x, options.y),
     rotateRadians(toRadians(options.rotate)),
     skewRadians(toRadians(options.xSkew), toRadians(options.ySkew)),
@@ -298,12 +334,16 @@ export const drawEllipse = (options: {
   borderDashPhase?: number | PDFNumber;
   graphicsState?: string | PDFName;
   borderLineCap?: LineCapStyle;
+  matrix?: TransformationMatrix;
+  clipSpaces?: Space[];
 }) =>
   [
     pushGraphicsState(),
     options.graphicsState && setGraphicsState(options.graphicsState),
     options.color && setFillingColor(options.color),
     options.borderColor && setStrokingColor(options.borderColor),
+    ...(options.clipSpaces ? clipSpaces(options.clipSpaces) : []),
+    options.matrix && concatTransformationMatrix(...options.matrix),
     setLineWidth(options.borderWidth),
     options.borderLineCap && setLineCap(options.borderLineCap),
     setDashPattern(options.borderDashArray ?? [], options.borderDashPhase ?? 0),
@@ -348,18 +388,21 @@ export const drawSvgPath = (
     borderDashPhase?: number | PDFNumber;
     borderLineCap?: LineCapStyle;
     graphicsState?: string | PDFName;
+    fillRule?: FillRule;
+    matrix?: TransformationMatrix;
+    clipSpaces?: Space[];
   },
 ) =>
   [
     pushGraphicsState(),
     options.graphicsState && setGraphicsState(options.graphicsState),
+    ...(options.clipSpaces ? clipSpaces(options.clipSpaces) : []),
+    options.matrix && concatTransformationMatrix(...options.matrix),
 
     translate(options.x, options.y),
     rotateRadians(toRadians(options.rotate ?? degrees(0))),
 
-    // SVG path Y axis is opposite pdf-lib's
-    options.scale ? scale(options.scale, -options.scale) : scale(1, -1),
-
+    options.scale && scale(options.scale, options.scale),
     options.color && setFillingColor(options.color),
     options.borderColor && setStrokingColor(options.borderColor),
     options.borderWidth && setLineWidth(options.borderWidth),
@@ -371,7 +414,7 @@ export const drawSvgPath = (
 
     // prettier-ignore
     options.color && options.borderWidth ? fillAndStroke()
-  : options.color                      ? fill()
+  : options.color                      ? options.fillRule === FillRule.EvenOdd ? fillEvenOdd() : fill()
   : options.borderColor                ? stroke()
   : closePath(),
 

package/src/api/operators.ts

@@ -1,12 +1,12 @@
-import { asNumber, asPDFName, asPDFNumber } from 'src/api/objects';
-import { degreesToRadians } from 'src/api/rotations';
+import { asNumber, asPDFName, asPDFNumber } from './objects';
+import { degreesToRadians } from './rotations';
 import {
   PDFHexString,
   PDFName,
   PDFNumber,
   PDFOperator,
   PDFOperatorNames as Ops,
-} from 'src/core';
+} from '../core';
 
 /* ==================== Clipping Path Operators ==================== */
 
@@ -185,8 +185,15 @@ export const square = (xPos: number, yPos: number, size: number) =>
 
 export const stroke = () => PDFOperator.of(Ops.StrokePath);
 
+export enum FillRule {
+  NonZero = 'f',
+  EvenOdd = 'f*'
+}
+
 export const fill = () => PDFOperator.of(Ops.FillNonZero);
 
+export const fillEvenOdd = () => PDFOperator.of(Ops.FillEvenOdd);
+
 export const fillAndStroke = () => PDFOperator.of(Ops.FillNonZeroAndStroke);
 
 export const endPath = () => PDFOperator.of(Ops.EndPath);

package/src/api/rotations.ts

@@ -1,4 +1,4 @@
-import { assertIs, error } from 'src/utils';
+import { assertIs, error } from '../utils';
 
 export enum RotationTypes {
   Degrees = 'degrees',