@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,231 @@
1
+ /**
2
+ * The materialiser's lifecycle: the first credential mint, identity
3
+ * resolution, the credential-refresh machinery, and the idempotent `ready()`
4
+ * that drives the store's initialize generator to completion. Extracted from
5
+ * the composition root along the humans() seam (docs/plans/package-split.md):
6
+ * the engine wires it with the prelude's credential slice and consumes
7
+ * `ready`; resolved identity flows back through one callback, so the
8
+ * engine-side state it seeds (the self locals, the streams) stays with the
9
+ * engine.
10
+ */
11
+ import { resolveParticipantIdentity } from '../transaction/auth/identity.js';
12
+ import { AbloAuthenticationError, AbloConnectionError, toAbloError, } from '../transaction/errors.js';
13
+ /**
14
+ * Wires the credential machinery onto the cluster and returns the `ready`
15
+ * the client exposes. Wiring happens now — the refresh lifecycle, the
16
+ * lazy-query auth recovery, the executor binding, and the opt-in auto-start;
17
+ * the first mint waits for `ready()` so the first connection carries a
18
+ * token.
19
+ */
20
+ export function startStoreLifecycle(deps) {
21
+ const { cluster, schema, internalOptions, authCredentials, credentialResolver, configuredApiKey, configuredAuthToken, url, kind, logger, validationError, onIdentityResolved, } = deps;
22
+ const { store, components, runtime } = cluster;
23
+ const { bootstrapHelper, hydration, syncClient } = components;
24
+ // Hand the credential lifecycle to the client (refresher + proactive refresh
25
+ // timer + wake/online/focus re-mint). Installed once here so refresh works for
26
+ // any consumer of `Ablo({ auth })`, not only those who render `<AbloProvider>`.
27
+ // The first mint happens in `ready()` so the first connection carries a token.
28
+ //
29
+ // Long-lived server clients also get the pre-roll timer on windowless hosts
30
+ // (`proactiveInNode`): their socket must renew its `rk_` or `ek_` before the
31
+ // server's keepalive reaper closes it (4001 `credential_expired`). Two signals
32
+ // qualify — an agent or system participant, and an absolute endpoint-string
33
+ // `apiKey` (a relative one can't be fetched in Node, so an absolute URL is
34
+ // unambiguously a deliberate server client). User-kind clients in Node (an
35
+ // SSR/RSC module evaluating scaffolded browser code) stay reactive-only.
36
+ if (credentialResolver) {
37
+ const rawEndpoint = internalOptions.authEndpoint ?? internalOptions.apiKey;
38
+ const absoluteEndpoint = typeof rawEndpoint === 'string' && /^https?:\/\//i.test(rawEndpoint);
39
+ store.startCredentialLifecycle(credentialResolver, {
40
+ /* eslint-disable @typescript-eslint/no-deprecated -- `kind` gates the self-hosted proactive pre-roll; hosted path derives it from the apiKey scope */
41
+ proactiveInNode: internalOptions.kind === 'agent' ||
42
+ internalOptions.kind === 'system' ||
43
+ absoluteEndpoint,
44
+ /* eslint-enable @typescript-eslint/no-deprecated */
45
+ });
46
+ }
47
+ // Put the lazy-query lane on the same auth-recovery path as the WebSocket probe
48
+ // and the proactive pre-roll: a 401 on `/sync/query` re-mints via the store's
49
+ // single-flight lifecycle and replays once, instead of silently returning empty
50
+ // rows against an expired `ek_` until the next proactive tick. Late-bound
51
+ // because the coordinator is constructed before the store exists.
52
+ hydration.setCredentialRecovery((recovery) => store.recoverFromAuthRejection(recovery));
53
+ // Bind this client's executor to its MutationQueue explicitly. The queue
54
+ // already resolves it through this client's own `runtime`, so this is the
55
+ // same executor either way; the explicit binding also covers a queue that
56
+ // was constructed without the instance runtime (subclass and test paths).
57
+ syncClient.getMutationQueue().setMutationExecutor(runtime.mutationExecutor);
58
+ // Status is tracked in store.syncStatus (MobX observable) — the single
59
+ // source of truth. No duplicate closure variables.
60
+ let _readyPromise = null;
61
+ let _refreshScheduler = null;
62
+ async function ready() {
63
+ if (_readyPromise)
64
+ return _readyPromise;
65
+ if (validationError) {
66
+ _readyPromise = Promise.reject(validationError);
67
+ return _readyPromise;
68
+ }
69
+ _readyPromise = (async () => {
70
+ try {
71
+ // Mint the first access credential before we connect, so the initial
72
+ // WebSocket upgrade and bootstrap carry a valid bearer (no tokenless first
73
+ // connect that has to self-heal). Only when a refreshing resolver is wired
74
+ // and no static credential is already present. Follows the `apiKey`
75
+ // resolver contract: `null` means the login is gone (terminal — fail ready
76
+ // so the app shows sign-in); a throw means transient (rethrown; autoStart
77
+ // swallows it and the lifecycle's online/wake triggers retry).
78
+ if (credentialResolver && !authCredentials.getAuthToken()) {
79
+ const token = await credentialResolver();
80
+ if (!token) {
81
+ throw new AbloAuthenticationError('Auth resolver returned null before connect — the user is not signed in.', { code: 'auth_no_credentials' });
82
+ }
83
+ authCredentials.setAuthToken(token);
84
+ }
85
+ // Resolve participant identity + scope. Three branches —
86
+ // hosted-cloud apiKey exchange, self-derived from capability
87
+ // token, or legacy explicit options. See `./identity.ts`.
88
+ const resolved = await resolveParticipantIdentity({
89
+ options: internalOptions,
90
+ internalOptions,
91
+ url,
92
+ kind,
93
+ configuredApiKey,
94
+ // Resolve identity against the live token, not the construction-time
95
+ // `configuredAuthToken`. Consumers using a function `apiKey` never pass
96
+ // `authToken` at construction — the lifecycle mints the first `ek_` or
97
+ // `rk_` and calls `setAuthToken()` before `ready()`, which updates the
98
+ // shared credential source. Reading the frozen `configuredAuthToken`
99
+ // here made `/auth/identity` fire with no bearer (returning
100
+ // `no_matching_provider` / `session_expired`) even though the token was
101
+ // present. This reads the shared credential source, like every other
102
+ // transport.
103
+ configuredAuthToken: authCredentials.getAuthToken() ?? configuredAuthToken,
104
+ bootstrapHelper,
105
+ auth: authCredentials,
106
+ logger,
107
+ });
108
+ const { userId, accountScope, teamIds, capabilityToken, syncGroups, participantKind, } = resolved;
109
+ // Fail-loud guard: detect the degenerate "no real sync groups
110
+ // resolved" state before opening the socket. It is the same class of bug as
111
+ // a sensible-looking default that's functionally broken: the
112
+ // SDK ends up subscribing only to the server-side
113
+ // `['default']` fallback, no
114
+ // delta has that tag, live fan-out silently never delivers.
115
+ // For human users (kind:'user') this is almost certainly a
116
+ // misconfiguration upstream — either the caller didn't pass
117
+ // `syncGroups`, or auth resolution didn't derive them, or
118
+ // both. Warn loudly so the next debugging session starts here
119
+ // instead of with "live updates don't work, hard reload fixes
120
+ // it."
121
+ const resolvedSyncGroups = syncGroups ?? [];
122
+ if (participantKind === 'user' &&
123
+ (resolvedSyncGroups.length === 0 ||
124
+ (resolvedSyncGroups.length === 1 && resolvedSyncGroups[0] === 'default'))) {
125
+ // Actionable and not self-healing (no live updates until fixed):
126
+ // kept at warn level for consumers; the low-level diagnostic
127
+ // fields ride the debug log below.
128
+ logger.warn('This client was started without sync groups, so it will not receive ' +
129
+ 'live updates. Pass `syncGroups` (for example ' +
130
+ '`["org:<id>", "user:<id>"]`) or check that your auth provider supplies them.');
131
+ logger.debug('degenerate syncGroups — details', { participantKind, resolvedSyncGroups });
132
+ }
133
+ // Seed the resolved identity into everything that filters or stamps
134
+ // by participant — the engine's self locals and its streams, through
135
+ // the one callback. This runs before the store connects, so no frame
136
+ // is ever filtered against the construction-time guess.
137
+ onIdentityResolved({
138
+ userId,
139
+ participantKind,
140
+ accountScope,
141
+ syncGroups: resolvedSyncGroups,
142
+ });
143
+ if (resolved.refreshScheduler) {
144
+ _refreshScheduler = resolved.refreshScheduler;
145
+ }
146
+ // Drive the generator to completion. Each yielded promise is awaited
147
+ // then fed back — this is standard generator consumption.
148
+ //
149
+ // The store.initialize() generator updates store.syncStatus as it
150
+ // progresses (syncing → idle on success, error on failure), so the
151
+ // consumer's `sync.syncStatus` observable reflects real-time state.
152
+ // Resolve bootstrap mode: explicit option wins; otherwise
153
+ // agents default to 'none' (transactional participant — see
154
+ // option doc) and everyone else defaults to 'full'.
155
+ const resolvedBootstrapMode = internalOptions.bootstrapMode ?? (participantKind === 'agent' ? 'none' : 'full');
156
+ const gen = store.initialize({
157
+ userId,
158
+ organizationId: accountScope,
159
+ teamIds,
160
+ kind: participantKind,
161
+ capabilityToken,
162
+ syncGroups,
163
+ bootstrapMode: resolvedBootstrapMode,
164
+ });
165
+ let current = gen.next();
166
+ while (!current.done) {
167
+ const yielded = current.value;
168
+ const settled = yielded instanceof Promise ? await yielded : yielded;
169
+ current = gen.next(settled);
170
+ }
171
+ const result = current.value;
172
+ if (!result.success) {
173
+ throw result.error
174
+ ? toAbloError(result.error)
175
+ : new AbloConnectionError('Sync engine initialization failed', {
176
+ code: 'bootstrap_fetch_timeout',
177
+ });
178
+ }
179
+ logger.info('Sync engine ready', { models: Object.keys(schema.models).length });
180
+ }
181
+ catch (err) {
182
+ // Coerce so the rejection a consumer awaiting `ready()` catches is
183
+ // always an AbloError — connection setup is held to the same
184
+ // never-leak-untagged contract as the model operations.
185
+ const error = toAbloError(err);
186
+ // Make sure syncStatus reflects the failure for observer() components
187
+ store.syncStatus.state = 'error';
188
+ store.syncStatus.error = error;
189
+ // Log the typed envelope (type + code + status), not just the bare
190
+ // message — so the console line names it as an Ablo error and carries
191
+ // the code (e.g. AbloAuthenticationError/identity_resolve_failed on a
192
+ // 401) instead of reading like an untagged failure.
193
+ logger.error('Sync engine failed to initialize', {
194
+ type: error.type,
195
+ code: error.code,
196
+ httpStatus: error.httpStatus,
197
+ error: error.message,
198
+ });
199
+ // Clear the memo so a future `ready()` re-attempts bootstrap instead of
200
+ // replaying this rejection forever. Bootstrap failures here are transient
201
+ // by nature — offline, an IndexedDB open timeout, a bootstrap fetch
202
+ // hiccup — and the early `if (_readyPromise) return _readyPromise` guard
203
+ // would otherwise hand every later caller this same dead promise, bricking
204
+ // the engine until a full page reload. Nulling it lets the provider's
205
+ // online/wake/retry triggers drive a clean re-bootstrap. (The terminal
206
+ // `validationError` branch above intentionally stays cached — config
207
+ // can't change without recreating the engine.)
208
+ _readyPromise = null;
209
+ throw error;
210
+ }
211
+ })();
212
+ return _readyPromise;
213
+ }
214
+ // Optional auto-start for convenience. Opt-in because silent background
215
+ // init has historically been the #1 source of "why isn't my data loading"
216
+ // bug reports. Explicit `await sync.ready()` is the default — errors
217
+ // surface immediately instead of being swallowed.
218
+ if (!validationError && internalOptions.autoStart) {
219
+ void ready().catch(() => {
220
+ // Error is captured in store.syncStatus; consumers should check
221
+ // `sync.syncStatus.state === 'error'` to detect failures.
222
+ });
223
+ }
224
+ return {
225
+ ready,
226
+ dispose() {
227
+ _refreshScheduler?.dispose();
228
+ _refreshScheduler = null;
229
+ },
230
+ };
231
+ }
@@ -9,7 +9,8 @@
9
9
  * problem, because the identity error messages mention the URL and would
