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

Move crypto classes into a separate namespace #3385

Merged
merged 3 commits into from
May 19, 2023
Merged

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented May 19, 2023

This is mostly to tidy up the typedoc, and to make sure that all the classes in crypto-api are included. It doesn't have much effect on users of the library (at least, not things like react-sdk that import individual files rather than the whole of matrixcs.)


Here's what your changelog entry will look like:

🦖 Deprecations

  • Move crypto classes into a separate namespace (#3385).

@richvdh richvdh requested a review from a team as a code owner May 19, 2023 10:10
@richvdh richvdh requested review from andybalaam and justjanne May 19, 2023 10:10
@richvdh richvdh added the T-Task Tasks for the team like planning label May 19, 2023
@t3chguy
Copy link
Member

t3chguy commented May 19, 2023

Isn't this a breaking change by removing/moving exports?

@richvdh
Copy link
Member Author

richvdh commented May 19, 2023

Isn't this a breaking change by removing/moving exports?

Only DeviceVerificationStatus and CryptoApi. Both were added very recently, and neither are used (via matrixcs) in react-sdk.

@t3chguy
Copy link
Member

t3chguy commented May 19, 2023

Both were added very recently

How recently? If we backport this change can we prevent a release containing those exports then losing them?

@richvdh
Copy link
Member Author

richvdh commented May 19, 2023

How recently? If we backport this change can we prevent a release containing those exports then losing them?

Not that recently, I'm afraid.

@t3chguy
Copy link
Member

t3chguy commented May 19, 2023

Can we add a deprecated re-export that we omit from typedoc?

@richvdh
Copy link
Member Author

richvdh commented May 19, 2023

(#3211 and #3287)

@richvdh
Copy link
Member Author

richvdh commented May 19, 2023

Turns out these are used in the react-sdk tests at least, so that rather makes a hole in my argument that re-exports are unnecessary.

src/matrix.ts Outdated Show resolved Hide resolved
Copy link
Member

@t3chguy t3chguy left a comment

Choose a reason for hiding this comment

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

:shipit:

@t3chguy t3chguy added T-Deprecation A pull request that makes something deprecated and removed T-Task Tasks for the team like planning labels May 19, 2023
@richvdh richvdh added this pull request to the merge queue May 19, 2023
Merged via the queue into develop with commit 3f48a95 May 19, 2023
@richvdh richvdh deleted the rav/crypto_namespace branch May 19, 2023 12:55
su-ex added a commit to SchildiChat/matrix-js-sdk that referenced this pull request Dec 13, 2023
* Ensure we do not add relations to the wrong timeline ([\matrix-org#3427](matrix-org#3427)). Fixes element-hq/element-web#25450 and element-hq/element-web#25494.
* Deprecate `QrCodeEvent`, `SasEvent` and `VerificationEvent` ([\matrix-org#3386](matrix-org#3386)).
* Move crypto classes into a separate namespace ([\matrix-org#3385](matrix-org#3385)).
* Mention deno support in the README ([\matrix-org#3417](matrix-org#3417)). Contributed by @sigmaSd.
* Mark room version 10 as safe ([\matrix-org#3425](matrix-org#3425)).
* Prioritise entirely supported flows for UIA ([\matrix-org#3402](matrix-org#3402)).
* Add methods to terminate idb worker ([\matrix-org#3362](matrix-org#3362)).
* Total summary count ([\matrix-org#3351](matrix-org#3351)). Contributed by @toger5.
* Audio concealment ([\matrix-org#3349](matrix-org#3349)). Contributed by @toger5.
* Correctly accumulate sync summaries. ([\matrix-org#3366](matrix-org#3366)). Fixes element-hq/element-web#23345.
* Keep measuring a call feed's volume after a stream replacement ([\matrix-org#3361](matrix-org#3361)). Fixes element-hq/element-call#1051.
* Element-R: Avoid uploading a new fallback key at every `/sync` ([\matrix-org#3338](matrix-org#3338)). Fixes element-hq/element-web#25215.
* Accumulate receipts for the main thread and unthreaded separately ([\matrix-org#3339](matrix-org#3339)). Fixes element-hq/element-web#24629.
* Remove spec non-compliant extended glob format ([\matrix-org#3423](matrix-org#3423)). Fixes element-hq/element-web#25474.
* Fix bug where original event was inserted into timeline instead of the edit event ([\matrix-org#3398](matrix-org#3398)). Contributed by @andybalaam.
* Only add a local receipt if it's after an existing receipt ([\matrix-org#3399](matrix-org#3399)). Contributed by @andybalaam.
* Attempt a potential workaround for stuck notifs ([\matrix-org#3384](matrix-org#3384)). Fixes element-hq/element-web#25406. Contributed by @andybalaam.
* Fix verification bug with `pendingEventOrdering: "chronological"` ([\matrix-org#3382](matrix-org#3382)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Deprecation A pull request that makes something deprecated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants