@abloatai/ablo 0.26.0 → 0.27.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 (398) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +101 -85
  3. package/dist/BaseSyncedStore.d.ts +85 -88
  4. package/dist/BaseSyncedStore.js +131 -147
  5. package/dist/Database.d.ts +54 -68
  6. package/dist/Database.js +97 -113
  7. package/dist/{ObjectPool.d.ts → InstanceCache.d.ts} +10 -13
  8. package/dist/{ObjectPool.js → InstanceCache.js} +85 -83
  9. package/dist/LazyReferenceCollection.d.ts +11 -15
  10. package/dist/LazyReferenceCollection.js +12 -16
  11. package/dist/Model.d.ts +37 -52
  12. package/dist/Model.js +46 -61
  13. package/dist/ModelRegistry.d.ts +21 -19
  14. package/dist/ModelRegistry.js +23 -27
  15. package/dist/NetworkMonitor.d.ts +5 -6
  16. package/dist/NetworkMonitor.js +5 -6
  17. package/dist/SyncClient.d.ts +112 -112
  18. package/dist/SyncClient.js +165 -172
  19. package/dist/adapters/alwaysOnline.d.ts +6 -8
  20. package/dist/adapters/alwaysOnline.js +6 -8
  21. package/dist/adapters/inMemoryStorage.d.ts +9 -9
  22. package/dist/adapters/inMemoryStorage.js +9 -9
  23. package/dist/agent/Agent.d.ts +27 -32
  24. package/dist/agent/Agent.js +18 -19
  25. package/dist/agent/index.d.ts +4 -4
  26. package/dist/agent/index.js +5 -5
  27. package/dist/agent/session.d.ts +47 -44
  28. package/dist/agent/session.js +37 -48
  29. package/dist/agent/types.d.ts +26 -31
  30. package/dist/agent/types.js +6 -7
  31. package/dist/ai-sdk/coordinatedTool.d.ts +108 -0
  32. package/dist/ai-sdk/{coordinated-tool.js → coordinatedTool.js} +44 -38
  33. package/dist/ai-sdk/coordinationContext.d.ts +46 -0
  34. package/dist/ai-sdk/{coordination-context.js → coordinationContext.js} +26 -33
  35. package/dist/ai-sdk/index.d.ts +25 -22
  36. package/dist/ai-sdk/index.js +25 -22
  37. package/dist/ai-sdk/wrap.d.ts +6 -7
  38. package/dist/ai-sdk/wrap.js +1 -1
  39. package/dist/auth/credentialPolicy.d.ts +69 -74
  40. package/dist/auth/credentialPolicy.js +51 -56
  41. package/dist/auth/credentialSource.d.ts +6 -5
  42. package/dist/auth/credentialSource.js +9 -10
  43. package/dist/auth/index.d.ts +59 -58
  44. package/dist/auth/index.js +31 -37
  45. package/dist/auth/schemas.d.ts +5 -4
  46. package/dist/auth/schemas.js +5 -4
  47. package/dist/batching/index.d.ts +19 -21
  48. package/dist/batching/index.js +14 -17
  49. package/dist/cli.cjs +167 -119
  50. package/dist/client/Ablo.d.ts +73 -73
  51. package/dist/client/Ablo.js +125 -160
  52. package/dist/client/ApiClient.d.ts +30 -19
  53. package/dist/client/ApiClient.js +133 -38
  54. package/dist/client/auth.d.ts +47 -47
  55. package/dist/client/auth.js +108 -117
  56. package/dist/client/claimHeartbeatLoop.d.ts +50 -0
  57. package/dist/client/claimHeartbeatLoop.js +88 -0
  58. package/dist/client/consoleLogger.d.ts +5 -6
  59. package/dist/client/consoleLogger.js +5 -6
  60. package/dist/client/createInternalComponents.d.ts +14 -17
  61. package/dist/client/createInternalComponents.js +25 -30
  62. package/dist/client/createModelProxy.d.ts +130 -120
  63. package/dist/client/createModelProxy.js +152 -122
  64. package/dist/client/credentialEndpoint.d.ts +40 -42
  65. package/dist/client/credentialEndpoint.js +35 -36
  66. package/dist/client/functionalUpdate.d.ts +29 -27
  67. package/dist/client/functionalUpdate.js +21 -21
  68. package/dist/client/hostedEndpoints.d.ts +9 -12
  69. package/dist/client/hostedEndpoints.js +9 -12
  70. package/dist/client/httpClient.d.ts +57 -53
  71. package/dist/client/httpClient.js +29 -31
  72. package/dist/client/identity.d.ts +15 -20
  73. package/dist/client/identity.js +47 -58
  74. package/dist/client/modelRegistration.d.ts +5 -9
  75. package/dist/client/modelRegistration.js +67 -87
  76. package/dist/client/options.d.ts +134 -157
  77. package/dist/client/options.js +3 -7
  78. package/dist/client/registerDataSource.d.ts +9 -9
  79. package/dist/client/registerDataSource.js +15 -16
  80. package/dist/client/resourceTypes.d.ts +64 -75
  81. package/dist/client/resourceTypes.js +4 -10
  82. package/dist/client/schemaConfig.d.ts +31 -43
  83. package/dist/client/schemaConfig.js +38 -50
  84. package/dist/client/sessionMint.d.ts +16 -12
  85. package/dist/client/sessionMint.js +26 -31
  86. package/dist/client/validateAbloOptions.d.ts +12 -14
  87. package/dist/client/validateAbloOptions.js +8 -9
  88. package/dist/client/writeOptionsSchema.d.ts +18 -16
  89. package/dist/client/writeOptionsSchema.js +23 -20
  90. package/dist/client/wsMutationExecutor.d.ts +15 -20
  91. package/dist/client/wsMutationExecutor.js +17 -23
  92. package/dist/context.d.ts +6 -4
  93. package/dist/context.js +6 -4
  94. package/dist/coordination/index.d.ts +10 -8
  95. package/dist/coordination/index.js +14 -12
  96. package/dist/coordination/schema.d.ts +176 -128
  97. package/dist/coordination/schema.js +197 -133
  98. package/dist/coordination/trace.d.ts +9 -10
  99. package/dist/coordination/trace.js +13 -14
  100. package/dist/core/DatabaseManager.d.ts +5 -7
  101. package/dist/core/DatabaseManager.js +15 -19
  102. package/dist/core/QueryProcessor.d.ts +7 -9
  103. package/dist/core/QueryProcessor.js +22 -28
  104. package/dist/core/QueryView.d.ts +8 -8
  105. package/dist/core/QueryView.js +2 -2
  106. package/dist/core/StoreManager.d.ts +12 -14
  107. package/dist/core/StoreManager.js +21 -24
  108. package/dist/core/ViewRegistry.d.ts +5 -5
  109. package/dist/core/ViewRegistry.js +4 -4
  110. package/dist/core/index.d.ts +17 -12
  111. package/dist/core/index.js +32 -26
  112. package/dist/core/openIDBWithTimeout.d.ts +38 -36
  113. package/dist/core/openIDBWithTimeout.js +42 -43
  114. package/dist/core/queryUtils.d.ts +45 -0
  115. package/dist/core/queryUtils.js +69 -0
  116. package/dist/core/storeContract.d.ts +63 -61
  117. package/dist/core/storeContract.js +8 -12
  118. package/dist/environment.d.ts +28 -0
  119. package/dist/environment.js +21 -0
  120. package/dist/errorCodes.d.ts +107 -99
  121. package/dist/errorCodes.js +131 -132
  122. package/dist/errors.d.ts +160 -166
  123. package/dist/errors.js +155 -158
  124. package/dist/index.d.ts +30 -27
  125. package/dist/index.js +89 -86
  126. package/dist/interfaces/index.d.ts +102 -113
  127. package/dist/interfaces/index.js +5 -4
  128. package/dist/keys/index.d.ts +27 -29
  129. package/dist/keys/index.js +41 -40
  130. package/dist/mutators/RecordingTransaction.d.ts +16 -16
  131. package/dist/mutators/RecordingTransaction.js +31 -37
  132. package/dist/mutators/Transaction.d.ts +18 -26
  133. package/dist/mutators/Transaction.js +14 -20
  134. package/dist/mutators/UndoManager.d.ts +122 -131
  135. package/dist/mutators/UndoManager.js +145 -156
  136. package/dist/mutators/defineMutators.d.ts +23 -34
  137. package/dist/mutators/defineMutators.js +14 -20
  138. package/dist/mutators/inverseOp.d.ts +12 -15
  139. package/dist/mutators/inverseOp.js +12 -15
  140. package/dist/mutators/mutateActions.d.ts +10 -9
  141. package/dist/mutators/mutateActions.js +1 -1
  142. package/dist/mutators/readerActions.d.ts +9 -8
  143. package/dist/mutators/readerActions.js +2 -2
  144. package/dist/mutators/undoApply.d.ts +31 -27
  145. package/dist/mutators/undoApply.js +26 -24
  146. package/dist/policy/index.d.ts +5 -3
  147. package/dist/policy/index.js +5 -3
  148. package/dist/policy/types.d.ts +104 -100
  149. package/dist/policy/types.js +67 -66
  150. package/dist/query/client.d.ts +28 -23
  151. package/dist/query/client.js +45 -43
  152. package/dist/query/types.d.ts +37 -60
  153. package/dist/query/types.js +13 -33
  154. package/dist/react/AbloProvider.d.ts +1 -1
  155. package/dist/react/AbloProvider.js +2 -2
  156. package/dist/react/context.d.ts +25 -28
  157. package/dist/react/context.js +9 -10
  158. package/dist/react/index.d.ts +41 -42
  159. package/dist/react/index.js +37 -38
  160. package/dist/react/internalContext.d.ts +17 -19
  161. package/dist/react/useAblo.d.ts +23 -22
  162. package/dist/react/useAblo.js +16 -14
  163. package/dist/react/useCurrentUserId.d.ts +8 -7
  164. package/dist/react/useCurrentUserId.js +8 -7
  165. package/dist/react/useErrorListener.d.ts +7 -7
  166. package/dist/react/useErrorListener.js +10 -11
  167. package/dist/react/useMutationFailureListener.d.ts +8 -8
  168. package/dist/react/useMutationFailureListener.js +8 -8
  169. package/dist/react/useMutators.d.ts +11 -11
  170. package/dist/react/useMutators.js +3 -3
  171. package/dist/react/useReactive.js +2 -2
  172. package/dist/react/useSyncStatus.d.ts +4 -6
  173. package/dist/react/useUndoScope.d.ts +7 -9
  174. package/dist/react/useUndoScope.js +1 -1
  175. package/dist/schema/coordination.d.ts +21 -25
  176. package/dist/schema/coordination.js +21 -25
  177. package/dist/schema/ddl.d.ts +43 -39
  178. package/dist/schema/ddl.js +75 -68
  179. package/dist/schema/ddlLock.d.ts +20 -24
  180. package/dist/schema/ddlLock.js +18 -23
  181. package/dist/schema/diff.d.ts +99 -61
  182. package/dist/schema/diff.js +43 -34
  183. package/dist/schema/field.d.ts +37 -42
  184. package/dist/schema/field.js +35 -48
  185. package/dist/schema/generate.d.ts +12 -12
  186. package/dist/schema/generate.js +12 -12
  187. package/dist/schema/index.d.ts +2 -2
  188. package/dist/schema/index.js +21 -23
  189. package/dist/schema/model.d.ts +118 -143
  190. package/dist/schema/model.js +22 -33
  191. package/dist/schema/openapi.d.ts +10 -9
  192. package/dist/schema/openapi.js +5 -3
  193. package/dist/schema/queries.d.ts +29 -31
  194. package/dist/schema/queries.js +23 -25
  195. package/dist/schema/relation.d.ts +89 -99
  196. package/dist/schema/relation.js +13 -13
  197. package/dist/schema/residency.d.ts +16 -13
  198. package/dist/schema/residency.js +16 -13
  199. package/dist/schema/roles.d.ts +36 -43
  200. package/dist/schema/roles.js +31 -37
  201. package/dist/schema/schema.d.ts +33 -42
  202. package/dist/schema/schema.js +31 -32
  203. package/dist/schema/select.d.ts +13 -13
  204. package/dist/schema/select.js +13 -13
  205. package/dist/schema/serialize.d.ts +28 -31
  206. package/dist/schema/serialize.js +27 -31
  207. package/dist/schema/sugar.d.ts +17 -32
  208. package/dist/schema/sugar.js +14 -29
  209. package/dist/schema/{sync-delta-row.d.ts → syncDeltaRow.d.ts} +26 -49
  210. package/dist/schema/syncDeltaRow.js +89 -0
  211. package/dist/schema/tenancy.d.ts +44 -46
  212. package/dist/schema/tenancy.js +46 -48
  213. package/dist/server/adapter.d.ts +58 -58
  214. package/dist/server/adapter.js +13 -14
  215. package/dist/server/commit.d.ts +60 -64
  216. package/dist/server/index.d.ts +9 -10
  217. package/dist/server/index.js +1 -1
  218. package/dist/server/readConfig.d.ts +70 -0
  219. package/dist/server/readConfig.js +8 -0
  220. package/dist/server/storageMode.d.ts +23 -0
  221. package/dist/server/storageMode.js +17 -0
  222. package/dist/source/adapter.d.ts +30 -25
  223. package/dist/source/adapter.js +10 -10
  224. package/dist/source/adapters/drizzle.d.ts +28 -23
  225. package/dist/source/adapters/drizzle.js +30 -25
  226. package/dist/source/adapters/kysely.d.ts +27 -25
  227. package/dist/source/adapters/kysely.js +24 -23
  228. package/dist/source/adapters/memory.d.ts +8 -7
  229. package/dist/source/adapters/memory.js +9 -8
  230. package/dist/source/adapters/prisma.d.ts +13 -12
  231. package/dist/source/adapters/prisma.js +22 -25
  232. package/dist/source/conformance.d.ts +18 -11
  233. package/dist/source/conformance.js +17 -11
  234. package/dist/source/connector.d.ts +31 -32
  235. package/dist/source/connector.js +28 -28
  236. package/dist/source/connectorProtocol.d.ts +160 -0
  237. package/dist/source/connectorProtocol.js +162 -0
  238. package/dist/source/contract.d.ts +26 -27
  239. package/dist/source/contract.js +28 -29
  240. package/dist/source/factory.d.ts +46 -58
  241. package/dist/source/factory.js +22 -27
  242. package/dist/source/index.d.ts +7 -9
  243. package/dist/source/index.js +12 -14
  244. package/dist/source/migrations.d.ts +9 -9
  245. package/dist/source/migrations.js +9 -9
  246. package/dist/source/next.d.ts +9 -10
  247. package/dist/source/next.js +6 -7
  248. package/dist/source/pushQueue.d.ts +69 -47
  249. package/dist/source/pushQueue.js +32 -28
  250. package/dist/source/signing.d.ts +46 -17
  251. package/dist/source/signing.js +28 -11
  252. package/dist/source/types.d.ts +121 -104
  253. package/dist/source/types.js +13 -14
  254. package/dist/stores/ObjectStore.d.ts +10 -11
  255. package/dist/stores/ObjectStore.js +11 -12
  256. package/dist/stores/ObjectStoreContract.d.ts +12 -15
  257. package/dist/stores/SyncActionStore.d.ts +7 -11
  258. package/dist/stores/SyncActionStore.js +13 -17
  259. package/dist/surface.d.ts +27 -20
  260. package/dist/surface.js +27 -20
  261. package/dist/sync/{BootstrapHelper.d.ts → BootstrapFetcher.d.ts} +36 -42
  262. package/dist/sync/{BootstrapHelper.js → BootstrapFetcher.js} +76 -76
  263. package/dist/sync/ConnectionManager.d.ts +39 -50
  264. package/dist/sync/ConnectionManager.js +55 -66
  265. package/dist/sync/NetworkProbe.d.ts +24 -29
  266. package/dist/sync/NetworkProbe.js +63 -69
  267. package/dist/sync/{HydrationCoordinator.d.ts → OnDemandLoader.d.ts} +42 -41
  268. package/dist/sync/{HydrationCoordinator.js → OnDemandLoader.js} +59 -54
  269. package/dist/sync/{AreaOfInterestManager.d.ts → SubscriptionManager.d.ts} +43 -57
  270. package/dist/sync/{AreaOfInterestManager.js → SubscriptionManager.js} +43 -51
  271. package/dist/sync/SyncWebSocket.d.ts +139 -165
  272. package/dist/sync/SyncWebSocket.js +191 -223
  273. package/dist/sync/awaitClaimGrant.d.ts +18 -18
  274. package/dist/sync/awaitClaimGrant.js +11 -11
  275. package/dist/sync/bootstrapApply.d.ts +34 -24
  276. package/dist/sync/bootstrapApply.js +27 -19
  277. package/dist/sync/commitFrames.d.ts +21 -20
  278. package/dist/sync/commitFrames.js +18 -18
  279. package/dist/sync/createClaimStream.d.ts +23 -22
  280. package/dist/sync/createClaimStream.js +105 -23
  281. package/dist/sync/createPresenceStream.d.ts +19 -18
  282. package/dist/sync/createPresenceStream.js +25 -26
  283. package/dist/sync/createSnapshot.d.ts +12 -14
  284. package/dist/sync/createSnapshot.js +20 -26
  285. package/dist/sync/credentialLifecycle.d.ts +104 -104
  286. package/dist/sync/credentialLifecycle.js +140 -147
  287. package/dist/sync/deltaPipeline.d.ts +36 -34
  288. package/dist/sync/deltaPipeline.js +64 -65
  289. package/dist/sync/groupChange.d.ts +63 -61
  290. package/dist/sync/groupChange.js +74 -78
  291. package/dist/sync/heartbeat.d.ts +34 -33
  292. package/dist/sync/heartbeat.js +31 -31
  293. package/dist/sync/participants.d.ts +19 -19
  294. package/dist/sync/schemas.d.ts +3 -2
  295. package/dist/sync/schemas.js +14 -10
  296. package/dist/sync/syncCursor.d.ts +17 -21
  297. package/dist/sync/syncCursor.js +17 -21
  298. package/dist/sync/syncPlan.d.ts +28 -36
  299. package/dist/sync/syncPlan.js +18 -19
  300. package/dist/sync/syncPosition.d.ts +54 -49
  301. package/dist/sync/syncPosition.js +57 -52
  302. package/dist/sync/wsFrameHandlers.d.ts +35 -36
  303. package/dist/sync/wsFrameHandlers.js +63 -67
  304. package/dist/testing/fixtures/bootstrap.d.ts +12 -6
  305. package/dist/testing/fixtures/bootstrap.js +12 -6
  306. package/dist/testing/fixtures/deltas.d.ts +30 -33
  307. package/dist/testing/fixtures/deltas.js +30 -33
  308. package/dist/testing/fixtures/models.d.ts +11 -10
  309. package/dist/testing/fixtures/models.js +11 -10
  310. package/dist/testing/helpers/{react-wrapper.d.ts → reactWrapper.d.ts} +13 -10
  311. package/dist/testing/helpers/{react-wrapper.js → reactWrapper.js} +15 -12
  312. package/dist/testing/helpers/{sync-engine-harness.d.ts → syncEngineHarness.d.ts} +17 -15
  313. package/dist/testing/helpers/{sync-engine-harness.js → syncEngineHarness.js} +12 -10
  314. package/dist/testing/helpers/wait.d.ts +13 -8
  315. package/dist/testing/helpers/wait.js +13 -8
  316. package/dist/testing/index.d.ts +3 -3
  317. package/dist/testing/index.js +2 -2
  318. package/dist/testing/mocks/MockMutationExecutor.d.ts +18 -17
  319. package/dist/testing/mocks/MockMutationExecutor.js +15 -14
  320. package/dist/testing/mocks/MockNetworkMonitor.d.ts +8 -8
  321. package/dist/testing/mocks/MockNetworkMonitor.js +8 -8
  322. package/dist/testing/mocks/MockSyncContext.d.ts +20 -17
  323. package/dist/testing/mocks/MockSyncContext.js +15 -13
  324. package/dist/testing/mocks/MockSyncStore.d.ts +10 -10
  325. package/dist/testing/mocks/MockSyncStore.js +11 -11
  326. package/dist/testing/mocks/MockWebSocket.d.ts +26 -22
  327. package/dist/testing/mocks/MockWebSocket.js +22 -21
  328. package/dist/transactions/TransactionQueue.d.ts +181 -176
  329. package/dist/transactions/TransactionQueue.js +338 -350
  330. package/dist/transactions/TransactionStore.d.ts +6 -4
  331. package/dist/transactions/TransactionStore.js +6 -4
  332. package/dist/transactions/UnconfirmedWrites.d.ts +82 -0
  333. package/dist/transactions/UnconfirmedWrites.js +104 -0
  334. package/dist/transactions/coalesceRules.d.ts +41 -17
  335. package/dist/transactions/coalesceRules.js +40 -17
  336. package/dist/transactions/commitPayload.d.ts +48 -52
  337. package/dist/transactions/commitPayload.js +48 -57
  338. package/dist/transactions/deltaConfirmation.d.ts +20 -22
  339. package/dist/transactions/deltaConfirmation.js +37 -45
  340. package/dist/transactions/optimisticApply.d.ts +49 -0
  341. package/dist/transactions/optimisticApply.js +65 -0
  342. package/dist/transactions/{persistedReplay.d.ts → replayValidation.d.ts} +28 -22
  343. package/dist/transactions/{persistedReplay.js → replayValidation.js} +33 -27
  344. package/dist/types/global.d.ts +46 -41
  345. package/dist/types/global.js +20 -19
  346. package/dist/types/index.d.ts +71 -77
  347. package/dist/types/index.js +22 -22
  348. package/dist/types/modelData.d.ts +6 -8
  349. package/dist/types/modelData.js +5 -7
  350. package/dist/types/participant.d.ts +10 -11
  351. package/dist/types/participant.js +6 -8
  352. package/dist/types/streams.d.ts +208 -195
  353. package/dist/types/streams.js +7 -7
  354. package/dist/utils/asyncIterator.d.ts +25 -32
  355. package/dist/utils/asyncIterator.js +25 -32
  356. package/dist/utils/duration.d.ts +12 -15
  357. package/dist/utils/duration.js +12 -15
  358. package/dist/utils/mobxSetup.d.ts +53 -0
  359. package/dist/utils/{mobx-setup.js → mobxSetup.js} +42 -98
  360. package/dist/webhooks/events.d.ts +21 -16
  361. package/dist/webhooks/events.js +10 -8
  362. package/dist/webhooks/index.d.ts +5 -7
  363. package/dist/webhooks/index.js +5 -7
  364. package/dist/{schema/sync-delta-wire.d.ts → wire/delta.d.ts} +58 -41
  365. package/dist/wire/delta.js +114 -0
  366. package/dist/wire/errorEnvelope.d.ts +30 -31
  367. package/dist/wire/errorEnvelope.js +34 -40
  368. package/dist/wire/frames.d.ts +79 -86
  369. package/dist/wire/frames.js +26 -33
  370. package/dist/wire/index.d.ts +14 -12
  371. package/dist/wire/index.js +30 -26
  372. package/dist/wire/listEnvelope.d.ts +16 -23
  373. package/dist/wire/listEnvelope.js +7 -6
  374. package/dist/wire/protocol.d.ts +25 -32
  375. package/dist/wire/protocol.js +25 -32
  376. package/dist/wire/protocolVersion.d.ts +44 -40
  377. package/dist/wire/protocolVersion.js +44 -40
  378. package/docs/coordination.md +59 -0
  379. package/package.json +11 -10
  380. package/dist/ai-sdk/coordinated-tool.d.ts +0 -101
  381. package/dist/ai-sdk/coordination-context.d.ts +0 -52
  382. package/dist/core/query-utils.d.ts +0 -34
  383. package/dist/core/query-utils.js +0 -59
  384. package/dist/schema/sync-delta-row.js +0 -103
  385. package/dist/schema/sync-delta-wire.js +0 -102
  386. package/dist/server/read-config.d.ts +0 -67
  387. package/dist/server/read-config.js +0 -8
  388. package/dist/server/storage-mode.d.ts +0 -8
  389. package/dist/server/storage-mode.js +0 -28
  390. package/dist/source/connector-protocol.d.ts +0 -159
  391. package/dist/source/connector-protocol.js +0 -161
  392. package/dist/transactions/OptimisticEchoTracker.d.ts +0 -82
  393. package/dist/transactions/OptimisticEchoTracker.js +0 -104
  394. package/dist/transactions/mutation-error-handler.d.ts +0 -5
  395. package/dist/transactions/mutation-error-handler.js +0 -39
  396. package/dist/transactions/optimistic.d.ts +0 -24
  397. package/dist/transactions/optimistic.js +0 -45
  398. package/dist/utils/mobx-setup.d.ts +0 -42
