sharp 0.34.4 → 0.34.5-rc.1

package/install/build.js

@@ -0,0 +1,38 @@
+/*!
+  Copyright 2013 Lovell Fuller and others.
+  SPDX-License-Identifier: Apache-2.0
+*/
+
+const {
+  useGlobalLibvips,
+  globalLibvipsVersion,
+  log,
+  spawnRebuild,
+} = require('../lib/libvips');
+
+log('Attempting to build from source via node-gyp');
+log('See https://sharp.pixelplumbing.com/install#building-from-source');
+
+try {
+  const addonApi = require('node-addon-api');
+  log(`Found node-addon-api ${addonApi.version || ''}`);
+} catch (_err) {
+  log('Please add node-addon-api to your dependencies');
+  process.exit(1);
+}
+try {
+  const gyp = require('node-gyp');
+  log(`Found node-gyp ${gyp().version}`);
+} catch (_err) {
+  log('Please add node-gyp to your dependencies');
+  process.exit(1);
+}
+
+if (useGlobalLibvips(log)) {
+  log(`Detected globally-installed libvips v${globalLibvipsVersion()}`);
+}
+
+const status = spawnRebuild();
+if (status !== 0) {
+  process.exit(status);
+}

package/install/check.js

@@ -1,39 +1,12 @@
-// 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
+*/
 
 try {
-  const { useGlobalLibvips, globalLibvipsVersion, log, spawnRebuild } = require('../lib/libvips');
-
-  const buildFromSource = (msg) => {
-    log(msg);
-    log('Attempting to build from source via node-gyp');
-    try {
-      const addonApi = require('node-addon-api');
-      log(`Found node-addon-api ${addonApi.version || ''}`);
-    } catch (err) {
-      log('Please add node-addon-api to your dependencies');
-      return;
-    }
-    try {
-      const gyp = require('node-gyp');
-      log(`Found node-gyp ${gyp().version}`);
-    } catch (err) {
-      log('Please add node-gyp to your dependencies');
-      return;
-    }
-    log('See https://sharp.pixelplumbing.com/install#building-from-source');
-    const status = spawnRebuild();
-    if (status !== 0) {
-      process.exit(status);
-    }
-  };
-
-  if (useGlobalLibvips(log)) {
-    buildFromSource(`Detected globally-installed libvips v${globalLibvipsVersion()}`);
-  } else if (process.env.npm_config_build_from_source) {
-    buildFromSource('Detected --build-from-source flag');
+  const { useGlobalLibvips } = require('../lib/libvips');
+  if (useGlobalLibvips() || process.env.npm_config_build_from_source) {
+    process.exit(1);
   }
 } catch (err) {
   const summary = err.message.split(/\n/).slice(0, 1);

package/lib/channel.js

@@ -1,7 +1,7 @@
-// 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');
 
@@ -18,7 +18,7 @@ const bool = {
 /**
  * Remove alpha channels, if any. This is a no-op if the image does not have an alpha channel.
  *
- * See also {@link /api-operation#flatten|flatten}.
+ * See also {@link /api-operation/#flatten flatten}.
  *
  * @example
  * sharp('rgba.png')
@@ -163,7 +163,7 @@ function bandbool (boolOp) {
  * @module Sharp
  * @private
  */
-module.exports = function (Sharp) {
+module.exports = (Sharp) => {
   Object.assign(Sharp.prototype, {
     // Public instance functions
     removeAlpha,

package/lib/colour.js

@@ -1,7 +1,7 @@
-// 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 color = require('@img/colour');
 const is = require('./is');
@@ -69,7 +69,7 @@ function grayscale (grayscale) {
  *
  * The input image will be converted to the provided colourspace at the start of the pipeline.
  * All operations will use this colourspace before converting to the output colourspace,
- * as defined by {@link #tocolourspace|toColourspace}.
+ * as defined by {@link #tocolourspace toColourspace}.
  *
  * @since 0.29.0
  *
@@ -80,7 +80,7 @@ function grayscale (grayscale) {
  *  .toColourspace('srgb')
  *  .toFile('16bpc-pipeline-to-8bpc-output.png')
  *
- * @param {string} [colourspace] - pipeline colourspace e.g. `rgb16`, `scrgb`, `lab`, `grey16` [...](https://github.com/libvips/libvips/blob/41cff4e9d0838498487a00623462204eb10ee5b8/libvips/iofuncs/enumtypes.c#L774)
+ * @param {string} [colourspace] - pipeline colourspace e.g. `rgb16`, `scrgb`, `lab`, `grey16` [...](https://www.libvips.org/API/current/enum.Interpretation.html)
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -112,7 +112,7 @@ function pipelineColorspace (colorspace) {
  *  .toColourspace('rgb16')
  *  .toFile('16-bpp.png')
  *
- * @param {string} [colourspace] - output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://github.com/libvips/libvips/blob/3c0bfdf74ce1dc37a6429bed47fa76f16e2cd70a/libvips/iofuncs/enumtypes.c#L777-L794)
+ * @param {string} [colourspace] - output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://www.libvips.org/API/current/enum.Interpretation.html)
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -141,7 +141,10 @@ function toColorspace (colorspace) {
  * @throws {Error} Invalid value
  */
 function _getBackgroundColourOption (value) {
-  if (is.object(value) || is.string(value)) {
+  if (
+    is.object(value) ||
+    (is.string(value) && value.length >= 3 && value.length <= 200)
+  ) {
     const colour = color(value);
     return [
       colour.red(),
@@ -172,7 +175,7 @@ function _setBackgroundColourOption (key, value) {
  * @module Sharp
  * @private
  */
-module.exports = function (Sharp) {
+module.exports = (Sharp) => {
   Object.assign(Sharp.prototype, {
     // Public
     tint,

package/lib/composite.js

@@ -1,7 +1,7 @@
-// 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');
 
@@ -56,7 +56,7 @@ const blend = {
  * `hard-light`, `soft-light`, `difference`, `exclusion`.
  *
  * More information about blend modes can be found at
- * https://www.libvips.org/API/current/libvips-conversion.html#VipsBlendMode
+ * https://www.libvips.org/API/current/enum.BlendMode.html
  * and https://www.cairographics.org/operators/
  *
  * @since 0.22.0
@@ -123,8 +123,8 @@ const blend = {
  * @param {Number} [images[].raw.height]
  * @param {Number} [images[].raw.channels]
  * @param {boolean} [images[].animated=false] - Set to `true` to read all frames/pages of an animated image.
- * @param {string} [images[].failOn='warning'] - @see {@link /api-constructor#parameters|constructor parameters}
- * @param {number|boolean} [images[].limitInputPixels=268402689] - @see {@link /api-constructor#parameters|constructor parameters}
+ * @param {string} [images[].failOn='warning'] - @see {@link /api-constructor/ constructor parameters}
+ * @param {number|boolean} [images[].limitInputPixels=268402689] - @see {@link /api-constructor/ constructor parameters}
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -206,7 +206,7 @@ function composite (images) {
  * @module Sharp
  * @private
  */
-module.exports = function (Sharp) {
+module.exports = (Sharp) => {
   Sharp.prototype.composite = composite;
   Sharp.blend = blend;
 };

package/lib/constructor.js

@@ -1,7 +1,7 @@
-// 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 util = require('node:util');
 const stream = require('node:stream');
@@ -12,6 +12,10 @@ require('./sharp');
 // Use NODE_DEBUG=sharp to enable libvips warnings
 const debuglog = util.debuglog('sharp');
 
+const queueListener = (queueLength) => {
+  Sharp.queue.emit('change', queueLength);
+};
+
 /**
  * Constructor factory to create an instance of `sharp`, to which further methods are chained.
  *
@@ -205,6 +209,7 @@ const debuglog = util.debuglog('sharp');
  * @throws {Error} Invalid parameters
  */
 const Sharp = function (input, options) {
+  // biome-ignore lint/complexity/noArguments: constructor factory
   if (arguments.length === 1 && !is.defined(input)) {
     throw new Error('Invalid input');
   }
@@ -353,6 +358,7 @@ const Sharp = function (input, options) {
     gifProgressive: false,
     tiffQuality: 80,
     tiffCompression: 'jpeg',
+    tiffBigtiff: false,
     tiffPredictor: 'horizontal',
     tiffPyramid: false,
     tiffMiniswhite: false,
@@ -396,9 +402,7 @@ const Sharp = function (input, options) {
       debuglog(warning);
     },
     // Function to notify of queue length changes
-    queueListener: function (queueLength) {
-      Sharp.queue.emit('change', queueLength);
-    }
+    queueListener
   };
   this.options.input = this._createInputDescriptor(input, options, { allowStream: true });
   return this;

package/lib/index.d.ts

@@ -27,7 +27,7 @@
 
 /// <reference types="node" />
 
-import { Duplex } from 'stream';
+import type { Duplex } from 'node:stream';
 
 //#region Constructor functions
 
@@ -860,6 +860,7 @@ declare namespace sharp {
                 | JxlOptions
                 | GifOptions
                 | Jp2Options
+                | RawOptions
                 | TiffOptions,
         ): Sharp;
 
@@ -1181,6 +1182,10 @@ declare namespace sharp {
         'IFD3'?: ExifDir;
     }
 
+    type HeifCompression = 'av1' | 'hevc';
+
+    type Unit = 'inch' | 'cm';
+
     interface WriteableMetadata {
         /** Number of pixels per inch (DPI) */
         density?: number | undefined;
@@ -1259,7 +1264,7 @@ declare namespace sharp {
         /** Buffer containing raw TIFFTAG_PHOTOSHOP data, if present */
         tifftagPhotoshop?: Buffer | undefined;
         /** The encoder used to compress an HEIF file, `av1` (AVIF) or `hevc` (HEIC) */
-        compression?: 'av1' | 'hevc';
+        compression?: HeifCompression | undefined;
         /** Default background colour, if present, for PNG (bKGD) and GIF images */
         background?: { r: number; g: number; b: number } | { gray: number };
         /** Details of each level in a multi-level image provided as an array of objects, requires libvips compiled with support for OpenSlide */
@@ -1267,7 +1272,7 @@ declare namespace sharp {
         /** Number of Sub Image File Directories in an OME-TIFF image */
         subifds?: number | undefined;
         /** The unit of resolution (density) */
-        resolutionUnit?: 'inch' | 'cm' | undefined;
+        resolutionUnit?: Unit | undefined;
         /** String containing format for images loaded via *magick */
         formatMagick?: string | undefined;
         /** Array of keyword/text pairs representing PNG text blocks, if present. */
@@ -1423,7 +1428,7 @@ declare namespace sharp {
         /** quality, integer 1-100 (optional, default 50) */
         quality?: number | undefined;
         /** compression format: av1, hevc (optional, default 'av1') */
-        compression?: 'av1' | 'hevc' | undefined;
+        compression?: HeifCompression | undefined;
         /** use lossless compression (optional, default false) */
         lossless?: boolean | undefined;
         /** Level of CPU effort to reduce file size, between 0 (fastest) and 9 (slowest) (optional, default 4) */
@@ -1460,6 +1465,8 @@ declare namespace sharp {
         quality?: number | undefined;
         /** Compression options: none, jpeg, deflate, packbits, ccittfax4, lzw, webp, zstd, jp2k (optional, default 'jpeg') */
         compression?: string | undefined;
+        /** Use BigTIFF variant (has no effect when compression is none) (optional, default false) */
+        bigtiff?: boolean | undefined;
         /** Compression predictor options: none, horizontal, float (optional, default 'horizontal') */
         predictor?: string | undefined;
         /** Write an image pyramid (optional, default false) */
@@ -1479,7 +1486,7 @@ declare namespace sharp {
         /** Write 1-bit images as miniswhite (optional, default false) */
         miniswhite?: boolean | undefined;
         /** Resolution unit options: inch, cm (optional, default 'inch') */
-        resolutionUnit?: 'inch' | 'cm' | undefined;
+        resolutionUnit?: Unit | undefined;
     }
 
     interface PngOptions extends OutputOptions {
@@ -1604,7 +1611,7 @@ declare namespace sharp {
     }
 
     interface RawOptions {
-        depth?: 'char' | 'uchar' | 'short' | 'ushort' | 'int' | 'uint' | 'float' | 'complex' | 'double' | 'dpcomplex';
+        depth?: keyof DepthEnum;
     }
 
     /** 1 for grayscale, 2 for grayscale + alpha, 3 for sRGB, 4 for CMYK or RGBA */

package/lib/index.js

@@ -1,7 +1,7 @@
-// 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 Sharp = require('./constructor');
 require('./input')(Sharp);

package/lib/input.js

@@ -1,7 +1,7 @@
-// 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');
 const sharp = require('./sharp');
@@ -54,7 +54,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
   const inputDescriptor = {
     autoOrient: false,
     failOn: 'warning',
-    limitInputPixels: Math.pow(0x3FFF, 2),
+    limitInputPixels: 0x3FFF ** 2,
     ignoreIcc: false,
     unlimited: false,
     sequentialRead: true
@@ -150,7 +150,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     if (is.defined(inputOptions.limitInputPixels)) {
       if (is.bool(inputOptions.limitInputPixels)) {
         inputDescriptor.limitInputPixels = inputOptions.limitInputPixels
-          ? Math.pow(0x3FFF, 2)
+          ? 0x3FFF ** 2
           : 0;
       } else if (is.integer(inputOptions.limitInputPixels) && is.inRange(inputOptions.limitInputPixels, 0, Number.MAX_SAFE_INTEGER)) {
         inputDescriptor.limitInputPixels = inputOptions.limitInputPixels;
@@ -513,7 +513,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
       }
     }
   } else if (is.defined(inputOptions)) {
-    throw new Error('Invalid input options ' + inputOptions);
+    throw new Error(`Invalid input options ${inputOptions}`);
   }
   return inputDescriptor;
 }
@@ -525,10 +525,8 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
  * @param {string} encoding - unused
  * @param {Function} callback
  */
-function _write (chunk, encoding, callback) {
-  /* istanbul ignore else */
+function _write (chunk, _encoding, callback) {
   if (Array.isArray(this.options.input.buffer)) {
-    /* istanbul ignore else */
     if (is.buffer(chunk)) {
       if (this.options.input.buffer.length === 0) {
         this.on('finish', () => {
@@ -572,7 +570,7 @@ function _isStreamInput () {
  * such as resize or rotate.
  *
  * Dimensions in the response will respect the `page` and `pages` properties of the
- * {@link /api-constructor#parameters|constructor parameters}.
+ * {@link /api-constructor/ constructor parameters}.
  *
  * A `Promise` is returned when `callback` is not provided.
  *
@@ -580,9 +578,9 @@ function _isStreamInput () {
  * - `size`: Total size of image in bytes, for Stream and Buffer input only
  * - `width`: Number of pixels wide (EXIF orientation is not taken into consideration, see example below)
  * - `height`: Number of pixels high (EXIF orientation is not taken into consideration, see example below)
- * - `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://www.libvips.org/API/current/VipsImage.html#VipsInterpretation)
+ * - `space`: Name of colour space interpretation e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://www.libvips.org/API/current/enum.Interpretation.html)
  * - `channels`: Number of bands e.g. `3` for sRGB, `4` for CMYK
- * - `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...](https://www.libvips.org/API/current/VipsImage.html#VipsBandFormat)
+ * - `depth`: Name of pixel depth format e.g. `uchar`, `char`, `ushort`, `float` [...](https://www.libvips.org/API/current/enum.BandFormat.html)
  * - `density`: Number of pixels per inch (DPI), if present
  * - `chromaSubsampling`: String containing JPEG chroma subsampling, `4:2:0` or `4:4:4` for RGB, `4:2:0:4` or `4:4:4:4` for CMYK
  * - `isProgressive`: Boolean indicating whether the image is interlaced using a progressive scan
@@ -794,7 +792,7 @@ function stats (callback) {
  * @module Sharp
  * @private
  */
-module.exports = function (Sharp) {
+module.exports = (Sharp) => {
   Object.assign(Sharp.prototype, {
     // Private
     _inputOptionsFromObject,

package/lib/is.js

@@ -1,61 +1,49 @@
-// 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
+*/
 
 /**
  * Is this value defined and not null?
  * @private
  */
-const defined = function (val) {
-  return typeof val !== 'undefined' && val !== null;
-};
+const defined = (val) => typeof val !== 'undefined' && val !== null;
 
 /**
  * Is this value an object?
  * @private
  */
-const object = function (val) {
-  return typeof val === 'object';
-};
+const object = (val) => typeof val === 'object';
 
 /**
  * Is this value a plain object?
  * @private
  */
-const plainObject = function (val) {
-  return Object.prototype.toString.call(val) === '[object Object]';
-};
+const plainObject = (val) => Object.prototype.toString.call(val) === '[object Object]';
 
 /**
  * Is this value a function?
  * @private
  */
-const fn = function (val) {
-  return typeof val === 'function';
-};
+const fn = (val) => typeof val === 'function';
 
 /**
  * Is this value a boolean?
  * @private
  */
-const bool = function (val) {
-  return typeof val === 'boolean';
-};
+const bool = (val) => typeof val === 'boolean';
 
 /**
  * Is this value a Buffer object?
  * @private
  */
-const buffer = function (val) {
-  return val instanceof Buffer;
-};
+const buffer = (val) => val instanceof Buffer;
 
 /**
  * Is this value a typed array object?. E.g. Uint8Array or Uint8ClampedArray?
  * @private
  */
-const typedArray = function (val) {
+const typedArray = (val) => {
   if (defined(val)) {
     switch (val.constructor) {
       case Uint8Array:
@@ -78,49 +66,37 @@ const typedArray = function (val) {
  * Is this value an ArrayBuffer object?
  * @private
  */
-const arrayBuffer = function (val) {
-  return val instanceof ArrayBuffer;
-};
+const arrayBuffer = (val) => val instanceof ArrayBuffer;
 
 /**
  * Is this value a non-empty string?
  * @private
  */
-const string = function (val) {
-  return typeof val === 'string' && val.length > 0;
-};
+const string = (val) => typeof val === 'string' && val.length > 0;
 
 /**
  * Is this value a real number?
  * @private
  */
-const number = function (val) {
-  return typeof val === 'number' && !Number.isNaN(val);
-};
+const number = (val) => typeof val === 'number' && !Number.isNaN(val);
 
 /**
  * Is this value an integer?
  * @private
  */
-const integer = function (val) {
-  return Number.isInteger(val);
-};
+const integer = (val) => Number.isInteger(val);
 
 /**
  * Is this value within an inclusive given range?
  * @private
  */
-const inRange = function (val, min, max) {
-  return val >= min && val <= max;
-};
+const inRange = (val, min, max) => val >= min && val <= max;
 
 /**
  * Is this value within the elements of an array?
  * @private
  */
-const inArray = function (val, list) {
-  return list.includes(val);
-};
+const inArray = (val, list) => list.includes(val);
 
 /**
  * Create an Error with a message relating to an invalid parameter.
@@ -131,11 +107,9 @@ const inArray = function (val, list) {
  * @returns {Error} Containing the formatted message.
  * @private
  */
-const invalidParameterError = function (name, expected, actual) {
-  return new Error(
+const invalidParameterError = (name, expected, actual) => new Error(
     `Expected ${expected} for ${name} but received ${actual} of type ${typeof actual}`
   );
-};
 
 /**
  * Ensures an Error from C++ contains a JS stack.
@@ -145,7 +119,7 @@ const invalidParameterError = function (name, expected, actual) {
  * @returns {Error} Error with message and stack.
  * @private
  */
-const nativeError = function (native, context) {
+const nativeError = (native, context) => {
   context.message = native.message;
   return context;
 };