Documentation

Author: grdsdev

Diff for: Sources/Functions/FunctionsClient.swift

@@ -1,14 +1,25 @@
 import Foundation
 
+/// An actor representing a client for invoking functions.
 public actor FunctionsClient {
+  /// Typealias for the fetch handler used to make requests.
   public typealias FetchHandler = @Sendable (_ request: URLRequest) async throws -> (
     Data, URLResponse
   )
 
+  /// The base URL for the functions.
   let url: URL
+  /// Headers to be included in the requests.
   var headers: [String: String]
+  /// The fetch handler used to make requests.
   let fetch: FetchHandler
 
+  /// Initializes a new instance of `FunctionsClient`.
+  ///
+  /// - Parameters:
+  ///   - url: The base URL for the functions.
+  ///   - headers: Headers to be included in the requests. (Default: empty dictionary)
+  ///   - fetch: The fetch handler used to make requests. (Default: URLSession.shared.data(for:))
   public init(
     url: URL,
     headers: [String: String] = [:],
@@ -21,63 +32,70 @@ public actor FunctionsClient {
   }
 
   /// Updates the authorization header.
-  /// - Parameter token: the new JWT token sent in the authorization header
+  ///
+  /// - Parameter token: The new JWT token sent in the authorization header.
   public func setAuth(token: String) {
     headers["Authorization"] = "Bearer \(token)"
   }
 
-  /// Invokes a function.
+  /// Invokes a function and decodes the response.
+  ///
   /// - Parameters:
-  ///   - functionName: the name of the function to invoke.
+  ///   - functionName: The name of the function to invoke.
+  ///   - invokeOptions: Options for invoking the function. (Default: empty `FunctionInvokeOptions`)
+  ///   - decode: A closure to decode the response data and HTTPURLResponse into a `Response` object.
+  /// - Returns: The decoded `Response` object.
   public func invoke<Response>(
     functionName: String,
     invokeOptions: FunctionInvokeOptions = .init(),
     decode: (Data, HTTPURLResponse) throws -> Response
   ) async throws -> Response {
     let (data, response) = try await rawInvoke(
-      functionName: functionName,
-      invokeOptions: invokeOptions
-    )
+      functionName: functionName, invokeOptions: invokeOptions)
     return try decode(data, response)
   }
 
-  /// Invokes a function.
+  /// Invokes a function and decodes the response as a specific type.
+  ///
   /// - Parameters:
-  ///   - functionName: the name of the function to invoke.
+  ///   - functionName: The name of the function to invoke.
+  ///   - invokeOptions: Options for invoking the function. (Default: empty `FunctionInvokeOptions`)
+  ///   - decoder: The JSON decoder to use for decoding the response. (Default: `JSONDecoder()`)
+  /// - Returns: The decoded object of type `T`.
   public func invoke<T: Decodable>(
     functionName: String,
     invokeOptions: FunctionInvokeOptions = .init(),
     decoder: JSONDecoder = JSONDecoder()
   ) async throws -> T {
-    try await invoke(
-      functionName: functionName,
-      invokeOptions: invokeOptions,
-      decode: { data, _ in try decoder.decode(T.self, from: data) }
-    )
+    try await invoke(functionName: functionName, invokeOptions: invokeOptions) { data, _ in
+      try decoder.decode(T.self, from: data)
+    }
   }
 
-  /// Invokes a function.
+  /// Invokes a function without expecting a response.
+  ///
   /// - Parameters:
-  ///   - functionName: the name of the function to invoke.
+  ///   - functionName: The name of the function to invoke.
+  ///   - invokeOptions: Options for invoking the function. (Default: empty `FunctionInvokeOptions`)
   public func invoke(
     functionName: String,
     invokeOptions: FunctionInvokeOptions = .init()
   ) async throws {
-    try await invoke(
-      functionName: functionName,
-      invokeOptions: invokeOptions,
-      decode: { _, _ in () }
-    )
+    try await invoke(functionName: functionName, invokeOptions: invokeOptions) { _, _ in () }
   }
 
   private func rawInvoke(
     functionName: String,
     invokeOptions: FunctionInvokeOptions
   ) async throws -> (Data, HTTPURLResponse) {
     let url = self.url.appendingPathComponent(functionName)
-
     var urlRequest = URLRequest(url: url)
-    urlRequest.allHTTPHeaderFields = invokeOptions.headers.merging(headers) { first, _ in first }
+
+    let headers = invokeOptions.headers.merging(self.headers) { invokeOption, _ in invokeOption }
+    headers.forEach { key, value in
+      urlRequest.setValue(value, forHTTPHeaderField: key)
+    }
+
     urlRequest.httpMethod = "POST"
     urlRequest.httpBody = invokeOptions.body
 

Diff for: Sources/Functions/Types.swift

@@ -1,21 +1,35 @@
 import Foundation
 
+/// An error type representing various errors that can occur while invoking functions.
 public enum FunctionsError: Error, LocalizedError {
+  /// Error indicating a relay error while invoking the Edge Function.
   case relayError
+  /// Error indicating a non-2xx status code returned by the Edge Function.
   case httpError(code: Int, data: Data)
 
+  /// A localized description of the error.
   public var errorDescription: String? {
     switch self {
-    case .relayError: return "Relay Error invoking the Edge Function"
-    case let .httpError(code, _): return "Edge Function returned a non-2xx status code: \(code)"
+    case .relayError:
+      return "Relay Error invoking the Edge Function"
+    case let .httpError(code, _):
+      return "Edge Function returned a non-2xx status code: \(code)"
     }
   }
 }
 
+/// Options for invoking a function.
 public struct FunctionInvokeOptions {
+  /// Headers to be included in the function invocation.
   let headers: [String: String]
+  /// Body data to be sent with the function invocation.
   let body: Data?
 
+  /// Initializes the `FunctionInvokeOptions` structure.
+  ///
+  /// - Parameters:
+  ///   - headers: Headers to be included in the function invocation. (Default: empty dictionary)
+  ///   - body: The body data to be sent with the function invocation. (Default: nil)
   public init(headers: [String: String] = [:], body: some Encodable) {
     var headers = headers
 
@@ -35,6 +49,9 @@ public struct FunctionInvokeOptions {
     self.headers = headers
   }
 
+  /// Initializes the `FunctionInvokeOptions` structure.
+  ///
+  /// - Parameter headers: Headers to be included in the function invocation. (Default: empty dictionary)
   public init(headers: [String: String] = [:]) {
     self.headers = headers
     body = nil