@muhammara/native-core 7.0.0 → 7.1.1

package/lib/recipe/utils.js

@@ -132,10 +132,22 @@ function resolveFontSize(options = {}, fallback) {
   return size;
 }
 
+/**
+ * Remove the breakable whitespace that ends a text; a non-breaking space
+ * (U+00A0) stays, as in Wasm.
+ * @private
+ * @param {string} value - The text.
+ * @returns {string} The trimmed text.
+ */
+function trimBreakableEnd(value) {
+  return value.replace(/(?:(?!\u00a0)\s)+$/, "");
+}
+
 exports.ANNOTATION_PREFIX = ANNOTATION_PREFIX;
 exports.PAGE_CONTEXT_STATE = PAGE_CONTEXT_STATE;
 exports.cloneOptions = cloneOptions;
 exports.resolveFontSize = resolveFontSize;
+exports.trimBreakableEnd = trimBreakableEnd;
 exports.appendPDFPageFromPDFWithAnnotations =
   appendPDFPageFromPDFWithAnnotations;
 exports.appendPDFPagesFromPDFWithAnnotations =

package/lib/recipe/vector-line.js

@@ -1,4 +1,3 @@
-const muhammara = require("../muhammara");
 const { Colorspace } = require("../recipe-constants");
 
 /**
@@ -62,7 +61,7 @@ exports._strokePolyline = function _strokePolyline(points, options) {
   // edited page resumes into a new context, so read the context afterwards.
   const pathOptions = this._getPathOptions(options);
   const context = this.pageContext;
-  pathOptions.type = muhammara.DrawingPathType.STROKE;
+  pathOptions.type = this.muhammara.DrawingPathType.STROKE;
 
   if (pathOptions.stroke !== undefined) {
     pathOptions.color = pathOptions.stroke;

package/lib/recipe/vector-polygon.js

@@ -27,7 +27,7 @@
  * @param {number} [options.opacity] - The opacity
  * @param {number[]} [options.dash] - The dash pattern [dashSize, gapSize] or [dashAndGapSize]
  * @param {number} [options.dashPhase] - distance into dash pattern at which to start dash (default: 0, immediately)
- * @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 {Recipe.LineCap} [options.lineCap] -  open line end style, a `Recipe.LineCap` value (default: 'round')
  * @param {Recipe.LineJoin} [options.lineJoin] - joined line end style, a `Recipe.LineJoin` value (default: 'round')

package/lib/recipe/vector.js

@@ -13,7 +13,6 @@
 //   PercentColor component values range from 1 to 100.
 
 const { linkPdf } = require("./annotation");
-const muhammara = require("../muhammara");
 const { miterLimitOption } = require("../recipe-options");
 
 /**
@@ -44,7 +43,7 @@ exports.circle = function circle(x, y, radius, options = {}) {
 
   if (options.fill) {
     const pathOptions = this._getPathOptions(options, nx, ny);
-    pathOptions.type = muhammara.DrawingPathType.FILL;
+    pathOptions.type = this.muhammara.DrawingPathType.FILL;
 
     if (pathOptions.fill !== undefined) {
       pathOptions.color = pathOptions.fill;
@@ -72,7 +71,7 @@ exports.circle = function circle(x, y, radius, options = {}) {
   }
   if (options.stroke || options.color || !options.fill) {
     const pathOptions = this._getPathOptions(options);
-    pathOptions.type = muhammara.DrawingPathType.STROKE;
+    pathOptions.type = this.muhammara.DrawingPathType.STROKE;
 
     if (pathOptions.stroke !== undefined) {
       pathOptions.color = pathOptions.stroke;
@@ -129,7 +128,7 @@ exports.circle = function circle(x, y, 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] - 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|number[]} [options.borderRadius] - Radius size for rounded corners.
  * When a one to four number array can be used to give specific sizees to each corner.
@@ -152,7 +151,7 @@ exports.rectangle = function rectangle(x, y, width, height, options = {}) {
   pathOptions.useGivenCoords = options.useGivenCoords;
 
   if (options.fill) {
-    pathOptions.type = muhammara.DrawingPathType.FILL;
+    pathOptions.type = this.muhammara.DrawingPathType.FILL;
 
     if (pathOptions.fill !== undefined) {
       pathOptions.color = pathOptions.fill;
@@ -188,7 +187,7 @@ exports.rectangle = function rectangle(x, y, width, height, options = {}) {
   }
 
   if (options.stroke || options.color || !options.fill) {
-    pathOptions.type = muhammara.DrawingPathType.STROKE;
+    pathOptions.type = this.muhammara.DrawingPathType.STROKE;
 
     // The fill above may have replaced the color; stroke with `color`.
     colorModel =
@@ -362,7 +361,7 @@ function drawRoundedRectangle(
  * @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
  * @returns {Recipe} The recipe instance.
  * @throws {TypeError} If no page is active.
@@ -544,7 +543,7 @@ function drawArc(ctx, x, y, radius, startAngle, endAngle, fromCenter = false) {
  * @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] - [originX, originY] Default: x, y
  * @returns {Recipe} The recipe instance.
  * @throws {TypeError} If no page is active.

package/lib/recipe-constants.js

@@ -320,7 +320,7 @@ var TextWrap = Object.freeze({
   CLIP: "clip",
   /** Drop the words that do not fit. */
   TRIM: "trim",
