sharp 0.32.6 → 0.33.0-alpha.11

package/lib/output.js

@@ -3,7 +3,7 @@
 
 'use strict';
 
-const path = require('path');
+const path = require('node:path');
 const is = require('./is');
 const sharp = require('./sharp');
 
@@ -86,7 +86,8 @@ function toFile (fileOut, callback) {
     }
   } else {
     this.options.fileOut = fileOut;
-    return this._pipeline(callback);
+    const stack = Error();
+    return this._pipeline(callback, stack);
   }
   return this;
 }
@@ -157,7 +158,8 @@ function toBuffer (options, callback) {
     this.options.resolveWithObject = false;
   }
   this.options.fileOut = '';
-  return this._pipeline(is.fn(options) ? options : callback);
+  const stack = Error();
+  return this._pipeline(is.fn(options) ? options : callback, stack);
 }
 
 /**
@@ -780,6 +782,7 @@ function trySetAnimationOptions (source, target) {
  * @param {number} [options.yres=1.0] - vertical resolution in pixels/mm
  * @param {string} [options.resolutionUnit='inch'] - resolution unit options: inch, cm
  * @param {number} [options.bitdepth=8] - reduce bitdepth to 1, 2 or 4 bit
+ * @param {boolean} [options.miniswhite=false] - write 1-bit images as miniswhite
  * @returns {Sharp}
  * @throws {Error} Invalid options
  */
@@ -817,6 +820,10 @@ function tiff (options) {
         throw is.invalidParameterError('tileHeight', 'integer greater than zero', options.tileHeight);
       }
     }
