polotno-node 2.15.19 → 3.0.1

package/lib/types.d.ts

@@ -0,0 +1,76 @@
+import type { Browser, Page } from 'puppeteer';
+import type { DesignInput } from '@polotno/schema';
+export interface RenderOptions {
+    ignoreBackground?: boolean;
+    includeBleed?: boolean;
+    quality?: number;
+    pixelRatio?: number;
+    assetLoadTimeout?: number;
+    fontLoadTimeout?: number;
+    /** Use the legacy (pre polotno 4) rich text renderer */
+    legacyRichTextEnabled?: boolean;
+    /** Vertical text resize + align. On by default; set `false` to disable. */
+    textVerticalResizeEnabled?: boolean;
+    textSplitAllowed?: boolean;
+    textOverflow?: string;
+    skipFontError?: boolean;
+    skipImageError?: boolean;
+    mimeType?: string;
+    pageId?: string;
+    onProgress?: (progress: number) => void;
+    /** Path to save CPU profile (.cpuprofile) - loadable in Chrome DevTools */
+    profilePath?: string;
+}
+export interface PDFRenderOptions extends RenderOptions {
+    dpi?: number;
+    parallel?: number;
+    pageIds?: Array<string>;
+    unit?: 'pt' | 'mm' | 'cm' | 'in';
+    cropMarkSize?: number;
+}
+export interface VideoRenderOptions extends RenderOptions {
+    fps?: number;
+    onProgress?: (progress: number, frameTime?: number) => void;
+    /**
+     * When using the default local client (no `createInstance({ url })`), polotno-node will
+     * pre-download remote video/audio sources into a temp folder and rewrite them to `file://...`
+     * URLs for more reliable and faster loading. Set `skipDownloads: true` to disable that.
+     */
+    skipDownloads?: boolean;
+}
+export type RenderJSON = DesignInput;
+export interface BrowserOptions {
+    browserArgs?: string[];
+    headless?: 'new' | boolean;
+    protocolTimeout?: number;
+    ignoreHTTPSErrors?: boolean;
+    executablePath?: string;
+}
+export interface InstanceOptions {
+    key?: string;
+    url?: string;
+    useParallelPages?: boolean;
+    browserArgs?: string[];
+    browser?: Browser;
+    /** Intercept every page request (e.g. to block or rewrite asset loads). */
+    requestInterceptor?: (request: any) => void;
+    /** Cache Google Fonts responses for the process lifetime and serve them to every page (default: true) */
+    useFontCache?: boolean;
+}
+export interface PolotnoInstance {
+    close: () => Promise<void>;
+    firstPage: Page | null;
+    browser: Browser;
+    run: (func: (json: RenderJSON, options?: RenderOptions) => Promise<any>, ...args: any[]) => Promise<any>;
+    jsonToDataURL: (json: RenderJSON, options?: RenderOptions) => Promise<string>;
+    jsonToImageBase64: (json: RenderJSON, options?: RenderOptions) => Promise<string>;
+    jsonToPDFDataURL: (json: RenderJSON, options?: PDFRenderOptions) => Promise<string>;
+    jsonToPDFBase64: (json: RenderJSON, options?: PDFRenderOptions) => Promise<string>;
+    jsonToBlob: (json: RenderJSON, options?: RenderOptions) => Promise<Buffer>;
+    jsonToGIFDataURL: (json: RenderJSON, options?: RenderOptions) => Promise<string>;
+    jsonToGIFBase64: (json: RenderJSON, options?: RenderOptions) => Promise<string>;
+    jsonToVideoDataURL: (json: RenderJSON, options?: VideoRenderOptions) => Promise<string>;
+    jsonToVideoBase64: (json: RenderJSON, options?: VideoRenderOptions) => Promise<string>;
+    jsonToVideoFile: (json: RenderJSON, outputPath: string, options?: VideoRenderOptions) => Promise<string>;
+    createPage: () => Promise<Page>;
+}

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,50 +1,62 @@
 {
   "name": "polotno-node",
-  "version": "2.15.19",
+  "version": "3.0.1",
   "description": "Polotno workflow from NodeJS",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "scripts": {
-    "postinstall": "test -d .git && patch-package || true",
-    "test": "npm run build && vitest run test/static/static.test.mjs",
-    "test:video": "npm run build && vitest run test/video/video.test.mjs",
-    "test:all": "npm run build && vitest run test/static/static.test.mjs test/video/video.test.mjs",
-    "build": "rm -rf ./dist && npx vite build ./client/ --base=./ --outDir ../dist --emptyOutDir --logLevel error",
-    "dev": "vite ./client.html"
+  "license": "SEE LICENSE IN LICENSE.md",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./instance": {
+      "types": "./lib/instance.d.ts",
+      "import": "./lib/instance.js",
+      "default": "./lib/instance.js"
+    }
   },
   "files": [
+    "lib",
     "dist",
-    "index.js",
-    "index.d.ts",
-    "instance.js",
-    "video-parallel.js",
-    "README.md"
+    "README.md",
+    "LICENSE.md"
   ],
   "browserslist": "> 0.5%, last 2 versions, not dead",
   "devDependencies": {
-    "@polotno/video-export": "^0.0.11",
-    "axios": "^1.16.1",
+    "@types/node": "^25.9.2",
+    "mediabunny": "^1.47.0",
+    "axios": "^1.18.0",
     "dotenv": "^17.4.2",
     "fluent-ffmpeg": "^2.1.3",
     "jspdf": "^4.2.1",
-    "patch-package": "^8.0.1",
+    "konva": "^10.3.0",
     "pixelmatch": "^7.2.0",
     "pngjs": "^7.0.0",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "vite": "^8.0.13",
-    "vitest": "^4.1.6",
-    "web-audio-api": "^1.5.1"
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "tmp": "^0.2.7",
+    "typescript": "~6.0.3",
+    "vite": "^8.0.16",
+    "vitest": "^4.1.9",
+    "web-audio-api": "^1.5.1",
+    "polotno": "4.2.1",
+    "@polotno/video-export": "0.1.0"
+  },
+  "overrides": {
+    "@polotno/video-export": {
+      "polotno": "$polotno",
+      "mediabunny": "$mediabunny"
+    }
   },
   "author": "Anton Lavrenov",
-  "license": "MIT",
   "dependencies": {
-    "@sparticuz/chromium": "^148.0.0",
-    "mediabunny": "1.27.3",
-    "polotno": "^2.41.0",
-    "puppeteer": "25.0.2",
-    "puppeteer-core": "25.0.2",
-    "tmp": "^0.2.5"
+    "@sparticuz/chromium": "^149.0.0",
+    "puppeteer": "25.1.0",
+    "puppeteer-core": "25.1.0",
+    "@polotno/schema": "0.1.5"
   },
   "bugs": {
     "url": "https://github.com/polotno-project/polotno-node/issues"
@@ -54,5 +66,13 @@
   "repository": {
     "type": "git",
     "url": "git@github.com:polotno-project/polotno-node.git"
+  },
+  "scripts": {
+    "build": "rm -rf ./lib ./dist && tsc -p tsconfig.json && vite build ./client/ --base=./ --outDir ../dist --emptyOutDir --logLevel error",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "pnpm run build && vitest run test/static/static.test.mjs",
+    "test:video": "pnpm run build && vitest run test/video/video.test.mjs",
+    "test:all": "pnpm run build && vitest run test/static/static.test.mjs test/video/video.test.mjs",
+    "dev": "vite ./client.html"
   }
-}
+}