payseed
Version:
A comprehensive TypeScript library for payment processing utilities - format money, validate cards, calculate fees, and more.
230 lines (165 loc) • 6.1 kB
Markdown
> A comprehensive TypeScript library for payment processing utilities
[](https://www.npmjs.com/package/payseed)
[](https://opensource.org/licenses/MIT)
[](https://www.typescriptlang.org/)
PaySeed is a lightweight, type-safe library providing essential utilities for payment processing, money formatting, credit card validation, and fee calculations.
- 💰 **Money Formatting** - Format and parse money values with multiple currency support
- 💳 **Card Validation** - Validate and identify credit card brands using Luhn algorithm
- 🧮 **Fee Calculations** - Calculate processing fees with percentage and fixed components
- 🌍 **Multi-Currency** - Support for USD, EUR, GBP, JPY, CAD, AUD, CHF, CNY
- 🔒 **Type-Safe** - Full TypeScript support with comprehensive type definitions
- ⚡ **Zero Dependencies** - Lightweight and fast
- ✅ **Well Tested** - 100% test coverage
```bash
npm install payseed
yarn add payseed
pnpm add payseed
```
```typescript
import { formatMoney, validateCardNumber, calculateProcessingFee } from 'payseed';
// Format money
const money = { amount: 1234, currency: 'USD' as const };
console.log(formatMoney(money)); // "USD 12.34"
// Validate credit card
const isValid = validateCardNumber('4111111111111111');
console.log(isValid); // true
// Calculate processing fee (2.9% + $0.30)
const fee = calculateProcessingFee(10000, 2.9, 30);
console.log(fee); // 320 (in cents)
```
Format money object to display string.
```typescript
formatMoney({ amount: 1234, currency: 'USD' }); // "USD 12.34"
```
Format with locale support using Intl.NumberFormat.
```typescript
formatCurrency(1234, 'USD'); // "$12.34"
formatCurrency(1000, 'JPY'); // "¥1,000"
```
Parse money string to Money object.
```typescript
parseMoney('$12.34', 'USD'); // { amount: 1234, currency: 'USD' }
```
Convert major units to minor units (e.g., dollars to cents).
```typescript
toMinorUnits(10.50); // 1050
toMinorUnits(100, 0); // 100 (for JPY)
```
Convert minor units to major units (e.g., cents to dollars).
```typescript
toMajorUnits(1050); // 10.50
```
Validate card number using Luhn algorithm.
```typescript
validateCardNumber('4111111111111111'); // true (Valid Visa)
validateCardNumber('4111-1111-1111-1111'); // true (handles formatting)
```
Identify credit card brand from number.
```typescript
identifyCardBrand('4242424242424242'); // 'visa'
identifyCardBrand('5555555555554444'); // 'mastercard'
identifyCardBrand('378282246310005'); // 'amex'
```
Mask credit card number for display.
```typescript
maskCardNumber('4111111111111111'); // '************1111'
maskCardNumber('378282246310005'); // '***********0005'
```
Calculate simple percentage fee.
```typescript
calculateFee(10000, 2.9); // 290
```
Calculate payment processing fee with fixed and percentage components.
```typescript
calculateProcessingFee(10000, 2.9, 30); // 320 (2.9% + $0.30)
```
Add two money values (must be same currency).
```typescript
const sum = addMoney(
{ amount: 1000, currency: 'USD' },
{ amount: 500, currency: 'USD' }
); // { amount: 1500, currency: 'USD' }
```
Subtract two money values.
```typescript
const diff = subtractMoney(
{ amount: 1000, currency: 'USD' },
{ amount: 300, currency: 'USD' }
); // { amount: 700, currency: 'USD' }
```
Multiply money by a factor.
```typescript
const doubled = multiplyMoney(
{ amount: 1000, currency: 'USD' },
2
); // { amount: 2000, currency: 'USD' }
```
Generate unique payment-related ID.
```typescript
seedId(); // 'payseed_lq3x8n2k_a7b9c2'
seedId('transaction'); // 'transaction_lq3x8n2k_a7b9c2'
```
Generate formatted payment reference.
```typescript
paymentReference(); // 'PAY-LQ3X8N2K-A7B9C2'
paymentReference('invoice'); // 'INV-LQ3X8N2K-A7B9C2'
```
Check if money amount is zero.
```typescript
isZeroMoney({ amount: 0, currency: 'USD' }); // true
```
Check if money amount is negative.
```typescript
isNegativeMoney({ amount: -100, currency: 'USD' }); // true
```
PaySeed is perfect for:
- E-commerce applications
- Payment processing systems
- Financial dashboards
- Invoice generation
- Shopping carts
- Subscription billing
- Any application handling money
```bash
pnpm test
pnpm test:ci
```
MIT © [Your Name]
Contributions, issues and feature requests are welcome!
Give a ⭐️ if this project helped you!