Release candidate for 1.5.x

Author: abnegate

Package.swift

@@ -13,12 +13,17 @@ let package = Package(
     products: [
         .library(
             name: "Appwrite",
-            targets: ["Appwrite", "AppwriteModels", "JSONCodable"]
+            targets: [
+                "Appwrite",
+                "AppwriteEnums",
+                "AppwriteModels",
+                "JSONCodable"
+            ]
         ),
     ],
     dependencies: [
         .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.9.0"),
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.32.0")
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.32.0"),
     ],
     targets: [
         .target(
@@ -27,6 +32,7 @@ let package = Package(
                 .product(name: "AsyncHTTPClient", package: "async-http-client"),
                 .product(name: "NIOWebSocket", package: "swift-nio"),
                 "AppwriteModels",
+                "AppwriteEnums",
                 "JSONCodable"
             ]
         ),
@@ -36,6 +42,9 @@ let package = Package(
                 "JSONCodable"
             ]
         ),
+        .target(
+            name: "AppwriteEnums"
+        ),
         .target(
             name: "JSONCodable"
         ),

README.md

@@ -7,7 +7,7 @@
 [![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)
 
-**This SDK is compatible with Appwrite server version 1.4.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-swift/releases).**
+**This SDK is compatible with Appwrite server version 1.5.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-swift/releases).**
 
  > This is the Swift SDK for integrating with Appwrite from your Swift server-side code. If you're looking for the Apple SDK you should check [appwrite/sdk-for-apple](https://github.com/appwrite/sdk-for-apple)
 
@@ -33,7 +33,7 @@ Add the package to your `Package.swift` dependencies:
 
 ```swift
     dependencies: [
-        .package(url: "[email protected]:appwrite/sdk-for-swift.git", from: "4.1.0"),
+        .package(url: "[email protected]:appwrite/sdk-for-swift.git", from: "5.0.0-rc.2"),
     ],
 ```
 

Sources/Appwrite/Client.swift

