Add Codable helpers for FunctionURL, APIGatewayV2, and SQS

Author: natanrolnik

Sources/AWSLambdaEvents/Codable Helpers/APIGatewayV2+Decode.swift

@@ -0,0 +1,48 @@
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
+import Foundation
+#endif
+
+import HTTPTypes
+
+public extension APIGatewayV2Request {
+    /// Decodes the body of the request into a `Data` object.
+    ///
+    /// - Returns: The decoded body as `Data` or `nil` if the body is empty.
+    func decodeBody() throws -> Data? {
+        guard let body else { return nil }
+
+        if isBase64Encoded,
+           let base64Decoded = Data(base64Encoded: body) {
+            return base64Decoded
+        }
+
+        return body.data(using: .utf8)
+    }
+
+    /// Decodes the body of the request into a decodable object. When the
+    /// body is empty, an error is thrown.
+    ///
+    /// - Parameters:
+    ///   - type: The type to decode the body into.
+    ///   - decoder: The decoder to use. Defaults to `JSONDecoder()`.
+    ///
+    /// - Returns: The decoded body as `T`.
+    /// - Throws: An error if the body cannot be decoded.
+    func decodeBody<T>(
+        _ type: T.Type,
+        using decoder: JSONDecoder = JSONDecoder()
+    ) throws -> T where T: Decodable {
+        let bodyData = body?.data(using: .utf8) ?? Data()
+
+        var requestData = bodyData
+
+        if isBase64Encoded,
+           let base64Decoded = Data(base64Encoded: requestData) {
+            requestData = base64Decoded
+        }
+
+        return try decoder.decode(T.self, from: requestData)
+    }
+}

Sources/AWSLambdaEvents/Codable Helpers/APIGatewayV2+Encode.swift

@@ -0,0 +1,41 @@
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
+import Foundation
+#endif
+
+import HTTPTypes
+
+public extension APIGatewayV2Response {
+    /// Encodes a given encodable object into a `APIGatewayV2Response` object.
+    ///
+    /// - Parameters:
+    ///   - encodable: The object to encode.
+    ///   - status: The status code to use. Defaults to `ok`.
+    ///   - encoder: The encoder to use. Defaults to a new `JSONEncoder`.
+    ///   - onError: A closure to handle errors, and transform them into a `APIGatewayV2Response`. Defaults
+    /// to converting the error into a 500 (Internal Server Error) response with the error message as the body.
+    static func encoding<T>(
+        _ encodable: T,
+        status: HTTPResponse.Status = .ok,
+        using encoder: JSONEncoder = JSONEncoder(),
+        onError: ((Error) -> Self)? = nil
+    ) -> Self where T: Encodable {
+        do {
+            let encodedResponse = try encoder.encode(encodable)
+            return APIGatewayV2Response(
+                statusCode: status,
+                body: String(data: encodedResponse, encoding: .utf8)
+            )
+        } catch {
+            return (onError ?? defaultErrorHandler)(error)
+        }
+    }
+}
+
+private func defaultErrorHandler(_ error: Error) -> APIGatewayV2Response {
+    APIGatewayV2Response(
+        statusCode: .internalServerError,
+        body: "Internal Server Error: \(String(describing: error))"
+    )
+}

Sources/AWSLambdaEvents/Codable Helpers/FunctionURL+Decode.swift

