Export thread-related types from SDK #3447

stas-demydiuk · 2023-06-06T07:04:19Z

Export types related to threads from SDK so consumers who also use typescript can easily consume them

Signed-off-by: Stanislav Demydiuk [email protected]

Checklist

Tests written for new code (and old code if feasible)
Linter and other CI checks pass
Sign-off given on the changes (see CONTRIBUTING.md)

Here's what your changelog entry will look like:

✨ Features

Export thread-related types from SDK (#3447). Contributed by @stas-demydiuk.

t3chguy

Can we avoid breaking changes, maintain backwards compatibility please

t3chguy · 2023-06-06T07:32:31Z

src/models/thread.ts

+export type ThreadEmittedEvents = Exclude<ThreadEvent, ThreadEvent.New> | RoomEvent.Timeline | RoomEvent.TimelineReset;

-export type EventHandlerMap = {
+export type ThreadEventHandlerMap = {


Changing this is a breaking change

As I see it was never exported before, so it is just an internal type rename, or am I missing something?

It was exported, you could import it as matrix-js-sdk/src/models/thread - you just changed its name, if you prefer the new name, fine, but you must maintain the old name with a deprecation notice

I see what you mean, my idea was to address the case when you use the library in a usual way i.e.

import { ThreadEvent, ThreadEventHandlerMap } from 'matrix-js-sdk'

rather than directly consuming and compiling source files. In such case exporting EmittedEvents sounds too generic as room, timeline and other models have their own EmittedEvents as well.

I updated the PR to export the original type from the source file as in your example and not from the library.

* Export thread-related types from SDK * address PR feedback

…ate (#3424) * send expected peer connections to posthog. (based on roomState event) * add tests * change GroupCallStats initialized * prettier * more test and catch for promise * seperate the participant logic in a summary extend function Signed-off-by: Timo K <[email protected]> * remove unused Signed-off-by: Timo K <[email protected]> * rename summaryStatsReportGatherer to "Reporter" for the summary stats there is only one instance because there is only one summary. Since we dont have a list of gatherers it this class only reports. Hence we rename it to be a reporter. Signed-off-by: Timo K <[email protected]> * review Signed-off-by: Timo K <[email protected]> * Update src/webrtc/stats/groupCallStats.ts Co-authored-by: Robin <[email protected]> * revert rename Signed-off-by: Timo K <[email protected]> * Update all non-major dependencies (#3433) * Update all non-major dependencies * Remove name wrap-ansi-cjs * Remove name string-width-cjs --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael Telatynski <[email protected]> * Update definitelyTyped (#3430) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael Telatynski <[email protected]> * Export FALLBACK_ICE_SERVER (#3429) * Add an integration test for verification (#3436) * Move existing crypto integ tests into a subdirectory * Factor out some common bits from `crypto.spec.ts` * Integration test for device verification * Ignore generated file in prettier * Always show a summary after Jest tests (#3440) ... because it is otherwise impossible to see what failed. * Use correct /v3 prefix for /refresh (#3016) * Add tests to ensure /v3/refresh is called + automatic /v1 retry * Request /refresh with v3 prefix, and quietly fall back to v1 * Add tests checking re-raising errors * Update spec/unit/login.spec.ts * Update comment Co-authored-by: Richard van der Hoff <[email protected]> --------- Co-authored-by: Richard van der Hoff <[email protected]> * Update Mutual Rooms (MSC2666) support (#3381) * update mutual rooms support * clarify docs and switch eslint comment with todo * please the holy linter * change query variable names around * add mock tests and fix issue * ye holy linter * GHA: build and cypress-test a copy of element-web after each push (#3412) * Build a copy of element-web after each push * Run cypress after each build of element-web * Fix downstream-artifacts build (#3443) * Fix downstream-artifacts build * Update cypress.yml * Fix edge cases around 2nd order relations and threads (#3437) * Fix tests oversimplifying threads fixtures * Check for unsigned thread_id in MatrixEvent::threadRootId * Fix threads order being racy * Make Sonar happier * Iterate * Make sliding sync linearize processing of sync requests (#3442) * Make sliding sync linearize processing of sync requests * Iterate * Iterate * Iterate * Iterate * Disable downstream artifacts build for develop branch (#3444) * Export thread-related types from SDK (#3447) * Export thread-related types from SDK * address PR feedback * Integration test for QR code verification (#3439) * Integration test for QR code verification Followup to #3436: another integration test, this time using the QR code flow * Use Object.defineProperty, and restore afterwards Apparently global.crypto exists in some environments * apply ts-ignore * remove stray comment * Update spec/integ/crypto/verification.spec.ts * Add `getShowSasCallbacks`, `getShowQrCodeCallbacks` to VerifierBase (#3422) * Add `getShowSasCallbacks`, `getShowQrCodeCallbacks` to VerifierBase ... to avoid some type-casting * Integration test for QR code verification Followup to #3436: another integration test, this time using the QR code flow * Rename method ... it turns out not to be used quite as I thought. * tests for new methods * Use Object.defineProperty, and restore afterwards Apparently global.crypto exists in some environments * apply ts-ignore * More test coverage * fix bad merge * Fix changelog_head.py script to be Python 3 compatible * Prepare changelog for v25.2.0-rc.1 * v25.2.0-rc.1 * Fix tsconfig-build.json * Prepare changelog for v25.2.0-rc.2 * v25.2.0-rc.2 * Fix docs deployment * Prepare changelog for v25.2.0-rc.3 * v25.2.0-rc.3 * Prepare changelog for v25.2.0-rc.4 * v25.2.0-rc.4 * [Backport staging] Attempt a potential workaround for stuck notifs (#3387) Co-authored-by: Andy Balaam <[email protected]> * Prepare changelog for v25.2.0-rc.5 * v25.2.0-rc.5 * [Backport staging] Fix mark as unread button (#3401) Co-authored-by: Michael Weimann <[email protected]> * Prepare changelog for v26.0.0-rc.1 * v26.0.0-rc.1 * Prepare changelog for v26.0.0 * v26.0.0 * Resetting package fields for development * use cli.canSupport to determine intentional mentions support (#3445) * use cli.canSupport to determine intentional mentions support * more specific comment * Update src/client.ts Co-authored-by: Michael Telatynski <[email protected]> --------- Co-authored-by: Michael Telatynski <[email protected]> * git fixup Signed-off-by: Timo K <[email protected]> * import updates Signed-off-by: Timo K <[email protected]> * dont revert enricos change Signed-off-by: Timo K <[email protected]> * temp rename for lowercase * lowercase --------- Signed-off-by: Timo K <[email protected]> Co-authored-by: Robin <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael Telatynski <[email protected]> Co-authored-by: Richard van der Hoff <[email protected]> Co-authored-by: David Lee <[email protected]> Co-authored-by: Jonathan de Jong <[email protected]> Co-authored-by: Stanislav Demydiuk <[email protected]> Co-authored-by: ElementRobot <[email protected]> Co-authored-by: Andy Balaam <[email protected]> Co-authored-by: Michael Weimann <[email protected]> Co-authored-by: Kerry <[email protected]>

@florianduros

* Introduce a new `Crypto.Verifier` interface, and deprecate direct access to `VerificationBase`, `SAS` and `ReciprocateQRCode` ([\matrix-org#3414](matrix-org#3414)). * Add `rust-crypto#isCrossSigningReady` implementation ([\matrix-org#3462](matrix-org#3462)). Contributed by @florianduros. * OIDC: Validate `m.authentication` configuration ([\matrix-org#3419](matrix-org#3419)). Contributed by @kerryarchibald. * ElementR: Add `CryptoApi.getCrossSigningStatus` ([\matrix-org#3452](matrix-org#3452)). Contributed by @florianduros. * Extend stats summary with call device and user count based on room state ([\matrix-org#3424](matrix-org#3424)). Contributed by @toger5. * Update MSC3912 implementation to use `with_rel_type` instead of `with_relations` ([\matrix-org#3420](matrix-org#3420)). * Export thread-related types from SDK ([\matrix-org#3447](matrix-org#3447)). Contributed by @stas-demydiuk. * Use correct /v3 prefix for /refresh ([\matrix-org#3016](matrix-org#3016)). Contributed by @davidisaaclee. * Fix thread list being ordered based on all updates ([\matrix-org#3458](matrix-org#3458)). Fixes element-hq/element-web#25522. * Fix: handle `baseUrl` with trailing slash in `fetch.getUrl` ([\matrix-org#3455](matrix-org#3455)). Fixes element-hq/element-web#25526. Contributed by @kerryarchibald. * use cli.canSupport to determine intentional mentions support ([\matrix-org#3445](matrix-org#3445)). Fixes element-hq/element-web#25497. Contributed by @kerryarchibald. * Make sliding sync linearize processing of sync requests ([\matrix-org#3442](matrix-org#3442)). * Fix edge cases around 2nd order relations and threads ([\matrix-org#3437](matrix-org#3437)).

Export thread-related types from SDK

be23500

stas-demydiuk requested a review from a team as a code owner June 6, 2023 07:04

stas-demydiuk requested review from kerryarchibald and richvdh June 6, 2023 07:04

github-actions bot added the Z-Community-PR Issue is solved by a community member's PR label Jun 6, 2023

github-actions bot deployed to PR Documentation Preview June 6, 2023 07:06 View deployment

germain-gg approved these changes Jun 6, 2023

View reviewed changes

germain-gg added the T-Enhancement label Jun 6, 2023

germain-gg enabled auto-merge June 6, 2023 07:31

germain-gg added this pull request to the merge queue Jun 6, 2023

t3chguy requested changes Jun 6, 2023

View reviewed changes

t3chguy added the X-Breaking-Change label Jun 6, 2023

t3chguy removed this pull request from the merge queue due to a manual request Jun 6, 2023

stas-demydiuk requested a review from t3chguy June 6, 2023 07:38

address PR feedback

a50b0bc

t3chguy approved these changes Jun 6, 2023

View reviewed changes

t3chguy enabled auto-merge June 6, 2023 07:53

github-actions bot deployed to PR Documentation Preview June 6, 2023 07:55 View deployment

t3chguy added this pull request to the merge queue Jun 6, 2023

richvdh removed their request for review June 6, 2023 08:08

Merged via the queue into matrix-org:develop with commit ecd700a Jun 6, 2023

t3chguy removed the X-Breaking-Change label Jun 6, 2023

toger5 pushed a commit that referenced this pull request Jun 7, 2023

Export thread-related types from SDK (#3447)

e1ce16a

* Export thread-related types from SDK * address PR feedback

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Export thread-related types from SDK #3447

Export thread-related types from SDK #3447

Uh oh!

stas-demydiuk commented Jun 6, 2023 •

edited by github-actions bot

Loading

Uh oh!

t3chguy left a comment

Uh oh!

t3chguy Jun 6, 2023

Uh oh!

stas-demydiuk Jun 6, 2023

Uh oh!

t3chguy Jun 6, 2023

Uh oh!

stas-demydiuk Jun 6, 2023

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Export thread-related types from SDK #3447

Export thread-related types from SDK #3447

Uh oh!

Conversation

stas-demydiuk commented Jun 6, 2023 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

✨ Features

Uh oh!

t3chguy left a comment

Choose a reason for hiding this comment

Uh oh!

t3chguy Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

stas-demydiuk Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

t3chguy Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

stas-demydiuk Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stas-demydiuk commented Jun 6, 2023 •

edited by github-actions bot

Loading