fix(core): update

.gitignore

@@ -1,8 +1,20 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
-dist/
 .cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,119 +1,122 @@
-# 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:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
 
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-  - npmci git mirror
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+  allow_failure: true
 
-snyk:
+auditDevDependencies:
+  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 config set registry https://registry.npmjs.org
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - 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 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 node install stable
+    - npmci npm install
+    - npmci npm 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 typescript
+    - npmci npm prepare
+    - npmci npm install
   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 typedoc typescript
-    - npmci npm prepare
+    - npmci node install stable
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +124,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,4 +1,15 @@
 {
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "webdetector",
+      "description": "detect things about from within a webapp",
+      "npmPackagename": "@pushrocks/webdetector",
+      "license": "MIT"
+    }
+  },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"

package.json

@@ -3,29 +3,41 @@
   "version": "1.0.5",
   "private": false,
   "description": "detect different environments within the browser",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(parcel build test/index.html --out-dir ./test/dist)",
+    "test": "(tstest test/)",
     "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "format": "(gitzone format)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "parcel-bundler": "^1.11.0",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsrun": "^1.2.42",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^20.2.6"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.2",
-    "@pushrocks/smartrx": "^2.0.3"
+    "@pushrocks/smartdelay": "^3.0.1",
+    "@pushrocks/smartrx": "^3.0.0"
   },
   "browserslist": [
     "last 1 version"
+  ],
+  "type": "module",
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
   ]
 }

readme.md

@@ -0,0 +1,36 @@
+# @pushrocks/webdetector
+detect things about from within a webapp
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/webdetector)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/webdetector)
+* [github.com (source mirror)](https://github.com/pushrocks/webdetector)
+* [docs (typedoc)](https://pushrocks.gitlab.io/webdetector/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/webdetector/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/webdetector/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/webdetector)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/webdetector)](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/webdetector)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/webdetector)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/webdetector)](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). :)
+
+For further information read the linked docs at the top of this readme.
+
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

test/index.html

@@ -1,7 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <script src="./test.ts"></script>
-  </head>
-  <body></body>
-</html>

test/test.both.ts

@@ -0,0 +1,26 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as webdetector from '../ts/index';
+let testWebDetector: webdetector.WebDetector;
+
+tap.test('first test', async () => {
+  const testWebDetector = new webdetector.WebDetector({
+    checkOnlineUrl: 'https://pubapi.lossless.one',
+  });
+
+  expect(testWebDetector).toBeInstanceOf(webdetector.WebDetector);
+});
+
+tap.test('should be online', async () => {
+  const onlineResultBoolean = await testWebDetector.isOnline();
+  console.log('browser is online:');
+  console.log(onlineResultBoolean);
+  testWebDetector.startPeriodicChecks();
+  testWebDetector.onlineObservable.subscribe((state) => {
+    console.log(state);
+  });
+});
+
+console.log('hi');
+
+tap.start();

test/test.ts

@@ -1,17 +0,0 @@
-import * as webdetector from '../ts/index'
-
-console.log('hi');
-
-const run = async () => {
-  const testWebDetector = new webdetector.WebDetector({
-    checkOnlineUrl: 'https://pubapi.lossless.one'
-  });
-  const onlineResultBoolean = await testWebDetector.isOnline();
-  console.log('browser is online:')
-  console.log(onlineResultBoolean);
-  testWebDetector.startPeriodicChecks();
-  testWebDetector.onlineObservable.subscribe((state) => {
-    console.log(state);
-  })
-}
-run();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/webdetector',
+  version: '1.0.6',
+  description: 'detect different environments within the browser'
+}

ts/index.ts

@@ -1,15 +1,20 @@
-import * as plugins from './webdetector.plugins';
+import * as plugins from './webdetector.plugins.js';
 
-import {throttleTime } from 'rxjs/operators';
+import { Platform } from './webdetector.classes.platform.js';
 
 export interface IWebDetectorOptions {
   checkOnlineUrl: string;
 }
 
 export class WebDetector {
+  // subclasses
+  public platform = new Platform();
+
   options: IWebDetectorOptions;
   private onlineObservableIntake = new plugins.smartrx.ObservableIntake();
-  onlineObservable = this.onlineObservableIntake.observable.pipe(throttleTime(10000));
+  public onlineObservable = this.onlineObservableIntake.observable.pipe(
+    plugins.smartrx.rxjs.ops.throttleTime(10000)
+  );
   latestState: 'online' | 'offline' = 'online';
 
   constructor(optionsArg: IWebDetectorOptions) {
@@ -27,20 +32,21 @@ export class WebDetector {
       controller.abort();
     }, 1000);
 
-    await fetchPromise.then(async response => {
-        reachesInternet = true
-    }).catch(err => {
-      // console.log(`request to ${this.options.checkOnlineUrl} failed}`)
-    });
+    await fetchPromise
+      .then(async (response) => {
+        reachesInternet = true;
+      })
+      .catch((err) => {
+        // console.log(`request to ${this.options.checkOnlineUrl} failed}`)
+      });
     const latestLocalState = (() => {
-      if(reachesInternet) {
-        return 'online'
+      if (reachesInternet) {
+        return 'online';
       } else {
-        return 'offline'
+        return 'offline';
       }
     })();
-    if(latestLocalState !== this.latestState) {
-      
+    if (latestLocalState !== this.latestState) {
       this.onlineObservableIntake.push(this.latestState);
     }
     this.latestState = latestLocalState;

ts/webdetector.classes.platform.ts

@@ -0,0 +1,25 @@
+export type TWebPlatform = 'android' | 'ios' | 'windows' | 'mac' | 'linux' | 'unknown';
+
+export class Platform {
+  public detectPlatform(): TWebPlatform {
+    const userAgent = navigator?.userAgent?.toLowerCase();
+
+    if (!userAgent) {
+      return 'unknown';
+    }
+
+    if (/android/.test(userAgent)) {
+      return 'android';
+    } else if (/iphone|ipad|ipod/.test(userAgent)) {
+      return 'ios';
+    } else if (/win/.test(userAgent)) {
+      return 'windows';
+    } else if (/mac/.test(userAgent)) {
+      return 'mac';
+    } else if (/linux/.test(userAgent)) {
+      return 'linux';
+    }
+
+    return 'unknown';
+  }
+}

ts/webdetector.plugins.ts

@@ -1,7 +1,4 @@
 import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartrx from '@pushrocks/smartrx';
 
-export {
-  smartdelay,
-  smartrx
-}
+export { smartdelay, smartrx };

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