2.0.5

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,60 +18,74 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci command npm run build
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -79,35 +93,39 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:18-dind
   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:
@@ -115,5 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -4,6 +4,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,42 +1,47 @@
 {
   "name": "@pushrocks/smartpdf",
-  "version": "1.0.22",
+  "version": "2.0.5",
   "private": false,
   "description": "create pdfs on the fly",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "format": "(gitzone format)",
+    "build": "(tsbuild --web)"
-    "build": "(tsbuild)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^12.12.7"
+    "@types/node": "^14.14.31",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.6",
+    "@pushrocks/smartfile": "^8.0.8",
-    "@pushrocks/smartnetwork": "^1.1.14",
+    "@pushrocks/smartnetwork": "^1.1.22",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.3",
-    "@pushrocks/smartpuppeteer": "^1.0.5",
+    "@pushrocks/smartpuppeteer": "^1.0.21",
-    "@pushrocks/smartunique": "^3.0.1",
+    "@pushrocks/smartunique": "^3.0.3",
-    "@types/express": "^4.17.2",
+    "@types/express": "^4.17.11",
     "express": "^4.17.1"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_*/**/*",
-    "dist_ts_web/*",
+    "dist_ts/**/*",
-    "assets/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,16 +8,32 @@ Create PDFs fast and smoothly
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartpdf/)
 
 ## Status for 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)
+Status Category | Status Badge
-[![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)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartpdf/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartpdf/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartpdf)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartpdf)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartpdf)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartpdf)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartpdf)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## 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). :)
+
+
+## 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)

test/test.ts

@@ -13,15 +13,15 @@ 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 () => {

ts/smartpdf.classes.smartpdf.ts

@@ -26,7 +26,9 @@ export class SmartPdf {
     if (this.headlessBrowser) {
       this.externalBrowserBool = true;
     } else {
-      this.headlessBrowser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance();
+      this.headlessBrowser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance({
+        forceNoSandbox: true,
+      });
     }
 
     // setup server
@@ -61,13 +63,13 @@ export class SmartPdf {
   /**
    * returns a pdf for a given html string;
    */
-  async getPdfForHtmlString(htmlStringArg: string): Promise<interfaces.IPdfResult> {
+  async getPdfResultForHtmlString(htmlStringArg: string): Promise<interfaces.IPdfResult> {
     await this._readyDeferred.promise;
     const pdfCandidate = new PdfCandidate(htmlStringArg);
     this._candidates[pdfCandidate.pdfId] = pdfCandidate;
     const page = await this.headlessBrowser.newPage();
     const response = await page.goto(`http://localhost:3210/${pdfCandidate.pdfId}`, {
-      waitUntil: 'networkidle2'
+      waitUntil: 'networkidle2',
     });
     const headers = response.headers();
     if (headers['pdf-id'] !== pdfCandidate.pdfId) {
@@ -78,7 +80,10 @@ export class SmartPdf {
     }
 
     const pdfBuffer = await page.pdf({
-      format: 'A4'
+      format: 'A4',
+      printBackground: true,
+      displayHeaderFooter: false,
+      preferCSSPageSize: true,
     });
     await page.close();
     delete this._candidates[pdfCandidate.pdfId];
@@ -87,52 +92,61 @@ export class SmartPdf {
     return {
       id: pdfCandidate.pdfId,
       name: `${pdfCandidate.pdfId}.js`,
-      buffer: pdfBuffer
+      buffer: pdfBuffer,
     };
   }
 
-  async getPdfForWebsite(websiteUrl: string): Promise<interfaces.IPdfResult> {
+  async getPdfResultForWebsite(websiteUrl: string): Promise<interfaces.IPdfResult> {
     const page = await this.headlessBrowser.newPage();
-    page.emulateMedia('screen');
+    await page.emulateMediaType('screen');
-    const response = await page.goto(websiteUrl, { waitUntil: 'networkidle2' });
-    const pdfId = plugins.smartunique.shortId();
-    const pdfBuffer = await page.pdf({
-      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
+        documentWidth: document.width,
       };
     });
     const pdfBuffer = await page.pdf({
+      format: 'A4',
       height: documentWidth,
       width: documentWidth,
       printBackground: true,
       displayHeaderFooter: false,
-      preferCSSPageSize: true
+      preferCSSPageSize: true,
     });
     await page.close();
     return {
       id: pdfId,
       name: `${pdfId}.js`,
-      buffer: pdfBuffer
+      buffer: pdfBuffer,
+    };
+  }
+
+  async getFullWebsiteAsSinglePdf(websiteUrl: string) {
+    const page = await this.headlessBrowser.newPage();
+    page.emulateMediaType('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,
     };
   }
 }