@json-render/react-pdf

@react-pdf/rendererを使用してJSON仕様からPDFドキュメントを生成するReact PDFレンダラーです。

インストール

npm install @json-render/core @json-render/react-pdf

クイックスタート

import { renderToBuffer } from "@json-render/react-pdf";
import type { Spec } from "@json-render/core";

const spec: Spec = {
  root: "doc",
  elements: {
    doc: { type: "Document", props: { title: "Invoice" }, children: ["page"] },
    page: {
      type: "Page",
      props: { size: "A4" },
      children: ["heading", "table"],
    },
    heading: {
      type: "Heading",
      props: { text: "Invoice #1234", level: "h1" },
      children: [],
    },
    table: {
      type: "Table",
      props: {
        columns: [
          { header: "Item", width: "60%" },
          { header: "Price", width: "40%", align: "right" },
        ],
        rows: [
          ["Widget A", "$10.00"],
          ["Widget B", "$25.00"],
        ],
      },
      children: [],
    },
  },
};

const buffer = await renderToBuffer(spec);

レンダリングAPI

import { renderToBuffer, renderToStream, renderToFile } from "@json-render/react-pdf";

// メモリ内バッファ
const buffer = await renderToBuffer(spec);

// 読み込み可能なストリーム (HTTPレスポンスにパイプ)
const stream = await renderToStream(spec);
stream.pipe(res);

// 直接ファイルに出力
await renderToFile(spec, "./output.pdf");

すべてのレンダリング関数は、オプションの第2引数 { registry?, state?, handlers? } を受け付けます。

標準コンポーネント

コンポーネント	説明
Document	トップレベルのPDFラッパー（ルートである必要があります）
Page	サイズ（A4、LETTER）、向き、余白を指定するページ
View	汎用コンテナ（パディング、マージン、背景、枠線）
Row, Column	ギャップ、配置、正当化を持つFlexレイアウト
Heading	h1-h4見出しテキスト
Text	本文テキスト（フォントサイズ、色、太さ、配置）
Image	URLまたはbase64からの画像
Link	テキストとhrefを持つハイパーリンク
Table	型付きカラムと行を持つデータテーブル
List	順序付きまたは順序なしリスト
Divider	水平線区切り
Spacer	空の縦スペース
PageNumber	現在のページ番号と総ページ数

カスタムカタログ

import { defineCatalog } from "@json-render/core";
import { schema, defineRegistry, renderToBuffer } from "@json-render/react-pdf";
import { standardComponentDefinitions } from "@json-render/react-pdf/catalog";
import { z } from "zod";

const catalog = defineCatalog(schema, {
  components: {
    ...standardComponentDefinitions,
    Badge: {
      props: z.object({ label: z.string(), color: z.string().nullable() }),
      slots: [],
      description: "A colored badge label",
    },
  },
  actions: {},
});

const { registry } = defineRegistry(catalog, {
  components: {
    Badge: ({ props }) => (
      <View style={{ backgroundColor: props.color ?? "#e5e7eb", padding: 4 }}>
        <Text>{props.label}</Text>
      </View>
    ),
  },
});

const buffer = await renderToBuffer(spec, { registry });

外部ストア（制御モード）

StateStoreを渡して状態を完全に制御します：

import { createStateStore } from "@json-render/react-pdf";

const store = createStateStore({ invoice: { total: 100 } });
store.set("/invoice/total", 200);

サーバー安全なインポート

Reactを引き込まずにスキーマとカタログをインポートします：

import { schema, standardComponentDefinitions } from "@json-render/react-pdf/server";