@@ -1,45 +1,38 @@
1
1
  /**
2
- * Cross-boundary protocol TIMING constants the one place the 30s ping
3
- * cadence and the claim/presence lease window are defined. Before this leaf
4
- * existed the pair was copy-pasted across five sites in four modules, kept
5
- * in sync only by comments ("~3× the 30s ping"); changing the server ping
6
- * silently skewed the SDK's claim-expiry estimate and presence reaping.
2
+ * The timing constants both sides of the protocol must agree on: the ping
3
+ * cadence and the lease window derived from it. Defining them here once keeps
4
+ * the client and the server from skewing apart a change to the ping interval
5
+ * that did not also move the lease window would make claim expiry and presence
6
+ * timeouts disagree between the two.
7
7
  *
8
- * Consumers (SDK side, relative import):
9
- * - `sync/heartbeat.ts` `HEARTBEAT_INTERVAL_MS`, the SDK's
10
- * application-level `{ type: 'ping' }` cadence.
11
- * - `client/createModelProxy.ts` `DEFAULT_LEASE_TTL_MS`, the client's
12
- * expiry estimate for a claim taken without an explicit TTL.
8
+ * {@link PING_INTERVAL_MS} is how often the connection pings to prove it is
9
+ * alive. {@link LEASE_TTL_MS} is how long a claim or presence entry stays valid
10
+ * without a renewing ping. On the client, these set the heartbeat cadence and
11
+ * the fallback expiry for a claim taken without an explicit lease. On the
12
+ * server, they set the keepalive interval, the lease granted per keepalive, and
13
+ * the presence-entry lifetime, so a silently disconnected client drops off the
14
+ * roster within one lease window.
13
15
  *
14
- * Consumers (server side, via `@abloatai/ablo/wire`):
15
- * - `apps/sync-server/src/hub/Hub.ts` the RFC 6455 `ws.ping()`
16
- * keepalive interval (the tick that renews claim leases).
17
- * - `apps/sync-server/src/hub/claimCoordinator.ts`
18
- * `LEASE_RENEW_TTL_MS`, the lease lifetime granted per keepalive tick.
19
- * - `apps/sync-server/src/presence/PresenceStore.ts` — the default
20
- * presence-entry TTL (a silently-dead client leaves the roster within
21
- * one lease window).
22
- *
23
- * INVARIANT: `LEASE_TTL_MS === 3 * PING_INTERVAL_MS`. The lease is renewed
24
- * on every ping, so a live holder always has ≥ 2 ping intervals of runway,
25
- * and a silent one lapses ~2 missed pings after it stops renewing. TTL is
26
- * liveness, not work-duration — never widen the lease without widening the
27
- * ping (or holders will flap), and never derive either value locally.
16
+ * The lease is three ping intervals long and is renewed on every ping, so a
17
+ * live holder always has at least two intervals of runway and a silent one
18
+ * lapses about two missed pings after it stops renewing. The window measures
19
+ * liveness, not how long a task may run: widening the lease without also
20
+ * widening the ping makes holders flap, and neither value should be redefined
21
+ * anywhere else.
28
22
  */
