Improve types around login, registration, UIA and identity servers #3537
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
t3chguy
added
the
T-Task
richvdh
requested changes
Jul 3, 2023
src/client.ts
Outdated
| @@ -7824,11 +7814,10 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa | |||
| } | |||
|
|
|||
| /** | |||
| * @returns Promise which resolves: TODO | |||
| @returns Promise which resolves to a LoginResponse object | |||
There was a problem hiding this comment.
Suggested change
| @returns Promise which resolves to a LoginResponse object | |
| * @returns Promise which resolves to a LoginResponse object |
t3chguy
added
X-Breaking-Change
T-Enhancement
…chguy/types/3jul23
richvdh
reviewed
Jul 4, 2023
Comment on lines
+92
to
+94
| * A client can identify a user using their Matrix ID. | ||
| * This can either be the fully qualified Matrix user ID, or just the localpart of the user ID. | ||
| * @see https://spec.matrix.org/v1.7/client-server-api/#matrix-user-id |
There was a problem hiding this comment.
This is certainly helpful, but for bonus points it would be nice to say where this thing is used: if I look at https://pr3537--js-sdk-docs-previews.netlify.app/stable/types/_internal_.userloginidentifier it's just somewhat lacking in context.
Anyway no need to change this now but something I think we could be better at in future.
src/client.ts
Outdated
| @@ -7824,11 +7814,10 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa | |||
| } | |||
|
|
|||
| /** | |||
| * @returns Promise which resolves: TODO | |||
| @returns Promise which resolves to a LoginResponse object | |||
richvdh
reviewed
Jul 4, 2023
…chguy/types/3jul23
Sneaking in from comments on #3540
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
su-ex
added a commit
to SchildiChat/matrix-js-sdk
that referenced
this pull request
Feb 24, 2024
* Drop support for Node 16 ([\matrix-org#3533](matrix-org#3533)). * Improve types around login, registration, UIA and identity servers ([\matrix-org#3537](matrix-org#3537)). * **The Browserify artifact is being deprecated, scheduled for removal in the October 10th release cycle. (matrix-org#3189)** * Simplify `MatrixClient::setPowerLevel` API ([\matrix-org#3570](matrix-org#3570)). Fixes element-hq/element-web#13900 and matrix-org#1844. * Deprecate `VerificationRequest.getQRCodeBytes` and replace it with the asynchronous `generateQRCode`. ([\matrix-org#3562](matrix-org#3562)). * Deprecate `VerificationRequest.beginKeyVerification()` in favour of `VerificationRequest.startVerification()`. ([\matrix-org#3528](matrix-org#3528)). * Deprecate `Crypto.VerificationRequest` application event, replacing it with `Crypto.VerificationRequestReceived`. ([\matrix-org#3514](matrix-org#3514)). * Throw saner error when peeking has its room pulled out from under it ([\matrix-org#3577](matrix-org#3577)). Fixes element-hq/element-web#18679. * OIDC: Log in ([\matrix-org#3554](matrix-org#3554)). Contributed by @kerryarchibald. * Prevent threads code from making identical simultaneous API hits ([\matrix-org#3541](matrix-org#3541)). Fixes element-hq/element-web#25395. * Update IUnsigned type to be extensible ([\matrix-org#3547](matrix-org#3547)). * add stop() api to BackupManager for clean shutdown ([\matrix-org#3553](matrix-org#3553)). * Log the message ID of any undecryptable to-device messages ([\matrix-org#3543](matrix-org#3543)). * Ignore thread relations on state events for consistency with edits ([\matrix-org#3540](matrix-org#3540)). * OIDC: validate id token ([\matrix-org#3531](matrix-org#3531)). Contributed by @kerryarchibald. * Fix read receipt sending behaviour around thread roots ([\matrix-org#3600](matrix-org#3600)). * Fix `TypedEventEmitter::removeAllListeners(void)` not working ([\matrix-org#3561](matrix-org#3561)). * Don't allow Olm unwedging rate-limiting to race ([\matrix-org#3549](matrix-org#3549)). Fixes element-hq/element-web#25716. * Fix an instance of failed to decrypt error when an in flight `/keys/query` fails. ([\matrix-org#3486](matrix-org#3486)). * Use the right anchor emoji for SAS verification ([\matrix-org#3534](matrix-org#3534)). * fix a bug which caused the wrong emoji to be shown during SAS device verification. ([\matrix-org#3523](matrix-org#3523)).
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.
Here's what your changelog entry will look like:
🚨 BREAKING CHANGES