ObjectStackPlugin schema — Kernel Protocol reference
Plugin schemas of the ObjectStack Kernel Protocol: Plugin — each property with its type, default and a TypeScript example.
Source: packages/spec/src/kernel/plugin.zod.ts
TypeScript Usage
import { PluginSchema } from '@objectstack/spec/kernel';
// Validate data
const result = PluginSchema.parse(data);Plugin
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| id | string | optional | Unique Plugin ID (e.g. com.example.crm) |
| type | Enum<'standard' | 'ui' | 'driver' | 'server' | 'app' | 'theme' | 'agent' | 'objectql'> | optional (default: "standard") | Plugin Type categorization for runtime behavior |
| staticPath | string | optional | Absolute path to static assets (Required for type="ui") |
| slug | string | optional | URL path segment (Required for type="ui") |
| default | boolean | optional | Serve at root path (Only one "ui" plugin can be default) |
| version | string | optional | Version (SemVer 2.0.0 — major.minor.patch with an optional -prerelease and an optional +build suffix; e.g. 1.2.3, 2.0.0-beta.1, 1.0.0-rc.1+exp.sha.5114f85) |
| description | string | optional | |
| author | string | optional | |
| homepage | string | optional |
Kernel Protocol
The ObjectStack Kernel Protocol in 30 reference pages: every schema in @objectstack/spec with its properties, types, defaults and a TypeScript example.
Plugin Lifecycle Advanced
Declares the INPUT contracts of the host-driven lifecycle classes exported by @objectstack/core — PluginHealthMonitor.