@revizly/sharp 0.35.0-revizly17 → 0.35.0-revizly18

package/lib/constructor.js

@@ -153,7 +153,7 @@ const queueListener = (queueLength) => {
  * @param {boolean} [options.unlimited=false] - Set this to `true` to remove safety features that help prevent memory exhaustion (JPEG, PNG, SVG, HEIF).
  * @param {boolean} [options.autoOrient=false] - Set this to `true` to rotate/flip the image to match EXIF `Orientation`, if any.
  * @param {boolean} [options.sequentialRead=true] - Set this to `false` to use random access rather than sequential read. Some operations will do this automatically.
- * @param {number} [options.density=72] - number representing the DPI for vector images in the range 1 to 100000.
+ * @param {number} [options.density=72] - The DPI at which to render SVG and PDF images, in the range 1 to 100000.
  * @param {number} [options.ignoreIcc=false] - should the embedded ICC profile, if any, be ignored.
  * @param {number} [options.pages=1] - Number of pages to extract for multi-page input (GIF, WebP, TIFF), use -1 for all pages.
  * @param {number} [options.page=0] - Page number to start extracting from for multi-page input (GIF, WebP, TIFF), zero based.

package/lib/index.d.ts

@@ -28,6 +28,7 @@
 /// <reference types="node" />
 
 import type { Duplex } from 'node:stream';
+import { ColorLike } from '@img/colour';
 
 //#region Constructor functions
 
@@ -234,7 +235,7 @@ declare namespace sharp {
          * @param tint Parsed by the color module.
          * @returns A sharp instance that can be used to chain operations
          */
-        tint(tint: Colour | Color): Sharp;
+        tint(tint: ColorLike): Sharp;
 
         /**
          * Convert to 8-bit greyscale; 256 shades of grey.
@@ -684,6 +685,14 @@ declare namespace sharp {
          */
         toUint8Array(): Promise<{ data: Uint8Array; info: OutputInfo }>;
 
+        /**
+         * Set output density (DPI) in EXIF metadata.
+         * @param density Density in dots per inch (DPI).
+         * @returns A sharp instance that can be used to chain operations
+         * @throws {Error} Invalid parameters
+         */
+        withDensity(density: number): Sharp;
+
         /**
          * Keep all EXIF metadata from the input image in the output image.
          * EXIF metadata is unsupported for TIFF output.
@@ -993,7 +1002,7 @@ declare namespace sharp {
         unlimited?: boolean | undefined;
         /** Set this to false to use random access rather than sequential read. Some operations will do this automatically. */
         sequentialRead?: boolean | undefined;
-        /** Number representing the DPI for vector images in the range 1 to 100000. (optional, default 72) */
+        /** The DPI at which to render SVG and PDF images, in the range 1 to 100000. (optional, default 72) */
         density?: number | undefined;
         /** Should the embedded ICC profile, if any, be ignored. */
         ignoreIcc?: boolean | undefined;
@@ -1014,7 +1023,7 @@ declare namespace sharp {
         /** @deprecated Use {@link SharpOptions.tiff} instead */
         subifd?: number | undefined;
         /** @deprecated Use {@link SharpOptions.pdf} instead */
-        pdfBackground?: Colour | Color | undefined;
+        pdfBackground?: ColorLike | undefined;
         /** @deprecated Use {@link SharpOptions.openSlide} instead */
         level?: number | undefined;
         /** Set to `true` to read all frames/pages of an animated image (equivalent of setting `pages` to `-1`). (optional, default false) */
@@ -1073,7 +1082,7 @@ declare namespace sharp {
         /** 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: Colour | Color;
+        background: ColorLike;
         /** Describes a noise to be created. */
         noise?: Noise | undefined;
         /** The height of each page/frame for animated images, must be an integral factor of the overall image height. */
@@ -1120,7 +1129,7 @@ declare namespace sharp {
         /** Space between images, in pixels. */
         shim?: number | undefined;
         /** Background colour. */
-        background?: Colour | Color | undefined;
+        background?: ColorLike | undefined;
         /** Horizontal alignment. */
         halign?: HorizontalAlignment | undefined;
         /** Vertical alignment. */
@@ -1141,7 +1150,7 @@ declare namespace sharp {
 
     interface PdfInputOptions {
         /** 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. */
-        background?: Colour | Color | undefined;
+        background?: ColorLike | undefined;
     }
 
     interface OpenSlideInputOptions {
@@ -1510,7 +1519,7 @@ declare namespace sharp {
 
     interface RotateOptions {
         /** parsed by the color module to extract values for red, green, blue and alpha. (optional, default "#000000") */
-        background?: Colour | Color | undefined;
+        background?: ColorLike | undefined;
     }
 
     type Precision = 'integer' | 'float' | 'approximate';
@@ -1526,7 +1535,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?: Colour | Color | undefined;
+        background?: ColorLike | undefined;
     }
 
     interface NegateOptions {
@@ -1551,7 +1560,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?: Colour | Color | undefined;
+        background?: ColorLike | 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) */
@@ -1594,14 +1603,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?: Colour | Color | undefined;
+        background?: ColorLike | 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?: Colour | Color | undefined;
+        background?: ColorLike | 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) */
@@ -1617,15 +1626,8 @@ declare namespace sharp {
     /** 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;
-        g?: number | undefined;
-        b?: number | undefined;
-        alpha?: number | undefined;
-    }
-
-    type Colour = string | RGBA;
-    type Color = Colour;
+    type Colour = ColorLike;
+    type Color = ColorLike;
 
     interface Kernel {
         /** width of the kernel in pixels. */
@@ -1691,7 +1693,7 @@ declare namespace sharp {
         /** Tile angle of rotation, must be a multiple of 90. (optional, default 0) */
         angle?: number | undefined;
         /** background colour, parsed by the color module, defaults to white without transparency. (optional, default {r:255,g:255,b:255,alpha:1}) */
-        background?: string | RGBA | undefined;
+        background?: ColorLike | undefined;
         /** How deep to make the pyramid, possible values are "onepixel", "onetile" or "one" (default based on layout) */
         depth?: string | undefined;
         /** Threshold to skip tile generation, a value 0 - 255 for 8-bit images or 0 - 65535 for 16-bit images */

package/lib/libvips.js

@@ -18,7 +18,8 @@ const minimumLibvipsVersion = semverCoerce(minimumLibvipsVersionLabelled).versio
 
 const prebuiltPlatforms = [
   'darwin-arm64', 'darwin-x64',
-  'linux-arm', 'linux-arm64', 'linux-ppc64', 'linux-riscv64', 'linux-s390x', 'linux-x64',
+  'freebsd-arm64', 'freebsd-x64',
+  'linux-arm', 'linux-arm64', 'linux-ppc64', 'linux-riscv64', 'linux-s390x', 'linux-wasm32', 'linux-x64',
   'linuxmusl-arm64', 'linuxmusl-x64',
   'win32-arm64', 'win32-ia32', 'win32-x64'
 ];
@@ -144,17 +145,24 @@ const globalLibvipsVersion = () => {
   }
 };
 
+const getBrewPkgConfigPath = () => {
+  try {
+    const brewPrefix = (spawnSync('brew', ['--prefix'], { encoding: 'utf8' }).stdout || '').trim();
+    if (brewPrefix) {
+      return `${brewPrefix}/lib/pkgconfig`;
+    }
+  } catch (_err) {
+    // ignore
+  }
+  return undefined;
+};
+
 /* node:coverage enable */
 
 const pkgConfigPath = () => {
   if (process.platform !== 'win32') {
-    /* node:coverage ignore next 4 */
-    const brewPkgConfigPath = spawnSync(
-      'which brew >/dev/null 2>&1 && brew environment --plain | grep PKG_CONFIG_LIBDIR | cut -d" " -f2',
-      spawnSyncOptions
-    ).stdout || '';
     return [
-      brewPkgConfigPath.trim(),
+      getBrewPkgConfigPath(),
       process.env.PKG_CONFIG_PATH,
       '/usr/local/lib/pkgconfig',
       '/usr/lib/pkgconfig',

package/lib/output.js

@@ -199,6 +199,29 @@ function toUint8Array () {
   return this._pipeline(null, stack);
 }
 
+/**
+ * Set output density (DPI) in EXIF metadata.
+ *
+ * @since 0.35.0
+ *
+ * @example
+ * const data = await sharp(input)
+ *   .withDensity(96)
+ *   .toBuffer();
+ *
+ * @param {number} density Number of pixels per inch (DPI).
+ * @returns {Sharp}
+ * @throws {Error} Invalid parameters
+ */
+function withDensity (density) {
+  if (is.number(density) && density > 0) {
+    this.options.withMetadataDensity = density;
+  } else {
+    throw is.invalidParameterError('density', 'positive number', density);
+  }
+  return this.keepExif();
+}
+
 /**
  * Keep all EXIF metadata from the input image in the output image.
  *
@@ -1712,6 +1735,7 @@ module.exports = (Sharp) => {
     toFile,
     toBuffer,
     toUint8Array,
+    withDensity,
     keepExif,
     withExif,
     withExifMerge,

package/lib/sharp.js

@@ -11,31 +11,72 @@ const { version } = require('../package.json');
 const { runtimePlatformArch, isUnsupportedNodeRuntime, prebuiltPlatforms, minimumLibvipsVersion } = require('./libvips');
 const runtimePlatform = runtimePlatformArch();
 
-const paths = [
-  `../src/build/Release/sharp-${runtimePlatform}-${version}.node`,
-  `../src/build/Release/sharp-wasm32-${version}.node`,
-  `@revizly/sharp-${runtimePlatform}/sharp.node`,
-  '@revizly/sharp-wasm32/sharp.node'
-];
-
 /* node:coverage disable */
 
-let path, sharp;
+const prebuiltBinaryForRuntime = () => {
+  switch (runtimePlatform) {
+    case 'darwin-arm64':
+      return require('@revizly/sharp-darwin-arm64/sharp.node');
+    case 'darwin-x64':
+      return require('@revizly/sharp-darwin-x64/sharp.node');
+    case 'linux-arm':
+      return require('@revizly/sharp-linux-arm/sharp.node');
+    case 'linux-arm64':
+      return require('@revizly/sharp-linux-arm64/sharp.node');
+    case 'linux-ppc64':
+      return require('@revizly/sharp-linux-ppc64/sharp.node');
+    case 'linux-riscv64':
+      return require('@revizly/sharp-linux-riscv64/sharp.node');
+    case 'linux-s390x':
+      return require('@revizly/sharp-linux-s390x/sharp.node');
+    case 'linux-x64':
+      return require('@revizly/sharp-linux-x64/sharp.node');
+    case 'linuxmusl-arm64':
+      return require('@revizly/sharp-linuxmusl-arm64/sharp.node') ;
+    case 'linuxmusl-x64':
+      return require('@revizly/sharp-linuxmusl-x64/sharp.node');
+    case 'win32-arm64':
+      return require('@revizly/sharp-win32-arm64/sharp.node');
+    case 'win32-ia32':
+      return require('@revizly/sharp-win32-ia32/sharp.node');
+    case 'win32-x64':
+      return require('@revizly/sharp-win32-x64/sharp.node');
+    case 'freebsd-arm64':
+    case 'freebsd-x64':
+      return require('@revizly/sharp-freebsd-wasm32/sharp.node');
+    case 'linux-wasm32':
+      return require('@revizly/sharp-webcontainers-wasm32/sharp.node');
+    default:
+      return require('@revizly/sharp-wasm32/sharp.node');
+  }
+};
+
+let sharp;
 const errors = [];
-for (path of paths) {
+try {
+  sharp = require(`../src/build/Release/sharp-${runtimePlatform}-${version}.node`);
+} catch (err) {
+  errors.push(err);
+}
+if (!sharp) {
   try {
-    sharp = require(path);
-    break;
+    sharp = require(`../src/build/Release/sharp-wasm32-${version}.node`);
   } catch (err) {
     errors.push(err);
   }
 }
-
-if (sharp && path.startsWith('@img/sharp-linux-x64') && !sharp._isUsingX64V2()) {
-  const err = new Error('Prebuilt binaries for linux-x64 require v2 microarchitecture');
-  err.code = 'Unsupported CPU';
-  errors.push(err);
-  sharp = null;
+if (!sharp) {
+  try {
+    sharp = prebuiltBinaryForRuntime();
+    if (['linux-x64', 'linuxmusl-x64'].includes(runtimePlatform) && !sharp._isUsingX64V2()) {
+      const err = new Error('Prebuilt binaries for Linux x64 require v2 microarchitecture');
+      err.code = 'Unsupported CPU';
+      errors.push(err);
+      sharp = null;
+    }
+  } catch (err) {
+    errors.push(err);
+  }
 }
 
 if (sharp) {
@@ -74,9 +115,8 @@ if (sharp) {
     help.push(
       `- Manually install libvips >= ${minimumLibvipsVersion}`,
       '    See https://sharp.pixelplumbing.com/install#building-from-source',
-      '- Add experimental WebAssembly-based dependencies:',
-      '    npm install --cpu=wasm32 sharp',
-      '    npm install @revizly/sharp-wasm32'
+      '- Add WebAssembly-based dependencies:',
+      '    npm install sharp @revizly/sharp-wasm32'
     );
   }
   if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {

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.35.0-revizly17",
+  "version": "0.35.0-revizly18",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://sharp.pixelplumbing.com",
   "contributors": [
@@ -103,6 +103,7 @@
     "test-leak": "./test/leak/leak.sh",
     "test-unit": "node --experimental-test-coverage test/unit.mjs",
     "package-from-local-build": "node npm/from-local-build.js",
+    "package-wasm-wrappers": "node npm/wasm-wrappers.js",
     "package-release-notes": "node npm/release-notes.js",
     "docs-build": "node docs/build.mjs",
     "docs-serve": "cd docs && npm start",
@@ -139,28 +140,28 @@
     "vips"
   ],
   "dependencies": {
-    "@img/colour": "^1.0.0",
+    "@img/colour": "^1.1.0",
     "detect-libc": "^2.1.2",
-    "semver": "^7.7.3"
+    "semver": "^7.7.4"
   },
   "optionalDependencies": {
-    "@revizly/sharp-libvips-linux-arm64": "1.0.27",
-    "@revizly/sharp-libvips-linux-x64": "1.0.27",
+    "@revizly/sharp-libvips-linux-arm64": "1.0.28",
+    "@revizly/sharp-libvips-linux-x64": "1.0.28",
     "@revizly/sharp-linux-arm64": "0.35.0-revizly16",
     "@revizly/sharp-linux-x64": "0.35.0-revizly16"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.10",
+    "@biomejs/biome": "^2.4.4",
     "@cpplint/cli": "^0.1.0",
-    "@emnapi/runtime": "^1.7.1",
-    "@revizly/sharp-libvips-dev": "1.0.27",
+    "@emnapi/runtime": "^1.8.1",
+    "@revizly/sharp-libvips-dev": "1.0.28",
     "@types/node": "*",
-    "emnapi": "^1.7.1",
+    "emnapi": "^1.8.1",
     "exif-reader": "^2.0.3",
     "extract-zip": "^2.0.1",
     "icc": "^3.0.0",
     "node-addon-api": "^8.5.0",
-    "node-gyp": "^12.1.0",
+    "node-gyp": "^12.2.0",
     "tar-fs": "^3.1.1",
     "tsd": "^0.33.0"
   },

package/src/metadata.cc

@@ -209,7 +209,7 @@ class MetadataWorker : public Napi::AsyncWorker {
     // Handle warnings
     std::string warning = sharp::VipsWarningPop();
     while (!warning.empty()) {
-      debuglog.Call(Receiver().Value(), { Napi::String::New(env, warning) });
+      debuglog.MakeCallback(Receiver().Value(), { Napi::String::New(env, warning) });
       warning = sharp::VipsWarningPop();
     }
 
@@ -344,9 +344,9 @@ class MetadataWorker : public Napi::AsyncWorker {
         }
         info.Set("comments", comments);
       }
-      Callback().Call(Receiver().Value(), { env.Null(), info });
+      Callback().MakeCallback(Receiver().Value(), { env.Null(), info });
     } else {
-      Callback().Call(Receiver().Value(), { Napi::Error::New(env, sharp::TrimEnd(baton->err)).Value() });
+      Callback().MakeCallback(Receiver().Value(), { Napi::Error::New(env, sharp::TrimEnd(baton->err)).Value() });
     }
 
     delete baton->input;

package/src/pipeline.cc

@@ -1301,7 +1301,7 @@ class PipelineWorker : public Napi::AsyncWorker {
       if (baton->errUseWarning) {
         (baton->err).append("\n").append(warning);
       } else {
-        debuglog.Call(Receiver().Value(), { Napi::String::New(env, warning) });
+        debuglog.MakeCallback(Receiver().Value(), { Napi::String::New(env, warning) });
       }
       warning = sharp::VipsWarningPop();
     }
@@ -1355,12 +1355,12 @@ class PipelineWorker : public Napi::AsyncWorker {
           sharp::FreeCallback(static_cast<char*>(baton->bufferOut), nullptr);
           Napi::TypedArrayOf<uint8_t> data = Napi::TypedArrayOf<uint8_t>::New(env,
             baton->bufferOutLength, ab, 0, napi_uint8_array);
-          Callback().Call(Receiver().Value(), { env.Null(), data, info });
+          Callback().MakeCallback(Receiver().Value(), { env.Null(), data, info });
         } else {
           // Node.js Buffer
           Napi::Buffer<char> data = Napi::Buffer<char>::NewOrCopy(env, static_cast<char*>(baton->bufferOut),
             baton->bufferOutLength, sharp::FreeCallback);
-          Callback().Call(Receiver().Value(), { env.Null(), data, info });
+          Callback().MakeCallback(Receiver().Value(), { env.Null(), data, info });
         }
       } else {
         // Add file size to info
@@ -1371,10 +1371,10 @@ class PipelineWorker : public Napi::AsyncWorker {
             info.Set("size", size);
           } catch (...) {}
         }
-        Callback().Call(Receiver().Value(), { env.Null(), info });
+        Callback().MakeCallback(Receiver().Value(), { env.Null(), info });
       }
     } else {
-      Callback().Call(Receiver().Value(), { Napi::Error::New(env, sharp::TrimEnd(baton->err)).Value() });
+      Callback().MakeCallback(Receiver().Value(), { Napi::Error::New(env, sharp::TrimEnd(baton->err)).Value() });
     }
 
     // Delete baton
@@ -1395,7 +1395,7 @@ class PipelineWorker : public Napi::AsyncWorker {
     // Decrement processing task counter
     sharp::counterProcess--;
     Napi::Number queueLength = Napi::Number::New(env, static_cast<int>(sharp::counterQueue));
-    queueListener.Call(Receiver().Value(), { queueLength });
+    queueListener.MakeCallback(Receiver().Value(), { queueLength });
   }
 
  private:
@@ -1833,7 +1833,7 @@ Napi::Value pipeline(const Napi::CallbackInfo& info) {
 
   // Increment queued task counter
   Napi::Number queueLength = Napi::Number::New(info.Env(), static_cast<int>(++sharp::counterQueue));
-  queueListener.Call(info.This(), { queueLength });
+  queueListener.MakeCallback(info.This(), { queueLength });
 
   return info.Env().Undefined();
 }

package/src/stats.cc

@@ -109,7 +109,7 @@ class StatsWorker : public Napi::AsyncWorker {
     // Handle warnings
     std::string warning = sharp::VipsWarningPop();
     while (!warning.empty()) {
-      debuglog.Call(Receiver().Value(), { Napi::String::New(env, warning) });
+      debuglog.MakeCallback(Receiver().Value(), { Napi::String::New(env, warning) });
       warning = sharp::VipsWarningPop();
     }
     if (baton->err.empty()) {
@@ -143,9 +143,9 @@ class StatsWorker : public Napi::AsyncWorker {
       dominant.Set("g", baton->dominantGreen);
       dominant.Set("b", baton->dominantBlue);
       info.Set("dominant", dominant);
-      Callback().Call(Receiver().Value(), { env.Null(), info });
+      Callback().MakeCallback(Receiver().Value(), { env.Null(), info });
     } else {
-      Callback().Call(Receiver().Value(), { Napi::Error::New(env, sharp::TrimEnd(baton->err)).Value() });
+      Callback().MakeCallback(Receiver().Value(), { Napi::Error::New(env, sharp::TrimEnd(baton->err)).Value() });
     }
 
     delete baton->input;