2.0.1

.gitignore

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

.gitlab-ci.yml

@@ -1,16 +1,19 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -19,38 +22,42 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - 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
-  - notpriv
+  allow_failure: true
+
+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 node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
   stage: test
   script:
     - npmci npm prepare
@@ -60,7 +67,17 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
@@ -70,6 +87,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -78,20 +96,16 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   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 prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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:
+    - lossless
     - docker
     - priv
 
@@ -102,18 +116,20 @@ trigger:
   only:
     - tags
   tags:
+    - 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:

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,28 +0,0 @@
-# @pushrocks/smartbrowser
-puppeteer wrapper for easy tasks
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartbrowser)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartbrowser)
-* [github.com (source mirror)](https://github.com/pushrocks/smartbrowser)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartbrowser/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartbrowser/badges/master/build.svg)](https://gitlab.com/pushrocks/smartbrowser/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartbrowser/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartbrowser/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartbrowser.svg)](https://www.npmjs.com/package/@pushrocks/smartbrowser)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartbrowser/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartbrowser)
-[![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
-
-Use TypeScript for best in class instellisense.
-
-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)

npmextra.json

@@ -1,10 +1,9 @@
 {
   "npmci": {
-    "globalNpmTools": [
+    "npmAccessLevel": "public"
-      "npmts"
-    ]
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@pushrocks/smartbrowser",
-  "version": "1.0.11",
+  "version": "2.0.1",
   "description": "simplified puppeteer",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)",
+    "test": "(tstest test/ --web)",
-    "build": "echo \"Not needed for now\""
+    "build": "(tsbuild --web --allowimplicitany)"
   },
   "repository": {
     "type": "git",
@@ -19,25 +20,32 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartbrowser#README",
   "dependencies": {
-    "@pushrocks/smartpdf": "^1.0.6",
+    "@pushrocks/smartdelay": "^2.0.13",
-    "puppeteer": "^1.17.0"
+    "@pushrocks/smartpdf": "^3.0.1",
+    "@pushrocks/smartpuppeteer": "^2.0.0",
+    "@pushrocks/smartunique": "^3.0.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.61",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.69",
-    "@pushrocks/tapbundle": "^3.0.9",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "tslint": "^5.16.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
-  "private": true,
+  "private": false,
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_*/**/*",
-    "assets/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -0,0 +1,39 @@
+# @pushrocks/smartbrowser
+puppeteer wrapper for easy tasks
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartbrowser)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartbrowser)
+* [github.com (source mirror)](https://github.com/pushrocks/smartbrowser)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartbrowser/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartbrowser/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartbrowser/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartbrowser)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartbrowser)](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/smartbrowser)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartbrowser)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartbrowser)](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
+
+Use TypeScript for best in class instellisense.
+
+## 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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/assets/index.html

@@ -1,6 +0,0 @@
-<head>
-    <title>Test</title>
-</head>
-<body>
-    Test
-</body>

test/test.js

@@ -1,33 +0,0 @@
-"use strict";
-require("typings-test");
-const should = require("should");
-const smartbrowser = require("../dist/index");
-let testSmartBrowser;
-describe('smartbrowser', () => {
-    it('should instanstiate a new browser ', function () {
-        testSmartBrowser = new smartbrowser.Smartbrowser({
-            webroot: './test/assets/',
-            watchFiles: ['./test/assets/']
-        });
-        should(testSmartBrowser).be.instanceof(smartbrowser.Smartbrowser);
-    });
-    it('should start the browser ', function (done) {
-        testSmartBrowser.start().then((bsInstance) => {
-            done();
-        }).catch((err) => { console.log(err); });
-    });
-    it('should stop the browser ', function (done) {
-        this.timeout(10000);
-        setTimeout(() => {
-            testSmartBrowser.stop().then(() => {
-                done();
-            }).catch((err) => { console.log(err); });
-        }, 2000);
-    });
-    it('should exit correctly', function () {
-        setTimeout(() => {
-            process.exit(0);
-        }, 2000);
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQixpQ0FBZ0M7QUFFaEMsOENBQTZDO0FBRTdDLElBQUksZ0JBQTJDLENBQUE7QUFFL0MsUUFBUSxDQUFDLGNBQWMsRUFBRTtJQUNyQixFQUFFLENBQUMsb0NBQW9DLEVBQUU7UUFDckMsZ0JBQWdCLEdBQUcsSUFBSSxZQUFZLENBQUMsWUFBWSxDQUFDO1lBQzdDLE9BQU8sRUFBRSxnQkFBZ0I7WUFDekIsVUFBVSxFQUFFLENBQUMsZ0JBQWdCLENBQUM7U0FDakMsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDckUsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsMkJBQTJCLEVBQUUsVUFBVSxJQUFJO1FBQzFDLGdCQUFnQixDQUFDLEtBQUssRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDLFVBQVU7WUFDckMsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxHQUFHLE9BQU8sT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO0lBQzNDLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLDBCQUEwQixFQUFFLFVBQVUsSUFBSTtRQUN6QyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFBO1FBQ25CLFVBQVUsQ0FBQztZQUNQLGdCQUFnQixDQUFDLElBQUksRUFBRSxDQUFDLElBQUksQ0FBQztnQkFDekIsSUFBSSxFQUFFLENBQUE7WUFDVixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxHQUFHLE9BQU8sT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO1FBQzNDLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQTtJQUNaLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLHVCQUF1QixFQUFDO1FBQ3ZCLFVBQVUsQ0FBQztZQUNQLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUE7UUFDbkIsQ0FBQyxFQUFDLElBQUksQ0FBQyxDQUFBO0lBQ1gsQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQSJ9

test/test.ts

@@ -1,32 +1,36 @@
-import { tap, expect } from 'tapbundle';
+import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
-import * as smartdelay from 'smartdelay';
 
-import * as smartbrowser from '../dist/index';
+import * as smartbrowser from '../ts/index.js';
-let testSmartBrowser: smartbrowser.Smartbrowser;
+let testSmartBrowser: smartbrowser.SmartBrowser;
 
-tap
+tap.test('should instanstiate a new browser ', async () => {
-  .test('should instanstiate a new browser ', async () => {
+  testSmartBrowser = new smartbrowser.SmartBrowser();
-    testSmartBrowser = new smartbrowser.Smartbrowser({
+  return expect(testSmartBrowser).toBeInstanceOf(smartbrowser.SmartBrowser);
-      webroot: './test/assets/',
+});
-      watchFiles: ['./test/assets/']
+
+tap.test('should start the browser ', async () => {
+  await testSmartBrowser.start();
+});
+
+tap.test('should create a PDF from a page', async (tools) => {
+  const result = await testSmartBrowser.pdfFromPage('https://lossless.com');
+  expect(result.buffer).toBeInstanceOf(Buffer);
+});
+
+tap.test('should produce a valid screenshot', async (tools) => {
+  const result = await testSmartBrowser.screenshotFromPage('https://lossless.com');
+  expect(result.buffer).toBeInstanceOf(Buffer);
+});
+
+tap.test('should evalute something in the browser', async () => {
+  const result = await testSmartBrowser.evaluateOnPage('https://lossless.com', async () => {
+    return window.location.toString();
   });
-    return expect(testSmartBrowser).to.be.instanceof(smartbrowser.Smartbrowser);
+  console.log(result);
-  })
+});
-  .catch(tap.threw);
-
-tap
-  .test('should start the browser ', async () => {
-    return await expect(testSmartBrowser.start()).to.eventually.be.fulfilled;
-  })
-  .catch(tap.threw);
 
 tap.test('should stop the browser ', async () => {
-  return await smartdelay.delayFor(2000).then(() => {
+  await testSmartBrowser.stop();
-    return expect(testSmartBrowser.stop()).to.eventually.be.fulfilled;
-  });
-});
-tap.test('should exit correctly', async () => {
-  smartdelay.delayFor(2000).then(() => {
-    process.exit(0);
-  });
 });
+
+tap.start();

ts/index.ts

@@ -1,21 +1,73 @@
-import * as plugins from './smartbrowser.plugins';
+import * as plugins from './smartbrowser.plugins.js';
 
+import * as interfaces from './interfaces/index.js';
+
+/**
+ * SmartBrowser
+ */
 export class SmartBrowser {
-  puppeteer: plugins.puppeteer.Browser;
+  public headlessBrowser: plugins.smartpuppeteer.puppeteer.Browser;
-  smartpdf: plugins.smartpdf.SmartPdf;
+  public smartpdf: plugins.smartpdf.SmartPdf;
-  pdfFromPage(urlArg: string) {
-    this.smartpdf.getFullWebsiteAsSinglePdf(urlArg: );
-  }
 
+  /**
+   * start the SmartBrowser instance
+   */
   public async start() {
+    this.headlessBrowser = await plugins.smartpuppeteer.getEnvAwareBrowserInstance();
     this.smartpdf = new plugins.smartpdf.SmartPdf();
-    this.smartpdf.init();
+    await this.smartpdf.start(this.headlessBrowser);
   }
 
   /**
-   * stops the smartbrowser instance
+   * stop the SmartBrowser instance
    */
-  stop() {
+  public async stop() {
-    this.smartpdf.close();
+    await this.headlessBrowser.close();
+    await this.smartpdf.stop();
+  }
+
+  /**
+   * create a pdf from page
+   * @param urlArg
+   */
+  public pdfFromPage(urlArg: string) {
+    const result = this.smartpdf.getFullWebsiteAsSinglePdf(urlArg);
+    return result;
+  }
+
+  /**
+   * make a screenshot from a page
+   * @param urlArg
+   */
+  public async screenshotFromPage(urlArg: string): Promise<interfaces.IScreenShotResult> {
+    const pageId = plugins.smartunique.shortId();
+    const page = await this.headlessBrowser.newPage();
+    await page.goto(urlArg, {
+      waitUntil: 'networkidle2',
+    });
+    const screenshotBuffer = await page.screenshot({
+      encoding: 'binary',
+    }) as Buffer;
+    await page.close();
+    return {
+      name: pageId,
+      id: `${pageId}.js`,
+      buffer: screenshotBuffer,
+    };
+  }
+
+  /**
+   * evalutes an expression on a page
+   * @param urlArg
+   * @param funcArg
+   */
+  public async evaluateOnPage<T>(urlArg: string, funcArg: () => Promise<T>) {
+    const page = await this.headlessBrowser.newPage();
+    await page.goto(urlArg, {
+      waitUntil: 'networkidle2',
+    });
+    const result = await page.evaluate(funcArg);
+    await page.close();
+    return result;
   }
 }

ts/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './interfaces.screenshotresult.js';

ts/interfaces/interfaces.screenshotresult.ts

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

ts/smartbrowser.plugins.ts

@@ -1,9 +1,8 @@
 // pushrocks scope
 import * as smartpdf from '@pushrocks/smartpdf';
+import * as smartpuppeteer from '@pushrocks/smartpuppeteer';
+import * as smartunique from '@pushrocks/smartunique';
 
-export { smartpdf };
+export { smartpdf, smartpuppeteer, smartunique };
 
 // third party
-import * as puppeteer from 'puppeteer';
-
-export { puppeteer };