Skip to content

fix(plugin-detail): declare designer inputs for record:* blocks (spec conformance)#2113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Jun 30, 2026
Merged

fix(plugin-detail): declare designer inputs for record:* blocks (spec conformance) #2113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/record-block-inputs.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
"@object-ui/plugin-detail": minor
---

Declare designer inputs for the `record:*` blocks (details, related_list,
highlights, path) so they conform to the spec protocol (RecordDetailsProps /
RecordRelatedListProps / RecordHighlightsProps / RecordPathProps in
@objectstack/spec component.zod). They previously registered ZERO inputs — the
visual designer could not configure them, and the spec↔frontend conformance
check flagged 17 spec-only divergences. Now each block's inputs mirror its spec
schema (columns/layout/sections/fields, etc.).
29 changes: 29 additions & 0 deletions packages/plugin-detail/src/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -218,20 +218,44 @@ ComponentRegistry.register('record:details', RecordDetailsRenderer, {
category: 'record',
label: 'Record Details',
icon: 'FileText',
// Designer inputs mirror @objectstack/spec RecordDetailsProps (component.zod).
inputs: [
{ name: 'columns', type: 'enum', label: 'Columns', enum: ['1', '2', '3', '4'], defaultValue: '2', description: 'Number of columns for field layout (1-4)' },
{ name: 'layout', type: 'enum', label: 'Layout', enum: ['auto', 'custom'], defaultValue: 'auto', description: 'auto uses the object compactLayout; custom uses explicit sections' },
{ name: 'sections', type: 'array', label: 'Sections', description: 'Section IDs to show (required when layout is "custom")' },
{ name: 'fields', type: 'array', label: 'Fields', description: 'Explicit field list (overrides compactLayout)' },
],
});

ComponentRegistry.register('record:related_list', RecordRelatedListRenderer, {
namespace: 'record',
category: 'record',
label: 'Related List',
icon: 'List',
// Mirrors @objectstack/spec RecordRelatedListProps.
inputs: [
{ name: 'objectName', type: 'string', label: 'Related Object', required: true, description: 'Related object name (e.g. "task")' },
{ name: 'relationshipField', type: 'string', label: 'Relationship Field', required: true, description: 'Field on the related object pointing back to this record' },
{ name: 'columns', type: 'array', label: 'Columns', required: true, description: 'Fields to display in the related list' },
{ name: 'sort', type: 'array', label: 'Sort' },
{ name: 'limit', type: 'number', label: 'Limit', defaultValue: 5, description: 'Records to display initially' },
{ name: 'filter', type: 'array', label: 'Filter', description: 'Additional filter criteria' },
{ name: 'title', type: 'string', label: 'Title' },
{ name: 'showViewAll', type: 'boolean', label: 'Show "View All"', defaultValue: true },
{ name: 'actions', type: 'array', label: 'Actions', description: 'Action IDs available for related records' },
],
});

ComponentRegistry.register('record:highlights', RecordHighlightsRenderer, {
namespace: 'record',
category: 'record',
label: 'Highlights Panel',
icon: 'Star',
// Mirrors @objectstack/spec RecordHighlightsProps.
inputs: [
{ name: 'fields', type: 'array', label: 'Fields', required: true, description: 'Key fields to highlight (1-7), bare names or {name,label?,icon?,type?}' },
{ name: 'layout', type: 'enum', label: 'Layout', enum: ['horizontal', 'vertical'], defaultValue: 'horizontal', description: 'Layout orientation for highlight fields' },
],
});

ComponentRegistry.register('record:activity', RecordActivityRenderer, {
Expand DownExpand Up@@ -265,6 +289,11 @@ ComponentRegistry.register('record:path', RecordPathRenderer, {
category: 'record',
label: 'Path / Stepper',
icon: 'GitBranch',
// Mirrors @objectstack/spec RecordPathProps.
inputs: [
{ name: 'statusField', type: 'string', label: 'Status Field', required: true, description: 'Field representing the current status/stage' },
{ name: 'stages', type: 'array', label: 'Stages', description: 'Explicit stage definitions [{ value, label }] (else derived from field metadata)' },
],
});

ComponentRegistry.register('record:quick_actions', RecordQuickActionsRenderer, {
Expand Down
Loading