2.0.3

.gitlab-ci.yml

@@ -1,36 +1,150 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
+- metadata
 
-testLEGACY:
-  stage: test
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
-    - docker
+  - docker
+  - notpriv
+
+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
+
+# ====================
+# test stage
+# ====================
 
 testLTS:
   stage: test
   script:
-    - npmci test lts
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
 
 release:
   stage: release
-  environment: npmjs-com_registry
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
+  only:
+  - tags
+  tags:
+  - 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]
+  tags:
+  - docker
+  - priv
+
+trigger:
+  stage: metadata
+  script:
+  - npmci trigger
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+pages:
+  image: hosttoday/ht-docker-node:npmci
+  stage: metadata
+  script:
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
-  tags:
-    - docker
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public
+  allow_failure: true

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Push.Rocks
+Copyright (c) 2016 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,15 +1,53 @@
-# nodehash
-simplifies access to node hash functions. TypeScript Ready
-
-## Status
-[![build status](https://gitlab.com/pushrocks/nodehash/badges/master/build.svg)](https://gitlab.com/pushrocks/nodehash/commits/master)
-
-## Usage
-We recommend the use of TypeScript for best in class intellisense.
-
-```typescript
-import * as nodehash from "nodehash";
-
-let sha256 = new nodehash.sha256();
-let myHashedString = sha256.fromString();
-```
+# @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)

dist/index.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

dist/nodehash.plugins.d.ts

@@ -1,2 +0,0 @@
-import "typings-global";
-export import crypto = require("crypto");

dist/nodehash.plugins.js

@@ -1,4 +0,0 @@
-"use strict";
-require("typings-global");
-exports.crypto = require("crypto");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm9kZWhhc2gucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25vZGVoYXNoLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGNBQU0sV0FBVyxRQUFRLENBQUMsQ0FBQyJ9

npmextra.json

@@ -1 +1,15 @@
-{}
+{
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smarthash",
+      "shortDescription": "simplifies access to node hash functions",
+      "npmPackagename": "@pushrocks/smarthash",
+      "license": "MIT"
+    }
+  },
+  "npmci": {
+    "npmAccessLevel": "public"
+  }
+}

package.json

@@ -1,20 +1,26 @@
 {
-  "name": "nodehash",
-  "version": "1.0.1",
-  "description": "simplifies access to node hash functions",
+  "name": "@pushrocks/smarthash",
+  "version": "2.0.3",
+  "private": false,
+  "description": "simplified access to node hash functions",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pushrocks/nodehash.git"
   },
   "keywords": [
+    "pushrocks",
+    "typescript",
     "hash",
     "node",
-    "sha"
+    "sha256",
+    "stream",
+    "filehash"
   ],
   "author": "Lossless GmbH",
   "license": "MIT",
@@ -23,11 +29,15 @@
   },
   "homepage": "https://github.com/pushrocks/nodehash#readme",
   "devDependencies": {
-    "npmts-g": "^5.2.8",
-    "should": "^11.1.0",
-    "typings-test": "^1.0.1"
+    "@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"
   },
   "dependencies": {
-    "typings-global": "^1.0.6"
+    "@pushrocks/smartpromise": "^2.0.5",
+    "@types/through2": "^2.0.34",
+    "through2": "^3.0.0"
   }
 }

test/test.js

@@ -1 +0,0 @@
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

test/test.ts

@@ -0,0 +1,31 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+import fs = require('fs');
+
+import * as nodehash 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');
+  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');
+  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);
+  expect(resultString).to.equal('45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c');
+});
+
+tap.test('sha256fromFile should convert a Stream to sha256', async () => {
+  const resultString = await nodehash.sha256FromFile('./test/testImageForHash.jpg');
+  expect(resultString).to.equal('45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c');
+});
+
+tap.start();

ts/index.ts

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

ts/nodehash.helpers.ts

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

ts/nodehash.plugins.ts

@@ -1,2 +1,6 @@
-import "typings-global";
-export import crypto = require("crypto");
+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');

ts/nodehash.sha256.ts

@@ -0,0 +1,48 @@
+import * as plugins from './nodehash.plugins';
+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');
+
+  hash['setEncoding']('hex');
+  input.pipe(hash).pipe(helpers.hashStreamPipeStop(done.resolve));
+  return done.promise;
+};
+
+/**
+ * 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;
+};
+
+/**
+ * Computes sha256 Hash from String synchronously
+ */
+export let sha256FromStringSync = stringArg => {
+  let hash = plugins.crypto.createHash('sha256');
+  hash.update(stringArg);
+  return hash.digest('hex');
+};
+
+/**
+ * Computes sha256 Hash from String
+ */
+export let sha256FromString = stringArg => {
+  let done = plugins.q.defer();
+  let hash = plugins.crypto.createHash('sha256');
+  hash.update(stringArg);
+  let hashResult = hash.digest('hex');
+  done.resolve(hashResult);
+  return done.promise;
+};

tslint.json

@@ -0,0 +1,17 @@
+{
+  "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"
+}