@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,818 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Builds the typed client for a single schema model — the object reached as
|
|
3
|
-
* `ablo.<model>`.
|
|
4
|
-
*
|
|
5
|
-
* Each schema model gets one {@link ModelOperations}: the async server reads
|
|
6
|
-
* `retrieve` and `list`, the same verbs restricted to the local graph under
|
|
7
|
-
* `local`, the writes `create`, `update`, and `delete`, the coordination
|
|
8
|
-
* namespace `claim` (callable as `claim({ id })`, plus `claim.state`,
|
|
9
|
-
* `claim.queue`, `claim.release`, and `claim.reorder`), `join`, and `onChange`.
|
|
10
|
-
* The factory returns a plain object; the client assembles the `ablo.<model>`
|
|
11
|
-
* lookup table from one of these per model.
|
|
12
|
-
*/
|
|
13
|
-
import { autorun } from 'mobx';
|
|
14
|
-
import { AbloClaimedError, AbloValidationError, formatClaimedErrorMessage, toAbloError, } from '../transaction/errors.js';
|
|
15
|
-
import { reconcileFunctionalUpdate, } from '../transaction/resources/functionalUpdate.js';
|
|
16
|
-
import { claimDescription, } from '../transaction/coordination/schema.js';
|
|
17
|
-
import { Model, modelAsRow } from '../Model.js';
|
|
18
|
-
import { toMs } from '../transaction/utils/duration.js';
|
|
19
|
-
import { LEASE_TTL_MS } from '../transaction/wire/protocol.js';
|
|
20
|
-
import { heartbeatCadenceMs, resolveHeartbeatOptions, startClaimHeartbeatLoop, } from '../transaction/coordination/claimHeartbeatLoop.js';
|
|
21
|
-
import { assertWriteOptions } from '../transaction/resources/writeOptionsSchema.js';
|
|
22
|
-
import { modelTarget, subTarget } from '../transaction/coordination/index.js';
|
|
23
|
-
import { ModelScope } from '../transaction/types/index.js';
|
|
24
|
-
const modelClientMeta = new WeakMap();
|
|
25
|
-
export function getModelClientMeta(modelClient) {
|
|
26
|
-
if (typeof modelClient !== 'object' || modelClient === null)
|
|
27
|
-
return undefined;
|
|
28
|
-
return modelClientMeta.get(modelClient);
|
|
29
|
-
}
|
|
30
|
-
export function createModelProxy(schemaKey, registeredModelName, objectPool, syncClient, registry, hydration, collaboration,
|
|
31
|
-
/** The client-wide `wait` default; a per-call `wait` still wins over it. */
|
|
32
|
-
defaultWait) {
|
|
33
|
-
/**
|
|
34
|
-
* Resolve a row **this** resource owns.
|
|
35
|
-
*
|
|
36
|
-
* The pool is one id space, so `objectPool.get(id)` happily returns another
|
|
37
|
-
* model's row. Every write path below addresses rows by bare id, so without
|
|
38
|
-
* this an id from a sibling model resolves and gets written — silently
|
|
39
|
-
* corrupting a row the caller never named.
|
|
40
|
-
*
|
|
41
|
-
* `undefined` means genuinely absent. A row belonging to another model throws:
|
|
42
|
-
* unlike a read, a cross-model *write* is never a legitimate outcome, and
|
|
43
|
-
* naming both models turns a silent corruption into a one-line diagnosis.
|
|
44
|
-
*/
|
|
45
|
-
const ownRowOrThrow = (id) => {
|
|
46
|
-
const own = objectPool.getOfType(id, registeredModelName);
|
|
47
|
-
if (own)
|
|
48
|
-
return own;
|
|
49
|
-
const foreign = objectPool.get(id);
|
|
50
|
-
if (!foreign)
|
|
51
|
-
return undefined;
|
|
52
|
-
const owner = foreign.getModelName();
|
|
53
|
-
throw new AbloValidationError(`No ${registeredModelName} with id ${id} — that id belongs to a ${owner}. ` +
|
|
54
|
-
`Read or write it through ${owner}.`, { code: 'entity_not_found' });
|
|
55
|
-
};
|
|
56
|
-
const ModelClass = registry.getModelByName(registeredModelName);
|
|
57
|
-
if (!ModelClass) {
|
|
58
|
-
throw new AbloValidationError(`Ablo: schema model "${schemaKey}" resolved to "${registeredModelName}", ` +
|
|
59
|
-
'but no matching constructor was registered.', { code: 'model_not_registered' });
|
|
60
|
-
}
|
|
61
|
-
// The coordination plane must speak the same wire dialect as the commit
|
|
62
|
-
// plane: the lowercased typename (`task`), not the schema key (`tasks`). The
|
|
63
|
-
// server's commit-time claim guard probes the lease store with the commit
|
|
64
|
-
// operation's model name, so a lease recorded under the schema key never
|
|
65
|
-
// matches — which would silently disarm the guard for every model whose
|
|
66
|
-
// schema key differs from its typename (a plural key against a singular
|
|
67
|
-
// typename, i.e. nearly all of them). Public surfaces such as
|
|
68
|
-
// `Claim.target.model` keep the schema key; only the wire and coordination
|
|
69
|
-
// targets use this.
|
|
70
|
-
const wireModel = registeredModelName.toLowerCase();
|
|
71
|
-
// Last-line guarantee for the public surface: any rejection from a lower
|
|
72
|
-
// layer (transport timeout, IndexedDB failure, a third-party throw) is
|
|
73
|
-
// coerced to an AbloError before it reaches the consumer. The SDK's
|
|
74
|
-
// contract is that callers only ever catch tagged errors — `instanceof
|
|
75
|
-
// AbloError` / `e.type` always hold. Internal helpers stay unwrapped; only
|
|
76
|
-
// the methods exposed on `operations` are guarded.
|
|
77
|
-
const guard = (fn) => {
|
|
78
|
-
return async (...args) => {
|
|
79
|
-
try {
|
|
80
|
-
return await fn(...args);
|
|
81
|
-
}
|
|
82
|
-
catch (err) {
|
|
83
|
-
throw toAbloError(err);
|
|
84
|
-
}
|
|
85
|
-
};
|
|
86
|
-
};
|
|
87
|
-
const load = async (options) => {
|
|
88
|
-
const rows = await hydration.fetch(schemaKey, options);
|
|
89
|
-
// The coordinator returns Model instances. ModelOperations is
|
|
90
|
-
// typed against the schema-inferred row shape (`T`), which is
|
|
91
|
-
// structurally what the model exposes through its property
|
|
92
|
-
// accessors — cast at the boundary.
|
|
93
|
-
return rows;
|
|
94
|
-
};
|
|
95
|
-
const waitForMutation = async (model, options) => {
|
|
96
|
-
// A per-call `wait` wins; otherwise the client-wide default decides. This
|
|
97
|
-
// is the single point that turns "confirmed" into actually waiting, so a
|
|
98
|
-
// client configured that way rejects on a refused write everywhere rather
|
|
99
|
-
// than in the one place a caller remembered to ask.
|
|
100
|
-
if ((options?.wait ?? defaultWait) !== 'confirmed')
|
|
101
|
-
return;
|
|
102
|
-
await syncClient.syncNow();
|
|
103
|
-
await syncClient.waitForConfirmation(model.getModelName(), model.id);
|
|
104
|
-
};
|
|
105
|
-
// Claims this proxy currently holds, keyed by entity id. Lets the flat
|
|
106
|
-
// `release({ id })` and `update({ id, data })` find the lease and snapshot a
|
|
107
|
-
// `claim({ id })` took, without a per-call handle. Released on dispose,
|
|
108
|
-
// explicit release, or TTL expiry.
|
|
109
|
-
//
|
|
110
|
-
// `target`, `description`, and `expiresAt` are kept alongside the lease so
|
|
111
|
-
// `claim.state` can synthesize a self-claim: the server excludes a holder's
|
|
112
|
-
// own presence frames, so this proxy is the only place that knows the client
|
|
113
|
-
// holds the row. `expiresAt` is the client's best estimate from the requested
|
|
114
|
-
// TTL (a real epoch-millisecond expiry, not a fabricated watermark), defaulting
|
|
115
|
-
// to the server's keepalive lease window when no TTL was requested.
|
|
116
|
-
const activeClaims = new Map();
|
|
117
|
-
// Server keepalive lease window — the same `LEASE_TTL_MS` the wire protocol
|
|
118
|
-
// declares, so the client's estimate and the server's lease cannot drift.
|
|
119
|
-
// This is the fallback expiry estimate when a claim is taken without an
|
|
120
|
-
// explicit TTL.
|
|
121
|
-
const DEFAULT_LEASE_TTL_MS = LEASE_TTL_MS;
|
|
122
|
-
const isClaimHandle = (value) => typeof value === 'object' &&
|
|
123
|
-
value !== null &&
|
|
124
|
-
value.object === 'claim' &&
|
|
125
|
-
typeof value.id === 'string' &&
|
|
126
|
-
typeof value.release === 'function';
|
|
127
|
-
const claimContextFromClaim = (claim) => {
|
|
128
|
-
return {
|
|
129
|
-
id: claim.id,
|
|
130
|
-
actor: claim.heldBy,
|
|
131
|
-
participantKind: claim.participantKind,
|
|
132
|
-
description: claim.description,
|
|
133
|
-
field: claim.target.field,
|
|
134
|
-
status: claim.status,
|
|
135
|
-
expiresAt: claim.expiresAt,
|
|
136
|
-
target: {
|
|
137
|
-
...modelTarget(claim.target),
|
|
138
|
-
...subTarget(claim.target),
|
|
139
|
-
},
|
|
140
|
-
};
|
|
141
|
-
};
|
|
142
|
-
const mutationOptions = (params) => {
|
|
143
|
-
const { id: _id, data: _data, claim: _claim, ...rest } = params;
|
|
144
|
-
// The write-options schema — the runtime twin of the compile-time params.
|
|
145
|
-
// Catches plain-JavaScript callers (for example `onStale: 'rejct'`) at the
|
|
146
|
-
// call site with a typed error instead of a silent no-op or a server 400.
|
|
147
|
-
assertWriteOptions(rest, `${schemaKey} write`);
|
|
148
|
-
return rest;
|
|
149
|
-
};
|
|
150
|
-
const releaseClaim = async (id) => {
|
|
151
|
-
const held = activeClaims.get(id);
|
|
152
|
-
if (!held)
|
|
153
|
-
return;
|
|
154
|
-
activeClaims.delete(id);
|
|
155
|
-
await held.lease.release?.();
|
|
156
|
-
};
|
|
157
|
-
const takeClaim = async (params) => {
|
|
158
|
-
if (!collaboration) {
|
|
159
|
-
throw new AbloValidationError(`Model "${schemaKey}" was built without the collaboration runtime, so claim() is unavailable here. Claiming needs no per-model config — use the standard Ablo({ schema, apiKey }) client and every model is claimable.`, { code: 'model_claim_not_configured' });
|
|
160
|
-
}
|
|
161
|
-
const { id, ...options } = params;
|
|
162
|
-
// Is someone else already on this target? Read the local coordination
|
|
163
|
-
// snapshot up front — it decides whether a re-read is needed after the
|
|
164
|
-
// claim (a free or already-held target cannot have changed underneath us).
|
|
165
|
-
const held = collaboration.state({ model: wireModel, id });
|
|
166
|
-
const contended = !!held && held.heldBy !== collaboration.selfParticipantId;
|
|
167
|
-
const failFast = options.queue === false;
|
|
168
|
-
// Fail-fast (`queue: false`): if another participant already holds it,
|
|
169
|
-
// reject now instead of queuing. Best-effort at the client (a racing
|
|
170
|
-
// claim not yet synced into our snapshot slips through here) — the
|
|
171
|
-
// commit-time claim guard is the authoritative backstop that rejects
|
|
172
|
-
// the loser's first write. For work-distribution dedup that's exactly
|
|
173
|
-
// right: don't wait (that would double-process), skip.
|
|
174
|
-
if (failFast && contended) {
|
|
175
|
-
const claim = claimContextFromClaim(held);
|
|
176
|
-
throw new AbloClaimedError(formatClaimedErrorMessage({
|
|
177
|
-
targetLabel: `${registeredModelName}/${id}`,
|
|
178
|
-
heldBy: held.heldBy,
|
|
179
|
-
claim,
|
|
180
|
-
fallback: `${registeredModelName}/${id} is held by ${held.heldBy ?? 'another participant'}.`,
|
|
181
|
-
}), { code: 'entity_claimed', claims: [claim] });
|
|
182
|
-
}
|
|
183
|
-
// Ensure the row exists locally before claiming.
|
|
184
|
-
let model = ownRowOrThrow(id);
|
|
185
|
-
if (!model) {
|
|
186
|
-
await load({ where: [['id', id]] });
|
|
187
|
-
model = ownRowOrThrow(id);
|
|
188
|
-
}
|
|
189
|
-
if (!model) {
|
|
190
|
-
throw new AbloValidationError(`Entity not found: ${registeredModelName}/${id}`, { code: 'entity_not_found' });
|
|
191
|
-
}
|
|
192
|
-
// Write intent: enter the entity scope before acquiring the lease so the
|
|
193
|
-
// holder's claim presence broadcasts to everyone in this entity group,
|
|
194
|
-
// including a peer that subscribed just before us. Pinning before the lease
|
|
195
|
-
// rather than after closes the subscribe-versus-broadcast race: the server
|
|
196
|
-
// fans presence out at claim time, so this client must be in the group when
|
|
197
|
-
// the claim lands. Awaited because the broadcast ordering depends on it;
|
|
198
|
-
// still best-effort (the store swallows reconcile errors).
|
|
199
|
-
await collaboration.pinScope?.({ [schemaKey]: id });
|
|
200
|
-
// Acquire the lease. By default (`queue` is not false) this goes through the
|
|
201
|
-
// server's fair FIFO queue: `queue: true` resolves only once the lease is
|
|
202
|
-
// genuinely ours, blocking behind any current holder, with no check-then-act
|
|
203
|
-
// gap because the server orders contenders. Fail-fast skips the queue: an
|
|
204
|
-
// observed conflict was already rejected above, so this just records the lease.
|
|
205
|
-
const lease = await collaboration.createClaim({
|
|
206
|
-
target: {
|
|
207
|
-
model: wireModel,
|
|
208
|
-
id,
|
|
209
|
-
// The whole sub-entity locator in one move — listing its members here
|
|
210
|
-
// is what let `fields` die between the caller and the lease, so the
|
|
211
|
-
// claim covered the whole row while the caller believed it named parts.
|
|
212
|
-
...subTarget(options),
|
|
213
|
-
},
|
|
214
|
-
description: claimDescription(options),
|
|
215
|
-
ttl: options.ttl,
|
|
216
|
-
queue: !failFast,
|
|
217
|
-
maxQueueDepth: options.maxQueueDepth,
|
|
218
|
-
});
|
|
219
|
-
// Only when the claim actually waited behind another holder can the row have
|
|
220
|
-
// changed underneath us — re-read so the claimed snapshot reflects what that
|
|
221
|
-
// holder committed before releasing. Either of two signals suffices:
|
|
222
|
-
// - `lease.waited` — the server granted the claim after the client
|
|
223
|
-
// provably queued behind a holder. Authoritative; it works even when the
|
|
224
|
-
// local snapshot is blind, since claim fan-out is entity-scoped and a
|
|
225
|
-
// broadly-subscribed client never observes peers' claims.
|
|
226
|
-
// - `contended` — the local snapshot saw a holder up front. Kept for the
|
|
227
|
-
// no-queue paths, where no grant frame exists.
|
|
228
|
-
if ((contended || lease.waited === true) && !failFast) {
|
|
229
|
-
// `type: 'complete'` forces the round-trip: the hydration ledger would
|
|
230
|
-
// otherwise serve the local row for an already-hydrated id, and the
|
|
231
|
-
// holder's final write may not have fanned out yet — the exact
|
|
232
|
-
// stale-snapshot race this re-read closes.
|
|
233
|
-
await load({ where: [['id', id]], type: 'complete' });
|
|
234
|
-
model = ownRowOrThrow(id) ?? model;
|
|
235
|
-
}
|
|
236
|
-
const snapshot = collaboration.createSnapshot(schemaKey, id);
|
|
237
|
-
const description = claimDescription(options);
|
|
238
|
-
// The self-claim's `ClaimTarget` mirrors what a peer's `claim.state` would
|
|
239
|
-
// report (`state` maps `held.target.model` to `type`), so a holder and a
|
|
240
|
-
// peer see the same `target.type` for one row — the wire model token.
|
|
241
|
-
const selfTarget = {
|
|
242
|
-
type: wireModel,
|
|
243
|
-
id,
|
|
244
|
-
...subTarget(options),
|
|
245
|
-
};
|
|
246
|
-
const ttlMs = options.ttl !== undefined ? toMs(options.ttl) : DEFAULT_LEASE_TTL_MS;
|
|
247
|
-
const expiresAt = Date.now() + ttlMs;
|
|
248
|
-
activeClaims.set(id, {
|
|
249
|
-
lease,
|
|
250
|
-
snapshot,
|
|
251
|
-
target: selfTarget,
|
|
252
|
-
description,
|
|
253
|
-
expiresAt,
|
|
254
|
-
});
|
|
255
|
-
const target = {
|
|
256
|
-
type: schemaKey,
|
|
257
|
-
id,
|
|
258
|
-
...subTarget(options),
|
|
259
|
-
};
|
|
260
|
-
// A beat resolves with the server's extended expiry; keep the local
|
|
261
|
-
// self-claim estimate in step so `claim.state` renders the real window,
|
|
262
|
-
// and surface every answer through `onHeartbeat` (pressure signal).
|
|
263
|
-
const heartbeat = async (beatOptions) => {
|
|
264
|
-
if (!lease.heartbeat) {
|
|
265
|
-
throw new AbloValidationError('This claim handle has no heartbeat wiring, which the standard Ablo({ schema, apiKey }) client provides on every claim. This appears only when a claim is minted through an internal path that predates heartbeats.', { code: 'claim_not_wired' });
|
|
266
|
-
}
|
|
267
|
-
const resolved = resolveHeartbeatOptions(beatOptions);
|
|
268
|
-
const beat = await lease.heartbeat({
|
|
269
|
-
ttl: resolved.ttl ?? options.ttl,
|
|
270
|
-
...(resolved.details !== undefined ? { details: resolved.details } : {}),
|
|
271
|
-
});
|
|
272
|
-
const held = activeClaims.get(id);
|
|
273
|
-
if (held)
|
|
274
|
-
held.expiresAt = beat.expiresAt;
|
|
275
|
-
options.onHeartbeat?.(beat);
|
|
276
|
-
return beat;
|
|
277
|
-
};
|
|
278
|
-
// Opt-in auto-heartbeat: the loop beats until release, and a definitive
|
|
279
|
-
// loss stops it and surfaces through `onHeartbeatLost`.
|
|
280
|
-
const stopHeartbeatLoop = options.heartbeat
|
|
281
|
-
? startClaimHeartbeatLoop({
|
|
282
|
-
beat: () => heartbeat(),
|
|
283
|
-
intervalMs: heartbeatCadenceMs(ttlMs, options.heartbeat),
|
|
284
|
-
...(options.onHeartbeatLost
|
|
285
|
-
? { onLost: options.onHeartbeatLost }
|
|
286
|
-
: {}),
|
|
287
|
-
})
|
|
288
|
-
: undefined;
|
|
289
|
-
const release = () => {
|
|
290
|
-
stopHeartbeatLoop?.();
|
|
291
|
-
return releaseClaim(id);
|
|
292
|
-
};
|
|
293
|
-
return {
|
|
294
|
-
object: 'claim',
|
|
295
|
-
id: lease.id,
|
|
296
|
-
readAt: snapshot.stamp,
|
|
297
|
-
// The fencing token the server minted for this grant, forwarded from the
|
|
298
|
-
// lease so writes taken under this handle carry it (Option B).
|
|
299
|
-
...(lease.fenceToken !== undefined ? { fenceToken: lease.fenceToken } : {}),
|
|
300
|
-
target,
|
|
301
|
-
description,
|
|
302
|
-
data: modelAsRow(model),
|
|
303
|
-
release,
|
|
304
|
-
revoke: () => {
|
|
305
|
-
void release();
|
|
306
|
-
},
|
|
307
|
-
heartbeat,
|
|
308
|
-
[Symbol.asyncDispose]: release,
|
|
309
|
-
};
|
|
310
|
-
};
|
|
311
|
-
// The row-free sibling of `takeClaim`: locks a key by id alone, for a row that
|
|
312
|
-
// lives only in the customer's own database and was never synced into Ablo.
|
|
313
|
-
// Everything about the lease — the fail-fast contention check, the scope pin,
|
|
314
|
-
// the `createClaim` grant, the heartbeat wiring, and the `activeClaims`
|
|
315
|
-
// bookkeeping — is identical; what's dropped is the object-pool `load` (and its
|
|
316
|
-
// `entity_not_found` throw), the post-grant re-read, and the `.data` field,
|
|
317
|
-
// since there is no local row to hydrate or return.
|
|
318
|
-
const takeRowFreeClaim = async (id, options) => {
|
|
319
|
-
if (!collaboration) {
|
|
320
|
-
throw new AbloValidationError(`Model "${schemaKey}" was built without the collaboration runtime, so claim() is unavailable here. Claiming needs no per-model config — use the standard Ablo({ schema, apiKey }) client and every model is claimable.`, { code: 'model_claim_not_configured' });
|
|
321
|
-
}
|
|
322
|
-
// Is someone else already on this target? Read the local coordination
|
|
323
|
-
// snapshot up front so a `queue: false` caller can reject before announcing
|
|
324
|
-
// a claim the server would refuse.
|
|
325
|
-
const held = collaboration.state({ model: wireModel, id });
|
|
326
|
-
const contended = !!held && held.heldBy !== collaboration.selfParticipantId;
|
|
327
|
-
const failFast = options.queue === false;
|
|
328
|
-
// Fail-fast (`queue: false`): reject now if a holder is already visible.
|
|
329
|
-
// Best-effort at the client — a row this participant never synced usually
|
|
330
|
-
// carries no local claim state either, so a peer gets the deterministic
|
|
331
|
-
// rejection only once it has observed the holder (entered the row's entity
|
|
332
|
-
// scope). The server's queue is the backstop for the queuing path.
|
|
333
|
-
if (failFast && contended) {
|
|
334
|
-
const claim = claimContextFromClaim(held);
|
|
335
|
-
throw new AbloClaimedError(formatClaimedErrorMessage({
|
|
336
|
-
targetLabel: `${registeredModelName}/${id}`,
|
|
337
|
-
heldBy: held.heldBy,
|
|
338
|
-
claim,
|
|
339
|
-
fallback: `${registeredModelName}/${id} is held by ${held.heldBy ?? 'another participant'}.`,
|
|
340
|
-
}), { code: 'entity_claimed', claims: [claim] });
|
|
341
|
-
}
|
|
342
|
-
// Enter the entity scope before acquiring the lease so the holder's claim
|
|
343
|
-
// presence broadcasts to everyone in this entity group — the same ordering
|
|
344
|
-
// the row-bearing path relies on. No pool `load` and no `entity_not_found`
|
|
345
|
-
// throw: the row lives only in the customer's database, so there is nothing
|
|
346
|
-
// to hydrate here and nothing to re-read after the grant.
|
|
347
|
-
await collaboration.pinScope?.({ [schemaKey]: id });
|
|
348
|
-
const lease = await collaboration.createClaim({
|
|
349
|
-
target: {
|
|
350
|
-
model: wireModel,
|
|
351
|
-
id,
|
|
352
|
-
// The whole sub-entity locator in one move — listing its members here
|
|
353
|
-
// is what let `fields` die between the caller and the lease, so the
|
|
354
|
-
// claim covered the whole row while the caller believed it named parts.
|
|
355
|
-
...subTarget(options),
|
|
356
|
-
},
|
|
357
|
-
description: claimDescription(options),
|
|
358
|
-
ttl: options.ttl,
|
|
359
|
-
queue: !failFast,
|
|
360
|
-
maxQueueDepth: options.maxQueueDepth,
|
|
361
|
-
});
|
|
362
|
-
// A watermark-only snapshot: `createSnapshot` still reads the engine's
|
|
363
|
-
// current `lastSyncId` even though the pool holds no row (the bucket is
|
|
364
|
-
// empty). It costs nothing extra and gives a write taken under this lease a
|
|
365
|
-
// real `readAt` to guard against changes since the lease was acquired.
|
|
366
|
-
const snapshot = collaboration.createSnapshot(schemaKey, id);
|
|
367
|
-
const description = claimDescription(options);
|
|
368
|
-
const selfTarget = {
|
|
369
|
-
type: wireModel,
|
|
370
|
-
id,
|
|
371
|
-
...subTarget(options),
|
|
372
|
-
};
|
|
373
|
-
const ttlMs = options.ttl !== undefined ? toMs(options.ttl) : DEFAULT_LEASE_TTL_MS;
|
|
374
|
-
const expiresAt = Date.now() + ttlMs;
|
|
375
|
-
activeClaims.set(id, {
|
|
376
|
-
lease,
|
|
377
|
-
snapshot,
|
|
378
|
-
target: selfTarget,
|
|
379
|
-
description,
|
|
380
|
-
expiresAt,
|
|
381
|
-
});
|
|
382
|
-
const target = {
|
|
383
|
-
type: schemaKey,
|
|
384
|
-
id,
|
|
385
|
-
...subTarget(options),
|
|
386
|
-
};
|
|
387
|
-
// A beat resolves with the server's extended expiry; keep the local
|
|
388
|
-
// self-claim estimate in step so `claim.state` renders the real window.
|
|
389
|
-
const heartbeat = async (beatOptions) => {
|
|
390
|
-
if (!lease.heartbeat) {
|
|
391
|
-
throw new AbloValidationError('This claim handle has no heartbeat wiring, which the standard Ablo({ schema, apiKey }) client provides on every claim. This appears only when a claim is minted through an internal path that predates heartbeats.', { code: 'claim_not_wired' });
|
|
392
|
-
}
|
|
393
|
-
const resolved = resolveHeartbeatOptions(beatOptions);
|
|
394
|
-
const beat = await lease.heartbeat({
|
|
395
|
-
ttl: resolved.ttl ?? options.ttl,
|
|
396
|
-
...(resolved.details !== undefined ? { details: resolved.details } : {}),
|
|
397
|
-
});
|
|
398
|
-
const held = activeClaims.get(id);
|
|
399
|
-
if (held)
|
|
400
|
-
held.expiresAt = beat.expiresAt;
|
|
401
|
-
options.onHeartbeat?.(beat);
|
|
402
|
-
return beat;
|
|
403
|
-
};
|
|
404
|
-
const stopHeartbeatLoop = options.heartbeat
|
|
405
|
-
? startClaimHeartbeatLoop({
|
|
406
|
-
beat: () => heartbeat(),
|
|
407
|
-
intervalMs: heartbeatCadenceMs(ttlMs, options.heartbeat),
|
|
408
|
-
...(options.onHeartbeatLost
|
|
409
|
-
? { onLost: options.onHeartbeatLost }
|
|
410
|
-
: {}),
|
|
411
|
-
})
|
|
412
|
-
: undefined;
|
|
413
|
-
const release = () => {
|
|
414
|
-
stopHeartbeatLoop?.();
|
|
415
|
-
return releaseClaim(id);
|
|
416
|
-
};
|
|
417
|
-
return {
|
|
418
|
-
object: 'claim',
|
|
419
|
-
id: lease.id,
|
|
420
|
-
readAt: snapshot.stamp,
|
|
421
|
-
// Forward the grant's fencing token so writes under this row-free lease
|
|
422
|
-
// carry it (Option B), exactly as the row-bearing claim does.
|
|
423
|
-
...(lease.fenceToken !== undefined ? { fenceToken: lease.fenceToken } : {}),
|
|
424
|
-
target,
|
|
425
|
-
description,
|
|
426
|
-
release,
|
|
427
|
-
revoke: () => {
|
|
428
|
-
void release();
|
|
429
|
-
},
|
|
430
|
-
heartbeat,
|
|
431
|
-
[Symbol.asyncDispose]: release,
|
|
432
|
-
};
|
|
433
|
-
};
|
|
434
|
-
// `claim` overloads on its first argument: an options object claims a synced
|
|
435
|
-
// row and resolves to a HeldClaim (carrying `.data`); a bare id claims a key
|
|
436
|
-
// whose row Ablo doesn't hold and resolves to a HeldLease (no `.data`). Both
|
|
437
|
-
// route their throws through `toAbloError` via the guarded takers, so the
|
|
438
|
-
// two-signature shape survives — wrapping the dispatcher itself in `guard`
|
|
439
|
-
// would collapse the overloads to one.
|
|
440
|
-
const guardedTakeClaim = guard(takeClaim);
|
|
441
|
-
const guardedTakeRowFreeClaim = guard(takeRowFreeClaim);
|
|
442
|
-
function claim(arg, opts) {
|
|
443
|
-
return typeof arg === 'string'
|
|
444
|
-
? guardedTakeRowFreeClaim(arg, opts ?? {})
|
|
445
|
-
: guardedTakeClaim(arg);
|
|
446
|
-
}
|
|
447
|
-
// `claim` is a callable namespace: invoke it to take a claim, reach its
|
|
448
|
-
// members to read/steer the coordination plane. Attach the readers to the
|
|
449
|
-
// callable so `ablo.<model>.claim(...)` and `ablo.<model>.claim.state(...)`
|
|
450
|
-
// are the same object.
|
|
451
|
-
// `state` and `queue` take a caller-named `meta` shape. The runtime cannot
|
|
452
|
-
// check it and is not meant to: `target.meta` is application data the
|
|
453
|
-
// protocol carries verbatim and never interprets, so naming its type is the
|
|
454
|
-
// caller asserting what it put there — the same bargain as parsing your own
|
|
455
|
-
// JSON into an interface. These read as `Claim` here, and the one assertion
|
|
456
|
-
// that applies the caller's parameter is on the assignment below, in one
|
|
457
|
-
// place rather than at every call site.
|
|
458
|
-
const claimReaders = {
|
|
459
|
-
state(params) {
|
|
460
|
-
// Read interest: a passive observer of a row's claim state must enter that
|
|
461
|
-
// row's entity scope, or it sits only on broader `org:`/`user:` groups and
|
|
462
|
-
// never receives the holder's entity-scoped claim presence. Best-effort
|
|
463
|
-
// and fire-and-forget — it never blocks or rejects the read.
|
|
464
|
-
void collaboration?.enterScope?.({ [schemaKey]: params.id });
|
|
465
|
-
// Self-awareness: the server excludes a holder's own presence frames and
|
|
466
|
-
// the client skips them, so `state` would return null for a row this client
|
|
467
|
-
// holds. Synthesize the active claim from the stored lease so the holder
|
|
468
|
-
// sees its own claim, honoring the documented contract on `claim.state`.
|
|
469
|
-
const own = activeClaims.get(params.id);
|
|
470
|
-
if (own) {
|
|
471
|
-
return {
|
|
472
|
-
object: 'claim',
|
|
473
|
-
id: own.lease.id,
|
|
474
|
-
status: 'active',
|
|
475
|
-
target: own.target,
|
|
476
|
-
description: own.description,
|
|
477
|
-
heldBy: collaboration?.selfParticipantId ?? '',
|
|
478
|
-
participantKind: collaboration?.selfParticipantKind ?? 'user',
|
|
479
|
-
expiresAt: own.expiresAt,
|
|
480
|
-
};
|
|
481
|
-
}
|
|
482
|
-
return collaboration?.state({ model: wireModel, id: params.id }) ?? null;
|
|
483
|
-
},
|
|
484
|
-
queue(params) {
|
|
485
|
-
return {
|
|
486
|
-
object: 'list',
|
|
487
|
-
data: collaboration?.queue({ model: wireModel, id: params.id }) ?? [],
|
|
488
|
-
};
|
|
489
|
-
},
|
|
490
|
-
reorder(params) {
|
|
491
|
-
collaboration?.reorder({ model: wireModel, id: params.id }, params.order);
|
|
492
|
-
},
|
|
493
|
-
release: guard((params) => releaseClaim(isClaimHandle(params) ? params.target.id : params.id)),
|
|
494
|
-
};
|
|
495
|
-
// The one place the caller's `meta` parameter is applied — see the note on
|
|
496
|
-
// `claimReaders`. Everything else about this object is checked structurally.
|
|
497
|
-
const claimApi = Object.assign(claim, claimReaders);
|
|
498
|
-
const local = {
|
|
499
|
-
retrieve(id) {
|
|
500
|
-
// Scoped to this model: an id belonging to a sibling model reads as
|
|
501
|
-
// absent rather than being handed back as if it were a `T`.
|
|
502
|
-
return objectPool.getOfType(id, registeredModelName);
|
|
503
|
-
},
|
|
504
|
-
list(options) {
|
|
505
|
-
const all = objectPool.getByType(ModelClass, (options?.state ?? ModelScope.live));
|
|
506
|
-
let result = all;
|
|
507
|
-
if (options?.where) {
|
|
508
|
-
const where = options.where;
|
|
509
|
-
result = result.filter((item) => {
|
|
510
|
-
for (const [key, value] of Object.entries(where)) {
|
|
511
|
-
if (item[key] !== value)
|
|
512
|
-
return false;
|
|
513
|
-
}
|
|
514
|
-
return true;
|
|
515
|
-
});
|
|
516
|
-
}
|
|
517
|
-
if (options?.filter) {
|
|
518
|
-
result = result.filter(options.filter);
|
|
519
|
-
}
|
|
520
|
-
const orderEntry = options?.orderBy ? Object.entries(options.orderBy)[0] : undefined;
|
|
521
|
-
if (orderEntry) {
|
|
522
|
-
const [field, dir] = orderEntry;
|
|
523
|
-
result = [...result].sort((a, b) => {
|
|
524
|
-
const av = a[field];
|
|
525
|
-
const bv = b[field];
|
|
526
|
-
if (av == null || bv == null)
|
|
527
|
-
return 0;
|
|
528
|
-
const cmp = av < bv ? -1 : av > bv ? 1 : 0;
|
|
529
|
-
return dir === 'desc' ? -cmp : cmp;
|
|
530
|
-
});
|
|
531
|
-
}
|
|
532
|
-
if (options?.offset)
|
|
533
|
-
result = result.slice(options.offset);
|
|
534
|
-
if (options?.limit)
|
|
535
|
-
result = result.slice(0, options.limit);
|
|
536
|
-
return result;
|
|
537
|
-
},
|
|
538
|
-
count(options) {
|
|
539
|
-
return local.list(options).length;
|
|
540
|
-
},
|
|
541
|
-
};
|
|
542
|
-
const operations = {
|
|
543
|
-
local,
|
|
544
|
-
retrieve: guard(async (params) => {
|
|
545
|
-
// Read-interest enrolment: reading a row enters its entity scope, so a
|
|
546
|
-
// client lands in the same group the holder's claim presence fans out
|
|
547
|
-
// on and `claim.state`/`claim.queue` report peers. Best-effort and
|
|
548
|
-
// fire-and-forget — it never makes the read reject or run slower.
|
|
549
|
-
void collaboration?.enterScope?.({ [schemaKey]: params.id });
|
|
550
|
-
const rows = await load({
|
|
551
|
-
...params,
|
|
552
|
-
where: [['id', params.id]],
|
|
553
|
-
limit: 1,
|
|
554
|
-
});
|
|
555
|
-
return rows[0];
|
|
556
|
-
}),
|
|
557
|
-
// No automatic scope enrolment on bulk `list`: that would subscribe to an
|
|
558
|
-
// unbounded set of rows' entity groups.
|
|
559
|
-
list: guard(load),
|
|
560
|
-
create: guard(async (params) => {
|
|
561
|
-
const id = params.id ?? Model.generateId();
|
|
562
|
-
const opts = mutationOptions(params);
|
|
563
|
-
const claim = params.claim;
|
|
564
|
-
let autoLease;
|
|
565
|
-
if (claim && !isClaimHandle(claim)) {
|
|
566
|
-
if (!collaboration) {
|
|
567
|
-
throw new AbloValidationError(`Model "${schemaKey}" was built without the collaboration runtime, so claim() is unavailable here. Claiming needs no per-model config — use the standard Ablo({ schema, apiKey }) client and every model is claimable.`, { code: 'model_claim_not_configured' });
|
|
568
|
-
}
|
|
569
|
-
// Write intent: enter the new row's entity scope before acquiring the
|
|
570
|
-
// create-claim so the holder's claim presence broadcasts to everyone
|
|
571
|
-
// already in this entity group (closing the subscribe-versus-broadcast
|
|
572
|
-
// race — see `takeClaim`). Released with the lease in the `finally`
|
|
573
|
-
// below. Awaited for broadcast ordering; still best-effort.
|
|
574
|
-
await collaboration.pinScope?.({ [schemaKey]: id });
|
|
575
|
-
autoLease = await collaboration.createClaim({
|
|
576
|
-
target: {
|
|
577
|
-
model: wireModel,
|
|
578
|
-
id,
|
|
579
|
-
...subTarget(claim),
|
|
580
|
-
},
|
|
581
|
-
description: claimDescription(claim, 'creating'),
|
|
582
|
-
ttl: claim.ttl,
|
|
583
|
-
queue: claim.queue !== false,
|
|
584
|
-
maxQueueDepth: claim.maxQueueDepth,
|
|
585
|
-
});
|
|
586
|
-
}
|
|
587
|
-
// Default `organizationId` from the client's identity, matching the other
|
|
588
|
-
// write path — without this, a caller that omits it would create an
|
|
589
|
-
// org-unscoped row on one write path but not the other. An explicit value
|
|
590
|
-
// in `data` still wins via the spread.
|
|
591
|
-
const orgDefault = params.data.organizationId ??
|
|
592
|
-
syncClient.getOrganizationId();
|
|
593
|
-
const model = new ModelClass({
|
|
594
|
-
id,
|
|
595
|
-
...(orgDefault != null ? { organizationId: orgDefault } : {}),
|
|
596
|
-
...params.data,
|
|
597
|
-
createdAt: new Date(),
|
|
598
|
-
updatedAt: new Date(),
|
|
599
|
-
});
|
|
600
|
-
const effective = {
|
|
601
|
-
...opts,
|
|
602
|
-
...(autoLease ? { claim: autoLease } : {}),
|
|
603
|
-
...(isClaimHandle(claim) ? { claim: { id: claim.id } } : {}),
|
|
604
|
-
};
|
|
605
|
-
try {
|
|
606
|
-
syncClient.add(model, effective);
|
|
607
|
-
await waitForMutation(model, effective);
|
|
608
|
-
return modelAsRow(model);
|
|
609
|
-
}
|
|
610
|
-
finally {
|
|
611
|
-
await autoLease?.release?.().catch(() => { });
|
|
612
|
-
}
|
|
613
|
-
}),
|
|
614
|
-
// `update` is overloaded — classic `update({ id, data })` + functional
|
|
615
|
-
// `update(id, current => next)`. The IIFE keeps the shared error-guard
|
|
616
|
-
// wrapping while exposing the two public signatures (a plain `guard(...)`
|
|
617
|
-
// would collapse them to one).
|
|
618
|
-
update: (() => {
|
|
619
|
-
const updateImpl = guard(async (arg, updater, contention) => {
|
|
620
|
-
// Functional form: update(id, current => next). Same guarantee as the
|
|
621
|
-
// HTTP client (shared reconcile loop), implemented with this transport's
|
|
622
|
-
// own read-fresh + confirmed compare-and-swap. A forced server round-trip
|
|
623
|
-
// gets the latest row + watermark; the write is stale-guarded by it, so
|
|
624
|
-
// concurrent writers reconcile instead of clobbering — no claim needed.
|
|
625
|
-
if (typeof arg === 'string') {
|
|
626
|
-
const id = arg;
|
|
627
|
-
if (typeof updater !== 'function') {
|
|
628
|
-
throw new AbloValidationError(`${registeredModelName}.update('${id}', updater): the second argument must ` +
|
|
629
|
-
`be an updater function (current) => next. To write a fixed value, use ` +
|
|
630
|
-
`update({ id, data }).`, { code: 'write_options_invalid' });
|
|
631
|
-
}
|
|
632
|
-
if (!collaboration) {
|
|
633
|
-
throw new AbloValidationError(`${registeredModelName}.update(id, updater) needs the collaboration runtime ` +
|
|
634
|
-
`(a live WebSocket) to read the row's watermark for its compare-and-swap. ` +
|
|
635
|
-
`Use the standard Ablo({ schema, apiKey }) client.`, { code: 'model_claim_not_configured' });
|
|
636
|
-
}
|
|
637
|
-
return reconcileFunctionalUpdate(updater, contention, {
|
|
638
|
-
model: registeredModelName,
|
|
639
|
-
id,
|
|
640
|
-
readFresh: async () => {
|
|
641
|
-
// `type: 'complete'` forces the round-trip — the hydration ledger
|
|
642
|
-
// would otherwise serve a possibly-stale local row for a hydrated id.
|
|
643
|
-
await load({ where: [['id', id]], type: 'complete' });
|
|
644
|
-
const fresh = ownRowOrThrow(id);
|
|
645
|
-
const snapshot = collaboration.createSnapshot(schemaKey, id);
|
|
646
|
-
return {
|
|
647
|
-
data: fresh ? modelAsRow(fresh) : undefined,
|
|
648
|
-
stamp: snapshot.stamp,
|
|
649
|
-
};
|
|
650
|
-
},
|
|
651
|
-
writeNext: async (patch, readAt) => {
|
|
652
|
-
const model = ownRowOrThrow(id);
|
|
653
|
-
if (!model) {
|
|
654
|
-
throw new AbloValidationError(`Entity not found: ${registeredModelName}/${id}`, { code: 'entity_not_found' });
|
|
655
|
-
}
|
|
656
|
-
const effective = {
|
|
657
|
-
wait: 'confirmed',
|
|
658
|
-
readAt,
|
|
659
|
-
onStale: 'reject',
|
|
660
|
-
};
|
|
661
|
-
model.applyChanges(patch);
|
|
662
|
-
syncClient.update(model, effective);
|
|
663
|
-
await waitForMutation(model, effective);
|
|
664
|
-
return modelAsRow(model);
|
|
665
|
-
},
|
|
666
|
-
});
|
|
667
|
-
}
|
|
668
|
-
const params = arg;
|
|
669
|
-
const autoClaim = params.claim && !isClaimHandle(params.claim) ? params.claim : null;
|
|
670
|
-
if (autoClaim) {
|
|
671
|
-
const handle = await takeClaim({ ...autoClaim, id: params.id });
|
|
672
|
-
try {
|
|
673
|
-
return await operations.update({ ...params, claim: handle });
|
|
674
|
-
}
|
|
675
|
-
finally {
|
|
676
|
-
await handle.release();
|
|
677
|
-
}
|
|
678
|
-
}
|
|
679
|
-
const { id } = params;
|
|
680
|
-
const model = ownRowOrThrow(id);
|
|
681
|
-
if (!model)
|
|
682
|
-
throw new AbloValidationError(`Entity not found: ${registeredModelName}/${id}`, { code: 'entity_not_found' });
|
|
683
|
-
// If we hold a claim on this row, guard the write with its snapshot
|
|
684
|
-
// watermark + lease so it's stale-rejected and attributed to the claim.
|
|
685
|
-
const claimed = activeClaims.get(id);
|
|
686
|
-
const opts = mutationOptions(params);
|
|
687
|
-
const handle = isClaimHandle(params.claim) ? params.claim : undefined;
|
|
688
|
-
const effective = claimed
|
|
689
|
-
? {
|
|
690
|
-
wait: 'confirmed',
|
|
691
|
-
readAt: claimed.snapshot.stamp,
|
|
692
|
-
onStale: 'reject',
|
|
693
|
-
claimRef: { id: claimed.lease.id },
|
|
694
|
-
...opts,
|
|
695
|
-
}
|
|
696
|
-
: {
|
|
697
|
-
// A carried handle engages the same stale guard as a claim this
|
|
698
|
-
// proxy took itself — the watermark rides on the handle, so it
|
|
699
|
-
// works across clients (HTTP-minted handles included).
|
|
700
|
-
...(handle?.readAt !== undefined
|
|
701
|
-
? {
|
|
702
|
-
wait: 'confirmed',
|
|
703
|
-
readAt: handle.readAt,
|
|
704
|
-
onStale: 'reject',
|
|
705
|
-
...(handle.fenceToken !== undefined
|
|
706
|
-
? { fenceToken: handle.fenceToken }
|
|
707
|
-
: {}),
|
|
708
|
-
}
|
|
709
|
-
: {}),
|
|
710
|
-
...opts,
|
|
711
|
-
...(handle ? { claim: { id: handle.id } } : {}),
|
|
712
|
-
};
|
|
713
|
-
// Local user update: `applyChanges` keeps change tracking on so the
|
|
714
|
-
// edited fields land in `modifiedProperties` and are actually sent to
|
|
715
|
-
// the server. (`updateFromData` is the hydration path and would discard
|
|
716
|
-
// the tracking, producing an empty `input: {}` no-op mutation.)
|
|
717
|
-
model.applyChanges(params.data);
|
|
718
|
-
syncClient.update(model, effective);
|
|
719
|
-
await waitForMutation(model, effective);
|
|
720
|
-
return modelAsRow(model);
|
|
721
|
-
});
|
|
722
|
-
function update(arg, updater, contention) {
|
|
723
|
-
return updateImpl(arg, updater, contention);
|
|
724
|
-
}
|
|
725
|
-
return update;
|
|
726
|
-
})(),
|
|
727
|
-
delete: guard(async (params) => {
|
|
728
|
-
const autoClaim = params.claim && !isClaimHandle(params.claim) ? params.claim : null;
|
|
729
|
-
if (autoClaim) {
|
|
730
|
-
const handle = await takeClaim({ ...autoClaim, id: params.id });
|
|
731
|
-
try {
|
|
732
|
-
await operations.delete({ ...params, claim: handle });
|
|
733
|
-
}
|
|
734
|
-
finally {
|
|
735
|
-
await handle.release();
|
|
736
|
-
}
|
|
737
|
-
return;
|
|
738
|
-
}
|
|
739
|
-
const { id } = params;
|
|
740
|
-
// Scoped: "ensure absent" stays idempotent for an id this model simply
|
|
741
|
-
// doesn't hold, but an id owned by a sibling model throws rather than
|
|
742
|
-
// deleting a row the caller never addressed.
|
|
743
|
-
const model = ownRowOrThrow(id);
|
|
744
|
-
// Idempotent delete: "ensure absent". A row that isn't in this client's
|
|
745
|
-
// replicated view is already gone from its perspective, so a delete is a
|
|
746
|
-
// no-op success rather than an `entity_not_found` error. This matches the
|
|
747
|
-
// HTTP client and makes delete safe to retry or race (two actors deleting
|
|
748
|
-
// the same row).
|
|
749
|
-
if (!model)
|
|
750
|
-
return;
|
|
751
|
-
const claimed = activeClaims.get(id);
|
|
752
|
-
const opts = mutationOptions(params);
|
|
753
|
-
const handle = isClaimHandle(params.claim) ? params.claim : undefined;
|
|
754
|
-
const effective = claimed
|
|
755
|
-
? {
|
|
756
|
-
wait: 'confirmed',
|
|
757
|
-
readAt: claimed.snapshot.stamp,
|
|
758
|
-
onStale: 'reject',
|
|
759
|
-
claimRef: { id: claimed.lease.id },
|
|
760
|
-
...(claimed.lease.fenceToken !== undefined
|
|
761
|
-
? { fenceToken: claimed.lease.fenceToken }
|
|
762
|
-
: {}),
|
|
763
|
-
...opts,
|
|
764
|
-
}
|
|
765
|
-
: {
|
|
766
|
-
...(handle?.readAt !== undefined
|
|
767
|
-
? {
|
|
768
|
-
wait: 'confirmed',
|
|
769
|
-
readAt: handle.readAt,
|
|
770
|
-
onStale: 'reject',
|
|
771
|
-
}
|
|
772
|
-
: {}),
|
|
773
|
-
...opts,
|
|
774
|
-
...(handle ? { claim: { id: handle.id } } : {}),
|
|
775
|
-
};
|
|
776
|
-
syncClient.delete(model, effective);
|
|
777
|
-
await waitForMutation(model, effective);
|
|
778
|
-
}),
|
|
779
|
-
// `claim` is a callable namespace (take a claim) carrying the coordination
|
|
780
|
-
// readers (`claim.state` / `claim.queue` / `claim.release` / `claim.reorder`).
|
|
781
|
-
claim: claimApi,
|
|
782
|
-
track: guard(async (params) => {
|
|
783
|
-
const dep = {
|
|
784
|
-
model: wireModel,
|
|
785
|
-
id: params.id,
|
|
786
|
-
...(params.readAt !== undefined ? { readAt: params.readAt } : {}),
|
|
787
|
-
};
|
|
788
|
-
// A track carries no write, so it rides the commit lane as a zero-operation
|
|
789
|
-
// commit: the queue tolerates disconnects and de-dupes replays, and the
|
|
790
|
-
// server's track-only path registers the premise and reports anything
|
|
791
|
-
// that already fired. Reuse the same lane the batch `commits.create` door
|
|
792
|
-
// uses rather than opening a bespoke transport.
|
|
793
|
-
const clientTxId = typeof crypto !== 'undefined' && typeof crypto.randomUUID === 'function'
|
|
794
|
-
? crypto.randomUUID()
|
|
795
|
-
: `tx_${Date.now()}_${Math.random().toString(36).slice(2, 10)}`;
|
|
796
|
-
const queue = syncClient.getMutationQueue();
|
|
797
|
-
await queue.enqueueCommit(clientTxId, [], { track: [dep] });
|
|
798
|
-
const { notifications } = await queue.waitForCommitReceipt(clientTxId);
|
|
799
|
-
return notifications && notifications.length > 0 ? { notifications } : {};
|
|
800
|
-
}),
|
|
801
|
-
join: guard((ids, options) => {
|
|
802
|
-
if (!collaboration?.createJoin) {
|
|
803
|
-
throw new AbloValidationError(`Model "${schemaKey}" was built without a WebSocket runtime, so join() is unavailable here. Presence needs a live socket — use the standard Ablo({ schema, apiKey }) client (not the HTTP transport).`, { code: 'model_join_not_configured' });
|
|
804
|
-
}
|
|
805
|
-
return collaboration.createJoin(schemaKey, ids, options);
|
|
806
|
-
}),
|
|
807
|
-
onChange(callback, options) {
|
|
808
|
-
return autorun(() => {
|
|
809
|
-
callback(local.list(options));
|
|
810
|
-
});
|
|
811
|
-
},
|
|
812
|
-
};
|
|
813
|
-
modelClientMeta.set(operations, {
|
|
814
|
-
key: schemaKey,
|
|
815
|
-
typename: registeredModelName,
|
|
816
|
-
});
|
|
817
|
-
return operations;
|
|
818
|
-
}
|