feat: MAUI support

.github/workflows/dev-packages.yml

@@ -1,5 +1,5 @@
 # The version is pulled from the CHANGELOG.md file of the package.
-# Add a `-dev.xxx` suffix to the version.
+# Add a `-dev.xxx` suffix to the version. Example: `0.0.1-dev.1`
 name: Create Dev Release
 
 on: workflow_dispatch
@@ -24,17 +24,32 @@ jobs:
       - name: Restore dependencies
         run: dotnet restore
 
-      - name: Extract Version from CHANGELOG.md
+      - name: Extract Common Package Version from CHANGELOG.md
         id: extract_version
         shell: bash
         run: |
-          VERSION=$(awk '/^## [0-9]+\.[0-9]+\.[0-9]+-dev(\.[0-9]+)?$/ {print $2; exit}' PowerSync/PowerSync.Common/CHANGELOG.md)
-          echo "Detected Version: $VERSION"
-          echo "VERSION=$VERSION" >> $GITHUB_ENV 
+          COMMON_VERSION=$(awk '/^## [0-9]+\.[0-9]+\.[0-9]+-dev(\.[0-9]+)?$/ {print $2; exit}' PowerSync/PowerSync.Common/CHANGELOG.md)
+          echo "Detected Version: $COMMON_VERSION"
+          echo "VERSION=$COMMON_VERSION" >> $GITHUB_ENV 
 
-      - name: Run Pack
-        run: dotnet pack -c Release -o ${{ github.workspace }}/output
+      - name: Run Pack For Common
+        run: dotnet pack PowerSync/PowerSync.Common -c Release -o ${{ github.workspace }}/output
 
-      - name: Run Push
-        run: dotnet nuget push ${{ github.workspace }}\output\*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}
-
+      - name: Run Push For Common
+        continue-on-error: true
+        run: dotnet nuget push ${{ github.workspace }}\output\PowerSync.Common*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}
+
+      - name: Extract MAUI Package Version from CHANGELOG.md
+        id: extract_maui_version
+        shell: bash
+        run: |
+          MAUI_VERSION=$(awk '/^## [0-9]+\.[0-9]+\.[0-9]+-dev(\.[0-9]+)?$/ {print $2; exit}' PowerSync/PowerSync.Maui/CHANGELOG.md)
+          echo "Detected Version: $MAUI_VERSION"
+          echo "VERSION=$MAUI_VERSION" >> $GITHUB_ENV 
+
+      - name: Run Pack For MAUI
+        run: dotnet pack PowerSync/PowerSync.Maui -c Release -o ${{ github.workspace }}/output
+
+      - name: Run Push For MAUI
+        continue-on-error: true
+        run: dotnet nuget push ${{ github.workspace }}\output\PowerSync.Maui*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}    

.github/workflows/release.yml

@@ -24,17 +24,32 @@ jobs:
       - name: Restore dependencies
         run: dotnet restore
 
-      - name: Extract Version from CHANGELOG.md
+      - name: Extract Common Package Version from CHANGELOG.md
         id: extract_version
         shell: bash
         run: |
           VERSION=$(awk '/^## [0-9]+\.[0-9]+\.[0-9]+/ {print $2; exit}' PowerSync/PowerSync.Common/CHANGELOG.md)
           echo "Detected Version: $VERSION"
           echo "VERSION=$VERSION" >> $GITHUB_ENV 
 
-      - name: Run Pack
-        run: dotnet pack -c Release -o ${{ github.workspace }}/output
+      - name: Run Pack for Common
+        run: dotnet pack PowerSync/PowerSync.Common -c Release -o ${{ github.workspace }}/output
 
