@abloatai/ablo 0.25.0 → 0.27.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 (425) hide show
  1. package/AGENTS.md +5 -3
  2. package/CHANGELOG.md +34 -0
  3. package/README.md +104 -88
  4. package/dist/BaseSyncedStore.d.ts +140 -266
  5. package/dist/BaseSyncedStore.js +338 -739
  6. package/dist/Database.d.ts +62 -77
  7. package/dist/Database.js +106 -127
  8. package/dist/{ObjectPool.d.ts → InstanceCache.d.ts} +10 -13
  9. package/dist/{ObjectPool.js → InstanceCache.js} +91 -83
  10. package/dist/LazyReferenceCollection.d.ts +11 -15
  11. package/dist/LazyReferenceCollection.js +16 -15
  12. package/dist/Model.d.ts +37 -52
  13. package/dist/Model.js +52 -69
  14. package/dist/ModelRegistry.d.ts +46 -25
  15. package/dist/ModelRegistry.js +32 -30
  16. package/dist/NetworkMonitor.d.ts +5 -6
  17. package/dist/NetworkMonitor.js +6 -7
  18. package/dist/SyncClient.d.ts +119 -109
  19. package/dist/SyncClient.js +303 -224
  20. package/dist/SyncEngineContext.d.ts +1 -3
  21. package/dist/SyncEngineContext.js +1 -2
  22. package/dist/adapters/alwaysOnline.d.ts +6 -8
  23. package/dist/adapters/alwaysOnline.js +6 -8
  24. package/dist/adapters/inMemoryStorage.d.ts +9 -9
  25. package/dist/adapters/inMemoryStorage.js +9 -9
  26. package/dist/agent/Agent.d.ts +39 -31
  27. package/dist/agent/Agent.js +35 -23
  28. package/dist/agent/index.d.ts +4 -4
  29. package/dist/agent/index.js +5 -5
  30. package/dist/agent/session.d.ts +47 -44
  31. package/dist/agent/session.js +37 -48
  32. package/dist/agent/types.d.ts +26 -31
  33. package/dist/agent/types.js +6 -7
  34. package/dist/ai-sdk/coordinatedTool.d.ts +108 -0
  35. package/dist/ai-sdk/{coordinated-tool.js → coordinatedTool.js} +44 -38
  36. package/dist/ai-sdk/coordinationContext.d.ts +46 -0
  37. package/dist/ai-sdk/{coordination-context.js → coordinationContext.js} +30 -31
  38. package/dist/ai-sdk/index.d.ts +25 -22
  39. package/dist/ai-sdk/index.js +25 -22
  40. package/dist/ai-sdk/wrap.d.ts +7 -8
  41. package/dist/ai-sdk/wrap.js +2 -2
  42. package/dist/auth/credentialPolicy.d.ts +74 -71
  43. package/dist/auth/credentialPolicy.js +51 -56
  44. package/dist/auth/credentialSource.d.ts +7 -18
  45. package/dist/auth/credentialSource.js +10 -18
  46. package/dist/auth/index.d.ts +59 -58
  47. package/dist/auth/index.js +34 -40
  48. package/dist/auth/schemas.d.ts +5 -4
  49. package/dist/auth/schemas.js +5 -4
  50. package/dist/batching/index.d.ts +19 -21
  51. package/dist/batching/index.js +14 -17
  52. package/dist/cli.cjs +483 -369
  53. package/dist/client/Ablo.d.ts +107 -836
  54. package/dist/client/Ablo.js +174 -833
  55. package/dist/client/ApiClient.d.ts +44 -20
  56. package/dist/client/ApiClient.js +193 -44
  57. package/dist/client/auth.d.ts +51 -60
  58. package/dist/client/auth.js +137 -110
  59. package/dist/client/claimHeartbeatLoop.d.ts +50 -0
  60. package/dist/client/claimHeartbeatLoop.js +88 -0
  61. package/dist/client/consoleLogger.d.ts +35 -0
  62. package/dist/client/consoleLogger.js +44 -0
  63. package/dist/client/createInternalComponents.d.ts +14 -17
  64. package/dist/client/createInternalComponents.js +26 -31
  65. package/dist/client/createModelProxy.d.ts +130 -120
  66. package/dist/client/createModelProxy.js +158 -124
  67. package/dist/client/credentialEndpoint.d.ts +61 -0
  68. package/dist/client/credentialEndpoint.js +86 -0
  69. package/dist/client/functionalUpdate.d.ts +29 -27
  70. package/dist/client/functionalUpdate.js +21 -21
  71. package/dist/client/hostedEndpoints.d.ts +21 -0
  72. package/dist/client/hostedEndpoints.js +21 -0
  73. package/dist/client/httpClient.d.ts +58 -54
  74. package/dist/client/httpClient.js +29 -31
  75. package/dist/client/identity.d.ts +15 -20
  76. package/dist/client/identity.js +49 -59
  77. package/dist/client/modelRegistration.d.ts +10 -0
  78. package/dist/client/modelRegistration.js +301 -0
  79. package/dist/client/options.d.ts +373 -0
  80. package/dist/client/options.js +6 -0
  81. package/dist/client/registerDataSource.d.ts +9 -9
  82. package/dist/client/registerDataSource.js +15 -16
  83. package/dist/client/resourceTypes.d.ts +333 -0
  84. package/dist/client/resourceTypes.js +7 -0
  85. package/dist/client/schemaConfig.d.ts +44 -0
  86. package/dist/client/schemaConfig.js +176 -0
  87. package/dist/client/sessionMint.d.ts +17 -13
  88. package/dist/client/sessionMint.js +26 -31
  89. package/dist/client/validateAbloOptions.d.ts +12 -14
  90. package/dist/client/validateAbloOptions.js +9 -10
  91. package/dist/client/writeOptionsSchema.d.ts +18 -16
  92. package/dist/client/writeOptionsSchema.js +23 -20
  93. package/dist/client/wsMutationExecutor.d.ts +28 -0
  94. package/dist/client/wsMutationExecutor.js +71 -0
  95. package/dist/context.d.ts +6 -4
  96. package/dist/context.js +6 -7
  97. package/dist/coordination/index.d.ts +13 -4
  98. package/dist/coordination/index.js +29 -4
  99. package/dist/coordination/schema.d.ts +176 -128
  100. package/dist/coordination/schema.js +197 -133
  101. package/dist/coordination/trace.d.ts +9 -11
  102. package/dist/coordination/trace.js +13 -15
  103. package/dist/core/DatabaseManager.d.ts +5 -8
  104. package/dist/core/DatabaseManager.js +38 -40
  105. package/dist/core/QueryProcessor.d.ts +7 -9
  106. package/dist/core/QueryProcessor.js +27 -34
  107. package/dist/core/QueryView.d.ts +17 -5
  108. package/dist/core/QueryView.js +6 -7
  109. package/dist/core/StoreManager.d.ts +14 -16
  110. package/dist/core/StoreManager.js +26 -25
  111. package/dist/core/ViewRegistry.d.ts +5 -5
  112. package/dist/core/ViewRegistry.js +4 -4
  113. package/dist/core/index.d.ts +18 -13
  114. package/dist/core/index.js +32 -26
  115. package/dist/core/openIDBWithTimeout.d.ts +38 -36
  116. package/dist/core/openIDBWithTimeout.js +57 -54
  117. package/dist/core/queryUtils.d.ts +45 -0
  118. package/dist/core/queryUtils.js +69 -0
  119. package/dist/core/storeContract.d.ts +145 -0
  120. package/dist/core/storeContract.js +12 -0
  121. package/dist/environment.d.ts +28 -0
  122. package/dist/environment.js +21 -0
  123. package/dist/errorCodes.d.ts +118 -101
  124. package/dist/errorCodes.js +277 -260
  125. package/dist/errors.d.ts +170 -165
  126. package/dist/errors.js +161 -151
  127. package/dist/index.d.ts +30 -27
  128. package/dist/index.js +90 -82
  129. package/dist/interfaces/index.d.ts +108 -133
  130. package/dist/interfaces/index.js +5 -4
  131. package/dist/keys/index.d.ts +27 -29
  132. package/dist/keys/index.js +59 -49
  133. package/dist/mutators/RecordingTransaction.d.ts +16 -16
  134. package/dist/mutators/RecordingTransaction.js +31 -37
  135. package/dist/mutators/Transaction.d.ts +18 -26
  136. package/dist/mutators/Transaction.js +14 -20
  137. package/dist/mutators/UndoManager.d.ts +122 -131
  138. package/dist/mutators/UndoManager.js +149 -155
  139. package/dist/mutators/defineMutators.d.ts +24 -37
  140. package/dist/mutators/defineMutators.js +14 -20
  141. package/dist/mutators/inverseOp.d.ts +12 -15
  142. package/dist/mutators/inverseOp.js +12 -15
  143. package/dist/mutators/mutateActions.d.ts +10 -9
  144. package/dist/mutators/mutateActions.js +1 -1
  145. package/dist/mutators/readerActions.d.ts +9 -8
  146. package/dist/mutators/readerActions.js +2 -2
  147. package/dist/mutators/undoApply.d.ts +31 -27
  148. package/dist/mutators/undoApply.js +26 -24
  149. package/dist/policy/index.d.ts +5 -3
  150. package/dist/policy/index.js +5 -3
  151. package/dist/policy/types.d.ts +105 -101
  152. package/dist/policy/types.js +67 -66
  153. package/dist/query/client.d.ts +32 -16
  154. package/dist/query/client.js +103 -72
  155. package/dist/query/types.d.ts +37 -60
  156. package/dist/query/types.js +13 -33
  157. package/dist/react/AbloProvider.d.ts +7 -11
  158. package/dist/react/AbloProvider.js +24 -17
  159. package/dist/react/context.d.ts +27 -146
  160. package/dist/react/context.js +9 -10
  161. package/dist/react/index.d.ts +41 -42
  162. package/dist/react/index.js +37 -38
  163. package/dist/react/internalContext.d.ts +17 -19
  164. package/dist/react/useAblo.d.ts +23 -22
  165. package/dist/react/useAblo.js +17 -15
  166. package/dist/react/useCurrentUserId.d.ts +8 -7
  167. package/dist/react/useCurrentUserId.js +8 -7
  168. package/dist/react/useErrorListener.d.ts +7 -7
  169. package/dist/react/useErrorListener.js +11 -12
  170. package/dist/react/useMutationFailureListener.d.ts +8 -8
  171. package/dist/react/useMutationFailureListener.js +9 -9
  172. package/dist/react/useMutators.d.ts +11 -11
  173. package/dist/react/useMutators.js +10 -4
  174. package/dist/react/useReactive.js +2 -3
  175. package/dist/react/useSyncStatus.d.ts +4 -6
  176. package/dist/react/useUndoScope.d.ts +7 -9
  177. package/dist/react/useUndoScope.js +3 -3
  178. package/dist/schema/coordination.d.ts +21 -25
  179. package/dist/schema/coordination.js +21 -25
  180. package/dist/schema/ddl.d.ts +43 -39
  181. package/dist/schema/ddl.js +75 -68
  182. package/dist/schema/ddlLock.d.ts +35 -0
  183. package/dist/schema/ddlLock.js +46 -0
  184. package/dist/schema/diff.d.ts +99 -61
  185. package/dist/schema/diff.js +43 -34
  186. package/dist/schema/field.d.ts +37 -42
  187. package/dist/schema/field.js +36 -49
  188. package/dist/schema/generate.d.ts +12 -12
  189. package/dist/schema/generate.js +12 -12
  190. package/dist/schema/index.d.ts +5 -4
  191. package/dist/schema/index.js +29 -21
  192. package/dist/schema/model.d.ts +121 -146
  193. package/dist/schema/model.js +24 -35
  194. package/dist/schema/openapi.d.ts +10 -9
  195. package/dist/schema/openapi.js +7 -1
  196. package/dist/schema/queries.d.ts +30 -32
  197. package/dist/schema/queries.js +24 -25
  198. package/dist/schema/relation.d.ts +89 -99
  199. package/dist/schema/relation.js +13 -13
  200. package/dist/schema/residency.d.ts +38 -0
  201. package/dist/schema/residency.js +30 -0
  202. package/dist/schema/roles.d.ts +45 -27
  203. package/dist/schema/roles.js +52 -21
  204. package/dist/schema/schema.d.ts +36 -45
  205. package/dist/schema/schema.js +42 -39
  206. package/dist/schema/select.d.ts +13 -13
  207. package/dist/schema/select.js +13 -13
  208. package/dist/schema/serialize.d.ts +36 -39
  209. package/dist/schema/serialize.js +27 -31
  210. package/dist/schema/sugar.d.ts +17 -32
  211. package/dist/schema/sugar.js +14 -29
  212. package/dist/schema/{sync-delta-row.d.ts → syncDeltaRow.d.ts} +27 -50
  213. package/dist/schema/syncDeltaRow.js +89 -0
  214. package/dist/schema/tenancy.d.ts +44 -46
  215. package/dist/schema/tenancy.js +46 -48
  216. package/dist/server/adapter.d.ts +58 -58
  217. package/dist/server/adapter.js +13 -14
  218. package/dist/server/commit.d.ts +60 -64
  219. package/dist/server/index.d.ts +9 -10
  220. package/dist/server/index.js +1 -1
  221. package/dist/server/readConfig.d.ts +70 -0
  222. package/dist/server/readConfig.js +8 -0
  223. package/dist/server/storageMode.d.ts +23 -0
  224. package/dist/server/storageMode.js +17 -0
  225. package/dist/source/adapter.d.ts +31 -26
  226. package/dist/source/adapter.js +10 -10
  227. package/dist/source/adapters/drizzle.d.ts +28 -23
  228. package/dist/source/adapters/drizzle.js +34 -28
  229. package/dist/source/adapters/kysely.d.ts +27 -25
  230. package/dist/source/adapters/kysely.js +28 -26
  231. package/dist/source/adapters/memory.d.ts +8 -7
  232. package/dist/source/adapters/memory.js +10 -9
  233. package/dist/source/adapters/prisma.d.ts +13 -12
  234. package/dist/source/adapters/prisma.js +27 -29
  235. package/dist/source/conformance.d.ts +18 -11
  236. package/dist/source/conformance.js +27 -19
  237. package/dist/source/connector.d.ts +31 -32
  238. package/dist/source/connector.js +30 -28
  239. package/dist/source/connectorProtocol.d.ts +160 -0
  240. package/dist/source/connectorProtocol.js +162 -0
  241. package/dist/source/contract.d.ts +26 -27
  242. package/dist/source/contract.js +28 -29
  243. package/dist/source/factory.d.ts +94 -0
  244. package/dist/source/factory.js +268 -0
  245. package/dist/source/index.d.ts +10 -462
  246. package/dist/source/index.js +17 -421
  247. package/dist/source/migrations.d.ts +9 -9
  248. package/dist/source/migrations.js +9 -9
  249. package/dist/source/next.d.ts +10 -11
  250. package/dist/source/next.js +7 -8
  251. package/dist/source/pushQueue.d.ts +70 -48
  252. package/dist/source/pushQueue.js +36 -29
  253. package/dist/source/signing.d.ts +88 -0
  254. package/dist/source/signing.js +159 -0
  255. package/dist/source/types.d.ts +351 -0
  256. package/dist/source/types.js +43 -0
  257. package/dist/stores/ObjectStore.d.ts +11 -12
  258. package/dist/stores/ObjectStore.js +34 -35
  259. package/dist/stores/ObjectStoreContract.d.ts +12 -15
  260. package/dist/stores/SyncActionStore.d.ts +8 -12
  261. package/dist/stores/SyncActionStore.js +77 -46
  262. package/dist/surface.d.ts +28 -21
  263. package/dist/surface.js +28 -20
  264. package/dist/sync/{BootstrapHelper.d.ts → BootstrapFetcher.d.ts} +37 -45
  265. package/dist/sync/{BootstrapHelper.js → BootstrapFetcher.js} +101 -80
  266. package/dist/sync/ConnectionManager.d.ts +47 -50
  267. package/dist/sync/ConnectionManager.js +74 -70
  268. package/dist/sync/NetworkProbe.d.ts +27 -31
  269. package/dist/sync/NetworkProbe.js +67 -72
  270. package/dist/sync/{HydrationCoordinator.d.ts → OnDemandLoader.d.ts} +49 -36
  271. package/dist/sync/{HydrationCoordinator.js → OnDemandLoader.js} +79 -54
  272. package/dist/sync/{AreaOfInterestManager.d.ts → SubscriptionManager.d.ts} +45 -59
  273. package/dist/sync/{AreaOfInterestManager.js → SubscriptionManager.js} +44 -52
  274. package/dist/sync/SyncWebSocket.d.ts +175 -250
  275. package/dist/sync/SyncWebSocket.js +431 -769
  276. package/dist/sync/awaitClaimGrant.d.ts +18 -18
  277. package/dist/sync/awaitClaimGrant.js +38 -30
  278. package/dist/sync/bootstrapApply.d.ts +70 -0
  279. package/dist/sync/bootstrapApply.js +73 -0
  280. package/dist/sync/commitFrames.d.ts +44 -0
  281. package/dist/sync/commitFrames.js +94 -0
  282. package/dist/sync/createClaimStream.d.ts +23 -22
  283. package/dist/sync/createClaimStream.js +108 -25
  284. package/dist/sync/createPresenceStream.d.ts +19 -18
  285. package/dist/sync/createPresenceStream.js +25 -26
  286. package/dist/sync/createSnapshot.d.ts +13 -17
  287. package/dist/sync/createSnapshot.js +20 -26
  288. package/dist/sync/credentialLifecycle.d.ts +175 -0
  289. package/dist/sync/credentialLifecycle.js +322 -0
  290. package/dist/sync/deltaPipeline.d.ts +113 -0
  291. package/dist/sync/deltaPipeline.js +261 -0
  292. package/dist/sync/groupChange.d.ts +113 -0
  293. package/dist/sync/groupChange.js +242 -0
  294. package/dist/sync/heartbeat.d.ts +63 -0
  295. package/dist/sync/heartbeat.js +91 -0
  296. package/dist/sync/participants.d.ts +27 -27
  297. package/dist/sync/schemas.d.ts +3 -2
  298. package/dist/sync/schemas.js +14 -10
  299. package/dist/sync/syncCursor.d.ts +40 -0
  300. package/dist/sync/syncCursor.js +55 -0
  301. package/dist/sync/syncPlan.d.ts +54 -0
  302. package/dist/sync/syncPlan.js +50 -0
  303. package/dist/sync/syncPosition.d.ts +54 -49
  304. package/dist/sync/syncPosition.js +57 -52
  305. package/dist/sync/wsFrameHandlers.d.ts +116 -0
  306. package/dist/sync/wsFrameHandlers.js +374 -0
  307. package/dist/testing/fixtures/bootstrap.d.ts +21 -17
  308. package/dist/testing/fixtures/bootstrap.js +12 -6
  309. package/dist/testing/fixtures/deltas.d.ts +31 -34
  310. package/dist/testing/fixtures/deltas.js +30 -33
  311. package/dist/testing/fixtures/models.d.ts +11 -10
  312. package/dist/testing/fixtures/models.js +12 -10
  313. package/dist/testing/helpers/{react-wrapper.d.ts → reactWrapper.d.ts} +13 -10
  314. package/dist/testing/helpers/{react-wrapper.js → reactWrapper.js} +15 -12
  315. package/dist/testing/helpers/{sync-engine-harness.d.ts → syncEngineHarness.d.ts} +17 -18
  316. package/dist/testing/helpers/{sync-engine-harness.js → syncEngineHarness.js} +14 -11
  317. package/dist/testing/helpers/wait.d.ts +13 -8
  318. package/dist/testing/helpers/wait.js +13 -8
  319. package/dist/testing/index.d.ts +4 -4
  320. package/dist/testing/index.js +3 -3
  321. package/dist/testing/mocks/MockMutationExecutor.d.ts +18 -17
  322. package/dist/testing/mocks/MockMutationExecutor.js +15 -14
  323. package/dist/testing/mocks/MockNetworkMonitor.d.ts +8 -8
  324. package/dist/testing/mocks/MockNetworkMonitor.js +8 -8
  325. package/dist/testing/mocks/MockSyncContext.d.ts +21 -34
  326. package/dist/testing/mocks/MockSyncContext.js +16 -45
  327. package/dist/testing/mocks/MockSyncStore.d.ts +14 -14
  328. package/dist/testing/mocks/MockSyncStore.js +11 -11
  329. package/dist/testing/mocks/MockWebSocket.d.ts +28 -24
  330. package/dist/testing/mocks/MockWebSocket.js +22 -21
  331. package/dist/transactions/TransactionQueue.d.ts +190 -221
  332. package/dist/transactions/TransactionQueue.js +424 -822
  333. package/dist/transactions/TransactionStore.d.ts +20 -0
  334. package/dist/transactions/TransactionStore.js +53 -0
  335. package/dist/transactions/UnconfirmedWrites.d.ts +82 -0
  336. package/dist/transactions/UnconfirmedWrites.js +104 -0
  337. package/dist/transactions/coalesceRules.d.ts +58 -0
  338. package/dist/transactions/coalesceRules.js +140 -0
  339. package/dist/transactions/commitPayload.d.ts +130 -0
  340. package/dist/transactions/commitPayload.js +143 -0
  341. package/dist/transactions/deltaConfirmation.d.ts +58 -0
  342. package/dist/transactions/deltaConfirmation.js +215 -0
  343. package/dist/transactions/optimisticApply.d.ts +49 -0
  344. package/dist/transactions/optimisticApply.js +65 -0
  345. package/dist/transactions/replayValidation.d.ts +99 -0
  346. package/dist/transactions/replayValidation.js +111 -0
  347. package/dist/types/global.d.ts +46 -41
  348. package/dist/types/global.js +20 -19
  349. package/dist/types/index.d.ts +74 -80
  350. package/dist/types/index.js +22 -27
  351. package/dist/types/modelData.d.ts +10 -0
  352. package/dist/types/modelData.js +9 -0
  353. package/dist/types/participant.d.ts +20 -0
  354. package/dist/types/participant.js +10 -0
  355. package/dist/types/streams.d.ts +216 -209
  356. package/dist/types/streams.js +7 -7
  357. package/dist/utils/asyncIterator.d.ts +25 -32
  358. package/dist/utils/asyncIterator.js +25 -32
  359. package/dist/utils/duration.d.ts +12 -15
  360. package/dist/utils/duration.js +12 -15
  361. package/dist/utils/mobxSetup.d.ts +53 -0
  362. package/dist/utils/{mobx-setup.js → mobxSetup.js} +44 -100
  363. package/dist/webhooks/events.d.ts +21 -16
  364. package/dist/webhooks/events.js +10 -8
  365. package/dist/webhooks/index.d.ts +5 -7
  366. package/dist/webhooks/index.js +5 -7
  367. package/dist/{schema/sync-delta-wire.d.ts → wire/delta.d.ts} +58 -41
  368. package/dist/wire/delta.js +114 -0
  369. package/dist/wire/errorEnvelope.d.ts +35 -27
  370. package/dist/wire/errorEnvelope.js +38 -32
  371. package/dist/wire/frames.d.ts +150 -67
  372. package/dist/wire/frames.js +48 -1
  373. package/dist/wire/index.d.ts +18 -13
  374. package/dist/wire/index.js +36 -13
  375. package/dist/wire/listEnvelope.d.ts +16 -23
  376. package/dist/wire/listEnvelope.js +7 -6
  377. package/dist/wire/protocol.d.ts +38 -0
  378. package/dist/wire/protocol.js +38 -0
  379. package/dist/wire/protocolVersion.d.ts +60 -0
  380. package/dist/wire/protocolVersion.js +67 -0
  381. package/docs/api-keys.md +4 -3
  382. package/docs/coordination.md +59 -0
  383. package/docs/examples/existing-python-backend.md +3 -3
  384. package/docs/identity.md +4 -4
  385. package/docs/integration-guide.md +1 -1
  386. package/docs/react.md +1 -1
  387. package/docs/sessions.md +5 -7
  388. package/package.json +24 -21
  389. package/dist/ai-sdk/coordinated-tool.d.ts +0 -101
  390. package/dist/ai-sdk/coordination-context.d.ts +0 -52
  391. package/dist/client/index.d.ts +0 -36
  392. package/dist/client/index.js +0 -33
  393. package/dist/config/index.d.ts +0 -10
  394. package/dist/config/index.js +0 -12
  395. package/dist/core/query-utils.d.ts +0 -34
  396. package/dist/core/query-utils.js +0 -59
  397. package/dist/interfaces/headless.d.ts +0 -95
  398. package/dist/interfaces/headless.js +0 -41
  399. package/dist/query/index.d.ts +0 -6
  400. package/dist/query/index.js +0 -5
  401. package/dist/realtime/index.d.ts +0 -10
  402. package/dist/realtime/index.js +0 -9
  403. package/dist/schema/plane.d.ts +0 -23
  404. package/dist/schema/plane.js +0 -19
  405. package/dist/schema/sync-delta-row.js +0 -103
  406. package/dist/schema/sync-delta-wire.js +0 -102
  407. package/dist/server/next.d.ts +0 -51
  408. package/dist/server/next.js +0 -47
  409. package/dist/server/read-config.d.ts +0 -67
  410. package/dist/server/read-config.js +0 -8
  411. package/dist/server/storage-mode.d.ts +0 -1
  412. package/dist/server/storage-mode.js +0 -18
  413. package/dist/source/connector-protocol.d.ts +0 -159
  414. package/dist/source/connector-protocol.js +0 -161
  415. package/dist/sync/OfflineFlush.d.ts +0 -9
  416. package/dist/sync/OfflineFlush.js +0 -22
  417. package/dist/sync/OfflineTransactionStore.d.ts +0 -37
  418. package/dist/sync/OfflineTransactionStore.js +0 -263
  419. package/dist/transactions/OptimisticEchoTracker.d.ts +0 -82
  420. package/dist/transactions/OptimisticEchoTracker.js +0 -104
  421. package/dist/transactions/index.d.ts +0 -16
  422. package/dist/transactions/index.js +0 -7
  423. package/dist/transactions/mutation-error-handler.d.ts +0 -5
  424. package/dist/transactions/mutation-error-handler.js +0 -39
  425. package/dist/utils/mobx-setup.d.ts +0 -42
