fix realtime reconnect

TorstenDittmann · TorstenDittmann · commit a505d070e430 · 2021-09-24T09:46:16.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.0.1
+- Fix realtime close and reconnect working only 1 out of two times due to future returning too early
+- Add dart doc comments to newly added response models
+
 ## 2.0.0
 - BREAKING All services and methods now return proper response objects instead of `Response` object
 
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  appwrite: ^2.0.0
+  appwrite: ^2.0.1
 ```
 
 You can install packages from the command line:
diff --git a/lib/appwrite.dart b/lib/appwrite.dart
@@ -8,7 +8,6 @@ import 'src/redirect_stub.dart'
     if (dart.library.html) 'src/redirect_browser.dart';
 import 'src/enums.dart';
 import 'src/client.dart';
-import 'src/response.dart';
 import 'src/service.dart';
 import 'models.dart' as models;
 
diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart
@@ -33,7 +33,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
         .replaceFirst('http://', 'ws://');
     _headers = {
       'content-type': 'application/json',
-      'x-sdk-version': 'appwrite:flutter:2.0.0',
+      'x-sdk-version': 'appwrite:flutter:2.0.1',
       'X-Appwrite-Response-Format' : '0.10.0',
     };
 
diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart
@@ -52,7 +52,7 @@ class ClientIO extends ClientBase with ClientMixin {
         .replaceFirst('http://', 'ws://');
     this._headers = {
       'content-type': 'application/json',
-      'x-sdk-version': 'appwrite:flutter:2.0.0',
+      'x-sdk-version': 'appwrite:flutter:2.0.1',
       'X-Appwrite-Response-Format' : '0.10.0',
     };
 
diff --git a/lib/src/models/continent.dart b/lib/src/models/continent.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Continent
 class Continent {
+    /// Continent name.
     final String name;
+    /// Continent two letter code.
     final String code;
 
     Continent({
diff --git a/lib/src/models/continent_list.dart b/lib/src/models/continent_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Continents List
 class ContinentList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of continents.
     final List<Continent> continents;
 
     ContinentList({
diff --git a/lib/src/models/country.dart b/lib/src/models/country.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Country
 class Country {
+    /// Country name.
     final String name;
+    /// Country two-character ISO 3166-1 alpha code.
     final String code;
 
     Country({
diff --git a/lib/src/models/country_list.dart b/lib/src/models/country_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Countries List
 class CountryList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of countries.
     final List<Country> countries;
 
     CountryList({
diff --git a/lib/src/models/currency.dart b/lib/src/models/currency.dart
@@ -1,12 +1,20 @@
 part of appwrite.models;
 
+/// Currency
 class Currency {
+    /// Currency symbol.
     final String symbol;
+    /// Currency name.
     final String name;
+    /// Currency native symbol.
     final String symbolNative;
+    /// Number of decimal digits.
     final int decimalDigits;
+    /// Currency digit rounding.
     final double rounding;
+    /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format.
     final String code;
+    /// Currency plural name
     final String namePlural;
 
     Currency({
diff --git a/lib/src/models/currency_list.dart b/lib/src/models/currency_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Currencies List
 class CurrencyList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of currencies.
     final List<Currency> currencies;
 
     CurrencyList({
diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart
@@ -1,8 +1,12 @@
 part of appwrite.models;
 
+/// Document
 class Document {
+    /// Document ID.
     final String $id;
+    /// Collection ID.
     final String $collection;
+    /// Document permissions.
     final Permissions $permissions;
     final Map<String, dynamic> data;
 
diff --git a/lib/src/models/document_list.dart b/lib/src/models/document_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Documents List
 class DocumentList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of documents.
     final List<Document> documents;
 
     DocumentList({
diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart
@@ -1,15 +1,26 @@
 part of appwrite.models;
 
+/// Execution
 class Execution {
+    /// Execution ID.
     final String $id;
+    /// Execution permissions.
     final Permissions $permissions;
+    /// Function ID.
     final String functionId;
+    /// The execution creation date in Unix timestamp.
     final int dateCreated;
+    /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
     final String trigger;
+    /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.
     final String status;
+    /// The script exit code.
     final int exitCode;
+    /// The script stdout output string. Logs the last 4,000 characters of the execution stdout output.
     final String stdout;
+    /// The script stderr output string. Logs the last 4,000 characters of the execution stderr output
     final String stderr;
+    /// The script execution time in seconds.
     final double time;
 
     Execution({
diff --git a/lib/src/models/execution_list.dart b/lib/src/models/execution_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Executions List
 class ExecutionList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of executions.
     final List<Execution> executions;
 
     ExecutionList({
diff --git a/lib/src/models/file.dart b/lib/src/models/file.dart
@@ -1,12 +1,20 @@
 part of appwrite.models;
 
+/// File
 class File {
+    /// File ID.
     final String $id;
+    /// File permissions.
     final Permissions $permissions;
+    /// File name.
     final String name;
+    /// File creation date in Unix timestamp.
     final int dateCreated;
+    /// File MD5 signature.
     final String signature;
+    /// File mime type.
     final String mimeType;
+    /// File original size in bytes.
     final int sizeOriginal;
 
     File({
diff --git a/lib/src/models/file_list.dart b/lib/src/models/file_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Files List
 class FileList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of files.
     final List<File> files;
 
     FileList({
diff --git a/lib/src/models/jwt.dart b/lib/src/models/jwt.dart
@@ -1,6 +1,8 @@
 part of appwrite.models;
 
+/// JWT
 class Jwt {
+    /// JWT encoded string.
     final String jwt;
 
     Jwt({
diff --git a/lib/src/models/language.dart b/lib/src/models/language.dart
@@ -1,8 +1,12 @@
 part of appwrite.models;
 
+/// Language
 class Language {
+    /// Language name.
     final String name;
+    /// Language two-character ISO 639-1 codes.
     final String code;
+    /// Language native name.
     final String nativeName;
 
     Language({
diff --git a/lib/src/models/language_list.dart b/lib/src/models/language_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Languages List
 class LanguageList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of languages.
     final List<Language> languages;
 
     LanguageList({
diff --git a/lib/src/models/locale.dart b/lib/src/models/locale.dart
@@ -1,12 +1,20 @@
 part of appwrite.models;
 
+/// Locale
 class Locale {
+    /// User IP address.
     final String ip;
+    /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format
     final String countryCode;
+    /// Country name. This field support localization.
     final String country;
+    /// Continent code. A two character continent code &quot;AF&quot; for Africa, &quot;AN&quot; for Antarctica, &quot;AS&quot; for Asia, &quot;EU&quot; for Europe, &quot;NA&quot; for North America, &quot;OC&quot; for Oceania, and &quot;SA&quot; for South America.
     final String continentCode;
+    /// Continent name. This field support localization.
     final String continent;
+    /// True if country is part of the Europian Union.
     final bool eu;
+    /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format
     final String currency;
 
     Locale({
diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart
@@ -1,22 +1,40 @@
 part of appwrite.models;
 
+/// Log
 class Log {
+    /// Event name.
     final String event;
+    /// IP session in use when the session was created.
     final String ip;
+    /// Log creation time in Unix timestamp.
     final int time;
+    /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
     final String osCode;
+    /// Operating system name.
     final String osName;
+    /// Operating system version.
     final String osVersion;
+    /// Client type.
     final String clientType;
+    /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
     final String clientCode;
+    /// Client name.
     final String clientName;
+    /// Client version.
     final String clientVersion;
+    /// Client engine name.
     final String clientEngine;
+    /// Client engine name.
     final String clientEngineVersion;
+    /// Device name.
     final String deviceName;
+    /// Device brand name.
     final String deviceBrand;
+    /// Device model name.
     final String deviceModel;
+    /// Country two-character ISO 3166-1 alpha code.
     final String countryCode;
+    /// Country name.
     final String countryName;
 
     Log({
diff --git a/lib/src/models/log_list.dart b/lib/src/models/log_list.dart
@@ -1,6 +1,8 @@
 part of appwrite.models;
 
+/// Logs List
 class LogList {
+    /// List of logs.
     final List<Log> logs;
 
     LogList({
diff --git a/lib/src/models/membership.dart b/lib/src/models/membership.dart
@@ -1,14 +1,24 @@
 part of appwrite.models;
 
+/// Membership
 class Membership {
+    /// Membership ID.
     final String $id;
+    /// User ID.
     final String userId;
+    /// Team ID.
     final String teamId;
+    /// User name.
     final String name;
+    /// User email address.
     final String email;
+    /// Date, the user has been invited to join the team in Unix timestamp.
     final int invited;
+    /// Date, the user has accepted the invitation to join the team in Unix timestamp.
     final int joined;
+    /// User confirmation status, true if the user has joined the team or false otherwise.
     final bool confirm;
+    /// User list of roles
     final List roles;
 
     Membership({
diff --git a/lib/src/models/membership_list.dart b/lib/src/models/membership_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Memberships List
 class MembershipList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of memberships.
     final List<Membership> memberships;
 
     MembershipList({
diff --git a/lib/src/models/permissions.dart b/lib/src/models/permissions.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Permissions
 class Permissions {
+    /// Read permissions.
     final List read;
+    /// Write permissions.
     final List write;
 
     Permissions({
diff --git a/lib/src/models/phone.dart b/lib/src/models/phone.dart
@@ -1,8 +1,12 @@
 part of appwrite.models;
 
+/// Phone
 class Phone {
+    /// Phone code.
     final String code;
+    /// Country two-character ISO 3166-1 alpha code.
     final String countryCode;
+    /// Country name.
     final String countryName;
 
     Phone({
diff --git a/lib/src/models/phone_list.dart b/lib/src/models/phone_list.dart
@@ -1,7 +1,10 @@
 part of appwrite.models;
 
+/// Phones List
 class PhoneList {
+    /// Total sum of items in the list.
     final int sum;
+    /// List of phones.
     final List<Phone> phones;
 
     PhoneList({
diff --git a/lib/src/models/preferences.dart b/lib/src/models/preferences.dart
@@ -1,5 +1,6 @@
 part of appwrite.models;
 
+/// Preferences
 class Preferences {
     final Map<String, dynamic> data;
 
diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart
diff --git a/lib/src/models/session_list.dart b/lib/src/models/session_list.dart
diff --git a/lib/src/models/team.dart b/lib/src/models/team.dart
diff --git a/lib/src/models/team_list.dart b/lib/src/models/team_list.dart
diff --git a/lib/src/models/token.dart b/lib/src/models/token.dart
diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart
diff --git a/lib/src/realtime_mixin.dart b/lib/src/realtime_mixin.dart
diff --git a/lib/src/realtime_subscription.dart b/lib/src/realtime_subscription.dart
diff --git a/pubspec.yaml b/pubspec.yaml
