quick-reference.mdx

title	Quick Reference Guide
description	Fast lookup table for all ObjectStack protocols

Quick Reference Guide

Fast lookup for the ObjectStack protocols organized by category.

Click on any protocol name to view its complete API reference.

Data Protocol (17 schemas)

Core business logic and data modeling schemas.

Protocol	Source File	Key Schemas	Purpose
Field	field.zod.ts	Field, FieldType, SelectOption	Field types for data modeling
Object	object.zod.ts	Object, ObjectCapabilities	Object/table definitions
Query	query.zod.ts	Query, QueryAST	Query AST with joins, aggregations
Filter	filter.zod.ts	QueryFilter, FilterCondition	Advanced filtering operators
Validation	validation.zod.ts	ValidationRule	Business validation rules
Datasource	datasource.zod.ts	Datasource, DatasourceCapabilities	Database connection configs
Analytics	analytics.zod.ts	Analytics	Data analytics and aggregation
Mapping	mapping.zod.ts	FieldMapping	Field transformation mappings
Hook	hook.zod.ts	Hook, HookEvent	Lifecycle event hooks
Data Engine	data-engine.zod.ts	DataEngine	Data engine configuration
Driver	driver.zod.ts	Driver, DriverCapabilities	Database driver interface
SQL Driver	driver-sql.zod.ts	SQLDriverConfig, SQLDialect	SQL-specific driver
NoSQL Driver	driver-nosql.zod.ts	NoSQLDriverConfig	NoSQL-specific driver
Document	document.zod.ts	Document	Document-oriented data
External Lookup	external-lookup.zod.ts	ExternalLookup	External data lookups
Postgres Driver	driver/postgres.zod.ts	PostgresConfig	PostgreSQL configuration
Mongo Driver	driver/mongo.zod.ts	MongoConfig	MongoDB configuration

UI Protocol (11 schemas)

Presentation layer - views, forms, dashboards, and themes.

Protocol	Source File	Key Schemas	Purpose
View	view.zod.ts	View, ListView, FormView	List and form view configurations
Page	page.zod.ts	Page, PageComponent	FlexiPage layouts
App	app.zod.ts	App, NavigationItem	Application navigation structure
Dashboard	dashboard.zod.ts	Dashboard, DashboardWidget	Dashboard layouts and widgets
Dataset	dataset.zod.ts	Dataset, DatasetDimension, DatasetMeasure	Semantic-layer datasets for dashboards (ADR-0021)
Report	report.zod.ts	Report, ReportType	Report definitions
Action	action.zod.ts	Action, ActionType	UI button actions
Component	component.zod.ts	PageComponent variants	Reusable UI components
Chart	chart.zod.ts	Chart, ChartType	Chart definitions
Theme	theme.zod.ts	Theme, ColorPalette	Theming and branding
Widget	widget.zod.ts	WidgetManifest	Custom widget definitions

Kernel Protocol (17 schemas)

Plugin architecture, manifests, and kernel runtime.

Protocol	Source File	Key Schemas	Purpose
Manifest	manifest.zod.ts	Manifest	Package manifest (objectstack.config.ts)
Context	context.zod.ts	KernelContext	Runtime execution context
Plugin	plugin.zod.ts	Plugin, PluginLifecycle	Plugin system interface
Plugin Capability	plugin-capability.zod.ts	PluginCapability	Plugin capability declarations
Plugin Lifecycle	plugin-lifecycle-events.zod.ts	PluginEventBase, EventPhase	Plugin lifecycle events
Plugin Lifecycle Advanced	plugin-lifecycle-advanced.zod.ts	AdvancedPluginLifecycleConfig, PluginHealthCheck	Advanced lifecycle hooks
Plugin Loading	plugin-loading.zod.ts	PluginLoadingConfig	Plugin loading and init
Plugin Security	plugin-security-advanced.zod.ts	KernelSecurityPolicy, PluginPermission	Plugin sandboxing
Plugin Structure	plugin-structure.zod.ts	OpsPluginStructure	Plugin file conventions
Plugin Validator	plugin-validator.zod.ts	ValidationResult, PluginMetadata	Plugin validation
Plugin Versioning	plugin-versioning.zod.ts	PluginCompatibilityMatrix, DeprecationNotice	Version compatibility
Service Registry	service-registry.zod.ts	ServiceRegistryConfig, ServiceMetadata	Service discovery
Startup Orchestrator	startup-orchestrator.zod.ts	StartupOptions, StartupOrchestrationResult	System startup
Events	events.zod.ts	Event, EventBusConfig	System event bus
Feature	feature.zod.ts	FeatureFlag	Feature flags
Metadata Loader	metadata-loader.zod.ts	MetadataLoaderContract	Metadata loading
Package Registry	package-registry.zod.ts	InstalledPackage, InstallPackageRequest	Package resolution

System Protocol (19 schemas)

Runtime environment, logging, jobs, caching, and observability.

