Merge pull request #80 from appwrite/dev-chirag

chore: regenerate sdk

Author: stnguyen90

CHANGELOG.md

@@ -1,8 +1,16 @@
 # Change Log
 
+## 16.1.0
+
+* Add `gif` support to `ImageFormat` enum
+* Add support for `dart38` and `flutter332` runtimes
+* Add `upsertDocument()` method to Databases service
+* Fix `convertTo()` method in `Document` and `Preferences` models to correctly accept `Map<String, dynamic>`
+* Fix `upsertDocuments()` method to have `documents` attribute as required parameter
+
 ## 16.0.0
 
-* Add `&lt;REGION&gt;` to doc examples due to the new multi region endpoints
+* Add `<REGION>` to doc examples due to the new multi region endpoints
 * Add doc examples and methods for bulk api transactions: `createDocuments`, `deleteDocuments` etc.
 * Add doc examples, class and methods for new `Sites` service
 * Add doc examples, class and methods for new `Tokens` service
@@ -15,13 +23,13 @@
 ## 14.0.0
 
 * Breaking changes:
-  * Changed the typing of `AppwriteException`&#039;s response parameter from a `dynamic` object to an optional string (`?String`).
+  * Changed the typing of `AppwriteException`'s response parameter from a `dynamic` object to an optional string (`?String`).
 
 ## 13.0.0
 
 * Fixed realtime pong response.
 * Fixed issues with `chunkedUpload` method.
-* Fixed type mismatch bug where `List&lt;dynamic&gt;` was incorrectly causing runtime type errors.
+* Fixed type mismatch bug where `List<dynamic>` was incorrectly causing runtime type errors.
 * Updated return type of `updateMfaChallenge()` from raw data to properly typed `models.Session` object.
 
 ## 12.0.0
