Add DTOs

Author: fpseverino

Package.swift

@@ -12,7 +12,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/vapor/fluent-kit.git", from: "1.49.0"),
-        .package(url: "https://github.com/fpseverino/swift-wallet.git", branch: "main"),
+        .package(url: "https://github.com/fpseverino/swift-wallet.git", from: "0.2.0"),
     ],
     targets: [
         .target(

Sources/FluentWallet/DTOs/LogEntriesDTO.swift

@@ -0,0 +1,11 @@
+/// An object that contains an array of messages.
+///
+/// See: [`LogEntries`](https://developer.apple.com/documentation/walletpasses/logentries)
+public struct LogEntriesDTO: Codable {
+    /// An array of log messages.
+    public let logs: [String]
+
+    public init(logs: [String]) {
+        self.logs = logs
+    }
+}

Sources/FluentWallet/DTOs/PushTokenDTO.swift

@@ -0,0 +1,11 @@
+/// An object that contains the push notification token for a registered pass on a device.
+///
+/// See: [`PushToken`](https://developer.apple.com/documentation/walletpasses/pushtoken)
+public struct PushTokenDTO: Codable {
+    /// A push token the server uses to send update notifications for a registered pass to a device.
+    public let pushToken: String
+
+    public init(pushToken: String) {
+        self.pushToken = pushToken
+    }
+}

Sources/FluentWalletOrders/DTOs/OrderIdentifiersDTO.swift

@@ -0,0 +1,17 @@
+import struct Foundation.Date
+
+/// The unique identifiers associated with orders.
+///
+/// See: [`OrderIdentifiers`](https://developer.apple.com/documentation/walletorders/orderidentifiers)
+public struct OrderIdentifiersDTO: Codable {
+    /// An array of order identifer strings.
+    public let orderIdentifiers: [String]
+
+    /// The date and time of when an order was last changed.
+    public let lastModified: String
+
+    public init(with orderIdentifiers: [String], maxDate: Date) {
+        self.orderIdentifiers = orderIdentifiers
+        self.lastModified = String(maxDate.timeIntervalSince1970)
+    }
+}

Sources/FluentWalletPasses/DTOs/PersonalizationDictionaryDTO.swift

@@ -0,0 +1,79 @@
+/// An object that contains the information you use to personalize a pass.
+///
+/// See: [`PersonalizationDictionary`](https://developer.apple.com/documentation/walletpasses/personalizationdictionary)
+public struct PersonalizationDictionaryDTO: Codable {
+    /// The personalization token for this request. The server must sign and return the token.
+    public let personalizationToken: String
+
+    /// An object that contains the user-entered information for a personalized pass.
+    public let requiredPersonalizationInfo: RequiredPersonalizationInfo
+
+    public init(
+        personalizationToken: String,
+        requiredPersonalizationInfo: RequiredPersonalizationInfo
+    ) {
+        self.personalizationToken = personalizationToken
+        self.requiredPersonalizationInfo = requiredPersonalizationInfo
+    }
+
+    /// An object that contains the user-entered information for a personalized pass.
+    ///
+    /// See: [`RequiredPersonalizationInfo`](https://developer.apple.com/documentation/walletpasses/personalizationdictionary/requiredpersonalizationinfo-data.dictionary)
+    public struct RequiredPersonalizationInfo: Codable {
+        /// The user-entered email address for the user of the personalized pass.
+        public let emailAddress: String?
+
+        /// The family name for the user of the personalized pass, parsed from the full name.
+        ///
+        /// The name can indicate membership in a group.
+        public let familyName: String?
+
+        /// The user-entered full name for the user of the personalized pass.
+        public let fullName: String?
+
+        /// The given name for the user of the personalized pass, parsed from the full name.
+        ///
+        /// The system uses the name to differentiate the individual from other members who share the same family name.
+        /// In some locales, the given name is also known as a _forename_ or _first name_.
+        public let givenName: String?
+
+        /// The ISO country code.
+        ///
+        /// The system sets this key when it’s known; otherwise, it doesn’t include the key.
+        public let isoCountryCode: String?
+
+        /// The user-entered phone number for the user of the personalized pass.
+        public let phoneNumber: String?
+
+        /// The user-entered postal code for the user of the personalized pass.
+        public let postalCode: String?
+
+        public init(
+            emailAddress: String? = nil,
+            familyName: String? = nil,
+            fullName: String? = nil,
+            givenName: String? = nil,
+            isoCountryCode: String? = nil,
+            phoneNumber: String? = nil,
+            postalCode: String? = nil
+        ) {
+            self.emailAddress = emailAddress
+            self.familyName = familyName
+            self.fullName = fullName
+            self.givenName = givenName
+            self.isoCountryCode = isoCountryCode
+            self.phoneNumber = phoneNumber
+            self.postalCode = postalCode
+        }
+
+        enum CodingKeys: String, CodingKey {
+            case emailAddress
+            case familyName
+            case fullName
+            case givenName
+            case isoCountryCode = "ISOCountryCode"
+            case phoneNumber
+            case postalCode
+        }
+    }
+}

Sources/FluentWalletPasses/DTOs/SerialNumbersDTO.swift

@@ -0,0 +1,17 @@
+import struct Foundation.Date
+
+/// An object that contains serial numbers for the updatable passes on a device.
+///
+/// See: [`SerialNumbers`](https://developer.apple.com/documentation/walletpasses/serialnumbers)
+public struct SerialNumbersDTO: Codable {
+    /// A developer-defined string that contains a tag that indicates the modification time for the returned passes.
+    public let lastUpdated: String
+
+    /// An array of serial numbers for the updated passes.
+    public let serialNumbers: [String]
+
+    public init(with serialNumbers: [String], maxDate: Date) {
+        lastUpdated = String(maxDate.timeIntervalSince1970)
+        self.serialNumbers = serialNumbers
+    }
+}

Tests/FluentWalletOrdersTests/FluentWalletOrdersTests.swift

@@ -1,9 +1,8 @@
 import FluentWalletOrders
+import Foundation
 import Testing
 import XCTFluent
 
-import struct Foundation.UUID
-
 @Suite("FluentWalletOrders Tests")
 struct FluentWalletOrdersTests {
     let test = ArrayTestDatabase()
@@ -107,4 +106,13 @@ struct FluentWalletOrdersTests {
 
         try await migration.revert(on: test.db)
     }
+
+    @Test("OrderIdentifiersDTO")
+    func orderIdentifiersDTO() {
+        let orderIdentifiers = ["Test Order Identifier"]
+        let maxDate = Date.now
+        let orderIdentifiersDTO = OrderIdentifiersDTO(with: orderIdentifiers, maxDate: maxDate)
+        #expect(orderIdentifiersDTO.orderIdentifiers == orderIdentifiers)
+        #expect(orderIdentifiersDTO.lastModified == String(maxDate.timeIntervalSince1970))
+    }
 }

Tests/FluentWalletPassesTests/FluentWalletPassesTests.swift

@@ -1,9 +1,8 @@
 import FluentWalletPasses
+import Foundation
 import Testing
 import XCTFluent
 
-import struct Foundation.UUID
-
 @Suite("FluentWalletPasses Tests")
 struct FluentWalletPassesTests {
     let test = ArrayTestDatabase()
@@ -154,4 +153,61 @@ struct FluentWalletPassesTests {
 
         try await migration.revert(on: test.db)
     }
+
+    @Test("SerialNumbersDTO")
+    func serialNumbersDTO() {
+        let serialNumbers = ["Test Serial Number 1", "Test Serial Number 2"]
+        let maxDate = Date.now
+        let serialNumbersDTO = SerialNumbersDTO(with: serialNumbers, maxDate: maxDate)
+        #expect(serialNumbersDTO.lastUpdated == String(maxDate.timeIntervalSince1970))
+        #expect(serialNumbersDTO.serialNumbers == serialNumbers)
+    }
+
+    @Test("PersonalizationDictionaryDTO")
+    func personalizationDictionaryDTO() throws {
+        let personalizationToken = "Test Personalization Token"
+        let requiredPersonalizationInfo = PersonalizationDictionaryDTO.RequiredPersonalizationInfo(
+            emailAddress: "Test Email Address",
+            familyName: "Test Family Name",
+            fullName: "Test Full Name",
+            givenName: "Test Given Name",
+            isoCountryCode: "Test ISO Country Code",
+            phoneNumber: "Test Phone Number",
+            postalCode: "Test Postal Code"
+        )
+        let personalizationDictionaryDTO = PersonalizationDictionaryDTO(
+            personalizationToken: personalizationToken,
+            requiredPersonalizationInfo: requiredPersonalizationInfo
+        )
+        #expect(personalizationDictionaryDTO.personalizationToken == personalizationToken)
+        #expect(personalizationDictionaryDTO.requiredPersonalizationInfo.emailAddress == requiredPersonalizationInfo.emailAddress)
+        #expect(personalizationDictionaryDTO.requiredPersonalizationInfo.familyName == requiredPersonalizationInfo.familyName)
+        #expect(personalizationDictionaryDTO.requiredPersonalizationInfo.fullName == requiredPersonalizationInfo.fullName)
+        #expect(personalizationDictionaryDTO.requiredPersonalizationInfo.givenName == requiredPersonalizationInfo.givenName)
+        #expect(personalizationDictionaryDTO.requiredPersonalizationInfo.isoCountryCode == requiredPersonalizationInfo.isoCountryCode)
+        #expect(personalizationDictionaryDTO.requiredPersonalizationInfo.phoneNumber == requiredPersonalizationInfo.phoneNumber)
+        #expect(personalizationDictionaryDTO.requiredPersonalizationInfo.postalCode == requiredPersonalizationInfo.postalCode)
+
+        // Test `PersonalizationDictionaryDTO.RequiredPersonalizationInfo` `CodingKeys`
+        let encoded = try JSONEncoder().encode(requiredPersonalizationInfo)
+        let jsonString = String(data: encoded, encoding: .utf8)!
+        #expect(jsonString.contains("ISOCountryCode"))
+        #expect(!jsonString.contains("isoCountryCode"))
+        let decoded = try JSONDecoder().decode(PersonalizationDictionaryDTO.RequiredPersonalizationInfo.self, from: encoded)
+        #expect(decoded.isoCountryCode == requiredPersonalizationInfo.isoCountryCode)
+    }
+
+    @Test("PushTokenDTO")
+    func pushTokenDTO() {
+        let pushToken = "Test Push Token"
+        let pushTokenDTO = PushTokenDTO(pushToken: pushToken)
+        #expect(pushTokenDTO.pushToken == pushToken)
+    }
+
+    @Test("LogEntriesDTO")
+    func logEntriesDTO() {
+        let logEntries = ["Test Log Entry 1", "Test Log Entry 2"]
+        let logEntriesDTO = LogEntriesDTO(logs: logEntries)
+        #expect(logEntriesDTO.logs == logEntries)
+    }
 }