RequestNetwork / request-scan

Request Scan app frontend
https://scan.request.network
MIT License
0 stars 0 forks source link

feat: more detail and export pdf #24

Closed rodrigopavezi closed 2 months ago

rodrigopavezi commented 2 months ago

Changes:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve updates to the package.json file, introducing new dependencies for enhanced functionality, particularly in PDF rendering and data handling. The RequestPage component has been modified to include new utility functions for payment references, improved actor information handling, and a PDF export feature. Additionally, a customizable dialog component and a separator component have been added, along with a custom hook for PDF export. The utility functions for payment and transaction handling have been expanded.

Changes

Files Change Summary
package.json Added new dependencies: @radix-ui/react-separator, @react-pdf/renderer, react-pdf-html, @requestnetwork/..., file-saver, json-edit-react, and @types/file-saver.
src/app/request/[id]/page.tsx Updated RequestPage with new payment reference functions, added ActorInfoSection, integrated useExportPDF, and changed layout to a table format.
src/components/ui/dialog.tsx Introduced a customizable dialog component using Radix UI Dialog primitives, including subcomponents for structure.
src/components/ui/separator.tsx Implemented a customizable separator component using Radix UI's Separator primitive for visual layout enhancement.
src/lib/hooks/use-export-pdf.tsx Added useExportPDF hook for generating and exporting PDF invoices from invoice data.
src/lib/utils.ts Renamed calculatePaymentReference to calculateShortPaymentReference, added calculateLongPaymentReference, and introduced new functions for transaction handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RequestPage
    participant useExportPDF
    participant PDFRenderer

    User->>RequestPage: Request details
    RequestPage->>useExportPDF: Trigger PDF export
    useExportPDF->>PDFRenderer: Generate PDF from invoice data
    PDFRenderer-->>useExportPDF: Return PDF file
    useExportPDF-->>RequestPage: Provide downloadable PDF
    RequestPage-->>User: Offer PDF download

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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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.
MantisClone commented 2 months ago

@rodrigopavezi Can you add a screenshot of the resulting Request Details page and PDF file export? That would help me approve this more quickly.

rodrigopavezi commented 2 months ago

Preview:

Screenshot 2024-09-07 at 10 21 13

PDF: invoice-1 (5).pdf

@MantisClone please review. Cheers!

MantisClone commented 2 months ago

Created new issue to track PDF Export Improvement: https://github.com/RequestNetwork/request-scan/issues/25

rodrigopavezi commented 2 months ago

@MantisClone I reused that html. Only remove logo. I can try adding logo or placeholder image for it.