ObjectStackMetadata Types — Shared Protocol reference
Metadata Types schemas of the ObjectStack Shared Protocol: BaseMetadataRecord, MetadataFormat — each property with its type, default and a TypeScript example.
Source: packages/spec/src/shared/metadata-types.zod.ts
TypeScript Usage
import { BaseMetadataRecordSchema, MetadataFormatSchema } from '@objectstack/spec/shared';
import type { BaseMetadataRecord, MetadataFormat } from '@objectstack/spec/shared';
// Validate data
const result = BaseMetadataRecordSchema.parse(data);BaseMetadataRecord
Base metadata record fields shared across kernel and system
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| id | string | ✅ | Unique metadata record identifier |
| type | string | ✅ | Metadata type (e.g. "object", "view", "flow") |
| name | string | ✅ | Machine name (snake_case) |
| format | Enum<'yaml' | 'json' | 'typescript' | 'javascript'> | optional | Source file format |
MetadataFormat
Metadata file format
Allowed Values
yamljsontypescriptjavascript