@objectstack/spec

ObjectStack Protocol & Specification - The Constitution of the ObjectStack Ecosystem

📜 Overview

This monorepo contains the core interfaces, schemas, and conventions for the ObjectStack ecosystem. It serves as the "Constitution" - the shared language that ObjectOS, ObjectStudio, ObjectCloud, and all third-party plugins use to communicate.

Guiding Principle: "Strict Types, No Logic"

📦 Packages

This repository is organized as a monorepo with the following packages:

Core Packages

• @objectstack/spec - Main package that re-exports everything (use this for convenience)
• @objectstack/spec-meta - Metamodel type definitions (ObjectEntity, ObjectField, ObjectView)
• @objectstack/spec-plugin - Plugin runtime interfaces (ObjectStackPlugin, PluginContext)
• @objectstack/spec-schemas - Zod validation schemas (ManifestSchema, MenuItemSchema)
• @objectstack/spec-constants - Convention constants (PKG_CONVENTIONS)

🚀 Installation

Install the main package (recommended)

pnpm install @objectstack/spec

Install individual packages (for smaller bundle sizes)

pnpm install @objectstack/spec-meta
pnpm install @objectstack/spec-plugin
pnpm install @objectstack/spec-schemas
pnpm install @objectstack/spec-constants

📚 Usage

Using the main package

import { 
  ObjectEntity,
  ObjectStackPlugin,
  ManifestSchema,
  PKG_CONVENTIONS
} from '@objectstack/spec';

Using individual packages

import { ObjectEntity } from '@objectstack/spec-meta';
import { ObjectStackPlugin } from '@objectstack/spec-plugin';
import { ManifestSchema } from '@objectstack/spec-schemas';
import { PKG_CONVENTIONS } from '@objectstack/spec-constants';

🏗️ Development

# Install dependencies
pnpm install

# Build all packages
pnpm run build

# Watch mode for development (all packages)
pnpm run dev

# Clean build artifacts
pnpm run clean

Building Individual Packages

# Build a specific package
cd packages/meta && pnpm run build

📄 License

MIT