sharp 0.33.5 → 0.35.0

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;
 }
@@ -486,9 +490,12 @@ function extract (options) {
   // 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 +506,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 +542,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, value is in pixels.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -557,21 +575,29 @@ function trim (options) {
       if (is.defined(options.lineArt)) {
         this._setBooleanOption('trimLineArt', options.lineArt);
       }
+      if (is.defined(options.margin)) {
+        if (is.integer(options.margin) && options.margin >= 0) {
+          this.options.trimMargin = options.margin;
+        } else {
+          throw is.invalidParameterError('margin', 'positive integer', 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,164 @@
+/*!
+  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;
+      default:
+        sharp = require("@img/sharp-wasm32/sharp.node");
+        break;
+    }
+    if (["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;
+    }
+  } 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,164 @@
+/*!
+  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;
+      default:
+        sharp = require("@img/sharp-wasm32/sharp.node");
+        break;
+    }
+    if (["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;
+    }
+  } 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;

package/{lib/utility.js → dist/utility.cjs}

@@ -1,16 +1,20 @@
-// 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 events = require('node:events');
+
+const { availableParallelism } = require("node:os");
 const detectLibc = require('detect-libc');
 
-const is = require('./is');
-const { runtimePlatformArch } = require('./libvips');
-const sharp = require('./sharp');
+const is = require('./is.cjs');
+const libvips = require('./libvips.cjs');
+const sharp = require('./sharp.cjs');
+const pkg = require("../package.json");
+
 
-const runtimePlatform = runtimePlatformArch();
+const runtimePlatform = libvips.runtimePlatformArch();
 const libvipsVersion = sharp.libvipsVersion();
 
 /**
@@ -24,7 +28,7 @@ const format = sharp.format();
 format.heif.output.alias = ['avif', 'heic'];
 format.jpeg.output.alias = ['jpe', 'jpg'];
 format.tiff.output.alias = ['tif'];
-format.jp2k.output.alias = ['j2c', 'j2k', 'jp2', 'jpx'];
+format.jp2.output.alias = ['j2c', 'j2k', 'jp2', 'jpx'];
 
 /**
  * An Object containing the available interpolators and their proper values
@@ -57,7 +61,7 @@ const interpolators = {
 let versions = {
   vips: libvipsVersion.semver
 };
-/* istanbul ignore next */
+/* node:coverage ignore next 15 */
 if (!libvipsVersion.isGlobal) {
   if (!libvipsVersion.isWasm) {
     try {
@@ -73,9 +77,9 @@ if (!libvipsVersion.isGlobal) {
     } catch (_) {}
   }
 }
-versions.sharp = require('../package.json').version;
+versions.sharp = pkg.version;
 
-/* istanbul ignore next */
+/* node:coverage ignore next 5 */
 if (versions.heif && format.heif) {
   // Prebuilt binaries provide AV1
   format.heif.input.fileSuffix = ['.avif'];
@@ -135,15 +139,9 @@ cache(true);
  * e.g. libaom manages its own 4 threads when encoding AVIF images,
  * and these are independent of the value set here.
  *
- * The maximum number of images that sharp can process in parallel
- * is controlled by libuv's `UV_THREADPOOL_SIZE` environment variable,
- * which defaults to 4.
- *
- * https://nodejs.org/api/cli.html#uv_threadpool_sizesize
- *
- * For example, by default, a machine with 8 CPU cores will process
- * 4 images in parallel and use up to 8 threads per image,
- * so there will be up to 32 concurrent threads.
+ * :::note
+ * Further {@link /performance/ control over performance} is available.
+ * :::
  *
  * @example
  * const threads = sharp.concurrency(); // 4
@@ -156,13 +154,13 @@ cache(true);
 function concurrency (concurrency) {
   return sharp.concurrency(is.integer(concurrency) ? concurrency : null);
 }
-/* istanbul ignore next */
+/* node:coverage ignore next 7 */
 if (detectLibc.familySync() === detectLibc.GLIBC && !sharp._isUsingJemalloc()) {
   // Reduce default concurrency to 1 when using glibc memory allocator
   sharp.concurrency(1);
 } else if (detectLibc.familySync() === detectLibc.MUSL && sharp.concurrency() === 1024) {
   // Reduce default concurrency when musl thread over-subscription detected
-  sharp.concurrency(require('node:os').availableParallelism());
+  sharp.concurrency(availableParallelism());
 }
 
 /**
@@ -280,9 +278,10 @@ function unblock (options) {
 
 /**
  * Decorate the Sharp class with utility-related functions.
+ * @module Sharp
  * @private
  */
-module.exports = function (Sharp) {
+module.exports = (Sharp) => {
   Sharp.cache = cache;
   Sharp.concurrency = concurrency;
   Sharp.counters = counters;