feat: openExternalLink returns a { opened: boolean } result
#282
Conversation
HamzaAtDiscord
force-pushed
the
hamzahutchinson/change-open-external-link-response
branch
from
b030381 to
2faa932
Compare
src/schema/responses.ts
Outdated
| export const OpenExternalLinkResponse = zod.object({ | ||
| opened: zod.boolean(), | ||
| }); | ||
|
|
There was a problem hiding this comment.
general question: how does this behave against a version of the client that doesn't send the opened flag across RPC? my gut is that since this isn't marked as optional and we're using .parse() it would error out, but I also don't know if we have error handling for that buried elsewhere (I'm assuming we do since otherwise I imagine this would have been a problem already).
There was a problem hiding this comment.
would defaulting this to false be appropriate?
There was a problem hiding this comment.
Good call. I've updated this to use fallbackToDefault and return { opened: null } in the case where parsing fails (ie: discord clients that don't support this response). I've also updated the documentation with the null case and a note on when it occurs.
package.json
Outdated
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@discord/embedded-app-sdk", | |||
| "version": "1.7.0", | |||
| "version": "1.7.1", | |||
There was a problem hiding this comment.
nit - we don't bump the package version in the PR, it happens automatically via the release please github action.
nit - I think this is a feature, not a patch
There was a problem hiding this comment.
Ah, I didn't realize! I have reverted to 1.7.0
src/schema/responses.ts
Outdated
| export const OpenExternalLinkResponse = zod.object({ | ||
| opened: zod.boolean(), | ||
| }); | ||
|
|
HamzaAtDiscord
force-pushed
the
hamzahutchinson/change-open-external-link-response
branch
from
24b227d to
13e5550
Compare
matthova
changed the title
openExternalLink returns a { opened: boolean } result{ opened: boolean } result
HamzaAtDiscord
deleted the
hamzahutchinson/change-open-external-link-response
branch
Edit the return type for
openExternalLink. With this change the result ofopenExternalLinkwill be an object containing a boolean valueopened.If
openedis true, then the link was opened by the userIf
openedis false, then the link was not opened by the userThe lifetime of the promise is also changed. Previously the promise completed after opening the "Leaving Discord" dialog, but with this change the promise completes after the user selects an action in the dialog (visit the site, or go back). If the dialog does not appear because the site visit is automatically approved, then the promise returns
{ opened: true }following the link opening.