Export types describing all specced media event formats #4092

t3chguy · 2024-03-05T14:29:19Z

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

richvdh

Generally I'm worried that this is rather a lot of new types in the top level of the js-sdk namespace, which is already somewhat unnavigable. Can we not find some better way of organising this stuff?

src/matrix.ts

src/models/media.ts

t3chguy · 2024-03-06T14:42:07Z

Generally I'm worried that this is rather a lot of new types in the top level of the js-sdk namespace, which is already somewhat unnavigable. Can we not find some better way of organising this stuff?

given how limited named imports are and that we desire to only have one main entrypoint in the js-sdk I'm not sure how you suggest solving this

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

richvdh · 2024-03-06T16:21:28Z

we desire to only have one main entrypoint in the js-sdk

I don't think we desire that. I think we desire not to have every single file in the js-sdk being a thing that applications should import, but having a limited number of well-defined things that applications can import seems sensible to me. For example, crypto-api is deliberately designed to be a public interface, and the crypto interfaces are available through that.

The difficulty is not solving it per se. The difficulty is coming up with a sensible structure that makes sense now, particularly given the absolute tyrefire of the current interface.

Still, I think this PR is a worrying step taking us even further in the wrong direction. Maybe we can discuss further at tomorrow's meeting.

t3chguy · 2024-03-06T16:30:10Z

We can't feasibly add any more entrypoints to the js-sdk as the linters in the upper layers are already maxed out on allowlist/exceptions from the work to move everything to single entrypoint. Given that work exists, it seems to go the complete opposite way of what you are suggesting here.

richvdh · 2024-03-06T18:50:49Z

We can't feasibly add any more entrypoints to the js-sdk as the linters in the upper layers are already maxed out on allowlist/exceptions from the work to move everything to single entrypoint

This list ? There's a lot of stuff there that needs to go away. If you need to get rid of one to make room for another, matrix-js-sdk/src/common-crypto should definitely never have been there and looks like it can be safely removed.

t3chguy · 2024-03-06T19:16:49Z

If you need to get rid of one to make room for another, matrix-js-sdk/src/common-crypto should definitely never have been there and looks like it can be safely removed.

In that case can you please fix the places in which you imported it so the lint exception can be removed?

richvdh · 2024-03-06T20:08:52Z

If you need to get rid of one to make room for another, matrix-js-sdk/src/common-crypto should definitely never have been there and looks like it can be safely removed.

In that case can you please fix the places in which you imported it so the lint exception can be removed?

Looks like I forgot to grep the test code. matrix-org/matrix-react-sdk#12321.

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

richvdh

This stuff doesn't appear to be making it into the documentation, which is problematic. I think maybe we need to add types.ts as an entrypoint in typedoc.json ?

Could we also add a few words to the README about the new entrypoint, and how you're meant to use it from a project that isn't the react-sdk with its weird build process?

src/@types/media.ts

src/types.ts

t3chguy · 2024-03-08T12:26:14Z

Could we also add a few words to the README about the new entrypoint, and how you're meant to use it from a project that isn't the react-sdk with its weird build process?

Where is the similar bit re crypto-api so I can remain consistent?

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

richvdh · 2024-03-08T13:17:55Z

Where is the similar bit re crypto-api so I can remain consistent?

Nobody has had time to write it yet. It should definitely be done, and should probably have been done when we first added crypto-api, but we were still experimenting with this stuff at the time. Its absence is not a good reason to propagate the error.

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

richvdh

You've got a conflict, but lgtm otherwise

