Protocol Reference

Every schema published by @objectstack/spec — 1570 schemas across 14 protocol modules

This is the complete reference for every protocol schema published by @objectstack/spec. Each protocol is defined as a Zod schema (Prime Directive #1), which is where its runtime validation, its TypeScript type and its JSON Schema all come from.

This index — like every page under it — is generated from the Zod sources in packages/spec/src/ by packages/spec/scripts/build-docs.ts. Its rows are enumerated from the same JSON Schema output the reference pages are built from, so a schema that no longer exists cannot keep a row here, and the counts are sums of the rows they head. Regenerate with pnpm --filter @objectstack/spec gen:schema && pnpm --filter @objectstack/spec gen:docs.

Module	Pages	Schemas	Description
AI Protocol	11	66	Agents, tools, skills, RAG and knowledge sources, model registry, conversations.
API Protocol	28	412	REST/GraphQL contracts, endpoints, routing, realtime, batch, discovery.
Automation Protocol	13	68	Flows and their nodes, approvals, ETL pipelines, webhooks, state machines, execution records.
Cloud Protocol	11	94	Environments, packages and versions, marketplace, developer portal, tenancy.
Data Protocol	29	163	Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer.
Identity Protocol	5	28	Users and accounts, organizations, positions, API keys, SCIM provisioning.
Integration Protocol	1	27	The single connector protocol (ADR-0097) — catalog descriptors and provider-bound instances.
Kernel Protocol	31	176	Plugin lifecycle and manifests, capabilities and security, metadata loading, service registry.
QA Protocol	1	8	Declarative test suites — scenarios, steps, actions and assertions.
Security Protocol	5	27	Permission sets, row-level security, sharing rules, tenancy posture.
Shared Protocol	8	31	Primitives used across every protocol — identifiers, HTTP, expressions, error maps, enums.
Studio Protocol	3	35	Studio designer metadata — the authoring surfaces for the protocols above.
System Protocol	36	287	The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance.
UI Protocol	16	148	Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer.
Total	198	1570	14 protocol modules

AI Protocol

Source: packages/spec/src/ai/ · Import: @objectstack/spec/ai · 11 pages, 66 schemas

Agents, tools, skills, RAG and knowledge sources, model registry, conversations.

File	Schemas
`agent.zod.ts`	`AIModelConfig`, `Agent`, `StructuredOutputConfig`, `StructuredOutputFormat`, `TransformPipelineStep`
`conversation.zod.ts`	`CodeContent`, `ConversationAnalytics`, `ConversationContext`, `ConversationMessage`, `ConversationSession`, `ConversationSummary`, `FileContent`, `FunctionCall`, `ImageContent`, `MessageContent`, `MessageContentType`, `MessagePruningEvent`, `MessageRole`, `TextContent`, `TokenBudgetConfig`, `TokenBudgetStrategy`, `TokenUsageStats`, `ToolCall`
`embedding.zod.ts`	`EmbeddingModel`, `VectorStore`, `VectorStoreProvider`
`knowledge-document.zod.ts`	`KnowledgeChunk`, `KnowledgeDocument`, `KnowledgeHit`
`knowledge-source.zod.ts`	`FileKnowledgeSource`, `HttpKnowledgeSource`, `KnowledgeRefreshPolicy`, `KnowledgeSource`, `KnowledgeSourceKind`, `ObjectKnowledgeSource`
`mcp.zod.ts`	`MCPApprovalPolicy`, `MCPServerRef`, `MCPToolBinding`, `MCPTransport`
`model-registry.zod.ts`	`ModelCapability`, `ModelConfig`, `ModelLimits`, `ModelPricing`, `ModelProvider`, `ModelRegistry`, `ModelRegistryEntry`, `ModelSelectionCriteria`, `PromptTemplate`, `PromptVariable`
`skill.zod.ts`	`Skill`, `SkillTriggerCondition`
`solution-blueprint.zod.ts`	`BlueprintApp`, `BlueprintCondition`, `BlueprintDashboard`, `BlueprintField`, `BlueprintNavItem`, `BlueprintObject`, `BlueprintSeed`, `BlueprintSummaryOperations`, `BlueprintView`, `BlueprintWidgetCondition`, `SolutionBlueprint`, `SolutionBlueprintStrict`
`tool.zod.ts`	`Tool`
`usage.zod.ts`	`AIUsageRecord`, `TokenUsage`

API Protocol

Source: packages/spec/src/api/ · Import: @objectstack/spec/api · 28 pages, 412 schemas

REST/GraphQL contracts, endpoints, routing, realtime, batch, discovery.

File	Schemas
`analytics.zod.ts`	`AnalyticsEndpoint`, `AnalyticsMetadataResponse`, `AnalyticsQueryRequest`, `AnalyticsResultResponse`, `AnalyticsSqlResponse`, `GetAnalyticsMetaRequest`
`auth.zod.ts`	`AuthProvider`, `LoginRequest`, `LoginType`, `RefreshTokenRequest`, `RegisterRequest`, `Session`, `SessionResponse`, `SessionUser`, `UserProfileResponse`
`auth-endpoints.zod.ts`	`AuthEndpoint`, `AuthFeaturesConfig`, `AuthProviderInfo`, `DeviceRequestResponse`, `DeviceTokenResponse`, `EmailPasswordConfigPublic`, `GetAuthConfigResponse`
`automation-api.zod.ts`	`AutomationApiErrorCode`, `AutomationFlowPathParams`, `AutomationRunPathParams`, `CreateFlowRequest`, `CreateFlowResponse`, `DeleteFlowRequest`, `DeleteFlowResponse`, `FlowSummary`, `GetFlowRequest`, `GetFlowResponse`, `GetRunRequest`, `GetRunResponse`, `ListFlowsRequest`, `ListFlowsResponse`, `ListRunsRequest`, `ListRunsResponse`, `ToggleFlowRequest`, `ToggleFlowResponse`, `TriggerFlowRequest`, `TriggerFlowResponse`, `UpdateFlowRequest`, `UpdateFlowResponse`
`batch.zod.ts`	`BatchConfig`, `BatchOperationResult`, `BatchOperationType`, `BatchOptions`, `BatchRecord`, `BatchUpdateRequest`, `BatchUpdateResponse`, `CrossObjectBatchDroppedFields`, `CrossObjectBatchOperation`, `CrossObjectBatchRequest`, `CrossObjectBatchResponse`, `DeleteManyRequest`, `UpdateManyRecord`, `UpdateManyRequest`
`contract.zod.ts`	`ApiError`, `BaseResponse`, `BatchLoadingStrategy`, `BulkRequest`, `BulkResponse`, `CreateRequest`, `DataLoaderConfig`, `DeleteResponse`, `ExportRequest`, `IdRequest`, `ListRecordResponse`, `ModificationResult`, `QueryOptimizationConfig`, `RecordData`, `SingleRecordResponse`, `UpdateRequest`
`discovery.zod.ts`	`ApiRoutes`, `CapabilityDescriptor`, `Discovery`, `DiscoveryEnvironment`, `RouteHealthEntry`, `RouteHealthReport`, `ServiceInfo`, `ServiceSelfInfo`, `ServiceStatus`, `WellKnownCapabilities`
`dispatcher.zod.ts`	`DispatcherConfig`, `DispatcherErrorCode`, `DispatcherErrorResponse`, `DispatcherRoute`
`documentation.zod.ts`	`ApiChangelogEntry`, `ApiDocumentationConfig`, `ApiTestCollection`, `ApiTestRequest`, `ApiTestingUiConfig`, `ApiTestingUiType`, `CodeGenerationTemplate`, `GeneratedApiDocumentation`, `OpenApiSecurityScheme`, `OpenApiServer`, `OpenApiSpec`
`endpoint.zod.ts`	`ApiEndpoint`, `ApiMapping`
`error-code-ledger.zod.ts`	`ErrorCode`
`errors.zod.ts`	`EnhancedApiError`, `ErrorCategory`, `ErrorResponse`, `FieldError`, `FieldErrorCode`, `RetryStrategy`, `StandardErrorCode`
`events.zod.ts`	`BulkDataEvent`, `BulkDataEventType`, `DataEvent`, `DataEventType`, `MetadataEvent`, `MetadataEventType`
`export.zod.ts`	`CreateExportJobRequest`, `CreateExportJobResponse`, `CreateImportJobRequest`, `CreateImportJobResponse`, `DeduplicationStrategy`, `ExportFormat`, `ExportImportTemplate`, `ExportJobProgress`, `ExportJobStatus`, `ExportJobSummary`, `FieldMappingEntry`, `GetExportJobDownloadRequest`, `GetExportJobDownloadResponse`, `ImportJobProgress`, `ImportJobResults`, `ImportJobStatus`, `ImportJobSummary`, `ImportMapping`, `ImportRequest`, `ImportResponse`, `ImportRowResult`, `ImportValidationConfig`, `ImportValidationMode`, `ImportValidationResult`, `ImportWriteMode`, `ListExportJobsRequest`, `ListExportJobsResponse`, `ListImportJobsRequest`, `ListImportJobsResponse`, `ScheduleExportRequest`, `ScheduleExportResponse`, `ScheduledExport`, `UndoImportJobResponse`
`http-cache.zod.ts`	`CacheControl`, `CacheDirective`, `CacheInvalidationRequest`, `CacheInvalidationResponse`, `CacheInvalidationTarget`, `ETag`, `MetadataCacheRequest`, `MetadataCacheResponse`
`metadata.zod.ts`	`AppDefinitionResponse`, `ConceptListResponse`, `MetadataBulkRegisterRequest`, `MetadataBulkResponse`, `MetadataBulkUnregisterRequest`, `MetadataDeleteResponse`, `MetadataDependenciesResponse`, `MetadataDependentsResponse`, `MetadataEffectiveResponse`, `MetadataExistsResponse`, `MetadataExportRequest`, `MetadataExportResponse`, `MetadataImportRequest`, `MetadataImportResponse`, `MetadataItemResponse`, `MetadataListResponse`, `MetadataNamesResponse`, `MetadataOverlayResponse`, `MetadataOverlaySaveRequest`, `MetadataQueryRequest`, `MetadataQueryResponse`, `MetadataRegisterRequest`, `MetadataTypeInfoResponse`, `MetadataTypesResponse`, `MetadataValidateRequest`, `MetadataValidateResponse`, `ObjectDefinitionResponse`
`odata.zod.ts`	`ODataConfig`, `ODataError`, `ODataFilterFunction`, `ODataMetadata`, `ODataQuery`, `ODataResponse`
`package-api.zod.ts`	`GetInstalledPackageRequest`, `GetInstalledPackageResponse`, `ListInstalledPackagesRequest`, `ListInstalledPackagesResponse`, `PackageApiErrorCode`, `PackageInstallRequest`, `PackageInstallResponse`, `PackagePathParams`, `PackageRollbackRequest`, `PackageRollbackResponse`, `PackageUpgradeRequest`, `PackageUpgradeResponse`, `ResolveDependenciesRequest`, `ResolveDependenciesResponse`, `UninstallPackageApiRequest`, `UninstallPackageApiResponse`, `UploadArtifactRequest`, `UploadArtifactResponse`
`plugin-rest-api.zod.ts`	`ErrorHandlingConfig`, `HandlerStatus`, `OpenApiGenerationConfig`, `RequestValidationConfig`, `ResponseEnvelopeConfig`, `RestApiEndpoint`, `RestApiPluginConfig`, `RestApiRouteCategory`, `RestApiRouteRegistration`, `RouteCoverageEntry`, `RouteCoverageReport`, `ValidationMode`
`protocol.zod.ts`	`AiAgentCapabilities`, `AiAgentChatRequest`, `AiAgentSummary`, `AiAgentsResponse`, `AiChatRequest`, `AiChatResponse`, `AiCompleteRequest`, `AiConversation`, `AiMessage`, `AiModelsResponse`, `AiPendingAction`, `AiPendingActionStatus`, `AiStreamChunk`, `ApproveAiPendingActionResponse`, `AutomationActionsResponse`, `AutomationTriggerRequest`, `AutomationTriggerResponse`, `BatchDataRequest`, `BatchDataResponse`, `CheckPermissionRequest`, `CheckPermissionResponse`, `CreateAiConversationRequest`, `CreateDataRequest`, `CreateDataResponse`, `CreateManyDataRequest`, `CreateManyDataResponse`, `DeleteDataRequest`, `DeleteDataResponse`, `DeleteManyDataRequest`, `DeleteManyDataResponse`, `DeleteMetaItemRequest`, `DeleteMetaItemResponse`, `DisablePackageRequest`, `DisablePackageResponse`, `EnablePackageRequest`, `EnablePackageResponse`, `FindDataRequest`, `FindDataResponse`, `GetDataRequest`, `GetDataResponse`, `GetDiscoveryRequest`, `GetDiscoveryResponse`, `GetEffectivePermissionsRequest`, `GetEffectivePermissionsResponse`, `GetFieldLabelsRequest`, `GetFieldLabelsResponse`, `GetLocalesRequest`, `GetLocalesResponse`, `GetMetaItemCachedRequest`, `GetMetaItemCachedResponse`, `GetMetaItemLayeredResponse`, `GetMetaItemRequest`, `GetMetaItemResponse`, `GetMetaItemsRequest`, `GetMetaItemsResponse`, `GetMetaTypesRequest`, `GetMetaTypesResponse`, `GetNotificationPreferencesRequest`, `GetNotificationPreferencesResponse`, `GetObjectPermissionsRequest`, `GetObjectPermissionsResponse`, `GetPackageRequest`, `GetPackageResponse`, `GetPresenceRequest`, `GetPresenceResponse`, `GetTranslationsRequest`, `GetTranslationsResponse`, `GetUiViewRequest`, `GetUiViewResponse`, `HttpFindQueryParams`, `InstallPackageRequest`, `InstallPackageResponse`, `ListAiConversationsRequest`, `ListAiConversationsResponse`, `ListAiPendingActionsRequest`, `ListAiPendingActionsResponse`, `ListNotificationsRequest`, `ListNotificationsResponse`, `ListPackagesRequest`, `ListPackagesResponse`, `MarkAllNotificationsReadRequest`, `MarkAllNotificationsReadResponse`, `MarkNotificationsReadRequest`, `MarkNotificationsReadResponse`, `Notification`, `NotificationPreferences`, `PublishMetaItemResponse`, `RealtimeConnectRequest`, `RealtimeConnectResponse`, `RealtimeDisconnectRequest`, `RealtimeDisconnectResponse`, `RealtimeSubscribeRequest`, `RealtimeSubscribeResponse`, `RealtimeUnsubscribeRequest`, `RealtimeUnsubscribeResponse`, `RegisterDeviceRequest`, `RegisterDeviceResponse`, `RejectAiPendingActionResponse`, `RuntimeAuthoringIssue`, `SaveMetaItemRequest`, `SaveMetaItemResponse`, `SetPresenceRequest`, `SetPresenceResponse`, `UninstallPackageRequest`, `UninstallPackageResponse`, `UnregisterDeviceRequest`, `UnregisterDeviceResponse`, `UpdateAiConversationRequest`, `UpdateDataRequest`, `UpdateDataResponse`, `UpdateManyDataRequest`, `UpdateManyDataResponse`, `UpdateNotificationPreferencesRequest`, `UpdateNotificationPreferencesResponse`, `ValidateDataIssue`, `ValidateDataRequest`, `ValidateDataResponse`
`query-adapter.zod.ts`	`ODataQueryAdapter`, `OperatorMapping`, `QueryAdapterConfig`, `QueryAdapterTarget`, `RestQueryAdapter`
`realtime.zod.ts`	`RealtimeConfig`, `RealtimeEvent`, `RealtimeEventType`, `RealtimePresence`, `Subscription`, `SubscriptionEvent`, `TransportProtocol`
`realtime-shared.zod.ts`	`BasePresence`, `PresenceStatus`, `RealtimeRecordAction`
`rest-server.zod.ts`	`BatchEndpointsConfig`, `CrudEndpointPattern`, `CrudEndpointsConfig`, `CrudOperation`, `EndpointRegistry`, `GeneratedEndpoint`, `MetadataEndpointsConfig`, `RestApiConfig`, `RestServerConfig`, `RouteGenerationConfig`
`router.zod.ts`	`ConflictResolutionStrategy`, `HttpMethod`, `RouteCategory`, `RouteDefinition`, `RouterConfig`
`storage.zod.ts`	`CompleteChunkedUploadRequest`, `CompleteChunkedUploadResponse`, `CompleteUploadRequest`, `FileDownloadUrlResponse`, `FileTypeValidation`, `FileUploadResponse`, `GetPresignedUrlRequest`, `InitiateChunkedUploadRequest`, `InitiateChunkedUploadResponse`, `PresignedUrlResponse`, `RawUploadResponse`, `UploadChunkRequest`, `UploadChunkResponse`, `UploadProgress`
`versioning.zod.ts`	`VersionDefinition`, `VersionNegotiationResponse`, `VersionStatus`, `VersioningConfig`, `VersioningStrategy`
`websocket.zod.ts`	`AckMessage`, `CursorMessage`, `CursorPosition`, `DocumentState`, `EditMessage`, `EditOperation`, `EditOperationType`, `ErrorMessage`, `EventMessage`, `EventPattern`, `EventSubscription`, `PingMessage`, `PongMessage`, `PresenceMessage`, `PresenceState`, `PresenceUpdate`, `SimpleCursorPosition`, `SimplePresenceState`, `SubscribeMessage`, `UnsubscribeMessage`, `UnsubscribeRequest`, `WebSocketConfig`, `WebSocketEvent`, `WebSocketMessage`, `WebSocketMessageType`, `WebSocketPresenceStatus`, `WebSocketServerConfig`

Automation Protocol

Source: packages/spec/src/automation/ · Import: @objectstack/spec/automation · 13 pages, 68 schemas

Flows and their nodes, approvals, ETL pipelines, webhooks, state machines, execution records.

File	Schemas
`approval.zod.ts`	`ApprovalDecision`, `ApprovalEscalation`, `ApprovalNodeApprover`, `ApprovalNodeConfig`, `ApproverType`, `DecisionOutputDef`
`bpmn-interop.zod.ts`	`BpmnDiagnostic`, `BpmnElementMapping`, `BpmnExportOptions`, `BpmnImportOptions`, `BpmnInteropResult`, `BpmnUnmappedStrategy`, `BpmnVersion`
`builtin-node-config.zod.ts`	`CreateRecordConfig`, `DeleteRecordConfig`, `GetRecordConfig`, `MapConfig`, `ScreenConfig`, `ScreenFieldConfig`, `UpdateRecordConfig`
`control-flow.zod.ts`	`FlowRegion`, `LoopConfig`, `ParallelBranch`, `ParallelConfig`, `RetryPolicy`, `TryCatchConfig`
`execution.zod.ts`	`Checkpoint`, `ConcurrencyPolicy`, `ExecutionError`, `ExecutionErrorSeverity`, `ExecutionLog`, `ExecutionStatus`, `ExecutionStepLog`, `ExecutionStepMetrics`, `ExecutionStepSkipReason`, `FlowRunGateSummary`, `FlowRunNodeSummary`, `FlowRunSummary`, `ScheduleState`
`flow.zod.ts`	`Flow`, `FlowEdge`, `FlowNode`, `FlowNodeAction`, `FlowVariable`, `FlowVersionHistory`
`flow-function.zod.ts`	`FlowFunctionEffect`
`io-node-config.zod.ts`	`HttpConfig`, `NotifyConfig`
`node-executor.zod.ts`	`ActionCategory`, `ActionDescriptor`, `ActionParadigm`, `NodeExecutorDescriptor`, `WaitEventType`, `WaitExecutorConfig`, `WaitResumePayload`, `WaitTimeoutBehavior`
`schemaless-node-config.zod.ts`	`DecisionCondition`, `DecisionConfig`, `ScriptConfig`, `SubflowConfig`
`state-machine.zod.ts`	`ActionRef`, `GuardRef`, `StateMachine`, `StateNode`, `Transition`
`time-relative-trigger.zod.ts`	`TimeRelativeTrigger`
`webhook.zod.ts`	`Webhook`, `WebhookTriggerType`

Cloud Protocol

Source: packages/spec/src/cloud/ · Import: @objectstack/spec/cloud · 11 pages, 94 schemas

Environments, packages and versions, marketplace, developer portal, tenancy.

File	Schemas
`app-store.zod.ts`	`AppDiscoveryRequest`, `AppDiscoveryResponse`, `AppSubscription`, `InstalledAppSummary`, `ListInstalledAppsRequest`, `ListInstalledAppsResponse`, `ListReviewsRequest`, `ListReviewsResponse`, `RecommendationReason`, `RecommendedApp`, `ReviewModerationStatus`, `SubmitReviewRequest`, `SubscriptionStatus`, `UserReview`
`developer-portal.zod.ts`	`AnalyticsTimeRange`, `CreateListingRequest`, `ListingActionRequest`, `PublisherProfile`, `PublishingAnalyticsRequest`, `PublishingAnalyticsResponse`, `ReleaseChannel`, `TimeSeriesPoint`, `UpdateListingRequest`, `VersionRelease`
`environment.zod.ts`	`Environment`, `EnvironmentCredential`, `EnvironmentCredentialStatus`, `EnvironmentDriver`, `EnvironmentMember`, `EnvironmentRole`, `EnvironmentStatus`, `EnvironmentType`, `EnvironmentVisibility`, `ProvisionEnvironmentRequest`, `ProvisionEnvironmentResponse`, `ProvisionOrganizationRequest`, `ProvisionOrganizationResponse`
`environment-artifact.zod.ts`	`Sha256Digest`
`environment-package.zod.ts`	`EnvironmentPackageInstallation`, `EnvironmentPackageStatus`, `InstallPackageToEnvironmentRequest`, `ListEnvironmentPackagesResponse`, `RollbackEnvironmentPackageRequest`, `UpgradeEnvironmentPackageRequest`
`marketplace.zod.ts`	`ArtifactDownloadResponse`, `ArtifactReference`, `ListingStatus`, `MarketplaceCategory`, `MarketplaceInstallRequest`, `MarketplaceInstallResponse`, `MarketplaceListing`, `MarketplaceSearchRequest`, `MarketplaceSearchResponse`, `PackageSubmission`, `PricingModel`, `Publisher`, `PublisherVerification`
`marketplace-admin.zod.ts`	`CuratedCollection`, `FeaturedListing`, `MarketplaceHealthMetrics`, `PolicyAction`, `PolicyViolationType`, `RejectionReason`, `ReviewCriterion`, `ReviewDecision`, `SubmissionReview`, `TrendingListing`
`package.zod.ts`	`CreatePackageRequest`, `Package`, `PackageCategory`, `PackageLocale`, `PackagePublisher`, `PackageTranslation`, `PackageTranslations`, `PackageVisibility`, `UpdatePackageRequest`
`package-version.zod.ts`	`CreatePackageVersionRequest`, `PackageDependency`, `PackageManifest`, `PackageVersion`, `PackageVersionStatus`, `PublishPackageVersionRequest`, `UpdatePackageVersionRequest`
`template-manifest.zod.ts`	`TemplateManifest`
`tenant.zod.ts`	`PackageInstallation`, `PackageInstallationStatus`, `ProvisionTenantRequest`, `ProvisionTenantResponse`, `TenantContext`, `TenantDatabase`, `TenantDatabaseStatus`, `TenantIdentificationSource`, `TenantPlan`, `TenantRoutingConfig`

Data Protocol

Source: packages/spec/src/data/ · Import: @objectstack/spec/data · 29 pages, 163 schemas

Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer.

File	Schemas
`analytics.zod.ts`	`AggregationMetricType`, `AnalyticsQuery`, `Cube`, `CubeJoin`, `Dimension`, `DimensionType`, `Metric`, `TimeUpdateInterval`
`context-tokens.zod.ts`	`ContextToken`, `ContextTokenPlaceholder`
`data-engine.zod.ts`	`BaseEngineOptions`, `DataEngineAggregateOptions`, `DataEngineAggregateRequest`, `DataEngineCountOptions`, `DataEngineCountRequest`, `DataEngineDeleteOptions`, `DataEngineDeleteRequest`, `DataEngineExecuteRequest`, `DataEngineFilter`, `DataEngineFindOneRequest`, `DataEngineFindRequest`, `DataEngineInsertOptions`, `DataEngineInsertRequest`, `DataEngineQueryOptions`, `DataEngineRequest`, `DataEngineSort`, `DataEngineUpdateOptions`, `DataEngineUpdateRequest`, `DataEngineVectorFindRequest`, `DroppedFieldsEvent`, `EngineAggregateOptions`, `EngineCountOptions`, `EngineDeleteOptions`, `EngineQueryOptions`, `EngineUpdateOptions`
`datasource.zod.ts`	`Datasource`, `DriverDefinition`, `DriverType`, `ExternalDatasourceSettings`, `SchemaMode`
`date-macros.zod.ts`	`DateMacroPlaceholder`, `DateMacroToken`
`document.zod.ts`	`Document`, `DocumentTemplate`, `DocumentVersion`, `ESignatureConfig`
`driver.zod.ts`	`DriverCapabilities`, `DriverConfig`, `DriverOptions`, `PoolConfig`
`driver/common.zod.ts`	`DriverSslToggle`, `SqlAutoMigrate`
`driver/memory.zod.ts`	`AutoPersistenceConfig`, `FilePersistenceConfig`, `LocalStoragePersistenceConfig`, `PersistenceType`
`driver/mongo.zod.ts`	`MongoConfig`
`driver/mysql.zod.ts`	`MysqlConfig`
`driver-nosql.zod.ts`	`AggregationPipeline`, `AggregationStage`, `ConsistencyLevel`, `DocumentSchemaValidation`, `NoSQLDataTypeMapping`, `NoSQLDatabaseType`, `NoSQLDriverConfig`, `NoSQLIndex`, `NoSQLIndexType`, `NoSQLOperationType`, `NoSQLQueryOptions`, `NoSQLTransactionOptions`, `ReplicationConfig`, `ShardingConfig`
`driver/postgres.zod.ts`	`PostgresConfig`
`driver-sql.zod.ts`	`DataTypeMapping`, `SQLDialect`, `SQLDriverConfig`, `SSLConfig`
`driver/sqlite.zod.ts`	`SqliteConfig`, `SqliteWasmConfig`, `SqliteWasmPersistMode`
`driver/turso.zod.ts`	`TursoConfig`, `TursoTransportMode`
`external-catalog.zod.ts`	`ExternalCatalog`, `ExternalColumn`, `ExternalTable`
`feed.zod.ts`	`FeedFilterMode`, `FeedItemType`
`field.zod.ts`	`CurrencyConfig`, `CurrencyValue`, `Field`, `FieldType`, `LocationCoordinates`, `SelectOption`, `UniqueScope`
`field-value.zod.ts`	`Address`, `AddressValue`, `CalendarDateValue`, `ClockTimeValue`, `FileLikeValue`, `FileReferenceIdValue`, `FileValue`, `InstantValue`, `LocationValue`, `ReferenceIdValue`
`filter.zod.ts`	`EqualityOperator`, `FieldReference`, `FilterArray`, `FilterCondition`, `QueryFilter`, `SetOperator`, `SpecialOperator`, `StringOperator`
`hook.zod.ts`	`HookContext`, `HookEvent`
`hook-body.zod.ts`	`ExpressionBody`, `HookBody`, `HookBodyCapability`, `ScriptBody`
`mapping.zod.ts`	`ImportFieldMapping`, `Mapping`, `TransformType`
`object.zod.ts`	`ApiMethod`, `ApiOperation`, `Index`, `Lifecycle`, `LifecycleClass`, `Object`, `ObjectAccessConfig`, `ObjectCapabilities`, `ObjectExtension`, `ObjectExternalBinding`, `ObjectFieldGroup`, `ObjectOwnershipEnum`, `ObjectRequiredPermissions`, `PerOperationRequiredPermissions`, `RowCrudActionOverride`, `TenancyConfig`
`query.zod.ts`	`AggregationFunction`, `AggregationNode`, `DateGranularity`, `FieldNode`, `FullTextSearch`, `GroupByNode`, `Query`, `SortNode`
`seed.zod.ts`	`Seed`, `SeedMode`
`seed-loader.zod.ts`	`ObjectDependencyGraph`, `ObjectDependencyNode`, `ReferenceResolution`, `ReferenceResolutionError`, `SeedIdentity`, `SeedLoadResult`, `SeedLoaderConfig`, `SeedLoaderRequest`, `SeedLoaderResult`
`validation.zod.ts`	`ConditionalValidation`, `CrossFieldValidation`, `FormatValidation`, `JSONValidation`, `ScriptValidation`, `StateMachineValidation`, `ValidationRule`

Identity Protocol

Source: packages/spec/src/identity/ · Import: @objectstack/spec/identity · 5 pages, 28 schemas

Users and accounts, organizations, positions, API keys, SCIM provisioning.

File	Schemas
`eval-user.zod.ts`	`EvalUser`
`identity.zod.ts`	`Account`, `ApiKey`, `User`, `VerificationToken`
`organization.zod.ts`	`Invitation`, `InvitationStatus`, `Member`, `Organization`
`position.zod.ts`	`Position`
`scim.zod.ts`	`SCIMAddress`, `SCIMBulkOperation`, `SCIMBulkRequest`, `SCIMBulkResponse`, `SCIMBulkResponseOperation`, `SCIMEmail`, `SCIMEnterpriseUser`, `SCIMError`, `SCIMGroup`, `SCIMGroupReference`, `SCIMListResponse`, `SCIMMemberReference`, `SCIMMeta`, `SCIMName`, `SCIMPatchOperation`, `SCIMPatchRequest`, `SCIMPhoneNumber`, `SCIMUser`

Integration Protocol

Source: packages/spec/src/integration/ · Import: @objectstack/spec/integration · 1 page, 27 schemas

The single connector protocol (ADR-0097) — catalog descriptors and provider-bound instances.

File Schemas

connector.zod.ts CircuitBreakerConfig, Connector, ConnectorAction, ConnectorActionEffect, ConnectorConflictResolution, ConnectorErrorCategory, ConnectorFieldMapping, ConnectorHealth, ConnectorInstanceAPIKeyAuth, ConnectorInstanceAuth, ConnectorInstanceBasicAuth, ConnectorInstanceBearerAuth, ConnectorInstanceNoAuth, ConnectorRetryStrategy, ConnectorStatus, ConnectorTrigger, ConnectorType, DataSyncConfig, DeclarativeConnectorEntry, ErrorMappingConfig, ErrorMappingRule, HealthCheckConfig, RetryConfig, SyncStrategy, WebhookConfig, WebhookEvent, WebhookSignatureAlgorithm

File	Schemas
`connector.zod.ts`	`CircuitBreakerConfig`, `Connector`, `ConnectorAction`, `ConnectorActionEffect`, `ConnectorConflictResolution`, `ConnectorErrorCategory`, `ConnectorFieldMapping`, `ConnectorHealth`, `ConnectorInstanceAPIKeyAuth`, `ConnectorInstanceAuth`, `ConnectorInstanceBasicAuth`, `ConnectorInstanceBearerAuth`, `ConnectorInstanceNoAuth`, `ConnectorRetryStrategy`, `ConnectorStatus`, `ConnectorTrigger`, `ConnectorType`, `DataSyncConfig`, `DeclarativeConnectorEntry`, `ErrorMappingConfig`, `ErrorMappingRule`, `HealthCheckConfig`, `RetryConfig`, `SyncStrategy`, `WebhookConfig`, `WebhookEvent`, `WebhookSignatureAlgorithm`

Kernel Protocol

Source: packages/spec/src/kernel/ · Import: @objectstack/spec/kernel · 31 pages, 176 schemas

Plugin lifecycle and manifests, capabilities and security, metadata loading, service registry.

File	Schemas
`cli-extension.zod.ts`	`CLICommandContribution`, `OclifPluginConfig`
`cluster.zod.ts`	`ClusterCapabilityConfig`, `ClusterDriver`, `ClusterTenantIsolation`, `EventClusterOptions`, `EventDeliverySemantics`, `EventScope`, `MetadataChangeOperation`, `ServiceClusterAnnotations`, `ServiceClusterScope`, `ServiceLeaderStrategy`
`context.zod.ts`	`KernelContext`, `PreviewModeConfig`, `RuntimeMode`, `TenantRuntimeContext`
`dependency-resolution.zod.ts`	`DependencyResolutionResult`, `DependencyStatusEnum`, `RequiredAction`, `ResolvedDependency`
`events/bus.zod.ts`	`EventBusConfig`
`events/core.zod.ts`	`Event`, `EventMetadata`, `EventPriority`, `EventTypeDefinition`
`events/dlq.zod.ts`	`DeadLetterQueueEntry`, `EventLogEntry`
`events/handlers.zod.ts`	`EventHandler`, `EventPersistence`, `EventRoute`
`events/integrations.zod.ts`	`EventMessageQueueConfig`, `EventWebhookConfig`, `RealTimeNotificationConfig`
`events/queue.zod.ts`	`EventQueueConfig`, `EventReplayConfig`, `EventSourcingConfig`
`execution-context.zod.ts`	`ExecutionContext`
`manifest.zod.ts`	`Manifest`, `ManifestPermissions`, `PluginEngines`, `PluginIntegrity`, `PluginPackaging`, `PluginPermissions`, `PluginRuntime`
`metadata-customization.zod.ts`	`CustomizationOrigin`, `CustomizationPolicy`, `FieldChange`, `MergeConflict`, `MergeResult`, `MergeStrategyConfig`, `MetadataOverlay`
`metadata-loader.zod.ts`	`MetadataFallbackStrategy`, `MetadataManagerConfig`
`metadata-plugin.zod.ts`	`MetadataBulkResult`, `MetadataDependency`, `MetadataPluginConfig`, `MetadataPluginManifest`, `MetadataQuery`, `MetadataQueryResult`, `MetadataType`, `MetadataTypeRegistryEntry`, `MetadataValidationResult`
`metadata-protection.zod.ts`	`MetadataLock`, `MetadataLockSource`, `MetadataProvenance`
`package-artifact.zod.ts`	`ArtifactChecksum`, `ArtifactFileEntry`, `ArtifactSignature`, `MetadataCategoryEnum`, `PackageArtifact`
`package-registry.zod.ts`	`DisablePackageRequest`, `DisablePackageResponse`, `EnablePackageRequest`, `EnablePackageResponse`, `GetPackageRequest`, `GetPackageResponse`, `InstallPackageRequest`, `InstallPackageResponse`, `InstalledPackage`, `ListPackagesRequest`, `ListPackagesResponse`, `NamespaceConflictError`, `NamespaceRegistryEntry`, `PackageStatusEnum`, `UninstallPackageRequest`, `UninstallPackageResponse`
`package-upgrade.zod.ts`	`MetadataChangeType`, `MetadataDiffItem`, `RollbackPackageRequest`, `RollbackPackageResponse`, `UpgradeImpactLevel`, `UpgradePackageRequest`, `UpgradePackageResponse`, `UpgradePhase`, `UpgradePlan`, `UpgradeSnapshot`
`plugin.zod.ts`	`Plugin`
`plugin-capability.zod.ts`	`CapabilityConformanceLevel`, `ExtensionPoint`, `PluginCapability`, `PluginCapabilityManifest`, `PluginDependency`, `PluginInterface`, `ProtocolFeature`, `ProtocolReference`, `ProtocolVersion`
`plugin-lifecycle-advanced.zod.ts`	`AdvancedPluginLifecycleConfig`, `DistributedStateConfig`, `GracefulDegradation`, `HotReloadConfig`, `PluginHealthCheck`, `PluginHealthReport`, `PluginHealthStatus`, `PluginStateSnapshot`, `PluginUpdateStrategy`
`plugin-loading.zod.ts`	`PluginLoadingEvent`, `PluginLoadingState`
`plugin-registry.zod.ts`	`PluginInstallConfig`, `PluginQualityMetrics`, `PluginRegistryEntry`, `PluginSearchFilters`, `PluginStatistics`, `PluginVendor`
`plugin-security.zod.ts`	`DependencyGraph`, `DependencyGraphNode`, `PackageDependencyConflict`, `PackageDependencyResolutionResult`, `PluginProvenance`, `PluginTrustScore`, `ResolvedPackageDependency`, `SBOM`, `SBOMEntry`, `SecurityPolicy`, `SecurityScanResult`, `SecurityVulnerability`, `VulnerabilitySeverity`
`plugin-security-advanced.zod.ts`	`KernelSecurityPolicy`, `KernelSecurityScanResult`, `KernelSecurityVulnerability`, `PermissionAction`, `PermissionScope`, `PluginPermission`, `PluginPermissionSet`, `PluginSecurityManifest`, `PluginTrustLevel`, `ResourceType`, `RuntimeConfig`, `SandboxConfig`
`plugin-structure.zod.ts`	`OpsDomainModule`, `OpsFilePath`, `OpsPluginStructure`
`plugin-validator.zod.ts`	`PluginMetadata`, `ValidationError`, `ValidationResult`, `ValidationWarning`
`plugin-versioning.zod.ts`	`BreakingChange`, `CompatibilityLevel`, `CompatibilityMatrixEntry`, `DependencyConflict`, `DeprecationNotice`, `MultiVersionSupport`, `PluginCompatibilityMatrix`, `PluginDependencyResolutionResult`, `PluginVersionMetadata`, `SemanticVersion`, `VersionConstraint`
`service-registry.zod.ts`	`ScopeConfig`, `ScopeInfo`, `ServiceFactoryRegistration`, `ServiceMetadata`, `ServiceRegistryConfig`, `ServiceScopeType`
`startup-orchestrator.zod.ts`	`HealthStatus`, `PluginStartupResult`, `StartupOptions`, `StartupOrchestrationResult`

QA Protocol

Source: packages/spec/src/qa/ · Import: @objectstack/spec/qa · 1 page, 8 schemas

Declarative test suites — scenarios, steps, actions and assertions.

File	Schemas
`testing.zod.ts`	`TestAction`, `TestActionType`, `TestAssertion`, `TestAssertionType`, `TestContext`, `TestScenario`, `TestStep`, `TestSuite`

Security Protocol

Source: packages/spec/src/security/ · Import: @objectstack/spec/security · 5 pages, 27 schemas

Permission sets, row-level security, sharing rules, tenancy posture.

File	Schemas
`explain.zod.ts`	`AccessMatrix`, `AccessMatrixEntry`, `AuthzPosture`, `ExplainDecision`, `ExplainLayer`, `ExplainMatchedRule`, `ExplainOperation`, `ExplainRecordAttribution`, `ExplainRequest`
`misc` (no single source file)	`CapabilityDeclaration`, `TenancyPosture`
`permission.zod.ts`	`AdminScope`, `EffectiveObjectPermission`, `FieldPermission`, `ObjectAccessScope`, `ObjectPermission`, `PermissionSet`
`rls.zod.ts`	`RLSEvaluationResult`, `RLSOperation`, `RLSUserContext`, `RowLevelSecurityPolicy`
`sharing.zod.ts`	`CriteriaSharingRule`, `OWDModel`, `ShareRecipientType`, `SharingLevel`, `SharingRule`, `SharingRuleType`

Shared Protocol

Source: packages/spec/src/shared/ · Import: @objectstack/spec/shared · 8 pages, 31 schemas

Primitives used across every protocol — identifiers, HTTP, expressions, error maps, enums.

File	Schemas
`branded-types.zod.ts`	`AppName`, `FieldName`, `FlowName`, `ObjectName`, `RoleName`, `ViewName`
`enums.zod.ts`	`IsolationLevelEnum`, `MutationEventEnum`, `SortDirectionEnum`, `SortItem`
`expression.zod.ts`	`CronExpressionInput`, `Expression`, `ExpressionDialect`, `ExpressionInput`, `ExpressionMeta`, `Predicate`, `PredicateInput`, `TemplateExpressionInput`
`http.zod.ts`	`CorsConfig`, `HttpMethod`, `HttpMethodSubset`, `HttpRequest`, `RateLimitConfig`, `StaticMount`
`identifiers.zod.ts`	`EventName`, `SnakeCaseIdentifier`, `SystemIdentifier`
`mapping.zod.ts`	`FieldMapping`
`metadata-types.zod.ts`	`BaseMetadataRecord`, `MetadataFormat`
`protection.zod.ts`	`Protection`

Studio Protocol

Source: packages/spec/src/studio/ · Import: @objectstack/spec/studio · 3 pages, 35 schemas

Studio designer metadata — the authoring surfaces for the protocols above.

File	Schemas
`flow-builder.zod.ts`	`FlowBuilderConfig`, `FlowCanvasEdge`, `FlowCanvasEdgeStyle`, `FlowCanvasNode`, `FlowLayoutAlgorithm`, `FlowLayoutDirection`, `FlowNodeRenderDescriptor`, `FlowNodeShape`
`object-designer.zod.ts`	`ERDiagramConfig`, `ERLayoutAlgorithm`, `ERNodeDisplay`, `FieldEditorConfig`, `FieldGroup`, `FieldPropertySection`, `ObjectDesignerConfig`, `ObjectDesignerDefaultView`, `ObjectFilter`, `ObjectListDisplayMode`, `ObjectManagerConfig`, `ObjectPreviewConfig`, `ObjectPreviewTab`, `ObjectSortField`, `RelationshipDisplay`, `RelationshipMapperConfig`
`plugin.zod.ts`	`ActionContribution`, `ActionContributionLocation`, `CommandContribution`, `MetadataIconContribution`, `MetadataViewerContribution`, `PanelContribution`, `PanelLocation`, `SidebarGroupContribution`, `StudioPluginContributions`, `StudioPluginManifest`, `ViewMode`

System Protocol

Source: packages/spec/src/system/ · Import: @objectstack/spec/system · 36 pages, 287 schemas

The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance.

File	Schemas
`app-install.zod.ts`	`AppCompatibilityCheck`, `AppInstallRequest`, `AppInstallResult`, `AppManifest`
`auth-config.zod.ts`	`AdvancedAuthConfig`, `AuthConfig`, `AuthPluginConfig`, `AuthProviderConfig`, `EmailAndPasswordConfig`, `EmailVerificationConfig`, `MutualTLSConfig`, `OidcProviderConfig`, `OidcProvidersConfig`, `SocialProviderConfig`
`book.zod.ts`	`Book`, `BookAudience`, `BookGroup`, `BookInclude`, `BookNode`
`cache.zod.ts`	`CacheAvalanchePrevention`, `CacheConfig`, `CacheConsistency`, `CacheInvalidation`, `CacheStrategy`, `CacheTier`, `CacheWarmup`, `DistributedCacheConfig`
`change-management.zod.ts`	`ChangeImpact`, `ChangePriority`, `ChangeRequest`, `ChangeStatus`, `ChangeType`, `RollbackPlan`
`collaboration.zod.ts`	`AwarenessEvent`, `AwarenessSession`, `AwarenessUpdate`, `AwarenessUserState`, `CRDTMergeResult`, `CRDTState`, `CRDTType`, `CollaborationMode`, `CollaborationSession`, `CollaborationSessionConfig`, `CollaborativeCursor`, `CounterOperation`, `CursorColorPreset`, `CursorSelection`, `CursorStyle`, `CursorUpdate`, `GCounter`, `LWWRegister`, `ORSet`, `ORSetElement`, `OTComponent`, `OTOperation`, `OTOperationType`, `OTTransformResult`, `PNCounter`, `TextCRDTOperation`, `TextCRDTState`, `UserActivityStatus`, `VectorClock`
`core-services.zod.ts`	`CoreServiceName`, `KernelServiceMap`, `KernelServiceStatus`, `ServiceConfig`, `ServiceCriticality`
`deploy-bundle.zod.ts`	`DeployBundle`, `DeployDiff`, `DeployManifest`, `DeployStatusEnum`, `DeployValidationIssue`, `DeployValidationResult`, `MigrationPlan`, `MigrationStatement`, `SchemaChange`
`disaster-recovery.zod.ts`	`BackupConfig`, `BackupRetention`, `BackupStrategy`, `DisasterRecoveryPlan`, `FailoverConfig`, `FailoverMode`, `RPO`, `RTO`
`doc.zod.ts`	`Doc`
`email-config.zod.ts`	`EmailAddressConfig`, `EmailProvider`, `EmailServiceConfig`
`email-template.zod.ts`	`EmailTemplateDefinition`, `EmailTemplateDefinitionCategory`, `EmailTemplateDefinitionVariable`
`encryption.zod.ts`	`EncryptionAlgorithm`, `EncryptionConfig`, `FieldEncryption`, `KeyManagementProvider`, `KeyRotationPolicy`
`environment-artifact.zod.ts`	`Sha256Digest`
`http-server.zod.ts`	`MiddlewareConfig`, `MiddlewareType`, `RouteHandlerMetadata`
`incident-response.zod.ts`	`Incident`, `IncidentCategory`, `IncidentNotificationMatrix`, `IncidentNotificationRule`, `IncidentResponsePhase`, `IncidentResponsePolicy`, `IncidentSeverity`, `IncidentStatus`
`job.zod.ts`	`CronSchedule`, `IntervalSchedule`, `Job`, `JobExecution`, `JobExecutionStatus`, `OnceSchedule`, `RetryPolicy`, `Schedule`
`license.zod.ts`	`Feature`, `License`, `LicenseMetricType`, `Plan`
`logging.zod.ts`	`ConsoleDestinationConfig`, `ExtendedLogLevel`, `ExternalServiceDestinationConfig`, `FileDestinationConfig`, `HttpDestinationConfig`, `LogDestination`, `LogDestinationType`, `LogEnrichmentConfig`, `LogEntry`, `LogFormat`, `LogLevel`, `LoggerConfig`, `LoggingConfig`, `StructuredLogEntry`
`metadata-persistence.zod.ts`	`MetadataCollectionInfo`, `MetadataDiffResult`, `MetadataFallbackStrategy`, `MetadataFormat`, `MetadataHistoryQueryOptions`, `MetadataHistoryQueryResult`, `MetadataHistoryRecord`, `MetadataHistoryRetentionPolicy`, `MetadataLoadOptions`, `MetadataLoadResult`, `MetadataLoaderContract`, `MetadataManagerConfig`, `MetadataRecord`, `MetadataSaveOptions`, `MetadataSaveResult`, `MetadataScope`, `MetadataSource`, `MetadataState`, `MetadataStats`, `MetadataWatchEvent`, `PackagePublishResult`
`metrics.zod.ts`	`HistogramBucketConfig`, `MetricAggregationConfig`, `MetricAggregationType`, `MetricDataPoint`, `MetricDefinition`, `MetricExportConfig`, `MetricLabels`, `MetricType`, `MetricUnit`, `MetricsConfig`, `ServiceLevelIndicator`, `ServiceLevelObjective`, `TimeSeries`, `TimeSeriesDataPoint`
`migration.zod.ts`	`AddFieldOperation`, `ChangeSet`, `CreateObjectOperation`, `DataMigrationFlag`, `DeleteObjectOperation`, `ExecuteSqlOperation`, `MigrationDependency`, `MigrationJournalEvent`, `MigrationOperation`, `ModifyFieldOperation`, `RemoveFieldOperation`, `RenameObjectOperation`
`notification.zod.ts`	`NotificationChannel`
`object-storage.zod.ts`	`AccessControlConfig`, `BucketConfig`, `FileMetadata`, `LifecycleAction`, `LifecyclePolicyConfig`, `LifecyclePolicyRule`, `MultipartUploadConfig`, `ObjectMetadata`, `ObjectStorageConfig`, `PresignedUrlConfig`, `StorageAcl`, `StorageClass`, `StorageConnection`, `StorageProvider`, `StorageScope`
`registry-config.zod.ts`	`RegistryConfig`, `RegistrySyncPolicy`, `RegistryUpstream`
`search-engine.zod.ts`	`AnalyzerConfig`, `FacetConfig`, `SearchConfig`, `SearchIndexConfig`, `SearchProvider`
`security-context.zod.ts`	`ComplianceAuditRequirement`, `ComplianceEncryptionRequirement`, `ComplianceFramework`, `DataClassification`, `DataClassificationPolicy`, `MaskingVisibilityRule`, `SecurityContextConfig`, `SecurityEventCorrelation`
`settings-client.zod.ts`	`SettingsChangeEvent`
`settings-manifest.zod.ts`	`ResolvedSettingValue`, `SettingsActionResult`, `SettingsManifest`, `SettingsNamespacePayload`, `Specifier`, `SpecifierHandler`, `SpecifierOption`, `SpecifierScope`, `SpecifierType`, `SpecifierValueDomain`
`stack-server.zod.ts`	`ServerRateLimitConfig`, `StackServerConfig`, `StackServerSecurity`
`supplier-security.zod.ts`	`SupplierAssessmentStatus`, `SupplierRiskLevel`, `SupplierSecurityAssessment`, `SupplierSecurityPolicy`, `SupplierSecurityRequirement`
`tenant.zod.ts`	`DatabaseLevelIsolationStrategy`, `DatabaseProvider`, `QuotaEnforcementResult`, `RowLevelIsolationStrategy`, `SchemaLevelIsolationStrategy`, `Tenant`, `TenantConnectionConfig`, `TenantIsolationConfig`, `TenantIsolationLevel`, `TenantQuota`, `TenantSecurityPolicy`, `TenantUsage`
`tracing.zod.ts`	`OpenTelemetryCompatibility`, `OtelExporterType`, `SamplingDecision`, `SamplingStrategyType`, `Span`, `SpanAttributeValue`, `SpanAttributes`, `SpanEvent`, `SpanKind`, `SpanLink`, `SpanStatus`, `TraceContext`, `TraceContextPropagation`, `TraceFlags`, `TracePropagationFormat`, `TraceSamplingConfig`, `TraceState`, `TracingConfig`
`training.zod.ts`	`TrainingCategory`, `TrainingCompletionStatus`, `TrainingCourse`, `TrainingPlan`, `TrainingRecord`
`translation.zod.ts`	`ActionResultDialogTranslation`, `CoverageBreakdownEntry`, `FieldTranslation`, `Locale`, `ObjectTranslationData`, `TranslationBundle`, `TranslationConfig`, `TranslationCoverageResult`, `TranslationData`, `TranslationDiffItem`, `TranslationDiffStatus`, `TranslationItem`
`worker.zod.ts`	`BatchProgress`, `QueueConfig`, `Task`, `TaskExecutionResult`, `TaskPriority`, `TaskRetryPolicy`, `TaskStatus`, `WorkerStats`

UI Protocol

Source: packages/spec/src/ui/ · Import: @objectstack/spec/ui · 16 pages, 148 schemas

Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer.

File	Schemas
`action.zod.ts`	`Action`, `ActionAi`, `ActionLocation`, `ActionParam`, `ActionType`, `InlineAction`
`action-params.zod.ts`	`ActionSession`
`app.zod.ts`	`ActionNavItem`, `App`, `AppBranding`, `AppContextSelector`, `ComponentNavItem`, `DashboardNavItem`, `GroupNavItem`, `NavigationArea`, `NavigationContribution`, `NavigationItem`, `ObjectNavItem`, `PageNavItem`, `ReportNavItem`, `UrlNavItem`
`bulk-action.zod.ts`	`BulkActionDef`, `BulkActionExecution`, `BulkActionOperation`, `BulkActionParam`
`chart.zod.ts`	`ChartAggregate`, `ChartAggregateFunction`, `ChartAnnotation`, `ChartAxis`, `ChartConfig`, `ChartDrillDown`, `ChartGroupBy`, `ChartInteraction`, `ChartSeries`, `ChartType`
`component.zod.ts`	`AIChatWindowProps`, `ElementButtonProps`, `ElementFilterProps`, `ElementFormProps`, `ElementImageProps`, `ElementMetadataViewerProps`, `ElementNumberProps`, `ElementRecordPickerProps`, `ElementTextInputProps`, `ElementTextProps`, `PageAccordionProps`, `PageCardProps`, `PageContainerProps`, `PageHeaderProps`, `PageTabsProps`, `RecordActivityProps`, `RecordChatterProps`, `RecordDetailsProps`, `RecordHighlightsField`, `RecordHighlightsProps`, `RecordPathProps`, `RecordRelatedListProps`
`dashboard.zod.ts`	`Dashboard`, `DashboardHeader`, `DashboardHeaderAction`, `DashboardWidget`, `DashboardWidgetOptions`, `GlobalFilter`, `GlobalFilterOptionsFrom`, `WidgetActionType`, `WidgetColorVariant`
`dataset.zod.ts`	`Dataset`, `DatasetDimension`, `DatasetMeasure`, `DerivedMeasureOp`
`i18n.zod.ts`	`AriaProps`, `I18nLabel`, `InlineLocaleMap`
`notification.zod.ts`	`NotificationPosition`, `NotificationSeverity`, `NotificationType`
`page.zod.ts`	`ElementDataSource`, `InterfacePageConfig`, `Page`, `PageComponent`, `PageComponentType`, `PageRegion`, `PageType`, `PageVariable`
`report.zod.ts`	`JoinedReportBlock`, `Report`, `ReportChart`, `ReportSort`, `ReportType`
`responsive.zod.ts`	`BreakpointColumnMap`, `BreakpointName`, `BreakpointOrderMap`, `ResponsiveConfig`, `ResponsiveStyles`, `StyleMap`
`sharing.zod.ts`	`SharingConfig`
`theme.zod.ts`	`BorderRadius`, `ColorPalette`, `Shadow`, `Theme`, `ThemeMode`, `Typography`
`view.zod.ts`	`AddRecordConfig`, `AppearanceConfig`, `CalendarConfig`, `ColumnPrefix`, `ColumnSummary`, `ColumnSummaryConfig`, `FormButtonConfig`, `FormField`, `FormFieldPublicPicker`, `FormSection`, `FormView`, `GalleryConfig`, `GanttConfig`, `GanttQuickFilter`, `GroupingConfig`, `GroupingField`, `HttpMethodSubset`, `HttpRequest`, `KanbanConfig`, `ListChartConfig`, `ListColumn`, `ListView`, `NavigationConfig`, `NavigationMode`, `ObjectListView`, `ObjectUserFilters`, `PaginationConfig`, `RowColorConfig`, `RowHeight`, `SelectionConfig`, `TimelineConfig`, `TreeConfig`, `UserActionsConfig`, `UserFilterField`, `UserFilters`, `View`, `ViewData`, `ViewFilterRule`, `ViewItem`, `ViewItemName`, `ViewItemWire`, `ViewKind`, `ViewScope`, `ViewSharing`, `ViewTab`, `VisualizationType`

Schema Conventions

Naming

Configuration keys (TypeScript props): camelCase — maxLength, referenceFilters
Machine names (data values): snake_case — name: 'project_task', object: 'account'
Metadata type names: singular — 'view', 'flow', 'agent'

Validation

Every schema is a Zod schema; TypeScript types are inferred with z.infer<typeof Schema>
JSON Schemas are generated from the Zod sources, so IDE completion and the docs cannot drift apart

Usage

import { ObjectSchema } from '@objectstack/spec/data';

// Runtime validation
const result = ObjectSchema.safeParse(objectDefinition);

Each module is importable on its own subpath (@objectstack/spec/<module>); every reference page shows the exact import line for the schemas it documents.

Quick Navigation