@abloatai/ablo 0.36.0 → 0.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (597) hide show
  1. package/AGENTS.md +2 -2
  2. package/CHANGELOG.md +71 -2013
  3. package/NOTICE +2 -2
  4. package/README.md +25 -71
  5. package/assets/banner.png +0 -0
  6. package/dist/auth.d.ts +2 -0
  7. package/dist/auth.d.ts.map +1 -0
  8. package/dist/auth.js +2 -0
  9. package/dist/auth.js.map +1 -0
  10. package/dist/client.d.ts +3 -0
  11. package/dist/client.d.ts.map +1 -0
  12. package/dist/client.js +3 -0
  13. package/dist/client.js.map +1 -0
  14. package/dist/coordination.d.ts +2 -0
  15. package/dist/coordination.d.ts.map +1 -0
  16. package/dist/coordination.js +2 -0
  17. package/dist/coordination.js.map +1 -0
  18. package/dist/index.d.ts +3 -114
  19. package/dist/index.d.ts.map +1 -0
  20. package/dist/index.js +3 -163
  21. package/dist/index.js.map +1 -0
  22. package/dist/react.d.ts +4 -0
  23. package/dist/react.d.ts.map +1 -0
  24. package/dist/react.js +3 -0
  25. package/dist/react.js.map +1 -0
  26. package/dist/schema.d.ts +2 -0
  27. package/dist/schema.d.ts.map +1 -0
  28. package/dist/schema.js +2 -0
  29. package/dist/schema.js.map +1 -0
  30. package/dist/server.d.ts +2 -0
  31. package/dist/server.d.ts.map +1 -0
  32. package/dist/server.js +2 -0
  33. package/dist/server.js.map +1 -0
  34. package/dist/source-conformance.d.ts +2 -0
  35. package/dist/source-conformance.d.ts.map +1 -0
  36. package/dist/source-conformance.js +2 -0
  37. package/dist/source-conformance.js.map +1 -0
  38. package/dist/source-drizzle.d.ts +2 -0
  39. package/dist/source-drizzle.d.ts.map +1 -0
  40. package/dist/source-drizzle.js +2 -0
  41. package/dist/source-drizzle.js.map +1 -0
  42. package/dist/source-kysely.d.ts +2 -0
  43. package/dist/source-kysely.d.ts.map +1 -0
  44. package/dist/source-kysely.js +2 -0
  45. package/dist/source-kysely.js.map +1 -0
  46. package/dist/source-next.d.ts +2 -0
  47. package/dist/source-next.d.ts.map +1 -0
  48. package/dist/source-next.js +2 -0
  49. package/dist/source-next.js.map +1 -0
  50. package/dist/source.d.ts +2 -0
  51. package/dist/source.d.ts.map +1 -0
  52. package/dist/source.js +2 -0
  53. package/dist/source.js.map +1 -0
  54. package/dist/wire.d.ts +2 -0
  55. package/dist/wire.d.ts.map +1 -0
  56. package/dist/wire.js +2 -0
  57. package/dist/wire.js.map +1 -0
  58. package/docs/agents.md +1 -1
  59. package/docs/api-keys.md +7 -6
  60. package/docs/api.md +10 -10
  61. package/docs/client-behavior.md +5 -5
  62. package/docs/coordination.md +52 -62
  63. package/docs/data-sources.md +1 -1
  64. package/docs/examples/agent-human.md +4 -4
  65. package/docs/examples/ai-sdk-tool.md +1 -1
  66. package/docs/examples/existing-python-backend.md +15 -4
  67. package/docs/examples/nextjs.md +27 -6
  68. package/docs/examples/server-agent.md +2 -2
  69. package/docs/how-it-works.md +4 -4
  70. package/docs/identity.md +2 -1
  71. package/docs/integration-guide.md +24 -13
  72. package/docs/internal/README.md +18 -0
  73. package/docs/internal/agent-fleet-coordination-design.md +171 -0
  74. package/docs/internal/agent-orchestration.md +58 -0
  75. package/docs/internal/commit-identifiers.md +91 -0
  76. package/docs/internal/concurrency-open-decisions.md +37 -0
  77. package/docs/internal/data-source-reverse-channel.md +150 -0
  78. package/docs/internal/per-field-conflict-detection.md +165 -0
  79. package/docs/internal/postgres-replication.md +64 -0
  80. package/docs/internal/serializable-schema.md +119 -0
  81. package/docs/internal/structure.md +32 -0
  82. package/docs/mcp.md +2 -2
  83. package/docs/migration.md +3 -3
  84. package/docs/quickstart.md +2 -2
  85. package/docs/react.md +5 -5
  86. package/docs/schema-contract.md +3 -3
  87. package/docs/sessions.md +91 -37
  88. package/examples/README.md +2 -2
  89. package/examples/data-source/README.md +1 -1
  90. package/examples/data-source/ablo-driver.ts +1 -1
  91. package/examples/data-source/customer-server.ts +1 -1
  92. package/examples/data-source/run.ts +1 -1
  93. package/examples/data-source/schema.ts +1 -1
  94. package/examples/quickstart.ts +2 -2
  95. package/llms.txt +8 -8
  96. package/package.json +63 -166
  97. package/bin/ablo.cjs +0 -39
  98. package/dist/BaseSyncedStore.d.ts +0 -843
  99. package/dist/BaseSyncedStore.js +0 -1971
  100. package/dist/Database.d.ts +0 -323
  101. package/dist/Database.js +0 -1502
  102. package/dist/InstanceCache.d.ts +0 -237
  103. package/dist/InstanceCache.js +0 -1166
  104. package/dist/LazyReferenceCollection.d.ts +0 -177
  105. package/dist/LazyReferenceCollection.js +0 -461
  106. package/dist/Model.d.ts +0 -454
  107. package/dist/Model.js +0 -919
  108. package/dist/ModelRegistry.d.ts +0 -225
  109. package/dist/ModelRegistry.js +0 -539
  110. package/dist/NetworkMonitor.d.ts +0 -28
  111. package/dist/NetworkMonitor.js +0 -79
  112. package/dist/RuntimeContext.d.ts +0 -52
  113. package/dist/RuntimeContext.js +0 -80
  114. package/dist/SyncClient.d.ts +0 -541
  115. package/dist/SyncClient.js +0 -2202
  116. package/dist/adapters/alwaysOnline.d.ts +0 -14
  117. package/dist/adapters/alwaysOnline.js +0 -17
  118. package/dist/adapters/inMemoryStorage.d.ts +0 -31
  119. package/dist/adapters/inMemoryStorage.js +0 -110
  120. package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
  121. package/dist/ai-sdk/coordinatedTool.js +0 -134
  122. package/dist/ai-sdk/coordinationContext.d.ts +0 -46
  123. package/dist/ai-sdk/coordinationContext.js +0 -106
  124. package/dist/ai-sdk/index.d.ts +0 -121
  125. package/dist/ai-sdk/index.js +0 -121
  126. package/dist/ai-sdk/wrap.d.ts +0 -65
  127. package/dist/ai-sdk/wrap.js +0 -39
  128. package/dist/auth/index.d.ts +0 -1
  129. package/dist/auth/index.js +0 -8
  130. package/dist/batching/index.d.ts +0 -55
  131. package/dist/batching/index.js +0 -147
  132. package/dist/client/Ablo.d.ts +0 -231
  133. package/dist/client/Ablo.js +0 -160
  134. package/dist/client/abloClient.d.ts +0 -309
  135. package/dist/client/abloClient.js +0 -13
  136. package/dist/client/clientPrelude.d.ts +0 -52
  137. package/dist/client/clientPrelude.js +0 -60
  138. package/dist/client/consoleLogger.d.ts +0 -35
  139. package/dist/client/consoleLogger.js +0 -44
  140. package/dist/client/coreClient.d.ts +0 -60
  141. package/dist/client/coreClient.js +0 -118
  142. package/dist/client/createInternalComponents.d.ts +0 -50
  143. package/dist/client/createInternalComponents.js +0 -98
  144. package/dist/client/createModelProxy.d.ts +0 -248
  145. package/dist/client/createModelProxy.js +0 -884
  146. package/dist/client/humans.d.ts +0 -69
  147. package/dist/client/humans.js +0 -78
  148. package/dist/client/modelRegistration.d.ts +0 -10
  149. package/dist/client/modelRegistration.js +0 -312
  150. package/dist/client/options.d.ts +0 -461
  151. package/dist/client/options.js +0 -7
  152. package/dist/client/reactiveEngine.d.ts +0 -53
  153. package/dist/client/reactiveEngine.js +0 -688
  154. package/dist/client/resourceTypes.d.ts +0 -12
  155. package/dist/client/resourceTypes.js +0 -10
  156. package/dist/client/schemaConfig.d.ts +0 -44
  157. package/dist/client/schemaConfig.js +0 -185
  158. package/dist/client/storeCluster.d.ts +0 -47
  159. package/dist/client/storeCluster.js +0 -118
  160. package/dist/client/storeLifecycle.d.ts +0 -61
  161. package/dist/client/storeLifecycle.js +0 -231
  162. package/dist/client/validateAbloOptions.d.ts +0 -42
  163. package/dist/client/validateAbloOptions.js +0 -43
  164. package/dist/client/wsMutationExecutor.d.ts +0 -27
  165. package/dist/client/wsMutationExecutor.js +0 -72
  166. package/dist/context.d.ts +0 -42
  167. package/dist/context.js +0 -81
  168. package/dist/coordination/ClaimLog.d.ts +0 -26
  169. package/dist/coordination/ClaimLog.js +0 -32
  170. package/dist/coordination/index.d.ts +0 -1
  171. package/dist/coordination/index.js +0 -8
  172. package/dist/core/index.d.ts +0 -33
  173. package/dist/core/index.js +0 -48
  174. package/dist/docs/catalog.d.ts +0 -72
  175. package/dist/docs/catalog.js +0 -230
  176. package/dist/docs/index.d.ts +0 -10
  177. package/dist/docs/index.js +0 -10
  178. package/dist/environment.d.ts +0 -1
  179. package/dist/environment.js +0 -8
  180. package/dist/interfaces/index.d.ts +0 -311
  181. package/dist/interfaces/index.js +0 -9
  182. package/dist/keys/index.d.ts +0 -1
  183. package/dist/keys/index.js +0 -8
  184. package/dist/mutators/RecordingMutation.d.ts +0 -36
  185. package/dist/mutators/RecordingMutation.js +0 -182
  186. package/dist/mutators/Transaction.d.ts +0 -40
  187. package/dist/mutators/Transaction.js +0 -58
  188. package/dist/mutators/UndoManager.d.ts +0 -258
  189. package/dist/mutators/UndoManager.js +0 -658
  190. package/dist/mutators/defineMutators.d.ts +0 -60
  191. package/dist/mutators/defineMutators.js +0 -18
  192. package/dist/mutators/inverseOp.d.ts +0 -126
  193. package/dist/mutators/inverseOp.js +0 -71
  194. package/dist/mutators/mutateActions.d.ts +0 -45
  195. package/dist/mutators/mutateActions.js +0 -105
  196. package/dist/mutators/readerActions.d.ts +0 -33
  197. package/dist/mutators/readerActions.js +0 -57
  198. package/dist/mutators/undoApply.d.ts +0 -51
  199. package/dist/mutators/undoApply.js +0 -117
  200. package/dist/policy/index.d.ts +0 -21
  201. package/dist/policy/index.js +0 -20
  202. package/dist/query/QueryProcessor.d.ts +0 -75
  203. package/dist/query/QueryProcessor.js +0 -255
  204. package/dist/query/client.d.ts +0 -64
  205. package/dist/query/client.js +0 -138
  206. package/dist/query/types.d.ts +0 -85
  207. package/dist/query/types.js +0 -16
  208. package/dist/react/AbloProvider.d.ts +0 -242
  209. package/dist/react/AbloProvider.js +0 -458
  210. package/dist/react/ClientSideSuspense.d.ts +0 -36
  211. package/dist/react/ClientSideSuspense.js +0 -17
  212. package/dist/react/DefaultFallback.d.ts +0 -24
  213. package/dist/react/DefaultFallback.js +0 -43
  214. package/dist/react/context.d.ts +0 -55
  215. package/dist/react/context.js +0 -29
  216. package/dist/react/createAbloReact.d.ts +0 -56
  217. package/dist/react/createAbloReact.js +0 -51
  218. package/dist/react/index.d.ts +0 -62
  219. package/dist/react/index.js +0 -69
  220. package/dist/react/internalContext.d.ts +0 -33
  221. package/dist/react/internalContext.js +0 -3
  222. package/dist/react/useAblo.d.ts +0 -82
  223. package/dist/react/useAblo.js +0 -120
  224. package/dist/react/useCurrentUserId.d.ts +0 -22
  225. package/dist/react/useCurrentUserId.js +0 -34
  226. package/dist/react/useErrorListener.d.ts +0 -20
  227. package/dist/react/useErrorListener.js +0 -38
  228. package/dist/react/useMutationFailureListener.d.ts +0 -26
  229. package/dist/react/useMutationFailureListener.js +0 -38
  230. package/dist/react/useMutators.d.ts +0 -56
  231. package/dist/react/useMutators.js +0 -84
  232. package/dist/react/useReactive.d.ts +0 -35
  233. package/dist/react/useReactive.js +0 -123
  234. package/dist/react/useSyncStatus.d.ts +0 -59
  235. package/dist/react/useSyncStatus.js +0 -76
  236. package/dist/react/useUndoScope.d.ts +0 -34
  237. package/dist/react/useUndoScope.js +0 -81
  238. package/dist/schema/coordination.d.ts +0 -112
  239. package/dist/schema/coordination.js +0 -133
  240. package/dist/schema/ddl.d.ts +0 -97
  241. package/dist/schema/ddl.js +0 -491
  242. package/dist/schema/ddlLock.d.ts +0 -35
  243. package/dist/schema/ddlLock.js +0 -46
  244. package/dist/schema/diff.d.ts +0 -225
  245. package/dist/schema/diff.js +0 -289
  246. package/dist/schema/generate.d.ts +0 -19
  247. package/dist/schema/generate.js +0 -86
  248. package/dist/schema/index.d.ts +0 -42
  249. package/dist/schema/index.js +0 -80
  250. package/dist/schema/queries.d.ts +0 -201
  251. package/dist/schema/queries.js +0 -144
  252. package/dist/schema/select.d.ts +0 -40
  253. package/dist/schema/select.js +0 -90
  254. package/dist/schema/serialize.d.ts +0 -115
  255. package/dist/schema/serialize.js +0 -265
  256. package/dist/schema/sugar.d.ts +0 -109
  257. package/dist/schema/sugar.js +0 -83
  258. package/dist/schema/syncDeltaRow.d.ts +0 -6
  259. package/dist/schema/syncDeltaRow.js +0 -6
  260. package/dist/server/adapter.d.ts +0 -173
  261. package/dist/server/adapter.js +0 -18
  262. package/dist/server/commit.d.ts +0 -107
  263. package/dist/server/commit.js +0 -1
  264. package/dist/server/index.d.ts +0 -14
  265. package/dist/server/index.js +0 -2
  266. package/dist/server/readConfig.d.ts +0 -80
  267. package/dist/server/readConfig.js +0 -8
  268. package/dist/server/storageMode.d.ts +0 -23
  269. package/dist/server/storageMode.js +0 -17
  270. package/dist/source/adapter.d.ts +0 -83
  271. package/dist/source/adapter.js +0 -24
  272. package/dist/source/adapters/drizzle.d.ts +0 -48
  273. package/dist/source/adapters/drizzle.js +0 -219
  274. package/dist/source/adapters/kysely.d.ts +0 -42
  275. package/dist/source/adapters/kysely.js +0 -205
  276. package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
  277. package/dist/source/adapters/kyselyMutationCore.js +0 -125
  278. package/dist/source/adapters/memory.d.ts +0 -13
  279. package/dist/source/adapters/memory.js +0 -130
  280. package/dist/source/adapters/prisma.d.ts +0 -63
  281. package/dist/source/adapters/prisma.js +0 -202
  282. package/dist/source/conformance.d.ts +0 -37
  283. package/dist/source/conformance.js +0 -215
  284. package/dist/source/connector.d.ts +0 -95
  285. package/dist/source/connector.js +0 -266
  286. package/dist/source/connectorProtocol.d.ts +0 -154
  287. package/dist/source/connectorProtocol.js +0 -163
  288. package/dist/source/contract.d.ts +0 -195
  289. package/dist/source/contract.js +0 -164
  290. package/dist/source/factory.d.ts +0 -92
  291. package/dist/source/factory.js +0 -286
  292. package/dist/source/idempotency.d.ts +0 -61
  293. package/dist/source/idempotency.js +0 -144
  294. package/dist/source/index.d.ts +0 -23
  295. package/dist/source/index.js +0 -30
  296. package/dist/source/migrations.d.ts +0 -21
  297. package/dist/source/migrations.js +0 -103
  298. package/dist/source/next.d.ts +0 -32
  299. package/dist/source/next.js +0 -25
  300. package/dist/source/pushQueue.d.ts +0 -134
  301. package/dist/source/pushQueue.js +0 -256
  302. package/dist/source/signing.d.ts +0 -92
  303. package/dist/source/signing.js +0 -162
  304. package/dist/source/types.d.ts +0 -401
  305. package/dist/source/types.js +0 -59
  306. package/dist/storeContract.d.ts +0 -145
  307. package/dist/storeContract.js +0 -12
  308. package/dist/stores/DatabaseManager.d.ts +0 -107
  309. package/dist/stores/DatabaseManager.js +0 -388
  310. package/dist/stores/ObjectStore.d.ts +0 -115
  311. package/dist/stores/ObjectStore.js +0 -393
  312. package/dist/stores/ObjectStoreContract.d.ts +0 -38
  313. package/dist/stores/ObjectStoreContract.js +0 -1
  314. package/dist/stores/StoreManager.d.ts +0 -114
  315. package/dist/stores/StoreManager.js +0 -304
  316. package/dist/stores/SyncActionStore.d.ts +0 -99
  317. package/dist/stores/SyncActionStore.js +0 -506
  318. package/dist/stores/openIDBWithTimeout.d.ts +0 -65
  319. package/dist/stores/openIDBWithTimeout.js +0 -153
  320. package/dist/stores/syncAction.d.ts +0 -26
  321. package/dist/stores/syncAction.js +0 -16
  322. package/dist/surface.d.ts +0 -36
  323. package/dist/surface.js +0 -75
  324. package/dist/sync/BootstrapFetcher.d.ts +0 -284
  325. package/dist/sync/BootstrapFetcher.js +0 -964
  326. package/dist/sync/ConnectionManager.d.ts +0 -8
  327. package/dist/sync/ConnectionManager.js +0 -8
  328. package/dist/sync/OnDemandLoader.d.ts +0 -231
  329. package/dist/sync/OnDemandLoader.js +0 -743
  330. package/dist/sync/SubscriptionManager.d.ts +0 -159
  331. package/dist/sync/SubscriptionManager.js +0 -243
  332. package/dist/sync/SyncWebSocket.d.ts +0 -173
  333. package/dist/sync/SyncWebSocket.js +0 -438
  334. package/dist/sync/awaitClaimGrant.d.ts +0 -6
  335. package/dist/sync/awaitClaimGrant.js +0 -6
  336. package/dist/sync/bootstrapApply.d.ts +0 -73
  337. package/dist/sync/bootstrapApply.js +0 -73
  338. package/dist/sync/commitFrames.d.ts +0 -8
  339. package/dist/sync/commitFrames.js +0 -8
  340. package/dist/sync/contextPorts.d.ts +0 -18
  341. package/dist/sync/contextPorts.js +0 -31
  342. package/dist/sync/createClaimStream.d.ts +0 -7
  343. package/dist/sync/createClaimStream.js +0 -7
  344. package/dist/sync/createPresenceStream.d.ts +0 -69
  345. package/dist/sync/createPresenceStream.js +0 -200
  346. package/dist/sync/createSnapshot.d.ts +0 -29
  347. package/dist/sync/createSnapshot.js +0 -118
  348. package/dist/sync/credentialLifecycle.d.ts +0 -7
  349. package/dist/sync/credentialLifecycle.js +0 -7
  350. package/dist/sync/deltaPipeline.d.ts +0 -114
  351. package/dist/sync/deltaPipeline.js +0 -278
  352. package/dist/sync/groupChange.d.ts +0 -116
  353. package/dist/sync/groupChange.js +0 -244
  354. package/dist/sync/participants.d.ts +0 -132
  355. package/dist/sync/participants.js +0 -346
  356. package/dist/sync/persistedPrefix.d.ts +0 -12
  357. package/dist/sync/persistedPrefix.js +0 -22
  358. package/dist/sync/schemaDrift.d.ts +0 -55
  359. package/dist/sync/schemaDrift.js +0 -53
  360. package/dist/sync/schemas.d.ts +0 -71
  361. package/dist/sync/schemas.js +0 -94
  362. package/dist/sync/syncCursor.d.ts +0 -40
  363. package/dist/sync/syncCursor.js +0 -55
  364. package/dist/sync/syncPlan.d.ts +0 -54
  365. package/dist/sync/syncPlan.js +0 -50
  366. package/dist/sync/wsFrameHandlers.d.ts +0 -8
  367. package/dist/sync/wsFrameHandlers.js +0 -8
  368. package/dist/syncLog/contract.d.ts +0 -20
  369. package/dist/syncLog/contract.js +0 -19
  370. package/dist/syncLog/index.d.ts +0 -1
  371. package/dist/syncLog/index.js +0 -1
  372. package/dist/transaction/ablo.d.ts +0 -88
  373. package/dist/transaction/ablo.js +0 -33
  374. package/dist/transaction/auth/apiKey.d.ts +0 -152
  375. package/dist/transaction/auth/apiKey.js +0 -419
  376. package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
  377. package/dist/transaction/auth/bootstrapScope.js +0 -1
  378. package/dist/transaction/auth/capability.d.ts +0 -212
  379. package/dist/transaction/auth/capability.js +0 -224
  380. package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
  381. package/dist/transaction/auth/credentialEndpoint.js +0 -86
  382. package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
  383. package/dist/transaction/auth/credentialPolicy.js +0 -125
  384. package/dist/transaction/auth/credentialSource.d.ts +0 -30
  385. package/dist/transaction/auth/credentialSource.js +0 -55
  386. package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
  387. package/dist/transaction/auth/hostedEndpoints.js +0 -21
  388. package/dist/transaction/auth/identity.d.ts +0 -55
  389. package/dist/transaction/auth/identity.js +0 -210
  390. package/dist/transaction/auth/index.d.ts +0 -162
  391. package/dist/transaction/auth/index.js +0 -304
  392. package/dist/transaction/auth/schemas.d.ts +0 -59
  393. package/dist/transaction/auth/schemas.js +0 -85
  394. package/dist/transaction/auth/sessionMint.d.ts +0 -28
  395. package/dist/transaction/auth/sessionMint.js +0 -85
  396. package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -56
  397. package/dist/transaction/coordination/awaitClaimGrant.js +0 -124
  398. package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -84
  399. package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -108
  400. package/dist/transaction/coordination/claimMeta.d.ts +0 -49
  401. package/dist/transaction/coordination/claimMeta.js +0 -52
  402. package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
  403. package/dist/transaction/coordination/createClaimStream.js +0 -475
  404. package/dist/transaction/coordination/events.d.ts +0 -74
  405. package/dist/transaction/coordination/events.js +0 -7
  406. package/dist/transaction/coordination/index.d.ts +0 -19
  407. package/dist/transaction/coordination/index.js +0 -45
  408. package/dist/transaction/coordination/locator.d.ts +0 -104
  409. package/dist/transaction/coordination/locator.js +0 -102
  410. package/dist/transaction/coordination/schema.d.ts +0 -1536
  411. package/dist/transaction/coordination/schema.js +0 -1177
  412. package/dist/transaction/coordination/targetConflict.d.ts +0 -2
  413. package/dist/transaction/coordination/targetConflict.js +0 -107
  414. package/dist/transaction/coordination/trace.d.ts +0 -78
  415. package/dist/transaction/coordination/trace.js +0 -138
  416. package/dist/transaction/durableWrites.d.ts +0 -62
  417. package/dist/transaction/durableWrites.js +0 -71
  418. package/dist/transaction/environment.d.ts +0 -105
  419. package/dist/transaction/environment.js +0 -108
  420. package/dist/transaction/errorCodes.d.ts +0 -403
  421. package/dist/transaction/errorCodes.js +0 -484
  422. package/dist/transaction/errors.d.ts +0 -428
  423. package/dist/transaction/errors.js +0 -686
  424. package/dist/transaction/footprint.d.ts +0 -111
  425. package/dist/transaction/footprint.js +0 -0
  426. package/dist/transaction/index.d.ts +0 -20
  427. package/dist/transaction/index.js +0 -20
  428. package/dist/transaction/keys/index.d.ts +0 -87
  429. package/dist/transaction/keys/index.js +0 -207
  430. package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
  431. package/dist/transaction/log/syncDeltaRow.js +0 -95
  432. package/dist/transaction/logPosition.d.ts +0 -97
  433. package/dist/transaction/logPosition.js +0 -125
  434. package/dist/transaction/logger.d.ts +0 -16
  435. package/dist/transaction/logger.js +0 -7
  436. package/dist/transaction/observability.d.ts +0 -53
  437. package/dist/transaction/observability.js +0 -19
  438. package/dist/transaction/persistence.d.ts +0 -12
  439. package/dist/transaction/persistence.js +0 -11
  440. package/dist/transaction/plugin.d.ts +0 -285
  441. package/dist/transaction/plugin.js +0 -106
  442. package/dist/transaction/policy/types.d.ts +0 -217
  443. package/dist/transaction/policy/types.js +0 -126
  444. package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
  445. package/dist/transaction/resources/functionalUpdate.js +0 -87
  446. package/dist/transaction/resources/httpResources.d.ts +0 -321
  447. package/dist/transaction/resources/httpResources.js +0 -7
  448. package/dist/transaction/resources/modelOperations.d.ts +0 -427
  449. package/dist/transaction/resources/modelOperations.js +0 -12
  450. package/dist/transaction/resources/mutationOptions.d.ts +0 -66
  451. package/dist/transaction/resources/mutationOptions.js +0 -9
  452. package/dist/transaction/resources/where.d.ts +0 -101
  453. package/dist/transaction/resources/where.js +0 -115
  454. package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
  455. package/dist/transaction/resources/writeOptionsSchema.js +0 -73
  456. package/dist/transaction/schema/field.d.ts +0 -120
  457. package/dist/transaction/schema/field.js +0 -265
  458. package/dist/transaction/schema/fieldRef.d.ts +0 -38
  459. package/dist/transaction/schema/fieldRef.js +0 -11
  460. package/dist/transaction/schema/loadStrategy.d.ts +0 -45
  461. package/dist/transaction/schema/loadStrategy.js +0 -46
  462. package/dist/transaction/schema/model.d.ts +0 -379
  463. package/dist/transaction/schema/model.js +0 -123
  464. package/dist/transaction/schema/openapi.d.ts +0 -58
  465. package/dist/transaction/schema/openapi.js +0 -501
  466. package/dist/transaction/schema/relation.d.ts +0 -204
  467. package/dist/transaction/schema/relation.js +0 -104
  468. package/dist/transaction/schema/residency.d.ts +0 -29
  469. package/dist/transaction/schema/residency.js +0 -25
  470. package/dist/transaction/schema/roles.d.ts +0 -249
  471. package/dist/transaction/schema/roles.js +0 -230
  472. package/dist/transaction/schema/schema.d.ts +0 -351
  473. package/dist/transaction/schema/schema.js +0 -325
  474. package/dist/transaction/schema/tenancy.d.ts +0 -139
  475. package/dist/transaction/schema/tenancy.js +0 -190
  476. package/dist/transaction/transactionLayer.d.ts +0 -82
  477. package/dist/transaction/transactionLayer.js +0 -24
  478. package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
  479. package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
  480. package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
  481. package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
  482. package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
  483. package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
  484. package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
  485. package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
  486. package/dist/transaction/transport/commitFrames.d.ts +0 -90
  487. package/dist/transaction/transport/commitFrames.js +0 -134
  488. package/dist/transaction/transport/connectionManager.d.ts +0 -215
  489. package/dist/transaction/transport/connectionManager.js +0 -673
  490. package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
  491. package/dist/transaction/transport/credentialLifecycle.js +0 -324
  492. package/dist/transaction/transport/heartbeat.d.ts +0 -65
  493. package/dist/transaction/transport/heartbeat.js +0 -93
  494. package/dist/transaction/transport/httpClient.d.ts +0 -131
  495. package/dist/transaction/transport/httpClient.js +0 -146
  496. package/dist/transaction/transport/httpOptions.d.ts +0 -33
  497. package/dist/transaction/transport/httpOptions.js +0 -12
  498. package/dist/transaction/transport/httpTransport.d.ts +0 -8
  499. package/dist/transaction/transport/httpTransport.js +0 -1388
  500. package/dist/transaction/transport/networkProbe.d.ts +0 -84
  501. package/dist/transaction/transport/networkProbe.js +0 -207
  502. package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
  503. package/dist/transaction/transport/wsFrameHandlers.js +0 -429
  504. package/dist/transaction/transport/wsTransport.d.ts +0 -574
  505. package/dist/transaction/transport/wsTransport.js +0 -1023
  506. package/dist/transaction/types/assertExact.d.ts +0 -17
  507. package/dist/transaction/types/assertExact.js +0 -1
  508. package/dist/transaction/types/global.d.ts +0 -107
  509. package/dist/transaction/types/global.js +0 -40
  510. package/dist/transaction/types/index.d.ts +0 -205
  511. package/dist/transaction/types/index.js +0 -56
  512. package/dist/transaction/types/modelData.d.ts +0 -10
  513. package/dist/transaction/types/modelData.js +0 -9
  514. package/dist/transaction/types/participant.d.ts +0 -20
  515. package/dist/transaction/types/participant.js +0 -10
  516. package/dist/transaction/types/streams.d.ts +0 -550
  517. package/dist/transaction/types/streams.js +0 -11
  518. package/dist/transaction/utils/asyncIterator.d.ts +0 -34
  519. package/dist/transaction/utils/asyncIterator.js +0 -135
  520. package/dist/transaction/utils/duration.d.ts +0 -50
  521. package/dist/transaction/utils/duration.js +0 -77
  522. package/dist/transaction/utils/json.d.ts +0 -57
  523. package/dist/transaction/utils/json.js +0 -276
  524. package/dist/transaction/wire/accountResponses.d.ts +0 -420
  525. package/dist/transaction/wire/accountResponses.js +0 -290
  526. package/dist/transaction/wire/auth.d.ts +0 -56
  527. package/dist/transaction/wire/auth.js +0 -63
  528. package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
  529. package/dist/transaction/wire/bootstrapReason.js +0 -8
  530. package/dist/transaction/wire/claimEvent.d.ts +0 -76
  531. package/dist/transaction/wire/claimEvent.js +0 -73
  532. package/dist/transaction/wire/claims.d.ts +0 -530
  533. package/dist/transaction/wire/claims.js +0 -327
  534. package/dist/transaction/wire/commit.d.ts +0 -603
  535. package/dist/transaction/wire/commit.js +0 -321
  536. package/dist/transaction/wire/delta.d.ts +0 -250
  537. package/dist/transaction/wire/delta.js +0 -147
  538. package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
  539. package/dist/transaction/wire/errorEnvelope.js +0 -123
  540. package/dist/transaction/wire/feedCursor.d.ts +0 -60
  541. package/dist/transaction/wire/feedCursor.js +0 -82
  542. package/dist/transaction/wire/feedEvent.d.ts +0 -204
  543. package/dist/transaction/wire/feedEvent.js +0 -65
  544. package/dist/transaction/wire/frames.d.ts +0 -194
  545. package/dist/transaction/wire/frames.js +0 -50
  546. package/dist/transaction/wire/inboundFrames.d.ts +0 -562
  547. package/dist/transaction/wire/inboundFrames.js +0 -116
  548. package/dist/transaction/wire/index.d.ts +0 -54
  549. package/dist/transaction/wire/index.js +0 -83
  550. package/dist/transaction/wire/listEnvelope.d.ts +0 -37
  551. package/dist/transaction/wire/listEnvelope.js +0 -42
  552. package/dist/transaction/wire/modelMutations.d.ts +0 -31
  553. package/dist/transaction/wire/modelMutations.js +0 -52
  554. package/dist/transaction/wire/modelResponses.d.ts +0 -85
  555. package/dist/transaction/wire/modelResponses.js +0 -43
  556. package/dist/transaction/wire/modelShape.d.ts +0 -78
  557. package/dist/transaction/wire/modelShape.js +0 -74
  558. package/dist/transaction/wire/protocol.d.ts +0 -38
  559. package/dist/transaction/wire/protocol.js +0 -38
  560. package/dist/transaction/wire/protocolVersion.d.ts +0 -73
  561. package/dist/transaction/wire/protocolVersion.js +0 -83
  562. package/dist/transactions/mutations/MutationQueue.d.ts +0 -661
  563. package/dist/transactions/mutations/MutationQueue.js +0 -2807
  564. package/dist/transactions/mutations/MutationStore.d.ts +0 -20
  565. package/dist/transactions/mutations/MutationStore.js +0 -53
  566. package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
  567. package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
  568. package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
  569. package/dist/transactions/mutations/coalesceRules.js +0 -140
  570. package/dist/transactions/mutations/commitLatency.d.ts +0 -52
  571. package/dist/transactions/mutations/commitLatency.js +0 -130
  572. package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
  573. package/dist/transactions/mutations/commitOutboxStore.js +0 -26
  574. package/dist/transactions/mutations/commitPayload.d.ts +0 -165
  575. package/dist/transactions/mutations/commitPayload.js +0 -152
  576. package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -63
  577. package/dist/transactions/mutations/deltaConfirmation.js +0 -235
  578. package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
  579. package/dist/transactions/mutations/durableWriteStore.js +0 -12
  580. package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
  581. package/dist/transactions/mutations/optimisticApply.js +0 -65
  582. package/dist/transactions/mutations/replayValidation.d.ts +0 -187
  583. package/dist/transactions/mutations/replayValidation.js +0 -164
  584. package/dist/utils/mobxSetup.d.ts +0 -53
  585. package/dist/utils/mobxSetup.js +0 -330
  586. package/dist/views/QueryView.d.ts +0 -79
  587. package/dist/views/QueryView.js +0 -218
  588. package/dist/views/ViewRegistry.d.ts +0 -20
  589. package/dist/views/ViewRegistry.js +0 -55
  590. package/dist/views/incrementalView.d.ts +0 -45
  591. package/dist/views/incrementalView.js +0 -69
  592. package/dist/webhooks/events.d.ts +0 -43
  593. package/dist/webhooks/events.js +0 -42
  594. package/dist/webhooks/index.d.ts +0 -8
  595. package/dist/webhooks/index.js +0 -8
  596. package/dist/wire/index.d.ts +0 -1
  597. package/dist/wire/index.js +0 -8
