@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,45 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* When a model's rows are loaded from the server.
|
|
3
|
-
*
|
|
4
|
-
* - `instant` — loaded during bootstrap, before the model is first used.
|
|
5
|
-
* - `lazy` — loaded all at once on first access.
|
|
6
|
-
*
|
|
7
|
-
* One declaration serves both sides of the seam. `LoadStrategy.instant` is the
|
|
8
|
-
* value the engine branches on once a model is registered; `'instant'` is the
|
|
9
|
-
* word an author writes in `model(…, { load })`. They are the same name because
|
|
10
|
-
* they are the same axis — a const object merged with the type of its own
|
|
11
|
-
* values, rather than an enum, because a string enum is nominal and would
|
|
12
|
-
* refuse the plain `'instant'` an author actually types.
|
|
13
|
-
*
|
|
14
|
-
* The set is deliberately this small. It previously named `partial`,
|
|
15
|
-
* `explicitlyRequested`, and `local` on the runtime side and `manual` on the
|
|
16
|
-
* authoring side, and not one of those was reachable end to end: `manual` had
|
|
17
|
-
* no implementation and resolved to `lazy`, while the other three had no way to
|
|
18
|
-
* be declared. A member no schema can produce, or no branch can observe, is a
|
|
19
|
-
* promise the engine has no way to keep.
|
|
20
|
-
*/
|
|
21
|
-
export declare const LoadStrategy: {
|
|
22
|
-
/** Loaded during startup, before it is first used — for models needed right away. */
|
|
23
|
-
readonly instant: "instant";
|
|
24
|
-
/** Loaded all at once the first time it is needed — for secondary models. */
|
|
25
|
-
readonly lazy: "lazy";
|
|
26
|
-
};
|
|
27
|
-
export type LoadStrategy = (typeof LoadStrategy)[keyof typeof LoadStrategy];
|
|
28
|
-
/** The strategy a model gets when it declares none. */
|
|
29
|
-
export declare const DEFAULT_LOAD_STRATEGY: LoadStrategy;
|
|
30
|
-
/**
|
|
31
|
-
* Whether a model's rows arrive in the bootstrap payload rather than on first
|
|
32
|
-
* access. This is the question the client asks when it builds the bootstrap
|
|
33
|
-
* subscription and the question the server asks when it assembles the payload,
|
|
34
|
-
* and the two must answer it identically or a model is requested by one side
|
|
35
|
-
* and withheld by the other.
|
|
36
|
-
*
|
|
37
|
-
* It is a function rather than a comparison spelled at each site because the
|
|
38
|
-
* sites disagreed about how to spell it: one asked `load !== 'lazy'`, another
|
|
39
|
-
* `load === 'instant'`, a third `load === 'lazy' ? … : …`. Against a two-member
|
|
40
|
-
* set those are the same predicate, so nothing failed. Against a third member
|
|
41
|
-
* they are three different predicates, and the first would have enrolled it in
|
|
42
|
-
* bootstrap while the second withheld it — the kind of split that surfaces as
|
|
43
|
-
* rows that never arrive, far from the line that caused it.
|
|
44
|
-
*/
|
|
45
|
-
export declare function loadsAtBootstrap(load: LoadStrategy | undefined): boolean;
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* When a model's rows are loaded from the server.
|
|
3
|
-
*
|
|
4
|
-
* - `instant` — loaded during bootstrap, before the model is first used.
|
|
5
|
-
* - `lazy` — loaded all at once on first access.
|
|
6
|
-
*
|
|
7
|
-
* One declaration serves both sides of the seam. `LoadStrategy.instant` is the
|
|
8
|
-
* value the engine branches on once a model is registered; `'instant'` is the
|
|
9
|
-
* word an author writes in `model(…, { load })`. They are the same name because
|
|
10
|
-
* they are the same axis — a const object merged with the type of its own
|
|
11
|
-
* values, rather than an enum, because a string enum is nominal and would
|
|
12
|
-
* refuse the plain `'instant'` an author actually types.
|
|
13
|
-
*
|
|
14
|
-
* The set is deliberately this small. It previously named `partial`,
|
|
15
|
-
* `explicitlyRequested`, and `local` on the runtime side and `manual` on the
|
|
16
|
-
* authoring side, and not one of those was reachable end to end: `manual` had
|
|
17
|
-
* no implementation and resolved to `lazy`, while the other three had no way to
|
|
18
|
-
* be declared. A member no schema can produce, or no branch can observe, is a
|
|
19
|
-
* promise the engine has no way to keep.
|
|
20
|
-
*/
|
|
21
|
-
export const LoadStrategy = {
|
|
22
|
-
/** Loaded during startup, before it is first used — for models needed right away. */
|
|
23
|
-
instant: 'instant',
|
|
24
|
-
/** Loaded all at once the first time it is needed — for secondary models. */
|
|
25
|
-
lazy: 'lazy',
|
|
26
|
-
};
|
|
27
|
-
/** The strategy a model gets when it declares none. */
|
|
28
|
-
export const DEFAULT_LOAD_STRATEGY = LoadStrategy.instant;
|
|
29
|
-
/**
|
|
30
|
-
* Whether a model's rows arrive in the bootstrap payload rather than on first
|
|
31
|
-
* access. This is the question the client asks when it builds the bootstrap
|
|
32
|
-
* subscription and the question the server asks when it assembles the payload,
|
|
33
|
-
* and the two must answer it identically or a model is requested by one side
|
|
34
|
-
* and withheld by the other.
|
|
35
|
-
*
|
|
36
|
-
* It is a function rather than a comparison spelled at each site because the
|
|
37
|
-
* sites disagreed about how to spell it: one asked `load !== 'lazy'`, another
|
|
38
|
-
* `load === 'instant'`, a third `load === 'lazy' ? … : …`. Against a two-member
|
|
39
|
-
* set those are the same predicate, so nothing failed. Against a third member
|
|
40
|
-
* they are three different predicates, and the first would have enrolled it in
|
|
41
|
-
* bootstrap while the second withheld it — the kind of split that surfaces as
|
|
42
|
-
* rows that never arrive, far from the line that caused it.
|
|
43
|
-
*/
|
|
44
|
-
export function loadsAtBootstrap(load) {
|
|
45
|
-
return (load ?? DEFAULT_LOAD_STRATEGY) === LoadStrategy.instant;
|
|
46
|
-
}
|
|
@@ -1,379 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Defines a model — one table's worth of fields, and one options object holding
|
|
3
|
-
* everything else the engine needs to know about it. A model is a Zod object schema
|
|
4
|
-
* paired with those options; the row type is inferred directly from Zod, with no
|
|
5
|
-
* separate type system to keep in sync.
|
|
6
|
-
*
|
|
7
|
-
* Usage:
|
|
8
|
-
* import { z } from 'zod';
|
|
9
|
-
* import { model, relation } from '@abloatai/ablo/schema';
|
|
10
|
-
*
|
|
11
|
-
* const tasks = model({
|
|
12
|
-
* title: z.string(),
|
|
13
|
-
* status: z.enum(['todo', 'doing', 'done']).default('todo'),
|
|
14
|
-
* projectId: z.string().optional(),
|
|
15
|
-
* }, {
|
|
16
|
-
* relations: { project: relation.belongsTo('projects', 'projectId') },
|
|
17
|
-
* load: 'lazy',
|
|
18
|
-
* });
|
|
19
|
-
*/
|
|
20
|
-
import { z } from 'zod';
|
|
21
|
-
import type { RelationDef } from './relation.js';
|
|
22
|
-
import type { EntityRole, GroupsInput } from './roles.js';
|
|
23
|
-
import { type FieldMeta } from './field.js';
|
|
24
|
-
import { type Tenancy, type PolicyInput } from './tenancy.js';
|
|
25
|
-
export type { ScopedViaRef, Tenancy, PolicyInput } from './tenancy.js';
|
|
26
|
-
import { type ModelResidency } from './residency.js';
|
|
27
|
-
import type { ConflictAxis } from '../policy/types.js';
|
|
28
|
-
export type { ConflictAxis } from '../policy/types.js';
|
|
29
|
-
import { LoadStrategy } from './loadStrategy.js';
|
|
30
|
-
export { LoadStrategy, DEFAULT_LOAD_STRATEGY, loadsAtBootstrap } from './loadStrategy.js';
|
|
31
|
-
/** A record of relation definitions */
|
|
32
|
-
export type RelationRecord = Record<string, RelationDef>;
|
|
33
|
-
/**
|
|
34
|
-
* Persistence hints for IndexedDB write-through and hydration.
|
|
35
|
-
*
|
|
36
|
-
* The sync engine's generic loader uses these to route incoming rows to
|
|
37
|
-
* the right client-side store without the consumer wiring each model by
|
|
38
|
-
* hand. `store` defaults to the model's {@link ModelDef.typename} (which
|
|
39
|
-
* itself defaults to the schema key), so consumers only set this when
|
|
40
|
-
* the IDB store name diverges from the typename.
|
|
41
|
-
*/
|
|
42
|
-
export interface PersistOptions {
|
|
43
|
-
/**
|
|
44
|
-
* Name of the IndexedDB object store that backs this model.
|
|
45
|
-
* Defaults to the model's {@link ModelDef.typename}.
|
|
46
|
-
*/
|
|
47
|
-
store?: string;
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* Declares a membership edge on a join model. See {@link ModelOptions.grants}
|
|
51
|
-
* for semantics and how the server membership resolver reads it. Both fields
|
|
52
|
-
* name `belongsTo` relations declared on the same model.
|
|
53
|
-
*/
|
|
54
|
-
export interface GrantsRef {
|
|
55
|
-
/** Relation name pointing at the identity that gains access (e.g. `'user'`). */
|
|
56
|
-
subject: string;
|
|
57
|
-
/** Relation name pointing at the scope-root entity (e.g. `'workspace'`). */
|
|
58
|
-
scope: string;
|
|
59
|
-
}
|
|
60
|
-
/** Options for model() */
|
|
61
|
-
export interface ModelOptions {
|
|
62
|
-
/**
|
|
63
|
-
* Edges from this model to others, keyed by the accessor name they create. The
|
|
64
|
-
* engine reads them to index foreign keys, to order inserts so a parent row lands
|
|
65
|
-
* before the rows referencing it, and to generate the accessors that let you read
|
|
66
|
-
* `task.project` or `project.tasks` directly. Built with the {@link relation}
|
|
67
|
-
* factories.
|
|
68
|
-
*
|
|
69
|
-
* ```ts
|
|
70
|
-
* relations: {
|
|
71
|
-
* project: relation.belongsTo('projects', 'projectId'),
|
|
72
|
-
* comments: relation.hasMany('comments', 'taskId'),
|
|
73
|
-
* }
|
|
74
|
-
* ```
|
|
75
|
-
*/
|
|
76
|
-
relations?: RelationRecord;
|
|
77
|
-
/** When to load this model's data. Default: 'instant' */
|
|
78
|
-
load?: LoadStrategy;
|
|
79
|
-
/** Max records to bootstrap. Default: unlimited. Only applies to 'instant' strategy. */
|
|
80
|
-
bootstrapLimit?: number;
|
|
81
|
-
/** Order to sort by during bootstrap (e.g., 'created_at DESC'). */
|
|
82
|
-
bootstrapOrderBy?: string;
|
|
83
|
-
/**
|
|
84
|
-
* The wire type name for this model — the value that identifies its rows on the
|
|
85
|
-
* wire (the `__typename`). The loader stamps it onto incoming rows and uses it to
|
|
86
|
-
* find the matching model class. It defaults to the schema key (`tasks` →
|
|
87
|
-
* `'tasks'`); set it explicitly when the wire shape uses different casing, such as
|
|
88
|
-
* schema key `block` mapping to typename `'Block'`.
|
|
89
|
-
*
|
|
90
|
-
* This is the one value that identifies the model on the wire; the client-side
|
|
91
|
-
* store name, query result references, and delta routing all resolve through it.
|
|
92
|
-
*/
|
|
93
|
-
typename?: string;
|
|
94
|
-
/**
|
|
95
|
-
* IndexedDB persistence hints. See {@link PersistOptions}.
|
|
96
|
-
*/
|
|
97
|
-
persist?: PersistOptions;
|
|
98
|
-
/**
|
|
99
|
-
* The database table this model maps to. Defaults to the snake_case form of the
|
|
100
|
-
* model name. Set it when the real table name does not follow that convention, so
|
|
101
|
-
* queries read from the right table instead of a guessed name.
|
|
102
|
-
*/
|
|
103
|
-
tableName?: string;
|
|
104
|
-
/**
|
|
105
|
-
* Row-access policy — decides which rows a tenant may read at all. A discriminated
|
|
106
|
-
* union on `by`:
|
|
107
|
-
*
|
|
108
|
-
* - `{ by: 'column' }` — the row carries its own tenancy column (the default when
|
|
109
|
-
* omitted). `column` overrides the column name, which defaults to
|
|
110
|
-
* `organization_id`.
|
|
111
|
-
* - `{ by: 'parent', fk, parent }` — inherit tenancy through a foreign key when the
|
|
112
|
-
* table has no tenancy column of its own (for example `blocks` → section →
|
|
113
|
-
* report → organization). In place of `organization_id = $1` the read emits
|
|
114
|
-
* `WHERE <table>.<fk> IN (SELECT <parentKey> FROM <parent> WHERE
|
|
115
|
-
* <parentTenantColumn> = $1)`. Use it for any `load: 'instant'` child table that
|
|
116
|
-
* would otherwise expose other tenants' rows at bootstrap.
|
|
117
|
-
* - `{ by: 'none' }` — genuinely global or reference data, such as a lookup table.
|
|
118
|
-
* This makes the whole table readable across tenants, so it is only correct for
|
|
119
|
-
* tables that have no tenant at all. It is a named branch rather than a falsy
|
|
120
|
-
* flag, so it cannot be selected by accident.
|
|
121
|
-
*
|
|
122
|
-
* {@link resolvePolicy} normalizes this into the canonical {@link Tenancy} when the
|
|
123
|
-
* model is built.
|
|
124
|
-
*/
|
|
125
|
-
policy?: PolicyInput;
|
|
126
|
-
/**
|
|
127
|
-
* Which database a model's rows live in. `tenant` (the default) is tenant data
|
|
128
|
-
* that provisioning places in the customer's own database; `control` is Ablo's own
|
|
129
|
-
* data — the sync log, attribution, and audit records — which never leaves Ablo's
|
|
130
|
-
* database. See {@link ModelResidency}.
|
|
131
|
-
*/
|
|
132
|
-
plane?: ModelResidency;
|
|
133
|
-
/**
|
|
134
|
-
* Sync-group routing — decides which delta channels a row fans out to. This is
|
|
135
|
-
* independent of {@link policy}, which governs read access. One object with three
|
|
136
|
-
* optional parts:
|
|
137
|
-
*
|
|
138
|
-
* - `root` — marks this model a scope root, so each of its records forms the group
|
|
139
|
-
* `<kind>:<id>`. The kind defaults to the lowercased typename (`Report` →
|
|
140
|
-
* `report:<id>`); pass a string to override it (`root: 'matter'`). Child models
|
|
141
|
-
* inherit a root's group through their `belongsTo` relations.
|
|
142
|
-
* - `grants` — a membership edge that grants an identity access to a scope root.
|
|
143
|
-
* Both values name `belongsTo` relations on this model (`subject` names the
|
|
144
|
-
* identity, `scope` names the scope root). Use it only for sharing within an
|
|
145
|
-
* organization.
|
|
146
|
-
* - `roles` — explicit record-to-group roles keyed on a plain field, for routing
|
|
147
|
-
* that does not follow a relation, such as fanning a message into a recipient's
|
|
148
|
-
* inbox. Accepts one role or many.
|
|
149
|
-
*
|
|
150
|
-
* ```ts
|
|
151
|
-
* // dataroomMember: { userId, dataroomId }
|
|
152
|
-
* groups: { grants: { subject: 'user', scope: 'workspace' } }
|
|
153
|
-
* // a message → its addressee's inbox, keyed on `toId`
|
|
154
|
-
* groups: { roles: [entityRole({ kind: 'inbox', source: 'toId' })] }
|
|
155
|
-
* ```
|
|
156
|
-
*/
|
|
157
|
-
groups?: GroupsInput;
|
|
158
|
-
/**
|
|
159
|
-
* Write-conflict disposition, set per committer kind — decides what happens when a
|
|
160
|
-
* commit collides with another participant's claim or with a stale snapshot of this
|
|
161
|
-
* model. This is independent of {@link policy} (read access) and {@link groups}
|
|
162
|
-
* (delta routing). It is a map keyed by the committer's kind (`user`, `agent`, or
|
|
163
|
-
* `system`), with these outcomes as values:
|
|
164
|
-
*
|
|
165
|
-
* - `'overwrite'` — the write wins; that committer is never blocked.
|
|
166
|
-
* - `'reject'` — the write is refused; that committer yields.
|
|
167
|
-
* - `'notify'` — hold the write and hand the current value back so the committer
|
|
168
|
-
* re-reads and re-applies (for stale writes only).
|
|
169
|
-
*
|
|
170
|
-
* A kind you omit falls back to the engine default: reject, while honoring
|
|
171
|
-
* `onStale: 'notify'`. The value is plain data that travels with the schema to the
|
|
172
|
-
* server, where the engine interprets it. For example:
|
|
173
|
-
*
|
|
174
|
-
* ```ts
|
|
175
|
-
* // "a human's edit always wins (never blocked); an agent yields"
|
|
176
|
-
* conflict: { user: 'overwrite', agent: 'reject' }
|
|
177
|
-
* ```
|
|
178
|
-
*/
|
|
179
|
-
conflict?: ConflictAxis;
|
|
180
|
-
/**
|
|
181
|
-
* Whether clients may create, update, and delete this model's rows through the
|
|
182
|
-
* commit protocol. Defaults to true: declaring a model in your schema is the
|
|
183
|
-
* opt-in, since a synced entity is almost always one you want to write. A model
|
|
184
|
-
* left out of the mutation allowlist rejects writes with
|
|
185
|
-
* `server_execute_unknown_model`.
|
|
186
|
-
*
|
|
187
|
-
* Set `mutable: false` (or use the `readOnly.*` shorthand, which sets it for you)
|
|
188
|
-
* for server-managed projections such as stats, digests, or audit views, so those
|
|
189
|
-
* cannot be written from a client. The server derives its mutation allowlist from
|
|
190
|
-
* this flag; there is no separate hardcoded list to keep in step.
|
|
191
|
-
*/
|
|
192
|
-
mutable?: boolean;
|
|
193
|
-
/**
|
|
194
|
-
* Defer setting up MobX observability until the model is first accessed by an
|
|
195
|
-
* observing component. Defaults to false, which observes immediately.
|
|
196
|
-
*
|
|
197
|
-
* Use it for models created in bulk — during an import or a batch bootstrap —
|
|
198
|
-
* where most instances are never rendered. The constructor skips the observability
|
|
199
|
-
* setup, and calling `model.makeObservable()` performs it later when the model
|
|
200
|
-
* enters the render tree. This avoids roughly 10ms of setup per instance when
|
|
201
|
-
* creating hundreds of models that are never observed.
|
|
202
|
-
*/
|
|
203
|
-
lazyObservable?: boolean;
|
|
204
|
-
/**
|
|
205
|
-
* Computed getters to install on the model instance. Each key becomes a getter;
|
|
206
|
-
* its function receives the model instance as `self` and returns the computed
|
|
207
|
-
* value.
|
|
208
|
-
*
|
|
209
|
-
* @example
|
|
210
|
-
* model({ title: z.string(), metadata: z.string() }, {
|
|
211
|
-
* computed: {
|
|
212
|
-
* displayTitle: (self) => self.title || `Untitled`,
|
|
213
|
-
* metadataObject: (self) => {
|
|
214
|
-
* try { return JSON.parse(self.metadata || '{}'); }
|
|
215
|
-
* catch { return {}; }
|
|
216
|
-
* },
|
|
217
|
-
* },
|
|
218
|
-
* })
|
|
219
|
-
*/
|
|
220
|
-
computed?: ComputedRecord;
|
|
221
|
-
/**
|
|
222
|
-
* Fields to back-fill from the connected sync identity when a stored row is missing
|
|
223
|
-
* them, during self-healing of the local store.
|
|
224
|
-
*
|
|
225
|
-
* Healing runs on every row loaded from the local store at hydration and on every
|
|
226
|
-
* delta merge. When a row is missing one of these fields, the engine writes the
|
|
227
|
-
* matching identity value (the `organizationId` or `userId` passed to the sync
|
|
228
|
-
* client) into the row before it is loaded. Without this, rows written by an older
|
|
229
|
-
* version that did not set the field would read as `undefined` and break code that
|
|
230
|
-
* assumes it is present.
|
|
231
|
-
*
|
|
232
|
-
* @example
|
|
233
|
-
* autoFill: [
|
|
234
|
-
* { field: 'organizationId', from: 'organizationId' },
|
|
235
|
-
* { field: 'createdBy', from: 'userId' },
|
|
236
|
-
* ]
|
|
237
|
-
*/
|
|
238
|
-
autoFill?: readonly AutoFillRule[];
|
|
239
|
-
/**
|
|
240
|
-
* Fields whose absence marks a stored row as orphaned — corrupt enough that the
|
|
241
|
-
* engine drops it instead of loading it.
|
|
242
|
-
*
|
|
243
|
-
* During self-healing, a row missing any listed field is discarded rather than
|
|
244
|
-
* loaded. Use it for foreign keys whose absence would crash code that depends on
|
|
245
|
-
* them — for example a child row that cannot be placed without its parent's id.
|
|
246
|
-
*
|
|
247
|
-
* @example requiredFields: ['sectionId']
|
|
248
|
-
*/
|
|
249
|
-
requiredFields?: readonly string[];
|
|
250
|
-
}
|
|
251
|
-
/** Base type for computed getter records. Preserves return types via inference. */
|
|
252
|
-
export type ComputedRecord = Record<string, (self: any) => any>;
|
|
253
|
-
/**
|
|
254
|
-
* Identity sources the sync engine can pull from when auto-filling a
|
|
255
|
-
* record's missing field during IndexedDB self-healing.
|
|
256
|
-
*
|
|
257
|
-
* - `'organizationId'` — the org id passed to `SyncClient.initialize`
|
|
258
|
-
* - `'userId'` — the user id passed to `SyncClient.initialize`
|
|
259
|
-
*/
|
|
260
|
-
export type AutoFillSource = 'organizationId' | 'userId';
|
|
261
|
-
/**
|
|
262
|
-
* Declares one field to back-fill from the connected sync identity when it is
|
|
263
|
-
* missing from a stored row. The engine repairs rows during self-healing — for
|
|
264
|
-
* example rows written by an older version without an `organizationId` or
|
|
265
|
-
* `createdBy`. Declared per model, so the engine stays product-neutral.
|
|
266
|
-
*/
|
|
267
|
-
export interface AutoFillRule {
|
|
268
|
-
/** Field name on the model (e.g. `'organizationId'`, `'createdBy'`). */
|
|
269
|
-
field: string;
|
|
270
|
-
/** Where to read the replacement value from on the sync client. */
|
|
271
|
-
from: AutoFillSource;
|
|
272
|
-
}
|
|
273
|
-
/** A complete model definition: Zod shape + fields metadata + relations + options */
|
|
274
|
-
export interface ModelDef<Shape extends z.ZodRawShape = z.ZodRawShape, R extends RelationRecord = RelationRecord, C extends ComputedRecord = ComputedRecord> {
|
|
275
|
-
/** The Zod object schema for this model's fields */
|
|
276
|
-
readonly schema: z.ZodObject<Shape>;
|
|
277
|
-
/** The raw shape (for type inference) */
|
|
278
|
-
readonly shape: Shape;
|
|
279
|
-
/**
|
|
280
|
-
* Runtime metadata for each field, keyed by field name.
|
|
281
|
-
*
|
|
282
|
-
* Populated automatically from `field.*()` builders. Fields defined
|
|
283
|
-
* with raw Zod (e.g., `z.string()`) get a fallback metadata entry
|
|
284
|
-
* with type inferred from Zod's `_def.typeName`.
|
|
285
|
-
*
|
|
286
|
-
* Used by the CLI (`npx ablo migrate`), admin panels, and any tooling
|
|
287
|
-
* that needs to introspect the schema without parsing Zod internals.
|
|
288
|
-
*/
|
|
289
|
-
readonly fields: Record<string, FieldMeta>;
|
|
290
|
-
/** Relations to other models */
|
|
291
|
-
readonly relations: R;
|
|
292
|
-
/** Load strategy */
|
|
293
|
-
readonly load: LoadStrategy;
|
|
294
|
-
/** Max records to bootstrap */
|
|
295
|
-
readonly bootstrapLimit?: number;
|
|
296
|
-
/** Sort order for bootstrap */
|
|
297
|
-
readonly bootstrapOrderBy?: string;
|
|
298
|
-
/**
|
|
299
|
-
* The wire type name (`__typename`) for this model. When left unset in
|
|
300
|
-
* {@link ModelOptions}, it falls back to the schema key when the schema is
|
|
301
|
-
* assembled. See {@link ModelOptions.typename}.
|
|
302
|
-
*/
|
|
303
|
-
readonly typename?: string;
|
|
304
|
-
/** IndexedDB persistence hints. See {@link PersistOptions}. */
|
|
305
|
-
readonly persist?: PersistOptions;
|
|
306
|
-
/** The database table this model maps to. See {@link ModelOptions.tableName}. */
|
|
307
|
-
readonly tableName?: string;
|
|
308
|
-
/** The canonical tenancy descriptor for this model, normalized from the `policy`
|
|
309
|
-
* option at build time. See {@link ModelOptions.policy}. */
|
|
310
|
-
readonly tenancy: Tenancy;
|
|
311
|
-
/** Which database this model's rows live in — `tenant` (default) can be a
|
|
312
|
-
* customer's own database; `control` is Ablo's. See {@link ModelOptions.plane}. */
|
|
313
|
-
readonly plane?: ModelResidency;
|
|
314
|
-
/** Scope-root marker. See {@link ModelOptions.groups}. */
|
|
315
|
-
readonly scope?: boolean | string;
|
|
316
|
-
/** Membership edge granting an identity access to a scope root. See {@link ModelOptions.groups}. */
|
|
317
|
-
readonly grants?: GrantsRef;
|
|
318
|
-
/** Explicit record-to-group roles, normalized to an array. See {@link ModelOptions.groups}. */
|
|
319
|
-
readonly entityRoles?: readonly EntityRole[];
|
|
320
|
-
/** The write-conflict disposition per committer kind, carried as plain data. See
|
|
321
|
-
* {@link ModelOptions.conflict}. */
|
|
322
|
-
readonly conflict?: ConflictAxis;
|
|
323
|
-
/** Whether wire-level CREATE/UPDATE/DELETE is allowed. See {@link ModelOptions.mutable}. */
|
|
324
|
-
readonly mutable?: boolean;
|
|
325
|
-
/** Defer MobX setup until first observer access. See {@link ModelOptions.lazyObservable}. */
|
|
326
|
-
readonly lazyObservable?: boolean;
|
|
327
|
-
/** Computed getters for the dynamic model class. See {@link ModelOptions.computed}. */
|
|
328
|
-
readonly computed?: C;
|
|
329
|
-
/** Auto-fill rules for IDB self-healing. See {@link ModelOptions.autoFill}. */
|
|
330
|
-
readonly autoFill?: readonly AutoFillRule[];
|
|
331
|
-
/** Fields whose absence orphans a row. See {@link ModelOptions.requiredFields}. */
|
|
332
|
-
readonly requiredFields?: readonly string[];
|
|
333
|
-
}
|
|
334
|
-
/**
|
|
335
|
-
* Defines a model from a Zod shape and its options. The row type is inferred from
|
|
336
|
-
* the shape; fields built with the {@link field} builders carry extra metadata,
|
|
337
|
-
* while plain Zod fields get metadata inferred from their Zod type. Everything else
|
|
338
|
-
* about the model — its {@link ModelOptions.relations}, its {@link LoadStrategy},
|
|
339
|
-
* the table it maps to — lives in the second argument, so a model that needs one
|
|
340
|
-
* setting never has to name the settings it does not use.
|
|
341
|
-
*
|
|
342
|
-
* ```ts
|
|
343
|
-
* import { z } from 'zod';
|
|
344
|
-
* import { model, relation } from '@abloatai/ablo/schema';
|
|
345
|
-
*
|
|
346
|
-
* // Fields alone
|
|
347
|
-
* const tags = model({ label: z.string() });
|
|
348
|
-
*
|
|
349
|
-
* // Loaded at bootstrap (the default), with an edge to its project
|
|
350
|
-
* const tasks = model({
|
|
351
|
-
* title: z.string(),
|
|
352
|
-
* status: z.enum(['todo', 'doing', 'done']).default('todo'),
|
|
353
|
-
* projectId: z.string().optional(),
|
|
354
|
-
* }, {
|
|
355
|
-
* relations: { project: relation.belongsTo('projects', 'projectId') },
|
|
356
|
-
* });
|
|
357
|
-
*
|
|
358
|
-
* // Loaded on first access
|
|
359
|
-
* const blocks = model({ sectionId: z.string(), type: z.string() }, {
|
|
360
|
-
* relations: { section: relation.belongsTo('sections', 'sectionId') },
|
|
361
|
-
* load: 'lazy',
|
|
362
|
-
* });
|
|
363
|
-
* ```
|
|
364
|
-
*/
|
|
365
|
-
export declare function model<Shape extends z.ZodRawShape, R extends RelationRecord = Record<string, never>, C extends ComputedRecord = Record<string, never>>(shape: Shape, options?: ModelOptions & {
|
|
366
|
-
relations?: R;
|
|
367
|
-
computed?: C;
|
|
368
|
-
}): ModelDef<Shape, R, C>;
|
|
369
|
-
/**
|
|
370
|
-
* Returns the sync-group kind a scope-root model produces, or `undefined` when the
|
|
371
|
-
* model is not a scope root. `scope: true` derives the kind from the lowercased
|
|
372
|
-
* typename (`ReportSection` → `reportsection`); `scope: 'section'` sets it explicitly, which
|
|
373
|
-
* you use when the wire kind must differ from the typename. This is the single place
|
|
374
|
-
* that decides a record's own group, so every layer that reads it agrees.
|
|
375
|
-
*/
|
|
376
|
-
export declare function scopeKindOf(def: {
|
|
377
|
-
scope?: boolean | string;
|
|
378
|
-
typename?: string;
|
|
379
|
-
}, fallbackKey: string): string | undefined;
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Defines a model — one table's worth of fields, and one options object holding
|
|
3
|
-
* everything else the engine needs to know about it. A model is a Zod object schema
|
|
4
|
-
* paired with those options; the row type is inferred directly from Zod, with no
|
|
5
|
-
* separate type system to keep in sync.
|
|
6
|
-
*
|
|
7
|
-
* Usage:
|
|
8
|
-
* import { z } from 'zod';
|
|
9
|
-
* import { model, relation } from '@abloatai/ablo/schema';
|
|
10
|
-
*
|
|
11
|
-
* const tasks = model({
|
|
12
|
-
* title: z.string(),
|
|
13
|
-
* status: z.enum(['todo', 'doing', 'done']).default('todo'),
|
|
14
|
-
* projectId: z.string().optional(),
|
|
15
|
-
* }, {
|
|
16
|
-
* relations: { project: relation.belongsTo('projects', 'projectId') },
|
|
17
|
-
* load: 'lazy',
|
|
18
|
-
* });
|
|
19
|
-
*/
|
|
20
|
-
import { z } from 'zod';
|
|
21
|
-
import { getFieldMeta, inferFieldMetaFromZod } from './field.js';
|
|
22
|
-
// Tenancy lives in `tenancy.ts`. Authoring uses the `policy` option
|
|
23
|
-
// (`PolicyInput`), which `resolvePolicy` normalizes into the canonical `Tenancy`
|
|
24
|
-
// at build time.
|
|
25
|
-
import { resolvePolicy } from './tenancy.js';
|
|
26
|
-
import { DEFAULT_RESIDENCY } from './residency.js';
|
|
27
|
-
/** Normalize the `entityRoles` option (single | array | undefined) to an array. */
|
|
28
|
-
function normalizeEntityRoles(input) {
|
|
29
|
-
if (!input)
|
|
30
|
-
return undefined;
|
|
31
|
-
return Array.isArray(input) ? input : [input];
|
|
32
|
-
}
|
|
33
|
-
// ── Load strategies ───────────────────────────────────────────────────────
|
|
34
|
-
// Defined in `./loadStrategy.ts`. Imported as well as re-exported: a bare
|
|
35
|
-
// `export … from` would not bind the name for the `load` fields below.
|
|
36
|
-
import { LoadStrategy, DEFAULT_LOAD_STRATEGY } from './loadStrategy.js';
|
|
37
|
-
export { LoadStrategy, DEFAULT_LOAD_STRATEGY, loadsAtBootstrap } from './loadStrategy.js';
|
|
38
|
-
// ── Model factory ─────────────────────────────────────────────────────────
|
|
39
|
-
/**
|
|
40
|
-
* Defines a model from a Zod shape and its options. The row type is inferred from
|
|
41
|
-
* the shape; fields built with the {@link field} builders carry extra metadata,
|
|
42
|
-
* while plain Zod fields get metadata inferred from their Zod type. Everything else
|
|
43
|
-
* about the model — its {@link ModelOptions.relations}, its {@link LoadStrategy},
|
|
44
|
-
* the table it maps to — lives in the second argument, so a model that needs one
|
|
45
|
-
* setting never has to name the settings it does not use.
|
|
46
|
-
*
|
|
47
|
-
* ```ts
|
|
48
|
-
* import { z } from 'zod';
|
|
49
|
-
* import { model, relation } from '@abloatai/ablo/schema';
|
|
50
|
-
*
|
|
51
|
-
* // Fields alone
|
|
52
|
-
* const tags = model({ label: z.string() });
|
|
53
|
-
*
|
|
54
|
-
* // Loaded at bootstrap (the default), with an edge to its project
|
|
55
|
-
* const tasks = model({
|
|
56
|
-
* title: z.string(),
|
|
57
|
-
* status: z.enum(['todo', 'doing', 'done']).default('todo'),
|
|
58
|
-
* projectId: z.string().optional(),
|
|
59
|
-
* }, {
|
|
60
|
-
* relations: { project: relation.belongsTo('projects', 'projectId') },
|
|
61
|
-
* });
|
|
62
|
-
*
|
|
63
|
-
* // Loaded on first access
|
|
64
|
-
* const blocks = model({ sectionId: z.string(), type: z.string() }, {
|
|
65
|
-
* relations: { section: relation.belongsTo('sections', 'sectionId') },
|
|
66
|
-
* load: 'lazy',
|
|
67
|
-
* });
|
|
68
|
-
* ```
|
|
69
|
-
*/
|
|
70
|
-
export function model(shape, options) {
|
|
71
|
-
// Build the fields metadata record by walking the Zod shape.
|
|
72
|
-
// Fields built with `field.*()` have structured metadata; fields built
|
|
73
|
-
// with raw Zod get a fallback derived from the Zod typeName.
|
|
74
|
-
const fields = {};
|
|
75
|
-
for (const [name, zodType] of Object.entries(shape)) {
|
|
76
|
-
const meta = getFieldMeta(zodType);
|
|
77
|
-
if (meta) {
|
|
78
|
-
fields[name] = meta;
|
|
79
|
-
}
|
|
80
|
-
else {
|
|
81
|
-
fields[name] = inferFieldMetaFromZod(zodType);
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
return {
|
|
85
|
-
schema: z.object(shape),
|
|
86
|
-
shape,
|
|
87
|
-
fields,
|
|
88
|
-
relations: (options?.relations ?? {}),
|
|
89
|
-
load: options?.load ?? DEFAULT_LOAD_STRATEGY,
|
|
90
|
-
bootstrapLimit: options?.bootstrapLimit,
|
|
91
|
-
bootstrapOrderBy: options?.bootstrapOrderBy,
|
|
92
|
-
typename: options?.typename,
|
|
93
|
-
persist: options?.persist,
|
|
94
|
-
tableName: options?.tableName,
|
|
95
|
-
// Normalize the `policy` option into the canonical tenancy descriptor (defaults
|
|
96
|
-
// to a row-local organization column).
|
|
97
|
-
tenancy: resolvePolicy(options?.policy),
|
|
98
|
-
plane: options?.plane ?? DEFAULT_RESIDENCY,
|
|
99
|
-
// Unpack the `groups` option into the individual routing fields the server reads.
|
|
100
|
-
scope: options?.groups?.root,
|
|
101
|
-
grants: options?.groups?.grants,
|
|
102
|
-
entityRoles: normalizeEntityRoles(options?.groups?.roles),
|
|
103
|
-
// The conflict disposition is already plain data, so it passes through unchanged.
|
|
104
|
-
conflict: options?.conflict,
|
|
105
|
-
mutable: options?.mutable ?? true,
|
|
106
|
-
lazyObservable: options?.lazyObservable,
|
|
107
|
-
computed: options?.computed,
|
|
108
|
-
autoFill: options?.autoFill,
|
|
109
|
-
requiredFields: options?.requiredFields,
|
|
110
|
-
};
|
|
111
|
-
}
|
|
112
|
-
/**
|
|
113
|
-
* Returns the sync-group kind a scope-root model produces, or `undefined` when the
|
|
114
|
-
* model is not a scope root. `scope: true` derives the kind from the lowercased
|
|
115
|
-
* typename (`ReportSection` → `reportsection`); `scope: 'section'` sets it explicitly, which
|
|
116
|
-
* you use when the wire kind must differ from the typename. This is the single place
|
|
117
|
-
* that decides a record's own group, so every layer that reads it agrees.
|
|
118
|
-
*/
|
|
119
|
-
export function scopeKindOf(def, fallbackKey) {
|
|
120
|
-
if (!def.scope)
|
|
121
|
-
return undefined;
|
|
122
|
-
return (typeof def.scope === 'string' ? def.scope : (def.typename ?? fallbackKey)).toLowerCase();
|
|
123
|
-
}
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Two OpenAPI 3.1 documents describing the same API, for two different readers.
|
|
3
|
-
*
|
|
4
|
-
* The server registers ONE parameterised route family — `/api/v1/models/:model`
|
|
5
|
-
* and what hangs below it, plus the coordination, credential and commit
|
|
6
|
-
* resources. The count does not move when a tenant's schema does.
|
|
7
|
-
* Authentication is a single Bearer scheme, your API key.
|
|
8
|
-
*
|
|
9
|
-
* {@link abloOpenApi} publishes that family. It takes no schema, so it cannot
|
|
10
|
-
* grow with one: identical for every caller, stable across every push, and the
|
|
11
|
-
* document a Python or Go client is generated from once. `spec-covers-routes`
|
|
12
|
-
* holds it to the served surface in both directions, so this is the list of
|
|
13
|
-
* routes rather than a description of it.
|
|
14
|
-
*
|
|
15
|
-
* {@link schemaToOpenApi} expands the model half into one set per model, with
|
|
16
|
-
* payloads typed from each model's introspectable {@link FieldMeta}. Five paths
|
|
17
|
-
* per model, regenerated on every push — worth it when you want generated types
|
|
18
|
-
* for one schema, and the wrong thing to hand an agent.
|
|
19
|
-
*
|
|
20
|
-
* Both return a plain JSON-serializable object; feed either into codegen (for
|
|
21
|
-
* example `ablo openapi > openapi.json`) or serve it directly.
|
|
22
|
-
*/
|
|
23
|
-
import type { Schema, SchemaRecord } from './schema.js';
|
|
24
|
-
/** Options for {@link schemaToOpenApi} — the metadata stamped into the generated spec. */
|
|
25
|
-
export interface SchemaToOpenApiOptions {
|
|
26
|
-
/** Spec title. Default `"Ablo API"`. */
|
|
27
|
-
readonly title?: string;
|
|
28
|
-
/** Spec version. Default `"1.0.0"`. */
|
|
29
|
-
readonly version?: string;
|
|
30
|
-
/** API base URL. Default `"https://api.abloatai.com/api"`. */
|
|
31
|
-
readonly serverUrl?: string;
|
|
32
|
-
}
|
|
33
|
-
type Json = Record<string, unknown>;
|
|
34
|
-
/**
|
|
35
|
-
* The protocol reference: the route templates the server actually serves.
|
|
36
|
-
*
|
|
37
|
-
* This takes no schema, and that is the point. The server registers one
|
|
38
|
-
* parameterised route family (`/api/v1/models/:model/...`), so the surface is
|
|
39
|
-
* the same size no matter how many models a tenant defines — and a spec that
|
|
40
|
-
* cannot see a schema cannot grow with one. It is publishable once, identical
|
|
41
|
-
* for every caller, and stable across every schema push: the document a Python
|
|
42
|
-
* or Go client is generated from, and the surface an agent is handed.
|
|
43
|
-
*
|
|
44
|
-
* Payload shapes are generic here by design. A caller that wants them typed
|
|
45
|
-
* either reads the schema at runtime or generates the per-tenant expansion with
|
|
46
|
-
* {@link schemaToOpenApi}.
|
|
47
|
-
*/
|
|
48
|
-
export declare function abloOpenApi(options?: SchemaToOpenApiOptions): Json;
|
|
49
|
-
/**
|
|
50
|
-
* The per-tenant expansion: every model's routes written out with typed payloads.
|
|
51
|
-
*
|
|
52
|
-
* Useful when you want generated types for one schema — five paths per model, so
|
|
53
|
-
* it grows with the schema and is regenerated on every push. It documents the
|
|
54
|
-
* same five routes {@link abloOpenApi} describes; it does not describe a
|
|
55
|
-
* different API.
|
|
56
|
-
*/
|
|
57
|
-
export declare function schemaToOpenApi<S extends SchemaRecord>(schema: Schema<S>, options?: SchemaToOpenApiOptions): Json;
|
|
58
|
-
export {};
|