Inital commit. First working version with full PKPass model and worki…

…ng signing

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj

Package.resolved

@@ -0,0 +1,61 @@
+{
+  "object": {
+    "pins": [
+      {
+        "package": "Core",
+        "repositoryURL": "https://github.com/vapor/core.git",
+        "state": {
+          "branch": null,
+          "revision": "c64f63cb21631010952f7abfef719d376ab6a441",
+          "version": "3.9.1"
+        }
+      },
+      {
+        "package": "Crypto",
+        "repositoryURL": "https://github.com/vapor/crypto.git",
+        "state": {
+          "branch": null,
+          "revision": "df8eb7d8ae51787b3a0628aa3975e67666da936c",
+          "version": "3.3.3"
+        }
+      },
+      {
+        "package": "swift-nio",
+        "repositoryURL": "https://github.com/apple/swift-nio.git",
+        "state": {
+          "branch": null,
+          "revision": "ba7970fe396e8198b84c6c1b44b38a1d4e2eb6bd",
+          "version": "1.14.1"
+        }
+      },
+      {
+        "package": "swift-nio-ssl-support",
+        "repositoryURL": "https://github.com/apple/swift-nio-ssl-support.git",
+        "state": {
+          "branch": null,
+          "revision": "c02eec4e0e6d351cd092938cf44195a8e669f555",
+          "version": "1.0.0"
+        }
+      },
+      {
+        "package": "swift-nio-zlib-support",
+        "repositoryURL": "https://github.com/apple/swift-nio-zlib-support.git",
+        "state": {
+          "branch": null,
+          "revision": "37760e9a52030bb9011972c5213c3350fa9d41fd",
+          "version": "1.0.0"
+        }
+      },
+      {
+        "package": "ZIPFoundation",
+        "repositoryURL": "https://github.com/weichsel/ZIPFoundation.git",
+        "state": {
+          "branch": null,
+          "revision": "edbeaa39b426e54702194b0a601342322f01e400",
+          "version": "0.9.9"
+        }
+      }
+    ]
+  },
+  "version": 1
+}

Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version:5.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "wallet-kit",
+    platforms: [
+        .macOS(.v10_12)
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        // .package(url: /* package url */, from: "1.0.0"),
+        .package(url: "https://github.com/vapor/crypto.git", from: "3.0.0"),
+        .package(url: "https://github.com/weichsel/ZIPFoundation.git", .upToNextMajor(from: "0.9.0")),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(name: "Run", dependencies: ["WalletKit"]),
+        .target(
+            name: "WalletKit",
+            dependencies: ["Crypto", "ZIPFoundation"]),
+        .testTarget(
+            name: "WalletKitTests",
+            dependencies: ["WalletKit"]),
+    ]
+)

README.md

@@ -0,0 +1,3 @@
+# WalletKit
+
+Generate Apple Wallet passes (.pkpass) using Swift.

Sources/WalletKit/Models/Pass.swift

