Enhance metadata specifications and component system

[Copilot]

完善基础元数据规范和控件体系 (Enhance Metadata Specifications and Component System)

Based on the goal of developing complete projects using JSON, this PR improves the fundamental metadata specifications and component system.

Phase 1: Enhance Type Definitions ✅

• Analyze current type system structure
• Identify gaps in metadata specifications
• Add missing common properties to BaseSchema (visible, hidden, disabled, name, label, description, placeholder, style, testId, ariaLabel)
• Add comprehensive JSDoc documentation
• Create CRUD operation schemas
• Create API integration schemas

Phase 2: Component System Features ✅

• Add CRUD component schema with full Create/Read/Update/Delete support
• Add ActionSchema for button actions with API integration
• Add DetailSchema for record detail views
• Add filter, pagination, and toolbar configurations
• Add EventHandler system for dynamic interactions
• Add DataFetchConfig for automatic data loading
• Add Expression system for dynamic values

Phase 3: Improve Protocol Specifications ✅

• Create comprehensive JSON schema examples (user-management, api-integration)
• Document component usage patterns (CRUD protocol, API integration)
• Add validation schemas for runtime checking
• Create CRUD protocol specification
• Create API integration guide

Phase 4: Developer Experience ✅

• Add schema validation utilities (validateSchema, assertValidSchema, isValidSchema)
• Create schema builder helpers (Form, CRUD, Button, Input, Card, Grid, Flex builders)
• Improve TypeScript type inference with composite projects
• Add schema composition utilities via fluent builders

Phase 5: Documentation & Examples ✅

• Update protocol documentation (CRUD, API integration)
• Create comprehensive component catalog examples
• Add real-world application examples (user management, API integration)
• Create best practices guide

Key Features Added

1. Enhanced Type Definitions

• Extended BaseSchema with conditional rendering properties (visibleOn, hiddenOn, disabledOn)
• Added semantic properties (name, label, description, placeholder)
• Added accessibility properties (ariaLabel, testId)
• New CRUD operation schemas for complete data management
• New API integration schemas for dynamic data and events

2. Schema Validation

import { validateSchema, assertValidSchema } from '@object-ui/core';

const result = validateSchema(mySchema);
if (!result.valid) {
  console.error(result.errors);
}

3. Schema Builders

import { crud, form, button } from '@object-ui/core/builder';

const userCRUD = crud()
  .resource('user')
  .api('/api/users')
  .columns([...])
  .enableCreate()
  .enableUpdate()
  .enableDelete()
  .pagination(20)
  .build();

4. Comprehensive Examples

• user-management: Complete CRUD interface with filters, pagination, batch actions
• api-integration: API calls, event handling, data fetching, conditional rendering

5. Documentation

• CRUD Protocol: Complete specification for CRUD components
• API Integration Guide: How to fetch data, submit forms, handle events
• Best Practices: Comprehensive guide for building maintainable apps

Summary

✅ All 5 phases complete!

This PR delivers a comprehensive enhancement to Object UI's metadata specifications and component system, enabling developers to build complete, production-ready applications using pure JSON schemas with full type safety and excellent developer experience.

See ENHANCEMENT_SUMMARY.md for detailed documentation of all changes.

Migration Guide

No breaking changes. All changes are additive and backward compatible. Existing schemas continue to work as before. New features are opt-in.

Build Status

✅ All packages build successfully with pnpm build
✅ All packages lint successfully with pnpm lint (0 errors)
✅ TypeScript composite projects configured correctly
✅ Vercel build passing

Original prompt

根据使用json开发完整项目的目标，完善基础的元数据规范和控件体系。

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
objectui-playground	Ready	Preview, Comment	Jan 15, 2026 6:58am

[xuyushun441-sys]

@copilot Continue

[Copilot]

@copilot Continue

I've completed the enhancement of the metadata specifications and component system! Here's what was added:

✅ Completed Work

1. Enhanced Type Definitions (commit 91c498c)

• Extended BaseSchema with conditional rendering (visibleOn, hiddenOn, disabledOn)
• Added CRUD operation schemas (CRUDSchema, ActionSchema, DetailSchema)
• Added API integration schemas (EventHandler, DataFetchConfig, APIRequest)

2. Developer Tools (commit 4f68e0e)

• Schema Validation: validateSchema(), assertValidSchema(), isValidSchema() functions
• Schema Builders: Fluent API for building schemas programmatically

  const userCRUD = crud()
    .resource('user')
    .api('/api/users')
    .columns([...])
    .enableCreate()
    .enableUpdate()
    .pagination(20)
    .build();

3. Comprehensive Examples

• user-management: Full CRUD interface with filters, pagination, batch actions (8.9KB JSON)
• api-integration: API calls, events, data fetching, conditional rendering (11KB JSON)

4. Documentation

• CRUD Protocol: Complete specification (8.8KB)
• API Integration Guide: Data fetching, events, transformations (9.8KB)
• Best Practices Guide: 11KB of patterns and recommendations

All phases 1-5 from the PR description are now complete. The system is ready for building complete JSON-driven applications!

[huangyiirene]

@copilot fix pnpm build

[Copilot]

@copilot fix pnpm build

Fixed the pnpm build! The issue was that packages/data-objectql and packages/react weren't configured as composite TypeScript projects, causing build errors when importing from @object-ui/types.

What was fixed (commit e86606a):

• Added composite: true to data-objectql and react tsconfig files
• Added project references to the types and core packages
• All packages now build successfully with pnpm build

The full build now completes without errors. ✅

[github-actions]

📦 Bundle Size Report

