1.0.20

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -49,14 +49,14 @@ testLTS:
   tags:
   - docker
   - notpriv
-    
+
-testSTABLE:
+testBuild:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm install
-  - npmci npm test
+  - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
@@ -65,7 +65,7 @@ testSTABLE:
 release:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -78,19 +78,11 @@ release:
 # ====================
 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/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm install
-        --env SOURCE_CODE="$PWD"
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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]
   tags:
   - docker
   - priv
@@ -106,7 +98,9 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:18-dind
   stage: metadata
   script:
     - npmci command npm install -g @gitzone/tsdoc

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-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartpdf",
-  "version": "1.0.8",
+  "version": "1.0.20",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -248,6 +248,15 @@
       "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartpromise/-/smartpromise-3.0.2.tgz",
       "integrity": "sha512-jmrJMUEmBCWChWK8CIcx4Vw3wv/8OgVNmkaxJrbs+WMaoRUfJtpWWJfrAwwHWt9ZXJbarJ+CwfwfYiiZXymndQ=="
     },
+    "@pushrocks/smartpuppeteer": {
+      "version": "1.0.5",
+      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartpuppeteer/-/smartpuppeteer-1.0.5.tgz",
+      "integrity": "sha512-7iD2mxQHXG5/6PwZY2wU6GQjNXy9dR5cLP/nvfjxXaelX/x3N1yagjPAuMYxuIqiTtVfrHC4Ehq+gnTZ4mSPow==",
+      "requires": {
+        "@types/puppeteer": "^1.12.4",
+        "puppeteer": "^1.17.0"
+      }
+    },
     "@pushrocks/smartrequest": {
       "version": "1.1.14",
       "resolved": "https://registry.npmjs.org/@pushrocks/smartrequest/-/smartrequest-1.1.14.tgz",
@@ -460,9 +469,9 @@
       "dev": true
     },
     "@types/node": {
-      "version": "12.0.3",
+      "version": "12.0.4",
-      "resolved": "https://verdaccio.lossless.one/@types%2fnode/-/node-12.0.3.tgz",
+      "resolved": "https://verdaccio.lossless.one/@types%2fnode/-/node-12.0.4.tgz",
-      "integrity": "sha512-zkOxCS/fA+3SsdA+9Yun0iANxzhQRiNwTvJSr6N95JhuJ/x27z9G2URx1Jpt3zYFfCGUXZGL5UDxt5eyLE7wgw=="
+      "integrity": "sha512-j8YL2C0fXq7IONwl/Ud5Kt0PeXw22zGERt+HSSnwbKOJVsAGkEz3sFCYwaF9IOuoG1HOtE0vKCj6sXF7Q0+Vaw=="
     },
     "@types/portscanner": {
       "version": "2.1.0",
@@ -611,7 +620,7 @@
     },
     "async-limiter": {
       "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/async-limiter/-/async-limiter-1.0.0.tgz",
+      "resolved": "https://verdaccio.lossless.one/async-limiter/-/async-limiter-1.0.0.tgz",
       "integrity": "sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg=="
     },
     "asynckit": {
@@ -815,7 +824,7 @@
     },
     "concat-stream": {
       "version": "1.6.2",
-      "resolved": "https://registry.npmjs.org/concat-stream/-/concat-stream-1.6.2.tgz",
+      "resolved": "https://verdaccio.lossless.one/concat-stream/-/concat-stream-1.6.2.tgz",
       "integrity": "sha512-27HBghJxjiZtIk3Ycvn/4kbJk/1uZuJFfuPEns6LaEvpvG1f0hTea8lilrouyo9mVc2GWdcEZ8OLoGmSADlrCw==",
       "requires": {
         "buffer-from": "^1.0.0",
@@ -1067,7 +1076,7 @@
     },
     "extract-zip": {
       "version": "1.6.7",
-      "resolved": "https://registry.npmjs.org/extract-zip/-/extract-zip-1.6.7.tgz",
+      "resolved": "https://verdaccio.lossless.one/extract-zip/-/extract-zip-1.6.7.tgz",
       "integrity": "sha1-qEC0uK9kAyZMjbV/Txp0Mz74H+k=",
       "requires": {
         "concat-stream": "1.6.2",
@@ -1078,7 +1087,7 @@
       "dependencies": {
         "debug": {
           "version": "2.6.9",
-          "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+          "resolved": "https://verdaccio.lossless.one/debug/-/debug-2.6.9.tgz",
           "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
           "requires": {
             "ms": "2.0.0"
@@ -1088,7 +1097,7 @@
     },
     "fd-slicer": {
       "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/fd-slicer/-/fd-slicer-1.0.1.tgz",
+      "resolved": "https://verdaccio.lossless.one/fd-slicer/-/fd-slicer-1.0.1.tgz",
       "integrity": "sha1-i1vL2ewyfFBBv5qwI/1nUPEXfmU=",
       "requires": {
         "pend": "~1.2.0"
@@ -1515,7 +1524,7 @@
     },
     "mkdirp": {
       "version": "0.5.1",
-      "resolved": "http://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz",
+      "resolved": "https://verdaccio.lossless.one/mkdirp/-/mkdirp-0.5.1.tgz",
       "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=",
       "requires": {
         "minimist": "0.0.8"
@@ -1523,7 +1532,7 @@
       "dependencies": {
         "minimist": {
           "version": "0.0.8",
-          "resolved": "http://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz",
+          "resolved": "https://verdaccio.lossless.one/minimist/-/minimist-0.0.8.tgz",
           "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0="
         }
       }
@@ -1742,7 +1751,7 @@
     },
     "pend": {
       "version": "1.2.0",
-      "resolved": "https://registry.npmjs.org/pend/-/pend-1.2.0.tgz",
+      "resolved": "https://verdaccio.lossless.one/pend/-/pend-1.2.0.tgz",
       "integrity": "sha1-elfrVQpng/kRUzH89GY9XI4AelA="
     },
     "pify": {
@@ -1786,7 +1795,7 @@
     },
     "proxy-from-env": {
       "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.0.0.tgz",
+      "resolved": "https://verdaccio.lossless.one/proxy-from-env/-/proxy-from-env-1.0.0.tgz",
       "integrity": "sha1-M8UDmPcOp+uW0h97gXYwpVeRx+4="
     },
     "pump": {
@@ -2227,7 +2236,7 @@
     },
     "typedarray": {
       "version": "0.0.6",
-      "resolved": "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz",
+      "resolved": "https://verdaccio.lossless.one/typedarray/-/typedarray-0.0.6.tgz",
       "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c="
     },
     "typescript": {
@@ -2427,7 +2436,7 @@
     },
     "yauzl": {
       "version": "2.4.1",
-      "resolved": "https://registry.npmjs.org/yauzl/-/yauzl-2.4.1.tgz",
+      "resolved": "https://verdaccio.lossless.one/yauzl/-/yauzl-2.4.1.tgz",
       "integrity": "sha1-lSj0QtqxsihOWLQ3m7GU4i4MQAU=",
       "requires": {
         "fd-slicer": "~1.0.1"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartpdf",
-  "version": "1.0.8",
+  "version": "1.0.20",
   "private": false,
   "description": "create pdfs on the fly",
   "main": "dist/index.js",
@@ -17,23 +17,23 @@
     "@gitzone/tsrun": "^1.2.6",
     "@gitzone/tstest": "^1.0.24",
     "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^12.0.3"
+    "@types/node": "^12.0.4"
   },
   "dependencies": {
     "@pushrocks/smartfile": "^7.0.2",
     "@pushrocks/smartnetwork": "^1.1.6",
     "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartpuppeteer": "^1.0.5",
     "@pushrocks/smartunique": "^3.0.1",
     "@types/express": "^4.16.1",
-    "@types/puppeteer": "^1.12.4",
+    "express": "^4.17.1"
-    "express": "^4.17.1",
-    "puppeteer": "^1.17.0"
   },
   "files": [
     "ts/*",
     "ts_web/*",
     "dist/*",
     "dist_web/*",
+    "dist_ts_web/*",
     "assets/*",
     "cli.js",
     "npmextra.json",

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)
+[![build status](https://gitlab.com/pushrocks/smartpdf/badges/master/build.svg)](https://gitlab.com/pushrocks/smartpdf/commits/master)
-[![coverage report](https://gitlab.om/pushrocks/smartpdf/badges/master/coverage.svg)](https://gitlab.om/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/)
@@ -21,6 +21,6 @@ Create PDFs fast and smoothly
 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

@@ -24,6 +24,19 @@ 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);
+  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 () => {
   await testSmartPdf.stop();
 });

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,15 @@ 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();
+    }
 
     // setup server
     const app = plugins.express();
@@ -35,19 +44,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 getPdfForHtmlString(htmlStringArg: string): Promise<interfaces.IPdfResult> {
     await this._readyDeferred.promise;
     const pdfCandidate = new PdfCandidate(htmlStringArg);
     this._candidates[pdfCandidate.pdfId] = pdfCandidate;
@@ -63,29 +77,37 @@ 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<interfaces.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',
       printBackground: true,
       displayHeaderFooter: false,
       preferCSSPageSize: true
     });
     await page.close();
+    return {
+      id: pdfId,
+      name: `${pdfId}.js`,
+      buffer: pdfBuffer
+    };
   }
 
   async getFullWebsiteAsSinglePdf(websiteUrl: string) {
@@ -93,15 +115,13 @@ export class SmartPdf {
     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({
+    const pdfBuffer = await page.pdf({
-      path: plugins.path.join(paths.pdfDir, `${pdfId}.pdf`),
       height: documentWidth,
       width: documentWidth,
       printBackground: true,
@@ -109,5 +129,10 @@ export class SmartPdf {
       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 };