@@ -0,0 +1,48 @@
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
+import Foundation
+#endif
+
+import HTTPTypes
+
+public extension FunctionURLRequest {
+    /// Decodes the body of the request into a `Data` object.
+    ///
+    /// - Returns: The decoded body as `Data` or `nil` if the body is empty.
+    func decodeBody() throws -> Data? {
+        guard let body else { return nil }
+
+        if isBase64Encoded,
+           let base64Decoded = Data(base64Encoded: body) {
+            return base64Decoded
+        }
+
+        return body.data(using: .utf8)
+    }
+
+    /// Decodes the body of the request into a decodable object. When the
+    /// body is empty, an error is thrown.
+    ///
+    /// - Parameters:
+    ///   - type: The type to decode the body into.
+    ///   - decoder: The decoder to use. Defaults to `JSONDecoder()`.
+    ///
+    /// - Returns: The decoded body as `T`.
+    /// - Throws: An error if the body cannot be decoded.
+    func decodeBody<T>(
+        _ type: T.Type,
+        using decoder: JSONDecoder = JSONDecoder()
+    ) throws -> T where T: Decodable {
+        let bodyData = body?.data(using: .utf8) ?? Data()
+
+        var requestData = bodyData
+
+        if isBase64Encoded,
+           let base64Decoded = Data(base64Encoded: requestData) {
+            requestData = base64Decoded
+        }
+
+        return try decoder.decode(T.self, from: requestData)
+    }
+}

Sources/AWSLambdaEvents/Codable Helpers/FunctionURL+Encode.swift

@@ -0,0 +1,41 @@
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
+import Foundation
+#endif
+
+import HTTPTypes
+
+public extension FunctionURLResponse {
+    /// Encodes a given encodable object into a `FunctionURLResponse` object.
+    ///
+    /// - Parameters:
+    ///   - encodable: The object to encode.
+    ///   - status: The status code to use. Defaults to `ok`.
+    ///   - encoder: The encoder to use. Defaults to a new `JSONEncoder`.
+    ///   - onError: A closure to handle errors, and transform them into a `FunctionURLResponse`. Defaults
+    /// to converting the error into a 500 (Internal Server Error) response with the error message as the body.
+    static func encoding<T>(
+        _ encodable: T,
+        status: HTTPResponse.Status = .ok,
+        using encoder: JSONEncoder = JSONEncoder(),
+        onError: ((Error) -> Self)? = nil
+    ) -> Self where T: Encodable {
+        do {
+            let encodedResponse = try encoder.encode(encodable)
+            return FunctionURLResponse(
+                statusCode: status,
+                body: String(data: encodedResponse, encoding: .utf8)
+            )
+        } catch {
+            return (onError ?? defaultErrorHandler)(error)
+        }
+    }
+}
+
+private func defaultErrorHandler(_ error: Error) -> FunctionURLResponse {
+    FunctionURLResponse(
+        statusCode: .internalServerError,
+        body: "Internal Server Error: \(String(describing: error))"
+    )
+}

Sources/AWSLambdaEvents/Codable Helpers/SQS+Decode.swift

@@ -0,0 +1,41 @@
+#if canImport(FoundationEssentials)
+import FoundationEssentials
+#else
+import Foundation
+#endif
+
+public extension SQSEvent {
+    /// Decodes the records included in the event into an array of decodable objects.
+    ///
+    /// - Parameters:
+    ///   - type: The type to decode the body into.
+    ///   - decoder: The decoder to use. Defaults to a new `JSONDecoder`.
+    ///
+    /// - Returns: The decoded records as `[T]`.
+    /// - Throws: An error if any of the records cannot be decoded.
+    func decodeBody<T>(
+        _ type: T.Type,
+        using decoder: JSONDecoder = JSONDecoder()
+    ) throws -> [T] where T: Decodable {
+        try records.map {
+            try $0.decodeBody(type, using: decoder)
+        }
+    }
+}
+
+public extension SQSEvent.Message {
+    /// Decodes the body of the message into a decodable object.
+    ///
+    /// - Parameters:
+    ///   - type: The type to decode the body into.
+    ///   - decoder: The decoder to use. Defaults to a new `JSONDecoder`.
+    ///
+    /// - Returns: The decoded body as `T`.
+    /// - Throws: An error if the body cannot be decoded.
+    func decodeBody<T>(
+        _ type: T.Type,
+        using decoder: JSONDecoder = JSONDecoder()
+    ) throws -> T where T: Decodable {
+        try decoder.decode(T.self, from: body.data(using: .utf8) ?? Data())
+    }
+}