Merge branch 'main' into feat/common-sdk

Author: Chriztiaan

.gitignore

@@ -60,4 +60,4 @@ TestResults/
 #Core binaries - add rules after ps extension downloading is supported
 *.dylib
 *.dll
-*.so
+*.so

commands

@@ -0,0 +1,14 @@
+dotnet new sln -n root    
+dotnet new classlib -n Common    
+dotnet sln root.sln add src/Common/Common.csproj
+dotnet add reference ../../packages/CommonUtilities/CommonUtilities.csproj
+
+dotnet pack packages/CommonUtilities -o ../local-nuget
+dotnet add package CommonUtilities --version "*"
+
+dotnet new xunit -n Common.Tests
+dotnet sln ../../root.sln add Common.Tests/Common.Tests.csproj
+
+dotnet test src/Common/Common.Tests
+dotnet test --logger "console;verbosity=detailed" src/Common/Common.Tests
+dotnet test --logger "console;verbosity=detailed"

src/Common.Tests/Common.Tests.csproj

@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+
+    <IsPackable>false</IsPackable>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="coverlet.collector" Version="6.0.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="xunit" Version="2.5.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Using Include="Xunit" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Common\Common.csproj" />
+  </ItemGroup>
+
+</Project>

src/Common.Tests/PowerSyncCredentialsTests.cs

@@ -0,0 +1,16 @@
+namespace Common.Tests;
+using Common.Client.Connection;
+public class PowerSyncCredentialsTests
+{
+    [Fact]
+    public void SimpleTest()
+    {
+        var endpoint = "http://localhost";
+        var token = "token";
+        var expiresAt = new DateTime();
+        PowerSyncCredentials credentials = new PowerSyncCredentials(endpoint, token, expiresAt);
+        Assert.Equal(endpoint, credentials.Endpoint);
+        Assert.Equal(token, credentials.Token);
+        Assert.Equal(expiresAt, credentials.ExpiresAt);
+    }
+}

src/Common/Class1.cs

@@ -0,0 +1,9 @@
+namespace Common;
+
+public class Class1
+{
+    public void Write()
+    {
+        Console.WriteLine("Hello from Common!");
+    }
+}

src/Common/Client/AbstractPowerSyncDatabase.cs

@@ -0,0 +1,20 @@
+using Common.DB.Crud;
+
+namespace Common.Client;
+public abstract class AbstractPowerSyncDatabase {
+
+    // Returns true if the connection is closed.    
+    bool closed;
+    bool ready;
+
+    string sdkVersion;
+    SyncStatus syncStatus;
+
+    public AbstractPowerSyncDatabase() {
+        this.syncStatus = new SyncStatus(new SyncStatusOptions());
+        this.closed = false;
+        this.ready = false;
+
+        this.sdkVersion = "";
+    }   
+}

src/Common/Client/Connection/IPowerSyncBackendConnector.cs

@@ -0,0 +1,23 @@
+namespace Common.Client.Connection;
+
+public interface IPowerSyncBackendConnector
+{
+    // Allows the PowerSync client to retrieve an authentication token from your backend
+    // which is used to authenticate against the PowerSync service.
+    //  
+    // This should always fetch a fresh set of credentials - don't use cached
+    // values.
+    //  
+    // Return null if the user is not signed in. Throw an error if credentials
+    // cannot be fetched due to a network error or other temporary error.
+    //
+    // This token is kept for the duration of a sync connection.
+    Task<PowerSyncCredentials?> FetchCredentials();
+
+    // Upload local changes to the app backend.
+    //
+    // Use {@link AbstractPowerSyncDatabase.getCrudBatch} to get a batch of changes to upload.
+    //
+    // Any thrown errors will result in a retry after the configured wait period (default: 5 seconds).
+    Task UploadData(AbstractPowerSyncDatabase database);
+}

src/Common/Client/Connection/PowerSyncCredentials.cs

@@ -0,0 +1,7 @@
+namespace Common.Client.Connection;
+public class PowerSyncCredentials(string endpoint, string token, DateTime? expiresAt = null)
+{
+    public string Endpoint { get; set; } = endpoint;
+    public string Token { get; set; } = token;
+    public DateTime? ExpiresAt { get; set; } = expiresAt;
+}

src/Common/Common.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>

src/Common/DB/Crud/SyncStatus.cs

@@ -0,0 +1,59 @@
+namespace Common.DB.Crud;
+
+using System.Text.Json;
+
+
+public class SyncDataFlowStatus
+{
+    public bool Downloading { get; set; } = false;
+    public bool Uploading { get; set; } = false;    
+}
+
+
+ public class SyncStatusOptions
+{
+    public bool? Connected { get; set; }
+    public SyncDataFlowStatus? DataFlow { get; set; }
+    public DateTime? LastSyncedAt { get; set; }
+    public bool? HasSynced { get; set; }
+}
+
+ public class SyncStatus(SyncStatusOptions options)
+{
+    protected SyncStatusOptions options = options;
+
+    public bool Connected => options.Connected ?? false;
+    
+    public DateTime? LastSyncedAt => options.LastSyncedAt;
+
+    public bool? HasSynced => options.HasSynced;
+
+    public SyncDataFlowStatus DataFlowStatus => options.DataFlow ?? new SyncDataFlowStatus();
+
+    public bool IsEqual(SyncStatus status)
+    {
+        return JsonSerializer.Serialize(options) == JsonSerializer.Serialize(status.options);
+    }
+
+    public string GetMessage()
+    {
+        return $"SyncStatus<connected: {Connected}, lastSyncedAt: {LastSyncedAt}, hasSynced: {HasSynced}, " +
+                $"downloading: {DataFlowStatus.Downloading}, uploading: {DataFlowStatus.Uploading}>";
+    }
+
+    public SyncStatusOptions ToJson()
+    {
+        return new SyncStatusOptions
+        {
+            Connected = Connected,
+            DataFlow = DataFlowStatus,
+            LastSyncedAt = LastSyncedAt,
+            HasSynced = HasSynced
+        };
+    }
+
+    public override string ToString()
+    {
+        return GetMessage();
+    }
+}