2.1.8

.gitignore

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

.gitlab-ci.yml

@@ -19,22 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-snyk:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - 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
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - 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 --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -49,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.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,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/smarthash",
-  "version": "2.1.1",
+  "version": "2.1.8",
   "private": false,
   "description": "simplified access to node hash functions",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild)"
@@ -29,29 +29,33 @@
   },
   "homepage": "https://github.com/pushrocks/nodehash#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^12.12.11",
-    "tslint": "^5.20.1",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.9",
+    "@types/node": "^14.11.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartjson": "^3.0.8",
+    "@pushrocks/smartjson": "^4.0.2",
     "@pushrocks/smartpromise": "^3.0.6",
-    "@types/through2": "^2.0.34",
-    "through2": "^3.0.1"
+    "@types/through2": "^2.0.36",
+    "through2": "^4.0.2"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -0,0 +1,75 @@
+# @pushrocks/smarthash
+simplifies access to node hash functions
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarthash)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smarthash)
+* [github.com (source mirror)](https://github.com/pushrocks/smarthash)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smarthash/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smarthash/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smarthash/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smarthash)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smarthash)](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/smarthash)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smarthash)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smarthash)](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
+
+We recommend the use of TypeScript for best in class intellisense.
+
+```typescript
+import * as smarthash from "smarthash";
+
+// ======
+// sha265
+// ======
+
+// from stream
+let readStream = fs.createReadStream("./somefile.txt")
+smarthash.sha256FromStream(readStream)
+    .then((resultString){
+        console.log(resultString); // prints hash of the file
+    });
+
+// from file
+smarthash.sha256FromFile("./somefile.txt")
+    .then((resultString){
+        console.log(resultString); // prints hash of the file
+    });
+
+// from string
+smarthash.sha256FromString("some weird random string")
+    .then((resultString){
+        console.log(resultString); // prints hash of the file
+    });
+
+let hashString = smarthash.sha256FromStringSync("some weird random string");
+
+// ===
+// md5
+// ===
+smarthash.md5FromString('hellothere').then(md5String = {
+    // do something with it here
+})
+```
+
+## 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

@@ -17,7 +17,7 @@ tap.test('sha256fromStringSync should convert a String to sha256 hash synchronou
   expect(resultString).to.equal(compareString);
 });
 
-tap.test('sha256fromStream should convert a Stream to sha256', async tools => {
+tap.test('sha256fromStream should convert a Stream to sha256', async (tools) => {
   const readStream = fs.createReadStream('./test/testImageForHash.jpg');
   const resultString: string = await smarthash.sha256FromStream(readStream);
   expect(resultString).to.equal('45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c');
@@ -31,17 +31,17 @@ tap.test('sha256fromFile should convert a Stream to sha256', async () => {
 tap.test('should produce reproducible hash from Object', async () => {
   const hash1 = await smarthash.sha265FromObject({
     hithere: 1,
-    wow: 'two'
+    wow: 'two',
   });
 
   const hash2 = await smarthash.sha265FromObject({
     wow: 'two',
-    hithere: 1
+    hithere: 1,
   });
 
   const hash3 = await smarthash.sha265FromObject({
     wow: 'twoe',
-    hithere: 1
+    hithere: 1,
   });
   expect(hash1).to.equal(hash2);
   expect(hash1).to.not.equal(hash3);

ts/nodehash.helpers.ts

@@ -1,12 +1,12 @@
 import * as plugins from './nodehash.plugins';
 
-export const hashStreamPipeStop = resolveFuntion => {
+export const hashStreamPipeStop = (resolveFuntion) => {
   const forEach = (chunk: Buffer, enc, cb) => {
     resolveFuntion(chunk.toString('utf8'));
     cb(null, chunk);
   };
 
-  const atEnd = cb => {
+  const atEnd = (cb) => {
     cb();
   };
 

ts/nodehash.md5.ts

@@ -1,8 +1,5 @@
 import * as plugins from './nodehash.plugins';
 
 export const md5FromString = async (stringToHash: string) => {
-  return plugins.crypto
-    .createHash('md5')
-    .update(stringToHash)
-    .digest('hex');
+  return plugins.crypto.createHash('md5').update(stringToHash).digest('hex');
 };

ts/nodehash.sha256.ts

@@ -26,7 +26,7 @@ export const sha256FromFile = async (filePath: string): Promise<string> => {
 /**
  * Computes sha256 Hash from String synchronously
  */
-export let sha256FromStringSync = (stringArg): string => {
+export const sha256FromStringSync = (stringArg: string): string => {
   const hash = plugins.crypto.createHash('sha256');
   hash.update(stringArg);
   return hash.digest('hex');
@@ -46,7 +46,7 @@ export const sha256FromString = async (stringArg: string): Promise<string> => {
  * computes sha265 Hash from Object
  */
 export const sha265FromObject = async (objectArg: any): Promise<string> => {
-  const stringifiedObject = plugins.smartjson.Smartjson.stringify(objectArg, {});
+  const stringifiedObject = plugins.smartjson.stringify(objectArg, {});
   const hashResult = await sha256FromString(stringifiedObject);
   return hashResult;
 };