@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,45 +0,0 @@
1
- /**
2
- * When a model's rows are loaded from the server.
3
- *
4
- * - `instant` — loaded during bootstrap, before the model is first used.
5
- * - `lazy` — loaded all at once on first access.
6
- *
7
- * One declaration serves both sides of the seam. `LoadStrategy.instant` is the
8
- * value the engine branches on once a model is registered; `'instant'` is the
9
- * word an author writes in `model(…, { load })`. They are the same name because
10
- * they are the same axis — a const object merged with the type of its own
11
- * values, rather than an enum, because a string enum is nominal and would
12
- * refuse the plain `'instant'` an author actually types.
13
- *
14
- * The set is deliberately this small. It previously named `partial`,
15
- * `explicitlyRequested`, and `local` on the runtime side and `manual` on the
16
- * authoring side, and not one of those was reachable end to end: `manual` had
17
- * no implementation and resolved to `lazy`, while the other three had no way to
18
- * be declared. A member no schema can produce, or no branch can observe, is a
19
- * promise the engine has no way to keep.
20
- */
21
- export declare const LoadStrategy: {
22
- /** Loaded during startup, before it is first used — for models needed right away. */
23
- readonly instant: "instant";
24
- /** Loaded all at once the first time it is needed — for secondary models. */
25
- readonly lazy: "lazy";
26
- };
27
- export type LoadStrategy = (typeof LoadStrategy)[keyof typeof LoadStrategy];
28
- /** The strategy a model gets when it declares none. */
29
- export declare const DEFAULT_LOAD_STRATEGY: LoadStrategy;
30
- /**
31
- * Whether a model's rows arrive in the bootstrap payload rather than on first
32
- * access. This is the question the client asks when it builds the bootstrap
33
- * subscription and the question the server asks when it assembles the payload,
34
- * and the two must answer it identically or a model is requested by one side
35
- * and withheld by the other.
36
- *
37
- * It is a function rather than a comparison spelled at each site because the
38
- * sites disagreed about how to spell it: one asked `load !== 'lazy'`, another
39
- * `load === 'instant'`, a third `load === 'lazy' ? … : …`. Against a two-member
40
- * set those are the same predicate, so nothing failed. Against a third member
41
- * they are three different predicates, and the first would have enrolled it in
42
- * bootstrap while the second withheld it — the kind of split that surfaces as
43
- * rows that never arrive, far from the line that caused it.
44
- */
45
- export declare function loadsAtBootstrap(load: LoadStrategy | undefined): boolean;
@@ -1,46 +0,0 @@
1
- /**
2
- * When a model's rows are loaded from the server.
3
- *
4
- * - `instant` — loaded during bootstrap, before the model is first used.
5
- * - `lazy` — loaded all at once on first access.
6
- *
7
- * One declaration serves both sides of the seam. `LoadStrategy.instant` is the
8
- * value the engine branches on once a model is registered; `'instant'` is the
9
- * word an author writes in `model(…, { load })`. They are the same name because
10
- * they are the same axis — a const object merged with the type of its own
11
- * values, rather than an enum, because a string enum is nominal and would
12
- * refuse the plain `'instant'` an author actually types.
13
- *
14
- * The set is deliberately this small. It previously named `partial`,
15
- * `explicitlyRequested`, and `local` on the runtime side and `manual` on the
16
- * authoring side, and not one of those was reachable end to end: `manual` had
17
- * no implementation and resolved to `lazy`, while the other three had no way to
18
- * be declared. A member no schema can produce, or no branch can observe, is a
19
- * promise the engine has no way to keep.
20
- */
21
- export const LoadStrategy = {
22
- /** Loaded during startup, before it is first used — for models needed right away. */
23
- instant: 'instant',
24
- /** Loaded all at once the first time it is needed — for secondary models. */
25
- lazy: 'lazy',
26
- };
27
- /** The strategy a model gets when it declares none. */
28
- export const DEFAULT_LOAD_STRATEGY = LoadStrategy.instant;
29
- /**
30
- * Whether a model's rows arrive in the bootstrap payload rather than on first
31
- * access. This is the question the client asks when it builds the bootstrap
32
- * subscription and the question the server asks when it assembles the payload,
33
- * and the two must answer it identically or a model is requested by one side
34
- * and withheld by the other.
35
- *
36
- * It is a function rather than a comparison spelled at each site because the
37
- * sites disagreed about how to spell it: one asked `load !== 'lazy'`, another
38
- * `load === 'instant'`, a third `load === 'lazy' ? … : …`. Against a two-member
39
- * set those are the same predicate, so nothing failed. Against a third member
40
- * they are three different predicates, and the first would have enrolled it in
41
- * bootstrap while the second withheld it — the kind of split that surfaces as
42
- * rows that never arrive, far from the line that caused it.
43
- */
44
- export function loadsAtBootstrap(load) {
45
- return (load ?? DEFAULT_LOAD_STRATEGY) === LoadStrategy.instant;
46
- }
@@ -1,379 +0,0 @@
1
- /**
2
- * Defines a model — one table's worth of fields, and one options object holding
3
- * everything else the engine needs to know about it. A model is a Zod object schema
4
- * paired with those options; the row type is inferred directly from Zod, with no
5
- * separate type system to keep in sync.
6
- *
7
- * Usage:
8
- * import { z } from 'zod';
9
- * import { model, relation } from '@abloatai/ablo/schema';
10
- *
11
- * const tasks = model({
12
- * title: z.string(),
13
- * status: z.enum(['todo', 'doing', 'done']).default('todo'),
14
- * projectId: z.string().optional(),
15
- * }, {
16
- * relations: { project: relation.belongsTo('projects', 'projectId') },
17
- * load: 'lazy',
18
- * });
19
- */
20
- import { z } from 'zod';
21
- import type { RelationDef } from './relation.js';
22
- import type { EntityRole, GroupsInput } from './roles.js';
23
- import { type FieldMeta } from './field.js';
24
- import { type Tenancy, type PolicyInput } from './tenancy.js';
25
- export type { ScopedViaRef, Tenancy, PolicyInput } from './tenancy.js';
26
- import { type ModelResidency } from './residency.js';
27
- import type { ConflictAxis } from '../policy/types.js';
28
- export type { ConflictAxis } from '../policy/types.js';
29
- import { LoadStrategy } from './loadStrategy.js';
30
- export { LoadStrategy, DEFAULT_LOAD_STRATEGY, loadsAtBootstrap } from './loadStrategy.js';
31
- /** A record of relation definitions */
32
- export type RelationRecord = Record<string, RelationDef>;
33
- /**
34
- * Persistence hints for IndexedDB write-through and hydration.
35
- *
36
- * The sync engine's generic loader uses these to route incoming rows to
37
- * the right client-side store without the consumer wiring each model by
38
- * hand. `store` defaults to the model's {@link ModelDef.typename} (which
39
- * itself defaults to the schema key), so consumers only set this when
40
- * the IDB store name diverges from the typename.
41
- */
42
- export interface PersistOptions {
43
- /**
44
- * Name of the IndexedDB object store that backs this model.
45
- * Defaults to the model's {@link ModelDef.typename}.
46
- */
47
- store?: string;
48
- }
49
- /**
50
- * Declares a membership edge on a join model. See {@link ModelOptions.grants}
51
- * for semantics and how the server membership resolver reads it. Both fields
52
- * name `belongsTo` relations declared on the same model.
53
- */
54
- export interface GrantsRef {
55
- /** Relation name pointing at the identity that gains access (e.g. `'user'`). */
56
- subject: string;
57
- /** Relation name pointing at the scope-root entity (e.g. `'workspace'`). */
58
- scope: string;
59
- }
60
- /** Options for model() */
61
- export interface ModelOptions {
62
- /**
63
- * Edges from this model to others, keyed by the accessor name they create. The
64
- * engine reads them to index foreign keys, to order inserts so a parent row lands
65
- * before the rows referencing it, and to generate the accessors that let you read
66
- * `task.project` or `project.tasks` directly. Built with the {@link relation}
67
- * factories.
68
- *
69
- * ```ts
70
- * relations: {
71
- * project: relation.belongsTo('projects', 'projectId'),
72
- * comments: relation.hasMany('comments', 'taskId'),
73
- * }
74
- * ```
75
- */
76
- relations?: RelationRecord;
77
- /** When to load this model's data. Default: 'instant' */
78
- load?: LoadStrategy;
79
- /** Max records to bootstrap. Default: unlimited. Only applies to 'instant' strategy. */
80
- bootstrapLimit?: number;
81
- /** Order to sort by during bootstrap (e.g., 'created_at DESC'). */
82
- bootstrapOrderBy?: string;
83
- /**
84
- * The wire type name for this model — the value that identifies its rows on the
85
- * wire (the `__typename`). The loader stamps it onto incoming rows and uses it to
86
- * find the matching model class. It defaults to the schema key (`tasks` →
87
- * `'tasks'`); set it explicitly when the wire shape uses different casing, such as
88
- * schema key `block` mapping to typename `'Block'`.
89
- *
90
- * This is the one value that identifies the model on the wire; the client-side
91
- * store name, query result references, and delta routing all resolve through it.
92
- */
93
- typename?: string;
94
- /**
95
- * IndexedDB persistence hints. See {@link PersistOptions}.
96
- */
97
- persist?: PersistOptions;
98
- /**
99
- * The database table this model maps to. Defaults to the snake_case form of the
100
- * model name. Set it when the real table name does not follow that convention, so
101
- * queries read from the right table instead of a guessed name.
102
- */
103
- tableName?: string;
104
- /**
105
- * Row-access policy — decides which rows a tenant may read at all. A discriminated
106
- * union on `by`:
107
- *
108
- * - `{ by: 'column' }` — the row carries its own tenancy column (the default when
109
- * omitted). `column` overrides the column name, which defaults to
110
- * `organization_id`.
111
- * - `{ by: 'parent', fk, parent }` — inherit tenancy through a foreign key when the
112
- * table has no tenancy column of its own (for example `blocks` → section →
113
- * report → organization). In place of `organization_id = $1` the read emits
114
- * `WHERE <table>.<fk> IN (SELECT <parentKey> FROM <parent> WHERE
115
- * <parentTenantColumn> = $1)`. Use it for any `load: 'instant'` child table that
116
- * would otherwise expose other tenants' rows at bootstrap.
117
- * - `{ by: 'none' }` — genuinely global or reference data, such as a lookup table.
118
- * This makes the whole table readable across tenants, so it is only correct for
119
- * tables that have no tenant at all. It is a named branch rather than a falsy
120
- * flag, so it cannot be selected by accident.
121
- *
122
- * {@link resolvePolicy} normalizes this into the canonical {@link Tenancy} when the
123
- * model is built.
124
- */
125
- policy?: PolicyInput;
126
- /**
127
- * Which database a model's rows live in. `tenant` (the default) is tenant data
128
- * that provisioning places in the customer's own database; `control` is Ablo's own
129
- * data — the sync log, attribution, and audit records — which never leaves Ablo's
130
- * database. See {@link ModelResidency}.
131
- */
132
- plane?: ModelResidency;
133
- /**
134
- * Sync-group routing — decides which delta channels a row fans out to. This is
135
- * independent of {@link policy}, which governs read access. One object with three
136
- * optional parts:
137
- *
138
- * - `root` — marks this model a scope root, so each of its records forms the group
139
- * `<kind>:<id>`. The kind defaults to the lowercased typename (`Report` →
140
- * `report:<id>`); pass a string to override it (`root: 'matter'`). Child models
141
- * inherit a root's group through their `belongsTo` relations.
142
- * - `grants` — a membership edge that grants an identity access to a scope root.
143
- * Both values name `belongsTo` relations on this model (`subject` names the
144
- * identity, `scope` names the scope root). Use it only for sharing within an
145
- * organization.
146
- * - `roles` — explicit record-to-group roles keyed on a plain field, for routing
147
- * that does not follow a relation, such as fanning a message into a recipient's
148
- * inbox. Accepts one role or many.
149
- *
150
- * ```ts
151
- * // dataroomMember: { userId, dataroomId }
152
- * groups: { grants: { subject: 'user', scope: 'workspace' } }
153
- * // a message → its addressee's inbox, keyed on `toId`
154
- * groups: { roles: [entityRole({ kind: 'inbox', source: 'toId' })] }
155
- * ```
156
- */
157
- groups?: GroupsInput;
158
- /**
159
- * Write-conflict disposition, set per committer kind — decides what happens when a
160
- * commit collides with another participant's claim or with a stale snapshot of this
161
- * model. This is independent of {@link policy} (read access) and {@link groups}
162
- * (delta routing). It is a map keyed by the committer's kind (`user`, `agent`, or
163
- * `system`), with these outcomes as values:
164
- *
165
- * - `'overwrite'` — the write wins; that committer is never blocked.
166
- * - `'reject'` — the write is refused; that committer yields.
167
- * - `'notify'` — hold the write and hand the current value back so the committer
168
- * re-reads and re-applies (for stale writes only).
169
- *
170
- * A kind you omit falls back to the engine default: reject, while honoring
171
- * `onStale: 'notify'`. The value is plain data that travels with the schema to the
172
- * server, where the engine interprets it. For example:
173
- *
174
- * ```ts
175
- * // "a human's edit always wins (never blocked); an agent yields"
176
- * conflict: { user: 'overwrite', agent: 'reject' }
177
- * ```
178
- */
179
- conflict?: ConflictAxis;
180
- /**
181
- * Whether clients may create, update, and delete this model's rows through the
182
- * commit protocol. Defaults to true: declaring a model in your schema is the
183
- * opt-in, since a synced entity is almost always one you want to write. A model
184
- * left out of the mutation allowlist rejects writes with
185
- * `server_execute_unknown_model`.
186
- *
187
- * Set `mutable: false` (or use the `readOnly.*` shorthand, which sets it for you)
188
- * for server-managed projections such as stats, digests, or audit views, so those
189
- * cannot be written from a client. The server derives its mutation allowlist from
190
- * this flag; there is no separate hardcoded list to keep in step.
191
- */
192
- mutable?: boolean;
193
- /**
194
- * Defer setting up MobX observability until the model is first accessed by an
195
- * observing component. Defaults to false, which observes immediately.
196
- *
197
- * Use it for models created in bulk — during an import or a batch bootstrap —
198
- * where most instances are never rendered. The constructor skips the observability
199
- * setup, and calling `model.makeObservable()` performs it later when the model
200
- * enters the render tree. This avoids roughly 10ms of setup per instance when
201
- * creating hundreds of models that are never observed.
202
- */
203
- lazyObservable?: boolean;
204
- /**
205
- * Computed getters to install on the model instance. Each key becomes a getter;
206
- * its function receives the model instance as `self` and returns the computed
207
- * value.
208
- *
209
- * @example
210
- * model({ title: z.string(), metadata: z.string() }, {
211
- * computed: {
212
- * displayTitle: (self) => self.title || `Untitled`,
213
- * metadataObject: (self) => {
214
- * try { return JSON.parse(self.metadata || '{}'); }
215
- * catch { return {}; }
216
- * },
217
- * },
218
- * })
219
- */
220
- computed?: ComputedRecord;
221
- /**
222
- * Fields to back-fill from the connected sync identity when a stored row is missing
223
- * them, during self-healing of the local store.
224
- *
225
- * Healing runs on every row loaded from the local store at hydration and on every
226
- * delta merge. When a row is missing one of these fields, the engine writes the
227
- * matching identity value (the `organizationId` or `userId` passed to the sync
228
- * client) into the row before it is loaded. Without this, rows written by an older
229
- * version that did not set the field would read as `undefined` and break code that
230
- * assumes it is present.
231
- *
232
- * @example
233
- * autoFill: [
234
- * { field: 'organizationId', from: 'organizationId' },
235
- * { field: 'createdBy', from: 'userId' },
236
- * ]
237
- */
238
- autoFill?: readonly AutoFillRule[];
239
- /**
240
- * Fields whose absence marks a stored row as orphaned — corrupt enough that the
241
- * engine drops it instead of loading it.
242
- *
243
- * During self-healing, a row missing any listed field is discarded rather than
244
- * loaded. Use it for foreign keys whose absence would crash code that depends on
245
- * them — for example a child row that cannot be placed without its parent's id.
246
- *
247
- * @example requiredFields: ['sectionId']
248
- */
249
- requiredFields?: readonly string[];
250
- }
251
- /** Base type for computed getter records. Preserves return types via inference. */
252
- export type ComputedRecord = Record<string, (self: any) => any>;
253
- /**
254
- * Identity sources the sync engine can pull from when auto-filling a
255
- * record's missing field during IndexedDB self-healing.
256
- *
257
- * - `'organizationId'` — the org id passed to `SyncClient.initialize`
258
- * - `'userId'` — the user id passed to `SyncClient.initialize`
259
- */
260
- export type AutoFillSource = 'organizationId' | 'userId';
261
- /**
262
- * Declares one field to back-fill from the connected sync identity when it is
263
- * missing from a stored row. The engine repairs rows during self-healing — for
264
- * example rows written by an older version without an `organizationId` or
265
- * `createdBy`. Declared per model, so the engine stays product-neutral.
266
- */
267
- export interface AutoFillRule {
268
- /** Field name on the model (e.g. `'organizationId'`, `'createdBy'`). */
269
- field: string;
270
- /** Where to read the replacement value from on the sync client. */
271
- from: AutoFillSource;
272
- }
273
- /** A complete model definition: Zod shape + fields metadata + relations + options */
274
- export interface ModelDef<Shape extends z.ZodRawShape = z.ZodRawShape, R extends RelationRecord = RelationRecord, C extends ComputedRecord = ComputedRecord> {
275
- /** The Zod object schema for this model's fields */
276
- readonly schema: z.ZodObject<Shape>;
277
- /** The raw shape (for type inference) */
278
- readonly shape: Shape;
279
- /**
280
- * Runtime metadata for each field, keyed by field name.
281
- *
282
- * Populated automatically from `field.*()` builders. Fields defined
283
- * with raw Zod (e.g., `z.string()`) get a fallback metadata entry
284
- * with type inferred from Zod's `_def.typeName`.
285
- *
286
- * Used by the CLI (`npx ablo migrate`), admin panels, and any tooling
287
- * that needs to introspect the schema without parsing Zod internals.
288
- */
289
- readonly fields: Record<string, FieldMeta>;
290
- /** Relations to other models */
291
- readonly relations: R;
292
- /** Load strategy */
293
- readonly load: LoadStrategy;
294
- /** Max records to bootstrap */
295
- readonly bootstrapLimit?: number;
296
- /** Sort order for bootstrap */
297
- readonly bootstrapOrderBy?: string;
298
- /**
299
- * The wire type name (`__typename`) for this model. When left unset in
300
- * {@link ModelOptions}, it falls back to the schema key when the schema is
301
- * assembled. See {@link ModelOptions.typename}.
302
- */
303
- readonly typename?: string;
304
- /** IndexedDB persistence hints. See {@link PersistOptions}. */
305
- readonly persist?: PersistOptions;
306
- /** The database table this model maps to. See {@link ModelOptions.tableName}. */
307
- readonly tableName?: string;
308
- /** The canonical tenancy descriptor for this model, normalized from the `policy`
309
- * option at build time. See {@link ModelOptions.policy}. */
310
- readonly tenancy: Tenancy;
311
- /** Which database this model's rows live in — `tenant` (default) can be a
312
- * customer's own database; `control` is Ablo's. See {@link ModelOptions.plane}. */
313
- readonly plane?: ModelResidency;
314
- /** Scope-root marker. See {@link ModelOptions.groups}. */
315
- readonly scope?: boolean | string;
316
- /** Membership edge granting an identity access to a scope root. See {@link ModelOptions.groups}. */
317
- readonly grants?: GrantsRef;
318
- /** Explicit record-to-group roles, normalized to an array. See {@link ModelOptions.groups}. */
319
- readonly entityRoles?: readonly EntityRole[];
320
- /** The write-conflict disposition per committer kind, carried as plain data. See
321
- * {@link ModelOptions.conflict}. */
322
- readonly conflict?: ConflictAxis;
323
- /** Whether wire-level CREATE/UPDATE/DELETE is allowed. See {@link ModelOptions.mutable}. */
324
- readonly mutable?: boolean;
325
- /** Defer MobX setup until first observer access. See {@link ModelOptions.lazyObservable}. */
326
- readonly lazyObservable?: boolean;
327
- /** Computed getters for the dynamic model class. See {@link ModelOptions.computed}. */
328
- readonly computed?: C;
329
- /** Auto-fill rules for IDB self-healing. See {@link ModelOptions.autoFill}. */
330
- readonly autoFill?: readonly AutoFillRule[];
331
- /** Fields whose absence orphans a row. See {@link ModelOptions.requiredFields}. */
332
- readonly requiredFields?: readonly string[];
333
- }
334
- /**
335
- * Defines a model from a Zod shape and its options. The row type is inferred from
336
- * the shape; fields built with the {@link field} builders carry extra metadata,
337
- * while plain Zod fields get metadata inferred from their Zod type. Everything else
338
- * about the model — its {@link ModelOptions.relations}, its {@link LoadStrategy},
339
- * the table it maps to — lives in the second argument, so a model that needs one
340
- * setting never has to name the settings it does not use.
341
- *
342
- * ```ts
343
- * import { z } from 'zod';
344
- * import { model, relation } from '@abloatai/ablo/schema';
345
- *
346
- * // Fields alone
347
- * const tags = model({ label: z.string() });
348
- *
349
- * // Loaded at bootstrap (the default), with an edge to its project
350
- * const tasks = model({
351
- * title: z.string(),
352
- * status: z.enum(['todo', 'doing', 'done']).default('todo'),
353
- * projectId: z.string().optional(),
354
- * }, {
355
- * relations: { project: relation.belongsTo('projects', 'projectId') },
356
- * });
357
- *
358
- * // Loaded on first access
359
- * const blocks = model({ sectionId: z.string(), type: z.string() }, {
360
- * relations: { section: relation.belongsTo('sections', 'sectionId') },
361
- * load: 'lazy',
362
- * });
363
- * ```
364
- */
365
- export declare function model<Shape extends z.ZodRawShape, R extends RelationRecord = Record<string, never>, C extends ComputedRecord = Record<string, never>>(shape: Shape, options?: ModelOptions & {
366
- relations?: R;
367
- computed?: C;
368
- }): ModelDef<Shape, R, C>;
369
- /**
370
- * Returns the sync-group kind a scope-root model produces, or `undefined` when the
371
- * model is not a scope root. `scope: true` derives the kind from the lowercased
372
- * typename (`ReportSection` → `reportsection`); `scope: 'section'` sets it explicitly, which
373
- * you use when the wire kind must differ from the typename. This is the single place
374
- * that decides a record's own group, so every layer that reads it agrees.
375
- */
376
- export declare function scopeKindOf(def: {
377
- scope?: boolean | string;
378
- typename?: string;
379
- }, fallbackKey: string): string | undefined;
@@ -1,123 +0,0 @@
1
- /**
2
- * Defines a model — one table's worth of fields, and one options object holding
3
- * everything else the engine needs to know about it. A model is a Zod object schema
4
- * paired with those options; the row type is inferred directly from Zod, with no
5
- * separate type system to keep in sync.
6
- *
7
- * Usage:
8
- * import { z } from 'zod';
9
- * import { model, relation } from '@abloatai/ablo/schema';
10
- *
11
- * const tasks = model({
12
- * title: z.string(),
13
- * status: z.enum(['todo', 'doing', 'done']).default('todo'),
14
- * projectId: z.string().optional(),
15
- * }, {
16
- * relations: { project: relation.belongsTo('projects', 'projectId') },
17
- * load: 'lazy',
18
- * });
19
- */
20
- import { z } from 'zod';
21
- import { getFieldMeta, inferFieldMetaFromZod } from './field.js';
22
- // Tenancy lives in `tenancy.ts`. Authoring uses the `policy` option
23
- // (`PolicyInput`), which `resolvePolicy` normalizes into the canonical `Tenancy`
24
- // at build time.
25
- import { resolvePolicy } from './tenancy.js';
26
- import { DEFAULT_RESIDENCY } from './residency.js';
27
- /** Normalize the `entityRoles` option (single | array | undefined) to an array. */
28
- function normalizeEntityRoles(input) {
29
- if (!input)
30
- return undefined;
31
- return Array.isArray(input) ? input : [input];
32
- }
33
- // ── Load strategies ───────────────────────────────────────────────────────
34
- // Defined in `./loadStrategy.ts`. Imported as well as re-exported: a bare
35
- // `export … from` would not bind the name for the `load` fields below.
36
- import { LoadStrategy, DEFAULT_LOAD_STRATEGY } from './loadStrategy.js';
37
- export { LoadStrategy, DEFAULT_LOAD_STRATEGY, loadsAtBootstrap } from './loadStrategy.js';
38
- // ── Model factory ─────────────────────────────────────────────────────────
39
- /**
40
- * Defines a model from a Zod shape and its options. The row type is inferred from
41
- * the shape; fields built with the {@link field} builders carry extra metadata,
42
- * while plain Zod fields get metadata inferred from their Zod type. Everything else
43
- * about the model — its {@link ModelOptions.relations}, its {@link LoadStrategy},
44
- * the table it maps to — lives in the second argument, so a model that needs one
45
- * setting never has to name the settings it does not use.
46
- *
47
- * ```ts
48
- * import { z } from 'zod';
49
- * import { model, relation } from '@abloatai/ablo/schema';
50
- *
51
- * // Fields alone
52
- * const tags = model({ label: z.string() });
53
- *
54
- * // Loaded at bootstrap (the default), with an edge to its project
55
- * const tasks = model({
56
- * title: z.string(),
57
- * status: z.enum(['todo', 'doing', 'done']).default('todo'),
58
- * projectId: z.string().optional(),
59
- * }, {
60
- * relations: { project: relation.belongsTo('projects', 'projectId') },
61
- * });
62
- *
63
- * // Loaded on first access
64
- * const blocks = model({ sectionId: z.string(), type: z.string() }, {
65
- * relations: { section: relation.belongsTo('sections', 'sectionId') },
66
- * load: 'lazy',
67
- * });
68
- * ```
69
- */
70
- export function model(shape, options) {
71
- // Build the fields metadata record by walking the Zod shape.
72
- // Fields built with `field.*()` have structured metadata; fields built
73
- // with raw Zod get a fallback derived from the Zod typeName.
74
- const fields = {};
75
- for (const [name, zodType] of Object.entries(shape)) {
76
- const meta = getFieldMeta(zodType);
77
- if (meta) {
78
- fields[name] = meta;
79
- }
80
- else {
81
- fields[name] = inferFieldMetaFromZod(zodType);
82
- }
83
- }
84
- return {
85
- schema: z.object(shape),
86
- shape,
87
- fields,
88
- relations: (options?.relations ?? {}),
89
- load: options?.load ?? DEFAULT_LOAD_STRATEGY,
90
- bootstrapLimit: options?.bootstrapLimit,
91
- bootstrapOrderBy: options?.bootstrapOrderBy,
92
- typename: options?.typename,
93
- persist: options?.persist,
94
- tableName: options?.tableName,
95
- // Normalize the `policy` option into the canonical tenancy descriptor (defaults
96
- // to a row-local organization column).
97
- tenancy: resolvePolicy(options?.policy),
98
- plane: options?.plane ?? DEFAULT_RESIDENCY,
99
- // Unpack the `groups` option into the individual routing fields the server reads.
100
- scope: options?.groups?.root,
101
- grants: options?.groups?.grants,
102
- entityRoles: normalizeEntityRoles(options?.groups?.roles),
103
- // The conflict disposition is already plain data, so it passes through unchanged.
104
- conflict: options?.conflict,
105
- mutable: options?.mutable ?? true,
106
- lazyObservable: options?.lazyObservable,
107
- computed: options?.computed,
108
- autoFill: options?.autoFill,
109
- requiredFields: options?.requiredFields,
110
- };
111
- }
112
- /**
113
- * Returns the sync-group kind a scope-root model produces, or `undefined` when the
114
- * model is not a scope root. `scope: true` derives the kind from the lowercased
115
- * typename (`ReportSection` → `reportsection`); `scope: 'section'` sets it explicitly, which
116
- * you use when the wire kind must differ from the typename. This is the single place
117
- * that decides a record's own group, so every layer that reads it agrees.
118
- */
119
- export function scopeKindOf(def, fallbackKey) {
120
- if (!def.scope)
121
- return undefined;
122
- return (typeof def.scope === 'string' ? def.scope : (def.typename ?? fallbackKey)).toLowerCase();
123
- }
@@ -1,57 +0,0 @@
1
- /**
2
- * Two OpenAPI 3.1 documents describing the same API, for two different readers.
3
- *
4
- * The server registers ONE parameterised route family — `/api/v1/models/:model`,
5
- * `/:id`, `/:id/claim`, `/claim/heartbeat`, `/claim/reorder`, plus `/v1/commits`.
6
- * Six routes, whatever a tenant's schema contains. Authentication is a single
7
- * Bearer scheme, your API key.
8
- *
9
- * {@link abloOpenApi} publishes exactly those six. It takes no schema, so it
10
- * cannot grow with one: identical for every caller, stable across every push,
11
- * and the document a Python or Go client is generated from once.
12
- *
13
- * {@link schemaToOpenApi} expands the same six into one set per model, with
14
- * payloads typed from each model's introspectable {@link FieldMeta}. Five paths
15
- * per model, regenerated on every push — worth it when you want generated types
16
- * for one schema, and the wrong thing to hand an agent.
17
- *
18
- * Both return a plain JSON-serializable object; feed either into codegen (for
19
- * example `ablo openapi > openapi.json`) or serve it directly.
20
- */
21
- import type { Schema, SchemaRecord } from './schema.js';
22
- /** Options for {@link schemaToOpenApi} — the metadata stamped into the generated spec. */
23
- export interface SchemaToOpenApiOptions {
24
- /** Spec title. Default `"Ablo API"`. */
25
- readonly title?: string;
26
- /** Spec version. Default `"1.0.0"`. */
27
- readonly version?: string;
28
- /** API base URL. Default `"https://api.abloatai.com/api"`. */
29
- readonly serverUrl?: string;
30
- }
31
- type Json = Record<string, unknown>;
32
- /**
33
- * The protocol reference: the five route templates the server actually serves,
34
- * plus `/v1/commits`.
35
- *
36
- * This takes no schema, and that is the point. The server registers one
37
- * parameterised route family (`/api/v1/models/:model/...`), so the API is five
38
- * routes no matter how many models a tenant defines — and a spec that cannot see
39
- * a schema cannot grow with one. It is publishable once, identical for every
40
- * caller, and stable across every schema push: the document a Python or Go
41
- * client is generated from, and the surface an agent is handed.
42
- *
43
- * Payload shapes are generic here by design. A caller that wants them typed
44
- * either reads the schema at runtime or generates the per-tenant expansion with
45
- * {@link schemaToOpenApi}.
46
- */
47
- export declare function abloOpenApi(options?: SchemaToOpenApiOptions): Json;
48
- /**
49
- * The per-tenant expansion: every model's routes written out with typed payloads.
50
- *
51
- * Useful when you want generated types for one schema — five paths per model, so
52
- * it grows with the schema and is regenerated on every push. It documents the
53
- * same five routes {@link abloOpenApi} describes; it does not describe a
54
- * different API.
55
- */
56
- export declare function schemaToOpenApi<S extends SchemaRecord>(schema: Schema<S>, options?: SchemaToOpenApiOptions): Json;
57
- export {};