2.0.1

.gitignore

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

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# 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
 
 # ====================
 # security stage
@@ -18,109 +18,114 @@ 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 command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - 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
-  - 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
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - 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
-    
-testSTABLE:
+    - docker
+
+testBuild:
   stage: test
   script:
-  - 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 typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -128,15 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
-  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
+      - 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

@@ -1,8 +1,17 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "npmts"
-    ],
+    "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartnetwork",
+      "shortDescription": "network diagnostics",
+      "npmPackagename": "@pushrocks/smartnetwork",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,22 +1,45 @@
 {
   "name": "@pushrocks/smartnetwork",
-  "version": "1.1.0",
+  "version": "2.0.1",
   "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": "(tsrun test/test.ts)",
-    "build": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.1.9",
-    "@pushrocks/tapbundle": "^3.0.1"
+    "@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": "^2.0.5",
-    "speedtest-net": "^1.4.3"
-  }
+    "@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",
+    "speedtest-net": "^2.1.1",
+    "systeminformation": "^5.6.12"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,57 @@
+# @pushrocks/smartnetwork
+network diagnostics
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartnetwork)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartnetwork)
+* [github.com (source mirror)](https://github.com/pushrocks/smartnetwork)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartnetwork/)
+
+## Status for master
+
+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
+
+```typescript
+import * as smartnetwork from 'smartnetwork';
+const testSmartNetwork = new smartnetwork.SmartNetwork();
+const run = async () => {
+  // measure average speed over a period of 5 seconds
+  // the structure of speedResult is self explanatory using TypeScript (or the linked TypeDoc above)
+  const speedResult = testSmartNetwork.getSpeed(5000);
+
+  //
+  const isLocalPortAvailable: boolean = await testSmartNetwork.isLocalPortAvailable(1234);
+  const isRemotePortAvailable: boolean = await testSmartNetwork.isRemotePortAvailable(
+    'google.com:80'
+  );
+  const isRemotePortAvailable: boolean = await testSmartNetwork.isRemotePortAvailable(
+    'google.com',
+    80
+  );
+};
+```
+
+## 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

@@ -15,7 +15,28 @@ tap.test('should perform a speedtest', async () => {
 });
 
 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 () => {
+  await expect(testSmartNetwork.isRemotePortAvailable('lossless.com:443')).to.eventually.be.true;
+  await expect(testSmartNetwork.isRemotePortAvailable('lossless.com', 443)).to.be.eventually.true;
+  // await expect(testSmartNetwork.isRemotePortAvailable('lossless.com:444')).to.eventually.be.false;
+});
+
+tap.test('should get gateways', async () => {
+  const gatewayResult = await testSmartNetwork.getGateways();
+  console.log(gatewayResult);
+});
+
+tap.test('should get the default gateway', async () => {
+  const gatewayResult = await testSmartNetwork.getDefaultGateway();
+  console.log(gatewayResult);
+});
+
+tap.test('should get public ips', async () => {
+  const ips = await testSmartNetwork.getPublicIps();
+  console.log(ips);
 });
 
 tap.start();

ts/index.ts

@@ -1,103 +1 @@
-import * as plugins from './smartnetwork.plugins';
-
-export class 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;
-  };
-  server: {
-    host: string;
-    lat: number;
-    lon: number;
-    location: string;
-    country: string;
-    cc: string;
-    sponsor: string;
-    distance: number;
-    distanceMi: number;
-    ping: number;
-    id: string;
-  };
-}
-
-/**
- * SmartNetwork simplifies actions within the network
- */
-export class SmartNetwork {
-  async getSpeed(measurementTime = 5000): Promise<ISpeedtestData> {
-    let 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;
-  }
-
-  /**
-   * returns a promise with a boolean answer
-   * note: false also resolves with false as argument
-   * @param port
-   */
-  async isLocalPortAvailable(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
-
-    // test IPv4 space
-    const ipv4Test = net.createServer();
-    ipv4Test.once('error', function(err: any) {
-      if (err.code !== 'EADDRINUSE') {
-        doneIpV4.resolve(false);
-        return;
-      }
-      doneIpV4.resolve(false);
-    });
-    ipv4Test.once('listening', function() {
-      ipv4Test.once('close', () => {
-        doneIpV4.resolve(true);
-      });
-      ipv4Test.close();
-    });
-    ipv4Test.listen(port, '0.0.0.0');
-
-    await doneIpV4.promise;
-
-    // test IPv6 space
-    const test_ipv6 = net.createServer();
-    test_ipv6.once('error', function(err: any) {
-      if (err.code !== 'EADDRINUSE') {
-        doneIpV6.resolve(false);
-        return;
-      }
-      doneIpV6.resolve(false);
-    });
-    test_ipv6.once('listening', function() {
-      test_ipv6.once('close', () => {
-        doneIpV6.resolve(true);
-      });
-      test_ipv6.close();
-    });
-    test_ipv6.listen(port, '::');
-
-    // lets wait for the result
-    const resultIpV4 = await doneIpV4.promise;
-    const resultIpV6 = await doneIpV6.promise;
-    const result = resultIpV4 === true && resultIpV6 === true;
-    return result;
-  }
-}
+export * from './smartnetwork.classes.smartnetwork';

