update description

.gitignore

@@ -1,6 +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,131 +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
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - 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 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
-    
-testSTABLE:
+    - docker
+
+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 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 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:
@@ -133,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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

license

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
+Copyright (c) 2022 Lossless GmbH (hello@lossless.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

npmextra.json

@@ -1,6 +1,30 @@
 {
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartping",
+      "description": "A utility for performing ping operations in Node.js environments.",
+      "npmPackagename": "@push.rocks/smartping",
+      "license": "MIT",
+      "projectDomain": "push.rocks",
+      "keywords": [
+        "ping",
+        "network",
+        "connectivity",
+        "Node.js",
+        "utility",
+        "async",
+        "promise"
+      ]
+    }
+  },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "tsdoc": {
+    "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,26 +1,58 @@
 {
-  "name": "@pushrocks/smartping",
-  "version": "1.0.2",
+  "name": "@push.rocks/smartping",
+  "version": "1.0.8",
   "private": false,
-  "description": "ping urls and ips",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "description": "A utility for performing ping operations in Node.js environments.",
+  "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)"
-  },
-  "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"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "(tsdoc)"
   },
   "dependencies": {
-    "ping": "^0.2.2"
+    "@types/ping": "^0.4.1",
+    "ping": "^0.4.4"
+  },
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbundle": "^2.0.5",
+    "@gitzone/tsdoc": "^1.1.10",
+    "@gitzone/tsrun": "^1.2.39",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^18.15.11"
+  },
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "keywords": [
+    "ping",
+    "network",
+    "connectivity",
+    "Node.js",
+    "utility",
+    "async",
+    "promise"
+  ],
+  "homepage": "https://code.foss.global/push.rocks/smartping",
+  "repository": {
+    "type": "git",
+    "url": "https://code.foss.global/push.rocks/smartping.git"
   }
-}
+}

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -0,0 +1,123 @@
+# @push.rocks/smartping
+a ping utility
+
+## Install
+
+To install `@push.rocks/smartping`, run the following command in your project directory:
+
+```bash
+npm install @push.rocks/smartping --save
+```
+
+This command adds `@push.rocks/smartping` to your project's dependencies and ensures you can begin utilizing it to manage your network ping needs efficiently.
+
+## Usage
+
+`@push.rocks/smartping` leverages TypeScript and ESM syntax for a seamless development experience, offering straightforward methods to conduct ping operations within your applications.
+
+Before diving into the usage scenarios, ensure that you import the module in your TypeScript files using:
+
+```typescript
+import { Smartping } from '@push.rocks/smartping';
+```
+
+### Basic Ping
+
+To perform a basic ping operation to check the reachability of a host, you can do the following:
+
+```typescript
+import { Smartping } from '@push.rocks/smartping';
+
+const pingInstance = new Smartping();
+
+async function basicPing() {
+  const pingResponse = await pingInstance.ping('google.com');
+  console.log(pingResponse);
+}
+
+basicPing();
+```
+
+This will output the ping response from `google.com`, including whether the host is alive, the time it took for the response, and other detailed information.
+
+### Ping with Timeout
+
+Sometimes, you may want to specify a timeout for the ping operation to avoid long waiting times if the host is not reachable. You can easily do this as follows:
+
+```typescript
+import { Smartping } from '@push.rocks/smartping';
+
+const pingInstance = new Smartping();
+
+async function pingWithTimeout() {
+  const pingResponse = await pingInstance.ping('google.com', 1000); // Timeout set to 1000 milliseconds
+  console.log(pingResponse);
+}
+
+pingWithTimeout();
+```
+
+### Checking if Host is Alive
+
+If you're only interested in whether a host is alive without the need for detailed ping information, you can use the `pingAlive` method:
+
+```typescript
+import { Smartping } from '@push.rocks/smartping';
+
+const pingInstance = new Smartping();
+
+async function checkHostAlive() {
+  const isAlive = await pingInstance.pingAlive('google.com');
+  console.log(`Is Google alive? ${isAlive}`);
+}
+
+checkHostAlive();
+```
+
+This method is particularly useful for quickly verifying the availability of a server or an API endpoint.
+
+### Advanced Usage Scenarios
+
+`@push.rocks/smartping` can be integrated into health-check mechanisms, automated network diagnostics, server monitoring tools, or any application requiring network communication verification. Its straightforward API and promise-based architecture allow it to be seamlessly incorporated into asynchronous flow control, enhancing both the development experience and performance.
+
+### Error Handling
+
+While using `@push.rocks/smartping`, you might encounter errors, particularly when dealing with unreachable hosts or network issues. It is recommended to implement proper error handling to manage such scenarios gracefully:
+
+```typescript
+async function safePingWithTimeout() {
+  try {
+    const pingResponse = await pingInstance.ping('google.com', 500);
+    console.log(pingResponse);
+  } catch (error) {
+    console.error('Ping operation failed:', error);
+  }
+}
+
+safePingWithTimeout();
+```
+
+### Wrapping Up
+
+Whether integrating into existing applications for network diagnostics or constructing a new solution requiring ping capabilities, `@push.rocks/smartping` provides an efficient and easy-to-use interface to accomplish these tasks with minimal code. Its design and implementation cater to modern development practices, promoting clean and maintainable code.
+
+For more complex scenarios or contributions, please consult the documentation and source code available on GitHub and NPM. Contributions are always welcome to enhance the module's capabilities and address the evolving needs of developers and applications alike.
+
+## License and Legal Information
+
+This 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. 
+
+**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.
+
+### Trademarks
+
+This 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.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By 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.

test/test.ts

@@ -1,8 +1,20 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartping from '../ts/index'
+import { expect, expectAsync, tap } from '@pushrocks/tapbundle';
+import * as smartping from '../ts/index.js';
 
-tap.test('first test', async () => {
-  console.log(smartping.standardExport)
+let testPing: smartping.Smartping;
+
+tap.test('should create an instance of Smartping', async () => {
+  testPing = new smartping.Smartping();
+  expect(testPing).toBeInstanceOf(smartping.Smartping);
+});
+
+tap.test('should deliver a ping result', async () => {
+  const result = await testPing.ping('lossless.com', 1000);
+  console.log(result);
 })
 
-tap.start()
+tap.test('should detect alive', async () => {
+  await expectAsync(testPing.pingAlive('lossless.com', 1000)).toBeTrue();
+})
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartping',
+  version: '1.0.8',
+  description: 'a ping utility'
+}

ts/index.ts

@@ -1,3 +1 @@
-import * as plugins from './smartping.plugins';
-
-export let standardExport = 'Hi there! :) This is an exported string';
+export * from './smartping.classes.smartping.js';

ts/smartping.classes.smartping.ts

@@ -0,0 +1,22 @@
+import * as plugins from './smartping.plugins.js';
+
+export class Smartping {
+  public async ping(hostArg: string, timeoutArg: number = 500): Promise<plugins.ping.PingResponse> {
+    const result = await plugins.ping.promise.probe(hostArg, {
+      timeout: timeoutArg
+    })
+    return result;
+  }
+
+  public async pingAlive(hostArg: string, timeoutArg: number = 500): Promise<boolean> {
+    const result = await plugins.ping.promise.probe(hostArg, {
+      timeout: timeoutArg
+    }).catch();
+    //console.log(result);
+    if (result.alive) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+}

ts/smartping.plugins.ts

@@ -1,4 +1,4 @@
-import * as ping from 'ping';
+import ping from 'ping';
 
 export {
   ping

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