Compare commits
No commits in common. "3019e19d5b24f4c71666a7e5a0da76d16bca8688" and "d8e49d8d8db563b44ee8a67d12d1e7f65fd2d028" have entirely different histories.
3019e19d5b
...
d8e49d8d8d
@ -8,7 +8,6 @@
|
||||
import SwiftUI
|
||||
import LocalData
|
||||
|
||||
/// Defines all demo destinations and provides display metadata for the list.
|
||||
enum DemoDestination: Hashable, CaseIterable {
|
||||
case userDefaults
|
||||
case keychain
|
||||
@ -17,8 +16,6 @@ enum DemoDestination: Hashable, CaseIterable {
|
||||
case sync
|
||||
case migration
|
||||
|
||||
/// Type-erased destination view for NavigationStack routing.
|
||||
/// The enum keeps navigation data-driven and centralized.
|
||||
var view: some View {
|
||||
switch self {
|
||||
case .userDefaults:
|
||||
@ -71,7 +68,6 @@ enum DemoDestination: Hashable, CaseIterable {
|
||||
}
|
||||
}
|
||||
|
||||
/// Root navigation list that links to each LocalData demo screen.
|
||||
struct ContentView: View {
|
||||
var body: some View {
|
||||
NavigationStack {
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
import SwiftUI
|
||||
|
||||
/// Design tokens for spacing and common UI colors used in the sample.
|
||||
enum Design {
|
||||
enum Spacing {
|
||||
static let xSmall: CGFloat = 4
|
||||
@ -11,7 +10,6 @@ enum Design {
|
||||
}
|
||||
|
||||
extension Color {
|
||||
/// Semantic colors used for status messaging in demo screens.
|
||||
enum Status {
|
||||
static let success = Color.green
|
||||
static let info = Color.blue
|
||||
@ -19,7 +17,6 @@ extension Color {
|
||||
static let error = Color.red
|
||||
}
|
||||
|
||||
/// Semantic text colors for secondary labels.
|
||||
enum Text {
|
||||
static let secondary = Color.secondary
|
||||
}
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
|
||||
/// Simple credential model for the Keychain demo.
|
||||
/// Using `Codable` keeps the storage path identical to more complex real-world credentials.
|
||||
/// Simple credential model for keychain storage demo.
|
||||
nonisolated
|
||||
struct Credential: Codable, Sendable {
|
||||
let username: String
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
import Foundation
|
||||
|
||||
/// Structured name model used in migration demos.
|
||||
/// This replaces a legacy single-string name with distinct components.
|
||||
nonisolated struct ProfileName: Codable, Sendable {
|
||||
let firstName: String
|
||||
let lastName: String
|
||||
|
||||
@ -1,8 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// Identifiers for custom key material sources used by the sample.
|
||||
/// LocalData uses these identifiers to look up registered providers.
|
||||
nonisolated enum SampleKeyMaterialSources {
|
||||
nonisolated static let external = KeyMaterialSource(id: "sample.external.key")
|
||||
}
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
|
||||
/// Lightweight location model for the Keychain demo.
|
||||
/// It shows that LocalData can store structured data even in secure domains.
|
||||
/// Location data model.
|
||||
nonisolated
|
||||
struct SampleLocationData: Codable, Sendable {
|
||||
let lat: Double
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
import Foundation
|
||||
|
||||
/// Aggregated settings model produced by migration demos.
|
||||
/// It combines multiple legacy settings into a single modern payload.
|
||||
nonisolated struct UnifiedSettings: Codable, Sendable {
|
||||
let notificationsEnabled: Bool
|
||||
let theme: String
|
||||
|
||||
@ -10,13 +10,9 @@ import LocalData
|
||||
import SharedKit
|
||||
|
||||
@main
|
||||
/// App entry point that centralizes LocalData configuration and storage key registration.
|
||||
/// Keeping this bootstrap in one place makes the sample's storage behavior easy to audit.
|
||||
struct SecureStorageSampleApp: App {
|
||||
init() {
|
||||
// Log derived identifiers up front so it's obvious which services the sample uses.
|
||||
StorageServiceIdentifiers.logConfiguration()
|
||||
// Spin up WCSession early so background sync opportunities aren't missed.
|
||||
_ = WatchConnectivityService.shared
|
||||
Task {
|
||||
// 1. Global Encryption Configuration
|
||||
@ -51,18 +47,15 @@ struct SecureStorageSampleApp: App {
|
||||
)
|
||||
await StorageRouter.shared.updateStorageConfiguration(storageConfig)
|
||||
|
||||
// Register keys once so LocalData can validate and migrate them consistently.
|
||||
do {
|
||||
try await StorageRouter.shared.registerCatalog(AppStorageCatalog(), migrateImmediately: true)
|
||||
} catch {
|
||||
assertionFailure("Storage catalog registration failed: \(error)")
|
||||
}
|
||||
// Provide external key material for the encrypted storage demo.
|
||||
await StorageRouter.shared.registerKeyMaterialProvider(
|
||||
ExternalKeyMaterialProvider(),
|
||||
for: SampleKeyMaterialSources.external
|
||||
)
|
||||
// If a watch is paired, send the current syncable payloads on launch.
|
||||
await StorageRouter.shared.syncRegisteredKeysIfNeeded()
|
||||
}
|
||||
#if DEBUG
|
||||
|
||||
@ -3,11 +3,8 @@ import LocalData
|
||||
import SharedKit
|
||||
|
||||
|
||||
/// Catalog of all storage keys used by the sample app.
|
||||
/// Registering a catalog allows LocalData to audit keys and run migrations up front.
|
||||
struct AppStorageCatalog: StorageKeyCatalog {
|
||||
var allKeys: [AnyStorageKey] {
|
||||
// Order here is purely for readability in audit reports.
|
||||
[
|
||||
.key(.appVersion),
|
||||
.key(.userPreferences),
|
||||
|
||||
@ -2,22 +2,18 @@ import CryptoKit
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// Supplies external key material for the encrypted storage demo.
|
||||
/// The provider persists the generated key material so encryption remains stable across launches.
|
||||
nonisolated
|
||||
struct ExternalKeyMaterialProvider: KeyMaterialProviding {
|
||||
private enum Constants {
|
||||
static let keyLength = 32
|
||||
}
|
||||
|
||||
/// Returns a stable 256-bit key, generating and persisting it on first use.
|
||||
func keyMaterial(for keyName: String) async throws -> Data {
|
||||
let key = StorageKey.externalKeyMaterial
|
||||
if let existing = try? await StorageRouter.shared.get(key) {
|
||||
return existing
|
||||
}
|
||||
|
||||
// CryptoKit ensures the material is cryptographically random.
|
||||
let symmetricKey = SymmetricKey(size: .bits256)
|
||||
let material = symmetricKey.withUnsafeBytes { Data($0) }
|
||||
guard material.count == Constants.keyLength else {
|
||||
|
||||
@ -4,8 +4,6 @@ import SharedKit
|
||||
import WatchConnectivity
|
||||
|
||||
@MainActor
|
||||
/// iOS-side WatchConnectivity bridge that keeps the watch app in sync with LocalData.
|
||||
/// This class focuses on coordination and delegates data payload creation to LocalData.
|
||||
final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
static let shared = WatchConnectivityService()
|
||||
|
||||
@ -14,7 +12,6 @@ final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
activateIfSupported()
|
||||
}
|
||||
|
||||
/// Activates WCSession only on supported devices (no-ops on unsupported hardware).
|
||||
private func activateIfSupported() {
|
||||
guard WCSession.isSupported() else { return }
|
||||
let session = WCSession.default
|
||||
@ -32,7 +29,6 @@ final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
} else {
|
||||
Logger.debug("iOS WCSession activated with state: \(activationState.rawValue)")
|
||||
}
|
||||
// Try to sync any previously registered keys as soon as WCSession is ready.
|
||||
Task {
|
||||
await StorageRouter.shared.syncRegisteredKeysIfNeeded()
|
||||
}
|
||||
@ -48,7 +44,6 @@ final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
|
||||
func sessionWatchStateDidChange(_ session: WCSession) {
|
||||
Logger.debug("iOS WCSession watch state changed: paired=\(session.isPaired) installed=\(session.isWatchAppInstalled)")
|
||||
// A watch install or pairing change is a good time to re-send syncable keys.
|
||||
Task {
|
||||
await StorageRouter.shared.syncRegisteredKeysIfNeeded()
|
||||
}
|
||||
@ -56,14 +51,12 @@ final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
|
||||
func sessionReachabilityDidChange(_ session: WCSession) {
|
||||
Logger.debug("iOS WCSession reachability changed: reachable=\(session.isReachable)")
|
||||
// When reachability flips, attempt to push any pending sync payloads.
|
||||
Task {
|
||||
await StorageRouter.shared.syncRegisteredKeysIfNeeded()
|
||||
}
|
||||
}
|
||||
|
||||
func session(_ session: WCSession, didReceiveMessage message: [String: Any]) {
|
||||
// Watch may request a sync without needing a reply (fire-and-forget message).
|
||||
if let request = message[WatchSyncMessageKeys.requestSync] as? Bool, request {
|
||||
Logger.debug("iOS received watch sync request")
|
||||
Task {
|
||||
@ -81,7 +74,6 @@ final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
didReceiveMessage message: [String: Any],
|
||||
replyHandler: @escaping ([String: Any]) -> Void
|
||||
) {
|
||||
// Reply-based handshake: watch expects a payload immediately if reachable.
|
||||
if let request = message[WatchSyncMessageKeys.requestSync] as? Bool, request {
|
||||
Logger.debug("iOS received watch sync request (reply)")
|
||||
Task {
|
||||
@ -92,7 +84,6 @@ final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempts to build a snapshot payload, retrying briefly in case keys are still initializing.
|
||||
private func buildSyncReplyPayload() async -> [String: Any] {
|
||||
let maxAttempts = 3
|
||||
for attempt in 1...maxAttempts {
|
||||
@ -113,7 +104,6 @@ final class WatchConnectivityService: NSObject, WCSessionDelegate {
|
||||
}
|
||||
|
||||
func session(_ session: WCSession, didReceiveUserInfo userInfo: [String: Any]) {
|
||||
// transferUserInfo can deliver requests when the watch was previously unreachable.
|
||||
if let request = userInfo[WatchSyncMessageKeys.requestSync] as? Bool, request {
|
||||
Logger.debug("iOS received queued watch sync request")
|
||||
Task {
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// App Group UserDefaults key used to demonstrate shared preferences between targets.
|
||||
extension StorageKey where Value == String {
|
||||
/// Stores a shared setting in App Group UserDefaults.
|
||||
/// - Domain: App Group UserDefaults
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// App Group file key for sharing a user profile across app targets.
|
||||
extension StorageKey where Value == UserProfile {
|
||||
/// Stores a shared user profile in the App Group container.
|
||||
/// - Domain: App Group File System
|
||||
@ -22,9 +21,6 @@ extension StorageKey where Value == UserProfile {
|
||||
syncPolicy: .never
|
||||
)
|
||||
|
||||
/// Creates a version of the key for a different App Group directory.
|
||||
/// Sample-only: production apps should avoid dynamic App Group configuration and
|
||||
/// migrate when storage settings change.
|
||||
nonisolated static func appGroupUserProfileKey(
|
||||
directory: FileDirectory = .documents
|
||||
) -> StorageKey {
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// App Group UserDefaults key for a generic preferences dictionary.
|
||||
extension StorageKey where Value == [String: AnyCodable] {
|
||||
/// Stores user preferences in App Group UserDefaults.
|
||||
/// - Domain: App Group UserDefaults
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// Encrypted file system key that pulls key material from a registered provider.
|
||||
extension StorageKey where Value == [String] {
|
||||
/// Stores session logs with encryption using external key material.
|
||||
nonisolated static let externalSessionLogs = StorageKey(
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// Encrypted file system key for long-lived private notes in Documents.
|
||||
extension StorageKey where Value == String {
|
||||
/// Stores private notes with encryption.
|
||||
nonisolated static let privateNotes = StorageKey(
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// Encrypted file system key for log data with configurable key derivation.
|
||||
extension StorageKey where Value == [String] {
|
||||
/// Stores session logs with full encryption.
|
||||
/// Configurable PBKDF2 iterations.
|
||||
@ -16,9 +15,6 @@ extension StorageKey where Value == [String] {
|
||||
syncPolicy: .never
|
||||
)
|
||||
|
||||
/// Builds a variant with a custom PBKDF2 iteration count for demo purposes.
|
||||
/// Sample-only: production apps should treat encryption parameters as fixed and
|
||||
/// perform a migration if they must change.
|
||||
nonisolated static func sessionLogsKey(iterations: Int) -> StorageKey {
|
||||
StorageKey(
|
||||
name: "session_logs.json",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// File system key for non-critical cache data stored in Caches.
|
||||
extension StorageKey where Value == Data {
|
||||
/// Stores cached data files.
|
||||
nonisolated static let cachedData = StorageKey(
|
||||
|
||||
@ -0,0 +1,27 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
extension StorageKey where Value == String {
|
||||
/// Example using custom serializer for specialized encoding.
|
||||
nonisolated static let customEncoded = StorageKey(
|
||||
name: "custom_encoded",
|
||||
domain: .fileSystem(directory: .documents),
|
||||
security: .none,
|
||||
serializer: .custom(
|
||||
encode: { value in
|
||||
Data(value.utf8).base64EncodedData()
|
||||
},
|
||||
decode: { data in
|
||||
guard let decoded = Data(base64Encoded: data),
|
||||
let string = String(data: decoded, encoding: .utf8) else {
|
||||
throw StorageError.deserializationFailed
|
||||
}
|
||||
return string
|
||||
}
|
||||
),
|
||||
owner: "SampleApp",
|
||||
description: "Stores custom-encoded string data (Base64 example).",
|
||||
availability: .all,
|
||||
syncPolicy: .never
|
||||
)
|
||||
}
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// File system key that persists a property list export.
|
||||
extension StorageKey where Value == [String: AnyCodable] {
|
||||
/// Stores settings as property list.
|
||||
nonisolated static let settingsPlist = StorageKey(
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// File system key for the shared UserProfile payload.
|
||||
extension StorageKey where Value == UserProfile {
|
||||
/// Stores user profile as JSON file in documents.
|
||||
nonisolated static let userProfileFile = StorageKey(
|
||||
@ -16,9 +15,6 @@ extension StorageKey where Value == UserProfile {
|
||||
syncPolicy: .automaticSmall
|
||||
)
|
||||
|
||||
/// Builds a profile key for an alternate file directory.
|
||||
/// Sample-only: production apps should keep directory decisions static; if the
|
||||
/// storage domain changes, migrate instead of toggling the key at runtime.
|
||||
nonisolated static func userProfileFileKey(directory: FileDirectory = .documents) -> StorageKey {
|
||||
StorageKey(
|
||||
name: UserProfile.storageKeyName,
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// Keychain key for short-lived API tokens that should not sync off-device.
|
||||
extension StorageKey where Value == String {
|
||||
/// Stores API token in keychain.
|
||||
nonisolated static let apiToken = StorageKey(
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// Keychain key used for credentials with optional access control variations.
|
||||
extension StorageKey where Value == Credential {
|
||||
/// Stores user credentials securely in keychain.
|
||||
/// Configurable accessibility and access control.
|
||||
@ -17,9 +16,6 @@ extension StorageKey where Value == Credential {
|
||||
syncPolicy: .never
|
||||
)
|
||||
|
||||
/// Builds a key with custom Keychain accessibility or access control options.
|
||||
/// Sample-only: production apps should not allow dynamic key configuration; treat
|
||||
/// StorageKey settings as fixed and migrate if security policies change.
|
||||
nonisolated static func credentialsKey(
|
||||
accessibility: KeychainAccessibility = .afterFirstUnlock,
|
||||
accessControl: KeychainAccessControl? = nil
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// Keychain key for externally provided key material used in encryption demos.
|
||||
extension StorageKey where Value == Data {
|
||||
/// Stores external key material used for encryption policies.
|
||||
nonisolated static let externalKeyMaterial = StorageKey(
|
||||
|
||||
@ -2,7 +2,6 @@ import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// Keychain key for sensitive location data with user presence required.
|
||||
extension StorageKey where Value == SampleLocationData {
|
||||
/// Stores sensitive location data in keychain with biometric protection.
|
||||
nonisolated static let lastLocation = StorageKey(
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// Legacy notification toggle stored in UserDefaults.
|
||||
extension StorageKey where Value == Bool {
|
||||
nonisolated static let legacyNotificationSetting = StorageKey(
|
||||
name: "legacy_notification_setting",
|
||||
@ -15,7 +14,6 @@ extension StorageKey where Value == Bool {
|
||||
)
|
||||
}
|
||||
|
||||
/// Legacy theme preference stored separately from notifications.
|
||||
extension StorageKey where Value == String {
|
||||
nonisolated static let legacyThemeSetting = StorageKey(
|
||||
name: "legacy_theme_setting",
|
||||
@ -29,9 +27,8 @@ extension StorageKey where Value == String {
|
||||
)
|
||||
}
|
||||
|
||||
/// Modern unified settings created by aggregating multiple legacy keys.
|
||||
extension StorageKey where Value == UnifiedSettings {
|
||||
|
||||
|
||||
nonisolated static let modernUnifiedSettings = StorageKey(
|
||||
name: "modern_unified_settings",
|
||||
domain: .fileSystem(directory: .documents),
|
||||
@ -51,7 +48,6 @@ extension StorageKey where Value == UnifiedSettings {
|
||||
destinationKey: key,
|
||||
sourceKeys: sources
|
||||
) { sources in
|
||||
// Merge legacy values into a single strongly-typed settings model.
|
||||
var notificationsEnabled = false
|
||||
var theme = "system"
|
||||
|
||||
|
||||
@ -1,8 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// Keys that demonstrate conditional migrations based on app version.
|
||||
extension StorageKey where Value == String {
|
||||
nonisolated static let legacyAppMode = StorageKey(
|
||||
name: "legacy_app_mode",
|
||||
@ -17,7 +15,7 @@ extension StorageKey where Value == String {
|
||||
|
||||
nonisolated static let modernAppMode = StorageKey(
|
||||
name: "modern_app_mode",
|
||||
domain: .keychain(service: StorageServiceIdentifiers.keychainLocation),
|
||||
domain: .keychain(service: "com.mbrucedogs.securestorage"),
|
||||
security: .keychain(
|
||||
accessibility: .afterFirstUnlock,
|
||||
accessControl: .userPresence
|
||||
|
||||
@ -1,10 +1,8 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// Keys that demonstrate a simple legacy-to-modern migration path.
|
||||
extension StorageKey where Value == String {
|
||||
/// The legacy key where data starts (in UserDefaults).
|
||||
/// The legacy key where data starts (in UserDefaults)
|
||||
nonisolated static let legacyMigrationSource = StorageKey(
|
||||
name: "legacy_user_id",
|
||||
domain: .userDefaults(suite: nil),
|
||||
@ -16,10 +14,10 @@ extension StorageKey where Value == String {
|
||||
syncPolicy: .never
|
||||
)
|
||||
|
||||
/// The modern key where data should end up (in Keychain).
|
||||
/// The modern key where data should end up (in Keychain)
|
||||
nonisolated static let modernMigrationDestination = StorageKey(
|
||||
name: "secure_user_id",
|
||||
domain: .keychain(service: StorageServiceIdentifiers.keychainLocation),
|
||||
domain: .keychain(service: "com.mbrucedogs.securestorage"),
|
||||
security: .keychain(
|
||||
accessibility: .afterFirstUnlock,
|
||||
accessControl: .userPresence
|
||||
@ -30,7 +28,6 @@ extension StorageKey where Value == String {
|
||||
availability: .all,
|
||||
syncPolicy: .never,
|
||||
migration: { key in
|
||||
// Simple "move on first read" migration for legacy identifiers.
|
||||
AnyStorageMigration(
|
||||
SimpleLegacyMigration(
|
||||
destinationKey: key,
|
||||
|
||||
@ -1,8 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
import SharedKit
|
||||
|
||||
/// Legacy string payload that will be transformed into a structured model.
|
||||
extension StorageKey where Value == String {
|
||||
nonisolated static let legacyProfileName = StorageKey(
|
||||
name: "legacy_profile_name",
|
||||
@ -16,11 +14,10 @@ extension StorageKey where Value == String {
|
||||
)
|
||||
}
|
||||
|
||||
/// Modern structured payload produced by transforming migration.
|
||||
extension StorageKey where Value == ProfileName {
|
||||
nonisolated static let modernProfileName = StorageKey(
|
||||
name: "modern_profile_name",
|
||||
domain: .keychain(service: StorageServiceIdentifiers.keychainLocation),
|
||||
domain: .keychain(service: "com.mbrucedogs.securestorage"),
|
||||
security: .keychain(
|
||||
accessibility: .afterFirstUnlock,
|
||||
accessControl: .userPresence
|
||||
@ -37,7 +34,6 @@ extension StorageKey where Value == ProfileName {
|
||||
destinationKey: key,
|
||||
sourceKey: sourceKey
|
||||
) { value in
|
||||
// Split "First Last" into a structured name for safer usage.
|
||||
let parts = value.split(separator: " ", maxSplits: 1).map(String.init)
|
||||
let firstName = parts.first ?? ""
|
||||
let lastName = parts.count > 1 ? parts[1] : ""
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// UserDefaults key that highlights platform availability and sync policy options.
|
||||
extension StorageKey where Value == String {
|
||||
/// Syncable setting with configurable platform and sync policy.
|
||||
/// Grouped under Platform to highlight availability/sync behavior.
|
||||
@ -16,9 +15,6 @@ extension StorageKey where Value == String {
|
||||
syncPolicy: .never
|
||||
)
|
||||
|
||||
/// Builds a variant to demonstrate different availability and sync policies.
|
||||
/// Sample-only: production apps should keep availability and sync policies static;
|
||||
/// if these change, migrate the data rather than altering the key at runtime.
|
||||
nonisolated static func syncableSettingKey(
|
||||
availability: PlatformAvailability = .all,
|
||||
syncPolicy: SyncPolicy = .never
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// UserDefaults key for watch-only preferences, used to demonstrate availability constraints.
|
||||
extension StorageKey where Value == Bool {
|
||||
/// Watch-only setting for vibration.
|
||||
/// Grouped under Platform to highlight watch-only availability.
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
import Foundation
|
||||
import LocalData
|
||||
|
||||
/// UserDefaults key used in the demo and as a lightweight migration flag.
|
||||
extension StorageKey where Value == String {
|
||||
/// Stores the app version in standard UserDefaults.
|
||||
/// - Domain: UserDefaults (standard)
|
||||
|
||||
@ -2,7 +2,6 @@ import SwiftUI
|
||||
import LocalData
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates aggregating multiple legacy keys into a UnifiedSettings model.
|
||||
struct AggregatingMigrationDemo: View {
|
||||
@State private var notificationsEnabled = false
|
||||
@State private var theme = ""
|
||||
@ -59,7 +58,6 @@ struct AggregatingMigrationDemo: View {
|
||||
.navigationBarTitleDisplayMode(.inline)
|
||||
}
|
||||
|
||||
/// Seeds the legacy keys to simulate pre-migration settings.
|
||||
private func saveToLegacy() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -80,7 +78,6 @@ struct AggregatingMigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads the modern unified key, triggering the aggregation migration.
|
||||
private func loadFromModern() {
|
||||
isLoading = true
|
||||
statusMessage = "Loading unified settings..."
|
||||
@ -98,7 +95,6 @@ struct AggregatingMigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Formats the aggregated settings for display.
|
||||
private func format(_ value: UnifiedSettings) -> String {
|
||||
let notificationsText = value.notificationsEnabled ? "On" : "Off"
|
||||
let themeText = value.theme.isEmpty ? "system" : value.theme
|
||||
|
||||
@ -2,7 +2,6 @@ import SwiftUI
|
||||
import LocalData
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates a migration that only runs when app version criteria are met.
|
||||
struct ConditionalMigrationDemo: View {
|
||||
@State private var legacyValue = ""
|
||||
@State private var modernValue = ""
|
||||
@ -60,7 +59,6 @@ struct ConditionalMigrationDemo: View {
|
||||
.navigationBarTitleDisplayMode(.inline)
|
||||
}
|
||||
|
||||
/// Seeds legacy data that will migrate when the version condition passes.
|
||||
private func saveToLegacy() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -75,7 +73,6 @@ struct ConditionalMigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads the modern key to trigger the conditional migration.
|
||||
private func loadFromModern() {
|
||||
isLoading = true
|
||||
statusMessage = "Loading modern mode..."
|
||||
|
||||
@ -9,7 +9,6 @@ import SwiftUI
|
||||
import LocalData
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates encrypted file storage with PBKDF2 and external key material options.
|
||||
struct EncryptedStorageDemo: View {
|
||||
@State private var logEntry = ""
|
||||
@State private var storedLogs: [String] = []
|
||||
@ -128,7 +127,6 @@ struct EncryptedStorageDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Appends an encrypted log entry using the selected key derivation mode.
|
||||
private func addLogEntry() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -154,7 +152,6 @@ struct EncryptedStorageDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Decrypts and loads log entries into memory for display.
|
||||
private func loadLogs() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -177,7 +174,6 @@ struct EncryptedStorageDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Clears the encrypted log file for a clean slate.
|
||||
private func clearLogs() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -198,7 +194,6 @@ struct EncryptedStorageDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads existing logs, appends the new entry, and returns the updated payload.
|
||||
private func updatedLogs(for key: StorageKey<[String]>) async throws -> [String] {
|
||||
var logs: [String]
|
||||
do {
|
||||
@ -219,7 +214,6 @@ struct EncryptedStorageDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Visual reminder that PBKDF2 iterations must remain stable to decrypt existing data.
|
||||
private struct IterationWarningView: View {
|
||||
var body: some View {
|
||||
Text("PBKDF2 iterations must match the value used during encryption. Changing this after saving will prevent decryption.")
|
||||
|
||||
@ -10,7 +10,6 @@ import LocalData
|
||||
import SharedKit
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates file storage in Documents/Caches plus App Group file sharing.
|
||||
struct FileSystemDemo: View {
|
||||
@State private var profileName = ""
|
||||
@State private var profileEmail = ""
|
||||
@ -169,7 +168,6 @@ struct FileSystemDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Saves a UserProfile to the selected file system directory.
|
||||
private func saveProfile() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -190,7 +188,6 @@ struct FileSystemDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads a UserProfile from the selected directory and updates the form.
|
||||
private func loadProfile() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -215,7 +212,6 @@ struct FileSystemDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Deletes the profile file from the selected directory.
|
||||
private func deleteProfile() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -231,7 +227,6 @@ struct FileSystemDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Persists a UserProfile into the App Group container.
|
||||
private func saveAppGroupProfile() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -252,7 +247,6 @@ struct FileSystemDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads a UserProfile from the App Group container.
|
||||
private func loadAppGroupProfile() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -277,7 +271,6 @@ struct FileSystemDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Deletes the App Group profile file to demonstrate shared cleanup.
|
||||
private func deleteAppGroupProfile() {
|
||||
isLoading = true
|
||||
Task {
|
||||
|
||||
@ -9,7 +9,6 @@ import SwiftUI
|
||||
import LocalData
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates Keychain storage with configurable accessibility and access control.
|
||||
struct KeychainDemo: View {
|
||||
@State private var username = ""
|
||||
@State private var password = ""
|
||||
@ -114,7 +113,6 @@ struct KeychainDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Stores credentials using the currently selected Keychain policies.
|
||||
private func saveCredentials() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -133,7 +131,6 @@ struct KeychainDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads credentials using the currently selected Keychain policies.
|
||||
private func loadCredentials() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -160,7 +157,6 @@ struct KeychainDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Removes the stored credentials from the Keychain.
|
||||
private func deleteCredentials() {
|
||||
isLoading = true
|
||||
Task {
|
||||
|
||||
@ -2,7 +2,6 @@ import SwiftUI
|
||||
import LocalData
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates a simple legacy key migration from UserDefaults to Keychain.
|
||||
struct MigrationDemo: View {
|
||||
@State private var legacyValue = ""
|
||||
@State private var modernValue = ""
|
||||
@ -84,7 +83,6 @@ struct MigrationDemo: View {
|
||||
|
||||
// MARK: - Actions
|
||||
|
||||
/// Seeds the legacy key to simulate pre-migration data.
|
||||
private func saveToLegacy() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -99,7 +97,6 @@ struct MigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads the modern key, triggering the configured migration if needed.
|
||||
private func loadFromModern() {
|
||||
isLoading = true
|
||||
statusMessage = "Retrieving from Modern..."
|
||||
@ -118,7 +115,6 @@ struct MigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Forces a migration sweep to drain legacy data even if the modern key exists.
|
||||
private func runManualMigration() {
|
||||
isLoading = true
|
||||
statusMessage = "Running manual migration..."
|
||||
@ -136,7 +132,6 @@ struct MigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Checks whether the legacy key still exists after migration.
|
||||
private func checkLegacyExists() {
|
||||
isLoading = true
|
||||
Task {
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
import SwiftUI
|
||||
|
||||
/// Entry point for the migration demos, grouped by strategy.
|
||||
struct MigrationHubView: View {
|
||||
var body: some View {
|
||||
Form {
|
||||
|
||||
@ -10,7 +10,6 @@ import LocalData
|
||||
import WatchConnectivity
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates platform availability and Watch sync policies for a single key.
|
||||
struct PlatformSyncDemo: View {
|
||||
@State private var settingValue = ""
|
||||
@State private var storedValue = ""
|
||||
@ -138,7 +137,6 @@ struct PlatformSyncDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Saves the value using the current availability and sync policy selection.
|
||||
private func saveValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -159,7 +157,6 @@ struct PlatformSyncDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads the value using the current availability and sync policy selection.
|
||||
private func loadValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -183,7 +180,6 @@ struct PlatformSyncDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Attempts a read to show the platform access error when applicable.
|
||||
private func testPlatformError() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -206,7 +202,6 @@ struct PlatformSyncDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Refreshes the WCSession status shown in the UI.
|
||||
private func refreshWatchStatus() {
|
||||
watchStatus = WatchStatus.current()
|
||||
}
|
||||
@ -214,7 +209,6 @@ struct PlatformSyncDemo: View {
|
||||
|
||||
// MARK: - Display Names
|
||||
|
||||
/// UI-friendly names for platform availability options.
|
||||
extension PlatformAvailability {
|
||||
var displayName: String {
|
||||
switch self {
|
||||
@ -226,7 +220,6 @@ extension PlatformAvailability {
|
||||
}
|
||||
}
|
||||
|
||||
/// UI-friendly names for sync policies.
|
||||
extension SyncPolicy {
|
||||
var displayName: String {
|
||||
switch self {
|
||||
@ -243,7 +236,6 @@ extension SyncPolicy {
|
||||
}
|
||||
}
|
||||
|
||||
/// Snapshot of current WatchConnectivity state for display purposes.
|
||||
private struct WatchStatus: Equatable {
|
||||
let isSupported: Bool
|
||||
let isPaired: Bool
|
||||
@ -281,7 +273,6 @@ private struct WatchStatus: Equatable {
|
||||
}
|
||||
}
|
||||
|
||||
/// Read-only UI for displaying WatchConnectivity state.
|
||||
private struct WatchStatusView: View {
|
||||
let status: WatchStatus
|
||||
|
||||
@ -314,7 +305,6 @@ private struct WatchStatusView: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Explanatory text for each platform availability option.
|
||||
private struct PlatformAvailabilityDescriptionView: View {
|
||||
let availability: PlatformAvailability
|
||||
|
||||
@ -338,7 +328,6 @@ private struct PlatformAvailabilityDescriptionView: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Explanatory text for each sync policy option.
|
||||
private struct SyncPolicyDescriptionView: View {
|
||||
let syncPolicy: SyncPolicy
|
||||
|
||||
@ -360,7 +349,6 @@ private struct SyncPolicyDescriptionView: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Predicts the expected behavior given the selected availability and sync policy.
|
||||
private struct ExpectedOutcomeView: View {
|
||||
let availability: PlatformAvailability
|
||||
let syncPolicy: SyncPolicy
|
||||
|
||||
@ -2,7 +2,6 @@ import SwiftUI
|
||||
import LocalData
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates transforming a legacy string into a structured ProfileName.
|
||||
struct TransformingMigrationDemo: View {
|
||||
@State private var legacyValue = ""
|
||||
@State private var modernValue = ""
|
||||
@ -60,7 +59,6 @@ struct TransformingMigrationDemo: View {
|
||||
.navigationBarTitleDisplayMode(.inline)
|
||||
}
|
||||
|
||||
/// Seeds the legacy string value to simulate pre-migration data.
|
||||
private func saveToLegacy() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -75,7 +73,6 @@ struct TransformingMigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads the modern key, triggering the transforming migration.
|
||||
private func loadFromModern() {
|
||||
isLoading = true
|
||||
statusMessage = "Loading modern profile..."
|
||||
@ -94,7 +91,6 @@ struct TransformingMigrationDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Formats the migrated name for display in the demo UI.
|
||||
private func format(_ value: ProfileName) -> String {
|
||||
let trimmedFirst = value.firstName.trimmingCharacters(in: .whitespacesAndNewlines)
|
||||
let trimmedLast = value.lastName.trimmingCharacters(in: .whitespacesAndNewlines)
|
||||
|
||||
@ -9,7 +9,6 @@ import SwiftUI
|
||||
import LocalData
|
||||
|
||||
@MainActor
|
||||
/// Demonstrates typed UserDefaults keys, including App Group sharing.
|
||||
struct UserDefaultsDemo: View {
|
||||
@State private var inputText = ""
|
||||
@State private var storedValue = ""
|
||||
@ -137,7 +136,6 @@ struct UserDefaultsDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Persists the current input value with the standard UserDefaults key.
|
||||
private func saveValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -152,7 +150,6 @@ struct UserDefaultsDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads the standard UserDefaults value and reflects it in the UI.
|
||||
private func loadValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -172,7 +169,6 @@ struct UserDefaultsDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Removes the standard UserDefaults value to reset the demo.
|
||||
private func removeValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -188,7 +184,6 @@ struct UserDefaultsDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Saves the input value into the App Group UserDefaults container.
|
||||
private func saveAppGroupValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -203,7 +198,6 @@ struct UserDefaultsDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads the App Group value to demonstrate cross-target sharing.
|
||||
private func loadAppGroupValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
@ -223,7 +217,6 @@ struct UserDefaultsDemo: View {
|
||||
}
|
||||
}
|
||||
|
||||
/// Clears the App Group value to demonstrate cleanup behavior.
|
||||
private func removeAppGroupValue() {
|
||||
isLoading = true
|
||||
Task {
|
||||
|
||||
@ -1,24 +1,22 @@
|
||||
import Foundation
|
||||
|
||||
/// Example shared models that demonstrate creating Watch-optimized payloads.
|
||||
/// The goal is to minimize what needs to traverse WatchConnectivity.
|
||||
// Example shared models for Watch-optimized data
|
||||
|
||||
struct Workout: Codable {
|
||||
let date: Date
|
||||
// Add other properties as needed
|
||||
}
|
||||
|
||||
/// Preferences included in the full profile; used to derive a slimmer watch payload.
|
||||
struct Preferences: Codable {
|
||||
let isPremium: Bool
|
||||
let appearance: Appearance
|
||||
}
|
||||
|
||||
/// Display preferences for the demo data.
|
||||
enum Appearance: Codable {
|
||||
case light, dark
|
||||
}
|
||||
|
||||
/// Shared full-fidelity profile used on iOS, with a computed watch-friendly version.
|
||||
// Shared model (iOS + watchOS)
|
||||
struct FullUserProfile: Codable {
|
||||
let id: UUID
|
||||
let fullName: String
|
||||
@ -27,7 +25,7 @@ struct FullUserProfile: Codable {
|
||||
let allWorkouts: [Workout] // ← potentially huge
|
||||
let preferences: Preferences
|
||||
|
||||
/// Lightweight Watch version computed from the full profile.
|
||||
// Lightweight Watch version — computed
|
||||
var watchVersion: WatchUserProfile {
|
||||
WatchUserProfile(
|
||||
id: id,
|
||||
@ -41,7 +39,6 @@ struct FullUserProfile: Codable {
|
||||
}
|
||||
}
|
||||
|
||||
/// Slimmed-down payload intended for watch display only.
|
||||
struct WatchUserProfile: Codable, Sendable {
|
||||
let id: UUID
|
||||
let displayName: String
|
||||
@ -57,7 +54,7 @@ struct WatchUserProfile: Codable, Sendable {
|
||||
// let watchData = try JSONEncoder().encode(profile.watchVersion)
|
||||
// WCSession.default.updateApplicationContext(["profile": watchData])
|
||||
|
||||
/// Optional protocol to standardize access to a watch-friendly payload.
|
||||
// Alternative: WatchRepresentable protocol
|
||||
public protocol WatchRepresentable {
|
||||
associatedtype WatchVersion: Codable, Sendable
|
||||
var watchVersion: WatchVersion { get }
|
||||
|
||||
Loading…
Reference in New Issue
Block a user