Update readmes

Author: simolus3

common/README.md

@@ -0,0 +1,25 @@
+# PowerSync common
+
+This module contains core definitions for the PowerSync SDK, without linking or bundling a SQLite dependency.
+
+This allows the module to be used as a building block for PowerSync SDKs with and without encryption support.
+
+Users should typically depend on `:core` instead.
+
+## Structure
+
+This is a Kotlin Multiplatform project targeting Android, iOS platforms, with the following
+structure:
+
+- `commonMain` - Shared code for all targets, which includes the `PowerSyncBackendConnector`
+  interface and `PowerSyncBuilder` for building a `PowerSync` instance. It also defines
+  the `DatabaseDriverFactory` class to be implemented in each platform.
+- `commonJava` - Shared logic for Android and Java targets.
+- `androidMain` - Android-specific code for loading the core extension.
+- `jvmMain` - Java-specific code for loading the core extension.
+- `nativeMain` - A SQLite driver implemented with cinterop calls to sqlite3.
+
+## Attachment Helpers
+
+This module contains attachment helpers under the `com.powersync.attachments` package. See
+the [Attachment Helpers README](../common/src/commonMain/kotlin/com/powersync/attachments/README.md)

common/src/androidMain/kotlin/com/powersync/DatabaseDriverFactory.android.kt renamed to common/src/androidMain/kotlin/com/powersync/ConnectionFactory.android.kt

@@ -15,6 +15,7 @@ import com.powersync.bucket.WriteCheckpointData
 import com.powersync.bucket.WriteCheckpointResponse
 import com.powersync.connectors.PowerSyncBackendConnector
 import com.powersync.connectors.PowerSyncCredentials
+import com.powersync.connectors.readCachedCredentials
 import com.powersync.db.PowerSyncDatabaseImpl
 import com.powersync.db.schema.PendingStatement
 import com.powersync.db.schema.PendingStatementParameter
@@ -123,7 +124,7 @@ abstract class BaseSyncIntegrationTest(
             turbineScope(timeout = 10.0.seconds) {
                 val turbine = database.currentStatus.asFlow().testIn(this)
                 turbine.waitFor { it.connected }
-                connector.cachedCredentials shouldNotBe null
+                connector.readCachedCredentials() shouldNotBe null
 
                 database.disconnect()
                 turbine.waitFor { !it.connected }
@@ -134,7 +135,7 @@ abstract class BaseSyncIntegrationTest(
             waitFor { syncLines.isClosedForSend shouldBe true }
 
             // And called invalidateCredentials on the connector
-            connector.cachedCredentials shouldBe null
+            connector.readCachedCredentials() shouldBe null
         }
 
     @Test
@@ -674,7 +675,7 @@ abstract class BaseSyncIntegrationTest(
                 // Should invalidate credentials when token expires
                 syncLines.send(SyncLine.KeepAlive(tokenExpiresIn = 0))
                 turbine.waitFor { !it.connected }
-                connector.cachedCredentials shouldBe null
+                connector.readCachedCredentials() shouldBe null
 
                 turbine.cancelAndIgnoreRemainingEvents()
             }

common/src/commonIntegrationTest/kotlin/com/powersync/sync/SyncIntegrationTest.kt

@@ -128,3 +128,8 @@ public abstract class PowerSyncBackendConnector {
     @Throws(PowerSyncException::class, CancellationException::class)
     public abstract suspend fun uploadData(database: PowerSyncDatabase)
 }
+
+// Not using this indirection causes linker errors in tests: https://youtrack.jetbrains.com/issue/CMP-3318
+internal fun PowerSyncBackendConnector.readCachedCredentials(): PowerSyncCredentials? {
+    return this.cachedCredentials
+}

common/src/commonMain/kotlin/com/powersync/DatabaseDriverFactory.kt renamed to common/src/commonMain/kotlin/com/powersync/ConnectionFactory.kt

@@ -11,27 +11,12 @@ structure:
 - `commonMain` - Shared code for all targets, which includes the `PowerSyncBackendConnector`
   interface and `PowerSyncBuilder` for building a `PowerSync` instance. It also defines
   the `DatabaseDriverFactory` class to be implemented in each platform.
-- `commonJava` - Common Java code including a Java SQLite driver using
-  the [Xerial JDBC Driver](https://github.com/xerial/sqlite-jdbc). This is used by both the Android
-  and JVM drivers.
 - `androidMain` - Android specific code, which includes an implementation of
-  `DatabaseDriverFactory`.
-- `jvmMain` - JVM specific code which includes an implementation of `DatabaseDriverFactory`.
-- `iosMain` - iOS specific code, which includes am implementation of `DatabaseDriverFactory` class
-  that creates an instance of `app.cash.sqldelight.driver.native.NativeSqliteDriver` and also sets
-  up native SQLite bindings for iOS.
-
-## Note on SQLDelight
-
-The PowerSync core module, internally makes use
-of [SQLDelight](https://sqldelight.github.io/sqldelight/latest/) for it database API and typesafe
-database
-query generation.
-
-The PowerSync core module does not currently support integrating with SQLDelight from client
-applications.
+  `PersistentConnectionFactory`.
+- `jvmMain` - JVM specific code which includes an implementation of `PersistentConnectionFactory`.
+- `nativeMain` - iOS specific code, which includes am implementation of `PersistentConnectionFactory`.
 
 ## Attachment Helpers
 
 This module contains attachment helpers under the `com.powersync.attachments` package. See
-the [Attachment Helpers README](./src/commonMain/kotlin/com/powersync/attachments/README.md)
+the [Attachment Helpers README](../common/src/commonMain/kotlin/com/powersync/attachments/README.md)

common/src/commonMain/kotlin/com/powersync/connectors/PowerSyncBackendConnector.kt

@@ -76,6 +76,7 @@ kotlin {
 
         commonTest.dependencies {
             implementation(projects.internal.testutils)
+            implementation(libs.kotlin.test)
         }
 
         // We're putting the native libraries into our JAR, so integration tests for the JVM can run as part of the unit

common/src/jvmMain/kotlin/com/powersync/DatabaseDriverFactory.jvm.kt renamed to common/src/jvmMain/kotlin/com/powersync/ConnectionFactory.jvm.kt

@@ -11,22 +11,13 @@ public actual class DatabaseDriverFactory: PersistentConnectionFactory, DriverBa
         path: String,
         openFlags: Int,
     ): SQLiteConnection = driver.open(path, openFlags)
-
-    internal companion object {
-        fun newDriver(): BundledSQLiteDriver {
-            return BundledSQLiteDriver().also { addPowerSyncExtension(it) }
-        }
-
-        @OptIn(ExperimentalPowerSyncAPI::class)
-        fun addPowerSyncExtension(driver: BundledSQLiteDriver) {
-            driver.addExtension(resolvePowerSyncLoadableExtensionPath()!!, "sqlite3_powersync_init")
-        }
-    }
 }
 
+internal fun newDriver() = BundledSQLiteDriver().also { it.addPowerSyncExtension() }
+
 @OptIn(ExperimentalPowerSyncAPI::class)
 public fun BundledSQLiteDriver.addPowerSyncExtension() {
-    DatabaseDriverFactory.addPowerSyncExtension(this)
+    addExtension(resolvePowerSyncLoadableExtensionPath()!!, "sqlite3_powersync_init")
 }
 
-internal actual val inMemoryDriver: InMemoryConnectionFactory = DriverBasedInMemoryFactory(DatabaseDriverFactory.newDriver())
+internal actual val inMemoryDriver: InMemoryConnectionFactory = DriverBasedInMemoryFactory(newDriver())