ObjectStackObjectStack

Plugin

Plugin protocol schemas

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

PropertyTypeRequiredDescription
idstringoptionalUnique Plugin ID (e.g. com.example.crm)
typeEnum<'standard' | 'ui' | 'driver' | 'server' | 'app' | 'theme' | 'agent' | 'objectql'>optionalPlugin Type categorization for runtime behavior
staticPathstringoptionalAbsolute path to static assets (Required for type="ui-plugin")
slugstringoptionalURL path segment (Required for type="ui-plugin")
defaultbooleanoptionalServe at root path (Only one "ui-plugin" can be default)
versionstringoptionalSemantic Version
descriptionstringoptional
authorstringoptional
homepagestringoptional

On this page