Tauri SDK

.changeset/config.json

@@ -7,7 +7,7 @@
   "access": "restricted",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["!@powersync/*"],
+  "ignore": ["import-tests", "powersynctests"],
   "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
     "onlyUpdatePeerDependentsWhenOutOfRange": true,
     "updateInternalDependents": "out-of-range"

.changeset/thick-hats-joke.md

@@ -0,0 +1,6 @@
+---
+'tauri-plugin-powersync': patch
+'@powersync/tauri-plugin': patch
+---
+
+Initial release

.github/workflows/release-tauri-crate.yml

@@ -0,0 +1,21 @@
+name: release
+on:
+  push:
+    tags:
+      - tauri-plugin-powersync@[0-9]+.[0-9]+.[0-9]+
+
+jobs:
+  publish_crates_io:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # Required for OIDC token exchange
+    steps:
+      - uses: actions/checkout@v6
+      - uses: rust-lang/crates-io-auth-action@v1
+        id: auth
+
+      - name: Publish powersync crate
+        run: cargo publish
+        working-directory: powersync
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}

.github/workflows/test-tauri.yaml

@@ -0,0 +1,50 @@
+name: Tauri Integration tests
+on:
+  pull_request: # triggered for any PR updates (including new pushes to PR branch)
+
+jobs:
+  check-changes:
+    name: Check for relevant changes
+    runs-on: ubuntu-latest
+    outputs:
+      should_run: ${{ steps.check.outputs.should_run }}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Check for changes
+        id: check
+        run: |
+          git fetch origin ${{ github.base_ref }}
+          if git diff --quiet origin/${{ github.base_ref }} -- packages/common packages/tauri; then
+            echo "should_run=false" >> $GITHUB_OUTPUT
+          else
+            echo "should_run=true" >> $GITHUB_OUTPUT
+          fi
+
+  test-tauri:
+    name: Tauri integration tests macOS
+    runs-on: macos-latest
+    needs: check-changes
+    if: needs.check-changes.outputs.should_run == 'true'
+    timeout-minutes: 15
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Enable Corepack
+        run: corepack enable
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build
+        run: pnpm run -r --filter "@powersync/tauri-plugin..." build
+      - name: Compile test runner
+        run: cargo build -p test-runner
+      - name: Test
+        working-directory: packages/tauri
+        run: pnpm test

.gitignore

@@ -26,3 +26,7 @@ demos/**/.pnpmfile.cjs
 demos/**/.branches
 demos/**/.temp
 
+Cargo.lock
+target/
+# Large files generated by Tauri
+**/gen/schemas/

Cargo.toml

@@ -0,0 +1,13 @@
+# Having a top-level Cargo.toml makes it easier to use rust-analyzer in VS Code when opening
+# this project.
+
+[workspace]
+resolver = "3"
+members = [
+    "packages/tauri",
+    "packages/tauri/test-runner",
+    "demos/tauri-app/src-tauri"
+]
+
+[workspace.package]
+repository = "https://github.com/powersync-ja/powersync-js"

demos/tauri-app/README.md

@@ -0,0 +1,24 @@
+# PowerSync Tauri demo
+
+This demonstrates a minimal Tauri app using PowerSync for local persistence and data sync.
+
+It is designed to run with a [self-hosted instance](https://github.com/powersync-ja/self-host-demo/). To get started:
+
+1. Clone the [self-host-demo](https://github.com/powersync-ja/self-host-demo/) repository.
+2. Change `config/sync-config.yaml` to the Sync Config from this readme.
+3. Run `pnpm tauri dev` to start the app.
+
+```yaml
+# config/sync-config.yaml
+config:
+  edition: 3
+
+streams:
+  lists:
+    query: SELECT * FROM lists
+    auto_subscribe: true
+  todos:
+    query: SELECT * FROM todos WHERE list_id = subscription.parameter('list')
+```
+
+When opening the app, you should see a list displaying all `lists` rows from the server. Clicking on the `Open in new window` button opens the list in a new window. All windows have their own JavaScript context, but share queries and sync in real-time thanks to the PowerSync Tauri plugin.

demos/tauri-app/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>PowerSync Tauri Demo</title>
+  </head>
+
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

demos/tauri-app/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "tauri-app",
+  "private": true,
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "tauri": "tauri"
+  },
+  "dependencies": {
+    "@powersync/common": "1.50.0",
+    "@powersync/tauri-plugin": "0.0.1",
+    "@powersync/react": "1.9.1",
+    "@tauri-apps/api": "^2.0.0",
+    "@tanstack/react-router": "^1.167.4",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4"
+  },
+  "devDependencies": {
+    "@tauri-apps/cli": "^2.0.0",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^6.0.1",
+    "@tanstack/router-plugin": "^1.166.13",
+    "typescript": "^5.9.3",
+    "vite": "^8.0.0"
+  }
+}

demos/tauri-app/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - .

demos/tauri-app/src-tauri/Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "tauri-app"
+version = "0.1.0"
+description = "A Tauri App"
+authors = ["you"]
+license = ""
+repository = ""
+edition = "2021"
+rust-version = "1.77.2"
+
+[lib]
+name = "tauri_app_lib"
+crate-type = ["staticlib", "cdylib", "rlib"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[build-dependencies]
+tauri-build = { version = "2.5.6", default-features = false , features = [] }
+
+[dependencies]
+tauri = { version = "2.10.3", features = [] }
+tauri-plugin-powersync = { path = "../../../packages/tauri" }
+powersync = "0.0.5"
+async-trait = "0.1.89"
+serde = "1"
+serde_json = "1"
+reqwest = { version = "0.13.0", features = ["json"] }
+log = "0.4"
+futures-lite = "2"

demos/tauri-app/src-tauri/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+  tauri_build::build()
+}

