API reference

The `SignIn` component renders a full app-native sign-in form. It drives the Flow Execution API loop automatically: initiating the flow, presenting the server-defined inputs and actions on each step, and completing when the user is authenticated. `SignIn` requires `.thunderIDProvider(config:)` in its ancestor view hierarchy.

import SwiftUI
import ThunderIDSwiftUI

struct AuthView: View {
    var body: some View {
        SignIn(applicationId: "<your-application-id>")
            .padding()
    }
}

The `SignInButton` component renders a pre-styled button that you can use to trigger your sign-in flow. It reads loading state from `ThunderIDState` and disables itself automatically while an operation is in progress. `SignInButton` requires `.thunderIDProvider(config:)` in its ancestor view hierarchy.

import SwiftUI
import ThunderIDSwiftUI

struct LandingView: View {
    var body: some View {
        SignInButton()
    }
}

The `SignOutButton` component renders a pre-styled button that calls `ThunderIDClient.signOut()`, then calls `ThunderIDState.refresh()` to update the reactive auth state. It disables itself automatically while the sign-out operation is in progress. `SignOutButton` requires `.thunderIDProvider(config:)` in its ancestor view hierarchy.

import SwiftUI
import ThunderIDSwiftUI

struct HomeView: View {
    var body: some View {
        VStack {
            Text("You are signed in.")
            SignOutButton()
        }
    }
}

The `SignUp` component renders a full app-native registration form. It drives the Flow Execution API registration loop automatically: initiating the flow, presenting the server-defined inputs and actions on each step, and completing when the user is registered and authenticated. `SignUp` requires `.thunderIDProvider(config:)` in its ancestor view hierarchy.

import SwiftUI
import ThunderIDSwiftUI

struct AuthView: View {
    @State private var showSignUp = false

    var body: some View {
        if showSignUp {
            SignUp(applicationId: "<your-application-id>")
                .padding()
        } else {
            SignIn(applicationId: "<your-application-id>")
                .padding()
        }
    }
}

The `SignedIn` component conditionally renders its content only when the user is authenticated. It reads the current sign-in state from `ThunderIDState` and displays protected UI for signed-in users, while rendering optional fallback content (or nothing) when the user is not authenticated. `SignedIn` requires `.thunderIDProvider(config:)` in its ancestor view hierarchy.

import SwiftUI
import ThunderIDSwiftUI

struct ContentView: View {
    var body: some View {
        SignedIn {
            Text("You are signed in.")
        }
    }
}

The `SignedOut` component conditionally renders its content only when the user is **not** authenticated. It reads the current sign-in state from `ThunderIDState` and displays content for unauthenticated users, while rendering optional fallback content (or nothing) when the user is signed in. `SignedOut` requires `.thunderIDProvider(config:)` in its ancestor view hierarchy.

import SwiftUI
import ThunderIDSwiftUI

struct ContentView: View {
    var body: some View {
        SignedOut {
            Text("Please sign in to continue.")
        }
    }
}

The `UserProfile` component renders an editable profile form. It loads the user's current profile from `/scim2/Me` when it appears, presents editable fields for `displayName` and `phoneNumbers`, and saves changes via `ThunderIDClient.updateUserProfile`. `UserProfile` requires `.thunderIDProvider(config:)` in its ancestor view hierarchy.

import SwiftUI
import ThunderIDSwiftUI

struct ProfileSheet: View {
    @Environment(\.dismiss) var dismiss

    var body: some View {
        UserProfile {
            dismiss()
        }
        .padding()
    }
}

The `ChangeCredential` view lets a signed-in user set a new value for one of their own credentials. It validates against the user type schema (`GET /users/me/meta`) and posts the change via `ThunderIDClient.updateUserCredentials`. Defaults to `password`; set `attribute` for another credential, such as a PIN. Requires `.thunderIDProvider(config:)` in the view hierarchy. Collects only a new value and its confirmation, not the current one, since the write path doesn't verify it today.

import SwiftUI
import ThunderIDSwiftUI

struct SecuritySection: View {
    var body: some View {
        VStack(alignment: .leading) {
            Text("Security")
            ChangeCredential()
        }
    }
}

`ThunderIDConfig` is the configuration struct passed to `ThunderIDClient.initialize(config:storage:)` and to the `.thunderIDProvider(config:)` view modifier.

import ThunderID

let config = ThunderIDConfig(
    baseUrl: "https://localhost:8090",
    clientId: "<your-client-id>",
    scopes: ["openid", "profile", "email"],
    afterSignInUrl: "io.thunderid.b2c://callback",
    afterSignOutUrl: "io.thunderid.b2c://logout",
    applicationId: "<your-application-id>"
)

`ThunderIDClient` is the core authentication client in the `ThunderID` package. It manages the full authentication lifecycle: initialization, sign-in (both app-native and redirect-based), session, token management, and user profile operations. When you use the `ThunderIDSwiftUI` package, a `ThunderIDClient` instance is created and managed automatically. You can access it via `ThunderIDState.client` from any view.

import ThunderID

let client = ThunderIDClient()

try await client.initialize(config: ThunderIDConfig(
    baseUrl: "https://localhost:8090",
    clientId: "<your-client-id>",
    scopes: ["openid", "profile", "email"],
    afterSignInUrl: "io.thunderid.b2c://callback",
    afterSignOutUrl: "io.thunderid.b2c://logout"
))

`ThunderIDState` is the reactive authentication state object provided by the `ThunderIDSwiftUI` package. It is an `ObservableObject` that holds the current user, loading state, and initialization status, and exposes the underlying `ThunderIDClient` for direct API calls. `ThunderIDState` is injected into the SwiftUI environment by the `.thunderIDProvider(config:)` modifier. Any view in the hierarchy can read it using `@EnvironmentObject`.

import SwiftUI
import ThunderIDSwiftUI

@main
struct MyApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
                .thunderIDProvider(config: ThunderIDConfig(
                    baseUrl: "https://localhost:8090",
                    clientId: "<your-client-id>",
                    afterSignInUrl: "io.thunderid.b2c://callback",
                    afterSignOutUrl: "io.thunderid.b2c://logout"
                ))
        }
    }
}