Improve types around User Interactive Auth #4709
Conversation
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
| /** | ||
| * Helper type to represent HTTP response body for a UIA enabled endpoint | ||
| */ | ||
| export type UIAResponse<T> = T | IAuthData; |
There was a problem hiding this comment.
wondering if we should (temporarily) make this
/** @deprecated */
export type UIAResponse<T> = T;
... to avoid having to synchronise the EW and js-sdk PRs.
No strong feelings though.
There was a problem hiding this comment.
We shouldn't need to synchronise them, EW can land first, shouldn't need to both land at once.
There was a problem hiding this comment.
Actually no, you're right, that is a better approach and will avoid a breaking change
wrong link, I think |
| export type UIAuthCallback<T> = (makeRequest: (authData: AuthDict | null) => Promise<UIAResponse<T>>) => Promise<T>; | ||
| export type UIAuthCallback<T> = (makeRequest: (authData: AuthDict | null) => Promise<T>) => Promise<T>; |
There was a problem hiding this comment.
It would be nice, while you're here (and since it took me a while to figure out), to clarify the documentation to say that, in the case of more auth being needed, makeRequest will throw a MatrixError whose data conforms to IAuthData. But I don't mind if you want to leave that for another time.
Fixes #4702
Requires element-hq/element-web#29255