Merge pull request #12 from bchainhub/update/functions-06

Update/functions 06

Author: rastislavcore

.gitignore

@@ -10,6 +10,7 @@ package-lock.json
 
 /dist-test/
 /dist/
+/coverage/
 
 .DS_Store
 .AppleDouble

README.md

@@ -2,14 +2,33 @@
 
 `payto-rl` is a TypeScript library for handling Payto Resource Locators (PRLs). This library is based on the [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) API and provides additional functionality for managing PRLs.
 
+[![npm](https://img.shields.io/npm/v/payto-rl?label=npm&color=cb3837&logo=npm)](https://www.npmjs.com/package/payto-rl)
+[![License: CORE](https://img.shields.io/badge/License-CORE-yellow?logo=googledocs)](LICENSE)
+[![Bundle Size](https://img.shields.io/bundlephobia/minzip/payto-rl?label=Size&logo=tsnode)](https://bundlephobia.com/package/payto-rl@latest)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-blue?logo=typescript)](https://www.typescriptlang.org/)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/bchainhub?label=Sponsors&logo=githubsponsors&color=EA4AAA)](https://github.com/sponsors/bchainhub)
+
+## Features
+
+- 🐥 **Small**: **[![Bundle Size](https://img.shields.io/bundlephobia/minzip/payto-rl?label=&color=6ead0a)](https://bundlephobia.com/package/payto-rl@latest)** gzipped, distributed as minified ES modules.
+- 📜 **Standardized**: Based on the [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) Web API.
+- 🏗️ **Simple**: Easy to implement.
+- 🗂 **Typed**: Ships with types included.
+- 🧪 **Tested**: Robust test coverage.
+- 🌲 **Tree Shaking**: Zero dependencies, no side effects.
+
 ## Installation
 
-Install the `payto-rl` package using npm or yarn:
+Install the `payto-rl` package using your package manager:
 
 ```sh
 npm i payto-rl
 ```
 
+```sh
+pnpm add payto-rl
+```
+
 ```sh
 yarn add payto-rl
 ```
@@ -37,6 +56,11 @@ payto.value = 20.02;
 console.log(payto.amount);   // 'ctn:20.02'
 console.log(payto.fiat);     // 'eur'
 
+// Color customization
+payto.colorBackground = 'ff0000';  // Red background (6-character hex)
+payto.colorForeground = '000000';  // Black foreground
+console.log(payto.colorBackground); // 'ff0000'
+
 // ACH payment examples
 const achPayto1 = new Payto('payto://ach/123456789/1234567'); // With routing number
 console.log(achPayto1.routingNumber); // 123456789
@@ -45,11 +69,11 @@ console.log(achPayto1.accountNumber); // 1234567
 const achPayto2 = new Payto('payto://ach/1234567'); // Account number only
 console.log(achPayto2.accountNumber); // 1234567
 
-// UPI/PIX payment examples
-const upiPayto = new Payto('payto://upi/user@example.com');
+// UPI/PIX payment examples (case-insensitive email)
+const upiPayto = new Payto('payto://upi/USER@example.com');
 console.log(upiPayto.accountAlias); // 'user@example.com'
 
-const pixPayto = new Payto('payto://pix/user@example.com');
+const pixPayto = new Payto('payto://pix/user@EXAMPLE.com');
 console.log(pixPayto.accountAlias); // 'user@example.com'
 
 // Geo location example
@@ -64,12 +88,22 @@ plusPayto.location = '8FVC9G8V+R9';  // Valid plus code
 console.log(plusPayto.void);     // 'plus'
 console.log(plusPayto.location); // '8FVC9G8V+R9'
 
-// Bank details example
-const bankPayto = new Payto('payto://bic/DEUTDEFF500');
+// Bank details example (case-insensitive BIC)
+const bankPayto = new Payto('payto://bic/deutdeff500');
 console.log(bankPayto.bic);           // 'DEUTDEFF500'
 bankPayto.routingNumber = 123456789;  // Valid 9-digit routing number
 console.log(bankPayto.routingNumber); // 123456789
 
+// Value handling examples
+const numericPayto = new Payto('payto://example/address?amount=10.5');
+console.log(numericPayto.value);  // 10.5
+console.log(numericPayto.amount); // '10.5'
+
+const tokenPayto = new Payto('payto://example/address?amount=token:10.5');
+console.log(tokenPayto.value);    // 10.5
+console.log(tokenPayto.amount);   // 'token:10.5'
+console.log(tokenPayto.asset);    // 'token'
+
 // Convert to JSON object
 const jsonObj = payto.toJSONObject();
 console.log(jsonObj.colorForeground); // Access typed properties
@@ -90,28 +124,28 @@ Creates a new Payto instance from a payto URL string.
 
 | Property | Type | Description |
 |----------|------|-------------|
-| `accountAlias` | `string \| null` | Email address for UPI/PIX payments |
+| `accountAlias` | `string \| null` | Email address for UPI/PIX payments (case-insensitive) |
 | `accountNumber` | `number \| null` | Account number (7-14 digits) for ACH payments |
 | `address` | `string \| null` | Payment address |
-| `amount` | `string \| null` | Payment amount with currency |
+| `amount` | `string \| null` | Payment amount with optional currency prefix |
 | `asset` | `string \| null` | Asset type or contract address |
 | `barcode` | `'qr' \| 'pdf417' \| 'aztec' \| 'code128' \| null` | Barcode format |
-| `bic` | `string \| null` | Bank Identifier Code (8 or 11 characters) |
-| `colorBackground` | `string \| null` | Background color in hex format |
-| `colorForeground` | `string \| null` | Foreground color in hex format |
-| `currency` | `[string \| null, string \| null]` | Currency codes array |
+| `bic` | `string \| null` | Bank Identifier Code (8 or 11 characters, case-insensitive) |
+| `colorBackground` | `string \| null` | Background color in 6-character hex format |
+| `colorForeground` | `string \| null` | Foreground color in 6-character hex format |
+| `currency` | `[string \| null, string \| null]` | Currency codes array [asset, fiat] |
 | `deadline` | `number \| null` | Payment deadline (Unix timestamp) |
 | `donate` | `boolean \| null` | Donation flag |
-| `fiat` | `string \| null` | Fiat currency code |
+| `fiat` | `string \| null` | Fiat currency code (case-insensitive) |
 | `hash` | `string` | URL hash component |
 | `host` | `string` | Complete host (hostname:port) |
-| `hostname` | `string` | Host without port |
+| `hostname` | `string` | Host without port (case-insensitive) |
 | `href` | `string` | Complete URL string |
-| `iban` | `string \| null` | International Bank Account Number |
+| `iban` | `string \| null` | International Bank Account Number (case-insensitive) |
 | `item` | `string \| null` | Item description (max 40 chars) |
 | `location` | `string \| null` | Location data (format depends on void type) |
 | `message` | `string \| null` | Payment message |
-| `network` | `string` | Network identifier |
+| `network` | `string` | Network identifier (case-insensitive) |
 | `organization` | `string \| null` | Organization name (max 25 chars) |
 | `origin` | `string \| null` | URL origin |
 | `password` | `string` | URL password component |
@@ -120,14 +154,14 @@ Creates a new Payto instance from a payto URL string.
 | `protocol` | `string` | URL protocol (always 'payto:') |
 | `receiverName` | `string \| null` | Receiver's name |
 | `recurring` | `string \| null` | Recurring payment details |
-| `route` | `string \| null` | Additional routing information |
 | `routingNumber` | `number \| null` | Bank routing number (9 digits) |
+| `rtl` | `boolean \| null` | right-to-left layout |
 | `search` | `string` | URL search component |
 | `searchParams` | `URLSearchParams` | URL search parameters |
 | `split` | `[string, string, boolean] \| null` | Payment split information |
 | `swap` | `string \| null` | Swap transaction details |
 | `username` | `string` | URL username component |
-| `value` | `number \| null` | Numeric amount value |
+| `value` | `number \| null` | Numeric amount value (extracted from both simple and token:amount formats) |
 | `void` | `string \| null` | Void path type (e.g., 'geo', 'plus') |
 
 ### Methods
@@ -142,18 +176,26 @@ Creates a new Payto instance from a payto URL string.
 
 The library includes TypeScript type definitions and runtime validation for:
 
-- Bank Identifier Codes (BIC)
+- Bank Identifier Codes (BIC) - 8 or 11 characters, case-insensitive
 - Routing numbers (9 digits)
 - Account numbers (7-14 digits)
-- Email addresses (for UPI/PIX)
+- Email addresses (for UPI/PIX, case-insensitive)
 - Geographic coordinates
 - Plus codes
 - Unix timestamps
 - Barcode formats
-- IBAN format
+- IBAN format (case-insensitive)
+- Color formats (6-character hex)
 
 ## Payment System Support
 
+### IBAN
+
+Supports two formats (case-insensitive):
+
+- `payto://iban/iban` (without BIC)
+- `payto://iban/bic/iban` (with BIC)
+
 ### ACH Payments
 
 Supports two formats:
@@ -163,7 +205,7 @@ Supports two formats:
 
 ### UPI/PIX Payments
 
-Email-based payment identifiers:
+Email-based payment identifiers (case-insensitive):
 
 - `payto://upi/email@example.com`
 - `payto://pix/email@example.com`
@@ -190,4 +232,4 @@ If you find this project useful, please consider supporting it:
 - [Bitcoin](https://www.blockchain.com/explorer/addresses/btc/bc1pd8guxjkr2p6n2kl388fdj2trete9w2fr89xlktdezmcctxvtzm8qsymg0d)
 - [Litecoin](https://www.blockchain.com/explorer/addresses/ltc/ltc1ql8dvx0wv0nh2vncpt9j3zqefaehsd25cwp7pfx)
 
-List of sponsors: [![GitHub Sponsors](https://img.shields.io/github/sponsors/bchainhub)](https://github.com/sponsors/bchainhub)
+List of sponsors: [![GitHub Sponsors](https://img.shields.io/github/sponsors/bchainhub?label=Sponsors&logo=githubsponsors&color=EA4AAA)](https://github.com/sponsors/bchainhub)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "payto-rl",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "PayTo Resource Locator",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,6 +9,7 @@
   "sideEffects": false,
   "scripts": {
     "test": "npm run build && node --no-deprecation --import 'data:text/javascript,import { register } from \"node:module\"; import { pathToFileURL } from \"node:url\"; register(\"ts-node/esm\", pathToFileURL(\"./\"));' ./node_modules/uvu/bin.js test",
+    "test:coverage": "c8 npm test",
     "build": "tsc --declaration --declarationDir ./dist",
     "dev": "node --import 'data:text/javascript,import { register } from \"node:module\"; import { pathToFileURL } from \"node:url\"; register(\"ts-node/esm\", pathToFileURL(\"./\"));' --inspect src/index.ts"
   },
@@ -47,7 +48,8 @@
     ".": "./dist/index.js"
   },
   "devDependencies": {
-    "@types/node": "^22.10.7",
+    "@types/node": "^22.10.9",
+    "c8": "^9.1.0",
     "esm": "^3.2.25",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.3",