@abloatai/ablo 0.34.1 → 0.36.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 (536) hide show
  1. package/AGENTS.md +2 -1
  2. package/CHANGELOG.md +758 -5
  3. package/README.md +56 -502
  4. package/bin/ablo.cjs +39 -0
  5. package/dist/BaseSyncedStore.d.ts +176 -48
  6. package/dist/BaseSyncedStore.js +346 -214
  7. package/dist/Database.d.ts +17 -44
  8. package/dist/Database.js +96 -79
  9. package/dist/InstanceCache.d.ts +31 -6
  10. package/dist/InstanceCache.js +65 -30
  11. package/dist/LazyReferenceCollection.d.ts +3 -3
  12. package/dist/LazyReferenceCollection.js +4 -4
  13. package/dist/Model.d.ts +23 -13
  14. package/dist/Model.js +27 -17
  15. package/dist/ModelRegistry.d.ts +8 -4
  16. package/dist/ModelRegistry.js +20 -18
  17. package/dist/NetworkMonitor.d.ts +3 -1
  18. package/dist/NetworkMonitor.js +7 -5
  19. package/dist/{SyncEngineContext.d.ts → RuntimeContext.d.ts} +20 -13
  20. package/dist/{SyncEngineContext.js → RuntimeContext.js} +11 -12
  21. package/dist/SyncClient.d.ts +47 -47
  22. package/dist/SyncClient.js +215 -156
  23. package/dist/ai-sdk/coordinatedTool.d.ts +2 -2
  24. package/dist/ai-sdk/coordinatedTool.js +1 -1
  25. package/dist/ai-sdk/coordinationContext.d.ts +2 -2
  26. package/dist/ai-sdk/coordinationContext.js +1 -1
  27. package/dist/ai-sdk/wrap.d.ts +3 -3
  28. package/dist/ai-sdk/wrap.js +2 -2
  29. package/dist/auth/index.d.ts +1 -156
  30. package/dist/auth/index.js +8 -301
  31. package/dist/client/Ablo.d.ts +42 -287
  32. package/dist/client/Ablo.js +129 -963
  33. package/dist/client/abloClient.d.ts +309 -0
  34. package/dist/client/abloClient.js +13 -0
  35. package/dist/client/clientPrelude.d.ts +52 -0
  36. package/dist/client/clientPrelude.js +60 -0
  37. package/dist/client/consoleLogger.d.ts +2 -2
  38. package/dist/client/coreClient.d.ts +60 -0
  39. package/dist/client/coreClient.js +118 -0
  40. package/dist/client/createInternalComponents.d.ts +8 -4
  41. package/dist/client/createInternalComponents.js +17 -10
  42. package/dist/client/createModelProxy.d.ts +98 -373
  43. package/dist/client/createModelProxy.js +233 -139
  44. package/dist/client/humans.d.ts +69 -0
  45. package/dist/client/humans.js +78 -0
  46. package/dist/client/modelRegistration.d.ts +1 -1
  47. package/dist/client/modelRegistration.js +9 -9
  48. package/dist/client/options.d.ts +73 -17
  49. package/dist/client/reactiveEngine.d.ts +53 -0
  50. package/dist/client/reactiveEngine.js +688 -0
  51. package/dist/client/resourceTypes.d.ts +9 -250
  52. package/dist/client/resourceTypes.js +8 -5
  53. package/dist/client/schemaConfig.d.ts +4 -4
  54. package/dist/client/schemaConfig.js +6 -2
  55. package/dist/client/storeCluster.d.ts +47 -0
  56. package/dist/client/storeCluster.js +118 -0
  57. package/dist/client/storeLifecycle.d.ts +61 -0
  58. package/dist/client/storeLifecycle.js +231 -0
  59. package/dist/client/validateAbloOptions.d.ts +3 -2
  60. package/dist/client/validateAbloOptions.js +1 -1
  61. package/dist/client/wsMutationExecutor.d.ts +3 -3
  62. package/dist/client/wsMutationExecutor.js +3 -3
  63. package/dist/context.d.ts +22 -9
  64. package/dist/context.js +33 -9
  65. package/dist/coordination/ClaimLog.d.ts +26 -0
  66. package/dist/coordination/ClaimLog.js +32 -0
  67. package/dist/coordination/index.d.ts +1 -15
  68. package/dist/coordination/index.js +8 -31
  69. package/dist/core/index.d.ts +3 -3
  70. package/dist/core/index.js +2 -2
  71. package/dist/docs/catalog.d.ts +72 -0
  72. package/dist/docs/catalog.js +230 -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 +44 -36
  78. package/dist/index.js +30 -22
  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 +5 -2
  99. package/dist/query/client.js +10 -9
  100. package/dist/query/types.d.ts +6 -41
  101. package/dist/query/types.js +2 -2
  102. package/dist/react/AbloProvider.d.ts +18 -8
  103. package/dist/react/AbloProvider.js +10 -9
  104. package/dist/react/context.d.ts +3 -3
  105. package/dist/react/context.js +1 -1
  106. package/dist/react/createAbloReact.d.ts +56 -0
  107. package/dist/react/createAbloReact.js +51 -0
  108. package/dist/react/index.d.ts +6 -5
  109. package/dist/react/index.js +6 -3
  110. package/dist/react/internalContext.d.ts +1 -1
  111. package/dist/react/useAblo.d.ts +12 -5
  112. package/dist/react/useAblo.js +26 -8
  113. package/dist/react/useCurrentUserId.js +1 -1
  114. package/dist/react/useErrorListener.js +1 -1
  115. package/dist/react/useMutationFailureListener.d.ts +2 -2
  116. package/dist/react/useMutationFailureListener.js +1 -1
  117. package/dist/react/useMutators.d.ts +3 -3
  118. package/dist/react/useMutators.js +3 -3
  119. package/dist/react/useUndoScope.d.ts +5 -5
  120. package/dist/react/useUndoScope.js +1 -1
  121. package/dist/schema/coordination.d.ts +69 -10
  122. package/dist/schema/coordination.js +90 -9
  123. package/dist/schema/ddl.js +2 -2
  124. package/dist/schema/diff.d.ts +1 -1
  125. package/dist/schema/generate.js +1 -1
  126. package/dist/schema/index.d.ts +11 -10
  127. package/dist/schema/index.js +22 -18
  128. package/dist/schema/queries.d.ts +27 -27
  129. package/dist/schema/queries.js +23 -23
  130. package/dist/schema/select.d.ts +3 -3
  131. package/dist/schema/select.js +6 -3
  132. package/dist/schema/serialize.d.ts +15 -6
  133. package/dist/schema/serialize.js +20 -3
  134. package/dist/schema/sugar.d.ts +6 -7
  135. package/dist/schema/sugar.js +9 -12
  136. package/dist/schema/syncDeltaRow.d.ts +4 -152
  137. package/dist/schema/syncDeltaRow.js +4 -105
  138. package/dist/server/adapter.d.ts +18 -1
  139. package/dist/server/commit.d.ts +10 -16
  140. package/dist/server/index.d.ts +1 -1
  141. package/dist/server/index.js +1 -1
  142. package/dist/server/readConfig.d.ts +1 -1
  143. package/dist/source/adapter.d.ts +7 -5
  144. package/dist/source/adapter.js +7 -5
  145. package/dist/source/adapters/drizzle.d.ts +1 -1
  146. package/dist/source/adapters/drizzle.js +2 -2
  147. package/dist/source/adapters/kysely.d.ts +1 -1
  148. package/dist/source/adapters/kysely.js +1 -1
  149. package/dist/source/adapters/kyselyMutationCore.d.ts +1 -1
  150. package/dist/source/adapters/kyselyMutationCore.js +2 -2
  151. package/dist/source/adapters/memory.js +1 -1
  152. package/dist/source/adapters/prisma.d.ts +8 -3
  153. package/dist/source/adapters/prisma.js +1 -1
  154. package/dist/source/connector.js +1 -1
  155. package/dist/source/connectorProtocol.d.ts +2 -8
  156. package/dist/source/connectorProtocol.js +3 -2
  157. package/dist/source/contract.d.ts +29 -17
  158. package/dist/source/contract.js +27 -22
  159. package/dist/source/factory.d.ts +1 -1
  160. package/dist/source/idempotency.js +2 -2
  161. package/dist/source/index.d.ts +1 -0
  162. package/dist/source/index.js +3 -0
  163. package/dist/source/next.d.ts +1 -1
  164. package/dist/source/signing.d.ts +9 -2
  165. package/dist/source/signing.js +4 -1
  166. package/dist/source/types.d.ts +6 -4
  167. package/dist/source/types.js +1 -1
  168. package/dist/{core/storeContract.d.ts → storeContract.d.ts} +6 -6
  169. package/dist/{core → stores}/DatabaseManager.d.ts +3 -1
  170. package/dist/{core → stores}/DatabaseManager.js +14 -13
  171. package/dist/stores/ObjectStore.d.ts +1 -1
  172. package/dist/{core → stores}/StoreManager.d.ts +9 -26
  173. package/dist/{core → stores}/StoreManager.js +29 -77
  174. package/dist/stores/SyncActionStore.d.ts +4 -2
  175. package/dist/stores/SyncActionStore.js +11 -17
  176. package/dist/stores/syncAction.d.ts +26 -0
  177. package/dist/stores/syncAction.js +16 -0
  178. package/dist/surface.d.ts +3 -3
  179. package/dist/surface.js +6 -4
  180. package/dist/sync/BootstrapFetcher.d.ts +127 -6
  181. package/dist/sync/BootstrapFetcher.js +511 -83
  182. package/dist/sync/ConnectionManager.d.ts +6 -198
  183. package/dist/sync/ConnectionManager.js +6 -677
  184. package/dist/sync/OnDemandLoader.d.ts +5 -2
  185. package/dist/sync/OnDemandLoader.js +61 -21
  186. package/dist/sync/SubscriptionManager.d.ts +13 -2
  187. package/dist/sync/SubscriptionManager.js +23 -5
  188. package/dist/sync/SyncWebSocket.d.ts +27 -510
  189. package/dist/sync/SyncWebSocket.js +76 -954
  190. package/dist/sync/awaitClaimGrant.d.ts +4 -44
  191. package/dist/sync/awaitClaimGrant.js +4 -109
  192. package/dist/sync/bootstrapApply.d.ts +3 -0
  193. package/dist/sync/bootstrapApply.js +2 -2
  194. package/dist/sync/commitFrames.d.ts +6 -40
  195. package/dist/sync/commitFrames.js +6 -97
  196. package/dist/sync/contextPorts.d.ts +18 -0
  197. package/dist/sync/contextPorts.js +31 -0
  198. package/dist/sync/createClaimStream.d.ts +5 -49
  199. package/dist/sync/createClaimStream.js +5 -469
  200. package/dist/sync/createPresenceStream.d.ts +26 -4
  201. package/dist/sync/createPresenceStream.js +28 -20
  202. package/dist/sync/createSnapshot.d.ts +2 -2
  203. package/dist/sync/createSnapshot.js +1 -1
  204. package/dist/sync/credentialLifecycle.d.ts +5 -173
  205. package/dist/sync/credentialLifecycle.js +5 -320
  206. package/dist/sync/deltaPipeline.d.ts +13 -12
  207. package/dist/sync/deltaPipeline.js +21 -4
  208. package/dist/sync/groupChange.d.ts +3 -0
  209. package/dist/sync/groupChange.js +16 -14
  210. package/dist/sync/participants.d.ts +24 -6
  211. package/dist/sync/participants.js +32 -23
  212. package/dist/sync/schemaDrift.d.ts +55 -0
  213. package/dist/sync/schemaDrift.js +53 -0
  214. package/dist/sync/schemas.d.ts +23 -33
  215. package/dist/sync/schemas.js +29 -20
  216. package/dist/sync/syncPlan.d.ts +3 -3
  217. package/dist/sync/wsFrameHandlers.d.ts +6 -114
  218. package/dist/sync/wsFrameHandlers.js +6 -392
  219. package/dist/syncLog/contract.d.ts +20 -0
  220. package/dist/syncLog/contract.js +19 -0
  221. package/dist/syncLog/index.d.ts +1 -0
  222. package/dist/syncLog/index.js +1 -0
  223. package/dist/transaction/ablo.d.ts +88 -0
  224. package/dist/transaction/ablo.js +33 -0
  225. package/dist/{client/auth.d.ts → transaction/auth/apiKey.d.ts} +43 -8
  226. package/dist/{client/auth.js → transaction/auth/apiKey.js} +19 -0
  227. package/dist/transaction/auth/bootstrapScope.d.ts +15 -0
  228. package/dist/transaction/auth/bootstrapScope.js +1 -0
  229. package/dist/transaction/auth/capability.d.ts +212 -0
  230. package/dist/transaction/auth/capability.js +224 -0
  231. package/dist/{auth → transaction/auth}/credentialSource.d.ts +8 -1
  232. package/dist/{client → transaction/auth}/identity.d.ts +8 -7
  233. package/dist/{client → transaction/auth}/identity.js +1 -1
  234. package/dist/transaction/auth/index.d.ts +162 -0
  235. package/dist/transaction/auth/index.js +304 -0
  236. package/dist/{auth → transaction/auth}/schemas.d.ts +1 -1
  237. package/dist/{auth → transaction/auth}/schemas.js +13 -13
  238. package/dist/{client → transaction/auth}/sessionMint.d.ts +8 -8
  239. package/dist/{client → transaction/auth}/sessionMint.js +4 -7
  240. package/dist/transaction/coordination/awaitClaimGrant.d.ts +56 -0
  241. package/dist/transaction/coordination/awaitClaimGrant.js +124 -0
  242. package/dist/{client → transaction/coordination}/claimHeartbeatLoop.d.ts +34 -0
  243. package/dist/{client → transaction/coordination}/claimHeartbeatLoop.js +20 -0
  244. package/dist/transaction/coordination/claimMeta.d.ts +49 -0
  245. package/dist/transaction/coordination/claimMeta.js +52 -0
  246. package/dist/transaction/coordination/createClaimStream.d.ts +64 -0
  247. package/dist/transaction/coordination/createClaimStream.js +475 -0
  248. package/dist/transaction/coordination/events.d.ts +74 -0
  249. package/dist/transaction/coordination/events.js +7 -0
  250. package/dist/transaction/coordination/index.d.ts +19 -0
  251. package/dist/transaction/coordination/index.js +45 -0
  252. package/dist/transaction/coordination/locator.d.ts +104 -0
  253. package/dist/transaction/coordination/locator.js +102 -0
  254. package/dist/transaction/coordination/schema.d.ts +1536 -0
  255. package/dist/transaction/coordination/schema.js +1177 -0
  256. package/dist/transaction/coordination/targetConflict.d.ts +2 -0
  257. package/dist/transaction/coordination/targetConflict.js +107 -0
  258. package/dist/{coordination → transaction/coordination}/trace.d.ts +7 -18
  259. package/dist/{coordination → transaction/coordination}/trace.js +18 -25
  260. package/dist/transaction/durableWrites.d.ts +62 -0
  261. package/dist/{client → transaction}/durableWrites.js +28 -3
  262. package/dist/transaction/environment.d.ts +105 -0
  263. package/dist/transaction/environment.js +108 -0
  264. package/dist/{errorCodes.d.ts → transaction/errorCodes.d.ts} +12 -12
  265. package/dist/{errorCodes.js → transaction/errorCodes.js} +45 -18
  266. package/dist/{errors.d.ts → transaction/errors.d.ts} +37 -13
  267. package/dist/{errors.js → transaction/errors.js} +85 -16
  268. package/dist/transaction/footprint.d.ts +111 -0
  269. package/dist/transaction/footprint.js +0 -0
  270. package/dist/transaction/index.d.ts +20 -0
  271. package/dist/transaction/index.js +20 -0
  272. package/dist/transaction/keys/index.d.ts +87 -0
  273. package/dist/transaction/keys/index.js +207 -0
  274. package/dist/transaction/log/syncDeltaRow.d.ts +158 -0
  275. package/dist/transaction/log/syncDeltaRow.js +95 -0
  276. package/dist/{sync/syncPosition.d.ts → transaction/logPosition.d.ts} +22 -8
  277. package/dist/{sync/syncPosition.js → transaction/logPosition.js} +15 -6
  278. package/dist/transaction/logger.d.ts +16 -0
  279. package/dist/transaction/logger.js +7 -0
  280. package/dist/transaction/observability.d.ts +53 -0
  281. package/dist/transaction/observability.js +19 -0
  282. package/dist/transaction/plugin.d.ts +285 -0
  283. package/dist/transaction/plugin.js +106 -0
  284. package/dist/{policy → transaction/policy}/types.d.ts +3 -3
  285. package/dist/{policy → transaction/policy}/types.js +2 -0
  286. package/dist/transaction/resources/httpResources.d.ts +321 -0
  287. package/dist/transaction/resources/httpResources.js +7 -0
  288. package/dist/transaction/resources/modelOperations.d.ts +427 -0
  289. package/dist/transaction/resources/modelOperations.js +12 -0
  290. package/dist/transaction/resources/mutationOptions.d.ts +66 -0
  291. package/dist/transaction/resources/mutationOptions.js +9 -0
  292. package/dist/transaction/resources/where.d.ts +101 -0
  293. package/dist/transaction/resources/where.js +115 -0
  294. package/dist/{client → transaction/resources}/writeOptionsSchema.d.ts +2 -6
  295. package/dist/{client → transaction/resources}/writeOptionsSchema.js +9 -5
  296. package/dist/{schema → transaction/schema}/field.d.ts +17 -23
  297. package/dist/{schema → transaction/schema}/field.js +5 -5
  298. package/dist/transaction/schema/fieldRef.d.ts +38 -0
  299. package/dist/transaction/schema/fieldRef.js +11 -0
  300. package/dist/transaction/schema/loadStrategy.d.ts +45 -0
  301. package/dist/transaction/schema/loadStrategy.js +46 -0
  302. package/dist/{schema → transaction/schema}/model.d.ts +50 -35
  303. package/dist/{schema → transaction/schema}/model.js +30 -20
  304. package/dist/transaction/schema/openapi.d.ts +58 -0
  305. package/dist/transaction/schema/openapi.js +501 -0
  306. package/dist/{schema → transaction/schema}/relation.d.ts +21 -16
  307. package/dist/{schema → transaction/schema}/relation.js +7 -7
  308. package/dist/{schema → transaction/schema}/residency.d.ts +0 -9
  309. package/dist/{schema → transaction/schema}/residency.js +0 -5
  310. package/dist/{schema → transaction/schema}/roles.d.ts +5 -5
  311. package/dist/{schema → transaction/schema}/roles.js +5 -5
  312. package/dist/{schema → transaction/schema}/schema.d.ts +39 -10
  313. package/dist/{schema → transaction/schema}/schema.js +24 -3
  314. package/dist/{schema → transaction/schema}/tenancy.d.ts +1 -1
  315. package/dist/{schema → transaction/schema}/tenancy.js +7 -4
  316. package/dist/transaction/transactionLayer.d.ts +82 -0
  317. package/dist/transaction/transactionLayer.js +24 -0
  318. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.d.ts +5 -6
  319. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.js +9 -13
  320. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.d.ts +9 -2
  321. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.js +5 -9
  322. package/dist/{transactions/durableWriteStore.d.ts → transaction/transactions/settlement/pendingWrite.d.ts} +11 -37
  323. package/dist/transaction/transactions/settlement/pendingWrite.js +20 -0
  324. package/dist/transaction/transport/commitFrames.d.ts +90 -0
  325. package/dist/transaction/transport/commitFrames.js +134 -0
  326. package/dist/transaction/transport/connectionManager.d.ts +215 -0
  327. package/dist/transaction/transport/connectionManager.js +673 -0
  328. package/dist/transaction/transport/credentialLifecycle.d.ts +177 -0
  329. package/dist/transaction/transport/credentialLifecycle.js +324 -0
  330. package/dist/{sync → transaction/transport}/heartbeat.d.ts +3 -1
  331. package/dist/{sync → transaction/transport}/heartbeat.js +6 -4
  332. package/dist/transaction/transport/httpClient.d.ts +131 -0
  333. package/dist/{client → transaction/transport}/httpClient.js +6 -5
  334. package/dist/transaction/transport/httpOptions.d.ts +33 -0
  335. package/dist/transaction/transport/httpOptions.js +12 -0
  336. package/dist/{client → transaction/transport}/httpTransport.js +295 -97
  337. package/dist/{sync/NetworkProbe.d.ts → transaction/transport/networkProbe.d.ts} +7 -4
  338. package/dist/{sync/NetworkProbe.js → transaction/transport/networkProbe.js} +14 -13
  339. package/dist/transaction/transport/wsFrameHandlers.d.ts +128 -0
  340. package/dist/transaction/transport/wsFrameHandlers.js +429 -0
  341. package/dist/transaction/transport/wsTransport.d.ts +574 -0
  342. package/dist/transaction/transport/wsTransport.js +1023 -0
  343. package/dist/transaction/types/assertExact.d.ts +17 -0
  344. package/dist/transaction/types/assertExact.js +1 -0
  345. package/dist/{types → transaction/types}/global.d.ts +17 -2
  346. package/dist/{types → transaction/types}/global.js +2 -1
  347. package/dist/{types → transaction/types}/index.d.ts +14 -46
  348. package/dist/{types → transaction/types}/index.js +7 -16
  349. package/dist/{types → transaction/types}/streams.d.ts +73 -45
  350. package/dist/transaction/utils/duration.d.ts +50 -0
  351. package/dist/{utils → transaction/utils}/duration.js +32 -0
  352. package/dist/{utils → transaction/utils}/json.d.ts +18 -0
  353. package/dist/transaction/utils/json.js +276 -0
  354. package/dist/transaction/wire/accountResponses.d.ts +420 -0
  355. package/dist/transaction/wire/accountResponses.js +290 -0
  356. package/dist/transaction/wire/auth.d.ts +56 -0
  357. package/dist/transaction/wire/auth.js +63 -0
  358. package/dist/transaction/wire/claimEvent.d.ts +76 -0
  359. package/dist/transaction/wire/claimEvent.js +73 -0
  360. package/dist/transaction/wire/claims.d.ts +530 -0
  361. package/dist/transaction/wire/claims.js +327 -0
  362. package/dist/{wire → transaction/wire}/commit.d.ts +125 -193
  363. package/dist/{wire → transaction/wire}/commit.js +68 -47
  364. package/dist/{wire → transaction/wire}/delta.d.ts +66 -17
  365. package/dist/{wire → transaction/wire}/delta.js +37 -13
  366. package/dist/transaction/wire/errorEnvelope.d.ts +72 -0
  367. package/dist/{wire → transaction/wire}/errorEnvelope.js +36 -5
  368. package/dist/transaction/wire/feedCursor.d.ts +60 -0
  369. package/dist/transaction/wire/feedCursor.js +82 -0
  370. package/dist/transaction/wire/feedEvent.d.ts +204 -0
  371. package/dist/transaction/wire/feedEvent.js +65 -0
  372. package/dist/transaction/wire/frames.d.ts +194 -0
  373. package/dist/transaction/wire/frames.js +50 -0
  374. package/dist/transaction/wire/inboundFrames.d.ts +562 -0
  375. package/dist/transaction/wire/inboundFrames.js +116 -0
  376. package/dist/transaction/wire/index.d.ts +54 -0
  377. package/dist/transaction/wire/index.js +83 -0
  378. package/dist/{wire → transaction/wire}/listEnvelope.d.ts +13 -14
  379. package/dist/transaction/wire/listEnvelope.js +42 -0
  380. package/dist/transaction/wire/modelMutations.d.ts +31 -0
  381. package/dist/transaction/wire/modelMutations.js +52 -0
  382. package/dist/transaction/wire/modelResponses.d.ts +85 -0
  383. package/dist/transaction/wire/modelResponses.js +43 -0
  384. package/dist/transaction/wire/modelShape.d.ts +78 -0
  385. package/dist/transaction/wire/modelShape.js +74 -0
  386. package/dist/transactions/{TransactionQueue.d.ts → mutations/MutationQueue.d.ts} +85 -38
  387. package/dist/transactions/{TransactionQueue.js → mutations/MutationQueue.js} +141 -80
  388. package/dist/transactions/{TransactionStore.d.ts → mutations/MutationStore.d.ts} +8 -8
  389. package/dist/transactions/{TransactionStore.js → mutations/MutationStore.js} +2 -2
  390. package/dist/transactions/{coalesceRules.d.ts → mutations/coalesceRules.d.ts} +10 -10
  391. package/dist/transactions/{coalesceRules.js → mutations/coalesceRules.js} +1 -1
  392. package/dist/transactions/mutations/commitLatency.d.ts +52 -0
  393. package/dist/transactions/mutations/commitLatency.js +130 -0
  394. package/dist/transactions/{commitOutboxStore.d.ts → mutations/commitOutboxStore.d.ts} +1 -5
  395. package/dist/transactions/{commitOutboxStore.js → mutations/commitOutboxStore.js} +1 -1
  396. package/dist/transactions/{commitPayload.d.ts → mutations/commitPayload.d.ts} +18 -16
  397. package/dist/transactions/{commitPayload.js → mutations/commitPayload.js} +15 -15
  398. package/dist/transactions/{deltaConfirmation.d.ts → mutations/deltaConfirmation.d.ts} +15 -11
  399. package/dist/transactions/{deltaConfirmation.js → mutations/deltaConfirmation.js} +14 -12
  400. package/dist/transactions/mutations/durableWriteStore.d.ts +14 -0
  401. package/dist/transactions/mutations/durableWriteStore.js +12 -0
  402. package/dist/transactions/{optimisticApply.d.ts → mutations/optimisticApply.d.ts} +7 -7
  403. package/dist/transactions/{replayValidation.d.ts → mutations/replayValidation.d.ts} +4 -3
  404. package/dist/transactions/{replayValidation.js → mutations/replayValidation.js} +7 -5
  405. package/dist/utils/mobxSetup.d.ts +1 -1
  406. package/dist/utils/mobxSetup.js +5 -2
  407. package/dist/{core → views}/QueryView.d.ts +2 -2
  408. package/dist/{core → views}/QueryView.js +2 -2
  409. package/dist/{core → views}/ViewRegistry.d.ts +1 -1
  410. package/dist/{core/queryUtils.d.ts → views/incrementalView.d.ts} +6 -6
  411. package/dist/{core/queryUtils.js → views/incrementalView.js} +6 -6
  412. package/dist/webhooks/events.d.ts +2 -2
  413. package/dist/wire/index.d.ts +1 -34
  414. package/dist/wire/index.js +8 -49
  415. package/docs/agent-messaging.md +3 -3
  416. package/docs/agents.md +20 -13
  417. package/docs/api-keys.md +14 -10
  418. package/docs/api.md +27 -61
  419. package/docs/audit.md +6 -3
  420. package/docs/cli.md +41 -13
  421. package/docs/client-behavior.md +11 -9
  422. package/docs/concurrency-convention.md +49 -57
  423. package/docs/coordination.md +283 -121
  424. package/docs/data-sources.md +7 -5
  425. package/docs/debugging.md +39 -15
  426. package/docs/deployment.md +267 -0
  427. package/docs/examples/agent-human.md +49 -42
  428. package/docs/examples/ai-sdk-tool.md +69 -44
  429. package/docs/examples/existing-python-backend.md +8 -6
  430. package/docs/examples/nextjs.md +129 -47
  431. package/docs/examples/scoped-agent.md +46 -45
  432. package/docs/examples/server-agent.md +46 -26
  433. package/docs/groups.md +87 -30
  434. package/docs/guarantees.md +41 -12
  435. package/docs/how-it-works.md +38 -12
  436. package/docs/idempotency.md +126 -0
  437. package/docs/identity.md +77 -74
  438. package/docs/index.md +172 -86
  439. package/docs/integration-guide.md +31 -19
  440. package/docs/mcp.md +46 -21
  441. package/docs/migration.md +95 -18
  442. package/docs/operating-on-your-database.md +3 -1
  443. package/docs/projects.md +3 -1
  444. package/docs/quickstart.md +22 -5
  445. package/docs/react.md +31 -18
  446. package/docs/schema-contract.md +5 -3
  447. package/docs/session-settings.md +108 -0
  448. package/docs/sessions.md +4 -2
  449. package/docs/webhooks.md +12 -10
  450. package/llms.txt +48 -18
  451. package/package.json +21 -26
  452. package/dist/agent/Agent.d.ts +0 -366
  453. package/dist/agent/Agent.js +0 -514
  454. package/dist/agent/index.d.ts +0 -115
  455. package/dist/agent/index.js +0 -128
  456. package/dist/agent/session.d.ts +0 -93
  457. package/dist/agent/session.js +0 -149
  458. package/dist/agent/types.d.ts +0 -68
  459. package/dist/agent/types.js +0 -9
  460. package/dist/cli.cjs +0 -286329
  461. package/dist/client/durableWrites.d.ts +0 -21
  462. package/dist/client/httpClient.d.ts +0 -80
  463. package/dist/coordination/schema.d.ts +0 -722
  464. package/dist/coordination/schema.js +0 -578
  465. package/dist/schema/openapi.d.ts +0 -29
  466. package/dist/schema/openapi.js +0 -124
  467. package/dist/testing/fixtures/bootstrap.d.ts +0 -49
  468. package/dist/testing/fixtures/bootstrap.js +0 -59
  469. package/dist/testing/fixtures/deltas.d.ts +0 -83
  470. package/dist/testing/fixtures/deltas.js +0 -136
  471. package/dist/testing/fixtures/models.d.ts +0 -83
  472. package/dist/testing/fixtures/models.js +0 -272
  473. package/dist/testing/helpers/reactWrapper.d.ts +0 -69
  474. package/dist/testing/helpers/reactWrapper.js +0 -67
  475. package/dist/testing/helpers/syncEngineHarness.d.ts +0 -54
  476. package/dist/testing/helpers/syncEngineHarness.js +0 -73
  477. package/dist/testing/helpers/wait.d.ts +0 -30
  478. package/dist/testing/helpers/wait.js +0 -49
  479. package/dist/testing/index.d.ts +0 -23
  480. package/dist/testing/index.js +0 -33
  481. package/dist/testing/mocks/FakeDatabase.d.ts +0 -18
  482. package/dist/testing/mocks/FakeDatabase.js +0 -10
  483. package/dist/testing/mocks/MockMutationExecutor.d.ts +0 -87
  484. package/dist/testing/mocks/MockMutationExecutor.js +0 -192
  485. package/dist/testing/mocks/MockNetworkMonitor.d.ts +0 -20
  486. package/dist/testing/mocks/MockNetworkMonitor.js +0 -46
  487. package/dist/testing/mocks/MockSyncContext.d.ts +0 -51
  488. package/dist/testing/mocks/MockSyncContext.js +0 -71
  489. package/dist/testing/mocks/MockSyncStore.d.ts +0 -88
  490. package/dist/testing/mocks/MockSyncStore.js +0 -171
  491. package/dist/testing/mocks/MockWebSocket.d.ts +0 -71
  492. package/dist/testing/mocks/MockWebSocket.js +0 -118
  493. package/dist/transactions/durableWriteStore.js +0 -30
  494. package/dist/utils/duration.d.ts +0 -25
  495. package/dist/utils/json.js +0 -88
  496. package/dist/wire/errorEnvelope.d.ts +0 -55
  497. package/dist/wire/frames.d.ts +0 -197
  498. package/dist/wire/frames.js +0 -49
  499. package/dist/wire/listEnvelope.js +0 -18
  500. package/docs/interaction-model.md +0 -97
  501. /package/dist/{core → query}/QueryProcessor.d.ts +0 -0
  502. /package/dist/{core → query}/QueryProcessor.js +0 -0
  503. /package/dist/{core/storeContract.js → storeContract.js} +0 -0
  504. /package/dist/{core → stores}/openIDBWithTimeout.d.ts +0 -0
  505. /package/dist/{core → stores}/openIDBWithTimeout.js +0 -0
  506. /package/dist/{client → transaction/auth}/credentialEndpoint.d.ts +0 -0
  507. /package/dist/{client → transaction/auth}/credentialEndpoint.js +0 -0
  508. /package/dist/{auth → transaction/auth}/credentialPolicy.d.ts +0 -0
  509. /package/dist/{auth → transaction/auth}/credentialPolicy.js +0 -0
  510. /package/dist/{auth → transaction/auth}/credentialSource.js +0 -0
  511. /package/dist/{client → transaction/auth}/hostedEndpoints.d.ts +0 -0
  512. /package/dist/{client → transaction/auth}/hostedEndpoints.js +0 -0
  513. /package/dist/{client → transaction}/persistence.d.ts +0 -0
  514. /package/dist/{client → transaction}/persistence.js +0 -0
  515. /package/dist/{client → transaction/resources}/functionalUpdate.d.ts +0 -0
  516. /package/dist/{client → transaction/resources}/functionalUpdate.js +0 -0
  517. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.d.ts +0 -0
  518. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.js +0 -0
  519. /package/dist/{client → transaction/transport}/httpTransport.d.ts +0 -0
  520. /package/dist/{types → transaction/types}/modelData.d.ts +0 -0
  521. /package/dist/{types → transaction/types}/modelData.js +0 -0
  522. /package/dist/{types → transaction/types}/participant.d.ts +0 -0
  523. /package/dist/{types → transaction/types}/participant.js +0 -0
  524. /package/dist/{types → transaction/types}/streams.js +0 -0
  525. /package/dist/{utils → transaction/utils}/asyncIterator.d.ts +0 -0
  526. /package/dist/{utils → transaction/utils}/asyncIterator.js +0 -0
  527. /package/dist/{wire → transaction/wire}/bootstrapReason.d.ts +0 -0
  528. /package/dist/{wire → transaction/wire}/bootstrapReason.js +0 -0
  529. /package/dist/{wire → transaction/wire}/protocol.d.ts +0 -0
  530. /package/dist/{wire → transaction/wire}/protocol.js +0 -0
  531. /package/dist/{wire → transaction/wire}/protocolVersion.d.ts +0 -0
  532. /package/dist/{wire → transaction/wire}/protocolVersion.js +0 -0
  533. /package/dist/transactions/{UnconfirmedWrites.d.ts → mutations/UnconfirmedWrites.d.ts} +0 -0
  534. /package/dist/transactions/{UnconfirmedWrites.js → mutations/UnconfirmedWrites.js} +0 -0
  535. /package/dist/transactions/{optimisticApply.js → mutations/optimisticApply.js} +0 -0
  536. /package/dist/{core → views}/ViewRegistry.js +0 -0
