@pdfme/pdf-lib 0.0.0

package/src/api/operators.ts

@@ -0,0 +1,335 @@
+import { asNumber, asPDFName, asPDFNumber } from './objects';
+import { degreesToRadians } from './rotations';
+import { PDFHexString, PDFName, PDFNumber, PDFOperator, PDFOperatorNames as Ops } from '../core';
+
+/* ==================== Clipping Path Operators ==================== */
+
+export const clip = () => PDFOperator.of(Ops.ClipNonZero);
+export const clipEvenOdd = () => PDFOperator.of(Ops.ClipEvenOdd);
+
+/* ==================== Graphics State Operators ==================== */
+
+const { cos, sin, tan } = Math;
+
+export const concatTransformationMatrix = (
+  a: number | PDFNumber,
+  b: number | PDFNumber,
+  c: number | PDFNumber,
+  d: number | PDFNumber,
+  e: number | PDFNumber,
+  f: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.ConcatTransformationMatrix, [
+    asPDFNumber(a),
+    asPDFNumber(b),
+    asPDFNumber(c),
+    asPDFNumber(d),
+    asPDFNumber(e),
+    asPDFNumber(f),
+  ]);
+
+export const translate = (xPos: number | PDFNumber, yPos: number | PDFNumber) =>
+  concatTransformationMatrix(1, 0, 0, 1, xPos, yPos);
+
+export const scale = (xPos: number | PDFNumber, yPos: number | PDFNumber) =>
+  concatTransformationMatrix(xPos, 0, 0, yPos, 0, 0);
+
+export const rotateRadians = (angle: number | PDFNumber) =>
+  concatTransformationMatrix(
+    cos(asNumber(angle)),
+    sin(asNumber(angle)),
+    -sin(asNumber(angle)),
+    cos(asNumber(angle)),
+    0,
+    0,
+  );
+
+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 skewDegrees = (xSkewAngle: number | PDFNumber, ySkewAngle: number | PDFNumber) =>
+  skewRadians(degreesToRadians(asNumber(xSkewAngle)), degreesToRadians(asNumber(ySkewAngle)));
+
+export const setDashPattern = (dashArray: (number | PDFNumber)[], dashPhase: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetLineDashPattern, [
+    `[${dashArray.map(asPDFNumber).join(' ')}]`,
+    asPDFNumber(dashPhase),
+  ]);
+
+export const restoreDashPattern = () => setDashPattern([], 0);
+
+export enum LineCapStyle {
+  Butt = 0,
+  Round = 1,
+  Projecting = 2,
+}
+
+export const setLineCap = (style: LineCapStyle) =>
+  PDFOperator.of(Ops.SetLineCapStyle, [asPDFNumber(style)]);
+
+export enum LineJoinStyle {
+  Miter = 0,
+  Round = 1,
+  Bevel = 2,
+}
+
+export const setLineJoin = (style: LineJoinStyle) =>
+  PDFOperator.of(Ops.SetLineJoinStyle, [asPDFNumber(style)]);
+
+export const setGraphicsState = (state: string | PDFName) =>
+  PDFOperator.of(Ops.SetGraphicsStateParams, [asPDFName(state)]);
+
+export const pushGraphicsState = () => PDFOperator.of(Ops.PushGraphicsState);
+
+export const popGraphicsState = () => PDFOperator.of(Ops.PopGraphicsState);
+
+export const setLineWidth = (width: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetLineWidth, [asPDFNumber(width)]);
+
+/* ==================== Path Construction Operators ==================== */
+
+export const appendBezierCurve = (
+  x1: number | PDFNumber,
+  y1: number | PDFNumber,
+  x2: number | PDFNumber,
+  y2: number | PDFNumber,
+  x3: number | PDFNumber,
+  y3: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.AppendBezierCurve, [
+    asPDFNumber(x1),
+    asPDFNumber(y1),
+    asPDFNumber(x2),
+    asPDFNumber(y2),
+    asPDFNumber(x3),
+    asPDFNumber(y3),
+  ]);
+
+export const appendQuadraticCurve = (
+  x1: number | PDFNumber,
+  y1: number | PDFNumber,
+  x2: number | PDFNumber,
+  y2: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.CurveToReplicateInitialPoint, [
+    asPDFNumber(x1),
+    asPDFNumber(y1),
+    asPDFNumber(x2),
+    asPDFNumber(y2),
+  ]);
+
+export const closePath = () => PDFOperator.of(Ops.ClosePath);
+
+export const moveTo = (xPos: number | PDFNumber, yPos: number | PDFNumber) =>
+  PDFOperator.of(Ops.MoveTo, [asPDFNumber(xPos), asPDFNumber(yPos)]);
+
+export const lineTo = (xPos: number | PDFNumber, yPos: number | PDFNumber) =>
+  PDFOperator.of(Ops.LineTo, [asPDFNumber(xPos), asPDFNumber(yPos)]);
+
+/**
+ * @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 const rectangle = (
+  xPos: number | PDFNumber,
+  yPos: number | PDFNumber,
+  width: number | PDFNumber,
+  height: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.AppendRectangle, [
+    asPDFNumber(xPos),
+    asPDFNumber(yPos),
+    asPDFNumber(width),
+    asPDFNumber(height),
+  ]);
+
+/**
+ * @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 const square = (xPos: number, yPos: number, size: number) =>
+  rectangle(xPos, yPos, size, size);
+
+/* ==================== Path Painting Operators ==================== */
+
+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);
+
+/* ==================== Text Positioning Operators ==================== */
+
+export const nextLine = () => PDFOperator.of(Ops.NextLine);
+
+export const moveText = (x: number | PDFNumber, y: number | PDFNumber) =>
+  PDFOperator.of(Ops.MoveText, [asPDFNumber(x), asPDFNumber(y)]);
+
+/* ==================== Text Showing Operators ==================== */
+
+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 setCharacterSpacing = (spacing: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetCharacterSpacing, [asPDFNumber(spacing)]);
+
+export const setWordSpacing = (spacing: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetWordSpacing, [asPDFNumber(spacing)]);
+
+/** @param squeeze horizontal character spacing */
+export const setCharacterSqueeze = (squeeze: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetTextHorizontalScaling, [asPDFNumber(squeeze)]);
+
+export const setLineHeight = (lineHeight: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetTextLineHeight, [asPDFNumber(lineHeight)]);
+
+export const setTextRise = (rise: number | PDFNumber) =>
+  PDFOperator.of(Ops.SetTextRise, [asPDFNumber(rise)]);
+
+export enum TextRenderingMode {
+  Fill = 0,
+  Outline = 1,
+  FillAndOutline = 2,
+  Invisible = 3,
+  FillAndClip = 4,
+  OutlineAndClip = 5,
+  FillAndOutlineAndClip = 6,
+  Clip = 7,
+}
+
+export const setTextRenderingMode = (mode: TextRenderingMode) =>
+  PDFOperator.of(Ops.SetTextRenderingMode, [asPDFNumber(mode)]);
+
+export const setTextMatrix = (
+  a: number | PDFNumber,
+  b: number | PDFNumber,
+  c: number | PDFNumber,
+  d: number | PDFNumber,
+  e: number | PDFNumber,
+  f: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.SetTextMatrix, [
+    asPDFNumber(a),
+    asPDFNumber(b),
+    asPDFNumber(c),
+    asPDFNumber(d),
+    asPDFNumber(e),
+    asPDFNumber(f),
+  ]);
+
+export const rotateAndSkewTextRadiansAndTranslate = (
+  rotationAngle: number | PDFNumber,
+  xSkewAngle: number | PDFNumber,
+  ySkewAngle: number | PDFNumber,
+  x: number | PDFNumber,
+  y: number | PDFNumber,
+) =>
+  setTextMatrix(
+    cos(asNumber(rotationAngle)),
+    sin(asNumber(rotationAngle)) + tan(asNumber(xSkewAngle)),
+    -sin(asNumber(rotationAngle)) + tan(asNumber(ySkewAngle)),
+    cos(asNumber(rotationAngle)),
+    x,
+    y,
+  );
+
+export const rotateAndSkewTextDegreesAndTranslate = (
+  rotationAngle: number | PDFNumber,
+  xSkewAngle: number | PDFNumber,
+  ySkewAngle: number | PDFNumber,
+  x: number | PDFNumber,
+  y: number | PDFNumber,
+) =>
+  rotateAndSkewTextRadiansAndTranslate(
+    degreesToRadians(asNumber(rotationAngle)),
+    degreesToRadians(asNumber(xSkewAngle)),
+    degreesToRadians(asNumber(ySkewAngle)),
+    x,
+    y,
+  );
+
+/* ==================== XObject Operator ==================== */
+
+export const drawObject = (name: string | PDFName) =>
+  PDFOperator.of(Ops.DrawObject, [asPDFName(name)]);
+
+/* ==================== Color Operators ==================== */
+
+export const setFillingGrayscaleColor = (gray: number | PDFNumber) =>
+  PDFOperator.of(Ops.NonStrokingColorGray, [asPDFNumber(gray)]);
+
+export const setStrokingGrayscaleColor = (gray: number | PDFNumber) =>
+  PDFOperator.of(Ops.StrokingColorGray, [asPDFNumber(gray)]);
+
+export const setFillingRgbColor = (
+  red: number | PDFNumber,
+  green: number | PDFNumber,
+  blue: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.NonStrokingColorRgb, [
+    asPDFNumber(red),
+    asPDFNumber(green),
+    asPDFNumber(blue),
+  ]);
+
+export const setStrokingRgbColor = (
+  red: number | PDFNumber,
+  green: number | PDFNumber,
+  blue: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.StrokingColorRgb, [asPDFNumber(red), asPDFNumber(green), asPDFNumber(blue)]);
+
+export const setFillingCmykColor = (
+  cyan: number | PDFNumber,
+  magenta: number | PDFNumber,
+  yellow: number | PDFNumber,
+  key: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.NonStrokingColorCmyk, [
+    asPDFNumber(cyan),
+    asPDFNumber(magenta),
+    asPDFNumber(yellow),
+    asPDFNumber(key),
+  ]);
+
+export const setStrokingCmykColor = (
+  cyan: number | PDFNumber,
+  magenta: number | PDFNumber,
+  yellow: number | PDFNumber,
+  key: number | PDFNumber,
+) =>
+  PDFOperator.of(Ops.StrokingColorCmyk, [
+    asPDFNumber(cyan),
+    asPDFNumber(magenta),
+    asPDFNumber(yellow),
+    asPDFNumber(key),
+  ]);
+
+/* ==================== Marked Content Operators ==================== */
+
+export const beginMarkedContent = (tag: string | PDFName) =>
+  PDFOperator.of(Ops.BeginMarkedContent, [asPDFName(tag)]);
+
+export const endMarkedContent = () => PDFOperator.of(Ops.EndMarkedContent);

