fix: make StatusApiResponse type a discriminate union #161
Conversation
This file contains 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
jamesdawsonWD
changed the title
|
Thanks! Looks good but I think these properties should be optional as well since they aren't enforced at the protocol level (e.g. you can have an FID w/ no displayName set) |
|
@deodad updated those optional types! |
|
I have also updated the docs and created a PR for this, if you decide to go ahead with the change. |
|
thanks @jamesdawsonWD could you also address the TS errors in auth-kit |
sds
pushed a commit
to farcasterxyz/docs
that referenced
this pull request
Jun 16, 2024
This doc update is linked to [this PR](farcasterxyz/auth-monorepo#161) <!-- start pr-codex --> --- ## PR-Codex overview This PR updates the structure of the `data` object in the `status.md` file within the auth-kit client app to have separate shapes for "pending" and "completed" states. ### Detailed summary - Separated `data` object into two shapes: "pending" and "completed" - Added `url`, `message`, `signature`, `fid` fields for "completed" state - Updated `state` field to be a string literal for both shapes > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
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.
Motivation
While working on integrating farcaster at work, I found this type to be inaccurate. This new type will allow for separate type states dependent on the status.
Change Summary
Convert StatusApiResponse type to discriminate union
Merge Checklist