@takumi-rs/core 1.0.0-beta.12 → 1.0.0-beta.14

package/export.d.ts

@@ -1 +1,220 @@
-export * from "./index";
+import type { Node } from "@takumi-rs/helpers";
+
+export type { ContainerNode, ImageNode, NodeMetadata, TextNode } from "@takumi-rs/helpers";
+
+export type { Node };
+
+export interface FontDetails {
+  /**
+   * The name of the font. If not provided, the name in the font file will be used.
+   */
+  name?: string;
+  /**
+   * The font data.
+   */
+  data: Uint8Array | ArrayBuffer;
+  /**
+   * The weight of the font. If not provided, the weight in the font file will be used.
+   */
+  weight?: number;
+  /**
+   * The style of the font. If not provided, the style in the font file will be used.
+   */
+  style?: "normal" | "italic" | "oblique" | `oblique ${number}deg` | (string & {});
+}
+
+export type Font = FontDetails | Uint8Array | ArrayBuffer;
+
+export type Keyframes = Record<string, Record<string, Record<string, unknown>>>;
+/** The main renderer for Takumi image rendering engine (Node.js version). */
+export declare class Renderer {
+  /** Creates a new Renderer instance. */
+  constructor(options?: ConstructRendererOptions | undefined | null)
+  /** Puts a persistent image into the renderer's internal store asynchronously. */
+  putPersistentImage(source: ImageSource, signal?: AbortSignal): Promise<void>
+  /** Loads a font synchronously. */
+  loadFontSync(font: Font): void
+  /** Loads a font into the renderer asynchronously. */
+  loadFont(data: Font, signal?: AbortSignal): Promise<number>
+  /** Loads multiple fonts into the renderer asynchronously. */
+  loadFonts(fonts: Font[], signal?: AbortSignal): Promise<number>
+  /** Clears the renderer's internal image store. */
+  clearImageStore(): void
+  /** Renders a node tree into an image buffer asynchronously. */
+  render(source: Node, options?: RenderOptions, signal?: AbortSignal): Promise<Buffer>
+  /** Measures a node tree and returns layout information asynchronously. */
+  measure(source: Node, options?: RenderOptions, signal?: AbortSignal): Promise<MeasuredNode>
+  /** Renders a sequential scene animation into a buffer asynchronously. */
+  renderAnimation(options: RenderAnimationOptions, signal?: AbortSignal): Promise<Buffer>
+  /** Encodes a precomputed frame sequence into an animated image buffer asynchronously. */
+  encodeFrames(source: AnimationFrameSource[], options: EncodeFramesOptions, signal?: AbortSignal): Promise<Buffer>
+}
+
+/** Represents a single frame in a precomputed animation sequence. */
+export interface AnimationFrameSource {
+  /** The node tree to render for this frame. */
+  node: Node
+  /** The duration of this frame in milliseconds. */
+  durationMs: number
+}
+
+/** Output format for animated images. */
+export type AnimationOutputFormat = /** Animated WebP format. */
+'webp'|
+/** Animated PNG format. */
+'apng'|
+/** Animated GIF format. */
+'gif';
+
+/** Represents a single scene in a sequential animation timeline. */
+export interface AnimationSceneSource {
+  /** The node tree to render for this scene. */
+  node: Node
+  /** The duration of this scene in milliseconds. */
+  durationMs: number
+}
+
+/** Options for constructing a Renderer instance. */
+export interface ConstructRendererOptions {
+  /** The images that needs to be preloaded into the renderer. */
+  persistentImages?: Array<ImageSource>
+  /** The fonts being used. */
+  fonts?: Font[] | undefined
+  /**
+   * Whether to load the default fonts.
+   * If `fonts` are provided, this will be `false` by default.
+   */
+  loadDefaultFonts?: boolean
+}
+
+export type DitheringAlgorithm =  'none'|
+'ordered-bayer'|
+'floyd-steinberg';
+
+/** Options for encoding a precomputed frame sequence. */
+export interface EncodeFramesOptions {
+  /** Whether to draw debug borders around layout elements. */
+  drawDebugBorder?: boolean
+  /** The width of each frame in pixels. */
+  width: number
+  /** The height of each frame in pixels. */
+  height: number
+  /** The output animation format (WebP, APNG, or GIF). */
+  format?: AnimationOutputFormat
+  /** The quality of WebP format (0-100). Ignored for APNG and GIF. */
+  quality?: number
+  /** The fetched resources to use. */
+  fetchedResources?: Array<ImageSource>
+  /** CSS stylesheets to apply before rendering. */
+  stylesheets?: Array<string>
+  /**
+   * The device pixel ratio.
+   * @default 1.0
+   */
+  devicePixelRatio?: number
+}
+
+/** Collects the fetch task urls from the node. */
+export declare function extractResourceUrls(node: Node): Array<string>
+
+/** An image source with its URL and raw data. */
+export interface ImageSource {
+  /** The source URL of the image. */
+  src: string
+  /** The raw image data (Uint8Array or ArrayBuffer). */
+  data: Uint8Array | ArrayBuffer
+}
+
+/** Represents a node that has been measured, including its layout information. */
+export interface MeasuredNode {
+  /** The measured width of the node. */
+  width: number
+  /** The measured height of the node. */
+  height: number
+  /** The transformation matrix of the node. */
+  transform: [number, number, number, number, number, number]
+  /** The children of the node. */
+  children: Array<MeasuredNode>
+  /** The text runs within the node. */
+  runs: Array<MeasuredTextRun>
+}
+
+/** Represents a single run of text in a measured node. */
+export interface MeasuredTextRun {
+  /** The text content of the run. */
+  text: string
+  /** The inline x-coordinate of the run. */
+  x: number
+  /** The inline y-coordinate of the run. */
+  y: number
+  /** The width of the run. */
+  width: number
+  /** The height of the run. */
+  height: number
+}
+
+/** Output format for static images. */
+export type OutputFormat = /** WebP format. */
+'webp'|
+/** PNG format. */
+'png'|
+/** JPEG format. */
+'jpeg'|
+/** Raw pixels format. */
+'raw';
+
+/** Options for rendering a sequential scene animation. */
+export interface RenderAnimationOptions {
+  /** The scenes to render sequentially. */
+  scenes: Array<AnimationSceneSource>
+  /** Whether to draw debug borders around layout elements. */
+  drawDebugBorder?: boolean
+  /** The width of each frame in pixels. */
+  width: number
+  /** The height of each frame in pixels. */
+  height: number
+  /** The output animation format (WebP, APNG, or GIF). */
+  format?: AnimationOutputFormat
+  /** The quality of WebP format (0-100). Ignored for APNG and GIF. */
+  quality?: number
+  /** Frames per second for timeline sampling. */
+  fps: number
+  /** The fetched resources to use. */
+  fetchedResources?: Array<ImageSource>
+  /** CSS stylesheets to apply before rendering. */
+  stylesheets?: Array<string>
+  /**
+   * The device pixel ratio.
+   * @default 1.0
+   */
+  devicePixelRatio?: number
+}
+
+/** Options for rendering an image. */
+export interface RenderOptions {
+  /** The width of the image. If not provided, the width will be automatically calculated based on the content. */
+  width?: number
+  /** The height of the image. If not provided, the height will be automatically calculated based on the content. */
+  height?: number
+  /** The format of the image. */
+  format?: OutputFormat
+  /** The quality of JPEG format (0-100). */
+  quality?: number
+  /** Whether to draw debug borders. */
+  drawDebugBorder?: boolean
+  /** The fetched resources to use. */
+  fetchedResources?: Array<ImageSource>
+  /** CSS stylesheets to apply before rendering. */
+  stylesheets?: Array<string>
+  /** Structured keyframes to register alongside stylesheets. */
+  keyframes?: { name: string; keyframes: { offsets: number[]; declarations: Record<string, unknown> }[] }[] | Keyframes
+  /**
+   * The device pixel ratio.
+   * @default 1.0
+   */
+  devicePixelRatio?: number
+  /** The animation timeline time in milliseconds. */
+  timeMs?: number
+  /** The output dithering algorithm. */
+  dithering?: DitheringAlgorithm
+}