29
23
  export declare const PING_INTERVAL_MS = 30000;
30
24
  export declare const LEASE_TTL_MS: number;
31
25
  /**
32
- * WebSocket subprotocols used to carry the bearer credential OUT of the URL.
26
+ * The WebSocket subprotocols that carry the bearer credential out of the URL.
33
27
  *
34
- * Browsers cannot set an `Authorization` header on a WebSocket, so the SDK
28
+ * A browser cannot set an `Authorization` header on a WebSocket, so the client
35
29
  * offers the token as a `Sec-WebSocket-Protocol` value — `ablo.bearer.<token>` —
36
30
  * alongside the real `ablo.sync.v1` protocol the server selects. This keeps the
37
- * credential out of the query string, which ALB access logs, proxies, and
38
- * browser history capture. The server reads the token from the subprotocol and
39
- * echoes back ONLY `ablo.sync.v1`, never the token-bearing value. Lives in
40
- * `wire/` (not `auth/`) because it IS the wire contract: client and server
41
- * import the same constants so the handshake format can never drift.
42
- * Re-exported from `auth/credentialSource.ts` for existing SDK importers.
31
+ * credential out of the query string, which access logs, proxies, and browser
32
+ * history would otherwise capture. The server reads the token from the
33
+ * subprotocol and echoes back only `ablo.sync.v1`, never the token-bearing
34
+ * value. Both the client and the server import these constants, so the
35
+ * handshake format cannot drift.
43
36
  */
