@abloatai/ablo 0.34.1 → 0.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (536) hide show
  1. package/AGENTS.md +2 -1
  2. package/CHANGELOG.md +758 -5
  3. package/README.md +56 -502
  4. package/bin/ablo.cjs +39 -0
  5. package/dist/BaseSyncedStore.d.ts +176 -48
  6. package/dist/BaseSyncedStore.js +346 -214
  7. package/dist/Database.d.ts +17 -44
  8. package/dist/Database.js +96 -79
  9. package/dist/InstanceCache.d.ts +31 -6
  10. package/dist/InstanceCache.js +65 -30
  11. package/dist/LazyReferenceCollection.d.ts +3 -3
  12. package/dist/LazyReferenceCollection.js +4 -4
  13. package/dist/Model.d.ts +23 -13
  14. package/dist/Model.js +27 -17
  15. package/dist/ModelRegistry.d.ts +8 -4
  16. package/dist/ModelRegistry.js +20 -18
  17. package/dist/NetworkMonitor.d.ts +3 -1
  18. package/dist/NetworkMonitor.js +7 -5
  19. package/dist/{SyncEngineContext.d.ts → RuntimeContext.d.ts} +20 -13
  20. package/dist/{SyncEngineContext.js → RuntimeContext.js} +11 -12
  21. package/dist/SyncClient.d.ts +47 -47
  22. package/dist/SyncClient.js +215 -156
  23. package/dist/ai-sdk/coordinatedTool.d.ts +2 -2
  24. package/dist/ai-sdk/coordinatedTool.js +1 -1
  25. package/dist/ai-sdk/coordinationContext.d.ts +2 -2
  26. package/dist/ai-sdk/coordinationContext.js +1 -1
  27. package/dist/ai-sdk/wrap.d.ts +3 -3
  28. package/dist/ai-sdk/wrap.js +2 -2
  29. package/dist/auth/index.d.ts +1 -156
  30. package/dist/auth/index.js +8 -301
  31. package/dist/client/Ablo.d.ts +42 -287
  32. package/dist/client/Ablo.js +129 -963
  33. package/dist/client/abloClient.d.ts +309 -0
  34. package/dist/client/abloClient.js +13 -0
  35. package/dist/client/clientPrelude.d.ts +52 -0
  36. package/dist/client/clientPrelude.js +60 -0
  37. package/dist/client/consoleLogger.d.ts +2 -2
  38. package/dist/client/coreClient.d.ts +60 -0
  39. package/dist/client/coreClient.js +118 -0
  40. package/dist/client/createInternalComponents.d.ts +8 -4
  41. package/dist/client/createInternalComponents.js +17 -10
  42. package/dist/client/createModelProxy.d.ts +98 -373
  43. package/dist/client/createModelProxy.js +233 -139
  44. package/dist/client/humans.d.ts +69 -0
  45. package/dist/client/humans.js +78 -0
  46. package/dist/client/modelRegistration.d.ts +1 -1
  47. package/dist/client/modelRegistration.js +9 -9
  48. package/dist/client/options.d.ts +73 -17
  49. package/dist/client/reactiveEngine.d.ts +53 -0
  50. package/dist/client/reactiveEngine.js +688 -0
  51. package/dist/client/resourceTypes.d.ts +9 -250
  52. package/dist/client/resourceTypes.js +8 -5
  53. package/dist/client/schemaConfig.d.ts +4 -4
  54. package/dist/client/schemaConfig.js +6 -2
  55. package/dist/client/storeCluster.d.ts +47 -0
  56. package/dist/client/storeCluster.js +118 -0
  57. package/dist/client/storeLifecycle.d.ts +61 -0
  58. package/dist/client/storeLifecycle.js +231 -0
  59. package/dist/client/validateAbloOptions.d.ts +3 -2
  60. package/dist/client/validateAbloOptions.js +1 -1
  61. package/dist/client/wsMutationExecutor.d.ts +3 -3
  62. package/dist/client/wsMutationExecutor.js +3 -3
  63. package/dist/context.d.ts +22 -9
  64. package/dist/context.js +33 -9
  65. package/dist/coordination/ClaimLog.d.ts +26 -0
  66. package/dist/coordination/ClaimLog.js +32 -0
  67. package/dist/coordination/index.d.ts +1 -15
  68. package/dist/coordination/index.js +8 -31
  69. package/dist/core/index.d.ts +3 -3
  70. package/dist/core/index.js +2 -2
  71. package/dist/docs/catalog.d.ts +72 -0
  72. package/dist/docs/catalog.js +230 -0
  73. package/dist/docs/index.d.ts +10 -0
  74. package/dist/docs/index.js +10 -0
  75. package/dist/environment.d.ts +1 -40
  76. package/dist/environment.js +8 -37
  77. package/dist/index.d.ts +44 -36
  78. package/dist/index.js +30 -22
  79. package/dist/interfaces/index.d.ts +44 -134
  80. package/dist/keys/index.d.ts +1 -77
  81. package/dist/keys/index.js +8 -190
  82. package/dist/mutators/{RecordingTransaction.d.ts → RecordingMutation.d.ts} +4 -4
  83. package/dist/mutators/{RecordingTransaction.js → RecordingMutation.js} +2 -2
  84. package/dist/mutators/Transaction.d.ts +1 -1
  85. package/dist/mutators/Transaction.js +1 -1
  86. package/dist/mutators/UndoManager.d.ts +6 -6
  87. package/dist/mutators/UndoManager.js +5 -5
  88. package/dist/mutators/defineMutators.d.ts +3 -3
  89. package/dist/mutators/defineMutators.js +1 -1
  90. package/dist/mutators/inverseOp.js +2 -2
  91. package/dist/mutators/mutateActions.d.ts +3 -3
  92. package/dist/mutators/mutateActions.js +1 -1
  93. package/dist/mutators/readerActions.d.ts +1 -1
  94. package/dist/mutators/undoApply.d.ts +1 -1
  95. package/dist/mutators/undoApply.js +1 -1
  96. package/dist/policy/index.d.ts +2 -2
  97. package/dist/policy/index.js +1 -1
  98. package/dist/query/client.d.ts +5 -2
  99. package/dist/query/client.js +10 -9
  100. package/dist/query/types.d.ts +6 -41
  101. package/dist/query/types.js +2 -2
  102. package/dist/react/AbloProvider.d.ts +18 -8
  103. package/dist/react/AbloProvider.js +10 -9
  104. package/dist/react/context.d.ts +3 -3
  105. package/dist/react/context.js +1 -1
  106. package/dist/react/createAbloReact.d.ts +56 -0
  107. package/dist/react/createAbloReact.js +51 -0
  108. package/dist/react/index.d.ts +6 -5
  109. package/dist/react/index.js +6 -3
  110. package/dist/react/internalContext.d.ts +1 -1
  111. package/dist/react/useAblo.d.ts +12 -5
  112. package/dist/react/useAblo.js +26 -8
  113. package/dist/react/useCurrentUserId.js +1 -1
  114. package/dist/react/useErrorListener.js +1 -1
  115. package/dist/react/useMutationFailureListener.d.ts +2 -2
  116. package/dist/react/useMutationFailureListener.js +1 -1
  117. package/dist/react/useMutators.d.ts +3 -3
  118. package/dist/react/useMutators.js +3 -3
  119. package/dist/react/useUndoScope.d.ts +5 -5
  120. package/dist/react/useUndoScope.js +1 -1
  121. package/dist/schema/coordination.d.ts +69 -10
  122. package/dist/schema/coordination.js +90 -9
  123. package/dist/schema/ddl.js +2 -2
  124. package/dist/schema/diff.d.ts +1 -1
  125. package/dist/schema/generate.js +1 -1
  126. package/dist/schema/index.d.ts +11 -10
  127. package/dist/schema/index.js +22 -18
  128. package/dist/schema/queries.d.ts +27 -27
  129. package/dist/schema/queries.js +23 -23
  130. package/dist/schema/select.d.ts +3 -3
  131. package/dist/schema/select.js +6 -3
  132. package/dist/schema/serialize.d.ts +15 -6
  133. package/dist/schema/serialize.js +20 -3
  134. package/dist/schema/sugar.d.ts +6 -7
  135. package/dist/schema/sugar.js +9 -12
  136. package/dist/schema/syncDeltaRow.d.ts +4 -152
  137. package/dist/schema/syncDeltaRow.js +4 -105
  138. package/dist/server/adapter.d.ts +18 -1
  139. package/dist/server/commit.d.ts +10 -16
  140. package/dist/server/index.d.ts +1 -1
  141. package/dist/server/index.js +1 -1
  142. package/dist/server/readConfig.d.ts +1 -1
  143. package/dist/source/adapter.d.ts +7 -5
  144. package/dist/source/adapter.js +7 -5
  145. package/dist/source/adapters/drizzle.d.ts +1 -1
  146. package/dist/source/adapters/drizzle.js +2 -2
  147. package/dist/source/adapters/kysely.d.ts +1 -1
  148. package/dist/source/adapters/kysely.js +1 -1
  149. package/dist/source/adapters/kyselyMutationCore.d.ts +1 -1
  150. package/dist/source/adapters/kyselyMutationCore.js +2 -2
  151. package/dist/source/adapters/memory.js +1 -1
  152. package/dist/source/adapters/prisma.d.ts +8 -3
  153. package/dist/source/adapters/prisma.js +1 -1
  154. package/dist/source/connector.js +1 -1
  155. package/dist/source/connectorProtocol.d.ts +2 -8
  156. package/dist/source/connectorProtocol.js +3 -2
  157. package/dist/source/contract.d.ts +29 -17
  158. package/dist/source/contract.js +27 -22
  159. package/dist/source/factory.d.ts +1 -1
  160. package/dist/source/idempotency.js +2 -2
  161. package/dist/source/index.d.ts +1 -0
  162. package/dist/source/index.js +3 -0
  163. package/dist/source/next.d.ts +1 -1
  164. package/dist/source/signing.d.ts +9 -2
  165. package/dist/source/signing.js +4 -1
  166. package/dist/source/types.d.ts +6 -4
  167. package/dist/source/types.js +1 -1
  168. package/dist/{core/storeContract.d.ts → storeContract.d.ts} +6 -6
  169. package/dist/{core → stores}/DatabaseManager.d.ts +3 -1
  170. package/dist/{core → stores}/DatabaseManager.js +14 -13
  171. package/dist/stores/ObjectStore.d.ts +1 -1
  172. package/dist/{core → stores}/StoreManager.d.ts +9 -26
  173. package/dist/{core → stores}/StoreManager.js +29 -77
  174. package/dist/stores/SyncActionStore.d.ts +4 -2
  175. package/dist/stores/SyncActionStore.js +11 -17
  176. package/dist/stores/syncAction.d.ts +26 -0
  177. package/dist/stores/syncAction.js +16 -0
  178. package/dist/surface.d.ts +3 -3
  179. package/dist/surface.js +6 -4
  180. package/dist/sync/BootstrapFetcher.d.ts +127 -6
  181. package/dist/sync/BootstrapFetcher.js +511 -83
  182. package/dist/sync/ConnectionManager.d.ts +6 -198
  183. package/dist/sync/ConnectionManager.js +6 -677
  184. package/dist/sync/OnDemandLoader.d.ts +5 -2
  185. package/dist/sync/OnDemandLoader.js +61 -21
  186. package/dist/sync/SubscriptionManager.d.ts +13 -2
  187. package/dist/sync/SubscriptionManager.js +23 -5
  188. package/dist/sync/SyncWebSocket.d.ts +27 -510
  189. package/dist/sync/SyncWebSocket.js +76 -954
  190. package/dist/sync/awaitClaimGrant.d.ts +4 -44
  191. package/dist/sync/awaitClaimGrant.js +4 -109
  192. package/dist/sync/bootstrapApply.d.ts +3 -0
  193. package/dist/sync/bootstrapApply.js +2 -2
  194. package/dist/sync/commitFrames.d.ts +6 -40
  195. package/dist/sync/commitFrames.js +6 -97
  196. package/dist/sync/contextPorts.d.ts +18 -0
  197. package/dist/sync/contextPorts.js +31 -0
  198. package/dist/sync/createClaimStream.d.ts +5 -49
  199. package/dist/sync/createClaimStream.js +5 -469
  200. package/dist/sync/createPresenceStream.d.ts +26 -4
  201. package/dist/sync/createPresenceStream.js +28 -20
  202. package/dist/sync/createSnapshot.d.ts +2 -2
  203. package/dist/sync/createSnapshot.js +1 -1
  204. package/dist/sync/credentialLifecycle.d.ts +5 -173
  205. package/dist/sync/credentialLifecycle.js +5 -320
  206. package/dist/sync/deltaPipeline.d.ts +13 -12
  207. package/dist/sync/deltaPipeline.js +21 -4
  208. package/dist/sync/groupChange.d.ts +3 -0
  209. package/dist/sync/groupChange.js +16 -14
  210. package/dist/sync/participants.d.ts +24 -6
  211. package/dist/sync/participants.js +32 -23
  212. package/dist/sync/schemaDrift.d.ts +55 -0
  213. package/dist/sync/schemaDrift.js +53 -0
  214. package/dist/sync/schemas.d.ts +23 -33
  215. package/dist/sync/schemas.js +29 -20
  216. package/dist/sync/syncPlan.d.ts +3 -3
  217. package/dist/sync/wsFrameHandlers.d.ts +6 -114
  218. package/dist/sync/wsFrameHandlers.js +6 -392
  219. package/dist/syncLog/contract.d.ts +20 -0
  220. package/dist/syncLog/contract.js +19 -0
  221. package/dist/syncLog/index.d.ts +1 -0
  222. package/dist/syncLog/index.js +1 -0
  223. package/dist/transaction/ablo.d.ts +88 -0
  224. package/dist/transaction/ablo.js +33 -0
  225. package/dist/{client/auth.d.ts → transaction/auth/apiKey.d.ts} +43 -8
  226. package/dist/{client/auth.js → transaction/auth/apiKey.js} +19 -0
  227. package/dist/transaction/auth/bootstrapScope.d.ts +15 -0
  228. package/dist/transaction/auth/bootstrapScope.js +1 -0
  229. package/dist/transaction/auth/capability.d.ts +212 -0
  230. package/dist/transaction/auth/capability.js +224 -0
  231. package/dist/{auth → transaction/auth}/credentialSource.d.ts +8 -1
  232. package/dist/{client → transaction/auth}/identity.d.ts +8 -7
  233. package/dist/{client → transaction/auth}/identity.js +1 -1
  234. package/dist/transaction/auth/index.d.ts +162 -0
  235. package/dist/transaction/auth/index.js +304 -0
  236. package/dist/{auth → transaction/auth}/schemas.d.ts +1 -1
  237. package/dist/{auth → transaction/auth}/schemas.js +13 -13
  238. package/dist/{client → transaction/auth}/sessionMint.d.ts +8 -8
  239. package/dist/{client → transaction/auth}/sessionMint.js +4 -7
  240. package/dist/transaction/coordination/awaitClaimGrant.d.ts +56 -0
  241. package/dist/transaction/coordination/awaitClaimGrant.js +124 -0
  242. package/dist/{client → transaction/coordination}/claimHeartbeatLoop.d.ts +34 -0
  243. package/dist/{client → transaction/coordination}/claimHeartbeatLoop.js +20 -0
  244. package/dist/transaction/coordination/claimMeta.d.ts +49 -0
  245. package/dist/transaction/coordination/claimMeta.js +52 -0
  246. package/dist/transaction/coordination/createClaimStream.d.ts +64 -0
  247. package/dist/transaction/coordination/createClaimStream.js +475 -0
  248. package/dist/transaction/coordination/events.d.ts +74 -0
  249. package/dist/transaction/coordination/events.js +7 -0
  250. package/dist/transaction/coordination/index.d.ts +19 -0
  251. package/dist/transaction/coordination/index.js +45 -0
  252. package/dist/transaction/coordination/locator.d.ts +104 -0
  253. package/dist/transaction/coordination/locator.js +102 -0
  254. package/dist/transaction/coordination/schema.d.ts +1536 -0
  255. package/dist/transaction/coordination/schema.js +1177 -0
  256. package/dist/transaction/coordination/targetConflict.d.ts +2 -0
  257. package/dist/transaction/coordination/targetConflict.js +107 -0
  258. package/dist/{coordination → transaction/coordination}/trace.d.ts +7 -18
  259. package/dist/{coordination → transaction/coordination}/trace.js +18 -25
  260. package/dist/transaction/durableWrites.d.ts +62 -0
  261. package/dist/{client → transaction}/durableWrites.js +28 -3
  262. package/dist/transaction/environment.d.ts +105 -0
  263. package/dist/transaction/environment.js +108 -0
  264. package/dist/{errorCodes.d.ts → transaction/errorCodes.d.ts} +12 -12
  265. package/dist/{errorCodes.js → transaction/errorCodes.js} +45 -18
  266. package/dist/{errors.d.ts → transaction/errors.d.ts} +37 -13
  267. package/dist/{errors.js → transaction/errors.js} +85 -16
  268. package/dist/transaction/footprint.d.ts +111 -0
  269. package/dist/transaction/footprint.js +0 -0
  270. package/dist/transaction/index.d.ts +20 -0
  271. package/dist/transaction/index.js +20 -0
  272. package/dist/transaction/keys/index.d.ts +87 -0
  273. package/dist/transaction/keys/index.js +207 -0
  274. package/dist/transaction/log/syncDeltaRow.d.ts +158 -0
  275. package/dist/transaction/log/syncDeltaRow.js +95 -0
  276. package/dist/{sync/syncPosition.d.ts → transaction/logPosition.d.ts} +22 -8
  277. package/dist/{sync/syncPosition.js → transaction/logPosition.js} +15 -6
  278. package/dist/transaction/logger.d.ts +16 -0
  279. package/dist/transaction/logger.js +7 -0
  280. package/dist/transaction/observability.d.ts +53 -0
  281. package/dist/transaction/observability.js +19 -0
  282. package/dist/transaction/plugin.d.ts +285 -0
  283. package/dist/transaction/plugin.js +106 -0
  284. package/dist/{policy → transaction/policy}/types.d.ts +3 -3
  285. package/dist/{policy → transaction/policy}/types.js +2 -0
  286. package/dist/transaction/resources/httpResources.d.ts +321 -0
  287. package/dist/transaction/resources/httpResources.js +7 -0
  288. package/dist/transaction/resources/modelOperations.d.ts +427 -0
  289. package/dist/transaction/resources/modelOperations.js +12 -0
  290. package/dist/transaction/resources/mutationOptions.d.ts +66 -0
  291. package/dist/transaction/resources/mutationOptions.js +9 -0
  292. package/dist/transaction/resources/where.d.ts +101 -0
  293. package/dist/transaction/resources/where.js +115 -0
  294. package/dist/{client → transaction/resources}/writeOptionsSchema.d.ts +2 -6
  295. package/dist/{client → transaction/resources}/writeOptionsSchema.js +9 -5
  296. package/dist/{schema → transaction/schema}/field.d.ts +17 -23
  297. package/dist/{schema → transaction/schema}/field.js +5 -5
  298. package/dist/transaction/schema/fieldRef.d.ts +38 -0
  299. package/dist/transaction/schema/fieldRef.js +11 -0
  300. package/dist/transaction/schema/loadStrategy.d.ts +45 -0
  301. package/dist/transaction/schema/loadStrategy.js +46 -0
  302. package/dist/{schema → transaction/schema}/model.d.ts +50 -35
  303. package/dist/{schema → transaction/schema}/model.js +30 -20
  304. package/dist/transaction/schema/openapi.d.ts +58 -0
  305. package/dist/transaction/schema/openapi.js +501 -0
  306. package/dist/{schema → transaction/schema}/relation.d.ts +21 -16
  307. package/dist/{schema → transaction/schema}/relation.js +7 -7
  308. package/dist/{schema → transaction/schema}/residency.d.ts +0 -9
  309. package/dist/{schema → transaction/schema}/residency.js +0 -5
  310. package/dist/{schema → transaction/schema}/roles.d.ts +5 -5
  311. package/dist/{schema → transaction/schema}/roles.js +5 -5
  312. package/dist/{schema → transaction/schema}/schema.d.ts +39 -10
  313. package/dist/{schema → transaction/schema}/schema.js +24 -3
  314. package/dist/{schema → transaction/schema}/tenancy.d.ts +1 -1
  315. package/dist/{schema → transaction/schema}/tenancy.js +7 -4
  316. package/dist/transaction/transactionLayer.d.ts +82 -0
  317. package/dist/transaction/transactionLayer.js +24 -0
  318. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.d.ts +5 -6
  319. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.js +9 -13
  320. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.d.ts +9 -2
  321. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.js +5 -9
  322. package/dist/{transactions/durableWriteStore.d.ts → transaction/transactions/settlement/pendingWrite.d.ts} +11 -37
  323. package/dist/transaction/transactions/settlement/pendingWrite.js +20 -0
  324. package/dist/transaction/transport/commitFrames.d.ts +90 -0
  325. package/dist/transaction/transport/commitFrames.js +134 -0
  326. package/dist/transaction/transport/connectionManager.d.ts +215 -0
  327. package/dist/transaction/transport/connectionManager.js +673 -0
  328. package/dist/transaction/transport/credentialLifecycle.d.ts +177 -0
  329. package/dist/transaction/transport/credentialLifecycle.js +324 -0
  330. package/dist/{sync → transaction/transport}/heartbeat.d.ts +3 -1
  331. package/dist/{sync → transaction/transport}/heartbeat.js +6 -4
  332. package/dist/transaction/transport/httpClient.d.ts +131 -0
  333. package/dist/{client → transaction/transport}/httpClient.js +6 -5
  334. package/dist/transaction/transport/httpOptions.d.ts +33 -0
  335. package/dist/transaction/transport/httpOptions.js +12 -0
  336. package/dist/{client → transaction/transport}/httpTransport.js +295 -97
  337. package/dist/{sync/NetworkProbe.d.ts → transaction/transport/networkProbe.d.ts} +7 -4
  338. package/dist/{sync/NetworkProbe.js → transaction/transport/networkProbe.js} +14 -13
  339. package/dist/transaction/transport/wsFrameHandlers.d.ts +128 -0
  340. package/dist/transaction/transport/wsFrameHandlers.js +429 -0
  341. package/dist/transaction/transport/wsTransport.d.ts +574 -0
  342. package/dist/transaction/transport/wsTransport.js +1023 -0
  343. package/dist/transaction/types/assertExact.d.ts +17 -0
  344. package/dist/transaction/types/assertExact.js +1 -0
  345. package/dist/{types → transaction/types}/global.d.ts +17 -2
  346. package/dist/{types → transaction/types}/global.js +2 -1
  347. package/dist/{types → transaction/types}/index.d.ts +14 -46
  348. package/dist/{types → transaction/types}/index.js +7 -16
  349. package/dist/{types → transaction/types}/streams.d.ts +73 -45
  350. package/dist/transaction/utils/duration.d.ts +50 -0
  351. package/dist/{utils → transaction/utils}/duration.js +32 -0
  352. package/dist/{utils → transaction/utils}/json.d.ts +18 -0
  353. package/dist/transaction/utils/json.js +276 -0
  354. package/dist/transaction/wire/accountResponses.d.ts +420 -0
  355. package/dist/transaction/wire/accountResponses.js +290 -0
  356. package/dist/transaction/wire/auth.d.ts +56 -0
  357. package/dist/transaction/wire/auth.js +63 -0
  358. package/dist/transaction/wire/claimEvent.d.ts +76 -0
  359. package/dist/transaction/wire/claimEvent.js +73 -0
  360. package/dist/transaction/wire/claims.d.ts +530 -0
  361. package/dist/transaction/wire/claims.js +327 -0
  362. package/dist/{wire → transaction/wire}/commit.d.ts +125 -193
  363. package/dist/{wire → transaction/wire}/commit.js +68 -47
  364. package/dist/{wire → transaction/wire}/delta.d.ts +66 -17
  365. package/dist/{wire → transaction/wire}/delta.js +37 -13
  366. package/dist/transaction/wire/errorEnvelope.d.ts +72 -0
  367. package/dist/{wire → transaction/wire}/errorEnvelope.js +36 -5
  368. package/dist/transaction/wire/feedCursor.d.ts +60 -0
  369. package/dist/transaction/wire/feedCursor.js +82 -0
  370. package/dist/transaction/wire/feedEvent.d.ts +204 -0
  371. package/dist/transaction/wire/feedEvent.js +65 -0
  372. package/dist/transaction/wire/frames.d.ts +194 -0
  373. package/dist/transaction/wire/frames.js +50 -0
  374. package/dist/transaction/wire/inboundFrames.d.ts +562 -0
  375. package/dist/transaction/wire/inboundFrames.js +116 -0
  376. package/dist/transaction/wire/index.d.ts +54 -0
  377. package/dist/transaction/wire/index.js +83 -0
  378. package/dist/{wire → transaction/wire}/listEnvelope.d.ts +13 -14
  379. package/dist/transaction/wire/listEnvelope.js +42 -0
  380. package/dist/transaction/wire/modelMutations.d.ts +31 -0
  381. package/dist/transaction/wire/modelMutations.js +52 -0
  382. package/dist/transaction/wire/modelResponses.d.ts +85 -0
  383. package/dist/transaction/wire/modelResponses.js +43 -0
  384. package/dist/transaction/wire/modelShape.d.ts +78 -0
  385. package/dist/transaction/wire/modelShape.js +74 -0
  386. package/dist/transactions/{TransactionQueue.d.ts → mutations/MutationQueue.d.ts} +85 -38
  387. package/dist/transactions/{TransactionQueue.js → mutations/MutationQueue.js} +141 -80
  388. package/dist/transactions/{TransactionStore.d.ts → mutations/MutationStore.d.ts} +8 -8
  389. package/dist/transactions/{TransactionStore.js → mutations/MutationStore.js} +2 -2
  390. package/dist/transactions/{coalesceRules.d.ts → mutations/coalesceRules.d.ts} +10 -10
  391. package/dist/transactions/{coalesceRules.js → mutations/coalesceRules.js} +1 -1
  392. package/dist/transactions/mutations/commitLatency.d.ts +52 -0
  393. package/dist/transactions/mutations/commitLatency.js +130 -0
  394. package/dist/transactions/{commitOutboxStore.d.ts → mutations/commitOutboxStore.d.ts} +1 -5
  395. package/dist/transactions/{commitOutboxStore.js → mutations/commitOutboxStore.js} +1 -1
  396. package/dist/transactions/{commitPayload.d.ts → mutations/commitPayload.d.ts} +18 -16
  397. package/dist/transactions/{commitPayload.js → mutations/commitPayload.js} +15 -15
  398. package/dist/transactions/{deltaConfirmation.d.ts → mutations/deltaConfirmation.d.ts} +15 -11
  399. package/dist/transactions/{deltaConfirmation.js → mutations/deltaConfirmation.js} +14 -12
  400. package/dist/transactions/mutations/durableWriteStore.d.ts +14 -0
  401. package/dist/transactions/mutations/durableWriteStore.js +12 -0
  402. package/dist/transactions/{optimisticApply.d.ts → mutations/optimisticApply.d.ts} +7 -7
  403. package/dist/transactions/{replayValidation.d.ts → mutations/replayValidation.d.ts} +4 -3
  404. package/dist/transactions/{replayValidation.js → mutations/replayValidation.js} +7 -5
  405. package/dist/utils/mobxSetup.d.ts +1 -1
  406. package/dist/utils/mobxSetup.js +5 -2
  407. package/dist/{core → views}/QueryView.d.ts +2 -2
  408. package/dist/{core → views}/QueryView.js +2 -2
  409. package/dist/{core → views}/ViewRegistry.d.ts +1 -1
  410. package/dist/{core/queryUtils.d.ts → views/incrementalView.d.ts} +6 -6
  411. package/dist/{core/queryUtils.js → views/incrementalView.js} +6 -6
  412. package/dist/webhooks/events.d.ts +2 -2
  413. package/dist/wire/index.d.ts +1 -34
  414. package/dist/wire/index.js +8 -49
  415. package/docs/agent-messaging.md +3 -3
  416. package/docs/agents.md +20 -13
  417. package/docs/api-keys.md +14 -10
  418. package/docs/api.md +27 -61
  419. package/docs/audit.md +6 -3
  420. package/docs/cli.md +41 -13
  421. package/docs/client-behavior.md +11 -9
  422. package/docs/concurrency-convention.md +49 -57
  423. package/docs/coordination.md +283 -121
  424. package/docs/data-sources.md +7 -5
  425. package/docs/debugging.md +39 -15
  426. package/docs/deployment.md +267 -0
  427. package/docs/examples/agent-human.md +49 -42
  428. package/docs/examples/ai-sdk-tool.md +69 -44
  429. package/docs/examples/existing-python-backend.md +8 -6
  430. package/docs/examples/nextjs.md +129 -47
  431. package/docs/examples/scoped-agent.md +46 -45
  432. package/docs/examples/server-agent.md +46 -26
  433. package/docs/groups.md +87 -30
  434. package/docs/guarantees.md +41 -12
  435. package/docs/how-it-works.md +38 -12
  436. package/docs/idempotency.md +126 -0
  437. package/docs/identity.md +77 -74
  438. package/docs/index.md +172 -86
  439. package/docs/integration-guide.md +31 -19
  440. package/docs/mcp.md +46 -21
  441. package/docs/migration.md +95 -18
  442. package/docs/operating-on-your-database.md +3 -1
  443. package/docs/projects.md +3 -1
  444. package/docs/quickstart.md +22 -5
  445. package/docs/react.md +31 -18
  446. package/docs/schema-contract.md +5 -3
  447. package/docs/session-settings.md +108 -0
  448. package/docs/sessions.md +4 -2
  449. package/docs/webhooks.md +12 -10
  450. package/llms.txt +48 -18
  451. package/package.json +21 -26
  452. package/dist/agent/Agent.d.ts +0 -366
  453. package/dist/agent/Agent.js +0 -514
  454. package/dist/agent/index.d.ts +0 -115
  455. package/dist/agent/index.js +0 -128
  456. package/dist/agent/session.d.ts +0 -93
  457. package/dist/agent/session.js +0 -149
  458. package/dist/agent/types.d.ts +0 -68
  459. package/dist/agent/types.js +0 -9
  460. package/dist/cli.cjs +0 -286329
  461. package/dist/client/durableWrites.d.ts +0 -21
  462. package/dist/client/httpClient.d.ts +0 -80
  463. package/dist/coordination/schema.d.ts +0 -722
  464. package/dist/coordination/schema.js +0 -578
  465. package/dist/schema/openapi.d.ts +0 -29
  466. package/dist/schema/openapi.js +0 -124
  467. package/dist/testing/fixtures/bootstrap.d.ts +0 -49
  468. package/dist/testing/fixtures/bootstrap.js +0 -59
  469. package/dist/testing/fixtures/deltas.d.ts +0 -83
  470. package/dist/testing/fixtures/deltas.js +0 -136
  471. package/dist/testing/fixtures/models.d.ts +0 -83
  472. package/dist/testing/fixtures/models.js +0 -272
  473. package/dist/testing/helpers/reactWrapper.d.ts +0 -69
  474. package/dist/testing/helpers/reactWrapper.js +0 -67
  475. package/dist/testing/helpers/syncEngineHarness.d.ts +0 -54
  476. package/dist/testing/helpers/syncEngineHarness.js +0 -73
  477. package/dist/testing/helpers/wait.d.ts +0 -30
  478. package/dist/testing/helpers/wait.js +0 -49
  479. package/dist/testing/index.d.ts +0 -23
  480. package/dist/testing/index.js +0 -33
  481. package/dist/testing/mocks/FakeDatabase.d.ts +0 -18
  482. package/dist/testing/mocks/FakeDatabase.js +0 -10
  483. package/dist/testing/mocks/MockMutationExecutor.d.ts +0 -87
  484. package/dist/testing/mocks/MockMutationExecutor.js +0 -192
  485. package/dist/testing/mocks/MockNetworkMonitor.d.ts +0 -20
  486. package/dist/testing/mocks/MockNetworkMonitor.js +0 -46
  487. package/dist/testing/mocks/MockSyncContext.d.ts +0 -51
  488. package/dist/testing/mocks/MockSyncContext.js +0 -71
  489. package/dist/testing/mocks/MockSyncStore.d.ts +0 -88
  490. package/dist/testing/mocks/MockSyncStore.js +0 -171
  491. package/dist/testing/mocks/MockWebSocket.d.ts +0 -71
  492. package/dist/testing/mocks/MockWebSocket.js +0 -118
  493. package/dist/transactions/durableWriteStore.js +0 -30
  494. package/dist/utils/duration.d.ts +0 -25
  495. package/dist/utils/json.js +0 -88
  496. package/dist/wire/errorEnvelope.d.ts +0 -55
  497. package/dist/wire/frames.d.ts +0 -197
  498. package/dist/wire/frames.js +0 -49
  499. package/dist/wire/listEnvelope.js +0 -18
  500. package/docs/interaction-model.md +0 -97
  501. /package/dist/{core → query}/QueryProcessor.d.ts +0 -0
  502. /package/dist/{core → query}/QueryProcessor.js +0 -0
  503. /package/dist/{core/storeContract.js → storeContract.js} +0 -0
  504. /package/dist/{core → stores}/openIDBWithTimeout.d.ts +0 -0
  505. /package/dist/{core → stores}/openIDBWithTimeout.js +0 -0
  506. /package/dist/{client → transaction/auth}/credentialEndpoint.d.ts +0 -0
  507. /package/dist/{client → transaction/auth}/credentialEndpoint.js +0 -0
  508. /package/dist/{auth → transaction/auth}/credentialPolicy.d.ts +0 -0
  509. /package/dist/{auth → transaction/auth}/credentialPolicy.js +0 -0
  510. /package/dist/{auth → transaction/auth}/credentialSource.js +0 -0
  511. /package/dist/{client → transaction/auth}/hostedEndpoints.d.ts +0 -0
  512. /package/dist/{client → transaction/auth}/hostedEndpoints.js +0 -0
  513. /package/dist/{client → transaction}/persistence.d.ts +0 -0
  514. /package/dist/{client → transaction}/persistence.js +0 -0
  515. /package/dist/{client → transaction/resources}/functionalUpdate.d.ts +0 -0
  516. /package/dist/{client → transaction/resources}/functionalUpdate.js +0 -0
  517. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.d.ts +0 -0
  518. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.js +0 -0
  519. /package/dist/{client → transaction/transport}/httpTransport.d.ts +0 -0
  520. /package/dist/{types → transaction/types}/modelData.d.ts +0 -0
  521. /package/dist/{types → transaction/types}/modelData.js +0 -0
  522. /package/dist/{types → transaction/types}/participant.d.ts +0 -0
  523. /package/dist/{types → transaction/types}/participant.js +0 -0
  524. /package/dist/{types → transaction/types}/streams.js +0 -0
  525. /package/dist/{utils → transaction/utils}/asyncIterator.d.ts +0 -0
  526. /package/dist/{utils → transaction/utils}/asyncIterator.js +0 -0
  527. /package/dist/{wire → transaction/wire}/bootstrapReason.d.ts +0 -0
  528. /package/dist/{wire → transaction/wire}/bootstrapReason.js +0 -0
  529. /package/dist/{wire → transaction/wire}/protocol.d.ts +0 -0
  530. /package/dist/{wire → transaction/wire}/protocol.js +0 -0
  531. /package/dist/{wire → transaction/wire}/protocolVersion.d.ts +0 -0
  532. /package/dist/{wire → transaction/wire}/protocolVersion.js +0 -0
  533. /package/dist/transactions/{UnconfirmedWrites.d.ts → mutations/UnconfirmedWrites.d.ts} +0 -0
  534. /package/dist/transactions/{UnconfirmedWrites.js → mutations/UnconfirmedWrites.js} +0 -0
  535. /package/dist/transactions/{optimisticApply.js → mutations/optimisticApply.js} +0 -0
  536. /package/dist/{core → views}/ViewRegistry.js +0 -0
