Null-safety support

Author: eldadfux

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.0-dev.1
+
+- Upgraded to Null-safety, minimum Dart SDK required 2.12.0
+- Upgraded all underlying dependencies to null safe version
+
 ## 0.3.1
 
 - Minor fixes for custom exceptions

README.md

@@ -1,13 +1,14 @@
 # Appwrite Dart SDK
 
-[![pub package](https://img.shields.io/pub/v/dart_appwrite.svg)](https://pub.dartlang.org/packages/dart_appwrite)
-![License](https://img.shields.io/github/license/appwrite/sdk-for-dart.svg?v=1)
-![Version](https://img.shields.io/badge/api%20version-0.7.0-blue.svg?v=1)
+[![pub package](https://img.shields.io/pub/v/dart_appwrite.svg?style=flat-square)](https://pub.dartlang.org/packages/dart_appwrite)
+![License](https://img.shields.io/github/license/appwrite/sdk-for-dart.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.7.0-blue.svg?style=flat-square)
+[![Twitter Account](https://img.shields.io/twitter/follow/appwrite_io?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite_io)
+[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 0.7.0. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-dart/releases).**
+**This SDK is compatible with Appwrite server version 0.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-dart/releases).**
 
- > This is the Dart SDK for integrating with Appwrite from your Dart server-side code.
-                            If you're looking for the Flutter SDK you should check [appwrite/sdk-for-flutter](https://github.com/appwrite/sdk-for-flutter)
+ > This is the Dart SDK for integrating with Appwrite from your Dart server-side code. If you're looking for the Flutter SDK you should check [appwrite/sdk-for-flutter](https://github.com/appwrite/sdk-for-flutter)
 
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way.
                         Use the Dart SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
@@ -23,7 +24,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  dart_appwrite: ^0.4.0
+  dart_appwrite: ^0.5.0-dev.1
 ```
 
 You can install packages from the command line:
@@ -33,6 +34,39 @@ pub get dart_appwrite
 ```
 
 
+## Getting Started
+
+### Initialize & Make API Request
+Once you add the dependencies, its extremely easy to get started with the SDK; All you need to do is import the package in your code, set your Appwrite credentials, and start making API calls. Below is a simple example:
+
+```dart
+import 'package:dart_appwrite/dart_appwrite.dart';
+
+void main() async {
+  Client client = Client();
+    .setEndpoint('http://[HOSTNAME_OR_IP]/v1') // Make sure your endpoint is accessible
+    .setProject('5ff3379a01d25') // Your project ID
+    .setKey('cd868c7af8bdc893b4...93b7535db89')
+
+  Users users = Users(client);
+
+  try {
+    final response = await users.create(email: ‘[email protected]’,password: ‘password’, name: ‘name’);
+    print(response.data);
+  } on AppwriteException catch(e) {
+    print(e.message);
+  }
+}
+```
+
+### Learn more
+You can use followng resources to learn more and get help
+- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
+- 📜 [Appwrite Docs](https://appwrite.io/docs)
+- 💬 [Discord Community](https://appwrite.io/discord)
+- 🚂 [Appwrite Dart Playground](https://github.com/appwrite/playground-for-dart)
+
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.

lib/client.dart

@@ -3,22 +3,23 @@ part of dart_appwrite;
 class Client {
     String endPoint;
     String type = 'unknown';
-    Map<String, String> headers;
-    Map<String, String> config;
+    Map<String, String>? headers;
+    late Map<String, String> config;
     bool selfSigned;
     bool initialized = false;
     Dio http;
 
-    Client({this.endPoint = 'https://appwrite.io/v1', this.selfSigned = false, Dio http}) : this.http = http ?? Dio() {
+    Client({this.endPoint = 'https://appwrite.io/v1', this.selfSigned = false, Dio? http}) : this.http = http ?? Dio() {
 
         this.headers = {
             'content-type': 'application/json',
-            'x-sdk-version': 'appwrite:dart:0.4.0',
+            'x-sdk-version': 'appwrite:dart:0.5.0-dev.1',
         };
 
         this.config = {};
 
         assert(endPoint.startsWith(RegExp("http://|https://")), "endPoint $endPoint must start with 'http'");
+        init();
     }
 
 
@@ -54,19 +55,17 @@ class Client {
     }
 
     Client addHeader(String key, String value) {
-        headers[key] = value;
+        headers![key] = value;
 
         return this;
     }
 
-    Future init() async {
-        if(!initialized) {
+    void init() {
           this.http.options.baseUrl = this.endPoint;
-          this.http.options.validateStatus = (status) => status < 400;
-        }
+          this.http.options.validateStatus = (status) => status! < 400;
     }
 
-    Future<Response> call(HttpMethod method, {String path = '', Map<String, String> headers = const {}, Map<String, dynamic> params = const {}, ResponseType responseType}) async {
+    Future<Response> call(HttpMethod method, {String path = '', Map<String, String> headers = const {}, Map<String, dynamic> params = const {}, ResponseType? responseType}) async {
         if(selfSigned) {
             // Allow self signed requests
             (http.httpClientAdapter as DefaultHttpClientAdapter).onHttpClientCreate = (HttpClient client) {
@@ -75,18 +74,17 @@ class Client {
             };
         }
 
-        await this.init();
-
         // Origin is hardcoded for testing
         Options options = Options(
-            headers: {...this.headers, ...headers},
+            headers: {...this.headers!, ...headers},
             method: method.name(),
-            responseType: responseType
+            responseType: responseType,
+            listFormat: ListFormat.multiCompatible,
         );
         try {
 
             if(headers['content-type'] == 'multipart/form-data') {
-                return await http.request(path, data: FormData.fromMap(params), options: options);
+                return await http.request(path, data: FormData.fromMap(params,ListFormat.multiCompatible), options: options);
             }
 
             if (method == HttpMethod.get) {
@@ -103,16 +101,16 @@ class Client {
             throw AppwriteException(e.message);
           }
           if(responseType == ResponseType.bytes) {
-            if(e.response.headers['content-type'].contains('application/json')) {
-              final res = json.decode(utf8.decode(e.response.data));
-              throw AppwriteException(res['message'],res['code'], e.response);
+            if(e.response!.headers['content-type']?.contains('application/json') ?? false) {
+              final res = json.decode(utf8.decode(e.response!.data));
+              throw AppwriteException(res['message'],res['code'], res);
             } else {
               throw AppwriteException(e.message);
             }
           }
-          throw AppwriteException(e.response.data['message'],e.response.data['code'], e.response.data);
+          throw AppwriteException(e.response?.data['message'],e.response?.data['code'], e.response?.data);
         } catch(e) {
-          throw AppwriteException(e.message);
+          throw AppwriteException(e.toString());
         }
     }
 }

lib/exception.dart

@@ -1,8 +1,8 @@
 part of dart_appwrite;
 
 class AppwriteException implements Exception {
-  final String message;
-  final int code;
+  final String? message;
+  final int? code;
   final dynamic response;
 
   AppwriteException([this.message = "", this.code, this.response]);

lib/services/avatars.dart

@@ -11,7 +11,7 @@ class Avatars extends Service {
      /// /account/sessions endpoint. Use width, height and quality arguments to
      /// change the output settings.
      ///
-    Future<Response> getBrowser({@required String code, int width = 100, int height = 100, int quality = 100}) {
+    Future<Response> getBrowser({required String code, int width = 100, int height = 100, int quality = 100}) {
         final String path = '/avatars/browsers/{code}'.replaceAll(RegExp('{code}'), code);
 
         final Map<String, dynamic> params = {
@@ -35,7 +35,7 @@ class Avatars extends Service {
      /// provider you need. Use width, height and quality arguments to change the
      /// output settings.
      ///
-    Future<Response> getCreditCard({@required String code, int width = 100, int height = 100, int quality = 100}) {
+    Future<Response> getCreditCard({required String code, int width = 100, int height = 100, int quality = 100}) {
         final String path = '/avatars/credit-cards/{code}'.replaceAll(RegExp('{code}'), code);
 
         final Map<String, dynamic> params = {
@@ -59,7 +59,7 @@ class Avatars extends Service {
      /// website URL.
      /// 
      ///
-    Future<Response> getFavicon({@required String url}) {
+    Future<Response> getFavicon({required String url}) {
         final String path = '/avatars/favicon';
 
         final Map<String, dynamic> params = {
@@ -81,7 +81,7 @@ class Avatars extends Service {
      /// users. The code argument receives the 2 letter country code. Use width,
      /// height and quality arguments to change the output settings.
      ///
-    Future<Response> getFlag({@required String code, int width = 100, int height = 100, int quality = 100}) {
+    Future<Response> getFlag({required String code, int width = 100, int height = 100, int quality = 100}) {
         final String path = '/avatars/flags/{code}'.replaceAll(RegExp('{code}'), code);
 
         final Map<String, dynamic> params = {
@@ -106,7 +106,7 @@ class Avatars extends Service {
      /// remote images in your app or in case you want to make sure a 3rd party
      /// image is properly served using a TLS protocol.
      ///
-    Future<Response> getImage({@required String url, int width = 400, int height = 400}) {
+    Future<Response> getImage({required String url, int width = 400, int height = 400}) {
         final String path = '/avatars/image';
 
         final Map<String, dynamic> params = {
@@ -162,7 +162,7 @@ class Avatars extends Service {
      /// Converts a given plain text to a QR code image. You can use the query
      /// parameters to change the size and style of the resulting image.
      ///
-    Future<Response> getQR({@required String text, int size = 400, int margin = 1, bool download = false}) {
+    Future<Response> getQR({required String text, int size = 400, int margin = 1, bool download = false}) {
         final String path = '/avatars/qr';
 
         final Map<String, dynamic> params = {

lib/services/database.dart

@@ -32,7 +32,7 @@ class Database extends Service {
      ///
      /// Create a new Collection.
      ///
-    Future<Response> createCollection({@required String name, @required List read, @required List write, @required List rules}) {
+    Future<Response> createCollection({required String name, required List read, required List write, required List rules}) {
         final String path = '/database/collections';
 
         final Map<String, dynamic> params = {
@@ -54,7 +54,7 @@ class Database extends Service {
      /// Get a collection by its unique ID. This endpoint response returns a JSON
      /// object with the collection metadata.
      ///
-    Future<Response> getCollection({@required String collectionId}) {
+    Future<Response> getCollection({required String collectionId}) {
         final String path = '/database/collections/{collectionId}'.replaceAll(RegExp('{collectionId}'), collectionId);
 
         final Map<String, dynamic> params = {
@@ -71,7 +71,7 @@ class Database extends Service {
      ///
      /// Update a collection by its unique ID.
      ///
-    Future<Response> updateCollection({@required String collectionId, @required String name, @required List read, @required List write, List rules = const []}) {
+    Future<Response> updateCollection({required String collectionId, required String name, required List read, required List write, List rules = const []}) {
         final String path = '/database/collections/{collectionId}'.replaceAll(RegExp('{collectionId}'), collectionId);
 
         final Map<String, dynamic> params = {
@@ -93,7 +93,7 @@ class Database extends Service {
      /// Delete a collection by its unique ID. Only users with write permissions
      /// have access to delete this resource.
      ///
-    Future<Response> deleteCollection({@required String collectionId}) {
+    Future<Response> deleteCollection({required String collectionId}) {
         final String path = '/database/collections/{collectionId}'.replaceAll(RegExp('{collectionId}'), collectionId);
 
         final Map<String, dynamic> params = {
@@ -113,7 +113,7 @@ class Database extends Service {
      /// of the project's documents. [Learn more about different API
      /// modes](/docs/admin).
      ///
-    Future<Response> listDocuments({@required String collectionId, List filters = const [], int limit = 25, int offset = 0, String orderField = '', OrderType orderType = OrderType.asc, String orderCast = 'string', String search = ''}) {
+    Future<Response> listDocuments({required String collectionId, List filters = const [], int limit = 25, int offset = 0, String orderField = '', OrderType orderType = OrderType.asc, String orderCast = 'string', String search = ''}) {
         final String path = '/database/collections/{collectionId}/documents'.replaceAll(RegExp('{collectionId}'), collectionId);
 
         final Map<String, dynamic> params = {
@@ -140,7 +140,7 @@ class Database extends Service {
      /// integration](/docs/server/database#databaseCreateCollection) API or
      /// directly from your database console.
      ///
-    Future<Response> createDocument({@required String collectionId, @required Map data, @required List read, @required List write, String parentDocument = '', String parentProperty = '', String parentPropertyType = 'assign'}) {
+    Future<Response> createDocument({required String collectionId, required Map data, required List read, required List write, String parentDocument = '', String parentProperty = '', String parentPropertyType = 'assign'}) {
         final String path = '/database/collections/{collectionId}/documents'.replaceAll(RegExp('{collectionId}'), collectionId);
 
         final Map<String, dynamic> params = {
@@ -164,7 +164,7 @@ class Database extends Service {
      /// Get a document by its unique ID. This endpoint response returns a JSON
      /// object with the document data.
      ///
-    Future<Response> getDocument({@required String collectionId, @required String documentId}) {
+    Future<Response> getDocument({required String collectionId, required String documentId}) {
         final String path = '/database/collections/{collectionId}/documents/{documentId}'.replaceAll(RegExp('{collectionId}'), collectionId).replaceAll(RegExp('{documentId}'), documentId);
 
         final Map<String, dynamic> params = {
@@ -182,7 +182,7 @@ class Database extends Service {
      /// Update a document by its unique ID. Using the patch method you can pass
      /// only specific fields that will get updated.
      ///
-    Future<Response> updateDocument({@required String collectionId, @required String documentId, @required Map data, @required List read, @required List write}) {
+    Future<Response> updateDocument({required String collectionId, required String documentId, required Map data, required List read, required List write}) {
         final String path = '/database/collections/{collectionId}/documents/{documentId}'.replaceAll(RegExp('{collectionId}'), collectionId).replaceAll(RegExp('{documentId}'), documentId);
 
         final Map<String, dynamic> params = {
@@ -204,7 +204,7 @@ class Database extends Service {
      /// documents, its attributes and relations to other documents. Child documents
      /// **will not** be deleted.
      ///
-    Future<Response> deleteDocument({@required String collectionId, @required String documentId}) {
+    Future<Response> deleteDocument({required String collectionId, required String documentId}) {
         final String path = '/database/collections/{collectionId}/documents/{documentId}'.replaceAll(RegExp('{collectionId}'), collectionId).replaceAll(RegExp('{documentId}'), documentId);
 
         final Map<String, dynamic> params = {