polotno-node 3.1.3 → 3.3.0

package/lib/index.js

@@ -1,121 +1,43 @@
 import puppeteerCore from 'puppeteer-core';
-import sparticuz from '@sparticuz/chromium';
 import os from 'os';
 import { createInstance as createInstanceImpl } from './instance.js';
-// TODO: that is a weird hack, but it works
-const chrome = sparticuz.default || sparticuz;
-const isMacOs = os.platform() === 'darwin';
-const isWindows = os.platform() === 'win32';
-// On non-Linux platforms use full puppeteer (bundles its own Chromium) instead
-// of @sparticuz/chromium. ESM imports are immutable, so resolve the variant via
-// a dynamic import. `puppeteer` is an optional peer on Linux servers, so the
-// import only runs where it's expected to be installed.
+import { BUNDLED_CHROMIUM_PLATFORM, resolveBrowserArgs, resolveExecutablePath, } from './launch-options.js';
+export { args } from './launch-options.js';
+// Off the bundled chromium's platform, use full puppeteer — it brings its own
+// Chromium. ESM imports are immutable, so resolve the variant via a dynamic
+// import. `puppeteer` is an optional peer on Linux servers, so the import only
+// runs where it's expected to be installed.
 let puppeteer = puppeteerCore;
-if (isMacOs || isWindows) {
+if (os.platform() !== BUNDLED_CHROMIUM_PLATFORM) {
     puppeteer = (await import('puppeteer')).default;
 }
-export const args = [
-    'about:blank',
-    '--disable-web-security',
-    '--allow-file-access-from-files',
-    '--allow-pre-commit-input',
-    '--autoplay-policy=user-gesture-required',
-    '--disable-background-networking',
-    '--disable-background-timer-throttling',
-    '--disable-backgrounding-occluded-windows',
-    '--disable-breakpad',
-    '--disable-component-extensions-with-background-pages',
-    '--disable-client-side-phishing-detection',
-    '--disable-component-update',
-    '--disable-default-apps',
-    '--disable-dev-shm-usage',
-    '--proxy-server=direct://',
-    '--proxy-bypass-list=*',
-    '--disable-domain-reliability',
-    '--disable-features=AudioServiceOutOfProcess,IsolateOrigins,site-per-process,Translate,BackForwardCache,AvoidUnnecessaryBeforeUnloadCheckSync,IntensiveWakeUpThrottling',
-    '--disable-extensions',
-    '--disable-hang-monitor',
-    '--disable-ipc-flooding-protection',
-    '--disable-notifications',
-    '--disable-offer-store-unmasked-wallet-cards',
-    '--disable-popup-blocking',
-    '--disable-print-preview',
-    '--disable-site-isolation-trials',
-    '--disable-prompt-on-repost',
-    '--disable-renderer-backgrounding',
-    '--disable-setuid-sandbox',
-    '--disable-speech-api',
-    '--disable-sync',
-    // Use srgb for identical output across Linux/macOS/Windows and to match how CSS colors/images are defined/assumed on the web.
-    '--force-color-profile=srgb',
-    '--hide-scrollbars',
-    '--metrics-recording-only',
-    '--mute-audio',
-    '--no-default-browser-check',
-    '--no-first-run',
-    '--enable-automation',
-    '--no-pings',
-    '--no-sandbox',
-    '--no-zygote',
-    '--password-store=basic',
-    '--allow-running-insecure-content',
-    // Disable accessibility features to reduce resource usage and improve performance.
-    '--disable-renderer-accessibility',
-    // stable locale → font fallback/hyphenation
-    '--lang=en-US',
-    // this line  breaks the rendering on most of OS
-    // it doesn't allow creating of pages
-    //'--use-gl=swiftshader',
-    '--disable-gpu',
-    '--use-mock-keychain',
-    '--enable-blink-features=IdleDetection',
-    '--intensive-wake-up-throttling-policy=0',
-    '--font-render-hinting=none',
-    '--ignore-gpu-blocklist',
-    // don't use this flag, because it makes renderign less accurate
-    // see https://community.polotno.com/c/ask/the-ability-to-exclude-args-from-minimal_args-in-polotno-node
-    // '--disable-font-subpixel-positioning',
-    '--text-rendering=geometricprecision',
-].filter(Boolean);
-/**
- * Merge browser argument arrays, deduping by flag name (the part before `=`).
- * Later arrays take precedence on conflict.
- */
-function mergeArgs(...argArrays) {
-    const argMap = new Map();
-    for (const argArray of argArrays) {
-        for (const arg of argArray) {
-            const flagMatch = arg.match(/^(--[^=]+)/);
-            const flagName = flagMatch ? flagMatch[1] : arg;
-            argMap.set(flagName, arg);
-        }
-    }
-    return Array.from(argMap.values());
-}
 const browserProps = {
-    headless: 'new',
+    headless: true,
     // make large timeout, because some renders may take a lot of time
     // like large PDF or video render
     protocolTimeout: 60 * 60 * 1000,
     ignoreHTTPSErrors: true,
 };
-export async function createBrowser({ browserArgs = [], ...rest } = {}) {
+export async function createBrowser(options = {}) {
+    // Both are resolved below, so neither may also reach the spread — a caller
+    // forwarding an unset env var (`executablePath:
+    // process.env.PUPPETEER_EXECUTABLE_PATH`) would overwrite the resolved path
+    // with `undefined` and leave puppeteer-core with no browser at all.
+    const { browserArgs, executablePath, ...rest } = options;
     return puppeteer.launch({
-        args: mergeArgs(isWindows ? [] : chrome.args, args, browserArgs),
-        defaultViewport: chrome.defaultViewport,
-        executablePath: isMacOs || isWindows ? undefined : await chrome.executablePath(),
+        args: resolveBrowserArgs(options),
+        executablePath: await resolveExecutablePath(options),
         ...browserProps,
         ...rest,
     });
 }
-export const createInstance = async ({ key, url, useParallelPages, browserArgs = [], browser, requestInterceptor, useFontCache, } = {}) => {
+export const createInstance = async (options = {}) => {
+    // Named here only because they shape the browser; everything else is passed
+    // straight through. Relisting each option by name is how `navigationTimeout`
+    // came to be declared, honoured downstream, and silently dropped in between.
+    const { browser, executablePath, browserArgs, ...rest } = options;
     return await createInstanceImpl({
-        browser: browser || (await createBrowser({ browserArgs })),
-        key,
-        url,
-        useParallelPages,
-        browserArgs,
-        requestInterceptor,
-        useFontCache,
+        ...rest,
+        browser: browser || (await createBrowser({ browserArgs, executablePath })),
     });
 };

package/lib/instance.d.ts

@@ -1,3 +1,4 @@
+import { type FetchPolicy } from './ssrf-guard.js';
 declare global {
     interface Window {
         config?: any;
@@ -9,19 +10,24 @@ declare global {
         __polotnoWriteChunk?: (chunk: string) => void;
     }
 }
-export declare const createPage: (browser: any, url: any, requestInterceptor: any, useFontCache?: boolean) => Promise<any>;
+export declare const guessExtension: (contentType: any, kind: any) => any;
+export declare const prepareLocalMediaForVideoExport: (json: any, policy?: FetchPolicy) => Promise<{
+    json: any;
+    cleanup: () => Promise<void>;
+}>;
+export declare const createPage: (browser: any, url: any, requestInterceptor: any, useFontCache?: boolean, navigationTimeout?: number) => Promise<any>;
 export declare const run: (page: any, func: any, args: any) => Promise<any>;
 export declare const jsonToDataURL: (page: any, json: any, attrs: any) => Promise<any>;
 export declare const jsonToPDFDataURL: (page: any, json: any, attrs: any) => Promise<any>;
 export declare const jsonToBlob: (page: any, json: any, attrs: any) => Promise<any>;
-export declare const createInstance: ({ key, url, useParallelPages, browser, requestInterceptor, useFontCache, }?: {
+export declare const createInstance: ({ key, url, useParallelPages, browser, requestInterceptor, useFontCache, navigationTimeout, }?: {
     key?: string;
     url?: string;
     useParallelPages?: boolean;
     browser?: any;
-    browserArgs?: string[];
     requestInterceptor?: (request: any) => void;
     useFontCache?: boolean;
+    navigationTimeout?: number;
 }) => Promise<{
     close: () => Promise<void>;
     firstPage: any;