Merge pull request #26 from appwrite/dev

christyjacob4 · web-flow · commit 2e25140f80a9 · 2021-07-07T15:41:51.000+05:30
feat: update version
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,12 @@
+## 0.7.0
+- Support for Appwrite 0.9
+- Breaking - removed order type enum, now you should pass string &#039;ASC&#039; or &#039;DESC&#039;
+- Image Crop Gravity support in image preview service
+- New endpoint in Account getSession to get session by ID
+- Fix - issues with User-Agent when app name consisted of non-ASCII characters
+- Fix - issue with null Success and Failure URL in createOAuth2Session
+- Updated underlying dependencies
+
 ## 0.6.3
 
 - Removed default values, nothing should change in usage as default values are already allocated in server
@@ -116,4 +125,4 @@
 ## 0.0.8
 
 - Fixed compilation error in Client class
-- Shorter description for package
+- Shorter description for package
diff --git a/README.md b/README.md
@@ -1,16 +1,15 @@
 # Appwrite Flutter SDK
 
-[![pub package](https://img.shields.io/pub/v/appwrite?style=flat-square.svg)](https://pub.dartlang.org/packages/appwrite)
+[![pub package](https://img.shields.io/pub/v/appwrite?style=flat-square)](https://pub.dartlang.org/packages/appwrite)
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-flutter.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-0.8.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.9.0-blue.svg?style=flat-square)
+[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![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.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-flutter/releases).**
+**This SDK is compatible with Appwrite server version 0.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-flutter/releases).**
 
-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 Flutter SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
-                        For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
+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 Flutter SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
 
 
@@ -22,7 +21,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  appwrite: ^0.6.4
+  appwrite: ^0.7.0
 ```
 
 You can install packages from the command line:
@@ -37,27 +36,14 @@ pub get appwrite
 ### Add your Flutter Platform
 To init your SDK and start interacting with Appwrite services, you need to add a new Flutter platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before, and click the 'Add Platform' button.
 
-From the options, choose to add a new **Flutter** platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for both iOS and Android.
+From the options, choose to add a new **Flutter** platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for Android, iOS, Linux, Mac OS, Web and Windows.
 
 If you are building your Flutter application for multiple devices, you have to follow this process for each different device.
 
-#### iOS
-For **iOS** add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.
-
-#### Android
-For **Android** add your app <u>name</u> and <u>package name</u>, Your package name is generally the applicationId in your app-level build.gradle file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
-
-### iOS
-
-The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS >= 11 to be able to build your app on an emulator or a real device.
-
-1. In Xcode, open Runner.xcworkspace in your app's ios folder.
-2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.
-3. Select the General tab.
-4. In Deployment Info, 'Target' select iOS 11.0
-
 ### Android
-In order to capture the Appwrite OAuth callback url, the following activity needs to be added to your [AndroidManifest.xml](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/src/main/AndroidManifest.xml). Be sure to relpace the **[PROJECT_ID]** string with your actual Appwrite project ID. You can find your Appwrite project ID in you project settings screen in your Appwrite console.
+For **Android** first add your app <u>name</u> and <u>package name</u>, Your package name is generally the **applicationId** in your app-level <a href="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/android/app/build.gradle#L41" target="_blank" rel="noopener">build.gradle</a> file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
+
+In order to capture the Appwrite OAuth callback url, the following activity needs to be added to your [AndroidManifest.xml](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/src/main/AndroidManifest.xml). Be sure to replace the **[PROJECT_ID]** string with your actual Appwrite project ID. You can find your Appwrite project ID in your project settings screen in the console.
 
 ```xml
 <manifest>
@@ -74,15 +60,34 @@ In order to capture the Appwrite OAuth callback url, the following activity need
 </manifest>
 ```
 
+### iOS
+For **iOS** first add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.
+
+The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS >= 11 to be able to build your app on an emulator or a real device.
+
+1. In Xcode, open Runner.xcworkspace in your app's ios folder.
+2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.
+3. Select the General tab.
+4. In Deployment Info, 'Target' select iOS 11.0
+
+### Linux
+For **Linux** add your app <u>name</u> and <u>package name</u>, Your package name is generally the **name** in your <a href="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1" target="_blank" rel="noopener">pubspec.yaml<a> file. If you cannot find the correct package name, run the application in linux, and make any request with proper exception handling, you should get the application ID needed to add in the received error message.
+
+### Mac OS
+For **Mac OS** add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.
+
 ### Web
 Appwrite 0.7, and the Appwrite Flutter SDK 0.3.0 have added support for Flutter Web. To build web apps that integrate with Appwrite successfully, all you have to do is add a web platform on your Appwrite project's dashboard and list the domain your website will use to allow communication to the Appwrite API.
 
 #### Flutter Web Cross-Domain Communication & Cookies
 While running Flutter Web, make sure your Appwrite server and your Flutter client are using the same top-level domain and the same protocol (HTTP or HTTPS) to communicate. When trying to communicate between different domains or protocols, you may receive HTTP status error 401 because some modern browsers block cross-site or insecure cookies for enhanced privacy. In production, Appwrite allows you set multiple [custom-domains](https://appwrite.io/docs/custom-domains) for each project.
 
+### Windows
+For **Windows** add your app <u>name</u> and <u>package name</u>, Your package name is generally the **name** in your <a href="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1" target="_blank" rel="noopener">pubspec.yaml</a> file. If you cannot find the correct package name, run the application in windows, and make any request with proper exception handling, you should get the application id needed to add in the received error message.
+
 ### Init your SDK
 
-<p>Initialize your SDK code with your project ID, which can be found in your project settings page.
+<p>Initialize your SDK with your Appwrite server API endpoint and project ID, which can be found in your project settings page.
 
 ```dart
 import 'package:appwrite/appwrite.dart';
@@ -102,7 +107,7 @@ When trying to connect to Appwrite from an emulator or a mobile device, localhos
 
 ### Make Your First Request
 
-<p>Once your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.
+<p>Once your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.
 
 ```dart
 // Register User
@@ -156,12 +161,13 @@ try {
 ```
 
 ### Learn more
-You can use followng resources to learn more and get help
+You can use following resources to learn more and get help
 - 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-flutter)
 - 📜 [Appwrite Docs](https://appwrite.io/docs)
 - 💬 [Discord Community](https://appwrite.io/discord)
 - 🚂 [Appwrite Flutter Playground](https://github.com/appwrite/playground-for-flutter)
 
+
 ## 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.
diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md
@@ -0,0 +1,21 @@
+import 'package:appwrite/appwrite.dart';
+
+void main() { // Init SDK
+  Client client = Client();
+  Account account = Account(client);
+
+  client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+  ;
+  Future result = account.getSession(
+    sessionId: '[SESSION_ID]',
+  );
+
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
+}
diff --git a/lib/client.dart b/lib/client.dart
@@ -26,8 +26,8 @@ class Client {
         
         this.headers = {
             'content-type': 'application/json',
-            'x-sdk-version': 'appwrite:flutter:0.6.4',
-            'X-Appwrite-Response-Format' : '0.8.0',
+            'x-sdk-version': 'appwrite:flutter:0.7.0',
+            'X-Appwrite-Response-Format' : '0.9.0',
         };
 
         this.config = {};
@@ -115,7 +115,7 @@ class Client {
                 final macinfo = await deviceInfoPlugin.macOsInfo;
                 device = '(Macintosh; ${macinfo.model})';
             }
-            addHeader('user-agent', '${packageInfo.appName}/${packageInfo.version} $device');
+            addHeader('user-agent', '${packageInfo.packageName}/${packageInfo.version} $device');
         } else {
             // if web set withCredentials true to make cookies work
             _prefs = await SharedPreferences.getInstance();
@@ -141,7 +141,9 @@ class Client {
             await this.init();
         }
 
-        params.removeWhere((key,value) => value == null);
+        if(params.isNotEmpty) {
+            params.removeWhere((key,value) => value == null);
+        }
 
         // Origin is hardcoded for testing
         Options options = Options(
diff --git a/lib/enums.dart b/lib/enums.dart
@@ -7,11 +7,3 @@ extension HttpMethodString on HttpMethod {
     return this.toString().split('.').last.toUpperCase();
   }
 }
-
-enum OrderType { asc, desc }
-
-extension OrderTypeString on OrderType {
-  String name() {
-    return this.toString().split('.').last.toUpperCase();
-  }
-}
diff --git a/lib/services/account.dart b/lib/services/account.dart
@@ -96,7 +96,8 @@ class Account extends Service {
      /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT
      /// to authenticate on behalf of the current user when working with the
      /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes
-     /// from its creation and will be invalid if the user will logout.
+     /// from its creation and will be invalid if the user will logout in that time
+     /// frame.
      ///
     Future<Response> createJWT() {
         final String path = '/account/jwt';
@@ -319,9 +320,10 @@ class Account extends Service {
      ///
      /// Use this endpoint to allow a new user to register an anonymous account in
      /// your project. This route will also create a new session for the user. To
-     /// allow the new user to convert an anonymous account to a normal account
-     /// account, you need to update its [email and
-     /// password](/docs/client/account#accountUpdateEmail).
+     /// allow the new user to convert an anonymous account to a normal account, you
+     /// need to update its [email and
+     /// password](/docs/client/account#accountUpdateEmail) or create an [OAuth2
+     /// session](/docs/client/account#accountCreateOAuth2Session).
      ///
     Future<Response> createAnonymousSession() {
         final String path = '/account/sessions/anonymous';
@@ -361,8 +363,7 @@ class Account extends Service {
             for (var item in value) {
               query.add(Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item));
             }
-          }
-          else {
+          } else if(value != null) {
               query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value));
           }
         });
@@ -395,6 +396,24 @@ class Account extends Service {
             });
         }
 
+    }
+
+     /// Get Session By ID
+     ///
+     /// Use this endpoint to get a logged in user's session using a Session ID.
+     /// Inputting 'current' will return the current session being used.
+     ///
+    Future<Response> getSession({required String sessionId}) {
+        final String path = '/account/sessions/{sessionId}'.replaceAll(RegExp('{sessionId}'), sessionId);
+
+        final Map<String, dynamic> params = {
+        };
+
+        final Map<String, String> headers = {
+            'content-type': 'application/json',
+        };
+
+        return client.call(HttpMethod.get, path: path, params: params, headers: headers);
     }
 
      /// Delete Account Session
diff --git a/lib/services/database.dart b/lib/services/database.dart
@@ -11,15 +11,15 @@ 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, int? limit, int? offset, String? orderField, OrderType? orderType, String? orderCast, String? search}) {
+    Future<Response> listDocuments({required String collectionId, List? filters, int? limit, int? offset, String? orderField, String? orderType, String? orderCast, String? search}) {
         final String path = '/database/collections/{collectionId}/documents'.replaceAll(RegExp('{collectionId}'), collectionId);
 
         final Map<String, dynamic> params = {
             'filters': filters,
             'limit': limit,
             'offset': offset,
             'orderField': orderField,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
             'orderCast': orderCast,
             'search': search,
         };
diff --git a/lib/services/functions.dart b/lib/services/functions.dart
@@ -11,14 +11,14 @@ class Functions extends Service {
      /// return a list of all of the project's executions. [Learn more about
      /// different API modes](/docs/admin).
      ///
-    Future<Response> listExecutions({required String functionId, String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> listExecutions({required String functionId, String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/functions/{functionId}/executions'.replaceAll(RegExp('{functionId}'), functionId);
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
diff --git a/lib/services/storage.dart b/lib/services/storage.dart
@@ -10,14 +10,14 @@ class Storage extends Service {
      /// your results. On admin mode, this endpoint will return a list of all of the
      /// project's files. [Learn more about different API modes](/docs/admin).
      ///
-    Future<Response> listFiles({String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> listFiles({String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/storage/files';
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
@@ -132,12 +132,13 @@ class Storage extends Service {
      /// and spreadsheets, will return the file icon image. You can also pass query
      /// string arguments for cutting and resizing your preview image.
      ///
-    Future<Response> getFilePreview({required String fileId, int? width, int? height, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, String? output}) {
+    Future<Response> getFilePreview({required String fileId, int? width, int? height, String? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, String? output}) {
         final String path = '/storage/files/{fileId}/preview'.replaceAll(RegExp('{fileId}'), fileId);
 
         final Map<String, dynamic> params = {
             'width': width,
             'height': height,
+            'gravity': gravity,
             'quality': quality,
             'borderWidth': borderWidth,
             'borderColor': borderColor,
diff --git a/lib/services/teams.dart b/lib/services/teams.dart
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,3 @@ extension HttpMethodString on HttpMethod {`
`7`	`7`	`return this.toString().split('.').last.toUpperCase();`
`8`	`8`	`}`
`9`	`9`	`}`
`10`		`-`
`11`		`-enum OrderType { asc, desc }`
`12`		`-`
`13`		`-extension OrderTypeString on OrderType {`
`14`		`- String name() {`
`15`		`- return this.toString().split('.').last.toUpperCase();`
`16`		`- }`
`17`		`-}`