Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Common SDK + CLI Demo #2

Merged
merged 28 commits into from
Mar 26, 2025
Merged
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
a6f4423
Added Common package, tests, and a CLI demo.
Chriztiaan Nov 29, 2024
dbe113a
Using base directory for setup script.
Chriztiaan Mar 6, 2025
41e5d37
Added readme entry for powersync extension retrieval.
Chriztiaan Mar 6, 2025
e5c6fbc
DSstore gitignore entry.
Chriztiaan Mar 6, 2025
45371d9
Moved CLI demo to CommandLine dir.
Chriztiaan Mar 6, 2025
5214965
Demo Readme tweak
benitav Mar 6, 2025
819425b
self-hosted
benitav Mar 6, 2025
3899f0d
Added .net9 to target frameworks for the package and tests. Added set…
Chriztiaan Mar 7, 2025
3283753
Emitting connected=false immediately on network break, SDK picks up i…
Chriztiaan Mar 7, 2025
c62c6ab
Release status message.
Chriztiaan Mar 10, 2025
0cae6fa
Added readlock/writelock/transactions to PowerSyncDatabase. Started t…
Chriztiaan Mar 11, 2025
70f9349
Merge branch 'main' into feat/common-sdk
Chriztiaan Mar 11, 2025
af01b33
Mention other compatible self-host-demos
benitav Mar 11, 2025
29cf709
Update README.md
benitav Mar 11, 2025
a202e59
Completed transaction tests.
Chriztiaan Mar 11, 2025
734895e
Merge branch 'feat/common-sdk' of https://github.com/powersync-ja/pow…
Chriztiaan Mar 11, 2025
8187e7e
Updated tests, wip commit message
Chriztiaan Mar 11, 2025
6baaa0e
Added temp package usage section.
Chriztiaan Mar 11, 2025
8968574
Disable test in development.
Chriztiaan Mar 11, 2025
b4e093b
Added further CrudTests. Ensuring read connection is closed, clearing…
Chriztiaan Mar 12, 2025
f4f998a
Made Watch return a Task, which completes after it has finished initi…
Chriztiaan Mar 12, 2025
9b19280
Removed Class1.cs file
Chriztiaan Mar 12, 2025
61bffc8
Removing demo tmp file.
Chriztiaan Mar 12, 2025
683cdc7
Newline formatting.
Chriztiaan Mar 12, 2025
7f795ab
Removed `src` contents that were missed in renaming of directories.
Chriztiaan Mar 12, 2025
58daca9
Added DB operations to IPowerSyncDatabase interface.
Chriztiaan Mar 20, 2025
3cd8cb2
Removed todos, added to internal tracker.
Chriztiaan Mar 20, 2025
331e60f
Removed commands file.
Chriztiaan Mar 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -38,6 +38,9 @@ obj/
*.lastbuildstate
*.idb

.DS_STORE


# NuGet packages
*.nupkg
*.snupkg
@@ -49,3 +52,12 @@ TestResults/
*.VSIXProjectLaunch
.project
.vsconfig

*.db
*.db-shm
*.db-wal

#Core binaries - add rules after ps extension downloading is supported
*.dylib
*.dll
*.so
6 changes: 6 additions & 0 deletions Directory.build.props
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<Project>
<ItemGroup>
<Compile Include="$(MSBuildThisFileDirectory)IsExternalInit.cs" Visible="false" />
</ItemGroup>
</Project>
7 changes: 7 additions & 0 deletions IsExternalInit.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
using System.ComponentModel;

namespace System.Runtime.CompilerServices
{
[EditorBrowsable(EditorBrowsableState.Never)]
internal class IsExternalInit { }
}
177 changes: 177 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
namespace PowerSync.Common.Client.Connection;

public interface IPowerSyncBackendConnector
{
/// <summary>
/// Allows the PowerSync client to retrieve an authentication token from your backend
/// which is used to authenticate against the PowerSync service.
/// <para />
/// This should always fetch a fresh set of credentials - don't use cached
/// values.
/// <para />
/// 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.
/// </summary>
Task<PowerSyncCredentials?> FetchCredentials();

/// <summary>
/// Upload local changes to the app backend.
///
/// Use <see cref="IPowerSyncDatabase.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).
/// </summary>
Task UploadData(IPowerSyncDatabase database);
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Common.Client.Connection;
namespace PowerSync.Common.Client.Connection;
public class PowerSyncCredentials(string endpoint, string token, DateTime? expiresAt = null)
{
public string Endpoint { get; set; } = endpoint;
Loading
Oops, something went wrong.