package/export.mjs

@@ -62,9 +62,13 @@ function loadNativeModule() {
 const nativeModule = loadNativeModule();
 
 if (!nativeModule) {
-  throw new Error(
-    "@takumi-rs/core is only available in Node.js runtimes. Use @takumi-rs/wasm or a higher-level package that falls back to WASM automatically.",
-  );
+  if (process.env.NEXT_RUNTIME === "nodejs") {
+    throw new Error(
+      "Native module is not being included in the bundle, add `outputFileTracingIncludes` to your Next.js configuration with `node_modules/@takumi-rs/core-*/*`.",
+    );
+  }
+
+  throw new Error("Unable to load native module, make sure your bundler has included it.");
 }
 
 const { Renderer, extractResourceUrls } = nativeModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takumi-rs/core",
-  "version": "1.0.0-beta.12",
+  "version": "1.0.0-beta.14",
   "keywords": [
     "css",
     "image",
@@ -40,12 +40,12 @@
   },
   "scripts": {
     "build": "napi build --release --no-const-enum --platform --esm --strip",
-    "prepublishOnly": "jq '.dependencies[\"@takumi-rs/helpers\"] = .version' package.json > tmp.json && mv tmp.json package.json && bun artifacts && napi prepublish -t npm --no-gh-release",
+    "prepublishOnly": "jq '.dependencies[\"@takumi-rs/helpers\"] = .version' package.json > tmp.json && mv tmp.json package.json && bun artifacts && cp artifacts/bindings-x86_64-unknown-linux-gnu/index.d.ts export.d.ts && napi prepublish -t npm --no-gh-release",
     "artifacts": "napi create-npm-dirs && napi artifacts && napi version",
     "bench": "bun tests/bench/index.tsx"
   },
   "dependencies": {
-    "@takumi-rs/helpers": "1.0.0-beta.12"
+    "@takumi-rs/helpers": "1.0.0-beta.14"
   },
   "devDependencies": {
     "@napi-rs/cli": "3.5.1",
@@ -75,13 +75,13 @@
     "node": ">= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0"
   },
   "optionalDependencies": {
-    "@takumi-rs/core-darwin-x64": "1.0.0-beta.12",
-    "@takumi-rs/core-darwin-arm64": "1.0.0-beta.12",
-    "@takumi-rs/core-linux-arm64-gnu": "1.0.0-beta.12",
-    "@takumi-rs/core-linux-arm64-musl": "1.0.0-beta.12",
-    "@takumi-rs/core-win32-arm64-msvc": "1.0.0-beta.12",
-    "@takumi-rs/core-linux-x64-gnu": "1.0.0-beta.12",
-    "@takumi-rs/core-linux-x64-musl": "1.0.0-beta.12",
-    "@takumi-rs/core-win32-x64-msvc": "1.0.0-beta.12"
+    "@takumi-rs/core-darwin-x64": "1.0.0-beta.14",
+    "@takumi-rs/core-darwin-arm64": "1.0.0-beta.14",
+    "@takumi-rs/core-linux-arm64-gnu": "1.0.0-beta.14",
+    "@takumi-rs/core-linux-arm64-musl": "1.0.0-beta.14",
+    "@takumi-rs/core-win32-arm64-msvc": "1.0.0-beta.14",
+    "@takumi-rs/core-linux-x64-gnu": "1.0.0-beta.14",
+    "@takumi-rs/core-linux-x64-musl": "1.0.0-beta.14",
+    "@takumi-rs/core-win32-x64-msvc": "1.0.0-beta.14"
   }
 }