@abloatai/ablo 0.35.0 → 0.37.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 (622) hide show
  1. package/AGENTS.md +2 -2
  2. package/CHANGELOG.md +71 -1929
  3. package/NOTICE +2 -2
  4. package/README.md +23 -532
  5. package/assets/banner.png +0 -0
  6. package/dist/auth.d.ts +2 -0
  7. package/dist/auth.d.ts.map +1 -0
  8. package/dist/auth.js +2 -0
  9. package/dist/auth.js.map +1 -0
  10. package/dist/client.d.ts +3 -0
  11. package/dist/client.d.ts.map +1 -0
  12. package/dist/client.js +3 -0
  13. package/dist/client.js.map +1 -0
  14. package/dist/coordination.d.ts +2 -0
  15. package/dist/coordination.d.ts.map +1 -0
  16. package/dist/coordination.js +2 -0
  17. package/dist/coordination.js.map +1 -0
  18. package/dist/index.d.ts +3 -112
  19. package/dist/index.d.ts.map +1 -0
  20. package/dist/index.js +3 -161
  21. package/dist/index.js.map +1 -0
  22. package/dist/react.d.ts +4 -0
  23. package/dist/react.d.ts.map +1 -0
  24. package/dist/react.js +3 -0
  25. package/dist/react.js.map +1 -0
  26. package/dist/schema.d.ts +2 -0
  27. package/dist/schema.d.ts.map +1 -0
  28. package/dist/schema.js +2 -0
  29. package/dist/schema.js.map +1 -0
  30. package/dist/server.d.ts +2 -0
  31. package/dist/server.d.ts.map +1 -0
  32. package/dist/server.js +2 -0
  33. package/dist/server.js.map +1 -0
  34. package/dist/source-conformance.d.ts +2 -0
  35. package/dist/source-conformance.d.ts.map +1 -0
  36. package/dist/source-conformance.js +2 -0
  37. package/dist/source-conformance.js.map +1 -0
  38. package/dist/source-drizzle.d.ts +2 -0
  39. package/dist/source-drizzle.d.ts.map +1 -0
  40. package/dist/source-drizzle.js +2 -0
  41. package/dist/source-drizzle.js.map +1 -0
  42. package/dist/source-kysely.d.ts +2 -0
  43. package/dist/source-kysely.d.ts.map +1 -0
  44. package/dist/source-kysely.js +2 -0
  45. package/dist/source-kysely.js.map +1 -0
  46. package/dist/source-next.d.ts +2 -0
  47. package/dist/source-next.d.ts.map +1 -0
  48. package/dist/source-next.js +2 -0
  49. package/dist/source-next.js.map +1 -0
  50. package/dist/source.d.ts +2 -0
  51. package/dist/source.d.ts.map +1 -0
  52. package/dist/source.js +2 -0
  53. package/dist/source.js.map +1 -0
  54. package/dist/wire.d.ts +2 -0
  55. package/dist/wire.d.ts.map +1 -0
  56. package/dist/wire.js +2 -0
  57. package/dist/wire.js.map +1 -0
  58. package/docs/agents.md +2 -2
  59. package/docs/api-keys.md +13 -12
  60. package/docs/api.md +15 -53
  61. package/docs/audit.md +4 -3
  62. package/docs/cli.md +11 -11
  63. package/docs/client-behavior.md +9 -9
  64. package/docs/concurrency-convention.md +28 -42
  65. package/docs/coordination.md +228 -86
  66. package/docs/data-sources.md +5 -5
  67. package/docs/debugging.md +34 -12
  68. package/docs/deployment.md +8 -8
  69. package/docs/examples/agent-human.md +4 -4
  70. package/docs/examples/ai-sdk-tool.md +1 -1
  71. package/docs/examples/existing-python-backend.md +15 -4
  72. package/docs/examples/nextjs.md +27 -6
  73. package/docs/examples/scoped-agent.md +3 -3
  74. package/docs/examples/server-agent.md +2 -2
  75. package/docs/groups.md +57 -3
  76. package/docs/guarantees.md +37 -10
  77. package/docs/how-it-works.md +32 -8
  78. package/docs/idempotency.md +6 -6
  79. package/docs/identity.md +24 -24
  80. package/docs/index.md +8 -8
  81. package/docs/integration-guide.md +38 -16
  82. package/docs/internal/README.md +18 -0
  83. package/docs/internal/agent-fleet-coordination-design.md +171 -0
  84. package/docs/internal/agent-orchestration.md +58 -0
  85. package/docs/internal/commit-identifiers.md +91 -0
  86. package/docs/internal/concurrency-open-decisions.md +37 -0
  87. package/docs/internal/data-source-reverse-channel.md +150 -0
  88. package/docs/internal/per-field-conflict-detection.md +165 -0
  89. package/docs/internal/postgres-replication.md +64 -0
  90. package/docs/internal/serializable-schema.md +119 -0
  91. package/docs/internal/structure.md +32 -0
  92. package/docs/mcp.md +9 -9
  93. package/docs/migration.md +37 -18
  94. package/docs/projects.md +1 -1
  95. package/docs/quickstart.md +2 -2
  96. package/docs/react.md +24 -13
  97. package/docs/schema-contract.md +3 -3
  98. package/docs/sessions.md +91 -37
  99. package/docs/webhooks.md +9 -9
  100. package/examples/README.md +2 -2
  101. package/examples/data-source/README.md +1 -1
  102. package/examples/data-source/ablo-driver.ts +1 -1
  103. package/examples/data-source/customer-server.ts +1 -1
  104. package/examples/data-source/run.ts +1 -1
  105. package/examples/data-source/schema.ts +1 -1
  106. package/examples/quickstart.ts +2 -2
  107. package/llms.txt +12 -12
  108. package/package.json +64 -174
  109. package/dist/BaseSyncedStore.d.ts +0 -823
  110. package/dist/BaseSyncedStore.js +0 -1955
  111. package/dist/Database.d.ts +0 -335
  112. package/dist/Database.js +0 -1500
  113. package/dist/InstanceCache.d.ts +0 -233
  114. package/dist/InstanceCache.js +0 -1164
  115. package/dist/LazyReferenceCollection.d.ts +0 -177
  116. package/dist/LazyReferenceCollection.js +0 -461
  117. package/dist/Model.d.ts +0 -444
  118. package/dist/Model.js +0 -909
  119. package/dist/ModelRegistry.d.ts +0 -221
  120. package/dist/ModelRegistry.js +0 -537
  121. package/dist/NetworkMonitor.d.ts +0 -26
  122. package/dist/NetworkMonitor.js +0 -77
  123. package/dist/RuntimeContext.d.ts +0 -52
  124. package/dist/RuntimeContext.js +0 -80
  125. package/dist/SyncClient.d.ts +0 -551
  126. package/dist/SyncClient.js +0 -2199
  127. package/dist/adapters/alwaysOnline.d.ts +0 -14
  128. package/dist/adapters/alwaysOnline.js +0 -17
  129. package/dist/adapters/inMemoryStorage.d.ts +0 -31
  130. package/dist/adapters/inMemoryStorage.js +0 -110
  131. package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
  132. package/dist/ai-sdk/coordinatedTool.js +0 -134
  133. package/dist/ai-sdk/coordinationContext.d.ts +0 -46
  134. package/dist/ai-sdk/coordinationContext.js +0 -106
  135. package/dist/ai-sdk/index.d.ts +0 -121
  136. package/dist/ai-sdk/index.js +0 -121
  137. package/dist/ai-sdk/wrap.d.ts +0 -65
  138. package/dist/ai-sdk/wrap.js +0 -39
  139. package/dist/auth/index.d.ts +0 -1
  140. package/dist/auth/index.js +0 -8
  141. package/dist/batching/index.d.ts +0 -55
  142. package/dist/batching/index.js +0 -147
  143. package/dist/cli.cjs +0 -288600
  144. package/dist/client/Ablo.d.ts +0 -231
  145. package/dist/client/Ablo.js +0 -149
  146. package/dist/client/abloClient.d.ts +0 -309
  147. package/dist/client/abloClient.js +0 -13
  148. package/dist/client/clientPrelude.d.ts +0 -52
  149. package/dist/client/clientPrelude.js +0 -60
  150. package/dist/client/consoleLogger.d.ts +0 -35
  151. package/dist/client/consoleLogger.js +0 -44
  152. package/dist/client/coreClient.d.ts +0 -60
  153. package/dist/client/coreClient.js +0 -118
  154. package/dist/client/createInternalComponents.d.ts +0 -46
  155. package/dist/client/createInternalComponents.js +0 -92
  156. package/dist/client/createModelProxy.d.ts +0 -228
  157. package/dist/client/createModelProxy.js +0 -818
  158. package/dist/client/humans.d.ts +0 -48
  159. package/dist/client/humans.js +0 -52
  160. package/dist/client/modelRegistration.d.ts +0 -10
  161. package/dist/client/modelRegistration.js +0 -312
  162. package/dist/client/options.d.ts +0 -461
  163. package/dist/client/options.js +0 -7
  164. package/dist/client/reactiveEngine.d.ts +0 -48
  165. package/dist/client/reactiveEngine.js +0 -910
  166. package/dist/client/resourceTypes.d.ts +0 -12
  167. package/dist/client/resourceTypes.js +0 -10
  168. package/dist/client/schemaConfig.d.ts +0 -44
  169. package/dist/client/schemaConfig.js +0 -185
  170. package/dist/client/validateAbloOptions.d.ts +0 -42
  171. package/dist/client/validateAbloOptions.js +0 -43
  172. package/dist/client/wsMutationExecutor.d.ts +0 -27
  173. package/dist/client/wsMutationExecutor.js +0 -72
  174. package/dist/context.d.ts +0 -29
  175. package/dist/context.js +0 -58
  176. package/dist/coordination/ClaimLog.d.ts +0 -26
  177. package/dist/coordination/ClaimLog.js +0 -32
  178. package/dist/coordination/index.d.ts +0 -1
  179. package/dist/coordination/index.js +0 -8
  180. package/dist/core/DatabaseManager.d.ts +0 -105
  181. package/dist/core/DatabaseManager.js +0 -387
  182. package/dist/core/QueryProcessor.d.ts +0 -75
  183. package/dist/core/QueryProcessor.js +0 -255
  184. package/dist/core/QueryView.d.ts +0 -79
  185. package/dist/core/QueryView.js +0 -218
  186. package/dist/core/StoreManager.d.ts +0 -112
  187. package/dist/core/StoreManager.js +0 -302
  188. package/dist/core/ViewRegistry.d.ts +0 -20
  189. package/dist/core/ViewRegistry.js +0 -55
  190. package/dist/core/index.d.ts +0 -33
  191. package/dist/core/index.js +0 -48
  192. package/dist/core/openIDBWithTimeout.d.ts +0 -65
  193. package/dist/core/openIDBWithTimeout.js +0 -153
  194. package/dist/core/queryUtils.d.ts +0 -45
  195. package/dist/core/queryUtils.js +0 -69
  196. package/dist/core/storeContract.d.ts +0 -145
  197. package/dist/core/storeContract.js +0 -12
  198. package/dist/docs/catalog.d.ts +0 -72
  199. package/dist/docs/catalog.js +0 -227
  200. package/dist/docs/index.d.ts +0 -10
  201. package/dist/docs/index.js +0 -10
  202. package/dist/environment.d.ts +0 -1
  203. package/dist/environment.js +0 -8
  204. package/dist/interfaces/index.d.ts +0 -311
  205. package/dist/interfaces/index.js +0 -9
  206. package/dist/keys/index.d.ts +0 -1
  207. package/dist/keys/index.js +0 -8
  208. package/dist/mutators/RecordingMutation.d.ts +0 -36
  209. package/dist/mutators/RecordingMutation.js +0 -182
  210. package/dist/mutators/Transaction.d.ts +0 -40
  211. package/dist/mutators/Transaction.js +0 -58
  212. package/dist/mutators/UndoManager.d.ts +0 -258
  213. package/dist/mutators/UndoManager.js +0 -658
  214. package/dist/mutators/defineMutators.d.ts +0 -60
  215. package/dist/mutators/defineMutators.js +0 -18
  216. package/dist/mutators/inverseOp.d.ts +0 -126
  217. package/dist/mutators/inverseOp.js +0 -71
  218. package/dist/mutators/mutateActions.d.ts +0 -45
  219. package/dist/mutators/mutateActions.js +0 -105
  220. package/dist/mutators/readerActions.d.ts +0 -33
  221. package/dist/mutators/readerActions.js +0 -57
  222. package/dist/mutators/undoApply.d.ts +0 -51
  223. package/dist/mutators/undoApply.js +0 -117
  224. package/dist/policy/index.d.ts +0 -21
  225. package/dist/policy/index.js +0 -20
  226. package/dist/query/client.d.ts +0 -61
  227. package/dist/query/client.js +0 -137
  228. package/dist/query/types.d.ts +0 -85
  229. package/dist/query/types.js +0 -16
  230. package/dist/react/AbloProvider.d.ts +0 -230
  231. package/dist/react/AbloProvider.js +0 -455
  232. package/dist/react/ClientSideSuspense.d.ts +0 -36
  233. package/dist/react/ClientSideSuspense.js +0 -17
  234. package/dist/react/DefaultFallback.d.ts +0 -24
  235. package/dist/react/DefaultFallback.js +0 -43
  236. package/dist/react/context.d.ts +0 -55
  237. package/dist/react/context.js +0 -29
  238. package/dist/react/index.d.ts +0 -61
  239. package/dist/react/index.js +0 -66
  240. package/dist/react/internalContext.d.ts +0 -33
  241. package/dist/react/internalContext.js +0 -3
  242. package/dist/react/useAblo.d.ts +0 -75
  243. package/dist/react/useAblo.js +0 -102
  244. package/dist/react/useCurrentUserId.d.ts +0 -22
  245. package/dist/react/useCurrentUserId.js +0 -34
  246. package/dist/react/useErrorListener.d.ts +0 -20
  247. package/dist/react/useErrorListener.js +0 -38
  248. package/dist/react/useMutationFailureListener.d.ts +0 -26
  249. package/dist/react/useMutationFailureListener.js +0 -38
  250. package/dist/react/useMutators.d.ts +0 -56
  251. package/dist/react/useMutators.js +0 -84
  252. package/dist/react/useReactive.d.ts +0 -35
  253. package/dist/react/useReactive.js +0 -123
  254. package/dist/react/useSyncStatus.d.ts +0 -59
  255. package/dist/react/useSyncStatus.js +0 -76
  256. package/dist/react/useUndoScope.d.ts +0 -34
  257. package/dist/react/useUndoScope.js +0 -81
  258. package/dist/schema/coordination.d.ts +0 -112
  259. package/dist/schema/coordination.js +0 -129
  260. package/dist/schema/ddl.d.ts +0 -97
  261. package/dist/schema/ddl.js +0 -491
  262. package/dist/schema/ddlLock.d.ts +0 -35
  263. package/dist/schema/ddlLock.js +0 -46
  264. package/dist/schema/diff.d.ts +0 -225
  265. package/dist/schema/diff.js +0 -289
  266. package/dist/schema/generate.d.ts +0 -19
  267. package/dist/schema/generate.js +0 -86
  268. package/dist/schema/index.d.ts +0 -41
  269. package/dist/schema/index.js +0 -76
  270. package/dist/schema/queries.d.ts +0 -201
  271. package/dist/schema/queries.js +0 -144
  272. package/dist/schema/select.d.ts +0 -40
  273. package/dist/schema/select.js +0 -87
  274. package/dist/schema/serialize.d.ts +0 -115
  275. package/dist/schema/serialize.js +0 -262
  276. package/dist/schema/sugar.d.ts +0 -109
  277. package/dist/schema/sugar.js +0 -83
  278. package/dist/schema/syncDeltaRow.d.ts +0 -6
  279. package/dist/schema/syncDeltaRow.js +0 -6
  280. package/dist/server/adapter.d.ts +0 -173
  281. package/dist/server/adapter.js +0 -18
  282. package/dist/server/commit.d.ts +0 -107
  283. package/dist/server/commit.js +0 -1
  284. package/dist/server/index.d.ts +0 -14
  285. package/dist/server/index.js +0 -2
  286. package/dist/server/readConfig.d.ts +0 -80
  287. package/dist/server/readConfig.js +0 -8
  288. package/dist/server/storageMode.d.ts +0 -23
  289. package/dist/server/storageMode.js +0 -17
  290. package/dist/source/adapter.d.ts +0 -81
  291. package/dist/source/adapter.js +0 -22
  292. package/dist/source/adapters/drizzle.d.ts +0 -48
  293. package/dist/source/adapters/drizzle.js +0 -219
  294. package/dist/source/adapters/kysely.d.ts +0 -42
  295. package/dist/source/adapters/kysely.js +0 -205
  296. package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
  297. package/dist/source/adapters/kyselyMutationCore.js +0 -125
  298. package/dist/source/adapters/memory.d.ts +0 -13
  299. package/dist/source/adapters/memory.js +0 -130
  300. package/dist/source/adapters/prisma.d.ts +0 -63
  301. package/dist/source/adapters/prisma.js +0 -202
  302. package/dist/source/conformance.d.ts +0 -37
  303. package/dist/source/conformance.js +0 -215
  304. package/dist/source/connector.d.ts +0 -95
  305. package/dist/source/connector.js +0 -266
  306. package/dist/source/connectorProtocol.d.ts +0 -154
  307. package/dist/source/connectorProtocol.js +0 -163
  308. package/dist/source/contract.d.ts +0 -195
  309. package/dist/source/contract.js +0 -164
  310. package/dist/source/factory.d.ts +0 -92
  311. package/dist/source/factory.js +0 -286
  312. package/dist/source/footprint.d.ts +0 -111
  313. package/dist/source/footprint.js +0 -0
  314. package/dist/source/idempotency.d.ts +0 -61
  315. package/dist/source/idempotency.js +0 -144
  316. package/dist/source/index.d.ts +0 -23
  317. package/dist/source/index.js +0 -30
  318. package/dist/source/migrations.d.ts +0 -21
  319. package/dist/source/migrations.js +0 -103
  320. package/dist/source/next.d.ts +0 -32
  321. package/dist/source/next.js +0 -25
  322. package/dist/source/pushQueue.d.ts +0 -134
  323. package/dist/source/pushQueue.js +0 -256
  324. package/dist/source/signing.d.ts +0 -92
  325. package/dist/source/signing.js +0 -162
  326. package/dist/source/types.d.ts +0 -401
  327. package/dist/source/types.js +0 -59
  328. package/dist/stores/ObjectStore.d.ts +0 -115
  329. package/dist/stores/ObjectStore.js +0 -393
  330. package/dist/stores/ObjectStoreContract.d.ts +0 -38
  331. package/dist/stores/ObjectStoreContract.js +0 -1
  332. package/dist/stores/SyncActionStore.d.ts +0 -97
  333. package/dist/stores/SyncActionStore.js +0 -504
  334. package/dist/stores/syncAction.d.ts +0 -26
  335. package/dist/stores/syncAction.js +0 -16
  336. package/dist/surface.d.ts +0 -36
  337. package/dist/surface.js +0 -75
  338. package/dist/sync/BootstrapFetcher.d.ts +0 -280
  339. package/dist/sync/BootstrapFetcher.js +0 -962
  340. package/dist/sync/ConnectionManager.d.ts +0 -8
  341. package/dist/sync/ConnectionManager.js +0 -8
  342. package/dist/sync/OnDemandLoader.d.ts +0 -228
  343. package/dist/sync/OnDemandLoader.js +0 -742
  344. package/dist/sync/SubscriptionManager.d.ts +0 -159
  345. package/dist/sync/SubscriptionManager.js +0 -243
  346. package/dist/sync/SyncWebSocket.d.ts +0 -173
  347. package/dist/sync/SyncWebSocket.js +0 -438
  348. package/dist/sync/awaitClaimGrant.d.ts +0 -6
  349. package/dist/sync/awaitClaimGrant.js +0 -6
  350. package/dist/sync/bootstrapApply.d.ts +0 -70
  351. package/dist/sync/bootstrapApply.js +0 -73
  352. package/dist/sync/commitFrames.d.ts +0 -8
  353. package/dist/sync/commitFrames.js +0 -8
  354. package/dist/sync/contextPorts.d.ts +0 -18
  355. package/dist/sync/contextPorts.js +0 -31
  356. package/dist/sync/createClaimStream.d.ts +0 -7
  357. package/dist/sync/createClaimStream.js +0 -7
  358. package/dist/sync/createPresenceStream.d.ts +0 -69
  359. package/dist/sync/createPresenceStream.js +0 -200
  360. package/dist/sync/createSnapshot.d.ts +0 -29
  361. package/dist/sync/createSnapshot.js +0 -118
  362. package/dist/sync/credentialLifecycle.d.ts +0 -7
  363. package/dist/sync/credentialLifecycle.js +0 -7
  364. package/dist/sync/deltaPipeline.d.ts +0 -113
  365. package/dist/sync/deltaPipeline.js +0 -261
  366. package/dist/sync/groupChange.d.ts +0 -113
  367. package/dist/sync/groupChange.js +0 -242
  368. package/dist/sync/participants.d.ts +0 -115
  369. package/dist/sync/participants.js +0 -344
  370. package/dist/sync/persistedPrefix.d.ts +0 -12
  371. package/dist/sync/persistedPrefix.js +0 -22
  372. package/dist/sync/schemaDrift.d.ts +0 -55
  373. package/dist/sync/schemaDrift.js +0 -53
  374. package/dist/sync/schemas.d.ts +0 -70
  375. package/dist/sync/schemas.js +0 -94
  376. package/dist/sync/syncCursor.d.ts +0 -40
  377. package/dist/sync/syncCursor.js +0 -55
  378. package/dist/sync/syncPlan.d.ts +0 -54
  379. package/dist/sync/syncPlan.js +0 -50
  380. package/dist/sync/wsFrameHandlers.d.ts +0 -8
  381. package/dist/sync/wsFrameHandlers.js +0 -8
  382. package/dist/testing/fixtures/bootstrap.d.ts +0 -49
  383. package/dist/testing/fixtures/bootstrap.js +0 -59
  384. package/dist/testing/fixtures/deltas.d.ts +0 -83
  385. package/dist/testing/fixtures/deltas.js +0 -136
  386. package/dist/testing/fixtures/httpResponses.d.ts +0 -70
  387. package/dist/testing/fixtures/httpResponses.js +0 -90
  388. package/dist/testing/fixtures/models.d.ts +0 -83
  389. package/dist/testing/fixtures/models.js +0 -272
  390. package/dist/testing/helpers/reactWrapper.d.ts +0 -69
  391. package/dist/testing/helpers/reactWrapper.js +0 -67
  392. package/dist/testing/helpers/syncEngineHarness.d.ts +0 -54
  393. package/dist/testing/helpers/syncEngineHarness.js +0 -73
  394. package/dist/testing/helpers/wait.d.ts +0 -30
  395. package/dist/testing/helpers/wait.js +0 -49
  396. package/dist/testing/index.d.ts +0 -23
  397. package/dist/testing/index.js +0 -33
  398. package/dist/testing/mocks/FakeDatabase.d.ts +0 -18
  399. package/dist/testing/mocks/FakeDatabase.js +0 -10
  400. package/dist/testing/mocks/MockMutationExecutor.d.ts +0 -87
  401. package/dist/testing/mocks/MockMutationExecutor.js +0 -186
  402. package/dist/testing/mocks/MockNetworkMonitor.d.ts +0 -20
  403. package/dist/testing/mocks/MockNetworkMonitor.js +0 -46
  404. package/dist/testing/mocks/MockSyncContext.d.ts +0 -51
  405. package/dist/testing/mocks/MockSyncContext.js +0 -72
  406. package/dist/testing/mocks/MockSyncStore.d.ts +0 -88
  407. package/dist/testing/mocks/MockSyncStore.js +0 -171
  408. package/dist/testing/mocks/MockWebSocket.d.ts +0 -71
  409. package/dist/testing/mocks/MockWebSocket.js +0 -118
  410. package/dist/transaction/ablo.d.ts +0 -88
  411. package/dist/transaction/ablo.js +0 -33
  412. package/dist/transaction/auth/apiKey.d.ts +0 -152
  413. package/dist/transaction/auth/apiKey.js +0 -419
  414. package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
  415. package/dist/transaction/auth/bootstrapScope.js +0 -1
  416. package/dist/transaction/auth/capability.d.ts +0 -177
  417. package/dist/transaction/auth/capability.js +0 -199
  418. package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
  419. package/dist/transaction/auth/credentialEndpoint.js +0 -86
  420. package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
  421. package/dist/transaction/auth/credentialPolicy.js +0 -125
  422. package/dist/transaction/auth/credentialSource.d.ts +0 -30
  423. package/dist/transaction/auth/credentialSource.js +0 -55
  424. package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
  425. package/dist/transaction/auth/hostedEndpoints.js +0 -21
  426. package/dist/transaction/auth/identity.d.ts +0 -55
  427. package/dist/transaction/auth/identity.js +0 -210
  428. package/dist/transaction/auth/index.d.ts +0 -162
  429. package/dist/transaction/auth/index.js +0 -304
  430. package/dist/transaction/auth/schemas.d.ts +0 -59
  431. package/dist/transaction/auth/schemas.js +0 -85
  432. package/dist/transaction/auth/sessionMint.d.ts +0 -28
  433. package/dist/transaction/auth/sessionMint.js +0 -85
  434. package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -49
  435. package/dist/transaction/coordination/awaitClaimGrant.js +0 -112
  436. package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -50
  437. package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -88
  438. package/dist/transaction/coordination/claimMeta.d.ts +0 -49
  439. package/dist/transaction/coordination/claimMeta.js +0 -52
  440. package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
  441. package/dist/transaction/coordination/createClaimStream.js +0 -475
  442. package/dist/transaction/coordination/events.d.ts +0 -74
  443. package/dist/transaction/coordination/events.js +0 -7
  444. package/dist/transaction/coordination/index.d.ts +0 -19
  445. package/dist/transaction/coordination/index.js +0 -44
  446. package/dist/transaction/coordination/locator.d.ts +0 -83
  447. package/dist/transaction/coordination/locator.js +0 -82
  448. package/dist/transaction/coordination/schema.d.ts +0 -1473
  449. package/dist/transaction/coordination/schema.js +0 -1013
  450. package/dist/transaction/coordination/targetConflict.d.ts +0 -2
  451. package/dist/transaction/coordination/targetConflict.js +0 -103
  452. package/dist/transaction/coordination/trace.d.ts +0 -78
  453. package/dist/transaction/coordination/trace.js +0 -138
  454. package/dist/transaction/durableWrites.d.ts +0 -62
  455. package/dist/transaction/durableWrites.js +0 -71
  456. package/dist/transaction/environment.d.ts +0 -105
  457. package/dist/transaction/environment.js +0 -108
  458. package/dist/transaction/errorCodes.d.ts +0 -403
  459. package/dist/transaction/errorCodes.js +0 -480
  460. package/dist/transaction/errors.d.ts +0 -428
  461. package/dist/transaction/errors.js +0 -686
  462. package/dist/transaction/index.d.ts +0 -20
  463. package/dist/transaction/index.js +0 -20
  464. package/dist/transaction/keys/index.d.ts +0 -87
  465. package/dist/transaction/keys/index.js +0 -207
  466. package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
  467. package/dist/transaction/log/syncDeltaRow.js +0 -95
  468. package/dist/transaction/logPosition.d.ts +0 -97
  469. package/dist/transaction/logPosition.js +0 -125
  470. package/dist/transaction/logger.d.ts +0 -16
  471. package/dist/transaction/logger.js +0 -7
  472. package/dist/transaction/observability.d.ts +0 -53
  473. package/dist/transaction/observability.js +0 -19
  474. package/dist/transaction/persistence.d.ts +0 -12
  475. package/dist/transaction/persistence.js +0 -11
  476. package/dist/transaction/plugin.d.ts +0 -192
  477. package/dist/transaction/plugin.js +0 -87
  478. package/dist/transaction/policy/types.d.ts +0 -217
  479. package/dist/transaction/policy/types.js +0 -126
  480. package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
  481. package/dist/transaction/resources/functionalUpdate.js +0 -87
  482. package/dist/transaction/resources/httpResources.d.ts +0 -266
  483. package/dist/transaction/resources/httpResources.js +0 -7
  484. package/dist/transaction/resources/modelOperations.d.ts +0 -319
  485. package/dist/transaction/resources/modelOperations.js +0 -12
  486. package/dist/transaction/resources/mutationOptions.d.ts +0 -66
  487. package/dist/transaction/resources/mutationOptions.js +0 -9
  488. package/dist/transaction/resources/where.d.ts +0 -85
  489. package/dist/transaction/resources/where.js +0 -70
  490. package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
  491. package/dist/transaction/resources/writeOptionsSchema.js +0 -73
  492. package/dist/transaction/schema/field.d.ts +0 -126
  493. package/dist/transaction/schema/field.js +0 -265
  494. package/dist/transaction/schema/loadStrategy.d.ts +0 -45
  495. package/dist/transaction/schema/loadStrategy.js +0 -46
  496. package/dist/transaction/schema/model.d.ts +0 -379
  497. package/dist/transaction/schema/model.js +0 -123
  498. package/dist/transaction/schema/openapi.d.ts +0 -57
  499. package/dist/transaction/schema/openapi.js +0 -340
  500. package/dist/transaction/schema/relation.d.ts +0 -199
  501. package/dist/transaction/schema/relation.js +0 -104
  502. package/dist/transaction/schema/residency.d.ts +0 -29
  503. package/dist/transaction/schema/residency.js +0 -25
  504. package/dist/transaction/schema/roles.d.ts +0 -249
  505. package/dist/transaction/schema/roles.js +0 -230
  506. package/dist/transaction/schema/schema.d.ts +0 -324
  507. package/dist/transaction/schema/schema.js +0 -305
  508. package/dist/transaction/schema/tenancy.d.ts +0 -139
  509. package/dist/transaction/schema/tenancy.js +0 -190
  510. package/dist/transaction/transactionLayer.d.ts +0 -82
  511. package/dist/transaction/transactionLayer.js +0 -24
  512. package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
  513. package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
  514. package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
  515. package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
  516. package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
  517. package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
  518. package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
  519. package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
  520. package/dist/transaction/transport/commitFrames.d.ts +0 -90
  521. package/dist/transaction/transport/commitFrames.js +0 -134
  522. package/dist/transaction/transport/connectionManager.d.ts +0 -215
  523. package/dist/transaction/transport/connectionManager.js +0 -673
  524. package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
  525. package/dist/transaction/transport/credentialLifecycle.js +0 -324
  526. package/dist/transaction/transport/heartbeat.d.ts +0 -65
  527. package/dist/transaction/transport/heartbeat.js +0 -93
  528. package/dist/transaction/transport/httpClient.d.ts +0 -123
  529. package/dist/transaction/transport/httpClient.js +0 -145
  530. package/dist/transaction/transport/httpOptions.d.ts +0 -33
  531. package/dist/transaction/transport/httpOptions.js +0 -12
  532. package/dist/transaction/transport/httpTransport.d.ts +0 -8
  533. package/dist/transaction/transport/httpTransport.js +0 -1276
  534. package/dist/transaction/transport/networkProbe.d.ts +0 -84
  535. package/dist/transaction/transport/networkProbe.js +0 -207
  536. package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
  537. package/dist/transaction/transport/wsFrameHandlers.js +0 -429
  538. package/dist/transaction/transport/wsTransport.d.ts +0 -576
  539. package/dist/transaction/transport/wsTransport.js +0 -1017
  540. package/dist/transaction/types/assertExact.d.ts +0 -17
  541. package/dist/transaction/types/assertExact.js +0 -1
  542. package/dist/transaction/types/global.d.ts +0 -107
  543. package/dist/transaction/types/global.js +0 -40
  544. package/dist/transaction/types/index.d.ts +0 -205
  545. package/dist/transaction/types/index.js +0 -56
  546. package/dist/transaction/types/modelData.d.ts +0 -10
  547. package/dist/transaction/types/modelData.js +0 -9
  548. package/dist/transaction/types/participant.d.ts +0 -20
  549. package/dist/transaction/types/participant.js +0 -10
  550. package/dist/transaction/types/streams.d.ts +0 -540
  551. package/dist/transaction/types/streams.js +0 -11
  552. package/dist/transaction/utils/asyncIterator.d.ts +0 -34
  553. package/dist/transaction/utils/asyncIterator.js +0 -135
  554. package/dist/transaction/utils/duration.d.ts +0 -25
  555. package/dist/transaction/utils/duration.js +0 -45
  556. package/dist/transaction/utils/json.d.ts +0 -57
  557. package/dist/transaction/utils/json.js +0 -276
  558. package/dist/transaction/wire/accountResponses.d.ts +0 -351
  559. package/dist/transaction/wire/accountResponses.js +0 -255
  560. package/dist/transaction/wire/auth.d.ts +0 -49
  561. package/dist/transaction/wire/auth.js +0 -57
  562. package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
  563. package/dist/transaction/wire/bootstrapReason.js +0 -8
  564. package/dist/transaction/wire/claimEvent.d.ts +0 -76
  565. package/dist/transaction/wire/claimEvent.js +0 -73
  566. package/dist/transaction/wire/claims.d.ts +0 -463
  567. package/dist/transaction/wire/claims.js +0 -229
  568. package/dist/transaction/wire/commit.d.ts +0 -603
  569. package/dist/transaction/wire/commit.js +0 -321
  570. package/dist/transaction/wire/delta.d.ts +0 -250
  571. package/dist/transaction/wire/delta.js +0 -147
  572. package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
  573. package/dist/transaction/wire/errorEnvelope.js +0 -123
  574. package/dist/transaction/wire/feedCursor.d.ts +0 -60
  575. package/dist/transaction/wire/feedCursor.js +0 -82
  576. package/dist/transaction/wire/feedEvent.d.ts +0 -177
  577. package/dist/transaction/wire/feedEvent.js +0 -39
  578. package/dist/transaction/wire/frames.d.ts +0 -194
  579. package/dist/transaction/wire/frames.js +0 -50
  580. package/dist/transaction/wire/inboundFrames.d.ts +0 -552
  581. package/dist/transaction/wire/inboundFrames.js +0 -116
  582. package/dist/transaction/wire/index.d.ts +0 -50
  583. package/dist/transaction/wire/index.js +0 -74
  584. package/dist/transaction/wire/listEnvelope.d.ts +0 -37
  585. package/dist/transaction/wire/listEnvelope.js +0 -42
  586. package/dist/transaction/wire/modelResponses.d.ts +0 -85
  587. package/dist/transaction/wire/modelResponses.js +0 -43
  588. package/dist/transaction/wire/protocol.d.ts +0 -38
  589. package/dist/transaction/wire/protocol.js +0 -38
  590. package/dist/transaction/wire/protocolVersion.d.ts +0 -73
  591. package/dist/transaction/wire/protocolVersion.js +0 -83
  592. package/dist/transactions/mutations/MutationQueue.d.ts +0 -655
  593. package/dist/transactions/mutations/MutationQueue.js +0 -2797
  594. package/dist/transactions/mutations/MutationStore.d.ts +0 -20
  595. package/dist/transactions/mutations/MutationStore.js +0 -53
  596. package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
  597. package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
  598. package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
  599. package/dist/transactions/mutations/coalesceRules.js +0 -140
  600. package/dist/transactions/mutations/commitLatency.d.ts +0 -52
  601. package/dist/transactions/mutations/commitLatency.js +0 -130
  602. package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
  603. package/dist/transactions/mutations/commitOutboxStore.js +0 -26
  604. package/dist/transactions/mutations/commitPayload.d.ts +0 -164
  605. package/dist/transactions/mutations/commitPayload.js +0 -152
  606. package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -59
  607. package/dist/transactions/mutations/deltaConfirmation.js +0 -233
  608. package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
  609. package/dist/transactions/mutations/durableWriteStore.js +0 -12
  610. package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
  611. package/dist/transactions/mutations/optimisticApply.js +0 -65
  612. package/dist/transactions/mutations/replayValidation.d.ts +0 -186
  613. package/dist/transactions/mutations/replayValidation.js +0 -163
  614. package/dist/utils/mobxSetup.d.ts +0 -53
  615. package/dist/utils/mobxSetup.js +0 -330
  616. package/dist/webhooks/events.d.ts +0 -43
  617. package/dist/webhooks/events.js +0 -42
  618. package/dist/webhooks/index.d.ts +0 -8
  619. package/dist/webhooks/index.js +0 -8
  620. package/dist/wire/index.d.ts +0 -1
  621. package/dist/wire/index.js +0 -8
  622. package/docs/interaction-model.md +0 -99
