Initial commit version 0.8.13

CHANGELOG.md

@@ -0,0 +1,345 @@
+## [0.8.13] - 02nd Mar 2022
+- fix: send oldusername in displayname changed event
+- fix: Dont encrypt reactions
+- refactor: Make MatrixFile final and move all image calculation into isolate
+- fix: own profile containing mxid
+- chore: Update fluffybox
+
+## [0.8.12] - 02nd Mar 2022
+- fix: Rooms sort order after login
+- fix: Change password using email authentication
+
+## [0.8.11] - 19nd Feb 2022
+- fix: Change password using email authentication
+
+## [0.8.10] - 19nd Feb 2022
+- chore: Increase default thumbnail size to 800
+- fix: sortRooms should be triggered right before onSync is called
+- fix: UIA request stucks forever on unexpected matrixExceptions
+
+## [0.8.9] - 16nd Feb 2022
+- feat: Return homeserver summary on checkHomeserver
+- fix: hasNewMessage true when last event is sent
+- fix: Correctly end the call.
+
+## [0.8.8] - 15nd Feb 2022
+- fix: Has new messages compares ts
+- fix: handle dynamic content for pinned events
+
+## [0.8.7] - 14nd Feb 2022
+- fix: Show reactions as last events and refactor hasNewMessage
+
+## [0.8.6] - 14nd Feb 2022
+- feat: Add hasNewMessages flag to room
+- fix: Sort rooms after updating the UI on web
+
+## [0.8.5] - 14nd Feb 2022
+- fix: exception on removed widgets
+- fix: Fix black screen when end screensharing with system buttons.
+
+## [0.8.4] - 08nd Feb 2022
+- fix: Call onChange correctly on redacted aggregation events
+
+## [0.8.3] - 07nd Feb 2022
+- fix: Remove onHistoryReceived which was broken anyway
+- fix: Remove aggregation event doesnt trigger onChange
+
+## [0.8.2] - 04nd Feb 2022
+- fix: Add redaction events to timeline
+- fix: Resize image with compute by using const class arguments
+
+## [0.8.1] - 03nd Feb 2022
+- refactor: Implement on history received in timeline
+- fix: null-safety issues with widgets
+- fix: Trigger onChange for index on aggregation event update
+- feat: implement to get a room's widgets
+
+## [0.8.0] - 25nd Jan 2022
+- BREAKING CHANGE: high-level hadling of image sizes
+- feat: expose Timeline.onChange to Room.getTimeline
+- fix: Use where and map instead of a loop and a removeWhere
+- fix: Remove sorts that shouldnt be required.
+
+## [0.7.3] - 14nd Jan 2022
+- fix: Fix turn credentials format issue for safari.
+- fix: update fluffybox version to correctly clear rooms after logout. 
+- fix: Allow unpadded base64 decoding
+
+## [0.7.2] - 08nd Jan 2022
+- feat: Let sendDefaultMessage return false on encryption failure (Krille Fear)
+- fix: Room Member updates should always be cached (Krille Fear)
+- fix: Requested users are not stored (Christian Pauly)
+- fix: Localize reactions (Krille Fear)
+- refactor: Remove unnecessary type checks and imports (Krille Fear)
+
+## [0.7.1] - 08nd Dec 2021
+- fix: fallback in body for replies to replies (Nicolas Werner)
+- fix: ignore 4xx errors when re-sending the to_device queue The to_device queue was introduced to ensure integrity if e.g. the server temporarily failed when attempting to send a to_device message. If, for whatever reason, the server responds with a 4xx error, though, then we want to ignore that to_device message from the queue and move on, as that means that something different was fundamentally wrong. This helps to fix the to_device queue clogging up, making clients incapable of sending to_device events anymore, should such clogging happen. (Sorunome)
+- fix: Database corruptions by updating FluffyBox (Krille Fear)
+- fix: Store the call state, fix the invite cannot be sent. (cloudwebrtc)
+- fix: Allow consecutive edits for state events in-memory The lastEvent was incorrect when trying to process an edit of an edit. This fixes that by allowing consecutive edits for the last event. (Sorunome)
+- fix: Only save state events from sync processing in-memory if needed If we dump all state events from sync into memory then we needlessly clog up our memory, potentially running out of ram. This is useless as when opening the timeline we post-load the unimportant state events anyways. So, this PR makes sure that only the state events of post-loaded rooms and important state events land in-memory when processing a sync request. (Sorunome)
+- fix(ssss): Strip all whitespace characters from recovery keys upon decode Previously we stripped all spaces off of the recovery when decoding it, so that we could format the recovery key nicely. It turns out, however, that some element flavours also format with linebreaks, leading to the user having to manually remove them. We fix this by just stripping *all* whitespace off of the recovery key. (Sorunome)
+
+## [0.7.0] - 03nd Dec 2021
+- feat: Support for webRTC
+- fix: Add missing calcDisplayname global rules to client constructor
+
+## [0.7.0-nullsafety.10] - 26nd Nov 2021
+- feat: Migrate olm sessions on database migration
+- chore: Enable E2EE recovery by default
+
+## [0.7.0-nullsafety.9] - 25nd Nov 2021
+- fix: Limited timeline clean up on web
+- fix: Remove account avatar
+
+## [0.7.0-nullsafety.8] - 24nd Nov 2021
+- chore: Update FluffyBox
+
+## [0.7.0-nullsafety.7] - 23nd Nov 2021
+- feat: Add commands to create chats
+- feat: Add clear cache command
+- feat: Implement new FluffyBox database API implementation
+- fix: Workaround for a null exception for a non nullable boolean while user device key updating
+- fix: Limited timeline clears too many events
+- fix: Ability to remove avatar from room and account
+- fix: Request history in archived rooms
+- fix: Decrypt last event of a room
+- refactor: Remove Sembast database implementation
+
+## [0.7.0-nullsafety.6] - 16nd Nov 2021
+- feat: Implement sembast store
+- fix: HtmlToText crashes with an empty code block
+- fix: use originServerTs to check if state event is old
+- fix: Dont enable e2ee in new direct chats without encryption support
+- fix: Change eventstatus of edits in prevEvent
+- chore: Trim formatted username fallback
+
+## [0.7.0-nullsafety.5] - 10nd Nov 2021
+- fix: Edits as lastEvent do not update
+- fix: JSON parsing in decryptRoomEvent method
+- fix: Wrong null check in hive database
+- fix: crash on invalid displaynames
+- chore: Update matrix_api_lite
+
+## [0.7.0-nullsafety.4] - 09nd Nov 2021
+- feat: More advanced create chat methods (encryption is now enabled by default)
+- feat: Make waiting on init db optional
+- feat: Add more benchmarks for sync, timeline, init
+- feat: Add onInsert, onRemove and onUpdate cb to timeline
+- refactor: Move setreadmarker functionality to timeline
+
+## [0.7.0-nullsafety.3] - 05nd Nov 2021
+- fix: Null error in get own profile
+
+## [0.7.0-nullsafety.2] - 04nd Nov 2021
+- refactor: Make room in Event class not nullable
+- refactor: download method should not return null
+
+## [0.7.0-nullsafety.1] - 04nd Nov 2021
+Prerelease of the null safety version of the SDK.
+- feat: choose memberships returned by requestParticipants()
+- refactor: Make SDK null safe
+- fix: add room invite update to roomStateBox, so invites don't show empty room when app is restarted
+- fix: Do not upload keys after logout
+- fix: obay explicitly set ports in mxc URLs
+
+## [0.6.2] - 25nd Oct 2021
+- fix: Unnecessary null check
+- fix: Auto update room states
+
+## [0.6.1] - 18nd Oct 2021
+- fix: Missing null check in a nested json map
+
+## [0.6.0] - 15nd Oct 2021
+- feat: Calc benchmarks for hive operations on init
+- refactor: Change event status to enum
+- refactor: Migrate more files to null safety
+- fix: Type error when using CryptoKey in dart web
+- fix: events with unknown users having invalid mxids This caused issues down the line where the sender id was assumed to be a valid matrix identifier
+- fix: Sent events are sorted in SENDING timeline
+- fix: use explicit type in fold instead of cast
+- fix: apply review feedback
+- fix: missing range check When requesting history the `start` parameter could become larger than the loaded events from the database were, resulting in an error when attempting to request history.
+- fix: New verification requests on requesting history
+- refactor: remove unused clientId
+- fix: Add type checkings for User.displayName
+
+## [0.5.5] - 20nd Sep 2021
+ fix: Autodetect mime type on file upload
+
+## [0.5.4] - 20nd Sep 2021
+- feat: Add waitForFirstSync parameter to init method
+
+## [0.5.3] - 19nd Sep 2021
+- feat: Add /discardsession command
+- fix: Auto-reply key requests
+- fix: Room previews not showing replies
+- fix: missing content-type when changing avatar
+- fix: only/number emotes in a reply
+
+## [0.5.2] - 14nd Sep 2021
+- fix: Delete box if it can not be cleared when calling database.clear() -> This should fix some box corruption problems
+- fix: Do not set old events as state events -> This should fix the room list sort ordering bug
+
+## [0.5.1] - 13nd Sep 2021
+- fix: Room.notificationCount set to null sometimes
+
+## [0.5.0] - 13nd Sep 2021
+- hotfix: Key sharing security vulnerability! -> Please upgrade as soon as possible to this version
+- feat: MSC2746: Improved Signalling for 1:1 VoIP
+- fix: Get direct chat from user ID method crashes on more than one DM rooms with one account
+- fix: compilation against newer matrix_api_lite
+- refactor: Remove onRoomUpdate stream
+
+## [0.4.3] - 8nd Sep 2021
+- fix: Do not handle sending event updates which are already synced
+
+## [0.4.2] - 6nd Sep 2021
+- revert: Make bytes in EncryptedFile nullable
+
+## [0.4.1] - 6nd Sep 2021
+- fix: Make bytes in EncryptedFile nullable
+
+## [0.4.0] - 3nd Sep 2021
+- fix: Check if database got disposed in keyManager
+- fix: Implement dummy transactions for hive
+- fix: room account data key/type returned encoded
+- fix: Missing null check
+- fix: uiaRequests send broken auth object at first try
+- fix: Requesting history being funky
+- fix: Don't lag when sending messages in big rooms
+- feat: Do not load all timeline events from store at once
+- feat: Pin invited rooms
+- refactor: Replace all logic regarding sortOrder
+- refactor: Workarounds for missing mHeroes in rooms
+
+## [0.3.6] - 30nd Aug 2021
+- hotfix: uiaRequests send broken auth object at first try
+
+## [0.3.5] - 28nd Aug 2021
+- hotfix: Send unencrypted thumbnails
+
+## [0.3.4] - 28nd Aug 2021
+- fix: String.parseIdentifierIntoParts not working with unicode matrix.to links
+    Some clients do not uri-encode the identifier for matrix.to links, so we must
+    handle if we can't uri-decode them
+- fix: missing null check in hideEdit condition
+- fix: missing null check
+    It seems `device_keys` in the reply of `/keys/query` is not required. While synapse always
+    sent it, conduit did not, which resulted in an error.
+
+## [0.3.3] - 20nd Aug 2021
+- fix: room.lastEvent order now respects edits
+- feat: use m.new_content in lastEvent (so no more * fallback)
+
+## [0.3.2] - 20nd Aug 2021
+- feat: cache archived rooms to access them with `getRoomById`
+- fix: requestHistory() for archived rooms
+- refactor: Change name of archive getter to function
+
+## [0.3.1] - 20nd Aug 2021
+- hotfix: Opt-out null safety for crypto files because of an error in web
+
+## [0.3.0] - 20nd Aug 2021
+- remove: deprecated moor database (breaking change)
+- feat(events): add plain-text body representation from HTML
+- feat: get new_content in getLocalizedBody
+- feat: Add a way to get a verification request by its transaction id
+    A client might find the need to get the verification request object by
+    its transaction id, to be able to e.g. display for in-room verification
+    an "accept verification request" button easily.
+- fix: Correctly parse the reason of a spoiler
+    Previously only the first child node of a spoiler was considered to
+    determine if there should be a spoiler reason. This was, unfortunately,
+    incorrect, as soon as e.g. the reason had more than one space. This is
+    fixed by properly iterating all child nodes to search for the reason.
+- fix: Add space states to important events
+    We need the space state events in the important events to be able to
+    differentiate rooms and spaces in the room list.
+- feat: Allow specifying extraContent for Room.sendFileEvent, in case clients want to specify some custom stuff
+- fix: toDouble was called on null when you had a pinned room
+- fix: Typo in key backup requests
+    This may lead to messages not decrypting after interactive verification,
+    which would make the user manually press the request keys button.
+- refactor: rename LoginState.logged to loggedIn
+
+## [0.2.1] - 2nd Aug 2021
+
+- fix: accidental OTK uploads on fakeSync calls
+
+## [0.2.0] - 27th Jul 2021
+
+- Breaking API changes duo to use of code generated matrix API
+- fix: Missing null checks in syncUpdate handling
+
+## [0.1.11] - 26th Jul 2021
+
+- fix: Upload OTKs if the otk_count field is missing
+
+## [0.1.10] - 21th Jul 2021
+
+Please note: This removes the isolate code from the SDK to make it compatible with dart web. If
+you still want the SDK to execute code in the background to not block the UI on key generation
+for example, pass the `compute` method from Flutter to your client:
+
+```dart
+// ...
+final client = Client('name...',
+    // ...
+    compute: compute,
+);
+```
+
+## [0.1.9] - 20th Jul 2021
+
+- fix: Add missing null check which made bootstrap fail for newest Synapse release
+
+## [0.1.8] - 18th Jul 2021
+
+- fix: Provide a reasonable well-known fallback
+- fix: Add locking to sending encrypted to_device messages to prevent potential race conditions
+- fix: preserve homeserver port when creating thumbnail URIs
+- feat: Add support for nicer mentions
+- feat: Add general image pack handling as per MSC2545
+
+## [0.1.7] - 10 Jul 2021
+
+- change: Hive database schema (will trigger a database migration)
+- fix: Dont migrate database from version null
+- fix: Adjust emoji ranges to have less false positives
+- fix: Sending of the to_device key
+
+## [0.1.6] - 06 Jul 2021
+
+- feat: Make it possible to get the current loginState
+- fix: Broken nested accountData content maps
+- fix: Mark unsent events as failed
+- fix: Pin moor to 4.3.2 to fix the CI errors
+
+## [0.1.5] - 26 Jun 2021
+
+- fix: Don't run syncs while the client is being initialized
+
+## [0.1.4] - 19 Jun 2021
+
+- change: Replace onSyncError Stream with onSyncStatus
+
+## [0.1.3] - 19 Jun 2021
+
+- feat: Implement migration for hive schema versions
+
+## [0.1.2] - 19 Jun 2021
+
+- fix: Hive breaks if room IDs contain emojis (yes there are users with hacked synapses out there who needs this)
+- feat: Also migrate inbound group sessions
+
+## [0.1.1] - 18 Jun 2021
+
+- refactor: Move pedantic to dev_dependencies
+- chore: Update readme
+- fix: Migrate missing device keys
+
+## [0.1.0] - 17 Jun 2021
+
+First stable version

