Merge pull request #260 from appwrite/dev

Dev

Author: loks0n

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 17.1.0
+
+* Add `incrementDocumentAttribute` and `decrementDocumentAttribute` support to `Databases` service
+* Add `gif` support to `ImageFormat` enum
+* Add `sequence` support to `Document` model
+
 ## 17.0.2
 
 * Add `gif` support to `ImageFormat` enum

README.md

@@ -21,7 +21,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  appwrite: ^17.0.2
+  appwrite: ^17.1.0
 ```
 
 You can install packages from the command line:

docs/examples/databases/create-document.md

@@ -2,9 +2,7 @@ import 'package:appwrite/appwrite.dart';
 
 Client client = Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setSession('') // The user session to authenticate with
-    .setKey('') // 
-    .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 Databases databases = Databases(client);
 

docs/examples/databases/decrement-document-attribute.md

@@ -0,0 +1,16 @@
+import 'package:appwrite/appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+Databases databases = Databases(client);
+
+Document result = await databases.decrementDocumentAttribute(
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    attribute: '',
+    value: 0, // optional
+    min: 0, // optional
+);

docs/examples/databases/increment-document-attribute.md

@@ -0,0 +1,16 @@
+import 'package:appwrite/appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+Databases databases = Databases(client);
+
+Document result = await databases.incrementDocumentAttribute(
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    attribute: '',
+    value: 0, // optional
+    max: 0, // optional
+);

lib/services/databases.dart

@@ -189,4 +189,64 @@ class Databases extends Service {
 
     return res.data;
   }
+
+  /// Decrement a specific attribute of a document by a given value.
+  Future<models.Document> decrementDocumentAttribute({
+    required String databaseId,
+    required String collectionId,
+    required String documentId,
+    required String attribute,
+    double? value,
+    double? min,
+  }) async {
+    final String apiPath =
+        '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement'
+            .replaceAll('{databaseId}', databaseId)
+            .replaceAll('{collectionId}', collectionId)
+            .replaceAll('{documentId}', documentId)
+            .replaceAll('{attribute}', attribute);
+
+    final Map<String, dynamic> apiParams = {'value': value, 'min': min};
+
+    final Map<String, String> apiHeaders = {'content-type': 'application/json'};
+
+    final res = await client.call(
+      HttpMethod.patch,
+      path: apiPath,
+      params: apiParams,
+      headers: apiHeaders,
+    );
+
+    return models.Document.fromMap(res.data);
+  }
+
+  /// Increment a specific attribute of a document by a given value.
+  Future<models.Document> incrementDocumentAttribute({
+    required String databaseId,
+    required String collectionId,
+    required String documentId,
+    required String attribute,
+    double? value,
+    double? max,
+  }) async {
+    final String apiPath =
+        '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment'
+            .replaceAll('{databaseId}', databaseId)
+            .replaceAll('{collectionId}', collectionId)
+            .replaceAll('{documentId}', documentId)
+            .replaceAll('{attribute}', attribute);
+
+    final Map<String, dynamic> apiParams = {'value': value, 'max': max};
+
+    final Map<String, String> apiHeaders = {'content-type': 'application/json'};
+
+    final res = await client.call(
+      HttpMethod.patch,
+      path: apiPath,
+      params: apiParams,
+      headers: apiHeaders,
+    );
+
+    return models.Document.fromMap(res.data);
+  }
 }

lib/src/client_browser.dart

@@ -40,7 +40,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
       'x-sdk-name': 'Flutter',
       'x-sdk-platform': 'client',
       'x-sdk-language': 'flutter',
-      'x-sdk-version': '17.0.2',
+      'x-sdk-version': '17.1.0',
       'X-Appwrite-Response-Format': '1.7.0',
     };
 

lib/src/client_io.dart

@@ -58,7 +58,7 @@ class ClientIO extends ClientBase with ClientMixin {
       'x-sdk-name': 'Flutter',
       'x-sdk-platform': 'client',
       'x-sdk-language': 'flutter',
-      'x-sdk-version': '17.0.2',
+      'x-sdk-version': '17.1.0',
       'X-Appwrite-Response-Format': '1.7.0',
     };
 

lib/src/models/document.dart

@@ -5,6 +5,9 @@ class Document implements Model {
   /// Document ID.
   final String $id;
 
+  /// Document automatically incrementing ID.
+  final int $sequence;
+
   /// Collection ID.
   final String $collectionId;
 
@@ -24,6 +27,7 @@ class Document implements Model {
 
   Document({
     required this.$id,
+    required this.$sequence,
     required this.$collectionId,
     required this.$databaseId,
     required this.$createdAt,
@@ -35,6 +39,7 @@ class Document implements Model {
   factory Document.fromMap(Map<String, dynamic> map) {
     return Document(
       $id: map['\$id'].toString(),
+      $sequence: map['\$sequence'],
       $collectionId: map['\$collectionId'].toString(),
       $databaseId: map['\$databaseId'].toString(),
       $createdAt: map['\$createdAt'].toString(),
@@ -47,6 +52,7 @@ class Document implements Model {
   Map<String, dynamic> toMap() {
     return {
       "\$id": $id,
+      "\$sequence": $sequence,
       "\$collectionId": $collectionId,
       "\$databaseId": $databaseId,
       "\$createdAt": $createdAt,

pubspec.yaml

@@ -1,5 +1,5 @@
 name: appwrite
-version: 17.0.2
+version: 17.1.0
 description: Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API
 homepage: https://appwrite.io
 repository: https://github.com/appwrite/sdk-for-flutter