takumi-js 1.0.8 → 1.0.10

package/dist/index.cjs

@@ -1,3 +1,3 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_render = require("./render-BzJnfhcB.cjs");
+const require_render = require("./render-Cwo-VZ54.cjs");
 exports.render = require_render.render;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { n as render, t as RenderOptions } from "./render-B4oZcaAM.cjs";
+import { n as render, t as RenderOptions } from "./render-mfKqlvP8.cjs";
 import { ContainerNode, FetchResourcesOptions, ImageNode, Node, NodeAttributes, NodeMetadata, ReactElementLike, TextNode } from "@takumi-rs/helpers";
 import { AnimationFrameSource, AnimationOutputFormat, AnimationSceneSource, ConstructRendererOptions, DitheringAlgorithm, EncodeFramesOptions, Font, FontDetails, ImageSource, Keyframes, KeyframesMap, KeyframesRuleList, MeasuredNode, MeasuredTextRun, OutputFormat, RenderAnimationOptions } from "@takumi-rs/core";
 

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { n as render, t as RenderOptions } from "./render-JdCdrWfJ.mjs";
+import { n as render, t as RenderOptions } from "./render-D_xiyqZH.mjs";
 import { ContainerNode, FetchResourcesOptions, ImageNode, Node, NodeAttributes, NodeMetadata, ReactElementLike, TextNode } from "@takumi-rs/helpers";
 import { AnimationFrameSource, AnimationOutputFormat, AnimationSceneSource, ConstructRendererOptions, DitheringAlgorithm, EncodeFramesOptions, Font, FontDetails, ImageSource, Keyframes, KeyframesMap, KeyframesRuleList, MeasuredNode, MeasuredTextRun, OutputFormat, RenderAnimationOptions } from "@takumi-rs/core";
 

package/dist/index.mjs

@@ -1,2 +1,2 @@
-import { t as render } from "./render-EhI8Ytcl.mjs";
+import { t as render } from "./render-M8h1fYtV.mjs";
 export { render };

package/dist/{render-BzJnfhcB.cjs → render-Cwo-VZ54.cjs}

@@ -86,6 +86,26 @@ function transformElement(element, options) {
 	if (typeof element === "string") return (0, _takumi_rs_helpers_html.fromHtml)(element);
 	return (0, _takumi_rs_helpers_jsx.fromJsx)(element, options?.jsx);
 }
