2.0.3

.gitlab-ci.yml

@@ -7,10 +7,58 @@ cache:
   key: '$CI_BUILD_STAGE'
 
 stages:
-  - only
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+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 --only=dev
+  tags:
+    - docker
+  allow_failure: true
+
+# ====================
+# test stage
+# ====================
 
 testStable:
-  stage: only
+  stage: test
   script:
     - npmci npm prepare
     - npmci node install stable
@@ -20,3 +68,74 @@ testStable:
   tags:
     - docker
 
+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
+  script:
+    - npmci node install stable
+    - npmci npm publish
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+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:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install lts
+    - npmci command npm install -g @git.zone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - public
+  allow_failure: true

npmextra.json

@@ -2,11 +2,11 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartpuppeteer",
       "shortDescription": "simplified access to puppeteer",
-      "npmPackagename": "@pushrocks/smartpuppeteer",
+      "npmPackagename": "@push.rocks/smartpuppeteer",
       "license": "MIT",
       "projectDomain": "push.rocks"
     }
@@ -14,5 +14,8 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "tsdocs": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,30 +1,28 @@
 {
-  "name": "@pushrocks/smartpuppeteer",
+  "name": "@push.rocks/smartpuppeteer",
-  "version": "1.0.35",
+  "version": "2.0.3",
   "private": false,
   "description": "simplified access to puppeteer",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "tstest test/",
-    "build": "(tsbuild --web)",
+    "build": "tsbuild --web --allowimplicitany"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.28",
+    "@git.zone/tsbuild": "^2.1.63",
-    "@gitzone/tstest": "^1.0.59",
+    "@git.zone/tsrun": "^1.2.46",
-    "@pushrocks/tapbundle": "^3.2.14",
+    "@git.zone/tstest": "^1.0.71",
-    "@types/node": "^16.11.6",
+    "@push.rocks/tapbundle": "^5.0.8",
-    "tslint": "^6.1.3",
+    "@types/node": "^20.12.7"
-    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.13",
+    "@push.rocks/smartdelay": "^3.0.1",
-    "@pushrocks/smartenv": "^4.0.16",
+    "@push.rocks/smartshell": "^3.0.3",
-    "@pushrocks/smartshell": "^2.0.29",
+    "puppeteer": "^22.6.4",
-    "puppeteer": "^11.0.0",
     "tree-kill": "^1.2.2"
   },
   "files": [

readme.md

@@ -1,8 +1,8 @@
-# @pushrocks/smartpuppeteer
+# @push.rocks/smartpuppeteer
 simplified access to puppeteer
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpuppeteer)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartpuppeteer)
 * [gitlab.com (source)](https://gitlab.com/pushrocks/smartpuppeteer)
 * [github.com (source mirror)](https://github.com/pushrocks/smartpuppeteer)
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartpuppeteer/)
@@ -13,14 +13,14 @@ Status Category | Status Badge
 -- | --
 GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartpuppeteer/badges/master/pipeline.svg)](https://lossless.cloud)
 GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartpuppeteer/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartpuppeteer)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartpuppeteer)](https://lossless.cloud)
 Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartpuppeteer)](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/smartpuppeteer)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartpuppeteer)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartpuppeteer)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartpuppeteer)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartpuppeteer)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartpuppeteer)](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

test/test.ts

@@ -1,11 +1,26 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
-import * as smartpuppeteer from '../ts/index';
+import * as smartpuppeteer from '../ts/index.js';
 
-tap.test('first test', async (tools) => {
+tap.test('should use pipe', async (tools) => {
   const headlessBrowser = await smartpuppeteer.getEnvAwareBrowserInstance({
-    forceNoSandbox: true,
+    forceNoSandbox: false,
   });
   const page = await headlessBrowser.newPage();
+  await page.goto('https://lossless.com');
+  console.log(await page.title());
+  expect(headlessBrowser.wsEndpoint()).toEqual('');
+  await headlessBrowser.close();
+});
+
+tap.test('should use websocket', async (tools) => {
+  const headlessBrowser = await smartpuppeteer.getEnvAwareBrowserInstance({
+    forceNoSandbox: false,
+    usePipe: false,
+  });
+  const page = await headlessBrowser.newPage();
+  await page.goto('https://lossless.com');
+  console.log(await page.title());
+  expect(headlessBrowser.wsEndpoint()).not.toEqual('');
   await headlessBrowser.close();
 });
 

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartpuppeteer',
+  version: '2.0.3',
+  description: 'simplified access to puppeteer'
+}

ts/index.ts

@@ -1,8 +1,8 @@
 // module exports
 
-export * from './smartpuppeteer.classes.smartpuppeteer';
+export * from './smartpuppeteer.classes.smartpuppeteer.js';
-export * from './smartpuppeteer.classes.incognitobrowser';
+export * from './smartpuppeteer.classes.incognitobrowser.js';
 
 // direct exports
-import { puppeteer } from './smartpuppeteer.plugins';
+import { puppeteer } from './smartpuppeteer.plugins.js';
 export { puppeteer };

ts/smartpuppeteer.classes.incognitobrowser.ts

@@ -1,5 +1,5 @@
-import { getEnvAwareBrowserInstance } from './smartpuppeteer.classes.smartpuppeteer';
+import { getEnvAwareBrowserInstance } from './smartpuppeteer.classes.smartpuppeteer.js';
-import * as plugins from './smartpuppeteer.plugins';
+import * as plugins from './smartpuppeteer.plugins.js';
 
 export class IncognitoBrowser {
   public status: 'started' | 'stopped' = 'stopped';
@@ -28,7 +28,7 @@ export class IncognitoBrowser {
    */
   public async stop() {
     this.status = 'stopped';
-    plugins.treeKill(this.browser.process().pid, 'SIGKILL');
+    plugins.treeKill(this.browser.process()?.pid as number, 'SIGKILL');
     await this.browser.close();
   }
 

ts/smartpuppeteer.classes.smartpuppeteer.ts

@@ -1,13 +1,13 @@
-import * as plugins from './smartpuppeteer.plugins';
+import * as plugins from './smartpuppeteer.plugins.js';
 
 export interface IEnvAwareOptions {
   forceNoSandbox?: boolean;
+  usePipe?: boolean;
 }
 
 export const getEnvAwareBrowserInstance = async (
   optionsArg: IEnvAwareOptions = {}
 ): Promise<plugins.puppeteer.Browser> => {
-  const smartenv = new plugins.smartenv.Smartenv();
   const options: IEnvAwareOptions = {
     ...{
       forceNoSandbox: false,
@@ -25,16 +25,16 @@ export const getEnvAwareBrowserInstance = async (
   console.log(chromeArgs);
   headlessBrowser = await plugins.puppeteer.launch({
     args: chromeArgs,
-    pipe: true,
+    pipe: options.usePipe !== undefined ? options.usePipe : true,
     headless: true,
     ...(() => {
       const returnObject: any = {};
-      const googleChrome = plugins.smartshell.which.sync('google-chrome')
+      const googleChrome = plugins.smartshell.which.sync('google-chrome');
-      if(googleChrome) {
+      if (googleChrome) {
-        returnObject.executablePath = googleChrome
+        returnObject.executablePath = googleChrome;
       }
       return returnObject;
-    })()
+    })(),
   });
 
   return headlessBrowser;

ts/smartpuppeteer.plugins.ts

@@ -4,11 +4,10 @@ import * as os from 'os';
 export { os };
 
 // @pushrocks scope
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartdelay from '@push.rocks/smartdelay';
-import * as smartenv from '@pushrocks/smartenv';
+import * as smartshell from '@push.rocks/smartshell';
-import * as smartshell from '@pushrocks/smartshell';
 
-export { smartdelay, smartenv, smartshell };
+export { smartdelay, smartshell };
 
 // third party scope
 import puppeteer from 'puppeteer';

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}