@quicore/hash 1.0.0

package/.babelrc

@@ -0,0 +1,9 @@
+{
+  "presets": [
+    ["@babel/env", {
+      "targets": {
+        "node": "current"
+      }
+    }]
+  ]
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 quicore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# hash
+A lightweight utility for fast access to the most commonly used hashing algorithms including SHA, Blake2, and PBKDF2

package/dist/index.js

@@ -0,0 +1,166 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GenerateHash = void 0;
+var _crypto = _interopRequireDefault(require("crypto"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Provides a faster and unified interface to commonly used cryptographic hash functions.
+ * Includes support for SHA families, BLAKE2, PBKDF2, RIPEMD, and more.
+ * Ideal for generating IDs, digital fingerprints, and secure hashes in Node.js applications.
+ */
+class GenerateHash {
+  /** Base62 character set used for compact encoding */
+  static BASE62_CHARS = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+
+  /** Default length for generated Base62-encoded IDs */
+  static DEFAULT_ID_LENGTH = 22;
+
+  /** Minimum allowed length for Base62-encoded IDs */
+  static MIN_ID_LENGTH = 10;
+
+  /** Digest size (in bytes) for BLAKE2b hashes used in compact ID generation */
+  static BLAKE2B_DIGEST_SIZE = 20;
+
+  /**
+   * Converts a binary buffer to a Base62-encoded string.
+   *
+   * @param {Buffer} buffer - The binary data to encode.
+   * @param {number} [length=GenerateHash.DEFAULT_ID_LENGTH] - Desired output length. Must be ≥ MIN_ID_LENGTH.
+   * @returns {string} Base62-encoded string.
+   * @throws {Error} If the requested length is below the minimum threshold.
+   */
+  static toBase62(buffer, length = this.DEFAULT_ID_LENGTH) {
+    if (length < this.MIN_ID_LENGTH) {
+      throw new Error(`ID length must be at least ${this.MIN_ID_LENGTH} characters`);
+    }
+    let num = BigInt('0x' + buffer.toString('hex'));
+    let result = '';
+    const base = BigInt(this.BASE62_CHARS.length);
+    do {
+      const remainder = Number(num % base);
+      result = this.BASE62_CHARS[remainder] + result;
+      num = num / base;
+    } while (num > 0n);
+    return result.length > length ? result.substring(0, length) : result.padStart(length, '0');
+  }
+
+  /**
+   * Generates a BLAKE2b hash from the input string.
+   *
+   * @param {string | Buffer} input - The input data to hash.
+   * @param {number} [digestSize=GenerateHash.BLAKE2B_DIGEST_SIZE] - Length of the digest in bytes.
+   * @returns {Buffer} Hash output as a buffer.
+   */
+  static blake2b(input, digestSize = this.BLAKE2B_DIGEST_SIZE) {
+    return _crypto.default.createHash('blake2b', {
+      digestLength: digestSize
+    }).update(input).digest();
+  }
+
+  /**
+   * Generates a compact, MongoDB-friendly hash string using BLAKE2b and Base62 encoding.
+   *
+   * @param {string} input - Input string to hash.
+   * @param {number} [length=GenerateHash.DEFAULT_ID_LENGTH] - Desired output length of the encoded hash.
+   * @returns {string} Base62-encoded BLAKE2b hash string.
+   */
+  static compactHash(input, length = this.DEFAULT_ID_LENGTH) {
+    const hash = this.blake2b(input);
+    return this.toBase62(hash, length);
+  }
+
+  /**
+   * Generates a SHA-256 hash of the input.
+   *
+   * @param {string} input - The input string to hash.
+   * @returns {string} Hexadecimal representation of the SHA-256 hash.
+   */
+  static SHA256(input) {
+    return _crypto.default.createHash('sha256').update(input).digest('hex');
+  }
+
+  /**
+   * Generates an MD5 hash of the input.
+   *
+   * @deprecated MD5 is not secure for cryptographic or security-sensitive operations.
+   * @param {string} input - The input string to hash.
+   * @returns {string} Hexadecimal representation of the MD5 hash.
+   */
+  static MD5(input) {
+    return _crypto.default.createHash('md5').update(input).digest('hex');
+  }
+
+  /**
+   * Generates a SHA-1 hash of the input.
+   *
+   * @deprecated SHA-1 is not secure for cryptographic or security-sensitive operations.
+   * @param {string} input - The input string to hash.
+   * @returns {string} Hexadecimal representation of the SHA-1 hash.
+   */
+  static SHA1(input) {
+    return _crypto.default.createHash('sha1').update(input).digest('hex');
+  }
+
+  /**
+   * Generates a SHA3-256 hash of the input.
+   *
+   * @param {string} input - The input string to hash.
+   * @returns {string} Hexadecimal representation of the SHA3-256 hash.
+   */
+  static SHA3_256(input) {
+    return _crypto.default.createHash('sha3-256').update(input).digest('hex');
+  }
+
+  /**
+   * Generates a PBKDF2 hash using SHA-512.
+   *
+   * @param {string} password - The password to hash.
+   * @param {string} salt - The salt to use in the hashing process.
+   * @returns {string} Hexadecimal representation of the derived key.
+   */
+  static PBKDF2(password, salt) {
+    const iterations = 100000;
+    const keyLength = 64;
+    return _crypto.default.pbkdf2Sync(password, salt, iterations, keyLength, 'sha512').toString('hex');
+  }
+
+  /**
+   * Generates a SHA-512 hash.
+   * @param {string} input - Input string to hash.
+   * @returns {string} Hexadecimal SHA-512 hash.
+   */
+  static SHA512(input) {
+    return _crypto.default.createHash('sha512').update(input).digest('hex');
+  }
+
+  /**
+   * Generates a SHA3-512 hash.
+   * @param {string} input - Input string to hash.
+   * @returns {string} Hexadecimal SHA3-512 hash.
+   */
+  static SHA3_512(input) {
+    return _crypto.default.createHash('sha3-512').update(input).digest('hex');
+  }
+
+  /**
+   * Generates a RIPEMD-160 hash.
+   * @param {string} input - Input string to hash.
+   * @returns {string} Hexadecimal RIPEMD-160 hash.
+   */
+  static RIPEMD160(input) {
+    return _crypto.default.createHash('ripemd160').update(input).digest('hex');
+  }
+
+  /**
+   * Generates a BLAKE2s256 hash.
+   * @param {string} input - Input string to hash.
+   * @returns {string} Hexadecimal BLAKE2s256 hash.
+   */
+  static BLAKE2s256(input) {
+    return _crypto.default.createHash('blake2s256').update(input).digest('hex');
+  }
+}
+exports.GenerateHash = GenerateHash;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@quicore/hash",
+  "version": "1.0.0",
+  "description": "A lightweight utility for fast access to the most commonly used hashing algorithms including SHA, Blake2, and PBKDF2",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "babel src -d dist"
+  },
+  "keywords": [
+    "hash",
+    "crypto",
+    "blake2",
+    "sha256",
+    "sha3",
+    "pbkdf2",
+    "ripemd160",
+    "hashing",
+    "base62",
+    "compact-hash",
+    "nodejs"
+  ],
+  "author": "quicore",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "^7.26.10",
+    "@babel/cli": "^7.27.0",
+    "@babel/preset-env": "^7.26.9"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}