@@ -0,0 +1,141 @@
+//
+//  Pass.swift
+//  Async
+//
+//  Created by Jimmy Arts on 12/09/2019.
+//
+
+import Foundation
+
+/// See: https://developer.apple.com/library/archive/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/TopLevel.html
+public struct Pass: Codable {
+
+    /// - Standard Keys
+    /// Information that is required for all passes.
+
+    /// Brief description of the pass, used by the iOS accessibility technologies.
+    /// Don’t try to include all of the data on the pass in its description, just include enough detail to distinguish passes of the same type.
+    public var description: String
+
+    /// Version of the file format. The value must be 1.
+    public var formatVersion: Int
+    /// Display name of the organization that originated and signed the pass.
+    public var organizationName: String
+    /// Pass type identifier, as issued by Apple. The value must correspond with your signing certificate.
+    public var passTypeIdentifier: String
+    /// Serial number that uniquely identifies the pass. No two passes with the same pass type identifier may have the same serial number.
+    public var serialNumber: String
+    /// Team identifier of the organization that originated and signed the pass, as issued by Apple.
+    public var teamIdentifier: String
+
+    /// - Associated App Keys
+    /// Information about an app that is associated with a pass.
+
+    /// A URL to be passed to the associated app when launching it.
+    /// The app receives this URL in the application:didFinishLaunchingWithOptions: and application:openURL:options: methods of its app delegate.
+    /// If this key is present, the associatedStoreIdentifiers key must also be present.
+    public var appLaunchURL: String?
+    /// A list of iTunes Store item identifiers for the associated apps.
+    /// Only one item in the list is used—the first item identifier for an app compatible with the current device. If the app is not installed, the link opens the App Store and shows the app. If the app is already installed, the link launches the app.
+    public var associatedStoreIdentifiers: [Double]?
+
+    /// - Companion App Keys
+    /// Custom information about a pass provided for a companion app to use.
+
+    /// Custom information for companion apps. This data is not displayed to the user.
+    /// For example, a pass for a cafe could include information about the user’s favorite drink and sandwich in a machine-readable form for the companion app to read, making it easy to place an order for “the usual” from the app.
+    /// Available in iOS 7.0.
+    public var userInfo: [String: String]?
+
+    /// - Expiration Keys
+    /// Information about when a pass expires and whether it is still valid.
+    /// A pass is marked as expired if the current date is after the pass’s expiration date, or if the pass has been explicitly marked as voided.
+
+    /// Date and time when the pass expires.
+    /// The value must be a complete date with hours and minutes, and may optionally include seconds.
+    /// Available in iOS 7.0.
+    public var expirationDate: String?
+    /// Indicates that the pass is void—for example, a one time use coupon that has been redeemed. The default value is false.
+    /// Available in iOS 7.0.
+    public var voided: Bool?
+
+    /// - Relevance Keys
+    /// Information about where and when a pass is relevant.
+
+    /// Beacons marking locations where the pass is relevant.
+    public var beacons: [PassBeacon]?
+    /// Locations where the pass is relevant. For example, the location of your store.
+    public var locations: [PassLocation]?
+    /// Maximum distance in meters from a relevant latitude and longitude that the pass is relevant. This number is compared to the pass’s default distance and the smaller value is used.
+    public var maxDistance: Double?
+    /// Recommended for event tickets and boarding passes; otherwise optional.
+    /// Date and time when the pass becomes relevant. For example, the start time of a movie.
+    /// The value must be a complete date with hours and minutes, and may optionally include seconds.
+    public var relevantDate: String?
+
+    /// - Style Keys
+    /// Keys that specify the pass style
+    /// Provide exactly one key—the key that corresponds with the pass’s type.
+
+    /// Information specific to a boarding pass.
+    public var boardingPass: PassStructure?
+    /// Information specific to a coupon.
+    public var coupon: PassStructure?
+    /// Information specific to an event ticket.
+    public var eventTicket: PassStructure?
+    /// Information specific to a generic pass.
+    public var generic: PassStructure?
+    /// Information specific to a store card.
+    public var storeCard: PassStructure?
+
+    /// - Visual Appearance Keys
+    /// Keys that define the visual style and appearance of the pass.
+    /// With the release of iOS 9, there are two ways to display a barcode:
+    /// - The barcodes key (new and required for iOS 9 and later)
+    /// - The barcode key (for iOS 8 and earlier)
+    /// To support older versions of iOS, use both keys. The system automatically selects the barcodes array for iOS 9 and later and uses the barcode dictionary for iOS 8 and earlier.
+
+    /// Information specific to the pass’s barcode. For this dictionary’s keys, see Barcode Dictionary Keys.
+    @available(*, deprecated, message: "Deprecated in iOS 9.0 and later; use barcodes instead.")
+    public var barcode: PassBarcode?
+    /// Information specific to the pass’s barcode. The system uses the first valid barcode dictionary in the array. Additional dictionaries can be added as fallbacks. For this dictionary’s keys, see Barcode Dictionary Keys.
+    /// Note: Available only in iOS 9.0 and later.
+    public var barcodes: [PassBarcode]?
+    /// Background color of the pass, specified as an CSS-style RGB triple. For example, rgb(23, 187, 82).
+    public var backgroundColor: String?
+    /// Foreground color of the pass, specified as a CSS-style RGB triple. For example, rgb(100, 10, 110).
+    public var foregroundColor: String?
+    /// Optional for event tickets and boarding passes; otherwise not allowed. Identifier used to group related passes. If a grouping identifier is specified, passes with the same style, pass type identifier, and grouping identifier are displayed as a group. Otherwise, passes are grouped automatically.
+    /// Use this to group passes that are tightly related, such as the boarding passes for different connections of the same trip.
+    /// Available in iOS 7.0.
+    public var groupingIdentifier: String?
+    /// Color of the label text, specified as a CSS-style RGB triple. For example, rgb(255, 255, 255).
+    /// If omitted, the label color is determined automatically.
+    public var labelColor: String?
+    /// Text displayed next to the logo on the pass.
+    public var logoText: String?
+    /// If true, the strip image is displayed without a shine effect. The default value prior to iOS 7.0 is false.
+    /// In iOS 7.0, a shine effect is never applied, and this key is deprecated.
+    public var suppressStripShine: Bool?
+
+    /// - Web Service Keys
+    /// Information used to update passes using the web service.
+    /// If a web service URL is provided, an authentication token is required; otherwise, these keys are not allowed.
+
+    /// The authentication token to use with the web service. The token must be 16 characters or longer.
+    public var authenticationToken: String?
+    /// The URL of a web service that conforms to the API described in PassKit Web Service Reference (https://developer.apple.com/library/archive/documentation/PassKit/Reference/PassKit_WebService/WebService.html#//apple_ref/doc/uid/TP40011988).
+    /// The web service must use the HTTPS protocol; the leading https:// is included in the value of this key.
+    /// On devices configured for development, there is UI in Settings to allow HTTP web services.
+    public var webServiceURL: String?
+
+    /// - NFC-Enabled Pass Keys
+    /// NFC-enabled pass keys support sending reward card information as part of an Apple Pay transaction.
+    /// Important: NFC-enabled pass keys are only supported in passes that contain an Enhanced Passbook/NFC certificate. For more information, contact merchant support at https://developer.apple.com/contact/passkit/.
+    /// Passes can send reward card information to a terminal as part of an Apple Pay transaction. This feature requires a payment terminal that supports NFC-entitled passes. Specifically, the terminal must implement the Value Added Services Protocol.
+    /// Passes provide the required information using the nfc key. The value of this key is a dictionary containing the keys described in NFC Dictionary Keys. This functionality allows passes to act as the user’s credentials in the context of the NFC Value Added Service Protocol. It is available only for storeCard style passes.
+
+    /// Information used for Value Added Service Protocol transactions.
+    /// Available in iOS 9.0.
+    public var nfc: PassNFC?
+}

