@abloatai/ablo 0.36.0 → 0.37.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (597) hide show
  1. package/AGENTS.md +2 -2
  2. package/CHANGELOG.md +55 -2014
  3. package/NOTICE +2 -2
  4. package/README.md +45 -63
  5. package/assets/banner.png +0 -0
  6. package/dist/auth.d.ts +2 -0
  7. package/dist/auth.d.ts.map +1 -0
  8. package/dist/auth.js +2 -0
  9. package/dist/auth.js.map +1 -0
  10. package/dist/client.d.ts +3 -0
  11. package/dist/client.d.ts.map +1 -0
  12. package/dist/client.js +3 -0
  13. package/dist/client.js.map +1 -0
  14. package/dist/coordination.d.ts +2 -0
  15. package/dist/coordination.d.ts.map +1 -0
  16. package/dist/coordination.js +2 -0
  17. package/dist/coordination.js.map +1 -0
  18. package/dist/index.d.ts +3 -114
  19. package/dist/index.d.ts.map +1 -0
  20. package/dist/index.js +3 -163
  21. package/dist/index.js.map +1 -0
  22. package/dist/react.d.ts +4 -0
  23. package/dist/react.d.ts.map +1 -0
  24. package/dist/react.js +3 -0
  25. package/dist/react.js.map +1 -0
  26. package/dist/schema.d.ts +2 -0
  27. package/dist/schema.d.ts.map +1 -0
  28. package/dist/schema.js +2 -0
  29. package/dist/schema.js.map +1 -0
  30. package/dist/server.d.ts +2 -0
  31. package/dist/server.d.ts.map +1 -0
  32. package/dist/server.js +2 -0
  33. package/dist/server.js.map +1 -0
  34. package/dist/source-conformance.d.ts +2 -0
  35. package/dist/source-conformance.d.ts.map +1 -0
  36. package/dist/source-conformance.js +2 -0
  37. package/dist/source-conformance.js.map +1 -0
  38. package/dist/source-drizzle.d.ts +2 -0
  39. package/dist/source-drizzle.d.ts.map +1 -0
  40. package/dist/source-drizzle.js +2 -0
  41. package/dist/source-drizzle.js.map +1 -0
  42. package/dist/source-kysely.d.ts +2 -0
  43. package/dist/source-kysely.d.ts.map +1 -0
  44. package/dist/source-kysely.js +2 -0
  45. package/dist/source-kysely.js.map +1 -0
  46. package/dist/source-next.d.ts +2 -0
  47. package/dist/source-next.d.ts.map +1 -0
  48. package/dist/source-next.js +2 -0
  49. package/dist/source-next.js.map +1 -0
  50. package/dist/source.d.ts +2 -0
  51. package/dist/source.d.ts.map +1 -0
  52. package/dist/source.js +2 -0
  53. package/dist/source.js.map +1 -0
  54. package/dist/wire.d.ts +2 -0
  55. package/dist/wire.d.ts.map +1 -0
  56. package/dist/wire.js +2 -0
  57. package/dist/wire.js.map +1 -0
  58. package/docs/agents.md +1 -1
  59. package/docs/api-keys.md +7 -6
  60. package/docs/api.md +10 -10
  61. package/docs/client-behavior.md +5 -5
  62. package/docs/coordination.md +52 -62
  63. package/docs/data-sources.md +1 -1
  64. package/docs/examples/agent-human.md +4 -4
  65. package/docs/examples/ai-sdk-tool.md +1 -1
  66. package/docs/examples/existing-python-backend.md +15 -4
  67. package/docs/examples/nextjs.md +27 -6
  68. package/docs/examples/server-agent.md +2 -2
  69. package/docs/how-it-works.md +4 -4
  70. package/docs/identity.md +2 -1
  71. package/docs/integration-guide.md +24 -13
  72. package/docs/internal/README.md +18 -0
  73. package/docs/internal/agent-fleet-coordination-design.md +171 -0
  74. package/docs/internal/agent-orchestration.md +58 -0
  75. package/docs/internal/commit-identifiers.md +91 -0
  76. package/docs/internal/concurrency-open-decisions.md +37 -0
  77. package/docs/internal/data-source-reverse-channel.md +150 -0
  78. package/docs/internal/per-field-conflict-detection.md +165 -0
  79. package/docs/internal/postgres-replication.md +64 -0
  80. package/docs/internal/serializable-schema.md +119 -0
  81. package/docs/internal/structure.md +32 -0
  82. package/docs/mcp.md +2 -2
  83. package/docs/migration.md +3 -3
  84. package/docs/quickstart.md +2 -2
  85. package/docs/react.md +5 -5
  86. package/docs/schema-contract.md +3 -3
  87. package/docs/sessions.md +91 -37
  88. package/examples/README.md +2 -2
  89. package/examples/data-source/README.md +1 -1
  90. package/examples/data-source/ablo-driver.ts +1 -1
  91. package/examples/data-source/customer-server.ts +1 -1
  92. package/examples/data-source/run.ts +1 -1
  93. package/examples/data-source/schema.ts +1 -1
  94. package/examples/quickstart.ts +2 -2
  95. package/llms.txt +8 -8
  96. package/package.json +63 -166
  97. package/bin/ablo.cjs +0 -39
  98. package/dist/BaseSyncedStore.d.ts +0 -843
  99. package/dist/BaseSyncedStore.js +0 -1971
  100. package/dist/Database.d.ts +0 -323
  101. package/dist/Database.js +0 -1502
  102. package/dist/InstanceCache.d.ts +0 -237
  103. package/dist/InstanceCache.js +0 -1166
  104. package/dist/LazyReferenceCollection.d.ts +0 -177
  105. package/dist/LazyReferenceCollection.js +0 -461
  106. package/dist/Model.d.ts +0 -454
  107. package/dist/Model.js +0 -919
  108. package/dist/ModelRegistry.d.ts +0 -225
  109. package/dist/ModelRegistry.js +0 -539
  110. package/dist/NetworkMonitor.d.ts +0 -28
  111. package/dist/NetworkMonitor.js +0 -79
  112. package/dist/RuntimeContext.d.ts +0 -52
  113. package/dist/RuntimeContext.js +0 -80
  114. package/dist/SyncClient.d.ts +0 -541
  115. package/dist/SyncClient.js +0 -2202
  116. package/dist/adapters/alwaysOnline.d.ts +0 -14
  117. package/dist/adapters/alwaysOnline.js +0 -17
  118. package/dist/adapters/inMemoryStorage.d.ts +0 -31
  119. package/dist/adapters/inMemoryStorage.js +0 -110
  120. package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
  121. package/dist/ai-sdk/coordinatedTool.js +0 -134
  122. package/dist/ai-sdk/coordinationContext.d.ts +0 -46
  123. package/dist/ai-sdk/coordinationContext.js +0 -106
  124. package/dist/ai-sdk/index.d.ts +0 -121
  125. package/dist/ai-sdk/index.js +0 -121
  126. package/dist/ai-sdk/wrap.d.ts +0 -65
  127. package/dist/ai-sdk/wrap.js +0 -39
  128. package/dist/auth/index.d.ts +0 -1
  129. package/dist/auth/index.js +0 -8
  130. package/dist/batching/index.d.ts +0 -55
  131. package/dist/batching/index.js +0 -147
  132. package/dist/client/Ablo.d.ts +0 -231
  133. package/dist/client/Ablo.js +0 -160
  134. package/dist/client/abloClient.d.ts +0 -309
  135. package/dist/client/abloClient.js +0 -13
  136. package/dist/client/clientPrelude.d.ts +0 -52
  137. package/dist/client/clientPrelude.js +0 -60
  138. package/dist/client/consoleLogger.d.ts +0 -35
  139. package/dist/client/consoleLogger.js +0 -44
  140. package/dist/client/coreClient.d.ts +0 -60
  141. package/dist/client/coreClient.js +0 -118
  142. package/dist/client/createInternalComponents.d.ts +0 -50
  143. package/dist/client/createInternalComponents.js +0 -98
  144. package/dist/client/createModelProxy.d.ts +0 -248
  145. package/dist/client/createModelProxy.js +0 -884
  146. package/dist/client/humans.d.ts +0 -69
  147. package/dist/client/humans.js +0 -78
  148. package/dist/client/modelRegistration.d.ts +0 -10
  149. package/dist/client/modelRegistration.js +0 -312
  150. package/dist/client/options.d.ts +0 -461
  151. package/dist/client/options.js +0 -7
  152. package/dist/client/reactiveEngine.d.ts +0 -53
  153. package/dist/client/reactiveEngine.js +0 -688
  154. package/dist/client/resourceTypes.d.ts +0 -12
  155. package/dist/client/resourceTypes.js +0 -10
  156. package/dist/client/schemaConfig.d.ts +0 -44
  157. package/dist/client/schemaConfig.js +0 -185
  158. package/dist/client/storeCluster.d.ts +0 -47
  159. package/dist/client/storeCluster.js +0 -118
  160. package/dist/client/storeLifecycle.d.ts +0 -61
  161. package/dist/client/storeLifecycle.js +0 -231
  162. package/dist/client/validateAbloOptions.d.ts +0 -42
  163. package/dist/client/validateAbloOptions.js +0 -43
  164. package/dist/client/wsMutationExecutor.d.ts +0 -27
  165. package/dist/client/wsMutationExecutor.js +0 -72
  166. package/dist/context.d.ts +0 -42
  167. package/dist/context.js +0 -81
  168. package/dist/coordination/ClaimLog.d.ts +0 -26
  169. package/dist/coordination/ClaimLog.js +0 -32
  170. package/dist/coordination/index.d.ts +0 -1
  171. package/dist/coordination/index.js +0 -8
  172. package/dist/core/index.d.ts +0 -33
  173. package/dist/core/index.js +0 -48
  174. package/dist/docs/catalog.d.ts +0 -72
  175. package/dist/docs/catalog.js +0 -230
  176. package/dist/docs/index.d.ts +0 -10
  177. package/dist/docs/index.js +0 -10
  178. package/dist/environment.d.ts +0 -1
  179. package/dist/environment.js +0 -8
  180. package/dist/interfaces/index.d.ts +0 -311
  181. package/dist/interfaces/index.js +0 -9
  182. package/dist/keys/index.d.ts +0 -1
  183. package/dist/keys/index.js +0 -8
  184. package/dist/mutators/RecordingMutation.d.ts +0 -36
  185. package/dist/mutators/RecordingMutation.js +0 -182
  186. package/dist/mutators/Transaction.d.ts +0 -40
  187. package/dist/mutators/Transaction.js +0 -58
  188. package/dist/mutators/UndoManager.d.ts +0 -258
  189. package/dist/mutators/UndoManager.js +0 -658
  190. package/dist/mutators/defineMutators.d.ts +0 -60
  191. package/dist/mutators/defineMutators.js +0 -18
  192. package/dist/mutators/inverseOp.d.ts +0 -126
  193. package/dist/mutators/inverseOp.js +0 -71
  194. package/dist/mutators/mutateActions.d.ts +0 -45
  195. package/dist/mutators/mutateActions.js +0 -105
  196. package/dist/mutators/readerActions.d.ts +0 -33
  197. package/dist/mutators/readerActions.js +0 -57
  198. package/dist/mutators/undoApply.d.ts +0 -51
  199. package/dist/mutators/undoApply.js +0 -117
  200. package/dist/policy/index.d.ts +0 -21
  201. package/dist/policy/index.js +0 -20
  202. package/dist/query/QueryProcessor.d.ts +0 -75
  203. package/dist/query/QueryProcessor.js +0 -255
  204. package/dist/query/client.d.ts +0 -64
  205. package/dist/query/client.js +0 -138
  206. package/dist/query/types.d.ts +0 -85
  207. package/dist/query/types.js +0 -16
  208. package/dist/react/AbloProvider.d.ts +0 -242
  209. package/dist/react/AbloProvider.js +0 -458
  210. package/dist/react/ClientSideSuspense.d.ts +0 -36
  211. package/dist/react/ClientSideSuspense.js +0 -17
  212. package/dist/react/DefaultFallback.d.ts +0 -24
  213. package/dist/react/DefaultFallback.js +0 -43
  214. package/dist/react/context.d.ts +0 -55
  215. package/dist/react/context.js +0 -29
  216. package/dist/react/createAbloReact.d.ts +0 -56
  217. package/dist/react/createAbloReact.js +0 -51
  218. package/dist/react/index.d.ts +0 -62
  219. package/dist/react/index.js +0 -69
  220. package/dist/react/internalContext.d.ts +0 -33
  221. package/dist/react/internalContext.js +0 -3
  222. package/dist/react/useAblo.d.ts +0 -82
  223. package/dist/react/useAblo.js +0 -120
  224. package/dist/react/useCurrentUserId.d.ts +0 -22
  225. package/dist/react/useCurrentUserId.js +0 -34
  226. package/dist/react/useErrorListener.d.ts +0 -20
  227. package/dist/react/useErrorListener.js +0 -38
  228. package/dist/react/useMutationFailureListener.d.ts +0 -26
  229. package/dist/react/useMutationFailureListener.js +0 -38
  230. package/dist/react/useMutators.d.ts +0 -56
  231. package/dist/react/useMutators.js +0 -84
  232. package/dist/react/useReactive.d.ts +0 -35
  233. package/dist/react/useReactive.js +0 -123
  234. package/dist/react/useSyncStatus.d.ts +0 -59
  235. package/dist/react/useSyncStatus.js +0 -76
  236. package/dist/react/useUndoScope.d.ts +0 -34
  237. package/dist/react/useUndoScope.js +0 -81
  238. package/dist/schema/coordination.d.ts +0 -112
  239. package/dist/schema/coordination.js +0 -133
  240. package/dist/schema/ddl.d.ts +0 -97
  241. package/dist/schema/ddl.js +0 -491
  242. package/dist/schema/ddlLock.d.ts +0 -35
  243. package/dist/schema/ddlLock.js +0 -46
  244. package/dist/schema/diff.d.ts +0 -225
  245. package/dist/schema/diff.js +0 -289
  246. package/dist/schema/generate.d.ts +0 -19
  247. package/dist/schema/generate.js +0 -86
  248. package/dist/schema/index.d.ts +0 -42
  249. package/dist/schema/index.js +0 -80
  250. package/dist/schema/queries.d.ts +0 -201
  251. package/dist/schema/queries.js +0 -144
  252. package/dist/schema/select.d.ts +0 -40
  253. package/dist/schema/select.js +0 -90
  254. package/dist/schema/serialize.d.ts +0 -115
  255. package/dist/schema/serialize.js +0 -265
  256. package/dist/schema/sugar.d.ts +0 -109
  257. package/dist/schema/sugar.js +0 -83
  258. package/dist/schema/syncDeltaRow.d.ts +0 -6
  259. package/dist/schema/syncDeltaRow.js +0 -6
  260. package/dist/server/adapter.d.ts +0 -173
  261. package/dist/server/adapter.js +0 -18
  262. package/dist/server/commit.d.ts +0 -107
  263. package/dist/server/commit.js +0 -1
  264. package/dist/server/index.d.ts +0 -14
  265. package/dist/server/index.js +0 -2
  266. package/dist/server/readConfig.d.ts +0 -80
  267. package/dist/server/readConfig.js +0 -8
  268. package/dist/server/storageMode.d.ts +0 -23
  269. package/dist/server/storageMode.js +0 -17
  270. package/dist/source/adapter.d.ts +0 -83
  271. package/dist/source/adapter.js +0 -24
  272. package/dist/source/adapters/drizzle.d.ts +0 -48
  273. package/dist/source/adapters/drizzle.js +0 -219
  274. package/dist/source/adapters/kysely.d.ts +0 -42
  275. package/dist/source/adapters/kysely.js +0 -205
  276. package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
  277. package/dist/source/adapters/kyselyMutationCore.js +0 -125
  278. package/dist/source/adapters/memory.d.ts +0 -13
  279. package/dist/source/adapters/memory.js +0 -130
  280. package/dist/source/adapters/prisma.d.ts +0 -63
  281. package/dist/source/adapters/prisma.js +0 -202
  282. package/dist/source/conformance.d.ts +0 -37
  283. package/dist/source/conformance.js +0 -215
  284. package/dist/source/connector.d.ts +0 -95
  285. package/dist/source/connector.js +0 -266
  286. package/dist/source/connectorProtocol.d.ts +0 -154
  287. package/dist/source/connectorProtocol.js +0 -163
  288. package/dist/source/contract.d.ts +0 -195
  289. package/dist/source/contract.js +0 -164
  290. package/dist/source/factory.d.ts +0 -92
  291. package/dist/source/factory.js +0 -286
  292. package/dist/source/idempotency.d.ts +0 -61
  293. package/dist/source/idempotency.js +0 -144
  294. package/dist/source/index.d.ts +0 -23
  295. package/dist/source/index.js +0 -30
  296. package/dist/source/migrations.d.ts +0 -21
  297. package/dist/source/migrations.js +0 -103
  298. package/dist/source/next.d.ts +0 -32
  299. package/dist/source/next.js +0 -25
  300. package/dist/source/pushQueue.d.ts +0 -134
  301. package/dist/source/pushQueue.js +0 -256
  302. package/dist/source/signing.d.ts +0 -92
  303. package/dist/source/signing.js +0 -162
  304. package/dist/source/types.d.ts +0 -401
  305. package/dist/source/types.js +0 -59
  306. package/dist/storeContract.d.ts +0 -145
  307. package/dist/storeContract.js +0 -12
  308. package/dist/stores/DatabaseManager.d.ts +0 -107
  309. package/dist/stores/DatabaseManager.js +0 -388
  310. package/dist/stores/ObjectStore.d.ts +0 -115
  311. package/dist/stores/ObjectStore.js +0 -393
  312. package/dist/stores/ObjectStoreContract.d.ts +0 -38
  313. package/dist/stores/ObjectStoreContract.js +0 -1
  314. package/dist/stores/StoreManager.d.ts +0 -114
  315. package/dist/stores/StoreManager.js +0 -304
  316. package/dist/stores/SyncActionStore.d.ts +0 -99
  317. package/dist/stores/SyncActionStore.js +0 -506
  318. package/dist/stores/openIDBWithTimeout.d.ts +0 -65
  319. package/dist/stores/openIDBWithTimeout.js +0 -153
  320. package/dist/stores/syncAction.d.ts +0 -26
  321. package/dist/stores/syncAction.js +0 -16
  322. package/dist/surface.d.ts +0 -36
  323. package/dist/surface.js +0 -75
  324. package/dist/sync/BootstrapFetcher.d.ts +0 -284
  325. package/dist/sync/BootstrapFetcher.js +0 -964
  326. package/dist/sync/ConnectionManager.d.ts +0 -8
  327. package/dist/sync/ConnectionManager.js +0 -8
  328. package/dist/sync/OnDemandLoader.d.ts +0 -231
  329. package/dist/sync/OnDemandLoader.js +0 -743
  330. package/dist/sync/SubscriptionManager.d.ts +0 -159
  331. package/dist/sync/SubscriptionManager.js +0 -243
  332. package/dist/sync/SyncWebSocket.d.ts +0 -173
  333. package/dist/sync/SyncWebSocket.js +0 -438
  334. package/dist/sync/awaitClaimGrant.d.ts +0 -6
  335. package/dist/sync/awaitClaimGrant.js +0 -6
  336. package/dist/sync/bootstrapApply.d.ts +0 -73
  337. package/dist/sync/bootstrapApply.js +0 -73
  338. package/dist/sync/commitFrames.d.ts +0 -8
  339. package/dist/sync/commitFrames.js +0 -8
  340. package/dist/sync/contextPorts.d.ts +0 -18
  341. package/dist/sync/contextPorts.js +0 -31
  342. package/dist/sync/createClaimStream.d.ts +0 -7
  343. package/dist/sync/createClaimStream.js +0 -7
  344. package/dist/sync/createPresenceStream.d.ts +0 -69
  345. package/dist/sync/createPresenceStream.js +0 -200
  346. package/dist/sync/createSnapshot.d.ts +0 -29
  347. package/dist/sync/createSnapshot.js +0 -118
  348. package/dist/sync/credentialLifecycle.d.ts +0 -7
  349. package/dist/sync/credentialLifecycle.js +0 -7
  350. package/dist/sync/deltaPipeline.d.ts +0 -114
  351. package/dist/sync/deltaPipeline.js +0 -278
  352. package/dist/sync/groupChange.d.ts +0 -116
  353. package/dist/sync/groupChange.js +0 -244
  354. package/dist/sync/participants.d.ts +0 -132
  355. package/dist/sync/participants.js +0 -346
  356. package/dist/sync/persistedPrefix.d.ts +0 -12
  357. package/dist/sync/persistedPrefix.js +0 -22
  358. package/dist/sync/schemaDrift.d.ts +0 -55
  359. package/dist/sync/schemaDrift.js +0 -53
  360. package/dist/sync/schemas.d.ts +0 -71
  361. package/dist/sync/schemas.js +0 -94
  362. package/dist/sync/syncCursor.d.ts +0 -40
  363. package/dist/sync/syncCursor.js +0 -55
  364. package/dist/sync/syncPlan.d.ts +0 -54
  365. package/dist/sync/syncPlan.js +0 -50
  366. package/dist/sync/wsFrameHandlers.d.ts +0 -8
  367. package/dist/sync/wsFrameHandlers.js +0 -8
  368. package/dist/syncLog/contract.d.ts +0 -20
  369. package/dist/syncLog/contract.js +0 -19
  370. package/dist/syncLog/index.d.ts +0 -1
  371. package/dist/syncLog/index.js +0 -1
  372. package/dist/transaction/ablo.d.ts +0 -88
  373. package/dist/transaction/ablo.js +0 -33
  374. package/dist/transaction/auth/apiKey.d.ts +0 -152
  375. package/dist/transaction/auth/apiKey.js +0 -419
  376. package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
  377. package/dist/transaction/auth/bootstrapScope.js +0 -1
  378. package/dist/transaction/auth/capability.d.ts +0 -212
  379. package/dist/transaction/auth/capability.js +0 -224
  380. package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
  381. package/dist/transaction/auth/credentialEndpoint.js +0 -86
  382. package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
  383. package/dist/transaction/auth/credentialPolicy.js +0 -125
  384. package/dist/transaction/auth/credentialSource.d.ts +0 -30
  385. package/dist/transaction/auth/credentialSource.js +0 -55
  386. package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
  387. package/dist/transaction/auth/hostedEndpoints.js +0 -21
  388. package/dist/transaction/auth/identity.d.ts +0 -55
  389. package/dist/transaction/auth/identity.js +0 -210
  390. package/dist/transaction/auth/index.d.ts +0 -162
  391. package/dist/transaction/auth/index.js +0 -304
  392. package/dist/transaction/auth/schemas.d.ts +0 -59
  393. package/dist/transaction/auth/schemas.js +0 -85
  394. package/dist/transaction/auth/sessionMint.d.ts +0 -28
  395. package/dist/transaction/auth/sessionMint.js +0 -85
  396. package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -56
  397. package/dist/transaction/coordination/awaitClaimGrant.js +0 -124
  398. package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -84
  399. package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -108
  400. package/dist/transaction/coordination/claimMeta.d.ts +0 -49
  401. package/dist/transaction/coordination/claimMeta.js +0 -52
  402. package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
  403. package/dist/transaction/coordination/createClaimStream.js +0 -475
  404. package/dist/transaction/coordination/events.d.ts +0 -74
  405. package/dist/transaction/coordination/events.js +0 -7
  406. package/dist/transaction/coordination/index.d.ts +0 -19
  407. package/dist/transaction/coordination/index.js +0 -45
  408. package/dist/transaction/coordination/locator.d.ts +0 -104
  409. package/dist/transaction/coordination/locator.js +0 -102
  410. package/dist/transaction/coordination/schema.d.ts +0 -1536
  411. package/dist/transaction/coordination/schema.js +0 -1177
  412. package/dist/transaction/coordination/targetConflict.d.ts +0 -2
  413. package/dist/transaction/coordination/targetConflict.js +0 -107
  414. package/dist/transaction/coordination/trace.d.ts +0 -78
  415. package/dist/transaction/coordination/trace.js +0 -138
  416. package/dist/transaction/durableWrites.d.ts +0 -62
  417. package/dist/transaction/durableWrites.js +0 -71
  418. package/dist/transaction/environment.d.ts +0 -105
  419. package/dist/transaction/environment.js +0 -108
  420. package/dist/transaction/errorCodes.d.ts +0 -403
  421. package/dist/transaction/errorCodes.js +0 -484
  422. package/dist/transaction/errors.d.ts +0 -428
  423. package/dist/transaction/errors.js +0 -686
  424. package/dist/transaction/footprint.d.ts +0 -111
  425. package/dist/transaction/footprint.js +0 -0
  426. package/dist/transaction/index.d.ts +0 -20
  427. package/dist/transaction/index.js +0 -20
  428. package/dist/transaction/keys/index.d.ts +0 -87
  429. package/dist/transaction/keys/index.js +0 -207
  430. package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
  431. package/dist/transaction/log/syncDeltaRow.js +0 -95
  432. package/dist/transaction/logPosition.d.ts +0 -97
  433. package/dist/transaction/logPosition.js +0 -125
  434. package/dist/transaction/logger.d.ts +0 -16
  435. package/dist/transaction/logger.js +0 -7
  436. package/dist/transaction/observability.d.ts +0 -53
  437. package/dist/transaction/observability.js +0 -19
  438. package/dist/transaction/persistence.d.ts +0 -12
  439. package/dist/transaction/persistence.js +0 -11
  440. package/dist/transaction/plugin.d.ts +0 -285
  441. package/dist/transaction/plugin.js +0 -106
  442. package/dist/transaction/policy/types.d.ts +0 -217
  443. package/dist/transaction/policy/types.js +0 -126
  444. package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
  445. package/dist/transaction/resources/functionalUpdate.js +0 -87
  446. package/dist/transaction/resources/httpResources.d.ts +0 -321
  447. package/dist/transaction/resources/httpResources.js +0 -7
  448. package/dist/transaction/resources/modelOperations.d.ts +0 -427
  449. package/dist/transaction/resources/modelOperations.js +0 -12
  450. package/dist/transaction/resources/mutationOptions.d.ts +0 -66
  451. package/dist/transaction/resources/mutationOptions.js +0 -9
  452. package/dist/transaction/resources/where.d.ts +0 -101
  453. package/dist/transaction/resources/where.js +0 -115
  454. package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
  455. package/dist/transaction/resources/writeOptionsSchema.js +0 -73
  456. package/dist/transaction/schema/field.d.ts +0 -120
  457. package/dist/transaction/schema/field.js +0 -265
  458. package/dist/transaction/schema/fieldRef.d.ts +0 -38
  459. package/dist/transaction/schema/fieldRef.js +0 -11
  460. package/dist/transaction/schema/loadStrategy.d.ts +0 -45
  461. package/dist/transaction/schema/loadStrategy.js +0 -46
  462. package/dist/transaction/schema/model.d.ts +0 -379
  463. package/dist/transaction/schema/model.js +0 -123
  464. package/dist/transaction/schema/openapi.d.ts +0 -58
  465. package/dist/transaction/schema/openapi.js +0 -501
  466. package/dist/transaction/schema/relation.d.ts +0 -204
  467. package/dist/transaction/schema/relation.js +0 -104
  468. package/dist/transaction/schema/residency.d.ts +0 -29
  469. package/dist/transaction/schema/residency.js +0 -25
  470. package/dist/transaction/schema/roles.d.ts +0 -249
  471. package/dist/transaction/schema/roles.js +0 -230
  472. package/dist/transaction/schema/schema.d.ts +0 -351
  473. package/dist/transaction/schema/schema.js +0 -325
  474. package/dist/transaction/schema/tenancy.d.ts +0 -139
  475. package/dist/transaction/schema/tenancy.js +0 -190
  476. package/dist/transaction/transactionLayer.d.ts +0 -82
  477. package/dist/transaction/transactionLayer.js +0 -24
  478. package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
  479. package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
  480. package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
  481. package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
  482. package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
  483. package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
  484. package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
  485. package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
  486. package/dist/transaction/transport/commitFrames.d.ts +0 -90
  487. package/dist/transaction/transport/commitFrames.js +0 -134
  488. package/dist/transaction/transport/connectionManager.d.ts +0 -215
  489. package/dist/transaction/transport/connectionManager.js +0 -673
  490. package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
  491. package/dist/transaction/transport/credentialLifecycle.js +0 -324
  492. package/dist/transaction/transport/heartbeat.d.ts +0 -65
  493. package/dist/transaction/transport/heartbeat.js +0 -93
  494. package/dist/transaction/transport/httpClient.d.ts +0 -131
  495. package/dist/transaction/transport/httpClient.js +0 -146
  496. package/dist/transaction/transport/httpOptions.d.ts +0 -33
  497. package/dist/transaction/transport/httpOptions.js +0 -12
  498. package/dist/transaction/transport/httpTransport.d.ts +0 -8
  499. package/dist/transaction/transport/httpTransport.js +0 -1388
  500. package/dist/transaction/transport/networkProbe.d.ts +0 -84
  501. package/dist/transaction/transport/networkProbe.js +0 -207
  502. package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
  503. package/dist/transaction/transport/wsFrameHandlers.js +0 -429
  504. package/dist/transaction/transport/wsTransport.d.ts +0 -574
  505. package/dist/transaction/transport/wsTransport.js +0 -1023
  506. package/dist/transaction/types/assertExact.d.ts +0 -17
  507. package/dist/transaction/types/assertExact.js +0 -1
  508. package/dist/transaction/types/global.d.ts +0 -107
  509. package/dist/transaction/types/global.js +0 -40
  510. package/dist/transaction/types/index.d.ts +0 -205
  511. package/dist/transaction/types/index.js +0 -56
  512. package/dist/transaction/types/modelData.d.ts +0 -10
  513. package/dist/transaction/types/modelData.js +0 -9
  514. package/dist/transaction/types/participant.d.ts +0 -20
  515. package/dist/transaction/types/participant.js +0 -10
  516. package/dist/transaction/types/streams.d.ts +0 -550
  517. package/dist/transaction/types/streams.js +0 -11
  518. package/dist/transaction/utils/asyncIterator.d.ts +0 -34
  519. package/dist/transaction/utils/asyncIterator.js +0 -135
  520. package/dist/transaction/utils/duration.d.ts +0 -50
  521. package/dist/transaction/utils/duration.js +0 -77
  522. package/dist/transaction/utils/json.d.ts +0 -57
  523. package/dist/transaction/utils/json.js +0 -276
  524. package/dist/transaction/wire/accountResponses.d.ts +0 -420
  525. package/dist/transaction/wire/accountResponses.js +0 -290
  526. package/dist/transaction/wire/auth.d.ts +0 -56
  527. package/dist/transaction/wire/auth.js +0 -63
  528. package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
  529. package/dist/transaction/wire/bootstrapReason.js +0 -8
  530. package/dist/transaction/wire/claimEvent.d.ts +0 -76
  531. package/dist/transaction/wire/claimEvent.js +0 -73
  532. package/dist/transaction/wire/claims.d.ts +0 -530
  533. package/dist/transaction/wire/claims.js +0 -327
  534. package/dist/transaction/wire/commit.d.ts +0 -603
  535. package/dist/transaction/wire/commit.js +0 -321
  536. package/dist/transaction/wire/delta.d.ts +0 -250
  537. package/dist/transaction/wire/delta.js +0 -147
  538. package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
  539. package/dist/transaction/wire/errorEnvelope.js +0 -123
  540. package/dist/transaction/wire/feedCursor.d.ts +0 -60
  541. package/dist/transaction/wire/feedCursor.js +0 -82
  542. package/dist/transaction/wire/feedEvent.d.ts +0 -204
  543. package/dist/transaction/wire/feedEvent.js +0 -65
  544. package/dist/transaction/wire/frames.d.ts +0 -194
  545. package/dist/transaction/wire/frames.js +0 -50
  546. package/dist/transaction/wire/inboundFrames.d.ts +0 -562
  547. package/dist/transaction/wire/inboundFrames.js +0 -116
  548. package/dist/transaction/wire/index.d.ts +0 -54
  549. package/dist/transaction/wire/index.js +0 -83
  550. package/dist/transaction/wire/listEnvelope.d.ts +0 -37
  551. package/dist/transaction/wire/listEnvelope.js +0 -42
  552. package/dist/transaction/wire/modelMutations.d.ts +0 -31
  553. package/dist/transaction/wire/modelMutations.js +0 -52
  554. package/dist/transaction/wire/modelResponses.d.ts +0 -85
  555. package/dist/transaction/wire/modelResponses.js +0 -43
  556. package/dist/transaction/wire/modelShape.d.ts +0 -78
  557. package/dist/transaction/wire/modelShape.js +0 -74
  558. package/dist/transaction/wire/protocol.d.ts +0 -38
  559. package/dist/transaction/wire/protocol.js +0 -38
  560. package/dist/transaction/wire/protocolVersion.d.ts +0 -73
  561. package/dist/transaction/wire/protocolVersion.js +0 -83
  562. package/dist/transactions/mutations/MutationQueue.d.ts +0 -661
  563. package/dist/transactions/mutations/MutationQueue.js +0 -2807
  564. package/dist/transactions/mutations/MutationStore.d.ts +0 -20
  565. package/dist/transactions/mutations/MutationStore.js +0 -53
  566. package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
  567. package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
  568. package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
  569. package/dist/transactions/mutations/coalesceRules.js +0 -140
  570. package/dist/transactions/mutations/commitLatency.d.ts +0 -52
  571. package/dist/transactions/mutations/commitLatency.js +0 -130
  572. package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
  573. package/dist/transactions/mutations/commitOutboxStore.js +0 -26
  574. package/dist/transactions/mutations/commitPayload.d.ts +0 -165
  575. package/dist/transactions/mutations/commitPayload.js +0 -152
  576. package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -63
  577. package/dist/transactions/mutations/deltaConfirmation.js +0 -235
  578. package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
  579. package/dist/transactions/mutations/durableWriteStore.js +0 -12
  580. package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
  581. package/dist/transactions/mutations/optimisticApply.js +0 -65
  582. package/dist/transactions/mutations/replayValidation.d.ts +0 -187
  583. package/dist/transactions/mutations/replayValidation.js +0 -164
  584. package/dist/utils/mobxSetup.d.ts +0 -53
  585. package/dist/utils/mobxSetup.js +0 -330
  586. package/dist/views/QueryView.d.ts +0 -79
  587. package/dist/views/QueryView.js +0 -218
  588. package/dist/views/ViewRegistry.d.ts +0 -20
  589. package/dist/views/ViewRegistry.js +0 -55
  590. package/dist/views/incrementalView.d.ts +0 -45
  591. package/dist/views/incrementalView.js +0 -69
  592. package/dist/webhooks/events.d.ts +0 -43
  593. package/dist/webhooks/events.js +0 -42
  594. package/dist/webhooks/index.d.ts +0 -8
  595. package/dist/webhooks/index.js +0 -8
  596. package/dist/wire/index.d.ts +0 -1
  597. package/dist/wire/index.js +0 -8