+    // miniswhite
+    if (is.defined(options.miniswhite)) {
+      this._setBooleanOption('tiffMiniswhite', options.miniswhite);
+    }
     // pyramid
     if (is.defined(options.pyramid)) {
       this._setBooleanOption('tiffPyramid', options.pyramid);
@@ -867,9 +874,6 @@ function tiff (options) {
 /**
  * Use these AVIF options for output image.
  *
- * Whilst it is possible to create AVIF images smaller than 16x16 pixels,
- * most web browsers do not display these properly.
- *
  * AVIF image sequences are not supported.
  *
  * @example
@@ -909,9 +913,9 @@ function avif (options) {
  *
  * @since 0.23.0
  *
- * @param {Object} [options] - output options
+ * @param {Object} options - output options
+ * @param {string} options.compression - compression format: av1, hevc
  * @param {number} [options.quality=50] - quality, integer 1-100
- * @param {string} [options.compression='av1'] - compression format: av1, hevc
  * @param {boolean} [options.lossless=false] - use lossless compression
  * @param {number} [options.effort=4] - CPU effort, between 0 (fastest) and 9 (slowest)
  * @param {string} [options.chromaSubsampling='4:4:4'] - set to '4:2:0' to use chroma subsampling
@@ -920,6 +924,11 @@ function avif (options) {
  */
 function heif (options) {
   if (is.object(options)) {
+    if (is.string(options.compression) && is.inArray(options.compression, ['av1', 'hevc'])) {
+      this.options.heifCompression = options.compression;
+    } else {
+      throw is.invalidParameterError('compression', 'one of: av1, hevc', options.compression);
+    }
     if (is.defined(options.quality)) {
       if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
         this.options.heifQuality = options.quality;
@@ -934,13 +943,6 @@ function heif (options) {
         throw is.invalidParameterError('lossless', 'boolean', options.lossless);
       }
     }
-    if (is.defined(options.compression)) {
-      if (is.string(options.compression) && is.inArray(options.compression, ['av1', 'hevc'])) {
-        this.options.heifCompression = options.compression;
-      } else {
-        throw is.invalidParameterError('compression', 'one of: av1, hevc', options.compression);
-      }
-    }
     if (is.defined(options.effort)) {
       if (is.integer(options.effort) && is.inRange(options.effort, 0, 9)) {
         this.options.heifEffort = options.effort;
@@ -955,6 +957,8 @@ function heif (options) {
         throw is.invalidParameterError('chromaSubsampling', 'one of: 4:2:0, 4:4:4', options.chromaSubsampling);
       }
     }
+  } else {
+    throw is.invalidParameterError('options', 'Object', options);
   }
   return this._updateFormatOut('heif', options);
 }
@@ -1285,7 +1289,8 @@ function _read () {
   /* istanbul ignore else */
   if (!this.options.streamOut) {
     this.options.streamOut = true;
-    this._pipeline();
+    const stack = Error();
+    this._pipeline(undefined, stack);
   }
 }
 
@@ -1294,18 +1299,30 @@ function _read () {
  * Supports callback, stream and promise variants
  * @private
  */
-function _pipeline (callback) {
+function _pipeline (callback, stack) {
   if (typeof callback === 'function') {
     // output=file/buffer
     if (this._isStreamInput()) {
       // output=file/buffer, input=stream
       this.on('finish', () => {
         this._flattenBufferIn();
-        sharp.pipeline(this.options, callback);
+        sharp.pipeline(this.options, (err, data, info) => {
+          if (err) {
+            callback(is.nativeError(err, stack));
+          } else {
+            callback(null, data, info);
+          }
+        });
       });
     } else {
       // output=file/buffer, input=file/buffer
-      sharp.pipeline(this.options, callback);
+      sharp.pipeline(this.options, (err, data, info) => {
+        if (err) {
+          callback(is.nativeError(err, stack));
+        } else {
+          callback(null, data, info);
+        }
+      });
     }
     return this;
   } else if (this.options.streamOut) {
@@ -1316,7 +1333,7 @@ function _pipeline (callback) {
         this._flattenBufferIn();
         sharp.pipeline(this.options, (err, data, info) => {
           if (err) {
-            this.emit('error', err);
+            this.emit('error', is.nativeError(err, stack));
           } else {
             this.emit('info', info);
             this.push(data);
@@ -1332,7 +1349,7 @@ function _pipeline (callback) {
       // output=stream, input=file/buffer
       sharp.pipeline(this.options, (err, data, info) => {
         if (err) {
-          this.emit('error', err);
+          this.emit('error', is.nativeError(err, stack));
         } else {
           this.emit('info', info);
           this.push(data);
@@ -1351,7 +1368,7 @@ function _pipeline (callback) {
           this._flattenBufferIn();
           sharp.pipeline(this.options, (err, data, info) => {
             if (err) {
-              reject(err);
+              reject(is.nativeError(err, stack));
             } else {
               if (this.options.resolveWithObject) {
                 resolve({ data, info });
@@ -1367,10 +1384,10 @@ function _pipeline (callback) {
       return new Promise((resolve, reject) => {
         sharp.pipeline(this.options, (err, data, info) => {
           if (err) {
-            reject(err);
+            reject(is.nativeError(err, stack));
           } else {
             if (this.options.resolveWithObject) {
-              resolve({ data: data, info: info });
+              resolve({ data, info });
             } else {
               resolve(data);
             }

package/lib/resize.js

@@ -250,6 +250,9 @@ function resize (widthOrOptions, height, options) {
   if (isResizeExpected(this.options)) {
     this.options.debuglog('ignoring previous resize options');
   }
+  if (this.options.widthPost !== -1) {
+    this.options.debuglog('operation order will be: extract, resize, extract');
+  }
   if (is.defined(widthOrOptions)) {
     if (is.object(widthOrOptions) && !is.defined(options)) {
       options = widthOrOptions;
@@ -437,7 +440,7 @@ function extend (extend) {
  *
  * - Use `extract` before `resize` for pre-resize extraction.
  * - Use `extract` after `resize` for post-resize extraction.
- * - Use `extract` before and after for both.
+ * - Use `extract` twice and `resize` once for extract-then-resize-then-extract in a fixed operation order.
  *
  * @example
  * sharp(input)
@@ -491,70 +494,67 @@ function extract (options) {
  *
  * If the result of this operation would trim an image to nothing then no change is made.
  *
- * The `info` response Object, obtained from callback of `.toFile()` or `.toBuffer()`,
- * will contain `trimOffsetLeft` and `trimOffsetTop` properties.
+ * The `info` response Object will contain `trimOffsetLeft` and `trimOffsetTop` properties.
  *
  * @example
  * // Trim pixels with a colour similar to that of the top-left pixel.
- * sharp(input)
+ * await sharp(input)
  *   .trim()
- *   .toFile(output, function(err, info) {
- *     ...
- *   });
+ *   .toFile(output);
+ *
  * @example
  * // Trim pixels with the exact same colour as that of the top-left pixel.
- * sharp(input)
- *   .trim(0)
- *   .toFile(output, function(err, info) {
- *     ...
- *   });
+ * await sharp(input)
+ *   .trim({
+ *     threshold: 0
+ *   })
+ *   .toFile(output);
+ *
  * @example
- * // Trim only pixels with a similar colour to red.
- * sharp(input)
- *   .trim("#FF0000")
- *   .toFile(output, function(err, info) {
- *     ...
- *   });
+ * // Assume input is line art and trim only pixels with a similar colour to red.
+ * const output = await sharp(input)
+ *   .trim({
+ *     background: "#FF0000",
+ *     lineArt: true
+ *   })
+ *   .toBuffer();
+ *
  * @example
  * // Trim all "yellow-ish" pixels, being more lenient with the higher threshold.
- * sharp(input)
+ * const output = await sharp(input)
  *   .trim({
  *     background: "yellow",
  *     threshold: 42,
  *   })
- *   .toFile(output, function(err, info) {
- *     ...
- *   });
+ *   .toBuffer();
  *
- * @param {string|number|Object} trim - the specific background colour to trim, the threshold for doing so or an Object with both.
- * @param {string|Object} [trim.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} [trim.threshold=10] - the allowed difference from the above colour, a positive number.
+ * @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?
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
-function trim (trim) {
-  if (!is.defined(trim)) {
-    this.options.trimThreshold = 10;
-  } else if (is.string(trim)) {
-    this._setBackgroundColourOption('trimBackground', trim);
-    this.options.trimThreshold = 10;
-  } else if (is.number(trim)) {
-    if (trim >= 0) {
-      this.options.trimThreshold = trim;
-    } else {
-      throw is.invalidParameterError('threshold', 'positive number', trim);
-    }
-  } else if (is.object(trim)) {
-    this._setBackgroundColourOption('trimBackground', trim.background);
-    if (!is.defined(trim.threshold)) {
-      this.options.trimThreshold = 10;
-    } else if (is.number(trim.threshold) && trim.threshold >= 0) {
-      this.options.trimThreshold = trim.threshold;
+function trim (options) {
+  this.options.trimThreshold = 10;
+  if (is.defined(options)) {
+    if (is.object(options)) {
+      if (is.defined(options.background)) {
+        this._setBackgroundColourOption('trimBackground', options.background);
+      }
+      if (is.defined(options.threshold)) {
+        if (is.number(options.threshold) && options.threshold >= 0) {
+          this.options.trimThreshold = options.threshold;
+        } else {
+          throw is.invalidParameterError('threshold', 'positive number', options.threshold);
+        }
+      }
+      if (is.defined(options.lineArt)) {
+        this._setBooleanOption('trimLineArt', options.lineArt);
+      }
     } else {
-      throw is.invalidParameterError('threshold', 'positive number', trim);
+      throw is.invalidParameterError('trim', 'object', options);
     }
-  } else {
-    throw is.invalidParameterError('trim', 'string, number or object', trim);
   }
   if (isRotationExpected(this.options)) {
     this.options.rotateBeforePreExtract = true;

package/lib/sharp.js

@@ -3,36 +3,81 @@
 
 'use strict';
 
-const platformAndArch = require('./platform')();
+// Inspects the runtime environment and exports the relevant sharp.node binary
+
+const { familySync, versionSync } = require('detect-libc');
+
+const { runtimePlatformArch, prebuiltPlatforms, minimumLibvipsVersion } = require('./libvips');
+const runtimePlatform = runtimePlatformArch();
+
+const paths = [
+  `../src/build/Release/sharp-${runtimePlatform}.node`,
+  '../src/build/Release/sharp-wasm32.node',
+  `@img/sharp-${runtimePlatform}/sharp.node`,
+  '@img/sharp-wasm32/sharp.node'
+];
+
+const errors = [];
+for (const path of paths) {
+  try {
+    module.exports = require(path);
+    break;
+  } catch (err) {
+    /* istanbul ignore next */
+    errors.push(err);
+  }
+}
 
 /* istanbul ignore next */
-try {
-  module.exports = require(`../build/Release/sharp-${platformAndArch}.node`);
-} catch (err) {
-  // Bail early if bindings aren't available
-  const help = ['', 'Something went wrong installing the "sharp" module', '', err.message, '', 'Possible solutions:'];
-  if (/dylib/.test(err.message) && /Incompatible library version/.test(err.message)) {
-    help.push('- Update Homebrew: "brew update && brew upgrade vips"');
-  } else {
-    const [platform, arch] = platformAndArch.split('-');
-    if (platform === 'linux' && /Module did not self-register/.test(err.message)) {
-      help.push('- Using worker threads? See https://sharp.pixelplumbing.com/install#worker-threads');
+if (!module.exports) {
+  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 !== 'MODULE_NOT_FOUND') {
+      help.push(`${err.code}: ${err.message}`);
     }
-    help.push(
-      '- Install with verbose logging and look for errors: "npm install --ignore-scripts=false --foreground-scripts --verbose sharp"',
-      `- Install for the current ${platformAndArch} runtime: "npm install --platform=${platform} --arch=${arch} sharp"`
-    );
+  });
+  const messages = errors.map(err => err.message).join(' ');
+  help.push('Possible solutions:');
+  // Common error messages
+  if (prebuiltPlatforms.includes(runtimePlatform)) {
+    const [os, cpu] = runtimePlatform.split('-');
+    help.push('- Add platform-specific dependencies:');
+    help.push(`    npm install --os=${os} --cpu=${cpu} sharp`);
+    help.push('  or');
+    help.push(`    npm install --force @img/sharp-${runtimePlatform}`);
+  } else {
+    help.push(`- Manually install libvips >= ${minimumLibvipsVersion}`);
+    help.push('- Add experimental WebAssembly-based dependencies:');
+    help.push('    npm install --cpu=wasm32 sharp');
   }
-  help.push(
-    '- Consult the installation documentation: https://sharp.pixelplumbing.com/install'
-  );
-  // Check loaded
-  if (process.platform === 'win32' || /symbol/.test(err.message)) {
-    const loadedModule = Object.keys(require.cache).find((i) => /[\\/]build[\\/]Release[\\/]sharp(.*)\.node$/.test(i));
-    if (loadedModule) {
-      const [, loadedPackage] = loadedModule.match(/node_modules[\\/]([^\\/]+)[\\/]/);
-      help.push(`- Ensure the version of sharp aligns with the ${loadedPackage} package: "npm ls sharp"`);
-    }
+  if (isLinux && /symbol not found/i.test(messages)) {
+    try {
+      const { engines } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
+      const libcFound = `${familySync()} ${versionSync()}`;
+      const libcRequires = `${engines.musl ? 'musl' : 'glibc'} ${engines.musl || engines.glibc}`;
+      help.push('- Update your OS:');
+      help.push(`    Found ${libcFound}`);
+      help.push(`    Requires ${libcRequires}`);
+    } catch (errEngines) {}
+  }
+  if (isMacOs && /Incompatible library version/.test(messages)) {
+    help.push('- Update Homebrew:');
+    help.push('    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');
+  }
+  if (process.versions.pnp) {
+    help.push('- Use a supported yarn linker, either pnpm or node-modules:');
+    help.push('    yarn config set nodeLinker node-modules');
+  }
+  // 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');
+  } else {
+    help.push('- Consult the installation documentation: https://sharp.pixelplumbing.com/install');
   }
   throw new Error(help.join('\n'));
 }

package/lib/utility.js

@@ -3,15 +3,16 @@
 
 'use strict';
 
-const fs = require('fs');
-const path = require('path');
-const events = require('events');
+const events = require('node:events');
 const detectLibc = require('detect-libc');
 
 const is = require('./is');
-const platformAndArch = require('./platform')();
+const { runtimePlatformArch } = require('./libvips');
 const sharp = require('./sharp');
 
+const runtimePlatform = runtimePlatformArch();
+const libvipsVersion = sharp.libvipsVersion();
+
 /**
  * An Object containing nested boolean values representing the available input and output formats/methods.
  * @member
@@ -46,34 +47,34 @@ const interpolators = {
 };
 
 /**
- * An Object containing the version numbers of sharp, libvips and its dependencies.
+ * An Object containing the version numbers of sharp, libvips
+ * and (when using prebuilt binaries) its dependencies.
+ *
  * @member
  * @example
  * console.log(sharp.versions);
  */
 let versions = {
-  vips: sharp.libvipsVersion()
+  vips: libvipsVersion.semver
 };
-try {
-  versions = require(`../vendor/${versions.vips}/${platformAndArch}/versions.json`);
-} catch (_err) { /* ignore */ }
+/* istanbul ignore next */
+if (!libvipsVersion.isGlobal) {
+  if (!libvipsVersion.isWasm) {
+    try {
+      versions = require(`@img/sharp-${runtimePlatform}/versions`);
+    } catch (_) {
+      try {
+        versions = require(`@img/sharp-libvips-${runtimePlatform}/versions`);
+      } catch (_) {}
+    }
+  } else {
+    try {
+      versions = require('@img/sharp-wasm32/versions');
+    } catch (_) {}
+  }
+}
 versions.sharp = require('../package.json').version;
 
-/**
- * An Object containing the platform and architecture
- * of the current and installed vendored binaries.
- * @member
- * @example
- * console.log(sharp.vendor);
- */
-const vendor = {
-  current: platformAndArch,
-  installed: []
-};
-try {
-  vendor.installed = fs.readdirSync(path.join(__dirname, `../vendor/${versions.vips}`));
-} catch (_err) { /* ignore */ }
-
 /**
  * Gets or, when options are provided, sets the limits of _libvips'_ operation cache.
  * Existing entries in the cache will be trimmed after any change in limits.
@@ -280,7 +281,6 @@ module.exports = function (Sharp) {
   Sharp.format = format;
   Sharp.interpolators = interpolators;
   Sharp.versions = versions;
-  Sharp.vendor = vendor;
   Sharp.queue = queue;
   Sharp.block = block;
   Sharp.unblock = unblock;