Mark :core and :paging as experimental

matt-ramotar · matt-ramotar · commit 52f0dba32e3e · 2024-01-15T22:19:24.000-05:00
Signed-off-by: mramotar &lt;mramotar@dropbox.com&gt;
diff --git a/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/ExperimentalStoreApi.kt b/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/ExperimentalStoreApi.kt
@@ -1,4 +1,4 @@
-package org.mobilenativefoundation.store.store5
+package org.mobilenativefoundation.store.core5
 
 /**
  * Marks declarations that are still **experimental** in store API.
diff --git a/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/InsertionStrategy.kt b/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/InsertionStrategy.kt
@@ -1,5 +1,6 @@
 package org.mobilenativefoundation.store.core5
 
+@ExperimentalStoreApi
 enum class InsertionStrategy {
     APPEND,
     PREPEND,
diff --git a/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/KeyProvider.kt b/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/KeyProvider.kt
@@ -1,5 +1,6 @@
 package org.mobilenativefoundation.store.core5
 
+@ExperimentalStoreApi
 interface KeyProvider<Id : Any, Single : StoreData.Single<Id>> {
     fun fromCollection(key: StoreKey.Collection<Id>, value: Single): StoreKey.Single<Id>
     fun fromSingle(key: StoreKey.Single<Id>, value: Single): StoreKey.Collection<Id>
diff --git a/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/StoreData.kt b/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/StoreData.kt
@@ -5,7 +5,7 @@ package org.mobilenativefoundation.store.core5
  * Every item that implements the [StoreData] interface must have a means of identification.
  * This is useful in scenarios when data can be represented as singles or collections.
  */
