2.0.5

.gitignore

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

.gitlab-ci.yml

@@ -3,14 +3,14 @@ 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
 
 # ====================
 # security stage
@@ -18,21 +18,36 @@ 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
+
+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
@@ -41,37 +56,36 @@ snyk:
 testStable:
   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 npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - docker
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci command npm run build
+    - 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 lts
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -79,35 +93,39 @@ release:
 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:
-  - 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-dbase:npmci
-  services:
-   - docker:stable-dind
   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:
@@ -115,5 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+ignore: {}
+patch: {}

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "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"
+    }
+  ]
+}

.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

@@ -4,6 +4,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,42 +1,46 @@
 {
   "name": "@pushrocks/smartnetwork",
-  "version": "1.1.14",
+  "version": "2.0.5",
   "private": false,
   "description": "network diagnostics",
-  "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": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "tslint": "^5.19.0",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartstring": "^3.0.10",
-    "@types/default-gateway": "^3.0.0",
-    "@types/portscanner": "^2.1.0",
-    "default-gateway": "^5.0.3",
-    "portscanner": "^2.2.0",
-    "speedtest-net": "^1.5.1",
-    "systeminformation": "^4.14.8"
+    "@pushrocks/smartpromise": "^3.1.3",
+    "@pushrocks/smartstring": "^3.0.24",
+    "@types/default-gateway": "^3.0.1",
+    "isopen": "^1.3.0",
+    "public-ip": "^4.0.3",
+    "speed-cloudflare-cli": "^2.0.3",
+    "speedtest-net": "^2.1.1",
+    "systeminformation": "^5.6.12"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_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

@@ -8,13 +8,20 @@ network diagnostics
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartnetwork/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartnetwork/badges/master/build.svg)](https://gitlab.com/pushrocks/smartnetwork/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartnetwork/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartnetwork/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartnetwork.svg)](https://www.npmjs.com/package/@pushrocks/smartnetwork)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartnetwork/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartnetwork)
-[![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/smartnetwork/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartnetwork/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartnetwork)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartnetwork)](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/smartnetwork)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartnetwork)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartnetwork)](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
 
@@ -38,6 +45,10 @@ const run = async () => {
 };
 ```
 
+## 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)

test/test.ts

@@ -9,13 +9,13 @@ tap.test('should create a valid instance of SmartNetwork', async () => {
 });
 
 tap.test('should perform a speedtest', async () => {
-  let result = await testSmartNetwork.getSpeed();
-  console.log(`Download speed for this instance is ${result.speeds.download}`);
-  console.log(`Upload speed for this instance is ${result.speeds.upload}`);
+  const result = await testSmartNetwork.getSpeed();
+  // console.log(`Download speed for this instance is ${result.download.bandwidth}`);
+  // console.log(`Upload speed for this instance is ${result.download.bandwidth}`);
 });
 
 tap.test('should determine wether a port is free', async () => {
-  await expect(testSmartNetwork.isLocalPortAvailable(8080)).to.eventually.be.true;
+  await expect(testSmartNetwork.isLocalPortUnused(8080)).to.eventually.be.true;
 });
 
 tap.test('should scan a port', async () => {
@@ -34,4 +34,9 @@ tap.test('should get the default gateway', async () => {
   console.log(gatewayResult);
 });
 
+tap.test('should get public ips', async () => {
+  const ips = await testSmartNetwork.getPublicIps();
+  console.log(ips);
+});
+
 tap.start();

ts/smartnetwork.classes.smartnetwork.ts

@@ -1,34 +1,31 @@
 import * as plugins from './smartnetwork.plugins';
 
 export interface ISpeedtestData {
-  speeds: {
-    download: number;
-    upload: number;
-    originalDownload: number;
-    originalUpload: number;
-  };
-  client: {
-    ip: string;
-    lat: number;
-    lon: number;
-    isp: string;
-    isprating: string;
-    rating: number;
-    ispdlavg: number;
-    ispulavg: number;
+  timestamp: Date;
+  ping: { jitter: number; latency: number };
+  download: { bandwidth: number; bytes: number; elapsed: number };
+  upload: { bandwidth: number; bytes: number; elapsed: number };
+  packetLoss: number;
+  isp: string;
+  interface: {
+    internalIp: string;
+    name: string;
+    macAddr: string;
+    isVpn: false;
+    externalIp: string;
   };
   server: {
-    host: string;
-    lat: number;
-    lon: number;
+    id: number;
+    name: string;
     location: string;
     country: string;
-    cc: string;
-    sponsor: string;
-    distance: number;
-    distanceMi: number;
-    ping: number;
+    host: string;
+    port: number;
+    ip: string;
+  };
+  result: {
     id: string;
+    url: string;
   };
 }
 
@@ -40,16 +37,9 @@ export class SmartNetwork {
    * get network speed
    * @param measurementTime
    */
-  public async getSpeed(measurementTime = 5000): Promise<ISpeedtestData> {
-    const done = plugins.smartpromise.defer<ISpeedtestData>();
-    const test = plugins.speedtestNet({ maxTime: measurementTime });
-    test.on('data', data => {
-      done.resolve(data);
-    });
-    test.on('error', err => {
-      done.reject(err);
-    });
-    return await done.promise;
+  public async getSpeed() {
+    const test = null;
+    return test;
   }
 
   /**
@@ -57,7 +47,7 @@ export class SmartNetwork {
    * note: false also resolves with false as argument
    * @param port
    */
-  public async isLocalPortAvailable(port: number): Promise<boolean> {
+  public async isLocalPortUnused(port: number): Promise<boolean> {
     const doneIpV4 = plugins.smartpromise.defer<boolean>();
     const doneIpV6 = plugins.smartpromise.defer<boolean>();
     const net = await import('net'); // creates only one instance of net ;) even on multiple calls
@@ -83,7 +73,7 @@ export class SmartNetwork {
 
     // test IPv6 space
     const ipv6Test = net.createServer();
-    ipv6Test.once('error', function(err: any) {
+    ipv6Test.once('error', function (err: any) {
       if (err.code !== 'EADDRINUSE') {
         doneIpV6.resolve(false);
         return;
@@ -114,12 +104,9 @@ export class SmartNetwork {
     const domainPart = domainArg.split(':')[0];
     const port = portArg ? portArg : parseInt(domainArg.split(':')[1], 10);
 
-    plugins.portscanner.checkPortStatus(port, domainPart, (err, status) => {
-      if (err) {
-        // console.log(err);
-        return done.resolve(false);
-      }
-      if (status === 'open') {
+    plugins.isopen(domainPart, port, (response) => {
+      console.log(response);
+      if (response[port.toString()].isOpen) {
         done.resolve(true);
       } else {
         done.resolve(false);
@@ -134,7 +121,10 @@ export class SmartNetwork {
     return result;
   }
 
-  public async getDefaultGateway(): Promise<{ipv4: plugins.os.NetworkInterfaceInfo, ipv6: plugins.os.NetworkInterfaceInfo}> {
+  public async getDefaultGateway(): Promise<{
+    ipv4: plugins.os.NetworkInterfaceInfo;
+    ipv6: plugins.os.NetworkInterfaceInfo;
+  }> {
     const defaultGatewayName = await plugins.systeminformation.networkInterfaceDefault();
     if (!defaultGatewayName) {
       console.log('Cannot determine default gateway');
@@ -144,7 +134,16 @@ export class SmartNetwork {
     const defaultGateway = gateways[defaultGatewayName];
     return {
       ipv4: defaultGateway[0],
-      ipv6: defaultGateway[1]
+      ipv6: defaultGateway[1],
+    };
+  }
+
+  public async getPublicIps() {
+    return {
+      v4: await plugins.publicIp.v4({
+        timeout: 1000,
+        onlyHttps: true,
+      }),
     };
   }
 }

ts/smartnetwork.plugins.ts

@@ -1,9 +1,7 @@
 // native scope
 import * as os from 'os';
 
-export {
-  os
-};
+export { os };
 
 // @pushrocks scope
 import * as smartpromise from '@pushrocks/smartpromise';
@@ -11,9 +9,9 @@ import * as smartstring from '@pushrocks/smartstring';
 
 export { smartpromise, smartstring };
 
-// @third party scope 
-import * as portscanner from 'portscanner';
-import speedtestNet from 'speedtest-net';
+// @third party scope
+import isopen from 'isopen';
+import publicIp from 'public-ip';
 import * as systeminformation from 'systeminformation';
 
-export { speedtestNet, portscanner, systeminformation };
+export { isopen, publicIp, systeminformation };