ts/smartnetwork.classes.smartnetwork.ts

@@ -0,0 +1,159 @@
+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;
+  };
+  server: {
+    host: string;
+    lat: number;
+    lon: number;
+    location: string;
+    country: string;
+    cc: string;
+    sponsor: string;
+    distance: number;
+    distanceMi: number;
+    ping: number;
+    id: string;
+  };
+}
+
+/**
+ * SmartNetwork simplifies actions within the network
+ */
+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;
+  }
+
+  /**
+   * returns a promise with a boolean answer
+   * note: false also resolves with false as argument
+   * @param port
+   */
+  public async isLocalPortAvailable(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
+
+    // test IPv4 space
+    const ipv4Test = net.createServer();
+    ipv4Test.once('error', (err: any) => {
+      if (err.code !== 'EADDRINUSE') {
+        doneIpV4.resolve(false);
+        return;
+      }
+      doneIpV4.resolve(false);
+    });
+    ipv4Test.once('listening', () => {
+      ipv4Test.once('close', () => {
+        doneIpV4.resolve(true);
+      });
+      ipv4Test.close();
+    });
+    ipv4Test.listen(port, '0.0.0.0');
+
+    await doneIpV4.promise;
+
+    // test IPv6 space
+    const ipv6Test = net.createServer();
+    ipv6Test.once('error', function (err: any) {
+      if (err.code !== 'EADDRINUSE') {
+        doneIpV6.resolve(false);
+        return;
+      }
+      doneIpV6.resolve(false);
+    });
+    ipv6Test.once('listening', () => {
+      ipv6Test.once('close', () => {
+        doneIpV6.resolve(true);
+      });
+      ipv6Test.close();
+    });
+    ipv6Test.listen(port, '::');
+
+    // lets wait for the result
+    const resultIpV4 = await doneIpV4.promise;
+    const resultIpV6 = await doneIpV6.promise;
+    const result = resultIpV4 === true && resultIpV6 === true;
+    return result;
+  }
+
+  /**
+   * checks wether a remote port is available
+   * @param domainArg
+   */
+  public async isRemotePortAvailable(domainArg: string, portArg?: number): Promise<boolean> {
+    const done = plugins.smartpromise.defer<boolean>();
+    const domainPart = domainArg.split(':')[0];
+    const port = portArg ? portArg : parseInt(domainArg.split(':')[1], 10);
+
+    plugins.isopen(domainPart, port, (response) => {
+      console.log(response);
+      if (response[port.toString()].isOpen) {
+        done.resolve(true);
+      } else {
+        done.resolve(false);
+      }
+    });
+    const result = await done.promise;
+    return result;
+  }
+
+  public async getGateways() {
+    const result = plugins.os.networkInterfaces();
+    return result;
+  }
+
+  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');
+      return null;
+    }
+    const gateways = await this.getGateways();
+    const defaultGateway = gateways[defaultGatewayName];
+    return {
+      ipv4: defaultGateway[0],
+      ipv6: defaultGateway[1],
+    };
+  }
+
+  public async getPublicIps() {
+    return {
+      v4: await plugins.publicIp.v4({
+        timeout: 1000,
+        onlyHttps: true,
+      }),
+    };
+  }
+}

ts/smartnetwork.plugins.ts

@@ -1,4 +1,18 @@
-let speedtestNet = require('speedtest-net');
-import * as smartpromise from '@pushrocks/smartpromise';
+// native scope
+import * as os from 'os';
 
-export { speedtestNet, smartpromise };
+export { os };
+
+// @pushrocks scope
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartstring from '@pushrocks/smartstring';
+
+export { smartpromise, smartstring };
+
+// @third party scope
+import isopen from 'isopen';
+import publicIp from 'public-ip';
+import speedtestNet from 'speedtest-net';
+import * as systeminformation from 'systeminformation';
+
+export { isopen, publicIp, speedtestNet, systeminformation };

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }