sharp 0.33.0-alpha.8 → 0.33.0-rc.2

package/lib/output.js

@@ -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,43 +158,190 @@ 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);
 }
 
 /**
- * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
- * This will also convert to and add a web-friendly sRGB ICC profile if appropriate,
- * unless a custom output profile is provided.
- *
- * The default behaviour, when `withMetadata` is not used, is to convert to the device-independent
- * sRGB colour space and strip all metadata, including the removal of any ICC profile.
+ * Keep all EXIF metadata from the input image in the output image.
  *
  * EXIF metadata is unsupported for TIFF output.
  *
+ * @since 0.33.0
+ *
  * @example
- * sharp('input.jpg')
- *   .withMetadata()
- *   .toFile('output-with-metadata.jpg')
- *   .then(info => { ... });
+ * const outputWithExif = await sharp(inputWithExif)
+ *   .keepExif()
+ *   .toBuffer();
+ *
+ * @returns {Sharp}
+ */
+function keepExif () {
+  this.options.keepMetadata |= 0b00001;
+  return this;
+}
+
+/**
+ * Set EXIF metadata in the output image, ignoring any EXIF in the input image.
+ *
+ * @since 0.33.0
  *
  * @example
- * // Set output EXIF metadata
- * const data = await sharp(input)
- *   .withMetadata({
- *     exif: {
- *       IFD0: {
- *         Copyright: 'The National Gallery'
- *       },
- *       IFD3: {
- *         GPSLatitudeRef: 'N',
- *         GPSLatitude: '51/1 30/1 3230/100',
- *         GPSLongitudeRef: 'W',
- *         GPSLongitude: '0/1 7/1 4366/100'
- *       }
+ * const dataWithExif = await sharp(input)
+ *   .withExif({
+ *     IFD0: {
+ *       Copyright: 'The National Gallery'
+ *     },
+ *     IFD3: {
+ *       GPSLatitudeRef: 'N',
+ *       GPSLatitude: '51/1 30/1 3230/100',
+ *       GPSLongitudeRef: 'W',
+ *       GPSLongitude: '0/1 7/1 4366/100'
  *     }
  *   })
  *   .toBuffer();
  *
+ * @param {Object<string, Object<string, string>>} exif Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function withExif (exif) {
+  if (is.object(exif)) {
+    for (const [ifd, entries] of Object.entries(exif)) {
+      if (is.object(entries)) {
+        for (const [k, v] of Object.entries(entries)) {
+          if (is.string(v)) {
+            this.options.withExif[`exif-${ifd.toLowerCase()}-${k}`] = v;
+          } else {
+            throw is.invalidParameterError(`${ifd}.${k}`, 'string', v);
+          }
+        }
+      } else {
+        throw is.invalidParameterError(ifd, 'object', entries);
+      }
+    }
+  } else {
+    throw is.invalidParameterError('exif', 'object', exif);
+  }
+  this.options.withExifMerge = false;
+  return this.keepExif();
+}
+
+/**
+ * Update EXIF metadata from the input image in the output image.
+ *
+ * @since 0.33.0
+ *
+ * @example
+ * const dataWithMergedExif = await sharp(inputWithExif)
+ *   .withExifMerge({
+ *     IFD0: {
+ *       Copyright: 'The National Gallery'
+ *     }
+ *   })
+ *   .toBuffer();
+ *
+ * @param {Object<string, Object<string, string>>} exif Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function withExifMerge (exif) {
+  this.withExif(exif);
+  this.options.withExifMerge = true;
+  return this;
+}
+
+/**
+ * Keep ICC profile from the input image in the output image.
+ *
+ * Where necessary, will attempt to convert the output colour space to match the profile.
+ *
+ * @since 0.33.0
+ *
+ * @example
+ * const outputWithIccProfile = await sharp(inputWithIccProfile)
+ *   .keepIccProfile()
+ *   .toBuffer();
+ *
+ * @returns {Sharp}
+ */
+function keepIccProfile () {
+  this.options.keepMetadata |= 0b01000;
+  return this;
+}
+
+/**
+ * Transform using an ICC profile and attach to the output image.
+ *
+ * This can either be an absolute filesystem path or
+ * built-in profile name (`srgb`, `p3`, `cmyk`).
+ *
+ * @since 0.33.0
+ *
+ * @example
+ * const outputWithP3 = await sharp(input)
+ *   .withIccProfile('p3')
+ *   .toBuffer();
+ *
+ * @param {string} icc - Absolute filesystem path to output ICC profile or built-in profile name (srgb, p3, cmyk).
+ * @param {Object} [options]
+ * @param {number} [options.attach=true] Should the ICC profile be included in the output image metadata?
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function withIccProfile (icc, options) {
+  if (is.string(icc)) {
+    this.options.withIccProfile = icc;
+  } else {
+    throw is.invalidParameterError('icc', 'string', icc);
+  }
+  this.keepIccProfile();
+  if (is.object(options)) {
+    if (is.defined(options.attach)) {
+      if (is.bool(options.attach)) {
+        if (!options.attach) {
+          this.options.keepMetadata &= ~0b01000;
+        }
+      } else {
+        throw is.invalidParameterError('attach', 'boolean', options.attach);
+      }
+    }
+  }
+  return this;
+}
+
+/**
+ * Keep all metadata (EXIF, ICC, XMP, IPTC) from the input image in the output image.
+ *
+ * The default behaviour, when `keepMetadata` is not used, is to convert to the device-independent
+ * sRGB colour space and strip all metadata, including the removal of any ICC profile.
+ *
+ * @since 0.33.0
+ *
+ * @example
+ * const outputWithMetadata = await sharp(inputWithMetadata)
+ *   .keepMetadata()
+ *   .toBuffer();
+ *
+ * @returns {Sharp}
+ */
+function keepMetadata () {
+  this.options.keepMetadata = 0b11111;
+  return this;
+}
+
+/**
+ * Keep most metadata (EXIF, XMP, IPTC) from the input image in the output image.
+ *
+ * This will also convert to and add a web-friendly sRGB ICC profile if appropriate.
+ *
+ * Allows orientation and density to be set or updated.
+ *
+ * @example
+ * const outputSrgbWithMetadata = await sharp(inputRgbWithMetadata)
+ *   .withMetadata()
+ *   .toBuffer();
+ *
  * @example
  * // Set output metadata to 96 DPI
  * const data = await sharp(input)
@@ -201,15 +349,14 @@ function toBuffer (options, callback) {
  *   .toBuffer();
  *
  * @param {Object} [options]
- * @param {number} [options.orientation] value between 1 and 8, used to update the EXIF `Orientation` tag.
- * @param {string} [options.icc='srgb'] Filesystem path to output ICC profile, relative to `process.cwd()`, defaults to built-in sRGB.
- * @param {Object<Object>} [options.exif={}] Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
+ * @param {number} [options.orientation] Used to update the EXIF `Orientation` tag, integer between 1 and 8.
  * @param {number} [options.density] Number of pixels per inch (DPI).
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
 function withMetadata (options) {
-  this.options.withMetadata = is.bool(options) ? options : true;
+  this.keepMetadata();
+  this.withIccProfile('srgb');
   if (is.object(options)) {
     if (is.defined(options.orientation)) {
       if (is.integer(options.orientation) && is.inRange(options.orientation, 1, 8)) {
@@ -226,30 +373,10 @@ function withMetadata (options) {
       }
     }
     if (is.defined(options.icc)) {
-      if (is.string(options.icc)) {
-        this.options.withMetadataIcc = options.icc;
-      } else {
-        throw is.invalidParameterError('icc', 'string filesystem path to ICC profile', options.icc);
-      }
+      this.withIccProfile(options.icc);
     }
     if (is.defined(options.exif)) {
-      if (is.object(options.exif)) {
-        for (const [ifd, entries] of Object.entries(options.exif)) {
-          if (is.object(entries)) {
-            for (const [k, v] of Object.entries(entries)) {
-              if (is.string(v)) {
-                this.options.withMetadataStrs[`exif-${ifd.toLowerCase()}-${k}`] = v;
-              } else {
-                throw is.invalidParameterError(`exif.${ifd}.${k}`, 'string', v);
-              }
-            }
-          } else {
-            throw is.invalidParameterError(`exif.${ifd}`, 'object', entries);
-          }
-        }
-      } else {
-        throw is.invalidParameterError('exif', 'object', options.exif);
-      }
+      this.withExifMerge(options.exif);
     }
   }
   return this;
@@ -780,6 +907,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 +945,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);
@@ -1282,7 +1414,8 @@ function _read () {
   /* istanbul ignore else */
   if (!this.options.streamOut) {
     this.options.streamOut = true;
-    this._pipeline();
+    const stack = Error();
+    this._pipeline(undefined, stack);
   }
 }
 
