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 (18 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, QueryOptions	Query AST with joins, aggregations
Filter	`filter.zod.ts`	QueryFilter, FilterCondition	Advanced filtering operators
Validation	`validation.zod.ts`	ValidationRule	Business validation rules
Dataset	`dataset.zod.ts`	Dataset, DatasetMode	Reusable dataset definitions
Datasource	`datasource.zod.ts`	Datasource, DatasourceType	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`	SQLDriver	SQL-specific driver
NoSQL Driver	`driver-nosql.zod.ts`	NoSQLDriver	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 (10 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
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, PluginHook	Plugin system interface
Plugin Capability	`plugin-capability.zod.ts`	PluginCapability	Plugin capability declarations
Plugin Lifecycle	`plugin-lifecycle-events.zod.ts`	PluginLifecycleEvents	Plugin lifecycle events
Plugin Lifecycle Advanced	`plugin-lifecycle-advanced.zod.ts`	PluginLifecycleAdvanced	Advanced lifecycle hooks
Plugin Loading	`plugin-loading.zod.ts`	PluginLoading	Plugin loading and init
Plugin Security	`plugin-security-advanced.zod.ts`	PluginSecurityAdvanced	Plugin sandboxing
Plugin Structure	`plugin-structure.zod.ts`	PluginStructure	Plugin file conventions
Plugin Validator	`plugin-validator.zod.ts`	PluginValidator	Plugin validation
Plugin Versioning	`plugin-versioning.zod.ts`	PluginVersioning	Version compatibility
Service Registry	`service-registry.zod.ts`	ServiceRegistry	Service discovery
Startup Orchestrator	`startup-orchestrator.zod.ts`	StartupOrchestrator	System startup
Events	`events.zod.ts`	Event, EventBus	System event bus
Feature	`feature.zod.ts`	FeatureFlag	Feature flags
Metadata Loader	`metadata-loader.zod.ts`	MetadataLoader	Metadata loading
Package Registry	`package-registry.zod.ts`	PackageRegistry	Package resolution

System Protocol (22 schemas)

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

Protocol	Source File	Key Schemas	Purpose
Audit	`audit.zod.ts`	AuditLog, AuditEvent	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`	ChangeManagement	Change tracking
Collaboration	`collaboration.zod.ts`	Collaboration	Real-time collab
Compliance	`compliance.zod.ts`	Compliance	Regulatory controls
Encryption	`encryption.zod.ts`	Encryption	Encryption & keys
HTTP Server	`http-server.zod.ts`	HTTPServer	HTTP server config
Job	`job.zod.ts`	Job, JobSchedule	Background job queue
Logging	`logging.zod.ts`	LoggingConfig	Structured logging
Masking	`masking.zod.ts`	Masking	Data masking
Message Queue	`message-queue.zod.ts`	MessageQueue	Message queuing
Metadata Persistence	`metadata-persistence.zod.ts`	MetadataPersistence	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`	ObjectStorage	Object storage
Search Engine	`search-engine.zod.ts`	SearchEngine	Full-text search
Service Registry	`service-registry.zod.ts`	ServiceRegistry	System services
Tracing	`tracing.zod.ts`	Tracing	Distributed tracing
Translation	`translation.zod.ts`	Translation	i18n support
Worker	`worker.zod.ts`	Worker	Background workers

AI Protocol (3 schemas)

AI/ML capabilities - agents, models, RAG, and cost tracking.

Protocol	Source File	Key Schemas	Purpose
Agent	`agent.zod.ts`	Agent, AITool	AI agent definitions
Model Registry	`model-registry.zod.ts`	ModelRegistry, ModelProvider	LLM model management
Conversation	`conversation.zod.ts`	ConversationSession	Conversation management

API Protocol (19 schemas)

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

Protocol	Source File	Key Schemas	Purpose
Contract	`contract.zod.ts`	APIContract	API contract definitions
Endpoint	`endpoint.zod.ts`	Endpoint, EndpointMethod	REST endpoint configuration
Router	`router.zod.ts`	Router, Route	API routing rules
OData	`odata.zod.ts`	ODataQuery	OData protocol support
GraphQL	`graphql.zod.ts`	GraphQLSchema	GraphQL API config
Realtime	`realtime.zod.ts`	Subscription, Channel	WebSocket subscriptions
WebSocket	`websocket.zod.ts`	WebSocketConfig	WebSocket protocol
Discovery	`discovery.zod.ts`	ServiceDiscovery	API discovery and metadata
Batch	`batch.zod.ts`	BatchRequest	Batch API processing
HTTP Cache	`http-cache.zod.ts`	CacheStrategy	HTTP caching
Errors	`errors.zod.ts`	ErrorResponse	Error responses
Protocol	`protocol.zod.ts`	ProtocolDefinition	Protocol definitions
REST Server	`rest-server.zod.ts`	RESTServer	REST server config
Auth	`auth.zod.ts`	Auth	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, WebhookEvent	Outbound webhooks
ETL	`etl.zod.ts`	ETLPipeline	Data transformation pipelines
Trigger Registry	`trigger-registry.zod.ts`	TriggerRegistry	Event-driven triggers
Sync	`sync.zod.ts`	SyncConfig	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`	RowLevelSecurity	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 (4 schemas)

Marketplace, licensing, and multi-tenancy.

Protocol	Source File	Key Schemas	Purpose
Marketplace	`marketplace.zod.ts`	Package, PackageVersion	Plugin marketplace
Plugin Registry	`plugin-registry.zod.ts`	PluginRegistry	Plugin versioning
Plugin Security	`plugin-security.zod.ts`	PluginSecurity	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 (4 schemas)

Common utilities used across all protocols.

Protocol	Source File	Key Schemas	Purpose
HTTP	`http.zod.ts`	HTTPRequest, HTTPResponse	HTTP utilities
Identifiers	`identifiers.zod.ts`	ID formats	Standard ID patterns
Mapping	`mapping.zod.ts`	MappingRule	Field mapping utilities
Connector Auth	`connector-auth.zod.ts`	ConnectorAuth	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

// Property names in schemas: camelCase
{
  maxLength: 100,
  defaultValue: 'example',
  referenceFilters: ['active = true']
}

// Machine identifiers in data: snake_case
{
  name: 'project_task',
  object: 'customer',
  field: 'first_name'
}

// 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, RAGPipelineConfigSchema } from '@objectstack/spec/ai';

// Types
import type { Field, Object, Query, View } from '@objectstack/spec';

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 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

Quick Reference Guide

On this page