44
37
  export declare const WS_BEARER_SUBPROTOCOL_PREFIX = "ablo.bearer.";
45
38
  export declare const WS_SYNC_SUBPROTOCOL = "ablo.sync.v1";
@@ -1,45 +1,38 @@
1
1
  /**
2
- * Cross-boundary protocol TIMING constants the one place the 30s ping
3
- * cadence and the claim/presence lease window are defined. Before this leaf
4
- * existed the pair was copy-pasted across five sites in four modules, kept
5
- * in sync only by comments ("~3× the 30s ping"); changing the server ping
6
- * silently skewed the SDK's claim-expiry estimate and presence reaping.
2
+ * The timing constants both sides of the protocol must agree on: the ping
3
+ * cadence and the lease window derived from it. Defining them here once keeps
4
+ * the client and the server from skewing apart a change to the ping interval
5
+ * that did not also move the lease window would make claim expiry and presence
6
+ * timeouts disagree between the two.
7
7
  *
8
- * Consumers (SDK side, relative import):
9
- * - `sync/heartbeat.ts` `HEARTBEAT_INTERVAL_MS`, the SDK's
10
- * application-level `{ type: 'ping' }` cadence.
11
- * - `client/createModelProxy.ts` `DEFAULT_LEASE_TTL_MS`, the client's
12
- * expiry estimate for a claim taken without an explicit TTL.
8
+ * {@link PING_INTERVAL_MS} is how often the connection pings to prove it is
9
+ * alive. {@link LEASE_TTL_MS} is how long a claim or presence entry stays valid
10
+ * without a renewing ping. On the client, these set the heartbeat cadence and
11
+ * the fallback expiry for a claim taken without an explicit lease. On the
12
+ * server, they set the keepalive interval, the lease granted per keepalive, and
13
+ * the presence-entry lifetime, so a silently disconnected client drops off the
14
+ * roster within one lease window.
13
15
  *
14
- * Consumers (server side, via `@abloatai/ablo/wire`):
15
- * - `apps/sync-server/src/hub/Hub.ts` the RFC 6455 `ws.ping()`
16
- * keepalive interval (the tick that renews claim leases).
17
- * - `apps/sync-server/src/hub/claimCoordinator.ts`
18
- * `LEASE_RENEW_TTL_MS`, the lease lifetime granted per keepalive tick.
19
- * - `apps/sync-server/src/presence/PresenceStore.ts` — the default
20
- * presence-entry TTL (a silently-dead client leaves the roster within
21
- * one lease window).
22
- *
23
- * INVARIANT: `LEASE_TTL_MS === 3 * PING_INTERVAL_MS`. The lease is renewed
24
- * on every ping, so a live holder always has ≥ 2 ping intervals of runway,
25
- * and a silent one lapses ~2 missed pings after it stops renewing. TTL is
26
- * liveness, not work-duration — never widen the lease without widening the
27
- * ping (or holders will flap), and never derive either value locally.
16
+ * The lease is three ping intervals long and is renewed on every ping, so a
17
+ * live holder always has at least two intervals of runway and a silent one
18
+ * lapses about two missed pings after it stops renewing. The window measures
19
+ * liveness, not how long a task may run: widening the lease without also
20
+ * widening the ping makes holders flap, and neither value should be redefined
21
+ * anywhere else.
28
22
  */