-      - name: Run Push
-        run: dotnet nuget push ${{ github.workspace }}\output\*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}
-
+      - name: Run Push for Common
+        continue-on-error: true
+        run: dotnet nuget push ${{ github.workspace }}\output\PowerSync.Common*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}
+
+      - name: Extract MAUI Package Version from CHANGELOG.md
+        id: extract_maui_version
+        shell: bash
+        run: |
+          MAUI_VERSION=$(awk '/^## [0-9]+\.[0-9]+\.[0-9]+/ {print $2; exit}' PowerSync/PowerSync.Maui/CHANGELOG.md)
+          echo "Detected Version: $MAUI_VERSION"
+          echo "VERSION=$MAUI_VERSION" >> $GITHUB_ENV
+
+      - name: Run Pack For MAUI
+        run: dotnet pack PowerSync/PowerSync.Maui -c Release -o ${{ github.workspace }}/output
+
+      - name: Run Push For MAUI
+        continue-on-error: true
+        run: dotnet nuget push ${{ github.workspace }}\output\PowerSync.Maui*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}

.gitignore

@@ -14,6 +14,7 @@ obj/
 *.log
 *.tlog
 *.dmp
+*.tmp
 
 # Visual Studio specific
 .vscode/
@@ -61,8 +62,9 @@ TestResults/
 *.dylib
 *.dll
 *.so
-
+*.xcframework
 .env
+*NativeLibs
 
 # Ignore user id file
 user_id.txt

PowerSync/PowerSync.Common/CHANGELOG.md

@@ -1,3 +1,8 @@
+# PowerSync.Common Changelog
+
+## 0.0.3-alpha.1
+- Minor changes to accommodate PowerSync.MAUI package extension.
+
 ## 0.0.2-alpha.2
 
 - Updated core extension to v0.3.14

PowerSync/PowerSync.Common/Client/PowerSyncDatabase.cs

@@ -35,11 +35,6 @@ public class DBAdapterSource(IDBAdapter Adapter) : IDatabaseSource
     public IDBAdapter Adapter { get; init; } = Adapter;
 }
 
-public class OpenFactorySource(ISQLOpenFactory Factory) : IDatabaseSource
-{
-    public ISQLOpenFactory Factory { get; init; } = Factory;
-}
-
 public class PowerSyncDatabaseOptions() : BasePowerSyncDatabaseOptions()
 {
     /// <summary> 
@@ -115,9 +110,9 @@ public PowerSyncDatabase(PowerSyncDatabaseOptions options)
         {
             Database = adapterSource.Adapter;
         }
-        else if (options.Database is OpenFactorySource factorySource)
+        else if (options.Database is ISQLOpenFactory factorySource)
         {
-            Database = factorySource.Factory.OpenDatabase();
+            Database = factorySource.OpenDatabase();
         }
         else if (options.Database is SQLOpenOptions openOptions)
         {

PowerSync/PowerSync.Common/Client/SQLOpenFactory.cs

@@ -15,7 +15,7 @@ public class SQLOpenOptions : IDatabaseSource
     public string? DbLocation { get; set; }
 }
 
-public interface ISQLOpenFactory
+public interface ISQLOpenFactory: IDatabaseSource
 {
     /// <summary>
     /// Opens a connection adapter to a SQLite Database.

PowerSync/PowerSync.Common/DB/Crud/SyncStatus.cs

@@ -10,18 +10,24 @@ public class SyncDataFlowStatus
     [JsonProperty("uploading")]
     public bool Uploading { get; set; } = false;
 
+    [JsonProperty("downloadError")]
+    public string? DownloadErrorMessage => DownloadError?.Message;
+
+    [JsonProperty("uploadError")]
+    public string? UploadErrorMessage => UploadError?.Message;
+
     /// <summary>
     /// Error during downloading (including connecting).
     /// Cleared on the next successful data download.
     /// </summary>
-    [JsonProperty("downloadError")]
+    [JsonIgnore]
     public Exception? DownloadError { get; set; } = null;
 
     /// <summary>
     /// Error during uploading.
     /// Cleared on the next successful upload.
     /// </summary>
-    [JsonProperty("uploadError")]
+    [JsonIgnore]
     public Exception? UploadError { get; set; } = null;
 }
 

PowerSync/PowerSync.Common/MDSQLite/MDSQLiteAdapter.cs

@@ -129,7 +129,7 @@ private static SqliteConnection OpenDatabase(string dbFilename)
         return connection;
     }
 
