openportal 0.1.0 → 0.1.1

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.
Files changed (99) hide show
  1. package/package.json +10 -4
  2. package/web/.next/static/{b-zSCTvx5IzLyCj7s91p4 → A7pW-dtFIbPCSkvE8uenX}/_buildManifest.js +5 -5
  3. package/web/.next/static/chunks/{d3520c0622de77ff.js → 2e7bfb90c343ca96.js} +2 -2
  4. package/web/.next/static/chunks/{c2c14edbf40dd531.js → 8f80b41262ef70b6.js} +1 -1
  5. package/web/.next/static/chunks/{6ed981794a42d949.js → 967a1e0002fe9ae6.js} +2 -2
  6. package/web/.next/static/chunks/{688448a61fbd7d50.js → 9b265e2198b5525f.js} +2 -2
  7. package/web/.next/static/chunks/{c617a4c7a78d4946.js → aebf799dac29fe08.js} +2 -2
  8. package/web/.next/static/chunks/{d091e73f46572c38.js → c20ae04df8cc28be.js} +2 -2
  9. package/web/.next/static/chunks/{fe47781ce8074a57.js → d316d63225992c76.js} +2 -2
  10. package/web/.next/static/chunks/{turbopack-f44fd3803d0d6727.js → turbopack-1837909a677d116b.js} +1 -1
  11. package/web/.next/static/chunks/{turbopack-03c9848eaf268db1.js → turbopack-26688626142ac58f.js} +1 -1
  12. package/web/.next/static/chunks/{turbopack-bc49f2e78bf92fdb.js → turbopack-27558c851386934e.js} +1 -1
  13. package/web/.next/static/chunks/{turbopack-d90c5e114da5fc51.js → turbopack-92c911b9efda2756.js} +1 -1
  14. package/web/.next/static/chunks/{turbopack-ededbd49a3a234ea.js → turbopack-c40ec6674624f1d7.js} +1 -1
  15. package/web/.next/static/chunks/{turbopack-b3b62a2520d01d7e.js → turbopack-f4c0881f9723f5a5.js} +1 -1
  16. package/web/apps/web/.next/BUILD_ID +1 -1
  17. package/web/apps/web/.next/build-manifest.json +14 -14
  18. package/web/apps/web/.next/required-server-files.json +1 -1
  19. package/web/apps/web/.next/server/middleware-build-manifest.js +12 -12
  20. package/web/apps/web/.next/server/pages/404.html +1 -1
  21. package/web/apps/web/.next/server/pages/500.html +1 -1
  22. package/web/apps/web/.next/server/pages/_app/build-manifest.json +2 -2
  23. package/web/apps/web/.next/server/pages/_app/client-build-manifest.json +1 -1
  24. package/web/apps/web/.next/server/pages/_error/build-manifest.json +2 -2
  25. package/web/apps/web/.next/server/pages/_error/client-build-manifest.json +1 -1
  26. package/web/apps/web/.next/server/pages/index/build-manifest.json +2 -2
  27. package/web/apps/web/.next/server/pages/index/client-build-manifest.json +1 -1
  28. package/web/apps/web/.next/server/pages/index.html +1 -1
  29. package/web/apps/web/.next/server/pages/session/[id]/build-manifest.json +2 -2
  30. package/web/apps/web/.next/server/pages/session/[id]/client-build-manifest.json +1 -1
  31. package/web/apps/web/.next/server/pages/session/[id].html +1 -1
  32. package/web/apps/web/.next/server/pages/settings/build-manifest.json +2 -2
  33. package/web/apps/web/.next/server/pages/settings/client-build-manifest.json +1 -1
  34. package/web/apps/web/.next/server/pages/settings.html +1 -1
  35. package/web/apps/web/.next/server/pages/terminal/build-manifest.json +2 -2
  36. package/web/apps/web/.next/server/pages/terminal/client-build-manifest.json +1 -1
  37. package/web/apps/web/.next/server/pages/terminal.html +1 -1
  38. package/web/apps/web/server.js +1 -1
  39. package/web/node_modules/.bun/@img+colour@1.0.0/node_modules/@img/colour/color.cjs +0 -1594
  40. package/web/node_modules/.bun/@img+colour@1.0.0/node_modules/@img/colour/index.cjs +0 -1
  41. package/web/node_modules/.bun/@img+colour@1.0.0/node_modules/@img/colour/package.json +0 -45
  42. package/web/node_modules/.bun/@img+sharp-darwin-arm64@0.34.5/node_modules/@img/sharp-darwin-arm64/lib/sharp-darwin-arm64.node +0 -0
  43. package/web/node_modules/.bun/@img+sharp-darwin-arm64@0.34.5/node_modules/@img/sharp-darwin-arm64/package.json +0 -40
  44. package/web/node_modules/.bun/@img+sharp-libvips-darwin-arm64@1.2.4/node_modules/@img/sharp-libvips-darwin-arm64/README.md +0 -46
  45. package/web/node_modules/.bun/@img+sharp-libvips-darwin-arm64@1.2.4/node_modules/@img/sharp-libvips-darwin-arm64/lib/glib-2.0/include/glibconfig.h +0 -220
  46. package/web/node_modules/.bun/@img+sharp-libvips-darwin-arm64@1.2.4/node_modules/@img/sharp-libvips-darwin-arm64/lib/index.js +0 -1
  47. package/web/node_modules/.bun/@img+sharp-libvips-darwin-arm64@1.2.4/node_modules/@img/sharp-libvips-darwin-arm64/lib/libvips-cpp.8.17.3.dylib +0 -0
  48. package/web/node_modules/.bun/@img+sharp-libvips-darwin-arm64@1.2.4/node_modules/@img/sharp-libvips-darwin-arm64/package.json +0 -36
  49. package/web/node_modules/.bun/@img+sharp-libvips-darwin-arm64@1.2.4/node_modules/@img/sharp-libvips-darwin-arm64/versions.json +0 -30
  50. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/cjs/_interop_require_default.cjs +0 -6
  51. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/cjs/_interop_require_wildcard.cjs +0 -38
  52. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/esm/_check_private_redeclaration.js +0 -6
  53. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/esm/_class_apply_descriptor_get.js +0 -6
  54. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/esm/_class_apply_descriptor_set.js +0 -13
  55. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/esm/_class_extract_field_descriptor.js +0 -6
  56. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/esm/_class_private_field_get.js +0 -8
  57. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/esm/_class_private_field_init.js +0 -7
  58. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/esm/_class_private_field_set.js +0 -9
  59. package/web/node_modules/.bun/@swc+helpers@0.5.15/node_modules/@swc/helpers/package.json +0 -471
  60. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/channel.js +0 -177
  61. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/colour.js +0 -195
  62. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/composite.js +0 -212
  63. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/constructor.js +0 -499
  64. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/index.js +0 -16
  65. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/input.js +0 -809
  66. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/is.js +0 -143
  67. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/libvips.js +0 -207
  68. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/operation.js +0 -1016
  69. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/output.js +0 -1666
  70. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/resize.js +0 -595
  71. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/sharp.js +0 -121
  72. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/lib/utility.js +0 -291
  73. package/web/node_modules/.bun/sharp@0.34.5/node_modules/sharp/package.json +0 -202
  74. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/_tsc.js +0 -133818
  75. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/_tsserver.js +0 -659
  76. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/_typingsInstaller.js +0 -222
  77. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/cs/diagnosticMessages.generated.json +0 -2122
  78. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/de/diagnosticMessages.generated.json +0 -2122
  79. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/es/diagnosticMessages.generated.json +0 -2122
  80. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/fr/diagnosticMessages.generated.json +0 -2122
  81. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/it/diagnosticMessages.generated.json +0 -2122
  82. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/ja/diagnosticMessages.generated.json +0 -2122
  83. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/ko/diagnosticMessages.generated.json +0 -2122
  84. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/pl/diagnosticMessages.generated.json +0 -2122
  85. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/pt-br/diagnosticMessages.generated.json +0 -2122
  86. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/ru/diagnosticMessages.generated.json +0 -2122
  87. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/tr/diagnosticMessages.generated.json +0 -2122
  88. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/tsc.js +0 -8
  89. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/tsserver.js +0 -8
  90. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/tsserverlibrary.js +0 -21
  91. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/typesMap.json +0 -497
  92. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/typescript.js +0 -200276
  93. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/typingsInstaller.js +0 -8
  94. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/watchGuard.js +0 -53
  95. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/zh-cn/diagnosticMessages.generated.json +0 -2122
  96. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/zh-tw/diagnosticMessages.generated.json +0 -2122
  97. package/web/node_modules/.bun/typescript@5.9.3/node_modules/typescript/package.json +0 -120
  98. /package/web/.next/static/{b-zSCTvx5IzLyCj7s91p4 → A7pW-dtFIbPCSkvE8uenX}/_clientMiddlewareManifest.json +0 -0
  99. /package/web/.next/static/{b-zSCTvx5IzLyCj7s91p4 → A7pW-dtFIbPCSkvE8uenX}/_ssgManifest.js +0 -0
