Release v0.3.3 - ObjectAI documentation + critical build fixes

CHANGELOG.md

@@ -19,6 +19,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security
 
+## [0.3.3] - 2026-01-24
+
+### Added
+- Comprehensive ObjectAI implementation documentation
+- AI agent and RAG pipeline implementation guides
+- AI protocol specifications and standards
+
+### Changed
+- Enhanced project documentation with AI-related guides and specifications
+
 ## [0.3.2] - 2026-01-24
 
 ### Changed

RELEASE_NOTES.md

@@ -1,5 +1,46 @@
 # Release Notes
 
+## v0.3.3 - ObjectAI Documentation Release (2026-01-24)
+
+### 📦 Released Packages
+
+All packages have been updated to version **0.3.3**:
+
+- **@objectstack/spec@0.3.3** - Core protocol definitions and TypeScript types
+- **@objectstack/types@0.3.3** - Shared TypeScript type definitions
+- **@objectstack/objectql@0.3.3** - ObjectQL query language and runtime
+- **@objectstack/runtime@0.3.3** - Runtime execution environment
+- **@objectstack/client@0.3.3** - Client library for ObjectStack
+- **@objectstack/driver-memory@0.3.3** - In-memory data storage driver
+- **@objectstack/plugin-hono-server@0.3.3** - Hono server plugin for REST API
+- **@objectstack/plugin-msw@0.3.3** - MSW (Mock Service Worker) plugin
+
+### 📝 Changes
+
+This is a patch release focusing on:
+- **New Documentation**: Added comprehensive ObjectAI implementation documentation
+- **AI Protocol Specifications**: Defined standards for AI agents and RAG pipelines
+- **Enhanced Guides**: Added AI-related implementation guides and best practices
+- Improved project documentation structure
+
+### 🤖 ObjectAI Features
+
+This release includes detailed documentation for:
+- AI Agent implementation patterns
+- RAG (Retrieval-Augmented Generation) pipeline architecture
+- AI protocol specifications and standards
+- Integration guides for AI capabilities
+
+### 🚀 Publishing
+
+This release is ready for publishing to npm. When this PR is merged to `main`:
+1. The GitHub Actions release workflow will automatically detect the version bump
+2. Build all packages
+3. Publish to npm registry using NPM_TOKEN secret
+4. Create GitHub release with appropriate tags
+
+---
+
 ## v0.3.2 - Maintenance Release (2026-01-24)
 
 ### 📦 Released Packages

content/docs/references/ai/meta.json

@@ -7,8 +7,8 @@
     "cost",
     "model-registry",
     "nlq",
+    "orchestration",
     "predictive",
-    "rag-pipeline",
-    "workflow-automation"
+    "rag-pipeline"
   ]
 }

content/docs/references/ai/orchestration/AIOrchestration.mdx

@@ -0,0 +1,34 @@
+---
+title: AIOrchestration
+description: AIOrchestration Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **name** | `string` | ✅ | Orchestration unique identifier (snake_case) |
+| **label** | `string` | ✅ | Display name |
+| **description** | `string` | optional |  |
+| **objectName** | `string` | ✅ | Target object for this orchestration |
+| **trigger** | `Enum<'record_created' \| 'record_updated' \| 'field_changed' \| 'scheduled' \| 'manual' \| 'webhook' \| 'batch'>` | ✅ |  |
+| **fieldConditions** | `object[]` | optional | Fields to monitor (for field_changed trigger) |
+| **schedule** | `object` | optional | Schedule configuration (for scheduled trigger) |
+| **webhookConfig** | `object` | optional | Webhook configuration (for webhook trigger) |
+| **entryCriteria** | `string` | optional | Formula condition - workflow only runs if TRUE |
+| **aiTasks** | `object[]` | ✅ | AI tasks to execute in sequence |
+| **postActions** | `object[]` | optional | Actions after AI tasks complete |
+| **executionMode** | `Enum<'sequential' \| 'parallel'>` | optional | How to execute multiple AI tasks |
+| **stopOnError** | `boolean` | optional | Stop workflow if any task fails |
+| **timeout** | `number` | optional | Maximum execution time in seconds |
+| **priority** | `Enum<'low' \| 'normal' \| 'high' \| 'critical'>` | optional |  |
+| **enableLogging** | `boolean` | optional |  |
+| **enableMetrics** | `boolean` | optional |  |
+| **notifyOnFailure** | `string[]` | optional | User IDs to notify on failure |
+| **active** | `boolean` | optional |  |
+| **version** | `string` | optional |  |
+| **tags** | `string[]` | optional |  |
+| **category** | `string` | optional | Workflow category (e.g., "support", "sales", "hr") |
+| **owner** | `string` | optional | User ID of workflow owner |
+| **createdAt** | `string` | optional | ISO timestamp |
+| **updatedAt** | `string` | optional | ISO timestamp |

