@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
@@ -5,9 +5,9 @@
5
5
  * one definition and cannot drift apart. This is the delta's home in the wire
6
6
  * layer, alongside the other protocol shapes in `wire/`.
7
7
  *
8
- * The wire delta is a projection of the stored `sync_deltas` row (see
9
- * {@link import('../schema/syncDeltaRow.js').syncDeltaRowSchema}) and differs from
10
- * it in three ways: it omits `organizationId` (the tenant-isolation predicate is
8
+ * The wire delta is a projection of the stored `sync_deltas` row (the
9
+ * `syncDeltaRowSchema` in `../log/syncDeltaRow.ts`) and differs from it
10
+ * in three ways: it omits `organizationId` (the tenant-isolation predicate is
11
11
  * never broadcast), it uses the full action vocabulary (see
12
12
  * {@link syncDeltaActionSchema}) rather than plain create, update, and delete, and
13
13
  * it carries attribution as nested {@link ParticipantRef}s instead of flat columns.
@@ -18,16 +18,20 @@
18
18
  * - {@link serverSyncDeltaSchema} — the core plus the audit attribution the server
19
19
  * adds to each broadcast, which the client ignores.
20
20
  *
21
- * The two participant enums below (`participantKind`, `confirmationState`) are the
22
- * shared vocabulary of the protocol. They live here, at the wire layer, so the
23
- * stored-row schema can import them downward rather than the wire delta reaching
24
- * up into the schema DSL for them.
21
+ * The participant vocabulary the delta carries is declared once elsewhere and
22
+ * re-served here: the actor union lives in `types/participant.ts` and its
23
+ * runtime validator in `coordination/schema.ts`. Only `confirmationState` has
24
+ * its home in this module, since the approval stage of a committed change is
25
+ * delta attribution and nothing else. All three mirror Postgres enums.
25
26
  */
26
27
  import { z } from 'zod';
27
28
  import { correlationIdSchema } from './commit.js';
28
- // ── Shared participant vocabulary (mirrors the corresponding Postgres enums) ──
29
- /** `participant_kind` who a delta is attributed to. */
30
- export const participantKindSchema = z.enum(['user', 'agent', 'system']);
29
+ import { participantKindSchema } from '../coordination/schema.js';
30
+ // ── Shared participant vocabulary (declared once; re-served on this subpath) ──
31
+ /** `participant_kind` who a delta is attributed to. Declared in
32
+ * `coordination/schema.ts`; re-exported so the wire subpath serves the
33
+ * vocabulary its delta shapes carry. */
34
+ export { participantKindSchema } from '../coordination/schema.js';
31
35
  /** `confirmation_state` — the approval stage a committed change was in. */
32
36
  export const confirmationStateSchema = z.enum([
33
37
  'auto',
@@ -57,12 +61,16 @@ export const wireDeltaDataSchema = z
57
61
  /**
58
62
  * A participant reference as carried on a broadcast delta. The server expands the
59
63
  * flat `actor_id` and `actor_kind` stored columns into this nested `{ kind, id }`
60
- * shape.
64
+ * shape. The type is the canonical {@link ParticipantRef} from
65
+ * `types/participant.ts`; the pin below fails to compile if this schema and the
66
+ * canonical shape ever drift.
61
67
  */
62
68
  export const participantRefSchema = z.object({
63
69
  kind: participantKindSchema,
64
70
  id: z.string(),
65
71
  });
72
+ const _participantRefContract = true;
73
+ void _participantRefContract;
66
74
  /**
67
75
  * The fields the server and client agree on for a broadcast delta — the shared core
68
76
  * both projections extend. `transactionId` is typed as the client sees it (an
@@ -118,6 +126,22 @@ export const serverSyncDeltaSchema = syncDeltaWireCoreSchema.extend({
118
126
  /** Foreign key to the authorizing capability; non-null for agent and system commits. */
119
127
  capabilityId: z.string().nullable(),
120
128
  confirmationState: confirmationStateSchema.nullable(),
121
- /** Foreign key to the task for the AI turn whose prompt caused this delta. */
122
- causedByTaskId: z.string().nullable(),
129
+ });
130
+ /**
131
+ * The transaction-layer seam's transport-neutral projection of a broadcast
132
+ * delta. It removes delivery plumbing (`syncGroups`, `transactionId`, and
133
+ * `correlationId`) while retaining the row change and optional audit
134
+ * attribution. `TransactionLayer.observe()` yields this shape.
135
+ */
136
+ export const deltaSchema = syncDeltaWireCoreSchema
137
+ .omit({
138
+ syncGroups: true,
139
+ transactionId: true,
140
+ correlationId: true,
141
+ })
142
+ .extend({
143
+ actor: participantRefSchema.nullable().optional(),
144
+ onBehalfOf: participantRefSchema.nullable().optional(),
145
+ capabilityId: z.string().nullable().optional(),
146
+ confirmationState: confirmationStateSchema.nullable().optional(),
123
147
  });
@@ -0,0 +1,72 @@
1
+ /**
2
+ * Turns any thrown value into the canonical error envelope and an HTTP status,
3
+ * so every error response carries the same
4
+ * `{ type, code, param, message, doc_url, request_id }` shape no matter which
5
+ * route or transport produced it. This is the counterpart to the wire-parsing
6
+ * helpers in the errors module, which turn a received envelope back into a typed
7
+ * error.
8
+ *
9
+ * It has no dependency on the client runtime, so a server-side handler can
10
+ * import it on its own to format error responses. A typed {@link AbloError}
11
+ * passes through with its code and status intact; anything else becomes a
12
+ * generic 500. A service that needs to classify database-driver failures can
13
+ * layer that on top before falling back to this baseline.
14
+ */
15
+ import { z } from 'zod';
16
+ /**
17
+ * The fixed, public-facing message returned for an unclassified 500. A raw
18
+ * `err.message` can carry driver text, connection strings, or stack fragments,
19
+ * so it is never placed on the wire; a caller that needs those details logs the
20
+ * original error server-side before formatting the response.
21
+ */
22
+ export declare const INTERNAL_ERROR_PUBLIC_MESSAGE = "An internal error occurred.";
23
+ /**
24
+ * The canonical error envelope schema. Every HTTP error response and every
25
+ * structured frame error carries these keys. `catchall` preserves typed domain
26
+ * details such as `missingIds`, `conflicts`, or `retryAfterSeconds` as additive
27
+ * top-level members, so newer producers remain compatible with older readers.
28
+ */
29
+ export declare const errorEnvelopeSchema: z.ZodObject<{
30
+ type: z.ZodString;
31
+ code: z.ZodOptional<z.ZodString>;
32
+ param: z.ZodOptional<z.ZodString>;
33
+ message: z.ZodString;
34
+ doc_url: z.ZodOptional<z.ZodString>;
35
+ request_id: z.ZodOptional<z.ZodString>;
36
+ errors: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodReadonly<z.ZodObject<{
37
+ code: z.ZodOptional<z.ZodString>;
38
+ message: z.ZodString;
39
+ param: z.ZodOptional<z.ZodString>;
40
+ }, z.core.$strip>>>>>;
41
+ }, z.core.$catchall<z.ZodUnknown>>;
42
+ export type ErrorEnvelope = Readonly<z.infer<typeof errorEnvelopeSchema>>;
43
+ /** Maps an {@link AbloError} subclass name to its default HTTP status. Each
44
+ * subclass is chosen to match the status — a validation error is a 400, a
45
+ * permission error a 403 — so a throw site picks the right class and code and
46
+ * the status follows. An explicit `httpStatus` is supplied only when it
47
+ * diverges, such as a 404 on the base class or a 503 on a server error. */
48
+ export declare function statusForType(type: string): number;
49
+ /**
50
+ * Converts any thrown value into the canonical {@link ErrorEnvelope} and an HTTP
51
+ * status. A typed {@link AbloError} is serialized through its own `toJSON`, so
52
+ * its code, param, doc_url, and structured details survive, and its status comes
53
+ * from an explicit `httpStatus` or, failing that, {@link statusForType}.
54
+ * Anything else becomes a 500 `internal_error` envelope — never a bare framework
55
+ * "Internal Server Error" body, and never a raw error string leaked onto the
56
+ * wire as an unregistered code.
57
+ *
58
+ * When `requestId` is supplied and the error does not already carry one, it is
59
+ * stamped into the body so the response and the `x-request-id` header agree for
60
+ * support correlation.
61
+ *
62
+ * A service that recognizes failures this module cannot — a database driver's
63
+ * integrity or privilege errors, say — classifies them into an {@link AbloError}
64
+ * before calling here, and that error then travels the same serialization and
65
+ * status precedence as every other one. This module deliberately takes no
66
+ * classifier callback: it would cross a package boundary, where an argument the
67
+ * built copy does not declare is dropped in silence rather than refused.
68
+ */
69
+ export declare function errorEnvelope(err: unknown, requestId?: string): {
70
+ body: ErrorEnvelope;
71
+ status: number;
72
+ };
@@ -12,6 +12,7 @@
12
12
  * generic 500. A service that needs to classify database-driver failures can
13
13
  * layer that on top before falling back to this baseline.
14
14
  */
15
+ import { z } from 'zod';
15
16
  import { AbloError, docUrlForCode } from '../errors.js';
16
17
  import { errorCodeSpec } from '../errorCodes.js';
17
18
  /**
@@ -21,6 +22,28 @@ import { errorCodeSpec } from '../errorCodes.js';
21
22
  * original error server-side before formatting the response.
22
23
  */
23
24
  export const INTERNAL_ERROR_PUBLIC_MESSAGE = 'An internal error occurred.';
25
+ const errorEnvelopeItemSchema = z.object({
26
+ code: z.string().optional(),
27
+ message: z.string(),
28
+ param: z.string().optional(),
29
+ }).readonly();
30
+ /**
31
+ * The canonical error envelope schema. Every HTTP error response and every
32
+ * structured frame error carries these keys. `catchall` preserves typed domain
33
+ * details such as `missingIds`, `conflicts`, or `retryAfterSeconds` as additive
34
+ * top-level members, so newer producers remain compatible with older readers.
35
+ */
36
+ export const errorEnvelopeSchema = z
37
+ .object({
38
+ type: z.string(),
39
+ code: z.string().optional(),
40
+ param: z.string().optional(),
41
+ message: z.string(),
42
+ doc_url: z.string().optional(),
43
+ request_id: z.string().optional(),
44
+ errors: z.array(errorEnvelopeItemSchema).readonly().optional(),
45
+ })
46
+ .catchall(z.unknown());
24
47
  /** Maps an {@link AbloError} subclass name to its default HTTP status. Each
25
48
  * subclass is chosen to match the status — a validation error is a 400, a
26
49
  * permission error a 403 — so a throw site picks the right class and code and
@@ -60,16 +83,24 @@ export function statusForType(type) {
60
83
  * When `requestId` is supplied and the error does not already carry one, it is
61
84
  * stamped into the body so the response and the `x-request-id` header agree for
62
85
  * support correlation.
86
+ *
87
+ * A service that recognizes failures this module cannot — a database driver's
88
+ * integrity or privilege errors, say — classifies them into an {@link AbloError}
89
+ * before calling here, and that error then travels the same serialization and
90
+ * status precedence as every other one. This module deliberately takes no
91
+ * classifier callback: it would cross a package boundary, where an argument the
92
+ * built copy does not declare is dropped in silence rather than refused.
63
93
  */
64
94
  export function errorEnvelope(err, requestId) {
65
- if (err instanceof AbloError) {
95
+ const typed = err instanceof AbloError ? err : undefined;
96
+ if (typed !== undefined) {
66
97
  // Status precedence: an explicit httpStatus wins; else the code's canonical
67
98
  // status from the registry (so `new AbloError('…', { code: 'entity_not_found' })`
68
99
  // is a 404 without the throw site repeating it); else the subclass default.
69
- const status = err.httpStatus ??
70
- (err.code ? errorCodeSpec(err.code)?.httpStatus : undefined) ??
71
- statusForType(err.type);
72
- const body = err.toJSON();
100
+ const status = typed.httpStatus ??
101
+ (typed.code ? errorCodeSpec(typed.code)?.httpStatus : undefined) ??
102
+ statusForType(typed.type);
103
+ const body = typed.toJSON();
73
104
  return {
74
105
  body: requestId && body.request_id === undefined ? { ...body, request_id: requestId } : body,
75
106
  status,
@@ -0,0 +1,60 @@
1
+ /**
2
+ * The resume position for `GET /v1/logs`.
3
+ *
4
+ * The feed merges two independently-sequenced sources — the settlement log and
5
+ * the claim-event log — so one opaque cursor has to carry two positions. They
6
+ * cannot share a sequence: allocating claim positions from `next_sync_id` would
7
+ * put ephemeral leases into the log that clients materialize rows from and that
8
+ * WAL-echo promotion and compaction operate over, where a claim-churn storm
9
+ * would be indistinguishable from committed change.
10
+ *
11
+ * Encoded `"<log>.<claims>"`, and a bare `"<log>"` still parses — cursors are
12
+ * persisted by callers, and every one issued before this existed is a plain
13
+ * delta id. Those resume at claim position 0, which is correct: a caller who
14
+ * never asked for claim events has no claim position to preserve.
15
+ *
16
+ * **A malformed cursor is an error, never a position.** The previous reader was
17
+ * `parseInt(raw, 10)` with `NaN ? 0 : n`, so a truncated or garbled cursor
18
+ * silently resumed from the beginning of the log and replayed it in full. That
19
+ * is the worst available failure: it looks like a working follow, and the
20
+ * damage scales with how long the log has been running. Parsing returns null
21
+ * and the route answers `invalid_request`.
22
+ */
23
+ import { z } from 'zod';
24
+ export declare const feedCursorSchema: z.ZodObject<{
25
+ log: z.ZodNumber;
26
+ claims: z.ZodNumber;
27
+ }, z.core.$strip>;
28
+ export type FeedCursor = z.infer<typeof feedCursorSchema>;
29
+ /**
30
+ * The cursor grammar, in one place, so the parser and the error that rejects a
31
+ * bad one cannot describe it differently. A reader who is told what shape was
32
+ * expected can fix the call; a reader told only that theirs was wrong cannot.
33
+ */
34
+ export declare const FEED_CURSOR_FORMAT = "<log>[.<claims>]";
35
+ /** A cursor that shows the grammar rather than only naming it. */
36
+ export declare const FEED_CURSOR_EXAMPLE = "4210.17";
37
+ /** The cursor a caller resumes from when they send none. */
38
+ export declare const FEED_CURSOR_START: FeedCursor;
39
+ /**
40
+ * Reads a wire cursor. Returns null when the string is not one — the caller
41
+ * turns that into `invalid_request` rather than guessing a position.
42
+ *
43
+ * Deliberately strict: only digits and at most one separator. `Number()` alone
44
+ * would accept `'1e3'`, `'0x10'`, `' 42 '`, and `''`, each of which would
45
+ * resume somewhere the caller did not ask for.
46
+ */
47
+ export declare function parseFeedCursor(raw: string): FeedCursor | null;
48
+ /** Writes a wire cursor. Always both positions, so the shape never varies. */
49
+ export declare function formatFeedCursor(cursor: FeedCursor): string;
50
+ /**
51
+ * Whether `next` is ahead of `prev` on either axis — the guard a follow loop
52
+ * needs so a stale or duplicated page cannot rewind it.
53
+ *
54
+ * It lives here because the alternative is what every caller reaches for first:
55
+ * comparing the cursor STRINGS as numbers. `Number('42.10')` is `42.1`, which
56
+ * compares as *behind* `42.9` and re-serializes as `'42.1'` — a cursor that
57
+ * silently skips eight claim positions and looks like it worked. A cursor is
58
+ * opaque to its holder; only this module takes it apart.
59
+ */
60
+ export declare function feedCursorAdvanced(prev: FeedCursor, next: FeedCursor): boolean;
@@ -0,0 +1,82 @@
1
+ /**
2
+ * The resume position for `GET /v1/logs`.
3
+ *
4
+ * The feed merges two independently-sequenced sources — the settlement log and
5
+ * the claim-event log — so one opaque cursor has to carry two positions. They
6
+ * cannot share a sequence: allocating claim positions from `next_sync_id` would
7
+ * put ephemeral leases into the log that clients materialize rows from and that
8
+ * WAL-echo promotion and compaction operate over, where a claim-churn storm
9
+ * would be indistinguishable from committed change.
10
+ *
11
+ * Encoded `"<log>.<claims>"`, and a bare `"<log>"` still parses — cursors are
12
+ * persisted by callers, and every one issued before this existed is a plain
13
+ * delta id. Those resume at claim position 0, which is correct: a caller who
14
+ * never asked for claim events has no claim position to preserve.
15
+ *
16
+ * **A malformed cursor is an error, never a position.** The previous reader was
17
+ * `parseInt(raw, 10)` with `NaN ? 0 : n`, so a truncated or garbled cursor
18
+ * silently resumed from the beginning of the log and replayed it in full. That
19
+ * is the worst available failure: it looks like a working follow, and the
20
+ * damage scales with how long the log has been running. Parsing returns null
21
+ * and the route answers `invalid_request`.
22
+ */
23
+ import { z } from 'zod';
24
+ export const feedCursorSchema = z.object({
25
+ /** Last delta id delivered. */
26
+ log: z.number().int().nonnegative(),
27
+ /** Last claim-event seq delivered. */
28
+ claims: z.number().int().nonnegative(),
29
+ });
30
+ /**
31
+ * The cursor grammar, in one place, so the parser and the error that rejects a
32
+ * bad one cannot describe it differently. A reader who is told what shape was
33
+ * expected can fix the call; a reader told only that theirs was wrong cannot.
34
+ */
35
+ export const FEED_CURSOR_FORMAT = '<log>[.<claims>]';
36
+ /** A cursor that shows the grammar rather than only naming it. */
37
+ export const FEED_CURSOR_EXAMPLE = '4210.17';
38
+ /** The cursor a caller resumes from when they send none. */
39
+ export const FEED_CURSOR_START = { log: 0, claims: 0 };
40
+ /**
41
+ * Reads a wire cursor. Returns null when the string is not one — the caller
42
+ * turns that into `invalid_request` rather than guessing a position.
43
+ *
44
+ * Deliberately strict: only digits and at most one separator. `Number()` alone
45
+ * would accept `'1e3'`, `'0x10'`, `' 42 '`, and `''`, each of which would
46
+ * resume somewhere the caller did not ask for.
47
+ */
48
+ export function parseFeedCursor(raw) {
49
+ const match = /^(\d+)(?:\.(\d+))?$/.exec(raw);
50
+ if (!match)
51
+ return null;
52
+ const parsed = feedCursorSchema.safeParse({
53
+ log: Number(match[1]),
54
+ claims: match[2] === undefined ? 0 : Number(match[2]),
55
+ });
56
+ if (!parsed.success)
57
+ return null;
58
+ // Beyond 2^53 the positions stop round-tripping through JSON's number type,
59
+ // and a cursor that cannot round-trip is not a cursor.
60
+ if (!Number.isSafeInteger(parsed.data.log) ||
61
+ !Number.isSafeInteger(parsed.data.claims)) {
62
+ return null;
63
+ }
64
+ return parsed.data;
65
+ }
66
+ /** Writes a wire cursor. Always both positions, so the shape never varies. */
67
+ export function formatFeedCursor(cursor) {
68
+ return `${cursor.log}.${cursor.claims}`;
69
+ }
70
+ /**
71
+ * Whether `next` is ahead of `prev` on either axis — the guard a follow loop
72
+ * needs so a stale or duplicated page cannot rewind it.
73
+ *
74
+ * It lives here because the alternative is what every caller reaches for first:
75
+ * comparing the cursor STRINGS as numbers. `Number('42.10')` is `42.1`, which
76
+ * compares as *behind* `42.9` and re-serializes as `'42.1'` — a cursor that
77
+ * silently skips eight claim positions and looks like it worked. A cursor is
78
+ * opaque to its holder; only this module takes it apart.
79
+ */
80
+ export function feedCursorAdvanced(prev, next) {
81
+ return next.log > prev.log || next.claims > prev.claims;
82
+ }
@@ -0,0 +1,204 @@
1
+ /**
2
+ * What `GET /v1/logs` returns: one envelope, two arms.
3
+ *
4
+ * The feed answers two questions that a caller without a socket cannot
5
+ * otherwise ask — "what changed" and "who is working on what" — and it answers
6
+ * them through one endpoint, one envelope, and one cursor grammar rather than
7
+ * growing a second feed with its own pagination dialect beside the first.
8
+ *
9
+ * The arms stay separately sequenced. A claim is a lease, not a settled fact,
10
+ * and putting one into the log that clients materialize rows from — and that
11
+ * WAL-echo promotion and compaction operate over — would make a claim-churn
12
+ * storm indistinguishable from committed change. They share a reading, not a
13
+ * sequence; {@link FeedCursor} is what carries both positions.
14
+ */
15
+ import { z } from 'zod';
16
+ import { type LogEvent } from './accountResponses.js';
17
+ import { type ClaimEvent } from './claimEvent.js';
18
+ import { type ListEnvelope } from './listEnvelope.js';
19
+ /**
20
+ * One entry, from either source. Discriminated on `object`, so a consumer
21
+ * reading an arm it does not know still parses the page and can skip the entry
22
+ * — which is what lets the claim arm be added to a running feed at all.
23
+ */
24
+ export declare const feedEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
25
+ object: z.ZodLiteral<"log_event">;
26
+ id: z.ZodNumber;
27
+ at: z.ZodString;
28
+ model: z.ZodString;
29
+ op: z.ZodEnum<{
30
+ update: "update";
31
+ visible: "visible";
32
+ create: "create";
33
+ delete: "delete";
34
+ archive: "archive";
35
+ revive: "revive";
36
+ group_added: "group_added";
37
+ group_removed: "group_removed";
38
+ }>;
39
+ recordId: z.ZodString;
40
+ actor: z.ZodNullable<z.ZodString>;
41
+ }, z.core.$strip>, z.ZodReadonly<z.ZodObject<{
42
+ target: z.ZodReadonly<z.ZodObject<{
43
+ model: z.ZodString;
44
+ id: z.ZodString;
45
+ path: z.ZodOptional<z.ZodString>;
46
+ range: z.ZodOptional<z.ZodObject<{
47
+ startLine: z.ZodNumber;
48
+ endLine: z.ZodNumber;
49
+ startColumn: z.ZodOptional<z.ZodNumber>;
50
+ endColumn: z.ZodOptional<z.ZodNumber>;
51
+ }, z.core.$strip>>;
52
+ field: z.ZodOptional<z.ZodString>;
53
+ fields: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
54
+ meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
55
+ }, z.core.$strip>>;
56
+ description: z.ZodString;
57
+ expiresAt: z.ZodNumber;
58
+ onBehalfOfId: z.ZodNullable<z.ZodString>;
59
+ onBehalfOfKind: z.ZodNullable<z.ZodPreprocess<z.ZodEnum<{
60
+ user: "user";
61
+ agent: "agent";
62
+ system: "system";
63
+ }>>>;
64
+ capabilityId: z.ZodNullable<z.ZodString>;
65
+ fenceToken: z.ZodOptional<z.ZodNumber>;
66
+ position: z.ZodOptional<z.ZodNumber>;
67
+ participantKind: z.ZodPreprocess<z.ZodEnum<{
68
+ user: "user";
69
+ agent: "agent";
70
+ system: "system";
71
+ }>>;
72
+ actor: z.ZodString;
73
+ object: z.ZodLiteral<"claim_event">;
74
+ seq: z.ZodNumber;
75
+ at: z.ZodString;
76
+ claimId: z.ZodString;
77
+ status: z.ZodEnum<{
78
+ active: "active";
79
+ committed: "committed";
80
+ expired: "expired";
81
+ canceled: "canceled";
82
+ queued: "queued";
83
+ }>;
84
+ }, z.core.$strip>>], "object">;
85
+ export type FeedEvent = LogEvent | ClaimEvent;
86
+ /** `GET /v1/logs` — the canonical list envelope over the feed. */
87
+ export declare const logListResponseSchema: z.ZodObject<{
88
+ object: z.ZodLiteral<"list">;
89
+ data: z.ZodReadonly<z.ZodArray<z.ZodType<{
90
+ object: "log_event";
91
+ id: number;
92
+ at: string;
93
+ model: string;
94
+ op: "update" | "visible" | "create" | "delete" | "archive" | "revive" | "group_added" | "group_removed";
95
+ recordId: string;
96
+ actor: string | null;
97
+ } | Readonly<{
98
+ target: Readonly<{
99
+ model: string;
100
+ id: string;
101
+ path?: string | undefined;
102
+ range?: {
103
+ startLine: number;
104
+ endLine: number;
105
+ startColumn?: number | undefined;
106
+ endColumn?: number | undefined;
107
+ } | undefined;
108
+ field?: string | undefined;
109
+ fields?: readonly string[] | undefined;
110
+ meta?: Record<string, unknown> | undefined;
111
+ }>;
112
+ description: string;
113
+ expiresAt: number;
114
+ onBehalfOfId: string | null;
115
+ onBehalfOfKind: "user" | "agent" | "system" | null;
116
+ capabilityId: string | null;
117
+ participantKind: "user" | "agent" | "system";
118
+ actor: string;
119
+ object: "claim_event";
120
+ seq: number;
121
+ at: string;
122
+ claimId: string;
123
+ status: "active" | "committed" | "expired" | "canceled" | "queued";
124
+ fenceToken?: number | undefined;
125
+ position?: number | undefined;
126
+ }>, unknown, z.core.$ZodTypeInternals<{
127
+ object: "log_event";
128
+ id: number;
129
+ at: string;
130
+ model: string;
131
+ op: "update" | "visible" | "create" | "delete" | "archive" | "revive" | "group_added" | "group_removed";
132
+ recordId: string;
133
+ actor: string | null;
134
+ } | Readonly<{
135
+ target: Readonly<{
136
+ model: string;
137
+ id: string;
138
+ path?: string | undefined;
139
+ range?: {
140
+ startLine: number;
141
+ endLine: number;
142
+ startColumn?: number | undefined;
143
+ endColumn?: number | undefined;
144
+ } | undefined;
145
+ field?: string | undefined;
146
+ fields?: readonly string[] | undefined;
147
+ meta?: Record<string, unknown> | undefined;
148
+ }>;
149
+ description: string;
150
+ expiresAt: number;
151
+ onBehalfOfId: string | null;
152
+ onBehalfOfKind: "user" | "agent" | "system" | null;
153
+ capabilityId: string | null;
154
+ participantKind: "user" | "agent" | "system";
155
+ actor: string;
156
+ object: "claim_event";
157
+ seq: number;
158
+ at: string;
159
+ claimId: string;
160
+ status: "active" | "committed" | "expired" | "canceled" | "queued";
161
+ fenceToken?: number | undefined;
162
+ position?: number | undefined;
163
+ }>, unknown>>>>;
164
+ has_more: z.ZodBoolean;
165
+ next_cursor: z.ZodNullable<z.ZodString>;
166
+ }, z.core.$strip>;
167
+ export type LogListResponse = ListEnvelope<FeedEvent>;
168
+ /**
169
+ * The query string on `GET /v1/logs`.
170
+ *
171
+ * Values arrive as strings, so this describes the wire spelling rather than the
172
+ * parsed result — the same reason {@link listQuerySchema} does.
173
+ *
174
+ * Scope is NOT here and never will be: the plane, the organization and the sync
175
+ * groups all come off the credential. A caller cannot widen what it sees by
176
+ * asking, which is what makes this feed safe to hand an agent.
177
+ */
178
+ export declare const logQuerySchema: z.ZodObject<{
179
+ after: z.ZodOptional<z.ZodString>;
180
+ limit: z.ZodOptional<z.ZodString>;
181
+ model: z.ZodOptional<z.ZodString>;
182
+ op: z.ZodOptional<z.ZodEnum<{
183
+ update: "update";
184
+ visible: "visible";
185
+ create: "create";
186
+ delete: "delete";
187
+ archive: "archive";
188
+ revive: "revive";
189
+ group_added: "group_added";
190
+ group_removed: "group_removed";
191
+ }>>;
192
+ since: z.ZodOptional<z.ZodString>;
193
+ }, z.core.$strip>;
194
+ export type LogQuery = z.infer<typeof logQuerySchema>;
195
+ /**
196
+ * The claim arm has no producer yet: claim transitions are broadcast today and
197
+ * recorded nowhere, so there is no sequence to read `seq` from. Until that log
198
+ * exists the route emits only `log_event`s, and there is deliberately NO
199
+ * request parameter for selecting arms — a knob that cannot be honoured is how
200
+ * a contract comes to describe a server that does not exist.
201
+ *
202
+ * What is here is the definition the producer will fill: the union parses
203
+ * today's pages unchanged, and the cursor already carries the second position.
204
+ */
@@ -0,0 +1,65 @@
1
+ /**
2
+ * What `GET /v1/logs` returns: one envelope, two arms.
3
+ *
4
+ * The feed answers two questions that a caller without a socket cannot
5
+ * otherwise ask — "what changed" and "who is working on what" — and it answers
6
+ * them through one endpoint, one envelope, and one cursor grammar rather than
7
+ * growing a second feed with its own pagination dialect beside the first.
8
+ *
9
+ * The arms stay separately sequenced. A claim is a lease, not a settled fact,
10
+ * and putting one into the log that clients materialize rows from — and that
11
+ * WAL-echo promotion and compaction operate over — would make a claim-churn
12
+ * storm indistinguishable from committed change. They share a reading, not a
13
+ * sequence; {@link FeedCursor} is what carries both positions.
14
+ */
15
+ import { z } from 'zod';
16
+ import { logEventSchema, logOpSchema } from './accountResponses.js';
17
+ import { claimEventSchema } from './claimEvent.js';
18
+ import { listEnvelopeSchema } from './listEnvelope.js';
19
+ /**
20
+ * One entry, from either source. Discriminated on `object`, so a consumer
21
+ * reading an arm it does not know still parses the page and can skip the entry
22
+ * — which is what lets the claim arm be added to a running feed at all.
23
+ */
24
+ export const feedEventSchema = z.discriminatedUnion('object', [
25
+ logEventSchema,
26
+ claimEventSchema,
27
+ ]);
28
+ /** `GET /v1/logs` — the canonical list envelope over the feed. */
29
+ export const logListResponseSchema = listEnvelopeSchema(feedEventSchema);
30
+ /**
31
+ * The query string on `GET /v1/logs`.
32
+ *
33
+ * Values arrive as strings, so this describes the wire spelling rather than the
34
+ * parsed result — the same reason {@link listQuerySchema} does.
35
+ *
36
+ * Scope is NOT here and never will be: the plane, the organization and the sync
37
+ * groups all come off the credential. A caller cannot widen what it sees by
38
+ * asking, which is what makes this feed safe to hand an agent.
39
+ */
40
+ export const logQuerySchema = z.object({
41
+ /**
42
+ * The `next_cursor` from the previous page, copied back unchanged. Omit it to
43
+ * start from the most recent entries — this is a tail, so the first page is
44
+ * the end of the log and `after` walks forward from there.
45
+ */
46
+ after: z.string().optional(),
47
+ /** Entries per page. Clamped server-side; the default is a short tail. */
48
+ limit: z.string().optional(),
49
+ /** Only this model's entries. */
50
+ model: z.string().optional(),
51
+ /** Only this kind of change. */
52
+ op: logOpSchema.optional(),
53
+ /** Only entries at or after this ISO 8601 timestamp. */
54
+ since: z.string().optional(),
55
+ });
56
+ /**
57
+ * The claim arm has no producer yet: claim transitions are broadcast today and
58
+ * recorded nowhere, so there is no sequence to read `seq` from. Until that log
59
+ * exists the route emits only `log_event`s, and there is deliberately NO
60
+ * request parameter for selecting arms — a knob that cannot be honoured is how
61
+ * a contract comes to describe a server that does not exist.
62
+ *
63
+ * What is here is the definition the producer will fill: the union parses
64
+ * today's pages unchanged, and the cursor already carries the second position.
65
+ */