chore: rename swift package name and add comment (#4)

DominicGBauer · DominicGBauer · web-flow · commit 049b27645950 · 2024-12-10T09:14:58.000+02:00
* chore: rename swift package name

* chore: update package

* fix: gh action

---------

Co-authored-by: DominicGBauer &lt;dominic@nomanini.com&gt;
diff --git a/.github/workflows/build_and_test.yaml b/.github/workflows/build_and_test.yaml
@@ -11,4 +11,4 @@ jobs:
       - uses: actions/checkout@v4
       - name: Build and Test
         run: |
-          xcodebuild test -scheme PowerSyncSwift -destination "platform=iOS Simulator,name=iPhone 15"
+          xcodebuild test -scheme PowerSync -destination "platform=iOS Simulator,name=iPhone 15"
diff --git a/Demo/PowerSyncExample.xcodeproj/project.pbxproj b/Demo/PowerSyncExample.xcodeproj/project.pbxproj
@@ -7,7 +7,6 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
-		18F30B2A2CCA4CD900A58917 /* PowerSyncSwift in Frameworks */ = {isa = PBXBuildFile; productRef = 18F30B292CCA4CD900A58917 /* PowerSyncSwift */; };
 		6A4AD3852B9EE763005CBFD4 /* SupabaseConnector.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6A4AD3842B9EE763005CBFD4 /* SupabaseConnector.swift */; };
 		6A4AD3892B9EEB21005CBFD4 /* _Secrets.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6A4AD3882B9EEB21005CBFD4 /* _Secrets.swift */; };
 		6A4AD3902B9EF775005CBFD4 /* ErrorText.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6A4AD38F2B9EF775005CBFD4 /* ErrorText.swift */; };
@@ -40,6 +39,7 @@
 		B666587C2C63B88700159A81 /* SwiftUINavigationCore in Frameworks */ = {isa = PBXBuildFile; productRef = B666587B2C63B88700159A81 /* SwiftUINavigationCore */; };
 		B69F7D862C8EE27400565448 /* AnyCodable in Frameworks */ = {isa = PBXBuildFile; productRef = B69F7D852C8EE27400565448 /* AnyCodable */; };
 		B6B3698A2C64F4B30033C307 /* Navigation.swift in Sources */ = {isa = PBXBuildFile; fileRef = B6B369892C64F4B30033C307 /* Navigation.swift */; };
+		B6FFD5322D06DA8000EEE60F /* PowerSync in Frameworks */ = {isa = PBXBuildFile; productRef = B6FFD5312D06DA8000EEE60F /* PowerSync */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXCopyFilesBuildPhase section */
@@ -116,9 +116,9 @@
 				B66658772C63B7BB00159A81 /* IdentifiedCollections in Frameworks */,
 				B69F7D862C8EE27400565448 /* AnyCodable in Frameworks */,
 				B666587C2C63B88700159A81 /* SwiftUINavigationCore in Frameworks */,
+				B6FFD5322D06DA8000EEE60F /* PowerSync in Frameworks */,
 				6A9669022B9EE69500B05DCF /* Supabase in Frameworks */,
 				6A9669002B9EE4FE00B05DCF /* PostgREST in Frameworks */,
-				18F30B2A2CCA4CD900A58917 /* PowerSyncSwift in Frameworks */,
 				6A9668FE2B9EE4FE00B05DCF /* Auth in Frameworks */,
 				B666587A2C63B88700159A81 /* SwiftUINavigation in Frameworks */,
 			);
@@ -481,7 +481,7 @@
 				B66658792C63B88700159A81 /* SwiftUINavigation */,
 				B666587B2C63B88700159A81 /* SwiftUINavigationCore */,
 				B69F7D852C8EE27400565448 /* AnyCodable */,