29
23
  export const PING_INTERVAL_MS = 30_000;
30
24
  export const LEASE_TTL_MS = 3 * PING_INTERVAL_MS;
31
25
  /**
32
- * WebSocket subprotocols used to carry the bearer credential OUT of the URL.
26
+ * The WebSocket subprotocols that carry the bearer credential out of the URL.
33
27
  *
34
- * Browsers cannot set an `Authorization` header on a WebSocket, so the SDK
28
+ * A browser cannot set an `Authorization` header on a WebSocket, so the client
35
29
  * offers the token as a `Sec-WebSocket-Protocol` value — `ablo.bearer.<token>` —
36
30
  * alongside the real `ablo.sync.v1` protocol the server selects. This keeps the
37
- * credential out of the query string, which ALB access logs, proxies, and
38
- * browser history capture. The server reads the token from the subprotocol and
39
- * echoes back ONLY `ablo.sync.v1`, never the token-bearing value. Lives in
40
- * `wire/` (not `auth/`) because it IS the wire contract: client and server
41
- * import the same constants so the handshake format can never drift.
42
- * Re-exported from `auth/credentialSource.ts` for existing SDK importers.
31
+ * credential out of the query string, which access logs, proxies, and browser
32
+ * history would otherwise capture. The server reads the token from the
33
+ * subprotocol and echoes back only `ablo.sync.v1`, never the token-bearing
34
+ * value. Both the client and the server import these constants, so the
35
+ * handshake format cannot drift.
43
36
  */
44
37
  export const WS_BEARER_SUBPROTOCOL_PREFIX = 'ablo.bearer.';
45
38
  export const WS_SYNC_SUBPROTOCOL = 'ablo.sync.v1';
@@ -1,56 +1,60 @@
1
1
  /**
2
- * The sync protocol version — ONE monotonically increasing integer covering
3
- * everything client and server must agree on to speak: WS frame shapes
4
- * (hub `ClientMessage`/`ServerMessage`), HTTP request/response envelopes, and
5
- * the persisted delta encodings a client replays. Zero's recipe: schemaHash
6
- * (WS close 4009) only detects APP-schema drift; this detects PROTOCOL drift
7
- * before it, every main-push deploy was an old-client/new-server encounter
8
- * with no detector at all.
2
+ * The sync protocol version — a single integer, increasing over time, that
3
+ * covers everything the client and server must agree on to talk to each other:
4
+ * the WebSocket frame shapes, the HTTP request and response envelopes, and the
5
+ * delta encodings a client replays. It is separate from the app-schema hash
6
+ * (WebSocket close code 4009), which detects drift in your data model; this
7
+ * detects drift in the protocol itself.
9
8
  *
10
- * Deploy contract: SERVER DEPLOYS FIRST. The server accepts every version in
11
- * `[MIN_SUPPORTED_PROTOCOL_VERSION, PROTOCOL_VERSION]`; a client never
12
- * connects to a server older than itself (if it does a rollback mid-fleet —
13
- * the too-new rejection below makes it visible instead of undefined behavior).
9
+ * Deploy ordering: the server is deployed first. It accepts every version in
10
+ * the inclusive range from {@link MIN_SUPPORTED_PROTOCOL_VERSION} to
11
+ * {@link PROTOCOL_VERSION}, and a client is never expected to connect to a
12
+ * server older than itself. If that does happen for example a partial server
13
+ * rollback — {@link protocolVersionProblem} reports it as `too_new` so the
14
+ * mismatch is visible rather than undefined.
14
15
  *
15
- * How to change the protocol:
16
- * 1. Make the wire change backward-tolerant where possible (the server's
17
- * `clientMessageSchema` accepts-and-ignores unknown payload keys an
18
- * ADDITIVE field usually needs NO version bump).
19
- * 2. For a breaking change: bump `PROTOCOL_VERSION`, append a changelog
20
- * entry below, and keep `MIN_SUPPORTED_PROTOCOL_VERSION` covering every
21
- * SDK version still in the wild; raise it only with a deprecation window.
22
- * 3. The contract test (`__tests__/protocolVersion.test.ts`) fails on any
23
- * bump — update it in the same change, deliberately.
16
+ * To change the protocol:
17
+ * 1. Make the change backward-tolerant where you can. The server ignores
18
+ * unknown payload keys, so an additive field usually needs no version bump.
19
+ * 2. For a breaking change, bump {@link PROTOCOL_VERSION}, add a changelog
20
+ * entry below, and keep {@link MIN_SUPPORTED_PROTOCOL_VERSION} low enough
21
+ * to cover every client still in use; raise it only after a deprecation
22
+ * window.
23
+ * 3. The protocol-version contract test fails on any bump — update it in the
24
+ * same change, deliberately.
24
25
  *
25
- * CHANGELOG
26
- * v1 (2026-07-03) — the protocol as of the version field's introduction:
27
- * sync_request{cursor,lastSyncId,capabilities,protocolVersion?},
28
- * commit/mutation/claim/release/ack/presence_update frames, bootstrap +
29
- * delta batches, HTTP envelopes per `wire/errorEnvelope` +
30
- * `wire/listEnvelope`. Clients that predate the field send NO
31
- * `protocolVersion` treated as v1 (the field's introduction changed no
32
- * semantics).
26
+ * Changelog
27
+ * v1 (2026-07-03) — the protocol as of this field's introduction: the
28
+ * sync-request frame (`cursor`, `lastSyncId`, `capabilities`, optional
29
+ * `protocolVersion`), the commit, mutation, claim, release, ack, and
30
+ * presence-update frames, the bootstrap and delta batches, and the HTTP
31
+ * error and list envelopes. A client that predates this field sends no
32
+ * `protocolVersion` and is treated as v1, since introducing the field
33
+ * changed no behavior.
33
34
  */
