fix: make objeto property optional in PIXRecPayload type

[jonashger]

What kind of change does this PR introduce?

Bug fix - This is a bug fix that addresses a type definition issue.

What is the current behavior?

Before this change, the objeto property in the PIXRecPayload type was required (line 138 in the vinculo object). This means that when creating or working with PIX recurrence payloads, developers were forced to always provide the objeto field, even when it might not be necessary or available in certain scenarios.

What is the new behavior (if this is a feature change)?

The objeto property is now optional (marked with ?). This allows developers to create PIXRecPayload objects without necessarily providing the objeto field, making the type definition more flexible and aligned with real-world usage scenarios where this field might not always be required.

Summary by CodeRabbit

• Bug Fixes

  • Relaxed the requirement for the vinculo.objeto field in PIX receive payloads; it is now optional. This prevents unnecessary validation/type errors when the field is absent in real-world responses and reduces integration friction.

• Refactor

  • Updated type definitions to reflect the optional nature of vinculo.objeto in PIX dynamic payloads, improving alignment with upstream data and enhancing developer experience without impacting existing functionality.

[coderabbitai]

Walkthrough

In src/types/pixDynamicPayload.ts, the PIXRecPayload type was updated: the vinculo.objeto field changed from a required string to an optional readonly string.

Changes

Cohort / File(s)	Summary
Type definition update src/types/pixDynamicPayload.ts	Made PIXRecPayload.vinculo.objeto optional (readonly objeto?: string) instead of required (readonly objeto: string).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• fix: export pixDynamicPayload types and update PIXRecPayload structure #36 — Also modifies fields within PIXRecPayload in src/types/pixDynamicPayload.ts.
• fix: add new enums and types for Pix payload structure #34 — Refactors/renames several PIXRecPayload fields in the same file affected here.

Poem

A nibble of types in a payload so spry,
objeto now optional—less strict, oh my!
I hop through the code with a gentle cheer,
Vinculos loosen, no need to fear.
Carrot-shaped braces, compile lights green—
A tidy hop forward in the PIXy scene. 🥕✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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 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

🧹 Nitpick comments (1)

src/types/pixDynamicPayload.ts (1)

138-138: Add a short doc comment to clarify optionality.

Document when objeto is expected to be present for downstream clarity.

-    readonly objeto?: string;
+    /** Opcional: presente apenas quando aplicável ao vínculo da recorrência. */
+    readonly objeto?: string;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef792fb and bc4c18d.

📒 Files selected for processing (1)

• src/types/pixDynamicPayload.ts (1 hunks)

🔇 Additional comments (2)

src/types/pixDynamicPayload.ts (2)

135-141: vinculo.objeto Optionality Confirmed Safe

No occurrences of vinculo.objeto (direct access, destructuring, or non-null assertions) were found in the codebase. Making it optional is purely a type‐level improvement with no runtime impact. LGTM.

---

135-141: exactOptionalPropertyTypes is not enabled – default (false) applies

I’ve searched all tsconfig*.json files and did not find exactOptionalPropertyTypes set, so the compiler is using its default (false). That means objeto?: string will accept undefined when explicitly assigned. If that matches your intent, no change is needed; otherwise, you can enable it in your tsconfig.json:

{
  "compilerOptions": {
    "exactOptionalPropertyTypes": true
  }
}

[thalesog]

🎉 This issue has been resolved in version 2.8.2 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