-				18F30B292CCA4CD900A58917 /* PowerSyncSwift */,
+				B6FFD5312D06DA8000EEE60F /* PowerSync */,
 			);
 			productName = PowerSyncExample;
 			productReference = 6A7315842B9854220004CB17 /* PowerSyncExample.app */;
@@ -832,11 +832,6 @@
 /* End XCRemoteSwiftPackageReference section */
 
 /* Begin XCSwiftPackageProductDependency section */
-		18F30B292CCA4CD900A58917 /* PowerSyncSwift */ = {
-			isa = XCSwiftPackageProductDependency;
-			package = 18F30B282CCA4B3B00A58917 /* XCLocalSwiftPackageReference "../../powersync-swift" */;
-			productName = PowerSyncSwift;
-		};
 		6A9668FD2B9EE4FE00B05DCF /* Auth */ = {
 			isa = XCSwiftPackageProductDependency;
 			package = 6A9668FC2B9EE4FE00B05DCF /* XCRemoteSwiftPackageReference "supabase-swift" */;
@@ -872,6 +867,11 @@
 			package = B69F7D842C8EE27300565448 /* XCRemoteSwiftPackageReference "AnyCodable" */;
 			productName = AnyCodable;
 		};
+		B6FFD5312D06DA8000EEE60F /* PowerSync */ = {
+			isa = XCSwiftPackageProductDependency;
+			package = 18F30B282CCA4B3B00A58917 /* XCLocalSwiftPackageReference "../../powersync-swift" */;
+			productName = PowerSync;
+		};
 /* End XCSwiftPackageProductDependency section */
 	};
 	rootObject = 6A73157C2B9854220004CB17 /* Project object */;
