@abloatai/ablo 0.34.1 → 0.36.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 -1
- package/CHANGELOG.md +758 -5
- package/README.md +56 -502
- package/bin/ablo.cjs +39 -0
- package/dist/BaseSyncedStore.d.ts +176 -48
- package/dist/BaseSyncedStore.js +346 -214
- package/dist/Database.d.ts +17 -44
- package/dist/Database.js +96 -79
- package/dist/InstanceCache.d.ts +31 -6
- package/dist/InstanceCache.js +65 -30
- package/dist/LazyReferenceCollection.d.ts +3 -3
- package/dist/LazyReferenceCollection.js +4 -4
- package/dist/Model.d.ts +23 -13
- package/dist/Model.js +27 -17
- package/dist/ModelRegistry.d.ts +8 -4
- package/dist/ModelRegistry.js +20 -18
- package/dist/NetworkMonitor.d.ts +3 -1
- package/dist/NetworkMonitor.js +7 -5
- package/dist/{SyncEngineContext.d.ts → RuntimeContext.d.ts} +20 -13
- package/dist/{SyncEngineContext.js → RuntimeContext.js} +11 -12
- package/dist/SyncClient.d.ts +47 -47
- package/dist/SyncClient.js +215 -156
- package/dist/ai-sdk/coordinatedTool.d.ts +2 -2
- package/dist/ai-sdk/coordinatedTool.js +1 -1
- package/dist/ai-sdk/coordinationContext.d.ts +2 -2
- package/dist/ai-sdk/coordinationContext.js +1 -1
- package/dist/ai-sdk/wrap.d.ts +3 -3
- package/dist/ai-sdk/wrap.js +2 -2
- package/dist/auth/index.d.ts +1 -156
- package/dist/auth/index.js +8 -301
- package/dist/client/Ablo.d.ts +42 -287
- package/dist/client/Ablo.js +129 -963
- package/dist/client/abloClient.d.ts +309 -0
- package/dist/client/abloClient.js +13 -0
- package/dist/client/clientPrelude.d.ts +52 -0
- package/dist/client/clientPrelude.js +60 -0
- package/dist/client/consoleLogger.d.ts +2 -2
- package/dist/client/coreClient.d.ts +60 -0
- package/dist/client/coreClient.js +118 -0
- package/dist/client/createInternalComponents.d.ts +8 -4
- package/dist/client/createInternalComponents.js +17 -10
- package/dist/client/createModelProxy.d.ts +98 -373
- package/dist/client/createModelProxy.js +233 -139
- package/dist/client/humans.d.ts +69 -0
- package/dist/client/humans.js +78 -0
- package/dist/client/modelRegistration.d.ts +1 -1
- package/dist/client/modelRegistration.js +9 -9
- package/dist/client/options.d.ts +73 -17
- package/dist/client/reactiveEngine.d.ts +53 -0
- package/dist/client/reactiveEngine.js +688 -0
- package/dist/client/resourceTypes.d.ts +9 -250
- package/dist/client/resourceTypes.js +8 -5
- package/dist/client/schemaConfig.d.ts +4 -4
- package/dist/client/schemaConfig.js +6 -2
- package/dist/client/storeCluster.d.ts +47 -0
- package/dist/client/storeCluster.js +118 -0
- package/dist/client/storeLifecycle.d.ts +61 -0
- package/dist/client/storeLifecycle.js +231 -0
- package/dist/client/validateAbloOptions.d.ts +3 -2
- package/dist/client/validateAbloOptions.js +1 -1
- package/dist/client/wsMutationExecutor.d.ts +3 -3
- package/dist/client/wsMutationExecutor.js +3 -3
- package/dist/context.d.ts +22 -9
- package/dist/context.js +33 -9
- package/dist/coordination/ClaimLog.d.ts +26 -0
- package/dist/coordination/ClaimLog.js +32 -0
- package/dist/coordination/index.d.ts +1 -15
- package/dist/coordination/index.js +8 -31
- package/dist/core/index.d.ts +3 -3
- package/dist/core/index.js +2 -2
- package/dist/docs/catalog.d.ts +72 -0
- package/dist/docs/catalog.js +230 -0
- package/dist/docs/index.d.ts +10 -0
- package/dist/docs/index.js +10 -0
- package/dist/environment.d.ts +1 -40
- package/dist/environment.js +8 -37
- package/dist/index.d.ts +44 -36
- package/dist/index.js +30 -22
- package/dist/interfaces/index.d.ts +44 -134
- package/dist/keys/index.d.ts +1 -77
- package/dist/keys/index.js +8 -190
- package/dist/mutators/{RecordingTransaction.d.ts → RecordingMutation.d.ts} +4 -4
- package/dist/mutators/{RecordingTransaction.js → RecordingMutation.js} +2 -2
- package/dist/mutators/Transaction.d.ts +1 -1
- package/dist/mutators/Transaction.js +1 -1
- package/dist/mutators/UndoManager.d.ts +6 -6
- package/dist/mutators/UndoManager.js +5 -5
- package/dist/mutators/defineMutators.d.ts +3 -3
- package/dist/mutators/defineMutators.js +1 -1
- package/dist/mutators/inverseOp.js +2 -2
- package/dist/mutators/mutateActions.d.ts +3 -3
- package/dist/mutators/mutateActions.js +1 -1
- package/dist/mutators/readerActions.d.ts +1 -1
- package/dist/mutators/undoApply.d.ts +1 -1
- package/dist/mutators/undoApply.js +1 -1
- package/dist/policy/index.d.ts +2 -2
- package/dist/policy/index.js +1 -1
- package/dist/query/client.d.ts +5 -2
- package/dist/query/client.js +10 -9
- package/dist/query/types.d.ts +6 -41
- package/dist/query/types.js +2 -2
- package/dist/react/AbloProvider.d.ts +18 -8
- package/dist/react/AbloProvider.js +10 -9
- package/dist/react/context.d.ts +3 -3
- package/dist/react/context.js +1 -1
- package/dist/react/createAbloReact.d.ts +56 -0
- package/dist/react/createAbloReact.js +51 -0
- package/dist/react/index.d.ts +6 -5
- package/dist/react/index.js +6 -3
- package/dist/react/internalContext.d.ts +1 -1
- package/dist/react/useAblo.d.ts +12 -5
- package/dist/react/useAblo.js +26 -8
- package/dist/react/useCurrentUserId.js +1 -1
- package/dist/react/useErrorListener.js +1 -1
- package/dist/react/useMutationFailureListener.d.ts +2 -2
- package/dist/react/useMutationFailureListener.js +1 -1
- package/dist/react/useMutators.d.ts +3 -3
- package/dist/react/useMutators.js +3 -3
- package/dist/react/useUndoScope.d.ts +5 -5
- package/dist/react/useUndoScope.js +1 -1
- package/dist/schema/coordination.d.ts +69 -10
- package/dist/schema/coordination.js +90 -9
- package/dist/schema/ddl.js +2 -2
- package/dist/schema/diff.d.ts +1 -1
- package/dist/schema/generate.js +1 -1
- package/dist/schema/index.d.ts +11 -10
- package/dist/schema/index.js +22 -18
- package/dist/schema/queries.d.ts +27 -27
- package/dist/schema/queries.js +23 -23
- package/dist/schema/select.d.ts +3 -3
- package/dist/schema/select.js +6 -3
- package/dist/schema/serialize.d.ts +15 -6
- package/dist/schema/serialize.js +20 -3
- package/dist/schema/sugar.d.ts +6 -7
- package/dist/schema/sugar.js +9 -12
- package/dist/schema/syncDeltaRow.d.ts +4 -152
- package/dist/schema/syncDeltaRow.js +4 -105
- package/dist/server/adapter.d.ts +18 -1
- package/dist/server/commit.d.ts +10 -16
- package/dist/server/index.d.ts +1 -1
- package/dist/server/index.js +1 -1
- package/dist/server/readConfig.d.ts +1 -1
- package/dist/source/adapter.d.ts +7 -5
- package/dist/source/adapter.js +7 -5
- package/dist/source/adapters/drizzle.d.ts +1 -1
- package/dist/source/adapters/drizzle.js +2 -2
- package/dist/source/adapters/kysely.d.ts +1 -1
- package/dist/source/adapters/kysely.js +1 -1
- package/dist/source/adapters/kyselyMutationCore.d.ts +1 -1
- package/dist/source/adapters/kyselyMutationCore.js +2 -2
- package/dist/source/adapters/memory.js +1 -1
- package/dist/source/adapters/prisma.d.ts +8 -3
- package/dist/source/adapters/prisma.js +1 -1
- package/dist/source/connector.js +1 -1
- package/dist/source/connectorProtocol.d.ts +2 -8
- package/dist/source/connectorProtocol.js +3 -2
- package/dist/source/contract.d.ts +29 -17
- package/dist/source/contract.js +27 -22
- package/dist/source/factory.d.ts +1 -1
- package/dist/source/idempotency.js +2 -2
- package/dist/source/index.d.ts +1 -0
- package/dist/source/index.js +3 -0
- package/dist/source/next.d.ts +1 -1
- package/dist/source/signing.d.ts +9 -2
- package/dist/source/signing.js +4 -1
- package/dist/source/types.d.ts +6 -4
- package/dist/source/types.js +1 -1
- package/dist/{core/storeContract.d.ts → storeContract.d.ts} +6 -6
- package/dist/{core → stores}/DatabaseManager.d.ts +3 -1
- package/dist/{core → stores}/DatabaseManager.js +14 -13
- package/dist/stores/ObjectStore.d.ts +1 -1
- package/dist/{core → stores}/StoreManager.d.ts +9 -26
- package/dist/{core → stores}/StoreManager.js +29 -77
- package/dist/stores/SyncActionStore.d.ts +4 -2
- package/dist/stores/SyncActionStore.js +11 -17
- package/dist/stores/syncAction.d.ts +26 -0
- package/dist/stores/syncAction.js +16 -0
- package/dist/surface.d.ts +3 -3
- package/dist/surface.js +6 -4
- package/dist/sync/BootstrapFetcher.d.ts +127 -6
- package/dist/sync/BootstrapFetcher.js +511 -83
- package/dist/sync/ConnectionManager.d.ts +6 -198
- package/dist/sync/ConnectionManager.js +6 -677
- package/dist/sync/OnDemandLoader.d.ts +5 -2
- package/dist/sync/OnDemandLoader.js +61 -21
- package/dist/sync/SubscriptionManager.d.ts +13 -2
- package/dist/sync/SubscriptionManager.js +23 -5
- package/dist/sync/SyncWebSocket.d.ts +27 -510
- package/dist/sync/SyncWebSocket.js +76 -954
- package/dist/sync/awaitClaimGrant.d.ts +4 -44
- package/dist/sync/awaitClaimGrant.js +4 -109
- package/dist/sync/bootstrapApply.d.ts +3 -0
- package/dist/sync/bootstrapApply.js +2 -2
- package/dist/sync/commitFrames.d.ts +6 -40
- package/dist/sync/commitFrames.js +6 -97
- package/dist/sync/contextPorts.d.ts +18 -0
- package/dist/sync/contextPorts.js +31 -0
- package/dist/sync/createClaimStream.d.ts +5 -49
- package/dist/sync/createClaimStream.js +5 -469
- package/dist/sync/createPresenceStream.d.ts +26 -4
- package/dist/sync/createPresenceStream.js +28 -20
- package/dist/sync/createSnapshot.d.ts +2 -2
- package/dist/sync/createSnapshot.js +1 -1
- package/dist/sync/credentialLifecycle.d.ts +5 -173
- package/dist/sync/credentialLifecycle.js +5 -320
- package/dist/sync/deltaPipeline.d.ts +13 -12
- package/dist/sync/deltaPipeline.js +21 -4
- package/dist/sync/groupChange.d.ts +3 -0
- package/dist/sync/groupChange.js +16 -14
- package/dist/sync/participants.d.ts +24 -6
- package/dist/sync/participants.js +32 -23
- package/dist/sync/schemaDrift.d.ts +55 -0
- package/dist/sync/schemaDrift.js +53 -0
- package/dist/sync/schemas.d.ts +23 -33
- package/dist/sync/schemas.js +29 -20
- package/dist/sync/syncPlan.d.ts +3 -3
- package/dist/sync/wsFrameHandlers.d.ts +6 -114
- package/dist/sync/wsFrameHandlers.js +6 -392
- package/dist/syncLog/contract.d.ts +20 -0
- package/dist/syncLog/contract.js +19 -0
- package/dist/syncLog/index.d.ts +1 -0
- package/dist/syncLog/index.js +1 -0
- package/dist/transaction/ablo.d.ts +88 -0
- package/dist/transaction/ablo.js +33 -0
- package/dist/{client/auth.d.ts → transaction/auth/apiKey.d.ts} +43 -8
- package/dist/{client/auth.js → transaction/auth/apiKey.js} +19 -0
- package/dist/transaction/auth/bootstrapScope.d.ts +15 -0
- package/dist/transaction/auth/bootstrapScope.js +1 -0
- package/dist/transaction/auth/capability.d.ts +212 -0
- package/dist/transaction/auth/capability.js +224 -0
- package/dist/{auth → transaction/auth}/credentialSource.d.ts +8 -1
- package/dist/{client → transaction/auth}/identity.d.ts +8 -7
- package/dist/{client → transaction/auth}/identity.js +1 -1
- package/dist/transaction/auth/index.d.ts +162 -0
- package/dist/transaction/auth/index.js +304 -0
- package/dist/{auth → transaction/auth}/schemas.d.ts +1 -1
- package/dist/{auth → transaction/auth}/schemas.js +13 -13
- package/dist/{client → transaction/auth}/sessionMint.d.ts +8 -8
- package/dist/{client → transaction/auth}/sessionMint.js +4 -7
- package/dist/transaction/coordination/awaitClaimGrant.d.ts +56 -0
- package/dist/transaction/coordination/awaitClaimGrant.js +124 -0
- package/dist/{client → transaction/coordination}/claimHeartbeatLoop.d.ts +34 -0
- package/dist/{client → transaction/coordination}/claimHeartbeatLoop.js +20 -0
- package/dist/transaction/coordination/claimMeta.d.ts +49 -0
- package/dist/transaction/coordination/claimMeta.js +52 -0
- package/dist/transaction/coordination/createClaimStream.d.ts +64 -0
- package/dist/transaction/coordination/createClaimStream.js +475 -0
- package/dist/transaction/coordination/events.d.ts +74 -0
- package/dist/transaction/coordination/events.js +7 -0
- package/dist/transaction/coordination/index.d.ts +19 -0
- package/dist/transaction/coordination/index.js +45 -0
- package/dist/transaction/coordination/locator.d.ts +104 -0
- package/dist/transaction/coordination/locator.js +102 -0
- package/dist/transaction/coordination/schema.d.ts +1536 -0
- package/dist/transaction/coordination/schema.js +1177 -0
- package/dist/transaction/coordination/targetConflict.d.ts +2 -0
- package/dist/transaction/coordination/targetConflict.js +107 -0
- package/dist/{coordination → transaction/coordination}/trace.d.ts +7 -18
- package/dist/{coordination → transaction/coordination}/trace.js +18 -25
- package/dist/transaction/durableWrites.d.ts +62 -0
- package/dist/{client → transaction}/durableWrites.js +28 -3
- package/dist/transaction/environment.d.ts +105 -0
- package/dist/transaction/environment.js +108 -0
- package/dist/{errorCodes.d.ts → transaction/errorCodes.d.ts} +12 -12
- package/dist/{errorCodes.js → transaction/errorCodes.js} +45 -18
- package/dist/{errors.d.ts → transaction/errors.d.ts} +37 -13
- package/dist/{errors.js → transaction/errors.js} +85 -16
- package/dist/transaction/footprint.d.ts +111 -0
- package/dist/transaction/footprint.js +0 -0
- package/dist/transaction/index.d.ts +20 -0
- package/dist/transaction/index.js +20 -0
- package/dist/transaction/keys/index.d.ts +87 -0
- package/dist/transaction/keys/index.js +207 -0
- package/dist/transaction/log/syncDeltaRow.d.ts +158 -0
- package/dist/transaction/log/syncDeltaRow.js +95 -0
- package/dist/{sync/syncPosition.d.ts → transaction/logPosition.d.ts} +22 -8
- package/dist/{sync/syncPosition.js → transaction/logPosition.js} +15 -6
- package/dist/transaction/logger.d.ts +16 -0
- package/dist/transaction/logger.js +7 -0
- package/dist/transaction/observability.d.ts +53 -0
- package/dist/transaction/observability.js +19 -0
- package/dist/transaction/plugin.d.ts +285 -0
- package/dist/transaction/plugin.js +106 -0
- package/dist/{policy → transaction/policy}/types.d.ts +3 -3
- package/dist/{policy → transaction/policy}/types.js +2 -0
- package/dist/transaction/resources/httpResources.d.ts +321 -0
- package/dist/transaction/resources/httpResources.js +7 -0
- package/dist/transaction/resources/modelOperations.d.ts +427 -0
- package/dist/transaction/resources/modelOperations.js +12 -0
- package/dist/transaction/resources/mutationOptions.d.ts +66 -0
- package/dist/transaction/resources/mutationOptions.js +9 -0
- package/dist/transaction/resources/where.d.ts +101 -0
- package/dist/transaction/resources/where.js +115 -0
- package/dist/{client → transaction/resources}/writeOptionsSchema.d.ts +2 -6
- package/dist/{client → transaction/resources}/writeOptionsSchema.js +9 -5
- package/dist/{schema → transaction/schema}/field.d.ts +17 -23
- package/dist/{schema → transaction/schema}/field.js +5 -5
- package/dist/transaction/schema/fieldRef.d.ts +38 -0
- package/dist/transaction/schema/fieldRef.js +11 -0
- package/dist/transaction/schema/loadStrategy.d.ts +45 -0
- package/dist/transaction/schema/loadStrategy.js +46 -0
- package/dist/{schema → transaction/schema}/model.d.ts +50 -35
- package/dist/{schema → transaction/schema}/model.js +30 -20
- package/dist/transaction/schema/openapi.d.ts +58 -0
- package/dist/transaction/schema/openapi.js +501 -0
- package/dist/{schema → transaction/schema}/relation.d.ts +21 -16
- package/dist/{schema → transaction/schema}/relation.js +7 -7
- package/dist/{schema → transaction/schema}/residency.d.ts +0 -9
- package/dist/{schema → transaction/schema}/residency.js +0 -5
- package/dist/{schema → transaction/schema}/roles.d.ts +5 -5
- package/dist/{schema → transaction/schema}/roles.js +5 -5
- package/dist/{schema → transaction/schema}/schema.d.ts +39 -10
- package/dist/{schema → transaction/schema}/schema.js +24 -3
- package/dist/{schema → transaction/schema}/tenancy.d.ts +1 -1
- package/dist/{schema → transaction/schema}/tenancy.js +7 -4
- package/dist/transaction/transactionLayer.d.ts +82 -0
- package/dist/transaction/transactionLayer.js +24 -0
- package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.d.ts +5 -6
- package/dist/{transactions → transaction/transactions/settlement}/commitEnvelope.js +9 -13
- package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.d.ts +9 -2
- package/dist/{transactions → transaction/transactions/settlement}/httpCommitEnvelope.js +5 -9
- package/dist/{transactions/durableWriteStore.d.ts → transaction/transactions/settlement/pendingWrite.d.ts} +11 -37
- package/dist/transaction/transactions/settlement/pendingWrite.js +20 -0
- package/dist/transaction/transport/commitFrames.d.ts +90 -0
- package/dist/transaction/transport/commitFrames.js +134 -0
- package/dist/transaction/transport/connectionManager.d.ts +215 -0
- package/dist/transaction/transport/connectionManager.js +673 -0
- package/dist/transaction/transport/credentialLifecycle.d.ts +177 -0
- package/dist/transaction/transport/credentialLifecycle.js +324 -0
- package/dist/{sync → transaction/transport}/heartbeat.d.ts +3 -1
- package/dist/{sync → transaction/transport}/heartbeat.js +6 -4
- package/dist/transaction/transport/httpClient.d.ts +131 -0
- package/dist/{client → transaction/transport}/httpClient.js +6 -5
- package/dist/transaction/transport/httpOptions.d.ts +33 -0
- package/dist/transaction/transport/httpOptions.js +12 -0
- package/dist/{client → transaction/transport}/httpTransport.js +295 -97
- package/dist/{sync/NetworkProbe.d.ts → transaction/transport/networkProbe.d.ts} +7 -4
- package/dist/{sync/NetworkProbe.js → transaction/transport/networkProbe.js} +14 -13
- package/dist/transaction/transport/wsFrameHandlers.d.ts +128 -0
- package/dist/transaction/transport/wsFrameHandlers.js +429 -0
- package/dist/transaction/transport/wsTransport.d.ts +574 -0
- package/dist/transaction/transport/wsTransport.js +1023 -0
- package/dist/transaction/types/assertExact.d.ts +17 -0
- package/dist/transaction/types/assertExact.js +1 -0
- package/dist/{types → transaction/types}/global.d.ts +17 -2
- package/dist/{types → transaction/types}/global.js +2 -1
- package/dist/{types → transaction/types}/index.d.ts +14 -46
- package/dist/{types → transaction/types}/index.js +7 -16
- package/dist/{types → transaction/types}/streams.d.ts +73 -45
- package/dist/transaction/utils/duration.d.ts +50 -0
- package/dist/{utils → transaction/utils}/duration.js +32 -0
- package/dist/{utils → transaction/utils}/json.d.ts +18 -0
- package/dist/transaction/utils/json.js +276 -0
- package/dist/transaction/wire/accountResponses.d.ts +420 -0
- package/dist/transaction/wire/accountResponses.js +290 -0
- package/dist/transaction/wire/auth.d.ts +56 -0
- package/dist/transaction/wire/auth.js +63 -0
- package/dist/transaction/wire/claimEvent.d.ts +76 -0
- package/dist/transaction/wire/claimEvent.js +73 -0
- package/dist/transaction/wire/claims.d.ts +530 -0
- package/dist/transaction/wire/claims.js +327 -0
- package/dist/{wire → transaction/wire}/commit.d.ts +125 -193
- package/dist/{wire → transaction/wire}/commit.js +68 -47
- package/dist/{wire → transaction/wire}/delta.d.ts +66 -17
- package/dist/{wire → transaction/wire}/delta.js +37 -13
- package/dist/transaction/wire/errorEnvelope.d.ts +72 -0
- package/dist/{wire → transaction/wire}/errorEnvelope.js +36 -5
- package/dist/transaction/wire/feedCursor.d.ts +60 -0
- package/dist/transaction/wire/feedCursor.js +82 -0
- package/dist/transaction/wire/feedEvent.d.ts +204 -0
- package/dist/transaction/wire/feedEvent.js +65 -0
- package/dist/transaction/wire/frames.d.ts +194 -0
- package/dist/transaction/wire/frames.js +50 -0
- package/dist/transaction/wire/inboundFrames.d.ts +562 -0
- package/dist/transaction/wire/inboundFrames.js +116 -0
- package/dist/transaction/wire/index.d.ts +54 -0
- package/dist/transaction/wire/index.js +83 -0
- package/dist/{wire → transaction/wire}/listEnvelope.d.ts +13 -14
- package/dist/transaction/wire/listEnvelope.js +42 -0
- package/dist/transaction/wire/modelMutations.d.ts +31 -0
- package/dist/transaction/wire/modelMutations.js +52 -0
- package/dist/transaction/wire/modelResponses.d.ts +85 -0
- package/dist/transaction/wire/modelResponses.js +43 -0
- package/dist/transaction/wire/modelShape.d.ts +78 -0
- package/dist/transaction/wire/modelShape.js +74 -0
- package/dist/transactions/{TransactionQueue.d.ts → mutations/MutationQueue.d.ts} +85 -38
- package/dist/transactions/{TransactionQueue.js → mutations/MutationQueue.js} +141 -80
- package/dist/transactions/{TransactionStore.d.ts → mutations/MutationStore.d.ts} +8 -8
- package/dist/transactions/{TransactionStore.js → mutations/MutationStore.js} +2 -2
- package/dist/transactions/{coalesceRules.d.ts → mutations/coalesceRules.d.ts} +10 -10
- package/dist/transactions/{coalesceRules.js → mutations/coalesceRules.js} +1 -1
- package/dist/transactions/mutations/commitLatency.d.ts +52 -0
- package/dist/transactions/mutations/commitLatency.js +130 -0
- package/dist/transactions/{commitOutboxStore.d.ts → mutations/commitOutboxStore.d.ts} +1 -5
- package/dist/transactions/{commitOutboxStore.js → mutations/commitOutboxStore.js} +1 -1
- package/dist/transactions/{commitPayload.d.ts → mutations/commitPayload.d.ts} +18 -16
- package/dist/transactions/{commitPayload.js → mutations/commitPayload.js} +15 -15
- package/dist/transactions/{deltaConfirmation.d.ts → mutations/deltaConfirmation.d.ts} +15 -11
- package/dist/transactions/{deltaConfirmation.js → mutations/deltaConfirmation.js} +14 -12
- package/dist/transactions/mutations/durableWriteStore.d.ts +14 -0
- package/dist/transactions/mutations/durableWriteStore.js +12 -0
- package/dist/transactions/{optimisticApply.d.ts → mutations/optimisticApply.d.ts} +7 -7
- package/dist/transactions/{replayValidation.d.ts → mutations/replayValidation.d.ts} +4 -3
- package/dist/transactions/{replayValidation.js → mutations/replayValidation.js} +7 -5
- package/dist/utils/mobxSetup.d.ts +1 -1
- package/dist/utils/mobxSetup.js +5 -2
- package/dist/{core → views}/QueryView.d.ts +2 -2
- package/dist/{core → views}/QueryView.js +2 -2
- package/dist/{core → views}/ViewRegistry.d.ts +1 -1
- package/dist/{core/queryUtils.d.ts → views/incrementalView.d.ts} +6 -6
- package/dist/{core/queryUtils.js → views/incrementalView.js} +6 -6
- package/dist/webhooks/events.d.ts +2 -2
- package/dist/wire/index.d.ts +1 -34
- package/dist/wire/index.js +8 -49
- package/docs/agent-messaging.md +3 -3
- package/docs/agents.md +20 -13
- package/docs/api-keys.md +14 -10
- package/docs/api.md +27 -61
- package/docs/audit.md +6 -3
- package/docs/cli.md +41 -13
- package/docs/client-behavior.md +11 -9
- package/docs/concurrency-convention.md +49 -57
- package/docs/coordination.md +283 -121
- package/docs/data-sources.md +7 -5
- package/docs/debugging.md +39 -15
- package/docs/deployment.md +267 -0
- package/docs/examples/agent-human.md +49 -42
- package/docs/examples/ai-sdk-tool.md +69 -44
- package/docs/examples/existing-python-backend.md +8 -6
- package/docs/examples/nextjs.md +129 -47
- package/docs/examples/scoped-agent.md +46 -45
- package/docs/examples/server-agent.md +46 -26
- package/docs/groups.md +87 -30
- package/docs/guarantees.md +41 -12
- package/docs/how-it-works.md +38 -12
- package/docs/idempotency.md +126 -0
- package/docs/identity.md +77 -74
- package/docs/index.md +172 -86
- package/docs/integration-guide.md +31 -19
- package/docs/mcp.md +46 -21
- package/docs/migration.md +95 -18
- package/docs/operating-on-your-database.md +3 -1
- package/docs/projects.md +3 -1
- package/docs/quickstart.md +22 -5
- package/docs/react.md +31 -18
- package/docs/schema-contract.md +5 -3
- package/docs/session-settings.md +108 -0
- package/docs/sessions.md +4 -2
- package/docs/webhooks.md +12 -10
- package/llms.txt +48 -18
- package/package.json +21 -26
- package/dist/agent/Agent.d.ts +0 -366
- package/dist/agent/Agent.js +0 -514
- package/dist/agent/index.d.ts +0 -115
- package/dist/agent/index.js +0 -128
- package/dist/agent/session.d.ts +0 -93
- package/dist/agent/session.js +0 -149
- package/dist/agent/types.d.ts +0 -68
- package/dist/agent/types.js +0 -9
- package/dist/cli.cjs +0 -286329
- package/dist/client/durableWrites.d.ts +0 -21
- package/dist/client/httpClient.d.ts +0 -80
- package/dist/coordination/schema.d.ts +0 -722
- package/dist/coordination/schema.js +0 -578
- package/dist/schema/openapi.d.ts +0 -29
- package/dist/schema/openapi.js +0 -124
- 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/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 -192
- 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 -71
- 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/transactions/durableWriteStore.js +0 -30
- package/dist/utils/duration.d.ts +0 -25
- package/dist/utils/json.js +0 -88
- package/dist/wire/errorEnvelope.d.ts +0 -55
- package/dist/wire/frames.d.ts +0 -197
- package/dist/wire/frames.js +0 -49
- package/dist/wire/listEnvelope.js +0 -18
- package/docs/interaction-model.md +0 -97
- /package/dist/{core → query}/QueryProcessor.d.ts +0 -0
- /package/dist/{core → query}/QueryProcessor.js +0 -0
- /package/dist/{core/storeContract.js → storeContract.js} +0 -0
- /package/dist/{core → stores}/openIDBWithTimeout.d.ts +0 -0
- /package/dist/{core → stores}/openIDBWithTimeout.js +0 -0
- /package/dist/{client → transaction/auth}/credentialEndpoint.d.ts +0 -0
- /package/dist/{client → transaction/auth}/credentialEndpoint.js +0 -0
- /package/dist/{auth → transaction/auth}/credentialPolicy.d.ts +0 -0
- /package/dist/{auth → transaction/auth}/credentialPolicy.js +0 -0
- /package/dist/{auth → transaction/auth}/credentialSource.js +0 -0
- /package/dist/{client → transaction/auth}/hostedEndpoints.d.ts +0 -0
- /package/dist/{client → transaction/auth}/hostedEndpoints.js +0 -0
- /package/dist/{client → transaction}/persistence.d.ts +0 -0
- /package/dist/{client → transaction}/persistence.js +0 -0
- /package/dist/{client → transaction/resources}/functionalUpdate.d.ts +0 -0
- /package/dist/{client → transaction/resources}/functionalUpdate.js +0 -0
- /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.d.ts +0 -0
- /package/dist/{transactions → transaction/transactions/settlement}/idempotencyKey.js +0 -0
- /package/dist/{client → transaction/transport}/httpTransport.d.ts +0 -0
- /package/dist/{types → transaction/types}/modelData.d.ts +0 -0
- /package/dist/{types → transaction/types}/modelData.js +0 -0
- /package/dist/{types → transaction/types}/participant.d.ts +0 -0
- /package/dist/{types → transaction/types}/participant.js +0 -0
- /package/dist/{types → transaction/types}/streams.js +0 -0
- /package/dist/{utils → transaction/utils}/asyncIterator.d.ts +0 -0
- /package/dist/{utils → transaction/utils}/asyncIterator.js +0 -0
- /package/dist/{wire → transaction/wire}/bootstrapReason.d.ts +0 -0
- /package/dist/{wire → transaction/wire}/bootstrapReason.js +0 -0
- /package/dist/{wire → transaction/wire}/protocol.d.ts +0 -0
- /package/dist/{wire → transaction/wire}/protocol.js +0 -0
- /package/dist/{wire → transaction/wire}/protocolVersion.d.ts +0 -0
- /package/dist/{wire → transaction/wire}/protocolVersion.js +0 -0
- /package/dist/transactions/{UnconfirmedWrites.d.ts → mutations/UnconfirmedWrites.d.ts} +0 -0
- /package/dist/transactions/{UnconfirmedWrites.js → mutations/UnconfirmedWrites.js} +0 -0
- /package/dist/transactions/{optimisticApply.js → mutations/optimisticApply.js} +0 -0
- /package/dist/{core → views}/ViewRegistry.js +0 -0
|
@@ -30,13 +30,13 @@
|
|
|
30
30
|
* necessarily lands above our acknowledgement and still rejects as stale.
|
|
31
31
|
*
|
|
32
32
|
* The validation schema is the state shape: the class holds exactly one
|
|
33
|
-
* {@link
|
|
34
|
-
* and restore share that shape and {@link
|
|
33
|
+
* {@link LogPositionSnapshot} and merges monotonically into it, so snapshot
|
|
34
|
+
* and restore share that shape and {@link parseLogPosition} is the single gate
|
|
35
35
|
* for anything loaded from disk — a corrupted cursor stored "ahead of reality"
|
|
36
36
|
* being a known failure mode.
|
|
37
37
|
*/
|
|
38
38
|
import { z } from 'zod';
|
|
39
|
-
export const
|
|
39
|
+
export const logPositionSchema = z.object({
|
|
40
40
|
/** The resume cursor; advances only after deltas persist to durable local storage. */
|
|
41
41
|
persisted: z.number().int().nonnegative(),
|
|
42
42
|
/** The in-memory cursor: the last delta applied to the object pool. */
|
|
@@ -56,8 +56,8 @@ export const syncPositionSchema = z.object({
|
|
|
56
56
|
* Validates an untrusted value, such as one loaded from disk, into a position
|
|
57
57
|
* snapshot, or returns null when it does not match the schema.
|
|
58
58
|
*/
|
|
59
|
-
export function
|
|
60
|
-
const result =
|
|
59
|
+
export function parseLogPosition(value) {
|
|
60
|
+
const result = logPositionSchema.safeParse(value);
|
|
61
61
|
return result.success ? result.data : null;
|
|
62
62
|
}
|
|
63
63
|
const ZERO = { persisted: 0, applied: 0, acked: 0 };
|
|
@@ -73,7 +73,7 @@ function advance(state, next) {
|
|
|
73
73
|
* The live sync position: one instance per client. Three producers each
|
|
74
74
|
* advance their own cursor, and consumers read the result.
|
|
75
75
|
*/
|
|
76
|
-
export class
|
|
76
|
+
export class LogPosition {
|
|
77
77
|
#state = ZERO;
|
|
78
78
|
/** Returns a copy of the current state in the schema's shape. */
|
|
79
79
|
snapshot() {
|
|
@@ -114,3 +114,12 @@ export class SyncPosition {
|
|
|
114
114
|
this.#state = advance(this.#state, snapshot);
|
|
115
115
|
}
|
|
116
116
|
}
|
|
117
|
+
// ── Deprecated aliases (renamed from the sync/syncPosition module, 2026-07-17) ──
|
|
118
|
+
// The position is a participant's place in the transaction log; the old names
|
|
119
|
+
// said the consumer. Same class, same instanceof identity. Removed in 0.36.0.
|
|
120
|
+
/** @deprecated Renamed to {@link logPositionSchema}. Removed in 0.36.0. */
|
|
121
|
+
export const syncPositionSchema = logPositionSchema;
|
|
122
|
+
/** @deprecated Renamed to {@link parseLogPosition}. Removed in 0.36.0. */
|
|
123
|
+
export const parseSyncPosition = parseLogPosition;
|
|
124
|
+
/** @deprecated Renamed to {@link LogPosition}. Removed in 0.36.0. */
|
|
125
|
+
export const SyncPosition = LogPosition;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The logging port the SDK writes through.
|
|
3
|
+
*
|
|
4
|
+
* A contract with no framework and no local state: credential exchange, commit,
|
|
5
|
+
* and claim all need to log with no UI and no offline store present, so the port
|
|
6
|
+
* belongs to the settlement core (ADR 0016). The consumer supplies the
|
|
7
|
+
* implementation; the SDK ships a no-op default.
|
|
8
|
+
*/
|
|
9
|
+
export interface Logger {
|
|
10
|
+
debug(message: string, ...args: unknown[]): void;
|
|
11
|
+
info(message: string, ...args: unknown[]): void;
|
|
12
|
+
warn(message: string, ...args: unknown[]): void;
|
|
13
|
+
error(message: string, ...args: unknown[]): void;
|
|
14
|
+
}
|
|
15
|
+
/** The no-op default — what the core logs through when no logger is wired. */
|
|
16
|
+
export declare const noopLogger: Logger;
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The observability the settlement core reports on its own behalf.
|
|
3
|
+
*
|
|
4
|
+
* Coordination outcomes — a claim changing state, a stale-write collision that
|
|
5
|
+
* notified instead of aborting — happen with no UI and no local store anywhere,
|
|
6
|
+
* so the core must be able to report them without depending on the consumer's
|
|
7
|
+
* full provider (ADR 0016).
|
|
8
|
+
*
|
|
9
|
+
* This is deliberately the narrow set the core actually calls today. Widening it
|
|
10
|
+
* later is non-breaking; the reactive engine's `ObservabilityProvider` extends
|
|
11
|
+
* this interface, so a single implementation still satisfies both.
|
|
12
|
+
*/
|
|
13
|
+
import type { ClaimEvent, ConflictEvent } from './coordination/events.js';
|
|
14
|
+
export interface CoordinationObservability {
|
|
15
|
+
/** Capture a claim state change (acquired / queued / granted / lost / rejected / expired). */
|
|
16
|
+
captureClaim(event: ClaimEvent): void;
|
|
17
|
+
/** Capture a notify-instead-of-abort stale-write collision. */
|
|
18
|
+
captureConflict(event: ConflictEvent): void;
|
|
19
|
+
}
|
|
20
|
+
/** Breadcrumb severity levels */
|
|
21
|
+
export type BreadcrumbLevel = 'debug' | 'info' | 'warning' | 'error';
|
|
22
|
+
/** Breadcrumb categories for sync engine lifecycle events */
|
|
23
|
+
export type BreadcrumbCategory = 'sync.bootstrap' | 'sync.transaction' | 'sync.websocket' | 'sync.offline' | 'sync.database' | 'sync.conflict' | 'sync.coordination' | 'sync.groups';
|
|
24
|
+
export interface WebSocketErrorDetails {
|
|
25
|
+
context: string;
|
|
26
|
+
error?: string;
|
|
27
|
+
code?: number;
|
|
28
|
+
reason?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* The observability the duplex transport reports on its own behalf: connection
|
|
32
|
+
* lifecycle breadcrumbs and socket errors. A server-side agent holding a socket
|
|
33
|
+
* for claim push has no store and no UI, so the transport must be able to
|
|
34
|
+
* report without the consumer's full provider — the same reasoning as
|
|
35
|
+
* {@link CoordinationObservability}, one layer down. The reactive engine's
|
|
36
|
+
* `ObservabilityProvider` extends this interface, so a single implementation
|
|
37
|
+
* satisfies both.
|
|
38
|
+
*/
|
|
39
|
+
export interface TransportObservability {
|
|
40
|
+
/** Add a breadcrumb for sync lifecycle events */
|
|
41
|
+
breadcrumb(message: string, category: BreadcrumbCategory, level?: BreadcrumbLevel, data?: Record<string, string | number | boolean | undefined>): void;
|
|
42
|
+
/** Capture WebSocket error */
|
|
43
|
+
captureWebSocketError(details: WebSocketErrorDetails): void;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Everything the duplex transport reports: its own lifecycle
|
|
47
|
+
* ({@link TransportObservability}) plus the coordination outcomes that ride
|
|
48
|
+
* the socket ({@link CoordinationObservability} — claim pushes and notified
|
|
49
|
+
* collisions arrive as frames, so the transport is where they surface).
|
|
50
|
+
*/
|
|
51
|
+
export type SocketObservability = TransportObservability & CoordinationObservability;
|
|
52
|
+
/** The no-op default — what the transport reports through when nothing is wired. */
|
|
53
|
+
export declare const noopSocketObservability: SocketObservability;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The observability the settlement core reports on its own behalf.
|
|
3
|
+
*
|
|
4
|
+
* Coordination outcomes — a claim changing state, a stale-write collision that
|
|
5
|
+
* notified instead of aborting — happen with no UI and no local store anywhere,
|
|
6
|
+
* so the core must be able to report them without depending on the consumer's
|
|
7
|
+
* full provider (ADR 0016).
|
|
8
|
+
*
|
|
9
|
+
* This is deliberately the narrow set the core actually calls today. Widening it
|
|
10
|
+
* later is non-breaking; the reactive engine's `ObservabilityProvider` extends
|
|
11
|
+
* this interface, so a single implementation still satisfies both.
|
|
12
|
+
*/
|
|
13
|
+
/** The no-op default — what the transport reports through when nothing is wired. */
|
|
14
|
+
export const noopSocketObservability = {
|
|
15
|
+
breadcrumb() { },
|
|
16
|
+
captureWebSocketError() { },
|
|
17
|
+
captureClaim() { },
|
|
18
|
+
captureConflict() { },
|
|
19
|
+
};
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The plugin contract (ADR 0016).
|
|
3
|
+
*
|
|
4
|
+
* The core is `commit` · `get`/`list` · `observe` · `claim` · auth. Everything
|
|
5
|
+
* else a caller might want — a local materialised copy, presence rendering,
|
|
6
|
+
* batching, framework bindings — is a plugin declared in one list, so a server
|
|
7
|
+
* or an agent installs only what it asked for.
|
|
8
|
+
*
|
|
9
|
+
* Every plugin has the same shape on purpose. Uniformity is what makes the list
|
|
10
|
+
* composable and the types inferable; bespoke plugins would reproduce today's
|
|
11
|
+
* nineteen export subpaths with extra ceremony.
|
|
12
|
+
*
|
|
13
|
+
* Where this shape came from, and the field-by-field reasoning behind it, is
|
|
14
|
+
* recorded in ADR 0016 — the contract itself only states what each field does.
|
|
15
|
+
*/
|
|
16
|
+
import type { ParticipantKind } from './types/participant.js';
|
|
17
|
+
import type { ErrorCodeSpec } from './errorCodes.js';
|
|
18
|
+
import type { Logger } from './logger.js';
|
|
19
|
+
import type { CoordinationObservability } from './observability.js';
|
|
20
|
+
import type { WsTransport } from './transport/wsTransport.js';
|
|
21
|
+
import type { AuthCredentialSource } from './auth/credentialSource.js';
|
|
22
|
+
import type { SyncDeltaWireCore } from './wire/delta.js';
|
|
23
|
+
import type { ModelData } from './types/modelData.js';
|
|
24
|
+
/**
|
|
25
|
+
* A string type that keeps literal inference alive: `id: 'humans'` stays the
|
|
26
|
+
* literal `'humans'` through object-literal inference instead of widening to
|
|
27
|
+
* `string`, which is what lets {@link InstalledSurface} key a plugin list's
|
|
28
|
+
* surface by id.
|
|
29
|
+
*/
|
|
30
|
+
export type LiteralString = '' | (string & Record<never, never>);
|
|
31
|
+
/**
|
|
32
|
+
* The ordered stages a delta passes through on its way from the feed into
|
|
33
|
+
* whatever is watching. A plugin names the one it attaches to.
|
|
34
|
+
*
|
|
35
|
+
* The order is not a convention — it is a correctness constraint. `acknowledge`
|
|
36
|
+
* must follow `persist`, because acknowledging the input range rather than the
|
|
37
|
+
* persisted high-water mark advances the server's cursor past deltas that never
|
|
38
|
+
* committed, and the next catch-up then answers "you're up to date" for a delta
|
|
39
|
+
* that was lost. Declaring the stage keeps that ordering out of array position,
|
|
40
|
+
* where it would be load-bearing and undocumented.
|
|
41
|
+
*/
|
|
42
|
+
export type PipelineStage =
|
|
43
|
+
/** Deltas arrive from `observe()` and are queued. */
|
|
44
|
+
'receive'
|
|
45
|
+
/** Per-entity collapse of the queued batch. */
|
|
46
|
+
| 'dedupe'
|
|
47
|
+
/** The batch is written to durable local storage. */
|
|
48
|
+
| 'persist'
|
|
49
|
+
/** Persisted results land in the in-memory graph. */
|
|
50
|
+
| 'apply'
|
|
51
|
+
/** The cursor advances — gated on `persist`, never on the input range. */
|
|
52
|
+
| 'acknowledge'
|
|
53
|
+
/** Anything downstream reacts: re-render, presence, subscribers. */
|
|
54
|
+
| 'notify';
|
|
55
|
+
/** Canonical order. A plugin runner must run stages in this sequence. */
|
|
56
|
+
export declare const PIPELINE_STAGES: readonly PipelineStage[];
|
|
57
|
+
/**
|
|
58
|
+
* A delta as stage handlers receive it — the identity slice of the wire
|
|
59
|
+
* shape, projected rather than restated so the wire schema stays the one
|
|
60
|
+
* definition.
|
|
61
|
+
*/
|
|
62
|
+
export type StageDelta = Pick<SyncDeltaWireCore, 'id' | 'actionType' | 'modelName' | 'modelId'>;
|
|
63
|
+
/**
|
|
64
|
+
* One persisted change: what the durable write reported and the apply stage
|
|
65
|
+
* lands in the in-memory graph. `data` is absent for actions that carry
|
|
66
|
+
* none (a remove reports identity only).
|
|
67
|
+
*/
|
|
68
|
+
export interface AppliedChange {
|
|
69
|
+
action: 'add' | 'update' | 'remove' | 'archive' | 'verify';
|
|
70
|
+
modelName: string;
|
|
71
|
+
modelId: string;
|
|
72
|
+
data?: ModelData | null;
|
|
73
|
+
/**
|
|
74
|
+
* Server-stamped transaction id, echoing the client's own commit
|
|
75
|
+
* operation id — how a client recognizes the confirmation of a change it
|
|
76
|
+
* already applied locally. Absent for system-emitted changes, which have
|
|
77
|
+
* no client transaction behind them.
|
|
78
|
+
*/
|
|
79
|
+
transactionId?: string;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* What each stage hands its handlers. Read off the delta pipeline these
|
|
83
|
+
* stages were read off, not invented: `receive` sees the delta being
|
|
84
|
+
* queued, `dedupe` and `persist` see the batch at those boundaries,
|
|
85
|
+
* `apply` and `notify` see the persisted changes, and `acknowledge` sees
|
|
86
|
+
* the persistence-gated cursor value.
|
|
87
|
+
*/
|
|
88
|
+
export interface StagePayloads {
|
|
89
|
+
receive: {
|
|
90
|
+
readonly delta: StageDelta;
|
|
91
|
+
};
|
|
92
|
+
dedupe: {
|
|
93
|
+
readonly deltas: readonly StageDelta[];
|
|
94
|
+
};
|
|
95
|
+
persist: {
|
|
96
|
+
readonly deltas: readonly StageDelta[];
|
|
97
|
+
};
|
|
98
|
+
apply: {
|
|
99
|
+
readonly changes: readonly AppliedChange[];
|
|
100
|
+
};
|
|
101
|
+
acknowledge: {
|
|
102
|
+
readonly syncId: number;
|
|
103
|
+
};
|
|
104
|
+
notify: {
|
|
105
|
+
readonly changes: readonly AppliedChange[];
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
/** The handler a plugin attaches at one stage. The payload derives from the key. */
|
|
109
|
+
export type StageHandler<K extends PipelineStage> = (payload: StagePayloads[K]) => void;
|
|
110
|
+
/**
|
|
111
|
+
* What a capability needs from whatever transport was selected.
|
|
112
|
+
*
|
|
113
|
+
* Transport is a slot the caller fills, not a packaging axis, so a capability
|
|
114
|
+
* states its requirement and an incompatible pairing fails when the client is
|
|
115
|
+
* configured — with a typed error naming the plugin — rather than at runtime
|
|
116
|
+
* with a subscription that silently never delivers.
|
|
117
|
+
*/
|
|
118
|
+
export interface TransportCapabilities {
|
|
119
|
+
/**
|
|
120
|
+
* Requires a transport the server can initiate frames on. Live subscriptions,
|
|
121
|
+
* presence, and claim grants need this; commit and point-in-time reads do not.
|
|
122
|
+
*/
|
|
123
|
+
readonly duplex?: boolean;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* The core surface a plugin is handed at construction.
|
|
127
|
+
*
|
|
128
|
+
* Generic over the client's options type: the host instantiates it with its
|
|
129
|
+
* own options bag, so a plugin reads configuration without this package
|
|
130
|
+
* naming any consumer's types. Alongside the raw options, the context
|
|
131
|
+
* carries the values the host has already resolved (`participant`,
|
|
132
|
+
* `syncGroups`), so a plugin never re-derives identity.
|
|
133
|
+
*/
|
|
134
|
+
export interface PluginContext<Options = unknown> {
|
|
135
|
+
readonly logger: Logger;
|
|
136
|
+
readonly observability?: CoordinationObservability;
|
|
137
|
+
/** The client's own options bag, as the host received it. */
|
|
138
|
+
readonly options?: Options;
|
|
139
|
+
/**
|
|
140
|
+
* The live duplex connection. The host builds it during construction, so a
|
|
141
|
+
* plugin holds the thing rather than a function that fetches it: the
|
|
142
|
+
* connection object is stable for the client's lifetime — identity and
|
|
143
|
+
* read scope are seeded into it when they resolve, and reconnects replace
|
|
144
|
+
* only the socket inside it, never the object. Absent on a
|
|
145
|
+
* request-response client, which is what `requires: { duplex: true }`
|
|
146
|
+
* guards.
|
|
147
|
+
*/
|
|
148
|
+
readonly transport?: WsTransport;
|
|
149
|
+
/** The participant this client runs as, when known at construction. */
|
|
150
|
+
readonly participant?: {
|
|
151
|
+
readonly id: string;
|
|
152
|
+
readonly kind: ParticipantKind;
|
|
153
|
+
};
|
|
154
|
+
/** The connection's initial read scope (sync groups). */
|
|
155
|
+
readonly syncGroups?: readonly string[];
|
|
156
|
+
/** The resolved server base URL, settled by the host before construction. */
|
|
157
|
+
readonly url?: string;
|
|
158
|
+
/**
|
|
159
|
+
* The client's single bearer-credential source, shared with every
|
|
160
|
+
* auth-aware transport the host built. A plugin that constructs its own
|
|
161
|
+
* fetching component hands this on rather than re-deriving a credential.
|
|
162
|
+
*/
|
|
163
|
+
readonly auth?: AuthCredentialSource;
|
|
164
|
+
/**
|
|
165
|
+
* Whether a plugin with the given id is installed on this client. Supplied
|
|
166
|
+
* by {@link resolvePlugins} from the list it is resolving — the one place
|
|
167
|
+
* that truthfully knows the assembly — so a plugin interrogates what is
|
|
168
|
+
* installed instead of the host special-casing plugins by name.
|
|
169
|
+
*/
|
|
170
|
+
readonly hasPlugin?: (id: string) => boolean;
|
|
171
|
+
/**
|
|
172
|
+
* The resolved plugin list itself, supplied by {@link resolvePlugins}
|
|
173
|
+
* alongside {@link hasPlugin} (which derives from it). A component a
|
|
174
|
+
* plugin constructs — the store and its delta pipeline — holds this list
|
|
175
|
+
* to dispatch the declared stage handlers through {@link runStage}.
|
|
176
|
+
*/
|
|
177
|
+
readonly plugins?: readonly AbloPlugin[];
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* One installed capability.
|
|
181
|
+
*
|
|
182
|
+
* @typeParam Surface - what `init` contributes to the client. The plugin list's
|
|
183
|
+
* element types are what let the installed surface be inferred rather than
|
|
184
|
+
* declared.
|
|
185
|
+
*/
|
|
186
|
+
export interface AbloPlugin<Surface = unknown> {
|
|
187
|
+
/** Stable identity — deduplication, diagnostics, and error attribution.
|
|
188
|
+
* Literal-typed so a list's installed surface can be keyed by it. */
|
|
189
|
+
readonly id: LiteralString;
|
|
190
|
+
/** The plugin's own version, for diagnostics. */
|
|
191
|
+
readonly version?: string;
|
|
192
|
+
/** What this plugin needs from the transport. Checked at configuration time. */
|
|
193
|
+
readonly requires?: TransportCapabilities;
|
|
194
|
+
/**
|
|
195
|
+
* Whether this plugin keeps a local copy of rows.
|
|
196
|
+
*
|
|
197
|
+
* This is ADR 0013 §4's membership test as a declared, checkable property
|
|
198
|
+
* rather than a rule someone has to remember: a stateless caller can assert
|
|
199
|
+
* that nothing in its list materialises, and CI can assert the core's own
|
|
200
|
+
* list is uniformly `false`.
|
|
201
|
+
*/
|
|
202
|
+
readonly materialises: boolean;
|
|
203
|
+
/**
|
|
204
|
+
* Error codes this plugin may raise, folded into the registry.
|
|
205
|
+
*
|
|
206
|
+
* Registration is part of the contract because the error catalog is
|
|
207
|
+
* generated — a plugin that invents untyped errors would silently punch a
|
|
208
|
+
* hole in the published reference.
|
|
209
|
+
*/
|
|
210
|
+
readonly errorCodes?: Readonly<Record<string, ErrorCodeSpec>>;
|
|
211
|
+
/**
|
|
212
|
+
* The pipeline stages this plugin attaches to: each key names a stage and
|
|
213
|
+
* holds the handler the runner invokes there. One field on purpose — a
|
|
214
|
+
* declared stage cannot exist without its handler, nor a handler without
|
|
215
|
+
* its stage, so the declaration can never point at nothing. The payload
|
|
216
|
+
* type derives from the key ({@link StagePayloads}).
|
|
217
|
+
*/
|
|
218
|
+
readonly stages?: {
|
|
219
|
+
readonly [K in PipelineStage]?: StageHandler<K>;
|
|
220
|
+
};
|
|
221
|
+
/** Build the plugin's contribution to the client surface. */
|
|
222
|
+
init(context: PluginContext): Surface;
|
|
223
|
+
}
|
|
224
|
+
/** The surface a plugin list contributes, keyed by plugin id. */
|
|
225
|
+
export type InstalledSurface<Plugins extends readonly AbloPlugin[]> = {
|
|
226
|
+
[P in Plugins[number] as P['id']]: P extends AbloPlugin<infer S> ? S : never;
|
|
227
|
+
};
|
|
228
|
+
/**
|
|
229
|
+
* The plugin with the given id in a list, or `never` when absent. Sound
|
|
230
|
+
* because ids are literal ({@link LiteralString}); a list typed only as
|
|
231
|
+
* `AbloPlugin[]` has widened ids and resolves to `never`, so write plugin
|
|
232
|
+
* lists inline for the client type to follow them.
|
|
233
|
+
*/
|
|
234
|
+
export type PluginById<Plugins extends readonly AbloPlugin[], Id extends string> = Extract<Plugins[number], {
|
|
235
|
+
id: Id;
|
|
236
|
+
}>;
|
|
237
|
+
/** Collapses a union into an intersection, member by member. */
|
|
238
|
+
type UnionToIntersection<U> = (U extends unknown ? (member: U) => void : never) extends (member: infer I) => void ? I : never;
|
|
239
|
+
/**
|
|
240
|
+
* Every surface in a plugin list, folded into the one shape that merges onto
|
|
241
|
+
* the client: `[a(), b()]` contributes `ASurface & BSurface`. An empty list
|
|
242
|
+
* contributes nothing (`unknown`), so intersecting it changes no type.
|
|
243
|
+
*/
|
|
244
|
+
export type MergedSurface<Plugins extends readonly AbloPlugin[]> = [
|
|
245
|
+
Plugins[number]
|
|
246
|
+
] extends [never] ? unknown : UnionToIntersection<Plugins[number] extends AbloPlugin<infer Surface> ? Surface : never>;
|
|
247
|
+
/** What the selected transport can actually do, for checking `requires`. */
|
|
248
|
+
export interface TransportProfile {
|
|
249
|
+
readonly duplex: boolean;
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* Check a plugin list against the selected transport and build its surface.
|
|
253
|
+
*
|
|
254
|
+
* Both failures are configuration mistakes, so they surface here — while the
|
|
255
|
+
* client is being constructed and the stack still points at the caller's own
|
|
256
|
+
* setup — rather than later as a subscription that never delivers.
|
|
257
|
+
*/
|
|
258
|
+
export declare function resolvePlugins<const Plugins extends readonly AbloPlugin[], Options = unknown>(plugins: Plugins, transport: TransportProfile, context: PluginContext<Options>): InstalledSurface<Plugins>;
|
|
259
|
+
/**
|
|
260
|
+
* Lays every installed plugin surface over a built client, so a plugin's
|
|
261
|
+
* contributions are reachable as client members. The base always wins — a
|
|
262
|
+
* plugin cannot shadow `dispose`, a model accessor, or any other member the
|
|
263
|
+
* client itself defines; contributions only fill what the base leaves
|
|
264
|
+
* undefined. With nothing installed the base is returned untouched.
|
|
265
|
+
*
|
|
266
|
+
* The second half of {@link resolvePlugins}: that call turns a list into a
|
|
267
|
+
* surface, this one merges the surface onto the client the host built.
|
|
268
|
+
*/
|
|
269
|
+
export declare function layerPluginSurface<T extends object>(base: T, installed: Record<string, unknown>): T;
|
|
270
|
+
/**
|
|
271
|
+
* The plugins attached to one pipeline stage, in declaration order.
|
|
272
|
+
*
|
|
273
|
+
* Stage order across the pipeline is fixed by {@link PIPELINE_STAGES}; this
|
|
274
|
+
* returns the members of a single stage, where declaration order is the caller's
|
|
275
|
+
* to choose and carries no correctness weight.
|
|
276
|
+
*/
|
|
277
|
+
export declare function pluginsForStage(plugins: readonly AbloPlugin[], stage: PipelineStage): readonly AbloPlugin[];
|
|
278
|
+
/**
|
|
279
|
+
* Invokes every handler declared for one stage, in declaration order, with
|
|
280
|
+
* that stage's payload. No handlers declared is a plain no-op, so a pipeline
|
|
281
|
+
* dispatches unconditionally at each boundary and pays nothing when the
|
|
282
|
+
* stage is unclaimed.
|
|
283
|
+
*/
|
|
284
|
+
export declare function runStage<K extends PipelineStage>(plugins: readonly AbloPlugin[], stage: K, payload: StagePayloads[K]): void;
|
|
285
|
+
export {};
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The plugin contract (ADR 0016).
|
|
3
|
+
*
|
|
4
|
+
* The core is `commit` · `get`/`list` · `observe` · `claim` · auth. Everything
|
|
5
|
+
* else a caller might want — a local materialised copy, presence rendering,
|
|
6
|
+
* batching, framework bindings — is a plugin declared in one list, so a server
|
|
7
|
+
* or an agent installs only what it asked for.
|
|
8
|
+
*
|
|
9
|
+
* Every plugin has the same shape on purpose. Uniformity is what makes the list
|
|
10
|
+
* composable and the types inferable; bespoke plugins would reproduce today's
|
|
11
|
+
* nineteen export subpaths with extra ceremony.
|
|
12
|
+
*
|
|
13
|
+
* Where this shape came from, and the field-by-field reasoning behind it, is
|
|
14
|
+
* recorded in ADR 0016 — the contract itself only states what each field does.
|
|
15
|
+
*/
|
|
16
|
+
import { AbloValidationError } from './errors.js';
|
|
17
|
+
/** Canonical order. A plugin runner must run stages in this sequence. */
|
|
18
|
+
export const PIPELINE_STAGES = [
|
|
19
|
+
'receive',
|
|
20
|
+
'dedupe',
|
|
21
|
+
'persist',
|
|
22
|
+
'apply',
|
|
23
|
+
'acknowledge',
|
|
24
|
+
'notify',
|
|
25
|
+
];
|
|
26
|
+
/**
|
|
27
|
+
* Check a plugin list against the selected transport and build its surface.
|
|
28
|
+
*
|
|
29
|
+
* Both failures are configuration mistakes, so they surface here — while the
|
|
30
|
+
* client is being constructed and the stack still points at the caller's own
|
|
31
|
+
* setup — rather than later as a subscription that never delivers.
|
|
32
|
+
*/
|
|
33
|
+
export function resolvePlugins(plugins, transport, context) {
|
|
34
|
+
const surface = {};
|
|
35
|
+
const seen = new Set();
|
|
36
|
+
// The assembly, injected from the list being resolved. Always this list's
|
|
37
|
+
// own answer — a host-supplied `plugins` or `hasPlugin` could disagree
|
|
38
|
+
// with the assembly it describes, so both are replaced, not deferred to.
|
|
39
|
+
const initContext = {
|
|
40
|
+
...context,
|
|
41
|
+
plugins,
|
|
42
|
+
hasPlugin: (id) => plugins.some((plugin) => plugin.id === id),
|
|
43
|
+
};
|
|
44
|
+
for (const plugin of plugins) {
|
|
45
|
+
if (seen.has(plugin.id)) {
|
|
46
|
+
throw new AbloValidationError(`The ${plugin.id} plugin is listed twice. Remove the duplicate; a plugin is installed once per client.`, { code: 'invalid_options', param: 'plugins' });
|
|
47
|
+
}
|
|
48
|
+
seen.add(plugin.id);
|
|
49
|
+
if (plugin.requires?.duplex && !transport.duplex) {
|
|
50
|
+
throw new AbloValidationError(`The ${plugin.id} plugin needs a connection the server can send on, and this client is set up for request-response only. Switch the transport to 'websocket', or drop the plugin.`, { code: 'invalid_options', param: 'plugins' });
|
|
51
|
+
}
|
|
52
|
+
surface[plugin.id] = plugin.init(initContext);
|
|
53
|
+
}
|
|
54
|
+
return surface;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Lays every installed plugin surface over a built client, so a plugin's
|
|
58
|
+
* contributions are reachable as client members. The base always wins — a
|
|
59
|
+
* plugin cannot shadow `dispose`, a model accessor, or any other member the
|
|
60
|
+
* client itself defines; contributions only fill what the base leaves
|
|
61
|
+
* undefined. With nothing installed the base is returned untouched.
|
|
62
|
+
*
|
|
63
|
+
* The second half of {@link resolvePlugins}: that call turns a list into a
|
|
64
|
+
* surface, this one merges the surface onto the client the host built.
|
|
65
|
+
*/
|
|
66
|
+
export function layerPluginSurface(base, installed) {
|
|
67
|
+
const contributions = {};
|
|
68
|
+
for (const surface of Object.values(installed)) {
|
|
69
|
+
if (surface && typeof surface === 'object') {
|
|
70
|
+
Object.assign(contributions, surface);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
if (Object.keys(contributions).length === 0)
|
|
74
|
+
return base;
|
|
75
|
+
return new Proxy(base, {
|
|
76
|
+
get(target, prop, receiver) {
|
|
77
|
+
const own = Reflect.get(target, prop, receiver);
|
|
78
|
+
if (own !== undefined)
|
|
79
|
+
return own;
|
|
80
|
+
return typeof prop === 'string' && prop in contributions
|
|
81
|
+
? contributions[prop]
|
|
82
|
+
: own;
|
|
83
|
+
},
|
|
84
|
+
});
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* The plugins attached to one pipeline stage, in declaration order.
|
|
88
|
+
*
|
|
89
|
+
* Stage order across the pipeline is fixed by {@link PIPELINE_STAGES}; this
|
|
90
|
+
* returns the members of a single stage, where declaration order is the caller's
|
|
91
|
+
* to choose and carries no correctness weight.
|
|
92
|
+
*/
|
|
93
|
+
export function pluginsForStage(plugins, stage) {
|
|
94
|
+
return plugins.filter((plugin) => plugin.stages?.[stage] !== undefined);
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Invokes every handler declared for one stage, in declaration order, with
|
|
98
|
+
* that stage's payload. No handlers declared is a plain no-op, so a pipeline
|
|
99
|
+
* dispatches unconditionally at each boundary and pays nothing when the
|
|
100
|
+
* stage is unclaimed.
|
|
101
|
+
*/
|
|
102
|
+
export function runStage(plugins, stage, payload) {
|
|
103
|
+
for (const plugin of plugins) {
|
|
104
|
+
plugin.stages?.[stage]?.(payload);
|
|
105
|
+
}
|
|
106
|
+
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* the two; switch on `kind` to narrow it.
|
|
11
11
|
*/
|
|
12
12
|
import type { ParticipantRef } from '../types/participant.js';
|
|
13
|
-
import type { OnStaleMode } from '../coordination/schema.js';
|
|
13
|
+
import type { CommitOperationType, OnStaleMode } from '../coordination/schema.js';
|
|
14
14
|
export type ConflictKind = 'stale_context' | 'claim_held';
|
|
15
15
|
/** Fields shared by every conflict shape. */
|
|
16
16
|
interface ConflictBase {
|
|
@@ -23,7 +23,7 @@ interface ConflictBase {
|
|
|
23
23
|
export interface ConflictOperation {
|
|
24
24
|
readonly model: string;
|
|
25
25
|
readonly id: string;
|
|
26
|
-
readonly type:
|
|
26
|
+
readonly type: CommitOperationType;
|
|
27
27
|
readonly input?: Readonly<Record<string, unknown>>;
|
|
28
28
|
}
|
|
29
29
|
export interface StaleContextConflict extends ConflictBase {
|
|
@@ -48,7 +48,7 @@ export interface StaleContextConflict extends ConflictBase {
|
|
|
48
48
|
* else rejects. A custom policy may override this. When absent, it is treated
|
|
49
49
|
* as `'reject'`, the default for an unguarded write.
|
|
50
50
|
*/
|
|
51
|
-
readonly requestedMode?:
|
|
51
|
+
readonly requestedMode?: OnStaleMode;
|
|
52
52
|
}
|
|
53
53
|
export interface ClaimHeldConflict extends ConflictBase {
|
|
54
54
|
readonly kind: 'claim_held';
|
|
@@ -77,6 +77,8 @@ export const capabilityPreemptPolicy = (conflict) => {
|
|
|
77
77
|
}
|
|
78
78
|
return defaultPolicy(conflict);
|
|
79
79
|
};
|
|
80
|
+
const _conflictAxisPinned = [true, true];
|
|
81
|
+
void _conflictAxisPinned;
|
|
80
82
|
/**
|
|
81
83
|
* Resolves a declared {@link ConflictAxis} into a {@link ConflictDecision} for
|
|
82
84
|
* one concrete conflict. It is pure and synchronous, doing no I/O, so it can
|