@abloatai/ablo 0.36.0 → 0.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +2 -2
- package/CHANGELOG.md +71 -2013
- package/NOTICE +2 -2
- package/README.md +25 -71
- package/assets/banner.png +0 -0
- package/dist/auth.d.ts +2 -0
- package/dist/auth.d.ts.map +1 -0
- package/dist/auth.js +2 -0
- package/dist/auth.js.map +1 -0
- package/dist/client.d.ts +3 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +3 -0
- package/dist/client.js.map +1 -0
- package/dist/coordination.d.ts +2 -0
- package/dist/coordination.d.ts.map +1 -0
- package/dist/coordination.js +2 -0
- package/dist/coordination.js.map +1 -0
- package/dist/index.d.ts +3 -114
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -163
- package/dist/index.js.map +1 -0
- package/dist/react.d.ts +4 -0
- package/dist/react.d.ts.map +1 -0
- package/dist/react.js +3 -0
- package/dist/react.js.map +1 -0
- package/dist/schema.d.ts +2 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +2 -0
- package/dist/schema.js.map +1 -0
- package/dist/server.d.ts +2 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +2 -0
- package/dist/server.js.map +1 -0
- package/dist/source-conformance.d.ts +2 -0
- package/dist/source-conformance.d.ts.map +1 -0
- package/dist/source-conformance.js +2 -0
- package/dist/source-conformance.js.map +1 -0
- package/dist/source-drizzle.d.ts +2 -0
- package/dist/source-drizzle.d.ts.map +1 -0
- package/dist/source-drizzle.js +2 -0
- package/dist/source-drizzle.js.map +1 -0
- package/dist/source-kysely.d.ts +2 -0
- package/dist/source-kysely.d.ts.map +1 -0
- package/dist/source-kysely.js +2 -0
- package/dist/source-kysely.js.map +1 -0
- package/dist/source-next.d.ts +2 -0
- package/dist/source-next.d.ts.map +1 -0
- package/dist/source-next.js +2 -0
- package/dist/source-next.js.map +1 -0
- package/dist/source.d.ts +2 -0
- package/dist/source.d.ts.map +1 -0
- package/dist/source.js +2 -0
- package/dist/source.js.map +1 -0
- package/dist/wire.d.ts +2 -0
- package/dist/wire.d.ts.map +1 -0
- package/dist/wire.js +2 -0
- package/dist/wire.js.map +1 -0
- package/docs/agents.md +1 -1
- package/docs/api-keys.md +7 -6
- package/docs/api.md +10 -10
- package/docs/client-behavior.md +5 -5
- package/docs/coordination.md +52 -62
- package/docs/data-sources.md +1 -1
- package/docs/examples/agent-human.md +4 -4
- package/docs/examples/ai-sdk-tool.md +1 -1
- package/docs/examples/existing-python-backend.md +15 -4
- package/docs/examples/nextjs.md +27 -6
- package/docs/examples/server-agent.md +2 -2
- package/docs/how-it-works.md +4 -4
- package/docs/identity.md +2 -1
- package/docs/integration-guide.md +24 -13
- package/docs/internal/README.md +18 -0
- package/docs/internal/agent-fleet-coordination-design.md +171 -0
- package/docs/internal/agent-orchestration.md +58 -0
- package/docs/internal/commit-identifiers.md +91 -0
- package/docs/internal/concurrency-open-decisions.md +37 -0
- package/docs/internal/data-source-reverse-channel.md +150 -0
- package/docs/internal/per-field-conflict-detection.md +165 -0
- package/docs/internal/postgres-replication.md +64 -0
- package/docs/internal/serializable-schema.md +119 -0
- package/docs/internal/structure.md +32 -0
- package/docs/mcp.md +2 -2
- package/docs/migration.md +3 -3
- package/docs/quickstart.md +2 -2
- package/docs/react.md +5 -5
- package/docs/schema-contract.md +3 -3
- package/docs/sessions.md +91 -37
- package/examples/README.md +2 -2
- package/examples/data-source/README.md +1 -1
- package/examples/data-source/ablo-driver.ts +1 -1
- package/examples/data-source/customer-server.ts +1 -1
- package/examples/data-source/run.ts +1 -1
- package/examples/data-source/schema.ts +1 -1
- package/examples/quickstart.ts +2 -2
- package/llms.txt +8 -8
- package/package.json +63 -166
- package/bin/ablo.cjs +0 -39
- package/dist/BaseSyncedStore.d.ts +0 -843
- package/dist/BaseSyncedStore.js +0 -1971
- package/dist/Database.d.ts +0 -323
- package/dist/Database.js +0 -1502
- package/dist/InstanceCache.d.ts +0 -237
- package/dist/InstanceCache.js +0 -1166
- package/dist/LazyReferenceCollection.d.ts +0 -177
- package/dist/LazyReferenceCollection.js +0 -461
- package/dist/Model.d.ts +0 -454
- package/dist/Model.js +0 -919
- package/dist/ModelRegistry.d.ts +0 -225
- package/dist/ModelRegistry.js +0 -539
- package/dist/NetworkMonitor.d.ts +0 -28
- package/dist/NetworkMonitor.js +0 -79
- package/dist/RuntimeContext.d.ts +0 -52
- package/dist/RuntimeContext.js +0 -80
- package/dist/SyncClient.d.ts +0 -541
- package/dist/SyncClient.js +0 -2202
- package/dist/adapters/alwaysOnline.d.ts +0 -14
- package/dist/adapters/alwaysOnline.js +0 -17
- package/dist/adapters/inMemoryStorage.d.ts +0 -31
- package/dist/adapters/inMemoryStorage.js +0 -110
- package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
- package/dist/ai-sdk/coordinatedTool.js +0 -134
- package/dist/ai-sdk/coordinationContext.d.ts +0 -46
- package/dist/ai-sdk/coordinationContext.js +0 -106
- package/dist/ai-sdk/index.d.ts +0 -121
- package/dist/ai-sdk/index.js +0 -121
- package/dist/ai-sdk/wrap.d.ts +0 -65
- package/dist/ai-sdk/wrap.js +0 -39
- package/dist/auth/index.d.ts +0 -1
- package/dist/auth/index.js +0 -8
- package/dist/batching/index.d.ts +0 -55
- package/dist/batching/index.js +0 -147
- package/dist/client/Ablo.d.ts +0 -231
- package/dist/client/Ablo.js +0 -160
- package/dist/client/abloClient.d.ts +0 -309
- package/dist/client/abloClient.js +0 -13
- package/dist/client/clientPrelude.d.ts +0 -52
- package/dist/client/clientPrelude.js +0 -60
- package/dist/client/consoleLogger.d.ts +0 -35
- package/dist/client/consoleLogger.js +0 -44
- package/dist/client/coreClient.d.ts +0 -60
- package/dist/client/coreClient.js +0 -118
- package/dist/client/createInternalComponents.d.ts +0 -50
- package/dist/client/createInternalComponents.js +0 -98
- package/dist/client/createModelProxy.d.ts +0 -248
- package/dist/client/createModelProxy.js +0 -884
- package/dist/client/humans.d.ts +0 -69
- package/dist/client/humans.js +0 -78
- package/dist/client/modelRegistration.d.ts +0 -10
- package/dist/client/modelRegistration.js +0 -312
- package/dist/client/options.d.ts +0 -461
- package/dist/client/options.js +0 -7
- package/dist/client/reactiveEngine.d.ts +0 -53
- package/dist/client/reactiveEngine.js +0 -688
- package/dist/client/resourceTypes.d.ts +0 -12
- package/dist/client/resourceTypes.js +0 -10
- package/dist/client/schemaConfig.d.ts +0 -44
- package/dist/client/schemaConfig.js +0 -185
- package/dist/client/storeCluster.d.ts +0 -47
- package/dist/client/storeCluster.js +0 -118
- package/dist/client/storeLifecycle.d.ts +0 -61
- package/dist/client/storeLifecycle.js +0 -231
- package/dist/client/validateAbloOptions.d.ts +0 -42
- package/dist/client/validateAbloOptions.js +0 -43
- package/dist/client/wsMutationExecutor.d.ts +0 -27
- package/dist/client/wsMutationExecutor.js +0 -72
- package/dist/context.d.ts +0 -42
- package/dist/context.js +0 -81
- package/dist/coordination/ClaimLog.d.ts +0 -26
- package/dist/coordination/ClaimLog.js +0 -32
- package/dist/coordination/index.d.ts +0 -1
- package/dist/coordination/index.js +0 -8
- package/dist/core/index.d.ts +0 -33
- package/dist/core/index.js +0 -48
- package/dist/docs/catalog.d.ts +0 -72
- package/dist/docs/catalog.js +0 -230
- package/dist/docs/index.d.ts +0 -10
- package/dist/docs/index.js +0 -10
- package/dist/environment.d.ts +0 -1
- package/dist/environment.js +0 -8
- package/dist/interfaces/index.d.ts +0 -311
- package/dist/interfaces/index.js +0 -9
- package/dist/keys/index.d.ts +0 -1
- package/dist/keys/index.js +0 -8
- package/dist/mutators/RecordingMutation.d.ts +0 -36
- package/dist/mutators/RecordingMutation.js +0 -182
- package/dist/mutators/Transaction.d.ts +0 -40
- package/dist/mutators/Transaction.js +0 -58
- package/dist/mutators/UndoManager.d.ts +0 -258
- package/dist/mutators/UndoManager.js +0 -658
- package/dist/mutators/defineMutators.d.ts +0 -60
- package/dist/mutators/defineMutators.js +0 -18
- package/dist/mutators/inverseOp.d.ts +0 -126
- package/dist/mutators/inverseOp.js +0 -71
- package/dist/mutators/mutateActions.d.ts +0 -45
- package/dist/mutators/mutateActions.js +0 -105
- package/dist/mutators/readerActions.d.ts +0 -33
- package/dist/mutators/readerActions.js +0 -57
- package/dist/mutators/undoApply.d.ts +0 -51
- package/dist/mutators/undoApply.js +0 -117
- package/dist/policy/index.d.ts +0 -21
- package/dist/policy/index.js +0 -20
- package/dist/query/QueryProcessor.d.ts +0 -75
- package/dist/query/QueryProcessor.js +0 -255
- package/dist/query/client.d.ts +0 -64
- package/dist/query/client.js +0 -138
- package/dist/query/types.d.ts +0 -85
- package/dist/query/types.js +0 -16
- package/dist/react/AbloProvider.d.ts +0 -242
- package/dist/react/AbloProvider.js +0 -458
- package/dist/react/ClientSideSuspense.d.ts +0 -36
- package/dist/react/ClientSideSuspense.js +0 -17
- package/dist/react/DefaultFallback.d.ts +0 -24
- package/dist/react/DefaultFallback.js +0 -43
- package/dist/react/context.d.ts +0 -55
- package/dist/react/context.js +0 -29
- package/dist/react/createAbloReact.d.ts +0 -56
- package/dist/react/createAbloReact.js +0 -51
- package/dist/react/index.d.ts +0 -62
- package/dist/react/index.js +0 -69
- package/dist/react/internalContext.d.ts +0 -33
- package/dist/react/internalContext.js +0 -3
- package/dist/react/useAblo.d.ts +0 -82
- package/dist/react/useAblo.js +0 -120
- package/dist/react/useCurrentUserId.d.ts +0 -22
- package/dist/react/useCurrentUserId.js +0 -34
- package/dist/react/useErrorListener.d.ts +0 -20
- package/dist/react/useErrorListener.js +0 -38
- package/dist/react/useMutationFailureListener.d.ts +0 -26
- package/dist/react/useMutationFailureListener.js +0 -38
- package/dist/react/useMutators.d.ts +0 -56
- package/dist/react/useMutators.js +0 -84
- package/dist/react/useReactive.d.ts +0 -35
- package/dist/react/useReactive.js +0 -123
- package/dist/react/useSyncStatus.d.ts +0 -59
- package/dist/react/useSyncStatus.js +0 -76
- package/dist/react/useUndoScope.d.ts +0 -34
- package/dist/react/useUndoScope.js +0 -81
- package/dist/schema/coordination.d.ts +0 -112
- package/dist/schema/coordination.js +0 -133
- package/dist/schema/ddl.d.ts +0 -97
- package/dist/schema/ddl.js +0 -491
- package/dist/schema/ddlLock.d.ts +0 -35
- package/dist/schema/ddlLock.js +0 -46
- package/dist/schema/diff.d.ts +0 -225
- package/dist/schema/diff.js +0 -289
- package/dist/schema/generate.d.ts +0 -19
- package/dist/schema/generate.js +0 -86
- package/dist/schema/index.d.ts +0 -42
- package/dist/schema/index.js +0 -80
- package/dist/schema/queries.d.ts +0 -201
- package/dist/schema/queries.js +0 -144
- package/dist/schema/select.d.ts +0 -40
- package/dist/schema/select.js +0 -90
- package/dist/schema/serialize.d.ts +0 -115
- package/dist/schema/serialize.js +0 -265
- package/dist/schema/sugar.d.ts +0 -109
- package/dist/schema/sugar.js +0 -83
- package/dist/schema/syncDeltaRow.d.ts +0 -6
- package/dist/schema/syncDeltaRow.js +0 -6
- package/dist/server/adapter.d.ts +0 -173
- package/dist/server/adapter.js +0 -18
- package/dist/server/commit.d.ts +0 -107
- package/dist/server/commit.js +0 -1
- package/dist/server/index.d.ts +0 -14
- package/dist/server/index.js +0 -2
- package/dist/server/readConfig.d.ts +0 -80
- package/dist/server/readConfig.js +0 -8
- package/dist/server/storageMode.d.ts +0 -23
- package/dist/server/storageMode.js +0 -17
- package/dist/source/adapter.d.ts +0 -83
- package/dist/source/adapter.js +0 -24
- package/dist/source/adapters/drizzle.d.ts +0 -48
- package/dist/source/adapters/drizzle.js +0 -219
- package/dist/source/adapters/kysely.d.ts +0 -42
- package/dist/source/adapters/kysely.js +0 -205
- package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
- package/dist/source/adapters/kyselyMutationCore.js +0 -125
- package/dist/source/adapters/memory.d.ts +0 -13
- package/dist/source/adapters/memory.js +0 -130
- package/dist/source/adapters/prisma.d.ts +0 -63
- package/dist/source/adapters/prisma.js +0 -202
- package/dist/source/conformance.d.ts +0 -37
- package/dist/source/conformance.js +0 -215
- package/dist/source/connector.d.ts +0 -95
- package/dist/source/connector.js +0 -266
- package/dist/source/connectorProtocol.d.ts +0 -154
- package/dist/source/connectorProtocol.js +0 -163
- package/dist/source/contract.d.ts +0 -195
- package/dist/source/contract.js +0 -164
- package/dist/source/factory.d.ts +0 -92
- package/dist/source/factory.js +0 -286
- package/dist/source/idempotency.d.ts +0 -61
- package/dist/source/idempotency.js +0 -144
- package/dist/source/index.d.ts +0 -23
- package/dist/source/index.js +0 -30
- package/dist/source/migrations.d.ts +0 -21
- package/dist/source/migrations.js +0 -103
- package/dist/source/next.d.ts +0 -32
- package/dist/source/next.js +0 -25
- package/dist/source/pushQueue.d.ts +0 -134
- package/dist/source/pushQueue.js +0 -256
- package/dist/source/signing.d.ts +0 -92
- package/dist/source/signing.js +0 -162
- package/dist/source/types.d.ts +0 -401
- package/dist/source/types.js +0 -59
- package/dist/storeContract.d.ts +0 -145
- package/dist/storeContract.js +0 -12
- package/dist/stores/DatabaseManager.d.ts +0 -107
- package/dist/stores/DatabaseManager.js +0 -388
- package/dist/stores/ObjectStore.d.ts +0 -115
- package/dist/stores/ObjectStore.js +0 -393
- package/dist/stores/ObjectStoreContract.d.ts +0 -38
- package/dist/stores/ObjectStoreContract.js +0 -1
- package/dist/stores/StoreManager.d.ts +0 -114
- package/dist/stores/StoreManager.js +0 -304
- package/dist/stores/SyncActionStore.d.ts +0 -99
- package/dist/stores/SyncActionStore.js +0 -506
- package/dist/stores/openIDBWithTimeout.d.ts +0 -65
- package/dist/stores/openIDBWithTimeout.js +0 -153
- package/dist/stores/syncAction.d.ts +0 -26
- package/dist/stores/syncAction.js +0 -16
- package/dist/surface.d.ts +0 -36
- package/dist/surface.js +0 -75
- package/dist/sync/BootstrapFetcher.d.ts +0 -284
- package/dist/sync/BootstrapFetcher.js +0 -964
- package/dist/sync/ConnectionManager.d.ts +0 -8
- package/dist/sync/ConnectionManager.js +0 -8
- package/dist/sync/OnDemandLoader.d.ts +0 -231
- package/dist/sync/OnDemandLoader.js +0 -743
- package/dist/sync/SubscriptionManager.d.ts +0 -159
- package/dist/sync/SubscriptionManager.js +0 -243
- package/dist/sync/SyncWebSocket.d.ts +0 -173
- package/dist/sync/SyncWebSocket.js +0 -438
- package/dist/sync/awaitClaimGrant.d.ts +0 -6
- package/dist/sync/awaitClaimGrant.js +0 -6
- package/dist/sync/bootstrapApply.d.ts +0 -73
- package/dist/sync/bootstrapApply.js +0 -73
- package/dist/sync/commitFrames.d.ts +0 -8
- package/dist/sync/commitFrames.js +0 -8
- package/dist/sync/contextPorts.d.ts +0 -18
- package/dist/sync/contextPorts.js +0 -31
- package/dist/sync/createClaimStream.d.ts +0 -7
- package/dist/sync/createClaimStream.js +0 -7
- package/dist/sync/createPresenceStream.d.ts +0 -69
- package/dist/sync/createPresenceStream.js +0 -200
- package/dist/sync/createSnapshot.d.ts +0 -29
- package/dist/sync/createSnapshot.js +0 -118
- package/dist/sync/credentialLifecycle.d.ts +0 -7
- package/dist/sync/credentialLifecycle.js +0 -7
- package/dist/sync/deltaPipeline.d.ts +0 -114
- package/dist/sync/deltaPipeline.js +0 -278
- package/dist/sync/groupChange.d.ts +0 -116
- package/dist/sync/groupChange.js +0 -244
- package/dist/sync/participants.d.ts +0 -132
- package/dist/sync/participants.js +0 -346
- package/dist/sync/persistedPrefix.d.ts +0 -12
- package/dist/sync/persistedPrefix.js +0 -22
- package/dist/sync/schemaDrift.d.ts +0 -55
- package/dist/sync/schemaDrift.js +0 -53
- package/dist/sync/schemas.d.ts +0 -71
- package/dist/sync/schemas.js +0 -94
- package/dist/sync/syncCursor.d.ts +0 -40
- package/dist/sync/syncCursor.js +0 -55
- package/dist/sync/syncPlan.d.ts +0 -54
- package/dist/sync/syncPlan.js +0 -50
- package/dist/sync/wsFrameHandlers.d.ts +0 -8
- package/dist/sync/wsFrameHandlers.js +0 -8
- package/dist/syncLog/contract.d.ts +0 -20
- package/dist/syncLog/contract.js +0 -19
- package/dist/syncLog/index.d.ts +0 -1
- package/dist/syncLog/index.js +0 -1
- package/dist/transaction/ablo.d.ts +0 -88
- package/dist/transaction/ablo.js +0 -33
- package/dist/transaction/auth/apiKey.d.ts +0 -152
- package/dist/transaction/auth/apiKey.js +0 -419
- package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
- package/dist/transaction/auth/bootstrapScope.js +0 -1
- package/dist/transaction/auth/capability.d.ts +0 -212
- package/dist/transaction/auth/capability.js +0 -224
- package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
- package/dist/transaction/auth/credentialEndpoint.js +0 -86
- package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
- package/dist/transaction/auth/credentialPolicy.js +0 -125
- package/dist/transaction/auth/credentialSource.d.ts +0 -30
- package/dist/transaction/auth/credentialSource.js +0 -55
- package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
- package/dist/transaction/auth/hostedEndpoints.js +0 -21
- package/dist/transaction/auth/identity.d.ts +0 -55
- package/dist/transaction/auth/identity.js +0 -210
- package/dist/transaction/auth/index.d.ts +0 -162
- package/dist/transaction/auth/index.js +0 -304
- package/dist/transaction/auth/schemas.d.ts +0 -59
- package/dist/transaction/auth/schemas.js +0 -85
- package/dist/transaction/auth/sessionMint.d.ts +0 -28
- package/dist/transaction/auth/sessionMint.js +0 -85
- package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -56
- package/dist/transaction/coordination/awaitClaimGrant.js +0 -124
- package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -84
- package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -108
- package/dist/transaction/coordination/claimMeta.d.ts +0 -49
- package/dist/transaction/coordination/claimMeta.js +0 -52
- package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
- package/dist/transaction/coordination/createClaimStream.js +0 -475
- package/dist/transaction/coordination/events.d.ts +0 -74
- package/dist/transaction/coordination/events.js +0 -7
- package/dist/transaction/coordination/index.d.ts +0 -19
- package/dist/transaction/coordination/index.js +0 -45
- package/dist/transaction/coordination/locator.d.ts +0 -104
- package/dist/transaction/coordination/locator.js +0 -102
- package/dist/transaction/coordination/schema.d.ts +0 -1536
- package/dist/transaction/coordination/schema.js +0 -1177
- package/dist/transaction/coordination/targetConflict.d.ts +0 -2
- package/dist/transaction/coordination/targetConflict.js +0 -107
- package/dist/transaction/coordination/trace.d.ts +0 -78
- package/dist/transaction/coordination/trace.js +0 -138
- package/dist/transaction/durableWrites.d.ts +0 -62
- package/dist/transaction/durableWrites.js +0 -71
- package/dist/transaction/environment.d.ts +0 -105
- package/dist/transaction/environment.js +0 -108
- package/dist/transaction/errorCodes.d.ts +0 -403
- package/dist/transaction/errorCodes.js +0 -484
- package/dist/transaction/errors.d.ts +0 -428
- package/dist/transaction/errors.js +0 -686
- package/dist/transaction/footprint.d.ts +0 -111
- package/dist/transaction/footprint.js +0 -0
- package/dist/transaction/index.d.ts +0 -20
- package/dist/transaction/index.js +0 -20
- package/dist/transaction/keys/index.d.ts +0 -87
- package/dist/transaction/keys/index.js +0 -207
- package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
- package/dist/transaction/log/syncDeltaRow.js +0 -95
- package/dist/transaction/logPosition.d.ts +0 -97
- package/dist/transaction/logPosition.js +0 -125
- package/dist/transaction/logger.d.ts +0 -16
- package/dist/transaction/logger.js +0 -7
- package/dist/transaction/observability.d.ts +0 -53
- package/dist/transaction/observability.js +0 -19
- package/dist/transaction/persistence.d.ts +0 -12
- package/dist/transaction/persistence.js +0 -11
- package/dist/transaction/plugin.d.ts +0 -285
- package/dist/transaction/plugin.js +0 -106
- package/dist/transaction/policy/types.d.ts +0 -217
- package/dist/transaction/policy/types.js +0 -126
- package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
- package/dist/transaction/resources/functionalUpdate.js +0 -87
- package/dist/transaction/resources/httpResources.d.ts +0 -321
- package/dist/transaction/resources/httpResources.js +0 -7
- package/dist/transaction/resources/modelOperations.d.ts +0 -427
- package/dist/transaction/resources/modelOperations.js +0 -12
- package/dist/transaction/resources/mutationOptions.d.ts +0 -66
- package/dist/transaction/resources/mutationOptions.js +0 -9
- package/dist/transaction/resources/where.d.ts +0 -101
- package/dist/transaction/resources/where.js +0 -115
- package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
- package/dist/transaction/resources/writeOptionsSchema.js +0 -73
- package/dist/transaction/schema/field.d.ts +0 -120
- package/dist/transaction/schema/field.js +0 -265
- package/dist/transaction/schema/fieldRef.d.ts +0 -38
- package/dist/transaction/schema/fieldRef.js +0 -11
- package/dist/transaction/schema/loadStrategy.d.ts +0 -45
- package/dist/transaction/schema/loadStrategy.js +0 -46
- package/dist/transaction/schema/model.d.ts +0 -379
- package/dist/transaction/schema/model.js +0 -123
- package/dist/transaction/schema/openapi.d.ts +0 -58
- package/dist/transaction/schema/openapi.js +0 -501
- package/dist/transaction/schema/relation.d.ts +0 -204
- package/dist/transaction/schema/relation.js +0 -104
- package/dist/transaction/schema/residency.d.ts +0 -29
- package/dist/transaction/schema/residency.js +0 -25
- package/dist/transaction/schema/roles.d.ts +0 -249
- package/dist/transaction/schema/roles.js +0 -230
- package/dist/transaction/schema/schema.d.ts +0 -351
- package/dist/transaction/schema/schema.js +0 -325
- package/dist/transaction/schema/tenancy.d.ts +0 -139
- package/dist/transaction/schema/tenancy.js +0 -190
- package/dist/transaction/transactionLayer.d.ts +0 -82
- package/dist/transaction/transactionLayer.js +0 -24
- package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
- package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
- package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
- package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
- package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
- package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
- package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
- package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
- package/dist/transaction/transport/commitFrames.d.ts +0 -90
- package/dist/transaction/transport/commitFrames.js +0 -134
- package/dist/transaction/transport/connectionManager.d.ts +0 -215
- package/dist/transaction/transport/connectionManager.js +0 -673
- package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
- package/dist/transaction/transport/credentialLifecycle.js +0 -324
- package/dist/transaction/transport/heartbeat.d.ts +0 -65
- package/dist/transaction/transport/heartbeat.js +0 -93
- package/dist/transaction/transport/httpClient.d.ts +0 -131
- package/dist/transaction/transport/httpClient.js +0 -146
- package/dist/transaction/transport/httpOptions.d.ts +0 -33
- package/dist/transaction/transport/httpOptions.js +0 -12
- package/dist/transaction/transport/httpTransport.d.ts +0 -8
- package/dist/transaction/transport/httpTransport.js +0 -1388
- package/dist/transaction/transport/networkProbe.d.ts +0 -84
- package/dist/transaction/transport/networkProbe.js +0 -207
- package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
- package/dist/transaction/transport/wsFrameHandlers.js +0 -429
- package/dist/transaction/transport/wsTransport.d.ts +0 -574
- package/dist/transaction/transport/wsTransport.js +0 -1023
- package/dist/transaction/types/assertExact.d.ts +0 -17
- package/dist/transaction/types/assertExact.js +0 -1
- package/dist/transaction/types/global.d.ts +0 -107
- package/dist/transaction/types/global.js +0 -40
- package/dist/transaction/types/index.d.ts +0 -205
- package/dist/transaction/types/index.js +0 -56
- package/dist/transaction/types/modelData.d.ts +0 -10
- package/dist/transaction/types/modelData.js +0 -9
- package/dist/transaction/types/participant.d.ts +0 -20
- package/dist/transaction/types/participant.js +0 -10
- package/dist/transaction/types/streams.d.ts +0 -550
- package/dist/transaction/types/streams.js +0 -11
- package/dist/transaction/utils/asyncIterator.d.ts +0 -34
- package/dist/transaction/utils/asyncIterator.js +0 -135
- package/dist/transaction/utils/duration.d.ts +0 -50
- package/dist/transaction/utils/duration.js +0 -77
- package/dist/transaction/utils/json.d.ts +0 -57
- package/dist/transaction/utils/json.js +0 -276
- package/dist/transaction/wire/accountResponses.d.ts +0 -420
- package/dist/transaction/wire/accountResponses.js +0 -290
- package/dist/transaction/wire/auth.d.ts +0 -56
- package/dist/transaction/wire/auth.js +0 -63
- package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
- package/dist/transaction/wire/bootstrapReason.js +0 -8
- package/dist/transaction/wire/claimEvent.d.ts +0 -76
- package/dist/transaction/wire/claimEvent.js +0 -73
- package/dist/transaction/wire/claims.d.ts +0 -530
- package/dist/transaction/wire/claims.js +0 -327
- package/dist/transaction/wire/commit.d.ts +0 -603
- package/dist/transaction/wire/commit.js +0 -321
- package/dist/transaction/wire/delta.d.ts +0 -250
- package/dist/transaction/wire/delta.js +0 -147
- package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
- package/dist/transaction/wire/errorEnvelope.js +0 -123
- package/dist/transaction/wire/feedCursor.d.ts +0 -60
- package/dist/transaction/wire/feedCursor.js +0 -82
- package/dist/transaction/wire/feedEvent.d.ts +0 -204
- package/dist/transaction/wire/feedEvent.js +0 -65
- package/dist/transaction/wire/frames.d.ts +0 -194
- package/dist/transaction/wire/frames.js +0 -50
- package/dist/transaction/wire/inboundFrames.d.ts +0 -562
- package/dist/transaction/wire/inboundFrames.js +0 -116
- package/dist/transaction/wire/index.d.ts +0 -54
- package/dist/transaction/wire/index.js +0 -83
- package/dist/transaction/wire/listEnvelope.d.ts +0 -37
- package/dist/transaction/wire/listEnvelope.js +0 -42
- package/dist/transaction/wire/modelMutations.d.ts +0 -31
- package/dist/transaction/wire/modelMutations.js +0 -52
- package/dist/transaction/wire/modelResponses.d.ts +0 -85
- package/dist/transaction/wire/modelResponses.js +0 -43
- package/dist/transaction/wire/modelShape.d.ts +0 -78
- package/dist/transaction/wire/modelShape.js +0 -74
- package/dist/transaction/wire/protocol.d.ts +0 -38
- package/dist/transaction/wire/protocol.js +0 -38
- package/dist/transaction/wire/protocolVersion.d.ts +0 -73
- package/dist/transaction/wire/protocolVersion.js +0 -83
- package/dist/transactions/mutations/MutationQueue.d.ts +0 -661
- package/dist/transactions/mutations/MutationQueue.js +0 -2807
- package/dist/transactions/mutations/MutationStore.d.ts +0 -20
- package/dist/transactions/mutations/MutationStore.js +0 -53
- package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
- package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
- package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
- package/dist/transactions/mutations/coalesceRules.js +0 -140
- package/dist/transactions/mutations/commitLatency.d.ts +0 -52
- package/dist/transactions/mutations/commitLatency.js +0 -130
- package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
- package/dist/transactions/mutations/commitOutboxStore.js +0 -26
- package/dist/transactions/mutations/commitPayload.d.ts +0 -165
- package/dist/transactions/mutations/commitPayload.js +0 -152
- package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -63
- package/dist/transactions/mutations/deltaConfirmation.js +0 -235
- package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
- package/dist/transactions/mutations/durableWriteStore.js +0 -12
- package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
- package/dist/transactions/mutations/optimisticApply.js +0 -65
- package/dist/transactions/mutations/replayValidation.d.ts +0 -187
- package/dist/transactions/mutations/replayValidation.js +0 -164
- package/dist/utils/mobxSetup.d.ts +0 -53
- package/dist/utils/mobxSetup.js +0 -330
- package/dist/views/QueryView.d.ts +0 -79
- package/dist/views/QueryView.js +0 -218
- package/dist/views/ViewRegistry.d.ts +0 -20
- package/dist/views/ViewRegistry.js +0 -55
- package/dist/views/incrementalView.d.ts +0 -45
- package/dist/views/incrementalView.js +0 -69
- package/dist/webhooks/events.d.ts +0 -43
- package/dist/webhooks/events.js +0 -42
- package/dist/webhooks/index.d.ts +0 -8
- package/dist/webhooks/index.js +0 -8
- package/dist/wire/index.d.ts +0 -1
- package/dist/wire/index.js +0 -8
package/dist/source/signing.js
DELETED
|
@@ -1,162 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Signs and verifies source requests using the Standard Webhooks scheme.
|
|
3
|
-
*
|
|
4
|
-
* Every request Ablo sends to a data source is signed with that source's API
|
|
5
|
-
* key, and the receiving endpoint verifies the signature before any handler
|
|
6
|
-
* runs. This module provides both halves: {@link signAbloSourceRequest} for
|
|
7
|
-
* the sender and {@link verifyAbloSourceRequest} for the receiver. Because the
|
|
8
|
-
* signature format follows the Standard Webhooks specification, you can verify
|
|
9
|
-
* it with any compatible library instead of these functions if you prefer.
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* The HTTP header names carried on a signed source request. They follow the
|
|
13
|
-
* Standard Webhooks specification (https://www.standardwebhooks.com/), so you
|
|
14
|
-
* can verify the signature with any compatible library rather than
|
|
15
|
-
* {@link verifyAbloSourceRequest} if you prefer.
|
|
16
|
-
*/
|
|
17
|
-
export const ABLO_SOURCE_HEADERS = {
|
|
18
|
-
signature: 'webhook-signature',
|
|
19
|
-
timestamp: 'webhook-timestamp',
|
|
20
|
-
id: 'webhook-id',
|
|
21
|
-
idempotencyKey: 'Idempotency-Key',
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
* Thrown when a source request fails signature verification. The
|
|
25
|
-
* {@link SourceSignatureError.code} names the specific reason — a missing
|
|
26
|
-
* header, a malformed or expired timestamp, or a signature that does not
|
|
27
|
-
* match.
|
|
28
|
-
*/
|
|
29
|
-
export class SourceSignatureError extends Error {
|
|
30
|
-
code;
|
|
31
|
-
constructor(code, message) {
|
|
32
|
-
super(message);
|
|
33
|
-
this.name = 'SourceSignatureError';
|
|
34
|
-
this.code = code;
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
const DEFAULT_SIGNATURE_TOLERANCE_MS = 5 * 60 * 1000;
|
|
38
|
-
function getHeader(request, name) {
|
|
39
|
-
const headers = request.headers;
|
|
40
|
-
if (!headers)
|
|
41
|
-
return null;
|
|
42
|
-
if (typeof headers.get === 'function') {
|
|
43
|
-
return headers.get(name);
|
|
44
|
-
}
|
|
45
|
-
const record = headers;
|
|
46
|
-
const value = record[name] ?? record[name.toLowerCase()] ?? null;
|
|
47
|
-
// Node folds repeated headers into an array; the signature headers are
|
|
48
|
-
// single-valued, so the first entry is the one that was signed.
|
|
49
|
-
return Array.isArray(value) ? (value[0] ?? null) : value;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Parse a `webhook-signature` header per the Standard Webhooks spec.
|
|
53
|
-
* Values are space-delimited `<scheme>,<base64>` pairs (e.g.
|
|
54
|
-
* `v1,abc== v1,def==` during a key rotation window). Returns the set
|
|
55
|
-
* of `v1` signatures so the verifier can accept any of them.
|
|
56
|
-
*/
|
|
57
|
-
function parseSignatureHeader(raw) {
|
|
58
|
-
if (!raw)
|
|
59
|
-
return [];
|
|
60
|
-
const out = [];
|
|
61
|
-
for (const part of raw.split(/\s+/)) {
|
|
62
|
-
const trimmed = part.trim();
|
|
63
|
-
if (!trimmed)
|
|
64
|
-
continue;
|
|
65
|
-
const commaAt = trimmed.indexOf(',');
|
|
66
|
-
if (commaAt === -1)
|
|
67
|
-
continue;
|
|
68
|
-
const scheme = trimmed.slice(0, commaAt);
|
|
69
|
-
const value = trimmed.slice(commaAt + 1);
|
|
70
|
-
if (scheme === 'v1' && value.length > 0) {
|
|
71
|
-
out.push(value);
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
return out;
|
|
75
|
-
}
|
|
76
|
-
function bufferToBase64(buffer) {
|
|
77
|
-
// Node + browsers both expose `btoa` on the global; we feed it
|
|
78
|
-
// a binary string built from the byte view.
|
|
79
|
-
let binary = '';
|
|
80
|
-
for (const byte of new Uint8Array(buffer)) {
|
|
81
|
-
binary += String.fromCharCode(byte);
|
|
82
|
-
}
|
|
83
|
-
return btoa(binary);
|
|
84
|
-
}
|
|
85
|
-
async function hmacSha256Base64(apiKey, payload) {
|
|
86
|
-
const crypto = globalThis.crypto?.subtle;
|
|
87
|
-
if (!crypto) {
|
|
88
|
-
throw new SourceSignatureError('source_signature_invalid', 'WebCrypto HMAC support is unavailable in this runtime');
|
|
89
|
-
}
|
|
90
|
-
const encoder = new TextEncoder();
|
|
91
|
-
const key = await crypto.importKey('raw', encoder.encode(apiKey), { name: 'HMAC', hash: 'SHA-256' }, false, ['sign']);
|
|
92
|
-
return bufferToBase64(await crypto.sign('HMAC', key, encoder.encode(payload)));
|
|
93
|
-
}
|
|
94
|
-
/**
|
|
95
|
-
* Constant-time string equality. Used over `===` so a malicious
|
|
96
|
-
* signature can't be probed byte-by-byte via timing differences.
|
|
97
|
-
*/
|
|
98
|
-
function timingSafeEqual(expected, actual) {
|
|
99
|
-
const max = Math.max(expected.length, actual.length);
|
|
100
|
-
let diff = expected.length ^ actual.length;
|
|
101
|
-
for (let i = 0; i < max; i++) {
|
|
102
|
-
diff |= (expected.charCodeAt(i) || 0) ^ (actual.charCodeAt(i) || 0);
|
|
103
|
-
}
|
|
104
|
-
return diff === 0;
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* Sign a source request and return the headers to send with it. The signature
|
|
108
|
-
* covers the message id, the timestamp, and the body, so any change to those
|
|
109
|
-
* invalidates it. The receiver checks it with {@link verifyAbloSourceRequest}.
|
|
110
|
-
*/
|
|
111
|
-
export async function signAbloSourceRequest(options) {
|
|
112
|
-
const signedAt = options.timestamp ?? Math.floor(Date.now() / 1000);
|
|
113
|
-
// Standard Webhooks signing input: `${msg_id}.${timestamp}.${payload}`
|
|
114
|
-
const signature = await hmacSha256Base64(options.apiKey, `${options.messageId}.${signedAt}.${options.body}`);
|
|
115
|
-
return {
|
|
116
|
-
signedAt,
|
|
117
|
-
signature,
|
|
118
|
-
headers: {
|
|
119
|
-
[ABLO_SOURCE_HEADERS.id]: options.messageId,
|
|
120
|
-
[ABLO_SOURCE_HEADERS.timestamp]: String(signedAt),
|
|
121
|
-
[ABLO_SOURCE_HEADERS.signature]: `v1,${signature}`,
|
|
122
|
-
},
|
|
123
|
-
};
|
|
124
|
-
}
|
|
125
|
-
/**
|
|
126
|
-
* Verify a signed source request, throwing {@link SourceSignatureError} when
|
|
127
|
-
* the message id, timestamp, or signature is missing, malformed, or outside
|
|
128
|
-
* the allowed clock-skew window. On success it returns the request's message
|
|
129
|
-
* id and signing time. This is the counterpart to {@link signAbloSourceRequest}.
|
|
130
|
-
*/
|
|
131
|
-
export async function verifyAbloSourceRequest(options) {
|
|
132
|
-
const messageId = getHeader(options.request, ABLO_SOURCE_HEADERS.id);
|
|
133
|
-
if (!messageId) {
|
|
134
|
-
throw new SourceSignatureError('source_id_missing', 'Missing webhook-id header');
|
|
135
|
-
}
|
|
136
|
-
const rawTimestamp = getHeader(options.request, ABLO_SOURCE_HEADERS.timestamp);
|
|
137
|
-
if (!rawTimestamp) {
|
|
138
|
-
throw new SourceSignatureError('source_timestamp_missing', 'Missing webhook-timestamp header');
|
|
139
|
-
}
|
|
140
|
-
const signedAt = Number(rawTimestamp);
|
|
141
|
-
if (!Number.isFinite(signedAt)) {
|
|
142
|
-
throw new SourceSignatureError('source_timestamp_invalid', 'Invalid webhook-timestamp header');
|
|
143
|
-
}
|
|
144
|
-
const toleranceMs = options.toleranceMs ?? DEFAULT_SIGNATURE_TOLERANCE_MS;
|
|
145
|
-
const nowSeconds = Math.floor(Date.now() / 1000);
|
|
146
|
-
const toleranceSeconds = Math.ceil(toleranceMs / 1000);
|
|
147
|
-
if (Math.abs(nowSeconds - signedAt) > toleranceSeconds) {
|
|
148
|
-
throw new SourceSignatureError('source_timestamp_expired', 'webhook-timestamp is outside the allowed clock-skew window');
|
|
149
|
-
}
|
|
150
|
-
const presented = parseSignatureHeader(getHeader(options.request, ABLO_SOURCE_HEADERS.signature));
|
|
151
|
-
if (presented.length === 0) {
|
|
152
|
-
throw new SourceSignatureError('source_signature_missing', 'Missing webhook-signature header');
|
|
153
|
-
}
|
|
154
|
-
const expected = await hmacSha256Base64(options.apiKey, `${messageId}.${signedAt}.${options.body}`);
|
|
155
|
-
// Accept any presented signature that matches — supports key
|
|
156
|
-
// rotation per the Standard Webhooks spec.
|
|
157
|
-
const ok = presented.some((sig) => timingSafeEqual(expected, sig));
|
|
158
|
-
if (!ok) {
|
|
159
|
-
throw new SourceSignatureError('source_signature_invalid', 'Invalid webhook-signature');
|
|
160
|
-
}
|
|
161
|
-
return { messageId, signedAt };
|
|
162
|
-
}
|
package/dist/source/types.d.ts
DELETED
|
@@ -1,401 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The types that describe a data source — the shapes exchanged over the wire
|
|
3
|
-
* and the handler interfaces you implement.
|
|
4
|
-
*
|
|
5
|
-
* A data source lets Ablo read from and write to your own database. These
|
|
6
|
-
* types cover the four request kinds Ablo can send ({@link SourceRequest}),
|
|
7
|
-
* the operations and change events they carry ({@link SourceOperation} and
|
|
8
|
-
* {@link SourceEvent}), the list-query and pagination shapes, and the handler
|
|
9
|
-
* and context types your source implements. {@link sourceEventForOperation}
|
|
10
|
-
* builds a change-event marker from an operation.
|
|
11
|
-
*/
|
|
12
|
-
import type { Environment } from '../transaction/environment.js';
|
|
13
|
-
import type { CommitOperationType, OnStaleMode } from '../transaction/coordination/schema.js';
|
|
14
|
-
import type { ParticipantKind } from '../transaction/types/participant.js';
|
|
15
|
-
/** A scalar value that can appear in a source filter. */
|
|
16
|
-
export type SourcePrimitive = string | number | boolean | null;
|
|
17
|
-
/**
|
|
18
|
-
* A single filter condition on a `list` query: a field paired with a value,
|
|
19
|
-
* or a field, comparison operator, and value. The two-element form is
|
|
20
|
-
* shorthand for equality.
|
|
21
|
-
*/
|
|
22
|
-
export type SourceWhere = readonly [field: string, value: SourcePrimitive] | readonly [
|
|
23
|
-
field: string,
|
|
24
|
-
op: '=' | '!=' | '<' | '<=' | '>' | '>=' | 'IN' | 'NOT IN' | 'IS' | 'IS NOT' | 'LIKE' | 'NOT LIKE' | 'ILIKE' | 'NOT ILIKE',
|
|
25
|
-
value: SourcePrimitive | readonly SourcePrimitive[]
|
|
26
|
-
];
|
|
27
|
-
/** The query Ablo passes to your `list` handler: filters, ordering, a limit, and a pagination cursor. */
|
|
28
|
-
export interface SourceListQuery {
|
|
29
|
-
readonly where?: readonly SourceWhere[];
|
|
30
|
-
readonly limit?: number;
|
|
31
|
-
readonly orderBy?: string;
|
|
32
|
-
readonly order?: 'asc' | 'desc';
|
|
33
|
-
readonly related?: readonly string[];
|
|
34
|
-
/**
|
|
35
|
-
* An opaque cursor returned by a previous `list` call. Your `list` handler
|
|
36
|
-
* decides what it encodes — a page index, a last id, a keyset. Ablo treats
|
|
37
|
-
* it as a black box and hands it back to fetch the next page until your
|
|
38
|
-
* handler stops returning a `nextCursor`.
|
|
39
|
-
*/
|
|
40
|
-
readonly cursor?: string;
|
|
41
|
-
}
|
|
42
|
-
/**
|
|
43
|
-
* The paginated return shape for a `list` handler. A handler may return a
|
|
44
|
-
* plain `Row[]` for a single, unpaginated page, or return this shape to expose
|
|
45
|
-
* a `nextCursor` that Ablo hands back on the following request.
|
|
46
|
-
*/
|
|
47
|
-
export interface SourceListPage<Row> {
|
|
48
|
-
readonly rows: readonly Row[];
|
|
49
|
-
readonly nextCursor?: string;
|
|
50
|
-
}
|
|
51
|
-
/** What a `list` handler returns: either a plain array of rows or a {@link SourceListPage}. */
|
|
52
|
-
export type SourceListResult<Row> = readonly Row[] | SourceListPage<Row>;
|
|
53
|
-
/**
|
|
54
|
-
* The scope of a source request: who is asking and what they are allowed to
|
|
55
|
-
* see. Ablo attaches this so your `authorize` and model handlers can reject
|
|
56
|
-
* calls that fall outside the participant's permitted sync groups.
|
|
57
|
-
*
|
|
58
|
-
* It is advisory. Because the canonical data lives in your database, your
|
|
59
|
-
* handlers are the only place that can actually enforce these limits.
|
|
60
|
-
*/
|
|
61
|
-
export interface SourceRequestContext {
|
|
62
|
-
readonly participantId?: string;
|
|
63
|
-
readonly participantKind?: ParticipantKind;
|
|
64
|
-
readonly organizationId?: string;
|
|
65
|
-
/** Trusted project plane selected by the authenticating credential. */
|
|
66
|
-
readonly projectId?: string;
|
|
67
|
-
/** Trusted sandbox plane selected by the authenticating credential. */
|
|
68
|
-
readonly sandboxId?: string;
|
|
69
|
-
readonly requiredSyncGroups?: readonly string[];
|
|
70
|
-
/**
|
|
71
|
-
* Whether this request runs in production or sandbox mode. Branch your
|
|
72
|
-
* handlers on it — for example, read and write a separate sandbox database
|
|
73
|
-
* when `mode === 'sandbox'` — so sandbox traffic exercises the same code
|
|
74
|
-
* against isolated data. Keeping the two apart is your handler's
|
|
75
|
-
* responsibility, since your database holds the canonical rows.
|
|
76
|
-
*
|
|
77
|
-
* Defaults to `'production'` when omitted.
|
|
78
|
-
*/
|
|
79
|
-
readonly mode?: Environment;
|
|
80
|
-
}
|
|
81
|
-
/**
|
|
82
|
-
* A single change Ablo asks your source to apply — a create, update, delete,
|
|
83
|
-
* archive, or unarchive of one row of `model`. Operations arrive in your
|
|
84
|
-
* `commit` handler through {@link SourceCommitParams}. `onStale` says what to
|
|
85
|
-
* do when the row changed since it was read at `readAt`.
|
|
86
|
-
*/
|
|
87
|
-
export interface SourceOperation {
|
|
88
|
-
readonly type: CommitOperationType;
|
|
89
|
-
readonly model: string;
|
|
90
|
-
readonly id?: string | null;
|
|
91
|
-
readonly input?: Record<string, unknown> | null;
|
|
92
|
-
readonly transactionId?: string | null;
|
|
93
|
-
readonly readAt?: number | null;
|
|
94
|
-
readonly onStale?: OnStaleMode | null;
|
|
95
|
-
}
|
|
96
|
-
/**
|
|
97
|
-
* A computed change to one row, ready to append to the change log. Your
|
|
98
|
-
* `commit` handler may return these directly, or return rows and let Ablo
|
|
99
|
-
* derive the deltas from them.
|
|
100
|
-
*/
|
|
101
|
-
export interface SourceDelta {
|
|
102
|
-
readonly model: string;
|
|
103
|
-
readonly id: string;
|
|
104
|
-
readonly type: SourceOperation['type'];
|
|
105
|
-
readonly data?: Record<string, unknown> | null;
|
|
106
|
-
readonly transactionId?: string | null;
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* A change that already happened in your database. Your `events` handler
|
|
110
|
-
* returns these, and Ablo appends them to the `sync_deltas` change log and
|
|
111
|
-
* fans them out to connected clients, exactly as it would a change made
|
|
112
|
-
* through the SDK.
|
|
113
|
-
*
|
|
114
|
-
* Your handler can return the whole outbox unfiltered. Ablo deduplicates on
|
|
115
|
-
* the stable `id`. A mediated endpoint write carries `correlationId` plus the
|
|
116
|
-
* operation's `transactionId`; those fields promote its queued receipt after
|
|
117
|
-
* the event is durably appended. External writes omit them.
|
|
118
|
-
*/
|
|
119
|
-
export interface SourceEvent {
|
|
120
|
-
/**
|
|
121
|
-
* A globally unique event id from your outbox. Ablo uses it for replay
|
|
122
|
-
* protection, so re-delivering the same id is a no-op.
|
|
123
|
-
*/
|
|
124
|
-
readonly id: string;
|
|
125
|
-
readonly model: string;
|
|
126
|
-
readonly entityId: string;
|
|
127
|
-
readonly type: SourceOperation['type'];
|
|
128
|
-
readonly data?: Record<string, unknown> | null;
|
|
129
|
-
/**
|
|
130
|
-
* The tenant this event belongs to. Populate it from the row's organization
|
|
131
|
-
* column for multi-tenant data; a single-tenant source may omit it and let
|
|
132
|
-
* the poller fall back to its configured default. It drives fan-out: clients
|
|
133
|
-
* in `org:${organizationId}` receive the resulting change.
|
|
134
|
-
*/
|
|
135
|
-
readonly organizationId?: string;
|
|
136
|
-
/**
|
|
137
|
-
* @deprecated Legacy echo identity. It is not trusted for queued settlement;
|
|
138
|
-
* use `correlationId` and `transactionId` for mediated endpoint writes.
|
|
139
|
-
*/
|
|
140
|
-
readonly clientTxId?: string;
|
|
141
|
-
/** Scoped server-authored identity of the queued mediated commit. */
|
|
142
|
-
readonly correlationId?: string;
|
|
143
|
-
/** Stable per-operation identity within the correlated commit. */
|
|
144
|
-
readonly transactionId?: string;
|
|
145
|
-
/**
|
|
146
|
-
* When the change occurred in your database. Optional and used only as an
|
|
147
|
-
* ordering hint; Ablo trusts the order of your handler's response over this
|
|
148
|
-
* field.
|
|
149
|
-
*/
|
|
150
|
-
readonly occurredAt?: number;
|
|
151
|
-
}
|
|
152
|
-
/** Inputs to {@link sourceEventForOperation}. */
|
|
153
|
-
export interface SourceEventForOperationOptions {
|
|
154
|
-
/**
|
|
155
|
-
* The stable id from your outbox table. It is Ablo's replay-protection key,
|
|
156
|
-
* so retries must return the same id.
|
|
157
|
-
*/
|
|
158
|
-
readonly eventId: string;
|
|
159
|
-
readonly operation: SourceOperation;
|
|
160
|
-
/**
|
|
161
|
-
* The committed row id. Defaults to `operation.id`; pass it explicitly for
|
|
162
|
-
* creates where the database assigns the id inside the transaction.
|
|
163
|
-
*/
|
|
164
|
-
readonly entityId?: string;
|
|
165
|
-
/**
|
|
166
|
-
* The row's payload after the write. Pass `null` for a delete. When omitted,
|
|
167
|
-
* the event carries no payload, which is valid but leaves less for clients to
|
|
168
|
-
* hydrate from in realtime.
|
|
169
|
-
*/
|
|
170
|
-
readonly data?: Record<string, unknown> | null;
|
|
171
|
-
/**
|
|
172
|
-
* @deprecated Legacy echo identity. Prefer the explicit correlation fields.
|
|
173
|
-
*/
|
|
174
|
-
readonly clientTxId?: string;
|
|
175
|
-
readonly correlationId?: string;
|
|
176
|
-
/** Defaults to `operation.transactionId` when present. */
|
|
177
|
-
readonly transactionId?: string;
|
|
178
|
-
readonly organizationId?: string;
|
|
179
|
-
readonly occurredAt?: number | Date;
|
|
180
|
-
}
|
|
181
|
-
/**
|
|
182
|
-
* Build the {@link SourceEvent} marker you should record in your outbox table,
|
|
183
|
-
* within the same transaction as the row change it describes.
|
|
184
|
-
*
|
|
185
|
-
* This helper only shapes the marker; it does not persist anything. Writing the
|
|
186
|
-
* returned event through your ORM or raw SQL keeps every source emitting the
|
|
187
|
-
* fields Ablo expects when it reconciles the change.
|
|
188
|
-
*/
|
|
189
|
-
export declare function sourceEventForOperation(options: SourceEventForOperationOptions): SourceEvent;
|
|
190
|
-
/** What your `commit` handler returns after applying operations. */
|
|
191
|
-
export interface SourceCommitResult<Row = Record<string, unknown>> {
|
|
192
|
-
/**
|
|
193
|
-
* The rows as they stand after the write. Ablo uses them to update its
|
|
194
|
-
* realtime projections and append the resulting changes.
|
|
195
|
-
*/
|
|
196
|
-
readonly rows?: readonly Row[];
|
|
197
|
-
/**
|
|
198
|
-
* Explicit changes, for sources that already compute them. Most sources can
|
|
199
|
-
* return rows instead and let Ablo derive the change payload.
|
|
200
|
-
*/
|
|
201
|
-
readonly deltas?: readonly SourceDelta[];
|
|
202
|
-
}
|
|
203
|
-
/**
|
|
204
|
-
* Requests a commit-correlated marker in the customer's Postgres WAL.
|
|
205
|
-
*
|
|
206
|
-
* This is opt-in because ordinary Data Source endpoints can be backed by
|
|
207
|
-
* stores other than Postgres. Connected Postgres planes request it for
|
|
208
|
-
* `wait: 'confirmed'`: the row changes and the logical message must be written
|
|
209
|
-
* by the same customer-side transaction, so a rollback publishes neither.
|
|
210
|
-
*/
|
|
211
|
-
export interface SourceCommitEcho {
|
|
212
|
-
readonly kind: 'postgres-wal';
|
|
213
|
-
/**
|
|
214
|
-
* Opaque, versioned marker payload authored by Ablo. A source handler must
|
|
215
|
-
* pass these exact bytes to `pg_logical_emit_message` inside the write
|
|
216
|
-
* transaction; it must not reconstruct or normalize the JSON.
|
|
217
|
-
*/
|
|
218
|
-
readonly payload: string;
|
|
219
|
-
}
|
|
220
|
-
/** Prefix reserved for Ablo commit-correlation messages in pgoutput. */
|
|
221
|
-
export declare const ABLO_POSTGRES_COMMIT_ECHO_PREFIX = "ablo";
|
|
222
|
-
/**
|
|
223
|
-
* Maximum source commit-correlation key length. This matches the server's
|
|
224
|
-
* idempotency-key contract: a WAL marker longer than this can never name an
|
|
225
|
-
* accepted Ablo commit and must not be appended as an apparently correlatable
|
|
226
|
-
* echo.
|
|
227
|
-
*/
|
|
228
|
-
export declare const ABLO_SOURCE_CLIENT_TX_ID_MAX_LENGTH = 255;
|
|
229
|
-
/** Connected-source batches are deliberately smaller than the generic wire cap. */
|
|
230
|
-
export declare const ABLO_SOURCE_ECHO_MAX_OPERATIONS = 500;
|
|
231
|
-
/** Maximum UTF-8 bytes accepted for one transactional WAL marker payload. */
|
|
232
|
-
export declare const ABLO_SOURCE_ECHO_MAX_PAYLOAD_BYTES: number;
|
|
233
|
-
export interface SourceCommitEchoOperation {
|
|
234
|
-
readonly model: string;
|
|
235
|
-
readonly id: string;
|
|
236
|
-
readonly action: 'I' | 'U' | 'D';
|
|
237
|
-
readonly transactionId: string;
|
|
238
|
-
}
|
|
239
|
-
/** Strict payload encoded into {@link SourceCommitEcho.payload}. */
|
|
240
|
-
export interface SourceCommitEchoMarker {
|
|
241
|
-
readonly version: 1;
|
|
242
|
-
readonly correlationId: string;
|
|
243
|
-
readonly operations: readonly SourceCommitEchoOperation[];
|
|
244
|
-
}
|
|
245
|
-
/** The arguments passed to a top-level {@link SourceCommitHandler}. */
|
|
246
|
-
export interface SourceCommitParams<TAuth = unknown> {
|
|
247
|
-
readonly operations: readonly SourceOperation[];
|
|
248
|
-
/** Scoped, server-authored customer-ledger identity. */
|
|
249
|
-
readonly correlationId?: string;
|
|
250
|
-
/** @deprecated Legacy wire name for `correlationId`. */
|
|
251
|
-
readonly clientTxId?: string;
|
|
252
|
-
/**
|
|
253
|
-
* Canonical hash of the complete caller intent (operations plus guarded
|
|
254
|
-
* context), authored and signed by Ablo. Persist it beside `correlationId` and
|
|
255
|
-
* reject a replay whose hash differs; this protects an ambiguous retry even
|
|
256
|
-
* if Ablo's local execution row rolled back after your commit succeeded.
|
|
257
|
-
*/
|
|
258
|
-
readonly intentHash?: string;
|
|
259
|
-
/** Present when the caller requires a transaction-correlated WAL echo. */
|
|
260
|
-
readonly echo?: SourceCommitEcho;
|
|
261
|
-
readonly context: SourceHandlerContext<TAuth>;
|
|
262
|
-
}
|
|
263
|
-
/**
|
|
264
|
-
* The operation an API key is permitted to invoke, one per request kind:
|
|
265
|
-
* `load` and `list` read, `commit` writes, and `events` reads the change feed.
|
|
266
|
-
* A key carries the set of scopes it is allowed to use.
|
|
267
|
-
*/
|
|
268
|
-
export type SourceScope = 'load' | 'list' | 'commit' | 'events';
|
|
269
|
-
/** What your `events` handler returns: a batch of changes and an optional next cursor. */
|
|
270
|
-
export interface SourceEventsResult {
|
|
271
|
-
readonly events: readonly SourceEvent[];
|
|
272
|
-
/**
|
|
273
|
-
* The cursor for the next poll. When omitted, Ablo treats the feed as fully
|
|
274
|
-
* drained for this round and reuses the last event's cursor, or the initial
|
|
275
|
-
* cursor, on the following call.
|
|
276
|
-
*/
|
|
277
|
-
readonly nextCursor?: string;
|
|
278
|
-
}
|
|
279
|
-
/**
|
|
280
|
-
* Your handler for the `events` request. Return the changes since `cursor` so
|
|
281
|
-
* Ablo can append and fan them out. See {@link SourceEvent}.
|
|
282
|
-
*/
|
|
283
|
-
export type SourceEventsHandler<TAuth = unknown> = (params: {
|
|
284
|
-
/**
|
|
285
|
-
* The cursor from a previous `events` call, or undefined on the first poll of
|
|
286
|
-
* a newly connected source. You decide what it encodes — a last event id, a
|
|
287
|
-
* timestamp, a log sequence number.
|
|
288
|
-
*/
|
|
289
|
-
readonly cursor?: string;
|
|
290
|
-
/**
|
|
291
|
-
* A suggested upper bound on how many events to return. You may return fewer;
|
|
292
|
-
* returning many more risks tripping Ablo's per-poll cap.
|
|
293
|
-
*/
|
|
294
|
-
readonly limit?: number;
|
|
295
|
-
readonly context: SourceHandlerContext<TAuth>;
|
|
296
|
-
}) => Promise<SourceEventsResult> | SourceEventsResult;
|
|
297
|
-
/** The request being authorized, passed to a function-form {@link SourceApiKey} or an `authorize` hook. */
|
|
298
|
-
export interface SourceAuthorizeContext {
|
|
299
|
-
readonly request: Request;
|
|
300
|
-
readonly body: unknown;
|
|
301
|
-
readonly rawBody: string;
|
|
302
|
-
}
|
|
303
|
-
export interface SourceHandlerContext<TAuth = unknown> {
|
|
304
|
-
readonly auth: TAuth;
|
|
305
|
-
readonly request: Request;
|
|
306
|
-
/**
|
|
307
|
-
* The `webhook-id` from the signed request, globally unique per the
|
|
308
|
-
* Standard Webhooks specification. Dedupe by this id to defend against
|
|
309
|
-
* replay: Ablo does not deduplicate at the source-handler boundary.
|
|
310
|
-
* Commit idempotency keys on the scoped `correlationId`, and event replay protection
|
|
311
|
-
* keys on the outbox event `id`.
|
|
312
|
-
*/
|
|
313
|
-
readonly messageId?: string;
|
|
314
|
-
readonly signedAt?: number;
|
|
315
|
-
/**
|
|
316
|
-
* The scope context Ablo attached to this request, naming the participant
|
|
317
|
-
* and the sync groups they are allowed to see. Present when the host
|
|
318
|
-
* opted into scope-aware requests. Use it in `authorize` to reject
|
|
319
|
-
* out-of-scope calls, and in `list` and `load` to filter rows down to
|
|
320
|
-
* what the participant may see.
|
|
321
|
-
*
|
|
322
|
-
* Absent for requests made without scope context, such as tests or
|
|
323
|
-
* single-tenant deployments that do not need scoped fan-out.
|
|
324
|
-
*/
|
|
325
|
-
readonly scope?: SourceRequestContext;
|
|
326
|
-
}
|
|
327
|
-
export interface SourceModelHandlers<Row, CreateInput, TAuth = unknown> {
|
|
328
|
-
load?(params: {
|
|
329
|
-
readonly id: string;
|
|
330
|
-
readonly context: SourceHandlerContext<TAuth>;
|
|
331
|
-
}): Promise<Row | null> | Row | null;
|
|
332
|
-
list?(params: {
|
|
333
|
-
readonly query: SourceListQuery;
|
|
334
|
-
readonly context: SourceHandlerContext<TAuth>;
|
|
335
|
-
}): Promise<SourceListResult<Row>> | SourceListResult<Row>;
|
|
336
|
-
/**
|
|
337
|
-
* Apply one or more operations for this model within your own database
|
|
338
|
-
* transaction. Your handler must be idempotent on the scoped server
|
|
339
|
-
* `correlationId`, so that a retried commit does not apply the change twice.
|
|
340
|
-
*/
|
|
341
|
-
commit?(params: {
|
|
342
|
-
readonly operations: readonly SourceOperation[];
|
|
343
|
-
/** Scoped, server-authored customer-ledger identity. */
|
|
344
|
-
readonly correlationId?: string;
|
|
345
|
-
/** @deprecated Legacy wire name for `correlationId`. */
|
|
346
|
-
readonly clientTxId?: string;
|
|
347
|
-
/** Persist and compare this hash as part of the idempotency ledger. */
|
|
348
|
-
readonly intentHash?: string;
|
|
349
|
-
/** Emit this marker inside the same transaction as the operations. */
|
|
350
|
-
readonly echo?: SourceCommitEcho;
|
|
351
|
-
readonly context: SourceHandlerContext<TAuth>;
|
|
352
|
-
}): Promise<SourceCommitResult<Row>> | SourceCommitResult<Row>;
|
|
353
|
-
}
|
|
354
|
-
export type SourceCommitHandler<TAuth = unknown> = (params: SourceCommitParams<TAuth>) => Promise<SourceCommitResult> | SourceCommitResult;
|
|
355
|
-
export type SourceApiKey = string | ((context: SourceAuthorizeContext) => Promise<string> | string);
|
|
356
|
-
export interface SourceLoadRequest {
|
|
357
|
-
readonly type: 'load';
|
|
358
|
-
readonly model: string;
|
|
359
|
-
readonly id: string;
|
|
360
|
-
readonly scope?: SourceRequestContext;
|
|
361
|
-
}
|
|
362
|
-
export interface SourceListRequest {
|
|
363
|
-
readonly type: 'list';
|
|
364
|
-
readonly model: string;
|
|
365
|
-
readonly query?: SourceListQuery;
|
|
366
|
-
readonly scope?: SourceRequestContext;
|
|
367
|
-
}
|
|
368
|
-
export interface SourceCommitRequest {
|
|
369
|
-
readonly type: 'commit';
|
|
370
|
-
/**
|
|
371
|
-
* Optional single-model hint. Omit for cross-model commits; top-level
|
|
372
|
-
* `commit` receives the whole operation array unchanged.
|
|
373
|
-
*/
|
|
374
|
-
readonly model?: string;
|
|
375
|
-
readonly operations: readonly SourceOperation[];
|
|
376
|
-
/** Scoped, server-authored customer-ledger identity. */
|
|
377
|
-
readonly correlationId?: string;
|
|
378
|
-
/** @deprecated Legacy wire name for `correlationId`. */
|
|
379
|
-
readonly clientTxId?: string;
|
|
380
|
-
/** Signed canonical hash of the complete server-side commit intent. */
|
|
381
|
-
readonly intentHash?: string;
|
|
382
|
-
/** Commit-confirmation marker requested by a connected Postgres plane. */
|
|
383
|
-
readonly echo?: SourceCommitEcho;
|
|
384
|
-
readonly scope?: SourceRequestContext;
|
|
385
|
-
}
|
|
386
|
-
export interface SourceEventsRequest {
|
|
387
|
-
readonly type: 'events';
|
|
388
|
-
readonly cursor?: string;
|
|
389
|
-
readonly limit?: number;
|
|
390
|
-
readonly scope?: SourceRequestContext;
|
|
391
|
-
}
|
|
392
|
-
export type SourceRequest = SourceLoadRequest | SourceListRequest | SourceCommitRequest | SourceEventsRequest;
|
|
393
|
-
export type SourceResponse<Row = Record<string, unknown>> = {
|
|
394
|
-
readonly row: Row | null;
|
|
395
|
-
} | {
|
|
396
|
-
readonly rows: readonly Row[];
|
|
397
|
-
readonly nextCursor?: string;
|
|
398
|
-
} | {
|
|
399
|
-
readonly rows?: readonly Row[];
|
|
400
|
-
readonly deltas?: readonly SourceDelta[];
|
|
401
|
-
};
|
package/dist/source/types.js
DELETED
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The types that describe a data source — the shapes exchanged over the wire
|
|
3
|
-
* and the handler interfaces you implement.
|
|
4
|
-
*
|
|
5
|
-
* A data source lets Ablo read from and write to your own database. These
|
|
6
|
-
* types cover the four request kinds Ablo can send ({@link SourceRequest}),
|
|
7
|
-
* the operations and change events they carry ({@link SourceOperation} and
|
|
8
|
-
* {@link SourceEvent}), the list-query and pagination shapes, and the handler
|
|
9
|
-
* and context types your source implements. {@link sourceEventForOperation}
|
|
10
|
-
* builds a change-event marker from an operation.
|
|
11
|
-
*/
|
|
12
|
-
import { AbloValidationError } from '../transaction/errors.js';
|
|
13
|
-
/**
|
|
14
|
-
* Build the {@link SourceEvent} marker you should record in your outbox table,
|
|
15
|
-
* within the same transaction as the row change it describes.
|
|
16
|
-
*
|
|
17
|
-
* This helper only shapes the marker; it does not persist anything. Writing the
|
|
18
|
-
* returned event through your ORM or raw SQL keeps every source emitting the
|
|
19
|
-
* fields Ablo expects when it reconciles the change.
|
|
20
|
-
*/
|
|
21
|
-
export function sourceEventForOperation(options) {
|
|
22
|
-
const entityId = options.entityId ?? options.operation.id;
|
|
23
|
-
if (typeof entityId !== 'string' || entityId.length === 0) {
|
|
24
|
-
throw new AbloValidationError('sourceEventForOperation requires operation.id or an explicit entityId', { code: 'source_event_invalid' });
|
|
25
|
-
}
|
|
26
|
-
const occurredAt = normalizeEventOccurredAt(options.occurredAt);
|
|
27
|
-
const transactionId = options.transactionId ?? options.operation.transactionId ?? undefined;
|
|
28
|
-
return {
|
|
29
|
-
id: options.eventId,
|
|
30
|
-
model: options.operation.model,
|
|
31
|
-
entityId,
|
|
32
|
-
type: options.operation.type,
|
|
33
|
-
...(options.data !== undefined ? { data: options.data } : {}),
|
|
34
|
-
...(options.organizationId ? { organizationId: options.organizationId } : {}),
|
|
35
|
-
...(options.clientTxId ? { clientTxId: options.clientTxId } : {}),
|
|
36
|
-
...(options.correlationId ? { correlationId: options.correlationId } : {}),
|
|
37
|
-
...(transactionId ? { transactionId } : {}),
|
|
38
|
-
...(occurredAt !== undefined ? { occurredAt } : {}),
|
|
39
|
-
};
|
|
40
|
-
}
|
|
41
|
-
function normalizeEventOccurredAt(value) {
|
|
42
|
-
if (value === undefined)
|
|
43
|
-
return undefined;
|
|
44
|
-
const timestamp = value instanceof Date ? value.getTime() : value;
|
|
45
|
-
return Number.isFinite(timestamp) ? timestamp : undefined;
|
|
46
|
-
}
|
|
47
|
-
/** Prefix reserved for Ablo commit-correlation messages in pgoutput. */
|
|
48
|
-
export const ABLO_POSTGRES_COMMIT_ECHO_PREFIX = 'ablo';
|
|
49
|
-
/**
|
|
50
|
-
* Maximum source commit-correlation key length. This matches the server's
|
|
51
|
-
* idempotency-key contract: a WAL marker longer than this can never name an
|
|
52
|
-
* accepted Ablo commit and must not be appended as an apparently correlatable
|
|
53
|
-
* echo.
|
|
54
|
-
*/
|
|
55
|
-
export const ABLO_SOURCE_CLIENT_TX_ID_MAX_LENGTH = 255;
|
|
56
|
-
/** Connected-source batches are deliberately smaller than the generic wire cap. */
|
|
57
|
-
export const ABLO_SOURCE_ECHO_MAX_OPERATIONS = 500;
|
|
58
|
-
/** Maximum UTF-8 bytes accepted for one transactional WAL marker payload. */
|
|
59
|
-
export const ABLO_SOURCE_ECHO_MAX_PAYLOAD_BYTES = 256 * 1024;
|