You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,6 @@
6
6
7
7
# PowerSync Swift
8
8
9
-
The PowerSync Swift SDK is an extension of the [PowerSync Kotlin Multiplatform SDK](https://github.com/powersync-ja/powersync-kotlin), and uses the API tool [SKIE](https://skie.touchlab.co/) and KMMBridge to generate and publish a native Swift SDK. More details about this configuration can be found in our blog [here](https://www.powersync.com/blog/using-kotlin-multiplatform-with-kmmbridge-and-skie-to-publish-a-native-swift-sdk).
10
-
11
9
The SDK reference for the PowerSync Swift SDK is available [here](https://docs.powersync.com/client-sdk-references/swift).
12
10
13
11
## Beta Release
@@ -31,11 +29,21 @@ The easiest way to test the PowerSync Swift SDK is to run our demo application.
to your `Package.swift` file and pin the dependency to a specific version. This is required because the package is in beta.
37
+
38
+
## Underlying Kotlin Dependency
39
+
40
+
The PowerSync Swift SDK currently makes use of the [PowerSync Kotlin Multiplatform SDK](https://github.com/powersync-ja/powersync-kotlin) with the API tool [SKIE](https://skie.touchlab.co/) and KMMBridge under the hood to help generate and publish the native Swift SDK. We will move to an entirely Swift native API in v1 and do not expect there to be any breaking changes.
41
+
42
+
43
+
## Migration from Alpha to Beta
44
+
45
+
* The `PowerSyncDatabase` no longer needs a driver argument and it must be removed.
46
+
* The interface for `PowerSyncDatabase` now uses `PowerSyncDatabaseProtocol` which may require some changes to databases uses.
47
+
* If you were using `__uploadData` and `__fetchCredentials` in your `PowerSyncBackendConnector` you must remove the `__` and update the methods to `uploadData` and `fetchCredentials`.
48
+
*`@MainThread` usage is no longer required and should be removed.
49
+
* Implementing `SuspendTaskWrapper` for database transactions is no longer required and should be removed.
0 commit comments