Merge pull request #304 from appwrite/dev

abnegate · web-flow · commit 44379c0d5019 · 2026-03-26T05:14:12.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## 23.0.0
+
+* [BREAKING] Changed `$sequence` type from `int` to `string` for rows and documents
+* Updated README badge to API version `1.9.x` and dependency example
+* Updated dependency example to `^21.1.0`
+
 ## 22.0.0
 
 * Breaking: Channel API no longer defaults to '*'; explicit IDs required.
diff --git a/README.md b/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.8.x-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.9.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 latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-flutter/releases).**
+**This SDK is compatible with Appwrite server version 1.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 abstracts and simplifies 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)
 
@@ -19,7 +19,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  appwrite: ^22.0.0
+  appwrite: ^23.0.0
 ```
 
 You can install packages from the command line:
diff --git a/lib/appwrite.dart b/lib/appwrite.dart
@@ -1,6 +1,6 @@
 /// Appwrite Flutter SDK
 ///
-/// This SDK is compatible with Appwrite server version 1.8.x.
+/// This SDK is compatible with Appwrite server version 1.9.x.
 /// For older versions, please check
 /// [previous releases](https://github.com/appwrite/sdk-for-flutter/releases).
 library appwrite;
diff --git a/lib/src/client.dart b/lib/src/client.dart
@@ -79,6 +79,21 @@ abstract class Client {
   /// Your secret dev API key.
   Client setDevKey(String value);
 
+  /// Set ImpersonateUserId.
+  ///
+  /// Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data..
+  Client setImpersonateUserId(String value);
+
+  /// Set ImpersonateUserEmail.
+  ///
+  /// Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data..
+  Client setImpersonateUserEmail(String value);
+
+  /// Set ImpersonateUserPhone.
+  ///
+  /// Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data..
+  Client setImpersonateUserPhone(String value);
+
   /// Add headers that should be sent with all API calls.
   Client addHeader(String key, String value);
 
diff --git a/lib/src/client_base.dart b/lib/src/client_base.dart
@@ -21,6 +21,18 @@ abstract class ClientBase implements Client {
   @override
   ClientBase setDevKey(value);
 
+  /// Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientBase setImpersonateUserId(value);
+
+  /// Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientBase setImpersonateUserEmail(value);
+
+  /// Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientBase setImpersonateUserPhone(value);
+
   @override
   ClientBase setSelfSigned({bool status = true});
 
diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart
@@ -40,8 +40,8 @@ class ClientBrowser extends ClientBase with ClientMixin {
       'x-sdk-name': 'Flutter',
       'x-sdk-platform': 'client',
       'x-sdk-language': 'flutter',
-      'x-sdk-version': '22.0.0',
-      'X-Appwrite-Response-Format': '1.8.0',
+      'x-sdk-version': '23.0.0',
+      'X-Appwrite-Response-Format': '1.9.0',
     };
 
     config = {};
@@ -95,6 +95,30 @@ class ClientBrowser extends ClientBase with ClientMixin {
     return this;
   }
 
+  /// Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientBrowser setImpersonateUserId(value) {
+    config['impersonateUserId'] = value;
+    addHeader('X-Appwrite-Impersonate-User-Id', value);
+    return this;
+  }
+
+  /// Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientBrowser setImpersonateUserEmail(value) {
+    config['impersonateUserEmail'] = value;
+    addHeader('X-Appwrite-Impersonate-User-Email', value);
+    return this;
+  }
+
+  /// Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientBrowser setImpersonateUserPhone(value) {
+    config['impersonateUserPhone'] = value;
+    addHeader('X-Appwrite-Impersonate-User-Phone', value);
+    return this;
+  }
+
   @override
   ClientBrowser setSelfSigned({bool status = true}) {
     return this;
diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart
@@ -58,8 +58,8 @@ class ClientIO extends ClientBase with ClientMixin {
       'x-sdk-name': 'Flutter',
       'x-sdk-platform': 'client',
       'x-sdk-language': 'flutter',
-      'x-sdk-version': '22.0.0',
-      'X-Appwrite-Response-Format': '1.8.0',
+      'x-sdk-version': '23.0.0',
+      'X-Appwrite-Response-Format': '1.9.0',
     };
 
     config = {};
@@ -121,6 +121,30 @@ class ClientIO extends ClientBase with ClientMixin {
     return this;
   }
 
+  /// Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientIO setImpersonateUserId(value) {
+    config['impersonateUserId'] = value;
+    addHeader('X-Appwrite-Impersonate-User-Id', value);
+    return this;
+  }
+
+  /// Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientIO setImpersonateUserEmail(value) {
+    config['impersonateUserEmail'] = value;
+    addHeader('X-Appwrite-Impersonate-User-Email', value);
+    return this;
+  }
+
+  /// Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
+  @override
+  ClientIO setImpersonateUserPhone(value) {
+    config['impersonateUserPhone'] = value;
+    addHeader('X-Appwrite-Impersonate-User-Phone', value);
+    return this;
+  }
+
   @override
   ClientIO setSelfSigned({bool status = true}) {
     selfSigned = status;
diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart
@@ -6,7 +6,7 @@ class Document implements Model {
   final String $id;
 
   /// Document sequence ID.
-  final int $sequence;
+  final String $sequence;
 
   /// Collection ID.
   final String $collectionId;
@@ -39,7 +39,7 @@ class Document implements Model {
   factory Document.fromMap(Map<String, dynamic> map) {
     return Document(
       $id: map['\$id'].toString(),
-      $sequence: map['\$sequence'],
+      $sequence: map['\$sequence'].toString(),
       $collectionId: map['\$collectionId'].toString(),
       $databaseId: map['\$databaseId'].toString(),
       $createdAt: map['\$createdAt'].toString(),
diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart
@@ -5,13 +5,13 @@ class Log implements Model {
   /// Event name.
   final String event;
 
-  /// User ID.
+  /// User ID of the actor recorded for this log. During impersonation, this is the original impersonator, not the impersonated target user.
   final String userId;
 
-  /// User Email.
+  /// User email of the actor recorded for this log. During impersonation, this is the original impersonator.
   final String userEmail;
 
-  /// User Name.
+  /// User name of the actor recorded for this log. During impersonation, this is the original impersonator.
   final String userName;
 
   /// API mode when event triggered.
diff --git a/lib/src/models/row.dart b/lib/src/models/row.dart
@@ -6,7 +6,7 @@ class Row implements Model {
   final String $id;
 
   /// Row sequence ID.
-  final int $sequence;
+  final String $sequence;
 
   /// Table ID.
   final String $tableId;
@@ -39,7 +39,7 @@ class Row implements Model {
   factory Row.fromMap(Map<String, dynamic> map) {
     return Row(
       $id: map['\$id'].toString(),
-      $sequence: map['\$sequence'],
+      $sequence: map['\$sequence'].toString(),
       $tableId: map['\$tableId'].toString(),
       $databaseId: map['\$databaseId'].toString(),
       $createdAt: map['\$createdAt'].toString(),
diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart
@@ -59,6 +59,12 @@ class User implements Model {
   /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
   final String accessedAt;
 
+  /// Whether the user can impersonate other users.
+  final bool? impersonator;
+
+  /// ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.
+  final String? impersonatorUserId;
+
   User({
     required this.$id,
     required this.$createdAt,
@@ -79,6 +85,8 @@ class User implements Model {
     required this.prefs,
     required this.targets,
     required this.accessedAt,
+    this.impersonator,
+    this.impersonatorUserId,
   });
 
   factory User.fromMap(Map<String, dynamic> map) {
@@ -102,6 +110,8 @@ class User implements Model {
       prefs: Preferences.fromMap(map['prefs']),
       targets: List<Target>.from(map['targets'].map((p) => Target.fromMap(p))),
       accessedAt: map['accessedAt'].toString(),
+      impersonator: map['impersonator'],
+      impersonatorUserId: map['impersonatorUserId']?.toString(),
     );
   }
 
@@ -127,6 +137,8 @@ class User implements Model {
       "prefs": prefs.toMap(),
       "targets": targets.map((p) => p.toMap()).toList(),
       "accessedAt": accessedAt,
+      "impersonator": impersonator,
+      "impersonatorUserId": impersonatorUserId,
     };
   }
 }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: appwrite
-version: 22.0.0
+version: 23.0.0
 description: Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API
 homepage: https://appwrite.io
 repository: https://github.com/appwrite/sdk-for-flutter
diff --git a/test/services/databases_test.dart b/test/services/databases_test.dart
@@ -181,7 +181,7 @@ void main() {
     test('test method createDocument()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$collectionId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -205,7 +205,7 @@ void main() {
     test('test method getDocument()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$collectionId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -228,7 +228,7 @@ void main() {
     test('test method upsertDocument()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$collectionId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -251,7 +251,7 @@ void main() {
     test('test method updateDocument()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$collectionId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -288,7 +288,7 @@ void main() {
     test('test method decrementDocumentAttribute()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$collectionId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -312,7 +312,7 @@ void main() {
     test('test method incrementDocumentAttribute()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$collectionId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
diff --git a/test/services/tables_db_test.dart b/test/services/tables_db_test.dart
@@ -181,7 +181,7 @@ void main() {
     test('test method createRow()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$tableId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -205,7 +205,7 @@ void main() {
     test('test method getRow()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$tableId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -228,7 +228,7 @@ void main() {
     test('test method upsertRow()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$tableId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -251,7 +251,7 @@ void main() {
     test('test method updateRow()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$tableId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -288,7 +288,7 @@ void main() {
     test('test method decrementRowColumn()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$tableId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
@@ -312,7 +312,7 @@ void main() {
     test('test method incrementRowColumn()', () async {
       final Map<String, dynamic> data = {
         '\$id': '5e5ea5c16897e',
-        '\$sequence': 1,
+        '\$sequence': '1',
         '\$tableId': '5e5ea5c15117e',
         '\$databaseId': '5e5ea5c15117e',
         '\$createdAt': '2020-10-15T06:38:00.000+00:00',
diff --git a/test/src/models/document_test.dart b/test/src/models/document_test.dart
@@ -6,7 +6,7 @@ void main() {
     test('model', () {
       final model = Document(
         $id: '5e5ea5c16897e',
-        $sequence: 1,
+        $sequence: '1',
         $collectionId: '5e5ea5c15117e',
         $databaseId: '5e5ea5c15117e',
         $createdAt: '2020-10-15T06:38:00.000+00:00',
@@ -19,7 +19,7 @@ void main() {
       final result = Document.fromMap(map);
 
       expect(result.$id, '5e5ea5c16897e');
-      expect(result.$sequence, 1);
+      expect(result.$sequence, '1');
       expect(result.$collectionId, '5e5ea5c15117e');
       expect(result.$databaseId, '5e5ea5c15117e');
       expect(result.$createdAt, '2020-10-15T06:38:00.000+00:00');
diff --git a/test/src/models/row_test.dart b/test/src/models/row_test.dart
