2.0.1

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,23 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+  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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +97,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "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"
+      "type": "node-terminal"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -1,8 +1,6 @@
 {
   "npmci": {
-    "globalNpmTools": [
-      "npmts"
-    ]
+    "npmAccessLevel": "public"
   },
   "gitzone": {
     "projectType": "npm",

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@pushrocks/smartbrowser",
-  "version": "1.0.15",
+  "version": "2.0.1",
   "description": "simplified puppeteer",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web --allowimplicitany)"
   },
   "repository": {
     "type": "git",
@@ -19,19 +20,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartbrowser#README",
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.9",
-    "@pushrocks/smartpdf": "^2.0.2",
-    "@pushrocks/smartpuppeteer": "^1.0.15",
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartpdf": "^3.0.1",
+    "@pushrocks/smartpuppeteer": "^2.0.0",
     "@pushrocks/smartunique": "^3.0.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tstest": "^1.0.32",
-    "@pushrocks/tapbundle": "^3.2.1",
-    "tslint": "^6.1.2",
+    "@gitzone/tsbuild": "^2.1.61",
+    "@gitzone/tstest": "^1.0.69",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
-  "private": true,
+  "private": false,
   "files": [
     "ts/**/*",
     "ts_web/**/*",
@@ -43,5 +44,8 @@
     "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/test.ts

@@ -1,36 +1,36 @@
-import { tap, expect } from '@pushrocks/tapbundle';
+import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
 
-import * as smartbrowser from '../ts/index';
+import * as smartbrowser from '../ts/index.js';
 let testSmartBrowser: smartbrowser.SmartBrowser;
 
 tap.test('should instanstiate a new browser ', async () => {
   testSmartBrowser = new smartbrowser.SmartBrowser();
-  return expect(testSmartBrowser).to.be.instanceof(smartbrowser.SmartBrowser);
+  return expect(testSmartBrowser).toBeInstanceOf(smartbrowser.SmartBrowser);
 });
 
 tap.test('should start the browser ', async () => {
-  await expect(testSmartBrowser.start()).to.eventually.be.fulfilled;
+  await testSmartBrowser.start();
 });
 
-tap.test('should create a PDF from a page', async tools => {
+tap.test('should create a PDF from a page', async (tools) => {
   const result = await testSmartBrowser.pdfFromPage('https://lossless.com');
-  expect(result.buffer).to.be.instanceOf(Buffer);
+  expect(result.buffer).toBeInstanceOf(Buffer);
 });
 
-tap.test('should produce a valid screenshot', async tools => {
+tap.test('should produce a valid screenshot', async (tools) => {
   const result = await testSmartBrowser.screenshotFromPage('https://lossless.com');
-  expect(result.buffer).to.be.instanceOf(Buffer);
+  expect(result.buffer).toBeInstanceOf(Buffer);
 });
 
 tap.test('should evalute something in the browser', async () => {
   const result = await testSmartBrowser.evaluateOnPage('https://lossless.com', async () => {
-    return 'hi';
+    return window.location.toString();
   });
   console.log(result);
 });
 
 tap.test('should stop the browser ', async () => {
-  await expect(testSmartBrowser.stop()).to.eventually.be.fulfilled;
+  await testSmartBrowser.stop();
 });
 
 tap.start();

ts/index.ts

@@ -1,6 +1,6 @@
-import * as plugins from './smartbrowser.plugins';
+import * as plugins from './smartbrowser.plugins.js';
 
-import * as interfaces from './interfaces';
+import * as interfaces from './interfaces/index.js';
 
 /**
  * SmartBrowser
@@ -43,16 +43,16 @@ export class SmartBrowser {
     const pageId = plugins.smartunique.shortId();
     const page = await this.headlessBrowser.newPage();
     await page.goto(urlArg, {
-      waitUntil: 'networkidle2'
+      waitUntil: 'networkidle2',
     });
     const screenshotBuffer = await page.screenshot({
-      encoding: 'binary'
-    });
+      encoding: 'binary',
+    }) as Buffer;
     await page.close();
     return {
       name: pageId,
       id: `${pageId}.js`,
-      buffer: screenshotBuffer
+      buffer: screenshotBuffer,
     };
   }
 
@@ -64,7 +64,7 @@ export class SmartBrowser {
   public async evaluateOnPage<T>(urlArg: string, funcArg: () => Promise<T>) {
     const page = await this.headlessBrowser.newPage();
     await page.goto(urlArg, {
-      waitUntil: 'networkidle2'
+      waitUntil: 'networkidle2',
     });
     const result = await page.evaluate(funcArg);
     await page.close();

ts/interfaces/index.ts

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