2.0.0

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,10 +18,11 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 snyk:
   stage: security
@@ -31,89 +32,89 @@ snyk:
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.snyk

@@ -0,0 +1,9 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-LODASH-450202:
+    - '@pushrocks/smartnetwork > portscanner > async > lodash':
+        reason: None given
+        expires: '2019-09-13T09:39:26.276Z'
+patch: {}

npmextra.json

@@ -5,7 +5,7 @@
   },
   "gitzone": {
     "module": {
-      "githost": "gitlab.om",
+      "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartpdf",
       "shortDescription": "Create PDFs fast and smoothly",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartpdf",
-  "version": "1.0.7",
+  "version": "2.0.0",
   "private": false,
   "description": "create pdfs on the fly",
   "main": "dist/index.js",
@@ -13,28 +13,30 @@
     "build": "(tsbuild)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^12.0.3"
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.12.8",
+    "tslint": "^6.0.0-beta0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.2",
-    "@pushrocks/smartnetwork": "^1.1.6",
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartfile": "^7.0.6",
+    "@pushrocks/smartnetwork": "^1.1.14",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpuppeteer": "^1.0.11",
     "@pushrocks/smartunique": "^3.0.1",
-    "@types/express": "^4.16.1",
-    "@types/puppeteer": "^1.12.4",
-    "express": "^4.17.1",
-    "puppeteer": "^1.17.0"
+    "@types/express": "^4.17.2",
+    "express": "^4.17.1"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -3,13 +3,13 @@ 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)
+* [gitlab.com (source)](https://gitlab.com/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)
+[![build status](https://gitlab.com/pushrocks/smartpdf/badges/master/build.svg)](https://gitlab.com/pushrocks/smartpdf/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartpdf/badges/master/coverage.svg)](https://gitlab.com/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/)
@@ -18,9 +18,14 @@ Create PDFs fast and smoothly
 
 ## Usage
 
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 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)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -13,15 +13,28 @@ tap.test('should start the instance', async () => {
 });
 
 tap.test('should create a pdf from html string', async () => {
-  await testSmartPdf.getPdfForHtmlString('hi');
+  await testSmartPdf.getPdfResultForHtmlString('hi');
 });
 
 tap.test('should create a pdf from website as A4', async () => {
-  await testSmartPdf.getPdfForWebsite('https://maintainedby.lossless.com');
+  await testSmartPdf.getPdfResultForWebsite('https://www.wikipedia.org');
 });
 
 tap.test('should create a pdf from website as single page PDF', async () => {
-  await testSmartPdf.getFullWebsiteAsSinglePdf('https://maintainedby.lossless.com');
+  await testSmartPdf.getFullWebsiteAsSinglePdf('https://www.wikipedia.org');
+});
+
+tap.test('should create a valid PDFResult', async () => {
+  const pdfResult = await testSmartPdf.getFullWebsiteAsSinglePdf(
+    'https://maintainedby.lossless.com'
+  );
+  expect(pdfResult.buffer).to.be.instanceOf(Buffer);
+  const fs = await import('fs');
+
+  if (!fs.existsSync('.nogit/')) {
+    fs.mkdirSync('.nogit/');
+  }
+  fs.writeFileSync('.nogit/sample.pdf', pdfResult.buffer);
 });
 
 tap.test('should be able to close properly', async () => {

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.smartpdf.ts

@@ -5,10 +5,13 @@ import { PdfCandidate } from './smartpdf.classes.pdfcandidate';
 
 declare const document;
 
+import * as interfaces from './interfaces';
+
 export class SmartPdf {
   htmlServerInstance: Server;
   serverPort: number;
-  headlessBrowser: plugins.puppeteer.Browser;
+  headlessBrowser: plugins.smartpuppeteer.puppeteer.Browser;
+  externalBrowserBool: boolean = false;
   private _readyDeferred: plugins.smartpromise.Deferred<void>;
   private _candidates: { [key: string]: PdfCandidate } = {};
 
@@ -16,9 +19,17 @@ export class SmartPdf {
     this._readyDeferred = new plugins.smartpromise.Deferred();
   }
 
-  async start() {
+  async start(headlessBrowserArg?) {
+    // lets set the external browser in case one is provided
+    this.headlessBrowser = headlessBrowserArg;
     // setup puppeteer
-    this.headlessBrowser = await plugins.puppeteer.launch();
+    if (this.headlessBrowser) {
+      this.externalBrowserBool = true;
+    } else {
+      this.headlessBrowser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance({
+        forceNoSandbox: true
+      });
+    }
 
     // setup server
     const app = plugins.express();
@@ -35,19 +46,24 @@ export class SmartPdf {
     });
   }
 
+  // stop
   async stop() {
     const done = plugins.smartpromise.defer<void>();
     this.htmlServerInstance.close(() => {
       done.resolve();
     });
-    await this.headlessBrowser.close();
+
+    if (!this.externalBrowserBool) {
+      await this.headlessBrowser.close();
+    }
+
     await done.promise;
   }
 
   /**
    * returns a pdf for a given html string;
    */
-  async getPdfForHtmlString(htmlStringArg: string) {
+  async getPdfResultForHtmlString(htmlStringArg: string): Promise<interfaces.IPdfResult> {
     await this._readyDeferred.promise;
     const pdfCandidate = new PdfCandidate(htmlStringArg);
     this._candidates[pdfCandidate.pdfId] = pdfCandidate;
@@ -63,43 +79,36 @@ export class SmartPdf {
       console.log(`id security check passed for ${pdfCandidate.pdfId}`);
     }
 
-    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;
-  }
-
-  async getPdfForWebsite(websiteUrl: string) {
-    const page = await this.headlessBrowser.newPage();
-    const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
-    const pdfId = plugins.smartunique.shortId();
-    await page.pdf({
-      path: plugins.path.join(paths.pdfDir, `${pdfId}.pdf`),
+    const pdfBuffer = await page.pdf({
       format: 'A4',
       printBackground: true,
       displayHeaderFooter: false,
       preferCSSPageSize: true
     });
     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 getFullWebsiteAsSinglePdf(websiteUrl: string) {
+  async getPdfResultForWebsite(websiteUrl: string): Promise<interfaces.IPdfResult> {
     const page = await this.headlessBrowser.newPage();
+    await page.emulateMedia('screen');
     const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
     const pdfId = plugins.smartunique.shortId();
-    const {documentHeight, documentWidth} = await page.evaluate(() => {
-      
+    const { documentHeight, documentWidth } = await page.evaluate(() => {
       return {
         documentHeight: document.height,
         documentWidth: document.width
       };
     });
-    await page.pdf({
-      path: plugins.path.join(paths.pdfDir, `${pdfId}.pdf`),
+    const pdfBuffer = await page.pdf({
+      format: 'A4',
       height: documentWidth,
       width: documentWidth,
       printBackground: true,
@@ -107,5 +116,37 @@ export class SmartPdf {
       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({
+      format: 'A4',
+      height: documentWidth,
+      width: documentWidth,
+      printBackground: true,
+      displayHeaderFooter: false,
+      preferCSSPageSize: true
+    });
+    await page.close();
+    return {
+      id: pdfId,
+      name: `${pdfId}.js`,
+      buffer: pdfBuffer
+    };
   }
 }

ts/smartpdf.paths.ts

@@ -1,6 +1,3 @@
 import * as plugins from './smartpdf.plugins';
 
 export const packageDir = plugins.path.join(__dirname, '../');
-export const pdfDir = plugins.path.join(packageDir, 'assets/pdfdir');
-
-plugins.smartfile.fs.ensureDirSync(pdfDir);

ts/smartpdf.plugins.ts

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