10
10
  * mislead if the URL were the thing actually missing.
11
11
  */
12
- import { AbloError } from '../errors.js';
12
+ import { AbloError } from '../transaction/errors.js';
13
+ import type { ParticipantKind } from '../transaction/types/participant.js';
13
14
  /**
14
15
  * The subset of client options this validator reads. It is declared as its own
15
16
  * interface, structurally compatible with the full options type, so a real
@@ -20,7 +21,7 @@ export interface ValidatableAbloOptions {
20
21
  readonly schema?: {
21
22
  readonly models?: Record<string, unknown>;
22
23
  } | null;
23
- readonly kind?: 'user' | 'agent' | 'system';
24
+ readonly kind?: ParticipantKind;
24
25
  readonly user?: {
25
26
  readonly id?: string;
26
27
  } | undefined;
@@ -9,7 +9,7 @@
9
9
  * problem, because the identity error messages mention the URL and would
10
10
  * mislead if the URL were the thing actually missing.
11
11
  */
12
- import { AbloError, AbloValidationError } from '../errors.js';
12
+ import { AbloError, AbloValidationError } from '../transaction/errors.js';
13
13
  export function validateAbloOptions(input) {
14
14
  const { options, url, configuredApiKey, configuredAuthToken } = input;
15
15
  const kind = options.kind ?? 'user';
@@ -4,7 +4,7 @@
4
4
  * commit time because it does not exist yet when the executor is created. A
5
5
  * client wires this up automatically unless you supply your own executor.
6
6
  */
7
- import type { ReadDependency, TrackDependency } from '../coordination/schema.js';
7
+ import type { ReadDependency, TrackDependency } from '../transaction/coordination/schema.js';
8
8
  import type { MutationExecutor, MutationOperation } from '../interfaces/index.js';
9
9
  import type { CommitAck } from '../sync/commitFrames.js';
10
10
  /**
@@ -18,10 +18,10 @@ import type { CommitAck } from '../sync/commitFrames.js';
18
18
  * the ready socket.
19
19
  *
20
20
  * When set, `options.idempotencyKey` is sent as the wire-level `clientTxId`, so
21
- * retrying a call with the same key is safe. TransactionQueue always supplies
21
+ * retrying a call with the same key is safe. MutationQueue always supplies
22
22
  * this key before its first attempt and owns reuse across retries. The fallback
23
23
  * generation below exists only for direct, one-shot executor consumers.
24
24
  */
25
25
  export declare function createDefaultMutationExecutor(getWs: () => {
26
- sendCommit?: (operations: readonly MutationOperation[], clientTxId: string, timeoutMs?: number, causedByTaskId?: string | null, reads?: readonly ReadDependency[] | null, track?: readonly TrackDependency[] | null) => Promise<CommitAck>;
26
+ sendCommit?: (operations: readonly MutationOperation[], clientTxId: string, timeoutMs?: number, reads?: readonly ReadDependency[] | null, track?: readonly TrackDependency[] | null) => Promise<CommitAck>;
27
27
  } | null): MutationExecutor;
@@ -4,7 +4,7 @@
4
4
  * commit time because it does not exist yet when the executor is created. A
5
5
  * client wires this up automatically unless you supply your own executor.
6
6
  */
7
- import { AbloError, AbloConnectionError } from '../errors.js';
7
+ import { AbloError, AbloConnectionError } from '../transaction/errors.js';
8
8
  // ── Default mutation executor (wire: `commit` frame over WebSocket) ──────
9
9
  /**
10
10
  * Creates the default mutation executor, which sends each change as a `commit`
@@ -17,7 +17,7 @@ import { AbloError, AbloConnectionError } from '../errors.js';
17
17
  * the ready socket.
18
18
  *
19
19
  * When set, `options.idempotencyKey` is sent as the wire-level `clientTxId`, so
20
- * retrying a call with the same key is safe. TransactionQueue always supplies
20
+ * retrying a call with the same key is safe. MutationQueue always supplies
21
21
  * this key before its first attempt and owns reuse across retries. The fallback
22
22
  * generation below exists only for direct, one-shot executor consumers.
23
23
  */
@@ -34,7 +34,7 @@ export function createDefaultMutationExecutor(getWs) {
34
34
  : `tx_${Date.now()}_${Math.random().toString(36).slice(2, 10)}`);
35
35
  try {
36
36
  return await ws.sendCommit(operations, clientTxId, undefined, // use sendCommit's built-in 15s default; no per-call override
37
- options?.causedByTaskId, options?.reads, options?.track);
37
+ options?.reads, options?.track);
38
38
  }
