@abloatai/ablo 0.26.0 → 0.28.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.
- package/CHANGELOG.md +42 -2
- package/README.md +102 -86
- package/dist/BaseSyncedStore.d.ts +85 -88
- package/dist/BaseSyncedStore.js +134 -151
- package/dist/Database.d.ts +68 -69
- package/dist/Database.js +316 -135
- package/dist/{ObjectPool.d.ts → InstanceCache.d.ts} +10 -13
- package/dist/{ObjectPool.js → InstanceCache.js} +85 -83
- package/dist/LazyReferenceCollection.d.ts +11 -15
- package/dist/LazyReferenceCollection.js +12 -16
- package/dist/Model.d.ts +54 -52
- package/dist/Model.js +78 -62
- package/dist/ModelRegistry.d.ts +21 -19
- package/dist/ModelRegistry.js +23 -27
- package/dist/NetworkMonitor.d.ts +5 -6
- package/dist/NetworkMonitor.js +5 -6
- package/dist/SyncClient.d.ts +122 -118
- package/dist/SyncClient.js +541 -245
- package/dist/adapters/alwaysOnline.d.ts +6 -8
- package/dist/adapters/alwaysOnline.js +6 -8
- package/dist/adapters/inMemoryStorage.d.ts +10 -9
- package/dist/adapters/inMemoryStorage.js +21 -9
- package/dist/agent/Agent.d.ts +27 -32
- package/dist/agent/Agent.js +18 -19
- package/dist/agent/index.d.ts +4 -4
- package/dist/agent/index.js +5 -5
- package/dist/agent/session.d.ts +47 -44
- package/dist/agent/session.js +37 -48
- package/dist/agent/types.d.ts +26 -31
- package/dist/agent/types.js +6 -7
- package/dist/ai-sdk/coordinatedTool.d.ts +108 -0
- package/dist/ai-sdk/{coordinated-tool.js → coordinatedTool.js} +44 -38
- package/dist/ai-sdk/coordinationContext.d.ts +46 -0
- package/dist/ai-sdk/{coordination-context.js → coordinationContext.js} +26 -33
- package/dist/ai-sdk/index.d.ts +25 -22
- package/dist/ai-sdk/index.js +25 -22
- package/dist/ai-sdk/wrap.d.ts +6 -7
- package/dist/ai-sdk/wrap.js +1 -1
- package/dist/auth/credentialPolicy.d.ts +69 -74
- package/dist/auth/credentialPolicy.js +51 -56
- package/dist/auth/credentialSource.d.ts +6 -5
- package/dist/auth/credentialSource.js +9 -10
- package/dist/auth/index.d.ts +59 -58
- package/dist/auth/index.js +31 -37
- package/dist/auth/schemas.d.ts +5 -4
- package/dist/auth/schemas.js +5 -4
- package/dist/batching/index.d.ts +19 -21
- package/dist/batching/index.js +14 -17
- package/dist/cli.cjs +173 -121
- package/dist/client/Ablo.d.ts +97 -74
- package/dist/client/Ablo.js +129 -163
- package/dist/client/ApiClient.d.ts +30 -19
- package/dist/client/ApiClient.js +442 -81
- package/dist/client/auth.d.ts +47 -47
- package/dist/client/auth.js +108 -117
- package/dist/client/claimHeartbeatLoop.d.ts +50 -0
- package/dist/client/claimHeartbeatLoop.js +88 -0
- package/dist/client/consoleLogger.d.ts +5 -6
- package/dist/client/consoleLogger.js +5 -6
- package/dist/client/createInternalComponents.d.ts +16 -17
- package/dist/client/createInternalComponents.js +26 -31
- package/dist/client/createModelProxy.d.ts +130 -120
- package/dist/client/createModelProxy.js +152 -122
- package/dist/client/credentialEndpoint.d.ts +40 -42
- package/dist/client/credentialEndpoint.js +35 -36
- package/dist/client/functionalUpdate.d.ts +29 -27
- package/dist/client/functionalUpdate.js +21 -21
- package/dist/client/hostedEndpoints.d.ts +9 -12
- package/dist/client/hostedEndpoints.js +9 -12
- package/dist/client/httpClient.d.ts +59 -53
- package/dist/client/httpClient.js +29 -31
- package/dist/client/identity.d.ts +15 -20
- package/dist/client/identity.js +47 -58
- package/dist/client/modelRegistration.d.ts +5 -9
- package/dist/client/modelRegistration.js +78 -87
- package/dist/client/options.d.ts +157 -157
- package/dist/client/options.js +3 -7
- package/dist/client/registerDataSource.d.ts +9 -9
- package/dist/client/registerDataSource.js +15 -16
- package/dist/client/resourceTypes.d.ts +64 -75
- package/dist/client/resourceTypes.js +4 -10
- package/dist/client/schemaConfig.d.ts +31 -43
- package/dist/client/schemaConfig.js +38 -50
- package/dist/client/sessionMint.d.ts +16 -12
- package/dist/client/sessionMint.js +26 -31
- package/dist/client/validateAbloOptions.d.ts +12 -14
- package/dist/client/validateAbloOptions.js +8 -9
- package/dist/client/writeOptionsSchema.d.ts +18 -16
- package/dist/client/writeOptionsSchema.js +23 -20
- package/dist/client/wsMutationExecutor.d.ts +16 -20
- package/dist/client/wsMutationExecutor.js +18 -23
- package/dist/commit/contract.d.ts +493 -0
- package/dist/commit/contract.js +187 -0
- package/dist/commit/index.d.ts +6 -0
- package/dist/commit/index.js +5 -0
- package/dist/context.d.ts +6 -4
- package/dist/context.js +6 -4
- package/dist/coordination/index.d.ts +10 -8
- package/dist/coordination/index.js +14 -12
- package/dist/coordination/schema.d.ts +176 -128
- package/dist/coordination/schema.js +197 -133
- package/dist/coordination/trace.d.ts +9 -10
- package/dist/coordination/trace.js +13 -14
- package/dist/core/DatabaseManager.d.ts +5 -7
- package/dist/core/DatabaseManager.js +15 -19
- package/dist/core/QueryProcessor.d.ts +7 -9
- package/dist/core/QueryProcessor.js +22 -28
- package/dist/core/QueryView.d.ts +8 -8
- package/dist/core/QueryView.js +2 -2
- package/dist/core/StoreManager.d.ts +14 -14
- package/dist/core/StoreManager.js +33 -24
- package/dist/core/ViewRegistry.d.ts +5 -5
- package/dist/core/ViewRegistry.js +4 -4
- package/dist/core/index.d.ts +17 -12
- package/dist/core/index.js +32 -26
- package/dist/core/openIDBWithTimeout.d.ts +38 -36
- package/dist/core/openIDBWithTimeout.js +42 -43
- package/dist/core/queryUtils.d.ts +45 -0
- package/dist/core/queryUtils.js +69 -0
- package/dist/core/storeContract.d.ts +63 -61
- package/dist/core/storeContract.js +8 -12
- package/dist/environment.d.ts +28 -0
- package/dist/environment.js +21 -0
- package/dist/errorCodes.d.ts +107 -99
- package/dist/errorCodes.js +137 -134
- package/dist/errors.d.ts +160 -166
- package/dist/errors.js +155 -158
- package/dist/index.d.ts +36 -27
- package/dist/index.js +91 -86
- package/dist/interfaces/index.d.ts +102 -113
- package/dist/interfaces/index.js +5 -4
- package/dist/keys/index.d.ts +27 -29
- package/dist/keys/index.js +41 -40
- package/dist/mutators/RecordingTransaction.d.ts +16 -16
- package/dist/mutators/RecordingTransaction.js +31 -37
- package/dist/mutators/Transaction.d.ts +18 -26
- package/dist/mutators/Transaction.js +14 -20
- package/dist/mutators/UndoManager.d.ts +124 -131
- package/dist/mutators/UndoManager.js +177 -156
- package/dist/mutators/defineMutators.d.ts +23 -34
- package/dist/mutators/defineMutators.js +14 -20
- package/dist/mutators/inverseOp.d.ts +12 -15
- package/dist/mutators/inverseOp.js +12 -15
- package/dist/mutators/mutateActions.d.ts +10 -9
- package/dist/mutators/mutateActions.js +1 -1
- package/dist/mutators/readerActions.d.ts +9 -8
- package/dist/mutators/readerActions.js +2 -2
- package/dist/mutators/undoApply.d.ts +31 -27
- package/dist/mutators/undoApply.js +26 -24
- package/dist/policy/index.d.ts +5 -3
- package/dist/policy/index.js +5 -3
- package/dist/policy/types.d.ts +104 -100
- package/dist/policy/types.js +67 -66
- package/dist/query/client.d.ts +28 -23
- package/dist/query/client.js +45 -43
- package/dist/query/types.d.ts +37 -60
- package/dist/query/types.js +13 -33
- package/dist/react/AbloProvider.d.ts +1 -1
- package/dist/react/AbloProvider.js +2 -2
- package/dist/react/context.d.ts +25 -28
- package/dist/react/context.js +9 -10
- package/dist/react/index.d.ts +41 -42
- package/dist/react/index.js +37 -38
- package/dist/react/internalContext.d.ts +17 -19
- package/dist/react/useAblo.d.ts +28 -25
- package/dist/react/useAblo.js +41 -17
- package/dist/react/useCurrentUserId.d.ts +8 -7
- package/dist/react/useCurrentUserId.js +8 -7
- package/dist/react/useErrorListener.d.ts +7 -7
- package/dist/react/useErrorListener.js +10 -11
- package/dist/react/useMutationFailureListener.d.ts +8 -8
- package/dist/react/useMutationFailureListener.js +8 -8
- package/dist/react/useMutators.d.ts +11 -11
- package/dist/react/useMutators.js +3 -3
- package/dist/react/useReactive.js +2 -2
- package/dist/react/useSyncStatus.d.ts +4 -6
- package/dist/react/useUndoScope.d.ts +7 -9
- package/dist/react/useUndoScope.js +1 -1
- package/dist/schema/coordination.d.ts +21 -25
- package/dist/schema/coordination.js +21 -25
- package/dist/schema/ddl.d.ts +43 -39
- package/dist/schema/ddl.js +75 -68
- package/dist/schema/ddlLock.d.ts +20 -24
- package/dist/schema/ddlLock.js +18 -23
- package/dist/schema/diff.d.ts +99 -61
- package/dist/schema/diff.js +43 -34
- package/dist/schema/field.d.ts +37 -42
- package/dist/schema/field.js +35 -48
- package/dist/schema/generate.d.ts +12 -12
- package/dist/schema/generate.js +12 -12
- package/dist/schema/index.d.ts +3 -3
- package/dist/schema/index.js +21 -23
- package/dist/schema/model.d.ts +118 -143
- package/dist/schema/model.js +22 -33
- package/dist/schema/openapi.d.ts +10 -9
- package/dist/schema/openapi.js +5 -3
- package/dist/schema/queries.d.ts +29 -31
- package/dist/schema/queries.js +23 -25
- package/dist/schema/relation.d.ts +89 -99
- package/dist/schema/relation.js +13 -13
- package/dist/schema/residency.d.ts +16 -13
- package/dist/schema/residency.js +16 -13
- package/dist/schema/roles.d.ts +36 -43
- package/dist/schema/roles.js +31 -37
- package/dist/schema/schema.d.ts +64 -43
- package/dist/schema/schema.js +31 -32
- package/dist/schema/select.d.ts +13 -13
- package/dist/schema/select.js +13 -13
- package/dist/schema/serialize.d.ts +28 -31
- package/dist/schema/serialize.js +27 -31
- package/dist/schema/sugar.d.ts +17 -32
- package/dist/schema/sugar.js +14 -29
- package/dist/schema/{sync-delta-row.d.ts → syncDeltaRow.d.ts} +26 -49
- package/dist/schema/syncDeltaRow.js +89 -0
- package/dist/schema/tenancy.d.ts +44 -46
- package/dist/schema/tenancy.js +46 -48
- package/dist/server/adapter.d.ts +58 -58
- package/dist/server/adapter.js +13 -14
- package/dist/server/commit.d.ts +60 -64
- package/dist/server/index.d.ts +9 -10
- package/dist/server/index.js +1 -1
- package/dist/server/readConfig.d.ts +70 -0
- package/dist/server/readConfig.js +8 -0
- package/dist/server/storageMode.d.ts +23 -0
- package/dist/server/storageMode.js +17 -0
- package/dist/source/adapter.d.ts +30 -25
- package/dist/source/adapter.js +10 -10
- package/dist/source/adapters/drizzle.d.ts +28 -23
- package/dist/source/adapters/drizzle.js +30 -25
- package/dist/source/adapters/kysely.d.ts +27 -25
- package/dist/source/adapters/kysely.js +24 -23
- package/dist/source/adapters/memory.d.ts +8 -7
- package/dist/source/adapters/memory.js +9 -8
- package/dist/source/adapters/prisma.d.ts +13 -12
- package/dist/source/adapters/prisma.js +22 -25
- package/dist/source/conformance.d.ts +18 -11
- package/dist/source/conformance.js +17 -11
- package/dist/source/connector.d.ts +31 -32
- package/dist/source/connector.js +28 -28
- package/dist/source/connectorProtocol.d.ts +160 -0
- package/dist/source/connectorProtocol.js +162 -0
- package/dist/source/contract.d.ts +26 -27
- package/dist/source/contract.js +28 -29
- package/dist/source/factory.d.ts +46 -58
- package/dist/source/factory.js +22 -27
- package/dist/source/index.d.ts +7 -9
- package/dist/source/index.js +12 -14
- package/dist/source/migrations.d.ts +9 -9
- package/dist/source/migrations.js +9 -9
- package/dist/source/next.d.ts +9 -10
- package/dist/source/next.js +6 -7
- package/dist/source/pushQueue.d.ts +69 -47
- package/dist/source/pushQueue.js +32 -28
- package/dist/source/signing.d.ts +46 -17
- package/dist/source/signing.js +28 -11
- package/dist/source/types.d.ts +121 -104
- package/dist/source/types.js +13 -14
- package/dist/stores/ObjectStore.d.ts +24 -12
- package/dist/stores/ObjectStore.js +38 -16
- package/dist/stores/ObjectStoreContract.d.ts +14 -15
- package/dist/stores/SyncActionStore.d.ts +7 -11
- package/dist/stores/SyncActionStore.js +13 -17
- package/dist/surface.d.ts +28 -21
- package/dist/surface.js +29 -20
- package/dist/sync/{BootstrapHelper.d.ts → BootstrapFetcher.d.ts} +36 -42
- package/dist/sync/{BootstrapHelper.js → BootstrapFetcher.js} +76 -76
- package/dist/sync/ConnectionManager.d.ts +39 -50
- package/dist/sync/ConnectionManager.js +55 -66
- package/dist/sync/NetworkProbe.d.ts +24 -29
- package/dist/sync/NetworkProbe.js +63 -69
- package/dist/sync/{HydrationCoordinator.d.ts → OnDemandLoader.d.ts} +42 -41
- package/dist/sync/{HydrationCoordinator.js → OnDemandLoader.js} +59 -54
- package/dist/sync/{AreaOfInterestManager.d.ts → SubscriptionManager.d.ts} +43 -57
- package/dist/sync/{AreaOfInterestManager.js → SubscriptionManager.js} +43 -51
- package/dist/sync/SyncWebSocket.d.ts +141 -166
- package/dist/sync/SyncWebSocket.js +191 -223
- package/dist/sync/awaitClaimGrant.d.ts +18 -18
- package/dist/sync/awaitClaimGrant.js +11 -11
- package/dist/sync/bootstrapApply.d.ts +34 -24
- package/dist/sync/bootstrapApply.js +27 -19
- package/dist/sync/commitFrames.d.ts +21 -20
- package/dist/sync/commitFrames.js +18 -18
- package/dist/sync/createClaimStream.d.ts +23 -22
- package/dist/sync/createClaimStream.js +105 -23
- package/dist/sync/createPresenceStream.d.ts +19 -18
- package/dist/sync/createPresenceStream.js +25 -26
- package/dist/sync/createSnapshot.d.ts +12 -14
- package/dist/sync/createSnapshot.js +20 -26
- package/dist/sync/credentialLifecycle.d.ts +104 -104
- package/dist/sync/credentialLifecycle.js +140 -147
- package/dist/sync/deltaPipeline.d.ts +36 -34
- package/dist/sync/deltaPipeline.js +64 -65
- package/dist/sync/groupChange.d.ts +63 -61
- package/dist/sync/groupChange.js +74 -78
- package/dist/sync/heartbeat.d.ts +34 -33
- package/dist/sync/heartbeat.js +31 -31
- package/dist/sync/participants.d.ts +19 -19
- package/dist/sync/persistedPrefix.d.ts +12 -0
- package/dist/sync/persistedPrefix.js +22 -0
- package/dist/sync/schemas.d.ts +3 -2
- package/dist/sync/schemas.js +14 -10
- package/dist/sync/syncCursor.d.ts +17 -21
- package/dist/sync/syncCursor.js +17 -21
- package/dist/sync/syncPlan.d.ts +28 -36
- package/dist/sync/syncPlan.js +18 -19
- package/dist/sync/syncPosition.d.ts +54 -49
- package/dist/sync/syncPosition.js +57 -52
- package/dist/sync/wsFrameHandlers.d.ts +35 -36
- package/dist/sync/wsFrameHandlers.js +63 -67
- package/dist/testing/fixtures/bootstrap.d.ts +12 -6
- package/dist/testing/fixtures/bootstrap.js +12 -6
- package/dist/testing/fixtures/deltas.d.ts +30 -33
- package/dist/testing/fixtures/deltas.js +30 -33
- package/dist/testing/fixtures/models.d.ts +11 -10
- package/dist/testing/fixtures/models.js +11 -10
- package/dist/testing/helpers/{react-wrapper.d.ts → reactWrapper.d.ts} +13 -10
- package/dist/testing/helpers/{react-wrapper.js → reactWrapper.js} +15 -12
- package/dist/testing/helpers/{sync-engine-harness.d.ts → syncEngineHarness.d.ts} +17 -15
- package/dist/testing/helpers/{sync-engine-harness.js → syncEngineHarness.js} +12 -10
- package/dist/testing/helpers/wait.d.ts +13 -8
- package/dist/testing/helpers/wait.js +13 -8
- package/dist/testing/index.d.ts +5 -3
- package/dist/testing/index.js +3 -2
- package/dist/testing/mocks/FakeDatabase.d.ts +18 -0
- package/dist/testing/mocks/FakeDatabase.js +10 -0
- package/dist/testing/mocks/MockMutationExecutor.d.ts +18 -17
- package/dist/testing/mocks/MockMutationExecutor.js +15 -14
- package/dist/testing/mocks/MockNetworkMonitor.d.ts +8 -8
- package/dist/testing/mocks/MockNetworkMonitor.js +8 -8
- package/dist/testing/mocks/MockSyncContext.d.ts +20 -17
- package/dist/testing/mocks/MockSyncContext.js +15 -13
- package/dist/testing/mocks/MockSyncStore.d.ts +10 -10
- package/dist/testing/mocks/MockSyncStore.js +11 -11
- package/dist/testing/mocks/MockWebSocket.d.ts +28 -23
- package/dist/testing/mocks/MockWebSocket.js +22 -21
- package/dist/transactions/TransactionQueue.d.ts +244 -181
- package/dist/transactions/TransactionQueue.js +929 -423
- package/dist/transactions/TransactionStore.d.ts +6 -4
- package/dist/transactions/TransactionStore.js +6 -4
- package/dist/transactions/UnconfirmedWrites.d.ts +82 -0
- package/dist/transactions/UnconfirmedWrites.js +104 -0
- package/dist/transactions/coalesceRules.d.ts +41 -17
- package/dist/transactions/coalesceRules.js +40 -17
- package/dist/transactions/commitEnvelope.d.ts +132 -0
- package/dist/transactions/commitEnvelope.js +139 -0
- package/dist/transactions/commitOutboxStore.d.ts +32 -0
- package/dist/transactions/commitOutboxStore.js +26 -0
- package/dist/transactions/commitPayload.d.ts +63 -52
- package/dist/transactions/commitPayload.js +54 -57
- package/dist/transactions/deltaConfirmation.d.ts +20 -22
- package/dist/transactions/deltaConfirmation.js +37 -45
- package/dist/transactions/httpCommitEnvelope.d.ts +43 -0
- package/dist/transactions/httpCommitEnvelope.js +179 -0
- package/dist/transactions/optimisticApply.d.ts +49 -0
- package/dist/transactions/optimisticApply.js +65 -0
- package/dist/transactions/replayValidation.d.ts +182 -0
- package/dist/transactions/replayValidation.js +156 -0
- package/dist/types/global.d.ts +46 -41
- package/dist/types/global.js +20 -19
- package/dist/types/index.d.ts +71 -77
- package/dist/types/index.js +22 -22
- package/dist/types/modelData.d.ts +6 -8
- package/dist/types/modelData.js +5 -7
- package/dist/types/participant.d.ts +10 -11
- package/dist/types/participant.js +6 -8
- package/dist/types/streams.d.ts +208 -195
- package/dist/types/streams.js +7 -7
- package/dist/utils/asyncIterator.d.ts +25 -32
- package/dist/utils/asyncIterator.js +25 -32
- package/dist/utils/duration.d.ts +12 -15
- package/dist/utils/duration.js +12 -15
- package/dist/utils/mobxSetup.d.ts +53 -0
- package/dist/utils/{mobx-setup.js → mobxSetup.js} +42 -98
- package/dist/webhooks/events.d.ts +21 -16
- package/dist/webhooks/events.js +10 -8
- package/dist/webhooks/index.d.ts +5 -7
- package/dist/webhooks/index.js +5 -7
- package/dist/wire/bootstrapReason.d.ts +9 -0
- package/dist/wire/bootstrapReason.js +8 -0
- package/dist/{schema/sync-delta-wire.d.ts → wire/delta.d.ts} +58 -41
- package/dist/wire/delta.js +114 -0
- package/dist/wire/errorEnvelope.d.ts +30 -31
- package/dist/wire/errorEnvelope.js +34 -40
- package/dist/wire/frames.d.ts +315 -86
- package/dist/wire/frames.js +47 -33
- package/dist/wire/index.d.ts +18 -14
- package/dist/wire/index.js +32 -27
- package/dist/wire/listEnvelope.d.ts +16 -23
- package/dist/wire/listEnvelope.js +7 -6
- package/dist/wire/protocol.d.ts +25 -32
- package/dist/wire/protocol.js +25 -32
- package/dist/wire/protocolVersion.d.ts +44 -40
- package/dist/wire/protocolVersion.js +44 -40
- package/docs/api.md +10 -10
- package/docs/coordination.md +59 -0
- package/docs/mcp.md +1 -1
- package/package.json +17 -11
- package/dist/ai-sdk/coordinated-tool.d.ts +0 -101
- package/dist/ai-sdk/coordination-context.d.ts +0 -52
- package/dist/core/query-utils.d.ts +0 -34
- package/dist/core/query-utils.js +0 -59
- package/dist/schema/sync-delta-row.js +0 -103
- package/dist/schema/sync-delta-wire.js +0 -102
- package/dist/server/read-config.d.ts +0 -67
- package/dist/server/read-config.js +0 -8
- package/dist/server/storage-mode.d.ts +0 -8
- package/dist/server/storage-mode.js +0 -28
- package/dist/source/connector-protocol.d.ts +0 -159
- package/dist/source/connector-protocol.js +0 -161
- package/dist/transactions/OptimisticEchoTracker.d.ts +0 -82
- package/dist/transactions/OptimisticEchoTracker.js +0 -104
- package/dist/transactions/mutation-error-handler.d.ts +0 -5
- package/dist/transactions/mutation-error-handler.js +0 -39
- package/dist/transactions/optimistic.d.ts +0 -24
- package/dist/transactions/optimistic.js +0 -45
- package/dist/transactions/persistedReplay.d.ts +0 -93
- package/dist/transactions/persistedReplay.js +0 -105
- package/dist/utils/mobx-setup.d.ts +0 -42
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* the queue's hot paths
|
|
4
|
-
*
|
|
5
|
-
*
|
|
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.
|
|
6
8
|
*/
|
|
7
9
|
import type { Transaction } from './commitPayload.js';
|
|
8
10
|
export declare class TransactionStore {
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* the queue's hot paths
|
|
4
|
-
*
|
|
5
|
-
*
|
|
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.
|
|
6
8
|
*/
|
|
7
9
|
export class TransactionStore {
|
|
8
10
|
transactions = new Map();
|
|
@@ -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
|
+
}
|
|
@@ -1,34 +1,58 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
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:
|
|
4
5
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* parking (
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
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.
|
|
13
15
|
*
|
|
14
|
-
* The queue
|
|
15
|
-
*
|
|
16
|
+
* The queue keeps the `enqueue` and `delete` methods that orchestrate optimistic
|
|
17
|
+
* state and events; these functions hold only the coalescing rules.
|
|
16
18
|
*/
|
|
17
19
|
import type { MutationInput, Transaction } from './commitPayload.js';
|
|
18
|
-
/** The
|
|
20
|
+
/** The subset of {@link TransactionStore} that the coalescing rules read. */
|
|
19
21
|
export interface TransactionStoreLike {
|
|
20
22
|
get(id: string): Transaction | undefined;
|
|
21
23
|
getByStatus(status: Transaction['status']): Transaction[];
|
|
22
24
|
}
|
|
23
25
|
export declare const entityKey: (modelName: string, modelId: string) => string;
|
|
24
26
|
/**
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* pending bucket
|
|
28
|
-
* held it so the caller can cancel it
|
|
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.
|
|
29
32
|
*/
|
|
30
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
|
+
*/
|
|
31
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
|
+
*/
|
|
32
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
|
+
*/
|
|
33
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
|
+
*/
|
|
34
58
|
export declare function mergeUpdateData(left: MutationInput | undefined, right: MutationInput | undefined, _modelName?: string): MutationInput;
|
|
@@ -1,26 +1,29 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
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:
|
|
4
5
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* parking (
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
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.
|
|
13
15
|
*
|
|
14
|
-
* The queue
|
|
15
|
-
*
|
|
16
|
+
* The queue keeps the `enqueue` and `delete` methods that orchestrate optimistic
|
|
17
|
+
* state and events; these functions hold only the coalescing rules.
|
|
16
18
|
*/
|
|
17
19
|
export const entityKey = (modelName, modelId) => `${modelName}:${modelId}`;
|
|
18
20
|
const isTransactionForModel = (transaction, modelName, modelId) => transaction.modelName === modelName && transaction.modelId === modelId;
|
|
19
21
|
/**
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* pending bucket
|
|
23
|
-
* held it so the caller can cancel it
|
|
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.
|
|
24
27
|
*/
|
|
25
28
|
export function takeUnsentCreateForModel(staged, queued, store, modelName, modelId) {
|
|
26
29
|
const isUnsentCreate = (tx) => tx.type === 'create' &&
|
|
@@ -37,6 +40,12 @@ export function takeUnsentCreateForModel(staged, queued, store, modelName, model
|
|
|
37
40
|
}
|
|
38
41
|
return store.getByStatus('pending').find(isUnsentCreate);
|
|
39
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
|
+
*/
|
|
40
49
|
export function findCreateBarrierForDelete(store, modelName, modelId) {
|
|
41
50
|
const liveCreates = [
|
|
42
51
|
...store.getByStatus('pending'),
|
|
@@ -50,12 +59,21 @@ export function findCreateBarrierForDelete(store, modelName, modelId) {
|
|
|
50
59
|
(tx.status !== 'pending' || tx.attempts > 0));
|
|
51
60
|
return liveCreates.sort((a, b) => b.createdAt - a.createdAt)[0];
|
|
52
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
|
+
*/
|
|
53
67
|
export function deferDeleteUntilCreateSettles(deferredDeletesByCreate, createTransaction, deleteTransaction) {
|
|
54
68
|
const key = entityKey(createTransaction.modelName, createTransaction.modelId);
|
|
55
69
|
const deferred = deferredDeletesByCreate.get(key) ?? [];
|
|
56
70
|
deferred.push(deleteTransaction);
|
|
57
71
|
deferredDeletesByCreate.set(key, deferred);
|
|
58
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
|
+
*/
|
|
59
77
|
export function releaseDeferredDeletesForCreate(deferredDeletesByCreate, store, enqueue, createTransaction) {
|
|
60
78
|
const key = entityKey(createTransaction.modelName, createTransaction.modelId);
|
|
61
79
|
const deferred = deferredDeletesByCreate.get(key);
|
|
@@ -68,7 +86,12 @@ export function releaseDeferredDeletesForCreate(deferredDeletesByCreate, store,
|
|
|
68
86
|
enqueue(deleteTransaction);
|
|
69
87
|
}
|
|
70
88
|
}
|
|
71
|
-
|
|
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
|
+
*/
|
|
72
95
|
export function mergeUpdateData(left, right, _modelName) {
|
|
73
96
|
const out = { ...(left || {}) };
|
|
74
97
|
const src = right || {};
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Runtime contracts for retry-safe commits.
|
|
3
|
+
*
|
|
4
|
+
* `commitEnvelopeMemberSchema` is the compact pointer stored on an in-memory
|
|
5
|
+
* transaction. `durableCommitEnvelopeSchema` is the actual outbox record: one
|
|
6
|
+
* atomic IndexedDB value containing the stable request key, exact ordered wire
|
|
7
|
+
* operations, and the source mutations it supersedes.
|
|
8
|
+
*/
|
|
9
|
+
import { z } from 'zod';
|
|
10
|
+
export declare const COMMIT_ENVELOPE_VERSION: 1;
|
|
11
|
+
export declare const COMMIT_ENVELOPE_RECORD_PREFIX = "commit-envelope:";
|
|
12
|
+
/** One transaction's position in a commit; this is not the envelope itself. */
|
|
13
|
+
export declare const commitEnvelopeMemberSchema: z.ZodObject<{
|
|
14
|
+
idempotencyKey: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
|
|
15
|
+
operationIndex: z.ZodNumber;
|
|
16
|
+
operationCount: z.ZodNumber;
|
|
17
|
+
sealedAt: z.ZodOptional<z.ZodNumber>;
|
|
18
|
+
sequence: z.ZodOptional<z.ZodNumber>;
|
|
19
|
+
}, z.core.$strict>;
|
|
20
|
+
export type CommitEnvelopeMember = z.infer<typeof commitEnvelopeMemberSchema>;
|
|
21
|
+
/** The legacy mutation operation shape sent by the current commit transport. */
|
|
22
|
+
export declare const durableCommitOperationSchema: z.ZodObject<{
|
|
23
|
+
type: z.ZodEnum<{
|
|
24
|
+
CREATE: "CREATE";
|
|
25
|
+
UPDATE: "UPDATE";
|
|
26
|
+
DELETE: "DELETE";
|
|
27
|
+
ARCHIVE: "ARCHIVE";
|
|
28
|
+
UNARCHIVE: "UNARCHIVE";
|
|
29
|
+
}>;
|
|
30
|
+
readAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
31
|
+
onStale: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
32
|
+
reject: "reject";
|
|
33
|
+
overwrite: "overwrite";
|
|
34
|
+
notify: "notify";
|
|
35
|
+
}>>>;
|
|
36
|
+
model: z.ZodString;
|
|
37
|
+
id: z.ZodString;
|
|
38
|
+
input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
39
|
+
transactionId: z.ZodOptional<z.ZodString>;
|
|
40
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
41
|
+
idempotencyKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
42
|
+
label: z.ZodOptional<z.ZodString>;
|
|
43
|
+
}, z.core.$strict>>;
|
|
44
|
+
}, z.core.$strip>;
|
|
45
|
+
export type DurableCommitOperation = z.infer<typeof durableCommitOperationSchema>;
|
|
46
|
+
export type DurableCommitOperationInput = z.input<typeof durableCommitOperationSchema>;
|
|
47
|
+
export declare const commitOutboxScopeSchema: z.ZodObject<{
|
|
48
|
+
organizationId: z.ZodString;
|
|
49
|
+
participantId: z.ZodString;
|
|
50
|
+
namespace: z.ZodString;
|
|
51
|
+
}, z.core.$strict>;
|
|
52
|
+
export type CommitOutboxScope = z.infer<typeof commitOutboxScopeSchema>;
|
|
53
|
+
/**
|
|
54
|
+
* One crash-durable logical commit. Keeping every operation in one record makes
|
|
55
|
+
* membership and order atomic: recovery can observe the old record or the new
|
|
56
|
+
* record, never half an envelope.
|
|
57
|
+
*/
|
|
58
|
+
export declare const durableCommitEnvelopeSchema: z.ZodObject<{
|
|
59
|
+
id: z.ZodString;
|
|
60
|
+
type: z.ZodLiteral<"commit_envelope">;
|
|
61
|
+
storageVersion: z.ZodLiteral<1>;
|
|
62
|
+
origin: z.ZodEnum<{
|
|
63
|
+
model_batch: "model_batch";
|
|
64
|
+
atomic_commit: "atomic_commit";
|
|
65
|
+
}>;
|
|
66
|
+
idempotencyKey: z.core.$ZodBranded<z.ZodString, "IdempotencyKey", "out">;
|
|
67
|
+
operations: z.ZodArray<z.ZodObject<{
|
|
68
|
+
type: z.ZodEnum<{
|
|
69
|
+
CREATE: "CREATE";
|
|
70
|
+
UPDATE: "UPDATE";
|
|
71
|
+
DELETE: "DELETE";
|
|
72
|
+
ARCHIVE: "ARCHIVE";
|
|
73
|
+
UNARCHIVE: "UNARCHIVE";
|
|
74
|
+
}>;
|
|
75
|
+
readAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
76
|
+
onStale: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
77
|
+
reject: "reject";
|
|
78
|
+
overwrite: "overwrite";
|
|
79
|
+
notify: "notify";
|
|
80
|
+
}>>>;
|
|
81
|
+
model: z.ZodString;
|
|
82
|
+
id: z.ZodString;
|
|
83
|
+
input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
84
|
+
transactionId: z.ZodOptional<z.ZodString>;
|
|
85
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
86
|
+
idempotencyKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
87
|
+
label: z.ZodOptional<z.ZodString>;
|
|
88
|
+
}, z.core.$strict>>;
|
|
89
|
+
}, z.core.$strip>>;
|
|
90
|
+
sourceMutationIds: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
91
|
+
commitOptions: z.ZodDefault<z.ZodObject<{
|
|
92
|
+
causedByTaskId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
93
|
+
reads: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
94
|
+
model: z.ZodString;
|
|
95
|
+
id: z.ZodString;
|
|
96
|
+
readAt: z.ZodNumber;
|
|
97
|
+
fields: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
98
|
+
onStale: z.ZodOptional<z.ZodEnum<{
|
|
99
|
+
reject: "reject";
|
|
100
|
+
overwrite: "overwrite";
|
|
101
|
+
notify: "notify";
|
|
102
|
+
}>>;
|
|
103
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
104
|
+
group: z.ZodString;
|
|
105
|
+
readAt: z.ZodNumber;
|
|
106
|
+
onStale: z.ZodOptional<z.ZodEnum<{
|
|
107
|
+
reject: "reject";
|
|
108
|
+
overwrite: "overwrite";
|
|
109
|
+
notify: "notify";
|
|
110
|
+
}>>;
|
|
111
|
+
}, z.core.$strip>]>>>>;
|
|
112
|
+
}, z.core.$strict>>;
|
|
113
|
+
scope: z.ZodOptional<z.ZodObject<{
|
|
114
|
+
organizationId: z.ZodString;
|
|
115
|
+
participantId: z.ZodString;
|
|
116
|
+
namespace: z.ZodString;
|
|
117
|
+
}, z.core.$strict>>;
|
|
118
|
+
createdAt: z.ZodNumber;
|
|
119
|
+
sealedAt: z.ZodNumber;
|
|
120
|
+
sequence: z.ZodOptional<z.ZodNumber>;
|
|
121
|
+
timestamp: z.ZodNumber;
|
|
122
|
+
}, z.core.$strict>;
|
|
123
|
+
export type DurableCommitEnvelope = z.infer<typeof durableCommitEnvelopeSchema>;
|
|
124
|
+
export declare function commitEnvelopeRecordId(idempotencyKey: string): string;
|
|
125
|
+
/** Constructs validated member metadata when an in-memory batch is formed. */
|
|
126
|
+
export declare function createCommitEnvelopeMember(value: z.input<typeof commitEnvelopeMemberSchema>): CommitEnvelopeMember;
|
|
127
|
+
/**
|
|
128
|
+
* Freezes the exact JSON request that will be persisted and sent. The JSON
|
|
129
|
+
* round-trip deliberately applies the same Date/undefined semantics as the
|
|
130
|
+
* WebSocket transport before the request fingerprint becomes durable.
|
|
131
|
+
*/
|
|
132
|
+
export declare function createDurableCommitEnvelope(value: Omit<z.input<typeof durableCommitEnvelopeSchema>, 'id' | 'type' | 'storageVersion' | 'timestamp'>): DurableCommitEnvelope;
|