@abloatai/ablo 0.34.1 → 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 +2 -1
  2. package/CHANGELOG.md +674 -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 +3344 -1073
  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 -86
  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 +3 -1
  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
@@ -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,49 @@
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
+ /** Where grant transitions are logged. Defaults to silent. */
48
+ logger?: Logger;
49
+ }): Promise<ClaimGrantInfo>;
@@ -0,0 +1,112 @@
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 { AbloClaimedError, formatClaimedErrorMessage, claimTargetLabel, } from '../errors.js';
16
+ import { modelTarget } from './locator.js';
17
+ import { noopLogger } from '../logger.js';
18
+ /** Read the server-stamped fencing token off a grant frame, if present. */
19
+ function readFenceToken(p) {
20
+ return typeof p.fenceToken === 'number' ? p.fenceToken : undefined;
21
+ }
22
+ export function awaitClaimGrant(transport, claimId, options) {
23
+ const logger = options?.logger ?? noopLogger;
24
+ return new Promise((resolve, reject) => {
25
+ const unsubs = [];
26
+ let timer;
27
+ const settle = (fn) => {
28
+ if (timer)
29
+ clearTimeout(timer);
30
+ for (const u of unsubs)
31
+ u();
32
+ fn();
33
+ };
34
+ // The target was free → `claim_acquired` (immediate); it was contended,
35
+ // we waited in line, and reached the head → `claim_granted`. Either frame
36
+ // means the lease is now ours; `waited` records which path it was.
37
+ unsubs.push(transport.subscribe('claim_acquired', (p) => {
38
+ if (p?.claimId === claimId) {
39
+ logger.debug(`claim: acquired ${claimId} (target was free)`);
40
+ const fenceToken = readFenceToken(p);
41
+ settle(() => {
42
+ resolve({ waited: false, ...(fenceToken !== undefined ? { fenceToken } : {}) });
43
+ });
44
+ }
45
+ }));
46
+ unsubs.push(transport.subscribe('claim_granted', (p) => {
47
+ if (p?.claimId === claimId) {
48
+ // Promoted to the head of the line — the creator's "it's the agent's
49
+ // turn now" moment after waiting behind a holder.
50
+ logger.info(`claim: granted ${claimId} — your turn (waited in queue)`);
51
+ const fenceToken = readFenceToken(p);
52
+ settle(() => {
53
+ resolve({ waited: true, ...(fenceToken !== undefined ? { fenceToken } : {}) });
54
+ });
55
+ }
56
+ }));
57
+ if (options?.maxQueueDepth !== undefined) {
58
+ const max = options.maxQueueDepth;
59
+ unsubs.push(transport.subscribe('claim_queued', (p) => {
60
+ if (p?.claimId !== claimId)
61
+ return;
62
+ const position = typeof p.position === 'number' ? p.position : 0;
63
+ if (position >= max) {
64
+ settle(() => {
65
+ reject(new AbloClaimedError(`Claim queue for ${claimId} is ${position} deep (max ${max}).`, { code: 'queue_too_deep' }));
66
+ });
67
+ }
68
+ }));
69
+ }
70
+ unsubs.push(transport.subscribe('claim_rejected', (p) => {
71
+ const rejection = p;
72
+ if (rejection.claimId !== claimId)
73
+ return;
74
+ const target = rejection.target
75
+ ? claimTargetLabel({
76
+ ...modelTarget(rejection.target),
77
+ field: rejection.target.field,
78
+ })
79
+ : claimId;
80
+ settle(() => {
81
+ reject(new AbloClaimedError(formatClaimedErrorMessage({
82
+ targetLabel: target,
83
+ heldBy: rejection.heldBy,
84
+ claim: rejection.heldByClaim,
85
+ policyReason: rejection.policyReason,
86
+ fallback: `Claim rejected for ${target}.`,
87
+ }), {
88
+ code: rejection.reason === 'conflict'
89
+ ? 'claim_conflict'
90
+ : 'claim_lease_unavailable',
91
+ claims: rejection.heldByClaim ? [rejection.heldByClaim] : undefined,
92
+ }));
93
+ });
94
+ }));
95
+ unsubs.push(transport.subscribe('claim_lost', (p) => {
96
+ if (p?.claimId === claimId) {
97
+ settle(() => {
98
+ reject(new AbloClaimedError(`Claim lost while queued for ${claimId}.`, {
99
+ code: 'claim_lost',
100
+ }));
101
+ });
102
+ }
103
+ }));
104
+ if (options?.timeoutMs && options.timeoutMs > 0) {
105
+ timer = setTimeout(() => {
106
+ settle(() => {
107
+ reject(new AbloClaimedError(`Timed out waiting for the queue grant on claim ${claimId}.`, { code: 'grant_timeout' }));
108
+ });
109
+ }, options.timeoutMs);
110
+ }
111
+ });
112
+ }
@@ -0,0 +1,49 @@
1
+ /**
2
+ * A claim's application metadata, crossing between the wire and the shape the
3
+ * program declared for it.
4
+ *
5
+ * The wire contract for `meta` is deliberately permissive — `targetRefSchema`
6
+ * parses it as `z.record(z.string(), z.unknown())` and always will, because a
7
+ * newer peer must be able to send a field this build has never heard of and
8
+ * still be understood. The read surface is the opposite: `Register`'s
9
+ * `ClaimMeta` slot names the one shape this program's claims carry, so
10
+ * `claim.state({ id })?.target.meta` reads without a guard.
11
+ *
12
+ * Those two facts meet here, and only here, in both directions. A decode calls
13
+ * {@link declaredMeta} on its way from a parsed record to a public `Claim`; the
14
+ * locator projection calls {@link wireMeta} on the way back out, where a
15
+ * caller's declared value is put on the socket or in the HTTP body. Between
16
+ * them they are the one place the SDK takes the caller's word for a shape it
17
+ * did not check — written down once, with the reason, instead of being asserted
18
+ * at each crossing.
19
+ *
20
+ * The two directions are not symmetric in cost. Losing the declared shape on
21
+ * the way out is harmless, because the wire has always accepted any record;
22
+ * gaining it on the way in is the promise the read surface makes, so
23
+ * `declaredMeta` is the one to audit when a claim reads back a shape its holder
24
+ * never wrote.
25
+ */
26
+ import type { ResolveClaimMeta } from '../types/global.js';
27
+ /**
28
+ * Read a parsed `meta` as the declared shape. Call it only where a decode hands
29
+ * a wire value to a public claim, and only for a value already known present —
30
+ * the absent case is an omitted member, not a declared-shaped `undefined`.
31
+ *
32
+ * The exported names are `declaredMeta` and `wireMeta` rather than a `claimMeta`
33
+ * pair because two claim surfaces already read a caller's `meta` back off the
34
+ * options it passed in, and spell that local reader `claimMeta`.
35
+ */
36
+ export declare function declaredMeta(raw: unknown): ResolveClaimMeta;
37
+ /**
38
+ * Write a declared `meta` as the permissive record the wire carries. Every path
39
+ * from a caller's target to a frame or request body goes through `subTarget`,
40
+ * so this has exactly one caller — widening it is how the declared shape stops
41
+ * being a compile error at the edge of the protocol instead of stopping there.
42
+ *
43
+ * The parameter is `unknown` rather than {@link ResolveClaimMeta} on purpose: a
44
+ * program may register an `interface` for its claim metadata, and an interface
45
+ * carries no implicit index signature, so a directly-typed parameter would make
46
+ * the conversion itself unrepresentable at the one site that needs it. Widening
47
+ * the input is what keeps the assertion single.
48
+ */
49
+ export declare function wireMeta(meta: unknown): Record<string, unknown>;