@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,67 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* `@abloatai/ablo/server` — per-model READ configuration the bootstrap
|
|
3
|
-
* reader consumes. Host-side type config (physical table, tenancy column,
|
|
4
|
-
* parent-scoping) — pure data, no `postgres` — so it lives in the server
|
|
5
|
-
* subpath and feeds the `DataAdapter` read contract. The SQL that consumes it
|
|
6
|
-
* (the bootstrap query builder) stays host-side.
|
|
7
|
-
*/
|
|
8
|
-
/** A field→column mapping with an explicit post-`SELECT *` alias. */
|
|
9
|
-
export interface ColumnOverride {
|
|
10
|
-
readonly field: string;
|
|
11
|
-
readonly column: string;
|
|
12
|
-
readonly alias: string;
|
|
13
|
-
}
|
|
14
|
-
export interface BootstrapModel {
|
|
15
|
-
name: string;
|
|
16
|
-
/**
|
|
17
|
-
* Additional names accepted for request-side lookup/filtering. In DB-canonical
|
|
18
|
-
* mode `name` stays the physical table name, while aliases cover generated
|
|
19
|
-
* compatibility names such as `WeatherReports` / `weatherReports`.
|
|
20
|
-
*/
|
|
21
|
-
aliases?: readonly string[];
|
|
22
|
-
/**
|
|
23
|
-
* Schema key used by source endpoints. `name` remains the wire/result model
|
|
24
|
-
* name, usually the typename; source handlers are keyed by the developer's
|
|
25
|
-
* schema object (`files`, `slideLayers`, ...).
|
|
26
|
-
*/
|
|
27
|
-
sourceModel?: string;
|
|
28
|
-
table: string;
|
|
29
|
-
syncGroups?: string[];
|
|
30
|
-
enabled?: boolean;
|
|
31
|
-
/** Max rows to return. Omit for unlimited. Maps to schema's bootstrapLimit. */
|
|
32
|
-
limit?: number;
|
|
33
|
-
/** SQL ORDER BY clause. Default: 'id'. Maps to schema's bootstrapOrderBy. */
|
|
34
|
-
orderBy?: string;
|
|
35
|
-
/** Whether the table has organization_id. Default: true. */
|
|
36
|
-
orgScoped?: boolean;
|
|
37
|
-
/** Physical tenancy column (default `organization_id`, configurable per model). */
|
|
38
|
-
orgColumn?: string;
|
|
39
|
-
/**
|
|
40
|
-
* Parent-table scoping for rows with no `organization_id` column. Mirrors the
|
|
41
|
-
* schema's `scopedVia` option. When set, the bootstrap query emits:
|
|
42
|
-
*
|
|
43
|
-
* WHERE <table>.<localKey> IN
|
|
44
|
-
* (SELECT <parentKey> FROM <parentTable> WHERE <parentOrgColumn> = $1)
|
|
45
|
-
*
|
|
46
|
-
* Applied IN ADDITION TO whatever `orgScoped` dictates — so a table can have
|
|
47
|
-
* its own `organization_id` AND further narrow via a parent, though the common
|
|
48
|
-
* use is `orgScoped: false` + `scopedVia` on tables that lack the column.
|
|
49
|
-
*/
|
|
50
|
-
scopedVia?: {
|
|
51
|
-
localKey: string;
|
|
52
|
-
parentTable: string;
|
|
53
|
-
parentKey?: string;
|
|
54
|
-
parentOrgColumn?: string;
|
|
55
|
-
};
|
|
56
|
-
/** Client-facing field name → physical DB column for declared fields. */
|
|
57
|
-
fieldColumns?: Record<string, string>;
|
|
58
|
-
/** Physical-column aliases needed after SELECT * for `.from(...)` fields. */
|
|
59
|
-
columnOverrides?: readonly ColumnOverride[];
|
|
60
|
-
/**
|
|
61
|
-
* Physical columns the schema declares as `json` (`field.json()`). A json
|
|
62
|
-
* field stored in a TEXT column comes back from `row_to_json` as a serialized
|
|
63
|
-
* string; the bootstrap re-parses these so the wire is the canonical object
|
|
64
|
-
* regardless of physical column type (jsonb returns objects natively → no-op).
|
|
65
|
-
*/
|
|
66
|
-
jsonColumns?: readonly string[];
|
|
67
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* `@abloatai/ablo/server` — per-model READ configuration the bootstrap
|
|
3
|
-
* reader consumes. Host-side type config (physical table, tenancy column,
|
|
4
|
-
* parent-scoping) — pure data, no `postgres` — so it lives in the server
|
|
5
|
-
* subpath and feeds the `DataAdapter` read contract. The SQL that consumes it
|
|
6
|
-
* (the bootstrap query builder) stays host-side.
|
|
7
|
-
*/
|
|
8
|
-
export {};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
/** See module note — host-deployment vocabulary, never customer-facing. */
|
|
2
|
-
export declare const storageModeSchema: z.ZodEnum<{
|
|
3
|
-
source: "source";
|
|
4
|
-
hosted: "hosted";
|
|
5
|
-
selfHosted: "selfHosted";
|
|
6
|
-
}>;
|
|
7
|
-
/** See module note — host-deployment vocabulary, never customer-facing. */
|
|
8
|
-
export type StorageMode = z.infer<typeof storageModeSchema>;
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* `@abloatai/ablo/server` — the storage-mode vocabulary the `DataAdapter`
|
|
3
|
-
* contract supports. Analogous to Better Auth's adapter `id`/`adapterId`: a
|
|
4
|
-
* diagnostic discriminator on the adapter, NOT a routing switch (routing goes
|
|
5
|
-
* through the resolver/factory). The package owns this enum so the contract and
|
|
6
|
-
* every host adapter agree on the closed set:
|
|
7
|
-
* - `hosted` — Ablo's control-plane database.
|
|
8
|
-
* - `selfHosted` — the customer's database, same execution path as hosted.
|
|
9
|
-
* - `source` — a customer-owned endpoint (credentialless ingestion).
|
|
10
|
-
*
|
|
11
|
-
* Deployment topology, not product vocabulary. Customers never see a
|
|
12
|
-
* "storage mode" — their story is `ablo connect` (WAL replication: reads tail
|
|
13
|
-
* their database's logical-replication stream, the data stays in their DB)
|
|
14
|
-
* with the signed `dataSource()` endpoint as the marked fallback (ADR 0002,
|
|
15
|
-
* docs/decisions/0002-read-path-logical-replication-vs-data-hosting.md).
|
|
16
|
-
* The `databaseUrl` dial-in that this enum's `selfHosted` arm serves is
|
|
17
|
-
* DEPRECATED pending the WAL read cutover — do not build on it.
|
|
18
|
-
* This export exists for the sync-server host only.
|
|
19
|
-
*
|
|
20
|
-
* NOT `@internal`-tagged: tsconfig.build.json sets `stripInternal`, and these
|
|
21
|
-
* symbols are re-exported by `server/index.ts` — tagging them strips them from
|
|
22
|
-
* the emitted d.ts, leaving an empty `export {}` module behind a live
|
|
23
|
-
* re-export. `skipLibCheck` masks the break and `StorageMode` silently
|
|
24
|
-
* degrades to an error-any for every dist consumer (the sync-server host).
|
|
25
|
-
*/
|
|
26
|
-
import { z } from 'zod';
|
|
27
|
-
/** See module note — host-deployment vocabulary, never customer-facing. */
|
|
28
|
-
export const storageModeSchema = z.enum(['hosted', 'source', 'selfHosted']);
|
|
@@ -1,159 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Data Source reverse-channel wire protocol.
|
|
3
|
-
*
|
|
4
|
-
* The `commit`/`load`/`list` leg of Data Source mode is normally an INBOUND
|
|
5
|
-
* webhook (Ablo Cloud → your HTTPS endpoint). That requires a public URL, so it
|
|
6
|
-
* doesn't work on `localhost` or inside a locked-down VPC with no inbound path.
|
|
7
|
-
*
|
|
8
|
-
* The reverse channel inverts the direction: the customer's connector dials OUT
|
|
9
|
-
* to Ablo Cloud over a WebSocket and serves those same requests over the open
|
|
10
|
-
* socket — the Stripe-CLI `stripe listen` pattern. This module defines the
|
|
11
|
-
* frames that travel over that socket.
|
|
12
|
-
*
|
|
13
|
-
* Trust model is unchanged. A `request` frame carries the SAME Standard Webhooks
|
|
14
|
-
* signature headers (`webhook-id` / `webhook-timestamp` / `webhook-signature`)
|
|
15
|
-
* and the SAME raw body Ablo would have POSTed, so the connector verifies it
|
|
16
|
-
* through the unchanged `verifyAbloSourceRequest`. Only the transport differs.
|
|
17
|
-
*
|
|
18
|
-
* Frames are validated with zod at the boundary (matching `contract.ts`): a
|
|
19
|
-
* malformed frame is rejected at the edge, and every wire type is inferred from
|
|
20
|
-
* one schema so the two sides can never silently drift.
|
|
21
|
-
*/
|
|
22
|
-
import { z } from 'zod';
|
|
23
|
-
/**
|
|
24
|
-
* Wire-protocol version. Bumped on any breaking frame-shape change so an old
|
|
25
|
-
* connector talking to a new server (or vice-versa) fails fast at `register`
|
|
26
|
-
* instead of misparsing a frame mid-stream.
|
|
27
|
-
*/
|
|
28
|
-
export declare const SOURCE_CONNECTOR_PROTOCOL_VERSION = 1;
|
|
29
|
-
/** Path the connector dials. Appended to the connector's `baseURL`. */
|
|
30
|
-
export declare const SOURCE_CONNECTOR_WS_PATH = "/v1/source/listen";
|
|
31
|
-
/**
|
|
32
|
-
* Negotiated WebSocket subprotocol that marks a reverse-channel source
|
|
33
|
-
* connector (vs. the SDK sync client's `ablo.sync.v1`). The server selects and
|
|
34
|
-
* echoes back ONLY this value, never the token-bearing subprotocol — keeping the
|
|
35
|
-
* credential out of ALB / proxy logs exactly like the sync socket does.
|
|
36
|
-
*/
|
|
37
|
-
export declare const WS_SOURCE_SUBPROTOCOL = "ablo.source.v1";
|
|
38
|
-
/**
|
|
39
|
-
* Build the `Sec-WebSocket-Protocol` list a connector offers: the source
|
|
40
|
-
* protocol plus the bearer credential (`ablo.bearer.<apiKey>`). Browsers can't
|
|
41
|
-
* set an `Authorization` header on a WebSocket, so the API key rides as a
|
|
42
|
-
* subprotocol — the same mechanism the SDK sync client uses, read server-side by
|
|
43
|
-
* the shared `extractBearer`.
|
|
44
|
-
*/
|
|
45
|
-
export declare function sourceConnectorSubprotocols(apiKey: string): string[];
|
|
46
|
-
/**
|
|
47
|
-
* Connector → server, first frame after the socket opens and authenticates.
|
|
48
|
-
* Auth and source resolution happen at the WS handshake from the API key; this
|
|
49
|
-
* frame only carries protocol negotiation + advisory metadata.
|
|
50
|
-
*/
|
|
51
|
-
export declare const registerFrameSchema: z.ZodObject<{
|
|
52
|
-
type: z.ZodLiteral<"register">;
|
|
53
|
-
protocolVersion: z.ZodNumber;
|
|
54
|
-
client: z.ZodOptional<z.ZodString>;
|
|
55
|
-
}, z.core.$strip>;
|
|
56
|
-
export type RegisterFrame = z.infer<typeof registerFrameSchema>;
|
|
57
|
-
/**
|
|
58
|
-
* Server → connector, acknowledges a successful `register`. Echoes the resolved
|
|
59
|
-
* source identity so the connector can log/verify which source it is serving.
|
|
60
|
-
*/
|
|
61
|
-
export declare const readyFrameSchema: z.ZodObject<{
|
|
62
|
-
type: z.ZodLiteral<"ready">;
|
|
63
|
-
protocolVersion: z.ZodNumber;
|
|
64
|
-
sourceId: z.ZodOptional<z.ZodString>;
|
|
65
|
-
organizationId: z.ZodOptional<z.ZodString>;
|
|
66
|
-
environment: z.ZodOptional<z.ZodEnum<{
|
|
67
|
-
production: "production";
|
|
68
|
-
sandbox: "sandbox";
|
|
69
|
-
}>>;
|
|
70
|
-
}, z.core.$strip>;
|
|
71
|
-
export type ReadyFrame = z.infer<typeof readyFrameSchema>;
|
|
72
|
-
/**
|
|
73
|
-
* Server → connector, one drained `commit`/`load`/`list` request. `headers` and
|
|
74
|
-
* `body` are byte-identical to what the inbound webhook path would have sent —
|
|
75
|
-
* the connector replays them into a synthesized `Request` so the unchanged
|
|
76
|
-
* handler verifies the signature exactly as in production.
|
|
77
|
-
*/
|
|
78
|
-
export declare const requestFrameSchema: z.ZodObject<{
|
|
79
|
-
type: z.ZodLiteral<"request">;
|
|
80
|
-
id: z.ZodString;
|
|
81
|
-
method: z.ZodLiteral<"POST">;
|
|
82
|
-
url: z.ZodString;
|
|
83
|
-
headers: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
84
|
-
body: z.ZodString;
|
|
85
|
-
}, z.core.$strip>;
|
|
86
|
-
export type RequestFrame = z.infer<typeof requestFrameSchema>;
|
|
87
|
-
/**
|
|
88
|
-
* Connector → server, the handler's `Response` for one `request`. The server
|
|
89
|
-
* resolves the pending request keyed by `id` and feeds `status`/`body` back to
|
|
90
|
-
* the `SourceClient` as if an HTTP response had returned.
|
|
91
|
-
*/
|
|
92
|
-
export declare const responseFrameSchema: z.ZodObject<{
|
|
93
|
-
type: z.ZodLiteral<"response">;
|
|
94
|
-
id: z.ZodString;
|
|
95
|
-
status: z.ZodNumber;
|
|
96
|
-
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
97
|
-
body: z.ZodString;
|
|
98
|
-
}, z.core.$strip>;
|
|
99
|
-
export type ResponseFrame = z.infer<typeof responseFrameSchema>;
|
|
100
|
-
/**
|
|
101
|
-
* Either direction, out-of-band failure not tied to a single request body
|
|
102
|
-
* (auth rejected, unsupported protocol version, malformed frame). When `id` is
|
|
103
|
-
* present the error pertains to that pending request and fails it; otherwise it
|
|
104
|
-
* is a connection-level error.
|
|
105
|
-
*/
|
|
106
|
-
export declare const errorFrameSchema: z.ZodObject<{
|
|
107
|
-
type: z.ZodLiteral<"error">;
|
|
108
|
-
id: z.ZodOptional<z.ZodString>;
|
|
109
|
-
code: z.ZodString;
|
|
110
|
-
message: z.ZodString;
|
|
111
|
-
}, z.core.$strip>;
|
|
112
|
-
export type ErrorFrame = z.infer<typeof errorFrameSchema>;
|
|
113
|
-
export declare const connectorFrameSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
114
|
-
type: z.ZodLiteral<"register">;
|
|
115
|
-
protocolVersion: z.ZodNumber;
|
|
116
|
-
client: z.ZodOptional<z.ZodString>;
|
|
117
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
118
|
-
type: z.ZodLiteral<"ready">;
|
|
119
|
-
protocolVersion: z.ZodNumber;
|
|
120
|
-
sourceId: z.ZodOptional<z.ZodString>;
|
|
121
|
-
organizationId: z.ZodOptional<z.ZodString>;
|
|
122
|
-
environment: z.ZodOptional<z.ZodEnum<{
|
|
123
|
-
production: "production";
|
|
124
|
-
sandbox: "sandbox";
|
|
125
|
-
}>>;
|
|
126
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
127
|
-
type: z.ZodLiteral<"request">;
|
|
128
|
-
id: z.ZodString;
|
|
129
|
-
method: z.ZodLiteral<"POST">;
|
|
130
|
-
url: z.ZodString;
|
|
131
|
-
headers: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
132
|
-
body: z.ZodString;
|
|
133
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
134
|
-
type: z.ZodLiteral<"response">;
|
|
135
|
-
id: z.ZodString;
|
|
136
|
-
status: z.ZodNumber;
|
|
137
|
-
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
138
|
-
body: z.ZodString;
|
|
139
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
140
|
-
type: z.ZodLiteral<"error">;
|
|
141
|
-
id: z.ZodOptional<z.ZodString>;
|
|
142
|
-
code: z.ZodString;
|
|
143
|
-
message: z.ZodString;
|
|
144
|
-
}, z.core.$strip>], "type">;
|
|
145
|
-
export type ConnectorFrame = z.infer<typeof connectorFrameSchema>;
|
|
146
|
-
/** Thrown when an incoming frame fails to parse or validate. */
|
|
147
|
-
export declare class ConnectorProtocolError extends Error {
|
|
148
|
-
readonly code = "source_connector_protocol_error";
|
|
149
|
-
constructor(message: string);
|
|
150
|
-
}
|
|
151
|
-
/** Serialize a frame for transmission. */
|
|
152
|
-
export declare function encodeFrame(frame: ConnectorFrame): string;
|
|
153
|
-
/**
|
|
154
|
-
* Parse + validate an incoming frame. Accepts the string or binary payloads the
|
|
155
|
-
* `ws` library / WebSocket `message` events deliver. Throws
|
|
156
|
-
* `ConnectorProtocolError` on any malformed or unknown frame so callers can
|
|
157
|
-
* reject the connection rather than act on garbage.
|
|
158
|
-
*/
|
|
159
|
-
export declare function decodeFrame(raw: string | ArrayBuffer | Uint8Array): ConnectorFrame;
|
|
@@ -1,161 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Data Source reverse-channel wire protocol.
|
|
3
|
-
*
|
|
4
|
-
* The `commit`/`load`/`list` leg of Data Source mode is normally an INBOUND
|
|
5
|
-
* webhook (Ablo Cloud → your HTTPS endpoint). That requires a public URL, so it
|
|
6
|
-
* doesn't work on `localhost` or inside a locked-down VPC with no inbound path.
|
|
7
|
-
*
|
|
8
|
-
* The reverse channel inverts the direction: the customer's connector dials OUT
|
|
9
|
-
* to Ablo Cloud over a WebSocket and serves those same requests over the open
|
|
10
|
-
* socket — the Stripe-CLI `stripe listen` pattern. This module defines the
|
|
11
|
-
* frames that travel over that socket.
|
|
12
|
-
*
|
|
13
|
-
* Trust model is unchanged. A `request` frame carries the SAME Standard Webhooks
|
|
14
|
-
* signature headers (`webhook-id` / `webhook-timestamp` / `webhook-signature`)
|
|
15
|
-
* and the SAME raw body Ablo would have POSTed, so the connector verifies it
|
|
16
|
-
* through the unchanged `verifyAbloSourceRequest`. Only the transport differs.
|
|
17
|
-
*
|
|
18
|
-
* Frames are validated with zod at the boundary (matching `contract.ts`): a
|
|
19
|
-
* malformed frame is rejected at the edge, and every wire type is inferred from
|
|
20
|
-
* one schema so the two sides can never silently drift.
|
|
21
|
-
*/
|
|
22
|
-
import { z } from 'zod';
|
|
23
|
-
import { WS_BEARER_SUBPROTOCOL_PREFIX } from '../auth/credentialSource.js';
|
|
24
|
-
/**
|
|
25
|
-
* Wire-protocol version. Bumped on any breaking frame-shape change so an old
|
|
26
|
-
* connector talking to a new server (or vice-versa) fails fast at `register`
|
|
27
|
-
* instead of misparsing a frame mid-stream.
|
|
28
|
-
*/
|
|
29
|
-
export const SOURCE_CONNECTOR_PROTOCOL_VERSION = 1;
|
|
30
|
-
/** Path the connector dials. Appended to the connector's `baseURL`. */
|
|
31
|
-
export const SOURCE_CONNECTOR_WS_PATH = '/v1/source/listen';
|
|
32
|
-
/**
|
|
33
|
-
* Negotiated WebSocket subprotocol that marks a reverse-channel source
|
|
34
|
-
* connector (vs. the SDK sync client's `ablo.sync.v1`). The server selects and
|
|
35
|
-
* echoes back ONLY this value, never the token-bearing subprotocol — keeping the
|
|
36
|
-
* credential out of ALB / proxy logs exactly like the sync socket does.
|
|
37
|
-
*/
|
|
38
|
-
export const WS_SOURCE_SUBPROTOCOL = 'ablo.source.v1';
|
|
39
|
-
/**
|
|
40
|
-
* Build the `Sec-WebSocket-Protocol` list a connector offers: the source
|
|
41
|
-
* protocol plus the bearer credential (`ablo.bearer.<apiKey>`). Browsers can't
|
|
42
|
-
* set an `Authorization` header on a WebSocket, so the API key rides as a
|
|
43
|
-
* subprotocol — the same mechanism the SDK sync client uses, read server-side by
|
|
44
|
-
* the shared `extractBearer`.
|
|
45
|
-
*/
|
|
46
|
-
export function sourceConnectorSubprotocols(apiKey) {
|
|
47
|
-
return [WS_SOURCE_SUBPROTOCOL, `${WS_BEARER_SUBPROTOCOL_PREFIX}${apiKey}`];
|
|
48
|
-
}
|
|
49
|
-
const headerRecord = z.record(z.string(), z.string());
|
|
50
|
-
/**
|
|
51
|
-
* Connector → server, first frame after the socket opens and authenticates.
|
|
52
|
-
* Auth and source resolution happen at the WS handshake from the API key; this
|
|
53
|
-
* frame only carries protocol negotiation + advisory metadata.
|
|
54
|
-
*/
|
|
55
|
-
export const registerFrameSchema = z.object({
|
|
56
|
-
type: z.literal('register'),
|
|
57
|
-
protocolVersion: z.number().int(),
|
|
58
|
-
/**
|
|
59
|
-
* Advisory client identifier (e.g. `@abloatai/ablo@0.12.0`) for server-side
|
|
60
|
-
* logging. Not trusted for any decision.
|
|
61
|
-
*/
|
|
62
|
-
client: z.string().optional(),
|
|
63
|
-
});
|
|
64
|
-
/**
|
|
65
|
-
* Server → connector, acknowledges a successful `register`. Echoes the resolved
|
|
66
|
-
* source identity so the connector can log/verify which source it is serving.
|
|
67
|
-
*/
|
|
68
|
-
export const readyFrameSchema = z.object({
|
|
69
|
-
type: z.literal('ready'),
|
|
70
|
-
protocolVersion: z.number().int(),
|
|
71
|
-
sourceId: z.string().optional(),
|
|
72
|
-
organizationId: z.string().optional(),
|
|
73
|
-
environment: z.enum(['production', 'sandbox']).optional(),
|
|
74
|
-
});
|
|
75
|
-
/**
|
|
76
|
-
* Server → connector, one drained `commit`/`load`/`list` request. `headers` and
|
|
77
|
-
* `body` are byte-identical to what the inbound webhook path would have sent —
|
|
78
|
-
* the connector replays them into a synthesized `Request` so the unchanged
|
|
79
|
-
* handler verifies the signature exactly as in production.
|
|
80
|
-
*/
|
|
81
|
-
export const requestFrameSchema = z.object({
|
|
82
|
-
type: z.literal('request'),
|
|
83
|
-
/** Correlation id; the matching `response` frame carries the same value. */
|
|
84
|
-
id: z.string().min(1),
|
|
85
|
-
method: z.literal('POST'),
|
|
86
|
-
/** Synthetic absolute URL used only to construct the `Request` object. */
|
|
87
|
-
url: z.string().min(1),
|
|
88
|
-
/** Signed Standard Webhooks headers + `Content-Type`. */
|
|
89
|
-
headers: headerRecord,
|
|
90
|
-
/** Raw JSON request body — exactly the bytes that were signed. */
|
|
91
|
-
body: z.string(),
|
|
92
|
-
});
|
|
93
|
-
/**
|
|
94
|
-
* Connector → server, the handler's `Response` for one `request`. The server
|
|
95
|
-
* resolves the pending request keyed by `id` and feeds `status`/`body` back to
|
|
96
|
-
* the `SourceClient` as if an HTTP response had returned.
|
|
97
|
-
*/
|
|
98
|
-
export const responseFrameSchema = z.object({
|
|
99
|
-
type: z.literal('response'),
|
|
100
|
-
id: z.string().min(1),
|
|
101
|
-
status: z.number().int(),
|
|
102
|
-
headers: headerRecord.optional(),
|
|
103
|
-
/** Raw JSON response body. */
|
|
104
|
-
body: z.string(),
|
|
105
|
-
});
|
|
106
|
-
/**
|
|
107
|
-
* Either direction, out-of-band failure not tied to a single request body
|
|
108
|
-
* (auth rejected, unsupported protocol version, malformed frame). When `id` is
|
|
109
|
-
* present the error pertains to that pending request and fails it; otherwise it
|
|
110
|
-
* is a connection-level error.
|
|
111
|
-
*/
|
|
112
|
-
export const errorFrameSchema = z.object({
|
|
113
|
-
type: z.literal('error'),
|
|
114
|
-
id: z.string().min(1).optional(),
|
|
115
|
-
code: z.string().min(1),
|
|
116
|
-
message: z.string(),
|
|
117
|
-
});
|
|
118
|
-
export const connectorFrameSchema = z.discriminatedUnion('type', [
|
|
119
|
-
registerFrameSchema,
|
|
120
|
-
readyFrameSchema,
|
|
121
|
-
requestFrameSchema,
|
|
122
|
-
responseFrameSchema,
|
|
123
|
-
errorFrameSchema,
|
|
124
|
-
]);
|
|
125
|
-
/** Thrown when an incoming frame fails to parse or validate. */
|
|
126
|
-
export class ConnectorProtocolError extends Error {
|
|
127
|
-
code = 'source_connector_protocol_error';
|
|
128
|
-
constructor(message) {
|
|
129
|
-
super(message);
|
|
130
|
-
this.name = 'ConnectorProtocolError';
|
|
131
|
-
}
|
|
132
|
-
}
|
|
133
|
-
/** Serialize a frame for transmission. */
|
|
134
|
-
export function encodeFrame(frame) {
|
|
135
|
-
return JSON.stringify(frame);
|
|
136
|
-
}
|
|
137
|
-
/**
|
|
138
|
-
* Parse + validate an incoming frame. Accepts the string or binary payloads the
|
|
139
|
-
* `ws` library / WebSocket `message` events deliver. Throws
|
|
140
|
-
* `ConnectorProtocolError` on any malformed or unknown frame so callers can
|
|
141
|
-
* reject the connection rather than act on garbage.
|
|
142
|
-
*/
|
|
143
|
-
export function decodeFrame(raw) {
|
|
144
|
-
const text = typeof raw === 'string' ? raw : decodeBinary(raw);
|
|
145
|
-
let parsed;
|
|
146
|
-
try {
|
|
147
|
-
parsed = JSON.parse(text);
|
|
148
|
-
}
|
|
149
|
-
catch {
|
|
150
|
-
throw new ConnectorProtocolError('Frame is not valid JSON');
|
|
151
|
-
}
|
|
152
|
-
const result = connectorFrameSchema.safeParse(parsed);
|
|
153
|
-
if (!result.success) {
|
|
154
|
-
throw new ConnectorProtocolError(`Invalid connector frame: ${result.error.message}`);
|
|
155
|
-
}
|
|
156
|
-
return result.data;
|
|
157
|
-
}
|
|
158
|
-
function decodeBinary(raw) {
|
|
159
|
-
const bytes = raw instanceof Uint8Array ? raw : new Uint8Array(raw);
|
|
160
|
-
return new TextDecoder().decode(bytes);
|
|
161
|
-
}
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* OptimisticEchoTracker — receive-layer reconciliation primitive.
|
|
3
|
-
*
|
|
4
|
-
* Tracks the set of transaction ids the client has applied locally
|
|
5
|
-
* but the server has not yet confirmed. When a sync delta arrives
|
|
6
|
-
* carrying a `transactionId` the tracker recognizes, the pool
|
|
7
|
-
* mutation is suppressed (the optimistic write already reflects it).
|
|
8
|
-
* Drained when the matching delta echo lands or when the originating
|
|
9
|
-
* transaction is rolled back.
|
|
10
|
-
*
|
|
11
|
-
* Architectural framing: see
|
|
12
|
-
* `apps/sync-server/docs/OPTIMISTIC_RECONCILIATION.md`. This is the
|
|
13
|
-
* "discriminator at the apply layer" the doc names — without it the
|
|
14
|
-
* authoritative-layer apply path blindly re-applies confirmations on
|
|
15
|
-
* top of whatever optimistic state has since diverged, producing the
|
|
16
|
-
* chart-delete flicker.
|
|
17
|
-
*
|
|
18
|
-
* Bounded by `maxSize` to defend against runaway growth from a
|
|
19
|
-
* pathological "transactions never confirmed and never rolled back"
|
|
20
|
-
* loop. When the bound is hit, the OLDEST id is evicted (FIFO via
|
|
21
|
-
* insertion-ordered Map). Eviction means a future echo of that
|
|
22
|
-
* transaction will be applied as a foreign mutation — no correctness
|
|
23
|
-
* risk for the originating tab (the pool already reflects the local
|
|
24
|
-
* write); the worst case is a single redundant pool re-set.
|
|
25
|
-
*/
|
|
26
|
-
export interface OptimisticEchoTrackerOptions {
|
|
27
|
-
/**
|
|
28
|
-
* Hard upper bound on tracked ids. FIFO eviction beyond this. The
|
|
29
|
-
* default of 10_000 covers a 200-tab user mid-bulk-edit (each tab
|
|
30
|
-
* tracking dozens of unconfirmed transactions) with two orders of
|
|
31
|
-
* magnitude of headroom.
|
|
32
|
-
*/
|
|
33
|
-
maxSize?: number;
|
|
34
|
-
}
|
|
35
|
-
export interface OptimisticEchoMetrics {
|
|
36
|
-
/** Total ids currently tracked. */
|
|
37
|
-
size: number;
|
|
38
|
-
/** Cumulative ids ever added since construction. */
|
|
39
|
-
totalAdded: number;
|
|
40
|
-
/** Cumulative successful echo matches (delta arrived → drained). */
|
|
41
|
-
hits: number;
|
|
42
|
-
/** Cumulative explicit rollback drains (transaction never made it). */
|
|
43
|
-
rollbacks: number;
|
|
44
|
-
/** Cumulative ids evicted due to maxSize pressure. */
|
|
45
|
-
evictions: number;
|
|
46
|
-
}
|
|
47
|
-
export declare class OptimisticEchoTracker {
|
|
48
|
-
private readonly ids;
|
|
49
|
-
private readonly maxSize;
|
|
50
|
-
private _totalAdded;
|
|
51
|
-
private _hits;
|
|
52
|
-
private _rollbacks;
|
|
53
|
-
private _evictions;
|
|
54
|
-
constructor(options?: OptimisticEchoTrackerOptions);
|
|
55
|
-
/**
|
|
56
|
-
* Mark a transaction as locally-applied. The next sync delta with a
|
|
57
|
-
* matching `transactionId` will be recognized as the server's
|
|
58
|
-
* confirmation of this same write. Idempotent — repeated calls with
|
|
59
|
-
* the same id are no-ops.
|
|
60
|
-
*/
|
|
61
|
-
markPending(transactionId: string): void;
|
|
62
|
-
/**
|
|
63
|
-
* If the id is currently tracked, drain it and return true (signal
|
|
64
|
-
* to the caller: this is an echo, skip the pool mutation).
|
|
65
|
-
* Otherwise return false (foreign mutation, apply normally).
|
|
66
|
-
*
|
|
67
|
-
* Combined check+drain into one method to make the receive-path
|
|
68
|
-
* idiom hard to misuse: a separate `has` then `drain` would race
|
|
69
|
-
* if multiple deltas with the same id arrived in the same batch.
|
|
70
|
-
*/
|
|
71
|
-
consumeEcho(transactionId: string | null | undefined): boolean;
|
|
72
|
-
/**
|
|
73
|
-
* Drain on rollback. The transaction was cancelled before a server
|
|
74
|
-
* confirmation arrived — no echo will ever come, so the pending
|
|
75
|
-
* entry would otherwise leak. Counts as a separate metric category
|
|
76
|
-
* so a spike of `rollbacks` (vs `hits`) signals network or
|
|
77
|
-
* server-side health issues.
|
|
78
|
-
*/
|
|
79
|
-
drainOnRollback(transactionId: string): void;
|
|
80
|
-
getMetrics(): Readonly<OptimisticEchoMetrics>;
|
|
81
|
-
clear(): void;
|
|
82
|
-
}
|
|
@@ -1,104 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* OptimisticEchoTracker — receive-layer reconciliation primitive.
|
|
3
|
-
*
|
|
4
|
-
* Tracks the set of transaction ids the client has applied locally
|
|
5
|
-
* but the server has not yet confirmed. When a sync delta arrives
|
|
6
|
-
* carrying a `transactionId` the tracker recognizes, the pool
|
|
7
|
-
* mutation is suppressed (the optimistic write already reflects it).
|
|
8
|
-
* Drained when the matching delta echo lands or when the originating
|
|
9
|
-
* transaction is rolled back.
|
|
10
|
-
*
|
|
11
|
-
* Architectural framing: see
|
|
12
|
-
* `apps/sync-server/docs/OPTIMISTIC_RECONCILIATION.md`. This is the
|
|
13
|
-
* "discriminator at the apply layer" the doc names — without it the
|
|
14
|
-
* authoritative-layer apply path blindly re-applies confirmations on
|
|
15
|
-
* top of whatever optimistic state has since diverged, producing the
|
|
16
|
-
* chart-delete flicker.
|
|
17
|
-
*
|
|
18
|
-
* Bounded by `maxSize` to defend against runaway growth from a
|
|
19
|
-
* pathological "transactions never confirmed and never rolled back"
|
|
20
|
-
* loop. When the bound is hit, the OLDEST id is evicted (FIFO via
|
|
21
|
-
* insertion-ordered Map). Eviction means a future echo of that
|
|
22
|
-
* transaction will be applied as a foreign mutation — no correctness
|
|
23
|
-
* risk for the originating tab (the pool already reflects the local
|
|
24
|
-
* write); the worst case is a single redundant pool re-set.
|
|
25
|
-
*/
|
|
26
|
-
const DEFAULT_MAX_SIZE = 10_000;
|
|
27
|
-
export class OptimisticEchoTracker {
|
|
28
|
-
// Map (not Set) for O(1) FIFO eviction via insertion order.
|
|
29
|
-
// Value is unused; Map.keys() iterates in insertion order so
|
|
30
|
-
// `keys().next()` yields the oldest id.
|
|
31
|
-
ids = new Map();
|
|
32
|
-
maxSize;
|
|
33
|
-
// Metrics — internal counters; exposed via `getMetrics()`. Kept
|
|
34
|
-
// numeric (not BigInt) since cumulative-since-page-load fits well
|
|
35
|
-
// under Number.MAX_SAFE_INTEGER for any realistic session.
|
|
36
|
-
_totalAdded = 0;
|
|
37
|
-
_hits = 0;
|
|
38
|
-
_rollbacks = 0;
|
|
39
|
-
_evictions = 0;
|
|
40
|
-
constructor(options = {}) {
|
|
41
|
-
this.maxSize = options.maxSize ?? DEFAULT_MAX_SIZE;
|
|
42
|
-
}
|
|
43
|
-
/**
|
|
44
|
-
* Mark a transaction as locally-applied. The next sync delta with a
|
|
45
|
-
* matching `transactionId` will be recognized as the server's
|
|
46
|
-
* confirmation of this same write. Idempotent — repeated calls with
|
|
47
|
-
* the same id are no-ops.
|
|
48
|
-
*/
|
|
49
|
-
markPending(transactionId) {
|
|
50
|
-
if (this.ids.has(transactionId))
|
|
51
|
-
return;
|
|
52
|
-
if (this.ids.size >= this.maxSize) {
|
|
53
|
-
const oldest = this.ids.keys().next().value;
|
|
54
|
-
if (oldest !== undefined) {
|
|
55
|
-
this.ids.delete(oldest);
|
|
56
|
-
this._evictions += 1;
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
this.ids.set(transactionId, true);
|
|
60
|
-
this._totalAdded += 1;
|
|
61
|
-
}
|
|
62
|
-
/**
|
|
63
|
-
* If the id is currently tracked, drain it and return true (signal
|
|
64
|
-
* to the caller: this is an echo, skip the pool mutation).
|
|
65
|
-
* Otherwise return false (foreign mutation, apply normally).
|
|
66
|
-
*
|
|
67
|
-
* Combined check+drain into one method to make the receive-path
|
|
68
|
-
* idiom hard to misuse: a separate `has` then `drain` would race
|
|
69
|
-
* if multiple deltas with the same id arrived in the same batch.
|
|
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
|
-
* Drain on rollback. The transaction was cancelled before a server
|
|
82
|
-
* confirmation arrived — no echo will ever come, so the pending
|
|
83
|
-
* entry would otherwise leak. Counts as a separate metric category
|
|
84
|
-
* so a spike of `rollbacks` (vs `hits`) signals network or
|
|
85
|
-
* server-side health issues.
|
|
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,39 +0,0 @@
|
|
|
1
|
-
import { getContext } from "../context.js";
|
|
2
|
-
/**
|
|
3
|
-
* Shared error handler for mutation execution.
|
|
4
|
-
* Logs to SyncObservability (unless offline + network error), then re-throws.
|
|
5
|
-
*/
|
|
6
|
-
export function handleMutationError(error, context, schemaName, modelId) {
|
|
7
|
-
const errorInfo = { schemaName, modelId, rawError: error };
|
|
8
|
-
if (error instanceof Error) {
|
|
9
|
-
errorInfo.message = error.message;
|
|
10
|
-
errorInfo.name = error.name;
|
|
11
|
-
errorInfo.stack =
|
|
12
|
-
typeof error.stack === 'string' ? error.stack.split('\n').slice(0, 5) : undefined;
|
|
13
|
-
}
|
|
14
|
-
else if (error && typeof error === 'object') {
|
|
15
|
-
errorInfo.message =
|
|
16
|
-
error.message ??
|
|
17
|
-
error.error ??
|
|
18
|
-
'Unknown error';
|
|
19
|
-
errorInfo.code = error.code;
|
|
20
|
-
errorInfo.extensions = error.extensions;
|
|
21
|
-
}
|
|
22
|
-
else {
|
|
23
|
-
errorInfo.message = String(error);
|
|
24
|
-
}
|
|
25
|
-
const isOffline = !getContext().onlineStatus.isOnline();
|
|
26
|
-
const msg = errorInfo.message;
|
|
27
|
-
const isNetworkError = msg?.includes('Failed to fetch') ||
|
|
28
|
-
msg?.includes('Network request failed') ||
|
|
29
|
-
msg?.includes('NetworkError');
|
|
30
|
-
if (!isOffline || !isNetworkError) {
|
|
31
|
-
getContext().observability.captureTransactionFailure({
|
|
32
|
-
context,
|
|
33
|
-
error: error instanceof Error ? error : String(errorInfo.message ?? error),
|
|
34
|
-
modelName: schemaName,
|
|
35
|
-
modelId,
|
|
36
|
-
});
|
|
37
|
-
}
|
|
38
|
-
throw error;
|
|
39
|
-
}
|