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

package/README.md

@@ -2,10 +2,14 @@
 
 <img src="https://cdn.jsdelivr.net/gh/lovell/sharp@main/docs/image/sharp-logo.svg" width="160" height="160" alt="sharp logo" align="right">
 
-The typical use case for this high speed Node.js module
+The typical use case for this high speed Node-API module
 is to convert large images in common formats to
 smaller, web-friendly JPEG, PNG, WebP, GIF and AVIF images of varying dimensions.
 
+It can be used with all JavaScript runtimes
+that provide support for Node-API v9, including
+Node.js >= 18.17.0, Deno and Bun.
+
 Resizing an image is typically 4x-5x faster than using the
 quickest ImageMagick and GraphicsMagick settings
 due to its use of [libvips](https://github.com/libvips/libvips).
@@ -16,7 +20,7 @@ Lanczos resampling ensures quality is not sacrificed for speed.
 As well as image resizing, operations such as
 rotation, extraction, compositing and gamma correction are available.
 
-Most modern macOS, Windows and Linux systems running Node.js >= 18.17.0
+Most modern macOS, Windows and Linux systems
 do not require any additional install or runtime dependencies.
 
 ## Documentation

package/lib/colour.js

@@ -19,7 +19,7 @@ const colourspace = {
 };
 
 /**
- * Tint the image using the provided chroma while preserving the image luminance.
+ * Tint the image using the provided colour.
  * An alpha channel may be present and will be unchanged by the operation.
  *
  * @example
@@ -27,14 +27,12 @@ const colourspace = {
  *   .tint({ r: 255, g: 240, b: 16 })
  *   .toBuffer();
  *
- * @param {string|Object} rgb - parsed by the [color](https://www.npmjs.org/package/color) module to extract chroma values.
+ * @param {string|Object} tint - Parsed by the [color](https://www.npmjs.org/package/color) module.
  * @returns {Sharp}
  * @throws {Error} Invalid parameter
  */
-function tint (rgb) {
-  const colour = color(rgb);
-  this.options.tintA = colour.a();
-  this.options.tintB = colour.b();
+function tint (tint) {
+  this._setBackgroundColourOption('tint', tint);
   return this;
 }
 

package/lib/constructor.js

@@ -121,7 +121,7 @@ const debuglog = util.debuglog('sharp');
  *  a String containing the filesystem path to an JPEG, PNG, WebP, AVIF, GIF, SVG or TIFF image file.
  *  JPEG, PNG, WebP, AVIF, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present.
  * @param {Object} [options] - if present, is an Object with optional attributes.
- * @param {string} [options.failOn='warning'] - when to abort processing of invalid pixel data, one of (in order of sensitivity): 'none' (least), 'truncated', 'error' or 'warning' (most), higher levels imply lower levels, invalid metadata will always abort.
+ * @param {string} [options.failOn='warning'] - When to abort processing of invalid pixel data, one of (in order of sensitivity, least to most): 'none', 'truncated', 'error', 'warning'. Higher levels imply lower levels. Invalid metadata will always abort.
  * @param {number|boolean} [options.limitInputPixels=268402689] - Do not process input images where the number of pixels
  *  (width x height) exceeds this limit. Assumes image dimensions contained in the input metadata can be trusted.
  *  An integral Number of pixels, zero or false to remove limit, true to use default limit of 268402689 (0x3FFF x 0x3FFF).
@@ -212,8 +212,7 @@ const Sharp = function (input, options) {
     kernel: 'lanczos3',
     fastShrinkOnLoad: true,
     // operations
-    tintA: 128,
-    tintB: 128,
+    tint: [-1, 0, 0, 0],
     flatten: false,
     flattenBackground: [0, 0, 0],
     unflatten: false,
@@ -230,7 +229,8 @@ const Sharp = function (input, options) {
     threshold: 0,
     thresholdGrayscale: true,
     trimBackground: [],
-    trimThreshold: 0,
+    trimThreshold: -1,
+    trimLineArt: false,
     gamma: 0,
     gammaOut: 0,
     greyscale: false,
@@ -257,11 +257,12 @@ const Sharp = function (input, options) {
     fileOut: '',
     formatOut: 'input',
     streamOut: false,
-    withMetadata: false,
+    keepMetadata: 0,
     withMetadataOrientation: -1,
     withMetadataDensity: 0,
-    withMetadataIcc: '',
-    withMetadataStrs: {},
+    withIccProfile: '',
+    withExif: {},
+    withExifMerge: true,
     resolveWithObject: false,
     // output format
     jpegQuality: 80,
@@ -305,6 +306,7 @@ const Sharp = function (input, options) {
     tiffCompression: 'jpeg',
     tiffPredictor: 'horizontal',
     tiffPyramid: false,
+    tiffMiniswhite: false,
     tiffBitdepth: 8,
     tiffTile: false,
     tiffTileHeight: 256,

package/lib/index.d.ts

@@ -239,12 +239,12 @@ declare namespace sharp {
         //#region Color functions
 
         /**
-         * Tint the image using the provided chroma while preserving the image luminance.
+         * Tint the image using the provided colour.
          * An alpha channel may be present and will be unchanged by the operation.
-         * @param rgb Parsed by the color module to extract chroma values.
+         * @param tint Parsed by the color module.
          * @returns A sharp instance that can be used to chain operations
          */
-        tint(rgb: Color): Sharp;
+        tint(tint: Color): Sharp;
 
         /**
          * Convert to 8-bit greyscale; 256 shades of grey.
@@ -633,6 +633,43 @@ declare namespace sharp {
          */
         toBuffer(options: { resolveWithObject: true }): Promise<{ data: Buffer; info: OutputInfo }>;
 
+        /**
+         * Keep all EXIF metadata from the input image in the output image.
+         * EXIF metadata is unsupported for TIFF output.
+         * @returns A sharp instance that can be used to chain operations
+         */
+        keepExif(): Sharp;
+
+        /**
+         * Set EXIF metadata in the output image, ignoring any EXIF in the input image.
+         * @param {Exif} exif Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
+         * @returns A sharp instance that can be used to chain operations
+         * @throws {Error} Invalid parameters
+         */
+        withExif(exif: Exif): Sharp;
+
+        /**
+         * Update EXIF metadata from the input image in the output image.
+         * @param {Exif} exif Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
+         * @returns A sharp instance that can be used to chain operations
+         * @throws {Error} Invalid parameters
+         */
+        withExifMerge(exif: Exif): Sharp;
+
+        /**
+         * Keep ICC profile from the input image in the output image where possible.
+         * @returns A sharp instance that can be used to chain operations
+         */
+        keepIccProfile(): Sharp;
+
+        /**
+         * Transform using an ICC profile and attach to the output image.
+         * @param {string} icc - Absolute filesystem path to output ICC profile or built-in profile name (srgb, p3, cmyk).
+         * @returns A sharp instance that can be used to chain operations
+         * @throws {Error} Invalid parameters
+         */
+        withIccProfile(icc: string, options?: WithIccProfileOptions): Sharp;
+
         /**
          * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
          * The default behaviour, when withMetadata is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
@@ -847,11 +884,11 @@ declare namespace sharp {
          * Trim pixels from all edges that contain values similar to the given background colour, which defaults to that of the top-left pixel.
          * Images with an alpha channel will use the combined bounding box of alpha and non-alpha channels.
          * The info response Object will contain trimOffsetLeft and trimOffsetTop properties.
-         * @param trim The specific background colour to trim, the threshold for doing so or an Object with both.
+         * @param options trim options
          * @throws {Error} Invalid parameters
          * @returns A sharp instance that can be used to chain operations
          */
-        trim(trim?: string | number | TrimOptions): Sharp;
+        trim(options?: TrimOptions): Sharp;
 
         //#endregion
     }
@@ -978,15 +1015,32 @@ declare namespace sharp {
         wrap?: TextWrap;
     }
 
+    interface ExifDir {
+        [k: string]: string;
+    }
+
+    interface Exif {
+        'IFD0'?: ExifDir;
+        'IFD1'?: ExifDir;
+        'IFD2'?: ExifDir;
+        'IFD3'?: ExifDir;
+    }
+
     interface WriteableMetadata {
+        /** Number of pixels per inch (DPI) */
+        density?: number | undefined;
         /** Value between 1 and 8, used to update the EXIF Orientation tag. */
         orientation?: number | undefined;
-        /** Filesystem path to output ICC profile, defaults to sRGB. */
+        /**
+         * Filesystem path to output ICC profile, defaults to sRGB.
+         * @deprecated Use `withIccProfile()` instead.
+        */
         icc?: string | undefined;
-        /** Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data. (optional, default {}) */
-        exif?: Record<string, any> | undefined;
-        /** Number of pixels per inch (DPI) */
-        density?: number | undefined;
+        /**
+         * Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
+         * @deprecated Use `withExif()` or `withExifMerge()` instead.
+         */
+        exif?: Exif | undefined;
     }
 
     interface Metadata {
@@ -1096,6 +1150,11 @@ declare namespace sharp {
         force?: boolean | undefined;
     }
 
+    interface WithIccProfileOptions {
+        /**  Should the ICC profile be included in the output image metadata? (optional, default true) */
+        attach?: boolean | undefined;
+    }
+
     interface JpegOptions extends OutputOptions {
         /** Quality, integer 1-100 (optional, default 80) */
         quality?: number | undefined;
@@ -1234,6 +1293,8 @@ declare namespace sharp {
         yres?: number | undefined;
         /** Reduce bitdepth to 1, 2 or 4 bit (optional, default 8) */
         bitdepth?: 1 | 2 | 4 | 8 | undefined;
+        /** Write 1-bit images as miniswhite (optional, default false) */
+        miniswhite?: boolean | undefined;
         /** Resolution unit options: inch, cm (optional, default 'inch') */
         resolutionUnit?: 'inch' | 'cm' | undefined;
     }
@@ -1275,10 +1336,10 @@ declare namespace sharp {
     }
 
     interface NormaliseOptions {
-      /** Percentile below which luminance values will be underexposed. */
-      lower?: number | undefined;
-      /** Percentile above which luminance values will be overexposed. */
-      upper?: number | undefined;
+        /** Percentile below which luminance values will be underexposed. */
+        lower?: number | undefined;
+        /** Percentile above which luminance values will be overexposed. */
+        upper?: number | undefined;
     }
 
     interface ResizeOptions {
@@ -1340,10 +1401,12 @@ declare namespace sharp {
     }
 
     interface TrimOptions {
-        /** background colour, parsed by the color module, defaults to that of the top-left pixel. (optional) */
+        /** Background colour, parsed by the color module, defaults to that of the top-left pixel. (optional) */
         background?: Color | undefined;
-        /** the allowed difference from the above colour, a positive number. (optional, default `10`) */
+        /** Allowed difference from the above colour, a positive number. (optional, default 10) */
         threshold?: number | undefined;
+        /** Does the input more closely resemble line art (e.g. vector) rather than being photographic? (optional, default false) */
+        lineArt?: boolean | undefined;
     }
 
     interface RawOptions {

package/lib/input.js

@@ -483,14 +483,27 @@ function _isStreamInput () {
  * @returns {Promise<Object>|Sharp}
  */
 function metadata (callback) {
+  const stack = Error();
   if (is.fn(callback)) {
     if (this._isStreamInput()) {
       this.on('finish', () => {
         this._flattenBufferIn();
-        sharp.metadata(this.options, callback);
+        sharp.metadata(this.options, (err, metadata) => {
+          if (err) {
+            callback(is.nativeError(err, stack));
+          } else {
+            callback(null, metadata);
+          }
+        });
       });
     } else {
-      sharp.metadata(this.options, callback);
+      sharp.metadata(this.options, (err, metadata) => {
+        if (err) {
+          callback(is.nativeError(err, stack));
+        } else {
+          callback(null, metadata);
+        }
+      });
     }
     return this;
   } else {
@@ -500,7 +513,7 @@ function metadata (callback) {
           this._flattenBufferIn();
           sharp.metadata(this.options, (err, metadata) => {
             if (err) {
-              reject(err);
+              reject(is.nativeError(err, stack));
             } else {
               resolve(metadata);
             }
@@ -516,7 +529,7 @@ function metadata (callback) {
       return new Promise((resolve, reject) => {
         sharp.metadata(this.options, (err, metadata) => {
           if (err) {
-            reject(err);
+            reject(is.nativeError(err, stack));
           } else {
             resolve(metadata);
           }
@@ -572,14 +585,27 @@ function metadata (callback) {
  * @returns {Promise<Object>}
  */
 function stats (callback) {
+  const stack = Error();
   if (is.fn(callback)) {
     if (this._isStreamInput()) {
       this.on('finish', () => {
         this._flattenBufferIn();
-        sharp.stats(this.options, callback);
+        sharp.stats(this.options, (err, stats) => {
+          if (err) {
+            callback(is.nativeError(err, stack));
+          } else {
+            callback(null, stats);
+          }
+        });
       });
     } else {
-      sharp.stats(this.options, callback);
+      sharp.stats(this.options, (err, stats) => {
+        if (err) {
+          callback(is.nativeError(err, stack));
+        } else {
+          callback(null, stats);
+        }
+      });
     }
     return this;
   } else {
@@ -589,7 +615,7 @@ function stats (callback) {
           this._flattenBufferIn();
           sharp.stats(this.options, (err, stats) => {
             if (err) {
-              reject(err);
+              reject(is.nativeError(err, stack));
             } else {
               resolve(stats);
             }
@@ -600,7 +626,7 @@ function stats (callback) {
       return new Promise((resolve, reject) => {
         sharp.stats(this.options, (err, stats) => {
           if (err) {
-            reject(err);
+            reject(is.nativeError(err, stack));
           } else {
             resolve(stats);
           }

package/lib/is.js

@@ -137,6 +137,19 @@ const invalidParameterError = function (name, expected, actual) {
   );
 };
 
+/**
+ * Ensures an Error from C++ contains a JS stack.
+ *
+ * @param {Error} native - Error with message from C++.
+ * @param {Error} context - Error with stack from JS.
+ * @returns {Error} Error with message and stack.
+ * @private
+ */
+const nativeError = function (native, context) {
+  context.message = native.message;
+  return context;
+};
+
 module.exports = {
   defined,
   object,
@@ -151,5 +164,6 @@ module.exports = {
   integer,
   inRange,
   inArray,
-  invalidParameterError
+  invalidParameterError,
+  nativeError
 };

package/lib/libvips.js

@@ -16,7 +16,7 @@ const minimumLibvipsVersion = semverCoerce(minimumLibvipsVersionLabelled).versio
 
 const prebuiltPlatforms = [
   'darwin-arm64', 'darwin-x64',
-  'linux-arm', 'linux-arm64', 'linux-x64',
+  'linux-arm', 'linux-arm64', 'linux-s390x', 'linux-x64',
   'linuxmusl-arm64', 'linuxmusl-x64',
   'win32-ia32', 'win32-x64'
 ];
@@ -41,22 +41,30 @@ const runtimePlatformArch = () => `${process.platform}${runtimeLibc()}-${process
 
 /* istanbul ignore next */
 const buildPlatformArch = () => {
+  if (isEmscripten()) {
+    return 'wasm32';
+  }
   /* eslint camelcase: ["error", { allow: ["^npm_config_"] }] */
   const { npm_config_arch, npm_config_platform, npm_config_libc } = process.env;
-  return `${npm_config_platform || process.platform}${npm_config_libc || runtimeLibc()}-${npm_config_arch || process.arch}`;
+  const libc = typeof npm_config_libc === 'string' ? npm_config_libc : runtimeLibc();
+  return `${npm_config_platform || process.platform}${libc}-${npm_config_arch || process.arch}`;
 };
 
 const buildSharpLibvipsIncludeDir = () => {
   try {
-    return require('@sharpen/sharp-libvips-dev/include');
-  } catch {}
+    return require(`@img/sharp-libvips-dev-${buildPlatformArch()}/include`);
+  } catch {
+    try {
+      return require('@img/sharp-libvips-dev/include');
+    } catch {}
+  }
   /* istanbul ignore next */
   return '';
 };
 
 const buildSharpLibvipsCPlusPlusDir = () => {
   try {
-    return require('@sharpen/sharp-libvips-dev/cplusplus');
+    return require('@img/sharp-libvips-dev/cplusplus');
   } catch {}
   /* istanbul ignore next */
   return '';
@@ -64,12 +72,22 @@ const buildSharpLibvipsCPlusPlusDir = () => {
 
 const buildSharpLibvipsLibDir = () => {
   try {
-    return require(`@sharpen/sharp-libvips-${buildPlatformArch()}/lib`);
-  } catch {}
+    return require(`@img/sharp-libvips-dev-${buildPlatformArch()}/lib`);
+  } catch {
+    try {
+      return require(`@img/sharp-libvips-${buildPlatformArch()}/lib`);
+    } catch {}
+  }
   /* istanbul ignore next */
   return '';
 };
 
+/* istanbul ignore next */
+const isEmscripten = () => {
+  const { CC } = process.env;
+  return Boolean(CC && CC.endsWith('/emcc'));
+};
+
 const isRosetta = () => {
   /* istanbul ignore next */
   if (process.platform === 'darwin' && process.arch === 'x64') {
@@ -81,7 +99,7 @@ const isRosetta = () => {
 
 /* istanbul ignore next */
 const spawnRebuild = () =>
-  spawnSync('node-gyp rebuild --directory=src', {
+  spawnSync(`node-gyp rebuild --directory=src ${isEmscripten() ? '--nodedir=emscripten' : ''}`, {
     ...spawnSyncOptions,
     stdio: 'inherit'
   }).status;