Rename ShopifyCheckoutProtocol to EmbeddedCheckoutProtocol (#354)

* Rename ShopifyCheckoutProtocol to EmbeddedCheckoutProtocol

* Dump swift API

Author: markmur

.github/CONTRIBUTING.md

@@ -100,7 +100,7 @@ cd platforms/swift && ./Scripts/lint fix
 
 ### Public API surface
 
-The library's public API is tracked via committed baselines under `platforms/swift/api/`, one JSON file per module (`ShopifyCheckoutProtocol.json`, `ShopifyCheckoutKit.json`, `ShopifyAcceleratedCheckouts.json`). They are produced by `xcrun swift-api-digester -dump-sdk` against the built `.swiftmodule` files. The unified `Breaking Changes` CI workflow runs `dev swift api check` on every PR that touches Swift sources and fails if the digester output for any module diverges from its committed baseline.
+The library's public API is tracked via committed baselines under `platforms/swift/api/`, one JSON file per module (`EmbeddedCheckoutProtocol.json`, `ShopifyCheckoutKit.json`, `ShopifyAcceleratedCheckouts.json`). They are produced by `xcrun swift-api-digester -dump-sdk` against the built `.swiftmodule` files. The unified `Breaking Changes` CI workflow runs `dev swift api check` on every PR that touches Swift sources and fails if the digester output for any module diverges from its committed baseline.
 
 If your change intentionally modifies the public API:
 

.swiftlint.yml

@@ -15,7 +15,7 @@ included:
 excluded:
   - platforms/swift/Samples
   - platforms/swift/Sources/ShopifyCheckoutKit/Models.swift
-  - protocol/languages/swift/Sources/ShopifyCheckoutProtocol/Generated
+  - protocol/languages/swift/Sources/UniversalCommerceProtocol/EmbeddedCheckoutProtocol/Generated
 
 opt_in_rules:
   - array_init

Package.swift

@@ -19,8 +19,8 @@ let package = Package(
             targets: ["ShopifyAcceleratedCheckouts"]
         ),
         .library(
-            name: "ShopifyCheckoutProtocol",
-            targets: ["ShopifyCheckoutProtocol"]
+            name: "EmbeddedCheckoutProtocol",
+            targets: ["EmbeddedCheckoutProtocol"]
         )
     ],
     dependencies: [
@@ -32,12 +32,12 @@ let package = Package(
         // 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 this package depends on.
         .target(
-            name: "ShopifyCheckoutProtocol",
-            path: "protocol/languages/swift/Sources/ShopifyCheckoutProtocol"
+            name: "EmbeddedCheckoutProtocol",
+            path: "protocol/languages/swift/Sources/UniversalCommerceProtocol/EmbeddedCheckoutProtocol"
         ),
         .target(
             name: "ShopifyCheckoutKit",
-            dependencies: ["ShopifyCheckoutProtocol"],
+            dependencies: ["EmbeddedCheckoutProtocol"],
             path: "platforms/swift/Sources/ShopifyCheckoutKit",
             resources: [.process("Assets.xcassets")]
         ),
@@ -48,9 +48,9 @@ let package = Package(
             resources: [.process("Localizable.xcstrings"), .process("Media.xcassets")]
         ),
         .testTarget(
-            name: "ShopifyCheckoutProtocolTests",
-            dependencies: ["ShopifyCheckoutProtocol"],
-            path: "protocol/languages/swift/Tests/ShopifyCheckoutProtocolTests",
+            name: "EmbeddedCheckoutProtocolTests",
+            dependencies: ["EmbeddedCheckoutProtocol"],
+            path: "protocol/languages/swift/Tests/EmbeddedCheckoutProtocolTests",
             resources: [.copy("Fixtures")]
         ),
         .testTarget(

README.md

@@ -32,7 +32,7 @@ This repository contains the Checkout Kit implementations, samples, and protocol
 | `com.shopify:checkout-kit` | `4.0.0-alpha.1` | Maven Central | Alpha | Android checkout dialog SDK. | [Android](platforms/android/README.md) |
 | `@shopify/checkout-kit-react-native` | `4.0.0-alpha.2` | npm `next` dist-tag | Alpha | React Native wrapper for the iOS and Android native SDKs. | [React Native](platforms/react-native/README.md) |
 | `@shopify/checkout-kit` | `4.0.0-alpha.2` | npm `next` dist-tag | Alpha | Web component for opening Shopify checkout from a web page. | [Web](platforms/web/README.md) |
-| `ShopifyCheckoutProtocol` | Source package | Swift Package Manager | Internal/supporting | Swift client for Embedded Checkout Protocol messages. | [Protocol Swift](protocol/languages/swift/README.md) |
+| `EmbeddedCheckoutProtocol` | Source package | Swift Package Manager | Internal/supporting | Swift client for Embedded Checkout Protocol messages. | [Protocol Swift](protocol/languages/swift/README.md) |
 
 Swift, Android, and React Native rows show the planned first Checkout Kit alpha releases. Web is already published as `4.0.0-alpha.2`.
 

ShopifyCheckoutKit.podspec

@@ -27,7 +27,7 @@ Pod::Spec.new do |s|
   s.subspec 'Core' do |core|
     core.source_files = [
       'platforms/swift/Sources/ShopifyCheckoutKit/**/*.swift',
-      'protocol/languages/swift/Sources/ShopifyCheckoutProtocol/**/*.swift',
+      'protocol/languages/swift/Sources/UniversalCommerceProtocol/EmbeddedCheckoutProtocol/**/*.swift',
     ]
     core.resource_bundles = {
       'ShopifyCheckoutKit' => ['platforms/swift/Sources/ShopifyCheckoutKit/Assets.xcassets']

dev.yml

@@ -348,7 +348,7 @@ commands:
           cd platforms/swift
           # ShopifyCheckoutKit-Package is the SPM-wide scheme: it cleans all
           # library targets in Package.swift (ShopifyCheckoutKit,
-          # ShopifyAcceleratedCheckouts, ShopifyCheckoutProtocol) in one pass.
+          # ShopifyAcceleratedCheckouts, EmbeddedCheckoutProtocol) in one pass.
           ./Scripts/xcode_run clean ShopifyCheckoutKit-Package
           cd Samples
           # Sample apps have a "Run Script" build phase that runs during clean

platforms/swift/.swiftformat

@@ -10,6 +10,6 @@
 --swiftversion 5.7.1
 --extensionacl on-declarations
 --exclude Sources/ShopifyCheckoutKit/Models.swift
---exclude Sources/ShopifyCheckoutProtocol/Generated
+--exclude Sources/UniversalCommerceProtocol/EmbeddedCheckoutProtocol/Generated
 --exclude Samples/CheckoutKitSwiftDemo/CheckoutKitSwiftDemo/Sources/Generated
 --exclude Samples/ShopifyAcceleratedCheckoutsApp/ShopifyAcceleratedCheckoutsApp/Generated

platforms/swift/README.md

@@ -71,7 +71,7 @@ Then add the products you need to your app target:
   name: "YourApp",
   dependencies: [
     "ShopifyCheckoutKit",
-    "ShopifyCheckoutProtocol",
+    "EmbeddedCheckoutProtocol",
     "ShopifyAcceleratedCheckouts" // Only needed for accelerated checkout buttons.
   ]
 )
@@ -237,11 +237,11 @@ let configuration = ShopifyCheckoutKit.configuration
 - `checkoutDidCancel()` fires when the buyer closes the checkout sheet.
 - `checkoutDidFail(error:)` fires when checkout cannot continue.
 
-Typed checkout state, including completion, flows through `ShopifyCheckoutProtocol`.
+Typed checkout state, including completion, flows through `EmbeddedCheckoutProtocol`.
 
 ```swift
 import ShopifyCheckoutKit
-import ShopifyCheckoutProtocol
+import EmbeddedCheckoutProtocol
 
 let client = CheckoutProtocol.Client()
   .on(CheckoutProtocol.start) { checkout in

platforms/swift/Samples/CheckoutKitSwiftDemo/CheckoutKitSwiftDemo/Sources/App/CheckoutCoordinator.swift

@@ -1,6 +1,6 @@
+import EmbeddedCheckoutProtocol
 import OSLog
 import ShopifyCheckoutKit
-import ShopifyCheckoutProtocol
 import UIKit
 
 class CheckoutCoordinator: UIViewController {

platforms/swift/Samples/CheckoutKitSwiftDemo/CheckoutKitSwiftDemo/Sources/CheckoutProtocolClient.swift

@@ -1,6 +1,6 @@
+import EmbeddedCheckoutProtocol
 import SafariServices
 import ShopifyCheckoutKit
-import ShopifyCheckoutProtocol
 import UIKit
 
 extension CheckoutProtocol.Client {