1.1.18

.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,23 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +43,40 @@ 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
+    - lossless
+    - docker
+    - priv
 
 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
+    - lossless
+    - docker
+    - notpriv
 
 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
@@ -81,33 +86,35 @@ codequality:
   allow_failure: true
   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 +122,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: {}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartnetwork",
-  "version": "1.1.14",
+  "version": "1.1.18",
   "private": false,
   "description": "network diagnostics",
   "main": "dist/index.js",
@@ -13,28 +13,29 @@
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "tslint": "^5.19.0",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "tslint": "^5.20.1",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartstring": "^3.0.10",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartstring": "^3.0.14",
     "@types/default-gateway": "^3.0.0",
     "@types/portscanner": "^2.1.0",
-    "default-gateway": "^5.0.3",
+    "default-gateway": "^5.0.5",
     "portscanner": "^2.2.0",
-    "speedtest-net": "^1.5.1",
-    "systeminformation": "^4.14.8"
+    "public-ip": "^4.0.0",
+    "speedtest-net": "^1.6.0",
+    "systeminformation": "^4.15.3"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -38,6 +38,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

@@ -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

@@ -134,7 +134,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');
@@ -147,4 +150,13 @@ export class SmartNetwork {
       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,10 @@ import * as smartstring from '@pushrocks/smartstring';
 
 export { smartpromise, smartstring };
 
-// @third party scope 
+// @third party scope
 import * as portscanner from 'portscanner';
+import publicIp from 'public-ip';
 import speedtestNet from 'speedtest-net';
 import * as systeminformation from 'systeminformation';
 
-export { speedtestNet, portscanner, systeminformation };
+export { portscanner, publicIp, speedtestNet, systeminformation };