+/**
+* Renders a React element, HTML string, or Takumi node tree into an image.
+*
+* This function automatically detects the best renderer for your environment (native Rust on Node.js,
+* WASM on Edge/Workers) and handles resource fetching (fonts, images) and emoji extraction.
+*
+* @example
+* ```tsx
+* import { render } from "takumi-js";
+*
+* const buffer = await render(
+*   <div tw="bg-blue-500 text-white p-4">Hello World</div>,
+*   { width: 1200, height: 630 }
+* );
+* ```
+*
+* @param element - The content to render. Can be a JSX element (React-like), an HTML string, or a pre-constructed node tree.
+* @param options - Configuration for rendering, including dimensions, format, fonts, and more.
+* @returns A promise that resolves to the rendered image data (Buffer/Uint8Array).
+*/
 async function render(element, options) {
 	const imports = await getImports(options && "module" in options ? options.module : void 0);
 	const isExternalRenderer = options && "renderer" in options;

package/dist/{render-B4oZcaAM.d.cts → render-D_xiyqZH.d.mts}

@@ -37,6 +37,26 @@ type RenderOptionsWithRenderer = InnerRenderOptions & {
 };
 type RenderOptionsWithoutRenderer = Omit<RenderOptionsWithRenderer, "renderer"> & ManagedRendererOptions;
 type RenderOptions = RenderOptionsWithRenderer | RenderOptionsWithoutRenderer;
+/**
+ * Renders a React element, HTML string, or Takumi node tree into an image.
+ *
+ * This function automatically detects the best renderer for your environment (native Rust on Node.js,
+ * WASM on Edge/Workers) and handles resource fetching (fonts, images) and emoji extraction.
+ *
+ * @example
+ * ```tsx
+ * import { render } from "takumi-js";
+ *
+ * const buffer = await render(
+ *   <div tw="bg-blue-500 text-white p-4">Hello World</div>,
+ *   { width: 1200, height: 630 }
+ * );
+ * ```
+ *
+ * @param element - The content to render. Can be a JSX element (React-like), an HTML string, or a pre-constructed node tree.
+ * @param options - Configuration for rendering, including dimensions, format, fonts, and more.
+ * @returns A promise that resolves to the rendered image data (Buffer/Uint8Array).
+ */
 declare function render(element: ReactNode | ReactElementLike | string, options?: RenderOptions): Promise<Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>;
 //#endregion
 export { render as n, RenderOptions as t };

package/dist/{render-EhI8Ytcl.mjs → render-M8h1fYtV.mjs}

@@ -85,6 +85,26 @@ function transformElement(element, options) {
 	if (typeof element === "string") return fromHtml(element);
 	return fromJsx(element, options?.jsx);
 }
+/**
+* Renders a React element, HTML string, or Takumi node tree into an image.
+*
+* This function automatically detects the best renderer for your environment (native Rust on Node.js,
+* WASM on Edge/Workers) and handles resource fetching (fonts, images) and emoji extraction.
+*
+* @example
+* ```tsx
+* import { render } from "takumi-js";
+*
+* const buffer = await render(
+*   <div tw="bg-blue-500 text-white p-4">Hello World</div>,
+*   { width: 1200, height: 630 }
+* );
+* ```
+*
+* @param element - The content to render. Can be a JSX element (React-like), an HTML string, or a pre-constructed node tree.
+* @param options - Configuration for rendering, including dimensions, format, fonts, and more.
+* @returns A promise that resolves to the rendered image data (Buffer/Uint8Array).
+*/
 async function render(element, options) {
 	const imports = await getImports(options && "module" in options ? options.module : void 0);
 	const isExternalRenderer = options && "renderer" in options;

package/dist/{render-JdCdrWfJ.d.mts → render-mfKqlvP8.d.cts}

@@ -37,6 +37,26 @@ type RenderOptionsWithRenderer = InnerRenderOptions & {
 };
 type RenderOptionsWithoutRenderer = Omit<RenderOptionsWithRenderer, "renderer"> & ManagedRendererOptions;
 type RenderOptions = RenderOptionsWithRenderer | RenderOptionsWithoutRenderer;
+/**
+ * Renders a React element, HTML string, or Takumi node tree into an image.
+ *
+ * This function automatically detects the best renderer for your environment (native Rust on Node.js,
+ * WASM on Edge/Workers) and handles resource fetching (fonts, images) and emoji extraction.
+ *
+ * @example
+ * ```tsx
+ * import { render } from "takumi-js";
+ *
+ * const buffer = await render(
+ *   <div tw="bg-blue-500 text-white p-4">Hello World</div>,
+ *   { width: 1200, height: 630 }
+ * );
+ * ```
+ *
+ * @param element - The content to render. Can be a JSX element (React-like), an HTML string, or a pre-constructed node tree.
+ * @param options - Configuration for rendering, including dimensions, format, fonts, and more.
+ * @returns A promise that resolves to the rendered image data (Buffer/Uint8Array).
+ */
 declare function render(element: ReactNode | ReactElementLike | string, options?: RenderOptions): Promise<Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>>;
 //#endregion
 export { render as n, RenderOptions as t };

package/dist/response.cjs

@@ -2,7 +2,7 @@ Object.defineProperties(exports, {
 	__esModule: { value: true },
 	[Symbol.toStringTag]: { value: "Module" }
 });
-const require_render = require("./render-BzJnfhcB.cjs");
+const require_render = require("./render-Cwo-VZ54.cjs");
 //#region src/response/index.ts
 function mergeOptions(defaultOptions, options) {
 	if (!defaultOptions) return options;
@@ -29,6 +29,26 @@ function defaultErrorHandler(error) {
 	console.error("Failed to render image.");
 	console.error(error);
 }
+/**
+* Creates a reusable ImageResponse factory with shared configuration.
+*
+* Use this to avoid repeating configuration like fonts, stylesheets, or cache headers
+* across multiple API routes.
+*
+* @example
+* ```tsx
+* const myImageResponse = createImageResponse({
+*   fonts: [{ name: "Inter", data: fontBuffer }],
+*   headers: { "Cache-Control": "public, max-age=31536000" }
+* });
+*
+* export function GET() {
+*   return myImageResponse(<div>Custom Og Image</div>);
+* }
+* ```
+*
+* @param defaultOptions - Options that will be applied to every response created by this factory.
+*/
 function createImageResponse(defaultOptions) {
 	return function imageResponse(element, options) {
 		const mergedOptions = mergeOptions(defaultOptions, options);
@@ -63,6 +83,29 @@ function createImageResponse(defaultOptions) {
 	};
 }
 let defaultImageResponse;
+/**
+* A universal ImageResponse class for generating images in API routes.
+*
+* Drop-in compatible with `next/og`'s `ImageResponse`. It supports React elements,
+* custom fonts, Tailwind CSS (via `tw` prop), and various image formats.
+*
+* @example
+* ```tsx
+* import { ImageResponse } from "takumi-js/response";
+*
+* export function GET() {
+*   return new ImageResponse(
+*     <div tw="flex h-full w-full items-center justify-center bg-white">
+*       <h1 tw="text-6xl font-bold">Hello World</h1>
+*     </div>,
+*     { width: 1200, height: 630 }
+*   );
+* }
+* ```
+*
+* @param component - The JSX element to render.
+* @param options - Rendering and response options.
+*/
 var ImageResponse = class extends Response {
 	ready;
 	constructor(component, options) {

package/dist/response.d.cts

@@ -1,4 +1,4 @@
-import { t as RenderOptions } from "./render-B4oZcaAM.cjs";
+import { t as RenderOptions } from "./render-mfKqlvP8.cjs";
 import { ReactNode } from "react";
 
 //#region src/response/index.d.ts
@@ -9,7 +9,50 @@ type ImageResponseOptions = RenderOptions & ResponseInit & {
   onError?: (error: unknown) => void | Promise<void>;
 };
 type ImageResponseFactory = (component: ReactNode, options?: ImageResponseOptions) => ImageResponseResult;
+/**
+ * Creates a reusable ImageResponse factory with shared configuration.
+ *
+ * Use this to avoid repeating configuration like fonts, stylesheets, or cache headers
+ * across multiple API routes.
+ *
+ * @example
+ * ```tsx
+ * const myImageResponse = createImageResponse({
+ *   fonts: [{ name: "Inter", data: fontBuffer }],
+ *   headers: { "Cache-Control": "public, max-age=31536000" }
+ * });
+ *
+ * export function GET() {
+ *   return myImageResponse(<div>Custom Og Image</div>);
+ * }
+ * ```
+ *
+ * @param defaultOptions - Options that will be applied to every response created by this factory.
+ */
 declare function createImageResponse(defaultOptions?: ImageResponseOptions): ImageResponseFactory;
+/**
+ * A universal ImageResponse class for generating images in API routes.
+ *
+ * Drop-in compatible with `next/og`'s `ImageResponse`. It supports React elements,
+ * custom fonts, Tailwind CSS (via `tw` prop), and various image formats.
+ *
+ * @example
+ * ```tsx
+ * import { ImageResponse } from "takumi-js/response";
+ *
+ * export function GET() {
+ *   return new ImageResponse(
+ *     <div tw="flex h-full w-full items-center justify-center bg-white">
+ *       <h1 tw="text-6xl font-bold">Hello World</h1>
+ *     </div>,
+ *     { width: 1200, height: 630 }
+ *   );
+ * }
+ * ```
+ *
+ * @param component - The JSX element to render.
+ * @param options - Rendering and response options.
+ */
 declare class ImageResponse extends Response {
   readonly ready: Promise<void>;
   constructor(component: ReactNode, options?: ImageResponseOptions);

package/dist/response.d.mts

@@ -1,4 +1,4 @@
-import { t as RenderOptions } from "./render-JdCdrWfJ.mjs";
+import { t as RenderOptions } from "./render-D_xiyqZH.mjs";
 import { ReactNode } from "react";
 
 //#region src/response/index.d.ts
@@ -9,7 +9,50 @@ type ImageResponseOptions = RenderOptions & ResponseInit & {
   onError?: (error: unknown) => void | Promise<void>;
 };
 type ImageResponseFactory = (component: ReactNode, options?: ImageResponseOptions) => ImageResponseResult;
+/**
+ * Creates a reusable ImageResponse factory with shared configuration.
+ *
+ * Use this to avoid repeating configuration like fonts, stylesheets, or cache headers
+ * across multiple API routes.
+ *
+ * @example
+ * ```tsx
+ * const myImageResponse = createImageResponse({
+ *   fonts: [{ name: "Inter", data: fontBuffer }],
+ *   headers: { "Cache-Control": "public, max-age=31536000" }
+ * });
+ *
+ * export function GET() {
+ *   return myImageResponse(<div>Custom Og Image</div>);
+ * }
+ * ```
+ *
+ * @param defaultOptions - Options that will be applied to every response created by this factory.
+ */
 declare function createImageResponse(defaultOptions?: ImageResponseOptions): ImageResponseFactory;
+/**
+ * A universal ImageResponse class for generating images in API routes.
+ *
+ * Drop-in compatible with `next/og`'s `ImageResponse`. It supports React elements,
+ * custom fonts, Tailwind CSS (via `tw` prop), and various image formats.
+ *
+ * @example
+ * ```tsx
+ * import { ImageResponse } from "takumi-js/response";
+ *
+ * export function GET() {
+ *   return new ImageResponse(
+ *     <div tw="flex h-full w-full items-center justify-center bg-white">
+ *       <h1 tw="text-6xl font-bold">Hello World</h1>
+ *     </div>,
+ *     { width: 1200, height: 630 }
+ *   );
+ * }
+ * ```
+ *
+ * @param component - The JSX element to render.
+ * @param options - Rendering and response options.
+ */
 declare class ImageResponse extends Response {
   readonly ready: Promise<void>;
   constructor(component: ReactNode, options?: ImageResponseOptions);

package/dist/response.mjs

@@ -1,4 +1,4 @@
-import { t as render } from "./render-EhI8Ytcl.mjs";
+import { t as render } from "./render-M8h1fYtV.mjs";
 //#region src/response/index.ts
 function mergeOptions(defaultOptions, options) {
 	if (!defaultOptions) return options;
@@ -25,6 +25,26 @@ function defaultErrorHandler(error) {
 	console.error("Failed to render image.");
 	console.error(error);
 }
+/**
+* Creates a reusable ImageResponse factory with shared configuration.
+*
+* Use this to avoid repeating configuration like fonts, stylesheets, or cache headers
+* across multiple API routes.
+*
+* @example
+* ```tsx
+* const myImageResponse = createImageResponse({
+*   fonts: [{ name: "Inter", data: fontBuffer }],
+*   headers: { "Cache-Control": "public, max-age=31536000" }
+* });
+*
+* export function GET() {
+*   return myImageResponse(<div>Custom Og Image</div>);
+* }
+* ```
+*
+* @param defaultOptions - Options that will be applied to every response created by this factory.
+*/
 function createImageResponse(defaultOptions) {
 	return function imageResponse(element, options) {
 		const mergedOptions = mergeOptions(defaultOptions, options);
@@ -59,6 +79,29 @@ function createImageResponse(defaultOptions) {
 	};
 }
 let defaultImageResponse;
+/**
+* A universal ImageResponse class for generating images in API routes.
+*
+* Drop-in compatible with `next/og`'s `ImageResponse`. It supports React elements,
+* custom fonts, Tailwind CSS (via `tw` prop), and various image formats.
+*
+* @example
+* ```tsx
+* import { ImageResponse } from "takumi-js/response";
+*
+* export function GET() {
+*   return new ImageResponse(
+*     <div tw="flex h-full w-full items-center justify-center bg-white">
+*       <h1 tw="text-6xl font-bold">Hello World</h1>
+*     </div>,
+*     { width: 1200, height: 630 }
+*   );
+* }
+* ```
+*
+* @param component - The JSX element to render.
+* @param options - Rendering and response options.
+*/
 var ImageResponse = class extends Response {
 	ready;
 	constructor(component, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "takumi-js",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "All-in-one Takumi package for Node.js and WebAssembly runtimes.",
   "license": "(MIT OR Apache-2.0)",
   "author": {
@@ -69,9 +69,9 @@
     "test:bundlers": "bun test tests/bundlers.test.ts"
   },
   "dependencies": {
-    "@takumi-rs/core": "1.0.8",
-    "@takumi-rs/helpers": "1.0.8",
-    "@takumi-rs/wasm": "1.0.8"
+    "@takumi-rs/core": "1.0.10",
+    "@takumi-rs/helpers": "1.0.10",
+    "@takumi-rs/wasm": "1.0.10"
   },
   "devDependencies": {
     "@types/bun": "catalog:",