@takumi-rs/image-response 2.0.0-beta.8 → 2.0.0-rc.0

package/README.md

@@ -1,135 +1,19 @@
 # @takumi-rs/image-response
 
-A universal `ImageResponse` implementation for Takumi in Next.js and other environments.
+> **Migrated to [`takumi-js/response`](https://www.npmjs.com/package/takumi-js).**
 
-Checkout the migration guide [From Next.js ImageResponse](https://takumi.kane.tw/docs/upgrade/v1) for more details.
-
-## Installation
+This package has moved into `takumi-js`. Install `takumi-js` and import `ImageResponse` from `takumi-js/response`:
 
 ```bash
-npm install @takumi-rs/image-response
-```
-
-## Usage
-
-```tsx
-import ImageResponse from "@takumi-rs/image-response";
-
-export function GET(request: Request) {
-  return new ImageResponse(<OgImage />, {
-    width: 1200,
-    height: 630,
-    format: "webp",
-    headers: {
-      "Cache-Control": "public, immutable, max-age=31536000",
-    },
-  });
-}
+npm install takumi-js
 ```
 
-Pass custom fonts per response; identical fonts are registered once and reused automatically.
-
 ```tsx
-import { ImageResponse } from "@takumi-rs/image-response";
+import { ImageResponse } from "takumi-js/response";
 
 export function GET() {
-  return new ImageResponse(<OgImage />, {
-    fonts: [
-      {
-        data: () => fetch("/fonts/Inter-Regular.ttf").then((res) => res.arrayBuffer()),
-        name: "Inter",
-      },
-    ],
-  });
+  return new ImageResponse(<OgImage />, { width: 1200, height: 630 });
 }
 ```
 
-### Fonts
-
-Takumi comes with full-axis [Geist](https://vercel.com/font) and Geist Mono by default.
-
-We have a global fonts cache to avoid loading the same fonts multiple times.
-
-If your environment supports top-level await, you can load the fonts in global scope and reuse the fonts array.
-
-```tsx
-const fonts = [
-  {
-    name: "Inter",
-    data: await fetch("/fonts/Inter-Regular.ttf").then((res) => res.arrayBuffer()),
-    style: "normal",
-    weight: 400,
-  },
-];
-
-new ImageResponse(<OgImage />, { fonts });
-```
-
-If your environment doesn't support top-level await, you can pass a lazy `data` loader instead.
-
-```tsx
-export function GET(request: Request) {
-  return new ImageResponse(<OgImage />, {
-    fonts: [
-      {
-        name: "Inter",
-        data: () => fetch("/fonts/Inter-Regular.ttf").then((res) => res.arrayBuffer()),
-        style: "normal",
-        weight: 400,
-      },
-    ],
-  });
-}
-```
-
-Images can likewise be provided up front via `images`, keyed by `src`, each with bytes or a sync/async loader.
-
-### Bring-Your-Own-Renderer (BYOR)
-
-If you want to use your own renderer instance, you can pass it to the `ImageResponse` constructor.
-
-```tsx
-import { Renderer } from "@takumi-rs/core";
-
-const renderer = new Renderer();
-
-new ImageResponse(<OgImage />, { renderer });
-```
-
-### JSX Options
-
-You can pass the JSX options to the `ImageResponse` constructor.
-
-```tsx
-new ImageResponse(<OgImage />, {
-  jsx: {
-    defaultStyles: false,
-  },
-});
-```
-
-### Error Handling
-
-`ImageResponse` exposes a `ready` promise that resolves when rendering succeeds and rejects when rendering fails.
-
-```tsx
-const response = new ImageResponse(<OgImage />);
-
-await response.ready;
-return response;
-```
-
-You can also provide `onError`, a notification hook that runs after rendering fails. It's for side effects like logging; its return value is ignored and the response stream still errors, so it cannot substitute a fallback image. To serve a fallback, catch the `ready` rejection and return your own response.
-
-```tsx
-const response = new ImageResponse(<OgImage />, {
-  onError: (error) => console.error(error),
-});
-
-try {
-  await response.ready;
-  return response;
-} catch {
-  return new Response("Failed to generate image", { status: 500 });
-}
-```
+See the [migration guide](https://takumi.kane.tw/docs/upgrade/v2) and the [`ImageResponse` reference](https://takumi.kane.tw/docs/image-response) for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takumi-rs/image-response",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.0-rc.0",
   "license": "(MIT OR Apache-2.0)",
   "author": {
     "name": "Kane Wang",
@@ -44,11 +44,14 @@
     "publish-lint": "attw --pack . && publint --strict ."
   },
   "dependencies": {
-    "takumi-js": "2.0.0-beta.8"
+    "takumi-js": "2.0.0-rc.0"
   },
   "devDependencies": {
     "@types/bun": "^1.3.14",
     "tsdown": "^0.22.3",
     "unrun": "^0.3.1"
+  },
+  "engines": {
+    "node": ">=18"
   }
 }