@@ -1,231 +0,0 @@
1
- /**
2
- * The materialiser's lifecycle: the first credential mint, identity
3
- * resolution, the credential-refresh machinery, and the idempotent `ready()`
4
- * that drives the store's initialize generator to completion. Extracted from
5
- * the composition root along the humans() seam (docs/plans/package-split.md):
6
- * the engine wires it with the prelude's credential slice and consumes
7
- * `ready`; resolved identity flows back through one callback, so the
8
- * engine-side state it seeds (the self locals, the streams) stays with the
9
- * engine.
10
- */
11
- import { resolveParticipantIdentity } from '../transaction/auth/identity.js';
12
- import { AbloAuthenticationError, AbloConnectionError, toAbloError, } from '../transaction/errors.js';
13
- /**
14
- * Wires the credential machinery onto the cluster and returns the `ready`
15
- * the client exposes. Wiring happens now — the refresh lifecycle, the
16
- * lazy-query auth recovery, the executor binding, and the opt-in auto-start;
17
- * the first mint waits for `ready()` so the first connection carries a
18
- * token.
19
- */
20
- export function startStoreLifecycle(deps) {
21
- const { cluster, schema, internalOptions, authCredentials, credentialResolver, configuredApiKey, configuredAuthToken, url, kind, logger, validationError, onIdentityResolved, } = deps;
22
- const { store, components, runtime } = cluster;
23
- const { bootstrapHelper, hydration, syncClient } = components;
24
- // Hand the credential lifecycle to the client (refresher + proactive refresh
25
- // timer + wake/online/focus re-mint). Installed once here so refresh works for
26
- // any consumer of `Ablo({ auth })`, not only those who render `<AbloProvider>`.
27
- // The first mint happens in `ready()` so the first connection carries a token.
28
- //
29
- // Long-lived server clients also get the pre-roll timer on windowless hosts
30
- // (`proactiveInNode`): their socket must renew its `rk_` or `ek_` before the
31
- // server's keepalive reaper closes it (4001 `credential_expired`). Two signals
32
- // qualify — an agent or system participant, and an absolute endpoint-string
33
- // `apiKey` (a relative one can't be fetched in Node, so an absolute URL is
34
- // unambiguously a deliberate server client). User-kind clients in Node (an
35
- // SSR/RSC module evaluating scaffolded browser code) stay reactive-only.
36
- if (credentialResolver) {
37
- const rawEndpoint = internalOptions.authEndpoint ?? internalOptions.apiKey;
38
- const absoluteEndpoint = typeof rawEndpoint === 'string' && /^https?:\/\//i.test(rawEndpoint);
39
- store.startCredentialLifecycle(credentialResolver, {
40
- /* eslint-disable @typescript-eslint/no-deprecated -- `kind` gates the self-hosted proactive pre-roll; hosted path derives it from the apiKey scope */
41
- proactiveInNode: internalOptions.kind === 'agent' ||
42
- internalOptions.kind === 'system' ||
43
- absoluteEndpoint,
44
- /* eslint-enable @typescript-eslint/no-deprecated */
45
- });
46
- }
47
- // Put the lazy-query lane on the same auth-recovery path as the WebSocket probe
48
- // and the proactive pre-roll: a 401 on `/sync/query` re-mints via the store's
49
- // single-flight lifecycle and replays once, instead of silently returning empty
50
- // rows against an expired `ek_` until the next proactive tick. Late-bound
51
- // because the coordinator is constructed before the store exists.
52
- hydration.setCredentialRecovery((recovery) => store.recoverFromAuthRejection(recovery));
53
- // Bind this client's executor to its MutationQueue explicitly. The queue
54
- // already resolves it through this client's own `runtime`, so this is the
55
- // same executor either way; the explicit binding also covers a queue that
56
- // was constructed without the instance runtime (subclass and test paths).
57
- syncClient.getMutationQueue().setMutationExecutor(runtime.mutationExecutor);
58
- // Status is tracked in store.syncStatus (MobX observable) — the single
59
- // source of truth. No duplicate closure variables.
60
- let _readyPromise = null;
61
- let _refreshScheduler = null;
62
- async function ready() {
63
- if (_readyPromise)
64
- return _readyPromise;
65
- if (validationError) {
66
- _readyPromise = Promise.reject(validationError);
67
- return _readyPromise;
68
- }
69
- _readyPromise = (async () => {
70
- try {
71
- // Mint the first access credential before we connect, so the initial
72
- // WebSocket upgrade and bootstrap carry a valid bearer (no tokenless first
73
- // connect that has to self-heal). Only when a refreshing resolver is wired
74
- // and no static credential is already present. Follows the `apiKey`
75
- // resolver contract: `null` means the login is gone (terminal — fail ready
76
- // so the app shows sign-in); a throw means transient (rethrown; autoStart
77
- // swallows it and the lifecycle's online/wake triggers retry).
78
- if (credentialResolver && !authCredentials.getAuthToken()) {
79
- const token = await credentialResolver();
80
- if (!token) {
81
- throw new AbloAuthenticationError('Auth resolver returned null before connect — the user is not signed in.', { code: 'auth_no_credentials' });
82
- }
83
- authCredentials.setAuthToken(token);
84
- }
85
- // Resolve participant identity + scope. Three branches —
86
- // hosted-cloud apiKey exchange, self-derived from capability
87
- // token, or legacy explicit options. See `./identity.ts`.
88
- const resolved = await resolveParticipantIdentity({
89
- options: internalOptions,
90
- internalOptions,
91
- url,
92
- kind,
93
- configuredApiKey,
94
- // Resolve identity against the live token, not the construction-time
95
- // `configuredAuthToken`. Consumers using a function `apiKey` never pass
96
- // `authToken` at construction — the lifecycle mints the first `ek_` or
97
- // `rk_` and calls `setAuthToken()` before `ready()`, which updates the
98
- // shared credential source. Reading the frozen `configuredAuthToken`
99
- // here made `/auth/identity` fire with no bearer (returning
100
- // `no_matching_provider` / `session_expired`) even though the token was
101
- // present. This reads the shared credential source, like every other
102
- // transport.
103
- configuredAuthToken: authCredentials.getAuthToken() ?? configuredAuthToken,
104
- bootstrapHelper,
105
- auth: authCredentials,
106
- logger,
107
- });
108
- const { userId, accountScope, teamIds, capabilityToken, syncGroups, participantKind, } = resolved;
109
- // Fail-loud guard: detect the degenerate "no real sync groups
110
- // resolved" state before opening the socket. It is the same class of bug as
111
- // a sensible-looking default that's functionally broken: the
112
- // SDK ends up subscribing only to the server-side
113
- // `['default']` fallback, no
114
- // delta has that tag, live fan-out silently never delivers.
115
- // For human users (kind:'user') this is almost certainly a
116
- // misconfiguration upstream — either the caller didn't pass
117
- // `syncGroups`, or auth resolution didn't derive them, or
118
- // both. Warn loudly so the next debugging session starts here
119
- // instead of with "live updates don't work, hard reload fixes
120
- // it."
121
- const resolvedSyncGroups = syncGroups ?? [];
122
- if (participantKind === 'user' &&
123
- (resolvedSyncGroups.length === 0 ||
124
- (resolvedSyncGroups.length === 1 && resolvedSyncGroups[0] === 'default'))) {
125
- // Actionable and not self-healing (no live updates until fixed):
126
- // kept at warn level for consumers; the low-level diagnostic
127
- // fields ride the debug log below.
128
- logger.warn('This client was started without sync groups, so it will not receive ' +
129
- 'live updates. Pass `syncGroups` (for example ' +
130
- '`["org:<id>", "user:<id>"]`) or check that your auth provider supplies them.');
131
- logger.debug('degenerate syncGroups — details', { participantKind, resolvedSyncGroups });
132
- }
133
- // Seed the resolved identity into everything that filters or stamps
134
- // by participant — the engine's self locals and its streams, through
135
- // the one callback. This runs before the store connects, so no frame
136
- // is ever filtered against the construction-time guess.
137
- onIdentityResolved({
138
- userId,
139
- participantKind,
140
- accountScope,
141
- syncGroups: resolvedSyncGroups,
142
- });
143
- if (resolved.refreshScheduler) {
144
- _refreshScheduler = resolved.refreshScheduler;
145
- }
146
- // Drive the generator to completion. Each yielded promise is awaited
147
- // then fed back — this is standard generator consumption.
148
- //
149
- // The store.initialize() generator updates store.syncStatus as it
150
- // progresses (syncing → idle on success, error on failure), so the
151
- // consumer's `sync.syncStatus` observable reflects real-time state.
152
- // Resolve bootstrap mode: explicit option wins; otherwise
153
- // agents default to 'none' (transactional participant — see
154
- // option doc) and everyone else defaults to 'full'.
155
- const resolvedBootstrapMode = internalOptions.bootstrapMode ?? (participantKind === 'agent' ? 'none' : 'full');
156
- const gen = store.initialize({
157
- userId,
158
- organizationId: accountScope,
159
- teamIds,
160
- kind: participantKind,
161
- capabilityToken,
162
- syncGroups,
163
- bootstrapMode: resolvedBootstrapMode,
164
- });
165
- let current = gen.next();
166
- while (!current.done) {
167
- const yielded = current.value;
168
- const settled = yielded instanceof Promise ? await yielded : yielded;
169
- current = gen.next(settled);
170
- }
171
- const result = current.value;
172
- if (!result.success) {
173
- throw result.error
174
- ? toAbloError(result.error)
175
- : new AbloConnectionError('Sync engine initialization failed', {
176
- code: 'bootstrap_fetch_timeout',
177
- });
178
- }
179
- logger.info('Sync engine ready', { models: Object.keys(schema.models).length });
180
- }
181
- catch (err) {
182
- // Coerce so the rejection a consumer awaiting `ready()` catches is
183
- // always an AbloError — connection setup is held to the same
184
- // never-leak-untagged contract as the model operations.
185
- const error = toAbloError(err);
186
- // Make sure syncStatus reflects the failure for observer() components
187
- store.syncStatus.state = 'error';
188
- store.syncStatus.error = error;
189
- // Log the typed envelope (type + code + status), not just the bare
190
- // message — so the console line names it as an Ablo error and carries
191
- // the code (e.g. AbloAuthenticationError/identity_resolve_failed on a
192
- // 401) instead of reading like an untagged failure.
193
- logger.error('Sync engine failed to initialize', {
194
- type: error.type,
195
- code: error.code,
196
- httpStatus: error.httpStatus,
197
- error: error.message,
198
- });
199
- // Clear the memo so a future `ready()` re-attempts bootstrap instead of
200
- // replaying this rejection forever. Bootstrap failures here are transient
201
- // by nature — offline, an IndexedDB open timeout, a bootstrap fetch
202
- // hiccup — and the early `if (_readyPromise) return _readyPromise` guard
203
- // would otherwise hand every later caller this same dead promise, bricking
204
- // the engine until a full page reload. Nulling it lets the provider's
205
- // online/wake/retry triggers drive a clean re-bootstrap. (The terminal
206
- // `validationError` branch above intentionally stays cached — config
207
- // can't change without recreating the engine.)
208
- _readyPromise = null;
209
- throw error;
210
- }
211
- })();
212
- return _readyPromise;
213
- }
214
- // Optional auto-start for convenience. Opt-in because silent background
215
- // init has historically been the #1 source of "why isn't my data loading"
216
- // bug reports. Explicit `await sync.ready()` is the default — errors
217
- // surface immediately instead of being swallowed.
218
- if (!validationError && internalOptions.autoStart) {
219
- void ready().catch(() => {
220
- // Error is captured in store.syncStatus; consumers should check
221
- // `sync.syncStatus.state === 'error'` to detect failures.
222
- });
223
- }
224
- return {
225
- ready,
226
- dispose() {
227
- _refreshScheduler?.dispose();
228
- _refreshScheduler = null;
229
- },
230
- };
231
- }
@@ -1,42 +0,0 @@
1
- /**
2
- * Validates the options passed when constructing a client, before any
3
- * connection is attempted. Returns the first problem it finds as an
4
- * {@link AbloError}, or null when every check passes. The caller records that
5
- * error on the client's sync status, so a misconfiguration surfaces through the
6
- * normal status channel rather than throwing at the call site.
7
- *
8
- * The order of checks matters: a missing `url` is reported before any identity
9
- * problem, because the identity error messages mention the URL and would
10
- * mislead if the URL were the thing actually missing.
11
- */
12
- import { AbloError } from '../transaction/errors.js';
13
- import type { ParticipantKind } from '../transaction/types/participant.js';
14
- /**
15
- * The subset of client options this validator reads. It is declared as its own
16
- * interface, structurally compatible with the full options type, so a real
17
- * options object satisfies it without the validator having to depend on the
18
- * complete type.
19
- */
20
- export interface ValidatableAbloOptions {
21
- readonly schema?: {
22
- readonly models?: Record<string, unknown>;
23
- } | null;
24
- readonly kind?: ParticipantKind;
25
- readonly user?: {
26
- readonly id?: string;
27
- } | undefined;
28
- readonly agentId?: string | undefined;
29
- readonly capabilityToken?: string | undefined;
30
- }
31
- export interface ValidateAbloOptionsInput {
32
- readonly options: ValidatableAbloOptions;
33
- readonly url: string;
34
- /**
35
- * Truthy when an API key was supplied (string or callable). The
36
- * validator only inspects presence, never the value, so the input
37
- * shape stays loose to accept whatever the caller resolved.
38
- */
39
- readonly configuredApiKey: unknown;
40
- readonly configuredAuthToken: unknown;
41
- }
42
- export declare function validateAbloOptions(input: ValidateAbloOptionsInput): AbloError | null;
@@ -1,43 +0,0 @@
1
- /**
2
- * Validates the options passed when constructing a client, before any
3
- * connection is attempted. Returns the first problem it finds as an
4
- * {@link AbloError}, or null when every check passes. The caller records that
5
- * error on the client's sync status, so a misconfiguration surfaces through the
6
- * normal status channel rather than throwing at the call site.
7
- *
8
- * The order of checks matters: a missing `url` is reported before any identity
9
- * problem, because the identity error messages mention the URL and would
10
- * mislead if the URL were the thing actually missing.
11
- */
12
- import { AbloError, AbloValidationError } from '../transaction/errors.js';
13
- export function validateAbloOptions(input) {
14
- const { options, url, configuredApiKey, configuredAuthToken } = input;
15
- const kind = options.kind ?? 'user';
16
- if (!url) {
17
- return new AbloValidationError('Ablo: `url` is required. Pass the sync server URL, e.g. ' +
18
- `Ablo({ baseURL: 'wss://api.abloatai.com', schema, user })`, { code: 'base_url_missing' });
19
- }
20
- if (!options.schema?.models) {
21
- return new AbloValidationError('Ablo: `schema` is required. Define it once and access models as `ablo.<model>`.', { code: 'invalid_options', param: 'schema' });
22
- }
23
- if (!configuredApiKey &&
24
- !configuredAuthToken &&
25
- !options.capabilityToken &&
26
- kind === 'user' &&
27
- options.user &&
28
- !options.user.id) {
29
- return new AbloValidationError('Ablo: `user.id` must be a non-empty string when `user` is provided.', { code: 'invalid_options', param: 'user.id' });
30
- }
31
- if (!configuredApiKey && !configuredAuthToken && kind === 'agent' && !options.agentId) {
32
- return new AbloValidationError('Ablo: provide either `apiKey` or `agentId` for `kind: "agent"`. ' +
33
- 'Hosted-cloud consumers pass `apiKey` and the server derives the ' +
34
- 'agent identity from its scope; self-hosted passes `agentId` + ' +
35
- '`capabilityToken` directly.', { code: 'invalid_options', param: 'agentId' });
36
- }
37
- if (!configuredApiKey && !configuredAuthToken && kind === 'agent' && !options.capabilityToken) {
38
- return new AbloValidationError('Ablo: provide either `apiKey` (hosted cloud — SDK exchanges internally) ' +
39
- 'or `capabilityToken` (self-hosted — your auth layer mints + hands in). ' +
40
- 'See https://abloatai.com/docs/api-keys for the full pattern.', { code: 'invalid_options', param: 'capabilityToken' });
41
- }
42
- return null;
43
- }
@@ -1,27 +0,0 @@
1
- /**
2
- * The default {@link MutationExecutor}. It sends each change as a `commit`
3
- * frame over the sync engine's own WebSocket, resolving that socket lazily at
4
- * commit time because it does not exist yet when the executor is created. A
5
- * client wires this up automatically unless you supply your own executor.
6
- */
7
- import type { ReadDependency, TrackDependency } from '../transaction/coordination/schema.js';
8
- import type { MutationExecutor, MutationOperation } from '../interfaces/index.js';
9
- import type { CommitAck } from '../sync/commitFrames.js';
10
- /**
11
- * Creates the default mutation executor, which sends each change as a `commit`
12
- * frame over the sync engine's own WebSocket. The engine owns its socket, so
13
- * you pass a URL and credentials rather than transport callbacks.
14
- *
15
- * The factory takes a `getWs` accessor instead of a socket directly because the
16
- * socket is created later during client startup and does not exist yet when
17
- * this executor is constructed. The accessor is called at commit time to reach
18
- * the ready socket.
19
- *
20
- * When set, `options.idempotencyKey` is sent as the wire-level `clientTxId`, so
21
- * retrying a call with the same key is safe. MutationQueue always supplies
22
- * this key before its first attempt and owns reuse across retries. The fallback
23
- * generation below exists only for direct, one-shot executor consumers.
24
- */
25
- export declare function createDefaultMutationExecutor(getWs: () => {
26
- sendCommit?: (operations: readonly MutationOperation[], clientTxId: string, timeoutMs?: number, reads?: readonly ReadDependency[] | null, track?: readonly TrackDependency[] | null) => Promise<CommitAck>;
27
- } | null): MutationExecutor;
@@ -1,72 +0,0 @@
1
- /**
2
- * The default {@link MutationExecutor}. It sends each change as a `commit`
3
- * frame over the sync engine's own WebSocket, resolving that socket lazily at
4
- * commit time because it does not exist yet when the executor is created. A
5
- * client wires this up automatically unless you supply your own executor.
6
- */
7
- import { AbloError, AbloConnectionError } from '../transaction/errors.js';
8
- // ── Default mutation executor (wire: `commit` frame over WebSocket) ──────
9
- /**
10
- * Creates the default mutation executor, which sends each change as a `commit`
11
- * frame over the sync engine's own WebSocket. The engine owns its socket, so
12
- * you pass a URL and credentials rather than transport callbacks.
13
- *
14
- * The factory takes a `getWs` accessor instead of a socket directly because the
15
- * socket is created later during client startup and does not exist yet when
16
- * this executor is constructed. The accessor is called at commit time to reach
17
- * the ready socket.
18
- *
19
- * When set, `options.idempotencyKey` is sent as the wire-level `clientTxId`, so
20
- * retrying a call with the same key is safe. MutationQueue always supplies
21
- * this key before its first attempt and owns reuse across retries. The fallback
22
- * generation below exists only for direct, one-shot executor consumers.
23
- */
24
- export function createDefaultMutationExecutor(getWs) {
25
- async function commit(operations, options) {
26
- const ws = getWs();
27
- if (!ws?.sendCommit) {
28
- throw new AbloConnectionError('SyncWebSocket not ready for commit. The engine must finish bootstrap ' +
29
- 'before mutations can be sent.', { code: 'ws_not_ready' });
30
- }
31
- const clientTxId = options?.idempotencyKey ??
32
- (typeof crypto !== 'undefined' && typeof crypto.randomUUID === 'function'
33
- ? crypto.randomUUID()
34
- : `tx_${Date.now()}_${Math.random().toString(36).slice(2, 10)}`);
35
- try {
36
- return await ws.sendCommit(operations, clientTxId, undefined, // use sendCommit's built-in 15s default; no per-call override
37
- options?.reads, options?.track);
38
- }
39
- catch (err) {
40
- // Wrap transport-level failures as connection errors so the transaction
41
- // queue's retry classifier treats them as transient and retries them.
42
- if (err instanceof AbloError)
43
- throw err;
44
- if (err instanceof Error) {
45
- if (/not connected|timed out|connection|ECONN/i.test(err.message)) {
46
- const wrapped = new AbloConnectionError(err.message, { cause: err });
47
- // Preserve any `diagnostics` snapshot the underlying SyncWebSocket
48
- // attached to the rejection. Without this, the wrapped error
49
- // bottoms out at "AbloConnectionError: not connected" with no
50
- // attribution to which close code / heartbeat trip / session
51
- // error caused it. See SyncWebSocket.notConnectedError().
52
- if (err &&
53
- typeof err === 'object' &&
54
- 'diagnostics' in err &&
55
- err.diagnostics) {
56
- wrapped.diagnostics = err.diagnostics;
57
- }
58
- throw wrapped;
59
- }
60
- }
61
- throw err;
62
- }
63
- }
64
- return {
65
- commit,
66
- executeCreate: (model, id, input, _txId, options) => commit([{ type: 'CREATE', model: model.toLowerCase(), id, input }], options).then(() => { }),
67
- executeUpdate: (model, id, data, _txId, options) => commit([{ type: 'UPDATE', model: model.toLowerCase(), id, input: data }], options),
68
- executeDelete: (model, id, _txId, options) => commit([{ type: 'DELETE', model: model.toLowerCase(), id }], options).then(() => { }),
69
- executeArchive: (model, id, _txId, options) => commit([{ type: 'ARCHIVE', model: model.toLowerCase(), id }], options).then(() => { }),
70
- executeUnarchive: (model, id, _txId, options) => commit([{ type: 'UNARCHIVE', model: model.toLowerCase(), id }], options).then(() => { }),
71
- };
72
- }
package/dist/context.d.ts DELETED
@@ -1,42 +0,0 @@
1
- /**
2
- * Module-level accessor for the sync engine's runtime context.
3
- *
4
- * The context is set once, during initialization, by {@link initRuntime}.
5
- * Code throughout the package reaches its shared dependencies — logger,
6
- * observability, online-status detector, configuration, and the mutation
7
- * executor — through {@link getContext} instead of receiving them through every
8
- * constructor.
9
- */
10
- import type { RuntimeContext } from './RuntimeContext.js';
11
- /**
12
- * Install the caller-provided runtime dependencies. Must be called before any
13
- * operation that reaches {@link getContext}.
14
- */
15
- export declare function initRuntime(context: RuntimeContext): void;
16
- /**
17
- * Get the current sync engine context.
18
- * Returns a safe fallback with no-op implementations if not yet initialized,
19
- * so SDK files can import at module load time without crashing.
20
- */
21
- export declare function getContext(): RuntimeContext;
22
- /**
23
- * The module-global runtime as an instance-shaped value — the bridge for code
24
- * that is not yet constructed with its client's own `RuntimeContext`.
25
- *
26
- * Every member reads {@link getContext} at call time, so a context installed
27
- * after construction is still picked up (tests construct first and
28
- * `initRuntime` later). Classes take `runtime` as a constructor option with
29
- * this as the default; a client that threads its own instance is isolated
30
- * from other clients in the same process, a construction that doesn't is
31
- * last-writer-wins exactly as before. Retired reference by reference as
32
- * construction moves behind `humans()` (docs/plans/package-split.md).
33
- */
34
- export declare const globalRuntime: RuntimeContext;
35
- /**
36
- * Check if the sync engine has been initialized.
37
- */
38
- export declare function isRuntimeInitialized(): boolean;
39
- /**
40
- * Reset context (for testing or cleanup).
41
- */
42
- export declare function resetRuntime(): void;
package/dist/context.js DELETED
@@ -1,81 +0,0 @@
1
- /**
2
- * Module-level accessor for the sync engine's runtime context.
3
- *
4
- * The context is set once, during initialization, by {@link initRuntime}.
5
- * Code throughout the package reaches its shared dependencies — logger,
6
- * observability, online-status detector, configuration, and the mutation
7
- * executor — through {@link getContext} instead of receiving them through every
8
- * constructor.
9
- */
10
- import { noopLogger, noopObservability, browserOnlineStatus, defaultSessionErrorDetector, emptyConfig, } from './RuntimeContext.js';
11
- let _context = null;
12
- /**
13
- * Install the caller-provided runtime dependencies. Must be called before any
14
- * operation that reaches {@link getContext}.
15
- */
16
- export function initRuntime(context) {
17
- _context = context;
18
- }
19
- /**
20
- * Get the current sync engine context.
21
- * Returns a safe fallback with no-op implementations if not yet initialized,
22
- * so SDK files can import at module load time without crashing.
23
- */
24
- export function getContext() {
25
- if (!_context) {
26
- return _fallback;
27
- }
28
- return _context;
29
- }
30
- /**
31
- * The module-global runtime as an instance-shaped value — the bridge for code
32
- * that is not yet constructed with its client's own `RuntimeContext`.
33
- *
34
- * Every member reads {@link getContext} at call time, so a context installed
35
- * after construction is still picked up (tests construct first and
36
- * `initRuntime` later). Classes take `runtime` as a constructor option with
37
- * this as the default; a client that threads its own instance is isolated
38
- * from other clients in the same process, a construction that doesn't is
39
- * last-writer-wins exactly as before. Retired reference by reference as
40
- * construction moves behind `humans()` (docs/plans/package-split.md).
41
- */
42
- export const globalRuntime = {
43
- get logger() { return getContext().logger; },
44
- get observability() { return getContext().observability; },
45
- get analytics() { return getContext().analytics; },
46
- get sessionErrorDetector() { return getContext().sessionErrorDetector; },
47
- get onlineStatus() { return getContext().onlineStatus; },
48
- get modelDebugLogger() { return getContext().modelDebugLogger; },
49
- get mutationExecutor() { return getContext().mutationExecutor; },
50
- get config() { return getContext().config; },
51
- getModelMetadata: (name) => getContext().getModelMetadata(name),
52
- };
53
- /**
54
- * Check if the sync engine has been initialized.
55
- */
56
- export function isRuntimeInitialized() {
57
- return _context !== null;
58
- }
59
- /**
60
- * Reset context (for testing or cleanup).
61
- */
62
- export function resetRuntime() {
63
- _context = null;
64
- }
65
- /** Fallback context with no-op implementations */
66
- const _fallback = {
67
- logger: noopLogger,
68
- observability: noopObservability,
69
- onlineStatus: browserOnlineStatus,
70
- sessionErrorDetector: defaultSessionErrorDetector,
71
- config: emptyConfig,
72
- getModelMetadata: () => undefined,
73
- mutationExecutor: {
74
- commit: () => Promise.resolve({ lastSyncId: 0, status: 'confirmed' }),
75
- executeCreate: () => Promise.resolve(),
76
- executeUpdate: () => Promise.resolve(null),
77
- executeDelete: () => Promise.resolve(),
78
- executeArchive: () => Promise.resolve(),
79
- executeUnarchive: () => Promise.resolve(),
80
- },
81
- };
@@ -1,26 +0,0 @@
1
- /**
2
- * Sync-engine compatibility adapter for the transaction layer's narrow claim
3
- * log. The core log knows only claim/conflict events; this subclass supplies
4
- * inert implementations for the client lifecycle hooks required by
5
- * `ObservabilityProvider`, preserving `Ablo({ observability: new ClaimLog() })`
6
- * without leaking bootstrap, storage, or WebSocket vocabulary into the core.
7
- */
8
- import { ClaimLog as CoordinationClaimLog } from '../transaction/coordination/trace.js';
9
- import type { ObservabilityProvider } from '../interfaces/index.js';
10
- export { formatClaim, formatConflict } from '../transaction/coordination/trace.js';
11
- export type { ClaimLogEntry } from '../transaction/coordination/trace.js';
12
- export declare class ClaimLog extends CoordinationClaimLog implements ObservabilityProvider {
13
- setContext(): void;
14
- setConnectionState(): void;
15
- breadcrumb(): void;
16
- captureRollback(): void;
17
- captureMutationFailure(): void;
18
- captureBootstrapFailure(): void;
19
- captureReconciliation(): void;
20
- captureDeltaRetryExhausted(): void;
21
- captureWebSocketError(): void;
22
- captureSelfHealing(): void;
23
- captureCommitZeroSyncId(): void;
24
- startSpan<T>(_name: string, _op: string, fn: () => T): T;
25
- startSpanAsync<T>(_name: string, _op: string, fn: () => Promise<T>): Promise<T>;
26
- }
@@ -1,32 +0,0 @@
1
- /**
2
- * Sync-engine compatibility adapter for the transaction layer's narrow claim
3
- * log. The core log knows only claim/conflict events; this subclass supplies
4
- * inert implementations for the client lifecycle hooks required by
5
- * `ObservabilityProvider`, preserving `Ablo({ observability: new ClaimLog() })`
6
- * without leaking bootstrap, storage, or WebSocket vocabulary into the core.
7
- */
8
- import { ClaimLog as CoordinationClaimLog } from '../transaction/coordination/trace.js';
9
- export { formatClaim, formatConflict } from '../transaction/coordination/trace.js';
10
- export class ClaimLog extends CoordinationClaimLog {
11
- // Client-lifecycle hooks the claim log has no notion of. Every body below is
12
- // deliberately inert: the log records claims and conflicts, nothing else.
13
- setContext() { }
14
- setConnectionState() { }
15
- breadcrumb() { }
16
- captureRollback() { }
17
- captureMutationFailure() { }
18
- captureBootstrapFailure() { }
19
- captureReconciliation() { }
20
- captureDeltaRetryExhausted() { }
21
- captureWebSocketError() { }
22
- captureSelfHealing() { }
23
- captureCommitZeroSyncId() { }
24
- // Spans run their body untimed; the trailing `attributes` argument callers
25
- // pass has nowhere to go here, so it is left off the signature.
26
- startSpan(_name, _op, fn) {
27
- return fn();
28
- }
29
- startSpanAsync(_name, _op, fn) {
30
- return fn();
31
- }
32
- }
@@ -1 +0,0 @@
1
- export * from '../transaction/coordination/index.js';
@@ -1,8 +0,0 @@
1
- // Moved to @ablo/transaction (ADR 0013 — the settlement core extraction).
2
- // This shim re-exports it at the original path so in-package importers of
3
- // `coordination/index.js` keep working; rewire to `@ablo/transaction/coordination`
4
- // and delete this shim once the core package is fully wired.
5
- //
6
- // Line comments on purpose: tsc copies a leading JSDoc block into the
7
- // published `.d.ts`, and this note names a package npm has never heard of.
8
- export * from '../transaction/coordination/index.js';
@@ -1,33 +0,0 @@
1
- /**
2
- * The framework-extension entry point of this package. Import from here only
3
- * when you are building on top of the sync engine — wiring your own store and
4
- * provider stack, writing a sync adapter, or driving a test harness. Everyday
5
- * application code should use the `Ablo({ schema })` client from the package
6
- * root instead; the primitives exported here are lower-level building blocks.
7
- *
8
- * The surface is deliberately narrow: it exposes only the types and classes an
9
- * extension actually needs. Anything the engine does not export here is
10
- * internal and may change.
11
- */
12
- export { BaseSyncedStore, type ModelConstructor, type ConcreteModelConstructor, } from '../BaseSyncedStore.js';
13
- export { SyncClient } from '../SyncClient.js';
14
- export { Database } from '../Database.js';
15
- export { InstanceCache, ModelScope } from '../InstanceCache.js';
16
- /** @deprecated `ObjectPool` was renamed to {@link InstanceCache} — the class is an
17
- * identity-map cache of live model instances, not a reuse pool. This alias keeps existing
18
- * imports working and will be removed in a future major version. */
19
- export { InstanceCache as ObjectPool } from '../InstanceCache.js';
20
- export { Model } from '../Model.js';
21
- export { LazyReferenceCollection, type LazyCollectionOptions, } from '../LazyReferenceCollection.js';
22
- export { ModelRegistry, getActiveRegistry, } from '../ModelRegistry.js';
23
- export { postQuery, type PostQueryOptions } from '../query/client.js';
24
- export { computeFKDepthPriority } from '../client/schemaConfig.js';
25
- export type { SyncLogger, SyncObservabilityProvider, MutationExecutor, SessionErrorDetector, OnlineStatusProvider, CommitResult, MutationOperation, MutationOptions, } from '../interfaces/index.js';
26
- export { SyncWebSocket, type SyncDelta, type SyncWebSocketOptions, } from '../sync/SyncWebSocket.js';
27
- export { BootstrapFetcher } from '../sync/BootstrapFetcher.js';
28
- /** @deprecated `BootstrapHelper` was renamed to {@link BootstrapFetcher}. This alias keeps
29
- * existing imports working and will be removed in a future major version. */
30
- export { BootstrapFetcher as BootstrapHelper } from '../sync/BootstrapFetcher.js';
31
- export { createClaimStream, type AttachableClaimStream, type ClaimStreamConfig, } from '../sync/createClaimStream.js';
32
- export { awaitClaimGrant, type GrantTransport, } from '../sync/awaitClaimGrant.js';
33
- export { LoadStrategy } from '../transaction/types/index.js';