@depup/sharp 0.34.5-depup.0 → 0.35.4-depup.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -109
- package/changes.json +5 -0
- package/{lib/channel.js → dist/channel.cjs} +1 -1
- package/dist/channel.mjs +177 -0
- package/{lib/colour.js → dist/colour.cjs} +11 -7
- package/dist/colour.mjs +199 -0
- package/{lib/composite.js → dist/composite.cjs} +8 -7
- package/dist/composite.mjs +213 -0
- package/{lib/constructor.js → dist/constructor.cjs} +42 -30
- package/dist/constructor.mjs +511 -0
- package/dist/index.cjs +25 -0
- package/dist/index.d.cts +1999 -0
- package/dist/index.d.mts +2046 -0
- package/dist/index.mjs +25 -0
- package/{lib/input.js → dist/input.cjs} +47 -37
- package/dist/input.mjs +819 -0
- package/{lib/is.js → dist/is.cjs} +1 -1
- package/dist/is.mjs +143 -0
- package/{lib/libvips.js → dist/libvips.cjs} +35 -30
- package/dist/libvips.mjs +212 -0
- package/{lib/operation.js → dist/operation.cjs} +37 -51
- package/dist/operation.mjs +1002 -0
- package/{lib/output.js → dist/output.cjs} +166 -47
- package/dist/output.mjs +1785 -0
- package/{lib/resize.js → dist/resize.cjs} +54 -32
- package/dist/resize.mjs +617 -0
- package/dist/sharp.cjs +174 -0
- package/dist/sharp.mjs +174 -0
- package/{lib/utility.js → dist/utility.cjs} +18 -8
- package/dist/utility.mjs +301 -0
- package/install/build.js +3 -3
- package/lib/index.d.ts +111 -83
- package/package.json +95 -54
- package/src/binding.gyp +19 -14
- package/src/common.cc +77 -21
- package/src/common.h +23 -4
- package/src/metadata.cc +66 -8
- package/src/metadata.h +6 -1
- package/src/operations.cc +25 -8
- package/src/operations.h +1 -1
- package/src/pipeline.cc +203 -69
- package/src/pipeline.h +15 -1
- package/src/stats.cc +6 -6
- package/src/utilities.cc +7 -6
- package/install/check.js +0 -14
- package/lib/index.js +0 -16
- package/lib/sharp.js +0 -121
package/README.md
CHANGED
|
@@ -1,118 +1,25 @@
|
|
|
1
|
-
# sharp
|
|
1
|
+
# @depup/sharp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Dependency-bumped version of [sharp](https://www.npmjs.com/package/sharp)
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
smaller, web-friendly JPEG, PNG, WebP, GIF and AVIF images of varying dimensions.
|
|
5
|
+
Generated by [DepUp](https://github.com/depup/npm) -- all production
|
|
6
|
+
dependencies bumped to latest versions.
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
that provide support for Node-API v9, including
|
|
11
|
-
Node.js (^18.17.0 or >= 20.3.0), Deno and Bun.
|
|
8
|
+
## Installation
|
|
12
9
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
due to its use of [libvips](https://github.com/libvips/libvips).
|
|
16
|
-
|
|
17
|
-
Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
|
|
18
|
-
Lanczos resampling ensures quality is not sacrificed for speed.
|
|
19
|
-
|
|
20
|
-
As well as image resizing, operations such as
|
|
21
|
-
rotation, extraction, compositing and gamma correction are available.
|
|
22
|
-
|
|
23
|
-
Most modern macOS, Windows and Linux systems
|
|
24
|
-
do not require any additional install or runtime dependencies.
|
|
25
|
-
|
|
26
|
-
## Documentation
|
|
27
|
-
|
|
28
|
-
Visit [sharp.pixelplumbing.com](https://sharp.pixelplumbing.com/) for complete
|
|
29
|
-
[installation instructions](https://sharp.pixelplumbing.com/install),
|
|
30
|
-
[API documentation](https://sharp.pixelplumbing.com/api-constructor),
|
|
31
|
-
[benchmark tests](https://sharp.pixelplumbing.com/performance) and
|
|
32
|
-
[changelog](https://sharp.pixelplumbing.com/changelog).
|
|
33
|
-
|
|
34
|
-
## Examples
|
|
35
|
-
|
|
36
|
-
```sh
|
|
37
|
-
npm install sharp
|
|
10
|
+
```bash
|
|
11
|
+
npm install @depup/sharp
|
|
38
12
|
```
|
|
39
13
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
```javascript
|
|
47
|
-
sharp(inputBuffer)
|
|
48
|
-
.resize(320, 240)
|
|
49
|
-
.toFile('output.webp', (err, info) => { ... });
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Promise
|
|
53
|
-
|
|
54
|
-
```javascript
|
|
55
|
-
sharp('input.jpg')
|
|
56
|
-
.rotate()
|
|
57
|
-
.resize(200)
|
|
58
|
-
.jpeg({ mozjpeg: true })
|
|
59
|
-
.toBuffer()
|
|
60
|
-
.then( data => { ... })
|
|
61
|
-
.catch( err => { ... });
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Async/await
|
|
65
|
-
|
|
66
|
-
```javascript
|
|
67
|
-
const semiTransparentRedPng = await sharp({
|
|
68
|
-
create: {
|
|
69
|
-
width: 48,
|
|
70
|
-
height: 48,
|
|
71
|
-
channels: 4,
|
|
72
|
-
background: { r: 255, g: 0, b: 0, alpha: 0.5 }
|
|
73
|
-
}
|
|
74
|
-
})
|
|
75
|
-
.png()
|
|
76
|
-
.toBuffer();
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
### Stream
|
|
80
|
-
|
|
81
|
-
```javascript
|
|
82
|
-
const roundedCorners = Buffer.from(
|
|
83
|
-
'<svg><rect x="0" y="0" width="200" height="200" rx="50" ry="50"/></svg>'
|
|
84
|
-
);
|
|
85
|
-
|
|
86
|
-
const roundedCornerResizer =
|
|
87
|
-
sharp()
|
|
88
|
-
.resize(200, 200)
|
|
89
|
-
.composite([{
|
|
90
|
-
input: roundedCorners,
|
|
91
|
-
blend: 'dest-in'
|
|
92
|
-
}])
|
|
93
|
-
.png();
|
|
94
|
-
|
|
95
|
-
readableStream
|
|
96
|
-
.pipe(roundedCornerResizer)
|
|
97
|
-
.pipe(writableStream);
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
## Contributing
|
|
101
|
-
|
|
102
|
-
A [guide for contributors](https://github.com/lovell/sharp/blob/main/.github/CONTRIBUTING.md)
|
|
103
|
-
covers reporting bugs, requesting features and submitting code changes.
|
|
104
|
-
|
|
105
|
-
## Licensing
|
|
14
|
+
| Field | Value |
|
|
15
|
+
|-------|-------|
|
|
16
|
+
| Original | [sharp](https://www.npmjs.com/package/sharp) @ 0.35.4 |
|
|
17
|
+
| Processed | 2026-08-30 |
|
|
18
|
+
| Smoke test | passed |
|
|
19
|
+
| Deps updated | 0 |
|
|
106
20
|
|
|
107
|
-
|
|
21
|
+
---
|
|
108
22
|
|
|
109
|
-
|
|
110
|
-
you may not use this file except in compliance with the License.
|
|
111
|
-
You may obtain a copy of the License at
|
|
112
|
-
[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
|
23
|
+
Source: https://github.com/depup/npm | Original: https://www.npmjs.com/package/sharp
|
|
113
24
|
|
|
114
|
-
|
|
115
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
116
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
117
|
-
See the License for the specific language governing permissions and
|
|
118
|
-
limitations under the License.
|
|
25
|
+
License inherited from the original package.
|
package/changes.json
ADDED
package/dist/channel.mjs
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
Copyright 2013 Lovell Fuller and others.
|
|
3
|
+
SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import is from './is.mjs';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Boolean operations for bandbool.
|
|
10
|
+
* @private
|
|
11
|
+
*/
|
|
12
|
+
const bool = {
|
|
13
|
+
and: 'and',
|
|
14
|
+
or: 'or',
|
|
15
|
+
eor: 'eor'
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Remove alpha channels, if any. This is a no-op if the image does not have an alpha channel.
|
|
20
|
+
*
|
|
21
|
+
* See also {@link /api-operation/#flatten flatten}.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* sharp('rgba.png')
|
|
25
|
+
* .removeAlpha()
|
|
26
|
+
* .toFile('rgb.png', function(err, info) {
|
|
27
|
+
* // rgb.png is a 3 channel image without an alpha channel
|
|
28
|
+
* });
|
|
29
|
+
*
|
|
30
|
+
* @returns {Sharp}
|
|
31
|
+
*/
|
|
32
|
+
function removeAlpha () {
|
|
33
|
+
this.options.removeAlpha = true;
|
|
34
|
+
return this;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Ensure the output image has an alpha transparency channel.
|
|
39
|
+
* If missing, the added alpha channel will have the specified
|
|
40
|
+
* transparency level, defaulting to fully-opaque (1).
|
|
41
|
+
* This is a no-op if the image already has an alpha channel.
|
|
42
|
+
*
|
|
43
|
+
* @since 0.21.2
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* // rgba.png will be a 4 channel image with a fully-opaque alpha channel
|
|
47
|
+
* await sharp('rgb.jpg')
|
|
48
|
+
* .ensureAlpha()
|
|
49
|
+
* .toFile('rgba.png')
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* // rgba is a 4 channel image with a fully-transparent alpha channel
|
|
53
|
+
* const rgba = await sharp(rgb)
|
|
54
|
+
* .ensureAlpha(0)
|
|
55
|
+
* .toBuffer();
|
|
56
|
+
*
|
|
57
|
+
* @param {number} [alpha=1] - alpha transparency level (0=fully-transparent, 1=fully-opaque)
|
|
58
|
+
* @returns {Sharp}
|
|
59
|
+
* @throws {Error} Invalid alpha transparency level
|
|
60
|
+
*/
|
|
61
|
+
function ensureAlpha (alpha) {
|
|
62
|
+
if (is.defined(alpha)) {
|
|
63
|
+
if (is.number(alpha) && is.inRange(alpha, 0, 1)) {
|
|
64
|
+
this.options.ensureAlpha = alpha;
|
|
65
|
+
} else {
|
|
66
|
+
throw is.invalidParameterError('alpha', 'number between 0 and 1', alpha);
|
|
67
|
+
}
|
|
68
|
+
} else {
|
|
69
|
+
this.options.ensureAlpha = 1;
|
|
70
|
+
}
|
|
71
|
+
return this;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* Extract a single channel from a multi-channel image.
|
|
76
|
+
*
|
|
77
|
+
* The output colourspace will be either `b-w` (8-bit) or `grey16` (16-bit).
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* // green.jpg is a greyscale image containing the green channel of the input
|
|
81
|
+
* await sharp(input)
|
|
82
|
+
* .extractChannel('green')
|
|
83
|
+
* .toFile('green.jpg');
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* // red1 is the red value of the first pixel, red2 the second pixel etc.
|
|
87
|
+
* const [red1, red2, ...] = await sharp(input)
|
|
88
|
+
* .extractChannel(0)
|
|
89
|
+
* .raw()
|
|
90
|
+
* .toBuffer();
|
|
91
|
+
*
|
|
92
|
+
* @param {number|string} channel - zero-indexed channel/band number to extract, or `red`, `green`, `blue` or `alpha`.
|
|
93
|
+
* @returns {Sharp}
|
|
94
|
+
* @throws {Error} Invalid channel
|
|
95
|
+
*/
|
|
96
|
+
function extractChannel (channel) {
|
|
97
|
+
const channelMap = { red: 0, green: 1, blue: 2, alpha: 3 };
|
|
98
|
+
if (Object.keys(channelMap).includes(channel)) {
|
|
99
|
+
channel = channelMap[channel];
|
|
100
|
+
}
|
|
101
|
+
if (is.integer(channel) && is.inRange(channel, 0, 4)) {
|
|
102
|
+
this.options.extractChannel = channel;
|
|
103
|
+
} else {
|
|
104
|
+
throw is.invalidParameterError('channel', 'integer or one of: red, green, blue, alpha', channel);
|
|
105
|
+
}
|
|
106
|
+
return this;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Join one or more channels to the image.
|
|
111
|
+
* The meaning of the added channels depends on the output colourspace, set with `toColourspace()`.
|
|
112
|
+
* By default the output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
|
|
113
|
+
* Channel ordering follows vips convention:
|
|
114
|
+
* - sRGB: 0: Red, 1: Green, 2: Blue, 3: Alpha.
|
|
115
|
+
* - CMYK: 0: Magenta, 1: Cyan, 2: Yellow, 3: Black, 4: Alpha.
|
|
116
|
+
*
|
|
117
|
+
* Buffers may be any of the image formats supported by sharp.
|
|
118
|
+
* For raw pixel input, the `options` object should contain a `raw` attribute, which follows the format of the attribute of the same name in the `sharp()` constructor.
|
|
119
|
+
*
|
|
120
|
+
* @param {Array<string|Buffer>|string|Buffer} images - one or more images (file paths, Buffers).
|
|
121
|
+
* @param {Object} options - image options, see `sharp()` constructor.
|
|
122
|
+
* @returns {Sharp}
|
|
123
|
+
* @throws {Error} Invalid parameters
|
|
124
|
+
*/
|
|
125
|
+
function joinChannel (images, options) {
|
|
126
|
+
if (Array.isArray(images)) {
|
|
127
|
+
images.forEach(function (image) {
|
|
128
|
+
this.options.joinChannelIn.push(this._createInputDescriptor(image, options));
|
|
129
|
+
}, this);
|
|
130
|
+
} else {
|
|
131
|
+
this.options.joinChannelIn.push(this._createInputDescriptor(images, options));
|
|
132
|
+
}
|
|
133
|
+
return this;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image.
|
|
138
|
+
*
|
|
139
|
+
* @example
|
|
140
|
+
* sharp('3-channel-rgb-input.png')
|
|
141
|
+
* .bandbool(sharp.bool.and)
|
|
142
|
+
* .toFile('1-channel-output.png', function (err, info) {
|
|
143
|
+
* // The output will be a single channel image where each pixel `P = R & G & B`.
|
|
144
|
+
* // If `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]`
|
|
145
|
+
* // then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
|
|
146
|
+
* });
|
|
147
|
+
*
|
|
148
|
+
* @param {string} boolOp - one of `and`, `or` or `eor` to perform that bitwise operation, like the C logic operators `&`, `|` and `^` respectively.
|
|
149
|
+
* @returns {Sharp}
|
|
150
|
+
* @throws {Error} Invalid parameters
|
|
151
|
+
*/
|
|
152
|
+
function bandbool (boolOp) {
|
|
153
|
+
if (is.string(boolOp) && is.inArray(boolOp, ['and', 'or', 'eor'])) {
|
|
154
|
+
this.options.bandBoolOp = boolOp;
|
|
155
|
+
} else {
|
|
156
|
+
throw is.invalidParameterError('boolOp', 'one of: and, or, eor', boolOp);
|
|
157
|
+
}
|
|
158
|
+
return this;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Decorate the Sharp prototype with channel-related functions.
|
|
163
|
+
* @module Sharp
|
|
164
|
+
* @private
|
|
165
|
+
*/
|
|
166
|
+
export default (Sharp) => {
|
|
167
|
+
Object.assign(Sharp.prototype, {
|
|
168
|
+
// Public instance functions
|
|
169
|
+
removeAlpha,
|
|
170
|
+
ensureAlpha,
|
|
171
|
+
extractChannel,
|
|
172
|
+
joinChannel,
|
|
173
|
+
bandbool
|
|
174
|
+
});
|
|
175
|
+
// Class attributes
|
|
176
|
+
Sharp.bool = bool;
|
|
177
|
+
};
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
const color = require('@img/colour');
|
|
7
|
-
const is = require('./is');
|
|
7
|
+
const is = require('./is.cjs');
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
10
|
* Colourspaces.
|
|
@@ -146,12 +146,16 @@ function _getBackgroundColourOption (value) {
|
|
|
146
146
|
(is.string(value) && value.length >= 3 && value.length <= 200)
|
|
147
147
|
) {
|
|
148
148
|
const colour = color(value);
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
149
|
+
const red = colour.red();
|
|
150
|
+
const green = colour.green();
|
|
151
|
+
const blue = colour.blue();
|
|
152
|
+
const alpha = Math.round(colour.alpha() * 255);
|
|
153
|
+
for (const [channel, component] of [['red', red], ['green', green], ['blue', blue], ['alpha', alpha]]) {
|
|
154
|
+
if (!is.number(component)) {
|
|
155
|
+
throw is.invalidParameterError(`background.${channel}`, 'number', component);
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
return [red, green, blue, alpha];
|
|
155
159
|
} else {
|
|
156
160
|
throw is.invalidParameterError('background', 'object or string', value);
|
|
157
161
|
}
|
package/dist/colour.mjs
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
Copyright 2013 Lovell Fuller and others.
|
|
3
|
+
SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import color from '@img/colour';
|
|
7
|
+
import is from './is.mjs';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Colourspaces.
|
|
11
|
+
* @private
|
|
12
|
+
*/
|
|
13
|
+
const colourspace = {
|
|
14
|
+
multiband: 'multiband',
|
|
15
|
+
'b-w': 'b-w',
|
|
16
|
+
bw: 'b-w',
|
|
17
|
+
cmyk: 'cmyk',
|
|
18
|
+
srgb: 'srgb'
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Tint the image using the provided colour.
|
|
23
|
+
* An alpha channel may be present and will be unchanged by the operation.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* const output = await sharp(input)
|
|
27
|
+
* .tint({ r: 255, g: 240, b: 16 })
|
|
28
|
+
* .toBuffer();
|
|
29
|
+
*
|
|
30
|
+
* @param {string|Object} tint - Parsed by the [color](https://www.npmjs.org/package/color) module.
|
|
31
|
+
* @returns {Sharp}
|
|
32
|
+
* @throws {Error} Invalid parameter
|
|
33
|
+
*/
|
|
34
|
+
function tint (tint) {
|
|
35
|
+
this._setBackgroundColourOption('tint', tint);
|
|
36
|
+
return this;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Convert to 8-bit greyscale; 256 shades of grey.
|
|
41
|
+
* 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.
|
|
42
|
+
* By default the output image will be web-friendly sRGB and contain three (identical) colour channels.
|
|
43
|
+
* This may be overridden by other sharp operations such as `toColourspace('b-w')`,
|
|
44
|
+
* which will produce an output image containing one colour channel.
|
|
45
|
+
* An alpha channel may be present, and will be unchanged by the operation.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* const output = await sharp(input).greyscale().toBuffer();
|
|
49
|
+
*
|
|
50
|
+
* @param {Boolean} [greyscale=true]
|
|
51
|
+
* @returns {Sharp}
|
|
52
|
+
*/
|
|
53
|
+
function greyscale (greyscale) {
|
|
54
|
+
this.options.greyscale = is.bool(greyscale) ? greyscale : true;
|
|
55
|
+
return this;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Alternative spelling of `greyscale`.
|
|
60
|
+
* @param {Boolean} [grayscale=true]
|
|
61
|
+
* @returns {Sharp}
|
|
62
|
+
*/
|
|
63
|
+
function grayscale (grayscale) {
|
|
64
|
+
return this.greyscale(grayscale);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* Set the pipeline colourspace.
|
|
69
|
+
*
|
|
70
|
+
* The input image will be converted to the provided colourspace at the start of the pipeline.
|
|
71
|
+
* All operations will use this colourspace before converting to the output colourspace,
|
|
72
|
+
* as defined by {@link #tocolourspace toColourspace}.
|
|
73
|
+
*
|
|
74
|
+
* @since 0.29.0
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* // Run pipeline in 16 bits per channel RGB while converting final result to 8 bits per channel sRGB.
|
|
78
|
+
* await sharp(input)
|
|
79
|
+
* .pipelineColourspace('rgb16')
|
|
80
|
+
* .toColourspace('srgb')
|
|
81
|
+
* .toFile('16bpc-pipeline-to-8bpc-output.png')
|
|
82
|
+
*
|
|
83
|
+
* @param {string} [colourspace] - pipeline colourspace e.g. `rgb16`, `scrgb`, `lab`, `grey16` [...](https://www.libvips.org/API/current/enum.Interpretation.html)
|
|
84
|
+
* @returns {Sharp}
|
|
85
|
+
* @throws {Error} Invalid parameters
|
|
86
|
+
*/
|
|
87
|
+
function pipelineColourspace (colourspace) {
|
|
88
|
+
if (!is.string(colourspace)) {
|
|
89
|
+
throw is.invalidParameterError('colourspace', 'string', colourspace);
|
|
90
|
+
}
|
|
91
|
+
this.options.colourspacePipeline = colourspace;
|
|
92
|
+
return this;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Alternative spelling of `pipelineColourspace`.
|
|
97
|
+
* @param {string} [colorspace] - pipeline colorspace.
|
|
98
|
+
* @returns {Sharp}
|
|
99
|
+
* @throws {Error} Invalid parameters
|
|
100
|
+
*/
|
|
101
|
+
function pipelineColorspace (colorspace) {
|
|
102
|
+
return this.pipelineColourspace(colorspace);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Set the output colourspace.
|
|
107
|
+
* By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* // Output 16 bits per pixel RGB
|
|
111
|
+
* await sharp(input)
|
|
112
|
+
* .toColourspace('rgb16')
|
|
113
|
+
* .toFile('16-bpp.png')
|
|
114
|
+
*
|
|
115
|
+
* @param {string} [colourspace] - output colourspace e.g. `srgb`, `rgb`, `cmyk`, `lab`, `b-w` [...](https://www.libvips.org/API/current/enum.Interpretation.html)
|
|
116
|
+
* @returns {Sharp}
|
|
117
|
+
* @throws {Error} Invalid parameters
|
|
118
|
+
*/
|
|
119
|
+
function toColourspace (colourspace) {
|
|
120
|
+
if (!is.string(colourspace)) {
|
|
121
|
+
throw is.invalidParameterError('colourspace', 'string', colourspace);
|
|
122
|
+
}
|
|
123
|
+
this.options.colourspace = colourspace;
|
|
124
|
+
return this;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Alternative spelling of `toColourspace`.
|
|
129
|
+
* @param {string} [colorspace] - output colorspace.
|
|
130
|
+
* @returns {Sharp}
|
|
131
|
+
* @throws {Error} Invalid parameters
|
|
132
|
+
*/
|
|
133
|
+
function toColorspace (colorspace) {
|
|
134
|
+
return this.toColourspace(colorspace);
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Create a RGBA colour array from a given value.
|
|
139
|
+
* @private
|
|
140
|
+
* @param {string|Object} value
|
|
141
|
+
* @throws {Error} Invalid value
|
|
142
|
+
*/
|
|
143
|
+
function _getBackgroundColourOption (value) {
|
|
144
|
+
if (
|
|
145
|
+
is.object(value) ||
|
|
146
|
+
(is.string(value) && value.length >= 3 && value.length <= 200)
|
|
147
|
+
) {
|
|
148
|
+
const colour = color(value);
|
|
149
|
+
const red = colour.red();
|
|
150
|
+
const green = colour.green();
|
|
151
|
+
const blue = colour.blue();
|
|
152
|
+
const alpha = Math.round(colour.alpha() * 255);
|
|
153
|
+
for (const [channel, component] of [['red', red], ['green', green], ['blue', blue], ['alpha', alpha]]) {
|
|
154
|
+
if (!is.number(component)) {
|
|
155
|
+
throw is.invalidParameterError(`background.${channel}`, 'number', component);
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
return [red, green, blue, alpha];
|
|
159
|
+
} else {
|
|
160
|
+
throw is.invalidParameterError('background', 'object or string', value);
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Update a colour attribute of the this.options Object.
|
|
166
|
+
* @private
|
|
167
|
+
* @param {string} key
|
|
168
|
+
* @param {string|Object} value
|
|
169
|
+
* @throws {Error} Invalid value
|
|
170
|
+
*/
|
|
171
|
+
function _setBackgroundColourOption (key, value) {
|
|
172
|
+
if (is.defined(value)) {
|
|
173
|
+
this.options[key] = _getBackgroundColourOption(value);
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Decorate the Sharp prototype with colour-related functions.
|
|
179
|
+
* @module Sharp
|
|
180
|
+
* @private
|
|
181
|
+
*/
|
|
182
|
+
export default (Sharp) => {
|
|
183
|
+
Object.assign(Sharp.prototype, {
|
|
184
|
+
// Public
|
|
185
|
+
tint,
|
|
186
|
+
greyscale,
|
|
187
|
+
grayscale,
|
|
188
|
+
pipelineColourspace,
|
|
189
|
+
pipelineColorspace,
|
|
190
|
+
toColourspace,
|
|
191
|
+
toColorspace,
|
|
192
|
+
// Private
|
|
193
|
+
_getBackgroundColourOption,
|
|
194
|
+
_setBackgroundColourOption
|
|
195
|
+
});
|
|
196
|
+
// Class attributes
|
|
197
|
+
Sharp.colourspace = colourspace;
|
|
198
|
+
Sharp.colorspace = colourspace;
|
|
199
|
+
};
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
SPDX-License-Identifier: Apache-2.0
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
|
-
const is = require('./is');
|
|
6
|
+
const is = require('./is.cjs');
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
9
|
* Blend modes.
|
|
@@ -113,8 +113,8 @@ const blend = {
|
|
|
113
113
|
* @param {Boolean} [images[].autoOrient=false] - set to true to use EXIF orientation data, if present, to orient the image.
|
|
114
114
|
* @param {String} [images[].blend='over'] - how to blend this image with the image below.
|
|
115
115
|
* @param {String} [images[].gravity='centre'] - gravity at which to place the overlay.
|
|
116
|
-
* @param {Number} [images[].top] - the pixel offset from the top edge.
|
|
117
|
-
* @param {Number} [images[].left] - the pixel offset from the left edge.
|
|
116
|
+
* @param {Number} [images[].top] - the pixel offset from the top edge, an integer between -100000000 and 100000000.
|
|
117
|
+
* @param {Number} [images[].left] - the pixel offset from the left edge, an integer between -100000000 and 100000000.
|
|
118
118
|
* @param {Boolean} [images[].tile=false] - set to true to repeat the overlay image across the entire image with the given `gravity`.
|
|
119
119
|
* @param {Boolean} [images[].premultiplied=false] - set to true to avoid premultiplying the image below. Equivalent to the `--premultiplied` vips option.
|
|
120
120
|
* @param {Number} [images[].density=72] - number representing the DPI for vector overlay image.
|
|
@@ -125,6 +125,7 @@ const blend = {
|
|
|
125
125
|
* @param {boolean} [images[].animated=false] - Set to `true` to read all frames/pages of an animated image.
|
|
126
126
|
* @param {string} [images[].failOn='warning'] - @see {@link /api-constructor/ constructor parameters}
|
|
127
127
|
* @param {number|boolean} [images[].limitInputPixels=268402689] - @see {@link /api-constructor/ constructor parameters}
|
|
128
|
+
* @param {number|boolean} [images[].limitInputChannels=5] - @see {@link /api-constructor/ constructor parameters}
|
|
128
129
|
* @returns {Sharp}
|
|
129
130
|
* @throws {Error} Invalid parameters
|
|
130
131
|
*/
|
|
@@ -162,17 +163,17 @@ function composite (images) {
|
|
|
162
163
|
}
|
|
163
164
|
}
|
|
164
165
|
if (is.defined(image.left)) {
|
|
165
|
-
if (is.integer(image.left)) {
|
|
166
|
+
if (is.integer(image.left) && is.inRange(image.left, -100000000, 100000000)) {
|
|
166
167
|
composite.left = image.left;
|
|
167
168
|
} else {
|
|
168
|
-
throw is.invalidParameterError('left', 'integer', image.left);
|
|
169
|
+
throw is.invalidParameterError('left', 'integer between -100000000 and 100000000', image.left);
|
|
169
170
|
}
|
|
170
171
|
}
|
|
171
172
|
if (is.defined(image.top)) {
|
|
172
|
-
if (is.integer(image.top)) {
|
|
173
|
+
if (is.integer(image.top) && is.inRange(image.top, -100000000, 100000000)) {
|
|
173
174
|
composite.top = image.top;
|
|
174
175
|
} else {
|
|
175
|
-
throw is.invalidParameterError('top', 'integer', image.top);
|
|
176
|
+
throw is.invalidParameterError('top', 'integer between -100000000 and 100000000', image.top);
|
|
176
177
|
}
|
|
177
178
|
}
|
|
178
179
|
if (is.defined(image.top) !== is.defined(image.left)) {
|