Sources/WalletKit/Models/PassBarcode.swift

@@ -0,0 +1,19 @@
+//
+//  PassBarcode.swift
+//  Async
+//
+//  Created by Jimmy Arts on 12/09/2019.
+//
+
+import Foundation
+
+public struct PassBarcode: Codable {
+    /// Text displayed near the barcode. For example, a human-readable version of the barcode data in case the barcode doesn’t scan.
+    public var altText: String?
+    /// Barcode format.
+    public var format: PassBarcodeFormat
+    /// Message or payload to be displayed as a barcode.
+    public var message: String
+    /// Text encoding that is used to convert the message from the string representation to a data representation to render the barcode. The value is typically iso-8859-1, but you may use another encoding that is supported by your barcode scanning infrastructure.
+    public var messageEncoding: PassCharacterEncoding?
+}

Sources/WalletKit/Models/PassBarcodeFormat.swift

@@ -0,0 +1,15 @@
+//
+//  PassBarcodeFormat.swift
+//  Async
+//
+//  Created by Jimmy Arts on 12/09/2019.
+//
+
+import Foundation
+
+public enum PassBarcodeFormat: String, Codable {
+    case qr = "PKBarcodeFormatQR"
+    case pdf = "PKBarcodeFormatPDF417"
+    case aztec = "PKBarcodeFormatAztec"
+    case code128 = "PKBarcodeFormatCode128"
+}

Sources/WalletKit/Models/PassBeacon.swift

@@ -0,0 +1,19 @@
+//
+//  PassBeacon.swift
+//  Async
+//
+//  Created by Jimmy Arts on 12/09/2019.
+//
+
+import Foundation
+
+public struct PassBeacon: Codable {
+    /// Major identifier of a Bluetooth Low Energy location beacon.
+    public var major: UInt16?
+    /// Minor identifier of a Bluetooth Low Energy location beacon.
+    public var minor: UInt16?
+    /// Unique identifier of a Bluetooth Low Energy location beacon.
+    public var proximityUUID: String
+    /// Text displayed on the lock screen when the pass is currently relevant. For example, a description of the nearby location such as “Store nearby on 1st and Main.”
+    public var relevantText: String?
+}