@@ -1,148 +0,0 @@
1
- /**
2
- * Decides what a credential is and how to use it when a client connects. A
3
- * caller configures an Ablo client with an API key, and this module answers two
4
- * questions about that value: which of the four key kinds it is, and which
5
- * connect-time route it takes.
6
- *
7
- * The routing decision is the only thing that lives here. This module does not
8
- * perform the network calls that mint or exchange credentials;
9
- * {@link resolveCredential} delegates those to primitives the caller supplies,
10
- * so the decision of what to do stays separate from the work of doing it.
11
- *
12
- * {@link classifyCredentialKind} is a plain string check with no Node
13
- * dependencies, so it is safe to run in a browser bundle. It recognizes the key
14
- * prefixes `sk_` (secret), `rk_` (restricted), `ek_` (ephemeral), and `pk_`
15
- * (publishable), but does not validate a key's checksum or environment segment.
16
- */
17
- import type { exchangeApiKey, mintUserSessionKey, resolveIdentity } from './index.js';
18
- /**
19
- * The shape of the function that resolves a configured `apiKey` — which may be a
20
- * string or an async setter — down to a concrete string, or `null` when no key
21
- * is available. It is declared here structurally, rather than imported, to avoid
22
- * a circular dependency between this module and the code that supplies the
23
- * function. Any function with a matching shape satisfies it.
24
- */
25
- type ResolveApiKeyValueFn = (apiKey: string | (() => Promise<string | null>) | null) => Promise<string | null>;
26
- /**
27
- * The four kinds of Ablo API key, one per prefix: `sk_` is secret, `ek_` is
28
- * ephemeral, `rk_` is restricted, and `pk_` is publishable. The list is declared
29
- * here, rather than imported, so this browser-safe module stays free of Node-only
30
- * dependencies.
31
- */
32
- export type CredentialKind = 'secret' | 'ephemeral' | 'restricted' | 'publishable';
33
- /**
34
- * Classifies a credential by its prefix, returning its {@link CredentialKind}, or
35
- * `null` when the value carries no recognized Ablo key prefix — for example a
36
- * capability or auth token the caller supplied, or an empty string. This is a
37
- * plain string check that is safe to run in a browser; it decides only which of
38
- * the four kinds a value is, and does not validate the key's checksum or
39
- * environment segment.
40
- */
41
- export declare function classifyCredentialKind(value: string): CredentialKind | null;
42
- /**
43
- * The set of authentication primitives that {@link resolveCredential} delegates
44
- * to. Injecting them keeps the network calls that mint and exchange credentials
45
- * in one place and leaves this module responsible only for the routing decision.
46
- * {@link resolveCredential} never calls `mintUserSessionKey` itself — an
47
- * ephemeral `ek_` key is minted before the client connects and arrives ready to
48
- * use — but it is listed here to describe the full primitive surface.
49
- */
50
- export interface CredentialPrimitives {
51
- readonly exchangeApiKey: typeof exchangeApiKey;
52
- readonly mintUserSessionKey: typeof mintUserSessionKey;
53
- readonly resolveIdentity: typeof resolveIdentity;
54
- readonly resolveApiKeyValue: ResolveApiKeyValueFn;
55
- }
56
- export interface ResolveCredentialContext {
57
- readonly primitives: CredentialPrimitives;
58
- /**
59
- * The arguments for the credential exchange, minus the `apiKey`. The caller
60
- * derives the base URL and participant scope and supplies them here;
61
- * {@link resolveCredential} fills in the resolved `apiKey` and calls
62
- * `exchangeApiKey`.
63
- */
64
- readonly exchangeArgs: Omit<Parameters<typeof exchangeApiKey>[0], 'apiKey'>;
65
- }
66
- export interface ResolveCredentialInput {
67
- /** Resolved string value of the configured `apiKey` (callable already invoked), or null. */
68
- readonly apiKeyValue: string | null;
69
- /** The configured `apiKey` (string or setter) — threaded onto the refresh path. */
70
- readonly configuredApiKey: string | (() => Promise<string | null>) | null;
71
- /** Explicit caller-supplied capability token (`options.capabilityToken`). */
72
- readonly capabilityToken: string | undefined;
73
- /** Configured static `authToken`. */
74
- readonly authToken: string | null;
75
- /** True when the caller already knows its own identity, so no server round-trip is needed to resolve it. */
76
- readonly hasExplicitIdentity: boolean;
77
- }
78
- /**
79
- * The outcome of the connect-time decision, as a discriminated union over the
80
- * route rather than the key kind: an `ek_` and an `rk_` key both take the
81
- * `pre-minted` route, as does a bare capability token. The caller switches on
82
- * `kind` and wires up the scope and side effects each route needs.
83
- *
84
- * Every variant carries the same three fields:
85
- * - `getBearer` — the token used to authenticate the bootstrap and `/auth/*`
86
- * requests, and to seed the credential source.
87
- * - `expiresAtMs` — when the credential expires, which drives the refresh
88
- * scheduler, or `null` when there is nothing to refresh.
89
- * - `controlPlaneKey` — the original configured API key when the route minted
90
- * its bearer through an exchange, so a refresh can mint again; otherwise
91
- * `null`.
92
- */
93
- export type ResolvedCredential =
94
- /** `pk_` — long-lived browser-safe read-only project key. Used directly as the
95
- * bearer; never exchanged, never refreshed. Identity resolved via `/auth/identity`. */
96
- {
97
- readonly kind: 'publishable';
98
- readonly getBearer: string;
99
- readonly expiresAtMs: null;
100
- readonly controlPlaneKey: null;
101
- }
102
- /** `sk_` (no explicit cap token) — hosted-cloud. Exchanged for a capability
103
- * token via `exchangeApiKey`; the refresh scheduler re-mints before expiry. */
104
- | {
105
- readonly kind: 'exchange';
106
- /** Result of the initial `exchangeApiKey` call. */
107
- readonly exchange: Awaited<ReturnType<typeof exchangeApiKey>>;
108
- readonly getBearer: string;
109
- readonly expiresAtMs: number;
110
- /** The configured apiKey (string or setter) — read fresh on each refresh. */
111
- readonly controlPlaneKey: string | (() => Promise<string | null>);
112
- }
113
- /** A pre-minted `ek_` or `rk_` key, or an explicit capability or auth token,
114
- * used as the bearer without any exchange. Identity resolved via `/auth/identity`. */
115
- | {
116
- readonly kind: 'pre-minted';
117
- readonly getBearer: string;
118
- readonly expiresAtMs: null;
119
- readonly controlPlaneKey: null;
120
- }
121
- /** The caller already knows its own organization and user or agent id, so there
122
- * is no server round-trip; the optional bearer is the initial capability token. */
123
- | {
124
- readonly kind: 'explicit';
125
- readonly getBearer: string | undefined;
126
- readonly expiresAtMs: null;
127
- readonly controlPlaneKey: null;
128
- };
129
- /**
130
- * Routes a configured API key to its connect-time outcome. It classifies the
131
- * key, then returns one of four {@link ResolvedCredential} variants, delegating
132
- * any credential exchange to the injected `exchangeApiKey` primitive. The caller
133
- * switches on the result's `kind` to wire up scope and the refresh scheduler.
134
- *
135
- * The routes, in the order they are tried:
136
- * 0. A `pk_` key with no explicit capability token becomes `publishable`: used
137
- * directly as the bearer, with no refresh.
138
- * 1. Any other exchangeable key (one that is not a pre-minted `ek_` or `rk_`)
139
- * with no explicit capability token becomes `exchange`: a round-trip mints a
140
- * capability token, and the refresh scheduler renews it before it expires.
141
- * 2. Otherwise, when the caller's identity is not yet known, the result is
142
- * `pre-minted`: the capability token is used as-is. Throws `session_expired`
143
- * when there is no token to authenticate `/auth/identity`.
144
- * 3. Otherwise, when the caller already knows its identity, the result is
145
- * `explicit`, with no round-trip.
146
- */
147
- export declare function resolveCredential(input: ResolveCredentialInput, ctx: ResolveCredentialContext): Promise<ResolvedCredential>;
148
- export {};
@@ -1,125 +0,0 @@
1
- /**
2
- * Decides what a credential is and how to use it when a client connects. A
3
- * caller configures an Ablo client with an API key, and this module answers two
4
- * questions about that value: which of the four key kinds it is, and which
5
- * connect-time route it takes.
6
- *
7
- * The routing decision is the only thing that lives here. This module does not
8
- * perform the network calls that mint or exchange credentials;
9
- * {@link resolveCredential} delegates those to primitives the caller supplies,
10
- * so the decision of what to do stays separate from the work of doing it.
11
- *
12
- * {@link classifyCredentialKind} is a plain string check with no Node
13
- * dependencies, so it is safe to run in a browser bundle. It recognizes the key
14
- * prefixes `sk_` (secret), `rk_` (restricted), `ek_` (ephemeral), and `pk_`
15
- * (publishable), but does not validate a key's checksum or environment segment.
16
- */
17
- import { AbloAuthenticationError } from '../errors.js';
18
- const KIND_BY_PREFIX = [
19
- ['sk_', 'secret'],
20
- ['ek_', 'ephemeral'],
21
- ['rk_', 'restricted'],
22
- ['pk_', 'publishable'],
23
- ];
24
- /**
25
- * Classifies a credential by its prefix, returning its {@link CredentialKind}, or
26
- * `null` when the value carries no recognized Ablo key prefix — for example a
27
- * capability or auth token the caller supplied, or an empty string. This is a
28
- * plain string check that is safe to run in a browser; it decides only which of
29
- * the four kinds a value is, and does not validate the key's checksum or
30
- * environment segment.
31
- */
32
- export function classifyCredentialKind(value) {
33
- for (const [prefix, kind] of KIND_BY_PREFIX) {
34
- if (value.startsWith(prefix))
35
- return kind;
36
- }
37
- return null;
38
- }
39
- /**
40
- * Routes a configured API key to its connect-time outcome. It classifies the
41
- * key, then returns one of four {@link ResolvedCredential} variants, delegating
42
- * any credential exchange to the injected `exchangeApiKey` primitive. The caller
43
- * switches on the result's `kind` to wire up scope and the refresh scheduler.
44
- *
45
- * The routes, in the order they are tried:
46
- * 0. A `pk_` key with no explicit capability token becomes `publishable`: used
47
- * directly as the bearer, with no refresh.
48
- * 1. Any other exchangeable key (one that is not a pre-minted `ek_` or `rk_`)
49
- * with no explicit capability token becomes `exchange`: a round-trip mints a
50
- * capability token, and the refresh scheduler renews it before it expires.
51
- * 2. Otherwise, when the caller's identity is not yet known, the result is
52
- * `pre-minted`: the capability token is used as-is. Throws `session_expired`
53
- * when there is no token to authenticate `/auth/identity`.
54
- * 3. Otherwise, when the caller already knows its identity, the result is
55
- * `explicit`, with no round-trip.
56
- */
57
- export async function resolveCredential(input, ctx) {
58
- const { apiKeyValue, capabilityToken, authToken, hasExplicitIdentity } = input;
59
- const kind = apiKeyValue != null ? classifyCredentialKind(apiKeyValue) : null;
60
- // A pre-minted capability bearer (an ephemeral `ek_` or restricted `rk_` key)
61
- // is not exchangeable: it was minted before connect and is used directly as the
62
- // bearer on Route 2, never sent through `exchangeApiKey`, which expects an `sk_`.
63
- const isPreMintedCapabilityBearer = kind === 'ephemeral' || kind === 'restricted';
64
- const initialCapToken = capabilityToken ??
65
- (isPreMintedCapabilityBearer ? apiKeyValue ?? undefined : undefined) ??
66
- authToken ??
67
- undefined;
68
- // Route 0: a publishable `pk_` key — long-lived, browser-safe, and read-only.
69
- // Used directly as the bearer; it is never exchanged, so it never expires and
70
- // there is nothing to refresh.
71
- if (apiKeyValue != null && kind === 'publishable' && capabilityToken == null) {
72
- return {
73
- kind: 'publishable',
74
- getBearer: apiKeyValue,
75
- expiresAtMs: null,
76
- controlPlaneKey: null,
77
- };
78
- }
79
- // Route 1: an exchangeable key (such as a secret `sk_`) with no caller-supplied
80
- // capability token. A pre-minted `ek_` or `rk_` is not exchangeable and falls
81
- // through to the next route.
82
- if (apiKeyValue != null &&
83
- capabilityToken == null &&
84
- !isPreMintedCapabilityBearer) {
85
- const exchange = await ctx.primitives.exchangeApiKey({
86
- ...ctx.exchangeArgs,
87
- apiKey: apiKeyValue,
88
- });
89
- return {
90
- kind: 'exchange',
91
- exchange,
92
- getBearer: exchange.token,
93
- expiresAtMs: Date.parse(exchange.expiresAt),
94
- controlPlaneKey: input.configuredApiKey ?? apiKeyValue,
95
- };
96
- }
97
- // Route 2: pre-minted — use the capability token as-is. Reached when the
98
- // caller's identity was not supplied.
99
- if (!hasExplicitIdentity) {
100
- if (initialCapToken == null) {
101
- // With no key to exchange and no caller-supplied identity, this token is the
102
- // only thing that could authenticate `/auth/identity`. When it is absent —
103
- // commonly a function `apiKey` resolver returning `null` for a missing or
104
- // expired session — report the re-authenticable condition here instead of
105
- // making a round-trip that is bound to fail.
106
- throw new AbloAuthenticationError('No auth token available to resolve identity — the session token is ' +
107
- 'missing or expired. Ensure your `apiKey` resolver returns a valid token, or ' +
108
- 'pass a static `apiKey` / `capabilityToken`.', { code: 'session_expired' });
109
- }
110
- return {
111
- kind: 'pre-minted',
112
- getBearer: initialCapToken,
113
- expiresAtMs: null,
114
- controlPlaneKey: null,
115
- };
116
- }
117
- // Route 3: explicit — the caller already knows its own organization and user
118
- // or agent id.
119
- return {
120
- kind: 'explicit',
121
- getBearer: initialCapToken,
122
- expiresAtMs: null,
123
- controlPlaneKey: null,
124
- };
125
- }
@@ -1,30 +0,0 @@
1
- /**
2
- * The single mutable holder for the active bearer credential every transport
3
- * uses.
4
- *
5
- * Each transport reads the current token from this object at request or connect
6
- * time — the HTTP request paths and the WebSocket URL authorizer alike. When the
7
- * token is refreshed, it is written here once, and every reader observes the new
8
- * value through its getter rather than being updated one by one.
9
- */
10
- export { WS_BEARER_SUBPROTOCOL_PREFIX, WS_SYNC_SUBPROTOCOL } from '../wire/protocol.js';
11
- export interface AuthCredentialSource {
12
- /**
13
- * Declared as a standalone closure rather than a method because callers pass
14
- * it on by reference — the transport and the core client each take
15
- * `getAuthToken` alone and call it with no receiver. The implementation is a
16
- * closure over the token, so that is safe; typing it as a method would say
17
- * otherwise and make every hand-off read as a lost `this`.
18
- */
19
- getAuthToken: () => string | null;
20
- setAuthToken(token: string | null | undefined): void;
21
- authorizationHeader(): string | undefined;
22
- withAuthHeaders(headers?: Record<string, string>): Record<string, string>;
23
- applyAuthQueryParam(params: URLSearchParams, paramName?: string): void;
24
- }
25
- export type AuthTokenGetter = () => string | null | undefined;
26
- export declare function createAuthCredentialSource(initialToken?: string | null): AuthCredentialSource;
27
- export declare function resolveAuthToken(getAuthToken?: AuthTokenGetter, fallbackToken?: string | null): string | undefined;
28
- export declare function authorizationHeaderForToken(token: string | null | undefined): string | undefined;
29
- export declare function withAuthHeaders(getAuthToken: AuthTokenGetter | undefined, headers?: Record<string, string>, fallbackToken?: string | null): Record<string, string>;
30
- export declare function applyAuthToQueryParams(params: URLSearchParams, getAuthToken: AuthTokenGetter | undefined, paramName?: string, fallbackToken?: string | null): void;
@@ -1,55 +0,0 @@
1
- /**
2
- * The single mutable holder for the active bearer credential every transport
3
- * uses.
4
- *
5
- * Each transport reads the current token from this object at request or connect
6
- * time — the HTTP request paths and the WebSocket URL authorizer alike. When the
7
- * token is refreshed, it is written here once, and every reader observes the new
8
- * value through its getter rather than being updated one by one.
9
- */
10
- // The WebSocket bearer-subprotocol constants are defined in `../wire/protocol.js`
11
- // as part of the wire contract shared between client and server. They are
12
- // re-exported here so this module stays a stable import site for them.
13
- export { WS_BEARER_SUBPROTOCOL_PREFIX, WS_SYNC_SUBPROTOCOL } from '../wire/protocol.js';
14
- export function createAuthCredentialSource(initialToken) {
15
- let authToken = normalizeToken(initialToken);
16
- return {
17
- getAuthToken: () => authToken,
18
- setAuthToken(token) {
19
- authToken = normalizeToken(token);
20
- },
21
- authorizationHeader() {
22
- return authorizationHeaderForToken(authToken);
23
- },
24
- withAuthHeaders(headers = {}) {
25
- const authorization = authorizationHeaderForToken(authToken);
26
- return authorization ? { ...headers, Authorization: authorization } : { ...headers };
27
- },
28
- applyAuthQueryParam(params, paramName = 'authorization') {
29
- applyAuthToQueryParams(params, () => authToken, paramName);
30
- },
31
- };
32
- }
33
- export function resolveAuthToken(getAuthToken, fallbackToken) {
34
- return normalizeToken(getAuthToken?.() ?? fallbackToken) ?? undefined;
35
- }
36
- export function authorizationHeaderForToken(token) {
37
- const normalized = normalizeToken(token);
38
- return normalized ? `Bearer ${normalized}` : undefined;
39
- }
40
- export function withAuthHeaders(getAuthToken, headers = {}, fallbackToken) {
41
- const authorization = authorizationHeaderForToken(resolveAuthToken(getAuthToken, fallbackToken));
42
- return authorization ? { ...headers, Authorization: authorization } : { ...headers };
43
- }
44
- export function applyAuthToQueryParams(params, getAuthToken, paramName = 'authorization', fallbackToken) {
45
- const authorization = authorizationHeaderForToken(resolveAuthToken(getAuthToken, fallbackToken));
46
- if (authorization) {
47
- params.set(paramName, authorization);
48
- }
49
- }
50
- function normalizeToken(token) {
51
- if (!token)
52
- return null;
53
- const trimmed = token.trim();
54
- return trimmed.length > 0 ? trimmed : null;
55
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * The hosted Ablo Cloud endpoint constants, with no dependencies of their own.
3
- *
4
- * This is the single place the hosted API host is declared. URL resolution, the
5
- * CLI's default URL, the data-source connector's base, the generated OpenAPI
6
- * server entry, and the network probe's default all import from here, so
7
- * changing the API domain is a one-line edit.
8
- *
9
- * These constants are kept dependency-free deliberately: several low-level
10
- * modules consume them, and routing those modules through the auth layer would
11
- * pull the error registry and credential policy into otherwise-clean paths and
12
- * risk an import cycle.
13
- */
14
- /** The hosted API domain (no scheme). */
15
- export declare const ABLO_HOSTED_API_DOMAIN = "api.abloatai.com";
16
- /** The hosted HTTP origin — `https://` + {@link ABLO_HOSTED_API_DOMAIN}. */
17
- export declare const ABLO_HOSTED_HTTP_BASE_URL = "https://api.abloatai.com";
18
- /** Default `baseURL` when the caller passes none. Same value as
19
- * {@link ABLO_HOSTED_HTTP_BASE_URL}; kept as a distinct name because it is
20
- * the documented client-options default. */
21
- export declare const ABLO_DEFAULT_BASE_URL = "https://api.abloatai.com";
@@ -1,21 +0,0 @@
1
- /**
2
- * The hosted Ablo Cloud endpoint constants, with no dependencies of their own.
3
- *
4
- * This is the single place the hosted API host is declared. URL resolution, the
5
- * CLI's default URL, the data-source connector's base, the generated OpenAPI
6
- * server entry, and the network probe's default all import from here, so
7
- * changing the API domain is a one-line edit.
8
- *
9
- * These constants are kept dependency-free deliberately: several low-level
10
- * modules consume them, and routing those modules through the auth layer would
11
- * pull the error registry and credential policy into otherwise-clean paths and
12
- * risk an import cycle.
13
- */
14
- /** The hosted API domain (no scheme). */
15
- export const ABLO_HOSTED_API_DOMAIN = 'api.abloatai.com';
16
- /** The hosted HTTP origin — `https://` + {@link ABLO_HOSTED_API_DOMAIN}. */
17
- export const ABLO_HOSTED_HTTP_BASE_URL = `https://${ABLO_HOSTED_API_DOMAIN}`;
18
- /** Default `baseURL` when the caller passes none. Same value as
19
- * {@link ABLO_HOSTED_HTTP_BASE_URL}; kept as a distinct name because it is
20
- * the documented client-options default. */
21
- export const ABLO_DEFAULT_BASE_URL = ABLO_HOSTED_HTTP_BASE_URL;
@@ -1,55 +0,0 @@
1
- /**
2
- * Resolves a participant's identity and scope when an {@link Ablo} client is
3
- * constructed, following whichever of three authentication paths the caller's
4
- * options select:
5
- *
6
- * 1. **Hosted cloud** — the caller passed an `apiKey`. The client exchanges it
7
- * for a capability token and scope, then starts a scheduler that re-mints the
8
- * token before it expires, so the rotation is invisible to the caller.
9
- * 2. **Self-derived** — the caller passed a bearer or capability token but not
10
- * an identity. The client asks the identity endpoint to recover the
11
- * participant id and scope from the token.
12
- * 3. **Explicit** — a self-hosted caller passed the organization id and a user
13
- * or agent id directly. No server round-trip; the client trusts the caller.
14
- *
15
- * Each branch is a separate function below, so it can be read and tested on its own.
16
- */
17
- import type { ParticipantKind } from '../types/participant.js';
18
- import { type RefreshScheduler } from '../auth/index.js';
19
- import type { BootstrapScope } from '../auth/bootstrapScope.js';
20
- import type { Logger } from '../logger.js';
21
- import type { AuthCredentialSource } from '../auth/credentialSource.js';
22
- import type { ApiKeySetter } from './apiKey.js';
23
- export interface IdentityResolveInput {
24
- readonly options: {
25
- readonly capabilityToken?: string;
26
- readonly bootstrapBaseUrl?: string;
27
- readonly user?: {
28
- id: string;
29
- teamIds?: string[];
30
- };
31
- readonly agentId?: string;
32
- readonly syncGroups?: string[];
33
- };
34
- readonly internalOptions: {
35
- readonly organizationId?: string;
36
- };
37
- readonly url: string;
38
- readonly kind: ParticipantKind;
39
- readonly configuredApiKey: string | ApiKeySetter | null;
40
- readonly configuredAuthToken: string | null;
41
- readonly bootstrapHelper: BootstrapScope;
42
- readonly auth: AuthCredentialSource;
43
- readonly logger: Logger;
44
- }
45
- export interface ResolvedIdentity {
46
- readonly userId: string;
47
- readonly accountScope: string;
48
- readonly teamIds: string[] | undefined;
49
- readonly capabilityToken: string | undefined;
50
- readonly syncGroups: readonly string[] | undefined;
51
- readonly participantKind: ParticipantKind;
52
- /** Set only on the hosted-cloud path; the caller keeps it to stop refreshes on shutdown. */
53
- readonly refreshScheduler: RefreshScheduler | null;
54
- }
55
- export declare function resolveParticipantIdentity(input: IdentityResolveInput): Promise<ResolvedIdentity>;
@@ -1,210 +0,0 @@
1
- /**
2
- * Resolves a participant's identity and scope when an {@link Ablo} client is
3
- * constructed, following whichever of three authentication paths the caller's
4
- * options select:
5
- *
6
- * 1. **Hosted cloud** — the caller passed an `apiKey`. The client exchanges it
7
- * for a capability token and scope, then starts a scheduler that re-mints the
8
- * token before it expires, so the rotation is invisible to the caller.
9
- * 2. **Self-derived** — the caller passed a bearer or capability token but not
10
- * an identity. The client asks the identity endpoint to recover the
11
- * participant id and scope from the token.
12
- * 3. **Explicit** — a self-hosted caller passed the organization id and a user
13
- * or agent id directly. No server round-trip; the client trusts the caller.
14
- *
15
- * Each branch is a separate function below, so it can be read and tested on its own.
16
- */
17
- import { AbloAuthenticationError } from '../errors.js';
18
- import { exchangeApiKey } from '../auth/index.js';
19
- import { mintUserSessionKey } from '../auth/index.js';
20
- import { resolveIdentity } from '../auth/index.js';
21
- import { createRefreshScheduler, } from '../auth/index.js';
22
- import { resolveCredential, } from '../auth/credentialPolicy.js';
23
- import { resolveApiKeyValue, resolveBootstrapBaseUrl } from './apiKey.js';
24
- export async function resolveParticipantIdentity(input) {
25
- const { options, internalOptions, url, kind, configuredApiKey, configuredAuthToken, bootstrapHelper, auth, logger, } = input;
26
- const apiKeyValue = await resolveApiKeyValue(configuredApiKey);
27
- // Resolve the http(s) base URL, coercing ws/wss to http/https even when
28
- // `bootstrapBaseUrl` is an explicit override (see auth.ts).
29
- const baseUrl = resolveBootstrapBaseUrl({
30
- url,
31
- bootstrapBaseUrl: options.bootstrapBaseUrl,
32
- });
33
- // An organization id plus a caller-supplied participant id is the explicit path:
34
- // the caller already knows its own identity, so no server round-trip is needed.
35
- const hasExplicitIdentity = internalOptions.organizationId != null &&
36
- (kind === 'agent' ? options.agentId != null : options.user?.id != null);
37
- // The credential-routing decision lives in `credentialPolicy`: it classifies the
38
- // apiKey by prefix (`sk_`/`ek_`/`rk_`/`pk_`) and picks a route. The hosted
39
- // exchange is the one mint the policy performs (via the injected
40
- // `exchangeApiKey`); every other route simply returns the bearer to use. The
41
- // switch below applies scope and sets up the refresh scheduler for each case.
42
- const cred = await resolveCredential({
43
- apiKeyValue,
44
- configuredApiKey,
45
- capabilityToken: options.capabilityToken,
46
- authToken: configuredAuthToken,
47
- hasExplicitIdentity,
48
- }, {
49
- primitives: {
50
- exchangeApiKey,
51
- mintUserSessionKey,
52
- resolveIdentity,
53
- resolveApiKeyValue,
54
- },
55
- exchangeArgs: {
56
- baseUrl,
57
- participantKind: (kind === 'agent' ? 'agent' : 'system'),
58
- participantId: options.agentId ?? options.user?.id,
59
- wideScope: true,
60
- ttlSeconds: 3600,
61
- },
62
- });
63
- switch (cred.kind) {
64
- case 'publishable':
65
- // `pk_` is a long-lived, browser-safe, read-only project key. It is used
66
- // directly as the bearer and is never exchanged for a short-lived
67
- // capability, so it never expires and there is nothing to refresh. The
68
- // server resolves the organization and read-only scope from the key itself;
69
- // we still call `/auth/identity` with the `pk_` bearer to learn the account
70
- // scope and sync groups for the bootstrap cache.
71
- return resolveViaIdentity({
72
- bearer: cred.getBearer,
73
- baseUrl,
74
- options,
75
- bootstrapHelper,
76
- auth,
77
- });
78
- case 'exchange':
79
- // Hosted-cloud (`sk_`): the policy exchanged the apiKey for a capability
80
- // token; here we apply the returned scope and set up the refresh scheduler.
81
- return resolveHosted({
82
- cred,
83
- configuredApiKey,
84
- baseUrl,
85
- kind,
86
- options,
87
- bootstrapHelper,
88
- auth,
89
- logger,
90
- });
91
- case 'pre-minted':
92
- // Self-derived: a pre-minted `ek_`/`rk_` bearer or an explicit capability
93
- // token authenticates `/auth/identity` directly (no exchange, no refresh).
94
- return resolveViaIdentity({
95
- bearer: cred.getBearer,
96
- baseUrl,
97
- options,
98
- bootstrapHelper,
99
- auth,
100
- });
101
- case 'explicit': {
102
- // Explicit self-hosted identity: the caller supplied its own organization id
103
- // and user or agent id.
104
- const userId = kind === 'agent' ? options.agentId : options.user.id;
105
- const accountScope = internalOptions.organizationId;
106
- bootstrapHelper.setCacheScope(accountScope);
107
- bootstrapHelper.setSyncGroups(options.syncGroups);
108
- auth.setAuthToken(cred.getBearer);
109
- return {
110
- userId,
111
- accountScope,
112
- teamIds: kind === 'user' ? options.user?.teamIds : undefined,
113
- capabilityToken: cred.getBearer,
114
- syncGroups: options.syncGroups,
115
- participantKind: kind,
116
- refreshScheduler: null,
117
- };
118
- }
119
- }
120
- }
121
- /**
122
- * Resolves identity through the `/auth/identity` endpoint for the publishable
123
- * (`pk_`) and pre-minted (`ek_`/`rk_` or explicit capability token) routes. The
124
- * bearer is used as-is, the server resolves the identity, and any caller-passed
125
- * sync groups are merged with the server-resolved set.
126
- */
127
- async function resolveViaIdentity(input) {
128
- const { bearer, baseUrl, options, bootstrapHelper, auth } = input;
129
- const identity = await resolveIdentity({ baseUrl, authToken: bearer });
130
- // Merge the caller's sync groups with the server-resolved set rather than
131
- // letting the server response overwrite them. A client may compose groups such
132
- // as `['default', 'org:<id>', 'user:<id>', 'team:<id>']` from the resolved
133
- // session and pass them in; the identity endpoint can return an empty set (for
134
- // example, for cookie-authenticated users), and an empty set makes the server
135
- // bootstrap fall back to `['default']`, so no deltas fan out and live updates
136
- // appear only on a hard reload. Merging keeps the caller's groups intact.
137
- const callerGroups = options.syncGroups ?? [];
138
- const mergedSyncGroups = callerGroups.length > 0
139
- ? [...new Set([...callerGroups, ...identity.syncGroups])]
140
- : identity.syncGroups;
141
- bootstrapHelper.setCacheScope(identity.accountScope);
142
- bootstrapHelper.setSyncGroups(mergedSyncGroups);
143
- auth.setAuthToken(bearer);
144
- return {
145
- userId: identity.participantId,
146
- accountScope: identity.accountScope,
147
- teamIds: undefined,
148
- capabilityToken: bearer,
149
- syncGroups: mergedSyncGroups,
150
- participantKind: identity.participantKind,
151
- refreshScheduler: null,
152
- };
153
- }
154
- async function resolveHosted(input) {
155
- // The managed-cloud shape, `Ablo({ schema, apiKey })`. The credential policy has
156
- // already exchanged the apiKey via `exchangeApiKey`; here we apply the returned
157
- // scope and set up the refresh scheduler.
158
- const { exchange } = input.cred;
159
- const baseUrl = input.baseUrl;
160
- // The refresh path re-runs `exchangeApiKey` with a freshly-resolved apiKey, so
161
- // it needs the same argument bag the policy used for the initial exchange.
162
- const participantKind = input.kind === 'agent' ? 'agent' : 'system';
163
- const exchangeArgs = {
164
- baseUrl,
165
- participantKind,
166
- participantId: input.options.agentId ?? input.options.user?.id,
167
- wideScope: true,
168
- ttlSeconds: 3600,
169
- };
170
- input.bootstrapHelper.setCacheScope(exchange.scope.organizationId);
171
- input.bootstrapHelper.setSyncGroups(exchange.scope.syncGroups);
172
- input.auth.setAuthToken(exchange.token);
173
- // Capability tokens carry a server-set TTL (3600s by default). Without proactive
174
- // refresh, the socket would be force-closed at expiry, or the next reconnect
175
- // would fail with a 401. The scheduler re-mints ahead of that, so the consumer
176
- // never sees the rotation.
177
- const refreshScheduler = createRefreshScheduler({
178
- initialExpiresAtMs: Date.parse(exchange.expiresAt),
179
- refresh: async () => {
180
- // Read the apiKey fresh each time — supports the ApiKeySetter
181
- // (rotating credentials) shape.
182
- const freshApiKey = await resolveApiKeyValue(input.configuredApiKey);
183
- if (!freshApiKey) {
184
- throw new AbloAuthenticationError('apiKey unavailable during refresh', { code: 'apikey_missing' });
185
- }
186
- const next = await exchangeApiKey({
187
- ...exchangeArgs,
188
- apiKey: freshApiKey,
189
- });
190
- input.auth.setAuthToken(next.token);
191
- return { expiresAtMs: Date.parse(next.expiresAt) };
192
- },
193
- onError: (err) => {
194
- input.logger.debug('cap token refresh failed; will retry', {
195
- error: err.message,
196
- });
197
- },
198
- });
199
- return {
200
- userId: exchange.scope.participantId,
201
- accountScope: exchange.scope.organizationId,
202
- // teamIds isn't needed because the server already encoded
203
- // team-level access into scope.syncGroups.
204
- teamIds: undefined,
205
- capabilityToken: exchange.token,
206
- syncGroups: exchange.scope.syncGroups,
207
- participantKind: input.kind,
208
- refreshScheduler,
209
- };
210
- }