@abloatai/ablo 0.35.0 → 0.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +2 -2
- package/CHANGELOG.md +71 -1929
- package/NOTICE +2 -2
- package/README.md +23 -532
- 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 -112
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -161
- 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 +2 -2
- package/docs/api-keys.md +13 -12
- package/docs/api.md +15 -53
- package/docs/audit.md +4 -3
- package/docs/cli.md +11 -11
- package/docs/client-behavior.md +9 -9
- package/docs/concurrency-convention.md +28 -42
- package/docs/coordination.md +228 -86
- package/docs/data-sources.md +5 -5
- package/docs/debugging.md +34 -12
- package/docs/deployment.md +8 -8
- 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/scoped-agent.md +3 -3
- package/docs/examples/server-agent.md +2 -2
- package/docs/groups.md +57 -3
- package/docs/guarantees.md +37 -10
- package/docs/how-it-works.md +32 -8
- package/docs/idempotency.md +6 -6
- package/docs/identity.md +24 -24
- package/docs/index.md +8 -8
- package/docs/integration-guide.md +38 -16
- 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 +9 -9
- package/docs/migration.md +37 -18
- package/docs/projects.md +1 -1
- package/docs/quickstart.md +2 -2
- package/docs/react.md +24 -13
- package/docs/schema-contract.md +3 -3
- package/docs/sessions.md +91 -37
- package/docs/webhooks.md +9 -9
- 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 +12 -12
- package/package.json +64 -174
- package/dist/BaseSyncedStore.d.ts +0 -823
- package/dist/BaseSyncedStore.js +0 -1955
- package/dist/Database.d.ts +0 -335
- package/dist/Database.js +0 -1500
- package/dist/InstanceCache.d.ts +0 -233
- package/dist/InstanceCache.js +0 -1164
- package/dist/LazyReferenceCollection.d.ts +0 -177
- package/dist/LazyReferenceCollection.js +0 -461
- package/dist/Model.d.ts +0 -444
- package/dist/Model.js +0 -909
- package/dist/ModelRegistry.d.ts +0 -221
- package/dist/ModelRegistry.js +0 -537
- package/dist/NetworkMonitor.d.ts +0 -26
- package/dist/NetworkMonitor.js +0 -77
- package/dist/RuntimeContext.d.ts +0 -52
- package/dist/RuntimeContext.js +0 -80
- package/dist/SyncClient.d.ts +0 -551
- package/dist/SyncClient.js +0 -2199
- 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/cli.cjs +0 -288600
- package/dist/client/Ablo.d.ts +0 -231
- package/dist/client/Ablo.js +0 -149
- 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 -46
- package/dist/client/createInternalComponents.js +0 -92
- package/dist/client/createModelProxy.d.ts +0 -228
- package/dist/client/createModelProxy.js +0 -818
- package/dist/client/humans.d.ts +0 -48
- package/dist/client/humans.js +0 -52
- 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 -48
- package/dist/client/reactiveEngine.js +0 -910
- 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/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 -29
- package/dist/context.js +0 -58
- 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/DatabaseManager.d.ts +0 -105
- package/dist/core/DatabaseManager.js +0 -387
- package/dist/core/QueryProcessor.d.ts +0 -75
- package/dist/core/QueryProcessor.js +0 -255
- package/dist/core/QueryView.d.ts +0 -79
- package/dist/core/QueryView.js +0 -218
- package/dist/core/StoreManager.d.ts +0 -112
- package/dist/core/StoreManager.js +0 -302
- package/dist/core/ViewRegistry.d.ts +0 -20
- package/dist/core/ViewRegistry.js +0 -55
- package/dist/core/index.d.ts +0 -33
- package/dist/core/index.js +0 -48
- package/dist/core/openIDBWithTimeout.d.ts +0 -65
- package/dist/core/openIDBWithTimeout.js +0 -153
- package/dist/core/queryUtils.d.ts +0 -45
- package/dist/core/queryUtils.js +0 -69
- package/dist/core/storeContract.d.ts +0 -145
- package/dist/core/storeContract.js +0 -12
- package/dist/docs/catalog.d.ts +0 -72
- package/dist/docs/catalog.js +0 -227
- 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/client.d.ts +0 -61
- package/dist/query/client.js +0 -137
- package/dist/query/types.d.ts +0 -85
- package/dist/query/types.js +0 -16
- package/dist/react/AbloProvider.d.ts +0 -230
- package/dist/react/AbloProvider.js +0 -455
- 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/index.d.ts +0 -61
- package/dist/react/index.js +0 -66
- package/dist/react/internalContext.d.ts +0 -33
- package/dist/react/internalContext.js +0 -3
- package/dist/react/useAblo.d.ts +0 -75
- package/dist/react/useAblo.js +0 -102
- 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 -129
- 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 -41
- package/dist/schema/index.js +0 -76
- 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 -87
- package/dist/schema/serialize.d.ts +0 -115
- package/dist/schema/serialize.js +0 -262
- 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 -81
- package/dist/source/adapter.js +0 -22
- 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/footprint.d.ts +0 -111
- package/dist/source/footprint.js +0 -0
- 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/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/SyncActionStore.d.ts +0 -97
- package/dist/stores/SyncActionStore.js +0 -504
- 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 -280
- package/dist/sync/BootstrapFetcher.js +0 -962
- package/dist/sync/ConnectionManager.d.ts +0 -8
- package/dist/sync/ConnectionManager.js +0 -8
- package/dist/sync/OnDemandLoader.d.ts +0 -228
- package/dist/sync/OnDemandLoader.js +0 -742
- 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 -70
- 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 -113
- package/dist/sync/deltaPipeline.js +0 -261
- package/dist/sync/groupChange.d.ts +0 -113
- package/dist/sync/groupChange.js +0 -242
- package/dist/sync/participants.d.ts +0 -115
- package/dist/sync/participants.js +0 -344
- 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 -70
- 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/testing/fixtures/bootstrap.d.ts +0 -49
- package/dist/testing/fixtures/bootstrap.js +0 -59
- package/dist/testing/fixtures/deltas.d.ts +0 -83
- package/dist/testing/fixtures/deltas.js +0 -136
- package/dist/testing/fixtures/httpResponses.d.ts +0 -70
- package/dist/testing/fixtures/httpResponses.js +0 -90
- package/dist/testing/fixtures/models.d.ts +0 -83
- package/dist/testing/fixtures/models.js +0 -272
- package/dist/testing/helpers/reactWrapper.d.ts +0 -69
- package/dist/testing/helpers/reactWrapper.js +0 -67
- package/dist/testing/helpers/syncEngineHarness.d.ts +0 -54
- package/dist/testing/helpers/syncEngineHarness.js +0 -73
- package/dist/testing/helpers/wait.d.ts +0 -30
- package/dist/testing/helpers/wait.js +0 -49
- package/dist/testing/index.d.ts +0 -23
- package/dist/testing/index.js +0 -33
- package/dist/testing/mocks/FakeDatabase.d.ts +0 -18
- package/dist/testing/mocks/FakeDatabase.js +0 -10
- package/dist/testing/mocks/MockMutationExecutor.d.ts +0 -87
- package/dist/testing/mocks/MockMutationExecutor.js +0 -186
- package/dist/testing/mocks/MockNetworkMonitor.d.ts +0 -20
- package/dist/testing/mocks/MockNetworkMonitor.js +0 -46
- package/dist/testing/mocks/MockSyncContext.d.ts +0 -51
- package/dist/testing/mocks/MockSyncContext.js +0 -72
- package/dist/testing/mocks/MockSyncStore.d.ts +0 -88
- package/dist/testing/mocks/MockSyncStore.js +0 -171
- package/dist/testing/mocks/MockWebSocket.d.ts +0 -71
- package/dist/testing/mocks/MockWebSocket.js +0 -118
- 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 -177
- package/dist/transaction/auth/capability.js +0 -199
- 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 -49
- package/dist/transaction/coordination/awaitClaimGrant.js +0 -112
- package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -50
- package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -88
- 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 -44
- package/dist/transaction/coordination/locator.d.ts +0 -83
- package/dist/transaction/coordination/locator.js +0 -82
- package/dist/transaction/coordination/schema.d.ts +0 -1473
- package/dist/transaction/coordination/schema.js +0 -1013
- package/dist/transaction/coordination/targetConflict.d.ts +0 -2
- package/dist/transaction/coordination/targetConflict.js +0 -103
- 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 -480
- package/dist/transaction/errors.d.ts +0 -428
- package/dist/transaction/errors.js +0 -686
- 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 -192
- package/dist/transaction/plugin.js +0 -87
- 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 -266
- package/dist/transaction/resources/httpResources.js +0 -7
- package/dist/transaction/resources/modelOperations.d.ts +0 -319
- 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 -85
- package/dist/transaction/resources/where.js +0 -70
- 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 -126
- package/dist/transaction/schema/field.js +0 -265
- 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 -57
- package/dist/transaction/schema/openapi.js +0 -340
- package/dist/transaction/schema/relation.d.ts +0 -199
- 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 -324
- package/dist/transaction/schema/schema.js +0 -305
- 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 -123
- package/dist/transaction/transport/httpClient.js +0 -145
- 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 -1276
- 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 -576
- package/dist/transaction/transport/wsTransport.js +0 -1017
- 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 -540
- 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 -25
- package/dist/transaction/utils/duration.js +0 -45
- 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 -351
- package/dist/transaction/wire/accountResponses.js +0 -255
- package/dist/transaction/wire/auth.d.ts +0 -49
- package/dist/transaction/wire/auth.js +0 -57
- 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 -463
- package/dist/transaction/wire/claims.js +0 -229
- 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 -177
- package/dist/transaction/wire/feedEvent.js +0 -39
- 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 -552
- package/dist/transaction/wire/inboundFrames.js +0 -116
- package/dist/transaction/wire/index.d.ts +0 -50
- package/dist/transaction/wire/index.js +0 -74
- package/dist/transaction/wire/listEnvelope.d.ts +0 -37
- package/dist/transaction/wire/listEnvelope.js +0 -42
- package/dist/transaction/wire/modelResponses.d.ts +0 -85
- package/dist/transaction/wire/modelResponses.js +0 -43
- 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 -655
- package/dist/transactions/mutations/MutationQueue.js +0 -2797
- 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 -164
- package/dist/transactions/mutations/commitPayload.js +0 -152
- package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -59
- package/dist/transactions/mutations/deltaConfirmation.js +0 -233
- 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 -186
- package/dist/transactions/mutations/replayValidation.js +0 -163
- package/dist/utils/mobxSetup.d.ts +0 -53
- package/dist/utils/mobxSetup.js +0 -330
- 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/docs/interaction-model.md +0 -99
|
@@ -1,540 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The types for real-time multiplayer coordination.
|
|
3
|
-
*
|
|
4
|
-
* Ablo treats people and AI agents alike as participants working on live
|
|
5
|
-
* application entities. A participant announces what it is reading or editing,
|
|
6
|
-
* claims an entity before writing to it, and captures a context snapshot before
|
|
7
|
-
* starting long-running AI work. You keep your own schema, agent stack, tools,
|
|
8
|
-
* prompts, and product rules; this package provides the shared coordination
|
|
9
|
-
* layer underneath.
|
|
10
|
-
*/
|
|
11
|
-
import type { InferModel, Schema } from '../schema/schema.js';
|
|
12
|
-
import type { ResolveClaimMeta } from './global.js';
|
|
13
|
-
import type { TargetRange, OnStaleMode, WireClaim, ClaimRejection, ClaimLost, PresenceKind, ParticipantKind, PublicClaimStatus, PresenceUpdatePayload } from '../coordination/schema.js';
|
|
14
|
-
export type { TargetRange, OnStaleMode, WireClaim, ClaimRejection, ClaimLost, PresenceKind, ParticipantKind, PresenceUpdatePayload, };
|
|
15
|
-
/**
|
|
16
|
-
* Any JSON-serializable value. Used where the SDK accepts free-form metadata
|
|
17
|
-
* that is stored or transported as JSON — more precise than `unknown` while
|
|
18
|
-
* still allowing any JSON shape.
|
|
19
|
-
*/
|
|
20
|
-
export type JsonValue = string | number | boolean | null | readonly JsonValue[] | {
|
|
21
|
-
readonly [key: string]: JsonValue;
|
|
22
|
-
};
|
|
23
|
-
export type { ParticipantRef } from './participant.js';
|
|
24
|
-
import type { Delta } from '../wire/delta.js';
|
|
25
|
-
export type { ConfirmationState, Delta } from '../wire/delta.js';
|
|
26
|
-
/**
|
|
27
|
-
* @deprecated Renamed to {@link Delta} — the authoritative change feed serves
|
|
28
|
-
* every participant, not only agents, and the seam names it plainly.
|
|
29
|
-
* Removed in 0.36.0.
|
|
30
|
-
*/
|
|
31
|
-
export type AgentDelta = Delta;
|
|
32
|
-
/**
|
|
33
|
-
* A flat, point-in-time view of application data returned by
|
|
34
|
-
* `participant.snapshot(...)`. Capture it before long-running AI work, then
|
|
35
|
-
* detect whether the data changed underneath while that work ran.
|
|
36
|
-
*
|
|
37
|
-
* - Per-model buckets: `snap.<modelName>[id]` returns the entity, typed from
|
|
38
|
-
* your schema (via `InferModel`) rather than as `unknown` — so, for
|
|
39
|
-
* example, `snap.clauses[clauseId].text` is a `string`.
|
|
40
|
-
* - `stamp` — an opaque version marker. Thread it into writes as
|
|
41
|
-
* `{ readAt: snap.stamp }` so the server can reject a write made against
|
|
42
|
-
* stale data.
|
|
43
|
-
* - `signal` — an `AbortSignal` that fires if any captured entity receives a
|
|
44
|
-
* change during the window. Pass it into your LLM call so a mid-generation
|
|
45
|
-
* change aborts the token stream instead of completing against a snapshot
|
|
46
|
-
* that is no longer current.
|
|
47
|
-
* - `onChange(fn)` — a callback alternative to `signal` for cases that don't
|
|
48
|
-
* abort, such as logging, UI flags, or partial regeneration. Returns an
|
|
49
|
-
* unsubscribe function.
|
|
50
|
-
*
|
|
51
|
-
* The per-model buckets share the object with `stamp`, `signal`, and
|
|
52
|
-
* `onChange`, so naming a model `stamp`, `signal`, or `onChange` collides.
|
|
53
|
-
* Snapshot creation throws a clear error in that case.
|
|
54
|
-
*/
|
|
55
|
-
export type Snapshot<TSchema extends Schema = Schema, ModelName extends keyof TSchema['models'] = keyof TSchema['models']> = {
|
|
56
|
-
readonly stamp: number;
|
|
57
|
-
readonly signal: AbortSignal;
|
|
58
|
-
onChange(listener: (change: ContextChange) => void): () => void;
|
|
59
|
-
} & {
|
|
60
|
-
readonly [M in ModelName]: Readonly<Record<string, InferModel<TSchema, M>>>;
|
|
61
|
-
};
|
|
62
|
-
export interface ContextChange {
|
|
63
|
-
readonly model: string;
|
|
64
|
-
readonly id: string;
|
|
65
|
-
readonly severity: 'semantic' | 'metadata';
|
|
66
|
-
}
|
|
67
|
-
/**
|
|
68
|
-
* The staleness mode for a write that follows a snapshot. When `readAt` is
|
|
69
|
-
* provided without an `onStale` mode, it defaults to `'reject'`.
|
|
70
|
-
*/
|
|
71
|
-
/**
|
|
72
|
-
* A pointer to one entity, optionally narrowed to a part of it. `type` and `id`
|
|
73
|
-
* come from your schema; `path`, `range`, `field`, and `meta` are
|
|
74
|
-
* general-purpose hints for finer-grained coordination in tools like code
|
|
75
|
-
* editors, document editors, and design tools.
|
|
76
|
-
*/
|
|
77
|
-
export interface ClaimTarget<M = ResolveClaimMeta> {
|
|
78
|
-
readonly type: string;
|
|
79
|
-
readonly id: string;
|
|
80
|
-
readonly path?: string;
|
|
81
|
-
readonly range?: TargetRange;
|
|
82
|
-
readonly field?: string;
|
|
83
|
-
/**
|
|
84
|
-
* Several named parts of the row at once — three sections of a document, two
|
|
85
|
-
* cells of a table. Claims conflict where their sets intersect, so two
|
|
86
|
-
* holders working on disjoint parts of one row do not wait for each other.
|
|
87
|
-
*
|
|
88
|
-
* Use this instead of packing names into `field`: a delimited string compares
|
|
89
|
-
* as one opaque value, so `'b_1,b_2'` and `'b_2,b_3'` read as unrelated
|
|
90
|
-
* targets and both holders are granted `b_2`.
|
|
91
|
-
*/
|
|
92
|
-
readonly fields?: readonly string[];
|
|
93
|
-
/**
|
|
94
|
-
* Application metadata, carried verbatim and never interpreted.
|
|
95
|
-
*
|
|
96
|
-
* The protocol does not know what is in here — the caller does, so the
|
|
97
|
-
* caller says so once, where the schema is already registered:
|
|
98
|
-
*
|
|
99
|
-
* ```ts
|
|
100
|
-
* declare module '@abloatai/ablo' {
|
|
101
|
-
* interface Register { ClaimMeta: { blocks: string[] } }
|
|
102
|
-
* }
|
|
103
|
-
* ```
|
|
104
|
-
*
|
|
105
|
-
* From then on every claim surface reads this field as that shape and no
|
|
106
|
-
* read of it needs a `typeof` guard. The `M` parameter remains for a program
|
|
107
|
-
* carrying more than one meta shape — `claim.state<OtherMeta>({ id })`
|
|
108
|
-
* overrides the registration for that one call.
|
|
109
|
-
*/
|
|
110
|
-
readonly meta?: M;
|
|
111
|
-
}
|
|
112
|
-
/**
|
|
113
|
-
* A pointer to the entity a participant is acting on. Either a
|
|
114
|
-
* {@link ClaimTarget} object or a `[type, id]` tuple such as `['Clause', 'cl_3']`
|
|
115
|
-
* for concise inline use. The verb methods below accept either form.
|
|
116
|
-
*/
|
|
117
|
-
export type PresenceTarget = ClaimTarget | readonly [type: string, id: string];
|
|
118
|
-
/**
|
|
119
|
-
* A reactive, always-on stream of what every participant is doing. Each
|
|
120
|
-
* participant has one, and it stays current for as long as the connection is
|
|
121
|
-
* open.
|
|
122
|
-
*/
|
|
123
|
-
export interface PresenceStream {
|
|
124
|
-
/**
|
|
125
|
-
* This participant's own broadcast state — the same thing every other
|
|
126
|
-
* participant sees for it. Read-only here; change it through `update(...)`.
|
|
127
|
-
*/
|
|
128
|
-
readonly self: Peer;
|
|
129
|
-
/**
|
|
130
|
-
* Broadcast a new activity. Synchronous — the frame ships on the already-open
|
|
131
|
-
* connection, with no request-response round-trip to await. Call it as often
|
|
132
|
-
* as the activity meaningfully changes: on read, on generation start, on
|
|
133
|
-
* partial output, on write, on done.
|
|
134
|
-
*
|
|
135
|
-
* For the common actions, prefer the verb methods below (`editing`,
|
|
136
|
-
* `viewing`, and so on): they read as one line and save you from remembering
|
|
137
|
-
* the action strings.
|
|
138
|
-
*/
|
|
139
|
-
update(activity: Activity): void;
|
|
140
|
-
/** Participant is actively modifying this entity. */
|
|
141
|
-
editing(target: PresenceTarget, detail?: string): void;
|
|
142
|
-
/** Participant is reading this entity; no modifications. */
|
|
143
|
-
reading(target: PresenceTarget, detail?: string): void;
|
|
144
|
-
/** Participant is reading this entity; no modifications. */
|
|
145
|
-
viewing(target: PresenceTarget, detail?: string): void;
|
|
146
|
-
/** Participant has stepped away from any specific entity. */
|
|
147
|
-
idle(): void;
|
|
148
|
-
/**
|
|
149
|
-
* A reactive view of every other participant's current activity on this
|
|
150
|
-
* participant's sync groups. Reading it returns the current snapshot; pair it
|
|
151
|
-
* with `onChange(listener)` below to be notified when it changes.
|
|
152
|
-
*
|
|
153
|
-
* You can drop `presence.others` into an LLM's system prompt so the model
|
|
154
|
-
* reasons about what other agents are doing right now — for example,
|
|
155
|
-
* "copy-bot is generating a new title for section 5; don't duplicate that work."
|
|
156
|
-
*/
|
|
157
|
-
readonly others: readonly Peer[];
|
|
158
|
-
/** Subset of `others` filtered to a specific sync group. */
|
|
159
|
-
othersIn(syncGroup: string): readonly Peer[];
|
|
160
|
-
/**
|
|
161
|
-
* A framework-agnostic reactivity hook. Register a callback that fires
|
|
162
|
-
* whenever `others` or `othersIn(...)` changes — a peer joined, left, or
|
|
163
|
-
* updated its activity. Returns a function that unsubscribes.
|
|
164
|
-
*
|
|
165
|
-
* React binding:
|
|
166
|
-
* ```ts
|
|
167
|
-
* const others = useSyncExternalStore(
|
|
168
|
-
* presence.subscribe,
|
|
169
|
-
* () => presence.others,
|
|
170
|
-
* );
|
|
171
|
-
* ```
|
|
172
|
-
*
|
|
173
|
-
* MobX binding:
|
|
174
|
-
* ```ts
|
|
175
|
-
* autorun(() => {
|
|
176
|
-
* // Triggered on every presence change because the observable
|
|
177
|
-
* // version counter inside presence is read here.
|
|
178
|
-
* const peers = presence.others;
|
|
179
|
-
* // ...
|
|
180
|
-
* });
|
|
181
|
-
* ```
|
|
182
|
-
*/
|
|
183
|
-
onChange(listener: () => void): () => void;
|
|
184
|
-
/**
|
|
185
|
-
* An async-iterable view of the peer roster. Each iteration yields the
|
|
186
|
-
* current `others` snapshot whenever it changes, so you can watch the world
|
|
187
|
-
* update without registering a callback.
|
|
188
|
-
*
|
|
189
|
-
* ```ts
|
|
190
|
-
* for await (const peers of participant.presence) {
|
|
191
|
-
* renderAvatars(peers);
|
|
192
|
-
* if (peers.length === 0) break; // iteration stops, subscription drops
|
|
193
|
-
* }
|
|
194
|
-
* ```
|
|
195
|
-
*
|
|
196
|
-
* Each `for await` gets an independent iterator — two loops on the same
|
|
197
|
-
* stream both see every update rather than stealing values from each other.
|
|
198
|
-
* Breaking out of the loop, or throwing, tears the subscription down cleanly.
|
|
199
|
-
*/
|
|
200
|
-
[Symbol.asyncIterator](): AsyncIterableIterator<readonly Peer[]>;
|
|
201
|
-
}
|
|
202
|
-
/**
|
|
203
|
-
* What a participant is currently doing. This type is both the SDK shape and
|
|
204
|
-
* the wire shape: a presence broadcast on the `presence_update` frame carries
|
|
205
|
-
* exactly these fields.
|
|
206
|
-
*
|
|
207
|
-
* Every activity is about one entity in focus. An agent working across several
|
|
208
|
-
* entities calls `presence.update(...)` each time its focus shifts, and other
|
|
209
|
-
* participants see the change in real time.
|
|
210
|
-
*/
|
|
211
|
-
export interface Activity {
|
|
212
|
-
/** Entity type the participant is focused on (e.g. "Section", "Document"). */
|
|
213
|
-
readonly entityType: string;
|
|
214
|
-
/** Specific entity id. */
|
|
215
|
-
readonly entityId: string;
|
|
216
|
-
/** Optional path for file/document-like targets. */
|
|
217
|
-
readonly path?: string;
|
|
218
|
-
/** Optional line/column range for partial-entity coordination. */
|
|
219
|
-
readonly range?: TargetRange;
|
|
220
|
-
/** Optional field/property path for field-level coordination. */
|
|
221
|
-
readonly field?: string;
|
|
222
|
-
/**
|
|
223
|
-
* Several named parts of the row at once — the same member
|
|
224
|
-
* {@link ClaimTarget} carries, and the one the presence frame has always
|
|
225
|
-
* declared. It was missing here, so a set-scoped participant announced
|
|
226
|
-
* itself as holding the whole row and the overlap filter compared it as if
|
|
227
|
-
* it named no parts at all.
|
|
228
|
-
*/
|
|
229
|
-
readonly fields?: readonly string[];
|
|
230
|
-
/** App-defined structured metadata. Display-only unless app policy uses it. */
|
|
231
|
-
readonly meta?: Record<string, unknown>;
|
|
232
|
-
/**
|
|
233
|
-
* What the participant is doing to that entity. Canonical values:
|
|
234
|
-
* `'editing'` / `'reviewing'` / `'generating'` / `'analyzing'` /
|
|
235
|
-
* `'executing'`. Free-form strings are accepted for app-specific
|
|
236
|
-
* phases.
|
|
237
|
-
*/
|
|
238
|
-
readonly action: string;
|
|
239
|
-
/** Human-readable detail — "section 3", "cell A1:B5", etc. */
|
|
240
|
-
readonly detail?: string;
|
|
241
|
-
/**
|
|
242
|
-
* A backpressure signal in the range `[0.0, 1.0]`. When set, orchestrator
|
|
243
|
-
* agents reading peer activity can route work away from busy participants:
|
|
244
|
-
* `0.0` means idle, `1.0` means at capacity, and values in between mean "I
|
|
245
|
-
* have headroom but would rather not." Optional — agents that don't take part
|
|
246
|
-
* in load-aware routing leave it unset, and orchestrators ignore them when
|
|
247
|
-
* balancing load. The server passes it through without interpreting it.
|
|
248
|
-
*/
|
|
249
|
-
readonly loadFactor?: number;
|
|
250
|
-
/**
|
|
251
|
-
* A backpressure gate for new work assignments. It defaults to `true` when
|
|
252
|
-
* unset, so everyone accepts work by default. Set it to `false` during
|
|
253
|
-
* graceful shutdown, at capacity, or while committed to a long step that
|
|
254
|
-
* can't be interrupted. Orchestrators should skip a peer showing `false`, and
|
|
255
|
-
* treat `true` with a high `loadFactor` as available but lower priority.
|
|
256
|
-
*/
|
|
257
|
-
readonly acceptingNewWork?: boolean;
|
|
258
|
-
}
|
|
259
|
-
/**
|
|
260
|
-
* One participant's live state as seen by everyone else in scope — its
|
|
261
|
-
* identity, sync groups, current {@link Activity}, and any open claims.
|
|
262
|
-
*/
|
|
263
|
-
export interface Peer {
|
|
264
|
-
readonly participantKind: ParticipantKind;
|
|
265
|
-
readonly participantId: string;
|
|
266
|
-
readonly label?: string;
|
|
267
|
-
readonly syncGroups: readonly string[];
|
|
268
|
-
readonly activity: Activity;
|
|
269
|
-
/** Server timestamp of the most recent frame from this participant. */
|
|
270
|
-
readonly lastActive: string;
|
|
271
|
-
/** The claims this participant currently holds. */
|
|
272
|
-
readonly activeClaims?: readonly Claim[];
|
|
273
|
-
}
|
|
274
|
-
/**
|
|
275
|
-
* A claim is a broadcast that says "I'm about to work on this entity." Claims
|
|
276
|
-
* travel on the same connection as presence, so every participant sees them in
|
|
277
|
-
* real time. They are cooperative rather than enforced: a claim announces
|
|
278
|
-
* intent, and other agents observe it and yield. This is lighter and more
|
|
279
|
-
* flexible than a central lock table and composes with presence.
|
|
280
|
-
*/
|
|
281
|
-
/**
|
|
282
|
-
* The options shared by every verb-style claim announcement
|
|
283
|
-
* (`claims.analyzing`, `claims.drafting`, and so on). The only required piece
|
|
284
|
-
* is the target; everything else has a sensible default. Prefer the verb
|
|
285
|
-
* methods on {@link ClaimStream} — for example `analyzing(entity, { ttl: '3m' })`
|
|
286
|
-
* — over the raw `announce(...)` call.
|
|
287
|
-
*/
|
|
288
|
-
export interface ClaimLeaseOptions {
|
|
289
|
-
/**
|
|
290
|
-
* How long before the server auto-expires this claim if the participant
|
|
291
|
-
* hasn't finished. Accepts a number of seconds or a duration string such as
|
|
292
|
-
* `'500ms'`, `'30s'`, `'3m'`, or `'24h'`.
|
|
293
|
-
*/
|
|
294
|
-
readonly ttl?: Duration;
|
|
295
|
-
}
|
|
296
|
-
/** The duration value type used by `ttl`, re-exported for convenience. */
|
|
297
|
-
export type Duration = import('../utils/duration.js').Duration;
|
|
298
|
-
export interface ClaimOptions extends ClaimLeaseOptions {
|
|
299
|
-
/**
|
|
300
|
-
* Peer-visible description of the work you're doing — the sentence another
|
|
301
|
-
* participant reads to decide whether to wait, work elsewhere, or move on
|
|
302
|
-
* (`'rewriting the risk section to match Q3'`). Surfaces in conflict
|
|
303
|
-
* messages and the activity overlay, and rides back in the rejection a
|
|
304
|
-
* blocked writer receives. Defaults to `'editing'`.
|
|
305
|
-
*/
|
|
306
|
-
readonly description?: string;
|
|
307
|
-
/**
|
|
308
|
-
* @deprecated Renamed to {@link ClaimOptions.description}. Still accepted —
|
|
309
|
-
* `description` wins when both are given — and removed in 0.36.0.
|
|
310
|
-
*
|
|
311
|
-
* The rename shipped without this line, so the server went on accepting
|
|
312
|
-
* `reason` while the type stopped offering it. Code written against the older
|
|
313
|
-
* shape kept working at runtime and stopped type-checking, with nothing
|
|
314
|
-
* saying why.
|
|
315
|
-
*/
|
|
316
|
-
readonly reason?: string;
|
|
317
|
-
/**
|
|
318
|
-
* On contention, join the server's fair first-in-first-out queue instead of
|
|
319
|
-
* being rejected. The grant then arrives asynchronously — immediately if the
|
|
320
|
-
* target was free, or once you reach the head of the line. To wait for the
|
|
321
|
-
* grant, use `ablo.<model>.claim`, which pairs this flag with the wait.
|
|
322
|
-
*/
|
|
323
|
-
readonly queue?: boolean;
|
|
324
|
-
}
|
|
325
|
-
export interface ClaimStream {
|
|
326
|
-
/**
|
|
327
|
-
* A reactive view of every other participant's active claims. Reading it
|
|
328
|
-
* returns the current snapshot; pair it with `onChange(...)` to be notified
|
|
329
|
-
* when it changes.
|
|
330
|
-
*/
|
|
331
|
-
readonly others: readonly Claim[];
|
|
332
|
-
/**
|
|
333
|
-
* A reactive view of the wait queue on one target — the ordered line of
|
|
334
|
-
* queued claims behind the current holder, each carrying its `description`,
|
|
335
|
-
* `heldBy`, and `position`. Empty when no one is waiting. Pair it with
|
|
336
|
-
* `onChange(...)` for change notifications.
|
|
337
|
-
*/
|
|
338
|
-
queueFor(target: PresenceTarget): readonly Claim[];
|
|
339
|
-
/**
|
|
340
|
-
* Re-rank the wait queue on a target: move the listed waiters to the front in
|
|
341
|
-
* the given order, leaving the rest in their existing relative order behind
|
|
342
|
-
* them. Pass the claims from `queueFor(target)` in the order you want. This
|
|
343
|
-
* is privileged — the server rejects a participant that lacks the
|
|
344
|
-
* `claim.reorder` capability — and fire-and-forget: the new order arrives
|
|
345
|
-
* reactively through `queueFor`.
|
|
346
|
-
*/
|
|
347
|
-
reorder(target: PresenceTarget, order: readonly Claim[]): void;
|
|
348
|
-
/**
|
|
349
|
-
* A framework-agnostic reactivity hook, with the same contract as
|
|
350
|
-
* {@link PresenceStream.onChange}: register a listener that fires on every
|
|
351
|
-
* change — a claim announced, revoked, or expired — and returns a function
|
|
352
|
-
* that unsubscribes. Use `useSyncExternalStore` in React or `autorun` in
|
|
353
|
-
* MobX.
|
|
354
|
-
*/
|
|
355
|
-
onChange(listener: () => void): () => void;
|
|
356
|
-
/**
|
|
357
|
-
* Observe claims the server rejected. Fires when a claim you tried to take is
|
|
358
|
-
* refused because another participant already holds an open claim on the same
|
|
359
|
-
* target.
|
|
360
|
-
*
|
|
361
|
-
* Use it to surface conflicts to the user:
|
|
362
|
-
* ```ts
|
|
363
|
-
* participant.claims.onRejected((r) => {
|
|
364
|
-
* toast.error(`${r.heldBy} is editing — try again in a moment`);
|
|
365
|
-
* });
|
|
366
|
-
* ```
|
|
367
|
-
*
|
|
368
|
-
* Returns a function that unsubscribes.
|
|
369
|
-
*/
|
|
370
|
-
onRejected(listener: (rejection: ClaimRejection) => void): () => void;
|
|
371
|
-
/**
|
|
372
|
-
* Observe losing a claim you held — distinct from `onRejected`, which is a
|
|
373
|
-
* claim the server refused to grant. Fires when the server reports the loss,
|
|
374
|
-
* carrying why: `'preempted'` (a privileged participant evicted you) or
|
|
375
|
-
* `'expired'` (your lease lapsed). This lets a holder react — re-plan or
|
|
376
|
-
* re-claim — rather than discovering the lease gone through presence.
|
|
377
|
-
*
|
|
378
|
-
* ```ts
|
|
379
|
-
* participant.claims.onLost((lost) => {
|
|
380
|
-
* if (lost.reason === 'preempted') replanAgainst(lost.target);
|
|
381
|
-
* else reclaim(lost.target);
|
|
382
|
-
* });
|
|
383
|
-
* ```
|
|
384
|
-
*
|
|
385
|
-
* Returns a function that unsubscribes.
|
|
386
|
-
*/
|
|
387
|
-
onLost(listener: (lost: ClaimLost) => void): () => void;
|
|
388
|
-
/**
|
|
389
|
-
* An async-iterable view of everyone else's open claims. Each iteration
|
|
390
|
-
* yields the current snapshot whenever it changes.
|
|
391
|
-
*
|
|
392
|
-
* ```ts
|
|
393
|
-
* for await (const openClaims of participant.claims) {
|
|
394
|
-
* if (openClaims.some((i) => i.target.id === clauseId)) wait();
|
|
395
|
-
* }
|
|
396
|
-
* ```
|
|
397
|
-
*/
|
|
398
|
-
[Symbol.asyncIterator](): AsyncIterableIterator<readonly Claim[]>;
|
|
399
|
-
}
|
|
400
|
-
/**
|
|
401
|
-
* Every lifecycle state of a claim. `active` is the current holder — the lock
|
|
402
|
-
* itself. `queued` is waiting in line behind the holder and carries a
|
|
403
|
-
* `position`. The remaining states are terminal and drop the claim from the
|
|
404
|
-
* synced set.
|
|
405
|
-
*/
|
|
406
|
-
export type ClaimStatus = PublicClaimStatus;
|
|
407
|
-
/** Options for waiting on a target to become free. */
|
|
408
|
-
export interface ClaimWaitOptions {
|
|
409
|
-
readonly timeout?: number;
|
|
410
|
-
readonly pollInterval?: number;
|
|
411
|
-
readonly signal?: AbortSignal;
|
|
412
|
-
}
|
|
413
|
-
export interface Claim<T = Record<string, unknown>, M = ResolveClaimMeta> {
|
|
414
|
-
readonly object: 'claim';
|
|
415
|
-
/** This claim's id. */
|
|
416
|
-
readonly id: string;
|
|
417
|
-
/**
|
|
418
|
-
* The claim's lifecycle state. `active` is the holder — the lock; `queued` is
|
|
419
|
-
* waiting in line and carries a `position`. It is optional on shapes derived
|
|
420
|
-
* from a presence frame, where a present entry is `active` by construction.
|
|
421
|
-
*/
|
|
422
|
-
readonly status?: ClaimStatus;
|
|
423
|
-
/** What is being coordinated. */
|
|
424
|
-
readonly target: ClaimTarget<M>;
|
|
425
|
-
/**
|
|
426
|
-
* Peer-visible description of the work being done — the same field on every
|
|
427
|
-
* claim surface. Always present: the SDK resolves it as it decodes the frame,
|
|
428
|
-
* defaulting to `'editing'` when a claim carries no description.
|
|
429
|
-
*/
|
|
430
|
-
readonly description: string;
|
|
431
|
-
/** Participant holding it. Absent on a handle you hold for yourself. */
|
|
432
|
-
readonly heldBy?: string;
|
|
433
|
-
/**
|
|
434
|
-
* Whether the holder is a user (session), agent, or system actor — so UIs
|
|
435
|
-
* style "agent editing X" vs "user editing X" without string-parsing
|
|
436
|
-
* `heldBy`. Present on observed claims; absent on your own fresh handle.
|
|
437
|
-
*/
|
|
438
|
-
readonly participantKind?: ParticipantKind;
|
|
439
|
-
/** Epoch-ms the holder opened it. */
|
|
440
|
-
readonly createdAt?: number;
|
|
441
|
-
/** Epoch-ms the server auto-expires it if the holder doesn't finish. */
|
|
442
|
-
readonly expiresAt?: number;
|
|
443
|
-
/**
|
|
444
|
-
* The seconds remaining until auto-expiry — a countdown output as a plain
|
|
445
|
-
* number, distinct from the `ttl: Duration` (such as `'3m'`) you pass in when
|
|
446
|
-
* claiming.
|
|
447
|
-
*/
|
|
448
|
-
readonly ttlSeconds?: number;
|
|
449
|
-
/**
|
|
450
|
-
* 0-based place in the FIFO line — present only when `status: 'queued'`
|
|
451
|
-
* (`0` = next behind the holder). Absent for the active holder.
|
|
452
|
-
*/
|
|
453
|
-
readonly position?: number;
|
|
454
|
-
/**
|
|
455
|
-
* True when the grant arrived only after waiting in the server's queue — the
|
|
456
|
-
* reliable signal that the row may have changed while you waited. Absent for
|
|
457
|
-
* an immediate, uncontended grant.
|
|
458
|
-
*/
|
|
459
|
-
readonly waited?: boolean;
|
|
460
|
-
/**
|
|
461
|
-
* The sync watermark at which `data` was read. A write made under this claim
|
|
462
|
-
* uses it as the `readAt` staleness guard. Present on a claim you hold.
|
|
463
|
-
*/
|
|
464
|
-
readonly readAt?: number;
|
|
465
|
-
/**
|
|
466
|
-
* The monotonic fencing token the server minted for this grant (Option B). A
|
|
467
|
-
* write made under this claim carries it, and the server rejects the write if
|
|
468
|
-
* a later holder already advanced this entity past the token — closing the
|
|
469
|
-
* "my claim lapsed and its successor came and went" lost-update window that
|
|
470
|
-
* `readAt` alone cannot (a blind write with no read basis has nothing to
|
|
471
|
-
* compare). Present on a claim you hold that was granted a token.
|
|
472
|
-
*/
|
|
473
|
-
readonly fenceToken?: number;
|
|
474
|
-
/** Row snapshot under the lease — present on a claim you hold. */
|
|
475
|
-
readonly data?: T;
|
|
476
|
-
/**
|
|
477
|
-
* Release the lease. Present only on a claim you hold (returned by
|
|
478
|
-
* `ablo.<model>.claim`); absent on observed peer claims.
|
|
479
|
-
*/
|
|
480
|
-
release?: () => Promise<void>;
|
|
481
|
-
/** Synchronously abandon the lease. Present only on a claim you hold. */
|
|
482
|
-
revoke?: () => void;
|
|
483
|
-
/**
|
|
484
|
-
* Extend the lease past the liveness window — the "still working" signal
|
|
485
|
-
* for long-running tasks. Resolving means the lease is still yours, now
|
|
486
|
-
* good until the returned `expiresAt`; a lease that lapsed (and may have
|
|
487
|
-
* been granted to the next in line) rejects with an
|
|
488
|
-
* {@link ../errors.js AbloClaimedError} carrying code `claim_lost`, so the
|
|
489
|
-
* failed beat doubles as the loss notification. Each beat's extension is
|
|
490
|
-
* clamped server-side — hold a long task by beating on a cadence (pass
|
|
491
|
-
* `heartbeat` when claiming to have the SDK do this for you), not by
|
|
492
|
-
* asking once for a huge window. Present only on a claim you hold.
|
|
493
|
-
*/
|
|
494
|
-
heartbeat?: (options?: Duration | ClaimHeartbeatOptions) => Promise<ClaimHeartbeat>;
|
|
495
|
-
/** Auto-release on `await using` scope exit. Present only on a held claim. */
|
|
496
|
-
[Symbol.asyncDispose]?(): PromiseLike<void>;
|
|
497
|
-
}
|
|
498
|
-
/** Options for one beat — a bare {@link Duration} is shorthand for `{ ttl }`. */
|
|
499
|
-
export interface ClaimHeartbeatOptions {
|
|
500
|
-
/** Requested extension from now; the server clamps it and never shortens. */
|
|
501
|
-
readonly ttl?: Duration;
|
|
502
|
-
/**
|
|
503
|
-
* Lightweight progress the beat carries along (`{ pages: 42, of: 100 }`) —
|
|
504
|
-
* becomes the claim's peer-visible `meta.progress` (last beat wins) and
|
|
505
|
-
* dies with the lease. Durable checkpoints belong in the data itself:
|
|
506
|
-
* write a row, and every subscriber already sees it.
|
|
507
|
-
*/
|
|
508
|
-
readonly details?: Record<string, unknown>;
|
|
509
|
-
}
|
|
510
|
-
/** The resolved value of a successful {@link Claim.heartbeat} — the lease is
|
|
511
|
-
* still yours, now good until `expiresAt` (epoch milliseconds). */
|
|
512
|
-
export interface ClaimHeartbeat {
|
|
513
|
-
readonly expiresAt: number;
|
|
514
|
-
/**
|
|
515
|
-
* How many participants wait in line behind this lease — cooperative-yield
|
|
516
|
-
* pressure. A worker that can checkpoint may release early when others
|
|
517
|
-
* wait. Absent when the server predates the field.
|
|
518
|
-
*/
|
|
519
|
-
readonly queueDepth?: number;
|
|
520
|
-
}
|
|
521
|
-
/**
|
|
522
|
-
* A claim you hold — the resolved value of `ablo.<model>.claim(...)`. It is a
|
|
523
|
-
* {@link Claim} with the lease-control members (`data`, `release`, `revoke`,
|
|
524
|
-
* and the async-dispose hook) made required; they are optional on the base
|
|
525
|
-
* because that shape also models observed peer claims, which lack them. Making
|
|
526
|
-
* them required is what lets `await using held = await ablo.x.claim(...)`
|
|
527
|
-
* typecheck, since `Claim`'s optional dispose hook is not assignable to
|
|
528
|
-
* `AsyncDisposable`.
|
|
529
|
-
*/
|
|
530
|
-
export type HeldClaim<T = Record<string, unknown>, M = ResolveClaimMeta> = Claim<T, M> & Required<Pick<Claim<T, M>, 'data' | 'release' | 'revoke' | 'heartbeat' | typeof Symbol.asyncDispose>>;
|
|
531
|
-
/**
|
|
532
|
-
* A held advisory lease you took on a key whose row Ablo does not hold — the
|
|
533
|
-
* resolved value of the row-free `ablo.<model>.claim(id)` overload. It is a
|
|
534
|
-
* {@link HeldClaim} minus `.data`: the same lease controls (`release`, `revoke`,
|
|
535
|
-
* `heartbeat`, and the `await using` disposer are all required and behave
|
|
536
|
-
* identically), only without a snapshot, because the row lives solely in the
|
|
537
|
-
* customer's own database and was never replicated into the local pool. Use it
|
|
538
|
-
* to serialize work against a key you know by id alone.
|
|
539
|
-
*/
|
|
540
|
-
export type HeldLease = Omit<HeldClaim, 'data'>;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The types for real-time multiplayer coordination.
|
|
3
|
-
*
|
|
4
|
-
* Ablo treats people and AI agents alike as participants working on live
|
|
5
|
-
* application entities. A participant announces what it is reading or editing,
|
|
6
|
-
* claims an entity before writing to it, and captures a context snapshot before
|
|
7
|
-
* starting long-running AI work. You keep your own schema, agent stack, tools,
|
|
8
|
-
* prompts, and product rules; this package provides the shared coordination
|
|
9
|
-
* layer underneath.
|
|
10
|
-
*/
|
|
11
|
-
export {};
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Turns a callback-based subscription into an async iterable that yields the
|
|
3
|
-
* latest snapshot each time the source changes. You supply two functions:
|
|
4
|
-
* `subscribe(listener)`, which registers your listener and returns a teardown
|
|
5
|
-
* function, and `getSnapshot()`, which reads the current value. On every change
|
|
6
|
-
* notification the iterator calls `getSnapshot()` and hands the result to the
|
|
7
|
-
* consumer's `for await` loop; when the loop ends, the iterator runs the
|
|
8
|
-
* teardown function.
|
|
9
|
-
*
|
|
10
|
-
* Because each notification yields the current snapshot rather than a specific
|
|
11
|
-
* event, bursts coalesce harmlessly — a consumer that falls behind still ends up
|
|
12
|
-
* with the freshest value. The queue is unbounded, so a consumer that never
|
|
13
|
-
* advances lets memory grow without limit. When individual events matter and
|
|
14
|
-
* must not be dropped, use {@link asyncIteratorFromEvents} instead.
|
|
15
|
-
*
|
|
16
|
-
* Each call to the factory creates an independent iterator with its own
|
|
17
|
-
* subscription. Two `for await` loops over the same source each observe every
|
|
18
|
-
* change; they do not take values from one another.
|
|
19
|
-
*/
|
|
20
|
-
/**
|
|
21
|
-
* Turns a callback-based subscription into an async iterable that yields each
|
|
22
|
-
* discrete event, in order, with none dropped. You supply a single
|
|
23
|
-
* `subscribe(push)` function: it registers your producer and returns a teardown
|
|
24
|
-
* function, and your producer calls `push(value)` once per event. The consumer's
|
|
25
|
-
* `for await` loop receives every pushed value.
|
|
26
|
-
*
|
|
27
|
-
* This is the counterpart to {@link asyncIteratorFrom}. Reach for that one when
|
|
28
|
-
* you only need the latest state and coalescing bursts is fine; reach for this
|
|
29
|
-
* one when every event is significant — for example a stream of change deltas
|
|
30
|
-
* where skipping one would lose data. The queue is unbounded, so a consumer that
|
|
31
|
-
* stops advancing lets memory grow without limit.
|
|
32
|
-
*/
|
|
33
|
-
export declare function asyncIteratorFromEvents<T>(subscribe: (push: (value: T) => void) => () => void): AsyncIterableIterator<T>;
|
|
34
|
-
export declare function asyncIteratorFrom<T>(subscribe: (listener: () => void) => () => void, getSnapshot: () => T): AsyncIterableIterator<T>;
|