@@ -0,0 +1,20 @@
1
+ /**
2
+ * An in-memory index of transactions by id, with a secondary index by status.
3
+ * The status index keeps the queue's hot paths — such as `getByStatus('pending')`
4
+ * on every batch and coalesce decision — proportional to the number of
5
+ * transactions in that status rather than the total across all statuses.
6
+ * {@link TransactionQueue} owns an instance and routes every status change
7
+ * through {@link updateStatus}, which keeps the two indexes consistent.
8
+ */
9
+ import type { Transaction } from './commitPayload.js';
10
+ export declare class TransactionStore {
11
+ private transactions;
12
+ private byStatus;
13
+ add(transaction: Transaction): void;
14
+ get(id: string): Transaction | undefined;
15
+ updateStatus(id: string, newStatus: Transaction['status']): void;
16
+ getByStatus(status: Transaction['status']): Transaction[];
17
+ remove(id: string): void;
18
+ clear(): void;
19
+ getAll(): Transaction[];
20
+ }
@@ -0,0 +1,53 @@
1
+ /**
2
+ * An in-memory index of transactions by id, with a secondary index by status.
3
+ * The status index keeps the queue's hot paths — such as `getByStatus('pending')`
4
+ * on every batch and coalesce decision — proportional to the number of
5
+ * transactions in that status rather than the total across all statuses.
6
+ * {@link TransactionQueue} owns an instance and routes every status change
7
+ * through {@link updateStatus}, which keeps the two indexes consistent.
8
+ */
9
+ export class TransactionStore {
10
+ transactions = new Map();
11
+ byStatus = new Map();
12
+ add(transaction) {
13
+ this.transactions.set(transaction.id, transaction);
14
+ if (!this.byStatus.has(transaction.status)) {
15
+ this.byStatus.set(transaction.status, new Set());
16
+ }
17
+ this.byStatus.get(transaction.status).add(transaction.id);
18
+ }
19
+ get(id) {
20
+ return this.transactions.get(id);
21
+ }
22
+ updateStatus(id, newStatus) {
23
+ const tx = this.transactions.get(id);
24
+ if (!tx)
25
+ return;
26
+ this.byStatus.get(tx.status)?.delete(id);
27
+ tx.status = newStatus;
28
+ if (!this.byStatus.has(newStatus)) {
29
+ this.byStatus.set(newStatus, new Set());
30
+ }
31
+ this.byStatus.get(newStatus).add(id);
32
+ }
33
+ getByStatus(status) {
34
+ const ids = this.byStatus.get(status) || new Set();
35
+ return Array.from(ids)
36
+ .map((id) => this.transactions.get(id))
37
+ .filter(Boolean);
38
+ }
39
+ remove(id) {
40
+ const tx = this.transactions.get(id);
41
+ if (!tx)
42
+ return;
43
+ this.transactions.delete(id);
44
+ this.byStatus.get(tx.status)?.delete(id);
45
+ }
46
+ clear() {
47
+ this.transactions.clear();
48
+ this.byStatus.clear();
49
+ }
50
+ getAll() {
51
+ return Array.from(this.transactions.values());
52
+ }
53
+ }
@@ -0,0 +1,82 @@
1
+ /**
2
+ * Tracks the transactions this client has applied locally but the server has
3
+ * not yet confirmed, so their echoes can be recognized when they return over
4
+ * the sync stream. When a change is made optimistically, the client updates
5
+ * its own state at once; the server later broadcasts the same change as a sync
6
+ * delta stamped with the originating `transactionId`. This tracker lets the
7
+ * receive path recognize that delta as its own echo and skip re-applying it,
8
+ * since the optimistic write already reflects it. Without this discriminator
9
+ * the apply path would re-apply the confirmation on top of state that may have
10
+ * changed since, producing a visible flicker.
11
+ *
12
+ * An entry is added with {@link markPending} and drained either by
13
+ * {@link consumeEcho} when the matching delta arrives, or by
14
+ * {@link drainOnRollback} when the originating transaction is cancelled.
15
+ *
16
+ * The set is bounded by `maxSize` to guard against unbounded growth if
17
+ * transactions are somehow never confirmed and never rolled back. When the
18
+ * bound is reached the oldest id is evicted first, since the backing Map
19
+ * iterates in insertion order. Eviction carries no correctness risk for the
20
+ * client that made the write, whose local state already reflects the change;
21
+ * the only cost is that a later echo of the evicted transaction is applied as
22
+ * if it were a foreign change, at worst a single redundant re-set.
23
+ */
24
+ export interface UnconfirmedWritesOptions {
25
+ /**
26
+ * The maximum number of unconfirmed transaction ids to track. Once this many
27
+ * are held, adding another evicts the oldest. Defaults to 10,000, which
28
+ * leaves ample headroom even for a client with many tabs open during a large
29
+ * bulk edit.
30
+ */
31
+ maxSize?: number;
32
+ }
33
+ export interface UnconfirmedWritesMetrics {
34
+ /** Total ids currently tracked. */
35
+ size: number;
36
+ /** Cumulative ids ever added since construction. */
37
+ totalAdded: number;
38
+ /** Cumulative successful echo matches (delta arrived → drained). */
39
+ hits: number;
40
+ /** Cumulative explicit rollback drains (transaction never made it). */
41
+ rollbacks: number;
42
+ /** Cumulative ids evicted due to maxSize pressure. */
43
+ evictions: number;
44
+ }
45
+ export declare class UnconfirmedWrites {
46
+ private readonly ids;
47
+ private readonly maxSize;
48
+ private _totalAdded;
49
+ private _hits;
50
+ private _rollbacks;
51
+ private _evictions;
52
+ constructor(options?: UnconfirmedWritesOptions);
53
+ /**
54
+ * Mark a transaction as locally-applied. The next sync delta with a
55
+ * matching `transactionId` will be recognized as the server's
56
+ * confirmation of this same write. Idempotent — repeated calls with
57
+ * the same id are no-ops.
58
+ */
59
+ markPending(transactionId: string): void;
60
+ /**
61
+ * Reports whether an incoming delta is this client's own echo, draining the
62
+ * entry if so. Returns true when the id was being tracked, signalling the
63
+ * caller to skip re-applying the change because the optimistic write already
64
+ * reflects it; returns false for a change that originated elsewhere, which
65
+ * should be applied normally.
66
+ *
67
+ * The check and drain are combined into one call so the receive path cannot
68
+ * accidentally treat two deltas carrying the same id, arriving in one batch,
69
+ * as separate echoes.
70
+ */
71
+ consumeEcho(transactionId: string | null | undefined): boolean;
72
+ /**
73
+ * Drains the entry for a transaction that was rolled back before the server
74
+ * confirmed it. No echo will ever arrive for a cancelled transaction, so
75
+ * without this the pending entry would leak. Rollbacks are counted separately
76
+ * from confirmed echoes, so a rise in rollbacks relative to hits can flag
77
+ * network or server trouble.
78
+ */
79
+ drainOnRollback(transactionId: string): void;
80
+ getMetrics(): Readonly<UnconfirmedWritesMetrics>;
81
+ clear(): void;
82
+ }
@@ -0,0 +1,104 @@
1
+ /**
2
+ * Tracks the transactions this client has applied locally but the server has
3
+ * not yet confirmed, so their echoes can be recognized when they return over
4
+ * the sync stream. When a change is made optimistically, the client updates
5
+ * its own state at once; the server later broadcasts the same change as a sync
6
+ * delta stamped with the originating `transactionId`. This tracker lets the
7
+ * receive path recognize that delta as its own echo and skip re-applying it,
8
+ * since the optimistic write already reflects it. Without this discriminator
9
+ * the apply path would re-apply the confirmation on top of state that may have
10
+ * changed since, producing a visible flicker.
11
+ *
12
+ * An entry is added with {@link markPending} and drained either by
13
+ * {@link consumeEcho} when the matching delta arrives, or by
14
+ * {@link drainOnRollback} when the originating transaction is cancelled.
15
+ *
16
+ * The set is bounded by `maxSize` to guard against unbounded growth if
17
+ * transactions are somehow never confirmed and never rolled back. When the
18
+ * bound is reached the oldest id is evicted first, since the backing Map
19
+ * iterates in insertion order. Eviction carries no correctness risk for the
20
+ * client that made the write, whose local state already reflects the change;
21
+ * the only cost is that a later echo of the evicted transaction is applied as
22
+ * if it were a foreign change, at worst a single redundant re-set.
23
+ */
24
+ const DEFAULT_MAX_SIZE = 10_000;
25
+ export class UnconfirmedWrites {
26
+ // Map (not Set) for O(1) FIFO eviction via insertion order.
27
+ // Value is unused; Map.keys() iterates in insertion order so
28
+ // `keys().next()` yields the oldest id.
29
+ ids = new Map();
30
+ maxSize;
31
+ // Metrics — internal counters; exposed via `getMetrics()`. Kept
32
+ // numeric (not BigInt) since cumulative-since-page-load fits well
33
+ // under Number.MAX_SAFE_INTEGER for any realistic session.
34
+ _totalAdded = 0;
35
+ _hits = 0;
36
+ _rollbacks = 0;
37
+ _evictions = 0;
38
+ constructor(options = {}) {
39
+ this.maxSize = options.maxSize ?? DEFAULT_MAX_SIZE;
40
+ }
41
+ /**
42
+ * Mark a transaction as locally-applied. The next sync delta with a
43
+ * matching `transactionId` will be recognized as the server's
44
+ * confirmation of this same write. Idempotent — repeated calls with
45
+ * the same id are no-ops.
46
+ */
47
+ markPending(transactionId) {
48
+ if (this.ids.has(transactionId))
49
+ return;
50
+ if (this.ids.size >= this.maxSize) {
51
+ const oldest = this.ids.keys().next().value;
52
+ if (oldest !== undefined) {
53
+ this.ids.delete(oldest);
54
+ this._evictions += 1;
55
+ }
56
+ }
57
+ this.ids.set(transactionId, true);
58
+ this._totalAdded += 1;
59
+ }
60
+ /**
61
+ * Reports whether an incoming delta is this client's own echo, draining the
62
+ * entry if so. Returns true when the id was being tracked, signalling the
63
+ * caller to skip re-applying the change because the optimistic write already
64
+ * reflects it; returns false for a change that originated elsewhere, which
65
+ * should be applied normally.
66
+ *
67
+ * The check and drain are combined into one call so the receive path cannot
68
+ * accidentally treat two deltas carrying the same id, arriving in one batch,
69
+ * as separate echoes.
70
+ */
71
+ consumeEcho(transactionId) {
72
+ if (!transactionId)
73
+ return false;
74
+ if (!this.ids.has(transactionId))
75
+ return false;
76
+ this.ids.delete(transactionId);
77
+ this._hits += 1;
78
+ return true;
79
+ }
80
+ /**
81
+ * Drains the entry for a transaction that was rolled back before the server
82
+ * confirmed it. No echo will ever arrive for a cancelled transaction, so
83
+ * without this the pending entry would leak. Rollbacks are counted separately
84
+ * from confirmed echoes, so a rise in rollbacks relative to hits can flag
85
+ * network or server trouble.
86
+ */
87
+ drainOnRollback(transactionId) {
88
+ if (this.ids.delete(transactionId)) {
89
+ this._rollbacks += 1;
90
+ }
91
+ }
92
+ getMetrics() {
93
+ return {
94
+ size: this.ids.size,
95
+ totalAdded: this._totalAdded,
96
+ hits: this._hits,
97
+ rollbacks: this._rollbacks,
98
+ evictions: this._evictions,
99
+ };
100
+ }
101
+ clear() {
102
+ this.ids.clear();
103
+ }
104
+ }
@@ -0,0 +1,58 @@
1
+ /**
2
+ * The queue's rules for coalescing operations that touch the same row, so their
3
+ * causal order is preserved. {@link TransactionQueue} calls into these through a
4
+ * small store-shaped interface:
5
+ *
6
+ * - Create-then-delete cancellation ({@link takeUnsentCreateForModel}):
7
+ * deleting a row whose create never left the client cancels both locally.
8
+ * - The create barrier ({@link findCreateBarrierForDelete}) and deferred-delete
9
+ * parking ({@link deferDeleteUntilCreateSettles} /
10
+ * {@link releaseDeferredDeletesForCreate}): once a create has been sent, a
11
+ * delete must wait for it to settle, or the server could receive the delete
12
+ * before the create.
13
+ * - Update-payload merging ({@link mergeUpdateData}): collapses rapid updates
14
+ * to the same row into one wire operation.
15
+ *
16
+ * The queue keeps the `enqueue` and `delete` methods that orchestrate optimistic
17
+ * state and events; these functions hold only the coalescing rules.
18
+ */
19
+ import type { MutationInput, Transaction } from './commitPayload.js';
20
+ /** The subset of {@link TransactionStore} that the coalescing rules read. */
21
+ export interface TransactionStoreLike {
22
+ get(id: string): Transaction | undefined;
23
+ getByStatus(status: Transaction['status']): Transaction[];
24
+ }
25
+ export declare const entityKey: (modelName: string, modelId: string) => string;
26
+ /**
27
+ * Finds and removes a create for the given model and id that has never been
28
+ * sent, searching the staging area, the execution queue, and the store's
29
+ * pending bucket in that order. It splices the match out of whichever queue
30
+ * held it, so the caller can cancel it rather than send a create followed by a
31
+ * delete.
32
+ */
33
+ export declare function takeUnsentCreateForModel(staged: Transaction[], queued: Transaction[], store: Pick<TransactionStoreLike, 'getByStatus'>, modelName: string, modelId: string): Transaction | undefined;
34
+ /**
35
+ * Returns the most recent in-flight create for the given model and id that a
36
+ * delete must wait behind, or undefined if there is none. A pending create that
37
+ * has never been attempted is not a barrier, because it can be cancelled
38
+ * instead; once a create has been sent, even a retry-pending one is a barrier.
39
+ */
40
+ export declare function findCreateBarrierForDelete(store: Pick<TransactionStoreLike, 'getByStatus'>, modelName: string, modelId: string): Transaction | undefined;
41
+ /**
42
+ * Parks a delete until the create for the same row settles, keyed by the
43
+ * create's model and id. {@link releaseDeferredDeletesForCreate} re-enqueues
44
+ * the parked deletes once that create completes.
45
+ */
46
+ export declare function deferDeleteUntilCreateSettles(deferredDeletesByCreate: Map<string, Transaction[]>, createTransaction: Transaction, deleteTransaction: Transaction): void;
47
+ /**
48
+ * Re-enqueues the deletes parked behind a create once that create settles,
49
+ * skipping any whose status is no longer pending.
50
+ */
51
+ export declare function releaseDeferredDeletesForCreate(deferredDeletesByCreate: Map<string, Transaction[]>, store: Pick<TransactionStoreLike, 'get'>, enqueue: (transaction: Transaction) => void, createTransaction: Transaction): void;
52
+ /**
53
+ * Merges two update payloads for the same row into one. Later values win, with
54
+ * one exception: a `metadata` field is deep-merged as an object — parsing it
55
+ * first when it arrives as a JSON string — rather than replaced, so partial
56
+ * metadata updates accumulate instead of overwriting each other.
57
+ */
58
+ export declare function mergeUpdateData(left: MutationInput | undefined, right: MutationInput | undefined, _modelName?: string): MutationInput;
@@ -0,0 +1,140 @@
1
+ /**
2
+ * The queue's rules for coalescing operations that touch the same row, so their
3
+ * causal order is preserved. {@link TransactionQueue} calls into these through a
4
+ * small store-shaped interface:
5
+ *
6
+ * - Create-then-delete cancellation ({@link takeUnsentCreateForModel}):
7
+ * deleting a row whose create never left the client cancels both locally.
8
+ * - The create barrier ({@link findCreateBarrierForDelete}) and deferred-delete
9
+ * parking ({@link deferDeleteUntilCreateSettles} /
10
+ * {@link releaseDeferredDeletesForCreate}): once a create has been sent, a
11
+ * delete must wait for it to settle, or the server could receive the delete
12
+ * before the create.
13
+ * - Update-payload merging ({@link mergeUpdateData}): collapses rapid updates
14
+ * to the same row into one wire operation.
15
+ *
16
+ * The queue keeps the `enqueue` and `delete` methods that orchestrate optimistic
17
+ * state and events; these functions hold only the coalescing rules.
18
+ */
19
+ export const entityKey = (modelName, modelId) => `${modelName}:${modelId}`;
20
+ const isTransactionForModel = (transaction, modelName, modelId) => transaction.modelName === modelName && transaction.modelId === modelId;
21
+ /**
22
+ * Finds and removes a create for the given model and id that has never been
23
+ * sent, searching the staging area, the execution queue, and the store's
24
+ * pending bucket in that order. It splices the match out of whichever queue
25
+ * held it, so the caller can cancel it rather than send a create followed by a
26
+ * delete.
27
+ */
28
+ export function takeUnsentCreateForModel(staged, queued, store, modelName, modelId) {
29
+ const isUnsentCreate = (tx) => tx.type === 'create' &&
30
+ tx.status === 'pending' &&
31
+ tx.attempts === 0 &&
32
+ isTransactionForModel(tx, modelName, modelId);
33
+ const stagedIndex = staged.findIndex(isUnsentCreate);
34
+ if (stagedIndex >= 0) {
35
+ return staged.splice(stagedIndex, 1)[0];
36
+ }
37
+ const queuedIndex = queued.findIndex(isUnsentCreate);
38
+ if (queuedIndex >= 0) {
39
+ return queued.splice(queuedIndex, 1)[0];
40
+ }
41
+ return store.getByStatus('pending').find(isUnsentCreate);
42
+ }
43
+ /**
44
+ * Returns the most recent in-flight create for the given model and id that a
45
+ * delete must wait behind, or undefined if there is none. A pending create that
46
+ * has never been attempted is not a barrier, because it can be cancelled
47
+ * instead; once a create has been sent, even a retry-pending one is a barrier.
48
+ */
49
+ export function findCreateBarrierForDelete(store, modelName, modelId) {
50
+ const liveCreates = [
51
+ ...store.getByStatus('pending'),
52
+ ...store.getByStatus('executing'),
53
+ ...store.getByStatus('awaiting_delta'),
54
+ ].filter((tx) => tx.type === 'create' &&
55
+ isTransactionForModel(tx, modelName, modelId) &&
56
+ // A never-attempted pending create can be cancelled instead. Once the
57
+ // create has been sent, even a retry-pending state is a causal barrier:
58
+ // the server may already have applied it and only the response was lost.
59
+ (tx.status !== 'pending' || tx.attempts > 0));
60
+ return liveCreates.sort((a, b) => b.createdAt - a.createdAt)[0];
61
+ }
62
+ /**
63
+ * Parks a delete until the create for the same row settles, keyed by the
64
+ * create's model and id. {@link releaseDeferredDeletesForCreate} re-enqueues
65
+ * the parked deletes once that create completes.
66
+ */
67
+ export function deferDeleteUntilCreateSettles(deferredDeletesByCreate, createTransaction, deleteTransaction) {
68
+ const key = entityKey(createTransaction.modelName, createTransaction.modelId);
69
+ const deferred = deferredDeletesByCreate.get(key) ?? [];
70
+ deferred.push(deleteTransaction);
71
+ deferredDeletesByCreate.set(key, deferred);
72
+ }
73
+ /**
74
+ * Re-enqueues the deletes parked behind a create once that create settles,
75
+ * skipping any whose status is no longer pending.
76
+ */
77
+ export function releaseDeferredDeletesForCreate(deferredDeletesByCreate, store, enqueue, createTransaction) {
78
+ const key = entityKey(createTransaction.modelName, createTransaction.modelId);
79
+ const deferred = deferredDeletesByCreate.get(key);
80
+ if (!deferred || deferred.length === 0)
81
+ return;
82
+ deferredDeletesByCreate.delete(key);
83
+ for (const deleteTransaction of deferred) {
84
+ if (store.get(deleteTransaction.id)?.status !== 'pending')
85
+ continue;
86
+ enqueue(deleteTransaction);
87
+ }
88
+ }
89
+ /**
90
+ * Merges two update payloads for the same row into one. Later values win, with
91
+ * one exception: a `metadata` field is deep-merged as an object — parsing it
92
+ * first when it arrives as a JSON string — rather than replaced, so partial
93
+ * metadata updates accumulate instead of overwriting each other.
94
+ */
95
+ export function mergeUpdateData(left, right, _modelName) {
96
+ const out = { ...(left || {}) };
97
+ const src = right || {};
98
+ for (const key of Object.keys(src)) {
99
+ // Special case: metadata payloads may be JSON strings; merge objects instead of clobbering
100
+ if (key === 'metadata') {
101
+ const l = out.metadata;
102
+ const r = src.metadata;
103
+ // If both sides undefined/null, continue
104
+ if (l == null && r == null) {
105
+ continue;
106
+ }
107
+ // Normalize to objects
108
+ const toObj = (v) => {
109
+ if (v == null)
110
+ return {};
111
+ if (typeof v === 'string') {
112
+ try {
113
+ return JSON.parse(v);
114
+ }
115
+ catch {
116
+ return {};
117
+ }
118
+ }
119
+ if (typeof v === 'object')
120
+ return v;
121
+ return {};
122
+ };
123
+ const lobj = toObj(l);
124
+ const robj = toObj(r);
125
+ const merged = { ...lobj, ...robj };
126
+ // Re-stringify to match schema input type
127
+ try {
128
+ out.metadata = JSON.stringify(merged);
129
+ }
130
+ catch {
131
+ // Fallback to right-hand side if stringify fails
132
+ out.metadata = typeof r === 'string' ? r : JSON.stringify(robj || {});
133
+ }
134
+ continue;
135
+ }
136
+ // Default: shallow overwrite with right-hand value
137
+ out[key] = src[key];
138
+ }
139
+ return out;
140
+ }
@@ -0,0 +1,130 @@
1
+ /**
2
+ * The vocabulary a local transaction uses on the wire. This module defines the
3
+ * {@link Transaction} record and the helpers that turn a transaction into a
4
+ * wire-safe commit operation: schema-field projection
5
+ * ({@link projectCommitPayload}), write-option projection
6
+ * ({@link applyWriteOptions}), foreign-key-aware priority scoring
7
+ * ({@link computePriorityScore}), and the structural checks used to classify
8
+ * transport errors. Nothing here holds queue state or timers, so the batched
9
+ * queue path and the HTTP commit path share the same projection.
10
+ */
11
+ import { MutationOperationType } from '../types/index.js';
12
+ import type { MutationOptions, WriteOptions } from '../interfaces/index.js';
13
+ export interface UserContext {
14
+ userId: string;
15
+ organizationId: string;
16
+ role?: string;
17
+ teamIds?: string[];
18
+ }
19
+ /** Wire-format mutation payload (post-projection). */
20
+ export type MutationInput = Record<string, unknown>;
21
+ /**
22
+ * Projects a model's serialized data onto the fields declared in its schema and
23
+ * returns a wire-safe commit payload. It does two things:
24
+ *
25
+ * 1. Drops framework-internal keys (`__class`, `__typename`, `clientId`,
26
+ * `syncStatus`) and anything not declared on the model's schema.
27
+ * 2. Passes each declared field's value through unchanged, including
28
+ * JSON-typed fields, which are sent as objects rather than pre-serialized
29
+ * strings (see the note in the body for why).
30
+ *
31
+ * For updates (`dropUndefined: true`), `undefined` values are also removed so
32
+ * they are not written as `SET column = NULL` on the server.
33
+ *
34
+ * Field metadata comes from the model registry, populated when the schema is
35
+ * registered at initialization. If a model has no registered field metadata —
36
+ * for example a manually registered model — projection passes the serialized
37
+ * data through unchanged apart from dropping the framework keys.
38
+ */
39
+ export declare function projectCommitPayload(modelName: string, source: Record<string, unknown>, opts: {
40
+ dropUndefined: boolean;
41
+ }): MutationInput;
42
+ export interface Transaction {
43
+ id: string;
44
+ type: 'create' | 'update' | 'delete' | 'archive' | 'unarchive';
45
+ modelName: string;
46
+ modelId: string;
47
+ modelKey: string;
48
+ data?: MutationInput;
49
+ previousData?: MutationInput | null;
50
+ context: UserContext;
51
+ status: 'pending' | 'executing' | 'awaiting_delta' | 'completed' | 'failed' | 'rolled_back';
52
+ createdAt: number;
53
+ attempts: number;
54
+ priority: 'normal' | 'high';
55
+ priorityScore: number;
56
+ writeOptions?: WriteOptions;
57
+ batchId?: string;
58
+ /** Completed locally without a server operation; no sync echo will arrive. */
59
+ localOnly?: boolean;
60
+ /** Sync-id threshold: the transaction confirms once a delta with an id at least this value arrives. */
61
+ syncIdNeededForCompletion?: number;
62
+ /**
63
+ * Resolves once the server has confirmed this transaction, whether by a delta
64
+ * or an HTTP acknowledgement, and rejects with the originating error if the
65
+ * transaction is permanently rolled back. It gives a caller one place to await
66
+ * the answer to "did my write land?", matching the
67
+ * `commits.create({ wait: 'confirmed' })` and
68
+ * {@link TransactionQueue.waitForConfirmation} vocabulary, so a failure
69
+ * surfaces at the call site instead of only as a silent local rollback. The
70
+ * rejection value is the same {@link AbloError} carried on the queue's
71
+ * `transaction:failed` event.
72
+ */
73
+ confirmation?: Promise<void>;
74
+ }
75
+ export declare const normalizeModelKey: (modelName: string) => string;
76
+ export declare const stripModelSuffix: (modelName: string) => string;
77
+ /**
78
+ * Returns the priority score used to order create operations by foreign-key
79
+ * depth, so a parent row commits before its children.
80
+ *
81
+ * The score comes from a priority map on the runtime configuration, built once
82
+ * at initialization by walking the schema's `belongsTo` graph. No model names
83
+ * are hard-coded here, and an application can override specific priorities
84
+ * through `configOverrides.modelCreatePriority`.
85
+ *
86
+ * Non-create operations (update, delete, archive, unarchive) need no
87
+ * foreign-key ordering because the row already exists, so they all share the
88
+ * configured default non-create priority.
89
+ */
90
+ export declare const computePriorityScore: (type: Transaction["type"], modelName: string) => number;
91
+ export declare const TX_TYPE_TO_MUTATION_OP: Record<Transaction['type'], MutationOperationType>;
92
+ export declare function hasStaleWriteOptions(options?: WriteOptions): boolean;
93
+ export interface WriteOperationFields {
94
+ readAt?: number | null;
95
+ onStale?: 'reject' | 'overwrite' | 'notify' | null;
96
+ options?: Pick<MutationOptions, 'idempotencyKey' | 'label'>;
97
+ }
98
+ /**
99
+ * Copies a transaction's `writeOptions` onto the wire operation. The
100
+ * stale-context guards (`readAt` and `onStale`) sit at the operation's root,
101
+ * while `idempotencyKey` and `label` go in its `options` slot — the
102
+ * `mutation_log` cache key and audit tag. This is the one place caller-supplied
103
+ * write options cross onto the wire.
104
+ */
105
+ export declare function applyWriteOptions<T extends object>(op: T, transaction: Transaction): T & WriteOperationFields;
106
+ /**
107
+ * The structural shape used to inspect transport-layer errors. It covers the
108
+ * GraphQL-style and HTTP-style error shapes the mutation executor can surface,
109
+ * and is kept intentionally narrow so it does not claim fields the runtime may
110
+ * not supply.
111
+ */
112
+ export interface TransportError {
113
+ message?: string;
114
+ code?: string | number;
115
+ extensions?: Record<string, unknown>;
116
+ locations?: readonly unknown[];
117
+ path?: readonly (string | number)[];
118
+ response?: {
119
+ status?: number;
120
+ errors?: readonly {
121
+ extensions?: {
122
+ code?: string;
123
+ };
124
+ message?: string;
125
+ }[];
126
+ };
127
+ error?: string;
128
+ }
129
+ export declare function asTransportError(value: unknown): TransportError;
130
+ export declare function extractStatusCode(error: unknown): number | undefined;