@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,491 +0,0 @@
1
- /**
2
- * Turns a schema definition into the ordered Postgres DDL that provisions and
3
- * migrates its tables. A schema built with `defineSchema(...)` and serialized to
4
- * {@link SchemaJSON} is the single source of truth, and this module lowers it to
5
- * ordered SQL strings.
6
- *
7
- * The same generators run wherever tables are created — in a hosted server
8
- * applying them to the Postgres it manages, and in the `ablo migrate` CLI
9
- * applying them to a customer's own Postgres — so the SQL, from column types to
10
- * row-level security to enum checks, is identical no matter who runs it.
11
- *
12
- * Everything here is pure: it returns strings and touches no database. The
13
- * execution side — the transaction and advisory lock that actually run the
14
- * statements — lives with each caller, because it is coupled to that caller's
15
- * Postgres client and error types.
16
- *
17
- * - {@link generateProvisionPlan} builds an additive, idempotent plan (CREATE
18
- * and ADD … IF NOT EXISTS, plus row-level security) that never loses data —
19
- * the "create my tables" primitive.
20
- * - {@link generateMigrationPlan} is its destructive-aware counterpart, driven
21
- * by a {@link diffSchema} step list: drops, renames, type casts, and
22
- * backfills.
23
- */
24
- import { AbloValidationError } from '../transaction/errors.js';
25
- import { resolveTenancy, tenancyColumn } from '../transaction/schema/tenancy.js';
26
- // ── Identifier safety ────────────────────────────────────────────────────────
27
- /** Postgres unquoted-identifier-safe slug: lowercase `[a-z0-9_]`, ≤50 chars. */
28
- function slug(raw) {
29
- const s = raw.toLowerCase().replace(/[^a-z0-9]+/g, '_').replace(/^_+|_+$/g, '');
30
- return s.slice(0, 50) || 'x';
31
- }
32
- /** Per-app schema name for an app (organization) id. */
33
- export function appSchemaName(organizationId) {
34
- return `app_${slug(organizationId)}`;
35
- }
36
- export function camelToSnake(identifier) {
37
- return identifier.replace(/[A-Z]/g, (ch) => `_${ch.toLowerCase()}`);
38
- }
39
- /**
40
- * Converts snake_case to camelCase — the inverse of {@link camelToSnake}. This
41
- * is the read-side translation: a column read back from a customer's own
42
- * database maps to the same JavaScript field the SDK wrote, so
43
- * `camelToSnake('operatorId') === 'operator_id'` and
44
- * `snakeToCamel('operator_id') === 'operatorId'` round-trip.
45
- */
46
- export function snakeToCamel(identifier) {
47
- return identifier.replace(/_+([a-z0-9])/g, (_, ch) => ch.toUpperCase());
48
- }
49
- /** Quote an identifier (defense-in-depth; inputs are already slug/snake). */
50
- export function q(identifier) {
51
- return `"${identifier.replace(/"/g, '""')}"`;
52
- }
53
- // ── Field type mapping ───────────────────────────────────────────────────────
54
- export function sqlType(fieldType) {
55
- switch (fieldType) {
56
- case 'string':
57
- case 'enum':
58
- return 'TEXT';
59
- case 'number':
60
- // DOUBLE PRECISION, not INTEGER — a Zod `number` may be fractional and
61
- // truncating to INTEGER is silent data loss.
62
- return 'DOUBLE PRECISION';
63
- case 'boolean':
64
- return 'BOOLEAN';
65
- case 'date':
66
- return 'TIMESTAMPTZ';
67
- case 'json':
68
- default:
69
- return 'JSONB';
70
- }
71
- }
72
- const BASE_COLUMNS = new Set(['id', 'organization_id', 'created_by', 'created_at', 'updated_at']);
73
- // ── Foreign keys (relation-driven, sync-safe) ────────────────────────────────
74
- /**
75
- * A Postgres-identifier-safe constraint name ≤63 bytes. When the natural
76
- * `<table>_<col>_<suffix>` exceeds the limit, fall back to a deterministic
77
- * hashed form so the name stays stable and matches what Postgres actually stores
78
- * — a silently-truncated name would never match the DO-block existence guard,
79
- * breaking idempotency (re-adds every push) and risking prefix collisions.
80
- */
81
- function constraintName(table, col, suffix) {
82
- const full = `${table}_${col}_${suffix}`;
83
- if (full.length <= 63)
84
- return full;
85
- let h = 5381;
86
- for (let i = 0; i < full.length; i++)
87
- h = ((h * 33) + full.charCodeAt(i)) >>> 0;
88
- const hash = h.toString(36);
89
- const prefix = full.slice(0, Math.max(1, 63 - suffix.length - hash.length - 2));
90
- return `${prefix}_${hash}_${suffix}`;
91
- }
92
- /**
93
- * Builds the foreign-key constraints for a model's belongsTo relations that opt
94
- * in by setting `{ fk: true }`.
95
- *
96
- * The `fk` marker is deliberately separate from `parent`: `parent` controls
97
- * sync-group fan-out and visibility, while `fk` requests physical referential
98
- * integrity in the database. A relation sets `fk` only when its target lives in
99
- * the same database, is written in the same commit, and is a strong, contained
100
- * entity. Soft references — provenance or template pointers such as
101
- * `sourceSlideId` or `templateId` — stay plain columns; a hard foreign key there
102
- * would reject a write that points across scopes or at an absent row and break
103
- * sync.
104
- *
105
- * On a live, populated table a plain `ADD CONSTRAINT` takes a heavy lock and
106
- * scans the whole child table, which would freeze writes on a customer's
107
- * production database. To avoid that, the constraint is added `NOT VALID`
108
- * (instant, no scan, brief lock) inside the transaction, and the existing-row
109
- * check (`VALIDATE CONSTRAINT`, which allows concurrent writes) plus the child
110
- * index (`CREATE INDEX CONCURRENTLY`) are returned separately in {@link
111
- * ForeignKeyDdl.concurrent}, to run after commit, outside any transaction, and
112
- * best-effort: if existing data violates a freshly added constraint the
113
- * validation is skipped (logged, never fatal), the constraint still enforces
114
- * every new write, and nothing is destroyed.
115
- *
116
- * The constraint is a `DEFERRABLE INITIALLY DEFERRED` integrity guard with `ON
117
- * DELETE NO ACTION`; it never mutates a child row itself. A `SET NULL` or
118
- * `CASCADE` action would change data in the database with no matching
119
- * sync_delta — invisible to other clients until they re-bootstrap — and would
120
- * override the application layer's own onDelete handling. The application layer
121
- * owns deletes and nullification and emits the deltas; the deferred check only
122
- * verifies, at commit time (so a same-batch child-before-parent write and the
123
- * application's own cascade both pass), that integrity holds, failing loudly
124
- * only when a dangling reference is left behind.
125
- *
126
- * Emission is idempotent and authoritative: a same-named constraint that is not
127
- * deferrable or carries the wrong delete action (a hand-added or older foreign
128
- * key) is dropped and recreated, while an already-correct one is left untouched
129
- * with no revalidation cost. It runs in a final pass, after every referenced
130
- * table exists.
131
- *
132
- * The foreign-key column is resolved the same way the table loop names columns
133
- * (`fieldMeta.column ?? camelToSnake(field)`), not from `rel.foreignKeyColumn`:
134
- * the table loop ignores relation casing, so trusting `foreignKeyColumn` would
135
- * mismatch the real column whenever `casing` is unset.
136
- */
137
- function foreignKeyStatements(table, model, models, qs) {
138
- const qt = `${qs}.${q(table)}`;
139
- // The model's provisioned column set — guard so a relation whose FK field
140
- // isn't actually declared (no column) never produces a broken ALTER.
141
- const orgCol = tenancyColumn(resolveTenancy(model));
142
- const columns = new Set(['id', 'created_by', 'created_at', 'updated_at']);
143
- if (orgCol)
144
- columns.add(orgCol);
145
- for (const [fieldName, meta] of Object.entries(model.fields)) {
146
- columns.add(meta.column ?? camelToSnake(fieldName));
147
- }
148
- const statements = [];
149
- const concurrent = [];
150
- for (const rel of Object.values(model.relations)) {
151
- if (rel.type !== 'belongsTo')
152
- continue; // only relations whose FK column lives on this table
153
- if (rel.options?.fk !== true)
154
- continue; // explicit `fk` marker — decoupled from `parent` (visibility)
155
- const targetModel = models[rel.target];
156
- if (!targetModel)
157
- continue; // target not provisioned into this DB → can't reference it
158
- if ((targetModel.plane ?? 'tenant') === 'control')
159
- continue; // control-plane table absent in a tenant DB
160
- const col = model.fields[rel.foreignKey]?.column ?? camelToSnake(rel.foreignKey);
161
- if (!columns.has(col))
162
- continue; // FK field isn't a provisioned column
163
- const targetTable = targetModel.tableName ?? rel.target;
164
- const cname = constraintName(table, col, 'fkey');
165
- const lit = cname.replace(/'/g, "''");
166
- const iname = constraintName(table, col, 'idx');
167
- const targetQt = `${qs}.${q(targetTable)}`;
168
- // In-tx: authoritative create as NOT VALID — instant, no child-table scan,
169
- // only a brief lock. confdeltype 'a' = NO ACTION; recreate only when absent /
170
- // not deferrable / wrong delete action, so a correct constraint is untouched.
171
- statements.push(`DO $$ BEGIN\n` +
172
- ` IF EXISTS (SELECT 1 FROM pg_constraint WHERE conname = '${lit}' AND (NOT condeferrable OR confdeltype <> 'a')) THEN\n` +
173
- ` ALTER TABLE ${qt} DROP CONSTRAINT ${q(cname)};\n` +
174
- ` END IF;\n` +
175
- ` IF NOT EXISTS (SELECT 1 FROM pg_constraint WHERE conname = '${lit}') THEN\n` +
176
- ` ALTER TABLE ${qt} ADD CONSTRAINT ${q(cname)} FOREIGN KEY (${q(col)}) ` +
177
- `REFERENCES ${targetQt} (${q('id')}) ON DELETE NO ACTION DEFERRABLE INITIALLY DEFERRED NOT VALID;\n` +
178
- ` END IF;\nEND $$;`);
179
- // Post-commit, non-blocking: validate existing rows (SHARE UPDATE EXCLUSIVE,
180
- // allows concurrent writes) then index the child column (Postgres does not
181
- // auto-index the referencing column → parent deletes would seq-scan it).
182
- concurrent.push(`ALTER TABLE ${qt} VALIDATE CONSTRAINT ${q(cname)};`);
183
- concurrent.push(`CREATE INDEX CONCURRENTLY IF NOT EXISTS ${q(iname)} ON ${qt} (${q(col)});`);
184
- }
185
- return { statements, concurrent };
186
- }
187
- // ── Provisioning (additive, idempotent) ─────────────────────────────────────
188
- /**
189
- * Builds the additive, idempotent provisioning plan for an app. Pure — it does
190
- * not touch a database.
191
- *
192
- * `targetSchema` is where the tables live: a per-app Postgres schema such as
193
- * `app_<id>`, or `public` when the database itself is the isolation boundary
194
- * (for example a customer's own database). For `public` the `CREATE SCHEMA`
195
- * statement is skipped, since it always exists.
196
- */
197
- export function generateProvisionPlan(schema, targetSchema, opts = {}) {
198
- const appSchema = targetSchema;
199
- const qs = q(appSchema);
200
- const statements = appSchema === 'public' ? [] : [`CREATE SCHEMA IF NOT EXISTS ${qs};`];
201
- const concurrent = [];
202
- for (const [key, model] of Object.entries(schema.models)) {
203
- // Control-plane models (the engine's own sync log, attribution, and audit
204
- // tables) are never emitted into a tenant database — only `tenant`-plane
205
- // models are. A model with no declared plane defaults to `tenant`. This
206
- // declared boundary is what makes the set of tables a customer's own
207
- // database receives derivable instead of hand-coded.
208
- if ((model.plane ?? 'tenant') === 'control')
209
- continue;
210
- // Default the physical table to the model key when `tableName` is omitted —
211
- // same fallback the migration path uses (`tableOfModel: m.tableName ?? key`).
212
- // Without this, a schema that doesn't set `tableName` (e.g. the `ablo init`
213
- // starter) provisions zero tables.
214
- const table = model.tableName ?? key;
215
- const qt = `${qs}.${q(table)}`;
216
- // Base columns are schema-driven, not blanket. `organization_id` (and its
217
- // index + tenant-isolation RLS below) is emitted only for org-scoped models.
218
- // A model that declares `orgScoped: false` (users, organizations, and other
219
- // tables scoped via a FK / app layer) genuinely has no `organization_id`
220
- // column — forcing one would add a NOT NULL column that fails on existing
221
- // rows and contradicts the model's own declaration.
222
- // Tenancy column: present only for column-scoped models, with the
223
- // configured name (default `organization_id`). `parent`/`none` tenancy emit
224
- // no tenancy column — they're scoped via a parent FK or not at all.
225
- const orgCol = tenancyColumn(resolveTenancy(model));
226
- const baseColumns = [
227
- ` ${q('id')} TEXT PRIMARY KEY,`,
228
- ...(orgCol ? [` ${q(orgCol)} TEXT NOT NULL,`] : []),
229
- ` ${q('created_by')} TEXT,`,
230
- ` ${q('created_at')} TIMESTAMPTZ NOT NULL DEFAULT NOW(),`,
231
- ` ${q('updated_at')} TIMESTAMPTZ NOT NULL DEFAULT NOW()`,
232
- ];
233
- statements.push(`CREATE TABLE IF NOT EXISTS ${qt} (\n${baseColumns.join('\n')}\n);`);
234
- for (const [fieldName, meta] of Object.entries(model.fields)) {
235
- const col = meta.column ?? camelToSnake(fieldName);
236
- if (BASE_COLUMNS.has(col) || col === orgCol)
237
- continue;
238
- statements.push(`ALTER TABLE ${qt} ADD COLUMN IF NOT EXISTS ${q(col)} ${sqlType(meta.type)};`);
239
- if (meta.type === 'enum' && meta.enumValues && meta.enumValues.length > 0) {
240
- const cname = `${table}_${col}_enum`;
241
- const allowed = meta.enumValues.map((v) => `'${v.replace(/'/g, "''")}'`).join(', ');
242
- statements.push(`DO $$ BEGIN\n` +
243
- ` IF NOT EXISTS (SELECT 1 FROM pg_constraint WHERE conname = '${cname}') THEN\n` +
244
- ` ALTER TABLE ${qt} ADD CONSTRAINT ${q(cname)} CHECK (${q(col)} IN (${allowed}));\n` +
245
- ` END IF;\n` +
246
- `END $$;`);
247
- }
248
- }
249
- // Org index + tenant-isolation RLS only where there's an `organization_id`
250
- // to isolate on. Non-org-scoped tables rely on FK/app-layer scoping.
251
- if (orgCol) {
252
- statements.push(`CREATE INDEX IF NOT EXISTS ${q(`${table}_${orgCol}_idx`)} ON ${qt} (${q(orgCol)});`);
253
- statements.push(`ALTER TABLE ${qt} ENABLE ROW LEVEL SECURITY;`);
254
- statements.push(`ALTER TABLE ${qt} FORCE ROW LEVEL SECURITY;`);
255
- const policy = `${table}_tenant_isolation`;
256
- const predicate = `${q(orgCol)} = current_setting('app.current_org_id', true)`;
257
- statements.push(`DROP POLICY IF EXISTS ${q(policy)} ON ${qt};`);
258
- statements.push(`CREATE POLICY ${q(policy)} ON ${qt}\n USING (${predicate})\n WITH CHECK (${predicate});`);
259
- }
260
- }
261
- // Foreign keys (opt-in) — a final pass so every referenced table already
262
- // exists when its constraint is added.
263
- if (opts.foreignKeys) {
264
- for (const [key, m] of Object.entries(schema.models)) {
265
- if ((m.plane ?? 'tenant') === 'control')
266
- continue;
267
- const t = m.tableName ?? key;
268
- const fk = foreignKeyStatements(t, m, schema.models, qs);
269
- statements.push(...fk.statements);
270
- concurrent.push(...fk.concurrent);
271
- }
272
- }
273
- return { appSchema, statements, concurrent };
274
- }
275
- // ── Migration (destructive-aware, diff-driven) ──────────────────────────────
276
- function enumCheckStatements(table, col, qt, values) {
277
- const cname = `${table}_${col}_enum`;
278
- const stmts = [`ALTER TABLE ${qt} DROP CONSTRAINT IF EXISTS ${q(cname)};`];
279
- if (values.length > 0) {
280
- const allowed = values.map((v) => `'${v.replace(/'/g, "''")}'`).join(', ');
281
- stmts.push(`ALTER TABLE ${qt} ADD CONSTRAINT ${q(cname)} CHECK (${q(col)} IN (${allowed}));`);
282
- }
283
- return stmts;
284
- }
285
- function indexName(table, col) {
286
- return `${table}_${col}_idx`;
287
- }
288
- function columnNameOf(fieldName, meta) {
289
- return meta?.column ?? camelToSnake(fieldName);
290
- }
291
- /**
292
- * Encode a constant backfill value as a typed SQL literal. Inputs are operator-
293
- * supplied (via the authed push), but we still encode by the field's declared
294
- * type and escape strings rather than interpolate raw — defense-in-depth.
295
- */
296
- function sqlLiteral(value, fieldType) {
297
- switch (fieldType) {
298
- case 'number':
299
- if (typeof value !== 'number' || !Number.isFinite(value)) {
300
- throw new AbloValidationError(`backfill for a number field must be a finite number, got ${JSON.stringify(value)}`, { code: 'schema_definition_invalid' });
301
- }
302
- return String(value);
303
- case 'boolean':
304
- return value ? 'TRUE' : 'FALSE';
305
- case 'date':
306
- return `'${String(value).replace(/'/g, "''")}'::timestamptz`;
307
- case 'json':
308
- return `'${JSON.stringify(value).replace(/'/g, "''")}'::jsonb`;
309
- case 'string':
310
- case 'enum':
311
- default:
312
- return `'${String(value).replace(/'/g, "''")}'`;
313
- }
314
- }
315
- /**
316
- * Lower an ordered migration step list to DDL. `next` is the schema being pushed
317
- * (the target column shapes are read from it), `prev` the active one (used to
318
- * resolve the *old* table name on a model rename).
319
- */
320
- export function generateMigrationPlan(steps, opts) {
321
- const { prev, next, targetSchema, backfills = [], foreignKeys = false } = opts;
322
- const qs = q(targetSchema);
323
- const statements = [];
324
- const concurrent = [];
325
- // The app schema must exist before any statement targets it. On a fresh
326
- // org's first push (`prev = null`) the migration plan is the provisioning —
327
- // `app_<orgId>` has never been created, and skipping this line made every
328
- // first push die with `3F000 invalid_schema_name` at statement 0. Idempotent
329
- // (`IF NOT EXISTS`), so emitting it on every later migration is free.
330
- if (steps.length > 0 && targetSchema !== 'public') {
331
- statements.push(`CREATE SCHEMA IF NOT EXISTS ${qs};`);
332
- }
333
- const qtFor = (table) => `${qs}.${q(table)}`;
334
- const tableOfModel = (schema, key) => {
335
- const m = schema?.models[key];
336
- if (!m)
337
- return null;
338
- return m.tableName ?? key;
339
- };
340
- const backfillFor = (model, field) => backfills.find((b) => b.model === model && b.field === field);
341
- for (const step of steps) {
342
- switch (step.kind) {
343
- case 'create_model': {
344
- // Reuse the provisioner for the full table (base cols + fields + enum
345
- // checks + RLS), minus its `CREATE SCHEMA` (the plan header above
346
- // already emitted it once — don't repeat it per model).
347
- const def = next.models[step.model];
348
- if (!def)
349
- break;
350
- const sub = { v: next.v, models: { [step.model]: def }, identityRoles: next.identityRoles };
351
- for (const s of generateProvisionPlan(sub, targetSchema).statements) {
352
- if (!s.startsWith('CREATE SCHEMA'))
353
- statements.push(s);
354
- }
355
- break;
356
- }
357
- case 'drop_model':
358
- statements.push(`DROP TABLE IF EXISTS ${qtFor(step.tableName)};`);
359
- break;
360
- case 'rename_model': {
361
- const fromTable = tableOfModel(prev, step.from);
362
- const toTable = tableOfModel(next, step.to);
363
- // A logical model rename only needs SQL when the physical table name
364
- // actually changes; if tableName is unchanged the rename is metadata.
365
- if (fromTable && toTable && fromTable !== toTable) {
366
- statements.push(`ALTER TABLE ${qtFor(fromTable)} RENAME TO ${q(toTable)};`);
367
- }
368
- break;
369
- }
370
- case 'add_field': {
371
- const table = tableOfModel(next, step.model);
372
- if (!table)
373
- break;
374
- const qt = qtFor(table);
375
- const col = columnNameOf(step.field, step.meta);
376
- // Added nullable first (the column is born NULL on every existing row).
377
- statements.push(`ALTER TABLE ${qt} ADD COLUMN IF NOT EXISTS ${q(col)} ${sqlType(step.meta.type)};`);
378
- if (step.meta.type === 'enum' && step.meta.enumValues?.length) {
379
- statements.push(...enumCheckStatements(table, col, qt, step.meta.enumValues));
380
- }
381
- // Backfill + enforce NOT NULL only with a supplied seed value. Without
382
- // one, a required field stays nullable (gated `unexecutable` upstream).
383
- const addBf = backfillFor(step.model, step.field);
384
- if (addBf !== undefined) {
385
- statements.push(`UPDATE ${qt} SET ${q(col)} = ${sqlLiteral(addBf.value, step.meta.type)} WHERE ${q(col)} IS NULL;`);
386
- if (!step.meta.isOptional) {
387
- statements.push(`ALTER TABLE ${qt} ALTER COLUMN ${q(col)} SET NOT NULL;`);
388
- }
389
- }
390
- if (step.meta.isIndexed) {
391
- statements.push(`CREATE INDEX IF NOT EXISTS ${q(indexName(table, col))} ON ${qt} (${q(col)});`);
392
- }
393
- break;
394
- }
395
- case 'drop_field': {
396
- const table = tableOfModel(next, step.model);
397
- if (!table)
398
- break;
399
- const prevMeta = prev?.models[step.model]?.fields[step.field];
400
- statements.push(`ALTER TABLE ${qtFor(table)} DROP COLUMN IF EXISTS ${q(columnNameOf(step.field, prevMeta))};`);
401
- break;
402
- }
403
- case 'rename_field': {
404
- const table = tableOfModel(next, step.model);
405
- if (!table)
406
- break;
407
- const prevMeta = prev?.models[step.model]?.fields[step.from];
408
- const nextMeta = next.models[step.model]?.fields[step.to];
409
- const fromCol = columnNameOf(step.from, prevMeta);
410
- const toCol = columnNameOf(step.to, nextMeta);
411
- if (fromCol === toCol)
412
- break;
413
- statements.push(`ALTER TABLE ${qtFor(table)} RENAME COLUMN ${q(fromCol)} TO ${q(toCol)};`);
414
- break;
415
- }
416
- case 'alter_field': {
417
- const table = tableOfModel(next, step.model);
418
- if (!table)
419
- break;
420
- const qt = qtFor(table);
421
- const nextMeta = next.models[step.model]?.fields[step.field];
422
- let col = columnNameOf(step.field, nextMeta);
423
- const ch = step.changes;
424
- // 0. Physical column rename. Subsequent alterations must address
425
- // the new name.
426
- if (ch.column) {
427
- statements.push(`ALTER TABLE ${qt} RENAME COLUMN ${q(ch.column.from)} TO ${q(ch.column.to)};`);
428
- col = ch.column.to;
429
- }
430
- // 1. Type — in-place cast or lossy drop-and-recreate.
431
- if (ch.type) {
432
- const target = sqlType(ch.type.to);
433
- if (ch.type.cast === 'notCastable') {
434
- statements.push(`ALTER TABLE ${qt} DROP COLUMN IF EXISTS ${q(col)};`);
435
- statements.push(`ALTER TABLE ${qt} ADD COLUMN IF NOT EXISTS ${q(col)} ${target};`);
436
- }
437
- else {
438
- statements.push(`ALTER TABLE ${qt} ALTER COLUMN ${q(col)} TYPE ${target} USING ${q(col)}::${target};`);
439
- }
440
- }
441
- // 2. Enum CHECK — drop when leaving enum; (re)build when arriving at or
442
- // re-valuing an enum. Reads the full target value set from `next`.
443
- if (ch.type?.from === 'enum' && nextMeta?.type !== 'enum') {
444
- statements.push(`ALTER TABLE ${qt} DROP CONSTRAINT IF EXISTS ${q(`${table}_${col}_enum`)};`);
445
- }
446
- else if (nextMeta?.type === 'enum' && (ch.enumValues || ch.type)) {
447
- statements.push(...enumCheckStatements(table, col, qt, nextMeta.enumValues ?? []));
448
- }
449
- // 3. Nullability. DROP NOT NULL is always safe. SET NOT NULL is gated
450
- // upstream (unexecutable on a table with NULLs); a supplied backfill
451
- // seeds the existing NULLs first so the constraint can take.
452
- if (ch.nullability) {
453
- if (ch.nullability.toOptional) {
454
- statements.push(`ALTER TABLE ${qt} ALTER COLUMN ${q(col)} DROP NOT NULL;`);
455
- }
456
- else {
457
- const bf = backfillFor(step.model, step.field);
458
- if (bf !== undefined && nextMeta) {
459
- statements.push(`UPDATE ${qt} SET ${q(col)} = ${sqlLiteral(bf.value, nextMeta.type)} WHERE ${q(col)} IS NULL;`);
460
- }
461
- statements.push(`ALTER TABLE ${qt} ALTER COLUMN ${q(col)} SET NOT NULL;`);
462
- }
463
- }
464
- // 4. Index.
465
- if (ch.indexed) {
466
- statements.push(ch.indexed.to
467
- ? `CREATE INDEX IF NOT EXISTS ${q(indexName(table, col))} ON ${qt} (${q(col)});`
468
- : `DROP INDEX IF EXISTS ${qs}.${q(indexName(table, col))};`);
469
- }
470
- break;
471
- }
472
- }
473
- }
474
- // Foreign keys (opt-in). Reconcile against the full `next` schema, not just
475
- // create_model steps: a parent edge added to an existing model surfaces only as
476
- // an add_field (relation changes aren't diffed), so a create_model-only pass
477
- // would never materialize its FK. The DO-block is authoritative + idempotent
478
- // (a no-op when the constraint is already correct), so emitting the full set
479
- // each push is cheap and self-healing. Appended after every table/column step.
480
- if (foreignKeys) {
481
- for (const [key, def] of Object.entries(next.models)) {
482
- if ((def.plane ?? 'tenant') === 'control')
483
- continue;
484
- const table = def.tableName ?? key;
485
- const fk = foreignKeyStatements(table, def, next.models, qs);
486
- statements.push(...fk.statements);
487
- concurrent.push(...fk.concurrent);
488
- }
489
- }
490
- return { appSchema: targetSchema, statements, concurrent };
491
- }
@@ -1,35 +0,0 @@
1
- /**
2
- * Lock settings for schema-change (DDL) statements. When a schema push alters a
3
- * table, these values control how quickly the change gives up on a contended
4
- * lock and how many times it retries. The command-line `ablo migrate` and the
5
- * host that applies a schema push both resolve their lock behavior through this
6
- * module, so tuning the environment variables below changes both paths the same
7
- * way.
8
- *
9
- * The defaults follow the standard safe-migration recipe: a short `lock_timeout`
10
- * so a blocked `ALTER` aborts quickly instead of parking an `ACCESS EXCLUSIVE`
11
- * lock request at the head of the queue — which would freeze every other query
12
- * on that table behind it — paired with a bounded retry-and-backoff on the
13
- * resulting timeout.
14
- *
15
- * The environment variables are read each time a resolver is called, not once
16
- * at import, so a long-running process or a test that changes them sees the
17
- * update: `ABLO_SCHEMA_LOCK_TIMEOUT` and `ABLO_SCHEMA_LOCK_ATTEMPTS`. The older
18
- * `ABLO_DDL_*` names are also accepted.
19
- */
20
- /** The Postgres SQLSTATE `55P03` (`lock_not_available`), raised when a statement
21
- * gives up waiting for a lock after `lock_timeout`. This is the one DDL failure
22
- * worth retrying; any other error is a genuine problem. */
23
- export declare const PG_LOCK_NOT_AVAILABLE = "55P03";
24
- /** The subset of environment variables the resolvers in this module read. It is
25
- * passed in explicitly so tests can supply their own values. */
26
- export type DdlLockEnv = Readonly<Record<string, string | undefined>>;
27
- /** `lock_timeout` for the DDL transaction (a Postgres duration string). */
28
- export declare function resolveDdlLockTimeout(env?: DdlLockEnv): string;
29
- /** How many times the whole DDL transaction is attempted on `55P03` lock
30
- * contention. Always ≥ 1; a malformed value falls back to the default
31
- * instead of silently disabling retries. */
32
- export declare function resolveDdlMaxLockAttempts(env?: DdlLockEnv): number;
33
- /** Backoff before retry N (1-based): capped exponential + a little jitter so
34
- * two contending migrators don't re-collide in lockstep. */
35
- export declare function ddlLockRetryBackoffMs(attempt: number): number;
@@ -1,46 +0,0 @@
1
- /**
2
- * Lock settings for schema-change (DDL) statements. When a schema push alters a
3
- * table, these values control how quickly the change gives up on a contended
4
- * lock and how many times it retries. The command-line `ablo migrate` and the
5
- * host that applies a schema push both resolve their lock behavior through this
6
- * module, so tuning the environment variables below changes both paths the same
7
- * way.
8
- *
9
- * The defaults follow the standard safe-migration recipe: a short `lock_timeout`
10
- * so a blocked `ALTER` aborts quickly instead of parking an `ACCESS EXCLUSIVE`
11
- * lock request at the head of the queue — which would freeze every other query
12
- * on that table behind it — paired with a bounded retry-and-backoff on the
13
- * resulting timeout.
14
- *
15
- * The environment variables are read each time a resolver is called, not once
16
- * at import, so a long-running process or a test that changes them sees the
17
- * update: `ABLO_SCHEMA_LOCK_TIMEOUT` and `ABLO_SCHEMA_LOCK_ATTEMPTS`. The older
18
- * `ABLO_DDL_*` names are also accepted.
19
- */
20
- /** The Postgres SQLSTATE `55P03` (`lock_not_available`), raised when a statement
21
- * gives up waiting for a lock after `lock_timeout`. This is the one DDL failure
22
- * worth retrying; any other error is a genuine problem. */
23
- export const PG_LOCK_NOT_AVAILABLE = '55P03';
24
- const DEFAULT_LOCK_TIMEOUT = '5s';
25
- const DEFAULT_MAX_LOCK_ATTEMPTS = 5;
26
- /** `lock_timeout` for the DDL transaction (a Postgres duration string). */
27
- export function resolveDdlLockTimeout(env = process.env) {
28
- return env.ABLO_SCHEMA_LOCK_TIMEOUT ?? env.ABLO_DDL_LOCK_TIMEOUT ?? DEFAULT_LOCK_TIMEOUT;
29
- }
30
- /** How many times the whole DDL transaction is attempted on `55P03` lock
31
- * contention. Always ≥ 1; a malformed value falls back to the default
32
- * instead of silently disabling retries. */
33
- export function resolveDdlMaxLockAttempts(env = process.env) {
34
- const raw = env.ABLO_SCHEMA_LOCK_ATTEMPTS ?? env.ABLO_DDL_LOCK_ATTEMPTS;
35
- if (raw === undefined)
36
- return DEFAULT_MAX_LOCK_ATTEMPTS;
37
- const parsed = Number(raw);
38
- if (!Number.isFinite(parsed))
39
- return DEFAULT_MAX_LOCK_ATTEMPTS;
40
- return Math.max(1, Math.floor(parsed));
41
- }
42
- /** Backoff before retry N (1-based): capped exponential + a little jitter so
43
- * two contending migrators don't re-collide in lockstep. */
44
- export function ddlLockRetryBackoffMs(attempt) {
45
- return Math.min(60_000, 10 * 2 ** attempt) + Math.floor(Math.random() * 50);
46
- }