JavaScript で画像と PDF を作成する

各メソッドは、テンプレート ID とオプションのオブジェクトを受け取ります。オプションはすべて省略できます。

画像を作成する

createImage はテンプレートをレンダリングし、画像のバイト列を返します。

import { writeFile } from "node:fs/promises"

const { result, error } = await bannerify.createImage("tpl_xxx", {
  modifications: [
    { name: "headline", text: "Launch promo" },
    { name: "price", text: "$29" },
  ],
  format: "webp",
})

if (error) throw new Error(error.message)

await writeFile("launch-promo.webp", Buffer.from(result))

result は ArrayBuffer です。ブラウザやエッジランタイムでは、Response のボディとして返し、Content-Type ヘッダーに画像の種類を設定してください。

PDF を作成する

createPdf は、同じ templateId と modifications を受け取ります。format オプションはありません。

const { result, error } = await bannerify.createPdf("tpl_invoice", {
  modifications: [
    { name: "customer", text: "Acme Studio" },
    {
      name: "line-items",
      columns: ["Item", "Qty", "Total"],
      rows: [{ Item: "Automate plan", Qty: 1, Total: "$29.00" }],
    },
  ],
})

if (error) throw new Error(error.message)

await writeFile("invoice.pdf", Buffer.from(result))

保存済み画像を作成する

createStoredImage は、画像をレンダリングして保存し、バイト列の代わりに URL を返します。リンクをメール、データベースの行、ノーコードツールに入れたいときに使います。

createImage のオプションに加えて、s3Config を受け付けます。

const { result: url, error } = await bannerify.createStoredImage("tpl_xxx", {
  modifications: [{ name: "headline", text: "Welcome back" }],
})

if (error) throw new Error(error.message)

console.log(url)

S3Config には、次のフィールドがあります。

フィールド	必須	説明
endPoint	はい	プロトコルを含まない S3 エンドポイント
region	はい	バケットのリージョン
bucket	はい	バケット名
accessKey	はい	アクセスキー
secretKey	はい	シークレットキー
port	いいえ	エンドポイントのポート。既定値は 443
useSSL	いいえ	既定値は true
pathStyle	いいえ	パススタイルの URL を使う。既定値は false
customUrl	いいえ	返されるリンクの URL テンプレート。ファイルキーには {key} を使います

結果を処理する

3 つのメソッドは、いずれも { result } または { error } を返します。エラーを処理するを参照してください。