@@ -1,471 +1,7 @@
1
1
  /**
2
- * Creates a {@link ClaimStream} over a live sync connection. A claim is a
3
- * short-lived, advisory lease a participant takes on an entity (or a field of
4
- * one) to signal "I'm working on this"; the stream lets you take claims, see
5
- * everyone else's, and watch the wait queue when a claim is contended.
6
- *
7
- * The stream is built directly on the sync WebSocket and shares that one
8
- * connection. It learns about other participants' claims from the same
9
- * `presence_update` frames the {@link createPresenceStream} presence stream
10
- * consumes — the server piggybacks each participant's `activeClaims` on every
11
- * presence frame — and sends its own claims as `claim_begin` and
12
- * `claim_abandon` frames.
13
- *
14
- * Wire frames:
15
- * • Outbound `claim_begin` — announce a claim: `{ claimId, entityType,
16
- * entityId, description, field?, estimatedMs? }`.
17
- * • Outbound `claim_abandon` — release it: `{ claimId, entityType?,
18
- * entityId? }`.
19
- * • Inbound, via presence — `event.activeClaims`, each stamped with
20
- * `declaredAt` and `expiresAt`.
21
- * • Inbound `claim_rejected` — the server refused the claim, with conflict
22
- * metadata.
2
+ * Moved to the settlement core (ADR 0016): claim push is coordination, and
3
+ * coordination is the product a contending agent wants `claim_granted`
4
+ * pushed exactly as much as a person does. This path re-exports it so
5
+ * existing importers stay unchanged.
23
6
  */
