@imbatcat/vietnam-qr-pay 1.5.1

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) xuannghia <xuannghia.dev@gmail.com> (https://xuannghia.dev)
+
+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,250 @@
+# Vietnam QR Pay
+
+Thư viện hỗ trợ encode/decode mã QR của VietQR (QR Ngân hàng, QR Đa năng Momo/ZaloPay) & VNPayQR
+
+[![npm](https://img.shields.io/npm/v/vietnam-qr-pay.svg)](https://www.npmjs.com/package/vietnam-qr-pay)
+[![download](https://img.shields.io/npm/dt/vietnam-qr-pay.svg)](https://www.npmjs.com/package/vietnam-qr-pay)
+[![bundlephobia](https://img.shields.io/bundlephobia/minzip/vietnam-qr-pay.svg)](https://bundlephobia.com/package/vietnam-qr-pay)
+
+## Install
+
+```bash
+npm install vietnam-qr-pay
+```
+
+
+## Encode - Tạo mã QR
+
+### VietQR Tĩnh
+```javascript
+
+import { QRPay, BanksObject } from 'vietnam-qr-pay';
+
+const qrPay = QRPay.initVietQR({
+  bankBin: BanksObject.acb.bin,
+  bankNumber: '257678859', // Số tài khoản
+})
+const content = qrPay.build()
+
+console.log(content)
+// 00020101021138530010A0000007270123000697041601092576788590208QRIBFTTA53037045802VN6304AE9F
+ 
+```
+
+### VietQR Động
+
+```javascript
+import { QRPay, BanksObject } from 'vietnam-qr-pay';
+
+const qrPay = QRPay.initVietQR({
+  bankBin: BanksObject.acb.bin,
+  bankNumber: '257678859', // Số tài khoản
+  amount: '10000', // Số tiền
+  purpose: 'Chuyen tien', // Nội dung chuyển tiền
+})
+const content = qrPay.build()
+
+console.log(content)
+// 00020101021238530010A0000007270123000697041601092576788590208QRIBFTTA53037045405100005802VN62150811Chuyen tien630453E6
+
+```
+
+### QR Đa năng của MoMo và ZaloPay
+
+Hiện tại, QR Đa năng của MoMo và ZaloPay đang thông qua Ngân hàng Bản Việt (BVBank) để nhận tiền.
+
+Mỗi tài khoản MoMo/ZaloPay sẽ được gán một STK tương ứng tại BVBank. Tiền chuyển đến STK này sẽ được chuyển tiếp đến ví MoMo/ZaloPay.
+
+Bạn có thể lấy STK này tại trang chi tiết của QR Nhận tiền trong ứng dụng MoMo/ZaloPay.
+
+#### MoMo
+
+```javascript
+import { QRPay, BanksObject } from 'vietnam-qr-pay';
+
+// Số tài khoản trong ví MoMo
+const accountNumber = '99MM24011M34875080'
+
+const momoQR = QRPay.initVietQR({
+  bankBin: BanksObject.banviet.bin,
+  bankNumber: accountNumber,
+  // amount: '10000', // Số tiền (không bắt buộc)
+  // purpose: 'Chuyen tien', // Nội dung (không bắt buộc)
+})
+
+// Trong mã QR của MoMo có chứa thêm 1 mã tham chiếu tương ứng với STK
+momoQR.additionalData.reference = 'MOMOW2W' + accountNumber.slice(10)
+
+// Mã QR của MoMo có thêm 1 trường ID 80 với giá trị là 3 số cuối của SỐ ĐIỆN THOẠI của tài khoản nhận tiền
+momoQR.setUnreservedField('80', '046')
+
+const content = momoQR.build()
+
+// 00020101021138620010A00000072701320006970454011899MM24011M348750800208QRIBFTTA53037045802VN62190515MOMOW2W3487508080030466304EBC8
+
+```
+
+<img src="test/momo.svg" width="160">
+
+#### ZaloPay
+
+> Trong mã QR của ZaloPay có chứa một số thông tin bổ sung ở trường ID 26. Tuy nhiên chưa rõ chức năng của các thông tin này (có thể là dùng để định danh từng mã QR đc tạo trên hệ thống của ZaloPay). Trong ví dụ dưới sẽ bỏ qua các thông tin này.
+
+```javascript
+import { QRPay, BanksObject } from 'vietnam-qr-pay';
+
+// Số tài khoản trong ví ZaloPay
+const accountNumber = '99ZP24009M07248267'
+  
+const zaloPayQR = QRPay.initVietQR({
+  bankBin: BanksObject.banviet.bin,
+  bankNumber: accountNumber,
+  // amount: '10000', // Số tiền (không bắt buộc)
+  // purpose: 'Chuyen tien', // Nội dung (không bắt buộc)
+})
+
+const content = zaloPayQR.build()
+// 00020101021138620010A00000072701320006970454011899ZP24009M072482670208QRIBFTTA53037045802VN6304073C
+```
+
+<img src="test/zalopay.svg" width="160">
+
+
+### VNPay 
+
+```javascript
+const qrPay = QRPay.initVNPayQR({
+  merchantId: '0102154778',
+  merchantName: 'TUGIACOMPANY',
+  store: 'TU GIA COMPUTER',
+  terminal: 'TUGIACO1',
+})
+const content = qrPay.build()
+console.log(content)
+// 00020101021126280010A0000007750110010531314453037045408210900005802VN5910CELLPHONES62600312CPSHN ONLINE0517021908061613127850705ONLHN0810CellphoneS63047685
+
+```
+
+
+## Decode mã QR
+
+### VietQR
+```javascript
+import { QRPay } from 'vietnam-qr-pay';
+
+const qrContent = '00020101021238530010A0000007270123000697041601092576788590208QRIBFTTA5303704540410005802VN62150811Chuyen tien6304BBB8'
+const qrPay = new QRPay(qrContent);
+console.log(qrPay.isValid) // true
+console.log(qrPay.provider.name) // VIETQR
+console.log(qrPay.consumer.bankBin) // 970416
+console.log(qrPay.consumer.bankNumber) // 257678859
+console.log(qrPay.amount) // 1000
+console.log(qrPay.additionalData.purpose) // Chuyen tien
+
+```
+
+### VNPay
+```javascript
+import { QRPay } from 'vietnam-qr-pay';
+
+const qrContent = '00020101021126280010A0000007750110010531314453037045408210900005802VN5910CELLPHONES62600312CPSHN ONLINE0517021908061613127850705ONLHN0810CellphoneS63047685'
+const qrPay = new QRPay(qrContent);
+console.log(qrPay.isValid) // true
+console.log(qrPay.provider.name) // VNPAY
+console.log(qrPay.merchant.merchantId) // 0105313144
+console.log(qrPay.amount) // 21090000
+console.log(qrPay.additionalData.store) // CPSHN ONLINE
+console.log(qrPay.additionalData.terminal) // ONLHN
+console.log(qrPay.additionalData.purpose) // CellphoneS
+console.log(qrPay.additionalData.reference) // 02190806161312785
+
+```
+
+
+## `QRPay` class
+
+
+```javascript
+import { QRPay } from 'vietnam-qr-pay';
+```
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `isValid` | `boolean` | Kiểm tra tính hợp lệ của mã QR |
+| `initMethod` | `string` | Phương thức khởi tạo (`11` - QR Tĩnh, `12` - QR động) |
+| `provider` | `Provider` | Thông tin nhà cung cấp |
+| `merchant` | `Merchant` | Thông tin merchant |
+| `consumer` | `Consumer` | Thông tin người thanh toán |
+| `amount` | `string` | Số tiền giao dịch |
+| `currency` | `string` | Mã tiền tệ (VNĐ: 704) |
+| `nation` | `string` | Mã quốc gia |
+| `additionalData` | `AdditionalData` | Thông tin bổ sung |
+| `crc` | `string` | Mã kiểm tra |
+| `build()` | `method` | Tạo lại mã QR mới |
+
+### `Provider` class
+
+Thông tin đơn vị cung cấp mã QR (VietQR, VNPay)
+
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `guid` | `string` | Mã định danh toàn cầu |
+| `name` | `string` | Tên nhà cung cấp |
+
+### `Merchant` class
+
+Thông tin merchant (Đơn vị chấp nhận thanh toán)
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `id` | `string` | Mã định danh đơn vị CNTT |
+| `name` | `string` | Tên đơn vị CNTT |
+
+### `Consumer` class
+
+Thông tin người thanh toán
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `bankBin` | `string` | Mã ngân hàng |
+| `bankNumber` | `string` | Số tài khoản |
+
+### `AdditionalData` class
+
+Thông tin bổ sung
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `billNumber` | `string` | Số hóa đơn |
+| `mobileNumber` | `string` | Số điện thoại di động |
+| `store` | `string` | Tên cửa hàng |
+| `loyaltyNumber` | `string` | Mã khách hàng thân thiết |
+| `reference` | `string` | Mã Tham chiếu |
+| `customerLabel` | `string` | Mã khách hàng |
+| `terminal` | `string` | Tên điểm bản |
+| `purpose` | `string` | Nội dung giao dịch |
+
+###  `build()` method
+
+Trả về nội dung mã QR mới
+
+```javascript
+import { QRPay } from 'vietnam-qr-pay';
+
+
+const qrContent = '00020101021238530010A0000007270123000697041601092576788590208QRIBFTTA5303704540410005802VN62150811Chuyen tien6304BBB8'
+const qrPay = new QRPay(qrContent);
+
+// qrPay.amount === "10000"
+// qrPay.additionalData.purpose === "Chuyen tien"
+
+qrPay.amount = '999999';
+qrPay.additionalData.purpose = 'Cam on nhe';
+
+const newQRContent = qrPay.build();
+/* 
+00020101021238530010A0000007270123000697041601092576788590208QRIBFTTA530370454069999995802VN62140810Cam on nhe6304E786
+*/
+
+```

package/dist/constants/bank-apps.d.ts

@@ -0,0 +1,10 @@
+import { BankKey } from './bank-key';
+export interface BankApp {
+    bank: BankKey;
+    scheme?: string;
+    packageId?: string;
+    appStoreId?: string;
+    supportVietQR?: boolean;
+    supportVNPayQR?: boolean;
+}
+export declare const BankApps: BankApp[];