@@ -0,0 +1,688 @@
1
+ /**
2
+ * The reactive engine assembly (ADR 0016). `Ablo({ ... })` resolves auth and
3
+ * capabilities; `humans().init` constructs the store cluster; the lifecycle
4
+ * — first mint, identity, ready() — lives in `./storeLifecycle.ts`. What
5
+ * remains here is assembly around those parts: the claim stream and
6
+ * participant manager, options validation, the typed model proxies, and the
7
+ * commit/claim/session resources — composed into the reactive client.
8
+ *
9
+ * Extracted from the factory so the composition root stays a root: resolve,
10
+ * dispatch, return. The remaining assembly converts to decoration of a
11
+ * host-built core client with the per-model surface split — the cut's own
12
+ * design step (docs/plans/package-split.md).
13
+ */
14
+ import { durableCommitOperationSchema, } from '../transaction/transactions/settlement/commitEnvelope.js';
15
+ import { AbloAuthenticationError, AbloConnectionError, AbloValidationError, claimedError } from '../transaction/errors.js';
16
+ import { batchFence, fenceTokenFor, modelTarget, streamTarget, subTarget, } from '../transaction/coordination/index.js';
17
+ import { validateAbloOptions } from './validateAbloOptions.js';
18
+ import { mintSession } from '../transaction/auth/sessionMint.js';
19
+ import { modelWireNames } from '../transaction/auth/capability.js';
20
+ import { startStoreLifecycle } from './storeLifecycle.js';
21
+ import { createClaimStream } from '../sync/createClaimStream.js';
22
+ import { awaitClaimGrant } from '../sync/awaitClaimGrant.js';
23
+ import { createSnapshot } from '../sync/createSnapshot.js';
24
+ import { createParticipantManager } from '../sync/participants.js';
25
+ import { resolveApiKeyValue, resolveBootstrapBaseUrl } from '../transaction/auth/apiKey.js';
26
+ import { createModelProxy } from './createModelProxy.js';
27
+ import { assertWriteOptions } from '../transaction/resources/writeOptionsSchema.js';
28
+ export function buildReactiveEngine(inputs) {
29
+ const { options, internalOptions, url, logger, configuredApiKey, configuredAuthToken, credentialResolver, authCredentials, transport, participantId, kind, presence, cluster, createSibling, } = inputs;
30
+ const schema = options.schema;
31
+ // The store cluster — this client's runtime, the component graph, the
32
+ // registered models, and the store — was constructed by `humans().init`
33
+ // from the widened plugin context (see `./storeCluster.ts`). The engine
34
+ // assembles around it.
35
+ const { runtime, components, store } = cluster;
36
+ const { modelRegistry, objectPool, bootstrapHelper, database, syncClient, hydration, } = components;
37
+ // Self identity, late-bound the same way the connection's values are: the
38
+ // construction-time guess seeds it (correct on the self-hosted path, empty
39
+ // on the hosted path), and `ready()` overwrites it with what identity
40
+ // resolution derives from the credential's scope. The model proxies read
41
+ // it through getters, so the is-this-claim-mine checks always compare
42
+ // against the resolved identity.
43
+ let selfParticipantId = participantId;
44
+ let selfParticipantKind = kind;
45
+ // Presence + claim streams — the same reference for the engine's lifetime,
46
+ // attached to the connection at construction (it exists — the host built
47
+ // it; sends before the socket opens are dropped by the transport's
48
+ // send-during-reconnect contract, and each stream re-announces on
49
+ // `connected`). The presence stream is the humans() plugin's contribution,
50
+ // built and attached by its `init` (ADR 0016); the claim stream is core
51
+ // coordination, so the root constructs it regardless of the list. Both
52
+ // filter own echoes by participant id, seeded in `ready()` alongside the
53
+ // locals above.
54
+ const presenceStream = presence;
55
+ const claimStream = createClaimStream({ participantId, logger }, transport);
56
+ // 6. Validate options up front — fail loudly on obviously wrong inputs so
57
+ // strangers don't get silent empty results. Validation errors are written
58
+ // into `store.syncStatus` (the single source of truth).
59
+ const _validationError = validateAbloOptions({
60
+ options: internalOptions,
61
+ url,
62
+ configuredApiKey,
63
+ configuredAuthToken,
64
+ });
65
+ if (_validationError) {
66
+ logger.error(_validationError.message);
67
+ store.syncStatus.state = 'error';
68
+ store.syncStatus.error = _validationError;
69
+ }
70
+ // Deprecated identity overrides are a silent no-op under hosted cloud: when an
71
+ // `apiKey` is configured the SERVER derives participant kind + id from the
72
+ // key's scope, so `kind` / `agentId` passed here are ignored. Setting them and
73
+ // trusting them is the trap (you think you're an agent; the key says user).
74
+ // Warn loudly rather than removing the fields — `agentId` is still load-bearing
75
+ // on the self-hosted path (no apiKey; paired with `capabilityToken`).
76
+ // eslint-disable-next-line @typescript-eslint/no-deprecated -- reads the deprecated fields precisely to warn callers off them under a configured apiKey
77
+ if (configuredApiKey && (internalOptions.kind || internalOptions.agentId)) {
78
+ logger.warn('Ablo: `kind` / `agentId` are ignored when an `apiKey` is configured — ' +
79
+ 'the server derives participant identity from the key’s scope. Remove ' +
80
+ 'them (or mint a scoped session via `ablo.sessions.create({ agent })` ' +
81
+ 'for a distinct agent identity). They apply only to the self-hosted ' +
82
+ '`capabilityToken` path.');
83
+ }
84
+ // 7. The lifecycle — first mint, identity resolution, credential refresh,
85
+ // and the idempotent ready() driving store.initialize() — is the
86
+ // materialiser's own (`./storeLifecycle.ts`); the engine wires it with
87
+ // the prelude's credential slice and seeds its own state through the
88
+ // callback: the self locals (read by the model proxies' getters) and
89
+ // the streams' own-echo filters, before the store ever connects.
90
+ /** Resolved account scope — seeded once identity resolution completes;
91
+ * exposed as the readonly `ablo.organizationId` accessor. */
92
+ let _resolvedOrganizationId = null;
93
+ const lifecycle = startStoreLifecycle({
94
+ cluster,
95
+ schema,
96
+ internalOptions,
97
+ authCredentials,
98
+ credentialResolver,
99
+ configuredApiKey,
100
+ configuredAuthToken,
101
+ url,
102
+ kind,
103
+ logger,
104
+ validationError: _validationError,
105
+ onIdentityResolved: ({ userId, participantKind, accountScope, syncGroups }) => {
106
+ selfParticipantId = userId;
107
+ selfParticipantKind = participantKind;
108
+ _resolvedOrganizationId = accountScope;
109
+ presenceStream.setParticipant({
110
+ id: userId,
111
+ kind: participantKind,
112
+ syncGroups: [...syncGroups],
113
+ });
114
+ claimStream.setParticipant({ id: userId });
115
+ },
116
+ });
117
+ const ready = lifecycle.ready;
118
+ const participantManager = createParticipantManager({
119
+ ready,
120
+ transport,
121
+ presence: presenceStream,
122
+ claims: claimStream,
123
+ schema,
124
+ });
125
+ // 9b. waitForFlush — drains pending mutations using the store's
126
+ // pendingChanges counter (already maintained by BaseSyncedStore based
127
+ // on MutationQueue events). Polls every 50ms; uses the existing
128
+ // observable rather than introducing a new event channel.
129
+ async function waitForFlush(timeoutMs) {
130
+ const start = Date.now();
131
+ while (store.syncStatus.pendingChanges > 0) {
132
+ if (timeoutMs !== undefined && Date.now() - start > timeoutMs) {
133
+ throw new AbloConnectionError(`Flush timeout: ${store.syncStatus.pendingChanges} pending mutations after ${timeoutMs}ms`, { code: 'flush_timeout' });
134
+ }
135
+ await new Promise((resolve) => setTimeout(resolve, 50));
136
+ }
137
+ }
138
+ function createClientTxId(idempotencyKey) {
139
+ if (idempotencyKey && idempotencyKey.length > 0)
140
+ return idempotencyKey;
141
+ return typeof crypto !== 'undefined' && typeof crypto.randomUUID === 'function'
142
+ ? crypto.randomUUID()
143
+ : `tx_${Date.now()}_${Math.random().toString(36).slice(2, 10)}`;
144
+ }
145
+ function normalizeCommitOperation(op, defaults, fence) {
146
+ const type = op.action.toUpperCase();
147
+ const id = op.id ?? '';
148
+ return durableCommitOperationSchema.parse({
149
+ type,
150
+ model: op.model.toLowerCase(),
151
+ id,
152
+ input: op.data ?? undefined,
153
+ transactionId: op.transactionId ?? undefined,
154
+ readAt: op.readAt ?? defaults.readAt ?? undefined,
155
+ onStale: op.onStale ?? defaults.onStale ?? undefined,
156
+ fenceToken: op.fenceToken ?? fenceTokenFor(fence, op.model, op.id ?? null) ?? undefined,
157
+ });
158
+ }
159
+ function normalizeCommitOperations(commitOptions, fence) {
160
+ if (commitOptions.operations.length === 0) {
161
+ throw new AbloValidationError('Commit requires a non-empty `operations` array.', { code: 'commit_operation_required' });
162
+ }
163
+ return commitOptions.operations.map((op) => normalizeCommitOperation(op, commitOptions, fence));
164
+ }
165
+ function modelClaimFromActive(claim) {
166
+ const target = {
167
+ ...modelTarget(claim.target),
168
+ ...subTarget(claim.target),
169
+ };
170
+ return {
171
+ id: claim.id,
172
+ actor: claim.heldBy ?? "",
173
+ participantKind: claim.participantKind ?? "user",
174
+ description: claim.description,
175
+ field: claim.target.field,
176
+ status: 'active',
177
+ expiresAt: claim.expiresAt ?? 0,
178
+ target,
179
+ // The claim's metadata read as the open record it is on the wire, so a
180
+ // key the coordinator wrote — a heartbeat's `progress` — is readable.
181
+ // `target.meta` is the same bag under the shape the program declared,
182
+ // and a declared shape has no member for something the holder did not
183
+ // write.
184
+ ...(target.meta !== undefined ? { meta: target.meta } : {}),
185
+ };
186
+ }
187
+ function targetMatchesModel(target, claim) {
188
+ if (target.model &&
189
+ claim.target.type.toLowerCase() !== target.model.toLowerCase()) {
190
+ return false;
191
+ }
192
+ if (target.id && claim.target.id !== target.id)
193
+ return false;
194
+ if (target.field && claim.target.field !== target.field)
195
+ return false;
196
+ return true;
197
+ }
198
+ function listModelClaims(target) {
199
+ return claimStream.others
200
+ .filter((claim) => (target ? targetMatchesModel(target, claim) : true))
201
+ .map(modelClaimFromActive);
202
+ }
203
+ function waitForModelUnclaimed(target, options) {
204
+ if (listModelClaims(target).length === 0)
205
+ return Promise.resolve();
206
+ return new Promise((resolve, reject) => {
207
+ let settled = false;
208
+ let timeoutId;
209
+ const cleanup = () => {
210
+ if (timeoutId)
211
+ clearTimeout(timeoutId);
212
+ unsubscribe();
213
+ options?.signal?.removeEventListener('abort', onAbort);
214
+ };
215
+ const finish = (fn) => {
216
+ if (settled)
217
+ return;
218
+ settled = true;
219
+ cleanup();
220
+ fn();
221
+ };
222
+ const check = () => {
223
+ if (listModelClaims(target).length === 0) {
224
+ finish(resolve);
225
+ }
226
+ };
227
+ const abortError = () => new AbloConnectionError('Claim wait aborted.', {
228
+ code: 'claim_wait_aborted',
229
+ cause: options?.signal?.reason,
230
+ });
231
+ const onAbort = () => {
232
+ finish(() => { reject(abortError()); });
233
+ };
234
+ // Answered before the subscription, the listener, and the timer exist,
235
+ // so there is nothing for `cleanup` to undo — and nothing that would
236
+ // read `unsubscribe` ahead of the line that binds it.
237
+ if (options?.signal?.aborted) {
238
+ reject(abortError());
239
+ return;
240
+ }
241
+ const unsubscribe = claimStream.onChange(check);
242
+ options?.signal?.addEventListener('abort', onAbort, { once: true });
243
+ if (options?.timeout != null) {
244
+ timeoutId = setTimeout(() => {
245
+ finish(() => {
246
+ reject(claimedError(target, listModelClaims(target), 'model_claimed_timeout'));
247
+ });
248
+ }, options.timeout);
249
+ }
250
+ });
251
+ }
252
+ function wrapClaimHandle(claim, waited = false, fenceToken) {
253
+ const release = () => {
254
+ claim.revoke?.();
255
+ return Promise.resolve();
256
+ };
257
+ // The token is server-stamped and arrives on the grant frame, so prefer
258
+ // the one `awaitClaimGrant` read there; fall back to any the local handle
259
+ // already carried (immediate, non-queued grants).
260
+ const resolvedFenceToken = fenceToken ?? claim.fenceToken;
261
+ return {
262
+ object: 'claim',
263
+ id: claim.id,
264
+ description: claim.description,
265
+ target: claim.target,
266
+ waited,
267
+ ...(resolvedFenceToken !== undefined ? { fenceToken: resolvedFenceToken } : {}),
268
+ release,
269
+ revoke: claim.revoke,
270
+ // The lease-control members are forwarded explicitly — this wrapper
271
+ // rebuilds the handle field by field, so anything not named here is
272
+ // silently dropped from the public claim.
273
+ heartbeat: claim.heartbeat,
274
+ [Symbol.asyncDispose]: release,
275
+ };
276
+ }
277
+ const publicClaims = Object.assign(claimStream, {
278
+ async create(claimOptions) {
279
+ await ready();
280
+ const claim = claimStream.claim({
281
+ ...streamTarget(claimOptions.target),
282
+ ...subTarget(claimOptions.target),
283
+ }, {
284
+ description: claimOptions.description,
285
+ ttl: claimOptions.ttl,
286
+ queue: claimOptions.queue,
287
+ });
288
+ // With `queue`, the claim is only really *ours* once the server says
289
+ // so (`claim_acquired` if the target was free, `claim_granted` once
290
+ // we reach the head of the FIFO line). Block here on that grant so
291
+ // callers — chiefly `ablo.<model>.claim` — get a handle that already
292
+ // holds the lease, never a half-claimed one racing the queue.
293
+ let waited = false;
294
+ let fenceToken;
295
+ if (claimOptions.queue) {
296
+ try {
297
+ ({ waited, fenceToken } = await awaitClaimGrant(transport, claim.id, {
298
+ timeoutMs: claimOptions.waitTimeoutMs,
299
+ maxQueueDepth: claimOptions.maxQueueDepth,
300
+ signal: claimOptions.signal,
301
+ logger,
302
+ }));
303
+ }
304
+ catch (err) {
305
+ // Gave up waiting (queue too deep, timed out, or lost) — abandon
306
+ // the queued claim so we don't leave a phantom entry in the
307
+ // line that would block or mislead other claimers.
308
+ claim.revoke?.();
309
+ throw err;
310
+ }
311
+ }
312
+ return wrapClaimHandle(claim, waited, fenceToken);
313
+ },
314
+ list(target) {
315
+ return listModelClaims(target);
316
+ },
317
+ waitFor(target, options) {
318
+ return waitForModelUnclaimed(target, options);
319
+ },
320
+ });
321
+ /**
322
+ * One held claim, as the public claim-state object.
323
+ *
324
+ * The live claim stream only tracks *open* claims; terminal states
325
+ * (committed / expired / canceled) drop out of the list entirely — exactly
326
+ * the ephemeral coordination model — so a present entry is by definition
327
+ * `status: 'active'`.
328
+ */
329
+ const claimStateOf = (held) => {
330
+ if (!held)
331
+ return null;
332
+ return {
333
+ object: 'claim',
334
+ id: held.id,
335
+ status: 'active',
336
+ target: {
337
+ ...streamTarget(held.target),
338
+ ...subTarget(held.target),
339
+ },
340
+ description: held.description ?? 'editing',
341
+ heldBy: held.actor,
342
+ participantKind: held.participantKind,
343
+ expiresAt: held.expiresAt,
344
+ // Carried, not dropped: the coordinator writes a heartbeat's `details`
345
+ // into `meta.progress` on the holder's record so an observer can see
346
+ // what a long hold is doing. It reached `ModelClaim` and stopped here,
347
+ // which left the beat writable and unreadable — a channel with a setter
348
+ // and no getter. `target.meta` beside it stays the declared shape; this
349
+ // is the open record, because a declared shape has no member for a key
350
+ // the holder did not write.
351
+ ...(held.meta !== undefined ? { meta: held.meta } : {}),
352
+ };
353
+ };
354
+ // Build the typed proxy — one property per model. Done after publicClaims
355
+ // exists so model clients can expose workflow helpers such as
356
+ // `ablo.files.edit(...)` without importing protocol wiring.
357
+ const modelProxies = {};
358
+ for (const [schemaKey, modelDef] of Object.entries(schema.models)) {
359
+ const registeredModelName = modelDef.typename ?? schemaKey;
360
+ modelProxies[schemaKey] = createModelProxy(schemaKey, registeredModelName, objectPool, syncClient, modelRegistry, hydration, {
361
+ createClaim: (claimOptions) => publicClaims.create(claimOptions),
362
+ createSnapshot: (modelKey, id) => createSnapshot({
363
+ pool: objectPool,
364
+ transport,
365
+ // `position.readFloor` is the value claims and snapshots stamp as
366
+ // `readAt` (max of the pool-applied cursor and the acked
367
+ // watermark for our own writes — see logPosition.ts).
368
+ // Stamping a bare stream cursor made a claim taken right after
369
+ // an ack-confirmed write stale against that write's own delta.
370
+ // The socket/store cursors are persistence-gated and therefore
371
+ // never ahead of `applied` — no extra max() needed here.
372
+ getLastSyncId: () => syncClient.position.readFloor,
373
+ entities: { [modelKey]: id },
374
+ }),
375
+ queue: (target) => publicClaims.queueFor(streamTarget(target)),
376
+ reorder: (target, order) => { publicClaims.reorder(streamTarget(target), order); },
377
+ // One row can have several holders — sub-row claims on disjoint
378
+ // targets are all granted — so `state` and `holders` read the same
379
+ // list and differ only in how much of it they answer with. The
380
+ // projection lives here once: two copies of it would drift the
381
+ // moment a field is added to one caller's answer.
382
+ state: (target) => claimStateOf(publicClaims.list(modelTarget(target))[0]),
383
+ holders: (target) => publicClaims
384
+ .list(modelTarget(target))
385
+ .map((held) => claimStateOf(held))
386
+ .filter((claim) => claim !== null),
387
+ waitFor: (target, waitOptions) => publicClaims.waitFor(modelTarget(target), waitOptions),
388
+ // Getters, not copies: identity is late-bound (seeded in `ready()`),
389
+ // and the contended / heldBy checks must compare against whoever
390
+ // this client resolved to, not the construction-time guess.
391
+ get selfParticipantId() { return selfParticipantId; },
392
+ get selfParticipantKind() { return selfParticipantKind; },
393
+ // Read-interest / write-intent enrolment for the typed surface.
394
+ // `enterScope`/`pinScope` resolve the `{ [schemaKey]: id }` scope
395
+ // through the same resolver the claim path uses, landing this client in
396
+ // the entity-scoped group the holder's claim presence fans out on.
397
+ // Returns the store promise so the claim write path can await pinScope
398
+ // before acquiring the lease (closing the subscribe-vs-broadcast race);
399
+ // read-interest callers (`retrieve`/`claim.state`) still `void` it and
400
+ // stay fire-and-forget. It's soft either way — the store swallows
401
+ // reconcile errors so read interest never makes a read reject or stall.
402
+ enterScope: (scope) => store.enterScope(scope),
403
+ pinScope: (scope) => store.pinScope(scope),
404
+ // `ablo.<model>.join(ids, { ttl })` performs a scoped participant join
405
+ // on this model's sync group(s). WebSocket only — `join` throws
406
+ // `AbloConnectionError` if the socket isn't ready.
407
+ // `ttl` passes straight through — both surfaces spell the lease the
408
+ // same way now, so there is no rename here to make a field's name
409
+ // disagree with the value it carries.
410
+ createJoin: (modelKey, ids, options) => participantManager.join({
411
+ scope: { [modelKey]: ids },
412
+ ...(options?.ttl !== undefined ? { ttl: options.ttl } : {}),
413
+ }),
414
+ },
415
+ // The client-wide `wait` default; a per-call `wait` still wins.
416
+ internalOptions.wait);
417
+ }
418
+ const commits = {
419
+ async create(commitOptions) {
420
+ await ready();
421
+ // Same runtime contract as the per-model writes — one schema.
422
+ assertWriteOptions({
423
+ idempotencyKey: commitOptions.idempotencyKey,
424
+ readAt: commitOptions.readAt,
425
+ onStale: commitOptions.onStale,
426
+ wait: commitOptions.wait,
427
+ claim: commitOptions.claim,
428
+ }, 'commits.create');
429
+ const clientTxId = createClientTxId(commitOptions.idempotencyKey);
430
+ // A claim handle supplies the batch stale-guard defaults — same
431
+ // semantics as `ablo.<model>.update({ id, data, claim })`, so the
432
+ // two write doors speak one claim vocabulary. Explicit options win.
433
+ const claim = commitOptions.claim ?? null;
434
+ const operations = normalizeCommitOperations({
435
+ ...commitOptions,
436
+ readAt: commitOptions.readAt ?? claim?.readAt ?? null,
437
+ onStale: commitOptions.onStale ?? (claim?.readAt !== undefined ? 'reject' : null),
438
+ }, batchFence(claim?.target, claim?.fenceToken));
439
+ const wait = commitOptions.wait ?? 'confirmed';
440
+ // Route through the MutationQueue's commit lane so the call
441
+ // tolerates WS disconnects: the envelope stays in memory until
442
+ // reconnect, mutationExecutor.commit() owns transport-level
443
+ // retry, and `mutation_log` server-side dedupes replays by
444
+ // clientTxId. Replaces the direct ws.sendCommit /
445
+ // sendCommitQueued path that threw synchronously on
446
+ // `ws.readyState !== OPEN`. The queue lives on the internal
447
+ // SyncClient we already hold from createInternalComponents —
448
+ // no need to leak an accessor through BaseSyncedStore.
449
+ const queue = syncClient.getMutationQueue();
450
+ await queue.enqueueCommit(clientTxId, operations, {
451
+ ...(commitOptions.reads ? { reads: [...commitOptions.reads] } : {}),
452
+ ...(commitOptions.track ? { track: [...commitOptions.track] } : {}),
453
+ });
454
+ if (wait === 'queued') {
455
+ return { id: clientTxId, status: 'queued' };
456
+ }
457
+ const { lastSyncId, notifications, missingIds } = await queue.waitForCommitReceipt(clientTxId);
458
+ return {
459
+ id: clientTxId,
460
+ status: 'confirmed',
461
+ lastSyncId,
462
+ ...(notifications && notifications.length > 0 ? { notifications } : {}),
463
+ ...(missingIds && missingIds.length > 0 ? { missingIds } : {}),
464
+ };
465
+ },
466
+ };
467
+ /**
468
+ * The control-plane credential: always the original configured secret key.
469
+ * Never reads `authCredentials` — that holds the exchanged sync credential
470
+ * (a wide-scope `rk_` on the hosted path), which control-plane routes
471
+ * rightly refuse (e.g. the user-session mint is sk_-gated). Counterpart to
472
+ * `getAuthToken()`, which resolves the sync-plane token.
473
+ *
474
+ * The secret-key-only rule is enforced on the server; the credential-kind taxonomy
475
+ * (secret/restricted/ephemeral/publishable) lives in `auth/credentialPolicy`.
476
+ */
477
+ async function controlPlaneApiKey() {
478
+ return resolveApiKeyValue(configuredApiKey);
479
+ }
480
+ /**
481
+ * Resolve the control-plane context a session/agent mint needs (sk_ +
482
+ * bootstrap base URL + the schema-key→typename map the server gates on).
483
+ * Shared by `sessions.create` and `agents.create` so the two mint doors
484
+ * can never drift on how a token is minted. Throws if no `sk_` is present —
485
+ * minting is a backend-only operation.
486
+ */
487
+ async function buildMintContext(resource) {
488
+ const apiKey = await controlPlaneApiKey();
489
+ if (!apiKey) {
490
+ throw new AbloAuthenticationError(`${resource} requires a secret (sk_) API key — call it from your backend, not the browser.`, { code: 'apikey_missing' });
491
+ }
492
+ return {
493
+ apiKey,
494
+ baseUrl: resolveBootstrapBaseUrl({
495
+ url,
496
+ bootstrapBaseUrl: internalOptions.bootstrapBaseUrl,
497
+ }),
498
+ ...(internalOptions.fetch ? { fetch: internalOptions.fetch } : {}),
499
+ // Map every `can` schema-key to the wire typename the server gates on, so a
500
+ // typename override (`documents` → `Document`) doesn't mint a capability
501
+ // the server then denies. Derived from this client's schema by the one rule
502
+ // the HTTP client and the mint route also read. See `MintSessionContext`.
503
+ modelTypenames: modelWireNames(schema.models),
504
+ };
505
+ }
506
+ const engine = {
507
+ ...modelProxies,
508
+ ready,
509
+ waitForFlush,
510
+ /** Durable frame subscription — delegates to the store's registry, which
511
+ * re-attaches across socket rebuilds. */
512
+ subscribe: (event, handler) => store.subscribe(event, handler),
513
+ setAuthToken(token) {
514
+ // The single credential source is read lazily by bootstrap HTTP,
515
+ // lazy query HTTP, network probes, and WebSocket reconnect URL auth.
516
+ // Updating it here is enough for the next request/connect to use the
517
+ // refreshed token; no per-transport patching.
518
+ authCredentials.setAuthToken(token);
519
+ // A fresh credential is useless to a connection parked in offline /
520
+ // backoff / auth_blocked until the next probe trigger — so kick one now.
521
+ // Harmless while connected (the FSM ignores the nudge there).
522
+ store.nudgeReconnect();
523
+ },
524
+ async getAuthToken() {
525
+ // The live short-lived bearer (set via `setAuthToken` / `apiKey`-resolver refresh)
526
+ // is the canonical credential; fall back to a configured API key.
527
+ //
528
+ // This is the sync-plane token (bootstrap, WebSocket, query HTTP). Control-plane
529
+ // calls (sessions.create, datasource registration) never use it — they
530
+ // present the original secret key via `controlPlaneApiKey()` below. The
531
+ // split matters: after the startup exchange this resolver returns the
532
+ // derived wide-scope `rk_`, a credential the control-plane routes
533
+ // correctly refuse (an agent token must never mint humans).
534
+ return (authCredentials.getAuthToken() ??
535
+ (await resolveApiKeyValue(configuredApiKey)) ??
536
+ configuredAuthToken ??
537
+ null);
538
+ },
539
+ setCredentialRefresher(refresher) {
540
+ store.setCredentialRefresher(refresher);
541
+ },
542
+ // The org this client resolved to — null until `ready()` completes. Exposed
543
+ // as a property so integrators can read it programmatically.
544
+ get organizationId() {
545
+ return _resolvedOrganizationId;
546
+ },
547
+ nudgeReconnect() {
548
+ store.nudgeReconnect();
549
+ },
550
+ sessions: {
551
+ // A backend (holding `sk_`) mints a short-lived scoped token for one end
552
+ // user or one agent.
553
+ //
554
+ // Both arms authenticate with the original secret key
555
+ // (`controlPlaneApiKey()`), never the wide-scope `rk_` the startup exchange
556
+ // installed as the sync credential. A derived agent credential silently
557
+ // replacing the secret key on control-plane calls is how humans would get
558
+ // minted as agents — and correct attribution is the point.
559
+ async create(params) {
560
+ // Both mint paths (`{ user }` → /auth/ephemeral-keys → `ek_`,
561
+ // `{ agent, can }` → /auth/capability → scoped `rk_`) resolve their
562
+ // control-plane context through the shared `buildMintContext`, so this
563
+ // client, `agents.create`, and the stateless HTTP client can't drift on
564
+ // how a token is minted.
565
+ return mintSession(params, await buildMintContext('sessions.create'));
566
+ },
567
+ },
568
+ // Mint a scoped agent identity and hand back a connected client bound to it —
569
+ // `sessions.create({ agent })` plus a typed `Ablo({ schema, apiKey })` client,
570
+ // for agents that run in this (secret-key-holding) process. Omitting `id`
571
+ // yields a fresh uuid per call, so concurrent agents are distinct participants
572
+ // that queue behind each other (even when they share a `name`). Humans don't
573
+ // get a server-built client — ship them a token via `sessions.create({ user })`.
574
+ agents: {
575
+ async create(params) {
576
+ // Distinct participant by default: omit `id` → a fresh uuid, so even two
577
+ // agents that share a `name` are independent participants and queue
578
+ // behind one another. `name` is display only (→ userMeta.name); it never
579
+ // derives the id. Pass an explicit `id` only to re-attach an agent to
580
+ // its own held claims.
581
+ const id = params.id ?? globalThis.crypto.randomUUID();
582
+ const userMeta = params.name !== undefined ? { ...params.userMeta, name: params.name } : params.userMeta;
583
+ const sessionParams = {
584
+ agent: { id },
585
+ can: params.can,
586
+ ...(params.syncGroups ? { syncGroups: params.syncGroups } : {}),
587
+ ...(params.ttlSeconds !== undefined ? { ttlSeconds: params.ttlSeconds } : {}),
588
+ ...(userMeta ? { userMeta } : {}),
589
+ };
590
+ // Re-mint the `rk_` on every resolver call so a long-lived agent client
591
+ // never hits token expiry; the `sk_` stays in this process — the child
592
+ // only ever sees its own short-lived `rk_`.
593
+ const mintToken = async () => (await mintSession(sessionParams, await buildMintContext('agents.create')))
594
+ .token;
595
+ // Mint once up front so a bad key / denied scope throws HERE, not later
596
+ // inside the child's bootstrap; reuse that first token, re-mint on refresh.
597
+ let pending = await mintToken();
598
+ const apiKey = async () => {
599
+ if (pending !== null) {
600
+ const token = pending;
601
+ pending = null;
602
+ return token;
603
+ }
604
+ return mintToken();
605
+ };
606
+ return createSibling({ ...internalOptions, apiKey });
607
+ },
608
+ },
609
+ async dispose() {
610
+ lifecycle.dispose();
611
+ try {
612
+ await store.disconnect();
613
+ }
614
+ catch (err) {
615
+ // Best-effort teardown — a disposal hiccup isn't consumer-actionable → debug.
616
+ logger.debug('Error during sync engine disposal', { error: err.message });
617
+ }
618
+ presenceStream.dispose();
619
+ claimStream.dispose();
620
+ syncClient.dispose();
621
+ },
622
+ /**
623
+ * Destroy every IndexedDB database owned by this engine. Disconnects
624
+ * the WebSocket, releases timers, and deletes all `ablo_*` / `ablo-*`
625
+ * databases. Typically called on session expiry or explicit logout.
626
+ * Best-effort — errors from individual deletions are swallowed.
627
+ */
628
+ async purge() {
629
+ await store.purge();
630
+ syncClient.dispose();
631
+ },
632
+ /**
633
+ * Subscribe to session-error events. Fires when the server rejects
634
+ * the session (WebSocket close code 1008/4001/4003 or a session_error
635
+ * frame). Multiple subscribers supported; returns an unsubscribe
636
+ * function. Consumers typically use this to trigger auth-failed UI
637
+ * flows (e.g., redirect to sign-in). Does not automatically purge the
638
+ * IndexedDB — call `engine.purge()` from the listener if you need
639
+ * that behavior (the SDK's `<AbloProvider>` does this by default).
640
+ */
641
+ onSessionError(listener) {
642
+ return store.subscribeSessionError(listener);
643
+ },
644
+ onMutationFailure(listener) {
645
+ return store.subscribeMutationFailure(listener);
646
+ },
647
+ onCommitLatency(listener) {
648
+ return store.subscribeCommitLatency(listener);
649
+ },
650
+ waitForConfirmation(modelName, modelId) {
651
+ return store.waitForConfirmation(modelName, modelId);
652
+ },
653
+ // Expose the store's MobX observable directly — single source of truth.
654
+ // React components using observer() will re-render automatically on
655
+ // any state change (syncing, error, offline, pendingChanges, progress).
656
+ get syncStatus() {
657
+ return store.syncStatus;
658
+ },
659
+ schema,
660
+ // ── Internal accessors for framework integration ─────────────────
661
+ // These expose internal components for consumers that need direct
662
+ // access (e.g., SyncEngineProvider wiring SyncContext, collaboration
663
+ // events accessing the WebSocket handle, demand loaders accessing
664
+ // the pool). Prefixed with _ to signal "internal but stable."
665
+ /** The BaseSyncedStore — implements SyncStoreContract for SyncContext.Provider. */
666
+ get _store() { return store; },
667
+ /** The InstanceCache — for demand loaders that need pool.createFromData(). */
668
+ get _pool() { return objectPool; },
669
+ /** The SyncWebSocket — for collaboration events (selection, cursors). */
670
+ get _ws() { return store.getSyncWebSocket(); },
671
+ /** Presence livestream — same socket as entity sync, no second
672
+ * connection. Stable reference across the engine's lifetime. */
673
+ presence: presenceStream,
674
+ /** Claim livestream — same socket. Stable reference. */
675
+ claims: publicClaims,
676
+ commits,
677
+ /** Context-staleness snapshot — see `engine.snapshot(...)` JSDoc. */
678
+ snapshot(entities) {
679
+ return createSnapshot({
680
+ pool: objectPool,
681
+ transport,
682
+ getLastSyncId: () => transport.getLastSyncId(),
683
+ entities,
684
+ });
685
+ },
686
+ };
687
+ return engine;
688
+ }