40 Commits

Author SHA1 Message Date
bb7bee3b42 2.1.10 2021-03-01 01:27:16 +00:00
50197d4634 fix(core): update 2021-03-01 01:27:15 +00:00
2e7a61541f 2.1.9 2021-03-01 01:26:55 +00:00
5a6ae2f083 fix(core): update 2021-03-01 01:26:55 +00:00
bf1b89a95a 2.1.8 2020-10-05 15:07:29 +00:00
3e2b300cdb fix(core): update 2020-10-05 15:07:28 +00:00
d865e3b874 2.1.7 2020-09-29 15:54:05 +00:00
13f1f854ce fix(core): update 2020-09-29 15:54:05 +00:00
34586b5fec 2.1.6 2019-12-15 22:49:22 +00:00
edb13cbdcf fix(core): update 2019-12-15 22:49:22 +00:00
5c2e01fe84 2.1.5 2019-12-15 19:22:27 +00:00
d348590e9a fix(core): update 2019-12-15 19:22:27 +00:00
c908cd824b 2.1.4 2019-12-15 19:18:45 +00:00
4a62342015 fix(core): update 2019-12-15 19:18:44 +00:00
0a9a0d3e90 2.1.3 2019-12-15 19:17:28 +00:00
8d5238e23e fix(core): update 2019-12-15 19:17:28 +00:00
9e5ce63c24 2.1.2 2019-12-15 19:12:02 +00:00
3921cbc8f8 fix(core): update 2019-12-15 19:12:01 +00:00
1d917c6a96 2.1.1 2019-11-21 14:20:57 +00:00
c06ac22a59 fix(ci): update 2019-11-21 14:20:57 +00:00
58d4d17e8a 2.1.0 2019-11-21 14:17:49 +00:00
0ed76d1ad4 feat(md5): now creates md5 hashes 2019-11-21 14:17:48 +00:00
cb5b3d2172 2.0.6 2019-07-04 17:07:23 +02:00
62b3813a85 fix(core): update 2019-07-04 17:07:23 +02:00
2a3ad3ad80 2.0.5 2019-07-04 16:56:38 +02:00
4d3b6ff3c9 fix(core): update 2019-07-04 16:56:37 +02:00
85c9a9381a 2.0.4 2019-01-30 02:45:39 +01:00
67962faebc fix(snyk): add .snyk file and mark as Open Source 2019-01-30 02:45:38 +01:00
9361702c38 2.0.3 2019-01-30 02:43:09 +01:00
48994e6ff9 fix(core): update 2019-01-30 02:43:08 +01:00
7130e34adb 2.0.2 2019-01-30 02:42:20 +01:00
dba40dc99f fix(core): update 2019-01-30 02:42:19 +01:00
9e0f2ee551 2.0.1 2019-01-30 02:37:55 +01:00
e28c1c73ea fix(core): update 2019-01-30 02:37:55 +01:00
f47ea7def8 2.0.0 2018-09-08 01:04:48 +02:00
eb79ac25c9 BREAKING CHANGE(scope): change and name to @pushrocks/smarthash 2018-09-08 01:04:47 +02:00
9746709aab 1.0.4 2016-08-16 03:45:18 +02:00
2c4e09cf88 update package tags 2016-08-16 03:45:15 +02:00
088b5259b5 1.0.3 2016-08-16 03:41:19 +02:00
a8c1e70b4c fix README 2016-08-16 03:41:17 +02:00
28 changed files with 11716 additions and 325 deletions

22
.gitignore vendored
View File

@ -1,4 +1,20 @@
node_modules/
docs/
.nogit/
# artifacts
coverage/
.nogit/
public/
pages/
# installs
node_modules/
# caches
.yarn/
.cache/
.rpt2_cache
# builds
dist/
dist_*/
# custom

View File

@ -1,36 +1,137 @@
image: hosttoday/ht-docker-node:npmts
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- test
- release
- security
- test
- release
- metadata
testLEGACY:
stage: test
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci test legacy
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
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
testLTS:
stage: test
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci test lts
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
testSTABLE:
allow_failure: true
# ====================
# test stage
# ====================
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
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:
- docker
release:
stage: release
environment: npmjs-com_registry
script:
- npmci publish
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- docker
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
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:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

4
.snyk Normal file
View File

@ -0,0 +1,4 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.13.3
ignore: {}
patch: {}

