Skip to content

Conversation

@ricardogarim
Copy link
Contributor

@ricardogarim ricardogarim commented Oct 2, 2025

Summary by CodeRabbit

  • Chores
    • Expanded the federation SDK’s public export surface with additional type aliases to improve TypeScript ergonomics for integrators and plugin authors.
    • Enables easier consumption of federation-related APIs with better IDE autocomplete and static typing.
    • No changes to runtime behavior or error handling; existing functionality remains unaffected.
    • No migration required.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025

Walkthrough

The SDK’s public export surface was expanded by re-exporting additional types from upstream packages. Specifically, the entry point now re-exports Pdu, PduForType, PduType from @rocket.chat/federation-room and EventStore from @rocket.chat/federation-core. No runtime or behavioral changes.

Changes

Cohort / File(s) Summary
SDK Entry Point Exports
packages/federation-sdk/src/index.ts
Added re-exports for types: Pdu, PduForType, PduType (from @rocket.chat/federation-room) and EventStore (from @rocket.chat/federation-core). No logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

Poem

I nibble on types in the morning light,
Four fresh leaves exported just right.
Pdu hops by, EventStore too—
Paths aligned, no code askew.
In the meadow of modules we gleefully play,
Public surfaces widened—hip hop hooray! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit's high-level summary is enabled.
Title Check ✅ Passed The title clearly and concisely summarizes the primary change by stating that EventStore, PduType, and PduForType are being exported from the federation-sdk, accurately reflecting the main intent without extra detail or noise.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/export-pdu-types

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between be19457 and 38ac2e0.

📒 Files selected for processing (1)
  • packages/federation-sdk/src/index.ts (1 hunks)
🔇 Additional comments (2)
packages/federation-sdk/src/index.ts (2)

28-35: EventStore export verified
Confirmed that EventStore is defined and re-exported by @rocket.chat/federation-core.


19-27: Verify exports in external package
The @rocket.chat/federation-room dependency isn’t present locally; please confirm it exports the Pdu, PduForType, and PduType types.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@ricardogarim ricardogarim force-pushed the chore/export-pdu-types branch from be0c646 to 7d5281a Compare October 2, 2025 21:24
@codecov-commenter
Copy link

codecov-commenter commented Oct 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.84%. Comparing base (f5addb9) to head (38ac2e0).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #247      +/-   ##
==========================================
- Coverage   81.86%   81.84%   -0.02%     
==========================================
  Files          63       63              
  Lines        4709     4705       -4     
==========================================
- Hits         3855     3851       -4     
  Misses        854      854              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ricardogarim ricardogarim force-pushed the chore/export-pdu-types branch from 7d5281a to 38ac2e0 Compare October 2, 2025 21:38
@ricardogarim ricardogarim marked this pull request as ready for review October 2, 2025 21:41
@ggazzo ggazzo merged commit 7916fb2 into main Oct 3, 2025
3 checks passed
@ggazzo ggazzo deleted the chore/export-pdu-types branch October 3, 2025 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants