@syncular/tauri 0.57.0 → 0.59.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/authority.js +2 -2
- package/dist/remote.d.ts +44 -203
- package/dist/remote.js +75 -937
- package/package.json +4 -4
- package/src/authority.ts +1 -2
- package/src/remote.ts +123 -1347
package/dist/authority.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createTauriSyncClient,
|
|
1
|
+
import { createTauriSyncClient, TauriSyncClient, TauriSyncError, } from './index.js';
|
|
2
2
|
/** Explicit native bridge with the zero-argument preflight authority read. */
|
|
3
3
|
export class TauriAuthoritySyncClient extends TauriSyncClient {
|
|
4
4
|
async authoritySnapshot() {
|
|
@@ -14,7 +14,7 @@ export class TauriAuthoritySyncClient extends TauriSyncClient {
|
|
|
14
14
|
...table,
|
|
15
15
|
rows: table.rows.map((row) => ({
|
|
16
16
|
...row,
|
|
17
|
-
values: decodeRow(row.values),
|
|
17
|
+
values: this.decodeRow(row.values),
|
|
18
18
|
})),
|
|
19
19
|
})),
|
|
20
20
|
};
|
package/dist/remote.d.ts
CHANGED
|
@@ -1,39 +1,28 @@
|
|
|
1
|
-
import { type SyncProgress, type SyncProgressListener } from '@syncular/client';
|
|
2
|
-
import type { ClientSnapshotMethods, PromiseMethods } from '@syncular/client';
|
|
3
1
|
/**
|
|
4
|
-
* @syncular/tauri
|
|
5
|
-
*
|
|
2
|
+
* @syncular/tauri: the JS bridge to the native syncular client running inside
|
|
3
|
+
* the Tauri process (see `tauri-plugin-syncular`).
|
|
6
4
|
*
|
|
7
5
|
* The Tauri host runs a REAL Rust syncular client (file DB + native HTTP+WS
|
|
8
|
-
* transport). This module is
|
|
9
|
-
* `
|
|
10
|
-
* (`useRawSql`, `useMutation`, `usePresence`, …) work
|
|
11
|
-
* Tauri app.
|
|
12
|
-
* `SyncClient`, the worker-leader `SyncClientHandle`, and the multi-tab
|
|
13
|
-
* follower.
|
|
6
|
+
* transport). This module is the webview-side proxy over the shared native
|
|
7
|
+
* command bridge (`@syncular/client/native-bridge`), so the React hooks
|
|
8
|
+
* (`useRawSql`, `useMutation`, `usePresence`, …) work unchanged against a
|
|
9
|
+
* Tauri app.
|
|
14
10
|
*
|
|
15
11
|
* Every method forwards to the plugin's `syncular_command` command (the whole
|
|
16
|
-
* command surface in one
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* the `syncular://event` Tauri event and fan out to the registered listeners.
|
|
12
|
+
* command surface in one `{method, params}` envelope). `query` uses the
|
|
13
|
+
* dedicated `syncular_query` fast path; atomic reactive reads use
|
|
14
|
+
* `syncular_query_snapshot`, backed by an independent read-only SQLite
|
|
15
|
+
* connection so network sync cannot stall local UI reads. Client-observable
|
|
16
|
+
* events arrive on the Tauri IPC channel the bridge passes to `create`, so
|
|
17
|
+
* only this webview receives them.
|
|
23
18
|
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* `@tauri-apps/api` is a required peer dependency: the bridge takes
|
|
28
|
-
* `invoke`/`listen` either from its ESM entry points, from the ambient
|
|
19
|
+
* `@tauri-apps/api` is a required peer dependency: the bridge takes `invoke`
|
|
20
|
+
* and `Channel` either from `@tauri-apps/api/core`, from the ambient
|
|
29
21
|
* `window.__TAURI__`, or via injected doubles (tests).
|
|
30
22
|
*/
|
|
31
|
-
import type { AuthorityReadPolicy,
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
readonly type: string;
|
|
35
|
-
readonly [key: string]: unknown;
|
|
36
|
-
}
|
|
23
|
+
import type { AuthorityReadPolicy, ClientDiagnosticsListener, SecurityLifecycle, SnapshotRead } from '@syncular/client';
|
|
24
|
+
import { NativeBridgeClient, type NativeCreateConfig, type NativeReply, NativeSyncError } from '@syncular/client/native-bridge';
|
|
25
|
+
export type { BytesEnvelope } from '@syncular/client/native-bridge';
|
|
37
26
|
/** §7.5: one read-only statement in an atomic sidecar snapshot read. */
|
|
38
27
|
export type { SnapshotStatement } from '@syncular/client';
|
|
39
28
|
/** §7.5: the catch-up state of one subscription from the sidecar. */
|
|
@@ -45,24 +34,18 @@ export type SnapshotReadResult = SnapshotRead;
|
|
|
45
34
|
/** The two Tauri primitives the bridge needs — injectable for tests. */
|
|
46
35
|
export interface TauriApi {
|
|
47
36
|
invoke<T>(cmd: string, args?: Record<string, unknown>): Promise<T>;
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
37
|
+
/**
|
|
38
|
+
* A Tauri IPC channel delivering each message to `onMessage`. Only the
|
|
39
|
+
* webview that created it receives its messages.
|
|
40
|
+
*/
|
|
41
|
+
channel<T>(onMessage: (message: T) => void): {
|
|
42
|
+
toJSON(): string;
|
|
43
|
+
};
|
|
51
44
|
}
|
|
52
|
-
/** The plugin's Tauri event name — mirror of `tauri-plugin-syncular`. */
|
|
53
|
-
export declare const SYNCULAR_EVENT = "syncular://event";
|
|
54
45
|
/** SPEC §12 local authority lifecycle state. */
|
|
55
46
|
export type LocalAuthorityState = 'local' | 'attaching' | 'attached';
|
|
56
47
|
/** Config for {@link createTauriSyncClient}. */
|
|
57
|
-
export interface TauriSyncClientConfig {
|
|
58
|
-
/** The generated schema JSON (the app passes `schema` from typegen). */
|
|
59
|
-
readonly schema: unknown;
|
|
60
|
-
/**
|
|
61
|
-
* Client id for this device/actor. If omitted, the native client generates
|
|
62
|
-
* one and persists it in the database. Supplying a different id when opening
|
|
63
|
-
* an existing database fails with `client.identity_mismatch`.
|
|
64
|
-
*/
|
|
65
|
-
readonly clientId?: string;
|
|
48
|
+
export interface TauriSyncClientConfig extends NativeCreateConfig {
|
|
66
49
|
/**
|
|
67
50
|
* Name of the native database to open, for example one replica per
|
|
68
51
|
* signed-in actor. The plugin opens `<database_dir>/<database>.db` from its
|
|
@@ -70,32 +53,11 @@ export interface TauriSyncClientConfig {
|
|
|
70
53
|
* `.` and starts with a letter or digit. Absent ⇒ the plugin's `db_path`.
|
|
71
54
|
*/
|
|
72
55
|
readonly database?: string;
|
|
73
|
-
/** §4.2 client limits, forwarded to the native `create`. */
|
|
74
|
-
readonly limits?: Record<string, unknown>;
|
|
75
|
-
/**
|
|
76
|
-
* SPEC §8.8 realtime policy, forwarded to the native `create`. Absent ⇒
|
|
77
|
-
* `optional`. `required` refuses a sync round while the socket is not
|
|
78
|
-
* connected instead of falling back to HTTP.
|
|
79
|
-
*/
|
|
80
|
-
readonly realtimePolicy?: SyncClientConfig['realtimePolicy'];
|
|
81
56
|
readonly retainFailedCommits?: boolean;
|
|
82
|
-
/**
|
|
83
|
-
* Portable E2EE keys and declarative per-row key-id columns. Raw keys are
|
|
84
|
-
* encoded into the native command envelope and never sent to the server.
|
|
85
|
-
*/
|
|
86
|
-
readonly encryption?: EncryptionKeyringConfig;
|
|
87
57
|
/** Fixed plain authority reads permitted before security activation. */
|
|
88
58
|
readonly authorityReads?: AuthorityReadPolicy;
|
|
89
|
-
/** Open the native replica behind the fail-closed security gate. */
|
|
90
|
-
readonly securityPreflight?: boolean;
|
|
91
59
|
/** Open local storage with network transport closed until explicitly resumed. */
|
|
92
60
|
readonly transportEnabled?: boolean;
|
|
93
|
-
/**
|
|
94
|
-
* RFC 0005 previous-version context, forwarded to the native `create`. The
|
|
95
|
-
* Rust create handler must read this key to enable capture; while it does
|
|
96
|
-
* not, the native core treats the feature as off (default-off).
|
|
97
|
-
*/
|
|
98
|
-
readonly previousVersionContext?: SyncClientConfig['previousVersionContext'];
|
|
99
61
|
/**
|
|
100
62
|
* The Tauri primitives. Omit in a real Tauri webview to auto-resolve from
|
|
101
63
|
* `@tauri-apps/api` (peer dep) or the ambient `window.__TAURI__`; inject in
|
|
@@ -103,161 +65,40 @@ export interface TauriSyncClientConfig {
|
|
|
103
65
|
*/
|
|
104
66
|
readonly tauri?: TauriApi;
|
|
105
67
|
}
|
|
106
|
-
/** The
|
|
107
|
-
export
|
|
108
|
-
|
|
109
|
-
}
|
|
110
|
-
/**
|
|
111
|
-
export declare
|
|
112
|
-
/**
|
|
113
|
-
* The webview-side proxy implementing `SyncClientLike` over the plugin. Every
|
|
114
|
-
* snapshot method returns a promise from an IPC round trip. React hooks accept
|
|
115
|
-
* the canonical snapshot interface directly.
|
|
116
|
-
*/
|
|
117
|
-
export declare class TauriSyncClient implements PromiseMethods<ClientSnapshotMethods> {
|
|
68
|
+
/** The error a `{error}` reply surfaces (mirrors the web-client `ClientSyncError`). */
|
|
69
|
+
export declare class TauriSyncError extends NativeSyncError {
|
|
70
|
+
name: string;
|
|
71
|
+
}
|
|
72
|
+
/** The webview-side proxy implementing `SyncClientLike` over the plugin. */
|
|
73
|
+
export declare class TauriSyncClient extends NativeBridgeClient {
|
|
118
74
|
#private;
|
|
119
75
|
/** @internal — use {@link createTauriSyncClient}. */
|
|
120
|
-
constructor(tauri: TauriApi,
|
|
121
|
-
|
|
122
|
-
protected
|
|
123
|
-
|
|
124
|
-
protected
|
|
125
|
-
/**
|
|
126
|
-
protected
|
|
127
|
-
/** @internal — fan an incoming plugin event out to the local listeners. */
|
|
128
|
-
__dispatchEvent(event: SyncularEvent): void;
|
|
129
|
-
securityLifecycle(): Promise<SecurityLifecycle>;
|
|
130
|
-
beginSecurityPreflight(): Promise<void>;
|
|
76
|
+
constructor(tauri: TauriApi, release: () => void, securityLifecycle?: SecurityLifecycle);
|
|
77
|
+
protected send(method: string, params: Record<string, unknown>): Promise<NativeReply>;
|
|
78
|
+
protected sendQuery(sql: string, params: unknown): Promise<NativeReply>;
|
|
79
|
+
protected sendQuerySnapshot(params: Record<string, unknown>): Promise<NativeReply>;
|
|
80
|
+
protected sendHeaders(headers: Readonly<Record<string, string>>): Promise<NativeReply>;
|
|
81
|
+
/** Shut down the native core and release its keyring. */
|
|
82
|
+
protected shutdown(): Promise<void>;
|
|
131
83
|
/**
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
84
|
+
* The native core pushes diagnostics snapshots only once a consumer is
|
|
85
|
+
* known (a `diagnosticsSnapshot` pull, or this `enableDiagnostics` signal).
|
|
86
|
+
* The first listener sends it once, fire-and-forget and outside the
|
|
87
|
+
* preflight gate: it is a pure observability registration, and the native
|
|
88
|
+
* side stays silent until activation. An error is tolerated, because the
|
|
89
|
+
* mount-time snapshot pull keeps `useDiagnostics` working without it.
|
|
137
90
|
*/
|
|
138
|
-
activateSecurity(options?: {
|
|
139
|
-
readonly encryption?: EncryptionKeyringConfig;
|
|
140
|
-
readonly headers?: Readonly<Record<string, string>>;
|
|
141
|
-
}): Promise<void>;
|
|
142
|
-
onInvalidate(listener: InvalidationListener): () => void;
|
|
143
|
-
onProgress(listener: SyncProgressListener): () => void;
|
|
144
|
-
progressSnapshot(): SyncProgress | undefined;
|
|
145
|
-
onChange(listener: ClientChangeListener): () => void;
|
|
146
91
|
onDiagnostics(listener: ClientDiagnosticsListener): () => void;
|
|
147
|
-
onPresence(listener: (scopeKey: string) => void): () => void;
|
|
148
|
-
query(sql: string, params?: readonly SqlValue[]): Promise<SqlRow[]>;
|
|
149
|
-
querySnapshot<Row = SqlRow>(spec: QueryReadSpec): Promise<QuerySnapshot<Row>>;
|
|
150
|
-
localRevision(): Promise<bigint>;
|
|
151
|
-
/**
|
|
152
|
-
* §7.5: one atomic read over the file-backed sidecar. Every statement and
|
|
153
|
-
* every catch-up/delivery read shares one revision (a `bigint`, matching
|
|
154
|
-
* `querySnapshot`) and one read transaction; every query row is decoded.
|
|
155
|
-
*/
|
|
156
|
-
snapshotRead(request: SnapshotReadRequest): Promise<SnapshotRead>;
|
|
157
|
-
statusSnapshot(): Promise<SyncStatusSnapshot>;
|
|
158
|
-
diagnosticsSnapshot(request?: ClientDiagnosticsRequest): Promise<ClientDiagnosticsSnapshot>;
|
|
159
|
-
mutate(mutations: readonly MutationInput[]): Promise<string>;
|
|
160
|
-
patch(table: string, rowId: string, partial: Readonly<Record<string, unknown>>, options?: {
|
|
161
|
-
readonly baseVersion?: number;
|
|
162
|
-
}): Promise<string>;
|
|
163
|
-
purgeLocalData(input: LocalDataPurgeInput): Promise<LocalDataPurgeResult>;
|
|
164
|
-
rebootstrapLocalData(input: LocalDataRebootstrapInput): Promise<LocalDataRebootstrapResult>;
|
|
165
|
-
previousVersionSnapshot(spec: PreviousVersionReadSpec): Promise<PreviousVersionSnapshot>;
|
|
166
|
-
previousVersionAudit(): Promise<PreviousVersionAudit | undefined>;
|
|
167
|
-
previousVersionDiscard(): Promise<{
|
|
168
|
-
present: boolean;
|
|
169
|
-
discarded: boolean;
|
|
170
|
-
}>;
|
|
171
92
|
/** Suspend new network work while retaining local access and queued commits. */
|
|
172
93
|
setTransportEnabled(enabled: boolean): Promise<void>;
|
|
173
94
|
/** Browser offline-control parity; local reads and commits remain available. */
|
|
174
95
|
setOffline(offline: boolean): Promise<void>;
|
|
175
|
-
/**
|
|
176
|
-
* Replace the native transport's request headers at runtime — the auth
|
|
177
|
-
* rotation path. Pass the FULL header set (it replaces,
|
|
178
|
-
* it does not merge). HTTP requests use the new set from the next call;
|
|
179
|
-
* the realtime socket applies it on its next (re)connect.
|
|
180
|
-
*/
|
|
181
|
-
setHeaders(headers: Readonly<Record<string, string>>): Promise<void>;
|
|
182
|
-
/** Materialize a `crdt` column's collaborative text — decoded from the
|
|
183
|
-
* stored (server-merged) Yjs bytes. `name` selects the shared text
|
|
184
|
-
* (default `"text"`). An absent row / NULL column is the empty document. */
|
|
185
|
-
crdtText(table: string, rowId: string, column: string, name?: string): Promise<string>;
|
|
186
|
-
/** Insert `value` at UTF-16 offset `index` in a `crdt` column's text and
|
|
187
|
-
* push the resulting Yjs update (baseVersion-less). Returns the commit id. */
|
|
188
|
-
crdtInsertText(table: string, rowId: string, column: string, index: number, value: string, name?: string): Promise<string>;
|
|
189
|
-
/** Delete `len` UTF-16 code units at `index` in a `crdt` column's text. */
|
|
190
|
-
crdtDeleteText(table: string, rowId: string, column: string, index: number, len: number, name?: string): Promise<string>;
|
|
191
|
-
/** Escape hatch: apply an arbitrary Yjs update onto a `crdt` column. */
|
|
192
|
-
crdtApplyUpdate(table: string, rowId: string, column: string, update: Uint8Array): Promise<string>;
|
|
193
|
-
/**
|
|
194
|
-
* Stage a blob for attachment (§5.9.7) and return the canonical `BlobRef`
|
|
195
|
-
* string to store in a `blob_ref` column. The native core owns the upload
|
|
196
|
-
* queue; write the referencing row after this resolves (§5.9.3).
|
|
197
|
-
*/
|
|
198
|
-
uploadBlob(bytes: Uint8Array, options?: {
|
|
199
|
-
readonly mediaType?: string;
|
|
200
|
-
readonly name?: string;
|
|
201
|
-
}): Promise<string>;
|
|
202
|
-
/**
|
|
203
|
-
* Resolve blob bytes for a `blob_ref` column value or a bare `blobId`
|
|
204
|
-
* (§5.9.7): the native core serves a local cache hit and otherwise
|
|
205
|
-
* downloads and verifies the content address.
|
|
206
|
-
*/
|
|
207
|
-
fetchBlob(ref: string): Promise<{
|
|
208
|
-
readonly blobId: string;
|
|
209
|
-
readonly byteLength: number;
|
|
210
|
-
readonly bytes: Uint8Array;
|
|
211
|
-
readonly mediaType?: string;
|
|
212
|
-
}>;
|
|
213
|
-
subscribe(input: {
|
|
214
|
-
readonly id: string;
|
|
215
|
-
readonly table: string;
|
|
216
|
-
readonly scopes?: Record<string, readonly string[]>;
|
|
217
|
-
readonly params?: string;
|
|
218
|
-
}): Promise<void>;
|
|
219
|
-
/** Register several subscriptions in one local transaction. */
|
|
220
|
-
subscribeMany(inputs: readonly {
|
|
221
|
-
readonly id: string;
|
|
222
|
-
readonly table: string;
|
|
223
|
-
readonly scopes?: Record<string, readonly string[]>;
|
|
224
|
-
readonly params?: string;
|
|
225
|
-
}[]): Promise<void>;
|
|
226
|
-
unsubscribe(id: string): Promise<void>;
|
|
227
|
-
setWindow(base: WindowBase, units: readonly string[]): Promise<void>;
|
|
228
|
-
windowState(base: WindowBase): Promise<WindowState>;
|
|
229
|
-
sync(): Promise<unknown>;
|
|
230
96
|
/**
|
|
231
97
|
* Rotate the client id (§1.5) after a `sync.invalid_client_id` refusal
|
|
232
98
|
* (`recommendedAction: resetClientId`). The next round carries the new id;
|
|
233
99
|
* the replica and outbox stay in place.
|
|
234
100
|
*/
|
|
235
101
|
resetClientId(): Promise<string>;
|
|
236
|
-
syncUntilIdle(maxRounds?: number): Promise<unknown>;
|
|
237
|
-
proveCurrentBase(outcome: Pick<CommitOutcome, 'clientCommitId' | 'sequence'>, maxRounds?: number): Promise<CurrentBaseProof>;
|
|
238
|
-
conflicts(): Promise<readonly ConflictRecord[]>;
|
|
239
|
-
rejections(): Promise<readonly RejectionRecord[]>;
|
|
240
|
-
commitOutcome(clientCommitId: string): Promise<CommitOutcome | undefined>;
|
|
241
|
-
commitOutcomes(query?: CommitOutcomeQuery): Promise<readonly CommitOutcome[]>;
|
|
242
|
-
resolveCommitOutcome(input: ResolveCommitOutcomeInput): Promise<CommitOutcome>;
|
|
243
|
-
pendingCommits(): Promise<unknown[]>;
|
|
244
|
-
presence(scopeKey: string): Promise<readonly PresencePeer[]>;
|
|
245
|
-
setPresence(scopeKey: string, doc: Record<string, unknown> | null): Promise<void>;
|
|
246
|
-
connectRealtime(): Promise<void>;
|
|
247
|
-
disconnectRealtime(): Promise<void>;
|
|
248
|
-
/**
|
|
249
|
-
* Shut down the native core, release its keyring, then detach listeners.
|
|
250
|
-
* Every call returns the same promise, so a concurrent or repeated close
|
|
251
|
-
* settles only when the one native shutdown settles, with its outcome.
|
|
252
|
-
*/
|
|
253
|
-
close(): Promise<void>;
|
|
254
|
-
}
|
|
255
|
-
/** The error a `{error}` reply surfaces (mirrors the web-client `ClientSyncError`). */
|
|
256
|
-
export declare class TauriSyncError extends Error {
|
|
257
|
-
readonly code: string;
|
|
258
|
-
readonly details: Readonly<Record<string, unknown>> | undefined;
|
|
259
|
-
readonly retryable: boolean;
|
|
260
|
-
constructor(code: string, message: string, details?: Readonly<Record<string, unknown>>, retryable?: boolean);
|
|
261
102
|
}
|
|
262
103
|
/**
|
|
263
104
|
* Construct the bridge and issue the native `create` (opening/attaching the
|