@@ -1291,18 +1424,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) {
@@ -1313,7 +1458,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);
@@ -1329,7 +1474,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);
@@ -1348,7 +1493,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 });
@@ -1364,7 +1509,7 @@ 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, info });
@@ -1387,6 +1532,12 @@ module.exports = function (Sharp) {
     // Public
     toFile,
     toBuffer,
+    keepExif,
+    withExif,
+    withExifMerge,
+    keepIccProfile,
+    withIccProfile,
+    keepMetadata,
     withMetadata,
     toFormat,
     jpeg,

package/lib/resize.js

@@ -494,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

@@ -9,61 +9,78 @@ const { familySync, versionSync } = require('detect-libc');
 
 const { runtimePlatformArch, prebuiltPlatforms, minimumLibvipsVersion } = require('./libvips');
 const runtimePlatform = runtimePlatformArch();
-const [isLinux, isMacOs, isWindows] = ['linux', 'darwin', 'win32'].map(os => runtimePlatform.startsWith(os));
 
-/* istanbul ignore next */
-try {
-  // Check for local build
-  module.exports = require(`../src/build/Release/sharp-${runtimePlatform}.node`);
-} catch (errLocal) {
+const paths = [
+  `../src/build/Release/sharp-${runtimePlatform}.node`,
+  '../src/build/Release/sharp-wasm32.node',
+  `@img/sharp-${runtimePlatform}/sharp.node`,
+  '@img/sharp-wasm32/sharp.node'
+];
+
+let sharp;
+const errors = [];
+for (const path of paths) {
   try {
-    // Check for runtime package
-    module.exports = require(`@sharpen/sharp-${runtimePlatform}/sharp.node`);
-  } catch (errPackage) {
-    const help = ['Could not load the "sharp" module at runtime'];
-    if (errLocal.code !== 'MODULE_NOT_FOUND') {
-      help.push(`${errLocal.code}: ${errLocal.message}`);
-    }
-    if (errPackage.code !== 'MODULE_NOT_FOUND') {
-      help.push(`${errPackage.code}: ${errPackage.message}`);
-    }
-    help.push('Possible solutions:');
-    // Common error messages
-    if (prebuiltPlatforms.includes(runtimePlatform)) {
-      help.push('- Add an explicit dependency for the runtime platform:');
-      help.push(`    npm install --force @sharpen/sharp-${runtimePlatform}"`);
-    } else {
-      help.push(`- The ${runtimePlatform} platform requires manual installation of libvips >= ${minimumLibvipsVersion}`);
-    }
-    if (isLinux && /symbol not found/i.test(errPackage)) {
-      try {
-        const { engines } = require(`@sharpen/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(errLocal.message)) {
-      help.push('- Update Homebrew:');
-      help.push('    brew update && brew upgrade vips');
-    }
-    if (errPackage.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 (isLinux && /Module did not self-register/.test(errLocal.message + errPackage.message)) {
-      help.push('- Using worker threads on Linux? See https://sharp.pixelplumbing.com/install#worker-threads');
-    } else if (isWindows && /The specified procedure could not be found/.test(errPackage.message)) {
-      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');
+    sharp = require(path);
+    break;
+  } catch (err) {
+    /* istanbul ignore next */
+    errors.push(err);
+  }
+}
+
+/* istanbul ignore next */
+if (sharp) {
+  module.exports = sharp;
+} else {
+  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}`);
     }
-    throw new Error(help.join('\n'));
+  });
+  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');
+  }
+  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

@@ -59,11 +59,17 @@ let versions = {
 };
 /* istanbul ignore next */
 if (!libvipsVersion.isGlobal) {
-  try {
-    versions = require(`@sharpen/sharp-${runtimePlatform}/versions`);
-  } catch (_) {
+  if (!libvipsVersion.isWasm) {
     try {
-      versions = require(`@sharpen/sharp-libvips-${runtimePlatform}/versions`);
+      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 (_) {}
   }
 }