Skip to content

Latest commit

 

History

History
4528 lines (3892 loc) · 255 KB

CHANGELOG.md

File metadata and controls

4528 lines (3892 loc) · 255 KB

Changes in 15.6.0 (2022-02-28)

✨ Features

  • Return send event response from MSC3089Branch.createNewVersion() (#2186).
  • Add functions to support refresh tokens (#2178).

🐛 Bug Fixes

  • [Release] Fix bug with the /hierarchy API sending invalid requests (#2202).
  • Fix bug where calls could break if rejected from somewhere else (#2189).
  • Fix camera stuck on after call transfer (#2188).
  • Fix synthetic read receipt handling (#2174). Fixes element-hq/element-web#21016.
  • Revert "Sign backup with cross-signing key when we reset it." (#2175).
  • Sign backup with cross-signing key when we reset it. (#2170).
  • Fix error in uploadContent() when file is empty under Node.js (#2155).
  • Check the backup info against the stored private key when determining trust. (#2167).
  • Back up keys before logging out (#2158). Fixes element-hq/element-web#13151.

Changes in 15.6.0-rc.1 (2022-02-22)

✨ Features

  • Return send event response from MSC3089Branch.createNewVersion() (#2186).
  • Add functions to support refresh tokens (#2178).

🐛 Bug Fixes

  • Fix bug where calls could break if rejected from somewhere else (#2189).
  • Fix camera stuck on after call transfer (#2188).
  • Fix synthetic read receipt handling (#2174). Fixes element-hq/element-web#21016.
  • Revert "Sign backup with cross-signing key when we reset it." (#2175).
  • Sign backup with cross-signing key when we reset it. (#2170).
  • Fix error in uploadContent() when file is empty under Node.js (#2155).
  • Check the backup info against the stored private key when determining trust. (#2167).
  • Back up keys before logging out (#2158). Fixes element-hq/element-web#13151.

Changes in 15.5.2 (2022-02-17)

🐛 Bug Fixes

  • Fix synthetic read receipt handling

Changes in 15.5.1 (2022-02-14)

🐛 Bug Fixes

Changes in 15.5.1-rc.1 (2022-02-08)

🐛 Bug Fixes

Changes in 15.5.0 (2022-01-31)

✨ Features

  • Support m.asset in m.location event content (#2109).
  • Send extensible events structure and support on-demand parsing (#2091).
  • Support cancelling events whilst they are in status = ENCRYPTING (#2095).

🐛 Bug Fixes

Changes in 15.5.0-rc.1 (2022-01-26)

✨ Features

  • Support m.asset in m.location event content (#2109).
  • Send extensible events structure and support on-demand parsing (#2091).
  • Support cancelling events whilst they are in status = ENCRYPTING (#2095).

🐛 Bug Fixes

Changes in 15.4.0 (2022-01-17)

✨ Features

  • Don't consider alt_aliases when calculating room name (#2094). Fixes element-hq/element-web#13887.
  • Load room history if necessary when searching for MSC3089 getFileEvent() (#2066).
  • Add support for MSC3030 /timestamp_to_event (#2072).

🐛 Bug Fixes

  • Stop encrypting redactions as it isn't spec compliant (#2098). Fixes element-hq/element-web#20460.
  • Fix more function typings relating to key backup (#2086).
  • Fix timeline search in MSC3089 getFileEvent() (#2085).
  • Set a deviceId for VoIP example and use const/let (#2090). Fixes #2083. Contributed by @SimonBrandner.
  • Fix incorrect TS return type for secret storage and key backup functions (#2082).

Changes in 15.4.0-rc.1 (2022-01-11)

✨ Features

  • Don't consider alt_aliases when calculating room name (#2094). Fixes element-hq/element-web#13887.
  • Load room history if necessary when searching for MSC3089 getFileEvent() (#2066).
  • Add support for MSC3030 /timestamp_to_event (#2072).

🐛 Bug Fixes

  • Stop encrypting redactions as it isn't spec compliant (#2098). Fixes element-hq/element-web#20460.
  • Fix more function typings relating to key backup (#2086).
  • Fix timeline search in MSC3089 getFileEvent() (#2085).
  • Set a deviceId for VoIP example and use const/let (#2090). Fixes #2083. Contributed by @SimonBrandner.
  • Fix incorrect TS return type for secret storage and key backup functions (#2082).

Changes in 15.3.0 (2021-12-20)

✨ Features

  • Improve fallback key behaviour (#2037).
  • Add new room event filter fields (#2051).
  • Add method to fetch /account/whoami (#2046).

🐛 Bug Fixes

Changes in 15.3.0-rc.1 (2021-12-14)

✨ Features

  • Improve fallback key behaviour (#2037).
  • Add new room event filter fields (#2051).
  • Add method to fetch /account/whoami (#2046).

🐛 Bug Fixes

Changes in 15.2.1 (2021-12-13)

Changes in 15.2.0 (2021-12-06)

✨ Features

  • Remove support for ArrayBuffer in unstable MSC3089 createFile() and createNewVersion() and instead use same content types as handled by MatrixClient.uploadContent(). This enables support for Node.js. (#2014).
  • Support for password-based backup on Node.js (#2021).
  • Add optional force parameter when ensuring Olm sessions (#2027).

🐛 Bug Fixes

  • Fix call upgrades (#2024). Contributed by @SimonBrandner.

Changes in 15.2.0-rc.1 (2021-11-30)

✨ Features

  • Remove support for ArrayBuffer in unstable MSC3089 createFile() and createNewVersion() and instead use same content types as handled by MatrixClient.uploadContent(). This enables support for Node.js. (#2014).
  • Support for password-based backup on Node.js (#2021).
  • Add optional force parameter when ensuring Olm sessions (#2027).

🐛 Bug Fixes

  • Fix call upgrades (#2024). Contributed by @SimonBrandner.

Changes in 15.1.1 (2021-11-22)

🐛 Bug Fixes

Changes in 15.1.1-rc.1 (2021-11-17)

🐛 Bug Fixes

Changes in 15.1.0 (2021-11-08)

🦖 Deprecations

  • Mark old verification methods as deprecated (#1994).

✨ Features

  • Try to set a sender on search result events if possible (#2004).
  • Port some changes from group calls branch to develop (#2001). Contributed by @SimonBrandner.
  • Fetch room membership from server rather than relying on stored data (#1998).
  • Add method to fetch the MSC3266 Room Summary of a Room (#1988).

🐛 Bug Fixes

Changes in 15.1.0-rc.1 (2021-11-02)

🦖 Deprecations

  • Mark old verification methods as deprecated (#1994).

✨ Features

  • Try to set a sender on search result events if possible (#2004).
  • Port some changes from group calls branch to develop (#2001). Contributed by @SimonBrandner.
  • Fetch room membership from server rather than relying on stored data (#1998).
  • Add method to fetch the MSC3266 Room Summary of a Room (#1988).

🐛 Bug Fixes

Changes in 15.0.0 (2021-10-25)

🚨 BREAKING CHANGES

  • Use ICallFeedOpts in the CallFeed constructor. To construct a new CallFeed object you have to pass ICallFeedOpts e.g. `const callFeed = new CallFeed({client (#1964). Contributed by SimonBrandner.

✨ Features

🐛 Bug Fixes

  • Fix requestVerificationDM with chronological pendingEventOrdering (#1943). Contributed by freaktechnik.

Changes in 15.0.0-rc.1 (2021-10-19)

🚨 BREAKING CHANGES

  • Use ICallFeedOpts in the CallFeed constructor. To construct a new CallFeed object you have to pass ICallFeedOpts e.g. `const callFeed = new CallFeed({client (#1964). Contributed by SimonBrandner.

✨ Features

🐛 Bug Fixes

  • Fix requestVerificationDM with chronological pendingEventOrdering (#1943). Contributed by freaktechnik.

Changes in 14.0.1 (2021-10-12)

🚨 BREAKING CHANGES

  • Support for call upgrades. setLocalVideoMuted() and setMicrophoneMuted() are now async and return the new mute state (#1827). Contributed by SimonBrandner.

✨ Features

🐛 Bug Fixes

Changes in 14.0.0-rc.1 (2021-10-04)

🚨 BREAKING CHANGES

  • Support for call upgrades. setLocalVideoMuted() and setMicrophoneMuted() are now async and return the new mute state (#1827). Contributed by SimonBrandner.

✨ Features

🐛 Bug Fixes

Changes in 13.0.0 (2021-09-27)

✨ Features

🐛 Bug Fixes

Changes in 13.0.0-rc.1 (2021-09-21)

✨ Features

🐛 Bug Fixes

Changes in 12.5.0 (2021-09-14)

✨ Features

  • [Release] Exclude opt-in Element performance metrics from encryption (#1901).
  • Give MatrixCall the capability to emit LengthChanged events (#1873). Contributed by SimonBrandner.
  • Improve browser example (#1875). Contributed by psrpinto.
  • Give CallFeed the capability to emit on volume changes (#1865). Contributed by SimonBrandner.

🐛 Bug Fixes

  • Fix verification request cancellation (#1871).

Changes in 12.4.1 (2021-09-13)

🔒 SECURITY FIXES

Changes in 12.4.0 (2021-08-31)

🦖 Deprecations

  • Deprecate groups APIs. Groups are no longer supported, only Synapse has support. They are being replaced by Spaces which build off of Rooms and are far more flexible. (#1792).

✨ Features

  • Add method for including extra fields when uploading to a tree space (#1850).

🐛 Bug Fixes

Changes in 12.3.1 (2021-08-17)

🐛 Bug Fixes

  • Fix multiple VoIP regressions (#1860).

Changes in 12.3.0 (2021-08-16)

✨ Features

🐛 Bug Fixes

Changes in 12.2.0 (2021-08-02)

✨ Features

  • Improve calculateRoomName performances by using Intl.Collator #1801
  • Switch callEventHandler from listening on event to Room.timeline #1789
  • Expose MatrixEvent's internal clearEvent as a function #1784

🐛 Bug Fixes

  • Clean up Event.clearEvent handling to fix a bug where malformed events with falsey content wouldn't be considered decrypted #1807
  • Standardise spelling and casing of homeserver, identity server, and integration manager #1782

Changes in 12.1.0 (2021-07-19)

Full Changelog

  • No changes from rc.1

Changes in 12.1.0-rc.1 (2021-07-14)

Full Changelog

  • Add VS Code to gitignore #1783
  • Make Crypto::inRoomVerificationRequests public #1781
  • Call setEventMetadata() for filtered timelineSets #1765
  • Symmetric backup #1775
  • Attempt to fix megolm key not being in SSSS #1776
  • Convert SecretStorage to TypeScript #1774
  • Strip hash from urls being previewed to de-duplicate #1721
  • Do not generate a lockfile when running in CI #1773
  • Tidy up secret requesting code #1766
  • Convert Sync and SyncAccumulator to Typescript #1763
  • Convert EventTimeline, EventTimelineSet and TimelineWindow to TS #1762
  • Comply with new member-delimiter-style rule #1764
  • Do not honor string power levels #1754
  • Typescriptify some crypto stuffs #1508
  • Make filterId read/write and optional #1760

Changes in 12.0.1 (2021-07-05)

Full Changelog

  • No changes from rc.1

Changes in 12.0.1-rc.1 (2021-06-29)

Full Changelog

  • Fix broken /messages filtering due to internal field changes in FilterComponent #1759
  • Convert crypto index to TS #1749
  • Fix typescript return types for membership update events #1739
  • Fix types of MatrixEvent sender & target #1753
  • Add keysharing on invites to File Tree Spaces #1744
  • Convert Room and RoomState to Typescript #1746
  • Improve type of IContent msgtype #1752
  • Add PR template #1747
  • Add functions to assist in immutability of Event objects #1738
  • Convert Event Context to TS #1742
  • Bump lodash from 4.17.20 to 4.17.21 #1743
  • Add invite retries to file trees #1740
  • Convert IndexedDBStore to TS #1741
  • Convert additional files to typescript #1736

Changes in 12.0.0 (2021-06-21)

Full Changelog

  • No changes since rc.1

Changes in 12.0.0-rc.1 (2021-06-15)

Full Changelog

  • Rework how disambiguation is handled #1730
  • Fix baseToString for n=0 edge case to match inverse stringToBase #1735
  • Move various types from the react-sdk to the js-sdk #1734
  • Unstable implementation of MSC3089: File Trees #1732
  • Add MSC3230 event type to enum #1729
  • Add separate reason code for transferred calls #1731
  • Use sendonly for call hold #1728
  • Stop breeding sync listeners #1727
  • Fix semicolons in TS files #1724
  • [BREAKING] Convert MatrixClient to TypeScript #1718
  • Factor out backup management to a separate module #1697
  • Ignore power_levels events with unknown state_key on room-state initialization #1723
  • Revert 1579 (Fix extra negotiate message in Firefox) #1725

Changes in 11.2.0 (2021-06-07)

Full Changelog

  • No changes since rc.1

Changes in 11.2.0-rc.1 (2021-06-01)

Full Changelog

  • Switch to stable endpoint/fields for MSC2858 #1720
  • Bump ws from 7.4.2 to 7.4.6 #1715
  • Make consistent call event type checks #1712
  • Apply new Babel linting config #1714
  • Bump browserslist from 4.16.1 to 4.16.6 #1709
  • Add user_busy call hangup reason #1713
  • 👕 New linting rules #1688
  • Emit relations created when target event added later #1710
  • Bump libolm version and update package name. #1705
  • Fix uploadContent not rejecting promise when http status code >= 400 #1703
  • Reduce noise in tests #1702
  • Only log once if a Room lacks an m.room.create event #1700
  • Cache normalized room name #1701
  • Change call event handlers to adapt to undecrypted events #1698

Changes in 11.1.0 (2021-05-24)

Full Changelog

  • [Release] Bump libolm version and update package name #1707
  • [Release] Change call event handlers to adapt to undecrypted events #1699

Changes in 11.1.0-rc.1 (2021-05-19)

Full Changelog

  • Fix regressed glare #1690
  • Add m.reaction to EventType enum #1692
  • Prioritise and reduce the amount of events decrypted on application startup #1684
  • Decrypt relations before applying them to target event #1696
  • Guard against duplicates in Relations model

Changes in 11.0.0 (2021-05-17)

Full Changelog

  • [Release] Fix regressed glare #1695

Changes in 11.0.0-rc.1 (2021-05-11)

Full Changelog

BREAKING CHANGES

  • MatrixCall and related APIs have been redesigned to support multiple streams (see #1660 for more details)

All changes

  • Switch from MSC1772 unstable prefixes to stable #1679
  • Update the VoIP example to work with the new changes #1680
  • Bump hosted-git-info from 2.8.8 to 2.8.9 #1687
  • Support for multiple streams (not MSC3077) #1660
  • Tweak missing m.room.create errors to describe their source #1683

Changes in 10.1.0 (2021-05-10)

Full Changelog

  • No changes since rc.1

Changes in 10.1.0-rc.1 (2021-05-04)

Full Changelog

  • Revert "Raise logging dramatically to chase pending event errors" #1681
  • Add test coverage collection script #1677
  • Raise logging dramatically to chase pending event errors #1678
  • Support MSC3086 asserted identity #1674
  • Fix /search with no results field work again #1670
  • Add room.getMembers method #1672

Changes in 10.0.0 (2021-04-26)

Full Changelog

  • No changes since rc.1

Changes in 10.0.0-rc.1 (2021-04-21)

Full Changelog

BREAKING CHANGES

  • The RoomState.members event is now only emitted when the room member's power level or the room's normal power level actually changes

All changes

  • Restrict event emit for room members that had power levels changed #1675
  • Fix sync with misconfigured push rules #1669
  • Add missing await #1665
  • Migrate to eslint-plugin-matrix-org #1642
  • Add missing event type enum for key verification done #1664
  • Fix timeline jumpiness by setting correct txnId #1663
  • Fix calling addEventListener if it does not exist #1661
  • Persist unsent messages for subsequent sessions #1655

Changes in 9.11.0 (2021-04-12)

Full Changelog

  • No changes since rc.1

Changes in 9.11.0-rc.1 (2021-04-07)

Full Changelog

  • Only try to cache private keys we know exist #1657
  • Properly terminate screen-share calls if NoUserMedia #1654
  • Attended transfer #1652
  • Remove catch handlers in private key retrieval #1653
  • Fixed the media fail error on caller's side #1651
  • Add function to share megolm keys for historical messages, take 2 #1640
  • Cache cross-signing private keys if needed on bootstrap #1649

Changes in 9.10.0 (2021-03-29)

Full Changelog

  • No changes since rc.1

Changes in 9.10.0-rc.1 (2021-03-25)

Full Changelog

  • Don't send m.call.hangup if m.call.invite wasn't sent either #1647
  • docs: registerGuest() #1641
  • Download device keys in chunks of 250 #1639
  • More VoIP connectivity fixes #1646
  • Make selectDesktopCapturerSource param optional #1644
  • Expose APIs needed for reworked cross-signing login flow #1632

Changes in 9.9.0 (2021-03-15)

Full Changelog

  • No changes since rc.1

Changes in 9.9.0-rc.1 (2021-03-10)

Full Changelog

  • Remove detailed Olm session logging #1638
  • Add space summary suggested only param #1637
  • Check TURN servers periodically, and at start of calls #1634
  • Support sending invite reasons #1624
  • Bump elliptic from 6.5.3 to 6.5.4 #1636
  • Add a function to get a room's MXC URI #1635
  • Stop streams if the call has ended #1633
  • Remove export keyword from global.d.ts #1631
  • Fix IndexedDB store creation example #1445
  • An attempt to cleanup how constraints are handled in calls #1613
  • Extract display name patterns to constants #1628
  • Bump pug-code-gen from 2.0.2 to 2.0.3 #1630
  • Avoid deadlocks when ensuring Olm sessions for devices #1627
  • Filter out edits from other senders in history #1626
  • Fix ContentHelpers export #1618
  • Add logging to in progress Olm sessions #1621
  • Don't ignore ICE candidates received before offer/answer #1623
  • Better handling of send failures on VoIP events #1622
  • Log when turn creds expire #1620
  • Initial Spaces [MSC1772] support #1563
  • Add logging to crypto store transactions #1617
  • Room helper for getting type and checking if it is a space room #1610

Changes in 9.8.0 (2021-03-01)

Full Changelog

  • No changes since rc.1

Changes in 9.8.0-rc.1 (2021-02-24)

Full Changelog

  • Optimise prefixed logger #1615
  • Add debug logs to encryption prep, take 3 #1614
  • Add functions for upper & lowercase random strings #1612
  • Room helpers for invite permissions and join rules #1609
  • Fixed wording in "Adding video track with id" log #1606
  • Add more debug logs to encryption prep #1605
  • Add option to set ice candidate pool size #1604
  • Cancel call if no source was selected #1601

Changes in 9.7.0 (2021-02-16)

Full Changelog

  • No changes since rc.1

Changes in 9.7.0-rc.1 (2021-02-10)

Full Changelog

  • Handle undefined peerconn #1600
  • ReEmitter: Don't throw if no error handler is attached #1599
  • Convert ReEmitter to TS #1598
  • Fix typo in main readme #1597
  • Remove rogue plus character #1596
  • Fix call ID NaN #1595
  • Fix Electron type merging #1594
  • Fix browser screen share #1593
  • Fix desktop Matrix screen sharing #1570
  • Guard against confused server retry times #1591
  • Decrypt redaction events #1589
  • Fix edge cases with peeking where a room is re-peeked #1587

Changes in 9.6.0 (2021-02-03)

Full Changelog

  • [Release] Fix edge cases with peeking where a room is re-peeked #1588

Changes in 9.6.0-rc.1 (2021-01-29)

Full Changelog

  • Add support for getting call stats #1584
  • Fix compatibility with v0 calls #1583
  • Upgrade deps 2021-01 #1582
  • Log the call ID when logging that we've received VoIP events #1581
  • Fix extra negotiate message in Firefox #1579
  • Add debug logs to encryption prep #1580
  • Expose getPresence endpoint #1578
  • Queue keys for backup even if backup isn't enabled yet #1577
  • Stop retrying TURN access when forbidden #1576
  • Add DTMF sending support #1573

Changes in 9.5.1 (2021-01-26)

Full Changelog

  • [Release] Fix compatibility with v0 calls #1585

Changes in 9.5.0 (2021-01-18)

Full Changelog

  • No changes since rc.1

Changes in 9.5.0-rc.1 (2021-01-13)

Full Changelog

  • Don't log if no WebRTC #1574
  • Add _unstable_getSharedRooms #1417
  • Bump node-notifier from 8.0.0 to 8.0.1 #1568
  • Ignore party ID if opponent is v0 #1567
  • Basic call transfer initiation support #1566
  • Room version 6 is now a thing #1572
  • Store keys with same index but better trust level #1571
  • Use TypeScript source for development, swap to build during release #1561
  • Revert "Ignore party ID if opponent is v0" #1565
  • Basic call transfer initiation support #1558
  • Ignore party ID if opponent is v0 #1559
  • Honour a call reject event from another of our own devices #1562

Changes in 9.4.1 (2020-12-21)

Full Changelog

  • Further script tweaks to get all layers building again

Changes in 9.4.0 (2020-12-21)

Full Changelog

  • Revert postinstall script change, causes issues for other layers

Changes in 9.4.0-rc.2 (2020-12-16)

Full Changelog

  • Remove postinstall script which also runs as a dependency #1560

Changes in 9.4.0-rc.1 (2020-12-16)

Full Changelog

  • Fixes to support line 1 / 2 #1553
  • Add API for listening to remote hold status, advertise VoIP V1 #1549
  • A hangup from another client is still valid #1555
  • Remove temporary build step for tests #1554
  • Move browser build steps to prepublish only #1552
  • Extend getSsoLoginUrl for MSC2858 #1541

Changes in 9.3.0 (2020-12-07)

Full Changelog

  • No changes since rc.1

Changes in 9.3.0-rc.1 (2020-12-02)

Full Changelog

  • Export CallError #1551
  • Upgrade dependencies #1550
  • Don't log error when environment does not support WebRTC #1547
  • Fix dehydration method name #1544

Changes in 9.2.0 (2020-11-23)

Full Changelog

  • [Release] Fix dehydration method name #1545

Changes in 9.2.0-rc.1 (2020-11-18)

Full Changelog

  • Implement call holding functionality #1532
  • Support awaitable one-time dehydration #1537
  • Client set profile methods update own user #1534

Changes in 9.1.0 (2020-11-09)

Full Changelog

  • No changes since rc.1

Changes in 9.1.0-rc.1 (2020-11-04)

Full Changelog

  • Fix spelling error in the server ACL event type #1535
  • await idb operations from crypto store for dehydration #1533
  • Fix stuck never-sending messages #1531
  • Await key cache check to avoid prompts #1529
  • Improve ICE candidate batching #1524
  • Convert logger to typescript #1527
  • Fix logger typo #1525
  • bind online listener to window instead of document #1523
  • Support m.call.select_answer #1522

Changes in 9.0.1 (2020-10-28)

Full Changelog

  • [Release] Await key cache check to avoid prompts #1530

Changes in 9.0.0 (2020-10-26)

Full Changelog

Changes in 9.0.0-rc.1 (2020-10-21)

Full Changelog

BREAKING CHANGES

  • hasPendingEvent now returns false instead of throwing when pending ordering mode is not detached

All changes

  • Don't cache failures when fetching /versions #1521
  • Install deps first as part of release #1518
  • [Breaking] Change hasPendingEvent to return false if pending ordering !detached #1517
  • Skip editor prompts for merges #1519
  • Convert call test to TypeScript #1516
  • Support party_id #1512
  • Support m.call.reject #1510
  • Remove specbuild from .gitignore #1515
  • Log the error when we failed to send candidates #1514
  • Fixes for call state machine #1503
  • Fix call event handler listener removing #1506
  • Set the type of the call based on the tracks #1501
  • Use new local timestamp for calls #1499
  • Adjust types and APIs to match React SDK #1502
  • Make an accurate version of 'age' for events #1495
  • Make 'options' parameter optional #1498
  • Create a giant event type enum #1497
  • Convert call.js to Typescript & update WebRTC APIs (re-apply) #1494

Changes in 8.5.0 (2020-10-12)

Full Changelog

  • No changes since rc.1

Changes in 8.5.0-rc.1 (2020-10-07)

Full Changelog

  • Add support for olm fallback keys #1467
  • Fix editing local echoes not updating them in real time #1492
  • Fix re-emit of Event.replaced to be on client and not room #1491
  • Add space to log line #1496
  • Revert "Convert call.js to Typescript & update WebRTC APIs" #1493
  • Convert call.js to Typescript & update WebRTC APIs #1487
  • Dehydrate and rehydrate devices #1436
  • Keep local device after processing device list sync #1490
  • Enforce logger module via lint rules #1489
  • Extend method redactEvent with reason #1462
  • Catch exception from call event handler #1484
  • Ignore invalid candidates #1483
  • Always push docs if they are generated #1478
  • Only sign key backup with cross-signing keys when available #1481
  • Upgrade dependencies #1479

Changes in 8.4.1 (2020-09-28)

Full Changelog

  • Catch exception from call event handler #1486
  • Ignore invalid candidates #1485

Changes in 8.4.0 (2020-09-28)

Full Changelog

  • Only sign key backup with cross-signing keys when available #1482

Changes in 8.4.0-rc.1 (2020-09-23)

Full Changelog

  • If there are extraParams set, ensure that queryParams is defined #1477
  • Add diagnostics to security bootstrap paths #1475
  • Switch to a combination of better-docs and docdash #1459
  • Undo attempts to cache private keys aggressively #1474
  • Repair secret storage reset, cache keys when missing #1472
  • Prevent parallel getVersions calls #1471
  • Send end-of-candidates #1473
  • Add a function for checking the /versions flag for forced e2ee #1470
  • Add option to allow users of pantialaimon to use the SDK #1469
  • Fixed Yarn broken link #1468
  • some TypeScript and doc fixes #1466
  • Remove Travis CI reference #1464
  • Inject identity server token for 3pid invites on createRoom #1463

Changes in 8.3.0 (2020-09-14)

Full Changelog

  • No changes since rc.1

Changes in 8.3.0-rc.1 (2020-09-09)

Full Changelog

  • Add missing options in ICreateClientOpts #1452
  • Ensure ready functions return boolean values #1457
  • Handle missing cross-signing keys gracefully #1456
  • Fix eslint ts override tsx matching #1451
  • Untangle cross-signing and secret storage #1450

Changes in 8.2.0 (2020-09-01)

Full Changelog

Security notice

JS SDK 8.2.0 fixes an issue where encrypted state events could break incoming call handling. Thanks to @awesome-michael from Awesome Technologies for responsibly disclosing this via Matrix's Security Disclosure Policy.

All changes

  • No changes since rc.1

Changes in 8.2.0-rc.1 (2020-08-26)

Full Changelog

  • Add state event check #1449
  • Add method to check whether client .well-known has been fetched #1444
  • Handle auth errors during cross-signing key upload #1443
  • Don't fail if the requested audio output isn't available #1448
  • Fix logging failures #1447
  • Log the constraints we pass to getUserMedia #1446
  • Use SAS emoji data from matrix-doc #1440

Changes in 8.1.0 (2020-08-17)

Full Changelog

  • No changes since rc.1

Changes in 8.1.0-rc.1 (2020-08-13)

Full Changelog

  • Update on Promises #1438
  • Store and request master cross-signing key #1437
  • Filter out non-string display names #1433
  • Bump elliptic from 6.5.2 to 6.5.3 #1427
  • Replace Riot with Element in docs and comments #1431
  • Remove leftover bits of TSLint #1430

Changes in 8.0.1 (2020-08-05)

Full Changelog

  • Filter out non-string display names #1434

Changes in 8.0.1-rc.1 (2020-07-31)

Full Changelog

  • Remove redundant lint dependencies #1426
  • Upload all keys when we start using a new key backup version #1428
  • Expose countSessionsNeedingBackup #1429
  • Configure and use new eslint package #1422

Changes in 8.0.0 (2020-07-27)

Full Changelog

BREAKING CHANGES

  • RoomState events changed to use a Map instead of an object, which changes the collection APIs available to access them.

All Changes

  • Properly support txnId #1424
  • [BREAKING] Remove deprecated getIdenticonUri #1423
  • Bump lodash from 4.17.15 to 4.17.19 #1421
  • [BREAKING] Convert RoomState's stored state map to a real map #1419

Changes in 7.1.0 (2020-07-03)

Full Changelog

  • No changes since rc.1

Changes in 7.1.0-rc.1 (2020-07-01)

Full Changelog

  • Ask general crypto callbacks for 4S privkey if operation adapter doesn't have it yet #1414
  • Fix ICreateClientOpts missing idBaseUrl #1413
  • Increase max event listeners for rooms #1411
  • Don't trust keys megolm received from backup for verifying the sender #1406
  • Raise the last known account data / state event for an update #1410
  • Isolate encryption bootstrap side-effects #1380
  • Add method to get current in-flight to-device requests #1405

Changes in 7.0.0 (2020-06-23)

Full Changelog

  • No changes since rc.1

Changes in 7.0.0-rc.1 (2020-06-17)

Full Changelog

BREAKING CHANGES

  • Presence lists were removed from the spec in r0.5.0, and the corresponding methods have now been removed here as well:
    • getPresenceList
    • inviteToPresenceList
    • dropFromPresenceList

All changes

  • Remove support for unspecced device-specific push rules #1404
  • Use existing session id for fetching flows as to not get a new session #1403
  • Upgrade deps #1400
  • Bring back backup key format migration #1398
  • Fix: more informative error message when we cant find a key to decrypt with #1313
  • Add js-sdk mechanism for polling client well-known for config #1394
  • Fix verification request timeouts to match spec #1388
  • Drop presence list methods #1391
  • Batch up URL previews to prevent excessive requests #1395

Changes in 6.2.2 (2020-06-16)

Full Changelog

  • Use existing session id for fetching flows as to not get a new session #1407

Changes in 6.2.1 (2020-06-05)

Full Changelog

  • Bring back backup key format migration #1399

Changes in 6.2.0 (2020-06-04)

Full Changelog

  • No changes since rc.1

Changes in 6.2.0-rc.1 (2020-06-02)

Full Changelog

  • Make auth argument in the register request compliant with r0.6.0 #1304
  • Send the wrong auth params with the right auth params #1393
  • encrypt cached keys with pickle key #1387
  • Fix replying to key share requests #1385
  • Add dist to package.json files so CDNs can serve it #1384
  • Fix getVersion warning saying undefined room #1382
  • Combine the two places we processed client-level default push rules #1379
  • make MAC check robust against unpadded vs padded base64 differences #1378
  • Remove key backup format migration #1375
  • Add simple browserify browser-matrix.js tests #1241
  • support new key agreement method for SAS #1376

Changes in 6.1.0 (2020-05-19)

Full Changelog

  • No changes since rc.1

Changes in 6.1.0-rc.1 (2020-05-14)

Full Changelog

  • Remove support for asymmetric 4S encryption #1373
  • Increase timeout for 2nd phase of Olm session creation #1367
  • Add logging on decryption retries #1366
  • Emit event when a trusted self-key is stored #1364
  • Customize error payload for oversized messages #1352
  • Return null for key backup state when we haven't checked yet #1363
  • Added a progressCallback for backup key loading #1351
  • Add initialFetch param to willUpdateDevices / devicesUpdated #1360
  • Fix race between sending .request and receiving .ready over to_device #1359
  • Handle race between sending and await next event from other party #1357
  • Add crypto.willUpdateDevices event and make getStoredDevices/getStoredDevicesForUser synchronous #1354
  • Fix sender of local echo events in unsigned redactions #1350
  • Remove redundant key backup setup path #1353
  • Remove some dead code from _retryDecryption #1349
  • Don't send key requests until after sync processing is finished #1348
  • Prevent attempts to send olm messages to ourselves #1346
  • Retry account data upload requests #1345
  • Log first known index with megolm session updates #1344
  • Prune to_device messages to avoid sending empty messages #1343
  • Convert bunch of things to TypeScript #1335
  • Add logging when making new Olm sessions #1342
  • Fix: handle filter not found #1340
  • Make getAccountDataFromServer return null if not found #1338
  • Fix setDefaultKeyId to fail if the request fails #1336
  • Document setRoomEncryption not modifying room state #1328
  • Fix: don't do extra /filter request when enabling lazy loading of members #1332
  • Reject attemptAuth promise if no auth flow found #1329
  • Fix FilterComponent allowed_values check #1327
  • Serialise Olm prekey decryptions #1326
  • Fix: crash when backup key needs fixing from corruption issue #1324
  • Fix cross-signing/SSSS reset #1322
  • Implement QR code reciprocate for self-verification with untrusted MSK #1320

Changes in 6.0.0 (2020-05-05)

Full Changelog

  • Add progress callback for key backups #1368

Changes in 6.0.0-rc.2 (2020-05-01)

Full Changelog

  • Emit event when a trusted self-key is stored #1365

Changes in 6.0.0-rc.1 (2020-04-30)

Full Changelog

BREAKING CHANGES

  • client.getStoredDevicesForUser and client.getStoredDevices are no longer async

All Changes

  • Add initialFetch param to willUpdateDevices / devicesUpdated #1362
  • Fix race between sending .request and receiving .ready over to_device #1361
  • Handle race between sending and await next event from other party #1358
  • Add crypto.willUpdateDevices event and make getStoredDevices/getStoredDevicesForUser synchronous #1356
  • Remove redundant key backup setup path #1355

Changes in 5.3.1-rc.4 (2020-04-23)

Full Changelog

  • Retry account data upload requests #1347
  • Fix: handle filter not found #1341
  • Make getAccountDataFromServer return null if not found #1339
  • Fix setDefaultKeyId to fail if the request fails #1337
  • Fix: don't do extra /filter request when enabling lazy loading of members #1333
  • Reject attemptAuth promise if no auth flow found #1331
  • Serialise Olm prekey decryptions #1330

Changes in 5.3.1-rc.3 (2020-04-17)

Full Changelog

  • Fix cross-signing/SSSS reset #1323
  • Fix: crash when backup key needs fixing from corruption issue #1325

Changes in 5.3.1-rc.2 (2020-04-16)

Full Changelog

  • Implement QR code reciprocate for self-verification with untrusted MSK #1321

Changes in 5.3.1-rc.1 (2020-04-15)

Full Changelog

  • Adapt release script for riot-desktop #1319
  • Fix: prevent spurious notifications from indexer #1318
  • Always create our own user object #1317
  • Fix incorrect backup key format in SSSS #1311
  • Fix e2ee crash after refreshing after having received a cross-singing key reset #1315
  • Fix: catch send errors in SAS verifier #1314
  • Clear cross-signing keys when detecting the keys have changed #1312
  • Upgrade deps #1310

Changes in 5.3.0-rc.1 (2020-04-08)

Full Changelog

  • Store key backup key in cache as Uint8Array #1308
  • Use the correct request body for the /keys/query endpoint. #1307
  • Avoid creating two devices on registration #1305
  • Lower max-warnings to 81 #1306
  • Move key backup key creation before caching #1303
  • Expose function to force-reset outgoing room key requests #1298
  • Add isSelfVerification property to VerificationRequest #1302
  • QR code reciprocation #1297
  • Add ability to check symmetric SSSS key before we try to use it #1294
  • Add some debug logging for events stuck to bottom of timeline #1296
  • Fix: spontanous verification request cancellation under some circumstances #1295
  • Receive private key for caching from the app layer #1293
  • Track whether we have verified a user before #1292
  • Fix: error during tests #1222
  • Send .done event for to_device verification #1288
  • Request the key backup key & restore backup #1291
  • Make screen sharing works on Chrome using getDisplayMedia() #1276
  • Fix isVerified returning false #1289
  • Fix: verification gets cancelled when event gets duplicated #1286
  • Use requestSecret on the client to request secrets #1287
  • Allow guests to fetch TURN servers #1277

Changes in 5.2.0 (2020-03-30)

Full Changelog

  • Fix isVerified returning false #1290

Changes in 5.2.0-rc.1 (2020-03-26)

Full Changelog

  • Add a flag for whether cross signing signatures are trusted #1285
  • Cache user and self signing keys during bootstrap #1282
  • remove unnecessary promise #1283
  • Functions to cache session backups key automatically #1281
  • Add function for checking cross-signing is ready #1279
  • Use symmetric encryption for SSSS #1228
  • Migrate SSSS to use symmetric algorithm #1238
  • Migration to symmetric SSSS #1272
  • Reduce number of one-time-key requests #1280
  • Fix: assume the requested method is supported by other party with to_device #1275
  • Use checkDeviceTrust when computing untrusted devices #1278
  • Add a store for backup keys #1271
  • Upload only new device signature of master key #1268
  • Expose prepareToEncrypt in the client API #1270
  • Don't kill the whole device download if one device gives an error #1269
  • Handle racing .start event during self verification #1267
  • A crypto.keySignatureUploadFailure event reported the wrong source #1266
  • Fix editing of unsent messages by waiting for actual event id #1263
  • Fix: ensureOlmSessionsForDevices parameter format #1264
  • Remove stuff that yarn install doesn't think we need #1261
  • Fix: prevent error being thrown during sync in some cases #1258
  • Force is_verified for key backups to bool and fix computation #1259
  • Add a method for legacy single device verification, returning a verification request #1257
  • yarn upgrade #1256

Changes in 5.1.1 (2020-03-17)

Full Changelog

  • Fix: ensureOlmSessionsForDevices parameter format #1265
  • Fix: prevent error being thrown during sync in some cases #1262
  • Force is_verified for key backups to bool and fix computation #1260

Changes in 5.1.1-rc.1 (2020-03-11)

Full Changelog

  • refactor megolm encryption to improve perceived speed #1252
  • Remove v1 identity server fallbacks #1253
  • Use alt_aliases instead of local ones for room names #1251
  • Upload cross-signing key signatures in the background #1250
  • Fix secret sharing names to match spec #1249
  • Cleanup: remove crypto.verification.start event #1248
  • Fix regression in key backup request params #1246
  • Use cross-signing trust to mark backups verified #1244
  • Check both cross-signing and local trust for key sharing #1243
  • Fixed up tests to match new way that crypto stores are created #1242
  • Store USK and SSK locally #1235
  • Use unpadded base64 for QR code secrets #1236
  • Don't require .done event for finishing self-verification #1239
  • Don't cancel as 3rd party in verification request #1237
  • Verification: log when switching start event #1234
  • Perform crypto store operations directly after transaction #1233
  • More verification request logging #1232
  • Upgrade deps #1231

Changes in 5.1.0 (2020-03-02)

Full Changelog

  • No changes since rc.1

Changes in 5.1.0-rc.1 (2020-02-26)

Full Changelog

  • Add latest dist-tag for releases #1230
  • Add room method for alt_aliases #1225
  • Remove buildkite pipeline #1227
  • don't assume verify has been called when receiving a cancellation in verifier #1226
  • Reduce secret size for new binary packing #1221
  • misc rageshake fixes #1223
  • Fix cancelled historical requests not appearing as cancelled #1220
  • Fix renaming error that broke QR code verification #1217

Changes in 5.0.1 (2020-02-19)

Full Changelog

  • add method for new /aliases endpoint #1219
  • method for checking if other party supports verification method #1213
  • add local echo state for accepting or declining a verif req #1210
  • make logging compatible with rageshakes #1214
  • Find existing requests when starting a new verification request #1209
  • log MAC calculation during SAS #1211

Changes in 5.0.0 (2020-02-17)

Full Changelog

  • No changes since rc.1

Changes in 5.0.0-rc.1 (2020-02-13)

Full Changelog

BREAKING CHANGES

  • The verification methods API has removed an argument (#1206)

All Changes

  • Remove methods argument to verification #1206
  • don't do a dynamic import of request #1207
  • QR self-verification fixes #1201
  • Log every verification event #1204
  • dont require .done event from other party #1203
  • New option to fully reset Secret Storage keys in boostrapSecretStorage #1202
  • Add function to estimate target device for a VerificationRequest #1190
  • pass ssss item name to callback so we can differentiate UI on it #1200
  • add export/import of Olm devices #1167
  • Convert utils.js -> utils.ts #1199
  • Don't sign ourselves as a user #1197
  • Add a bunch of logging to verification #1196
  • Fix: always return a valid string from InRoomChannel.getEventType #1198
  • add logging when a request is being cancelled #1195
  • Don't explode verification validation if we don't have an event type #1194
  • Fix: verification request appearing for users that are not the receiver or sender if they are in room #1193
  • Fix getting secrets encoded with passthrough keys #1192
  • Update QR code handling for new spec #1175
  • Don't add ephemeral events to timeline when peeking #1188
  • Fix typo #1189
  • Verification: resolve race between .start events from both parties #1187
  • Add option to bootstrap to start new key backup #1184
  • Add a bunch of null guards to feature checks #1182
  • docs: fix MatrixClient reference #1183
  • Add helper to obtain the cancellation code for a verification request #1180
  • Publish pre-releases as a separate tag on npm #1178
  • Fix support for passthrough keys #1177
  • Trust our own cross-signing keys if we verify them with another device #1174
  • Ensure cross-signing keys are downloaded when checking trust #1176
  • Don't log verification validation errors for normal messages #1172
  • Fix bootstrap cleanup #1173
  • QR code verification #1155
  • expose deviceId prop on device channel #1171
  • Move & upgrade babel runtime into dependencies (like it wants) #1169
  • Add unit tests for verifying your own device, remove .event property on verification request #1166
  • For dm-verification, also consider events sent by other devices of same user as "our" events #1163
  • Add a prepare script #1161
  • Remove :deviceId from /keys/upload/:deviceId as not spec-compliant #1162
  • Refactor and expose some logic publicly for the TimelineWindow class. #1159
  • Allow a device key upload request without auth #1158
  • Support for .ready verification event (MSC2366) & other things #1140

Changes in 4.0.0 (2020-01-27)

Full Changelog

  • Move & upgrade babel runtime into dependencies (like it wants) #1170
  • Add a prepare script #1164

Changes in 4.0.0-rc.1 (2020-01-20)

Full Changelog

BREAKING CHANGES

  • The js-sdk node module now exports ES6 rather than ES5. If you wish to supports target that aren't compatible with ES6, you will need to transpile the js-sdk to a suitable dialect.

All Changes

  • Convert secret storage to new account data API #1154
  • Add v5 as a safe room version #1157
  • Add API to get account data from server #1153
  • Fix sourcemaps by refactoring the build system #1151
  • record, report, and notify about olm errors #1146
  • Send device messages for the same user in same API call. #1148
  • Add an option to ignore unverified devices #1150
  • Sign key backup with cross-signing key on upgrade #1144
  • Emoji verification: Change name of 🔒 to lock #1145
  • use a separate object for each encrypted content #1147
  • Sourcemaps: develop -> feature branch #1143
  • Use a safer import/export scheme for the ContentRepo utilities #1134
  • Fix error handling in decryptGroupMessage #1142
  • Add additional properties to package.json for riot-web's webpack #1131
  • Fix import for indexeddb crypto store #1133
  • Use the right request when creating clients #1132
  • Target NodeJS 10, minified browser bundle, and other publishing/package things #1127
  • Re-focus sourcemap generation #1126
  • Remove ancient polyfill for prototype inheritance #1125
  • Remove "source-map-support" from tests because it makes sourcemaps worse #1124
  • Remove ancient "use strict" annotations #1123
  • Use ES6 imports/exports instead of older CommonJS ones #1122
  • [BREAKING] Refactor the entire build process #1113

Changes in 3.0.0 (2020-01-13)

Full Changelog

  • No changes from rc.1

Changes in 3.0.0-rc.1 (2020-01-06)

Full Changelog

BREAKING CHANGES

  • matrix-js-sdk no longer uses bluebird promises, so promises returned by the js-sdk no longer support the done() method. Code that calls done() on promises returned by the js-sdk will break and will need to be updated to remove the done() call.

All Changes

  • Make displayName disambiguation more fuzzy especially against RTL/LTR content #1141
  • stop trying to resend event if we get M_TOO_LARGE #1129
  • Fix creating a key backup with cross signing diabled #1139
  • Use checkDeviceTrust with key backup #1138
  • Add support for passthrough SSSS secrets #1128
  • Add support for key backups using secret storage #1118
  • Remove unused user verification event #1117
  • Fix check for private keys #1116
  • Restore watching mode for start:watch #1115
  • Add secret storage bootstrap flow #1079
  • Part 1 of many: Upgrade to babel@7 and TypeScript #1112
  • Remove Bluebird: phase 2.5 #1100
  • Remove Bluebird: phase 3 #1088
  • ignore m.key.verification.done messages when we don't expect any more messages #1104
  • dont cancel on remote echo of own .request event #1111
  • Refactor verification request code #1109
  • Fix device list's cross-signing storage path #1105
  • yarn upgrade #1103

Changes in 2.4.6 (2019-12-09)

Full Changelog

  • No changes since rc.1

Changes in 2.4.6-rc.1 (2019-12-04)

Full Changelog

  • Update alias handling #1102
  • increase timeout on flush to fix failing unit test #1096
  • Disable broken cross-signing test #1095
  • Fix a couple SAS tests #1094
  • Fix Olm unwedging test #1093
  • Fix empty string handling in push notifications #1089
  • expand e2ee logging to better debug UISIs #1090
  • Remove Bluebird: phase 2 #1087
  • Relax identity server discovery checks to FAIL_PROMPT #1062
  • Fix incorrect return value of MatrixClient.prototype.uploadKeys #1061
  • Fix calls in e2e rooms #1086
  • Monitor verification request over DM as well #1085
  • Remove 'check' npm script #1084
  • Always process call events in batches #1083
  • Fix ringing chirp on loading #1082
  • Remove most bluebird specific things #1081
  • Switch to Jest #1080

Changes in 2.4.5 (2019-11-27)

Full Changelog

  • Relax identity server discovery checks to FAIL_PROMPT
  • Expand E2EE debug logging to diagnose "unable to decrypt" errors

Changes in 2.4.4 (2019-11-25)

Full Changelog

  • No changes since rc.1

Changes in 2.4.4-rc.1 (2019-11-20)

Full Changelog

  • Fix SAS verification in encrypted DMs #1077
  • Cross-signing / secret storage tweaks #1078
  • Fix local trust for key backups #1075
  • Add method to get last active timestamp in room #1072
  • Check the right Synapse endpoint for determining admin capabilities #1071
  • Cross Signing Support #832
  • Don't double cancel verification request #1064
  • Support for verification requests in the timeline #1067
  • Use stable API prefix for 3PID APIs when supported #1066
  • Remove Jenkins scripts #1063

Changes in 2.4.3 (2019-11-04)

Full Changelog

  • No changes since rc.1

Changes in 2.4.3-rc.1 (2019-10-30)

Full Changelog

  • fix the path in references to logger.js #1056
  • verification in DMs #1050
  • Properly documented the function possible returns #1054
  • Downgrade to Bluebird 3.5.5 to fix Firefox #1055
  • Upgrade safe deps to latest major version #1053
  • Don't include .js in the import string. #1052

Changes in 2.4.2 (2019-10-18)

Full Changelog

  • No changes since v2.4.2-rc.1

Changes in 2.4.2-rc.1 (2019-10-09)

Full Changelog

  • Log state of Olm sessions #1047
  • Add method to get access to all timelines #1048

Changes in 2.4.1 (2019-10-01)

Full Changelog

  • Upgrade deps #1046
  • Ignore crypto events with no content #1043

Changes in 2.4.0 (2019-09-27)

Full Changelog

  • Clean Yarn cache during release #1045

Changes in 2.4.0-rc.1 (2019-09-25)

Full Changelog

  • Remove id_server from creds for interactive auth #1044
  • Remove IS details from requestToken to HS #1041
  • Add support for sending MSISDN tokens to alternate URLs #1040
  • Add separate 3PID add and bind APIs #1038
  • Bump eslint-utils from 1.4.0 to 1.4.2 #1037
  • Handle WebRTC security errors as non-fatal #1036
  • Check for r0.6.0 support in addition to unstable feature flags #1035
  • Update room members on member event redaction #1030
  • Support hidden read receipts #1028
  • Do 3pid lookups in lowercase #1029
  • Add Synapse admin functions for deactivating a user #1027
  • Fix addPendingEvent with pending event order == chronological #1026
  • Add AutoDiscovery.getRawClientConfig() for easy .well-known lookups #1024
  • Don't convert errors to JSON if they are JSON already #1025
  • Send id_access_token to HS for use in proxied IS requests #1022
  • Clean up JSON handling in identity server requests #1023
  • Use the v2 (hashed) lookup for identity server queries #1021
  • Add getIdServer() & doesServerRequireIdServerParam() #1018
  • Make requestToken endpoints work without ID Server #1019
  • Fix setIdentityServer #1016
  • Change ICE fallback server and make fallback opt-in #1015
  • Throw an exception if trying to do an ID server request with no ID server #1014
  • Add setIdentityServerUrl #1013
  • Add matrix base API to report an event #1011
  • Fix POST body for v2 IS requests #1010
  • Add API for bulk lookup on the Identity Server #1009
  • Remove deprecated authedRequestWithPrefix and requestWithPrefix #1000
  • Add API for checking IS account info #1007
  • Support rewriting push rules when our internal defaults change #1006
  • Upgrade dependencies #1005

Changes in 2.3.2 (2019-09-16)

Full Changelog

  • [Release] Fix addPendingEvent with pending event order == chronological #1034

Changes in 2.3.2-rc.1 (2019-09-13)

Full Changelog

  • Synapse admin functions to release #1033
  • [To Release] Add matrix base API to report an event #1032

Changes in 2.3.1 (2019-09-12)

Full Changelog

  • No changes since rc.1

Changes in 2.3.1-rc.1 (2019-09-11)

Full Changelog

  • Update room members on member event redaction #1031

Changes in 2.3.0 (2019-08-05)

Full Changelog

  • [release] Support rewriting push rules when our internal defaults change #1008

Changes in 2.3.0-rc.1 (2019-07-31)

Full Changelog

  • Add support for IS v2 API with authentication #1002
  • Tombstone bugfixes #1001
  • Support for MSC2140 (terms of service for IS/IM) #988
  • Add a request method to /devices #994

Changes in 2.2.0 (2019-07-18)

Full Changelog

  • Upgrade lodash dependencies

Changes in 2.2.0-rc.2 (2019-07-12)

Full Changelog

  • Fix regression from 2.2.0-rc.1 in request to /devices #995

Changes in 2.2.0-rc.1 (2019-07-12)

Full Changelog

  • End the verification timer when verification is done #993
  • Stabilize usage of stably stable APIs (in a stable way) #990
  • Expose original_event for /relations #987
  • Process ephemeral events outside timeline handling #989
  • Don't accept any locally known edits earlier than the last known server-side aggregated edit #986
  • Get edit date transparently from server aggregations or local echo #984
  • Add a function to flag keys for backup without scheduling a backup #982
  • Block read marker and read receipt from advancing into pending events #981
  • Upgrade dependencies #977
  • Add default push rule to ignore reactions #976
  • Fix exception whilst syncing #979
  • Include the error object when raising Session.logged_out #975

Changes in 2.1.1 (2019-07-11)

Full Changelog

  • Process emphemeral events outside timeline handling #989

Changes in 2.1.0 (2019-07-08)

Full Changelog

  • Fix exception whilst syncing #979

Changes in 2.1.0-rc.1 (2019-07-03)

Full Changelog

  • Handle self read receipts for fixing e2e notification counts #974
  • Add redacts field to event.toJSON #973
  • Handle associated event send failures #972
  • Remove irrelevant debug line from timeline handling #971
  • Handle relations in encrypted rooms #969
  • Relations endpoint support #967
  • Disable event encryption for reactions #968
  • Change the known safe room version to version 4 #966
  • Check for lazy-loading support in the spec versions instead #965
  • Use camelCase instead of underscore #963
  • Time out verification attempts after 10 minutes of inactivity #961
  • Don't handle key verification requests which are immediately cancelled #962

Changes in 2.0.1 (2019-06-19)

Full Changelog

No changes since rc.2

Changes in 2.0.1-rc.2 (2019-06-18)

Full Changelog

  • return 'sending' status for an event that is only locally redacted #960
  • Key verification request fixes #954
  • Add flag to force saving sync store #956
  • Expose the inhibit_login flag to register #953
  • Support redactions and relations of/with unsent events. #947

Changes in 2.0.1-rc.1 (2019-06-12)

Full Changelog

  • Fix content uploads for modern browsers #952
  • Don't overlap auth submissions with polls #951
  • Add funding details for GitHub sponsor button #945
  • Fix backup sig validation with multiple sigs #944
  • Don't send another token request while one's in flight #943
  • Don't poll UI auth again until current poll finishes #942
  • Provide the discovered URLs when a liveliness error occurs #938
  • Encode event IDs when redacting events #941
  • add missing logger #940
  • verification: don't error if we don't know about some keys #939
  • Local echo for redactions #937
  • Refresh safe room versions when the server looks more modern than us #934
  • Add v4 as a safe room version #935
  • Disable guard-for-in rule #933
  • Extend loglevel logging for the whole project #924
  • fix(login): saves access_token and user_id after login for all login types #930
  • Do not try to request thumbnails with non-integer sizes #929
  • Revert "Add a bunch of debugging to .well-known IS validation" #928
  • Add a bunch of debugging to .well-known IS validation #927

Changes in 2.0.0 (2019-05-31)

Full Changelog

BREAKING CHANGES

  • This package now publishes in ES6 / ES2015 syntax to NPM
  • Saves access_token and user_id after login for all login types #932
  • Fix recovery key encoding for base-x 3.0.5 #931

Changes in 1.2.0 (2019-05-29)

Full Changelog

Changes in 1.2.0-rc.1 (2019-05-23)

Full Changelog

  • interactive-auth now handles requesting email tokens #926
  • allow access to unreplaced message content #923
  • Add method to retrieve replacing event #922
  • More logging when signature verification fails #921
  • Local echo for m.replace relations #920
  • Track relations as pending and remove when cancelled #919
  • Add stringify helper to summarise events when debugging #916
  • Message editing: filter out replacements for senders that are not the original sender #918
  • Wait until decrypt before aggregating #917
  • Message editing: mark original event as replaced instead of replacing the event object #914
  • Support for replacing message through m.replace relationship. #913
  • Use a short timeout for .well-known requests #912
  • Redaction and change events for relations #911
  • Add basic read path for relations #910
  • Add a concept of default push rules, using it for tombstone notifications #860
  • yarn upgrade #907

Changes in 1.1.0 (2019-05-07)

Full Changelog

  • No Changes since rc.1

Changes in 1.1.0-rc.1 (2019-04-30)

Full Changelog

  • use the release version of olm 3.1.0 #903
  • Use new Olm repo link in README #901
  • Support being fed a .well-known config object for validation #897
  • emit self-membership event at end of handling sync update #900
  • Use packages.matrix.org for Olm #898
  • Fix tests on develop #899
  • Stop syncing when the token is invalid #895
  • change event redact, POST request to PUT request #887
  • Expose better autodiscovery error messages #894
  • Explicitly guard store usage during sync startup #892
  • Flag v3 rooms as safe #893
  • Cache failed capabilities lookups for shorter amounts of time #890
  • Fix highlight notifications for unencrypted rooms #891
  • Document checking crypto state before using hasUnverifiedDevices #889
  • Add logging to sync startup path #888
  • Track e2e highlights better, particularly in 'Mentions Only' rooms #886
  • support both the incorrect and correct MAC methods #882
  • Refuse to set forwards pagination token on live timeline #885
  • Degrade IndexedDBStore back to memory only on failure #884
  • Refuse to link live timelines into the forwards/backwards position when either is invalid #877
  • Key backup logging improvements #883
  • Don't assume aborts are always from txn.abort() #880
  • Add a bunch of logging #878
  • Refuse splicing the live timeline into a broken position #873
  • Add existence check to local storage based crypto store #872

Changes in 1.0.4 (2019-04-08)

Full Changelog

Changes in 1.0.3 (2019-04-01)

Full Changelog

  • Add existence check to local storage based crypto store #874

Changes in 1.0.3-rc.1 (2019-03-27)

Full Changelog

  • Add IndexedDB existence checks #871
  • Emit sync errors for capturing by clients #869
  • Add functions for getting room upgrade history and leaving those rooms #868
  • Clarify the meaning of 'real name' for contribution #867
  • Remove sessionStore to cryptoStore migration path #865
  • Add debugging for spurious room version warnings #866
  • Add investigation notes for browser storage #864
  • make sure resolve object is defined before calling it #862
  • Rename MatrixInMemoryStore to MemoryStore #861
  • Use Buildkite for CI #859
  • only create one session at a time per device #857

Changes in 1.0.2 (2019-03-18)

Full Changelog

  • No changes since rc.1

Changes in 1.0.2-rc.1 (2019-03-13)

Full Changelog

  • Use modern Yarn version on Travis CI #858
  • Switch to yarn for dependency management #856
  • More key request fixes #855
  • Calculate encrypted notification counts #851
  • Update dependencies #854
  • make sure key requests get sent #850
  • Use 'ideal' rather than 'exact' for deviceid #852
  • handle partially-shared sessions better #848

Changes in 1.0.1 (2019-03-06)

Full Changelog

  • No changes since rc.2

Changes in 1.0.1-rc.2 (2019-03-05)

Full Changelog

  • dont swallow txn errors in crypto store #853
  • Don't swallow txn errors in crypto store #849

Changes in 1.0.1-rc.1 (2019-02-28)

Full Changelog

  • Fix "e is undefined" masking the original error in MegolmDecryption #847

Changes in 1.0.0 (2019-02-14)

Full Changelog

  • Try again to commit package-lock.json #841

Changes in 1.0.0-rc.2 (2019-02-14)

Full Changelog

  • Release script: commit package-lock.json #839
  • Add method to force re-check of key backup #840
  • Fix: dont check for unverified devices in left members #838

Changes in 1.0.0-rc.1 (2019-02-08)

Full Changelog

  • change hex SAS verification to decimal and emoji #837
  • Trust on decrypt #836
  • Always track our own devices #835
  • Make linting rules more consistent #834
  • add method to room to check for unverified devices #833
  • Merge redesign into develop #831
  • Supporting infrastructure for educated decisions on when to upgrade rooms #830
  • Include signature info for unknown devices #826
  • Flag v2 rooms as "safe" #828
  • Update ESLint #821

Changes in 0.14.3 (2019-01-22)

Full Changelog

  • No changes since rc.1

Changes in 0.14.3-rc.1 (2019-01-17)

Full Changelog

  • Merge develop into experimental #815
  • Add a getAllEndToEndSessions to crypto store #812
  • T3chguy/fix displayname logic #668
  • Contributing: Note that rebase lets you mass signoff commits #814
  • take into account homoglyphs when calculating similar display names #672
  • Emit for key backup failures #809
  • emit oldEventId on "updatePendingEvent" #646
  • Add getThirdpartyUser to base api #589
  • Support custom status messages #805
  • Extra checks to avoid release script blowing up mid-process. #749
  • Move glob regex utilities out of the pushprocessor and into a more generic place #800

Changes in 0.14.2 (2018-12-10)

Full Changelog

  • No changes since rc.1

Changes in 0.14.2-rc.1 (2018-12-06)

Full Changelog

  • fix some assertions in e2e backup unit test #794
  • Config should be called with auth #798
  • Don't re-establish sessions with unknown devices #792
  • e2e key backups #684
  • WIP: online incremental megolm backups #595
  • Support for e2e key backups #736
  • Passphrase Support for e2e backups #786
  • Add 'getSsoLoginUrl' function #783
  • Fix: don't set the room name to null when heroes are missing. #784
  • Handle crypto db version upgrades #785
  • Restart broken Olm sessions #780
  • Use the last olm session that got a message #776

Changes in 0.14.1 (2018-11-22)

Full Changelog

  • Warning when crypto DB is too new to use.

Changes in 0.14.0 (2018-11-19)

Full Changelog

  • No changes since rc.1

Changes in 0.14.0-rc.1 (2018-11-15)

Full Changelog

BREAKING CHANGE

  • js-sdk now uses Olm 3.0. Apps using Olm must update to 3.0 to continue using Olm with the js-sdk. The js-sdk will call Olm's init() method when the client is started.

All Changes

  • Prevent messages from being sent if other messages have failed to send #781
  • A unit test for olm #777
  • Set access_token and user_id after login in with username and password. #778
  • Add function to get currently joined rooms. #779
  • Remove the request-only stuff we don't need anymore #775
  • Manually construct query strings for browser-request instances #770
  • Fix: correctly check for crypto being present #769
  • Update babel-eslint to 8.1.1 #768
  • Support request in the browser and support supplying servers to try in joinRoom() #764
  • loglevel should be a normal dependency #767
  • Stop devicelist when client is stopped #766
  • Update to WebAssembly-powered Olm #743
  • Logging lib. Fixes #332 #763
  • Use new stop() method on matrix-mock-request #765

Changes in 0.13.1 (2018-11-14)

Full Changelog

  • Add function to get currently joined rooms. #779

Changes in 0.13.0 (2018-11-15)

Full Changelog

BREAKING CHANGE

  • MatrixClient::login now sets client access_token and user_id following successful login with username and password.

Changes in 0.12.1 (2018-10-29)

Full Changelog

  • No changes since rc.1

Changes in 0.12.1-rc.1 (2018-10-24)

Full Changelog

  • Add repository type to package.json to make it valid #762
  • Add getMediaConfig() #761
  • add new examples, to be expanded into a post #739

Changes in 0.12.0 (2018-10-16)

Full Changelog

  • No changes since rc.1

Changes in 0.12.0-rc.1 (2018-10-11)

Full Changelog

BREAKING CHANGES

  • If js-sdk finds data in the store that is incompatible with the options currently being used, it will emit sync state ERROR with an error of type InvalidStoreError. It will also stop trying to sync in this situation: the app must stop the client and then either clear the store or change the options (in this case, enable or disable lazy loading of members) and then start the client again.

All Changes

  • never replace /sync'ed memberships with OOB ones #760
  • Don't fail to start up if lazy load check fails #759
  • Make e2e work on Edge #754
  • throw error with same name and message over idb worker boundary #758
  • Default to a room version of 1 when there is no room create event #755
  • Silence bluebird warnings #757
  • allow non-ff merge from release branch into master #750
  • Reject with the actual error on indexeddb error #751
  • Update mocha to v5 #744
  • disable lazy loading for guests as they cant create filters #748
  • Revert "Add getMediaLimits to client" #745

Changes in 0.11.1 (2018-10-01)

Full Changelog

  • No changes since rc.1

Changes in 0.11.1-rc.1 (2018-09-27)

Full Changelog

  • make usage of hub compatible with latest version (2.5) #747
  • Detect when lazy loading has been toggled in client.startClient #746
  • Add getMediaLimits to client #644
  • Split npm start into an init and watch script #742
  • Revert "room name should only take canonical alias into account" #738
  • fix display name disambiguation with LL #737
  • Introduce Room.myMembership event #735
  • room name should only take canonical alias into account #733
  • state events from context response were not wrapped in a MatrixEvent #732
  • Reduce amount of promises created when inserting members #724
  • dont wait for LL members to be stored to resolve the members #726
  • RoomState.members emitted with wrong argument order for OOB members #728

Changes in 0.11.0 (2018-09-10)

Full Changelog

BREAKING CHANGES

  • v0.11.0-rc.1 introduced some breaking changes - see the respective release notes.

No changes since rc.1

Changes in 0.11.0-rc.1 (2018-09-07)

Full Changelog

  • Support for lazy loading members. This should improve performance for users who joined big rooms a lot. Pass to lazyLoadMembers = true option when calling startClient.

BREAKING CHANGES

  • MatrixClient::startClient now returns a Promise. No method should be called on the client before that promise resolves. Before this method didn't return anything.
  • A new CATCHUP sync state, emitted by MatrixClient#"sync" and returned by MatrixClient::getSyncState(), when doing initial sync after the ERROR state. See MatrixClient documentation for details.
  • RoomState::maySendEvent('m.room.message', userId) & RoomState::maySendMessage(userId) do not check the membership of the user anymore, only the power level. To check if the syncing user is allowed to write in a room, use Room::maySendMessage() as RoomState is not always aware of the syncing user's membership anymore, in case lazy loading of members is enabled.

All Changes

  • Only emit CATCHUP if recovering from conn error #727
  • Fix docstring for sync data.error #725
  • Re-apply "Don't rely on members to query if syncing user can post to room" #723
  • Revert "Don't rely on members to query if syncing user can post to room" #721
  • Don't rely on members to query if syncing user can post to room #717
  • Fixes for room.guessDMUserId #719
  • Fix filepanel also filtering main timeline with LL turned on. #716
  • Remove lazy loaded members when leaving room #711
  • Fix: show spinner again while recovering from connection error #702
  • Add method to query LL state in client #714
  • Fix: also load invited members when lazy loading members #707
  • Pass through function to discard megolm session #704

Changes in 0.10.9 (2018-09-03)

Full Changelog

  • No changes since rc.2

Changes in 0.10.9-rc.2 (2018-08-31)

Full Changelog

  • Fix for "otherMember.getAvatarUrl is not a function" #708

Changes in 0.10.9-rc.1 (2018-08-30)

Full Changelog

  • Fix DM avatar #706
  • Lazy loading: avoid loading members at initial sync for e2e rooms #699
  • Improve setRoomEncryption guard against multiple m.room.encryption st… #700
  • Revert "Lazy loading: don't block on setting up room crypto" #698
  • Lazy loading: don't block on setting up room crypto #696
  • Add getVisibleRooms() #695
  • Add wrapper around getJoinedMemberCount() #697
  • Api to fetch events via /room/.../event/.. #694
  • Support for room upgrades #693
  • Lazy loading of room members #691

Changes in 0.10.8 (2018-08-20)

Full Changelog

  • No changes since rc.1

Changes in 0.10.8-rc.1 (2018-08-16)

Full Changelog

  • Add getVersion to Room #689
  • Add getSyncStateData() #680
  • Send sync error to listener #679
  • make sure room.tags is always a valid object to avoid crashes #675
  • Fix infinite spinner upon joining a room #673

Changes in 0.10.7 (2018-07-30)

Full Changelog

  • No changes since rc.1

Changes in 0.10.7-rc.1 (2018-07-24)

Full Changelog

  • encrypt for invited users if history visibility allows. #666

Changes in 0.10.6 (2018-07-09)

Full Changelog

  • No changes since rc.1

Changes in 0.10.6-rc.1 (2018-07-06)

Full Changelog

  • Expose event decryption error via Event.decrypted event #665
  • Add decryption error codes to base.DecryptionError #663

Changes in 0.10.5 (2018-06-29)

Full Changelog

  • No changes since rc.1

Changes in 0.10.5-rc.1 (2018-06-21)

Full Changelog

  • fix auth header and filename=undefined #659
  • allow setting the output device for webrtc calls #650
  • arguments true and false are actually invalid #596
  • fix typo where headers was not being used and thus sent wrong content-type #643
  • fix some documentation typos #642

Changes in 0.10.4 (2018-06-12)

Full Changelog

  • No changes since rc.1

Changes in 0.10.4-rc.1 (2018-06-06)

Full Changelog

  • check whether notif level is undefined, because 0 is falsey #651

Changes in 0.10.3 (2018-05-25)

Full Changelog

  • No changes since v0.10.3-rc.1

Changes in 0.10.3-rc.1 (2018-05-24)

Full Changelog

BREAKING CHANGE

The deprecated 'callback' parameter has been removed from MatrixBaseApis.deactivateAccount

  • Add erase option to deactivateAccount #649
  • Emit Session.no_consent when M_CONSENT_NOT_GIVEN received #647

Changes in 0.10.2 (2018-04-30)

Full Changelog

  • No changes from rc.1

Changes in 0.10.2-rc.1 (2018-04-25)

Full Changelog

  • Ignore inserts of dup inbound group sessions, pt 2 #641
  • Ignore inserts of duplicate inbound group sessions #639
  • Log IDB errors #638
  • Remove not very useful but veryv spammy log line #632
  • Switch event type to m.sticker. #628

Changes in 0.10.1 (2018-04-12)

Full Changelog

  • Log IDB errors #638
  • Ignore inserts of duplicate inbound group sessions #639
  • Ignore inserts of dup inbound group sessions, pt 2 #641

Changes in 0.10.0 (2018-04-11)

Full Changelog

  • No changes

Changes in 0.10.0-rc.2 (2018-04-09)

Full Changelog

  • Add wrapper for group join API
  • Add wrapped API to set group join_policy

Changes in 0.10.0-rc.1 (2018-03-19)

Full Changelog

  • Fix duplicated state events in timeline from peek #630
  • Create indexeddb worker when starting the store #627
  • Fix indexeddb logging #626
  • Don't do /keys/changes on incremental sync #625
  • Don't mark devicelist dirty unnecessarily #623
  • Cache the joined member count for a room state #619
  • Fix JS doc #618
  • Precompute push actions for state events #617
  • Fix bug where global "Never send to unverified..." is ignored #616
  • Intern legacy top-level 'membership' field #615
  • Don't synthesize RR for m.room.redaction as causes the RR to go missing. #598
  • Make Events create Dates on demand #613
  • Stop cloning events when adding to state #612
  • De-dup code: use the initialiseState function #611
  • Create sentinel members on-demand #610
  • Some more doc on how sentinels work #609
  • Migrate room encryption store to crypto store #597
  • add parameter to getIdentityServerUrl to strip the protocol for invites #600
  • Move Device Tracking Data to Crypto Store #594
  • Optimise pushprocessor #591
  • Set event error before emitting #592
  • Add event type for stickers [WIP] #590
  • Migrate inbound sessions to cryptostore #587
  • Disambiguate names if they contain an mxid #588
  • Check for sessions in indexeddb before migrating #585
  • Emit an event for crypto store migration #586
  • Supporting fixes For making UnknownDeviceDialog not pop up automatically #575
  • Move sessions to the crypto store #584
  • Change crypto store transaction API #582
  • Add some missed copyright notices #581
  • Move Olm account to IndexedDB #579
  • Fix logging of DecryptionErrors to be more useful #580
  • [BREAKING] Change the behaviour of the unverfied devices blacklist flag #568
  • Support set_presence=offline for syncing #557
  • Consider cases where the sender may not redact their own event #556

Changes in 0.9.2 (2017-12-04)

Full Changelog

Changes in 0.9.1 (2017-11-17)

Full Changelog

  • Fix the force TURN option #577

Changes in 0.9.0 (2017-11-15)

Full Changelog

Changes in 0.9.0-rc.1 (2017-11-10)

Full Changelog

  • Modify addRoomToGroup to allow setting isPublic, create alias updateGroupRoomAssociation #567
  • Expose more functionality of pushprocessor #565
  • Function for working out notif trigger permission #566
  • keep track of event ID and timestamp of decrypted messages #555
  • Fix notifEvent computation #564
  • Fix power level of sentinel members #563
  • don't try to decrypt a redacted message (fixes element-hq/element-web#3744) #554
  • Support room notifs #562
  • Fix the glob-to-regex code #558

Changes in 0.8.5 (2017-10-16)

Full Changelog

  • Make unknown pushrule conditions not match #559

Changes in 0.8.5-rc.1 (2017-10-13)

Full Changelog

  • Implement wrapper API for removing a room from a group #553
  • Fix typo which resulted in stuck key download requests #552
  • Store group when it's created #549
  • Luke/groups remove rooms users from summary #548
  • Clean on prepublish #546
  • Implement wrapper APIs for adding rooms to group summary #545

Changes in 0.8.4 (2017-09-21)

Full Changelog

  • Fix build issue

Changes in 0.8.3 (2017-09-20)

Full Changelog

  • No changes

Changes in 0.8.3-rc.1 (2017-09-19)

Full Changelog

  • consume trailing slash when creating Matrix Client in HS and IS urls #526
  • Add ignore users API #539
  • Upgrade to jsdoc 3.5.5 #540
  • Make re-emitting events much more memory efficient #538
  • Only re-emit events from Event objects if needed #536
  • Handle 'left' users in the deviceList mananagement #535
  • Factor out devicelist integration tests to a separate file #534
  • Refactor sync._sync as an async function #533
  • Add es6 to eslint environments #532

Changes in 0.8.2 (2017-08-24)

Full Changelog

  • Handle m.call.* events which are decrypted asynchronously #530
  • Re-emit events from, er, Event objects #529

Changes in 0.8.1 (2017-08-23)

Full Changelog

  • [No changes]

Changes in 0.8.1-rc.1 (2017-08-22)

Full Changelog

  • Fix error handling in interactive-auth #527
  • Make lots of OlmDevice asynchronous #524
  • Make crypto.decryptMessage return decryption results #523

Changes in 0.8.0 (2017-08-15)

Full Changelog

BREAKING CHANGE

In order to support a move to a more scalable storage backend, we need to make a number of the APIs related end-to-end encryption asynchronous.

This release of the JS-SDK includes the following changes which will affect applications which support end-to-end encryption:

  1. MatrixClient now provides a new (asynchronous) method, initCrypto. Applications which support end-to-end encryption must call this method (and wait for it to complete) before calling startClient, to give the crypto layer a chance to initialise.

  2. The following APIs have been changed to return promises:

    • MatrixClient.getStoredDevicesForUser
    • MatrixClient.getStoredDevice
    • MatrixClient.setDeviceVerified
    • MatrixClient.setDeviceBlocked
    • MatrixClient.setDeviceKnown
    • MatrixClient.getEventSenderDeviceInfo
    • MatrixClient.isEventSenderVerified
    • MatrixClient.importRoomKeys

    Applications using the results of any of the above methods will need to be updated to wait for the result of the promise.

  3. MatrixClient.listDeviceKeys has been removed altogether. It's been deprecated for some time. Applications using it should instead be changed to use MatrixClient.getStoredDevices, which is similar but returns its results in a slightly different format.

  • Make bits of olmlib asynchronous #521
  • Make some of DeviceList asynchronous #520
  • Make methods in crypto/algorithms async #519
  • Avoid sending unencrypted messages in e2e room #518
  • Make tests wait for syncs to happen #517
  • Make a load of methods in the 'Crypto' module asynchronous #510
  • Set rawDisplayName to userId if membership has displayname=null #515
  • Refactor handling of crypto events for async #508
  • Let event decryption be asynchronous #509
  • Transform async functions to bluebird promises #511
  • Add more group APIs #512
  • Retrying test: wait for localEchoUpdated event #507
  • Fix member events breaking on timeline reset, 2 #504
  • Make bits of the js-sdk api asynchronous #503
  • Yet more js-sdk test deflakification #499
  • Fix racy 'matrixclient retrying' test #497
  • Fix spamming of key-share-requests #495
  • Add progress handler to uploadContent #500
  • Switch matrix-js-sdk to bluebird #490
  • Fix some more flakey tests #492
  • make the npm test script windows-friendly #489
  • Fix a bunch of races in the tests #488
  • Fix early return in MatrixClient.setGuestAccess #487
  • Remove testUtils.failTest #486
  • Add test:watch script #485
  • Make it possible to use async/await #484
  • Remove m.new_device support #483
  • Use access-token in header #478
  • Sanity-check response from /thirdparty/protocols #482
  • Avoid parsing plain-text errors as JSON #479
  • Use external mock-request #481
  • Fix some races in the tests #480
  • Fall back to MemoryCryptoStore if indexeddb fails #475
  • Fix load failure in firefox when indexedDB is disabled #474
  • Fix a race in a test #471
  • Avoid throwing an unhandled error when the indexeddb is deleted #470
  • fix jsdoc #469
  • Handle m.forwarded_room_key events #468
  • Improve error reporting from indexeddbstore.clearDatabase #466
  • Implement sharing of megolm keys #454
  • Process received room key requests #449
  • Send m.room_key_request events when we fail to decrypt an event #448

Changes in 0.7.13 (2017-06-22)

Full Changelog

  • Fix failure on Tor browser #473
  • Fix issues with firefox private browsing #472

Changes in 0.7.12 (2017-06-19)

Full Changelog

  • No changes

Changes in 0.7.12-rc.1 (2017-06-15)

Full Changelog

  • allow setting iceTransportPolicy to relay through forceTURN option #462

Changes in 0.7.11 (2017-06-12)

Full Changelog

  • Add a bunch of logging around sending messages #460

Changes in 0.7.11-rc.1 (2017-06-09)

Full Changelog

  • Make TimelineWindow.load resolve quicker if we have the events #458
  • Stop peeking when a matrix client is stopped #451
  • Update README: Clarify how to install libolm #450

Changes in 0.7.10 (2017-06-02)

Full Changelog

  • BREAKING CHANGE: The SDK no longer requires olm - instead it expects libolm to be provided as an Olm global. This will only affect applications which use end-to-end encryption. See the README for details.

  • indexeddb-crypto-store: fix db deletion #447

  • Load Olm from the global rather than requiring it. #446

Changes in 0.7.9 (2017-06-01)

Full Changelog

  • Initial framework for indexeddb-backed crypto store #445
  • Factor out reEmit to a common module #444
  • crypto/algorithms/base.js: Convert to es6 #443
  • maySendRedactionForEvent for userId #435
  • MatrixClient: add getUserId() #441
  • Run jsdoc on a custom babeling of the source #442
  • Add in a public api getStoredDevice allowing clients to get a specific device #439

Changes in 0.7.8 (2017-05-22)

Full Changelog

  • No changes

Changes in 0.7.8-rc.1 (2017-05-19)

Full Changelog

  • Attempt to rework the release-tarball-signing stuff #438
  • ability to specify webrtc audio/video inputs for the lib to request #427
  • make screen sharing call FF friendly :D #434
  • Fix race in device list updates #431
  • WebRTC: Support recvonly for video for those without a webcam #424
  • Update istanbul to remove minimatch DoS Warning #422
  • webrtc/call: Make it much less likely that callIds collide locally #423
  • Automatically complete dummy auth #420
  • Don't leave the gh-pages branch checked out #418

Changes in 0.7.7 (2017-04-25)

Full Changelog

  • No changes

Changes in 0.7.7-rc.1 (2017-04-21)

Full Changelog

  • Automatically complete dummy auth #420

Changes in 0.7.6 (2017-04-12)

Full Changelog

  • No changes

Changes in 0.7.6-rc.2 (2017-04-10)

Full Changelog

  • Add feature detection for webworkers #416
  • Fix release script #415

Changes in 0.7.6-rc.1 (2017-04-07)

Full Changelog

  • Make indexeddb save after the first sync #414
  • Make indexeddb startup faster #413
  • Add ability to do indexeddb sync work in webworker #412
  • Move more functionality to the indexeddb backend #409
  • Indicate syncState ERROR after many failed /syncs #410
  • Further reorganising of indexeddb sync code #407
  • Change interface of IndexedDBStore: hide internals #406
  • Don't be SYNCING until updating from the server #405
  • Don't log the entire /sync response #403
  • webrtc/call: Assign MediaStream to video element srcObject #402
  • Fix undefined reference in http-api #400
  • Add copyright header to event-timeline.js #382
  • client: fix docs for user-scoped account_data events #397
  • Add a CONTRIBUTING for js-sdk #399
  • Fix leaking room state objects on limited sync responses #395
  • Extend 'ignoreFailure' to be 'background' #396
  • Add x_show_msisdn parameter to register calls #388
  • Update event redaction to keep sender and origin_server_ts #394
  • Handle 'limited' timeline responses in the SyncAccumulator #393
  • Give a better error message if the HS doesn't support msisdn registeration #391
  • Add getEmailSid #383
  • Add m.login.email.identity support to UI auth #380
  • src/client.js: Fix incorrect roomId reference in VoIP glare code #381
  • add .editorconfig #379
  • Store account data in the same way as room data #377
  • Upload one-time keys on /sync rather than a timer #376
  • Increase the WRITE_DELAY on database syncing #374
  • Make deleteAllData() return a Promise #373
  • Don't include banned users in the room name #372
  • Support IndexedDB as a backing store #363
  • Poll /sync with a short timeout while catching up #370
  • Make test coverage work again #368
  • Add docs to event #367
  • Keep the device-sync token more up-to-date #366
  • Fix race conditions in device list download #365
  • Fix the unban method #364
  • Spread out device verification work #362
  • Clean up/improve e2e logging #361
  • Fix decryption of events whose key arrives later #360
  • Invalidate device lists when encryption is enabled in a room #359
  • Switch from jasmine to mocha + expect + lolex #358
  • Install source-map-support in each test #356
  • searchMessageText: avoid setting keys=undefined #357
  • realtime-callbacks: pass global as this #355
  • Make the tests work without olm #354
  • Tests: Factor out TestClient and use it in crypto tests #353
  • Fix some lint #352
  • Make a sig for source tarballs when releasing #351
  • When doing a pre-release, don't bother merging to master and develop. #350

Changes in 0.7.5 (2017-02-04)

Full Changelog

No changes from 0.7.5-rc.3

Changes in 0.7.5-rc.3 (2017-02-03)

Full Changelog

  • Include DeviceInfo in deviceVerificationChanged events a3cc8eb
  • Fix device list update 5fd7410

Changes in 0.7.5-rc.2 (2017-02-03)

Full Changelog

  • Use the device change notifications interface #348
  • Rewrite the device key query logic #347

Changes in 0.7.5-rc.1 (2017-02-03)

Full Changelog

  • Support for blacklisting unverified devices, both per-room and globally #336
  • track errors when events can't be sent #349
  • Factor out device list management #346
  • Support for warning users when unknown devices show up #335
  • Enable sourcemaps in browserified distro #345
  • Record all e2e room settings in localstorage #344
  • Make Olm work with browserified js-sdk #340
  • Make browserify a dev dependency #339
  • Allow single line brace-style #338
  • Turn on comma-dangle for function calls #333
  • Add prefer-const #331
  • Support for importing and exporting megolm sessions #326
  • Fix linting on all tests #329
  • Fix ESLint warnings and errors #325
  • BREAKING CHANGE: Remove WebStorageStore #324

Changes in 0.7.4 (2017-01-16)

Full Changelog

  • Fix non-conference calling

Changes in 0.7.4-rc.1 (2017-01-13)

Full Changelog

  • Remove babel-polyfill #321
  • Update build process for ES6 #320
  • 'babel' is not a babel package anymore #319
  • Add Babel for ES6 support #318
  • Move screen sharing check/error #317
  • release.sh: Bail early if there are uncommitted changes #316

Changes in 0.7.3 (2017-01-04)

Full Changelog

  • User presence list feature #310
  • Allow clients the ability to set a default local timeout #313
  • Add API to delete threepid #312

Changes in 0.7.2 (2016-12-15)

Full Changelog

  • Bump to Olm 2.0 #309
  • Sanity check payload length before encrypting #307
  • Remove dead _sendPingToDevice function #308
  • Add setRoomDirectoryVisibilityAppService #306
  • Update release script to do signed releases #305
  • e2e: Wait for pending device lists #304
  • Start a new megolm session when devices are blacklisted #303
  • E2E: Download our own devicelist on startup #302

Changes in 0.7.1 (2016-12-09)

Full Changelog

No changes

Changes in 0.7.1-rc.1 (2016-12-05)

Full Changelog

  • Avoid NPE when no sessionStore is given #300
  • Improve decryption error messages #299
  • Revert "Use native Array.isArray when available." #283
  • Use native Array.isArray when available. #282

Changes in 0.7.0 (2016-11-18)

Full Changelog

  • Avoid a packetstorm of device queries on startup #297
  • E2E: Check devices to share keys with on each send #295
  • Apply unknown-keyshare mitigations #296
  • distinguish unknown users from deviceless users #294
  • Allow starting client with initialSyncLimit = 0 #293
  • Make timeline-window _unpaginate public and rename to unpaginate #289
  • Send a STOPPED sync updated after call to stopClient #286
  • Fix bug in verifying megolm event senders #292
  • Handle decryption of events after they arrive #288
  • Fix examples. #287
  • Add a travis.yml #278
  • Encrypt all events, including 'm.call.*' #277
  • Ignore reshares of known megolm sessions #276
  • Log to the console on unknown session #274
  • Make it easier for SDK users to wrap prevailing the 'request' function #273

Changes in 0.6.4 (2016-11-04)

Full Changelog

  • Change release script to pass version by environment variable

Changes in 0.6.4-rc.2 (2016-11-02)

Full Changelog

  • Add getRoomTags method to client #236

Changes in 0.6.4-rc.1 (2016-11-02)

Full Changelog

Breaking Changes

  • Bundled version of the JS SDK are no longer versioned along with source files in the dist/ directory. As of this release, they will be included in the release tarball, but not the source repository.

Other Changes

  • More fixes to the release script #272
  • Update the release process to use github releases #271
  • Don't package the world when we release #270
  • Add ability to set a filter prior to the first /sync #269
  • Sign one-time keys, and verify their signatures #243
  • Check for duplicate message indexes for group messages #241
  • Rotate megolm sessions #240
  • Check recipient and sender in Olm messages #239
  • Consistency checks for E2E device downloads #237
  • Support User-Interactive auth for delete device #235
  • Utility to help with interactive auth #234
  • Fix sync breaking when an invalid filterId is in localStorage #228

Changes in 0.6.3 (2016-10-12)

Full Changelog

Breaking Changes

  • Add a 'RECONNECTING' state to the sync states. This is an additional state between 'SYNCING' and 'ERROR', so most clients should not notice.

Other Changes

  • Fix params getting replaced on register calls #233
  • Fix potential 30s delay on reconnect #232
  • uploadContent: Attempt some consistency between browser and node #230
  • Fix error handling on uploadContent #229
  • Fix uploadContent for node.js #226
  • Don't emit ERROR until a keepalive poke fails #223
  • Function to get the fallback url for interactive auth #224
  • Revert "Handle the first /sync failure differently." #222

Changes in 0.6.2 (2016-10-05)

Full Changelog

  • Check dependencies aren't on develop in release.sh #221
  • Fix checkTurnServers leak on logout #220
  • Fix leak of file upload objects #219
  • crypto: remove duplicate code #218
  • Add API for 3rd party location lookup #217
  • Handle the first /sync failure differently. #216

Changes in 0.6.1 (2016-09-21)

Full Changelog

  • Fix the ed25519 key checking #215
  • Add MatrixClient.getEventSenderDeviceInfo() #214

Changes in 0.6.0 (2016-09-21)

Full Changelog

  • Pull user device list on join #212
  • Fix sending of oh_hais on bad sessions #213
  • Support /publicRooms pagination #211
  • Update the olm library version to 1.3.0 #205
  • Comment what the logic in uploadKeys does #209
  • Include keysProved and keysClaimed in the local echo for events we send. #210
  • Check if we need to upload new one-time keys every 10 minutes #208
  • Reset oneTimeKey to null on each loop iteration. #207
  • Add getKeysProved and getKeysClaimed methods to MatrixEvent. #206
  • Send a 'm.new_device' when we get a message for an unknown group session #204
  • Introduce EventTimelineSet, filtered timelines and global notif timeline. #196
  • Wrap the crypto event handlers in try/catch blocks #203
  • Show warnings on to-device decryption fail #202
  • s/Displayname/DisplayName/ #201
  • OH HAI #200
  • Share the current ratchet with new members #199
  • Move crypto bits into a subdirectory #198
  • Refactor event handling in Crypto #197
  • Don't create Olm sessions proactively #195
  • Use to-device events for key sharing #194
  • README: callbacks deprecated #193
  • Fix sender verification for megolm messages #192
  • Use ciphertext instead of body in megolm events #191
  • Add debug methods to get the state of OlmSessions #189
  • MatrixClient.getStoredDevicesForUser #190
  • Olm-related cleanups #188
  • Update to fixed olmlib #187
  • always play audio out of the remoteAudioElement if it exists. #186
  • Fix exceptions where HTMLMediaElement loads and plays race #185
  • Reset megolm session when people join/leave the room #183
  • Fix exceptions when dealing with redactions #184

Changes in 0.5.6 (2016-08-28)

Full Changelog

  • Put all of the megolm keys in one room message #182
  • Reinstate device blocking for simple Olm #181
  • support for unpacking megolm keys #180
  • Send out megolm keys when we start a megolm session #179
  • Change the result structure for ensureOlmSessionsForUsers #178
  • Factor out a function for doing olm encryption #177
  • Move DeviceInfo and DeviceVerification to separate module #175
  • Make encryption asynchronous #176
  • Added ability to set and get status_msg for presence. #167
  • Megolm: don't dereference nullable object #174
  • Implement megolm encryption/decryption #173
  • Update our push rules when they come down stream #170
  • Factor Olm encryption/decryption out to new classes #172
  • Make DeviceInfo more useful, and refactor crypto methods to use it #171
  • Move login and register methods into base-apis #169
  • Remove defaultDeviceDisplayName from MatrixClient options #168

Changes in 0.5.5 (2016-08-11)

Full Changelog

  • Add room.getAliases() and room.getCanonicalAlias

  • Add API calls /register/email/requestToken, /account/password/email/requestToken and /account/3pid/email/requestToken

  • Add User.currentlyActive and User.lastPresenceTs events for changes in fields on the User object

  • Add logout and deactivateAccount

  • Make sure we actually stop the sync loop on logout #166

  • Zero is a valid power level #164

  • Verify e2e keys on download #163

  • Factor crypto stuff out of MatrixClient #162

  • Refactor device key upload #161

  • Wrappers for devices API #158

  • Add deactivate account function #160

  • client.listDeviceKeys: Expose device display name #159

  • Add logout #157

  • Fix email registration #156

  • Factor out MatrixClient methods to MatrixBaseApis #155

  • Fix some broken tests #154

  • make jenkins fail the build if the tests fail #153

  • deviceId-related fixes #152

  • /login, /register: Add device_id and initial_device_display_name #151

  • Support global account_data #150

  • Add more events to User #149

  • Add API calls for other requestToken endpoints #148

  • Add register-specific request token endpoint #147

  • Set a valid SPDX license identifier in package.json #139

  • Configure encryption on m.room.encryption events #145

  • Implement device blocking #146

  • Clearer doc for setRoomDirectoryVisibility #144

  • crypto: use memberlist to derive recipient list #143

  • Support for marking devices as unverified #142

  • Add Olm as an optionalDependency #141

  • Add room.getAliases() and room.getCanonicalAlias() #140

  • Change how MatrixEvent manages encrypted events #138

  • Catch exceptions when encrypting events #137

  • Support for marking devices as verified #136

  • Various matrix-client refactorings and fixes #134

Changes in 0.5.4 (2016-06-02)

Full Changelog

Changes in 0.5.3 (2016-06-02)

Full Changelog

  • Add support for the openid interface #133
  • Bugfix for HTTP upload content when running on node #129
  • Ignore missing profile (displayname and avatar_url) fields on presence events, rather than overwriting existing valid profile data from membership events or elsewhere. Fixes element-hq/element-web#1039

Changes in 0.5.2 (2016-04-19)

Full Changelog

  • Track the absolute time that presence events are received, so that the relative lastActiveAgo value is meaningful. #128
  • Refactor the addition of events to rooms #127
  • Clean up test shutdown #126
  • Add methods to get (and set) pushers #125
  • URL previewing support #122
  • Avoid paginating forever in private rooms #124
  • Fix a bug where we recreated sync filters #123
  • Implement HTTP timeouts in realtime #121

Changes in 0.5.1 (2016-03-30)

Full Changelog

  • Only count joined members for the member count in notifications. #119
  • Add maySendEvent to match maySendStateEvent #118

Changes in 0.5.0 (2016-03-22)

Full Changelog

BREAKING CHANGES:

  • opts.pendingEventOrdering==end is no longer supported in the arguments to MatrixClient.startClient(). Instead we provide a detached option, which puts pending events into a completely separate list in the Room, accessible via Room.getPendingEvents(). #111

Other improvements:

  • Log the stack when we get a sync error #109
  • Refactor transmitted-messages code #110
  • Add a method to the js sdk to look up 3pids on the ID server. #113
  • Support for cancelling pending events #112
  • API to stop peeking #114
  • update store user metadata based on membership events rather than presence #116
  • Include a counter in generated transaction IDs #115
  • get/setRoomVisibility API #117

Changes in 0.4.2 (2016-03-17)

Full Changelog

  • Try again if a pagination request gives us no new messages #98
  • Add a delay before we start polling the connectivity check endpoint #99
  • Clean up a codepath that was only used for crypto messages #101
  • Add maySendStateEvent method, ported from react-sdk (but fixed). #94
  • Add Session.logged_out event #100
  • make presence work when peeking. #103
  • Add RoomState.mayClientSendStateEvent() #104
  • Fix displaynames for member join events #108

Changes in 0.4.1

Improvements:

  • Check that /sync filters are correct before reusing them, and recreate them if not (matrix-org#85).
  • Fire a Room.timelineReset event when a room's timeline is reset by a gappy /sync (matrix-org#87, matrix-org#93).
  • Make TimelineWindow.load() faster in the simple case of loading the live timeline (matrix-org#88).
  • Update room-name calculation code to use the name of the sender of the invite when invited to a room (matrix-org#89).
  • Don't reset the timeline when we join a room after peeking into it (matrix-org#91).
  • Fire Room.localEchoUpdated events as local echoes progress through their transmission process (matrix-org#95, matrix-org#97).
  • Avoid getting stuck in a pagination loop when the server sends us only messages we've already seen (matrix-org#96).

New methods:

  • Add MatrixClient.setPushRuleActions to set the actions for a push notification rule (matrix-org#90)
  • Add RoomState.maySendStateEvent which determines if a given user has permission to send a state event (matrix-org#94)

Changes in 0.4.0

BREAKING CHANGES:

  • RoomMember.getAvatarUrl() and MatrixClient.mxcUrlToHttp() now return the empty string when given anything other than an mxc:// URL. This ensures that clients never inadvertantly reference content directly, leaking information to third party servers. The allowDirectLinks option is provided if the client wants to allow such links.
  • Add a 'bindEmail' option to register()

Improvements:

  • Support third party invites
  • More appropriate naming for third party invite rooms
  • Poll the 'versions' endpoint to re-establish connectivity
  • Catch exceptions when syncing
  • Room tag support
  • Generate implicit read receipts
  • Support CAS login
  • Guest access support
  • Never return non-mxc URLs by default
  • Ability to cancel file uploads
  • Use the Matrix C/S API v2 with r0 prefix
  • Account data support
  • Support non-contiguous event timelines
  • Support new unread counts
  • Local echo for read-receipts

New methods:

  • Add method to fetch URLs not on the home or identity server
  • Method to get the last receipt for a user
  • Method to get all known users
  • Method to delete an alias

Changes in 0.3.0

  • MatrixClient.getAvatarUrlForMember has been removed and replaced with RoomMember.getAvatarUrl. Arguments remain the same except the homeserver URL must now be supplied from MatrixClient.getHomeserverUrl().

    // before
    var url = client.getAvatarUrlForMember(member, width, height, resize, allowDefault)
    // after
    var url = member.getAvatarUrl(client.getHomeserverUrl(), width, height, resize, allowDefault)
  • MatrixClient.getAvatarUrlForRoom has been removed and replaced with Room.getAvatarUrl. Arguments remain the same except the homeserver URL must now be supplied from MatrixClient.getHomeserverUrl().

    // before
    var url = client.getAvatarUrlForRoom(room, width, height, resize, allowDefault)
    // after
    var url = room.getAvatarUrl(client.getHomeserverUrl(), width, height, resize, allowDefault)
  • s/Room.getMembersWithMemership/Room.getMembersWithMembership/g

New methods:

  • Added support for sending receipts via MatrixClient.sendReceipt(event, receiptType, callback) and MatrixClient.sendReadReceipt(event, callback).
  • Added support for receiving receipts via Room.getReceiptsForEvent(event) and Room.getUsersReadUpTo(event). Receipts can be directly added to a Room using Room.addReceipt(event) though the MatrixClient does this for you.
  • Added support for muting local video and audio via the new methods MatrixCall.setMicrophoneMuted(), MatrixCall.isMicrophoneMuted(muted), MatrixCall.isLocalVideoMuted() and Matrix.setLocalVideoMuted(muted).
  • Added experimental support for screen-sharing in Chrome via MatrixCall.placeScreenSharingCall(remoteVideoElement, localVideoElement).
  • Added ability to perform server-side searches using MatrixClient.searchMessageText(opts) and MatrixClient.search(opts).

Improvements:

  • Improve the performance of initial sync processing from O(n^2) to O(n).
  • Room.name will now take into account m.room.canonical_alias events.
  • MatrixClient.startClient now takes an Object opts rather than a Number in a backwards-compatible way. This opts allows syncing configuration options to be specified including includeArchivedRooms and resolveInvitesToProfiles.
  • Room objects which represent room invitations will now have state populated from invite_room_state if it is included in the m.room.member event.
  • Room.getAvatarUrl will now take into account m.room.avatar events.

Changes in 0.2.2

Bug fixes:

  • Null pointer fixes for VoIP calling and push notification processing.
  • Set the Content-Type to application/octet-stream in the event that the file object has no type.

New methods:

  • Added MatrixClient.getCasServer() which calls through to the HTTP endpoint /login/cas.
  • Added MatrixClient.loginWithCas(ticket, service) which logs in with the type m.login.cas.
  • Added MatrixClient.getHomeserverUrl() which returns the URL passed in the constructor.
  • Added MatrixClient.getIdentityServerUrl() which returns the URL passed in the constructor.
  • Added getLastModifiedTime() to RoomMember, RoomState and User objects. This makes it easier to see if the object in question has changed, which can be used to improve performance by only rendering when these objects change.

Changes in 0.2.1

BREAKING CHANGES

  • MatrixClient.joinRoom has changed from (roomIdOrAlias, callback) to (roomIdOrAlias, opts, callback).

Bug fixes:

  • The Content-Type of file uploads is now explicitly set, without relying on the browser to do it for us.

Improvements:

  • The MatrixScheduler.RETRY_BACKOFF_RATELIMIT function will not retry when the response is a 400,401,403.
  • The text returned from a room invite now includes who the invite was from.
  • There is now a try/catch block around the request function which will reject/errback appropriately if an exception is thrown synchronously in it.

New methods:

  • MatrixClient.createAlias(alias, roomId)
  • MatrixClient.getRoomIdForAlias(alias)
  • MatrixClient.sendNotice(roomId, body, txnId, callback)
  • MatrixClient.sendHtmlNotice(roomId, body, htmlBody, callback)

Modified methods:

  • MatrixClient.joinRoom(roomIdOrAlias, opts) where opts can include a syncRoom: true|false flag to control whether a room initial sync is performed after joining the room.
  • MatrixClient.getAvatarUrlForMember has a new last arg allowDefault which returns the default identicon URL if true.
  • MatrixClient.getAvatarUrlForRoom has a new last arg allowDefault which is passed through to the default identicon generation for getAvatarUrlForMember.

Changes in 0.2.0

BREAKING CHANGES:

  • MatrixClient.setPowerLevel now expects a MatrixEvent and not an Object for the event parameter.

New features:

  • Added EventStatus.QUEUED which is set on an event when it is waiting to be sent by the scheduler and there are other events in front.
  • Added support for processing push rules on an event. This can be obtained by calling MatrixClient.getPushActionsForEvent(event).
  • Added WebRTC support. Outbound calls can be made via call = global.createNewMatrixCall(MatrixClient, roomId) followed by call.placeVoiceCall() or call.placeVideoCall(remoteEle, localEle). Inbound calls will be received via the event "Call.incoming" which provides a call object which can be followed with call.answer() or call.hangup().
  • Added the ability to upload files to the media repository.
  • Added the ability to change the client's password.
  • Added the ability to register with an email via an identity server.
  • Handle presence events by updating the associated User object.
  • Handle redaction events.
  • Added infrastructure for supporting End-to-End encryption. E2E is NOT available in this version.

New methods:

  • MatrixClient.getUser(userId)
  • MatrixClient.getPushActionsForEvent(event)
  • MatrixClient.setPassword(auth, newPassword)
  • MatrixClient.loginWithSAML2(relayState, callback)
  • MatrixClient.getAvatarUrlForMember(member, w, h, method)
  • MatrixClient.mxcUrlToHttp(url, w, h, method)
  • MatrixClient.getAvatarUrlForRoom(room, w, h, method)
  • MatrixClient.uploadContent(file, callback)
  • Room.getMembersWithMembership(membership)
  • MatrixScheduler.getQueueForEvent(event)
  • MatrixScheduler.removeEventFromQueue(event)
  • $DATA_STORE.setSyncToken(token)
  • $DATA_STORE.getSyncToken()

Crypto infrastructure (crypto is NOT available in this version):

  • global.CRYPTO_ENABLED
  • MatrixClient.isCryptoEnabled()
  • MatrixClient.uploadKeys(maxKeys)
  • MatrixClient.downloadKeys(userIds, forceDownload)
  • MatrixClient.listDeviceKeys(userId)
  • MatrixClient.setRoomEncryption(roomId, config)
  • MatrixClient.isRoomEncrypted(roomId)

New classes:

  • MatrixCall
  • WebStorageStore - WIP; unstable
  • WebStorageSessionStore - WIP; unstable

Bug fixes:

  • Member name bugfix: Fixed an issue which prevented RoomMember.name being disambiguated if there was exactly 1 other person with the same display name.
  • Member name bugfix: Disambiguate both clashing display names with user IDs in the event of a clash.
  • Room state bugfix: Fixed a bug which incorrectly overwrote power levels locally for a room.
  • Room name bugfix: Ignore users who have left the room when determining a room name.
  • Events bugfix: Fixed a bug which prevented the sender and target properties from being set.

Changes in 0.1.1

BREAKING CHANGES:

  • Room.calculateRoomName is now private. Use Room.recalculate instead, and access the calculated name via Room.name.
  • new MatrixClient(...) no longer creates a MatrixInMemoryStore if opts.store is not specified. Instead, the createClient global function creates it and passes it to the constructor. This change will not affect users who have always used createClient to create a MatrixClient.
  • "Room" events will now be emitted when the Room has finished being populated with state rather than at the moment of creation. This will fire when the SDK encounters a room it doesn't know about (just arrived from the event stream; e.g. a room invite) and will also fire after syncing room state (e.g. after calling joinRoom).
  • MatrixClient.joinRoom now returns a Room object when resolved, not an object with a room_id property.
  • MatrixClient.scrollback now expects a Room arg instead of a room_id and from token. Construct a new Room(roomId) if you want to continue using this directly, then set the pagination token using room.oldState.paginationToken = from. It now resolves to a Room object instead of the raw HTTP response.

New properties:

  • User.events
  • RoomMember.events

New methods:

  • Room.hasMembershipState(userId, membership)
  • MatrixClient.resendEvent(event, room)

New features:

  • Local echo. When you send an event using the SDK it will immediately be added to Room.timeline with the event.status of EventStatus.SENDING. When the event is finally sent, this status will be removed.
  • Not sent status. When an event fails to send using the SDK, it will have the event.status of EventStatus.NOT_SENT.
  • Retries. If events fail to send, they will be automatically retried.
  • Manual resending. Events which failed to send can be passed to MatrixClient.resendEvent(event, room) to resend them.
  • Queueing. Messages sent in quick succession will be queued to preserve the order in which they were submitted.
  • Room state is automatcally synchronised when joining a room (including if another device joins a room).
  • Scrollback. You can request earlier events in a room using MatrixClient.scrollback(room, limit, callback).

Bug fixes:

  • Fixed a bug which prevented the event stream from polling. Some devices will black hole requests when they hibernate, meaning that the callbacks will never fire. We now maintain a local timer to forcibly restart the request.