dragonfly_chrome_headless 0.2.0

data/node_modules/html-pdf-chrome/.npmignore

@@ -0,0 +1,9 @@
+coverage/
+gulpfile.js
+lib/test/
+test/
+tsconfig.json
+tslint.json
+.istanbul.yml
+.travis.yml
+.vscode/

data/node_modules/html-pdf-chrome/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Seth Westphal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/node_modules/html-pdf-chrome/README.md

@@ -0,0 +1,165 @@
+# html-pdf-chrome
+
+[![npm version](https://badge.fury.io/js/html-pdf-chrome.svg)](https://badge.fury.io/js/html-pdf-chrome)
+[![Build Status](https://travis-ci.org/westy92/html-pdf-chrome.svg)](https://travis-ci.org/westy92/html-pdf-chrome/)
+[![Code Coverage](https://codecov.io/gh/westy92/html-pdf-chrome/branch/master/graph/badge.svg)](https://codecov.io/gh/westy92/html-pdf-chrome)
+[![Dependency Status](https://david-dm.org/westy92/html-pdf-chrome.svg)](https://david-dm.org/westy92/html-pdf-chrome)
+[![Known Vulnerabilities](https://snyk.io/test/github/westy92/html-pdf-chrome/badge.svg)](https://snyk.io/test/github/westy92/html-pdf-chrome)
+
+HTML to PDF converter via Chrome/Chromium.
+
+## Prerequisites
+
+* Chrome/Chromium 59 or higher (60 or higher for some features)
+* Windows, macOS, or Linux
+* Node.js v6 or later
+
+## Installation
+
+```bash
+npm install --save html-pdf-chrome
+```
+
+## Usage
+
+__Note:__ It is _strongly_ recommended that you keep Chrome running side-by-side with Node.js.  There is significant overhead starting up Chrome for each PDF generation which can be easily avoided.
+
+It's suggested to use [pm2](http://pm2.keymetrics.io/) to ensure Chrome continues to run.  If it crashes, it will restart automatically.
+
+As of this writing, headless Chrome uses about 65mb of RAM while idle.
+
+```bash
+# install pm2 globally
+npm install -g pm2
+# start Chrome and be sure to specify a port to use in the html-pdf-chrome options.
+pm2 start google-chrome \
+  --interpreter none \
+  -- \
+  --headless \
+  --disable-gpu \
+  --disable-translate \
+  --disable-extensions \
+  --disable-background-networking \
+  --safebrowsing-disable-auto-update \
+  --disable-sync \
+  --metrics-recording-only \
+  --disable-default-apps \
+  --no-first-run \
+  --remote-debugging-port=<port goes here>
+# run your Node.js app.
+```
+
+TypeScript:
+
+```js
+import * as htmlPdf from 'html-pdf-chrome';
+
+const html = '<p>Hello, world!</p>';
+const options: htmlPdf.CreateOptions = {
+  port: 9222, // port Chrome is listening on
+};
+
+// async
+const pdf = await htmlPdf.create(html, options);
+await pdf.toFile('test.pdf');
+const base64 = pdf.toBase64();
+const buffer = pdf.toBuffer();
+
+// Promise
+htmlPdf.create(html, options).then((pdf) => pdf.toFile('test.pdf'));
+htmlPdf.create(html, options).then((pdf) => pdf.toBase64());
+htmlPdf.create(html, options).then((pdf) => pdf.toBuffer());
+```
+
+JavaScript:
+
+```js
+const htmlPdf = require('html-pdf-chrome');
+
+const html = '<p>Hello, world!</p>';
+const options = {
+  port: 9222, // port Chrome is listening on
+};
+
+htmlPdf.create(html, options).then((pdf) => pdf.toFile('test.pdf'));
+htmlPdf.create(html, options).then((pdf) => pdf.toBase64());
+htmlPdf.create(html, options).then((pdf) => pdf.toBuffer());
+```
+
+View the full documentation in the source code.
+
+### Using an External Site
+
+```js
+import * as htmlPdf from 'html-pdf-chrome';
+
+const options: htmlPdf.CreateOptions = {
+  port: 9222, // port Chrome is listening on
+};
+
+const url = 'https://github.com/westy92/html-pdf-chrome';
+const pdf = await htmlPdf.create(url, options);
+```
+
+### Using a Template Engine
+
+Pug (formerly known as Jade)
+
+```js
+import * as htmlPdf from 'html-pdf-chrome';
+import * as pug from 'pug';
+
+const template = pug.compile('p Hello, #{noun}!');
+const templateData = {
+  noun: 'world',
+};
+const options: htmlPdf.CreateOptions = {
+  port: 9222, // port Chrome is listening on
+};
+
+const html = template(templateData);
+const pdf = await htmlPdf.create(html, options);
+```
+
+### Trigger Render Completion
+
+There are a few `CompletionTrigger` types that wait for something to occur before triggering PDF printing.
+
+* Callback - waits for a callback to be called
+* Element - waits for an element to be injected into the DOM
+* Event - waits for an Event to fire
+* Timer - waits a specified amount of time
+* Variable - waits for a variable to be set to `true`
+
+```js
+const options: htmlPdf.CreateOptions = {
+  port: 9222, // port Chrome is listening on
+  completionTrigger: new htmlPdf.CompletionTrigger.Timer(5000), // milliseconds
+};
+
+// Alternative completionTrigger options:
+new htmlPdf.CompletionTrigger.Callback(
+  'cbName', // optional, name of the callback to define for the browser to call when finished rendering.  Defaults to 'htmlPdfCb'.
+  5000 // optional, timeout (milliseconds)
+),
+
+new htmlPdf.CompletionTrigger.Element(
+  'div#myElement', // name of the DOM element to wait for
+  5000 // optional, timeout (milliseconds)
+),
+
+new htmlPdf.CompletionTrigger.Event(
+  'myEvent', // name of the event to listen for
+  '#myElement', // optional DOM element CSS selector to listen on, defaults to body
+  5000 // optional timeout (milliseconds)
+),
+
+new htmlPdf.CompletionTrigger.Variable(
+  'myVarName', // optional, name of the variable to wait for.  Defaults to 'htmlPdfDone'
+  5000 // optional, timeout (milliseconds)
+),
+```
+
+## License
+
+html-pdf-chrome is released under the MIT License.

data/node_modules/html-pdf-chrome/lib/src/ChromePrintOptions.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Chrome Page.printToPDF options.
+ * Note: these require Chrome >= 60.
+ *
+ * @export
+ * @interface ChromePrintOptions
+ */
+export interface ChromePrintOptions {
+    /**
+     * Paper orientation. Defaults to false.
+     *
+     * @type {boolean}
+     * @memberof ChromePrintOptions
+     */
+    landscape?: boolean;
+    /**
+     * Display header and footer. Defaults to false.
+     *
+     * @type {boolean}
+     * @memberof ChromePrintOptions
+     */
+    displayHeaderFooter?: boolean;
+    /**
+     * Print background graphics. Defaults to false.
+     *
+     * @type {boolean}
+     * @memberof ChromePrintOptions
+     */
+    printBackground?: boolean;
+    /**
+     * Scale of the webpage rendering. Defaults to 1.
+     *
+     * @type {number}
+     * @memberof ChromePrintOptions
+     */
+    scale?: number;
+    /**
+     * Paper width in inches. Defaults to 8.5 inches.
+     *
+     * @type {number}
+     * @memberof ChromePrintOptions
+     */
+    paperWidth?: number;
+    /**
+     * Paper height in inches. Defaults to 11 inches.
+     *
+     * @type {number}
+     * @memberof ChromePrintOptions
+     */
+    paperHeight?: number;
+    /**
+     * Top margin in inches. Defaults to 1cm (~0.4 inches).
+     *
+     * @type {number}
+     * @memberof ChromePrintOptions
+     */
+    marginTop?: number;
+    /**
+     * Bottom margin in inches. Defaults to 1cm (~0.4 inches).
+     *
+     * @type {number}
+     * @memberof ChromePrintOptions
+     */
+    marginBottom?: number;
+    /**
+     * Left margin in inches. Defaults to 1cm (~0.4 inches).
+     *
+     * @type {number}
+     * @memberof ChromePrintOptions
+     */
+    marginLeft?: number;
+    /**
+     * Right margin in inches. Defaults to 1cm (~0.4 inches).
+     *
+     * @type {number}
+     * @memberof ChromePrintOptions
+     */
+    marginRight?: number;
+    /**
+     * Paper ranges to print, e.g., '1-5, 8, 11-13'.
+     * Defaults to the empty string, which means print all pages.
+     *
+     * @type {string}
+     * @memberof ChromePrintOptions
+     */
+    pageRanges?: string;
+}

data/node_modules/html-pdf-chrome/lib/src/ChromePrintOptions.js

@@ -0,0 +1,4 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+
+//# sourceMappingURL=ChromePrintOptions.js.map

data/node_modules/html-pdf-chrome/lib/src/ChromePrintOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["src/ChromePrintOptions.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC","file":"ChromePrintOptions.js","sourcesContent":["'use strict';\n\n/**\n * Chrome Page.printToPDF options.\n * Note: these require Chrome >= 60.\n *\n * @export\n * @interface ChromePrintOptions\n */\nexport interface ChromePrintOptions {\n  /**\n   * Paper orientation. Defaults to false.\n   *\n   * @type {boolean}\n   * @memberof ChromePrintOptions\n   */\n  landscape?: boolean;\n\n  /**\n   * Display header and footer. Defaults to false.\n   *\n   * @type {boolean}\n   * @memberof ChromePrintOptions\n   */\n  displayHeaderFooter?: boolean;\n\n  /**\n   * Print background graphics. Defaults to false.\n   *\n   * @type {boolean}\n   * @memberof ChromePrintOptions\n   */\n  printBackground?: boolean;\n\n  /**\n   * Scale of the webpage rendering. Defaults to 1.\n   *\n   * @type {number}\n   * @memberof ChromePrintOptions\n   */\n  scale?: number;\n\n  /**\n   * Paper width in inches. Defaults to 8.5 inches.\n   *\n   * @type {number}\n   * @memberof ChromePrintOptions\n   */\n  paperWidth?: number;\n\n  /**\n   * Paper height in inches. Defaults to 11 inches.\n   *\n   * @type {number}\n   * @memberof ChromePrintOptions\n   */\n  paperHeight?: number;\n\n  /**\n   * Top margin in inches. Defaults to 1cm (~0.4 inches).\n   *\n   * @type {number}\n   * @memberof ChromePrintOptions\n   */\n  marginTop?: number;\n\n  /**\n   * Bottom margin in inches. Defaults to 1cm (~0.4 inches).\n   *\n   * @type {number}\n   * @memberof ChromePrintOptions\n   */\n  marginBottom?: number;\n\n  /**\n   * Left margin in inches. Defaults to 1cm (~0.4 inches).\n   *\n   * @type {number}\n   * @memberof ChromePrintOptions\n   */\n  marginLeft?: number;\n\n  /**\n   * Right margin in inches. Defaults to 1cm (~0.4 inches).\n   *\n   * @type {number}\n   * @memberof ChromePrintOptions\n   */\n  marginRight?: number;\n\n  /**\n   * Paper ranges to print, e.g., '1-5, 8, 11-13'.\n   * Defaults to the empty string, which means print all pages.\n   *\n   * @type {string}\n   * @memberof ChromePrintOptions\n   */\n  pageRanges?: string;\n}\n"],"sourceRoot":"../.."}

data/node_modules/html-pdf-chrome/lib/src/CompletionTrigger.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Defines a trigger that signifies page render completion.
+ *
+ * @export
+ * @abstract
+ * @class CompletionTrigger
+ */
+export declare abstract class CompletionTrigger {
+    protected timeout: number;
+    protected timeoutMessage: string;
+    /**
+     * Creates an instance of CompletionTrigger.
+     * @param {number} [timeout=1000] milliseconds until timing out.
+     * @param {string} [timeoutMessage='CompletionTrigger timed out.'] The timeout message.
+     * @memberof CompletionTrigger
+     */
+    constructor(timeout?: number, timeoutMessage?: string);
+    /**
+     * Abstracts away the trigger logic.
+     *
+     * @abstract
+     * @param {*} client the Chrome connection information.
+     * @returns {Promise<any>} resolves if triggered, rejects on error or timeout.
+     * @memberof CompletionTrigger
+     */
+    abstract wait(client: any): Promise<any>;
+}
+/**
+ * Waits for a specified amount of time.
+ *
+ * @export
+ * @class Timer
+ * @extends {CompletionTrigger}
+ */
+export declare class Timer extends CompletionTrigger {
+    /**
+     * Creates an instance of the Timer CompletionTrigger.
+     * @param {number} timeout ms to wait until timing out.
+     * @memberof Timer
+     */
+    constructor(timeout: number);
+    wait(client: any): Promise<any>;
+}
+/**
+ * Waits for an Event to fire.
+ *
+ * @export
+ * @class Event
+ * @extends {CompletionTrigger}
+ */
+export declare class Event extends CompletionTrigger {
+    protected event: string;
+    protected cssSelector: string;
+    /**
+     * Creates an instance of the Event CompletionTrigger.
+     * @param {string} event the name of the event to listen for.
+     * @param {string} [cssSelector] the CSS selector of the element to listen on.
+     *  Defaults to body.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Event
+     */
+    constructor(event: string, cssSelector?: string, timeout?: number);
+    wait(client: any): Promise<any>;
+}
+/**
+ * Waits for a callback to be called.
+ *
+ * @export
+ * @class Callback
+ * @extends {CompletionTrigger}
+ */
+export declare class Callback extends CompletionTrigger {
+    protected callbackName: string;
+    /**
+     * Creates an instance of the Callback CompletionTrigger.
+     * @param {string} [callbackName] the name of the callback to listen for.
+     *  Defaults to htmlPdfCb.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Callback
+     */
+    constructor(callbackName?: string, timeout?: number);
+    wait(client: any): Promise<any>;
+}
+/**
+ * Waits for a DOM element to appear.
+ *
+ * @export
+ * @class Element
+ * @extends {CompletionTrigger}
+ */
+export declare class Element extends CompletionTrigger {
+    protected cssSelector: string;
+    /**
+     * Creates an instance of the Element CompletionTrigger.
+     * @param {string} cssSelector the element to listen for.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Element
+     */
+    constructor(cssSelector: string, timeout?: number);
+    wait(client: any): Promise<any>;
+}
+/**
+ * Waits for a variable to be true.
+ *
+ * @export
+ * @class Variable
+ * @extends {CompletionTrigger}
+ */
+export declare class Variable extends CompletionTrigger {
+    protected variableName: string;
+    /**
+     * Creates an instance of the Variable CompletionTrigger.
+     * @param {string} [variableName] the variable to listen on.
+     *  Defaults to htmlPdfDone.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Variable
+     */
+    constructor(variableName?: string, timeout?: number);
+    wait(client: any): Promise<any>;
+}

data/node_modules/html-pdf-chrome/lib/src/CompletionTrigger.js

@@ -0,0 +1,206 @@
+'use strict';
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Defines a trigger that signifies page render completion.
+ *
+ * @export
+ * @abstract
+ * @class CompletionTrigger
+ */
+class CompletionTrigger {
+    /**
+     * Creates an instance of CompletionTrigger.
+     * @param {number} [timeout=1000] milliseconds until timing out.
+     * @param {string} [timeoutMessage='CompletionTrigger timed out.'] The timeout message.
+     * @memberof CompletionTrigger
+     */
+    constructor(timeout = 1000, timeoutMessage = 'CompletionTrigger timed out.') {
+        this.timeout = timeout;
+        this.timeoutMessage = timeoutMessage;
+    }
+}
+exports.CompletionTrigger = CompletionTrigger;
+/**
+ * Waits for a specified amount of time.
+ *
+ * @export
+ * @class Timer
+ * @extends {CompletionTrigger}
+ */
+class Timer extends CompletionTrigger {
+    /**
+     * Creates an instance of the Timer CompletionTrigger.
+     * @param {number} timeout ms to wait until timing out.
+     * @memberof Timer
+     */
+    constructor(timeout) {
+        super(timeout);
+    }
+    wait(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve) => {
+                setTimeout(resolve, this.timeout);
+            });
+        });
+    }
+}
+exports.Timer = Timer;
+/**
+ * Waits for an Event to fire.
+ *
+ * @export
+ * @class Event
+ * @extends {CompletionTrigger}
+ */
+class Event extends CompletionTrigger {
+    /**
+     * Creates an instance of the Event CompletionTrigger.
+     * @param {string} event the name of the event to listen for.
+     * @param {string} [cssSelector] the CSS selector of the element to listen on.
+     *  Defaults to body.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Event
+     */
+    constructor(event, cssSelector, timeout) {
+        super(timeout);
+        this.event = event;
+        this.cssSelector = cssSelector;
+    }
+    wait(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { Runtime } = client;
+            const selector = this.cssSelector ? `querySelector('${this.cssSelector}')` : 'body';
+            return Runtime.evaluate({
+                awaitPromise: true,
+                expression: `
+        new Promise((resolve, reject) => {
+          document.${selector}.addEventListener('${this.event}', resolve, { once: true });
+          setTimeout(() => reject('${this.timeoutMessage}'), ${this.timeout});
+        })`,
+            });
+        });
+    }
+}
+exports.Event = Event;
+/**
+ * Waits for a callback to be called.
+ *
+ * @export
+ * @class Callback
+ * @extends {CompletionTrigger}
+ */
+class Callback extends CompletionTrigger {
+    /**
+     * Creates an instance of the Callback CompletionTrigger.
+     * @param {string} [callbackName] the name of the callback to listen for.
+     *  Defaults to htmlPdfCb.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Callback
+     */
+    constructor(callbackName, timeout) {
+        super(timeout);
+        this.callbackName = callbackName;
+    }
+    wait(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { Runtime } = client;
+            const cbName = this.callbackName || 'htmlPdfCb';
+            return Runtime.evaluate({
+                awaitPromise: true,
+                expression: `
+        new Promise((resolve, reject) => {
+          ${cbName} = resolve;
+          setTimeout(() => reject('${this.timeoutMessage}'), ${this.timeout});
+        })`,
+            });
+        });
+    }
+}
+exports.Callback = Callback;
+/**
+ * Waits for a DOM element to appear.
+ *
+ * @export
+ * @class Element
+ * @extends {CompletionTrigger}
+ */
+class Element extends CompletionTrigger {
+    /**
+     * Creates an instance of the Element CompletionTrigger.
+     * @param {string} cssSelector the element to listen for.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Element
+     */
+    constructor(cssSelector, timeout) {
+        super(timeout);
+        this.cssSelector = cssSelector;
+    }
+    wait(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { Runtime } = client;
+            return Runtime.evaluate({
+                awaitPromise: true,
+                expression: `
+        new Promise((resolve, reject) => {
+          new MutationObserver((mutations, observer) => {
+            mutations.forEach((mutation) => {
+              if ([...mutation.addedNodes].find((node) => node.matches('${this.cssSelector}'))) {
+                observer.disconnect();
+                resolve();
+              }
+            });
+          }).observe(document.body, { childList: true });
+          setTimeout(() => reject('${this.timeoutMessage}'), ${this.timeout});
+        })`,
+            });
+        });
+    }
+}
+exports.Element = Element;
+/**
+ * Waits for a variable to be true.
+ *
+ * @export
+ * @class Variable
+ * @extends {CompletionTrigger}
+ */
+class Variable extends CompletionTrigger {
+    /**
+     * Creates an instance of the Variable CompletionTrigger.
+     * @param {string} [variableName] the variable to listen on.
+     *  Defaults to htmlPdfDone.
+     * @param {number} [timeout] ms to wait until timing out.
+     * @memberof Variable
+     */
+    constructor(variableName, timeout) {
+        super(timeout);
+        this.variableName = variableName;
+    }
+    wait(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { Runtime } = client;
+            const varName = this.variableName || 'htmlPdfDone';
+            return Runtime.evaluate({
+                awaitPromise: true,
+                expression: `
+        new Promise((resolve, reject) => {
+          Object.defineProperty(window, '${varName}', {
+            set: (val) => { if (val === true) resolve(); }
+          });
+          setTimeout(() => reject('${this.timeoutMessage}'), ${this.timeout});
+        })`,
+            });
+        });
+    }
+}
+exports.Variable = Variable;
+
+//# sourceMappingURL=CompletionTrigger.js.map