@abloatai/ablo 0.35.0 → 0.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (622) hide show
  1. package/AGENTS.md +2 -2
  2. package/CHANGELOG.md +71 -1929
  3. package/NOTICE +2 -2
  4. package/README.md +23 -532
  5. package/assets/banner.png +0 -0
  6. package/dist/auth.d.ts +2 -0
  7. package/dist/auth.d.ts.map +1 -0
  8. package/dist/auth.js +2 -0
  9. package/dist/auth.js.map +1 -0
  10. package/dist/client.d.ts +3 -0
  11. package/dist/client.d.ts.map +1 -0
  12. package/dist/client.js +3 -0
  13. package/dist/client.js.map +1 -0
  14. package/dist/coordination.d.ts +2 -0
  15. package/dist/coordination.d.ts.map +1 -0
  16. package/dist/coordination.js +2 -0
  17. package/dist/coordination.js.map +1 -0
  18. package/dist/index.d.ts +3 -112
  19. package/dist/index.d.ts.map +1 -0
  20. package/dist/index.js +3 -161
  21. package/dist/index.js.map +1 -0
  22. package/dist/react.d.ts +4 -0
  23. package/dist/react.d.ts.map +1 -0
  24. package/dist/react.js +3 -0
  25. package/dist/react.js.map +1 -0
  26. package/dist/schema.d.ts +2 -0
  27. package/dist/schema.d.ts.map +1 -0
  28. package/dist/schema.js +2 -0
  29. package/dist/schema.js.map +1 -0
  30. package/dist/server.d.ts +2 -0
  31. package/dist/server.d.ts.map +1 -0
  32. package/dist/server.js +2 -0
  33. package/dist/server.js.map +1 -0
  34. package/dist/source-conformance.d.ts +2 -0
  35. package/dist/source-conformance.d.ts.map +1 -0
  36. package/dist/source-conformance.js +2 -0
  37. package/dist/source-conformance.js.map +1 -0
  38. package/dist/source-drizzle.d.ts +2 -0
  39. package/dist/source-drizzle.d.ts.map +1 -0
  40. package/dist/source-drizzle.js +2 -0
  41. package/dist/source-drizzle.js.map +1 -0
  42. package/dist/source-kysely.d.ts +2 -0
  43. package/dist/source-kysely.d.ts.map +1 -0
  44. package/dist/source-kysely.js +2 -0
  45. package/dist/source-kysely.js.map +1 -0
  46. package/dist/source-next.d.ts +2 -0
  47. package/dist/source-next.d.ts.map +1 -0
  48. package/dist/source-next.js +2 -0
  49. package/dist/source-next.js.map +1 -0
  50. package/dist/source.d.ts +2 -0
  51. package/dist/source.d.ts.map +1 -0
  52. package/dist/source.js +2 -0
  53. package/dist/source.js.map +1 -0
  54. package/dist/wire.d.ts +2 -0
  55. package/dist/wire.d.ts.map +1 -0
  56. package/dist/wire.js +2 -0
  57. package/dist/wire.js.map +1 -0
  58. package/docs/agents.md +2 -2
  59. package/docs/api-keys.md +13 -12
  60. package/docs/api.md +15 -53
  61. package/docs/audit.md +4 -3
  62. package/docs/cli.md +11 -11
  63. package/docs/client-behavior.md +9 -9
  64. package/docs/concurrency-convention.md +28 -42
  65. package/docs/coordination.md +228 -86
  66. package/docs/data-sources.md +5 -5
  67. package/docs/debugging.md +34 -12
  68. package/docs/deployment.md +8 -8
  69. package/docs/examples/agent-human.md +4 -4
  70. package/docs/examples/ai-sdk-tool.md +1 -1
  71. package/docs/examples/existing-python-backend.md +15 -4
  72. package/docs/examples/nextjs.md +27 -6
  73. package/docs/examples/scoped-agent.md +3 -3
  74. package/docs/examples/server-agent.md +2 -2
  75. package/docs/groups.md +57 -3
  76. package/docs/guarantees.md +37 -10
  77. package/docs/how-it-works.md +32 -8
  78. package/docs/idempotency.md +6 -6
  79. package/docs/identity.md +24 -24
  80. package/docs/index.md +8 -8
  81. package/docs/integration-guide.md +38 -16
  82. package/docs/internal/README.md +18 -0
  83. package/docs/internal/agent-fleet-coordination-design.md +171 -0
  84. package/docs/internal/agent-orchestration.md +58 -0
  85. package/docs/internal/commit-identifiers.md +91 -0
  86. package/docs/internal/concurrency-open-decisions.md +37 -0
  87. package/docs/internal/data-source-reverse-channel.md +150 -0
  88. package/docs/internal/per-field-conflict-detection.md +165 -0
  89. package/docs/internal/postgres-replication.md +64 -0
  90. package/docs/internal/serializable-schema.md +119 -0
  91. package/docs/internal/structure.md +32 -0
  92. package/docs/mcp.md +9 -9
  93. package/docs/migration.md +37 -18
  94. package/docs/projects.md +1 -1
  95. package/docs/quickstart.md +2 -2
  96. package/docs/react.md +24 -13
  97. package/docs/schema-contract.md +3 -3
  98. package/docs/sessions.md +91 -37
  99. package/docs/webhooks.md +9 -9
  100. package/examples/README.md +2 -2
  101. package/examples/data-source/README.md +1 -1
  102. package/examples/data-source/ablo-driver.ts +1 -1
  103. package/examples/data-source/customer-server.ts +1 -1
  104. package/examples/data-source/run.ts +1 -1
  105. package/examples/data-source/schema.ts +1 -1
  106. package/examples/quickstart.ts +2 -2
  107. package/llms.txt +12 -12
  108. package/package.json +64 -174
  109. package/dist/BaseSyncedStore.d.ts +0 -823
  110. package/dist/BaseSyncedStore.js +0 -1955
  111. package/dist/Database.d.ts +0 -335
  112. package/dist/Database.js +0 -1500
  113. package/dist/InstanceCache.d.ts +0 -233
  114. package/dist/InstanceCache.js +0 -1164
  115. package/dist/LazyReferenceCollection.d.ts +0 -177
  116. package/dist/LazyReferenceCollection.js +0 -461
  117. package/dist/Model.d.ts +0 -444
  118. package/dist/Model.js +0 -909
  119. package/dist/ModelRegistry.d.ts +0 -221
  120. package/dist/ModelRegistry.js +0 -537
  121. package/dist/NetworkMonitor.d.ts +0 -26
  122. package/dist/NetworkMonitor.js +0 -77
  123. package/dist/RuntimeContext.d.ts +0 -52
  124. package/dist/RuntimeContext.js +0 -80
  125. package/dist/SyncClient.d.ts +0 -551
  126. package/dist/SyncClient.js +0 -2199
  127. package/dist/adapters/alwaysOnline.d.ts +0 -14
  128. package/dist/adapters/alwaysOnline.js +0 -17
  129. package/dist/adapters/inMemoryStorage.d.ts +0 -31
  130. package/dist/adapters/inMemoryStorage.js +0 -110
  131. package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
  132. package/dist/ai-sdk/coordinatedTool.js +0 -134
  133. package/dist/ai-sdk/coordinationContext.d.ts +0 -46
  134. package/dist/ai-sdk/coordinationContext.js +0 -106
  135. package/dist/ai-sdk/index.d.ts +0 -121
  136. package/dist/ai-sdk/index.js +0 -121
  137. package/dist/ai-sdk/wrap.d.ts +0 -65
  138. package/dist/ai-sdk/wrap.js +0 -39
  139. package/dist/auth/index.d.ts +0 -1
  140. package/dist/auth/index.js +0 -8
  141. package/dist/batching/index.d.ts +0 -55
  142. package/dist/batching/index.js +0 -147
  143. package/dist/cli.cjs +0 -288600
  144. package/dist/client/Ablo.d.ts +0 -231
  145. package/dist/client/Ablo.js +0 -149
  146. package/dist/client/abloClient.d.ts +0 -309
  147. package/dist/client/abloClient.js +0 -13
  148. package/dist/client/clientPrelude.d.ts +0 -52
  149. package/dist/client/clientPrelude.js +0 -60
  150. package/dist/client/consoleLogger.d.ts +0 -35
  151. package/dist/client/consoleLogger.js +0 -44
  152. package/dist/client/coreClient.d.ts +0 -60
  153. package/dist/client/coreClient.js +0 -118
  154. package/dist/client/createInternalComponents.d.ts +0 -46
  155. package/dist/client/createInternalComponents.js +0 -92
  156. package/dist/client/createModelProxy.d.ts +0 -228
  157. package/dist/client/createModelProxy.js +0 -818
  158. package/dist/client/humans.d.ts +0 -48
  159. package/dist/client/humans.js +0 -52
  160. package/dist/client/modelRegistration.d.ts +0 -10
  161. package/dist/client/modelRegistration.js +0 -312
  162. package/dist/client/options.d.ts +0 -461
  163. package/dist/client/options.js +0 -7
  164. package/dist/client/reactiveEngine.d.ts +0 -48
  165. package/dist/client/reactiveEngine.js +0 -910
  166. package/dist/client/resourceTypes.d.ts +0 -12
  167. package/dist/client/resourceTypes.js +0 -10
  168. package/dist/client/schemaConfig.d.ts +0 -44
  169. package/dist/client/schemaConfig.js +0 -185
  170. package/dist/client/validateAbloOptions.d.ts +0 -42
  171. package/dist/client/validateAbloOptions.js +0 -43
  172. package/dist/client/wsMutationExecutor.d.ts +0 -27
  173. package/dist/client/wsMutationExecutor.js +0 -72
  174. package/dist/context.d.ts +0 -29
  175. package/dist/context.js +0 -58
  176. package/dist/coordination/ClaimLog.d.ts +0 -26
  177. package/dist/coordination/ClaimLog.js +0 -32
  178. package/dist/coordination/index.d.ts +0 -1
  179. package/dist/coordination/index.js +0 -8
  180. package/dist/core/DatabaseManager.d.ts +0 -105
  181. package/dist/core/DatabaseManager.js +0 -387
  182. package/dist/core/QueryProcessor.d.ts +0 -75
  183. package/dist/core/QueryProcessor.js +0 -255
  184. package/dist/core/QueryView.d.ts +0 -79
  185. package/dist/core/QueryView.js +0 -218
  186. package/dist/core/StoreManager.d.ts +0 -112
  187. package/dist/core/StoreManager.js +0 -302
  188. package/dist/core/ViewRegistry.d.ts +0 -20
  189. package/dist/core/ViewRegistry.js +0 -55
  190. package/dist/core/index.d.ts +0 -33
  191. package/dist/core/index.js +0 -48
  192. package/dist/core/openIDBWithTimeout.d.ts +0 -65
  193. package/dist/core/openIDBWithTimeout.js +0 -153
  194. package/dist/core/queryUtils.d.ts +0 -45
  195. package/dist/core/queryUtils.js +0 -69
  196. package/dist/core/storeContract.d.ts +0 -145
  197. package/dist/core/storeContract.js +0 -12
  198. package/dist/docs/catalog.d.ts +0 -72
  199. package/dist/docs/catalog.js +0 -227
  200. package/dist/docs/index.d.ts +0 -10
  201. package/dist/docs/index.js +0 -10
  202. package/dist/environment.d.ts +0 -1
  203. package/dist/environment.js +0 -8
  204. package/dist/interfaces/index.d.ts +0 -311
  205. package/dist/interfaces/index.js +0 -9
  206. package/dist/keys/index.d.ts +0 -1
  207. package/dist/keys/index.js +0 -8
  208. package/dist/mutators/RecordingMutation.d.ts +0 -36
  209. package/dist/mutators/RecordingMutation.js +0 -182
  210. package/dist/mutators/Transaction.d.ts +0 -40
  211. package/dist/mutators/Transaction.js +0 -58
  212. package/dist/mutators/UndoManager.d.ts +0 -258
  213. package/dist/mutators/UndoManager.js +0 -658
  214. package/dist/mutators/defineMutators.d.ts +0 -60
  215. package/dist/mutators/defineMutators.js +0 -18
  216. package/dist/mutators/inverseOp.d.ts +0 -126
  217. package/dist/mutators/inverseOp.js +0 -71
  218. package/dist/mutators/mutateActions.d.ts +0 -45
  219. package/dist/mutators/mutateActions.js +0 -105
  220. package/dist/mutators/readerActions.d.ts +0 -33
  221. package/dist/mutators/readerActions.js +0 -57
  222. package/dist/mutators/undoApply.d.ts +0 -51
  223. package/dist/mutators/undoApply.js +0 -117
  224. package/dist/policy/index.d.ts +0 -21
  225. package/dist/policy/index.js +0 -20
  226. package/dist/query/client.d.ts +0 -61
  227. package/dist/query/client.js +0 -137
  228. package/dist/query/types.d.ts +0 -85
  229. package/dist/query/types.js +0 -16
  230. package/dist/react/AbloProvider.d.ts +0 -230
  231. package/dist/react/AbloProvider.js +0 -455
  232. package/dist/react/ClientSideSuspense.d.ts +0 -36
  233. package/dist/react/ClientSideSuspense.js +0 -17
  234. package/dist/react/DefaultFallback.d.ts +0 -24
  235. package/dist/react/DefaultFallback.js +0 -43
  236. package/dist/react/context.d.ts +0 -55
  237. package/dist/react/context.js +0 -29
  238. package/dist/react/index.d.ts +0 -61
  239. package/dist/react/index.js +0 -66
  240. package/dist/react/internalContext.d.ts +0 -33
  241. package/dist/react/internalContext.js +0 -3
  242. package/dist/react/useAblo.d.ts +0 -75
  243. package/dist/react/useAblo.js +0 -102
  244. package/dist/react/useCurrentUserId.d.ts +0 -22
  245. package/dist/react/useCurrentUserId.js +0 -34
  246. package/dist/react/useErrorListener.d.ts +0 -20
  247. package/dist/react/useErrorListener.js +0 -38
  248. package/dist/react/useMutationFailureListener.d.ts +0 -26
  249. package/dist/react/useMutationFailureListener.js +0 -38
  250. package/dist/react/useMutators.d.ts +0 -56
  251. package/dist/react/useMutators.js +0 -84
  252. package/dist/react/useReactive.d.ts +0 -35
  253. package/dist/react/useReactive.js +0 -123
  254. package/dist/react/useSyncStatus.d.ts +0 -59
  255. package/dist/react/useSyncStatus.js +0 -76
  256. package/dist/react/useUndoScope.d.ts +0 -34
  257. package/dist/react/useUndoScope.js +0 -81
  258. package/dist/schema/coordination.d.ts +0 -112
  259. package/dist/schema/coordination.js +0 -129
  260. package/dist/schema/ddl.d.ts +0 -97
  261. package/dist/schema/ddl.js +0 -491
  262. package/dist/schema/ddlLock.d.ts +0 -35
  263. package/dist/schema/ddlLock.js +0 -46
  264. package/dist/schema/diff.d.ts +0 -225
  265. package/dist/schema/diff.js +0 -289
  266. package/dist/schema/generate.d.ts +0 -19
  267. package/dist/schema/generate.js +0 -86
  268. package/dist/schema/index.d.ts +0 -41
  269. package/dist/schema/index.js +0 -76
  270. package/dist/schema/queries.d.ts +0 -201
  271. package/dist/schema/queries.js +0 -144
  272. package/dist/schema/select.d.ts +0 -40
  273. package/dist/schema/select.js +0 -87
  274. package/dist/schema/serialize.d.ts +0 -115
  275. package/dist/schema/serialize.js +0 -262
  276. package/dist/schema/sugar.d.ts +0 -109
  277. package/dist/schema/sugar.js +0 -83
  278. package/dist/schema/syncDeltaRow.d.ts +0 -6
  279. package/dist/schema/syncDeltaRow.js +0 -6
  280. package/dist/server/adapter.d.ts +0 -173
  281. package/dist/server/adapter.js +0 -18
  282. package/dist/server/commit.d.ts +0 -107
  283. package/dist/server/commit.js +0 -1
  284. package/dist/server/index.d.ts +0 -14
  285. package/dist/server/index.js +0 -2
  286. package/dist/server/readConfig.d.ts +0 -80
  287. package/dist/server/readConfig.js +0 -8
  288. package/dist/server/storageMode.d.ts +0 -23
  289. package/dist/server/storageMode.js +0 -17
  290. package/dist/source/adapter.d.ts +0 -81
  291. package/dist/source/adapter.js +0 -22
  292. package/dist/source/adapters/drizzle.d.ts +0 -48
  293. package/dist/source/adapters/drizzle.js +0 -219
  294. package/dist/source/adapters/kysely.d.ts +0 -42
  295. package/dist/source/adapters/kysely.js +0 -205
  296. package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
  297. package/dist/source/adapters/kyselyMutationCore.js +0 -125
  298. package/dist/source/adapters/memory.d.ts +0 -13
  299. package/dist/source/adapters/memory.js +0 -130
  300. package/dist/source/adapters/prisma.d.ts +0 -63
  301. package/dist/source/adapters/prisma.js +0 -202
  302. package/dist/source/conformance.d.ts +0 -37
  303. package/dist/source/conformance.js +0 -215
  304. package/dist/source/connector.d.ts +0 -95
  305. package/dist/source/connector.js +0 -266
  306. package/dist/source/connectorProtocol.d.ts +0 -154
  307. package/dist/source/connectorProtocol.js +0 -163
  308. package/dist/source/contract.d.ts +0 -195
  309. package/dist/source/contract.js +0 -164
  310. package/dist/source/factory.d.ts +0 -92
  311. package/dist/source/factory.js +0 -286
  312. package/dist/source/footprint.d.ts +0 -111
  313. package/dist/source/footprint.js +0 -0
  314. package/dist/source/idempotency.d.ts +0 -61
  315. package/dist/source/idempotency.js +0 -144
  316. package/dist/source/index.d.ts +0 -23
  317. package/dist/source/index.js +0 -30
  318. package/dist/source/migrations.d.ts +0 -21
  319. package/dist/source/migrations.js +0 -103
  320. package/dist/source/next.d.ts +0 -32
  321. package/dist/source/next.js +0 -25
  322. package/dist/source/pushQueue.d.ts +0 -134
  323. package/dist/source/pushQueue.js +0 -256
  324. package/dist/source/signing.d.ts +0 -92
  325. package/dist/source/signing.js +0 -162
  326. package/dist/source/types.d.ts +0 -401
  327. package/dist/source/types.js +0 -59
  328. package/dist/stores/ObjectStore.d.ts +0 -115
  329. package/dist/stores/ObjectStore.js +0 -393
  330. package/dist/stores/ObjectStoreContract.d.ts +0 -38
  331. package/dist/stores/ObjectStoreContract.js +0 -1
  332. package/dist/stores/SyncActionStore.d.ts +0 -97
  333. package/dist/stores/SyncActionStore.js +0 -504
  334. package/dist/stores/syncAction.d.ts +0 -26
  335. package/dist/stores/syncAction.js +0 -16
  336. package/dist/surface.d.ts +0 -36
  337. package/dist/surface.js +0 -75
  338. package/dist/sync/BootstrapFetcher.d.ts +0 -280
  339. package/dist/sync/BootstrapFetcher.js +0 -962
  340. package/dist/sync/ConnectionManager.d.ts +0 -8
  341. package/dist/sync/ConnectionManager.js +0 -8
  342. package/dist/sync/OnDemandLoader.d.ts +0 -228
  343. package/dist/sync/OnDemandLoader.js +0 -742
  344. package/dist/sync/SubscriptionManager.d.ts +0 -159
  345. package/dist/sync/SubscriptionManager.js +0 -243
  346. package/dist/sync/SyncWebSocket.d.ts +0 -173
  347. package/dist/sync/SyncWebSocket.js +0 -438
  348. package/dist/sync/awaitClaimGrant.d.ts +0 -6
  349. package/dist/sync/awaitClaimGrant.js +0 -6
  350. package/dist/sync/bootstrapApply.d.ts +0 -70
  351. package/dist/sync/bootstrapApply.js +0 -73
  352. package/dist/sync/commitFrames.d.ts +0 -8
  353. package/dist/sync/commitFrames.js +0 -8
  354. package/dist/sync/contextPorts.d.ts +0 -18
  355. package/dist/sync/contextPorts.js +0 -31
  356. package/dist/sync/createClaimStream.d.ts +0 -7
  357. package/dist/sync/createClaimStream.js +0 -7
  358. package/dist/sync/createPresenceStream.d.ts +0 -69
  359. package/dist/sync/createPresenceStream.js +0 -200
  360. package/dist/sync/createSnapshot.d.ts +0 -29
  361. package/dist/sync/createSnapshot.js +0 -118
  362. package/dist/sync/credentialLifecycle.d.ts +0 -7
  363. package/dist/sync/credentialLifecycle.js +0 -7
  364. package/dist/sync/deltaPipeline.d.ts +0 -113
  365. package/dist/sync/deltaPipeline.js +0 -261
  366. package/dist/sync/groupChange.d.ts +0 -113
  367. package/dist/sync/groupChange.js +0 -242
  368. package/dist/sync/participants.d.ts +0 -115
  369. package/dist/sync/participants.js +0 -344
  370. package/dist/sync/persistedPrefix.d.ts +0 -12
  371. package/dist/sync/persistedPrefix.js +0 -22
  372. package/dist/sync/schemaDrift.d.ts +0 -55
  373. package/dist/sync/schemaDrift.js +0 -53
  374. package/dist/sync/schemas.d.ts +0 -70
  375. package/dist/sync/schemas.js +0 -94
  376. package/dist/sync/syncCursor.d.ts +0 -40
  377. package/dist/sync/syncCursor.js +0 -55
  378. package/dist/sync/syncPlan.d.ts +0 -54
  379. package/dist/sync/syncPlan.js +0 -50
  380. package/dist/sync/wsFrameHandlers.d.ts +0 -8
  381. package/dist/sync/wsFrameHandlers.js +0 -8
  382. package/dist/testing/fixtures/bootstrap.d.ts +0 -49
  383. package/dist/testing/fixtures/bootstrap.js +0 -59
  384. package/dist/testing/fixtures/deltas.d.ts +0 -83
  385. package/dist/testing/fixtures/deltas.js +0 -136
  386. package/dist/testing/fixtures/httpResponses.d.ts +0 -70
  387. package/dist/testing/fixtures/httpResponses.js +0 -90
  388. package/dist/testing/fixtures/models.d.ts +0 -83
  389. package/dist/testing/fixtures/models.js +0 -272
  390. package/dist/testing/helpers/reactWrapper.d.ts +0 -69
  391. package/dist/testing/helpers/reactWrapper.js +0 -67
  392. package/dist/testing/helpers/syncEngineHarness.d.ts +0 -54
  393. package/dist/testing/helpers/syncEngineHarness.js +0 -73
  394. package/dist/testing/helpers/wait.d.ts +0 -30
  395. package/dist/testing/helpers/wait.js +0 -49
  396. package/dist/testing/index.d.ts +0 -23
  397. package/dist/testing/index.js +0 -33
  398. package/dist/testing/mocks/FakeDatabase.d.ts +0 -18
  399. package/dist/testing/mocks/FakeDatabase.js +0 -10
  400. package/dist/testing/mocks/MockMutationExecutor.d.ts +0 -87
  401. package/dist/testing/mocks/MockMutationExecutor.js +0 -186
  402. package/dist/testing/mocks/MockNetworkMonitor.d.ts +0 -20
  403. package/dist/testing/mocks/MockNetworkMonitor.js +0 -46
  404. package/dist/testing/mocks/MockSyncContext.d.ts +0 -51
  405. package/dist/testing/mocks/MockSyncContext.js +0 -72
  406. package/dist/testing/mocks/MockSyncStore.d.ts +0 -88
  407. package/dist/testing/mocks/MockSyncStore.js +0 -171
  408. package/dist/testing/mocks/MockWebSocket.d.ts +0 -71
  409. package/dist/testing/mocks/MockWebSocket.js +0 -118
  410. package/dist/transaction/ablo.d.ts +0 -88
  411. package/dist/transaction/ablo.js +0 -33
  412. package/dist/transaction/auth/apiKey.d.ts +0 -152
  413. package/dist/transaction/auth/apiKey.js +0 -419
  414. package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
  415. package/dist/transaction/auth/bootstrapScope.js +0 -1
  416. package/dist/transaction/auth/capability.d.ts +0 -177
  417. package/dist/transaction/auth/capability.js +0 -199
  418. package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
  419. package/dist/transaction/auth/credentialEndpoint.js +0 -86
  420. package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
  421. package/dist/transaction/auth/credentialPolicy.js +0 -125
  422. package/dist/transaction/auth/credentialSource.d.ts +0 -30
  423. package/dist/transaction/auth/credentialSource.js +0 -55
  424. package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
  425. package/dist/transaction/auth/hostedEndpoints.js +0 -21
  426. package/dist/transaction/auth/identity.d.ts +0 -55
  427. package/dist/transaction/auth/identity.js +0 -210
  428. package/dist/transaction/auth/index.d.ts +0 -162
  429. package/dist/transaction/auth/index.js +0 -304
  430. package/dist/transaction/auth/schemas.d.ts +0 -59
  431. package/dist/transaction/auth/schemas.js +0 -85
  432. package/dist/transaction/auth/sessionMint.d.ts +0 -28
  433. package/dist/transaction/auth/sessionMint.js +0 -85
  434. package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -49
  435. package/dist/transaction/coordination/awaitClaimGrant.js +0 -112
  436. package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -50
  437. package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -88
  438. package/dist/transaction/coordination/claimMeta.d.ts +0 -49
  439. package/dist/transaction/coordination/claimMeta.js +0 -52
  440. package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
  441. package/dist/transaction/coordination/createClaimStream.js +0 -475
  442. package/dist/transaction/coordination/events.d.ts +0 -74
  443. package/dist/transaction/coordination/events.js +0 -7
  444. package/dist/transaction/coordination/index.d.ts +0 -19
  445. package/dist/transaction/coordination/index.js +0 -44
  446. package/dist/transaction/coordination/locator.d.ts +0 -83
  447. package/dist/transaction/coordination/locator.js +0 -82
  448. package/dist/transaction/coordination/schema.d.ts +0 -1473
  449. package/dist/transaction/coordination/schema.js +0 -1013
  450. package/dist/transaction/coordination/targetConflict.d.ts +0 -2
  451. package/dist/transaction/coordination/targetConflict.js +0 -103
  452. package/dist/transaction/coordination/trace.d.ts +0 -78
  453. package/dist/transaction/coordination/trace.js +0 -138
  454. package/dist/transaction/durableWrites.d.ts +0 -62
  455. package/dist/transaction/durableWrites.js +0 -71
  456. package/dist/transaction/environment.d.ts +0 -105
  457. package/dist/transaction/environment.js +0 -108
  458. package/dist/transaction/errorCodes.d.ts +0 -403
  459. package/dist/transaction/errorCodes.js +0 -480
  460. package/dist/transaction/errors.d.ts +0 -428
  461. package/dist/transaction/errors.js +0 -686
  462. package/dist/transaction/index.d.ts +0 -20
  463. package/dist/transaction/index.js +0 -20
  464. package/dist/transaction/keys/index.d.ts +0 -87
  465. package/dist/transaction/keys/index.js +0 -207
  466. package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
  467. package/dist/transaction/log/syncDeltaRow.js +0 -95
  468. package/dist/transaction/logPosition.d.ts +0 -97
  469. package/dist/transaction/logPosition.js +0 -125
  470. package/dist/transaction/logger.d.ts +0 -16
  471. package/dist/transaction/logger.js +0 -7
  472. package/dist/transaction/observability.d.ts +0 -53
  473. package/dist/transaction/observability.js +0 -19
  474. package/dist/transaction/persistence.d.ts +0 -12
  475. package/dist/transaction/persistence.js +0 -11
  476. package/dist/transaction/plugin.d.ts +0 -192
  477. package/dist/transaction/plugin.js +0 -87
  478. package/dist/transaction/policy/types.d.ts +0 -217
  479. package/dist/transaction/policy/types.js +0 -126
  480. package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
  481. package/dist/transaction/resources/functionalUpdate.js +0 -87
  482. package/dist/transaction/resources/httpResources.d.ts +0 -266
  483. package/dist/transaction/resources/httpResources.js +0 -7
  484. package/dist/transaction/resources/modelOperations.d.ts +0 -319
  485. package/dist/transaction/resources/modelOperations.js +0 -12
  486. package/dist/transaction/resources/mutationOptions.d.ts +0 -66
  487. package/dist/transaction/resources/mutationOptions.js +0 -9
  488. package/dist/transaction/resources/where.d.ts +0 -85
  489. package/dist/transaction/resources/where.js +0 -70
  490. package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
  491. package/dist/transaction/resources/writeOptionsSchema.js +0 -73
  492. package/dist/transaction/schema/field.d.ts +0 -126
  493. package/dist/transaction/schema/field.js +0 -265
  494. package/dist/transaction/schema/loadStrategy.d.ts +0 -45
  495. package/dist/transaction/schema/loadStrategy.js +0 -46
  496. package/dist/transaction/schema/model.d.ts +0 -379
  497. package/dist/transaction/schema/model.js +0 -123
  498. package/dist/transaction/schema/openapi.d.ts +0 -57
  499. package/dist/transaction/schema/openapi.js +0 -340
  500. package/dist/transaction/schema/relation.d.ts +0 -199
  501. package/dist/transaction/schema/relation.js +0 -104
  502. package/dist/transaction/schema/residency.d.ts +0 -29
  503. package/dist/transaction/schema/residency.js +0 -25
  504. package/dist/transaction/schema/roles.d.ts +0 -249
  505. package/dist/transaction/schema/roles.js +0 -230
  506. package/dist/transaction/schema/schema.d.ts +0 -324
  507. package/dist/transaction/schema/schema.js +0 -305
  508. package/dist/transaction/schema/tenancy.d.ts +0 -139
  509. package/dist/transaction/schema/tenancy.js +0 -190
  510. package/dist/transaction/transactionLayer.d.ts +0 -82
  511. package/dist/transaction/transactionLayer.js +0 -24
  512. package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
  513. package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
  514. package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
  515. package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
  516. package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
  517. package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
  518. package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
  519. package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
  520. package/dist/transaction/transport/commitFrames.d.ts +0 -90
  521. package/dist/transaction/transport/commitFrames.js +0 -134
  522. package/dist/transaction/transport/connectionManager.d.ts +0 -215
  523. package/dist/transaction/transport/connectionManager.js +0 -673
  524. package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
  525. package/dist/transaction/transport/credentialLifecycle.js +0 -324
  526. package/dist/transaction/transport/heartbeat.d.ts +0 -65
  527. package/dist/transaction/transport/heartbeat.js +0 -93
  528. package/dist/transaction/transport/httpClient.d.ts +0 -123
  529. package/dist/transaction/transport/httpClient.js +0 -145
  530. package/dist/transaction/transport/httpOptions.d.ts +0 -33
  531. package/dist/transaction/transport/httpOptions.js +0 -12
  532. package/dist/transaction/transport/httpTransport.d.ts +0 -8
  533. package/dist/transaction/transport/httpTransport.js +0 -1276
  534. package/dist/transaction/transport/networkProbe.d.ts +0 -84
  535. package/dist/transaction/transport/networkProbe.js +0 -207
  536. package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
  537. package/dist/transaction/transport/wsFrameHandlers.js +0 -429
  538. package/dist/transaction/transport/wsTransport.d.ts +0 -576
  539. package/dist/transaction/transport/wsTransport.js +0 -1017
  540. package/dist/transaction/types/assertExact.d.ts +0 -17
  541. package/dist/transaction/types/assertExact.js +0 -1
  542. package/dist/transaction/types/global.d.ts +0 -107
  543. package/dist/transaction/types/global.js +0 -40
  544. package/dist/transaction/types/index.d.ts +0 -205
  545. package/dist/transaction/types/index.js +0 -56
  546. package/dist/transaction/types/modelData.d.ts +0 -10
  547. package/dist/transaction/types/modelData.js +0 -9
  548. package/dist/transaction/types/participant.d.ts +0 -20
  549. package/dist/transaction/types/participant.js +0 -10
  550. package/dist/transaction/types/streams.d.ts +0 -540
  551. package/dist/transaction/types/streams.js +0 -11
  552. package/dist/transaction/utils/asyncIterator.d.ts +0 -34
  553. package/dist/transaction/utils/asyncIterator.js +0 -135
  554. package/dist/transaction/utils/duration.d.ts +0 -25
  555. package/dist/transaction/utils/duration.js +0 -45
  556. package/dist/transaction/utils/json.d.ts +0 -57
  557. package/dist/transaction/utils/json.js +0 -276
  558. package/dist/transaction/wire/accountResponses.d.ts +0 -351
  559. package/dist/transaction/wire/accountResponses.js +0 -255
  560. package/dist/transaction/wire/auth.d.ts +0 -49
  561. package/dist/transaction/wire/auth.js +0 -57
  562. package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
  563. package/dist/transaction/wire/bootstrapReason.js +0 -8
  564. package/dist/transaction/wire/claimEvent.d.ts +0 -76
  565. package/dist/transaction/wire/claimEvent.js +0 -73
  566. package/dist/transaction/wire/claims.d.ts +0 -463
  567. package/dist/transaction/wire/claims.js +0 -229
  568. package/dist/transaction/wire/commit.d.ts +0 -603
  569. package/dist/transaction/wire/commit.js +0 -321
  570. package/dist/transaction/wire/delta.d.ts +0 -250
  571. package/dist/transaction/wire/delta.js +0 -147
  572. package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
  573. package/dist/transaction/wire/errorEnvelope.js +0 -123
  574. package/dist/transaction/wire/feedCursor.d.ts +0 -60
  575. package/dist/transaction/wire/feedCursor.js +0 -82
  576. package/dist/transaction/wire/feedEvent.d.ts +0 -177
  577. package/dist/transaction/wire/feedEvent.js +0 -39
  578. package/dist/transaction/wire/frames.d.ts +0 -194
  579. package/dist/transaction/wire/frames.js +0 -50
  580. package/dist/transaction/wire/inboundFrames.d.ts +0 -552
  581. package/dist/transaction/wire/inboundFrames.js +0 -116
  582. package/dist/transaction/wire/index.d.ts +0 -50
  583. package/dist/transaction/wire/index.js +0 -74
  584. package/dist/transaction/wire/listEnvelope.d.ts +0 -37
  585. package/dist/transaction/wire/listEnvelope.js +0 -42
  586. package/dist/transaction/wire/modelResponses.d.ts +0 -85
  587. package/dist/transaction/wire/modelResponses.js +0 -43
  588. package/dist/transaction/wire/protocol.d.ts +0 -38
  589. package/dist/transaction/wire/protocol.js +0 -38
  590. package/dist/transaction/wire/protocolVersion.d.ts +0 -73
  591. package/dist/transaction/wire/protocolVersion.js +0 -83
  592. package/dist/transactions/mutations/MutationQueue.d.ts +0 -655
  593. package/dist/transactions/mutations/MutationQueue.js +0 -2797
  594. package/dist/transactions/mutations/MutationStore.d.ts +0 -20
  595. package/dist/transactions/mutations/MutationStore.js +0 -53
  596. package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
  597. package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
  598. package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
  599. package/dist/transactions/mutations/coalesceRules.js +0 -140
  600. package/dist/transactions/mutations/commitLatency.d.ts +0 -52
  601. package/dist/transactions/mutations/commitLatency.js +0 -130
  602. package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
  603. package/dist/transactions/mutations/commitOutboxStore.js +0 -26
  604. package/dist/transactions/mutations/commitPayload.d.ts +0 -164
  605. package/dist/transactions/mutations/commitPayload.js +0 -152
  606. package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -59
  607. package/dist/transactions/mutations/deltaConfirmation.js +0 -233
  608. package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
  609. package/dist/transactions/mutations/durableWriteStore.js +0 -12
  610. package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
  611. package/dist/transactions/mutations/optimisticApply.js +0 -65
  612. package/dist/transactions/mutations/replayValidation.d.ts +0 -186
  613. package/dist/transactions/mutations/replayValidation.js +0 -163
  614. package/dist/utils/mobxSetup.d.ts +0 -53
  615. package/dist/utils/mobxSetup.js +0 -330
  616. package/dist/webhooks/events.d.ts +0 -43
  617. package/dist/webhooks/events.js +0 -42
  618. package/dist/webhooks/index.d.ts +0 -8
  619. package/dist/webhooks/index.js +0 -8
  620. package/dist/wire/index.d.ts +0 -1
  621. package/dist/wire/index.js +0 -8
  622. package/docs/interaction-model.md +0 -99
