@naman_deep_singh/security 1.0.3 → 1.0.4

package/README.md

@@ -1,19 +1,25 @@
 # @naman_deep_singh/security
 
-Security utilities for password hashing and JWT token management.
+Security utilities for password hashing and JWT token management with TypeScript support.
 
 ## Installation
 
 ```bash
 npm install @naman_deep_singh/security
-or
-pnpm add @naman_deep_singh/security
-or
-yarn add @naman_deep_singh/security
 ```
 
+## Features
+
+- ✅ **Password hashing** with bcrypt (salt rounds: 10)
+- ✅ **JWT token management** with configurable expiration
+- ✅ **TypeScript support** with full type safety
+- ✅ **Hybrid exports** - use named imports or namespace imports
+- ✅ **Backward compatibility** with legacy function names
+- ✅ **Async/await support** for all operations
+
 ## Usage
 
+### Named Imports (Tree-shakable)
 ```typescript
 import { hashPassword, verifyPassword, generateToken, verifyToken } from '@naman_deep_singh/security';
 
@@ -22,21 +28,89 @@ const hashedPassword = await hashPassword('mypassword');
 const isValid = await verifyPassword('mypassword', hashedPassword);
 
 // JWT tokens
-const token = generateToken({ userId: 1 }, 'your-secret-key');
+const token = generateToken({ userId: 1, role: 'admin' }, 'your-secret-key', '24h');
 const decoded = verifyToken(token, 'your-secret-key');
 ```
 
-## API
+### Namespace Import
+```typescript
+import SecurityUtils from '@naman_deep_singh/security';
+
+const hashedPassword = await SecurityUtils.hashPassword('mypassword');
+const token = SecurityUtils.generateToken({ userId: 1 }, 'secret');
+```
+
+### Backward Compatibility
+```typescript
+import { comparePassword, signToken } from '@naman_deep_singh/security';
+
+// Legacy function names still work
+const isValid = await comparePassword('password', 'hash');
+const token = signToken({ userId: 1 }, 'secret');
+```
+
+## API Reference
 
 ### Password Functions
-- `hashPassword(password: string): Promise<string>` - Hash a password using bcrypt
+- `hashPassword(password: string): Promise<string>` - Hash a password using bcrypt with salt rounds 10
 - `verifyPassword(password: string, hash: string): Promise<boolean>` - Verify password against hash
+- `comparePassword(password: string, hash: string): Promise<boolean>` - Alias for verifyPassword (backward compatibility)
 
 ### JWT Functions
-- `generateToken(payload: object, secret: string, expiresIn?: string): string` - Generate JWT token
-- `verifyToken(token: string, secret: string): any` - Verify and decode JWT token
+- `generateToken(payload: Record<string, unknown>, secret: Secret, expiresIn?: string): string` - Generate JWT token
+- `verifyToken(token: string, secret: Secret): string | JwtPayload` - Verify and decode JWT token
+- `signToken(payload: Record<string, unknown>, secret: Secret, expiresIn?: string): string` - Alias for generateToken (backward compatibility)
+
+## Examples
+
+### Complete Authentication Flow
+```typescript
+import { hashPassword, verifyPassword, generateToken, verifyToken } from '@naman_deep_singh/security';
+
+// Registration
+async function registerUser(email: string, password: string) {
+  const hashedPassword = await hashPassword(password);
+  // Save user with hashedPassword to database
+  return { email, password: hashedPassword };
+}
+
+// Login
+async function loginUser(email: string, password: string, storedHash: string) {
+  const isValid = await verifyPassword(password, storedHash);
+  
+  if (!isValid) {
+    throw new Error('Invalid credentials');
+  }
+  
+  const token = generateToken(
+    { email, loginTime: Date.now() },
+    process.env.JWT_SECRET!,
+    '7d'
+  );
+  
+  return { token };
+}
+
+// Verify JWT
+function authenticateRequest(token: string) {
+  try {
+    const decoded = verifyToken(token, process.env.JWT_SECRET!);
+    return decoded;
+  } catch (error) {
+    throw new Error('Invalid token');
+  }
+}
+```
 
 ## Dependencies
 
-- bcryptjs - For password hashing
-- jsonwebtoken - For JWT token management
+- **bcryptjs** - For secure password hashing
+- **jsonwebtoken** - For JWT token management
+
+## Security Best Practices
+
+1. **Use strong secrets** for JWT signing (minimum 32 characters)
+2. **Set appropriate expiration times** for tokens
+3. **Store JWT secrets in environment variables**
+4. **Never log or expose hashed passwords**
+5. **Use HTTPS** in production for token transmission

package/dist/index.d.ts

@@ -1,5 +1,16 @@
-import { Secret } from "jsonwebtoken";
+import { Secret, JwtPayload } from "jsonwebtoken";
 export declare const hashPassword: (password: string) => Promise<string>;
+export declare const verifyPassword: (password: string, hash: string) => Promise<boolean>;
 export declare const comparePassword: (password: string, hash: string) => Promise<boolean>;