34
35
  export declare const PROTOCOL_VERSION = 1;
35
36
  /**
36
- * Oldest client protocol this build still serves. Raising it is a BREAKING
37
- * cut for un-upgraded clients do it only with a deprecation window and a
38
- * changelog entry.
37
+ * The oldest client protocol version this build still serves. Raising it cuts
38
+ * off clients that have not upgraded, so do it only after a deprecation window
39
+ * and with a changelog entry.
39
40
  */
40
41
  export declare const MIN_SUPPORTED_PROTOCOL_VERSION = 1;
41
42
  /**
42
- * WS application close code for a protocol-version rejection (4001 =
43
- * credential, 4009 = app-schema drift). The reason string is the error code
44
- * `protocol_version_unsupported`; the SDK treats this close as TERMINAL
45
- * reconnecting cannot heal a version mismatch, upgrading the SDK (or rolling
46
- * the server forward) can.
43
+ * The WebSocket close code the server sends to reject a protocol-version
44
+ * mismatch. It sits alongside the other application close codes (4001 for a
45
+ * credential problem, 4009 for app-schema drift), and its reason string is the
46
+ * error code `protocol_version_unsupported`. A client should treat this close
47
+ * as terminal: reconnecting cannot heal a version mismatch, but upgrading the
48
+ * client or rolling the server forward can.
47
49
  */
48
50
  export declare const WS_CLOSE_PROTOCOL_VERSION = 4010;
49
51
  /**
50
- * Classify a peer's announced protocol version. `undefined` (a pre-versioning
51
- * client) is v1 by definition. Non-integer garbage classifies as `too_old` —
52
- * fail closed, visibly.
52
+ * Classifies a peer's announced protocol version against what this build
53
+ * supports, returning `'too_old'`, `'too_new'`, or `null` when the versions are
54
+ * compatible. An `undefined` version — a client from before versioning existed
55
+ * — counts as v1. A non-integer value is treated as `'too_old'` so the check
56
+ * fails closed and visibly.
53
57
  */
54
58
  export declare function protocolVersionProblem(announced: number | undefined): 'too_old' | 'too_new' | null;
55
- /** HTTP request header carrying the client's protocol version. */
59
+ /** The HTTP request header a client uses to announce its protocol version. */
56
60
  export declare const PROTOCOL_VERSION_HEADER = "Ablo-Protocol-Version";
@@ -1,55 +1,59 @@
1
1
  /**
2
- * The sync protocol version — ONE monotonically increasing integer covering
3
- * everything client and server must agree on to speak: WS frame shapes
4
- * (hub `ClientMessage`/`ServerMessage`), HTTP request/response envelopes, and
5
- * the persisted delta encodings a client replays. Zero's recipe: schemaHash
6
- * (WS close 4009) only detects APP-schema drift; this detects PROTOCOL drift
7
- * before it, every main-push deploy was an old-client/new-server encounter
8
- * with no detector at all.
2
+ * The sync protocol version — a single integer, increasing over time, that
3
+ * covers everything the client and server must agree on to talk to each other:
4
+ * the WebSocket frame shapes, the HTTP request and response envelopes, and the
5
+ * delta encodings a client replays. It is separate from the app-schema hash
6
+ * (WebSocket close code 4009), which detects drift in your data model; this
7
+ * detects drift in the protocol itself.
9
8
  *
10
- * Deploy contract: SERVER DEPLOYS FIRST. The server accepts every version in
11
- * `[MIN_SUPPORTED_PROTOCOL_VERSION, PROTOCOL_VERSION]`; a client never
12
- * connects to a server older than itself (if it does a rollback mid-fleet —
13
- * the too-new rejection below makes it visible instead of undefined behavior).
9
+ * Deploy ordering: the server is deployed first. It accepts every version in
10
+ * the inclusive range from {@link MIN_SUPPORTED_PROTOCOL_VERSION} to
11
+ * {@link PROTOCOL_VERSION}, and a client is never expected to connect to a
12
+ * server older than itself. If that does happen for example a partial server
13
+ * rollback — {@link protocolVersionProblem} reports it as `too_new` so the
14
+ * mismatch is visible rather than undefined.
14
15
  *
15
- * How to change the protocol:
16
- * 1. Make the wire change backward-tolerant where possible (the server's
17
- * `clientMessageSchema` accepts-and-ignores unknown payload keys an
18
- * ADDITIVE field usually needs NO version bump).
19
- * 2. For a breaking change: bump `PROTOCOL_VERSION`, append a changelog
20
- * entry below, and keep `MIN_SUPPORTED_PROTOCOL_VERSION` covering every
21
- * SDK version still in the wild; raise it only with a deprecation window.
22
- * 3. The contract test (`__tests__/protocolVersion.test.ts`) fails on any
23
- * bump — update it in the same change, deliberately.
16
+ * To change the protocol:
17
+ * 1. Make the change backward-tolerant where you can. The server ignores
18
+ * unknown payload keys, so an additive field usually needs no version bump.
19
+ * 2. For a breaking change, bump {@link PROTOCOL_VERSION}, add a changelog
20
+ * entry below, and keep {@link MIN_SUPPORTED_PROTOCOL_VERSION} low enough
21
+ * to cover every client still in use; raise it only after a deprecation
22
+ * window.
23
+ * 3. The protocol-version contract test fails on any bump — update it in the
24
+ * same change, deliberately.
24
25
  *
25
- * CHANGELOG
26
- * v1 (2026-07-03) — the protocol as of the version field's introduction:
27
- * sync_request{cursor,lastSyncId,capabilities,protocolVersion?},
28
- * commit/mutation/claim/release/ack/presence_update frames, bootstrap +
29
- * delta batches, HTTP envelopes per `wire/errorEnvelope` +
30
- * `wire/listEnvelope`. Clients that predate the field send NO
31
- * `protocolVersion` treated as v1 (the field's introduction changed no
32
- * semantics).
26
+ * Changelog
27
+ * v1 (2026-07-03) — the protocol as of this field's introduction: the
28
+ * sync-request frame (`cursor`, `lastSyncId`, `capabilities`, optional
29
+ * `protocolVersion`), the commit, mutation, claim, release, ack, and
30
+ * presence-update frames, the bootstrap and delta batches, and the HTTP
31
+ * error and list envelopes. A client that predates this field sends no
32
+ * `protocolVersion` and is treated as v1, since introducing the field
33
+ * changed no behavior.
33
34
  */