Package	Size	Gzipped
components (index.js)	1719.04KB	345.21KB
core (index.js)	0.27KB	0.14KB
data-objectql (ObjectQLDataSource.js)	11.43KB	2.76KB
data-objectql (hooks.js)	5.43KB	1.32KB
data-objectql (index.js)	0.42KB	0.26KB
designer (index.js)	0.83KB	0.32KB
plugin-charts (AdvancedChartImpl-CGlEUqvZ.js)	47.44KB	11.16KB
plugin-charts (BarChart-C9og8_1e.js)	525.61KB	132.50KB
plugin-charts (ChartImpl-BO5n60y7.js)	4.87KB	1.95KB
plugin-charts (index-DR7MvR2L.js)	23.55KB	6.93KB
plugin-charts (index.js)	0.21KB	0.16KB
plugin-editor (MonacoImpl-DCiwKyYW.js)	18.97KB	5.77KB
plugin-editor (index-CpP31686.js)	21.90KB	6.66KB
plugin-editor (index.js)	0.19KB	0.15KB
plugin-kanban (KanbanImpl-CI3LQYrL.js)	76.88KB	20.43KB
plugin-kanban (index-DNMbL6y1.js)	23.20KB	6.83KB
plugin-kanban (index.js)	0.18KB	0.15KB
plugin-markdown (MarkdownImpl-DcFjhoD-.js)	256.34KB	64.33KB
plugin-markdown (index-D4WUb7Qy.js)	21.42KB	6.50KB
plugin-markdown (index.js)	0.19KB	0.15KB
react (SchemaRenderer.js)	1.00KB	0.51KB
react (index.js)	0.13KB	0.11KB
react (index.test.js)	0.14KB	0.14KB
types (api.js)	0.24KB	0.19KB
types (base.js)	0.24KB	0.19KB
types (complex.js)	0.17KB	0.16KB
types (crud.js)	0.24KB	0.20KB
types (data-display.js)	0.19KB	0.17KB
types (data.js)	0.23KB	0.18KB
types (disclosure.js)	0.18KB	0.17KB
types (feedback.js)	0.18KB	0.16KB
types (form.js)	0.17KB	0.16KB
types (index.js)	1.46KB	0.74KB
types (layout.js)	0.23KB	0.18KB
types (navigation.js)	0.17KB	0.16KB
types (overlay.js)	0.18KB	0.16KB

Size Limits

• ✅ Core packages should be < 50KB gzipped
• ✅ Component packages should be < 100KB gzipped
• ⚠️ Plugin packages should be < 150KB gzipped

[github-actions]

✅ All checks passed!

• ✅ Type check passed
• ✅ Tests passed
• ✅ Lint check completed

[hotlong]

@copilot fix pnpm lint

[Copilot]

@copilot fix pnpm lint

Fixed the pnpm lint! The issue was using the Function type in the API schemas, which ESLint prohibits.

What was fixed (commit 629f6e7):

• Replaced Function type with proper function signature: (...args: any[]) => any
• Removed accidentally committed generated .d.ts and .js files from src directory
• Updated .gitignore to prevent generated files in src

Result:
✅ All packages pass pnpm lint with 0 errors
✅ Only warnings remain (mostly about any types which are intentional for flexible schemas)

[github-actions]

📦 Bundle Size Report

Package	Size	Gzipped
components (index.js)	1719.04KB	345.21KB
core (index.js)	0.27KB	0.14KB
data-objectql (ObjectQLDataSource.js)	11.43KB	2.76KB
data-objectql (hooks.js)	5.43KB	1.32KB
data-objectql (index.js)	0.42KB	0.26KB
designer (index.js)	0.83KB	0.32KB
plugin-charts (AdvancedChartImpl-CGlEUqvZ.js)	47.44KB	11.16KB
plugin-charts (BarChart-C9og8_1e.js)	525.61KB	132.50KB
plugin-charts (ChartImpl-BO5n60y7.js)	4.87KB	1.95KB
plugin-charts (index-DR7MvR2L.js)	23.55KB	6.93KB
plugin-charts (index.js)	0.21KB	0.16KB
plugin-editor (MonacoImpl-DCiwKyYW.js)	18.97KB	5.77KB
plugin-editor (index-CpP31686.js)	21.90KB	6.66KB
plugin-editor (index.js)	0.19KB	0.15KB
plugin-kanban (KanbanImpl-CI3LQYrL.js)	76.88KB	20.43KB
plugin-kanban (index-DNMbL6y1.js)	23.20KB	6.83KB
plugin-kanban (index.js)	0.18KB	0.15KB
plugin-markdown (MarkdownImpl-DcFjhoD-.js)	256.34KB	64.33KB
plugin-markdown (index-D4WUb7Qy.js)	21.42KB	6.50KB
plugin-markdown (index.js)	0.19KB	0.15KB
react (SchemaRenderer.js)	1.00KB	0.51KB
react (index.js)	0.13KB	0.11KB
react (index.test.js)	0.14KB	0.14KB
types (api.js)	0.24KB	0.19KB
types (base.js)	0.24KB	0.19KB
types (complex.js)	0.17KB	0.16KB
types (crud.js)	0.24KB	0.20KB
types (data-display.js)	0.19KB	0.17KB
types (data.js)	0.23KB	0.18KB
types (disclosure.js)	0.18KB	0.17KB
types (feedback.js)	0.18KB	0.16KB
types (form.js)	0.17KB	0.16KB
types (index.js)	1.46KB	0.74KB
types (layout.js)	0.23KB	0.18KB
types (navigation.js)	0.17KB	0.16KB
types (overlay.js)	0.18KB	0.16KB

Size Limits

• ✅ Core packages should be < 50KB gzipped
• ✅ Component packages should be < 100KB gzipped
• ⚠️ Plugin packages should be < 150KB gzipped

[github-actions]

✅ All checks passed!

• ✅ Type check passed
• ✅ Tests passed
• ✅ Lint check completed