@muhammara/native-core 7.0.0-beta.1 → 7.0.0-beta.2

package/lib/recipe/parameters.js

@@ -81,6 +81,8 @@ exports._setParameters = function _setParameters() {
   };
 
   this._margin = Object.assign({}, this.default.pageMargin);
+  this.contextState = "idle";
+  this.modifiedSourcePages = new Set();
 
   // Object.assign(this, options);
 };

package/lib/recipe/replaceText.js

@@ -10,14 +10,15 @@ function escapePDFLiteralString(value) {
  * @memberof Recipe#
  * @param {string} text Text to replace.
  * @param {string} replacement Replacement text.
- * @param {number} [pageNumber=1] One-based page number.
+ * @param {number} pageNumber One-based page number.
  */
 exports.replaceText = function replaceText(text, replacement, pageNumber) {
-  pageNumber = pageNumber || 1;
-
   if (typeof text !== "string" || typeof replacement !== "string") {
     throw new TypeError("replaceText expects text and replacement strings");
   }
+  if (!Number.isInteger(pageNumber) || pageNumber < 1) {
+    throw new TypeError("replaceText expects a positive integer page number");
+  }
 
   var pageIndex = pageNumber - 1;
   var page = this.pdfReader.parsePage(pageIndex).getDictionary();
@@ -60,5 +61,6 @@ exports.replaceText = function replaceText(text, replacement, pageNumber) {
   replacementStream.getWriteStream().write(Array.from(Buffer.from(replaced)));
   objectsContext.endPDFStream(replacementStream).endIndirectObject();
   this.writer.replaceObject(pageIndex, contentsObjectId, replacementObjectId);
+  this.modifiedSourcePages.add(pageNumber);
   return this;
 };

package/lib/recipe/shapes.js

@@ -155,7 +155,10 @@ exports.n_gon = function n_gon(cx, cy, radius, sides = 3, options = {}) {
 
   const ngon = _n_gon(sides, cx, cy, radius, options);
 
-  this.polygon(ngon, options);
+  const drawOptions = Object.assign({}, options, { link: undefined });
+  this.polygon(ngon, drawOptions);
+  if (options.link)
+    this.link(options.link, cx - radius, cy - radius, radius * 2, radius * 2);
 
   if (options.rotationVertice) {
     delete options["rotationOrigin"]; // cleanup n-gon generated point
@@ -220,6 +223,7 @@ exports.star = function star(cx, cy, radius, points = 5, options = {}) {
   }
 
   const starOptions = Object.assign({}, options);
+  delete starOptions.link;
 
   if (odd(points)) {
     starPath = _oddStar(_n_gon(points, cx, cy, radius, options));
@@ -265,6 +269,9 @@ exports.star = function star(cx, cy, radius, points = 5, options = {}) {
 
   this.polygon(starPath, starOptions);
 
+  if (options.link)
+    this.link(options.link, cx - radius, cy - radius, radius * 2, radius * 2);
+
   if (options.debug) {
     this.circle(cx, cy, radius, { width: 1, stroke: "#00ff00" });
     this.circle(cx, cy, 2, { fill: "#ff0000" });
@@ -375,6 +382,7 @@ exports.triangle = function triangle(x, y, traits, options = {}) {
   let traitID = options.traitID || options.traitsID || "sss";
   let position = options.position ? options.position.toLowerCase() : "default";
   let triopts = Object.assign({}, options);
+  delete triopts.link;
 
   if (traits.length !== 3) {
     throw new Error(
@@ -433,6 +441,19 @@ exports.triangle = function triangle(x, y, traits, options = {}) {
   }
 
   this.polygon(trigon, triopts);
+  if (options.link) {
+    const xs = trigon.map((point) => point[0]);
+    const ys = trigon.map((point) => point[1]);
+    const left = Math.min(...xs);
+    const top = Math.min(...ys);
+    this.link(
+      options.link,
+      left,
+      top,
+      Math.max(...xs) - left,
+      Math.max(...ys) - top,
+    );
+  }
 
   if (options.debug) {
     let angle = triopts.rotation || 0;

package/lib/recipe/text.helper.js

@@ -1,5 +1,5 @@
 const charSpacing = function charSpacing(text, charSpace) {
-  let txt = text.trim();
+  let txt = text.replace(/^(?:(?!\u00a0)\s)+|(?:(?!\u00a0)\s)+$/g, "");
   return txt.length ? (txt.length - 1) * charSpace : 0;
 };
 

package/lib/recipe/text.js

@@ -2,6 +2,7 @@ const LineBreaker = require("linebreak");
 const { Word, Line, Column } = require("./text.helper");
 const { htmlToTextObjects } = require("./htmlToTextObjects");
 const { Color, xObjectForm } = require("./xObjectForm");
+const { linkPdf } = require("./annotation");
 const muhammara = require("../muhammara");
 const { UsedFont } = require("../muhammara");
 
@@ -258,6 +259,8 @@ exports.text = function text(text = "", x, y, options = {}) {
     return this;
   }
   options = _initOptions(this, x, y, options);
+  const linkX = this.x;
+  const linkY = this.y;
 
   const targetAnnotations = options;
   const originCoord = this._calibrateCoordinate(
@@ -273,6 +276,7 @@ exports.text = function text(text = "", x, y, options = {}) {
     originCoord.ny,
   );
   pathOptions.html = options.html;
+  pathOptions.link = options.link;
   pathOptions.hilite = options.hilite;
 
   // save text state for continued text?
@@ -294,6 +298,7 @@ exports.text = function text(text = "", x, y, options = {}) {
     textBox,
     pathOptions,
   );
+  const linkAnnotations = [];
 
   if (!textBox.width) {
     textBox.width = toWriteTextObjects[0].lineWidth;
@@ -316,7 +321,7 @@ exports.text = function text(text = "", x, y, options = {}) {
       toWriteTextObjects = clippedText.textObjects;
       textBox.textHeight = getTextBoxHeight(toWriteTextObjects);
 
-      if (clippedText.remainder.length) {
+      if (clippedText.clipped) {
         clipResult = {
           remainder: clippedText.remainder,
           linesWritten: clippedText.linesWritten,
@@ -641,6 +646,15 @@ exports.text = function text(text = "", x, y, options = {}) {
           const x = next_x || getStartX(content.startX, content);
           const y = currentY;
           next_x = writeText(context, x, y, content);
+          if (content.writeOptions.link) {
+            linkAnnotations.push({
+              url: content.writeOptions.link,
+              left: x,
+              bottom: y,
+              width: next_x ? next_x - x : content.lineWidth,
+              height: content.lineHeight,
+            });
+          }
         });
         // The line offset from the last line in the
         // group determines Y positioning for next line.
@@ -739,6 +753,15 @@ exports.text = function text(text = "", x, y, options = {}) {
           const x = next_x || getStartX(content.startX, content);
           const y = currentY;
           next_x = writeText(context, x, y, content);
+          if (content.writeOptions.link) {
+            linkAnnotations.push({
+              url: content.writeOptions.link,
+              left: x,
+              bottom: y,
+              width: next_x ? next_x - x : content.lineWidth,
+              height: content.lineHeight,
+            });
+          }
         }
 
         // Flush any left over text objects.
@@ -754,6 +777,16 @@ exports.text = function text(text = "", x, y, options = {}) {
     }
   }
 
+  linkAnnotations.forEach((annotation) => {
+    linkPdf(
+      this,
+      annotation.url,
+      annotation.left,
+      annotation.bottom,
+      annotation.width,
+      annotation.height,
+    );
+  });
   return this;
 };
 
@@ -798,6 +831,13 @@ exports._layoutText = function _layoutText(textObjects, textBox, pathOptions) {
 
   let firstLineHeight;
   let toWriteTextObjects = [];
+  /** Reports whether a layout node contains content other than the break sentinel. */
+  const hasRenderableContent = (textObject) =>
+    (textObject.value !== undefined &&
+      textObject.value !== null &&
+      textObject.value !== "" &&
+      textObject.value !== "[@@DONOT_RENDER_THIS@@]") ||
+    textObject.childs?.some(hasRenderableContent);
 
   const writeValue = (textObject) => {
     textObject.lineID = textObject.lineID || Date.now() * Math.random();
@@ -832,6 +872,7 @@ exports._layoutText = function _layoutText(textObjects, textBox, pathOptions) {
       textObject.layer++;
 
       textObject.currentIndex = 0;
+      let prependValue = textObject.prependValue;
 
       textObject.childs.forEach((child) => {
         if (textObject.tag == "ul") {
@@ -852,11 +893,17 @@ exports._layoutText = function _layoutText(textObjects, textBox, pathOptions) {
             child.layer = textObject.layer - 1;
           }
         }
-        if (textObject.prependValue) {
-          child.prependValue = !["ol", "ul"].includes(textObject.tag)
-            ? textObject.prependValue
-            : child.prependValue;
-          textObject.indent = 2 * textObject.layer;
+        if (
+          prependValue &&
+          !["ol", "ul"].includes(child.tag) &&
+          hasRenderableContent(child)
+        ) {
+          child.prependValue = prependValue;
+          prependValue = null;
+          textObject.indent =
+            textObject.tag == "li"
+              ? 2 * textObject.layer
+              : textObject.indent || 2 * textObject.layer;
         }
         if (textObject.indent) {
           child.indent = child.indent || textObject.indent;
@@ -866,6 +913,7 @@ exports._layoutText = function _layoutText(textObjects, textBox, pathOptions) {
           child.sizeRatios = [...textObject.sizeRatios, child.sizeRatio];
         }
         child.styles = Object.assign(child.styles, textObject.styles);
+        child.link = child.link || textObject.link;
 
         child.isBold = textObject.isBold ? textObject.isBold : child.isBold;
         child.isItalic = textObject.isItalic
@@ -887,7 +935,55 @@ exports._layoutText = function _layoutText(textObjects, textBox, pathOptions) {
     writeValue(textObject);
   });
 
-  return { toWriteTextObjects: toWriteTextObjects, textHeight: totalHeight };
+  const normalizedTextObjects = [];
+  let pendingBreaks = [];
+  const replacementLineIDs = new Map();
+  /** Converts pending break sentinels into line state without rendering their text. */
+  const appendPendingBreaks = (nextTextObject) => {
+    const previous = normalizedTextObjects[normalizedTextObjects.length - 1];
+    if (previous) previous.lineComplete = true;
+    const blankBreaks =
+      previous && nextTextObject ? pendingBreaks.slice(1) : pendingBreaks;
+    blankBreaks.forEach((breakObject, index) => {
+      normalizedTextObjects.push({
+        ...breakObject,
+        lineID: previous ? pendingBreaks[index].lineID : breakObject.lineID,
+        text: "",
+        lineComplete: true,
+        lineWidth: 0,
+        textWidth: 0,
+      });
+    });
+    if (nextTextObject && previous) {
+      replacementLineIDs.set(
+        nextTextObject.lineID,
+        pendingBreaks[pendingBreaks.length - 1].lineID,
+      );
+    }
+    pendingBreaks = [];
+  };
+  toWriteTextObjects.forEach((textObject, index, objects) => {
+    const sentinel = textObject.text.trim() == "[@@DONOT_RENDER_THIS@@]";
+    const beforeSentinel =
+      textObject.text.trim() == "" &&
+      objects[index + 1]?.text.trim() == "[@@DONOT_RENDER_THIS@@]";
+    if (beforeSentinel) return;
+    if (sentinel) {
+      pendingBreaks.push(textObject);
+      return;
+    }
+    if (pendingBreaks.length) appendPendingBreaks(textObject);
+    textObject.lineID =
+      replacementLineIDs.get(textObject.lineID) || textObject.lineID;
+    normalizedTextObjects.push(textObject);
+  });
+  if (pendingBreaks.length) appendPendingBreaks();
+  toWriteTextObjects = normalizedTextObjects;
+
+  return {
+    toWriteTextObjects: toWriteTextObjects,
+    textHeight: getTextBoxHeight(toWriteTextObjects) || totalHeight,
+  };
 };
 
 function getTextBoxHeight(textObjs) {
@@ -949,6 +1045,7 @@ function clipTextToBox(textObjs, availableHeight) {
   return {
     textObjects: visibleLines.flat(),
     linesWritten,
+    clipped: remainderLines.length > 0,
     // Preserve line boundaries so a remainder can be written into another box.
     remainder: remainderLines
       .map((currentLine) => currentLine.map((textObj) => textObj.text).join(""))
@@ -1195,6 +1292,7 @@ function makeTextObjects(self, textObject = {}, pathOptions, textBox = {}) {
     ? textBox.textAlign.split(" ")
     : [];
   const writeOptions = Object.assign({}, pathOptions, {
+    link: textObject.link || pathOptions.link,
     color: textObject.styles.color,
     opacity: parseFloat(textObject.styles.opacity || pathOptions.opacity || 1),
     underline: textObject.underline || pathOptions.underline,
@@ -1216,7 +1314,7 @@ function makeTextObjects(self, textObject = {}, pathOptions, textBox = {}) {
   const indent = textObject.indent || 0;
 
   const lineMaxWidth = textBox.width
-    ? textBox.width - textBox.paddingLeft - textBox.paddingRight - indent
+    ? textBox.width - textBox.paddingLeft - textBox.paddingRight
     : null;
   let remainderWidth = lineMaxWidth;
   let newLine;

package/lib/recipe/vector-polygon.js

@@ -122,6 +122,7 @@ exports.polygon = function polygon(coordinates = [], options = {}) {
       height,
       pathOptions,
       (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         ctx.w(pathOptions.width);
         setPathOptions(ctx);
         xObject.stroke(colorModel);
@@ -131,5 +132,15 @@ exports.polygon = function polygon(coordinates = [], options = {}) {
     );
   }
 
+  if (options.link) {
+    this.link(
+      options.link,
+      boundBox[0] - margin,
+      boundBox[1] - margin,
+      width,
+      height,
+    );
+  }
+
   return this;
 };

package/lib/recipe/vector.helper.js

@@ -30,9 +30,21 @@ exports._getPathOptions = function _getPathOptions(
     width: 2,
     align: options.align,
   };
+  const lineStyle = this.current.lineStyle || {};
+
+  if (lineStyle.width !== undefined) pathOptions.width = lineStyle.width;
+  if (lineStyle.cap !== undefined) pathOptions.lineCap = lineStyle.cap;
+  if (lineStyle.join !== undefined) pathOptions.lineJoin = lineStyle.join;
+  if (lineStyle.miterLimit !== undefined)
+    pathOptions.miterLimit = lineStyle.miterLimit;
+  if (lineStyle.dash !== undefined) pathOptions.dash = lineStyle.dash;
+  if (lineStyle.dashPhase !== undefined)
+    pathOptions.dashPhase = lineStyle.dashPhase;
+  if (pathOptions.dash === undefined) pathOptions.dash = [];
+  if (pathOptions.dashPhase === undefined) pathOptions.dashPhase = 0;
 
   if (options.opacity == void 0 || isNaN(options.opacity)) {
-    options.opacity = 1;
+    options.opacity = this.current.opacity ?? 1;
   } else {
     options.opacity =
       options.opacity < 0 ? 0 : options.opacity > 1 ? 1 : options.opacity;
@@ -95,8 +107,8 @@ exports._getPathOptions = function _getPathOptions(
   }
 
   // Page 127 of PDF 1.7 specification
-  pathOptions.dash = Array.isArray(options.dash) ? options.dash : [];
-  pathOptions.dashPhase = !isNaN(options.dashPhase) ? options.dashPhase : 0;
+  if (Array.isArray(options.dash)) pathOptions.dash = options.dash;
+  if (!isNaN(options.dashPhase)) pathOptions.dashPhase = options.dashPhase;
   if (pathOptions.dash[0] == 0 && pathOptions.dash[1] == 0) {
     pathOptions.dash = []; // no dash, solid unbroken line
     pathOptions.dashPhase = 0;

package/lib/recipe/vector.js

@@ -12,6 +12,8 @@
 //   DecimalColor component values range from 0 to 255.
 //   PercentColor component values range from 1 to 100.
 
+const { linkPdf } = require("./annotation");
+
 /**
  * Draw a circle
  * @name circle
@@ -74,7 +76,8 @@ exports.circle = function circle(x, y, radius, options = {}) {
       diameter,
       diameter,
       pathOptions,
-      (ctx) => {
+      (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         ctx
           .d(pathOptions.dash, pathOptions.dashPhase)
           .drawCircle(
@@ -88,6 +91,8 @@ exports.circle = function circle(x, y, radius, options = {}) {
       },
     );
   }
+  if (options.link)
+    this.link(options.link, x - radius, y - radius, diameter, diameter);
   return this;
 };
 
@@ -173,6 +178,7 @@ exports.rectangle = function rectangle(x, y, width, height, options = {}) {
       height,
       pathOptions,
       (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         // ... requires adjusting the internal drawing to accomodate line thickness.
         const margin = pathOptions.width;
         xObject.stroke(colorModel);
@@ -203,6 +209,11 @@ exports.rectangle = function rectangle(x, y, width, height, options = {}) {
       },
     );
   }
+  if (options.link) {
+    if (options.useGivenCoords)
+      linkPdf(this, options.link, x, y, width, height);
+    else this.link(options.link, x, y, width, height);
+  }
 
   return this;
 };
@@ -362,6 +373,7 @@ exports.ellipse = function ellipse(cx, cy, rx, ry, options = {}) {
       height,
       pathOptions,
       (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         const margin = pathOptions.width / 2;
         xObject.stroke(colorModel);
         ctx.w(pathOptions.width).d(pathOptions.dash, pathOptions.dashPhase);
@@ -378,6 +390,7 @@ exports.ellipse = function ellipse(cx, cy, rx, ry, options = {}) {
       },
     );
   }
+  if (options.link) this.link(options.link, cx - rx, cy - ry, width, height);
   return this;
 };
 
@@ -518,6 +531,7 @@ exports.arc = function arc(
       diameter,
       pathOptions,
       (ctx, xObject) => {
+        ctx.gs(xObject.getGsName(pathOptions.strokeGsId));
         const margin = pathOptions.width / 2;
         xObject.stroke(colorModel);
         ctx.w(pathOptions.width).d(pathOptions.dash, pathOptions.dashPhase);
@@ -532,34 +546,118 @@ exports.arc = function arc(
     );
   }
 
+  if (options.link)
+    this.link(options.link, x - radius, y - radius, diameter, diameter);
+  return this;
+};
+
+/**
+ * Draw a closed sector of a circle.
+ * @name pie
+ * @function
+ * @memberof Recipe#
+ * @param {number} x - the x coordinate of the pie center point
+ * @param {number} y - the y coordinate of the pie center point
+ * @param {number} radius - the distance from the center point to the arc
+ * @param {number} [startAngle=0] - the start of the arc in degree units
+ * @param {number} [endAngle=360] - the end of the arc in degree units
+ * @param {Object} [options] - The path options.
+ * @returns {Recipe} The recipe instance.
+ */
+exports.pie = function pie(x, y, radius, startAngle, endAngle, options = {}) {
+  return this.arc(x, y, radius, startAngle, endAngle, {
+    ...options,
+    sector: true,
+  });
+};
+
+/**
+ * Set the line style for the current page content context.
+ * @name lineStyle
+ * @function
+ * @memberof Recipe#
+ * @param {Recipe.LineStyleOptions} [options] - The line style options.
+ * @param {number} [options.width] - The line width.
+ * @param {number} [options.lineWidth] - Alias for width.
+ * @param {number} [options.cap] - The PDF line cap style.
+ * @param {number} [options.join] - The PDF line join style.
+ * @param {number} [options.miterLimit] - The miter limit.
+ * @param {number[]} [options.dash] - The dash pattern.
+ * @param {number} [options.dashPhase] - The dash pattern phase.
+ * @returns {Recipe} The recipe instance.
+ */
+exports.lineStyle = function lineStyle(options = {}) {
+  this.current = this.current || {};
+  this.current.lineStyle = this.current.lineStyle || {};
+
+  if (options.width !== undefined || options.lineWidth !== undefined) {
+    const width = options.width ?? options.lineWidth;
+    this.current.lineStyle.width = width;
+    this.pageContext.w(width);
+  }
+  if (options.cap !== undefined) {
+    this.current.lineStyle.cap = options.cap;
+    this.pageContext.J(options.cap);
+  }
+  if (options.join !== undefined) {
+    this.current.lineStyle.join = options.join;
+    this.pageContext.j(options.join);
+  }
+  if (options.miterLimit !== undefined) {
+    this.current.lineStyle.miterLimit = options.miterLimit;
+    this.pageContext.M(options.miterLimit);
+  }
+  if (options.dash !== undefined || options.dashPhase !== undefined) {
+    const dash = options.dash ?? this.current.lineStyle.dash ?? [];
+    const dashPhase =
+      options.dashPhase ?? this.current.lineStyle.dashPhase ?? 0;
+    this.current.lineStyle.dash = dash;
+    this.current.lineStyle.dashPhase = dashPhase;
+  }
+  return this._setLineStyle(options);
+};
+
+exports._setLineStyle = function _setLineStyle(options = {}) {
+  if (options.width !== undefined || options.lineWidth !== undefined)
+    this.pageContext.w(options.width ?? options.lineWidth);
+  if (options.cap !== undefined) this.pageContext.J(options.cap);
+  if (options.join !== undefined) this.pageContext.j(options.join);
+  if (options.miterLimit !== undefined) this.pageContext.M(options.miterLimit);
+  if (options.dash !== undefined || options.dashPhase !== undefined)
+    this.pageContext.d(
+      options.dash ?? this.current.lineStyle.dash ?? [],
+      options.dashPhase ?? this.current.lineStyle.dashPhase ?? 0,
+    );
   return this;
 };
 
 /**
  * Set the line width.
  *
- * This compatibility method currently has no effect.
  * @name lineWidth
  * @function
  * @memberof Recipe#
- * @param {number} width - The requested line width.
+ * @param {number} width - The line width.
  * @returns {Recipe} The recipe instance.
  */
-exports.lineWidth = function lineWidth() {
-  return this;
+exports.lineWidth = function lineWidth(width) {
+  return this.lineStyle({ width });
 };
 
 /**
- * Set the fill opacity.
+ * Set fill and stroke opacity.
  *
- * This compatibility method currently has no effect.
- * @name fillOpacity
+ * @name opacity
  * @function
  * @memberof Recipe#
- * @param {number} opacity - The requested fill opacity.
+ * @param {number} value - The requested opacity from 0 (transparent) to 1 (opaque).
  * @returns {Recipe} The recipe instance.
  */
-exports.fillOpacity = function fillOpacity() {
+exports.opacity = function opacity(value) {
+  if (!Number.isFinite(value) || value < 0 || value > 1) {
+    throw new RangeError("Opacity must be a finite number between 0 and 1");
+  }
+  this.current.opacity = value;
   return this;
 };
 

package/lib/recipe-info.js

@@ -0,0 +1,10 @@
+// Metadata fields accepted by Recipe constructor options and info().
+var recipeInfoKeys = Object.freeze({
+  author: "author",
+  title: "title",
+  subject: "subject",
+  keywords: "keywords",
+});
+var standardInfoKeys = Object.freeze(Object.values(recipeInfoKeys));
+
+module.exports = { recipeInfoKeys, standardInfoKeys };