Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add helpers for authenticated media, and associated documentation #4185

Merged
merged 3 commits into from
May 2, 2024

Conversation

turt2live
Copy link
Member

Checklist

  • Tests written for new code (and old code if feasible).
  • New or updated public/exported symbols have accurate TSDoc documentation.
  • Linter and other CI checks pass.
  • Sign-off given on the changes (see CONTRIBUTING.md).

@turt2live turt2live added the T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements label Apr 30, 2024
@@ -21,6 +21,10 @@ endpoints from before Matrix 1.1, for example.

# Quickstart

> [!IMPORTANT]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for the reviewer - I think this our first usage of the blockquote styles provided by github. See https://github.com/orgs/community/discussions/16925 for details.

@turt2live turt2live marked this pull request as ready for review April 30, 2024 22:51
@turt2live turt2live requested a review from a team as a code owner April 30, 2024 22:51
@turt2live turt2live requested review from dbkr and richvdh April 30, 2024 22:51
Copy link
Member

@dbkr dbkr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How will we manage the second transition from unstable to stable?

@turt2live
Copy link
Member Author

Ah, sorry, it's mentioned briefly in the README diff here and in the depths of element-hq/element-web#27326 (comment) somewhere - we'd be introducing a breaking change later (once the MSC is either stable or released) which only returns authenticated media URLs.

I'm not sure there's much of a way to avoid a breaking change here, given we'd want the js-sdk to produce authentication-required URLs by default as soon as it possibly can.

@dbkr
Copy link
Member

dbkr commented May 2, 2024

Fair enough, as long as there's a plan for managing the second transition (ie. to stable) as well.

@turt2live turt2live added this pull request to the merge queue May 2, 2024
Merged via the queue into develop with commit 402adfb May 2, 2024
25 checks passed
@turt2live turt2live deleted the travis/msc3916-helpers branch May 2, 2024 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants