@abloatai/ablo 0.34.0 → 0.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +4 -1
  2. package/CHANGELOG.md +684 -5
  3. package/README.md +39 -22
  4. package/dist/BaseSyncedStore.d.ts +152 -44
  5. package/dist/BaseSyncedStore.js +300 -184
  6. package/dist/Database.d.ts +9 -24
  7. package/dist/Database.js +37 -22
  8. package/dist/InstanceCache.d.ts +25 -4
  9. package/dist/InstanceCache.js +48 -15
  10. package/dist/LazyReferenceCollection.d.ts +3 -3
  11. package/dist/LazyReferenceCollection.js +4 -4
  12. package/dist/Model.d.ts +6 -6
  13. package/dist/Model.js +10 -10
  14. package/dist/ModelRegistry.d.ts +4 -4
  15. package/dist/ModelRegistry.js +3 -3
  16. package/dist/{SyncEngineContext.d.ts → RuntimeContext.d.ts} +20 -13
  17. package/dist/{SyncEngineContext.js → RuntimeContext.js} +11 -12
  18. package/dist/SyncClient.d.ts +42 -32
  19. package/dist/SyncClient.js +166 -110
  20. package/dist/ai-sdk/coordinatedTool.d.ts +2 -2
  21. package/dist/ai-sdk/coordinatedTool.js +1 -1
  22. package/dist/ai-sdk/coordinationContext.d.ts +2 -2
  23. package/dist/ai-sdk/coordinationContext.js +1 -1
  24. package/dist/ai-sdk/wrap.d.ts +3 -3
  25. package/dist/ai-sdk/wrap.js +2 -2
  26. package/dist/auth/index.d.ts +1 -156
  27. package/dist/auth/index.js +8 -301
  28. package/dist/cli.cjs +3459 -1126
  29. package/dist/client/Ablo.d.ts +42 -287
  30. package/dist/client/Ablo.js +118 -963
  31. package/dist/client/abloClient.d.ts +309 -0
  32. package/dist/client/abloClient.js +13 -0
  33. package/dist/client/clientPrelude.d.ts +52 -0
  34. package/dist/client/clientPrelude.js +60 -0
  35. package/dist/client/consoleLogger.d.ts +2 -2
  36. package/dist/client/coreClient.d.ts +60 -0
  37. package/dist/client/coreClient.js +118 -0
  38. package/dist/client/createInternalComponents.d.ts +4 -4
  39. package/dist/client/createInternalComponents.js +9 -8
  40. package/dist/client/createModelProxy.d.ts +78 -373
  41. package/dist/client/createModelProxy.js +114 -86
  42. package/dist/client/humans.d.ts +48 -0
  43. package/dist/client/humans.js +52 -0
  44. package/dist/client/modelRegistration.d.ts +1 -1
  45. package/dist/client/modelRegistration.js +9 -9
  46. package/dist/client/options.d.ts +73 -17
  47. package/dist/client/reactiveEngine.d.ts +48 -0
  48. package/dist/client/reactiveEngine.js +910 -0
  49. package/dist/client/resourceTypes.d.ts +9 -250
  50. package/dist/client/resourceTypes.js +8 -5
  51. package/dist/client/schemaConfig.d.ts +4 -4
  52. package/dist/client/schemaConfig.js +6 -2
  53. package/dist/client/validateAbloOptions.d.ts +3 -2
  54. package/dist/client/validateAbloOptions.js +1 -1
  55. package/dist/client/wsMutationExecutor.d.ts +3 -3
  56. package/dist/client/wsMutationExecutor.js +3 -3
  57. package/dist/context.d.ts +9 -9
  58. package/dist/context.js +10 -9
  59. package/dist/coordination/ClaimLog.d.ts +26 -0
  60. package/dist/coordination/ClaimLog.js +32 -0
  61. package/dist/coordination/index.d.ts +1 -15
  62. package/dist/coordination/index.js +8 -31
  63. package/dist/core/DatabaseManager.js +1 -1
  64. package/dist/core/QueryView.d.ts +1 -1
  65. package/dist/core/QueryView.js +1 -1
  66. package/dist/core/StoreManager.d.ts +4 -23
  67. package/dist/core/StoreManager.js +5 -55
  68. package/dist/core/index.d.ts +2 -2
  69. package/dist/core/index.js +2 -2
  70. package/dist/core/storeContract.d.ts +2 -2
  71. package/dist/docs/catalog.d.ts +72 -0
  72. package/dist/docs/catalog.js +227 -0
  73. package/dist/docs/index.d.ts +10 -0
  74. package/dist/docs/index.js +10 -0
  75. package/dist/environment.d.ts +1 -40
  76. package/dist/environment.js +8 -37
  77. package/dist/index.d.ts +40 -34
  78. package/dist/index.js +26 -20
  79. package/dist/interfaces/index.d.ts +44 -134
  80. package/dist/keys/index.d.ts +1 -77
  81. package/dist/keys/index.js +8 -190
  82. package/dist/mutators/{RecordingTransaction.d.ts → RecordingMutation.d.ts} +4 -4
  83. package/dist/mutators/{RecordingTransaction.js → RecordingMutation.js} +2 -2
  84. package/dist/mutators/Transaction.d.ts +1 -1
  85. package/dist/mutators/Transaction.js +1 -1
  86. package/dist/mutators/UndoManager.d.ts +6 -6
  87. package/dist/mutators/UndoManager.js +5 -5
  88. package/dist/mutators/defineMutators.d.ts +3 -3
  89. package/dist/mutators/defineMutators.js +1 -1
  90. package/dist/mutators/inverseOp.js +2 -2
  91. package/dist/mutators/mutateActions.d.ts +3 -3
  92. package/dist/mutators/mutateActions.js +1 -1
  93. package/dist/mutators/readerActions.d.ts +1 -1
  94. package/dist/mutators/undoApply.d.ts +1 -1
  95. package/dist/mutators/undoApply.js +1 -1
  96. package/dist/policy/index.d.ts +2 -2
  97. package/dist/policy/index.js +1 -1
  98. package/dist/query/client.d.ts +2 -2
  99. package/dist/query/client.js +4 -4
  100. package/dist/query/types.d.ts +6 -41
  101. package/dist/query/types.js +2 -2
  102. package/dist/react/AbloProvider.d.ts +6 -8
  103. package/dist/react/AbloProvider.js +5 -7
  104. package/dist/react/context.d.ts +1 -1
  105. package/dist/react/context.js +1 -1
  106. package/dist/react/index.d.ts +5 -5
  107. package/dist/react/index.js +3 -3
  108. package/dist/react/internalContext.d.ts +1 -1
  109. package/dist/react/useAblo.d.ts +3 -3
  110. package/dist/react/useAblo.js +1 -1
  111. package/dist/react/useCurrentUserId.js +1 -1
  112. package/dist/react/useErrorListener.js +1 -1
  113. package/dist/react/useMutationFailureListener.d.ts +2 -2
  114. package/dist/react/useMutationFailureListener.js +1 -1
  115. package/dist/react/useMutators.d.ts +3 -3
  116. package/dist/react/useMutators.js +3 -3
  117. package/dist/react/useUndoScope.d.ts +5 -5
  118. package/dist/react/useUndoScope.js +1 -1
  119. package/dist/schema/coordination.d.ts +69 -10
  120. package/dist/schema/coordination.js +86 -9
  121. package/dist/schema/ddl.js +2 -2
  122. package/dist/schema/diff.d.ts +1 -1
  123. package/dist/schema/generate.js +1 -1
  124. package/dist/schema/index.d.ts +10 -10
  125. package/dist/schema/index.js +18 -18
  126. package/dist/schema/queries.d.ts +27 -27
  127. package/dist/schema/queries.js +23 -23
  128. package/dist/schema/select.d.ts +3 -3
  129. package/dist/schema/select.js +3 -3
  130. package/dist/schema/serialize.d.ts +15 -6
  131. package/dist/schema/serialize.js +17 -3
  132. package/dist/schema/sugar.d.ts +6 -7
  133. package/dist/schema/sugar.js +9 -12
  134. package/dist/schema/syncDeltaRow.d.ts +4 -152
  135. package/dist/schema/syncDeltaRow.js +4 -105
  136. package/dist/server/adapter.d.ts +18 -1
  137. package/dist/server/commit.d.ts +10 -16
  138. package/dist/server/index.d.ts +1 -1
  139. package/dist/server/index.js +1 -1
  140. package/dist/server/readConfig.d.ts +1 -1
  141. package/dist/source/adapters/drizzle.d.ts +1 -1
  142. package/dist/source/adapters/drizzle.js +2 -2
  143. package/dist/source/adapters/kysely.d.ts +1 -1
  144. package/dist/source/adapters/kysely.js +1 -1
  145. package/dist/source/adapters/kyselyMutationCore.d.ts +1 -1
  146. package/dist/source/adapters/kyselyMutationCore.js +2 -2
  147. package/dist/source/adapters/memory.js +1 -1
  148. package/dist/source/adapters/prisma.d.ts +8 -3
  149. package/dist/source/adapters/prisma.js +1 -1
  150. package/dist/source/connector.js +1 -1
  151. package/dist/source/connectorProtocol.d.ts +2 -8
  152. package/dist/source/connectorProtocol.js +3 -2
  153. package/dist/source/contract.d.ts +29 -17
  154. package/dist/source/contract.js +27 -22
  155. package/dist/source/factory.d.ts +1 -1
  156. package/dist/source/footprint.d.ts +111 -0
  157. package/dist/source/footprint.js +0 -0
  158. package/dist/source/idempotency.js +2 -2
  159. package/dist/source/index.d.ts +1 -0
  160. package/dist/source/index.js +3 -0
  161. package/dist/source/next.d.ts +1 -1
  162. package/dist/source/signing.d.ts +9 -2
  163. package/dist/source/signing.js +4 -1
  164. package/dist/source/types.d.ts +6 -4
  165. package/dist/source/types.js +1 -1
  166. package/dist/stores/ObjectStore.d.ts +1 -1
  167. package/dist/stores/SyncActionStore.d.ts +1 -1
  168. package/dist/stores/SyncActionStore.js +2 -10
  169. package/dist/stores/syncAction.d.ts +26 -0
  170. package/dist/stores/syncAction.js +16 -0
  171. package/dist/surface.d.ts +3 -3
  172. package/dist/surface.js +6 -4
  173. package/dist/sync/BootstrapFetcher.d.ts +123 -6
  174. package/dist/sync/BootstrapFetcher.js +492 -66
  175. package/dist/sync/ConnectionManager.d.ts +6 -198
  176. package/dist/sync/ConnectionManager.js +6 -677
  177. package/dist/sync/OnDemandLoader.d.ts +2 -2
  178. package/dist/sync/OnDemandLoader.js +60 -21
  179. package/dist/sync/SubscriptionManager.d.ts +13 -2
  180. package/dist/sync/SubscriptionManager.js +23 -5
  181. package/dist/sync/SyncWebSocket.d.ts +27 -510
  182. package/dist/sync/SyncWebSocket.js +76 -954
  183. package/dist/sync/awaitClaimGrant.d.ts +4 -44
  184. package/dist/sync/awaitClaimGrant.js +4 -109
  185. package/dist/sync/commitFrames.d.ts +6 -40
  186. package/dist/sync/commitFrames.js +6 -97
  187. package/dist/sync/contextPorts.d.ts +18 -0
  188. package/dist/sync/contextPorts.js +31 -0
  189. package/dist/sync/createClaimStream.d.ts +5 -49
  190. package/dist/sync/createClaimStream.js +5 -469
  191. package/dist/sync/createPresenceStream.d.ts +26 -4
  192. package/dist/sync/createPresenceStream.js +28 -20
  193. package/dist/sync/createSnapshot.d.ts +2 -2
  194. package/dist/sync/createSnapshot.js +1 -1
  195. package/dist/sync/credentialLifecycle.d.ts +5 -173
  196. package/dist/sync/credentialLifecycle.js +5 -320
  197. package/dist/sync/deltaPipeline.d.ts +1 -1
  198. package/dist/sync/participants.d.ts +5 -4
  199. package/dist/sync/participants.js +29 -22
  200. package/dist/sync/schemaDrift.d.ts +55 -0
  201. package/dist/sync/schemaDrift.js +53 -0
  202. package/dist/sync/schemas.d.ts +21 -32
  203. package/dist/sync/schemas.js +26 -17
  204. package/dist/sync/syncPlan.d.ts +3 -3
  205. package/dist/sync/wsFrameHandlers.d.ts +6 -114
  206. package/dist/sync/wsFrameHandlers.js +6 -392
  207. package/dist/testing/fixtures/bootstrap.d.ts +1 -1
  208. package/dist/testing/fixtures/deltas.d.ts +1 -1
  209. package/dist/testing/fixtures/httpResponses.d.ts +70 -0
  210. package/dist/testing/fixtures/httpResponses.js +90 -0
  211. package/dist/testing/fixtures/models.js +1 -1
  212. package/dist/testing/helpers/wait.js +1 -1
  213. package/dist/testing/mocks/MockMutationExecutor.d.ts +2 -2
  214. package/dist/testing/mocks/MockMutationExecutor.js +8 -14
  215. package/dist/testing/mocks/MockSyncContext.d.ts +11 -11
  216. package/dist/testing/mocks/MockSyncContext.js +10 -9
  217. package/dist/testing/mocks/MockSyncStore.js +1 -1
  218. package/dist/testing/mocks/MockWebSocket.d.ts +2 -2
  219. package/dist/transaction/ablo.d.ts +88 -0
  220. package/dist/transaction/ablo.js +33 -0
  221. package/dist/{client/auth.d.ts → transaction/auth/apiKey.d.ts} +43 -8
  222. package/dist/{client/auth.js → transaction/auth/apiKey.js} +19 -0
  223. package/dist/transaction/auth/bootstrapScope.d.ts +15 -0
  224. package/dist/transaction/auth/bootstrapScope.js +1 -0
  225. package/dist/transaction/auth/capability.d.ts +177 -0
  226. package/dist/transaction/auth/capability.js +199 -0
  227. package/dist/{auth → transaction/auth}/credentialSource.d.ts +8 -1
  228. package/dist/{client → transaction/auth}/identity.d.ts +8 -7
  229. package/dist/{client → transaction/auth}/identity.js +1 -1
  230. package/dist/transaction/auth/index.d.ts +162 -0
  231. package/dist/transaction/auth/index.js +304 -0
  232. package/dist/{auth → transaction/auth}/schemas.d.ts +1 -1
  233. package/dist/{auth → transaction/auth}/schemas.js +13 -13
  234. package/dist/{client → transaction/auth}/sessionMint.d.ts +8 -8
  235. package/dist/{client → transaction/auth}/sessionMint.js +4 -7
  236. package/dist/transaction/coordination/awaitClaimGrant.d.ts +49 -0
  237. package/dist/transaction/coordination/awaitClaimGrant.js +112 -0
  238. package/dist/transaction/coordination/claimMeta.d.ts +49 -0
  239. package/dist/transaction/coordination/claimMeta.js +52 -0
  240. package/dist/transaction/coordination/createClaimStream.d.ts +64 -0
  241. package/dist/transaction/coordination/createClaimStream.js +475 -0
  242. package/dist/transaction/coordination/events.d.ts +74 -0
  243. package/dist/transaction/coordination/events.js +7 -0
  244. package/dist/transaction/coordination/index.d.ts +19 -0
  245. package/dist/transaction/coordination/index.js +44 -0
  246. package/dist/transaction/coordination/locator.d.ts +83 -0
  247. package/dist/transaction/coordination/locator.js +82 -0
  248. package/dist/transaction/coordination/schema.d.ts +1473 -0
  249. package/dist/{coordination → transaction/coordination}/schema.js +490 -55
  250. package/dist/transaction/coordination/targetConflict.d.ts +2 -0
  251. package/dist/transaction/coordination/targetConflict.js +103 -0
  252. package/dist/{coordination → transaction/coordination}/trace.d.ts +7 -18
  253. package/dist/{coordination → transaction/coordination}/trace.js +18 -25
  254. package/dist/transaction/durableWrites.d.ts +62 -0
  255. package/dist/{client → transaction}/durableWrites.js +28 -3
  256. package/dist/transaction/environment.d.ts +105 -0
  257. package/dist/transaction/environment.js +108 -0
  258. package/dist/{errorCodes.d.ts → transaction/errorCodes.d.ts} +11 -11
  259. package/dist/{errorCodes.js → transaction/errorCodes.js} +35 -12
  260. package/dist/{errors.d.ts → transaction/errors.d.ts} +37 -13
  261. package/dist/{errors.js → transaction/errors.js} +85 -16
  262. package/dist/transaction/index.d.ts +20 -0
  263. package/dist/transaction/index.js +20 -0
  264. package/dist/transaction/keys/index.d.ts +87 -0
  265. package/dist/transaction/keys/index.js +207 -0
  266. package/dist/transaction/log/syncDeltaRow.d.ts +158 -0
  267. package/dist/transaction/log/syncDeltaRow.js +95 -0
  268. package/dist/{sync/syncPosition.d.ts → transaction/logPosition.d.ts} +22 -8
  269. package/dist/{sync/syncPosition.js → transaction/logPosition.js} +15 -6
  270. package/dist/transaction/logger.d.ts +16 -0
  271. package/dist/transaction/logger.js +7 -0
  272. package/dist/transaction/observability.d.ts +53 -0
  273. package/dist/transaction/observability.js +19 -0
  274. package/dist/transaction/plugin.d.ts +192 -0
  275. package/dist/transaction/plugin.js +87 -0
  276. package/dist/{policy → transaction/policy}/types.d.ts +3 -3
  277. package/dist/{policy → transaction/policy}/types.js +2 -0
  278. package/dist/transaction/resources/httpResources.d.ts +266 -0
  279. package/dist/transaction/resources/httpResources.js +7 -0
  280. package/dist/transaction/resources/modelOperations.d.ts +319 -0
  281. package/dist/transaction/resources/modelOperations.js +12 -0
  282. package/dist/transaction/resources/mutationOptions.d.ts +66 -0
  283. package/dist/transaction/resources/mutationOptions.js +9 -0
  284. package/dist/transaction/resources/where.d.ts +85 -0
  285. package/dist/transaction/resources/where.js +70 -0
  286. package/dist/{client → transaction/resources}/writeOptionsSchema.d.ts +2 -6
  287. package/dist/{client → transaction/resources}/writeOptionsSchema.js +9 -5
  288. package/dist/{schema → transaction/schema}/field.d.ts +5 -5
  289. package/dist/{schema → transaction/schema}/field.js +5 -5
  290. package/dist/transaction/schema/loadStrategy.d.ts +45 -0
  291. package/dist/transaction/schema/loadStrategy.js +46 -0
  292. package/dist/{schema → transaction/schema}/model.d.ts +50 -35
  293. package/dist/{schema → transaction/schema}/model.js +30 -20
  294. package/dist/transaction/schema/openapi.d.ts +57 -0
  295. package/dist/transaction/schema/openapi.js +340 -0
  296. package/dist/{schema → transaction/schema}/relation.d.ts +14 -14
  297. package/dist/{schema → transaction/schema}/relation.js +7 -7
  298. package/dist/{schema → transaction/schema}/residency.d.ts +0 -9
  299. package/dist/{schema → transaction/schema}/residency.js +0 -5
  300. package/dist/{schema → transaction/schema}/roles.d.ts +5 -5
  301. package/dist/{schema → transaction/schema}/roles.js +5 -5
  302. package/dist/{schema → transaction/schema}/schema.d.ts +12 -10
  303. package/dist/{schema → transaction/schema}/schema.js +4 -3
  304. package/dist/{schema → transaction/schema}/tenancy.d.ts +1 -1
  305. package/dist/{schema → transaction/schema}/tenancy.js +7 -4
  306. package/dist/transaction/transactionLayer.d.ts +82 -0
  307. package/dist/transaction/transactionLayer.js +24 -0
  308. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.d.ts +4 -5
  309. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.js +9 -13
  310. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.d.ts +9 -2
  311. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.js +5 -9
  312. package/dist/{transactions/durableWriteStore.d.ts → transaction/transactions/settlement/pendingWrite.d.ts} +10 -36
  313. package/dist/transaction/transactions/settlement/pendingWrite.js +20 -0
  314. package/dist/transaction/transport/commitFrames.d.ts +90 -0
  315. package/dist/transaction/transport/commitFrames.js +134 -0
  316. package/dist/transaction/transport/connectionManager.d.ts +215 -0
  317. package/dist/transaction/transport/connectionManager.js +673 -0
  318. package/dist/transaction/transport/credentialLifecycle.d.ts +177 -0
  319. package/dist/transaction/transport/credentialLifecycle.js +324 -0
  320. package/dist/{sync → transaction/transport}/heartbeat.d.ts +3 -1
  321. package/dist/{sync → transaction/transport}/heartbeat.js +6 -4
  322. package/dist/{client → transaction/transport}/httpClient.d.ts +59 -16
  323. package/dist/{client → transaction/transport}/httpClient.js +5 -5
  324. package/dist/transaction/transport/httpOptions.d.ts +33 -0
  325. package/dist/transaction/transport/httpOptions.js +12 -0
  326. package/dist/{client → transaction/transport}/httpTransport.js +171 -85
  327. package/dist/{sync/NetworkProbe.d.ts → transaction/transport/networkProbe.d.ts} +7 -4
  328. package/dist/{sync/NetworkProbe.js → transaction/transport/networkProbe.js} +14 -13
  329. package/dist/transaction/transport/wsFrameHandlers.d.ts +128 -0
  330. package/dist/transaction/transport/wsFrameHandlers.js +429 -0
  331. package/dist/transaction/transport/wsTransport.d.ts +576 -0
  332. package/dist/transaction/transport/wsTransport.js +1017 -0
  333. package/dist/transaction/types/assertExact.d.ts +17 -0
  334. package/dist/transaction/types/assertExact.js +1 -0
  335. package/dist/{types → transaction/types}/global.d.ts +17 -2
  336. package/dist/{types → transaction/types}/global.js +2 -1
  337. package/dist/{types → transaction/types}/index.d.ts +14 -46
  338. package/dist/{types → transaction/types}/index.js +7 -16
  339. package/dist/{types → transaction/types}/streams.d.ts +63 -45
  340. package/dist/{utils → transaction/utils}/json.d.ts +18 -0
  341. package/dist/transaction/utils/json.js +276 -0
  342. package/dist/transaction/wire/accountResponses.d.ts +351 -0
  343. package/dist/transaction/wire/accountResponses.js +255 -0
  344. package/dist/transaction/wire/auth.d.ts +49 -0
  345. package/dist/transaction/wire/auth.js +57 -0
  346. package/dist/transaction/wire/claimEvent.d.ts +76 -0
  347. package/dist/transaction/wire/claimEvent.js +73 -0
  348. package/dist/transaction/wire/claims.d.ts +463 -0
  349. package/dist/transaction/wire/claims.js +229 -0
  350. package/dist/{wire → transaction/wire}/commit.d.ts +125 -193
  351. package/dist/{wire → transaction/wire}/commit.js +68 -47
  352. package/dist/{wire → transaction/wire}/delta.d.ts +66 -17
  353. package/dist/{wire → transaction/wire}/delta.js +37 -13
  354. package/dist/transaction/wire/errorEnvelope.d.ts +72 -0
  355. package/dist/{wire → transaction/wire}/errorEnvelope.js +36 -5
  356. package/dist/transaction/wire/feedCursor.d.ts +60 -0
  357. package/dist/transaction/wire/feedCursor.js +82 -0
  358. package/dist/transaction/wire/feedEvent.d.ts +177 -0
  359. package/dist/transaction/wire/feedEvent.js +39 -0
  360. package/dist/transaction/wire/frames.d.ts +194 -0
  361. package/dist/transaction/wire/frames.js +50 -0
  362. package/dist/transaction/wire/inboundFrames.d.ts +552 -0
  363. package/dist/transaction/wire/inboundFrames.js +116 -0
  364. package/dist/transaction/wire/index.d.ts +50 -0
  365. package/dist/transaction/wire/index.js +74 -0
  366. package/dist/{wire → transaction/wire}/listEnvelope.d.ts +13 -14
  367. package/dist/transaction/wire/listEnvelope.js +42 -0
  368. package/dist/transaction/wire/modelResponses.d.ts +85 -0
  369. package/dist/transaction/wire/modelResponses.js +43 -0
  370. package/dist/transactions/{TransactionQueue.d.ts → mutations/MutationQueue.d.ts} +79 -38
  371. package/dist/transactions/{TransactionQueue.js → mutations/MutationQueue.js} +110 -59
  372. package/dist/transactions/{TransactionStore.d.ts → mutations/MutationStore.d.ts} +8 -8
  373. package/dist/transactions/{TransactionStore.js → mutations/MutationStore.js} +2 -2
  374. package/dist/transactions/{coalesceRules.d.ts → mutations/coalesceRules.d.ts} +10 -10
  375. package/dist/transactions/{coalesceRules.js → mutations/coalesceRules.js} +1 -1
  376. package/dist/transactions/mutations/commitLatency.d.ts +52 -0
  377. package/dist/transactions/mutations/commitLatency.js +130 -0
  378. package/dist/transactions/{commitOutboxStore.d.ts → mutations/commitOutboxStore.d.ts} +1 -5
  379. package/dist/transactions/{commitOutboxStore.js → mutations/commitOutboxStore.js} +1 -1
  380. package/dist/transactions/{commitPayload.d.ts → mutations/commitPayload.d.ts} +16 -15
  381. package/dist/transactions/{commitPayload.js → mutations/commitPayload.js} +12 -12
  382. package/dist/transactions/{deltaConfirmation.d.ts → mutations/deltaConfirmation.d.ts} +11 -11
  383. package/dist/transactions/{deltaConfirmation.js → mutations/deltaConfirmation.js} +7 -7
  384. package/dist/transactions/mutations/durableWriteStore.d.ts +14 -0
  385. package/dist/transactions/mutations/durableWriteStore.js +12 -0
  386. package/dist/transactions/{optimisticApply.d.ts → mutations/optimisticApply.d.ts} +7 -7
  387. package/dist/transactions/{replayValidation.d.ts → mutations/replayValidation.d.ts} +3 -3
  388. package/dist/transactions/{replayValidation.js → mutations/replayValidation.js} +4 -3
  389. package/dist/utils/mobxSetup.d.ts +1 -1
  390. package/dist/utils/mobxSetup.js +5 -2
  391. package/dist/webhooks/events.d.ts +2 -2
  392. package/dist/wire/index.d.ts +1 -34
  393. package/dist/wire/index.js +8 -49
  394. package/docs/agent-messaging.md +3 -3
  395. package/docs/agents.md +19 -12
  396. package/docs/api-keys.md +8 -4
  397. package/docs/api.md +22 -18
  398. package/docs/audit.md +2 -0
  399. package/docs/cli.md +31 -3
  400. package/docs/client-behavior.md +8 -6
  401. package/docs/concurrency-convention.md +30 -24
  402. package/docs/coordination.md +48 -38
  403. package/docs/data-sources.md +3 -1
  404. package/docs/debugging.md +5 -3
  405. package/docs/deployment.md +267 -0
  406. package/docs/examples/agent-human.md +49 -42
  407. package/docs/examples/ai-sdk-tool.md +69 -44
  408. package/docs/examples/existing-python-backend.md +8 -6
  409. package/docs/examples/nextjs.md +129 -47
  410. package/docs/examples/scoped-agent.md +45 -44
  411. package/docs/examples/server-agent.md +46 -26
  412. package/docs/groups.md +32 -29
  413. package/docs/guarantees.md +4 -2
  414. package/docs/how-it-works.md +9 -7
  415. package/docs/idempotency.md +126 -0
  416. package/docs/identity.md +58 -54
  417. package/docs/index.md +172 -84
  418. package/docs/integration-guide.md +17 -16
  419. package/docs/interaction-model.md +6 -4
  420. package/docs/mcp.md +41 -16
  421. package/docs/migration.md +63 -5
  422. package/docs/operating-on-your-database.md +111 -0
  423. package/docs/projects.md +2 -0
  424. package/docs/quickstart.md +22 -5
  425. package/docs/react.md +12 -10
  426. package/docs/schema-contract.md +5 -3
  427. package/docs/session-settings.md +108 -0
  428. package/docs/sessions.md +3 -1
  429. package/docs/webhooks.md +3 -1
  430. package/llms.txt +47 -17
  431. package/package.json +10 -8
  432. package/dist/agent/Agent.d.ts +0 -366
  433. package/dist/agent/Agent.js +0 -514
  434. package/dist/agent/index.d.ts +0 -115
  435. package/dist/agent/index.js +0 -128
  436. package/dist/agent/session.d.ts +0 -93
  437. package/dist/agent/session.js +0 -149
  438. package/dist/agent/types.d.ts +0 -68
  439. package/dist/agent/types.js +0 -9
  440. package/dist/client/durableWrites.d.ts +0 -21
  441. package/dist/coordination/schema.d.ts +0 -722
  442. package/dist/schema/openapi.d.ts +0 -29
  443. package/dist/schema/openapi.js +0 -124
  444. package/dist/transactions/durableWriteStore.js +0 -30
  445. package/dist/utils/json.js +0 -88
  446. package/dist/wire/errorEnvelope.d.ts +0 -55
  447. package/dist/wire/frames.d.ts +0 -197
  448. package/dist/wire/frames.js +0 -49
  449. package/dist/wire/listEnvelope.js +0 -18
  450. /package/dist/{client → transaction/auth}/credentialEndpoint.d.ts +0 -0
  451. /package/dist/{client → transaction/auth}/credentialEndpoint.js +0 -0
  452. /package/dist/{auth → transaction/auth}/credentialPolicy.d.ts +0 -0
  453. /package/dist/{auth → transaction/auth}/credentialPolicy.js +0 -0
  454. /package/dist/{auth → transaction/auth}/credentialSource.js +0 -0
  455. /package/dist/{client → transaction/auth}/hostedEndpoints.d.ts +0 -0
  456. /package/dist/{client → transaction/auth}/hostedEndpoints.js +0 -0
  457. /package/dist/{client → transaction/coordination}/claimHeartbeatLoop.d.ts +0 -0
  458. /package/dist/{client → transaction/coordination}/claimHeartbeatLoop.js +0 -0
  459. /package/dist/{client → transaction}/persistence.d.ts +0 -0
  460. /package/dist/{client → transaction}/persistence.js +0 -0
  461. /package/dist/{client → transaction/resources}/functionalUpdate.d.ts +0 -0
  462. /package/dist/{client → transaction/resources}/functionalUpdate.js +0 -0
  463. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.d.ts +0 -0
  464. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.js +0 -0
  465. /package/dist/{client → transaction/transport}/httpTransport.d.ts +0 -0
  466. /package/dist/{types → transaction/types}/modelData.d.ts +0 -0
  467. /package/dist/{types → transaction/types}/modelData.js +0 -0
  468. /package/dist/{types → transaction/types}/participant.d.ts +0 -0
  469. /package/dist/{types → transaction/types}/participant.js +0 -0
  470. /package/dist/{types → transaction/types}/streams.js +0 -0
  471. /package/dist/{utils → transaction/utils}/asyncIterator.d.ts +0 -0
  472. /package/dist/{utils → transaction/utils}/asyncIterator.js +0 -0
  473. /package/dist/{utils → transaction/utils}/duration.d.ts +0 -0
  474. /package/dist/{utils → transaction/utils}/duration.js +0 -0
  475. /package/dist/{wire → transaction/wire}/bootstrapReason.d.ts +0 -0
  476. /package/dist/{wire → transaction/wire}/bootstrapReason.js +0 -0
  477. /package/dist/{wire → transaction/wire}/protocol.d.ts +0 -0
  478. /package/dist/{wire → transaction/wire}/protocol.js +0 -0
  479. /package/dist/{wire → transaction/wire}/protocolVersion.d.ts +0 -0
  480. /package/dist/{wire → transaction/wire}/protocolVersion.js +0 -0
  481. /package/dist/transactions/{UnconfirmedWrites.d.ts → mutations/UnconfirmedWrites.d.ts} +0 -0
  482. /package/dist/transactions/{UnconfirmedWrites.js → mutations/UnconfirmedWrites.js} +0 -0
  483. /package/dist/transactions/{optimisticApply.js → mutations/optimisticApply.js} +0 -0