24
- import { asyncIteratorFrom } from '../utils/asyncIterator.js';
25
- import { toMs } from '../utils/duration.js';
26
- import { claimHeartbeatAckPayloadSchema, claimLostSchema, descriptionFromMeta, participantKindFromWire, } from '../coordination/schema.js';
27
- import { AbloClaimedError, AbloConnectionError } from '../errors.js';
28
- import { resolveHeartbeatOptions } from '../client/claimHeartbeatLoop.js';
29
- import { getContext } from '../context.js';
30
- /** Readable target for the coordination trace: `documents:abc` / `documents:abc.title`. */
31
- function claimLabel(type, id, field) {
32
- return field ? `${type}:${id}.${field}` : `${type}:${id}`;
33
- }
34
- /**
35
- * How long a heartbeat waits for its `claim_heartbeat_ack` before giving up
36
- * as transient (the auto-heartbeat loop's next tick retries). Comfortably
37
- * above a round trip, comfortably below the ttl/3 beat cadence.
38
- */
39
- const HEARTBEAT_ACK_TIMEOUT_MS = 10_000;
40
- export function createClaimStream(config, transport = null) {
41
- const { participantId } = config;
42
- // ── State: others' open claims, keyed by claimId ───────────────
43
- const activeByClaimId = new Map();
44
- let claimsSnapshot = Object.freeze([]);
45
- // ── State: our own open claims (for re-announce on reconnect) ───
46
- const ownClaims = new Map();
47
- // ── State: per-entity wait queues, from `claim_queue` frames ────
48
- // Keyed `type:id`; the value is the FIFO line of queued claims. Powers
49
- // the reactive `queue(target)` read — who's waiting and what they intend.
50
- const queueByEntity = new Map();
51
- const entityKey = (type, id) => `${type}:${id}`;
52
- const EMPTY_QUEUE = Object.freeze([]);
53
- // Last queue position we logged per own-claim, so advancing in line is traced
54
- // once per change (not re-logged on every server re-fan of the same line).
55
- const lastLoggedQueuePos = new Map();
56
- // ── Subscribers ──────────────────────────────────────────────────
57
- const listeners = new Set();
58
- const rejectionListeners = new Set();
59
- const lostListeners = new Set();
60
- // ── State: in-flight heartbeats awaiting their ack, keyed by claimId ──
61
- const pendingHeartbeats = new Map();
62
- const settleHeartbeat = (claimId, settle) => {
63
- const pending = pendingHeartbeats.get(claimId);
64
- if (!pending)
65
- return;
66
- pendingHeartbeats.delete(claimId);
67
- clearTimeout(pending.timer);
68
- settle(pending);
69
- };
70
- const notifyListeners = () => {
71
- claimsSnapshot = Object.freeze(Array.from(activeByClaimId.values()));
72
- for (const l of listeners) {
73
- try {
74
- l();
75
- }
76
- catch {
77
- /* listener errors don't break siblings */
78
- }
79
- }
80
- };
81
- // ── Wire wiring ──────────────────────────────────────────────────
82
- let attached = null;
83
- const unsubs = [];
84
- function attach(t) {
85
- if (attached)
86
- return;
87
- attached = t;
88
- // (1) Inbound presence frames carry every participant's full
89
- // active-claim set. Prune previous claims by holder, then
90
- // re-add from the frame — the frame is authoritative for that
91
- // participant's open claims at that moment.
92
- unsubs.push(t.subscribe('presence_update', (event) => {
93
- if (!event.userId)
94
- return;
95
- if (event.userId === participantId)
96
- return;
97
- let mutated = false;
98
- if (event.kind === 'leave') {
99
- for (const [id, claim] of activeByClaimId) {
100
- if (claim.heldBy === event.userId) {
101
- activeByClaimId.delete(id);
102
- mutated = true;
103
- }
104
- }
105
- if (mutated)
106
- notifyListeners();
107
- return;
108
- }
109
- for (const [id, claim] of activeByClaimId) {
110
- if (claim.heldBy === event.userId) {
111
- activeByClaimId.delete(id);
112
- mutated = true;
113
- }
114
- }
115
- for (const claim of event.activeClaims ?? []) {
116
- // Terminal-status entries (committed / expired / canceled) are
117
- // one-shot "this claim ended" signals. The holder sweep above
118
- // already removed the prior active entry; skipping the re-add
119
- // drops it from `others`, which is what resolves a contender's
120
- // `settled()`. Absent status means active (wire back-compat).
121
- if (claim.status && claim.status !== 'active')
122
- continue;
123
- // Resolve the always-present public field, tolerating a frame that
124
- // carries the value in `meta` rather than as an explicit description.
125
- const description = claim.description ??
126
- descriptionFromMeta(claim.meta) ??
127
- 'editing';
128
- activeByClaimId.set(claim.claimId, {
129
- object: 'claim',
130
- id: claim.claimId,
131
- status: 'active',
132
- heldBy: event.userId,
133
- participantKind: participantKindFromWire(event.participantKind, event.isAgent),
134
- target: {
135
- type: claim.entityType,
136
- id: claim.entityId,
137
- path: claim.path,
138
- range: claim.range,
139
- field: claim.field,
140
- meta: claim.meta,
141
- },
142
- description,
143
- ttlSeconds: Math.max(0, Math.floor((claim.expiresAt - Date.now()) / 1000)),
144
- createdAt: claim.declaredAt,
145
- expiresAt: claim.expiresAt,
146
- });
147
- mutated = true;
148
- }
149
- if (mutated)
150
- notifyListeners();
151
- }));
152
- // (2) Server-side rejection frames.
153
- unsubs.push(t.subscribe('claim_rejected', (rejection) => {
154
- if (!rejection.claimId)
155
- return;
156
- if (ownClaims.has(rejection.claimId)) {
157
- const tgt = rejection.target
158
- ? claimLabel(rejection.target.entityType, rejection.target.entityId, rejection.target.field)
159
- : rejection.claimId;
160
- getContext().logger.info(`claim: rejected ${tgt}${rejection.heldBy ? ` — held by ${rejection.heldBy}` : ''}`, { claimId: rejection.claimId, reason: rejection.reason });
161
- }
162
- // Drop the rejected own-claim so reconnect doesn't re-announce
163
- // a claim the server already rejected (would just spam both
164
- // sides with conflicts).
165
- ownClaims.delete(rejection.claimId);
166
- for (const l of rejectionListeners) {
167
- try {
168
- l(rejection);
169
- }
170
- catch {
171
- /* isolate */
172
- }
173
- }
174
- }));
175
- // (2a) Server-side loss frames — you held the claim, then lost it
176
- // (preempted or expired). Distinct from a rejection, which is a claim
177
- // the server refused.
178
- unsubs.push(t.subscribe('claim_lost', (payload) => {
179
- const parsed = claimLostSchema.safeParse(payload);
180
- if (!parsed.success)
181
- return;
182
- const lost = parsed.data;
183
- if (ownClaims.has(lost.claimId)) {
184
- const c = ownClaims.get(lost.claimId);
185
- getContext().logger.info(`claim: lost ${c ? claimLabel(c.entityType, c.entityId, c.field) : lost.claimId} (preempted or expired)`, { claimId: lost.claimId });
186
- }
187
- // Drop the lost own-claim so reconnect doesn't re-announce a lease we
188
- // no longer hold.
189
- ownClaims.delete(lost.claimId);
190
- for (const l of lostListeners) {
191
- try {
192
- l(lost);
193
- }
194
- catch {
195
- /* isolate */
196
- }
197
- }
198
- }));
199
- // (2b) Per-entity wait-queue snapshots. The server fans the full line
200
- // out on every queue mutation; we replace our cached line for that
201
- // entity and notify so `queue(target)` reads reactively.
202
- unsubs.push(t.subscribe('claim_queue', (payload) => {
203
- const p = payload;
204
- if (!p.target?.type || !p.target.id)
205
- return;
206
- const key = entityKey(p.target.type, p.target.id);
207
- const line = Array.isArray(p.queue) ? p.queue : [];
208
- if (line.length === 0)
209
- queueByEntity.delete(key);
210
- else
211
- queueByEntity.set(key, Object.freeze([...line]));
212
- // If we are in this line, trace our position (the "agent queued behind a
213
- // claim" moment) — once per position change, so advancing is visible.
214
- const ourIndex = line.findIndex((c) => ownClaims.has(c.id));
215
- const ourClaim = ourIndex >= 0 ? line[ourIndex] : undefined;
216
- if (ourClaim) {
217
- const ourId = ourClaim.id;
218
- if (lastLoggedQueuePos.get(ourId) !== ourIndex) {
219
- lastLoggedQueuePos.set(ourId, ourIndex);
220
- getContext().logger.info(`claim: queued for ${claimLabel(p.target.type, p.target.id)} — position ${ourIndex + 1} of ${line.length}, waiting`, { claimId: ourId });
221
- }
222
- }
223
- notifyListeners();
224
- }));
225
- // (2c) Heartbeat replies — correlate back to the awaiting beat by
226
- // claimId. `held` resolves with the extended expiry; `queued` and
227
- // `lost` reject with a typed claimed error, because a heartbeat on
228
- // a handle we thought we held coming back as anything but `held`
229
- // means the lease is no longer ours.
230
- unsubs.push(t.subscribe('claim_heartbeat_ack', (payload) => {
231
- const parsed = claimHeartbeatAckPayloadSchema.safeParse(payload);
232
- if (!parsed.success)
233
- return;
234
- const ack = parsed.data;
235
- settleHeartbeat(ack.claimId, ({ resolve, reject }) => {
236
- if (ack.status === 'held' && ack.expiresAt !== undefined) {
237
- resolve({
238
- expiresAt: ack.expiresAt,
239
- ...(ack.queueDepth !== undefined
240
- ? { queueDepth: ack.queueDepth }
241
- : {}),
242
- });
243
- return;
244
- }
245
- const c = ownClaims.get(ack.claimId);
246
- reject(new AbloClaimedError(`The lease behind ${c ? claimLabel(c.entityType, c.entityId, c.field) : `claim ${ack.claimId}`} is no longer held — it expired or was granted onward while this participant was working. Re-acquire the claim and retry; a write attempted under the old lease is rejected by its \`readAt\` guard.`, { code: 'claim_lost' }));
247
- });
248
- }));
249
- // (3) On reconnect, re-announce every open self-claim — the
250
- // server's claim state is in-memory and is lost across
251
- // restarts. Without this, peers would see our claims vanish
252
- // whenever the connection blipped.
253
- unsubs.push(t.subscribe('connected', () => {
254
- for (const [claimId, claim] of ownClaims) {
255
- sendBegin(claimId, claim);
256
- }
257
- }));
258
- }
259
- if (transport)
260
- attach(transport);
261
- // ── Outbound ────────────────────────────────────────────────────
262
- function sendBegin(claimId, claim) {
263
- if (!attached?.isConnected())
264
- return;
265
- attached.send({
266
- type: 'claim_begin',
267
- payload: {
268
- claimId,
269
- entityType: claim.entityType,
270
- entityId: claim.entityId,
271
- path: claim.path,
272
- range: claim.range,
273
- description: claim.description,
274
- field: claim.field,
275
- meta: claim.meta,
276
- estimatedMs: claim.estimatedMs,
277
- queue: claim.queue,
278
- },
279
- });
280
- }
281
- function sendReorder(entityType, entityId, order) {
282
- if (!attached?.isConnected())
283
- return;
284
- attached.send({
285
- type: 'claim_reorder',
286
- payload: {
287
- entityType,
288
- entityId,
289
- // The wire shape identifies a waiter by heldBy + claimId; map the
290
- // ergonomic `Claim[]` (what `queueFor` returns) down to that.
291
- order: order.map((i) => ({ heldBy: i.heldBy, claimId: i.id })),
292
- },
293
- });
294
- }
295
- /**
296
- * Send one heartbeat and await its ack. Rejects with
297
- * {@link AbloConnectionError} (transient — the auto-heartbeat loop retries
298
- * on its next tick) when the socket is down or the ack times out, and with
299
- * {@link AbloClaimedError} (definitive) when the server answers that the
300
- * lease is no longer ours.
301
- */
302
- function sendHeartbeat(claimId, claim, options) {
303
- if (!attached?.isConnected()) {
304
- return Promise.reject(new AbloConnectionError(`The heartbeat for ${claimLabel(claim.entityType, claim.entityId, claim.field)} was skipped because the connection is down. The keepalive renews held leases automatically on reconnect; the next beat retries.`));
305
- }
306
- return new Promise((resolve, reject) => {
307
- settleHeartbeat(claimId, ({ reject: rejectPrior }) => {
308
- rejectPrior(new AbloConnectionError('A newer heartbeat for this claim superseded the one still awaiting its reply.'));
309
- });
310
- const timer = setTimeout(() => {
311
- settleHeartbeat(claimId, ({ reject: rejectTimeout }) => {
312
- rejectTimeout(new AbloConnectionError(`No reply to the heartbeat for ${claimLabel(claim.entityType, claim.entityId, claim.field)} arrived within ${HEARTBEAT_ACK_TIMEOUT_MS / 1000}s. The next beat retries.`));
313
- });
314
- }, HEARTBEAT_ACK_TIMEOUT_MS);
315
- pendingHeartbeats.set(claimId, { resolve, reject, timer });
316
- attached?.send({
317
- type: 'claim_heartbeat',
318
- payload: {
319
- claimId,
320
- entityType: claim.entityType,
321
- entityId: claim.entityId,
322
- ...(options.ttl !== undefined ? { ttlMs: toMs(options.ttl) } : {}),
323
- ...(options.details !== undefined ? { details: options.details } : {}),
324
- },
325
- });
326
- });
327
- }
328
- function sendAbandon(claimId, claim) {
329
- if (!attached?.isConnected())
330
- return;
331
- // Carry the target so the server can dequeue us if we were only *waiting*
332
- // (a queued claim isn't in the holder set it would otherwise scan). Held
333
- // claims are found by claimId regardless; the target is harmless there.
334
- attached.send({
335
- type: 'claim_abandon',
336
- payload: {
337
- claimId,
338
- entityType: claim?.entityType,
339
- entityId: claim?.entityId,
340
- },
341
- });
342
- }
343
- function mintHandle(args) {
344
- const claimId = crypto.randomUUID();
345
- const estimatedMs = args.ttl !== undefined ? toMs(args.ttl) : undefined;
346
- const claim = {
347
- entityType: args.entityType,
348
- entityId: args.entityId,
349
- path: args.path,
350
- range: args.range,
351
- field: args.field,
352
- meta: args.meta,
353
- description: args.description,
354
- estimatedMs,
355
- queue: args.queue,
356
- };
357
- ownClaims.set(claimId, claim);
358
- sendBegin(claimId, claim);
359
- // Coordination trace (info): the creator can see their human/agent claims.
360
- getContext().logger.info(`claim: requesting ${claimLabel(claim.entityType, claim.entityId, claim.field)} for "${claim.description}"` +
361
- (claim.queue ? ' (will queue if contended)' : ''), { claimId });
362
- let revoked = false;
363
- const revoke = () => {
364
- if (revoked)
365
- return;
366
- revoked = true;
367
- ownClaims.delete(claimId);
368
- sendAbandon(claimId, claim);
369
- getContext().logger.info(`claim: released ${claimLabel(claim.entityType, claim.entityId, claim.field)}`, { claimId });
370
- };
371
- return {
372
- object: 'claim',
373
- id: claimId,
374
- status: 'active',
375
- description: args.description,
376
- target: {
377
- type: args.entityType,
378
- id: args.entityId,
379
- path: args.path,
380
- range: args.range,
381
- field: args.field,
382
- meta: args.meta,
383
- },
384
- release: async () => {
385
- revoke();
386
- },
387
- revoke,
388
- heartbeat: (options) => sendHeartbeat(claimId, claim, resolveHeartbeatOptions(options)),
389
- [Symbol.asyncDispose]: async () => {
390
- revoke();
391
- },
392
- };
393
- }
394
- function resolveTarget(target) {
395
- if (Array.isArray(target))
396
- return { type: target[0], id: target[1] };
397
- return target;
398
- }
399
- return {
400
- claim(target, opts) {
401
- const resolved = resolveTarget(target);
402
- return mintHandle({
403
- entityType: resolved.type,
404
- entityId: resolved.id,
405
- path: resolved.path,
406
- range: resolved.range,
407
- field: resolved.field,
408
- meta: resolved.meta,
409
- description: opts?.description ?? 'editing',
410
- ttl: opts?.ttl,
411
- queue: opts?.queue,
412
- });
413
- },
414
- get others() {
415
- return claimsSnapshot;
416
- },
417
- queueFor(target) {
418
- const ref = resolveTarget(target);
419
- return queueByEntity.get(entityKey(ref.type, ref.id)) ?? EMPTY_QUEUE;
420
- },
421
- reorder(target, order) {
422
- const ref = resolveTarget(target);
423
- sendReorder(ref.type, ref.id, order);
424
- },
425
- onChange: (listener) => {
426
- listeners.add(listener);
427
- return () => {
428
- listeners.delete(listener);
429
- };
430
- },
431
- onRejected: (listener) => {
432
- rejectionListeners.add(listener);
433
- return () => {
434
- rejectionListeners.delete(listener);
435
- };
436
- },
437
- onLost: (listener) => {
438
- lostListeners.add(listener);
439
- return () => {
440
- lostListeners.delete(listener);
441
- };
442
- },
443
- [Symbol.asyncIterator]() {
444
- return asyncIteratorFrom((onChange) => {
445
- listeners.add(onChange);
446
- return () => {
447
- listeners.delete(onChange);
448
- };
449
- }, () => claimsSnapshot);
450
- },
451
- attach,
452
- dispose() {
453
- for (const off of unsubs)
454
- off();
455
- unsubs.length = 0;
456
- for (const claimId of [...pendingHeartbeats.keys()]) {
457
- settleHeartbeat(claimId, ({ reject }) => {
458
- reject(new AbloConnectionError('The claim stream was disposed while this heartbeat was awaiting its reply.'));
459
- });
460
- }
461
- listeners.clear();
462
- rejectionListeners.clear();
463
- lostListeners.clear();
464
- activeByClaimId.clear();
465
- ownClaims.clear();
466
- queueByEntity.clear();
467
- claimsSnapshot = Object.freeze([]);
468
- attached = null;
469
- },
470
- };
471
- }
7
+ export { createClaimStream, } from '../transaction/coordination/createClaimStream.js';
@@ -22,8 +22,17 @@
22
22
  * • Inbound — the same frame, with `kind` one of `enter`, `update`, or