diff --git a/Demo/PowerSyncExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/Demo/PowerSyncExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -15,8 +15,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/powersync-ja/powersync-kotlin.git",
       "state" : {
-        "revision" : "b547389faf77d0c79f30887b5d82489ee3f4de4b",
-        "version" : "1.0.0-BETA9.0"
+        "revision" : "ebdb9addc0494ad17f964e8c45617715d2ab6725",
+        "version" : "1.0.0-BETA11.0"
       }
     },
     {
diff --git a/Demo/PowerSyncExample/PowerSync/Schema.swift b/Demo/PowerSyncExample/PowerSync/Schema.swift
@@ -1,5 +1,5 @@
 import Foundation
-import PowerSyncSwift
+import PowerSync
 
 let LISTS_TABLE = "lists"
 let TODOS_TABLE = "todos"
diff --git a/Demo/PowerSyncExample/PowerSync/SupabaseConnector.swift b/Demo/PowerSyncExample/PowerSync/SupabaseConnector.swift
@@ -1,7 +1,7 @@
 import Auth
 import SwiftUI
 import Supabase
-import PowerSyncSwift
+import PowerSync
 import AnyCodable
 
 @Observable
diff --git a/Demo/PowerSyncExample/PowerSync/SystemManager.swift b/Demo/PowerSyncExample/PowerSync/SystemManager.swift
@@ -1,5 +1,5 @@
 import Foundation
-import PowerSyncSwift
+import PowerSync
 
 @Observable
 class SystemManager {
diff --git a/Package.resolved b/Package.resolved
@@ -5,8 +5,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/powersync-ja/powersync-kotlin.git",
       "state" : {
-        "revision" : "b547389faf77d0c79f30887b5d82489ee3f4de4b",
-        "version" : "1.0.0-BETA9.0"
+        "revision" : "ebdb9addc0494ad17f964e8c45617715d2ab6725",
+        "version" : "1.0.0-BETA11.0"
       }
     },
     {
diff --git a/Package.swift b/Package.swift
@@ -2,7 +2,7 @@
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
-let packageName = "PowerSyncSwift"
+let packageName = "PowerSync"
 
 let package = Package(
     name: packageName,
@@ -14,10 +14,10 @@ let package = Package(
         // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
             name: packageName,
-            targets: ["PowerSyncSwift"]),
+            targets: ["PowerSync"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/powersync-ja/powersync-kotlin.git", exact: "1.0.0-BETA9.0"),
+        .package(url: "https://github.com/powersync-ja/powersync-kotlin.git", exact: "1.0.0-BETA11.0"),
         .package(url: "https://github.com/powersync-ja/powersync-sqlite-core-swift.git", "0.3.1"..<"0.4.0"),
     ],
     targets: [
@@ -26,12 +26,12 @@ let package = Package(
         .target(
             name: packageName,
             dependencies: [
-                .product(name: "PowerSync", package: "powersync-kotlin"),
+                .product(name: "PowerSyncKotlin", package: "powersync-kotlin"),
                 .product(name: "PowerSyncSQLiteCore", package: "powersync-sqlite-core-swift")
             ]),
         .testTarget(
-            name: "PowerSyncSwiftTests",
-            dependencies: ["PowerSyncSwift"]
+            name: "PowerSyncTests",
+            dependencies: ["PowerSync"]
         ),
     ]
 )
diff --git a/Sources/PowerSync/Kotlin/KotlinAdapter.swift b/Sources/PowerSync/Kotlin/KotlinAdapter.swift
@@ -1,18 +1,18 @@
-import PowerSync
+import PowerSyncKotlin
 
 internal struct KotlinAdapter {
     struct Index {
-        static func toKotlin(_ index: IndexProtocol) -> PowerSync.Index {
-            PowerSync.Index(
+        static func toKotlin(_ index: IndexProtocol) -> PowerSyncKotlin.Index {
+            PowerSyncKotlin.Index(
                 name: index.name,
                 columns: index.columns.map { IndexedColumn.toKotlin($0) }
             )
         }
     }
     
     struct IndexedColumn {
-        static func toKotlin(_ column: IndexedColumnProtocol) -> PowerSync.IndexedColumn {
-            return PowerSync.IndexedColumn(
+        static func toKotlin(_ column: IndexedColumnProtocol) -> PowerSyncKotlin.IndexedColumn {
+            return PowerSyncKotlin.IndexedColumn(
                 column: column.column,
                 ascending: column.ascending,
                 columnDefinition: nil,
@@ -22,8 +22,8 @@ internal struct KotlinAdapter {
     }
     
     struct Table {
-        static func toKotlin(_ table: TableProtocol) -> PowerSync.Table {
-            PowerSync.Table(
+        static func toKotlin(_ table: TableProtocol) -> PowerSyncKotlin.Table {
+            PowerSyncKotlin.Table(
                 name: table.name,
                 columns: table.columns.map {Column.toKotlin($0)},
                 indexes: table.indexes.map { Index.toKotlin($0) },
@@ -35,28 +35,28 @@ internal struct KotlinAdapter {
     }
     
     struct Column {
-        static func toKotlin(_ column: any ColumnProtocol) -> PowerSync.Column {
-            PowerSync.Column(
+        static func toKotlin(_ column: any ColumnProtocol) -> PowerSyncKotlin.Column {
+            PowerSyncKotlin.Column(
                 name: column.name,
                 type: columnType(from: column.type)
             )
         }
         
-        private static func columnType(from swiftType: ColumnData) -> PowerSync.ColumnType {
+        private static func columnType(from swiftType: ColumnData) -> PowerSyncKotlin.ColumnType {
             switch swiftType {
             case .text:
-                return PowerSync.ColumnType.text
+                return PowerSyncKotlin.ColumnType.text
             case .integer:
-                return PowerSync.ColumnType.integer
+                return PowerSyncKotlin.ColumnType.integer
             case .real:
-                return PowerSync.ColumnType.real
+                return PowerSyncKotlin.ColumnType.real
             }
         }
     }
     
     struct Schema {
-        static func toKotlin(_ schema: SchemaProtocol) -> PowerSync.Schema {
-            PowerSync.Schema(
+        static func toKotlin(_ schema: SchemaProtocol) -> PowerSyncKotlin.Schema {
+            PowerSyncKotlin.Schema(
                 tables: schema.tables.map { Table.toKotlin($0) }
             )
         }
diff --git a/Sources/PowerSync/Kotlin/KotlinPowerSyncDatabaseImpl.swift b/Sources/PowerSync/Kotlin/KotlinPowerSyncDatabaseImpl.swift
@@ -1,8 +1,8 @@
 import Foundation
-import PowerSync
+import PowerSyncKotlin
 
 final class KotlinPowerSyncDatabaseImpl: PowerSyncDatabaseProtocol {
-    private let kotlinDatabase: PowerSync.PowerSyncDatabase
+    private let kotlinDatabase: PowerSyncKotlin.PowerSyncDatabase
 
     var currentStatus: SyncStatus {
         get { kotlinDatabase.currentStatus }
@@ -12,7 +12,7 @@ final class KotlinPowerSyncDatabaseImpl: PowerSyncDatabaseProtocol {
         schema: Schema,
         dbFilename: String
     ) {
-        let factory = PowerSync.DatabaseDriverFactory()
+        let factory = PowerSyncKotlin.DatabaseDriverFactory()
         self.kotlinDatabase = PowerSyncDatabase(
             factory: factory,
             schema: KotlinAdapter.Schema.toKotlin(schema),
diff --git a/Sources/PowerSync/Kotlin/KotlinTypes.swift b/Sources/PowerSync/Kotlin/KotlinTypes.swift
@@ -0,0 +1,12 @@
+import PowerSyncKotlin
+
+public typealias KotlinPowerSyncBackendConnector = PowerSyncKotlin.PowerSyncBackendConnector
+public typealias CrudEntry = PowerSyncKotlin.CrudEntry
+public typealias CrudBatch = PowerSyncKotlin.CrudBatch
+public typealias SyncStatus = PowerSyncKotlin.SyncStatus
+public typealias SqlCursor = PowerSyncKotlin.RuntimeSqlCursor
+public typealias JsonParam = PowerSyncKotlin.JsonParam
+public typealias CrudTransaction = PowerSyncKotlin.CrudTransaction
+public typealias KotlinPowerSyncCredentials = PowerSyncKotlin.PowerSyncCredentials
+public typealias KotlinPowerSyncDatabase = PowerSyncKotlin.PowerSyncDatabase
+
diff --git a/Sources/PowerSync/PowerSyncBackendConnector.swift b/Sources/PowerSync/PowerSyncBackendConnector.swift
diff --git a/Sources/PowerSync/PowerSyncBackendConnectorAdapter.swift b/Sources/PowerSync/PowerSyncBackendConnectorAdapter.swift
diff --git a/Sources/PowerSync/PowerSyncCredentials.swift b/Sources/PowerSync/PowerSyncCredentials.swift
diff --git a/Sources/PowerSync/PowerSyncDatabase.swift b/Sources/PowerSync/PowerSyncDatabase.swift
diff --git a/Sources/PowerSync/PowerSyncDatabaseProtocol.swift b/Sources/PowerSync/PowerSyncDatabaseProtocol.swift
diff --git a/Sources/PowerSync/QueriesProtocol.swift b/Sources/PowerSync/QueriesProtocol.swift
@@ -1,9 +1,10 @@
 import Foundation
 import Combine
-import PowerSync
+import PowerSyncKotlin
 
 public protocol Queries {
     /// Execute a write query (INSERT, UPDATE, DELETE)
+    /// Using `RETURNING *` will result in an error.
     func execute(sql: String, parameters: [Any]?) async throws -> Int64
     
     /// Execute a read-only (SELECT) query and return a single result.
diff --git a/Sources/PowerSync/Schema/Column.swift b/Sources/PowerSync/Schema/Column.swift
@@ -1,5 +1,5 @@
 import Foundation
-import PowerSync
+import PowerSyncKotlin
 
 public protocol ColumnProtocol: Equatable {
     var name: String { get }
diff --git a/Sources/PowerSync/Schema/Index.swift b/Sources/PowerSync/Schema/Index.swift
@@ -1,5 +1,5 @@
 import Foundation
-import PowerSync
+import PowerSyncKotlin
 
 public protocol IndexProtocol {
     var name: String { get }
diff --git a/Sources/PowerSync/Schema/IndexedColumn.swift b/Sources/PowerSync/Schema/IndexedColumn.swift
diff --git a/Sources/PowerSync/Schema/Schema.swift b/Sources/PowerSync/Schema/Schema.swift
diff --git a/Sources/PowerSync/Schema/Table.swift b/Sources/PowerSync/Schema/Table.swift
diff --git a/Sources/PowerSyncSwift/Kotlin/KotlinTypes.swift b/Sources/PowerSyncSwift/Kotlin/KotlinTypes.swift
diff --git a/Tests/PowerSyncTests/Kotlin/KotlinPowerSyncDatabaseImplTests.swift b/Tests/PowerSyncTests/Kotlin/KotlinPowerSyncDatabaseImplTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import PowerSyncSwift
+@testable import PowerSync
 
 final class KotlinPowerSyncDatabaseImplTests: XCTestCase {
     private var database: KotlinPowerSyncDatabaseImpl!
diff --git a/Tests/PowerSyncTests/Schema/ColumnTests.swift b/Tests/PowerSyncTests/Schema/ColumnTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import PowerSyncSwift
+@testable import PowerSync
 
 final class ColumnTests: XCTestCase {
     
diff --git a/Tests/PowerSyncTests/Schema/IndexTests.swift b/Tests/PowerSyncTests/Schema/IndexTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import PowerSyncSwift
+@testable import PowerSync
 
 final class IndexTests: XCTestCase {
     
diff --git a/Tests/PowerSyncTests/Schema/IndexedColumnTests.swift b/Tests/PowerSyncTests/Schema/IndexedColumnTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import PowerSyncSwift
+@testable import PowerSync
 
 final class IndexedColumnTests: XCTestCase {
     
diff --git a/Tests/PowerSyncTests/Schema/SchemaTests.swift b/Tests/PowerSyncTests/Schema/SchemaTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import PowerSyncSwift
+@testable import PowerSync
 
 final class SchemaTests: XCTestCase {
     private func makeValidTable(name: String) -> Table {
diff --git a/Tests/PowerSyncTests/Schema/TableTests.swift b/Tests/PowerSyncTests/Schema/TableTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import PowerSyncSwift
+@testable import PowerSync
 
 final class TableTests: XCTestCase {
     

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@`
`15`	`15`	`"kind" : "remoteSourceControl",`
`16`	`16`	`"location" : "https://github.com/powersync-ja/powersync-kotlin.git",`
`17`	`17`	`"state" : {`
`18`		`- "revision" : "b547389faf77d0c79f30887b5d82489ee3f4de4b",`
`19`		`- "version" : "1.0.0-BETA9.0"`
	`18`	`+ "revision" : "ebdb9addc0494ad17f964e8c45617715d2ab6725",`
	`19`	`+ "version" : "1.0.0-BETA11.0"`
`20`	`20`	`}`
`21`	`21`	`},`
`22`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,8 @@`
`5`	`5`	`"kind" : "remoteSourceControl",`
`6`	`6`	`"location" : "https://github.com/powersync-ja/powersync-kotlin.git",`
`7`	`7`	`"state" : {`
`8`		`- "revision" : "b547389faf77d0c79f30887b5d82489ee3f4de4b",`
`9`		`- "version" : "1.0.0-BETA9.0"`
	`8`	`+ "revision" : "ebdb9addc0494ad17f964e8c45617715d2ab6725",`
	`9`	`+ "version" : "1.0.0-BETA11.0"`
`10`	`10`	`}`
`11`	`11`	`},`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,18 @@`
`1`		`-import PowerSync`
	`1`	`+import PowerSyncKotlin`
`2`	`2`
`3`	`3`	`internal struct KotlinAdapter {`
`4`	`4`	`struct Index {`
`5`		`- static func toKotlin(_ index: IndexProtocol) -> PowerSync.Index {`
`6`		`- PowerSync.Index(`
	`5`	`+ static func toKotlin(_ index: IndexProtocol) -> PowerSyncKotlin.Index {`
	`6`	`+ PowerSyncKotlin.Index(`
`7`	`7`	`name: index.name,`
`8`	`8`	`columns: index.columns.map { IndexedColumn.toKotlin($0) }`
`9`	`9`	`)`
`10`	`10`	`}`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`struct IndexedColumn {`
`14`		`- static func toKotlin(_ column: IndexedColumnProtocol) -> PowerSync.IndexedColumn {`
`15`		`- return PowerSync.IndexedColumn(`
	`14`	`+ static func toKotlin(_ column: IndexedColumnProtocol) -> PowerSyncKotlin.IndexedColumn {`
	`15`	`+ return PowerSyncKotlin.IndexedColumn(`
`16`	`16`	`column: column.column,`
`17`	`17`	`ascending: column.ascending,`
`18`	`18`	`columnDefinition: nil,`
`@@ -22,8 +22,8 @@ internal struct KotlinAdapter {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`struct Table {`
`25`		`- static func toKotlin(_ table: TableProtocol) -> PowerSync.Table {`
`26`		`- PowerSync.Table(`
	`25`	`+ static func toKotlin(_ table: TableProtocol) -> PowerSyncKotlin.Table {`
	`26`	`+ PowerSyncKotlin.Table(`
`27`	`27`	`name: table.name,`
`28`	`28`	`columns: table.columns.map {Column.toKotlin($0)},`
`29`	`29`	`indexes: table.indexes.map { Index.toKotlin($0) },`
`@@ -35,28 +35,28 @@ internal struct KotlinAdapter {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`struct Column {`
`38`		`- static func toKotlin(_ column: any ColumnProtocol) -> PowerSync.Column {`
`39`		`- PowerSync.Column(`
	`38`	`+ static func toKotlin(_ column: any ColumnProtocol) -> PowerSyncKotlin.Column {`
	`39`	`+ PowerSyncKotlin.Column(`
`40`	`40`	`name: column.name,`
`41`	`41`	`type: columnType(from: column.type)`
`42`	`42`	`)`
`43`	`43`	`}`
`44`	`44`
`45`		`- private static func columnType(from swiftType: ColumnData) -> PowerSync.ColumnType {`
	`45`	`+ private static func columnType(from swiftType: ColumnData) -> PowerSyncKotlin.ColumnType {`
`46`	`46`	`switch swiftType {`
`47`	`47`	`case .text:`
`48`		`- return PowerSync.ColumnType.text`
	`48`	`+ return PowerSyncKotlin.ColumnType.text`
`49`	`49`	`case .integer:`
`50`		`- return PowerSync.ColumnType.integer`
	`50`	`+ return PowerSyncKotlin.ColumnType.integer`
`51`	`51`	`case .real:`
`52`		`- return PowerSync.ColumnType.real`
	`52`	`+ return PowerSyncKotlin.ColumnType.real`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`struct Schema {`
`58`		`- static func toKotlin(_ schema: SchemaProtocol) -> PowerSync.Schema {`
`59`		`- PowerSync.Schema(`
	`58`	`+ static func toKotlin(_ schema: SchemaProtocol) -> PowerSyncKotlin.Schema {`
	`59`	`+ PowerSyncKotlin.Schema(`
`60`	`60`	`tables: schema.tables.map { Table.toKotlin($0) }`
`61`	`61`	`)`
`62`	`62`	`}`