@@ -14,32 +14,28 @@ open class Client {
     // MARK: Properties
     public static var chunkSize = 5 * 1024 * 1024 // 5MB
 
-    open var endPoint = "https://HOSTNAME/v1"
-
-    open var endPointRealtime: String? = nil
+    open var endPoint = "https://cloud.appwrite.io/v1"
 
     open var headers: [String: String] = [
-        "content-type": "",
+        "content-type": "application/json",
         "x-sdk-name": "Swift",
         "x-sdk-platform": "server",
         "x-sdk-language": "swift",
-        "x-sdk-version": "4.1.0",
-        "X-Appwrite-Response-Format": "1.4.0"
+        "x-sdk-version": "5.0.0-rc.2",
+        "x-appwrite-response-format": "1.4.0"
     ]
 
-    open var config: [String: String] = [:]
+    internal var config: [String: String] = [:]
 
-    open var selfSigned: Bool = false
+    internal var selfSigned: Bool = false
 
-    open var http: HTTPClient
+    internal var http: HTTPClient
 
-    private static let boundaryChars =
-        "abcdefghijklmnopqrstuvwxyz1234567890"
+    private static let boundaryChars = "abcdefghijklmnopqrstuvwxyz1234567890"
 
     private static let boundary = randomBoundary()
 
-    private static var eventLoopGroupProvider =
-        HTTPClient.EventLoopGroupProvider.createNew
+    private static var eventLoopGroupProvider = HTTPClient.EventLoopGroupProvider.singleton
 
     // MARK: Methods
 
@@ -149,49 +145,75 @@ open class Client {
         return self
     }
 
+    ///
+    /// Set Session
+    ///
+    /// The user session to authenticate with
+    ///
+    /// @param String value
+    ///
+    /// @return Client
+    ///
+    open func setSession(_ value: String) -> Client {
+        config["session"] = value
+        _ = addHeader(key: "X-Appwrite-Session", value: value)
+        return self
+    }
 
     ///
-    /// Set self signed
+    /// Set ForwardedFor
     ///
-    /// @param Bool status
+    /// The IP address of the client that made the request
+    ///
+    /// @param String value
     ///
     /// @return Client
     ///
-    open func setSelfSigned(_ status: Bool = true) -> Client {
-        self.selfSigned = status
-        try! http.syncShutdown()
-        http = Client.createHTTP(selfSigned: status)
+    open func setForwardedFor(_ value: String) -> Client {
+        config["forwardedfor"] = value
+        _ = addHeader(key: "X-Forwarded-For", value: value)
         return self
     }
 
     ///
-    /// Set endpoint
+    /// Set ForwardedUserAgent
     ///
-    /// @param String endPoint
+    /// The user agent string of the client that made the request
+    ///
+    /// @param String value
     ///
     /// @return Client
     ///
-    open func setEndpoint(_ endPoint: String) -> Client {
-        self.endPoint = endPoint
+    open func setForwardedUserAgent(_ value: String) -> Client {
+        config["forwardeduseragent"] = value
+        _ = addHeader(key: "X-Forwarded-User-Agent", value: value)
+        return self
+    }
 
-        if (self.endPointRealtime == nil && endPoint.starts(with: "http")) {
-            self.endPointRealtime = endPoint
-                .replacingOccurrences(of: "http://", with: "ws://")
-                .replacingOccurrences(of: "https://", with: "wss://")
-        }
 
+    ///
+    /// Set self signed
+    ///
+    /// @param Bool status
+    ///
+    /// @return Client
+    ///
+    open func setSelfSigned(_ status: Bool = true) -> Client {
+        self.selfSigned = status
+        try! http.syncShutdown()
+        http = Client.createHTTP(selfSigned: status)
         return self
     }
 
     ///
-    /// Set realtime endpoint.
+    /// Set endpoint
     ///
     /// @param String endPoint
     ///
     /// @return Client
     ///
-    open func setEndpointRealtime(_ endPoint: String) -> Client {
-        self.endPointRealtime = endPoint
+    open func setEndpoint(_ endPoint: String) -> Client {
+        self.endPoint = endPoint
 
         return self
     }
@@ -310,64 +332,47 @@ open class Client {
         withSink bufferSink: ((ByteBuffer) -> Void)? = nil,
         converter: ((Any) -> T)? = nil
     ) async throws -> T {
-        func complete(with response: HTTPClientResponse) async throws -> T {
-            switch response.status.code {
-            case 0..<400:
-                if response.headers["Set-Cookie"].count > 0 {
-                    UserDefaults.standard.set(
-                        response.headers["Set-Cookie"],
-                        forKey: URL(string: request.url)!.host! + "-cookies"
-                    )
-                }
-                switch T.self {
-                case is Bool.Type:
-                    return true as! T
-                case is ByteBuffer.Type:
-                    return try await response.body.collect(upTo: Int.max) as! T
-                default:
-                    let data = try await response.body.collect(upTo: Int.max)
-                    if data.readableBytes == 0 {
-                        return true as! T
-                    }
-                    let dict = try JSONSerialization.jsonObject(with: data) as? [String: Any]
+        let response = try await http.execute(
+            request,
+            timeout: .seconds(30)
+        )
 
-                    return converter?(dict!) ?? dict! as! T
-                }
+        switch response.status.code {
+        case 0..<400:
+            switch T.self {
+            case is Bool.Type:
+                return true as! T
+            case is ByteBuffer.Type:
+                return try await response.body.collect(upTo: Int.max) as! T
             default:
-                var message = ""
-                var data = try await response.body.collect(upTo: Int.max)
-                var type = ""
-                
-                do {
-                    let dict = try JSONSerialization.jsonObject(with: data) as? [String: Any]
-
-                    message = dict?["message"] as? String ?? response.status.reasonPhrase
-                    type = dict?["type"] as? String ?? ""
-                } catch {
-                    message =  data.readString(length: data.readableBytes)!
+                let data = try await response.body.collect(upTo: Int.max)
+                if data.readableBytes == 0 {
+                    return true as! T
                 }
+                let dict = try JSONSerialization.jsonObject(with: data) as? [String: Any]
 
-                throw AppwriteError(
-                    message: message,
-                    code: Int(response.status.code),
-                    type: type
-                )
+                return converter?(dict!) ?? dict! as! T
             }
-        }
+        default:
+            var message = ""
+            var data = try await response.body.collect(upTo: Int.max)
+            var type = ""
 
-        if bufferSink == nil {
-            let response = try await http.execute(
-                request, 
-                timeout: .seconds(30)
+            do {
+                let dict = try JSONSerialization.jsonObject(with: data) as? [String: Any]
+
+                message = dict?["message"] as? String ?? response.status.reasonPhrase
+                type = dict?["type"] as? String ?? ""
+            } catch {
+                message =  data.readString(length: data.readableBytes)!
+            }
+
+            throw AppwriteError(
+                message: message,
+                code: Int(response.status.code),
+                type: type
             )
-            return try await complete(with: response)
         }
-
-        let response = try await http.execute(
-            request,
-            timeout: .seconds(30)
-        )
-        return try await complete(with: response)
     }
 
     func chunkedUpload<T>(
@@ -426,7 +431,7 @@ open class Client {
         while offset < size {
             let slice = (input.data as! ByteBuffer).getSlice(at: offset, length: Client.chunkSize)
                 ?? (input.data as! ByteBuffer).getSlice(at: offset, length: Int(size - offset))
-            
+
             params[paramName] = InputFile.fromBuffer(slice!, filename: input.filename, mimeType: input.mimeType)
             headers["content-range"] = "bytes \(offset)-\(min((offset + Client.chunkSize) - 1, size - 1))/\(size)"
 
@@ -481,7 +486,12 @@ open class Client {
                 || param is [Bool: Any] {
                 encodedParams[key] = param
             } else {
-                encodedParams[key] = try! (param as! Encodable).toJson()
+                let value = try! (param as! Encodable).toJson()
+
+                let range = value.index(value.startIndex, offsetBy: 1)..<value.index(value.endIndex, offsetBy: -1)
+                let substring = value[range]
+
+                encodedParams[key] = substring
             }
         }
 
@@ -618,24 +628,3 @@ extension Client {
         return device
     }
 }
-
-extension Client {
-
-    public enum HTTPStatus: Int {
-      case unknown = -1
-      case ok = 200
-      case created = 201
-      case accepted = 202
-      case movedPermanently = 301
-      case found = 302
-      case badRequest = 400
-      case notAuthorized = 401
-      case paymentRequired = 402
-      case forbidden = 403
-      case notFound = 404
-      case methodNotAllowed = 405
-      case notAcceptable = 406
-      case internalServerError = 500
-      case notImplemented = 501
-    }
-}

Sources/Appwrite/Extensions/HTTPClientRequest+Cookies.swift

@@ -17,7 +17,7 @@ extension HTTPClientRequest {
 
 extension HTTPHeaders {
     public mutating func addDomainCookies(for domain: String) {
-        guard let cookies = UserDefaults.standard.stringArray(forKey: "\(domain)-cookies") else {
+        guard let cookies = UserDefaults.standard.stringArray(forKey: domain) else {
             return
         }
         for cookie in cookies {