pdf() API

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `mousedown(selector: string): Chromeless<T>` and `mouseup(selector: string): Chromeless<T>` APIs [#118](https://github.com/graphcool/chromeless/pull/118) @criticalbh
 - `focus(selector: string)` API [#132](https://github.com/graphcool/chromeless/pull/132) @criticalbh
 - When using chromeless locally, chromeless will now boot chrome automatically [#120](https://github.com/graphcool/chromeless/pull/120) @joelgriffith
+- `pdf()` API [#84](https://github.com/graphcool/chromeless/pull/84)
 
 
 ### Changed

README.md

@@ -157,7 +157,7 @@ const chromeless = new Chromeless({
 - [`inputValue(selector: string)`](docs/api.md#api-inputvalue)
 - [`exists(selector: string)`](docs/api.md#api-exists)
 - [`screenshot()`](docs/api.md#api-screenshot)
-- [`pdf()`](docs/api.md#api-pdf) - Not implemented yet
+- [`pdf(options?: PdfOptions)`](docs/api.md#api-pdf)
 - [`getHtml()`](docs/api.md#api-gethtml)
 - [`cookiesGet()`](docs/api.md#api-cookiesget)
 - [`cookiesGet(name: string)`](docs/api.md#api-cookiesget-name)

docs/api.md

@@ -26,7 +26,7 @@ Chromeless provides TypeScript typings.
 - [`inputValue(selector: string)`](#api-inputvalue)
 - [`exists(selector: string)`](#api-exists)
 - [`screenshot()`](#api-screenshot)
-- [`pdf()`](#api-pdf) - Not implemented yet
+- [`pdf(options?: PdfOptions)`](#api-pdf)
 - [`getHtml()`](#api-gethtml)
 - [`cookiesGet()`](#api-cookiesget)
 - [`cookiesGet(name: string)`](#api-cookiesget-name)
@@ -390,9 +390,24 @@ console.log(screenshot) // prints local file path or S3 URL
 
 <a name="api-pdf" />
 
-### pdf() - Not implemented yet
+### pdf(options?: PdfOptions) - Chromeless<string>
 
-Not implemented yet
+Print to a PDF of the document as framed by the viewport.
+When running Chromeless locally this returns the local file path to the PDF.
+When run over the Chromeless Proxy service, a URL to the PDF on S3 is returned.
+
+__Arguments__
+- `options` - An object containing overrides for [printToPDF() parameters](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF)
+
+__Example__
+
+```js
+const pdf = await chromeless
+  .goto('https://google.com/')
+  .pdf({landscape: true})
+
+console.log(pdf) // prints local file path or S3 URL
+```
 
 ---------------------------------------
 

src/api.ts

@@ -1,7 +1,7 @@
 import ChromeLocal from './chrome/local'
 import ChromeRemote from './chrome/remote'
 import Queue from './queue'
-import { ChromelessOptions, Cookie, CookieQuery } from './types'
+import { ChromelessOptions, Cookie, CookieQuery, PdfOptions } from './types'
 import { getDebugOption } from './util'
 
 export default class Chromeless<T extends any> implements Promise<T> {
@@ -186,6 +186,12 @@ export default class Chromeless<T extends any> implements Promise<T> {
     return new Chromeless<string>({}, this)
   }
 
+  pdf(options?: PdfOptions): Chromeless<string> {
+    this.lastReturnPromise = this.queue.process<string>({type: 'returnPDF', options})
+
+    return new Chromeless<string>({}, this)
+  }
+
   /**
    * Get the cookies for the current url
    */

src/chrome/local-runtime.ts

@@ -1,5 +1,5 @@
 import * as AWS from 'aws-sdk'
-import { Client, Command, ChromelessOptions, Cookie, CookieQuery } from '../types'
+import { Client, Command, ChromelessOptions, Cookie, CookieQuery, PdfOptions } from '../types'
 import * as cuid from 'cuid'
 import * as fs from 'fs'
 import {
@@ -10,6 +10,7 @@ import {
   evaluate,
   screenshot,
   getHtml,
+  pdf,
   type,
   getValue,
   scrollTo,
@@ -53,6 +54,8 @@ export default class LocalRuntime {
         return this.returnScreenshot()
       case 'returnHtml':
         return this.returnHtml()
+      case 'returnPDF':
+        return this.returnPDF(command.options)
       case 'returnInputValue':
         return this.returnInputValue(command.selector)
       case 'type':
@@ -275,6 +278,34 @@ export default class LocalRuntime {
     return await getHtml(this.client)
   }
 
+  // Returns the S3 url or local file path
+  async returnPDF(options?: PdfOptions): Promise<string> {
+    const data = await pdf(this.client, options)
+
+    // check if S3 configured
+    if (process.env['CHROMELESS_S3_BUCKET_NAME'] && process.env['CHROMELESS_S3_BUCKET_URL']) {
+      const s3Path = `${cuid()}.pdf`
+      const s3 = new AWS.S3()
+      await s3.putObject({
+        Bucket: process.env['CHROMELESS_S3_BUCKET_NAME'],
+        Key: s3Path,
+        ContentType: 'application/pdf',
+        ACL: 'public-read',
+        Body: new Buffer(data, 'base64'),
+      }).promise()
+
+      return `https://${process.env['CHROMELESS_S3_BUCKET_URL']}/${s3Path}`
+    }
+
+    // write to `/tmp` instead
+    else {
+      const filePath = `/tmp/${cuid()}.pdf`
+      fs.writeFileSync(filePath, Buffer.from(data, 'base64'))
+
+      return filePath
+    }
+  }
+
   private log(msg: string): void {
     if (this.chromelessOptions.debug) {
       console.log(msg)

src/types.ts

@@ -81,6 +81,10 @@ export type Command =
   | {
       type: 'returnHtml'
     }
+  | {
+      type: 'returnPDF',
+      options?: PdfOptions
+    }
   | {
       type: 'scrollTo'
       x: number
@@ -151,3 +155,19 @@ export interface CookieQuery {
   secure?: boolean
   session?: boolean
 }
+
+// https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF
+export interface PdfOptions {
+  landscape?: boolean,
+  displayHeaderFooter?: boolean,
+  printBackground?: boolean,
+  scale?: number,
+  paperWidth?: number,
+  paperHeight?: number,
+  marginTop?: number,
+  marginBottom?: number,
+  marginLeft?: number,
+  marginRight?: number,
+  pageRanges?: string,
+  ignoreInvalidPageRanges?: boolean
+}

src/util.ts

@@ -1,6 +1,6 @@
 import * as fs from 'fs'
 import * as path from 'path'
-import { Client, Cookie } from './types'
+import { Client, Cookie, PdfOptions } from './types'
 
 export const version: string = ((): string => {
   if (fs.existsSync(path.join(__dirname, '../package.json'))) {
@@ -332,6 +332,14 @@ export async function getHtml(client: Client): Promise<string> {
   return outerHTML
 }
 
+export async function pdf(client: Client, options?: PdfOptions): Promise<string> {
+  const {Page} = client
+
+  const pdf = await Page.printToPDF(options)
+
+  return pdf.data
+}
+
 export function getDebugOption(): boolean {
   if (process && process.env && process.env['DEBUG'] && process.env['DEBUG'].includes('chromeless')) {
     return true