2.0.0

.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,24 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  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 npm audit --audit-level=high
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +44,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 +87,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 +123,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -3,10 +3,8 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
   },
-  "npmts": {
-    "coverageTreshold": 50
-  },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,41 +1,42 @@
 {
   "name": "@pushrocks/smartupdate",
-  "version": "1.0.24",
+  "version": "2.0.0",
   "private": false,
   "description": "update your tools in a smart way",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.4",
-    "tslint": "^5.19.0",
+    "@gitzone/tsbuild": "^2.1.61",
+    "@gitzone/tsrun": "^1.2.32",
+    "@gitzone/tstest": "^1.0.70",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^17.0.23",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
     "@pushrocks/consolecolor": "^2.0.1",
-    "@pushrocks/npmextra": "^3.0.5",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartnpm": "^1.0.10",
-    "@pushrocks/smartopen": "^1.0.21",
-    "@pushrocks/smarttime": "^3.0.12",
-    "@pushrocks/smartversion": "^2.0.0"
+    "@pushrocks/npmextra": "^3.0.9",
+    "@pushrocks/smartnpm": "^2.0.0",
+    "@pushrocks/smartopen": "^2.0.0",
+    "@pushrocks/smarttime": "^3.0.45",
+    "@pushrocks/smartversion": "^2.0.7"
   },
   "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"

readme.md