…chguy/media-event-type Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* v31.5.0-rc.0 * Don't re-fetch thread root if we already have it (matrix-org#4088) The root event of a thread used to arrive with the pagination request, but this was unspecced and so got changed to simply fetch the root event. In many (almost all) cases this shouldn't be necessary because the thread should already have its root event: re-use it if it's already there. This is only in pagination, so there's no reason to believe that the root event would have changed and needs to be re-fetched. This removes a number of duplicate calls to the /event/ endpoint from the tests. * Fix race condition with sliding sync extensions (matrix-org#4089) * Fix race condition with sliding sync extensions * Fix types on sliding-sync spec test * Prettier fixes * Add `.m.rule.is_room_mention` push rule to DEFAULT_OVERRIDE_RULES (matrix-org#4100) * Add intentional mentions push rules to DEFAULT_OVERRIDE_RULES Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Export types describing all specced media event formats (matrix-org#4092) * Export types describing all specced media event formats Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate PR Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Move types to a dedicated export Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add readme entry Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Update dependency typedoc to v0.25.11 (matrix-org#4102) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * v31.5.0 * Resetting package fields for development * Temporarily disable broken step in the release process Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * fix automatic DM avatar with functional members (matrix-org#4017) * fix automatic DM avatar with functional members * update comments * lint * add tests for functional members * keep functional members out of the public API - remove public API for functional members, reverting most of 0ce2d82, f9b41f6, e65fb24 - remove tests for functional members public API c114bf5 - add shared functional members getter for both room name and avatar fallback generation * filter functional members from more candidates - remove from hero(es) - remove from previous members * add tests for fallback avatars with functional members * Add docstring for getFunctionalMembers Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * inline getInvitedAndJoinedFunctionalMemberCount * update comments for getAvatarFallbackMember * use correct list of heroes in getAvatarFallbackMember * remove redundant type annotation * optimize performance of invitedAndJoinedFunctionalMemberCount * calculate nonFunctionalMemberCount in one step instead of iterating redundantly * clean up functional member tests with review feedback * lint * Update src/models/room.ts Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * apply feedback about comments * non-functional per review, lint --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: RiotRobot <releases@riot.im> Co-authored-by: David Baker <dbkr@users.noreply.github.com> Co-authored-by: Daniel Salinas <zzorba@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Export types describing all specced media event formats

66f590e

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

t3chguy added the T-Enhancement label Mar 5, 2024

t3chguy requested a review from a team as a code owner March 5, 2024 14:29

t3chguy requested review from richvdh and florianduros March 5, 2024 14:29

t3chguy mentioned this pull request Mar 5, 2024

Reuse media content/info types from the js-sdk matrix-org/matrix-react-sdk#12308

Merged

github-actions bot deployed to PR Documentation Preview March 5, 2024 14:30 View deployment

richvdh requested changes Mar 6, 2024

View reviewed changes

src/matrix.ts Outdated Show resolved Hide resolved

src/models/media.ts Outdated Show resolved Hide resolved

src/models/media.ts Outdated Show resolved Hide resolved

src/models/media.ts Outdated Show resolved Hide resolved

src/models/media.ts Outdated Show resolved Hide resolved

Iterate PR

9a19f5f

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

t3chguy requested a review from richvdh March 6, 2024 14:47

github-actions bot deployed to PR Documentation Preview March 6, 2024 14:48 View deployment

richvdh removed their request for review March 6, 2024 22:59

Move types to a dedicated export

23c75ae

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

t3chguy requested a review from richvdh March 7, 2024 11:08

github-actions bot deployed to PR Documentation Preview March 7, 2024 11:09 View deployment

richvdh requested changes Mar 8, 2024

View reviewed changes

src/@types/media.ts Show resolved Hide resolved

src/types.ts Outdated Show resolved Hide resolved

Iterate

d7c2f19

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

Add readme entry

da325d6

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

t3chguy requested a review from richvdh March 8, 2024 13:34

richvdh approved these changes Mar 8, 2024

View reviewed changes

Merge branch 'develop' of github.com:matrix-org/matrix-js-sdk into t3…

231ee55

…chguy/media-event-type Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

github-actions bot deployed to PR Documentation Preview March 8, 2024 20:58 View deployment

t3chguy added this pull request to the merge queue Mar 8, 2024

Merged via the queue into develop with commit 3711ad7 Mar 8, 2024
23 checks passed

t3chguy deleted the t3chguy/media-event-type branch March 8, 2024 21:29

richvdh mentioned this pull request Mar 14, 2024

Introduce Membership TS type (take 2) #4107

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Export types describing all specced media event formats #4092

Export types describing all specced media event formats #4092

t3chguy commented Mar 5, 2024

richvdh left a comment

t3chguy commented Mar 6, 2024

richvdh commented Mar 6, 2024

t3chguy commented Mar 6, 2024

richvdh commented Mar 6, 2024 •

edited

Loading

t3chguy commented Mar 6, 2024 •

edited

Loading

richvdh commented Mar 6, 2024

richvdh left a comment

t3chguy commented Mar 8, 2024

richvdh commented Mar 8, 2024

richvdh left a comment

Export types describing all specced media event formats #4092

Export types describing all specced media event formats #4092

Conversation

t3chguy commented Mar 5, 2024

richvdh left a comment

Choose a reason for hiding this comment

t3chguy commented Mar 6, 2024

richvdh commented Mar 6, 2024

t3chguy commented Mar 6, 2024

richvdh commented Mar 6, 2024 • edited Loading

t3chguy commented Mar 6, 2024 • edited Loading

richvdh commented Mar 6, 2024

richvdh left a comment

Choose a reason for hiding this comment

t3chguy commented Mar 8, 2024

richvdh commented Mar 8, 2024

richvdh left a comment

Choose a reason for hiding this comment

richvdh commented Mar 6, 2024 •

edited

Loading

t3chguy commented Mar 6, 2024 •

edited

Loading