demos/tauri-app/src-tauri/capabilities/default.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "../gen/schemas/desktop-schema.json",
+  "identifier": "default",
+  "description": "enables the default permissions",
+  "windows": [
+    "*"
+  ],
+  "permissions": [
+    "core:default",
+    "powersync:default",
+    "core:webview:allow-create-webview-window",
+    "core:window:allow-set-title"
+  ]
+}

demos/tauri-app/src-tauri/src/lib.rs

@@ -0,0 +1,115 @@
+use async_trait::async_trait;
+use futures_lite::StreamExt;
+use log::warn;
+use powersync::error::PowerSyncError;
+use powersync::{
+    BackendConnector, PowerSyncCredentials, PowerSyncDatabase, SyncOptions, UpdateType,
+};
+use reqwest::StatusCode;
+use serde::{Deserialize, Serialize};
+use serde_json::{Map, Value};
+use tauri::{AppHandle, Runtime};
+use tauri_plugin_powersync::PowerSyncExt;
+
+#[tauri::command]
+async fn connect<R: Runtime>(
+    app: AppHandle<R>,
+    handle: usize,
+) -> tauri_plugin_powersync::Result<()> {
+    let ps = app.powersync();
+    let database = ps.database_from_javascript_handle(handle)?;
+
+    let options = SyncOptions::new(MyRustConnector {
+        db: database.clone(),
+    });
+    database.connect(options).await;
+
+    Ok(())
+}
+
+#[cfg_attr(mobile, tauri::mobile_entry_point)]
+pub fn run() {
+    tauri::Builder::default()
+        .invoke_handler(tauri::generate_handler![connect])
+        .plugin(tauri_plugin_powersync::init())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+
+/// A backend connector implementation based on the
+/// [self-hosted demo](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs).
+struct MyRustConnector {
+    db: PowerSyncDatabase,
+}
+
+#[async_trait]
+impl BackendConnector for MyRustConnector {
+    async fn fetch_credentials(&self) -> Result<PowerSyncCredentials, PowerSyncError> {
+        let response = reqwest::get("http://localhost:6060/api/auth/token").await?;
+
+        #[derive(Deserialize)]
+        struct TokenResponse {
+            token: String,
+        }
+
+        let token: TokenResponse = response.json().await?;
+        Ok(PowerSyncCredentials {
+            endpoint: "http://localhost:8080".to_string(),
+            token: token.token,
+        })
+    }
+
+    async fn upload_data(&self) -> Result<(), PowerSyncError> {
+        let mut transactions = self.db.crud_transactions();
+        let mut last_tx = None;
+
+        while let Some(mut tx) = transactions.try_next().await? {
+            #[derive(Serialize)]
+            struct BackendEntry {
+                op: UpdateType,
+                table: String,
+                id: String,
+                data: Option<Map<String, Value>>,
+            }
+
+            #[derive(Serialize)]
+            struct BackendBatch {
+                batch: Vec<BackendEntry>,
+            }
+
+            let mut entries = vec![];
+            for crud in std::mem::take(&mut tx.crud) {
+                entries.push(BackendEntry {
+                    op: crud.update_type,
+                    table: crud.table,
+                    id: crud.id,
+                    data: crud.data,
+                });
+            }
+
+            let serialized = serde_json::to_string(&BackendBatch { batch: entries })?;
+
+            let client = reqwest::Client::new();
+            let response = client
+                .post("http://localhost:6060/api/data")
+                .header("Content-Type", "application/json")
+                .body(serialized)
+                .send()
+                .await?;
+
+            if response.status() != StatusCode::OK {
+                let status = response.status();
+                let body = response.text().await?;
+                warn!("Received {} from /api/data: {}", status, body);
+            }
+
+            last_tx = Some(tx);
+        }
+
+        if let Some(tx) = last_tx {
+            tx.complete().await?;
+        }
+
+        Ok(())
+    }
+}

demos/tauri-app/src-tauri/src/main.rs

@@ -0,0 +1,6 @@
+// Prevents additional console window on Windows in release, DO NOT REMOVE!!
+#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
+
+fn main() {
+  tauri_app_lib::run();
+}

demos/tauri-app/src-tauri/tauri.conf.json

@@ -0,0 +1,37 @@
+{
+  "productName": "tauri-app",
+  "version": "0.1.0",
+  "identifier": "com.powersync.demo.tauri.selfhosted",
+  "build": {
+    "beforeDevCommand": "pnpm dev",
+    "beforeBuildCommand": "pnpm build",
+    "devUrl": "http://localhost:1420",
+    "frontendDist": "../dist"
+  },
+  "app": {
+    "withGlobalTauri": false,
+    "security": {
+      "csp": null
+    },
+    "windows": [
+      {
+        "fullscreen": false,
+        "height": 600,
+        "resizable": true,
+        "title": "tauri-app",
+        "width": 800
+      }
+    ]
+  },
+  "bundle": {
+    "active": true,
+    "targets": "all",
+    "icon": [
+      "icons/32x32.png",
+      "icons/128x128.png",
+      "icons/128x128@2x.png",
+      "icons/icon.icns",
+      "icons/icon.ico"
+    ]
+  }
+}