content/docs/references/ai/orchestration/AIOrchestrationExecutionResult.mdx

@@ -0,0 +1,20 @@
+---
+title: AIOrchestrationExecutionResult
+description: AIOrchestrationExecutionResult Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **workflowName** | `string` | ✅ |  |
+| **recordId** | `string` | ✅ |  |
+| **status** | `Enum<'success' \| 'partial_success' \| 'failed' \| 'skipped'>` | ✅ |  |
+| **executionTime** | `number` | ✅ | Execution time in milliseconds |
+| **tasksExecuted** | `integer` | ✅ | Number of tasks executed |
+| **tasksSucceeded** | `integer` | ✅ | Number of tasks succeeded |
+| **tasksFailed** | `integer` | ✅ | Number of tasks failed |
+| **taskResults** | `object[]` | optional |  |
+| **error** | `string` | optional |  |
+| **startedAt** | `string` | ✅ | ISO timestamp |
+| **completedAt** | `string` | optional | ISO timestamp |

content/docs/references/ai/orchestration/AIOrchestrationTrigger.mdx

@@ -0,0 +1,14 @@
+---
+title: AIOrchestrationTrigger
+description: AIOrchestrationTrigger Schema Reference
+---
+
+## Allowed Values
+
+* `record_created`
+* `record_updated`
+* `field_changed`
+* `scheduled`
+* `manual`
+* `webhook`
+* `batch`

content/docs/references/ai/orchestration/BatchAIOrchestrationExecution.mdx

@@ -0,0 +1,14 @@
+---
+title: BatchAIOrchestrationExecution
+description: BatchAIOrchestrationExecution Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **workflowName** | `string` | ✅ | Orchestration to execute |
+| **recordIds** | `string[]` | ✅ | Records to process |
+| **batchSize** | `integer` | optional |  |
+| **parallelism** | `integer` | optional |  |
+| **priority** | `Enum<'low' \| 'normal' \| 'high'>` | optional |  |

content/docs/references/ai/orchestration/meta.json

@@ -0,0 +1,3 @@
+{
+  "title": "Orchestration"
+}

content/docs/references/api/contract/ExportRequest.mdx

@@ -9,14 +9,15 @@ description: ExportRequest Schema Reference
 | :--- | :--- | :--- | :--- |
 | **object** | `string` | ✅ | Object name (e.g. account) |
 | **fields** | `string \| object[]` | optional | Fields to retrieve |
-| **aggregations** | `object[]` | optional | Aggregation functions (GROUP BY) |
-| **windowFunctions** | `object[]` | optional | Window functions with OVER clause |
-| **filters** | `any[] \| string \| any[]` | optional | Filtering criteria |
-| **joins** | `object[]` | optional | Table joins |
+| **where** | `any` | optional | Filtering criteria (WHERE) |
+| **orderBy** | `object[]` | optional | Sorting instructions (ORDER BY) |
+| **limit** | `number` | optional | Max records to return (LIMIT) |
+| **offset** | `number` | optional | Records to skip (OFFSET) |
+| **cursor** | `Record<string, any>` | optional | Cursor for keyset pagination |
+| **joins** | `object[]` | optional | Explicit Table Joins |
+| **aggregations** | `object[]` | optional | Aggregation functions |
 | **groupBy** | `string[]` | optional | GROUP BY fields |
-| **having** | `any[] \| string \| any[]` | optional | HAVING clause for aggregation filtering |
-| **sort** | `object[]` | optional | Sorting instructions |
-| **top** | `number` | optional | Limit results |
-| **skip** | `number` | optional | Offset results |
+| **having** | `any` | optional | HAVING clause for aggregation filtering |
+| **windowFunctions** | `object[]` | optional | Window functions with OVER clause |
 | **distinct** | `boolean` | optional | SELECT DISTINCT flag |
 | **format** | `Enum<'csv' \| 'json' \| 'xlsx'>` | optional |  |

content/docs/references/api/discovery/ApiCapabilities.mdx

@@ -0,0 +1,13 @@
+---
+title: ApiCapabilities
+description: ApiCapabilities Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **graphql** | `boolean` | optional |  |
+| **search** | `boolean` | optional |  |
+| **websockets** | `boolean` | optional |  |
+| **files** | `boolean` | optional |  |

content/docs/references/api/discovery/ApiRoutes.mdx

@@ -0,0 +1,15 @@
+---
+title: ApiRoutes
+description: ApiRoutes Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **data** | `string` | ✅ | e.g. /api/v1/data |
+| **metadata** | `string` | ✅ | e.g. /api/v1/meta |
+| **auth** | `string` | ✅ | e.g. /api/v1/auth |
+| **actions** | `string` | optional | e.g. /api/v1/p |
+| **storage** | `string` | optional | e.g. /api/v1/storage |
+| **graphql** | `string` | optional | e.g. /api/v1/graphql |