package/src/api/rotations.ts

@@ -0,0 +1,84 @@
+import { assertIs, error } from '../utils';
+
+export 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 const radians = (radianAngle: number): Radians => {
+  assertIs(radianAngle, 'radianAngle', ['number']);
+  return { type: RotationTypes.Radians, angle: radianAngle };
+};
+
+export const degrees = (degreeAngle: number): Degrees => {
+  assertIs(degreeAngle, 'degreeAngle', ['number']);
+  return { type: RotationTypes.Degrees, angle: degreeAngle };
+};
+
+const { Radians, Degrees } = RotationTypes;
+
+export const degreesToRadians = (degree: number) => (degree * Math.PI) / 180;
+export const radiansToDegrees = (radian: number) => (radian * 180) / Math.PI;
+
+// prettier-ignore
+export const toRadians = (rotation: Rotation) => 
+    rotation.type === Radians ? rotation.angle
+  : rotation.type === Degrees ? degreesToRadians(rotation.angle)
+  : error(`Invalid rotation: ${JSON.stringify(rotation)}`);
+
+// prettier-ignore
+export const toDegrees = (rotation: Rotation) => 
+    rotation.type === Radians ? radiansToDegrees(rotation.angle)
+  : rotation.type === Degrees ? rotation.angle
+  : error(`Invalid rotation: ${JSON.stringify(rotation)}`);
+
+export const reduceRotation = (degreeAngle = 0) => {
+  const quadrants = (degreeAngle / 90) % 4;
+  if (quadrants === 0) return 0;
+  if (quadrants === 1) return 90;
+  if (quadrants === 2) return 180;
+  if (quadrants === 3) return 270;
+  return 0; // `degreeAngle` is not a multiple of 90
+};
+
+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 }
+    : { width: dims.width, height: dims.height };
+};
+
+export const rotateRectangle = (
+  rectangle: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+  },
+  borderWidth = 0,
+  degreeAngle = 0,
+) => {
+  const { x, y, width: w, height: h } = rectangle;
+
+  const r = reduceRotation(degreeAngle);
+  const b = borderWidth / 2;
+
+  // prettier-ignore
+  if (r === 0) return { x: x - b, y: y - b, width: w, height: h };
+  else if (r === 90) return { x: x - h + b, y: y - b, width: h, height: w };
+  else if (r === 180) return { x: x - w + b, y: y - h + b, width: w, height: h };
+  else if (r === 270) return { x: x - b, y: y - w + b, width: h, height: w };
+  else return { x: x - b, y: y - b, width: w, height: h };
+};

