@abloatai/ablo 0.36.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 (597) hide show
  1. package/AGENTS.md +2 -2
  2. package/CHANGELOG.md +71 -2013
  3. package/NOTICE +2 -2
  4. package/README.md +25 -71
  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 -114
  19. package/dist/index.d.ts.map +1 -0
  20. package/dist/index.js +3 -163
  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 +1 -1
  59. package/docs/api-keys.md +7 -6
  60. package/docs/api.md +10 -10
  61. package/docs/client-behavior.md +5 -5
  62. package/docs/coordination.md +52 -62
  63. package/docs/data-sources.md +1 -1
  64. package/docs/examples/agent-human.md +4 -4
  65. package/docs/examples/ai-sdk-tool.md +1 -1
  66. package/docs/examples/existing-python-backend.md +15 -4
  67. package/docs/examples/nextjs.md +27 -6
  68. package/docs/examples/server-agent.md +2 -2
  69. package/docs/how-it-works.md +4 -4
  70. package/docs/identity.md +2 -1
  71. package/docs/integration-guide.md +24 -13
  72. package/docs/internal/README.md +18 -0
  73. package/docs/internal/agent-fleet-coordination-design.md +171 -0
  74. package/docs/internal/agent-orchestration.md +58 -0
  75. package/docs/internal/commit-identifiers.md +91 -0
  76. package/docs/internal/concurrency-open-decisions.md +37 -0
  77. package/docs/internal/data-source-reverse-channel.md +150 -0
  78. package/docs/internal/per-field-conflict-detection.md +165 -0
  79. package/docs/internal/postgres-replication.md +64 -0
  80. package/docs/internal/serializable-schema.md +119 -0
  81. package/docs/internal/structure.md +32 -0
  82. package/docs/mcp.md +2 -2
  83. package/docs/migration.md +3 -3
  84. package/docs/quickstart.md +2 -2
  85. package/docs/react.md +5 -5
  86. package/docs/schema-contract.md +3 -3
  87. package/docs/sessions.md +91 -37
  88. package/examples/README.md +2 -2
  89. package/examples/data-source/README.md +1 -1
  90. package/examples/data-source/ablo-driver.ts +1 -1
  91. package/examples/data-source/customer-server.ts +1 -1
  92. package/examples/data-source/run.ts +1 -1
  93. package/examples/data-source/schema.ts +1 -1
  94. package/examples/quickstart.ts +2 -2
  95. package/llms.txt +8 -8
  96. package/package.json +63 -166
  97. package/bin/ablo.cjs +0 -39
  98. package/dist/BaseSyncedStore.d.ts +0 -843
  99. package/dist/BaseSyncedStore.js +0 -1971
  100. package/dist/Database.d.ts +0 -323
  101. package/dist/Database.js +0 -1502
  102. package/dist/InstanceCache.d.ts +0 -237
  103. package/dist/InstanceCache.js +0 -1166
  104. package/dist/LazyReferenceCollection.d.ts +0 -177
  105. package/dist/LazyReferenceCollection.js +0 -461
  106. package/dist/Model.d.ts +0 -454
  107. package/dist/Model.js +0 -919
  108. package/dist/ModelRegistry.d.ts +0 -225
  109. package/dist/ModelRegistry.js +0 -539
  110. package/dist/NetworkMonitor.d.ts +0 -28
  111. package/dist/NetworkMonitor.js +0 -79
  112. package/dist/RuntimeContext.d.ts +0 -52
  113. package/dist/RuntimeContext.js +0 -80
  114. package/dist/SyncClient.d.ts +0 -541
  115. package/dist/SyncClient.js +0 -2202
  116. package/dist/adapters/alwaysOnline.d.ts +0 -14
  117. package/dist/adapters/alwaysOnline.js +0 -17
  118. package/dist/adapters/inMemoryStorage.d.ts +0 -31
  119. package/dist/adapters/inMemoryStorage.js +0 -110
  120. package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
  121. package/dist/ai-sdk/coordinatedTool.js +0 -134
  122. package/dist/ai-sdk/coordinationContext.d.ts +0 -46
  123. package/dist/ai-sdk/coordinationContext.js +0 -106
  124. package/dist/ai-sdk/index.d.ts +0 -121
  125. package/dist/ai-sdk/index.js +0 -121
  126. package/dist/ai-sdk/wrap.d.ts +0 -65
  127. package/dist/ai-sdk/wrap.js +0 -39
  128. package/dist/auth/index.d.ts +0 -1
  129. package/dist/auth/index.js +0 -8
  130. package/dist/batching/index.d.ts +0 -55
  131. package/dist/batching/index.js +0 -147
  132. package/dist/client/Ablo.d.ts +0 -231
  133. package/dist/client/Ablo.js +0 -160
  134. package/dist/client/abloClient.d.ts +0 -309
  135. package/dist/client/abloClient.js +0 -13
  136. package/dist/client/clientPrelude.d.ts +0 -52
  137. package/dist/client/clientPrelude.js +0 -60
  138. package/dist/client/consoleLogger.d.ts +0 -35
  139. package/dist/client/consoleLogger.js +0 -44
  140. package/dist/client/coreClient.d.ts +0 -60
  141. package/dist/client/coreClient.js +0 -118
  142. package/dist/client/createInternalComponents.d.ts +0 -50
  143. package/dist/client/createInternalComponents.js +0 -98
  144. package/dist/client/createModelProxy.d.ts +0 -248
  145. package/dist/client/createModelProxy.js +0 -884
  146. package/dist/client/humans.d.ts +0 -69
  147. package/dist/client/humans.js +0 -78
  148. package/dist/client/modelRegistration.d.ts +0 -10
  149. package/dist/client/modelRegistration.js +0 -312
  150. package/dist/client/options.d.ts +0 -461
  151. package/dist/client/options.js +0 -7
  152. package/dist/client/reactiveEngine.d.ts +0 -53
  153. package/dist/client/reactiveEngine.js +0 -688
  154. package/dist/client/resourceTypes.d.ts +0 -12
  155. package/dist/client/resourceTypes.js +0 -10
  156. package/dist/client/schemaConfig.d.ts +0 -44
  157. package/dist/client/schemaConfig.js +0 -185
  158. package/dist/client/storeCluster.d.ts +0 -47
  159. package/dist/client/storeCluster.js +0 -118
  160. package/dist/client/storeLifecycle.d.ts +0 -61
  161. package/dist/client/storeLifecycle.js +0 -231
  162. package/dist/client/validateAbloOptions.d.ts +0 -42
  163. package/dist/client/validateAbloOptions.js +0 -43
  164. package/dist/client/wsMutationExecutor.d.ts +0 -27
  165. package/dist/client/wsMutationExecutor.js +0 -72
  166. package/dist/context.d.ts +0 -42
  167. package/dist/context.js +0 -81
  168. package/dist/coordination/ClaimLog.d.ts +0 -26
  169. package/dist/coordination/ClaimLog.js +0 -32
  170. package/dist/coordination/index.d.ts +0 -1
  171. package/dist/coordination/index.js +0 -8
  172. package/dist/core/index.d.ts +0 -33
  173. package/dist/core/index.js +0 -48
  174. package/dist/docs/catalog.d.ts +0 -72
  175. package/dist/docs/catalog.js +0 -230
  176. package/dist/docs/index.d.ts +0 -10
  177. package/dist/docs/index.js +0 -10
  178. package/dist/environment.d.ts +0 -1
  179. package/dist/environment.js +0 -8
  180. package/dist/interfaces/index.d.ts +0 -311
  181. package/dist/interfaces/index.js +0 -9
  182. package/dist/keys/index.d.ts +0 -1
  183. package/dist/keys/index.js +0 -8
  184. package/dist/mutators/RecordingMutation.d.ts +0 -36
  185. package/dist/mutators/RecordingMutation.js +0 -182
  186. package/dist/mutators/Transaction.d.ts +0 -40
  187. package/dist/mutators/Transaction.js +0 -58
  188. package/dist/mutators/UndoManager.d.ts +0 -258
  189. package/dist/mutators/UndoManager.js +0 -658
  190. package/dist/mutators/defineMutators.d.ts +0 -60
  191. package/dist/mutators/defineMutators.js +0 -18
  192. package/dist/mutators/inverseOp.d.ts +0 -126
  193. package/dist/mutators/inverseOp.js +0 -71
  194. package/dist/mutators/mutateActions.d.ts +0 -45
  195. package/dist/mutators/mutateActions.js +0 -105
  196. package/dist/mutators/readerActions.d.ts +0 -33
  197. package/dist/mutators/readerActions.js +0 -57
  198. package/dist/mutators/undoApply.d.ts +0 -51
  199. package/dist/mutators/undoApply.js +0 -117
  200. package/dist/policy/index.d.ts +0 -21
  201. package/dist/policy/index.js +0 -20
  202. package/dist/query/QueryProcessor.d.ts +0 -75
  203. package/dist/query/QueryProcessor.js +0 -255
  204. package/dist/query/client.d.ts +0 -64
  205. package/dist/query/client.js +0 -138
  206. package/dist/query/types.d.ts +0 -85
  207. package/dist/query/types.js +0 -16
  208. package/dist/react/AbloProvider.d.ts +0 -242
  209. package/dist/react/AbloProvider.js +0 -458
  210. package/dist/react/ClientSideSuspense.d.ts +0 -36
  211. package/dist/react/ClientSideSuspense.js +0 -17
  212. package/dist/react/DefaultFallback.d.ts +0 -24
  213. package/dist/react/DefaultFallback.js +0 -43
  214. package/dist/react/context.d.ts +0 -55
  215. package/dist/react/context.js +0 -29
  216. package/dist/react/createAbloReact.d.ts +0 -56
  217. package/dist/react/createAbloReact.js +0 -51
  218. package/dist/react/index.d.ts +0 -62
  219. package/dist/react/index.js +0 -69
  220. package/dist/react/internalContext.d.ts +0 -33
  221. package/dist/react/internalContext.js +0 -3
  222. package/dist/react/useAblo.d.ts +0 -82
  223. package/dist/react/useAblo.js +0 -120
  224. package/dist/react/useCurrentUserId.d.ts +0 -22
  225. package/dist/react/useCurrentUserId.js +0 -34
  226. package/dist/react/useErrorListener.d.ts +0 -20
  227. package/dist/react/useErrorListener.js +0 -38
  228. package/dist/react/useMutationFailureListener.d.ts +0 -26
  229. package/dist/react/useMutationFailureListener.js +0 -38
  230. package/dist/react/useMutators.d.ts +0 -56
  231. package/dist/react/useMutators.js +0 -84
  232. package/dist/react/useReactive.d.ts +0 -35
  233. package/dist/react/useReactive.js +0 -123
  234. package/dist/react/useSyncStatus.d.ts +0 -59
  235. package/dist/react/useSyncStatus.js +0 -76
  236. package/dist/react/useUndoScope.d.ts +0 -34
  237. package/dist/react/useUndoScope.js +0 -81
  238. package/dist/schema/coordination.d.ts +0 -112
  239. package/dist/schema/coordination.js +0 -133
  240. package/dist/schema/ddl.d.ts +0 -97
  241. package/dist/schema/ddl.js +0 -491
  242. package/dist/schema/ddlLock.d.ts +0 -35
  243. package/dist/schema/ddlLock.js +0 -46
  244. package/dist/schema/diff.d.ts +0 -225
  245. package/dist/schema/diff.js +0 -289
  246. package/dist/schema/generate.d.ts +0 -19
  247. package/dist/schema/generate.js +0 -86
  248. package/dist/schema/index.d.ts +0 -42
  249. package/dist/schema/index.js +0 -80
  250. package/dist/schema/queries.d.ts +0 -201
  251. package/dist/schema/queries.js +0 -144
  252. package/dist/schema/select.d.ts +0 -40
  253. package/dist/schema/select.js +0 -90
  254. package/dist/schema/serialize.d.ts +0 -115
  255. package/dist/schema/serialize.js +0 -265
  256. package/dist/schema/sugar.d.ts +0 -109
  257. package/dist/schema/sugar.js +0 -83
  258. package/dist/schema/syncDeltaRow.d.ts +0 -6
  259. package/dist/schema/syncDeltaRow.js +0 -6
  260. package/dist/server/adapter.d.ts +0 -173
  261. package/dist/server/adapter.js +0 -18
  262. package/dist/server/commit.d.ts +0 -107
  263. package/dist/server/commit.js +0 -1
  264. package/dist/server/index.d.ts +0 -14
  265. package/dist/server/index.js +0 -2
  266. package/dist/server/readConfig.d.ts +0 -80
  267. package/dist/server/readConfig.js +0 -8
  268. package/dist/server/storageMode.d.ts +0 -23
  269. package/dist/server/storageMode.js +0 -17
  270. package/dist/source/adapter.d.ts +0 -83
  271. package/dist/source/adapter.js +0 -24
  272. package/dist/source/adapters/drizzle.d.ts +0 -48
  273. package/dist/source/adapters/drizzle.js +0 -219
  274. package/dist/source/adapters/kysely.d.ts +0 -42
  275. package/dist/source/adapters/kysely.js +0 -205
  276. package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
  277. package/dist/source/adapters/kyselyMutationCore.js +0 -125
  278. package/dist/source/adapters/memory.d.ts +0 -13
  279. package/dist/source/adapters/memory.js +0 -130
  280. package/dist/source/adapters/prisma.d.ts +0 -63
  281. package/dist/source/adapters/prisma.js +0 -202
  282. package/dist/source/conformance.d.ts +0 -37
  283. package/dist/source/conformance.js +0 -215
  284. package/dist/source/connector.d.ts +0 -95
  285. package/dist/source/connector.js +0 -266
  286. package/dist/source/connectorProtocol.d.ts +0 -154
  287. package/dist/source/connectorProtocol.js +0 -163
  288. package/dist/source/contract.d.ts +0 -195
  289. package/dist/source/contract.js +0 -164
  290. package/dist/source/factory.d.ts +0 -92
  291. package/dist/source/factory.js +0 -286
  292. package/dist/source/idempotency.d.ts +0 -61
  293. package/dist/source/idempotency.js +0 -144
  294. package/dist/source/index.d.ts +0 -23
  295. package/dist/source/index.js +0 -30
  296. package/dist/source/migrations.d.ts +0 -21
  297. package/dist/source/migrations.js +0 -103
  298. package/dist/source/next.d.ts +0 -32
  299. package/dist/source/next.js +0 -25
  300. package/dist/source/pushQueue.d.ts +0 -134
  301. package/dist/source/pushQueue.js +0 -256
  302. package/dist/source/signing.d.ts +0 -92
  303. package/dist/source/signing.js +0 -162
  304. package/dist/source/types.d.ts +0 -401
  305. package/dist/source/types.js +0 -59
  306. package/dist/storeContract.d.ts +0 -145
  307. package/dist/storeContract.js +0 -12
  308. package/dist/stores/DatabaseManager.d.ts +0 -107
  309. package/dist/stores/DatabaseManager.js +0 -388
  310. package/dist/stores/ObjectStore.d.ts +0 -115
  311. package/dist/stores/ObjectStore.js +0 -393
  312. package/dist/stores/ObjectStoreContract.d.ts +0 -38
  313. package/dist/stores/ObjectStoreContract.js +0 -1
  314. package/dist/stores/StoreManager.d.ts +0 -114
  315. package/dist/stores/StoreManager.js +0 -304
  316. package/dist/stores/SyncActionStore.d.ts +0 -99
  317. package/dist/stores/SyncActionStore.js +0 -506
  318. package/dist/stores/openIDBWithTimeout.d.ts +0 -65
  319. package/dist/stores/openIDBWithTimeout.js +0 -153
  320. package/dist/stores/syncAction.d.ts +0 -26
  321. package/dist/stores/syncAction.js +0 -16
  322. package/dist/surface.d.ts +0 -36
  323. package/dist/surface.js +0 -75
  324. package/dist/sync/BootstrapFetcher.d.ts +0 -284
  325. package/dist/sync/BootstrapFetcher.js +0 -964
  326. package/dist/sync/ConnectionManager.d.ts +0 -8
  327. package/dist/sync/ConnectionManager.js +0 -8
  328. package/dist/sync/OnDemandLoader.d.ts +0 -231
  329. package/dist/sync/OnDemandLoader.js +0 -743
  330. package/dist/sync/SubscriptionManager.d.ts +0 -159
  331. package/dist/sync/SubscriptionManager.js +0 -243
  332. package/dist/sync/SyncWebSocket.d.ts +0 -173
  333. package/dist/sync/SyncWebSocket.js +0 -438
  334. package/dist/sync/awaitClaimGrant.d.ts +0 -6
  335. package/dist/sync/awaitClaimGrant.js +0 -6
  336. package/dist/sync/bootstrapApply.d.ts +0 -73
  337. package/dist/sync/bootstrapApply.js +0 -73
  338. package/dist/sync/commitFrames.d.ts +0 -8
  339. package/dist/sync/commitFrames.js +0 -8
  340. package/dist/sync/contextPorts.d.ts +0 -18
  341. package/dist/sync/contextPorts.js +0 -31
  342. package/dist/sync/createClaimStream.d.ts +0 -7
  343. package/dist/sync/createClaimStream.js +0 -7
  344. package/dist/sync/createPresenceStream.d.ts +0 -69
  345. package/dist/sync/createPresenceStream.js +0 -200
  346. package/dist/sync/createSnapshot.d.ts +0 -29
  347. package/dist/sync/createSnapshot.js +0 -118
  348. package/dist/sync/credentialLifecycle.d.ts +0 -7
  349. package/dist/sync/credentialLifecycle.js +0 -7
  350. package/dist/sync/deltaPipeline.d.ts +0 -114
  351. package/dist/sync/deltaPipeline.js +0 -278
  352. package/dist/sync/groupChange.d.ts +0 -116
  353. package/dist/sync/groupChange.js +0 -244
  354. package/dist/sync/participants.d.ts +0 -132
  355. package/dist/sync/participants.js +0 -346
  356. package/dist/sync/persistedPrefix.d.ts +0 -12
  357. package/dist/sync/persistedPrefix.js +0 -22
  358. package/dist/sync/schemaDrift.d.ts +0 -55
  359. package/dist/sync/schemaDrift.js +0 -53
  360. package/dist/sync/schemas.d.ts +0 -71
  361. package/dist/sync/schemas.js +0 -94
  362. package/dist/sync/syncCursor.d.ts +0 -40
  363. package/dist/sync/syncCursor.js +0 -55
  364. package/dist/sync/syncPlan.d.ts +0 -54
  365. package/dist/sync/syncPlan.js +0 -50
  366. package/dist/sync/wsFrameHandlers.d.ts +0 -8
  367. package/dist/sync/wsFrameHandlers.js +0 -8
  368. package/dist/syncLog/contract.d.ts +0 -20
  369. package/dist/syncLog/contract.js +0 -19
  370. package/dist/syncLog/index.d.ts +0 -1
  371. package/dist/syncLog/index.js +0 -1
  372. package/dist/transaction/ablo.d.ts +0 -88
  373. package/dist/transaction/ablo.js +0 -33
  374. package/dist/transaction/auth/apiKey.d.ts +0 -152
  375. package/dist/transaction/auth/apiKey.js +0 -419
  376. package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
  377. package/dist/transaction/auth/bootstrapScope.js +0 -1
  378. package/dist/transaction/auth/capability.d.ts +0 -212
  379. package/dist/transaction/auth/capability.js +0 -224
  380. package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
  381. package/dist/transaction/auth/credentialEndpoint.js +0 -86
  382. package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
  383. package/dist/transaction/auth/credentialPolicy.js +0 -125
  384. package/dist/transaction/auth/credentialSource.d.ts +0 -30
  385. package/dist/transaction/auth/credentialSource.js +0 -55
  386. package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
  387. package/dist/transaction/auth/hostedEndpoints.js +0 -21
  388. package/dist/transaction/auth/identity.d.ts +0 -55
  389. package/dist/transaction/auth/identity.js +0 -210
  390. package/dist/transaction/auth/index.d.ts +0 -162
  391. package/dist/transaction/auth/index.js +0 -304
  392. package/dist/transaction/auth/schemas.d.ts +0 -59
  393. package/dist/transaction/auth/schemas.js +0 -85
  394. package/dist/transaction/auth/sessionMint.d.ts +0 -28
  395. package/dist/transaction/auth/sessionMint.js +0 -85
  396. package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -56
  397. package/dist/transaction/coordination/awaitClaimGrant.js +0 -124
  398. package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -84
  399. package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -108
  400. package/dist/transaction/coordination/claimMeta.d.ts +0 -49
  401. package/dist/transaction/coordination/claimMeta.js +0 -52
  402. package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
  403. package/dist/transaction/coordination/createClaimStream.js +0 -475
  404. package/dist/transaction/coordination/events.d.ts +0 -74
  405. package/dist/transaction/coordination/events.js +0 -7
  406. package/dist/transaction/coordination/index.d.ts +0 -19
  407. package/dist/transaction/coordination/index.js +0 -45
  408. package/dist/transaction/coordination/locator.d.ts +0 -104
  409. package/dist/transaction/coordination/locator.js +0 -102
  410. package/dist/transaction/coordination/schema.d.ts +0 -1536
  411. package/dist/transaction/coordination/schema.js +0 -1177
  412. package/dist/transaction/coordination/targetConflict.d.ts +0 -2
  413. package/dist/transaction/coordination/targetConflict.js +0 -107
  414. package/dist/transaction/coordination/trace.d.ts +0 -78
  415. package/dist/transaction/coordination/trace.js +0 -138
  416. package/dist/transaction/durableWrites.d.ts +0 -62
  417. package/dist/transaction/durableWrites.js +0 -71
  418. package/dist/transaction/environment.d.ts +0 -105
  419. package/dist/transaction/environment.js +0 -108
  420. package/dist/transaction/errorCodes.d.ts +0 -403
  421. package/dist/transaction/errorCodes.js +0 -484
  422. package/dist/transaction/errors.d.ts +0 -428
  423. package/dist/transaction/errors.js +0 -686
  424. package/dist/transaction/footprint.d.ts +0 -111
  425. package/dist/transaction/footprint.js +0 -0
  426. package/dist/transaction/index.d.ts +0 -20
  427. package/dist/transaction/index.js +0 -20
  428. package/dist/transaction/keys/index.d.ts +0 -87
  429. package/dist/transaction/keys/index.js +0 -207
  430. package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
  431. package/dist/transaction/log/syncDeltaRow.js +0 -95
  432. package/dist/transaction/logPosition.d.ts +0 -97
  433. package/dist/transaction/logPosition.js +0 -125
  434. package/dist/transaction/logger.d.ts +0 -16
  435. package/dist/transaction/logger.js +0 -7
  436. package/dist/transaction/observability.d.ts +0 -53
  437. package/dist/transaction/observability.js +0 -19
  438. package/dist/transaction/persistence.d.ts +0 -12
  439. package/dist/transaction/persistence.js +0 -11
  440. package/dist/transaction/plugin.d.ts +0 -285
  441. package/dist/transaction/plugin.js +0 -106
  442. package/dist/transaction/policy/types.d.ts +0 -217
  443. package/dist/transaction/policy/types.js +0 -126
  444. package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
  445. package/dist/transaction/resources/functionalUpdate.js +0 -87
  446. package/dist/transaction/resources/httpResources.d.ts +0 -321
  447. package/dist/transaction/resources/httpResources.js +0 -7
  448. package/dist/transaction/resources/modelOperations.d.ts +0 -427
  449. package/dist/transaction/resources/modelOperations.js +0 -12
  450. package/dist/transaction/resources/mutationOptions.d.ts +0 -66
  451. package/dist/transaction/resources/mutationOptions.js +0 -9
  452. package/dist/transaction/resources/where.d.ts +0 -101
  453. package/dist/transaction/resources/where.js +0 -115
  454. package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
  455. package/dist/transaction/resources/writeOptionsSchema.js +0 -73
  456. package/dist/transaction/schema/field.d.ts +0 -120
  457. package/dist/transaction/schema/field.js +0 -265
  458. package/dist/transaction/schema/fieldRef.d.ts +0 -38
  459. package/dist/transaction/schema/fieldRef.js +0 -11
  460. package/dist/transaction/schema/loadStrategy.d.ts +0 -45
  461. package/dist/transaction/schema/loadStrategy.js +0 -46
  462. package/dist/transaction/schema/model.d.ts +0 -379
  463. package/dist/transaction/schema/model.js +0 -123
  464. package/dist/transaction/schema/openapi.d.ts +0 -58
  465. package/dist/transaction/schema/openapi.js +0 -501
  466. package/dist/transaction/schema/relation.d.ts +0 -204
  467. package/dist/transaction/schema/relation.js +0 -104
  468. package/dist/transaction/schema/residency.d.ts +0 -29
  469. package/dist/transaction/schema/residency.js +0 -25
  470. package/dist/transaction/schema/roles.d.ts +0 -249
  471. package/dist/transaction/schema/roles.js +0 -230
  472. package/dist/transaction/schema/schema.d.ts +0 -351
  473. package/dist/transaction/schema/schema.js +0 -325
  474. package/dist/transaction/schema/tenancy.d.ts +0 -139
  475. package/dist/transaction/schema/tenancy.js +0 -190
  476. package/dist/transaction/transactionLayer.d.ts +0 -82
  477. package/dist/transaction/transactionLayer.js +0 -24
  478. package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
  479. package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
  480. package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
  481. package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
  482. package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
  483. package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
  484. package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
  485. package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
  486. package/dist/transaction/transport/commitFrames.d.ts +0 -90
  487. package/dist/transaction/transport/commitFrames.js +0 -134
  488. package/dist/transaction/transport/connectionManager.d.ts +0 -215
  489. package/dist/transaction/transport/connectionManager.js +0 -673
  490. package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
  491. package/dist/transaction/transport/credentialLifecycle.js +0 -324
  492. package/dist/transaction/transport/heartbeat.d.ts +0 -65
  493. package/dist/transaction/transport/heartbeat.js +0 -93
  494. package/dist/transaction/transport/httpClient.d.ts +0 -131
  495. package/dist/transaction/transport/httpClient.js +0 -146
  496. package/dist/transaction/transport/httpOptions.d.ts +0 -33
  497. package/dist/transaction/transport/httpOptions.js +0 -12
  498. package/dist/transaction/transport/httpTransport.d.ts +0 -8
  499. package/dist/transaction/transport/httpTransport.js +0 -1388
  500. package/dist/transaction/transport/networkProbe.d.ts +0 -84
  501. package/dist/transaction/transport/networkProbe.js +0 -207
  502. package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
  503. package/dist/transaction/transport/wsFrameHandlers.js +0 -429
  504. package/dist/transaction/transport/wsTransport.d.ts +0 -574
  505. package/dist/transaction/transport/wsTransport.js +0 -1023
  506. package/dist/transaction/types/assertExact.d.ts +0 -17
  507. package/dist/transaction/types/assertExact.js +0 -1
  508. package/dist/transaction/types/global.d.ts +0 -107
  509. package/dist/transaction/types/global.js +0 -40
  510. package/dist/transaction/types/index.d.ts +0 -205
  511. package/dist/transaction/types/index.js +0 -56
  512. package/dist/transaction/types/modelData.d.ts +0 -10
  513. package/dist/transaction/types/modelData.js +0 -9
  514. package/dist/transaction/types/participant.d.ts +0 -20
  515. package/dist/transaction/types/participant.js +0 -10
  516. package/dist/transaction/types/streams.d.ts +0 -550
  517. package/dist/transaction/types/streams.js +0 -11
  518. package/dist/transaction/utils/asyncIterator.d.ts +0 -34
  519. package/dist/transaction/utils/asyncIterator.js +0 -135
  520. package/dist/transaction/utils/duration.d.ts +0 -50
  521. package/dist/transaction/utils/duration.js +0 -77
  522. package/dist/transaction/utils/json.d.ts +0 -57
  523. package/dist/transaction/utils/json.js +0 -276
  524. package/dist/transaction/wire/accountResponses.d.ts +0 -420
  525. package/dist/transaction/wire/accountResponses.js +0 -290
  526. package/dist/transaction/wire/auth.d.ts +0 -56
  527. package/dist/transaction/wire/auth.js +0 -63
  528. package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
  529. package/dist/transaction/wire/bootstrapReason.js +0 -8
  530. package/dist/transaction/wire/claimEvent.d.ts +0 -76
  531. package/dist/transaction/wire/claimEvent.js +0 -73
  532. package/dist/transaction/wire/claims.d.ts +0 -530
  533. package/dist/transaction/wire/claims.js +0 -327
  534. package/dist/transaction/wire/commit.d.ts +0 -603
  535. package/dist/transaction/wire/commit.js +0 -321
  536. package/dist/transaction/wire/delta.d.ts +0 -250
  537. package/dist/transaction/wire/delta.js +0 -147
  538. package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
  539. package/dist/transaction/wire/errorEnvelope.js +0 -123
  540. package/dist/transaction/wire/feedCursor.d.ts +0 -60
  541. package/dist/transaction/wire/feedCursor.js +0 -82
  542. package/dist/transaction/wire/feedEvent.d.ts +0 -204
  543. package/dist/transaction/wire/feedEvent.js +0 -65
  544. package/dist/transaction/wire/frames.d.ts +0 -194
  545. package/dist/transaction/wire/frames.js +0 -50
  546. package/dist/transaction/wire/inboundFrames.d.ts +0 -562
  547. package/dist/transaction/wire/inboundFrames.js +0 -116
  548. package/dist/transaction/wire/index.d.ts +0 -54
  549. package/dist/transaction/wire/index.js +0 -83
  550. package/dist/transaction/wire/listEnvelope.d.ts +0 -37
  551. package/dist/transaction/wire/listEnvelope.js +0 -42
  552. package/dist/transaction/wire/modelMutations.d.ts +0 -31
  553. package/dist/transaction/wire/modelMutations.js +0 -52
  554. package/dist/transaction/wire/modelResponses.d.ts +0 -85
  555. package/dist/transaction/wire/modelResponses.js +0 -43
  556. package/dist/transaction/wire/modelShape.d.ts +0 -78
  557. package/dist/transaction/wire/modelShape.js +0 -74
  558. package/dist/transaction/wire/protocol.d.ts +0 -38
  559. package/dist/transaction/wire/protocol.js +0 -38
  560. package/dist/transaction/wire/protocolVersion.d.ts +0 -73
  561. package/dist/transaction/wire/protocolVersion.js +0 -83
  562. package/dist/transactions/mutations/MutationQueue.d.ts +0 -661
  563. package/dist/transactions/mutations/MutationQueue.js +0 -2807
  564. package/dist/transactions/mutations/MutationStore.d.ts +0 -20
  565. package/dist/transactions/mutations/MutationStore.js +0 -53
  566. package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
  567. package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
  568. package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
  569. package/dist/transactions/mutations/coalesceRules.js +0 -140
  570. package/dist/transactions/mutations/commitLatency.d.ts +0 -52
  571. package/dist/transactions/mutations/commitLatency.js +0 -130
  572. package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
  573. package/dist/transactions/mutations/commitOutboxStore.js +0 -26
  574. package/dist/transactions/mutations/commitPayload.d.ts +0 -165
  575. package/dist/transactions/mutations/commitPayload.js +0 -152
  576. package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -63
  577. package/dist/transactions/mutations/deltaConfirmation.js +0 -235
  578. package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
  579. package/dist/transactions/mutations/durableWriteStore.js +0 -12
  580. package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
  581. package/dist/transactions/mutations/optimisticApply.js +0 -65
  582. package/dist/transactions/mutations/replayValidation.d.ts +0 -187
  583. package/dist/transactions/mutations/replayValidation.js +0 -164
  584. package/dist/utils/mobxSetup.d.ts +0 -53
  585. package/dist/utils/mobxSetup.js +0 -330
  586. package/dist/views/QueryView.d.ts +0 -79
  587. package/dist/views/QueryView.js +0 -218
  588. package/dist/views/ViewRegistry.d.ts +0 -20
  589. package/dist/views/ViewRegistry.js +0 -55
  590. package/dist/views/incrementalView.d.ts +0 -45
  591. package/dist/views/incrementalView.js +0 -69
  592. package/dist/webhooks/events.d.ts +0 -43
  593. package/dist/webhooks/events.js +0 -42
  594. package/dist/webhooks/index.d.ts +0 -8
  595. package/dist/webhooks/index.js +0 -8
  596. package/dist/wire/index.d.ts +0 -1
  597. package/dist/wire/index.js +0 -8
