polotno-node 0.2.2 → 0.3.1

package/README.md

@@ -1,6 +1,7 @@
 # Polotno-node
 
 Export Polotno JSON into images and pdf files. NodeJS package to work with [Polotno Store API](https://polotno.dev/).
+Should work fine with lambda functions as well.
 
 ## Usage
 
@@ -68,7 +69,7 @@ const url = await instance.jsonToDataURL(json);
 res.json({ url });
 ```
 
-### `instance.jsonToImageBase64(json)`
+### `instance.jsonToImageBase64(json, attrs)`
 
 Export json into base64 string of image.
 
@@ -81,7 +82,7 @@ const imageBase64 = await instance.jsonToImageBase64(json, {
 fs.writeFileSync('out.png', imageBase64, 'base64');
 ```
 
-### `instance.jsonToPDFBase64(json)`
+### `instance.jsonToPDFBase64(json, attrs)`
 
 Export json into base64 string of pdf file.
 
@@ -91,3 +92,30 @@ const json = JSON.parse(fs.readFileSync('polotno.json'));
 const pdfBase64 = await instance.jsonToPDFBase64(json);
 fs.writeFileSync('out.pdf', pdfBase64, 'base64');
 ```
+
+### `instance.jsonToPDFDataURL(json, attrs)`
+
+Export json into data url of pdf file.
+
+```js
+const json = JSON.parse(fs.readFileSync('polotno.json'));
+
+const url = await instance.jsonToPDFDataURL(json);
+res.json({ url });
+```
+
+## Browserless usage
+
+By default `polotno-node` will import browser bundle using `chrome-aws-lambda`. But you can use `browserless` instead, to keep your cloud function smaller.
+
+```js
+const { createInstance } = require('polotno-node/instance');
+const puppeteer = require('puppeteer');
+
+const instance = await createInstance({
+  key: 'nFA5H9elEytDyPyvKL7T',
+  browser: await puppeteer.connect({
+    browserWSEndpoint: 'wss://chrome.browserless.io?token=API_KEY',
+  }),
+});
+```

package/index.js

@@ -1,32 +1,14 @@
 const chrome = require('chrome-aws-lambda');
 const puppeteer = require('puppeteer');
-const path = require('path');
 
-const DEFAULT_CLIENT = `file:${path.join(__dirname, 'dist', 'client.html')}`;
+const { createInstance } = require('./instance');
 
-const getNewPage = async (browser, url) => {
-  const page = await browser.newPage();
-
-  page.on('console', (msg) => {
-    msg.args().forEach((message) => {
-      // skip style information
-      if (message.toString().indexOf('margin') >= 0) {
-        return;
-      }
-      const text = message
-        .toString()
-        .replace('JSHandle:', '')
-        .replace('%c', '');
-      console.log(text);
-    });
-  });
-
-  await page.goto(url);
-
-  return page;
-};
-
-module.exports.createInstance = async ({ key, url, useParallelPages } = {}) => {
+module.exports.createInstance = async ({
+  key,
+  url,
+  useParallelPages,
+  browserArgs = [],
+} = {}) => {
   const browser = await puppeteer.launch({
     args: [
       ...chrome.args,
@@ -34,70 +16,23 @@ module.exports.createInstance = async ({ key, url, useParallelPages } = {}) => {
       '--hide-scrollbars',
       '--disable-web-security',
       '--allow-file-access-from-files',
+      // more info about --disable-dev-shm-usage
+      // https://github.com/puppeteer/puppeteer/issues/1175#issuecomment-369728215
+      // https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#tips
+      '--disable-dev-shm-usage',
+      ...browserArgs,
     ],
     defaultViewport: chrome.defaultViewport,
     executablePath: await chrome.executablePath,
     headless: true,
     ignoreHTTPSErrors: true,
   });
-  const visitPage = url || `${DEFAULT_CLIENT}?key=${key}`;
-
-  const firstPage = await getNewPage(browser, visitPage);
 
-  const run = async (func, ...args) => {
-    const page = useParallelPages
-      ? await getNewPage(browser, visitPage)
-      : firstPage;
-
-    const result = await page.evaluate(func, ...args);
-    if (useParallelPages) {
-      page.close();
-    }
-    return result;
-  };
-
-  const jsonToDataURL = async (json, attrs) => {
-    return await run(
-      async (json, attrs) => {
-        const pixelRatio = attrs.pixelRatio || 1;
-        store.loadJSON(json);
-        store.setElementsPixelRatio(pixelRatio);
-        await store.waitLoading();
-        return store.toDataURL({ ...attrs, pixelRatio });
-      },
-      json,
-      attrs || {}
-    );
-  };
-
-  const jsonToImageBase64 = async (json, attrs) => {
-    const url = await jsonToDataURL(json, attrs);
-    return url.split('base64,')[1];
-  };
-
-  const jsonToPDFDataURL = async (json, attrs) => {
-    return await run(
-      async (json, attrs) => {
-        store.loadJSON(json);
-        await store.waitLoading();
-        return await store.toPDFDataURL(attrs);
-      },
-      json,
-      attrs || {}
-    );
-  };
-
-  const jsonToPDFBase64 = async (json, attrs) => {
-    const url = await jsonToPDFDataURL(json, attrs);
-    return url.split('base64,')[1];
-  };
-
-  return {
-    close: async () => await browser.close(),
-    run,
-    jsonToDataURL,
-    jsonToImageBase64,
-    jsonToPDFDataURL,
-    jsonToPDFBase64,
-  };
+  return await createInstance({
+    browser,
+    key,
+    url,
+    useParallelPages,
+    browserArgs,
+  });
 };

package/instance.js

@@ -0,0 +1,123 @@
+const path = require('path');
+const DEFAULT_CLIENT = `file:${path.join(__dirname, 'dist', 'client.html')}`;
+
+module.exports.createPage = async (browser, url) => {
+  const page = await browser.newPage();
+
+  page.on('console', (msg) => {
+    msg.args().forEach((message) => {
+      // skip style information
+      if (message.toString().indexOf('margin') >= 0) {
+        return;
+      }
+      const text = message
+        .toString()
+        .replace('JSHandle:', '')
+        .replace('%c', '');
+      console.log(text);
+    });
+  });
+
+  await page.goto(url);
+
+  return page;
+};
+
+module.exports.run = async (page, func, args) => {
+  return await page.evaluate(func, ...args);
+};
+
+module.exports.jsonToDataURL = async (page, json, attrs) => {
+  return await page.evaluate(
+    async (json, attrs) => {
+      const pixelRatio = attrs.pixelRatio || 1;
+      store.loadJSON(json);
+      store.setElementsPixelRatio(pixelRatio);
+      await store.waitLoading();
+      return store.toDataURL({ ...attrs, pixelRatio });
+    },
+    json,
+    attrs || {}
+  );
+};
+
+module.exports.jsonToPDFDataURL = async (page, json, attrs) => {
+  return page.evaluate(
+    async (json, attrs) => {
+      store.loadJSON(json);
+      await store.waitLoading();
+      return await store.toPDFDataURL(attrs);
+    },
+    json,
+    attrs || {}
+  );
+};
+
+module.exports.createInstance = async ({
+  key,
+  url,
+  useParallelPages,
+  browser,
+} = {}) => {
+  const visitPage = url || `${DEFAULT_CLIENT}?key=${key}`;
+  const firstPage = useParallelPages
+    ? null
+    : await module.exports.createPage(browser, visitPage);
+
+  const run = async (func, ...args) => {
+    const page = useParallelPages
+      ? await module.exports.createPage(browser, visitPage)
+      : firstPage;
+
+    const result = await page.evaluate(func, ...args);
+    if (useParallelPages) {
+      page.close();
+    }
+    return result;
+  };
+
+  const jsonToDataURL = async (json, attrs) => {
+    return await run(
+      async (json, attrs) => {
+        const pixelRatio = attrs.pixelRatio || 1;
+        store.loadJSON(json);
+        store.setElementsPixelRatio(pixelRatio);
+        await store.waitLoading();
+        return store.toDataURL({ ...attrs, pixelRatio });
+      },
+      json,
+      attrs || {}
+    );
+  };
+
+  const jsonToImageBase64 = async (json, attrs) => {
+    const url = await jsonToDataURL(json, attrs);
+    return url.split('base64,')[1];
+  };
+
+  const jsonToPDFDataURL = async (json, attrs) => {
+    return await run(
+      async (json, attrs) => {
+        store.loadJSON(json);
+        await store.waitLoading();
+        return await store.toPDFDataURL(attrs);
+      },
+      json,
+      attrs || {}
+    );
+  };
+
+  const jsonToPDFBase64 = async (json, attrs) => {
+    const url = await jsonToPDFDataURL(json, attrs);
+    return url.split('base64,')[1];
+  };
+
+  return {
+    close: async () => await browser.close(),
+    run,
+    jsonToDataURL,
+    jsonToImageBase64,
+    jsonToPDFDataURL,
+    jsonToPDFBase64,
+  };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polotno-node",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "Polotno workflow from NodeJS",
   "main": "index.js",
   "scripts": {
@@ -10,6 +10,7 @@
   "files": [
     "dist",
     "index.js",
+    "instance.js",
     "README.md"
   ],
   "devDependencies": {