39
39
  catch (err) {
40
40
  // Wrap transport-level failures as connection errors so the transaction
package/dist/context.d.ts CHANGED
@@ -1,29 +1,42 @@
1
1
  /**
2
- * Module-level accessor for the sync engine's shared context.
2
+ * Module-level accessor for the sync engine's runtime context.
3
3
  *
4
- * The context is set once, during initialization, by {@link initSyncEngine}.
4
+ * The context is set once, during initialization, by {@link initRuntime}.
5
5
  * Code throughout the package reaches its shared dependencies — logger,
6
6
  * observability, online-status detector, configuration, and the mutation
7
7
  * executor — through {@link getContext} instead of receiving them through every
8
8
  * constructor.
9
9
  */
10
- import type { SyncEngineContext } from './SyncEngineContext.js';
10
+ import type { RuntimeContext } from './RuntimeContext.js';
11
11
  /**
12
- * Initialize the sync engine with application-provided dependencies.
13
- * Must be called before any sync engine operations.
12
+ * Install the caller-provided runtime dependencies. Must be called before any
13
+ * operation that reaches {@link getContext}.
14
14
  */
15
- export declare function initSyncEngine(context: SyncEngineContext): void;
15
+ export declare function initRuntime(context: RuntimeContext): void;
16
16
  /**
17
17
  * Get the current sync engine context.
18
18
  * Returns a safe fallback with no-op implementations if not yet initialized,
19
19
  * so SDK files can import at module load time without crashing.
20
20
  */
21
- export declare function getContext(): SyncEngineContext;
21
+ export declare function getContext(): RuntimeContext;
22
+ /**
23
+ * The module-global runtime as an instance-shaped value — the bridge for code
24
+ * that is not yet constructed with its client's own `RuntimeContext`.
25
+ *
26
+ * Every member reads {@link getContext} at call time, so a context installed
27
+ * after construction is still picked up (tests construct first and
28
+ * `initRuntime` later). Classes take `runtime` as a constructor option with
29
+ * this as the default; a client that threads its own instance is isolated
30
+ * from other clients in the same process, a construction that doesn't is
31
+ * last-writer-wins exactly as before. Retired reference by reference as
32
+ * construction moves behind `humans()` (docs/plans/package-split.md).
33
+ */
34
+ export declare const globalRuntime: RuntimeContext;
22
35
  /**
23
36
  * Check if the sync engine has been initialized.
24
37
  */
25
- export declare function isSyncEngineInitialized(): boolean;
38
+ export declare function isRuntimeInitialized(): boolean;
26
39
  /**
27
40
  * Reset context (for testing or cleanup).
28
41
  */
29
- export declare function resetSyncEngine(): void;
42
+ export declare function resetRuntime(): void;
package/dist/context.js CHANGED
@@ -1,19 +1,19 @@
1
1
  /**
2
- * Module-level accessor for the sync engine's shared context.
2
+ * Module-level accessor for the sync engine's runtime context.
3
3
  *
4
- * The context is set once, during initialization, by {@link initSyncEngine}.
4
+ * The context is set once, during initialization, by {@link initRuntime}.
5
5
  * Code throughout the package reaches its shared dependencies — logger,
6
6
  * observability, online-status detector, configuration, and the mutation
7
7
  * executor — through {@link getContext} instead of receiving them through every
8
8
  * constructor.
9
9
  */
10
- import { noopLogger, noopObservability, browserOnlineStatus, defaultSessionErrorDetector, emptyConfig, } from './SyncEngineContext.js';
10
+ import { noopLogger, noopObservability, browserOnlineStatus, defaultSessionErrorDetector, emptyConfig, } from './RuntimeContext.js';
11
11
  let _context = null;
12
12
  /**
13
- * Initialize the sync engine with application-provided dependencies.
14
- * Must be called before any sync engine operations.
13
+ * Install the caller-provided runtime dependencies. Must be called before any
14
+ * operation that reaches {@link getContext}.
15
15
  */
16
- export function initSyncEngine(context) {
16
+ export function initRuntime(context) {
17
17
  _context = context;
18
18
  }
19
19
  /**
@@ -27,16 +27,39 @@ export function getContext() {
27
27
  }
28
28
  return _context;
29
29
  }
30
+ /**
31
+ * The module-global runtime as an instance-shaped value — the bridge for code
32
+ * that is not yet constructed with its client's own `RuntimeContext`.
33
+ *
34
+ * Every member reads {@link getContext} at call time, so a context installed
35
+ * after construction is still picked up (tests construct first and
36
+ * `initRuntime` later). Classes take `runtime` as a constructor option with
37
+ * this as the default; a client that threads its own instance is isolated
38
+ * from other clients in the same process, a construction that doesn't is
39
+ * last-writer-wins exactly as before. Retired reference by reference as
40
+ * construction moves behind `humans()` (docs/plans/package-split.md).
41
+ */
42
+ export const globalRuntime = {
43
+ get logger() { return getContext().logger; },
44
+ get observability() { return getContext().observability; },
45
+ get analytics() { return getContext().analytics; },
46
+ get sessionErrorDetector() { return getContext().sessionErrorDetector; },
47
+ get onlineStatus() { return getContext().onlineStatus; },
48
+ get modelDebugLogger() { return getContext().modelDebugLogger; },
49
+ get mutationExecutor() { return getContext().mutationExecutor; },
50
+ get config() { return getContext().config; },
51
+ getModelMetadata: (name) => getContext().getModelMetadata(name),
52
+ };
30
53
  /**
31
54
  * Check if the sync engine has been initialized.
32
55
  */
33
- export function isSyncEngineInitialized() {
56
+ export function isRuntimeInitialized() {
34
57
  return _context !== null;
35
58
  }
36
59
  /**
37
60
  * Reset context (for testing or cleanup).
38
61
  */
39
- export function resetSyncEngine() {
62
+ export function resetRuntime() {
40
63
  _context = null;
41
64
  }
42
65
  /** Fallback context with no-op implementations */
@@ -46,8 +69,9 @@ const _fallback = {
46
69
  onlineStatus: browserOnlineStatus,
47
70
  sessionErrorDetector: defaultSessionErrorDetector,
48
71
  config: emptyConfig,
72
+ getModelMetadata: () => undefined,
49
73
  mutationExecutor: {
50
- commit: () => Promise.resolve({ lastSyncId: 0 }),
74
+ commit: () => Promise.resolve({ lastSyncId: 0, status: 'confirmed' }),
51
75
  executeCreate: () => Promise.resolve(),
52
76
  executeUpdate: () => Promise.resolve(null),
53
77
  executeDelete: () => Promise.resolve(),
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Sync-engine compatibility adapter for the transaction layer's narrow claim
3
+ * log. The core log knows only claim/conflict events; this subclass supplies
4
+ * inert implementations for the client lifecycle hooks required by
5
+ * `ObservabilityProvider`, preserving `Ablo({ observability: new ClaimLog() })`
6
+ * without leaking bootstrap, storage, or WebSocket vocabulary into the core.
7
+ */
8
+ import { ClaimLog as CoordinationClaimLog } from '../transaction/coordination/trace.js';
9
+ import type { ObservabilityProvider } from '../interfaces/index.js';
10
+ export { formatClaim, formatConflict } from '../transaction/coordination/trace.js';
11
+ export type { ClaimLogEntry } from '../transaction/coordination/trace.js';
12
+ export declare class ClaimLog extends CoordinationClaimLog implements ObservabilityProvider {
13
+ setContext(): void;
14
+ setConnectionState(): void;
15
+ breadcrumb(): void;
16
+ captureRollback(): void;
17
+ captureMutationFailure(): void;
18
+ captureBootstrapFailure(): void;
19
+ captureReconciliation(): void;
20
+ captureDeltaRetryExhausted(): void;
21
+ captureWebSocketError(): void;
22
+ captureSelfHealing(): void;
23
+ captureCommitZeroSyncId(): void;
24
+ startSpan<T>(_name: string, _op: string, fn: () => T): T;
25
+ startSpanAsync<T>(_name: string, _op: string, fn: () => Promise<T>): Promise<T>;
26
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Sync-engine compatibility adapter for the transaction layer's narrow claim
3
+ * log. The core log knows only claim/conflict events; this subclass supplies
4
+ * inert implementations for the client lifecycle hooks required by
5
+ * `ObservabilityProvider`, preserving `Ablo({ observability: new ClaimLog() })`
6
+ * without leaking bootstrap, storage, or WebSocket vocabulary into the core.
7
+ */
8
+ import { ClaimLog as CoordinationClaimLog } from '../transaction/coordination/trace.js';
9
+ export { formatClaim, formatConflict } from '../transaction/coordination/trace.js';
10
+ export class ClaimLog extends CoordinationClaimLog {
11
+ // Client-lifecycle hooks the claim log has no notion of. Every body below is
12
+ // deliberately inert: the log records claims and conflicts, nothing else.
13
+ setContext() { }
14
+ setConnectionState() { }
15
+ breadcrumb() { }
16
+ captureRollback() { }
17
+ captureMutationFailure() { }
18
+ captureBootstrapFailure() { }
19
+ captureReconciliation() { }
20
+ captureDeltaRetryExhausted() { }
21
+ captureWebSocketError() { }
22
+ captureSelfHealing() { }
23
+ captureCommitZeroSyncId() { }
24
+ // Spans run their body untimed; the trailing `attributes` argument callers
25
+ // pass has nowhere to go here, so it is left off the signature.
26
+ startSpan(_name, _op, fn) {
27
+ return fn();
28
+ }
29
+ startSpanAsync(_name, _op, fn) {
30
+ return fn();
31
+ }
32
+ }
@@ -1,15 +1 @@
1
- /**
2
- * The `@abloatai/ablo/coordination` entry point. It re-exports the wire
3
- * schemas and inferred types for the three coordination layers: presence (who
4
- * is currently active), claims (taking exclusive hold of a target before
5
- * writing it), and stale-context guards (rejecting a write that was based on an
6
- * out-of-date read). The definitions themselves live in the sibling schema
7
- * module.
8
- *
9
- * Exports are listed by name rather than re-exported wholesale, so every symbol
10
- * that becomes part of this package's public API is a deliberate choice.
11
- */
12
- export { targetRangeSchema, participantKindSchema, wireParticipantKindSchema, participantKindFromWire, descriptionFromMeta, targetRefSchema, onStaleModeSchema, writeGuardSchema, staleNotificationSchema, readDependencySchema, trackDependencySchema, claimStatusSchema, wireClaimSummarySchema, claimErrorSchema, wireClaimSchema, claimRejectionSchema, modelTargetSchema, modelClaimSchema, claimBeginPayloadSchema, claimAbandonPayloadSchema, claimReorderPayloadSchema, claimHeartbeatPayloadSchema, claimHeartbeatAckPayloadSchema, claimHeartbeatBatchPayloadSchema, claimHeartbeatBatchAckPayloadSchema, updateSubscriptionPayloadSchema, subscriptionAckPayloadSchema, commitOperationTypeSchema, commitOperationSchema, presenceKindSchema, presenceActivitySchema, presenceUpdateFrameSchema, } from './schema.js';
13
- export { defaultPolicy, capabilityPreemptPolicy, interpretConflictAxis } from '../policy/types.js';
14
- export type { Conflict, ConflictAxis, ConflictDecision, ConflictKind, ConflictOperation, ConflictPolicy, StaleContextConflict, ClaimHeldConflict, } from '../policy/types.js';
15
- export type { TargetRange, ParticipantKind, TargetRef, OnStaleMode, WriteGuard, StaleNotification, ReadDependency, TrackDependency, ClaimStatus, WireClaimSummary, ClaimError, WireClaim, ClaimRejection, ModelTarget, ModelClaim, ClaimBeginPayload, ClaimAbandonPayload, ClaimReorderPayload, ClaimHeartbeatPayload, ClaimHeartbeatAckPayload, ClaimHeartbeatBatchPayload, ClaimHeartbeatBatchAckPayload, UpdateSubscriptionPayload, SubscriptionAckPayload, CommitOperationType, CommitOperation, AnyCommitOperation, PresenceKind, PresenceActivity, PresenceUpdateFrame, } from './schema.js';
1
+ export * from '../transaction/coordination/index.js';
@@ -1,31 +1,8 @@
1
- /**
2
- * The `@abloatai/ablo/coordination` entry point. It re-exports the wire
3
- * schemas and inferred types for the three coordination layers: presence (who
4
- * is currently active), claims (taking exclusive hold of a target before
5
- * writing it), and stale-context guards (rejecting a write that was based on an
6
- * out-of-date read). The definitions themselves live in the sibling schema
7
- * module.
8
- *
9
- * Exports are listed by name rather than re-exported wholesale, so every symbol
10
- * that becomes part of this package's public API is a deliberate choice.
11
- */
12
- // Runtime schemas + helpers.
13
- export {
14
- // Shared primitives
15
- targetRangeSchema, participantKindSchema, wireParticipantKindSchema, participantKindFromWire, descriptionFromMeta, targetRefSchema,
16
- // Layer 3 — optimistic stale-context
17
- onStaleModeSchema, writeGuardSchema, staleNotificationSchema, readDependencySchema, trackDependencySchema,
18
- // Layer 2 — pessimistic claim / claim-lease
19
- claimStatusSchema, wireClaimSummarySchema, claimErrorSchema, wireClaimSchema, claimRejectionSchema, modelTargetSchema, modelClaimSchema, claimBeginPayloadSchema, claimAbandonPayloadSchema, claimReorderPayloadSchema, claimHeartbeatPayloadSchema, claimHeartbeatAckPayloadSchema, claimHeartbeatBatchPayloadSchema, claimHeartbeatBatchAckPayloadSchema,
20
- // Read interest — area-of-interest navigation
21
- updateSubscriptionPayloadSchema, subscriptionAckPayloadSchema,
22
- // Commit operation — carries the optimistic write-guard
23
- commitOperationTypeSchema, commitOperationSchema,
24
- // Layer 1 — presence
25
- presenceKindSchema, presenceActivitySchema, presenceUpdateFrameSchema, } from './schema.js';
26
- // Conflict-policy runtime — the engine detects a conflict, and the policy
27
- // decides what to do about it. These are re-exported here so that server-side
28
- // code can reach both the coordination vocabulary and its default conflict
29
- // resolution from this one subpath, without importing the full client from the
30
- // package root.
31
- export { defaultPolicy, capabilityPreemptPolicy, interpretConflictAxis } from '../policy/types.js';
1
+ // Moved to @ablo/transaction (ADR 0013 — the settlement core extraction).
2
+ // This shim re-exports it at the original path so in-package importers of
3
+ // `coordination/index.js` keep working; rewire to `@ablo/transaction/coordination`
4
+ // and delete this shim once the core package is fully wired.
5
+ //
6
+ // Line comments on purpose: tsc copies a leading JSDoc block into the
7
+ // published `.d.ts`, and this note names a package npm has never heard of.
8
+ export * from '../transaction/coordination/index.js';
@@ -21,8 +21,8 @@ export { Model } from '../Model.js';
21
21
  export { LazyReferenceCollection, type LazyCollectionOptions, } from '../LazyReferenceCollection.js';
22
22
  export { ModelRegistry, getActiveRegistry, } from '../ModelRegistry.js';
23
23
  export { postQuery, type PostQueryOptions } from '../query/client.js';
24
- export { computeFKDepthPriority } from '../client/Ablo.js';
25
- export type { SyncLogger, SyncObservabilityProvider, MutationExecutor, SessionErrorDetector, OnlineStatusProvider, CommitResult, MutationOperation, } from '../interfaces/index.js';
24
+ export { computeFKDepthPriority } from '../client/schemaConfig.js';
25
+ export type { SyncLogger, SyncObservabilityProvider, MutationExecutor, SessionErrorDetector, OnlineStatusProvider, CommitResult, MutationOperation, MutationOptions, } from '../interfaces/index.js';
26
26
  export { SyncWebSocket, type SyncDelta, type SyncWebSocketOptions, } from '../sync/SyncWebSocket.js';
27
27
  export { BootstrapFetcher } from '../sync/BootstrapFetcher.js';
28
28
  /** @deprecated `BootstrapHelper` was renamed to {@link BootstrapFetcher}. This alias keeps
@@ -30,4 +30,4 @@ export { BootstrapFetcher } from '../sync/BootstrapFetcher.js';
30
30
  export { BootstrapFetcher as BootstrapHelper } from '../sync/BootstrapFetcher.js';
31
31
  export { createClaimStream, type AttachableClaimStream, type ClaimStreamConfig, } from '../sync/createClaimStream.js';
32
32
  export { awaitClaimGrant, type GrantTransport, } from '../sync/awaitClaimGrant.js';
33
- export { LoadStrategy } from '../types/index.js';
33
+ export { LoadStrategy } from '../transaction/types/index.js';
@@ -28,7 +28,7 @@ export { postQuery } from '../query/client.js';
28
28
  // Computes a dependency-safe ordering for a set of models by walking their
29
29
  // foreign-key relationships, so writes commit parents before children. Used by
30
30
  // schema-aware test fixtures and scaffolding tools.
31
- export { computeFKDepthPriority } from '../client/Ablo.js';
31
+ export { computeFKDepthPriority } from '../client/schemaConfig.js';
32
32
  // The sync layer: the WebSocket wrapper and the delta shape it carries. Needed
33
33
  // when writing a sync adapter or a multi-participant test harness.
34
34
  export { SyncWebSocket, } from '../sync/SyncWebSocket.js';
@@ -45,4 +45,4 @@ export { createClaimStream, } from '../sync/createClaimStream.js';
45
45
  export { awaitClaimGrant, } from '../sync/awaitClaimGrant.js';
46
46
  // An enum naming the strategies for loading a model's data. Referenced when
47
47
  // registering models in extension code.
48
- export { LoadStrategy } from '../types/index.js';
48
+ export { LoadStrategy } from '../transaction/types/index.js';