@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
package/src/mutations.ts DELETED
@@ -1,168 +0,0 @@
1
- import type { SyncOperation } from '@syncular/core';
2
- import type { Insertable, Updateable } from 'kysely';
3
-
4
- type AnyDb = Record<string, Record<string, unknown>>;
5
-
6
- type ReservedKeys = '$commit' | '$table';
7
- type KnownKeys<T> = string extends keyof T ? never : keyof T & string;
8
- type KnownTableKey<DB> = Exclude<KnownKeys<DB>, ReservedKeys>;
9
-
10
- type InsertPayload<Row> =
11
- Insertable<Row> extends { id?: infer I }
12
- ? Omit<Insertable<Row>, 'id'> & { id?: I }
13
- : Insertable<Row>;
14
-
15
- type UpdatePayload<Row> = Omit<Updateable<Row>, 'id'> & { id?: never };
16
-
17
- type BaseVersionOptions = { baseVersion?: number | null };
18
-
19
- export interface MutationReceipt {
20
- commitId: string;
21
- clientCommitId: string;
22
- }
23
-
24
- export interface SyncularCommitMeta {
25
- operations: SyncOperation[];
26
- localMutations: Array<{
27
- table: string;
28
- rowId: string;
29
- op: 'upsert' | 'delete';
30
- }>;
31
- }
32
-
33
- export type TableMutations<DB, T extends keyof DB & string> = {
34
- insert: (
35
- values: InsertPayload<DB[T]>
36
- ) => Promise<MutationReceipt & { id: string }>;
37
- insertMany: (
38
- rows: Array<InsertPayload<DB[T]>>
39
- ) => Promise<MutationReceipt & { ids: string[] }>;
40
- update: (
41
- id: string,
42
- patch: UpdatePayload<DB[T]>,
43
- options?: BaseVersionOptions
44
- ) => Promise<MutationReceipt>;
45
- delete: (
46
- id: string,
47
- options?: BaseVersionOptions
48
- ) => Promise<MutationReceipt>;
49
- upsert: (
50
- id: string,
51
- patch: UpdatePayload<DB[T]>,
52
- options?: BaseVersionOptions
53
- ) => Promise<MutationReceipt>;
54
- };
55
-
56
- export type TableMutationsTx<DB, T extends keyof DB & string> = {
57
- insert: (values: InsertPayload<DB[T]>) => Promise<string>;
58
- insertMany: (rows: Array<InsertPayload<DB[T]>>) => Promise<string[]>;
59
- update: (
60
- id: string,
61
- patch: UpdatePayload<DB[T]>,
62
- options?: BaseVersionOptions
63
- ) => Promise<void>;
64
- delete: (id: string, options?: BaseVersionOptions) => Promise<void>;
65
- upsert: (
66
- id: string,
67
- patch: UpdatePayload<DB[T]>,
68
- options?: BaseVersionOptions
69
- ) => Promise<void>;
70
- };
71
-
72
- export type MutationsTx<DB> = {
73
- [T in KnownTableKey<DB>]: TableMutationsTx<DB, T>;
74
- } & {
75
- [table: string]: TableMutationsTx<AnyDb, string>;
76
- };
77
-
78
- export type MutationsCommitFn<DB, Meta = unknown, Options = unknown> = <R>(
79
- fn: (tx: MutationsTx<DB>) => Promise<R> | R,
80
- options?: Options
81
- ) => Promise<{ result: R; receipt: MutationReceipt; meta: Meta }>;
82
-
83
- export type MutationsApi<DB, CommitOptions = unknown> = {
84
- $commit: <R>(
85
- fn: (tx: MutationsTx<DB>) => Promise<R> | R,
86
- options?: CommitOptions
87
- ) => Promise<{ result: R; commit: MutationReceipt }>;
88
- $table: {
89
- <T extends KnownTableKey<DB>>(table: T): TableMutations<DB, T>;
90
- (table: string): TableMutations<AnyDb, string>;
91
- };
92
- } & {
93
- [T in KnownTableKey<DB>]: TableMutations<DB, T>;
94
- };
95
-
96
- export function createMutationsApi<DB, Meta = unknown, CommitOptions = unknown>(
97
- commit: MutationsCommitFn<DB, Meta, CommitOptions>
98
- ): MutationsApi<DB, CommitOptions> {
99
- const rootTableCache = new Map<string, TableMutations<AnyDb, string>>();
100
-
101
- const apiBase = {
102
- $commit: async <R>(
103
- fn: (tx: MutationsTx<DB>) => Promise<R> | R,
104
- options?: CommitOptions
105
- ) => {
106
- const { result, receipt } = await commit(fn, options);
107
- return { result, commit: receipt };
108
- },
109
- $table: (table: string) => {
110
- const cached = rootTableCache.get(table);
111
- if (cached) return cached;
112
-
113
- const tableApi: TableMutations<AnyDb, string> = {
114
- async insert(values) {
115
- const { result, receipt } = await commit(
116
- async (tx) => await tx[table]!.insert(values)
117
- );
118
- return { ...receipt, id: result };
119
- },
120
- async insertMany(rows) {
121
- const { result, receipt } = await commit(
122
- async (tx) => await tx[table]!.insertMany(rows)
123
- );
124
- return { ...receipt, ids: result };
125
- },
126
- async update(id, patch, opts) {
127
- const { receipt } = await commit(async (tx) => {
128
- await tx[table]!.update(id, patch, opts);
129
- return null;
130
- });
131
- return receipt;
132
- },
133
- async delete(id, opts) {
134
- const { receipt } = await commit(async (tx) => {
135
- await tx[table]!.delete(id, opts);
136
- return null;
137
- });
138
- return receipt;
139
- },
140
- async upsert(id, patch, opts) {
141
- const { receipt } = await commit(async (tx) => {
142
- await tx[table]!.upsert(id, patch, opts);
143
- return null;
144
- });
145
- return receipt;
146
- },
147
- };
148
-
149
- rootTableCache.set(table, tableApi);
150
- return tableApi;
151
- },
152
- };
153
-
154
- return new Proxy(apiBase, {
155
- get(target, prop) {
156
- if (prop === 'then') return undefined;
157
- if (typeof prop !== 'string') return undefined;
158
- if (hasOwn(target, prop)) {
159
- return (target as Record<string, unknown>)[prop];
160
- }
161
- return target.$table(prop);
162
- },
163
- }) as MutationsApi<DB, CommitOptions>;
164
- }
165
-
166
- function hasOwn(obj: object, key: string): boolean {
167
- return Object.hasOwn(obj, key);
168
- }
package/src/network.ts DELETED
@@ -1,32 +0,0 @@
1
- import type { SyncularNetworkStatusSource } from './types';
2
-
3
- export function browserSyncularNetworkStatusSource():
4
- | SyncularNetworkStatusSource
5
- | undefined {
6
- const target = globalThis as unknown as {
7
- navigator?: { onLine?: boolean };
8
- addEventListener?: (
9
- type: string,
10
- listener: EventListenerOrEventListenerObject
11
- ) => void;
12
- removeEventListener?: (
13
- type: string,
14
- listener: EventListenerOrEventListenerObject
15
- ) => void;
16
- };
17
- if (
18
- typeof target.navigator?.onLine !== 'boolean' &&
19
- (!target.addEventListener || !target.removeEventListener)
20
- ) {
21
- return undefined;
22
- }
23
- return {
24
- isOnline: () => target.navigator?.onLine,
25
- addEventListener: target.addEventListener
26
- ? (type, listener) => target.addEventListener?.(type, listener)
27
- : undefined,
28
- removeEventListener: target.removeEventListener
29
- ? (type, listener) => target.removeEventListener?.(type, listener)
30
- : undefined,
31
- };
32
- }