@@ -1,286 +0,0 @@
1
- /**
2
- * Builds the request handler returned by `dataSource()`. Given your options —
3
- * the schema, the API key, and either
4
- * per-model handlers or an ORM adapter — the handler verifies each signed request,
5
- * enforces the per-key scopes, and routes the four wire operations (`load`,
6
- * `list`, `commit`, and `events`) to whichever handlers you configured.
7
- */
8
- import { changeSetSchema } from './contract.js';
9
- import { SourceSignatureError, verifyAbloSourceRequest, } from './signing.js';
10
- function json(data, status = 200) {
11
- return new Response(JSON.stringify(data), {
12
- status,
13
- headers: { 'Content-Type': 'application/json' },
14
- });
15
- }
16
- /**
17
- * Serves one request from an ORM `adapter`, mapping each of the four operations to
18
- * the adapter's `read`, `commit`, or `events` method and shaping the wire response.
19
- * The adapter is the only dispatch point, so there is no per-model branching here.
20
- */
21
- async function handleViaAdapter(adapter, body, scope) {
22
- if (body.type === 'load') {
23
- const rows = await adapter.read({
24
- kind: 'load',
25
- model: body.model,
26
- id: body.id,
27
- ...(scope ? { scope } : {}),
28
- });
29
- return json({ row: rows[0] ?? null });
30
- }
31
- if (body.type === 'list') {
32
- const rows = await adapter.read({
33
- kind: 'list',
34
- model: body.model,
35
- ...(body.query ? { query: body.query } : {}),
36
- ...(scope ? { scope } : {}),
37
- });
38
- return json({ rows });
39
- }
40
- if (body.type === 'commit') {
41
- const correlationId = body.correlationId ?? body.clientTxId;
42
- if (!correlationId) {
43
- return json({
44
- error: 'source_commit_requires_correlation_id',
45
- message: 'commit requires a scoped correlationId for idempotency',
46
- }, 400);
47
- }
48
- const parsed = changeSetSchema.safeParse({
49
- operations: body.operations,
50
- correlationId,
51
- intentHash: body.intentHash,
52
- echo: body.echo,
53
- });
54
- if (!parsed.success) {
55
- return json({ error: 'source_commit_invalid', message: parsed.error.message }, 400);
56
- }
57
- if (parsed.data.echo?.kind === 'postgres-wal' &&
58
- adapter.capabilities.postgresWalEcho !== true) {
59
- return json({
60
- error: 'source_commit_echo_not_supported',
61
- message: 'This adapter cannot emit the required Postgres WAL commit echo',
62
- }, 409);
63
- }
64
- const result = await adapter.commit(parsed.data);
65
- return json({ rows: result.rows });
66
- }
67
- if (body.type === 'events') {
68
- const page = await adapter.events(body.cursor ?? null, body.limit ?? 100);
69
- return json({
70
- events: page.events.map((event) => ({
71
- id: event.id,
72
- model: event.model,
73
- entityId: event.entityId,
74
- type: event.type,
75
- ...(event.data !== undefined && event.data !== null ? { data: event.data } : {}),
76
- ...(event.organizationId ? { organizationId: event.organizationId } : {}),
77
- ...(event.clientTxId ? { clientTxId: event.clientTxId } : {}),
78
- ...(event.correlationId ? { correlationId: event.correlationId } : {}),
79
- ...(event.transactionId ? { transactionId: event.transactionId } : {}),
80
- ...(event.occurredAt !== undefined && event.occurredAt !== null
81
- ? { occurredAt: event.occurredAt }
82
- : {}),
83
- })),
84
- ...(page.nextCursor !== null ? { nextCursor: page.nextCursor } : {}),
85
- });
86
- }
87
- return json({ error: 'unknown_source_request' }, 400);
88
- }
89
- async function readBody(request) {
90
- if (typeof request.text === 'function') {
91
- const rawBody = await request.text();
92
- return { rawBody, body: JSON.parse(rawBody) };
93
- }
94
- const body = (await request.json());
95
- return { rawBody: JSON.stringify(body), body };
96
- }
97
- async function resolveApiKey(apiKey, context) {
98
- if (!apiKey)
99
- return null;
100
- return typeof apiKey === 'function' ? apiKey(context) : apiKey;
101
- }
102
- /**
103
- * Maps a wire request to the single scope it requires. The mapping is exhaustive,
104
- * so a new request type must be given its own scope, keeping the scope vocabulary
105
- * in step with the set of operations.
106
- */
107
- function scopeFor(body) {
108
- switch (body.type) {
109
- case 'load':
110
- return 'load';
111
- case 'list':
112
- return 'list';
113
- case 'commit':
114
- return 'commit';
115
- case 'events':
116
- return 'events';
117
- }
118
- }
119
- function normalizeListResult(result) {
120
- if (Array.isArray(result)) {
121
- return { rows: result };
122
- }
123
- const page = result;
124
- return page.nextCursor !== undefined
125
- ? { rows: page.rows, nextCursor: page.nextCursor }
126
- : { rows: page.rows };
127
- }
128
- function getModelHandlers(options, model) {
129
- const grouped = options.models?.[model];
130
- if (grouped)
131
- return grouped;
132
- const direct = options[model];
133
- return direct;
134
- }
135
- function sameModel(operations) {
136
- const first = operations[0]?.model;
137
- if (!first)
138
- return null;
139
- return operations.every((op) => op.model === first) ? first : null;
140
- }
141
- /**
142
- * Creates a Data Source endpoint you host in front of your own database.
143
- *
144
- * Your application code still reads and writes through Ablo, as in
145
- * `ablo.files.load`, `.list`, and `.update`. This helper is for keeping the
146
- * canonical rows in your database: Ablo calls a narrow, signed endpoint you
147
- * control rather than holding your database credentials.
148
- */
149
- export function dataSource(options) {
150
- return async function handleDataSource(request) {
151
- if (request.method !== 'POST') {
152
- return json({ error: 'method_not_allowed' }, 405);
153
- }
154
- let body;
155
- let rawBody;
156
- try {
157
- const parsed = await readBody(request);
158
- body = parsed.body;
159
- rawBody = parsed.rawBody;
160
- }
161
- catch {
162
- return json({ error: 'invalid_json' }, 400);
163
- }
164
- let signature = null;
165
- try {
166
- const apiKey = await resolveApiKey(options.apiKey, {
167
- request,
168
- body,
169
- rawBody,
170
- });
171
- if (!apiKey) {
172
- return json({
173
- error: 'source_api_key_missing',
174
- message: 'Data Source apiKey is required',
175
- }, 401);
176
- }
177
- signature = await verifyAbloSourceRequest({
178
- request,
179
- body: rawBody,
180
- apiKey,
181
- toleranceMs: options.signatureToleranceMs,
182
- });
183
- }
184
- catch (err) {
185
- if (err instanceof SourceSignatureError) {
186
- return json({ error: err.code, message: err.message }, 401);
187
- }
188
- throw err;
189
- }
190
- const auth = options.authorize
191
- ? await options.authorize({ request, body, rawBody })
192
- : undefined;
193
- // Enforce the per-key scope. When `resolveScopes` is set, it returns the
194
- // operations this key may invoke, and we check the request against that set
195
- // before any model handler runs.
196
- if (options.resolveScopes) {
197
- const required = scopeFor(body);
198
- const granted = await options.resolveScopes({ auth, request, body });
199
- const grantedSet = granted instanceof Set ? granted : new Set(granted);
200
- if (!grantedSet.has(required)) {
201
- return json({
202
- error: 'source_forbidden',
203
- required,
204
- granted: Array.from(grantedSet),
205
- }, 403);
206
- }
207
- }
208
- const context = {
209
- auth,
210
- request,
211
- messageId: signature?.messageId,
212
- signedAt: signature?.signedAt,
213
- ...(body.scope ? { scope: body.scope } : {}),
214
- };
215
- // When an ORM adapter is configured it serves every operation here, at the
216
- // generic layer where rows are plain JSON, so there is no per-model handler
217
- // lookup on this path.
218
- if (options.adapter) {
219
- return handleViaAdapter(options.adapter, body, context.scope);
220
- }
221
- if (body.type === 'load') {
222
- const handlers = getModelHandlers(options, body.model);
223
- if (!handlers?.load) {
224
- return json({ error: 'source_load_not_configured', model: body.model }, 404);
225
- }
226
- const row = await handlers.load({ id: body.id, context });
227
- return json({ row });
228
- }
229
- if (body.type === 'list') {
230
- const handlers = getModelHandlers(options, body.model);
231
- if (!handlers?.list) {
232
- return json({ error: 'source_list_not_configured', model: body.model }, 404);
233
- }
234
- const result = await handlers.list({ query: body.query ?? {}, context });
235
- const normalized = normalizeListResult(result);
236
- return json(normalized);
237
- }
238
- if (body.type === 'commit') {
239
- if (options.commit) {
240
- const result = await options.commit({
241
- operations: body.operations,
242
- correlationId: body.correlationId ?? body.clientTxId,
243
- clientTxId: body.clientTxId,
244
- intentHash: body.intentHash,
245
- echo: body.echo,
246
- context,
247
- });
248
- return json(result);
249
- }
250
- const model = body.model ?? sameModel(body.operations);
251
- if (!model) {
252
- return json({ error: 'source_commit_requires_single_model' }, 400);
253
- }
254
- const handlers = getModelHandlers(options, model);
255
- if (!handlers?.commit) {
256
- return json({ error: 'source_commit_not_configured', model }, 404);
257
- }
258
- const result = await handlers.commit({
259
- operations: body.operations,
260
- correlationId: body.correlationId ?? body.clientTxId,
261
- clientTxId: body.clientTxId,
262
- intentHash: body.intentHash,
263
- echo: body.echo,
264
- context,
265
- });
266
- return json(result);
267
- }
268
- if (body.type === 'events') {
269
- if (!options.events) {
270
- return json({ error: 'source_events_not_configured' }, 404);
271
- }
272
- const result = await options.events({
273
- cursor: body.cursor,
274
- limit: body.limit,
275
- context,
276
- });
277
- return json({
278
- events: result.events,
279
- ...(result.nextCursor !== undefined
280
- ? { nextCursor: result.nextCursor }
281
- : {}),
282
- });
283
- }
284
- return json({ error: 'unknown_source_request' }, 400);
285
- };
286
- }
@@ -1,111 +0,0 @@
1
- /**
2
- * The footprint — every object Ablo leaves inside a customer's own database,
3
- * declared once.
4
- *
5
- * Four things need this list and each used to carry its own copy: the setup SQL
6
- * that creates the objects, the replication runtime that reads them, the audit
7
- * that tells a customer what Ablo put there, and (eventually) the teardown that
8
- * removes them. They drifted, as hand-maintained copies do — `ABLO_PUBLICATION`
9
- * was declared twice, under a comment insisting the literals "MUST equal the
10
- * CLI's" and pointing at a file that no longer held it, and the audit went on
11
- * looking for a footprint from an earlier era while seeing none of what Ablo
12
- * installs today.
13
- *
14
- * The audit is the copy that matters most. A customer runs it to answer "what is
15
- * still in my database", and a stale list answers "nothing" — which reads as
16
- * clean rather than as unexamined. So the list lives here, every consumer
17
- * derives from it, and an object added to Ablo's setup is visible to the audit
18
- * because it could not have been added anywhere else.
19
- *
20
- * Retired objects stay in the list, marked {@link FootprintArtifact.retired}.
21
- * They are no longer installed, but a database connected to an older Ablo still
22
- * holds them, and those are precisely the ones a customer would never think to
23
- * look for.
24
- */
25
- /** The Postgres object class, which decides how the audit looks it up. */
26
- export type FootprintKind = 'publication' | 'slot' | 'role' | 'table' | 'type';
27
- export interface FootprintArtifact {
28
- readonly kind: FootprintKind;
29
- readonly name: string;
30
- /** What it is for, in the words a customer reading an audit would want. */
31
- readonly purpose: string;
32
- /**
33
- * Installed only for a data source that reports through the signed endpoint
34
- * rather than the write-ahead log.
35
- */
36
- readonly endpointOnly?: boolean;
37
- /**
38
- * No longer installed by any current version. A database that once ran an
39
- * older Ablo still holds it; the audit reports it so it can be cleaned up.
40
- */
41
- readonly retired?: boolean;
42
- /**
43
- * What it costs to leave behind, when leaving it behind costs something. The
44
- * audit leads with this, because "you still have an object named X" is not a
45
- * reason to act and "this one is retaining your write-ahead log" is.
46
- */
47
- readonly hazard?: string;
48
- }
49
- /**
50
- * The publication Ablo's replication reads from. Constant by design: a
51
- * publication declares what streams, and several readers are meant to share one
52
- * (`publication_names` is a per-stream option, not slot state).
53
- */
54
- export declare const ABLO_PUBLICATION = "ablo_publication";
55
- /**
56
- * The replication slot that holds Ablo's position in the write-ahead log.
57
- *
58
- * Constant, and it should not be — a slot stores ONE position, so two
59
- * connections sharing this name compete for the same marker. It is why a
60
- * database can be connected to one plane at a time. ADR 0020 derives it per
61
- * connection; {@link isValidReplicationSlotName} is the check a derived name
62
- * has to pass.
63
- */
64
- export declare const ABLO_REPLICATION_SLOT = "ablo_slot";
65
- /** The least-privilege login Ablo reads with. Per-connection under ADR 0020. */
66
- export declare const ABLO_REPLICATION_ROLE = "ablo_replicator";
67
- /** The separate least-privilege login used only for row writes. */
68
- export declare const ABLO_WRITE_ROLE = "ablo_writer";
69
- /** The bookkeeping table that makes a retried write land once. */
70
- export declare const ABLO_IDEMPOTENCY_TABLE = "ablo_idempotency";
71
- /** The transactional outbox an endpoint source reports through. */
72
- export declare const ABLO_OUTBOX_TABLE = "ablo_outbox";
73
- /**
74
- * Postgres will not accept a replication slot name outside this shape — the
75
- * check is in `ReplicationSlotValidateNameInternal`, and identifier quoting does
76
- * not exempt a name from it. Anything derived into a slot name is validated
77
- * here, at the point it is derived, rather than failing at the point it is used.
78
- */
79
- export declare const REPLICATION_SLOT_NAME: RegExp;
80
- export declare function isValidReplicationSlotName(name: string): boolean;
81
- /** The four plane axes a connection is identified by. */
82
- export interface FootprintPlane {
83
- readonly organizationId: string;
84
- readonly environment: string;
85
- /** '' for the organization-default project. */
86
- readonly projectId?: string;
87
- /** '' for the default sandbox. */
88
- readonly sandboxId?: string;
89
- }
90
- /** The names one connection owns. Nothing here is shared with another plane. */
91
- export interface FootprintNames {
92
- readonly slot: string;
93
- readonly publication: string;
94
- readonly replicationRole: string;
95
- readonly writeRole: string;
96
- }
97
- /**
98
- * The objects this connection owns, named so no other connection can claim them.
99
- *
100
- * A slot stores ONE position, so two connections sharing a name compete for the
101
- * same marker and Postgres reports nothing — which is why the constants these
102
- * replace made a database connectable to one plane at a time. The publication
103
- * and roles are derived from the same digest so a database's footprint reads as
104
- * one set per connection rather than a mix of shared and private objects.
105
- *
106
- * Stable: the same plane always derives the same names, so re-running setup is a
107
- * no-op rather than a second installation.
108
- */
109
- export declare function footprintNamesFor(plane: FootprintPlane): FootprintNames;
110
- /** Everything Ablo has ever put in a customer's database, current and retired. */
111
- export declare const ABLO_FOOTPRINT: readonly FootprintArtifact[];
Binary file
@@ -1,61 +0,0 @@
1
- /**
2
- * Customer-side source idempotency helpers.
3
- *
4
- * Connected writes use a permanent, server-derived correlation key at the
5
- * customer boundary. The matching intent hash must therefore also be
6
- * permanent: replaying the key with a different request is a conflict, never a
7
- * fresh execution. Ablo supplies the hash for signed source requests because
8
- * it covers context/read guards that an adapter cannot reconstruct from the
9
- * effective operation list alone. Direct adapter users get a canonical
10
- * operations-only fallback.
11
- */
12
- import { z } from 'zod';
13
- import type { ChangeSet, Operation } from './contract.js';
14
- /** Runtime shape recovered from the internal storage envelope. */
15
- export declare const sourceEchoTransactionIdSchema: z.ZodObject<{
16
- correlationId: z.ZodString;
17
- transactionId: z.ZodString;
18
- }, z.core.$strict>;
19
- export type SourceEchoTransactionId = z.infer<typeof sourceEchoTransactionIdSchema>;
20
- /**
21
- * Store both source-batch identity and the originating optimistic-write id in
22
- * the existing `sync_deltas.transaction_id` column. The database value is an
23
- * internal envelope: the server unwraps it before broadcasting, so clients
24
- * still receive the exact operation transaction id they authored.
25
- *
26
- * Keeping the opaque, authenticated-scope correlation in the stored value is
27
- * load-bearing for crash recovery. A raw caller may choose or reuse an
28
- * operation transaction id; that value alone must never be able to satisfy a
29
- * different participant's queued receipt.
30
- */
31
- export declare function encodeSourceEchoTransactionId(correlationId: string, transactionId: string): string;
32
- /** Decode a source-WAL transaction envelope, or return null for normal rows. */
33
- export declare function decodeSourceEchoTransactionId(value: string | null): SourceEchoTransactionId | null;
34
- /** Canonical operations-only fallback for direct adapter use. */
35
- export declare function sourceOperationsIntentHash(operations: readonly Operation[]): string;
36
- /** Resolve the hash every newly-written customer ledger row must persist. */
37
- export declare function sourceChangeIntentHash(change: ChangeSet): string;
38
- /** Fail closed for changed intent and legacy rows that lack hash evidence. */
39
- export declare function assertSourceIdempotencyIntent(cachedHash: unknown, requestHash: string): void;
40
- /**
41
- * How long a ledger row stays replayable, as a Postgres interval. New rows are
42
- * written with `expires_at = now() + this`, so the customer can prune anything
43
- * past it — the writer can't (it holds no DELETE, by design), so pruning is a
44
- * job for their own admin/cron: `DELETE FROM ablo_idempotency WHERE expires_at <
45
- * now()`.
46
- *
47
- * This is an ops/UX window, not a safety one: {@link assertSourceIdempotencyRetention}
48
- * already refuses to replay an expired key (fail-closed), so an expired row can
49
- * never be safely re-applied whether or not it has been pruned. The window only
50
- * governs how late a retry can still collect its cached response before it's
51
- * told to start over. 30 days comfortably covers an offline client's queued
52
- * commits while keeping the table bounded.
53
- */
54
- export declare const SOURCE_IDEMPOTENCY_RETENTION = "30 days";
55
- /**
56
- * Enforce the retention contract on replay. A row past its `expires_at` is
57
- * refused (fail-closed) rather than re-applied, so pruning expired rows is
58
- * always safe. Rows written before the column existed (`infinity`/null) are
59
- * accepted — they predate bounded retention and never expire.
60
- */
61
- export declare function assertSourceIdempotencyRetention(expiresAt: unknown, now?: number): void;
@@ -1,144 +0,0 @@
1
- /**
2
- * Customer-side source idempotency helpers.
3
- *
4
- * Connected writes use a permanent, server-derived correlation key at the
5
- * customer boundary. The matching intent hash must therefore also be
6
- * permanent: replaying the key with a different request is a conflict, never a
7
- * fresh execution. Ablo supplies the hash for signed source requests because
8
- * it covers context/read guards that an adapter cannot reconstruct from the
9
- * effective operation list alone. Direct adapter users get a canonical
10
- * operations-only fallback.
11
- */
12
- import { createHash } from 'node:crypto';
13
- import { z } from 'zod';
14
- import { AbloValidationError } from '../transaction/errors.js';
15
- import { COMMIT_CORRELATION_ID_MAX_LENGTH, correlationIdSchema, } from '../transaction/wire/commit.js';
16
- const SOURCE_ECHO_TRANSACTION_ID_PREFIX = 'ablo_echo_tx_v1:';
17
- const sourceOperationTransactionIdSchema = z
18
- .string()
19
- .min(1)
20
- .max(COMMIT_CORRELATION_ID_MAX_LENGTH);
21
- /** Runtime shape recovered from the internal storage envelope. */
22
- export const sourceEchoTransactionIdSchema = z.strictObject({
23
- correlationId: correlationIdSchema,
24
- transactionId: sourceOperationTransactionIdSchema,
25
- });
26
- const sourceEchoTransactionIdTupleSchema = z.tuple([
27
- correlationIdSchema,
28
- sourceOperationTransactionIdSchema,
29
- ]);
30
- /**
31
- * Store both source-batch identity and the originating optimistic-write id in
32
- * the existing `sync_deltas.transaction_id` column. The database value is an
33
- * internal envelope: the server unwraps it before broadcasting, so clients
34
- * still receive the exact operation transaction id they authored.
35
- *
36
- * Keeping the opaque, authenticated-scope correlation in the stored value is
37
- * load-bearing for crash recovery. A raw caller may choose or reuse an
38
- * operation transaction id; that value alone must never be able to satisfy a
39
- * different participant's queued receipt.
40
- */
41
- export function encodeSourceEchoTransactionId(correlationId, transactionId) {
42
- const tuple = sourceEchoTransactionIdTupleSchema.parse([
43
- correlationId,
44
- transactionId,
45
- ]);
46
- return `${SOURCE_ECHO_TRANSACTION_ID_PREFIX}${JSON.stringify(tuple)}`;
47
- }
48
- /** Decode a source-WAL transaction envelope, or return null for normal rows. */
49
- export function decodeSourceEchoTransactionId(value) {
50
- if (!value?.startsWith(SOURCE_ECHO_TRANSACTION_ID_PREFIX))
51
- return null;
52
- try {
53
- const parsed = JSON.parse(value.slice(SOURCE_ECHO_TRANSACTION_ID_PREFIX.length));
54
- const tuple = sourceEchoTransactionIdTupleSchema.safeParse(parsed);
55
- if (!tuple.success)
56
- return null;
57
- return sourceEchoTransactionIdSchema.parse({
58
- correlationId: tuple.data[0],
59
- transactionId: tuple.data[1],
60
- });
61
- }
62
- catch {
63
- return null;
64
- }
65
- }
66
- function canonicalJson(value) {
67
- if (value === null || typeof value !== 'object') {
68
- const encoded = JSON.stringify(value);
69
- return encoded ?? 'null';
70
- }
71
- if (Array.isArray(value)) {
72
- return `[${value
73
- .map((entry) => canonicalJson(entry === undefined ? null : entry))
74
- .join(',')}]`;
75
- }
76
- const record = value;
77
- return `{${Object.keys(record)
78
- .filter((key) => record[key] !== undefined)
79
- .sort()
80
- .map((key) => `${JSON.stringify(key)}:${canonicalJson(record[key])}`)
81
- .join(',')}}`;
82
- }
83
- /** Canonical operations-only fallback for direct adapter use. */
84
- export function sourceOperationsIntentHash(operations) {
85
- return createHash('sha256')
86
- .update(canonicalJson(operations))
87
- .digest('hex');
88
- }
89
- /** Resolve the hash every newly-written customer ledger row must persist. */
90
- export function sourceChangeIntentHash(change) {
91
- if (change.echo && !change.intentHash) {
92
- throw new AbloValidationError('A WAL-correlated source commit requires Ablo intentHash evidence', { code: 'idempotency_conflict' });
93
- }
94
- return change.intentHash ?? sourceOperationsIntentHash(change.operations);
95
- }
96
- /** Fail closed for changed intent and legacy rows that lack hash evidence. */
97
- export function assertSourceIdempotencyIntent(cachedHash, requestHash) {
98
- if (cachedHash !== requestHash) {
99
- throw new AbloValidationError(cachedHash == null
100
- ? 'The source idempotency row predates intent hashing and cannot be replayed safely'
101
- : 'The source idempotency key was already used with a different request intent', { code: 'idempotency_conflict' });
102
- }
103
- }
104
- /**
105
- * How long a ledger row stays replayable, as a Postgres interval. New rows are
106
- * written with `expires_at = now() + this`, so the customer can prune anything
107
- * past it — the writer can't (it holds no DELETE, by design), so pruning is a
108
- * job for their own admin/cron: `DELETE FROM ablo_idempotency WHERE expires_at <
109
- * now()`.
110
- *
111
- * This is an ops/UX window, not a safety one: {@link assertSourceIdempotencyRetention}
112
- * already refuses to replay an expired key (fail-closed), so an expired row can
113
- * never be safely re-applied whether or not it has been pruned. The window only
114
- * governs how late a retry can still collect its cached response before it's
115
- * told to start over. 30 days comfortably covers an offline client's queued
116
- * commits while keeping the table bounded.
117
- */
118
- export const SOURCE_IDEMPOTENCY_RETENTION = '30 days';
119
- /**
120
- * Enforce the retention contract on replay. A row past its `expires_at` is
121
- * refused (fail-closed) rather than re-applied, so pruning expired rows is
122
- * always safe. Rows written before the column existed (`infinity`/null) are
123
- * accepted — they predate bounded retention and never expire.
124
- */
125
- export function assertSourceIdempotencyRetention(expiresAt, now = Date.now()) {
126
- if (expiresAt == null ||
127
- expiresAt === 'infinity' ||
128
- expiresAt === Infinity) {
129
- return;
130
- }
131
- const timestamp = expiresAt instanceof Date
132
- ? expiresAt.getTime()
133
- : typeof expiresAt === 'number'
134
- ? expiresAt
135
- : typeof expiresAt === 'string'
136
- ? Date.parse(expiresAt)
137
- : Number.NaN;
138
- if (!Number.isFinite(timestamp)) {
139
- throw new AbloValidationError('The source idempotency retention evidence is invalid', { code: 'idempotency_conflict' });
140
- }
141
- if (timestamp <= now) {
142
- throw new AbloValidationError('The source idempotency key has expired and cannot be executed again safely', { code: 'idempotency_key_expired' });
143
- }
144
- }
@@ -1,23 +0,0 @@
1
- /**
2
- * The entry point for the Data Source API, re-exporting the pieces you need from
3
- * their individual modules:
4
- *
5
- * - `types.ts` — the shared wire and handler types, plus `sourceEventForOperation`
6
- * - `signing.ts` — request signing and verification
7
- * - `factory.ts` — the `dataSource()` endpoint factory
8
- *
9
- * Import from here; the sibling modules import one another directly.
10
- */
11
- export { sourceEventForOperation, ABLO_POSTGRES_COMMIT_ECHO_PREFIX, ABLO_SOURCE_CLIENT_TX_ID_MAX_LENGTH, ABLO_SOURCE_ECHO_MAX_OPERATIONS, ABLO_SOURCE_ECHO_MAX_PAYLOAD_BYTES, type SourcePrimitive, type SourceWhere, type SourceListQuery, type SourceListPage, type SourceListResult, type SourceRequestContext, type SourceOperation, type SourceDelta, type SourceEvent, type SourceEventForOperationOptions, type SourceCommitResult, type SourceCommitEcho, type SourceCommitEchoOperation, type SourceCommitEchoMarker, type SourceCommitParams, type SourceScope, type SourceEventsResult, type SourceEventsHandler, type SourceAuthorizeContext, type SourceHandlerContext, type SourceModelHandlers, type SourceCommitHandler, type SourceApiKey, type SourceLoadRequest, type SourceListRequest, type SourceCommitRequest, type SourceEventsRequest, type SourceRequest, type SourceResponse, } from './types.js';
12
- export { ABLO_SOURCE_HEADERS, SourceSignatureError, signAbloSourceRequest, verifyAbloSourceRequest, type SourceSignatureOptions, type SourceSignatureVerificationOptions, type SourceSignatureVerificationResult, } from './signing.js';
13
- export { dataSource, type DataSourceOptions, } from './factory.js';
14
- export { createPushQueue, InMemoryPushQueueStorage, STANDARD_WEBHOOKS_RETRY_SCHEDULE, type PushQueue, type PushQueueItem, type PushQueueOptions, type PushQueueStorage, } from './pushQueue.js';
15
- export { createSourceConnector, DEFAULT_RECONNECT_SCHEDULE, type SourceConnector, type SourceConnectorOptions, type ConnectorWebSocket, type ConnectorWebSocketFactory, type ConnectorStatus, } from './connector.js';
16
- export { SOURCE_CONNECTOR_PROTOCOL_VERSION, SOURCE_CONNECTOR_WS_PATH, WS_SOURCE_SUBPROTOCOL, sourceConnectorSubprotocols, encodeFrame, decodeFrame, ConnectorProtocolError, connectorFrameSchema, type ConnectorFrame, type RegisterFrame, type ReadyFrame, type RequestFrame, type ResponseFrame, type ErrorFrame, } from './connectorProtocol.js';
17
- export { type DataSourceAdapter, type MutationAdapter, type AdapterReadRequest, type AdapterCommitResult, type Row as AdapterRow, } from './adapter.js';
18
- export { operationSchema, operationTypeSchema, sourceCommitEchoSchema, sourceCommitEchoOperationSchema, sourceCommitEchoMarkerSchema, changeSetSchema, outboxEventSchema, eventsPageSchema, migrationSchema, adapterCapabilitiesSchema, type Operation, type ChangeSet, type OutboxEvent, type EventsPage, type Migration, type AdapterCapabilities, type SourceCommitEchoMarkerWire, } from './contract.js';
19
- export { prismaDataSource, type PrismaLike, type PrismaDataSourceOptions } from './adapters/prisma.js';
20
- export { adapterTableMigrations, endpointOutboxMigrations, idempotencyLedgerMigrations, } from './migrations.js';
21
- export { createKyselyMutationAdapter, createKyselyMutationCore, kyselyDataSource, kyselyDirectMutation, kyselyOperationRowId, type KyselyCompiledQuery, type KyselyDeleteBuilder, type KyselyInsertBuilder, type KyselyInsertValuesBuilder, type KyselyLike, type KyselyMutationCore, type KyselyReturningExecutable, type KyselySelectBuilder, type KyselyTransactionBuilder, type KyselyUpdateBuilder, type KyselyUpdateSetBuilder, } from './adapters/kysely.js';
22
- export { sourceOperationsIntentHash, sourceChangeIntentHash, assertSourceIdempotencyIntent, assertSourceIdempotencyRetention, sourceEchoTransactionIdSchema, encodeSourceEchoTransactionId, decodeSourceEchoTransactionId, type SourceEchoTransactionId, } from './idempotency.js';
23
- export { ABLO_FOOTPRINT, ABLO_PUBLICATION, ABLO_REPLICATION_SLOT, ABLO_REPLICATION_ROLE, ABLO_WRITE_ROLE, ABLO_IDEMPOTENCY_TABLE, ABLO_OUTBOX_TABLE, REPLICATION_SLOT_NAME, isValidReplicationSlotName, footprintNamesFor, type FootprintArtifact, type FootprintKind, type FootprintNames, type FootprintPlane, } from './footprint.js';
@@ -1,30 +0,0 @@
1
- /**
2
- * The entry point for the Data Source API, re-exporting the pieces you need from
3
- * their individual modules:
4
- *
5
- * - `types.ts` — the shared wire and handler types, plus `sourceEventForOperation`
6
- * - `signing.ts` — request signing and verification
7
- * - `factory.ts` — the `dataSource()` endpoint factory
8
- *
9
- * Import from here; the sibling modules import one another directly.
10
- */
11
- export { sourceEventForOperation, ABLO_POSTGRES_COMMIT_ECHO_PREFIX, ABLO_SOURCE_CLIENT_TX_ID_MAX_LENGTH, ABLO_SOURCE_ECHO_MAX_OPERATIONS, ABLO_SOURCE_ECHO_MAX_PAYLOAD_BYTES, } from './types.js';
12
- export { ABLO_SOURCE_HEADERS, SourceSignatureError, signAbloSourceRequest, verifyAbloSourceRequest, } from './signing.js';
13
- export { dataSource, } from './factory.js';
14
- export { createPushQueue, InMemoryPushQueueStorage, STANDARD_WEBHOOKS_RETRY_SCHEDULE, } from './pushQueue.js';
15
- // The reverse-channel connector — an outbound transport for the load, list, and
16
- // commit leg, and the dial-out counterpart to `createPushQueue`. It lets you serve
17
- // a Data Source from localhost or a private network that has no public inbound
18
- // URL. See `connectorProtocol.ts` for the frames it exchanges.
19
- export { createSourceConnector, DEFAULT_RECONNECT_SCHEDULE, } from './connector.js';
20
- export { SOURCE_CONNECTOR_PROTOCOL_VERSION, SOURCE_CONNECTOR_WS_PATH, WS_SOURCE_SUBPROTOCOL, sourceConnectorSubprotocols, encodeFrame, decodeFrame, ConnectorProtocolError, connectorFrameSchema, } from './connectorProtocol.js';
21
- // The Data Source adapter interface and its Zod contract, with per-ORM implementations.
22
- export {} from './adapter.js';
23
- export { operationSchema, operationTypeSchema, sourceCommitEchoSchema, sourceCommitEchoOperationSchema, sourceCommitEchoMarkerSchema, changeSetSchema, outboxEventSchema, eventsPageSchema, migrationSchema, adapterCapabilitiesSchema, } from './contract.js';
24
- export { prismaDataSource } from './adapters/prisma.js';
25
- export { adapterTableMigrations, endpointOutboxMigrations, idempotencyLedgerMigrations, } from './migrations.js';
26
- export { createKyselyMutationAdapter, createKyselyMutationCore, kyselyDataSource, kyselyDirectMutation, kyselyOperationRowId, } from './adapters/kysely.js';
27
- export { sourceOperationsIntentHash, sourceChangeIntentHash, assertSourceIdempotencyIntent, assertSourceIdempotencyRetention, sourceEchoTransactionIdSchema, encodeSourceEchoTransactionId, decodeSourceEchoTransactionId, } from './idempotency.js';
28
- // What Ablo leaves inside a customer's database, declared once — read by the
29
- // setup SQL, the replication runtime, and the audit that reports it back.
30
- export { ABLO_FOOTPRINT, ABLO_PUBLICATION, ABLO_REPLICATION_SLOT, ABLO_REPLICATION_ROLE, ABLO_WRITE_ROLE, ABLO_IDEMPOTENCY_TABLE, ABLO_OUTBOX_TABLE, REPLICATION_SLOT_NAME, isValidReplicationSlotName, footprintNamesFor, } from './footprint.js';