polotno-node 2.15.19 → 3.0.1

package/LICENSE.md

@@ -0,0 +1,10 @@
+Polotno SDK License
+
+Copyright (c) 2014–present Anton Lavrenov.
+
+This package is part of the Polotno SDK. It is not open source. Use in
+production requires a valid Polotno subscription.
+
+Full license terms: https://polotno.com/legal/license
+
+The software is provided "as is", without warranty of any kind.

package/README.md

@@ -15,8 +15,8 @@ npm install polotno-node
 ```
 
 ```js
-const fs = require('fs');
-const { createInstance } = require('polotno-node');
+import fs from 'fs';
+import { createInstance } from 'polotno-node';
 
 async function run() {
   // create working instance
@@ -47,7 +47,7 @@ run();
 Create working instance of Polotno Node.
 
 ```js
-const { createInstance } = require('polotno-node');
+import { createInstance } from 'polotno-node';
 const instance = await createInstance({
   // this is a demo key just for that project
   // (!) please don't use it in your projects
@@ -71,6 +71,14 @@ const instance = await createInstance({
   // see "Custom Browser Arguments" section for more details
   browserArgs: ['--custom-arg'],
 
+  // 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
+  // re-downloads the same fonts and bursts of parallel renders may get
+  // throttled by Google Fonts (fonts time out and text falls back to a
+  // default font). Default is true.
+  useFontCache: true,
+
   // requestInterceptor - optional function to intercept and modify network requests
   // Useful when you need to:
   // - Modify headers like User-Agent to access protected image resources
@@ -98,7 +106,7 @@ const instance = await createInstance({
 Create a Puppeteer browser instance with optimized settings for Polotno rendering. This is useful when you want to create a browser separately from the instance.
 
 ```js
-const { createBrowser, createInstance } = require('polotno-node');
+import { createBrowser, createInstance } from 'polotno-node';
 
 // Create a browser
 const browser = await createBrowser({
@@ -283,39 +291,23 @@ Timeout for loading fonts. By default it is 6000ms.
 const url = await instance.jsonToPDFDataURL(json, { fontLoadTimeout: 10000 });
 ```
 
-### `attrs.richTextEnabled`
+### `attrs.legacyRichTextEnabled`
 
-Enable rich text renderin. By default it is `false`.
+Use the legacy (pre polotno 4) rich text renderer. By default it is `false` — the new text rendering engine is always on.
 
 ```js
 const url = await instance.jsonToPDFDataURL(json, {
-  richTextEnabled: true,
-});
-```
-
-### `attrs.htmlTextRenderEnabled` (deprecated)
-
-⚠️ **Deprecated:** Use `richTextEnabled` instead. This property is maintained for backward compatibility and works as a fallback.
-
-```js
-// Old (deprecated)
-const url = await instance.jsonToPDFDataURL(json, {
-  htmlTextRenderEnabled: true,
-});
-
-// New (recommended)
-const url = await instance.jsonToPDFDataURL(json, {
-  richTextEnabled: true,
+  legacyRichTextEnabled: true,
 });
 ```
 
 ### `attrs.textVerticalResizeEnabled`
 
-Enabled vertical text resize and align. By default it is `false`.
+Vertical text resize and align. **On by default** — pass `false` to disable it.
 
 ```js
 const url = await instance.jsonToPDFDataURL(json, {
-  textVerticalResizeEnabled: true,
+  textVerticalResizeEnabled: false,
 });
 ```
 
@@ -409,7 +401,7 @@ const url = await instance.run(async (json) => {
 `polotno-node` exports a carefully curated set of Chrome arguments (`args`) that are optimized for server-side rendering. These arguments are automatically used when you call `createInstance()` without providing your own browser.
 
 ```js
-const { args } = require('polotno-node');
+import { args } from 'polotno-node';
 
 console.log(args);
 // Will show the default arguments like:
@@ -423,9 +415,9 @@ console.log(args);
 When you want to use your own browser instance (e.g., with browserless.io or custom puppeteer configuration), you should combine `chrome.args` (the base defaults) with polotno-node's `args` (additional optimizations):
 
 ```js
-const { createInstance, args } = require('polotno-node');
-const chromium = require('@sparticuz/chromium');
-const puppeteer = require('puppeteer-core');
+import { createInstance, args } from 'polotno-node';
+import chromium from '@sparticuz/chromium';
+import puppeteer from 'puppeteer-core';
 
 // Combine chrome.args (base defaults) with polotno-node's args (optimizations)
 // This works best on Linux/macOS
@@ -450,9 +442,9 @@ const instance = await createInstance({
 If you need to add, remove, or replace specific arguments (Linux/macOS):
 
 ```js
-const { createInstance, args } = require('polotno-node');
-const chromium = require('@sparticuz/chromium');
-const puppeteer = require('puppeteer-core');
+import { createInstance, args } from 'polotno-node';
+import chromium from '@sparticuz/chromium';
+import puppeteer from 'puppeteer-core';
 
 // Add custom arguments on top of chrome.args and polotno args
 const browser = await puppeteer.launch({
@@ -487,7 +479,7 @@ const browser3 = await puppeteer.launch({
 When using `createInstance()` or `createBrowser()`, you can provide additional arguments via `browserArgs` option. Internally, this automatically combines `chrome.args` + `args` + your custom `browserArgs`:
 
 ```js
-const { createInstance } = require('polotno-node');
+import { createInstance } from 'polotno-node';
 
 const instance = await createInstance({
   key: 'your-key',
@@ -507,7 +499,7 @@ Pass `url` option to `createInstance` function with public url of your client ed
 **Note: you will have to maintain the last version of your client editor by yourself. Better to keep using the last **
 
 ```js
-const { createInstance } = require('polotno-node');
+import { createInstance } from 'polotno-node';
 
 const instance = await createInstance({
   key: 'KEY',
@@ -522,7 +514,7 @@ const instance = await createInstance({
 `polotno-node` works with AWS Lambda out of the box. Here's a simple example:
 
 ```js
-const { createInstance } = require('polotno-node');
+import { createInstance } from 'polotno-node';
 
 export const handler = async (event) => {
   const instance = await createInstance({
@@ -690,8 +682,8 @@ Using browserless.io you can also make your function much smaller in size, so it
 
 ```js
 // (!) loading from polotno-node/instance will not import puppeteer and chromium-min dependencies
-const { createInstance } = require('polotno-node/instance');
-const puppeteer = require('puppeteer');
+import { createInstance } from 'polotno-node/instance';
+import puppeteer from 'puppeteer';
 
 const instance = await createInstance({
   key: 'nFA5H9elEytDyPyvKL7T',
@@ -711,11 +703,11 @@ npm install @sparticuz/chromium-min
 ```
 
 ```js
-const { createInstance } = require('polotno-node/instance');
+import { createInstance } from 'polotno-node/instance';
 // Import args from main entry point for optimal browser configuration
-const { args } = require('polotno-node');
-const chromium = require('@sparticuz/chromium-min');
-const puppeteer = require('puppeteer-core');
+import { args } from 'polotno-node';
+import chromium from '@sparticuz/chromium-min';
+import puppeteer from 'puppeteer-core';
 
 const makeInstance = async () => {
   const browser = await puppeteer.launch({