Protocol	Source File	Key Schemas	Purpose
Audit	audit.zod.ts	AuditEvent, AuditConfig	Audit trail logging
Auth Config	auth-config.zod.ts	AuthConfig	Authentication configuration
Cache	cache.zod.ts	CacheConfig	Caching layer
Change Management	change-management.zod.ts	ChangeRequest, RollbackPlan	Change tracking
Collaboration	collaboration.zod.ts	Collaboration	Real-time collab
Encryption	encryption.zod.ts	Encryption	Encryption & keys
HTTP Server	http-server.zod.ts	HttpServerConfig, MiddlewareConfig	HTTP server config
Job	job.zod.ts	Job, JobSchedule	Background job queue
Logging	logging.zod.ts	LoggingConfig	Structured logging
Message Queue	message-queue.zod.ts	MessageQueueConfig, TopicConfig	Message queuing
Metadata Persistence	metadata-persistence.zod.ts	MetadataHistoryRecord, MetadataDiffResult	Metadata storage
Metrics	metrics.zod.ts	Metrics	Application metrics
Migration	migration.zod.ts	Migration	Schema migration
Notification	notification.zod.ts	Notification	Notifications
Object Storage	object-storage.zod.ts	BucketConfig, ObjectMetadata	Object storage
Search Engine	search-engine.zod.ts	SearchConfig, SearchIndexConfig	Full-text search
Tracing	tracing.zod.ts	Tracing	Distributed tracing
Translation	translation.zod.ts	Translation	i18n support
Worker	worker.zod.ts	Worker	Background workers

AI Protocol (11 schemas)

AI/ML capabilities - agents, skills, tools, MCP exposure, RAG, and cost tracking.

Protocol	Source File	Key Schemas	Purpose
Agent	agent.zod.ts	Agent, AITool	AI agent definitions
Skill	skill.zod.ts	Skill, SkillTriggerCondition	Reusable agent skills
Tool	tool.zod.ts	Tool, ToolCategory	Agent tool definitions
MCP	mcp.zod.ts	MCPServerRef, MCPToolBinding	MCP server exposure and tool bindings
Model Registry	model-registry.zod.ts	ModelRegistry, ModelProvider	LLM model management
Conversation	conversation.zod.ts	ConversationSession	Conversation management
Embedding	embedding.zod.ts	EmbeddingModel, VectorStore	Embedding models and vector stores
Knowledge Source	knowledge-source.zod.ts	KnowledgeSource, KnowledgeRefreshPolicy	RAG ingestion sources
Knowledge Document	knowledge-document.zod.ts	KnowledgeDocument, KnowledgeChunk	RAG documents and chunks
Usage	usage.zod.ts	AIUsageRecord, TokenUsage	AI usage and cost tracking
Solution Blueprint	solution-blueprint.zod.ts	BlueprintObject, BlueprintApp	Blueprint format for AI app generation

API Protocol (19 schemas)

REST/GraphQL endpoints, real-time subscriptions, and discovery.

Protocol	Source File	Key Schemas	Purpose
Contract	contract.zod.ts	BaseResponse, BulkRequest	API contract definitions
Endpoint	endpoint.zod.ts	ApiEndpoint, ApiMapping	REST endpoint configuration
Router	router.zod.ts	Router, Route	API routing rules
OData	odata.zod.ts	ODataQuery	OData protocol support
GraphQL	graphql.zod.ts	GraphQLConfig, FederationEntity	GraphQL API config
Realtime	realtime.zod.ts	Subscription, RealtimeEvent	WebSocket subscriptions
WebSocket	websocket.zod.ts	WebSocketConfig	WebSocket protocol
Discovery	discovery.zod.ts	Discovery, ServiceInfo	API discovery and metadata
Batch	batch.zod.ts	BatchConfig, CrossObjectBatchRequest	Batch API processing
HTTP Cache	http-cache.zod.ts	CacheControl, ETag	HTTP caching
Errors	errors.zod.ts	ErrorResponse	Error responses
Protocol	protocol.zod.ts	BatchDataRequest, CheckPermissionRequest	Console/client request-response contracts
REST Server	rest-server.zod.ts	RestApiConfig, CrudEndpointsConfig	REST server config
Auth	auth.zod.ts	LoginRequest, Session	API authentication
Analytics	analytics.zod.ts	Analytics	API usage analytics
Documentation	documentation.zod.ts	Documentation	API docs generation
Metadata	metadata.zod.ts	Metadata	API metadata endpoints
Registry	registry.zod.ts	Registry	API registry
Storage	storage.zod.ts	Storage	API storage operations

Automation Protocol (7 schemas)

Flows, state machines, approvals, and integrations.

Protocol	Source File	Key Schemas	Purpose
Flow	flow.zod.ts	Flow, FlowNode	Visual workflow builder
Approval	approval.zod.ts	ApprovalNodeConfig	Flow approval-node config
State Machine	state-machine.zod.ts	StateMachine	State machine definitions
Webhook	webhook.zod.ts	Webhook	Outbound webhooks
ETL	etl.zod.ts	ETLPipeline	Data transformation pipelines
Trigger Registry	trigger-registry.zod.ts	TriggerRegistry	Event-driven triggers
Sync	sync.zod.ts	DataSyncConfig, SyncMode	Bi-directional data sync

