@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,111 +0,0 @@
1
- /**
2
- * The footprint — every object Ablo leaves inside a customer's own database,
3
- * declared once.
4
- *
5
- * Four things need this list and each used to carry its own copy: the setup SQL
6
- * that creates the objects, the replication runtime that reads them, the audit
7
- * that tells a customer what Ablo put there, and (eventually) the teardown that
8
- * removes them. They drifted, as hand-maintained copies do — `ABLO_PUBLICATION`
9
- * was declared twice, under a comment insisting the literals "MUST equal the
10
- * CLI's" and pointing at a file that no longer held it, and the audit went on
11
- * looking for a footprint from an earlier era while seeing none of what Ablo
12
- * installs today.
13
- *
14
- * The audit is the copy that matters most. A customer runs it to answer "what is
15
- * still in my database", and a stale list answers "nothing" — which reads as
16
- * clean rather than as unexamined. So the list lives here, every consumer
17
- * derives from it, and an object added to Ablo's setup is visible to the audit
18
- * because it could not have been added anywhere else.
19
- *
20
- * Retired objects stay in the list, marked {@link FootprintArtifact.retired}.
21
- * They are no longer installed, but a database connected to an older Ablo still
22
- * holds them, and those are precisely the ones a customer would never think to
23
- * look for.
24
- */
25
- /** The Postgres object class, which decides how the audit looks it up. */
26
- export type FootprintKind = 'publication' | 'slot' | 'role' | 'table' | 'type';
27
- export interface FootprintArtifact {
28
- readonly kind: FootprintKind;
29
- readonly name: string;
30
- /** What it is for, in the words a customer reading an audit would want. */
31
- readonly purpose: string;
32
- /**
33
- * Installed only for a data source that reports through the signed endpoint
34
- * rather than the write-ahead log.
35
- */
36
- readonly endpointOnly?: boolean;
37
- /**
38
- * No longer installed by any current version. A database that once ran an
39
- * older Ablo still holds it; the audit reports it so it can be cleaned up.
40
- */
41
- readonly retired?: boolean;
42
- /**
43
- * What it costs to leave behind, when leaving it behind costs something. The
44
- * audit leads with this, because "you still have an object named X" is not a
45
- * reason to act and "this one is retaining your write-ahead log" is.
46
- */
47
- readonly hazard?: string;
48
- }
49
- /**
50
- * The publication Ablo's replication reads from. Constant by design: a
51
- * publication declares what streams, and several readers are meant to share one
52
- * (`publication_names` is a per-stream option, not slot state).
53
- */
54
- export declare const ABLO_PUBLICATION = "ablo_publication";
55
- /**
56
- * The replication slot that holds Ablo's position in the write-ahead log.
57
- *
58
- * Constant, and it should not be — a slot stores ONE position, so two
59
- * connections sharing this name compete for the same marker. It is why a
60
- * database can be connected to one plane at a time. ADR 0020 derives it per
61
- * connection; {@link isValidReplicationSlotName} is the check a derived name
62
- * has to pass.
63
- */
64
- export declare const ABLO_REPLICATION_SLOT = "ablo_slot";
65
- /** The least-privilege login Ablo reads with. Per-connection under ADR 0020. */
66
- export declare const ABLO_REPLICATION_ROLE = "ablo_replicator";
67
- /** The separate least-privilege login used only for row writes. */
68
- export declare const ABLO_WRITE_ROLE = "ablo_writer";
69
- /** The bookkeeping table that makes a retried write land once. */
70
- export declare const ABLO_IDEMPOTENCY_TABLE = "ablo_idempotency";
71
- /** The transactional outbox an endpoint source reports through. */
72
- export declare const ABLO_OUTBOX_TABLE = "ablo_outbox";
73
- /**
74
- * Postgres will not accept a replication slot name outside this shape — the
75
- * check is in `ReplicationSlotValidateNameInternal`, and identifier quoting does
76
- * not exempt a name from it. Anything derived into a slot name is validated
77
- * here, at the point it is derived, rather than failing at the point it is used.
78
- */
79
- export declare const REPLICATION_SLOT_NAME: RegExp;
80
- export declare function isValidReplicationSlotName(name: string): boolean;
81
- /** The four plane axes a connection is identified by. */
82
- export interface FootprintPlane {
83
- readonly organizationId: string;
84
- readonly environment: string;
85
- /** '' for the organization-default project. */
86
- readonly projectId?: string;
87
- /** '' for the default sandbox. */
88
- readonly sandboxId?: string;
89
- }
90
- /** The names one connection owns. Nothing here is shared with another plane. */
91
- export interface FootprintNames {
92
- readonly slot: string;
93
- readonly publication: string;
94
- readonly replicationRole: string;
95
- readonly writeRole: string;
96
- }
97
- /**
98
- * The objects this connection owns, named so no other connection can claim them.
99
- *
100
- * A slot stores ONE position, so two connections sharing a name compete for the
101
- * same marker and Postgres reports nothing — which is why the constants these
102
- * replace made a database connectable to one plane at a time. The publication
103
- * and roles are derived from the same digest so a database's footprint reads as
104
- * one set per connection rather than a mix of shared and private objects.
105
- *
106
- * Stable: the same plane always derives the same names, so re-running setup is a
107
- * no-op rather than a second installation.
108
- */
109
- export declare function footprintNamesFor(plane: FootprintPlane): FootprintNames;
110
- /** Everything Ablo has ever put in a customer's database, current and retired. */
111
- export declare const ABLO_FOOTPRINT: readonly FootprintArtifact[];
Binary file
@@ -1,20 +0,0 @@
1
- /**
2
- * The Ablo settlement core (ADR 0013).
3
- *
4
- * The transaction layer that the reactive client is a consumer of, not the
5
- * other way round. The root barrel is deliberate: it exports the seam —
6
- * {@link TransactionLayer} — plus exactly the vocabulary its signatures
7
- * reference and the error hierarchy callers catch. Everything else stays on
8
- * subpaths; every addition here is a decision
9
- * (docs/plans/transaction-layer-barrel-design.md).
10
- */
11
- export type { TransactionLayer, ListQuery, CommitReceipt } from './transactionLayer.js';
12
- export { Ablo } from './ablo.js';
13
- export type { AbloHttpClient, AbloHttpClientOptions, HttpModelClient, } from './transport/httpClient.js';
14
- export type { Delta, HeldClaim, HeldLease, ClaimTarget, ClaimLeaseOptions, } from './types/streams.js';
15
- export type { ModelData } from './types/modelData.js';
16
- export { LogPosition, logPositionSchema, parseLogPosition } from './logPosition.js';
17
- export type { LogPositionSnapshot } from './logPosition.js';
18
- export { AbloError, AbloAuthenticationError, AbloPermissionError, AbloRateLimitError, AbloIdempotencyError, AbloConnectionError, AbloValidationError, AbloNotFoundError, AbloServerError, AbloStaleContextError, AbloContentionError, AbloClaimedError, AbloSessionError, toAbloError, } from './errors.js';
19
- export * from './errorCodes.js';
20
- export * from './environment.js';
@@ -1,20 +0,0 @@
1
- /**
2
- * The Ablo settlement core (ADR 0013).
3
- *
4
- * The transaction layer that the reactive client is a consumer of, not the
5
- * other way round. The root barrel is deliberate: it exports the seam —
6
- * {@link TransactionLayer} — plus exactly the vocabulary its signatures
7
- * reference and the error hierarchy callers catch. Everything else stays on
8
- * subpaths; every addition here is a decision
9
- * (docs/plans/transaction-layer-barrel-design.md).
10
- */
11
- // The client entry point (ADR 0016). The bare import constructs the
12
- // coordination layer over request/response transport; the reactive
13
- // materialiser is the consumer package's entry point, layered above it.
14
- export { Ablo } from './ablo.js';
15
- export { LogPosition, logPositionSchema, parseLogPosition } from './logPosition.js';
16
- // The error hierarchy callers catch.
17
- export { AbloError, AbloAuthenticationError, AbloPermissionError, AbloRateLimitError, AbloIdempotencyError, AbloConnectionError, AbloValidationError, AbloNotFoundError, AbloServerError, AbloStaleContextError, AbloContentionError, AbloClaimedError, AbloSessionError, toAbloError, } from './errors.js';
18
- // Pre-seam leaf surfaces, kept for compatibility with the first extraction.
19
- export * from './errorCodes.js';
20
- export * from './environment.js';
@@ -1,87 +0,0 @@
1
- /**
2
- * The Ablo API-key format: how keys are minted, hashed, and validated, in one
3
- * place so every component that issues or checks a key agrees on the format.
4
- *
5
- * This module uses `node:crypto` and is therefore Node-only. It is published on
6
- * the `@abloatai/ablo/keys` subpath and kept off the main browser-facing entry
7
- * so a browser bundle never pulls in `node:crypto`.
8
- *
9
- * A key looks like `<sk|rk|ek|pk>_<live|test>_<30 base62 chars><6-char base62
10
- * CRC32 checksum>`. The middle segment is the stable environment prefix, mapped
11
- * on parse to `production` or `sandbox`. The recognizable prefix lets secret
12
- * scanners spot a leaked key, and the trailing checksum lets the format reject a
13
- * mistyped or forged key locally, without a database round-trip. Older keys
14
- * (roughly a 43-character base64url body with no checksum) still validate by hash
15
- * and parse here with `checksummed: false`.
16
- */
17
- import { z } from 'zod';
18
- import { type KeyEnvironment } from '../environment.js';
19
- export declare const API_KEY_KINDS: readonly ["secret", "restricted", "ephemeral", "publishable"];
20
- export type ApiKeyKind = (typeof API_KEY_KINDS)[number];
21
- export declare const API_KEY_ENVS: readonly ["production", "sandbox"];
22
- export type ApiKeyEnv = KeyEnvironment;
23
- /** A structurally-valid Ablo API key, parsed into its parts. */
24
- export interface ParsedApiKey {
25
- /** The original plaintext. */
26
- raw: string;
27
- kind: ApiKeyKind;
28
- env: ApiKeyEnv;
29
- /** The chars after `<prefix>_<env>_` (body + checksum for new keys). */
30
- body: string;
31
- /** True when this is the new checksummed format (36-char base62 body). */
32
- checksummed: boolean;
33
- }
34
- /**
35
- * The Zod schema for an Ablo API key. `parse` and `safeParse` return a typed
36
- * {@link ParsedApiKey}. A checksummed-format key whose checksum does not match is
37
- * rejected without any network call; an older key with no checksum parses with
38
- * `checksummed: false` and is left for the server to validate by hash.
39
- */
40
- export declare const apiKeySchema: z.ZodPipe<z.ZodString, z.ZodTransform<ParsedApiKey, string>>;
41
- /** Parse + fully validate (incl. checksum). Returns null when invalid. */
42
- export declare function parseApiKey(raw: string): ParsedApiKey | null;
43
- /**
44
- * Read the environment off a STORED display prefix (`keyPrefix`, the first 12
45
- * chars — `rk_test_abcd`), rather than off a full plaintext key.
46
- *
47
- * A key row records its environment nowhere but its prefix, so this is how a
48
- * server-side flow that only has the row — rotation, most importantly — recovers
49
- * the credential's own mode. Returns null when the prefix is not a recognizable
50
- * key spelling, so callers can fail closed rather than fall back to a default.
51
- */
52
- export declare function environmentFromStoredKeyPrefix(prefix: string): KeyEnvironment | null;
53
- /** True when the key uses the new checksummed format (regardless of validity). */
54
- export declare function isChecksummedKey(raw: string): boolean;
55
- /** Verify the embedded checksum. Meaningful only for checksummed-format keys. */
56
- export declare function keyChecksumMatches(raw: string): boolean;
57
- /**
58
- * Mint a key: `<prefix>_<env>_<body><checksum>`. Returns the plaintext (shown
59
- * once), its SHA-256 hash (persisted), and the 12-char display prefix.
60
- */
61
- export declare function generateApiKey(env?: ApiKeyEnv, kind?: ApiKeyKind): {
62
- plaintext: string;
63
- hash: string;
64
- prefix: string;
65
- };
66
- /**
67
- * The stable SHA-256 hex digest of a plaintext key, computed both when a key is
68
- * minted and when one is looked up. A fast hash is the right choice here rather
69
- * than a password hash like bcrypt: API keys are long random strings, so there is
70
- * no dictionary of guesses to slow down.
71
- */
72
- export declare function hashApiKey(plaintext: string): string;
73
- /** `whsec_` label prefix per the Standard Webhooks spec (not part of the key material). */
74
- export declare const WEBHOOK_SECRET_PREFIX = "whsec_";
75
- /**
76
- * Mints a webhook signing secret following the Standard Webhooks specification
77
- * (https://www.standardwebhooks.com): a base64-encoded random key of 24–64 bytes,
78
- * labelled with the `whsec_` prefix. This uses 32 bytes (256 bits), comfortably
79
- * inside that range. Unlike an API key, a signing secret is not hashed at rest,
80
- * because signing a request with {@link signAbloSourceRequest} needs the live
81
- * value. It is therefore kept in a secret store, returned to the customer once at
82
- * creation, and never shown again.
83
- */
84
- export declare function generateWebhookSecret(): {
85
- plaintext: string;
86
- last4: string;
87
- };
@@ -1,207 +0,0 @@
1
- /**
2
- * The Ablo API-key format: how keys are minted, hashed, and validated, in one
3
- * place so every component that issues or checks a key agrees on the format.
4
- *
5
- * This module uses `node:crypto` and is therefore Node-only. It is published on
6
- * the `@abloatai/ablo/keys` subpath and kept off the main browser-facing entry
7
- * so a browser bundle never pulls in `node:crypto`.
8
- *
9
- * A key looks like `<sk|rk|ek|pk>_<live|test>_<30 base62 chars><6-char base62
10
- * CRC32 checksum>`. The middle segment is the stable environment prefix, mapped
11
- * on parse to `production` or `sandbox`. The recognizable prefix lets secret
12
- * scanners spot a leaked key, and the trailing checksum lets the format reject a
13
- * mistyped or forged key locally, without a database round-trip. Older keys
14
- * (roughly a 43-character base64url body with no checksum) still validate by hash
15
- * and parse here with `checksummed: false`.
16
- */
17
- import { createHash, randomBytes } from 'node:crypto';
18
- import { z } from 'zod';
19
- import { KEY_ENVIRONMENTS, KEY_PREFIX_ENVIRONMENTS, environmentFromKeyPrefix, environmentToKeyPrefix, } from '../environment.js';
20
- // ── Vocabulary ──────────────────────────────────────────────────────────
21
- // The four key kinds:
22
- // secret (sk_) — backend and server-to-server use, including agents. Full
23
- // authority; never expose one in a browser.
24
- // restricted (rk_) — a scoped server key, such as an agent session token or a
25
- // narrowed capability.
26
- // ephemeral (ek_) — a short-lived, backend-minted session credential scoped to
27
- // one user, safe to hand to that user's browser. Carries
28
- // `participantKind: 'user'` and its baked-in sync groups.
29
- // publishable (pk_) — a long-lived, browser-safe, organization-scoped read-only
30
- // key. It is used directly as the bearer token — never
31
- // exchanged, never expires, nothing to refresh. It grants
32
- // read access to the organization's data and cannot write or
33
- // reach any control-plane operation.
34
- export const API_KEY_KINDS = ['secret', 'restricted', 'ephemeral', 'publishable'];
35
- // A key's environment is the CREDENTIAL axis, not the plane axis: the format
36
- // below spells it as one of two prefixes, so a plane name outside those two has
37
- // no representation here and must not reach `generateApiKey`.
38
- export const API_KEY_ENVS = KEY_ENVIRONMENTS;
39
- const PREFIX_BY_KIND = {
40
- secret: 'sk',
41
- restricted: 'rk',
42
- ephemeral: 'ek',
43
- publishable: 'pk',
44
- };
45
- const KIND_BY_PREFIX = {
46
- sk: 'secret',
47
- rk: 'restricted',
48
- ek: 'ephemeral',
49
- pk: 'publishable',
50
- };
51
- const BASE62 = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
52
- /** Random base62 chars before the checksum. */
53
- const KEY_BODY_LEN = 30;
54
- /** base62(CRC32): 62^6 (~5.7e10) > 2^32, so a CRC32 always fits in 6 chars. */
55
- const CHECKSUM_LEN = 6;
56
- /** A new checksummed body is exactly this long and pure base62. */
57
- const CHECKSUMMED_BODY_LEN = KEY_BODY_LEN + CHECKSUM_LEN;
58
- /** `<sk|rk|ek|pk>_<live|test>_<body>`; the body charset covers base62 as well as the legacy base64url form. */
59
- const KEY_RE = /^(sk|rk|ek|pk)_(live|test)_([0-9A-Za-z\-_]+)$/;
60
- const BASE62_RE = /^[0-9A-Za-z]+$/;
61
- // ── Checksum (standard CRC-32, GitHub-compatible) ───────────────────────
62
- const CRC32_TABLE = (() => {
63
- const t = new Uint32Array(256);
64
- for (let n = 0; n < 256; n++) {
65
- let c = n;
66
- for (let k = 0; k < 8; k++)
67
- c = c & 1 ? 0xedb88320 ^ (c >>> 1) : c >>> 1;
68
- t[n] = c >>> 0;
69
- }
70
- return t;
71
- })();
72
- function crc32(s) {
73
- let c = 0xffffffff;
74
- for (let i = 0; i < s.length; i++) {
75
- // `& 0xff` bounds the index to the 256-entry table — the ?? 0 is unreachable.
76
- c = ((CRC32_TABLE[(c ^ s.charCodeAt(i)) & 0xff] ?? 0) ^ (c >>> 8)) >>> 0;
77
- }
78
- return (c ^ 0xffffffff) >>> 0;
79
- }
80
- /** 6-char base62 encoding of the CRC32 of `payload`. */
81
- function checksum6(payload) {
82
- let n = crc32(payload);
83
- let out = '';
84
- for (let i = 0; i < CHECKSUM_LEN; i++) {
85
- out = BASE62.charAt(n % 62) + out;
86
- n = Math.floor(n / 62);
87
- }
88
- return out;
89
- }
90
- /** `len` cryptographically-random base62 chars (rejection-sampled, no bias). */
91
- function randomBase62(len) {
92
- let out = '';
93
- while (out.length < len) {
94
- for (const b of randomBytes(len * 2)) {
95
- if (b < 248) {
96
- out += BASE62.charAt(b % 62);
97
- if (out.length === len)
98
- break;
99
- }
100
- }
101
- }
102
- return out;
103
- }
104
- function bodyIsChecksummed(body) {
105
- return body.length === CHECKSUMMED_BODY_LEN && BASE62_RE.test(body);
106
- }
107
- /**
108
- * The Zod schema for an Ablo API key. `parse` and `safeParse` return a typed
109
- * {@link ParsedApiKey}. A checksummed-format key whose checksum does not match is
110
- * rejected without any network call; an older key with no checksum parses with
111
- * `checksummed: false` and is left for the server to validate by hash.
112
- */
113
- export const apiKeySchema = z.string().transform((raw, ctx) => {
114
- const m = KEY_RE.exec(raw);
115
- if (!m) {
116
- ctx.addIssue({ code: 'custom', message: 'not a valid Ablo API key format' });
117
- return z.NEVER;
118
- }
119
- const [, prefix, env, body] = m;
120
- const kind = prefix === undefined ? undefined : KIND_BY_PREFIX[prefix];
121
- // Unreachable on a KEY_RE match (all three groups are non-optional and the
122
- // prefix alternation is exactly the KIND_BY_PREFIX key set) — narrows the
123
- // regex-group lookups for the checks below.
124
- if (kind === undefined || env === undefined || body === undefined) {
125
- ctx.addIssue({ code: 'custom', message: 'not a valid Ablo API key format' });
126
- return z.NEVER;
127
- }
128
- const checksummed = bodyIsChecksummed(body);
129
- if (checksummed && checksum6(raw.slice(0, -CHECKSUM_LEN)) !== body.slice(KEY_BODY_LEN)) {
130
- ctx.addIssue({ code: 'custom', message: 'API key checksum mismatch' });
131
- return z.NEVER;
132
- }
133
- return {
134
- raw,
135
- kind,
136
- env: environmentFromKeyPrefix(env),
137
- body,
138
- checksummed,
139
- };
140
- });
141
- // ── Derived validators (thin wrappers over the same spec) ───────────────
142
- /** Parse + fully validate (incl. checksum). Returns null when invalid. */
143
- export function parseApiKey(raw) {
144
- const r = apiKeySchema.safeParse(raw);
145
- return r.success ? r.data : null;
146
- }
147
- /**
148
- * Read the environment off a STORED display prefix (`keyPrefix`, the first 12
149
- * chars — `rk_test_abcd`), rather than off a full plaintext key.
150
- *
151
- * A key row records its environment nowhere but its prefix, so this is how a
152
- * server-side flow that only has the row — rotation, most importantly — recovers
153
- * the credential's own mode. Returns null when the prefix is not a recognizable
154
- * key spelling, so callers can fail closed rather than fall back to a default.
155
- */
156
- export function environmentFromStoredKeyPrefix(prefix) {
157
- const spelling = /^(?:sk|rk|ek|pk)_([a-z]+)_/.exec(prefix)?.[1];
158
- const env = KEY_PREFIX_ENVIRONMENTS.find((candidate) => candidate === spelling);
159
- return env === undefined ? null : environmentFromKeyPrefix(env);
160
- }
161
- /** True when the key uses the new checksummed format (regardless of validity). */
162
- export function isChecksummedKey(raw) {
163
- const body = KEY_RE.exec(raw)?.[3];
164
- return body !== undefined && bodyIsChecksummed(body);
165
- }
166
- /** Verify the embedded checksum. Meaningful only for checksummed-format keys. */
167
- export function keyChecksumMatches(raw) {
168
- const body = KEY_RE.exec(raw)?.[3];
169
- if (body === undefined || !bodyIsChecksummed(body))
170
- return false;
171
- return checksum6(raw.slice(0, -CHECKSUM_LEN)) === body.slice(KEY_BODY_LEN);
172
- }
173
- // ── Mint + hash (node:crypto) ───────────────────────────────────────────
174
- /**
175
- * Mint a key: `<prefix>_<env>_<body><checksum>`. Returns the plaintext (shown
176
- * once), its SHA-256 hash (persisted), and the 12-char display prefix.
177
- */
178
- export function generateApiKey(env = 'production', kind = 'secret') {
179
- const body = randomBase62(KEY_BODY_LEN);
180
- const payload = `${PREFIX_BY_KIND[kind]}_${environmentToKeyPrefix(env)}_${body}`;
181
- const plaintext = `${payload}${checksum6(payload)}`;
182
- return { plaintext, hash: hashApiKey(plaintext), prefix: plaintext.slice(0, 12) };
183
- }
184
- /**
185
- * The stable SHA-256 hex digest of a plaintext key, computed both when a key is
186
- * minted and when one is looked up. A fast hash is the right choice here rather
187
- * than a password hash like bcrypt: API keys are long random strings, so there is
188
- * no dictionary of guesses to slow down.
189
- */
190
- export function hashApiKey(plaintext) {
191
- return createHash('sha256').update(plaintext).digest('hex');
192
- }
193
- /** `whsec_` label prefix per the Standard Webhooks spec (not part of the key material). */
194
- export const WEBHOOK_SECRET_PREFIX = 'whsec_';
195
- /**
196
- * Mints a webhook signing secret following the Standard Webhooks specification
197
- * (https://www.standardwebhooks.com): a base64-encoded random key of 24–64 bytes,
198
- * labelled with the `whsec_` prefix. This uses 32 bytes (256 bits), comfortably
199
- * inside that range. Unlike an API key, a signing secret is not hashed at rest,
200
- * because signing a request with {@link signAbloSourceRequest} needs the live
201
- * value. It is therefore kept in a secret store, returned to the customer once at
202
- * creation, and never shown again.
203
- */
204
- export function generateWebhookSecret() {
205
- const plaintext = `${WEBHOOK_SECRET_PREFIX}${randomBytes(32).toString('base64')}`;
206
- return { plaintext, last4: plaintext.slice(-4) };
207
- }
@@ -1,158 +0,0 @@
1
- /**
2
- * Zod schemas that describe the `sync_deltas` storage row — the durable record of
3
- * one committed change. The row is split into two slices by the concern each one
4
- * serves:
5
- *
6
- * - {@link syncDeltaCoreSchema} — the sync-protocol slice: everything a client
7
- * needs to reconstruct the change, plus the tenant key. This is a portable
8
- * payload shape; it is not a statement that the row is physically stored in
9
- * the customer's database.
10
- * - {@link deltaAttributionSchema} — who made the change, and on whose authority.
11
- *
12
- * {@link syncDeltaRowSchema} composes both into the full stored row.
13
- * {@link DELTA_DATA_CLASSIFICATION} states which slices contain customer data,
14
- * while {@link DELTA_PHYSICAL_STORAGE} states where the runtime persists them.
15
- * Keeping those axes separate prevents a portable schema slice from being cited
16
- * incorrectly as a physical-residency guarantee.
17
- *
18
- * This is the stored shape. The delta broadcast to clients is a narrower projection
19
- * of it — see {@link import('../wire/delta.js').syncDeltaWireCoreSchema} — and
20
- * the field names here mirror those on that wire delta.
21
- */
22
- import { z } from 'zod';
23
- export { participantKindSchema, confirmationStateSchema } from '../wire/delta.js';
24
- export type { ParticipantKind, ConfirmationState } from '../wire/delta.js';
25
- /** `backfill_provenance` */
26
- export declare const backfillProvenanceSchema: z.ZodEnum<{
27
- unknown: "unknown";
28
- exact: "exact";
29
- inferred: "inferred";
30
- }>;
31
- export type BackfillProvenance = z.infer<typeof backfillProvenanceSchema>;
32
- /**
33
- * Everything a client needs to materialize the change, plus the tenant key. This
34
- * is the portable shape an authoritative WAL change or endpoint event carries.
35
- * The runtime persists the resulting full row in Ablo's tenant-scoped ordered
36
- * sync log; it is not written atomically with a direct application-row mutation.
37
- * `id`, `createdAt`, and `syncGroups` are assigned when the source change is
38
- * appended, so they are optional at the ingestion boundary.
39
- */
40
- export declare const syncDeltaCoreSchema: z.ZodObject<{
41
- id: z.ZodOptional<z.ZodUnion<readonly [z.ZodBigInt, z.ZodNumber]>>;
42
- actionType: z.ZodEnum<{
43
- I: "I";
44
- U: "U";
45
- D: "D";
46
- A: "A";
47
- V: "V";
48
- C: "C";
49
- G: "G";
50
- S: "S";
51
- }>;
52
- modelName: z.ZodString;
53
- modelId: z.ZodString;
54
- data: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
55
- previousData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
56
- syncGroups: z.ZodOptional<z.ZodArray<z.ZodString>>;
57
- organizationId: z.ZodNullable<z.ZodString>;
58
- createdAt: z.ZodOptional<z.ZodString>;
59
- transactionId: z.ZodNullable<z.ZodString>;
60
- sourceChangeId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
61
- }, z.core.$strip>;
62
- export type SyncDeltaCore = z.infer<typeof syncDeltaCoreSchema>;
63
- export declare const deltaAttributionSchema: z.ZodObject<{
64
- createdBy: z.ZodNullable<z.ZodString>;
65
- actorId: z.ZodNullable<z.ZodString>;
66
- actorKind: z.ZodNullable<z.ZodEnum<{
67
- user: "user";
68
- agent: "agent";
69
- system: "system";
70
- }>>;
71
- onBehalfOfId: z.ZodNullable<z.ZodString>;
72
- onBehalfOfKind: z.ZodNullable<z.ZodEnum<{
73
- user: "user";
74
- agent: "agent";
75
- system: "system";
76
- }>>;
77
- capabilityId: z.ZodNullable<z.ZodString>;
78
- delegationChainRootUserId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
79
- confirmationState: z.ZodNullable<z.ZodEnum<{
80
- auto: "auto";
81
- previewed: "previewed";
82
- approved: "approved";
83
- required_human_approval: "required_human_approval";
84
- auto_historical: "auto_historical";
85
- }>>;
86
- backfillProvenance: z.ZodNullable<z.ZodEnum<{
87
- unknown: "unknown";
88
- exact: "exact";
89
- inferred: "inferred";
90
- }>>;
91
- }, z.core.$strip>;
92
- export type DeltaAttribution = z.infer<typeof deltaAttributionSchema>;
93
- /** The complete `sync_deltas` row: core and attribution combined. */
94
- export declare const syncDeltaRowSchema: z.ZodObject<{
95
- id: z.ZodOptional<z.ZodUnion<readonly [z.ZodBigInt, z.ZodNumber]>>;
96
- actionType: z.ZodEnum<{
97
- I: "I";
98
- U: "U";
99
- D: "D";
100
- A: "A";
101
- V: "V";
102
- C: "C";
103
- G: "G";
104
- S: "S";
105
- }>;
106
- modelName: z.ZodString;
107
- modelId: z.ZodString;
108
- data: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
109
- previousData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
110
- syncGroups: z.ZodOptional<z.ZodArray<z.ZodString>>;
111
- organizationId: z.ZodNullable<z.ZodString>;
112
- createdAt: z.ZodOptional<z.ZodString>;
113
- transactionId: z.ZodNullable<z.ZodString>;
114
- sourceChangeId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
115
- createdBy: z.ZodNullable<z.ZodString>;
116
- actorId: z.ZodNullable<z.ZodString>;
117
- actorKind: z.ZodNullable<z.ZodEnum<{
118
- user: "user";
119
- agent: "agent";
120
- system: "system";
121
- }>>;
122
- onBehalfOfId: z.ZodNullable<z.ZodString>;
123
- onBehalfOfKind: z.ZodNullable<z.ZodEnum<{
124
- user: "user";
125
- agent: "agent";
126
- system: "system";
127
- }>>;
128
- capabilityId: z.ZodNullable<z.ZodString>;
129
- delegationChainRootUserId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
130
- confirmationState: z.ZodNullable<z.ZodEnum<{
131
- auto: "auto";
132
- previewed: "previewed";
133
- approved: "approved";
134
- required_human_approval: "required_human_approval";
135
- auto_historical: "auto_historical";
136
- }>>;
137
- backfillProvenance: z.ZodNullable<z.ZodEnum<{
138
- unknown: "unknown";
139
- exact: "exact";
140
- inferred: "inferred";
141
- }>>;
142
- }, z.core.$strip>;
143
- export type SyncDeltaRow = z.infer<typeof syncDeltaRowSchema>;
144
- /** Which slices contain retained customer row data versus control metadata. */
145
- export declare const DELTA_DATA_CLASSIFICATION: {
146
- readonly core: "customer-data";
147
- readonly attribution: "control-metadata";
148
- };
149
- /**
150
- * Where the current runtime physically persists each slice. Both live in
151
- * Ablo's tenant-scoped `sync_deltas` log. `core` contains full post-change row
152
- * payloads (and optional previous payloads), so `control` here must not be read
153
- * as "metadata only."
154
- */
155
- export declare const DELTA_PHYSICAL_STORAGE: {
156
- readonly core: "control";
157
- readonly attribution: "control";
158
- };