CONTRIBUTING.md

@@ -0,0 +1,104 @@
+# Contributing code to Famedly
+
+*See also: Code of Conduct*
+
+We look forward to you joining our team. Everyone is welcome to contribute code via pull requests or to file issues on Gitlab or help other peoples. We communicate primarily over Gitlab and on chat channels. You should be willing to license your contributions under the same license as the project itself.
+
+# How to contribute
+The only way to contribute changes to our project is to create a new branch or to fork it on Gitlab. Then create a merge request to ask us to merge your changes into the main branch of our repository. (https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html)
+
+**The main branch is our development branch where all the work happens.**
+
+## Merge request workflow in detail
+- Create a new branch or fork the main branch of the project (Please follow the guidlines below of naming branch and commits)
+- Make a merge request to merge your changes into the main branch
+- We use the Gitlab merge request workflow to review your contribution
+  - Only merge requests with a working CI can be merged
+  - Only merge requests with at least one code reviewer of the core team can be merged
+  - Only merge requests which are signed-off can be merged
+- Merge Requests may be refused if they don't follow the rules below.
+
+**Never ever just push something directly to the main branch!**
+
+## Naming guidelines & code style
+
+### Create a branch
+
+- Branches should get named by this pattern: `username/name-your-changes`.
+
+*That means for example: "alice/fix-this-bug".*
+
+- Use [Conventional Commits](https://www.conventionalcommits.org/)
+
+### File structure:
+- File names must be `snake_case`.
+- Directories need to be lowercase.
+
+### Code style:
+- We recommend using Android Studio or VS Code for coding
+- Follow the common Dart style in: https://dart.dev/guides/language/effective-dart/style
+- Format the code with `flutter format lib` - otherwise the CI will fail
+
+### Code quality
+- Don't repeat yourself! Use local variables, functions, classes.
+- Don't mix UI and business logic in the same environment.
+- Write tests for new classes, functions and widgets.
+- Keep it simple stupid: https://en.wikipedia.org/wiki/KISS_principle
+- Describe all of your classes, methods and attributes using **dartdoc** comments. Read this for more information: https://dart.dev/guides/language/effective-dart/documentation
+- Don't write functions to create new widgets. Write classes!
+- Don't insert unlocalized strings!
+- Use Dart extensions to extend class functionality instead of writing wrapper classes!
+- Don't mix functions which changes the state of something (functions with a return type of `void` or `Future<void>`) and functional programming which doesn't.
+
+## Sign off
+In order to have a concrete record that your contribution is intentional and you agree to license it under the same terms as the project's license, we've adopted the same lightweight approach that [the Linux Kernel](https://www.kernel.org/doc/Documentation/SubmittingPatches), [Docker](https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other projects use: the [**DCO - Developer Certificate of Origin**](http://developercertificate.org/). This is a simple declaration that you wrote the contribution or otherwise have the right to contribute it to Matrix:
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+If you agree to this for your contribution, then all that's needed is to include the line in your commit or merge request comment:
+
+`Signed-off-by: Your Name <your@email.example.org>`
+
+We accept contributions under a legally identifiable name, such as your name on government documentation or common-law names (names claimed by legitimate usage or repute). Unfortunately, we cannot accept anonymous contributions at this time.
+
+Git allows you to add this signoff automatically when using the `-s` flag to `git commit`, which uses the name and email set in your `user.name` and `user.email` git configs.
+
+If you forgot to sign off your commits before making your pull request and are on Git 2.17+ you can mass signoff using rebase:
+
+`git rebase --signoff origin/main`

LICENSE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    famedlySDK
+    Copyright (C) 2019  famedly
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.

README.md

@@ -0,0 +1,74 @@
+# Matrix SDK
+
+Matrix (matrix.org) SDK written in dart.
+
+## Native libraries
+
+For E2EE, libolm must be provided.
+
+Additionally, OpenSSL (libcrypto) must be provided on native platforms for E2EE.
+
+For flutter apps you can easily import it with the [flutter_olm](https://pub.dev/packages/flutter_olm) and the [flutter_openssl_crypto](https://pub.dev/packages/flutter_openssl_crypto) packages.
+
+## How to use this
+
+1. Import the sdk
+
+```yaml
+  matrix: <latest-version>
+  # Optional:
+  flutter_olm: <latest-version>
+  flutter_openssl_crypto: <latest-version>
+```
+
+```dart
+import 'package:matrix/matrix.dart';
+```
+
+2. Create a new client:
+
+```dart
+final client = Client("HappyChat");
+```
+
+The SDK works better with a database. Otherwise it has no persistence. For this you need to provide a databaseBuilder like this:
+
+```dart
+final client = Client(
+  "HappyChat",
+  databaseBuilder: (Client client) async {
+    await Hive.init('/path/to/your/storage');
+    final db = FamedlySdkHiveDatabase(client.clientName);
+    await db.open();
+    return db;
+  },
+);
+```
+
+3. Connect to a Matrix Homeserver and listen to the streams:
+
+```dart
+client.onLoginStateChanged.stream.listen((bool loginState){ 
+  print("LoginState: ${loginState.toString()}");
+});
+
+client.onEvent.stream.listen((EventUpdate eventUpdate){ 
+  print("New event update!");
+});
+
+client.onRoomUpdate.stream.listen((RoomUpdate eventUpdate){ 
+  print("New room update!");
+});
+
+await client.checkHomeserver("https://yourhomeserver.abc");
+await client.login(
+  identifier: AuthenticationUserIdentifier(user: 'alice'),
+  password: '123456',
+);
+```
+
+4. Send a message to a Room:
+
+```dart
+await client.getRoomById('your_room_id').sendTextEvent('Hello world');
+```

analysis_options.yaml

@@ -0,0 +1,50 @@
+include: package:pedantic/analysis_options.yaml
+
+linter:
+  rules:
+    - camel_case_types
+    - avoid_print
+    - constant_identifier_names
+    - prefer_final_locals
+    - prefer_final_in_for_each
+
+analyzer:
+  errors:
+    todo: ignore
+  exclude:
+    - example/main.dart
+    # needed until crypto packages upgrade
+    - lib/src/database/database.g.dart
+  plugins:
+    # Show code metrics in IDE
+    # - dart_code_metrics
+
+dart_code_metrics:
+  metrics:
+    cyclomatic-complexity: 20
+    number-of-arguments: 4
+    maximum-nesting-level: 5
+    source-lines-of-code: 50
+    # This is still unstable, so handle with care
+    maintainability-index: 40
+  metrics-exclude:
+    - test/**
+  rules:
+    #- newline-before-return
+    - no-boolean-literal-compare
+    - no-empty-block
+    #- prefer-trailing-comma
+    - prefer-conditional-expressions
+    - no-equal-arguments
+    - no-equal-then-else
+    - no-magic-number:
+        severity: style # too noisy otherwise atm
+    - avoid-late-keyword:
+        severity: style # too noisy otherwise atm
+    - avoid-non-null-assertion:
+        severity: style # too noisy otherwise atm
+    - avoid-unused-parameters
+    - binary-expression-operand-order
+  anti-patterns:
+    - long-method
+    - long-parameter-list

build.yaml

@@ -0,0 +1,6 @@
+targets:
+  $default:
+    builders:
+      moor_generator:
+        options:
+          generate_connect_constructor: true

example/main.dart

@@ -0,0 +1,377 @@
+import 'package:flutter/material.dart';
+import 'package:matrix/matrix.dart';
+import 'package:path_provider/path_provider.dart';
+import 'package:provider/provider.dart';
+
+void main() async {
+  WidgetsFlutterBinding.ensureInitialized();
+
+  final client = Client(
+    'Matrix Example Chat',
+    databaseBuilder: (_) async {
+      final dir = await getApplicationSupportDirectory();
+      final db = FluffyBoxDatabase('matrix_example_chat', dir.path);
+      await db.open();
+      return db;
+    },
+  );
+  await client.init();
+  runApp(MatrixExampleChat(client: client));
+}
+
+class MatrixExampleChat extends StatelessWidget {
+  final Client client;
+  const MatrixExampleChat({required this.client, Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: 'Matrix Example Chat',
+      builder: (context, child) => Provider<Client>(
+        create: (context) => client,
+        child: child,
+      ),
+      home: client.isLogged() ? const RoomListPage() : const LoginPage(),
+    );
+  }
+}
+
+class LoginPage extends StatefulWidget {
+  const LoginPage({Key? key}) : super(key: key);
+
+  @override
+  _LoginPageState createState() => _LoginPageState();
+}
+
+class _LoginPageState extends State<LoginPage> {
+  final TextEditingController _homeserverTextField = TextEditingController(
+    text: 'matrix.org',
+  );
+  final TextEditingController _usernameTextField = TextEditingController();
+  final TextEditingController _passwordTextField = TextEditingController();
+
+  bool _loading = false;
+
+  void _login() async {
+    setState(() {
+      _loading = true;
+    });
+
+    try {
+      final client = Provider.of<Client>(context, listen: false);
+      await client
+          .checkHomeserver(Uri.https(_homeserverTextField.text.trim(), ''));
+      await client.login(
+        LoginType.mLoginPassword,
+        password: _passwordTextField.text,
+        identifier: AuthenticationUserIdentifier(user: _usernameTextField.text),
+      );
+      Navigator.of(context).pushAndRemoveUntil(
+        MaterialPageRoute(builder: (_) => const RoomListPage()),
+        (route) => false,
+      );
+    } catch (e) {
+      ScaffoldMessenger.of(context).showSnackBar(
+        SnackBar(
+          content: Text(e.toString()),
+        ),
+      );
+      setState(() {
+        _loading = false;
+      });
+    }
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(title: const Text('Login')),
+      body: Padding(
+        padding: const EdgeInsets.all(16.0),
+        child: Column(
+          children: [
+            TextField(
+              controller: _homeserverTextField,
+              readOnly: _loading,
+              autocorrect: false,
+              decoration: const InputDecoration(
+                prefixText: 'https://',
+                border: OutlineInputBorder(),
+                labelText: 'Homeserver',
+              ),
+            ),
+            const SizedBox(height: 16),
+            TextField(
+              controller: _usernameTextField,
+              readOnly: _loading,
+              autocorrect: false,
+              decoration: const InputDecoration(
+                border: OutlineInputBorder(),
+                labelText: 'Username',
+              ),
+            ),
+            const SizedBox(height: 16),
+            TextField(
+              controller: _passwordTextField,
+              readOnly: _loading,
+              autocorrect: false,
+              obscureText: true,
+              decoration: const InputDecoration(
+                border: OutlineInputBorder(),
+                labelText: 'Password',
+              ),
+            ),
+            const SizedBox(height: 16),
+            SizedBox(
+              width: double.infinity,
+              child: ElevatedButton(
+                onPressed: _loading ? null : _login,
+                child: _loading
+                    ? const LinearProgressIndicator()
+                    : const Text('Login'),
+              ),
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+}
+
+class RoomListPage extends StatefulWidget {
+  const RoomListPage({Key? key}) : super(key: key);
+
+  @override
+  _RoomListPageState createState() => _RoomListPageState();
+}
+
+class _RoomListPageState extends State<RoomListPage> {
+  void _logout() async {
+    final client = Provider.of<Client>(context, listen: false);
+    await client.logout();
+    Navigator.of(context).pushAndRemoveUntil(
+      MaterialPageRoute(builder: (_) => const LoginPage()),
+      (route) => false,
+    );
+  }
+
+  void _join(Room room) async {
+    if (room.membership != Membership.join) {
+      await room.join();
+    }
+    Navigator.of(context).push(
+      MaterialPageRoute(
+        builder: (_) => RoomPage(room: room),
+      ),
+    );
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    final client = Provider.of<Client>(context, listen: false);
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text('Chats'),
+        actions: [
+          IconButton(
+            icon: const Icon(Icons.logout),
+            onPressed: _logout,
+          ),
+        ],
+      ),
+      body: StreamBuilder(
+        stream: client.onSync.stream,
+        builder: (context, _) => ListView.builder(
+          itemCount: client.rooms.length,
+          itemBuilder: (context, i) => ListTile(
+            leading: CircleAvatar(
+              foregroundImage: client.rooms[i].avatar == null
+                  ? null
+                  : NetworkImage(client.rooms[i].avatar!
+                      .getThumbnail(
+                        client,
+                        width: 56,
+                        height: 56,
+                      )
+                      .toString()),
+            ),
+            title: Row(
+              children: [
+                Expanded(child: Text(client.rooms[i].displayname)),
+                if (client.rooms[i].notificationCount > 0)
+                  Material(
+                      borderRadius: BorderRadius.circular(99),
+                      color: Colors.red,
+                      child: Padding(
+                        padding: const EdgeInsets.all(2.0),
+                        child:
+                            Text(client.rooms[i].notificationCount.toString()),
+                      ))
+              ],
+            ),
+            subtitle: Text(
+              client.rooms[i].lastEvent?.body ?? 'No messages',
+              maxLines: 1,
+            ),
+            onTap: () => _join(client.rooms[i]),
+          ),
+        ),
+      ),
+    );
+  }
+}
+
+class RoomPage extends StatefulWidget {
+  final Room room;
+  const RoomPage({required this.room, Key? key}) : super(key: key);
+
+  @override
+  _RoomPageState createState() => _RoomPageState();
+}
+
+class _RoomPageState extends State<RoomPage> {
+  late final Future<Timeline> _timelineFuture;
+  final GlobalKey<AnimatedListState> _listKey = GlobalKey<AnimatedListState>();
+  int _count = 0;
+
+  @override
+  void initState() {
+    _timelineFuture = widget.room.getTimeline(onChange: (i) {
+      print('on change! $i');
+      _listKey.currentState?.setState(() {});
+    }, onInsert: (i) {
+      print('on insert! $i');
+      _listKey.currentState?.insertItem(i);
+      _count++;
+    }, onRemove: (i) {
+      print('On remove $i');
+      _count--;
+      _listKey.currentState?.removeItem(i, (_, __) => const ListTile());
+    }, onHistoryReceived: (count) {
+      print('On History Received $count');
+      for (var i = 0; i < count; i++) {
+        _listKey.currentState?.insertItem(_count + i);
+      }
+      _count += count;
+    });
+    super.initState();
+  }
+
+  final TextEditingController _sendController = TextEditingController();
+
+  void _send() {
+    widget.room.sendTextEvent(_sendController.text.trim());
+    _sendController.clear();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: Text(widget.room.displayname),
+      ),
+      body: SafeArea(
+        child: Column(
+          children: [
+            Expanded(
+              child: FutureBuilder<Timeline>(
+                future: _timelineFuture,
+                builder: (context, snapshot) {
+                  final timeline = snapshot.data;
+                  if (timeline == null) {
+                    return const Center(
+                      child: CircularProgressIndicator.adaptive(),
+                    );
+                  }
+                  _count = timeline.events.length;
+                  return Column(
+                    children: [
+                      Center(
+                        child: TextButton(
+                            onPressed: timeline.requestHistory,
+                            child: const Text('Load more...')),
+                      ),
+                      const Divider(height: 1),
+                      Expanded(
+                        child: AnimatedList(
+                          key: _listKey,
+                          reverse: true,