2.1.7

.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,48 +18,65 @@ 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
 # ====================
 
-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
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - 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
@@ -69,31 +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-node:npmci
   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:
@@ -101,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smarthash",
-  "version": "2.0.6",
+  "version": "2.1.7",
   "private": false,
   "description": "simplified access to node hash functions",
   "main": "dist/index.js",
@@ -29,26 +29,27 @@
   },
   "homepage": "https://github.com/pushrocks/nodehash#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^12.0.12",
-    "tslint": "^5.18.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^12.12.17",
+    "tslint": "^5.20.1",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartjson": "^3.0.5",
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartjson": "^3.0.10",
+    "@pushrocks/smartpromise": "^3.0.6",
     "@types/through2": "^2.0.34",
     "through2": "^3.0.1"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -21,33 +21,48 @@ simplifies access to node hash functions
 We recommend the use of TypeScript for best in class intellisense.
 
 ```typescript
-import * as nodehash from "nodehash";
+import * as smarthash from "smarthash";
+
+// ======
+// sha265
+// ======
 
 // from stream
 let readStream = fs.createReadStream("./somefile.txt")
-nodehash.sha256FromStream(readStream)
+smarthash.sha256FromStream(readStream)
     .then((resultString){
         console.log(resultString); // prints hash of the file
     });
 
 // from file
-nodehash.sha256FromFile("./somefile.txt")
+smarthash.sha256FromFile("./somefile.txt")
     .then((resultString){
         console.log(resultString); // prints hash of the file
     });
 
 // from string
-nodehash.sha256FromString("some weird random string")
+smarthash.sha256FromString("some weird random string")
     .then((resultString){
         console.log(resultString); // prints hash of the file
     });
 
-let hashString = nodehash.sha256FromStringSync("some weird random string");
+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.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -30,21 +30,26 @@ 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'
+    hithere: 1,
+    wow: 'two'
   });
 
   const hash2 = await smarthash.sha265FromObject({
-    'wow': 'two',
-    'hithere': 1,
+    wow: 'two',
+    hithere: 1
   });
 
   const hash3 = await smarthash.sha265FromObject({
-    'wow': 'twoe',
-    'hithere': 1,
+    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.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

@@ -4,25 +4,15 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as stream from 'stream';
 
-export {
-  crypto,
-  fs,
-  path,
-  stream
-};
+export { crypto, fs, path, stream };
 
 // pushrocks scope
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartjson from '@pushrocks/smartjson';
 
-export {
-  smartpromise,
-  smartjson
-};
+export { smartpromise, smartjson };
 
 // thirdparty scope
 import through2 from 'through2';
 
-export {
-  through2
-};
+export { through2 };

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');
@@ -35,7 +35,7 @@ export let sha256FromStringSync = (stringArg): string => {
 /**
  * Computes sha256 Hash from String
  */
-export const sha256FromString = async(stringArg: string): Promise<string> => {
+export const sha256FromString = async (stringArg: string): Promise<string> => {
   const hash = plugins.crypto.createHash('sha256');
   hash.update(stringArg);
   const hashResult = hash.digest('hex');