@revizly/sharp 0.33.5-revizly2 → 0.33.6-revizly1

package/lib/channel.js

@@ -158,6 +158,7 @@ function bandbool (boolOp) {
 
 /**
  * Decorate the Sharp prototype with channel-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/lib/colour.js

@@ -39,9 +39,9 @@ function tint (tint) {
 /**
  * Convert to 8-bit greyscale; 256 shades of grey.
  * This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use `gamma()` with `greyscale()` for the best results.
- * By default the output image will be web-friendly sRGB and contain three (identical) color channels.
+ * By default the output image will be web-friendly sRGB and contain three (identical) colour channels.
  * This may be overridden by other sharp operations such as `toColourspace('b-w')`,
- * which will produce an output image containing one color channel.
+ * which will produce an output image containing one colour channel.
  * An alpha channel may be present, and will be unchanged by the operation.
  *
  * @example
@@ -159,6 +159,7 @@ function _setBackgroundColourOption (key, value) {
 
 /**
  * Decorate the Sharp prototype with colour-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/lib/composite.js

@@ -202,6 +202,7 @@ function composite (images) {
 
 /**
  * Decorate the Sharp prototype with composite-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/lib/constructor.js

@@ -139,6 +139,7 @@ const debuglog = util.debuglog('sharp');
  * @param {number} [options.page=0] - Page number to start extracting from for multi-page input (GIF, WebP, TIFF), zero based.
  * @param {number} [options.subifd=-1] - subIFD (Sub Image File Directory) to extract for OME-TIFF, defaults to main image.
  * @param {number} [options.level=0] - level to extract from a multi-level input (OpenSlide), zero based.
+ * @param {string|Object} [options.pdfBackground] - Background colour to use when PDF is partially transparent. Parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick.
  * @param {boolean} [options.animated=false] - Set to `true` to read all frames/pages of an animated image (GIF, WebP, TIFF), equivalent of setting `pages` to `-1`.
  * @param {Object} [options.raw] - describes raw pixel input image data. See `raw()` for pixel ordering.
  * @param {number} [options.raw.width] - integral number of pixels wide.
@@ -348,6 +349,7 @@ const Sharp = function (input, options) {
     timeoutSeconds: 0,
     linearA: [],
     linearB: [],
+    pdfBackground: [255, 255, 255, 255],
     // Function to notify of libvips warnings
     debuglog: warning => {
       this.emit('warning', warning);
@@ -447,6 +449,7 @@ Object.assign(Sharp.prototype, { clone });
 
 /**
  * Export constructor.
+ * @module Sharp
  * @private
  */
 module.exports = Sharp;

package/lib/index.d.ts

@@ -244,14 +244,14 @@ declare namespace sharp {
          * @param tint Parsed by the color module.
          * @returns A sharp instance that can be used to chain operations
          */
-        tint(tint: Color): Sharp;
+        tint(tint: Colour | Color): Sharp;
 
         /**
          * Convert to 8-bit greyscale; 256 shades of grey.
          * This is a linear operation.
          * If the input image is in a non-linear colour space such as sRGB, use gamma() with greyscale() for the best results.
-         * By default the output image will be web-friendly sRGB and contain three (identical) color channels.
-         * This may be overridden by other sharp operations such as toColourspace('b-w'), which will produce an output image containing one color channel.
+         * By default the output image will be web-friendly sRGB and contain three (identical) colour channels.
+         * This may be overridden by other sharp operations such as toColourspace('b-w'), which will produce an output image containing one colour channel.
          * An alpha channel may be present, and will be unchanged by the operation.
          * @param greyscale true to enable and false to disable (defaults to true)
          * @returns A sharp instance that can be used to chain operations
@@ -401,7 +401,7 @@ declare namespace sharp {
         /**
          * Perform an affine transform on an image. This operation will always occur after resizing, extraction and rotation, if any.
          * You must provide an array of length 4 or a 2x2 affine transformation matrix.
-         * By default, new pixels are filled with a black background. You can provide a background color with the `background` option.
+         * By default, new pixels are filled with a black background. You can provide a background colour with the `background` option.
          * A particular interpolator may also be specified. Set the `interpolator` option to an attribute of the `sharp.interpolators` Object e.g. `sharp.interpolators.nohalo`.
          *
          * In the case of a 2x2 matrix, the transform is:
@@ -935,6 +935,8 @@ declare namespace sharp {
         subifd?: number | undefined;
         /** Level to extract from a multi-level input (OpenSlide), zero based. (optional, default 0) */
         level?: number | undefined;
+        /** Background colour to use when PDF is partially transparent. Requires the use of a globally-installed libvips compiled with support for PDFium, Poppler, ImageMagick or GraphicsMagick. */
+        pdfBackground?: Colour | Color | undefined;
         /** Set to `true` to read all frames/pages of an animated image (equivalent of setting `pages` to `-1`). (optional, default false) */
         animated?: boolean | undefined;
         /** Describes raw pixel input image data. See raw() for pixel ordering. */
@@ -969,7 +971,7 @@ declare namespace sharp {
     interface Raw {
         width: number;
         height: number;
-        channels: 1 | 2 | 3 | 4;
+        channels: Channels;
     }
 
     interface CreateRaw extends Raw {
@@ -977,15 +979,17 @@ declare namespace sharp {
         premultiplied?: boolean | undefined;
     }
 
+    type CreateChannels = 3 | 4;
+
     interface Create {
         /** Number of pixels wide. */
         width: number;
         /** Number of pixels high. */
         height: number;
-        /** Number of bands e.g. 3 for RGB, 4 for RGBA */
-        channels: Channels;
+        /** Number of bands, 3 for RGB, 4 for RGBA */
+        channels: CreateChannels;
         /** Parsed by the [color](https://www.npmjs.org/package/color) module to extract values for red, green, blue and alpha. */
-        background: Color;
+        background: Colour | Color;
         /** Describes a noise to be created. */
         noise?: Noise | undefined;
     }
@@ -1339,7 +1343,7 @@ declare namespace sharp {
 
     interface RotateOptions {
         /** parsed by the color module to extract values for red, green, blue and alpha. (optional, default "#000000") */
-        background?: Color | undefined;
+        background?: Colour | Color | undefined;
     }
 
     type Precision = 'integer' | 'float' | 'approximate';
@@ -1355,7 +1359,7 @@ declare namespace sharp {
 
     interface FlattenOptions {
         /** background colour, parsed by the color module, defaults to black. (optional, default {r:0,g:0,b:0}) */
-        background?: Color | undefined;
+        background?: Colour | Color | undefined;
     }
 
     interface NegateOptions {
@@ -1380,7 +1384,7 @@ declare namespace sharp {
         /** Position, gravity or strategy to use when fit is cover or contain. (optional, default 'centre') */
         position?: number | string | undefined;
         /** Background colour when using a fit of contain, parsed by the color module, defaults to black without transparency. (optional, default {r:0,g:0,b:0,alpha:1}) */
-        background?: Color | undefined;
+        background?: Colour | Color | undefined;
         /** The kernel to use for image reduction. (optional, default 'lanczos3') */
         kernel?: keyof KernelEnum | undefined;
         /** Do not enlarge if the width or height are already less than the specified dimensions, equivalent to GraphicsMagick's > geometry option. (optional, default false) */
@@ -1423,14 +1427,14 @@ declare namespace sharp {
         /** single pixel count to right edge (optional, default 0) */
         right?: number | undefined;
         /** background colour, parsed by the color module, defaults to black without transparency. (optional, default {r:0,g:0,b:0,alpha:1}) */
-        background?: Color | undefined;
+        background?: Colour | Color | undefined;
         /** how the extension is done, one of: "background", "copy", "repeat", "mirror" (optional, default `'background'`) */
         extendWith?: ExtendWith | undefined;
     }
 
     interface TrimOptions {
         /** Background colour, parsed by the color module, defaults to that of the top-left pixel. (optional) */
-        background?: Color | undefined;
+        background?: Colour | Color | undefined;
         /** 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) */
@@ -1441,8 +1445,8 @@ declare namespace sharp {
         depth?: 'char' | 'uchar' | 'short' | 'ushort' | 'int' | 'uint' | 'float' | 'complex' | 'double' | 'dpcomplex';
     }
 
-    /** 3 for sRGB, 4 for CMYK */
-    type Channels = 3 | 4;
+    /** 1 for grayscale, 2 for grayscale + alpha, 3 for sRGB, 4 for CMYK or RGBA */
+    type Channels = 1 | 2 | 3 | 4;
 
     interface RGBA {
         r?: number | undefined;
@@ -1451,7 +1455,8 @@ declare namespace sharp {
         alpha?: number | undefined;
     }
 
-    type Color = string | RGBA;
+    type Colour = string | RGBA;
+    type Color = Colour;
 
     interface Kernel {
         /** width of the kernel in pixels. */
@@ -1576,7 +1581,7 @@ declare namespace sharp {
         size: number;
         width: number;
         height: number;
-        channels: 1 | 2 | 3 | 4;
+        channels: Channels;
         /** indicating if premultiplication was used */
         premultiplied: boolean;
         /** Only defined when using a crop strategy */

package/lib/input.js

@@ -8,7 +8,7 @@ const is = require('./is');
 const sharp = require('./sharp');
 
 /**
- * Justication alignment
+ * Justification alignment
  * @member
  * @private
  */
@@ -24,9 +24,9 @@ const align = {
  * @private
  */
 function _inputOptionsFromObject (obj) {
-  const { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd } = obj;
-  return [raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd].some(is.defined)
-    ? { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd }
+  const { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground } = obj;
+  return [raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground].some(is.defined)
+    ? { raw, density, limitInputPixels, ignoreIcc, unlimited, sequentialRead, failOn, failOnError, animated, page, pages, subifd, pdfBackground }
     : undefined;
 }
 
@@ -222,6 +222,10 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
         throw is.invalidParameterError('subifd', 'integer between -1 and 100000', inputOptions.subifd);
       }
     }
+    // PDF background colour
+    if (is.defined(inputOptions.pdfBackground)) {
+      this._setBackgroundColourOption('pdfBackground', inputOptions.pdfBackground);
+    }
     // Create new image
     if (is.defined(inputOptions.create)) {
       if (
@@ -639,6 +643,7 @@ function stats (callback) {
 
 /**
  * Decorate the Sharp prototype with input-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/lib/operation.js

@@ -128,7 +128,7 @@ function flop (flop) {
  * Perform an affine transform on an image. This operation will always occur after resizing, extraction and rotation, if any.
  *
  * You must provide an array of length 4 or a 2x2 affine transformation matrix.
- * By default, new pixels are filled with a black background. You can provide a background color with the `background` option.
+ * By default, new pixels are filled with a black background. You can provide a background colour with the `background` option.
  * A particular interpolator may also be specified. Set the `interpolator` option to an attribute of the `sharp.interpolators` Object e.g. `sharp.interpolators.nohalo`.
  *
  * In the case of a 2x2 matrix, the transform is:
@@ -930,6 +930,7 @@ function modulate (options) {
 
 /**
  * Decorate the Sharp prototype with operation-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/lib/output.js

@@ -1551,6 +1551,7 @@ function _pipeline (callback, stack) {
 
 /**
  * Decorate the Sharp prototype with output-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/lib/resize.js

@@ -569,6 +569,7 @@ function trim (options) {
 
 /**
  * Decorate the Sharp prototype with resize-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/lib/utility.js

@@ -280,6 +280,7 @@ function unblock (options) {
 
 /**
  * Decorate the Sharp class with utility-related functions.
+ * @module Sharp
  * @private
  */
 module.exports = function (Sharp) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revizly/sharp",
   "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, GIF, AVIF and TIFF images",
-  "version": "0.33.5-revizly2",
+  "version": "0.33.6-revizly1",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",
   "contributors": [
@@ -142,22 +142,21 @@
     "semver": "^7.6.3"
   },
   "optionalDependencies": {
-    "@revizly/sharp-libvips-linux-arm64": "1.0.8",
-    "@revizly/sharp-libvips-linux-x64": "1.0.8",
+    "@revizly/sharp-libvips-linux-arm64": "1.0.9",
+    "@revizly/sharp-libvips-linux-x64": "1.0.9",
     "@revizly/sharp-linux-arm64": "0.33.5-revizly1",
     "@revizly/sharp-linux-x64": "0.33.5-revizly1"
   },
   "devDependencies": {
     "@emnapi/runtime": "^1.2.0",
-    "@revizly/sharp-libvips-dev": "1.0.8",
+    "@revizly/sharp-libvips-dev": "1.0.9",
     "@types/node": "*",
-    "async": "^3.2.5",
     "cc": "^3.0.1",
     "emnapi": "^1.2.0",
     "exif-reader": "^2.0.1",
     "extract-zip": "^2.0.1",
     "icc": "^3.0.0",
-    "jsdoc-to-markdown": "^8.0.3",
+    "jsdoc-to-markdown": "^9.0.0",
     "license-checker": "^25.0.1",
     "mocha": "^10.7.3",
     "node-addon-api": "^8.1.0",
@@ -165,14 +164,14 @@
     "prebuild": "^13.0.1",
     "semistandard": "^17.0.0",
     "tar-fs": "^3.0.6",
-    "tsd": "^0.31.1"
+    "tsd": "^0.31.2"
   },
   "license": "Apache-2.0",
   "engines": {
     "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
   },
   "config": {
-    "libvips": ">=8.15.3"
+    "libvips": ">=8.15.5"
   },
   "funding": {
     "url": "https://opencollective.com/libvips"

package/src/binding.gyp

@@ -12,7 +12,7 @@
     'sharp_libvips_lib_dir': '<!(node -p "require(\'../lib/libvips\').buildSharpLibvipsLibDir()")'
   },
   'targets': [{
-    'target_name': 'libvips-cpp',
+    'target_name': 'libvips-cpp-<(vips_version)',
     'conditions': [
       ['OS == "win"', {
         # Build libvips C++ binding for Windows due to MSVC std library ABI changes
@@ -83,7 +83,7 @@
     ],
     'dependencies': [
       '<!(node -p "require(\'node-addon-api\').gyp")',
-      'libvips-cpp'
+      'libvips-cpp-<(vips_version)'
     ],
     'variables': {
       'conditions': [
@@ -149,7 +149,7 @@
           ['OS == "mac"', {
             'link_settings': {
               'libraries': [
-                'libvips-cpp.42.dylib'
+                'libvips-cpp.<(vips_version).dylib'
               ]
             },
             'xcode_settings': {
@@ -169,7 +169,7 @@
             ],
             'link_settings': {
               'libraries': [
-                '-l:libvips-cpp.so.42'
+                '-l:libvips-cpp.so.<(vips_version)'
               ],
               'ldflags': [
                 '-Wl,-s',

package/src/common.cc

@@ -109,6 +109,10 @@ namespace sharp {
     if (HasAttr(input, "subifd")) {
       descriptor->subifd = AttrAsInt32(input, "subifd");
     }
+    // // PDF background color
+    if (HasAttr(input, "pdfBackground")) {
+      descriptor->pdfBackground = AttrAsVectorOfDouble(input, "pdfBackground");
+    }
     // Create new image
     if (HasAttr(input, "createChannels")) {
       descriptor->createChannels = AttrAsUint32(input, "createChannels");
@@ -402,6 +406,9 @@ namespace sharp {
             if (imageType == ImageType::TIFF) {
               option->set("subifd", descriptor->subifd);
             }
+            if (imageType == ImageType::PDF) {
+              option->set("background", descriptor->pdfBackground);
+            }
             image = VImage::new_from_buffer(descriptor->buffer, descriptor->bufferLength, nullptr, option);
             if (imageType == ImageType::SVG || imageType == ImageType::PDF || imageType == ImageType::MAGICK) {
               image = SetDensity(image, descriptor->density);
@@ -506,6 +513,9 @@ namespace sharp {
             if (imageType == ImageType::TIFF) {
               option->set("subifd", descriptor->subifd);
             }
+            if (imageType == ImageType::PDF) {
+              option->set("background", descriptor->pdfBackground);
+            }
             image = VImage::new_from_file(descriptor->file.data(), option);
             if (imageType == ImageType::SVG || imageType == ImageType::PDF || imageType == ImageType::MAGICK) {
               image = SetDensity(image, descriptor->density);

package/src/common.h

@@ -16,8 +16,8 @@
 
 #if (VIPS_MAJOR_VERSION < 8) || \
   (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION < 15) || \
-  (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION == 15 && VIPS_MICRO_VERSION < 3)
-#error "libvips version 8.15.3+ is required - please see https://sharp.pixelplumbing.com/install"
+  (VIPS_MAJOR_VERSION == 8 && VIPS_MINOR_VERSION == 15 && VIPS_MICRO_VERSION < 5)
+#error "libvips version 8.15.5+ is required - please see https://sharp.pixelplumbing.com/install"
 #endif
 
 #if ((!defined(__clang__)) && defined(__GNUC__) && (__GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 6)))
@@ -74,6 +74,7 @@ namespace sharp {
     int textSpacing;
     VipsTextWrap textWrap;
     int textAutofitDpi;
+    std::vector<double> pdfBackground;
 
     InputDescriptor():
       buffer(nullptr),
@@ -108,7 +109,8 @@ namespace sharp {
       textRgba(false),
       textSpacing(0),
       textWrap(VIPS_TEXT_WRAP_WORD),
-      textAutofitDpi(0) {}
+      textAutofitDpi(0),
+      pdfBackground{ 255.0, 255.0, 255.0, 255.0 } {}
   };
 
   // Convenience methods to access the attributes of a Napi::Object