@abloatai/ablo 0.34.0 → 0.35.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 (483) hide show
  1. package/AGENTS.md +4 -1
  2. package/CHANGELOG.md +684 -5
  3. package/README.md +39 -22
  4. package/dist/BaseSyncedStore.d.ts +152 -44
  5. package/dist/BaseSyncedStore.js +300 -184
  6. package/dist/Database.d.ts +9 -24
  7. package/dist/Database.js +37 -22
  8. package/dist/InstanceCache.d.ts +25 -4
  9. package/dist/InstanceCache.js +48 -15
  10. package/dist/LazyReferenceCollection.d.ts +3 -3
  11. package/dist/LazyReferenceCollection.js +4 -4
  12. package/dist/Model.d.ts +6 -6
  13. package/dist/Model.js +10 -10
  14. package/dist/ModelRegistry.d.ts +4 -4
  15. package/dist/ModelRegistry.js +3 -3
  16. package/dist/{SyncEngineContext.d.ts → RuntimeContext.d.ts} +20 -13
  17. package/dist/{SyncEngineContext.js → RuntimeContext.js} +11 -12
  18. package/dist/SyncClient.d.ts +42 -32
  19. package/dist/SyncClient.js +166 -110
  20. package/dist/ai-sdk/coordinatedTool.d.ts +2 -2
  21. package/dist/ai-sdk/coordinatedTool.js +1 -1
  22. package/dist/ai-sdk/coordinationContext.d.ts +2 -2
  23. package/dist/ai-sdk/coordinationContext.js +1 -1
  24. package/dist/ai-sdk/wrap.d.ts +3 -3
  25. package/dist/ai-sdk/wrap.js +2 -2
  26. package/dist/auth/index.d.ts +1 -156
  27. package/dist/auth/index.js +8 -301
  28. package/dist/cli.cjs +3459 -1126
  29. package/dist/client/Ablo.d.ts +42 -287
  30. package/dist/client/Ablo.js +118 -963
  31. package/dist/client/abloClient.d.ts +309 -0
  32. package/dist/client/abloClient.js +13 -0
  33. package/dist/client/clientPrelude.d.ts +52 -0
  34. package/dist/client/clientPrelude.js +60 -0
  35. package/dist/client/consoleLogger.d.ts +2 -2
  36. package/dist/client/coreClient.d.ts +60 -0
  37. package/dist/client/coreClient.js +118 -0
  38. package/dist/client/createInternalComponents.d.ts +4 -4
  39. package/dist/client/createInternalComponents.js +9 -8
  40. package/dist/client/createModelProxy.d.ts +78 -373
  41. package/dist/client/createModelProxy.js +114 -86
  42. package/dist/client/humans.d.ts +48 -0
  43. package/dist/client/humans.js +52 -0
  44. package/dist/client/modelRegistration.d.ts +1 -1
  45. package/dist/client/modelRegistration.js +9 -9
  46. package/dist/client/options.d.ts +73 -17
  47. package/dist/client/reactiveEngine.d.ts +48 -0
  48. package/dist/client/reactiveEngine.js +910 -0
  49. package/dist/client/resourceTypes.d.ts +9 -250
  50. package/dist/client/resourceTypes.js +8 -5
  51. package/dist/client/schemaConfig.d.ts +4 -4
  52. package/dist/client/schemaConfig.js +6 -2
  53. package/dist/client/validateAbloOptions.d.ts +3 -2
  54. package/dist/client/validateAbloOptions.js +1 -1
  55. package/dist/client/wsMutationExecutor.d.ts +3 -3
  56. package/dist/client/wsMutationExecutor.js +3 -3
  57. package/dist/context.d.ts +9 -9
  58. package/dist/context.js +10 -9
  59. package/dist/coordination/ClaimLog.d.ts +26 -0
  60. package/dist/coordination/ClaimLog.js +32 -0
  61. package/dist/coordination/index.d.ts +1 -15
  62. package/dist/coordination/index.js +8 -31
  63. package/dist/core/DatabaseManager.js +1 -1
  64. package/dist/core/QueryView.d.ts +1 -1
  65. package/dist/core/QueryView.js +1 -1
  66. package/dist/core/StoreManager.d.ts +4 -23
  67. package/dist/core/StoreManager.js +5 -55
  68. package/dist/core/index.d.ts +2 -2
  69. package/dist/core/index.js +2 -2
  70. package/dist/core/storeContract.d.ts +2 -2
  71. package/dist/docs/catalog.d.ts +72 -0
  72. package/dist/docs/catalog.js +227 -0
  73. package/dist/docs/index.d.ts +10 -0
  74. package/dist/docs/index.js +10 -0
  75. package/dist/environment.d.ts +1 -40
  76. package/dist/environment.js +8 -37
  77. package/dist/index.d.ts +40 -34
  78. package/dist/index.js +26 -20
  79. package/dist/interfaces/index.d.ts +44 -134
  80. package/dist/keys/index.d.ts +1 -77
  81. package/dist/keys/index.js +8 -190
  82. package/dist/mutators/{RecordingTransaction.d.ts → RecordingMutation.d.ts} +4 -4
  83. package/dist/mutators/{RecordingTransaction.js → RecordingMutation.js} +2 -2
  84. package/dist/mutators/Transaction.d.ts +1 -1
  85. package/dist/mutators/Transaction.js +1 -1
  86. package/dist/mutators/UndoManager.d.ts +6 -6
  87. package/dist/mutators/UndoManager.js +5 -5
  88. package/dist/mutators/defineMutators.d.ts +3 -3
  89. package/dist/mutators/defineMutators.js +1 -1
  90. package/dist/mutators/inverseOp.js +2 -2
  91. package/dist/mutators/mutateActions.d.ts +3 -3
  92. package/dist/mutators/mutateActions.js +1 -1
  93. package/dist/mutators/readerActions.d.ts +1 -1
  94. package/dist/mutators/undoApply.d.ts +1 -1
  95. package/dist/mutators/undoApply.js +1 -1
  96. package/dist/policy/index.d.ts +2 -2
  97. package/dist/policy/index.js +1 -1
  98. package/dist/query/client.d.ts +2 -2
  99. package/dist/query/client.js +4 -4
  100. package/dist/query/types.d.ts +6 -41
  101. package/dist/query/types.js +2 -2
  102. package/dist/react/AbloProvider.d.ts +6 -8
  103. package/dist/react/AbloProvider.js +5 -7
  104. package/dist/react/context.d.ts +1 -1
  105. package/dist/react/context.js +1 -1
  106. package/dist/react/index.d.ts +5 -5
  107. package/dist/react/index.js +3 -3
  108. package/dist/react/internalContext.d.ts +1 -1
  109. package/dist/react/useAblo.d.ts +3 -3
  110. package/dist/react/useAblo.js +1 -1
  111. package/dist/react/useCurrentUserId.js +1 -1
  112. package/dist/react/useErrorListener.js +1 -1
  113. package/dist/react/useMutationFailureListener.d.ts +2 -2
  114. package/dist/react/useMutationFailureListener.js +1 -1
  115. package/dist/react/useMutators.d.ts +3 -3
  116. package/dist/react/useMutators.js +3 -3
  117. package/dist/react/useUndoScope.d.ts +5 -5
  118. package/dist/react/useUndoScope.js +1 -1
  119. package/dist/schema/coordination.d.ts +69 -10
  120. package/dist/schema/coordination.js +86 -9
  121. package/dist/schema/ddl.js +2 -2
  122. package/dist/schema/diff.d.ts +1 -1
  123. package/dist/schema/generate.js +1 -1
  124. package/dist/schema/index.d.ts +10 -10
  125. package/dist/schema/index.js +18 -18
  126. package/dist/schema/queries.d.ts +27 -27
  127. package/dist/schema/queries.js +23 -23
  128. package/dist/schema/select.d.ts +3 -3
  129. package/dist/schema/select.js +3 -3
  130. package/dist/schema/serialize.d.ts +15 -6
  131. package/dist/schema/serialize.js +17 -3
  132. package/dist/schema/sugar.d.ts +6 -7
  133. package/dist/schema/sugar.js +9 -12
  134. package/dist/schema/syncDeltaRow.d.ts +4 -152
  135. package/dist/schema/syncDeltaRow.js +4 -105
  136. package/dist/server/adapter.d.ts +18 -1
  137. package/dist/server/commit.d.ts +10 -16
  138. package/dist/server/index.d.ts +1 -1
  139. package/dist/server/index.js +1 -1
  140. package/dist/server/readConfig.d.ts +1 -1
  141. package/dist/source/adapters/drizzle.d.ts +1 -1
  142. package/dist/source/adapters/drizzle.js +2 -2
  143. package/dist/source/adapters/kysely.d.ts +1 -1
  144. package/dist/source/adapters/kysely.js +1 -1
  145. package/dist/source/adapters/kyselyMutationCore.d.ts +1 -1
  146. package/dist/source/adapters/kyselyMutationCore.js +2 -2
  147. package/dist/source/adapters/memory.js +1 -1
  148. package/dist/source/adapters/prisma.d.ts +8 -3
  149. package/dist/source/adapters/prisma.js +1 -1
  150. package/dist/source/connector.js +1 -1
  151. package/dist/source/connectorProtocol.d.ts +2 -8
  152. package/dist/source/connectorProtocol.js +3 -2
  153. package/dist/source/contract.d.ts +29 -17
  154. package/dist/source/contract.js +27 -22
  155. package/dist/source/factory.d.ts +1 -1
  156. package/dist/source/footprint.d.ts +111 -0
  157. package/dist/source/footprint.js +0 -0
  158. package/dist/source/idempotency.js +2 -2
  159. package/dist/source/index.d.ts +1 -0
  160. package/dist/source/index.js +3 -0
  161. package/dist/source/next.d.ts +1 -1
  162. package/dist/source/signing.d.ts +9 -2
  163. package/dist/source/signing.js +4 -1
  164. package/dist/source/types.d.ts +6 -4
  165. package/dist/source/types.js +1 -1
  166. package/dist/stores/ObjectStore.d.ts +1 -1
  167. package/dist/stores/SyncActionStore.d.ts +1 -1
  168. package/dist/stores/SyncActionStore.js +2 -10
  169. package/dist/stores/syncAction.d.ts +26 -0
  170. package/dist/stores/syncAction.js +16 -0
  171. package/dist/surface.d.ts +3 -3
  172. package/dist/surface.js +6 -4
  173. package/dist/sync/BootstrapFetcher.d.ts +123 -6
  174. package/dist/sync/BootstrapFetcher.js +492 -66
  175. package/dist/sync/ConnectionManager.d.ts +6 -198
  176. package/dist/sync/ConnectionManager.js +6 -677
  177. package/dist/sync/OnDemandLoader.d.ts +2 -2
  178. package/dist/sync/OnDemandLoader.js +60 -21
  179. package/dist/sync/SubscriptionManager.d.ts +13 -2
  180. package/dist/sync/SubscriptionManager.js +23 -5
  181. package/dist/sync/SyncWebSocket.d.ts +27 -510
  182. package/dist/sync/SyncWebSocket.js +76 -954
  183. package/dist/sync/awaitClaimGrant.d.ts +4 -44
  184. package/dist/sync/awaitClaimGrant.js +4 -109
  185. package/dist/sync/commitFrames.d.ts +6 -40
  186. package/dist/sync/commitFrames.js +6 -97
  187. package/dist/sync/contextPorts.d.ts +18 -0
  188. package/dist/sync/contextPorts.js +31 -0
  189. package/dist/sync/createClaimStream.d.ts +5 -49
  190. package/dist/sync/createClaimStream.js +5 -469
  191. package/dist/sync/createPresenceStream.d.ts +26 -4
  192. package/dist/sync/createPresenceStream.js +28 -20
  193. package/dist/sync/createSnapshot.d.ts +2 -2
  194. package/dist/sync/createSnapshot.js +1 -1
  195. package/dist/sync/credentialLifecycle.d.ts +5 -173
  196. package/dist/sync/credentialLifecycle.js +5 -320
  197. package/dist/sync/deltaPipeline.d.ts +1 -1
  198. package/dist/sync/participants.d.ts +5 -4
  199. package/dist/sync/participants.js +29 -22
  200. package/dist/sync/schemaDrift.d.ts +55 -0
  201. package/dist/sync/schemaDrift.js +53 -0
  202. package/dist/sync/schemas.d.ts +21 -32
  203. package/dist/sync/schemas.js +26 -17
  204. package/dist/sync/syncPlan.d.ts +3 -3
  205. package/dist/sync/wsFrameHandlers.d.ts +6 -114
  206. package/dist/sync/wsFrameHandlers.js +6 -392
  207. package/dist/testing/fixtures/bootstrap.d.ts +1 -1
  208. package/dist/testing/fixtures/deltas.d.ts +1 -1
  209. package/dist/testing/fixtures/httpResponses.d.ts +70 -0
  210. package/dist/testing/fixtures/httpResponses.js +90 -0
  211. package/dist/testing/fixtures/models.js +1 -1
  212. package/dist/testing/helpers/wait.js +1 -1
  213. package/dist/testing/mocks/MockMutationExecutor.d.ts +2 -2
  214. package/dist/testing/mocks/MockMutationExecutor.js +8 -14
  215. package/dist/testing/mocks/MockSyncContext.d.ts +11 -11
  216. package/dist/testing/mocks/MockSyncContext.js +10 -9
  217. package/dist/testing/mocks/MockSyncStore.js +1 -1
  218. package/dist/testing/mocks/MockWebSocket.d.ts +2 -2
  219. package/dist/transaction/ablo.d.ts +88 -0
  220. package/dist/transaction/ablo.js +33 -0
  221. package/dist/{client/auth.d.ts → transaction/auth/apiKey.d.ts} +43 -8
  222. package/dist/{client/auth.js → transaction/auth/apiKey.js} +19 -0
  223. package/dist/transaction/auth/bootstrapScope.d.ts +15 -0
  224. package/dist/transaction/auth/bootstrapScope.js +1 -0
  225. package/dist/transaction/auth/capability.d.ts +177 -0
  226. package/dist/transaction/auth/capability.js +199 -0
  227. package/dist/{auth → transaction/auth}/credentialSource.d.ts +8 -1
  228. package/dist/{client → transaction/auth}/identity.d.ts +8 -7
  229. package/dist/{client → transaction/auth}/identity.js +1 -1
  230. package/dist/transaction/auth/index.d.ts +162 -0
  231. package/dist/transaction/auth/index.js +304 -0
  232. package/dist/{auth → transaction/auth}/schemas.d.ts +1 -1
  233. package/dist/{auth → transaction/auth}/schemas.js +13 -13
  234. package/dist/{client → transaction/auth}/sessionMint.d.ts +8 -8
  235. package/dist/{client → transaction/auth}/sessionMint.js +4 -7
  236. package/dist/transaction/coordination/awaitClaimGrant.d.ts +49 -0
  237. package/dist/transaction/coordination/awaitClaimGrant.js +112 -0
  238. package/dist/transaction/coordination/claimMeta.d.ts +49 -0
  239. package/dist/transaction/coordination/claimMeta.js +52 -0
  240. package/dist/transaction/coordination/createClaimStream.d.ts +64 -0
  241. package/dist/transaction/coordination/createClaimStream.js +475 -0
  242. package/dist/transaction/coordination/events.d.ts +74 -0
  243. package/dist/transaction/coordination/events.js +7 -0
  244. package/dist/transaction/coordination/index.d.ts +19 -0
  245. package/dist/transaction/coordination/index.js +44 -0
  246. package/dist/transaction/coordination/locator.d.ts +83 -0
  247. package/dist/transaction/coordination/locator.js +82 -0
  248. package/dist/transaction/coordination/schema.d.ts +1473 -0
  249. package/dist/{coordination → transaction/coordination}/schema.js +490 -55
  250. package/dist/transaction/coordination/targetConflict.d.ts +2 -0
  251. package/dist/transaction/coordination/targetConflict.js +103 -0
  252. package/dist/{coordination → transaction/coordination}/trace.d.ts +7 -18
  253. package/dist/{coordination → transaction/coordination}/trace.js +18 -25
  254. package/dist/transaction/durableWrites.d.ts +62 -0
  255. package/dist/{client → transaction}/durableWrites.js +28 -3
  256. package/dist/transaction/environment.d.ts +105 -0
  257. package/dist/transaction/environment.js +108 -0
  258. package/dist/{errorCodes.d.ts → transaction/errorCodes.d.ts} +11 -11
  259. package/dist/{errorCodes.js → transaction/errorCodes.js} +35 -12
  260. package/dist/{errors.d.ts → transaction/errors.d.ts} +37 -13
  261. package/dist/{errors.js → transaction/errors.js} +85 -16
  262. package/dist/transaction/index.d.ts +20 -0
  263. package/dist/transaction/index.js +20 -0
  264. package/dist/transaction/keys/index.d.ts +87 -0
  265. package/dist/transaction/keys/index.js +207 -0
  266. package/dist/transaction/log/syncDeltaRow.d.ts +158 -0
  267. package/dist/transaction/log/syncDeltaRow.js +95 -0
  268. package/dist/{sync/syncPosition.d.ts → transaction/logPosition.d.ts} +22 -8
  269. package/dist/{sync/syncPosition.js → transaction/logPosition.js} +15 -6
  270. package/dist/transaction/logger.d.ts +16 -0
  271. package/dist/transaction/logger.js +7 -0
  272. package/dist/transaction/observability.d.ts +53 -0
  273. package/dist/transaction/observability.js +19 -0
  274. package/dist/transaction/plugin.d.ts +192 -0
  275. package/dist/transaction/plugin.js +87 -0
  276. package/dist/{policy → transaction/policy}/types.d.ts +3 -3
  277. package/dist/{policy → transaction/policy}/types.js +2 -0
  278. package/dist/transaction/resources/httpResources.d.ts +266 -0
  279. package/dist/transaction/resources/httpResources.js +7 -0
  280. package/dist/transaction/resources/modelOperations.d.ts +319 -0
  281. package/dist/transaction/resources/modelOperations.js +12 -0
  282. package/dist/transaction/resources/mutationOptions.d.ts +66 -0
  283. package/dist/transaction/resources/mutationOptions.js +9 -0
  284. package/dist/transaction/resources/where.d.ts +85 -0
  285. package/dist/transaction/resources/where.js +70 -0
  286. package/dist/{client → transaction/resources}/writeOptionsSchema.d.ts +2 -6
  287. package/dist/{client → transaction/resources}/writeOptionsSchema.js +9 -5
  288. package/dist/{schema → transaction/schema}/field.d.ts +5 -5
  289. package/dist/{schema → transaction/schema}/field.js +5 -5
  290. package/dist/transaction/schema/loadStrategy.d.ts +45 -0
  291. package/dist/transaction/schema/loadStrategy.js +46 -0
  292. package/dist/{schema → transaction/schema}/model.d.ts +50 -35
  293. package/dist/{schema → transaction/schema}/model.js +30 -20
  294. package/dist/transaction/schema/openapi.d.ts +57 -0
  295. package/dist/transaction/schema/openapi.js +340 -0
  296. package/dist/{schema → transaction/schema}/relation.d.ts +14 -14
  297. package/dist/{schema → transaction/schema}/relation.js +7 -7
  298. package/dist/{schema → transaction/schema}/residency.d.ts +0 -9
  299. package/dist/{schema → transaction/schema}/residency.js +0 -5
  300. package/dist/{schema → transaction/schema}/roles.d.ts +5 -5
  301. package/dist/{schema → transaction/schema}/roles.js +5 -5
  302. package/dist/{schema → transaction/schema}/schema.d.ts +12 -10
  303. package/dist/{schema → transaction/schema}/schema.js +4 -3
  304. package/dist/{schema → transaction/schema}/tenancy.d.ts +1 -1
  305. package/dist/{schema → transaction/schema}/tenancy.js +7 -4
  306. package/dist/transaction/transactionLayer.d.ts +82 -0
  307. package/dist/transaction/transactionLayer.js +24 -0
  308. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.d.ts +4 -5
  309. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.js +9 -13
  310. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.d.ts +9 -2
  311. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.js +5 -9
  312. package/dist/{transactions/durableWriteStore.d.ts → transaction/transactions/settlement/pendingWrite.d.ts} +10 -36
  313. package/dist/transaction/transactions/settlement/pendingWrite.js +20 -0
  314. package/dist/transaction/transport/commitFrames.d.ts +90 -0
  315. package/dist/transaction/transport/commitFrames.js +134 -0
  316. package/dist/transaction/transport/connectionManager.d.ts +215 -0
  317. package/dist/transaction/transport/connectionManager.js +673 -0
  318. package/dist/transaction/transport/credentialLifecycle.d.ts +177 -0
  319. package/dist/transaction/transport/credentialLifecycle.js +324 -0
  320. package/dist/{sync → transaction/transport}/heartbeat.d.ts +3 -1
  321. package/dist/{sync → transaction/transport}/heartbeat.js +6 -4
  322. package/dist/{client → transaction/transport}/httpClient.d.ts +59 -16
  323. package/dist/{client → transaction/transport}/httpClient.js +5 -5
  324. package/dist/transaction/transport/httpOptions.d.ts +33 -0
  325. package/dist/transaction/transport/httpOptions.js +12 -0
  326. package/dist/{client → transaction/transport}/httpTransport.js +171 -85
  327. package/dist/{sync/NetworkProbe.d.ts → transaction/transport/networkProbe.d.ts} +7 -4
  328. package/dist/{sync/NetworkProbe.js → transaction/transport/networkProbe.js} +14 -13
  329. package/dist/transaction/transport/wsFrameHandlers.d.ts +128 -0
  330. package/dist/transaction/transport/wsFrameHandlers.js +429 -0
  331. package/dist/transaction/transport/wsTransport.d.ts +576 -0
  332. package/dist/transaction/transport/wsTransport.js +1017 -0
  333. package/dist/transaction/types/assertExact.d.ts +17 -0
  334. package/dist/transaction/types/assertExact.js +1 -0
  335. package/dist/{types → transaction/types}/global.d.ts +17 -2
  336. package/dist/{types → transaction/types}/global.js +2 -1
  337. package/dist/{types → transaction/types}/index.d.ts +14 -46
  338. package/dist/{types → transaction/types}/index.js +7 -16
  339. package/dist/{types → transaction/types}/streams.d.ts +63 -45
  340. package/dist/{utils → transaction/utils}/json.d.ts +18 -0
  341. package/dist/transaction/utils/json.js +276 -0
  342. package/dist/transaction/wire/accountResponses.d.ts +351 -0
  343. package/dist/transaction/wire/accountResponses.js +255 -0
  344. package/dist/transaction/wire/auth.d.ts +49 -0
  345. package/dist/transaction/wire/auth.js +57 -0
  346. package/dist/transaction/wire/claimEvent.d.ts +76 -0
  347. package/dist/transaction/wire/claimEvent.js +73 -0
  348. package/dist/transaction/wire/claims.d.ts +463 -0
  349. package/dist/transaction/wire/claims.js +229 -0
  350. package/dist/{wire → transaction/wire}/commit.d.ts +125 -193
  351. package/dist/{wire → transaction/wire}/commit.js +68 -47
  352. package/dist/{wire → transaction/wire}/delta.d.ts +66 -17
  353. package/dist/{wire → transaction/wire}/delta.js +37 -13
  354. package/dist/transaction/wire/errorEnvelope.d.ts +72 -0
  355. package/dist/{wire → transaction/wire}/errorEnvelope.js +36 -5
  356. package/dist/transaction/wire/feedCursor.d.ts +60 -0
  357. package/dist/transaction/wire/feedCursor.js +82 -0
  358. package/dist/transaction/wire/feedEvent.d.ts +177 -0
  359. package/dist/transaction/wire/feedEvent.js +39 -0
  360. package/dist/transaction/wire/frames.d.ts +194 -0
  361. package/dist/transaction/wire/frames.js +50 -0
  362. package/dist/transaction/wire/inboundFrames.d.ts +552 -0
  363. package/dist/transaction/wire/inboundFrames.js +116 -0
  364. package/dist/transaction/wire/index.d.ts +50 -0
  365. package/dist/transaction/wire/index.js +74 -0
  366. package/dist/{wire → transaction/wire}/listEnvelope.d.ts +13 -14
  367. package/dist/transaction/wire/listEnvelope.js +42 -0
  368. package/dist/transaction/wire/modelResponses.d.ts +85 -0
  369. package/dist/transaction/wire/modelResponses.js +43 -0
  370. package/dist/transactions/{TransactionQueue.d.ts → mutations/MutationQueue.d.ts} +79 -38
  371. package/dist/transactions/{TransactionQueue.js → mutations/MutationQueue.js} +110 -59
  372. package/dist/transactions/{TransactionStore.d.ts → mutations/MutationStore.d.ts} +8 -8
  373. package/dist/transactions/{TransactionStore.js → mutations/MutationStore.js} +2 -2
  374. package/dist/transactions/{coalesceRules.d.ts → mutations/coalesceRules.d.ts} +10 -10
  375. package/dist/transactions/{coalesceRules.js → mutations/coalesceRules.js} +1 -1
  376. package/dist/transactions/mutations/commitLatency.d.ts +52 -0
  377. package/dist/transactions/mutations/commitLatency.js +130 -0
  378. package/dist/transactions/{commitOutboxStore.d.ts → mutations/commitOutboxStore.d.ts} +1 -5
  379. package/dist/transactions/{commitOutboxStore.js → mutations/commitOutboxStore.js} +1 -1
  380. package/dist/transactions/{commitPayload.d.ts → mutations/commitPayload.d.ts} +16 -15
  381. package/dist/transactions/{commitPayload.js → mutations/commitPayload.js} +12 -12
  382. package/dist/transactions/{deltaConfirmation.d.ts → mutations/deltaConfirmation.d.ts} +11 -11
  383. package/dist/transactions/{deltaConfirmation.js → mutations/deltaConfirmation.js} +7 -7
  384. package/dist/transactions/mutations/durableWriteStore.d.ts +14 -0
  385. package/dist/transactions/mutations/durableWriteStore.js +12 -0
  386. package/dist/transactions/{optimisticApply.d.ts → mutations/optimisticApply.d.ts} +7 -7
  387. package/dist/transactions/{replayValidation.d.ts → mutations/replayValidation.d.ts} +3 -3
  388. package/dist/transactions/{replayValidation.js → mutations/replayValidation.js} +4 -3
  389. package/dist/utils/mobxSetup.d.ts +1 -1
  390. package/dist/utils/mobxSetup.js +5 -2
  391. package/dist/webhooks/events.d.ts +2 -2
  392. package/dist/wire/index.d.ts +1 -34
  393. package/dist/wire/index.js +8 -49
  394. package/docs/agent-messaging.md +3 -3
  395. package/docs/agents.md +19 -12
  396. package/docs/api-keys.md +8 -4
  397. package/docs/api.md +22 -18
  398. package/docs/audit.md +2 -0
  399. package/docs/cli.md +31 -3
  400. package/docs/client-behavior.md +8 -6
  401. package/docs/concurrency-convention.md +30 -24
  402. package/docs/coordination.md +48 -38
  403. package/docs/data-sources.md +3 -1
  404. package/docs/debugging.md +5 -3
  405. package/docs/deployment.md +267 -0
  406. package/docs/examples/agent-human.md +49 -42
  407. package/docs/examples/ai-sdk-tool.md +69 -44
  408. package/docs/examples/existing-python-backend.md +8 -6
  409. package/docs/examples/nextjs.md +129 -47
  410. package/docs/examples/scoped-agent.md +45 -44
  411. package/docs/examples/server-agent.md +46 -26
  412. package/docs/groups.md +32 -29
  413. package/docs/guarantees.md +4 -2
  414. package/docs/how-it-works.md +9 -7
  415. package/docs/idempotency.md +126 -0
  416. package/docs/identity.md +58 -54
  417. package/docs/index.md +172 -84
  418. package/docs/integration-guide.md +17 -16
  419. package/docs/interaction-model.md +6 -4
  420. package/docs/mcp.md +41 -16
  421. package/docs/migration.md +63 -5
  422. package/docs/operating-on-your-database.md +111 -0
  423. package/docs/projects.md +2 -0
  424. package/docs/quickstart.md +22 -5
  425. package/docs/react.md +12 -10
  426. package/docs/schema-contract.md +5 -3
  427. package/docs/session-settings.md +108 -0
  428. package/docs/sessions.md +3 -1
  429. package/docs/webhooks.md +3 -1
  430. package/llms.txt +47 -17
  431. package/package.json +10 -8
  432. package/dist/agent/Agent.d.ts +0 -366
  433. package/dist/agent/Agent.js +0 -514
  434. package/dist/agent/index.d.ts +0 -115
  435. package/dist/agent/index.js +0 -128
  436. package/dist/agent/session.d.ts +0 -93
  437. package/dist/agent/session.js +0 -149
  438. package/dist/agent/types.d.ts +0 -68
  439. package/dist/agent/types.js +0 -9
  440. package/dist/client/durableWrites.d.ts +0 -21
  441. package/dist/coordination/schema.d.ts +0 -722
  442. package/dist/schema/openapi.d.ts +0 -29
  443. package/dist/schema/openapi.js +0 -124
  444. package/dist/transactions/durableWriteStore.js +0 -30
  445. package/dist/utils/json.js +0 -88
  446. package/dist/wire/errorEnvelope.d.ts +0 -55
  447. package/dist/wire/frames.d.ts +0 -197
  448. package/dist/wire/frames.js +0 -49
  449. package/dist/wire/listEnvelope.js +0 -18
  450. /package/dist/{client → transaction/auth}/credentialEndpoint.d.ts +0 -0
  451. /package/dist/{client → transaction/auth}/credentialEndpoint.js +0 -0
  452. /package/dist/{auth → transaction/auth}/credentialPolicy.d.ts +0 -0
  453. /package/dist/{auth → transaction/auth}/credentialPolicy.js +0 -0
  454. /package/dist/{auth → transaction/auth}/credentialSource.js +0 -0
  455. /package/dist/{client → transaction/auth}/hostedEndpoints.d.ts +0 -0
  456. /package/dist/{client → transaction/auth}/hostedEndpoints.js +0 -0
  457. /package/dist/{client → transaction/coordination}/claimHeartbeatLoop.d.ts +0 -0
  458. /package/dist/{client → transaction/coordination}/claimHeartbeatLoop.js +0 -0
  459. /package/dist/{client → transaction}/persistence.d.ts +0 -0
  460. /package/dist/{client → transaction}/persistence.js +0 -0
  461. /package/dist/{client → transaction/resources}/functionalUpdate.d.ts +0 -0
  462. /package/dist/{client → transaction/resources}/functionalUpdate.js +0 -0
  463. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.d.ts +0 -0
  464. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.js +0 -0
  465. /package/dist/{client → transaction/transport}/httpTransport.d.ts +0 -0
  466. /package/dist/{types → transaction/types}/modelData.d.ts +0 -0
  467. /package/dist/{types → transaction/types}/modelData.js +0 -0
  468. /package/dist/{types → transaction/types}/participant.d.ts +0 -0
  469. /package/dist/{types → transaction/types}/participant.js +0 -0
  470. /package/dist/{types → transaction/types}/streams.js +0 -0
  471. /package/dist/{utils → transaction/utils}/asyncIterator.d.ts +0 -0
  472. /package/dist/{utils → transaction/utils}/asyncIterator.js +0 -0
  473. /package/dist/{utils → transaction/utils}/duration.d.ts +0 -0
  474. /package/dist/{utils → transaction/utils}/duration.js +0 -0
  475. /package/dist/{wire → transaction/wire}/bootstrapReason.d.ts +0 -0
  476. /package/dist/{wire → transaction/wire}/bootstrapReason.js +0 -0
  477. /package/dist/{wire → transaction/wire}/protocol.d.ts +0 -0
  478. /package/dist/{wire → transaction/wire}/protocol.js +0 -0
  479. /package/dist/{wire → transaction/wire}/protocolVersion.d.ts +0 -0
  480. /package/dist/{wire → transaction/wire}/protocolVersion.js +0 -0
  481. /package/dist/transactions/{UnconfirmedWrites.d.ts → mutations/UnconfirmedWrites.d.ts} +0 -0
  482. /package/dist/transactions/{UnconfirmedWrites.js → mutations/UnconfirmedWrites.js} +0 -0
  483. /package/dist/transactions/{optimisticApply.js → mutations/optimisticApply.js} +0 -0
