@pdfme/pdf-lib 5.4.0-dev.63 → 5.4.0-dev.66

package/src/api/form/PDFOptionList.ts

@@ -1,10 +1,7 @@
 import PDFDocument from '../PDFDocument';
 import PDFPage from '../PDFPage';
 import PDFFont from '../PDFFont';
-import PDFField, {
-  FieldAppearanceOptions,
-  assertFieldAppearanceOptions,
-} from './PDFField';
+import PDFField, { FieldAppearanceOptions, assertFieldAppearanceOptions } from './PDFField';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
@@ -22,12 +19,7 @@ import {
   AcroChoiceFlags,
   PDFWidgetAnnotation,
 } from '../../core';
-import {
-  assertIs,
-  assertIsSubset,
-  assertOrUndefined,
-  assertPositive,
-} from '../../utils';
+import { assertIs, assertIsSubset, assertOrUndefined, assertPositive } from '../../utils';
 
 /**
  * Represents an option list field of a [[PDFForm]].
@@ -59,11 +51,7 @@ export default class PDFOptionList extends PDFField {
   /** The low-level PDFAcroListBox wrapped by this option list. */
   readonly acroField: PDFAcroListBox;
 
-  private constructor(
-    acroListBox: PDFAcroListBox,
-    ref: PDFRef,
-    doc: PDFDocument,
-  ) {
+  private constructor(acroListBox: PDFAcroListBox, ref: PDFRef, doc: PDFDocument) {
     super(acroListBox, ref, doc);
 
     assertIs(acroListBox, 'acroListBox', [[PDFAcroListBox, 'PDFAcroListBox']]);
@@ -498,8 +486,7 @@ export default class PDFOptionList extends PDFField {
     const widgets = this.acroField.getWidgets();
     for (let idx = 0, len = widgets.length; idx < len; idx++) {
       const widget = widgets[idx];
-      const hasAppearances =
-        widget.getAppearances()?.normal instanceof PDFStream;
+      const hasAppearances = widget.getAppearances()?.normal instanceof PDFStream;
       if (!hasAppearances) return true;
     }
 
@@ -537,10 +524,7 @@ export default class PDFOptionList extends PDFField {
    * @param provider Optionally, the appearance provider to be used for
    *                 generating the contents of the appearance streams.
    */
-  updateAppearances(
-    font: PDFFont,
-    provider?: AppearanceProviderFor<PDFOptionList>,
-  ) {
+  updateAppearances(font: PDFFont, provider?: AppearanceProviderFor<PDFOptionList>) {
     assertIs(font, 'font', [[PDFFont, 'PDFFont']]);
     assertOrUndefined(provider, 'provider', [Function]);
 

package/src/api/form/PDFRadioGroup.ts

@@ -1,9 +1,6 @@
 import PDFDocument from '../PDFDocument';
 import PDFPage from '../PDFPage';
-import PDFField, {
-  FieldAppearanceOptions,
-  assertFieldAppearanceOptions,
-} from './PDFField';
+import PDFField, { FieldAppearanceOptions, assertFieldAppearanceOptions } from './PDFField';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
@@ -54,25 +51,16 @@ export default class PDFRadioGroup extends PDFField {
    * @param ref The unique reference for this radio group.
    * @param doc The document to which this radio group will belong.
    */
-  static of = (
-    acroRadioButton: PDFAcroRadioButton,
-    ref: PDFRef,
-    doc: PDFDocument,
-  ) => new PDFRadioGroup(acroRadioButton, ref, doc);
+  static of = (acroRadioButton: PDFAcroRadioButton, ref: PDFRef, doc: PDFDocument) =>
+    new PDFRadioGroup(acroRadioButton, ref, doc);
 
   /** The low-level PDFAcroRadioButton wrapped by this radio group. */
   readonly acroField: PDFAcroRadioButton;
 
-  private constructor(
-    acroRadioButton: PDFAcroRadioButton,
-    ref: PDFRef,
-    doc: PDFDocument,
-  ) {
+  private constructor(acroRadioButton: PDFAcroRadioButton, ref: PDFRef, doc: PDFDocument) {
     super(acroRadioButton, ref, doc);
 
-    assertIs(acroRadioButton, 'acroRadioButton', [
-      [PDFAcroRadioButton, 'PDFAcroRadioButton'],
-    ]);
+    assertIs(acroRadioButton, 'acroRadioButton', [[PDFAcroRadioButton, 'PDFAcroRadioButton']]);
 
     this.acroField = acroRadioButton;
   }
@@ -349,11 +337,7 @@ export default class PDFRadioGroup extends PDFField {
    * @param page The page to which the radio button widget should be added.
    * @param options The options to be used when adding the radio button widget.
    */
-  addOptionToPage(
-    option: string,
-    page: PDFPage,
-    options?: FieldAppearanceOptions,
-  ) {
+  addOptionToPage(option: string, page: PDFPage, options?: FieldAppearanceOptions) {
     assertIs(option, 'option', ['string']);
     assertIs(page, 'page', [[PDFPage, 'PDFPage']]);
     assertFieldAppearanceOptions(options);

package/src/api/form/PDFSignature.ts

@@ -24,25 +24,16 @@ export default class PDFSignature extends PDFField {
    * @param ref The unique reference for this signature.
    * @param doc The document to which this signature will belong.
    */
-  static of = (
-    acroSignature: PDFAcroSignature,
-    ref: PDFRef,
-    doc: PDFDocument,
-  ) => new PDFSignature(acroSignature, ref, doc);
+  static of = (acroSignature: PDFAcroSignature, ref: PDFRef, doc: PDFDocument) =>
+    new PDFSignature(acroSignature, ref, doc);
 
   /** The low-level PDFAcroSignature wrapped by this signature. */
   readonly acroField: PDFAcroSignature;
 
-  private constructor(
-    acroSignature: PDFAcroSignature,
-    ref: PDFRef,
-    doc: PDFDocument,
-  ) {
+  private constructor(acroSignature: PDFAcroSignature, ref: PDFRef, doc: PDFDocument) {
     super(acroSignature, ref, doc);
 
-    assertIs(acroSignature, 'acroSignature', [
-      [PDFAcroSignature, 'PDFAcroSignature'],
-    ]);
+    assertIs(acroSignature, 'acroSignature', [[PDFAcroSignature, 'PDFAcroSignature']]);
 
     this.acroField = acroSignature;
   }

package/src/api/form/PDFTextField.ts

@@ -2,10 +2,7 @@ import PDFDocument from '../PDFDocument';
 import PDFPage from '../PDFPage';
 import PDFFont from '../PDFFont';
 import PDFImage from '../PDFImage';
-import PDFField, {
-  FieldAppearanceOptions,
-  assertFieldAppearanceOptions,
-} from './PDFField';
+import PDFField, { FieldAppearanceOptions, assertFieldAppearanceOptions } from './PDFField';
 import {
   AppearanceProviderFor,
   normalizeAppearance,
@@ -13,11 +10,7 @@ import {
 } from './appearances';
 import { rgb } from '../colors';
 import { degrees } from '../rotations';
-import {
-  RichTextFieldReadError,
-  ExceededMaxLengthError,
-  InvalidMaxLengthError,
-} from '../errors';
+import { RichTextFieldReadError, ExceededMaxLengthError, InvalidMaxLengthError } from '../errors';
 import { ImageAlignment } from '../image/alignment';
 import { TextAlignment } from '../text/alignment';
 
@@ -305,11 +298,7 @@ export default class PDFTextField extends PDFField {
     const widgets = this.acroField.getWidgets();
     for (let idx = 0, len = widgets.length; idx < len; idx++) {
       const widget = widgets[idx];
-      const streamRef = this.createImageAppearanceStream(
-        widget,
-        image,
-        alignment,
-      );
+      const streamRef = this.createImageAppearanceStream(widget, image, alignment);
       this.updateWidgetAppearances(widget, { normal: streamRef });
     }
 
@@ -760,8 +749,7 @@ export default class PDFTextField extends PDFField {
     const widgets = this.acroField.getWidgets();
     for (let idx = 0, len = widgets.length; idx < len; idx++) {
       const widget = widgets[idx];
-      const hasAppearances =
-        widget.getAppearances()?.normal instanceof PDFStream;
+      const hasAppearances = widget.getAppearances()?.normal instanceof PDFStream;
       if (!hasAppearances) return true;
     }
 
@@ -799,10 +787,7 @@ export default class PDFTextField extends PDFField {
    * @param provider Optionally, the appearance provider to be used for
    *                 generating the contents of the appearance streams.
    */
-  updateAppearances(
-    font: PDFFont,
-    provider?: AppearanceProviderFor<PDFTextField>,
-  ) {
+  updateAppearances(font: PDFFont, provider?: AppearanceProviderFor<PDFTextField>) {
     assertIs(font, 'font', [[PDFFont, 'PDFFont']]);
     assertOrUndefined(provider, 'provider', [Function]);
 

package/src/api/form/appearances.ts

@@ -16,14 +16,7 @@ import {
   drawTextField,
   drawOptionList,
 } from '../operations';
-import {
-  rgb,
-  componentsToColor,
-  setFillingColor,
-  grayscale,
-  cmyk,
-  Color,
-} from '../colors';
+import { rgb, componentsToColor, setFillingColor, grayscale, cmyk, Color } from '../colors';
 import { reduceRotation, adjustDimsForRotation } from '../rotations';
 import {
   layoutMultilineText,
@@ -114,9 +107,7 @@ export const normalizeAppearance = <T extends Object>(
 //   `/HeBo 8.00 Tf` -> ['/HeBo 8 Tf', 'HeBo', '8.00']
 const tfRegex = /\/([^\s]+)\s+(\d+(?:\.\d+)?)\s+Tf/;
 
-const getDefaultFontSize = (field: {
-  getDefaultAppearance(): string | undefined;
-}) => {
+const getDefaultFontSize = (field: { getDefaultAppearance(): string | undefined }) => {
   const da = field.getDefaultAppearance() ?? '';
   const daMatch = findLastMatch(da, tfRegex).match ?? [];
   const defaultFontSize = Number(daMatch[2]);
@@ -127,11 +118,10 @@ 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+)?)\s*(\d+(?:\.\d+)?)?\s*(\d+(?:\.\d+)?)?\s*(\d+(?:\.\d+)?)?\s+(g|rg|k)/;
+const colorRegex =
+  /(\d+(?:\.\d+)?)\s*(\d+(?:\.\d+)?)?\s*(\d+(?:\.\d+)?)?\s*(\d+(?:\.\d+)?)?\s+(g|rg|k)/;
 
-const getDefaultColor = (field: {
-  getDefaultAppearance(): string | undefined;
-}) => {
+const getDefaultColor = (field: { getDefaultAppearance(): string | undefined }) => {
   const da = field.getDefaultAppearance() ?? '';
   const daMatch = findLastMatch(da, colorRegex).match;
 
@@ -163,9 +153,10 @@ 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);
@@ -244,9 +235,10 @@ export const defaultCheckBoxAppearanceProvider: AppearanceProviderFor<
   };
 };
 
-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);
@@ -324,9 +316,11 @@ export const defaultRadioGroupAppearanceProvider: AppearanceProviderFor<
   };
 };
 
-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);
@@ -412,9 +406,11 @@ export const defaultButtonAppearanceProvider: AppearanceProviderFor<
   };
 };
 
-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);
@@ -502,9 +498,11 @@ export const defaultTextFieldAppearanceProvider: AppearanceProviderFor<
   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);
@@ -567,9 +565,11 @@ export const defaultDropdownAppearanceProvider: AppearanceProviderFor<
   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/operations.ts

@@ -39,7 +39,7 @@ 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'
+import type { Space, TransformationMatrix } from '../types';
 
 export interface DrawTextOptions {
   color: Color;
@@ -55,27 +55,18 @@ export interface DrawTextOptions {
   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,
-): PDFOperator[] =>
+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): PDFOperator[] =>
   [
     pushGraphicsState(),
     options.graphicsState && setGraphicsState(options.graphicsState),
@@ -228,7 +219,7 @@ export const drawRectangle = (options: {
   radius?: number | PDFNumber;
 }) => {
   let ops = [];
-  
+
   if (!options.radius || asNumber(options.radius) <= 0) {
     ops = [
       moveTo(0, 0),
@@ -252,7 +243,14 @@ export const drawRectangle = (options: {
       lineTo(width - radius, 0),
       appendBezierCurve(width - radius + offset, 0, width, radius - offset, width, radius),
       lineTo(width, height - radius),
-      appendBezierCurve(width, height - radius + offset, width - radius + offset, height, width - radius, height),
+      appendBezierCurve(
+        width,
+        height - radius + offset,
+        width - radius + offset,
+        height,
+        width - radius,
+        height,
+      ),
       lineTo(radius, height),
       appendBezierCurve(radius - offset, height, 0, height - radius + offset, 0, height - radius),
       closePath(),
@@ -283,7 +281,7 @@ export const drawRectangle = (options: {
 
     popGraphicsState(),
   ].filter(Boolean) as PDFOperator[];
-}
+};
 
 const KAPPA = 4.0 * ((Math.sqrt(2) - 1.0) / 3.0);
 

package/src/api/operators.ts

@@ -1,12 +1,6 @@
 import { asNumber, asPDFName, asPDFNumber } from './objects';
 import { degreesToRadians } from './rotations';
-import {
-  PDFHexString,
-  PDFName,
-  PDFNumber,
-  PDFOperator,
-  PDFOperatorNames as Ops,
-} from '../core';
+import { PDFHexString, PDFName, PDFNumber, PDFOperator, PDFOperatorNames as Ops } from '../core';
 
 /* ==================== Clipping Path Operators ==================== */
 
@@ -53,32 +47,13 @@ export const rotateRadians = (angle: number | PDFNumber) =>
 export const rotateDegrees = (angle: number | PDFNumber) =>
   rotateRadians(degreesToRadians(asNumber(angle)));
 
-export const skewRadians = (
-  xSkewAngle: number | PDFNumber,
-  ySkewAngle: number | PDFNumber,
-) =>
-  concatTransformationMatrix(
-    1,
-    tan(asNumber(xSkewAngle)),
-    tan(asNumber(ySkewAngle)),
-    1,
-    0,
-    0,
-  );
+export const skewRadians = (xSkewAngle: number | PDFNumber, ySkewAngle: number | PDFNumber) =>
+  concatTransformationMatrix(1, tan(asNumber(xSkewAngle)), tan(asNumber(ySkewAngle)), 1, 0, 0);
 
-export const skewDegrees = (
-  xSkewAngle: number | PDFNumber,
-  ySkewAngle: number | PDFNumber,
-) =>
-  skewRadians(
-    degreesToRadians(asNumber(xSkewAngle)),
-    degreesToRadians(asNumber(ySkewAngle)),
-  );
+export const skewDegrees = (xSkewAngle: number | PDFNumber, ySkewAngle: number | PDFNumber) =>
+  skewRadians(degreesToRadians(asNumber(xSkewAngle)), degreesToRadians(asNumber(ySkewAngle)));
 
-export const setDashPattern = (
-  dashArray: (number | PDFNumber)[],
-  dashPhase: number | PDFNumber,
-) =>
+export const setDashPattern = (dashArray: (number | PDFNumber)[], dashPhase: number | PDFNumber) =>
   PDFOperator.of(Ops.SetLineDashPattern, [
     `[${dashArray.map(asPDFNumber).join(' ')}]`,
     asPDFNumber(dashPhase),
@@ -187,7 +162,7 @@ export const stroke = () => PDFOperator.of(Ops.StrokePath);
 
 export enum FillRule {
   NonZero = 'f',
-  EvenOdd = 'f*'
+  EvenOdd = 'f*',
 }
 
 export const fill = () => PDFOperator.of(Ops.FillNonZero);
@@ -207,18 +182,15 @@ export const moveText = (x: number | PDFNumber, y: number | PDFNumber) =>
 
 /* ==================== Text Showing Operators ==================== */
 
-export const showText = (text: PDFHexString) =>
-  PDFOperator.of(Ops.ShowText, [text]);
+export const showText = (text: PDFHexString) => PDFOperator.of(Ops.ShowText, [text]);
 
 /* ==================== Text State Operators ==================== */
 
 export const beginText = () => PDFOperator.of(Ops.BeginText);
 export const endText = () => PDFOperator.of(Ops.EndText);
 
-export const setFontAndSize = (
-  name: string | PDFName,
-  size: number | PDFNumber,
-) => PDFOperator.of(Ops.SetFontAndSize, [asPDFName(name), asPDFNumber(size)]);
+export const setFontAndSize = (name: string | PDFName, size: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetFontAndSize, [asPDFName(name), asPDFNumber(size)]);
 
 export const setCharacterSpacing = (spacing: number | PDFNumber) =>
   PDFOperator.of(Ops.SetCharacterSpacing, [asPDFNumber(spacing)]);
@@ -327,11 +299,7 @@ export const setStrokingRgbColor = (
   green: number | PDFNumber,
   blue: number | PDFNumber,
 ) =>
-  PDFOperator.of(Ops.StrokingColorRgb, [
-    asPDFNumber(red),
-    asPDFNumber(green),
-    asPDFNumber(blue),
-  ]);
+  PDFOperator.of(Ops.StrokingColorRgb, [asPDFNumber(red), asPDFNumber(green), asPDFNumber(blue)]);
 
 export const setFillingCmykColor = (
   cyan: number | PDFNumber,

package/src/api/rotations.ts

@@ -53,10 +53,7 @@ export const reduceRotation = (degreeAngle = 0) => {
   return 0; // `degreeAngle` is not a multiple of 90
 };
 
-export const adjustDimsForRotation = (
-  dims: { width: number; height: number },
-  degreeAngle = 0,
-) => {
+export const adjustDimsForRotation = (dims: { width: number; height: number }, degreeAngle = 0) => {
   const rotation = reduceRotation(degreeAngle);
   return rotation === 90 || rotation === 270
     ? { width: dims.height, height: dims.width }