Security Protocol (4 schemas)

Access control, permissions, and row-level security.

Protocol	Source File	Key Schemas	Purpose
Permission	permission.zod.ts	ObjectPermission	Object-level permissions
RLS	rls.zod.ts	RowLevelSecurityPolicy	Row-level security filters
Sharing	sharing.zod.ts	SharingRule	Record sharing rules
Territory	territory.zod.ts	Territory	Territory-based access

Identity Protocol (4 schemas)

User identity, organizations, and position management.

Protocol	Source File	Key Schemas	Purpose
Identity	identity.zod.ts	Identity, User	User identity management
Organization	organization.zod.ts	Organization	Multi-organization support
Position	position.zod.ts	Position	Permission-set distribution (岗位, ADR-0090)
SCIM	scim.zod.ts	SCIMUser, SCIMGroup	SCIM 2.0 provisioning

Cloud Protocol (5 schemas)

Environments, marketplace, licensing, and multi-tenancy.

Protocol	Source File	Key Schemas	Purpose
Environment	environment.zod.ts	Environment, EnvironmentType	Deployment environments
Marketplace	marketplace.zod.ts	MarketplaceListing, PackageSubmission	Plugin marketplace
Plugin Registry	plugin-registry.zod.ts	PluginRegistryEntry, PluginVendor	Plugin registry entries and quality metrics
Plugin Security	plugin-security.zod.ts	PluginSecurityProtocol, SBOM	Plugin security policies
Tenant	tenant.zod.ts	Tenant	Multi-tenancy isolation

Integration Protocol (7 schemas)

External system connectors and adapters.

Protocol	Source File	Key Schemas	Purpose
Connector	connector.zod.ts	Connector	Generic connector interface
SaaS Connector	connector/saas.zod.ts	SaaSConnector	SaaS integrations
Database Connector	connector/database.zod.ts	DatabaseConnector	Database adapters
File Storage	connector/file-storage.zod.ts	FileStorageConnector	Cloud storage
Message Queue	connector/message-queue.zod.ts	MessageQueueConnector	Queue integrations
GitHub	connector/github.zod.ts	GitHubConnector	GitHub API integration
Vercel	connector/vercel.zod.ts	VercelConnector	Vercel deployment

Shared Protocol (5 schemas)

Common utilities used across all protocols.

Protocol	Source File	Key Schemas	Purpose
Expression	expression.zod.ts	Expression, ExpressionInput	CEL expression values and inputs
HTTP	http.zod.ts	HttpRequest, HttpMethod, CorsConfig	HTTP utilities
Identifiers	identifiers.zod.ts	SystemIdentifier, SnakeCaseIdentifier	Standard ID patterns
Mapping	mapping.zod.ts	FieldMapping, TransformType	Field mapping utilities
Connector Auth	connector-auth.zod.ts	ConnectorAuthConfig	Connector auth patterns

QA Protocol (1 schema)

Testing and quality assurance.

Protocol	Source File	Key Schemas	Purpose
Testing	testing.zod.ts	TestSuite	Declarative test definitions

---

Common Patterns

Naming Conventions

<Tabs items={['Configuration Keys', 'Data Values', 'Schema Names']}> typescript // Property names in schemas: camelCase { maxLength: 100, defaultValue: 'example', inlineHelpText: 'Enter a value' } typescript // Machine identifiers in data: snake_case { name: 'project_task', object: 'customer', field: 'first_name' } typescript // Export names: PascalCase + Schema suffix export const FieldSchema = z.object({...}); export type Field = z.infer<typeof FieldSchema>;

Common Imports

// Data protocols
import { FieldSchema, ObjectSchema, QuerySchema } from '@objectstack/spec/data';

// UI protocols
import { ViewSchema, AppSchema, DashboardSchema } from '@objectstack/spec/ui';

// Kernel protocols
import { ManifestSchema, PluginSchema } from '@objectstack/spec/kernel';

// System protocols
import { LoggerConfigSchema, JobSchema } from '@objectstack/spec/system';

// AI protocols
import { AgentSchema, ModelRegistrySchema } from '@objectstack/spec/ai';

// Types (subpath imports — the root package does not export types)
import type { Field, ServiceObject, QueryAST } from '@objectstack/spec/data';
import type { View } from '@objectstack/spec/ui';

Search Tips

• By Feature: "How do I model relationships?" → Field Protocol → lookup or master_detail types
• By Use Case: "Build a dashboard" → Dashboard Protocol
• By Layer: Data → Data Protocol, UI → UI Protocol, Runtime → System Protocol

Next Steps

**New to ObjectStack?** Start with the [Introduction](/docs/getting-started) to learn core concepts before diving into specific protocols.

• Protocol Reference Index - Full protocol documentation
• Data Modeling - Deep dive into data modeling
• UI Engine - UI development guide
• Contributing Guide - How to contribute to protocols