-  /** Replace the text that does not fit with "...". */
+  /** Replace the text that does not fit with "…". */
   ELLIPSIS: "ellipsis",
 });
 

package/licenses/AdobeGlyphList.txt

@@ -0,0 +1,29 @@
+Copyright (c) 1997,1998,2002,2007 Adobe Systems Incorporated
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this documentation file to use, copy, publish, distribute,
+sublicense, and/or sell copies of the documentation, and to permit
+others to do the same, provided that:
+- No modification, editing or other alteration of this document is
+allowed; and
+- The above copyright notice and this permission notice shall be
+included in all copies of the documentation.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this documentation file, to create their own derivative works
+from the content of this document to use, copy, publish, distribute,
+sublicense, and/or sell the derivative works, and to permit others to do
+the same, provided that the derived work is not represented as being a
+copy or version of this document.
+
+Adobe shall not be liable to any party for any loss of revenue or profit
+or for indirect, incidental, special, consequential, or other similar
+damages, whether based on tort (including without limitation negligence
+or strict liability), contract or other legal or equitable grounds even
+if Adobe has been advised or had reason to know of the possibility of
+such damages. The Adobe materials are provided on an "AS IS" basis.
+Adobe specifically disclaims all express, statutory, or implied
+warranties relating to the Adobe materials, including but not limited to
+those concerning merchantability or fitness for a particular purpose or
+non-infringement of any third party rights regarding the Adobe
+materials.

package/muhammara.d.ts

