Awesome

<div align="center"> <img src="Images/friendly_robot.png" width="120"/> <h1 style="font-size:48px">Store5</h1> </div>

<div align="center"> <h4>Full documentation can be found on our <a href="https://mobilenativefoundation.github.io/Store/">website</a>!</h4> <h4>Join our official Slack on <a href="https://kotlinlang.slack.com/archives/C06007Z01HU">kotlinlang</a>!</h4> </div>

Concepts

Store is a typed repository that returns a flow of Data /Loading /Error from local and network data sources
MutableStore is a mutable repository implementation that allows create (C), read (R), update (U), and delete (D) operations for local and network resources
SourceOfTruth persists items
Fetcher defines how data will be fetched over network
Updater defines how local changes will be pushed to network
Bookkeeper tracks metadata of local changes and records synchronization failures
Validator returns whether an item is valid
Converter converts items between Network /Local /Output representations

Including Store In Your Project

Android

implementation "org.mobilenativefoundation.store:store5:5.1.0-alpha05"

Multiplatform (Common, JVM, Native, JS)

commonMain {
  dependencies {
    implementation("org.mobilenativefoundation.store:store5:5.1.0-alpha05")
  }
}

Getting Started

Building Your First Store

StoreBuilder
  .from<Key, Network, Output, Local>(fetcher, sourceOfTruth)
  .converter(converter)
  .validator(validator)
  .build(updater, bookkeeper)

Creating

Request

store.write(
  request = StoreWriteRequest.of<Key, Output, Response>(
    key = key,
    value = value
  )
)

Response

1. StoreWriteResponse.Success.Typed<Response>(response)

Reading

Request

store.stream<Response>(request = StoreReadRequest.cached(key, refresh = false))

Response

1. StoreReadResponse.Data(value, origin = StoreReadResponseOrigin.Cache)

Updating

Request

store.write(
  request = StoreWriteRequest.of<Key, Output, Response>(
    key = key,
    value = newValue
  )
)

Response

1. StoreWriteResponse.Success.Typed<Response>(response)

Deleting

Request

store.clear(key)

License

Copyright (c) 2024 Mobile Native Foundation.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.