@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,162 @@
1
+ /**
2
+ * Exchanges an API key for a capability token and the scope it grants.
3
+ *
4
+ * The `Ablo({...})` factory calls this during startup when you provide an
5
+ * `apiKey` but no explicit capability token, organization, or user identity. It
6
+ * sends one `POST /auth/capability` request; the server responds with the
7
+ * granted scope and any user metadata, which the client uses to populate its
8
+ * session state. The API key is the only credential you handle directly — this
9
+ * exchange happens automatically behind it.
10
+ */
11
+ import { type CapabilityExchangeResponse, type EphemeralKeyResponse, type IdentityResolveResponse } from './schemas.js';
12
+ import type { ParticipantKind } from '../types/participant.js';
13
+ import type { GrantedOperation } from './capability.js';
14
+ export type { CapabilityExchangeResponse, EphemeralKeyResponse, IdentityResolveResponse, } from './schemas.js';
15
+ export { capabilityOperationSchema, capabilityCanSchema, capabilityScopeSchema, capabilityRequestSchema, grantedOperationSchema, grantedOperations, expandReadYourWrites, modelWireNames, capabilityModelAliases, unresolvableOperations, } from './capability.js';
16
+ export type { CapabilityOperation, CapabilityCan, CapabilityScope, CapabilityRequest, CapabilityModelShape, GrantedOperation, } from './capability.js';
17
+ export interface ExchangeApiKeyRequest {
18
+ readonly apiKey: string;
19
+ readonly baseUrl: string;
20
+ readonly participantKind: ParticipantKind;
21
+ readonly participantId?: string;
22
+ readonly syncGroups?: readonly string[];
23
+ /** The grant's verb axis, already in wire form. Build it with
24
+ * `grantedOperations(can)` rather than assembling `model.verb` by hand. */
25
+ readonly operations?: readonly GrantedOperation[];
26
+ readonly ttlSeconds: number;
27
+ readonly label?: string;
28
+ readonly userMeta?: Record<string, unknown>;
29
+ readonly fetch?: typeof fetch;
30
+ readonly timeoutMs?: number;
31
+ }
32
+ export declare function exchangeApiKey(options: ExchangeApiKeyRequest): Promise<CapabilityExchangeResponse>;
33
+ export interface MintUserSessionRequest {
34
+ /** Your secret API key (an `sk_` key). Minting a session is a server-side
35
+ * operation, so it always presents the secret key, never a token derived
36
+ * from it. */
37
+ readonly apiKey: string;
38
+ readonly baseUrl: string;
39
+ /** The end user's identifier in your identity provider. It becomes the
40
+ * session's `participantId`. */
41
+ readonly userId: string;
42
+ /** The organization to mint the session into, for a platform that manages many
43
+ * organizations. Requires the secret key to carry the `ephemeral:mint-any-org`
44
+ * capability. Omit to mint into the key's own organization. */
45
+ readonly organizationId?: string;
46
+ /** Points this session's schema at a shared project while its data stays scoped
47
+ * to `organizationId`. Use this when each customer has its own organization but
48
+ * they all share one schema: keep a single schema project, and every customer's
49
+ * session resolves its schema from it instead of pushing the schema into each
50
+ * organization separately. Requires the secret key to carry the
51
+ * `ephemeral:mint-any-org` capability. Omit to resolve the schema from the
52
+ * session's own organization. */
53
+ readonly schemaProject?: {
54
+ /** The organization that owns the shared schema project. */
55
+ readonly organizationId: string;
56
+ /** The project the schema was pushed under. */
57
+ readonly projectId: string;
58
+ };
59
+ readonly syncGroups?: readonly string[];
60
+ readonly ttlSeconds: number;
61
+ readonly label?: string;
62
+ readonly fetch?: typeof fetch;
63
+ readonly timeoutMs?: number;
64
+ }
65
+ /**
66
+ * Mints an end-user session key (an `ek_` key) by calling
67
+ * `POST /auth/ephemeral-keys`, using your secret key as authorization. Your
68
+ * backend calls this to issue a session that a browser can present as its bearer
69
+ * credential; the server trusts the resulting key because a secret key minted it.
70
+ *
71
+ * This is a distinct endpoint from `/auth/capability`, which exchanges keys for
72
+ * agents and systems and cannot mint sessions for human users.
73
+ */
74
+ export declare function mintUserSessionKey(options: MintUserSessionRequest): Promise<EphemeralKeyResponse>;
75
+ export interface ResolveIdentityRequest {
76
+ readonly baseUrl: string;
77
+ readonly authToken?: string;
78
+ readonly fetch?: typeof fetch;
79
+ readonly timeoutMs?: number;
80
+ }
81
+ /**
82
+ * Resolves the caller's identity from an authenticated request by calling
83
+ * `GET /auth/identity`. This lets browser and session flows learn who the
84
+ * current user is without requiring the application to pass a user id up front —
85
+ * for example, to key local storage.
86
+ */
87
+ export declare function resolveIdentity(options: ResolveIdentityRequest): Promise<IdentityResolveResponse>;
88
+ /**
89
+ * Keeps a capability token fresh so a long-lived client never disconnects when
90
+ * its token expires.
91
+ *
92
+ * A capability token has a shorter lifetime — one hour by default — than a
93
+ * typical browser session. Without a refresh, the WebSocket is force-closed at
94
+ * expiry (close code 1008) or the next reconnect fails with a 401, and either way
95
+ * the user sees a mid-session disconnect. The scheduler prevents that by
96
+ * re-minting the token ahead of time.
97
+ *
98
+ * Three triggers share one refresh path:
99
+ *
100
+ * 1. Proactive — a timer set for `expiresAtMs - bufferMs - now`.
101
+ * 2. Visibility — when a hidden tab becomes visible and the token is already
102
+ * within the buffer window, refresh immediately. This covers a
103
+ * background tab whose timers were throttled while it was idle.
104
+ * 3. Reactive — the caller invokes {@link RefreshScheduler.refreshNow} after
105
+ * observing an auth failure, such as a WebSocket close 1008 or
106
+ * 4001.
107
+ *
108
+ * All three await the same in-flight promise, so concurrent triggers mint the
109
+ * token only once. Each successful refresh records the new expiry and reschedules
110
+ * the proactive timer.
111
+ *
112
+ * The refresh margin is `max(60s, ttl/10)` — six minutes for a one-hour token,
113
+ * and it scales down for shorter lifetimes.
114
+ */
115
+ export interface RefreshSchedulerOptions {
116
+ /** Initial absolute expiry, ms since epoch (server-supplied). */
117
+ readonly initialExpiresAtMs: number;
118
+ /**
119
+ * Performs the token exchange and returns the new expiry. Errors propagate to
120
+ * `onError`; the scheduler stays alive and retries on its next trigger. It does
121
+ * not back off between retries, since the common failure here is a revoked API
122
+ * key, for which retrying would not help.
123
+ */
124
+ readonly refresh: () => Promise<{
125
+ expiresAtMs: number;
126
+ }>;
127
+ /** Called on every successful refresh. */
128
+ readonly onRefreshed?: (info: {
129
+ expiresAtMs: number;
130
+ }) => void;
131
+ /** Called on every refresh failure. */
132
+ readonly onError?: (error: Error) => void;
133
+ /**
134
+ * Override the buffer (ms ahead of expiry to refresh). Defaults to
135
+ * `max(60_000, ttlMs * 0.1)`. Tests use a tiny value to exercise
136
+ * scheduling without burning real time.
137
+ */
138
+ readonly bufferMs?: number;
139
+ /**
140
+ * If true, install a `visibilitychange` listener on `document` that
141
+ * triggers a refresh when the tab becomes visible and the token is
142
+ * within the buffer window. No-op if `document` is undefined (Node).
143
+ * Default: true in browser environments.
144
+ */
145
+ readonly attachVisibilityListener?: boolean;
146
+ /** Time source. Override in tests; defaults to `Date.now`. */
147
+ readonly now?: () => number;
148
+ /** Timer pair. Override in tests. */
149
+ readonly setTimer?: (fn: () => void, ms: number) => ReturnType<typeof setTimeout>;
150
+ readonly clearTimer?: (handle: ReturnType<typeof setTimeout>) => void;
151
+ }
152
+ export interface RefreshScheduler {
153
+ /** Force a refresh now. Idempotent — concurrent calls share one promise. */
154
+ refreshNow(): Promise<{
155
+ expiresAtMs: number;
156
+ }>;
157
+ /** Stop scheduling. Safe to call multiple times. */
158
+ dispose(): void;
159
+ /** Current absolute expiry. Updated after each successful refresh. */
160
+ readonly expiresAtMs: number;
161
+ }
162
+ export declare function createRefreshScheduler(options: RefreshSchedulerOptions): RefreshScheduler;
@@ -0,0 +1,304 @@
1
+ /**
2
+ * Exchanges an API key for a capability token and the scope it grants.
3
+ *
4
+ * The `Ablo({...})` factory calls this during startup when you provide an
5
+ * `apiKey` but no explicit capability token, organization, or user identity. It
6
+ * sends one `POST /auth/capability` request; the server responds with the
7
+ * granted scope and any user metadata, which the client uses to populate its
8
+ * session state. The API key is the only credential you handle directly — this
9
+ * exchange happens automatically behind it.
10
+ */
11
+ import { parseCapabilityExchangeResponse, parseEphemeralKeyResponse, parseIdentityResolveResponse, } from './schemas.js';
12
+ import { AbloAuthenticationError, hasWireCode, translateHttpError } from '../errors.js';
13
+ // The capability vocabulary — what a grant is, on both axes, in one place.
14
+ // Served from this barrel so every minter reaches it through one import.
15
+ export { capabilityOperationSchema, capabilityCanSchema, capabilityScopeSchema, capabilityRequestSchema, grantedOperationSchema, grantedOperations, expandReadYourWrites, modelWireNames, capabilityModelAliases, unresolvableOperations, } from './capability.js';
16
+ export async function exchangeApiKey(options) {
17
+ if (!options.apiKey) {
18
+ throw new AbloAuthenticationError('No API key found. Set ABLO_API_KEY in your environment — `npx ablo login` ' +
19
+ 'then `npx ablo dev` writes it into .env.local for you — or pass ' +
20
+ '`apiKey` to Ablo({ ... }) directly.', { code: 'apikey_missing' });
21
+ }
22
+ if (!options.baseUrl) {
23
+ throw new AbloAuthenticationError('baseUrl is required for capability exchange', { code: 'base_url_missing' });
24
+ }
25
+ const fetcher = options.fetch ?? fetch;
26
+ const url = `${options.baseUrl.replace(/\/+$/, '')}/auth/capability`;
27
+ const timeoutMs = options.timeoutMs ?? 10_000;
28
+ const controller = new AbortController();
29
+ const timer = setTimeout(() => { controller.abort(); }, timeoutMs);
30
+ let response;
31
+ try {
32
+ response = await fetcher(url, {
33
+ method: 'POST',
34
+ headers: {
35
+ 'Content-Type': 'application/json',
36
+ Authorization: `Bearer ${options.apiKey}`,
37
+ },
38
+ body: JSON.stringify({
39
+ participantKind: options.participantKind,
40
+ ...(options.participantId ? { participantId: options.participantId } : {}),
41
+ syncGroups: options.syncGroups,
42
+ operations: options.operations,
43
+ wideScope: options.wideScope,
44
+ ttlSeconds: options.ttlSeconds,
45
+ label: options.label,
46
+ userMeta: options.userMeta,
47
+ }),
48
+ signal: controller.signal,
49
+ });
50
+ }
51
+ catch (err) {
52
+ throw new AbloAuthenticationError(`apiKey exchange failed: ${err instanceof Error ? err.message : String(err)}`, { code: 'exchange_network_error', cause: err });
53
+ }
54
+ finally {
55
+ clearTimeout(timer);
56
+ }
57
+ if (!response.ok) {
58
+ let body = null;
59
+ try {
60
+ body = await response.json();
61
+ }
62
+ catch {
63
+ // ignore — server returned non-JSON error
64
+ }
65
+ // Route the error through the wire-error translator so the server's envelope
66
+ // (`code`, `message`, `doc_url`) is preserved and mapped to the matching
67
+ // AbloError subclass. Fall back to `exchange_failed` only when the body
68
+ // carried no recognizable error code.
69
+ const requestId = response.headers.get('x-request-id') ?? undefined;
70
+ throw hasWireCode(body)
71
+ ? translateHttpError(response.status, body, requestId)
72
+ : new AbloAuthenticationError(`apiKey exchange rejected (${response.status})`, { code: 'exchange_failed', httpStatus: response.status });
73
+ }
74
+ return parseCapabilityExchangeResponse(await response.json());
75
+ }
76
+ /**
77
+ * Mints an end-user session key (an `ek_` key) by calling
78
+ * `POST /auth/ephemeral-keys`, using your secret key as authorization. Your
79
+ * backend calls this to issue a session that a browser can present as its bearer
80
+ * credential; the server trusts the resulting key because a secret key minted it.
81
+ *
82
+ * This is a distinct endpoint from `/auth/capability`, which exchanges keys for
83
+ * agents and systems and cannot mint sessions for human users.
84
+ */
85
+ export async function mintUserSessionKey(options) {
86
+ if (!options.apiKey) {
87
+ throw new AbloAuthenticationError('No API key found. Set ABLO_API_KEY in your environment or pass `apiKey` ' +
88
+ 'to Ablo({ ... }) directly — user sessions are minted by your backend.', { code: 'apikey_missing' });
89
+ }
90
+ if (!options.baseUrl) {
91
+ throw new AbloAuthenticationError('baseUrl is required for user-session mint', { code: 'base_url_missing' });
92
+ }
93
+ const fetcher = options.fetch ?? fetch;
94
+ const url = `${options.baseUrl.replace(/\/+$/, '')}/auth/ephemeral-keys`;
95
+ const timeoutMs = options.timeoutMs ?? 10_000;
96
+ const controller = new AbortController();
97
+ const timer = setTimeout(() => { controller.abort(); }, timeoutMs);
98
+ let response;
99
+ try {
100
+ response = await fetcher(url, {
101
+ method: 'POST',
102
+ headers: {
103
+ 'Content-Type': 'application/json',
104
+ Authorization: `Bearer ${options.apiKey}`,
105
+ },
106
+ body: JSON.stringify({
107
+ user: { id: options.userId },
108
+ ...(options.organizationId ? { organizationId: options.organizationId } : {}),
109
+ // The public option is project-centric; map it to the flat wire keys the
110
+ // endpoint expects.
111
+ ...(options.schemaProject
112
+ ? {
113
+ schemaProjectId: options.schemaProject.projectId,
114
+ schemaOwnerOrgId: options.schemaProject.organizationId,
115
+ }
116
+ : {}),
117
+ ...(options.syncGroups ? { syncGroups: options.syncGroups } : {}),
118
+ ttlSeconds: options.ttlSeconds,
119
+ ...(options.label ? { label: options.label } : {}),
120
+ }),
121
+ signal: controller.signal,
122
+ });
123
+ }
124
+ catch (err) {
125
+ throw new AbloAuthenticationError(`user-session mint failed: ${err instanceof Error ? err.message : String(err)}`, { code: 'exchange_network_error', cause: err });
126
+ }
127
+ finally {
128
+ clearTimeout(timer);
129
+ }
130
+ if (!response.ok) {
131
+ let body = null;
132
+ try {
133
+ body = await response.json();
134
+ }
135
+ catch {
136
+ // ignore — server returned non-JSON error
137
+ }
138
+ const requestId = response.headers.get('x-request-id') ?? undefined;
139
+ throw hasWireCode(body)
140
+ ? translateHttpError(response.status, body, requestId)
141
+ : new AbloAuthenticationError(`user-session mint rejected (${response.status})`, { code: 'exchange_failed', httpStatus: response.status });
142
+ }
143
+ return parseEphemeralKeyResponse(await response.json());
144
+ }
145
+ /**
146
+ * Resolves the caller's identity from an authenticated request by calling
147
+ * `GET /auth/identity`. This lets browser and session flows learn who the
148
+ * current user is without requiring the application to pass a user id up front —
149
+ * for example, to key local storage.
150
+ */
151
+ export async function resolveIdentity(options) {
152
+ if (!options.baseUrl) {
153
+ throw new AbloAuthenticationError('baseUrl is required for identity resolve', {
154
+ code: 'base_url_missing',
155
+ });
156
+ }
157
+ const fetcher = options.fetch ?? fetch;
158
+ const url = `${options.baseUrl.replace(/\/+$/, '')}/auth/identity`;
159
+ const timeoutMs = options.timeoutMs ?? 10_000;
160
+ const controller = new AbortController();
161
+ const timer = setTimeout(() => { controller.abort(); }, timeoutMs);
162
+ let response;
163
+ try {
164
+ const headers = { Accept: 'application/json' };
165
+ if (options.authToken) {
166
+ headers.Authorization = `Bearer ${options.authToken}`;
167
+ }
168
+ response = await fetcher(url, {
169
+ method: 'GET',
170
+ headers,
171
+ signal: controller.signal,
172
+ });
173
+ }
174
+ catch (err) {
175
+ throw new AbloAuthenticationError(`identity resolve failed: ${err instanceof Error ? err.message : String(err)}`, { code: 'identity_network_error', cause: err });
176
+ }
177
+ finally {
178
+ clearTimeout(timer);
179
+ }
180
+ if (!response.ok) {
181
+ let body = null;
182
+ try {
183
+ body = await response.json();
184
+ }
185
+ catch {
186
+ // ignore non-JSON auth errors
187
+ }
188
+ // Translate the error envelope the same way `exchangeApiKey` does, so the
189
+ // server's precise auth diagnosis (for example `jwt_issuer_untrusted` with
190
+ // its full message) reaches the caller instead of collapsing every 401 to a
191
+ // generic `identity_resolve_failed`.
192
+ const requestId = response.headers.get('x-request-id') ?? undefined;
193
+ throw hasWireCode(body)
194
+ ? translateHttpError(response.status, body, requestId)
195
+ : new AbloAuthenticationError(`identity resolve rejected (${response.status})`, { code: 'identity_resolve_failed', httpStatus: response.status });
196
+ }
197
+ return parseIdentityResolveResponse(await response.json());
198
+ }
199
+ const DEFAULT_BUFFER_FLOOR_MS = 60_000;
200
+ const DEFAULT_BUFFER_RATIO = 0.1;
201
+ export function createRefreshScheduler(options) {
202
+ const now = options.now ?? Date.now;
203
+ const setTimer = options.setTimer ?? setTimeout;
204
+ const clearTimer = options.clearTimer ?? clearTimeout;
205
+ let expiresAtMs = options.initialExpiresAtMs;
206
+ let timer = null;
207
+ let inFlight = null;
208
+ let disposed = false;
209
+ // Attach the visibility listener only in a browser-like environment. A
210
+ // non-browser runtime has no `document`, so the default behaves correctly
211
+ // without an explicit opt-out.
212
+ const wantsVisibility = options.attachVisibilityListener ?? true;
213
+ const hasDocument = typeof document !== 'undefined';
214
+ const visibilityActive = wantsVisibility && hasDocument;
215
+ function bufferFor(currentExpiresAtMs) {
216
+ if (typeof options.bufferMs === 'number')
217
+ return options.bufferMs;
218
+ const ttl = currentExpiresAtMs - now();
219
+ return Math.max(DEFAULT_BUFFER_FLOOR_MS, Math.floor(ttl * DEFAULT_BUFFER_RATIO));
220
+ }
221
+ function clearTimerIfAny() {
222
+ if (timer !== null) {
223
+ clearTimer(timer);
224
+ timer = null;
225
+ }
226
+ }
227
+ function schedule() {
228
+ if (disposed)
229
+ return;
230
+ clearTimerIfAny();
231
+ const buffer = bufferFor(expiresAtMs);
232
+ const delay = Math.max(0, expiresAtMs - buffer - now());
233
+ timer = setTimer(() => {
234
+ void refreshNow().catch(() => {
235
+ // onError already fired inside refreshNow; swallow here so
236
+ // the timer callback doesn't surface as an unhandled rejection.
237
+ });
238
+ }, delay);
239
+ }
240
+ function refreshNow() {
241
+ if (disposed) {
242
+ return Promise.reject(new Error('refreshScheduler: disposed'));
243
+ }
244
+ if (inFlight)
245
+ return inFlight;
246
+ inFlight = (async () => {
247
+ try {
248
+ const result = await options.refresh();
249
+ if (disposed)
250
+ return result;
251
+ expiresAtMs = result.expiresAtMs;
252
+ options.onRefreshed?.({ expiresAtMs });
253
+ schedule();
254
+ return result;
255
+ }
256
+ catch (err) {
257
+ const error = err instanceof Error ? err : new Error(String(err));
258
+ options.onError?.(error);
259
+ // Reschedule even on failure so the next window still triggers.
260
+ // The user's apiKey may have been temporarily unreachable.
261
+ if (!disposed)
262
+ schedule();
263
+ throw error;
264
+ }
265
+ finally {
266
+ inFlight = null;
267
+ }
268
+ })();
269
+ return inFlight;
270
+ }
271
+ function onVisibilityChange() {
272
+ if (disposed)
273
+ return;
274
+ if (typeof document === 'undefined')
275
+ return;
276
+ if (document.visibilityState !== 'visible')
277
+ return;
278
+ const buffer = bufferFor(expiresAtMs);
279
+ if (expiresAtMs - now() <= buffer) {
280
+ void refreshNow().catch(() => {
281
+ // already routed through onError
282
+ });
283
+ }
284
+ }
285
+ if (visibilityActive) {
286
+ document.addEventListener('visibilitychange', onVisibilityChange);
287
+ }
288
+ schedule();
289
+ return {
290
+ refreshNow,
291
+ dispose() {
292
+ if (disposed)
293
+ return;
294
+ disposed = true;
295
+ clearTimerIfAny();
296
+ if (visibilityActive) {
297
+ document.removeEventListener('visibilitychange', onVisibilityChange);
298
+ }
299
+ },
300
+ get expiresAtMs() {
301
+ return expiresAtMs;
302
+ },
303
+ };
304
+ }
@@ -8,7 +8,7 @@ export declare const CapabilityExchangeResponseSchema: z.ZodObject<{
8
8
  scope: z.ZodObject<{
9
9
  organizationId: z.ZodString;
10
10
  syncGroups: z.ZodArray<z.ZodString>;
11
- operations: z.ZodArray<z.ZodString>;
11
+ operations: z.ZodArray<z.ZodTemplateLiteral<`${string}.update` | `${string}.create` | `${string}.delete` | `${string}.read`>>;
12
12
  participantKind: z.ZodEnum<{
13
13
  user: "user";
14
14
  agent: "agent";
@@ -1,6 +1,12 @@
1
1
  import { z } from 'zod';
2
+ import { participantKindSchema } from '../coordination/schema.js';
3
+ import { capabilityScopeSchema } from './capability.js';
2
4
  import { AbloAuthenticationError } from '../errors.js';
3
- const AuthParticipantKindSchema = z.enum(['user', 'agent', 'system']);
5
+ // Not a second enum. The auth responses carry the same participant vocabulary
6
+ // the coordination plane parses, so they validate against the same schema — a
7
+ // kind the delta plane accepts must not throw here on an otherwise-valid
8
+ // identity-resolve response.
9
+ const AuthParticipantKindSchema = participantKindSchema;
4
10
  export const AuthTokenSchema = z.string().trim().min(1);
5
11
  export const CapabilityExchangeResponseSchema = z
6
12
  .object({
@@ -8,18 +14,12 @@ export const CapabilityExchangeResponseSchema = z
8
14
  token: AuthTokenSchema,
9
15
  expiresAt: z.string().min(1),
10
16
  organizationId: z.string().min(1),
11
- scope: z
12
- .object({
13
- organizationId: z.string().min(1),
14
- syncGroups: z.array(z.string()),
15
- operations: z.array(z.string()),
16
- participantKind: AuthParticipantKindSchema,
17
- participantId: z.string().min(1),
18
- })
19
- .passthrough(),
17
+ // The grant the mint settled on, in the one shape the key row stores and
18
+ // the gates read — not a second description of it.
19
+ scope: capabilityScopeSchema.loose(),
20
20
  userMeta: z.record(z.string(), z.unknown()),
21
21
  })
22
- .passthrough();
22
+ .loose();
23
23
  export const IdentityResolveResponseSchema = z
24
24
  .object({
25
25
  participantKind: AuthParticipantKindSchema,
@@ -35,7 +35,7 @@ export const IdentityResolveResponseSchema = z
35
35
  syncGroups: z.array(z.string()),
36
36
  userMeta: z.record(z.string(), z.unknown()),
37
37
  })
38
- .passthrough();
38
+ .loose();
39
39
  /**
40
40
  * The response shape of `POST /auth/ephemeral-keys`, the endpoint that mints an
41
41
  * end-user session key (an `ek_` key). The shape is flat, with no nested scope
@@ -53,7 +53,7 @@ export const EphemeralKeyResponseSchema = z
53
53
  participantId: z.string().min(1),
54
54
  syncGroups: z.array(z.string()),
55
55
  })
56
- .passthrough();
56
+ .loose();
57
57
  function formatIssues(error) {
58
58
  return error.issues
59
59
  .map((issue) => {
@@ -1,5 +1,5 @@
1
1
  import type { SchemaRecord } from '../schema/schema.js';
2
- import type { AbloSession, CreateSessionParams } from './resourceTypes.js';
2
+ import type { AbloSession, CreateSessionParams } from '../resources/httpResources.js';
3
3
  /**
4
4
  * The resolved control-plane details a mint needs: a secret key, a base URL,
5
5
  * and an optional `fetch`. When `fetch` is omitted, the auth helpers fall back
@@ -10,15 +10,15 @@ export interface MintSessionContext {
10
10
  readonly baseUrl: string;
11
11
  readonly fetch?: typeof fetch;
12
12
  /**
13
- * Maps each schema key to its wire type name. Every public client supplies
14
- * this; it stays optional only for isolated private-transport use. A
15
- * capability is scoped by the lowercased type name the server checks, but
16
- * `can` is keyed by schema key so
13
+ * Each schema key mapped to its wire type name, from
14
+ * {@link modelWireNames} over the client's own schema. Required, and derived
15
+ * rather than assembled: `can` is keyed by schema key while a capability is
16
+ * scoped by the type name the server checks, so
17
17
  * `can: { documents: ['update'] }` on a model whose type name is overridden
18
- * to `Document` must mint `document.update`, not `documents.update`, or the
19
- * server denies the write with `capability_scope_denied`.
18
+ * to `Document` must mint `document.update`. A caller who leaves this out
19
+ * mints a grant the server denies on the first write.
20
20
  */
21
- readonly modelTypenames?: Readonly<Record<string, string>>;
21
+ readonly modelTypenames: Readonly<Record<string, string>>;
22
22
  }
23
23
  /**
24
24
  * Mints a session token from an already-resolved secret key and base URL.
@@ -23,6 +23,7 @@
23
23
  * caller's responsibility.
24
24
  */
25
25
  import { exchangeApiKey, mintUserSessionKey } from '../auth/index.js';
26
+ import { grantedOperations } from './capability.js';
26
27
  /**
27
28
  * Mints a session token from an already-resolved secret key and base URL.
28
29
  * Routes the `{ user }` or `{ agent }` request to the matching mint endpoint
@@ -58,13 +59,9 @@ export async function mintSession(params, ctx) {
58
59
  userMeta: params.userMeta ?? { id: res.participantId },
59
60
  };
60
61
  }
61
- const operations = Object.entries(params.can).flatMap(([model, ops]) => {
62
- // Translate the schema key the developer used in `can` into the wire type
63
- // name the server checks — see `modelTypenames` above. The key fallback is
64
- // private transport tolerance; every public client supplies the schema map.
65
- const ns = ctx.modelTypenames?.[model] ?? model;
66
- return (ops ?? []).map((op) => `${ns.toLowerCase()}.${op}`);
67
- });
62
+ // One translation from the declared grant to the wire allowlist, shared with
63
+ // every other door that mints see `auth/capability.ts`.
64
+ const operations = grantedOperations(params.can, ctx.modelTypenames);
68
65
  const res = await exchangeApiKey({
69
66
  apiKey,
70
67
  baseUrl,
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Waits for a queued claim to reach the head of the line — the client side of
3
+ * the fair-queue handover. When a claim is contended, the server puts it in a
4
+ * queue and replies that it is queued (HTTP 202 on `/v1/claims`, or a
5
+ * `claim_queued` frame over the WebSocket). The grant is delivered later, when
6
+ * the claim reaches the head, as a `claim_granted` frame. This resolves once
7
+ * that frame arrives for the given `claimId`, so the caller's `claim` promise
8
+ * stays pending — event-driven, with no polling — until it is actually the
9
+ * caller's turn. It rejects if the claim is lost (`claim_lost`: taken away by a
10
+ * TTL lapse on disconnect, or revoked) or if an optional timeout elapses.
11
+ *
12
+ * It needs only a minimal `{ subscribe }` transport, so it can be tested
13
+ * against a fake; the duplex `WsTransport` satisfies it.
14
+ */
15
+ import { type Logger } from '../logger.js';
16
+ export interface GrantTransport {
17
+ subscribe(event: 'claim_acquired' | 'claim_granted' | 'claim_lost' | 'claim_queued' | 'claim_rejected', handler: (payload: Record<string, unknown>) => void): () => void;
18
+ }
19
+ export interface ClaimGrantInfo {
20
+ /**
21
+ * True when the grant arrived as `claim_granted` — the target was held when
22
+ * the caller asked, and the caller waited in the FIFO line behind the holder.
23
+ * False for the immediate `claim_acquired`, where the target was free.
24
+ *
25
+ * Callers read this to know the row may have changed while they queued. Claim
26
+ * visibility is scoped to the entity, so a broad, organization-wide
27
+ * subscription receives no presence or claim fan-out, and the local
28
+ * coordination snapshot cannot be trusted to tell whether the caller waited.
29
+ * The grant frame itself is the authoritative signal.
30
+ */
31
+ readonly waited: boolean;
32
+ /**
33
+ * The fencing token the server minted for this grant (Option B), read off the
34
+ * grant frame — the authoritative source, since the token is server-stamped.
35
+ * `undefined` when the server does not fence (no minter wired).
36
+ */
37
+ readonly fenceToken?: number;
38
+ }
39
+ export declare function awaitClaimGrant(transport: GrantTransport, claimId: string, options?: {
40
+ timeoutMs?: number;
41
+ /**
42
+ * Backpressure: reject instead of waiting if, when we join the line, the
43
+ * server reports `position >= maxQueueDepth` (i.e. that many claims are
44
+ * already ahead of us). Omit to wait however deep the queue is.
45
+ */
46
+ maxQueueDepth?: number;
47
+ /**
48
+ * Abort the wait from outside — the same signal that cancels everything
49
+ * else in the program. Rejects with `claim_wait_aborted`; once the grant
50
+ * has arrived the signal is ignored, so a held lease is never torn down
51
+ * by a late abort.
52
+ */
53
+ signal?: AbortSignal;
54
+ /** Where grant transitions are logged. Defaults to silent. */
55
+ logger?: Logger;
56
+ }): Promise<ClaimGrantInfo>;