ipx 2.0.0-0 → 2.0.0-1

package/README.md

@@ -7,8 +7,8 @@ High performance, secure and easy-to-use image optimizer.
 
 Powered by [sharp](https://github.com/lovell/sharp) and [libvips](https://github.com/libvips/libvips).
 
-> [!IMPORTANT]  
-> This is the development branch for IPX v2. Check out [ipx/v1](https://github.com/unjs/ipx/tree/v1) for latest stable docs.
+> [!IMPORTANT]
+> This is the development branch for IPX v2. Check out [ipx/v1](https://github.com/unjs/ipx/tree/v1) for latest stable docs and [#71](https://github.com/unjs/ipx/issues/171) for v2 roadmap.
 
 ## Using CLI
 
@@ -17,13 +17,13 @@ You can use `ipx` command to start server.
 Using `npx`:
 
 ```bash
-npx ipx@latest serve --dir ./
+npx ipx@next-2 serve --dir ./
 ```
 
 Usin `bun`
 
 ```bash
-bun x ipx@latest serve --dir ./
+bun x npx ipx@next-2 serve --dir ./
 ```
 
 The default serve directory is the current working directory.
@@ -38,7 +38,7 @@ import {
   createIPXMiddleware,
   ipxFSStorage,
   ipxHttpStorage,
-} from "./src";
+} from "ipx";
 
 const ipx = createIPX({
   storage: ipxFSStorage({ dir: "./public" }),

package/dist/cli.cjs

@@ -3,7 +3,7 @@
 const listhen = require('listhen');
 const citty = require('citty');
 const cli = require('listhen/cli');
-const nodeFs = require('./shared/ipx.0fc4e4c7.cjs');
+const nodeFs = require('./shared/ipx.680a50a5.cjs');
 require('defu');
 require('image-meta');
 require('ufo');
@@ -11,11 +11,11 @@ require('h3');
 require('destr');
 require('@fastify/accept-negotiator');
 require('etag');
-require('node-fetch-native');
+require('ofetch');
 require('pathe');
 
 const name = "ipx";
-const version = "2.0.0-0";
+const version = "2.0.0-1";
 const description = "High performance, secure and easy-to-use image optimizer.";
 
 const serve = citty.defineCommand({

package/dist/cli.mjs

@@ -1,7 +1,7 @@
 import { listen } from 'listhen';
 import { defineCommand, runMain } from 'citty';
 import { getArgs, parseArgs } from 'listhen/cli';
-import { c as createIPX, g as ipxFSStorage, i as ipxHttpStorage, e as createIPXNodeServer } from './shared/ipx.42c0c175.mjs';
+import { c as createIPX, g as ipxFSStorage, i as ipxHttpStorage, e as createIPXNodeServer } from './shared/ipx.57fad794.mjs';
 import 'defu';
 import 'image-meta';
 import 'ufo';
@@ -9,11 +9,11 @@ import 'h3';
 import 'destr';
 import '@fastify/accept-negotiator';
 import 'etag';
-import 'node-fetch-native';
+import 'ofetch';
 import 'pathe';
 
 const name = "ipx";
-const version = "2.0.0-0";
+const version = "2.0.0-1";
 const description = "High performance, secure and easy-to-use image optimizer.";
 
 const serve = defineCommand({

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-const nodeFs = require('./shared/ipx.0fc4e4c7.cjs');
+const nodeFs = require('./shared/ipx.680a50a5.cjs');
 require('defu');
 require('image-meta');
 require('ufo');
@@ -8,7 +8,7 @@ require('h3');
 require('destr');
 require('@fastify/accept-negotiator');
 require('etag');
-require('node-fetch-native');
+require('ofetch');
 require('pathe');
 
 function unstorageToIPXStorage(storage, prefix) {

package/dist/index.d.cts

@@ -128,7 +128,11 @@ type IPXOptions = {
 };
 declare function createIPX(userOptions: IPXOptions): IPX;
 
-declare function createIPXH3Handler(ipx: IPX): h3.EventHandler<h3.EventHandlerRequest, Promise<Buffer | null>>;
+declare function createIPXH3Handler(ipx: IPX): h3.EventHandler<h3.EventHandlerRequest, Promise<Buffer | {
+    error: {
+        message: string;
+    };
+} | null>>;
 declare function createIPXH3App(ipx: IPX): h3.App;
 declare function createIPXWebServer(ipx: IPX): h3.WebHandler;
 declare function createIPXNodeServer(ipx: IPX): h3.NodeListener;

package/dist/index.d.mts

@@ -128,7 +128,11 @@ type IPXOptions = {
 };
 declare function createIPX(userOptions: IPXOptions): IPX;
 
-declare function createIPXH3Handler(ipx: IPX): h3.EventHandler<h3.EventHandlerRequest, Promise<Buffer | null>>;
+declare function createIPXH3Handler(ipx: IPX): h3.EventHandler<h3.EventHandlerRequest, Promise<Buffer | {
+    error: {
+        message: string;
+    };
+} | null>>;
 declare function createIPXH3App(ipx: IPX): h3.App;
 declare function createIPXWebServer(ipx: IPX): h3.WebHandler;
 declare function createIPXNodeServer(ipx: IPX): h3.NodeListener;

package/dist/index.d.ts

@@ -128,7 +128,11 @@ type IPXOptions = {
 };
 declare function createIPX(userOptions: IPXOptions): IPX;
 
-declare function createIPXH3Handler(ipx: IPX): h3.EventHandler<h3.EventHandlerRequest, Promise<Buffer | null>>;
+declare function createIPXH3Handler(ipx: IPX): h3.EventHandler<h3.EventHandlerRequest, Promise<Buffer | {
+    error: {
+        message: string;
+    };
+} | null>>;
 declare function createIPXH3App(ipx: IPX): h3.App;
 declare function createIPXWebServer(ipx: IPX): h3.WebHandler;
 declare function createIPXNodeServer(ipx: IPX): h3.NodeListener;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { c as createIPX, b as createIPXH3App, a as createIPXH3Handler, e as createIPXNodeServer, f as createIPXPlainServer, d as createIPXWebServer, g as ipxFSStorage, i as ipxHttpStorage } from './shared/ipx.42c0c175.mjs';
+export { c as createIPX, b as createIPXH3App, a as createIPXH3Handler, e as createIPXNodeServer, f as createIPXPlainServer, d as createIPXWebServer, g as ipxFSStorage, i as ipxHttpStorage } from './shared/ipx.57fad794.mjs';
 import 'defu';
 import 'image-meta';
 import 'ufo';
@@ -6,7 +6,7 @@ import 'h3';
 import 'destr';
 import '@fastify/accept-negotiator';
 import 'etag';
-import 'node-fetch-native';
+import 'ofetch';
 import 'pathe';
 
 function unstorageToIPXStorage(storage, prefix) {

package/dist/shared/{ipx.42c0c175.mjs → ipx.57fad794.mjs}

@@ -1,11 +1,11 @@
 import { defu } from 'defu';
 import { imageMeta } from 'image-meta';
 import { withLeadingSlash, hasProtocol, joinURL, decode } from 'ufo';
-import { createError, defineEventHandler, getRequestHeader, setResponseHeader, setResponseStatus, createApp, toWebHandler, toNodeListener, toPlainHandler } from 'h3';
+import { createError, defineEventHandler, setResponseStatus, createApp, toWebHandler, toNodeListener, toPlainHandler, getRequestHeader, setResponseHeader } from 'h3';
 import destr from 'destr';
 import { negotiate } from '@fastify/accept-negotiator';
 import getEtag from 'etag';
-import { fetch } from 'node-fetch-native';
+import { ofetch } from 'ofetch';
 import { resolve, join, parse } from 'pathe';
 
 const Handlers = {
@@ -335,6 +335,7 @@ function createIPX(userOptions) {
     if (!id) {
       throw createError({
         statusCode: 400,
+        statusText: `IPX_MISSING_ID`,
         message: `Resource id is missing`
       });
     }
@@ -348,6 +349,7 @@ function createIPX(userOptions) {
     if (!storage) {
       throw createError({
         statusCode: 500,
+        statusText: `IPX_NO_STORAGE`,
         message: "No storage configured!"
       });
     }
@@ -356,6 +358,7 @@ function createIPX(userOptions) {
       if (!sourceMeta) {
         throw createError({
           statusCode: 404,
+          statusText: `IPX_RESOURCE_NOT_FOUND`,
           message: `Resource not found: ${id}`
         });
       }
@@ -369,6 +372,7 @@ function createIPX(userOptions) {
       if (!sourceData) {
         throw createError({
           statusCode: 404,
+          statusText: `IPX_RESOURCE_NOT_FOUND`,
           message: `Resource not found: ${id}`
         });
       }
@@ -376,7 +380,16 @@ function createIPX(userOptions) {
     });
     const process = cachedPromise(async () => {
       const sourceData = await getSourceData();
-      const imageMeta$1 = imageMeta(sourceData);
+      let imageMeta$1;
+      try {
+        imageMeta$1 = imageMeta(sourceData);
+      } catch {
+        throw createError({
+          statusCode: 400,
+          statusText: `IPX_INVALID_IMAGE`,
+          message: `Cannot parse image metadata: ${id}`
+        });
+      }
       let mFormat = modifiers.f || modifiers.format;
       if (mFormat === "jpg") {
         mFormat = "jpeg";
@@ -432,7 +445,7 @@ function createIPX(userOptions) {
 const MODIFIER_SEP = /[&,]/g;
 const MODIFIER_VAL_SEP = /[:=_]/;
 function createIPXH3Handler(ipx) {
-  return defineEventHandler(async (event) => {
+  const _handler = async (event) => {
     const [modifiersString = "", ...idSegments] = event.path.slice(
       1
       /* leading slash */
@@ -441,12 +454,14 @@ function createIPXH3Handler(ipx) {
     if (!modifiersString) {
       throw createError({
         statusCode: 400,
+        statusText: `IPX_MISSING_MODIFIERS`,
         message: `Modifiers are missing: ${id}`
       });
     }
     if (!id || id === "/") {
       throw createError({
         statusCode: 400,
+        statusText: `IPX_MISSING_ID`,
         message: `Resource id is missing: ${event.path}`
       });
     }
@@ -499,6 +514,19 @@ function createIPXH3Handler(ipx) {
     }
     setResponseHeader(event, "content-security-policy", "default-src 'none'");
     return data;
+  };
+  return defineEventHandler(async (event) => {
+    try {
+      return await _handler(event);
+    } catch (_error) {
+      const error = createError(_error);
+      setResponseStatus(event, error.statusCode, error.statusMessage);
+      return {
+        error: {
+          message: `[${error.statusCode}] [${error.statusMessage || "IPX_ERROR"}] ${error.message}`
+        }
+      };
+    }
   });
 }
 function createIPXH3App(ipx) {
@@ -557,24 +585,20 @@ function ipxHttpStorage(_options = {}) {
     if (!url.hostname) {
       throw createError({
         statusCode: 403,
+        statusText: `IPX_MISSING_HOSTNAME`,
         message: `Hostname is missing: ${id}`
       });
     }
     if (!allowAllDomains && !domains.has(url.hostname)) {
       throw createError({
         statusCode: 403,
+        statusText: `IPX_FORBIDDEN_HOST`,
         message: `Forbidden host: ${url.hostname}`
       });
     }
     return url.toString();
   }
   function parseResponse(response) {
-    if (!response.ok) {
-      throw createError({
-        statusCode: response.status || 500,
-        message: `Fetch error: ${response.statusText}`
-      });
-    }
     let maxAge = defaultMaxAge;
     const _cacheControl = response.headers.get("cache-control");
     if (_cacheControl) {
@@ -595,7 +619,10 @@ function ipxHttpStorage(_options = {}) {
     async getMeta(id) {
       const url = validateId(id);
       try {
-        const response = await fetch(url, { ...fetchOptions, method: "HEAD" });
+        const response = await ofetch.raw(url, {
+          ...fetchOptions,
+          method: "HEAD"
+        });
         const { maxAge, mtime } = parseResponse(response);
         return { mtime, maxAge };
       } catch {
@@ -604,8 +631,12 @@ function ipxHttpStorage(_options = {}) {
     },
     async getData(id) {
       const url = validateId(id);
-      const response = await fetch(url, { ...fetchOptions, method: "GET" });
-      return response.arrayBuffer();
+      const response = await ofetch(url, {
+        ...fetchOptions,
+        method: "GET",
+        responseType: "arrayBuffer"
+      });
+      return response;
     }
   };
 }
@@ -618,6 +649,7 @@ function ipxFSStorage(_options = {}) {
     if (!isValidPath(resolved) || !resolved.startsWith(rootDir)) {
       throw createError({
         statusCode: 403,
+        statusText: `IPX_FORBIDDEN_PATH`,
         message: `Forbidden path: ${id}`
       });
     }
@@ -635,16 +667,19 @@ function ipxFSStorage(_options = {}) {
       } catch (error) {
         throw error.code === "ENOENT" ? createError({
           statusCode: 404,
-          message: `File not found: ${fsPath}`
+          statusText: `IPX_FILE_NOT_FOUND`,
+          message: `File not found: ${id}`
         }) : createError({
           statusCode: 403,
-          message: `File access error: (${error.code}) ${fsPath}`
+          statusText: `IPX_FORBIDDEN_FILE`,
+          message: `File access forbidden: (${error.code}) ${id}`
         });
       }
       if (!stats.isFile()) {
         throw createError({
           statusCode: 400,
-          message: `Path should be a file: ${fsPath}`
+          statusText: `IPX_INVALID_FILE`,
+          message: `Path should be a file: ${id}`
         });
       }
       return {

package/dist/shared/{ipx.0fc4e4c7.cjs → ipx.680a50a5.cjs}

@@ -7,7 +7,7 @@ const h3 = require('h3');
 const destr = require('destr');
 const acceptNegotiator = require('@fastify/accept-negotiator');
 const getEtag = require('etag');
-const nodeFetchNative = require('node-fetch-native');
+const ofetch = require('ofetch');
 const pathe = require('pathe');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
@@ -342,6 +342,7 @@ function createIPX(userOptions) {
     if (!id) {
       throw h3.createError({
         statusCode: 400,
+        statusText: `IPX_MISSING_ID`,
         message: `Resource id is missing`
       });
     }
@@ -355,6 +356,7 @@ function createIPX(userOptions) {
     if (!storage) {
       throw h3.createError({
         statusCode: 500,
+        statusText: `IPX_NO_STORAGE`,
         message: "No storage configured!"
       });
     }
@@ -363,6 +365,7 @@ function createIPX(userOptions) {
       if (!sourceMeta) {
         throw h3.createError({
           statusCode: 404,
+          statusText: `IPX_RESOURCE_NOT_FOUND`,
           message: `Resource not found: ${id}`
         });
       }
@@ -376,6 +379,7 @@ function createIPX(userOptions) {
       if (!sourceData) {
         throw h3.createError({
           statusCode: 404,
+          statusText: `IPX_RESOURCE_NOT_FOUND`,
           message: `Resource not found: ${id}`
         });
       }
@@ -383,7 +387,16 @@ function createIPX(userOptions) {
     });
     const process = cachedPromise(async () => {
       const sourceData = await getSourceData();
-      const imageMeta$1 = imageMeta.imageMeta(sourceData);
+      let imageMeta$1;
+      try {
+        imageMeta$1 = imageMeta.imageMeta(sourceData);
+      } catch {
+        throw h3.createError({
+          statusCode: 400,
+          statusText: `IPX_INVALID_IMAGE`,
+          message: `Cannot parse image metadata: ${id}`
+        });
+      }
       let mFormat = modifiers.f || modifiers.format;
       if (mFormat === "jpg") {
         mFormat = "jpeg";
@@ -439,7 +452,7 @@ function createIPX(userOptions) {
 const MODIFIER_SEP = /[&,]/g;
 const MODIFIER_VAL_SEP = /[:=_]/;
 function createIPXH3Handler(ipx) {
-  return h3.defineEventHandler(async (event) => {
+  const _handler = async (event) => {
     const [modifiersString = "", ...idSegments] = event.path.slice(
       1
       /* leading slash */
@@ -448,12 +461,14 @@ function createIPXH3Handler(ipx) {
     if (!modifiersString) {
       throw h3.createError({
         statusCode: 400,
+        statusText: `IPX_MISSING_MODIFIERS`,
         message: `Modifiers are missing: ${id}`
       });
     }
     if (!id || id === "/") {
       throw h3.createError({
         statusCode: 400,
+        statusText: `IPX_MISSING_ID`,
         message: `Resource id is missing: ${event.path}`
       });
     }
@@ -506,6 +521,19 @@ function createIPXH3Handler(ipx) {
     }
     h3.setResponseHeader(event, "content-security-policy", "default-src 'none'");
     return data;
+  };
+  return h3.defineEventHandler(async (event) => {
+    try {
+      return await _handler(event);
+    } catch (_error) {
+      const error = h3.createError(_error);
+      h3.setResponseStatus(event, error.statusCode, error.statusMessage);
+      return {
+        error: {
+          message: `[${error.statusCode}] [${error.statusMessage || "IPX_ERROR"}] ${error.message}`
+        }
+      };
+    }
   });
 }
 function createIPXH3App(ipx) {
@@ -564,24 +592,20 @@ function ipxHttpStorage(_options = {}) {
     if (!url.hostname) {
       throw h3.createError({
         statusCode: 403,
+        statusText: `IPX_MISSING_HOSTNAME`,
         message: `Hostname is missing: ${id}`
       });
     }
     if (!allowAllDomains && !domains.has(url.hostname)) {
       throw h3.createError({
         statusCode: 403,
+        statusText: `IPX_FORBIDDEN_HOST`,
         message: `Forbidden host: ${url.hostname}`
       });
     }
     return url.toString();
   }
   function parseResponse(response) {
-    if (!response.ok) {
-      throw h3.createError({
-        statusCode: response.status || 500,
-        message: `Fetch error: ${response.statusText}`
-      });
-    }
     let maxAge = defaultMaxAge;
     const _cacheControl = response.headers.get("cache-control");
     if (_cacheControl) {
@@ -602,7 +626,10 @@ function ipxHttpStorage(_options = {}) {
     async getMeta(id) {
       const url = validateId(id);
       try {
-        const response = await nodeFetchNative.fetch(url, { ...fetchOptions, method: "HEAD" });
+        const response = await ofetch.ofetch.raw(url, {
+          ...fetchOptions,
+          method: "HEAD"
+        });
         const { maxAge, mtime } = parseResponse(response);
         return { mtime, maxAge };
       } catch {
@@ -611,8 +638,12 @@ function ipxHttpStorage(_options = {}) {
     },
     async getData(id) {
       const url = validateId(id);
-      const response = await nodeFetchNative.fetch(url, { ...fetchOptions, method: "GET" });
-      return response.arrayBuffer();
+      const response = await ofetch.ofetch(url, {
+        ...fetchOptions,
+        method: "GET",
+        responseType: "arrayBuffer"
+      });
+      return response;
     }
   };
 }
@@ -625,6 +656,7 @@ function ipxFSStorage(_options = {}) {
     if (!isValidPath(resolved) || !resolved.startsWith(rootDir)) {
       throw h3.createError({
         statusCode: 403,
+        statusText: `IPX_FORBIDDEN_PATH`,
         message: `Forbidden path: ${id}`
       });
     }
@@ -642,16 +674,19 @@ function ipxFSStorage(_options = {}) {
       } catch (error) {
         throw error.code === "ENOENT" ? h3.createError({
           statusCode: 404,
-          message: `File not found: ${fsPath}`
+          statusText: `IPX_FILE_NOT_FOUND`,
+          message: `File not found: ${id}`
         }) : h3.createError({
           statusCode: 403,
-          message: `File access error: (${error.code}) ${fsPath}`
+          statusText: `IPX_FORBIDDEN_FILE`,
+          message: `File access forbidden: (${error.code}) ${id}`
         });
       }
       if (!stats.isFile()) {
         throw h3.createError({
           statusCode: 400,
-          message: `Path should be a file: ${fsPath}`
+          statusText: `IPX_INVALID_FILE`,
+          message: `Path should be a file: ${id}`
         });
       }
       return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipx",
-  "version": "2.0.0-0",
+  "version": "2.0.0-1",
   "repository": "unjs/ipx",
   "description": "High performance, secure and easy-to-use image optimizer.",
   "license": "MIT",
@@ -24,6 +24,18 @@
     "dist",
     "bin"
   ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "listhen -w playground",
+    "ipx": "jiti ./src/cli.ts",
+    "lint": "eslint --ext .ts . && prettier -c src test",
+    "lint:fix": "eslint --ext .ts . --fix && prettier -w src test",
+    "prepack": "pnpm build",
+    "release": "pnpm test && changelogen --release --push && npm publish",
+    "prerelease": "pnpm test && pnpm build && changelogen --release --prerelease --push --publish --publishTag next-2",
+    "start": "node bin/ipx.js",
+    "test": "pnpm lint && vitest run --coverage"
+  },
   "dependencies": {
     "@fastify/accept-negotiator": "^1.1.0",
     "citty": "^0.1.4",
@@ -31,39 +43,28 @@
     "defu": "^6.1.2",
     "destr": "^2.0.1",
     "etag": "^1.8.1",
-    "h3": "^1.8.1",
+    "h3": "^1.8.2",
     "image-meta": "^0.1.1",
-    "listhen": "^1.5.2",
-    "node-fetch-native": "^1.4.0",
+    "listhen": "^1.5.5",
+    "ofetch": "^1.3.3",
     "pathe": "^1.1.1",
-    "sharp": "^0.32.5",
+    "sharp": "^0.32.6",
     "ufo": "^1.3.0",
     "unstorage": "^1.9.0"
   },
   "devDependencies": {
     "@types/etag": "^1.8.1",
     "@types/is-valid-path": "^0.1.0",
-    "@vitest/coverage-v8": "^0.34.4",
+    "@vitest/coverage-v8": "^0.34.5",
     "changelogen": "^0.5.5",
-    "eslint": "^8.49.0",
+    "eslint": "^8.50.0",
     "eslint-config-unjs": "^0.2.1",
     "jiti": "^1.20.0",
     "prettier": "^3.0.3",
     "serve-handler": "^6.1.5",
     "typescript": "^5.2.2",
     "unbuild": "^2.0.0",
-    "vitest": "^0.34.4"
+    "vitest": "^0.34.5"
   },
-  "packageManager": "pnpm@8.7.5",
-  "scripts": {
-    "build": "unbuild",
-    "dev": "listhen -w playground",
-    "ipx": "jiti ./src/cli.ts",
-    "lint": "eslint --ext .ts . && prettier -c src test",
-    "lint:fix": "eslint --ext .ts . --fix && prettier -w src test",
-    "release": "pnpm test && changelogen --release --push && npm publish",
-    "prerelease": "pnpm test && pnpm build && changelogen --release --prerelease --push --publish --publishTag v2",
-    "start": "node bin/ipx.js",
-    "test": "pnpm lint && vitest run --coverage"
-  }
+  "packageManager": "pnpm@8.8.0"
 }