diff --git a/CHANGELOG.md b/CHANGELOG.md index d2a18b25..3eec45c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,68 @@ +## [1.0.0] 10th June 2025 + +- feat: Migrate to vodozemac (Christian Kußowski) +- refactor: Make database non nullable (Christian Kußowski) +- refactor: (BREAKING) Make database required (Christian Kußowski) +- refactor: disable benchmarks by global boolean (#2104) (Krille-chan) +- refactor: Remove olm dependency (Christian Kußowski) + +### Breaking changes: + +#### DatabaseBuilder deprecated + +From now on the `Client` constructor expects an open database. `Client.database` is no longer nullable. + +**Before**: + +```dart +final client = Client( + 'Client Name', + databaseBuilder: (_) async { + final database = MatrixSdkDatabase( + '', + database: await databaseFactoryFfi.openDatabase(':memory:'), + sqfliteFactory: databaseFactoryFfi, + ); + await database.open(); + return database; + }, +); +``` + +**Now**: + +```dart +final client = Client( + '', + database: await MatrixSdkDatabase.init( + '', + database: await databaseFactoryFfi.openDatabase(':memory:'), + sqfliteFactory: databaseFactoryFfi, + ), +); +``` + +#### LibOlm deprecated in favor of Vodozemac + +LibOlm is no longer used. From now on you should use **Vodozemac**. +For Flutter you can use [flutter_vodozemac](https://pub.dev/packages/flutter_vodozemac). This +just needs to be initialized **once**: + +```dart +import 'package:flutter_vodozemac/flutter_vodozemac' as vod; + +// ... + +await vod.init(); + +final client = Client(/*...*/); +``` + +This should work on Android, iOS, macOS, Linux and Windows. + +For web you need to compile vodozemac to wasm. [Please refer to the Vodozemac bindings documentation](https://pub.dev/packages/vodozemac#build-for-web). + + ## [0.40.2] 5th June 2025 - fix: fallback on homeserver is userID null (The one with the braid) diff --git a/pubspec.yaml b/pubspec.yaml index 2c889a50..fe59a249 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: matrix description: Matrix Dart SDK -version: 0.40.2 +version: 1.0.0 homepage: https://famedly.com repository: https://github.com/famedly/matrix-dart-sdk.git issue_tracker: https://github.com/famedly/matrix-dart-sdk/issues