@syncular/client 0.1.3 → 0.2.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.
Files changed (233) hide show
  1. package/README.md +227 -709
  2. package/dist/apply.d.ts +80 -0
  3. package/dist/apply.js +301 -0
  4. package/dist/blob.d.ts +127 -0
  5. package/dist/blob.js +201 -0
  6. package/dist/bun-database.d.ts +22 -0
  7. package/dist/bun-database.js +61 -0
  8. package/dist/client.d.ts +320 -69
  9. package/dist/client.js +1627 -163
  10. package/dist/content-type.d.ts +2 -0
  11. package/dist/content-type.js +2 -0
  12. package/dist/database.d.ts +35 -80
  13. package/dist/database.js +32 -947
  14. package/dist/encryption.d.ts +47 -0
  15. package/dist/encryption.js +75 -0
  16. package/dist/errors.d.ts +8 -22
  17. package/dist/errors.js +10 -207
  18. package/dist/http.d.ts +32 -0
  19. package/dist/http.js +196 -0
  20. package/dist/index.d.ts +28 -16
  21. package/dist/index.js +25 -12
  22. package/dist/invalidation.d.ts +69 -0
  23. package/dist/invalidation.js +84 -0
  24. package/dist/leader-lock.d.ts +28 -0
  25. package/dist/leader-lock.js +38 -0
  26. package/dist/multi-tab.d.ts +134 -0
  27. package/dist/multi-tab.js +399 -0
  28. package/dist/node-database.d.ts +41 -0
  29. package/dist/node-database.js +133 -0
  30. package/dist/outbox.d.ts +56 -0
  31. package/dist/outbox.js +140 -0
  32. package/dist/schema.d.ts +107 -0
  33. package/dist/schema.js +267 -0
  34. package/dist/state.d.ts +40 -0
  35. package/dist/state.js +77 -0
  36. package/dist/transport.d.ts +44 -0
  37. package/dist/transport.js +7 -0
  38. package/dist/wasm-database.d.ts +30 -0
  39. package/dist/wasm-database.js +170 -0
  40. package/dist/window.d.ts +64 -0
  41. package/dist/window.js +0 -0
  42. package/dist/worker-entry.d.ts +16 -2
  43. package/dist/worker-entry.js +300 -456
  44. package/dist/worker-host.d.ts +174 -0
  45. package/dist/worker-host.js +536 -0
  46. package/dist/worker-protocol.d.ts +173 -61
  47. package/dist/worker-protocol.js +7 -16
  48. package/package.json +45 -112
  49. package/src/apply.ts +435 -0
  50. package/src/blob.ts +333 -0
  51. package/src/bun-database.ts +75 -0
  52. package/src/client.ts +2247 -277
  53. package/src/content-type.ts +2 -0
  54. package/src/database.ts +63 -1389
  55. package/src/encryption.ts +123 -0
  56. package/src/errors.ts +11 -265
  57. package/src/http.ts +254 -0
  58. package/src/index.ts +25 -20
  59. package/src/invalidation.ts +128 -0
  60. package/src/leader-lock.ts +68 -0
  61. package/src/multi-tab.ts +550 -0
  62. package/src/node-database.ts +180 -0
  63. package/src/outbox.ts +206 -0
  64. package/src/schema.ts +397 -0
  65. package/src/state.ts +126 -0
  66. package/src/transport.ts +52 -0
  67. package/src/wasm-database.ts +279 -0
  68. package/src/window.ts +0 -0
  69. package/src/worker-entry.ts +391 -545
  70. package/src/worker-host.ts +800 -0
  71. package/src/worker-protocol.ts +204 -99
  72. package/dist/auth-leases.d.ts +0 -11
  73. package/dist/auth-leases.d.ts.map +0 -1
  74. package/dist/auth-leases.js +0 -140
  75. package/dist/auth-leases.js.map +0 -1
  76. package/dist/blob-limits.d.ts +0 -15
  77. package/dist/blob-limits.d.ts.map +0 -1
  78. package/dist/blob-limits.js +0 -66
  79. package/dist/blob-limits.js.map +0 -1
  80. package/dist/bridge-client.d.ts +0 -69
  81. package/dist/bridge-client.d.ts.map +0 -1
  82. package/dist/bridge-client.js +0 -282
  83. package/dist/bridge-client.js.map +0 -1
  84. package/dist/client-config.d.ts +0 -6
  85. package/dist/client-config.d.ts.map +0 -1
  86. package/dist/client-config.js +0 -18
  87. package/dist/client-config.js.map +0 -1
  88. package/dist/client.d.ts.map +0 -1
  89. package/dist/client.js.map +0 -1
  90. package/dist/command-history.d.ts +0 -35
  91. package/dist/command-history.d.ts.map +0 -1
  92. package/dist/command-history.js +0 -378
  93. package/dist/command-history.js.map +0 -1
  94. package/dist/console-diagnostics.d.ts +0 -33
  95. package/dist/console-diagnostics.d.ts.map +0 -1
  96. package/dist/console-diagnostics.js +0 -496
  97. package/dist/console-diagnostics.js.map +0 -1
  98. package/dist/crdt-yjs/index.d.ts +0 -4
  99. package/dist/crdt-yjs/index.d.ts.map +0 -1
  100. package/dist/crdt-yjs/index.js +0 -4
  101. package/dist/crdt-yjs/index.js.map +0 -1
  102. package/dist/crdt-yjs/webview-host-facade.d.ts +0 -126
  103. package/dist/crdt-yjs/webview-host-facade.d.ts.map +0 -1
  104. package/dist/crdt-yjs/webview-host-facade.js +0 -284
  105. package/dist/crdt-yjs/webview-host-facade.js.map +0 -1
  106. package/dist/crdt-yjs/yjs-document-field-adapter.d.ts +0 -153
  107. package/dist/crdt-yjs/yjs-document-field-adapter.d.ts.map +0 -1
  108. package/dist/crdt-yjs/yjs-document-field-adapter.js +0 -406
  109. package/dist/crdt-yjs/yjs-document-field-adapter.js.map +0 -1
  110. package/dist/crdt-yjs/yjs-prosemirror-bridge.d.ts +0 -73
  111. package/dist/crdt-yjs/yjs-prosemirror-bridge.d.ts.map +0 -1
  112. package/dist/crdt-yjs/yjs-prosemirror-bridge.js +0 -169
  113. package/dist/crdt-yjs/yjs-prosemirror-bridge.js.map +0 -1
  114. package/dist/database.d.ts.map +0 -1
  115. package/dist/database.js.map +0 -1
  116. package/dist/diagnostics.d.ts +0 -10
  117. package/dist/diagnostics.d.ts.map +0 -1
  118. package/dist/diagnostics.js +0 -83
  119. package/dist/diagnostics.js.map +0 -1
  120. package/dist/errors.d.ts.map +0 -1
  121. package/dist/errors.js.map +0 -1
  122. package/dist/generated-bridge.d.ts +0 -365
  123. package/dist/generated-bridge.d.ts.map +0 -1
  124. package/dist/generated-bridge.js +0 -250
  125. package/dist/generated-bridge.js.map +0 -1
  126. package/dist/index.d.ts.map +0 -1
  127. package/dist/index.js.map +0 -1
  128. package/dist/mutations.d.ts +0 -72
  129. package/dist/mutations.d.ts.map +0 -1
  130. package/dist/mutations.js +0 -63
  131. package/dist/mutations.js.map +0 -1
  132. package/dist/network.d.ts +0 -3
  133. package/dist/network.d.ts.map +0 -1
  134. package/dist/network.js +0 -17
  135. package/dist/network.js.map +0 -1
  136. package/dist/react/index.d.ts +0 -169
  137. package/dist/react/index.d.ts.map +0 -1
  138. package/dist/react/index.js +0 -628
  139. package/dist/react/index.js.map +0 -1
  140. package/dist/react-native/index.d.ts +0 -35
  141. package/dist/react-native/index.d.ts.map +0 -1
  142. package/dist/react-native/index.js +0 -49
  143. package/dist/react-native/index.js.map +0 -1
  144. package/dist/runtime-contract.d.ts +0 -13
  145. package/dist/runtime-contract.d.ts.map +0 -1
  146. package/dist/runtime-contract.js +0 -24
  147. package/dist/runtime-contract.js.map +0 -1
  148. package/dist/rust-client.d.ts +0 -106
  149. package/dist/rust-client.d.ts.map +0 -1
  150. package/dist/rust-client.js +0 -938
  151. package/dist/rust-client.js.map +0 -1
  152. package/dist/sentry.d.ts +0 -35
  153. package/dist/sentry.d.ts.map +0 -1
  154. package/dist/sentry.js +0 -155
  155. package/dist/sentry.js.map +0 -1
  156. package/dist/sql-safety.d.ts +0 -3
  157. package/dist/sql-safety.d.ts.map +0 -1
  158. package/dist/sql-safety.js +0 -62
  159. package/dist/sql-safety.js.map +0 -1
  160. package/dist/syncular-runtime-artifacts.json +0 -61
  161. package/dist/tauri/index.d.ts +0 -35
  162. package/dist/tauri/index.d.ts.map +0 -1
  163. package/dist/tauri/index.js +0 -114
  164. package/dist/tauri/index.js.map +0 -1
  165. package/dist/types.d.ts +0 -1096
  166. package/dist/types.d.ts.map +0 -1
  167. package/dist/types.js +0 -2
  168. package/dist/types.js.map +0 -1
  169. package/dist/wasm/.syncular-wasm-profile +0 -1
  170. package/dist/wasm/syncular-runtime-artifact.json +0 -21
  171. package/dist/wasm/syncular.d.ts +0 -207
  172. package/dist/wasm/syncular.js +0 -2341
  173. package/dist/wasm/syncular_bg.wasm +0 -0
  174. package/dist/wasm/syncular_bg.wasm.d.ts +0 -97
  175. package/dist/wasm-bindings/runtime-contract.d.ts +0 -22
  176. package/dist/wasm-bindings/runtime-contract.d.ts.map +0 -1
  177. package/dist/wasm-bindings/runtime-contract.js +0 -112
  178. package/dist/wasm-bindings/runtime-contract.js.map +0 -1
  179. package/dist/wasm-core/.syncular-wasm-profile +0 -1
  180. package/dist/wasm-core/syncular-runtime-artifact.json +0 -17
  181. package/dist/wasm-core/syncular.d.ts +0 -162
  182. package/dist/wasm-core/syncular.js +0 -1847
  183. package/dist/wasm-core/syncular_bg.wasm +0 -0
  184. package/dist/wasm-core/syncular_bg.wasm.d.ts +0 -77
  185. package/dist/wasm-perf/.syncular-wasm-profile +0 -1
  186. package/dist/wasm-perf/syncular-runtime-artifact.json +0 -21
  187. package/dist/wasm-perf/syncular.d.ts +0 -207
  188. package/dist/wasm-perf/syncular.js +0 -2341
  189. package/dist/wasm-perf/syncular_bg.wasm +0 -0
  190. package/dist/wasm-perf/syncular_bg.wasm.d.ts +0 -97
  191. package/dist/wasm-runtime.d.ts +0 -23
  192. package/dist/wasm-runtime.d.ts.map +0 -1
  193. package/dist/wasm-runtime.js +0 -69
  194. package/dist/wasm-runtime.js.map +0 -1
  195. package/dist/worker-client.d.ts +0 -123
  196. package/dist/worker-client.d.ts.map +0 -1
  197. package/dist/worker-client.js +0 -1735
  198. package/dist/worker-client.js.map +0 -1
  199. package/dist/worker-entry.d.ts.map +0 -1
  200. package/dist/worker-entry.js.map +0 -1
  201. package/dist/worker-protocol.d.ts.map +0 -1
  202. package/dist/worker-protocol.js.map +0 -1
  203. package/dist/worker-realtime.d.ts +0 -39
  204. package/dist/worker-realtime.d.ts.map +0 -1
  205. package/dist/worker-realtime.js +0 -677
  206. package/dist/worker-realtime.js.map +0 -1
  207. package/src/auth-leases.ts +0 -251
  208. package/src/blob-limits.ts +0 -98
  209. package/src/bridge-client.ts +0 -512
  210. package/src/client-config.ts +0 -29
  211. package/src/command-history.ts +0 -623
  212. package/src/console-diagnostics.ts +0 -617
  213. package/src/crdt-yjs/index.ts +0 -3
  214. package/src/crdt-yjs/webview-host-facade.ts +0 -477
  215. package/src/crdt-yjs/yjs-document-field-adapter.ts +0 -733
  216. package/src/crdt-yjs/yjs-prosemirror-bridge.ts +0 -272
  217. package/src/diagnostics.ts +0 -116
  218. package/src/generated-bridge.ts +0 -741
  219. package/src/mutations.ts +0 -168
  220. package/src/network.ts +0 -32
  221. package/src/react/index.ts +0 -1036
  222. package/src/react-native/index.ts +0 -152
  223. package/src/runtime-contract.ts +0 -48
  224. package/src/rust-client.ts +0 -1491
  225. package/src/sentry.ts +0 -215
  226. package/src/sql-safety.ts +0 -61
  227. package/src/tauri/index.ts +0 -211
  228. package/src/types.ts +0 -1397
  229. package/src/wasm-bindings/generated-wasm-bindings.d.ts +0 -70
  230. package/src/wasm-bindings/runtime-contract.ts +0 -158
  231. package/src/wasm-runtime.ts +0 -145
  232. package/src/worker-client.ts +0 -2289
  233. package/src/worker-realtime.ts +0 -843
