2.0.3

.gitignore

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

.gitlab-ci.yml

@@ -1,16 +1,19 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -18,102 +21,115 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
-  - notpriv
+    - 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 --ignore-scripts
-    - npmci command snyk test
+    - 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
-  - notpriv
+    - 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
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --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]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g @gitzone/tsdoc
+    - 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:
@@ -121,5 +137,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

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

npmextra.json

@@ -1,11 +1,12 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "smartpuppeteer",
       "shortDescription": "simplified access to puppeteer",
-      "npmPackagename": "@pushrocks/smartpuppeteer",
+      "npmPackagename": "@push.rocks/smartpuppeteer",
       "license": "MIT",
       "projectDomain": "push.rocks"
     }
@@ -13,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,34 +1,43 @@
 {
-  "name": "@pushrocks/smartpuppeteer",
-  "version": "1.0.2",
+  "name": "@push.rocks/smartpuppeteer",
+  "version": "2.0.3",
   "private": false,
   "description": "simplified access to puppeteer",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild)",
-    "format": "(gitzone format)"
+    "test": "tstest test/",
+    "build": "tsbuild --web --allowimplicitany"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@git.zone/tsbuild": "^2.1.63",
+    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tstest": "^1.0.71",
+    "@push.rocks/tapbundle": "^5.0.8",
+    "@types/node": "^20.12.7"
+  },
+  "dependencies": {
+    "@push.rocks/smartdelay": "^3.0.1",
+    "@push.rocks/smartshell": "^3.0.3",
+    "puppeteer": "^22.6.4",
+    "tree-kill": "^1.2.2"
   },
-  "dependencies": {},
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -1,26 +1,46 @@
-# @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/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartpuppeteer/badges/master/build.svg)](https://gitlab.com/pushrocks/smartpuppeteer/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartpuppeteer/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartpuppeteer/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartpuppeteer.svg)](https://www.npmjs.com/package/@pushrocks/smartpuppeteer)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartpuppeteer/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartpuppeteer)
-[![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/)
+
+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/@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/@push.rocks/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/@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
 
+Use TypeScript for best in class intellisense.
+
+```typescript
+const headlessBrowser = await smartpuppeteer.getEnvAwareBrowserInstance({
+  forceNoSandbox: true, // if you really want no sandbox, you can do this. Otherwise its starting things as necessary
+});
+await headlessBrowser.close();
+```
+
+## 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.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

@@ -1,8 +1,34 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartpuppeteer from '../ts/index';
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as smartpuppeteer from '../ts/index.js';
 
-tap.test('first test', async () => {
-  console.log(smartpuppeteer.standardExport);
+tap.test('should use pipe', async (tools) => {
+  const headlessBrowser = await smartpuppeteer.getEnvAwareBrowserInstance({
+    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();
+});
+
+tap.test('should get and stop an Incognito browser', async () => {
+  const incognitoInstance = new smartpuppeteer.IncognitoBrowser();
+  await incognitoInstance.start();
+  const page = await incognitoInstance.browser.newPage();
+  await incognitoInstance.stop();
 });
 
 tap.start();

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,3 +1,8 @@
-import * as plugins from './smartpuppeteer.plugins';
+// module exports
 
-export let standardExport = 'Hi there! :) This is an exported string';
+export * from './smartpuppeteer.classes.smartpuppeteer.js';
+export * from './smartpuppeteer.classes.incognitobrowser.js';
+
+// direct exports
+import { puppeteer } from './smartpuppeteer.plugins.js';
+export { puppeteer };

ts/smartpuppeteer.classes.incognitobrowser.ts

@@ -0,0 +1,50 @@
+import { getEnvAwareBrowserInstance } from './smartpuppeteer.classes.smartpuppeteer.js';
+import * as plugins from './smartpuppeteer.plugins.js';
+
+export class IncognitoBrowser {
+  public status: 'started' | 'stopped' = 'stopped';
+  public browser: plugins.puppeteer.Browser;
+
+  constructor() {}
+
+  /**
+   * starts the IncognitoBrowser
+   */
+  public async start() {
+    this.status = 'started';
+    this.browser = await getEnvAwareBrowserInstance();
+    this.browser.on('disconnected', async (eventArg) => {
+      try {
+        this.browser.removeAllListeners();
+      } catch (err) {}
+      if (this.status === 'started') {
+        this.browser = await getEnvAwareBrowserInstance();
+      }
+    });
+  }
+
+  /**
+   * stops the IncognitoBrowser
+   */
+  public async stop() {
+    this.status = 'stopped';
+    plugins.treeKill(this.browser.process()?.pid as number, 'SIGKILL');
+    await this.browser.close();
+  }
+
+  /**
+   * rotate
+   */
+  public async rotateBrowser() {
+    this.browser.close().catch();
+    this.browser = await getEnvAwareBrowserInstance();
+  }
+
+  public async getNewIncognitoContext(): Promise<plugins.puppeteer.BrowserContext> {
+    if (this.browser) {
+      return this.browser.createIncognitoBrowserContext();
+    } else {
+      throw new Error('you need to start the IncognitoBrowser instance first');
+    }
+  }
+}

ts/smartpuppeteer.classes.smartpuppeteer.ts

@@ -0,0 +1,41 @@
+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 options: IEnvAwareOptions = {
+    ...{
+      forceNoSandbox: false,
+    },
+    ...optionsArg,
+  };
+
+  let chromeArgs: string[] = [];
+  if (process.env.CI || options.forceNoSandbox || plugins.os.userInfo().username === 'root') {
+    chromeArgs = chromeArgs.concat(['--no-sandbox', '--disable-setuid-sandbox']);
+  }
+
+  let headlessBrowser: plugins.puppeteer.Browser;
+  console.log('launching puppeteer bundled chrome with arguments:');
+  console.log(chromeArgs);
+  headlessBrowser = await plugins.puppeteer.launch({
+    args: chromeArgs,
+    pipe: options.usePipe !== undefined ? options.usePipe : true,
+    headless: true,
+    ...(() => {
+      const returnObject: any = {};
+      const googleChrome = plugins.smartshell.which.sync('google-chrome');
+      if (googleChrome) {
+        returnObject.executablePath = googleChrome;
+      }
+      return returnObject;
+    })(),
+  });
+
+  return headlessBrowser;
+};

ts/smartpuppeteer.plugins.ts

@@ -1,2 +1,16 @@
-const removeme = {};
-export { removeme };
+// node native scope
+import * as os from 'os';
+
+export { os };
+
+// @pushrocks scope
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as smartshell from '@push.rocks/smartshell';
+
+export { smartdelay, smartshell };
+
+// third party scope
+import puppeteer from 'puppeteer';
+import treeKill from 'tree-kill';
+
+export { puppeteer, treeKill };

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"
-}