refactor!: markNotificationAsRead takes notification_id + kind#37
Merged
Conversation
…d of full Notification
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The current
markNotificationAsRead({ notification, read })signature forces callers to hand in a fullNotificationobject even though every provider only consumeskindandid. Callers who only know "I want to mark PM #42 read" have to fabricate aNotificationwith boguscreator_id,published_at, etc. just to satisfy the type.Change the signature to the honest minimum:
All three providers' implementations only touch those two fields, so it's a pure simplification — no behavior change.
Test plan
pnpm test:typescleanpnpm test— 19 / 19 passpnpm format:checkcleanBreaking
Consumers using
client.markNotificationAsRead({ notification, read })need to switch to{ kind: notification.kind, notification_id: notification.id, read }. (Voyager PR follow-up.)