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