Merge pull request #263 from appwrite/dev

Add 1.8.x support

Author: abnegate

.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: Analyze and test
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          channel: stable
+      - run: flutter pub get
+      - run: flutter analyze --no-fatal-infos --no-fatal-warnings
+      - run: flutter test

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## 18.0.0
+
+* Support for Appwrite 1.8
+* Added TablesDB service
+* Added new query types:
+    * `notContains`
+    * `notSearch`
+    * `notBetween`
+    * `notStartsWith`
+    * `notEndsWith`
+    * `createdBefore`
+    * `createdAfter`
+    * `updatedBefore`
+    * `updatedAfter`
+* Deprecated `updateMagicURLSession`
+* Deprecated `updatePhoneSession`
+* Deprecated Databases service
+> The TablesDB service is the new recommended way to work with databases.
+> Existing databases/collections/attributes/documents can be managed using the TablesDB service.
+> Existing Databases service will continue to work, but new features may only be added to the TablesDB service.
+
 ## 17.1.0
 
 * Add `incrementDocumentAttribute` and `decrementDocumentAttribute` support to `Databases` service

README.md

@@ -2,12 +2,12 @@
 
 [![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-1.7.x-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.8.x-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?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-flutter/releases).**
+**This SDK is compatible with Appwrite server version 1.8.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)
 
@@ -21,7 +21,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  appwrite: ^17.1.0
+  appwrite: ^18.0.0
 ```
 
 You can install packages from the command line:
@@ -50,7 +50,7 @@ In order to capture the Appwrite OAuth callback url, the following activity need
     ....
     <application ...>
         ....
-        <!-- Add this inside the <application> tag, along side the existing <activity> tags -->
+        <!-- Add this inside the <application> tag, alongside the existing <activity> tags -->
         <activity android:exported="true" android:name="com.linusu.flutter_web_auth_2.CallbackActivity" >
             <intent-filter android:label="flutter_web_auth_2">
                 <action android:name="android.intent.action.VIEW" />
@@ -76,8 +76,8 @@ The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthentication
 ### 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.
+### macOS
+For **macOS** 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 macOS 10.15+ to allow OAuth authentication. You have to change your macOS Deployment Target in Xcode to be macOS >= 10.15 to be able to build your app for macOS.
 
@@ -121,77 +121,53 @@ For **Windows** add your app <u>name</u> and <u>package name</u>, Your package n
 
 ### Init your SDK
 
-<p>Initialize your SDK with your Appwrite server API endpoint and project ID, which can be found in your project settings page.
+<p>Initialize your SDK with your project ID, which can be found in your project settings page.
 
 ```dart
-import 'package:appwrite/appwrite.dart';
-
-void main() {
-  Client client = Client();
-
-  client
-    .setEndpoint('https://localhost/v1') // Your Appwrite Endpoint
-    .setProject('5e8cf4f46b5e8') // Your project ID
-    .setSelfSigned() // Use only on dev mode with a self-signed SSL cert
-  ;
-}
+Client client = Client().setProject('<YOUR_PROJECT_ID>');
 ```
 
-Before starting to send any API calls to your new Appwrite instance, make sure your Android or iOS emulators has network access to the Appwrite server hostname or IP address.
-
-When trying to connect to Appwrite from an emulator or a mobile device, localhost is the hostname for the device or emulator and not your local Appwrite instance. You should replace localhost with your private IP as the Appwrite endpoint's hostname. You can also use a service like [ngrok](https://ngrok.com/) to proxy the Appwrite API.
+> If using a self-hosted instance, you will also need to set your Appwrite endpoint using the `setEndpoint` method. Before starting to send any API calls to your new Appwrite instance, make sure your Android or iOS emulators has network access to the Appwrite server hostname or IP address.
+> When trying to connect to a local Appwrite instance from an emulator or a mobile device, localhost is the hostname for the device or emulator and not your machine. You should replace localhost with your machine's private IP as the Appwrite endpoint's hostname (e.g. 192.168.1.100). You can also use a service like [ngrok](https://ngrok.com/) to proxy the Appwrite API.
 
 ### 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](https://appwrite.io/docs) section.
 
 ```dart
-// Register User
 Account account = Account(client);
-final user = await account
-  .create(
-    userId: ID.unique(), email: "[email protected]", password: "password", name: "Walter O'Brien"
-  );
+
+User user = await account.create(
+  userId: ID.unique(),
+  email: '[email protected]',
+  password: 'password',
+  name: 'Walter O'Brien',
+);
 ```
 
 ### Full Example
 
 ```dart
-import 'package:appwrite/appwrite.dart';
-
-void main() {
-  Client client = Client();
-
+Client client = Client().setProject('<YOUR_PROJECT_ID>>');
 
-  client
-    .setEndpoint('https://localhost/v1') // Your Appwrite Endpoint
-    .setProject('5e8cf4f46b5e8') // Your project ID
-    .setSelfSigned() // Use only on dev mode with a self-signed SSL cert
-    ;
-
-
-  // Register User
-  Account account = Account(client);
+Account account = Account(client);
 
-  final user = await account
-    .create(
-      userId: ID.unique(), email: "[email protected]", password: "password", name: "Walter O'Brien"
-    );
-}
+User user = await account.create(
+  userId: ID.unique(),
+  email: '[email protected]',
+  password: 'password',
+  name: 'Walter O'Brien'
+);
 ```
 
 ### Error Handling
 The Appwrite Flutter SDK raises `AppwriteException` object with `message`, `type`, `code` and `response` properties. You can handle any errors by catching `AppwriteException` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.
 
 ```dart
-Account account = Account(client);
-
 try {
-  final user = await account.create(userId: ID.unique(), email: "[email protected]", password: "password", name: "Walter O'Brien");
-  print(user.toMap());
+  User user = await account.create(...);
 } on AppwriteException catch(e) {
-  //show message to user or do other operation based on error as required
-  print(e.message);
+  // Handle the exception
 }
 ```
 

analysis_options.yaml

@@ -0,0 +1 @@
+include: package:flutter_lints/flutter.yaml

docs/examples/account/create-j-w-t.md renamed to docs/examples/account/create-jwt.md

@@ -6,6 +6,6 @@ Client client = Client()
 
 Account account = Account(client);
 
-MfaType result = await account.createMfaAuthenticator(
+MfaType result = await account.createMFAAuthenticator(
     type: AuthenticatorType.totp,
 );

docs/examples/account/create-magic-u-r-l-token.md renamed to docs/examples/account/create-magic-url-token.md

@@ -6,6 +6,6 @@ Client client = Client()
 
 Account account = Account(client);
 
-MfaChallenge result = await account.createMfaChallenge(
+MfaChallenge result = await account.createMFAChallenge(
     factor: AuthenticationFactor.email,
 );

docs/examples/account/create-mfa-authenticator.md

@@ -6,4 +6,4 @@ Client client = Client()
 
 Account account = Account(client);
 
-MfaRecoveryCodes result = await account.createMfaRecoveryCodes();
+MfaRecoveryCodes result = await account.createMFARecoveryCodes();