@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,139 +0,0 @@
1
- /**
2
- * Defines how a model's rows are scoped to a tenant. Two forms live here, and the
3
- * separation between them is deliberate:
4
- *
5
- * 1. The canonical form, {@link Tenancy} — a discriminated union that every
6
- * consumer reads (provisioning and row-level security, introspection, the
7
- * runtime, and the CLI) and the shape that crosses the wire in `ModelJSON`.
8
- * One exhaustively switchable shape, so the type system enforces the isolation
9
- * boundary.
10
- * 2. The authoring form, {@link PolicyInput} — the `policy: { by }` option a
11
- * schema author writes. The name follows SQL row-level security, where a
12
- * policy is the rule that decides which rows a tenant may read.
13
- * {@link resolvePolicy} converts it to the canonical {@link Tenancy} when the
14
- * model is built, so the authoring vocabulary never reaches the wire or any
15
- * consumer.
16
- *
17
- * The canonical form is an exhaustively switchable discriminated union, so the type
18
- * system enforces the isolation boundary at every consumer. The authoring form is a
19
- * flat object whose `by` names the choice and whose per-branch rules are checked by a
20
- * refinement — the opt-out from tenant scoping (`{ by: 'none' }`) and the
21
- * source-derived case (`{ by: 'source' }`) are explicit, named values rather than
22
- * falsy flags, important because `none` makes an entire table readable across tenants.
23
- */
24
- import { z } from 'zod';
25
- /** The default physical tenancy column. This is the single canonical definition of that column name. */
26
- export declare const DEFAULT_ORG_COLUMN = "organization_id";
27
- /**
28
- * Scopes a table's rows through a parent table, for rows that carry no tenancy
29
- * column of their own (for example, blocks scoped through their section, report,
30
- * and organization). This is the canonical `parent` payload; authors write the
31
- * friendlier {@link PolicyInput} `{ by: 'parent', fk, parent }` form, which
32
- * {@link resolvePolicy} normalizes into this.
33
- */
34
- export declare const scopedViaRefSchema: z.ZodObject<{
35
- localKey: z.ZodString;
36
- parentTable: z.ZodString;
37
- parentKey: z.ZodOptional<z.ZodString>;
38
- parentOrgColumn: z.ZodOptional<z.ZodString>;
39
- }, z.core.$strip>;
40
- export type ScopedViaRef = z.infer<typeof scopedViaRefSchema>;
41
- /** How a model's rows are scoped to a tenant — the canonical, wire-facing form. */
42
- export declare const tenancySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
43
- kind: z.ZodLiteral<"column">;
44
- column: z.ZodString;
45
- }, z.core.$strip>, z.ZodObject<{
46
- kind: z.ZodLiteral<"parent">;
47
- via: z.ZodObject<{
48
- localKey: z.ZodString;
49
- parentTable: z.ZodString;
50
- parentKey: z.ZodOptional<z.ZodString>;
51
- parentOrgColumn: z.ZodOptional<z.ZodString>;
52
- }, z.core.$strip>;
53
- }, z.core.$strip>, z.ZodObject<{
54
- kind: z.ZodLiteral<"none">;
55
- }, z.core.$strip>, z.ZodObject<{
56
- kind: z.ZodLiteral<"source">;
57
- }, z.core.$strip>], "kind">;
58
- export type Tenancy = z.infer<typeof tenancySchema>;
59
- /**
60
- * The authoring form of tenancy — what a schema author writes as the model's
61
- * `policy` option. The name follows SQL row-level security, where a policy is the
62
- * rule that decides which rows a tenant may read.
63
- *
64
- * The four choices `by` can take:
65
- *
66
- * - `{ by: 'column' }` — a row-local tenancy column (the default). `column`
67
- * overrides the name (default {@link DEFAULT_ORG_COLUMN}).
68
- * - `{ by: 'parent', fk, parent }` — inherit tenancy through a foreign key when
69
- * this table has no tenancy column of its own. `parentKey` (default `'id'`) and
70
- * `parentTenantColumn` (default {@link DEFAULT_ORG_COLUMN}) are optional overrides.
71
- * - `{ by: 'source' }` — derive the organization from the connected source that
72
- * registered the model, for a single-tenant connected database that carries no
73
- * `organization_id` column. The registration is the tenant boundary.
74
- * - `{ by: 'none' }` — genuinely global or reference data. This makes the whole
75
- * table readable across tenants, so it is correct only for tables that have no tenant.
76
- *
77
- * The runtime schema is one flat object rather than a discriminated union: `by`
78
- * selects the branch, and the {@link https://zod.dev | superRefine} pass enforces
79
- * the per-branch field rules (`parent` requires `fk` and `parent`; the other three
80
- * take no branch fields). The exported {@link PolicyInput} type is hand-written as a
81
- * precise union so the compiler still requires the right fields per `by` — the flat
82
- * schema validates at runtime, the union guides at author time, and the type guard
83
- * below keeps the two from drifting.
84
- */
85
- export declare const policyInputSchema: z.ZodObject<{
86
- by: z.ZodEnum<{
87
- none: "none";
88
- source: "source";
89
- column: "column";
90
- parent: "parent";
91
- }>;
92
- column: z.ZodOptional<z.ZodString>;
93
- fk: z.ZodOptional<z.ZodString>;
94
- parent: z.ZodOptional<z.ZodString>;
95
- parentKey: z.ZodOptional<z.ZodString>;
96
- parentTenantColumn: z.ZodOptional<z.ZodString>;
97
- }, z.core.$strip>;
98
- /**
99
- * The precise authoring type. Hand-written rather than inferred from
100
- * {@link policyInputSchema} so the compiler enforces the per-branch fields the flat
101
- * runtime schema can only check at parse time — an author writing `{ by: 'parent' }`
102
- * gets a type error for the missing `fk`/`parent`, not a runtime one.
103
- */
104
- export type PolicyInput = {
105
- by: 'column';
106
- column?: string;
107
- } | {
108
- by: 'parent';
109
- fk: string;
110
- parent: string;
111
- parentKey?: string;
112
- parentTenantColumn?: string;
113
- } | {
114
- by: 'source';
115
- } | {
116
- by: 'none';
117
- };
118
- /**
119
- * Normalizes the authoring {@link PolicyInput} into the canonical {@link Tenancy}.
120
- * Called once, when the model is built, so that `ModelDef`, `ModelJSON`, and every
121
- * consumer see only the canonical union. Omitting `policy` defaults to a row-local
122
- * `organization_id` column.
123
- */
124
- export declare function resolvePolicy(input?: PolicyInput): Tenancy;
125
- /**
126
- * Reads the canonical {@link Tenancy} off an already-built model definition (or a
127
- * parsed `ModelJSON`), defaulting to a row-local `organization_id` column when it is
128
- * absent.
129
- *
130
- * This is the read-side helper. Consumers — provisioning and row-level security, the
131
- * membership resolver, DDL generation, and the CLI — call it to get a model's
132
- * tenancy without re-deriving the default each time. It is not the authoring
133
- * normalizer; that is {@link resolvePolicy}.
134
- */
135
- export declare function resolveTenancy(def: {
136
- tenancy?: Tenancy;
137
- }): Tenancy;
138
- /** The physical tenancy column for a column-scoped model, else `null`. */
139
- export declare function tenancyColumn(t: Tenancy): string | null;
@@ -1,190 +0,0 @@
1
- /**
2
- * Defines how a model's rows are scoped to a tenant. Two forms live here, and the
3
- * separation between them is deliberate:
4
- *
5
- * 1. The canonical form, {@link Tenancy} — a discriminated union that every
6
- * consumer reads (provisioning and row-level security, introspection, the
7
- * runtime, and the CLI) and the shape that crosses the wire in `ModelJSON`.
8
- * One exhaustively switchable shape, so the type system enforces the isolation
9
- * boundary.
10
- * 2. The authoring form, {@link PolicyInput} — the `policy: { by }` option a
11
- * schema author writes. The name follows SQL row-level security, where a
12
- * policy is the rule that decides which rows a tenant may read.
13
- * {@link resolvePolicy} converts it to the canonical {@link Tenancy} when the
14
- * model is built, so the authoring vocabulary never reaches the wire or any
15
- * consumer.
16
- *
17
- * The canonical form is an exhaustively switchable discriminated union, so the type
18
- * system enforces the isolation boundary at every consumer. The authoring form is a
19
- * flat object whose `by` names the choice and whose per-branch rules are checked by a
20
- * refinement — the opt-out from tenant scoping (`{ by: 'none' }`) and the
21
- * source-derived case (`{ by: 'source' }`) are explicit, named values rather than
22
- * falsy flags, important because `none` makes an entire table readable across tenants.
23
- */
24
- import { z } from 'zod';
25
- /** The default physical tenancy column. This is the single canonical definition of that column name. */
26
- export const DEFAULT_ORG_COLUMN = 'organization_id';
27
- /**
28
- * Scopes a table's rows through a parent table, for rows that carry no tenancy
29
- * column of their own (for example, blocks scoped through their section, report,
30
- * and organization). This is the canonical `parent` payload; authors write the
31
- * friendlier {@link PolicyInput} `{ by: 'parent', fk, parent }` form, which
32
- * {@link resolvePolicy} normalizes into this.
33
- */
34
- export const scopedViaRefSchema = z.object({
35
- /** Column on this table that points at the parent (for example, `'team_id'`). */
36
- localKey: z.string().min(1),
37
- /** Parent table name (e.g. `'team'`). */
38
- parentTable: z.string().min(1),
39
- /** Column on the parent that `localKey` references. Default `'id'`. */
40
- parentKey: z.string().min(1).optional(),
41
- /** Column on the parent holding the tenant id. Default {@link DEFAULT_ORG_COLUMN}. */
42
- parentOrgColumn: z.string().min(1).optional(),
43
- });
44
- /** How a model's rows are scoped to a tenant — the canonical, wire-facing form. */
45
- export const tenancySchema = z.discriminatedUnion('kind', [
46
- /** Row-local tenancy column (default name `organization_id`, overridable). */
47
- z.object({ kind: z.literal('column'), column: z.string().min(1) }),
48
- /** Scoped through a parent table's tenancy. */
49
- z.object({ kind: z.literal('parent'), via: scopedViaRefSchema }),
50
- /** Not tenant-scoped (global / reference data). */
51
- z.object({ kind: z.literal('none') }),
52
- /**
53
- * Scoped by the data source itself: the model carries no tenancy column, and the
54
- * owning organization is derived from the connected source that registered it — the
55
- * registration is the tenant boundary. This is the natural default for a
56
- * single-tenant connected database (`ablo connect`), which holds one org's rows and
57
- * so has no per-row `organization_id` to read. Carries no payload for the same
58
- * reason `none` does: the binding lives in the source registration, not the model.
59
- */
60
- z.object({ kind: z.literal('source') }),
61
- ]);
62
- /**
63
- * The authoring form of tenancy — what a schema author writes as the model's
64
- * `policy` option. The name follows SQL row-level security, where a policy is the
65
- * rule that decides which rows a tenant may read.
66
- *
67
- * The four choices `by` can take:
68
- *
69
- * - `{ by: 'column' }` — a row-local tenancy column (the default). `column`
70
- * overrides the name (default {@link DEFAULT_ORG_COLUMN}).
71
- * - `{ by: 'parent', fk, parent }` — inherit tenancy through a foreign key when
72
- * this table has no tenancy column of its own. `parentKey` (default `'id'`) and
73
- * `parentTenantColumn` (default {@link DEFAULT_ORG_COLUMN}) are optional overrides.
74
- * - `{ by: 'source' }` — derive the organization from the connected source that
75
- * registered the model, for a single-tenant connected database that carries no
76
- * `organization_id` column. The registration is the tenant boundary.
77
- * - `{ by: 'none' }` — genuinely global or reference data. This makes the whole
78
- * table readable across tenants, so it is correct only for tables that have no tenant.
79
- *
80
- * The runtime schema is one flat object rather than a discriminated union: `by`
81
- * selects the branch, and the {@link https://zod.dev | superRefine} pass enforces
82
- * the per-branch field rules (`parent` requires `fk` and `parent`; the other three
83
- * take no branch fields). The exported {@link PolicyInput} type is hand-written as a
84
- * precise union so the compiler still requires the right fields per `by` — the flat
85
- * schema validates at runtime, the union guides at author time, and the type guard
86
- * below keeps the two from drifting.
87
- */
88
- export const policyInputSchema = z
89
- .object({
90
- by: z.enum(['column', 'parent', 'none', 'source']),
91
- /** `by: 'column'` — override the physical tenancy column name. Default {@link DEFAULT_ORG_COLUMN}. */
92
- column: z.string().min(1).optional(),
93
- /** `by: 'parent'` — column on this table that points at the parent (for example, `'sectionId'`). */
94
- fk: z.string().min(1).optional(),
95
- /** `by: 'parent'` — parent table name (e.g. `'sections'`). */
96
- parent: z.string().min(1).optional(),
97
- /** `by: 'parent'` — column on the parent that `fk` references. Default `'id'`. */
98
- parentKey: z.string().min(1).optional(),
99
- /** `by: 'parent'` — column on the parent holding the tenant id. Default {@link DEFAULT_ORG_COLUMN}. */
100
- parentTenantColumn: z.string().min(1).optional(),
101
- })
102
- .superRefine((policy, ctx) => {
103
- if (policy.by === 'parent') {
104
- if (!policy.fk) {
105
- ctx.addIssue({
106
- code: z.ZodIssueCode.custom,
107
- path: ['fk'],
108
- message: "A `by: 'parent'` policy needs `fk` — the column on this table that points at the parent row whose tenancy it inherits.",
109
- });
110
- }
111
- if (!policy.parent) {
112
- ctx.addIssue({
113
- code: z.ZodIssueCode.custom,
114
- path: ['parent'],
115
- message: "A `by: 'parent'` policy needs `parent` — the name of the parent table this table is scoped through.",
116
- });
117
- }
118
- }
119
- // A `column` policy may carry `column`; the parent fields belong only to `parent`.
120
- // Flag a field that landed on the wrong branch so a typo doesn't silently no-op.
121
- const parentOnly = ['fk', 'parent', 'parentKey', 'parentTenantColumn'];
122
- if (policy.by !== 'parent') {
123
- for (const field of parentOnly) {
124
- if (policy[field] !== undefined) {
125
- ctx.addIssue({
126
- code: z.ZodIssueCode.custom,
127
- path: [field],
128
- message: `\`${field}\` only applies to a \`by: 'parent'\` policy; remove it or set \`by: 'parent'\`.`,
129
- });
130
- }
131
- }
132
- }
133
- if (policy.by !== 'column' && policy.column !== undefined) {
134
- ctx.addIssue({
135
- code: z.ZodIssueCode.custom,
136
- path: ['column'],
137
- message: "`column` only applies to a `by: 'column'` policy; remove it or set `by: 'column'`.",
138
- });
139
- }
140
- });
141
- const _policyInputAssignable = [
142
- true,
143
- true,
144
- ];
145
- void _policyInputAssignable;
146
- /**
147
- * Normalizes the authoring {@link PolicyInput} into the canonical {@link Tenancy}.
148
- * Called once, when the model is built, so that `ModelDef`, `ModelJSON`, and every
149
- * consumer see only the canonical union. Omitting `policy` defaults to a row-local
150
- * `organization_id` column.
151
- */
152
- export function resolvePolicy(input) {
153
- if (!input)
154
- return { kind: 'column', column: DEFAULT_ORG_COLUMN };
155
- switch (input.by) {
156
- case 'column':
157
- return { kind: 'column', column: input.column ?? DEFAULT_ORG_COLUMN };
158
- case 'parent':
159
- return {
160
- kind: 'parent',
161
- via: {
162
- localKey: input.fk,
163
- parentTable: input.parent,
164
- parentKey: input.parentKey,
165
- parentOrgColumn: input.parentTenantColumn,
166
- },
167
- };
168
- case 'source':
169
- return { kind: 'source' };
170
- case 'none':
171
- return { kind: 'none' };
172
- }
173
- }
174
- /**
175
- * Reads the canonical {@link Tenancy} off an already-built model definition (or a
176
- * parsed `ModelJSON`), defaulting to a row-local `organization_id` column when it is
177
- * absent.
178
- *
179
- * This is the read-side helper. Consumers — provisioning and row-level security, the
180
- * membership resolver, DDL generation, and the CLI — call it to get a model's
181
- * tenancy without re-deriving the default each time. It is not the authoring
182
- * normalizer; that is {@link resolvePolicy}.
183
- */
184
- export function resolveTenancy(def) {
185
- return def.tenancy ?? { kind: 'column', column: DEFAULT_ORG_COLUMN };
186
- }
187
- /** The physical tenancy column for a column-scoped model, else `null`. */
188
- export function tenancyColumn(t) {
189
- return t.kind === 'column' ? t.column : null;
190
- }
@@ -1,82 +0,0 @@
1
- /**
2
- * The transaction layer's seam — the surface the sync engine (and any other
3
- * caller) sits on. ADR 0013's thesis as an interface: the layer defines,
4
- * orders, settles, and authorizes changes; it holds no materialised state.
5
- *
6
- * `observe()` is the whole seam in one method. The sync engine is `observe()`
7
- * piped into a materializer — deltas → local store → IndexedDB → reactive
8
- * re-render — plus local optimistic mutations reconciled against `commit()` /
9
- * `settled()`. Everything reactive is downstream of that method; the
10
- * transaction layer never calls up into it.
11
- *
12
- * `participant` stays the WHO (user | agent | system), never the name of this.
13
- * The taught verbs map onto the seam directly: `create`/`update`/`delete` are
14
- * operations inside a `commit()` payload; `claim` is `claim()`; `track` rides
15
- * the commit payload's `track` field (a durable premise is a zero-operation
16
- * commit). Presence (`join`) is deliberately absent: it is live observation
17
- * over a socket, and it joins the seam when its core carrier type exists —
18
- * see docs/plans/transaction-core-language.md, Tier 3.
19
- *
20
- * This is the contract, not a runtime: nothing in this package implements it
21
- * yet. The first explicit implementation (a headless client, a test harness)
22
- * gains a compile-time conformance pin against this interface.
23
- */
24
- import type { CommitMessage } from './wire/frames.js';
25
- import type { CommitReceiptWire } from './wire/commit.js';
26
- import type { Delta, HeldClaim, ClaimTarget, ClaimLeaseOptions } from './types/streams.js';
27
- import type { ModelData } from './types/modelData.js';
28
- import type { ModelScope } from './types/index.js';
29
- /**
30
- * A commit's durable acceptance — `{ status: 'queued' }` with the correlation
31
- * the settlement feed later confirms. The wire layer names this
32
- * {@link CommitReceiptWire}; the seam names it plainly.
33
- */
34
- export type CommitReceipt = CommitReceiptWire;
35
- /**
36
- * The seam's read grammar for {@link TransactionLayer.list} — filter, order,
37
- * and page through settled rows. Mirrors the taught list options
38
- * (`where` / `orderBy` / `limit` / `offset` / `state`) without binding the
39
- * seam to the client's local-read machinery.
40
- */
41
- export interface ListQuery {
42
- /** Equality filter on field values. */
43
- where?: ModelData;
44
- /** Sort order, field → direction. */
45
- orderBy?: Record<string, 'asc' | 'desc'>;
46
- limit?: number;
47
- offset?: number;
48
- /** Lifecycle filter; defaults to `'live'`. */
49
- state?: `${ModelScope}`;
50
- }
51
- /**
52
- * The transaction layer. Reads return settled state, point-in-time — never a
53
- * reactive subscription. A write is an intent submitted through `commit()`;
54
- * durable acceptance is the receipt (`queued`), and `settled()` resolves when
55
- * the sync log has appended it (`confirmed`).
56
- */
57
- export interface TransactionLayer {
58
- /** Authentication: mint or renew the short-lived credential (`ek_`). */
59
- ready(): Promise<void>;
60
- /** Read one settled row by id, or `null` when absent. */
61
- get(model: string, id: string): Promise<ModelData | null>;
62
- /** Read settled rows matching a {@link ListQuery}. */
63
- list(model: string, query?: ListQuery): Promise<ModelData[]>;
64
- /**
65
- * Submit a batch of operations — with its idempotent `clientTxId`, its
66
- * `reads` premise, and any durable `track` registrations — and receive
67
- * durable acceptance.
68
- */
69
- commit(payload: CommitMessage['payload']): Promise<CommitReceipt>;
70
- /** Resolve when the receipt's operations have appended to the sync log. */
71
- settled(receipt: CommitReceipt): Promise<void>;
72
- /**
73
- * Take a FIFO lease with a fence token on a target; release through the
74
- * handle (`await using` disposes it).
75
- */
76
- claim(target: ClaimTarget, options?: ClaimLeaseOptions): Promise<HeldClaim>;
77
- /**
78
- * The authoritative change feed, scoped to one or more sync groups —
79
- * omitted, everything the credential can see.
80
- */
81
- observe(scope?: string | readonly string[]): AsyncIterable<Delta>;
82
- }
@@ -1,24 +0,0 @@
1
- /**
2
- * The transaction layer's seam — the surface the sync engine (and any other
3
- * caller) sits on. ADR 0013's thesis as an interface: the layer defines,
4
- * orders, settles, and authorizes changes; it holds no materialised state.
5
- *
6
- * `observe()` is the whole seam in one method. The sync engine is `observe()`
7
- * piped into a materializer — deltas → local store → IndexedDB → reactive
8
- * re-render — plus local optimistic mutations reconciled against `commit()` /
9
- * `settled()`. Everything reactive is downstream of that method; the
10
- * transaction layer never calls up into it.
11
- *
12
- * `participant` stays the WHO (user | agent | system), never the name of this.
13
- * The taught verbs map onto the seam directly: `create`/`update`/`delete` are
14
- * operations inside a `commit()` payload; `claim` is `claim()`; `track` rides
15
- * the commit payload's `track` field (a durable premise is a zero-operation
16
- * commit). Presence (`join`) is deliberately absent: it is live observation
17
- * over a socket, and it joins the seam when its core carrier type exists —
18
- * see docs/plans/transaction-core-language.md, Tier 3.
19
- *
20
- * This is the contract, not a runtime: nothing in this package implements it
21
- * yet. The first explicit implementation (a headless client, a test harness)
22
- * gains a compile-time conformance pin against this interface.
23
- */
24
- export {};
@@ -1,143 +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
- export declare const COMMIT_ENVELOPE_VERSION: 1;
11
- export declare const COMMIT_ENVELOPE_RECORD_PREFIX = "commit-envelope:";
12
- /** One transaction's position in a commit; this is not the envelope itself. */
13
- export declare const commitEnvelopeMemberSchema: z.ZodObject<{
14
- idempotencyKey: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
15
- operationIndex: z.ZodNumber;
16
- operationCount: z.ZodNumber;
17
- sealedAt: z.ZodOptional<z.ZodNumber>;
18
- sequence: z.ZodOptional<z.ZodNumber>;
19
- }, z.core.$strict>;
20
- export type CommitEnvelopeMember = z.infer<typeof commitEnvelopeMemberSchema>;
21
- /** One operation stored exactly as the current commit transport sends it. */
22
- export declare const durableCommitOperationSchema: z.ZodObject<{
23
- type: z.ZodEnum<{
24
- CREATE: "CREATE";
25
- UPDATE: "UPDATE";
26
- DELETE: "DELETE";
27
- ARCHIVE: "ARCHIVE";
28
- UNARCHIVE: "UNARCHIVE";
29
- }>;
30
- readAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
31
- onStale: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
32
- reject: "reject";
33
- overwrite: "overwrite";
34
- notify: "notify";
35
- }>>>;
36
- fenceToken: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
37
- model: z.ZodString;
38
- id: z.ZodString;
39
- input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
40
- transactionId: z.ZodOptional<z.ZodString>;
41
- options: z.ZodOptional<z.ZodObject<{
42
- idempotencyKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
43
- label: z.ZodOptional<z.ZodString>;
44
- }, z.core.$strict>>;
45
- }, z.core.$strip>;
46
- export type DurableCommitOperation = z.infer<typeof durableCommitOperationSchema>;
47
- export type DurableCommitOperationInput = z.input<typeof durableCommitOperationSchema>;
48
- export declare const commitOutboxScopeSchema: z.ZodObject<{
49
- organizationId: z.ZodString;
50
- participantId: z.ZodString;
51
- namespace: z.ZodString;
52
- }, z.core.$strict>;
53
- export type CommitOutboxScope = z.infer<typeof commitOutboxScopeSchema>;
54
- /**
55
- * One crash-durable logical commit. Keeping every operation in one record makes
56
- * membership and order atomic: recovery can observe the old record or the new
57
- * record, never half an envelope.
58
- */
59
- export declare const durableCommitEnvelopeSchema: z.ZodObject<{
60
- id: z.ZodString;
61
- type: z.ZodLiteral<"commit_envelope">;
62
- storageVersion: z.ZodLiteral<1>;
63
- origin: z.ZodEnum<{
64
- model_batch: "model_batch";
65
- atomic_commit: "atomic_commit";
66
- }>;
67
- idempotencyKey: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
68
- operations: z.ZodArray<z.ZodObject<{
69
- type: z.ZodEnum<{
70
- CREATE: "CREATE";
71
- UPDATE: "UPDATE";
72
- DELETE: "DELETE";
73
- ARCHIVE: "ARCHIVE";
74
- UNARCHIVE: "UNARCHIVE";
75
- }>;
76
- readAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
77
- onStale: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
78
- reject: "reject";
79
- overwrite: "overwrite";
80
- notify: "notify";
81
- }>>>;
82
- fenceToken: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
83
- model: z.ZodString;
84
- id: z.ZodString;
85
- input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
86
- transactionId: z.ZodOptional<z.ZodString>;
87
- options: z.ZodOptional<z.ZodObject<{
88
- idempotencyKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
89
- label: z.ZodOptional<z.ZodString>;
90
- }, z.core.$strict>>;
91
- }, z.core.$strip>>;
92
- sourceMutationIds: z.ZodDefault<z.ZodArray<z.ZodString>>;
93
- commitOptions: z.ZodDefault<z.ZodObject<{
94
- reads: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
95
- model: z.ZodString;
96
- id: z.ZodString;
97
- readAt: z.ZodNumber;
98
- fields: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
99
- onStale: z.ZodOptional<z.ZodEnum<{
100
- reject: "reject";
101
- overwrite: "overwrite";
102
- notify: "notify";
103
- }>>;
104
- }, z.core.$strip>, z.ZodObject<{
105
- group: z.ZodString;
106
- readAt: z.ZodNumber;
107
- onStale: z.ZodOptional<z.ZodEnum<{
108
- reject: "reject";
109
- overwrite: "overwrite";
110
- notify: "notify";
111
- }>>;
112
- }, z.core.$strip>]>>>>;
113
- track: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
114
- model: z.ZodString;
115
- id: z.ZodString;
116
- readAt: z.ZodOptional<z.ZodNumber>;
117
- }, z.core.$strip>, z.ZodObject<{
118
- group: z.ZodString;
119
- readAt: z.ZodOptional<z.ZodNumber>;
120
- }, z.core.$strip>]>>>>;
121
- }, z.core.$strict>>;
122
- scope: z.ZodOptional<z.ZodObject<{
123
- organizationId: z.ZodString;
124
- participantId: z.ZodString;
125
- namespace: z.ZodString;
126
- }, z.core.$strict>>;
127
- createdAt: z.ZodNumber;
128
- sealedAt: z.ZodNumber;
129
- acceptedAt: z.ZodOptional<z.ZodNumber>;
130
- correlationId: z.ZodOptional<z.ZodString>;
131
- sequence: z.ZodOptional<z.ZodNumber>;
132
- timestamp: z.ZodNumber;
133
- }, z.core.$strict>;
134
- export type DurableCommitEnvelope = z.infer<typeof durableCommitEnvelopeSchema>;
135
- export declare function commitEnvelopeRecordId(idempotencyKey: string): string;
136
- /** Constructs validated member metadata when an in-memory batch is formed. */
137
- export declare function createCommitEnvelopeMember(value: z.input<typeof commitEnvelopeMemberSchema>): CommitEnvelopeMember;
138
- /**
139
- * Freezes the exact JSON request that will be persisted and sent. The shared
140
- * snapshot contract makes framework proxies plain and rejects values that
141
- * would be lost or corrupted by JSON serialization.
142
- */
143
- export declare function createDurableCommitEnvelope(value: Omit<z.input<typeof durableCommitEnvelopeSchema>, 'id' | 'type' | 'storageVersion' | 'timestamp'>): DurableCommitEnvelope;