package/src/api/sizes.ts

@@ -0,0 +1,52 @@
+export const PageSizes = {
+  '4A0': [4767.87, 6740.79] as [number, number],
+  '2A0': [3370.39, 4767.87] as [number, number],
+  A0: [2383.94, 3370.39] as [number, number],
+  A1: [1683.78, 2383.94] as [number, number],
+  A2: [1190.55, 1683.78] as [number, number],
+  A3: [841.89, 1190.55] as [number, number],
+  A4: [595.28, 841.89] as [number, number],
+  A5: [419.53, 595.28] as [number, number],
+  A6: [297.64, 419.53] as [number, number],
+  A7: [209.76, 297.64] as [number, number],
+  A8: [147.4, 209.76] as [number, number],
+  A9: [104.88, 147.4] as [number, number],
+  A10: [73.7, 104.88] as [number, number],
+  B0: [2834.65, 4008.19] as [number, number],
+  B1: [2004.09, 2834.65] as [number, number],
+  B2: [1417.32, 2004.09] as [number, number],
+  B3: [1000.63, 1417.32] as [number, number],
+  B4: [708.66, 1000.63] as [number, number],
+  B5: [498.9, 708.66] as [number, number],
+  B6: [354.33, 498.9] as [number, number],
+  B7: [249.45, 354.33] as [number, number],
+  B8: [175.75, 249.45] as [number, number],
+  B9: [124.72, 175.75] as [number, number],
+  B10: [87.87, 124.72] as [number, number],
+  C0: [2599.37, 3676.54] as [number, number],
+  C1: [1836.85, 2599.37] as [number, number],
+  C2: [1298.27, 1836.85] as [number, number],
+  C3: [918.43, 1298.27] as [number, number],
+  C4: [649.13, 918.43] as [number, number],
+  C5: [459.21, 649.13] as [number, number],
+  C6: [323.15, 459.21] as [number, number],
+  C7: [229.61, 323.15] as [number, number],
+  C8: [161.57, 229.61] as [number, number],
+  C9: [113.39, 161.57] as [number, number],
+  C10: [79.37, 113.39] as [number, number],
+  RA0: [2437.8, 3458.27] as [number, number],
+  RA1: [1729.13, 2437.8] as [number, number],
+  RA2: [1218.9, 1729.13] as [number, number],
+  RA3: [864.57, 1218.9] as [number, number],
+  RA4: [609.45, 864.57] as [number, number],
+  SRA0: [2551.18, 3628.35] as [number, number],
+  SRA1: [1814.17, 2551.18] as [number, number],
+  SRA2: [1275.59, 1814.17] as [number, number],
+  SRA3: [907.09, 1275.59] as [number, number],
+  SRA4: [637.8, 907.09] as [number, number],
+  Executive: [521.86, 756.0] as [number, number],
+  Folio: [612.0, 936.0] as [number, number],
+  Legal: [612.0, 1008.0] as [number, number],
+  Letter: [612.0, 792.0] as [number, number],
+  Tabloid: [792.0, 1224.0] as [number, number],
+};