Merge pull request #50 from appwrite/dev

loks0n · web-flow · commit 01db5524e76c · 2025-07-26T17:13:20.000+01:00
Add inc/dec
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1 +1,29 @@
-# Change Log
+# Change Log
+
+## 9.1.0
+
+* Add `incrementDocumentAttribute` and `decrementDocumentAttribute` support to `Databases` service
+* Add `dart38` and `flutter332` support to runtime models
+* Add `gif` support to `ImageFormat` enum
+* Add `encrypt` support to `StringAttribute` model
+* Add `sequence` support to `Document` model
+
+## 9.0.0
+
+* 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
+* Add enums for `BuildRuntime `, `Adapter`, `Framework`, `DeploymentDownloadType` and `VCSDeploymentType`
+* Update enum for `runtimes` with Pythonml312, Dart219, Flutter327 and Flutter329
+* Add `token` param to `getFilePreview` and `getFileView` for File tokens usage
+* Add `queries` and `search` params to `listMemberships` method
+* Remove `search` param from `listExecutions` method
+
+## 8.0.0
+
+* Fix requests failing by removing `Content-Type` header from `GET` and `HEAD` requests
+
+## 7.0.0
+
+* Fix pong response & chunked upload
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ![Maven Central](https://img.shields.io/maven-central/v/io.appwrite/sdk-for-kotlin.svg?color=green&style=flat-square)
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-kotlin.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.7.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.7.4-blue.svg?style=flat-square)
 [![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)
 
@@ -39,7 +39,7 @@ repositories {
 Next, add the dependency to your project's `build.gradle(.kts)` file:
 
 ```groovy
-implementation("io.appwrite:sdk-for-kotlin:9.0.0")
+implementation("io.appwrite:sdk-for-kotlin:9.1.0")
 ```
 
 ### Maven
@@ -50,7 +50,7 @@ Add this to your project's `pom.xml` file:
     <dependency>
         <groupId>io.appwrite</groupId>
         <artifactId>sdk-for-kotlin</artifactId>
-        <version>9.0.0</version>
+        <version>9.1.0</version>
     </dependency>
 </dependencies>
 ```
@@ -115,6 +115,77 @@ suspend fun main() {
 }
 ```
 
+### Type Safety with Models
+
+The Appwrite Kotlin SDK provides type safety when working with database documents through generic methods. Methods like `listDocuments`, `getDocument`, and others accept a `nestedType` parameter that allows you to specify your custom model type for full type safety.
+
+```kotlin
+data class Book(
+    val name: String,
+    val author: String,
+    val releaseYear: String? = null,
+    val category: String? = null,
+    val genre: List<String>? = null,
+    val isCheckedOut: Boolean
+)
+
+val databases = Databases(client)
+
+try {
+    val documents = databases.listDocuments(
+        databaseId = "your-database-id",
+        collectionId = "your-collection-id",
+        nestedType = Book::class.java // Pass in your custom model type
+    )
+    
+    for (book in documents.documents) {
+        Log.d("Appwrite", "Book: ${book.name} by ${book.author}") // Now you have full type safety
+    }
+} catch (e: AppwriteException) {
+    Log.e("Appwrite", e.message ?: "Unknown error")
+}
+```
+
+**Tip**: You can use the `appwrite types` command to automatically generate model definitions based on your Appwrite database schema. Learn more about [type generation](https://appwrite.io/docs/products/databases/type-generation).
+
+### Working with Model Methods
+
+All Appwrite models come with built-in methods for data conversion and manipulation:
+
+**`toMap()`** - Converts a model instance to a Map format, useful for debugging or manual data manipulation:
+```kotlin
+val account = Account(client)
+val user = account.get()
+val userMap = user.toMap()
+Log.d("Appwrite", userMap.toString()) // Prints all user properties as a Map
+```
+
+**`from(map:, nestedType:)`** - Creates a model instance from a Map, useful when working with raw data:
+```kotlin
+val userData: Map<String, Any> = mapOf(
+    "\$id" to "123",
+    "name" to "John",
+    "email" to "john@example.com"
+)
+val user = User.from(userData, User::class.java)
+```
+
+**JSON Serialization** - Models can be easily converted to/from JSON using Gson (which the SDK uses internally):
+```kotlin
+import com.google.gson.Gson
+
+val account = Account(client)
+val user = account.get()
+
+// Convert to JSON
+val gson = Gson()
+val jsonString = gson.toJson(user)
+Log.d("Appwrite", "User JSON: $jsonString")
+
+// Convert from JSON
+val userFromJson = gson.fromJson(jsonString, User::class.java)
+```
+
 ### Error Handling
 
 The Appwrite Kotlin SDK raises `AppwriteException` object with `message`, `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.
diff --git a/docs/examples/java/databases/create-document.md b/docs/examples/java/databases/create-document.md
@@ -4,9 +4,8 @@ import io.appwrite.services.Databases;
 
 Client client = new Client()
     .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
-    .setSession("") // The user session to authenticate with
-    .setKey("<YOUR_API_KEY>") // Your secret API key
-    .setJWT("<YOUR_JWT>"); // Your secret JSON Web Token
+    .setProject("<YOUR_PROJECT_ID>") // Your project ID
+    .setSession(""); // The user session to authenticate with
 
 Databases databases = new Databases(client);
 
diff --git a/docs/examples/java/databases/create-documents.md b/docs/examples/java/databases/create-documents.md
@@ -4,6 +4,7 @@ import io.appwrite.services.Databases;
 
 Client client = new Client()
     .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
+    .setProject("<YOUR_PROJECT_ID>") // Your project ID
     .setKey("<YOUR_API_KEY>"); // Your secret API key
 
 Databases databases = new Databases(client);
diff --git a/docs/examples/java/databases/decrement-document-attribute.md b/docs/examples/java/databases/decrement-document-attribute.md
@@ -0,0 +1,28 @@
+import io.appwrite.Client;
+import io.appwrite.coroutines.CoroutineCallback;
+import io.appwrite.services.Databases;
+
+Client client = new Client()
+    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
+    .setProject("<YOUR_PROJECT_ID>") // Your project ID
+    .setKey("<YOUR_API_KEY>"); // Your secret API key
+
+Databases databases = new Databases(client);
+
+databases.decrementDocumentAttribute(
+    "<DATABASE_ID>", // databaseId
+    "<COLLECTION_ID>", // collectionId
+    "<DOCUMENT_ID>", // documentId
+    "", // attribute
+    0, // value (optional)
+    0, // min (optional)
+    new CoroutineCallback<>((result, error) -> {
+        if (error != null) {
+            error.printStackTrace();
+            return;
+        }
+
+        System.out.println(result);
+    })
+);
+
diff --git a/docs/examples/java/databases/increment-document-attribute.md b/docs/examples/java/databases/increment-document-attribute.md
@@ -0,0 +1,28 @@
+import io.appwrite.Client;
+import io.appwrite.coroutines.CoroutineCallback;
+import io.appwrite.services.Databases;
+
+Client client = new Client()
+    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
+    .setProject("<YOUR_PROJECT_ID>") // Your project ID
+    .setKey("<YOUR_API_KEY>"); // Your secret API key
+
+Databases databases = new Databases(client);
+
+databases.incrementDocumentAttribute(
+    "<DATABASE_ID>", // databaseId
+    "<COLLECTION_ID>", // collectionId
+    "<DOCUMENT_ID>", // documentId
+    "", // attribute
+    0, // value (optional)
+    0, // max (optional)
+    new CoroutineCallback<>((result, error) -> {
+        if (error != null) {
+            error.printStackTrace();
+            return;
+        }
+
+        System.out.println(result);
+    })
+);
+
diff --git a/docs/examples/java/databases/upsert-document.md b/docs/examples/java/databases/upsert-document.md
@@ -0,0 +1,27 @@
+import io.appwrite.Client;
+import io.appwrite.coroutines.CoroutineCallback;
+import io.appwrite.services.Databases;
+
+Client client = new 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 = new Databases(client);
+
+databases.upsertDocument(
+    "<DATABASE_ID>", // databaseId
+    "<COLLECTION_ID>", // collectionId
+    "<DOCUMENT_ID>", // documentId
+    mapOf( "a" to "b" ), // data
+    listOf("read("any")"), // permissions (optional)
+    new CoroutineCallback<>((result, error) -> {
+        if (error != null) {
+            error.printStackTrace();
+            return;
+        }
+
+        System.out.println(result);
+    })
+);
+
diff --git a/docs/examples/java/databases/upsert-documents.md b/docs/examples/java/databases/upsert-documents.md
@@ -12,7 +12,7 @@ Databases databases = new Databases(client);
 databases.upsertDocuments(
     "<DATABASE_ID>", // databaseId
     "<COLLECTION_ID>", // collectionId
-    listOf(), // documents (optional)
+    listOf(), // documents
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
diff --git a/docs/examples/kotlin/databases/create-document.md b/docs/examples/kotlin/databases/create-document.md
@@ -4,9 +4,8 @@ import io.appwrite.services.Databases
 
 val 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
-    .setKey("<YOUR_API_KEY>") // Your secret API key
-    .setJWT("<YOUR_JWT>") // Your secret JSON Web Token
 
 val databases = Databases(client)
 
diff --git a/docs/examples/kotlin/databases/create-documents.md b/docs/examples/kotlin/databases/create-documents.md
@@ -4,6 +4,7 @@ import io.appwrite.services.Databases
 
 val client = Client()
     .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
+    .setProject("<YOUR_PROJECT_ID>") // Your project ID
     .setKey("<YOUR_API_KEY>") // Your secret API key
 
 val databases = Databases(client)
diff --git a/docs/examples/kotlin/databases/decrement-document-attribute.md b/docs/examples/kotlin/databases/decrement-document-attribute.md
@@ -0,0 +1,19 @@
+import io.appwrite.Client
+import io.appwrite.coroutines.CoroutineCallback
+import io.appwrite.services.Databases
+
+val client = Client()
+    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
+    .setProject("<YOUR_PROJECT_ID>") // Your project ID
+    .setKey("<YOUR_API_KEY>") // Your secret API key
+
+val databases = Databases(client)
+
+val response = databases.decrementDocumentAttribute(
+    databaseId = "<DATABASE_ID>",
+    collectionId = "<COLLECTION_ID>",
+    documentId = "<DOCUMENT_ID>",
+    attribute = "",
+    value = 0, // optional
+    min = 0 // optional
+)
diff --git a/docs/examples/kotlin/databases/increment-document-attribute.md b/docs/examples/kotlin/databases/increment-document-attribute.md
@@ -0,0 +1,19 @@
+import io.appwrite.Client
+import io.appwrite.coroutines.CoroutineCallback
+import io.appwrite.services.Databases
+
+val client = Client()
+    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
+    .setProject("<YOUR_PROJECT_ID>") // Your project ID
+    .setKey("<YOUR_API_KEY>") // Your secret API key
+
+val databases = Databases(client)
+
+val response = databases.incrementDocumentAttribute(
+    databaseId = "<DATABASE_ID>",
+    collectionId = "<COLLECTION_ID>",
+    documentId = "<DOCUMENT_ID>",
+    attribute = "",
+    value = 0, // optional
+    max = 0 // optional
+)
diff --git a/docs/examples/kotlin/databases/upsert-document.md b/docs/examples/kotlin/databases/upsert-document.md
@@ -0,0 +1,18 @@
+import io.appwrite.Client
+import io.appwrite.coroutines.CoroutineCallback
+import io.appwrite.services.Databases
+
+val 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
+
+val databases = Databases(client)
+
+val response = databases.upsertDocument(
+    databaseId = "<DATABASE_ID>",
+    collectionId = "<COLLECTION_ID>",
+    documentId = "<DOCUMENT_ID>",
+    data = mapOf( "a" to "b" ),
+    permissions = listOf("read("any")") // optional
+)
diff --git a/docs/examples/kotlin/databases/upsert-documents.md b/docs/examples/kotlin/databases/upsert-documents.md
@@ -12,5 +12,5 @@ val databases = Databases(client)
 val response = databases.upsertDocuments(
     databaseId = "<DATABASE_ID>",
     collectionId = "<COLLECTION_ID>",
-    documents = listOf() // optional
+    documents = listOf()
 )
diff --git a/src/main/kotlin/io/appwrite/Client.kt b/src/main/kotlin/io/appwrite/Client.kt
@@ -58,11 +58,11 @@ class Client @JvmOverloads constructor(
     init {
         headers = mutableMapOf(
             "content-type" to "application/json",
-            "user-agent" to "AppwriteKotlinSDK/9.0.0 ${System.getProperty("http.agent")}",
+            "user-agent" to "AppwriteKotlinSDK/9.1.0 ${System.getProperty("http.agent")}",
             "x-sdk-name" to "Kotlin",
             "x-sdk-platform" to "server",
             "x-sdk-language" to "kotlin",
-            "x-sdk-version" to "9.0.0",
+            "x-sdk-version" to "9.1.0",
             "x-appwrite-response-format" to "1.7.0",
         )
 
diff --git a/src/main/kotlin/io/appwrite/enums/BuildRuntime.kt b/src/main/kotlin/io/appwrite/enums/BuildRuntime.kt
@@ -77,6 +77,8 @@ enum class BuildRuntime(val value: String) {
     DART_3_3("dart-3.3"),
     @SerializedName("dart-3.5")
     DART_3_5("dart-3.5"),
+    @SerializedName("dart-3.8")
+    DART_3_8("dart-3.8"),
     @SerializedName("dotnet-6.0")
     DOTNET_6_0("dotnet-6.0"),
     @SerializedName("dotnet-7.0")
@@ -128,7 +130,9 @@ enum class BuildRuntime(val value: String) {
     @SerializedName("flutter-3.27")
     FLUTTER_3_27("flutter-3.27"),
     @SerializedName("flutter-3.29")
-    FLUTTER_3_29("flutter-3.29");
+    FLUTTER_3_29("flutter-3.29"),
+    @SerializedName("flutter-3.32")
+    FLUTTER_3_32("flutter-3.32");
 
     override fun toString() = value
 }
diff --git a/src/main/kotlin/io/appwrite/enums/ImageFormat.kt b/src/main/kotlin/io/appwrite/enums/ImageFormat.kt
@@ -14,7 +14,9 @@ enum class ImageFormat(val value: String) {
     @SerializedName("heic")
     HEIC("heic"),
     @SerializedName("avif")
-    AVIF("avif");
+    AVIF("avif"),
+    @SerializedName("gif")
+    GIF("gif");
 
     override fun toString() = value
 }
diff --git a/src/main/kotlin/io/appwrite/enums/Runtime.kt b/src/main/kotlin/io/appwrite/enums/Runtime.kt
diff --git a/src/main/kotlin/io/appwrite/models/AttributeString.kt b/src/main/kotlin/io/appwrite/models/AttributeString.kt
diff --git a/src/main/kotlin/io/appwrite/models/Document.kt b/src/main/kotlin/io/appwrite/models/Document.kt
diff --git a/src/main/kotlin/io/appwrite/services/Databases.kt b/src/main/kotlin/io/appwrite/services/Databases.kt
diff --git a/src/main/kotlin/io/appwrite/services/Tokens.kt b/src/main/kotlin/io/appwrite/services/Tokens.kt
diff --git a/src/main/kotlin/io/appwrite/services/Users.kt b/src/main/kotlin/io/appwrite/services/Users.kt
