1.0.14

.gitignore

@@ -1,7 +1,23 @@
 .nogit/
-node_modules/
+
-assets/pdfdir/
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom
+assets/pdfdir

.gitlab-ci.yml

@@ -37,18 +37,6 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
@@ -121,10 +109,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv
@@ -135,13 +123,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

npmextra.json

@@ -2,5 +2,15 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.om",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartpdf",
+      "shortDescription": "Create PDFs fast and smoothly",
+      "npmPackagename": "@pushrocks/smartpdf",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartpdf",
-  "version": "1.0.3",
+  "version": "1.0.14",
   "private": false,
   "description": "create pdfs on the fly",
   "main": "dist/index.js",
@@ -13,20 +13,30 @@
     "build": "(tsbuild)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^10.11.4"
+    "@types/node": "^12.0.3"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^6.0.8",
+    "@pushrocks/smartfile": "^7.0.2",
-    "@pushrocks/smartnetwork": "^1.1.0",
+    "@pushrocks/smartnetwork": "^1.1.6",
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartpromise": "^3.0.2",
     "@pushrocks/smartunique": "^3.0.1",
-    "@types/express": "^4.16.0",
+    "@types/express": "^4.16.1",
-    "@types/puppeteer": "^1.9.0",
+    "@types/puppeteer": "^1.12.4",
-    "express": "^4.16.3",
+    "express": "^4.17.1",
-    "puppeteer": "^1.9.0"
+    "puppeteer": "^1.17.0"
-  }
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,26 @@
+# @pushrocks/smartpdf
+Create PDFs fast and smoothly
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpdf)
+* [gitlab.com (source)](https://gitlab.om/pushrocks/smartpdf)
+* [github.com (source mirror)](https://github.com/pushrocks/smartpdf)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartpdf/)
+
+## Status for master
+[![build status](https://gitlab.om/pushrocks/smartpdf/badges/master/build.svg)](https://gitlab.om/pushrocks/smartpdf/commits/master)
+[![coverage report](https://gitlab.om/pushrocks/smartpdf/badges/master/coverage.svg)](https://gitlab.om/pushrocks/smartpdf/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartpdf.svg)](https://www.npmjs.com/package/@pushrocks/smartpdf)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartpdf/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartpdf)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -8,16 +8,29 @@ tap.test('should create a valid instance of smartpdf', async () => {
   expect(testSmartPdf).to.be.instanceof(smartpdf.SmartPdf);
 });
 
+tap.test('should start the instance', async () => {
+  await testSmartPdf.start();
+});
+
 tap.test('should create a pdf from html string', async () => {
   await testSmartPdf.getPdfForHtmlString('hi');
 });
 
-tap.test('should create a pdf from website', async () => {
+tap.test('should create a pdf from website as A4', async () => {
-  await testSmartPdf.getPdfForWebsite('https://wikipedia.org');
+  await testSmartPdf.getPdfForWebsite('https://maintainedby.lossless.com');
+});
+
+tap.test('should create a pdf from website as single page PDF', async () => {
+  await testSmartPdf.getFullWebsiteAsSinglePdf('https://maintainedby.lossless.com');
+});
+
+tap.test('should create a valid PDFResult', async () => {
+  const pdfResult = await testSmartPdf.getFullWebsiteAsSinglePdf('https://maintainedby.lossless.com');
+  expect(pdfResult.buffer).to.be.instanceOf(Buffer);
 });
 
 tap.test('should be able to close properly', async () => {
-  await testSmartPdf.close();
+  await testSmartPdf.stop();
 });
 
 tap.start();

ts/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './interface.pdfresult';

ts/interfaces/interface.pdfresult.ts

@@ -0,0 +1,5 @@
+export interface IPdfResult {
+  name: string,
+  id: string,
+  buffer: Buffer;
+}

ts/smartpdf.classes.pdfresult.ts

@@ -1 +0,0 @@
-import * as plugins from './smartpdf.plugins';

ts/smartpdf.classes.smartpdf.ts

@@ -3,21 +3,36 @@ import * as paths from './smartpdf.paths';
 import { Server } from 'http';
 import { PdfCandidate } from './smartpdf.classes.pdfcandidate';
 
+declare const document;
+
+import { IPdfResult } from './interfaces';
+
 export class SmartPdf {
   htmlServerInstance: Server;
   serverPort: number;
   headlessBrowser: plugins.puppeteer.Browser;
+  externalBrowser: boolean = false;
   private _readyDeferred: plugins.smartpromise.Deferred<void>;
   private _candidates: { [key: string]: PdfCandidate } = {};
 
-  constructor() {
+  constructor(headlessBrowserArg?) {
+    this.headlessBrowser = headlessBrowserArg
     this._readyDeferred = new plugins.smartpromise.Deferred();
-    this.init();
   }
 
-  async init() {
+  async start() {
     // setup puppeteer
-    this.headlessBrowser = await plugins.puppeteer.launch();
+    if (!this.headlessBrowser) {
+      let  chromeArgs: string[] = [];
+      if(process.env.CI) {
+        chromeArgs = chromeArgs.concat(['--no-sandbox', '--disable-setuid-sandbox'])
+      }
+      this.headlessBrowser = await plugins.puppeteer.launch({
+        args: chromeArgs
+      });
+    } else {
+      this.externalBrowser = true;
+    }
 
     // setup server
     const app = plugins.express();
@@ -34,19 +49,23 @@ export class SmartPdf {
     });
   }
 
-  async close () {
+  async stop() {
     const done = plugins.smartpromise.defer<void>();
     this.htmlServerInstance.close(() => {
       done.resolve();
     });
+    
+    if (!this.externalBrowser) {
       await this.headlessBrowser.close();
+    }
+
     await done.promise;
   }
 
   /**
    * returns a pdf for a given html string;
    */
-  async getPdfForHtmlString(htmlStringArg: string) {
+  async getPdfForHtmlString(htmlStringArg: string): Promise<IPdfResult> {
     await this._readyDeferred.promise;
     const pdfCandidate = new PdfCandidate(htmlStringArg);
     this._candidates[pdfCandidate.pdfId] = pdfCandidate;
@@ -62,24 +81,62 @@ export class SmartPdf {
       console.log(`id security check passed for ${pdfCandidate.pdfId}`);
     }
 
-    await page.pdf({
+    const pdfBuffer = await page.pdf({
-      path: plugins.path.join(paths.pdfDir, `${pdfCandidate.pdfId}.pdf`),
       format: 'A4'
     });
     await page.close();
     delete this._candidates[pdfCandidate.pdfId];
     pdfCandidate.doneDeferred.resolve();
     await pdfCandidate.doneDeferred.promise;
+    return {
+      id: pdfCandidate.pdfId,
+      name: `${pdfCandidate.pdfId}.js`,
+      buffer: pdfBuffer
+    };
   }
 
-  async getPdfForWebsite(websiteUrl: string) {
+  async getPdfForWebsite(websiteUrl: string): Promise<IPdfResult> {
     const page = await this.headlessBrowser.newPage();
+    page.emulateMedia('screen');
     const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
     const pdfId = plugins.smartunique.shortId();
-    await page.pdf({
+    const pdfBuffer = await page.pdf({
-      path: plugins.path.join(paths.pdfDir, `${pdfId}.pdf`),
+      format: 'A4',
-      format: 'A4'
+      printBackground: true,
+      displayHeaderFooter: false,
+      preferCSSPageSize: true
     });
     await page.close();
+    return {
+      id: pdfId,
+      name: `${pdfId}.js`,
+      buffer: pdfBuffer
+    };
+  }
+
+  async getFullWebsiteAsSinglePdf(websiteUrl: string) {
+    const page = await this.headlessBrowser.newPage();
+    page.emulateMedia('screen');
+    const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
+    const pdfId = plugins.smartunique.shortId();
+    const { documentHeight, documentWidth } = await page.evaluate(() => {
+      return {
+        documentHeight: document.height,
+        documentWidth: document.width
+      };
+    });
+    const pdfBuffer = await page.pdf({
+      height: documentWidth,
+      width: documentWidth,
+      printBackground: true,
+      displayHeaderFooter: false,
+      preferCSSPageSize: true
+    });
+    await page.close();
+    return {
+      id: pdfId,
+      name: `${pdfId}.js`,
+      buffer: pdfBuffer
+    };
   }
 }

ts/smartpdf.plugins.ts

@@ -13,7 +13,7 @@ import * as smartunique from '@pushrocks/smartunique';
 export { smartfile, smartpromise, smartunique, smartnetwork };
 
 // thirdparty
-import * as express from 'express';
+import express from 'express';
-import * as puppeteer from 'puppeteer';
+import puppeteer from 'puppeteer';
 
 export { express, puppeteer };

tslint.json

@@ -1,7 +1,17 @@
 {
   "extends": ["tslint:latest", "tslint-config-prettier"],
   "rules": {
-      "semicolon": [true, "always"]
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
       }
     }
-  
+  },
+  "defaultSeverity": "warning"
+}