Add support for PDF/UA form field

[lennartb-]

Would fix #46

Summary by CodeRabbit

• New Features

  • Added an option to enable PDF/UA (Universal Access) for generated PDFs.

• Improvements

  • Enhanced PDF generation capabilities to support Universal Access settings.

[coderabbitai]

Walkthrough

A new method EnablePdfUa() has been added to the MergeOfficeBuilder class to support generating PDF/UA documents. The MergeOfficeRequest class now includes an EnablePdfUa property. A conditional block in MergeOfficeRequestExtensions checks this property and adds the necessary form data for PDF/UA conversion. Additionally, a constant PdfUa has been defined in Constants.cs.

Changes

Files	Change Summary
.../MergeOfficeBuilder.cs	Added EnablePdfUa() method and updated UseNativePdfFormat() method.
.../MergeOfficeRequest.cs	Introduced the EnablePdfUa property.
.../MergeOfficeRequestExtensions.cs	Added a conditional block in PropertiesToHttpContent method to handle EnablePdfUa for form data.
.../Constants.cs	Added a new constant PdfUa within the Convert class.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MergeOfficeBuilder
    participant MergeOfficeRequest
    participant MergeOfficeRequestExtensions
    
    User->>MergeOfficeBuilder: EnablePdfUa()
    MergeOfficeBuilder->>MergeOfficeRequest: Set EnablePdfUa to true
    MergeOfficeRequest->>MergeOfficeRequestExtensions: Call PropertiesToHttpContent
    alt EnablePdfUa is true
        MergeOfficeRequestExtensions->>MergeOfficeRequestExtensions: Add PDF/UA conversion form data
    end
    MergeOfficeRequestExtensions-->>MergeOfficeRequest: Return HTTP content
    MergeOfficeRequest-->>MergeOfficeBuilder: Return updated request

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Support for Gotenberg's PDF/UA option (#46)	✅

Poem

In the land of code, where bytes do flow,
A new feature blooms, in a PDF glow.
With EnablePdfUa, documents accessible,
A future bright and universally permissible.
Cheers to the builders, their work done right,
Bringing clarity and access to every byte! 🌟📄

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c9a4187 and 6854915.

Files selected for processing (4)

• lib/Domain/Builders/MergeOfficeBuilder.cs (1 hunks)
• lib/Domain/Requests/MergeOfficeRequest.cs (1 hunks)
• lib/Extensions/MergeOfficeRequestExtensions.cs (1 hunks)
• lib/Infrastructure/Constants.cs (1 hunks)

Files skipped from review due to trivial changes (1)

• lib/Infrastructure/Constants.cs

Additional comments not posted (3)

lib/Extensions/MergeOfficeRequestExtensions.cs (1)

43-47: Ensure correct form data for PDF/UA conversion.

The new conditional block correctly adds form data for PDF/UA conversion when EnablePdfUa is true. Ensure that Constants.Gotenberg.LibreOffice.Routes.Convert.PdfUa is correctly defined and used elsewhere in the codebase.

lib/Domain/Builders/MergeOfficeBuilder.cs (1)

93-100: Confirm the addition of the EnablePdfUa method.

The new method correctly sets the EnablePdfUa property in the request object to true. Ensure that this method is adequately tested and used where necessary.

lib/Domain/Requests/MergeOfficeRequest.cs (1)

64-67: Confirm the addition of the EnablePdfUa property.

The new property EnablePdfUa is correctly added to enable Universal Access for the resulting PDF. Ensure that this property is adequately tested and used where necessary.