Merge pull request #37 from appwrite/dev

Add inc/dec

Author: loks0n

CHANGELOG.md

@@ -1 +1,45 @@
-# Change Log
+# Change Log
+
+## 10.2.0
+
+* Update sdk to use swift-native doc comments instead of jsdoc styled comments as per [Swift Documentation Comments](https://github.com/swiftlang/swift/blob/main/docs/DocumentationComments.md)
+* Add `incrementDocumentAttribute` and `decrementDocumentAttribute` support to `Databases` service
+* Add `gif` support to `ImageFormat` enum
+* Add `sequence` support to `Document` model
+* Add `dart38` and `flutter332` support to runtime models
+
+## 10.1.0
+
+* Adds `upsertDocument` method
+* Adds warnings to bulk operation methods
+* Adds the new `encrypt` attribute
+* Adds runtimes: `flutter332` and `dart38`
+* Fix `select` Queries by updating internal attributes like `id`, `createdAt`, `updatedAt` etc. to be optional in `Document` model.
+* Fix `listCollection` errors by updating `attributes` typing
+* Fix querying datetime values by properly encoding URLs
+
+## 10.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
+
+## 9.0.0
+
+* Fix requests failing by removing `Content-Type` header from `GET` and `HEAD` requests
+
+## 8.0.0
+
+* Remove redundant titles from method descriptions.
+* Add `codable` models
+* Ensure response attribute in `AppwriteException` is always string
+
+## 7.0.0
+
+* Fix pong response & chunked upload

README.md

@@ -21,7 +21,7 @@ Appwrite is an open-source backend as a service server that abstract and simplif
 
 The Appwrite Swift SDK is available via Swift Package Manager. In order to use the Appwrite Swift SDK from Xcode, select File > **Add Packages**
 
-In the dialog that appears, enter the Appwrite Swift SDK [package URL](git@github.com:appwrite/sdk-for-swift.git) in the search field. Once found, select `sdk-for-apple`.
+In the dialog that appears, enter the Appwrite Swift SDK [package URL](git@github.com:appwrite/sdk-for-swift.git) in the search field. Once found, select `sdk-for-swift`.
 
 On the right, select your version rules and ensure your desired target is selected in the **Add to Project** field.
 
@@ -33,7 +33,7 @@ Add the package to your `Package.swift` dependencies:
 
 ```swift
     dependencies: [
-        .package(url: "git@github.com:appwrite/sdk-for-swift.git", from: "10.1.0"),
+        .package(url: "git@github.com:appwrite/sdk-for-swift.git", from: "10.2.0"),
     ],
 ```
 
@@ -118,6 +118,63 @@ func main() {
 }
 ```
 
+### Type Safety with Models
+
+The Appwrite Swift 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.
+
+```swift
+struct Book: Codable {
+    let name: String
+    let author: String
+    let releaseYear: String?
+    let category: String?
+    let genre: [String]?
+    let isCheckedOut: Bool
+}
+
+let databases = Databases(client)
+
+do {
+    let documents = try await databases.listDocuments(
+        databaseId: "your-database-id",
+        collectionId: "your-collection-id",
+        nestedType: Book.self // Pass in your custom model type
+    )
+    
+    for book in documents.documents {
+        print("Book: \(book.name) by \(book.author)") // Now you have full type safety
+    }
+} catch {
+    print(error.localizedDescription)
+}
+```
+
+**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 dictionary format, useful for debugging or manual data manipulation:
+```swift
+let user = try await account.get()
+let userMap = user.toMap()
+print(userMap) // Prints all user properties as a dictionary
+```
+
+**`from(map:)`** - Creates a model instance from a dictionary, useful when working with raw data:
+```swift
+let userData: [String: Any] = ["$id": "123", "name": "John", "email": "john@example.com"]
+let user = User.from(map: userData)
+```
+
+**`encode(to:)`** - Encodes the model to JSON format (part of Swift's Codable protocol), useful for serialization:
+```swift
+let user = try await account.get()
+let jsonData = try JSONEncoder().encode(user)
+let jsonString = String(data: jsonData, encoding: .utf8)
+```
+
 ### Error Handling
 
 When an error occurs, the Appwrite Swift SDK throws an `AppwriteError` object with `message` and `code` properties. You can handle any errors in a catch block and present the `message` or `localizedDescription` to the user or handle it yourself based on the provided error information. Below is an example.

Sources/Appwrite/Client.swift

@@ -21,7 +21,7 @@ open class Client {
         "x-sdk-name": "Swift",
         "x-sdk-platform": "server",
         "x-sdk-language": "swift",
-        "x-sdk-version": "10.1.0",
+        "x-sdk-version": "10.2.0",
         "x-appwrite-response-format": "1.7.0"
     ]