@@ -1,1666 +0,0 @@
1
- /*!
2
- Copyright 2013 Lovell Fuller and others.
3
- SPDX-License-Identifier: Apache-2.0
4
- */
5
-
6
- const path = require('node:path');
7
- const is = require('./is');
8
- const sharp = require('./sharp');
9
-
10
- const formats = new Map([
11
- ['heic', 'heif'],
12
- ['heif', 'heif'],
13
- ['avif', 'avif'],
14
- ['jpeg', 'jpeg'],
15
- ['jpg', 'jpeg'],
16
- ['jpe', 'jpeg'],
17
- ['tile', 'tile'],
18
- ['dz', 'tile'],
19
- ['png', 'png'],
20
- ['raw', 'raw'],
21
- ['tiff', 'tiff'],
22
- ['tif', 'tiff'],
23
- ['webp', 'webp'],
24
- ['gif', 'gif'],
25
- ['jp2', 'jp2'],
26
- ['jpx', 'jp2'],
27
- ['j2k', 'jp2'],
28
- ['j2c', 'jp2'],
29
- ['jxl', 'jxl']
30
- ]);
31
-
32
- const jp2Regex = /\.(jp[2x]|j2[kc])$/i;
33
-
34
- const errJp2Save = () => new Error('JP2 output requires libvips with support for OpenJPEG');
35
-
36
- const bitdepthFromColourCount = (colours) => 1 << 31 - Math.clz32(Math.ceil(Math.log2(colours)));
37
-
38
- /**
39
- * Write output image data to a file.
40
- *
41
- * If an explicit output format is not selected, it will be inferred from the extension,
42
- * with JPEG, PNG, WebP, AVIF, TIFF, GIF, DZI, and libvips' V format supported.
43
- * Note that raw pixel data is only supported for buffer output.
44
- *
45
- * By default all metadata will be removed, which includes EXIF-based orientation.
46
- * See {@link #withmetadata withMetadata} for control over this.
47
- *
48
- * The caller is responsible for ensuring directory structures and permissions exist.
49
- *
50
- * A `Promise` is returned when `callback` is not provided.
51
- *
52
- * @example
53
- * sharp(input)
54
- * .toFile('output.png', (err, info) => { ... });
55
- *
56
- * @example
57
- * sharp(input)
58
- * .toFile('output.png')
59
- * .then(info => { ... })
60
- * .catch(err => { ... });
61
- *
62
- * @param {string} fileOut - the path to write the image data to.
63
- * @param {Function} [callback] - called on completion with two arguments `(err, info)`.
64
- * `info` contains the output image `format`, `size` (bytes), `width`, `height`,
65
- * `channels` and `premultiplied` (indicating if premultiplication was used).
66
- * When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
67
- * When using the attention crop strategy also contains `attentionX` and `attentionY`, the focal point of the cropped region.
68
- * Animated output will also contain `pageHeight` and `pages`.
69
- * May also contain `textAutofitDpi` (dpi the font was rendered at) if image was created from text.
70
- * @returns {Promise<Object>} - when no callback is provided
71
- * @throws {Error} Invalid parameters
72
- */
73
- function toFile (fileOut, callback) {
74
- let err;
75
- if (!is.string(fileOut)) {
76
- err = new Error('Missing output file path');
77
- } else if (is.string(this.options.input.file) && path.resolve(this.options.input.file) === path.resolve(fileOut)) {
78
- err = new Error('Cannot use same file for input and output');
79
- } else if (jp2Regex.test(path.extname(fileOut)) && !this.constructor.format.jp2k.output.file) {
80
- err = errJp2Save();
81
- }
82
- if (err) {
83
- if (is.fn(callback)) {
84
- callback(err);
85
- } else {
86
- return Promise.reject(err);
87
- }
88
- } else {
89
- this.options.fileOut = fileOut;
90
- const stack = Error();
91
- return this._pipeline(callback, stack);
92
- }
93
- return this;
94
- }
95
-
96
- /**
97
- * Write output to a Buffer.
98
- * JPEG, PNG, WebP, AVIF, TIFF, GIF and raw pixel data output are supported.
99
- *
100
- * Use {@link #toformat toFormat} or one of the format-specific functions such as {@link #jpeg jpeg}, {@link #png png} etc. to set the output format.
101
- *
102
- * If no explicit format is set, the output format will match the input image, except SVG input which becomes PNG output.
103
- *
104
- * By default all metadata will be removed, which includes EXIF-based orientation.
105
- * See {@link #withmetadata withMetadata} for control over this.
106
- *
107
- * `callback`, if present, gets three arguments `(err, data, info)` where:
108
- * - `err` is an error, if any.
109
- * - `data` is the output image data.
110
- * - `info` contains the output image `format`, `size` (bytes), `width`, `height`,
111
- * `channels` and `premultiplied` (indicating if premultiplication was used).
112
- * When using a crop strategy also contains `cropOffsetLeft` and `cropOffsetTop`.
113
- * Animated output will also contain `pageHeight` and `pages`.
114
- * May also contain `textAutofitDpi` (dpi the font was rendered at) if image was created from text.
115
- *
116
- * A `Promise` is returned when `callback` is not provided.
117
- *
118
- * @example
119
- * sharp(input)
120
- * .toBuffer((err, data, info) => { ... });
121
- *
122
- * @example
123
- * sharp(input)
124
- * .toBuffer()
125
- * .then(data => { ... })
126
- * .catch(err => { ... });
127
- *
128
- * @example
129
- * sharp(input)
130
- * .png()
131
- * .toBuffer({ resolveWithObject: true })
132
- * .then(({ data, info }) => { ... })
133
- * .catch(err => { ... });
134
- *
135
- * @example
136
- * const { data, info } = await sharp('my-image.jpg')
137
- * // output the raw pixels
138
- * .raw()
139
- * .toBuffer({ resolveWithObject: true });
140
- *
141
- * // create a more type safe way to work with the raw pixel data
142
- * // this will not copy the data, instead it will change `data`s underlying ArrayBuffer
143
- * // so `data` and `pixelArray` point to the same memory location
144
- * const pixelArray = new Uint8ClampedArray(data.buffer);
145
- *
146
- * // When you are done changing the pixelArray, sharp takes the `pixelArray` as an input
147
- * const { width, height, channels } = info;
148
- * await sharp(pixelArray, { raw: { width, height, channels } })
149
- * .toFile('my-changed-image.jpg');
150
- *
151
- * @param {Object} [options]
152
- * @param {boolean} [options.resolveWithObject] Resolve the Promise with an Object containing `data` and `info` properties instead of resolving only with `data`.
153
- * @param {Function} [callback]
154
- * @returns {Promise<Buffer>} - when no callback is provided
155
- */
156
- function toBuffer (options, callback) {
157
- if (is.object(options)) {
158
- this._setBooleanOption('resolveWithObject', options.resolveWithObject);
159
- } else if (this.options.resolveWithObject) {
160
- this.options.resolveWithObject = false;
161
- }
162
- this.options.fileOut = '';
163
- const stack = Error();
164
- return this._pipeline(is.fn(options) ? options : callback, stack);
165
- }
166
-
167
- /**
168
- * Keep all EXIF metadata from the input image in the output image.
169
- *
170
- * EXIF metadata is unsupported for TIFF output.
171
- *
172
- * @since 0.33.0
173
- *
174
- * @example
175
- * const outputWithExif = await sharp(inputWithExif)
176
- * .keepExif()
177
- * .toBuffer();
178
- *
179
- * @returns {Sharp}
180
- */
181
- function keepExif () {
182
- this.options.keepMetadata |= 0b00001;
183
- return this;
184
- }
185
-
186
- /**
187
- * Set EXIF metadata in the output image, ignoring any EXIF in the input image.
188
- *
189
- * @since 0.33.0
190
- *
191
- * @example
192
- * const dataWithExif = await sharp(input)
193
- * .withExif({
194
- * IFD0: {
195
- * Copyright: 'The National Gallery'
196
- * },
197
- * IFD3: {
198
- * GPSLatitudeRef: 'N',
199
- * GPSLatitude: '51/1 30/1 3230/100',
200
- * GPSLongitudeRef: 'W',
201
- * GPSLongitude: '0/1 7/1 4366/100'
202
- * }
203
- * })
204
- * .toBuffer();
205
- *
206
- * @param {Object<string, Object<string, string>>} exif Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
207
- * @returns {Sharp}
208
- * @throws {Error} Invalid parameters
209
- */
210
- function withExif (exif) {
211
- if (is.object(exif)) {
212
- for (const [ifd, entries] of Object.entries(exif)) {
213
- if (is.object(entries)) {
214
- for (const [k, v] of Object.entries(entries)) {
215
- if (is.string(v)) {
216
- this.options.withExif[`exif-${ifd.toLowerCase()}-${k}`] = v;
217
- } else {
218
- throw is.invalidParameterError(`${ifd}.${k}`, 'string', v);
219
- }
220
- }
221
- } else {
222
- throw is.invalidParameterError(ifd, 'object', entries);
223
- }
224
- }
225
- } else {
226
- throw is.invalidParameterError('exif', 'object', exif);
227
- }
228
- this.options.withExifMerge = false;
229
- return this.keepExif();
230
- }
231
-
232
- /**
233
- * Update EXIF metadata from the input image in the output image.
234
- *
235
- * @since 0.33.0
236
- *
237
- * @example
238
- * const dataWithMergedExif = await sharp(inputWithExif)
239
- * .withExifMerge({
240
- * IFD0: {
241
- * Copyright: 'The National Gallery'
242
- * }
243
- * })
244
- * .toBuffer();
245
- *
246
- * @param {Object<string, Object<string, string>>} exif Object keyed by IFD0, IFD1 etc. of key/value string pairs to write as EXIF data.
247
- * @returns {Sharp}
248
- * @throws {Error} Invalid parameters
249
- */
250
- function withExifMerge (exif) {
251
- this.withExif(exif);
252
- this.options.withExifMerge = true;
253
- return this;
254
- }
255
-
256
- /**
257
- * Keep ICC profile from the input image in the output image.
258
- *
259
- * When input and output colour spaces differ, use with {@link /api-colour/#tocolourspace toColourspace} and optionally {@link /api-colour/#pipelinecolourspace pipelineColourspace}.
260
- *
261
- * @since 0.33.0
262
- *
263
- * @example
264
- * const outputWithIccProfile = await sharp(inputWithIccProfile)
265
- * .keepIccProfile()
266
- * .toBuffer();
267
- *
268
- * @example
269
- * const cmykOutputWithIccProfile = await sharp(cmykInputWithIccProfile)
270
- * .pipelineColourspace('cmyk')
271
- * .toColourspace('cmyk')
272
- * .keepIccProfile()
273
- * .toBuffer();
274
- *
275
- * @returns {Sharp}
276
- */
277
- function keepIccProfile () {
278
- this.options.keepMetadata |= 0b01000;
279
- return this;
280
- }
281
-
282
- /**
283
- * Transform using an ICC profile and attach to the output image.
284
- *
285
- * This can either be an absolute filesystem path or
286
- * built-in profile name (`srgb`, `p3`, `cmyk`).
287
- *
288
- * @since 0.33.0
289
- *
290
- * @example
291
- * const outputWithP3 = await sharp(input)
292
- * .withIccProfile('p3')
293
- * .toBuffer();
294
- *
295
- * @param {string} icc - Absolute filesystem path to output ICC profile or built-in profile name (srgb, p3, cmyk).
296
- * @param {Object} [options]
297
- * @param {number} [options.attach=true] Should the ICC profile be included in the output image metadata?
298
- * @returns {Sharp}
299
- * @throws {Error} Invalid parameters
300
- */
301
- function withIccProfile (icc, options) {
302
- if (is.string(icc)) {
303
- this.options.withIccProfile = icc;
304
- } else {
305
- throw is.invalidParameterError('icc', 'string', icc);
306
- }
307
- this.keepIccProfile();
308
- if (is.object(options)) {
309
- if (is.defined(options.attach)) {
310
- if (is.bool(options.attach)) {
311
- if (!options.attach) {
312
- this.options.keepMetadata &= ~0b01000;
313
- }
314
- } else {
315
- throw is.invalidParameterError('attach', 'boolean', options.attach);
316
- }
317
- }
318
- }
319
- return this;
320
- }
321
-
322
- /**
323
- * Keep XMP metadata from the input image in the output image.
324
- *
325
- * @since 0.34.3
326
- *
327
- * @example
328
- * const outputWithXmp = await sharp(inputWithXmp)
329
- * .keepXmp()
330
- * .toBuffer();
331
- *
332
- * @returns {Sharp}
333
- */
334
- function keepXmp () {
335
- this.options.keepMetadata |= 0b00010;
336
- return this;
337
- }
338
-
339
- /**
340
- * Set XMP metadata in the output image.
341
- *
342
- * Supported by PNG, JPEG, WebP, and TIFF output.
343
- *
344
- * @since 0.34.3
345
- *
346
- * @example
347
- * const xmpString = `
348
- * <?xml version="1.0"?>
349
- * <x:xmpmeta xmlns:x="adobe:ns:meta/">
350
- * <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
351
- * <rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">
352
- * <dc:creator><rdf:Seq><rdf:li>John Doe</rdf:li></rdf:Seq></dc:creator>
353
- * </rdf:Description>
354
- * </rdf:RDF>
355
- * </x:xmpmeta>`;
356
- *
357
- * const data = await sharp(input)
358
- * .withXmp(xmpString)
359
- * .toBuffer();
360
- *
361
- * @param {string} xmp String containing XMP metadata to be embedded in the output image.
362
- * @returns {Sharp}
363
- * @throws {Error} Invalid parameters
364
- */
365
- function withXmp (xmp) {
366
- if (is.string(xmp) && xmp.length > 0) {
367
- this.options.withXmp = xmp;
368
- this.options.keepMetadata |= 0b00010;
369
- } else {
370
- throw is.invalidParameterError('xmp', 'non-empty string', xmp);
371
- }
372
- return this;
373
- }
374
-
375
- /**
376
- * Keep all metadata (EXIF, ICC, XMP, IPTC) from the input image in the output image.
377
- *
378
- * The default behaviour, when `keepMetadata` is not used, is to convert to the device-independent
379
- * sRGB colour space and strip all metadata, including the removal of any ICC profile.
380
- *
381
- * @since 0.33.0
382
- *
383
- * @example
384
- * const outputWithMetadata = await sharp(inputWithMetadata)
385
- * .keepMetadata()
386
- * .toBuffer();
387
- *
388
- * @returns {Sharp}
389
- */
390
- function keepMetadata () {
391
- this.options.keepMetadata = 0b11111;
392
- return this;
393
- }
394
-
395
- /**
396
- * Keep most metadata (EXIF, XMP, IPTC) from the input image in the output image.
397
- *
398
- * This will also convert to and add a web-friendly sRGB ICC profile if appropriate.
399
- *
400
- * Allows orientation and density to be set or updated.
401
- *
402
- * @example
403
- * const outputSrgbWithMetadata = await sharp(inputRgbWithMetadata)
404
- * .withMetadata()
405
- * .toBuffer();
406
- *
407
- * @example
408
- * // Set output metadata to 96 DPI
409
- * const data = await sharp(input)
410
- * .withMetadata({ density: 96 })
411
- * .toBuffer();
412
- *
413
- * @param {Object} [options]
414
- * @param {number} [options.orientation] Used to update the EXIF `Orientation` tag, integer between 1 and 8.
415
- * @param {number} [options.density] Number of pixels per inch (DPI).
416
- * @returns {Sharp}
417
- * @throws {Error} Invalid parameters
418
- */
419
- function withMetadata (options) {
420
- this.keepMetadata();
421
- this.withIccProfile('srgb');
422
- if (is.object(options)) {
423
- if (is.defined(options.orientation)) {
424
- if (is.integer(options.orientation) && is.inRange(options.orientation, 1, 8)) {
425
- this.options.withMetadataOrientation = options.orientation;
426
- } else {
427
- throw is.invalidParameterError('orientation', 'integer between 1 and 8', options.orientation);
428
- }
429
- }
430
- if (is.defined(options.density)) {
431
- if (is.number(options.density) && options.density > 0) {
432
- this.options.withMetadataDensity = options.density;
433
- } else {
434
- throw is.invalidParameterError('density', 'positive number', options.density);
435
- }
436
- }
437
- if (is.defined(options.icc)) {
438
- this.withIccProfile(options.icc);
439
- }
440
- if (is.defined(options.exif)) {
441
- this.withExifMerge(options.exif);
442
- }
443
- }
444
- return this;
445
- }
446
-
447
- /**
448
- * Force output to a given format.
449
- *
450
- * @example
451
- * // Convert any input to PNG output
452
- * const data = await sharp(input)
453
- * .toFormat('png')
454
- * .toBuffer();
455
- *
456
- * @param {(string|Object)} format - as a string or an Object with an 'id' attribute
457
- * @param {Object} options - output options
458
- * @returns {Sharp}
459
- * @throws {Error} unsupported format or options
460
- */
461
- function toFormat (format, options) {
462
- const actualFormat = formats.get((is.object(format) && is.string(format.id) ? format.id : format).toLowerCase());
463
- if (!actualFormat) {
464
- throw is.invalidParameterError('format', `one of: ${[...formats.keys()].join(', ')}`, format);
465
- }
466
- return this[actualFormat](options);
467
- }
468
-
469
- /**
470
- * Use these JPEG options for output image.
471
- *
472
- * @example
473
- * // Convert any input to very high quality JPEG output
474
- * const data = await sharp(input)
475
- * .jpeg({
476
- * quality: 100,
477
- * chromaSubsampling: '4:4:4'
478
- * })
479
- * .toBuffer();
480
- *
481
- * @example
482
- * // Use mozjpeg to reduce output JPEG file size (slower)
483
- * const data = await sharp(input)
484
- * .jpeg({ mozjpeg: true })
485
- * .toBuffer();
486
- *
487
- * @param {Object} [options] - output options
488
- * @param {number} [options.quality=80] - quality, integer 1-100
489
- * @param {boolean} [options.progressive=false] - use progressive (interlace) scan
490
- * @param {string} [options.chromaSubsampling='4:2:0'] - set to '4:4:4' to prevent chroma subsampling otherwise defaults to '4:2:0' chroma subsampling
491
- * @param {boolean} [options.optimiseCoding=true] - optimise Huffman coding tables
492
- * @param {boolean} [options.optimizeCoding=true] - alternative spelling of optimiseCoding
493
- * @param {boolean} [options.mozjpeg=false] - use mozjpeg defaults, equivalent to `{ trellisQuantisation: true, overshootDeringing: true, optimiseScans: true, quantisationTable: 3 }`
494
- * @param {boolean} [options.trellisQuantisation=false] - apply trellis quantisation
495
- * @param {boolean} [options.overshootDeringing=false] - apply overshoot deringing
496
- * @param {boolean} [options.optimiseScans=false] - optimise progressive scans, forces progressive
497
- * @param {boolean} [options.optimizeScans=false] - alternative spelling of optimiseScans
498
- * @param {number} [options.quantisationTable=0] - quantization table to use, integer 0-8
499
- * @param {number} [options.quantizationTable=0] - alternative spelling of quantisationTable
500
- * @param {boolean} [options.force=true] - force JPEG output, otherwise attempt to use input format
501
- * @returns {Sharp}
502
- * @throws {Error} Invalid options
503
- */
504
- function jpeg (options) {
505
- if (is.object(options)) {
506
- if (is.defined(options.quality)) {
507
- if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
508
- this.options.jpegQuality = options.quality;
509
- } else {
510
- throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
511
- }
512
- }
513
- if (is.defined(options.progressive)) {
514
- this._setBooleanOption('jpegProgressive', options.progressive);
515
- }
516
- if (is.defined(options.chromaSubsampling)) {
517
- if (is.string(options.chromaSubsampling) && is.inArray(options.chromaSubsampling, ['4:2:0', '4:4:4'])) {
518
- this.options.jpegChromaSubsampling = options.chromaSubsampling;
519
- } else {
520
- throw is.invalidParameterError('chromaSubsampling', 'one of: 4:2:0, 4:4:4', options.chromaSubsampling);
521
- }
522
- }
523
- const optimiseCoding = is.bool(options.optimizeCoding) ? options.optimizeCoding : options.optimiseCoding;
524
- if (is.defined(optimiseCoding)) {
525
- this._setBooleanOption('jpegOptimiseCoding', optimiseCoding);
526
- }
527
- if (is.defined(options.mozjpeg)) {
528
- if (is.bool(options.mozjpeg)) {
529
- if (options.mozjpeg) {
530
- this.options.jpegTrellisQuantisation = true;
531
- this.options.jpegOvershootDeringing = true;
532
- this.options.jpegOptimiseScans = true;
533
- this.options.jpegProgressive = true;
534
- this.options.jpegQuantisationTable = 3;
535
- }
536
- } else {
537
- throw is.invalidParameterError('mozjpeg', 'boolean', options.mozjpeg);
538
- }
539
- }
540
- const trellisQuantisation = is.bool(options.trellisQuantization) ? options.trellisQuantization : options.trellisQuantisation;
541
- if (is.defined(trellisQuantisation)) {
542
- this._setBooleanOption('jpegTrellisQuantisation', trellisQuantisation);
543
- }
544
- if (is.defined(options.overshootDeringing)) {
545
- this._setBooleanOption('jpegOvershootDeringing', options.overshootDeringing);
546
- }
547
- const optimiseScans = is.bool(options.optimizeScans) ? options.optimizeScans : options.optimiseScans;
548
- if (is.defined(optimiseScans)) {
549
- this._setBooleanOption('jpegOptimiseScans', optimiseScans);
550
- if (optimiseScans) {
551
- this.options.jpegProgressive = true;
552
- }
553
- }
554
- const quantisationTable = is.number(options.quantizationTable) ? options.quantizationTable : options.quantisationTable;
555
- if (is.defined(quantisationTable)) {
556
- if (is.integer(quantisationTable) && is.inRange(quantisationTable, 0, 8)) {
557
- this.options.jpegQuantisationTable = quantisationTable;
558
- } else {
559
- throw is.invalidParameterError('quantisationTable', 'integer between 0 and 8', quantisationTable);
560
- }
561
- }
562
- }
563
- return this._updateFormatOut('jpeg', options);
564
- }
565
-
566
- /**
567
- * Use these PNG options for output image.
568
- *
569
- * By default, PNG output is full colour at 8 bits per pixel.
570
- *
571
- * Indexed PNG input at 1, 2 or 4 bits per pixel is converted to 8 bits per pixel.
572
- * Set `palette` to `true` for slower, indexed PNG output.
573
- *
574
- * For 16 bits per pixel output, convert to `rgb16` via
575
- * {@link /api-colour/#tocolourspace toColourspace}.
576
- *
577
- * @example
578
- * // Convert any input to full colour PNG output
579
- * const data = await sharp(input)
580
- * .png()
581
- * .toBuffer();
582
- *
583
- * @example
584
- * // Convert any input to indexed PNG output (slower)
585
- * const data = await sharp(input)
586
- * .png({ palette: true })
587
- * .toBuffer();
588
- *
589
- * @example
590
- * // Output 16 bits per pixel RGB(A)
591
- * const data = await sharp(input)
592
- * .toColourspace('rgb16')
593
- * .png()
594
- * .toBuffer();
595
- *
596
- * @param {Object} [options]
597
- * @param {boolean} [options.progressive=false] - use progressive (interlace) scan
598
- * @param {number} [options.compressionLevel=6] - zlib compression level, 0 (fastest, largest) to 9 (slowest, smallest)
599
- * @param {boolean} [options.adaptiveFiltering=false] - use adaptive row filtering
600
- * @param {boolean} [options.palette=false] - quantise to a palette-based image with alpha transparency support
601
- * @param {number} [options.quality=100] - use the lowest number of colours needed to achieve given quality, sets `palette` to `true`
602
- * @param {number} [options.effort=7] - CPU effort, between 1 (fastest) and 10 (slowest), sets `palette` to `true`
603
- * @param {number} [options.colours=256] - maximum number of palette entries, sets `palette` to `true`
604
- * @param {number} [options.colors=256] - alternative spelling of `options.colours`, sets `palette` to `true`
605
- * @param {number} [options.dither=1.0] - level of Floyd-Steinberg error diffusion, sets `palette` to `true`
606
- * @param {boolean} [options.force=true] - force PNG output, otherwise attempt to use input format
607
- * @returns {Sharp}
608
- * @throws {Error} Invalid options
609
- */
610
- function png (options) {
611
- if (is.object(options)) {
612
- if (is.defined(options.progressive)) {
613
- this._setBooleanOption('pngProgressive', options.progressive);
614
- }
615
- if (is.defined(options.compressionLevel)) {
616
- if (is.integer(options.compressionLevel) && is.inRange(options.compressionLevel, 0, 9)) {
617
- this.options.pngCompressionLevel = options.compressionLevel;
618
- } else {
619
- throw is.invalidParameterError('compressionLevel', 'integer between 0 and 9', options.compressionLevel);
620
- }
621
- }
622
- if (is.defined(options.adaptiveFiltering)) {
623
- this._setBooleanOption('pngAdaptiveFiltering', options.adaptiveFiltering);
624
- }
625
- const colours = options.colours || options.colors;
626
- if (is.defined(colours)) {
627
- if (is.integer(colours) && is.inRange(colours, 2, 256)) {
628
- this.options.pngBitdepth = bitdepthFromColourCount(colours);
629
- } else {
630
- throw is.invalidParameterError('colours', 'integer between 2 and 256', colours);
631
- }
632
- }
633
- if (is.defined(options.palette)) {
634
- this._setBooleanOption('pngPalette', options.palette);
635
- } else if ([options.quality, options.effort, options.colours, options.colors, options.dither].some(is.defined)) {
636
- this._setBooleanOption('pngPalette', true);
637
- }
638
- if (this.options.pngPalette) {
639
- if (is.defined(options.quality)) {
640
- if (is.integer(options.quality) && is.inRange(options.quality, 0, 100)) {
641
- this.options.pngQuality = options.quality;
642
- } else {
643
- throw is.invalidParameterError('quality', 'integer between 0 and 100', options.quality);
644
- }
645
- }
646
- if (is.defined(options.effort)) {
647
- if (is.integer(options.effort) && is.inRange(options.effort, 1, 10)) {
648
- this.options.pngEffort = options.effort;
649
- } else {
650
- throw is.invalidParameterError('effort', 'integer between 1 and 10', options.effort);
651
- }
652
- }
653
- if (is.defined(options.dither)) {
654
- if (is.number(options.dither) && is.inRange(options.dither, 0, 1)) {
655
- this.options.pngDither = options.dither;
656
- } else {
657
- throw is.invalidParameterError('dither', 'number between 0.0 and 1.0', options.dither);
658
- }
659
- }
660
- }
661
- }
662
- return this._updateFormatOut('png', options);
663
- }
664
-
665
- /**
666
- * Use these WebP options for output image.
667
- *
668
- * @example
669
- * // Convert any input to lossless WebP output
670
- * const data = await sharp(input)
671
- * .webp({ lossless: true })
672
- * .toBuffer();
673
- *
674
- * @example
675
- * // Optimise the file size of an animated WebP
676
- * const outputWebp = await sharp(inputWebp, { animated: true })
677
- * .webp({ effort: 6 })
678
- * .toBuffer();
679
- *
680
- * @param {Object} [options] - output options
681
- * @param {number} [options.quality=80] - quality, integer 1-100
682
- * @param {number} [options.alphaQuality=100] - quality of alpha layer, integer 0-100
683
- * @param {boolean} [options.lossless=false] - use lossless compression mode
684
- * @param {boolean} [options.nearLossless=false] - use near_lossless compression mode
685
- * @param {boolean} [options.smartSubsample=false] - use high quality chroma subsampling
686
- * @param {boolean} [options.smartDeblock=false] - auto-adjust the deblocking filter, can improve low contrast edges (slow)
687
- * @param {string} [options.preset='default'] - named preset for preprocessing/filtering, one of: default, photo, picture, drawing, icon, text
688
- * @param {number} [options.effort=4] - CPU effort, between 0 (fastest) and 6 (slowest)
689
- * @param {number} [options.loop=0] - number of animation iterations, use 0 for infinite animation
690
- * @param {number|number[]} [options.delay] - delay(s) between animation frames (in milliseconds)
691
- * @param {boolean} [options.minSize=false] - prevent use of animation key frames to minimise file size (slow)
692
- * @param {boolean} [options.mixed=false] - allow mixture of lossy and lossless animation frames (slow)
693
- * @param {boolean} [options.force=true] - force WebP output, otherwise attempt to use input format
694
- * @returns {Sharp}
695
- * @throws {Error} Invalid options
696
- */
697
- function webp (options) {
698
- if (is.object(options)) {
699
- if (is.defined(options.quality)) {
700
- if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
701
- this.options.webpQuality = options.quality;
702
- } else {
703
- throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
704
- }
705
- }
706
- if (is.defined(options.alphaQuality)) {
707
- if (is.integer(options.alphaQuality) && is.inRange(options.alphaQuality, 0, 100)) {
708
- this.options.webpAlphaQuality = options.alphaQuality;
709
- } else {
710
- throw is.invalidParameterError('alphaQuality', 'integer between 0 and 100', options.alphaQuality);
711
- }
712
- }
713
- if (is.defined(options.lossless)) {
714
- this._setBooleanOption('webpLossless', options.lossless);
715
- }
716
- if (is.defined(options.nearLossless)) {
717
- this._setBooleanOption('webpNearLossless', options.nearLossless);
718
- }
719
- if (is.defined(options.smartSubsample)) {
720
- this._setBooleanOption('webpSmartSubsample', options.smartSubsample);
721
- }
722
- if (is.defined(options.smartDeblock)) {
723
- this._setBooleanOption('webpSmartDeblock', options.smartDeblock);
724
- }
725
- if (is.defined(options.preset)) {
726
- if (is.string(options.preset) && is.inArray(options.preset, ['default', 'photo', 'picture', 'drawing', 'icon', 'text'])) {
727
- this.options.webpPreset = options.preset;
728
- } else {
729
- throw is.invalidParameterError('preset', 'one of: default, photo, picture, drawing, icon, text', options.preset);
730
- }
731
- }
732
- if (is.defined(options.effort)) {
733
- if (is.integer(options.effort) && is.inRange(options.effort, 0, 6)) {
734
- this.options.webpEffort = options.effort;
735
- } else {
736
- throw is.invalidParameterError('effort', 'integer between 0 and 6', options.effort);
737
- }
738
- }
739
- if (is.defined(options.minSize)) {
740
- this._setBooleanOption('webpMinSize', options.minSize);
741
- }
742
- if (is.defined(options.mixed)) {
743
- this._setBooleanOption('webpMixed', options.mixed);
744
- }
745
- }
746
- trySetAnimationOptions(options, this.options);
747
- return this._updateFormatOut('webp', options);
748
- }
749
-
750
- /**
751
- * Use these GIF options for the output image.
752
- *
753
- * The first entry in the palette is reserved for transparency.
754
- *
755
- * The palette of the input image will be re-used if possible.
756
- *
757
- * @since 0.30.0
758
- *
759
- * @example
760
- * // Convert PNG to GIF
761
- * await sharp(pngBuffer)
762
- * .gif()
763
- * .toBuffer();
764
- *
765
- * @example
766
- * // Convert animated WebP to animated GIF
767
- * await sharp('animated.webp', { animated: true })
768
- * .toFile('animated.gif');
769
- *
770
- * @example
771
- * // Create a 128x128, cropped, non-dithered, animated thumbnail of an animated GIF
772
- * const out = await sharp('in.gif', { animated: true })
773
- * .resize({ width: 128, height: 128 })
774
- * .gif({ dither: 0 })
775
- * .toBuffer();
776
- *
777
- * @example
778
- * // Lossy file size reduction of animated GIF
779
- * await sharp('in.gif', { animated: true })
780
- * .gif({ interFrameMaxError: 8 })
781
- * .toFile('optim.gif');
782
- *
783
- * @param {Object} [options] - output options
784
- * @param {boolean} [options.reuse=true] - re-use existing palette, otherwise generate new (slow)
785
- * @param {boolean} [options.progressive=false] - use progressive (interlace) scan
786
- * @param {number} [options.colours=256] - maximum number of palette entries, including transparency, between 2 and 256
787
- * @param {number} [options.colors=256] - alternative spelling of `options.colours`
788
- * @param {number} [options.effort=7] - CPU effort, between 1 (fastest) and 10 (slowest)
789
- * @param {number} [options.dither=1.0] - level of Floyd-Steinberg error diffusion, between 0 (least) and 1 (most)
790
- * @param {number} [options.interFrameMaxError=0] - maximum inter-frame error for transparency, between 0 (lossless) and 32
791
- * @param {number} [options.interPaletteMaxError=3] - maximum inter-palette error for palette reuse, between 0 and 256
792
- * @param {boolean} [options.keepDuplicateFrames=false] - keep duplicate frames in the output instead of combining them
793
- * @param {number} [options.loop=0] - number of animation iterations, use 0 for infinite animation
794
- * @param {number|number[]} [options.delay] - delay(s) between animation frames (in milliseconds)
795
- * @param {boolean} [options.force=true] - force GIF output, otherwise attempt to use input format
796
- * @returns {Sharp}
797
- * @throws {Error} Invalid options
798
- */
799
- function gif (options) {
800
- if (is.object(options)) {
801
- if (is.defined(options.reuse)) {
802
- this._setBooleanOption('gifReuse', options.reuse);
803
- }
804
- if (is.defined(options.progressive)) {
805
- this._setBooleanOption('gifProgressive', options.progressive);
806
- }
807
- const colours = options.colours || options.colors;
808
- if (is.defined(colours)) {
809
- if (is.integer(colours) && is.inRange(colours, 2, 256)) {
810
- this.options.gifBitdepth = bitdepthFromColourCount(colours);
811
- } else {
812
- throw is.invalidParameterError('colours', 'integer between 2 and 256', colours);
813
- }
814
- }
815
- if (is.defined(options.effort)) {
816
- if (is.number(options.effort) && is.inRange(options.effort, 1, 10)) {
817
- this.options.gifEffort = options.effort;
818
- } else {
819
- throw is.invalidParameterError('effort', 'integer between 1 and 10', options.effort);
820
- }
821
- }
822
- if (is.defined(options.dither)) {
823
- if (is.number(options.dither) && is.inRange(options.dither, 0, 1)) {
824
- this.options.gifDither = options.dither;
825
- } else {
826
- throw is.invalidParameterError('dither', 'number between 0.0 and 1.0', options.dither);
827
- }
828
- }
829
- if (is.defined(options.interFrameMaxError)) {
830
- if (is.number(options.interFrameMaxError) && is.inRange(options.interFrameMaxError, 0, 32)) {
831
- this.options.gifInterFrameMaxError = options.interFrameMaxError;
832
- } else {
833
- throw is.invalidParameterError('interFrameMaxError', 'number between 0.0 and 32.0', options.interFrameMaxError);
834
- }
835
- }
836
- if (is.defined(options.interPaletteMaxError)) {
837
- if (is.number(options.interPaletteMaxError) && is.inRange(options.interPaletteMaxError, 0, 256)) {
838
- this.options.gifInterPaletteMaxError = options.interPaletteMaxError;
839
- } else {
840
- throw is.invalidParameterError('interPaletteMaxError', 'number between 0.0 and 256.0', options.interPaletteMaxError);
841
- }
842
- }
843
- if (is.defined(options.keepDuplicateFrames)) {
844
- if (is.bool(options.keepDuplicateFrames)) {
845
- this._setBooleanOption('gifKeepDuplicateFrames', options.keepDuplicateFrames);
846
- } else {
847
- throw is.invalidParameterError('keepDuplicateFrames', 'boolean', options.keepDuplicateFrames);
848
- }
849
- }
850
- }
851
- trySetAnimationOptions(options, this.options);
852
- return this._updateFormatOut('gif', options);
853
- }
854
-
855
- /**
856
- * Use these JP2 options for output image.
857
- *
858
- * Requires libvips compiled with support for OpenJPEG.
859
- * The prebuilt binaries do not include this - see
860
- * {@link /install#custom-libvips installing a custom libvips}.
861
- *
862
- * @example
863
- * // Convert any input to lossless JP2 output
864
- * const data = await sharp(input)
865
- * .jp2({ lossless: true })
866
- * .toBuffer();
867
- *
868
- * @example
869
- * // Convert any input to very high quality JP2 output
870
- * const data = await sharp(input)
871
- * .jp2({
872
- * quality: 100,
873
- * chromaSubsampling: '4:4:4'
874
- * })
875
- * .toBuffer();
876
- *
877
- * @since 0.29.1
878
- *
879
- * @param {Object} [options] - output options
880
- * @param {number} [options.quality=80] - quality, integer 1-100
881
- * @param {boolean} [options.lossless=false] - use lossless compression mode
882
- * @param {number} [options.tileWidth=512] - horizontal tile size
883
- * @param {number} [options.tileHeight=512] - vertical tile size
884
- * @param {string} [options.chromaSubsampling='4:4:4'] - set to '4:2:0' to use chroma subsampling
885
- * @returns {Sharp}
886
- * @throws {Error} Invalid options
887
- */
888
- function jp2 (options) {
889
- /* node:coverage ignore next 41 */
890
- if (!this.constructor.format.jp2k.output.buffer) {
891
- throw errJp2Save();
892
- }
893
- if (is.object(options)) {
894
- if (is.defined(options.quality)) {
895
- if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
896
- this.options.jp2Quality = options.quality;
897
- } else {
898
- throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
899
- }
900
- }
901
- if (is.defined(options.lossless)) {
902
- if (is.bool(options.lossless)) {
903
- this.options.jp2Lossless = options.lossless;
904
- } else {
905
- throw is.invalidParameterError('lossless', 'boolean', options.lossless);
906
- }
907
- }
908
- if (is.defined(options.tileWidth)) {
909
- if (is.integer(options.tileWidth) && is.inRange(options.tileWidth, 1, 32768)) {
910
- this.options.jp2TileWidth = options.tileWidth;
911
- } else {
912
- throw is.invalidParameterError('tileWidth', 'integer between 1 and 32768', options.tileWidth);
913
- }
914
- }
915
- if (is.defined(options.tileHeight)) {
916
- if (is.integer(options.tileHeight) && is.inRange(options.tileHeight, 1, 32768)) {
917
- this.options.jp2TileHeight = options.tileHeight;
918
- } else {
919
- throw is.invalidParameterError('tileHeight', 'integer between 1 and 32768', options.tileHeight);
920
- }
921
- }
922
- if (is.defined(options.chromaSubsampling)) {
923
- if (is.string(options.chromaSubsampling) && is.inArray(options.chromaSubsampling, ['4:2:0', '4:4:4'])) {
924
- this.options.jp2ChromaSubsampling = options.chromaSubsampling;
925
- } else {
926
- throw is.invalidParameterError('chromaSubsampling', 'one of: 4:2:0, 4:4:4', options.chromaSubsampling);
927
- }
928
- }
929
- }
930
- return this._updateFormatOut('jp2', options);
931
- }
932
-
933
- /**
934
- * Set animation options if available.
935
- * @private
936
- *
937
- * @param {Object} [source] - output options
938
- * @param {number} [source.loop=0] - number of animation iterations, use 0 for infinite animation
939
- * @param {number[]} [source.delay] - list of delays between animation frames (in milliseconds)
940
- * @param {Object} [target] - target object for valid options
941
- * @throws {Error} Invalid options
942
- */
943
- function trySetAnimationOptions (source, target) {
944
- if (is.object(source) && is.defined(source.loop)) {
945
- if (is.integer(source.loop) && is.inRange(source.loop, 0, 65535)) {
946
- target.loop = source.loop;
947
- } else {
948
- throw is.invalidParameterError('loop', 'integer between 0 and 65535', source.loop);
949
- }
950
- }
951
- if (is.object(source) && is.defined(source.delay)) {
952
- // We allow singular values as well
953
- if (is.integer(source.delay) && is.inRange(source.delay, 0, 65535)) {
954
- target.delay = [source.delay];
955
- } else if (
956
- Array.isArray(source.delay) &&
957
- source.delay.every(is.integer) &&
958
- source.delay.every(v => is.inRange(v, 0, 65535))) {
959
- target.delay = source.delay;
960
- } else {
961
- throw is.invalidParameterError('delay', 'integer or an array of integers between 0 and 65535', source.delay);
962
- }
963
- }
964
- }
965
-
966
- /**
967
- * Use these TIFF options for output image.
968
- *
969
- * The `density` can be set in pixels/inch via {@link #withmetadata withMetadata}
970
- * instead of providing `xres` and `yres` in pixels/mm.
971
- *
972
- * @example
973
- * // Convert SVG input to LZW-compressed, 1 bit per pixel TIFF output
974
- * sharp('input.svg')
975
- * .tiff({
976
- * compression: 'lzw',
977
- * bitdepth: 1
978
- * })
979
- * .toFile('1-bpp-output.tiff')
980
- * .then(info => { ... });
981
- *
982
- * @param {Object} [options] - output options
983
- * @param {number} [options.quality=80] - quality, integer 1-100
984
- * @param {boolean} [options.force=true] - force TIFF output, otherwise attempt to use input format
985
- * @param {string} [options.compression='jpeg'] - compression options: none, jpeg, deflate, packbits, ccittfax4, lzw, webp, zstd, jp2k
986
- * @param {boolean} [options.bigtiff=false] - use BigTIFF variant (has no effect when compression is none)
987
- * @param {string} [options.predictor='horizontal'] - compression predictor options: none, horizontal, float
988
- * @param {boolean} [options.pyramid=false] - write an image pyramid
989
- * @param {boolean} [options.tile=false] - write a tiled tiff
990
- * @param {number} [options.tileWidth=256] - horizontal tile size
991
- * @param {number} [options.tileHeight=256] - vertical tile size
992
- * @param {number} [options.xres=1.0] - horizontal resolution in pixels/mm
993
- * @param {number} [options.yres=1.0] - vertical resolution in pixels/mm
994
- * @param {string} [options.resolutionUnit='inch'] - resolution unit options: inch, cm
995
- * @param {number} [options.bitdepth=8] - reduce bitdepth to 1, 2 or 4 bit
996
- * @param {boolean} [options.miniswhite=false] - write 1-bit images as miniswhite
997
- * @returns {Sharp}
998
- * @throws {Error} Invalid options
999
- */
1000
- function tiff (options) {
1001
- if (is.object(options)) {
1002
- if (is.defined(options.quality)) {
1003
- if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
1004
- this.options.tiffQuality = options.quality;
1005
- } else {
1006
- throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
1007
- }
1008
- }
1009
- if (is.defined(options.bitdepth)) {
1010
- if (is.integer(options.bitdepth) && is.inArray(options.bitdepth, [1, 2, 4, 8])) {
1011
- this.options.tiffBitdepth = options.bitdepth;
1012
- } else {
1013
- throw is.invalidParameterError('bitdepth', '1, 2, 4 or 8', options.bitdepth);
1014
- }
1015
- }
1016
- // tiling
1017
- if (is.defined(options.tile)) {
1018
- this._setBooleanOption('tiffTile', options.tile);
1019
- }
1020
- if (is.defined(options.tileWidth)) {
1021
- if (is.integer(options.tileWidth) && options.tileWidth > 0) {
1022
- this.options.tiffTileWidth = options.tileWidth;
1023
- } else {
1024
- throw is.invalidParameterError('tileWidth', 'integer greater than zero', options.tileWidth);
1025
- }
1026
- }
1027
- if (is.defined(options.tileHeight)) {
1028
- if (is.integer(options.tileHeight) && options.tileHeight > 0) {
1029
- this.options.tiffTileHeight = options.tileHeight;
1030
- } else {
1031
- throw is.invalidParameterError('tileHeight', 'integer greater than zero', options.tileHeight);
1032
- }
1033
- }
1034
- // miniswhite
1035
- if (is.defined(options.miniswhite)) {
1036
- this._setBooleanOption('tiffMiniswhite', options.miniswhite);
1037
- }
1038
- // pyramid
1039
- if (is.defined(options.pyramid)) {
1040
- this._setBooleanOption('tiffPyramid', options.pyramid);
1041
- }
1042
- // resolution
1043
- if (is.defined(options.xres)) {
1044
- if (is.number(options.xres) && options.xres > 0) {
1045
- this.options.tiffXres = options.xres;
1046
- } else {
1047
- throw is.invalidParameterError('xres', 'number greater than zero', options.xres);
1048
- }
1049
- }
1050
- if (is.defined(options.yres)) {
1051
- if (is.number(options.yres) && options.yres > 0) {
1052
- this.options.tiffYres = options.yres;
1053
- } else {
1054
- throw is.invalidParameterError('yres', 'number greater than zero', options.yres);
1055
- }
1056
- }
1057
- // compression
1058
- if (is.defined(options.compression)) {
1059
- if (is.string(options.compression) && is.inArray(options.compression, ['none', 'jpeg', 'deflate', 'packbits', 'ccittfax4', 'lzw', 'webp', 'zstd', 'jp2k'])) {
1060
- this.options.tiffCompression = options.compression;
1061
- } else {
1062
- throw is.invalidParameterError('compression', 'one of: none, jpeg, deflate, packbits, ccittfax4, lzw, webp, zstd, jp2k', options.compression);
1063
- }
1064
- }
1065
- // bigtiff
1066
- if (is.defined(options.bigtiff)) {
1067
- this._setBooleanOption('tiffBigtiff', options.bigtiff);
1068
- }
1069
- // predictor
1070
- if (is.defined(options.predictor)) {
1071
- if (is.string(options.predictor) && is.inArray(options.predictor, ['none', 'horizontal', 'float'])) {
1072
- this.options.tiffPredictor = options.predictor;
1073
- } else {
1074
- throw is.invalidParameterError('predictor', 'one of: none, horizontal, float', options.predictor);
1075
- }
1076
- }
1077
- // resolutionUnit
1078
- if (is.defined(options.resolutionUnit)) {
1079
- if (is.string(options.resolutionUnit) && is.inArray(options.resolutionUnit, ['inch', 'cm'])) {
1080
- this.options.tiffResolutionUnit = options.resolutionUnit;
1081
- } else {
1082
- throw is.invalidParameterError('resolutionUnit', 'one of: inch, cm', options.resolutionUnit);
1083
- }
1084
- }
1085
- }
1086
- return this._updateFormatOut('tiff', options);
1087
- }
1088
-
1089
- /**
1090
- * Use these AVIF options for output image.
1091
- *
1092
- * AVIF image sequences are not supported.
1093
- * Prebuilt binaries support a bitdepth of 8 only.
1094
- *
1095
- * This feature is experimental on the Windows ARM64 platform
1096
- * and requires a CPU with ARM64v8.4 or later.
1097
- *
1098
- * @example
1099
- * const data = await sharp(input)
1100
- * .avif({ effort: 2 })
1101
- * .toBuffer();
1102
- *
1103
- * @example
1104
- * const data = await sharp(input)
1105
- * .avif({ lossless: true })
1106
- * .toBuffer();
1107
- *
1108
- * @since 0.27.0
1109
- *
1110
- * @param {Object} [options] - output options
1111
- * @param {number} [options.quality=50] - quality, integer 1-100
1112
- * @param {boolean} [options.lossless=false] - use lossless compression
1113
- * @param {number} [options.effort=4] - CPU effort, between 0 (fastest) and 9 (slowest)
1114
- * @param {string} [options.chromaSubsampling='4:4:4'] - set to '4:2:0' to use chroma subsampling
1115
- * @param {number} [options.bitdepth=8] - set bitdepth to 8, 10 or 12 bit
1116
- * @returns {Sharp}
1117
- * @throws {Error} Invalid options
1118
- */
1119
- function avif (options) {
1120
- return this.heif({ ...options, compression: 'av1' });
1121
- }
1122
-
1123
- /**
1124
- * Use these HEIF options for output image.
1125
- *
1126
- * Support for patent-encumbered HEIC images using `hevc` compression requires the use of a
1127
- * globally-installed libvips compiled with support for libheif, libde265 and x265.
1128
- *
1129
- * @example
1130
- * const data = await sharp(input)
1131
- * .heif({ compression: 'hevc' })
1132
- * .toBuffer();
1133
- *
1134
- * @since 0.23.0
1135
- *
1136
- * @param {Object} options - output options
1137
- * @param {string} options.compression - compression format: av1, hevc
1138
- * @param {number} [options.quality=50] - quality, integer 1-100
1139
- * @param {boolean} [options.lossless=false] - use lossless compression
1140
- * @param {number} [options.effort=4] - CPU effort, between 0 (fastest) and 9 (slowest)
1141
- * @param {string} [options.chromaSubsampling='4:4:4'] - set to '4:2:0' to use chroma subsampling
1142
- * @param {number} [options.bitdepth=8] - set bitdepth to 8, 10 or 12 bit
1143
- * @returns {Sharp}
1144
- * @throws {Error} Invalid options
1145
- */
1146
- function heif (options) {
1147
- if (is.object(options)) {
1148
- if (is.string(options.compression) && is.inArray(options.compression, ['av1', 'hevc'])) {
1149
- this.options.heifCompression = options.compression;
1150
- } else {
1151
- throw is.invalidParameterError('compression', 'one of: av1, hevc', options.compression);
1152
- }
1153
- if (is.defined(options.quality)) {
1154
- if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
1155
- this.options.heifQuality = options.quality;
1156
- } else {
1157
- throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
1158
- }
1159
- }
1160
- if (is.defined(options.lossless)) {
1161
- if (is.bool(options.lossless)) {
1162
- this.options.heifLossless = options.lossless;
1163
- } else {
1164
- throw is.invalidParameterError('lossless', 'boolean', options.lossless);
1165
- }
1166
- }
1167
- if (is.defined(options.effort)) {
1168
- if (is.integer(options.effort) && is.inRange(options.effort, 0, 9)) {
1169
- this.options.heifEffort = options.effort;
1170
- } else {
1171
- throw is.invalidParameterError('effort', 'integer between 0 and 9', options.effort);
1172
- }
1173
- }
1174
- if (is.defined(options.chromaSubsampling)) {
1175
- if (is.string(options.chromaSubsampling) && is.inArray(options.chromaSubsampling, ['4:2:0', '4:4:4'])) {
1176
- this.options.heifChromaSubsampling = options.chromaSubsampling;
1177
- } else {
1178
- throw is.invalidParameterError('chromaSubsampling', 'one of: 4:2:0, 4:4:4', options.chromaSubsampling);
1179
- }
1180
- }
1181
- if (is.defined(options.bitdepth)) {
1182
- if (is.integer(options.bitdepth) && is.inArray(options.bitdepth, [8, 10, 12])) {
1183
- if (options.bitdepth !== 8 && this.constructor.versions.heif) {
1184
- throw is.invalidParameterError('bitdepth when using prebuilt binaries', 8, options.bitdepth);
1185
- }
1186
- this.options.heifBitdepth = options.bitdepth;
1187
- } else {
1188
- throw is.invalidParameterError('bitdepth', '8, 10 or 12', options.bitdepth);
1189
- }
1190
- }
1191
- } else {
1192
- throw is.invalidParameterError('options', 'Object', options);
1193
- }
1194
- return this._updateFormatOut('heif', options);
1195
- }
1196
-
1197
- /**
1198
- * Use these JPEG-XL (JXL) options for output image.
1199
- *
1200
- * This feature is experimental, please do not use in production systems.
1201
- *
1202
- * Requires libvips compiled with support for libjxl.
1203
- * The prebuilt binaries do not include this - see
1204
- * {@link /install/#custom-libvips installing a custom libvips}.
1205
- *
1206
- * @since 0.31.3
1207
- *
1208
- * @param {Object} [options] - output options
1209
- * @param {number} [options.distance=1.0] - maximum encoding error, between 0 (highest quality) and 15 (lowest quality)
1210
- * @param {number} [options.quality] - calculate `distance` based on JPEG-like quality, between 1 and 100, overrides distance if specified
1211
- * @param {number} [options.decodingTier=0] - target decode speed tier, between 0 (highest quality) and 4 (lowest quality)
1212
- * @param {boolean} [options.lossless=false] - use lossless compression
1213
- * @param {number} [options.effort=7] - CPU effort, between 1 (fastest) and 9 (slowest)
1214
- * @param {number} [options.loop=0] - number of animation iterations, use 0 for infinite animation
1215
- * @param {number|number[]} [options.delay] - delay(s) between animation frames (in milliseconds)
1216
- * @returns {Sharp}
1217
- * @throws {Error} Invalid options
1218
- */
1219
- function jxl (options) {
1220
- if (is.object(options)) {
1221
- if (is.defined(options.quality)) {
1222
- if (is.integer(options.quality) && is.inRange(options.quality, 1, 100)) {
1223
- // https://github.com/libjxl/libjxl/blob/0aeea7f180bafd6893c1db8072dcb67d2aa5b03d/tools/cjxl_main.cc#L640-L644
1224
- this.options.jxlDistance = options.quality >= 30
1225
- ? 0.1 + (100 - options.quality) * 0.09
1226
- : 53 / 3000 * options.quality * options.quality - 23 / 20 * options.quality + 25;
1227
- } else {
1228
- throw is.invalidParameterError('quality', 'integer between 1 and 100', options.quality);
1229
- }
1230
- } else if (is.defined(options.distance)) {
1231
- if (is.number(options.distance) && is.inRange(options.distance, 0, 15)) {
1232
- this.options.jxlDistance = options.distance;
1233
- } else {
1234
- throw is.invalidParameterError('distance', 'number between 0.0 and 15.0', options.distance);
1235
- }
1236
- }
1237
- if (is.defined(options.decodingTier)) {
1238
- if (is.integer(options.decodingTier) && is.inRange(options.decodingTier, 0, 4)) {
1239
- this.options.jxlDecodingTier = options.decodingTier;
1240
- } else {
1241
- throw is.invalidParameterError('decodingTier', 'integer between 0 and 4', options.decodingTier);
1242
- }
1243
- }
1244
- if (is.defined(options.lossless)) {
1245
- if (is.bool(options.lossless)) {
1246
- this.options.jxlLossless = options.lossless;
1247
- } else {
1248
- throw is.invalidParameterError('lossless', 'boolean', options.lossless);
1249
- }
1250
- }
1251
- if (is.defined(options.effort)) {
1252
- if (is.integer(options.effort) && is.inRange(options.effort, 1, 9)) {
1253
- this.options.jxlEffort = options.effort;
1254
- } else {
1255
- throw is.invalidParameterError('effort', 'integer between 1 and 9', options.effort);
1256
- }
1257
- }
1258
- }
1259
- trySetAnimationOptions(options, this.options);
1260
- return this._updateFormatOut('jxl', options);
1261
- }
1262
-
1263
- /**
1264
- * Force output to be raw, uncompressed pixel data.
1265
- * Pixel ordering is left-to-right, top-to-bottom, without padding.
1266
- * Channel ordering will be RGB or RGBA for non-greyscale colourspaces.
1267
- *
1268
- * @example
1269
- * // Extract raw, unsigned 8-bit RGB pixel data from JPEG input
1270
- * const { data, info } = await sharp('input.jpg')
1271
- * .raw()
1272
- * .toBuffer({ resolveWithObject: true });
1273
- *
1274
- * @example
1275
- * // Extract alpha channel as raw, unsigned 16-bit pixel data from PNG input
1276
- * const data = await sharp('input.png')
1277
- * .ensureAlpha()
1278
- * .extractChannel(3)
1279
- * .toColourspace('b-w')
1280
- * .raw({ depth: 'ushort' })
1281
- * .toBuffer();
1282
- *
1283
- * @param {Object} [options] - output options
1284
- * @param {string} [options.depth='uchar'] - bit depth, one of: char, uchar (default), short, ushort, int, uint, float, complex, double, dpcomplex
1285
- * @returns {Sharp}
1286
- * @throws {Error} Invalid options
1287
- */
1288
- function raw (options) {
1289
- if (is.object(options)) {
1290
- if (is.defined(options.depth)) {
1291
- if (is.string(options.depth) && is.inArray(options.depth,
1292
- ['char', 'uchar', 'short', 'ushort', 'int', 'uint', 'float', 'complex', 'double', 'dpcomplex']
1293
- )) {
1294
- this.options.rawDepth = options.depth;
1295
- } else {
1296
- throw is.invalidParameterError('depth', 'one of: char, uchar, short, ushort, int, uint, float, complex, double, dpcomplex', options.depth);
1297
- }
1298
- }
1299
- }
1300
- return this._updateFormatOut('raw');
1301
- }
1302
-
1303
- /**
1304
- * Use tile-based deep zoom (image pyramid) output.
1305
- *
1306
- * Set the format and options for tile images via the `toFormat`, `jpeg`, `png` or `webp` functions.
1307
- * Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed archive file format.
1308
- *
1309
- * The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
1310
- *
1311
- * @example
1312
- * sharp('input.tiff')
1313
- * .png()
1314
- * .tile({
1315
- * size: 512
1316
- * })
1317
- * .toFile('output.dz', function(err, info) {
1318
- * // output.dzi is the Deep Zoom XML definition
1319
- * // output_files contains 512x512 tiles grouped by zoom level
1320
- * });
1321
- *
1322
- * @example
1323
- * const zipFileWithTiles = await sharp(input)
1324
- * .tile({ basename: "tiles" })
1325
- * .toBuffer();
1326
- *
1327
- * @example
1328
- * const iiififier = sharp().tile({ layout: "iiif" });
1329
- * readableStream
1330
- * .pipe(iiififier)
1331
- * .pipe(writeableStream);
1332
- *
1333
- * @param {Object} [options]
1334
- * @param {number} [options.size=256] tile size in pixels, a value between 1 and 8192.
1335
- * @param {number} [options.overlap=0] tile overlap in pixels, a value between 0 and 8192.
1336
- * @param {number} [options.angle=0] tile angle of rotation, must be a multiple of 90.
1337
- * @param {string|Object} [options.background={r: 255, g: 255, b: 255, alpha: 1}] - background colour, parsed by the [color](https://www.npmjs.org/package/color) module, defaults to white without transparency.
1338
- * @param {string} [options.depth] how deep to make the pyramid, possible values are `onepixel`, `onetile` or `one`, default based on layout.
1339
- * @param {number} [options.skipBlanks=-1] Threshold to skip tile generation. Range is 0-255 for 8-bit images, 0-65535 for 16-bit images. Default is 5 for `google` layout, -1 (no skip) otherwise.
1340
- * @param {string} [options.container='fs'] tile container, with value `fs` (filesystem) or `zip` (compressed file).
1341
- * @param {string} [options.layout='dz'] filesystem layout, possible values are `dz`, `iiif`, `iiif3`, `zoomify` or `google`.
1342
- * @param {boolean} [options.centre=false] centre image in tile.
1343
- * @param {boolean} [options.center=false] alternative spelling of centre.
1344
- * @param {string} [options.id='https://example.com/iiif'] when `layout` is `iiif`/`iiif3`, sets the `@id`/`id` attribute of `info.json`
1345
- * @param {string} [options.basename] the name of the directory within the zip file when container is `zip`.
1346
- * @returns {Sharp}
1347
- * @throws {Error} Invalid parameters
1348
- */
1349
- function tile (options) {
1350
- if (is.object(options)) {
1351
- // Size of square tiles, in pixels
1352
- if (is.defined(options.size)) {
1353
- if (is.integer(options.size) && is.inRange(options.size, 1, 8192)) {
1354
- this.options.tileSize = options.size;
1355
- } else {
1356
- throw is.invalidParameterError('size', 'integer between 1 and 8192', options.size);
1357
- }
1358
- }
1359
- // Overlap of tiles, in pixels
1360
- if (is.defined(options.overlap)) {
1361
- if (is.integer(options.overlap) && is.inRange(options.overlap, 0, 8192)) {
1362
- if (options.overlap > this.options.tileSize) {
1363
- throw is.invalidParameterError('overlap', `<= size (${this.options.tileSize})`, options.overlap);
1364
- }
1365
- this.options.tileOverlap = options.overlap;
1366
- } else {
1367
- throw is.invalidParameterError('overlap', 'integer between 0 and 8192', options.overlap);
1368
- }
1369
- }
1370
- // Container
1371
- if (is.defined(options.container)) {
1372
- if (is.string(options.container) && is.inArray(options.container, ['fs', 'zip'])) {
1373
- this.options.tileContainer = options.container;
1374
- } else {
1375
- throw is.invalidParameterError('container', 'one of: fs, zip', options.container);
1376
- }
1377
- }
1378
- // Layout
1379
- if (is.defined(options.layout)) {
1380
- if (is.string(options.layout) && is.inArray(options.layout, ['dz', 'google', 'iiif', 'iiif3', 'zoomify'])) {
1381
- this.options.tileLayout = options.layout;
1382
- } else {
1383
- throw is.invalidParameterError('layout', 'one of: dz, google, iiif, iiif3, zoomify', options.layout);
1384
- }
1385
- }
1386
- // Angle of rotation,
1387
- if (is.defined(options.angle)) {
1388
- if (is.integer(options.angle) && !(options.angle % 90)) {
1389
- this.options.tileAngle = options.angle;
1390
- } else {
1391
- throw is.invalidParameterError('angle', 'positive/negative multiple of 90', options.angle);
1392
- }
1393
- }
1394
- // Background colour
1395
- this._setBackgroundColourOption('tileBackground', options.background);
1396
- // Depth of tiles
1397
- if (is.defined(options.depth)) {
1398
- if (is.string(options.depth) && is.inArray(options.depth, ['onepixel', 'onetile', 'one'])) {
1399
- this.options.tileDepth = options.depth;
1400
- } else {
1401
- throw is.invalidParameterError('depth', 'one of: onepixel, onetile, one', options.depth);
1402
- }
1403
- }
1404
- // Threshold to skip blank tiles
1405
- if (is.defined(options.skipBlanks)) {
1406
- if (is.integer(options.skipBlanks) && is.inRange(options.skipBlanks, -1, 65535)) {
1407
- this.options.tileSkipBlanks = options.skipBlanks;
1408
- } else {
1409
- throw is.invalidParameterError('skipBlanks', 'integer between -1 and 255/65535', options.skipBlanks);
1410
- }
1411
- } else if (is.defined(options.layout) && options.layout === 'google') {
1412
- this.options.tileSkipBlanks = 5;
1413
- }
1414
- // Center image in tile
1415
- const centre = is.bool(options.center) ? options.center : options.centre;
1416
- if (is.defined(centre)) {
1417
- this._setBooleanOption('tileCentre', centre);
1418
- }
1419
- // @id attribute for IIIF layout
1420
- if (is.defined(options.id)) {
1421
- if (is.string(options.id)) {
1422
- this.options.tileId = options.id;
1423
- } else {
1424
- throw is.invalidParameterError('id', 'string', options.id);
1425
- }
1426
- }
1427
- // Basename for zip container
1428
- if (is.defined(options.basename)) {
1429
- if (is.string(options.basename)) {
1430
- this.options.tileBasename = options.basename;
1431
- } else {
1432
- throw is.invalidParameterError('basename', 'string', options.basename);
1433
- }
1434
- }
1435
- }
1436
- // Format
1437
- if (is.inArray(this.options.formatOut, ['jpeg', 'png', 'webp'])) {
1438
- this.options.tileFormat = this.options.formatOut;
1439
- } else if (this.options.formatOut !== 'input') {
1440
- throw is.invalidParameterError('format', 'one of: jpeg, png, webp', this.options.formatOut);
1441
- }
1442
- return this._updateFormatOut('dz');
1443
- }
1444
-
1445
- /**
1446
- * Set a timeout for processing, in seconds.
1447
- * Use a value of zero to continue processing indefinitely, the default behaviour.
1448
- *
1449
- * The clock starts when libvips opens an input image for processing.
1450
- * Time spent waiting for a libuv thread to become available is not included.
1451
- *
1452
- * @example
1453
- * // Ensure processing takes no longer than 3 seconds
1454
- * try {
1455
- * const data = await sharp(input)
1456
- * .blur(1000)
1457
- * .timeout({ seconds: 3 })
1458
- * .toBuffer();
1459
- * } catch (err) {
1460
- * if (err.message.includes('timeout')) { ... }
1461
- * }
1462
- *
1463
- * @since 0.29.2
1464
- *
1465
- * @param {Object} options
1466
- * @param {number} options.seconds - Number of seconds after which processing will be stopped
1467
- * @returns {Sharp}
1468
- */
1469
- function timeout (options) {
1470
- if (!is.plainObject(options)) {
1471
- throw is.invalidParameterError('options', 'object', options);
1472
- }
1473
- if (is.integer(options.seconds) && is.inRange(options.seconds, 0, 3600)) {
1474
- this.options.timeoutSeconds = options.seconds;
1475
- } else {
1476
- throw is.invalidParameterError('seconds', 'integer between 0 and 3600', options.seconds);
1477
- }
1478
- return this;
1479
- }
1480
-
1481
- /**
1482
- * Update the output format unless options.force is false,
1483
- * in which case revert to input format.
1484
- * @private
1485
- * @param {string} formatOut
1486
- * @param {Object} [options]
1487
- * @param {boolean} [options.force=true] - force output format, otherwise attempt to use input format
1488
- * @returns {Sharp}
1489
- */
1490
- function _updateFormatOut (formatOut, options) {
1491
- if (!(is.object(options) && options.force === false)) {
1492
- this.options.formatOut = formatOut;
1493
- }
1494
- return this;
1495
- }
1496
-
1497
- /**
1498
- * Update a boolean attribute of the this.options Object.
1499
- * @private
1500
- * @param {string} key
1501
- * @param {boolean} val
1502
- * @throws {Error} Invalid key
1503
- */
1504
- function _setBooleanOption (key, val) {
1505
- if (is.bool(val)) {
1506
- this.options[key] = val;
1507
- } else {
1508
- throw is.invalidParameterError(key, 'boolean', val);
1509
- }
1510
- }
1511
-
1512
- /**
1513
- * Called by a WriteableStream to notify us it is ready for data.
1514
- * @private
1515
- */
1516
- function _read () {
1517
- if (!this.options.streamOut) {
1518
- this.options.streamOut = true;
1519
- const stack = Error();
1520
- this._pipeline(undefined, stack);
1521
- }
1522
- }
1523
-
1524
- /**
1525
- * Invoke the C++ image processing pipeline
1526
- * Supports callback, stream and promise variants
1527
- * @private
1528
- */
1529
- function _pipeline (callback, stack) {
1530
- if (typeof callback === 'function') {
1531
- // output=file/buffer
1532
- if (this._isStreamInput()) {
1533
- // output=file/buffer, input=stream
1534
- this.on('finish', () => {
1535
- this._flattenBufferIn();
1536
- sharp.pipeline(this.options, (err, data, info) => {
1537
- if (err) {
1538
- callback(is.nativeError(err, stack));
1539
- } else {
1540
- callback(null, data, info);
1541
- }
1542
- });
1543
- });
1544
- } else {
1545
- // output=file/buffer, input=file/buffer
1546
- sharp.pipeline(this.options, (err, data, info) => {
1547
- if (err) {
1548
- callback(is.nativeError(err, stack));
1549
- } else {
1550
- callback(null, data, info);
1551
- }
1552
- });
1553
- }
1554
- return this;
1555
- } else if (this.options.streamOut) {
1556
- // output=stream
1557
- if (this._isStreamInput()) {
1558
- // output=stream, input=stream
1559
- this.once('finish', () => {
1560
- this._flattenBufferIn();
1561
- sharp.pipeline(this.options, (err, data, info) => {
1562
- if (err) {
1563
- this.emit('error', is.nativeError(err, stack));
1564
- } else {
1565
- this.emit('info', info);
1566
- this.push(data);
1567
- }
1568
- this.push(null);
1569
- this.on('end', () => this.emit('close'));
1570
- });
1571
- });
1572
- if (this.streamInFinished) {
1573
- this.emit('finish');
1574
- }
1575
- } else {
1576
- // output=stream, input=file/buffer
1577
- sharp.pipeline(this.options, (err, data, info) => {
1578
- if (err) {
1579
- this.emit('error', is.nativeError(err, stack));
1580
- } else {
1581
- this.emit('info', info);
1582
- this.push(data);
1583
- }
1584
- this.push(null);
1585
- this.on('end', () => this.emit('close'));
1586
- });
1587
- }
1588
- return this;
1589
- } else {
1590
- // output=promise
1591
- if (this._isStreamInput()) {
1592
- // output=promise, input=stream
1593
- return new Promise((resolve, reject) => {
1594
- this.once('finish', () => {
1595
- this._flattenBufferIn();
1596
- sharp.pipeline(this.options, (err, data, info) => {
1597
- if (err) {
1598
- reject(is.nativeError(err, stack));
1599
- } else {
1600
- if (this.options.resolveWithObject) {
1601
- resolve({ data, info });
1602
- } else {
1603
- resolve(data);
1604
- }
1605
- }
1606
- });
1607
- });
1608
- });
1609
- } else {
1610
- // output=promise, input=file/buffer
1611
- return new Promise((resolve, reject) => {
1612
- sharp.pipeline(this.options, (err, data, info) => {
1613
- if (err) {
1614
- reject(is.nativeError(err, stack));
1615
- } else {
1616
- if (this.options.resolveWithObject) {
1617
- resolve({ data, info });
1618
- } else {
1619
- resolve(data);
1620
- }
1621
- }
1622
- });
1623
- });
1624
- }
1625
- }
1626
- }
1627
-
1628
- /**
1629
- * Decorate the Sharp prototype with output-related functions.
1630
- * @module Sharp
1631
- * @private
1632
- */
1633
- module.exports = (Sharp) => {
1634
- Object.assign(Sharp.prototype, {
1635
- // Public
1636
- toFile,
1637
- toBuffer,
1638
- keepExif,
1639
- withExif,
1640
- withExifMerge,
1641
- keepIccProfile,
1642
- withIccProfile,
1643
- keepXmp,
1644
- withXmp,
1645
- keepMetadata,
1646
- withMetadata,
1647
- toFormat,
1648
- jpeg,
1649
- jp2,
1650
- png,
1651
- webp,
1652
- tiff,
1653
- avif,
1654
- heif,
1655
- jxl,
1656
- gif,
1657
- raw,
1658
- tile,
1659
- timeout,
1660
- // Private
1661
- _updateFormatOut,
1662
- _setBooleanOption,
1663
- _read,
1664
- _pipeline
1665
- });
1666
- };