@@ -1,679 +1,8 @@
1
1
  /**
2
- * Owns the sync engine's connection lifecycle: the state machine that carries a
3
- * client from a healthy connection, through a dropout, and back to live. It
4
- * watches the browser's online/offline and visibility events, probes real
5
- * connectivity and session validity with {@link probeNetwork}, applies retry
6
- * backoff with a ceiling and jitter, and runs a watchdog for the cases where
7
- * the browser never fires an event (VPN flips, captive portals). When it
8
- * decides to recover, it drives the reconnect sequence — bootstrap, then
9
- * WebSocket connect — through the {@link ConnectionCallbacks.onReconnect}
10
- * callback and reacts to the outcome.
11
- *
12
- * It deliberately does not perform the bootstrap, local-storage, or object-pool
13
- * work itself; that lives in the embedding store, which the manager reaches
14
- * only through its callbacks. One manager is created per store, started on the
15
- * first successful connect and disposed on teardown.
16
- *
17
- * CONNECTED ──(socket drop)──► PROBING_NETWORK ──► RECONNECTING ──► CONNECTED
18
- * │ │ │
19
- * (network lost) ▼ ▼
20
- * ▼ SESSION_EXPIRED BACKOFF ──► PROBING_NETWORK
21
- * OFFLINE ──(online)──► PROBING_NETWORK
22
- * │
23
- * ▼
24
- * WAITING_FOR_NETWORK
25
- *
26
- * Three behaviors are worth calling out. A network return or tab focus during a
27
- * backoff delay jumps straight to probing instead of waiting out the full
28
- * interval. Reaching the retry ceiling while the browser reports offline parks
29
- * in `waiting_for_network` rather than hard-reloading a browser that has no
30
- * network. And a socket drop (close code 1006) goes straight to probing rather
31
- * than the passive `offline` state — 1006 is generated locally and carries no
32
- * connectivity signal, so on a healthy machine no online/offline event ever
33
- * fires; only a genuine operating-system network loss parks in `offline` to
34
- * wait for the `online` event.
2
+ * Moved to the settlement core with the duplex transport (ADR 0016): the
3
+ * connection state machine is plain, mobx-free plumbing an agent needs as much
4
+ * as a browser does. This path re-exports it so existing importers stay
5
+ * unchanged; the reactive store mirrors its transitions through
6
+ * `ConnectionCallbacks.onStateChange` into its own observable `syncStatus`.
35
7
  */
