@abloatai/ablo 0.36.0 → 0.37.1
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 +55 -2014
- package/NOTICE +2 -2
- package/README.md +45 -63
- package/assets/banner.png +0 -0
- package/dist/auth.d.ts +2 -0
- package/dist/auth.d.ts.map +1 -0
- package/dist/auth.js +2 -0
- package/dist/auth.js.map +1 -0
- package/dist/client.d.ts +3 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +3 -0
- package/dist/client.js.map +1 -0
- package/dist/coordination.d.ts +2 -0
- package/dist/coordination.d.ts.map +1 -0
- package/dist/coordination.js +2 -0
- package/dist/coordination.js.map +1 -0
- package/dist/index.d.ts +3 -114
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -163
- package/dist/index.js.map +1 -0
- package/dist/react.d.ts +4 -0
- package/dist/react.d.ts.map +1 -0
- package/dist/react.js +3 -0
- package/dist/react.js.map +1 -0
- package/dist/schema.d.ts +2 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +2 -0
- package/dist/schema.js.map +1 -0
- package/dist/server.d.ts +2 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +2 -0
- package/dist/server.js.map +1 -0
- package/dist/source-conformance.d.ts +2 -0
- package/dist/source-conformance.d.ts.map +1 -0
- package/dist/source-conformance.js +2 -0
- package/dist/source-conformance.js.map +1 -0
- package/dist/source-drizzle.d.ts +2 -0
- package/dist/source-drizzle.d.ts.map +1 -0
- package/dist/source-drizzle.js +2 -0
- package/dist/source-drizzle.js.map +1 -0
- package/dist/source-kysely.d.ts +2 -0
- package/dist/source-kysely.d.ts.map +1 -0
- package/dist/source-kysely.js +2 -0
- package/dist/source-kysely.js.map +1 -0
- package/dist/source-next.d.ts +2 -0
- package/dist/source-next.d.ts.map +1 -0
- package/dist/source-next.js +2 -0
- package/dist/source-next.js.map +1 -0
- package/dist/source.d.ts +2 -0
- package/dist/source.d.ts.map +1 -0
- package/dist/source.js +2 -0
- package/dist/source.js.map +1 -0
- package/dist/wire.d.ts +2 -0
- package/dist/wire.d.ts.map +1 -0
- package/dist/wire.js +2 -0
- package/dist/wire.js.map +1 -0
- package/docs/agents.md +1 -1
- package/docs/api-keys.md +7 -6
- package/docs/api.md +10 -10
- package/docs/client-behavior.md +5 -5
- package/docs/coordination.md +52 -62
- package/docs/data-sources.md +1 -1
- package/docs/examples/agent-human.md +4 -4
- package/docs/examples/ai-sdk-tool.md +1 -1
- package/docs/examples/existing-python-backend.md +15 -4
- package/docs/examples/nextjs.md +27 -6
- package/docs/examples/server-agent.md +2 -2
- package/docs/how-it-works.md +4 -4
- package/docs/identity.md +2 -1
- package/docs/integration-guide.md +24 -13
- package/docs/internal/README.md +18 -0
- package/docs/internal/agent-fleet-coordination-design.md +171 -0
- package/docs/internal/agent-orchestration.md +58 -0
- package/docs/internal/commit-identifiers.md +91 -0
- package/docs/internal/concurrency-open-decisions.md +37 -0
- package/docs/internal/data-source-reverse-channel.md +150 -0
- package/docs/internal/per-field-conflict-detection.md +165 -0
- package/docs/internal/postgres-replication.md +64 -0
- package/docs/internal/serializable-schema.md +119 -0
- package/docs/internal/structure.md +32 -0
- package/docs/mcp.md +2 -2
- package/docs/migration.md +3 -3
- package/docs/quickstart.md +2 -2
- package/docs/react.md +5 -5
- package/docs/schema-contract.md +3 -3
- package/docs/sessions.md +91 -37
- package/examples/README.md +2 -2
- package/examples/data-source/README.md +1 -1
- package/examples/data-source/ablo-driver.ts +1 -1
- package/examples/data-source/customer-server.ts +1 -1
- package/examples/data-source/run.ts +1 -1
- package/examples/data-source/schema.ts +1 -1
- package/examples/quickstart.ts +2 -2
- package/llms.txt +8 -8
- package/package.json +63 -166
- package/bin/ablo.cjs +0 -39
- package/dist/BaseSyncedStore.d.ts +0 -843
- package/dist/BaseSyncedStore.js +0 -1971
- package/dist/Database.d.ts +0 -323
- package/dist/Database.js +0 -1502
- package/dist/InstanceCache.d.ts +0 -237
- package/dist/InstanceCache.js +0 -1166
- package/dist/LazyReferenceCollection.d.ts +0 -177
- package/dist/LazyReferenceCollection.js +0 -461
- package/dist/Model.d.ts +0 -454
- package/dist/Model.js +0 -919
- package/dist/ModelRegistry.d.ts +0 -225
- package/dist/ModelRegistry.js +0 -539
- package/dist/NetworkMonitor.d.ts +0 -28
- package/dist/NetworkMonitor.js +0 -79
- package/dist/RuntimeContext.d.ts +0 -52
- package/dist/RuntimeContext.js +0 -80
- package/dist/SyncClient.d.ts +0 -541
- package/dist/SyncClient.js +0 -2202
- package/dist/adapters/alwaysOnline.d.ts +0 -14
- package/dist/adapters/alwaysOnline.js +0 -17
- package/dist/adapters/inMemoryStorage.d.ts +0 -31
- package/dist/adapters/inMemoryStorage.js +0 -110
- package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
- package/dist/ai-sdk/coordinatedTool.js +0 -134
- package/dist/ai-sdk/coordinationContext.d.ts +0 -46
- package/dist/ai-sdk/coordinationContext.js +0 -106
- package/dist/ai-sdk/index.d.ts +0 -121
- package/dist/ai-sdk/index.js +0 -121
- package/dist/ai-sdk/wrap.d.ts +0 -65
- package/dist/ai-sdk/wrap.js +0 -39
- package/dist/auth/index.d.ts +0 -1
- package/dist/auth/index.js +0 -8
- package/dist/batching/index.d.ts +0 -55
- package/dist/batching/index.js +0 -147
- package/dist/client/Ablo.d.ts +0 -231
- package/dist/client/Ablo.js +0 -160
- package/dist/client/abloClient.d.ts +0 -309
- package/dist/client/abloClient.js +0 -13
- package/dist/client/clientPrelude.d.ts +0 -52
- package/dist/client/clientPrelude.js +0 -60
- package/dist/client/consoleLogger.d.ts +0 -35
- package/dist/client/consoleLogger.js +0 -44
- package/dist/client/coreClient.d.ts +0 -60
- package/dist/client/coreClient.js +0 -118
- package/dist/client/createInternalComponents.d.ts +0 -50
- package/dist/client/createInternalComponents.js +0 -98
- package/dist/client/createModelProxy.d.ts +0 -248
- package/dist/client/createModelProxy.js +0 -884
- package/dist/client/humans.d.ts +0 -69
- package/dist/client/humans.js +0 -78
- package/dist/client/modelRegistration.d.ts +0 -10
- package/dist/client/modelRegistration.js +0 -312
- package/dist/client/options.d.ts +0 -461
- package/dist/client/options.js +0 -7
- package/dist/client/reactiveEngine.d.ts +0 -53
- package/dist/client/reactiveEngine.js +0 -688
- package/dist/client/resourceTypes.d.ts +0 -12
- package/dist/client/resourceTypes.js +0 -10
- package/dist/client/schemaConfig.d.ts +0 -44
- package/dist/client/schemaConfig.js +0 -185
- package/dist/client/storeCluster.d.ts +0 -47
- package/dist/client/storeCluster.js +0 -118
- package/dist/client/storeLifecycle.d.ts +0 -61
- package/dist/client/storeLifecycle.js +0 -231
- package/dist/client/validateAbloOptions.d.ts +0 -42
- package/dist/client/validateAbloOptions.js +0 -43
- package/dist/client/wsMutationExecutor.d.ts +0 -27
- package/dist/client/wsMutationExecutor.js +0 -72
- package/dist/context.d.ts +0 -42
- package/dist/context.js +0 -81
- package/dist/coordination/ClaimLog.d.ts +0 -26
- package/dist/coordination/ClaimLog.js +0 -32
- package/dist/coordination/index.d.ts +0 -1
- package/dist/coordination/index.js +0 -8
- package/dist/core/index.d.ts +0 -33
- package/dist/core/index.js +0 -48
- package/dist/docs/catalog.d.ts +0 -72
- package/dist/docs/catalog.js +0 -230
- package/dist/docs/index.d.ts +0 -10
- package/dist/docs/index.js +0 -10
- package/dist/environment.d.ts +0 -1
- package/dist/environment.js +0 -8
- package/dist/interfaces/index.d.ts +0 -311
- package/dist/interfaces/index.js +0 -9
- package/dist/keys/index.d.ts +0 -1
- package/dist/keys/index.js +0 -8
- package/dist/mutators/RecordingMutation.d.ts +0 -36
- package/dist/mutators/RecordingMutation.js +0 -182
- package/dist/mutators/Transaction.d.ts +0 -40
- package/dist/mutators/Transaction.js +0 -58
- package/dist/mutators/UndoManager.d.ts +0 -258
- package/dist/mutators/UndoManager.js +0 -658
- package/dist/mutators/defineMutators.d.ts +0 -60
- package/dist/mutators/defineMutators.js +0 -18
- package/dist/mutators/inverseOp.d.ts +0 -126
- package/dist/mutators/inverseOp.js +0 -71
- package/dist/mutators/mutateActions.d.ts +0 -45
- package/dist/mutators/mutateActions.js +0 -105
- package/dist/mutators/readerActions.d.ts +0 -33
- package/dist/mutators/readerActions.js +0 -57
- package/dist/mutators/undoApply.d.ts +0 -51
- package/dist/mutators/undoApply.js +0 -117
- package/dist/policy/index.d.ts +0 -21
- package/dist/policy/index.js +0 -20
- package/dist/query/QueryProcessor.d.ts +0 -75
- package/dist/query/QueryProcessor.js +0 -255
- package/dist/query/client.d.ts +0 -64
- package/dist/query/client.js +0 -138
- package/dist/query/types.d.ts +0 -85
- package/dist/query/types.js +0 -16
- package/dist/react/AbloProvider.d.ts +0 -242
- package/dist/react/AbloProvider.js +0 -458
- package/dist/react/ClientSideSuspense.d.ts +0 -36
- package/dist/react/ClientSideSuspense.js +0 -17
- package/dist/react/DefaultFallback.d.ts +0 -24
- package/dist/react/DefaultFallback.js +0 -43
- package/dist/react/context.d.ts +0 -55
- package/dist/react/context.js +0 -29
- package/dist/react/createAbloReact.d.ts +0 -56
- package/dist/react/createAbloReact.js +0 -51
- package/dist/react/index.d.ts +0 -62
- package/dist/react/index.js +0 -69
- package/dist/react/internalContext.d.ts +0 -33
- package/dist/react/internalContext.js +0 -3
- package/dist/react/useAblo.d.ts +0 -82
- package/dist/react/useAblo.js +0 -120
- package/dist/react/useCurrentUserId.d.ts +0 -22
- package/dist/react/useCurrentUserId.js +0 -34
- package/dist/react/useErrorListener.d.ts +0 -20
- package/dist/react/useErrorListener.js +0 -38
- package/dist/react/useMutationFailureListener.d.ts +0 -26
- package/dist/react/useMutationFailureListener.js +0 -38
- package/dist/react/useMutators.d.ts +0 -56
- package/dist/react/useMutators.js +0 -84
- package/dist/react/useReactive.d.ts +0 -35
- package/dist/react/useReactive.js +0 -123
- package/dist/react/useSyncStatus.d.ts +0 -59
- package/dist/react/useSyncStatus.js +0 -76
- package/dist/react/useUndoScope.d.ts +0 -34
- package/dist/react/useUndoScope.js +0 -81
- package/dist/schema/coordination.d.ts +0 -112
- package/dist/schema/coordination.js +0 -133
- package/dist/schema/ddl.d.ts +0 -97
- package/dist/schema/ddl.js +0 -491
- package/dist/schema/ddlLock.d.ts +0 -35
- package/dist/schema/ddlLock.js +0 -46
- package/dist/schema/diff.d.ts +0 -225
- package/dist/schema/diff.js +0 -289
- package/dist/schema/generate.d.ts +0 -19
- package/dist/schema/generate.js +0 -86
- package/dist/schema/index.d.ts +0 -42
- package/dist/schema/index.js +0 -80
- package/dist/schema/queries.d.ts +0 -201
- package/dist/schema/queries.js +0 -144
- package/dist/schema/select.d.ts +0 -40
- package/dist/schema/select.js +0 -90
- package/dist/schema/serialize.d.ts +0 -115
- package/dist/schema/serialize.js +0 -265
- package/dist/schema/sugar.d.ts +0 -109
- package/dist/schema/sugar.js +0 -83
- package/dist/schema/syncDeltaRow.d.ts +0 -6
- package/dist/schema/syncDeltaRow.js +0 -6
- package/dist/server/adapter.d.ts +0 -173
- package/dist/server/adapter.js +0 -18
- package/dist/server/commit.d.ts +0 -107
- package/dist/server/commit.js +0 -1
- package/dist/server/index.d.ts +0 -14
- package/dist/server/index.js +0 -2
- package/dist/server/readConfig.d.ts +0 -80
- package/dist/server/readConfig.js +0 -8
- package/dist/server/storageMode.d.ts +0 -23
- package/dist/server/storageMode.js +0 -17
- package/dist/source/adapter.d.ts +0 -83
- package/dist/source/adapter.js +0 -24
- package/dist/source/adapters/drizzle.d.ts +0 -48
- package/dist/source/adapters/drizzle.js +0 -219
- package/dist/source/adapters/kysely.d.ts +0 -42
- package/dist/source/adapters/kysely.js +0 -205
- package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
- package/dist/source/adapters/kyselyMutationCore.js +0 -125
- package/dist/source/adapters/memory.d.ts +0 -13
- package/dist/source/adapters/memory.js +0 -130
- package/dist/source/adapters/prisma.d.ts +0 -63
- package/dist/source/adapters/prisma.js +0 -202
- package/dist/source/conformance.d.ts +0 -37
- package/dist/source/conformance.js +0 -215
- package/dist/source/connector.d.ts +0 -95
- package/dist/source/connector.js +0 -266
- package/dist/source/connectorProtocol.d.ts +0 -154
- package/dist/source/connectorProtocol.js +0 -163
- package/dist/source/contract.d.ts +0 -195
- package/dist/source/contract.js +0 -164
- package/dist/source/factory.d.ts +0 -92
- package/dist/source/factory.js +0 -286
- package/dist/source/idempotency.d.ts +0 -61
- package/dist/source/idempotency.js +0 -144
- package/dist/source/index.d.ts +0 -23
- package/dist/source/index.js +0 -30
- package/dist/source/migrations.d.ts +0 -21
- package/dist/source/migrations.js +0 -103
- package/dist/source/next.d.ts +0 -32
- package/dist/source/next.js +0 -25
- package/dist/source/pushQueue.d.ts +0 -134
- package/dist/source/pushQueue.js +0 -256
- package/dist/source/signing.d.ts +0 -92
- package/dist/source/signing.js +0 -162
- package/dist/source/types.d.ts +0 -401
- package/dist/source/types.js +0 -59
- package/dist/storeContract.d.ts +0 -145
- package/dist/storeContract.js +0 -12
- package/dist/stores/DatabaseManager.d.ts +0 -107
- package/dist/stores/DatabaseManager.js +0 -388
- package/dist/stores/ObjectStore.d.ts +0 -115
- package/dist/stores/ObjectStore.js +0 -393
- package/dist/stores/ObjectStoreContract.d.ts +0 -38
- package/dist/stores/ObjectStoreContract.js +0 -1
- package/dist/stores/StoreManager.d.ts +0 -114
- package/dist/stores/StoreManager.js +0 -304
- package/dist/stores/SyncActionStore.d.ts +0 -99
- package/dist/stores/SyncActionStore.js +0 -506
- package/dist/stores/openIDBWithTimeout.d.ts +0 -65
- package/dist/stores/openIDBWithTimeout.js +0 -153
- package/dist/stores/syncAction.d.ts +0 -26
- package/dist/stores/syncAction.js +0 -16
- package/dist/surface.d.ts +0 -36
- package/dist/surface.js +0 -75
- package/dist/sync/BootstrapFetcher.d.ts +0 -284
- package/dist/sync/BootstrapFetcher.js +0 -964
- package/dist/sync/ConnectionManager.d.ts +0 -8
- package/dist/sync/ConnectionManager.js +0 -8
- package/dist/sync/OnDemandLoader.d.ts +0 -231
- package/dist/sync/OnDemandLoader.js +0 -743
- package/dist/sync/SubscriptionManager.d.ts +0 -159
- package/dist/sync/SubscriptionManager.js +0 -243
- package/dist/sync/SyncWebSocket.d.ts +0 -173
- package/dist/sync/SyncWebSocket.js +0 -438
- package/dist/sync/awaitClaimGrant.d.ts +0 -6
- package/dist/sync/awaitClaimGrant.js +0 -6
- package/dist/sync/bootstrapApply.d.ts +0 -73
- package/dist/sync/bootstrapApply.js +0 -73
- package/dist/sync/commitFrames.d.ts +0 -8
- package/dist/sync/commitFrames.js +0 -8
- package/dist/sync/contextPorts.d.ts +0 -18
- package/dist/sync/contextPorts.js +0 -31
- package/dist/sync/createClaimStream.d.ts +0 -7
- package/dist/sync/createClaimStream.js +0 -7
- package/dist/sync/createPresenceStream.d.ts +0 -69
- package/dist/sync/createPresenceStream.js +0 -200
- package/dist/sync/createSnapshot.d.ts +0 -29
- package/dist/sync/createSnapshot.js +0 -118
- package/dist/sync/credentialLifecycle.d.ts +0 -7
- package/dist/sync/credentialLifecycle.js +0 -7
- package/dist/sync/deltaPipeline.d.ts +0 -114
- package/dist/sync/deltaPipeline.js +0 -278
- package/dist/sync/groupChange.d.ts +0 -116
- package/dist/sync/groupChange.js +0 -244
- package/dist/sync/participants.d.ts +0 -132
- package/dist/sync/participants.js +0 -346
- package/dist/sync/persistedPrefix.d.ts +0 -12
- package/dist/sync/persistedPrefix.js +0 -22
- package/dist/sync/schemaDrift.d.ts +0 -55
- package/dist/sync/schemaDrift.js +0 -53
- package/dist/sync/schemas.d.ts +0 -71
- package/dist/sync/schemas.js +0 -94
- package/dist/sync/syncCursor.d.ts +0 -40
- package/dist/sync/syncCursor.js +0 -55
- package/dist/sync/syncPlan.d.ts +0 -54
- package/dist/sync/syncPlan.js +0 -50
- package/dist/sync/wsFrameHandlers.d.ts +0 -8
- package/dist/sync/wsFrameHandlers.js +0 -8
- package/dist/syncLog/contract.d.ts +0 -20
- package/dist/syncLog/contract.js +0 -19
- package/dist/syncLog/index.d.ts +0 -1
- package/dist/syncLog/index.js +0 -1
- package/dist/transaction/ablo.d.ts +0 -88
- package/dist/transaction/ablo.js +0 -33
- package/dist/transaction/auth/apiKey.d.ts +0 -152
- package/dist/transaction/auth/apiKey.js +0 -419
- package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
- package/dist/transaction/auth/bootstrapScope.js +0 -1
- package/dist/transaction/auth/capability.d.ts +0 -212
- package/dist/transaction/auth/capability.js +0 -224
- package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
- package/dist/transaction/auth/credentialEndpoint.js +0 -86
- package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
- package/dist/transaction/auth/credentialPolicy.js +0 -125
- package/dist/transaction/auth/credentialSource.d.ts +0 -30
- package/dist/transaction/auth/credentialSource.js +0 -55
- package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
- package/dist/transaction/auth/hostedEndpoints.js +0 -21
- package/dist/transaction/auth/identity.d.ts +0 -55
- package/dist/transaction/auth/identity.js +0 -210
- package/dist/transaction/auth/index.d.ts +0 -162
- package/dist/transaction/auth/index.js +0 -304
- package/dist/transaction/auth/schemas.d.ts +0 -59
- package/dist/transaction/auth/schemas.js +0 -85
- package/dist/transaction/auth/sessionMint.d.ts +0 -28
- package/dist/transaction/auth/sessionMint.js +0 -85
- package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -56
- package/dist/transaction/coordination/awaitClaimGrant.js +0 -124
- package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -84
- package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -108
- package/dist/transaction/coordination/claimMeta.d.ts +0 -49
- package/dist/transaction/coordination/claimMeta.js +0 -52
- package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
- package/dist/transaction/coordination/createClaimStream.js +0 -475
- package/dist/transaction/coordination/events.d.ts +0 -74
- package/dist/transaction/coordination/events.js +0 -7
- package/dist/transaction/coordination/index.d.ts +0 -19
- package/dist/transaction/coordination/index.js +0 -45
- package/dist/transaction/coordination/locator.d.ts +0 -104
- package/dist/transaction/coordination/locator.js +0 -102
- package/dist/transaction/coordination/schema.d.ts +0 -1536
- package/dist/transaction/coordination/schema.js +0 -1177
- package/dist/transaction/coordination/targetConflict.d.ts +0 -2
- package/dist/transaction/coordination/targetConflict.js +0 -107
- package/dist/transaction/coordination/trace.d.ts +0 -78
- package/dist/transaction/coordination/trace.js +0 -138
- package/dist/transaction/durableWrites.d.ts +0 -62
- package/dist/transaction/durableWrites.js +0 -71
- package/dist/transaction/environment.d.ts +0 -105
- package/dist/transaction/environment.js +0 -108
- package/dist/transaction/errorCodes.d.ts +0 -403
- package/dist/transaction/errorCodes.js +0 -484
- package/dist/transaction/errors.d.ts +0 -428
- package/dist/transaction/errors.js +0 -686
- package/dist/transaction/footprint.d.ts +0 -111
- package/dist/transaction/footprint.js +0 -0
- package/dist/transaction/index.d.ts +0 -20
- package/dist/transaction/index.js +0 -20
- package/dist/transaction/keys/index.d.ts +0 -87
- package/dist/transaction/keys/index.js +0 -207
- package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
- package/dist/transaction/log/syncDeltaRow.js +0 -95
- package/dist/transaction/logPosition.d.ts +0 -97
- package/dist/transaction/logPosition.js +0 -125
- package/dist/transaction/logger.d.ts +0 -16
- package/dist/transaction/logger.js +0 -7
- package/dist/transaction/observability.d.ts +0 -53
- package/dist/transaction/observability.js +0 -19
- package/dist/transaction/persistence.d.ts +0 -12
- package/dist/transaction/persistence.js +0 -11
- package/dist/transaction/plugin.d.ts +0 -285
- package/dist/transaction/plugin.js +0 -106
- package/dist/transaction/policy/types.d.ts +0 -217
- package/dist/transaction/policy/types.js +0 -126
- package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
- package/dist/transaction/resources/functionalUpdate.js +0 -87
- package/dist/transaction/resources/httpResources.d.ts +0 -321
- package/dist/transaction/resources/httpResources.js +0 -7
- package/dist/transaction/resources/modelOperations.d.ts +0 -427
- package/dist/transaction/resources/modelOperations.js +0 -12
- package/dist/transaction/resources/mutationOptions.d.ts +0 -66
- package/dist/transaction/resources/mutationOptions.js +0 -9
- package/dist/transaction/resources/where.d.ts +0 -101
- package/dist/transaction/resources/where.js +0 -115
- package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
- package/dist/transaction/resources/writeOptionsSchema.js +0 -73
- package/dist/transaction/schema/field.d.ts +0 -120
- package/dist/transaction/schema/field.js +0 -265
- package/dist/transaction/schema/fieldRef.d.ts +0 -38
- package/dist/transaction/schema/fieldRef.js +0 -11
- package/dist/transaction/schema/loadStrategy.d.ts +0 -45
- package/dist/transaction/schema/loadStrategy.js +0 -46
- package/dist/transaction/schema/model.d.ts +0 -379
- package/dist/transaction/schema/model.js +0 -123
- package/dist/transaction/schema/openapi.d.ts +0 -58
- package/dist/transaction/schema/openapi.js +0 -501
- package/dist/transaction/schema/relation.d.ts +0 -204
- package/dist/transaction/schema/relation.js +0 -104
- package/dist/transaction/schema/residency.d.ts +0 -29
- package/dist/transaction/schema/residency.js +0 -25
- package/dist/transaction/schema/roles.d.ts +0 -249
- package/dist/transaction/schema/roles.js +0 -230
- package/dist/transaction/schema/schema.d.ts +0 -351
- package/dist/transaction/schema/schema.js +0 -325
- package/dist/transaction/schema/tenancy.d.ts +0 -139
- package/dist/transaction/schema/tenancy.js +0 -190
- package/dist/transaction/transactionLayer.d.ts +0 -82
- package/dist/transaction/transactionLayer.js +0 -24
- package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
- package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
- package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
- package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
- package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
- package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
- package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
- package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
- package/dist/transaction/transport/commitFrames.d.ts +0 -90
- package/dist/transaction/transport/commitFrames.js +0 -134
- package/dist/transaction/transport/connectionManager.d.ts +0 -215
- package/dist/transaction/transport/connectionManager.js +0 -673
- package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
- package/dist/transaction/transport/credentialLifecycle.js +0 -324
- package/dist/transaction/transport/heartbeat.d.ts +0 -65
- package/dist/transaction/transport/heartbeat.js +0 -93
- package/dist/transaction/transport/httpClient.d.ts +0 -131
- package/dist/transaction/transport/httpClient.js +0 -146
- package/dist/transaction/transport/httpOptions.d.ts +0 -33
- package/dist/transaction/transport/httpOptions.js +0 -12
- package/dist/transaction/transport/httpTransport.d.ts +0 -8
- package/dist/transaction/transport/httpTransport.js +0 -1388
- package/dist/transaction/transport/networkProbe.d.ts +0 -84
- package/dist/transaction/transport/networkProbe.js +0 -207
- package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
- package/dist/transaction/transport/wsFrameHandlers.js +0 -429
- package/dist/transaction/transport/wsTransport.d.ts +0 -574
- package/dist/transaction/transport/wsTransport.js +0 -1023
- package/dist/transaction/types/assertExact.d.ts +0 -17
- package/dist/transaction/types/assertExact.js +0 -1
- package/dist/transaction/types/global.d.ts +0 -107
- package/dist/transaction/types/global.js +0 -40
- package/dist/transaction/types/index.d.ts +0 -205
- package/dist/transaction/types/index.js +0 -56
- package/dist/transaction/types/modelData.d.ts +0 -10
- package/dist/transaction/types/modelData.js +0 -9
- package/dist/transaction/types/participant.d.ts +0 -20
- package/dist/transaction/types/participant.js +0 -10
- package/dist/transaction/types/streams.d.ts +0 -550
- package/dist/transaction/types/streams.js +0 -11
- package/dist/transaction/utils/asyncIterator.d.ts +0 -34
- package/dist/transaction/utils/asyncIterator.js +0 -135
- package/dist/transaction/utils/duration.d.ts +0 -50
- package/dist/transaction/utils/duration.js +0 -77
- package/dist/transaction/utils/json.d.ts +0 -57
- package/dist/transaction/utils/json.js +0 -276
- package/dist/transaction/wire/accountResponses.d.ts +0 -420
- package/dist/transaction/wire/accountResponses.js +0 -290
- package/dist/transaction/wire/auth.d.ts +0 -56
- package/dist/transaction/wire/auth.js +0 -63
- package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
- package/dist/transaction/wire/bootstrapReason.js +0 -8
- package/dist/transaction/wire/claimEvent.d.ts +0 -76
- package/dist/transaction/wire/claimEvent.js +0 -73
- package/dist/transaction/wire/claims.d.ts +0 -530
- package/dist/transaction/wire/claims.js +0 -327
- package/dist/transaction/wire/commit.d.ts +0 -603
- package/dist/transaction/wire/commit.js +0 -321
- package/dist/transaction/wire/delta.d.ts +0 -250
- package/dist/transaction/wire/delta.js +0 -147
- package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
- package/dist/transaction/wire/errorEnvelope.js +0 -123
- package/dist/transaction/wire/feedCursor.d.ts +0 -60
- package/dist/transaction/wire/feedCursor.js +0 -82
- package/dist/transaction/wire/feedEvent.d.ts +0 -204
- package/dist/transaction/wire/feedEvent.js +0 -65
- package/dist/transaction/wire/frames.d.ts +0 -194
- package/dist/transaction/wire/frames.js +0 -50
- package/dist/transaction/wire/inboundFrames.d.ts +0 -562
- package/dist/transaction/wire/inboundFrames.js +0 -116
- package/dist/transaction/wire/index.d.ts +0 -54
- package/dist/transaction/wire/index.js +0 -83
- package/dist/transaction/wire/listEnvelope.d.ts +0 -37
- package/dist/transaction/wire/listEnvelope.js +0 -42
- package/dist/transaction/wire/modelMutations.d.ts +0 -31
- package/dist/transaction/wire/modelMutations.js +0 -52
- package/dist/transaction/wire/modelResponses.d.ts +0 -85
- package/dist/transaction/wire/modelResponses.js +0 -43
- package/dist/transaction/wire/modelShape.d.ts +0 -78
- package/dist/transaction/wire/modelShape.js +0 -74
- package/dist/transaction/wire/protocol.d.ts +0 -38
- package/dist/transaction/wire/protocol.js +0 -38
- package/dist/transaction/wire/protocolVersion.d.ts +0 -73
- package/dist/transaction/wire/protocolVersion.js +0 -83
- package/dist/transactions/mutations/MutationQueue.d.ts +0 -661
- package/dist/transactions/mutations/MutationQueue.js +0 -2807
- package/dist/transactions/mutations/MutationStore.d.ts +0 -20
- package/dist/transactions/mutations/MutationStore.js +0 -53
- package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
- package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
- package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
- package/dist/transactions/mutations/coalesceRules.js +0 -140
- package/dist/transactions/mutations/commitLatency.d.ts +0 -52
- package/dist/transactions/mutations/commitLatency.js +0 -130
- package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
- package/dist/transactions/mutations/commitOutboxStore.js +0 -26
- package/dist/transactions/mutations/commitPayload.d.ts +0 -165
- package/dist/transactions/mutations/commitPayload.js +0 -152
- package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -63
- package/dist/transactions/mutations/deltaConfirmation.js +0 -235
- package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
- package/dist/transactions/mutations/durableWriteStore.js +0 -12
- package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
- package/dist/transactions/mutations/optimisticApply.js +0 -65
- package/dist/transactions/mutations/replayValidation.d.ts +0 -187
- package/dist/transactions/mutations/replayValidation.js +0 -164
- package/dist/utils/mobxSetup.d.ts +0 -53
- package/dist/utils/mobxSetup.js +0 -330
- package/dist/views/QueryView.d.ts +0 -79
- package/dist/views/QueryView.js +0 -218
- package/dist/views/ViewRegistry.d.ts +0 -20
- package/dist/views/ViewRegistry.js +0 -55
- package/dist/views/incrementalView.d.ts +0 -45
- package/dist/views/incrementalView.js +0 -69
- package/dist/webhooks/events.d.ts +0 -43
- package/dist/webhooks/events.js +0 -42
- package/dist/webhooks/index.d.ts +0 -8
- package/dist/webhooks/index.js +0 -8
- package/dist/wire/index.d.ts +0 -1
- package/dist/wire/index.js +0 -8
|
@@ -1,204 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Declarative relations between your models — the edges that turn a flat set
|
|
3
|
-
* of models into a graph. You attach relations to a model with the
|
|
4
|
-
* {@link relation} factories; the engine reads them to index foreign keys for
|
|
5
|
-
* fast child lookups, to order inserts so a parent row lands before the rows
|
|
6
|
-
* that reference it, and to generate the accessor properties that let you read
|
|
7
|
-
* `task.project` or `project.tasks` directly.
|
|
8
|
-
*
|
|
9
|
-
* Usage:
|
|
10
|
-
* import { relation } from '@abloatai/ablo/schema';
|
|
11
|
-
*
|
|
12
|
-
* const taskRelations = {
|
|
13
|
-
* project: relation.belongsTo('projects', 'projectId'),
|
|
14
|
-
* assignee: relation.belongsTo('users', 'assigneeId'),
|
|
15
|
-
* comments: relation.hasMany('comments', 'taskId'),
|
|
16
|
-
* };
|
|
17
|
-
*/
|
|
18
|
-
/**
|
|
19
|
-
* Options for `relation.belongsTo`. Each defaults to `false`, so every
|
|
20
|
-
* behavior below is opt-in per relation.
|
|
21
|
-
*
|
|
22
|
-
* `index: true` registers a foreign-key index for the child model when the
|
|
23
|
-
* engine starts, turning "every child that points at this parent" from a full
|
|
24
|
-
* scan into a constant-time lookup. Reach for it on relations you query this
|
|
25
|
-
* way often, such as a block's `sectionId`.
|
|
26
|
-
*
|
|
27
|
-
* `enrich: true` auto-populates the parent reference on an incoming change
|
|
28
|
-
* before the child data lands. A change to `Task { teamId: 't1' }` picks up the
|
|
29
|
-
* already-loaded `teams:t1` record and attaches it as `data.team`, so you can
|
|
30
|
-
* read `task.team` without a second lookup. Enrichment is best-effort: if the
|
|
31
|
-
* parent has not loaded yet it quietly does nothing, and the child data still
|
|
32
|
-
* applies.
|
|
33
|
-
*
|
|
34
|
-
* `defer: true` tells the engine to ignore this edge when it works out the
|
|
35
|
-
* order in which to insert rows. Use it on the soft side of a genuine reference
|
|
36
|
-
* cycle — the side where you are willing to insert the child first with the
|
|
37
|
-
* foreign key left null and fill it in with a later update. The other side of
|
|
38
|
-
* the cycle then becomes a strict predecessor, so the child is ordered after
|
|
39
|
-
* the parent rather than tied with it.
|
|
40
|
-
*
|
|
41
|
-
* `defer` changes only that ordering, not what the engine sends on the wire; it
|
|
42
|
-
* does not rewrite an insert into an insert-then-update. Pair it with a Postgres
|
|
43
|
-
* `DEFERRABLE INITIALLY DEFERRED` constraint when you also want the database to
|
|
44
|
-
* relax the foreign-key check itself. For example:
|
|
45
|
-
*
|
|
46
|
-
* ```ts
|
|
47
|
-
* layouts: model({ reportId: z.string().nullish() }, {
|
|
48
|
-
* // The report-owns-layout link is nullable and the layout is always
|
|
49
|
-
* // created first; marking it `defer` lets the report commit ahead of the
|
|
50
|
-
* // layout instead of sharing its insert-order slot.
|
|
51
|
-
* report: relation.belongsTo('reports', 'reportId', { defer: true }),
|
|
52
|
-
* }),
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
export interface BelongsToOptions {
|
|
56
|
-
readonly index?: boolean;
|
|
57
|
-
readonly enrich?: boolean;
|
|
58
|
-
readonly defer?: boolean;
|
|
59
|
-
/**
|
|
60
|
-
* Marks the relation's target as this record's parent: the entity the record
|
|
61
|
-
* lives inside and inherits its access scope from. When a record is written,
|
|
62
|
-
* the engine routes it into its parent's sync group — following a chain of
|
|
63
|
-
* `parent` edges all the way up — so the change reaches everyone subscribed to
|
|
64
|
-
* the owning entity. This is the familiar rule that access flows down from a
|
|
65
|
-
* container to the things it holds, as a folder does to its files.
|
|
66
|
-
*
|
|
67
|
-
* Do not set `parent` on a reference that merely points at another record for
|
|
68
|
-
* provenance or as a template, such as `sourceSectionId` or `templateId`; doing
|
|
69
|
-
* so would leak the record into an unrelated scope. The engine also cannot
|
|
70
|
-
* infer the parent from whether a field is optional — many real parent keys
|
|
71
|
-
* are optional, like a root folder or an inbox task — so you must declare the
|
|
72
|
-
* parent edge explicitly.
|
|
73
|
-
*
|
|
74
|
-
* It reads naturally at the call site:
|
|
75
|
-
* `belongsTo('report', 'reportId', { parent: true })` — the report is the parent.
|
|
76
|
-
*/
|
|
77
|
-
readonly parent?: boolean;
|
|
78
|
-
/**
|
|
79
|
-
* Emit a real Postgres foreign-key constraint for this relation when the
|
|
80
|
-
* engine provisions tables in a customer-owned database. This is independent
|
|
81
|
-
* of `parent`: `parent` decides which subscribers a change reaches, while
|
|
82
|
-
* `fk` decides whether the database enforces referential integrity. A relation
|
|
83
|
-
* may set either, both, or neither.
|
|
84
|
-
*
|
|
85
|
-
* Set `fk: true` only when the target row lives in the same database and is
|
|
86
|
-
* written in the same commit as this row, and points at a strong, contained
|
|
87
|
-
* entity. Leave it off provenance or template pointers (`sourceSectionId`,
|
|
88
|
-
* `templateId`), cross-tenant references, or anything that may be written in a
|
|
89
|
-
* different transaction than its target — a hard constraint there would reject
|
|
90
|
-
* the write and break out-of-order sync. The constraint is emitted as
|
|
91
|
-
* `DEFERRABLE INITIALLY DEFERRED, ON DELETE NO ACTION`: a plain integrity
|
|
92
|
-
* guard, leaving any cascade or null-on-delete behavior to the application.
|
|
93
|
-
*/
|
|
94
|
-
readonly fk?: boolean;
|
|
95
|
-
}
|
|
96
|
-
declare const __relationType: unique symbol;
|
|
97
|
-
declare const __relationTarget: unique symbol;
|
|
98
|
-
declare const __relationField: unique symbol;
|
|
99
|
-
/**
|
|
100
|
-
* The three edges the engine resolves. Inferred from `wire/modelShape.ts`
|
|
101
|
-
* rather than restated: the set is reported to callers by `GET /api/schema`,
|
|
102
|
-
* so it is protocol, and protocol has one definition.
|
|
103
|
-
*/
|
|
104
|
-
export type { RelationType } from '../wire/modelShape.js';
|
|
105
|
-
import type { RelationType } from '../wire/modelShape.js';
|
|
106
|
-
/**
|
|
107
|
-
* A relation definition, carrying its type information at both the type and
|
|
108
|
-
* runtime level.
|
|
109
|
-
*
|
|
110
|
-
* The `Options` generic captures a relation's options in the type system; only
|
|
111
|
-
* `belongsTo` uses it, while `hasMany` and `hasOne` leave it empty. The `const`
|
|
112
|
-
* modifier on the `belongsTo` factory preserves literal inference, so
|
|
113
|
-
* `{ enrich: true }` is remembered as `true` rather than widened to `boolean`,
|
|
114
|
-
* letting type-level features read the exact option value.
|
|
115
|
-
*
|
|
116
|
-
* `options` is always present at runtime: the factory substitutes an empty
|
|
117
|
-
* object when you omit it, so reading `options.index` or `options.enrich` needs
|
|
118
|
-
* no null check.
|
|
119
|
-
*/
|
|
120
|
-
export interface RelationDef<Type extends RelationType = RelationType, Target extends string = string, Field extends string = string, Options extends BelongsToOptions = BelongsToOptions> {
|
|
121
|
-
readonly [__relationType]: Type;
|
|
122
|
-
readonly [__relationTarget]: Target;
|
|
123
|
-
readonly [__relationField]: Field;
|
|
124
|
-
/** Runtime metadata */
|
|
125
|
-
readonly type: Type;
|
|
126
|
-
readonly target: Target;
|
|
127
|
-
/**
|
|
128
|
-
* The field on the child model that holds the parent's id, as a camelCase
|
|
129
|
-
* schema field name. The engine reads `model[foreignKey]` to resolve the
|
|
130
|
-
* relation and to build client-side index keys; it is never interpolated into
|
|
131
|
-
* raw SQL — that is what {@link foreignKeyColumn} is for.
|
|
132
|
-
*/
|
|
133
|
-
readonly foreignKey: Field;
|
|
134
|
-
/**
|
|
135
|
-
* The same foreign key expressed as a database column identifier.
|
|
136
|
-
* {@link foreignKey} is translated into this when you configure a `casing`
|
|
137
|
-
* option on `defineSchema` — for example `'snake_case'` turns `messageId`
|
|
138
|
-
* into `message_id`. The server interpolates this column name into SQL
|
|
139
|
-
* directly, because a driver's automatic camelCase-to-snake_case mapping does
|
|
140
|
-
* not reach identifiers embedded in raw SQL; resolving the name once at
|
|
141
|
-
* schema-build time is what makes it available there.
|
|
142
|
-
*
|
|
143
|
-
* Defaults to {@link foreignKey} when no `casing` option is set, so consumers
|
|
144
|
-
* whose database columns already match their field names need no
|
|
145
|
-
* configuration.
|
|
146
|
-
*/
|
|
147
|
-
readonly foreignKeyColumn: string;
|
|
148
|
-
readonly options: Options;
|
|
149
|
-
/**
|
|
150
|
-
* Optional sort field for `hasMany` relations. When set, the
|
|
151
|
-
* generated relation getter sorts results by this field. Populated
|
|
152
|
-
* by `relation.hasMany(target, fk, { orderBy: 'fieldName' })`.
|
|
153
|
-
*/
|
|
154
|
-
readonly _orderBy?: string;
|
|
155
|
-
}
|
|
156
|
-
export declare const relation: {
|
|
157
|
-
/**
|
|
158
|
-
* This model belongs to another model via a foreign key.
|
|
159
|
-
* e.g., Task belongs to Project via projectId
|
|
160
|
-
*
|
|
161
|
-
* ```ts
|
|
162
|
-
* // Simple reference (no options)
|
|
163
|
-
* project: relation.belongsTo('projects', 'projectId'),
|
|
164
|
-
*
|
|
165
|
-
* // Register an FK index for O(1) child lookups
|
|
166
|
-
* section: relation.belongsTo('sections', 'sectionId', { index: true }),
|
|
167
|
-
*
|
|
168
|
-
* // Auto-populate the parent on delta arrival
|
|
169
|
-
* team: relation.belongsTo('teams', 'teamId', { enrich: true }),
|
|
170
|
-
*
|
|
171
|
-
* // Both
|
|
172
|
-
* parent: relation.belongsTo('threads', 'parentId', { index: true, enrich: true }),
|
|
173
|
-
*
|
|
174
|
-
* // Mark the soft side of a cycle so the priority computer breaks
|
|
175
|
-
* // the cycle deterministically instead of tying the two models.
|
|
176
|
-
* report: relation.belongsTo('reports', 'reportId', { defer: true }),
|
|
177
|
-
* ```
|
|
178
|
-
*/
|
|
179
|
-
readonly belongsTo: <Target extends string, Field extends string, const Opts extends BelongsToOptions = Record<string, never>>(target: Target, foreignKey: Field, options?: Opts) => RelationDef<"belongsTo", Target, Field, Opts>;
|
|
180
|
-
/**
|
|
181
|
-
* This model has many of another model — for example, a project has many
|
|
182
|
-
* tasks via `Task.projectId`.
|
|
183
|
-
*
|
|
184
|
-
* At runtime the engine adds a getter to the parent model that returns every
|
|
185
|
-
* child whose foreign key matches, and registers the foreign-key index on the
|
|
186
|
-
* child model automatically.
|
|
187
|
-
*
|
|
188
|
-
* ```ts
|
|
189
|
-
* blocks: relation.hasMany('blocks', 'sectionId'),
|
|
190
|
-
* // → section.blocks returns all Block[] where sectionId === section.id
|
|
191
|
-
*
|
|
192
|
-
* blocks: relation.hasMany('blocks', 'sectionId', { orderBy: 'zIndex' }),
|
|
193
|
-
* // → section.blocks returns Block[] sorted by zIndex ascending
|
|
194
|
-
* ```
|
|
195
|
-
*/
|
|
196
|
-
readonly hasMany: <Target extends string, Field extends string>(target: Target, foreignKey: Field, options?: {
|
|
197
|
-
orderBy?: string;
|
|
198
|
-
}) => RelationDef<"hasMany", Target, Field>;
|
|
199
|
-
/**
|
|
200
|
-
* This model has one of another model — for example, a user has one profile
|
|
201
|
-
* via `Profile.userId`.
|
|
202
|
-
*/
|
|
203
|
-
readonly hasOne: <Target extends string, Field extends string>(target: Target, foreignKey: Field) => RelationDef<"hasOne", Target, Field>;
|
|
204
|
-
};
|
|
@@ -1,104 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Declarative relations between your models — the edges that turn a flat set
|
|
3
|
-
* of models into a graph. You attach relations to a model with the
|
|
4
|
-
* {@link relation} factories; the engine reads them to index foreign keys for
|
|
5
|
-
* fast child lookups, to order inserts so a parent row lands before the rows
|
|
6
|
-
* that reference it, and to generate the accessor properties that let you read
|
|
7
|
-
* `task.project` or `project.tasks` directly.
|
|
8
|
-
*
|
|
9
|
-
* Usage:
|
|
10
|
-
* import { relation } from '@abloatai/ablo/schema';
|
|
11
|
-
*
|
|
12
|
-
* const taskRelations = {
|
|
13
|
-
* project: relation.belongsTo('projects', 'projectId'),
|
|
14
|
-
* assignee: relation.belongsTo('users', 'assigneeId'),
|
|
15
|
-
* comments: relation.hasMany('comments', 'taskId'),
|
|
16
|
-
* };
|
|
17
|
-
*/
|
|
18
|
-
// ── Internal relation builder ─────────────────────────────────────────────
|
|
19
|
-
class RelationBuilder {
|
|
20
|
-
type;
|
|
21
|
-
target;
|
|
22
|
-
foreignKey;
|
|
23
|
-
/**
|
|
24
|
-
* Starts out identical to {@link foreignKey}. `defineSchema` overwrites
|
|
25
|
-
* this when a `casing` option is set — it's declared as a mutable
|
|
26
|
-
* (non-readonly on the implementation side) so the schema builder can
|
|
27
|
-
* resolve it once at build time without allocating a new object per
|
|
28
|
-
* relation. Consumers see it typed as `readonly` on {@link RelationDef}.
|
|
29
|
-
*/
|
|
30
|
-
foreignKeyColumn;
|
|
31
|
-
options;
|
|
32
|
-
/**
|
|
33
|
-
* Stashed by `hasMany` when the caller provides `{ orderBy }`. Read
|
|
34
|
-
* back in `createSyncEngine` to install the sort comparator on the
|
|
35
|
-
* generated relation getter. Declared on the builder so both writer
|
|
36
|
-
* and reader stay type-safe — no double-cast smuggle through `Record<...>`.
|
|
37
|
-
*/
|
|
38
|
-
_orderBy;
|
|
39
|
-
constructor(type, target, foreignKey, options) {
|
|
40
|
-
this.type = type;
|
|
41
|
-
this.target = target;
|
|
42
|
-
this.foreignKey = foreignKey;
|
|
43
|
-
this.foreignKeyColumn = foreignKey;
|
|
44
|
-
this.options = (options ?? {});
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
// ── Public relation factories ─────────────────────────────────────────────
|
|
48
|
-
export const relation = {
|
|
49
|
-
/**
|
|
50
|
-
* This model belongs to another model via a foreign key.
|
|
51
|
-
* e.g., Task belongs to Project via projectId
|
|
52
|
-
*
|
|
53
|
-
* ```ts
|
|
54
|
-
* // Simple reference (no options)
|
|
55
|
-
* project: relation.belongsTo('projects', 'projectId'),
|
|
56
|
-
*
|
|
57
|
-
* // Register an FK index for O(1) child lookups
|
|
58
|
-
* section: relation.belongsTo('sections', 'sectionId', { index: true }),
|
|
59
|
-
*
|
|
60
|
-
* // Auto-populate the parent on delta arrival
|
|
61
|
-
* team: relation.belongsTo('teams', 'teamId', { enrich: true }),
|
|
62
|
-
*
|
|
63
|
-
* // Both
|
|
64
|
-
* parent: relation.belongsTo('threads', 'parentId', { index: true, enrich: true }),
|
|
65
|
-
*
|
|
66
|
-
* // Mark the soft side of a cycle so the priority computer breaks
|
|
67
|
-
* // the cycle deterministically instead of tying the two models.
|
|
68
|
-
* report: relation.belongsTo('reports', 'reportId', { defer: true }),
|
|
69
|
-
* ```
|
|
70
|
-
*/
|
|
71
|
-
belongsTo(target, foreignKey, options) {
|
|
72
|
-
return new RelationBuilder('belongsTo', target, foreignKey, options ?? {});
|
|
73
|
-
},
|
|
74
|
-
/**
|
|
75
|
-
* This model has many of another model — for example, a project has many
|
|
76
|
-
* tasks via `Task.projectId`.
|
|
77
|
-
*
|
|
78
|
-
* At runtime the engine adds a getter to the parent model that returns every
|
|
79
|
-
* child whose foreign key matches, and registers the foreign-key index on the
|
|
80
|
-
* child model automatically.
|
|
81
|
-
*
|
|
82
|
-
* ```ts
|
|
83
|
-
* blocks: relation.hasMany('blocks', 'sectionId'),
|
|
84
|
-
* // → section.blocks returns all Block[] where sectionId === section.id
|
|
85
|
-
*
|
|
86
|
-
* blocks: relation.hasMany('blocks', 'sectionId', { orderBy: 'zIndex' }),
|
|
87
|
-
* // → section.blocks returns Block[] sorted by zIndex ascending
|
|
88
|
-
* ```
|
|
89
|
-
*/
|
|
90
|
-
hasMany(target, foreignKey, options) {
|
|
91
|
-
const builder = new RelationBuilder('hasMany', target, foreignKey);
|
|
92
|
-
if (options?.orderBy) {
|
|
93
|
-
builder._orderBy = options.orderBy;
|
|
94
|
-
}
|
|
95
|
-
return builder;
|
|
96
|
-
},
|
|
97
|
-
/**
|
|
98
|
-
* This model has one of another model — for example, a user has one profile
|
|
99
|
-
* via `Profile.userId`.
|
|
100
|
-
*/
|
|
101
|
-
hasOne(target, foreignKey) {
|
|
102
|
-
return new RelationBuilder('hasOne', target, foreignKey);
|
|
103
|
-
},
|
|
104
|
-
};
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A model's residency: which database its rows live in. This is a sibling axis
|
|
3
|
-
* to `tenancy`, which instead describes how rows are isolated within a single
|
|
4
|
-
* database.
|
|
5
|
-
*
|
|
6
|
-
* - `tenant` — the tenant data plane. For a customer-connected database this
|
|
7
|
-
* is the customer's own database, and provisioning creates these
|
|
8
|
-
* tables there.
|
|
9
|
-
* - `control` — the coordination plane the engine owns: the change log,
|
|
10
|
-
* attribution, audit, and the like. These tables are never
|
|
11
|
-
* created in a customer's database.
|
|
12
|
-
*
|
|
13
|
-
* The name is `residency` rather than `plane` because "plane" already refers to
|
|
14
|
-
* the server's tenancy scope — organization, environment, and optionally
|
|
15
|
-
* project and sandbox. On the wire the serialized option is still keyed as
|
|
16
|
-
* `plane`, a frozen part of the wire format; only the TypeScript name differs.
|
|
17
|
-
*
|
|
18
|
-
* Declaring this boundary lets provisioning derive what a customer's database
|
|
19
|
-
* receives — the models whose residency is `tenant` — rather than hand-coding
|
|
20
|
-
* that list. Defaults to `tenant`.
|
|
21
|
-
*/
|
|
22
|
-
import { z } from 'zod';
|
|
23
|
-
export declare const residencySchema: z.ZodEnum<{
|
|
24
|
-
tenant: "tenant";
|
|
25
|
-
control: "control";
|
|
26
|
-
}>;
|
|
27
|
-
export type ModelResidency = z.infer<typeof residencySchema>;
|
|
28
|
-
/** Default residency for a model that doesn't declare one — the tenant data plane. */
|
|
29
|
-
export declare const DEFAULT_RESIDENCY: ModelResidency;
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A model's residency: which database its rows live in. This is a sibling axis
|
|
3
|
-
* to `tenancy`, which instead describes how rows are isolated within a single
|
|
4
|
-
* database.
|
|
5
|
-
*
|
|
6
|
-
* - `tenant` — the tenant data plane. For a customer-connected database this
|
|
7
|
-
* is the customer's own database, and provisioning creates these
|
|
8
|
-
* tables there.
|
|
9
|
-
* - `control` — the coordination plane the engine owns: the change log,
|
|
10
|
-
* attribution, audit, and the like. These tables are never
|
|
11
|
-
* created in a customer's database.
|
|
12
|
-
*
|
|
13
|
-
* The name is `residency` rather than `plane` because "plane" already refers to
|
|
14
|
-
* the server's tenancy scope — organization, environment, and optionally
|
|
15
|
-
* project and sandbox. On the wire the serialized option is still keyed as
|
|
16
|
-
* `plane`, a frozen part of the wire format; only the TypeScript name differs.
|
|
17
|
-
*
|
|
18
|
-
* Declaring this boundary lets provisioning derive what a customer's database
|
|
19
|
-
* receives — the models whose residency is `tenant` — rather than hand-coding
|
|
20
|
-
* that list. Defaults to `tenant`.
|
|
21
|
-
*/
|
|
22
|
-
import { z } from 'zod';
|
|
23
|
-
export const residencySchema = z.enum(['tenant', 'control']);
|
|
24
|
-
/** Default residency for a model that doesn't declare one — the tenant data plane. */
|
|
25
|
-
export const DEFAULT_RESIDENCY = 'tenant';
|
|
@@ -1,249 +0,0 @@
|
|
|
1
|
-
import { z } from 'zod';
|
|
2
|
-
/**
|
|
3
|
-
* Sync-group roles — the fan-out vocabulary, as typed data.
|
|
4
|
-
*
|
|
5
|
-
* A *sync group* is the unit the broadcast layer routes deltas on. On the wire
|
|
6
|
-
* it's a `kind:id` string, but that serialization is owned entirely by this
|
|
7
|
-
* module — callers never hand-write `'org:abc'`. Instead they declare a typed
|
|
8
|
-
* {@link Role} (`kind` + which field supplies the id) and the engine mints the
|
|
9
|
-
* branded {@link SyncGroup} string via {@link syncGroup}.
|
|
10
|
-
*
|
|
11
|
-
* Two reading directions, one shape:
|
|
12
|
-
*
|
|
13
|
-
* • {@link IdentityRole} — "which groups may this *participant* subscribe to?"
|
|
14
|
-
* Reads fields off an identity context (`organizationId`, `teamIds`).
|
|
15
|
-
*
|
|
16
|
-
* • {@link EntityRole} — "which groups does this *record* live in?" Reads
|
|
17
|
-
* fields off the record itself (`id`, `reportId`), so the server can fan a
|
|
18
|
-
* committed delta to the right entity streams regardless of what the
|
|
19
|
-
* committer was subscribed to.
|
|
20
|
-
*
|
|
21
|
-
* Roles are pure data (no closures) so a `Schema` round-trips through the
|
|
22
|
-
* control plane and the reconstructed copy behaves identically.
|
|
23
|
-
*/
|
|
24
|
-
/**
|
|
25
|
-
* The branded wire form of a sync group: `${kind}:${id}`. Branded so a raw
|
|
26
|
-
* string can't masquerade as one — the only way to produce a `SyncGroup` is
|
|
27
|
-
* {@link syncGroup}. Because the brand is an intersection it's still assignable
|
|
28
|
-
* *to* `string`, so existing `string[]` plumbing keeps working unchanged.
|
|
29
|
-
*/
|
|
30
|
-
export declare const syncGroupSchema: z.core.$ZodBranded<z.ZodTemplateLiteral<`${string}:${string}`>, "SyncGroup", "out">;
|
|
31
|
-
export type SyncGroup = z.infer<typeof syncGroupSchema>;
|
|
32
|
-
/**
|
|
33
|
-
* Mint a sync-group string. The single place the `kind:id` convention lives —
|
|
34
|
-
* if the wire format ever changes (structured columns, a different separator),
|
|
35
|
-
* it changes here and nowhere else.
|
|
36
|
-
*/
|
|
37
|
-
export declare function syncGroup(kind: string, id: string): SyncGroup;
|
|
38
|
-
/**
|
|
39
|
-
* The caller-facing input form of a sync group. Accepts a {@link SyncGroup}
|
|
40
|
-
* from the constructor, a template literal of the right shape
|
|
41
|
-
* (`` `org:${orgId}` `` type-checks without importing the constructor), or the
|
|
42
|
-
* reserved `'default'` anchor. A plain string with no colon is a compile error,
|
|
43
|
-
* because it would match no group and silently subscribe to nothing.
|
|
44
|
-
*/
|
|
45
|
-
export type SyncGroupInput = SyncGroup | `${string}:${string}` | 'default';
|
|
46
|
-
/**
|
|
47
|
-
* Runtime validation for {@link SyncGroupInput}, used wherever a group crosses a
|
|
48
|
-
* trust boundary such as minting a capability or an ephemeral key. A malformed
|
|
49
|
-
* group is rejected with `invalid_sync_group` rather than stored and left
|
|
50
|
-
* silently subscribed to nothing.
|
|
51
|
-
*/
|
|
52
|
-
export declare const syncGroupInputSchema: z.ZodUnion<readonly [z.ZodLiteral<"default">, z.core.$ZodBranded<z.ZodTemplateLiteral<`${string}:${string}`>, "SyncGroup", "out">]>;
|
|
53
|
-
/** Runtime guard matching {@link SyncGroupInput}. */
|
|
54
|
-
export declare function isSyncGroupInput(value: unknown): value is SyncGroupInput;
|
|
55
|
-
/**
|
|
56
|
-
* The sync-group kinds the authentication provider mints directly onto an
|
|
57
|
-
* identity. This is a fixed vocabulary: add to this list rather than write a
|
|
58
|
-
* new namespace string inline.
|
|
59
|
-
*
|
|
60
|
-
* - `org:<organizationId>` — every member of the organization
|
|
61
|
-
* - `user:<participantId>` — the participant itself
|
|
62
|
-
* - `project:<projectId>` — every credential scoped to the project; the
|
|
63
|
-
* organization's default project shares the organization's id
|
|
64
|
-
*
|
|
65
|
-
* Schema-declared roles ({@link identityRole} and {@link entityRole}) extend
|
|
66
|
-
* this vocabulary per application; the kinds here are the ones the engine
|
|
67
|
-
* reserves.
|
|
68
|
-
*/
|
|
69
|
-
export declare const IDENTITY_ANCHOR_KINDS: readonly ["org", "user", "project"];
|
|
70
|
-
export type IdentityAnchorKind = (typeof IDENTITY_ANCHOR_KINDS)[number];
|
|
71
|
-
/** Mint an engine-reserved identity anchor (typed wrapper over {@link syncGroup}). */
|
|
72
|
-
export declare function identityAnchor(kind: IdentityAnchorKind, id: string): SyncGroup;
|
|
73
|
-
/** Validates how a role pulls ids out of a context (identity or record). */
|
|
74
|
-
export declare const roleSourceSchema: z.ZodObject<{
|
|
75
|
-
field: z.ZodString;
|
|
76
|
-
multi: z.ZodBoolean;
|
|
77
|
-
}, z.core.$strip>;
|
|
78
|
-
export type RoleSource = z.infer<typeof roleSourceSchema>;
|
|
79
|
-
/** Back-compat alias — historical name for {@link RoleSource}. */
|
|
80
|
-
export type IdentityRoleSource = RoleSource;
|
|
81
|
-
/** Record-side name for {@link RoleSource}. */
|
|
82
|
-
export type EntityRoleSource = RoleSource;
|
|
83
|
-
/** Free-form context a role reads from. */
|
|
84
|
-
export type RoleContext = Record<string, unknown>;
|
|
85
|
-
/** The identity shape an {@link IdentityRole} reads from. */
|
|
86
|
-
export type IdentityContext = RoleContext;
|
|
87
|
-
/** The record shape an {@link EntityRole} reads from. */
|
|
88
|
-
export type EntityContext = RoleContext;
|
|
89
|
-
/**
|
|
90
|
-
* A sync-group role: a typed `kind` plus the field that supplies the id. The
|
|
91
|
-
* wire string is `${kind}:${id}`, built by the engine — there is deliberately
|
|
92
|
-
* no template/placeholder for the author to get wrong.
|
|
93
|
-
*/
|
|
94
|
-
export declare const roleSchema: z.ZodObject<{
|
|
95
|
-
kind: z.ZodString;
|
|
96
|
-
source: z.ZodObject<{
|
|
97
|
-
field: z.ZodString;
|
|
98
|
-
multi: z.ZodBoolean;
|
|
99
|
-
}, z.core.$strip>;
|
|
100
|
-
}, z.core.$strip>;
|
|
101
|
-
export type Role = z.infer<typeof roleSchema>;
|
|
102
|
-
/**
|
|
103
|
-
* Identity-anchored role. Reads an identity field; `kind` names the group.
|
|
104
|
-
*
|
|
105
|
-
* ```ts
|
|
106
|
-
* identityRole({ kind: 'org', source: 'organizationId' })
|
|
107
|
-
* identityRole({ kind: 'team', source: 'teamIds', multi: true })
|
|
108
|
-
* ```
|
|
109
|
-
*/
|
|
110
|
-
export type IdentityRole = Role;
|
|
111
|
-
/**
|
|
112
|
-
* Record-anchored role. Reads a record field; `kind` names the group. A record
|
|
113
|
-
* can route to a group keyed by its own `id` *or* a foreign key like `reportId`.
|
|
114
|
-
*
|
|
115
|
-
* ```ts
|
|
116
|
-
* entityRole({ kind: 'report', source: 'id' }) // a report → report:<id>
|
|
117
|
-
* entityRole({ kind: 'report', source: 'reportId' }) // a block → its parent report
|
|
118
|
-
* ```
|
|
119
|
-
*/
|
|
120
|
-
export type EntityRole = Role;
|
|
121
|
-
/** Validates an {@link IdentityRole}. */
|
|
122
|
-
export declare const identityRoleSchema: z.ZodType<IdentityRole>;
|
|
123
|
-
/** Validates an {@link EntityRole}. */
|
|
124
|
-
export declare const entityRoleSchema: z.ZodType<EntityRole>;
|
|
125
|
-
/**
|
|
126
|
-
* Validates a model's `scope` declaration: `true` (kind = typename) or an
|
|
127
|
-
* explicit lowercase kind string. The same vocabulary the roles use, so the
|
|
128
|
-
* whole sync-group declaration surface is Zod-validated, not hand-checked.
|
|
129
|
-
*/
|
|
130
|
-
export declare const scopeSchema: z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>;
|
|
131
|
-
/**
|
|
132
|
-
* Validates a model's `grants` membership edge. Both values are relation names
|
|
133
|
-
* declared on the same model (`subject` → identity, `scope` → scope root); that
|
|
134
|
-
* the relations actually exist + are `belongsTo` is a cross-field check done in
|
|
135
|
-
* `defineSchema` where the relation map is in scope.
|
|
136
|
-
*/
|
|
137
|
-
export declare const grantsRefSchema: z.ZodObject<{
|
|
138
|
-
subject: z.ZodString;
|
|
139
|
-
scope: z.ZodString;
|
|
140
|
-
}, z.core.$strip>;
|
|
141
|
-
/**
|
|
142
|
-
* The authoring form of a model's sync-group routing — the `groups: { ... }`
|
|
143
|
-
* option. One object collects the three independent routing controls. This is a
|
|
144
|
-
* separate concern from `policy`, which governs tenant isolation: `policy`
|
|
145
|
-
* decides who may read a row, while `groups` decides which change channels a row
|
|
146
|
-
* fans into.
|
|
147
|
-
*
|
|
148
|
-
* - `root` — marks this model a scope root, so its records form the group
|
|
149
|
-
* `<kind>:<id>` (the kind defaults to the typename).
|
|
150
|
-
* - `grants` — a membership edge granting an identity access to a scope root.
|
|
151
|
-
* - `roles` — record-to-group roles keyed on a plain field rather than a
|
|
152
|
-
* relation, such as inbox fan-out. Accepts a single role or an array.
|
|
153
|
-
*/
|
|
154
|
-
export declare const groupsInputSchema: z.ZodObject<{
|
|
155
|
-
root: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
|
|
156
|
-
grants: z.ZodOptional<z.ZodObject<{
|
|
157
|
-
subject: z.ZodString;
|
|
158
|
-
scope: z.ZodString;
|
|
159
|
-
}, z.core.$strip>>;
|
|
160
|
-
roles: z.ZodOptional<z.ZodUnion<readonly [z.ZodType<{
|
|
161
|
-
kind: string;
|
|
162
|
-
source: {
|
|
163
|
-
field: string;
|
|
164
|
-
multi: boolean;
|
|
165
|
-
};
|
|
166
|
-
}, unknown, z.core.$ZodTypeInternals<{
|
|
167
|
-
kind: string;
|
|
168
|
-
source: {
|
|
169
|
-
field: string;
|
|
170
|
-
multi: boolean;
|
|
171
|
-
};
|
|
172
|
-
}, unknown>>, z.ZodArray<z.ZodType<{
|
|
173
|
-
kind: string;
|
|
174
|
-
source: {
|
|
175
|
-
field: string;
|
|
176
|
-
multi: boolean;
|
|
177
|
-
};
|
|
178
|
-
}, unknown, z.core.$ZodTypeInternals<{
|
|
179
|
-
kind: string;
|
|
180
|
-
source: {
|
|
181
|
-
field: string;
|
|
182
|
-
multi: boolean;
|
|
183
|
-
};
|
|
184
|
-
}, unknown>>>]>>;
|
|
185
|
-
}, z.core.$strip>;
|
|
186
|
-
export type GroupsInput = z.infer<typeof groupsInputSchema>;
|
|
187
|
-
/** Build an identity-anchored role. `multi` defaults to `false`. */
|
|
188
|
-
export declare function identityRole(spec: {
|
|
189
|
-
readonly kind: string;
|
|
190
|
-
/** Identity-context field to read. See {@link RoleSource.field}. */
|
|
191
|
-
readonly source: string;
|
|
192
|
-
/** Treat the field as an array of ids. See {@link RoleSource.multi}. */
|
|
193
|
-
readonly multi?: boolean;
|
|
194
|
-
}): IdentityRole;
|
|
195
|
-
/** Build a record-anchored role. `multi` defaults to `false`. */
|
|
196
|
-
export declare function entityRole(spec: {
|
|
197
|
-
readonly kind: string;
|
|
198
|
-
/** Record field to read. See {@link RoleSource.field}. */
|
|
199
|
-
readonly source: string;
|
|
200
|
-
/** Treat the field as an array of ids. See {@link RoleSource.multi}. */
|
|
201
|
-
readonly multi?: boolean;
|
|
202
|
-
}): EntityRole;
|
|
203
|
-
/**
|
|
204
|
-
* Evaluate a {@link RoleSource} against a context. Absent or falsy fields yield
|
|
205
|
-
* `[]`, so a role whose field isn't present (a user with no `teamIds`, a record
|
|
206
|
-
* with no `reportId`) is a silent no-op.
|
|
207
|
-
*/
|
|
208
|
-
export declare function extractRoleIds(context: RoleContext, source: RoleSource): readonly string[];
|
|
209
|
-
/** Identity-side name for {@link extractRoleIds}. */
|
|
210
|
-
export declare const extractIdentityIds: typeof extractRoleIds;
|
|
211
|
-
/** Record-side name for {@link extractRoleIds}. */
|
|
212
|
-
export declare const extractEntityIds: typeof extractRoleIds;
|
|
213
|
-
/**
|
|
214
|
-
* Compose the sync groups an identity may subscribe to, from the schema's
|
|
215
|
-
* registered {@link IdentityRole}s. Returns `[]` when no role produces an id;
|
|
216
|
-
* the caller treats `[]` as "no scope", not "match everything".
|
|
217
|
-
*/
|
|
218
|
-
export declare function composeIdentitySyncGroups(identity: IdentityContext, schema: {
|
|
219
|
-
readonly identityRoles: readonly IdentityRole[];
|
|
220
|
-
}): readonly SyncGroup[];
|
|
221
|
-
/**
|
|
222
|
-
* Compose the sync groups a record belongs to, from the model's registered
|
|
223
|
-
* {@link EntityRole}s. Mirror of {@link composeIdentitySyncGroups}, reading the
|
|
224
|
-
* record instead of an identity. Returns `[]` when the model has no entity
|
|
225
|
-
* roles (the delta then fans on its base `org:`/`user:` groups only).
|
|
226
|
-
*/
|
|
227
|
-
export declare function composeEntitySyncGroups(record: EntityContext, def: {
|
|
228
|
-
readonly entityRoles?: readonly EntityRole[];
|
|
229
|
-
}): readonly SyncGroup[];
|
|
230
|
-
/**
|
|
231
|
-
* Narrow a client's requested sync-group set to the groups it is actually
|
|
232
|
-
* allowed to subscribe to. This helper is fully generic — it never inspects the
|
|
233
|
-
* group strings — so it lives beside the composition helpers above.
|
|
234
|
-
*
|
|
235
|
-
* Behaviour:
|
|
236
|
-
* - If the client requested no groups, return the full identity-derived set,
|
|
237
|
-
* which is this participant's default subscription scope.
|
|
238
|
-
* - If the client requested some groups, keep only those that appear in the
|
|
239
|
-
* identity-derived allowed set and drop the rest, reporting the dropped
|
|
240
|
-
* groups through the optional `logDropped` callback.
|
|
241
|
-
* - If nothing survives the filter, fall back to the full allowed set rather
|
|
242
|
-
* than return `[]`, which would otherwise collapse to the server-side
|
|
243
|
-
* `'default'` fallback and deliver no changes at all.
|
|
244
|
-
*/
|
|
245
|
-
export declare function intersectRequestedWithAllowed(args: {
|
|
246
|
-
readonly requested: readonly string[];
|
|
247
|
-
readonly allowed: readonly string[];
|
|
248
|
-
readonly logDropped?: (dropped: readonly string[]) => void;
|
|
249
|
-
}): readonly string[];
|