@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,230 +0,0 @@
|
|
|
1
|
-
import { type ReactNode } from 'react';
|
|
2
|
-
import type { SchemaRecord } from '../transaction/schema/schema.js';
|
|
3
|
-
import { Ablo } from '../client/Ablo.js';
|
|
4
|
-
import type { Claim, Peer } from '../transaction/types/streams.js';
|
|
5
|
-
import type { EngineParticipant, ParticipantScope, ParticipantStatus } from '../sync/participants.js';
|
|
6
|
-
import { type SyncStoreContract } from './context.js';
|
|
7
|
-
/**
|
|
8
|
-
* Ablo umbrella provider — owns the sync engine, multiplayer, and
|
|
9
|
-
* the full lifecycle (Strict-Mode-safe singleton, `beforeunload`,
|
|
10
|
-
* session-expiry handling, post-bootstrap hooks).
|
|
11
|
-
*
|
|
12
|
-
* Design goals (borrowed from Liveblocks' `LiveblocksProvider` and
|
|
13
|
-
* Zero's `ZeroProvider`):
|
|
14
|
-
*
|
|
15
|
-
* - **One component, one import.** Consumers write the provider
|
|
16
|
-
* once at the root; nothing else needs to plumb the engine.
|
|
17
|
-
* - **Multiplayer is default.** React consumers are always browsers doing
|
|
18
|
-
* multiplayer UI, so `useJoin()` / `useAblo()` are always
|
|
19
|
-
* available. No opt-in prop.
|
|
20
|
-
* - **Declarative props for app glue.** `preventUnsavedChanges`,
|
|
21
|
-
* `onSessionExpired`, `postBootstrap`, `resolveUsers` — each
|
|
22
|
-
* absorbs a class of integration code that previously lived in
|
|
23
|
-
* userland.
|
|
24
|
-
* - **Singleton safety.** The engine lives in a ref and rotates
|
|
25
|
-
* only when `userId` / account scope / `url` change. React
|
|
26
|
-
* Strict Mode double-mount does not leak a second WebSocket.
|
|
27
|
-
*/
|
|
28
|
-
/**
|
|
29
|
-
* Props for `<AbloProvider>`.
|
|
30
|
-
*
|
|
31
|
-
* The one required prop is a prebuilt {@link Ablo} client — the client
|
|
32
|
-
* owns auth and the credential lifecycle; this provider is the reactive
|
|
33
|
-
* binding over it (Stripe's `<Elements stripe={...}>` model):
|
|
34
|
-
*
|
|
35
|
-
* ```tsx
|
|
36
|
-
* // Build once at module scope — a new instance per render tears down the socket.
|
|
37
|
-
* // The endpoint string points at your session-mint route (`ablo init`
|
|
38
|
-
* // scaffolds it); the SDK fetches it and keeps the token fresh.
|
|
39
|
-
* const ablo = Ablo({ schema, authEndpoint: '/api/ablo-session' });
|
|
40
|
-
*
|
|
41
|
-
* <AbloProvider client={ablo}>
|
|
42
|
-
* <App />
|
|
43
|
-
* </AbloProvider>
|
|
44
|
-
* ```
|
|
45
|
-
*
|
|
46
|
-
* That's it for most apps. `userId` is informational; the `fallback`,
|
|
47
|
-
* `preventUnsavedChanges`, and `on*` props are opt-in app glue; and the
|
|
48
|
-
* block tagged "Optional DI (advanced)" below is escape-hatch wiring for
|
|
49
|
-
* tests and platform builders — if you don't recognize a prop there, you
|
|
50
|
-
* don't need it.
|
|
51
|
-
*/
|
|
52
|
-
export interface AbloProviderProps<R extends SchemaRecord = SchemaRecord> {
|
|
53
|
-
/**
|
|
54
|
-
* A prebuilt {@link Ablo} client — **the only way to configure the engine.**
|
|
55
|
-
* Construct it yourself with `Ablo({ schema, apiKey, ... })` and pass the
|
|
56
|
-
* instance: the CLIENT owns auth, the credential lifecycle, transport, and
|
|
57
|
-
* connection; this provider is the thin REACTIVE binding over it (context,
|
|
58
|
-
* the bootstrap gate, error/session forwarding). Mirrors Stripe
|
|
59
|
-
* `<Elements stripe={...}>` and a Supabase client passed into a context.
|
|
60
|
-
*
|
|
61
|
-
* Memoize it (build it once, e.g. with `useMemo` or module scope) — a new
|
|
62
|
-
* instance each render re-keys the bootstrap gate and tears down the socket.
|
|
63
|
-
*/
|
|
64
|
-
client: Ablo<R>;
|
|
65
|
-
/**
|
|
66
|
-
* The app user id, surfaced via `useCurrentUserId()` for app-owned fields.
|
|
67
|
-
* Purely informational for the React tree — sync identity is resolved by the
|
|
68
|
-
* client from its auth, not from this. Optional.
|
|
69
|
-
*/
|
|
70
|
-
userId?: string;
|
|
71
|
-
/**
|
|
72
|
-
* Block tab close while there are unsynced local writes (the standard
|
|
73
|
-
* `beforeunload` prompt). Browsers ignore custom messages — don't pass one.
|
|
74
|
-
*/
|
|
75
|
-
preventUnsavedChanges?: boolean;
|
|
76
|
-
/**
|
|
77
|
-
* Fired when the server rejects the session. The provider has ALREADY called
|
|
78
|
-
* `client.purge()` (disposed + wiped IndexedDB) by the time this runs — use it
|
|
79
|
-
* for app side effects (redirect to sign-in, clear analytics identity).
|
|
80
|
-
*/
|
|
81
|
-
onSessionExpired?: () => void | Promise<void>;
|
|
82
|
-
/**
|
|
83
|
-
* Fired on any error the provider surfaces (engine/WebSocket/bootstrap). For
|
|
84
|
-
* Sentry/Datadog. React-only consumers can use `useErrorListener()` instead.
|
|
85
|
-
*/
|
|
86
|
-
onError?: (error: Error) => void;
|
|
87
|
-
/**
|
|
88
|
-
* Rendered in place of `children` during the *first* bootstrap pass —
|
|
89
|
-
* while the engine is actively transitioning from `initial` →
|
|
90
|
-
* `connected` and has never successfully connected before. Once the
|
|
91
|
-
* engine reaches `connected` the gate latches open for the lifetime
|
|
92
|
-
* of this provider instance; transient `reconnecting` / `needs-auth`
|
|
93
|
-
* states do NOT re-show the fallback (the app's own UI handles those
|
|
94
|
-
* by then).
|
|
95
|
-
*
|
|
96
|
-
* Defaults to `<DefaultFallback />` — a neutral theme-adaptive
|
|
97
|
-
* spinner that uses `currentColor`, ships with zero design-system
|
|
98
|
-
* dependencies, and self-centers in a full-parent container. Pass
|
|
99
|
-
* your own `<Skeleton />` for a branded loading UX. Pass `null` to
|
|
100
|
-
* render nothing during bootstrap. Pass the string literal
|
|
101
|
-
* `"passthrough"` to opt out of the gate entirely — children render
|
|
102
|
-
* immediately and consumers are responsible for their own gating
|
|
103
|
-
* (`<ClientSideSuspense>` or manual `useSyncStatus()` checks).
|
|
104
|
-
* Useful for pages that mount debug helpers, error boundaries, or
|
|
105
|
-
* analytics that must run pre-ready.
|
|
106
|
-
*/
|
|
107
|
-
fallback?: ReactNode | 'passthrough';
|
|
108
|
-
children: ReactNode;
|
|
109
|
-
}
|
|
110
|
-
export declare function AbloProvider<R extends SchemaRecord = SchemaRecord>(props: AbloProviderProps<R>): React.ReactElement;
|
|
111
|
-
export type { EngineParticipant, ParticipantScope, ParticipantStatus };
|
|
112
|
-
/**
|
|
113
|
-
* Options for `useJoin`. The hook reuses the engine's single
|
|
114
|
-
* WebSocket and opens a scoped claim on it when `scope` is provided:
|
|
115
|
-
* one TCP connection, N logical sub-syncgroup participants.
|
|
116
|
-
*/
|
|
117
|
-
export interface UseJoinOptions {
|
|
118
|
-
readonly scope?: ParticipantScope;
|
|
119
|
-
readonly ttlSeconds?: number | string | null;
|
|
120
|
-
/** Tear down + don't re-join while true. */
|
|
121
|
-
readonly paused?: boolean;
|
|
122
|
-
/**
|
|
123
|
-
* Acquire a write-claim CLAIM on the scope, in addition to read interest.
|
|
124
|
-
*
|
|
125
|
-
* Default `false`: opening a scope subscribes the connection to its deltas
|
|
126
|
-
* (read interest, via `update_subscription`) but does NOT claim it — a
|
|
127
|
-
* viewer is not a claimant. Set `true` when the participant intends to
|
|
128
|
-
* WRITE (editing a report, an agent staking work): the claim is sent so peers
|
|
129
|
-
* observe it, and the scope is pinned so it stays subscribed (never warms)
|
|
130
|
-
* for as long as the claim is held.
|
|
131
|
-
*/
|
|
132
|
-
readonly claim?: boolean;
|
|
133
|
-
/**
|
|
134
|
-
* Backfill the scope's CURRENT state into the pool on enter, in addition to
|
|
135
|
-
* tailing live changes.
|
|
136
|
-
*
|
|
137
|
-
* Default `false`: entering a scope subscribes to its FUTURE deltas only — if
|
|
138
|
-
* the scope's rows aren't already loaded, the view is empty until something
|
|
139
|
-
* changes. Set `true` when opening an entity that may not be loaded yet (a
|
|
140
|
-
* deep-linked report, a never-opened ledger) so its current rows are fetched and
|
|
141
|
-
* injected once, then kept fresh by the live tail. The fetch is single-flight
|
|
142
|
-
* and runs once per group; a failure soft-fails (the live tail still flows).
|
|
143
|
-
*/
|
|
144
|
-
readonly hydrate?: boolean;
|
|
145
|
-
}
|
|
146
|
-
export interface UseJoinReturn {
|
|
147
|
-
readonly participant: EngineParticipant | null;
|
|
148
|
-
/** Everyone else on the engine's sync groups (`participant.presence.others`), bridged to React. */
|
|
149
|
-
readonly peers: readonly Peer[];
|
|
150
|
-
/** Active claim claims by peers (`participant.claims.others`), bridged to React. */
|
|
151
|
-
readonly claims: readonly Claim[];
|
|
152
|
-
readonly status: ParticipantStatus;
|
|
153
|
-
readonly error: Error | null;
|
|
154
|
-
}
|
|
155
|
-
/**
|
|
156
|
-
* Join multiplayer for a given scope. Returns the participant and its
|
|
157
|
-
* lifecycle status. Auto-cleans up on unmount or when `paused`
|
|
158
|
-
* flips to true.
|
|
159
|
-
*
|
|
160
|
-
* `useJoin` is the React form of `ablo.<model>.join` — scope-level
|
|
161
|
-
* read-interest + presence; returns the reactive participant facade
|
|
162
|
-
* (peers/claims/status).
|
|
163
|
-
*
|
|
164
|
-
* The returned `participant` is an `EngineParticipant` — `.presence`
|
|
165
|
-
* + `.claims` only — backed by the engine's existing socket. For
|
|
166
|
-
* headless-bot patterns (a separate identity in the same browser
|
|
167
|
-
* tab), construct a second `Ablo({ kind: 'agent', ... })` directly.
|
|
168
|
-
*/
|
|
169
|
-
export declare function useJoin(opts: UseJoinOptions): UseJoinReturn;
|
|
170
|
-
/**
|
|
171
|
-
* Read-only presence: the OTHER participants currently visible to this
|
|
172
|
-
* connection, bridged to React. Unlike {@link useJoin}, this does
|
|
173
|
-
* NOT enter/leave a scope (no `update_subscription`, no warm-TTL churn) —
|
|
174
|
-
* it is a pure reader of the engine's already-flowing presence stream.
|
|
175
|
-
*
|
|
176
|
-
* Pass `scope` to narrow to the peers on that scope's sync group(s); omit
|
|
177
|
-
* it to get everyone on the engine's groups. Membership is driven entirely
|
|
178
|
-
* by the presence channel (set server-side on connect, independent of any
|
|
179
|
-
* cursor/collaboration traffic), so reading it never affects what the
|
|
180
|
-
* connection is subscribed to and can't deadlock against a gated channel.
|
|
181
|
-
*
|
|
182
|
-
* Use this to answer "is anyone else here?" — e.g. suppressing live-cursor
|
|
183
|
-
* broadcasts while alone — when some OTHER mount already owns the scope's
|
|
184
|
-
* read interest (scope `leave` is not reference-counted, so a second
|
|
185
|
-
* `useJoin` on the same scope would warm-drop the owner's
|
|
186
|
-
* subscription on unmount).
|
|
187
|
-
*
|
|
188
|
-
* ```ts
|
|
189
|
-
* const peers = usePeers({ reports: reportId });
|
|
190
|
-
* const alone = !peers.some((p) => p.participantKind === 'user');
|
|
191
|
-
* ```
|
|
192
|
-
*/
|
|
193
|
-
export declare function usePeers(scope?: ParticipantScope): readonly Peer[];
|
|
194
|
-
/**
|
|
195
|
-
* Returns the raw `SyncEngine` proxy. Typically you want the typed
|
|
196
|
-
* hooks (`useQuery`, `useOne`, `useMutate`) — this is for rare cases
|
|
197
|
-
* where you need direct access (e.g., `sync.tasks.onChange(cb)`).
|
|
198
|
-
*
|
|
199
|
-
* The generic parameter narrows the return type to your schema's
|
|
200
|
-
* model record so call sites get typed `sync.tasks.findMany()` /
|
|
201
|
-
* `sync.sections.create(...)` without a cast at the call site:
|
|
202
|
-
*
|
|
203
|
-
* ```ts
|
|
204
|
-
* const sync = useSync<(typeof schema)['models']>();
|
|
205
|
-
* ```
|
|
206
|
-
*
|
|
207
|
-
* The runtime value is the exact engine the provider constructed;
|
|
208
|
-
* the generic just widens the compile-time type.
|
|
209
|
-
*/
|
|
210
|
-
export declare function useSync<R extends SchemaRecord = SchemaRecord>(): Ablo<R>;
|
|
211
|
-
/**
|
|
212
|
-
* Returns the underlying `SyncStoreContract` (the BaseSyncedStore).
|
|
213
|
-
* Most consumers should prefer the typed hooks (`useQuery` etc.); this
|
|
214
|
-
* is for advanced cases like direct InstanceCache access or custom
|
|
215
|
-
* reactive bridges. Throws if the provider hasn't mounted the store
|
|
216
|
-
* yet — wrap consumers in `<ClientSideSuspense>` to gate correctly.
|
|
217
|
-
*
|
|
218
|
-
* The generic parameter lets consumers widen the return type to a
|
|
219
|
-
* concrete `BaseSyncedStore<...>` subclass if they track one:
|
|
220
|
-
*
|
|
221
|
-
* ```ts
|
|
222
|
-
* type AppStore = BaseSyncedStore<AppEvents, typeof schema>;
|
|
223
|
-
* const store = useSyncStore<AppStore>(); // no cast needed at call site
|
|
224
|
-
* ```
|
|
225
|
-
*
|
|
226
|
-
* The runtime value is always the concrete store the SDK constructed,
|
|
227
|
-
* so widening the type is safe. The bounded generic (`T extends
|
|
228
|
-
* SyncStoreContract`) keeps the widening honest.
|
|
229
|
-
*/
|
|
230
|
-
export declare function useSyncStore<T extends SyncStoreContract = SyncStoreContract>(): T;
|
|
@@ -1,455 +0,0 @@
|
|
|
1
|
-
'use client';
|
|
2
|
-
import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
|
|
3
|
-
import { useCallback, useContext, useEffect, useMemo, useRef, useState, createContext, } from 'react';
|
|
4
|
-
import { Ablo } from '../client/Ablo.js';
|
|
5
|
-
import { createParticipantClaimId, parseParticipantTtlSeconds, resolveParticipantSyncGroups, } from '../sync/participants.js';
|
|
6
|
-
import { SyncContext } from './context.js';
|
|
7
|
-
import { AbloInternalContext } from './internalContext.js';
|
|
8
|
-
import { AbloValidationError } from '../transaction/errors.js';
|
|
9
|
-
import { useSyncStatus } from './useSyncStatus.js';
|
|
10
|
-
import { DefaultFallback } from './DefaultFallback.js';
|
|
11
|
-
// ── Implementation ───────────────────────────────────────────────────
|
|
12
|
-
/**
|
|
13
|
-
* Lightweight event emitter for provider-level errors. Lives on the
|
|
14
|
-
* provider instance (ref-based) so `useErrorListener` subscriptions
|
|
15
|
-
* survive re-renders without thrashing.
|
|
16
|
-
*/
|
|
17
|
-
function createErrorEmitter() {
|
|
18
|
-
const listeners = new Set();
|
|
19
|
-
return {
|
|
20
|
-
subscribe(fn) {
|
|
21
|
-
listeners.add(fn);
|
|
22
|
-
return () => { listeners.delete(fn); };
|
|
23
|
-
},
|
|
24
|
-
emit(err) {
|
|
25
|
-
for (const fn of listeners) {
|
|
26
|
-
try {
|
|
27
|
-
fn(err);
|
|
28
|
-
}
|
|
29
|
-
catch { }
|
|
30
|
-
}
|
|
31
|
-
},
|
|
32
|
-
};
|
|
33
|
-
}
|
|
34
|
-
export function AbloProvider(props) {
|
|
35
|
-
const { client, userId, preventUnsavedChanges, onSessionExpired, onError, fallback = _jsx(DefaultFallback, {}), children, } = props;
|
|
36
|
-
// The client IS the engine — synchronous, never null. This provider is a
|
|
37
|
-
// REACTIVE binding over it (context + bootstrap gate + error/session
|
|
38
|
-
// forwarding); it does NOT construct, configure, or own the connection. The
|
|
39
|
-
// client owns auth, the credential lifecycle (first mint, refresh, and
|
|
40
|
-
// wake/online/focus re-mint — see `Ablo({ apiKey })`), transport, and
|
|
41
|
-
// `dispose()`. The CONSUMER built the client, so the consumer owns teardown;
|
|
42
|
-
// the provider never disposes it.
|
|
43
|
-
const engine = client;
|
|
44
|
-
const schema = engine.schema;
|
|
45
|
-
// Account scope isn't a prop — read it from `_store.orgId` once `ready()`
|
|
46
|
-
// resolves the identity from the client's auth.
|
|
47
|
-
const [resolvedAccountScope, setResolvedAccountScope] = useState(null);
|
|
48
|
-
// ── Error emitter (provider-instance scoped) ─────────────────────
|
|
49
|
-
const errorEmitterRef = useRef(null);
|
|
50
|
-
if (!errorEmitterRef.current) {
|
|
51
|
-
errorEmitterRef.current = createErrorEmitter();
|
|
52
|
-
}
|
|
53
|
-
const errorEmitter = errorEmitterRef.current;
|
|
54
|
-
// Stash callbacks in refs so a new identity each render doesn't re-run the
|
|
55
|
-
// start effect (the `useEventCallback` idiom).
|
|
56
|
-
const onErrorRef = useRef(onError);
|
|
57
|
-
onErrorRef.current = onError;
|
|
58
|
-
useEffect(() => {
|
|
59
|
-
return errorEmitter.subscribe((err) => onErrorRef.current?.(err));
|
|
60
|
-
}, [errorEmitter]);
|
|
61
|
-
const onSessionExpiredRef = useRef(onSessionExpired);
|
|
62
|
-
onSessionExpiredRef.current = onSessionExpired;
|
|
63
|
-
// Re-key the bootstrap gate when the client INSTANCE changes — a genuinely new
|
|
64
|
-
// engine is a fresh "first bootstrap". Stable for the common single-client app.
|
|
65
|
-
const clientGenRef = useRef({ client, gen: 0 });
|
|
66
|
-
if (clientGenRef.current.client !== client) {
|
|
67
|
-
clientGenRef.current = { client, gen: clientGenRef.current.gen + 1 };
|
|
68
|
-
}
|
|
69
|
-
const engineKey = String(clientGenRef.current.gen);
|
|
70
|
-
// ── Start + session-error wiring ─────────────────────────────────
|
|
71
|
-
//
|
|
72
|
-
// Two reactive jobs only:
|
|
73
|
-
// 1. Forward a SERVER session-rejection → purge (wipe IndexedDB so the next
|
|
74
|
-
// login starts clean) → onSessionExpired (the app redirects). The
|
|
75
|
-
// offline/transient-vs-terminal credential logic lives in the CLIENT now.
|
|
76
|
-
// 2. Drive `ready()` (idempotent) so bootstrap starts on mount, then read the
|
|
77
|
-
// resolved org scope for SyncContext.
|
|
78
|
-
// It does NOT dispose the client (consumer-owned) and does NOT touch auth.
|
|
79
|
-
useEffect(() => {
|
|
80
|
-
let stale = false;
|
|
81
|
-
const unsubscribeSession = engine.onSessionError((err) => {
|
|
82
|
-
errorEmitter.emit(err);
|
|
83
|
-
void (async () => {
|
|
84
|
-
try {
|
|
85
|
-
await engine.purge();
|
|
86
|
-
}
|
|
87
|
-
catch { }
|
|
88
|
-
try {
|
|
89
|
-
await onSessionExpiredRef.current?.();
|
|
90
|
-
}
|
|
91
|
-
catch (hookErr) {
|
|
92
|
-
errorEmitter.emit(hookErr);
|
|
93
|
-
}
|
|
94
|
-
})().catch(() => {
|
|
95
|
-
// Only a throwing errorEmitter subscriber can land here — it was
|
|
96
|
-
// already the error-reporting path, so swallow rather than surface
|
|
97
|
-
// an unhandled rejection loop.
|
|
98
|
-
});
|
|
99
|
-
});
|
|
100
|
-
engine
|
|
101
|
-
.ready()
|
|
102
|
-
.then(() => {
|
|
103
|
-
if (stale)
|
|
104
|
-
return;
|
|
105
|
-
setResolvedAccountScope(engine._store.orgId ?? null);
|
|
106
|
-
})
|
|
107
|
-
.catch((err) => {
|
|
108
|
-
if (stale)
|
|
109
|
-
return;
|
|
110
|
-
errorEmitter.emit(err);
|
|
111
|
-
});
|
|
112
|
-
return () => {
|
|
113
|
-
stale = true;
|
|
114
|
-
unsubscribeSession();
|
|
115
|
-
};
|
|
116
|
-
}, [engine, errorEmitter]);
|
|
117
|
-
// ── beforeunload + preventUnsavedChanges ─────────────────────────
|
|
118
|
-
useEffect(() => {
|
|
119
|
-
if (typeof window === 'undefined')
|
|
120
|
-
return;
|
|
121
|
-
const handler = (event) => {
|
|
122
|
-
// Best-effort IDB flush on TAB CLOSE — the client is going away with the
|
|
123
|
-
// page regardless. This is NOT an unmount teardown: the consumer owns the
|
|
124
|
-
// client's lifecycle and the provider never disposes it on unmount.
|
|
125
|
-
void engine.dispose();
|
|
126
|
-
if (preventUnsavedChanges && engine._store.hasUnsyncedChanges) {
|
|
127
|
-
event.preventDefault();
|
|
128
|
-
event.returnValue = '';
|
|
129
|
-
}
|
|
130
|
-
};
|
|
131
|
-
window.addEventListener('beforeunload', handler);
|
|
132
|
-
return () => { window.removeEventListener('beforeunload', handler); };
|
|
133
|
-
}, [engine, preventUnsavedChanges]);
|
|
134
|
-
// ── SyncContext value (for useQuery/useOne/useMutate hooks) ──────
|
|
135
|
-
//
|
|
136
|
-
// The engine is always present (it's the `client` prop), but its org scope is
|
|
137
|
-
// unknown until `ready()` resolves identity — so `syncValue` is null until
|
|
138
|
-
// then, which drives the initial fallback below.
|
|
139
|
-
const syncValue = useMemo(() => {
|
|
140
|
-
const currentAccountScope = resolvedAccountScope ??
|
|
141
|
-
engine._store.orgId;
|
|
142
|
-
if (!currentAccountScope)
|
|
143
|
-
return null;
|
|
144
|
-
return {
|
|
145
|
-
store: engine._store,
|
|
146
|
-
organizationId: currentAccountScope,
|
|
147
|
-
schema,
|
|
148
|
-
};
|
|
149
|
-
}, [engine, resolvedAccountScope, schema]);
|
|
150
|
-
// ── Internal context (currentUserId + error subscription) ────────
|
|
151
|
-
const internalValue = useMemo(() => ({
|
|
152
|
-
currentUserId: userId ?? null,
|
|
153
|
-
subscribeError: errorEmitter.subscribe,
|
|
154
|
-
emitError: errorEmitter.emit,
|
|
155
|
-
engine: engine,
|
|
156
|
-
}), [userId, errorEmitter, engine]);
|
|
157
|
-
// ── Render ───────────────────────────────────────────────────────
|
|
158
|
-
//
|
|
159
|
-
// Two-phase gate (see `BootstrapGate` below for the latch logic):
|
|
160
|
-
//
|
|
161
|
-
// 1. Engine is null on first render (constructed in the effect
|
|
162
|
-
// above, not in render). We render `fallback` directly — there
|
|
163
|
-
// is no SyncContext to read status from, and by definition the
|
|
164
|
-
// engine hasn't started bootstrapping.
|
|
165
|
-
// 2. Engine exists. Mount SyncContext. `BootstrapGate` then reads
|
|
166
|
-
// `useSyncStatus()` and shows `fallback` only during the very
|
|
167
|
-
// first `connecting` transition; children render on every
|
|
168
|
-
// subsequent state change, including reconnects and auth
|
|
169
|
-
// failures (the app's own UI handles those).
|
|
170
|
-
//
|
|
171
|
-
// `fallback === 'passthrough'` short-circuits both branches — children
|
|
172
|
-
// render immediately without any gate, restoring pre-gate behavior
|
|
173
|
-
// for consumers who need debug helpers / error boundaries / analytics
|
|
174
|
-
// to mount before the engine is ready.
|
|
175
|
-
const passthrough = fallback === 'passthrough';
|
|
176
|
-
const initialFallback = passthrough ? children : fallback;
|
|
177
|
-
if (!syncValue) {
|
|
178
|
-
return (_jsx(AbloInternalContext.Provider, { value: internalValue, children: initialFallback }));
|
|
179
|
-
}
|
|
180
|
-
return (_jsx(AbloInternalContext.Provider, { value: internalValue, children: _jsx(SyncContext.Provider, { value: syncValue, children: passthrough ? (children) : (_jsx(BootstrapGate, { fallback: fallback, children: children }, engineKey)) }) }));
|
|
181
|
-
}
|
|
182
|
-
/**
|
|
183
|
-
* Internal gate that renders `fallback` only during the very first
|
|
184
|
-
* bootstrap pass. Latches open on the first `connected` / `reconnecting`
|
|
185
|
-
* / `disconnected` transition and stays open — subsequent transient
|
|
186
|
-
* `connecting` states (hard reconnect after an offline stretch) do NOT
|
|
187
|
-
* re-show the fallback, because by then the app has already rendered
|
|
188
|
-
* once and its own reconnect UI should take over.
|
|
189
|
-
*
|
|
190
|
-
* Re-keyed on `engineState.key` in the parent so engine rotations
|
|
191
|
-
* (userId/org/url change) reset the latch — a new engine genuinely IS
|
|
192
|
-
* a new "first bootstrap" cycle.
|
|
193
|
-
*/
|
|
194
|
-
function BootstrapGate({ fallback, children, }) {
|
|
195
|
-
const status = useSyncStatus();
|
|
196
|
-
const [everConnected, setEverConnected] = useState(false);
|
|
197
|
-
useEffect(() => {
|
|
198
|
-
if (status.name === 'connected' ||
|
|
199
|
-
status.name === 'reconnecting' ||
|
|
200
|
-
status.name === 'disconnected') {
|
|
201
|
-
setEverConnected(true);
|
|
202
|
-
}
|
|
203
|
-
}, [status.name]);
|
|
204
|
-
const showFallback = !everConnected && status.name === 'connecting';
|
|
205
|
-
return _jsx(_Fragment, { children: showFallback ? fallback : children });
|
|
206
|
-
}
|
|
207
|
-
const EMPTY_PRESENCE = Object.freeze([]);
|
|
208
|
-
const EMPTY_INTENTS = Object.freeze([]);
|
|
209
|
-
/**
|
|
210
|
-
* Join multiplayer for a given scope. Returns the participant and its
|
|
211
|
-
* lifecycle status. Auto-cleans up on unmount or when `paused`
|
|
212
|
-
* flips to true.
|
|
213
|
-
*
|
|
214
|
-
* `useJoin` is the React form of `ablo.<model>.join` — scope-level
|
|
215
|
-
* read-interest + presence; returns the reactive participant facade
|
|
216
|
-
* (peers/claims/status).
|
|
217
|
-
*
|
|
218
|
-
* The returned `participant` is an `EngineParticipant` — `.presence`
|
|
219
|
-
* + `.claims` only — backed by the engine's existing socket. For
|
|
220
|
-
* headless-bot patterns (a separate identity in the same browser
|
|
221
|
-
* tab), construct a second `Ablo({ kind: 'agent', ... })` directly.
|
|
222
|
-
*/
|
|
223
|
-
export function useJoin(opts) {
|
|
224
|
-
const ctx = useContext(AbloInternalContext);
|
|
225
|
-
const engine = ctx?.engine ?? null;
|
|
226
|
-
const { paused = false } = opts;
|
|
227
|
-
// Resolve the model-form scope ({ reports: id } / refs) THROUGH the schema, so a
|
|
228
|
-
// model's declared `scope` kind is honored (typename `Report` → `report:<id>`,
|
|
229
|
-
// not the `type:id` string fallback). Schema appears once the engine is ready;
|
|
230
|
-
// until then refs resolve by convention, then re-resolve when it arrives.
|
|
231
|
-
const scopeKey = JSON.stringify(resolveParticipantSyncGroups(opts.scope, engine?.schema).sort());
|
|
232
|
-
const scopedSyncGroups = useMemo(() => JSON.parse(scopeKey), [scopeKey]);
|
|
233
|
-
const [claimError, setClaimError] = useState(null);
|
|
234
|
-
const [claimConnected, setClaimConnected] = useState(false);
|
|
235
|
-
// Reference-stable participant facade — same socket as entity sync,
|
|
236
|
-
// so there is no `connect()` / `disconnect()` lifecycle here. The
|
|
237
|
-
// engine manages the connection; the hook is a thin window onto its
|
|
238
|
-
// already-attached presence + claim streams.
|
|
239
|
-
const participant = useMemo(() => {
|
|
240
|
-
if (!engine)
|
|
241
|
-
return null;
|
|
242
|
-
return { presence: engine.presence, claims: engine.claims };
|
|
243
|
-
}, [engine]);
|
|
244
|
-
// Status maps to the engine's sync state. `connecting` while the
|
|
245
|
-
// engine bootstraps; `connected` once `engine.ready()` resolves and
|
|
246
|
-
// any scoped participant claim has acked; `error` if the claim
|
|
247
|
-
// fails; `disconnected` while paused or before the engine exists.
|
|
248
|
-
const syncStatus = useSyncStatus();
|
|
249
|
-
// Only a write-claim participant waits on a claim ack. A pure reader
|
|
250
|
-
// (the default) is `connected` as soon as the engine is — its read
|
|
251
|
-
// interest is fire-and-forget `update_subscription`, not a claim.
|
|
252
|
-
const needsClaim = !!opts.claim && scopedSyncGroups.length > 0;
|
|
253
|
-
const status = paused || !engine
|
|
254
|
-
? 'disconnected'
|
|
255
|
-
: claimError
|
|
256
|
-
? 'error'
|
|
257
|
-
: syncStatus.name === 'connected'
|
|
258
|
-
? needsClaim && !claimConnected
|
|
259
|
-
? 'connecting'
|
|
260
|
-
: 'connected'
|
|
261
|
-
: syncStatus.name === 'disconnected' || syncStatus.name === 'needs-auth'
|
|
262
|
-
? 'disconnected'
|
|
263
|
-
: 'connecting';
|
|
264
|
-
const error = claimError;
|
|
265
|
-
// ── Read interest (always) ───────────────────────────────────────
|
|
266
|
-
// Subscribe the connection to the scope's sync groups while mounted +
|
|
267
|
-
// connected — the area-of-interest navigation primitive. No claim, no
|
|
268
|
-
// TTL: a viewer just receives the scope's deltas. Hysteresis (warm TTL)
|
|
269
|
-
// lives in the store's SubscriptionManager, so a quick unmount/remount
|
|
270
|
-
// (tab flip) doesn't re-bootstrap.
|
|
271
|
-
useEffect(() => {
|
|
272
|
-
const scope = opts.scope;
|
|
273
|
-
if (paused || !engine || !scope || scopedSyncGroups.length === 0)
|
|
274
|
-
return;
|
|
275
|
-
if (syncStatus.name !== 'connected')
|
|
276
|
-
return;
|
|
277
|
-
const store = engine._store;
|
|
278
|
-
// `hydrate` backfills the scope's current state after subscribing
|
|
279
|
-
// (store handles subscribe-first ordering + single-flight). leaveScope
|
|
280
|
-
// only moves read interest; the hydrated rows stay in the pool.
|
|
281
|
-
void store.enterScope?.(scope, { hydrate: opts.hydrate });
|
|
282
|
-
return () => {
|
|
283
|
-
void store.leaveScope?.(scope);
|
|
284
|
-
};
|
|
285
|
-
// scopeKey is the stable proxy for the resolved groups; same idiom as
|
|
286
|
-
// the claim effect below.
|
|
287
|
-
}, [engine, paused, scopeKey, syncStatus.name, opts.hydrate]);
|
|
288
|
-
// ── Write claim (opt-in: `claim: true`) ─────────────────────────
|
|
289
|
-
// A claim is the write-claim primitive — distinct from read interest
|
|
290
|
-
// above. Only sent when the caller opts in; it makes peers observe the
|
|
291
|
-
// claim and pins the scope so it never warms while held.
|
|
292
|
-
useEffect(() => {
|
|
293
|
-
setClaimError(null);
|
|
294
|
-
setClaimConnected(false);
|
|
295
|
-
const scope = opts.scope;
|
|
296
|
-
if (paused || !engine || !opts.claim || !scope || scopedSyncGroups.length === 0)
|
|
297
|
-
return;
|
|
298
|
-
if (syncStatus.name !== 'connected')
|
|
299
|
-
return;
|
|
300
|
-
const ws = engine._ws;
|
|
301
|
-
const store = engine._store;
|
|
302
|
-
let cancelled = false;
|
|
303
|
-
const claimId = createParticipantClaimId();
|
|
304
|
-
ws.sendClaim(claimId, scopedSyncGroups, {
|
|
305
|
-
ttlSeconds: parseParticipantTtlSeconds(opts.ttlSeconds),
|
|
306
|
-
})
|
|
307
|
-
.then(() => {
|
|
308
|
-
if (!cancelled)
|
|
309
|
-
setClaimConnected(true);
|
|
310
|
-
})
|
|
311
|
-
.catch((err) => {
|
|
312
|
-
if (!cancelled) {
|
|
313
|
-
setClaimError(err instanceof Error ? err : new Error(String(err)));
|
|
314
|
-
}
|
|
315
|
-
});
|
|
316
|
-
// Prominence: hold the scope subscribed for as long as the claim lives.
|
|
317
|
-
void store.pinScope?.(scope);
|
|
318
|
-
return () => {
|
|
319
|
-
cancelled = true;
|
|
320
|
-
ws.sendRelease(claimId);
|
|
321
|
-
void store.unpinScope?.(scope);
|
|
322
|
-
};
|
|
323
|
-
}, [engine, paused, scopeKey, syncStatus.name, opts.ttlSeconds, opts.claim]);
|
|
324
|
-
// Bridge the engine's presence + claims streams into React state.
|
|
325
|
-
// Plain useState + useEffect is sufficient — mid-frame tearing on a
|
|
326
|
-
// peer list is harmless (users won't notice one frame of stale
|
|
327
|
-
// presence). Queries and sync status use useSyncExternalStore
|
|
328
|
-
// because transactions CAN tear visibly; presence can't.
|
|
329
|
-
const [peers, setPeers] = useState(EMPTY_PRESENCE);
|
|
330
|
-
const [claims, setClaims] = useState(EMPTY_INTENTS);
|
|
331
|
-
useEffect(() => {
|
|
332
|
-
if (!participant || paused) {
|
|
333
|
-
setPeers(EMPTY_PRESENCE);
|
|
334
|
-
setClaims(EMPTY_INTENTS);
|
|
335
|
-
return;
|
|
336
|
-
}
|
|
337
|
-
setPeers(participant.presence.others);
|
|
338
|
-
setClaims(participant.claims.others);
|
|
339
|
-
const unsubPresence = participant.presence.onChange(() => {
|
|
340
|
-
setPeers(participant.presence.others);
|
|
341
|
-
});
|
|
342
|
-
const unsubClaims = participant.claims.onChange(() => {
|
|
343
|
-
setClaims(participant.claims.others);
|
|
344
|
-
});
|
|
345
|
-
return () => {
|
|
346
|
-
unsubPresence();
|
|
347
|
-
unsubClaims();
|
|
348
|
-
};
|
|
349
|
-
}, [participant, paused]);
|
|
350
|
-
return { participant, peers, claims, status, error };
|
|
351
|
-
}
|
|
352
|
-
/**
|
|
353
|
-
* Read-only presence: the OTHER participants currently visible to this
|
|
354
|
-
* connection, bridged to React. Unlike {@link useJoin}, this does
|
|
355
|
-
* NOT enter/leave a scope (no `update_subscription`, no warm-TTL churn) —
|
|
356
|
-
* it is a pure reader of the engine's already-flowing presence stream.
|
|
357
|
-
*
|
|
358
|
-
* Pass `scope` to narrow to the peers on that scope's sync group(s); omit
|
|
359
|
-
* it to get everyone on the engine's groups. Membership is driven entirely
|
|
360
|
-
* by the presence channel (set server-side on connect, independent of any
|
|
361
|
-
* cursor/collaboration traffic), so reading it never affects what the
|
|
362
|
-
* connection is subscribed to and can't deadlock against a gated channel.
|
|
363
|
-
*
|
|
364
|
-
* Use this to answer "is anyone else here?" — e.g. suppressing live-cursor
|
|
365
|
-
* broadcasts while alone — when some OTHER mount already owns the scope's
|
|
366
|
-
* read interest (scope `leave` is not reference-counted, so a second
|
|
367
|
-
* `useJoin` on the same scope would warm-drop the owner's
|
|
368
|
-
* subscription on unmount).
|
|
369
|
-
*
|
|
370
|
-
* ```ts
|
|
371
|
-
* const peers = usePeers({ reports: reportId });
|
|
372
|
-
* const alone = !peers.some((p) => p.participantKind === 'user');
|
|
373
|
-
* ```
|
|
374
|
-
*/
|
|
375
|
-
export function usePeers(scope) {
|
|
376
|
-
const ctx = useContext(AbloInternalContext);
|
|
377
|
-
const engine = ctx?.engine ?? null;
|
|
378
|
-
// Resolve scope → groups through the schema (same idiom as useJoin).
|
|
379
|
-
// The stringified, sorted key is the stable effect dependency.
|
|
380
|
-
const scopeKey = JSON.stringify(resolveParticipantSyncGroups(scope, engine?.schema).sort());
|
|
381
|
-
const groups = useMemo(() => JSON.parse(scopeKey), [scopeKey]);
|
|
382
|
-
const [peers, setPeers] = useState(EMPTY_PRESENCE);
|
|
383
|
-
useEffect(() => {
|
|
384
|
-
if (!engine) {
|
|
385
|
-
setPeers(EMPTY_PRESENCE);
|
|
386
|
-
return;
|
|
387
|
-
}
|
|
388
|
-
const presence = engine.presence;
|
|
389
|
-
const compute = () => groups.length === 0
|
|
390
|
-
? presence.others
|
|
391
|
-
: presence.others.filter((p) => p.syncGroups.some((g) => groups.includes(g)));
|
|
392
|
-
// Plain useState + onChange — presence changes on join/leave/activity
|
|
393
|
-
// only (never on cursor traffic, a separate channel), so this fires
|
|
394
|
-
// rarely; a frame of stale presence is harmless (same rationale as
|
|
395
|
-
// useJoin's peers bridge).
|
|
396
|
-
setPeers(compute());
|
|
397
|
-
return presence.onChange(() => { setPeers(compute()); });
|
|
398
|
-
}, [engine, scopeKey]);
|
|
399
|
-
return peers;
|
|
400
|
-
}
|
|
401
|
-
// ── Escape-hatches: raw engine/store access ──────────────────────────
|
|
402
|
-
/**
|
|
403
|
-
* Returns the raw `SyncEngine` proxy. Typically you want the typed
|
|
404
|
-
* hooks (`useQuery`, `useOne`, `useMutate`) — this is for rare cases
|
|
405
|
-
* where you need direct access (e.g., `sync.tasks.onChange(cb)`).
|
|
406
|
-
*
|
|
407
|
-
* The generic parameter narrows the return type to your schema's
|
|
408
|
-
* model record so call sites get typed `sync.tasks.findMany()` /
|
|
409
|
-
* `sync.sections.create(...)` without a cast at the call site:
|
|
410
|
-
*
|
|
411
|
-
* ```ts
|
|
412
|
-
* const sync = useSync<(typeof schema)['models']>();
|
|
413
|
-
* ```
|
|
414
|
-
*
|
|
415
|
-
* The runtime value is the exact engine the provider constructed;
|
|
416
|
-
* the generic just widens the compile-time type.
|
|
417
|
-
*/
|
|
418
|
-
export function useSync() {
|
|
419
|
-
const ctx = useContext(AbloInternalContext);
|
|
420
|
-
if (!ctx) {
|
|
421
|
-
throw new AbloValidationError('useSync: no <AbloProvider> mounted above this component.', { code: 'no_ablo_provider' });
|
|
422
|
-
}
|
|
423
|
-
if (!ctx.engine) {
|
|
424
|
-
throw new AbloValidationError('useSync: the sync engine has not yet initialized. Wrap your ' +
|
|
425
|
-
'consumer in <ClientSideSuspense> or guard on useSyncStatus().', { code: 'sync_not_ready' });
|
|
426
|
-
}
|
|
427
|
-
return ctx.engine;
|
|
428
|
-
}
|
|
429
|
-
/**
|
|
430
|
-
* Returns the underlying `SyncStoreContract` (the BaseSyncedStore).
|
|
431
|
-
* Most consumers should prefer the typed hooks (`useQuery` etc.); this
|
|
432
|
-
* is for advanced cases like direct InstanceCache access or custom
|
|
433
|
-
* reactive bridges. Throws if the provider hasn't mounted the store
|
|
434
|
-
* yet — wrap consumers in `<ClientSideSuspense>` to gate correctly.
|
|
435
|
-
*
|
|
436
|
-
* The generic parameter lets consumers widen the return type to a
|
|
437
|
-
* concrete `BaseSyncedStore<...>` subclass if they track one:
|
|
438
|
-
*
|
|
439
|
-
* ```ts
|
|
440
|
-
* type AppStore = BaseSyncedStore<AppEvents, typeof schema>;
|
|
441
|
-
* const store = useSyncStore<AppStore>(); // no cast needed at call site
|
|
442
|
-
* ```
|
|
443
|
-
*
|
|
444
|
-
* The runtime value is always the concrete store the SDK constructed,
|
|
445
|
-
* so widening the type is safe. The bounded generic (`T extends
|
|
446
|
-
* SyncStoreContract`) keeps the widening honest.
|
|
447
|
-
*/
|
|
448
|
-
export function useSyncStore() {
|
|
449
|
-
const sync = useContext(SyncContext);
|
|
450
|
-
if (!sync?.store) {
|
|
451
|
-
throw new AbloValidationError('useSyncStore: the sync engine has not yet initialized. Wrap ' +
|
|
452
|
-
'consumers in <ClientSideSuspense> or guard on useSyncStatus().', { code: 'sync_not_ready' });
|
|
453
|
-
}
|
|
454
|
-
return sync.store;
|
|
455
|
-
}
|