ipx 1.2.0 → 1.3.1

package/README.md

@@ -5,31 +5,60 @@
 
 High performance, secure and easy to use image proxy based on [sharp](https://github.com/lovell/sharp) and [libvips](https://github.com/libvips/libvips).
 
-## Usage
-
-### Quick Start
+## Using CLI
 
 You can use `ipx` command to start server using:
 
 ```bash
-$ npx ipx
+npx ipx@latest
 ```
 
 The default server directory is the current working directory.
 
-### Programatic Usage
+## Programatic API
+
+You can use IPX as a middleware or directly use IPX interface.
 
-You can use IPX as a Connect/Express middleware or directly use ipx api.
+```ts
+import { createIPX, createIPXMiddleware } from "ipx";
+
+const ipx = createIPX({ domains: ["unjs.io"] });
+
+// (req, res) => void
+const ipxMiddleware = createIPXMiddleware(ipx);
+```
+
+**Example**: Using with [unjs/h3](https://github.com/unjs/h3):
 
 ```js
 import { createIPX, createIPXMiddleware } from "ipx";
+import { listen } from "listhen";
+import { createApp, fromNodeMiddleware, toNodeListener } from "h3";
+
+const ipx = createIPX({});
+const ipxMiddleware = createIPXMiddleware(ipx);
+
+const app = createApp().use("/", fromNodeMiddleware(ipxMiddleware));
+
+listen(toNodeListener(app));
+```
+
+**Example:** Using [express](https://expressjs.com):
+
+```js
+import { createIPX, createIPXMiddleware } from "ipx";
+import { listen } from "listhen";
+import express from "express";
+
+const ipx = createIPX({});
+const ipxMiddleware = createIPXMiddleware(ipx);
+
+const app = express().use("/", ipxMiddleware);
 
-const ipx = createIPX(/* options */);
-const app = express();
-app.use("/image", createIPXMiddleware(ipx));
+listen(app);
 ```
 
-### Examples
+## Examples
 
 Get original image:
 
@@ -47,17 +76,19 @@ Resize to `200x200px` using `embed` method and change format to `webp`:
 
 `/embed,f_webp,s_200x200/static/buffalo.png`
 
-### Modifiers
+## Modifiers
 
 | Property       | Docs                                                            | Example                                              | Comments                                                                                                                                                          |
 | -------------- | :-------------------------------------------------------------- | :--------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | width / w      | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/width_200/buffalo.png`                             |
 | height / h     | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/height_200/buffalo.png`                            |
 | resize / s     | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200/buffalo.png`                             |
+| kernel         | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200,kernel_nearest/buffalo.png`              | Supported kernel: `nearest`, `cubic`, `mitchell`, `lanczos2` and `lanczos3` (default).                                                                            |
 | fit            | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200,fit_outside/buffalo.png`                 | Sets `fit` option for `resize`.                                                                                                                                   |
 | position / pos | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200,pos_top/buffalo.png`                     | Sets `position` option for `resize`.                                                                                                                              |
 | trim           | [Docs](https://sharp.pixelplumbing.com/api-resize#trim)         | `/trim_100/buffalo.png`                              |
 | extend         | [Docs](https://sharp.pixelplumbing.com/api-resize#extend)       | `/extend_{top}_{right}_{bottom}_{left}/buffalo.png`  | Extend / pad / extrude one or more edges of the image with either the provided background colour or pixels derived from the image.                                |
+| background / b | \_                                                              | `/r_45,b_00ff00/buffalo.png`                         |
 | extract        | [Docs](https://sharp.pixelplumbing.com/api-resize#extract)      | `/extract_{left}_{top}_{width}_{height}/buffalo.png` | Extract/crop a region of the image.                                                                                                                               |
 | format / f     | [Docs](https://sharp.pixelplumbing.com/api-output#toformat)     | `/format_webp/buffalo.png`                           | Supported format: `jpg`, `jpeg`, `png`, `webp`, `avif`, `gif`, `heif`, `tiff` and `auto` (experimental only with middleware)                                      |
 | quality / q    | \_                                                              | `/quality_50/buffalo.png`                            | Accepted values: 0 to 100                                                                                                                                         |
@@ -76,7 +107,7 @@ Resize to `200x200px` using `embed` method and change format to `webp`:
 | grayscale      | [Docs](https://sharp.pixelplumbing.com/api-colour#grayscale)    | `/grayscale/buffalo.png`                             |
 | animated       | -                                                               | `/animated/buffalo.gif`                              | Experimental                                                                                                                                                      |
 
-### Config
+## Config
 
 Config can be customized using `IPX_*` environment variables.
 

package/bin/ipx.mjs

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import '../dist/cli.mjs'
+import "../dist/cli.mjs";

package/dist/cli.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.ts

@@ -1,2 +1,2 @@
 
-export { }
+export {  }

package/dist/index.cjs

@@ -38,6 +38,7 @@ const Handlers = {
   get grayscale () { return grayscale; },
   get h () { return h; },
   get height () { return height; },
+  get kernel () { return kernel; },
   get median () { return median; },
   get modulate () { return modulate; },
   get negate () { return negate; },
@@ -57,6 +58,12 @@ const Handlers = {
   get width () { return width; }
 };
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 function getEnv(name, defaultValue) {
   return destr__default(process.env[name]) ?? defaultValue;
 }
@@ -71,6 +78,11 @@ function cachedPromise(function_) {
   };
 }
 class IPXError extends Error {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "statusCode");
+    __publicField(this, "statusMessage");
+  }
 }
 function createError(statusMessage, statusCode, trace) {
   const error = new IPXError(statusMessage + (trace ? ` (${trace})` : ""));
@@ -242,6 +254,12 @@ const enlarge = {
     context.enlarge = true;
   }
 };
+const kernel = {
+  args: [VArg],
+  apply: (context, _pipe, kernel2) => {
+    context.kernel = kernel2;
+  }
+};
 const width = {
   args: [VArg],
   apply: (context, pipe, width2) => {
@@ -279,7 +297,8 @@ const resize = {
     return pipe.resize(width2, height2, {
       fit: context.fit,
       position: context.position,
-      background: context.background
+      background: context.background,
+      kernel: context.kernel
     });
   }
 };
@@ -419,7 +438,8 @@ const SUPPORTED_FORMATS = /* @__PURE__ */ new Set([
   "avif",
   "tiff",
   "heif",
-  "gif"
+  "gif",
+  "heic"
 ]);
 function createIPX(userOptions) {
   const defaults = {
@@ -487,7 +507,7 @@ function createIPX(userOptions) {
       const Sharp = await import('sharp').then(
         (r) => r.default || r
       );
-      let sharp = Sharp(data, { animated });
+      let sharp = Sharp(data, { animated, ...options.sharp });
       Object.assign(sharp.options, options.sharp);
       const handlers = Object.entries(modifiers).map(([name, arguments_]) => ({
         handler: getHandler(name),
@@ -587,7 +607,7 @@ async function _handleRequest(request, ipx) {
   }
   res.headers["Content-Security-Policy"] = "default-src 'none'";
   res.body = data;
-  return sanetizeReponse(res);
+  return sanitizeReponse(res);
 }
 function handleRequest(request, ipx) {
   return _handleRequest(request, ipx).catch((error) => {
@@ -596,7 +616,7 @@ function handleRequest(request, ipx) {
     if (process.env.NODE_ENV !== "production" && statusCode === 500) {
       console.error(error);
     }
-    return sanetizeReponse({
+    return sanitizeReponse({
       statusCode,
       statusMessage,
       body: "IPX Error: " + error,
@@ -639,7 +659,7 @@ function autoDetectFormat(acceptHeader, animated) {
   ]);
   return acceptMime?.split("/")[1] || "jpeg";
 }
-function sanetizeReponse(res) {
+function sanitizeReponse(res) {
   return {
     statusCode: res.statusCode || 200,
     statusMessage: res.statusMessage ? safeString(res.statusMessage) : "OK",

package/dist/index.d.cts

@@ -0,0 +1,144 @@
+import { Sharp, Color, KernelEnum, SharpOptions } from 'sharp';
+import { IncomingMessage, ServerResponse } from 'node:http';
+
+interface ImageMeta {
+    width: number;
+    height: number;
+    type: string;
+    mimeType: string;
+}
+interface SourceData {
+    mtime?: Date;
+    maxAge?: number;
+    getData: () => Promise<Buffer>;
+}
+type Source = (source: string, requestOptions?: any) => Promise<SourceData>;
+type SourceFactory<T = Record<string, any>> = (options: T) => Source;
+interface HandlerContext {
+    quality?: number;
+    fit?: "contain" | "cover" | "fill" | "inside" | "outside";
+    position?: number | string;
+    background?: Color;
+    enlarge?: boolean;
+    kernel?: keyof KernelEnum;
+    meta: ImageMeta;
+}
+interface Handler {
+    args: ((argument: string) => any)[];
+    order?: number;
+    apply: (context: HandlerContext, pipe: Sharp, ...arguments_: any[]) => any;
+}
+
+declare const quality: Handler;
+declare const fit: Handler;
+declare const position: Handler;
+declare const background: Handler;
+declare const enlarge: Handler;
+declare const kernel: Handler;
+declare const width: Handler;
+declare const height: Handler;
+declare const resize: Handler;
+declare const trim: Handler;
+declare const extend: Handler;
+declare const extract: Handler;
+declare const rotate: Handler;
+declare const flip: Handler;
+declare const flop: Handler;
+declare const sharpen: Handler;
+declare const median: Handler;
+declare const blur: Handler;
+declare const flatten: Handler;
+declare const gamma: Handler;
+declare const negate: Handler;
+declare const normalize: Handler;
+declare const threshold: Handler;
+declare const modulate: Handler;
+declare const tint: Handler;
+declare const grayscale: Handler;
+declare const crop: Handler;
+declare const q: Handler;
+declare const b: Handler;
+declare const w: Handler;
+declare const h: Handler;
+declare const s: Handler;
+declare const pos: Handler;
+
+declare const Handlers_b: typeof b;
+declare const Handlers_background: typeof background;
+declare const Handlers_blur: typeof blur;
+declare const Handlers_crop: typeof crop;
+declare const Handlers_enlarge: typeof enlarge;
+declare const Handlers_extend: typeof extend;
+declare const Handlers_extract: typeof extract;
+declare const Handlers_fit: typeof fit;
+declare const Handlers_flatten: typeof flatten;
+declare const Handlers_flip: typeof flip;
+declare const Handlers_flop: typeof flop;
+declare const Handlers_gamma: typeof gamma;
+declare const Handlers_grayscale: typeof grayscale;
+declare const Handlers_h: typeof h;
+declare const Handlers_height: typeof height;
+declare const Handlers_kernel: typeof kernel;
+declare const Handlers_median: typeof median;
+declare const Handlers_modulate: typeof modulate;
+declare const Handlers_negate: typeof negate;
+declare const Handlers_normalize: typeof normalize;
+declare const Handlers_pos: typeof pos;
+declare const Handlers_position: typeof position;
+declare const Handlers_q: typeof q;
+declare const Handlers_quality: typeof quality;
+declare const Handlers_resize: typeof resize;
+declare const Handlers_rotate: typeof rotate;
+declare const Handlers_s: typeof s;
+declare const Handlers_sharpen: typeof sharpen;
+declare const Handlers_threshold: typeof threshold;
+declare const Handlers_tint: typeof tint;
+declare const Handlers_trim: typeof trim;
+declare const Handlers_w: typeof w;
+declare const Handlers_width: typeof width;
+declare namespace Handlers {
+  export { Handlers_b as b, Handlers_background as background, Handlers_blur as blur, Handlers_crop as crop, Handlers_enlarge as enlarge, Handlers_extend as extend, Handlers_extract as extract, Handlers_fit as fit, Handlers_flatten as flatten, Handlers_flip as flip, Handlers_flop as flop, Handlers_gamma as gamma, Handlers_grayscale as grayscale, Handlers_h as h, Handlers_height as height, Handlers_kernel as kernel, Handlers_median as median, Handlers_modulate as modulate, Handlers_negate as negate, Handlers_normalize as normalize, Handlers_pos as pos, Handlers_position as position, Handlers_q as q, Handlers_quality as quality, Handlers_resize as resize, Handlers_rotate as rotate, Handlers_s as s, Handlers_sharpen as sharpen, Handlers_threshold as threshold, Handlers_tint as tint, Handlers_trim as trim, Handlers_w as w, Handlers_width as width };
+}
+
+type HandlerName = keyof typeof Handlers;
+
+interface IPXCTX {
+    sources: Record<string, Source>;
+}
+type IPX = (id: string, modifiers?: Partial<Record<HandlerName | "f" | "format" | "a" | "animated", string>>, requestOptions?: any) => {
+    src: () => Promise<SourceData>;
+    data: () => Promise<{
+        data: Buffer;
+        meta: ImageMeta;
+        format: string;
+    }>;
+};
+interface IPXOptions {
+    dir?: false | string;
+    maxAge?: number;
+    domains?: false | string[];
+    alias: Record<string, string>;
+    fetchOptions: RequestInit;
+    sharp?: SharpOptions;
+}
+declare function createIPX(userOptions: Partial<IPXOptions>): IPX;
+
+interface IPXHRequest {
+    url: string;
+    headers?: Record<string, string>;
+    options?: any;
+}
+interface IPXHResponse {
+    statusCode: number;
+    statusMessage: string;
+    headers: Record<string, string>;
+    body: any;
+    error?: any;
+}
+interface MiddlewareOptions {
+    fallthrough?: boolean;
+}
+declare function handleRequest(request: IPXHRequest, ipx: IPX): Promise<IPXHResponse>;
+declare function createIPXMiddleware(ipx: IPX, options?: Partial<MiddlewareOptions>): (request: IncomingMessage, res: ServerResponse, next?: ((err?: any) => void) | undefined) => Promise<void>;
+
+export { type IPX, type IPXCTX, type IPXHRequest, type IPXHResponse, type IPXOptions, type MiddlewareOptions, type Source, type SourceData, type SourceFactory, createIPX, createIPXMiddleware, handleRequest };

package/dist/index.d.mts

@@ -0,0 +1,144 @@
+import { Sharp, Color, KernelEnum, SharpOptions } from 'sharp';
+import { IncomingMessage, ServerResponse } from 'node:http';
+
+interface ImageMeta {
+    width: number;
+    height: number;
+    type: string;
+    mimeType: string;
+}
+interface SourceData {
+    mtime?: Date;
+    maxAge?: number;
+    getData: () => Promise<Buffer>;
+}
+type Source = (source: string, requestOptions?: any) => Promise<SourceData>;
+type SourceFactory<T = Record<string, any>> = (options: T) => Source;
+interface HandlerContext {
+    quality?: number;
+    fit?: "contain" | "cover" | "fill" | "inside" | "outside";
+    position?: number | string;
+    background?: Color;
+    enlarge?: boolean;
+    kernel?: keyof KernelEnum;
+    meta: ImageMeta;
+}
+interface Handler {
+    args: ((argument: string) => any)[];
+    order?: number;
+    apply: (context: HandlerContext, pipe: Sharp, ...arguments_: any[]) => any;
+}
+
+declare const quality: Handler;
+declare const fit: Handler;
+declare const position: Handler;
+declare const background: Handler;
+declare const enlarge: Handler;
+declare const kernel: Handler;
+declare const width: Handler;
+declare const height: Handler;
+declare const resize: Handler;
+declare const trim: Handler;
+declare const extend: Handler;
+declare const extract: Handler;
+declare const rotate: Handler;
+declare const flip: Handler;
+declare const flop: Handler;
+declare const sharpen: Handler;
+declare const median: Handler;
+declare const blur: Handler;
+declare const flatten: Handler;
+declare const gamma: Handler;
+declare const negate: Handler;
+declare const normalize: Handler;
+declare const threshold: Handler;
+declare const modulate: Handler;
+declare const tint: Handler;
+declare const grayscale: Handler;
+declare const crop: Handler;
+declare const q: Handler;
+declare const b: Handler;
+declare const w: Handler;
+declare const h: Handler;
+declare const s: Handler;
+declare const pos: Handler;
+
+declare const Handlers_b: typeof b;
+declare const Handlers_background: typeof background;
+declare const Handlers_blur: typeof blur;
+declare const Handlers_crop: typeof crop;
+declare const Handlers_enlarge: typeof enlarge;
+declare const Handlers_extend: typeof extend;
+declare const Handlers_extract: typeof extract;
+declare const Handlers_fit: typeof fit;
+declare const Handlers_flatten: typeof flatten;
+declare const Handlers_flip: typeof flip;
+declare const Handlers_flop: typeof flop;
+declare const Handlers_gamma: typeof gamma;
+declare const Handlers_grayscale: typeof grayscale;
+declare const Handlers_h: typeof h;
+declare const Handlers_height: typeof height;
+declare const Handlers_kernel: typeof kernel;
+declare const Handlers_median: typeof median;
+declare const Handlers_modulate: typeof modulate;
+declare const Handlers_negate: typeof negate;
+declare const Handlers_normalize: typeof normalize;
+declare const Handlers_pos: typeof pos;
+declare const Handlers_position: typeof position;
+declare const Handlers_q: typeof q;
+declare const Handlers_quality: typeof quality;
+declare const Handlers_resize: typeof resize;
+declare const Handlers_rotate: typeof rotate;
+declare const Handlers_s: typeof s;
+declare const Handlers_sharpen: typeof sharpen;
+declare const Handlers_threshold: typeof threshold;
+declare const Handlers_tint: typeof tint;
+declare const Handlers_trim: typeof trim;
+declare const Handlers_w: typeof w;
+declare const Handlers_width: typeof width;
+declare namespace Handlers {
+  export { Handlers_b as b, Handlers_background as background, Handlers_blur as blur, Handlers_crop as crop, Handlers_enlarge as enlarge, Handlers_extend as extend, Handlers_extract as extract, Handlers_fit as fit, Handlers_flatten as flatten, Handlers_flip as flip, Handlers_flop as flop, Handlers_gamma as gamma, Handlers_grayscale as grayscale, Handlers_h as h, Handlers_height as height, Handlers_kernel as kernel, Handlers_median as median, Handlers_modulate as modulate, Handlers_negate as negate, Handlers_normalize as normalize, Handlers_pos as pos, Handlers_position as position, Handlers_q as q, Handlers_quality as quality, Handlers_resize as resize, Handlers_rotate as rotate, Handlers_s as s, Handlers_sharpen as sharpen, Handlers_threshold as threshold, Handlers_tint as tint, Handlers_trim as trim, Handlers_w as w, Handlers_width as width };
+}
+
+type HandlerName = keyof typeof Handlers;
+
+interface IPXCTX {
+    sources: Record<string, Source>;
+}
+type IPX = (id: string, modifiers?: Partial<Record<HandlerName | "f" | "format" | "a" | "animated", string>>, requestOptions?: any) => {
+    src: () => Promise<SourceData>;
+    data: () => Promise<{
+        data: Buffer;
+        meta: ImageMeta;
+        format: string;
+    }>;
+};
+interface IPXOptions {
+    dir?: false | string;
+    maxAge?: number;
+    domains?: false | string[];
+    alias: Record<string, string>;
+    fetchOptions: RequestInit;
+    sharp?: SharpOptions;
+}
+declare function createIPX(userOptions: Partial<IPXOptions>): IPX;
+
+interface IPXHRequest {
+    url: string;
+    headers?: Record<string, string>;
+    options?: any;
+}
+interface IPXHResponse {
+    statusCode: number;
+    statusMessage: string;
+    headers: Record<string, string>;
+    body: any;
+    error?: any;
+}
+interface MiddlewareOptions {
+    fallthrough?: boolean;
+}
+declare function handleRequest(request: IPXHRequest, ipx: IPX): Promise<IPXHResponse>;
+declare function createIPXMiddleware(ipx: IPX, options?: Partial<MiddlewareOptions>): (request: IncomingMessage, res: ServerResponse, next?: ((err?: any) => void) | undefined) => Promise<void>;
+
+export { type IPX, type IPXCTX, type IPXHRequest, type IPXHResponse, type IPXOptions, type MiddlewareOptions, type Source, type SourceData, type SourceFactory, createIPX, createIPXMiddleware, handleRequest };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Sharp, Color, SharpOptions } from 'sharp';
+import { Sharp, Color, KernelEnum, SharpOptions } from 'sharp';
 import { IncomingMessage, ServerResponse } from 'node:http';
 
 interface ImageMeta {
@@ -20,6 +20,7 @@ interface HandlerContext {
     position?: number | string;
     background?: Color;
     enlarge?: boolean;
+    kernel?: keyof KernelEnum;
     meta: ImageMeta;
 }
 interface Handler {
@@ -33,6 +34,7 @@ declare const fit: Handler;
 declare const position: Handler;
 declare const background: Handler;
 declare const enlarge: Handler;
+declare const kernel: Handler;
 declare const width: Handler;
 declare const height: Handler;
 declare const resize: Handler;
@@ -76,6 +78,7 @@ declare const Handlers_gamma: typeof gamma;
 declare const Handlers_grayscale: typeof grayscale;
 declare const Handlers_h: typeof h;
 declare const Handlers_height: typeof height;
+declare const Handlers_kernel: typeof kernel;
 declare const Handlers_median: typeof median;
 declare const Handlers_modulate: typeof modulate;
 declare const Handlers_negate: typeof negate;
@@ -94,40 +97,7 @@ declare const Handlers_trim: typeof trim;
 declare const Handlers_w: typeof w;
 declare const Handlers_width: typeof width;
 declare namespace Handlers {
-  export {
-    Handlers_b as b,
-    Handlers_background as background,
-    Handlers_blur as blur,
-    Handlers_crop as crop,
-    Handlers_enlarge as enlarge,
-    Handlers_extend as extend,
-    Handlers_extract as extract,
-    Handlers_fit as fit,
-    Handlers_flatten as flatten,
-    Handlers_flip as flip,
-    Handlers_flop as flop,
-    Handlers_gamma as gamma,
-    Handlers_grayscale as grayscale,
-    Handlers_h as h,
-    Handlers_height as height,
-    Handlers_median as median,
-    Handlers_modulate as modulate,
-    Handlers_negate as negate,
-    Handlers_normalize as normalize,
-    Handlers_pos as pos,
-    Handlers_position as position,
-    Handlers_q as q,
-    Handlers_quality as quality,
-    Handlers_resize as resize,
-    Handlers_rotate as rotate,
-    Handlers_s as s,
-    Handlers_sharpen as sharpen,
-    Handlers_threshold as threshold,
-    Handlers_tint as tint,
-    Handlers_trim as trim,
-    Handlers_w as w,
-    Handlers_width as width,
-  };
+  export { Handlers_b as b, Handlers_background as background, Handlers_blur as blur, Handlers_crop as crop, Handlers_enlarge as enlarge, Handlers_extend as extend, Handlers_extract as extract, Handlers_fit as fit, Handlers_flatten as flatten, Handlers_flip as flip, Handlers_flop as flop, Handlers_gamma as gamma, Handlers_grayscale as grayscale, Handlers_h as h, Handlers_height as height, Handlers_kernel as kernel, Handlers_median as median, Handlers_modulate as modulate, Handlers_negate as negate, Handlers_normalize as normalize, Handlers_pos as pos, Handlers_position as position, Handlers_q as q, Handlers_quality as quality, Handlers_resize as resize, Handlers_rotate as rotate, Handlers_s as s, Handlers_sharpen as sharpen, Handlers_threshold as threshold, Handlers_tint as tint, Handlers_trim as trim, Handlers_w as w, Handlers_width as width };
 }
 
 type HandlerName = keyof typeof Handlers;
@@ -171,4 +141,4 @@ interface MiddlewareOptions {
 declare function handleRequest(request: IPXHRequest, ipx: IPX): Promise<IPXHResponse>;
 declare function createIPXMiddleware(ipx: IPX, options?: Partial<MiddlewareOptions>): (request: IncomingMessage, res: ServerResponse, next?: ((err?: any) => void) | undefined) => Promise<void>;
 
-export { IPX, IPXCTX, IPXHRequest, IPXHResponse, IPXOptions, MiddlewareOptions, Source, SourceData, SourceFactory, createIPX, createIPXMiddleware, handleRequest };
+export { type IPX, type IPXCTX, type IPXHRequest, type IPXHResponse, type IPXOptions, type MiddlewareOptions, type Source, type SourceData, type SourceFactory, createIPX, createIPXMiddleware, handleRequest };

package/dist/index.mjs

@@ -28,6 +28,7 @@ const Handlers = {
   get grayscale () { return grayscale; },
   get h () { return h; },
   get height () { return height; },
+  get kernel () { return kernel; },
   get median () { return median; },
   get modulate () { return modulate; },
   get negate () { return negate; },
@@ -47,6 +48,12 @@ const Handlers = {
   get width () { return width; }
 };
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 function getEnv(name, defaultValue) {
   return destr(process.env[name]) ?? defaultValue;
 }
@@ -61,6 +68,11 @@ function cachedPromise(function_) {
   };
 }
 class IPXError extends Error {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "statusCode");
+    __publicField(this, "statusMessage");
+  }
 }
 function createError(statusMessage, statusCode, trace) {
   const error = new IPXError(statusMessage + (trace ? ` (${trace})` : ""));
@@ -232,6 +244,12 @@ const enlarge = {
     context.enlarge = true;
   }
 };
+const kernel = {
+  args: [VArg],
+  apply: (context, _pipe, kernel2) => {
+    context.kernel = kernel2;
+  }
+};
 const width = {
   args: [VArg],
   apply: (context, pipe, width2) => {
@@ -269,7 +287,8 @@ const resize = {
     return pipe.resize(width2, height2, {
       fit: context.fit,
       position: context.position,
-      background: context.background
+      background: context.background,
+      kernel: context.kernel
     });
   }
 };
@@ -409,7 +428,8 @@ const SUPPORTED_FORMATS = /* @__PURE__ */ new Set([
   "avif",
   "tiff",
   "heif",
-  "gif"
+  "gif",
+  "heic"
 ]);
 function createIPX(userOptions) {
   const defaults = {
@@ -477,7 +497,7 @@ function createIPX(userOptions) {
       const Sharp = await import('sharp').then(
         (r) => r.default || r
       );
-      let sharp = Sharp(data, { animated });
+      let sharp = Sharp(data, { animated, ...options.sharp });
       Object.assign(sharp.options, options.sharp);
       const handlers = Object.entries(modifiers).map(([name, arguments_]) => ({
         handler: getHandler(name),
@@ -577,7 +597,7 @@ async function _handleRequest(request, ipx) {
   }
   res.headers["Content-Security-Policy"] = "default-src 'none'";
   res.body = data;
-  return sanetizeReponse(res);
+  return sanitizeReponse(res);
 }
 function handleRequest(request, ipx) {
   return _handleRequest(request, ipx).catch((error) => {
@@ -586,7 +606,7 @@ function handleRequest(request, ipx) {
     if (process.env.NODE_ENV !== "production" && statusCode === 500) {
       console.error(error);
     }
-    return sanetizeReponse({
+    return sanitizeReponse({
       statusCode,
       statusMessage,
       body: "IPX Error: " + error,
@@ -629,7 +649,7 @@ function autoDetectFormat(acceptHeader, animated) {
   ]);
   return acceptMime?.split("/")[1] || "jpeg";
 }
-function sanetizeReponse(res) {
+function sanitizeReponse(res) {
   return {
     statusCode: res.statusCode || 200,
     statusMessage: res.statusMessage ? safeString(res.statusMessage) : "OK",

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "ipx",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "repository": "unjs/ipx",
   "license": "MIT",
   "exports": {
     ".": {
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.mjs"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
   "main": "./dist/index.cjs",
@@ -19,7 +25,7 @@
   ],
   "scripts": {
     "build": "unbuild",
-    "dev": "nodemon",
+    "dev": "listhen -w playground",
     "lint": "eslint --ext .ts . && prettier -c src test",
     "lint:fix": "eslint --ext .ts . --fix && prettier -w src test",
     "prepack": "pnpm build",
@@ -29,33 +35,31 @@
   },
   "dependencies": {
     "@fastify/accept-negotiator": "^1.1.0",
-    "consola": "^3.1.0",
+    "consola": "^3.2.3",
     "defu": "^6.1.2",
-    "destr": "^1.2.2",
+    "destr": "^2.0.1",
     "etag": "^1.8.1",
     "image-meta": "^0.1.1",
-    "listhen": "^1.0.4",
-    "node-fetch-native": "^1.1.1",
+    "listhen": "^1.5.5",
+    "node-fetch-native": "^1.4.0",
     "pathe": "^1.1.1",
-    "sharp": "^0.32.1",
-    "ufo": "^1.1.2",
+    "sharp": "^0.32.6",
+    "ufo": "^1.3.1",
     "xss": "^1.0.14"
   },
   "devDependencies": {
     "@types/etag": "^1.8.1",
     "@types/is-valid-path": "^0.1.0",
-    "@vitest/coverage-c8": "^0.32.0",
-    "@vitest/coverage-v8": "^0.32.0",
-    "changelogen": "^0.5.3",
-    "eslint": "^8.42.0",
+    "@vitest/coverage-v8": "^0.34.6",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.50.0",
     "eslint-config-unjs": "^0.2.1",
-    "jiti": "^1.18.2",
-    "nodemon": "^2.0.22",
-    "prettier": "^2.8.8",
+    "jiti": "^1.20.0",
+    "prettier": "^3.0.3",
     "serve-handler": "^6.1.5",
-    "typescript": "^5.1.3",
-    "unbuild": "^1.2.1",
-    "vitest": "^0.32.0"
+    "typescript": "^5.2.2",
+    "unbuild": "^2.0.0",
+    "vitest": "^0.34.6"
   },
-  "packageManager": "pnpm@8.6.1"
+  "packageManager": "pnpm@8.7.1"
 }