@livestore/common 0.3.0-dev.27 → 0.3.0-dev.29

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 (277) hide show
  1. package/dist/.tsbuildinfo +1 -1
  2. package/dist/__tests__/fixture.d.ts +83 -221
  3. package/dist/__tests__/fixture.d.ts.map +1 -1
  4. package/dist/__tests__/fixture.js +33 -11
  5. package/dist/__tests__/fixture.js.map +1 -1
  6. package/dist/adapter-types.d.ts +22 -15
  7. package/dist/adapter-types.d.ts.map +1 -1
  8. package/dist/adapter-types.js +15 -2
  9. package/dist/adapter-types.js.map +1 -1
  10. package/dist/bounded-collections.d.ts +1 -1
  11. package/dist/bounded-collections.d.ts.map +1 -1
  12. package/dist/debug-info.d.ts.map +1 -1
  13. package/dist/debug-info.js +1 -0
  14. package/dist/debug-info.js.map +1 -1
  15. package/dist/devtools/devtools-messages-client-session.d.ts +21 -21
  16. package/dist/devtools/devtools-messages-common.d.ts +6 -6
  17. package/dist/devtools/devtools-messages-leader.d.ts +45 -45
  18. package/dist/devtools/devtools-messages-leader.d.ts.map +1 -1
  19. package/dist/devtools/devtools-messages-leader.js +11 -11
  20. package/dist/devtools/devtools-messages-leader.js.map +1 -1
  21. package/dist/index.d.ts +2 -5
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index.js +2 -5
  24. package/dist/index.js.map +1 -1
  25. package/dist/leader-thread/LeaderSyncProcessor.d.ts +25 -12
  26. package/dist/leader-thread/LeaderSyncProcessor.d.ts.map +1 -1
  27. package/dist/leader-thread/LeaderSyncProcessor.js +125 -89
  28. package/dist/leader-thread/LeaderSyncProcessor.js.map +1 -1
  29. package/dist/leader-thread/{apply-mutation.d.ts → apply-event.d.ts} +7 -7
  30. package/dist/leader-thread/apply-event.d.ts.map +1 -0
  31. package/dist/leader-thread/apply-event.js +103 -0
  32. package/dist/leader-thread/apply-event.js.map +1 -0
  33. package/dist/leader-thread/eventlog.d.ts +27 -0
  34. package/dist/leader-thread/eventlog.d.ts.map +1 -0
  35. package/dist/leader-thread/eventlog.js +123 -0
  36. package/dist/leader-thread/eventlog.js.map +1 -0
  37. package/dist/leader-thread/leader-worker-devtools.js +18 -18
  38. package/dist/leader-thread/leader-worker-devtools.js.map +1 -1
  39. package/dist/leader-thread/make-leader-thread-layer.d.ts +16 -4
  40. package/dist/leader-thread/make-leader-thread-layer.d.ts.map +1 -1
  41. package/dist/leader-thread/make-leader-thread-layer.js +23 -16
  42. package/dist/leader-thread/make-leader-thread-layer.js.map +1 -1
  43. package/dist/leader-thread/mod.d.ts +1 -1
  44. package/dist/leader-thread/mod.d.ts.map +1 -1
  45. package/dist/leader-thread/mod.js +1 -1
  46. package/dist/leader-thread/mod.js.map +1 -1
  47. package/dist/leader-thread/recreate-db.d.ts.map +1 -1
  48. package/dist/leader-thread/recreate-db.js +6 -8
  49. package/dist/leader-thread/recreate-db.js.map +1 -1
  50. package/dist/leader-thread/types.d.ts +11 -11
  51. package/dist/leader-thread/types.d.ts.map +1 -1
  52. package/dist/materializer-helper.d.ts +23 -0
  53. package/dist/materializer-helper.d.ts.map +1 -0
  54. package/dist/materializer-helper.js +70 -0
  55. package/dist/materializer-helper.js.map +1 -0
  56. package/dist/query-builder/api.d.ts +58 -53
  57. package/dist/query-builder/api.d.ts.map +1 -1
  58. package/dist/query-builder/api.js +3 -5
  59. package/dist/query-builder/api.js.map +1 -1
  60. package/dist/query-builder/astToSql.d.ts.map +1 -1
  61. package/dist/query-builder/astToSql.js +59 -37
  62. package/dist/query-builder/astToSql.js.map +1 -1
  63. package/dist/query-builder/impl.d.ts +2 -3
  64. package/dist/query-builder/impl.d.ts.map +1 -1
  65. package/dist/query-builder/impl.js +48 -46
  66. package/dist/query-builder/impl.js.map +1 -1
  67. package/dist/query-builder/impl.test.d.ts +86 -1
  68. package/dist/query-builder/impl.test.d.ts.map +1 -1
  69. package/dist/query-builder/impl.test.js +244 -36
  70. package/dist/query-builder/impl.test.js.map +1 -1
  71. package/dist/rehydrate-from-eventlog.d.ts +14 -0
  72. package/dist/rehydrate-from-eventlog.d.ts.map +1 -0
  73. package/dist/{rehydrate-from-mutationlog.js → rehydrate-from-eventlog.js} +25 -26
  74. package/dist/rehydrate-from-eventlog.js.map +1 -0
  75. package/dist/schema/EventDef.d.ts +136 -0
  76. package/dist/schema/EventDef.d.ts.map +1 -0
  77. package/dist/schema/EventDef.js +58 -0
  78. package/dist/schema/EventDef.js.map +1 -0
  79. package/dist/schema/EventId.d.ts +2 -2
  80. package/dist/schema/EventId.d.ts.map +1 -1
  81. package/dist/schema/EventId.js +8 -2
  82. package/dist/schema/EventId.js.map +1 -1
  83. package/dist/schema/{MutationEvent.d.ts → LiveStoreEvent.d.ts} +56 -56
  84. package/dist/schema/LiveStoreEvent.d.ts.map +1 -0
  85. package/dist/schema/{MutationEvent.js → LiveStoreEvent.js} +25 -25
  86. package/dist/schema/LiveStoreEvent.js.map +1 -0
  87. package/dist/schema/client-document-def.d.ts +223 -0
  88. package/dist/schema/client-document-def.d.ts.map +1 -0
  89. package/dist/schema/client-document-def.js +170 -0
  90. package/dist/schema/client-document-def.js.map +1 -0
  91. package/dist/schema/client-document-def.test.d.ts +2 -0
  92. package/dist/schema/client-document-def.test.d.ts.map +1 -0
  93. package/dist/schema/client-document-def.test.js +201 -0
  94. package/dist/schema/client-document-def.test.js.map +1 -0
  95. package/dist/schema/db-schema/dsl/mod.d.ts.map +1 -1
  96. package/dist/schema/events.d.ts +2 -0
  97. package/dist/schema/events.d.ts.map +1 -0
  98. package/dist/schema/events.js +2 -0
  99. package/dist/schema/events.js.map +1 -0
  100. package/dist/schema/mod.d.ts +4 -3
  101. package/dist/schema/mod.d.ts.map +1 -1
  102. package/dist/schema/mod.js +4 -3
  103. package/dist/schema/mod.js.map +1 -1
  104. package/dist/schema/schema.d.ts +27 -23
  105. package/dist/schema/schema.d.ts.map +1 -1
  106. package/dist/schema/schema.js +45 -43
  107. package/dist/schema/schema.js.map +1 -1
  108. package/dist/schema/sqlite-state.d.ts +12 -0
  109. package/dist/schema/sqlite-state.d.ts.map +1 -0
  110. package/dist/schema/sqlite-state.js +36 -0
  111. package/dist/schema/sqlite-state.js.map +1 -0
  112. package/dist/schema/system-tables.d.ts +67 -98
  113. package/dist/schema/system-tables.d.ts.map +1 -1
  114. package/dist/schema/system-tables.js +62 -48
  115. package/dist/schema/system-tables.js.map +1 -1
  116. package/dist/schema/table-def.d.ts +26 -96
  117. package/dist/schema/table-def.d.ts.map +1 -1
  118. package/dist/schema/table-def.js +16 -64
  119. package/dist/schema/table-def.js.map +1 -1
  120. package/dist/schema/view.d.ts +3 -0
  121. package/dist/schema/view.d.ts.map +1 -0
  122. package/dist/schema/view.js +3 -0
  123. package/dist/schema/view.js.map +1 -0
  124. package/dist/schema-management/common.d.ts +4 -4
  125. package/dist/schema-management/common.d.ts.map +1 -1
  126. package/dist/schema-management/migrations.d.ts.map +1 -1
  127. package/dist/schema-management/migrations.js +6 -6
  128. package/dist/schema-management/migrations.js.map +1 -1
  129. package/dist/schema-management/validate-mutation-defs.d.ts +3 -3
  130. package/dist/schema-management/validate-mutation-defs.d.ts.map +1 -1
  131. package/dist/schema-management/validate-mutation-defs.js +17 -17
  132. package/dist/schema-management/validate-mutation-defs.js.map +1 -1
  133. package/dist/sync/ClientSessionSyncProcessor.d.ts +7 -7
  134. package/dist/sync/ClientSessionSyncProcessor.d.ts.map +1 -1
  135. package/dist/sync/ClientSessionSyncProcessor.js +31 -30
  136. package/dist/sync/ClientSessionSyncProcessor.js.map +1 -1
  137. package/dist/sync/next/facts.d.ts +19 -19
  138. package/dist/sync/next/facts.d.ts.map +1 -1
  139. package/dist/sync/next/facts.js +2 -2
  140. package/dist/sync/next/facts.js.map +1 -1
  141. package/dist/sync/next/history-dag-common.d.ts +3 -3
  142. package/dist/sync/next/history-dag-common.d.ts.map +1 -1
  143. package/dist/sync/next/history-dag-common.js +1 -1
  144. package/dist/sync/next/history-dag-common.js.map +1 -1
  145. package/dist/sync/next/history-dag.js +1 -1
  146. package/dist/sync/next/history-dag.js.map +1 -1
  147. package/dist/sync/next/rebase-events.d.ts +7 -7
  148. package/dist/sync/next/rebase-events.d.ts.map +1 -1
  149. package/dist/sync/next/rebase-events.js +5 -5
  150. package/dist/sync/next/rebase-events.js.map +1 -1
  151. package/dist/sync/next/test/compact-events.calculator.test.js +38 -33
  152. package/dist/sync/next/test/compact-events.calculator.test.js.map +1 -1
  153. package/dist/sync/next/test/compact-events.test.js +71 -71
  154. package/dist/sync/next/test/compact-events.test.js.map +1 -1
  155. package/dist/sync/next/test/{mutation-fixtures.d.ts → event-fixtures.d.ts} +29 -29
  156. package/dist/sync/next/test/event-fixtures.d.ts.map +1 -0
  157. package/dist/sync/next/test/{mutation-fixtures.js → event-fixtures.js} +60 -25
  158. package/dist/sync/next/test/event-fixtures.js.map +1 -0
  159. package/dist/sync/next/test/mod.d.ts +1 -1
  160. package/dist/sync/next/test/mod.d.ts.map +1 -1
  161. package/dist/sync/next/test/mod.js +1 -1
  162. package/dist/sync/next/test/mod.js.map +1 -1
  163. package/dist/sync/sync.d.ts +3 -3
  164. package/dist/sync/sync.d.ts.map +1 -1
  165. package/dist/sync/syncstate.d.ts +32 -32
  166. package/dist/sync/syncstate.d.ts.map +1 -1
  167. package/dist/sync/syncstate.js +31 -25
  168. package/dist/sync/syncstate.js.map +1 -1
  169. package/dist/sync/syncstate.test.js +165 -175
  170. package/dist/sync/syncstate.test.js.map +1 -1
  171. package/dist/sync/validate-push-payload.d.ts +2 -2
  172. package/dist/sync/validate-push-payload.d.ts.map +1 -1
  173. package/dist/sync/validate-push-payload.js.map +1 -1
  174. package/dist/version.d.ts +1 -1
  175. package/dist/version.js +1 -1
  176. package/package.json +3 -3
  177. package/src/__tests__/fixture.ts +36 -15
  178. package/src/adapter-types.ts +23 -16
  179. package/src/debug-info.ts +1 -0
  180. package/src/devtools/devtools-messages-leader.ts +13 -13
  181. package/src/index.ts +2 -5
  182. package/src/leader-thread/LeaderSyncProcessor.ts +183 -122
  183. package/src/leader-thread/{apply-mutation.ts → apply-event.ts} +50 -74
  184. package/src/leader-thread/eventlog.ts +199 -0
  185. package/src/leader-thread/leader-worker-devtools.ts +18 -18
  186. package/src/leader-thread/make-leader-thread-layer.ts +51 -29
  187. package/src/leader-thread/mod.ts +1 -1
  188. package/src/leader-thread/recreate-db.ts +6 -9
  189. package/src/leader-thread/types.ts +12 -12
  190. package/src/materializer-helper.ts +110 -0
  191. package/src/query-builder/api.ts +79 -105
  192. package/src/query-builder/astToSql.ts +68 -39
  193. package/src/query-builder/impl.test.ts +264 -42
  194. package/src/query-builder/impl.ts +72 -56
  195. package/src/{rehydrate-from-mutationlog.ts → rehydrate-from-eventlog.ts} +33 -40
  196. package/src/schema/EventDef.ts +216 -0
  197. package/src/schema/EventId.ts +11 -3
  198. package/src/schema/{MutationEvent.ts → LiveStoreEvent.ts} +68 -69
  199. package/src/schema/client-document-def.test.ts +239 -0
  200. package/src/schema/client-document-def.ts +444 -0
  201. package/src/schema/db-schema/dsl/mod.ts +0 -1
  202. package/src/schema/events.ts +1 -0
  203. package/src/schema/mod.ts +4 -3
  204. package/src/schema/schema.ts +79 -69
  205. package/src/schema/sqlite-state.ts +62 -0
  206. package/src/schema/system-tables.ts +42 -53
  207. package/src/schema/table-def.ts +53 -209
  208. package/src/schema/view.ts +2 -0
  209. package/src/schema-management/common.ts +4 -4
  210. package/src/schema-management/migrations.ts +8 -9
  211. package/src/schema-management/validate-mutation-defs.ts +22 -24
  212. package/src/sync/ClientSessionSyncProcessor.ts +37 -36
  213. package/src/sync/next/facts.ts +31 -32
  214. package/src/sync/next/history-dag-common.ts +4 -4
  215. package/src/sync/next/history-dag.ts +1 -1
  216. package/src/sync/next/rebase-events.ts +13 -13
  217. package/src/sync/next/test/compact-events.calculator.test.ts +45 -45
  218. package/src/sync/next/test/compact-events.test.ts +73 -73
  219. package/src/sync/next/test/event-fixtures.ts +219 -0
  220. package/src/sync/next/test/mod.ts +1 -1
  221. package/src/sync/sync.ts +3 -3
  222. package/src/sync/syncstate.test.ts +168 -179
  223. package/src/sync/syncstate.ts +48 -38
  224. package/src/sync/validate-push-payload.ts +2 -2
  225. package/src/version.ts +1 -1
  226. package/tmp/pack.tgz +0 -0
  227. package/tsconfig.json +1 -0
  228. package/dist/derived-mutations.d.ts +0 -109
  229. package/dist/derived-mutations.d.ts.map +0 -1
  230. package/dist/derived-mutations.js +0 -54
  231. package/dist/derived-mutations.js.map +0 -1
  232. package/dist/derived-mutations.test.d.ts +0 -2
  233. package/dist/derived-mutations.test.d.ts.map +0 -1
  234. package/dist/derived-mutations.test.js +0 -93
  235. package/dist/derived-mutations.test.js.map +0 -1
  236. package/dist/init-singleton-tables.d.ts +0 -4
  237. package/dist/init-singleton-tables.d.ts.map +0 -1
  238. package/dist/init-singleton-tables.js +0 -16
  239. package/dist/init-singleton-tables.js.map +0 -1
  240. package/dist/leader-thread/apply-mutation.d.ts.map +0 -1
  241. package/dist/leader-thread/apply-mutation.js +0 -122
  242. package/dist/leader-thread/apply-mutation.js.map +0 -1
  243. package/dist/leader-thread/mutationlog.d.ts +0 -27
  244. package/dist/leader-thread/mutationlog.d.ts.map +0 -1
  245. package/dist/leader-thread/mutationlog.js +0 -124
  246. package/dist/leader-thread/mutationlog.js.map +0 -1
  247. package/dist/leader-thread/pull-queue-set.d.ts +0 -7
  248. package/dist/leader-thread/pull-queue-set.d.ts.map +0 -1
  249. package/dist/leader-thread/pull-queue-set.js +0 -38
  250. package/dist/leader-thread/pull-queue-set.js.map +0 -1
  251. package/dist/mutation.d.ts +0 -20
  252. package/dist/mutation.d.ts.map +0 -1
  253. package/dist/mutation.js +0 -68
  254. package/dist/mutation.js.map +0 -1
  255. package/dist/query-info.d.ts +0 -41
  256. package/dist/query-info.d.ts.map +0 -1
  257. package/dist/query-info.js +0 -7
  258. package/dist/query-info.js.map +0 -1
  259. package/dist/rehydrate-from-mutationlog.d.ts +0 -15
  260. package/dist/rehydrate-from-mutationlog.d.ts.map +0 -1
  261. package/dist/rehydrate-from-mutationlog.js.map +0 -1
  262. package/dist/schema/MutationEvent.d.ts.map +0 -1
  263. package/dist/schema/MutationEvent.js.map +0 -1
  264. package/dist/schema/mutations.d.ts +0 -115
  265. package/dist/schema/mutations.d.ts.map +0 -1
  266. package/dist/schema/mutations.js +0 -42
  267. package/dist/schema/mutations.js.map +0 -1
  268. package/dist/sync/next/test/mutation-fixtures.d.ts.map +0 -1
  269. package/dist/sync/next/test/mutation-fixtures.js.map +0 -1
  270. package/src/derived-mutations.test.ts +0 -101
  271. package/src/derived-mutations.ts +0 -170
  272. package/src/init-singleton-tables.ts +0 -24
  273. package/src/leader-thread/mutationlog.ts +0 -202
  274. package/src/mutation.ts +0 -108
  275. package/src/query-info.ts +0 -83
  276. package/src/schema/mutations.ts +0 -193
  277. package/src/sync/next/test/mutation-fixtures.ts +0 -228