@@ -0,0 +1,130 @@
1
+ /**
2
+ * Commit latency — how long a user's edit actually takes to land.
3
+ *
4
+ * The engine has never measured this. HUDs and dashboards reach for
5
+ * `window.fetch` timings, which the sync engine's WebSocket never touches, so
6
+ * the latency a user sees reported while editing has had nothing to do with
7
+ * the writes they are making. This module closes that gap without adding a
8
+ * single timestamp to the hot path: `MutationQueue` already emits the commit
9
+ * lifecycle, and the events already carry the correlation key.
10
+ *
11
+ * Three events, two intervals:
12
+ *
13
+ * commit:staging ──sealMs──▶ commit:created ──ackMs──▶ transaction:completed
14
+ *
15
+ * - `sealMs` is **local** — writing the durable envelope before the commit is
16
+ * allowed onto the wire. Slow here means storage (IndexedDB), not network.
17
+ * - `ackMs` is **remote** — dispatch, round-trip, and server work. For a
18
+ * commit routed at a connected source this also spans the wait for the
19
+ * correlated echo that promotes `queued` to `confirmed`, so it answers
20
+ * "when did my edit become real" rather than raw socket round-trip. Read a
21
+ * large `ackMs` against a small `sealMs` as a network or replication cost.
22
+ *
23
+ * Correlation is by `clientTxId`: `MutationQueue` uses it as the transaction
24
+ * id verbatim, so the staging event and the completion event share one key.
25
+ */
26
+ /**
27
+ * Cap on commits awaiting completion. A commit whose completion never arrives
28
+ * (connection dropped mid-flight, retry abandoned) would otherwise pin its
29
+ * entry forever, so the map is bounded rather than trusted to drain.
30
+ */
31
+ const MAX_PENDING_COMMITS = 256;
32
+ function nowMs() {
33
+ return typeof performance !== 'undefined' ? performance.now() : Date.now();
34
+ }
35
+ /** Read `clientTxId` off a `commit:*` payload, or null if it isn't shaped so. */
36
+ function readClientTxId(payload) {
37
+ if (typeof payload !== 'object' || payload === null)
38
+ return null;
39
+ const { clientTxId } = payload;
40
+ return typeof clientTxId === 'string' ? clientTxId : null;
41
+ }
42
+ /** Read `id` off a transaction payload (`transaction:completed` sends the tx). */
43
+ function readTransactionId(payload) {
44
+ if (typeof payload !== 'object' || payload === null)
45
+ return null;
46
+ const { id } = payload;
47
+ return typeof id === 'string' ? id : null;
48
+ }
49
+ /** `transaction:failed` wraps the transaction rather than sending it bare. */
50
+ function readFailedTransactionId(payload) {
51
+ if (typeof payload !== 'object' || payload === null)
52
+ return null;
53
+ return readTransactionId(payload.transaction);
54
+ }
55
+ /**
56
+ * Pair commit lifecycle events into latency samples. Returns an unsubscribe
57
+ * function that also drops any still-pending timings.
58
+ *
59
+ * `onSample` fires once per commit that completes, in completion order.
60
+ */
61
+ export function observeCommitLatency(source, onSample) {
62
+ const pending = new Map();
63
+ const handleStaging = (payload) => {
64
+ const id = readClientTxId(payload);
65
+ if (id === null)
66
+ return;
67
+ // Map preserves insertion order, so the first key is the stalest entry.
68
+ if (pending.size >= MAX_PENDING_COMMITS) {
69
+ const oldest = pending.keys().next();
70
+ if (!oldest.done)
71
+ pending.delete(oldest.value);
72
+ }
73
+ pending.set(id, { stagedAt: nowMs(), sealedAt: null });
74
+ };
75
+ const handleCreated = (payload) => {
76
+ const id = readClientTxId(payload);
77
+ if (id === null)
78
+ return;
79
+ const timing = pending.get(id);
80
+ if (timing === undefined)
81
+ return;
82
+ timing.sealedAt = nowMs();
83
+ };
84
+ const handleCompleted = (payload) => {
85
+ const id = readTransactionId(payload);
86
+ if (id === null)
87
+ return;
88
+ const timing = pending.get(id);
89
+ // `transaction:completed` also fires for local (non-commit) transactions
90
+ // and for mutation-log replay. Only ids we staged are commits, so an
91
+ // absent entry is the normal way those are filtered out.
92
+ if (timing === undefined)
93
+ return;
94
+ pending.delete(id);
95
+ const completedAt = nowMs();
96
+ // A commit can complete without an observed seal only if the listener was
97
+ // attached mid-flight; attributing the whole span to `ackMs` keeps
98
+ // `sealMs + ackMs === totalMs` true rather than reporting a bogus seal.
99
+ const sealedAt = timing.sealedAt ?? timing.stagedAt;
100
+ onSample({
101
+ clientTxId: id,
102
+ sealMs: sealedAt - timing.stagedAt,
103
+ ackMs: completedAt - sealedAt,
104
+ totalMs: completedAt - timing.stagedAt,
105
+ });
106
+ };
107
+ const handleSealFailed = (payload) => {
108
+ const id = readClientTxId(payload);
109
+ if (id !== null)
110
+ pending.delete(id);
111
+ };
112
+ const handleFailed = (payload) => {
113
+ const id = readFailedTransactionId(payload);
114
+ if (id !== null)
115
+ pending.delete(id);
116
+ };
117
+ source.on('commit:staging', handleStaging);
118
+ source.on('commit:created', handleCreated);
119
+ source.on('commit:seal_failed', handleSealFailed);
120
+ source.on('transaction:completed', handleCompleted);
121
+ source.on('transaction:failed', handleFailed);
122
+ return () => {
123
+ source.off('commit:staging', handleStaging);
124
+ source.off('commit:created', handleCreated);
125
+ source.off('commit:seal_failed', handleSealFailed);
126
+ source.off('transaction:completed', handleCompleted);
127
+ source.off('transaction:failed', handleFailed);
128
+ pending.clear();
129
+ };
130
+ }
@@ -3,13 +3,9 @@
3
3
  *