@@ -151,7 +159,7 @@ You can find the new syntax for breaking changes in the [Appwrite API references
 * The `number` argument in phone endpoints have been renamed to `phone`
 * List endpoints no longer support `limit`, `offset`, `cursor`, `cursorDirection`, `orderAttributes`, `orderTypes` as they have been moved to the `queries` array
 * `read` and `write` permission have been deprecated and they are now included in the `permissions` array
-* Parameter `permission` for collections and buckets are now renamed to `documentSecurity` &amp; `fileSecurity` respectively
+* Parameter `permission` for collections and buckets are now renamed to `documentSecurity` & `fileSecurity` respectively
 * Renamed methods of the Query helper
     1.  `lesser` renamed to `lessThan`
     2.  `lesserEqual` renamed to `lessThanEqual`
@@ -167,8 +175,8 @@ You can find the new syntax for breaking changes in the [Appwrite API references
 
 ## 6.0.0
 * Support for Appwrite 0.15
-* **BREAKING** `Database` -&gt; `Databases`
-* **BREAKING** `account.createSession()` -&gt; `account.createEmailSession()`
+* **BREAKING** `Database` -> `Databases`
+* **BREAKING** `account.createSession()` -> `account.createEmailSession()`
 * **BREAKING** `dateCreated` attribute removed from `Team`, `Execution`, `File` models
 * **BREAKING** `dateCreated` and `dateUpdated` attribute removed from `Func`, `Deployment`, `Bucket` models
 * **BREAKING** Realtime channels
@@ -182,7 +190,7 @@ You can find the new syntax for breaking changes in the [Appwrite API references
 
 ## 5.0.0
 * Support for Appwrite 0.14
-* **BREAKING** `account.delete()` -&gt; `account.updateStatus()`
+* **BREAKING** `account.delete()` -> `account.updateStatus()`
 * **BREAKING** Execution model `stdout` renamed to `response`
 * **BREAKING** Membership model `name` renamed to `userName` and `email` renamed to `userEmail`
 * Added `teamName` to Membership model
@@ -200,7 +208,7 @@ You can find the new syntax for breaking changes in the [Appwrite API references
 * **BREAKING** **Tags** have been renamed to **Deployments**
 * **BREAKING** `createFile` function expects Bucket ID as the first parameter
 * **BREAKING** `createDeployment` and `createFile` functions expect an instance **InputFile** rather than the instance of **MultipartFile**
-* **BREAKING** `list&lt;Entity&gt;` endpoints now contain a `total` attribute instead of `sum`
+* **BREAKING** `list<Entity>` endpoints now contain a `total` attribute instead of `sum`
 * `onProgress()` callback function for endpoints supporting file uploads
 * Support for synchronous function executions
 * Bug fixes and Improvements
@@ -237,7 +245,7 @@ You can find the new syntax for breaking changes in the [Appwrite API references
 
 ## 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;
+- Breaking - removed order type enum, now you should pass string 'ASC' or 'DESC'
 - Breaking - changed param name from `env` to `runtime` in the **Functions** API
 - Image Crop Gravity support in image preview service
 - New endpoint in Account getSession to get session by ID
@@ -258,7 +266,7 @@ You can find the new syntax for breaking changes in the [Appwrite API references
 - Upgraded all underlying dependencies to null safe version
 - BREAKING Renamed users.deleteUser to users.delete
 - BREAKING Renamed parameter inviteId to membershipId on teams.updateMembershipStatus, teams.deleteMembership
-- JWT Support client.setJWT(&#039;JWT_GENERATED_IN_CLIENT&#039;)
+- JWT Support client.setJWT('JWT_GENERATED_IN_CLIENT')
 - [Update membership roles](https://appwrite.io/docs/references/cloud/server-dart/teams?sdk=dart#updateMembershipRoles)
 - New awesome image preview features, supports borderRadius, borderColor, borderWidth
 

README.md

@@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  dart_appwrite: ^16.0.0
+  dart_appwrite: ^16.1.0
 ```
 
 You can install packages from the command line:

docs/examples/databases/upsert-document.md

@@ -0,0 +1,16 @@
+import 'package:dart_appwrite/dart_appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setSession(''); // The user session to authenticate with
+
+Databases databases = Databases(client);
+
+Document result = await databases.upsertDocument(
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    data: {},
+    permissions: ["read("any")"], // (optional)
+);

docs/examples/databases/upsert-documents.md

@@ -10,5 +10,5 @@ Databases databases = Databases(client);
 DocumentList result = await databases.upsertDocuments(
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    documents: [], // (optional)
+    documents: [],
 );

lib/query.dart

@@ -82,19 +82,17 @@ class Query {
   static String contains(String attribute, dynamic value) =>
       Query._('contains', attribute, value).toString();
 
-  static String or(List<String> queries) =>
-      Query._(
-        'or',
-        null,
-        queries.map((query) => jsonDecode(query)).toList(),
-      ).toString();
-
-  static String and(List<String> queries) =>
-      Query._(
-        'and',
-        null,
-        queries.map((query) => jsonDecode(query)).toList(),
-      ).toString();
+  static String or(List<String> queries) => Query._(
+    'or',
+    null,
+    queries.map((query) => jsonDecode(query)).toList(),
+  ).toString();
+
+  static String and(List<String> queries) => Query._(
+    'and',
+    null,
+    queries.map((query) => jsonDecode(query)).toList(),
+  ).toString();
 
   /// Specify which attributes should be returned by the API call.
   static String select(List<String> attributes) =>

lib/services/databases.dart

@@ -1128,6 +1128,10 @@ class Databases extends Service {
     return models.Document.fromMap(res.data);
   }
 
+  /// **WARNING: Experimental Feature** - This endpoint is experimental and not
+  /// yet officially supported. It may be subject to breaking changes or removal
+  /// in future versions.
+  ///
   /// Create new Documents. Before using this route, you should create a new
   /// collection resource using either a [server
   /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
@@ -1156,15 +1160,18 @@ class Databases extends Service {
     return models.DocumentList.fromMap(res.data);
   }
 
+  /// **WARNING: Experimental Feature** - This endpoint is experimental and not
+  /// yet officially supported. It may be subject to breaking changes or removal
+  /// in future versions.
+  ///
   /// Create or update Documents. Before using this route, you should create a
   /// new collection resource using either a [server
   /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
   /// API or directly from your database console.
-  ///
   Future<models.DocumentList> upsertDocuments({
     required String databaseId,
     required String collectionId,
-    List<Map>? documents,
+    required List<Map> documents,
   }) async {
     final String apiPath =
         '/databases/{databaseId}/collections/{collectionId}/documents'
@@ -1185,6 +1192,10 @@ class Databases extends Service {
     return models.DocumentList.fromMap(res.data);
   }
 
+  /// **WARNING: Experimental Feature** - This endpoint is experimental and not
+  /// yet officially supported. It may be subject to breaking changes or removal
+  /// in future versions.
+  ///
   /// Update all documents that match your queries, if no queries are submitted
   /// then all documents are updated. You can pass only specific fields to be
   /// updated.
@@ -1213,6 +1224,10 @@ class Databases extends Service {
     return models.DocumentList.fromMap(res.data);
   }
 
+  /// **WARNING: Experimental Feature** - This endpoint is experimental and not
+  /// yet officially supported. It may be subject to breaking changes or removal
+  /// in future versions.
+  ///
   /// Bulk delete documents using queries, if no queries are passed then all
   /// documents are deleted.
   Future<models.DocumentList> deleteDocuments({
@@ -1267,6 +1282,44 @@ class Databases extends Service {
     return models.Document.fromMap(res.data);
   }
 
+  /// **WARNING: Experimental Feature** - This endpoint is experimental and not
+  /// yet officially supported. It may be subject to breaking changes or removal
+  /// in future versions.
+  ///
+  /// Create or update a Document. Before using this route, you should create a
+  /// new collection resource using either a [server
+  /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
+  /// API or directly from your database console.
+  Future<models.Document> upsertDocument({
+    required String databaseId,
+    required String collectionId,
+    required String documentId,
+    required Map data,
+    List<String>? permissions,
+  }) async {
+    final String apiPath =
+        '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
+            .replaceAll('{databaseId}', databaseId)
+            .replaceAll('{collectionId}', collectionId)
+            .replaceAll('{documentId}', documentId);
+
+    final Map<String, dynamic> apiParams = {
+      'data': data,
+      'permissions': permissions,
+    };
+
+    final Map<String, String> apiHeaders = {'content-type': 'application/json'};
+
+    final res = await client.call(
+      HttpMethod.put,
+      path: apiPath,
+      params: apiParams,
+      headers: apiHeaders,
+    );
+
+    return models.Document.fromMap(res.data);
+  }
+
   /// Update a document by its unique ID. Using the patch method you can pass
   /// only specific fields that will get updated.
   Future<models.Document> updateDocument({

lib/services/tokens.dart

@@ -29,7 +29,7 @@ class Tokens extends Service {
   }
 
   /// Create a new token. A token is linked to a file. Token can be passed as a
-  /// header or request get parameter.
+  /// request URL search parameter.
   Future<models.ResourceToken> createFileToken({
     required String bucketId,
     required String fileId,

lib/src/client_browser.dart

@@ -30,7 +30,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
       'x-sdk-name': 'Dart',
       'x-sdk-platform': 'server',
       'x-sdk-language': 'dart',
-      'x-sdk-version': '16.0.0',
+      'x-sdk-version': '16.1.0',
       'X-Appwrite-Response-Format': '1.7.0',
     };
 

lib/src/client_io.dart

@@ -26,20 +26,19 @@ class ClientIO extends ClientBase with ClientMixin {
     String endPoint = 'https://cloud.appwrite.io/v1',
     bool selfSigned = false,
   }) : _endPoint = endPoint {
-    _nativeClient =
-        HttpClient()
-          ..badCertificateCallback =
-              ((X509Certificate cert, String host, int port) => selfSigned);
+    _nativeClient = HttpClient()
+      ..badCertificateCallback =
+          ((X509Certificate cert, String host, int port) => selfSigned);
     _httpClient = IOClient(_nativeClient);
     _endPoint = endPoint;
     _headers = {
       'content-type': 'application/json',
       'x-sdk-name': 'Dart',
       'x-sdk-platform': 'server',
       'x-sdk-language': 'dart',
-      'x-sdk-version': '16.0.0',
+      'x-sdk-version': '16.1.0',
       'user-agent':
-          'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})',
+          'AppwriteDartSDK/16.1.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})',
       'X-Appwrite-Response-Format': '1.7.0',
     };
 

lib/src/client_mixin.dart

@@ -124,10 +124,9 @@ mixin ClientMixin {
         '',
         streamedResponse.statusCode,
         headers: streamedResponse.headers.map(
-          (k, v) =>
-              k.toLowerCase() == 'content-type'
-                  ? MapEntry(k, 'text/plain')
-                  : MapEntry(k, v),
+          (k, v) => k.toLowerCase() == 'content-type'
+              ? MapEntry(k, 'text/plain')
+              : MapEntry(k, v),
         ),
         request: streamedResponse.request,
         isRedirect: streamedResponse.isRedirect,