3.0.4

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

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

.gitlab-ci.yml

@@ -1,36 +0,0 @@
-image: hosttoday/ht-docker-node:npmts
-
-stages:
-- test
-- release
-
-testLEGACY:
-  stage: test
-  script:
-    - npmci test legacy
-  tags:
-    - docker
-
-testLTS:
-  stage: test
-  script:
-    - npmci test lts
-  tags:
-    - docker
-    
-testSTABLE:
-  stage: test
-  script:
-    - npmci test stable
-  tags:
-    - docker
-
-release:
-  stage: release
-  environment: npmjs-com_registry
-  script:
-    - npmci publish
-  only:
-    - tags
-  tags:
-    - docker

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,15 +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";
-
-let sha256 = new nodehash.sha256();
-let myHashedString = sha256.fromString();
-```

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

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

npmextra.json

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

package.json

@@ -1,33 +1,53 @@
 {
-  "name": "nodehash",
-  "version": "1.0.1",
-  "description": "simplifies access to node hash functions",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "name": "@push.rocks/smarthash",
+  "version": "3.0.4",
+  "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 --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "keywords": [
+    "pushrocks",
+    "typescript",
     "hash",
     "node",
-    "sha"
+    "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"
+    "@git.zone/tsbuild": "^2.1.70",
+    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tstest": "^1.0.81",
+    "@push.rocks/tapbundle": "^5.0.15",
+    "@types/node": "^20.6.3"
   },
   "dependencies": {
-    "typings-global": "^1.0.6"
-  }
+    "@push.rocks/smartjson": "^5.0.10",
+    "@push.rocks/smartpromise": "^4.0.3",
+    "@types/through2": "^2.0.39",
+    "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"
+  ],
+  "type": "module"
 }

readme.md

@@ -0,0 +1,73 @@
+# @push.rocks/smarthash
+simplifies access to node hash functions
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smarthash)
+* [gitlab.com (source)](https://gitlab.com/push.rocks/smarthash)
+* [github.com (source mirror)](https://github.com/push.rocks/smarthash)
+* [docs (typedoc)](https://push.rocks.gitlab.io/smarthash/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smarthash/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smarthash/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smarthash)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/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/@push.rocks/smarthash)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smarthash)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smarthash)](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.
+
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

test/test.js

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

test/test.ts

@@ -0,0 +1,55 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as fs from 'fs';
+
+import * as smarthash from '../ts/index.js';
+
+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).toEqual(testHash3);
+  expect(testHash).not.toEqual('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).toEqual(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).toEqual('45b80413ed93acb495691186ce61850449439f9183352b9bff96d5533fa1046c');
+});
+
+tap.test('sha256fromFile should convert a Stream to sha256', async () => {
+  const resultString = await smarthash.sha256FromFile('./test/testImageForHash.jpg');
+  expect(resultString).toEqual('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).toEqual(hash2);
+  expect(hash1).not.toEqual(hash3);
+});
+
+tap.test('should create md5hash from string', async () => {
+  const md5Hash = await smarthash.md5FromString('hellothere');
+  expect(md5Hash).toEqual('c6f7c372641dd25e0fddf0215375561f');
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smarthash',
+  version: '3.0.4',
+  description: 'simplified access to node hash functions'
+}

ts/index.ts

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

ts/nodehash.helpers.ts

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

ts/nodehash.md5.ts

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

ts/nodehash.plugins.ts

@@ -1,2 +1,18 @@
-import "typings-global";
-export import crypto = require("crypto");
+// 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 '@push.rocks/smartpromise';
+import * as smartjson from '@push.rocks/smartjson';
+
+export { smartpromise, smartjson };
+
+// thirdparty scope
+import through2 from 'through2';
+
+export { through2 };

ts/nodehash.sha256.ts

@@ -0,0 +1,62 @@
+import * as plugins from './nodehash.plugins.js';
+import * as helpers from './nodehash.helpers.js';
+
+/**
+ * creates sha256 Hash from Stream
+ */
+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;
+};
+
+/**
+ * creates sha256 Hash from File;
+ */
+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 const sha256FromStringSync = (stringArg: string): string => {
+  const hash = plugins.crypto.createHash('sha256');
+  hash.update(stringArg);
+  return hash.digest('hex');
+};
+
+/**
+ * Computes sha256 Hash from String
+ */
+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;
+};

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}