sharp 0.33.5 → 0.35.3

package/{lib/resize.js → dist/resize.mjs}

@@ -1,9 +1,9 @@
-// Copyright 2013 Lovell Fuller and others.
-// SPDX-License-Identifier: Apache-2.0
-
-'use strict';
+/*!
+  Copyright 2013 Lovell Fuller and others.
+  SPDX-License-Identifier: Apache-2.0
+*/
 
-const is = require('./is');
+import is from './is.mjs';
 
 /**
  * Weighting to apply when using contain/cover fit.
@@ -72,7 +72,9 @@ const kernel = {
   cubic: 'cubic',
   mitchell: 'mitchell',
   lanczos2: 'lanczos2',
-  lanczos3: 'lanczos3'
+  lanczos3: 'lanczos3',
+  mks2013: 'mks2013',
+  mks2021: 'mks2021'
 };
 
 /**
@@ -105,7 +107,7 @@ const mapFitToCanvas = {
  * @private
  */
 function isRotationExpected (options) {
-  return (options.angle % 360) !== 0 || options.useExifOrientation === true || options.rotationAngle !== 0;
+  return (options.angle % 360) !== 0 || options.rotationAngle !== 0;
 }
 
 /**
@@ -127,7 +129,7 @@ function isResizeExpected (options) {
  *
  * Some of these values are based on the [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) CSS property.
  *
- * <img alt="Examples of various values for the fit property when resizing" width="100%" style="aspect-ratio: 998/243" src="https://cdn.jsdelivr.net/gh/lovell/sharp@main/docs/image/api-resize-fit.svg">
+ * <img alt="Examples of various values for the fit property when resizing" width="100%" style="aspect-ratio: 998/243" src="/api-resize-fit.svg">
  *
  * When using a **fit** of `cover` or `contain`, the default **position** is `centre`. Other options are:
  * - `sharp.position`: `top`, `right top`, `right`, `right bottom`, `bottom`, `left bottom`, `left`, `left top`.
@@ -148,6 +150,8 @@ function isResizeExpected (options) {
  * - `mitchell`: Use a [Mitchell-Netravali spline](https://www.cs.utexas.edu/~fussell/courses/cs384g-fall2013/lectures/mitchell/Mitchell.pdf).
  * - `lanczos2`: Use a [Lanczos kernel](https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel) with `a=2`.
  * - `lanczos3`: Use a Lanczos kernel with `a=3` (the default).
+ * - `mks2013`: Use a [Magic Kernel Sharp](https://johncostella.com/magic/mks.pdf) 2013 kernel, as adopted by Facebook.
+ * - `mks2021`: Use a Magic Kernel Sharp 2021 kernel, with more accurate (reduced) sharpening than the 2013 version.
  *
  * When upsampling, these kernels map to `nearest`, `linear` and `cubic` interpolators.
  * Downsampling kernels without a matching upsampling interpolator map to `cubic`.
@@ -339,7 +343,7 @@ function resize (widthOrOptions, height, options) {
     }
   }
   if (isRotationExpected(this.options) && isResizeExpected(this.options)) {
-    this.options.rotateBeforePreExtract = true;
+    this.options.rotateBefore = true;
   }
   return this;
 }
@@ -382,48 +386,52 @@ function resize (widthOrOptions, height, options) {
  *   ...
  *
  * @param {(number|Object)} extend - single pixel count to add to all edges or an Object with per-edge counts
- * @param {number} [extend.top=0]
- * @param {number} [extend.left=0]
- * @param {number} [extend.bottom=0]
- * @param {number} [extend.right=0]
+ * @param {number} [extend.top=0] - number of pixels to add to the top edge, valid values are integers in the range 0-10000
+ * @param {number} [extend.left=0] - number of pixels to add to the left edge, valid values are integers in the range 0-10000
+ * @param {number} [extend.bottom=0] - number of pixels to add to the bottom edge, valid values are integers in the range 0-10000
+ * @param {number} [extend.right=0] - number of pixels to add to the right edge, valid values are integers in the range 0-10000
  * @param {String} [extend.extendWith='background'] - populate new pixels using this method, one of: background, copy, repeat, mirror.
  * @param {String|Object} [extend.background={r: 0, g: 0, b: 0, alpha: 1}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
 */
 function extend (extend) {
-  if (is.integer(extend) && extend > 0) {
-    this.options.extendTop = extend;
-    this.options.extendBottom = extend;
-    this.options.extendLeft = extend;
-    this.options.extendRight = extend;
+  if (is.integer(extend)) {
+    if (is.inRange(extend, 1, 10000)) {
+      this.options.extendTop = extend;
+      this.options.extendBottom = extend;
+      this.options.extendLeft = extend;
+      this.options.extendRight = extend;
+    } else {
+      throw is.invalidParameterError('extend', 'integer between 1 and 10000', extend);
+    }
   } else if (is.object(extend)) {
     if (is.defined(extend.top)) {
-      if (is.integer(extend.top) && extend.top >= 0) {
+      if (is.integer(extend.top) && is.inRange(extend.top, 0, 10000)) {
         this.options.extendTop = extend.top;
       } else {
-        throw is.invalidParameterError('top', 'positive integer', extend.top);
+        throw is.invalidParameterError('top', 'integer between 0 and 10000', extend.top);
       }
     }
     if (is.defined(extend.bottom)) {
-      if (is.integer(extend.bottom) && extend.bottom >= 0) {
+      if (is.integer(extend.bottom) && is.inRange(extend.bottom, 0, 10000)) {
         this.options.extendBottom = extend.bottom;
       } else {
-        throw is.invalidParameterError('bottom', 'positive integer', extend.bottom);
+        throw is.invalidParameterError('bottom', 'integer between 0 and 10000', extend.bottom);
       }
     }
     if (is.defined(extend.left)) {
-      if (is.integer(extend.left) && extend.left >= 0) {
+      if (is.integer(extend.left) && is.inRange(extend.left, 0, 10000)) {
         this.options.extendLeft = extend.left;
       } else {
-        throw is.invalidParameterError('left', 'positive integer', extend.left);
+        throw is.invalidParameterError('left', 'integer between 0 and 10000', extend.left);
       }
     }
     if (is.defined(extend.right)) {
-      if (is.integer(extend.right) && extend.right >= 0) {
+      if (is.integer(extend.right) && is.inRange(extend.right, 0, 10000)) {
         this.options.extendRight = extend.right;
       } else {
-        throw is.invalidParameterError('right', 'positive integer', extend.right);
+        throw is.invalidParameterError('right', 'integer between 0 and 10000', extend.right);
       }
     }
     this._setBackgroundColourOption('extendBackground', extend.background);
@@ -463,10 +471,10 @@ function extend (extend) {
  *   });
  *
  * @param {Object} options - describes the region to extract using integral pixel values
- * @param {number} options.left - zero-indexed offset from left edge
- * @param {number} options.top - zero-indexed offset from top edge
- * @param {number} options.width - width of region to extract
- * @param {number} options.height - height of region to extract
+ * @param {number} options.left - zero-indexed offset from left edge, an integer between 0 and 100000000
+ * @param {number} options.top - zero-indexed offset from top edge, an integer between 0 and 100000000
+ * @param {number} options.width - width of region to extract, an integer between 0 and 100000000
+ * @param {number} options.height - height of region to extract, an integer between 0 and 100000000
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -477,18 +485,21 @@ function extract (options) {
   }
   ['left', 'top', 'width', 'height'].forEach(function (name) {
     const value = options[name];
-    if (is.integer(value) && value >= 0) {
+    if (is.integer(value) && is.inRange(value, 0, 100000000)) {
       this.options[name + (name === 'left' || name === 'top' ? 'Offset' : '') + suffix] = value;
     } else {
-      throw is.invalidParameterError(name, 'integer', value);
+      throw is.invalidParameterError(name, 'integer between 0 and 100000000', value);
     }
   }, this);
   // Ensure existing rotation occurs before pre-resize extraction
   if (isRotationExpected(this.options) && !isResizeExpected(this.options)) {
     if (this.options.widthPre === -1 || this.options.widthPost === -1) {
-      this.options.rotateBeforePreExtract = true;
+      this.options.rotateBefore = true;
     }
   }
+  if (this.options.input.autoOrient) {
+    this.options.orientBefore = true;
+  }
   return this;
 }
 
@@ -499,6 +510,8 @@ function extract (options) {
  *
  * If the result of this operation would trim an image to nothing then no change is made.
  *
+ * Use the `lineArt` and `threshold` options for control over sensitivity.
+ *
  * The `info` response Object will contain `trimOffsetLeft` and `trimOffsetTop` properties.
  *
  * @example
@@ -533,10 +546,19 @@ function extract (options) {
  *   })
  *   .toBuffer();
  *
+ * @example
+ * // Trim image leaving (up to) a 10 pixel margin around the trimmed content.
+ * const output = await sharp(input)
+ *   .trim({
+ *     margin: 10
+ *   })
+ *   .toBuffer();
+ *
  * @param {Object} [options]
  * @param {string|Object} [options.background='top-left pixel'] - Background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to that of the top-left pixel.
  * @param {number} [options.threshold=10] - Allowed difference from the above colour, a positive number.
  * @param {boolean} [options.lineArt=false] - Does the input more closely resemble line art (e.g. vector) rather than being photographic?
+ * @param {number} [options.margin=0] - Leave a margin around trimmed content, integral number of pixels between 0 and 10000000.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -557,21 +579,29 @@ function trim (options) {
       if (is.defined(options.lineArt)) {
         this._setBooleanOption('trimLineArt', options.lineArt);
       }
+      if (is.defined(options.margin)) {
+        if (is.integer(options.margin) && is.inRange(options.margin, 0, 10000000)) {
+          this.options.trimMargin = options.margin;
+        } else {
+          throw is.invalidParameterError('margin', 'integer between 0 and 10000000', options.margin);
+        }
+      }
     } else {
       throw is.invalidParameterError('trim', 'object', options);
     }
   }
   if (isRotationExpected(this.options)) {
-    this.options.rotateBeforePreExtract = true;
+    this.options.rotateBefore = true;
   }
   return this;
 }
 
 /**
  * Decorate the Sharp prototype with resize-related functions.
+ * @module Sharp
  * @private
  */
-module.exports = function (Sharp) {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
     resize,
     extend,

package/dist/sharp.cjs

@@ -0,0 +1,174 @@
+/*!
+  Copyright 2013 Lovell Fuller and others.
+  SPDX-License-Identifier: Apache-2.0
+*/
+
+// Inspects the runtime environment and exports the relevant sharp.node binary
+
+
+const { familySync, versionSync } = require("detect-libc");
+
+const libvips = require("./libvips.cjs");
+const pkg = require('../package.json');
+
+
+const { version } = pkg;
+
+const { runtimePlatformArch, isUnsupportedNodeRuntime, prebuiltPlatforms, minimumLibvipsVersion } = libvips;
+const runtimePlatform = runtimePlatformArch();
+
+/* node:coverage disable */
+
+let sharp;
+const errors = [];
+try {
+  sharp = require(`../src/build/Release/sharp-${runtimePlatform}-${version}.node`);
+} catch (err) {
+  errors.push(err);
+}
+if (!sharp) {
+  try {
+    sharp = require(`../src/build/Release/sharp-wasm32-${version}.node`);
+  } catch (err) {
+    errors.push(err);
+  }
+}
+if (!sharp) {
+  try {
+    switch (runtimePlatform) {
+      case "darwin-arm64":
+        sharp = require("@img/sharp-darwin-arm64/sharp.node");
+        break;
+      case "darwin-x64":
+        sharp = require("@img/sharp-darwin-x64/sharp.node");
+        break;
+      case "linux-arm":
+        sharp = require("@img/sharp-linux-arm/sharp.node");
+        break;
+      case "linux-arm64":
+        sharp = require("@img/sharp-linux-arm64/sharp.node");
+        break;
+      case "linux-ppc64":
+        sharp = require("@img/sharp-linux-ppc64/sharp.node");
+        break;
+      case "linux-riscv64":
+        sharp = require("@img/sharp-linux-riscv64/sharp.node");
+        break;
+      case "linux-s390x":
+        sharp = require("@img/sharp-linux-s390x/sharp.node");
+        break;
+      case "linux-x64":
+        sharp = require("@img/sharp-linux-x64/sharp.node");
+        break;
+      case "linuxmusl-arm64":
+        sharp = require("@img/sharp-linuxmusl-arm64/sharp.node");
+        break;
+      case "linuxmusl-x64":
+        sharp = require("@img/sharp-linuxmusl-x64/sharp.node");
+        break;
+      case "win32-arm64":
+        sharp = require("@img/sharp-win32-arm64/sharp.node");
+        break;
+      case "win32-ia32":
+        sharp = require("@img/sharp-win32-ia32/sharp.node");
+        break;
+      case "win32-x64":
+        sharp = require("@img/sharp-win32-x64/sharp.node");
+        break;
+      case "freebsd-arm64":
+      case "freebsd-x64":
+        sharp = require("@img/sharp-freebsd-wasm32/sharp.node");
+        break;
+      case "linux-wasm32":
+        sharp = require("@img/sharp-webcontainers-wasm32/sharp.node");
+        break;
+    }
+    if (sharp && ["linux-x64", "linuxmusl-x64"].includes(runtimePlatform) && !sharp._isUsingX64V2()) {
+      const err = new Error("Prebuilt binaries for Linux x64 require v2 microarchitecture");
+      err.code = "Unsupported CPU";
+      errors.push(err);
+      sharp = null;
+    }
+    if (sharp && process.versions.electron && runtimePlatform.startsWith("linux")) {
+      process.emitWarning(
+        "Binaries provided by Electron for use on Linux may be incompatible with sharp - see https://sharp.pixelplumbing.com/install#electron-and-linux",
+        { code: "SharpElectronLinux" }
+      );
+    }
+  } catch (err) {
+    errors.push(err);
+  }
+}
+if (!sharp) {
+  try {
+    sharp = require("@img/sharp-wasm32/sharp.node");
+  } catch (err) {
+    errors.push(err);
+  }
+}
+
+if (!sharp) {
+  const [isLinux, isMacOs, isWindows] = ["linux", "darwin", "win32"].map((os) => runtimePlatform.startsWith(os));
+
+  const help = [`Could not load the "sharp" module using the ${runtimePlatform} runtime`];
+  errors.forEach((err) => {
+    if (!err.code.endsWith("MODULE_NOT_FOUND")) {
+      help.push(`${err.code}: ${err.message}`);
+    }
+  });
+  const messages = errors.map((err) => err.message).join(" ");
+  help.push("Possible solutions:");
+  // Common error messages
+  if (isUnsupportedNodeRuntime()) {
+    const { found, expected } = isUnsupportedNodeRuntime();
+    help.push("- Please upgrade Node.js:", `    Found ${found}`, `    Requires ${expected}`);
+  } else if (prebuiltPlatforms.includes(runtimePlatform)) {
+    const [os, cpu] = runtimePlatform.split("-");
+    const libc = os.endsWith("musl") ? " --libc=musl" : "";
+    help.push(
+      "- Ensure optional dependencies can be installed:",
+      "    npm install --include=optional sharp",
+      "- Ensure your package manager supports multi-platform installation:",
+      "    See https://sharp.pixelplumbing.com/install#cross-platform",
+      "- Add platform-specific dependencies:",
+      `    npm install --os=${os.replace("musl", "")}${libc} --cpu=${cpu} sharp`,
+    );
+  } else {
+    help.push(
+      `- Manually install libvips >= ${minimumLibvipsVersion}`,
+      "    See https://sharp.pixelplumbing.com/install#building-from-source",
+      "- Add WebAssembly-based dependencies:",
+      "    npm install sharp @img/sharp-wasm32",
+    );
+  }
+  if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {
+    try {
+      const { config } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
+      const libcFound = `${familySync()} ${versionSync()}`;
+      const libcRequires = `${config.musl ? "musl" : "glibc"} ${config.musl || config.glibc}`;
+      help.push("- Update your OS:", `    Found ${libcFound}`, `    Requires ${libcRequires}`);
+    } catch (_errEngines) {}
+  }
+  if (isLinux && /\/snap\/core[0-9]{2}/.test(messages)) {
+    help.push("- Remove the Node.js Snap, which does not support native modules", "    snap remove node");
+  }
+  if (isMacOs && /Incompatible library version/.test(messages)) {
+    help.push("- Update Homebrew:", "    brew update && brew upgrade vips");
+  }
+  if (errors.some((err) => err.code === "ERR_DLOPEN_DISABLED")) {
+    help.push("- Run Node.js without using the --no-addons flag");
+  }
+  // Link to installation docs
+  if (isWindows && /The specified procedure could not be found/.test(messages)) {
+    help.push(
+      "- Using the canvas package on Windows?",
+      "    See https://sharp.pixelplumbing.com/install#canvas-and-windows",
+      "- Check for outdated versions of sharp in the dependency tree:",
+      "    npm ls sharp",
+    );
+  }
+  help.push("- Consult the installation documentation:", "    See https://sharp.pixelplumbing.com/install");
+  throw new Error(help.join("\n"));
+}
+
+module.exports = sharp;

package/dist/sharp.mjs

@@ -0,0 +1,174 @@
+/*!
+  Copyright 2013 Lovell Fuller and others.
+  SPDX-License-Identifier: Apache-2.0
+*/
+
+// Inspects the runtime environment and exports the relevant sharp.node binary
+
+import { createRequire } from "node:module"
+import { familySync, versionSync } from "detect-libc";
+
+import libvips from "./libvips.mjs";
+import pkg from '../package.json' with { type: 'json' };
+
+const require = createRequire(import.meta.url);
+const { version } = pkg;
+
+const { runtimePlatformArch, isUnsupportedNodeRuntime, prebuiltPlatforms, minimumLibvipsVersion } = libvips;
+const runtimePlatform = runtimePlatformArch();
+
+/* node:coverage disable */
+
+let sharp;
+const errors = [];
+try {
+  sharp = require(`../src/build/Release/sharp-${runtimePlatform}-${version}.node`);
+} catch (err) {
+  errors.push(err);
+}
+if (!sharp) {
+  try {
+    sharp = require(`../src/build/Release/sharp-wasm32-${version}.node`);
+  } catch (err) {
+    errors.push(err);
+  }
+}
+if (!sharp) {
+  try {
+    switch (runtimePlatform) {
+      case "darwin-arm64":
+        sharp = require("@img/sharp-darwin-arm64/sharp.node");
+        break;
+      case "darwin-x64":
+        sharp = require("@img/sharp-darwin-x64/sharp.node");
+        break;
+      case "linux-arm":
+        sharp = require("@img/sharp-linux-arm/sharp.node");
+        break;
+      case "linux-arm64":
+        sharp = require("@img/sharp-linux-arm64/sharp.node");
+        break;
+      case "linux-ppc64":
+        sharp = require("@img/sharp-linux-ppc64/sharp.node");
+        break;
+      case "linux-riscv64":
+        sharp = require("@img/sharp-linux-riscv64/sharp.node");
+        break;
+      case "linux-s390x":
+        sharp = require("@img/sharp-linux-s390x/sharp.node");
+        break;
+      case "linux-x64":
+        sharp = require("@img/sharp-linux-x64/sharp.node");
+        break;
+      case "linuxmusl-arm64":
+        sharp = require("@img/sharp-linuxmusl-arm64/sharp.node");
+        break;
+      case "linuxmusl-x64":
+        sharp = require("@img/sharp-linuxmusl-x64/sharp.node");
+        break;
+      case "win32-arm64":
+        sharp = require("@img/sharp-win32-arm64/sharp.node");
+        break;
+      case "win32-ia32":
+        sharp = require("@img/sharp-win32-ia32/sharp.node");
+        break;
+      case "win32-x64":
+        sharp = require("@img/sharp-win32-x64/sharp.node");
+        break;
+      case "freebsd-arm64":
+      case "freebsd-x64":
+        sharp = require("@img/sharp-freebsd-wasm32/sharp.node");
+        break;
+      case "linux-wasm32":
+        sharp = require("@img/sharp-webcontainers-wasm32/sharp.node");
+        break;
+    }
+    if (sharp && ["linux-x64", "linuxmusl-x64"].includes(runtimePlatform) && !sharp._isUsingX64V2()) {
+      const err = new Error("Prebuilt binaries for Linux x64 require v2 microarchitecture");
+      err.code = "Unsupported CPU";
+      errors.push(err);
+      sharp = null;
+    }
+    if (sharp && process.versions.electron && runtimePlatform.startsWith("linux")) {
+      process.emitWarning(
+        "Binaries provided by Electron for use on Linux may be incompatible with sharp - see https://sharp.pixelplumbing.com/install#electron-and-linux",
+        { code: "SharpElectronLinux" }
+      );
+    }
+  } catch (err) {
+    errors.push(err);
+  }
+}
+if (!sharp) {
+  try {
+    sharp = require("@img/sharp-wasm32/sharp.node");
+  } catch (err) {
+    errors.push(err);
+  }
+}
+
+if (!sharp) {
+  const [isLinux, isMacOs, isWindows] = ["linux", "darwin", "win32"].map((os) => runtimePlatform.startsWith(os));
+
+  const help = [`Could not load the "sharp" module using the ${runtimePlatform} runtime`];
+  errors.forEach((err) => {
+    if (!err.code.endsWith("MODULE_NOT_FOUND")) {
+      help.push(`${err.code}: ${err.message}`);
+    }
+  });
+  const messages = errors.map((err) => err.message).join(" ");
+  help.push("Possible solutions:");
+  // Common error messages
+  if (isUnsupportedNodeRuntime()) {
+    const { found, expected } = isUnsupportedNodeRuntime();
+    help.push("- Please upgrade Node.js:", `    Found ${found}`, `    Requires ${expected}`);
+  } else if (prebuiltPlatforms.includes(runtimePlatform)) {
+    const [os, cpu] = runtimePlatform.split("-");
+    const libc = os.endsWith("musl") ? " --libc=musl" : "";
+    help.push(
+      "- Ensure optional dependencies can be installed:",
+      "    npm install --include=optional sharp",
+      "- Ensure your package manager supports multi-platform installation:",
+      "    See https://sharp.pixelplumbing.com/install#cross-platform",
+      "- Add platform-specific dependencies:",
+      `    npm install --os=${os.replace("musl", "")}${libc} --cpu=${cpu} sharp`,
+    );
+  } else {
+    help.push(
+      `- Manually install libvips >= ${minimumLibvipsVersion}`,
+      "    See https://sharp.pixelplumbing.com/install#building-from-source",
+      "- Add WebAssembly-based dependencies:",
+      "    npm install sharp @img/sharp-wasm32",
+    );
+  }
+  if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {
+    try {
+      const { config } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
+      const libcFound = `${familySync()} ${versionSync()}`;
+      const libcRequires = `${config.musl ? "musl" : "glibc"} ${config.musl || config.glibc}`;
+      help.push("- Update your OS:", `    Found ${libcFound}`, `    Requires ${libcRequires}`);
+    } catch (_errEngines) {}
+  }
+  if (isLinux && /\/snap\/core[0-9]{2}/.test(messages)) {
+    help.push("- Remove the Node.js Snap, which does not support native modules", "    snap remove node");
+  }
+  if (isMacOs && /Incompatible library version/.test(messages)) {
+    help.push("- Update Homebrew:", "    brew update && brew upgrade vips");
+  }
+  if (errors.some((err) => err.code === "ERR_DLOPEN_DISABLED")) {
+    help.push("- Run Node.js without using the --no-addons flag");
+  }
+  // Link to installation docs
+  if (isWindows && /The specified procedure could not be found/.test(messages)) {
+    help.push(
+      "- Using the canvas package on Windows?",
+      "    See https://sharp.pixelplumbing.com/install#canvas-and-windows",
+      "- Check for outdated versions of sharp in the dependency tree:",
+      "    npm ls sharp",
+    );
+  }
+  help.push("- Consult the installation documentation:", "    See https://sharp.pixelplumbing.com/install");
+  throw new Error(help.join("\n"));
+}
+
+export default sharp;