@abloatai/ablo 0.34.1 → 0.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (536) hide show
  1. package/AGENTS.md +2 -1
  2. package/CHANGELOG.md +758 -5
  3. package/README.md +56 -502
  4. package/bin/ablo.cjs +39 -0
  5. package/dist/BaseSyncedStore.d.ts +176 -48
  6. package/dist/BaseSyncedStore.js +346 -214
  7. package/dist/Database.d.ts +17 -44
  8. package/dist/Database.js +96 -79
  9. package/dist/InstanceCache.d.ts +31 -6
  10. package/dist/InstanceCache.js +65 -30
  11. package/dist/LazyReferenceCollection.d.ts +3 -3
  12. package/dist/LazyReferenceCollection.js +4 -4
  13. package/dist/Model.d.ts +23 -13
  14. package/dist/Model.js +27 -17
  15. package/dist/ModelRegistry.d.ts +8 -4
  16. package/dist/ModelRegistry.js +20 -18
  17. package/dist/NetworkMonitor.d.ts +3 -1
  18. package/dist/NetworkMonitor.js +7 -5
  19. package/dist/{SyncEngineContext.d.ts → RuntimeContext.d.ts} +20 -13
  20. package/dist/{SyncEngineContext.js → RuntimeContext.js} +11 -12
  21. package/dist/SyncClient.d.ts +47 -47
  22. package/dist/SyncClient.js +215 -156
  23. package/dist/ai-sdk/coordinatedTool.d.ts +2 -2
  24. package/dist/ai-sdk/coordinatedTool.js +1 -1
  25. package/dist/ai-sdk/coordinationContext.d.ts +2 -2
  26. package/dist/ai-sdk/coordinationContext.js +1 -1
  27. package/dist/ai-sdk/wrap.d.ts +3 -3
  28. package/dist/ai-sdk/wrap.js +2 -2
  29. package/dist/auth/index.d.ts +1 -156
  30. package/dist/auth/index.js +8 -301
  31. package/dist/client/Ablo.d.ts +42 -287
  32. package/dist/client/Ablo.js +129 -963
  33. package/dist/client/abloClient.d.ts +309 -0
  34. package/dist/client/abloClient.js +13 -0
  35. package/dist/client/clientPrelude.d.ts +52 -0
  36. package/dist/client/clientPrelude.js +60 -0
  37. package/dist/client/consoleLogger.d.ts +2 -2
  38. package/dist/client/coreClient.d.ts +60 -0
  39. package/dist/client/coreClient.js +118 -0
  40. package/dist/client/createInternalComponents.d.ts +8 -4
  41. package/dist/client/createInternalComponents.js +17 -10
  42. package/dist/client/createModelProxy.d.ts +98 -373
  43. package/dist/client/createModelProxy.js +233 -139
  44. package/dist/client/humans.d.ts +69 -0
  45. package/dist/client/humans.js +78 -0
  46. package/dist/client/modelRegistration.d.ts +1 -1
  47. package/dist/client/modelRegistration.js +9 -9
  48. package/dist/client/options.d.ts +73 -17
  49. package/dist/client/reactiveEngine.d.ts +53 -0
  50. package/dist/client/reactiveEngine.js +688 -0
  51. package/dist/client/resourceTypes.d.ts +9 -250
  52. package/dist/client/resourceTypes.js +8 -5
  53. package/dist/client/schemaConfig.d.ts +4 -4
  54. package/dist/client/schemaConfig.js +6 -2
  55. package/dist/client/storeCluster.d.ts +47 -0
  56. package/dist/client/storeCluster.js +118 -0
  57. package/dist/client/storeLifecycle.d.ts +61 -0
  58. package/dist/client/storeLifecycle.js +231 -0
  59. package/dist/client/validateAbloOptions.d.ts +3 -2
  60. package/dist/client/validateAbloOptions.js +1 -1
  61. package/dist/client/wsMutationExecutor.d.ts +3 -3
  62. package/dist/client/wsMutationExecutor.js +3 -3
  63. package/dist/context.d.ts +22 -9
  64. package/dist/context.js +33 -9
  65. package/dist/coordination/ClaimLog.d.ts +26 -0
  66. package/dist/coordination/ClaimLog.js +32 -0
  67. package/dist/coordination/index.d.ts +1 -15
  68. package/dist/coordination/index.js +8 -31
  69. package/dist/core/index.d.ts +3 -3
  70. package/dist/core/index.js +2 -2
  71. package/dist/docs/catalog.d.ts +72 -0
  72. package/dist/docs/catalog.js +230 -0
  73. package/dist/docs/index.d.ts +10 -0
  74. package/dist/docs/index.js +10 -0
  75. package/dist/environment.d.ts +1 -40
  76. package/dist/environment.js +8 -37
  77. package/dist/index.d.ts +44 -36
  78. package/dist/index.js +30 -22
  79. package/dist/interfaces/index.d.ts +44 -134
  80. package/dist/keys/index.d.ts +1 -77
  81. package/dist/keys/index.js +8 -190
  82. package/dist/mutators/{RecordingTransaction.d.ts → RecordingMutation.d.ts} +4 -4
  83. package/dist/mutators/{RecordingTransaction.js → RecordingMutation.js} +2 -2
  84. package/dist/mutators/Transaction.d.ts +1 -1
  85. package/dist/mutators/Transaction.js +1 -1
  86. package/dist/mutators/UndoManager.d.ts +6 -6
  87. package/dist/mutators/UndoManager.js +5 -5
  88. package/dist/mutators/defineMutators.d.ts +3 -3
  89. package/dist/mutators/defineMutators.js +1 -1
  90. package/dist/mutators/inverseOp.js +2 -2
  91. package/dist/mutators/mutateActions.d.ts +3 -3
  92. package/dist/mutators/mutateActions.js +1 -1
  93. package/dist/mutators/readerActions.d.ts +1 -1
  94. package/dist/mutators/undoApply.d.ts +1 -1
  95. package/dist/mutators/undoApply.js +1 -1
  96. package/dist/policy/index.d.ts +2 -2
  97. package/dist/policy/index.js +1 -1
  98. package/dist/query/client.d.ts +5 -2
  99. package/dist/query/client.js +10 -9
  100. package/dist/query/types.d.ts +6 -41
  101. package/dist/query/types.js +2 -2
  102. package/dist/react/AbloProvider.d.ts +18 -8
  103. package/dist/react/AbloProvider.js +10 -9
  104. package/dist/react/context.d.ts +3 -3
  105. package/dist/react/context.js +1 -1
  106. package/dist/react/createAbloReact.d.ts +56 -0
  107. package/dist/react/createAbloReact.js +51 -0
  108. package/dist/react/index.d.ts +6 -5
  109. package/dist/react/index.js +6 -3
  110. package/dist/react/internalContext.d.ts +1 -1
  111. package/dist/react/useAblo.d.ts +12 -5
  112. package/dist/react/useAblo.js +26 -8
  113. package/dist/react/useCurrentUserId.js +1 -1
  114. package/dist/react/useErrorListener.js +1 -1
  115. package/dist/react/useMutationFailureListener.d.ts +2 -2
  116. package/dist/react/useMutationFailureListener.js +1 -1
  117. package/dist/react/useMutators.d.ts +3 -3
  118. package/dist/react/useMutators.js +3 -3
  119. package/dist/react/useUndoScope.d.ts +5 -5
  120. package/dist/react/useUndoScope.js +1 -1
  121. package/dist/schema/coordination.d.ts +69 -10
  122. package/dist/schema/coordination.js +90 -9
  123. package/dist/schema/ddl.js +2 -2
  124. package/dist/schema/diff.d.ts +1 -1
  125. package/dist/schema/generate.js +1 -1
  126. package/dist/schema/index.d.ts +11 -10
  127. package/dist/schema/index.js +22 -18
  128. package/dist/schema/queries.d.ts +27 -27
  129. package/dist/schema/queries.js +23 -23
  130. package/dist/schema/select.d.ts +3 -3
  131. package/dist/schema/select.js +6 -3
  132. package/dist/schema/serialize.d.ts +15 -6
  133. package/dist/schema/serialize.js +20 -3
  134. package/dist/schema/sugar.d.ts +6 -7
  135. package/dist/schema/sugar.js +9 -12
  136. package/dist/schema/syncDeltaRow.d.ts +4 -152
  137. package/dist/schema/syncDeltaRow.js +4 -105
  138. package/dist/server/adapter.d.ts +18 -1
  139. package/dist/server/commit.d.ts +10 -16
  140. package/dist/server/index.d.ts +1 -1
  141. package/dist/server/index.js +1 -1
  142. package/dist/server/readConfig.d.ts +1 -1
  143. package/dist/source/adapter.d.ts +7 -5
  144. package/dist/source/adapter.js +7 -5
  145. package/dist/source/adapters/drizzle.d.ts +1 -1
  146. package/dist/source/adapters/drizzle.js +2 -2
  147. package/dist/source/adapters/kysely.d.ts +1 -1
  148. package/dist/source/adapters/kysely.js +1 -1
  149. package/dist/source/adapters/kyselyMutationCore.d.ts +1 -1
  150. package/dist/source/adapters/kyselyMutationCore.js +2 -2
  151. package/dist/source/adapters/memory.js +1 -1
  152. package/dist/source/adapters/prisma.d.ts +8 -3
  153. package/dist/source/adapters/prisma.js +1 -1
  154. package/dist/source/connector.js +1 -1
  155. package/dist/source/connectorProtocol.d.ts +2 -8
  156. package/dist/source/connectorProtocol.js +3 -2
  157. package/dist/source/contract.d.ts +29 -17
  158. package/dist/source/contract.js +27 -22
  159. package/dist/source/factory.d.ts +1 -1
  160. package/dist/source/idempotency.js +2 -2
  161. package/dist/source/index.d.ts +1 -0
  162. package/dist/source/index.js +3 -0
  163. package/dist/source/next.d.ts +1 -1
  164. package/dist/source/signing.d.ts +9 -2
  165. package/dist/source/signing.js +4 -1
  166. package/dist/source/types.d.ts +6 -4
  167. package/dist/source/types.js +1 -1
  168. package/dist/{core/storeContract.d.ts → storeContract.d.ts} +6 -6
  169. package/dist/{core → stores}/DatabaseManager.d.ts +3 -1
  170. package/dist/{core → stores}/DatabaseManager.js +14 -13
  171. package/dist/stores/ObjectStore.d.ts +1 -1
  172. package/dist/{core → stores}/StoreManager.d.ts +9 -26
  173. package/dist/{core → stores}/StoreManager.js +29 -77
  174. package/dist/stores/SyncActionStore.d.ts +4 -2
  175. package/dist/stores/SyncActionStore.js +11 -17
  176. package/dist/stores/syncAction.d.ts +26 -0
  177. package/dist/stores/syncAction.js +16 -0
  178. package/dist/surface.d.ts +3 -3
  179. package/dist/surface.js +6 -4
  180. package/dist/sync/BootstrapFetcher.d.ts +127 -6
  181. package/dist/sync/BootstrapFetcher.js +511 -83
  182. package/dist/sync/ConnectionManager.d.ts +6 -198
  183. package/dist/sync/ConnectionManager.js +6 -677
  184. package/dist/sync/OnDemandLoader.d.ts +5 -2
  185. package/dist/sync/OnDemandLoader.js +61 -21
  186. package/dist/sync/SubscriptionManager.d.ts +13 -2
  187. package/dist/sync/SubscriptionManager.js +23 -5
  188. package/dist/sync/SyncWebSocket.d.ts +27 -510
  189. package/dist/sync/SyncWebSocket.js +76 -954
  190. package/dist/sync/awaitClaimGrant.d.ts +4 -44
  191. package/dist/sync/awaitClaimGrant.js +4 -109
  192. package/dist/sync/bootstrapApply.d.ts +3 -0
  193. package/dist/sync/bootstrapApply.js +2 -2
  194. package/dist/sync/commitFrames.d.ts +6 -40
  195. package/dist/sync/commitFrames.js +6 -97
  196. package/dist/sync/contextPorts.d.ts +18 -0
  197. package/dist/sync/contextPorts.js +31 -0
  198. package/dist/sync/createClaimStream.d.ts +5 -49
  199. package/dist/sync/createClaimStream.js +5 -469
  200. package/dist/sync/createPresenceStream.d.ts +26 -4
  201. package/dist/sync/createPresenceStream.js +28 -20
  202. package/dist/sync/createSnapshot.d.ts +2 -2
  203. package/dist/sync/createSnapshot.js +1 -1
  204. package/dist/sync/credentialLifecycle.d.ts +5 -173
  205. package/dist/sync/credentialLifecycle.js +5 -320
  206. package/dist/sync/deltaPipeline.d.ts +13 -12
  207. package/dist/sync/deltaPipeline.js +21 -4
  208. package/dist/sync/groupChange.d.ts +3 -0
  209. package/dist/sync/groupChange.js +16 -14
  210. package/dist/sync/participants.d.ts +24 -6
  211. package/dist/sync/participants.js +32 -23
  212. package/dist/sync/schemaDrift.d.ts +55 -0
  213. package/dist/sync/schemaDrift.js +53 -0
  214. package/dist/sync/schemas.d.ts +23 -33
  215. package/dist/sync/schemas.js +29 -20
  216. package/dist/sync/syncPlan.d.ts +3 -3
  217. package/dist/sync/wsFrameHandlers.d.ts +6 -114
  218. package/dist/sync/wsFrameHandlers.js +6 -392
  219. package/dist/syncLog/contract.d.ts +20 -0
  220. package/dist/syncLog/contract.js +19 -0
  221. package/dist/syncLog/index.d.ts +1 -0
  222. package/dist/syncLog/index.js +1 -0
  223. package/dist/transaction/ablo.d.ts +88 -0
  224. package/dist/transaction/ablo.js +33 -0
  225. package/dist/{client/auth.d.ts → transaction/auth/apiKey.d.ts} +43 -8
  226. package/dist/{client/auth.js → transaction/auth/apiKey.js} +19 -0
  227. package/dist/transaction/auth/bootstrapScope.d.ts +15 -0
  228. package/dist/transaction/auth/bootstrapScope.js +1 -0
  229. package/dist/transaction/auth/capability.d.ts +212 -0
  230. package/dist/transaction/auth/capability.js +224 -0
  231. package/dist/{auth → transaction/auth}/credentialSource.d.ts +8 -1
  232. package/dist/{client → transaction/auth}/identity.d.ts +8 -7
  233. package/dist/{client → transaction/auth}/identity.js +1 -1
  234. package/dist/transaction/auth/index.d.ts +162 -0
  235. package/dist/transaction/auth/index.js +304 -0
  236. package/dist/{auth → transaction/auth}/schemas.d.ts +1 -1
  237. package/dist/{auth → transaction/auth}/schemas.js +13 -13
  238. package/dist/{client → transaction/auth}/sessionMint.d.ts +8 -8
  239. package/dist/{client → transaction/auth}/sessionMint.js +4 -7
  240. package/dist/transaction/coordination/awaitClaimGrant.d.ts +56 -0
  241. package/dist/transaction/coordination/awaitClaimGrant.js +124 -0
  242. package/dist/{client → transaction/coordination}/claimHeartbeatLoop.d.ts +34 -0
  243. package/dist/{client → transaction/coordination}/claimHeartbeatLoop.js +20 -0
  244. package/dist/transaction/coordination/claimMeta.d.ts +49 -0
  245. package/dist/transaction/coordination/claimMeta.js +52 -0
  246. package/dist/transaction/coordination/createClaimStream.d.ts +64 -0
  247. package/dist/transaction/coordination/createClaimStream.js +475 -0
  248. package/dist/transaction/coordination/events.d.ts +74 -0
  249. package/dist/transaction/coordination/events.js +7 -0
  250. package/dist/transaction/coordination/index.d.ts +19 -0
  251. package/dist/transaction/coordination/index.js +45 -0
  252. package/dist/transaction/coordination/locator.d.ts +104 -0
  253. package/dist/transaction/coordination/locator.js +102 -0
  254. package/dist/transaction/coordination/schema.d.ts +1536 -0
  255. package/dist/transaction/coordination/schema.js +1177 -0
  256. package/dist/transaction/coordination/targetConflict.d.ts +2 -0
  257. package/dist/transaction/coordination/targetConflict.js +107 -0
  258. package/dist/{coordination → transaction/coordination}/trace.d.ts +7 -18
  259. package/dist/{coordination → transaction/coordination}/trace.js +18 -25
  260. package/dist/transaction/durableWrites.d.ts +62 -0
  261. package/dist/{client → transaction}/durableWrites.js +28 -3
  262. package/dist/transaction/environment.d.ts +105 -0
  263. package/dist/transaction/environment.js +108 -0
  264. package/dist/{errorCodes.d.ts → transaction/errorCodes.d.ts} +12 -12
  265. package/dist/{errorCodes.js → transaction/errorCodes.js} +45 -18
  266. package/dist/{errors.d.ts → transaction/errors.d.ts} +37 -13
  267. package/dist/{errors.js → transaction/errors.js} +85 -16
  268. package/dist/transaction/footprint.d.ts +111 -0
  269. package/dist/transaction/footprint.js +0 -0
  270. package/dist/transaction/index.d.ts +20 -0
  271. package/dist/transaction/index.js +20 -0
  272. package/dist/transaction/keys/index.d.ts +87 -0
  273. package/dist/transaction/keys/index.js +207 -0
  274. package/dist/transaction/log/syncDeltaRow.d.ts +158 -0
  275. package/dist/transaction/log/syncDeltaRow.js +95 -0
  276. package/dist/{sync/syncPosition.d.ts → transaction/logPosition.d.ts} +22 -8
  277. package/dist/{sync/syncPosition.js → transaction/logPosition.js} +15 -6
  278. package/dist/transaction/logger.d.ts +16 -0
  279. package/dist/transaction/logger.js +7 -0
  280. package/dist/transaction/observability.d.ts +53 -0
  281. package/dist/transaction/observability.js +19 -0
  282. package/dist/transaction/plugin.d.ts +285 -0
  283. package/dist/transaction/plugin.js +106 -0
  284. package/dist/{policy → transaction/policy}/types.d.ts +3 -3
  285. package/dist/{policy → transaction/policy}/types.js +2 -0
  286. package/dist/transaction/resources/httpResources.d.ts +321 -0
  287. package/dist/transaction/resources/httpResources.js +7 -0
  288. package/dist/transaction/resources/modelOperations.d.ts +427 -0
  289. package/dist/transaction/resources/modelOperations.js +12 -0
  290. package/dist/transaction/resources/mutationOptions.d.ts +66 -0
  291. package/dist/transaction/resources/mutationOptions.js +9 -0
  292. package/dist/transaction/resources/where.d.ts +101 -0
  293. package/dist/transaction/resources/where.js +115 -0
  294. package/dist/{client → transaction/resources}/writeOptionsSchema.d.ts +2 -6
  295. package/dist/{client → transaction/resources}/writeOptionsSchema.js +9 -5
  296. package/dist/{schema → transaction/schema}/field.d.ts +17 -23
  297. package/dist/{schema → transaction/schema}/field.js +5 -5
  298. package/dist/transaction/schema/fieldRef.d.ts +38 -0
  299. package/dist/transaction/schema/fieldRef.js +11 -0
  300. package/dist/transaction/schema/loadStrategy.d.ts +45 -0
  301. package/dist/transaction/schema/loadStrategy.js +46 -0
  302. package/dist/{schema → transaction/schema}/model.d.ts +50 -35
  303. package/dist/{schema → transaction/schema}/model.js +30 -20
  304. package/dist/transaction/schema/openapi.d.ts +58 -0
  305. package/dist/transaction/schema/openapi.js +501 -0
  306. package/dist/{schema → transaction/schema}/relation.d.ts +21 -16
  307. package/dist/{schema → transaction/schema}/relation.js +7 -7
  308. package/dist/{schema → transaction/schema}/residency.d.ts +0 -9
  309. package/dist/{schema → transaction/schema}/residency.js +0 -5
  310. package/dist/{schema → transaction/schema}/roles.d.ts +5 -5
  311. package/dist/{schema → transaction/schema}/roles.js +5 -5
  312. package/dist/{schema → transaction/schema}/schema.d.ts +39 -10
  313. package/dist/{schema → transaction/schema}/schema.js +24 -3
  314. package/dist/{schema → transaction/schema}/tenancy.d.ts +1 -1
  315. package/dist/{schema → transaction/schema}/tenancy.js +7 -4
  316. package/dist/transaction/transactionLayer.d.ts +82 -0
  317. package/dist/transaction/transactionLayer.js +24 -0
  318. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.d.ts +5 -6
  319. package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.js +9 -13
  320. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.d.ts +9 -2
  321. package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.js +5 -9
  322. package/dist/{transactions/durableWriteStore.d.ts → transaction/transactions/settlement/pendingWrite.d.ts} +11 -37
  323. package/dist/transaction/transactions/settlement/pendingWrite.js +20 -0
  324. package/dist/transaction/transport/commitFrames.d.ts +90 -0
  325. package/dist/transaction/transport/commitFrames.js +134 -0
  326. package/dist/transaction/transport/connectionManager.d.ts +215 -0
  327. package/dist/transaction/transport/connectionManager.js +673 -0
  328. package/dist/transaction/transport/credentialLifecycle.d.ts +177 -0
  329. package/dist/transaction/transport/credentialLifecycle.js +324 -0
  330. package/dist/{sync → transaction/transport}/heartbeat.d.ts +3 -1
  331. package/dist/{sync → transaction/transport}/heartbeat.js +6 -4
  332. package/dist/transaction/transport/httpClient.d.ts +131 -0
  333. package/dist/{client → transaction/transport}/httpClient.js +6 -5
  334. package/dist/transaction/transport/httpOptions.d.ts +33 -0
  335. package/dist/transaction/transport/httpOptions.js +12 -0
  336. package/dist/{client → transaction/transport}/httpTransport.js +295 -97
  337. package/dist/{sync/NetworkProbe.d.ts → transaction/transport/networkProbe.d.ts} +7 -4
  338. package/dist/{sync/NetworkProbe.js → transaction/transport/networkProbe.js} +14 -13
  339. package/dist/transaction/transport/wsFrameHandlers.d.ts +128 -0
  340. package/dist/transaction/transport/wsFrameHandlers.js +429 -0
  341. package/dist/transaction/transport/wsTransport.d.ts +574 -0
  342. package/dist/transaction/transport/wsTransport.js +1023 -0
  343. package/dist/transaction/types/assertExact.d.ts +17 -0
  344. package/dist/transaction/types/assertExact.js +1 -0
  345. package/dist/{types → transaction/types}/global.d.ts +17 -2
  346. package/dist/{types → transaction/types}/global.js +2 -1
  347. package/dist/{types → transaction/types}/index.d.ts +14 -46
  348. package/dist/{types → transaction/types}/index.js +7 -16
  349. package/dist/{types → transaction/types}/streams.d.ts +73 -45
  350. package/dist/transaction/utils/duration.d.ts +50 -0
  351. package/dist/{utils → transaction/utils}/duration.js +32 -0
  352. package/dist/{utils → transaction/utils}/json.d.ts +18 -0
  353. package/dist/transaction/utils/json.js +276 -0
  354. package/dist/transaction/wire/accountResponses.d.ts +420 -0
  355. package/dist/transaction/wire/accountResponses.js +290 -0
  356. package/dist/transaction/wire/auth.d.ts +56 -0
  357. package/dist/transaction/wire/auth.js +63 -0
  358. package/dist/transaction/wire/claimEvent.d.ts +76 -0
  359. package/dist/transaction/wire/claimEvent.js +73 -0
  360. package/dist/transaction/wire/claims.d.ts +530 -0
  361. package/dist/transaction/wire/claims.js +327 -0
  362. package/dist/{wire → transaction/wire}/commit.d.ts +125 -193
  363. package/dist/{wire → transaction/wire}/commit.js +68 -47
  364. package/dist/{wire → transaction/wire}/delta.d.ts +66 -17
  365. package/dist/{wire → transaction/wire}/delta.js +37 -13
  366. package/dist/transaction/wire/errorEnvelope.d.ts +72 -0
  367. package/dist/{wire → transaction/wire}/errorEnvelope.js +36 -5
  368. package/dist/transaction/wire/feedCursor.d.ts +60 -0
  369. package/dist/transaction/wire/feedCursor.js +82 -0
  370. package/dist/transaction/wire/feedEvent.d.ts +204 -0
  371. package/dist/transaction/wire/feedEvent.js +65 -0
  372. package/dist/transaction/wire/frames.d.ts +194 -0
  373. package/dist/transaction/wire/frames.js +50 -0
  374. package/dist/transaction/wire/inboundFrames.d.ts +562 -0
  375. package/dist/transaction/wire/inboundFrames.js +116 -0
  376. package/dist/transaction/wire/index.d.ts +54 -0
  377. package/dist/transaction/wire/index.js +83 -0
  378. package/dist/{wire → transaction/wire}/listEnvelope.d.ts +13 -14
  379. package/dist/transaction/wire/listEnvelope.js +42 -0
  380. package/dist/transaction/wire/modelMutations.d.ts +31 -0
  381. package/dist/transaction/wire/modelMutations.js +52 -0
  382. package/dist/transaction/wire/modelResponses.d.ts +85 -0
  383. package/dist/transaction/wire/modelResponses.js +43 -0
  384. package/dist/transaction/wire/modelShape.d.ts +78 -0
  385. package/dist/transaction/wire/modelShape.js +74 -0
  386. package/dist/transactions/{TransactionQueue.d.ts → mutations/MutationQueue.d.ts} +85 -38
  387. package/dist/transactions/{TransactionQueue.js → mutations/MutationQueue.js} +141 -80
  388. package/dist/transactions/{TransactionStore.d.ts → mutations/MutationStore.d.ts} +8 -8
  389. package/dist/transactions/{TransactionStore.js → mutations/MutationStore.js} +2 -2
  390. package/dist/transactions/{coalesceRules.d.ts → mutations/coalesceRules.d.ts} +10 -10
  391. package/dist/transactions/{coalesceRules.js → mutations/coalesceRules.js} +1 -1
  392. package/dist/transactions/mutations/commitLatency.d.ts +52 -0
  393. package/dist/transactions/mutations/commitLatency.js +130 -0
  394. package/dist/transactions/{commitOutboxStore.d.ts → mutations/commitOutboxStore.d.ts} +1 -5
  395. package/dist/transactions/{commitOutboxStore.js → mutations/commitOutboxStore.js} +1 -1
  396. package/dist/transactions/{commitPayload.d.ts → mutations/commitPayload.d.ts} +18 -16
  397. package/dist/transactions/{commitPayload.js → mutations/commitPayload.js} +15 -15
  398. package/dist/transactions/{deltaConfirmation.d.ts → mutations/deltaConfirmation.d.ts} +15 -11
  399. package/dist/transactions/{deltaConfirmation.js → mutations/deltaConfirmation.js} +14 -12
  400. package/dist/transactions/mutations/durableWriteStore.d.ts +14 -0
  401. package/dist/transactions/mutations/durableWriteStore.js +12 -0
  402. package/dist/transactions/{optimisticApply.d.ts → mutations/optimisticApply.d.ts} +7 -7
  403. package/dist/transactions/{replayValidation.d.ts → mutations/replayValidation.d.ts} +4 -3
  404. package/dist/transactions/{replayValidation.js → mutations/replayValidation.js} +7 -5
  405. package/dist/utils/mobxSetup.d.ts +1 -1
  406. package/dist/utils/mobxSetup.js +5 -2
  407. package/dist/{core → views}/QueryView.d.ts +2 -2
  408. package/dist/{core → views}/QueryView.js +2 -2
  409. package/dist/{core → views}/ViewRegistry.d.ts +1 -1
  410. package/dist/{core/queryUtils.d.ts → views/incrementalView.d.ts} +6 -6
  411. package/dist/{core/queryUtils.js → views/incrementalView.js} +6 -6
  412. package/dist/webhooks/events.d.ts +2 -2
  413. package/dist/wire/index.d.ts +1 -34
  414. package/dist/wire/index.js +8 -49
  415. package/docs/agent-messaging.md +3 -3
  416. package/docs/agents.md +20 -13
  417. package/docs/api-keys.md +14 -10
  418. package/docs/api.md +27 -61
  419. package/docs/audit.md +6 -3
  420. package/docs/cli.md +41 -13
  421. package/docs/client-behavior.md +11 -9
  422. package/docs/concurrency-convention.md +49 -57
  423. package/docs/coordination.md +283 -121
  424. package/docs/data-sources.md +7 -5
  425. package/docs/debugging.md +39 -15
  426. package/docs/deployment.md +267 -0
  427. package/docs/examples/agent-human.md +49 -42
  428. package/docs/examples/ai-sdk-tool.md +69 -44
  429. package/docs/examples/existing-python-backend.md +8 -6
  430. package/docs/examples/nextjs.md +129 -47
  431. package/docs/examples/scoped-agent.md +46 -45
  432. package/docs/examples/server-agent.md +46 -26
  433. package/docs/groups.md +87 -30
  434. package/docs/guarantees.md +41 -12
  435. package/docs/how-it-works.md +38 -12
  436. package/docs/idempotency.md +126 -0
  437. package/docs/identity.md +77 -74
  438. package/docs/index.md +172 -86
  439. package/docs/integration-guide.md +31 -19
  440. package/docs/mcp.md +46 -21
  441. package/docs/migration.md +95 -18
  442. package/docs/operating-on-your-database.md +3 -1
  443. package/docs/projects.md +3 -1
  444. package/docs/quickstart.md +22 -5
  445. package/docs/react.md +31 -18
  446. package/docs/schema-contract.md +5 -3
  447. package/docs/session-settings.md +108 -0
  448. package/docs/sessions.md +4 -2
  449. package/docs/webhooks.md +12 -10
  450. package/llms.txt +48 -18
  451. package/package.json +21 -26
  452. package/dist/agent/Agent.d.ts +0 -366
  453. package/dist/agent/Agent.js +0 -514
  454. package/dist/agent/index.d.ts +0 -115
  455. package/dist/agent/index.js +0 -128
  456. package/dist/agent/session.d.ts +0 -93
  457. package/dist/agent/session.js +0 -149
  458. package/dist/agent/types.d.ts +0 -68
  459. package/dist/agent/types.js +0 -9
  460. package/dist/cli.cjs +0 -286329
  461. package/dist/client/durableWrites.d.ts +0 -21
  462. package/dist/client/httpClient.d.ts +0 -80
  463. package/dist/coordination/schema.d.ts +0 -722
  464. package/dist/coordination/schema.js +0 -578
  465. package/dist/schema/openapi.d.ts +0 -29
  466. package/dist/schema/openapi.js +0 -124
  467. package/dist/testing/fixtures/bootstrap.d.ts +0 -49
  468. package/dist/testing/fixtures/bootstrap.js +0 -59
  469. package/dist/testing/fixtures/deltas.d.ts +0 -83
  470. package/dist/testing/fixtures/deltas.js +0 -136
  471. package/dist/testing/fixtures/models.d.ts +0 -83
  472. package/dist/testing/fixtures/models.js +0 -272
  473. package/dist/testing/helpers/reactWrapper.d.ts +0 -69
  474. package/dist/testing/helpers/reactWrapper.js +0 -67
  475. package/dist/testing/helpers/syncEngineHarness.d.ts +0 -54
  476. package/dist/testing/helpers/syncEngineHarness.js +0 -73
  477. package/dist/testing/helpers/wait.d.ts +0 -30
  478. package/dist/testing/helpers/wait.js +0 -49
  479. package/dist/testing/index.d.ts +0 -23
  480. package/dist/testing/index.js +0 -33
  481. package/dist/testing/mocks/FakeDatabase.d.ts +0 -18
  482. package/dist/testing/mocks/FakeDatabase.js +0 -10
  483. package/dist/testing/mocks/MockMutationExecutor.d.ts +0 -87
  484. package/dist/testing/mocks/MockMutationExecutor.js +0 -192
  485. package/dist/testing/mocks/MockNetworkMonitor.d.ts +0 -20
  486. package/dist/testing/mocks/MockNetworkMonitor.js +0 -46
  487. package/dist/testing/mocks/MockSyncContext.d.ts +0 -51
  488. package/dist/testing/mocks/MockSyncContext.js +0 -71
  489. package/dist/testing/mocks/MockSyncStore.d.ts +0 -88
  490. package/dist/testing/mocks/MockSyncStore.js +0 -171
  491. package/dist/testing/mocks/MockWebSocket.d.ts +0 -71
  492. package/dist/testing/mocks/MockWebSocket.js +0 -118
  493. package/dist/transactions/durableWriteStore.js +0 -30
  494. package/dist/utils/duration.d.ts +0 -25
  495. package/dist/utils/json.js +0 -88
  496. package/dist/wire/errorEnvelope.d.ts +0 -55
  497. package/dist/wire/frames.d.ts +0 -197
  498. package/dist/wire/frames.js +0 -49
  499. package/dist/wire/listEnvelope.js +0 -18
  500. package/docs/interaction-model.md +0 -97
  501. /package/dist/{core → query}/QueryProcessor.d.ts +0 -0
  502. /package/dist/{core → query}/QueryProcessor.js +0 -0
  503. /package/dist/{core/storeContract.js → storeContract.js} +0 -0
  504. /package/dist/{core → stores}/openIDBWithTimeout.d.ts +0 -0
  505. /package/dist/{core → stores}/openIDBWithTimeout.js +0 -0
  506. /package/dist/{client → transaction/auth}/credentialEndpoint.d.ts +0 -0
  507. /package/dist/{client → transaction/auth}/credentialEndpoint.js +0 -0
  508. /package/dist/{auth → transaction/auth}/credentialPolicy.d.ts +0 -0
  509. /package/dist/{auth → transaction/auth}/credentialPolicy.js +0 -0
  510. /package/dist/{auth → transaction/auth}/credentialSource.js +0 -0
  511. /package/dist/{client → transaction/auth}/hostedEndpoints.d.ts +0 -0
  512. /package/dist/{client → transaction/auth}/hostedEndpoints.js +0 -0
  513. /package/dist/{client → transaction}/persistence.d.ts +0 -0
  514. /package/dist/{client → transaction}/persistence.js +0 -0
  515. /package/dist/{client → transaction/resources}/functionalUpdate.d.ts +0 -0
  516. /package/dist/{client → transaction/resources}/functionalUpdate.js +0 -0
  517. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.d.ts +0 -0
  518. /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.js +0 -0
  519. /package/dist/{client → transaction/transport}/httpTransport.d.ts +0 -0
  520. /package/dist/{types → transaction/types}/modelData.d.ts +0 -0
  521. /package/dist/{types → transaction/types}/modelData.js +0 -0
  522. /package/dist/{types → transaction/types}/participant.d.ts +0 -0
  523. /package/dist/{types → transaction/types}/participant.js +0 -0
  524. /package/dist/{types → transaction/types}/streams.js +0 -0
  525. /package/dist/{utils → transaction/utils}/asyncIterator.d.ts +0 -0
  526. /package/dist/{utils → transaction/utils}/asyncIterator.js +0 -0
  527. /package/dist/{wire → transaction/wire}/bootstrapReason.d.ts +0 -0
  528. /package/dist/{wire → transaction/wire}/bootstrapReason.js +0 -0
  529. /package/dist/{wire → transaction/wire}/protocol.d.ts +0 -0
  530. /package/dist/{wire → transaction/wire}/protocol.js +0 -0
  531. /package/dist/{wire → transaction/wire}/protocolVersion.d.ts +0 -0
  532. /package/dist/{wire → transaction/wire}/protocolVersion.js +0 -0
  533. /package/dist/transactions/{UnconfirmedWrites.d.ts → mutations/UnconfirmedWrites.d.ts} +0 -0
  534. /package/dist/transactions/{UnconfirmedWrites.js → mutations/UnconfirmedWrites.js} +0 -0
  535. /package/dist/transactions/{optimisticApply.js → mutations/optimisticApply.js} +0 -0
  536. /package/dist/{core → views}/ViewRegistry.js +0 -0
