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

Update documentation and fix broken anchor #14

Closed lehuygiang28 closed 3 months ago

lehuygiang28 commented 3 months ago

This pull request updates the documentation by fixing a broken anchor and updating the license section. It also includes some file changes related to the bank list and the verification of IPN calls.

Update #9

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 31, 2024 2:31am
coderabbitai[bot] commented 3 months ago

Walkthrough

The changes primarily involve updates to the VNPay npm package documentation. These include adding new logging capabilities, updating import statements, modifying installation instructions, and restructuring sections for better clarity. Additionally, the license has been updated to MIT. New sections and files have been introduced to provide detailed guidance on using various features of the VNPay library, including payment URL creation, IPN verification, and refund processing.

Changes

Files/Groups Change Summary
README.md, README_en-US.md Updated import statements, added logger functionality, and changed license to MIT
docs/docs/01_intro.md, docs/i18n/.../01_intro.md Updated links and added license information
docs/docs/02_installation.md, docs/i18n/.../02_installation.md Updated installation commands and import statements
docs/docs/04_create-payment-url.md, docs/i18n/.../04_create-payment-url.md Updated logger usage section and corrected Vietnamese text
docs/docs/05_ipn/02_verify-ipn-call.md, docs/i18n/.../05_ipn/02_verify-ipn-call.md Restructured content, updated section titles, and added logger usage section
docs/docs/06_verify-return-url.md, docs/i18n/.../06_verify-return-url.md Updated reference links
docs/docs/07_query-dr.md, docs/i18n/.../07_query-dr.md Updated URL references in code snippets
docs/i18n/en/.../03_get-bank-list.md New file providing information on retrieving a bank list
docs/i18n/en/.../08_refund.md New file introducing an API for refund requests
docs/i18n/en/.../20_examples.md Removed sidebar_position metadata
docs/i18n/en/.../05_ipn/_category_.json New JSON configuration for the IPN category

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant VNPay
    participant Logger

    User->>VNPay: Initialize VNPay({ enableLog: true, loggerFn: ignoreLogger })
    Note right of VNPay: VNPay is initialized with logging enabled

    User->>VNPay: Create Payment URL
    VNPay->>Logger: Log payment URL creation
    Logger-->>VNPay: Log entry created

    User->>VNPay: Verify IPN Call
    VNPay->>Logger: Log IPN verification
    Logger-->>VNPay: Log entry created

    User->>VNPay: Process Refund
    VNPay->>Logger: Log refund request
    Logger-->>VNPay: Log entry created
sequenceDiagram
    participant User
    participant VNPay
    participant Logger

    User->>VNPay: Query Payment Result
    VNPay->>Logger: Log query request
    Logger-->>VNPay: Log entry created

    VNPay->>User: Return query result

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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 do a full 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 configuration` to show the current CodeRabbit configuration for the repository. - `@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.