34
35
  export const PROTOCOL_VERSION = 1;
35
36
  /**
36
- * Oldest client protocol this build still serves. Raising it is a BREAKING
37
- * cut for un-upgraded clients do it only with a deprecation window and a
38
- * changelog entry.
37
+ * The oldest client protocol version this build still serves. Raising it cuts
38
+ * off clients that have not upgraded, so do it only after a deprecation window
39
+ * and with a changelog entry.
39
40
  */
40
41
  export const MIN_SUPPORTED_PROTOCOL_VERSION = 1;
41
42
  /**
42
- * WS application close code for a protocol-version rejection (4001 =
43
- * credential, 4009 = app-schema drift). The reason string is the error code
44
- * `protocol_version_unsupported`; the SDK treats this close as TERMINAL
45
- * reconnecting cannot heal a version mismatch, upgrading the SDK (or rolling
46
- * the server forward) can.
43
+ * The WebSocket close code the server sends to reject a protocol-version
44
+ * mismatch. It sits alongside the other application close codes (4001 for a
45
+ * credential problem, 4009 for app-schema drift), and its reason string is the
46
+ * error code `protocol_version_unsupported`. A client should treat this close
47
+ * as terminal: reconnecting cannot heal a version mismatch, but upgrading the
48
+ * client or rolling the server forward can.
47
49
  */
48
50
  export const WS_CLOSE_PROTOCOL_VERSION = 4010;
49
51
  /**
50
- * Classify a peer's announced protocol version. `undefined` (a pre-versioning
51
- * client) is v1 by definition. Non-integer garbage classifies as `too_old` —
52
- * fail closed, visibly.
52
+ * Classifies a peer's announced protocol version against what this build
53
+ * supports, returning `'too_old'`, `'too_new'`, or `null` when the versions are
54
+ * compatible. An `undefined` version — a client from before versioning existed
55
+ * — counts as v1. A non-integer value is treated as `'too_old'` so the check
56
+ * fails closed and visibly.
53
57
  */