@@ -1,230 +0,0 @@
1
- import { z } from 'zod';
2
- /**
3
- * Sync-group roles — the fan-out vocabulary, as typed data.
4
- *
5
- * A *sync group* is the unit the broadcast layer routes deltas on. On the wire
6
- * it's a `kind:id` string, but that serialization is owned entirely by this
7
- * module — callers never hand-write `'org:abc'`. Instead they declare a typed
8
- * {@link Role} (`kind` + which field supplies the id) and the engine mints the
9
- * branded {@link SyncGroup} string via {@link syncGroup}.
10
- *
11
- * Two reading directions, one shape:
12
- *
13
- * • {@link IdentityRole} — "which groups may this *participant* subscribe to?"
14
- * Reads fields off an identity context (`organizationId`, `teamIds`).
15
- *
16
- * • {@link EntityRole} — "which groups does this *record* live in?" Reads
17
- * fields off the record itself (`id`, `reportId`), so the server can fan a
18
- * committed delta to the right entity streams regardless of what the
19
- * committer was subscribed to.
20
- *
21
- * Roles are pure data (no closures) so a `Schema` round-trips through the
22
- * control plane and the reconstructed copy behaves identically.
23
- */
24
- // ── Sync-group wire form (branded) ──────────────────────────────────────────
25
- /**
26
- * The branded wire form of a sync group: `${kind}:${id}`. Branded so a raw
27
- * string can't masquerade as one — the only way to produce a `SyncGroup` is
28
- * {@link syncGroup}. Because the brand is an intersection it's still assignable
29
- * *to* `string`, so existing `string[]` plumbing keeps working unchanged.
30
- */
31
- export const syncGroupSchema = z
32
- .templateLiteral([z.string().regex(/^[a-z][a-z0-9_]*$/), ':', z.string().min(1)])
33
- .brand();
34
- /**
35
- * Mint a sync-group string. The single place the `kind:id` convention lives —
36
- * if the wire format ever changes (structured columns, a different separator),
37
- * it changes here and nowhere else.
38
- */
39
- export function syncGroup(kind, id) {
40
- return `${kind}:${id}`;
41
- }
42
- /**
43
- * Runtime validation for {@link SyncGroupInput}, used wherever a group crosses a
44
- * trust boundary such as minting a capability or an ephemeral key. A malformed
45
- * group is rejected with `invalid_sync_group` rather than stored and left
46
- * silently subscribed to nothing.
47
- */
48
- export const syncGroupInputSchema = z.union([z.literal('default'), syncGroupSchema]);
49
- /** Runtime guard matching {@link SyncGroupInput}. */
50
- export function isSyncGroupInput(value) {
51
- return syncGroupInputSchema.safeParse(value).success;
52
- }
53
- // ── Identity anchors (closed vocabulary) ────────────────────────────────────
54
- /**
55
- * The sync-group kinds the authentication provider mints directly onto an
56
- * identity. This is a fixed vocabulary: add to this list rather than write a
57
- * new namespace string inline.
58
- *
59
- * - `org:<organizationId>` — every member of the organization
60
- * - `user:<participantId>` — the participant itself
61
- * - `project:<projectId>` — every credential scoped to the project; the
62
- * organization's default project shares the organization's id
63
- *
64
- * Schema-declared roles ({@link identityRole} and {@link entityRole}) extend
65
- * this vocabulary per application; the kinds here are the ones the engine
66
- * reserves.
67
- */
68
- export const IDENTITY_ANCHOR_KINDS = ['org', 'user', 'project'];
69
- /** Mint an engine-reserved identity anchor (typed wrapper over {@link syncGroup}). */
70
- export function identityAnchor(kind, id) {
71
- return syncGroup(kind, id);
72
- }
73
- // ── Role source ─────────────────────────────────────────────────────────────
74
- /** Validates how a role pulls ids out of a context (identity or record). */
75
- export const roleSourceSchema = z.object({
76
- /** The context field to read, e.g. `'organizationId'`, `'id'`, `'reportId'`. */
77
- field: z.string().regex(/^[a-zA-Z_][a-zA-Z0-9_]*$/, 'source must be a valid identifier'),
78
- /**
79
- * When `true`, `field` holds an array; every non-empty string element yields
80
- * one group. When `false` (default), `field` is a scalar; truthy → one group.
81
- */
82
- multi: z.boolean(),
83
- });
84
- // ── Role (kind + source — no template string) ───────────────────────────────
85
- /**
86
- * A sync-group role: a typed `kind` plus the field that supplies the id. The
87
- * wire string is `${kind}:${id}`, built by the engine — there is deliberately
88
- * no template/placeholder for the author to get wrong.
89
- */
90
- export const roleSchema = z.object({
91
- kind: z.string().regex(/^[a-z][a-z0-9_]*$/, 'kind must be a lowercase identifier, e.g. "report"'),
92
- source: roleSourceSchema,
93
- });
94
- /** Validates an {@link IdentityRole}. */
95
- export const identityRoleSchema = roleSchema;
96
- /** Validates an {@link EntityRole}. */
97
- export const entityRoleSchema = roleSchema;
98
- /**
99
- * Validates a model's `scope` declaration: `true` (kind = typename) or an
100
- * explicit lowercase kind string. The same vocabulary the roles use, so the
101
- * whole sync-group declaration surface is Zod-validated, not hand-checked.
102
- */
103
- export const scopeSchema = z.union([
104
- z.boolean(),
105
- z.string().regex(/^[a-z][a-z0-9_]*$/, 'scope kind must be a lowercase identifier, e.g. "workspace"'),
106
- ]);
107
- /**
108
- * Validates a model's `grants` membership edge. Both values are relation names
109
- * declared on the same model (`subject` → identity, `scope` → scope root); that
110
- * the relations actually exist + are `belongsTo` is a cross-field check done in
111
- * `defineSchema` where the relation map is in scope.
112
- */
113
- export const grantsRefSchema = z.object({
114
- subject: z.string().regex(/^[a-zA-Z_][a-zA-Z0-9_]*$/, 'grants.subject must name a relation'),
115
- scope: z.string().regex(/^[a-zA-Z_][a-zA-Z0-9_]*$/, 'grants.scope must name a relation'),
116
- });
117
- /**
118
- * The authoring form of a model's sync-group routing — the `groups: { ... }`
119
- * option. One object collects the three independent routing controls. This is a
120
- * separate concern from `policy`, which governs tenant isolation: `policy`
121
- * decides who may read a row, while `groups` decides which change channels a row
122
- * fans into.
123
- *
124
- * - `root` — marks this model a scope root, so its records form the group
125
- * `<kind>:<id>` (the kind defaults to the typename).
126
- * - `grants` — a membership edge granting an identity access to a scope root.
127
- * - `roles` — record-to-group roles keyed on a plain field rather than a
128
- * relation, such as inbox fan-out. Accepts a single role or an array.
129
- */
130
- export const groupsInputSchema = z.object({
131
- root: scopeSchema.optional(),
132
- grants: grantsRefSchema.optional(),
133
- roles: z.union([entityRoleSchema, z.array(entityRoleSchema)]).optional(),
134
- });
135
- // ── Factories ───────────────────────────────────────────────────────────────
136
- function makeRole(spec) {
137
- return { kind: spec.kind, source: { field: spec.source, multi: spec.multi ?? false } };
138
- }
139
- /** Build an identity-anchored role. `multi` defaults to `false`. */
140
- export function identityRole(spec) {
141
- return makeRole(spec);
142
- }
143
- /** Build a record-anchored role. `multi` defaults to `false`. */
144
- export function entityRole(spec) {
145
- return makeRole(spec);
146
- }
147
- // ── Evaluation ──────────────────────────────────────────────────────────────
148
- /**
149
- * Evaluate a {@link RoleSource} against a context. Absent or falsy fields yield
150
- * `[]`, so a role whose field isn't present (a user with no `teamIds`, a record
151
- * with no `reportId`) is a silent no-op.
152
- */
153
- export function extractRoleIds(context, source) {
154
- const raw = context[source.field];
155
- if (source.multi) {
156
- return Array.isArray(raw)
157
- ? raw.filter((t) => typeof t === 'string' && t.length > 0)
158
- : [];
159
- }
160
- return raw ? [String(raw)] : [];
161
- }
162
- /** Identity-side name for {@link extractRoleIds}. */
163
- export const extractIdentityIds = extractRoleIds;
164
- /** Record-side name for {@link extractRoleIds}. */
165
- export const extractEntityIds = extractRoleIds;
166
- /**
167
- * Compose the sync groups an identity may subscribe to, from the schema's
168
- * registered {@link IdentityRole}s. Returns `[]` when no role produces an id;
169
- * the caller treats `[]` as "no scope", not "match everything".
170
- */
171
- export function composeIdentitySyncGroups(identity, schema) {
172
- const out = new Set();
173
- for (const role of schema.identityRoles) {
174
- for (const id of extractRoleIds(identity, role.source)) {
175
- if (id)
176
- out.add(syncGroup(role.kind, id));
177
- }
178
- }
179
- return Array.from(out);
180
- }
181
- /**
182
- * Compose the sync groups a record belongs to, from the model's registered
183
- * {@link EntityRole}s. Mirror of {@link composeIdentitySyncGroups}, reading the
184
- * record instead of an identity. Returns `[]` when the model has no entity
185
- * roles (the delta then fans on its base `org:`/`user:` groups only).
186
- */
187
- export function composeEntitySyncGroups(record, def) {
188
- if (!def.entityRoles?.length)
189
- return [];
190
- const out = new Set();
191
- for (const role of def.entityRoles) {
192
- for (const id of extractRoleIds(record, role.source)) {
193
- if (id)
194
- out.add(syncGroup(role.kind, id));
195
- }
196
- }
197
- return Array.from(out);
198
- }
199
- /**
200
- * Narrow a client's requested sync-group set to the groups it is actually
201
- * allowed to subscribe to. This helper is fully generic — it never inspects the
202
- * group strings — so it lives beside the composition helpers above.
203
- *
204
- * Behaviour:
205
- * - If the client requested no groups, return the full identity-derived set,
206
- * which is this participant's default subscription scope.
207
- * - If the client requested some groups, keep only those that appear in the
208
- * identity-derived allowed set and drop the rest, reporting the dropped
209
- * groups through the optional `logDropped` callback.
210
- * - If nothing survives the filter, fall back to the full allowed set rather
211
- * than return `[]`, which would otherwise collapse to the server-side
212
- * `'default'` fallback and deliver no changes at all.
213
- */
214
- export function intersectRequestedWithAllowed(args) {
215
- const { requested, allowed, logDropped } = args;
216
- if (requested.length === 0)
217
- return allowed;
218
- const allowedSet = new Set(allowed);
219
- const accepted = [];
220
- const dropped = [];
221
- for (const g of requested) {
222
- if (allowedSet.has(g))
223
- accepted.push(g);
224
- else
225
- dropped.push(g);
226
- }
227
- if (dropped.length > 0 && logDropped)
228
- logDropped(dropped);
229
- return accepted.length > 0 ? accepted : allowed;
230
- }
@@ -1,351 +0,0 @@
1
- /**
2
- * Schema Definition + Type Inference
3
- *
4
- * defineSchema() wraps your models. Types are inferred via Zod — no custom type system.
5
- *
6
- * Usage:
7
- * import { z } from 'zod';
8
- * import { defineSchema, model, relation } from '@abloatai/ablo/schema';
9
- *
10
- * const schema = defineSchema({
11
- * tasks: model({
12
- * title: z.string(),
13
- * status: z.enum(['todo', 'doing', 'done']).default('todo'),
14
- * projectId: z.string().optional(),
15
- * }, {
16
- * project: relation.belongsTo('projects', 'projectId'),
17
- * }),
18
- * });
19
- *
20
- * type Task = InferModel<typeof schema, 'tasks'>;
21
- */
22
- import { z } from 'zod';
23
- import type { ModelDef, RelationRecord } from './model.js';
24
- import type { RelationDef } from './relation.js';
25
- import type { IdentityRole } from './roles.js';
26
- import { type FieldRef } from './fieldRef.js';
27
- export { type IdentityRole, type IdentityRoleSource, type IdentityContext, type EntityRole, type EntityRoleSource, type EntityContext, type RoleSource, type RoleContext, type SyncGroup, type SyncGroupInput, identityRole, entityRole, extractIdentityIds, extractEntityIds, composeIdentitySyncGroups, composeEntitySyncGroups, intersectRequestedWithAllowed, syncGroup, syncGroupSchema, syncGroupInputSchema, isSyncGroupInput, identityRoleSchema, entityRoleSchema, roleSchema, roleSourceSchema, scopeSchema, grantsRefSchema, groupsInputSchema, type GroupsInput, } from './roles.js';
28
- /** The set of built-in casing conventions supported by `defineSchema`. */
29
- export type CasingConvention = 'snake_case' | 'camelCase';
30
- /** Plug point for custom conventions (e.g. mixed legacy databases). */
31
- export type CasingFn = (jsField: string) => string;
32
- /** `defineSchema`'s casing option. Identity when unset. */
33
- export type Casing = CasingConvention | CasingFn;
34
- /**
35
- * A server-authored identity value that can fill one of a customer's Postgres
36
- * session settings. Deliberately a closed set — every member is resolved by Ablo
37
- * from the authenticated `ek_` and the plane, never from client-supplied data —
38
- * so a mapping can forward the tenant identity Ablo already trusts but can never
39
- * widen a writer's scope. Mirrors the fields the engine sets on the direct-write
40
- * connection (`app.current_org_id`, `app.current_project_id`, …).
41
- */
42
- export type SessionSettingSource = 'orgId' | 'projectId' | 'environment' | 'sandboxId' | 'participantId' | 'participantKind';
43
- /**
44
- * A map from a Postgres session-setting name the customer's RLS policies read to
45
- * the Ablo identity that fills it — e.g. `{ 'app.current_org': 'orgId' }`. The
46
- * setting name is the key (it takes exactly one source), so a duplicate is
47
- * unrepresentable rather than validated away. See
48
- * {@link DefineSchemaOptions.sessionSettings} and ADR 0011.
49
- */
50
- export type SessionSettings = Readonly<Record<string, SessionSettingSource>>;
51
- /**
52
- * Session settings Ablo already sets on its direct-write connection. A
53
- * `sessionSettings` entry FORWARDS Ablo's trusted context into a setting the
54
- * customer's own policies read — it may never reassign one of these, which would
55
- * let a schema push relax the engine's own scoping, timeouts, or `row_security`.
56
- * Shared with the engine's direct-write seam so authoring-time validation and
57
- * the runtime guard read one list. See ADR 0011.
58
- */
59
- export declare const RESERVED_SESSION_SETTINGS: readonly string[];
60
- export interface DefineSchemaOptions {
61
- /**
62
- * How to translate camelCase JS field names into database column
63
- * identifiers. Applied once, at schema build, to every relation's
64
- * `foreignKey` to produce `foreignKeyColumn`. Consumers whose DB
65
- * columns already match their JS field names can omit this — the
66
- * default is identity (no transform).
67
- *
68
- * Accepts a named convention or a custom function:
69
- *
70
- * ```ts
71
- * defineSchema({ ... }, { casing: 'snake_case' })
72
- * defineSchema({ ... }, { casing: (key) => key.toUpperCase() })
73
- * ```
74
- */
75
- readonly casing?: Casing;
76
- /**
77
- * Identity-anchored sync-group roles. The server's
78
- * `composeIdentitySyncGroups` reads these to build the set of groups a
79
- * participant may subscribe to. See {@link IdentityRole} for the shape: you
80
- * define the `kind` and which identity field supplies the id, with no fixed
81
- * vocabulary of kinds.
82
- *
83
- * Leave this unset for schemas that need no identity-derived scoping, such as
84
- * fully public read models. When it is unset, `composeIdentitySyncGroups`
85
- * returns `[]` and callers fall back to whatever explicit sync groups the
86
- * authentication provider attached to the identity.
87
- */
88
- readonly identityRoles?: readonly IdentityRole[];
89
- /**
90
- * Extra Postgres session settings Ablo's direct-write connection applies from
91
- * your authenticated identity, so your row-level-security policies read them
92
- * (ADR 0011). Before every direct write, Ablo already `SET LOCAL`s a fixed
93
- * bundle (`app.current_org_id`, `app.current_project_id`, …). If your policies
94
- * read a differently-named setting your own app sets per-connection — e.g. a
95
- * restrictive policy on `current_setting('app.current_org')` — map that
96
- * setting to the identity that fills it, and Ablo sets it too:
97
- *
98
- * ```ts
99
- * defineSchema({ ... }, {
100
- * sessionSettings: { 'app.current_org': 'orgId' },
101
- * })
102
- * ```
103
- *
104
- * The key is the setting name your policies read; the value is a closed set of
105
- * identities Ablo authenticates, so a mapping can narrow what the writer sees
106
- * but never widen it. Do NOT carve a policy exception for the writer role —
107
- * that exempts exactly the writes you want governed. Leave unset when your
108
- * policies read the settings Ablo already applies (or when a table has no RLS).
109
- */
110
- readonly sessionSettings?: SessionSettings;
111
- }
112
- /** A record of model names → model definitions */
113
- export type SchemaRecord = Record<string, ModelDef>;
114
- /**
115
- * Base fields every synced model gets automatically.
116
- *
117
- * Exported (internal) so `parseSchema` can rebuild a model's validator the
118
- * same way `defineSchema` does — `baseFieldsSchema.merge(modelSchema)` — when
119
- * reconstructing a `Schema` from its JSON form.
120
- */
121
- export declare const baseFieldsSchema: z.ZodObject<{
122
- id: z.ZodString;
123
- createdAt: z.ZodDate;
124
- updatedAt: z.ZodDate;
125
- organizationId: z.ZodOptional<z.ZodString>;
126
- createdBy: z.ZodOptional<z.ZodString>;
127
- }, z.core.$strip>;
128
- /**
129
- * The base-column names every model carries automatically — the keys of
130
- * {@link baseFieldsSchema}, kept here as the single source of truth. Code
131
- * generation reads it to avoid emitting a base column twice, and
132
- * {@link defineSchema} uses it to reject a model that redeclares one, since
133
- * merging the user's field over the base field would produce a `string & Date`
134
- * type and break the build.
135
- */
136
- export declare const BASE_FIELDS: readonly ["id", "createdAt", "updatedAt", "organizationId", "createdBy"];
137
- /** The base fields type — pure data columns. */
138
- export type BaseModelFields = z.infer<typeof baseFieldsSchema>;
139
- /**
140
- * Methods every model instance carries. These are intersected into
141
- * {@link InferModel}, the read-side type, but not into the create or update
142
- * input types, since methods are not valid input.
143
- */
144
- export interface BaseModelMethods {
145
- /** Wire-format model name (e.g. `'Section'`, `'Comment'`). */
146
- getModelName(): string;
147
- /** Plain-object serialization suitable for sending over the wire. */
148
- toJSON(): Record<string, unknown>;
149
- }
150
- /** The schema object returned by defineSchema() */
151
- export interface Schema<S extends SchemaRecord = SchemaRecord> {
152
- /** The raw model definitions */
153
- readonly models: S;
154
- /**
155
- * Every declared field as a {@link FieldRef} — the field as a value rather
156
- * than a quoted name: `schema.fields.tasks.status`.
157
- *
158
- * A surface that names a field takes one of these instead of a string, so a
159
- * name that does not exist stops compiling and a rename is a compile error at
160
- * every use. Claims are the first caller; anything else that has to say
161
- * "which field" should take a reference for the same reason.
162
- *
163
- * Base fields (`id`, `createdAt`, …) are not here: the schema does not
164
- * declare them, and a caller naming one means the row, not a part of it.
165
- */
166
- readonly fields: {
167
- readonly [K in keyof S]: S[K] extends ModelDef<infer Shape> ? {
168
- readonly [F in Extract<keyof Shape, string>]: FieldRef;
169
- } : never;
170
- };
171
- /** Zod schemas with base fields merged in */
172
- readonly validators: {
173
- readonly [K in keyof S]: S[K] extends ModelDef<infer Shape> ? z.ZodObject<Shape & typeof baseFieldsSchema.shape> : never;
174
- };
175
- /**
176
- * Identity-anchored sync-group roles registered via
177
- * `defineSchema({...}, { identityRoles })`. Empty array when unset.
178
- * Server's `composeIdentitySyncGroups(identity, schema)` reads this
179
- * to derive a participant's allowed sync-group set.
180
- */
181
- readonly identityRoles: readonly IdentityRole[];
182
- /**
183
- * Session settings registered via `defineSchema({...}, { sessionSettings })`
184
- * (ADR 0011). The engine's direct-write path reads this to `SET LOCAL` each
185
- * named setting from server-authored context before applying DML, so the
186
- * customer's RLS governs Ablo's writes. Empty object when unset.
187
- */
188
- readonly sessionSettings: SessionSettings;
189
- /**
190
- * Set only on a projection produced by `selectModels`/`omitModels`: the
191
- * content hash of the FULL source schema the subset was cut from. A subset
192
- * hashes differently from the full schema it belongs to, so a projection-bound
193
- * client would otherwise always report drift against a server running the full
194
- * schema. The drift check treats the client as in-sync when the server's active
195
- * hash matches EITHER this client's own (subset) hash or this source hash — so
196
- * a current projection stays quiet while a genuinely behind server still warns.
197
- * Absent on a schema authored directly, where the client's own hash is the
198
- * deployed hash and plain equality is correct. Excluded from `toSchemaJSON`, so
199
- * stamping it never perturbs `schemaHash`.
200
- */
201
- readonly sourceSchemaHash?: string;
202
- }
203
- /**
204
- * Infer the full model type from a schema.
205
- * Includes base fields (id, createdAt, updatedAt, etc.)
206
- *
207
- * ```ts
208
- * type Task = InferModel<typeof schema, 'tasks'>;
209
- * ```
210
- */
211
- /** The schema bound via `declare module … interface Register { Schema: … }`
212
- * (the `ablo/register.ts` the scaffold writes). `never` when not registered. */
213
- type RegisteredSchema = import('../types/global.js').Register extends {
214
- Schema: infer S extends Schema;
215
- } ? S : never;
216
- /**
217
- * The primary model-type helper. Once your project's `ablo/register.ts`
218
- * registers the schema, a single argument is all it takes:
219
- *
220
- * ```ts
221
- * type Task = Model<'tasks'>;
222
- * ```
223
- *
224
- * Without that registration, or for a second schema, pass the schema
225
- * explicitly: `Model<typeof schema, 'tasks'>`.
226
- */
227
- export type Model<A, B = never> = [B] extends [never] ? A extends keyof RegisteredSchema['models'] ? InferModel<RegisteredSchema, A> : never : A extends Schema ? InferModel<A, B extends keyof A['models'] ? B : never> : never;
228
- /**
229
- * The row type {@link Model} resolves to. Internal: `Model<typeof schema,
230
- * 'tasks'>` is the published spelling, because it reads as the domain rather
231
- * than the machinery. This one is no longer exported from any subpath — it
232
- * stays because `Model` is defined in terms of it, not as a second name for
233
- * the same idea.
234
- */
235
- export type InferModel<S extends Schema, ModelName extends keyof S['models']> = S['models'][ModelName] extends ModelDef<infer Shape, infer R, infer C> ? // `Omit<…, keyof BaseModelFields>` so a model that (wrongly) redeclares a
236
- Omit<z.infer<z.ZodObject<Shape>>, keyof BaseModelFields> & BaseModelFields & BaseModelMethods & InferComputed<C> & InferRelations<S, R> : never;
237
- /**
238
- * Infer the relation accessor types from a model's relations record.
239
- *
240
- * At runtime the engine installs a getter for each declared relation, so this
241
- * type mirrors them and you can read `section.blocks` and `section.report` without a
242
- * cast.
243
- *
244
- * - `hasMany` → `InferModel<S, Target>[]`
245
- * - `belongsTo` / `hasOne` → `InferModel<S, Target> | undefined` (undefined
246
- * when the foreign key is unset or the parent has not loaded yet)
247
- *
248
- * Kept `readonly` because the accessors are getters with no setter — assigning
249
- * to `section.blocks` would have no effect at runtime.
250
- */
251
- export type InferRelations<S extends Schema, R extends RelationRecord> = string extends keyof R ? unknown : {
252
- readonly [K in keyof R]: R[K] extends RelationDef<infer Type, infer Target> ? Target extends keyof S['models'] ? Type extends 'hasMany' ? InferModel<S, Target>[] : Type extends 'hasOne' | 'belongsTo' ? InferModel<S, Target> | undefined : never : never : never;
253
- };
254
- /**
255
- * The row shape a reactive read returns: the model's data fields, base fields,
256
- * and schema computed getters — WITHOUT relation accessors and WITHOUT model
257
- * methods. Derived from the model definition, exactly like {@link InferModel},
258
- * mirroring what `toReactiveSnapshot()` produces at runtime.
259
- *
260
- * Relations (`hasMany` / `belongsTo`) are store-backed getters that exist only
261
- * on the pool's model instances, so a reactive row honestly omits them —
262
- * reading `row.blocks` is a compile error instead of a silent `undefined`.
263
- * Compose relations through a selector or hook instead.
264
- *
265
- * The same pairing other data layers converged on: Zero's data-only `Row<...>`
266
- * with relations added per-query, Prisma's scalar-only model types with
267
- * `GetPayload<{ include }>`, mobx-state-tree's `Instance<T>` / `SnapshotOut<T>`.
268
- */
269
- export type InferRow<S extends Schema, ModelName extends keyof S['models']> = S['models'][ModelName] extends ModelDef<infer Shape, RelationRecord, infer C> ? // Same reserved-field guard as InferModel — see the comment there.
270
- Omit<z.infer<z.ZodObject<Shape>>, keyof BaseModelFields> & BaseModelFields & InferComputed<C> : never;
271
- /**
272
- * The reactive-row companion to {@link Model}. Once your project's
273
- * `ablo/register.ts` registers the schema, a single argument is all it takes:
274
- *
275
- * ```ts
276
- * type SectionRow = Row<'sections'>; // data fields + computeds, no relations
277
- * type Section = Model<'sections'>; // the pool's model instance
278
- * ```
279
- *
280
- * Without that registration, or for a second schema, pass the schema
281
- * explicitly: `Row<typeof schema, 'sections'>`.
282
- */
283
- export type Row<A, B = never> = [B] extends [never] ? A extends keyof RegisteredSchema['models'] ? InferRow<RegisteredSchema, A> : never : A extends Schema ? InferRow<A, B extends keyof A['models'] ? B : never> : never;
284
- /**
285
- * Infer the return types of computed getters.
286
- * Maps each computed function's return type into a readonly property.
287
- *
288
- * ```ts
289
- * // Given: computed: { displayTitle: (self) => self.title || 'Untitled' }
290
- * // Infers: { readonly displayTitle: string }
291
- * ```
292
- */
293
- export type InferComputed<C> = string extends keyof C ? unknown : {
294
- readonly [K in keyof C]: C[K] extends (...args: any[]) => infer R ? R : never;
295
- };
296
- /**
297
- * Infer the create input type. Only schema-defined fields are accepted —
298
- * base fields (id, createdAt, updatedAt) are auto-generated by the SDK
299
- * and cannot be passed by the consumer.
300
- *
301
- * The only exception is `id`: consumers can optionally provide one for
302
- * client-generated IDs (useful for optimistic UI that needs to reference
303
- * the entity before the server confirms).
304
- *
305
- * ```ts
306
- * type CreateTask = InferCreate<typeof schema, 'tasks'>;
307
- * // { title: string; status?: 'todo' | 'doing' | 'done'; id?: string }
308
- * // createdAt, updatedAt are NOT accepted — they're auto-generated
309
- * ```
310
- */
311
- export type InferCreate<S extends Schema, ModelName extends keyof S['models']> = S['models'][ModelName] extends ModelDef<infer Shape> ? // Same reserved-field guard as InferModel: drop any (wrongly) redeclared
312
- Omit<z.input<z.ZodObject<Shape>>, keyof BaseModelFields> & Partial<BaseModelFields> : never;
313
- /**
314
- * Extract all model names from a schema.
315
- */
316
- export type InferModelNames<S extends Schema> = keyof S['models'] & string;
317
- /**
318
- * The value type for inserting a new row. Same shape as {@link InferCreate}:
319
- * the fields you can write, plus an optional `id` for client-generated ids.
320
- */
321
- export type InsertValue<S extends Schema, ModelName extends keyof S['models']> = InferCreate<S, ModelName>;
322
- /**
323
- * The value type for upserting (insert or overwrite). Same shape as
324
- * {@link InsertValue} — a full row. If a row with the same `id` exists,
325
- * it gets overwritten.
326
- */
327
- export type UpsertValue<S extends Schema, ModelName extends keyof S['models']> = InsertValue<S, ModelName>;
328
- /**
329
- * The value type for updating an existing row. `id` is required (identifies
330
- * the row to update); all other fields are optional (only provided fields
331
- * are changed).
332
- */
333
- export type UpdateValue<S extends Schema, ModelName extends keyof S['models']> = S['models'][ModelName] extends ModelDef<infer Shape> ? {
334
- id: string;
335
- } & Partial<z.input<z.ZodObject<Shape>>> : never;
336
- /**
337
- * The value type for deleting a row. Just the primary key.
338
- */
339
- export interface DeleteId<S extends Schema, ModelName extends keyof S['models']> {
340
- id: string;
341
- }
342
- /**
343
- * One {@link FieldRef} per declared field, keyed by model then field.
344
- *
345
- * Every construction of a {@link Schema} goes through here — `defineSchema`,
346
- * the `selectModels`/`omitModels` projections, and the deserializer — so a
347
- * projection carries references for exactly the models it kept and a schema
348
- * rebuilt from JSON carries them at all.
349
- */
350
- export declare function buildFieldRefs(models: Record<string, ModelDef>): Record<string, Record<string, FieldRef>>;
351
- export declare function defineSchema<const S extends SchemaRecord>(models: S, options?: DefineSchemaOptions): Schema<S>;