Arch Storage

Reactive, type-safe key-value storage for Kotlin Multiplatform, extracted from Arch Toolkit. Use the same entry API for temporary in-memory values and persistent DataStore preferences.

1.0.0 is the first independent stable release of Arch Storage. See the migration guide before replacing the older 2.0.0-rc* artifacts.

Coordinates retain the group io.github.matheus-corregiari. Packages remain under br.com.arch.toolkit.storage. The modules share one release version.

import br.com.arch.toolkit.storage.core.KeyValue.Companion.required
import br.com.arch.toolkit.storage.memory.MemoryStoreProvider

val storage = MemoryStoreProvider(mutableMapOf())
val visits = storage.int("visits").required { 0 }
visits.set(1)
// In a coroutine:
// visits.get().collect { count -> println(count) }

Memory writes are immediate. DataStore writes are asynchronous; observe get() to await a persisted value. current() uses a short timeout and can return the cached value instead. Memory values do not survive process termination.

Use JDK 21, the checked-in Gradle Wrapper, and Android SDK 37/build tools 37.0.0. Set ANDROID_HOME to your SDK installation. The minimum Android API is 23. Browser tests require Chrome; Apple compilation and simulator tests require macOS and Xcode.

./gradlew ciBuild ciCoverage
./gradlew ciLint ciDocs ciPublicationManifest
python -m unittest discover -s .github/scripts -p 'test_*.py'
python -m pip install -r .github/requirements-docs.txt
python -m mkdocs build --strict

Use gradlew.bat in PowerShell. Coverage gates require at least 90% of lines, 85% of instructions and 80% of branches, both per module and in aggregate; modules without branches report N/A. No Git checkout or publishing credentials are needed for local build/test/docs. The local version defaults to 0.0.0-SNAPSHOT; override with '-PreleaseVersion=1.0.0', which takes precedence over the CI-generated build/version-name.txt. Normal dependency resolution excludes Maven Local; enable it explicitly with -PuseMavenLocal=true.

• Getting started: dependencies and provider setup.
• Core concepts: entries, nullability, mapping and lifecycle.
• Recipes: preferences, JSON models and Compose.
• CI and releases: gates, secrets and publication workflow.
• Changelog: extraction changes.
• Contributing.
• Local validation record: checks, coverage and platform limits.

Licensed under Apache 2.0.