ipx 1.3.0 → 2.0.0-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.
@@ -0,0 +1,674 @@
1
+ import { defu } from 'defu';
2
+ import { imageMeta } from 'image-meta';
3
+ import { withLeadingSlash, hasProtocol, joinURL, decode } from 'ufo';
4
+ import { createError, defineEventHandler, getRequestHeader, setResponseHeader, setResponseStatus, createApp, toWebHandler, toNodeListener, toPlainHandler } from 'h3';
5
+ import destr from 'destr';
6
+ import { negotiate } from '@fastify/accept-negotiator';
7
+ import getEtag from 'etag';
8
+ import { fetch } from 'node-fetch-native';
9
+ import { resolve, join, parse } from 'pathe';
10
+
11
+ const Handlers = {
12
+ __proto__: null,
13
+ get b () { return b; },
14
+ get background () { return background; },
15
+ get blur () { return blur; },
16
+ get crop () { return crop; },
17
+ get enlarge () { return enlarge; },
18
+ get extend () { return extend; },
19
+ get extract () { return extract; },
20
+ get fit () { return fit; },
21
+ get flatten () { return flatten; },
22
+ get flip () { return flip; },
23
+ get flop () { return flop; },
24
+ get gamma () { return gamma; },
25
+ get grayscale () { return grayscale; },
26
+ get h () { return h; },
27
+ get height () { return height; },
28
+ get kernel () { return kernel; },
29
+ get median () { return median; },
30
+ get modulate () { return modulate; },
31
+ get negate () { return negate; },
32
+ get normalize () { return normalize; },
33
+ get pos () { return pos; },
34
+ get position () { return position; },
35
+ get q () { return q; },
36
+ get quality () { return quality; },
37
+ get resize () { return resize; },
38
+ get rotate () { return rotate; },
39
+ get s () { return s; },
40
+ get sharpen () { return sharpen; },
41
+ get threshold () { return threshold; },
42
+ get tint () { return tint; },
43
+ get trim () { return trim; },
44
+ get w () { return w; },
45
+ get width () { return width; }
46
+ };
47
+
48
+ function VArg(argument) {
49
+ return destr(argument);
50
+ }
51
+ function parseArgs(arguments_, mappers) {
52
+ const vargs = arguments_.split("_");
53
+ return mappers.map((v, index) => v(vargs[index]));
54
+ }
55
+ function getHandler(key) {
56
+ return Handlers[key];
57
+ }
58
+ function applyHandler(context, pipe, handler, argumentsString) {
59
+ const arguments_ = handler.args ? parseArgs(argumentsString, handler.args) : [];
60
+ return handler.apply(context, pipe, ...arguments_);
61
+ }
62
+ function clampDimensionsPreservingAspectRatio(sourceDimensions, desiredDimensions) {
63
+ const desiredAspectRatio = desiredDimensions.width / desiredDimensions.height;
64
+ let { width, height } = desiredDimensions;
65
+ if (width > sourceDimensions.width) {
66
+ width = sourceDimensions.width;
67
+ height = Math.round(sourceDimensions.width / desiredAspectRatio);
68
+ }
69
+ if (height > sourceDimensions.height) {
70
+ height = sourceDimensions.height;
71
+ width = Math.round(sourceDimensions.height * desiredAspectRatio);
72
+ }
73
+ return { width, height };
74
+ }
75
+
76
+ const quality = {
77
+ args: [VArg],
78
+ order: -1,
79
+ apply: (context, _pipe, quality2) => {
80
+ context.quality = quality2;
81
+ }
82
+ };
83
+ const fit = {
84
+ args: [VArg],
85
+ order: -1,
86
+ apply: (context, _pipe, fit2) => {
87
+ context.fit = fit2;
88
+ }
89
+ };
90
+ const position = {
91
+ args: [VArg],
92
+ order: -1,
93
+ apply: (context, _pipe, position2) => {
94
+ context.position = position2;
95
+ }
96
+ };
97
+ const HEX_RE = /^([\da-f]{2})([\da-f]{2})([\da-f]{2})$/i;
98
+ const SHORTHEX_RE = /^([\da-f])([\da-f])([\da-f])$/i;
99
+ const background = {
100
+ args: [VArg],
101
+ order: -1,
102
+ apply: (context, _pipe, background2) => {
103
+ background2 = String(background2);
104
+ if (!background2.startsWith("#") && (HEX_RE.test(background2) || SHORTHEX_RE.test(background2))) {
105
+ background2 = "#" + background2;
106
+ }
107
+ context.background = background2;
108
+ }
109
+ };
110
+ const enlarge = {
111
+ args: [],
112
+ apply: (context) => {
113
+ context.enlarge = true;
114
+ }
115
+ };
116
+ const kernel = {
117
+ args: [VArg],
118
+ apply: (context, _pipe, kernel2) => {
119
+ context.kernel = kernel2;
120
+ }
121
+ };
122
+ const width = {
123
+ args: [VArg],
124
+ apply: (context, pipe, width2) => {
125
+ return pipe.resize(width2, void 0, {
126
+ withoutEnlargement: !context.enlarge
127
+ });
128
+ }
129
+ };
130
+ const height = {
131
+ args: [VArg],
132
+ apply: (context, pipe, height2) => {
133
+ return pipe.resize(void 0, height2, {
134
+ withoutEnlargement: !context.enlarge
135
+ });
136
+ }
137
+ };
138
+ const resize = {
139
+ args: [VArg, VArg, VArg],
140
+ apply: (context, pipe, size) => {
141
+ let [width2, height2] = String(size).split("x").map(Number);
142
+ if (!width2) {
143
+ return;
144
+ }
145
+ if (!height2) {
146
+ height2 = width2;
147
+ }
148
+ if (!context.enlarge) {
149
+ const clamped = clampDimensionsPreservingAspectRatio(context.meta, {
150
+ width: width2,
151
+ height: height2
152
+ });
153
+ width2 = clamped.width;
154
+ height2 = clamped.height;
155
+ }
156
+ return pipe.resize(width2, height2, {
157
+ fit: context.fit,
158
+ position: context.position,
159
+ background: context.background,
160
+ kernel: context.kernel
161
+ });
162
+ }
163
+ };
164
+ const trim = {
165
+ args: [VArg],
166
+ apply: (_context, pipe, threshold2) => {
167
+ return pipe.trim(threshold2);
168
+ }
169
+ };
170
+ const extend = {
171
+ args: [VArg, VArg, VArg, VArg],
172
+ apply: (context, pipe, top, right, bottom, left) => {
173
+ return pipe.extend({
174
+ top,
175
+ left,
176
+ bottom,
177
+ right,
178
+ background: context.background
179
+ });
180
+ }
181
+ };
182
+ const extract = {
183
+ args: [VArg, VArg, VArg, VArg],
184
+ apply: (_context, pipe, left, top, width2, height2) => {
185
+ return pipe.extract({
186
+ left,
187
+ top,
188
+ width: width2,
189
+ height: height2
190
+ });
191
+ }
192
+ };
193
+ const rotate = {
194
+ args: [VArg],
195
+ apply: (context, pipe, angel) => {
196
+ return pipe.rotate(angel, {
197
+ background: context.background
198
+ });
199
+ }
200
+ };
201
+ const flip = {
202
+ args: [],
203
+ apply: (_context, pipe) => {
204
+ return pipe.flip();
205
+ }
206
+ };
207
+ const flop = {
208
+ args: [],
209
+ apply: (_context, pipe) => {
210
+ return pipe.flop();
211
+ }
212
+ };
213
+ const sharpen = {
214
+ args: [VArg, VArg, VArg],
215
+ apply: (_context, pipe, sigma, flat, jagged) => {
216
+ return pipe.sharpen(sigma, flat, jagged);
217
+ }
218
+ };
219
+ const median = {
220
+ args: [VArg, VArg, VArg],
221
+ apply: (_context, pipe, size) => {
222
+ return pipe.median(size);
223
+ }
224
+ };
225
+ const blur = {
226
+ args: [VArg, VArg, VArg],
227
+ apply: (_context, pipe, sigma) => {
228
+ return pipe.blur(sigma);
229
+ }
230
+ };
231
+ const flatten = {
232
+ args: [VArg, VArg, VArg],
233
+ apply: (context, pipe) => {
234
+ return pipe.flatten({
235
+ background: context.background
236
+ });
237
+ }
238
+ };
239
+ const gamma = {
240
+ args: [VArg, VArg, VArg],
241
+ apply: (_context, pipe, gamma2, gammaOut) => {
242
+ return pipe.gamma(gamma2, gammaOut);
243
+ }
244
+ };
245
+ const negate = {
246
+ args: [VArg, VArg, VArg],
247
+ apply: (_context, pipe) => {
248
+ return pipe.negate();
249
+ }
250
+ };
251
+ const normalize = {
252
+ args: [VArg, VArg, VArg],
253
+ apply: (_context, pipe) => {
254
+ return pipe.normalize();
255
+ }
256
+ };
257
+ const threshold = {
258
+ args: [VArg],
259
+ apply: (_context, pipe, threshold2) => {
260
+ return pipe.threshold(threshold2);
261
+ }
262
+ };
263
+ const modulate = {
264
+ args: [VArg],
265
+ apply: (_context, pipe, brightness, saturation, hue) => {
266
+ return pipe.modulate({
267
+ brightness,
268
+ saturation,
269
+ hue
270
+ });
271
+ }
272
+ };
273
+ const tint = {
274
+ args: [VArg],
275
+ apply: (_context, pipe, rgb) => {
276
+ return pipe.tint(rgb);
277
+ }
278
+ };
279
+ const grayscale = {
280
+ args: [VArg],
281
+ apply: (_context, pipe) => {
282
+ return pipe.grayscale();
283
+ }
284
+ };
285
+ const crop = extract;
286
+ const q = quality;
287
+ const b = background;
288
+ const w = width;
289
+ const h = height;
290
+ const s = resize;
291
+ const pos = position;
292
+
293
+ function getEnv(name) {
294
+ return name in process.env ? destr(process.env[name]) : void 0;
295
+ }
296
+ function cachedPromise(function_) {
297
+ let p;
298
+ return (...arguments_) => {
299
+ if (p) {
300
+ return p;
301
+ }
302
+ p = Promise.resolve(function_(...arguments_));
303
+ return p;
304
+ };
305
+ }
306
+
307
+ const SUPPORTED_FORMATS = /* @__PURE__ */ new Set([
308
+ "jpeg",
309
+ "png",
310
+ "webp",
311
+ "avif",
312
+ "tiff",
313
+ "heif",
314
+ "gif",
315
+ "heic"
316
+ ]);
317
+ function createIPX(userOptions) {
318
+ const options = defu(userOptions, {
319
+ alias: getEnv("IPX_ALIAS") || {},
320
+ maxAge: getEnv("IPX_MAX_AGE") || 300,
321
+ sharpOptions: {}
322
+ });
323
+ options.alias = Object.fromEntries(
324
+ Object.entries(options.alias || {}).map((e) => [
325
+ withLeadingSlash(e[0]),
326
+ e[1]
327
+ ])
328
+ );
329
+ const getSharp = cachedPromise(async () => {
330
+ return await import('sharp').then(
331
+ (r) => r.default || r
332
+ );
333
+ });
334
+ return function ipx(id, modifiers = {}, opts = {}) {
335
+ if (!id) {
336
+ throw createError({
337
+ statusCode: 400,
338
+ message: `Resource id is missing`
339
+ });
340
+ }
341
+ id = hasProtocol(id) ? id : withLeadingSlash(id);
342
+ for (const base in options.alias) {
343
+ if (id.startsWith(base)) {
344
+ id = joinURL(options.alias[base], id.slice(base.length));
345
+ }
346
+ }
347
+ const storage = hasProtocol(id) ? options.httpStorage || options.storage : options.storage || options.httpStorage;
348
+ if (!storage) {
349
+ throw createError({
350
+ statusCode: 500,
351
+ message: "No storage configured!"
352
+ });
353
+ }
354
+ const getSourceMeta = cachedPromise(async () => {
355
+ const sourceMeta = await storage.getMeta(id, opts);
356
+ if (!sourceMeta) {
357
+ throw createError({
358
+ statusCode: 404,
359
+ message: `Resource not found: ${id}`
360
+ });
361
+ }
362
+ return {
363
+ maxAge: typeof sourceMeta.maxAge === "string" ? Number.parseInt(sourceMeta.maxAge) : sourceMeta.maxAge,
364
+ mtime: sourceMeta.mtime ? new Date(sourceMeta.mtime) : void 0
365
+ };
366
+ });
367
+ const getSourceData = cachedPromise(async () => {
368
+ const sourceData = await storage.getData(id, opts);
369
+ if (!sourceData) {
370
+ throw createError({
371
+ statusCode: 404,
372
+ message: `Resource not found: ${id}`
373
+ });
374
+ }
375
+ return Buffer.from(sourceData);
376
+ });
377
+ const process = cachedPromise(async () => {
378
+ const sourceData = await getSourceData();
379
+ const imageMeta$1 = imageMeta(sourceData);
380
+ let mFormat = modifiers.f || modifiers.format;
381
+ if (mFormat === "jpg") {
382
+ mFormat = "jpeg";
383
+ }
384
+ const format = mFormat && SUPPORTED_FORMATS.has(mFormat) ? mFormat : SUPPORTED_FORMATS.has(imageMeta$1.type) ? imageMeta$1.type : "jpeg";
385
+ if (imageMeta$1.type === "svg" && !mFormat) {
386
+ return {
387
+ data: sourceData,
388
+ format: "svg+xml",
389
+ meta: imageMeta$1
390
+ };
391
+ }
392
+ const animated = modifiers.animated !== void 0 || modifiers.a !== void 0 || format === "gif";
393
+ const Sharp = await getSharp();
394
+ let sharp = Sharp(sourceData, { animated, ...options.sharpOptions });
395
+ Object.assign(
396
+ sharp.options,
397
+ options.sharpOptions
398
+ );
399
+ const handlers = Object.entries(modifiers).map(([name, arguments_]) => ({
400
+ handler: getHandler(name),
401
+ name,
402
+ args: arguments_
403
+ })).filter((h) => h.handler).sort((a, b) => {
404
+ const aKey = (a.handler.order || a.name || "").toString();
405
+ const bKey = (b.handler.order || b.name || "").toString();
406
+ return aKey.localeCompare(bKey);
407
+ });
408
+ const handlerContext = { meta: imageMeta$1 };
409
+ for (const h of handlers) {
410
+ sharp = applyHandler(handlerContext, sharp, h.handler, h.args) || sharp;
411
+ }
412
+ if (SUPPORTED_FORMATS.has(format)) {
413
+ sharp = sharp.toFormat(format, {
414
+ quality: handlerContext.quality,
415
+ progressive: format === "jpeg"
416
+ });
417
+ }
418
+ const processedImage = await sharp.toBuffer();
419
+ return {
420
+ data: processedImage,
421
+ format,
422
+ meta: imageMeta$1
423
+ };
424
+ });
425
+ return {
426
+ getSourceMeta,
427
+ process
428
+ };
429
+ };
430
+ }
431
+
432
+ const MODIFIER_SEP = /[&,]/g;
433
+ const MODIFIER_VAL_SEP = /[:=_]/;
434
+ function createIPXH3Handler(ipx) {
435
+ return defineEventHandler(async (event) => {
436
+ const [modifiersString = "", ...idSegments] = event.path.slice(
437
+ 1
438
+ /* leading slash */
439
+ ).split("/");
440
+ const id = safeString(decode(idSegments.join("/")));
441
+ if (!modifiersString) {
442
+ throw createError({
443
+ statusCode: 400,
444
+ message: `Modifiers are missing: ${id}`
445
+ });
446
+ }
447
+ if (!id || id === "/") {
448
+ throw createError({
449
+ statusCode: 400,
450
+ message: `Resource id is missing: ${event.path}`
451
+ });
452
+ }
453
+ const modifiers = /* @__PURE__ */ Object.create(null);
454
+ if (modifiersString !== "_") {
455
+ for (const p of modifiersString.split(MODIFIER_SEP)) {
456
+ const [key, ...values] = p.split(MODIFIER_VAL_SEP);
457
+ modifiers[safeString(key)] = values.map((v) => safeString(decode(v))).join("_");
458
+ }
459
+ }
460
+ const mFormat = modifiers.f || modifiers.format;
461
+ if (mFormat === "auto") {
462
+ const acceptHeader = getRequestHeader(event, "accept") || "";
463
+ const autoFormat = autoDetectFormat(
464
+ acceptHeader,
465
+ !!(modifiers.a || modifiers.animated)
466
+ );
467
+ delete modifiers.f;
468
+ delete modifiers.format;
469
+ if (autoFormat) {
470
+ modifiers.format = autoFormat;
471
+ setResponseHeader(event, "vary", "Accept");
472
+ }
473
+ }
474
+ const img = ipx(id, modifiers);
475
+ const sourceMeta = await img.getSourceMeta();
476
+ if (sourceMeta.mtime) {
477
+ if (getRequestHeader(event, "if-modified-since") && new Date(getRequestHeader(event, "if-modified-since") || "") >= sourceMeta.mtime) {
478
+ setResponseStatus(event, 304);
479
+ return null;
480
+ }
481
+ setResponseHeader(event, "last-modified", sourceMeta.mtime.toUTCString());
482
+ }
483
+ if (typeof sourceMeta.maxAge === "number") {
484
+ setResponseHeader(
485
+ event,
486
+ "cache-control",
487
+ `max-age=${+sourceMeta.maxAge}, public, s-maxage=${+sourceMeta.maxAge}`
488
+ );
489
+ }
490
+ const { data, format } = await img.process();
491
+ const etag = getEtag(data);
492
+ setResponseHeader(event, "etag", etag);
493
+ if (etag && getRequestHeader(event, "if-none-match") === etag) {
494
+ setResponseStatus(event, 304);
495
+ return null;
496
+ }
497
+ if (format) {
498
+ setResponseHeader(event, "content-type", `image/${format}`);
499
+ }
500
+ setResponseHeader(event, "content-security-policy", "default-src 'none'");
501
+ return data;
502
+ });
503
+ }
504
+ function createIPXH3App(ipx) {
505
+ const app = createApp({ debug: true });
506
+ app.use(createIPXH3Handler(ipx));
507
+ return app;
508
+ }
509
+ function createIPXWebServer(ipx) {
510
+ return toWebHandler(createIPXH3App(ipx));
511
+ }
512
+ function createIPXNodeServer(ipx) {
513
+ return toNodeListener(createIPXH3App(ipx));
514
+ }
515
+ function createIPXPlainServer(ipx) {
516
+ return toPlainHandler(createIPXH3App(ipx));
517
+ }
518
+ function autoDetectFormat(acceptHeader, animated) {
519
+ if (animated) {
520
+ const acceptMime2 = negotiate(acceptHeader, ["image/webp", "image/gif"]);
521
+ return acceptMime2?.split("/")[1] || "gif";
522
+ }
523
+ const acceptMime = negotiate(acceptHeader, [
524
+ "image/avif",
525
+ "image/webp",
526
+ "image/jpeg",
527
+ "image/png",
528
+ "image/tiff",
529
+ "image/heif",
530
+ "image/gif"
531
+ ]);
532
+ return acceptMime?.split("/")[1] || "jpeg";
533
+ }
534
+ function safeString(input) {
535
+ return JSON.stringify(input).replace(/^"|"$/g, "").replace(/\\+/g, "\\").replace(/\\"/g, '"');
536
+ }
537
+
538
+ const HTTP_RE = /^https?:\/\//;
539
+ function ipxHttpStorage(_options = {}) {
540
+ const allowAllDomains = getEnv("IPX_HTTP_ALLOW_ALL_DOMAINS") ?? false;
541
+ let _domains = _options.domains || getEnv("IPX_HTTP_DOMAINS") || [];
542
+ const defaultMaxAge = _options.maxAge || getEnv("IPX_HTTP_MAX_AGE");
543
+ const fetchOptions = _options.fetchOptions || getEnv("IPX_HTTP_FETCH_OPTIONS") || {};
544
+ if (typeof _domains === "string") {
545
+ _domains = _domains.split(",").map((s) => s.trim());
546
+ }
547
+ const domains = new Set(
548
+ _domains.map((d) => {
549
+ if (!HTTP_RE.test(d)) {
550
+ d = "http://" + d;
551
+ }
552
+ return new URL(d).hostname;
553
+ }).filter(Boolean)
554
+ );
555
+ function validateId(id) {
556
+ const url = new URL(decodeURIComponent(id));
557
+ if (!url.hostname) {
558
+ throw createError({
559
+ statusCode: 403,
560
+ message: `Hostname is missing: ${id}`
561
+ });
562
+ }
563
+ if (!allowAllDomains && !domains.has(url.hostname)) {
564
+ throw createError({
565
+ statusCode: 403,
566
+ message: `Forbidden host: ${url.hostname}`
567
+ });
568
+ }
569
+ return url.toString();
570
+ }
571
+ function parseResponse(response) {
572
+ if (!response.ok) {
573
+ throw createError({
574
+ statusCode: response.status || 500,
575
+ message: `Fetch error: ${response.statusText}`
576
+ });
577
+ }
578
+ let maxAge = defaultMaxAge;
579
+ const _cacheControl = response.headers.get("cache-control");
580
+ if (_cacheControl) {
581
+ const m = _cacheControl.match(/max-age=(\d+)/);
582
+ if (m && m[1]) {
583
+ maxAge = Number.parseInt(m[1]);
584
+ }
585
+ }
586
+ let mtime;
587
+ const _lastModified = response.headers.get("last-modified");
588
+ if (_lastModified) {
589
+ mtime = new Date(_lastModified);
590
+ }
591
+ return { maxAge, mtime };
592
+ }
593
+ return {
594
+ name: "ipx:http",
595
+ async getMeta(id) {
596
+ const url = validateId(id);
597
+ try {
598
+ const response = await fetch(url, { ...fetchOptions, method: "HEAD" });
599
+ const { maxAge, mtime } = parseResponse(response);
600
+ return { mtime, maxAge };
601
+ } catch {
602
+ return {};
603
+ }
604
+ },
605
+ async getData(id) {
606
+ const url = validateId(id);
607
+ const response = await fetch(url, { ...fetchOptions, method: "GET" });
608
+ return response.arrayBuffer();
609
+ }
610
+ };
611
+ }
612
+
613
+ function ipxFSStorage(_options = {}) {
614
+ const rootDir = resolve(_options.dir || getEnv("IPX_FS_DIR") || ".");
615
+ const maxAge = _options.maxAge || getEnv("IPX_FS_MAX_AGE");
616
+ const _resolve = (id) => {
617
+ const resolved = join(rootDir, id);
618
+ if (!isValidPath(resolved) || !resolved.startsWith(rootDir)) {
619
+ throw createError({
620
+ statusCode: 403,
621
+ message: `Forbidden path: ${id}`
622
+ });
623
+ }
624
+ return resolved;
625
+ };
626
+ const _getFS = cachedPromise(() => import('node:fs/promises'));
627
+ return {
628
+ name: "ipx:node-fs",
629
+ async getMeta(id) {
630
+ const fsPath = _resolve(id);
631
+ let stats;
632
+ try {
633
+ const fs = await _getFS();
634
+ stats = await fs.stat(fsPath);
635
+ } catch (error) {
636
+ throw error.code === "ENOENT" ? createError({
637
+ statusCode: 404,
638
+ message: `File not found: ${fsPath}`
639
+ }) : createError({
640
+ statusCode: 403,
641
+ message: `File access error: (${error.code}) ${fsPath}`
642
+ });
643
+ }
644
+ if (!stats.isFile()) {
645
+ throw createError({
646
+ statusCode: 400,
647
+ message: `Path should be a file: ${fsPath}`
648
+ });
649
+ }
650
+ return {
651
+ mtime: stats.mtime,
652
+ maxAge
653
+ };
654
+ },
655
+ async getData(id) {
656
+ const fsPath = _resolve(id);
657
+ const fs = await _getFS();
658
+ const contents = await fs.readFile(fsPath);
659
+ return contents;
660
+ }
661
+ };
662
+ }
663
+ const isWindows = process.platform === "win32";
664
+ function isValidPath(fp) {
665
+ if (isWindows) {
666
+ fp = fp.slice(parse(fp).root.length);
667
+ }
668
+ if (/["*:<>?|]/.test(fp)) {
669
+ return false;
670
+ }
671
+ return true;
672
+ }
673
+
674
+ export { createIPXH3Handler as a, createIPXH3App as b, createIPX as c, createIPXWebServer as d, createIPXNodeServer as e, createIPXPlainServer as f, ipxFSStorage as g, ipxHttpStorage as i };