@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,162 +0,0 @@
1
- /**
2
- * Exchanges an API key for a capability token and the scope it grants.
3
- *
4
- * The `Ablo({...})` factory calls this during startup when you provide an
5
- * `apiKey` but no explicit capability token, organization, or user identity. It
6
- * sends one `POST /auth/capability` request; the server responds with the
7
- * granted scope and any user metadata, which the client uses to populate its
8
- * session state. The API key is the only credential you handle directly — this
9
- * exchange happens automatically behind it.
10
- */
11
- import { type CapabilityExchangeResponse, type EphemeralKeyResponse, type IdentityResolveResponse } from './schemas.js';
12
- import type { ParticipantKind } from '../types/participant.js';
13
- import type { GrantedOperation } from './capability.js';
14
- export type { CapabilityExchangeResponse, EphemeralKeyResponse, IdentityResolveResponse, } from './schemas.js';
15
- export { capabilityOperationSchema, capabilityCanSchema, capabilityScopeSchema, capabilityRequestSchema, grantedOperationSchema, grantedOperations, expandReadYourWrites, modelWireNames, capabilityModelAliases, unresolvableOperations, } from './capability.js';
16
- export type { CapabilityOperation, CapabilityCan, CapabilityScope, CapabilityRequest, CapabilityModelShape, GrantedOperation, } from './capability.js';
17
- export interface ExchangeApiKeyRequest {
18
- readonly apiKey: string;
19
- readonly baseUrl: string;
20
- readonly participantKind: ParticipantKind;
21
- readonly participantId?: string;
22
- readonly syncGroups?: readonly string[];
23
- /** The grant's verb axis, already in wire form. Build it with
24
- * `grantedOperations(can)` rather than assembling `model.verb` by hand. */
25
- readonly operations?: readonly GrantedOperation[];
26
- readonly ttlSeconds: number;
27
- readonly label?: string;
28
- readonly userMeta?: Record<string, unknown>;
29
- readonly fetch?: typeof fetch;
30
- readonly timeoutMs?: number;
31
- }
32
- export declare function exchangeApiKey(options: ExchangeApiKeyRequest): Promise<CapabilityExchangeResponse>;
33
- export interface MintUserSessionRequest {
34
- /** Your secret API key (an `sk_` key). Minting a session is a server-side
35
- * operation, so it always presents the secret key, never a token derived
36
- * from it. */
37
- readonly apiKey: string;
38
- readonly baseUrl: string;
39
- /** The end user's identifier in your identity provider. It becomes the
40
- * session's `participantId`. */
41
- readonly userId: string;
42
- /** The organization to mint the session into, for a platform that manages many
43
- * organizations. Requires the secret key to carry the `ephemeral:mint-any-org`
44
- * capability. Omit to mint into the key's own organization. */
45
- readonly organizationId?: string;
46
- /** Points this session's schema at a shared project while its data stays scoped
47
- * to `organizationId`. Use this when each customer has its own organization but
48
- * they all share one schema: keep a single schema project, and every customer's
49
- * session resolves its schema from it instead of pushing the schema into each
50
- * organization separately. Requires the secret key to carry the
51
- * `ephemeral:mint-any-org` capability. Omit to resolve the schema from the
52
- * session's own organization. */
53
- readonly schemaProject?: {
54
- /** The organization that owns the shared schema project. */
55
- readonly organizationId: string;
56
- /** The project the schema was pushed under. */
57
- readonly projectId: string;
58
- };
59
- readonly syncGroups?: readonly string[];
60
- readonly ttlSeconds: number;
61
- readonly label?: string;
62
- readonly fetch?: typeof fetch;
63
- readonly timeoutMs?: number;
64
- }
65
- /**
66
- * Mints an end-user session key (an `ek_` key) by calling
67
- * `POST /auth/ephemeral-keys`, using your secret key as authorization. Your
68
- * backend calls this to issue a session that a browser can present as its bearer
69
- * credential; the server trusts the resulting key because a secret key minted it.
70
- *
71
- * This is a distinct endpoint from `/auth/capability`, which exchanges keys for
72
- * agents and systems and cannot mint sessions for human users.
73
- */
74
- export declare function mintUserSessionKey(options: MintUserSessionRequest): Promise<EphemeralKeyResponse>;
75
- export interface ResolveIdentityRequest {
76
- readonly baseUrl: string;
77
- readonly authToken?: string;
78
- readonly fetch?: typeof fetch;
79
- readonly timeoutMs?: number;
80
- }
81
- /**
82
- * Resolves the caller's identity from an authenticated request by calling
83
- * `GET /auth/identity`. This lets browser and session flows learn who the
84
- * current user is without requiring the application to pass a user id up front —
85
- * for example, to key local storage.
86
- */
87
- export declare function resolveIdentity(options: ResolveIdentityRequest): Promise<IdentityResolveResponse>;
88
- /**
89
- * Keeps a capability token fresh so a long-lived client never disconnects when
90
- * its token expires.
91
- *
92
- * A capability token has a shorter lifetime — one hour by default — than a
93
- * typical browser session. Without a refresh, the WebSocket is force-closed at
94
- * expiry (close code 1008) or the next reconnect fails with a 401, and either way
95
- * the user sees a mid-session disconnect. The scheduler prevents that by
96
- * re-minting the token ahead of time.
97
- *
98
- * Three triggers share one refresh path:
99
- *
100
- * 1. Proactive — a timer set for `expiresAtMs - bufferMs - now`.
101
- * 2. Visibility — when a hidden tab becomes visible and the token is already
102
- * within the buffer window, refresh immediately. This covers a
103
- * background tab whose timers were throttled while it was idle.
104
- * 3. Reactive — the caller invokes {@link RefreshScheduler.refreshNow} after
105
- * observing an auth failure, such as a WebSocket close 1008 or
106
- * 4001.
107
- *
108
- * All three await the same in-flight promise, so concurrent triggers mint the
109
- * token only once. Each successful refresh records the new expiry and reschedules
110
- * the proactive timer.
111
- *
112
- * The refresh margin is `max(60s, ttl/10)` — six minutes for a one-hour token,
113
- * and it scales down for shorter lifetimes.
114
- */
115
- export interface RefreshSchedulerOptions {
116
- /** Initial absolute expiry, ms since epoch (server-supplied). */
117
- readonly initialExpiresAtMs: number;
118
- /**
119
- * Performs the token exchange and returns the new expiry. Errors propagate to
120
- * `onError`; the scheduler stays alive and retries on its next trigger. It does
121
- * not back off between retries, since the common failure here is a revoked API
122
- * key, for which retrying would not help.
123
- */
124
- readonly refresh: () => Promise<{
125
- expiresAtMs: number;
126
- }>;
127
- /** Called on every successful refresh. */
128
- readonly onRefreshed?: (info: {
129
- expiresAtMs: number;
130
- }) => void;
131
- /** Called on every refresh failure. */
132
- readonly onError?: (error: Error) => void;
133
- /**
134
- * Override the buffer (ms ahead of expiry to refresh). Defaults to
135
- * `max(60_000, ttlMs * 0.1)`. Tests use a tiny value to exercise
136
- * scheduling without burning real time.
137
- */
138
- readonly bufferMs?: number;
139
- /**
140
- * If true, install a `visibilitychange` listener on `document` that
141
- * triggers a refresh when the tab becomes visible and the token is
142
- * within the buffer window. No-op if `document` is undefined (Node).
143
- * Default: true in browser environments.
144
- */
145
- readonly attachVisibilityListener?: boolean;
146
- /** Time source. Override in tests; defaults to `Date.now`. */
147
- readonly now?: () => number;
148
- /** Timer pair. Override in tests. */
149
- readonly setTimer?: (fn: () => void, ms: number) => ReturnType<typeof setTimeout>;
150
- readonly clearTimer?: (handle: ReturnType<typeof setTimeout>) => void;
151
- }
152
- export interface RefreshScheduler {
153
- /** Force a refresh now. Idempotent — concurrent calls share one promise. */
154
- refreshNow(): Promise<{
155
- expiresAtMs: number;
156
- }>;
157
- /** Stop scheduling. Safe to call multiple times. */
158
- dispose(): void;
159
- /** Current absolute expiry. Updated after each successful refresh. */
160
- readonly expiresAtMs: number;
161
- }
162
- export declare function createRefreshScheduler(options: RefreshSchedulerOptions): RefreshScheduler;
@@ -1,304 +0,0 @@
1
- /**
2
- * Exchanges an API key for a capability token and the scope it grants.
3
- *
4
- * The `Ablo({...})` factory calls this during startup when you provide an
5
- * `apiKey` but no explicit capability token, organization, or user identity. It
6
- * sends one `POST /auth/capability` request; the server responds with the
7
- * granted scope and any user metadata, which the client uses to populate its
8
- * session state. The API key is the only credential you handle directly — this
9
- * exchange happens automatically behind it.
10
- */
11
- import { parseCapabilityExchangeResponse, parseEphemeralKeyResponse, parseIdentityResolveResponse, } from './schemas.js';
12
- import { AbloAuthenticationError, hasWireCode, translateHttpError } from '../errors.js';
13
- // The capability vocabulary — what a grant is, on both axes, in one place.
14
- // Served from this barrel so every minter reaches it through one import.
15
- export { capabilityOperationSchema, capabilityCanSchema, capabilityScopeSchema, capabilityRequestSchema, grantedOperationSchema, grantedOperations, expandReadYourWrites, modelWireNames, capabilityModelAliases, unresolvableOperations, } from './capability.js';
16
- export async function exchangeApiKey(options) {
17
- if (!options.apiKey) {
18
- throw new AbloAuthenticationError('No API key found. Set ABLO_API_KEY in your environment — `npx ablo login` ' +
19
- 'then `npx ablo dev` writes it into .env.local for you — or pass ' +
20
- '`apiKey` to Ablo({ ... }) directly.', { code: 'apikey_missing' });
21
- }
22
- if (!options.baseUrl) {
23
- throw new AbloAuthenticationError('baseUrl is required for capability exchange', { code: 'base_url_missing' });
24
- }
25
- const fetcher = options.fetch ?? fetch;
26
- const url = `${options.baseUrl.replace(/\/+$/, '')}/auth/capability`;
27
- const timeoutMs = options.timeoutMs ?? 10_000;
28
- const controller = new AbortController();
29
- const timer = setTimeout(() => { controller.abort(); }, timeoutMs);
30
- let response;
31
- try {
32
- response = await fetcher(url, {
33
- method: 'POST',
34
- headers: {
35
- 'Content-Type': 'application/json',
36
- Authorization: `Bearer ${options.apiKey}`,
37
- },
38
- body: JSON.stringify({
39
- participantKind: options.participantKind,
40
- ...(options.participantId ? { participantId: options.participantId } : {}),
41
- syncGroups: options.syncGroups,
42
- operations: options.operations,
43
- wideScope: options.wideScope,
44
- ttlSeconds: options.ttlSeconds,
45
- label: options.label,
46
- userMeta: options.userMeta,
47
- }),
48
- signal: controller.signal,
49
- });
50
- }
51
- catch (err) {
52
- throw new AbloAuthenticationError(`apiKey exchange failed: ${err instanceof Error ? err.message : String(err)}`, { code: 'exchange_network_error', cause: err });
53
- }
54
- finally {
55
- clearTimeout(timer);
56
- }
57
- if (!response.ok) {
58
- let body = null;
59
- try {
60
- body = await response.json();
61
- }
62
- catch {
63
- // ignore — server returned non-JSON error
64
- }
65
- // Route the error through the wire-error translator so the server's envelope
66
- // (`code`, `message`, `doc_url`) is preserved and mapped to the matching
67
- // AbloError subclass. Fall back to `exchange_failed` only when the body
68
- // carried no recognizable error code.
69
- const requestId = response.headers.get('x-request-id') ?? undefined;
70
- throw hasWireCode(body)
71
- ? translateHttpError(response.status, body, requestId)
72
- : new AbloAuthenticationError(`apiKey exchange rejected (${response.status})`, { code: 'exchange_failed', httpStatus: response.status });
73
- }
74
- return parseCapabilityExchangeResponse(await response.json());
75
- }
76
- /**
77
- * Mints an end-user session key (an `ek_` key) by calling
78
- * `POST /auth/ephemeral-keys`, using your secret key as authorization. Your
79
- * backend calls this to issue a session that a browser can present as its bearer
80
- * credential; the server trusts the resulting key because a secret key minted it.
81
- *
82
- * This is a distinct endpoint from `/auth/capability`, which exchanges keys for
83
- * agents and systems and cannot mint sessions for human users.
84
- */
85
- export async function mintUserSessionKey(options) {
86
- if (!options.apiKey) {
87
- throw new AbloAuthenticationError('No API key found. Set ABLO_API_KEY in your environment or pass `apiKey` ' +
88
- 'to Ablo({ ... }) directly — user sessions are minted by your backend.', { code: 'apikey_missing' });
89
- }
90
- if (!options.baseUrl) {
91
- throw new AbloAuthenticationError('baseUrl is required for user-session mint', { code: 'base_url_missing' });
92
- }
93
- const fetcher = options.fetch ?? fetch;
94
- const url = `${options.baseUrl.replace(/\/+$/, '')}/auth/ephemeral-keys`;
95
- const timeoutMs = options.timeoutMs ?? 10_000;
96
- const controller = new AbortController();
97
- const timer = setTimeout(() => { controller.abort(); }, timeoutMs);
98
- let response;
99
- try {
100
- response = await fetcher(url, {
101
- method: 'POST',
102
- headers: {
103
- 'Content-Type': 'application/json',
104
- Authorization: `Bearer ${options.apiKey}`,
105
- },
106
- body: JSON.stringify({
107
- user: { id: options.userId },
108
- ...(options.organizationId ? { organizationId: options.organizationId } : {}),
109
- // The public option is project-centric; map it to the flat wire keys the
110
- // endpoint expects.
111
- ...(options.schemaProject
112
- ? {
113
- schemaProjectId: options.schemaProject.projectId,
114
- schemaOwnerOrgId: options.schemaProject.organizationId,
115
- }
116
- : {}),
117
- ...(options.syncGroups ? { syncGroups: options.syncGroups } : {}),
118
- ttlSeconds: options.ttlSeconds,
119
- ...(options.label ? { label: options.label } : {}),
120
- }),
121
- signal: controller.signal,
122
- });
123
- }
124
- catch (err) {
125
- throw new AbloAuthenticationError(`user-session mint failed: ${err instanceof Error ? err.message : String(err)}`, { code: 'exchange_network_error', cause: err });
126
- }
127
- finally {
128
- clearTimeout(timer);
129
- }
130
- if (!response.ok) {
131
- let body = null;
132
- try {
133
- body = await response.json();
134
- }
135
- catch {
136
- // ignore — server returned non-JSON error
137
- }
138
- const requestId = response.headers.get('x-request-id') ?? undefined;
139
- throw hasWireCode(body)
140
- ? translateHttpError(response.status, body, requestId)
141
- : new AbloAuthenticationError(`user-session mint rejected (${response.status})`, { code: 'exchange_failed', httpStatus: response.status });
142
- }
143
- return parseEphemeralKeyResponse(await response.json());
144
- }
145
- /**
146
- * Resolves the caller's identity from an authenticated request by calling
147
- * `GET /auth/identity`. This lets browser and session flows learn who the
148
- * current user is without requiring the application to pass a user id up front —
149
- * for example, to key local storage.
150
- */
151
- export async function resolveIdentity(options) {
152
- if (!options.baseUrl) {
153
- throw new AbloAuthenticationError('baseUrl is required for identity resolve', {
154
- code: 'base_url_missing',
155
- });
156
- }
157
- const fetcher = options.fetch ?? fetch;
158
- const url = `${options.baseUrl.replace(/\/+$/, '')}/auth/identity`;
159
- const timeoutMs = options.timeoutMs ?? 10_000;
160
- const controller = new AbortController();
161
- const timer = setTimeout(() => { controller.abort(); }, timeoutMs);
162
- let response;
163
- try {
164
- const headers = { Accept: 'application/json' };
165
- if (options.authToken) {
166
- headers.Authorization = `Bearer ${options.authToken}`;
167
- }
168
- response = await fetcher(url, {
169
- method: 'GET',
170
- headers,
171
- signal: controller.signal,
172
- });
173
- }
174
- catch (err) {
175
- throw new AbloAuthenticationError(`identity resolve failed: ${err instanceof Error ? err.message : String(err)}`, { code: 'identity_network_error', cause: err });
176
- }
177
- finally {
178
- clearTimeout(timer);
179
- }
180
- if (!response.ok) {
181
- let body = null;
182
- try {
183
- body = await response.json();
184
- }
185
- catch {
186
- // ignore non-JSON auth errors
187
- }
188
- // Translate the error envelope the same way `exchangeApiKey` does, so the
189
- // server's precise auth diagnosis (for example `jwt_issuer_untrusted` with
190
- // its full message) reaches the caller instead of collapsing every 401 to a
191
- // generic `identity_resolve_failed`.
192
- const requestId = response.headers.get('x-request-id') ?? undefined;
193
- throw hasWireCode(body)
194
- ? translateHttpError(response.status, body, requestId)
195
- : new AbloAuthenticationError(`identity resolve rejected (${response.status})`, { code: 'identity_resolve_failed', httpStatus: response.status });
196
- }
197
- return parseIdentityResolveResponse(await response.json());
198
- }
199
- const DEFAULT_BUFFER_FLOOR_MS = 60_000;
200
- const DEFAULT_BUFFER_RATIO = 0.1;
201
- export function createRefreshScheduler(options) {
202
- const now = options.now ?? Date.now;
203
- const setTimer = options.setTimer ?? setTimeout;
204
- const clearTimer = options.clearTimer ?? clearTimeout;
205
- let expiresAtMs = options.initialExpiresAtMs;
206
- let timer = null;
207
- let inFlight = null;
208
- let disposed = false;
209
- // Attach the visibility listener only in a browser-like environment. A
210
- // non-browser runtime has no `document`, so the default behaves correctly
211
- // without an explicit opt-out.
212
- const wantsVisibility = options.attachVisibilityListener ?? true;
213
- const hasDocument = typeof document !== 'undefined';
214
- const visibilityActive = wantsVisibility && hasDocument;
215
- function bufferFor(currentExpiresAtMs) {
216
- if (typeof options.bufferMs === 'number')
217
- return options.bufferMs;
218
- const ttl = currentExpiresAtMs - now();
219
- return Math.max(DEFAULT_BUFFER_FLOOR_MS, Math.floor(ttl * DEFAULT_BUFFER_RATIO));
220
- }
221
- function clearTimerIfAny() {
222
- if (timer !== null) {
223
- clearTimer(timer);
224
- timer = null;
225
- }
226
- }
227
- function schedule() {
228
- if (disposed)
229
- return;
230
- clearTimerIfAny();
231
- const buffer = bufferFor(expiresAtMs);
232
- const delay = Math.max(0, expiresAtMs - buffer - now());
233
- timer = setTimer(() => {
234
- void refreshNow().catch(() => {
235
- // onError already fired inside refreshNow; swallow here so
236
- // the timer callback doesn't surface as an unhandled rejection.
237
- });
238
- }, delay);
239
- }
240
- function refreshNow() {
241
- if (disposed) {
242
- return Promise.reject(new Error('refreshScheduler: disposed'));
243
- }
244
- if (inFlight)
245
- return inFlight;
246
- inFlight = (async () => {
247
- try {
248
- const result = await options.refresh();
249
- if (disposed)
250
- return result;
251
- expiresAtMs = result.expiresAtMs;
252
- options.onRefreshed?.({ expiresAtMs });
253
- schedule();
254
- return result;
255
- }
256
- catch (err) {
257
- const error = err instanceof Error ? err : new Error(String(err));
258
- options.onError?.(error);
259
- // Reschedule even on failure so the next window still triggers.
260
- // The user's apiKey may have been temporarily unreachable.
261
- if (!disposed)
262
- schedule();
263
- throw error;
264
- }
265
- finally {
266
- inFlight = null;
267
- }
268
- })();
269
- return inFlight;
270
- }
271
- function onVisibilityChange() {
272
- if (disposed)
273
- return;
274
- if (typeof document === 'undefined')
275
- return;
276
- if (document.visibilityState !== 'visible')
277
- return;
278
- const buffer = bufferFor(expiresAtMs);
279
- if (expiresAtMs - now() <= buffer) {
280
- void refreshNow().catch(() => {
281
- // already routed through onError
282
- });
283
- }
284
- }
285
- if (visibilityActive) {
286
- document.addEventListener('visibilitychange', onVisibilityChange);
287
- }
288
- schedule();
289
- return {
290
- refreshNow,
291
- dispose() {
292
- if (disposed)
293
- return;
294
- disposed = true;
295
- clearTimerIfAny();
296
- if (visibilityActive) {
297
- document.removeEventListener('visibilitychange', onVisibilityChange);
298
- }
299
- },
300
- get expiresAtMs() {
301
- return expiresAtMs;
302
- },
303
- };
304
- }
@@ -1,59 +0,0 @@
1
- import { z } from 'zod';
2
- export declare const AuthTokenSchema: z.ZodString;
3
- export declare const CapabilityExchangeResponseSchema: z.ZodObject<{
4
- capabilityId: z.ZodString;
5
- token: z.ZodString;
6
- expiresAt: z.ZodString;
7
- organizationId: z.ZodString;
8
- scope: z.ZodObject<{
9
- organizationId: z.ZodString;
10
- syncGroups: z.ZodArray<z.ZodString>;
11
- operations: z.ZodArray<z.ZodTemplateLiteral<`${string}.update` | `${string}.create` | `${string}.delete` | `${string}.read`>>;
12
- participantKind: z.ZodEnum<{
13
- user: "user";
14
- agent: "agent";
15
- system: "system";
16
- }>;
17
- participantId: z.ZodString;
18
- }, z.core.$loose>;
19
- userMeta: z.ZodRecord<z.ZodString, z.ZodUnknown>;
20
- }, z.core.$loose>;
21
- export type CapabilityExchangeResponse = z.infer<typeof CapabilityExchangeResponseSchema>;
22
- export declare const IdentityResolveResponseSchema: z.ZodObject<{
23
- participantKind: z.ZodEnum<{
24
- user: "user";
25
- agent: "agent";
26
- system: "system";
27
- }>;
28
- participantId: z.ZodString;
29
- accountScope: z.ZodString;
30
- projectId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
31
- environment: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
32
- production: "production";
33
- sandbox: "sandbox";
34
- }>>>;
35
- sandboxId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
36
- syncGroups: z.ZodArray<z.ZodString>;
37
- userMeta: z.ZodRecord<z.ZodString, z.ZodUnknown>;
38
- }, z.core.$loose>;
39
- export type IdentityResolveResponse = z.infer<typeof IdentityResolveResponseSchema>;
40
- /**
41
- * The response shape of `POST /auth/ephemeral-keys`, the endpoint that mints an
42
- * end-user session key (an `ek_` key). The shape is flat, with no nested scope
43
- * block: the server records the scope on the key itself and re-derives it on
44
- * every request, so the client only needs the token and identity fields to hand
45
- * to the browser.
46
- */
47
- export declare const EphemeralKeyResponseSchema: z.ZodObject<{
48
- object: z.ZodOptional<z.ZodLiteral<"ephemeral_key">>;
49
- id: z.ZodString;
50
- token: z.ZodString;
51
- expiresAt: z.ZodString;
52
- organizationId: z.ZodString;
53
- participantId: z.ZodString;
54
- syncGroups: z.ZodArray<z.ZodString>;
55
- }, z.core.$loose>;
56
- export type EphemeralKeyResponse = z.infer<typeof EphemeralKeyResponseSchema>;
57
- export declare function parseCapabilityExchangeResponse(raw: unknown): CapabilityExchangeResponse;
58
- export declare function parseEphemeralKeyResponse(raw: unknown): EphemeralKeyResponse;
59
- export declare function parseIdentityResolveResponse(raw: unknown): IdentityResolveResponse;
@@ -1,85 +0,0 @@
1
- import { z } from 'zod';
2
- import { participantKindSchema } from '../coordination/schema.js';
3
- import { capabilityScopeSchema } from './capability.js';
4
- import { AbloAuthenticationError } from '../errors.js';
5
- // Not a second enum. The auth responses carry the same participant vocabulary
6
- // the coordination plane parses, so they validate against the same schema — a
7
- // kind the delta plane accepts must not throw here on an otherwise-valid
8
- // identity-resolve response.
9
- const AuthParticipantKindSchema = participantKindSchema;
10
- export const AuthTokenSchema = z.string().trim().min(1);
11
- export const CapabilityExchangeResponseSchema = z
12
- .object({
13
- capabilityId: z.string().min(1),
14
- token: AuthTokenSchema,
15
- expiresAt: z.string().min(1),
16
- organizationId: z.string().min(1),
17
- // The grant the mint settled on, in the one shape the key row stores and
18
- // the gates read — not a second description of it.
19
- scope: capabilityScopeSchema.loose(),
20
- userMeta: z.record(z.string(), z.unknown()),
21
- })
22
- .loose();
23
- export const IdentityResolveResponseSchema = z
24
- .object({
25
- participantKind: AuthParticipantKindSchema,
26
- participantId: z.string().min(1),
27
- accountScope: z.string().min(1),
28
- // The rest of the plane this credential resolves to. `nullish` (optional +
29
- // nullable) so a server too old to send them still parses, and a human
30
- // session — which carries no such scope — validates with them absent.
31
- // `projectId` equals the org id for the org-default project.
32
- projectId: z.string().min(1).nullish(),
33
- environment: z.enum(['sandbox', 'production']).nullish(),
34
- sandboxId: z.string().min(1).nullish(),
35
- syncGroups: z.array(z.string()),
36
- userMeta: z.record(z.string(), z.unknown()),
37
- })
38
- .loose();
39
- /**
40
- * The response shape of `POST /auth/ephemeral-keys`, the endpoint that mints an
41
- * end-user session key (an `ek_` key). The shape is flat, with no nested scope
42
- * block: the server records the scope on the key itself and re-derives it on
43
- * every request, so the client only needs the token and identity fields to hand
44
- * to the browser.
45
- */
46
- export const EphemeralKeyResponseSchema = z
47
- .object({
48
- object: z.literal('ephemeral_key').optional(),
49
- id: z.string().min(1),
50
- token: AuthTokenSchema,
51
- expiresAt: z.string().min(1),
52
- organizationId: z.string().min(1),
53
- participantId: z.string().min(1),
54
- syncGroups: z.array(z.string()),
55
- })
56
- .loose();
57
- function formatIssues(error) {
58
- return error.issues
59
- .map((issue) => {
60
- const path = issue.path.length > 0 ? issue.path.join('.') : '<root>';
61
- return `${path}: ${issue.message}`;
62
- })
63
- .join('; ');
64
- }
65
- export function parseCapabilityExchangeResponse(raw) {
66
- const parsed = CapabilityExchangeResponseSchema.safeParse(raw);
67
- if (!parsed.success) {
68
- throw new AbloAuthenticationError(`apiKey exchange response was malformed: ${formatIssues(parsed.error)}`, { code: 'exchange_malformed_response', cause: parsed.error });
69
- }
70
- return parsed.data;
71
- }
72
- export function parseEphemeralKeyResponse(raw) {
73
- const parsed = EphemeralKeyResponseSchema.safeParse(raw);
74
- if (!parsed.success) {
75
- throw new AbloAuthenticationError(`user-session mint response was malformed: ${formatIssues(parsed.error)}`, { code: 'exchange_malformed_response', cause: parsed.error });
76
- }
77
- return parsed.data;
78
- }
79
- export function parseIdentityResolveResponse(raw) {
80
- const parsed = IdentityResolveResponseSchema.safeParse(raw);
81
- if (!parsed.success) {
82
- throw new AbloAuthenticationError(`identity resolve response was malformed: ${formatIssues(parsed.error)}`, { code: 'identity_resolve_failed', cause: parsed.error });
83
- }
84
- return parsed.data;
85
- }
@@ -1,28 +0,0 @@
1
- import type { SchemaRecord } from '../schema/schema.js';
2
- import type { AbloSession, CreateSessionParams } from '../resources/httpResources.js';
3
- /**
4
- * The resolved control-plane details a mint needs: a secret key, a base URL,
5
- * and an optional `fetch`. When `fetch` is omitted, the auth helpers fall back
6
- * to the runtime's global `fetch`.
7
- */
8
- export interface MintSessionContext {
9
- readonly apiKey: string;
10
- readonly baseUrl: string;
11
- readonly fetch?: typeof fetch;
12
- /**
13
- * Each schema key mapped to its wire type name, from
14
- * {@link modelWireNames} over the client's own schema. Required, and derived
15
- * rather than assembled: `can` is keyed by schema key while a capability is
16
- * scoped by the type name the server checks, so
17
- * `can: { documents: ['update'] }` on a model whose type name is overridden
18
- * to `Document` must mint `document.update`. A caller who leaves this out
19
- * mints a grant the server denies on the first write.
20
- */
21
- readonly modelTypenames: Readonly<Record<string, string>>;
22
- }
23
- /**
24
- * Mints a session token from an already-resolved secret key and base URL.
25
- * Routes the `{ user }` or `{ agent }` request to the matching mint endpoint
26
- * and reshapes the response into an {@link AbloSession}.
27
- */
28
- export declare function mintSession<S extends SchemaRecord>(params: CreateSessionParams<S>, ctx: MintSessionContext): Promise<AbloSession>;