23
23
  * `leave`.
24
24
  */
25
- import type { SyncWebSocket } from './SyncWebSocket.js';
26
- import type { PresenceStream } from '../types/streams.js';
25
+ import type { WsTransport } from '../transaction/transport/wsTransport.js';
26
+ import type { PresenceStream } from '../transaction/types/streams.js';
27
+ import type { ParticipantKind } from '../transaction/types/participant.js';
28
+ /**
29
+ * The wire capability the presence stream actually uses: subscribe to typed
30
+ * inbound frames, check liveness, and send outbound frames. The duplex
31
+ * `WsTransport` satisfies it — the same port shape the claim stream depends
32
+ * on — so the stream can attach to whatever connection the host built,
33
+ * without naming the engine's subclass.
34
+ */
35
+ export type PresenceTransport = Pick<WsTransport, 'subscribe' | 'isConnected' | 'send'>;
27
36
  export interface PresenceStreamConfig {
28
37
  /** Identity used to filter our own echoed frames out of `others`. */
29
38
  participantId: string;
@@ -40,8 +49,21 @@ export interface PresenceStreamConfig {
40
49
  export interface AttachablePresenceStream extends PresenceStream {
41
50
  /** Wire the stream to a now-ready transport. Calls before this are
42
51
  * buffered (self mutations only — no wire send). Idempotent. */
43
- attach(transport: SyncWebSocket): void;
52
+ attach(transport: PresenceTransport): void;
53
+ /**
54
+ * Seeds the participant identity once the host resolves it. The stream can
55
+ * be built before identity is known — a hosted client learns who it is
56
+ * from its credential's scope during connect — and until then the
57
+ * construction-time values (possibly empty) would leave the `self` entry
58
+ * blank and let the participant's own echoed frames into `others`. Updates
59
+ * the `self` entry in place, so held references see the resolved identity.
60
+ */
61
+ setParticipant(participant: {
62
+ id: string;
63
+ kind?: ParticipantKind;
64
+ syncGroups?: readonly string[];
65
+ }): void;
44
66
  /** Tear down listeners. Stream object stays usable as a no-op. */
45
67
  dispose(): void;
46
68
  }
47
- export declare function createPresenceStream(config: PresenceStreamConfig, transport?: SyncWebSocket | null): AttachablePresenceStream;
69
+ export declare function createPresenceStream(config: PresenceStreamConfig, transport?: PresenceTransport | null): AttachablePresenceStream;
@@ -22,10 +22,14 @@
22
22
  * • Inbound — the same frame, with `kind` one of `enter`, `update`, or
23
23
  * `leave`.
24
24
  */
25
- import { asyncIteratorFrom } from '../utils/asyncIterator.js';
26
- import { participantKindFromWire } from '../coordination/schema.js';
25
+ import { asyncIteratorFrom } from '../transaction/utils/asyncIterator.js';
26
+ import { participantKindFromWire } from '../transaction/coordination/schema.js';
27
+ import { isTargetTuple, subTarget, wireTarget } from '../transaction/coordination/index.js';
27
28
  export function createPresenceStream(config, transport = null) {
28
- const { participantId, label, syncGroups, isAgent = false } = config;
29
+ const { label, syncGroups, isAgent = false } = config;
30
+ // Mutable: the host seeds the resolved identity via `setParticipant` once
31
+ // it is known; the own-echo filter always reads the current value.
32
+ let participantId = config.participantId;
29
33
  // ── Self ─────────────────────────────────────────────────────────
30
34
  const self = {
31
35
  participantKind: isAgent ? 'agent' : 'user',
@@ -81,23 +85,23 @@ export function createPresenceStream(config, transport = null) {
81
85
  if (othersById.delete(event.userId))
82
86
  notifyListeners();
83
87
  return;
88
+ // No `undefined` arm: every site that builds a presence frame stamps
89
+ // `kind`, and the schema now says so, so an unlabelled frame is not a
90
+ // shape the transport can hand us.
84
91
  case 'enter':
85
- case 'update':
86
- case undefined: {
92
+ case 'update': {
87
93
  const entry = {
88
94
  participantKind: participantKindFromWire(event.participantKind, event.isAgent),
89
95
  participantId: event.userId,
90
96
  syncGroups: event.syncGroups ?? [],
91
97
  activity: event.activity
92
98
  ? {
93
- entityType: event.activity.entityType,
94
- entityId: event.activity.entityId,
95
- path: event.activity.path,
96
- range: event.activity.range,
97
- field: event.activity.field,
98
- meta: event.activity.meta,
99
+ ...wireTarget(event.activity),
100
+ ...subTarget(event.activity),
99
101
  action: event.activity.action,
100
- detail: event.activity.detail,
102
+ ...(event.activity.detail !== undefined
103
+ ? { detail: event.activity.detail }
104
+ : {}),
101
105
  }
102
106
  : { entityType: 'Unknown', entityId: '', action: event.status },
103
107
  lastActive: event.timestamp
@@ -134,17 +138,12 @@ export function createPresenceStream(config, transport = null) {
134
138
  sendUpdate(activity);
135
139
  }
136
140
  function resolveTarget(target) {
137
- if (Array.isArray(target)) {
141
+ if (isTargetTuple(target)) {
138
142
  return { entityType: target[0], entityId: target[1], action: 'unknown' };
139
143
  }
140
- const obj = target;
141
144
  return {
142
- entityType: obj.type,
143
- entityId: obj.id,
144
- path: obj.path,
145
- range: obj.range,
146
- field: obj.field,
147
- meta: obj.meta,
145
+ ...wireTarget(target),
146
+ ...subTarget(target),
148
147
  action: 'unknown',
149
148
  };
150
149
  }
@@ -179,6 +178,15 @@ export function createPresenceStream(config, transport = null) {
179
178
  }, () => othersSnapshot);
180
179
  },
181
180
  attach,
181
+ setParticipant(participant) {
182
+ participantId = participant.id;
183
+ const writable = self;
184
+ writable.participantId = participant.id;
185
+ if (participant.kind)
186
+ writable.participantKind = participant.kind;
187
+ if (participant.syncGroups)
188
+ writable.syncGroups = [...participant.syncGroups];
189
+ },
182
190
  dispose() {
183
191
  for (const off of unsubs)
184
192
  off();
@@ -12,9 +12,9 @@
12
12
  * existing sync connection — no second connection.
13
13
  */
14
14
  import type { InstanceCache } from '../InstanceCache.js';
15
- import type { Schema } from '../schema/schema.js';
15
+ import type { Schema } from '../transaction/schema/schema.js';
16
16
  import type { SyncWebSocket } from './SyncWebSocket.js';
17
- import type { Snapshot } from '../types/streams.js';
17
+ import type { Snapshot } from '../transaction/types/streams.js';
18
18
  export interface CreateSnapshotArgs<TSchema extends Schema = Schema, K extends keyof TSchema['models'] & string = keyof TSchema['models'] & string> {
19
19
  pool: InstanceCache;
20
20
  /** Live transport for delta subscriptions. May be null if the engine
@@ -11,7 +11,7 @@
11
11
  * current `lastSyncId` as the watermark, and subscribes to delta frames on the
12
12
  * existing sync connection — no second connection.
13
13
  */
14
- import { AbloValidationError } from '../errors.js';
14
+ import { AbloValidationError } from '../transaction/errors.js';
15
15
  import { Model, modelAsRow } from '../Model.js';
16
16
  /**
17
17
  * The snapshot result exposes `stamp`, `signal`, and `onChange` at its top