29
.vscode/launch.json vendored Normal file
View File

@ -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"
}
]
}

26
.vscode/settings.json vendored Normal file
View File

@ -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"]
}
}
}
}
}
}
]
}

View File

@ -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

View File

@ -1,33 +0,0 @@
# 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";
// 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")
```

1
dist/index.d.ts vendored
View File

@ -1 +0,0 @@
export * from "./nodehash.sha256";

6
dist/index.js vendored
View File

@ -1,6 +0,0 @@
"use strict";
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
__export(require("./nodehash.sha256"));
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaUJBQWMsbUJBQW1CLENBQUMsRUFBQSJ9

View File

@ -1,2 +0,0 @@
/// <reference types="node" />
export declare let hashStreamPipeStop: (resolveFuntion: any) => NodeJS.ReadWriteStream;

View File

@ -1,13 +0,0 @@
"use strict";
const plugins = require("./nodehash.plugins");
exports.hashStreamPipeStop = (resolveFuntion) => {
let forEach = (chunk, enc, cb) => {
resolveFuntion(chunk.toString("utf8"));
cb(null, chunk);
};
let atEnd = (cb) => {
cb();
};
return plugins.through2(forEach, atEnd);
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm9kZWhhc2guaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25vZGVoYXNoLmhlbHBlcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLG9CQUFvQixDQUFDLENBQUE7QUFFbkMsMEJBQWtCLEdBQUcsQ0FBQyxjQUFjO0lBQzNDLElBQUksT0FBTyxHQUFHLENBQUMsS0FBWSxFQUFDLEdBQUcsRUFBQyxFQUFFO1FBQzlCLGNBQWMsQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7UUFDdkMsRUFBRSxDQUFDLElBQUksRUFBQyxLQUFLLENBQUMsQ0FBQztJQUNuQixDQUFDLENBQUM7SUFFRixJQUFJLEtBQUssR0FBRyxDQUFDLEVBQUU7UUFDWCxFQUFFLEVBQUUsQ0FBQztJQUNULENBQUMsQ0FBQztJQUVGLE1BQU0sQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sRUFBQyxLQUFLLENBQUMsQ0FBQztBQUMzQyxDQUFDLENBQUMifQ==

View File

@ -1,7 +0,0 @@
import "typings-global";
export import crypto = require("crypto");
export import fs = require("fs");
export import path = require("path");
export import q = require("q");
export import stream = require("stream");
export import through2 = require("through2");

View File

@ -1,9 +0,0 @@
"use strict";
require("typings-global");
exports.crypto = require("crypto");
exports.fs = require("fs");
exports.path = require("path");
exports.q = require("q");
exports.stream = require("stream");
exports.through2 = require("through2");
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm9kZWhhc2gucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25vZGVoYXNoLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGNBQU0sV0FBVyxRQUFRLENBQUMsQ0FBQztBQUMzQixVQUFFLFdBQVcsSUFBSSxDQUFDLENBQUM7QUFDbkIsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNqQixjQUFNLFdBQVcsUUFBUSxDQUFDLENBQUM7QUFDM0IsZ0JBQVEsV0FBVyxVQUFVLENBQUMsQ0FBQyJ9

View File

@ -1,18 +0,0 @@
/// <reference types="q" />
import * as plugins from "./nodehash.plugins";
/**
* creates sha256 Hash from Stream
*/
export declare let sha256FromStream: (input: any) => plugins.q.Promise<{}>;
/**
* creates sha256 Hash from File;
*/
export declare let sha256FromFile: (filePath: string) => plugins.q.Promise<{}>;
/**
* Computes sha256 Hash from String synchronously
*/
export declare let sha256FromStringSync: (stringArg: any) => any;
/**
* Computes sha256 Hash from String
*/
export declare let sha256FromString: (stringArg: any) => plugins.q.Promise<{}>;

View File

@ -1,48 +0,0 @@
"use strict";
const plugins = require("./nodehash.plugins");
const helpers = require("./nodehash.helpers");
/**
* creates sha256 Hash from Stream
*/
exports.sha256FromStream = (input) => {
let done = plugins.q.defer();
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;
*/
exports.sha256FromFile = (filePath) => {
let done = plugins.q.defer();
let absolutePath = plugins.path.resolve(filePath);
let readableStream = plugins.fs.createReadStream(absolutePath);
exports.sha256FromStream(readableStream)
.then((resultHashString) => {
done.resolve(resultHashString);
});
return done.promise;
};
/**
* Computes sha256 Hash from String synchronously
*/
exports.sha256FromStringSync = (stringArg) => {
let hash = plugins.crypto.createHash('sha256');
hash.update(stringArg);
return hash.digest("hex");
};
/**
* Computes sha256 Hash from String
*/
exports.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;
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm9kZWhhc2guc2hhMjU2LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbm9kZWhhc2guc2hhMjU2LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxNQUFZLE9BQU8sV0FBTSxvQkFBb0IsQ0FBQyxDQUFBO0FBQzlDLE1BQVksT0FBTyxXQUFNLG9CQUFvQixDQUFDLENBQUE7QUFFOUM7O0dBRUc7QUFDUSx3QkFBZ0IsR0FBRyxDQUFDLEtBQUs7SUFDaEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUUvQyxJQUFJLENBQUMsYUFBYSxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDM0IsS0FBSztTQUNBLElBQUksQ0FBQyxJQUFJLENBQUM7U0FDVixJQUFJLENBQUMsT0FBTyxDQUFDLGtCQUFrQixDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO0lBQ3BELE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3hCLENBQUMsQ0FBQztBQUVGOztHQUVHO0FBQ1Esc0JBQWMsR0FBRyxDQUFDLFFBQWU7SUFDeEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixJQUFJLFlBQVksR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNsRCxJQUFJLGNBQWMsR0FBRyxPQUFPLENBQUMsRUFBRSxDQUFDLGdCQUFnQixDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQy9ELHdCQUFnQixDQUFDLGNBQWMsQ0FBQztTQUMzQixJQUFJLENBQUMsQ0FBQyxnQkFBZ0I7UUFDbkIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0lBQ25DLENBQUMsQ0FBQyxDQUFDO0lBQ1AsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDeEIsQ0FBQyxDQUFBO0FBRUQ7O0dBRUc7QUFDUSw0QkFBb0IsR0FBRyxDQUFDLFNBQVM7SUFDeEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDL0MsSUFBSSxDQUFDLE1BQU0sQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUN2QixNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztBQUM5QixDQUFDLENBQUM7QUFFRjs7R0FFRztBQUNRLHdCQUFnQixHQUFHLENBQUMsU0FBUztJQUNwQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzdCLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQy9DLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDdkIsSUFBSSxVQUFVLEdBQUcsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUNwQyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQ3pCLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3hCLENBQUMsQ0FBQyJ9

View File

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

11240
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,37 +1,53 @@
{
"name": "nodehash",
"version": "1.0.2",
"description": "simplifies access to node hash functions",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"name": "@pushrocks/smarthash",
"version": "2.1.10",
"private": false,
"description": "simplified access to node hash functions",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"scripts": {
"test": "(npmts)"
},
"repository": {
"type": "git",
"url": "git+https://github.com/pushrocks/nodehash.git"
"test": "(tstest test/ --web)",
"build": "(tsbuild --web)"
},
"keywords": [
"pushrocks",
"typescript",
"hash",
"node",
"sha265"
"sha256",
"stream",
"filehash"
],
"author": "Lossless GmbH",
"license": "MIT",
"bugs": {
"url": "https://github.com/pushrocks/nodehash/issues"
},
"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.25",
"@gitzone/tsrun": "^1.2.12",
"@gitzone/tstest": "^1.0.52",
"@pushrocks/tapbundle": "^3.2.14",
"@types/node": "^14.14.31",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
},
"dependencies": {
"@types/q": "0.x.x",
"@types/through2": "0.x.x",
"q": "^1.4.1",
"through2": "^2.0.1",
"typings-global": "^1.0.6"
}
"@pushrocks/smartjson": "^4.0.6",
"@pushrocks/smartpromise": "^3.1.3",
"@types/through2": "^2.0.36",
"through2": "^4.0.2"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

75
readme.md Normal file
View File

@ -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 | **&copy;** [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)

1
test/test.d.ts vendored
View File

@ -1 +0,0 @@
import "typings-test";

View File

@ -1,46 +0,0 @@
"use strict";
require("typings-test");
const should = require("should");
const fs = require("fs");
const nodehash = require("../dist/index");
describe("nodehash", function () {
describe("sha256FromStringSync", function () {
it("should convert a String to sha256 hash synchronously", function () {
let testHash = nodehash.sha256FromStringSync("test");
let testHash2 = nodehash.sha256FromStringSync("testString");
let testHash3 = nodehash.sha256FromStringSync("test");
should.equal(testHash, testHash3);
should.notEqual(testHash, "test");
});
});
describe("sha256fromStringSync", function () {
it("should convert a String to sha256 hash synchronously", function (done) {
nodehash.sha256FromString("test")
.then(resultString => {
let compareString = nodehash.sha256FromStringSync("test");
should.equal(resultString, compareString);
done();
});
});
});
describe("sha256fromStream", function () {
it("should convert a Stream to sha256 and resolve a promise with result", function (done) {
let readStream = fs.createReadStream("./test/testImageForHash.jpg");
nodehash.sha256FromStream(readStream)
.then((resultString) => {
should.equal(resultString, "45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c");
done();
});
});
});
describe("sha256fromFile", function () {
it("should convert a Stream to sha256 and resolve a promise with result", function (done) {
nodehash.sha256FromFile("./test/testImageForHash.jpg")
.then((resultString) => {
should.equal(resultString, "45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c");
done();
});
});
});
});
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBTyxNQUFNLFdBQVcsUUFBUSxDQUFDLENBQUM7QUFDbEMsTUFBTyxFQUFFLFdBQVcsSUFBSSxDQUFDLENBQUM7QUFFMUIsTUFBWSxRQUFRLFdBQU0sZUFBZSxDQUFDLENBQUE7QUFFMUMsUUFBUSxDQUFDLFVBQVUsRUFBQztJQUNoQixRQUFRLENBQUMsc0JBQXNCLEVBQUM7UUFDNUIsRUFBRSxDQUFDLHNEQUFzRCxFQUFDO1lBQ3RELElBQUksUUFBUSxHQUFHLFFBQVEsQ0FBQyxvQkFBb0IsQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUNyRCxJQUFJLFNBQVMsR0FBRyxRQUFRLENBQUMsb0JBQW9CLENBQUMsWUFBWSxDQUFDLENBQUM7WUFDNUQsSUFBSSxTQUFTLEdBQUcsUUFBUSxDQUFDLG9CQUFvQixDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQ3RELE1BQU0sQ0FBQyxLQUFLLENBQUMsUUFBUSxFQUFDLFNBQVMsQ0FBQyxDQUFDO1lBQ2pDLE1BQU0sQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQ3JDLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUM7SUFDSCxRQUFRLENBQUMsc0JBQXNCLEVBQUM7UUFDNUIsRUFBRSxDQUFDLHNEQUFzRCxFQUFDLFVBQVMsSUFBSTtZQUNuRSxRQUFRLENBQUMsZ0JBQWdCLENBQUMsTUFBTSxDQUFDO2lCQUM1QixJQUFJLENBQUMsWUFBWTtnQkFDZCxJQUFJLGFBQWEsR0FBRyxRQUFRLENBQUMsb0JBQW9CLENBQUMsTUFBTSxDQUFDLENBQUM7Z0JBQzFELE1BQU0sQ0FBQyxLQUFLLENBQUMsWUFBWSxFQUFDLGFBQWEsQ0FBQyxDQUFDO2dCQUN6QyxJQUFJLEVBQUUsQ0FBQztZQUNYLENBQUMsQ0FBQyxDQUFBO1FBQ1YsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQztJQUNILFFBQVEsQ0FBQyxrQkFBa0IsRUFBQztRQUN4QixFQUFFLENBQUMscUVBQXFFLEVBQUMsVUFBUyxJQUFJO1lBQ2xGLElBQUksVUFBVSxHQUFHLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FBQyw2QkFBNkIsQ0FBQyxDQUFDO1lBQ3BFLFFBQVEsQ0FBQyxnQkFBZ0IsQ0FBQyxVQUFVLENBQUM7aUJBQ2hDLElBQUksQ0FBQyxDQUFDLFlBQW1CO2dCQUN0QixNQUFNLENBQUMsS0FBSyxDQUFDLFlBQVksRUFBQyxrRUFBa0UsQ0FBQyxDQUFBO2dCQUM3RixJQUFJLEVBQUUsQ0FBQztZQUNYLENBQUMsQ0FBQyxDQUFDO1FBQ1gsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQztJQUNILFFBQVEsQ0FBQyxnQkFBZ0IsRUFBQztRQUN0QixFQUFFLENBQUMscUVBQXFFLEVBQUMsVUFBUyxJQUFJO1lBQ2xGLFFBQVEsQ0FBQyxjQUFjLENBQUMsNkJBQTZCLENBQUM7aUJBQ2pELElBQUksQ0FBQyxDQUFDLFlBQW1CO2dCQUN0QixNQUFNLENBQUMsS0FBSyxDQUFDLFlBQVksRUFBQyxrRUFBa0UsQ0FBQyxDQUFBO2dCQUM3RixJQUFJLEVBQUUsQ0FBQztZQUNYLENBQUMsQ0FBQyxDQUFDO1FBQ1gsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMsQ0FBQyxDQUFDIn0=

View File

@ -1,46 +1,55 @@
import "typings-test";
import should = require("should");
import fs = require("fs");
import { tap, expect } from '@pushrocks/tapbundle';
import fs = require('fs');
import * as nodehash from "../dist/index";
import * as smarthash from '../ts/index';
describe("nodehash",function(){
describe("sha256FromStringSync",function(){
it("should convert a String to sha256 hash synchronously",function(){
let testHash = nodehash.sha256FromStringSync("test");
let testHash2 = nodehash.sha256FromStringSync("testString");
let testHash3 = nodehash.sha256FromStringSync("test");
should.equal(testHash,testHash3);
should.notEqual(testHash,"test");
})
});
describe("sha256fromStringSync",function(){
it("should convert a String to sha256 hash synchronously",function(done){
nodehash.sha256FromString("test")
.then(resultString => {
let compareString = nodehash.sha256FromStringSync("test");
should.equal(resultString,compareString);
done();
})
})
});
describe("sha256fromStream",function(){
it("should convert a Stream to sha256 and resolve a promise with result",function(done){
let readStream = fs.createReadStream("./test/testImageForHash.jpg");
nodehash.sha256FromStream(readStream)
.then((resultString:string) => {
should.equal(resultString,"45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c")
done();
});
})
});
describe("sha256fromFile",function(){
it("should convert a Stream to sha256 and resolve a promise with result",function(done){
nodehash.sha256FromFile("./test/testImageForHash.jpg")
.then((resultString:string) => {
should.equal(resultString,"45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c")
done();
});
})
});
});
tap.test('sha256FromStringSync should convert a String to sha256 hash synchronously', async () => {
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 smarthash.sha256FromString('test');
const compareString = smarthash.sha256FromStringSync('test');
expect(resultString).to.equal(compareString);
});
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');
});
tap.test('sha256fromFile should convert a Stream to sha256', async () => {
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();

View File

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

View File

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

5
ts/nodehash.md5.ts Normal file
View File

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

View File

@ -1,7 +1,18 @@
import "typings-global";
export import crypto = require("crypto");
export import fs = require("fs");
export import path = require("path");
export import q = require("q");
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 };

View File

@ -1,51 +1,62 @@
import * as plugins from "./nodehash.plugins";
import * as helpers from "./nodehash.helpers";
import * as plugins from './nodehash.plugins';
import * as helpers from './nodehash.helpers';
/**
* creates sha256 Hash from Stream
*/
export let sha256FromStream = (input) => {
let done = plugins.q.defer();
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");
input
.pipe(hash)
.pipe(helpers.hashStreamPipeStop(done.resolve));
return done.promise;
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;
}
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');
hash.update(stringArg);
return hash.digest("hex");
export const sha256FromStringSync = (stringArg: string): string => {
const 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;
};
export const sha256FromString = async (stringArg: string): Promise<string> => {
const hash = plugins.crypto.createHash('sha256');
hash.update(stringArg);
const hashResult = hash.digest('hex');
return hashResult;
};
/**
* Computes sha256 Hash from String
*/
export const sha256FromBuffer = async (bufferArg: Buffer): Promise<string> => {
const hash = plugins.crypto.createHash('sha256');
hash.update(bufferArg);
const hashResult = hash.digest('hex');
return hashResult;
};
/**
* computes sha265 Hash from Object
*/
export const sha265FromObject = async (objectArg: any): Promise<string> => {
const stringifiedObject = plugins.smartjson.stringify(objectArg, {});
const hashResult = await sha256FromString(stringifiedObject);
return hashResult;
};

17
tslint.json Normal file
View File

@ -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"
}