@syncular/tauri 0.15.48 → 0.16.1

package/README.md

@@ -8,6 +8,22 @@ Install the bridge together with its required Tauri JavaScript API peer:
 bun add @syncular/tauri @tauri-apps/api
 ```
 
+The bridge works with any frontend framework. Generate the schema module using
+the [existing-project setup](https://syncular.dev/guide-schema/#add-syncular-to-an-existing-project),
+then create one shared client in the webview:
+
+```ts
+// src/sync.ts
+import { createTauriSyncClient } from '@syncular/tauri';
+import { schema } from './syncular.generated';
+
+export const client = await createTauriSyncClient({ schema });
+```
+
+Register the native plugin as described in the
+[Tauri guide](https://syncular.dev/platform-tauri/). React apps can separately
+install `@syncular/react` for hooks over the same client.
+
 Reactive snapshots use the plugin's independent read-only SQLite path, so
 local Tauri views remain responsive while the native client is syncing over
 HTTP/WebSocket. Mutations, sync, and all durable writes remain serialized on
@@ -148,3 +164,9 @@ See the [Syncular repository](https://github.com/syncular/syncular) for docs.
 ## License
 
 Apache-2.0
+
+The snapshot API revision removes the individual `schemaFloor`, `leaseState`,
+`upgrading`, and `syncNeeded` methods. Read those fields from
+`await client.statusSnapshot()`. Collection and outcome reads remain methods.
+React accepts the bridge directly. See the
+[client migration](https://syncular.dev/platform-web/#snapshot-api-migration).

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import type { ClientSnapshotMethods, PromiseMethods } from '@syncular/client';
 /**
  * @syncular/tauri — the JS bridge to the native syncular instance running
  * inside the Tauri process (see `tauri-plugin-syncular`).
@@ -26,7 +27,7 @@
  * `invoke`/`listen` either from its ESM entry points, from the ambient
  * `window.__TAURI__`, or via injected doubles (tests).
  */
-import type { ClientChangeListener, ClientDiagnosticsListener, ClientDiagnosticsRequest, ClientDiagnosticsSnapshot, CommitOutcome, CommitOutcomeQuery, ConflictRecord, EncryptionKeyringConfig, InvalidationListener, LeaseState, LocalDataPurgeInput, LocalDataPurgeResult, LocalDataRebootstrapInput, LocalDataRebootstrapResult, MutationInput, PresencePeer, QueryReadSpec, QuerySnapshot, RejectionRecord, ResolveCommitOutcomeInput, SchemaFloor, SecurityLifecycle, SqlRow, SqlValue, SyncStatusSnapshot, WindowBase, WindowState } from '@syncular/client';
+import type { ClientChangeListener, ClientDiagnosticsListener, ClientDiagnosticsRequest, ClientDiagnosticsSnapshot, CommitOutcome, CommitOutcomeQuery, ConflictRecord, EncryptionKeyringConfig, InvalidationListener, LocalDataPurgeInput, LocalDataPurgeResult, LocalDataRebootstrapInput, LocalDataRebootstrapResult, MutationInput, PresencePeer, QueryReadSpec, QuerySnapshot, RejectionRecord, ResolveCommitOutcomeInput, SecurityLifecycle, SqlRow, SqlValue, SyncStatusSnapshot, WindowBase, WindowState } from '@syncular/client';
 /** One event pushed on `syncular://event` (the derived client-observable set). */
 interface SyncularEvent {
     readonly type: string;
@@ -73,10 +74,10 @@ export type BytesEnvelope = {
 };
 /**
  * The webview-side proxy implementing `SyncClientLike` over the plugin. Every
- * method is a promise (an IPC round trip); the React `normalizeClient` already
- * wraps sync and async members uniformly, so the hooks accept it directly.
+ * snapshot method returns a promise from an IPC round trip. React hooks accept
+ * the canonical snapshot interface directly.
  */
-export declare class TauriSyncClient {
+export declare class TauriSyncClient implements PromiseMethods<ClientSnapshotMethods> {
     #private;
     /** @internal — use {@link createTauriSyncClient}. */
     constructor(tauri: TauriApi, unlisten: () => void, securityLifecycle?: SecurityLifecycle);
@@ -144,10 +145,6 @@ export declare class TauriSyncClient {
     commitOutcome(clientCommitId: string): Promise<CommitOutcome | undefined>;
     commitOutcomes(query?: CommitOutcomeQuery): Promise<readonly CommitOutcome[]>;
     resolveCommitOutcome(input: ResolveCommitOutcomeInput): Promise<CommitOutcome>;
-    schemaFloor(): Promise<SchemaFloor | undefined>;
-    leaseState(): Promise<LeaseState | undefined>;
-    upgrading(): Promise<boolean>;
-    syncNeeded(): Promise<boolean>;
     pendingCommits(): Promise<unknown[]>;
     presence(scopeKey: string): Promise<readonly PresencePeer[]>;
     setPresence(scopeKey: string, doc: Record<string, unknown> | null): Promise<void>;

package/dist/index.js

@@ -1,31 +1,3 @@
-/**
- * @syncular/tauri — the JS bridge to the native syncular instance running
- * inside the Tauri process (see `tauri-plugin-syncular`).
- *
- * The Tauri host runs a REAL Rust syncular client (file DB + native HTTP+WS
- * transport). This module is a thin webview-side proxy that implements the SAME
- * `SyncClientLike` interface the React package normalizes — so the hooks
- * (`useRawSql`, `useMutation`, `usePresence`, …) work UNCHANGED against a
- * Tauri app. It is the fourth host of one interface, after the direct
- * `SyncClient`, the worker-leader `SyncClientHandle`, and the multi-tab
- * follower.
- *
- * Every method forwards to the plugin's `syncular_command` command (the whole
- * command surface in one JSON envelope — `{method, params}`), mirroring the FFI
- * and the conformance shim. `query` uses the dedicated `syncular_query` fast
- * path; atomic reactive reads use `syncular_query_snapshot`, backed by an
- * independent read-only SQLite connection so network sync cannot stall local
- * UI reads. Client-observable
- * events (`change` / `presence`) arrive on
- * the `syncular://event` Tauri event and fan out to the registered listeners.
- *
- * Bytes cross the command JSON as the established `{$bytes: hex}` envelope, the
- * same convention the Rust command router and the driver protocol use.
- *
- * `@tauri-apps/api` is a required peer dependency: the bridge takes
- * `invoke`/`listen` either from its ESM entry points, from the ambient
- * `window.__TAURI__`, or via injected doubles (tests).
- */
 // -- Types the bridge speaks (structurally the web-client's) -----------------
 // Most imports stay type-only; the stable preflight error code is shared at
 // runtime so every host surfaces byte-identical policy evidence.
@@ -145,8 +117,8 @@ async function resolveTauri(injected) {
 }
 /**
  * The webview-side proxy implementing `SyncClientLike` over the plugin. Every
- * method is a promise (an IPC round trip); the React `normalizeClient` already
- * wraps sync and async members uniformly, so the hooks accept it directly.
+ * snapshot method returns a promise from an IPC round trip. React hooks accept
+ * the canonical snapshot interface directly.
  */
 export class TauriSyncClient {
     #tauri;
@@ -522,22 +494,6 @@ export class TauriSyncClient {
         }));
         return result.outcome;
     }
-    async schemaFloor() {
-        const result = (await this.#command('schemaFloor', {}));
-        return result.floor ?? undefined;
-    }
-    async leaseState() {
-        const result = (await this.#command('leaseState', {}));
-        return result.lease ?? undefined;
-    }
-    async upgrading() {
-        const result = (await this.#command('upgrading', {}));
-        return result.value;
-    }
-    async syncNeeded() {
-        const result = (await this.#command('syncNeeded', {}));
-        return result.value;
-    }
     async pendingCommits() {
         const result = (await this.#command('pendingCommitIds', {}));
         return result.ids;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncular/tauri",
-  "version": "0.15.48",
+  "version": "0.16.1",
   "description": "Tauri integration for the Syncular client",
   "license": "Apache-2.0",
   "author": "Benjamin Kniffler",
@@ -48,12 +48,12 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@syncular/client": "0.15.48"
+    "@syncular/client": "0.16.1"
   },
   "peerDependencies": {
     "@tauri-apps/api": ">=2.0.0"
   },
   "devDependencies": {
-    "@syncular/react": "0.15.48"
+    "@syncular/react": "0.16.1"
   }
 }

package/src/index.ts

@@ -1,3 +1,4 @@
+import type { ClientSnapshotMethods, PromiseMethods } from '@syncular/client';
 /**
  * @syncular/tauri — the JS bridge to the native syncular instance running
  * inside the Tauri process (see `tauri-plugin-syncular`).
@@ -39,7 +40,6 @@ import type {
   EncryptionKeyringConfig,
   InvalidationEvent,
   InvalidationListener,
-  LeaseState,
   LocalDataPurgeInput,
   LocalDataPurgeResult,
   LocalDataRebootstrapInput,
@@ -50,7 +50,6 @@ import type {
   QuerySnapshot,
   RejectionRecord,
   ResolveCommitOutcomeInput,
-  SchemaFloor,
   SecurityLifecycle,
   SqlRow,
   SqlValue,
@@ -252,10 +251,10 @@ async function resolveTauri(injected: TauriApi | undefined): Promise<TauriApi> {
 
 /**
  * The webview-side proxy implementing `SyncClientLike` over the plugin. Every
- * method is a promise (an IPC round trip); the React `normalizeClient` already
- * wraps sync and async members uniformly, so the hooks accept it directly.
+ * snapshot method returns a promise from an IPC round trip. React hooks accept
+ * the canonical snapshot interface directly.
  */
-export class TauriSyncClient {
+export class TauriSyncClient implements PromiseMethods<ClientSnapshotMethods> {
   readonly #tauri: TauriApi;
   readonly #invalidationListeners = new Set<InvalidationListener>();
   readonly #changeListeners = new Set<ClientChangeListener>();
@@ -763,32 +762,6 @@ export class TauriSyncClient {
     return result.outcome;
   }
 
-  async schemaFloor(): Promise<SchemaFloor | undefined> {
-    const result = (await this.#command('schemaFloor', {})) as {
-      floor?: SchemaFloor;
-    };
-    return result.floor ?? undefined;
-  }
-
-  async leaseState(): Promise<LeaseState | undefined> {
-    const result = (await this.#command('leaseState', {})) as {
-      lease?: LeaseState;
-    };
-    return result.lease ?? undefined;
-  }
-
-  async upgrading(): Promise<boolean> {
-    const result = (await this.#command('upgrading', {})) as { value: boolean };
-    return result.value;
-  }
-
-  async syncNeeded(): Promise<boolean> {
-    const result = (await this.#command('syncNeeded', {})) as {
-      value: boolean;
-    };
-    return result.value;
-  }
-
   async pendingCommits(): Promise<unknown[]> {
     const result = (await this.#command('pendingCommitIds', {})) as {
       ids: string[];