@@ -8,13 +8,20 @@ update your tools in a smart way
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartupdate/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartupdate/badges/master/build.svg)](https://gitlab.com/pushrocks/smartupdate/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartupdate/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartupdate/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartupdate.svg)](https://www.npmjs.com/package/@pushrocks/smartupdate)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartupdate/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartupdate)
-[![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/smartupdate/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartupdate/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartupdate)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartupdate)](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/smartupdate)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartupdate)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartupdate)](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
 
@@ -34,12 +41,9 @@ await smartupdate.standardHandler.check(
 );
 ```
 
-For further information read the linked docs at the top of this README.
+## Contribution
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+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.
 

test/test.ts

@@ -1,12 +1,14 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartupdate from '../ts/index';
+import * as smartupdate from '../ts/index.js';
+
+let testSmartUpdate: smartupdate.SmartUpdate;
+
+tap.test('should create an instance of SmartUpdate', async () => {
+  testSmartUpdate = new smartupdate.SmartUpdate();
+});
 
 tap.test('should check for a npm module', async () => {
-  await smartupdate.standardHandler.check(
-    'lodash',
-    '1.0.5',
-    'http://gitzone.gitlab.io/npmts/changelog.html'
-  );
+  await testSmartUpdate.check('lodash', '1.0.5');
 });
 
 tap.start();

ts/index.ts

@@ -1,104 +1 @@
-import * as plugins from './smartupdate.plugins';
-
-import { TimeStamp } from '@pushrocks/smarttime';
-
-interface ICacheStatus {
-  lastCheck: number;
-  latestVersion: string;
-  performedUpgrade: boolean;
-}
-
-import { KeyValueStore } from '@pushrocks/npmextra';
-
-export class SmartUpdate {
-  public kvStore = new plugins.npmextra.KeyValueStore('custom', 'global_smartupdate');
-
-  public async check(npmnameArg: string, compareVersion: string, changelogUrlArg?: string) {
-    // the newData to write
-    const timeStamp = new TimeStamp();
-    const newData = {
-      lastCheck: timeStamp.milliSeconds,
-      latestVersion: 'x.x.x',
-      performedUpgrade: false
-    };
-
-    // the comparison data from the keyValue store
-    const result: ICacheStatus = await this.kvStore.readKey(npmnameArg);
-
-    if (result) {
-      const lastCheckTimeStamp = TimeStamp.fromMilliSeconds(result.lastCheck);
-      const tresholdTime = plugins.smarttime.getMilliSecondsFromUnits({ hours: 1 });
-      if (!lastCheckTimeStamp.isOlderThan(timeStamp, tresholdTime)) {
-        newData.lastCheck = lastCheckTimeStamp.milliSeconds;
-        const nextCheckInMinutes =
-          (tresholdTime - (timeStamp.milliSeconds - lastCheckTimeStamp.milliSeconds)) / 60000;
-        console.log(
-          `next update check in less than ${Math.floor(nextCheckInMinutes) + 1} minute(s): ` +
-            `${plugins.consolecolor.coloredString(
-              `${npmnameArg} has already been checked within the last hour.`,
-              'pink'
-            )}`
-        );
-        return;
-      }
-    }
-    const npmPackage = await this.getNpmPackageFromRegistry(npmnameArg);
-    if (!npmPackage) {
-      plugins.smartlog.defaultLogger.log('warn', 'failed to retrieve package information...');
-      plugins.smartlog.defaultLogger.log('info', 'npms.io might be down');
-      return;
-    }
-    newData.latestVersion = npmPackage.version;
-    const upgradeBool = await this.checkIfUpgrade(npmPackage, compareVersion, changelogUrlArg);
-    if (upgradeBool) {
-      // TODO:
-    }
-    this.kvStore.writeKey(npmnameArg, newData);
-  }
-
-  private async getNpmPackageFromRegistry(npmnameArg): Promise<plugins.smartnpm.NpmPackage> {
-    console.log(
-      `smartupdate: checking for newer version of ${plugins.consolecolor.coloredString(
-        npmnameArg,
-        'pink'
-      )}...`
-    );
-    const npmRegistry = new plugins.smartnpm.NpmRegistry();
-    const npmPackage = (await npmRegistry.search({ name: npmnameArg, boostExact: true }))[0];
-    return npmPackage;
-  }
-
-  private async checkIfUpgrade(
-    npmPackage: plugins.smartnpm.NpmPackage,
-    localVersionStringArg: string,
-    changelogUrlArg?: string
-  ) {
-    // create Version objects
-    const versionNpm = new plugins.smartversion.SmartVersion(npmPackage.version);
-    const versionLocal = new plugins.smartversion.SmartVersion(localVersionStringArg);
-    if (!versionNpm.greaterThan(versionLocal)) {
-      console.log(
-        `smartupdate: You are running the latest version of ${plugins.consolecolor.coloredString(
-          npmPackage.name,
-          'pink'
-        )}`
-      );
-      return false;
-    } else {
-      plugins.smartlog.defaultLogger.log(
-        'warn',
-        `There is a newer version of ${npmPackage.name} available on npm.`
-      );
-      plugins.smartlog.defaultLogger.log(
-        'warn',
-        `Your version: ${versionLocal.versionString} | version on npm: ${versionNpm.versionString}`
-      );
-      if (!process.env.CI && changelogUrlArg) {
-        console.log('trying to open changelog...');
-        plugins.smartopen.openUrl(changelogUrlArg);
-      }
-      return true;
-    }
-  }
-}
-export let standardHandler = new SmartUpdate();
+export { SmartUpdate } from './smartupdate.classes.smartupdate.js';

ts/smartupdate.classes.smartupdate.ts

@@ -0,0 +1,107 @@
+import * as plugins from './smartupdate.plugins.js';
+
+import { TimeStamp } from '@pushrocks/smarttime';
+
+interface ICacheStatus {
+  lastCheck: number;
+  latestVersion: string;
+  performedUpgrade: boolean;
+}
+
+import { KeyValueStore } from '@pushrocks/npmextra';
+
+export class SmartUpdate {
+  public npmRegistry: plugins.smartnpm.NpmRegistry;
+  public kvStore = new plugins.npmextra.KeyValueStore('custom', 'global_smartupdate');
+
+  constructor(optionsArg: plugins.smartnpm.INpmRegistryConstructorOptions = {}) {
+    this.npmRegistry = new plugins.smartnpm.NpmRegistry(optionsArg);
+  }
+
+  public async checkForCli(npmnameArg: string, compareVersion: string, changelogUrlArg?: string) {
+    // the newData to write
+    const timeStamp = new TimeStamp();
+    const newCacheData: ICacheStatus = {
+      lastCheck: timeStamp.milliSeconds,
+      latestVersion: 'x.x.x',
+      performedUpgrade: false
+    };
+
+    // the comparison data from the keyValue store
+    const retrievedCacheData: ICacheStatus = await this.kvStore.readKey(npmnameArg);
+
+    if (retrievedCacheData) {
+      const lastCheckTimeStamp = TimeStamp.fromMilliSeconds(retrievedCacheData.lastCheck);
+      const tresholdTime = plugins.smarttime.getMilliSecondsFromUnits({ hours: 1 });
+      if (!lastCheckTimeStamp.isOlderThan(timeStamp, tresholdTime)) {
+        newCacheData.lastCheck = lastCheckTimeStamp.milliSeconds;
+        const nextCheckInMinutes =
+          (tresholdTime - (timeStamp.milliSeconds - lastCheckTimeStamp.milliSeconds)) / 60000;
+        console.log(
+          `next update check in less than ${Math.floor(nextCheckInMinutes) + 1} minute(s): ` +
+            `${plugins.consolecolor.coloredString(
+              `${npmnameArg} has already been checked within the last hour.`,
+              'pink'
+            )}`
+        );
+        return false; // don't upgrade if checked within reasonable time
+      }
+    }
+
+    const upgradeBool = await this.check(npmnameArg, compareVersion, changelogUrlArg);
+    if (upgradeBool) {
+      const npmPackage = await this.npmRegistry.getPackageInfo(npmnameArg);
+      newCacheData.latestVersion = npmPackage.version;
+      this.kvStore.writeKey(npmnameArg, newCacheData);
+    }
+
+    return upgradeBool;
+  }
+
+  private async getNpmPackageFromRegistry(npmnameArg): Promise<plugins.smartnpm.NpmPackage> {
+    console.log(
+      `smartupdate: checking for newer version of ${plugins.consolecolor.coloredString(
+        npmnameArg,
+        'pink'
+      )}...`
+    );
+    const npmPackage = this.npmRegistry.getPackageInfo(npmnameArg);
+    return npmPackage;
+  }
+
+  public async check(
+    npmPackageName: string,
+    localVersionStringArg: string,
+    changelogUrlArg?: string
+  ) {
+    const npmPackage = await this.getNpmPackageFromRegistry(npmPackageName);
+    if (!npmPackage) {
+      console.log('warn: failed to retrieve package information...');
+      console.log('info: is the registry down?');
+      return;
+    }
+
+    // create Version objects
+    const versionNpm = new plugins.smartversion.SmartVersion(npmPackage.version);
+    const versionLocal = new plugins.smartversion.SmartVersion(localVersionStringArg);
+    if (!versionNpm.greaterThan(versionLocal)) {
+      console.log(
+        `smartupdate: You are running the latest version of ${plugins.consolecolor.coloredString(
+          npmPackage.name,
+          'pink'
+        )}`
+      );
+      return false;
+    } else {
+      console.log(`warn: There is a newer version of ${npmPackage.name} available on npm.`);
+      console.log(
+        `warn: Your version: ${versionLocal.versionString} | version on npm: ${versionNpm.versionString}`
+      );
+      if (!process.env.CI && changelogUrlArg) {
+        console.log('trying to open changelog...');
+        plugins.smartopen.openUrl(changelogUrlArg);
+      }
+      return true;
+    }
+  }
+}

ts/smartupdate.plugins.ts

@@ -1,5 +1,3 @@
-import * as smartlog from '@pushrocks/smartlog';
-smartlog.defaultLogger.enableConsole();
 import * as consolecolor from '@pushrocks/consolecolor';
 import * as npmextra from '@pushrocks/npmextra';
 import * as smartnpm from '@pushrocks/smartnpm';
@@ -7,4 +5,4 @@ import * as smartopen from '@pushrocks/smartopen';
 import * as smarttime from '@pushrocks/smarttime';
 import * as smartversion from '@pushrocks/smartversion';
 
-export { smartlog, consolecolor, npmextra, smartnpm, smartopen, smarttime, smartversion };
+export { consolecolor, npmextra, smartnpm, smartopen, smarttime, smartversion };