@@ -1,311 +0,0 @@
1
- /**
2
- * The interfaces you implement to plug the SDK into your own environment.
3
- *
4
- * The SDK depends on these contracts rather than any specific framework, so you
5
- * provide the concrete implementations — logging, observability, analytics,
6
- * session-error detection, online-status checks, and the transport that carries
7
- * mutations to your backend. The SDK ships sensible no-op defaults where it can.
8
- */
9
- import type { MutationCommitResultInput } from '../transaction/wire/commit.js';
10
- import type { OnStaleMode } from '../transaction/coordination/schema.js';
11
- export type { ClaimEvent, ConflictEvent } from '../transaction/coordination/events.js';
12
- import type { CoordinationObservability } from '../transaction/observability.js';
13
- export type { CoordinationObservability } from '../transaction/observability.js';
14
- export type { Logger } from '../transaction/logger.js';
15
- import type { Logger } from '../transaction/logger.js';
16
- export type { BreadcrumbLevel, BreadcrumbCategory, WebSocketErrorDetails, TransportObservability, } from '../transaction/observability.js';
17
- import type { BreadcrumbCategory, TransportObservability } from '../transaction/observability.js';
18
- export interface RollbackDetails {
19
- transactionType: string;
20
- modelName: string;
21
- modelId: string;
22
- reason: string;
23
- error?: string;
24
- connectionState: string;
25
- }
26
- export interface TransactionFailureDetails {
27
- context: string;
28
- modelName?: string;
29
- modelId?: string;
30
- transactionId?: string;
31
- error: Error | string;
32
- }
33
- export interface BootstrapFailureDetails {
34
- attempt?: number;
35
- type?: string;
36
- navigatorOnline?: boolean;
37
- }
38
- export interface ReconciliationDetails {
39
- reason: string;
40
- model: string;
41
- modelId: string;
42
- syncIdNeeded?: number;
43
- lastSeenSyncId: number;
44
- retryCount: number;
45
- connectionState?: string;
46
- }
47
- export interface DeltaRetryExhaustedDetails {
48
- txId: string;
49
- model: string;
50
- modelId: string;
51
- retryCount: number;
52
- syncIdNeeded?: number;
53
- }
54
- export interface SelfHealingDetails {
55
- modelName: string;
56
- modelId: string;
57
- field: string;
58
- action: string;
59
- }
60
- export interface CommitZeroSyncIdDetails {
61
- operationCount: number;
62
- operations: string[];
63
- }
64
- /** Span attributes for performance monitoring */
65
- export type SpanAttributes = Record<string, string | number | boolean | undefined>;
66
- /**
67
- * The observability hooks the SDK calls to report its own lifecycle. The SDK
68
- * ships a no-op default; provide your own to forward these events to a monitoring
69
- * tool such as Sentry, Datadog, or OpenTelemetry.
70
- */
71
- export interface ObservabilityProvider extends CoordinationObservability, TransportObservability {
72
- /** Set user/org context for error grouping */
73
- setContext(userId: string, organizationId: string): void;
74
- /** Update connection state tag */
75
- setConnectionState(state: 'connected' | 'disconnected' | 'connecting'): void;
76
- /** Capture optimistic rollback (data reverted) */
77
- captureRollback(details: RollbackDetails): void;
78
- /**
79
- * Capture permanent mutation failure. Named `captureTransactionFailure`
80
- * before 0.35.0; the rename is announced in that release note rather than
81
- * aliased, because this member is required — a provider still carrying the
82
- * old spelling fails to satisfy the interface and the compiler names the
83
- * member, which an optional alias would only have hidden.
84
- */
85
- captureMutationFailure(details: TransactionFailureDetails): void;
86
- /** Capture bootstrap failure */
87
- captureBootstrapFailure(error: Error | unknown, details?: BootstrapFailureDetails): void;
88
- /** Capture reconciliation needed (delta confirmation timeout) */
89
- captureReconciliation(details: ReconciliationDetails): void;
90
- /** Capture delta retry exhausted */
91
- captureDeltaRetryExhausted(details: DeltaRetryExhaustedDetails): void;
92
- /** Capture self-healing event */
93
- captureSelfHealing(details: SelfHealingDetails): void;
94
- /** Capture commit returning lastSyncId: 0 */
95
- captureCommitZeroSyncId(details: CommitZeroSyncIdDetails): void;
96
- /** Wrap a synchronous function in a performance span */
97
- startSpan<T>(name: string, op: string, fn: () => T, attributes?: SpanAttributes): T;
98
- /** Wrap an async function in a performance span */
99
- startSpanAsync<T>(name: string, op: string, fn: () => Promise<T>, attributes?: SpanAttributes): Promise<T>;
100
- }
101
- export interface Analytics {
102
- capture(event: string, properties?: Record<string, unknown>): void;
103
- }
104
- /**
105
- * Detects whether an error represents an expired/invalid session.
106
- * The SDK uses this to decide whether to redirect to login vs retry.
107
- */
108
- export interface SessionErrorDetector {
109
- /** Check if an error is a session error (401/403) */
110
- isSessionError(error: unknown): boolean;
111
- /** Check if an HTTP response status indicates a session error */
112
- isSessionErrorResponse(status: number, body?: string): boolean;
113
- }
114
- export interface OnlineStatusProvider {
115
- /** Returns true if the device is currently online */
116
- isOnline(): boolean;
117
- }
118
- export interface ModelDebugLoggerContract {
119
- logOperation(info: {
120
- modelName: string;
121
- modelId?: string;
122
- operation: string;
123
- fields?: Record<string, unknown>;
124
- }): void;
125
- logDebug(message: string): void;
126
- logError(modelName: string, operation: string, message: string, data?: unknown): void;
127
- logCreation(modelName: string, data: unknown, constructor: unknown): void;
128
- logObservableSetup(modelName: string, observableProps: string[], computedProps: string[]): void;
129
- }
130
- /**
131
- * Result returned by an injected mutation executor. The input type is inferred
132
- * from the runtime compatibility schema: legacy `{lastSyncId}` remains valid,
133
- * while every explicit queued result requires a WAL correlation.
134
- */
135
- export type CommitResult = MutationCommitResultInput;
136
- export type { MutationOptions } from '../transaction/resources/mutationOptions.js';
137
- import type { MutationOptions } from '../transaction/resources/mutationOptions.js';
138
- /**
139
- * The subset of {@link MutationOptions} that travels with each write as it is
140
- * queued offline and sent on the wire. A single shared type keeps the public
141
- * parameters, the offline queue, and the wire format from diverging. `wait` and
142
- * `claim` are deliberately absent: both are resolved on the client before a write
143
- * is staged, so neither reaches this layer.
144
- */
145
- export type WriteOptions = Pick<MutationOptions, 'readAt' | 'onStale' | 'idempotencyKey' | 'label' | 'fenceToken'>;
146
- /** A single mutation within a batch. Its `options` travel with it so the server
147
- * can cache and replay the operation for idempotent retries. */
148
- export interface MutationOperation {
149
- type: string;
150
- model: string;
151
- id: string;
152
- input?: Record<string, unknown>;
153
- /**
154
- * A client-side id for this single operation. The server stamps it onto the
155
- * resulting `sync_deltas.transaction_id`, so when the confirming delta arrives
156
- * back over the sync stream the client can recognize it as an echo of its own
157
- * optimistic write and skip re-applying it locally.
158
- *
159
- * This is distinct from the batch-level `client_tx_id` that idempotency uses:
160
- * that key de-duplicates a retried batch (a request-level cache), whereas this
161
- * id identifies one row within a batch (for echo matching). Both can appear on
162
- * the wire at once.
163
- */
164
- transactionId?: string;
165
- readAt?: number | null;
166
- onStale?: OnStaleMode | null;
167
- /**
168
- * The fencing token (Option B) carried on the wire for this op — the held
169
- * claim's token, validated against the entity's high-water at commit.
170
- */
171
- fenceToken?: number | null;
172
- /**
173
- * Per-operation idempotency and audit metadata. `idempotencyKey` is also the
174
- * cache key the server uses to de-duplicate retries; `label` is stored for
175
- * debugging. These are the only {@link MutationOptions} fields sent on the wire.
176
- */
177
- options?: Pick<MutationOptions, 'idempotencyKey' | 'label'>;
178
- }
179
- /**
180
- * The transport that carries mutations to your backend. The SDK calls the
181
- * methods on this interface; you implement them over whatever transport you use —
182
- * an HTTP API, a WebSocket, or something else.
183
- */
184
- export interface MutationExecutor {
185
- /**
186
- * Commits a batch of mutations atomically and returns the sync
187
- * acknowledgement. The `options` argument applies to the whole batch, while
188
- * per-operation `idempotencyKey` and `label` live on each
189
- * {@link MutationOperation}. The method name matches the `{ type: 'commit' }`
190
- * frame on the wire.
191
- */
192
- commit(operations: MutationOperation[], options?: MutationOptions): Promise<CommitResult>;
193
- /** Execute a create mutation for a specific model */
194
- executeCreate(modelName: string, id: string, input: Record<string, unknown>, clientMutationId?: string, options?: MutationOptions): Promise<void>;
195
- /** Execute an update mutation for a specific model */
196
- executeUpdate(modelName: string, modelId: string, data: Record<string, unknown>, clientMutationId?: string, options?: MutationOptions): Promise<CommitResult | null>;
197
- /** Execute a delete mutation for a specific model */
198
- executeDelete(modelName: string, modelId: string, clientMutationId?: string, options?: MutationOptions): Promise<void>;
199
- /** Execute an archive mutation for a specific model */
200
- executeArchive(modelName: string, modelId: string, clientMutationId?: string, options?: MutationOptions): Promise<void>;
201
- /** Execute an unarchive mutation for a specific model */
202
- executeUnarchive(modelName: string, modelId: string, clientMutationId?: string, options?: MutationOptions): Promise<void>;
203
- /** Upload an attachment (optional, not all consumers need this) */
204
- uploadAttachment?(id: string, input: Record<string, unknown>): Promise<{
205
- url: string;
206
- }>;
207
- /** Batch upload attachments (optional) */
208
- batchUploadAttachments?(items: {
209
- id: string;
210
- input: Record<string, unknown>;
211
- }[]): Promise<{
212
- id: string;
213
- url: string;
214
- }[]>;
215
- /** Delete a subscription entity */
216
- deleteSubscription?(entityType: string, entityId: string, txId: string): Promise<void>;
217
- /** Delete a favorite entity */
218
- deleteFavorite?(modelId: string, txId: string): Promise<void>;
219
- /** Register a callback for session expiry detection */
220
- onSessionExpired?(callback: () => void): void;
221
- }
222
- /**
223
- * Application-specific configuration for the sync engine, describing how your
224
- * models relate so the engine can order and merge writes correctly.
225
- */
226
- export interface RuntimeConfig {
227
- /**
228
- * The order in which to create models, so a row is never inserted before the
229
- * parent row its foreign key points at. Keyed by each model's type name, with
230
- * lower numbers created first, so parents precede children. The engine fills
231
- * this in automatically by walking the schema's `belongsTo` relations — a model
232
- * with no parents gets 10, its children 20, their children 30, and so on,
233
- * stepping by 10 to leave room for overrides. You rarely set this by hand;
234
- * override it only when a relation the schema can't see (such as a polymorphic
235
- * foreign key) imposes an ordering the engine wouldn't otherwise know about.
236
- */
237
- modelCreatePriority: ReadonlyMap<string, number>;
238
- /**
239
- * The create priority for a model not listed in {@link modelCreatePriority}.
240
- * It sits in the middle of the range, so an unlisted model is created after
241
- * declared parents but before declared grandchildren — a safe default.
242
- */
243
- defaultCreatePriority: number;
244
- /**
245
- * The priority for update, delete, archive, and unarchive operations. These
246
- * need no ordering among themselves — the row already exists when they run —
247
- * so this is set higher than any create priority to ensure creates go first.
248
- */
249
- defaultNonCreatePriority: number;
250
- /**
251
- * Fields to preserve when merging a partial update into the local store. A
252
- * change usually carries only the fields that changed; listing a model's
253
- * essential fields here keeps them from being dropped during that merge.
254
- * For example: `{ Task: ['title', 'projectId'], Section: ['reportId', 'order'] }`.
255
- */
256
- essentialFields: Readonly<Record<string, readonly string[]>>;
257
- /**
258
- * A fallback map from class name to model name, used to resolve a model's name
259
- * when the usual lookup fails — for instance, when a bundler has minified the
260
- * class names. For example: `{ TaskModel: 'Task', ProjectModel: 'Project' }`.
261
- */
262
- classNameFallbackMap: Readonly<Record<string, string>>;
263
- /**
264
- * The content hash of the schema this client was built against — the same hash
265
- * the `ablo push` command and the server compute. It exists only to detect
266
- * schema drift: if the server reports a different active hash when the client
267
- * connects, the SDK warns you to run `ablo push`, so drift surfaces as a clear
268
- * message rather than a confusing database error later. It is advisory, not
269
- * enforced.
270
- */
271
- expectedSchemaHash?: string;
272
- /**
273
- * Set only when the bound schema is a projection (`selectModels`/`omitModels`):
274
- * the content hash of the full source schema the subset was cut from. A subset
275
- * hashes differently from its full schema, so without this a projection-bound
276
- * client always reports drift against a server running the full schema. The
277
- * drift check treats the client as in-sync when the server's active hash
278
- * matches either `expectedSchemaHash` or this source hash. Advisory, like the
279
- * hash above.
280
- */
281
- expectedSourceSchemaHash?: string;
282
- /**
283
- * Per-model content hashes of the schema this client was built against,
284
- * keyed by schema key (`tasks` → hash of that model's serialized JSON). The
285
- * semantic layer of the drift check: on a whole-schema mismatch the client
286
- * compares only the models IT declares against the server's per-model
287
- * surface, so a purely additive server-side change (new models this build
288
- * never references) is silence, and real divergence names the exact models.
289
- * Advisory, like the hashes above.
290
- */
291
- expectedModelHashes?: Readonly<Record<string, string>>;
292
- }
293
- /**
294
- * Extends the WebSocket event map with your own collaboration events, such as
295
- * cursor positions or selections, beyond the core delta, presence, and
296
- * bootstrap events.
297
- */
298
- export interface WebSocketEventConfig {
299
- /** Additional event type names beyond the core delta/presence/bootstrap events */
300
- customEventTypes?: readonly string[];
301
- }
302
- /** @deprecated Renamed to {@link Logger}. Removed in 0.36.0. */
303
- export type SyncLogger = Logger;
304
- /** @deprecated Renamed to {@link ObservabilityProvider}. Removed in 0.36.0. */
305
- export type SyncObservabilityProvider = ObservabilityProvider;
306
- /** @deprecated Renamed to {@link Analytics}. Removed in 0.36.0. */
307
- export type SyncAnalytics = Analytics;
308
- /** @deprecated Renamed to {@link RuntimeConfig}. Removed in 0.36.0. */
309
- export type SyncEngineConfig = RuntimeConfig;
310
- /** @deprecated Renamed to {@link BreadcrumbCategory}. Removed in 0.36.0. */
311
- export type SyncBreadcrumbCategory = BreadcrumbCategory;
@@ -1,9 +0,0 @@
1
- /**
2
- * The interfaces you implement to plug the SDK into your own environment.
3
- *
4
- * The SDK depends on these contracts rather than any specific framework, so you
5
- * provide the concrete implementations — logging, observability, analytics,
6
- * session-error detection, online-status checks, and the transport that carries
7
- * mutations to your backend. The SDK ships sensible no-op defaults where it can.
8
- */
9
- export {};
@@ -1 +0,0 @@
1
- export * from '../transaction/keys/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
- // `keys/index.js` keep working; rewire to `@ablo/transaction/keys`
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/keys/index.js';
@@ -1,36 +0,0 @@
1
- /**
2
- * Wraps a {@link Transaction} and records the inverse of every write so the
3
- * change can be undone. Each write is observed just before it runs, to snapshot
4
- * the previous state, and just after, to record the forward operation for redo.
5
- *
6
- * The mutator sees an ordinary `Transaction<S>` and is unaware it is being
7
- * recorded. When the mutator returns, the caller reads
8
- * {@link RecordingMutation.getEntry} and pushes the result onto the active
9
- * {@link UndoScope}.
10
- *
11
- * The snapshots are taken here rather than in the undo scope because they must
12
- * exist before the write lands: the inverse of an update needs the field's
13
- * previous values, and the inverse of a delete needs the full row. The inverse
14
- * of a create is just a delete by id, but that id is known only after creation,
15
- * since the schema generates one when the caller omits it.
16
- */
17
- import type { Schema } from '../transaction/schema/schema.js';
18
- import type { SyncStoreContract } from '../react/context.js';
19
- import type { Transaction } from './Transaction.js';
20
- import type { UndoEntry } from './UndoManager.js';
21
- export interface RecordingMutation<S extends Schema> {
22
- /** The wrapped transaction — pass this into the mutator. */
23
- tx: Transaction<S>;
24
- /**
25
- * Finalize the recording. Returns the captured entry or `null` if the
26
- * mutator made no reversible writes (skip the push to save memory).
27
- */
28
- getEntry: (label?: string) => UndoEntry | null;
29
- }
30
- /**
31
- * Builds a transaction that records the forward and inverse of each write as it
32
- * runs. Use this only when the mutator should be undoable; a read-only or
33
- * side-effect-only mutator should call {@link createTransaction} directly to skip
34
- * the bookkeeping.
35
- */
36
- export declare function createRecordingMutation<S extends Schema>(schema: S, store: SyncStoreContract, organizationId: string): RecordingMutation<S>;
@@ -1,182 +0,0 @@
1
- /**
2
- * Wraps a {@link Transaction} and records the inverse of every write so the
3
- * change can be undone. Each write is observed just before it runs, to snapshot
4
- * the previous state, and just after, to record the forward operation for redo.
5
- *
6
- * The mutator sees an ordinary `Transaction<S>` and is unaware it is being
7
- * recorded. When the mutator returns, the caller reads
8
- * {@link RecordingMutation.getEntry} and pushes the result onto the active
9
- * {@link UndoScope}.
10
- *
11
- * The snapshots are taken here rather than in the undo scope because they must
12
- * exist before the write lands: the inverse of an update needs the field's
13
- * previous values, and the inverse of a delete needs the full row. The inverse
14
- * of a create is just a delete by id, but that id is known only after creation,
15
- * since the schema generates one when the caller omits it.
16
- */
17
- import { createTransaction } from './Transaction.js';
18
- /**
19
- * Builds a transaction that records the forward and inverse of each write as it
20
- * runs. Use this only when the mutator should be undoable; a read-only or
21
- * side-effect-only mutator should call {@link createTransaction} directly to skip
22
- * the bookkeeping.
23
- */
24
- export function createRecordingMutation(schema, store, organizationId) {
25
- const inverses = [];
26
- const forwards = [];
27
- const inner = createTransaction(schema, store, organizationId);
28
- // Wrap mutations with a Proxy that intercepts each model key's
29
- // methods. We keep `inner.read` as-is — reads don't need recording.
30
- const mutateProxy = new Proxy({}, {
31
- get(_target, prop) {
32
- if (typeof prop !== 'string')
33
- return undefined;
34
- const innerMutate = inner.mutations[prop];
35
- if (!innerMutate)
36
- return innerMutate;
37
- return wrapMutateForKey(prop, innerMutate, store, inverses, forwards);
38
- },
39
- });
40
- return {
41
- tx: { mutations: mutateProxy, read: inner.read },
42
- getEntry: (label) => {
43
- if (inverses.length === 0)
44
- return null;
45
- // Undo applies the inverses in reverse order of the forward writes; redo
46
- // applies the forwards in their original order.
47
- return { label, inverses: [...inverses].reverse(), forwards: [...forwards] };
48
- },
49
- };
50
- }
51
- // ── Per-key wrapper ────────────────────────────────────────────────────────
52
- function wrapMutateForKey(modelKey, mutate, store, inverses, forwards) {
53
- const snapshot = (id) => {
54
- const model = store.pool.get(id);
55
- if (!model)
56
- return null;
57
- // toJSON produces a plain object suitable for re-creating the row. The
58
- // delete→create inverse needs every field, which is exactly what it returns.
59
- return model.toJSON();
60
- };
61
- // Captures the before-image for an undo inverse, delegating to the model's
62
- // shared `capturePreviousValues`. `fallbackToLive` is enabled here so that a
63
- // field that was neither pre-mutated nor present in the original snapshot falls
64
- // back to its current value as a last resort.
65
- const snapshotFields = (id, fieldNames) => {
66
- const model = store.pool.get(id);
67
- if (!model)
68
- return null;
69
- return model.capturePreviousValues(fieldNames, { fallbackToLive: true });
70
- };
71
- // After an update succeeds, clear the modified-field markers it was snapshotted
72
- // from, so the next write to the same row sees this update's result as its
73
- // baseline rather than the older pre-update value. The queue has already taken
74
- // its own frozen copy, so clearing here is safe.
75
- const consumeModifiedFields = (id, fieldNames) => {
76
- store.pool.get(id)?.consumeModifiedFields(fieldNames);
77
- };
78
- return {
79
- // Overloaded — single row or array. The recorder dispatches the
80
- // matching forward/inverse op shape (`create`/`createMany`,
81
- // `update`/`updateMany`, `delete`/`deleteMany`) so the persisted
82
- // undo entry is symmetric with what was originally invoked.
83
- create: (async (data) => {
84
- if (Array.isArray(data)) {
85
- const created = await mutate.create(data);
86
- const withIds = created.map((m, i) => ({
87
- ...data[i],
88
- id: m.id,
89
- }));
90
- const ids = created.map((m) => m.id);
91
- forwards.push({ kind: 'createMany', modelKey, data: withIds });
92
- inverses.push({ kind: 'deleteMany', modelKey, ids });
93
- return created;
94
- }
95
- const created = await mutate.create(data);
96
- const id = created.id;
97
- forwards.push({
98
- kind: 'create',
99
- modelKey,
100
- data: { ...data, id },
101
- });
102
- inverses.push({ kind: 'delete', modelKey, id });
103
- return created;
104
- }),
105
- update: (async (patch) => {
106
- if (Array.isArray(patch)) {
107
- // Snapshot every row's previous values before applying any patch: later
108
- // patches in the same list would corrupt an earlier one's inverse if the
109
- // snapshots were taken lazily.
110
- const prevPatches = [];
111
- for (const p of patch) {
112
- const fields = Object.keys(p).filter((k) => k !== 'id');
113
- const prev = snapshotFields(p.id, fields);
114
- if (prev)
115
- prevPatches.push({ id: p.id, ...prev });
116
- }
117
- const updated = await mutate.update(patch);
118
- const forwardPatches = patch.map((p) => ({ ...p }));
119
- for (const p of forwardPatches) {
120
- consumeModifiedFields(p.id, Object.keys(p).filter((k) => k !== 'id'));
121
- }
122
- forwards.push({ kind: 'updateMany', modelKey, patches: forwardPatches });
123
- if (prevPatches.length > 0) {
124
- inverses.push({ kind: 'updateMany', modelKey, patches: prevPatches });
125
- }
126
- return updated;
127
- }
128
- const id = patch.id;
129
- const fields = Object.keys(patch).filter((k) => k !== 'id');
130
- const prev = snapshotFields(id, fields);
131
- const updated = await mutate.update(patch);
132
- const patchCopy = {
133
- id,
134
- ...patch,
135
- };
136
- consumeModifiedFields(id, fields);
137
- forwards.push({ kind: 'update', modelKey, patch: patchCopy });
138
- if (prev) {
139
- inverses.push({ kind: 'update', modelKey, patch: { id, ...prev } });
140
- }
141
- return updated;
142
- }),
143
- delete: (async (idOrIds) => {
144
- if (Array.isArray(idOrIds)) {
145
- const prevs = idOrIds
146
- .map((id) => snapshot(id))
147
- .filter((d) => d !== null);
148
- await mutate.delete(idOrIds);
149
- forwards.push({ kind: 'deleteMany', modelKey, ids: [...idOrIds] });
150
- if (prevs.length > 0) {
151
- inverses.push({ kind: 'createMany', modelKey, data: prevs });
152
- }
153
- return;
154
- }
155
- const prev = snapshot(idOrIds);
156
- await mutate.delete(idOrIds);
157
- forwards.push({ kind: 'delete', modelKey, id: idOrIds });
158
- if (prev) {
159
- inverses.push({ kind: 'create', modelKey, data: prev });
160
- }
161
- }),
162
- archive: async (id) => {
163
- await mutate.archive(id);
164
- forwards.push({
165
- kind: 'update',
166
- modelKey,
167
- patch: { id, archivedAt: new Date() },
168
- });
169
- // Inverse of archive is unarchive, modeled here as a "restore" update.
170
- inverses.push({ kind: 'update', modelKey, patch: { id, archivedAt: null } });
171
- },
172
- unarchive: async (id) => {
173
- await mutate.unarchive(id);
174
- forwards.push({ kind: 'update', modelKey, patch: { id, archivedAt: null } });
175
- inverses.push({
176
- kind: 'update',
177
- modelKey,
178
- patch: { id, archivedAt: new Date() },
179
- });
180
- },
181
- };
182
- }
@@ -1,40 +0,0 @@
1
- /**
2
- * The typed transaction object passed to a custom mutator. A mutator receives
3
- * `{ tx, args }` and uses `tx.mutations.<modelKey>.*` to write and
4
- * `tx.read.<modelKey>.*` to take synchronous snapshots of the current data.
5
- *
6
- * Writes are applied eagerly as they are called, with no buffering: if a mutator
7
- * throws partway through, the writes it already made stand. Reads are synchronous
8
- * snapshots and use a fast index lookup where one is available for the field.
9
- *
10
- * The write surface deliberately works one row at a time. To write a batch,
11
- * compose the calls yourself — `Promise.all(rows.map((r) => tx.mutations.x.create(r)))`.
12
- * Every call stages its write in the same synchronous tick and the engine
13
- * coalesces them into a single commit on the wire, so there is no separate
14
- * bulk-insert method to learn.
15
- */
16
- import type { Schema } from '../transaction/schema/schema.js';
17
- import type { SyncStoreContract } from '../react/context.js';
18
- import { type MutateActions } from './mutateActions.js';
19
- import { type ReaderActions, type ReaderFindOptions } from './readerActions.js';
20
- /**
21
- * The full transaction surface: `tx.mutations.<key>.*` for writes and
22
- * `tx.read.<key>.*` for reads. It also re-exports the read-options type so a
23
- * mutator author can type a `where` payload without importing it separately. The
24
- * property is named `mutations` to match the corresponding React hook.
25
- */
26
- export interface Transaction<S extends Schema> {
27
- mutations: {
28
- [K in keyof S['models'] & string]: MutateActions<S, K>;
29
- };
30
- read: {
31
- [K in keyof S['models'] & string]: ReaderActions<S, K>;
32
- };
33
- }
34
- export type { ReaderFindOptions };
35
- /**
36
- * Builds a {@link Transaction} for a single mutator invocation. The returned
37
- * object creates each model's actions lazily on first access, so a mutator pays
38
- * nothing for the models it never touches.
39
- */
40
- export declare function createTransaction<S extends Schema>(schema: S, store: SyncStoreContract, organizationId: string): Transaction<S>;
@@ -1,58 +0,0 @@
1
- /**
2
- * The typed transaction object passed to a custom mutator. A mutator receives
3
- * `{ tx, args }` and uses `tx.mutations.<modelKey>.*` to write and
4
- * `tx.read.<modelKey>.*` to take synchronous snapshots of the current data.
5
- *
6
- * Writes are applied eagerly as they are called, with no buffering: if a mutator
7
- * throws partway through, the writes it already made stand. Reads are synchronous
8
- * snapshots and use a fast index lookup where one is available for the field.
9
- *
10
- * The write surface deliberately works one row at a time. To write a batch,
11
- * compose the calls yourself — `Promise.all(rows.map((r) => tx.mutations.x.create(r)))`.
12
- * Every call stages its write in the same synchronous tick and the engine
13
- * coalesces them into a single commit on the wire, so there is no separate
14
- * bulk-insert method to learn.
15
- */
16
- import { createMutateActions } from './mutateActions.js';
17
- import { createReaderActions } from './readerActions.js';
18
- import { AbloValidationError } from '../transaction/errors.js';
19
- /**
20
- * Builds a {@link Transaction} for a single mutator invocation. The returned
21
- * object creates each model's actions lazily on first access, so a mutator pays
22
- * nothing for the models it never touches.
23
- */
24
- export function createTransaction(schema, store, organizationId) {
25
- const mutateCache = new Map();
26
- const readCache = new Map();
27
- const mutations = new Proxy({}, {
28
- get(_target, prop) {
29
- if (typeof prop !== 'string')
30
- return undefined;
31
- const cached = mutateCache.get(prop);
32
- if (cached)
33
- return cached;
34
- if (!(prop in schema.models)) {
35
- throw new AbloValidationError(`Transaction.mutations: unknown model key "${prop}". Known keys: ${Object.keys(schema.models).join(', ')}`, { code: 'transaction_mutate_unknown_model' });
36
- }
37
- const actions = createMutateActions(schema, prop, store, organizationId);
38
- mutateCache.set(prop, actions);
39
- return actions;
40
- },
41
- });
42
- const read = new Proxy({}, {
43
- get(_target, prop) {
44
- if (typeof prop !== 'string')
45
- return undefined;
46
- const cached = readCache.get(prop);
47
- if (cached)
48
- return cached;
49
- if (!(prop in schema.models)) {
50
- throw new AbloValidationError(`Transaction.read: unknown model key "${prop}". Known keys: ${Object.keys(schema.models).join(', ')}`, { code: 'transaction_read_unknown_model' });
51
- }
52
- const actions = createReaderActions(schema, prop, store);
53
- readCache.set(prop, actions);
54
- return actions;
55
- },
56
- });
57
- return { mutations, read };
58
- }