@@ -0,0 +1,239 @@
1
+ import { Schema } from '@livestore/utils/effect'
2
+ import { describe, expect, test } from 'vitest'
3
+
4
+ import { tables } from '../__tests__/fixture.js'
5
+ import { clientDocument, ClientDocumentTableDefSymbol } from './client-document-def.js'
6
+ import type * as LiveStoreEvent from './LiveStoreEvent.js'
7
+
8
+ const materializerContext = {
9
+ currentFacts: new Map(),
10
+ clientOnly: false,
11
+ }
12
+
13
+ describe('client document table', () => {
14
+ test('set event', () => {
15
+ expect(patchId(tables.UiState.set({ showSidebar: false }, 'session-1'))).toMatchInlineSnapshot(`
16
+ {
17
+ "args": {
18
+ "id": "session-1",
19
+ "value": {
20
+ "showSidebar": false,
21
+ },
22
+ },
23
+ "id": "00000000-0000-0000-0000-000000000000",
24
+ "name": "UiStateSet",
25
+ }
26
+ `)
27
+
28
+ expect(patchId(tables.appConfig.set({ fontSize: 12, theme: 'dark' }))).toMatchInlineSnapshot(`
29
+ {
30
+ "args": {
31
+ "id": "static",
32
+ "value": {
33
+ "fontSize": 12,
34
+ "theme": "dark",
35
+ },
36
+ },
37
+ "id": "00000000-0000-0000-0000-000000000000",
38
+ "name": "AppConfigSet",
39
+ }
40
+ `)
41
+ })
42
+
43
+ describe('materializer', () => {
44
+ const forSchema = <T>(schema: Schema.Schema<T, any>, value: T, id?: string, options?: { partialSet?: boolean }) => {
45
+ const Doc = clientDocument({
46
+ name: 'test',
47
+ schema,
48
+ default: { value },
49
+ ...options,
50
+ })
51
+
52
+ const materializer = Doc[ClientDocumentTableDefSymbol].derived.setMaterializer
53
+
54
+ return materializer(Doc.set(value, id as any).args, materializerContext)
55
+ }
56
+
57
+ test('string value', () => {
58
+ expect(forSchema(Schema.String, 'hello', 'id1')).toMatchInlineSnapshot(`
59
+ {
60
+ "bindValues": [
61
+ "id1",
62
+ ""hello"",
63
+ ""hello"",
64
+ ],
65
+ "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
66
+ "writeTables": Set {
67
+ "test",
68
+ },
69
+ }
70
+ `)
71
+ })
72
+
73
+ test('struct value (partial set=true)', () => {
74
+ expect(forSchema(Schema.Struct({ a: Schema.String }), { a: 'hello' }, 'id1', { partialSet: true }))
75
+ .toMatchInlineSnapshot(`
76
+ {
77
+ "bindValues": [
78
+ "id1",
79
+ "{"a":"hello"}",
80
+ "$.a",
81
+ ""hello"",
82
+ ],
83
+ "sql": "
84
+ INSERT INTO 'test' (id, value)
85
+ VALUES (?, ?)
86
+ ON CONFLICT (id) DO UPDATE SET value = json_set(value, ?, json(?))
87
+ ",
88
+ "writeTables": Set {
89
+ "test",
90
+ },
91
+ }
92
+ `)
93
+ })
94
+
95
+ test('struct value (partial set=false)', () => {
96
+ expect(forSchema(Schema.Struct({ a: Schema.String }), { a: 'hello' }, 'id1', { partialSet: false }))
97
+ .toMatchInlineSnapshot(`
98
+ {
99
+ "bindValues": [
100
+ "id1",
101
+ "{"a":"hello"}",
102
+ "{"a":"hello"}",
103
+ ],
104
+ "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
105
+ "writeTables": Set {
106
+ "test",
107
+ },
108
+ }
109
+ `)
110
+ })
111
+
112
+ test('struct value (partial set=true) advanced', () => {
113
+ expect(
114
+ forSchema(
115
+ Schema.Struct({ a: Schema.String, b: Schema.String, c: Schema.Number }),
116
+ { a: 'hello', c: 123 } as any,
117
+ 'id1',
118
+ { partialSet: true },
119
+ ),
120
+ ).toMatchInlineSnapshot(`
121
+ {
122
+ "bindValues": [
123
+ "id1",
124
+ "{"a":"hello","c":123}",
125
+ "$.a",
126
+ ""hello"",
127
+ "$.c",
128
+ "123",
129
+ ],
130
+ "sql": "
131
+ INSERT INTO 'test' (id, value)
132
+ VALUES (?, ?)
133
+ ON CONFLICT (id) DO UPDATE SET value = json_set(json_set(value, ?, json(?)), ?, json(?))
134
+ ",
135
+ "writeTables": Set {
136
+ "test",
137
+ },
138
+ }
139
+ `)
140
+ })
141
+
142
+ test('struct value (partial set=true), explicit undefined, filter out undefined values', () => {
143
+ expect(
144
+ forSchema(
145
+ Schema.Struct({ a: Schema.String.pipe(Schema.optional), b: Schema.String }),
146
+ { a: undefined, b: 'hello' },
147
+ 'id1',
148
+ {
149
+ partialSet: true,
150
+ },
151
+ ),
152
+ ).toMatchInlineSnapshot(`
153
+ {
154
+ "bindValues": [
155
+ "id1",
156
+ "{"b":"hello"}",
157
+ "$.b",
158
+ ""hello"",
159
+ ],
160
+ "sql": "
161
+ INSERT INTO 'test' (id, value)
162
+ VALUES (?, ?)
163
+ ON CONFLICT (id) DO UPDATE SET value = json_set(value, ?, json(?))
164
+ ",
165
+ "writeTables": Set {
166
+ "test",
167
+ },
168
+ }
169
+ `)
170
+ })
171
+
172
+ test('struct value (partial set=true), explicit undefined, nothing to update', () => {
173
+ expect(
174
+ forSchema(Schema.Struct({ a: Schema.String.pipe(Schema.optional) }), { a: undefined }, 'id1', {
175
+ partialSet: true,
176
+ }),
177
+ ).toMatchInlineSnapshot(`
178
+ {
179
+ "bindValues": [
180
+ "id1",
181
+ "{}",
182
+ ],
183
+ "sql": "
184
+ INSERT INTO 'test' (id, value)
185
+ VALUES (?, ?)
186
+ ON CONFLICT (id) DO NOTHING
187
+ ",
188
+ "writeTables": Set {
189
+ "test",
190
+ },
191
+ }
192
+ `)
193
+ })
194
+
195
+ test('struct union value', () => {
196
+ expect(
197
+ forSchema(
198
+ Schema.Union(Schema.Struct({ a: Schema.String }), Schema.Struct({ b: Schema.String })),
199
+ { a: 'hello' },
200
+ 'id1',
201
+ ),
202
+ ).toMatchInlineSnapshot(`
203
+ {
204
+ "bindValues": [
205
+ "id1",
206
+ "{"a":"hello"}",
207
+ "{"a":"hello"}",
208
+ ],
209
+ "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
210
+ "writeTables": Set {
211
+ "test",
212
+ },
213
+ }
214
+ `)
215
+ })
216
+
217
+ test('array value', () => {
218
+ expect(forSchema(Schema.Array(Schema.String), ['hello', 'world'], 'id1')).toMatchInlineSnapshot(`
219
+ {
220
+ "bindValues": [
221
+ "id1",
222
+ "["hello","world"]",
223
+ "["hello","world"]",
224
+ ],
225
+ "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
226
+ "writeTables": Set {
227
+ "test",
228
+ },
229
+ }
230
+ `)
231
+ })
232
+ })
233
+ })
234
+
235
+ const patchId = (muationEvent: LiveStoreEvent.PartialAnyDecoded) => {
236
+ // TODO use new id paradigm
237
+ const id = `00000000-0000-0000-0000-000000000000`
238
+ return { ...muationEvent, id }
239
+ }
@@ -0,0 +1,444 @@
1
+ import { shouldNeverHappen } from '@livestore/utils'
2
+ import type { Option, Types } from '@livestore/utils/effect'
3
+ import { Schema, SchemaAST } from '@livestore/utils/effect'
4
+
5
+ import { SessionIdSymbol } from '../adapter-types.js'
6
+ import type { QueryBuilder, QueryBuilderAst } from '../query-builder/mod.js'
7
+ import { QueryBuilderAstSymbol, QueryBuilderTypeId } from '../query-builder/mod.js'
8
+ import { sql } from '../util.js'
9
+ import { SqliteDsl } from './db-schema/mod.js'
10
+ import type { EventDef, Materializer } from './EventDef.js'
11
+ import { defineEvent, defineMaterializer } from './EventDef.js'
12
+ import type { TableDef, TableDefBase } from './table-def.js'
13
+ import { table } from './table-def.js'
14
+
15
+ /**
16
+ * Special:
17
+ * - Synced across client sessions (e.g. tabs) but not across different clients
18
+ * - Derived setters
19
+ * - Emits client-only events
20
+ * - Has implicit setter-reducers
21
+ * - Similar to `React.useState` (except it's persisted)
22
+ *
23
+ * Careful:
24
+ * - When changing the table definitions in a non-backwards compatible way, the state might be lost without
25
+ * explicit reducers to handle the old auto-generated events
26
+ */
27
+ export const clientDocument = <
28
+ TName extends string,
29
+ TType,
30
+ TEncoded,
31
+ const TOptions extends ClientDocumentTableOptions.Input<NoInfer<TType>>,
32
+ >({
33
+ name,
34
+ schema: valueSchema,
35
+ ...inputOptions
36
+ }: {
37
+ name: TName
38
+ schema: Schema.Schema<TType, TEncoded>
39
+ } & TOptions): ClientDocumentTableDef<
40
+ TName,
41
+ TType,
42
+ TEncoded,
43
+ Types.Simplify<ClientDocumentTableOptions.WithDefaults<TOptions>>
44
+ > => {
45
+ const options = {
46
+ partialSet: inputOptions.partialSet ?? true,
47
+ default: {
48
+ id: inputOptions.default.id,
49
+ value: inputOptions.default.value,
50
+ },
51
+ } satisfies ClientDocumentTableOptions<TType>
52
+
53
+ const columns = {
54
+ id: SqliteDsl.text({ primaryKey: true }),
55
+ value: SqliteDsl.json({ schema: valueSchema }),
56
+ }
57
+
58
+ const tableDef = table({ name, columns })
59
+
60
+ // @ts-expect-error TODO properly type this
61
+ tableDef.options.isClientDocumentTable = true
62
+
63
+ const { eventDef: derivedSetEventDef, materializer: derivedSetMaterializer } = deriveEventAndMaterializer({
64
+ name,
65
+ valueSchema,
66
+ defaultValue: options.default.value,
67
+ partialSet: options.partialSet,
68
+ })
69
+
70
+ const setEventDef = (...args: any[]) => {
71
+ const [value, id = options.default.id] = args
72
+ return derivedSetEventDef({ id, value })
73
+ }
74
+
75
+ Object.defineProperty(setEventDef, 'name', { value: `${name}Set` })
76
+ Object.defineProperty(setEventDef, 'schema', {
77
+ value: Schema.Struct({
78
+ id: Schema.String,
79
+ value: options.partialSet ? Schema.partial(valueSchema) : valueSchema,
80
+ }).annotations({ title: `${name}Set:Args` }),
81
+ })
82
+ Object.defineProperty(setEventDef, 'options', { value: { derived: true, clientOnly: true, facts: undefined } })
83
+
84
+ const clientDocumentTableDefTrait: ClientDocumentTableDef.Trait<
85
+ TName,
86
+ TType,
87
+ TEncoded,
88
+ ClientDocumentTableOptions<TType>
89
+ > = {
90
+ get: makeGetQueryBuilder(() => clientDocumentTableDef) as any,
91
+ set: setEventDef as any,
92
+ Value: 'only-for-type-inference' as any,
93
+ default: options.default,
94
+ valueSchema,
95
+ [ClientDocumentTableDefSymbol]: {
96
+ derived: {
97
+ setEventDef: derivedSetEventDef as any,
98
+ setMaterializer: derivedSetMaterializer as any,
99
+ },
100
+ options,
101
+ },
102
+ }
103
+
104
+ const clientDocumentTableDef = {
105
+ ...tableDef,
106
+ ...clientDocumentTableDefTrait,
107
+ } as any
108
+
109
+ return clientDocumentTableDef
110
+ }
111
+
112
+ const mergeDefaultValues = <T>(defaultValues: T, explicitDefaultValues: T): T => {
113
+ if (
114
+ typeof defaultValues !== 'object' ||
115
+ typeof explicitDefaultValues !== 'object' ||
116
+ defaultValues === null ||
117
+ explicitDefaultValues === null
118
+ ) {
119
+ return explicitDefaultValues
120
+ }
121
+
122
+ return Object.keys(defaultValues as any).reduce((acc, key) => {
123
+ acc[key] = (explicitDefaultValues as any)[key] ?? (defaultValues as any)[key]
124
+ return acc
125
+ }, {} as any)
126
+ }
127
+
128
+ export const deriveEventAndMaterializer = ({
129
+ name,
130
+ valueSchema,
131
+ defaultValue,
132
+ partialSet,
133
+ }: {
134
+ name: string
135
+ valueSchema: Schema.Schema<any, any>
136
+ defaultValue: any
137
+ partialSet: boolean
138
+ }) => {
139
+ const derivedSetEventDef = defineEvent({
140
+ name: `${name}Set`,
141
+ schema: Schema.Struct({
142
+ id: Schema.Union(Schema.String, Schema.UniqueSymbolFromSelf(SessionIdSymbol)),
143
+ value: partialSet ? Schema.partial(valueSchema) : valueSchema,
144
+ }).annotations({ title: `${name}Set:Args` }),
145
+ clientOnly: true,
146
+ derived: true,
147
+ })
148
+
149
+ const derivedSetMaterializer = defineMaterializer(derivedSetEventDef, ({ id, value }) => {
150
+ if (id === SessionIdSymbol) {
151
+ return shouldNeverHappen(`SessionIdSymbol needs to be replaced before materializing the set event`)
152
+ }
153
+
154
+ // Override the full value if it's not an object or no partial set is allowed
155
+ const schemaProps = SchemaAST.getPropertySignatures(valueSchema.ast)
156
+ if (schemaProps.length === 0 || partialSet === false) {
157
+ const valueColJsonSchema = Schema.parseJson(valueSchema)
158
+ const encodedInsertValue = Schema.encodeSyncDebug(valueColJsonSchema)(value ?? defaultValue)
159
+ const encodedUpdateValue = Schema.encodeSyncDebug(valueColJsonSchema)(value)
160
+
161
+ return {
162
+ sql: `INSERT INTO '${name}' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?`,
163
+ bindValues: [id, encodedInsertValue, encodedUpdateValue],
164
+ writeTables: new Set([name]),
165
+ }
166
+ } else {
167
+ const valueColJsonSchema = Schema.parseJson(Schema.partial(valueSchema))
168
+
169
+ const encodedInsertValue = Schema.encodeSyncDebug(valueColJsonSchema)(mergeDefaultValues(defaultValue, value))
170
+
171
+ let jsonSetSql = 'value'
172
+ const setBindValues: unknown[] = []
173
+
174
+ const keys = Object.keys(value)
175
+ const partialUpdateSchema = valueSchema.pipe(Schema.pick(...keys))
176
+ const encodedPartialUpdate = Schema.encodeSyncDebug(partialUpdateSchema)(value)
177
+
178
+ for (const key in encodedPartialUpdate) {
179
+ const encodedValueForKey = encodedPartialUpdate[key]
180
+ // Skipping undefined values
181
+ if (encodedValueForKey === undefined) {
182
+ continue
183
+ }
184
+ jsonSetSql = `json_set(${jsonSetSql}, ?, json(?))`
185
+ setBindValues.push(`$.${key}`, JSON.stringify(encodedValueForKey))
186
+ }
187
+
188
+ const onConflictClause =
189
+ setBindValues.length > 0
190
+ ? `ON CONFLICT (id) DO UPDATE SET value = ${jsonSetSql}`
191
+ : 'ON CONFLICT (id) DO NOTHING'
192
+
193
+ const sqlQuery = `
194
+ INSERT INTO '${name}' (id, value)
195
+ VALUES (?, ?)
196
+ ${onConflictClause}
197
+ `
198
+
199
+ return {
200
+ sql: sqlQuery,
201
+ bindValues: [id, encodedInsertValue, ...setBindValues],
202
+ writeTables: new Set([name]),
203
+ }
204
+ }
205
+ })
206
+
207
+ return { eventDef: derivedSetEventDef, materializer: derivedSetMaterializer }
208
+ }
209
+
210
+ export const tableIsClientDocumentTable = <TTableDef extends TableDefBase>(
211
+ tableDef: TTableDef,
212
+ ): tableDef is TTableDef & {
213
+ options: { isClientDocumentTable: true }
214
+ } & ClientDocumentTableDef.Trait<TTableDef['sqliteDef']['name'], any, any, any> =>
215
+ tableDef.options.isClientDocumentTable === true
216
+
217
+ const makeGetQueryBuilder = <TTableDef extends ClientDocumentTableDef<any, any, any, any>>(
218
+ getTableDef: () => TTableDef,
219
+ ): ClientDocumentTableDef.MakeGetQueryBuilder<any, any, any> => {
220
+ return ((...args: any[]) => {
221
+ const tableDef = getTableDef()
222
+
223
+ const [id = tableDef[ClientDocumentTableDefSymbol].options.default.id, options = {}] = args
224
+
225
+ const explicitDefaultValues = options.default ?? tableDef[ClientDocumentTableDefSymbol].options.default.value
226
+
227
+ const ast: QueryBuilderAst.RowQuery = {
228
+ _tag: 'RowQuery',
229
+ tableDef,
230
+ id,
231
+ explicitDefaultValues,
232
+ }
233
+
234
+ const query = sql`SELECT * FROM '${tableDef.sqliteDef.name}' WHERE id = ?`
235
+
236
+ return {
237
+ [QueryBuilderTypeId]: QueryBuilderTypeId,
238
+ [QueryBuilderAstSymbol]: ast,
239
+ ResultType: 'only-for-type-inference' as any,
240
+ asSql: () => ({ query, bindValues: [id] }),
241
+ toString: () => query.toString(),
242
+ ...({} as any), // Needed for type cast
243
+ }
244
+ }) as any
245
+ }
246
+
247
+ export type ClientDocumentTableOptions<TType> = {
248
+ partialSet: boolean
249
+ default: {
250
+ id: SessionIdSymbol | string | undefined
251
+ value: TType
252
+ }
253
+ }
254
+
255
+ export namespace ClientDocumentTableOptions {
256
+ export type Input<TType> = {
257
+ /**
258
+ * Whether to allow for partial set operations. Only applies if the schema is a struct.
259
+ *
260
+ * @default true
261
+ */
262
+ partialSet?: boolean
263
+ default: {
264
+ id?: SessionIdSymbol | string | undefined
265
+ value: TType
266
+ }
267
+ }
268
+
269
+ export type WithDefaults<TInput extends Input<any>> = {
270
+ partialSet: TInput['partialSet'] extends false ? false : true
271
+ default: {
272
+ id: TInput['default']['id'] extends string | SessionIdSymbol ? TInput['default']['id'] : undefined
273
+ value: TInput['default']['value']
274
+ }
275
+ }
276
+ }
277
+
278
+ export type ClientDocumentTableDef<
279
+ TName extends string,
280
+ TType,
281
+ TEncoded,
282
+ TOptions extends ClientDocumentTableOptions<TType>,
283
+ > = TableDef<
284
+ ClientDocumentTableDef.SqliteDef<TName, TType>,
285
+ {
286
+ isClientDocumentTable: true
287
+ }
288
+ > &
289
+ ClientDocumentTableDef.Trait<TName, TType, TEncoded, TOptions>
290
+
291
+ export namespace ClientDocumentTableDef {
292
+ export type Any = ClientDocumentTableDef<any, any, any, any>
293
+
294
+ export type SqliteDef<TName extends string, TType> = SqliteDsl.TableDefinition<
295
+ TName,
296
+ {
297
+ id: SqliteDsl.ColumnDefinition<string, string> & { default: Option.Some<string> }
298
+ value: SqliteDsl.ColumnDefinition<string, TType> & { default: Option.Some<TType> }
299
+ }
300
+ >
301
+
302
+ export type TableDefBase_<TName extends string, TType> = TableDefBase<
303
+ SqliteDef<TName, TType>,
304
+ {
305
+ isClientDocumentTable: true
306
+ }
307
+ >
308
+
309
+ export interface Trait<TName extends string, TType, TEncoded, TOptions extends ClientDocumentTableOptions<TType>> {
310
+ /**
311
+ * Get the current value of the client document table.
312
+ *
313
+ * @example
314
+ * ```ts
315
+ * const someDocumentTable = State.SQLite.clientDocument({
316
+ * name: 'SomeDocumentTable',
317
+ * schema: Schema.Struct({
318
+ * someField: Schema.String,
319
+ * }),
320
+ * default: { value: { someField: 'some-value' } },
321
+ * })
322
+ *
323
+ * const value$ = queryDb(someDocumentTable.get('some-id'))
324
+ *
325
+ * // When you've set a default id, you can omit the id argument
326
+ *
327
+ * const uiState = State.SQLite.clientDocument({
328
+ * name: 'UiState',
329
+ * schema: Schema.Struct({
330
+ * someField: Schema.String,
331
+ * }),
332
+ * default: { id: SessionIdSymbol, value: { someField: 'some-value' } },
333
+ * })
334
+ *
335
+ * const value$ = queryDb(uiState.get())
336
+ * ```
337
+ */
338
+ readonly get: MakeGetQueryBuilder<TName, TType, TOptions>
339
+ /**
340
+ * Derived event definition for setting the value of the client document table.
341
+ * If the document doesn't exist yet, the first .set event will create it.
342
+ *
343
+ * @example
344
+ * ```ts
345
+ * const someDocumentTable = State.SQLite.clientDocument({
346
+ * name: 'SomeDocumentTable',
347
+ * schema: Schema.Struct({
348
+ * someField: Schema.String,
349
+ * someOtherField: Schema.String,
350
+ * }),
351
+ * default: { value: { someField: 'some-default-value', someOtherField: 'some-other-default-value' } },
352
+ * })
353
+ *
354
+ * const setEventDef = store.commit(someDocumentTable.set({ someField: 'explicit-value' }, 'some-id'))
355
+ * // Will commit an event with the following payload:
356
+ * // { id: 'some-id', value: { someField: 'explicit-value', someOtherField: 'some-other-default-value' } }
357
+ * ```
358
+ *
359
+ * Similar to `.get`, you can omit the id argument if you've set a default id.
360
+ *
361
+ * @example
362
+ * ```ts
363
+ * const uiState = State.SQLite.clientDocument({
364
+ * name: 'UiState',
365
+ * schema: Schema.Struct({ someField: Schema.String }),
366
+ * default: { id: SessionIdSymbol, value: { someField: 'some-default-value' } },
367
+ * })
368
+ *
369
+ * const setEventDef = store.commit(uiState.set({ someField: 'explicit-value' }))
370
+ * // Will commit an event with the following payload:
371
+ * // { id: '...', value: { someField: 'explicit-value' } }
372
+ * // ^^^
373
+ * // Automatically replaced with the client session id
374
+ * ```
375
+ */
376
+ readonly set: SetEventDefLike<TName, TType, TOptions>
377
+ readonly Value: TType
378
+ readonly valueSchema: Schema.Schema<TType, TEncoded>
379
+ readonly default: TOptions['default']
380
+ readonly [ClientDocumentTableDefSymbol]: {
381
+ readonly options: TOptions
382
+ readonly derived: {
383
+ readonly setEventDef: SetEventDef<TName, TType, TOptions>
384
+ readonly setMaterializer: Materializer<SetEventDef<TName, TType, TOptions>>
385
+ }
386
+ }
387
+ }
388
+
389
+ export type GetOptions<TTableDef extends TraitAny> =
390
+ TTableDef extends ClientDocumentTableDef.Trait<any, any, any, infer TOptions> ? TOptions : never
391
+
392
+ export type TraitAny = Trait<any, any, any, any>
393
+
394
+ export type DefaultIdType<TTableDef extends TraitAny> =
395
+ TTableDef extends ClientDocumentTableDef.Trait<any, any, any, infer TOptions>
396
+ ? TOptions['default']['id'] extends SessionIdSymbol | string
397
+ ? TOptions['default']['id']
398
+ : never
399
+ : never
400
+
401
+ export type SetEventDefLike<TName extends string, TType, TOptions extends ClientDocumentTableOptions<TType>> =
402
+ // Helper to create partial event
403
+ (TOptions['default']['id'] extends undefined
404
+ ? (
405
+ args: TOptions['partialSet'] extends false ? TType : Partial<TType>,
406
+ id: string | SessionIdSymbol,
407
+ ) => { name: `${TName}Set`; args: { id: string; value: TType } }
408
+ : (
409
+ args: TOptions['partialSet'] extends false ? TType : Partial<TType>,
410
+ id?: string | SessionIdSymbol,
411
+ ) => { name: `${TName}Set`; args: { id: string; value: TType } }) & {
412
+ readonly name: `${TName}Set`
413
+ readonly schema: Schema.Schema<any>
414
+ readonly Event: {
415
+ readonly name: `${TName}Set`
416
+ readonly args: { id: string; value: TType }
417
+ }
418
+ readonly options: { derived: true; clientOnly: true; facts: undefined }
419
+ }
420
+
421
+ export type SetEventDef<TName extends string, TType, TOptions extends ClientDocumentTableOptions<TType>> = EventDef<
422
+ TName,
423
+ TOptions['partialSet'] extends false ? { id: string; value: TType } : { id: string; value: Partial<TType> },
424
+ any,
425
+ true
426
+ >
427
+
428
+ export type MakeGetQueryBuilder<
429
+ TName extends string,
430
+ TType,
431
+ TOptions extends ClientDocumentTableOptions<TType>,
432
+ > = TOptions extends ClientDocumentTableOptions<TType> & { default: { id: string | SessionIdSymbol } }
433
+ ? (
434
+ id?: TOptions['default']['id'] | SessionIdSymbol,
435
+ options?: { default: Partial<TType> },
436
+ ) => QueryBuilder<TType, ClientDocumentTableDef.TableDefBase_<TName, TType>, QueryBuilder.ApiFeature>
437
+ : (
438
+ id: string | SessionIdSymbol,
439
+ options?: { default: Partial<TType> },
440
+ ) => QueryBuilder<TType, ClientDocumentTableDef.TableDefBase_<TName, TType>, QueryBuilder.ApiFeature>
441
+ }
442
+
443
+ export const ClientDocumentTableDefSymbol = Symbol('ClientDocumentTableDef')
444
+ export type ClientDocumentTableDefSymbol = typeof ClientDocumentTableDefSymbol
@@ -122,7 +122,6 @@ export type IsSingleColumn<TColumns extends Columns | ColumnDefinition<any, any>
122
122
  *
123
123
  * Hopefully this can be removed in the future
124
124
  */
125
-
126
125
  export type ConstraintColumns = Record<string, ColumnDefinition<any, any>> & { __constrained?: never }
127
126
 
128
127
  export type Index = {
@@ -0,0 +1 @@
1
+ export { defineEvent, synced, clientOnly } from './EventDef.js'
package/src/schema/mod.ts CHANGED
@@ -1,8 +1,9 @@
1
1
  export * from './system-tables.js'
2
- export * as DbSchema from './table-def.js'
3
2
  export { SqliteAst, SqliteDsl } from './db-schema/mod.js'
4
- export * from './mutations.js'
3
+ export * from './EventDef.js'
5
4
  export * from './schema-helpers.js'
6
5
  export * from './schema.js'
7
- export * as MutationEvent from './MutationEvent.js'
6
+ export * as State from './view.js'
7
+ export * as LiveStoreEvent from './LiveStoreEvent.js'
8
8
  export * as EventId from './EventId.js'
9
+ export * as Events from './events.js'