@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,161 +0,0 @@
1
- /**
2
- * Runtime contracts for retry-safe commits.
3
- *
4
- * `commitEnvelopeMemberSchema` is the compact pointer stored on an in-memory
5
- * transaction. `durableCommitEnvelopeSchema` is the actual outbox record: one
6
- * atomic IndexedDB value containing the stable request key, exact ordered wire
7
- * operations, and the source mutations it supersedes.
8
- */
9
- import { z } from 'zod';
10
- import { readDependencySchema, trackDependencySchema } from '../../coordination/schema.js';
11
- import { wireCommitOperationSchema } from '../../wire/frames.js';
12
- import { correlationIdSchema } from '../../wire/commit.js';
13
- import { idempotencyKeySchema } from './idempotencyKey.js';
14
- import { snapshotJsonValue } from '../../utils/json.js';
15
- export const COMMIT_ENVELOPE_VERSION = 1;
16
- export const COMMIT_ENVELOPE_RECORD_PREFIX = 'commit-envelope:';
17
- /** One transaction's position in a commit; this is not the envelope itself. */
18
- export const commitEnvelopeMemberSchema = z
19
- .strictObject({
20
- idempotencyKey: idempotencyKeySchema,
21
- operationIndex: z.number().int().nonnegative(),
22
- operationCount: z.number().int().positive(),
23
- sealedAt: z.number().int().nonnegative().optional(),
24
- sequence: z.number().int().nonnegative().optional(),
25
- })
26
- .refine(({ operationIndex, operationCount }) => operationIndex < operationCount, { message: 'operationIndex must be smaller than operationCount' });
27
- /** One operation stored exactly as the current commit transport sends it. */
28
- export const durableCommitOperationSchema = wireCommitOperationSchema
29
- .pick({
30
- type: true,
31
- model: true,
32
- id: true,
33
- input: true,
34
- transactionId: true,
35
- readAt: true,
36
- onStale: true,
37
- fenceToken: true,
38
- })
39
- .extend({
40
- model: z.string().min(1),
41
- id: z.string().min(1),
42
- input: z.record(z.string(), z.unknown()).optional(),
43
- transactionId: z.string().min(1).optional(),
44
- options: z
45
- .strictObject({
46
- idempotencyKey: z.string().min(1).max(255).nullable().optional(),
47
- label: z.string().min(1).max(255).optional(),
48
- })
49
- .optional(),
50
- });
51
- const durableCommitOptionsSchema = z.strictObject({
52
- reads: z.array(readDependencySchema).nullable().optional(),
53
- track: z.array(trackDependencySchema).nullable().optional(),
54
- });
55
- export const commitOutboxScopeSchema = z.strictObject({
56
- organizationId: z.string().min(1),
57
- participantId: z.string().min(1),
58
- namespace: z.string().min(1),
59
- });
60
- /**
61
- * One crash-durable logical commit. Keeping every operation in one record makes
62
- * membership and order atomic: recovery can observe the old record or the new
63
- * record, never half an envelope.
64
- */
65
- export const durableCommitEnvelopeSchema = z
66
- .strictObject({
67
- id: z.string().startsWith(COMMIT_ENVELOPE_RECORD_PREFIX),
68
- type: z.literal('commit_envelope'),
69
- storageVersion: z.literal(COMMIT_ENVELOPE_VERSION),
70
- origin: z.enum(['model_batch', 'atomic_commit']),
71
- idempotencyKey: idempotencyKeySchema,
72
- operations: z.array(durableCommitOperationSchema).min(1).max(500),
73
- // Bookkeeping cardinality is independent of the 500 wire-operation cap:
74
- // hundreds of same-row offline patches may coalesce into one operation.
75
- sourceMutationIds: z.array(z.string().min(1)).default([]),
76
- commitOptions: durableCommitOptionsSchema.default({}),
77
- scope: commitOutboxScopeSchema.optional(),
78
- createdAt: z.number().int().nonnegative(),
79
- sealedAt: z.number().int().nonnegative(),
80
- /**
81
- * Monotonic evidence that a connected source accepted this exact request.
82
- * Its server and customer idempotency keys are permanent, so an accepted
83
- * envelope remains replayable until the WAL echo confirms it.
84
- */
85
- acceptedAt: z.number().int().nonnegative().optional(),
86
- /** Opaque server-derived source-batch identity paired with `acceptedAt`. */
87
- correlationId: correlationIdSchema.optional(),
88
- /** Monotonic within one client; disambiguates writes sealed in the same ms. */
89
- sequence: z.number().int().nonnegative().optional(),
90
- timestamp: z.number().int().nonnegative(),
91
- })
92
- .superRefine((envelope, context) => {
93
- if (envelope.id !== commitEnvelopeRecordId(envelope.idempotencyKey)) {
94
- context.addIssue({
95
- code: 'custom',
96
- path: ['id'],
97
- message: 'Envelope record id must be derived from its idempotency key',
98
- });
99
- }
100
- if (new Set(envelope.sourceMutationIds).size !== envelope.sourceMutationIds.length) {
101
- context.addIssue({
102
- code: 'custom',
103
- path: ['sourceMutationIds'],
104
- message: 'Source mutation ids must be unique',
105
- });
106
- }
107
- if ((envelope.acceptedAt === undefined) !== (envelope.correlationId === undefined)) {
108
- context.addIssue({
109
- code: 'custom',
110
- path: ['acceptedAt'],
111
- message: 'Accepted commit envelopes require both acceptedAt and correlationId',
112
- });
113
- }
114
- if (envelope.acceptedAt !== undefined &&
115
- envelope.acceptedAt < envelope.sealedAt) {
116
- context.addIssue({
117
- code: 'custom',
118
- path: ['acceptedAt'],
119
- message: 'Commit envelope cannot be accepted before it is sealed',
120
- });
121
- }
122
- if (envelope.origin === 'model_batch') {
123
- const transactionIds = envelope.operations.map((operation) => operation.transactionId);
124
- if (transactionIds.some((id) => typeof id !== 'string' || id.length === 0)) {
125
- context.addIssue({
126
- code: 'custom',
127
- path: ['operations'],
128
- message: 'Every model-batch operation must carry a transactionId',
129
- });
130
- }
131
- else if (new Set(transactionIds).size !== transactionIds.length) {
132
- context.addIssue({
133
- code: 'custom',
134
- path: ['operations'],
135
- message: 'Model-batch transactionIds must be unique',
136
- });
137
- }
138
- }
139
- });
140
- export function commitEnvelopeRecordId(idempotencyKey) {
141
- return `${COMMIT_ENVELOPE_RECORD_PREFIX}${idempotencyKey}`;
142
- }
143
- /** Constructs validated member metadata when an in-memory batch is formed. */
144
- export function createCommitEnvelopeMember(value) {
145
- return commitEnvelopeMemberSchema.parse(value);
146
- }
147
- /**
148
- * Freezes the exact JSON request that will be persisted and sent. The shared
149
- * snapshot contract makes framework proxies plain and rejects values that
150
- * would be lost or corrupted by JSON serialization.
151
- */
152
- export function createDurableCommitEnvelope(value) {
153
- const candidate = {
154
- ...value,
155
- id: commitEnvelopeRecordId(value.idempotencyKey),
156
- type: 'commit_envelope',
157
- storageVersion: COMMIT_ENVELOPE_VERSION,
158
- timestamp: value.sealedAt,
159
- };
160
- return durableCommitEnvelopeSchema.parse(snapshotJsonValue(candidate, '$.commitEnvelope'));
161
- }
@@ -1,53 +0,0 @@
1
- /** Crash-durable exact HTTP request used by the stateless agent client. */
2
- import { z } from 'zod';
3
- export declare const HTTP_COMMIT_ENVELOPE_VERSION: 1;
4
- export declare const HTTP_COMMIT_ENVELOPE_PREFIX = "http-commit-envelope:";
5
- /** Stay one hour inside the server's 24-hour idempotency retention window. */
6
- export declare const HTTP_COMMIT_REPLAY_WINDOW_MS: number;
7
- /** Snapshot the JSON contract once, then make object-key order canonical. */
8
- export declare function canonicalHttpCommitBody(value: unknown): string;
9
- export declare const durableHttpCommitEnvelopeSchema: z.ZodObject<{
10
- id: z.ZodString;
11
- type: z.ZodLiteral<"http_commit_envelope">;
12
- storageVersion: z.ZodLiteral<1>;
13
- idempotencyKey: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
14
- protocolVersion: z.ZodDefault<z.ZodNumber>;
15
- request: z.ZodObject<{
16
- method: z.ZodEnum<{
17
- DELETE: "DELETE";
18
- POST: "POST";
19
- PATCH: "PATCH";
20
- }>;
21
- path: z.ZodString;
22
- body: z.ZodString;
23
- }, z.core.$strict>;
24
- scopeNamespace: z.ZodString;
25
- createdAt: z.ZodNumber;
26
- sealedAt: z.ZodNumber;
27
- acceptedAt: z.ZodOptional<z.ZodNumber>;
28
- correlationId: z.ZodOptional<z.ZodString>;
29
- sequence: z.ZodOptional<z.ZodNumber>;
30
- timestamp: z.ZodNumber;
31
- }, z.core.$strict>;
32
- export type DurableHttpCommitEnvelope = z.infer<typeof durableHttpCommitEnvelopeSchema>;
33
- /**
34
- * The HTTP verbs a durable commit envelope can carry, projected out of the
35
- * persisted schema above. Callers that build, seal, or dispatch an envelope
36
- * take this rather than restating the verbs: the envelope is a stored contract,
37
- * so a verb the schema does not accept must not be constructible.
38
- */
39
- export type DurableHttpCommitMethod = DurableHttpCommitEnvelope['request']['method'];
40
- export declare function httpCommitEnvelopeRecordId(idempotencyKey: string, scopeNamespace?: string): string;
41
- export declare function createDurableHttpCommitEnvelope(input: {
42
- idempotencyKey: string;
43
- request: {
44
- method: DurableHttpCommitMethod;
45
- path: string;
46
- body: unknown;
47
- };
48
- scopeNamespace: string;
49
- createdAt?: number;
50
- sealedAt?: number;
51
- sequence?: number;
52
- }): DurableHttpCommitEnvelope;
53
- export declare function isHttpCommitReplayExpired(envelope: Pick<DurableHttpCommitEnvelope, 'sealedAt' | 'acceptedAt'>, now?: number): boolean;
@@ -1,207 +0,0 @@
1
- /** Crash-durable exact HTTP request used by the stateless agent client. */
2
- import { z } from 'zod';
3
- import { v5 as uuidv5 } from 'uuid';
4
- import { snapshotJsonValue, stableStringify } from '../../utils/json.js';
5
- import { correlationIdSchema } from '../../wire/commit.js';
6
- import { PROTOCOL_VERSION } from '../../wire/protocolVersion.js';
7
- import { idempotencyKeySchema } from './idempotencyKey.js';
8
- export const HTTP_COMMIT_ENVELOPE_VERSION = 1;
9
- export const HTTP_COMMIT_ENVELOPE_PREFIX = 'http-commit-envelope:';
10
- /** Stay one hour inside the server's 24-hour idempotency retention window. */
11
- export const HTTP_COMMIT_REPLAY_WINDOW_MS = 23 * 60 * 60 * 1000;
12
- const HTTP_COMMIT_SCOPE_ID_NAMESPACE = '043e8f73-86fc-5f62-af46-935d68fca729';
13
- const commitPathSchema = z.literal('/v1/commits');
14
- const modelCollectionPathSchema = z.string().regex(/^\/v1\/models\/[^/]+$/);
15
- const modelEntityPathSchema = z.string().regex(/^\/v1\/models\/[^/]+\/[^/]+$/);
16
- function hasSafeModelPathSegments(path) {
17
- if (!path.startsWith('/v1/models/'))
18
- return true;
19
- try {
20
- return path
21
- .slice('/v1/models/'.length)
22
- .split('/')
23
- .every((segment) => {
24
- const decoded = decodeURIComponent(segment);
25
- return (decoded.length > 0 &&
26
- decoded !== '.' &&
27
- decoded !== '..' &&
28
- !decoded.includes('/') &&
29
- !decoded.includes('\\'));
30
- });
31
- }
32
- catch {
33
- return false;
34
- }
35
- }
36
- /** Snapshot the JSON contract once, then make object-key order canonical. */
37
- export function canonicalHttpCommitBody(value) {
38
- return stableStringify(snapshotJsonValue(value, '$.body'));
39
- }
40
- export const durableHttpCommitEnvelopeSchema = z
41
- .strictObject({
42
- id: z.string().startsWith(HTTP_COMMIT_ENVELOPE_PREFIX),
43
- type: z.literal('http_commit_envelope'),
44
- storageVersion: z.literal(HTTP_COMMIT_ENVELOPE_VERSION),
45
- idempotencyKey: idempotencyKeySchema,
46
- /**
47
- * The wire contract used when this exact request was sealed. Entries from
48
- * before protocol versioning omitted the field and are v1 by definition.
49
- */
50
- protocolVersion: z.number().int().positive().default(1),
51
- request: z.strictObject({
52
- method: z.enum(['POST', 'PATCH', 'DELETE']),
53
- path: z.string().startsWith('/'),
54
- body: z.string().refine((body) => {
55
- try {
56
- JSON.parse(body);
57
- return true;
58
- }
59
- catch {
60
- return false;
61
- }
62
- }, 'HTTP commit body must be valid JSON'),
63
- }),
64
- scopeNamespace: z.string().min(1),
65
- createdAt: z.number().int().nonnegative(),
66
- sealedAt: z.number().int().nonnegative(),
67
- /**
68
- * Monotonic evidence that the server accepted this exact request for a
69
- * connected source. Such server keys are permanent, so this envelope must
70
- * remain replayable past the ordinary hosted 24-hour window until its WAL
71
- * echo confirms.
72
- */
73
- acceptedAt: z.number().int().nonnegative().optional(),
74
- /** Opaque server-derived source-batch identity paired with `acceptedAt`. */
75
- correlationId: correlationIdSchema.optional(),
76
- /** Monotonic within one client; disambiguates writes sealed in the same ms. */
77
- sequence: z.number().int().nonnegative().optional(),
78
- timestamp: z.number().int().nonnegative(),
79
- })
80
- .superRefine((envelope, context) => {
81
- const legacyId = httpCommitEnvelopeRecordId(envelope.idempotencyKey);
82
- const scopedId = httpCommitEnvelopeRecordId(envelope.idempotencyKey, envelope.scopeNamespace);
83
- if (envelope.id !== legacyId && envelope.id !== scopedId) {
84
- context.addIssue({
85
- code: 'custom',
86
- path: ['id'],
87
- message: 'HTTP envelope id must be derived from its idempotency key',
88
- });
89
- }
90
- if (envelope.sealedAt < envelope.createdAt) {
91
- context.addIssue({
92
- code: 'custom',
93
- path: ['sealedAt'],
94
- message: 'HTTP envelope cannot be sealed before it is created',
95
- });
96
- }
97
- if ((envelope.acceptedAt === undefined) !== (envelope.correlationId === undefined)) {
98
- context.addIssue({
99
- code: 'custom',
100
- path: ['acceptedAt'],
101
- message: 'Accepted HTTP envelopes require both acceptedAt and correlationId',
102
- });
103
- }
104
- if (envelope.acceptedAt !== undefined &&
105
- envelope.acceptedAt < envelope.sealedAt) {
106
- context.addIssue({
107
- code: 'custom',
108
- path: ['acceptedAt'],
109
- message: 'HTTP envelope cannot be accepted before it is sealed',
110
- });
111
- }
112
- const { method, path } = envelope.request;
113
- const allowedPath = method === 'POST'
114
- ? commitPathSchema.safeParse(path).success ||
115
- modelCollectionPathSchema.safeParse(path).success
116
- : modelEntityPathSchema.safeParse(path).success;
117
- if (!allowedPath || !hasSafeModelPathSegments(path)) {
118
- context.addIssue({
119
- code: 'custom',
120
- path: ['request', 'path'],
121
- message: 'HTTP outbox records may target only commit or model-mutation routes',
122
- });
123
- return;
124
- }
125
- let body;
126
- try {
127
- body = JSON.parse(envelope.request.body);
128
- }
129
- catch {
130
- return; // The field-level JSON refinement reports this.
131
- }
132
- if (typeof body !== 'object' || body === null || Array.isArray(body)) {
133
- context.addIssue({
134
- code: 'custom',
135
- path: ['request', 'body'],
136
- message: 'HTTP commit body must be a JSON object',
137
- });
138
- return;
139
- }
140
- const record = body;
141
- // `envelope.idempotencyKey` is replayed as the `Idempotency-Key` header.
142
- // Older sealed bodies may also carry `idempotencyKey`/`clientTxId`; accept
143
- // and replay them byte-for-byte, but current requests do not duplicate the
144
- // key in JSON.
145
- if (path === '/v1/commits') {
146
- if (!Array.isArray(record.operations) || record.operations.length === 0) {
147
- context.addIssue({
148
- code: 'custom',
149
- path: ['request', 'body'],
150
- message: 'Commit-route body must carry operations',
151
- });
152
- }
153
- }
154
- else if (method === 'POST' && typeof record.id !== 'string') {
155
- context.addIssue({
156
- code: 'custom',
157
- path: ['request', 'body', 'id'],
158
- message: 'Model-create body must carry its entity id',
159
- });
160
- }
161
- else if (method === 'PATCH' &&
162
- (typeof record.data !== 'object' || record.data === null || Array.isArray(record.data))) {
163
- context.addIssue({
164
- code: 'custom',
165
- path: ['request', 'body', 'data'],
166
- message: 'Model-update body must carry a JSON object patch',
167
- });
168
- }
169
- });
170
- export function httpCommitEnvelopeRecordId(idempotencyKey, scopeNamespace) {
171
- if (!scopeNamespace) {
172
- return `${HTTP_COMMIT_ENVELOPE_PREFIX}${idempotencyKey}`;
173
- }
174
- const scopeId = uuidv5(scopeNamespace, HTTP_COMMIT_SCOPE_ID_NAMESPACE);
175
- return `${HTTP_COMMIT_ENVELOPE_PREFIX}${scopeId}:${idempotencyKey}`;
176
- }
177
- export function createDurableHttpCommitEnvelope(input) {
178
- const now = Date.now();
179
- const createdAt = input.createdAt ?? now;
180
- const sealedAt = input.sealedAt ?? now;
181
- const body = canonicalHttpCommitBody(input.request.body);
182
- return durableHttpCommitEnvelopeSchema.parse({
183
- id: httpCommitEnvelopeRecordId(input.idempotencyKey, input.scopeNamespace),
184
- type: 'http_commit_envelope',
185
- storageVersion: HTTP_COMMIT_ENVELOPE_VERSION,
186
- idempotencyKey: input.idempotencyKey,
187
- protocolVersion: PROTOCOL_VERSION,
188
- request: {
189
- method: input.request.method,
190
- path: input.request.path,
191
- body,
192
- },
193
- scopeNamespace: input.scopeNamespace,
194
- createdAt,
195
- sealedAt,
196
- ...(input.sequence !== undefined ? { sequence: input.sequence } : {}),
197
- timestamp: sealedAt,
198
- });
199
- }
200
- export function isHttpCommitReplayExpired(envelope, now = Date.now()) {
201
- // Connected-source mutation-log and customer idempotency keys are
202
- // permanent. Once acceptance is durable, age can no longer make replay
203
- // ambiguous; only the matching WAL echo may settle the envelope.
204
- if (envelope.acceptedAt !== undefined)
205
- return false;
206
- return now - envelope.sealedAt >= HTTP_COMMIT_REPLAY_WINDOW_MS;
207
- }
@@ -1,10 +0,0 @@
1
- /**
2
- * Identity shared by the durable write records.
3
- *
4
- * A retry must reuse the same non-empty key so the server can recognize the
5
- * same logical write. This is a persistence invariant, not a second commit
6
- * protocol.
7
- */
8
- import { z } from 'zod';
9
- export declare const idempotencyKeySchema: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
10
- export type IdempotencyKey = z.output<typeof idempotencyKeySchema>;
@@ -1,9 +0,0 @@
1
- /**
2
- * Identity shared by the durable write records.
3
- *
4
- * A retry must reuse the same non-empty key so the server can recognize the
5
- * same logical write. This is a persistence invariant, not a second commit
6
- * protocol.
7
- */
8
- import { z } from 'zod';
9
- export const idempotencyKeySchema = z.string().min(1).max(255).brand();
@@ -1,112 +0,0 @@
1
- /**
2
- * The persisted shape of a write awaiting a definitive outcome.
3
- *
4
- * Owns one authoritative union over the two durable commit envelopes — the
5
- * WebSocket envelope and its HTTP counterpart — so an injected store and the
6
- * engine that reads back from it agree on exactly one set of records. The
7
- * envelope schemas in this directory remain authoritative for their own fields;
8
- * this module only unions them.
9
- *
10
- * The port that persists these records is a behavior contract, not a persisted
11
- * shape, so it lives outside this directory in `src/durableWrites.ts`.
12
- */
13
- import { z } from 'zod';
14
- /** Every write shape that Ablo may ask an injected store to persist. */
15
- export declare const pendingWriteSchema: z.ZodUnion<readonly [z.ZodObject<{
16
- id: z.ZodString;
17
- type: z.ZodLiteral<"commit_envelope">;
18
- storageVersion: z.ZodLiteral<1>;
19
- origin: z.ZodEnum<{
20
- model_batch: "model_batch";
21
- atomic_commit: "atomic_commit";
22
- }>;
23
- idempotencyKey: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
24
- operations: z.ZodArray<z.ZodObject<{
25
- type: z.ZodEnum<{
26
- CREATE: "CREATE";
27
- UPDATE: "UPDATE";
28
- DELETE: "DELETE";
29
- ARCHIVE: "ARCHIVE";
30
- UNARCHIVE: "UNARCHIVE";
31
- }>;
32
- readAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
33
- onStale: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
34
- reject: "reject";
35
- overwrite: "overwrite";
36
- notify: "notify";
37
- }>>>;
38
- fenceToken: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
39
- model: z.ZodString;
40
- id: z.ZodString;
41
- input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
42
- transactionId: z.ZodOptional<z.ZodString>;
43
- options: z.ZodOptional<z.ZodObject<{
44
- idempotencyKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
45
- label: z.ZodOptional<z.ZodString>;
46
- }, z.core.$strict>>;
47
- }, z.core.$strip>>;
48
- sourceMutationIds: z.ZodDefault<z.ZodArray<z.ZodString>>;
49
- commitOptions: z.ZodDefault<z.ZodObject<{
50
- reads: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
51
- model: z.ZodString;
52
- id: z.ZodString;
53
- readAt: z.ZodNumber;
54
- fields: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
55
- onStale: z.ZodOptional<z.ZodEnum<{
56
- reject: "reject";
57
- overwrite: "overwrite";
58
- notify: "notify";
59
- }>>;
60
- }, z.core.$strip>, z.ZodObject<{
61
- group: z.ZodString;
62
- readAt: z.ZodNumber;
63
- onStale: z.ZodOptional<z.ZodEnum<{
64
- reject: "reject";
65
- overwrite: "overwrite";
66
- notify: "notify";
67
- }>>;
68
- }, z.core.$strip>]>>>>;
69
- track: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
70
- model: z.ZodString;
71
- id: z.ZodString;
72
- readAt: z.ZodOptional<z.ZodNumber>;
73
- }, z.core.$strip>, z.ZodObject<{
74
- group: z.ZodString;
75
- readAt: z.ZodOptional<z.ZodNumber>;
76
- }, z.core.$strip>]>>>>;
77
- }, z.core.$strict>>;
78
- scope: z.ZodOptional<z.ZodObject<{
79
- organizationId: z.ZodString;
80
- participantId: z.ZodString;
81
- namespace: z.ZodString;
82
- }, z.core.$strict>>;
83
- createdAt: z.ZodNumber;
84
- sealedAt: z.ZodNumber;
85
- acceptedAt: z.ZodOptional<z.ZodNumber>;
86
- correlationId: z.ZodOptional<z.ZodString>;
87
- sequence: z.ZodOptional<z.ZodNumber>;
88
- timestamp: z.ZodNumber;
89
- }, z.core.$strict>, z.ZodObject<{
90
- id: z.ZodString;
91
- type: z.ZodLiteral<"http_commit_envelope">;
92
- storageVersion: z.ZodLiteral<1>;
93
- idempotencyKey: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
94
- protocolVersion: z.ZodDefault<z.ZodNumber>;
95
- request: z.ZodObject<{
96
- method: z.ZodEnum<{
97
- DELETE: "DELETE";
98
- POST: "POST";
99
- PATCH: "PATCH";
100
- }>;
101
- path: z.ZodString;
102
- body: z.ZodString;
103
- }, z.core.$strict>;
104
- scopeNamespace: z.ZodString;
105
- createdAt: z.ZodNumber;
106
- sealedAt: z.ZodNumber;
107
- acceptedAt: z.ZodOptional<z.ZodNumber>;
108
- correlationId: z.ZodOptional<z.ZodString>;
109
- sequence: z.ZodOptional<z.ZodNumber>;
110
- timestamp: z.ZodNumber;
111
- }, z.core.$strict>]>;
112
- export type PendingWrite = z.infer<typeof pendingWriteSchema>;
@@ -1,20 +0,0 @@
1
- /**
2
- * The persisted shape of a write awaiting a definitive outcome.
3
- *
4
- * Owns one authoritative union over the two durable commit envelopes — the
5
- * WebSocket envelope and its HTTP counterpart — so an injected store and the
6
- * engine that reads back from it agree on exactly one set of records. The
7
- * envelope schemas in this directory remain authoritative for their own fields;
8
- * this module only unions them.
9
- *
10
- * The port that persists these records is a behavior contract, not a persisted
11
- * shape, so it lives outside this directory in `src/durableWrites.ts`.
12
- */
13
- import { z } from 'zod';
14
- import { durableCommitEnvelopeSchema } from './commitEnvelope.js';
15
- import { durableHttpCommitEnvelopeSchema } from './httpCommitEnvelope.js';
16
- /** Every write shape that Ablo may ask an injected store to persist. */
17
- export const pendingWriteSchema = z.union([
18
- durableCommitEnvelopeSchema,
19
- durableHttpCommitEnvelopeSchema,
20
- ]);
@@ -1,90 +0,0 @@
1
- /**
2
- * Builds the outgoing frames the sync WebSocket sends on the commit path, and
3
- * provides the single place claim events are traced. These are stateless
4
- * helpers that hold no socket state, so both the transport and its frame
5
- * dispatch can share them.
6
- */
7
- import type { CommitMessage } from '../wire/index.js';
8
- import type { CommitAck as CanonicalCommitAck } from '../wire/commit.js';
9
- import type { OnStaleMode, StaleNotification, ReadDependency, TrackDependency } from '../coordination/schema.js';
10
- import type { ClaimAcquired, ClaimGranted, ClaimQueued, ClaimLost, ClaimRejection, ClaimExpired } from '../coordination/schema.js';
11
- import type { Logger } from '../logger.js';
12
- import type { SocketObservability } from '../observability.js';
13
- /**
14
- * The value a commit acknowledgement resolves to. `notifications` is present
15
- * only when a guarded write (`onStale: 'notify'`) met a concurrent change; it
16
- * carries the advisory signal that lets the writer self-heal, and the same
17
- * signal also arrives on the `conflict:notified` event.
18
- */
19
- export type CommitAck = CanonicalCommitAck;
20
- /**
21
- * The slice of a queued client mutation the commit frame reads — a structural
22
- * port, so the reactive engine's fatter `MutationOperation` satisfies it
23
- * without this module importing the consumer package.
24
- */
25
- export interface CommitFrameOperation {
26
- readonly type: string;
27
- readonly model: string;
28
- readonly id: string;
29
- readonly input?: Record<string, unknown>;
30
- readonly transactionId?: string;
31
- readonly readAt?: number | null;
32
- readonly onStale?: OnStaleMode | null;
33
- readonly fenceToken?: number | null;
34
- }
35
- /**
36
- * Converts the client's list of {@link CommitFrameOperation} values into the wire
37
- * {@link CommitMessage} the server accepts. This is the one place the loosely
38
- * typed operation — its `type` is a string, and it carries client-only
39
- * `options` the server never reads — becomes the strict wire contract. Mapping
40
- * each field by hand means a change to {@link WireCommitOperation} fails to compile
41
- * here; the single `as` cast narrows the validated `type` to the wire union and
42
- * is the only place that loosening happens.
43
- */
44
- export declare function buildCommitFrame(operations: readonly CommitFrameOperation[], clientTxId: string, reads?: readonly ReadDependency[] | null, track?: readonly TrackDependency[] | null): CommitMessage;
45
- /**
46
- * Defensively validate the optional `notifications` array off a commit ack.
47
- * Untrusted wire data — a malformed entry is dropped rather than throwing,
48
- * so a bad notification never sinks an otherwise-successful commit.
49
- */
50
- export declare function parseNotifications(raw: unknown): StaleNotification[] | undefined;
51
- /** The reporting ports a claim trace writes through — supplied by the caller
52
- * (the frame dispatch passes its session's own ports). */
53
- export interface ClaimTracePorts {
54
- readonly logger: Logger;
55
- readonly observability: SocketObservability;
56
- }
57
- /**
58
- * Which frame reports each phase of a claim's life.
59
- *
60
- * The correspondence is real and was previously implicit: six dispatch handlers
61
- * each passed their own payload alongside a phase they picked by hand, and
62
- * nothing checked that the two matched. Stating it once means a caller cannot
63
- * label a rejection as an acquisition.
64
- *
65
- * Every value is the `z.infer` of the schema the dispatcher parsed with, so no
66
- * field is restated here — this maps existing types, it does not describe them.
67
- */
68
- interface ClaimFrameByPhase {
69
- acquired: ClaimAcquired;
70
- granted: ClaimGranted;
71
- queued: ClaimQueued;
72
- lost: ClaimLost;
73
- rejected: ClaimRejection;
74
- expired: ClaimExpired;
75
- }
76
- /**
77
- * The single place claim events are traced. Every `claim_*` frame passes
78
- * through here, so a developer debugging a collision gets one consistent record
79
- * — a console line and a structured capture — without each frame case
80
- * re-deriving the row and holder shape.
81
- *
82
- * The payload arrives already validated against its frame's schema, so this
83
- * reads it as the shape it is rather than re-narrowing an untyped record. That
84
- * distinction is not cosmetic: while this took `Record<string, unknown>` it
85
- * read `actor`, `participantKind`, and `description` off frames that carry none
86
- * of them, and every one of those reads silently produced `undefined` because a
87
- * string key never has to exist.
88
- */
89
- export declare function recordClaim<P extends keyof ClaimFrameByPhase>(ports: ClaimTracePorts, phase: P, payload: ClaimFrameByPhase[P]): void;
90
- export {};