content/docs/references/api/discovery/Discovery.mdx

@@ -0,0 +1,15 @@
+---
+title: Discovery
+description: Discovery Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **name** | `string` | ✅ |  |
+| **version** | `string` | ✅ |  |
+| **environment** | `Enum<'production' \| 'sandbox' \| 'development'>` | ✅ |  |
+| **routes** | `object` | ✅ |  |
+| **features** | `object` | ✅ |  |
+| **locale** | `object` | ✅ |  |

content/docs/references/api/endpoint/meta.json

@@ -0,0 +1,3 @@
+{
+  "title": "Endpoint"
+}

content/docs/references/api/meta.json

@@ -2,6 +2,9 @@
   "title": "API Protocol",
   "root": true,
   "pages": [
-    "contract"
+    "contract",
+    "discovery",
+    "endpoint",
+    "realtime"
   ]
 }

content/docs/references/api/realtime/Presence.mdx

@@ -0,0 +1,13 @@
+---
+title: Presence
+description: Presence Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **userId** | `string` | ✅ | User identifier |
+| **status** | `Enum<'online' \| 'away' \| 'offline'>` | ✅ | Current presence status |
+| **lastSeen** | `string` | ✅ | ISO 8601 datetime of last activity |
+| **metadata** | `Record<string, any>` | optional | Custom presence data (e.g., current page, custom status) |

content/docs/references/api/realtime/PresenceStatus.mdx

@@ -0,0 +1,10 @@
+---
+title: PresenceStatus
+description: PresenceStatus Schema Reference
+---
+
+## Allowed Values
+
+* `online`
+* `away`
+* `offline`

content/docs/references/api/realtime/RealtimeAction.mdx

@@ -0,0 +1,10 @@
+---
+title: RealtimeAction
+description: RealtimeAction Schema Reference
+---
+
+## Allowed Values
+
+* `created`
+* `updated`
+* `deleted`

content/docs/references/api/realtime/RealtimeEvent.mdx

@@ -0,0 +1,16 @@
+---
+title: RealtimeEvent
+description: RealtimeEvent Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **id** | `string` | ✅ | Unique event identifier |
+| **type** | `string` | ✅ | Event type (e.g., record.created, record.updated) |
+| **object** | `string` | optional | Object name the event relates to |
+| **action** | `Enum<'created' \| 'updated' \| 'deleted'>` | optional | Action performed |
+| **payload** | `any` | optional | Event payload data |
+| **timestamp** | `string` | ✅ | ISO 8601 datetime when event occurred |
+| **userId** | `string` | optional | User who triggered the event |

content/docs/references/api/realtime/RealtimeEventType.mdx

@@ -0,0 +1,11 @@
+---
+title: RealtimeEventType
+description: RealtimeEventType Schema Reference
+---
+
+## Allowed Values
+
+* `record.created`
+* `record.updated`
+* `record.deleted`
+* `field.changed`

content/docs/references/api/realtime/Subscription.mdx

@@ -0,0 +1,13 @@
+---
+title: Subscription
+description: Subscription Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **id** | `string` | ✅ | Unique subscription identifier |
+| **events** | `object[]` | ✅ | Array of events to subscribe to |
+| **transport** | `Enum<'websocket' \| 'sse' \| 'polling'>` | ✅ | Transport protocol to use |
+| **channel** | `string` | optional | Optional channel name for grouping subscriptions |

content/docs/references/api/realtime/SubscriptionEvent.mdx

@@ -0,0 +1,12 @@
+---
+title: SubscriptionEvent
+description: SubscriptionEvent Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **type** | `Enum<'record.created' \| 'record.updated' \| 'record.deleted' \| 'field.changed'>` | ✅ | Type of event to subscribe to |
+| **object** | `string` | optional | Object name to subscribe to |
+| **filters** | `any` | optional | Filter conditions |

content/docs/references/api/realtime/TransportProtocol.mdx

@@ -0,0 +1,10 @@
+---
+title: TransportProtocol
+description: TransportProtocol Schema Reference
+---
+
+## Allowed Values
+
+* `websocket`
+* `sse`
+* `polling`

content/docs/references/data/datasource/Datasource.mdx

@@ -0,0 +1,18 @@
+---
+title: Datasource
+description: Datasource Schema Reference
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **name** | `string` | ✅ | Unique datasource identifier |
+| **label** | `string` | optional | Display label |
+| **driver** | `string` | ✅ | Underlying driver type |
+| **config** | `Record<string, any>` | ✅ | Driver specific configuration |
+| **pool** | `object` | optional | Connection pool settings |
+| **readReplicas** | `Record<string, any>[]` | optional | Read-only replica configurations |
+| **capabilities** | `object` | optional | Capability overrides |
+| **description** | `string` | optional | Internal description |
+| **active** | `boolean` | optional | Is datasource enabled |