Documentation edits made through Mintlify web editor

Author: benitav

client-sdk-references/swift.mdx

@@ -4,26 +4,33 @@ sidebarTitle: "Overview"
 ---
 
 <Note>
-    The PowerSync Swift SDK is currently in an alpha release. It is not suitable for production use at this stage unless you've tested your use cases extensively. Breaking changes are still likely to occur.
+  The PowerSync Swift SDK is currently in an alpha release. It is not suitable for production use at this stage unless you've tested your use cases extensively. Breaking changes are still likely to occur.
 </Note>
 
 ## Kotlin Multiplatform -> Native Swift SDK
 
 This SDK is an extension of the [Kotlin Multiplatform SDK](https://github.com/powersync-ja/powersync-kotlin), and utilizes the API tool [SKIE](https://skie.touchlab.co/) to generate and publish a [PowerSync SDK](https://github.com/powersync-ja/powersync-kotlin/tree/main/PowerSync) that can be used in a standalone Swift app. Further 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).
 
-<Info>
-**Demo App**
+For the beta, we are moving away from this Kotlin-based architecture towards more Swift-native APIs. For the stable release, will are planning a fully native Swift SDK.
 
-We recommend the [Supabase Todo List Demo](https://github.com/powersync-ja/powersync-kotlin-swift-demo) app as a starting point for using the Swift SDK. See the README for details to run it.
-</Info>
+<Tip>
+  **Demo App**
+
+  We recommend the [Supabase Todo List Demo](https://github.com/powersync-ja/powersync-kotlin-swift-demo) app as a starting point for using the Swift SDK. See the README for details to run it.
+</Tip>
 
 ### SDK Features
 
 * Provides real-time streaming of database changes.
+
 * Offers direct access to the SQLite database, enabling the use of SQL on both client and server sides.
+
 * Operations are asynchronous by default, ensuring the user interface remains unblocked.
+
 * Supports concurrent database operations, allowing one write and multiple reads simultaneously.
+
 * Enables subscription to queries for receiving live updates.
+
 * Eliminates the need for client-side database migrations as these are managed automatically.
 
 ## Installation
@@ -61,41 +68,42 @@ let package = Package(
 )
 ```
 
-2.  Using Xcode:
+1. Using Xcode:
+   <Frame>
+     <img src="/images/swift.avif" />
+   </Frame>
+   <Frame>
+     <img src="/images/image (1).png" />
+   </Frame>
 
-    1. Follow [this](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#Add-a-package-dependency) guide to add a package to your project.
-    2.  When searching for the package use [https://github.com/powersync-ja/powersync-kotlin.git](https://github.com/powersync-ja/powersync-kotlin.git) as the URL and include the exact version `1.0.0-BETA5.0` as shown below:
+   1. Do the same for `power-sqlite-core-swift` using [https://github.com/powersync-ja/powersync-sqlite-core-swift.git](https://github.com/powersync-ja/powersync-kotlin.git) and choose a range between `0.3.1` and `0.4.0` as shown below:
 
-    <Frame>
-        
-        <img src="/images/swift.avif"></img>
-    </Frame>
+   1) Follow [this](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#Add-a-package-dependency) guide to add a package to your project.
 
-    3. Do the same for `power-sqlite-core-swift` using [https://github.com/powersync-ja/powersync-sqlite-core-swift.git](https://github.com/powersync-ja/powersync-kotlin.git) and choose a range between `0.3.1` and `0.4.0` as shown below:
-
-    <Frame>
-        <img src="/images/image (1).png"></img>
-    </Frame>
+   2) When searching for the package use [https://github.com/powersync-ja/powersync-kotlin.git](https://github.com/powersync-ja/powersync-kotlin.git) as the URL and include the exact version `1.0.0-BETA5.0` as shown below:
 
 <Note>
-    Use the exact version for `powersync-kotlin` as we are actively making changes to the Swift SDK which could result in breaking changes. The version history can be found [here](https://central.sonatype.com/artifact/com.powersync/core/versions).
+  Use the exact version for `powersync-kotlin` as we are actively making changes to the Swift SDK which could result in breaking changes. The version history can be found [here](https://central.sonatype.com/artifact/com.powersync/core/versions).
 </Note>
 
 ## Getting Started
 
 Before implementing the PowerSync SDK in your project, make sure you have completed these steps:
 
 * Signed up for a PowerSync Cloud account ([here](https://accounts.journeyapps.com/portal/get-started?powersync=true)) or [self-host PowerSync](/self-hosting/getting-started).
+
 * [Configured your backend database](/installation/database-setup) and connected it to your PowerSync instance.
+
 * [Installed](/client-sdk-references/swift#installation) the PowerSync SDK.
 
-### 1\. Define the Schema
+### 1. Define the Schema
 
 The first step is defining the schema for the local SQLite database, which is provided to the `PowerSyncDatabase` constructor via the `schema` parameter. This schema represents a "view" of the downloaded data. No migrations are required — the schema is applied directly when the PowerSync database is constructed.
 
 The types available are `text`, `integer` and `real`. These should map directly to the values produced by the [Sync Rules](/usage/sync-rules). If a value doesn't match, it is cast automatically.
 
 **Example**:
+
 ```swift
 import Foundation
 import PowerSync
@@ -148,10 +156,10 @@ let AppSchema = Schema(tables: [lists, todos])
 ```
 
 <Info>
-    **Note**: No need to declare a primary key `id` column, as PowerSync will automatically create this.
+  **Note**: No need to declare a primary key `id` column, as PowerSync will automatically create this.
 </Info>
 
-### 2\. Instantiate the PowerSync Database
+### 2. Instantiate the PowerSync Database
 
 Next, you need to instantiate the PowerSync database — this is the core managed database.
 
@@ -172,20 +180,22 @@ var db = PowerSyncDatabase(
 )
 ```
 
-### 3\. Integrate with your Backend
+### 3. Integrate with your Backend
 
 Create a connector to integrate with your backend. The PowerSync backend connector provides the connection between your application backend and the PowerSync managed database.
 
 It is used to:
 
 1. Retrieve an auth token to connect to the PowerSync instance.
+
 2. Apply local changes on your backend application server (and from there, to Postgres)
 
 Accordingly, the connector must implement two methods:
 
-1. `PowerSyncBackendConnector.fetchCredentials` \- This is called every couple of minutes and is used to obtain credentials for your app's backend API. -> See [Authentication Setup](/installation/authentication-setup) for instructions on how the credentials should be generated.
-2. `PowerSyncBackendConnector.uploadData` \- Use this to upload client-side changes to your app backend.
-\-> See [Writing Client Changes](/installation/app-backend-setup/writing-client-changes) for considerations on the app backend implementation.
+1. `PowerSyncBackendConnector.fetchCredentials` - This is called every couple of minutes and is used to obtain credentials for your app's backend API. -> See [Authentication Setup](/installation/authentication-setup) for instructions on how the credentials should be generated.
+
+2. `PowerSyncBackendConnector.uploadData` - Use this to upload client-side changes to your app backend.
+   -> See [Writing Client Changes](/installation/app-backend-setup/writing-client-changes) for considerations on the app backend implementation.
 
 **Example**:
 
@@ -218,7 +228,7 @@ class MyConnector: PowerSyncBackendConnector {
 ```
 
 <Info>
-    If you are using **Supabase**, you can use [SupabaseConnector.swift](https://github.com/powersync-ja/powersync-kotlin-swift-demo/blob/main/PowerSyncExample/PowerSync/SupabaseConnector.swift) as a starting point.
+  If you are using **Supabase**, you can use [SupabaseConnector.swift](https://github.com/powersync-ja/powersync-kotlin-swift-demo/blob/main/PowerSyncExample/PowerSync/SupabaseConnector.swift) as a starting point.
 </Info>
 
 ## Using PowerSync: CRUD functions
@@ -227,11 +237,15 @@ Once the PowerSync instance is configured you can start using the SQLite DB func
 
 The most commonly used CRUD functions to interact with your SQLite data are:
 
-* [PowerSyncDatabase.get](/client-sdk-references/swift#fetching-a-single-item) \- get (SELECT) a single row from a table.
-* [PowerSyncDatabase.getOptional](/client-sdk-references/swift#fetching-a-single-item) \- get (SELECT) a single row from a table and return `null` if not found.
-* [PowerSyncDatabase.getAll](/client-sdk-references/swift#querying-items-powersync-getall) \- get (SELECT) a set of rows from a table.
-* [PowerSyncDatabase.watch](/client-sdk-references/swift#watching-queries-powersync-watch) \- execute a read query every time source tables are modified.
-* [PowerSyncDatabase.execute](/client-sdk-references/swift#mutations-powersync-execute) \- execute a write (INSERT/UPDATE/DELETE) query.
+* [PowerSyncDatabase.get](/client-sdk-references/swift#fetching-a-single-item) - get (SELECT) a single row from a table.
+
+* [PowerSyncDatabase.getOptional](/client-sdk-references/swift#fetching-a-single-item) - get (SELECT) a single row from a table and return `null` if not found.
+
+* [PowerSyncDatabase.getAll](/client-sdk-references/swift#querying-items-powersync-getall) - get (SELECT) a set of rows from a table.
+
+* [PowerSyncDatabase.watch](/client-sdk-references/swift#watching-queries-powersync-watch) - execute a read query every time source tables are modified.
+
+* [PowerSyncDatabase.execute](/client-sdk-references/swift#mutations-powersync-execute) - execute a write (INSERT/UPDATE/DELETE) query.
 
 ### Fetching a Single Item ( PowerSync.get / PowerSync.getOptional)
 
@@ -329,4 +343,4 @@ func deleteTodo(id: String) async throws {
         return
     })
 }
-```
+```