ObjectStackDeploy Bundle
Deploy Bundle protocol schemas
Deploy Bundle Protocol
Defines the schemas for metadata-driven deployment: Schema Push → Zod Validate → Diff → DDL Sync → Register
This eliminates traditional CI/CD pipelines for schema changes. A "deploy" is a bundle of metadata (objects, views, flows, permissions) that is validated, diffed against the current state, and applied as DDL migrations directly to the tenant database.
Target: 2-5 second deploys vs. 2-15 minute traditional Docker/CI/CD.
Source: packages/spec/src/system/deploy-bundle.zod.ts
TypeScript Usage
import { DeployBundleSchema, DeployDiffSchema, DeployManifestSchema, DeployStatusEnum, DeployValidationIssueSchema, DeployValidationResultSchema, MigrationPlanSchema, MigrationStatementSchema, SchemaChangeSchema } from '@objectstack/spec/system';
import type { DeployBundle, DeployDiff, DeployManifest, DeployValidationIssue, DeployValidationResult, MigrationPlan, MigrationStatement, SchemaChange } from '@objectstack/spec/system';
// Validate data
const result = DeployBundleSchema.parse(data);DeployBundle
Deploy bundle containing all metadata for deployment
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| manifest | { version: string; checksum?: string; objects: string[]; views: string[]; … } | ✅ | Deployment manifest |
| objects | Record<string, any>[] | optional (default: []) | Object definitions |
| views | Record<string, any>[] | optional (default: []) | View definitions |
| flows | Record<string, any>[] | optional (default: []) | Flow definitions |
| permissions | Record<string, any>[] | optional (default: []) | Permission definitions |
| seedData | Record<string, any>[] | optional (default: []) | Seed data records |
Nested Shape: DeployBundle.manifest
| Property | Type | Required | Description |
|---|---|---|---|
| version | string | ✅ | Deployment version |
| checksum | string | optional | SHA256 checksum |
| objects | string[] | optional (default: []) | Object names included |
| views | string[] | optional (default: []) | View names included |
| flows | string[] | optional (default: []) | Flow names included |
| permissions | string[] | optional (default: []) | Permission names included |
| createdAt | string | optional | Bundle creation time |
DeployDiff
Schema diff between current and desired state
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| changes | { entityType: Enum<'object' | 'field' | 'index' | 'view' | 'flow' | 'permission'>; entityName: string; parentEntity?: string; changeType: Enum<'added' | 'modified' | 'removed'>; … }[] | optional (default: []) | List of schema changes |
| summary | { added: integer; modified: integer; removed: integer } | ✅ | Change summary counts |
| hasBreakingChanges | boolean | optional (default: false) | Whether diff contains breaking changes |
Nested Shape: DeployDiff.changes[number]
Individual schema change
| Property | Type | Required | Description |
|---|---|---|---|
| entityType | Enum<'object' | 'field' | 'index' | 'view' | 'flow' | 'permission'> | ✅ | Entity type |
| entityName | string | ✅ | Entity name |
| parentEntity | string | optional | Parent entity name |
| changeType | Enum<'added' | 'modified' | 'removed'> | ✅ | Change type |
| oldValue | any | optional | Previous value |
| newValue | any | optional | New value |
Nested Shape: DeployDiff.summary
| Property | Type | Required | Description |
|---|---|---|---|
| added | integer | optional (default: 0) | Number of added entities |
| modified | integer | optional (default: 0) | Number of modified entities |
| removed | integer | optional (default: 0) | Number of removed entities |
DeployManifest
Deployment manifest
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| version | string | ✅ | Deployment version |
| checksum | string | optional | SHA256 checksum |
| objects | string[] | optional (default: []) | Object names included |
| views | string[] | optional (default: []) | View names included |
| flows | string[] | optional (default: []) | Flow names included |
| permissions | string[] | optional (default: []) | Permission names included |
| createdAt | string | optional | Bundle creation time |
DeployStatusEnum
Deployment lifecycle status
Allowed Values
validatingdiffingmigratingregisteringreadyfailedrolling_back
DeployValidationIssue
Validation issue
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| severity | Enum<'error' | 'warning' | 'info'> | ✅ | Issue severity |
| path | string | ✅ | Entity path (e.g., objects.project_task.fields.name) |
| message | string | ✅ | Issue description |
| code | string | optional | Validation error code |
DeployValidationResult
Bundle validation result
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| valid | boolean | ✅ | Whether the bundle is valid |
| issues | { severity: Enum<'error' | 'warning' | 'info'>; path: string; message: string; code?: string }[] | optional (default: []) | Validation issues |
| errorCount | integer | optional (default: 0) | Number of errors |
| warningCount | integer | optional (default: 0) | Number of warnings |
Nested Shape: DeployValidationResult.issues[number]
Validation issue
| Property | Type | Required | Description |
|---|---|---|---|
| severity | Enum<'error' | 'warning' | 'info'> | ✅ | Issue severity |
| path | string | ✅ | Entity path (e.g., objects.project_task.fields.name) |
| message | string | ✅ | Issue description |
| code | string | optional | Validation error code |
MigrationPlan
Ordered migration plan
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| statements | { sql: string; reversible: boolean; rollbackSql?: string; order: integer }[] | optional (default: []) | Ordered DDL statements |
| dialect | string | ✅ | Target SQL dialect |
| reversible | boolean | optional (default: true) | Whether the plan can be fully rolled back |
| estimatedDurationMs | integer | optional | Estimated execution time |
Nested Shape: MigrationPlan.statements[number]
Single DDL migration statement
| Property | Type | Required | Description |
|---|---|---|---|
| sql | string | ✅ | SQL DDL statement |
| reversible | boolean | optional (default: true) | Whether the statement can be reversed |
| rollbackSql | string | optional | Reverse SQL for rollback |
| order | integer | ✅ | Execution order |
MigrationStatement
Single DDL migration statement
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| sql | string | ✅ | SQL DDL statement |
| reversible | boolean | optional (default: true) | Whether the statement can be reversed |
| rollbackSql | string | optional | Reverse SQL for rollback |
| order | integer | ✅ | Execution order |
SchemaChange
Individual schema change
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| entityType | Enum<'object' | 'field' | 'index' | 'view' | 'flow' | 'permission'> | ✅ | Entity type |
| entityName | string | ✅ | Entity name |
| parentEntity | string | optional | Parent entity name |
| changeType | Enum<'added' | 'modified' | 'removed'> | ✅ | Change type |
| oldValue | any | optional | Previous value |
| newValue | any | optional | New value |