Abstract customer accounts api to ShopifyCustomerAccounts

[markmur]

Consumer API

import ShopifyCustomerAccounts
import UIKit

@MainActor
final class AccountService {
    private let client: CustomerAccountClient

    init() {
        let configuration = CustomerAccountConfiguration(
            shopID: "<shop-id>",
            clientID: "<customer-account-client-id>",
            redirectURI: URL(string: "myapp://customer-account/callback")!
            // browserSession defaults to .shared
        )

        client = CustomerAccountClient(configuration: configuration)
    }

    /// Call during app startup.
    func restoreSession() async {
        try? await client.restoreSession()
    }

    func signIn(from viewController: UIViewController) async throws {
        try await client.signIn(from: viewController)

        // Explicitly connect the account to your Storefront cart.
        let accessToken = try await client.accessToken()
        try await updateCartBuyerIdentity(
            customerAccessToken: accessToken
        )
    }

    func signOut(from viewController: UIViewController) async throws {
        // Performs Shopify's browser-based logout and clears local credentials.
        try await client.signOut(from: viewController)

        // App-owned cleanup remains explicit.
        try await resetCart()
    }

    func clearLocalSession() throws {
        // Clears this app's credentials without browser-based logout.
        try client.clearSession()
    }
}

The app must register the redirect URI's custom scheme (in this example, myapp) under CFBundleURLTypes.

The browser session is shared by default. Consumers can opt into an isolated session with browserSession: .ephemeral.

ShopifyCustomerAccounts owns authentication and token management, while cart integration remains explicit and app-owned.

---

Before you merge

Important

• I've added tests to support my implementation
• I have read and agree with the Contribution Guidelines
• I have read and agree with the Code of Conduct
• I've updated the relevant platform README (platforms/swift/README.md and/or platforms/android/README.md)

---

Releasing a new Swift version?

• I have bumped the version in ShopifyCheckoutKit.podspec
• I have bumped the version in platforms/swift/Sources/ShopifyCheckoutKit/ShopifyCheckoutKit.swift
• I have updated the SwiftPM/CocoaPods version snippets in platforms/swift/README.md (major version only)

Releasing a new Embedded Checkout Protocol version?

• I have bumped embeddedCheckoutProtocolAndroid in platforms/android/gradle/libs.versions.toml
• I have updated protocol/languages/kotlin/embedded-checkout-protocol/api/embedded-checkout-protocol.api if the public API changed

Releasing a new Android version?

• I have bumped checkoutKitAndroid in platforms/android/gradle/libs.versions.toml
• I have updated the Gradle/Maven version snippets in platforms/android/README.md

Tip

See the Contributing documentation for the full release process per platform.

[markmur]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• Abstract customer accounts api to ShopifyCustomerAccounts #512 👈 (View in Graphite)
• Migrate Android sample to AuthTabIntent #513
• Migrate Swift sample from WKWebView to ASWebAuthenticationSession #511
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.