Merge pull request #14 from lehuygiang28/update_docs

Update documentation and fix broken anchor

Author: lehuygiang28

README.md

@@ -10,9 +10,9 @@
 <br/>
 
 <p align="center">
-<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/v/vnpay" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/l/vnpay" alt="Package License"><a>
-<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/dm/vnpay" alt="NPM Downloads"></a>
+    <a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/v/vnpay" alt="NPM Version" /></a>
+    <a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/l/vnpay" alt="Package License"><a>
+    <a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/d18m/vnpay" alt="NPM Downloads"></a>
 </p>
 
 <strong>Thư viện mã nguồn mở hỗ trợ thanh toán qua [VNPay](https://vnpay.vn).</strong>
@@ -40,22 +40,37 @@ $ yarn add vnpay
 Cài đặt `vnpay` với `pnpm`:
 
 ```bash
-$ pnpm add vnpay
+$ pnpm install vnpay
 ```
 
 ## Sử dụng:
 
 #### Khởi tạo
 
 ```typescript
-import { VNPay } from 'vnpay';
+import { VNPay, ignoreLogger } from 'vnpay';
 
 const vnpay = new VNPay({
     tmnCode: '2QXUI4B4',
     secureSecret: 'secret',
     vnpayHost: 'https://sandbox.vnpayment.vn',
-    testMode: true, // optional
-    hashAlgorithm: 'SHA512', // optional
+    testMode: true, // tùy chọn
+    hashAlgorithm: 'SHA512', // tùy chọn
+
+    /**
+     * Sử dụng enableLog để bật/tắt logger
+     * Nếu enableLog là false, loggerFn sẽ không được sử dụng trong bất kỳ phương thức nào
+     */
+    enableLog: true, // tùy chọn
+
+    /**
+     * Hàm `loggerFn` sẽ được gọi để ghi log
+     * Mặc định, loggerFn sẽ ghi log ra console
+     * Bạn có thể ghi đè loggerFn để ghi log ra nơi khác
+     *
+     * `ignoreLogger` là một hàm không làm gì cả
+     */
+    loggerFn: ignoreLogger, // tùy chọn
 });
 ```
 
@@ -74,5 +89,9 @@ Trước khi bắt đầu, hãy đảm bảo rằng bạn đã đọc [hướng
 ### Người đóng góp
 
 <a href="https://github.com/lehuygiang28/vnpay/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=lehuygiang28/vnpay&max=20" />
+  <img src="https://contrib.rocks/image?repo=lehuygiang28/vnpay&max=20" alt="List of Contributors"/>
 </a>
+
+## Giấy phép
+
+**[MIT](LICENSE) © [Lê Huy Giang](https://github.com/lehuygiang28)**

README_en-US.md

@@ -10,9 +10,9 @@
 <br/>
 
 <p align="center">
-<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/v/vnpay" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/l/vnpay" alt="Package License"><a>
-<a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/dm/vnpay" alt="NPM Downloads"></a>
+    <a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/v/vnpay" alt="NPM Version" /></a>
+    <a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/l/vnpay" alt="Package License"><a>
+    <a href="https://www.npmjs.com/package/vnpay" target="_blank"><img src="https://img.shields.io/npm/d18m/vnpay" alt="NPM Downloads"></a>
 </p>
 
 <strong>An open-source library support to payment with [VNPay](https://vnpay.vn).</strong>
@@ -40,22 +40,38 @@ $ yarn add vnpay
 Install `vnpay` with `pnpm`:
 
 ```bash
-$ pnpm add vnpay
+$ pnpm install vnpay
 ```
 
 ## Usage:
 
 #### Initialize
 
 ```typescript
-import { VNPay } from 'vnpay';
+import { VNPay, ignoreLogger } from 'vnpay';
 
 const vnpay = new VNPay({
     tmnCode: '2QXUI4B4',
     secureSecret: 'secret',
     vnpayHost: 'https://sandbox.vnpayment.vn',
     testMode: true, // optional
     hashAlgorithm: 'SHA512', // optional
+
+    /**
+     * On/off logger
+     * If enableLog is false, loggerFn will not be used in any method
+     */
+    enableLog: true, // optional
+
+    /**
+     * `loggerFn` will be called to write log when enableLog is true
+     * By default, loggerFn will write log to console
+     * If you want to write log to other place, you can provide other function here
+     *
+     * `ignoreLogger` is a function do nothing
+     *
+     */
+    loggerFn: ignoreLogger, // optional
 });
 ```
 
@@ -74,5 +90,9 @@ Before contributing, please read our [Contribution Guidelines](.github/CONTRIBUT
 ### Contributors
 
 <a href="https://github.com/lehuygiang28/vnpay/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=lehuygiang28/vnpay&max=20" />
+  <img src="https://contrib.rocks/image?repo=lehuygiang28/vnpay&max=20" alt="List of Contributors"/>
 </a>
+
+## License
+
+**[MIT](LICENSE) © [Lê Huy Giang](https://github.com/lehuygiang28)**

docs/docs/01_intro.md

@@ -11,7 +11,7 @@ Thư viện [VNPay](https://github.com/lehuygiang28/vnpay) là một dự án m
 
 ## Tài liệu
 
--   Tìm hiểu cách sử dụng thư viện VNPay tại [đây](installation.md).
+-   Tìm hiểu cách sử dụng thư viện VNPay tại [đây](/installation).
 -   Bạn cũng có thể tìm hiểu cách VNPay hoạt động tại [đây](https://sandbox.vnpayment.vn/apis/).
 
 -   `vnpay` trên [GitHub](https://github.com/lehuygiang28/vnpay)
@@ -31,3 +31,7 @@ _[github.com/lehuygiang28](https://github.com/lehuygiang28)_
 <a href="https://github.com/lehuygiang28/vnpay/graphs/contributors" target="_blank">
   <img src="https://contrib.rocks/image?repo=lehuygiang28/vnpay&max=20" class="contributors_img" />
 </a>
+
+## Giấy phép
+
+**[MIT](https://github.com/lehuygiang28/vnpay/blob/main/LICENSE) © [Lê Huy Giang](https://github.com/lehuygiang28)**

docs/docs/02_installation.md

@@ -17,7 +17,7 @@ $ yarn add vnpay
 ### PNPM
 
 ```bash
-$ pnpm add vnpay
+$ pnpm install vnpay
 ```
 
 ## Sử dụng thư viện
@@ -31,7 +31,7 @@ import { VNPay } from 'vnpay';
 ### Khởi tạo đối tượng {#init-vnpay}
 
 ```typescript
-import { ignoreLogger } from 'vnpay';
+import { VNPay, ignoreLogger } from 'vnpay';
 
 const vnpay = new VNPay({
     tmnCode: 'YOUR_TMNCODE',

docs/docs/04_create-payment-url.md

@@ -58,7 +58,7 @@ Xem thêm các thuộc tính khác tại [VNPay](https://sandbox.vnpayment.vn/ap
 
 ## Sử dụng
 
-### Sử dụng logger {#use-logger}
+### Sử dụng logger {#using-logger}
 
 ```typescript
 import { ProductCode, VnpLocale, consoleLogger } from 'vnpay';

docs/docs/05_ipn/02_verify-ipn-call.md

@@ -12,7 +12,7 @@ import { VerifyIpnCall } from 'vnpay';
 const verify: VerifyIpnCall = vnpay.verifyIpnCall(req.query);
 ```
 
-## Các thuộc tính của đối tượng `VerifyIpnCall`
+## Các thuộc tính của đối tượng `VerifyIpnCall` {#properties-of-the-verify-ipn-call}
 
 Thông tin sau khi xác thực và của VNPay trả về
 
@@ -34,7 +34,7 @@ Các tham số mà VNPay trả về cũng nằm trong đối tượng `VerifyIpn
 ### Sử dụng logger
 
 -   Tương tự như khi tạo URL thanh toán, bạn có thể sử dụng logger để ghi log thông tin xác thực IPN
-    [xem tại đây](create-payment-url.md#use-logger).
+    [xem tại đây](/create-payment-url#using-logger).
 
 ### Với Express
 

docs/docs/06_verify-return-url.md

@@ -17,15 +17,15 @@ const verify: VerifyReturnUrl = vnpay.verifyReturnUrl(req.query);
 Thông tin sau khi xác thực và của VNPay trả về
 
 :::info
-Giống với các thuộc tính của đối tượng [`VerifyIpnCall`](./verify-ipn-call.md#các-thuộc-tính-của-đối-tượng-verifyipncall)
+Giống với các thuộc tính của đối tượng [`VerifyIpnCall`](/ipn/verify-ipn-call#properties-of-the-verify-ipn-call)
 :::
 
 ## Sử dụng
 
 ### Sử dụng logger
 
 -   Tương tự như khi tạo URL thanh toán, bạn có thể sử dụng logger để ghi log thông tin xác thực return URL
-    [xem tại đây](./create-payment-url.md#use-logger).
+    [xem tại đây](/create-payment-url#using-logger).
 
 ### Với Express MVC
 

docs/docs/07_query-dr.md

@@ -66,7 +66,7 @@ Các tham số mà [VNPay trả về](https://sandbox.vnpayment.vn/apis/docs/tru
 
 ### Với logger
 
--   Để có thể sử dụng logger, bạn cần phải khởi tạo [`VNPay`](./installation.md#init-vnpay) với `enableLog` là `true`.
+-   Để có thể sử dụng logger, bạn cần phải khởi tạo [`VNPay`](/installation#init-vnpay) với `enableLog` là `true`.
 
 ```typescript
 import { QueryDr, QueryDrResponse, getDateInGMT7, dateFormat } from 'vnpay';

docs/i18n/en/docusaurus-plugin-content-docs/current/intro.md renamed to docs/i18n/en/docusaurus-plugin-content-docs/current/01_intro.md

@@ -11,7 +11,7 @@ The [VNPay](https://github.com/lehuygiang28/vnpay) library is an open source pro
 
 ## Documentation
 
--   Learn how to use the VNPay library [here](installation.md).
+-   Learn how to use the VNPay library [here](/installation).
 -   You can also learn how VNPay works [here](https://sandbox.vnpayment.vn/apis/).
 
 -   `vnpay` on [GitHub](https://github.com/lehuygiang28/vnpay)
@@ -31,3 +31,7 @@ _[github.com/lehuygiang28](https://github.com/lehuygiang28)_
 <a href="https://github.com/lehuygiang28/vnpay/graphs/contributors" target="_blank">
   <img src="https://contrib.rocks/image?repo=lehuygiang28/vnpay&max=20" class="contributors_img" />
 </a>
+
+## License
+
+**[MIT](https://github.com/lehuygiang28/vnpay/blob/main/LICENSE) © [Lê Huy Giang](https://github.com/lehuygiang28)**

docs/i18n/en/docusaurus-plugin-content-docs/current/02_installation.md

@@ -0,0 +1,59 @@
+# Installation
+
+## Installation with package managers
+
+### NPM
+
+```bash
+$ npm install vnpay
+```
+
+### Yarn
+
+```bash
+$ yarn add vnpay
+```
+
+### PNPM
+
+```bash
+$ pnpm install vnpay
+```
+
+## Usage
+
+### Import the library
+
+```typescript
+import { VNPay } from 'vnpay';
+```
+
+### Initialize the instance {#init-vnpay}
+
+```typescript
+import { VNPay, ignoreLogger } from 'vnpay';
+
+const vnpay = new VNPay({
+    tmnCode: 'YOUR_TMNCODE',
+    secureSecret: 'YOUR_SECURE_SECRET',
+    vnpayHost: 'https://sandbox.vnpayment.vn',
+    testMode: true, // optional, overrides vnpayHost to sandbox if true
+    hashAlgorithm: 'SHA512', // optional
+
+    /**
+     * On/off logger
+     * If enableLog is false, loggerFn will not be used in any method
+     */
+    enableLog: true, // optional
+
+    /**
+     * `loggerFn` will be called to write log when enableLog is true
+     * By default, loggerFn will write log to console
+     * If you want to write log to other place, you can provide other function here
+     *
+     * `ignoreLogger` is a function do nothing
+     *
+     */
+    loggerFn: ignoreLogger, // optional
+});
+```

docs/i18n/en/docusaurus-plugin-content-docs/current/03_get-bank-list.md

@@ -0,0 +1,29 @@
+# Bank List {#get-bank-list}
+
+:::info
+Bank list, used for `vnp_BankCode`
+:::
+
+## Get Bank List
+
+```typescript
+import { Bank } from 'vnpay';
+
+/* ... */
+
+const bankList: Bank[] = await vnpay.getBankList();
+```
+
+## Properties of `Bank` Object
+
+| Property        | Type     | Description    |
+| --------------- | -------- | -------------- |
+| `bank_code`     | `string` | Bank code      |
+| `bank_name`     | `string` | Bank name      |
+| `logo_link`     | `string` | Bank logo link |
+| `bank_type`     | `number` | Bank type      |
+| `display_order` | `number` | Display order  |
+
+:::info
+See more [here](https://sandbox.vnpayment.vn/apis/docs/chuyen-doi-thuat-toan/changeTypeHash.html#tao-url-thanh-toan)
+:::

docs/i18n/en/docusaurus-plugin-content-docs/current/create-payment-url.md renamed to docs/i18n/en/docusaurus-plugin-content-docs/current/04_create-payment-url.md

@@ -1,7 +1,3 @@
----
-sidebar_position: 3
----
-
 # Create Payment URL
 
 Create a payment URL for VNPay.
@@ -39,7 +35,59 @@ const paymentUrl = vnpay.buildPaymentUrl({
 
 See more properties at [VNPay](https://sandbox.vnpayment.vn/apis/docs/thanh-toan-pay/pay.html#danh-s%C3%A1ch-tham-s%E1%BB%91).
 
-## Use in Express
+## Usage
+
+### Using logger {#using-logger}
+
+```typescript
+import { ProductCode, VnpLocale, consoleLogger } from 'vnpay';
+
+/* ... */
+
+const paymentUrl = vnpay.buildPaymentUrl(
+    {
+        vnp_Amount: 10000,
+        vnp_IpAddr: '1.1.1.1',
+        vnp_TxnRef: '123456',
+        vnp_OrderInfo: 'Payment for order 123456',
+        vnp_OrderType: ProductCode.Other,
+        vnp_ReturnUrl: `http://localhost:${port}/vnpay-return`,
+    },
+    {
+        logger: {
+            type: 'pick', // The mode to select log fields, can be 'pick', 'omit' or 'all'
+            fields: ['createdAt', 'method', 'paymentUrl'], // Select the fields to log
+            loggerFn: consoleLogger, // Log data to console, can be replaced with another function
+        },
+    },
+);
+```
+
+### Using custom logger
+
+```typescript
+import { ProductCode, VnpLocale } from 'vnpay';
+
+/* ... */
+
+const paymentUrl = vnpay.buildPaymentUrl(
+    {
+        vnp_Amount: 10000,
+        vnp_IpAddr: '1.1.1.1',
+        vnp_TxnRef: '123456',
+        vnp_OrderInfo: 'Payment for order 123456',
+        vnp_OrderType: ProductCode.Other,
+        vnp_ReturnUrl: `http://localhost:${port}/vnpay-return`,
+    },
+    {
+        logger: {
+            type: 'pick', // The mode to select log fields, can be 'pick', 'omit' or 'all'
+            fields: ['createdAt', 'method', 'paymentUrl'], // Select the fields to log
+            loggerFn: (data) => logToDatabase(data), // Function to log data to database, you need to implement it
+        },
+    },
+);
+```
 
 ### With MVC