54
58
  export function protocolVersionProblem(announced) {
55
59
  const v = announced ?? 1;
@@ -59,5 +63,5 @@ export function protocolVersionProblem(announced) {
59
63
  return 'too_new';
60
64
  return null;
61
65
  }
62
- /** HTTP request header carrying the client's protocol version. */
66
+ /** The HTTP request header a client uses to announce its protocol version. */
63
67
  export const PROTOCOL_VERSION_HEADER = 'Ablo-Protocol-Version';
@@ -416,6 +416,65 @@ try {
416
416
  }
417
417
  ```
418
418
 
419
+ ### `heartbeat` — holding a claim for long-running work
420
+
421
+ ```ts
422
+ held.heartbeat(ttl?: Duration): Promise<{ expiresAt: number }>
423
+ ```
424
+
425
+ A claim's TTL is crash cleanup, not a work-duration estimate — so a task that
426
+ outlives it (an agent run, a background worker's job) keeps its lease by
427
+ **beating**, the same pattern as an SQS visibility heartbeat or a Temporal
428
+ activity heartbeat. Each beat extends the lease from now (never shortens it,
429
+ and each extension is clamped server-side); a crashed worker stops beating and
430
+ its lease lapses within one beat window, promoting the next waiter.
431
+
432
+ Usually **implicit** — pass `heartbeat` when claiming and the SDK beats every
433
+ third of the TTL until release:
434
+
435
+ ```ts
436
+ await using claim = await ablo.reports.claim({
437
+ id: 'report_q3',
438
+ reason: 'generating',
439
+ ttl: '5m',
440
+ heartbeat: true, // or an explicit cadence: heartbeat: '2m'
441
+ onHeartbeatLost: () => abortWork(),
442
+ });
443
+ await runLongGeneration(claim.data); // lease held for the duration
444
+ // scope exit releases; the loop stops with it
445
+ ```
446
+
447
+ A beat that comes back with a definitive loss — the lease expired and the
448
+ queue moved on — rejects with `AbloClaimedError` (`claim_lost`) and stops the
449
+ auto-loop. For a worker with no socket, **the failed beat is the loss
450
+ notification**; abandon or re-claim, and remember any write attempted under
451
+ the old lease is independently rejected by its `readAt` guard. Transient
452
+ failures (a connection blip) don't stop the loop — the next tick retries.
453
+
454
+ Each beat's answer carries two more things:
455
+
456
+ - **`queueDepth`** — how many participants wait in line behind the lease.
457
+ This is the cooperative-yield pressure signal: a worker that can checkpoint
458
+ may release early when others wait. Read it from the resolved beat, or pass
459
+ `onHeartbeat` when claiming to observe every auto-beat.
460
+ - **progress `details`** — `held.heartbeat({ details: { pages: 42, of: 100 } })`
461
+ stores the payload as the claim's peer-visible `meta.progress` (last beat
462
+ wins, via `claim.state`). This is presence, not a checkpoint: it dies with
463
+ the lease. Durable progress belongs in the data itself — write a row, and
464
+ every subscriber already sees it.
465
+
466
+ Works identically on both transports: the realtime client sends a
467
+ `claim_heartbeat` frame; the HTTP client posts
468
+ `POST /v1/models/{model}/{id}/claim/heartbeat` (`{ ttl?, claimId?, details? }`).
469
+ Over HTTP, a **queued** claim can heartbeat too — it refreshes the waiter's
470
+ slot in the line (a queued slot is TTL'd like a lease) and reports
471
+ `{ status: 'queued', position }`.
472
+
473
+ A stateless worker holding **many** rows beats them all in one round trip:
474
+ `ablo.claims.heartbeatAll({ ttl: '5m' })` → `POST /v1/claims/heartbeat`, one
475
+ entry per extended lease. This is the socketless twin of the realtime
476
+ keepalive, which already renews every held lease on each ping.
477
+
419
478
  ### `watch` — presence for a set of rows
420
479
 
421
480
  Reading or claiming a row auto-enrolls you in its sync group, which is enough for
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@abloatai/ablo",
3
- "version": "0.26.0",
3
+ "version": "0.27.0",
4
4
  "description": "The Collaboration Layer For AI Agents",
5
5
  "license": "Apache-2.0",
6
6
  "type": "module",
@@ -150,10 +150,10 @@
150
150
  "pretest": "node scripts/check-dist-fresh.mjs",
151
151
  "test": "jest",
152
152
  "test:quickstart": "node scripts/test-quickstart.mjs",
153
- "test:unit": "jest --testPathPattern=__tests__/unit",
154
- "test:integration": "jest --testPathPattern=__tests__/integration",
155
- "test:contract": "jest --testPathPattern=__tests__/contract",
156
- "test:property": "jest --testPathPattern=__tests__/property",
153
+ "test:unit": "jest --testPathPatterns __tests__/unit",
154
+ "test:integration": "jest --testPathPatterns __tests__/integration",
155
+ "test:contract": "jest --testPathPatterns __tests__/contract",
156
+ "test:property": "jest --testPathPatterns __tests__/property",
157
157
  "test:coverage": "jest --coverage",
158
158
  "test:e2e": "E2E_TEST=true jest --config jest.e2e.config.ts",
159
159
  "test:e2e:up": "docker compose -f docker-compose.test.yml up -d --wait",
@@ -212,9 +212,9 @@
212
212
  "devDependencies": {
213
213
  "@ai-sdk/provider": "^3.0.0",
214
214
  "@clack/prompts": "^0.11.0",
215
- "@jest/globals": "^29.7.0",
215
+ "@jest/globals": "^30.2.0",
216
216
  "@prisma/client": "^7.3.0",
217
- "@types/jest": "^29.5.0",
217
+ "@types/jest": "^30.0.0",
218
218
  "@types/node": "^22.0.0",
219
219
  "@types/react": "^19.0.0",
220
220
  "@types/uuid": "^10.0.0",
@@ -225,13 +225,14 @@
225
225
  "fake-indexeddb": "^6.0.0",
226
226
  "fast-check": "^3.0.0",
227
227
  "globals": "^16.5.0",
228
- "jest": "^29.7.0",
229
- "jest-environment-jsdom": "^29.7.0",
228
+ "jest": "^30.2.0",
229
+ "jest-environment-jsdom": "^30.2.0",
230
+ "jest-environment-node": "^30.2.0",
230
231
  "picocolors": "^1.1.0",
231
232
  "postgres": "^3.4.0",
232
233
  "react": "^19.0.0",
233
234
  "react-dom": "^19.0.0",
234
- "ts-jest": "^29.4.0",
235
+ "ts-jest": "^29.4.5",
235
236
  "ts-morph": "^26.0.0",
236
237
  "tsup": "^8.0.0",
237
238
  "tsx": "^4.19.0",
@@ -1,101 +0,0 @@
1
- /**
2
- * `coordinatedTool` — the one-liner that turns an Ablo model write into a Vercel
3
- * AI SDK tool with multi-agent coordination already handled, so an AI agent can
4
- * contribute to shared state without ever silently clobbering a concurrent
5
- * writer.
6
- *
7
- * The base `./ai-sdk` pattern (see index.ts) is "write your own `tool()` and
8
- * call `ablo.<model>.update({ id, data, claim })` inside `execute`". That's the
9
- * right amount of control when a tool does something bespoke. But the *common*
10
- * case — "the agent produced some content; save it into the shared row" — should
11
- * not require every integration to re-derive optimistic concurrency by hand. This
12
- * collapses it to a declaration:
13
- *
14
- * ```ts
15
- * import { coordinatedTool } from '@abloatai/ablo/ai-sdk';
16
- * import { z } from 'zod';
17
- *
18
- * const saveSection = coordinatedTool(ablo.documents, {
19
- * description: 'Save your section into the shared document.',
20
- * inputSchema: z.object({ text: z.string() }),
21
- * id: () => DOC_ID,
22
- * apply: (current, { text }) => ({ content: appendBlock(current.content, text) }),
23
- * // strategy: 'merge' ← the default
24
- * });
25
- *
26
- * await streamText({ model, messages, tools: { saveSection } });
27
- * ```
28
- *
29
- * `apply` is the whole API: a pure function of `(freshest row, tool input) →
30
- * patch`, exactly like React's `setState(prev => next)`. Everything underneath —
31
- * reading the latest row, the compare-and-swap, the jittered backoff between
32
- * reconcile rounds, releasing claims — is the runtime's job, not yours.
33
- *
34
- * ## Strategies (pick by how writers should relate; all verified to converge
35
- * under N-way agent contention)
36
- *
37
- * - `'merge'` *(default)* — delegates straight to the functional update
38
- * `ablo.<model>.update(id, current => apply(current, input))`. The SDK re-reads
39
- * and re-applies `apply` on top of every concurrent write and backs off between
40
- * rounds, so N agents *accumulate* into one row and the model never sees a
41
- * conflict. **Requires the model's agent conflict policy to be `reject`** (the
42
- * default, or `agentsReject()`); a model declaring `agentsNotify()` HOLDS the
43
- * losing write instead of rejecting it, which defeats the reconcile — use
44
- * `claim`/`queue` there, or switch the policy.
45
- *
46
- * - `'claim'` — mutual exclusion. Takes a fail-fast claim; if another participant
47
- * holds the row it returns `{ status: 'claimed' }` so the *model* decides to
48
- * retry (a legible signal beats a hidden wait when the agent might do something
49
- * better with its turn). Works regardless of conflict policy.
50
- *
51
- * - `'queue'` — fair-ish serialization over stateless HTTP, the SQS shape: a
52
- * client poll-acquire loop (true FIFO needs a socket) until the claim is granted
53
- * or `poll.timeoutMs` elapses. The model calls once and the tool waits its turn.
54
- */
55
- import type { z } from 'zod';
56
- import type { ModelOperations } from '../client/createModelProxy.js';
57
- export type CoordinationStrategy = 'merge' | 'claim' | 'queue';
58
- /** The structured result the tool hands back to the model (or the caller). */
59
- export interface CoordinatedWriteResult<T> {
60
- /**
61
- * `'written'` — saved. `'claimed'` — another participant holds the row; NOT
62
- * saved, the model should try again. `'timeout'` — the queue strategy could not
63
- * acquire the row within `poll.timeoutMs`.
64
- */
65
- status: 'written' | 'claimed' | 'timeout';
66
- /** The reconciled row, on `'written'`. */
67
- row?: T;
68
- message?: string;
69
- /** On `'written'` via the `queue` strategy, how long the tool waited in line. */
70
- waitedMs?: number;
71
- }
72
- export interface CoordinatedToolOptions<TInput, T> {
73
- /** Tool description shown to the model. */
74
- description: string;
75
- /** What the model may send — a normal AI SDK / zod input schema. */
76
- inputSchema: z.ZodType<TInput>;
77
- /** Which row this write targets, derived from the tool input. */
78
- id: (input: TInput) => string;
79
- /**
80
- * Produce the write patch from the freshest current row + the tool input — a
81
- * pure `(prev, input) => next`. Under `merge` it re-runs on every concurrent
82
- * write, so it must be idempotent w.r.t. its own contribution (e.g. skip if its
83
- * marker is already present) to be safe across reconcile rounds.
84
- */
85
- apply: (current: T, input: TInput) => Partial<T>;
86
- /** How concurrent writers relate. Defaults to `'merge'`. */
87
- strategy?: CoordinationStrategy;
88
- /** Human-legible coordination metadata attached to the claim (`claim`/`queue`). */
89
- claim?: {
90
- reason?: string;
91
- description?: string;
92
- };
93
- /** Reconcile budget for `merge` (rounds before `AbloContentionError`). */
94
- retries?: number;
95
- /** Poll cadence / ceiling for `queue` (defaults 250ms / 30s). */
96
- poll?: {
97
- intervalMs?: number;
98
- timeoutMs?: number;
99
- };
100
- }
101
- export declare function coordinatedTool<TInput, T = Record<string, unknown>, CreateInput = Partial<T>>(model: ModelOperations<T, CreateInput>, options: CoordinatedToolOptions<TInput, T>): import("ai").Tool<TInput, CoordinatedWriteResult<T>>;