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(queryDr): ⚡ `queryDr` no longer throw error, support logger #10

Closed lehuygiang28 closed 4 months ago

lehuygiang28 commented 4 months ago

Pull Request Description

Type of Change

Please check the type of change your PR introduces:

Does this introduce a breaking change?

If yes, please describe the impact and migration path for existing applications:

Summary by CodeRabbit

vercel[bot] commented 4 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 21, 2024 11:05am
coderabbitai[bot] commented 4 months ago

Walkthrough

The updates encompass several documentation and TypeScript files, introducing new functionalities and enhancing existing ones. Key changes include the addition of QueryDr and QueryDrResponse interfaces, new constants, and functions, as well as modifications to logging and error handling. Documentation has been updated to reflect these changes, providing clearer guidance and examples for users.

Changes

File(s) Change Summary
docs/docs/examples.md Updated sidebar_position value from 7 to 8.
docs/docs/installation.md Changed section heading to "Khởi tạo đối tượng {#init-vnpay}".
docs/docs/query-dr.md Introduced documentation for the queryDr API, including QueryDr and QueryDrResponse interfaces and examples.
src/constants/response-map.constant.ts Added WRONG_CHECKSUM_KEY constant and updated various response maps with translations for it.
src/types/common.type.ts Extended ResultVerified type to include transaction status, verification status, and error message.
src/types/index.ts Added QueryDrResponse to exports in query-dr.type.
src/types/query-dr.type.ts Enhanced QueryDr type and added new types: QueryDrResponse, QueryDrResponseLogger, and QueryDrResponseOptions.
src/utils/common.ts Introduced getDateInGMT7 function for converting dates to GMT+7 timezone.
src/vnpay.ts Enhanced queryDr method in VNPay class with added options, improved error handling, and updated response processing.

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 a review. This is useful when automatic reviews are disabled for the repository. - `@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.