Add helpers for authenticated media, and associated documentation

matrix-org / matrix-js-sdk

Matrix Client-Server SDK for JavaScript

Apache License 2.0

1.49k stars 578 forks source link

Add helpers for authenticated media, and associated documentation #4185

Closed turt2live closed 2 months ago

turt2live commented 2 months ago

Checklist

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

turt2live commented 2 months ago

Ah, sorry, it's mentioned briefly in the README diff here and in the depths of https://github.com/element-hq/element-web/pull/27326#discussion_r1576303882 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 commented 2 months ago

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