-    private void LoadExtension(SqliteConnection db)
+    protected virtual void LoadExtension(SqliteConnection db)
     {
         string extensionPath = PowerSyncPathResolver.GetNativeLibraryPath(AppContext.BaseDirectory);
         db.EnableExtensions(true);

PowerSync/PowerSync.Common/MDSQLite/MDSQLiteDBOpenFactory.cs

@@ -8,11 +8,11 @@ public class MDSQLiteOpenFactoryOptions : SQLOpenOptions
     public MDSQLiteOptions? SqliteOptions { get; set; }
 }
 
-public class MDSqliteDBOpenFactory : ISQLOpenFactory
+public class MDSQLiteDBOpenFactory : ISQLOpenFactory
 {
     private readonly MDSQLiteOpenFactoryOptions options;
 
-    public MDSqliteDBOpenFactory(MDSQLiteOpenFactoryOptions options)
+    public MDSQLiteDBOpenFactory(MDSQLiteOpenFactoryOptions options)
     {
         this.options = options;
     }

PowerSync/PowerSync.Common/PowerSync.Common.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;net6.0;net8.0;net9.0</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;net6.0;net8.0;net9.0;net8.0-ios;net8.0-android</TargetFrameworks>
     <LangVersion>12</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
@@ -19,6 +19,7 @@
     <PackageIcon>icon.png</PackageIcon>
     <NoWarn>NU5100</NoWarn>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <DefaultItemExcludes>$(DefaultItemExcludes);runtimes/**/*.*;</DefaultItemExcludes>
   </PropertyGroup>
 
   <ItemGroup>
@@ -29,20 +30,20 @@
     <PackageReference Include="Nito.AsyncEx" Version="5.1.2" />
     <PackageReference Include="System.Threading.Channels" Version="8.0.0" />
   </ItemGroup>
-
-  <!-- For monorepo, test if we can remove this in monorepo -->
-  <ItemGroup>
+
+  <!-- Check allows us to skip for all MAUI targets-->
+  <!-- For monorepo-->
+  <ItemGroup Condition="!$(TargetFramework.Contains('-'))">
     <Content Include="runtimes\**\*.*">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>
 
   <!-- For releasing runtimes  -->
-  <ItemGroup>
+  <ItemGroup Condition="!$(TargetFramework.Contains('-'))">
     <None Include="runtimes\**\*.*" Pack="true" PackagePath="runtimes\" />
   </ItemGroup>
-
-
+
   <ItemGroup>
     <None Include="..\..\icon.png" Pack="true" PackagePath=""/>
     <None Include="README.md" Pack="true" PackagePath=""/>

PowerSync/PowerSync.Maui/CHANGELOG.md

@@ -0,0 +1,9 @@
+# PowerSync.Maui Changelog
+
+## 0.0.1-alpha.1
+
+- Introduce package. Support for iOS/Android use cases.
+
+### Platform Runtime Support Added
+* MAUI iOS
+* MAUI Android

PowerSync/PowerSync.Maui/PowerSync.Maui.csproj

@@ -0,0 +1,57 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>netstandard2.0;net6.0;net8.0;net9.0;net8.0-ios;net8.0-android</TargetFrameworks>
+    <LangVersion>12</LangVersion>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <PackageId>PowerSync.Maui</PackageId>
+    <Title>PowerSync.Maui</Title>
+    <Description>PowerSync.Maui is a package that enables MAUI usage for PowerSync</Description>
+    <Authors>PowerSync</Authors>
+    <owners>powersync</owners>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+    <RepositoryUrl>https://github.com/powersync-ja/powersync-dotnet</RepositoryUrl>
+    <PackageProjectUrl>https://powersync.com</PackageProjectUrl>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <PackageReleaseNotes>https://github.com/powersync-ja/powersync-dotnet/PowerSync/PowerSync.Maui/CHANGELOG.md</PackageReleaseNotes>
+    <PackageTags>powersync local-first local-storage state-management offline sql db persistence sqlite sync </PackageTags>
+    <PackageIcon>icon.png</PackageIcon>
+    <NoWarn>NU5100</NoWarn>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\PowerSync.Common\PowerSync.Common.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="..\..\icon.png" Pack="true" PackagePath=""/>
+    <None Include="README.md" Pack="true" PackagePath=""/>
+    <None Update="Platforms\Android\Resources\values\colors.xml">
+      <SubType>Designer</SubType>
+    </None>
+  </ItemGroup>
+
+  <!-- For monorepo-->
+  <ItemGroup Condition="$(TargetFramework.Contains('-android'))">
+    <Content Include="Platforms\Android\**\*.*">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+  <ItemGroup Condition="$(TargetFramework.Contains('-ios'))">
+    <Content Include="Platforms\iOS\NativeLibs\powersync-sqlite-core.xcframework\**\*.*">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+  <!-- For releasing runtimes  -->
+  <ItemGroup Condition="$(TargetFramework.Contains('-android'))">
+  <None Include="Platforms\Android\**\*.*" Pack="true" PackagePath="Platforms\Android" />
+  </ItemGroup>
+
+  <ItemGroup Condition="$(TargetFramework.Contains('-ios'))">
+    <None Include="Platforms\iOS\NativeLibs\powersync-sqlite-core.xcframework\**\*.*" Pack="true" PackagePath="Platforms\iOS" />
+  </ItemGroup>
+</Project>

PowerSync/PowerSync.Maui/README.md

@@ -0,0 +1,5 @@
+# PowerSync SDK .NET MAUI
+
+## Usage
+
+TBD Factory Example

PowerSync/PowerSync.Maui/SQLite/MAUISQLiteAdapter.cs

@@ -0,0 +1,44 @@
+namespace PowerSync.Maui.SQLite;
+
+using Microsoft.Data.Sqlite;
+using PowerSync.Common.MDSQLite;
+
+// iOS specific imports
+#if IOS
+using Foundation;
+#endif
+
+public class MAUISQLiteAdapter : MDSQLiteAdapter
+{
+    public MAUISQLiteAdapter(MDSQLiteAdapterOptions options) : base(options)
+    {
+    }
+
+    protected override void LoadExtension(SqliteConnection db)
+    {
+        db.EnableExtensions(true);
+
+#if IOS
+       LoadExtensionIOS(db);
+#elif ANDROID
+        db.LoadExtension("libpowersync");
+#else
+        base.LoadExtension(db);
+#endif
+    }
+
+    private void LoadExtensionIOS(SqliteConnection db)
+    {
+        #if IOS
+        var bundlePath = Foundation.NSBundle.MainBundle.BundlePath;
+        var filePath =
+            Path.Combine(bundlePath, "Frameworks", "powersync-sqlite-core.framework", "powersync-sqlite-core");
+
+        using var loadExtension = db.CreateCommand();
+        loadExtension.CommandText = "SELECT load_extension(@path, @entryPoint)";
+        loadExtension.Parameters.AddWithValue("@path", filePath);
+        loadExtension.Parameters.AddWithValue("@entryPoint", "sqlite3_powersync_init");
+        loadExtension.ExecuteNonQuery();
+        #endif
+    }
+}

PowerSync/PowerSync.Maui/SQLite/MAUISQLiteDBOpenFactory.cs

@@ -0,0 +1,26 @@
+using PowerSync.Common.DB;
+
+namespace PowerSync.Maui.SQLite;
+
+using PowerSync.Common.Client;
+using PowerSync.Common.MDSQLite;
+
+
+public class MAUISQLiteDBOpenFactory : ISQLOpenFactory
+{
+    private readonly MDSQLiteOpenFactoryOptions options;
+
+    public MAUISQLiteDBOpenFactory(MDSQLiteOpenFactoryOptions options)
+    {
+        this.options = options;
+    }
+
+    public IDBAdapter OpenDatabase()
+    {
+        return new MAUISQLiteAdapter(new MDSQLiteAdapterOptions
+        {
+            Name = options.DbFilename,
+            SqliteOptions = options.SqliteOptions
+        });
+    }
+}