Skip to content

Commit b98144d

Browse files
Merge pull request #424 from objectstack-ai/copilot/scan-packages-and-protocols
2 parents edc4bd3 + bf93947 commit b98144d

File tree

6 files changed

+546
-36
lines changed

6 files changed

+546
-36
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ ObjectStack is a metadata-driven platform built on three foundational protocols:
3737
- [Quick Start Examples](./examples/) - CRM, Todo, and plugin examples
3838

3939
- **Protocol References:**
40-
- [Protocol Reference](./content/docs/references/) - All 70 protocol specifications
40+
- [Protocol Reference](./content/docs/references/) - All 109 protocol specifications
4141
- [ObjectQL](./content/docs/objectql/) - Data layer documentation
4242
- [ObjectUI](./content/docs/objectui/) - UI layer documentation
4343
- [ObjectOS](./content/docs/objectos/) - System layer documentation

content/docs/references/index.mdx

Lines changed: 110 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Protocol Reference
3-
description: Complete reference of all 70 ObjectStack protocol specifications
3+
description: Complete reference of all 109 ObjectStack protocol specifications
44
---
55

66
# Protocol Reference
@@ -11,26 +11,27 @@ This is the complete reference for all protocol specifications in the ObjectStac
1111

1212
| Module | Protocols | Description |
1313
| :--- | :---: | :--- |
14-
| [Data Protocol](#data-protocol) | 8 | Core business logic and data modeling (ObjectQL) |
14+
| [Data Protocol](#data-protocol) | 16 | Core business logic and data modeling (ObjectQL) |
1515
| [UI Protocol](#ui-protocol) | 10 | User interface definitions and interactions (ObjectUI) |
16-
| [System Protocol](#system-protocol) | 14 | Runtime environment and platform capabilities (ObjectOS) |
17-
| [AI Protocol](#ai-protocol) | 8 | AI/ML integration and agent orchestration |
18-
| [API Protocol](#api-protocol) | 6 | Standardized API contracts and communication |
16+
| [System Protocol](#system-protocol) | 39 | Runtime environment and platform capabilities (ObjectOS) |
17+
| [AI Protocol](#ai-protocol) | 9 | AI/ML integration and agent orchestration |
18+
| [API Protocol](#api-protocol) | 13 | Standardized API contracts and communication |
1919
| [Automation Protocol](#automation-protocol) | 7 | Workflow automation and integration |
2020
| [Auth Protocol](#auth-protocol) | 6 | Identity, authentication, and authorization |
2121
| [Permission Protocol](#permission-protocol) | 4 | Access control and security policies |
22-
| [Hub Protocol](#hub-protocol) | 5 | Marketplace and multi-tenancy |
23-
| [Shared Protocol](#shared-protocol) | 1 | Common utilities and identifiers |
22+
| [Hub Protocol](#hub-protocol) | 6 | Marketplace and multi-tenancy |
23+
| [Integration Protocol](#integration-protocol) | 5 | External system connectors and adapters |
24+
| [Shared Protocol](#shared-protocol) | 3 | Common utilities and identifiers |
2425
| [Stack Protocol](#stack-protocol) | 1 | Root stack definition |
2526

26-
**Total: 70 protocols**
27+
**Total: 109 protocols**
2728

2829
---
2930

3031
## Data Protocol (ObjectQL)
3132

3233
**Location:** `packages/spec/src/data/`
33-
**Count:** 8 protocols
34+
**Count:** 16 protocols
3435

3536
Defines the "Shape of Data" and business logic.
3637

@@ -44,6 +45,14 @@ Defines the "Shape of Data" and business logic.
4445
| `dataset.zod.ts` | `DatasetSchema` | Dataset definitions for reporting and analytics |
4546
| `mapping.zod.ts` | `FieldMappingSchema` | Field mapping configurations for data transformation |
4647
| `hook.zod.ts` | `HookSchema` | Lifecycle hooks (before/after insert, update, delete) |
48+
| `data-engine.zod.ts` | `DataEngineSchema` | Data engine configuration and capabilities |
49+
| `driver.zod.ts` | `DriverSchema` | Generic database driver interface and capabilities |
50+
| `driver-sql.zod.ts` | `SQLDriverSchema` | SQL-specific driver configuration |
51+
| `driver-nosql.zod.ts` | `NoSQLDriverSchema` | NoSQL-specific driver configuration |
52+
| `document.zod.ts` | `DocumentSchema` | Document-oriented data structures |
53+
| `external-lookup.zod.ts` | `ExternalLookupSchema` | External data source lookup configurations |
54+
| `driver/postgres.zod.ts` | `PostgresConfigSchema` | PostgreSQL driver configuration |
55+
| `driver/mongo.zod.ts` | `MongoConfigSchema` | MongoDB driver configuration |
4756

4857
**Key Features:**
4958
- 44 field types including AI/ML vectors and GPS locations
@@ -88,26 +97,40 @@ Defines the "Shape of Interaction" for rendering interfaces.
8897
## System Protocol (ObjectOS)
8998

9099
**Location:** `packages/spec/src/system/`
91-
**Count:** 14 protocols
100+
**Count:** 39 protocols
92101

93102
Defines the "Runtime Environment" and platform capabilities.
94103

95104
| File | Schema | Purpose |
96105
| :--- | :--- | :--- |
97106
| `manifest.zod.ts` | `ManifestSchema` | Application/plugin manifest (`objectstack.config.ts`) with 7 package types |
98107
| `datasource.zod.ts` | `DatasourceSchema` | Data source connection configurations |
99-
| `driver.zod.ts` | `DriverSchema` | Database driver definitions and options |
100-
| `driver/postgres.zod.ts` | `PostgresConfigSchema` | PostgreSQL-specific driver configuration |
101-
| `driver/mongo.zod.ts` | `MongoConfigSchema` | MongoDB-specific driver configuration |
102-
| `plugin.zod.ts` | `PluginSchema` | Plugin lifecycle and interface definitions |
103108
| `context.zod.ts` | `KernelContextSchema` | Kernel execution context with user, org, tenant info |
109+
| `plugin.zod.ts` | `PluginSchema` | Plugin lifecycle and interface definitions |
110+
| `plugin-capability.zod.ts` | `PluginCapabilitySchema` | Plugin capability declarations |
111+
| `plugin-lifecycle-events.zod.ts` | `PluginLifecycleEventsSchema` | Plugin lifecycle event definitions |
112+
| `plugin-validator.zod.ts` | `PluginValidatorSchema` | Plugin validation rules |
113+
| `startup-orchestrator.zod.ts` | `StartupOrchestratorSchema` | System startup orchestration |
114+
| `service-registry.zod.ts` | `ServiceRegistrySchema` | Service discovery and registration |
104115
| `events.zod.ts` | `EventSchema` | Event bus and pub/sub patterns |
105116
| `job.zod.ts` | `JobSchema` | Background job scheduling (cron, interval, delayed) |
106117
| `audit.zod.ts` | `AuditEventSchema` | Audit logging for compliance |
107-
| `logger.zod.ts` | `LoggerConfigSchema` | Structured logging configuration |
118+
| `logging.zod.ts` | `LoggingSchema` | Structured logging configuration |
119+
| `metrics.zod.ts` | `MetricsSchema` | Application metrics and monitoring |
120+
| `tracing.zod.ts` | `TracingSchema` | Distributed tracing configuration |
108121
| `translation.zod.ts` | `TranslationSchema` | i18n/l10n support |
109122
| `feature.zod.ts` | `FeatureFlagSchema` | Feature flag definitions |
110-
| `scoped-storage.zod.ts` | `ScopedStorageSchema` | Scoped key-value storage |
123+
| `cache.zod.ts` | `CacheSchema` | Caching layer configuration |
124+
| `object-storage.zod.ts` | `ObjectStorageSchema` | Object storage configuration |
125+
| `message-queue.zod.ts` | `MessageQueueSchema` | Message queue integration |
126+
| `search-engine.zod.ts` | `SearchEngineSchema` | Full-text search configuration |
127+
| `encryption.zod.ts` | `EncryptionSchema` | Encryption and key management |
128+
| `compliance.zod.ts` | `ComplianceSchema` | Compliance and regulatory controls |
129+
| `masking.zod.ts` | `MaskingSchema` | Data masking rules |
130+
| `notification.zod.ts` | `NotificationSchema` | Notification service configuration |
131+
| `change-management.zod.ts` | `ChangeManagementSchema` | Change tracking and deployment |
132+
| `collaboration.zod.ts` | `CollaborationSchema` | Real-time collaboration features |
133+
| `http-server.zod.ts` | `HTTPServerSchema` | HTTP server configuration |
111134

112135
**Package Types:**
113136
- `app` - Business application package
@@ -125,13 +148,14 @@ Defines the "Runtime Environment" and platform capabilities.
125148
## AI Protocol
126149

127150
**Location:** `packages/spec/src/ai/`
128-
**Count:** 8 protocols
151+
**Count:** 9 protocols
129152

130153
Defines AI agent integration capabilities.
131154

132155
| File | Schema | Purpose |
133156
| :--- | :--- | :--- |
134157
| `agent.zod.ts` | `AgentSchema` | AI agent definitions and configurations |
158+
| `agent-action.zod.ts` | `AgentActionSchema` | Actions that agents can perform |
135159
| `model-registry.zod.ts` | `ModelRegistrySchema` | LLM registry and selection |
136160
| `rag-pipeline.zod.ts` | `RAGPipelineSchema` | Retrieval-augmented generation |
137161
| `nlq.zod.ts` | `NLQSchema` | Natural language query processing (NL to ObjectQL) |
@@ -147,7 +171,7 @@ Defines AI agent integration capabilities.
147171
## API Protocol
148172

149173
**Location:** `packages/spec/src/api/`
150-
**Count:** 6 protocols
174+
**Count:** 13 protocols
151175

152176
Defines standardized API contracts.
153177

@@ -157,13 +181,81 @@ Defines standardized API contracts.
157181
| `endpoint.zod.ts` | `EndpointSchema` | REST endpoint definitions with rate limiting |
158182
| `router.zod.ts` | `RouterSchema` | API routing configuration |
159183
| `odata.zod.ts` | `ODataSchema` | OData query protocol support |
184+
| `graphql.zod.ts` | `GraphQLSchema` | GraphQL API configuration |
160185
| `realtime.zod.ts` | `RealtimeSchema` | WebSocket/SSE real-time subscriptions |
186+
| `websocket.zod.ts` | `WebSocketSchema` | WebSocket protocol configuration |
161187
| `discovery.zod.ts` | `DiscoverySchema` | API discovery and introspection |
188+
| `batch.zod.ts` | `BatchSchema` | Batch API request processing |
189+
| `http-cache.zod.ts` | `HTTPCacheSchema` | HTTP caching strategies |
190+
| `errors.zod.ts` | `ErrorSchema` | Standardized error responses |
191+
| `view-storage.zod.ts` | `ViewStorageSchema` | View state persistence |
192+
| `protocol.zod.ts` | `ProtocolSchema` | API protocol definitions |
193+
| `rest-server.zod.ts` | `RESTServerSchema` | REST server configuration |
162194

163195
**Learn more:** [API Protocol Reference](/docs/references/api)
164196

165197
---
166198

199+
## Automation Protocol
200+
201+
**Location:** `packages/spec/src/automation/`
202+
**Count:** 7 protocols
203+
204+
Defines workflow automation and business process management.
205+
206+
| File | Schema | Purpose |
207+
| :--- | :--- | :--- |
208+
| `workflow.zod.ts` | `WorkflowSchema` | State machine and approval processes |
209+
| `flow.zod.ts` | `FlowSchema` | Visual logic orchestration (autolaunched, screen, schedule) |
210+
| `approval.zod.ts` | `ApprovalSchema` | Approval process configuration |
211+
| `webhook.zod.ts` | `WebhookSchema` | Webhook definitions and handlers |
212+
| `etl.zod.ts` | `ETLSchema` | Extract, transform, load pipelines |
213+
| `trigger-registry.zod.ts` | `TriggerRegistrySchema` | Event-driven automation triggers |
214+
| `sync.zod.ts` | `SyncSchema` | Data synchronization configurations |
215+
216+
**Learn more:** [Automation Protocol Reference](/docs/references/automation)
217+
218+
---
219+
220+
## Hub Protocol
221+
222+
**Location:** `packages/spec/src/hub/`
223+
**Count:** 6 protocols
224+
225+
Defines marketplace and multi-tenancy capabilities.
226+
227+
| File | Schema | Purpose |
228+
| :--- | :--- | :--- |
229+
| `marketplace.zod.ts` | `MarketplaceSchema` | Plugin marketplace configuration |
230+
| `plugin-registry.zod.ts` | `PluginRegistrySchema` | Plugin registry and versioning |
231+
| `composer.zod.ts` | `ComposerSchema` | Application composition tools |
232+
| `space.zod.ts` | `SpaceSchema` | Workspace and environment management |
233+
| `tenant.zod.ts` | `TenantSchema` | Multi-tenancy configuration |
234+
| `license.zod.ts` | `LicenseSchema` | Licensing and entitlement management |
235+
236+
**Learn more:** [Hub Protocol Reference](/docs/references/hub)
237+
238+
---
239+
240+
## Integration Protocol
241+
242+
**Location:** `packages/spec/src/integration/`
243+
**Count:** 5 protocols
244+
245+
Defines external system connectors and adapters.
246+
247+
| File | Schema | Purpose |
248+
| :--- | :--- | :--- |
249+
| `connector.zod.ts` | `ConnectorSchema` | Generic connector interface |
250+
| `connector/saas.zod.ts` | `SaaSConnectorSchema` | SaaS platform connectors (Salesforce, HubSpot, etc.) |
251+
| `connector/database.zod.ts` | `DatabaseConnectorSchema` | Database connection adapters |
252+
| `connector/file-storage.zod.ts` | `FileStorageConnectorSchema` | Cloud storage connectors (S3, Azure Blob, etc.) |
253+
| `connector/message-queue.zod.ts` | `MessageQueueConnectorSchema` | Message queue integrations (RabbitMQ, Kafka, etc.) |
254+
255+
**Learn more:** [Integration Protocol Reference](/docs/references/integration)
256+
257+
---
258+
167259
## Recent Additions (2026-01-27)
168260

169261
**ObjectQL Advanced Features:**

content/docs/references/meta.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
{
22
"title": "Protocol Reference",
33
"pages": [
4+
"packages",
45
"data",
56
"ui",
67
"automation",
78
"system",
89
"permission",
910
"ai",
1011
"api",
11-
"driver"
12+
"driver",
13+
"hub",
14+
"integration",
15+
"auth",
16+
"shared"
1217
]
1318
}

0 commit comments

Comments
 (0)