@revizly/sharp 0.35.0-revizly4 → 0.35.0-revizly41

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

@@ -3,7 +3,7 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const is = require('./is');
+const is = require('./is.cjs');
 
 /**
  * Weighting to apply when using contain/cover fit.
@@ -386,48 +386,52 @@ function resize (widthOrOptions, height, options) {
  *   ...
  *
  * @param {(number|Object)} extend - single pixel count to add to all edges or an Object with per-edge counts
- * @param {number} [extend.top=0]
- * @param {number} [extend.left=0]
- * @param {number} [extend.bottom=0]
- * @param {number} [extend.right=0]
+ * @param {number} [extend.top=0] - number of pixels to add to the top edge, valid values are integers in the range 0-10000
+ * @param {number} [extend.left=0] - number of pixels to add to the left edge, valid values are integers in the range 0-10000
+ * @param {number} [extend.bottom=0] - number of pixels to add to the bottom edge, valid values are integers in the range 0-10000
+ * @param {number} [extend.right=0] - number of pixels to add to the right edge, valid values are integers in the range 0-10000
  * @param {String} [extend.extendWith='background'] - populate new pixels using this method, one of: background, copy, repeat, mirror.
  * @param {String|Object} [extend.background={r: 0, g: 0, b: 0, alpha: 1}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to black without transparency.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
 */
 function extend (extend) {
-  if (is.integer(extend) && extend > 0) {
-    this.options.extendTop = extend;
-    this.options.extendBottom = extend;
-    this.options.extendLeft = extend;
-    this.options.extendRight = extend;
+  if (is.integer(extend)) {
+    if (is.inRange(extend, 1, 10000)) {
+      this.options.extendTop = extend;
+      this.options.extendBottom = extend;
+      this.options.extendLeft = extend;
+      this.options.extendRight = extend;
+    } else {
+      throw is.invalidParameterError('extend', 'integer between 1 and 10000', extend);
+    }
   } else if (is.object(extend)) {
     if (is.defined(extend.top)) {
-      if (is.integer(extend.top) && extend.top >= 0) {
+      if (is.integer(extend.top) && is.inRange(extend.top, 0, 10000)) {
         this.options.extendTop = extend.top;
       } else {
-        throw is.invalidParameterError('top', 'positive integer', extend.top);
+        throw is.invalidParameterError('top', 'integer between 0 and 10000', extend.top);
       }
     }
     if (is.defined(extend.bottom)) {
-      if (is.integer(extend.bottom) && extend.bottom >= 0) {
+      if (is.integer(extend.bottom) && is.inRange(extend.bottom, 0, 10000)) {
         this.options.extendBottom = extend.bottom;
       } else {
-        throw is.invalidParameterError('bottom', 'positive integer', extend.bottom);
+        throw is.invalidParameterError('bottom', 'integer between 0 and 10000', extend.bottom);
       }
     }
     if (is.defined(extend.left)) {
-      if (is.integer(extend.left) && extend.left >= 0) {
+      if (is.integer(extend.left) && is.inRange(extend.left, 0, 10000)) {
         this.options.extendLeft = extend.left;
       } else {
-        throw is.invalidParameterError('left', 'positive integer', extend.left);
+        throw is.invalidParameterError('left', 'integer between 0 and 10000', extend.left);
       }
     }
     if (is.defined(extend.right)) {
-      if (is.integer(extend.right) && extend.right >= 0) {
+      if (is.integer(extend.right) && is.inRange(extend.right, 0, 10000)) {
         this.options.extendRight = extend.right;
       } else {
-        throw is.invalidParameterError('right', 'positive integer', extend.right);
+        throw is.invalidParameterError('right', 'integer between 0 and 10000', extend.right);
       }
     }
     this._setBackgroundColourOption('extendBackground', extend.background);
@@ -467,10 +471,10 @@ function extend (extend) {
  *   });
  *
  * @param {Object} options - describes the region to extract using integral pixel values
- * @param {number} options.left - zero-indexed offset from left edge
- * @param {number} options.top - zero-indexed offset from top edge
- * @param {number} options.width - width of region to extract
- * @param {number} options.height - height of region to extract
+ * @param {number} options.left - zero-indexed offset from left edge, an integer between 0 and 100000000
+ * @param {number} options.top - zero-indexed offset from top edge, an integer between 0 and 100000000
+ * @param {number} options.width - width of region to extract, an integer between 0 and 100000000
+ * @param {number} options.height - height of region to extract, an integer between 0 and 100000000
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -481,10 +485,10 @@ function extract (options) {
   }
   ['left', 'top', 'width', 'height'].forEach(function (name) {
     const value = options[name];
-    if (is.integer(value) && value >= 0) {
+    if (is.integer(value) && is.inRange(value, 0, 100000000)) {
       this.options[name + (name === 'left' || name === 'top' ? 'Offset' : '') + suffix] = value;
     } else {
-      throw is.invalidParameterError(name, 'integer', value);
+      throw is.invalidParameterError(name, 'integer between 0 and 100000000', value);
     }
   }, this);
   // Ensure existing rotation occurs before pre-resize extraction
@@ -506,6 +510,8 @@ function extract (options) {
  *
  * If the result of this operation would trim an image to nothing then no change is made.
  *
+ * Use the `lineArt` and `threshold` options for control over sensitivity.
+ *
  * The `info` response Object will contain `trimOffsetLeft` and `trimOffsetTop` properties.
  *
  * @example
@@ -540,10 +546,19 @@ function extract (options) {
  *   })
  *   .toBuffer();
  *
+ * @example
+ * // Trim image leaving (up to) a 10 pixel margin around the trimmed content.
+ * const output = await sharp(input)
+ *   .trim({
+ *     margin: 10
+ *   })
+ *   .toBuffer();
+ *
  * @param {Object} [options]
  * @param {string|Object} [options.background='top-left pixel'] - Background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to that of the top-left pixel.
  * @param {number} [options.threshold=10] - Allowed difference from the above colour, a positive number.
  * @param {boolean} [options.lineArt=false] - Does the input more closely resemble line art (e.g. vector) rather than being photographic?
+ * @param {number} [options.margin=0] - Leave a margin around trimmed content, integral number of pixels between 0 and 10000000.
  * @returns {Sharp}
  * @throws {Error} Invalid parameters
  */
@@ -564,6 +579,13 @@ function trim (options) {
       if (is.defined(options.lineArt)) {
         this._setBooleanOption('trimLineArt', options.lineArt);
       }
+      if (is.defined(options.margin)) {
+        if (is.integer(options.margin) && is.inRange(options.margin, 0, 10000000)) {
+          this.options.trimMargin = options.margin;
+        } else {
+          throw is.invalidParameterError('margin', 'integer between 0 and 10000000', options.margin);
+        }
+      }
     } else {
       throw is.invalidParameterError('trim', 'object', options);
     }