search

lehuygiang28 / vnpay

An open-source nodejs library support to payment with VNPay (vnpay.vn)
https://vnpay.js.org
MIT License
63 stars 26 forks source link

refactor `refund`, update docs #13

Closed lehuygiang28 closed 3 months ago

lehuygiang28 commented 3 months ago

Summary by CodeRabbit

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vnpay ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 26, 2024 7:24am
coderabbitai[bot] commented 3 months ago

Walkthrough

This update introduces significant changes and additions to the VNPay integration documentation and codebase. Key enhancements include a new parameter for specifying bank codes in payment URLs, a detailed guide on retrieving bank lists, and a comprehensive API for processing refunds. The documentation has been restructured, with metadata adjustments and new content for improved clarity and usability.

Changes

Files/Groups Change Summary
docs/docs/02_installation.md Removed metadata sidebar_position: 2 and adjusted heading structure.
docs/docs/03_get-bank-list.md Added new file detailing the retrieval and properties of bank lists for vnp_BankCode.
docs/docs/04_create-payment-url.md Added vnp_BankCode parameter to buildPaymentUrl function.
docs/docs/05_ipn/01_config-ipn.md Removed metadata and refined IPN URL setup content.
docs/docs/05_ipn/02_verify-ipn-call.md Removed metadata, adjusted links, and refined IPN verification content.
docs/docs/05_ipn/_category_.json Introduced JSON configuration for IPN module, defining label and collapsible behavior.
docs/docs/06_verify-return-url.md Removed metadata and focused on verifying return URL post-payment.
docs/docs/07_query-dr.md Removed metadata and restructured heading for querying transaction results.
docs/docs/08_refund.md Added new file introducing refund API, detailing refund transaction initiation and properties.
docs/docs/20_examples.md Removed metadata and restructured document, removing unnecessary lines.
src/types/index.ts Added new types QueryDrResponseFromVNPay, RefundResponse, RefundResponseFromVNPay, and bank.
src/types/refund.type.ts Modified Refund and RefundResponse types, introduced RefundResponseLogger and RefundOptions.
src/utils/common.ts Enhanced generateRandomString to include an optional onlyNumber flag.
src/vnpay.ts Added new types and modified refund method to accept additional parameters, enhanced processing.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant VNPayAPI
    participant BankListService
    participant RefundService
    User->>VNPayAPI: Request to build payment URL with vnp_BankCode
    VNPayAPI->>BankListService: Retrieve bank list
    BankListService-->>VNPayAPI: Return bank list
    VNPayAPI-->>User: Provide payment URL

    User->>VNPayAPI: Request refund
    VNPayAPI->>RefundService: Process refund request
    RefundService-->>VNPayAPI: Refund response
    VNPayAPI-->>User: Provide refund response

[!TIP]

Early Access Features - Sequence Diagrams in the Walkthrough

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to full the review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.