@@ -89,29 +89,74 @@ declare namespace muhammara {
    * no passwords are given.
    * @param originalPdfPath - The source PDF path.
    * @param newPdfPath - The output path.
-   * @param options - The source password and the new encryption settings.
+   * @param options - The source password and the new encryption settings;
+   *   `null` means no options.
    * @throws {TypeError} If the arguments are wrong, one side is a path and the
    *   other a stream, or the PDF cannot be recrypted.
    */
   export function recrypt(
     originalPdfPath: FilePath,
     newPdfPath: FilePath,
-    options?: PDFRecryptOptions,
+    options?: PDFRecryptOptions | null,
   ): void;
   /**
    * Writes a copy of a PDF stream with new encryption settings, or decrypted
    * when no passwords are given.
    * @param originalPdfStream - The source PDF.
    * @param newPdfStream - The output stream.
-   * @param options - The source password and the new encryption settings.
+   * @param options - The source password and the new encryption settings;
+   *   `null` means no options.
    * @throws {TypeError} If the arguments are wrong or the PDF cannot be
    *   recrypted.
    */
   export function recrypt(
     originalPdfStream: PDFRStreamForFile | PDFRStreamForBuffer,
     newPdfStream: PDFWStreamForFile | PDFWStreamForBuffer,
-    options?: PDFRecryptOptions,
+    options?: PDFRecryptOptions | null,
   ): void;
+  /**
+   * Like `recrypt()`, but re-encrypts on libuv's thread pool and returns a
+   * promise, so the event loop keeps running. A thread's jobs run one at a
+   * time, in call order, and its waiting jobs do not hold pool threads; jobs
+   * from different threads run in parallel. Relative paths are resolved when
+   * called, naming the files `recrypt()` would open at that moment.
+   * @param originalPdfPath - The source PDF path.
+   * @param newPdfPath - The output path.
+   * @param options - The source password and the new encryption settings;
+   *   `null` means no options.
+   * @returns Resolves once the output is written; rejects with a TypeError if
+   *   the PDF cannot be recrypted, or with an Error if the source or output
+   *   path is relative and the working directory was removed, or if a path
+   *   is too long for the system once made absolute.
+   * @throws {TypeError} If the arguments are wrong, or one side is a path and
+   *   the other a stream.
+   */
+  export function recryptAsync(
+    originalPdfPath: FilePath,
+    newPdfPath: FilePath,
+    options?: PDFRecryptOptions | null,
+  ): Promise<void>;
+  /**
+   * Like `recrypt()`, but re-encrypts on libuv's thread pool and returns a
+   * promise. The source stream is read into memory when called, and the
+   * output is written to `newPdfStream` before the promise resolves; both
+   * steps run on the calling thread.
+   * @param originalPdfStream - The source PDF.
+   * @param newPdfStream - The output stream.
+   * @param options - The source password and the new encryption settings;
+   *   `null` means no options.
+   * @returns Resolves once the output is written; rejects with a TypeError if
+   *   the PDF cannot be recrypted, with an Error if the output stream was
+   *   written to after the call, with a RangeError if the source or output is
+   *   too large to hold in memory, with the error a stream threw, or with an
+   *   Error if `log` is too long for the system once made absolute.
+   * @throws {TypeError} If the arguments are wrong.
+   */
+  export function recryptAsync(
+    originalPdfStream: PDFRStreamForFile | PDFRStreamForBuffer,
+    newPdfStream: PDFWStreamForFile | PDFWStreamForBuffer,
+    options?: PDFRecryptOptions | null,
+  ): Promise<void>;
 
   /**
    * A JavaScript output stream. `write` receives each chunk as a `Buffer` the
@@ -1395,7 +1440,8 @@ declare namespace muhammara {
   /**
    * Per-call extraction budget. Every field is clamped to a built-in ceiling,
    * so a caller may tighten a limit but never raise it above the default.
-   * Omitted fields keep the ceiling.
+   * Omitted fields keep the ceiling. Independent of these, an extraction reads
+   * at most 64 MiB of decoded content and throws past it.
    */
   export interface PDFExtractionLimits {
     /** Extracted elements or items. Default and ceiling: 100000. */
@@ -3467,6 +3513,7 @@ declare namespace muhammara {
       overflow?: TextOverflowCallback;
       layout?: number | string;
       opacity?: number;
+      /** Clockwise rotation in degrees, around `rotationOrigin` or the text position. */
       rotation?: number;
       rotationOrigin?: readonly [number, number];
       font?: string;
@@ -3643,6 +3690,7 @@ declare namespace muhammara {
     }
 
     interface TransformOptions extends SkewOptions {
+      /** Clockwise rotation in degrees, around `rotationOrigin`. */
       rotation?: number;
       rotationOrigin?: readonly [number, number];
     }
@@ -4174,7 +4222,7 @@ declare namespace muhammara {
      *   "center center". Horizontal center moves the image left by half its width
      *   and right moves it right by half; vertical center moves it up by half its
      *   height and bottom moves it down by half from its top-left placement.
-     * @param options.rotation - Rotate the image, in degrees.
+     * @param options.rotation - Clockwise rotation of the image, in degrees.
      * @param options.rotationOrigin - [x, y] of the rotation origin; the
      *   bottom-left corner of the drawn image when omitted.
      * @param options.fill - Paint the image box beneath the image.
@@ -4434,7 +4482,8 @@ declare namespace muhammara {
     resumeContext(): Recipe;
     /**
      * Rotate subsequent content around a point in Recipe coordinates.
-     * @param degrees - Clockwise rotation in degrees.
+     * @param degrees - Counter-clockwise rotation in degrees. The `rotation`
+     *   option of shapes, text, and images turns clockwise instead.
      * @param x - Rotation origin x coordinate; defaults to 0.
      * @param y - Rotation origin y coordinate; defaults to 0.
      * @returns The recipe instance.
@@ -4478,8 +4527,9 @@ declare namespace muhammara {
      * @param options.underline - Text markup annotation.
      * @param options.strikeOut - Text markup annotation.
      * @param options.html - Interpret text as html
-     * @param options.flow - Used to activate/deactivate text flow which is the; defaults to false.
-     * ability to use multiple calls to 'text' to create an overall text box.
+     * @param options.flow - Used to activate/deactivate text flow which is the
+     * ability to use multiple calls to 'text' to create an overall text box. Defaults to
+     * `true` for a call without coordinates and `false` for a call with them.
      * @param options.layout - An identifier of the layout to be associated with given text.
      * @param options.overflow - Called when the text is going to exceed the area
      * of the given text object. Intended for column layouts. Its parameter is (self) where 'self' is the recipe handle so

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@muhammara/native-core",
-  "version": "7.0.0",
+  "version": "7.1.1",
   "description": "Shared JavaScript API for MuhammaraJS native packages",
   "homepage": "https://muhammarajs.readthedocs.io/",
   "license": "Apache-2.0",
@@ -26,6 +26,7 @@
     "index.d.ts",
     "lib",
     "fonts",
+    "licenses",
     "muhammara.d.ts",
     "THIRD_PARTY_NOTICES.md"
   ],