@depup/sharp 0.34.5-depup.0 → 0.35.4-depup.0

package/dist/index.mjs

@@ -0,0 +1,25 @@
+/*!
+  Copyright 2013 Lovell Fuller and others.
+  SPDX-License-Identifier: Apache-2.0
+*/
+
+import Sharp from './constructor.mjs';
+import input from './input.mjs';
+import resize from './resize.mjs';
+import composite from './composite.mjs';
+import operation from './operation.mjs';
+import colour from './colour.mjs';
+import channel from './channel.mjs';
+import output from './output.mjs';
+import utility from './utility.mjs';
+
+input(Sharp);
+resize(Sharp);
+composite(Sharp);
+operation(Sharp);
+colour(Sharp);
+channel(Sharp);
+output(Sharp);
+utility(Sharp);
+
+export default Sharp;

package/{lib/input.js → dist/input.cjs}

@@ -3,8 +3,8 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const is = require('./is');
-const sharp = require('./sharp');
+const is = require('./is.cjs');
+const sharp = require('./sharp.cjs');
 
 /**
  * Justification alignment
@@ -24,13 +24,13 @@ const align = {
 
 const inputStreamParameters = [
   // Limits and error handling
-  'failOn', 'limitInputPixels', 'unlimited',
+  'failOn', 'limitInputPixels', 'limitInputChannels', 'unlimited',
   // Format-generic
   'animated', 'autoOrient', 'density', 'ignoreIcc', 'page', 'pages', 'sequentialRead',
   // Format-specific
   'jp2', 'openSlide', 'pdf', 'raw', 'svg', 'tiff',
   // Deprecated
-  'failOnError', 'openSlideLevel', 'pdfBackground', 'tiffSubifd'
+  'openSlideLevel', 'pdfBackground', 'tiffSubifd'
 ];
 
 /**
@@ -55,6 +55,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     autoOrient: false,
     failOn: 'warning',
     limitInputPixels: 0x3FFF ** 2,
+    limitInputChannels: 5,
     ignoreIcc: false,
     unlimited: false,
     sequentialRead: true
@@ -106,14 +107,6 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     }`);
   }
   if (is.object(inputOptions)) {
-    // Deprecated: failOnError
-    if (is.defined(inputOptions.failOnError)) {
-      if (is.bool(inputOptions.failOnError)) {
-        inputDescriptor.failOn = inputOptions.failOnError ? 'warning' : 'none';
-      } else {
-        throw is.invalidParameterError('failOnError', 'boolean', inputOptions.failOnError);
-      }
-    }
     // failOn
     if (is.defined(inputOptions.failOn)) {
       if (is.string(inputOptions.failOn) && is.inArray(inputOptions.failOn, ['none', 'truncated', 'error', 'warning'])) {
@@ -132,7 +125,7 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     }
     // Density
     if (is.defined(inputOptions.density)) {
-      if (is.inRange(inputOptions.density, 1, 100000)) {
+      if (is.number(inputOptions.density) && is.inRange(inputOptions.density, 1, 100000)) {
         inputDescriptor.density = inputOptions.density;
       } else {
         throw is.invalidParameterError('density', 'number between 1 and 100000', inputOptions.density);
@@ -158,6 +151,16 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
         throw is.invalidParameterError('limitInputPixels', 'positive integer', inputOptions.limitInputPixels);
       }
     }
+    // limitInputChannels
+    if (is.defined(inputOptions.limitInputChannels)) {
+      if (is.bool(inputOptions.limitInputChannels)) {
+        inputDescriptor.limitInputChannels = inputOptions.limitInputChannels ? 5 : 0;
+      } else if (is.integer(inputOptions.limitInputChannels) && is.inRange(inputOptions.limitInputChannels, 0, Number.MAX_SAFE_INTEGER)) {
+        inputDescriptor.limitInputChannels = inputOptions.limitInputChannels;
+      } else {
+        throw is.invalidParameterError('limitInputChannels', 'positive integer', inputOptions.limitInputChannels);
+      }
+    }
     // unlimited
     if (is.defined(inputOptions.unlimited)) {
       if (is.bool(inputOptions.unlimited)) {
@@ -178,8 +181,8 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     if (is.defined(inputOptions.raw)) {
       if (
         is.object(inputOptions.raw) &&
-        is.integer(inputOptions.raw.width) && inputOptions.raw.width > 0 &&
-        is.integer(inputOptions.raw.height) && inputOptions.raw.height > 0 &&
+        is.integer(inputOptions.raw.width) && is.inRange(inputOptions.raw.width, 1, 100000000) &&
+        is.integer(inputOptions.raw.height) && is.inRange(inputOptions.raw.height, 1, 100000000) &&
         is.integer(inputOptions.raw.channels) && is.inRange(inputOptions.raw.channels, 1, 4)
       ) {
         inputDescriptor.rawWidth = inputOptions.raw.width;
@@ -326,8 +329,8 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
     if (is.defined(inputOptions.create)) {
       if (
         is.object(inputOptions.create) &&
-        is.integer(inputOptions.create.width) && inputOptions.create.width > 0 &&
-        is.integer(inputOptions.create.height) && inputOptions.create.height > 0 &&
+        is.integer(inputOptions.create.width) && is.inRange(inputOptions.create.width, 1, 100000000) &&
+        is.integer(inputOptions.create.height) && is.inRange(inputOptions.create.height, 1, 100000000) &&
         is.integer(inputOptions.create.channels)
       ) {
         inputDescriptor.createWidth = inputOptions.create.width;
@@ -407,17 +410,17 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
           }
         }
         if (is.defined(inputOptions.text.width)) {
-          if (is.integer(inputOptions.text.width) && inputOptions.text.width > 0) {
+          if (is.integer(inputOptions.text.width) && is.inRange(inputOptions.text.width, 1, 1000000)) {
             inputDescriptor.textWidth = inputOptions.text.width;
           } else {
-            throw is.invalidParameterError('text.width', 'positive integer', inputOptions.text.width);
+            throw is.invalidParameterError('text.width', 'integer between 1 and 1000000', inputOptions.text.width);
           }
         }
         if (is.defined(inputOptions.text.height)) {
-          if (is.integer(inputOptions.text.height) && inputOptions.text.height > 0) {
+          if (is.integer(inputOptions.text.height) && is.inRange(inputOptions.text.height, 1, 1000000)) {
             inputDescriptor.textHeight = inputOptions.text.height;
           } else {
-            throw is.invalidParameterError('text.height', 'positive integer', inputOptions.text.height);
+            throw is.invalidParameterError('text.height', 'integer between 1 and 1000000', inputOptions.text.height);
           }
         }
         if (is.defined(inputOptions.text.align)) {
@@ -528,11 +531,6 @@ function _createInputDescriptor (input, inputOptions, containerOptions) {
 function _write (chunk, _encoding, callback) {
   if (Array.isArray(this.options.input.buffer)) {
     if (is.buffer(chunk)) {
-      if (this.options.input.buffer.length === 0) {
-        this.on('finish', () => {
-          this.streamInFinished = true;
-        });
-      }
       this.options.input.buffer.push(chunk);
       callback();
     } else {
@@ -562,6 +560,20 @@ function _isStreamInput () {
   return Array.isArray(this.options.input.buffer);
 }
 
+/**
+ * Call fn when the Writable side of Stream-based input has finished,
+ * or immediately when it already has, as 'finish' is emitted only once.
+ * @private
+ * @param {Function} fn
+ */
+function _whenStreamInFinished (fn) {
+  if (this.writableFinished) {
+    fn();
+  } else {
+    this.once('finish', fn);
+  }
+}
+
 /**
  * Fast access to (uncached) image metadata without decoding any compressed pixel data.
  *
@@ -574,7 +586,8 @@ function _isStreamInput () {
  *
  * A `Promise` is returned when `callback` is not provided.
  *
- * - `format`: Name of decoder used to decompress image data e.g. `jpeg`, `png`, `webp`, `gif`, `svg`
+ * - `format`: Name of decoder used to parse image e.g. `jpeg`, `png`, `webp`, `gif`, `svg`, `heif`, `tiff`
+ * - `mediaType`: Media Type (MIME Type) e.g. `image/jpeg`, `image/png`, `image/svg+xml`, `image/avif`
  * - `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)
@@ -607,6 +620,7 @@ function _isStreamInput () {
  * - `tifftagPhotoshop`: Buffer containing raw TIFFTAG_PHOTOSHOP data, if present
  * - `formatMagick`: String containing format for images loaded via *magick
  * - `comments`: Array of keyword/text pairs representing PNG text blocks, if present.
+ * - `gainMap.image`: HDR gain map, if present, as compressed JPEG image.
  *
  * @example
  * const metadata = await sharp(input).metadata();
@@ -637,7 +651,7 @@ function metadata (callback) {
   const stack = Error();
   if (is.fn(callback)) {
     if (this._isStreamInput()) {
-      this.on('finish', () => {
+      this._whenStreamInFinished(() => {
         this._flattenBufferIn();
         sharp.metadata(this.options, (err, metadata) => {
           if (err) {
@@ -660,7 +674,7 @@ function metadata (callback) {
   } else {
     if (this._isStreamInput()) {
       return new Promise((resolve, reject) => {
-        const finished = () => {
+        this._whenStreamInFinished(() => {
           this._flattenBufferIn();
           sharp.metadata(this.options, (err, metadata) => {
             if (err) {
@@ -669,12 +683,7 @@ function metadata (callback) {
               resolve(metadata);
             }
           });
-        };
-        if (this.writableFinished) {
-          finished();
-        } else {
-          this.once('finish', finished);
-        }
+        });
       });
     } else {
       return new Promise((resolve, reject) => {
@@ -739,7 +748,7 @@ function stats (callback) {
   const stack = Error();
   if (is.fn(callback)) {
     if (this._isStreamInput()) {
-      this.on('finish', () => {
+      this._whenStreamInFinished(() => {
         this._flattenBufferIn();
         sharp.stats(this.options, (err, stats) => {
           if (err) {
@@ -762,7 +771,7 @@ function stats (callback) {
   } else {
     if (this._isStreamInput()) {
       return new Promise((resolve, reject) => {
-        this.on('finish', function () {
+        this._whenStreamInFinished(() => {
           this._flattenBufferIn();
           sharp.stats(this.options, (err, stats) => {
             if (err) {
@@ -800,6 +809,7 @@ module.exports = (Sharp) => {
     _write,
     _flattenBufferIn,
     _isStreamInput,
+    _whenStreamInFinished,
     // Public
     metadata,
     stats