@vlasky/shacrypt 0.5.0 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.5.1] - 2026-01-29
+
+### Added
+- TypeScript type declarations (`index.d.ts`)
+
 ## [0.5.0] - 2026-01-28
 
 ### Changed

package/README.md

@@ -16,6 +16,8 @@ Asynchronous mode is especially useful in that computation is performed in Node.
 npm install @vlasky/shacrypt
 ```
 
+TypeScript type declarations are included.
+
 NOTE: You will need to have C++ build tools installed on your system to successfully install the package. If you are running under Windows, you can download Microsoft's [Build Tools for Visual Studio 2017](https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017).
 
 ### Usage

package/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Callback function for async hash operations.
+ */
+type HashCallback = (error: Error | null, hash: string) => void;
+
+/**
+ * Generate SHA256-CRYPT hash (synchronous).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns The hashed password string
+ */
+export function sha256crypt(password: string, salt?: string, rounds?: number): string;
+
+/**
+ * Generate SHA256-CRYPT hash (callback-based async).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @param callback - Callback function receiving (error, hash)
+ */
+export function sha256crypt(password: string, salt: string | undefined, rounds: number | undefined, callback: HashCallback): void;
+
+/**
+ * Generate SHA512-CRYPT hash (synchronous).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns The hashed password string
+ */
+export function sha512crypt(password: string, salt?: string, rounds?: number): string;
+
+/**
+ * Generate SHA512-CRYPT hash (callback-based async).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @param callback - Callback function receiving (error, hash)
+ */
+export function sha512crypt(password: string, salt: string | undefined, rounds: number | undefined, callback: HashCallback): void;
+
+/**
+ * Generate SHA256-CRYPT hash (async/await compatible).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns Promise resolving to the hashed password string
+ */
+export function sha256cryptAsync(password: string, salt?: string, rounds?: number): Promise<string>;
+
+/**
+ * Generate SHA512-CRYPT hash (async/await compatible).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns Promise resolving to the hashed password string
+ */
+export function sha512cryptAsync(password: string, salt?: string, rounds?: number): Promise<string>;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@vlasky/shacrypt",
   "description": "Node.js wrapper over sha256-crypt and sha512-crypt functions originally created by Ulrich Drepper https://www.akkadia.org/drepper/SHA-crypt.txt",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "homepage": "https://github.com/vlasky/shacrypt",
   "author": "Vlad Lasky <github@vladlasky.com> (https://github.com/vlasky/)",
   "contributors": [
     "Oleksiy Krivoshey <oleksiyk@gmail.com> (https://github.com/oleksiyk/)"
   ],
   "main": "shacrypt",
+  "types": "index.d.ts",
   "scripts": {
     "install": "node-gyp rebuild",
     "test": "make test"