Support "webhookPingCreated" type payload

Author: treastrain

Package.swift

@@ -4,6 +4,7 @@ import PackageDescription
 
 let package = Package(
     name: "AppStoreConnectWebhook",
+    platforms: [.macOS(.v12)],
     products: [
         .library(
             name: "AppStoreConnectWebhook",

README.md

@@ -8,6 +8,33 @@ Type definitions for App Store Connect webhook notification payloads in Swift.
 [![X (formerly Twitter): @treastrain](https://img.shields.io/twitter/follow/treastrain?label=%40treastrain&style=social)](https://x.com/treastrain)
 [![Swift Build & Test](https://github.com/treastrain/AppStoreConnectWebhook/actions/workflows/swift.yml/badge.svg)](https://github.com/treastrain/AppStoreConnectWebhook/actions/workflows/swift.yml)
 
+# Usage
+```swift
+import AppStoreConnectWebhook
+import Foundation
+
+let payloadJSON = """
+    {
+        "data": {
+            "type": "webhookPingCreated",
+            "id": "01234567-abcd-8901-dcba-987654321012",
+            "version": 1,
+            "attributes": {
+                "timestamp": "2025-06-09T10:09:30.123456789Z"
+            }
+        }
+    }
+    """
+
+let payload = try AppStoreConnectWebhookPayload(json: payloadJSON)
+switch payload.data {
+case .webhookPingCreated(let webhookPingCreated):
+    webhookPingCreated.id  // "01234567-abcd-8901-dcba-987654321012"
+    webhookPingCreated.attributes.timestamp  // 2025-06-09T10:09:30.123Z
+// ...
+}
+```
+
 # How to add to your project
 ## Package dependencies
 ```swift

Sources/AppStoreConnectWebhook/AppStoreConnectWebhook.swift

@@ -0,0 +1,29 @@
+//
+//  AppStoreConnectWebhookPayload.swift
+//  AppStoreConnectWebhook
+//
+//  Created by treastrain on 2025/06/20.
+//
+
+public import Foundation
+
+public struct AppStoreConnectWebhookPayload: Codable, Sendable {
+    public let data: AppStoreConnectWebhookPayloadData
+
+    public init(data: AppStoreConnectWebhookPayloadData) {
+        self.data = data
+    }
+}
+
+extension AppStoreConnectWebhookPayload {
+    public init(json: String, using encoding: String.Encoding = .utf8) throws {
+        let data = json.data(using: encoding)!
+        let decoder = JSONDecoder()
+        decoder.dateDecodingStrategy = .iso8601IncludingFractionalSeconds
+        self = try decoder.decode(Self.self, from: data)
+    }
+}
+
+extension AppStoreConnectWebhookPayload: CustomStringConvertible {
+    public var description: String { logDescription }
+}

Sources/AppStoreConnectWebhook/AppStoreConnectWebhookPayload.swift

@@ -0,0 +1,61 @@
+//
+//  AppStoreConnectWebhookPayloadData.swift
+//  AppStoreConnectWebhook
+//
+//  Created by treastrain on 2025/06/20.
+//
+
+import Foundation
+
+public enum AppStoreConnectWebhookPayloadData: Sendable {
+    case webhookPingCreated(WebhookPingCreated)
+}
+
+enum AppStoreConnectWebhookPayloadDataType: String, Codable, Sendable {
+    case webhookPingCreated
+}
+
+extension AppStoreConnectWebhookPayloadData: Codable {
+    enum CodingKeys: CodingKey {
+        case type
+    }
+
+    public init(from decoder: any Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        guard container.allKeys.contains(.type) else {
+            throw DecodingError.typeMismatch(
+                AppStoreConnectWebhookPayloadData.self,
+                DecodingError.Context.init(
+                    codingPath: container.codingPath,
+                    debugDescription: "Missing 'type' key in payload data.",
+                    underlyingError: nil
+                )
+            )
+        }
+        let type = try container.decode(
+            AppStoreConnectWebhookPayloadDataType.self,
+            forKey: .type
+        )
+        switch type {
+        case .webhookPingCreated:
+            let webhookPingCreated = try WebhookPingCreated(from: decoder)
+            self = .webhookPingCreated(webhookPingCreated)
+        }
+    }
+
+    public func encode(to encoder: any Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        switch self {
+        case .webhookPingCreated(let webhookPingCreated):
+            try container.encode(
+                AppStoreConnectWebhookPayloadDataType.webhookPingCreated,
+                forKey: .type
+            )
+            try webhookPingCreated.encode(to: encoder)
+        }
+    }
+}
+
+extension AppStoreConnectWebhookPayloadData: CustomStringConvertible {
+    public var description: String { logDescription }
+}

Sources/AppStoreConnectWebhook/AppStoreConnectWebhookPayloadData.swift

@@ -0,0 +1,43 @@
+//
+//  AppStoreConnectWebhookPayloadDataWebhookPingCreated.swift
+//  AppStoreConnectWebhook
+//
+//  Created by treastrain on 2025/06/20.
+//
+
+public import Foundation
+
+extension AppStoreConnectWebhookPayloadData {
+    public struct WebhookPingCreated: Codable, Sendable {
+        public struct Attributes: Codable, Sendable {
+            public let timestamp: Date
+
+            public init(timestamp: Date) {
+                self.timestamp = timestamp
+            }
+        }
+
+        public let type: String
+        public let id: String
+        public let version: Int
+        public let attributes: Attributes
+
+        public init(
+            type: String,
+            id: String,
+            version: Int,
+            attributes: Attributes
+        ) {
+            self.type = type
+            self.id = id
+            self.version = version
+            self.attributes = attributes
+        }
+    }
+}
+
+extension AppStoreConnectWebhookPayloadData.WebhookPingCreated:
+    CustomStringConvertible
+{
+    public var description: String { logDescription }
+}

Sources/AppStoreConnectWebhook/AppStoreConnectWebhookPayloadDataWebhookPingCreated.swift

@@ -0,0 +1,36 @@
+//
+//  DateCodingStrategy.swift
+//  AppStoreConnectWebhook
+//
+//  Created by treastrain on 2025/06/20.
+//
+
+public import Foundation
+
+private let style = Date.ISO8601FormatStyle()
+    .year()
+    .month()
+    .day()
+    .timeZone(separator: .omitted)
+    .time(includingFractionalSeconds: true)
+    .timeSeparator(.colon)
+
+extension JSONDecoder.DateDecodingStrategy {
+    public static var iso8601IncludingFractionalSeconds: Self {
+        .custom {
+            try style.parse(
+                $0.singleValueContainer()
+                    .decode(String.self)
+            )
+        }
+    }
+}
+
+extension JSONEncoder.DateEncodingStrategy {
+    public static var iso8601IncludingFractionalSeconds: Self {
+        .custom {
+            var container = $1.singleValueContainer()
+            try container.encode(style.format($0))
+        }
+    }
+}

Sources/AppStoreConnectWebhook/DateCodingStrategy.swift

@@ -0,0 +1,26 @@
+//
+//  Encodable+.swift
+//  AppStoreConnectWebhook
+//
+//  Created by treastrain on 2025/06/20.
+//
+
+import Foundation
+
+private let logDescriptionEncoder = {
+    let encoder = JSONEncoder()
+    encoder.outputFormatting = [
+        .prettyPrinted,
+        .sortedKeys,
+        .withoutEscapingSlashes,
+    ]
+    encoder.dateEncodingStrategy = .iso8601IncludingFractionalSeconds
+    return encoder
+}()
+
+extension Encodable {
+    var logDescription: String {
+        let data = try! logDescriptionEncoder.encode(self)
+        return String(data: data, encoding: .utf8)!
+    }
+}

Sources/AppStoreConnectWebhook/Encodable+.swift

@@ -0,0 +1,73 @@
+//
+//  AppStoreConnectWebhookPayloadDataWebhookPingCreatedTests.swift
+//  AppStoreConnectWebhook
+//
+//  Created by treastrain on 2025/06/20.
+//
+
+import AppStoreConnectWebhook
+import Foundation
+import Testing
+
+struct AppStoreConnectWebhookPayloadDataWebhookPingCreatedTests {
+    @Test
+    func decode() throws {
+        let payloadJSON = """
+            {
+                "data": {
+                    "type": "webhookPingCreated",
+                    "id": "01234567-abcd-8901-dcba-987654321012",
+                    "version": 1,
+                    "attributes": {
+                        "timestamp": "2025-06-09T10:09:30.123456789Z"
+                    }
+                }
+            }
+            """
+        let payload = try AppStoreConnectWebhookPayload(json: payloadJSON)
+        guard case .webhookPingCreated(let webhookPingCreated) = payload.data
+        else {
+            Issue.record(
+                "Expected payload data to be of type WebhookPingCreated, but got \(payload.data)"
+            )
+            return
+        }
+
+        #expect(webhookPingCreated.type == "webhookPingCreated")
+        #expect(webhookPingCreated.id == "01234567-abcd-8901-dcba-987654321012")
+        #expect(webhookPingCreated.version == 1)
+        #expect(
+            webhookPingCreated.attributes.timestamp
+                == Date(timeIntervalSinceReferenceDate: 771156570.123456789)
+        )
+    }
+
+    @Test
+    func encode() throws {
+        let encoder = JSONEncoder()
+        encoder.dateEncodingStrategy = .iso8601IncludingFractionalSeconds
+        encoder.outputFormatting = [.sortedKeys]
+
+        let payload = AppStoreConnectWebhookPayload(
+            data: .webhookPingCreated(
+                AppStoreConnectWebhookPayloadData.WebhookPingCreated(
+                    type: "webhookPingCreated",
+                    id: "01234567-abcd-8901-dcba-987654321012",
+                    version: 1,
+                    attributes: .init(
+                        timestamp: Date(
+                            timeIntervalSinceReferenceDate: 771156570.123456789
+                        )
+                    )
+                )
+            )
+        )
+        let payloadData = try encoder.encode(payload)
+        let payloadJSON = String(data: payloadData, encoding: .utf8)!
+
+        #expect(
+            payloadJSON
+                == #"{"data":{"attributes":{"timestamp":"2025-06-09T10:09:30.123Z"},"id":"01234567-abcd-8901-dcba-987654321012","type":"webhookPingCreated","version":1}}"#
+        )
+    }
+}