-
Notifications
You must be signed in to change notification settings - Fork 71
fix(message): remove standalone MessagePromotion export #3180
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🦋 Changeset detectedLatest commit: b49050c The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR removes the standalone MessagePromotion
component export from @lg-chat/message
while preserving the MessagePromotionProps
type export. This change enforces the compound component pattern where MessagePromotion
should only be accessed as Message.Promotion
rather than as a standalone import.
Key changes:
- Removes
MessagePromotion
component from standalone exports - Retains
MessagePromotionProps
type export for TypeScript usage - Adds changeset documentation for the breaking change
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
File | Description |
---|---|
chat/message/src/index.ts | Updates exports to remove standalone MessagePromotion component while keeping type export |
.changeset/rude-rockets-crash.md | Documents the breaking change for release notes |
Size Change: -9 B (0%) Total Size: 1.6 MB
ℹ️ View Unchanged
|
@@ -0,0 +1,5 @@ | |||
--- | |||
'@lg-chat/message': patch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this only a patch?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shaneeza it was inadvertently exported in the previous release. I was treating this as a fix and going to deprecate the version that initially exported it since it doesn't yet have usage. Do you think that would be fine or does this need to be a major version?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Honestly, I'm not sure. I would bring it up with the team.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Synced offline and we deemed patch was okay in this case despite this technically being a major
✍️ Proposed changes
Removes the standalone
MessagePromotion
export from@lg-chat/message
while keeping theMessagePromotionProps
type export. This change aligns with the compound component pattern introduced in v8.2.0, whereMessagePromotion
should only be accessed asMessage.Promotion
, not as a standalone export.The component remains fully functional as
Message.Promotion
, and TypeScript users can still import theMessagePromotionProps
type for type checking.🎟️ Jira ticket: No JIRA ticket found in changeset files
✅ Checklist
pnpm changeset
and documented my changes🧪 How to test changes
Message.Promotion
continues to work as expected when used as a compound componentMessagePromotionProps
can still be imported for TypeScript type checkingMessagePromotion
as a standalone component results in an error (expected behavior)Message.Promotion
functionality is unchanged