polotno-node 3.4.0 → 3.6.0

package/README.md

@@ -75,6 +75,11 @@ const instance = await createInstance({
   // e.g. the Chrome installed in your container. Ignored if you pass `browser`.
   executablePath: '/usr/bin/google-chrome-stable',
 
+  // headless - which headless mode to launch. By default, where we pick the
+  // browser ourselves, that is puppeteer's `chrome-headless-shell`; set `true`
+  // for full Chrome. Ignored if you pass `browser`.
+  headless: true,
+
   // useFontCache - cache Google Fonts responses (in memory + on disk in the
   // OS temp folder, shared across processes) and serve them to every page.
   // Every page starts with an empty HTTP cache, so without it each render
@@ -265,7 +270,7 @@ By default, when exporting video and **only** when using the default local clien
 - Deduplicate downloads (same URL is downloaded once)
 - Probe downloaded remote videos with `ffprobe`
 - Conditionally normalize incompatible downloaded videos into MP4 with H.264 video, `yuv420p`, and AAC audio for better Chromium render compatibility
-- Rewrite `src` to `file://...` URLs so Chromium loads media from disk
+- Rewrite `src` to a URL that `polotno-node` answers from the temporary folder
 
 For best compatibility, use MP4 with H.264 (`yuv420p`) video and AAC audio.
 
@@ -279,6 +284,12 @@ const url = await instance.jsonToVideoDataURL(json, {
 
 When `skipDownloads` is enabled, `polotno-node` will skip both remote-media downloading and the conditional video preprocessing described above.
 
+### Local files
+
+A `file:` source anywhere in a design — an image, an SVG, a video, an audio track, a font — is read by `polotno-node` and handed to the renderer, in every export format. `skipDownloads` does not affect this; it controls **remote** media only.
+
+Because the bytes come from Node, a browser running somewhere else (`browser: await puppeteer.connect(...)`, browserless) can render a design that names files on this machine.
+
 ### Restricted media hosts
 
 Server-side downloads block cloud-metadata addresses (e.g. `169.254.169.254`) by default. Normal URLs, `localhost`, and private hosts still work. To restrict further: