@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,52 @@
1
+ /**
2
+ * A claim's application metadata, crossing between the wire and the shape the
3
+ * program declared for it.
4
+ *
5
+ * The wire contract for `meta` is deliberately permissive — `targetRefSchema`
6
+ * parses it as `z.record(z.string(), z.unknown())` and always will, because a
7
+ * newer peer must be able to send a field this build has never heard of and
8
+ * still be understood. The read surface is the opposite: `Register`'s
9
+ * `ClaimMeta` slot names the one shape this program's claims carry, so
10
+ * `claim.state({ id })?.target.meta` reads without a guard.
11
+ *
12
+ * Those two facts meet here, and only here, in both directions. A decode calls
13
+ * {@link declaredMeta} on its way from a parsed record to a public `Claim`; the
14
+ * locator projection calls {@link wireMeta} on the way back out, where a
15
+ * caller's declared value is put on the socket or in the HTTP body. Between
16
+ * them they are the one place the SDK takes the caller's word for a shape it
17
+ * did not check — written down once, with the reason, instead of being asserted
18
+ * at each crossing.
19
+ *
20
+ * The two directions are not symmetric in cost. Losing the declared shape on
21
+ * the way out is harmless, because the wire has always accepted any record;
22
+ * gaining it on the way in is the promise the read surface makes, so
23
+ * `declaredMeta` is the one to audit when a claim reads back a shape its holder
24
+ * never wrote.
25
+ */
26
+ /**
27
+ * Read a parsed `meta` as the declared shape. Call it only where a decode hands
28
+ * a wire value to a public claim, and only for a value already known present —
29
+ * the absent case is an omitted member, not a declared-shaped `undefined`.
30
+ *
31
+ * The exported names are `declaredMeta` and `wireMeta` rather than a `claimMeta`
32
+ * pair because two claim surfaces already read a caller's `meta` back off the
33
+ * options it passed in, and spell that local reader `claimMeta`.
34
+ */
35
+ export function declaredMeta(raw) {
36
+ return raw;
37
+ }
38
+ /**
39
+ * Write a declared `meta` as the permissive record the wire carries. Every path
40
+ * from a caller's target to a frame or request body goes through `subTarget`,
41
+ * so this has exactly one caller — widening it is how the declared shape stops
42
+ * being a compile error at the edge of the protocol instead of stopping there.
43
+ *
44
+ * The parameter is `unknown` rather than {@link ResolveClaimMeta} on purpose: a
45
+ * program may register an `interface` for its claim metadata, and an interface
46
+ * carries no implicit index signature, so a directly-typed parameter would make
47
+ * the conversion itself unrepresentable at the one site that needs it. Widening
48
+ * the input is what keeps the assertion single.
49
+ */
50
+ export function wireMeta(meta) {
51
+ return meta;
52
+ }
@@ -0,0 +1,64 @@
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.
23
+ */
24
+ import type { WsTransport } from '../transport/wsTransport.js';
25
+ import type { ClaimOptions, Claim, ClaimStream, PresenceTarget } from '../types/streams.js';
26
+ import { type Logger } from '../logger.js';
27
+ /**
28
+ * The wire capability the claim stream actually uses: subscribe to typed
29
+ * inbound frames, check liveness, and send outbound frames. The duplex
30
+ * `WsTransport` satisfies it, so production wiring is unchanged — but depending on the port
31
+ * rather than the whole socket class lets a test drive it with a plain object,
32
+ * no cast. `Pick` carries the exact (generic, typed-payload) `subscribe`
33
+ * signature, so every handler stays fully typed.
34
+ */
35
+ export type ClaimTransport = Pick<WsTransport, 'subscribe' | 'isConnected' | 'send'>;
36
+ export interface ClaimStreamConfig {
37
+ /** Identity used to filter our own active claims out of `others`. */
38
+ participantId: string;
39
+ /** Where the coordination trace is logged. Defaults to silent. */
40
+ logger?: Logger;
41
+ }
42
+ export interface AttachableClaimStream extends ClaimStream {
43
+ /**
44
+ * Mints a lease directly: sends the `claim_begin` frame and returns a held
45
+ * {@link Claim} that carries no row `data` (the resource layer reads the row
46
+ * and stamps it). This is an internal entry point, not part of the public
47
+ * {@link ClaimStream}; application code takes a claim through
48
+ * `ablo.<model>.claim({ id })`, which is built on this.
49
+ */
50
+ claim(target: PresenceTarget, opts?: ClaimOptions): Claim;
51
+ attach(transport: ClaimTransport): void;
52
+ /**
53
+ * Seeds the participant identity once the host resolves it. The stream can
54
+ * be built before identity is known — a hosted client learns who it is
55
+ * from its credential's scope during connect — and until then the
56
+ * construction-time id (possibly empty) would let the participant's own
57
+ * claims into `others`. Idempotent; later frames filter on the new id.
58
+ */
59
+ setParticipant(participant: {
60
+ id: string;
61
+ }): void;
62
+ dispose(): void;
63
+ }
64
+ export declare function createClaimStream(config: ClaimStreamConfig, transport?: ClaimTransport | null): AttachableClaimStream;
@@ -0,0 +1,475 @@
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.
23
+ */
24
+ import { asyncIteratorFrom } from '../utils/asyncIterator.js';
25
+ import { toMs } from '../utils/duration.js';
26
+ import { claimDescription, descriptionFromMeta, participantKindFromWire, } from './schema.js';
27
+ import { isTargetTuple, subTarget, streamTarget, wireTarget, } from './locator.js';
28
+ import { declaredMeta } from './claimMeta.js';
29
+ import { AbloClaimedError, AbloConnectionError } from '../errors.js';
30
+ import { resolveHeartbeatOptions } from './claimHeartbeatLoop.js';
31
+ import { noopLogger } from '../logger.js';
32
+ /** Readable target for the coordination trace: `documents:abc` / `documents:abc.title`. */
33
+ function claimLabel(type, id, field) {
34
+ return field ? `${type}:${id}.${field}` : `${type}:${id}`;
35
+ }
36
+ /**
37
+ * How long a heartbeat waits for its `claim_heartbeat_ack` before giving up
38
+ * as transient (the auto-heartbeat loop's next tick retries). Comfortably
39
+ * above a round trip, comfortably below the ttl/3 beat cadence.
40
+ */
41
+ const HEARTBEAT_ACK_TIMEOUT_MS = 10_000;
42
+ export function createClaimStream(config, transport = null) {
43
+ // Mutable: the host seeds the resolved identity via `setParticipant` once
44
+ // it is known; the own-claim filter always reads the current value.
45
+ let participantId = config.participantId;
46
+ const logger = config.logger ?? noopLogger;
47
+ // ── State: others' open claims, keyed by claimId ───────────────
48
+ const activeByClaimId = new Map();
49
+ let claimsSnapshot = Object.freeze([]);
50
+ // ── State: our own open claims (for re-announce on reconnect) ───
51
+ const ownClaims = new Map();
52
+ // ── State: per-entity wait queues, from `claim_queue` frames ────
53
+ // Keyed `type:id`; the value is the FIFO line of queued claims. Powers
54
+ // the reactive `queue(target)` read — who's waiting and what they intend.
55
+ const queueByEntity = new Map();
56
+ const entityKey = (type, id) => `${type}:${id}`;
57
+ const EMPTY_QUEUE = Object.freeze([]);
58
+ // Last queue position we logged per own-claim, so advancing in line is traced
59
+ // once per change (not re-logged on every server re-fan of the same line).
60
+ const lastLoggedQueuePos = new Map();
61
+ // ── Subscribers ──────────────────────────────────────────────────
62
+ const listeners = new Set();
63
+ const rejectionListeners = new Set();
64
+ const lostListeners = new Set();
65
+ // ── State: in-flight heartbeats awaiting their ack, keyed by claimId ──
66
+ const pendingHeartbeats = new Map();
67
+ const settleHeartbeat = (claimId, settle) => {
68
+ const pending = pendingHeartbeats.get(claimId);
69
+ if (!pending)
70
+ return;
71
+ pendingHeartbeats.delete(claimId);
72
+ clearTimeout(pending.timer);
73
+ settle(pending);
74
+ };
75
+ const notifyListeners = () => {
76
+ claimsSnapshot = Object.freeze(Array.from(activeByClaimId.values()));
77
+ for (const l of listeners) {
78
+ try {
79
+ l();
80
+ }
81
+ catch {
82
+ /* listener errors don't break siblings */
83
+ }
84
+ }
85
+ };
86
+ // ── Wire wiring ──────────────────────────────────────────────────
87
+ let attached = null;
88
+ const unsubs = [];
89
+ function attach(t) {
90
+ if (attached)
91
+ return;
92
+ attached = t;
93
+ // (1) Inbound presence frames carry every participant's full
94
+ // active-claim set. Prune previous claims by holder, then
95
+ // re-add from the frame — the frame is authoritative for that
96
+ // participant's open claims at that moment.
97
+ unsubs.push(t.subscribe('presence_update', (event) => {
98
+ if (!event.userId)
99
+ return;
100
+ if (event.userId === participantId)
101
+ return;
102
+ let mutated = false;
103
+ if (event.kind === 'leave') {
104
+ for (const [id, claim] of activeByClaimId) {
105
+ if (claim.heldBy === event.userId) {
106
+ activeByClaimId.delete(id);
107
+ mutated = true;
108
+ }
109
+ }
110
+ if (mutated)
111
+ notifyListeners();
112
+ return;
113
+ }
114
+ for (const [id, claim] of activeByClaimId) {
115
+ if (claim.heldBy === event.userId) {
116
+ activeByClaimId.delete(id);
117
+ mutated = true;
118
+ }
119
+ }
120
+ for (const claim of event.activeClaims ?? []) {
121
+ // Terminal-status entries (committed / expired / canceled) are
122
+ // one-shot "this claim ended" signals. The holder sweep above
123
+ // already removed the prior active entry; skipping the re-add
124
+ // drops it from `others`, which is what resolves a contender's
125
+ // `settled()`. Absent status means active (wire back-compat).
126
+ if (claim.status && claim.status !== 'active')
127
+ continue;
128
+ // Resolve the always-present public field, tolerating a frame that
129
+ // carries the value in `meta` rather than as an explicit description.
130
+ const description = claim.description ??
131
+ descriptionFromMeta(claim.meta) ??
132
+ 'editing';
133
+ // The frame is parsed permissively, on purpose; `declaredMeta` is where
134
+ // that wire value becomes the shape the program declared.
135
+ const { meta, ...details } = subTarget(claim);
136
+ activeByClaimId.set(claim.claimId, {
137
+ object: 'claim',
138
+ id: claim.claimId,
139
+ status: 'active',
140
+ heldBy: event.userId,
141
+ participantKind: participantKindFromWire(event.participantKind, event.isAgent),
142
+ target: {
143
+ ...streamTarget(claim),
144
+ ...details,
145
+ ...(meta !== undefined ? { meta: declaredMeta(meta) } : {}),
146
+ },
147
+ description,
148
+ ttlSeconds: Math.max(0, Math.floor((claim.expiresAt - Date.now()) / 1000)),
149
+ createdAt: claim.declaredAt,
150
+ expiresAt: claim.expiresAt,
151
+ });
152
+ mutated = true;
153
+ }
154
+ if (mutated)
155
+ notifyListeners();
156
+ }));
157
+ // (2) Server-side rejection frames.
158
+ unsubs.push(t.subscribe('claim_rejected', (rejection) => {
159
+ if (!rejection.claimId)
160
+ return;
161
+ if (ownClaims.has(rejection.claimId)) {
162
+ const tgt = rejection.target
163
+ ? claimLabel(rejection.target.entityType, rejection.target.entityId, rejection.target.field)
164
+ : rejection.claimId;
165
+ logger.info(`claim: rejected ${tgt}${rejection.heldBy ? ` — held by ${rejection.heldBy}` : ''}`, { claimId: rejection.claimId, reason: rejection.reason });
166
+ }
167
+ // Drop the rejected own-claim so reconnect doesn't re-announce
168
+ // a claim the server already rejected (would just spam both
169
+ // sides with conflicts).
170
+ ownClaims.delete(rejection.claimId);
171
+ for (const l of rejectionListeners) {
172
+ try {
173
+ l(rejection);
174
+ }
175
+ catch {
176
+ /* isolate */
177
+ }
178
+ }
179
+ }));
180
+ // (2a) Server-side loss frames — you held the claim, then lost it
181
+ // (preempted or expired). Distinct from a rejection, which is a claim
182
+ // the server refused.
183
+ unsubs.push(
184
+ // The frame is validated by the transport's dispatcher against the same
185
+ // schema this parameter's type comes from, so it arrives proven.
186
+ t.subscribe('claim_lost', (lost) => {
187
+ if (ownClaims.has(lost.claimId)) {
188
+ const c = ownClaims.get(lost.claimId);
189
+ logger.info(`claim: lost ${c ? claimLabel(c.entityType, c.entityId, c.field) : lost.claimId} (preempted or expired)`, { claimId: lost.claimId });
190
+ }
191
+ // Drop the lost own-claim so reconnect doesn't re-announce a lease we
192
+ // no longer hold.
193
+ ownClaims.delete(lost.claimId);
194
+ for (const l of lostListeners) {
195
+ try {
196
+ l(lost);
197
+ }
198
+ catch {
199
+ /* isolate */
200
+ }
201
+ }
202
+ }));
203
+ // (2b) Per-entity wait-queue snapshots. The server fans the full line
204
+ // out on every queue mutation; we replace our cached line for that
205
+ // entity and notify so `queue(target)` reads reactively.
206
+ unsubs.push(t.subscribe('claim_queue', (p) => {
207
+ const key = entityKey(p.target.type, p.target.id);
208
+ const line = p.queue;
209
+ if (line.length === 0)
210
+ queueByEntity.delete(key);
211
+ else
212
+ // The wait line crosses from the wire into the public `Claim` shape
213
+ // like every other read does, so its meta goes through `declaredMeta`
214
+ // rather than arriving as the open record the frame was parsed as.
215
+ queueByEntity.set(key, Object.freeze(line.map((entry) => {
216
+ const { meta, ...target } = entry.target;
217
+ return {
218
+ ...entry,
219
+ target: {
220
+ ...target,
221
+ ...(meta !== undefined ? { meta: declaredMeta(meta) } : {}),
222
+ },
223
+ };
224
+ })));
225
+ // If we are in this line, trace our position (the "agent queued behind a
226
+ // claim" moment) — once per position change, so advancing is visible.
227
+ const ourIndex = line.findIndex((c) => ownClaims.has(c.id));
228
+ const ourClaim = ourIndex >= 0 ? line[ourIndex] : undefined;
229
+ if (ourClaim) {
230
+ const ourId = ourClaim.id;
231
+ if (lastLoggedQueuePos.get(ourId) !== ourIndex) {
232
+ lastLoggedQueuePos.set(ourId, ourIndex);
233
+ logger.info(`claim: queued for ${claimLabel(p.target.type, p.target.id)} — position ${ourIndex + 1} of ${line.length}, waiting`, { claimId: ourId });
234
+ }
235
+ }
236
+ notifyListeners();
237
+ }));
238
+ // (2c) Heartbeat replies — correlate back to the awaiting beat by
239
+ // claimId. `held` resolves with the extended expiry; `queued` and
240
+ // `lost` reject with a typed claimed error, because a heartbeat on
241
+ // a handle we thought we held coming back as anything but `held`
242
+ // means the lease is no longer ours.
243
+ unsubs.push(t.subscribe('claim_heartbeat_ack', (ack) => {
244
+ settleHeartbeat(ack.claimId, ({ resolve, reject }) => {
245
+ if (ack.status === 'held' && ack.expiresAt !== undefined) {
246
+ resolve({
247
+ expiresAt: ack.expiresAt,
248
+ ...(ack.queueDepth !== undefined
249
+ ? { queueDepth: ack.queueDepth }
250
+ : {}),
251
+ });
252
+ return;
253
+ }
254
+ const c = ownClaims.get(ack.claimId);
255
+ 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' }));
256
+ });
257
+ }));
258
+ // (3) On reconnect, re-announce every open self-claim — the
259
+ // server's claim state is in-memory and is lost across
260
+ // restarts. Without this, peers would see our claims vanish
261
+ // whenever the connection blipped.
262
+ unsubs.push(t.subscribe('connected', () => {
263
+ for (const [claimId, claim] of ownClaims) {
264
+ sendBegin(claimId, claim);
265
+ }
266
+ }));
267
+ }
268
+ if (transport)
269
+ attach(transport);
270
+ // ── Outbound ────────────────────────────────────────────────────
271
+ function sendBegin(claimId, claim) {
272
+ if (!attached?.isConnected())
273
+ return;
274
+ attached.send({
275
+ type: 'claim_begin',
276
+ payload: {
277
+ claimId,
278
+ ...wireTarget(claim),
279
+ description: claim.description,
280
+ ...subTarget(claim),
281
+ estimatedMs: claim.estimatedMs,
282
+ queue: claim.queue,
283
+ },
284
+ });
285
+ }
286
+ function sendReorder(entityType, entityId, order) {
287
+ if (!attached?.isConnected())
288
+ return;
289
+ attached.send({
290
+ type: 'claim_reorder',
291
+ payload: {
292
+ entityType,
293
+ entityId,
294
+ // The wire shape identifies a waiter by heldBy + claimId; map the
295
+ // ergonomic `Claim[]` (what `queueFor` returns) down to that.
296
+ order: order.map((i) => ({ heldBy: i.heldBy, claimId: i.id })),
297
+ },
298
+ });
299
+ }
300
+ /**
301
+ * Send one heartbeat and await its ack. Rejects with
302
+ * {@link AbloConnectionError} (transient — the auto-heartbeat loop retries
303
+ * on its next tick) when the socket is down or the ack times out, and with
304
+ * {@link AbloClaimedError} (definitive) when the server answers that the
305
+ * lease is no longer ours.
306
+ */
307
+ function sendHeartbeat(claimId, claim, options) {
308
+ if (!attached?.isConnected()) {
309
+ 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.`));
310
+ }
311
+ return new Promise((resolve, reject) => {
312
+ settleHeartbeat(claimId, ({ reject: rejectPrior }) => {
313
+ rejectPrior(new AbloConnectionError('A newer heartbeat for this claim superseded the one still awaiting its reply.'));
314
+ });
315
+ const timer = setTimeout(() => {
316
+ settleHeartbeat(claimId, ({ reject: rejectTimeout }) => {
317
+ 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.`));
318
+ });
319
+ }, HEARTBEAT_ACK_TIMEOUT_MS);
320
+ pendingHeartbeats.set(claimId, { resolve, reject, timer });
321
+ attached?.send({
322
+ type: 'claim_heartbeat',
323
+ payload: {
324
+ claimId,
325
+ entityType: claim.entityType,
326
+ entityId: claim.entityId,
327
+ ...(options.ttl !== undefined ? { ttlMs: toMs(options.ttl) } : {}),
328
+ ...(options.details !== undefined ? { details: options.details } : {}),
329
+ },
330
+ });
331
+ });
332
+ }
333
+ function sendAbandon(claimId, claim) {
334
+ if (!attached?.isConnected())
335
+ return;
336
+ // Carry the target so the server can dequeue us if we were only *waiting*
337
+ // (a queued claim isn't in the holder set it would otherwise scan). Held
338
+ // claims are found by claimId regardless; the target is harmless there.
339
+ attached.send({
340
+ type: 'claim_abandon',
341
+ payload: {
342
+ claimId,
343
+ entityType: claim?.entityType,
344
+ entityId: claim?.entityId,
345
+ },
346
+ });
347
+ }
348
+ // The locator half derives from `OwnClaim` rather than being restated: a
349
+ // member spelled out here is a member that dies before `sendBegin`, which is
350
+ // how `fields` used to be lost between `claim()` and the socket.
351
+ function mintHandle(args) {
352
+ const claimId = crypto.randomUUID();
353
+ const estimatedMs = args.ttl !== undefined ? toMs(args.ttl) : undefined;
354
+ // The handle the caller reads back is a public claim, so its `meta` is the
355
+ // declared shape; the `OwnClaim` below stays wire-typed, because that is
356
+ // what goes on the socket.
357
+ const { meta, ...details } = subTarget(args);
358
+ const claim = {
359
+ ...wireTarget(args),
360
+ ...subTarget(args),
361
+ description: args.description,
362
+ estimatedMs,
363
+ queue: args.queue,
364
+ };
365
+ ownClaims.set(claimId, claim);
366
+ sendBegin(claimId, claim);
367
+ // Coordination trace (info): the creator can see their human/agent claims.
368
+ logger.info(`claim: requesting ${claimLabel(claim.entityType, claim.entityId, claim.field)} for "${claim.description}"` +
369
+ (claim.queue ? ' (will queue if contended)' : ''), { claimId });
370
+ let revoked = false;
371
+ const revoke = () => {
372
+ if (revoked)
373
+ return;
374
+ revoked = true;
375
+ ownClaims.delete(claimId);
376
+ sendAbandon(claimId, claim);
377
+ logger.info(`claim: released ${claimLabel(claim.entityType, claim.entityId, claim.field)}`, { claimId });
378
+ };
379
+ return {
380
+ object: 'claim',
381
+ id: claimId,
382
+ status: 'active',
383
+ description: args.description,
384
+ target: {
385
+ ...streamTarget(args),
386
+ ...details,
387
+ ...(meta !== undefined ? { meta: declaredMeta(meta) } : {}),
388
+ },
389
+ release: async () => {
390
+ revoke();
391
+ },
392
+ revoke,
393
+ heartbeat: (options) => sendHeartbeat(claimId, claim, resolveHeartbeatOptions(options)),
394
+ [Symbol.asyncDispose]: async () => {
395
+ revoke();
396
+ },
397
+ };
398
+ }
399
+ function resolveTarget(target) {
400
+ if (isTargetTuple(target))
401
+ return { type: target[0], id: target[1] };
402
+ return target;
403
+ }
404
+ return {
405
+ claim(target, opts) {
406
+ const resolved = resolveTarget(target);
407
+ return mintHandle({
408
+ ...wireTarget(resolved),
409
+ ...subTarget(resolved),
410
+ description: claimDescription({ ...opts, meta: resolved.meta }),
411
+ ttl: opts?.ttl,
412
+ queue: opts?.queue,
413
+ });
414
+ },
415
+ get others() {
416
+ return claimsSnapshot;
417
+ },
418
+ queueFor(target) {
419
+ const ref = resolveTarget(target);
420
+ return queueByEntity.get(entityKey(ref.type, ref.id)) ?? EMPTY_QUEUE;
421
+ },
422
+ reorder(target, order) {
423
+ const ref = resolveTarget(target);
424
+ sendReorder(ref.type, ref.id, order);
425
+ },
426
+ onChange: (listener) => {
427
+ listeners.add(listener);
428
+ return () => {
429
+ listeners.delete(listener);
430
+ };
431
+ },
432
+ onRejected: (listener) => {
433
+ rejectionListeners.add(listener);
434
+ return () => {
435
+ rejectionListeners.delete(listener);
436
+ };
437
+ },
438
+ onLost: (listener) => {
439
+ lostListeners.add(listener);
440
+ return () => {
441
+ lostListeners.delete(listener);
442
+ };
443
+ },
444
+ [Symbol.asyncIterator]() {
445
+ return asyncIteratorFrom((onChange) => {
446
+ listeners.add(onChange);
447
+ return () => {
448
+ listeners.delete(onChange);
449
+ };
450
+ }, () => claimsSnapshot);
451
+ },
452
+ attach,
453
+ setParticipant(participant) {
454
+ participantId = participant.id;
455
+ },
456
+ dispose() {
457
+ for (const off of unsubs)
458
+ off();
459
+ unsubs.length = 0;
460
+ for (const claimId of [...pendingHeartbeats.keys()]) {
461
+ settleHeartbeat(claimId, ({ reject }) => {
462
+ reject(new AbloConnectionError('The claim stream was disposed while this heartbeat was awaiting its reply.'));
463
+ });
464
+ }
465
+ listeners.clear();
466
+ rejectionListeners.clear();
467
+ lostListeners.clear();
468
+ activeByClaimId.clear();
469
+ ownClaims.clear();
470
+ queueByEntity.clear();
471
+ claimsSnapshot = Object.freeze([]);
472
+ attached = null;
473
+ },
474
+ };
475
+ }
@@ -0,0 +1,74 @@
1
+ /**
2
+ * In-process observation events emitted by the transaction layer's
3
+ * coordination protocol. The wire claim and stale-write contracts live in
4
+ * `coordination/schema.ts`; these two projections are the stable event shapes
5
+ * an observer receives after those frames have been interpreted.
6
+ */
7
+ import type { ParticipantKind } from '../types/participant.js';
8
+ export type { ClaimEventReason } from './schema.js';
9
+ import type { ClaimEventReason } from './schema.js';
10
+ /** The participant that blocked a claim — present on `rejected`. */
11
+ export interface ClaimCounterparty {
12
+ /** Who holds it. */
13
+ actor?: string;
14
+ /**
15
+ * Whether the holder is a person, an agent, or the system — the distinction
16
+ * a caller acts on, since yielding to a person and queueing behind an agent
17
+ * are different decisions. It lives here rather than on the event because
18
+ * only a counterparty has a kind worth reporting: on an acquisition the
19
+ * participant is you, and you already know what you are.
20
+ */
21
+ participantKind?: ParticipantKind;
22
+ /** The lease they hold, so a caller can poll or wait on it by id. */
23
+ claimId?: string;
24
+ /** When their lease lapses without a heartbeat. */
25
+ expiresAt?: number;
26
+ /** What they said they were doing — prose, for a person to read. */
27
+ description?: string;
28
+ }
29
+ /** A single state transition in the lifecycle of a claim. */
30
+ export interface ClaimEvent {
31
+ phase: 'acquired' | 'queued' | 'granted' | 'lost' | 'rejected' | 'expired';
32
+ claimId?: string;
33
+ model?: string;
34
+ id?: string;
35
+ field?: string;
36
+ actor?: string;
37
+ position?: number;
38
+ /**
39
+ * What this claim's holder said they were doing — prose, written for a
40
+ * person. Separate from {@link ClaimEvent.reason}, which is machine-readable
41
+ * and only ever says why a claim ended. One field used to carry both, so an
42
+ * `acquired` event's "reason" was really a description and a `rejected`
43
+ * event's was really a cause.
44
+ */
45
+ description?: string;
46
+ /** Why the claim ended or was refused. Absent while it is simply alive. */
47
+ reason?: ClaimEventReason;
48
+ /**
49
+ * A policy's own words when a policy decided the outcome — free text by
50
+ * nature, and kept beside the closed {@link ClaimEvent.reason} rather than
51
+ * collapsed into it.
52
+ */
53
+ policyReason?: string;
54
+ /**
55
+ * Who blocked this claim. Present on `rejected`, where the wire already
56
+ * carried the holder and this projection used to discard it.
57
+ */
58
+ heldBy?: ClaimCounterparty;
59
+ }
60
+ /** A committed notify-instead-of-abort stale-write collision. */
61
+ export interface ConflictEvent {
62
+ clientTxId: string;
63
+ rows: readonly {
64
+ model: string;
65
+ id: string;
66
+ fields: readonly string[];
67
+ writtenBy?: ParticipantKind;
68
+ }[];
69
+ }
70
+ /** The narrow behavior a transaction-layer coordination observer implements. */
71
+ export interface CoordinationObserver {
72
+ captureClaim(event: ClaimEvent): void;
73
+ captureConflict(event: ConflictEvent): void;
74
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * In-process observation events emitted by the transaction layer's
3
+ * coordination protocol. The wire claim and stale-write contracts live in
4
+ * `coordination/schema.ts`; these two projections are the stable event shapes
5
+ * an observer receives after those frames have been interpreted.
6
+ */
7
+ export {};