@@ -0,0 +1,276 @@
1
+ /**
2
+ * json.ts — key-order-insensitive comparison helpers for JSON-shaped values.
3
+ *
4
+ * Why this exists as a first-class, exported util:
5
+ *
6
+ * A `field.json()` value may be backed by a Postgres `jsonb` column, and **jsonb
7
+ * does not preserve object key order** (it reorders keys by length, then
8
+ * bytewise, and drops insignificant whitespace — see
9
+ * https://www.postgresql.org/docs/current/datatype-json.html). So a document an
10
+ * app wrote as `{type,text}` streams back in a delta as `{text,type}`: the same
11
+ * value, a different serialization.
12
+ *
13
+ * That bites any app that reconciles an Ablo row against an *external* state
14
+ * container it doesn't control — a rich-text editor (Tiptap/ProseMirror/Slate),
15
+ * a `useState`, a form buffer. The natural guard, `JSON.stringify(remote) ===
16
+ * JSON.stringify(local)`, is silently wrong because the two sides serialize keys
17
+ * in different orders, so it never matches — and the app re-applies the remote
18
+ * value on every render, clobbering in-flight edits and fighting the cursor.
19
+ *
20
+ * The fix is to compare order-insensitively. `deepEqual` does structural
21
+ * equality directly; `stableStringify` produces a canonical string (recursively
22
+ * sorted keys) for when you need a stable cache key / dependency value. The SDK
23
+ * already uses `deepEqual` internally for store-level echo detection; this
24
+ * module makes the same guarantee available to app authors so they don't each
25
+ * reinvent it.
26
+ *
27
+ * (If you need byte-exact key order preserved end-to-end, store the field in a
28
+ * `text` column instead of `jsonb` — Ablo's adaptive codec serializes verbatim
29
+ * there, matching Postgres's `json` type behavior.)
30
+ */
31
+ import { AbloValidationError } from '../errors.js';
32
+ /**
33
+ * Takes an immutable, plain snapshot at a JSON persistence/wire boundary.
34
+ *
35
+ * Traversal intentionally creates fresh objects and arrays instead of relying
36
+ * on a framework-specific unwrapping API. That makes Proxy-wrapped plain data
37
+ * (including MobX observables) safe for IndexedDB's structured-clone algorithm
38
+ * while keeping the settlement core independent of any reactive framework.
39
+ *
40
+ * The accepted contract is deliberately narrower than `JSON.stringify`:
41
+ * values that JSON would silently corrupt (`NaN` to `null`, `Map` to `{}`) or
42
+ * cannot encode are rejected with a stable, path-aware validation error.
43
+ * Valid dates retain normal JSON semantics and become ISO strings. Undefined
44
+ * object properties are omitted for compatibility with optional object keys;
45
+ * root/array `undefined` and sparse arrays are rejected rather than becoming
46
+ * an ambiguous `null`.
47
+ */
48
+ export function snapshotJsonValue(value, path = '$') {
49
+ try {
50
+ return snapshotJsonNode(value, path, new WeakMap());
51
+ }
52
+ catch (error) {
53
+ if (error instanceof AbloValidationError)
54
+ throw error;
55
+ throw invalidJsonValue(path, 'could not be read safely', value, error);
56
+ }
57
+ }
58
+ function snapshotJsonNode(value, path, active) {
59
+ if (value === null || typeof value === 'string' || typeof value === 'boolean') {
60
+ return value;
61
+ }
62
+ if (typeof value === 'number') {
63
+ if (!Number.isFinite(value)) {
64
+ throw invalidJsonValue(path, 'must be a finite number', value);
65
+ }
66
+ return Object.is(value, -0) ? 0 : value;
67
+ }
68
+ if (value === undefined) {
69
+ throw invalidJsonValue(path, 'cannot be undefined here', value);
70
+ }
71
+ if (typeof value === 'bigint') {
72
+ throw invalidJsonValue(path, 'cannot be a bigint', value);
73
+ }
74
+ if (typeof value === 'function') {
75
+ throw invalidJsonValue(path, 'cannot be a function', value);
76
+ }
77
+ if (typeof value === 'symbol') {
78
+ throw invalidJsonValue(path, 'cannot be a symbol', value);
79
+ }
80
+ if (value instanceof Date) {
81
+ const timestamp = value.getTime();
82
+ if (!Number.isFinite(timestamp)) {
83
+ throw invalidJsonValue(path, 'cannot be an invalid Date', value);
84
+ }
85
+ return value.toISOString();
86
+ }
87
+ if (Array.isArray(value)) {
88
+ const firstPath = active.get(value);
89
+ if (firstPath !== undefined) {
90
+ throw invalidJsonValue(path, `forms a cycle back to ${firstPath}`, value);
91
+ }
92
+ active.set(value, path);
93
+ try {
94
+ const output = [];
95
+ for (let index = 0; index < value.length; index += 1) {
96
+ const itemPath = `${path}[${index}]`;
97
+ if (!(index in value)) {
98
+ throw invalidJsonValue(itemPath, 'cannot be a sparse array hole', undefined);
99
+ }
100
+ output.push(snapshotJsonNode(value[index], itemPath, active));
101
+ }
102
+ return Object.freeze(output);
103
+ }
104
+ finally {
105
+ active.delete(value);
106
+ }
107
+ }
108
+ const object = value;
109
+ const firstPath = active.get(object);
110
+ if (firstPath !== undefined) {
111
+ throw invalidJsonValue(path, `forms a cycle back to ${firstPath}`, value);
112
+ }
113
+ let prototype;
114
+ try {
115
+ prototype = Object.getPrototypeOf(object);
116
+ }
117
+ catch (cause) {
118
+ throw invalidJsonValue(path, 'has an unreadable prototype', value, cause);
119
+ }
120
+ if (prototype !== null) {
121
+ const constructorDescriptor = Object.getOwnPropertyDescriptor(prototype, 'constructor');
122
+ const constructor = constructorDescriptor?.value;
123
+ if (typeof constructor !== 'function' || constructor.name !== 'Object') {
124
+ throw invalidJsonValue(path, 'must be a plain object', value);
125
+ }
126
+ }
127
+ active.set(object, path);
128
+ try {
129
+ let keys;
130
+ try {
131
+ keys = Reflect.ownKeys(object);
132
+ }
133
+ catch (cause) {
134
+ throw invalidJsonValue(path, 'has unreadable keys', value, cause);
135
+ }
136
+ for (const key of keys) {
137
+ if (typeof key !== 'symbol')
138
+ continue;
139
+ let enumerable = false;
140
+ try {
141
+ enumerable = Object.getOwnPropertyDescriptor(object, key)?.enumerable === true;
142
+ }
143
+ catch (cause) {
144
+ throw invalidJsonValue(path, 'has an unreadable symbol property', value, cause);
145
+ }
146
+ if (enumerable) {
147
+ throw invalidJsonValue(path, 'cannot contain enumerable symbol keys', value);
148
+ }
149
+ }
150
+ const output = {};
151
+ for (const key of keys) {
152
+ if (typeof key !== 'string')
153
+ continue;
154
+ let descriptor;
155
+ try {
156
+ descriptor = Object.getOwnPropertyDescriptor(object, key);
157
+ }
158
+ catch (cause) {
159
+ throw invalidJsonValue(jsonPath(path, key), 'has an unreadable property', value, cause);
160
+ }
161
+ if (!descriptor?.enumerable)
162
+ continue;
163
+ let child;
164
+ try {
165
+ child = Reflect.get(object, key);
166
+ }
167
+ catch (cause) {
168
+ throw invalidJsonValue(jsonPath(path, key), 'could not be read', value, cause);
169
+ }
170
+ // Matches JSON object semantics for optional fields without allowing
171
+ // undefined to become null inside arrays.
172
+ if (child === undefined)
173
+ continue;
174
+ Object.defineProperty(output, key, {
175
+ configurable: true,
176
+ enumerable: true,
177
+ value: snapshotJsonNode(child, jsonPath(path, key), active),
178
+ writable: true,
179
+ });
180
+ }
181
+ return Object.freeze(output);
182
+ }
183
+ finally {
184
+ active.delete(object);
185
+ }
186
+ }
187
+ function jsonPath(parent, key) {
188
+ return /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(key)
189
+ ? `${parent}.${key}`
190
+ : `${parent}[${JSON.stringify(key)}]`;
191
+ }
192
+ function invalidJsonValue(path, reason, value, cause) {
193
+ const valueType = jsonValueType(value);
194
+ return new AbloValidationError(`Write payload ${path} ${reason}.`, {
195
+ code: 'write_payload_invalid',
196
+ param: path,
197
+ details: { path, reason, valueType },
198
+ ...(cause !== undefined ? { cause } : {}),
199
+ });
200
+ }
201
+ function jsonValueType(value) {
202
+ if (value === null)
203
+ return 'null';
204
+ try {
205
+ if (Array.isArray(value))
206
+ return 'array';
207
+ if (value instanceof Date)
208
+ return 'Date';
209
+ if (typeof value === 'object') {
210
+ const name = Reflect.get(value, 'constructor')?.name;
211
+ return typeof name === 'string' ? name : 'object';
212
+ }
213
+ }
214
+ catch {
215
+ return typeof value;
216
+ }
217
+ return typeof value;
218
+ }
219
+ /** Structural equality for JSON-shaped values (scalars, arrays, plain objects); key order is ignored. */
220
+ export function deepEqual(a, b) {
221
+ if (a === b)
222
+ return true;
223
+ if (a === null || b === null || typeof a !== 'object' || typeof b !== 'object') {
224
+ return false;
225
+ }
226
+ const aArr = Array.isArray(a);
227
+ if (aArr !== Array.isArray(b))
228
+ return false;
229
+ if (aArr) {
230
+ const av = a;
231
+ const bv = b;
232
+ if (av.length !== bv.length)
233
+ return false;
234
+ for (let i = 0; i < av.length; i++) {
235
+ if (!deepEqual(av[i], bv[i]))
236
+ return false;
237
+ }
238
+ return true;
239
+ }
240
+ const ao = a;
241
+ const bo = b;
242
+ const ak = Object.keys(ao);
243
+ const bk = Object.keys(bo);
244
+ if (ak.length !== bk.length)
245
+ return false;
246
+ for (const k of ak) {
247
+ if (!Object.prototype.hasOwnProperty.call(bo, k))
248
+ return false;
249
+ if (!deepEqual(ao[k], bo[k]))
250
+ return false;
251
+ }
252
+ return true;
253
+ }
254
+ /**
255
+ * Canonical JSON serialization: recursively sorts object keys so two values that
256
+ * differ only in key order (e.g. a jsonb round-trip) produce the same string.
257
+ * Use this when you need a comparable/cacheable string rather than a boolean —
258
+ * e.g. an echo guard or a `useEffect`/`useMemo` dependency.
259
+ */
260
+ export function stableStringify(value) {
261
+ return JSON.stringify(sortKeysDeep(value));
262
+ }
263
+ function sortKeysDeep(value) {
264
+ if (Array.isArray(value))
265
+ return value.map(sortKeysDeep);
266
+ if (value && typeof value === 'object') {
267
+ const source = value;
268
+ return Object.keys(source)
269
+ .sort()
270
+ .reduce((acc, key) => {
271
+ acc[key] = sortKeysDeep(source[key]);
272
+ return acc;
273
+ }, {});
274
+ }
275
+ return value;
276
+ }
@@ -0,0 +1,420 @@
1
+ /**
2
+ * What the ACCOUNT routes answer with — the surface you reach through the
3
+ * `ablo` CLI rather than through a model: `GET /v1/projects`, `GET /api/schema`,
4
+ * `GET /v1/logs`, `GET /v1/usage`.
5
+ *
6
+ * These are the shapes the server, the CLI, and the MCP server all have to
7
+ * agree on. Before this module each of them spelled the shape out again — the
8
+ * server inline in `c.json({ … })`, the others in hand-written interfaces — so
9
+ * a renamed field broke a consumer at runtime with nothing failing in between.
10
+ *
11
+ * None of these endpoints appear in the published OpenAPI contract yet (they
12
+ * sit in the spec test's `NOT_YET_PUBLISHED` set). Deriving the spec from these
13
+ * schemas is what removes them from it.
14
+ */
15
+ import { z } from 'zod';
16
+ import type { SyncDeltaAction } from './delta.js';
17
+ /**
18
+ * One project — an app's own schema, data planes, and keys. `default` marks the
19
+ * organization's implicit project, whose id is the organization's own.
20
+ */
21
+ export declare const projectResponseSchema: z.ZodObject<{
22
+ object: z.ZodLiteral<"project">;
23
+ id: z.ZodString;
24
+ slug: z.ZodString;
25
+ name: z.ZodString;
26
+ default: z.ZodBoolean;
27
+ created_at: z.ZodString;
28
+ }, z.core.$strip>;
29
+ export type ProjectResponse = z.infer<typeof projectResponseSchema>;
30
+ /**
31
+ * `GET /v1/projects`.
32
+ *
33
+ * Note what this is NOT: the canonical {@link ListEnvelope}. An org's projects
34
+ * are returned whole, so the route emits `data` with no `has_more`/`next_cursor`
35
+ * beside it. That divergence is real and this schema states it rather than
36
+ * describing a pagination the endpoint does not implement — adding the two
37
+ * fields is an API change, not a documentation fix.
38
+ */
39
+ export declare const projectListResponseSchema: z.ZodObject<{
40
+ object: z.ZodLiteral<"list">;
41
+ data: z.ZodReadonly<z.ZodArray<z.ZodObject<{
42
+ object: z.ZodLiteral<"project">;
43
+ id: z.ZodString;
44
+ slug: z.ZodString;
45
+ name: z.ZodString;
46
+ default: z.ZodBoolean;
47
+ created_at: z.ZodString;
48
+ }, z.core.$strip>>>;
49
+ }, z.core.$strip>;
50
+ export type ProjectListResponse = z.infer<typeof projectListResponseSchema>;
51
+ /** One minted key, returned exactly once — the plaintext is never readable again. */
52
+ export declare const provisionedKeySchema: z.ZodObject<{
53
+ apiKey: z.ZodString;
54
+ expiresAt: z.ZodOptional<z.ZodString>;
55
+ }, z.core.$strip>;
56
+ export type ProvisionedKey = z.infer<typeof provisionedKeySchema>;
57
+ /**
58
+ * What the CLI device flow gets back once a browser approval is exchanged for
59
+ * credentials: the sandbox key `ablo push` authors with, and the restricted
60
+ * production key that only observes.
61
+ *
62
+ * `project` is the project both keys are scoped to, resolved SERVER-SIDE from
63
+ * the requested slug — null means the organization's default. The server's
64
+ * answer is authoritative because it is what resolved the slug to an id, so the
65
+ * CLI stores keys under the project named here rather than the one it asked
66
+ * for.
67
+ */
68
+ export declare const provisionKeyResponseSchema: z.ZodObject<{
69
+ test: z.ZodObject<{
70
+ apiKey: z.ZodString;
71
+ expiresAt: z.ZodOptional<z.ZodString>;
72
+ }, z.core.$strip>;
73
+ live: z.ZodOptional<z.ZodObject<{
74
+ apiKey: z.ZodString;
75
+ expiresAt: z.ZodOptional<z.ZodString>;
76
+ }, z.core.$strip>>;
77
+ organizationId: z.ZodOptional<z.ZodString>;
78
+ organizationSlug: z.ZodOptional<z.ZodString>;
79
+ project: z.ZodOptional<z.ZodNullable<z.ZodObject<{
80
+ id: z.ZodString;
81
+ slug: z.ZodString;
82
+ }, z.core.$strip>>>;
83
+ }, z.core.$strip>;
84
+ export type ProvisionKeyResponse = z.infer<typeof provisionKeyResponseSchema>;
85
+ /**
86
+ * A model's declared conflict disposition as it travels on the wire, keyed by
87
+ * committer kind.
88
+ *
89
+ * Spelled here rather than imported from the policy layer, which states the same
90
+ * three members as a TypeScript interface: `wire/` holds runtime-validatable
91
+ * schemas, and it is the protocol leaf — everything depends on it and it depends
92
+ * on nothing. The check that the two never drift therefore lives on the policy
93
+ * side of that edge, next to the interface, in `../policy/types.ts`.
94
+ */
95
+ export declare const conflictAxisWireSchema: z.ZodObject<{
96
+ user: z.ZodOptional<z.ZodEnum<{
97
+ reject: "reject";
98
+ overwrite: "overwrite";
99
+ notify: "notify";
100
+ }>>;
101
+ agent: z.ZodOptional<z.ZodEnum<{
102
+ reject: "reject";
103
+ overwrite: "overwrite";
104
+ notify: "notify";
105
+ }>>;
106
+ system: z.ZodOptional<z.ZodEnum<{
107
+ reject: "reject";
108
+ overwrite: "overwrite";
109
+ notify: "notify";
110
+ }>>;
111
+ }, z.core.$strip>;
112
+ /** One model in the deployed schema, as the schema read reports it. */
113
+ export declare const schemaModelResponseSchema: z.ZodObject<{
114
+ key: z.ZodString;
115
+ typename: z.ZodString;
116
+ conflict: z.ZodNullable<z.ZodObject<{
117
+ user: z.ZodOptional<z.ZodEnum<{
118
+ reject: "reject";
119
+ overwrite: "overwrite";
120
+ notify: "notify";
121
+ }>>;
122
+ agent: z.ZodOptional<z.ZodEnum<{
123
+ reject: "reject";
124
+ overwrite: "overwrite";
125
+ notify: "notify";
126
+ }>>;
127
+ system: z.ZodOptional<z.ZodEnum<{
128
+ reject: "reject";
129
+ overwrite: "overwrite";
130
+ notify: "notify";
131
+ }>>;
132
+ }, z.core.$strip>>;
133
+ hash: z.ZodString;
134
+ fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
135
+ type: z.ZodEnum<{
136
+ string: "string";
137
+ number: "number";
138
+ boolean: "boolean";
139
+ date: "date";
140
+ enum: "enum";
141
+ json: "json";
142
+ }>;
143
+ isOptional: z.ZodBoolean;
144
+ isIndexed: z.ZodBoolean;
145
+ column: z.ZodOptional<z.ZodString>;
146
+ enumValues: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
147
+ }, z.core.$strip>>>;
148
+ relations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
149
+ type: z.ZodEnum<{
150
+ belongsTo: "belongsTo";
151
+ hasMany: "hasMany";
152
+ hasOne: "hasOne";
153
+ }>;
154
+ target: z.ZodString;
155
+ foreignKey: z.ZodString;
156
+ }, z.core.$strip>>>;
157
+ }, z.core.$strip>;
158
+ export type SchemaModelResponse = z.infer<typeof schemaModelResponseSchema>;
159
+ /**
160
+ * `GET /api/schema` — the schema active on the caller's plane.
161
+ *
162
+ * A discriminated union because the two answers carry different fields, and the
163
+ * difference is the one a caller must act on: `active: false` means nothing has
164
+ * been pushed to this plane, so `models` is empty and `ablo push` is the fix.
165
+ * Reporting that as an inactive artifact with absent metadata, rather than as
166
+ * optional fields on one shape, is what stops a consumer from reading a missing
167
+ * `version` as a version of zero.
168
+ */
169
+ export declare const schemaReadResponseSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
170
+ active: z.ZodLiteral<false>;
171
+ environment: z.ZodString;
172
+ project: z.ZodNullable<z.ZodString>;
173
+ models: z.ZodReadonly<z.ZodArray<z.ZodObject<{
174
+ key: z.ZodString;
175
+ typename: z.ZodString;
176
+ conflict: z.ZodNullable<z.ZodObject<{
177
+ user: z.ZodOptional<z.ZodEnum<{
178
+ reject: "reject";
179
+ overwrite: "overwrite";
180
+ notify: "notify";
181
+ }>>;
182
+ agent: z.ZodOptional<z.ZodEnum<{
183
+ reject: "reject";
184
+ overwrite: "overwrite";
185
+ notify: "notify";
186
+ }>>;
187
+ system: z.ZodOptional<z.ZodEnum<{
188
+ reject: "reject";
189
+ overwrite: "overwrite";
190
+ notify: "notify";
191
+ }>>;
192
+ }, z.core.$strip>>;
193
+ hash: z.ZodString;
194
+ fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
195
+ type: z.ZodEnum<{
196
+ string: "string";
197
+ number: "number";
198
+ boolean: "boolean";
199
+ date: "date";
200
+ enum: "enum";
201
+ json: "json";
202
+ }>;
203
+ isOptional: z.ZodBoolean;
204
+ isIndexed: z.ZodBoolean;
205
+ column: z.ZodOptional<z.ZodString>;
206
+ enumValues: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
207
+ }, z.core.$strip>>>;
208
+ relations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
209
+ type: z.ZodEnum<{
210
+ belongsTo: "belongsTo";
211
+ hasMany: "hasMany";
212
+ hasOne: "hasOne";
213
+ }>;
214
+ target: z.ZodString;
215
+ foreignKey: z.ZodString;
216
+ }, z.core.$strip>>>;
217
+ }, z.core.$strip>>>;
218
+ }, z.core.$strip>, z.ZodObject<{
219
+ active: z.ZodLiteral<true>;
220
+ environment: z.ZodString;
221
+ project: z.ZodNullable<z.ZodString>;
222
+ models: z.ZodReadonly<z.ZodArray<z.ZodObject<{
223
+ key: z.ZodString;
224
+ typename: z.ZodString;
225
+ conflict: z.ZodNullable<z.ZodObject<{
226
+ user: z.ZodOptional<z.ZodEnum<{
227
+ reject: "reject";
228
+ overwrite: "overwrite";
229
+ notify: "notify";
230
+ }>>;
231
+ agent: z.ZodOptional<z.ZodEnum<{
232
+ reject: "reject";
233
+ overwrite: "overwrite";
234
+ notify: "notify";
235
+ }>>;
236
+ system: z.ZodOptional<z.ZodEnum<{
237
+ reject: "reject";
238
+ overwrite: "overwrite";
239
+ notify: "notify";
240
+ }>>;
241
+ }, z.core.$strip>>;
242
+ hash: z.ZodString;
243
+ fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
244
+ type: z.ZodEnum<{
245
+ string: "string";
246
+ number: "number";
247
+ boolean: "boolean";
248
+ date: "date";
249
+ enum: "enum";
250
+ json: "json";
251
+ }>;
252
+ isOptional: z.ZodBoolean;
253
+ isIndexed: z.ZodBoolean;
254
+ column: z.ZodOptional<z.ZodString>;
255
+ enumValues: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
256
+ }, z.core.$strip>>>;
257
+ relations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
258
+ type: z.ZodEnum<{
259
+ belongsTo: "belongsTo";
260
+ hasMany: "hasMany";
261
+ hasOne: "hasOne";
262
+ }>;
263
+ target: z.ZodString;
264
+ foreignKey: z.ZodString;
265
+ }, z.core.$strip>>>;
266
+ }, z.core.$strip>>>;
267
+ schemaId: z.ZodString;
268
+ version: z.ZodNumber;
269
+ hash: z.ZodString;
270
+ pushedAt: z.ZodNullable<z.ZodString>;
271
+ }, z.core.$strip>], "active">;
272
+ export type SchemaReadResponse = z.infer<typeof schemaReadResponseSchema>;
273
+ /**
274
+ * What a log reader calls each kind of entry.
275
+ *
276
+ * The log carries the full delta vocabulary, not just writes, so this has a
277
+ * word for every one of them — a reader should never be shown the stored
278
+ * letter. The eight are the plain-language face of {@link SyncDeltaAction}.
279
+ */
280
+ export declare const logOpSchema: z.ZodEnum<{
281
+ update: "update";
282
+ visible: "visible";
283
+ create: "create";
284
+ delete: "delete";
285
+ archive: "archive";
286
+ revive: "revive";
287
+ group_added: "group_added";
288
+ group_removed: "group_removed";
289
+ }>;
290
+ export type LogOp = z.infer<typeof logOpSchema>;
291
+ /**
292
+ * The stored action letter, as a log reader sees it.
293
+ *
294
+ * Typed against {@link SyncDeltaAction} so it is total by construction: adding
295
+ * a ninth action to the vocabulary stops this compiling until it has a word.
296
+ * The alternative — a lookup with a fallback — is what let `A` reach callers
297
+ * as the bare letter "a".
298
+ */
299
+ export declare const LOG_OP_BY_ACTION: Readonly<Record<SyncDeltaAction, LogOp>>;
300
+ /** One entry in the log: what changed, and who changed it. */
301
+ export declare const logEventSchema: z.ZodObject<{
302
+ object: z.ZodLiteral<"log_event">;
303
+ id: z.ZodNumber;
304
+ at: z.ZodString;
305
+ model: z.ZodString;
306
+ op: z.ZodEnum<{
307
+ update: "update";
308
+ visible: "visible";
309
+ create: "create";
310
+ delete: "delete";
311
+ archive: "archive";
312
+ revive: "revive";
313
+ group_added: "group_added";
314
+ group_removed: "group_removed";
315
+ }>;
316
+ recordId: z.ZodString;
317
+ actor: z.ZodNullable<z.ZodString>;
318
+ }, z.core.$strip>;
319
+ export type LogEvent = z.infer<typeof logEventSchema>;
320
+ /**
321
+ * One day's usage. `results` is one row per `group_by` combination, carrying
322
+ * the requested dimensions plus `total` and `count`; with no `group_by` it is a
323
+ * single ungrouped row. The keys therefore depend on the request, which is why
324
+ * the row stays open rather than claiming a fixed shape.
325
+ *
326
+ * `total` arrives as a string — it is a bigint in the database, and JSON has no
327
+ * lossless number for it.
328
+ */
329
+ export declare const usageBucketSchema: z.ZodObject<{
330
+ starting_at: z.ZodString;
331
+ ending_at: z.ZodString;
332
+ results: z.ZodReadonly<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
333
+ }, z.core.$strip>;
334
+ export type UsageBucket = z.infer<typeof usageBucketSchema>;
335
+ /**
336
+ * One of the org's keys, as a management surface may show it.
337
+ *
338
+ * Everything here is safe to display: the prefix identifies a key without being
339
+ * one. There is deliberately no field for the key itself — plaintext exists only
340
+ * in the response to the mint that created it, and the store keeps a SHA-256
341
+ * hash, so no later read can return it.
342
+ */
343
+ export declare const controlKeySchema: z.ZodObject<{
344
+ id: z.ZodString;
345
+ keyPrefix: z.ZodString;
346
+ label: z.ZodNullable<z.ZodString>;
347
+ kind: z.ZodString;
348
+ scopes: z.ZodReadonly<z.ZodArray<z.ZodString>>;
349
+ createdAt: z.ZodString;
350
+ lastUsedAt: z.ZodNullable<z.ZodString>;
351
+ expiresAt: z.ZodNullable<z.ZodString>;
352
+ projectId: z.ZodNullable<z.ZodString>;
353
+ }, z.core.$strip>;
354
+ export type ControlKey = z.infer<typeof controlKeySchema>;
355
+ /**
356
+ * `GET /v1/dashboard/keys` — the org's live, hand-managed keys.
357
+ *
358
+ * Like the project list, this is not the canonical {@link ListEnvelope}: it
359
+ * answers with a bare `keys` array. Stated as it is rather than as the envelope
360
+ * it resembles.
361
+ */
362
+ export declare const controlKeyListResponseSchema: z.ZodObject<{
363
+ keys: z.ZodReadonly<z.ZodArray<z.ZodObject<{
364
+ id: z.ZodString;
365
+ keyPrefix: z.ZodString;
366
+ label: z.ZodNullable<z.ZodString>;
367
+ kind: z.ZodString;
368
+ scopes: z.ZodReadonly<z.ZodArray<z.ZodString>>;
369
+ createdAt: z.ZodString;
370
+ lastUsedAt: z.ZodNullable<z.ZodString>;
371
+ expiresAt: z.ZodNullable<z.ZodString>;
372
+ projectId: z.ZodNullable<z.ZodString>;
373
+ }, z.core.$strip>>>;
374
+ }, z.core.$strip>;
375
+ export type ControlKeyListResponse = z.infer<typeof controlKeyListResponseSchema>;
376
+ /**
377
+ * `POST /v1/dashboard/keys` — the mint.
378
+ *
379
+ * `plaintext` is the only place the secret ever appears. The store keeps a
380
+ * SHA-256 hash, so nothing can return it again: a consumer that reads the wrong
381
+ * field name here does not get an error, it gets `undefined`, and the key is
382
+ * gone. That is the whole reason this shape is defined once rather than
383
+ * described at each end.
384
+ */
385
+ export declare const keyMintedResponseSchema: z.ZodObject<{
386
+ id: z.ZodString;
387
+ label: z.ZodNullable<z.ZodString>;
388
+ keyPrefix: z.ZodString;
389
+ createdAt: z.ZodString;
390
+ createdBy: z.ZodNullable<z.ZodString>;
391
+ projectId: z.ZodNullable<z.ZodString>;
392
+ plaintext: z.ZodString;
393
+ }, z.core.$strip>;
394
+ export type KeyMintedResponse = z.infer<typeof keyMintedResponseSchema>;
395
+ /**
396
+ * `DELETE /v1/dashboard/keys/:id`. `activeSessionsClosed` reports how many live
397
+ * connections the revocation cut, so a caller can see it took effect on sessions
398
+ * already open rather than only on future ones. A second revoke of the same key
399
+ * is not an error — it answers `alreadyRevoked` and closes nothing.
400
+ */
401
+ export declare const keyRevokedResponseSchema: z.ZodObject<{
402
+ id: z.ZodString;
403
+ revoked: z.ZodLiteral<true>;
404
+ revokedAt: z.ZodOptional<z.ZodString>;
405
+ alreadyRevoked: z.ZodOptional<z.ZodBoolean>;
406
+ activeSessionsClosed: z.ZodOptional<z.ZodNumber>;
407
+ }, z.core.$strip>;
408
+ export type KeyRevokedResponse = z.infer<typeof keyRevokedResponseSchema>;
409
+ /** `GET /v1/usage` — daily buckets, shaped after a usage report. */
410
+ export declare const usageReportResponseSchema: z.ZodObject<{
411
+ object: z.ZodLiteral<"usage_report">;
412
+ buckets: z.ZodReadonly<z.ZodArray<z.ZodObject<{
413
+ starting_at: z.ZodString;
414
+ ending_at: z.ZodString;
415
+ results: z.ZodReadonly<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
416
+ }, z.core.$strip>>>;
417
+ has_more: z.ZodBoolean;
418
+ data_freshness_seconds: z.ZodNumber;
419
+ }, z.core.$strip>;
420
+ export type UsageReportResponse = z.infer<typeof usageReportResponseSchema>;