OneSecStanfordStudy

Stanford study integration module for the one sec app's Digital Interventions Outcome study.

Overview

This package combines the original interface and implementation packages into one package that depends on the Spezi monorepo.

The old two-package setup worked around a deployment-target mismatch by dynamically loading the iOS 18 implementation from a separate framework while exposing an iOS 15 interface package. The new single-repo version no longer needs that workaround: apps can depend on this single package and link the implementation directly.

Installation

Add this package to your app and select the OneSecStanfordStudy product. The package can be added to app targets that support iOS 15 or newer. The study integration is active on iOS 18 and newer; on older iOS versions, initialization and the root view modifier are no-ops.

This setup temporarily depends on the Spezi monorepo feature branch that adds the monorepo-backed deployment target support:

.package(url: "https://github.com/SchmiedmayerLab/Spezi.git", branch: "oldiOSVersion", traits: [])

After the Spezi changes are merged and tagged, replace the branch dependency with the tagged 0.x release range:

.package(url: "https://github.com/SchmiedmayerLab/Spezi.git", "0.1.0"..<"0.2.0", traits: [])

Then add the product dependency to the target that needs it:

.target(
    name: "MyApp",
    dependencies: [
        .product(name: "OneSecStanfordStudy", package: "OneSecStanfordStudy")
    ]
)

Usage

Call initializeOneSecStanfordStudy(_:launchOptions:healthExportConfig:) from your app delegate's application(_:willFinishLaunchingWithOptions:) method:

import OneSecStanfordStudy
import UIKit

final class AppDelegate: NSObject, UIApplicationDelegate {
    func application(
        _ application: UIApplication,
        willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
    ) -> Bool {
        initializeOneSecStanfordStudy(
            application,
            launchOptions: launchOptions,
            healthExportConfig: HealthExportConfiguration(
                destination: healthExportDirectory,
                sampleTypes: sampleTypes,
                timeRange: timeRange,
                didStartExport: { files in
                    // Upload or process the generated files.
                },
                didEndExport: {
                    // Handle completion.
                }
            )
        )
        return true
    }
}

Apply .oneSecStanfordStudy() to the root of your SwiftUI hierarchy:

WindowGroup {
    ContentView()
        .oneSecStanfordStudy()
}

The runtime is configured directly and OneSecStanfordStudyModule is available through SwiftUI environment injection:

@Environment(OneSecStanfordStudyModule.self) private var oneSec

Testing

The package includes unit tests in Tests/OneSecStanfordStudyTests and a consolidated iOS UI test app in Tests/UITests.

Run the UI test app with the TestApp scheme in Tests/UITests/UITests.xcodeproj. The test app has an iOS 15 deployment target. On iOS 15 and iOS 16, the wrapper launch test validates that initialization and .oneSecStanfordStudy() are no-ops. On iOS 18 and newer, the same app validates the active integration and the web view alert/confirm hooks.

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first. You can find a list of contributors in the CONTRIBUTORS.md file.

License

This project is licensed under the MIT License. See LICENSE.md for more information.

Citation

If you use this software, please cite it using the metadata in CITATION.cff, which GitHub surfaces through the Cite this repository button.

Our Research

For more information, visit the Schmiedmayer Lab GitHub organization.