sharp 0.33.0-alpha.7 → 0.33.0-alpha.9

package/lib/index.d.ts

@@ -640,7 +640,7 @@ declare namespace sharp {
          * @param withMetadata
          * @throws {Error} Invalid parameters.
          */
-        withMetadata(withMetadata?: WriteableMetadata): Sharp;
+        withMetadata(withMetadata?: boolean | WriteableMetadata): Sharp;
 
         /**
          * Use these JPEG options for output image.
@@ -1275,10 +1275,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 {

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

@@ -48,7 +48,7 @@ const buildPlatformArch = () => {
 
 const buildSharpLibvipsIncludeDir = () => {
   try {
-    return require('@sharpen/sharp-libvips-dev/include');
+    return require('@img/sharp-libvips-dev/include');
   } catch {}
   /* istanbul ignore next */
   return '';
@@ -56,7 +56,7 @@ const buildSharpLibvipsIncludeDir = () => {
 
 const buildSharpLibvipsCPlusPlusDir = () => {
   try {
-    return require('@sharpen/sharp-libvips-dev/cplusplus');
+    return require('@img/sharp-libvips-dev/cplusplus');
   } catch {}
   /* istanbul ignore next */
   return '';
@@ -64,7 +64,7 @@ const buildSharpLibvipsCPlusPlusDir = () => {
 
 const buildSharpLibvipsLibDir = () => {
   try {
-    return require(`@sharpen/sharp-libvips-${buildPlatformArch()}/lib`);
+    return require(`@img/sharp-libvips-${buildPlatformArch()}/lib`);
   } catch {}
   /* istanbul ignore next */
   return '';

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,7 +158,8 @@ 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);
 }
 
 /**
@@ -1282,7 +1284,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 +1294,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 +1328,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 +1344,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 +1363,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 +1379,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 });

package/lib/sharp.js

@@ -18,7 +18,7 @@ try {
 } catch (errLocal) {
   try {
     // Check for runtime package
-    module.exports = require(`@sharpen/sharp-${runtimePlatform}/sharp.node`);
+    module.exports = require(`@img/sharp-${runtimePlatform}/sharp.node`);
   } catch (errPackage) {
     const help = ['Could not load the "sharp" module at runtime'];
     if (errLocal.code !== 'MODULE_NOT_FOUND') {
@@ -30,20 +30,19 @@ try {
     help.push('Possible solutions:');
     // Common error messages
     if (prebuiltPlatforms.includes(runtimePlatform)) {
-      help.push('- Add explicit dependencies for the runtime platform:');
-      help.push(`    npm install --force @sharpen/sharp-${runtimePlatform}`);
-      if (!isWindows) {
-        help.push(`    npm install --force @sharpen/sharp-libvips-${runtimePlatform}`);
-      }
+      help.push('- Add an explicit dependency for the runtime platform:');
+      help.push(`    npm install --force @img/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 { 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: found ${libcFound}, requires ${libcRequires}`);
+        help.push('- Update your OS:');
+        help.push(`    Found ${libcFound}`);
+        help.push(`    Requires ${libcRequires}`);
       } catch (errEngines) {}
     }
     if (isMacOs && /Incompatible library version/.test(errLocal.message)) {
@@ -54,7 +53,7 @@ try {
       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('- Use a supported yarn linker, either pnpm or node-modules:');
       help.push('    yarn config set nodeLinker node-modules');
     }
     // Link to installation docs

package/lib/utility.js

@@ -60,10 +60,10 @@ let versions = {
 /* istanbul ignore next */
 if (!libvipsVersion.isGlobal) {
   try {
-    versions = require(`@sharpen/sharp-${runtimePlatform}/versions`);
+    versions = require(`@img/sharp-${runtimePlatform}/versions`);
   } catch (_) {
     try {
-      versions = require(`@sharpen/sharp-libvips-${runtimePlatform}/versions`);
+      versions = require(`@img/sharp-libvips-${runtimePlatform}/versions`);
     } catch (_) {}
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sharp",
   "description": "High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP, GIF, AVIF and TIFF images",
-  "version": "0.33.0-alpha.7",
+  "version": "0.33.0-alpha.9",
   "author": "Lovell Fuller <npm@lovell.info>",
   "homepage": "https://github.com/lovell/sharp",
   "contributors": [
@@ -139,27 +139,27 @@
     "semver": "^7.5.4"
   },
   "optionalDependencies": {
-    "@sharpen/sharp-darwin-arm64": "0.0.1-alpha.7",
-    "@sharpen/sharp-darwin-x64": "0.0.1-alpha.7",
-    "@sharpen/sharp-libvips-darwin-arm64": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-darwin-x64": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-linux-arm": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-linux-arm64": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-linux-x64": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-linuxmusl-arm64": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-linuxmusl-x64": "0.0.1-alpha.2",
-    "@sharpen/sharp-linux-arm": "0.0.1-alpha.7",
-    "@sharpen/sharp-linux-arm64": "0.0.1-alpha.7",
-    "@sharpen/sharp-linux-x64": "0.0.1-alpha.7",
-    "@sharpen/sharp-linuxmusl-arm64": "0.0.1-alpha.7",
-    "@sharpen/sharp-linuxmusl-x64": "0.0.1-alpha.7",
-    "@sharpen/sharp-win32-ia32": "0.0.1-alpha.7",
-    "@sharpen/sharp-win32-x64": "0.0.1-alpha.7"
+    "@img/sharp-darwin-arm64": "0.33.0-alpha.9",
+    "@img/sharp-darwin-x64": "0.33.0-alpha.9",
+    "@img/sharp-libvips-darwin-arm64": "0.0.1",
+    "@img/sharp-libvips-darwin-x64": "0.0.1",
+    "@img/sharp-libvips-linux-arm": "0.0.1",
+    "@img/sharp-libvips-linux-arm64": "0.0.1",
+    "@img/sharp-libvips-linux-x64": "0.0.1",
+    "@img/sharp-libvips-linuxmusl-arm64": "0.0.1",
+    "@img/sharp-libvips-linuxmusl-x64": "0.0.1",
+    "@img/sharp-linux-arm": "0.33.0-alpha.9",
+    "@img/sharp-linux-arm64": "0.33.0-alpha.9",
+    "@img/sharp-linux-x64": "0.33.0-alpha.9",
+    "@img/sharp-linuxmusl-arm64": "0.33.0-alpha.9",
+    "@img/sharp-linuxmusl-x64": "0.33.0-alpha.9",
+    "@img/sharp-win32-ia32": "0.33.0-alpha.9",
+    "@img/sharp-win32-x64": "0.33.0-alpha.9"
   },
   "devDependencies": {
-    "@sharpen/sharp-libvips-dev": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-win32-ia32": "0.0.1-alpha.2",
-    "@sharpen/sharp-libvips-win32-x64": "0.0.1-alpha.2",
+    "@img/sharp-libvips-dev": "0.0.1",
+    "@img/sharp-libvips-win32-ia32": "0.0.1",
+    "@img/sharp-libvips-win32-x64": "0.0.1",
     "@types/node": "*",
     "async": "^3.2.4",
     "cc": "^3.0.1",

package/src/binding.gyp

@@ -157,8 +157,8 @@
               'OTHER_LDFLAGS': [
                 # Ensure runtime linking is relative to sharp.node
                 '-Wl,-rpath,\'@loader_path/../../sharp-libvips-<(platform_and_arch)/lib\'',
-                '-Wl,-rpath,\'@loader_path/../../node_modules/@sharpen/sharp-libvips-<(platform_and_arch)/lib\'',
-                '-Wl,-rpath,\'@loader_path/../../../node_modules/@sharpen/sharp-libvips-<(platform_and_arch)/lib\''
+                '-Wl,-rpath,\'@loader_path/../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
+                '-Wl,-rpath,\'@loader_path/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
               ]
             }
           }],
@@ -178,8 +178,8 @@
                 '-Wl,-s',
                 '-Wl,--disable-new-dtags',
                 '-Wl,-rpath=\'$$ORIGIN/../../sharp-libvips-<(platform_and_arch)/lib\'',
-                '-Wl,-rpath=\'$$ORIGIN/../../node_modules/@sharpen/sharp-libvips-<(platform_and_arch)/lib\'',
-                '-Wl,-rpath=\'$$ORIGIN/../../../node_modules/@sharpen/sharp-libvips-<(platform_and_arch)/lib\''
+                '-Wl,-rpath=\'$$ORIGIN/../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\'',
+                '-Wl,-rpath=\'$$ORIGIN/../../../node_modules/@img/sharp-libvips-<(platform_and_arch)/lib\''
               ]
             }
           }]