@oomol-lab/open-flow 0.1.0-beta.81 → 0.1.0-beta.83

package/README.md

@@ -13,6 +13,41 @@ same singleton share catalog requests, freshness and validation; no Provider pro
 A Shadow DOM host must load the stylesheet inside its shadow root before mounting the component;
 Vite hosts can import `@oomol-lab/open-flow/preview.css?url` for the stylesheet URL.
 
+## Node PNG rendering
+
+On Node.js 20+, install the optional `playwright-core` peer and supply your own
+Chromium Browser. Prepare the browser executable, its system libraries and required
+Chinese fonts yourself. The renderer reuses the Workbench PNG implementation and
+ships its own rendering resources; it does not require a running Workbench service.
+
+```ts
+import { readFile, writeFile } from 'node:fs/promises'
+import { chromium } from 'playwright-core'
+import { flowToPng } from '@oomol-lab/open-flow/render'
+
+const browser = await chromium.launch({ executablePath: process.env.CHROMIUM_EXECUTABLE_PATH })
+try {
+  const workflow = JSON.parse(await readFile('workflow.openflow.json', 'utf8'))
+  const result = await flowToPng(browser, workflow, { language: 'zh-CN', dark: true, frame: true })
+  await writeFile('workflow.png', result.buffer)
+} finally {
+  await browser.close()
+}
+```
+
+Pass a parsed `.openflow.json` object. Options default to English, light mode and
+no frame; `title` overrides the file name shown in the frame. The result also
+provides `width`, `height` and `hasImagePlaceholders`. Image scale and allocation
+retries adapt automatically. Each call closes its own Context, leaving your Browser
+available for reuse. It validates the file without modifying it or executing nodes.
+
+Network access is allowed by default, including requests to private endpoints.
+Set `allowNetwork: false` when rendering untrusted files to block requests in the
+renderer's Context. Bundled rendering resources remain available. The exporter sets
+`hasImagePlaceholders` to `true` when it substitutes an image placeholder. Remote
+node icons may instead use a component fallback or be omitted without setting this
+flag. A `false` value does not guarantee that every remote image loaded.
+
 Install the Task contracts as a development dependency:
 
 ```bash