arch-toolkit

📦 Arch Toolkit · Storage Core

A multiplatform reactive storage abstraction for key–value data. Part of the Arch Toolkit.

---

✨ Features

• ✅ Multiplatform API: Works across Java (Android/JVM), Apple (iOS/macOS), Web (JS/WASM*).
• 🎯 Unified contract: Consistent KeyValue interface for any storage backend.
• 🔄 Reactive: Observe changes via Kotlin [Flow].
• ⚡ Synchronous access: Immediate reads with instant().
• 🧩 Compose ready: [state()] integration with Jetpack Compose.
• 🖇️ Delegates: Property by syntax.
• 🔒 Type-safe: Built-in support for primitives, enums, and JSON models.

* Web targets fallback to noop stubs.

---

🚀 Quick Start

Add the core module as dependency:

implementation("io.github.matheus-corregiari:storage-core:<version>")

Then choose one of the available providers:

• DataStore (persistent)

  implementation("io.github.matheus-corregiari:storage-datastore:<version>")
  

• Memory (in-memory, for tests or ephemeral cache)

  implementation("io.github.matheus-corregiari:storage-memory:<version>")
  

---

📖 Usage Examples

Basic

val storage: StorageProvider = DataStoreProvider(store)

val isLoggedIn = storage.boolean("is_logged_in")
val userName = storage.string("user_name")

isLoggedIn.set(true)
println("User: ${userName.instant()}")

---

Enum

enum class Theme { Light, Dark }

val theme = storage.enum("theme", Theme.entries, Theme.Light)

theme.set(Theme.Dark)
println("Theme is ${theme.instant()}")

---

JSON Model

@kotlinx.serialization.Serializable
data class User(val id: String, val name: String)

val user = storage.model<User>("user")

user.set(User("42", "Alice"))
println("User: ${user.instant()}")

---

Compose Integration

@Composable
fun UserNameInput(userName: KeyValue<String?>) {
    val state = userName.state()
    TextField(
        value = state.value.orEmpty(),
        onValueChange = { state.value = it }
    )
}

---

Delegated Property

var counter by storage.int("counter").required { 0 }.delegate()

counter += 1
println("Counter is $counter")

---

🛠️ Providers

• storage-datastore → Backed by AndroidX DataStore.
  • Supported on Java (Android/JVM) and Apple (iOS/macOS).
• storage-memory → In-memory, ideal for testing and mock scenarios.
• noop → Stub for Web (JS/WASM) targets.

---

⚙️ JSON Configuration

By default, models use the built-in Json configuration:

ignoreUnknownKeys = true
encodeDefaults = true
prettyPrint = true

Override globally if needed:

StorageProvider.json(Json {
    ignoreUnknownKeys = false
})

---

🧩 Targets Overview

Target	Provider(s)	Status
Android/JVM	DataStore	✅
iOS/macOS	DataStore (KMP)	✅
JS/WASM	Noop (stub only)	⚠️
Any	Memory	✅

---

🧪 Testing

For unit tests or non-persistent use cases, use the in-memory provider:

val memory = MemoryStoreProvider(mutableMapOf())
val flag = memory.boolean("feature_enabled")

flag.set(true)
println(flag.instant()) // true

---

🔗 Related Modules

• 📦 storage-datastore
  Implementation backed by AndroidX DataStore.

• 📦 storage-memory
  In-memory provider for tests and ephemeral use.

• 📦 storage-core
  Abstractions and contracts (this module).

---

📦 Part of Arch Toolkit

The Storage Core is one of the building blocks of Arch Toolkit, designed to provide:

• Consistency across platforms
• Type safety
• Developer productivity

---

📄 License

This module is released under the Apache 2.0 License. See LICENSE for details.

---

```

This site is open source. Improve this page.