2.1.1

.gitignore

@@ -1,4 +1,22 @@
-node_modules/
-docs/
+.nogit/
+
+# artifacts
 coverage/
-.nogit/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# 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,127 +18,103 @@ 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
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - 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:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
   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 command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 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
   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:
@@ -146,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

README.md

@@ -1,53 +0,0 @@
-# @pushrocks/smarthash
-simplified 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
-[![build status](https://gitlab.com/pushrocks/smarthash/badges/master/build.svg)](https://gitlab.com/pushrocks/smarthash/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smarthash/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smarthash/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smarthash.svg)](https://www.npmjs.com/package/@pushrocks/smarthash)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smarthash/badge.svg)](https://snyk.io/test/npm/@pushrocks/smarthash)
-[![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-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-
-We recommend the use of TypeScript for best in class intellisense.
-
-```typescript
-import * as nodehash from "nodehash";
-
-// from stream
-let readStream = fs.createReadStream("./somefile.txt")
-nodehash.sha256FromStream(readStream)
-    .then((resultString){
-        console.log(resultString); // prints hash of the file
-    });
-
-// from file
-nodehash.sha256FromFile("./somefile.txt")
-    .then((resultString){
-        console.log(resultString); // prints hash of the file
-    });
-
-// from string
-nodehash.sha256FromString("some weird random string")
-    .then((resultString){
-        console.log(resultString); // prints hash of the file
-    });
-
-let hashString = nodehash.sha256FromStringSync("some weird random string");
-```
-
-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.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -12,4 +12,4 @@
   "npmci": {
     "npmAccessLevel": "public"
   }
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smarthash",
-  "version": "2.0.4",
+  "version": "2.1.1",
   "private": false,
   "description": "simplified access to node hash functions",
   "main": "dist/index.js",
@@ -29,15 +29,29 @@
   },
   "homepage": "https://github.com/pushrocks/nodehash#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tsrun": "^1.1.17",
-    "@gitzone/tstest": "^1.0.18",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.19"
+    "@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",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartjson": "^3.0.8",
+    "@pushrocks/smartpromise": "^3.0.6",
     "@types/through2": "^2.0.34",
-    "through2": "^3.0.0"
-  }
+    "through2": "^3.0.1"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.ts

@@ -1,31 +1,55 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 import fs = require('fs');
 
-import * as nodehash from '../ts/index';
+import * as smarthash from '../ts/index';
 
 tap.test('sha256FromStringSync should convert a String to sha256 hash synchronously', async () => {
-  let testHash = nodehash.sha256FromStringSync('test');
-  let testHash2 = nodehash.sha256FromStringSync('testString');
-  let testHash3 = nodehash.sha256FromStringSync('test');
+  const testHash = smarthash.sha256FromStringSync('test');
+  const testHash2 = smarthash.sha256FromStringSync('testString');
+  const testHash3 = smarthash.sha256FromStringSync('test');
   expect(testHash).to.equal(testHash3);
   expect(testHash).to.not.equal('test');
 });
 
 tap.test('sha256fromStringSync should convert a String to sha256 hash synchronously', async () => {
-  const resultString = await nodehash.sha256FromString('test');
-  let compareString = nodehash.sha256FromStringSync('test');
+  const resultString = await smarthash.sha256FromString('test');
+  const compareString = smarthash.sha256FromStringSync('test');
   expect(resultString).to.equal(compareString);
 });
 
 tap.test('sha256fromStream should convert a Stream to sha256', async tools => {
-  let readStream = fs.createReadStream('./test/testImageForHash.jpg');
-  const resultString: string = await nodehash.sha256FromStream(readStream);
+  const readStream = fs.createReadStream('./test/testImageForHash.jpg');
+  const resultString: string = await smarthash.sha256FromStream(readStream);
   expect(resultString).to.equal('45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c');
 });
 
 tap.test('sha256fromFile should convert a Stream to sha256', async () => {
-  const resultString = await nodehash.sha256FromFile('./test/testImageForHash.jpg');
+  const resultString = await smarthash.sha256FromFile('./test/testImageForHash.jpg');
   expect(resultString).to.equal('45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c');
 });
 
+tap.test('should produce reproducible hash from Object', async () => {
+  const hash1 = await smarthash.sha265FromObject({
+    hithere: 1,
+    wow: 'two'
+  });
+
+  const hash2 = await smarthash.sha265FromObject({
+    wow: 'two',
+    hithere: 1
+  });
+
+  const hash3 = await smarthash.sha265FromObject({
+    wow: 'twoe',
+    hithere: 1
+  });
+  expect(hash1).to.equal(hash2);
+  expect(hash1).to.not.equal(hash3);
+});
+
+tap.test('should create md5hash from string', async () => {
+  const md5Hash = await smarthash.md5FromString('hellothere');
+  expect(md5Hash).to.equal('c6f7c372641dd25e0fddf0215375561f');
+});
+
 tap.start();

ts/index.ts

@@ -1,3 +1,4 @@
 import * as plugins from './nodehash.plugins';
 
 export * from './nodehash.sha256';
+export * from './nodehash.md5';

ts/nodehash.helpers.ts

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

ts/nodehash.md5.ts

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

ts/nodehash.plugins.ts

@@ -1,6 +1,18 @@
-export import crypto = require('crypto');
-export import fs = require('fs');
-export import path = require('path');
-export import q = require('@pushrocks/smartpromise');
-export import stream = require('stream');
-export import through2 = require('through2');
+// node native scope
+import crypto from 'crypto';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as stream from 'stream';
+
+export { crypto, fs, path, stream };
+
+// pushrocks scope
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartjson from '@pushrocks/smartjson';
+
+export { smartpromise, smartjson };
+
+// thirdparty scope
+import through2 from 'through2';
+
+export { through2 };

ts/nodehash.sha256.ts

@@ -4,11 +4,11 @@ import * as helpers from './nodehash.helpers';
 /**
  * creates sha256 Hash from Stream
  */
-export let sha256FromStream = (input): Promise<string> => {
-  let done = plugins.q.defer<string>();
-  let hash = plugins.crypto.createHash('sha256');
+export const sha256FromStream = (input: plugins.stream.Stream): Promise<string> => {
+  const done = plugins.smartpromise.defer<string>();
+  const hash = plugins.crypto.createHash('sha256');
 
-  hash['setEncoding']('hex');
+  hash.setEncoding('hex');
   input.pipe(hash).pipe(helpers.hashStreamPipeStop(done.resolve));
   return done.promise;
 };
@@ -16,21 +16,18 @@ export let sha256FromStream = (input): Promise<string> => {
 /**
  * creates sha256 Hash from File;
  */
-export let sha256FromFile = (filePath: string) => {
-  let done = plugins.q.defer();
-  let absolutePath = plugins.path.resolve(filePath);
-  let readableStream = plugins.fs.createReadStream(absolutePath);
-  sha256FromStream(readableStream).then(resultHashString => {
-    done.resolve(resultHashString);
-  });
-  return done.promise;
+export const sha256FromFile = async (filePath: string): Promise<string> => {
+  const absolutePath = plugins.path.resolve(filePath);
+  const readableStream = plugins.fs.createReadStream(absolutePath);
+  const hashResult = sha256FromStream(readableStream);
+  return hashResult;
 };
 
 /**
  * Computes sha256 Hash from String synchronously
  */
-export let sha256FromStringSync = stringArg => {
-  let hash = plugins.crypto.createHash('sha256');
+export let sha256FromStringSync = (stringArg): string => {
+  const hash = plugins.crypto.createHash('sha256');
   hash.update(stringArg);
   return hash.digest('hex');
 };
@@ -38,11 +35,18 @@ export let sha256FromStringSync = stringArg => {
 /**
  * Computes sha256 Hash from String
  */
-export let sha256FromString = stringArg => {
-  let done = plugins.q.defer();
-  let hash = plugins.crypto.createHash('sha256');
+export const sha256FromString = async (stringArg: string): Promise<string> => {
+  const hash = plugins.crypto.createHash('sha256');
   hash.update(stringArg);
-  let hashResult = hash.digest('hex');
-  done.resolve(hashResult);
-  return done.promise;
+  const hashResult = hash.digest('hex');
+  return hashResult;
+};
+
+/**
+ * computes sha265 Hash from Object
+ */
+export const sha265FromObject = async (objectArg: any): Promise<string> => {
+  const stringifiedObject = plugins.smartjson.Smartjson.stringify(objectArg, {});
+  const hashResult = await sha256FromString(stringifiedObject);
+  return hashResult;
 };