36
- import { makeAutoObservable, runInAction } from 'mobx';
37
- import { getContext } from '../context.js';
38
- import { probeNetwork } from './NetworkProbe.js';
39
- // ─── Tunables ─────────────────────────────────────────────────────────────
40
- const DEFAULT_BACKOFF = {
41
- BASE_MS: 2_000,
42
- MAX_MS: 30_000,
43
- MAX_ATTEMPTS: 8,
44
- JITTER: 0.15,
45
- };
46
- const ONLINE_DEBOUNCE_MS = 500;
47
- const WATCHDOG_INTERVAL_MS = 30_000;
48
- const MAX_STUCK_CYCLES_BEFORE_RELOAD = 6;
49
- /** Cap on consecutive access-key re-mints before giving up to `auth_blocked`.
50
- * Stops a hot loop if the server keeps reporting the key stale even after a
51
- * "successful" re-mint (clock skew, a mint returning an already-rejected key). */
52
- const MAX_CREDENTIAL_REFRESH_ATTEMPTS = 3;
53
- // ─── ConnectionManager ────────────────────────────────────────────────────
54
- export class ConnectionManager {
55
- // Observable state
56
- state = 'connected';
57
- offlineSince = null;
58
- attempt = 0;
59
- lastProbeResult = null;
60
- // Private
61
- callbacks = null;
62
- backoffTimer = null;
63
- debounceTimer = null;
64
- watchdogTimer = null;
65
- stuckCycles = 0;
66
- /** Consecutive access-key re-mints in the current recovery cycle; reset on
67
- * reaching `connected`. See {@link MAX_CREDENTIAL_REFRESH_ATTEMPTS}. */
68
- credentialRefreshAttempts = 0;
69
- disposed = false;
70
- baseUrl;
71
- getAuthToken;
72
- backoff;
73
- handleBrowserOnline = null;
74
- handleBrowserOffline = null;
75
- handleVisibilityChange = null;
76
- constructor(options = {}) {
77
- this.baseUrl = options.baseUrl;
78
- this.getAuthToken = options.getAuthToken;
79
- this.backoff = { ...DEFAULT_BACKOFF, ...(options.backoff ?? {}) };
80
- makeAutoObservable(this, {}, { autoBind: true });
81
- }
82
- // ── Lifecycle ────────────────────────────────────────────────────────
83
- start(callbacks) {
84
- this.callbacks = callbacks;
85
- this.setupBrowserListeners();
86
- this.startWatchdog();
87
- getContext().logger.info('[ConnectionManager] Started');
88
- }
89
- dispose() {
90
- this.disposed = true;
91
- this.clearBackoffTimer();
92
- this.clearDebounceTimer();
93
- if (this.watchdogTimer) {
94
- clearInterval(this.watchdogTimer);
95
- this.watchdogTimer = null;
96
- }
97
- this.removeBrowserListeners();
98
- this.callbacks = null;
99
- getContext().logger.info('[ConnectionManager] Disposed');
100
- }
101
- // ── Send events ──────────────────────────────────────────────────────
102
- send(event) {
103
- if (this.disposed)
104
- return;
105
- const prevState = this.state;
106
- const nextState = this.transition(prevState, event);
107
- if (nextState === null)
108
- return;
109
- getContext().logger.info('[ConnectionManager] Transition', {
110
- from: prevState,
111
- to: nextState,
112
- event: event.type,
113
- });
114
- runInAction(() => {
115
- this.state = nextState;
116
- if (prevState === 'connected' && nextState !== 'connected') {
117
- this.offlineSince = new Date();
118
- }
119
- if (nextState === 'connected') {
120
- this.offlineSince = null;
121
- this.attempt = 0;
122
- this.stuckCycles = 0;
123
- }
124
- });
125
- // Notify the embedding store BEFORE running side effects, so the
126
- // UI flips to the new label (e.g. "Reconnecting…") at the same
127
- // tick the probe / backoff actually starts. Errors in the consumer
128
- // must not break the FSM — wrap defensively.
129
- try {
130
- this.callbacks?.onStateChange?.(nextState, prevState);
131
- }
132
- catch (err) {
133
- getContext().logger.debug('[ConnectionManager] onStateChange threw', {
134
- error: err instanceof Error ? err.message : String(err),
135
- });
136
- }
137
- this.onEnterState(nextState, event);
138
- }
139
- // ── Pure transition ──────────────────────────────────────────────────
140
- transition(state, event) {
141
- switch (state) {
142
- case 'connected':
143
- switch (event.type) {
144
- case 'NETWORK_LOST':
145
- // The OS reported the NIC down — park passively in `offline` and
146
- // wait for the `online` event. Probing a downed adapter is wasted
147
- // work.
148
- return 'offline';
149
- case 'WS_DISCONNECTED':
150
- // The socket died (typically code 1006) but the operating-system
151
- // network is almost certainly fine — 1006 is generated locally when
152
- // the TCP connection vanishes and carries no connectivity signal, so
153
- // the browser fires no online/offline event. Probe immediately rather
154
- // than landing in the passive `offline` dead-end (which only escaped
155
- // via the 30s watchdog, long after queued commits rolled back). The
156
- // probe fast-fails if we genuinely are offline → waiting_for_network.
157
- return 'probing_network';
158
- case 'WS_SESSION_ERROR':
159
- case 'BOOTSTRAP_FAILED_SESSION':
160
- return 'session_expired';
161
- case 'WS_HANDSHAKE_FAILED':
162
- return 'probing_network';
163
- case 'TAB_VISIBLE':
164
- return 'probing_network';
165
- default:
166
- return null;
167
- }
168
- case 'offline':
169
- switch (event.type) {
170
- case 'NETWORK_ONLINE':
171
- case 'MANUAL_RETRY':
172
- case 'TAB_VISIBLE':
173
- case 'WS_HANDSHAKE_FAILED':
174
- case 'CREDENTIAL_REFRESHED':
175
- return 'probing_network';
176
- case 'WS_SESSION_ERROR':
177
- case 'BOOTSTRAP_FAILED_SESSION':
178
- return 'session_expired';
179
- default:
180
- return null;
181
- }
182
- case 'probing_network':
183
- switch (event.type) {
184
- case 'PROBE_SUCCESS':
185
- return event.sessionValid ? 'reconnecting' : 'session_expired';
186
- case 'PROBE_CREDENTIAL_STALE':
187
- // Access key expired but the login is fine — re-mint, don't sign out.
188
- return 'refreshing_credential';
189
- case 'PROBE_AUTH_BLOCKED':
190
- return 'auth_blocked';
191
- case 'PROBE_FAILED':
192
- return 'waiting_for_network';
193
- case 'NETWORK_LOST':
194
- return 'offline';
195
- default:
196
- return null;
197
- }
198
- case 'waiting_for_network':
199
- switch (event.type) {
200
- case 'NETWORK_ONLINE':
201
- case 'TAB_VISIBLE':
202
- case 'MANUAL_RETRY':
203
- case 'BACKOFF_ELAPSED':
204
- case 'CREDENTIAL_REFRESHED':
205
- return 'probing_network';
206
- case 'NETWORK_LOST':
207
- return 'offline';
208
- default:
209
- return null;
210
- }
211
- case 'validating_session':
212
- switch (event.type) {
213
- case 'PROBE_SUCCESS':
214
- return event.sessionValid ? 'reconnecting' : 'session_expired';
215
- case 'PROBE_CREDENTIAL_STALE':
216
- return 'refreshing_credential';
217
- case 'PROBE_AUTH_BLOCKED':
218
- return 'auth_blocked';
219
- case 'NETWORK_LOST':
220
- return 'offline';
221
- default:
222
- return null;
223
- }
224
- case 'refreshing_credential':
225
- // Re-minting the short-lived access key (the `ek_`/`rk_`). The login is
226
- // presumed valid; this is not a sign-out state.
227
- switch (event.type) {
228
- case 'CREDENTIAL_REFRESHED':
229
- // Fresh key in hand — re-probe so we reconnect with it.
230
- return 'probing_network';
231
- case 'BOOTSTRAP_FAILED_SESSION':
232
- // The re-mint hit a genuine 401/403: the long-lived login itself is
233
- // gone. This is the only path from here to sign-out.
234
- return 'session_expired';
235
- case 'RECONNECT_FAILED':
236
- // Couldn't reach the mint endpoint (offline/5xx/throw) — transient.
237
- // Back off and retry; never sign out for a network failure.
238
- return 'backoff';
239
- case 'PROBE_AUTH_BLOCKED':
240
- // Bounded-attempt fallback: the key keeps coming back stale even
241
- // after re-mint (see runRefreshCredential's attempt guard). Stop
242
- // looping without signing out.
243
- return 'auth_blocked';
244
- case 'NETWORK_LOST':
245
- return 'offline';
246
- default:
247
- return null;
248
- }
249
- case 'reconnecting':
250
- switch (event.type) {
251
- case 'RECONNECT_SUCCESS':
252
- case 'WS_CONNECTED':
253
- return 'connected';
254
- case 'RECONNECT_FAILED':
255
- case 'WS_HANDSHAKE_FAILED':
256
- return 'backoff';
257
- case 'BOOTSTRAP_FAILED_SESSION':
258
- case 'WS_SESSION_ERROR':
259
- return 'session_expired';
260
- case 'NETWORK_LOST':
261
- return 'offline';
262
- default:
263
- return null;
264
- }
265
- case 'backoff':
266
- switch (event.type) {
267
- case 'BACKOFF_ELAPSED':
268
- case 'MANUAL_RETRY':
269
- case 'WS_HANDSHAKE_FAILED':
270
- return 'probing_network';
271
- case 'NETWORK_ONLINE':
272
- case 'TAB_VISIBLE':
273
- case 'CREDENTIAL_REFRESHED':
274
- // Network came back (or a fresh credential arrived) while we were
275
- // waiting out a backoff delay — jump straight to probing instead of
276
- // waiting the full exponential interval. Fixes the "doesn't
277
- // retrigger when internet comes back" bug.
278
- return 'probing_network';
279
- case 'NETWORK_LOST':
280
- return 'offline';
281
- case 'WS_SESSION_ERROR':
282
- case 'BOOTSTRAP_FAILED_SESSION':
283
- return 'session_expired';
284
- default:
285
- return null;
286
- }
287
- case 'auth_blocked':
288
- // Reachable, but the data-plane rejected the credential (non-retryable,
289
- // non-expiry — e.g. api_key_required, jwt_issuer_untrusted). Don't
290
- // auto-reconnect and don't sign out. Allow a manual retry or a
291
- // tab-focus / network-return / fresh-credential re-probe (e.g. after a
292
- // server deploy or an out-of-band re-mint); a network drop parks
293
- // offline; a genuine session error still expires.
294
- switch (event.type) {
295
- case 'MANUAL_RETRY':
296
- case 'TAB_VISIBLE':
297
- case 'NETWORK_ONLINE':
298
- case 'CREDENTIAL_REFRESHED':
299
- return 'probing_network';
300
- case 'NETWORK_LOST':
301
- return 'offline';
302
- case 'WS_SESSION_ERROR':
303
- case 'BOOTSTRAP_FAILED_SESSION':
304
- return 'session_expired';
305
- default:
306
- return null;
307
- }
308
- case 'session_expired':
309
- return null; // terminal
310
- default:
311
- return null;
312
- }
313
- }
314
- // ── Side effects per state ───────────────────────────────────────────
315
- onEnterState(state, event) {
316
- switch (state) {
317
- case 'connected':
318
- this.clearBackoffTimer();
319
- runInAction(() => {
320
- this.credentialRefreshAttempts = 0;
321
- });
322
- break;
323
- case 'offline':
324
- this.clearBackoffTimer();
325
- this.callbacks?.onDisconnectWebSocket();
326
- break;
327
- case 'probing_network':
328
- // A socket drop (`WS_DISCONNECTED`) lands here directly so recovery
329
- // starts immediately. Tear the dead socket down first — that is what
330
- // sets SyncWebSocket's `isManualClose=true` and suppresses its own
331
- // reconnect, keeping this machine the single reconnect authority on the
332
- // human path. The teardown runs synchronously inside the `disconnected`
333
- // emit, before `SyncWebSocket.onclose` checks the flag, so the timing
334
- // matches the previous `offline`-entry teardown. We gate on the drop
335
- // event specifically: the other paths into `probing_network`
336
- // (tab-focus re-validation, handshake retry, backoff elapse) must not
337
- // tear down a socket that may still be live.
338
- if (event.type === 'WS_DISCONNECTED') {
339
- this.callbacks?.onDisconnectWebSocket();
340
- }
341
- void this.runProbe().catch(this.captureEffectFailure('probe'));
342
- break;
343
- case 'waiting_for_network':
344
- this.scheduleBackoff();
345
- break;
346
- case 'reconnecting':
347
- void this.runReconnect().catch(this.captureEffectFailure('reconnect'));
348
- break;
349
- case 'refreshing_credential':
350
- void this.runRefreshCredential().catch(this.captureEffectFailure('refresh-credential'));
351
- break;
352
- case 'backoff':
353
- this.scheduleBackoff();
354
- break;
355
- case 'auth_blocked':
356
- // Stop here — the server is reachable but rejected the credential (for
357
- // example api_key_required or jwt_issuer_untrusted from the data plane).
358
- // Neither reconnecting nor re-authenticating fixes it. Drop the socket
359
- // and wait for a manual retry or a re-probe. This deliberately does not
360
- // call onSessionExpired (no sign-out) and does not reconnect — that is
361
- // the whole point of the state.
362
- this.clearBackoffTimer();
363
- this.callbacks?.onDisconnectWebSocket();
364
- getContext().observability.breadcrumb('Auth blocked — reachable but credential rejected; not reconnecting or signing out', 'sync.offline', 'error');
365
- break;
366
- case 'session_expired':
367
- this.clearBackoffTimer();
368
- this.callbacks?.onDisconnectWebSocket();
369
- this.callbacks?.onSessionExpired();
370
- getContext().observability.breadcrumb('Session expired — redirecting to signin', 'sync.offline', 'warning');
371
- break;
372
- }
373
- }
374
- // ── Async operations ─────────────────────────────────────────────────
375
- /**
376
- * FSM effects are fire-and-forget by design (`onEnterState` is sync). Each
377
- * effect catches its own operational failures and maps them onto an FSM
378
- * event, so a rejection here means the machine wedged mid-transition
379
- * (`send()` or a transition listener threw) with no retry timer armed past
380
- * it — capture it instead of losing the reconnect loop silently.
381
- */
382
- captureEffectFailure(effect) {
383
- return (error) => {
384
- getContext().observability.captureWebSocketError({
385
- context: `connection-fsm-${effect}`,
386
- error: error instanceof Error ? error.message : String(error),
387
- });
388
- };
389
- }
390
- async runProbe() {
391
- try {
392
- const result = await probeNetwork({
393
- baseUrl: this.baseUrl,
394
- getAuthToken: this.getAuthToken,
395
- });
396
- runInAction(() => {
397
- this.lastProbeResult = result;
398
- });
399
- // One probe outcome → one event. Exhaustive over ProbeOutcome so a new
400
- // outcome can't be silently dropped.
401
- switch (result.outcome) {
402
- case 'reachable':
403
- this.send({ type: 'PROBE_SUCCESS', sessionValid: true });
404
- break;
405
- case 'session_expired':
406
- // Genuine login expiry — terminal. (PROBE_SUCCESS with
407
- // sessionValid:false routes to session_expired in the FSM.)
408
- this.send({ type: 'PROBE_SUCCESS', sessionValid: false });
409
- break;
410
- case 'credential_stale':
411
- // Access key expired but the login is fine — re-mint, don't sign out.
412
- this.send({ type: 'PROBE_CREDENTIAL_STALE' });
413
- break;
414
- case 'auth_blocked':
415
- this.send({ type: 'PROBE_AUTH_BLOCKED' });
416
- break;
417
- case 'unreachable':
418
- this.send({ type: 'PROBE_FAILED' });
419
- break;
420
- default: {
421
- const _exhaustive = result.outcome;
422
- void _exhaustive;
423
- this.send({ type: 'PROBE_FAILED' });
424
- }
425
- }
426
- }
427
- catch {
428
- this.send({ type: 'PROBE_FAILED' });
429
- }
430
- }
431
- /**
432
- * Re-mint the short-lived access key on `refreshing_credential`. Delegates to
433
- * the `onRefreshCredential` callback (which mints a fresh `ek_`/`rk_` from the
434
- * still-valid login and pushes it into the credential source) and maps its
435
- * tri-state outcome onto the FSM:
436
- * - `refreshed` → `CREDENTIAL_REFRESHED` → re-probe & reconnect.
437
- * - `session_error` → `BOOTSTRAP_FAILED_SESSION` → sign out (login is gone).
438
- * - `network_error` → `RECONNECT_FAILED` → back off & retry (never sign out).
439
- *
440
- * A bounded attempt counter guards against a hot loop where the server keeps
441
- * reporting the key stale even after a "successful" re-mint (e.g. a clock skew
442
- * or a mint that returns an already-rejected key): after
443
- * `MAX_CREDENTIAL_REFRESH_ATTEMPTS` we fall through to `auth_blocked` (stop,
444
- * no sign-out) rather than spin. The counter resets once we reach `connected`.
445
- *
446
- * When no refresher is wired (e.g. a static `apiKey` deployment), we re-probe
447
- * directly — the credential source's own scheduler owns refresh there.
448
- */
449
- async runRefreshCredential() {
450
- if (this.credentialRefreshAttempts >= MAX_CREDENTIAL_REFRESH_ATTEMPTS) {
451
- getContext().logger.debug('[ConnectionManager] Access key still stale after repeated re-mints — stopping', { attempts: this.credentialRefreshAttempts });
452
- runInAction(() => {
453
- this.credentialRefreshAttempts = 0;
454
- });
455
- this.send({ type: 'PROBE_AUTH_BLOCKED' });
456
- return;
457
- }
458
- runInAction(() => {
459
- this.credentialRefreshAttempts += 1;
460
- });
461
- const refresher = this.callbacks?.onRefreshCredential;
462
- if (!refresher) {
463
- // No re-mint path wired — re-probe with whatever the credential source
464
- // holds (a static-key deployment refreshes out-of-band, if at all).
465
- this.send({ type: 'CREDENTIAL_REFRESHED' });
466
- return;
467
- }
468
- try {
469
- const result = await refresher();
470
- switch (result) {
471
- case 'refreshed':
472
- this.send({ type: 'CREDENTIAL_REFRESHED' });
473
- break;
474
- case 'session_error':
475
- this.send({ type: 'BOOTSTRAP_FAILED_SESSION' });
476
- break;
477
- case 'network_error':
478
- this.send({ type: 'RECONNECT_FAILED' });
479
- break;
480
- default: {
481
- const _exhaustive = result;
482
- void _exhaustive;
483
- this.send({ type: 'RECONNECT_FAILED' });
484
- }
485
- }
486
- }
487
- catch (error) {
488
- // A thrown refresher is transient by contract (offline / mint endpoint
489
- // unreachable) — back off and retry, never sign out.
490
- getContext().logger.debug('[ConnectionManager] Credential re-mint threw (transient)', { error });
491
- this.send({ type: 'RECONNECT_FAILED' });
492
- }
493
- }
494
- async runReconnect() {
495
- if (!this.callbacks)
496
- return;
497
- try {
498
- const result = await this.callbacks.onReconnect();
499
- switch (result) {
500
- case 'success':
501
- this.send({ type: 'RECONNECT_SUCCESS' });
502
- break;
503
- case 'session_error':
504
- this.send({ type: 'BOOTSTRAP_FAILED_SESSION' });
505
- break;
506
- case 'network_error':
507
- this.send({ type: 'RECONNECT_FAILED' });
508
- break;
509
- }
510
- }
511
- catch (error) {
512
- getContext().logger.debug('[ConnectionManager] Reconnect threw', { error });
513
- this.send({ type: 'RECONNECT_FAILED' });
514
- }
515
- }
516
- // ── Backoff ──────────────────────────────────────────────────────────
517
- scheduleBackoff() {
518
- this.clearBackoffTimer();
519
- if (this.attempt >= this.backoff.MAX_ATTEMPTS) {
520
- // If still offline, a hard reload will fail or serve cached and
521
- // we'll loop. Park in waiting_for_network and let the `online`
522
- // event (or watchdog) restart the cycle when the network comes
523
- // back.
524
- if (typeof navigator !== 'undefined' && navigator.onLine === false) {
525
- getContext().logger.debug('[ConnectionManager] Max retries while offline — parking until network restored');
526
- getContext().observability.breadcrumb('Max retries — parking offline', 'sync.offline', 'warning');
527
- runInAction(() => {
528
- this.attempt = 0;
529
- });
530
- return;
531
- }
532
- getContext().logger.debug('[ConnectionManager] Max retries — hard reload');
533
- getContext().observability.breadcrumb('Max retries — hard reload', 'sync.offline', 'error');
534
- if (typeof window !== 'undefined') {
535
- window.location.reload();
536
- }
537
- return;
538
- }
539
- const baseDelay = Math.min(this.backoff.BASE_MS * Math.pow(2, this.attempt), this.backoff.MAX_MS);
540
- const jitter = baseDelay * this.backoff.JITTER * (2 * Math.random() - 1);
541
- const delay = Math.round(baseDelay + jitter);
542
- runInAction(() => {
543
- this.attempt++;
544
- });
545
- this.backoffTimer = setTimeout(() => {
546
- this.backoffTimer = null;
547
- this.send({ type: 'BACKOFF_ELAPSED' });
548
- }, delay);
549
- }
550
- // ── Browser listeners ────────────────────────────────────────────────
551
- setupBrowserListeners() {
552
- if (typeof window === 'undefined')
553
- return;
554
- this.handleBrowserOnline = () => {
555
- this.clearDebounceTimer();
556
- this.debounceTimer = setTimeout(() => {
557
- this.send({ type: 'NETWORK_ONLINE' });
558
- }, ONLINE_DEBOUNCE_MS);
559
- };
560
- this.handleBrowserOffline = () => {
561
- this.clearDebounceTimer();
562
- this.send({ type: 'NETWORK_LOST' });
563
- };
564
- this.handleVisibilityChange = () => {
565
- if (typeof document !== 'undefined' && document.visibilityState === 'visible') {
566
- this.send({ type: 'TAB_VISIBLE' });
567
- }
568
- };
569
- window.addEventListener('online', this.handleBrowserOnline);
570
- window.addEventListener('offline', this.handleBrowserOffline);
571
- if (typeof document !== 'undefined') {
572
- document.addEventListener('visibilitychange', this.handleVisibilityChange);
573
- }
574
- }
575
- removeBrowserListeners() {
576
- if (typeof window === 'undefined')
577
- return;
578
- if (this.handleBrowserOnline) {
579
- window.removeEventListener('online', this.handleBrowserOnline);
580
- }
581
- if (this.handleBrowserOffline) {
582
- window.removeEventListener('offline', this.handleBrowserOffline);
583
- }
584
- if (this.handleVisibilityChange && typeof document !== 'undefined') {
585
- document.removeEventListener('visibilitychange', this.handleVisibilityChange);
586
- }
587
- }
588
- // ── Watchdog ─────────────────────────────────────────────────────────
589
- startWatchdog() {
590
- if (typeof window === 'undefined')
591
- return;
592
- this.watchdogTimer = setInterval(() => {
593
- if (this.disposed)
594
- return;
595
- // "Stuck" means parked in a non-active recovery state (offline,
596
- // waiting_for_network, backoff). This deliberately does not gate on
597
- // `navigator.onLine === true`: per MDN, `navigator.onLine` is only
598
- // reliable when it returns false ("definitely offline"), and even that
599
- // lies after laptop wake or VPN flips. Gating the watchdog on `onLine`
600
- // was what stranded the machine in `offline` forever — when the browser
601
- // briefly reported offline and never re-fired the `online` event, there
602
- // was no escape. The probe itself fast-fails when truly offline, so an
603
- // unconditional retry costs nothing in the genuine case.
604
- const isStuck = this.state !== 'connected' &&
605
- this.state !== 'session_expired' &&
606
- this.state !== 'probing_network' &&
607
- this.state !== 'refreshing_credential' &&
608
- this.state !== 'reconnecting';
609
- if (isStuck) {
610
- this.stuckCycles++;
611
- // Hard-reload gate: only reload when `navigator.onLine` is true.
612
- // `onLine === false` is the one direction we trust (MDN: "false
613
- // means definitely offline"), and reloading while truly offline
614
- // would either serve cached content forever or fail and leave
615
- // the user with a broken page.
616
- const browserOnline = typeof navigator === 'undefined' || navigator.onLine;
617
- if (this.stuckCycles >= MAX_STUCK_CYCLES_BEFORE_RELOAD && browserOnline) {
618
- getContext().logger.debug('[ConnectionManager] Watchdog: sustained stuck — hard reload');
619
- getContext().observability.breadcrumb('Watchdog hard reload', 'sync.offline', 'error');
620
- if (typeof window !== 'undefined') {
621
- window.location.reload();
622
- }
623
- return;
624
- }
625
- getContext().logger.info('[ConnectionManager] Watchdog: stuck — retry', {
626
- state: this.state,
627
- stuckCycles: this.stuckCycles,
628
- browserOnline,
629
- });
630
- runInAction(() => {
631
- this.attempt = 0;
632
- });
633
- this.send({ type: 'MANUAL_RETRY' });
634
- }
635
- else {
636
- this.stuckCycles = 0;
637
- }
638
- }, WATCHDOG_INTERVAL_MS);
639
- }
640
- // ── UI-friendly computed ──────────────────────────────────────────────
641
- get isConnected() { return this.state === 'connected'; }
642
- get isOffline() { return this.state === 'offline' || this.state === 'waiting_for_network'; }
643
- get isReconnecting() {
644
- return (this.state === 'probing_network' ||
645
- this.state === 'validating_session' ||
646
- this.state === 'refreshing_credential' ||
647
- this.state === 'reconnecting' ||
648
- this.state === 'backoff');
649
- }
650
- get isSessionExpired() { return this.state === 'session_expired'; }
651
- get offlineDuration() {
652
- if (!this.offlineSince)
653
- return null;
654
- const ms = Date.now() - this.offlineSince.getTime();
655
- const seconds = Math.floor(ms / 1000);
656
- const minutes = Math.floor(seconds / 60);
657
- const hours = Math.floor(minutes / 60);
658
- if (seconds < 60)
659
- return 'Just now';
660
- if (minutes < 60)
661
- return `${minutes}m ago`;
662
- if (hours < 24)
663
- return `${hours}h ago`;
664
- return `${Math.floor(hours / 24)}d ago`;
665
- }
666
- // ── Timer helpers ─────────────────────────────────────────────────────
667
- clearBackoffTimer() {
668
- if (this.backoffTimer) {
669
- clearTimeout(this.backoffTimer);
670
- this.backoffTimer = null;
671
- }
672
- }
673
- clearDebounceTimer() {
674
- if (this.debounceTimer) {
675
- clearTimeout(this.debounceTimer);
676
- this.debounceTimer = null;
677
- }
678
- }
679
- }
8
+ export { ConnectionManager, } from '../transaction/transport/connectionManager.js';