Merge pull request #96 from appwrite/dev

feat: Apple SDK update for version 13.5.0

Author: abnegate

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 13.5.0
+
+* Add `getScreenshot` method to `Avatars` service
+* Add `Theme`, `Timezone` and `Output` enums
+
 ## 13.4.0
 
 * Add `total` parameter to list queries allowing skipping counting rows in a table for improved performance

README.md

@@ -31,7 +31,7 @@ Add the package to your `Package.swift` dependencies:
 
 ```swift
     dependencies: [
-        .package(url: "[email protected]:appwrite/sdk-for-apple.git", from: "13.4.0"),
+        .package(url: "[email protected]:appwrite/sdk-for-apple.git", from: "13.5.0"),
     ],
 ```
 

Sources/Appwrite/Client.swift

@@ -5,6 +5,7 @@ import NIOSSL
 import Foundation
 import AsyncHTTPClient
 @_exported import AppwriteModels
+@_exported import JSONCodable
 
 let DASHDASH = "--"
 let CRLF = "\r\n"
@@ -23,7 +24,7 @@ open class Client {
         "x-sdk-name": "Apple",
         "x-sdk-platform": "client",
         "x-sdk-language": "apple",
-        "x-sdk-version": "13.4.0",
+        "x-sdk-version": "13.5.0",
         "x-appwrite-response-format": "1.8.0"
     ]
 

Sources/Appwrite/Services/Account.swift

@@ -654,7 +654,7 @@ open class Account: Service {
     open func createMfaChallenge(
         factor: AppwriteEnums.AuthenticationFactor
     ) async throws -> AppwriteModels.MfaChallenge {
-        let apiPath: String = "/account/mfa/challenge"
+        let apiPath: String = "/account/mfa/challenges"
 
         let apiParams: [String: Any?] = [
             "factor": factor
@@ -690,7 +690,7 @@ open class Account: Service {
     open func createMFAChallenge(
         factor: AppwriteEnums.AuthenticationFactor
     ) async throws -> AppwriteModels.MfaChallenge {
-        let apiPath: String = "/account/mfa/challenge"
+        let apiPath: String = "/account/mfa/challenges"
 
         let apiParams: [String: Any?] = [
             "factor": factor
@@ -731,7 +731,7 @@ open class Account: Service {
         challengeId: String,
         otp: String
     ) async throws -> AppwriteModels.Session {
-        let apiPath: String = "/account/mfa/challenge"
+        let apiPath: String = "/account/mfa/challenges"
 
         let apiParams: [String: Any?] = [
             "challengeId": challengeId,
@@ -772,7 +772,7 @@ open class Account: Service {
         challengeId: String,
         otp: String
     ) async throws -> AppwriteModels.Session {
-        let apiPath: String = "/account/mfa/challenge"
+        let apiPath: String = "/account/mfa/challenges"
 
         let apiParams: [String: Any?] = [
             "challengeId": challengeId,

Sources/Appwrite/Services/Avatars.swift

@@ -290,5 +290,96 @@ open class Avatars: Service {
         )
     }
 
+    ///
+    /// Use this endpoint to capture a screenshot of any website URL. This endpoint
+    /// uses a headless browser to render the webpage and capture it as an image.
+    /// 
+    /// You can configure the browser viewport size, theme, user agent,
+    /// geolocation, permissions, and more. Capture either just the viewport or the
+    /// full page scroll.
+    /// 
+    /// When width and height are specified, the image is resized accordingly. If
+    /// both dimensions are 0, the API provides an image at original size. If
+    /// dimensions are not specified, the default viewport size is 1280x720px.
+    ///
+    /// - Parameters:
+    ///   - url: String
+    ///   - headers: Any (optional)
+    ///   - viewportWidth: Int (optional)
+    ///   - viewportHeight: Int (optional)
+    ///   - scale: Double (optional)
+    ///   - theme: AppwriteEnums.Theme (optional)
+    ///   - userAgent: String (optional)
+    ///   - fullpage: Bool (optional)
+    ///   - locale: String (optional)
+    ///   - timezone: AppwriteEnums.Timezone (optional)
+    ///   - latitude: Double (optional)
+    ///   - longitude: Double (optional)
+    ///   - accuracy: Double (optional)
+    ///   - touch: Bool (optional)
+    ///   - permissions: [String] (optional)
+    ///   - sleep: Int (optional)
+    ///   - width: Int (optional)
+    ///   - height: Int (optional)
+    ///   - quality: Int (optional)
+    ///   - output: AppwriteEnums.Output (optional)
+    /// - Throws: Exception if the request fails
+    /// - Returns: ByteBuffer
+    ///
+    open func getScreenshot(
+        url: String,
+        headers: Any? = nil,
+        viewportWidth: Int? = nil,
+        viewportHeight: Int? = nil,
+        scale: Double? = nil,
+        theme: AppwriteEnums.Theme? = nil,
+        userAgent: String? = nil,
+        fullpage: Bool? = nil,
+        locale: String? = nil,
+        timezone: AppwriteEnums.Timezone? = nil,
+        latitude: Double? = nil,
+        longitude: Double? = nil,
+        accuracy: Double? = nil,
+        touch: Bool? = nil,
+        permissions: [String]? = nil,
+        sleep: Int? = nil,
+        width: Int? = nil,
+        height: Int? = nil,
+        quality: Int? = nil,
+        output: AppwriteEnums.Output? = nil
+    ) async throws -> ByteBuffer {
+        let apiPath: String = "/avatars/screenshots"
+
+        let apiParams: [String: Any?] = [
+            "url": url,
+            "headers": headers,
+            "viewportWidth": viewportWidth,
+            "viewportHeight": viewportHeight,
+            "scale": scale,
+            "theme": theme,
+            "userAgent": userAgent,
+            "fullpage": fullpage,
+            "locale": locale,
+            "timezone": timezone,
+            "latitude": latitude,
+            "longitude": longitude,
+            "accuracy": accuracy,
+            "touch": touch,
+            "permissions": permissions,
+            "sleep": sleep,
+            "width": width,
+            "height": height,
+            "quality": quality,
+            "output": output,
+            "project": client.config["project"]
+        ]
+
+        return try await client.call(
+            method: "GET",
+            path: apiPath,
+            params: apiParams
+        )
+    }
+
 
 }

Sources/Appwrite/Services/TablesDb.swift renamed to Sources/Appwrite/Services/TablesDB.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+public enum Output: String, CustomStringConvertible {
+    case jpg = "jpg"
+    case jpeg = "jpeg"
+    case png = "png"
+    case webp = "webp"
+    case heic = "heic"
+    case avif = "avif"
+    case gif = "gif"
+
+    public var description: String {
+        return rawValue
+    }
+}

Sources/AppwriteEnums/Output.swift

@@ -0,0 +1,10 @@
+import Foundation
+
+public enum Theme: String, CustomStringConvertible {
+    case light = "light"
+    case dark = "dark"
+
+    public var description: String {
+        return rawValue
+    }
+}