@pdfme/generator 2.0.1 → 2.1.0

package/src/helper.ts

@@ -32,7 +32,11 @@ import {
   DEFAULT_FONT_COLOR,
   calculateDynamicFontSize,
   heightOfFontAtSize,
-  getFontKitFont
+  getFontKitFont,
+  getSplittedLines,
+  mm2pt,
+  widthOfTextAtSize,
+  FontWidthCalcValues,
 } from '@pdfme/common';
 import { Buffer } from 'buffer';
 
@@ -130,14 +134,7 @@ export const getEmbeddedPagesAndEmbedPdfBoxes = async (arg: {
   return { embeddedPages, embedPdfBoxes };
 };
 
-const mm2pt = (mm: number): number => {
-  // https://www.ddc.co.jp/words/archives/20090701114500.html
-  const ptRatio = 2.8346;
-
-  return parseFloat(String(mm)) * ptRatio;
-};
-
-const getSchemaSizeAndRotate = (schema: Schema) => {
+const convertSchemaDimensionsToPt = (schema: Schema) => {
   const width = mm2pt(schema.width);
   const height = mm2pt(schema.height);
   const rotate = degrees(schema.rotate ? schema.rotate : 0);
@@ -200,7 +197,7 @@ const drawBackgroundColor = (arg: {
 }) => {
   const { templateSchema, page, pageHeight } = arg;
   if (!templateSchema.backgroundColor) return;
-  const { width, height } = getSchemaSizeAndRotate(templateSchema);
+  const { width, height } = convertSchemaDimensionsToPt(templateSchema);
   const color = hex2RgbColor(templateSchema.backgroundColor);
   page.drawRectangle({
     x: calcX(templateSchema.position.x, 'left', width, width),
@@ -211,57 +208,6 @@ const drawBackgroundColor = (arg: {
   });
 };
 
-type IsOverEval = (testString: string) => boolean;
-
-/**
- * Incrementally checks the current line for its real length
- * and returns the position where it exceeds the box width.
- * Returns `null` to indicate if inputLine is shorter as the available bbox.
- */
-const getOverPosition = (inputLine: string, isOverEval: IsOverEval) => {
-  for (let i = 0; i <= inputLine.length; i++) {
-    if (isOverEval(inputLine.slice(0, i))) {
-      return i;
-    }
-  }
-
-  return null;
-};
-
-/**
- * Gets the position of the split. Splits the exceeding line at
- * the last whitespace over it exceeds the bounding box width.
- */
-const getSplitPosition = (inputLine: string, isOverEval: IsOverEval) => {
-  const overPos = getOverPosition(inputLine, isOverEval);
-  if (overPos === null) return inputLine.length;  // input line is shorter than the available space
-
-  let overPosTmp = overPos;
-  while (inputLine[overPosTmp] !== ' ' && overPosTmp >= 0) {
-    overPosTmp--;
-  }
-
-  // For very long lines with no whitespace use the original overPos
-  return overPosTmp > 0 ? overPosTmp : overPos - 1;
-};
-
-/**
- * Recursively splits the line at getSplitPosition.
- * If there is some leftover, split the rest again in the same manner.
- */
-const getSplittedLines = (inputLine: string, isOverEval: IsOverEval): string[] => {
-  const splitPos = getSplitPosition(inputLine, isOverEval);
-  const splittedLine = inputLine.substring(0, splitPos);
-  const rest = inputLine.substring(splitPos).trimStart();
-
-  if (rest.length === 0) {
-    // end recursion if there is no rest
-    return [splittedLine];
-  }
-
-  return [splittedLine, ...getSplittedLines(rest, isOverEval)];
-};
-
 interface FontSetting {
   font: Font;
   pdfFontObj: {
@@ -275,18 +221,18 @@ const drawInputByTextSchema = async (arg: {
   templateSchema: TextSchema;
   pdfDoc: PDFDocument;
   page: PDFPage;
-  pageHeight: number;
   fontSetting: FontSetting;
 }) => {
-  const { input, templateSchema, page, pageHeight, fontSetting } = arg;
+  const { input, templateSchema, page, fontSetting } = arg;
   const { font, pdfFontObj, fallbackFontName } = fontSetting;
 
   const pdfFontValue = pdfFontObj[templateSchema.fontName ? templateSchema.fontName : fallbackFontName];
-  const fontKitFont = await getFontKitFont(templateSchema, font)
+  const fontKitFont = await getFontKitFont(templateSchema, font);
 
+  const pageHeight = page.getHeight();
   drawBackgroundColor({ templateSchema, page, pageHeight });
 
-  const { width, height, rotate } = getSchemaSizeAndRotate(templateSchema);
+  const { width, height, rotate } = convertSchemaDimensionsToPt(templateSchema);
   const { size, color, alignment, lineHeight, characterSpacing } = await getFontProp({
     input,
     font,
@@ -297,16 +243,18 @@ const drawInputByTextSchema = async (arg: {
 
   let beforeLineOver = 0;
 
-  const isOverEval = (testString: string) => {
-    const testStringWidth =
-      pdfFontValue.widthOfTextAtSize(testString, size) + (testString.length - 1) * characterSpacing;
-    return width <= testStringWidth;
+  const fontWidthCalcValues: FontWidthCalcValues = {
+    font: fontKitFont,
+    fontSize: size,
+    characterSpacing,
+    boxWidthInPt: width,
   };
+
   input.split(/\r|\n|\r\n/g).forEach((inputLine, inputLineIndex) => {
-    const splitLines = getSplittedLines(inputLine, isOverEval);
+    const splitLines = getSplittedLines(inputLine, fontWidthCalcValues);
 
     const drawLine = (line: string, lineIndex: number) => {
-      const textWidth = pdfFontValue.widthOfTextAtSize(line, size) + (line.length - 1) * characterSpacing;
+      const textWidth = widthOfTextAtSize(line, fontKitFont, size, characterSpacing);
       const textHeight = heightOfFontAtSize(fontKitFont, size);
 
       page.drawText(line, {
@@ -337,17 +285,16 @@ const getCacheKey = (templateSchema: Schema, input: string) => `${templateSchema
 const drawInputByImageSchema = async (arg: {
   input: string;
   templateSchema: ImageSchema;
-  pageHeight: number;
   pdfDoc: PDFDocument;
   page: PDFPage;
   inputImageCache: InputImageCache;
 }) => {
-  const { input, templateSchema, pageHeight, pdfDoc, page, inputImageCache } = arg;
+  const { input, templateSchema, pdfDoc, page, inputImageCache } = arg;
 
-  const { width, height, rotate } = getSchemaSizeAndRotate(templateSchema);
+  const { width, height, rotate } = convertSchemaDimensionsToPt(templateSchema);
   const opt = {
     x: calcX(templateSchema.position.x, 'left', width, width),
-    y: calcY(templateSchema.position.y, pageHeight, height),
+    y: calcY(templateSchema.position.y, page.getHeight(), height),
     rotate,
     width,
     height,
@@ -365,18 +312,17 @@ const drawInputByImageSchema = async (arg: {
 const drawInputByBarcodeSchema = async (arg: {
   input: string;
   templateSchema: BarcodeSchema;
-  pageHeight: number;
   pdfDoc: PDFDocument;
   page: PDFPage;
   inputImageCache: InputImageCache;
 }) => {
-  const { input, templateSchema, pageHeight, pdfDoc, page, inputImageCache } = arg;
+  const { input, templateSchema, pdfDoc, page, inputImageCache } = arg;
   if (!validateBarcodeInput(templateSchema.type as BarCodeType, input)) return;
 
-  const { width, height, rotate } = getSchemaSizeAndRotate(templateSchema);
+  const { width, height, rotate } = convertSchemaDimensionsToPt(templateSchema);
   const opt = {
     x: calcX(templateSchema.position.x, 'left', width, width),
-    y: calcY(templateSchema.position.y, pageHeight, height),
+    y: calcY(templateSchema.position.y, page.getHeight(), height),
     rotate,
     width,
     height,
@@ -398,7 +344,6 @@ export const drawInputByTemplateSchema = async (arg: {
   templateSchema: Schema;
   pdfDoc: PDFDocument;
   page: PDFPage;
-  pageHeight: number;
   fontSetting: FontSetting;
   inputImageCache: InputImageCache;
 }) => {