-export declare const signToken: (payload: object, secret: Secret, expiresIn?: string) => string;
-export declare const verifyToken: (token: string, secret: Secret) => object | string;
+export declare const generateToken: (payload: Record<string, unknown>, secret: Secret, expiresIn?: string) => string;
+export declare const verifyToken: (token: string, secret: Secret) => string | JwtPayload;
+export declare const signToken: (payload: Record<string, unknown>, secret: Secret, expiresIn?: string) => string;
+declare const SecurityUtils: {
+    hashPassword: (password: string) => Promise<string>;
+    verifyPassword: (password: string, hash: string) => Promise<boolean>;
+    comparePassword: (password: string, hash: string) => Promise<boolean>;
+    generateToken: (payload: Record<string, unknown>, secret: Secret, expiresIn?: string) => string;
+    verifyToken: (token: string, secret: Secret) => string | JwtPayload;
+    signToken: (payload: Record<string, unknown>, secret: Secret, expiresIn?: string) => string;
+};
+export default SecurityUtils;

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyToken = exports.signToken = exports.comparePassword = exports.hashPassword = void 0;
+exports.signToken = exports.verifyToken = exports.generateToken = exports.comparePassword = exports.verifyPassword = exports.hashPassword = void 0;
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 const bcryptjs_1 = __importDefault(require("bcryptjs"));
 // 🧱 Password helpers
@@ -12,16 +12,30 @@ const hashPassword = async (password) => {
     return bcryptjs_1.default.hash(password, salt);
 };
 exports.hashPassword = hashPassword;
-const comparePassword = async (password, hash) => {
+const verifyPassword = async (password, hash) => {
     return bcryptjs_1.default.compare(password, hash);
 };
-exports.comparePassword = comparePassword;
+exports.verifyPassword = verifyPassword;
+// For backward compatibility
+exports.comparePassword = exports.verifyPassword;
 // 🧩 JWT helpers
-const signToken = (payload, secret, expiresIn = "1h") => {
+const generateToken = (payload, secret, expiresIn = "1h") => {
     return jsonwebtoken_1.default.sign(payload, secret, { expiresIn, algorithm: "HS256" });
 };
-exports.signToken = signToken;
+exports.generateToken = generateToken;
 const verifyToken = (token, secret) => {
     return jsonwebtoken_1.default.verify(token, secret);
 };
 exports.verifyToken = verifyToken;
+// For backward compatibility
+exports.signToken = exports.generateToken;
+// Default export for namespace usage
+const SecurityUtils = {
+    hashPassword: exports.hashPassword,
+    verifyPassword: exports.verifyPassword,
+    comparePassword: exports.comparePassword,
+    generateToken: exports.generateToken,
+    verifyToken: exports.verifyToken,
+    signToken: exports.signToken
+};
+exports.default = SecurityUtils;

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@naman_deep_singh/security",
-  "version": "1.0.3",
-  "description": "",
+  "version": "1.0.4",
+  "description": "Security utilities for password hashing and JWT token management with TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": [
+    "security",
+    "jwt",
+    "bcrypt",
+    "authentication",
+    "password",
+    "token"
+  ],
+  "author": "Naman Deep Singh",
   "license": "ISC",
   "packageManager": "pnpm@10.20.0",
   "dependencies": {
@@ -16,6 +23,7 @@
     "jsonwebtoken": "^9.0.2"
   },
   "devDependencies": {
+    "@types/bcryptjs": "^2.4.6",
     "@types/jsonwebtoken": "^9.0.10",
     "typescript": "^5.9.3"
   }

package/src/index.ts

@@ -1,4 +1,4 @@
-import jwt, { Secret } from "jsonwebtoken";
+import jwt, { Secret, JwtPayload } from "jsonwebtoken";
 import bcrypt from "bcryptjs";
 
 // 🧱 Password helpers
@@ -7,15 +7,33 @@ export const hashPassword = async (password: string): Promise<string> => {
   return bcrypt.hash(password, salt);
 };
 
-export const comparePassword = async (password: string, hash: string): Promise<boolean> => {
+export const verifyPassword = async (password: string, hash: string): Promise<boolean> => {
   return bcrypt.compare(password, hash);
 };
 
+// For backward compatibility
+export const comparePassword = verifyPassword;
+
 // 🧩 JWT helpers
-export const signToken = (payload: object, secret: Secret, expiresIn = "1h"): string => {
+export const generateToken = (payload: Record<string, unknown>, secret: Secret, expiresIn = "1h"): string => {
   return jwt.sign(payload, secret, { expiresIn, algorithm: "HS256" } as jwt.SignOptions);
 };
 
-export const verifyToken = (token: string, secret: Secret): object | string => {
+export const verifyToken = (token: string, secret: Secret): string | JwtPayload => {
   return jwt.verify(token, secret);
 };
+
+// For backward compatibility
+export const signToken = generateToken;
+
+// Default export for namespace usage
+const SecurityUtils = {
+  hashPassword,
+  verifyPassword,
+  comparePassword,
+  generateToken,
+  verifyToken,
+  signToken
+};
+
+export default SecurityUtils;

package/tsconfig.json

@@ -3,18 +3,19 @@
     "target": "ES2020",
     "module": "CommonJS",
     "moduleResolution": "node",
-    "rootDir": "src",
-    "outDir": "dist",
+    "rootDir": "./src",
+    "outDir": "./dist",
     "strict": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
+    "declaration": true,
     "baseUrl": ".",
     "paths": {
       "*": ["*", "*.ts", "*.js"]
     }
   },
-  "include": ["src"],
-  "exclude": ["node_modules"]
-}
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}