-
+@ExperimentalStoreApi
 interface StoreData<out Id : Any> {
 
     /**
diff --git a/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/StoreKey.kt b/core/src/commonMain/kotlin/org/mobilenativefoundation/store/core5/StoreKey.kt
@@ -6,6 +6,7 @@ package org.mobilenativefoundation.store.core5
  * Provides mechanisms for ID-based fetch, page-based fetch, and cursor-based fetch.
  * Includes options for sorting and filtering.
  */
+@ExperimentalStoreApi
 interface StoreKey<out Id : Any> {
 
     /**
diff --git a/paging/src/commonMain/kotlin/org/mobilenativefoundation/store/paging5/LaunchPagingStore.kt b/paging/src/commonMain/kotlin/org/mobilenativefoundation/store/paging5/LaunchPagingStore.kt
@@ -10,9 +10,9 @@ import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.drop
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.launch
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.core5.StoreData
 import org.mobilenativefoundation.store.core5.StoreKey
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.MutableStore
 import org.mobilenativefoundation.store.store5.Store
 import org.mobilenativefoundation.store.store5.StoreReadRequest
@@ -27,6 +27,7 @@ private class StopProcessingException : Exception()
  * @param stream A lambda that invokes [Store.stream].
  * @return A read-only [StateFlow] reflecting the state of the Store.
  */
+@ExperimentalStoreApi
 private fun <Id : Any, Key : StoreKey<Id>, Output : StoreData<Id>> launchPagingStore(
     scope: CoroutineScope,
     keys: Flow<Key>,
@@ -73,6 +74,7 @@ private fun <Id : Any, Key : StoreKey<Id>, Output : StoreData<Id>> launchPagingS
  * Initializes and returns a [StateFlow] that reflects the state of the [Store], updating by a flow of provided keys.
  * @see [launchPagingStore].
  */
+@ExperimentalStoreApi
 fun <Id : Any, Key : StoreKey<Id>, Output : StoreData<Id>> Store<Key, Output>.launchPagingStore(
     scope: CoroutineScope,
     keys: Flow<Key>,
@@ -86,7 +88,7 @@ fun <Id : Any, Key : StoreKey<Id>, Output : StoreData<Id>> Store<Key, Output>.la
  * Initializes and returns a [StateFlow] that reflects the state of the [Store], updating by a flow of provided keys.
  * @see [launchPagingStore].
  */
-@OptIn(ExperimentalStoreApi::class)
+@ExperimentalStoreApi
 fun <Id : Any, Key : StoreKey<Id>, Output : StoreData<Id>> MutableStore<Key, Output>.launchPagingStore(
     scope: CoroutineScope,
     keys: Flow<Key>,
@@ -96,6 +98,7 @@ fun <Id : Any, Key : StoreKey<Id>, Output : StoreData<Id>> MutableStore<Key, Out
     }
 }
 
+@ExperimentalStoreApi
 private fun <Id : Any, Key : StoreKey.Collection<Id>, Output : StoreData<Id>> joinData(
     key: Key,
     prevResponse: StoreReadResponse<Output>,
diff --git a/paging/src/commonTest/kotlin/org/mobilenativefoundation/store/paging5/LaunchPagingStoreTests.kt b/paging/src/commonTest/kotlin/org/mobilenativefoundation/store/paging5/LaunchPagingStoreTests.kt
@@ -15,7 +15,7 @@ import org.mobilenativefoundation.store.paging5.util.PostDatabase
 import org.mobilenativefoundation.store.paging5.util.PostKey
 import org.mobilenativefoundation.store.paging5.util.PostPutRequestResult
 import org.mobilenativefoundation.store.paging5.util.PostStoreFactory
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.MutableStore
 import org.mobilenativefoundation.store.store5.StoreReadRequest
 import org.mobilenativefoundation.store.store5.StoreReadResponse
diff --git a/paging/src/commonTest/kotlin/org/mobilenativefoundation/store/paging5/util/PostStoreFactory.kt b/paging/src/commonTest/kotlin/org/mobilenativefoundation/store/paging5/util/PostStoreFactory.kt
@@ -8,7 +8,7 @@ import org.mobilenativefoundation.store.cache5.StoreMultiCache
 import org.mobilenativefoundation.store.core5.KeyProvider
 import org.mobilenativefoundation.store.core5.StoreKey
 import org.mobilenativefoundation.store.store5.Converter
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.Fetcher
 import org.mobilenativefoundation.store.store5.MutableStore
 import org.mobilenativefoundation.store.store5.SourceOfTruth
diff --git a/rx2/src/main/kotlin/org/mobilenativefoundation/store/rx2/RxStore.kt b/rx2/src/main/kotlin/org/mobilenativefoundation/store/rx2/RxStore.kt
@@ -6,7 +6,7 @@ import io.reactivex.Flowable
 import kotlinx.coroutines.rx2.asFlowable
 import kotlinx.coroutines.rx2.rxCompletable
 import kotlinx.coroutines.rx2.rxSingle
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.Store
 import org.mobilenativefoundation.store.store5.StoreBuilder
 import org.mobilenativefoundation.store.store5.StoreReadRequest
diff --git a/rx2/src/test/kotlin/org/mobilenativefoundation/store/rx2/test/RxSingleStoreExtensionsTest.kt b/rx2/src/test/kotlin/org/mobilenativefoundation/store/rx2/test/RxSingleStoreExtensionsTest.kt
@@ -14,7 +14,7 @@ import org.mobilenativefoundation.store.rx2.getSingle
 import org.mobilenativefoundation.store.rx2.ofMaybe
 import org.mobilenativefoundation.store.rx2.ofResultSingle
 import org.mobilenativefoundation.store.rx2.withScheduler
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.Fetcher
 import org.mobilenativefoundation.store.store5.FetcherResult
 import org.mobilenativefoundation.store.store5.SourceOfTruth
diff --git a/rx2/src/test/kotlin/org/mobilenativefoundation/store/rx2/test/RxSingleStoreTest.kt b/rx2/src/test/kotlin/org/mobilenativefoundation/store/rx2/test/RxSingleStoreTest.kt
@@ -15,7 +15,7 @@ import org.mobilenativefoundation.store.rx2.observeClearAll
 import org.mobilenativefoundation.store.rx2.ofMaybe
 import org.mobilenativefoundation.store.rx2.ofResultSingle
 import org.mobilenativefoundation.store.rx2.withScheduler
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.Fetcher
 import org.mobilenativefoundation.store.store5.FetcherResult
 import org.mobilenativefoundation.store.store5.SourceOfTruth
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/Clear.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/Clear.kt
@@ -1,5 +1,7 @@
 package org.mobilenativefoundation.store.store5
 
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
+
 interface Clear {
     interface Key<Key : Any> {
         /**
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/MutableStore.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/MutableStore.kt
@@ -1,5 +1,7 @@
 package org.mobilenativefoundation.store.store5
 
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
+
 @ExperimentalStoreApi
 interface MutableStore<Key : Any, Output : Any> :
     Read.StreamWithConflictResolution<Key, Output>,
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/StoreBuilder.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/StoreBuilder.kt
@@ -85,7 +85,7 @@ interface StoreBuilder<Key : Any, Output : Any> {
             memoryCache
         )
 
-        fun <Key : Any, Network : Any, Output : Any, Local: Any> from(
+        fun <Key : Any, Network : Any, Output : Any, Local : Any> from(
             fetcher: Fetcher<Key, Network>,
             sourceOfTruth: SourceOfTruth<Key, Local, Output>,
             converter: Converter<Network, Local, Output>
@@ -96,7 +96,7 @@ interface StoreBuilder<Key : Any, Output : Any> {
             converter
         )
 
-        fun <Key : Any, Network : Any, Output : Any, Local: Any> from(
+        fun <Key : Any, Network : Any, Output : Any, Local : Any> from(
             fetcher: Fetcher<Key, Network>,
             sourceOfTruth: SourceOfTruth<Key, Local, Output>,
             memoryCache: Cache<Key, Output>,
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/Write.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/Write.kt
@@ -1,6 +1,7 @@
 package org.mobilenativefoundation.store.store5
 
 import kotlinx.coroutines.flow.Flow
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 
 interface Write<Key : Any, Output : Any> {
     @ExperimentalStoreApi
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealMutableStore.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealMutableStore.kt
@@ -13,7 +13,7 @@ import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
 import org.mobilenativefoundation.store.store5.Bookkeeper
 import org.mobilenativefoundation.store.store5.Clear
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.MutableStore
 import org.mobilenativefoundation.store.store5.StoreReadRequest
 import org.mobilenativefoundation.store.store5.StoreReadResponse
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealStore.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealStore.kt
@@ -30,7 +30,7 @@ import kotlinx.coroutines.flow.transform
 import org.mobilenativefoundation.store.cache5.Cache
 import org.mobilenativefoundation.store.store5.CacheType
 import org.mobilenativefoundation.store.store5.Converter
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.Fetcher
 import org.mobilenativefoundation.store.store5.SourceOfTruth
 import org.mobilenativefoundation.store.store5.Store
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealStoreBuilder.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealStoreBuilder.kt
@@ -35,7 +35,7 @@ fun <Key : Any, Network : Any, Output : Any> storeBuilderFromFetcherSourceOfTrut
 ): StoreBuilder<Key, Output> =
     RealStoreBuilder<Key, Network, Output, Network>(fetcher, sourceOfTruth, memoryCache)
 
-fun <Key : Any, Network : Any, Output : Any, Local: Any> storeBuilderFromFetcherSourceOfTruthMemoryCacheAndConverter(
+fun <Key : Any, Network : Any, Output : Any, Local : Any> storeBuilderFromFetcherSourceOfTruthMemoryCacheAndConverter(
     fetcher: Fetcher<Key, Network>,
     sourceOfTruth: SourceOfTruth<Key, Local, Output>,
     memoryCache: Cache<Key, Output>?,
@@ -76,7 +76,7 @@ internal class RealStoreBuilder<Key : Any, Network : Any, Output : Any, Local :
         scope = scope ?: GlobalScope,
         sourceOfTruth = sourceOfTruth,
         fetcher = fetcher,
-        converter = converter?: defaultConverter(),
+        converter = converter ?: defaultConverter(),
         validator = validator,
         memCache = memoryCache ?: cachePolicy?.let {
             CacheBuilder<Key, Output>().apply {
@@ -134,7 +134,7 @@ internal class RealStoreBuilder<Key : Any, Network : Any, Output : Any, Local :
         }
     }
 
-     private fun <Network: Any, Local: Any, Output: Any> defaultConverter() = object : Converter<Network, Local, Output> {
+    private fun <Network : Any, Local : Any, Output : Any> defaultConverter() = object : Converter<Network, Local, Output> {
         override fun fromOutputToLocal(output: Output): Local =
             throw IllegalStateException("non mutable store never call this function")
 
diff --git a/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/extensions/store.kt b/store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/extensions/store.kt
@@ -3,7 +3,7 @@ package org.mobilenativefoundation.store.store5.impl.extensions
 import kotlinx.coroutines.flow.filterNot
 import kotlinx.coroutines.flow.first
 import org.mobilenativefoundation.store.store5.Bookkeeper
-import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.MutableStore
 import org.mobilenativefoundation.store.store5.Store
 import org.mobilenativefoundation.store.store5.StoreReadRequest
diff --git a/store/src/commonTest/kotlin/org/mobilenativefoundation/store/store5/ClearAllStoreTests.kt b/store/src/commonTest/kotlin/org/mobilenativefoundation/store/store5/ClearAllStoreTests.kt
@@ -5,6 +5,7 @@ import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.test.TestScope
 import kotlinx.coroutines.test.advanceUntilIdle
 import kotlinx.coroutines.test.runTest
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.util.InMemoryPersister
 import org.mobilenativefoundation.store.store5.util.asSourceOfTruth
 import org.mobilenativefoundation.store.store5.util.getData
diff --git a/store/src/commonTest/kotlin/org/mobilenativefoundation/store/store5/FetcherResponseTests.kt b/store/src/commonTest/kotlin/org/mobilenativefoundation/store/store5/FetcherResponseTests.kt
@@ -236,7 +236,6 @@ class FetcherResponseTests {
         )
     }
 
-
     private fun <Key : Any, Output : Any> StoreBuilder<Key, Output>.buildWithTestScope() =
         scope(testScope).build()
 }
diff --git a/store/src/commonTest/kotlin/org/mobilenativefoundation/store/store5/UpdaterTests.kt b/store/src/commonTest/kotlin/org/mobilenativefoundation/store/store5/UpdaterTests.kt
@@ -7,6 +7,7 @@ import kotlinx.coroutines.flow.last
 import kotlinx.coroutines.flow.take
 import kotlinx.coroutines.test.TestScope
 import kotlinx.coroutines.test.runTest
+import org.mobilenativefoundation.store.core5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.impl.extensions.inHours
 import org.mobilenativefoundation.store.store5.util.assertEmitsExactly
 import org.mobilenativefoundation.store.store5.util.fake.Notes

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package org.mobilenativefoundation.store.store5`
	`1`	`+package org.mobilenativefoundation.store.core5`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* Marks declarations that are still experimental in store API.`