4
4
  * Browser clients use {@link DatabaseCommitOutboxStore}. Agent/Node hosts can
5
5
  * inject a workflow-, SQLite-, or filesystem-backed implementation without
6
- * coupling TransactionQueue to the browser database/cache implementation.
6
+ * coupling MutationQueue to the browser database/cache implementation.
7
7
  */
8
8
  import type { DurableWriteStore, PendingWrite } from './durableWriteStore.js';
9
- /** @deprecated Use {@link PendingWrite}. */
10
- export type CommitOutboxRecord = PendingWrite;
11
- /** @deprecated Use {@link DurableWriteStore}. */
12
- export type CommitOutboxStore = DurableWriteStore;
13
9
  /**
14
10
  * The exact subset of the browser `Database` that {@link DatabaseCommitOutboxStore}
15
11
  * drives. Typing the adapter to this narrow port instead of importing the
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Browser clients use {@link DatabaseCommitOutboxStore}. Agent/Node hosts can
5
5
  * inject a workflow-, SQLite-, or filesystem-backed implementation without
6
- * coupling TransactionQueue to the browser database/cache implementation.
6
+ * coupling MutationQueue to the browser database/cache implementation.
7
7
  */
8
8
  /** Strict IndexedDB adapter backed by Database's `__transactions` store. */
