objectstack/packages/spec/src/studio/index.ts at db5d9f8f1ba476a00fe6546b2dad1186fca549ea · objectstack-ai/objectstack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.

/**
 * @module studio
 *
 * Studio Protocol — Plugin system for ObjectStack Studio
 *
 * Defines the extension model that allows metadata types to contribute
 * custom viewers, designers, sidebar groups, actions, and commands.
 * Also includes the Object Designer protocol for visual field editing,
 * relationship mapping, and ER diagram configuration.
 */

export {
  // Schemas
  ViewModeSchema,
  MetadataViewerContributionSchema,
  SidebarGroupContributionSchema,
  ActionContributionSchema,
  // [#4737] Renamed from `ActionLocationSchema` — that bare name now belongs
  // solely to `@objectstack/spec/ui`'s 7-value app-UI vocabulary. This is the
  // 3-value Studio IDE surface enum for `ActionContributionSchema.location`.
  ActionContributionLocationSchema,
  MetadataIconContributionSchema,
  PanelContributionSchema,
  PanelLocationSchema,
  CommandContributionSchema,
  StudioPluginContributionsSchema,
  // [#4653] `ActivationEventSchema` / `ActivationEvent` are RE-EXPORTS of the
  // single declaration in `kernel/plugin-runtime.zod.ts`, not a second source.
  // Studio plugin authors keep importing them from `@objectstack/spec/studio`.
  ActivationEventSchema,
  StudioPluginManifestSchema,

  // Types
  type ViewMode,
  type MetadataViewerContribution,
  type SidebarGroupContribution,
  type ActionContribution,
  type ActionContributionLocation,
  type MetadataIconContribution,
  type PanelContribution,
  type CommandContribution,
  type StudioPluginContributions,
  type StudioPluginManifest,
  type ActivationEvent,

  // Helpers
  defineStudioPlugin,
} from './plugin.zod';

export {
  // Object Designer Schemas
  FieldPropertySectionSchema,
  FieldGroupSchema,
  FieldEditorConfigSchema,
  RelationshipDisplaySchema,
  RelationshipMapperConfigSchema,
  ERLayoutAlgorithmSchema,
  ERNodeDisplaySchema,
  ERDiagramConfigSchema,
  ObjectListDisplayModeSchema,
  ObjectSortFieldSchema,
  ObjectFilterSchema,
  ObjectManagerConfigSchema,
  ObjectPreviewTabSchema,
  ObjectPreviewConfigSchema,
  ObjectDesignerDefaultViewSchema,
  ObjectDesignerConfigSchema,

  // Object Designer Types
  type FieldPropertySection,
  type FieldGroup,
  type FieldEditorConfig,
  type RelationshipDisplay,
  type RelationshipMapperConfig,
  type ERLayoutAlgorithm,
  type ERNodeDisplay,
  type ERDiagramConfig,
  type ObjectListDisplayMode,
  type ObjectSortField,
  type ObjectFilter,
  type ObjectManagerConfig,
  type ObjectPreviewTab,
  type ObjectPreviewConfig,
  type ObjectDesignerDefaultView,
  type ObjectDesignerConfig,

  // Object Designer Helpers
  defineObjectDesignerConfig,
} from './object-designer.zod';

// Page Builder schemas removed — they configured the `blank` page-type drag-drop
// canvas, which has no renderer and was dropped from PageTypeSchema (framework#2265).

export {
  // Flow Builder Schemas
  FlowNodeShapeSchema,
  FlowNodeRenderDescriptorSchema,
  FlowCanvasNodeSchema,
  FlowCanvasEdgeStyleSchema,
  FlowCanvasEdgeSchema,
  FlowLayoutAlgorithmSchema,
  FlowLayoutDirectionSchema,
  FlowBuilderConfigSchema,
  BUILT_IN_NODE_DESCRIPTORS,

  // Flow Builder Types
  type FlowNodeShape,
  type FlowNodeRenderDescriptor,
  type FlowCanvasNode,
  type FlowCanvasEdgeStyle,
  type FlowCanvasEdge,
  type FlowLayoutAlgorithm,
  type FlowLayoutDirection,
  type FlowBuilderConfig,

  // Flow Builder Helpers
  defineFlowBuilderConfig,
} from './flow-builder.zod';