@muhammara/native-core 7.0.0-rc.2 → 7.1.0

package/lib/recipe/page.js

@@ -1,4 +1,3 @@
-const muhammara = require("../muhammara");
 const { PAGE_CONTEXT_STATE } = require("./utils");
 const { PageLayout, Colorspace } = require("../recipe-constants");
 const {
@@ -541,11 +540,17 @@ function writePageLabels(writer, copyingContext, pageLabels) {
  * @param {number} [margins.bottom] - Bottom margin.
  * @returns {Recipe} The recipe instance.
  * @throws {Error} If pages were deleted with deletePage() on this Recipe.
+ * @throws {Error} If another page is still active; call endPage() first.
  */
 exports.createPage = function createPage(pageWidth, pageHeight, margins) {
   if (this.deletedPages?.size) {
     throw new Error("createPage cannot be combined with deletePage");
   }
+  // Opening a second page over an active one leaves the first page
+  // unfinished: the writer then crashes or silently drops it at endPDF().
+  if (this.page) {
+    throw new Error("Finish the current page before creating another page");
+  }
   if (!pageWidth && !pageHeight) {
     [pageWidth, pageHeight] = this.default.pageSize;
   } else if (
@@ -605,17 +610,45 @@ exports.createPage = function createPage(pageWidth, pageHeight, margins) {
   }
 
   this.moveTo(0, 0);
+  resetTextBox(this, 0, 0);
   return this;
 };
 
-// setPageBox() also accepts the PageBox names.
-const PAGE_BOX_CONSTANTS = {
-  [muhammara.PageBox.MEDIA]: muhammara.ePDFPageBoxMediaBox,
-  [muhammara.PageBox.CROP]: muhammara.ePDFPageBoxCropBox,
-  [muhammara.PageBox.BLEED]: muhammara.ePDFPageBoxBleedBox,
-  [muhammara.PageBox.TRIM]: muhammara.ePDFPageBoxTrimBox,
-  [muhammara.PageBox.ART]: muhammara.ePDFPageBoxArtBox,
-};
+/**
+ * Forget the previous page's text box, so text() without coordinates starts
+ * at the margins of the new active page instead of the last text position,
+ * and movedown() starts from the given cursor.
+ * @private
+ * @param {Recipe} recipe - The recipe instance.
+ * @param {number} x - The text cursor x on the new active page.
+ * @param {number} y - The text cursor y on the new active page.
+ * @returns {void}
+ */
+function resetTextBox(recipe, x, y) {
+  recipe.x = x;
+  recipe.y = y;
+  recipe.box = undefined;
+  recipe._textOptions = undefined;
+  recipe._previousTextObjects = [];
+  recipe._firstLineHeight = 0;
+}
+
+/**
+ * Map the PageBox names, which setPageBox() also accepts, to the addon's
+ * ePDFPageBox constants.
+ * @private
+ * @param {Object} muhammara - The addon API the Recipe was created for.
+ * @returns {Object<string, number>} The page box constants by name.
+ */
+function pageBoxConstants(muhammara) {
+  return {
+    [muhammara.PageBox.MEDIA]: muhammara.ePDFPageBoxMediaBox,
+    [muhammara.PageBox.CROP]: muhammara.ePDFPageBoxCropBox,
+    [muhammara.PageBox.BLEED]: muhammara.ePDFPageBoxBleedBox,
+    [muhammara.PageBox.TRIM]: muhammara.ePDFPageBoxTrimBox,
+    [muhammara.PageBox.ART]: muhammara.ePDFPageBoxArtBox,
+  };
+}
 
 /**
  * Validate a page rotation. PDF allows only multiples of 90 degrees.
@@ -677,7 +710,8 @@ exports.rotate = function rotate(rotation) {
  * @throws {TypeError} If no page is active.
  */
 exports.setPageBox = function setPageBox(box, left, bottom, right, top) {
-  box = PAGE_BOX_CONSTANTS[box] ?? box;
+  const muhammara = this.muhammara;
+  box = pageBoxConstants(muhammara)[box] ?? box;
   if ([left, bottom, right, top].some((value) => typeof value === "bigint")) {
     throw new TypeError("setPageBox coordinates must be numbers");
   }
@@ -720,6 +754,8 @@ exports.endPage = function endPage() {
   if (!this.page) {
     return this;
   }
+  // A flow still waiting for its end is drawn on the page it started on.
+  this._flushTextFlow();
 
   if (this.page.endContext) {
     if (this.contextState === PAGE_CONTEXT_STATE.ACTIVE_EDIT)
@@ -746,6 +782,7 @@ exports.endPage = function endPage() {
  * @returns {Recipe} The recipe instance.
  * @throws {Error} If the Recipe was not constructed from an existing PDF.
  * @throws {Error} If the page does not exist in the source PDF.
+ * @throws {Error} If another page is still active; call endPage() first.
  */
 exports.editPage = function editPage(pageNumber) {
   if (this.isNewPDF) {
@@ -753,9 +790,14 @@ exports.editPage = function editPage(pageNumber) {
       "editPage requires a Recipe constructed from an existing PDF",
     );
   }
+  // As in createPage, an active page left unfinished crashes the writer or is
+  // silently dropped at endPDF().
+  if (this.page) {
+    throw new Error("Finish the current page before editing another page");
+  }
   const pdfWriter = this.writer;
   const pageIndex = pageNumber - 1;
-  const pageModifier = new muhammara.PDFPageModifier(
+  const pageModifier = new this.muhammara.PDFPageModifier(
     pdfWriter,
     pageIndex,
     true,
@@ -766,6 +808,7 @@ exports.editPage = function editPage(pageNumber) {
   this.editingPage = true;
   this.contextState = PAGE_CONTEXT_STATE.ACTIVE_EDIT;
   this.modifiedSourcePages.add(pageNumber);
+  resetTextBox(this, this._margin.left, this._margin.top);
 
   this._resumePageRotation(pageNumber);
 

package/lib/recipe/shapes.js

@@ -214,7 +214,7 @@ function _n_gon(sides, cx, cy, radius, options = {}) {
  * @param {number} [options.lineWidth] - The line width
  * @param {number} [options.opacity] - The opacity
  * @param {number[]} [options.dash] - The dash style [number, number]
- * @param {number} [options.rotation=0] - Accept: +/- 0 through 360.
+ * @param {number} [options.rotation=0] - Clockwise rotation in degrees, +/- 0 through 360.
  * @param {number[]} [options.rotationOrigin=[cx,cy]] - [originX, originY]
  * @param {number} [options.rotationVertice] - the number of the vertice to be used as rotation origin
  * @param {number} [options.skewX] - the angle skew off the x-axis
@@ -293,7 +293,7 @@ function _oddStar(ngon) {
  * @param {number} [options.lineWidth] - The line width
  * @param {number} [options.opacity] - The opacity
  * @param {number[]} [options.dash] - The dash style [number, number]
- * @param {number} [options.rotation] - Accept: +/- 0 through 360. Default: 0
+ * @param {number} [options.rotation] - Clockwise rotation in degrees, +/- 0 through 360. Default: 0
  * @param {number[]} [options.rotationOrigin] - [originX, originY] Default: x, y
  * @param {number} [options.skewX] - the angle skew off the x-axis
  * @param {number} [options.skewY] - the angle skew off the y-axis.
@@ -508,7 +508,7 @@ function flipY(x, ngon) {
  * @param {number} [options.lineWidth] - The line width
  * @param {number} [options.opacity] - The opacity
  * @param {number[]} [options.dash] - The dash style [number, number]
- * @param {number} [options.rotation] - Accept: +/- 0 through 360. Default: 0
+ * @param {number} [options.rotation] - Clockwise rotation in degrees, +/- 0 through 360. Default: 0
  * @param {number[]} [options.rotationOrigin] - [originX, originY] Default: x, y
  * @param {number} [options.skewX] - the angle skew off the x-axis
  * @param {number} [options.skewY] - the angle skew off the y-axis.

package/lib/recipe/split.js

@@ -1,4 +1,3 @@
-const muhammara = require("../muhammara");
 const path = require("path");
 const utils = require("./utils");
 
@@ -19,7 +18,7 @@ exports.split = function split(outputDir = "", prefix) {
   prefix = prefix || this.filename;
   for (let i = 0; i < this.metadata.pages; i++) {
     const newPdf = path.join(outputDir, `${prefix}-${i + 1}.pdf`);
-    const pdfWriter = muhammara.createWriter(newPdf);
+    const pdfWriter = this.muhammara.createWriter(newPdf);
     utils.appendPDFPageFromPDFWithAnnotations(pdfWriter, this._getReader(), i);
     pdfWriter.end();
   }

package/lib/recipe/table.js

@@ -212,6 +212,8 @@ exports.table = function table(x, y, contents, options = {}) {
   if (!Array.isArray(contents) || contents.length === 0) {
     return this;
   }
+  // An open text flow is drawn before the table starts its own text.
+  this._flushTextFlow();
   var columns = tableFields(contents, options).map((field) => {
     var column =
       options.columns &&

package/lib/recipe/text.helper.js

@@ -1,4 +1,4 @@
-var { cloneOptions, resolveFontSize } = require("./utils");
+var { cloneOptions, resolveFontSize, trimBreakableEnd } = require("./utils");
 var { HorizontalAlign, VerticalAlign } = require("../recipe-constants");
 
 /**
@@ -70,8 +70,8 @@ const Word = class Word {
   }
 
   /**
-   * Mark the word as the last of its line, trimming trailing space and
-   * measuring it again.
+   * Mark the word as the last of its line, trimming the spaces around it
+   * but a trailing non-breaking space, and measuring it again when trimmed.
    * @param {boolean} [value=true] - Whether the word is last.
    * @returns {void}
    */
@@ -79,7 +79,9 @@ const Word = class Word {
     // indicate last word in line (for justification)
     this._last = value;
     if (this._last) {
-      this._value = this._value.trim(); // wack any trailing space
+      const trimmed = trimBreakableEnd(this._value.trimStart());
+      if (trimmed === this._text) return;
+      this._value = trimmed;
       this._text = this._value;
       this._dimensions = this._pathOptions.font.calculateTextDimensions(
         this._text,