9
9
  export class DatabaseCommitOutboxStore {
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * The vocabulary a local transaction uses on the wire. This module defines the
3
- * {@link Transaction} record and the helpers that turn a transaction into a
3
+ * {@link QueuedMutation} record and the helpers that turn a transaction into a
4
4
  * wire-safe commit operation: schema-field projection
5
5
  * ({@link projectCommitPayload}), write-option projection
6
6
  * ({@link applyWriteOptions}), foreign-key-aware priority scoring
@@ -8,9 +8,10 @@
8
8
  * transport errors. Nothing here holds queue state or timers, so the batched
9
9
  * queue path and the HTTP commit path share the same projection.
10
10
  */
11
- import { MutationOperationType } from '../types/index.js';
12
- import type { MutationOptions, WriteOptions } from '../interfaces/index.js';
13
- import type { CommitEnvelopeMember } from './commitEnvelope.js';
11
+ import { MutationOperationType } from '../../transaction/types/index.js';
12
+ import type { OnStaleMode } from '../../transaction/coordination/schema.js';
13
+ import type { MutationOptions, WriteOptions } from '../../interfaces/index.js';
14
+ import type { CommitEnvelopeMember } from '../../transaction/transactions/settlement/commitEnvelope.js';
14
15
  export interface UserContext {
15
16
  userId: string;
16
17
  organizationId: string;
@@ -25,22 +26,22 @@ export type MutationInput = Record<string, unknown>;
25
26
  *
26
27
  * 1. Drops framework-internal keys (`__class`, `__typename`, `clientId`,
27
28
  * `syncStatus`) and anything not declared on the model's schema.
28
- * 2. Passes each declared field's value through unchanged, including
29
- * JSON-typed fields, which are sent as objects rather than pre-serialized
30
- * strings (see the note in the body for why).
29
+ * 2. Takes a fresh plain JSON snapshot of the projected values. JSON-typed
30
+ * fields stay objects rather than pre-serialized strings, while reactive
31
+ * proxies cannot leak into persistence or the wire payload.
31
32
  *
32
33
  * For updates (`dropUndefined: true`), `undefined` values are also removed so
33
34
  * they are not written as `SET column = NULL` on the server.
34
35
  *
35
36
  * Field metadata comes from the model registry, populated when the schema is
36
37
  * registered at initialization. If a model has no registered field metadata —
37
- * for example a manually registered model — projection passes the serialized
38
- * data through unchanged apart from dropping the framework keys.
38
+ * for example a manually registered model — projection snapshots all serialized
39
+ * data apart from the framework keys.
39
40
  */
40
41
  export declare function projectCommitPayload(modelName: string, source: Record<string, unknown>, opts: {
41
42
  dropUndefined: boolean;
42
43
  }): MutationInput;
43
- export interface Transaction {
44
+ export interface QueuedMutation {
44
45
  id: string;
45
46
  type: 'create' | 'update' | 'delete' | 'archive' | 'unarchive';
46
47
  modelName: string;
@@ -95,7 +96,7 @@ export interface Transaction {
95
96
  * recovers. This gives a caller one place to await the answer to "did my write
96
97
  * land?", matching the
97
98
  * `commits.create({ wait: 'confirmed' })` and
98
- * {@link TransactionQueue.waitForConfirmation} vocabulary, so a failure
99
+ * {@link MutationQueue.waitForConfirmation} vocabulary, so a failure
99
100
  * surfaces at the call site instead of only as a silent local rollback. The
100
101
  * permanent-rejection value is the same {@link AbloError} carried on the
101
102
  * queue's `transaction:failed` event.
@@ -117,14 +118,14 @@ export declare const stripModelSuffix: (modelName: string) => string;
117
118
  * foreign-key ordering because the row already exists, so they all share the
118
119
  * configured default non-create priority.
119
120
  */
120
- export declare const computePriorityScore: (type: Transaction["type"], modelName: string) => number;
121
- export declare const TX_TYPE_TO_MUTATION_OP: Record<Transaction['type'], MutationOperationType>;
121
+ export declare const computePriorityScore: (type: QueuedMutation["type"], modelName: string) => number;
122
+ export declare const TX_TYPE_TO_MUTATION_OP: Record<QueuedMutation['type'], MutationOperationType>;
122
123
  export declare function hasStaleWriteOptions(options?: WriteOptions): boolean;
123
124
  /** Options whose identity/audit semantics forbid merging two caller writes. */
124
125
  export declare function hasCommitCoalescingBarrier(options?: WriteOptions): boolean;
125
126
  export interface WriteOperationFields {
126
127
  readAt?: number | null;
127
- onStale?: 'reject' | 'overwrite' | 'notify' | null;
128
+ onStale?: OnStaleMode | null;
128
129
  fenceToken?: number | null;
129
130
  options?: Pick<MutationOptions, 'idempotencyKey' | 'label'>;
130
131
  }
@@ -135,7 +136,7 @@ export interface WriteOperationFields {
135
136
  * `mutation_log` cache key and audit tag. This is the one place caller-supplied
136
137
  * write options cross onto the wire.
137
138
  */
138
- export declare function applyWriteOptions<T extends object>(op: T, transaction: Transaction): T & WriteOperationFields;
139
+ export declare function applyWriteOptions<T extends object>(op: T, transaction: QueuedMutation): T & WriteOperationFields;
139
140
  /**
140
141
  * The structural shape used to inspect transport-layer errors. It covers the
141
142
  * GraphQL-style and HTTP-style error shapes the mutation executor can surface,
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * The vocabulary a local transaction uses on the wire. This module defines the
3
- * {@link Transaction} record and the helpers that turn a transaction into a
3
+ * {@link QueuedMutation} record and the helpers that turn a transaction into a
4
4
  * wire-safe commit operation: schema-field projection
5
5
  * ({@link projectCommitPayload}), write-option projection
6
6
  * ({@link applyWriteOptions}), foreign-key-aware priority scoring
@@ -8,9 +8,9 @@
8
8
  * transport errors. Nothing here holds queue state or timers, so the batched
9
9
  * queue path and the HTTP commit path share the same projection.
10
10
  */
11
- import { getContext } from '../context.js';
12
- import { getActiveRegistry } from '../ModelRegistry.js';
13
- import { MutationOperationType } from '../types/index.js';
11
+ import { getContext } from '../../context.js';
12
+ import { MutationOperationType } from '../../transaction/types/index.js';
13
+ import { snapshotJsonValue } from '../../transaction/utils/json.js';
14
14
  /**
15
15
  * Framework-internal keys added by `Model.toJSON()` that must never
16
16
  * reach the wire. The server treats each top-level key as a target
@@ -23,20 +23,20 @@ const FRAMEWORK_KEYS = new Set(['__class', '__typename', 'clientId', 'syncStatus
23
23
  *
24
24
  * 1. Drops framework-internal keys (`__class`, `__typename`, `clientId`,
25
25
  * `syncStatus`) and anything not declared on the model's schema.
26
- * 2. Passes each declared field's value through unchanged, including
27
- * JSON-typed fields, which are sent as objects rather than pre-serialized
28
- * strings (see the note in the body for why).
26
+ * 2. Takes a fresh plain JSON snapshot of the projected values. JSON-typed
27
+ * fields stay objects rather than pre-serialized strings, while reactive
28
+ * proxies cannot leak into persistence or the wire payload.
29
29
  *
30
30
  * For updates (`dropUndefined: true`), `undefined` values are also removed so
31
31
  * they are not written as `SET column = NULL` on the server.
32
32
  *
33
33
  * Field metadata comes from the model registry, populated when the schema is
34
34
  * registered at initialization. If a model has no registered field metadata —
35
- * for example a manually registered model — projection passes the serialized
36
- * data through unchanged apart from dropping the framework keys.
35
+ * for example a manually registered model — projection snapshots all serialized
36
+ * data apart from the framework keys.
37
37
  */
38
38
  export function projectCommitPayload(modelName, source, opts) {
39
- const metadata = getActiveRegistry().getMetadata(modelName);
39
+ const metadata = getContext().getModelMetadata(modelName);
40
40
  const fields = metadata?.fields;
41
41
  const out = {};
42
42
  if (!fields) {
@@ -48,7 +48,7 @@ export function projectCommitPayload(modelName, source, opts) {
48
48
  continue;
49
49
  out[k] = v;
50
50
  }
51
- return out;
51
+ return snapshotJsonValue(out, '$.input');
52
52
  }
53
53
  for (const key of Object.keys(fields)) {
54
54
  if (!(key in source))
@@ -73,7 +73,7 @@ export function projectCommitPayload(modelName, source, opts) {
73
73
  // to jsonb correctly once the column is identified as jsonb.
74
74
  out[key] = value;
75
75
  }
76
- return out;
76
+ return snapshotJsonValue(out, '$.input');
77
77
  }
78
78
  export const normalizeModelKey = (modelName) => modelName.replace('Model', '').toLowerCase();
79
79
  export const stripModelSuffix = (modelName) => modelName.replace('Model', '');
@@ -1,16 +1,16 @@
1
1
  /**
2
2
  * Tracks whether the confirming delta for a write has arrived. It holds the
3
- * acknowledgement watermark (through the shared {@link SyncPosition}), the
3
+ * acknowledgement watermark (through the shared {@link LogPosition}), the
4
4
  * per-transaction confirmation timeouts, and the retry-with-backoff and
5
5
  * reconciliation policy for transactions in the `awaiting_delta` status. It
6
- * reaches back to {@link TransactionQueue} only through the small
6
+ * reaches back to {@link MutationQueue} only through the small
7
7
  * {@link DeltaConfirmationContext} interface, not the queue class itself, so it
8
8
  * has no cyclic dependency and can be tested on its own.
9
9
  */
10
- import type { SyncPosition } from '../sync/syncPosition.js';
11
- import type { Transaction } from './commitPayload.js';
10
+ import type { LogPosition } from '../../transaction/logPosition.js';
11
+ import type { QueuedMutation } from './commitPayload.js';
12
12
  /**
13
- * The subset of {@link TransactionQueue} that the confirmation tracker needs:
13
+ * The subset of {@link MutationQueue} that the confirmation tracker needs:
14
14
  * store lookups and status changes, removing optimistic entries once a write
15
15
  * confirms, the queue's event emitter (`transaction:completed`,
16
16
  * `reconciliation:needed`, and so on), a connection check (so timeouts
@@ -20,16 +20,16 @@ import type { Transaction } from './commitPayload.js';
20
20
  */
21
21
  export interface DeltaConfirmationContext {
22
22
  store: {
23
- get(id: string): Transaction | undefined;
24
- getByStatus(status: Transaction['status']): Transaction[];
25
- updateStatus(id: string, status: Transaction['status']): void;
23
+ get(id: string): QueuedMutation | undefined;
24
+ getByStatus(status: QueuedMutation['status']): QueuedMutation[];
25
+ updateStatus(id: string, status: QueuedMutation['status']): void;
26
26
  };
27
27
  optimisticUpdates: {
28
28
  delete(id: string): boolean;
29
29
  };
30
30
  emit(event: string, payload?: unknown): void;
31
31
  isConnected(): boolean;
32
- position: SyncPosition;
32
+ position: LogPosition;
33
33
  }
34
34
  export declare class DeltaConfirmationTracker {
35
35
  private readonly ctx;
@@ -48,11 +48,11 @@ export declare class DeltaConfirmationTracker {
48
48
  * @param syncId - The sync id of the received delta.
49
49
  */
50
50
  onDeltaReceived(syncId: number, correlationId?: string): void;
51
- scheduleDeltaConfirmationTimeout(tx: Transaction, timeoutMs: number): void;
51
+ scheduleDeltaConfirmationTimeout(tx: QueuedMutation, timeoutMs: number): void;
52
52
  private cancelDeltaConfirmationTimeout;
53
53
  /**
54
54
  * Clears every armed confirmation timer, one per in-flight transaction.
55
- * {@link TransactionQueue.dispose} calls this; without it a disposed queue
55
+ * {@link MutationQueue.dispose} calls this; without it a disposed queue
56
56
  * would keep the process alive and fire callbacks against a cleared store.
57
57
  */
58
58
  dispose(): void;
@@ -1,13 +1,13 @@
1
1
  /**
2
2
  * Tracks whether the confirming delta for a write has arrived. It holds the
3
- * acknowledgement watermark (through the shared {@link SyncPosition}), the
3
+ * acknowledgement watermark (through the shared {@link LogPosition}), the
4
4
  * per-transaction confirmation timeouts, and the retry-with-backoff and
5
5
  * reconciliation policy for transactions in the `awaiting_delta` status. It
6
- * reaches back to {@link TransactionQueue} only through the small
6
+ * reaches back to {@link MutationQueue} only through the small
7
7
  * {@link DeltaConfirmationContext} interface, not the queue class itself, so it
8
8
  * has no cyclic dependency and can be tested on its own.
9
9
  */
10
- import { getContext } from '../context.js';
10
+ import { getContext } from '../../context.js';
11
11
  export class DeltaConfirmationTracker {
12
12
  ctx;
13
13
  // Retry configuration for delta confirmation, using exponential backoff.
@@ -118,7 +118,7 @@ export class DeltaConfirmationTracker {
118
118
  // rejection instead of a catchable synchronous error.
119
119
  const timeoutHandle = setTimeout(() => {
120
120
  const currentTx = this.ctx.store.get(tx.id);
121
- if (!currentTx || currentTx.status !== 'awaiting_delta') {
121
+ if (currentTx?.status !== 'awaiting_delta') {
122
122
  this.deltaConfirmationRetries.delete(tx.id);
123
123
  return; // Already confirmed or failed
124
124
  }
@@ -126,7 +126,7 @@ export class DeltaConfirmationTracker {
126
126
  if (!this.ctx.isConnected()) {
127
127
  // Self-healing: re-schedule the confirmation wait while offline, no
128
128
  // consumer action needed → debug.
129
- getContext().logger.debug('[TransactionQueue] Timeout fired while disconnected - re-scheduling', {
129
+ getContext().logger.debug('[MutationQueue] Timeout fired while disconnected - re-scheduling', {
130
130
  txId: tx.id.slice(0, 8),
131
131
  model: tx.modelName,
132
132
  });
@@ -165,7 +165,7 @@ export class DeltaConfirmationTracker {
165
165
  });
166
166
  // Self-healing retry with backoff — the server already committed; we're
167
167
  // just waiting on the delta. No consumer action → debug.
168
- getContext().logger.debug('[TransactionQueue] Re-scheduling with backoff', {
168
+ getContext().logger.debug('[MutationQueue] Re-scheduling with backoff', {
169
169
  txId: tx.id.slice(0, 8),
170
170
  model: tx.modelName,
171
171
  nextTimeoutMs: nextTimeout,
@@ -220,7 +220,7 @@ export class DeltaConfirmationTracker {
220
220
  }
221
221
  /**
222
222
  * Clears every armed confirmation timer, one per in-flight transaction.
223
- * {@link TransactionQueue.dispose} calls this; without it a disposed queue
223
+ * {@link MutationQueue.dispose} calls this; without it a disposed queue
224
224
  * would keep the process alive and fire callbacks against a cleared store.
225
225
  */
226
226
  dispose() {
@@ -0,0 +1,14 @@
1
+ /**
2
+ * The durable-write port moved to the settlement core (ADR 0016): it is a
3
+ * contract over commit envelopes and holds no local rows. Re-exported here so
4
+ * the existing `transactions/mutations/durableWriteStore` import path keeps
5
+ * resolving for the queue, the outbox, and the client options.
6
+ *
7
+ * The port and its config live in the core's `durableWrites` module (a behavior
8
+ * contract, not a persisted shape); the records that cross it are owned by
9
+ * `transactions/settlement/pendingWrite`.
10
+ */
11
+ export { durableWriteStoreSchema, durableWritesConfigSchema, } from '../../transaction/durableWrites.js';
12
+ export type { DurableWriteStore, DurableWritesConfig, } from '../../transaction/durableWrites.js';
13
+ export { pendingWriteSchema } from '../../transaction/transactions/settlement/pendingWrite.js';
14
+ export type { PendingWrite } from '../../transaction/transactions/settlement/pendingWrite.js';
@@ -0,0 +1,12 @@
1
+ /**
2
+ * The durable-write port moved to the settlement core (ADR 0016): it is a
3
+ * contract over commit envelopes and holds no local rows. Re-exported here so
4
+ * the existing `transactions/mutations/durableWriteStore` import path keeps
5
+ * resolving for the queue, the outbox, and the client options.
6
+ *
7
+ * The port and its config live in the core's `durableWrites` module (a behavior
8
+ * contract, not a persisted shape); the records that cross it are owned by
9
+ * `transactions/settlement/pendingWrite`.
10
+ */
11
+ export { durableWriteStoreSchema, durableWritesConfigSchema, } from '../../transaction/durableWrites.js';
12
+ export { pendingWriteSchema } from '../../transaction/transactions/settlement/pendingWrite.js';
@@ -8,8 +8,8 @@
8
8
  * than any larger object, so the rules have no dependencies of their own and
9
9
  * can be tested in isolation.
10
10
  */
11
- import type { Model } from '../Model.js';
12
- import type { MutationInput, Transaction } from './commitPayload.js';
11
+ import type { Model } from '../../Model.js';
12
+ import type { MutationInput, QueuedMutation } from './commitPayload.js';
13
13
  /**
14
14
  * One tracked optimistic mutation: the live model plus the value it held
15
15
  * before the change, kept so a rollback can restore it.
@@ -17,7 +17,7 @@ import type { MutationInput, Transaction } from './commitPayload.js';
17
17
  export interface OptimisticUpdateEntry {
18
18
  model: Model;
19
19
  previousState: MutationInput | null | undefined;
20
- transaction: Transaction;
20
+ transaction: QueuedMutation;
21
21
  }
22
22
  /**
23
23
  * The event emitter these functions use to announce each optimistic change and
@@ -30,20 +30,20 @@ export interface OptimisticEmitter {
30
30
  * Record an optimistic create and announce it. There is no prior value to
31
31
  * restore, so the rollback pre-image is `null`.
32
32
  */
33
- export declare function applyOptimisticCreate(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, model: Model, transaction: Transaction): void;
33
+ export declare function applyOptimisticCreate(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, model: Model, transaction: QueuedMutation): void;
34
34
  /**
35
35
  * Record an optimistic update and announce it, keeping the row's prior value so
36
36
  * a rollback can put it back.
37
37
  */
38
- export declare function applyOptimisticUpdate(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, model: Model, transaction: Transaction): void;
38
+ export declare function applyOptimisticUpdate(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, model: Model, transaction: QueuedMutation): void;
39
39
  /**
40
40
  * Record an optimistic delete and announce it, keeping the deleted row so a
41
41
  * rollback can restore it.
42
42
  */
43
- export declare function applyOptimisticDelete(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, model: Model, transaction: Transaction): void;
43
+ export declare function applyOptimisticDelete(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, model: Model, transaction: QueuedMutation): void;
44
44
  /**
45
45
  * Undo an optimistic mutation by its transaction id: emit `optimistic:rollback`
46
46
  * with the saved pre-image so listeners can restore the prior value, then drop
47
47
  * the ledger entry. Does nothing if the transaction was never tracked.
48
48
  */
49
- export declare function rollbackOptimistic(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, transaction: Transaction, reason?: string, error?: Error): Promise<void>;
49
+ export declare function rollbackOptimistic(optimisticUpdates: Map<string, OptimisticUpdateEntry>, emitter: OptimisticEmitter, transaction: QueuedMutation, reason?: string, error?: Error): Promise<void>;
@@ -15,7 +15,7 @@
15
15
  * quietly rather than flagged as corruption.
16
16
  */
17
17
  import { z } from 'zod';
18
- import type { Transaction } from './commitPayload.js';
18
+ import type { QueuedMutation } from './commitPayload.js';
19
19
  /**
20
20
  * The shape of a persisted transaction that can be replayed: the fields the
21
21
  * transaction queue reads when it re-enqueues the row — its id, operation type,
@@ -73,12 +73,12 @@ export type PersistedReplayableTransaction = z.infer<typeof persistedTransaction
73
73
  */
74
74
  export declare function isNonReplayablePersistedRow(row: unknown): boolean;
75
75
  /**
76
- * Validates one stored row and rehydrates it into a {@link Transaction} ready
76
+ * Validates one stored row and rehydrates it into a {@link QueuedMutation} ready
77
77
  * to replay, or returns `null` when the row fails validation. Bookkeeping
78
78
  * fields the stored row lacks — status, attempts, priority, timestamp — are
79
79
  * re-derived the same way a freshly staged transaction derives them.
80
80
  */
81
- export declare function deserializePersistedTransaction(row: unknown): Transaction | null;
81
+ export declare function deserializePersistedTransaction(row: unknown): QueuedMutation | null;
82
82
  /**
83
83
  * The shape of one entry in the persisted offline mutation queue — an item of
84
84
  * the `'queue'` row's `mutations` array, carrying the fields read when the
@@ -16,12 +16,13 @@
16
16
  */
17
17
  import { z } from 'zod';
18
18
  import { computePriorityScore, normalizeModelKey } from './commitPayload.js';
19
- import { commitEnvelopeMemberSchema, commitOutboxScopeSchema, } from './commitEnvelope.js';
19
+ import { commitEnvelopeMemberSchema, commitOutboxScopeSchema, } from '../../transaction/transactions/settlement/commitEnvelope.js';
20
+ import { onStaleModeSchema } from '../../transaction/coordination/schema.js';
20
21
  /** The subset of a write's options that is stored with each transaction or queued mutation. */
21
22
  const persistedWriteOptionsSchema = z
22
23
  .object({
23
24
  readAt: z.number().nullable().optional(),
24
- onStale: z.enum(['reject', 'overwrite', 'notify']).nullable().optional(),
25
+ onStale: onStaleModeSchema.nullable().optional(),
25
26
  idempotencyKey: z.string().optional(),
26
27
  label: z.string().optional(),
27
28
  // Aligned with the `WriteOptions` type: a claimed write persisted offline
@@ -81,7 +82,7 @@ export function isNonReplayablePersistedRow(row) {
81
82
  NON_REPLAYABLE_TYPES.has(row.type));
82
83
  }
83
84
  /**
84
- * Validates one stored row and rehydrates it into a {@link Transaction} ready
85
+ * Validates one stored row and rehydrates it into a {@link QueuedMutation} ready
85
86
  * to replay, or returns `null` when the row fails validation. Bookkeeping
86
87
  * fields the stored row lacks — status, attempts, priority, timestamp — are
87
88
  * re-derived the same way a freshly staged transaction derives them.
@@ -5,7 +5,7 @@
5
5
  * each field, leaving any hand-written getter or setter in place.
6
6
  */
7
7
  import { type AnnotationMapEntry } from 'mobx';
8
- import { type PropertyMetadata, type ReferenceMetadata } from '../types/index.js';
8
+ import { type PropertyMetadata, type ReferenceMetadata } from '../transaction/types/index.js';
9
9
  /**
10
10
  * The subset of a model instance that {@link M1} reads and writes. A model calls
11
11
  * {@link M1} from its constructor, where these members exist on `this`;
@@ -5,7 +5,7 @@
5
5
  * each field, leaving any hand-written getter or setter in place.
6
6
  */
7
7
  import { observable, makeObservable, action, computed, observe, } from 'mobx';
8
- import { PropertyType } from '../types/index.js';
8
+ import { PropertyType } from '../transaction/types/index.js';
9
9
  import { getContext } from '../context.js';
10
10
  /**
11
11
  * Makes a model instance's schema-defined properties observable with MobX. For
@@ -140,7 +140,10 @@ export function M1(target, propertyMetadata, referenceMetadata) {
140
140
  annotations.updatedAt = observable;
141
141
  }
142
142
  if (!hasGetter('modifiedProperties') && !hasSetter('modifiedProperties')) {
143
- annotations.modifiedProperties = observable;
143
+ // Track map membership, but keep change payloads as plain values. These
144
+ // entries are replaced rather than mutated and later cross IndexedDB's
145
+ // structured-clone boundary, where MobX's deep proxies are invalid.
146
+ annotations.modifiedProperties = observable.shallow;
144
147
  }
145
148
  // Add actions only if methods exist and aren't already actions.
146
149
  // `Reflect.get` keeps the read typed without an index-signature
@@ -7,10 +7,10 @@ export interface AbloWebhookEvent {
7
7
  /** A stable, unique event identifier equal to `String(syncId)`. Use it to
8
8
  * deduplicate deliveries. */
9
9
  readonly id: string;
10
- /** The event type, formatted as `<model>.<verb>`, such as `"slide.updated"`.
10
+ /** The event type, formatted as `<model>.<verb>`, such as `"report.updated"`.
11
11
  * Branch on this to route the event. */
12
12
  readonly type: string;
13
- /** The name of the model whose row changed, such as `"Slide"`. */
13
+ /** The name of the model whose row changed, such as `"Report"`. */
14
14
  readonly model: string;
15
15
  /** The identifier of the row that changed. */
16
16
  readonly objectId: string;
@@ -1,34 +1 @@
1
- /**
2
- * The wire contract for the sync protocol: the HTTP envelope shapes and the
3
- * write-path frames, with no dependency on the client runtime. A server — a
4
- * route handler, an edge function — can import the envelope producers here
5
- * without pulling in the full sync client.
6
- *
7
- * It has two halves, used across every endpoint:
8
- * - Error responses — {@link errorEnvelope}, {@link ErrorEnvelope}, and
9
- * {@link statusForType} turn any thrown value into the uniform
10
- * `{ type, code, param, message, doc_url, request_id }` body.
11
- * - List responses — {@link listEnvelope} and {@link ListEnvelope} stamp the
12
- * uniform `{ object: 'list', data, has_more, next_cursor }` collection.
13
- *
14
- * The {@link AbloError} hierarchy, {@link docUrlForCode}, and the wire-parsing
15
- * helpers are re-exported too, so a single import lets a route throw the right
16
- * typed error and serialize it back out.
17
- */
18
- export { errorEnvelope, statusForType } from './errorEnvelope.js';
19
- export type { ErrorEnvelope } from './errorEnvelope.js';
20
- export { listEnvelope } from './listEnvelope.js';
21
- export type { ListEnvelope } from './listEnvelope.js';
22
- export { bootstrapReasonSchema } from './bootstrapReason.js';
23
- export type { BootstrapReason } from './bootstrapReason.js';
24
- export { commitOperationSchema, commitPayloadSchema, } from './frames.js';
25
- export { PROTOCOL_VERSION, MIN_SUPPORTED_PROTOCOL_VERSION, DEFAULT_PROTOCOL_VERSION, SUPPORTED_PROTOCOL_VERSIONS, WS_CLOSE_PROTOCOL_VERSION, PROTOCOL_VERSION_HEADER, protocolVersionProblem, resolveProtocolVersion, } from './protocolVersion.js';
26
- export type { SupportedProtocolVersion, ProtocolVersionProblem, } from './protocolVersion.js';
27
- export type { CommitOperation, CommitMessage, MutationResultMessage, } from './frames.js';
28
- export { COMMIT_CORRELATION_ID_MAX_LENGTH, correlationIdSchema, commitStatusSchema, commitSettlementSchema, commitReceiptSchema, legacyCompatibleCommitReceiptSchema, rejectedCommitReceiptSchema, mutationResultPayloadSchema, mutationResultMessageSchema, commitAckSchema, mutationCommitResultSchema, } from './commit.js';
29
- export type { CorrelationId, CommitStatus, CommitSettlement, CommitReceiptWire, RejectedCommitReceiptWire, MutationResultPayload, MutationResultMessageWire, CommitAck, MutationCommitResultInput, MutationCommitResult, } from './commit.js';
30
- export { participantKindSchema, confirmationStateSchema, syncDeltaActionSchema, wireDeltaDataSchema, participantRefSchema, syncDeltaWireCoreSchema, clientSyncDeltaSchema, serverSyncDeltaSchema, } from './delta.js';
31
- export type { ParticipantKind, ConfirmationState, SyncDeltaAction, WireDeltaData, ParticipantRef, SyncDeltaWireCore, ClientSyncDelta, ServerSyncDelta, } from './delta.js';
32
- export { AbloError, AbloAuthenticationError, AbloPermissionError, AbloValidationError, AbloRateLimitError, AbloIdempotencyError, AbloConnectionError, AbloServerError, AbloStaleContextError, AbloClaimedError, CapabilityError, SyncSessionError, docUrlForCode, translateHttpError, errorFromWire, toAbloError, ERROR_CONTRACT_VERSION, errorCodeSpec, } from '../errors.js';
33
- export type { ErrorCode, WireErrorCode } from '../errors.js';
34
- export { PING_INTERVAL_MS, LEASE_TTL_MS, WS_BEARER_SUBPROTOCOL_PREFIX, WS_SYNC_SUBPROTOCOL, } from './protocol.js';
1
+ export * from '../transaction/wire/index.js';