@object-ui/core

Core logic, types, and validation for Object UI. Zero React dependencies.

Features

• 🎯 Type Definitions - Complete TypeScript schemas for all components
• 🔍 Component Registry - Framework-agnostic component registration system
• 📊 Data Scope - Data scope management and expression evaluation
• ✅ Validation - Zod-based schema validation
• 🚀 Zero React - Can run in Node.js or any JavaScript environment

Installation

npm install @object-ui/core

Usage

Type Definitions

import type { 
  PageSchema, 
  FormSchema, 
  InputSchema,
  BaseSchema 
} from '@object-ui/core'

const mySchema: PageSchema = {
  type: 'page',
  title: 'My Page',
  body: []
}

Component Registry

import { ComponentRegistry } from '@object-ui/core'

const registry = new ComponentRegistry()
registry.register('button', buttonMetadata)
const metadata = registry.get('button')

Data Scope

import { DataScope } from '@object-ui/core'

const scope = new DataScope({ 
  user: { name: 'John', role: 'admin' } 
})

const userName = scope.get('user.name') // 'John'
const isAdmin = scope.evaluate('${user.role === "admin"}') // true

System Views (defineView)

Schemas authored in source code are part of the product contract and must not be mutated at runtime. Wrap them with defineView() to deep-freeze the graph and tag it as a System View.

import { defineView, cloneAsOverride, isSystemView } from '@object-ui/core'

export const userListView = defineView({
  type: 'list',
  data: { object: 'User' },
  columns: [{ name: 'email' }],
})

userListView.columns.push({ name: 'name' }) // ❌ TypeError (strict mode)
isSystemView(userListView)                   // ✅ true

// To produce a Tenant- or User-level override, derive a mutable copy:
const draft = cloneAsOverride(userListView)
draft.columns.push({ name: 'name' })         // ✅ allowed
isSystemView(draft)                          // false — clone is no longer System

View tiers (recommended layering):

| Tier | Source | Mutable? | API | | ----------- | --------------------- | -------- | --------------------------- | | System View | code (import / as const) | ❌ frozen | defineView() | | Tenant View | backend / DB | ⚠️ admin only | cloneAsOverride() + persist | | User View | localStorage / API | ✅ user-editable | cloneAsOverride() + persist |

Date, RegExp, Map, Set, and class instances passed via props are intentionally not frozen so infrastructure objects keep working.

Philosophy

This package is designed to be framework-agnostic. It contains:

• ✅ Pure TypeScript types and interfaces
• ✅ Core logic and utilities
• ✅ Validation schemas
• ❌ NO React components
• ❌ NO UI rendering logic
• ❌ NO framework dependencies

This allows the core types and logic to be used in:

• Build tools and CLI utilities
• Backend validation
• Code generators
• Alternative framework adapters (Vue, Svelte, etc.)

API Reference

See full documentation for detailed API reference.

Compatibility

• Node.js: ≥ 18
• TypeScript: ≥ 5.0 (strict mode)
• @objectstack/spec: ^3.3.0
• @objectstack/client: ^3.3.0
• Tailwind CSS: ≥ 3.4 (for packages with UI)

Links

• 📚 Documentation
• 📦 npm package
• 📝 Changelog
• 🐛 Report an issue
• 🤝 Contributing Guide
• 🗺️ Roadmap

License

MIT — see LICENSE.