@@ -1,152 +0,0 @@
1
- import {
2
- type CreateSyncularBridgeClientOptions,
3
- createSyncularBridgeClient,
4
- type SyncularAuthLeaseRecord,
5
- type SyncularBridge,
6
- type SyncularBridgeMutationBatch,
7
- type SyncularBridgeQueryRequest,
8
- type SyncularBridgeQueryResult,
9
- type SyncularBridgeStatus,
10
- type SyncularClientEventMap,
11
- type SyncularClientEventSink,
12
- type SyncularClientEventType,
13
- type SyncularClientLike,
14
- type SyncularConflictResolution,
15
- type SyncularConflictSummary,
16
- type SyncularDiagnosticSnapshot,
17
- type SyncularPresenceEntry,
18
- type SyncularPresenceSink,
19
- type SyncularSubscriptionSpec,
20
- type SyncularSyncResult,
21
- } from '@syncular/client';
22
- import type { SyncAuthLeaseIssueRequest } from '@syncular/core';
23
-
24
- export type SyncularNativeEventSubscription = (() => void) | { remove(): void };
25
-
26
- export interface SyncularNativeModule {
27
- executeSql<Row extends Record<string, unknown> = Record<string, unknown>>(
28
- request: SyncularBridgeQueryRequest
29
- ): Promise<SyncularBridgeQueryResult<Row>> | SyncularBridgeQueryResult<Row>;
30
- applyMutationsCommit(
31
- batch: SyncularBridgeMutationBatch
32
- ): Promise<string> | string;
33
- applyLeasedMutationsCommit?(
34
- batch: SyncularBridgeMutationBatch
35
- ): Promise<string> | string;
36
- sync?(): Promise<SyncularSyncResult>;
37
- resumeFromBackground?(): Promise<SyncularSyncResult>;
38
- start?(): Promise<void>;
39
- stop?(): Promise<void>;
40
- setSubscriptions?(
41
- subscriptions: readonly SyncularSubscriptionSpec[]
42
- ): Promise<void>;
43
- getStatus?(): SyncularBridgeStatus;
44
- issueAuthLease?(
45
- request: SyncAuthLeaseIssueRequest
46
- ): Promise<SyncularAuthLeaseRecord>;
47
- upsertAuthLease?(lease: SyncularAuthLeaseRecord): Promise<void>;
48
- authLease?(leaseId: string): Promise<SyncularAuthLeaseRecord | null>;
49
- activeAuthLeases?(
50
- actorId?: string | null,
51
- nowMs?: number
52
- ): Promise<SyncularAuthLeaseRecord[]>;
53
- diagnosticSnapshot?(): Promise<SyncularDiagnosticSnapshot>;
54
- addListener?<T extends SyncularClientEventType>(
55
- event: T,
56
- listener: SyncularClientEventSink<T>
57
- ): SyncularNativeEventSubscription;
58
- getPresence?<TMetadata = Record<string, unknown>>(
59
- scopeKey: string
60
- ): SyncularPresenceEntry<TMetadata>[];
61
- joinPresence?(scopeKey: string, metadata?: Record<string, unknown>): void;
62
- leavePresence?(scopeKey: string): void;
63
- updatePresenceMetadata?(
64
- scopeKey: string,
65
- metadata: Record<string, unknown>
66
- ): void;
67
- conflictSummaries?(): Promise<SyncularConflictSummary[]>;
68
- retryConflictKeepLocal?(id: string): Promise<string>;
69
- resolveConflict?(
70
- id: string,
71
- resolution: SyncularConflictResolution
72
- ): Promise<void>;
73
- }
74
-
75
- export interface CreateSyncularNativeClientOptions
76
- extends Omit<CreateSyncularBridgeClientOptions, 'bridge'> {
77
- module: SyncularNativeModule;
78
- }
79
-
80
- export async function createSyncularNativeClient<DB>(
81
- options: CreateSyncularNativeClientOptions
82
- ): Promise<SyncularClientLike<DB>> {
83
- return createSyncularBridgeClient<DB>({
84
- ...options,
85
- bridge: createSyncularNativeBridge(options.module),
86
- });
87
- }
88
-
89
- export function createSyncularNativeBridge(
90
- module: SyncularNativeModule
91
- ): SyncularBridge {
92
- return {
93
- executeSql: <Row extends Record<string, unknown>>(
94
- request: SyncularBridgeQueryRequest
95
- ) => module.executeSql<Row>(request),
96
- applyMutationsCommit: (batch) => module.applyMutationsCommit(batch),
97
- applyLeasedMutationsCommit: module.applyLeasedMutationsCommit?.bind(module),
98
- sync: module.sync?.bind(module),
99
- resumeFromBackground: module.resumeFromBackground?.bind(module),
100
- start: module.start?.bind(module),
101
- stop: module.stop?.bind(module),
102
- setSubscriptions: module.setSubscriptions?.bind(module),
103
- getStatus: module.getStatus?.bind(module),
104
- issueAuthLease: module.issueAuthLease?.bind(module),
105
- upsertAuthLease: module.upsertAuthLease?.bind(module),
106
- authLease: module.authLease?.bind(module),
107
- activeAuthLeases: module.activeAuthLeases?.bind(module),
108
- diagnosticSnapshot: module.diagnosticSnapshot?.bind(module),
109
- on: (event, listener) => removeable(module.addListener?.(event, listener)),
110
- presence: {
111
- get: (scopeKey) => module.getPresence?.(scopeKey) ?? [],
112
- join: (scopeKey, metadata) => module.joinPresence?.(scopeKey, metadata),
113
- leave: (scopeKey) => module.leavePresence?.(scopeKey),
114
- updateMetadata: (scopeKey, metadata) =>
115
- module.updatePresenceMetadata?.(scopeKey, metadata),
116
- onChange: <TMetadata = Record<string, unknown>>(
117
- listener: SyncularPresenceSink<TMetadata>
118
- ) =>
119
- removeable(
120
- module.addListener?.('presenceChanged', (event) =>
121
- listener(
122
- event as SyncularClientEventMap['presenceChanged'] as Parameters<
123
- SyncularPresenceSink<TMetadata>
124
- >[0]
125
- )
126
- )
127
- ),
128
- },
129
- conflicts: {
130
- list: () => module.conflictSummaries?.() ?? Promise.resolve([]),
131
- retryKeepLocal: (id) =>
132
- module.retryConflictKeepLocal?.(id) ??
133
- Promise.reject(
134
- new Error('Syncular native module cannot retry conflicts.')
135
- ),
136
- resolve: (id, resolution) =>
137
- module.resolveConflict?.(id, resolution) ??
138
- Promise.reject(
139
- new Error('Syncular native module cannot resolve conflicts.')
140
- ),
141
- },
142
- };
143
- }
144
-
145
- function removeable(subscription: SyncularNativeEventSubscription | undefined) {
146
- if (!subscription) return noop;
147
- return typeof subscription === 'function'
148
- ? subscription
149
- : () => subscription.remove();
150
- }
151
-
152
- function noop(): void {}
@@ -1,48 +0,0 @@
1
- import type {
2
- SyncularRuntimeInfo,
3
- SyncularRustRuntimeInfo,
4
- SyncularStorage,
5
- } from './types';
6
- import {
7
- SYNCULAR_CLIENT_PACKAGE_NAME,
8
- SYNCULAR_CLIENT_PACKAGE_VERSION,
9
- } from './wasm-bindings/runtime-contract';
10
- import { SYNCULAR_WORKER_PROTOCOL_VERSION } from './worker-protocol';
11
-
12
- export {
13
- SYNCULAR_CORE_RUNTIME_FEATURES,
14
- SYNCULAR_FULL_RUNTIME_FEATURES,
15
- SYNCULAR_WASM_ARTIFACT_CATALOG_FILE,
16
- SYNCULAR_WASM_ARTIFACT_FILE,
17
- SYNCULAR_WASM_BINARY_FILE,
18
- SYNCULAR_WASM_GLUE_FILE,
19
- SYNCULAR_WASM_OUT_NAME,
20
- } from './wasm-bindings/runtime-contract';
21
- export { SYNCULAR_WORKER_PROTOCOL_VERSION } from './worker-protocol';
22
-
23
- export const SYNCULAR_PACKAGE_NAME = SYNCULAR_CLIENT_PACKAGE_NAME;
24
- export const SYNCULAR_PACKAGE_VERSION = SYNCULAR_CLIENT_PACKAGE_VERSION;
25
-
26
- export function createSyncularRuntimeInfo(options: {
27
- storage?: SyncularStorage;
28
- workerUrl?: string | URL;
29
- wasmGlueUrl: string | URL;
30
- wasmUrl: string | URL | Request;
31
- rust?: SyncularRustRuntimeInfo | null;
32
- }): SyncularRuntimeInfo {
33
- return {
34
- packageName: SYNCULAR_PACKAGE_NAME,
35
- packageVersion: SYNCULAR_PACKAGE_VERSION,
36
- workerProtocolVersion: SYNCULAR_WORKER_PROTOCOL_VERSION,
37
- storage: options.storage,
38
- workerUrl: options.workerUrl == null ? undefined : href(options.workerUrl),
39
- wasmGlueUrl: href(options.wasmGlueUrl),
40
- wasmUrl: href(options.wasmUrl),
41
- rust: options.rust ?? undefined,
42
- };
43
- }
44
-
45
- function href(value: string | URL | Request): string {
46
- if (value instanceof Request) return value.url;
47
- return value instanceof URL ? value.href : value;
48
- }