Appwite 1.5 support

abnegate · abnegate · commit 1a8d525cae77 · 2024-03-08T10:44:03.000+01:00
diff --git a/README.md b/README.md
@@ -13,15 +13,15 @@ Appwrite is an open-source backend as a service server that abstract and simplif
 
 
 
-![Appwrite](https://appwrite.io/images/github.png)
+![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
 
 ## Installation
 
 Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  appwrite: ^12.0.0-rc.6
+  appwrite: ^12.0.0
 ```
 
 You can install packages from the command line:
diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md
@@ -6,6 +6,6 @@ Client client = Client()
 
 Account account = Account(client);
 
-MfaType result = await account.addAuthenticator(
+MfaType result = await account.createMfaAuthenticator(
     type: AuthenticatorType.totp,
 );
diff --git a/docs/examples/account/create-mfa-challenge.md b/docs/examples/account/create-mfa-challenge.md
@@ -6,6 +6,6 @@ Client client = Client()
 
 Account account = Account(client);
 
-MfaChallenge result = await account.createChallenge(
-    factor: AuthenticationFactor.totp,
+MfaChallenge result = await account.createMfaChallenge(
+    factor: AuthenticationFactor.email,
 );
diff --git a/docs/examples/account/create-mfa-recovery-codes.md b/docs/examples/account/create-mfa-recovery-codes.md
@@ -0,0 +1,9 @@
+import 'package:appwrite/appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+Account account = Account(client);
+
+MfaRecoveryCodes result = await account.createMfaRecoveryCodes();
diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md
@@ -6,7 +6,7 @@ Client client = Client()
 
 Account account = Account(client);
 
-await account.deleteAuthenticator(
+await account.deleteMfaAuthenticator(
     type: AuthenticatorType.totp,
     otp: '<OTP>',
 );
diff --git a/docs/examples/account/get-mfa-recovery-codes.md b/docs/examples/account/get-mfa-recovery-codes.md
@@ -0,0 +1,9 @@
+import 'package:appwrite/appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+Account account = Account(client);
+
+MfaRecoveryCodes result = await account.getMfaRecoveryCodes();
diff --git a/docs/examples/account/list-mfa-factors.md b/docs/examples/account/list-mfa-factors.md
@@ -6,4 +6,4 @@ Client client = Client()
 
 Account account = Account(client);
 
-MfaFactors result = await account.listFactors();
+MfaFactors result = await account.listMfaFactors();
diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md
@@ -6,7 +6,7 @@ Client client = Client()
 
 Account account = Account(client);
 
-User result = await account.verifyAuthenticator(
+User result = await account.updateMfaAuthenticator(
     type: AuthenticatorType.totp,
     otp: '<OTP>',
 );
diff --git a/docs/examples/account/update-mfa-challenge.md b/docs/examples/account/update-mfa-challenge.md
@@ -6,7 +6,7 @@ Client client = Client()
 
 Account account = Account(client);
 
- result = await account.updateChallenge(
+ result = await account.updateMfaChallenge(
     challengeId: '<CHALLENGE_ID>',
     otp: '<OTP>',
 );
diff --git a/docs/examples/account/update-mfa-recovery-codes.md b/docs/examples/account/update-mfa-recovery-codes.md
@@ -0,0 +1,9 @@
+import 'package:appwrite/appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+Account account = Account(client);
+
+MfaRecoveryCodes result = await account.updateMfaRecoveryCodes();
diff --git a/lib/enums.dart b/lib/enums.dart
@@ -1,8 +1,8 @@
 /// Appwrite Enums
 library appwrite.enums;
 
-part 'src/enums/authentication_factor.dart';
 part 'src/enums/authenticator_type.dart';
+part 'src/enums/authentication_factor.dart';
 part 'src/enums/o_auth_provider.dart';
 part 'src/enums/browser.dart';
 part 'src/enums/credit_card.dart';
diff --git a/lib/models.dart b/lib/models.dart
@@ -44,6 +44,7 @@ part 'src/models/currency.dart';
 part 'src/models/phone.dart';
 part 'src/models/headers.dart';
 part 'src/models/mfa_challenge.dart';
+part 'src/models/mfa_recovery_codes.dart';
 part 'src/models/mfa_type.dart';
 part 'src/models/mfa_factors.dart';
 part 'src/models/subscriber.dart';
diff --git a/lib/services/account.dart b/lib/services/account.dart
@@ -184,9 +184,76 @@ class Account extends Service {
 
     }
 
+    /// Add Authenticator
+    ///
+    /// Add an authenticator app to be used as an MFA factor. Verify the
+    /// authenticator using the [verify
+    /// authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
+    /// method.
+    Future<models.MfaType> createMfaAuthenticator({required enums.AuthenticatorType type}) async {
+        final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value);
+
+        final Map<String, dynamic> apiParams = {
+        };
+
+        final Map<String, String> apiHeaders = {
+            'content-type': 'application/json',
+        };
+
+        final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders);
+
+        return models.MfaType.fromMap(res.data);
+
+    }
+
+    /// Verify Authenticator
+    ///
+    /// Verify an authenticator app after adding it using the [add
+    /// authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+    /// method.
+    Future<models.User> updateMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async {
+        final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value);
+
+        final Map<String, dynamic> apiParams = {
+            'otp': otp,
+        };
+
+        final Map<String, String> apiHeaders = {
+            'content-type': 'application/json',
+        };
+
+        final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders);
+
+        return models.User.fromMap(res.data);
+
+    }
+
+    /// Delete Authenticator
+    ///
+    /// Delete an authenticator for a user by ID.
+    Future<models.User> deleteMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async {
+        final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value);
+
+        final Map<String, dynamic> apiParams = {
+            'otp': otp,
+        };
+
+        final Map<String, String> apiHeaders = {
+            'content-type': 'application/json',
+        };
+
+        final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders);
+
+        return models.User.fromMap(res.data);
+
+    }
+
     /// Create 2FA Challenge
     ///
-    Future<models.MfaChallenge> createChallenge({required enums.AuthenticationFactor factor}) async {
+    /// Begin the process of MFA verification after sign-in. Finish the flow with
+    /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
+    /// method.
+    Future<models.MfaChallenge> createMfaChallenge({required enums.AuthenticationFactor factor}) async {
         const String apiPath = '/account/mfa/challenge';
 
         final Map<String, dynamic> apiParams = {
@@ -205,8 +272,12 @@ class Account extends Service {
 
     /// Create MFA Challenge (confirmation)
     ///
-    /// Complete the MFA challenge by providing the one-time password.
-    Future updateChallenge({required String challengeId, required String otp}) async {
+    /// Complete the MFA challenge by providing the one-time password. Finish the
+    /// process of MFA verification by providing the one-time password. To begin
+    /// the flow, use
+    /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+    /// method.
+    Future updateMfaChallenge({required String challengeId, required String otp}) async {
         const String apiPath = '/account/mfa/challenge';
 
         final Map<String, dynamic> apiParams = {
@@ -227,7 +298,7 @@ class Account extends Service {
     /// List Factors
     ///
     /// List the factors available on the account to be used as a MFA challange.
-    Future<models.MfaFactors> listFactors() async {
+    Future<models.MfaFactors> listMfaFactors() async {
         const String apiPath = '/account/mfa/factors';
 
         final Map<String, dynamic> apiParams = {
@@ -243,14 +314,14 @@ class Account extends Service {
 
     }
 
-    /// Add Authenticator
+    /// Get MFA Recovery Codes
     ///
-    /// Add an authenticator app to be used as an MFA factor. Verify the
-    /// authenticator using the [verify
-    /// authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
-    /// method.
-    Future<models.MfaType> addAuthenticator({required enums.AuthenticatorType type}) async {
-        final String apiPath = '/account/mfa/{type}'.replaceAll('{type}', type.value);
+    /// Get recovery codes that can be used as backup for MFA flow. Before getting
+    /// codes, they must be generated using
+    /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+    /// method. An OTP challenge is required to read recovery codes.
+    Future<models.MfaRecoveryCodes> getMfaRecoveryCodes() async {
+        const String apiPath = '/account/mfa/recovery-codes';
 
         final Map<String, dynamic> apiParams = {
         };
@@ -259,51 +330,54 @@ class Account extends Service {
             'content-type': 'application/json',
         };
 
-        final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders);
+        final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders);
 
-        return models.MfaType.fromMap(res.data);
+        return models.MfaRecoveryCodes.fromMap(res.data);
 
     }
 
-    /// Verify Authenticator
+    /// Create MFA Recovery Codes
     ///
-    /// Verify an authenticator app after adding it using the [add
-    /// authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+    /// Generate recovery codes as backup for MFA flow. It's recommended to
+    /// generate and show then immediately after user successfully adds their
+    /// authehticator. Recovery codes can be used as a MFA verification type in
+    /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
     /// method.
-    Future<models.User> verifyAuthenticator({required enums.AuthenticatorType type, required String otp}) async {
-        final String apiPath = '/account/mfa/{type}'.replaceAll('{type}', type.value);
+    Future<models.MfaRecoveryCodes> createMfaRecoveryCodes() async {
+        const String apiPath = '/account/mfa/recovery-codes';
 
         final Map<String, dynamic> apiParams = {
-            'otp': otp,
         };
 
         final Map<String, String> apiHeaders = {
             'content-type': 'application/json',
         };
 
-        final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders);
+        final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders);
 
-        return models.User.fromMap(res.data);
+        return models.MfaRecoveryCodes.fromMap(res.data);
 
     }
 
-    /// Delete Authenticator
+    /// Regenerate MFA Recovery Codes
     ///
-    /// Delete an authenticator for a user by ID.
-    Future<models.User> deleteAuthenticator({required enums.AuthenticatorType type, required String otp}) async {
-        final String apiPath = '/account/mfa/{type}'.replaceAll('{type}', type.value);
+    /// Regenerate recovery codes that can be used as backup for MFA flow. Before
+    /// regenerating codes, they must be first generated using
+    /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+    /// method. An OTP challenge is required to regenreate recovery codes.
+    Future<models.MfaRecoveryCodes> updateMfaRecoveryCodes() async {
+        const String apiPath = '/account/mfa/recovery-codes';
 
         final Map<String, dynamic> apiParams = {
-            'otp': otp,
         };
 
         final Map<String, String> apiHeaders = {
             'content-type': 'application/json',
         };
 
-        final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders);
+        final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders);
 
-        return models.User.fromMap(res.data);
+        return models.MfaRecoveryCodes.fromMap(res.data);
 
     }
 
@@ -708,10 +782,11 @@ class Account extends Service {
 
     }
 
-    /// Update (or renew) session
+    /// Update session
     ///
-    /// Extend session's expiry to increase it's lifespan. Extending a session is
-    /// useful when session length is short such as 5 minutes.
+    /// Use this endpoint to extend a session's length. Extending a session is
+    /// useful when session expiry is short. If the session was created using an
+    /// OAuth provider, this endpoint refreshes the access token from the provider.
     Future<models.Session> updateSession({required String sessionId}) async {
         final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId);
 
diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart
@@ -43,7 +43,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
       'x-sdk-name': 'Flutter',
       'x-sdk-platform': 'client',
       'x-sdk-language': 'flutter',
-      'x-sdk-version': '12.0.0-rc.6',
+      'x-sdk-version': '12.0.0',
       'X-Appwrite-Response-Format': '1.5.0',
     };
 
diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart
@@ -64,7 +64,7 @@ class ClientIO extends ClientBase with ClientMixin {
       'x-sdk-name': 'Flutter',
       'x-sdk-platform': 'client',
       'x-sdk-language': 'flutter',
-      'x-sdk-version': '12.0.0-rc.6',
+      'x-sdk-version': '12.0.0',
       'X-Appwrite-Response-Format' : '1.5.0',
     };
 
diff --git a/lib/src/enums/authentication_factor.dart b/lib/src/enums/authentication_factor.dart
@@ -1,9 +1,10 @@
 part of appwrite.enums;
 
 enum AuthenticationFactor {
-    totp(value: 'totp'),
+    email(value: 'email'),
     phone(value: 'phone'),
-    email(value: 'email');
+    totp(value: 'totp'),
+    recoverycode(value: 'recoverycode');
 
     const AuthenticationFactor({
         required this.value
diff --git a/lib/src/enums/flag.dart b/lib/src/enums/flag.dart
@@ -34,7 +34,7 @@ enum Flag {
     switzerland(value: 'ch'),
     chile(value: 'cl'),
     china(value: 'cn'),
-    cTeDIvoire(value: 'ci'),
+    coteDIvoire(value: 'ci'),
     cameroon(value: 'cm'),
     democraticRepublicOfTheCongo(value: 'cd'),
     republicOfTheCongo(value: 'cg'),
diff --git a/lib/src/models/mfa_recovery_codes.dart b/lib/src/models/mfa_recovery_codes.dart
@@ -0,0 +1,23 @@
+part of appwrite.models;
+
+/// MFA Recovery Codes
+class MfaRecoveryCodes implements Model {
+    /// Recovery codes.
+    final List recoveryCodes;
+
+    MfaRecoveryCodes({
+        required this.recoveryCodes,
+    });
+
+    factory MfaRecoveryCodes.fromMap(Map<String, dynamic> map) {
+        return MfaRecoveryCodes(
+            recoveryCodes: map['recoveryCodes'] ?? [],
+        );
+    }
+
+    Map<String, dynamic> toMap() {
+        return {
+            "recoveryCodes": recoveryCodes,
+        };
+    }
+}
diff --git a/lib/src/models/mfa_type.dart b/lib/src/models/mfa_type.dart
diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart
diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart
diff --git a/pubspec.yaml b/pubspec.yaml
diff --git a/test/services/account_test.dart b/test/services/account_test.dart
diff --git a/test/src/models/mfa_recovery_codes_test.dart b/test/src/models/mfa_recovery_codes_test.dart
diff --git a/test/src/models/mfa_type_test.dart b/test/src/models/mfa_type_test.dart
diff --git a/test/src/models/session_test.dart b/test/src/models/session_test.dart
diff --git a/test/src/models/user_test.dart b/test/src/models/user_test.dart

Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,4 @@ Client client = Client()`
`6`	`6`
`7`	`7`	`Account account = Account(client);`
`8`	`8`
`9`		`-MfaFactors result = await account.listFactors();`
	`9`	`+MfaFactors result = await account.listMfaFactors();`